blob: d2a7f1198271825778049f226cdb60e6f90b64da [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 Carruthc80ceea2014-03-04 11:02:08 +000021#include "llvm/IR/CallSite.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000022#include "llvm/IR/Intrinsics.h"
Anders Carlssonbbe277c2011-04-13 02:35:36 +000023
Anders Carlssoncc52f652009-09-22 22:53:17 +000024using namespace clang;
25using namespace CodeGen;
26
George Burgess IVd0a9e802017-02-23 22:07:35 +000027namespace {
28struct MemberCallInfo {
29 RequiredArgs ReqArgs;
30 // Number of prefix arguments for the call. Ignores the `this` pointer.
31 unsigned PrefixSize;
32};
33}
34
35static MemberCallInfo
Alexey Samsonovefa956c2016-03-10 00:20:33 +000036commonEmitCXXMemberOrOperatorCall(CodeGenFunction &CGF, const CXXMethodDecl *MD,
37 llvm::Value *This, llvm::Value *ImplicitParam,
38 QualType ImplicitParamTy, const CallExpr *CE,
Richard Smith762672a2016-09-28 19:09:10 +000039 CallArgList &Args, CallArgList *RtlArgs) {
Alexey Samsonova5bf76b2014-08-25 20:17:35 +000040 assert(CE == nullptr || isa<CXXMemberCallExpr>(CE) ||
41 isa<CXXOperatorCallExpr>(CE));
Anders Carlsson27da15b2010-01-01 20:29:01 +000042 assert(MD->isInstance() &&
Alexey Samsonova5bf76b2014-08-25 20:17:35 +000043 "Trying to emit a member or operator call expr on a static method!");
Reid Kleckner034e7272016-09-07 15:15:51 +000044 ASTContext &C = CGF.getContext();
Anders Carlsson27da15b2010-01-01 20:29:01 +000045
Anders Carlsson27da15b2010-01-01 20:29:01 +000046 // Push the this ptr.
Reid Kleckner034e7272016-09-07 15:15:51 +000047 const CXXRecordDecl *RD =
48 CGF.CGM.getCXXABI().getThisArgumentTypeForMethod(MD);
49 Args.add(RValue::get(This),
50 RD ? C.getPointerType(C.getTypeDeclType(RD)) : C.VoidPtrTy);
Anders Carlsson27da15b2010-01-01 20:29:01 +000051
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +000052 // If there is an implicit parameter (e.g. VTT), emit it.
53 if (ImplicitParam) {
54 Args.add(RValue::get(ImplicitParam), ImplicitParamTy);
Anders Carlssone36a6b32010-01-02 01:01:18 +000055 }
John McCalla729c622012-02-17 03:33:10 +000056
57 const FunctionProtoType *FPT = MD->getType()->castAs<FunctionProtoType>();
George Burgess IV419996c2016-06-16 23:06:04 +000058 RequiredArgs required = RequiredArgs::forPrototypePlus(FPT, Args.size(), MD);
George Burgess IVd0a9e802017-02-23 22:07:35 +000059 unsigned PrefixSize = Args.size() - 1;
Alexey Samsonov8e1162c2014-09-08 17:22:45 +000060
John McCalla729c622012-02-17 03:33:10 +000061 // And the rest of the call args.
Richard Smith762672a2016-09-28 19:09:10 +000062 if (RtlArgs) {
63 // Special case: if the caller emitted the arguments right-to-left already
64 // (prior to emitting the *this argument), we're done. This happens for
65 // assignment operators.
66 Args.addFrom(*RtlArgs);
67 } else if (CE) {
Alexey Samsonova5bf76b2014-08-25 20:17:35 +000068 // Special case: skip first argument of CXXOperatorCall (it is "this").
Alexey Samsonov8e1162c2014-09-08 17:22:45 +000069 unsigned ArgsToSkip = isa<CXXOperatorCallExpr>(CE) ? 1 : 0;
David Blaikief05779e2015-07-21 18:37:18 +000070 CGF.EmitCallArgs(Args, FPT, drop_begin(CE->arguments(), ArgsToSkip),
David Majnemer0c0b6d92014-10-31 20:09:12 +000071 CE->getDirectCallee());
Alexey Samsonova5bf76b2014-08-25 20:17:35 +000072 } else {
Alexey Samsonov8e1162c2014-09-08 17:22:45 +000073 assert(
74 FPT->getNumParams() == 0 &&
75 "No CallExpr specified for function with non-zero number of arguments");
Alexey Samsonova5bf76b2014-08-25 20:17:35 +000076 }
George Burgess IVd0a9e802017-02-23 22:07:35 +000077 return {required, PrefixSize};
David Majnemer0c0b6d92014-10-31 20:09:12 +000078}
Anders Carlsson27da15b2010-01-01 20:29:01 +000079
David Majnemer0c0b6d92014-10-31 20:09:12 +000080RValue CodeGenFunction::EmitCXXMemberOrOperatorCall(
John McCallb92ab1a2016-10-26 23:46:34 +000081 const CXXMethodDecl *MD, const CGCallee &Callee,
82 ReturnValueSlot ReturnValue,
David Majnemer0c0b6d92014-10-31 20:09:12 +000083 llvm::Value *This, llvm::Value *ImplicitParam, QualType ImplicitParamTy,
Richard Smith762672a2016-09-28 19:09:10 +000084 const CallExpr *CE, CallArgList *RtlArgs) {
David Majnemer0c0b6d92014-10-31 20:09:12 +000085 const FunctionProtoType *FPT = MD->getType()->castAs<FunctionProtoType>();
86 CallArgList Args;
George Burgess IVd0a9e802017-02-23 22:07:35 +000087 MemberCallInfo CallInfo = commonEmitCXXMemberOrOperatorCall(
Richard Smith762672a2016-09-28 19:09:10 +000088 *this, MD, This, ImplicitParam, ImplicitParamTy, CE, Args, RtlArgs);
George Burgess IVd0a9e802017-02-23 22:07:35 +000089 auto &FnInfo = CGM.getTypes().arrangeCXXMethodCall(
90 Args, FPT, CallInfo.ReqArgs, CallInfo.PrefixSize);
Vedant Kumar09b5bfd2017-12-21 00:10:25 +000091 return EmitCall(FnInfo, Callee, ReturnValue, Args, nullptr,
92 CE ? CE->getExprLoc() : SourceLocation());
Anders Carlsson27da15b2010-01-01 20:29:01 +000093}
94
Alexey Samsonovae81bbb2016-03-10 00:20:37 +000095RValue CodeGenFunction::EmitCXXDestructorCall(
John McCallb92ab1a2016-10-26 23:46:34 +000096 const CXXDestructorDecl *DD, const CGCallee &Callee, llvm::Value *This,
Alexey Samsonovae81bbb2016-03-10 00:20:37 +000097 llvm::Value *ImplicitParam, QualType ImplicitParamTy, const CallExpr *CE,
98 StructorType Type) {
David Majnemer0c0b6d92014-10-31 20:09:12 +000099 CallArgList Args;
Alexey Samsonovae81bbb2016-03-10 00:20:37 +0000100 commonEmitCXXMemberOrOperatorCall(*this, DD, This, ImplicitParam,
Richard Smith762672a2016-09-28 19:09:10 +0000101 ImplicitParamTy, CE, Args, nullptr);
Alexey Samsonovae81bbb2016-03-10 00:20:37 +0000102 return EmitCall(CGM.getTypes().arrangeCXXStructorDeclaration(DD, Type),
John McCallb92ab1a2016-10-26 23:46:34 +0000103 Callee, ReturnValueSlot(), Args);
104}
105
106RValue CodeGenFunction::EmitCXXPseudoDestructorExpr(
107 const CXXPseudoDestructorExpr *E) {
108 QualType DestroyedType = E->getDestroyedType();
109 if (DestroyedType.hasStrongOrWeakObjCLifetime()) {
110 // Automatic Reference Counting:
111 // If the pseudo-expression names a retainable object with weak or
112 // strong lifetime, the object shall be released.
113 Expr *BaseExpr = E->getBase();
114 Address BaseValue = Address::invalid();
115 Qualifiers BaseQuals;
116
117 // If this is s.x, emit s as an lvalue. If it is s->x, emit s as a scalar.
118 if (E->isArrow()) {
119 BaseValue = EmitPointerWithAlignment(BaseExpr);
120 const PointerType *PTy = BaseExpr->getType()->getAs<PointerType>();
121 BaseQuals = PTy->getPointeeType().getQualifiers();
122 } else {
123 LValue BaseLV = EmitLValue(BaseExpr);
124 BaseValue = BaseLV.getAddress();
125 QualType BaseTy = BaseExpr->getType();
126 BaseQuals = BaseTy.getQualifiers();
127 }
128
129 switch (DestroyedType.getObjCLifetime()) {
130 case Qualifiers::OCL_None:
131 case Qualifiers::OCL_ExplicitNone:
132 case Qualifiers::OCL_Autoreleasing:
133 break;
134
135 case Qualifiers::OCL_Strong:
136 EmitARCRelease(Builder.CreateLoad(BaseValue,
137 DestroyedType.isVolatileQualified()),
138 ARCPreciseLifetime);
139 break;
140
141 case Qualifiers::OCL_Weak:
142 EmitARCDestroyWeak(BaseValue);
143 break;
144 }
145 } else {
146 // C++ [expr.pseudo]p1:
147 // The result shall only be used as the operand for the function call
148 // operator (), and the result of such a call has type void. The only
149 // effect is the evaluation of the postfix-expression before the dot or
150 // arrow.
151 EmitIgnoredExpr(E->getBase());
152 }
153
154 return RValue::get(nullptr);
David Majnemer0c0b6d92014-10-31 20:09:12 +0000155}
156
Rafael Espindola3b33c4e2012-06-28 14:28:57 +0000157static CXXRecordDecl *getCXXRecord(const Expr *E) {
158 QualType T = E->getType();
159 if (const PointerType *PTy = T->getAs<PointerType>())
160 T = PTy->getPointeeType();
161 const RecordType *Ty = T->castAs<RecordType>();
162 return cast<CXXRecordDecl>(Ty->getDecl());
163}
164
Francois Pichet64225792011-01-18 05:04:39 +0000165// Note: This function also emit constructor calls to support a MSVC
166// extensions allowing explicit constructor function call.
Anders Carlsson27da15b2010-01-01 20:29:01 +0000167RValue CodeGenFunction::EmitCXXMemberCallExpr(const CXXMemberCallExpr *CE,
168 ReturnValueSlot ReturnValue) {
John McCall2d2e8702011-04-11 07:02:50 +0000169 const Expr *callee = CE->getCallee()->IgnoreParens();
170
171 if (isa<BinaryOperator>(callee))
Anders Carlsson27da15b2010-01-01 20:29:01 +0000172 return EmitCXXMemberPointerCallExpr(CE, ReturnValue);
John McCall2d2e8702011-04-11 07:02:50 +0000173
174 const MemberExpr *ME = cast<MemberExpr>(callee);
Anders Carlsson27da15b2010-01-01 20:29:01 +0000175 const CXXMethodDecl *MD = cast<CXXMethodDecl>(ME->getMemberDecl());
176
177 if (MD->isStatic()) {
178 // The method is static, emit it as we would a regular call.
Erich Keanede6480a32018-11-13 15:48:08 +0000179 CGCallee callee =
180 CGCallee::forDirect(CGM.GetAddrOfFunction(MD), GlobalDecl(MD));
John McCallb92ab1a2016-10-26 23:46:34 +0000181 return EmitCall(getContext().getPointerType(MD->getType()), callee, CE,
Alexey Samsonov70b9c012014-08-21 20:26:47 +0000182 ReturnValue);
Anders Carlsson27da15b2010-01-01 20:29:01 +0000183 }
Anders Carlsson27da15b2010-01-01 20:29:01 +0000184
Nico Weberaad4af62014-12-03 01:21:41 +0000185 bool HasQualifier = ME->hasQualifier();
186 NestedNameSpecifier *Qualifier = HasQualifier ? ME->getQualifier() : nullptr;
187 bool IsArrow = ME->isArrow();
Rafael Espindolaecbe2e92012-06-28 01:56:38 +0000188 const Expr *Base = ME->getBase();
Nico Weberaad4af62014-12-03 01:21:41 +0000189
190 return EmitCXXMemberOrOperatorMemberCallExpr(
191 CE, MD, ReturnValue, HasQualifier, Qualifier, IsArrow, Base);
192}
193
194RValue CodeGenFunction::EmitCXXMemberOrOperatorMemberCallExpr(
195 const CallExpr *CE, const CXXMethodDecl *MD, ReturnValueSlot ReturnValue,
196 bool HasQualifier, NestedNameSpecifier *Qualifier, bool IsArrow,
197 const Expr *Base) {
198 assert(isa<CXXMemberCallExpr>(CE) || isa<CXXOperatorCallExpr>(CE));
199
200 // Compute the object pointer.
201 bool CanUseVirtualCall = MD->isVirtual() && !HasQualifier;
Rafael Espindolaecbe2e92012-06-28 01:56:38 +0000202
Craig Topper8a13c412014-05-21 05:09:00 +0000203 const CXXMethodDecl *DevirtualizedMethod = nullptr;
Akira Hatanaka22461672017-07-13 06:08:27 +0000204 if (CanUseVirtualCall &&
205 MD->getDevirtualizedMethod(Base, getLangOpts().AppleKext)) {
Rafael Espindola3b33c4e2012-06-28 14:28:57 +0000206 const CXXRecordDecl *BestDynamicDecl = Base->getBestDynamicClassType();
207 DevirtualizedMethod = MD->getCorrespondingMethodInClass(BestDynamicDecl);
208 assert(DevirtualizedMethod);
209 const CXXRecordDecl *DevirtualizedClass = DevirtualizedMethod->getParent();
210 const Expr *Inner = Base->ignoreParenBaseCasts();
Alexey Bataev5bd68792014-09-29 10:32:21 +0000211 if (DevirtualizedMethod->getReturnType().getCanonicalType() !=
212 MD->getReturnType().getCanonicalType())
213 // If the return types are not the same, this might be a case where more
214 // code needs to run to compensate for it. For example, the derived
215 // method might return a type that inherits form from the return
216 // type of MD and has a prefix.
217 // For now we just avoid devirtualizing these covariant cases.
218 DevirtualizedMethod = nullptr;
219 else if (getCXXRecord(Inner) == DevirtualizedClass)
Rafael Espindola3b33c4e2012-06-28 14:28:57 +0000220 // If the class of the Inner expression is where the dynamic method
221 // is defined, build the this pointer from it.
222 Base = Inner;
223 else if (getCXXRecord(Base) != DevirtualizedClass) {
224 // If the method is defined in a class that is not the best dynamic
225 // one or the one of the full expression, we would have to build
226 // a derived-to-base cast to compute the correct this pointer, but
227 // we don't have support for that yet, so do a virtual call.
Craig Topper8a13c412014-05-21 05:09:00 +0000228 DevirtualizedMethod = nullptr;
Rafael Espindola3b33c4e2012-06-28 14:28:57 +0000229 }
230 }
Rafael Espindolaecbe2e92012-06-28 01:56:38 +0000231
Richard Smith762672a2016-09-28 19:09:10 +0000232 // C++17 demands that we evaluate the RHS of a (possibly-compound) assignment
233 // operator before the LHS.
234 CallArgList RtlArgStorage;
235 CallArgList *RtlArgs = nullptr;
236 if (auto *OCE = dyn_cast<CXXOperatorCallExpr>(CE)) {
237 if (OCE->isAssignmentOp()) {
238 RtlArgs = &RtlArgStorage;
239 EmitCallArgs(*RtlArgs, MD->getType()->castAs<FunctionProtoType>(),
240 drop_begin(CE->arguments(), 1), CE->getDirectCallee(),
Richard Smitha560ccf2016-09-29 21:30:12 +0000241 /*ParamsToSkip*/0, EvaluationOrder::ForceRightToLeft);
Richard Smith762672a2016-09-28 19:09:10 +0000242 }
243 }
244
Ivan A. Kosarev1860b522018-01-25 14:21:55 +0000245 LValue This;
246 if (IsArrow) {
247 LValueBaseInfo BaseInfo;
248 TBAAAccessInfo TBAAInfo;
249 Address ThisValue = EmitPointerWithAlignment(Base, &BaseInfo, &TBAAInfo);
250 This = MakeAddrLValue(ThisValue, Base->getType(), BaseInfo, TBAAInfo);
251 } else {
252 This = EmitLValue(Base);
253 }
Rafael Espindolaecbe2e92012-06-28 01:56:38 +0000254
Anders Carlsson27da15b2010-01-01 20:29:01 +0000255
Richard Smith419bd092015-04-29 19:26:57 +0000256 if (MD->isTrivial() || (MD->isDefaulted() && MD->getParent()->isUnion())) {
Craig Topper8a13c412014-05-21 05:09:00 +0000257 if (isa<CXXDestructorDecl>(MD)) return RValue::get(nullptr);
Fangrui Song6907ce22018-07-30 19:24:48 +0000258 if (isa<CXXConstructorDecl>(MD) &&
Francois Pichet64225792011-01-18 05:04:39 +0000259 cast<CXXConstructorDecl>(MD)->isDefaultConstructor())
Craig Topper8a13c412014-05-21 05:09:00 +0000260 return RValue::get(nullptr);
John McCall0d635f52010-09-03 01:26:39 +0000261
Nico Weberaad4af62014-12-03 01:21:41 +0000262 if (!MD->getParent()->mayInsertExtraPadding()) {
263 if (MD->isCopyAssignmentOperator() || MD->isMoveAssignmentOperator()) {
264 // We don't like to generate the trivial copy/move assignment operator
265 // when it isn't necessary; just produce the proper effect here.
Richard Smith762672a2016-09-28 19:09:10 +0000266 LValue RHS = isa<CXXOperatorCallExpr>(CE)
267 ? MakeNaturalAlignAddrLValue(
Yaxun Liu5b330e82018-03-15 15:25:19 +0000268 (*RtlArgs)[0].getRValue(*this).getScalarVal(),
Richard Smith762672a2016-09-28 19:09:10 +0000269 (*(CE->arg_begin() + 1))->getType())
270 : EmitLValue(*CE->arg_begin());
Ivan A. Kosarev1860b522018-01-25 14:21:55 +0000271 EmitAggregateAssign(This, RHS, CE->getType());
John McCall7f416cc2015-09-08 08:05:57 +0000272 return RValue::get(This.getPointer());
Nico Weberaad4af62014-12-03 01:21:41 +0000273 }
Alexey Samsonov525bf652014-08-25 21:58:56 +0000274
Nico Weberaad4af62014-12-03 01:21:41 +0000275 if (isa<CXXConstructorDecl>(MD) &&
276 cast<CXXConstructorDecl>(MD)->isCopyOrMoveConstructor()) {
277 // Trivial move and copy ctor are the same.
278 assert(CE->getNumArgs() == 1 && "unexpected argcount for trivial ctor");
Ivan A. Kosarev1860b522018-01-25 14:21:55 +0000279 const Expr *Arg = *CE->arg_begin();
280 LValue RHS = EmitLValue(Arg);
281 LValue Dest = MakeAddrLValue(This.getAddress(), Arg->getType());
Richard Smithe78fac52018-04-05 20:52:58 +0000282 // This is the MSVC p->Ctor::Ctor(...) extension. We assume that's
283 // constructing a new complete object of type Ctor.
284 EmitAggregateCopy(Dest, RHS, Arg->getType(),
285 AggValueSlot::DoesNotOverlap);
John McCall7f416cc2015-09-08 08:05:57 +0000286 return RValue::get(This.getPointer());
Nico Weberaad4af62014-12-03 01:21:41 +0000287 }
288 llvm_unreachable("unknown trivial member function");
Francois Pichet64225792011-01-18 05:04:39 +0000289 }
Anders Carlsson27da15b2010-01-01 20:29:01 +0000290 }
291
John McCall0d635f52010-09-03 01:26:39 +0000292 // Compute the function type we're calling.
Nico Weber3abfe952014-12-02 20:41:18 +0000293 const CXXMethodDecl *CalleeDecl =
294 DevirtualizedMethod ? DevirtualizedMethod : MD;
Craig Topper8a13c412014-05-21 05:09:00 +0000295 const CGFunctionInfo *FInfo = nullptr;
Nico Weber3abfe952014-12-02 20:41:18 +0000296 if (const auto *Dtor = dyn_cast<CXXDestructorDecl>(CalleeDecl))
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000297 FInfo = &CGM.getTypes().arrangeCXXStructorDeclaration(
298 Dtor, StructorType::Complete);
Nico Weber3abfe952014-12-02 20:41:18 +0000299 else if (const auto *Ctor = dyn_cast<CXXConstructorDecl>(CalleeDecl))
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000300 FInfo = &CGM.getTypes().arrangeCXXStructorDeclaration(
301 Ctor, StructorType::Complete);
Francois Pichet64225792011-01-18 05:04:39 +0000302 else
Eli Friedmanade60972012-10-25 00:12:49 +0000303 FInfo = &CGM.getTypes().arrangeCXXMethodDeclaration(CalleeDecl);
John McCall0d635f52010-09-03 01:26:39 +0000304
Reid Klecknere7de47e2013-07-22 13:51:44 +0000305 llvm::FunctionType *Ty = CGM.getTypes().GetFunctionType(*FInfo);
John McCall0d635f52010-09-03 01:26:39 +0000306
Ivan Krasind98f5d72016-11-17 00:39:48 +0000307 // C++11 [class.mfct.non-static]p2:
308 // If a non-static member function of a class X is called for an object that
309 // is not of type X, or of a type derived from X, the behavior is undefined.
310 SourceLocation CallLoc;
311 ASTContext &C = getContext();
312 if (CE)
313 CallLoc = CE->getExprLoc();
314
Vedant Kumar34b1fd62017-02-17 23:22:59 +0000315 SanitizerSet SkippedChecks;
Vedant Kumarffd7c882017-04-14 22:03:34 +0000316 if (const auto *CMCE = dyn_cast<CXXMemberCallExpr>(CE)) {
317 auto *IOA = CMCE->getImplicitObjectArgument();
318 bool IsImplicitObjectCXXThis = IsWrappedCXXThis(IOA);
319 if (IsImplicitObjectCXXThis)
320 SkippedChecks.set(SanitizerKind::Alignment, true);
321 if (IsImplicitObjectCXXThis || isa<DeclRefExpr>(IOA))
Vedant Kumar34b1fd62017-02-17 23:22:59 +0000322 SkippedChecks.set(SanitizerKind::Null, true);
Vedant Kumarffd7c882017-04-14 22:03:34 +0000323 }
Vedant Kumar34b1fd62017-02-17 23:22:59 +0000324 EmitTypeCheck(
325 isa<CXXConstructorDecl>(CalleeDecl) ? CodeGenFunction::TCK_ConstructorCall
326 : CodeGenFunction::TCK_MemberCall,
327 CallLoc, This.getPointer(), C.getRecordType(CalleeDecl->getParent()),
328 /*Alignment=*/CharUnits::Zero(), SkippedChecks);
Ivan Krasind98f5d72016-11-17 00:39:48 +0000329
Vedant Kumar018f2662016-10-19 20:21:16 +0000330 // FIXME: Uses of 'MD' past this point need to be audited. We may need to use
331 // 'CalleeDecl' instead.
332
Anders Carlsson27da15b2010-01-01 20:29:01 +0000333 // C++ [class.virtual]p12:
334 // Explicit qualification with the scope operator (5.1) suppresses the
335 // virtual call mechanism.
336 //
337 // We also don't emit a virtual call if the base expression has a record type
338 // because then we know what the type is.
Rafael Espindola3b33c4e2012-06-28 14:28:57 +0000339 bool UseVirtualCall = CanUseVirtualCall && !DevirtualizedMethod;
Fangrui Song6907ce22018-07-30 19:24:48 +0000340
John McCall0d635f52010-09-03 01:26:39 +0000341 if (const CXXDestructorDecl *Dtor = dyn_cast<CXXDestructorDecl>(MD)) {
Stephen Lin9dc6eef2013-06-30 20:40:16 +0000342 assert(CE->arg_begin() == CE->arg_end() &&
343 "Destructor shouldn't have explicit parameters");
344 assert(ReturnValue.isNull() && "Destructor shouldn't have return value");
John McCall0d635f52010-09-03 01:26:39 +0000345 if (UseVirtualCall) {
Nico Weberaad4af62014-12-03 01:21:41 +0000346 CGM.getCXXABI().EmitVirtualDestructorCall(
Ivan A. Kosarev1860b522018-01-25 14:21:55 +0000347 *this, Dtor, Dtor_Complete, This.getAddress(),
348 cast<CXXMemberCallExpr>(CE));
Anders Carlsson27da15b2010-01-01 20:29:01 +0000349 } else {
John McCallb92ab1a2016-10-26 23:46:34 +0000350 CGCallee Callee;
Nico Weberaad4af62014-12-03 01:21:41 +0000351 if (getLangOpts().AppleKext && MD->isVirtual() && HasQualifier)
352 Callee = BuildAppleKextVirtualCall(MD, Qualifier, Ty);
Rafael Espindola3b33c4e2012-06-28 14:28:57 +0000353 else if (!DevirtualizedMethod)
John McCallb92ab1a2016-10-26 23:46:34 +0000354 Callee = CGCallee::forDirect(
355 CGM.getAddrOfCXXStructor(Dtor, StructorType::Complete, FInfo, Ty),
Erich Keanede6480a32018-11-13 15:48:08 +0000356 GlobalDecl(Dtor, Dtor_Complete));
Rafael Espindola49e860b2012-06-26 17:45:31 +0000357 else {
Rafael Espindola3b33c4e2012-06-28 14:28:57 +0000358 const CXXDestructorDecl *DDtor =
359 cast<CXXDestructorDecl>(DevirtualizedMethod);
John McCallb92ab1a2016-10-26 23:46:34 +0000360 Callee = CGCallee::forDirect(
Erich Keanede6480a32018-11-13 15:48:08 +0000361 CGM.GetAddrOfFunction(GlobalDecl(DDtor, Dtor_Complete), Ty),
362 GlobalDecl(DDtor, Dtor_Complete));
Rafael Espindola49e860b2012-06-26 17:45:31 +0000363 }
Vedant Kumar018f2662016-10-19 20:21:16 +0000364 EmitCXXMemberOrOperatorCall(
365 CalleeDecl, Callee, ReturnValue, This.getPointer(),
366 /*ImplicitParam=*/nullptr, QualType(), CE, nullptr);
Anders Carlsson27da15b2010-01-01 20:29:01 +0000367 }
Craig Topper8a13c412014-05-21 05:09:00 +0000368 return RValue::get(nullptr);
Stephen Lin9dc6eef2013-06-30 20:40:16 +0000369 }
Fangrui Song6907ce22018-07-30 19:24:48 +0000370
John McCallb92ab1a2016-10-26 23:46:34 +0000371 CGCallee Callee;
Stephen Lin9dc6eef2013-06-30 20:40:16 +0000372 if (const CXXConstructorDecl *Ctor = dyn_cast<CXXConstructorDecl>(MD)) {
John McCallb92ab1a2016-10-26 23:46:34 +0000373 Callee = CGCallee::forDirect(
Erich Keanede6480a32018-11-13 15:48:08 +0000374 CGM.GetAddrOfFunction(GlobalDecl(Ctor, Ctor_Complete), Ty),
375 GlobalDecl(Ctor, Ctor_Complete));
John McCall0d635f52010-09-03 01:26:39 +0000376 } else if (UseVirtualCall) {
Peter Collingbourneea211002018-02-05 23:09:13 +0000377 Callee = CGCallee::forVirtual(CE, MD, This.getAddress(), Ty);
Anders Carlsson27da15b2010-01-01 20:29:01 +0000378 } else {
Peter Collingbourne1a7488a2015-04-02 00:23:30 +0000379 if (SanOpts.has(SanitizerKind::CFINVCall) &&
380 MD->getParent()->isDynamicClass()) {
Peter Collingbourne60108802017-12-13 21:53:04 +0000381 llvm::Value *VTable;
382 const CXXRecordDecl *RD;
383 std::tie(VTable, RD) =
Ivan A. Kosarev1860b522018-01-25 14:21:55 +0000384 CGM.getCXXABI().LoadVTablePtr(*this, This.getAddress(),
385 MD->getParent());
Stephen Kellyf2ceec42018-08-09 21:08:08 +0000386 EmitVTablePtrCheckForCall(RD, VTable, CFITCK_NVCall, CE->getBeginLoc());
Peter Collingbourne1a7488a2015-04-02 00:23:30 +0000387 }
388
Nico Weberaad4af62014-12-03 01:21:41 +0000389 if (getLangOpts().AppleKext && MD->isVirtual() && HasQualifier)
390 Callee = BuildAppleKextVirtualCall(MD, Qualifier, Ty);
Rafael Espindola3b33c4e2012-06-28 14:28:57 +0000391 else if (!DevirtualizedMethod)
Erich Keanede6480a32018-11-13 15:48:08 +0000392 Callee =
393 CGCallee::forDirect(CGM.GetAddrOfFunction(MD, Ty), GlobalDecl(MD));
Rafael Espindola49e860b2012-06-26 17:45:31 +0000394 else {
Erich Keanede6480a32018-11-13 15:48:08 +0000395 Callee =
396 CGCallee::forDirect(CGM.GetAddrOfFunction(DevirtualizedMethod, Ty),
397 GlobalDecl(DevirtualizedMethod));
Rafael Espindola49e860b2012-06-26 17:45:31 +0000398 }
Anders Carlsson27da15b2010-01-01 20:29:01 +0000399 }
400
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +0000401 if (MD->isVirtual()) {
Ivan A. Kosarev1860b522018-01-25 14:21:55 +0000402 Address NewThisAddr =
403 CGM.getCXXABI().adjustThisArgumentForVirtualFunctionCall(
404 *this, CalleeDecl, This.getAddress(), UseVirtualCall);
405 This.setAddress(NewThisAddr);
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +0000406 }
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000407
Vedant Kumar018f2662016-10-19 20:21:16 +0000408 return EmitCXXMemberOrOperatorCall(
409 CalleeDecl, Callee, ReturnValue, This.getPointer(),
410 /*ImplicitParam=*/nullptr, QualType(), CE, RtlArgs);
Anders Carlsson27da15b2010-01-01 20:29:01 +0000411}
412
413RValue
414CodeGenFunction::EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E,
415 ReturnValueSlot ReturnValue) {
416 const BinaryOperator *BO =
417 cast<BinaryOperator>(E->getCallee()->IgnoreParens());
418 const Expr *BaseExpr = BO->getLHS();
419 const Expr *MemFnExpr = BO->getRHS();
Fangrui Song6907ce22018-07-30 19:24:48 +0000420
421 const MemberPointerType *MPT =
John McCall0009fcc2011-04-26 20:42:42 +0000422 MemFnExpr->getType()->castAs<MemberPointerType>();
John McCall475999d2010-08-22 00:05:51 +0000423
Fangrui Song6907ce22018-07-30 19:24:48 +0000424 const FunctionProtoType *FPT =
John McCall0009fcc2011-04-26 20:42:42 +0000425 MPT->getPointeeType()->castAs<FunctionProtoType>();
Fangrui Song6907ce22018-07-30 19:24:48 +0000426 const CXXRecordDecl *RD =
Anders Carlsson27da15b2010-01-01 20:29:01 +0000427 cast<CXXRecordDecl>(MPT->getClass()->getAs<RecordType>()->getDecl());
428
Anders Carlsson27da15b2010-01-01 20:29:01 +0000429 // Emit the 'this' pointer.
John McCall7f416cc2015-09-08 08:05:57 +0000430 Address This = Address::invalid();
John McCalle3027922010-08-25 11:45:40 +0000431 if (BO->getOpcode() == BO_PtrMemI)
John McCall7f416cc2015-09-08 08:05:57 +0000432 This = EmitPointerWithAlignment(BaseExpr);
Fangrui Song6907ce22018-07-30 19:24:48 +0000433 else
Anders Carlsson27da15b2010-01-01 20:29:01 +0000434 This = EmitLValue(BaseExpr).getAddress();
Anders Carlsson27da15b2010-01-01 20:29:01 +0000435
John McCall7f416cc2015-09-08 08:05:57 +0000436 EmitTypeCheck(TCK_MemberCall, E->getExprLoc(), This.getPointer(),
Richard Smithe30752c2012-10-09 19:52:38 +0000437 QualType(MPT->getClass(), 0));
Richard Smith69d0d262012-08-24 00:54:33 +0000438
Richard Smithbde62d72016-09-26 23:56:57 +0000439 // Get the member function pointer.
440 llvm::Value *MemFnPtr = EmitScalarExpr(MemFnExpr);
441
John McCall475999d2010-08-22 00:05:51 +0000442 // Ask the ABI to load the callee. Note that This is modified.
John McCall7f416cc2015-09-08 08:05:57 +0000443 llvm::Value *ThisPtrForCall = nullptr;
John McCallb92ab1a2016-10-26 23:46:34 +0000444 CGCallee Callee =
John McCall7f416cc2015-09-08 08:05:57 +0000445 CGM.getCXXABI().EmitLoadOfMemberFunctionPointer(*this, BO, This,
446 ThisPtrForCall, MemFnPtr, MPT);
Fangrui Song6907ce22018-07-30 19:24:48 +0000447
Anders Carlsson27da15b2010-01-01 20:29:01 +0000448 CallArgList Args;
449
Fangrui Song6907ce22018-07-30 19:24:48 +0000450 QualType ThisType =
Anders Carlsson27da15b2010-01-01 20:29:01 +0000451 getContext().getPointerType(getContext().getTagDeclType(RD));
452
453 // Push the this ptr.
John McCall7f416cc2015-09-08 08:05:57 +0000454 Args.add(RValue::get(ThisPtrForCall), ThisType);
John McCall8dda7b22012-07-07 06:41:13 +0000455
George Burgess IV419996c2016-06-16 23:06:04 +0000456 RequiredArgs required =
457 RequiredArgs::forPrototypePlus(FPT, 1, /*FD=*/nullptr);
458
Anders Carlsson27da15b2010-01-01 20:29:01 +0000459 // And the rest of the call args
George Burgess IV419996c2016-06-16 23:06:04 +0000460 EmitCallArgs(Args, FPT, E->arguments());
George Burgess IVd0a9e802017-02-23 22:07:35 +0000461 return EmitCall(CGM.getTypes().arrangeCXXMethodCall(Args, FPT, required,
462 /*PrefixSize=*/0),
Vedant Kumar09b5bfd2017-12-21 00:10:25 +0000463 Callee, ReturnValue, Args, nullptr, E->getExprLoc());
Anders Carlsson27da15b2010-01-01 20:29:01 +0000464}
465
466RValue
467CodeGenFunction::EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E,
468 const CXXMethodDecl *MD,
469 ReturnValueSlot ReturnValue) {
470 assert(MD->isInstance() &&
471 "Trying to emit a member call expr on a static method!");
Nico Weberaad4af62014-12-03 01:21:41 +0000472 return EmitCXXMemberOrOperatorMemberCallExpr(
473 E, MD, ReturnValue, /*HasQualifier=*/false, /*Qualifier=*/nullptr,
474 /*IsArrow=*/false, E->getArg(0));
Anders Carlsson27da15b2010-01-01 20:29:01 +0000475}
476
Peter Collingbournefe883422011-10-06 18:29:37 +0000477RValue CodeGenFunction::EmitCUDAKernelCallExpr(const CUDAKernelCallExpr *E,
478 ReturnValueSlot ReturnValue) {
479 return CGM.getCUDARuntime().EmitCUDAKernelCallExpr(*this, E, ReturnValue);
480}
481
Eli Friedmanfde961d2011-10-14 02:27:24 +0000482static void EmitNullBaseClassInitialization(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +0000483 Address DestPtr,
Eli Friedmanfde961d2011-10-14 02:27:24 +0000484 const CXXRecordDecl *Base) {
485 if (Base->isEmpty())
486 return;
487
John McCall7f416cc2015-09-08 08:05:57 +0000488 DestPtr = CGF.Builder.CreateElementBitCast(DestPtr, CGF.Int8Ty);
Eli Friedmanfde961d2011-10-14 02:27:24 +0000489
490 const ASTRecordLayout &Layout = CGF.getContext().getASTRecordLayout(Base);
David Majnemer8671c6e2015-11-02 09:01:44 +0000491 CharUnits NVSize = Layout.getNonVirtualSize();
492
493 // We cannot simply zero-initialize the entire base sub-object if vbptrs are
494 // present, they are initialized by the most derived class before calling the
495 // constructor.
496 SmallVector<std::pair<CharUnits, CharUnits>, 1> Stores;
497 Stores.emplace_back(CharUnits::Zero(), NVSize);
498
499 // Each store is split by the existence of a vbptr.
500 CharUnits VBPtrWidth = CGF.getPointerSize();
501 std::vector<CharUnits> VBPtrOffsets =
502 CGF.CGM.getCXXABI().getVBPtrOffsets(Base);
503 for (CharUnits VBPtrOffset : VBPtrOffsets) {
David Majnemer7f980d82016-05-12 03:51:52 +0000504 // Stop before we hit any virtual base pointers located in virtual bases.
505 if (VBPtrOffset >= NVSize)
506 break;
David Majnemer8671c6e2015-11-02 09:01:44 +0000507 std::pair<CharUnits, CharUnits> LastStore = Stores.pop_back_val();
508 CharUnits LastStoreOffset = LastStore.first;
509 CharUnits LastStoreSize = LastStore.second;
510
511 CharUnits SplitBeforeOffset = LastStoreOffset;
512 CharUnits SplitBeforeSize = VBPtrOffset - SplitBeforeOffset;
513 assert(!SplitBeforeSize.isNegative() && "negative store size!");
514 if (!SplitBeforeSize.isZero())
515 Stores.emplace_back(SplitBeforeOffset, SplitBeforeSize);
516
517 CharUnits SplitAfterOffset = VBPtrOffset + VBPtrWidth;
518 CharUnits SplitAfterSize = LastStoreSize - SplitAfterOffset;
519 assert(!SplitAfterSize.isNegative() && "negative store size!");
520 if (!SplitAfterSize.isZero())
521 Stores.emplace_back(SplitAfterOffset, SplitAfterSize);
522 }
Eli Friedmanfde961d2011-10-14 02:27:24 +0000523
524 // If the type contains a pointer to data member we can't memset it to zero.
525 // Instead, create a null constant and copy it to the destination.
526 // TODO: there are other patterns besides zero that we can usefully memset,
527 // like -1, which happens to be the pattern used by member-pointers.
528 // TODO: isZeroInitializable can be over-conservative in the case where a
529 // virtual base contains a member pointer.
David Majnemer8671c6e2015-11-02 09:01:44 +0000530 llvm::Constant *NullConstantForBase = CGF.CGM.EmitNullConstantForBase(Base);
531 if (!NullConstantForBase->isNullValue()) {
532 llvm::GlobalVariable *NullVariable = new llvm::GlobalVariable(
533 CGF.CGM.getModule(), NullConstantForBase->getType(),
534 /*isConstant=*/true, llvm::GlobalVariable::PrivateLinkage,
535 NullConstantForBase, Twine());
John McCall7f416cc2015-09-08 08:05:57 +0000536
537 CharUnits Align = std::max(Layout.getNonVirtualAlignment(),
538 DestPtr.getAlignment());
Eli Friedmanfde961d2011-10-14 02:27:24 +0000539 NullVariable->setAlignment(Align.getQuantity());
John McCall7f416cc2015-09-08 08:05:57 +0000540
541 Address SrcPtr = Address(CGF.EmitCastToVoidPtr(NullVariable), Align);
Eli Friedmanfde961d2011-10-14 02:27:24 +0000542
543 // Get and call the appropriate llvm.memcpy overload.
David Majnemer8671c6e2015-11-02 09:01:44 +0000544 for (std::pair<CharUnits, CharUnits> Store : Stores) {
545 CharUnits StoreOffset = Store.first;
546 CharUnits StoreSize = Store.second;
547 llvm::Value *StoreSizeVal = CGF.CGM.getSize(StoreSize);
548 CGF.Builder.CreateMemCpy(
549 CGF.Builder.CreateConstInBoundsByteGEP(DestPtr, StoreOffset),
550 CGF.Builder.CreateConstInBoundsByteGEP(SrcPtr, StoreOffset),
551 StoreSizeVal);
552 }
553
Eli Friedmanfde961d2011-10-14 02:27:24 +0000554 // Otherwise, just memset the whole thing to zero. This is legal
555 // because in LLVM, all default initializers (other than the ones we just
556 // handled above) are guaranteed to have a bit pattern of all zeros.
David Majnemer8671c6e2015-11-02 09:01:44 +0000557 } else {
558 for (std::pair<CharUnits, CharUnits> Store : Stores) {
559 CharUnits StoreOffset = Store.first;
560 CharUnits StoreSize = Store.second;
561 llvm::Value *StoreSizeVal = CGF.CGM.getSize(StoreSize);
562 CGF.Builder.CreateMemSet(
563 CGF.Builder.CreateConstInBoundsByteGEP(DestPtr, StoreOffset),
564 CGF.Builder.getInt8(0), StoreSizeVal);
565 }
566 }
Eli Friedmanfde961d2011-10-14 02:27:24 +0000567}
568
Anders Carlsson27da15b2010-01-01 20:29:01 +0000569void
John McCall7a626f62010-09-15 10:14:12 +0000570CodeGenFunction::EmitCXXConstructExpr(const CXXConstructExpr *E,
571 AggValueSlot Dest) {
572 assert(!Dest.isIgnored() && "Must have a destination!");
Anders Carlsson27da15b2010-01-01 20:29:01 +0000573 const CXXConstructorDecl *CD = E->getConstructor();
Fangrui Song6907ce22018-07-30 19:24:48 +0000574
Douglas Gregor630c76e2010-08-22 16:15:35 +0000575 // If we require zero initialization before (or instead of) calling the
576 // constructor, as can be the case with a non-user-provided default
Argyrios Kyrtzidis03535262011-04-28 22:57:55 +0000577 // constructor, emit the zero initialization now, unless destination is
578 // already zeroed.
Eli Friedmanfde961d2011-10-14 02:27:24 +0000579 if (E->requiresZeroInitialization() && !Dest.isZeroed()) {
580 switch (E->getConstructionKind()) {
581 case CXXConstructExpr::CK_Delegating:
Eli Friedmanfde961d2011-10-14 02:27:24 +0000582 case CXXConstructExpr::CK_Complete:
John McCall7f416cc2015-09-08 08:05:57 +0000583 EmitNullInitialization(Dest.getAddress(), E->getType());
Eli Friedmanfde961d2011-10-14 02:27:24 +0000584 break;
585 case CXXConstructExpr::CK_VirtualBase:
586 case CXXConstructExpr::CK_NonVirtualBase:
John McCall7f416cc2015-09-08 08:05:57 +0000587 EmitNullBaseClassInitialization(*this, Dest.getAddress(),
588 CD->getParent());
Eli Friedmanfde961d2011-10-14 02:27:24 +0000589 break;
590 }
591 }
Fangrui Song6907ce22018-07-30 19:24:48 +0000592
Douglas Gregor630c76e2010-08-22 16:15:35 +0000593 // If this is a call to a trivial default constructor, do nothing.
594 if (CD->isTrivial() && CD->isDefaultConstructor())
595 return;
Fangrui Song6907ce22018-07-30 19:24:48 +0000596
John McCall8ea46b62010-09-18 00:58:34 +0000597 // Elide the constructor if we're constructing from a temporary.
598 // The temporary check is required because Sema sets this on NRVO
599 // returns.
Richard Smith9c6890a2012-11-01 22:30:59 +0000600 if (getLangOpts().ElideConstructors && E->isElidable()) {
John McCall8ea46b62010-09-18 00:58:34 +0000601 assert(getContext().hasSameUnqualifiedType(E->getType(),
602 E->getArg(0)->getType()));
John McCall7a626f62010-09-15 10:14:12 +0000603 if (E->getArg(0)->isTemporaryObject(getContext(), CD->getParent())) {
604 EmitAggExpr(E->getArg(0), Dest);
Douglas Gregor222cf0e2010-05-15 00:13:29 +0000605 return;
606 }
Anders Carlsson27da15b2010-01-01 20:29:01 +0000607 }
Fangrui Song6907ce22018-07-30 19:24:48 +0000608
Alexey Bataeve7545b32016-04-29 09:39:50 +0000609 if (const ArrayType *arrayType
610 = getContext().getAsArrayType(E->getType())) {
Serge Pavlov37605182018-07-28 15:33:03 +0000611 EmitCXXAggrConstructorCall(CD, arrayType, Dest.getAddress(), E,
612 Dest.isSanitizerChecked());
John McCallf677a8e2011-07-13 06:10:41 +0000613 } else {
Cameron Esfahanibceca202011-05-06 21:28:42 +0000614 CXXCtorType Type = Ctor_Complete;
Alexis Hunt271c3682011-05-03 20:19:28 +0000615 bool ForVirtualBase = false;
Douglas Gregor61535002013-01-31 05:50:40 +0000616 bool Delegating = false;
Fangrui Song6907ce22018-07-30 19:24:48 +0000617
Alexis Hunt271c3682011-05-03 20:19:28 +0000618 switch (E->getConstructionKind()) {
619 case CXXConstructExpr::CK_Delegating:
Alexis Hunt61bc1732011-05-01 07:04:31 +0000620 // We should be emitting a constructor; GlobalDecl will assert this
621 Type = CurGD.getCtorType();
Douglas Gregor61535002013-01-31 05:50:40 +0000622 Delegating = true;
Alexis Hunt271c3682011-05-03 20:19:28 +0000623 break;
Alexis Hunt61bc1732011-05-01 07:04:31 +0000624
Alexis Hunt271c3682011-05-03 20:19:28 +0000625 case CXXConstructExpr::CK_Complete:
626 Type = Ctor_Complete;
627 break;
628
629 case CXXConstructExpr::CK_VirtualBase:
630 ForVirtualBase = true;
Adrian Prantlf3b3ccd2017-12-19 22:06:11 +0000631 LLVM_FALLTHROUGH;
Alexis Hunt271c3682011-05-03 20:19:28 +0000632
633 case CXXConstructExpr::CK_NonVirtualBase:
634 Type = Ctor_Base;
635 }
Fangrui Song6907ce22018-07-30 19:24:48 +0000636
Anders Carlsson27da15b2010-01-01 20:29:01 +0000637 // Call the constructor.
John McCall7f416cc2015-09-08 08:05:57 +0000638 EmitCXXConstructorCall(CD, Type, ForVirtualBase, Delegating,
Serge Pavlov37605182018-07-28 15:33:03 +0000639 Dest.getAddress(), E, Dest.mayOverlap(),
640 Dest.isSanitizerChecked());
Anders Carlssone11f9ce2010-05-02 23:20:53 +0000641 }
Anders Carlsson27da15b2010-01-01 20:29:01 +0000642}
643
John McCall7f416cc2015-09-08 08:05:57 +0000644void CodeGenFunction::EmitSynthesizedCXXCopyCtor(Address Dest, Address Src,
645 const Expr *Exp) {
John McCall5d413782010-12-06 08:20:24 +0000646 if (const ExprWithCleanups *E = dyn_cast<ExprWithCleanups>(Exp))
Fariborz Jahaniane988bda2010-11-13 21:53:34 +0000647 Exp = E->getSubExpr();
Fangrui Song6907ce22018-07-30 19:24:48 +0000648 assert(isa<CXXConstructExpr>(Exp) &&
Fariborz Jahaniane988bda2010-11-13 21:53:34 +0000649 "EmitSynthesizedCXXCopyCtor - unknown copy ctor expr");
650 const CXXConstructExpr* E = cast<CXXConstructExpr>(Exp);
651 const CXXConstructorDecl *CD = E->getConstructor();
652 RunCleanupsScope Scope(*this);
Fangrui Song6907ce22018-07-30 19:24:48 +0000653
Fariborz Jahaniane988bda2010-11-13 21:53:34 +0000654 // If we require zero initialization before (or instead of) calling the
655 // constructor, as can be the case with a non-user-provided default
656 // constructor, emit the zero initialization now.
657 // FIXME. Do I still need this for a copy ctor synthesis?
658 if (E->requiresZeroInitialization())
659 EmitNullInitialization(Dest, E->getType());
Fangrui Song6907ce22018-07-30 19:24:48 +0000660
Chandler Carruth99da11c2010-11-15 13:54:43 +0000661 assert(!getContext().getAsConstantArrayType(E->getType())
662 && "EmitSynthesizedCXXCopyCtor - Copied-in Array");
Alexey Samsonov525bf652014-08-25 21:58:56 +0000663 EmitSynthesizedCXXCopyCtorCall(CD, Dest, Src, E);
Fariborz Jahaniane988bda2010-11-13 21:53:34 +0000664}
665
John McCall8ed55a52010-09-02 09:58:18 +0000666static CharUnits CalculateCookiePadding(CodeGenFunction &CGF,
667 const CXXNewExpr *E) {
Anders Carlsson21122cf2009-12-13 20:04:38 +0000668 if (!E->isArray())
Ken Dyck3eb55cf2010-01-26 19:44:24 +0000669 return CharUnits::Zero();
Anders Carlsson21122cf2009-12-13 20:04:38 +0000670
John McCall7ec4b432011-05-16 01:05:12 +0000671 // No cookie is required if the operator new[] being used is the
672 // reserved placement operator new[].
673 if (E->getOperatorNew()->isReservedGlobalPlacementOperator())
John McCallaa4149a2010-08-23 01:17:59 +0000674 return CharUnits::Zero();
675
John McCall284c48f2011-01-27 09:37:56 +0000676 return CGF.CGM.getCXXABI().GetArrayCookieSize(E);
Anders Carlssonb4bd0662009-09-23 16:07:23 +0000677}
678
John McCall036f2f62011-05-15 07:14:44 +0000679static llvm::Value *EmitCXXNewAllocSize(CodeGenFunction &CGF,
680 const CXXNewExpr *e,
Sebastian Redlf862eb62012-02-22 17:37:52 +0000681 unsigned minElements,
John McCall036f2f62011-05-15 07:14:44 +0000682 llvm::Value *&numElements,
683 llvm::Value *&sizeWithoutCookie) {
684 QualType type = e->getAllocatedType();
John McCall8ed55a52010-09-02 09:58:18 +0000685
John McCall036f2f62011-05-15 07:14:44 +0000686 if (!e->isArray()) {
687 CharUnits typeSize = CGF.getContext().getTypeSizeInChars(type);
688 sizeWithoutCookie
689 = llvm::ConstantInt::get(CGF.SizeTy, typeSize.getQuantity());
690 return sizeWithoutCookie;
Douglas Gregor05fc5be2010-07-21 01:10:17 +0000691 }
Anders Carlssonb4bd0662009-09-23 16:07:23 +0000692
John McCall036f2f62011-05-15 07:14:44 +0000693 // The width of size_t.
694 unsigned sizeWidth = CGF.SizeTy->getBitWidth();
695
John McCall8ed55a52010-09-02 09:58:18 +0000696 // Figure out the cookie size.
John McCall036f2f62011-05-15 07:14:44 +0000697 llvm::APInt cookieSize(sizeWidth,
698 CalculateCookiePadding(CGF, e).getQuantity());
John McCall8ed55a52010-09-02 09:58:18 +0000699
Anders Carlssonb4bd0662009-09-23 16:07:23 +0000700 // Emit the array size expression.
Argyrios Kyrtzidis7648fb42010-08-26 15:23:38 +0000701 // We multiply the size of all dimensions for NumElements.
702 // e.g for 'int[2][3]', ElemType is 'int' and NumElements is 6.
John McCallde0fe072017-08-15 21:42:52 +0000703 numElements =
704 ConstantEmitter(CGF).tryEmitAbstract(e->getArraySize(), e->getType());
Nick Lewycky07527622017-02-13 23:49:55 +0000705 if (!numElements)
706 numElements = CGF.EmitScalarExpr(e->getArraySize());
John McCall036f2f62011-05-15 07:14:44 +0000707 assert(isa<llvm::IntegerType>(numElements->getType()));
John McCall8ed55a52010-09-02 09:58:18 +0000708
John McCall036f2f62011-05-15 07:14:44 +0000709 // The number of elements can be have an arbitrary integer type;
710 // essentially, we need to multiply it by a constant factor, add a
711 // cookie size, and verify that the result is representable as a
712 // size_t. That's just a gloss, though, and it's wrong in one
713 // important way: if the count is negative, it's an error even if
714 // the cookie size would bring the total size >= 0.
Fangrui Song6907ce22018-07-30 19:24:48 +0000715 bool isSigned
Douglas Gregor6ab2fa82011-05-20 16:38:50 +0000716 = e->getArraySize()->getType()->isSignedIntegerOrEnumerationType();
Chris Lattner2192fe52011-07-18 04:24:23 +0000717 llvm::IntegerType *numElementsType
John McCall036f2f62011-05-15 07:14:44 +0000718 = cast<llvm::IntegerType>(numElements->getType());
719 unsigned numElementsWidth = numElementsType->getBitWidth();
720
721 // Compute the constant factor.
722 llvm::APInt arraySizeMultiplier(sizeWidth, 1);
Argyrios Kyrtzidis7648fb42010-08-26 15:23:38 +0000723 while (const ConstantArrayType *CAT
John McCall036f2f62011-05-15 07:14:44 +0000724 = CGF.getContext().getAsConstantArrayType(type)) {
725 type = CAT->getElementType();
726 arraySizeMultiplier *= CAT->getSize();
Argyrios Kyrtzidis7648fb42010-08-26 15:23:38 +0000727 }
728
John McCall036f2f62011-05-15 07:14:44 +0000729 CharUnits typeSize = CGF.getContext().getTypeSizeInChars(type);
730 llvm::APInt typeSizeMultiplier(sizeWidth, typeSize.getQuantity());
731 typeSizeMultiplier *= arraySizeMultiplier;
732
733 // This will be a size_t.
734 llvm::Value *size;
Fangrui Song6907ce22018-07-30 19:24:48 +0000735
Chris Lattner32ac5832010-07-20 21:55:52 +0000736 // If someone is doing 'new int[42]' there is no need to do a dynamic check.
737 // Don't bloat the -O0 code.
John McCall036f2f62011-05-15 07:14:44 +0000738 if (llvm::ConstantInt *numElementsC =
739 dyn_cast<llvm::ConstantInt>(numElements)) {
740 const llvm::APInt &count = numElementsC->getValue();
John McCall8ed55a52010-09-02 09:58:18 +0000741
John McCall036f2f62011-05-15 07:14:44 +0000742 bool hasAnyOverflow = false;
John McCall8ed55a52010-09-02 09:58:18 +0000743
John McCall036f2f62011-05-15 07:14:44 +0000744 // If 'count' was a negative number, it's an overflow.
745 if (isSigned && count.isNegative())
746 hasAnyOverflow = true;
John McCall8ed55a52010-09-02 09:58:18 +0000747
John McCall036f2f62011-05-15 07:14:44 +0000748 // We want to do all this arithmetic in size_t. If numElements is
749 // wider than that, check whether it's already too big, and if so,
750 // overflow.
751 else if (numElementsWidth > sizeWidth &&
752 numElementsWidth - sizeWidth > count.countLeadingZeros())
753 hasAnyOverflow = true;
754
755 // Okay, compute a count at the right width.
756 llvm::APInt adjustedCount = count.zextOrTrunc(sizeWidth);
757
Sebastian Redlf862eb62012-02-22 17:37:52 +0000758 // If there is a brace-initializer, we cannot allocate fewer elements than
759 // there are initializers. If we do, that's treated like an overflow.
760 if (adjustedCount.ult(minElements))
761 hasAnyOverflow = true;
762
John McCall036f2f62011-05-15 07:14:44 +0000763 // Scale numElements by that. This might overflow, but we don't
764 // care because it only overflows if allocationSize does, too, and
765 // if that overflows then we shouldn't use this.
766 numElements = llvm::ConstantInt::get(CGF.SizeTy,
767 adjustedCount * arraySizeMultiplier);
768
769 // Compute the size before cookie, and track whether it overflowed.
770 bool overflow;
771 llvm::APInt allocationSize
772 = adjustedCount.umul_ov(typeSizeMultiplier, overflow);
773 hasAnyOverflow |= overflow;
774
775 // Add in the cookie, and check whether it's overflowed.
776 if (cookieSize != 0) {
777 // Save the current size without a cookie. This shouldn't be
778 // used if there was overflow.
779 sizeWithoutCookie = llvm::ConstantInt::get(CGF.SizeTy, allocationSize);
780
781 allocationSize = allocationSize.uadd_ov(cookieSize, overflow);
782 hasAnyOverflow |= overflow;
783 }
784
785 // On overflow, produce a -1 so operator new will fail.
Aaron Ballman455f42c2014-08-28 17:24:14 +0000786 if (hasAnyOverflow) {
787 size = llvm::Constant::getAllOnesValue(CGF.SizeTy);
788 } else {
John McCall036f2f62011-05-15 07:14:44 +0000789 size = llvm::ConstantInt::get(CGF.SizeTy, allocationSize);
Aaron Ballman455f42c2014-08-28 17:24:14 +0000790 }
John McCall036f2f62011-05-15 07:14:44 +0000791
792 // Otherwise, we might need to use the overflow intrinsics.
793 } else {
Sebastian Redlf862eb62012-02-22 17:37:52 +0000794 // There are up to five conditions we need to test for:
John McCall036f2f62011-05-15 07:14:44 +0000795 // 1) if isSigned, we need to check whether numElements is negative;
796 // 2) if numElementsWidth > sizeWidth, we need to check whether
797 // numElements is larger than something representable in size_t;
Sebastian Redlf862eb62012-02-22 17:37:52 +0000798 // 3) if minElements > 0, we need to check whether numElements is smaller
799 // than that.
800 // 4) we need to compute
John McCall036f2f62011-05-15 07:14:44 +0000801 // sizeWithoutCookie := numElements * typeSizeMultiplier
802 // and check whether it overflows; and
Sebastian Redlf862eb62012-02-22 17:37:52 +0000803 // 5) if we need a cookie, we need to compute
John McCall036f2f62011-05-15 07:14:44 +0000804 // size := sizeWithoutCookie + cookieSize
805 // and check whether it overflows.
806
Craig Topper8a13c412014-05-21 05:09:00 +0000807 llvm::Value *hasOverflow = nullptr;
John McCall036f2f62011-05-15 07:14:44 +0000808
809 // If numElementsWidth > sizeWidth, then one way or another, we're
810 // going to have to do a comparison for (2), and this happens to
811 // take care of (1), too.
812 if (numElementsWidth > sizeWidth) {
813 llvm::APInt threshold(numElementsWidth, 1);
814 threshold <<= sizeWidth;
815
816 llvm::Value *thresholdV
817 = llvm::ConstantInt::get(numElementsType, threshold);
818
819 hasOverflow = CGF.Builder.CreateICmpUGE(numElements, thresholdV);
820 numElements = CGF.Builder.CreateTrunc(numElements, CGF.SizeTy);
821
822 // Otherwise, if we're signed, we want to sext up to size_t.
823 } else if (isSigned) {
824 if (numElementsWidth < sizeWidth)
825 numElements = CGF.Builder.CreateSExt(numElements, CGF.SizeTy);
Fangrui Song6907ce22018-07-30 19:24:48 +0000826
John McCall036f2f62011-05-15 07:14:44 +0000827 // If there's a non-1 type size multiplier, then we can do the
828 // signedness check at the same time as we do the multiply
829 // because a negative number times anything will cause an
Sebastian Redlf862eb62012-02-22 17:37:52 +0000830 // unsigned overflow. Otherwise, we have to do it here. But at least
831 // in this case, we can subsume the >= minElements check.
John McCall036f2f62011-05-15 07:14:44 +0000832 if (typeSizeMultiplier == 1)
833 hasOverflow = CGF.Builder.CreateICmpSLT(numElements,
Sebastian Redlf862eb62012-02-22 17:37:52 +0000834 llvm::ConstantInt::get(CGF.SizeTy, minElements));
John McCall036f2f62011-05-15 07:14:44 +0000835
836 // Otherwise, zext up to size_t if necessary.
837 } else if (numElementsWidth < sizeWidth) {
838 numElements = CGF.Builder.CreateZExt(numElements, CGF.SizeTy);
839 }
840
841 assert(numElements->getType() == CGF.SizeTy);
842
Sebastian Redlf862eb62012-02-22 17:37:52 +0000843 if (minElements) {
844 // Don't allow allocation of fewer elements than we have initializers.
845 if (!hasOverflow) {
846 hasOverflow = CGF.Builder.CreateICmpULT(numElements,
847 llvm::ConstantInt::get(CGF.SizeTy, minElements));
848 } else if (numElementsWidth > sizeWidth) {
849 // The other existing overflow subsumes this check.
850 // We do an unsigned comparison, since any signed value < -1 is
851 // taken care of either above or below.
852 hasOverflow = CGF.Builder.CreateOr(hasOverflow,
853 CGF.Builder.CreateICmpULT(numElements,
854 llvm::ConstantInt::get(CGF.SizeTy, minElements)));
855 }
856 }
857
John McCall036f2f62011-05-15 07:14:44 +0000858 size = numElements;
859
860 // Multiply by the type size if necessary. This multiplier
861 // includes all the factors for nested arrays.
862 //
863 // This step also causes numElements to be scaled up by the
864 // nested-array factor if necessary. Overflow on this computation
865 // can be ignored because the result shouldn't be used if
866 // allocation fails.
867 if (typeSizeMultiplier != 1) {
John McCall036f2f62011-05-15 07:14:44 +0000868 llvm::Value *umul_with_overflow
Benjamin Kramer8d375ce2011-07-14 17:45:50 +0000869 = CGF.CGM.getIntrinsic(llvm::Intrinsic::umul_with_overflow, CGF.SizeTy);
John McCall036f2f62011-05-15 07:14:44 +0000870
871 llvm::Value *tsmV =
872 llvm::ConstantInt::get(CGF.SizeTy, typeSizeMultiplier);
873 llvm::Value *result =
David Blaikie43f9bb72015-05-18 22:14:03 +0000874 CGF.Builder.CreateCall(umul_with_overflow, {size, tsmV});
John McCall036f2f62011-05-15 07:14:44 +0000875
876 llvm::Value *overflowed = CGF.Builder.CreateExtractValue(result, 1);
877 if (hasOverflow)
878 hasOverflow = CGF.Builder.CreateOr(hasOverflow, overflowed);
879 else
880 hasOverflow = overflowed;
881
882 size = CGF.Builder.CreateExtractValue(result, 0);
883
884 // Also scale up numElements by the array size multiplier.
885 if (arraySizeMultiplier != 1) {
886 // If the base element type size is 1, then we can re-use the
887 // multiply we just did.
888 if (typeSize.isOne()) {
889 assert(arraySizeMultiplier == typeSizeMultiplier);
890 numElements = size;
891
892 // Otherwise we need a separate multiply.
893 } else {
894 llvm::Value *asmV =
895 llvm::ConstantInt::get(CGF.SizeTy, arraySizeMultiplier);
896 numElements = CGF.Builder.CreateMul(numElements, asmV);
897 }
898 }
899 } else {
900 // numElements doesn't need to be scaled.
901 assert(arraySizeMultiplier == 1);
Chris Lattner32ac5832010-07-20 21:55:52 +0000902 }
Fangrui Song6907ce22018-07-30 19:24:48 +0000903
John McCall036f2f62011-05-15 07:14:44 +0000904 // Add in the cookie size if necessary.
905 if (cookieSize != 0) {
906 sizeWithoutCookie = size;
907
John McCall036f2f62011-05-15 07:14:44 +0000908 llvm::Value *uadd_with_overflow
Benjamin Kramer8d375ce2011-07-14 17:45:50 +0000909 = CGF.CGM.getIntrinsic(llvm::Intrinsic::uadd_with_overflow, CGF.SizeTy);
John McCall036f2f62011-05-15 07:14:44 +0000910
911 llvm::Value *cookieSizeV = llvm::ConstantInt::get(CGF.SizeTy, cookieSize);
912 llvm::Value *result =
David Blaikie43f9bb72015-05-18 22:14:03 +0000913 CGF.Builder.CreateCall(uadd_with_overflow, {size, cookieSizeV});
John McCall036f2f62011-05-15 07:14:44 +0000914
915 llvm::Value *overflowed = CGF.Builder.CreateExtractValue(result, 1);
916 if (hasOverflow)
917 hasOverflow = CGF.Builder.CreateOr(hasOverflow, overflowed);
918 else
919 hasOverflow = overflowed;
920
921 size = CGF.Builder.CreateExtractValue(result, 0);
John McCall8ed55a52010-09-02 09:58:18 +0000922 }
Anders Carlssonb4bd0662009-09-23 16:07:23 +0000923
John McCall036f2f62011-05-15 07:14:44 +0000924 // If we had any possibility of dynamic overflow, make a select to
925 // overwrite 'size' with an all-ones value, which should cause
926 // operator new to throw.
927 if (hasOverflow)
Aaron Ballman455f42c2014-08-28 17:24:14 +0000928 size = CGF.Builder.CreateSelect(hasOverflow,
929 llvm::Constant::getAllOnesValue(CGF.SizeTy),
930 size);
Chris Lattner32ac5832010-07-20 21:55:52 +0000931 }
John McCall8ed55a52010-09-02 09:58:18 +0000932
John McCall036f2f62011-05-15 07:14:44 +0000933 if (cookieSize == 0)
934 sizeWithoutCookie = size;
John McCall8ed55a52010-09-02 09:58:18 +0000935 else
John McCall036f2f62011-05-15 07:14:44 +0000936 assert(sizeWithoutCookie && "didn't set sizeWithoutCookie?");
John McCall8ed55a52010-09-02 09:58:18 +0000937
John McCall036f2f62011-05-15 07:14:44 +0000938 return size;
Anders Carlssonb4bd0662009-09-23 16:07:23 +0000939}
940
Sebastian Redlf862eb62012-02-22 17:37:52 +0000941static void StoreAnyExprIntoOneUnit(CodeGenFunction &CGF, const Expr *Init,
Richard Smithe78fac52018-04-05 20:52:58 +0000942 QualType AllocType, Address NewPtr,
943 AggValueSlot::Overlap_t MayOverlap) {
Richard Smith1c96bc52013-12-11 01:40:16 +0000944 // FIXME: Refactor with EmitExprAsInit.
John McCall47fb9502013-03-07 21:37:08 +0000945 switch (CGF.getEvaluationKind(AllocType)) {
946 case TEK_Scalar:
David Blaikiea2c11242014-12-10 19:04:09 +0000947 CGF.EmitScalarInit(Init, nullptr,
John McCall7f416cc2015-09-08 08:05:57 +0000948 CGF.MakeAddrLValue(NewPtr, AllocType), false);
John McCall47fb9502013-03-07 21:37:08 +0000949 return;
950 case TEK_Complex:
John McCall7f416cc2015-09-08 08:05:57 +0000951 CGF.EmitComplexExprIntoLValue(Init, CGF.MakeAddrLValue(NewPtr, AllocType),
John McCall47fb9502013-03-07 21:37:08 +0000952 /*isInit*/ true);
953 return;
954 case TEK_Aggregate: {
John McCall7a626f62010-09-15 10:14:12 +0000955 AggValueSlot Slot
John McCall7f416cc2015-09-08 08:05:57 +0000956 = AggValueSlot::forAddr(NewPtr, AllocType.getQualifiers(),
John McCall8d6fc952011-08-25 20:40:09 +0000957 AggValueSlot::IsDestructed,
John McCall46759f42011-08-26 07:31:35 +0000958 AggValueSlot::DoesNotNeedGCBarriers,
Richard Smithe78fac52018-04-05 20:52:58 +0000959 AggValueSlot::IsNotAliased,
Serge Pavlov37605182018-07-28 15:33:03 +0000960 MayOverlap, AggValueSlot::IsNotZeroed,
961 AggValueSlot::IsSanitizerChecked);
John McCall7a626f62010-09-15 10:14:12 +0000962 CGF.EmitAggExpr(Init, Slot);
John McCall47fb9502013-03-07 21:37:08 +0000963 return;
John McCall7a626f62010-09-15 10:14:12 +0000964 }
John McCall47fb9502013-03-07 21:37:08 +0000965 }
966 llvm_unreachable("bad evaluation kind");
Fariborz Jahaniand5202e02010-06-25 18:26:07 +0000967}
968
David Blaikiefb901c7a2015-04-04 15:12:29 +0000969void CodeGenFunction::EmitNewArrayInitializer(
970 const CXXNewExpr *E, QualType ElementType, llvm::Type *ElementTy,
John McCall7f416cc2015-09-08 08:05:57 +0000971 Address BeginPtr, llvm::Value *NumElements,
David Blaikiefb901c7a2015-04-04 15:12:29 +0000972 llvm::Value *AllocSizeWithoutCookie) {
Richard Smith06a67e22014-06-03 06:58:52 +0000973 // If we have a type with trivial initialization and no initializer,
974 // there's nothing to do.
Sebastian Redl6047f072012-02-16 12:22:20 +0000975 if (!E->hasInitializer())
Richard Smith06a67e22014-06-03 06:58:52 +0000976 return;
John McCall99210dc2011-09-15 06:49:18 +0000977
John McCall7f416cc2015-09-08 08:05:57 +0000978 Address CurPtr = BeginPtr;
John McCall99210dc2011-09-15 06:49:18 +0000979
Richard Smith06a67e22014-06-03 06:58:52 +0000980 unsigned InitListElements = 0;
Sebastian Redlf862eb62012-02-22 17:37:52 +0000981
982 const Expr *Init = E->getInitializer();
John McCall7f416cc2015-09-08 08:05:57 +0000983 Address EndOfInit = Address::invalid();
Richard Smith06a67e22014-06-03 06:58:52 +0000984 QualType::DestructionKind DtorKind = ElementType.isDestructedType();
985 EHScopeStack::stable_iterator Cleanup;
986 llvm::Instruction *CleanupDominator = nullptr;
Richard Smith1c96bc52013-12-11 01:40:16 +0000987
John McCall7f416cc2015-09-08 08:05:57 +0000988 CharUnits ElementSize = getContext().getTypeSizeInChars(ElementType);
989 CharUnits ElementAlign =
990 BeginPtr.getAlignment().alignmentOfArrayElement(ElementSize);
991
Richard Smith0511d232016-10-05 22:41:02 +0000992 // Attempt to perform zero-initialization using memset.
993 auto TryMemsetInitialization = [&]() -> bool {
994 // FIXME: If the type is a pointer-to-data-member under the Itanium ABI,
995 // we can initialize with a memset to -1.
996 if (!CGM.getTypes().isZeroInitializable(ElementType))
997 return false;
998
999 // Optimization: since zero initialization will just set the memory
1000 // to all zeroes, generate a single memset to do it in one shot.
1001
1002 // Subtract out the size of any elements we've already initialized.
1003 auto *RemainingSize = AllocSizeWithoutCookie;
1004 if (InitListElements) {
1005 // We know this can't overflow; we check this when doing the allocation.
1006 auto *InitializedSize = llvm::ConstantInt::get(
1007 RemainingSize->getType(),
1008 getContext().getTypeSizeInChars(ElementType).getQuantity() *
1009 InitListElements);
1010 RemainingSize = Builder.CreateSub(RemainingSize, InitializedSize);
1011 }
1012
1013 // Create the memset.
1014 Builder.CreateMemSet(CurPtr, Builder.getInt8(0), RemainingSize, false);
1015 return true;
1016 };
1017
Sebastian Redlf862eb62012-02-22 17:37:52 +00001018 // If the initializer is an initializer list, first do the explicit elements.
1019 if (const InitListExpr *ILE = dyn_cast<InitListExpr>(Init)) {
Richard Smith0511d232016-10-05 22:41:02 +00001020 // Initializing from a (braced) string literal is a special case; the init
1021 // list element does not initialize a (single) array element.
1022 if (ILE->isStringLiteralInit()) {
1023 // Initialize the initial portion of length equal to that of the string
1024 // literal. The allocation must be for at least this much; we emitted a
1025 // check for that earlier.
1026 AggValueSlot Slot =
1027 AggValueSlot::forAddr(CurPtr, ElementType.getQualifiers(),
1028 AggValueSlot::IsDestructed,
1029 AggValueSlot::DoesNotNeedGCBarriers,
Richard Smithe78fac52018-04-05 20:52:58 +00001030 AggValueSlot::IsNotAliased,
Serge Pavlov37605182018-07-28 15:33:03 +00001031 AggValueSlot::DoesNotOverlap,
1032 AggValueSlot::IsNotZeroed,
1033 AggValueSlot::IsSanitizerChecked);
Richard Smith0511d232016-10-05 22:41:02 +00001034 EmitAggExpr(ILE->getInit(0), Slot);
1035
1036 // Move past these elements.
1037 InitListElements =
1038 cast<ConstantArrayType>(ILE->getType()->getAsArrayTypeUnsafe())
1039 ->getSize().getZExtValue();
1040 CurPtr =
1041 Address(Builder.CreateInBoundsGEP(CurPtr.getPointer(),
1042 Builder.getSize(InitListElements),
1043 "string.init.end"),
1044 CurPtr.getAlignment().alignmentAtOffset(InitListElements *
1045 ElementSize));
1046
1047 // Zero out the rest, if any remain.
1048 llvm::ConstantInt *ConstNum = dyn_cast<llvm::ConstantInt>(NumElements);
1049 if (!ConstNum || !ConstNum->equalsInt(InitListElements)) {
1050 bool OK = TryMemsetInitialization();
1051 (void)OK;
1052 assert(OK && "couldn't memset character type?");
1053 }
1054 return;
1055 }
1056
Richard Smith06a67e22014-06-03 06:58:52 +00001057 InitListElements = ILE->getNumInits();
Chad Rosierf62290a2012-02-24 00:13:55 +00001058
Richard Smith1c96bc52013-12-11 01:40:16 +00001059 // If this is a multi-dimensional array new, we will initialize multiple
1060 // elements with each init list element.
1061 QualType AllocType = E->getAllocatedType();
1062 if (const ConstantArrayType *CAT = dyn_cast_or_null<ConstantArrayType>(
1063 AllocType->getAsArrayTypeUnsafe())) {
David Blaikiefb901c7a2015-04-04 15:12:29 +00001064 ElementTy = ConvertTypeForMem(AllocType);
John McCall7f416cc2015-09-08 08:05:57 +00001065 CurPtr = Builder.CreateElementBitCast(CurPtr, ElementTy);
Richard Smith06a67e22014-06-03 06:58:52 +00001066 InitListElements *= getContext().getConstantArrayElementCount(CAT);
Richard Smith1c96bc52013-12-11 01:40:16 +00001067 }
1068
Richard Smith06a67e22014-06-03 06:58:52 +00001069 // Enter a partial-destruction Cleanup if necessary.
1070 if (needsEHCleanup(DtorKind)) {
1071 // In principle we could tell the Cleanup where we are more
Chad Rosierf62290a2012-02-24 00:13:55 +00001072 // directly, but the control flow can get so varied here that it
1073 // would actually be quite complex. Therefore we go through an
1074 // alloca.
John McCall7f416cc2015-09-08 08:05:57 +00001075 EndOfInit = CreateTempAlloca(BeginPtr.getType(), getPointerAlign(),
1076 "array.init.end");
1077 CleanupDominator = Builder.CreateStore(BeginPtr.getPointer(), EndOfInit);
1078 pushIrregularPartialArrayCleanup(BeginPtr.getPointer(), EndOfInit,
1079 ElementType, ElementAlign,
Richard Smith06a67e22014-06-03 06:58:52 +00001080 getDestroyer(DtorKind));
1081 Cleanup = EHStack.stable_begin();
Chad Rosierf62290a2012-02-24 00:13:55 +00001082 }
1083
John McCall7f416cc2015-09-08 08:05:57 +00001084 CharUnits StartAlign = CurPtr.getAlignment();
Sebastian Redlf862eb62012-02-22 17:37:52 +00001085 for (unsigned i = 0, e = ILE->getNumInits(); i != e; ++i) {
Chad Rosierf62290a2012-02-24 00:13:55 +00001086 // Tell the cleanup that it needs to destroy up to this
1087 // element. TODO: some of these stores can be trivially
1088 // observed to be unnecessary.
John McCall7f416cc2015-09-08 08:05:57 +00001089 if (EndOfInit.isValid()) {
1090 auto FinishedPtr =
1091 Builder.CreateBitCast(CurPtr.getPointer(), BeginPtr.getType());
1092 Builder.CreateStore(FinishedPtr, EndOfInit);
1093 }
Richard Smith06a67e22014-06-03 06:58:52 +00001094 // FIXME: If the last initializer is an incomplete initializer list for
1095 // an array, and we have an array filler, we can fold together the two
1096 // initialization loops.
Richard Smith1c96bc52013-12-11 01:40:16 +00001097 StoreAnyExprIntoOneUnit(*this, ILE->getInit(i),
Richard Smithe78fac52018-04-05 20:52:58 +00001098 ILE->getInit(i)->getType(), CurPtr,
1099 AggValueSlot::DoesNotOverlap);
John McCall7f416cc2015-09-08 08:05:57 +00001100 CurPtr = Address(Builder.CreateInBoundsGEP(CurPtr.getPointer(),
1101 Builder.getSize(1),
1102 "array.exp.next"),
1103 StartAlign.alignmentAtOffset((i + 1) * ElementSize));
Sebastian Redlf862eb62012-02-22 17:37:52 +00001104 }
1105
1106 // The remaining elements are filled with the array filler expression.
1107 Init = ILE->getArrayFiller();
Richard Smith1c96bc52013-12-11 01:40:16 +00001108
Richard Smith06a67e22014-06-03 06:58:52 +00001109 // Extract the initializer for the individual array elements by pulling
1110 // out the array filler from all the nested initializer lists. This avoids
1111 // generating a nested loop for the initialization.
1112 while (Init && Init->getType()->isConstantArrayType()) {
1113 auto *SubILE = dyn_cast<InitListExpr>(Init);
1114 if (!SubILE)
1115 break;
1116 assert(SubILE->getNumInits() == 0 && "explicit inits in array filler?");
1117 Init = SubILE->getArrayFiller();
1118 }
1119
1120 // Switch back to initializing one base element at a time.
John McCall7f416cc2015-09-08 08:05:57 +00001121 CurPtr = Builder.CreateBitCast(CurPtr, BeginPtr.getType());
Sebastian Redlf862eb62012-02-22 17:37:52 +00001122 }
1123
Richard Smith454a7cd2014-06-03 08:26:00 +00001124 // If all elements have already been initialized, skip any further
1125 // initialization.
1126 llvm::ConstantInt *ConstNum = dyn_cast<llvm::ConstantInt>(NumElements);
1127 if (ConstNum && ConstNum->getZExtValue() <= InitListElements) {
1128 // If there was a Cleanup, deactivate it.
1129 if (CleanupDominator)
1130 DeactivateCleanupBlock(Cleanup, CleanupDominator);
1131 return;
1132 }
1133
1134 assert(Init && "have trailing elements to initialize but no initializer");
1135
Richard Smith06a67e22014-06-03 06:58:52 +00001136 // If this is a constructor call, try to optimize it out, and failing that
1137 // emit a single loop to initialize all remaining elements.
Richard Smith454a7cd2014-06-03 08:26:00 +00001138 if (const CXXConstructExpr *CCE = dyn_cast<CXXConstructExpr>(Init)) {
Richard Smith06a67e22014-06-03 06:58:52 +00001139 CXXConstructorDecl *Ctor = CCE->getConstructor();
1140 if (Ctor->isTrivial()) {
1141 // If new expression did not specify value-initialization, then there
1142 // is no initialization.
1143 if (!CCE->requiresZeroInitialization() || Ctor->getParent()->isEmpty())
1144 return;
1145
1146 if (TryMemsetInitialization())
1147 return;
1148 }
1149
1150 // Store the new Cleanup position for irregular Cleanups.
1151 //
1152 // FIXME: Share this cleanup with the constructor call emission rather than
1153 // having it create a cleanup of its own.
John McCall7f416cc2015-09-08 08:05:57 +00001154 if (EndOfInit.isValid())
1155 Builder.CreateStore(CurPtr.getPointer(), EndOfInit);
Richard Smith06a67e22014-06-03 06:58:52 +00001156
1157 // Emit a constructor call loop to initialize the remaining elements.
1158 if (InitListElements)
1159 NumElements = Builder.CreateSub(
1160 NumElements,
1161 llvm::ConstantInt::get(NumElements->getType(), InitListElements));
Alexey Samsonov70b9c012014-08-21 20:26:47 +00001162 EmitCXXAggrConstructorCall(Ctor, NumElements, CurPtr, CCE,
Serge Pavlov37605182018-07-28 15:33:03 +00001163 /*NewPointerIsChecked*/true,
Richard Smith06a67e22014-06-03 06:58:52 +00001164 CCE->requiresZeroInitialization());
Chandler Carruthe6c980c2014-05-03 09:16:57 +00001165 return;
1166 }
1167
Richard Smith06a67e22014-06-03 06:58:52 +00001168 // If this is value-initialization, we can usually use memset.
1169 ImplicitValueInitExpr IVIE(ElementType);
Richard Smith454a7cd2014-06-03 08:26:00 +00001170 if (isa<ImplicitValueInitExpr>(Init)) {
Richard Smith06a67e22014-06-03 06:58:52 +00001171 if (TryMemsetInitialization())
1172 return;
1173
1174 // Switch to an ImplicitValueInitExpr for the element type. This handles
1175 // only one case: multidimensional array new of pointers to members. In
1176 // all other cases, we already have an initializer for the array element.
1177 Init = &IVIE;
1178 }
1179
1180 // At this point we should have found an initializer for the individual
1181 // elements of the array.
1182 assert(getContext().hasSameUnqualifiedType(ElementType, Init->getType()) &&
1183 "got wrong type of element to initialize");
1184
Richard Smith454a7cd2014-06-03 08:26:00 +00001185 // If we have an empty initializer list, we can usually use memset.
1186 if (auto *ILE = dyn_cast<InitListExpr>(Init))
1187 if (ILE->getNumInits() == 0 && TryMemsetInitialization())
1188 return;
Richard Smith06a67e22014-06-03 06:58:52 +00001189
Yunzhong Gaocb779302015-06-10 00:27:52 +00001190 // If we have a struct whose every field is value-initialized, we can
1191 // usually use memset.
1192 if (auto *ILE = dyn_cast<InitListExpr>(Init)) {
1193 if (const RecordType *RType = ILE->getType()->getAs<RecordType>()) {
1194 if (RType->getDecl()->isStruct()) {
Richard Smith872307e2016-03-08 22:17:41 +00001195 unsigned NumElements = 0;
1196 if (auto *CXXRD = dyn_cast<CXXRecordDecl>(RType->getDecl()))
1197 NumElements = CXXRD->getNumBases();
Yunzhong Gaocb779302015-06-10 00:27:52 +00001198 for (auto *Field : RType->getDecl()->fields())
1199 if (!Field->isUnnamedBitfield())
Richard Smith872307e2016-03-08 22:17:41 +00001200 ++NumElements;
1201 // FIXME: Recurse into nested InitListExprs.
1202 if (ILE->getNumInits() == NumElements)
Yunzhong Gaocb779302015-06-10 00:27:52 +00001203 for (unsigned i = 0, e = ILE->getNumInits(); i != e; ++i)
1204 if (!isa<ImplicitValueInitExpr>(ILE->getInit(i)))
Richard Smith872307e2016-03-08 22:17:41 +00001205 --NumElements;
1206 if (ILE->getNumInits() == NumElements && TryMemsetInitialization())
Yunzhong Gaocb779302015-06-10 00:27:52 +00001207 return;
1208 }
1209 }
1210 }
1211
Richard Smith06a67e22014-06-03 06:58:52 +00001212 // Create the loop blocks.
1213 llvm::BasicBlock *EntryBB = Builder.GetInsertBlock();
1214 llvm::BasicBlock *LoopBB = createBasicBlock("new.loop");
1215 llvm::BasicBlock *ContBB = createBasicBlock("new.loop.end");
1216
1217 // Find the end of the array, hoisted out of the loop.
1218 llvm::Value *EndPtr =
John McCall7f416cc2015-09-08 08:05:57 +00001219 Builder.CreateInBoundsGEP(BeginPtr.getPointer(), NumElements, "array.end");
John McCall99210dc2011-09-15 06:49:18 +00001220
Sebastian Redlf862eb62012-02-22 17:37:52 +00001221 // If the number of elements isn't constant, we have to now check if there is
1222 // anything left to initialize.
Richard Smith06a67e22014-06-03 06:58:52 +00001223 if (!ConstNum) {
John McCall7f416cc2015-09-08 08:05:57 +00001224 llvm::Value *IsEmpty =
1225 Builder.CreateICmpEQ(CurPtr.getPointer(), EndPtr, "array.isempty");
Richard Smith06a67e22014-06-03 06:58:52 +00001226 Builder.CreateCondBr(IsEmpty, ContBB, LoopBB);
John McCall99210dc2011-09-15 06:49:18 +00001227 }
1228
1229 // Enter the loop.
Richard Smith06a67e22014-06-03 06:58:52 +00001230 EmitBlock(LoopBB);
John McCall99210dc2011-09-15 06:49:18 +00001231
1232 // Set up the current-element phi.
Richard Smith06a67e22014-06-03 06:58:52 +00001233 llvm::PHINode *CurPtrPhi =
John McCall7f416cc2015-09-08 08:05:57 +00001234 Builder.CreatePHI(CurPtr.getType(), 2, "array.cur");
1235 CurPtrPhi->addIncoming(CurPtr.getPointer(), EntryBB);
1236
1237 CurPtr = Address(CurPtrPhi, ElementAlign);
John McCall99210dc2011-09-15 06:49:18 +00001238
Richard Smith06a67e22014-06-03 06:58:52 +00001239 // Store the new Cleanup position for irregular Cleanups.
Fangrui Song6907ce22018-07-30 19:24:48 +00001240 if (EndOfInit.isValid())
John McCall7f416cc2015-09-08 08:05:57 +00001241 Builder.CreateStore(CurPtr.getPointer(), EndOfInit);
Chad Rosierf62290a2012-02-24 00:13:55 +00001242
Richard Smith06a67e22014-06-03 06:58:52 +00001243 // Enter a partial-destruction Cleanup if necessary.
1244 if (!CleanupDominator && needsEHCleanup(DtorKind)) {
John McCall7f416cc2015-09-08 08:05:57 +00001245 pushRegularPartialArrayCleanup(BeginPtr.getPointer(), CurPtr.getPointer(),
1246 ElementType, ElementAlign,
Richard Smith06a67e22014-06-03 06:58:52 +00001247 getDestroyer(DtorKind));
1248 Cleanup = EHStack.stable_begin();
1249 CleanupDominator = Builder.CreateUnreachable();
John McCall99210dc2011-09-15 06:49:18 +00001250 }
1251
1252 // Emit the initializer into this element.
Richard Smithe78fac52018-04-05 20:52:58 +00001253 StoreAnyExprIntoOneUnit(*this, Init, Init->getType(), CurPtr,
1254 AggValueSlot::DoesNotOverlap);
John McCall99210dc2011-09-15 06:49:18 +00001255
Richard Smith06a67e22014-06-03 06:58:52 +00001256 // Leave the Cleanup if we entered one.
1257 if (CleanupDominator) {
1258 DeactivateCleanupBlock(Cleanup, CleanupDominator);
1259 CleanupDominator->eraseFromParent();
John McCallf4beacd2011-11-10 10:43:54 +00001260 }
John McCall99210dc2011-09-15 06:49:18 +00001261
Faisal Vali57ae0562013-12-14 00:40:05 +00001262 // Advance to the next element by adjusting the pointer type as necessary.
Richard Smith06a67e22014-06-03 06:58:52 +00001263 llvm::Value *NextPtr =
John McCall7f416cc2015-09-08 08:05:57 +00001264 Builder.CreateConstInBoundsGEP1_32(ElementTy, CurPtr.getPointer(), 1,
1265 "array.next");
Richard Smith06a67e22014-06-03 06:58:52 +00001266
John McCall99210dc2011-09-15 06:49:18 +00001267 // Check whether we've gotten to the end of the array and, if so,
1268 // exit the loop.
Richard Smith06a67e22014-06-03 06:58:52 +00001269 llvm::Value *IsEnd = Builder.CreateICmpEQ(NextPtr, EndPtr, "array.atend");
1270 Builder.CreateCondBr(IsEnd, ContBB, LoopBB);
1271 CurPtrPhi->addIncoming(NextPtr, Builder.GetInsertBlock());
John McCall99210dc2011-09-15 06:49:18 +00001272
Richard Smith06a67e22014-06-03 06:58:52 +00001273 EmitBlock(ContBB);
Fariborz Jahaniand5202e02010-06-25 18:26:07 +00001274}
1275
Anders Carlssonb4bd0662009-09-23 16:07:23 +00001276static void EmitNewInitializer(CodeGenFunction &CGF, const CXXNewExpr *E,
David Blaikiefb901c7a2015-04-04 15:12:29 +00001277 QualType ElementType, llvm::Type *ElementTy,
John McCall7f416cc2015-09-08 08:05:57 +00001278 Address NewPtr, llvm::Value *NumElements,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00001279 llvm::Value *AllocSizeWithoutCookie) {
David Blaikie9b479662015-01-25 01:19:10 +00001280 ApplyDebugLocation DL(CGF, E);
Richard Smith06a67e22014-06-03 06:58:52 +00001281 if (E->isArray())
David Blaikiefb901c7a2015-04-04 15:12:29 +00001282 CGF.EmitNewArrayInitializer(E, ElementType, ElementTy, NewPtr, NumElements,
Richard Smith06a67e22014-06-03 06:58:52 +00001283 AllocSizeWithoutCookie);
1284 else if (const Expr *Init = E->getInitializer())
Richard Smithe78fac52018-04-05 20:52:58 +00001285 StoreAnyExprIntoOneUnit(CGF, Init, E->getAllocatedType(), NewPtr,
1286 AggValueSlot::DoesNotOverlap);
Anders Carlssonb4bd0662009-09-23 16:07:23 +00001287}
1288
Richard Smith8d0dc312013-07-21 23:12:18 +00001289/// Emit a call to an operator new or operator delete function, as implicitly
1290/// created by new-expressions and delete-expressions.
1291static RValue EmitNewDeleteCall(CodeGenFunction &CGF,
John McCallb92ab1a2016-10-26 23:46:34 +00001292 const FunctionDecl *CalleeDecl,
Richard Smith8d0dc312013-07-21 23:12:18 +00001293 const FunctionProtoType *CalleeType,
1294 const CallArgList &Args) {
1295 llvm::Instruction *CallOrInvoke;
John McCallb92ab1a2016-10-26 23:46:34 +00001296 llvm::Constant *CalleePtr = CGF.CGM.GetAddrOfFunction(CalleeDecl);
Erich Keanede6480a32018-11-13 15:48:08 +00001297 CGCallee Callee = CGCallee::forDirect(CalleePtr, GlobalDecl(CalleeDecl));
Richard Smith8d0dc312013-07-21 23:12:18 +00001298 RValue RV =
Peter Collingbournef7706832014-12-12 23:41:25 +00001299 CGF.EmitCall(CGF.CGM.getTypes().arrangeFreeFunctionCall(
1300 Args, CalleeType, /*chainCall=*/false),
John McCallb92ab1a2016-10-26 23:46:34 +00001301 Callee, ReturnValueSlot(), Args, &CallOrInvoke);
Richard Smith8d0dc312013-07-21 23:12:18 +00001302
1303 /// C++1y [expr.new]p10:
1304 /// [In a new-expression,] an implementation is allowed to omit a call
1305 /// to a replaceable global allocation function.
1306 ///
1307 /// We model such elidable calls with the 'builtin' attribute.
John McCallb92ab1a2016-10-26 23:46:34 +00001308 llvm::Function *Fn = dyn_cast<llvm::Function>(CalleePtr);
1309 if (CalleeDecl->isReplaceableGlobalAllocationFunction() &&
Rafael Espindola6956d582013-10-22 14:23:09 +00001310 Fn && Fn->hasFnAttribute(llvm::Attribute::NoBuiltin)) {
Richard Smith8d0dc312013-07-21 23:12:18 +00001311 // FIXME: Add addAttribute to CallSite.
1312 if (llvm::CallInst *CI = dyn_cast<llvm::CallInst>(CallOrInvoke))
Reid Klecknerde864822017-03-21 16:57:30 +00001313 CI->addAttribute(llvm::AttributeList::FunctionIndex,
Richard Smith8d0dc312013-07-21 23:12:18 +00001314 llvm::Attribute::Builtin);
1315 else if (llvm::InvokeInst *II = dyn_cast<llvm::InvokeInst>(CallOrInvoke))
Reid Klecknerde864822017-03-21 16:57:30 +00001316 II->addAttribute(llvm::AttributeList::FunctionIndex,
Richard Smith8d0dc312013-07-21 23:12:18 +00001317 llvm::Attribute::Builtin);
1318 else
1319 llvm_unreachable("unexpected kind of call instruction");
1320 }
1321
1322 return RV;
1323}
1324
Richard Smith760520b2014-06-03 23:27:44 +00001325RValue CodeGenFunction::EmitBuiltinNewDeleteCall(const FunctionProtoType *Type,
Eric Fiselierfa752f22018-03-21 19:19:48 +00001326 const CallExpr *TheCall,
Richard Smith760520b2014-06-03 23:27:44 +00001327 bool IsDelete) {
1328 CallArgList Args;
Eric Fiselierfa752f22018-03-21 19:19:48 +00001329 EmitCallArgs(Args, Type->getParamTypes(), TheCall->arguments());
Richard Smith760520b2014-06-03 23:27:44 +00001330 // Find the allocation or deallocation function that we're calling.
1331 ASTContext &Ctx = getContext();
1332 DeclarationName Name = Ctx.DeclarationNames
1333 .getCXXOperatorName(IsDelete ? OO_Delete : OO_New);
Eric Fiselierfa752f22018-03-21 19:19:48 +00001334
Richard Smith760520b2014-06-03 23:27:44 +00001335 for (auto *Decl : Ctx.getTranslationUnitDecl()->lookup(Name))
Richard Smith599bed72014-06-05 00:43:02 +00001336 if (auto *FD = dyn_cast<FunctionDecl>(Decl))
1337 if (Ctx.hasSameType(FD->getType(), QualType(Type, 0)))
Eric Fiselierfa752f22018-03-21 19:19:48 +00001338 return EmitNewDeleteCall(*this, FD, Type, Args);
Richard Smith760520b2014-06-03 23:27:44 +00001339 llvm_unreachable("predeclared global operator new/delete is missing");
1340}
1341
Richard Smith5b349582017-10-13 01:55:36 +00001342namespace {
1343/// The parameters to pass to a usual operator delete.
1344struct UsualDeleteParams {
1345 bool DestroyingDelete = false;
1346 bool Size = false;
1347 bool Alignment = false;
1348};
1349}
1350
1351static UsualDeleteParams getUsualDeleteParams(const FunctionDecl *FD) {
1352 UsualDeleteParams Params;
1353
1354 const FunctionProtoType *FPT = FD->getType()->castAs<FunctionProtoType>();
Richard Smithb2f0f052016-10-10 18:54:32 +00001355 auto AI = FPT->param_type_begin(), AE = FPT->param_type_end();
Richard Smith189e52f2016-10-10 06:42:31 +00001356
Richard Smithb2f0f052016-10-10 18:54:32 +00001357 // The first argument is always a void*.
1358 ++AI;
1359
Richard Smith5b349582017-10-13 01:55:36 +00001360 // The next parameter may be a std::destroying_delete_t.
1361 if (FD->isDestroyingOperatorDelete()) {
1362 Params.DestroyingDelete = true;
1363 assert(AI != AE);
1364 ++AI;
1365 }
Richard Smithb2f0f052016-10-10 18:54:32 +00001366
Richard Smith5b349582017-10-13 01:55:36 +00001367 // Figure out what other parameters we should be implicitly passing.
Richard Smithb2f0f052016-10-10 18:54:32 +00001368 if (AI != AE && (*AI)->isIntegerType()) {
Richard Smith5b349582017-10-13 01:55:36 +00001369 Params.Size = true;
Richard Smithb2f0f052016-10-10 18:54:32 +00001370 ++AI;
1371 }
1372
1373 if (AI != AE && (*AI)->isAlignValT()) {
Richard Smith5b349582017-10-13 01:55:36 +00001374 Params.Alignment = true;
Richard Smithb2f0f052016-10-10 18:54:32 +00001375 ++AI;
1376 }
1377
1378 assert(AI == AE && "unexpected usual deallocation function parameter");
Richard Smith5b349582017-10-13 01:55:36 +00001379 return Params;
Richard Smithb2f0f052016-10-10 18:54:32 +00001380}
1381
1382namespace {
1383 /// A cleanup to call the given 'operator delete' function upon abnormal
1384 /// exit from a new expression. Templated on a traits type that deals with
1385 /// ensuring that the arguments dominate the cleanup if necessary.
1386 template<typename Traits>
1387 class CallDeleteDuringNew final : public EHScopeStack::Cleanup {
1388 /// Type used to hold llvm::Value*s.
1389 typedef typename Traits::ValueTy ValueTy;
1390 /// Type used to hold RValues.
1391 typedef typename Traits::RValueTy RValueTy;
1392 struct PlacementArg {
1393 RValueTy ArgValue;
1394 QualType ArgType;
1395 };
1396
1397 unsigned NumPlacementArgs : 31;
1398 unsigned PassAlignmentToPlacementDelete : 1;
1399 const FunctionDecl *OperatorDelete;
1400 ValueTy Ptr;
1401 ValueTy AllocSize;
1402 CharUnits AllocAlign;
1403
1404 PlacementArg *getPlacementArgs() {
1405 return reinterpret_cast<PlacementArg *>(this + 1);
1406 }
Daniel Jaspere9abe642016-10-10 14:13:55 +00001407
1408 public:
1409 static size_t getExtraSize(size_t NumPlacementArgs) {
Richard Smithb2f0f052016-10-10 18:54:32 +00001410 return NumPlacementArgs * sizeof(PlacementArg);
Daniel Jaspere9abe642016-10-10 14:13:55 +00001411 }
1412
1413 CallDeleteDuringNew(size_t NumPlacementArgs,
Richard Smithb2f0f052016-10-10 18:54:32 +00001414 const FunctionDecl *OperatorDelete, ValueTy Ptr,
1415 ValueTy AllocSize, bool PassAlignmentToPlacementDelete,
1416 CharUnits AllocAlign)
1417 : NumPlacementArgs(NumPlacementArgs),
1418 PassAlignmentToPlacementDelete(PassAlignmentToPlacementDelete),
1419 OperatorDelete(OperatorDelete), Ptr(Ptr), AllocSize(AllocSize),
1420 AllocAlign(AllocAlign) {}
Daniel Jaspere9abe642016-10-10 14:13:55 +00001421
Richard Smithb2f0f052016-10-10 18:54:32 +00001422 void setPlacementArg(unsigned I, RValueTy Arg, QualType Type) {
Daniel Jaspere9abe642016-10-10 14:13:55 +00001423 assert(I < NumPlacementArgs && "index out of range");
Richard Smithb2f0f052016-10-10 18:54:32 +00001424 getPlacementArgs()[I] = {Arg, Type};
Daniel Jaspere9abe642016-10-10 14:13:55 +00001425 }
1426
1427 void Emit(CodeGenFunction &CGF, Flags flags) override {
Richard Smithb2f0f052016-10-10 18:54:32 +00001428 const FunctionProtoType *FPT =
1429 OperatorDelete->getType()->getAs<FunctionProtoType>();
Daniel Jaspere9abe642016-10-10 14:13:55 +00001430 CallArgList DeleteArgs;
1431
Richard Smith5b349582017-10-13 01:55:36 +00001432 // The first argument is always a void* (or C* for a destroying operator
1433 // delete for class type C).
Richard Smithb2f0f052016-10-10 18:54:32 +00001434 DeleteArgs.add(Traits::get(CGF, Ptr), FPT->getParamType(0));
Daniel Jaspere9abe642016-10-10 14:13:55 +00001435
Richard Smithb2f0f052016-10-10 18:54:32 +00001436 // Figure out what other parameters we should be implicitly passing.
Richard Smith5b349582017-10-13 01:55:36 +00001437 UsualDeleteParams Params;
Richard Smithb2f0f052016-10-10 18:54:32 +00001438 if (NumPlacementArgs) {
1439 // A placement deallocation function is implicitly passed an alignment
1440 // if the placement allocation function was, but is never passed a size.
Richard Smith5b349582017-10-13 01:55:36 +00001441 Params.Alignment = PassAlignmentToPlacementDelete;
Richard Smithb2f0f052016-10-10 18:54:32 +00001442 } else {
1443 // For a non-placement new-expression, 'operator delete' can take a
1444 // size and/or an alignment if it has the right parameters.
Richard Smith5b349582017-10-13 01:55:36 +00001445 Params = getUsualDeleteParams(OperatorDelete);
John McCall7f9c92a2010-09-17 00:50:28 +00001446 }
1447
Richard Smith5b349582017-10-13 01:55:36 +00001448 assert(!Params.DestroyingDelete &&
1449 "should not call destroying delete in a new-expression");
1450
Richard Smithb2f0f052016-10-10 18:54:32 +00001451 // The second argument can be a std::size_t (for non-placement delete).
Richard Smith5b349582017-10-13 01:55:36 +00001452 if (Params.Size)
Richard Smithb2f0f052016-10-10 18:54:32 +00001453 DeleteArgs.add(Traits::get(CGF, AllocSize),
1454 CGF.getContext().getSizeType());
1455
1456 // The next (second or third) argument can be a std::align_val_t, which
1457 // is an enum whose underlying type is std::size_t.
1458 // FIXME: Use the right type as the parameter type. Note that in a call
1459 // to operator delete(size_t, ...), we may not have it available.
Richard Smith5b349582017-10-13 01:55:36 +00001460 if (Params.Alignment)
Richard Smithb2f0f052016-10-10 18:54:32 +00001461 DeleteArgs.add(RValue::get(llvm::ConstantInt::get(
1462 CGF.SizeTy, AllocAlign.getQuantity())),
1463 CGF.getContext().getSizeType());
1464
John McCall7f9c92a2010-09-17 00:50:28 +00001465 // Pass the rest of the arguments, which must match exactly.
1466 for (unsigned I = 0; I != NumPlacementArgs; ++I) {
Richard Smithb2f0f052016-10-10 18:54:32 +00001467 auto Arg = getPlacementArgs()[I];
1468 DeleteArgs.add(Traits::get(CGF, Arg.ArgValue), Arg.ArgType);
John McCall7f9c92a2010-09-17 00:50:28 +00001469 }
1470
1471 // Call 'operator delete'.
Richard Smith8d0dc312013-07-21 23:12:18 +00001472 EmitNewDeleteCall(CGF, OperatorDelete, FPT, DeleteArgs);
John McCall7f9c92a2010-09-17 00:50:28 +00001473 }
1474 };
Alexander Kornienkoab9db512015-06-22 23:07:51 +00001475}
John McCall7f9c92a2010-09-17 00:50:28 +00001476
1477/// Enter a cleanup to call 'operator delete' if the initializer in a
1478/// new-expression throws.
1479static void EnterNewDeleteCleanup(CodeGenFunction &CGF,
1480 const CXXNewExpr *E,
John McCall7f416cc2015-09-08 08:05:57 +00001481 Address NewPtr,
John McCall7f9c92a2010-09-17 00:50:28 +00001482 llvm::Value *AllocSize,
Richard Smithb2f0f052016-10-10 18:54:32 +00001483 CharUnits AllocAlign,
John McCall7f9c92a2010-09-17 00:50:28 +00001484 const CallArgList &NewArgs) {
Richard Smithb2f0f052016-10-10 18:54:32 +00001485 unsigned NumNonPlacementArgs = E->passAlignment() ? 2 : 1;
1486
John McCall7f9c92a2010-09-17 00:50:28 +00001487 // If we're not inside a conditional branch, then the cleanup will
1488 // dominate and we can do the easier (and more efficient) thing.
1489 if (!CGF.isInConditionalBranch()) {
Richard Smithb2f0f052016-10-10 18:54:32 +00001490 struct DirectCleanupTraits {
1491 typedef llvm::Value *ValueTy;
1492 typedef RValue RValueTy;
1493 static RValue get(CodeGenFunction &, ValueTy V) { return RValue::get(V); }
1494 static RValue get(CodeGenFunction &, RValueTy V) { return V; }
1495 };
1496
1497 typedef CallDeleteDuringNew<DirectCleanupTraits> DirectCleanup;
1498
1499 DirectCleanup *Cleanup = CGF.EHStack
1500 .pushCleanupWithExtra<DirectCleanup>(EHCleanup,
1501 E->getNumPlacementArgs(),
1502 E->getOperatorDelete(),
1503 NewPtr.getPointer(),
1504 AllocSize,
1505 E->passAlignment(),
1506 AllocAlign);
1507 for (unsigned I = 0, N = E->getNumPlacementArgs(); I != N; ++I) {
1508 auto &Arg = NewArgs[I + NumNonPlacementArgs];
Yaxun Liu5b330e82018-03-15 15:25:19 +00001509 Cleanup->setPlacementArg(I, Arg.getRValue(CGF), Arg.Ty);
Richard Smithb2f0f052016-10-10 18:54:32 +00001510 }
John McCall7f9c92a2010-09-17 00:50:28 +00001511
1512 return;
1513 }
1514
1515 // Otherwise, we need to save all this stuff.
John McCallcb5f77f2011-01-28 10:53:53 +00001516 DominatingValue<RValue>::saved_type SavedNewPtr =
John McCall7f416cc2015-09-08 08:05:57 +00001517 DominatingValue<RValue>::save(CGF, RValue::get(NewPtr.getPointer()));
John McCallcb5f77f2011-01-28 10:53:53 +00001518 DominatingValue<RValue>::saved_type SavedAllocSize =
1519 DominatingValue<RValue>::save(CGF, RValue::get(AllocSize));
John McCall7f9c92a2010-09-17 00:50:28 +00001520
Richard Smithb2f0f052016-10-10 18:54:32 +00001521 struct ConditionalCleanupTraits {
1522 typedef DominatingValue<RValue>::saved_type ValueTy;
1523 typedef DominatingValue<RValue>::saved_type RValueTy;
1524 static RValue get(CodeGenFunction &CGF, ValueTy V) {
1525 return V.restore(CGF);
1526 }
1527 };
1528 typedef CallDeleteDuringNew<ConditionalCleanupTraits> ConditionalCleanup;
1529
1530 ConditionalCleanup *Cleanup = CGF.EHStack
1531 .pushCleanupWithExtra<ConditionalCleanup>(EHCleanup,
1532 E->getNumPlacementArgs(),
1533 E->getOperatorDelete(),
1534 SavedNewPtr,
1535 SavedAllocSize,
1536 E->passAlignment(),
1537 AllocAlign);
1538 for (unsigned I = 0, N = E->getNumPlacementArgs(); I != N; ++I) {
1539 auto &Arg = NewArgs[I + NumNonPlacementArgs];
Yaxun Liu5b330e82018-03-15 15:25:19 +00001540 Cleanup->setPlacementArg(
1541 I, DominatingValue<RValue>::save(CGF, Arg.getRValue(CGF)), Arg.Ty);
Richard Smithb2f0f052016-10-10 18:54:32 +00001542 }
John McCall7f9c92a2010-09-17 00:50:28 +00001543
John McCallf4beacd2011-11-10 10:43:54 +00001544 CGF.initFullExprCleanup();
John McCall824c2f52010-09-14 07:57:04 +00001545}
1546
Anders Carlssoncc52f652009-09-22 22:53:17 +00001547llvm::Value *CodeGenFunction::EmitCXXNewExpr(const CXXNewExpr *E) {
John McCall75f94982011-03-07 03:12:35 +00001548 // The element type being allocated.
1549 QualType allocType = getContext().getBaseElementType(E->getAllocatedType());
John McCall8ed55a52010-09-02 09:58:18 +00001550
John McCall75f94982011-03-07 03:12:35 +00001551 // 1. Build a call to the allocation function.
1552 FunctionDecl *allocator = E->getOperatorNew();
Anders Carlssoncc52f652009-09-22 22:53:17 +00001553
Sebastian Redlf862eb62012-02-22 17:37:52 +00001554 // If there is a brace-initializer, cannot allocate fewer elements than inits.
1555 unsigned minElements = 0;
1556 if (E->isArray() && E->hasInitializer()) {
Richard Smith0511d232016-10-05 22:41:02 +00001557 const InitListExpr *ILE = dyn_cast<InitListExpr>(E->getInitializer());
1558 if (ILE && ILE->isStringLiteralInit())
1559 minElements =
1560 cast<ConstantArrayType>(ILE->getType()->getAsArrayTypeUnsafe())
1561 ->getSize().getZExtValue();
1562 else if (ILE)
Sebastian Redlf862eb62012-02-22 17:37:52 +00001563 minElements = ILE->getNumInits();
1564 }
1565
Craig Topper8a13c412014-05-21 05:09:00 +00001566 llvm::Value *numElements = nullptr;
1567 llvm::Value *allocSizeWithoutCookie = nullptr;
John McCall75f94982011-03-07 03:12:35 +00001568 llvm::Value *allocSize =
Sebastian Redlf862eb62012-02-22 17:37:52 +00001569 EmitCXXNewAllocSize(*this, E, minElements, numElements,
1570 allocSizeWithoutCookie);
Richard Smithb2f0f052016-10-10 18:54:32 +00001571 CharUnits allocAlign = getContext().getTypeAlignInChars(allocType);
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00001572
John McCall7ec4b432011-05-16 01:05:12 +00001573 // Emit the allocation call. If the allocator is a global placement
1574 // operator, just "inline" it directly.
John McCall7f416cc2015-09-08 08:05:57 +00001575 Address allocation = Address::invalid();
1576 CallArgList allocatorArgs;
John McCall7ec4b432011-05-16 01:05:12 +00001577 if (allocator->isReservedGlobalPlacementOperator()) {
John McCall53dcf942015-09-29 23:55:17 +00001578 assert(E->getNumPlacementArgs() == 1);
1579 const Expr *arg = *E->placement_arguments().begin();
1580
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +00001581 LValueBaseInfo BaseInfo;
1582 allocation = EmitPointerWithAlignment(arg, &BaseInfo);
John McCall7f416cc2015-09-08 08:05:57 +00001583
1584 // The pointer expression will, in many cases, be an opaque void*.
1585 // In these cases, discard the computed alignment and use the
1586 // formal alignment of the allocated type.
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +00001587 if (BaseInfo.getAlignmentSource() != AlignmentSource::Decl)
Richard Smithb2f0f052016-10-10 18:54:32 +00001588 allocation = Address(allocation.getPointer(), allocAlign);
John McCall7f416cc2015-09-08 08:05:57 +00001589
John McCall53dcf942015-09-29 23:55:17 +00001590 // Set up allocatorArgs for the call to operator delete if it's not
1591 // the reserved global operator.
1592 if (E->getOperatorDelete() &&
1593 !E->getOperatorDelete()->isReservedGlobalPlacementOperator()) {
1594 allocatorArgs.add(RValue::get(allocSize), getContext().getSizeType());
1595 allocatorArgs.add(RValue::get(allocation.getPointer()), arg->getType());
1596 }
1597
John McCall7ec4b432011-05-16 01:05:12 +00001598 } else {
John McCall7f416cc2015-09-08 08:05:57 +00001599 const FunctionProtoType *allocatorType =
1600 allocator->getType()->castAs<FunctionProtoType>();
Richard Smithb2f0f052016-10-10 18:54:32 +00001601 unsigned ParamsToSkip = 0;
John McCall7f416cc2015-09-08 08:05:57 +00001602
1603 // The allocation size is the first argument.
1604 QualType sizeType = getContext().getSizeType();
1605 allocatorArgs.add(RValue::get(allocSize), sizeType);
Richard Smithb2f0f052016-10-10 18:54:32 +00001606 ++ParamsToSkip;
John McCall7f416cc2015-09-08 08:05:57 +00001607
Richard Smithb2f0f052016-10-10 18:54:32 +00001608 if (allocSize != allocSizeWithoutCookie) {
1609 CharUnits cookieAlign = getSizeAlign(); // FIXME: Ask the ABI.
1610 allocAlign = std::max(allocAlign, cookieAlign);
1611 }
1612
1613 // The allocation alignment may be passed as the second argument.
1614 if (E->passAlignment()) {
1615 QualType AlignValT = sizeType;
1616 if (allocatorType->getNumParams() > 1) {
1617 AlignValT = allocatorType->getParamType(1);
1618 assert(getContext().hasSameUnqualifiedType(
1619 AlignValT->castAs<EnumType>()->getDecl()->getIntegerType(),
1620 sizeType) &&
1621 "wrong type for alignment parameter");
1622 ++ParamsToSkip;
1623 } else {
1624 // Corner case, passing alignment to 'operator new(size_t, ...)'.
1625 assert(allocator->isVariadic() && "can't pass alignment to allocator");
1626 }
1627 allocatorArgs.add(
1628 RValue::get(llvm::ConstantInt::get(SizeTy, allocAlign.getQuantity())),
1629 AlignValT);
1630 }
1631
1632 // FIXME: Why do we not pass a CalleeDecl here?
John McCall7f416cc2015-09-08 08:05:57 +00001633 EmitCallArgs(allocatorArgs, allocatorType, E->placement_arguments(),
Vedant Kumared00ea02017-03-06 05:28:22 +00001634 /*AC*/AbstractCallee(), /*ParamsToSkip*/ParamsToSkip);
John McCall7f416cc2015-09-08 08:05:57 +00001635
1636 RValue RV =
1637 EmitNewDeleteCall(*this, allocator, allocatorType, allocatorArgs);
1638
Richard Smithb2f0f052016-10-10 18:54:32 +00001639 // If this was a call to a global replaceable allocation function that does
1640 // not take an alignment argument, the allocator is known to produce
1641 // storage that's suitably aligned for any object that fits, up to a known
1642 // threshold. Otherwise assume it's suitably aligned for the allocated type.
1643 CharUnits allocationAlign = allocAlign;
1644 if (!E->passAlignment() &&
1645 allocator->isReplaceableGlobalAllocationFunction()) {
1646 unsigned AllocatorAlign = llvm::PowerOf2Floor(std::min<uint64_t>(
1647 Target.getNewAlign(), getContext().getTypeSize(allocType)));
1648 allocationAlign = std::max(
1649 allocationAlign, getContext().toCharUnitsFromBits(AllocatorAlign));
John McCall7f416cc2015-09-08 08:05:57 +00001650 }
1651
1652 allocation = Address(RV.getScalarVal(), allocationAlign);
John McCall7ec4b432011-05-16 01:05:12 +00001653 }
Anders Carlssoncc52f652009-09-22 22:53:17 +00001654
John McCall75f94982011-03-07 03:12:35 +00001655 // Emit a null check on the allocation result if the allocation
1656 // function is allowed to return null (because it has a non-throwing
Richard Smith902a0232015-02-14 01:52:20 +00001657 // exception spec or is the reserved placement new) and we have an
Richard Smith2f72a752019-01-10 00:03:29 +00001658 // interesting initializer will be running sanitizers on the initialization.
Bruno Ricci9b6dfac2019-01-07 15:04:45 +00001659 bool nullCheck = E->shouldNullCheckAllocation() &&
Richard Smith2f72a752019-01-10 00:03:29 +00001660 (!allocType.isPODType(getContext()) || E->hasInitializer() ||
1661 sanitizePerformTypeCheck());
Anders Carlssoncc52f652009-09-22 22:53:17 +00001662
Craig Topper8a13c412014-05-21 05:09:00 +00001663 llvm::BasicBlock *nullCheckBB = nullptr;
1664 llvm::BasicBlock *contBB = nullptr;
Anders Carlssoncc52f652009-09-22 22:53:17 +00001665
John McCallf7dcf322011-03-07 01:52:56 +00001666 // The null-check means that the initializer is conditionally
1667 // evaluated.
1668 ConditionalEvaluation conditional(*this);
1669
John McCall75f94982011-03-07 03:12:35 +00001670 if (nullCheck) {
John McCallf7dcf322011-03-07 01:52:56 +00001671 conditional.begin(*this);
John McCall75f94982011-03-07 03:12:35 +00001672
1673 nullCheckBB = Builder.GetInsertBlock();
1674 llvm::BasicBlock *notNullBB = createBasicBlock("new.notnull");
1675 contBB = createBasicBlock("new.cont");
1676
John McCall7f416cc2015-09-08 08:05:57 +00001677 llvm::Value *isNull =
1678 Builder.CreateIsNull(allocation.getPointer(), "new.isnull");
John McCall75f94982011-03-07 03:12:35 +00001679 Builder.CreateCondBr(isNull, contBB, notNullBB);
1680 EmitBlock(notNullBB);
Anders Carlssoncc52f652009-09-22 22:53:17 +00001681 }
Anders Carlssonf7716812009-09-23 18:59:48 +00001682
John McCall824c2f52010-09-14 07:57:04 +00001683 // If there's an operator delete, enter a cleanup to call it if an
1684 // exception is thrown.
John McCall75f94982011-03-07 03:12:35 +00001685 EHScopeStack::stable_iterator operatorDeleteCleanup;
Craig Topper8a13c412014-05-21 05:09:00 +00001686 llvm::Instruction *cleanupDominator = nullptr;
John McCall7ec4b432011-05-16 01:05:12 +00001687 if (E->getOperatorDelete() &&
1688 !E->getOperatorDelete()->isReservedGlobalPlacementOperator()) {
Richard Smithb2f0f052016-10-10 18:54:32 +00001689 EnterNewDeleteCleanup(*this, E, allocation, allocSize, allocAlign,
1690 allocatorArgs);
John McCall75f94982011-03-07 03:12:35 +00001691 operatorDeleteCleanup = EHStack.stable_begin();
John McCallf4beacd2011-11-10 10:43:54 +00001692 cleanupDominator = Builder.CreateUnreachable();
John McCall824c2f52010-09-14 07:57:04 +00001693 }
1694
Eli Friedmancf9b1f62011-09-06 18:53:03 +00001695 assert((allocSize == allocSizeWithoutCookie) ==
1696 CalculateCookiePadding(*this, E).isZero());
1697 if (allocSize != allocSizeWithoutCookie) {
1698 assert(E->isArray());
1699 allocation = CGM.getCXXABI().InitializeArrayCookie(*this, allocation,
1700 numElements,
1701 E, allocType);
1702 }
1703
David Blaikiefb901c7a2015-04-04 15:12:29 +00001704 llvm::Type *elementTy = ConvertTypeForMem(allocType);
John McCall7f416cc2015-09-08 08:05:57 +00001705 Address result = Builder.CreateElementBitCast(allocation, elementTy);
John McCall824c2f52010-09-14 07:57:04 +00001706
Piotr Padlewski5dde8092018-05-03 11:03:01 +00001707 // Passing pointer through launder.invariant.group to avoid propagation of
Piotr Padlewski338c9d02015-09-15 21:46:47 +00001708 // vptrs information which may be included in previous type.
Piotr Padlewski31fd99c2017-05-20 08:56:18 +00001709 // To not break LTO with different optimizations levels, we do it regardless
1710 // of optimization level.
Piotr Padlewski338c9d02015-09-15 21:46:47 +00001711 if (CGM.getCodeGenOpts().StrictVTablePointers &&
Piotr Padlewski338c9d02015-09-15 21:46:47 +00001712 allocator->isReservedGlobalPlacementOperator())
Piotr Padlewski5dde8092018-05-03 11:03:01 +00001713 result = Address(Builder.CreateLaunderInvariantGroup(result.getPointer()),
Piotr Padlewski338c9d02015-09-15 21:46:47 +00001714 result.getAlignment());
1715
Serge Pavlov37605182018-07-28 15:33:03 +00001716 // Emit sanitizer checks for pointer value now, so that in the case of an
Richard Smithcfa79b22019-01-23 03:37:29 +00001717 // array it was checked only once and not at each constructor call. We may
1718 // have already checked that the pointer is non-null.
1719 // FIXME: If we have an array cookie and a potentially-throwing allocator,
1720 // we'll null check the wrong pointer here.
1721 SanitizerSet SkippedChecks;
1722 SkippedChecks.set(SanitizerKind::Null, nullCheck);
Serge Pavlov37605182018-07-28 15:33:03 +00001723 EmitTypeCheck(CodeGenFunction::TCK_ConstructorCall,
Richard Smithcfa79b22019-01-23 03:37:29 +00001724 E->getAllocatedTypeSourceInfo()->getTypeLoc().getBeginLoc(),
1725 result.getPointer(), allocType, result.getAlignment(),
1726 SkippedChecks, numElements);
Serge Pavlov37605182018-07-28 15:33:03 +00001727
David Blaikiefb901c7a2015-04-04 15:12:29 +00001728 EmitNewInitializer(*this, E, allocType, elementTy, result, numElements,
John McCall99210dc2011-09-15 06:49:18 +00001729 allocSizeWithoutCookie);
John McCall8ed55a52010-09-02 09:58:18 +00001730 if (E->isArray()) {
John McCall8ed55a52010-09-02 09:58:18 +00001731 // NewPtr is a pointer to the base element type. If we're
1732 // allocating an array of arrays, we'll need to cast back to the
1733 // array pointer type.
Chris Lattner2192fe52011-07-18 04:24:23 +00001734 llvm::Type *resultType = ConvertTypeForMem(E->getType());
John McCall7f416cc2015-09-08 08:05:57 +00001735 if (result.getType() != resultType)
John McCall75f94982011-03-07 03:12:35 +00001736 result = Builder.CreateBitCast(result, resultType);
Fariborz Jahanian47b46292010-03-24 16:57:01 +00001737 }
John McCall824c2f52010-09-14 07:57:04 +00001738
1739 // Deactivate the 'operator delete' cleanup if we finished
1740 // initialization.
John McCallf4beacd2011-11-10 10:43:54 +00001741 if (operatorDeleteCleanup.isValid()) {
1742 DeactivateCleanupBlock(operatorDeleteCleanup, cleanupDominator);
1743 cleanupDominator->eraseFromParent();
1744 }
Sebastian Redl6047f072012-02-16 12:22:20 +00001745
John McCall7f416cc2015-09-08 08:05:57 +00001746 llvm::Value *resultPtr = result.getPointer();
John McCall75f94982011-03-07 03:12:35 +00001747 if (nullCheck) {
John McCallf7dcf322011-03-07 01:52:56 +00001748 conditional.end(*this);
1749
John McCall75f94982011-03-07 03:12:35 +00001750 llvm::BasicBlock *notNullBB = Builder.GetInsertBlock();
1751 EmitBlock(contBB);
Anders Carlssoncc52f652009-09-22 22:53:17 +00001752
John McCall7f416cc2015-09-08 08:05:57 +00001753 llvm::PHINode *PHI = Builder.CreatePHI(resultPtr->getType(), 2);
1754 PHI->addIncoming(resultPtr, notNullBB);
1755 PHI->addIncoming(llvm::Constant::getNullValue(resultPtr->getType()),
John McCall75f94982011-03-07 03:12:35 +00001756 nullCheckBB);
Anders Carlssoncc52f652009-09-22 22:53:17 +00001757
John McCall7f416cc2015-09-08 08:05:57 +00001758 resultPtr = PHI;
Anders Carlssoncc52f652009-09-22 22:53:17 +00001759 }
Fangrui Song6907ce22018-07-30 19:24:48 +00001760
John McCall7f416cc2015-09-08 08:05:57 +00001761 return resultPtr;
Anders Carlssoncc52f652009-09-22 22:53:17 +00001762}
1763
Eli Friedmanfe81e3f2009-11-18 00:50:08 +00001764void CodeGenFunction::EmitDeleteCall(const FunctionDecl *DeleteFD,
Richard Smithb2f0f052016-10-10 18:54:32 +00001765 llvm::Value *Ptr, QualType DeleteTy,
1766 llvm::Value *NumElements,
1767 CharUnits CookieSize) {
1768 assert((!NumElements && CookieSize.isZero()) ||
1769 DeleteFD->getOverloadedOperator() == OO_Array_Delete);
John McCall8ed55a52010-09-02 09:58:18 +00001770
Eli Friedmanfe81e3f2009-11-18 00:50:08 +00001771 const FunctionProtoType *DeleteFTy =
1772 DeleteFD->getType()->getAs<FunctionProtoType>();
1773
1774 CallArgList DeleteArgs;
1775
Richard Smith5b349582017-10-13 01:55:36 +00001776 auto Params = getUsualDeleteParams(DeleteFD);
Richard Smithb2f0f052016-10-10 18:54:32 +00001777 auto ParamTypeIt = DeleteFTy->param_type_begin();
1778
1779 // Pass the pointer itself.
1780 QualType ArgTy = *ParamTypeIt++;
Eli Friedmanfe81e3f2009-11-18 00:50:08 +00001781 llvm::Value *DeletePtr = Builder.CreateBitCast(Ptr, ConvertType(ArgTy));
Eli Friedman43dca6a2011-05-02 17:57:46 +00001782 DeleteArgs.add(RValue::get(DeletePtr), ArgTy);
Eli Friedmanfe81e3f2009-11-18 00:50:08 +00001783
Richard Smith5b349582017-10-13 01:55:36 +00001784 // Pass the std::destroying_delete tag if present.
1785 if (Params.DestroyingDelete) {
1786 QualType DDTag = *ParamTypeIt++;
1787 // Just pass an 'undef'. We expect the tag type to be an empty struct.
1788 auto *V = llvm::UndefValue::get(getTypes().ConvertType(DDTag));
1789 DeleteArgs.add(RValue::get(V), DDTag);
1790 }
1791
Richard Smithb2f0f052016-10-10 18:54:32 +00001792 // Pass the size if the delete function has a size_t parameter.
Richard Smith5b349582017-10-13 01:55:36 +00001793 if (Params.Size) {
Richard Smithb2f0f052016-10-10 18:54:32 +00001794 QualType SizeType = *ParamTypeIt++;
1795 CharUnits DeleteTypeSize = getContext().getTypeSizeInChars(DeleteTy);
1796 llvm::Value *Size = llvm::ConstantInt::get(ConvertType(SizeType),
1797 DeleteTypeSize.getQuantity());
1798
1799 // For array new, multiply by the number of elements.
1800 if (NumElements)
1801 Size = Builder.CreateMul(Size, NumElements);
1802
1803 // If there is a cookie, add the cookie size.
1804 if (!CookieSize.isZero())
1805 Size = Builder.CreateAdd(
1806 Size, llvm::ConstantInt::get(SizeTy, CookieSize.getQuantity()));
1807
1808 DeleteArgs.add(RValue::get(Size), SizeType);
1809 }
1810
1811 // Pass the alignment if the delete function has an align_val_t parameter.
Richard Smith5b349582017-10-13 01:55:36 +00001812 if (Params.Alignment) {
Richard Smithb2f0f052016-10-10 18:54:32 +00001813 QualType AlignValType = *ParamTypeIt++;
1814 CharUnits DeleteTypeAlign = getContext().toCharUnitsFromBits(
1815 getContext().getTypeAlignIfKnown(DeleteTy));
1816 llvm::Value *Align = llvm::ConstantInt::get(ConvertType(AlignValType),
1817 DeleteTypeAlign.getQuantity());
1818 DeleteArgs.add(RValue::get(Align), AlignValType);
1819 }
1820
1821 assert(ParamTypeIt == DeleteFTy->param_type_end() &&
1822 "unknown parameter to usual delete function");
Eli Friedmanfe81e3f2009-11-18 00:50:08 +00001823
1824 // Emit the call to delete.
Richard Smith8d0dc312013-07-21 23:12:18 +00001825 EmitNewDeleteCall(*this, DeleteFD, DeleteFTy, DeleteArgs);
Eli Friedmanfe81e3f2009-11-18 00:50:08 +00001826}
1827
John McCall8ed55a52010-09-02 09:58:18 +00001828namespace {
1829 /// Calls the given 'operator delete' on a single object.
David Blaikie7e70d682015-08-18 22:40:54 +00001830 struct CallObjectDelete final : EHScopeStack::Cleanup {
John McCall8ed55a52010-09-02 09:58:18 +00001831 llvm::Value *Ptr;
1832 const FunctionDecl *OperatorDelete;
1833 QualType ElementType;
1834
1835 CallObjectDelete(llvm::Value *Ptr,
1836 const FunctionDecl *OperatorDelete,
1837 QualType ElementType)
1838 : Ptr(Ptr), OperatorDelete(OperatorDelete), ElementType(ElementType) {}
1839
Craig Topper4f12f102014-03-12 06:41:41 +00001840 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall8ed55a52010-09-02 09:58:18 +00001841 CGF.EmitDeleteCall(OperatorDelete, Ptr, ElementType);
1842 }
1843 };
Alexander Kornienkoab9db512015-06-22 23:07:51 +00001844}
John McCall8ed55a52010-09-02 09:58:18 +00001845
David Majnemer0c0b6d92014-10-31 20:09:12 +00001846void
1847CodeGenFunction::pushCallObjectDeleteCleanup(const FunctionDecl *OperatorDelete,
1848 llvm::Value *CompletePtr,
1849 QualType ElementType) {
1850 EHStack.pushCleanup<CallObjectDelete>(NormalAndEHCleanup, CompletePtr,
1851 OperatorDelete, ElementType);
1852}
1853
Richard Smith5b349582017-10-13 01:55:36 +00001854/// Emit the code for deleting a single object with a destroying operator
1855/// delete. If the element type has a non-virtual destructor, Ptr has already
1856/// been converted to the type of the parameter of 'operator delete'. Otherwise
1857/// Ptr points to an object of the static type.
1858static void EmitDestroyingObjectDelete(CodeGenFunction &CGF,
1859 const CXXDeleteExpr *DE, Address Ptr,
1860 QualType ElementType) {
1861 auto *Dtor = ElementType->getAsCXXRecordDecl()->getDestructor();
1862 if (Dtor && Dtor->isVirtual())
1863 CGF.CGM.getCXXABI().emitVirtualObjectDelete(CGF, DE, Ptr, ElementType,
1864 Dtor);
1865 else
1866 CGF.EmitDeleteCall(DE->getOperatorDelete(), Ptr.getPointer(), ElementType);
1867}
1868
John McCall8ed55a52010-09-02 09:58:18 +00001869/// Emit the code for deleting a single object.
1870static void EmitObjectDelete(CodeGenFunction &CGF,
David Majnemer08681372014-11-01 07:37:17 +00001871 const CXXDeleteExpr *DE,
John McCall7f416cc2015-09-08 08:05:57 +00001872 Address Ptr,
David Majnemer08681372014-11-01 07:37:17 +00001873 QualType ElementType) {
Ivan Krasind98f5d72016-11-17 00:39:48 +00001874 // C++11 [expr.delete]p3:
1875 // If the static type of the object to be deleted is different from its
1876 // dynamic type, the static type shall be a base class of the dynamic type
1877 // of the object to be deleted and the static type shall have a virtual
1878 // destructor or the behavior is undefined.
1879 CGF.EmitTypeCheck(CodeGenFunction::TCK_MemberCall,
1880 DE->getExprLoc(), Ptr.getPointer(),
1881 ElementType);
1882
Richard Smith5b349582017-10-13 01:55:36 +00001883 const FunctionDecl *OperatorDelete = DE->getOperatorDelete();
1884 assert(!OperatorDelete->isDestroyingOperatorDelete());
1885
John McCall8ed55a52010-09-02 09:58:18 +00001886 // Find the destructor for the type, if applicable. If the
1887 // destructor is virtual, we'll just emit the vcall and return.
Craig Topper8a13c412014-05-21 05:09:00 +00001888 const CXXDestructorDecl *Dtor = nullptr;
John McCall8ed55a52010-09-02 09:58:18 +00001889 if (const RecordType *RT = ElementType->getAs<RecordType>()) {
1890 CXXRecordDecl *RD = cast<CXXRecordDecl>(RT->getDecl());
Eli Friedmanb23533d2011-08-02 18:05:30 +00001891 if (RD->hasDefinition() && !RD->hasTrivialDestructor()) {
John McCall8ed55a52010-09-02 09:58:18 +00001892 Dtor = RD->getDestructor();
1893
1894 if (Dtor->isVirtual()) {
David Majnemer08681372014-11-01 07:37:17 +00001895 CGF.CGM.getCXXABI().emitVirtualObjectDelete(CGF, DE, Ptr, ElementType,
1896 Dtor);
John McCall8ed55a52010-09-02 09:58:18 +00001897 return;
1898 }
1899 }
1900 }
1901
1902 // Make sure that we call delete even if the dtor throws.
John McCalle4df6c82011-01-28 08:37:24 +00001903 // This doesn't have to a conditional cleanup because we're going
1904 // to pop it off in a second.
John McCall8ed55a52010-09-02 09:58:18 +00001905 CGF.EHStack.pushCleanup<CallObjectDelete>(NormalAndEHCleanup,
John McCall7f416cc2015-09-08 08:05:57 +00001906 Ptr.getPointer(),
1907 OperatorDelete, ElementType);
John McCall8ed55a52010-09-02 09:58:18 +00001908
1909 if (Dtor)
1910 CGF.EmitCXXDestructorCall(Dtor, Dtor_Complete,
Douglas Gregor61535002013-01-31 05:50:40 +00001911 /*ForVirtualBase=*/false,
1912 /*Delegating=*/false,
1913 Ptr);
John McCall460ce582015-10-22 18:38:17 +00001914 else if (auto Lifetime = ElementType.getObjCLifetime()) {
1915 switch (Lifetime) {
John McCall31168b02011-06-15 23:02:42 +00001916 case Qualifiers::OCL_None:
1917 case Qualifiers::OCL_ExplicitNone:
1918 case Qualifiers::OCL_Autoreleasing:
1919 break;
John McCall8ed55a52010-09-02 09:58:18 +00001920
John McCall7f416cc2015-09-08 08:05:57 +00001921 case Qualifiers::OCL_Strong:
1922 CGF.EmitARCDestroyStrong(Ptr, ARCPreciseLifetime);
John McCall31168b02011-06-15 23:02:42 +00001923 break;
Fangrui Song6907ce22018-07-30 19:24:48 +00001924
John McCall31168b02011-06-15 23:02:42 +00001925 case Qualifiers::OCL_Weak:
1926 CGF.EmitARCDestroyWeak(Ptr);
1927 break;
1928 }
1929 }
Fangrui Song6907ce22018-07-30 19:24:48 +00001930
John McCall8ed55a52010-09-02 09:58:18 +00001931 CGF.PopCleanupBlock();
1932}
1933
1934namespace {
1935 /// Calls the given 'operator delete' on an array of objects.
David Blaikie7e70d682015-08-18 22:40:54 +00001936 struct CallArrayDelete final : EHScopeStack::Cleanup {
John McCall8ed55a52010-09-02 09:58:18 +00001937 llvm::Value *Ptr;
1938 const FunctionDecl *OperatorDelete;
1939 llvm::Value *NumElements;
1940 QualType ElementType;
1941 CharUnits CookieSize;
1942
1943 CallArrayDelete(llvm::Value *Ptr,
1944 const FunctionDecl *OperatorDelete,
1945 llvm::Value *NumElements,
1946 QualType ElementType,
1947 CharUnits CookieSize)
1948 : Ptr(Ptr), OperatorDelete(OperatorDelete), NumElements(NumElements),
1949 ElementType(ElementType), CookieSize(CookieSize) {}
1950
Craig Topper4f12f102014-03-12 06:41:41 +00001951 void Emit(CodeGenFunction &CGF, Flags flags) override {
Richard Smithb2f0f052016-10-10 18:54:32 +00001952 CGF.EmitDeleteCall(OperatorDelete, Ptr, ElementType, NumElements,
1953 CookieSize);
John McCall8ed55a52010-09-02 09:58:18 +00001954 }
1955 };
Alexander Kornienkoab9db512015-06-22 23:07:51 +00001956}
John McCall8ed55a52010-09-02 09:58:18 +00001957
1958/// Emit the code for deleting an array of objects.
1959static void EmitArrayDelete(CodeGenFunction &CGF,
John McCall284c48f2011-01-27 09:37:56 +00001960 const CXXDeleteExpr *E,
John McCall7f416cc2015-09-08 08:05:57 +00001961 Address deletedPtr,
John McCallca2c56f2011-07-13 01:41:37 +00001962 QualType elementType) {
Craig Topper8a13c412014-05-21 05:09:00 +00001963 llvm::Value *numElements = nullptr;
1964 llvm::Value *allocatedPtr = nullptr;
John McCallca2c56f2011-07-13 01:41:37 +00001965 CharUnits cookieSize;
1966 CGF.CGM.getCXXABI().ReadArrayCookie(CGF, deletedPtr, E, elementType,
1967 numElements, allocatedPtr, cookieSize);
John McCall8ed55a52010-09-02 09:58:18 +00001968
John McCallca2c56f2011-07-13 01:41:37 +00001969 assert(allocatedPtr && "ReadArrayCookie didn't set allocated pointer");
John McCall8ed55a52010-09-02 09:58:18 +00001970
1971 // Make sure that we call delete even if one of the dtors throws.
John McCallca2c56f2011-07-13 01:41:37 +00001972 const FunctionDecl *operatorDelete = E->getOperatorDelete();
John McCall8ed55a52010-09-02 09:58:18 +00001973 CGF.EHStack.pushCleanup<CallArrayDelete>(NormalAndEHCleanup,
John McCallca2c56f2011-07-13 01:41:37 +00001974 allocatedPtr, operatorDelete,
1975 numElements, elementType,
1976 cookieSize);
John McCall8ed55a52010-09-02 09:58:18 +00001977
John McCallca2c56f2011-07-13 01:41:37 +00001978 // Destroy the elements.
1979 if (QualType::DestructionKind dtorKind = elementType.isDestructedType()) {
1980 assert(numElements && "no element count for a type with a destructor!");
1981
John McCall7f416cc2015-09-08 08:05:57 +00001982 CharUnits elementSize = CGF.getContext().getTypeSizeInChars(elementType);
1983 CharUnits elementAlign =
1984 deletedPtr.getAlignment().alignmentOfArrayElement(elementSize);
1985
1986 llvm::Value *arrayBegin = deletedPtr.getPointer();
John McCallca2c56f2011-07-13 01:41:37 +00001987 llvm::Value *arrayEnd =
John McCall7f416cc2015-09-08 08:05:57 +00001988 CGF.Builder.CreateInBoundsGEP(arrayBegin, numElements, "delete.end");
John McCall97eab0a2011-07-13 08:09:46 +00001989
1990 // Note that it is legal to allocate a zero-length array, and we
1991 // can never fold the check away because the length should always
1992 // come from a cookie.
John McCall7f416cc2015-09-08 08:05:57 +00001993 CGF.emitArrayDestroy(arrayBegin, arrayEnd, elementType, elementAlign,
John McCallca2c56f2011-07-13 01:41:37 +00001994 CGF.getDestroyer(dtorKind),
John McCall97eab0a2011-07-13 08:09:46 +00001995 /*checkZeroLength*/ true,
John McCallca2c56f2011-07-13 01:41:37 +00001996 CGF.needsEHCleanup(dtorKind));
John McCall8ed55a52010-09-02 09:58:18 +00001997 }
1998
John McCallca2c56f2011-07-13 01:41:37 +00001999 // Pop the cleanup block.
John McCall8ed55a52010-09-02 09:58:18 +00002000 CGF.PopCleanupBlock();
2001}
2002
Anders Carlssoncc52f652009-09-22 22:53:17 +00002003void CodeGenFunction::EmitCXXDeleteExpr(const CXXDeleteExpr *E) {
Douglas Gregorbb3e12f2009-09-29 18:16:17 +00002004 const Expr *Arg = E->getArgument();
John McCall7f416cc2015-09-08 08:05:57 +00002005 Address Ptr = EmitPointerWithAlignment(Arg);
Anders Carlssoncc52f652009-09-22 22:53:17 +00002006
2007 // Null check the pointer.
2008 llvm::BasicBlock *DeleteNotNull = createBasicBlock("delete.notnull");
2009 llvm::BasicBlock *DeleteEnd = createBasicBlock("delete.end");
2010
John McCall7f416cc2015-09-08 08:05:57 +00002011 llvm::Value *IsNull = Builder.CreateIsNull(Ptr.getPointer(), "isnull");
Anders Carlssoncc52f652009-09-22 22:53:17 +00002012
2013 Builder.CreateCondBr(IsNull, DeleteEnd, DeleteNotNull);
2014 EmitBlock(DeleteNotNull);
Anders Carlssone828c362009-11-13 04:45:41 +00002015
Richard Smith5b349582017-10-13 01:55:36 +00002016 QualType DeleteTy = E->getDestroyedType();
2017
2018 // A destroying operator delete overrides the entire operation of the
2019 // delete expression.
2020 if (E->getOperatorDelete()->isDestroyingOperatorDelete()) {
2021 EmitDestroyingObjectDelete(*this, E, Ptr, DeleteTy);
2022 EmitBlock(DeleteEnd);
2023 return;
2024 }
2025
John McCall8ed55a52010-09-02 09:58:18 +00002026 // We might be deleting a pointer to array. If so, GEP down to the
2027 // first non-array element.
2028 // (this assumes that A(*)[3][7] is converted to [3 x [7 x %A]]*)
John McCall8ed55a52010-09-02 09:58:18 +00002029 if (DeleteTy->isConstantArrayType()) {
2030 llvm::Value *Zero = Builder.getInt32(0);
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002031 SmallVector<llvm::Value*,8> GEP;
John McCall8ed55a52010-09-02 09:58:18 +00002032
2033 GEP.push_back(Zero); // point at the outermost array
2034
2035 // For each layer of array type we're pointing at:
2036 while (const ConstantArrayType *Arr
2037 = getContext().getAsConstantArrayType(DeleteTy)) {
2038 // 1. Unpeel the array type.
2039 DeleteTy = Arr->getElementType();
2040
2041 // 2. GEP to the first element of the array.
2042 GEP.push_back(Zero);
Anders Carlssoncc52f652009-09-22 22:53:17 +00002043 }
John McCall8ed55a52010-09-02 09:58:18 +00002044
John McCall7f416cc2015-09-08 08:05:57 +00002045 Ptr = Address(Builder.CreateInBoundsGEP(Ptr.getPointer(), GEP, "del.first"),
2046 Ptr.getAlignment());
Anders Carlssoncc52f652009-09-22 22:53:17 +00002047 }
2048
John McCall7f416cc2015-09-08 08:05:57 +00002049 assert(ConvertTypeForMem(DeleteTy) == Ptr.getElementType());
John McCall8ed55a52010-09-02 09:58:18 +00002050
Reid Kleckner7270ef52015-03-19 17:03:58 +00002051 if (E->isArrayForm()) {
2052 EmitArrayDelete(*this, E, Ptr, DeleteTy);
2053 } else {
2054 EmitObjectDelete(*this, E, Ptr, DeleteTy);
2055 }
Anders Carlssoncc52f652009-09-22 22:53:17 +00002056
Anders Carlssoncc52f652009-09-22 22:53:17 +00002057 EmitBlock(DeleteEnd);
2058}
Mike Stumpc9b231c2009-11-15 08:09:41 +00002059
David Majnemer1c3d95e2014-07-19 00:17:06 +00002060static bool isGLValueFromPointerDeref(const Expr *E) {
2061 E = E->IgnoreParens();
2062
2063 if (const auto *CE = dyn_cast<CastExpr>(E)) {
2064 if (!CE->getSubExpr()->isGLValue())
2065 return false;
2066 return isGLValueFromPointerDeref(CE->getSubExpr());
2067 }
2068
2069 if (const auto *OVE = dyn_cast<OpaqueValueExpr>(E))
2070 return isGLValueFromPointerDeref(OVE->getSourceExpr());
2071
2072 if (const auto *BO = dyn_cast<BinaryOperator>(E))
2073 if (BO->getOpcode() == BO_Comma)
2074 return isGLValueFromPointerDeref(BO->getRHS());
2075
2076 if (const auto *ACO = dyn_cast<AbstractConditionalOperator>(E))
2077 return isGLValueFromPointerDeref(ACO->getTrueExpr()) ||
2078 isGLValueFromPointerDeref(ACO->getFalseExpr());
2079
2080 // C++11 [expr.sub]p1:
2081 // The expression E1[E2] is identical (by definition) to *((E1)+(E2))
2082 if (isa<ArraySubscriptExpr>(E))
2083 return true;
2084
2085 if (const auto *UO = dyn_cast<UnaryOperator>(E))
2086 if (UO->getOpcode() == UO_Deref)
2087 return true;
2088
2089 return false;
2090}
2091
Warren Hunt747e3012014-06-18 21:15:55 +00002092static llvm::Value *EmitTypeidFromVTable(CodeGenFunction &CGF, const Expr *E,
Chris Lattner2192fe52011-07-18 04:24:23 +00002093 llvm::Type *StdTypeInfoPtrTy) {
Anders Carlsson940f02d2011-04-18 00:57:03 +00002094 // Get the vtable pointer.
John McCall7f416cc2015-09-08 08:05:57 +00002095 Address ThisPtr = CGF.EmitLValue(E).getAddress();
Anders Carlsson940f02d2011-04-18 00:57:03 +00002096
Stephan Bergmannd71ad172017-12-28 12:45:41 +00002097 QualType SrcRecordTy = E->getType();
2098
2099 // C++ [class.cdtor]p4:
2100 // If the operand of typeid refers to the object under construction or
2101 // destruction and the static type of the operand is neither the constructor
2102 // or destructor’s class nor one of its bases, the behavior is undefined.
2103 CGF.EmitTypeCheck(CodeGenFunction::TCK_DynamicOperation, E->getExprLoc(),
2104 ThisPtr.getPointer(), SrcRecordTy);
2105
Anders Carlsson940f02d2011-04-18 00:57:03 +00002106 // C++ [expr.typeid]p2:
2107 // If the glvalue expression is obtained by applying the unary * operator to
2108 // a pointer and the pointer is a null pointer value, the typeid expression
2109 // throws the std::bad_typeid exception.
David Majnemer1c3d95e2014-07-19 00:17:06 +00002110 //
2111 // However, this paragraph's intent is not clear. We choose a very generous
2112 // interpretation which implores us to consider comma operators, conditional
2113 // operators, parentheses and other such constructs.
David Majnemer1c3d95e2014-07-19 00:17:06 +00002114 if (CGF.CGM.getCXXABI().shouldTypeidBeNullChecked(
2115 isGLValueFromPointerDeref(E), SrcRecordTy)) {
David Majnemer1162d252014-06-22 19:05:33 +00002116 llvm::BasicBlock *BadTypeidBlock =
Anders Carlsson940f02d2011-04-18 00:57:03 +00002117 CGF.createBasicBlock("typeid.bad_typeid");
David Majnemer1162d252014-06-22 19:05:33 +00002118 llvm::BasicBlock *EndBlock = CGF.createBasicBlock("typeid.end");
Anders Carlsson940f02d2011-04-18 00:57:03 +00002119
John McCall7f416cc2015-09-08 08:05:57 +00002120 llvm::Value *IsNull = CGF.Builder.CreateIsNull(ThisPtr.getPointer());
David Majnemer1162d252014-06-22 19:05:33 +00002121 CGF.Builder.CreateCondBr(IsNull, BadTypeidBlock, EndBlock);
Anders Carlsson940f02d2011-04-18 00:57:03 +00002122
David Majnemer1162d252014-06-22 19:05:33 +00002123 CGF.EmitBlock(BadTypeidBlock);
2124 CGF.CGM.getCXXABI().EmitBadTypeidCall(CGF);
2125 CGF.EmitBlock(EndBlock);
Anders Carlsson940f02d2011-04-18 00:57:03 +00002126 }
2127
David Majnemer1162d252014-06-22 19:05:33 +00002128 return CGF.CGM.getCXXABI().EmitTypeid(CGF, SrcRecordTy, ThisPtr,
2129 StdTypeInfoPtrTy);
Anders Carlsson940f02d2011-04-18 00:57:03 +00002130}
2131
John McCalle4df6c82011-01-28 08:37:24 +00002132llvm::Value *CodeGenFunction::EmitCXXTypeidExpr(const CXXTypeidExpr *E) {
Fangrui Song6907ce22018-07-30 19:24:48 +00002133 llvm::Type *StdTypeInfoPtrTy =
Anders Carlsson940f02d2011-04-18 00:57:03 +00002134 ConvertType(E->getType())->getPointerTo();
Fangrui Song6907ce22018-07-30 19:24:48 +00002135
Anders Carlsson3f4336c2009-12-17 07:09:17 +00002136 if (E->isTypeOperand()) {
David Majnemer143c55e2013-09-27 07:04:31 +00002137 llvm::Constant *TypeInfo =
2138 CGM.GetAddrOfRTTIDescriptor(E->getTypeOperand(getContext()));
Anders Carlsson940f02d2011-04-18 00:57:03 +00002139 return Builder.CreateBitCast(TypeInfo, StdTypeInfoPtrTy);
Anders Carlsson3f4336c2009-12-17 07:09:17 +00002140 }
Anders Carlsson0c633502011-04-11 14:13:40 +00002141
Anders Carlsson940f02d2011-04-18 00:57:03 +00002142 // C++ [expr.typeid]p2:
2143 // When typeid is applied to a glvalue expression whose type is a
2144 // polymorphic class type, the result refers to a std::type_info object
2145 // representing the type of the most derived object (that is, the dynamic
2146 // type) to which the glvalue refers.
Richard Smithef8bf432012-08-13 20:08:14 +00002147 if (E->isPotentiallyEvaluated())
Fangrui Song6907ce22018-07-30 19:24:48 +00002148 return EmitTypeidFromVTable(*this, E->getExprOperand(),
Richard Smithef8bf432012-08-13 20:08:14 +00002149 StdTypeInfoPtrTy);
Anders Carlsson940f02d2011-04-18 00:57:03 +00002150
2151 QualType OperandTy = E->getExprOperand()->getType();
2152 return Builder.CreateBitCast(CGM.GetAddrOfRTTIDescriptor(OperandTy),
2153 StdTypeInfoPtrTy);
Mike Stumpc9b231c2009-11-15 08:09:41 +00002154}
Mike Stump65511702009-11-16 06:50:58 +00002155
Anders Carlssonc1c99712011-04-11 01:45:29 +00002156static llvm::Value *EmitDynamicCastToNull(CodeGenFunction &CGF,
2157 QualType DestTy) {
Chris Lattner2192fe52011-07-18 04:24:23 +00002158 llvm::Type *DestLTy = CGF.ConvertType(DestTy);
Anders Carlssonc1c99712011-04-11 01:45:29 +00002159 if (DestTy->isPointerType())
2160 return llvm::Constant::getNullValue(DestLTy);
2161
2162 /// C++ [expr.dynamic.cast]p9:
2163 /// A failed cast to reference type throws std::bad_cast
David Majnemer1162d252014-06-22 19:05:33 +00002164 if (!CGF.CGM.getCXXABI().EmitBadCastCall(CGF))
2165 return nullptr;
Anders Carlssonc1c99712011-04-11 01:45:29 +00002166
2167 CGF.EmitBlock(CGF.createBasicBlock("dynamic_cast.end"));
2168 return llvm::UndefValue::get(DestLTy);
2169}
2170
John McCall7f416cc2015-09-08 08:05:57 +00002171llvm::Value *CodeGenFunction::EmitDynamicCast(Address ThisAddr,
Mike Stump65511702009-11-16 06:50:58 +00002172 const CXXDynamicCastExpr *DCE) {
Alexey Bataev2bf9b4c2015-10-20 04:24:12 +00002173 CGM.EmitExplicitCastExprType(DCE, this);
Anders Carlsson3f4336c2009-12-17 07:09:17 +00002174 QualType DestTy = DCE->getTypeAsWritten();
Anders Carlsson882d7902011-04-11 00:46:40 +00002175
Anders Carlssonc1c99712011-04-11 01:45:29 +00002176 QualType SrcTy = DCE->getSubExpr()->getType();
2177
David Majnemer1162d252014-06-22 19:05:33 +00002178 // C++ [expr.dynamic.cast]p7:
2179 // If T is "pointer to cv void," then the result is a pointer to the most
2180 // derived object pointed to by v.
2181 const PointerType *DestPTy = DestTy->getAs<PointerType>();
2182
2183 bool isDynamicCastToVoid;
2184 QualType SrcRecordTy;
2185 QualType DestRecordTy;
2186 if (DestPTy) {
2187 isDynamicCastToVoid = DestPTy->getPointeeType()->isVoidType();
2188 SrcRecordTy = SrcTy->castAs<PointerType>()->getPointeeType();
2189 DestRecordTy = DestPTy->getPointeeType();
2190 } else {
2191 isDynamicCastToVoid = false;
2192 SrcRecordTy = SrcTy;
2193 DestRecordTy = DestTy->castAs<ReferenceType>()->getPointeeType();
2194 }
2195
Stephan Bergmannd71ad172017-12-28 12:45:41 +00002196 // C++ [class.cdtor]p5:
2197 // If the operand of the dynamic_cast refers to the object under
2198 // construction or destruction and the static type of the operand is not a
2199 // pointer to or object of the constructor or destructor’s own class or one
2200 // of its bases, the dynamic_cast results in undefined behavior.
2201 EmitTypeCheck(TCK_DynamicOperation, DCE->getExprLoc(), ThisAddr.getPointer(),
2202 SrcRecordTy);
2203
2204 if (DCE->isAlwaysNull())
2205 if (llvm::Value *T = EmitDynamicCastToNull(*this, DestTy))
2206 return T;
2207
David Majnemer1162d252014-06-22 19:05:33 +00002208 assert(SrcRecordTy->isRecordType() && "source type must be a record type!");
2209
Fangrui Song6907ce22018-07-30 19:24:48 +00002210 // C++ [expr.dynamic.cast]p4:
Anders Carlsson882d7902011-04-11 00:46:40 +00002211 // If the value of v is a null pointer value in the pointer case, the result
2212 // is the null pointer value of type T.
David Majnemer1162d252014-06-22 19:05:33 +00002213 bool ShouldNullCheckSrcValue =
2214 CGM.getCXXABI().shouldDynamicCastCallBeNullChecked(SrcTy->isPointerType(),
2215 SrcRecordTy);
Craig Topper8a13c412014-05-21 05:09:00 +00002216
2217 llvm::BasicBlock *CastNull = nullptr;
2218 llvm::BasicBlock *CastNotNull = nullptr;
Anders Carlsson882d7902011-04-11 00:46:40 +00002219 llvm::BasicBlock *CastEnd = createBasicBlock("dynamic_cast.end");
Fangrui Song6907ce22018-07-30 19:24:48 +00002220
Anders Carlsson882d7902011-04-11 00:46:40 +00002221 if (ShouldNullCheckSrcValue) {
2222 CastNull = createBasicBlock("dynamic_cast.null");
2223 CastNotNull = createBasicBlock("dynamic_cast.notnull");
2224
John McCall7f416cc2015-09-08 08:05:57 +00002225 llvm::Value *IsNull = Builder.CreateIsNull(ThisAddr.getPointer());
Anders Carlsson882d7902011-04-11 00:46:40 +00002226 Builder.CreateCondBr(IsNull, CastNull, CastNotNull);
2227 EmitBlock(CastNotNull);
Mike Stump65511702009-11-16 06:50:58 +00002228 }
2229
John McCall7f416cc2015-09-08 08:05:57 +00002230 llvm::Value *Value;
David Majnemer1162d252014-06-22 19:05:33 +00002231 if (isDynamicCastToVoid) {
John McCall7f416cc2015-09-08 08:05:57 +00002232 Value = CGM.getCXXABI().EmitDynamicCastToVoid(*this, ThisAddr, SrcRecordTy,
David Majnemer1162d252014-06-22 19:05:33 +00002233 DestTy);
2234 } else {
2235 assert(DestRecordTy->isRecordType() &&
2236 "destination type must be a record type!");
John McCall7f416cc2015-09-08 08:05:57 +00002237 Value = CGM.getCXXABI().EmitDynamicCastCall(*this, ThisAddr, SrcRecordTy,
David Majnemer1162d252014-06-22 19:05:33 +00002238 DestTy, DestRecordTy, CastEnd);
David Majnemer67528ea2015-11-23 03:01:14 +00002239 CastNotNull = Builder.GetInsertBlock();
David Majnemer1162d252014-06-22 19:05:33 +00002240 }
Anders Carlsson882d7902011-04-11 00:46:40 +00002241
2242 if (ShouldNullCheckSrcValue) {
2243 EmitBranch(CastEnd);
2244
2245 EmitBlock(CastNull);
2246 EmitBranch(CastEnd);
2247 }
2248
2249 EmitBlock(CastEnd);
2250
2251 if (ShouldNullCheckSrcValue) {
2252 llvm::PHINode *PHI = Builder.CreatePHI(Value->getType(), 2);
2253 PHI->addIncoming(Value, CastNotNull);
2254 PHI->addIncoming(llvm::Constant::getNullValue(Value->getType()), CastNull);
2255
2256 Value = PHI;
2257 }
2258
2259 return Value;
Mike Stump65511702009-11-16 06:50:58 +00002260}