1//===--- CGExprCXX.cpp - Emit LLVM Code for C++ expressions ---------------===//
2//
3// 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
6//
7//===----------------------------------------------------------------------===//
8//
9// This contains code dealing with code generation of C++ expressions
10//
11//===----------------------------------------------------------------------===//
12
13#include "CGCUDARuntime.h"
14#include "CGCXXABI.h"
15#include "CGDebugInfo.h"
16#include "CGObjCRuntime.h"
17#include "CodeGenFunction.h"
18#include "ConstantEmitter.h"
19#include "TargetInfo.h"
20#include "clang/Basic/CodeGenOptions.h"
21#include "clang/Basic/OperatorKinds.h"
22#include "clang/CodeGen/CGFunctionInfo.h"
23#include "llvm/IR/Intrinsics.h"
24
25using namespace clang;
26using namespace CodeGen;
27
28namespace {
29struct MemberCallInfo {
30 RequiredArgs ReqArgs;
31 // Number of prefix arguments for the call. Ignores the `this` pointer.
32 unsigned PrefixSize;
33};
34} // namespace
35
36static MemberCallInfo
37commonEmitCXXMemberOrOperatorCall(CodeGenFunction &CGF, GlobalDecl GD,
38 llvm::Value *This, llvm::Value *ImplicitParam,
39 QualType ImplicitParamTy, const CallExpr *CE,
40 CallArgList &Args, CallArgList *RtlArgs) {
41 auto *MD = cast<CXXMethodDecl>(Val: GD.getDecl());
42
43 assert(CE == nullptr || isa<CXXMemberCallExpr>(CE) ||
44 isa<CXXOperatorCallExpr>(CE));
45 assert(MD->isImplicitObjectMemberFunction() &&
46 "Trying to emit a member or operator call expr on a static method!");
47
48 // Push the this ptr.
49 const CXXRecordDecl *RD =
50 CGF.CGM.getCXXABI().getThisArgumentTypeForMethod(GD);
51 Args.add(rvalue: RValue::get(V: This), type: CGF.getTypes().DeriveThisType(RD, MD));
52
53 // If there is an implicit parameter (e.g. VTT), emit it.
54 if (ImplicitParam) {
55 Args.add(rvalue: RValue::get(V: ImplicitParam), type: ImplicitParamTy);
56 }
57
58 const FunctionProtoType *FPT = MD->getType()->castAs<FunctionProtoType>();
59 RequiredArgs required = RequiredArgs::forPrototypePlus(prototype: FPT, additional: Args.size());
60 unsigned PrefixSize = Args.size() - 1;
61
62 // And the rest of the call args.
63 if (RtlArgs) {
64 // Special case: if the caller emitted the arguments right-to-left already
65 // (prior to emitting the *this argument), we're done. This happens for
66 // assignment operators.
67 Args.addFrom(other: *RtlArgs);
68 } else if (CE) {
69 // Special case: skip first argument of CXXOperatorCall (it is "this").
70 unsigned ArgsToSkip = 0;
71 if (const auto *Op = dyn_cast<CXXOperatorCallExpr>(Val: CE)) {
72 if (const auto *M = dyn_cast<CXXMethodDecl>(Val: Op->getCalleeDecl()))
73 ArgsToSkip =
74 static_cast<unsigned>(!M->isExplicitObjectMemberFunction());
75 }
76 CGF.EmitCallArgs(Args, Prototype: FPT, ArgRange: drop_begin(RangeOrContainer: CE->arguments(), N: ArgsToSkip),
77 AC: CE->getDirectCallee());
78 } else {
79 assert(
80 FPT->getNumParams() == 0 &&
81 "No CallExpr specified for function with non-zero number of arguments");
82 }
83 return {.ReqArgs: required, .PrefixSize: PrefixSize};
84}
85
86RValue CodeGenFunction::EmitCXXMemberOrOperatorCall(
87 const CXXMethodDecl *MD, const CGCallee &Callee,
88 ReturnValueSlot ReturnValue, llvm::Value *This, llvm::Value *ImplicitParam,
89 QualType ImplicitParamTy, const CallExpr *CE, CallArgList *RtlArgs,
90 llvm::CallBase **CallOrInvoke) {
91 const FunctionProtoType *FPT = MD->getType()->castAs<FunctionProtoType>();
92 CallArgList Args;
93 MemberCallInfo CallInfo = commonEmitCXXMemberOrOperatorCall(
94 CGF&: *this, GD: MD, This, ImplicitParam, ImplicitParamTy, CE, Args, RtlArgs);
95 auto &FnInfo = CGM.getTypes().arrangeCXXMethodCall(
96 args: Args, type: FPT, required: CallInfo.ReqArgs, numPrefixArgs: CallInfo.PrefixSize,
97 ABIInfoFD: getCurrentFunctionDecl());
98 return EmitCall(CallInfo: FnInfo, Callee, ReturnValue, Args, CallOrInvoke,
99 IsMustTail: CE && CE == MustTailCall,
100 Loc: CE ? CE->getExprLoc() : SourceLocation());
101}
102
103RValue CodeGenFunction::EmitCXXDestructorCall(
104 GlobalDecl Dtor, const CGCallee &Callee, llvm::Value *This, QualType ThisTy,
105 llvm::Value *ImplicitParam, QualType ImplicitParamTy, const CallExpr *CE,
106 llvm::CallBase **CallOrInvoke) {
107 const CXXMethodDecl *DtorDecl = cast<CXXMethodDecl>(Val: Dtor.getDecl());
108
109 assert(!ThisTy.isNull());
110 assert(ThisTy->getAsCXXRecordDecl() == DtorDecl->getParent() &&
111 "Pointer/Object mixup");
112
113 LangAS SrcAS = ThisTy.getAddressSpace();
114 LangAS DstAS = DtorDecl->getMethodQualifiers().getAddressSpace();
115 if (SrcAS != DstAS) {
116 QualType DstTy = DtorDecl->getThisType();
117 llvm::Type *NewType = CGM.getTypes().ConvertType(T: DstTy);
118 This = performAddrSpaceCast(Src: This, DestTy: NewType);
119 }
120
121 CallArgList Args;
122 commonEmitCXXMemberOrOperatorCall(CGF&: *this, GD: Dtor, This, ImplicitParam,
123 ImplicitParamTy, CE, Args, RtlArgs: nullptr);
124 return EmitCall(CallInfo: CGM.getTypes().arrangeCXXStructorDeclaration(GD: Dtor), Callee,
125 ReturnValue: ReturnValueSlot(), Args, CallOrInvoke,
126 IsMustTail: CE && CE == MustTailCall,
127 Loc: CE ? CE->getExprLoc() : SourceLocation{});
128}
129
130RValue
131CodeGenFunction::EmitCXXPseudoDestructorExpr(const CXXPseudoDestructorExpr *E) {
132 QualType DestroyedType = E->getDestroyedType();
133 if (DestroyedType.hasStrongOrWeakObjCLifetime()) {
134 // Automatic Reference Counting:
135 // If the pseudo-expression names a retainable object with weak or
136 // strong lifetime, the object shall be released.
137 Expr *BaseExpr = E->getBase();
138 Address BaseValue = Address::invalid();
139 Qualifiers BaseQuals;
140
141 // If this is s.x, emit s as an lvalue. If it is s->x, emit s as a scalar.
142 if (E->isArrow()) {
143 BaseValue = EmitPointerWithAlignment(Addr: BaseExpr);
144 const auto *PTy = BaseExpr->getType()->castAs<PointerType>();
145 BaseQuals = PTy->getPointeeType().getQualifiers();
146 } else {
147 LValue BaseLV = EmitLValue(E: BaseExpr);
148 BaseValue = BaseLV.getAddress();
149 QualType BaseTy = BaseExpr->getType();
150 BaseQuals = BaseTy.getQualifiers();
151 }
152
153 switch (DestroyedType.getObjCLifetime()) {
154 case Qualifiers::OCL_None:
155 case Qualifiers::OCL_ExplicitNone:
156 case Qualifiers::OCL_Autoreleasing:
157 break;
158
159 case Qualifiers::OCL_Strong:
160 EmitARCRelease(
161 value: Builder.CreateLoad(Addr: BaseValue, IsVolatile: DestroyedType.isVolatileQualified()),
162 precise: ARCPreciseLifetime);
163 break;
164
165 case Qualifiers::OCL_Weak:
166 EmitARCDestroyWeak(addr: BaseValue);
167 break;
168 }
169 } else {
170 // C++ [expr.pseudo]p1:
171 // The result shall only be used as the operand for the function call
172 // operator (), and the result of such a call has type void. The only
173 // effect is the evaluation of the postfix-expression before the dot or
174 // arrow.
175 EmitIgnoredExpr(E: E->getBase());
176 }
177
178 return RValue::get(V: nullptr);
179}
180
181static CXXRecordDecl *getCXXRecord(const Expr *E) {
182 QualType T = E->getType();
183 if (const PointerType *PTy = T->getAs<PointerType>())
184 T = PTy->getPointeeType();
185 return T->castAsCXXRecordDecl();
186}
187
188// Note: This function also emit constructor calls to support a MSVC
189// extensions allowing explicit constructor function call.
190RValue CodeGenFunction::EmitCXXMemberCallExpr(const CXXMemberCallExpr *CE,
191 ReturnValueSlot ReturnValue,
192 llvm::CallBase **CallOrInvoke) {
193 const Expr *callee = CE->getCallee()->IgnoreParens();
194
195 if (isa<BinaryOperator>(Val: callee))
196 return EmitCXXMemberPointerCallExpr(E: CE, ReturnValue, CallOrInvoke);
197
198 const MemberExpr *ME = cast<MemberExpr>(Val: callee);
199 const CXXMethodDecl *MD = cast<CXXMethodDecl>(Val: ME->getMemberDecl());
200
201 // Sema represents calls to static member functions as ordinary CallExpr
202 // nodes rather than CXXMemberCallExpr.
203 assert(!MD->isStatic() &&
204 "static member call is unexpected in EmitCXXMemberCallExpr");
205
206 bool HasQualifier = ME->hasQualifier();
207 NestedNameSpecifier Qualifier = ME->getQualifier();
208 bool IsArrow = ME->isArrow();
209 const Expr *Base = ME->getBase();
210
211 return EmitCXXMemberOrOperatorMemberCallExpr(CE, MD, ReturnValue,
212 HasQualifier, Qualifier, IsArrow,
213 Base, CallOrInvoke);
214}
215
216RValue CodeGenFunction::EmitCXXMemberOrOperatorMemberCallExpr(
217 const CallExpr *CE, const CXXMethodDecl *MD, ReturnValueSlot ReturnValue,
218 bool HasQualifier, NestedNameSpecifier Qualifier, bool IsArrow,
219 const Expr *Base, llvm::CallBase **CallOrInvoke) {
220 assert(isa<CXXMemberCallExpr>(CE) || isa<CXXOperatorCallExpr>(CE));
221
222 // Compute the object pointer.
223 bool CanUseVirtualCall = MD->isVirtual() && !HasQualifier;
224
225 const CXXMethodDecl *DevirtualizedMethod = nullptr;
226 if (CanUseVirtualCall &&
227 MD->getDevirtualizedMethod(Base, IsAppleKext: getLangOpts().AppleKext)) {
228 const CXXRecordDecl *BestDynamicDecl = Base->getBestDynamicClassType();
229 DevirtualizedMethod = MD->getCorrespondingMethodInClass(RD: BestDynamicDecl);
230 assert(DevirtualizedMethod);
231 const CXXRecordDecl *DevirtualizedClass = DevirtualizedMethod->getParent();
232 const Expr *Inner = Base->IgnoreParenBaseCasts();
233 if (DevirtualizedMethod->getReturnType().getCanonicalType() !=
234 MD->getReturnType().getCanonicalType())
235 // If the return types are not the same, this might be a case where more
236 // code needs to run to compensate for it. For example, the derived
237 // method might return a type that inherits form from the return
238 // type of MD and has a prefix.
239 // For now we just avoid devirtualizing these covariant cases.
240 DevirtualizedMethod = nullptr;
241 else if (getCXXRecord(E: Inner) == DevirtualizedClass)
242 // If the class of the Inner expression is where the dynamic method
243 // is defined, build the this pointer from it.
244 Base = Inner;
245 else if (getCXXRecord(E: Base) != DevirtualizedClass) {
246 // If the method is defined in a class that is not the best dynamic
247 // one or the one of the full expression, we would have to build
248 // a derived-to-base cast to compute the correct this pointer, but
249 // we don't have support for that yet, so do a virtual call.
250 DevirtualizedMethod = nullptr;
251 }
252 }
253
254 bool TrivialAssignment = MD->isMemcpyEquivalentSpecialMember(Ctx: getContext());
255
256 // C++17 demands that we evaluate the RHS of a (possibly-compound) assignment
257 // operator before the LHS.
258 CallArgList RtlArgStorage;
259 CallArgList *RtlArgs = nullptr;
260 LValue TrivialAssignmentRHS;
261 if (auto *OCE = dyn_cast<CXXOperatorCallExpr>(Val: CE)) {
262 if (OCE->isAssignmentOp()) {
263 if (TrivialAssignment) {
264 TrivialAssignmentRHS = EmitCheckedLValue(E: CE->getArg(Arg: 1), TCK: TCK_Load);
265 } else {
266 RtlArgs = &RtlArgStorage;
267 EmitCallArgs(Args&: *RtlArgs, Prototype: MD->getType()->castAs<FunctionProtoType>(),
268 ArgRange: drop_begin(RangeOrContainer: CE->arguments(), N: 1), AC: CE->getDirectCallee(),
269 /*ParamsToSkip*/ 0, Order: EvaluationOrder::ForceRightToLeft);
270 }
271 }
272 }
273
274 std::optional<LValue> HLSLThisLValue;
275 if (auto *HLSLOutArg = dyn_cast<HLSLOutArgExpr>(Val: Base)) {
276 if (!RtlArgs)
277 RtlArgs = &RtlArgStorage;
278 HLSLThisLValue = EmitHLSLOutArgExpr(
279 E: HLSLOutArg, Args&: *RtlArgs, Ty: HLSLOutArg->getType(), /*IsImplicitObject=*/true);
280 EmitCallArgs(Args&: *RtlArgs, Prototype: MD->getType()->castAs<FunctionProtoType>(),
281 ArgRange: drop_begin(RangeOrContainer: CE->arguments(), N: 0), AC: CE->getDirectCallee());
282 }
283
284 auto getLValueForThis = [this, IsArrow, Base,
285 HLSLThisLValue](bool EmitCheckedForStore = false) {
286 // FIXME: Respect EmitCheckedForStore for the IsArrow case.
287 if (IsArrow) {
288 LValueBaseInfo BaseInfo;
289 TBAAAccessInfo TBAAInfo;
290 Address ThisValue = EmitPointerWithAlignment(Addr: Base, BaseInfo: &BaseInfo, TBAAInfo: &TBAAInfo);
291 return MakeAddrLValue(Addr: ThisValue, T: Base->getType()->getPointeeType(),
292 BaseInfo, TBAAInfo);
293 }
294 if (HLSLThisLValue)
295 return *HLSLThisLValue;
296 if (EmitCheckedForStore)
297 return EmitCheckedLValue(E: Base, TCK: TCK_Store);
298 return EmitLValue(E: Base);
299 };
300
301 if (const CXXConstructorDecl *Ctor = dyn_cast<CXXConstructorDecl>(Val: MD)) {
302 // This is the MSVC p->Ctor::Ctor(...) extension. We assume that's
303 // constructing a new complete object of type Ctor.
304 assert(!RtlArgs);
305 assert(ReturnValue.isNull() && "Constructor shouldn't have return value");
306 LValue This = getLValueForThis();
307 CallArgList Args;
308 commonEmitCXXMemberOrOperatorCall(
309 CGF&: *this, GD: {Ctor, Ctor_Complete}, This: This.getPointer(CGF&: *this),
310 /*ImplicitParam=*/nullptr,
311 /*ImplicitParamTy=*/QualType(), CE, Args, RtlArgs: nullptr);
312
313 EmitCXXConstructorCall(D: Ctor, Type: Ctor_Complete, /*ForVirtualBase=*/false,
314 /*Delegating=*/false, This: This.getAddress(), Args,
315 Overlap: AggValueSlot::DoesNotOverlap, Loc: CE->getExprLoc(),
316 /*NewPointerIsChecked=*/false, CallOrInvoke);
317 return RValue::get(V: nullptr);
318 }
319
320 if (isa<CXXDestructorDecl>(Val: MD) && MD->isTrivial()) {
321 (void)getLValueForThis(); // Emit LHS for side effects.
322 return RValue::get(V: nullptr);
323 }
324
325 if (TrivialAssignment) {
326 // We don't like to generate the trivial copy/move assignment operator
327 // when it isn't necessary; just produce the proper effect here.
328 LValue This = getLValueForThis(/*EmitCheckedForStore=*/true);
329
330 // It's important that we use the result of EmitCheckedLValue here rather
331 // than emitting call arguments, in order to preserve TBAA information
332 // from the RHS.
333 LValue RHS = isa<CXXOperatorCallExpr>(Val: CE)
334 ? TrivialAssignmentRHS
335 : EmitCheckedLValue(E: *CE->arg_begin(), TCK: TCK_Load);
336 EmitAggregateAssign(Dest: This, Src: RHS, EltTy: CE->getType());
337 return RValue::get(V: This.getPointer(CGF&: *this));
338 }
339
340 // Compute the function type we're calling.
341 const CXXMethodDecl *CalleeDecl =
342 DevirtualizedMethod ? DevirtualizedMethod : MD;
343 const CGFunctionInfo *FInfo = nullptr;
344 if (const auto *Dtor = dyn_cast<CXXDestructorDecl>(Val: CalleeDecl))
345 FInfo = &CGM.getTypes().arrangeCXXStructorDeclaration(
346 GD: GlobalDecl(Dtor, Dtor_Complete));
347 else
348 FInfo = &CGM.getTypes().arrangeCXXMethodDeclaration(MD: CalleeDecl);
349
350 llvm::FunctionType *Ty = CGM.getTypes().GetFunctionType(Info: *FInfo);
351
352 // C++11 [class.mfct.non-static]p2:
353 // If a non-static member function of a class X is called for an object that
354 // is not of type X, or of a type derived from X, the behavior is undefined.
355 SourceLocation CallLoc;
356 ASTContext &C = getContext();
357 if (CE)
358 CallLoc = CE->getExprLoc();
359
360 SanitizerSet SkippedChecks;
361 if (const auto *CMCE = dyn_cast<CXXMemberCallExpr>(Val: CE)) {
362 auto *IOA = CMCE->getImplicitObjectArgument();
363 bool IsImplicitObjectCXXThis = IsWrappedCXXThis(E: IOA);
364 if (IsImplicitObjectCXXThis)
365 SkippedChecks.set(K: SanitizerKind::Alignment, Value: true);
366 if (IsImplicitObjectCXXThis || isa<DeclRefExpr>(Val: IOA))
367 SkippedChecks.set(K: SanitizerKind::Null, Value: true);
368 }
369
370 LValue This = getLValueForThis();
371 if (sanitizePerformTypeCheck())
372 EmitTypeCheck(TCK: CodeGenFunction::TCK_MemberCall, Loc: CallLoc,
373 V: This.emitRawPointer(CGF&: *this),
374 Type: C.getCanonicalTagType(TD: CalleeDecl->getParent()),
375 /*Alignment=*/CharUnits::Zero(), SkippedChecks);
376
377 // C++ [class.virtual]p12:
378 // Explicit qualification with the scope operator (5.1) suppresses the
379 // virtual call mechanism.
380 //
381 // We also don't emit a virtual call if the base expression has a record type
382 // because then we know what the type is.
383 bool UseVirtualCall = CanUseVirtualCall && !DevirtualizedMethod;
384
385 if (const CXXDestructorDecl *Dtor = dyn_cast<CXXDestructorDecl>(Val: CalleeDecl)) {
386 assert(CE->arguments().empty() &&
387 "Destructor shouldn't have explicit parameters");
388 assert(ReturnValue.isNull() && "Destructor shouldn't have return value");
389 if (UseVirtualCall) {
390 CGM.getCXXABI().EmitVirtualDestructorCall(
391 CGF&: *this, Dtor, DtorType: Dtor_Complete, This: This.getAddress(),
392 E: cast<CXXMemberCallExpr>(Val: CE), CallOrInvoke);
393 } else {
394 GlobalDecl GD(Dtor, Dtor_Complete);
395 CGCallee Callee;
396 if (getLangOpts().AppleKext && Dtor->isVirtual() && HasQualifier)
397 Callee = BuildAppleKextVirtualCall(MD: Dtor, Qual: Qualifier, Ty);
398 else if (!DevirtualizedMethod)
399 Callee =
400 CGCallee::forDirect(functionPtr: CGM.getAddrOfCXXStructor(GD, FnInfo: FInfo, FnType: Ty), abstractInfo: GD);
401 else {
402 Callee = CGCallee::forDirect(functionPtr: CGM.GetAddrOfFunction(GD, Ty), abstractInfo: GD);
403 }
404
405 QualType ThisTy =
406 IsArrow ? Base->getType()->getPointeeType() : Base->getType();
407 EmitCXXDestructorCall(Dtor: GD, Callee, This: This.getPointer(CGF&: *this), ThisTy,
408 /*ImplicitParam=*/nullptr,
409 /*ImplicitParamTy=*/QualType(), CE, CallOrInvoke);
410 }
411 return RValue::get(V: nullptr);
412 }
413
414 // FIXME: Uses of 'MD' past this point need to be audited. We may need to use
415 // 'CalleeDecl' instead.
416
417 CGCallee Callee;
418 if (UseVirtualCall) {
419 Callee = CGCallee::forVirtual(CE, MD, Addr: This.getAddress(), FTy: Ty);
420 } else {
421 if (SanOpts.has(K: SanitizerKind::CFINVCall) &&
422 MD->getParent()->isDynamicClass()) {
423 llvm::Value *VTable;
424 const CXXRecordDecl *RD;
425 std::tie(args&: VTable, args&: RD) = CGM.getCXXABI().LoadVTablePtr(
426 CGF&: *this, This: This.getAddress(), RD: CalleeDecl->getParent());
427 EmitVTablePtrCheckForCall(RD, VTable, TCK: CFITCK_NVCall, Loc: CE->getBeginLoc());
428 }
429
430 if (getLangOpts().AppleKext && MD->isVirtual() && HasQualifier)
431 Callee = BuildAppleKextVirtualCall(MD, Qual: Qualifier, Ty);
432 else if (!DevirtualizedMethod)
433 Callee =
434 CGCallee::forDirect(functionPtr: CGM.GetAddrOfFunction(GD: MD, Ty), abstractInfo: GlobalDecl(MD));
435 else {
436 Callee =
437 CGCallee::forDirect(functionPtr: CGM.GetAddrOfFunction(GD: DevirtualizedMethod, Ty),
438 abstractInfo: GlobalDecl(DevirtualizedMethod));
439 }
440 }
441
442 if (MD->isVirtual()) {
443 Address NewThisAddr =
444 CGM.getCXXABI().adjustThisArgumentForVirtualFunctionCall(
445 CGF&: *this, GD: CalleeDecl, This: This.getAddress(), VirtualCall: UseVirtualCall);
446 This.setAddress(NewThisAddr);
447 }
448
449 return EmitCXXMemberOrOperatorCall(
450 MD: CalleeDecl, Callee, ReturnValue, This: This.getPointer(CGF&: *this),
451 /*ImplicitParam=*/nullptr, ImplicitParamTy: QualType(), CE, RtlArgs, CallOrInvoke);
452}
453
454RValue
455CodeGenFunction::EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E,
456 ReturnValueSlot ReturnValue,
457 llvm::CallBase **CallOrInvoke) {
458 const BinaryOperator *BO =
459 cast<BinaryOperator>(Val: E->getCallee()->IgnoreParens());
460 const Expr *BaseExpr = BO->getLHS();
461 const Expr *MemFnExpr = BO->getRHS();
462
463 const auto *MPT = MemFnExpr->getType()->castAs<MemberPointerType>();
464 const auto *FPT = MPT->getPointeeType()->castAs<FunctionProtoType>();
465 const auto *RD = MPT->getMostRecentCXXRecordDecl();
466
467 // Emit the 'this' pointer.
468 Address This = Address::invalid();
469 if (BO->getOpcode() == BO_PtrMemI)
470 This = EmitPointerWithAlignment(Addr: BaseExpr, BaseInfo: nullptr, TBAAInfo: nullptr, IsKnownNonNull: KnownNonNull);
471 else
472 This = EmitLValue(E: BaseExpr, IsKnownNonNull: KnownNonNull).getAddress();
473
474 CanQualType ClassType = CGM.getContext().getCanonicalTagType(TD: RD);
475 EmitTypeCheck(TCK: TCK_MemberCall, Loc: E->getExprLoc(), V: This.emitRawPointer(CGF&: *this),
476 Type: ClassType);
477
478 // Get the member function pointer.
479 llvm::Value *MemFnPtr = EmitScalarExpr(E: MemFnExpr);
480
481 // Ask the ABI to load the callee. Note that This is modified.
482 llvm::Value *ThisPtrForCall = nullptr;
483 CGCallee Callee = CGM.getCXXABI().EmitLoadOfMemberFunctionPointer(
484 CGF&: *this, E: BO, This, ThisPtrForCall, MemPtr: MemFnPtr, MPT);
485
486 CallArgList Args;
487
488 QualType ThisType = getContext().getPointerType(T: ClassType);
489
490 // Push the this ptr.
491 Args.add(rvalue: RValue::get(V: ThisPtrForCall), type: ThisType);
492
493 RequiredArgs required = RequiredArgs::forPrototypePlus(prototype: FPT, additional: 1);
494
495 // And the rest of the call args
496 EmitCallArgs(Args, Prototype: FPT, ArgRange: E->arguments());
497 return EmitCall(CallInfo: CGM.getTypes().arrangeCXXMethodCall(args: Args, type: FPT, required,
498 /*PrefixSize=*/numPrefixArgs: 0,
499 ABIInfoFD: getCurrentFunctionDecl()),
500 Callee, ReturnValue, Args, CallOrInvoke, IsMustTail: E == MustTailCall,
501 Loc: E->getExprLoc());
502}
503
504RValue CodeGenFunction::EmitCXXOperatorMemberCallExpr(
505 const CXXOperatorCallExpr *E, const CXXMethodDecl *MD,
506 ReturnValueSlot ReturnValue, llvm::CallBase **CallOrInvoke) {
507 assert(MD->isImplicitObjectMemberFunction() &&
508 "Trying to emit a member call expr on a static method!");
509 return EmitCXXMemberOrOperatorMemberCallExpr(
510 CE: E, MD, ReturnValue, /*HasQualifier=*/false, /*Qualifier=*/std::nullopt,
511 /*IsArrow=*/false, Base: E->getArg(Arg: 0), CallOrInvoke);
512}
513
514RValue CodeGenFunction::EmitCUDAKernelCallExpr(const CUDAKernelCallExpr *E,
515 ReturnValueSlot ReturnValue,
516 llvm::CallBase **CallOrInvoke) {
517 // Emit as a device kernel call if CUDA device code is to be generated.
518 // TODO: implement for HIP
519 if (!getLangOpts().HIP && getLangOpts().CUDAIsDevice)
520 return CGM.getCUDARuntime().EmitCUDADeviceKernelCallExpr(
521 CGF&: *this, E, ReturnValue, CallOrInvoke);
522 return CGM.getCUDARuntime().EmitCUDAKernelCallExpr(CGF&: *this, E, ReturnValue,
523 CallOrInvoke);
524}
525
526static void EmitNullBaseClassInitialization(CodeGenFunction &CGF,
527 Address DestPtr,
528 const CXXRecordDecl *Base) {
529 if (Base->isEmpty())
530 return;
531
532 DestPtr = DestPtr.withElementType(ElemTy: CGF.Int8Ty);
533
534 const ASTRecordLayout &Layout = CGF.getContext().getASTRecordLayout(D: Base);
535 CharUnits NVSize = Layout.getNonVirtualSize();
536
537 // We cannot simply zero-initialize the entire base sub-object if vbptrs are
538 // present, they are initialized by the most derived class before calling the
539 // constructor.
540 SmallVector<std::pair<CharUnits, CharUnits>, 1> Stores;
541 Stores.emplace_back(Args: CharUnits::Zero(), Args&: NVSize);
542
543 // Each store is split by the existence of a vbptr.
544 CharUnits VBPtrWidth = CGF.getPointerSize();
545 std::vector<CharUnits> VBPtrOffsets =
546 CGF.CGM.getCXXABI().getVBPtrOffsets(RD: Base);
547 for (CharUnits VBPtrOffset : VBPtrOffsets) {
548 // Stop before we hit any virtual base pointers located in virtual bases.
549 if (VBPtrOffset >= NVSize)
550 break;
551 std::pair<CharUnits, CharUnits> LastStore = Stores.pop_back_val();
552 CharUnits LastStoreOffset = LastStore.first;
553
554 CharUnits SplitBeforeOffset = LastStoreOffset;
555 CharUnits SplitBeforeSize = VBPtrOffset - SplitBeforeOffset;
556 assert(!SplitBeforeSize.isNegative() && "negative store size!");
557 if (!SplitBeforeSize.isZero())
558 Stores.emplace_back(Args&: SplitBeforeOffset, Args&: SplitBeforeSize);
559
560 CharUnits SplitAfterOffset = VBPtrOffset + VBPtrWidth;
561 CharUnits SplitAfterSize = NVSize - SplitAfterOffset;
562 assert(!SplitAfterSize.isNegative() && "negative store size!");
563 if (!SplitAfterSize.isZero())
564 Stores.emplace_back(Args&: SplitAfterOffset, Args&: SplitAfterSize);
565 }
566
567 // If the type contains a pointer to data member we can't memset it to zero.
568 // Instead, create a null constant and copy it to the destination.
569 // TODO: there are other patterns besides zero that we can usefully memset,
570 // like -1, which happens to be the pattern used by member-pointers.
571 // TODO: isZeroInitializable can be over-conservative in the case where a
572 // virtual base contains a member pointer.
573 llvm::Constant *NullConstantForBase = CGF.CGM.EmitNullConstantForBase(Record: Base);
574 if (!NullConstantForBase->isNullValue()) {
575 llvm::GlobalVariable *NullVariable = new llvm::GlobalVariable(
576 CGF.CGM.getModule(), NullConstantForBase->getType(),
577 /*isConstant=*/true, llvm::GlobalVariable::PrivateLinkage,
578 NullConstantForBase, Twine());
579
580 CharUnits Align =
581 std::max(a: Layout.getNonVirtualAlignment(), b: DestPtr.getAlignment());
582 NullVariable->setAlignment(Align.getAsAlign());
583
584 Address SrcPtr(NullVariable, CGF.Int8Ty, Align);
585
586 // Get and call the appropriate llvm.memcpy overload.
587 for (std::pair<CharUnits, CharUnits> Store : Stores) {
588 CharUnits StoreOffset = Store.first;
589 CharUnits StoreSize = Store.second;
590 llvm::Value *StoreSizeVal = CGF.CGM.getSize(numChars: StoreSize);
591 CGF.Builder.CreateMemCpy(
592 Dest: CGF.Builder.CreateConstInBoundsByteGEP(Addr: DestPtr, Offset: StoreOffset),
593 Src: CGF.Builder.CreateConstInBoundsByteGEP(Addr: SrcPtr, Offset: StoreOffset),
594 Size: StoreSizeVal);
595 }
596
597 // Otherwise, just memset the whole thing to zero. This is legal
598 // because in LLVM, all default initializers (other than the ones we just
599 // handled above) are guaranteed to have a bit pattern of all zeros.
600 } else {
601 for (std::pair<CharUnits, CharUnits> Store : Stores) {
602 CharUnits StoreOffset = Store.first;
603 CharUnits StoreSize = Store.second;
604 llvm::Value *StoreSizeVal = CGF.CGM.getSize(numChars: StoreSize);
605 CGF.Builder.CreateMemSet(
606 Dest: CGF.Builder.CreateConstInBoundsByteGEP(Addr: DestPtr, Offset: StoreOffset),
607 Value: CGF.Builder.getInt8(C: 0), Size: StoreSizeVal);
608 }
609 }
610}
611
612void CodeGenFunction::EmitCXXConstructExpr(const CXXConstructExpr *E,
613 AggValueSlot Dest) {
614 assert(!Dest.isIgnored() && "Must have a destination!");
615 const CXXConstructorDecl *CD = E->getConstructor();
616
617 // If we require zero initialization before (or instead of) calling the
618 // constructor, as can be the case with a non-user-provided default
619 // constructor, emit the zero initialization now, unless destination is
620 // already zeroed.
621 if (E->requiresZeroInitialization() && !Dest.isZeroed()) {
622 switch (E->getConstructionKind()) {
623 case CXXConstructionKind::Delegating:
624 case CXXConstructionKind::Complete:
625 EmitNullInitialization(DestPtr: Dest.getAddress(), Ty: E->getType());
626 break;
627 case CXXConstructionKind::VirtualBase:
628 case CXXConstructionKind::NonVirtualBase:
629 EmitNullBaseClassInitialization(CGF&: *this, DestPtr: Dest.getAddress(),
630 Base: CD->getParent());
631 break;
632 }
633 }
634
635 // If this is a call to a trivial default constructor, do nothing.
636 if (CD->isTrivial() && CD->isDefaultConstructor())
637 return;
638
639 // Elide the constructor if we're constructing from a temporary.
640 if (getLangOpts().ElideConstructors && E->isElidable()) {
641 // FIXME: This only handles the simplest case, where the source object
642 // is passed directly as the first argument to the constructor.
643 // This should also handle stepping though implicit casts and
644 // conversion sequences which involve two steps, with a
645 // conversion operator followed by a converting constructor.
646 const Expr *SrcObj = E->getArg(Arg: 0);
647 assert(SrcObj->isTemporaryObject(getContext(), CD->getParent()));
648 assert(
649 getContext().hasSameUnqualifiedType(E->getType(), SrcObj->getType()));
650 EmitAggExpr(E: SrcObj, AS: Dest);
651 return;
652 }
653
654 if (const ArrayType *arrayType = getContext().getAsArrayType(T: E->getType())) {
655 EmitCXXAggrConstructorCall(D: CD, ArrayTy: arrayType, ArrayPtr: Dest.getAddress(), E,
656 NewPointerIsChecked: Dest.isSanitizerChecked());
657 } else {
658 CXXCtorType Type = Ctor_Complete;
659 bool ForVirtualBase = false;
660 bool Delegating = false;
661
662 switch (E->getConstructionKind()) {
663 case CXXConstructionKind::Delegating:
664 // We should be emitting a constructor; GlobalDecl will assert this
665 Type = CurGD.getCtorType();
666 Delegating = true;
667 break;
668
669 case CXXConstructionKind::Complete:
670 Type = Ctor_Complete;
671 break;
672
673 case CXXConstructionKind::VirtualBase:
674 ForVirtualBase = true;
675 [[fallthrough]];
676
677 case CXXConstructionKind::NonVirtualBase:
678 Type = Ctor_Base;
679 }
680
681 // Call the constructor.
682 EmitCXXConstructorCall(D: CD, Type, ForVirtualBase, Delegating, ThisAVS: Dest, E);
683 }
684}
685
686void CodeGenFunction::EmitSynthesizedCXXCopyCtor(Address Dest, Address Src,
687 const Expr *Exp) {
688 if (const ExprWithCleanups *E = dyn_cast<ExprWithCleanups>(Val: Exp))
689 Exp = E->getSubExpr();
690 assert(isa<CXXConstructExpr>(Exp) &&
691 "EmitSynthesizedCXXCopyCtor - unknown copy ctor expr");
692 const CXXConstructExpr *E = cast<CXXConstructExpr>(Val: Exp);
693 const CXXConstructorDecl *CD = E->getConstructor();
694 RunCleanupsScope Scope(*this);
695
696 // If we require zero initialization before (or instead of) calling the
697 // constructor, as can be the case with a non-user-provided default
698 // constructor, emit the zero initialization now.
699 // FIXME. Do I still need this for a copy ctor synthesis?
700 if (E->requiresZeroInitialization())
701 EmitNullInitialization(DestPtr: Dest, Ty: E->getType());
702
703 assert(!getContext().getAsConstantArrayType(E->getType()) &&
704 "EmitSynthesizedCXXCopyCtor - Copied-in Array");
705 EmitSynthesizedCXXCopyCtorCall(D: CD, This: Dest, Src, E);
706}
707
708static CharUnits CalculateCookiePadding(CodeGenFunction &CGF,
709 const CXXNewExpr *E) {
710 if (!E->isArray())
711 return CharUnits::Zero();
712
713 // No cookie is required if the operator new[] being used is the
714 // reserved placement operator new[].
715 if (E->getOperatorNew()->isReservedGlobalPlacementOperator())
716 return CharUnits::Zero();
717
718 return CGF.CGM.getCXXABI().GetArrayCookieSize(expr: E);
719}
720
721static llvm::Value *EmitCXXNewAllocSize(CodeGenFunction &CGF,
722 const CXXNewExpr *e,
723 unsigned minElements,
724 llvm::Value *&numElements,
725 llvm::Value *&sizeWithoutCookie) {
726 QualType type = e->getAllocatedType();
727
728 if (!e->isArray()) {
729 CharUnits typeSize = CGF.getContext().getTypeSizeInChars(T: type);
730 sizeWithoutCookie =
731 llvm::ConstantInt::get(Ty: CGF.SizeTy, V: typeSize.getQuantity());
732 return sizeWithoutCookie;
733 }
734
735 // The width of size_t.
736 unsigned sizeWidth = CGF.SizeTy->getBitWidth();
737
738 // Figure out the cookie size.
739 llvm::APInt cookieSize(sizeWidth,
740 CalculateCookiePadding(CGF, E: e).getQuantity());
741
742 // Emit the array size expression.
743 // We multiply the size of all dimensions for NumElements.
744 // e.g for 'int[2][3]', ElemType is 'int' and NumElements is 6.
745 numElements = ConstantEmitter(CGF).tryEmitAbstract(
746 E: *e->getArraySize(), T: (*e->getArraySize())->getType());
747 if (!numElements)
748 numElements = CGF.EmitScalarExpr(E: *e->getArraySize());
749 assert(isa<llvm::IntegerType>(numElements->getType()));
750
751 // The number of elements can be have an arbitrary integer type;
752 // essentially, we need to multiply it by a constant factor, add a
753 // cookie size, and verify that the result is representable as a
754 // size_t. That's just a gloss, though, and it's wrong in one
755 // important way: if the count is negative, it's an error even if
756 // the cookie size would bring the total size >= 0.
757 bool isSigned =
758 (*e->getArraySize())->getType()->isSignedIntegerOrEnumerationType();
759 llvm::IntegerType *numElementsType =
760 cast<llvm::IntegerType>(Val: numElements->getType());
761 unsigned numElementsWidth = numElementsType->getBitWidth();
762
763 // Compute the constant factor.
764 llvm::APInt arraySizeMultiplier(sizeWidth, 1);
765 while (const ConstantArrayType *CAT =
766 CGF.getContext().getAsConstantArrayType(T: type)) {
767 type = CAT->getElementType();
768 arraySizeMultiplier *= CAT->getSize();
769 }
770
771 CharUnits typeSize = CGF.getContext().getTypeSizeInChars(T: type);
772 llvm::APInt typeSizeMultiplier(sizeWidth, typeSize.getQuantity());
773 typeSizeMultiplier *= arraySizeMultiplier;
774
775 // This will be a size_t.
776 llvm::Value *size;
777
778 // If someone is doing 'new int[42]' there is no need to do a dynamic check.
779 // Don't bloat the -O0 code.
780 if (llvm::ConstantInt *numElementsC =
781 dyn_cast<llvm::ConstantInt>(Val: numElements)) {
782 const llvm::APInt &count = numElementsC->getValue();
783
784 bool hasAnyOverflow = false;
785
786 // If 'count' was a negative number, it's an overflow.
787 if (isSigned && count.isNegative())
788 hasAnyOverflow = true;
789
790 // We want to do all this arithmetic in size_t. If numElements is
791 // wider than that, check whether it's already too big, and if so,
792 // overflow.
793 else if (numElementsWidth > sizeWidth &&
794 numElementsWidth - sizeWidth > count.countl_zero())
795 hasAnyOverflow = true;
796
797 // Okay, compute a count at the right width.
798 llvm::APInt adjustedCount = count.zextOrTrunc(width: sizeWidth);
799
800 // If there is a brace-initializer, we cannot allocate fewer elements than
801 // there are initializers. If we do, that's treated like an overflow.
802 if (adjustedCount.ult(RHS: minElements))
803 hasAnyOverflow = true;
804
805 // Scale numElements by that. This might overflow, but we don't
806 // care because it only overflows if allocationSize does, too, and
807 // if that overflows then we shouldn't use this.
808 numElements =
809 llvm::ConstantInt::get(Ty: CGF.SizeTy, V: adjustedCount * arraySizeMultiplier);
810
811 // Compute the size before cookie, and track whether it overflowed.
812 bool overflow;
813 llvm::APInt allocationSize =
814 adjustedCount.umul_ov(RHS: typeSizeMultiplier, Overflow&: overflow);
815 hasAnyOverflow |= overflow;
816
817 // Add in the cookie, and check whether it's overflowed.
818 if (cookieSize != 0) {
819 // Save the current size without a cookie. This shouldn't be
820 // used if there was overflow.
821 sizeWithoutCookie = llvm::ConstantInt::get(Ty: CGF.SizeTy, V: allocationSize);
822
823 allocationSize = allocationSize.uadd_ov(RHS: cookieSize, Overflow&: overflow);
824 hasAnyOverflow |= overflow;
825 }
826
827 // On overflow, produce a -1 so operator new will fail.
828 if (hasAnyOverflow) {
829 size = llvm::Constant::getAllOnesValue(Ty: CGF.SizeTy);
830 } else {
831 size = llvm::ConstantInt::get(Ty: CGF.SizeTy, V: allocationSize);
832 }
833
834 // Otherwise, we might need to use the overflow intrinsics.
835 } else {
836 // There are up to five conditions we need to test for:
837 // 1) if isSigned, we need to check whether numElements is negative;
838 // 2) if numElementsWidth > sizeWidth, we need to check whether
839 // numElements is larger than something representable in size_t;
840 // 3) if minElements > 0, we need to check whether numElements is smaller
841 // than that.
842 // 4) we need to compute
843 // sizeWithoutCookie := numElements * typeSizeMultiplier
844 // and check whether it overflows; and
845 // 5) if we need a cookie, we need to compute
846 // size := sizeWithoutCookie + cookieSize
847 // and check whether it overflows.
848
849 llvm::Value *hasOverflow = nullptr;
850
851 // If numElementsWidth > sizeWidth, then one way or another, we're
852 // going to have to do a comparison for (2), and this happens to
853 // take care of (1), too.
854 if (numElementsWidth > sizeWidth) {
855 llvm::APInt threshold =
856 llvm::APInt::getOneBitSet(numBits: numElementsWidth, BitNo: sizeWidth);
857
858 llvm::Value *thresholdV =
859 llvm::ConstantInt::get(Ty: numElementsType, V: threshold);
860
861 hasOverflow = CGF.Builder.CreateICmpUGE(LHS: numElements, RHS: thresholdV);
862 numElements = CGF.Builder.CreateTrunc(V: numElements, DestTy: CGF.SizeTy);
863
864 // Otherwise, if we're signed, we want to sext up to size_t.
865 } else if (isSigned) {
866 if (numElementsWidth < sizeWidth)
867 numElements = CGF.Builder.CreateSExt(V: numElements, DestTy: CGF.SizeTy);
868
869 // If there's a non-1 type size multiplier, then we can do the
870 // signedness check at the same time as we do the multiply
871 // because a negative number times anything will cause an
872 // unsigned overflow. Otherwise, we have to do it here. But at least
873 // in this case, we can subsume the >= minElements check.
874 if (typeSizeMultiplier == 1)
875 hasOverflow = CGF.Builder.CreateICmpSLT(
876 LHS: numElements, RHS: llvm::ConstantInt::get(Ty: CGF.SizeTy, V: minElements));
877
878 // Otherwise, zext up to size_t if necessary.
879 } else if (numElementsWidth < sizeWidth) {
880 numElements = CGF.Builder.CreateZExt(V: numElements, DestTy: CGF.SizeTy);
881 }
882
883 assert(numElements->getType() == CGF.SizeTy);
884
885 if (minElements) {
886 // Don't allow allocation of fewer elements than we have initializers.
887 if (!hasOverflow) {
888 hasOverflow = CGF.Builder.CreateICmpULT(
889 LHS: numElements, RHS: llvm::ConstantInt::get(Ty: CGF.SizeTy, V: minElements));
890 } else if (numElementsWidth > sizeWidth) {
891 // The other existing overflow subsumes this check.
892 // We do an unsigned comparison, since any signed value < -1 is
893 // taken care of either above or below.
894 hasOverflow = CGF.Builder.CreateOr(
895 LHS: hasOverflow,
896 RHS: CGF.Builder.CreateICmpULT(
897 LHS: numElements, RHS: llvm::ConstantInt::get(Ty: CGF.SizeTy, V: minElements)));
898 }
899 }
900
901 size = numElements;
902
903 // Multiply by the type size if necessary. This multiplier
904 // includes all the factors for nested arrays.
905 //
906 // This step also causes numElements to be scaled up by the
907 // nested-array factor if necessary. Overflow on this computation
908 // can be ignored because the result shouldn't be used if
909 // allocation fails.
910 if (typeSizeMultiplier != 1) {
911 llvm::Function *umul_with_overflow =
912 CGF.CGM.getIntrinsic(IID: llvm::Intrinsic::umul_with_overflow, Tys: CGF.SizeTy);
913
914 llvm::Value *tsmV =
915 llvm::ConstantInt::get(Ty: CGF.SizeTy, V: typeSizeMultiplier);
916 llvm::Value *result =
917 CGF.Builder.CreateCall(Callee: umul_with_overflow, Args: {size, tsmV});
918
919 llvm::Value *overflowed = CGF.Builder.CreateExtractValue(Agg: result, Idxs: 1);
920 if (hasOverflow)
921 hasOverflow = CGF.Builder.CreateOr(LHS: hasOverflow, RHS: overflowed);
922 else
923 hasOverflow = overflowed;
924
925 size = CGF.Builder.CreateExtractValue(Agg: result, Idxs: 0);
926
927 // Also scale up numElements by the array size multiplier.
928 if (arraySizeMultiplier != 1) {
929 // If the base element type size is 1, then we can re-use the
930 // multiply we just did.
931 if (typeSize.isOne()) {
932 assert(arraySizeMultiplier == typeSizeMultiplier);
933 numElements = size;
934
935 // Otherwise we need a separate multiply.
936 } else {
937 llvm::Value *asmV =
938 llvm::ConstantInt::get(Ty: CGF.SizeTy, V: arraySizeMultiplier);
939 numElements = CGF.Builder.CreateMul(LHS: numElements, RHS: asmV);
940 }
941 }
942 } else {
943 // numElements doesn't need to be scaled.
944 assert(arraySizeMultiplier == 1);
945 }
946
947 // Add in the cookie size if necessary.
948 if (cookieSize != 0) {
949 sizeWithoutCookie = size;
950
951 llvm::Function *uadd_with_overflow =
952 CGF.CGM.getIntrinsic(IID: llvm::Intrinsic::uadd_with_overflow, Tys: CGF.SizeTy);
953
954 llvm::Value *cookieSizeV = llvm::ConstantInt::get(Ty: CGF.SizeTy, V: cookieSize);
955 llvm::Value *result =
956 CGF.Builder.CreateCall(Callee: uadd_with_overflow, Args: {size, cookieSizeV});
957
958 llvm::Value *overflowed = CGF.Builder.CreateExtractValue(Agg: result, Idxs: 1);
959 if (hasOverflow)
960 hasOverflow = CGF.Builder.CreateOr(LHS: hasOverflow, RHS: overflowed);
961 else
962 hasOverflow = overflowed;
963
964 size = CGF.Builder.CreateExtractValue(Agg: result, Idxs: 0);
965 }
966
967 // If we had any possibility of dynamic overflow, make a select to
968 // overwrite 'size' with an all-ones value, which should cause
969 // operator new to throw.
970 if (hasOverflow)
971 size = CGF.Builder.CreateSelect(
972 C: hasOverflow, True: llvm::Constant::getAllOnesValue(Ty: CGF.SizeTy), False: size);
973 }
974
975 if (cookieSize == 0)
976 sizeWithoutCookie = size;
977 else
978 assert(sizeWithoutCookie && "didn't set sizeWithoutCookie?");
979
980 return size;
981}
982
983static void StoreAnyExprIntoOneUnit(CodeGenFunction &CGF, const Expr *Init,
984 QualType AllocType, Address NewPtr,
985 AggValueSlot::Overlap_t MayOverlap) {
986 // FIXME: Refactor with EmitExprAsInit.
987 switch (CGF.getEvaluationKind(T: AllocType)) {
988 case TEK_Scalar:
989 CGF.EmitScalarInit(init: Init, D: nullptr, lvalue: CGF.MakeAddrLValue(Addr: NewPtr, T: AllocType),
990 capturedByInit: false);
991 return;
992 case TEK_Complex:
993 CGF.EmitComplexExprIntoLValue(E: Init, dest: CGF.MakeAddrLValue(Addr: NewPtr, T: AllocType),
994 /*isInit*/ true);
995 return;
996 case TEK_Aggregate: {
997 AggValueSlot Slot = AggValueSlot::forAddr(
998 addr: NewPtr, quals: AllocType.getQualifiers(), isDestructed: AggValueSlot::IsDestructed,
999 needsGC: AggValueSlot::DoesNotNeedGCBarriers, isAliased: AggValueSlot::IsNotAliased,
1000 mayOverlap: MayOverlap, isZeroed: AggValueSlot::IsNotZeroed,
1001 isChecked: AggValueSlot::IsSanitizerChecked);
1002 CGF.EmitAggExpr(E: Init, AS: Slot);
1003 return;
1004 }
1005 }
1006 llvm_unreachable("bad evaluation kind");
1007}
1008
1009void CodeGenFunction::EmitNewArrayInitializer(
1010 const CXXNewExpr *E, QualType ElementType, llvm::Type *ElementTy,
1011 Address BeginPtr, llvm::Value *NumElements,
1012 llvm::Value *AllocSizeWithoutCookie) {
1013 // If we have a type with trivial initialization and no initializer,
1014 // there's nothing to do.
1015 if (!E->hasInitializer())
1016 return;
1017
1018 Address CurPtr = BeginPtr;
1019
1020 unsigned InitListElements = 0;
1021
1022 const Expr *Init = E->getInitializer();
1023 Address EndOfInit = Address::invalid();
1024 QualType::DestructionKind DtorKind = ElementType.isDestructedType();
1025 CleanupDeactivationScope deactivation(*this);
1026 bool pushedCleanup = false;
1027
1028 CharUnits ElementSize = getContext().getTypeSizeInChars(T: ElementType);
1029 CharUnits ElementAlign =
1030 BeginPtr.getAlignment().alignmentOfArrayElement(elementSize: ElementSize);
1031
1032 // Attempt to perform zero-initialization using memset.
1033 auto TryMemsetInitialization = [&]() -> bool {
1034 // FIXME: If the type is a pointer-to-data-member under the Itanium ABI,
1035 // we can initialize with a memset to -1.
1036 if (!CGM.getTypes().isZeroInitializable(T: ElementType))
1037 return false;
1038
1039 // Optimization: since zero initialization will just set the memory
1040 // to all zeroes, generate a single memset to do it in one shot.
1041
1042 // Subtract out the size of any elements we've already initialized.
1043 auto *RemainingSize = AllocSizeWithoutCookie;
1044 if (InitListElements) {
1045 // We know this can't overflow; we check this when doing the allocation.
1046 auto *InitializedSize = llvm::ConstantInt::get(
1047 Ty: RemainingSize->getType(),
1048 V: getContext().getTypeSizeInChars(T: ElementType).getQuantity() *
1049 InitListElements);
1050 RemainingSize = Builder.CreateSub(LHS: RemainingSize, RHS: InitializedSize);
1051 }
1052
1053 // Create the memset.
1054 Builder.CreateMemSet(Dest: CurPtr, Value: Builder.getInt8(C: 0), Size: RemainingSize, IsVolatile: false);
1055 return true;
1056 };
1057
1058 const InitListExpr *ILE = dyn_cast<InitListExpr>(Val: Init);
1059 const CXXParenListInitExpr *CPLIE = nullptr;
1060 const StringLiteral *SL = nullptr;
1061 const ObjCEncodeExpr *OCEE = nullptr;
1062 const Expr *IgnoreParen = nullptr;
1063 if (!ILE) {
1064 IgnoreParen = Init->IgnoreParenImpCasts();
1065 CPLIE = dyn_cast<CXXParenListInitExpr>(Val: IgnoreParen);
1066 SL = dyn_cast<StringLiteral>(Val: IgnoreParen);
1067 OCEE = dyn_cast<ObjCEncodeExpr>(Val: IgnoreParen);
1068 }
1069
1070 // If the initializer is an initializer list, first do the explicit elements.
1071 if (ILE || CPLIE || SL || OCEE) {
1072 // Initializing from a (braced) string literal is a special case; the init
1073 // list element does not initialize a (single) array element.
1074 if ((ILE && ILE->isStringLiteralInit()) || SL || OCEE) {
1075 if (!ILE)
1076 Init = IgnoreParen;
1077 // Initialize the initial portion of length equal to that of the string
1078 // literal. The allocation must be for at least this much; we emitted a
1079 // check for that earlier.
1080 AggValueSlot Slot = AggValueSlot::forAddr(
1081 addr: CurPtr, quals: ElementType.getQualifiers(), isDestructed: AggValueSlot::IsDestructed,
1082 needsGC: AggValueSlot::DoesNotNeedGCBarriers, isAliased: AggValueSlot::IsNotAliased,
1083 mayOverlap: AggValueSlot::DoesNotOverlap, isZeroed: AggValueSlot::IsNotZeroed,
1084 isChecked: AggValueSlot::IsSanitizerChecked);
1085 EmitAggExpr(E: ILE ? ILE->getInit(Init: 0) : Init, AS: Slot);
1086
1087 // Move past these elements.
1088 InitListElements =
1089 cast<ConstantArrayType>(Val: Init->getType()->getAsArrayTypeUnsafe())
1090 ->getZExtSize();
1091 CurPtr = Builder.CreateConstInBoundsGEP(Addr: CurPtr, Index: InitListElements,
1092 Name: "string.init.end");
1093
1094 // Zero out the rest, if any remain.
1095 llvm::ConstantInt *ConstNum = dyn_cast<llvm::ConstantInt>(Val: NumElements);
1096 if (!ConstNum || !ConstNum->equalsInt(V: InitListElements)) {
1097 bool OK = TryMemsetInitialization();
1098 (void)OK;
1099 assert(OK && "couldn't memset character type?");
1100 }
1101 return;
1102 }
1103
1104 ArrayRef<const Expr *> InitExprs =
1105 ILE ? ILE->inits() : CPLIE->getInitExprs();
1106 InitListElements =
1107 ILE ? ILE->getNumInitsWithEmbedExpanded() : InitExprs.size();
1108
1109 // If this is a multi-dimensional array new, we will initialize multiple
1110 // elements with each init list element.
1111 QualType AllocType = E->getAllocatedType();
1112 if (const ConstantArrayType *CAT = dyn_cast_or_null<ConstantArrayType>(
1113 Val: AllocType->getAsArrayTypeUnsafe())) {
1114 ElementTy = ConvertTypeForMem(T: AllocType);
1115 CurPtr = CurPtr.withElementType(ElemTy: ElementTy);
1116 InitListElements *= getContext().getConstantArrayElementCount(CA: CAT);
1117 }
1118
1119 // Enter a partial-destruction Cleanup if necessary.
1120 if (DtorKind) {
1121 AllocaTrackerRAII AllocaTracker(*this);
1122 // In principle we could tell the Cleanup where we are more
1123 // directly, but the control flow can get so varied here that it
1124 // would actually be quite complex. Therefore we go through an
1125 // alloca.
1126 llvm::Instruction *DominatingIP =
1127 Builder.CreateFlagLoad(Addr: llvm::ConstantInt::getNullValue(Ty: Int8PtrTy));
1128 EndOfInit = CreateTempAlloca(Ty: BeginPtr.getType(), align: getPointerAlign(),
1129 Name: "array.init.end");
1130 pushIrregularPartialArrayCleanup(arrayBegin: BeginPtr.emitRawPointer(CGF&: *this),
1131 arrayEndPointer: EndOfInit, elementType: ElementType, elementAlignment: ElementAlign,
1132 destroyer: getDestroyer(destructionKind: DtorKind));
1133 cast<EHCleanupScope>(Val&: *EHStack.find(sp: EHStack.stable_begin()))
1134 .AddAuxAllocas(Allocas: AllocaTracker.Take());
1135 DeferredDeactivationCleanupStack.push_back(
1136 Elt: {.Cleanup: EHStack.stable_begin(), .DominatingIP: DominatingIP});
1137 pushedCleanup = true;
1138 }
1139
1140 CharUnits StartAlign = CurPtr.getAlignment();
1141 unsigned i = 0;
1142 auto AdvanceToNextElement = [&]() {
1143 CurPtr = Address(Builder.CreateInBoundsGEP(Ty: CurPtr.getElementType(),
1144 Ptr: CurPtr.emitRawPointer(CGF&: *this),
1145 IdxList: Builder.getSize(N: 1),
1146 Name: "array.exp.next"),
1147 CurPtr.getElementType(),
1148 StartAlign.alignmentAtOffset(offset: (++i) * ElementSize));
1149 };
1150 for (const Expr *IE : InitExprs) {
1151 // Tell the cleanup that it needs to destroy up to this
1152 // element. TODO: some of these stores can be trivially
1153 // observed to be unnecessary.
1154 if (EndOfInit.isValid()) {
1155 Builder.CreateStore(Val: CurPtr.emitRawPointer(CGF&: *this), Addr: EndOfInit);
1156 }
1157 // A multi-element EmbedExpr initializes several array elements at once.
1158 // A single-element embed can be wrapped in a conversion to a non-scalar
1159 // element type (e.g. _Complex) and is emitted like any other
1160 // initializer.
1161 const auto *EmbedS = dyn_cast<EmbedExpr>(Val: IE->IgnoreParenImpCasts());
1162 if (EmbedS && EmbedS->getDataElementCount() > 1) {
1163 const StringLiteral *SL = EmbedS->getDataStringLiteral();
1164 llvm::Type *DataTy = ConvertType(T: EmbedS->getType());
1165 for (unsigned I = EmbedS->getStartingElementPos(),
1166 End = I + EmbedS->getDataElementCount();
1167 I != End; ++I) {
1168 llvm::Value *Val = EmitScalarConversion(
1169 Src: llvm::ConstantInt::get(Ty: DataTy, V: SL->getCodeUnit(I)),
1170 SrcTy: EmbedS->getType(), DstTy: ElementType, Loc: EmbedS->getLocation());
1171 EmitStoreOfScalar(value: Val, lvalue: MakeAddrLValue(Addr: CurPtr, T: ElementType),
1172 /*isInit=*/true);
1173 AdvanceToNextElement();
1174 }
1175 continue;
1176 }
1177 // FIXME: If the last initializer is an incomplete initializer list for
1178 // an array, and we have an array filler, we can fold together the two
1179 // initialization loops.
1180 StoreAnyExprIntoOneUnit(CGF&: *this, Init: IE, AllocType: IE->getType(), NewPtr: CurPtr,
1181 MayOverlap: AggValueSlot::DoesNotOverlap);
1182 AdvanceToNextElement();
1183 }
1184
1185 // The remaining elements are filled with the array filler expression.
1186 Init = ILE ? ILE->getArrayFiller() : CPLIE->getArrayFiller();
1187
1188 // Extract the initializer for the individual array elements by pulling
1189 // out the array filler from all the nested initializer lists. This avoids
1190 // generating a nested loop for the initialization.
1191 while (Init && Init->getType()->isConstantArrayType()) {
1192 auto *SubILE = dyn_cast<InitListExpr>(Val: Init);
1193 if (!SubILE)
1194 break;
1195 assert(SubILE->getNumInits() == 0 && "explicit inits in array filler?");
1196 Init = SubILE->getArrayFiller();
1197 }
1198
1199 // Switch back to initializing one base element at a time.
1200 CurPtr = CurPtr.withElementType(ElemTy: BeginPtr.getElementType());
1201 }
1202
1203 // If all elements have already been initialized, skip any further
1204 // initialization.
1205 llvm::ConstantInt *ConstNum = dyn_cast<llvm::ConstantInt>(Val: NumElements);
1206 if (ConstNum && ConstNum->getZExtValue() <= InitListElements) {
1207 return;
1208 }
1209
1210 assert(Init && "have trailing elements to initialize but no initializer");
1211
1212 // If this is a constructor call, try to optimize it out, and failing that
1213 // emit a single loop to initialize all remaining elements.
1214 if (const CXXConstructExpr *CCE = dyn_cast<CXXConstructExpr>(Val: Init)) {
1215 CXXConstructorDecl *Ctor = CCE->getConstructor();
1216 if (Ctor->isTrivial()) {
1217 // If new expression did not specify value-initialization, then there
1218 // is no initialization.
1219 if (!CCE->requiresZeroInitialization() || Ctor->getParent()->isEmpty())
1220 return;
1221
1222 if (TryMemsetInitialization())
1223 return;
1224 }
1225
1226 // Store the new Cleanup position for irregular Cleanups.
1227 //
1228 // FIXME: Share this cleanup with the constructor call emission rather than
1229 // having it create a cleanup of its own.
1230 if (EndOfInit.isValid())
1231 Builder.CreateStore(Val: CurPtr.emitRawPointer(CGF&: *this), Addr: EndOfInit);
1232
1233 // Emit a constructor call loop to initialize the remaining elements.
1234 if (InitListElements)
1235 NumElements = Builder.CreateSub(
1236 LHS: NumElements,
1237 RHS: llvm::ConstantInt::get(Ty: NumElements->getType(), V: InitListElements));
1238 EmitCXXAggrConstructorCall(D: Ctor, NumElements, ArrayPtr: CurPtr, E: CCE,
1239 /*NewPointerIsChecked*/ true,
1240 ZeroInitialization: CCE->requiresZeroInitialization());
1241 if (getContext().getTargetInfo().emitVectorDeletingDtors(
1242 getContext().getLangOpts())) {
1243 CXXDestructorDecl *Dtor = Ctor->getParent()->getDestructor();
1244 if (Dtor && Dtor->isVirtual())
1245 CGM.requireVectorDestructorDefinition(RD: Ctor->getParent());
1246 }
1247 return;
1248 }
1249
1250 // If this is value-initialization, we can usually use memset.
1251 ImplicitValueInitExpr IVIE(ElementType);
1252 if (isa<ImplicitValueInitExpr>(Val: Init)) {
1253 if (TryMemsetInitialization())
1254 return;
1255
1256 // Switch to an ImplicitValueInitExpr for the element type. This handles
1257 // only one case: multidimensional array new of pointers to members. In
1258 // all other cases, we already have an initializer for the array element.
1259 Init = &IVIE;
1260 }
1261
1262 // At this point we should have found an initializer for the individual
1263 // elements of the array.
1264 assert(getContext().hasSameUnqualifiedType(ElementType, Init->getType()) &&
1265 "got wrong type of element to initialize");
1266
1267 // If we have an empty initializer list, we can usually use memset.
1268 if (auto *ILE = dyn_cast<InitListExpr>(Val: Init))
1269 if (ILE->getNumInits() == 0 && TryMemsetInitialization())
1270 return;
1271
1272 // If we have a struct whose every field is value-initialized, we can
1273 // usually use memset.
1274 if (auto *ILE = dyn_cast<InitListExpr>(Val: Init)) {
1275 if (const RecordType *RType =
1276 ILE->getType()->getAsCanonical<RecordType>()) {
1277 if (RType->getDecl()->isStruct()) {
1278 const RecordDecl *RD = RType->getDecl()->getDefinitionOrSelf();
1279 unsigned NumElements = 0;
1280 if (auto *CXXRD = dyn_cast<CXXRecordDecl>(Val: RD))
1281 NumElements = CXXRD->getNumBases();
1282 for (auto *Field : RD->fields())
1283 if (!Field->isUnnamedBitField())
1284 ++NumElements;
1285 // FIXME: Recurse into nested InitListExprs.
1286 if (ILE->getNumInits() == NumElements)
1287 for (unsigned i = 0, e = ILE->getNumInits(); i != e; ++i)
1288 if (!isa<ImplicitValueInitExpr>(Val: ILE->getInit(Init: i)))
1289 --NumElements;
1290 if (ILE->getNumInits() == NumElements && TryMemsetInitialization())
1291 return;
1292 }
1293 }
1294 }
1295
1296 // Create the loop blocks.
1297 llvm::BasicBlock *EntryBB = Builder.GetInsertBlock();
1298 llvm::BasicBlock *LoopBB = createBasicBlock(name: "new.loop");
1299 llvm::BasicBlock *ContBB = createBasicBlock(name: "new.loop.end");
1300
1301 // Find the end of the array, hoisted out of the loop.
1302 llvm::Value *EndPtr = Builder.CreateInBoundsGEP(
1303 Ty: BeginPtr.getElementType(), Ptr: BeginPtr.emitRawPointer(CGF&: *this), IdxList: NumElements,
1304 Name: "array.end");
1305
1306 // If the number of elements isn't constant, we have to now check if there is
1307 // anything left to initialize.
1308 if (!ConstNum) {
1309 llvm::Value *IsEmpty = Builder.CreateICmpEQ(LHS: CurPtr.emitRawPointer(CGF&: *this),
1310 RHS: EndPtr, Name: "array.isempty");
1311 Builder.CreateCondBr(Cond: IsEmpty, True: ContBB, False: LoopBB);
1312 }
1313
1314 // Enter the loop.
1315 EmitBlock(BB: LoopBB);
1316
1317 // Set up the current-element phi.
1318 llvm::PHINode *CurPtrPhi =
1319 Builder.CreatePHI(Ty: CurPtr.getType(), NumReservedValues: 2, Name: "array.cur");
1320 CurPtrPhi->addIncoming(V: CurPtr.emitRawPointer(CGF&: *this), BB: EntryBB);
1321
1322 CurPtr = Address(CurPtrPhi, CurPtr.getElementType(), ElementAlign);
1323
1324 // Store the new Cleanup position for irregular Cleanups.
1325 if (EndOfInit.isValid())
1326 Builder.CreateStore(Val: CurPtr.emitRawPointer(CGF&: *this), Addr: EndOfInit);
1327
1328 // Enter a partial-destruction Cleanup if necessary.
1329 if (!pushedCleanup && needsEHCleanup(kind: DtorKind)) {
1330 llvm::Instruction *DominatingIP =
1331 Builder.CreateFlagLoad(Addr: llvm::ConstantInt::getNullValue(Ty: Int8PtrTy));
1332 pushRegularPartialArrayCleanup(arrayBegin: BeginPtr.emitRawPointer(CGF&: *this),
1333 arrayEnd: CurPtr.emitRawPointer(CGF&: *this), elementType: ElementType,
1334 elementAlignment: ElementAlign, destroyer: getDestroyer(destructionKind: DtorKind));
1335 DeferredDeactivationCleanupStack.push_back(
1336 Elt: {.Cleanup: EHStack.stable_begin(), .DominatingIP: DominatingIP});
1337 }
1338
1339 // Emit the initializer into this element.
1340 StoreAnyExprIntoOneUnit(CGF&: *this, Init, AllocType: Init->getType(), NewPtr: CurPtr,
1341 MayOverlap: AggValueSlot::DoesNotOverlap);
1342
1343 // Leave the Cleanup if we entered one.
1344 deactivation.ForceDeactivate();
1345
1346 // Advance to the next element by adjusting the pointer type as necessary.
1347 llvm::Value *NextPtr = Builder.CreateConstInBoundsGEP1_32(
1348 Ty: ElementTy, Ptr: CurPtr.emitRawPointer(CGF&: *this), Idx0: 1, Name: "array.next");
1349
1350 // Check whether we've gotten to the end of the array and, if so,
1351 // exit the loop.
1352 llvm::Value *IsEnd = Builder.CreateICmpEQ(LHS: NextPtr, RHS: EndPtr, Name: "array.atend");
1353 Builder.CreateCondBr(Cond: IsEnd, True: ContBB, False: LoopBB);
1354 CurPtrPhi->addIncoming(V: NextPtr, BB: Builder.GetInsertBlock());
1355
1356 EmitBlock(BB: ContBB);
1357}
1358
1359static void EmitNewInitializer(CodeGenFunction &CGF, const CXXNewExpr *E,
1360 QualType ElementType, llvm::Type *ElementTy,
1361 Address NewPtr, llvm::Value *NumElements,
1362 llvm::Value *AllocSizeWithoutCookie) {
1363 ApplyDebugLocation DL(CGF, E);
1364 if (E->isArray())
1365 CGF.EmitNewArrayInitializer(E, ElementType, ElementTy, BeginPtr: NewPtr, NumElements,
1366 AllocSizeWithoutCookie);
1367 else if (const Expr *Init = E->getInitializer())
1368 StoreAnyExprIntoOneUnit(CGF, Init, AllocType: E->getAllocatedType(), NewPtr,
1369 MayOverlap: AggValueSlot::DoesNotOverlap);
1370}
1371
1372/// Emit a call to an operator new or operator delete function, as implicitly
1373/// created by new-expressions and delete-expressions.
1374static RValue EmitNewDeleteCall(CodeGenFunction &CGF,
1375 const FunctionDecl *CalleeDecl,
1376 const FunctionProtoType *CalleeType,
1377 const CallArgList &Args,
1378 llvm::Constant *CalleeOverride = nullptr) {
1379 llvm::CallBase *CallOrInvoke;
1380 llvm::Constant *CalleePtr =
1381 CalleeOverride ? CalleeOverride : CGF.CGM.GetAddrOfFunction(GD: CalleeDecl);
1382 CGCallee Callee = CGCallee::forDirect(functionPtr: CalleePtr, abstractInfo: GlobalDecl(CalleeDecl));
1383 RValue RV = CGF.EmitCall(
1384 CallInfo: CGF.CGM.getTypes().arrangeFreeFunctionCall(
1385 Args, Ty: CalleeType, /*ChainCall=*/false, ABIInfoFD: CGF.getCurrentFunctionDecl()),
1386 Callee, ReturnValue: ReturnValueSlot(), Args, CallOrInvoke: &CallOrInvoke);
1387
1388 /// C++1y [expr.new]p10:
1389 /// [In a new-expression,] an implementation is allowed to omit a call
1390 /// to a replaceable global allocation function.
1391 ///
1392 /// We model such elidable calls with the 'builtin' attribute.
1393 llvm::Function *Fn = dyn_cast<llvm::Function>(Val: CalleePtr);
1394 UnsignedOrNone AlignArg = std::nullopt;
1395 if (CalleeDecl->isReplaceableGlobalAllocationFunction(AlignmentParam: &AlignArg)) {
1396 auto &Ctx = CallOrInvoke->getContext();
1397 llvm::AllocFnKind AK = llvm::AllocFnKind::Unknown;
1398 OverloadedOperatorKind Op = CalleeDecl->getOverloadedOperator();
1399 bool IsDeleter = Op == OO_Array_Delete || Op == OO_Delete;
1400 if (IsDeleter) {
1401 AK = AK | llvm::AllocFnKind::Free;
1402 } else {
1403 if (AlignArg)
1404 AK = llvm::AllocFnKind::Aligned;
1405 AK = AK | llvm::AllocFnKind::Alloc | llvm::AllocFnKind::Uninitialized;
1406 }
1407
1408 bool IsArray = Op == OO_Array_New || Op == OO_Array_Delete;
1409 StringRef Family;
1410 if (CGF.CGM.getTarget().getCXXABI().isMicrosoft()) {
1411 if (IsArray)
1412 Family =
1413 AlignArg ? "??_U@YAPAXIW4align_val_t@std@@@Z" : "??_U@YAPAXI@Z";
1414 else
1415 Family = AlignArg ? "??2@YAPAXIW4align_val_t@std@@@Z" : "??2@YAPAXI@Z";
1416 } else {
1417 assert(CGF.CGM.getTarget().getCXXABI().isItaniumFamily() &&
1418 "unknown C++ ABI when resolving alloc-family for operator "
1419 "new/delete");
1420 if (IsArray)
1421 Family = AlignArg ? "_ZnamSt11align_val_t" : "_Znam";
1422 else
1423 Family = AlignArg ? "_ZnwmSt11align_val_t" : "_Znwm";
1424 }
1425
1426 CallOrInvoke->addFnAttr(Attr: llvm::Attribute::get(Context&: Ctx, Kind: "alloc-family", Val: Family));
1427 if (Fn && Fn->hasFnAttribute(Kind: llvm::Attribute::NoBuiltin))
1428 CallOrInvoke->addFnAttr(Kind: llvm::Attribute::Builtin);
1429 CallOrInvoke->addFnAttr(Attr: llvm::Attribute::get(
1430 Context&: Ctx, Kind: llvm::Attribute::AllocKind, Val: static_cast<uint64_t>(AK)));
1431
1432 // A sane operator new does not read or write accessible memory.
1433 if (Fn && CGF.CGM.getCodeGenOpts().AssumeSaneOperatorNew &&
1434 CalleeDecl->getDeclName().isAnyOperatorNew()) {
1435 // FIXME: inaccessiblemem could cause issues if LTO makes the
1436 // previously inaccessible memory accessible after linking.
1437 CallOrInvoke->setMemoryEffects(
1438 llvm::MemoryEffects::inaccessibleOrErrnoMemOnly(
1439 InaccessibleMR: llvm::ModRefInfo::ModRef, ErrnoMR: llvm::ModRefInfo::Mod));
1440 }
1441 }
1442
1443 return RV;
1444}
1445
1446RValue CodeGenFunction::EmitBuiltinNewDeleteCall(const FunctionProtoType *Type,
1447 const CallExpr *TheCall,
1448 bool IsDelete) {
1449 CallArgList Args;
1450 EmitCallArgs(Args, Prototype: Type, ArgRange: TheCall->arguments());
1451 // Find the allocation or deallocation function that we're calling.
1452 ASTContext &Ctx = getContext();
1453 DeclarationName Name =
1454 Ctx.DeclarationNames.getCXXOperatorName(Op: IsDelete ? OO_Delete : OO_New);
1455
1456 for (auto *Decl : Ctx.getTranslationUnitDecl()->lookup(Name))
1457 if (auto *FD = dyn_cast<FunctionDecl>(Val: Decl))
1458 if (Ctx.hasSameType(T1: FD->getType(), T2: QualType(Type, 0))) {
1459 RValue RV = EmitNewDeleteCall(CGF&: *this, CalleeDecl: FD, CalleeType: Type, Args);
1460 if (auto *CB = dyn_cast_if_present<llvm::CallBase>(Val: RV.getScalarVal())) {
1461 if (SanOpts.has(K: SanitizerKind::AllocToken)) {
1462 // Set !alloc_token metadata.
1463 EmitAllocToken(CB, E: TheCall);
1464 }
1465 }
1466 return RV;
1467 }
1468 llvm_unreachable("predeclared global operator new/delete is missing");
1469}
1470
1471namespace {
1472/// A cleanup to call the given 'operator delete' function upon abnormal
1473/// exit from a new expression. Templated on a traits type that deals with
1474/// ensuring that the arguments dominate the cleanup if necessary.
1475template <typename Traits>
1476class CallDeleteDuringNew final : public EHScopeStack::Cleanup {
1477 /// Type used to hold llvm::Value*s.
1478 typedef typename Traits::ValueTy ValueTy;
1479 /// Type used to hold RValues.
1480 typedef typename Traits::RValueTy RValueTy;
1481 struct PlacementArg {
1482 RValueTy ArgValue;
1483 QualType ArgType;
1484 };
1485
1486 unsigned NumPlacementArgs : 30;
1487 LLVM_PREFERRED_TYPE(AlignedAllocationMode)
1488 unsigned PassAlignmentToPlacementDelete : 1;
1489 const FunctionDecl *OperatorDelete;
1490 RValueTy TypeIdentity;
1491 ValueTy Ptr;
1492 ValueTy AllocSize;
1493 CharUnits AllocAlign;
1494
1495 PlacementArg *getPlacementArgs() {
1496 return reinterpret_cast<PlacementArg *>(this + 1);
1497 }
1498
1499public:
1500 static size_t getExtraSize(size_t NumPlacementArgs) {
1501 return NumPlacementArgs * sizeof(PlacementArg);
1502 }
1503
1504 CallDeleteDuringNew(size_t NumPlacementArgs,
1505 const FunctionDecl *OperatorDelete, RValueTy TypeIdentity,
1506 ValueTy Ptr, ValueTy AllocSize,
1507 const ImplicitAllocationParameters &IAP,
1508 CharUnits AllocAlign)
1509 : NumPlacementArgs(NumPlacementArgs),
1510 PassAlignmentToPlacementDelete(isAlignedAllocation(Mode: IAP.PassAlignment)),
1511 OperatorDelete(OperatorDelete), TypeIdentity(TypeIdentity), Ptr(Ptr),
1512 AllocSize(AllocSize), AllocAlign(AllocAlign) {}
1513
1514 void setPlacementArg(unsigned I, RValueTy Arg, QualType Type) {
1515 assert(I < NumPlacementArgs && "index out of range");
1516 getPlacementArgs()[I] = {Arg, Type};
1517 }
1518
1519 void Emit(CodeGenFunction &CGF, Flags flags) override {
1520 const auto *FPT = OperatorDelete->getType()->castAs<FunctionProtoType>();
1521 CallArgList DeleteArgs;
1522 unsigned FirstNonTypeArg = 0;
1523 TypeAwareAllocationMode TypeAwareDeallocation = TypeAwareAllocationMode::No;
1524 if (OperatorDelete->isTypeAwareOperatorNewOrDelete()) {
1525 TypeAwareDeallocation = TypeAwareAllocationMode::Yes;
1526 QualType SpecializedTypeIdentity = FPT->getParamType(i: 0);
1527 ++FirstNonTypeArg;
1528 DeleteArgs.add(rvalue: Traits::get(CGF, TypeIdentity), type: SpecializedTypeIdentity);
1529 }
1530 // The first argument after type-identity parameter (if any) is always
1531 // a void* (or C* for a destroying operator delete for class type C).
1532 DeleteArgs.add(rvalue: Traits::get(CGF, Ptr), type: FPT->getParamType(i: FirstNonTypeArg));
1533
1534 // Figure out what other parameters we should be implicitly passing.
1535 UsualDeleteParams Params;
1536 if (NumPlacementArgs) {
1537 // A placement deallocation function is implicitly passed an alignment
1538 // if the placement allocation function was, but is never passed a size.
1539 Params.Alignment =
1540 alignedAllocationModeFromBool(IsAligned: PassAlignmentToPlacementDelete);
1541 Params.TypeAwareDelete = TypeAwareDeallocation;
1542 Params.Size = isTypeAwareAllocation(Mode: Params.TypeAwareDelete);
1543 } else {
1544 // For a non-placement new-expression, 'operator delete' can take a
1545 // size and/or an alignment if it has the right parameters.
1546 Params = OperatorDelete->getUsualDeleteParams();
1547 }
1548
1549 assert(!Params.DestroyingDelete &&
1550 "should not call destroying delete in a new-expression");
1551
1552 // The second argument can be a std::size_t (for non-placement delete).
1553 if (Params.Size)
1554 DeleteArgs.add(rvalue: Traits::get(CGF, AllocSize),
1555 type: CGF.getContext().getSizeType());
1556
1557 // The next (second or third) argument can be a std::align_val_t, which
1558 // is an enum whose underlying type is std::size_t.
1559 // FIXME: Use the right type as the parameter type. Note that in a call
1560 // to operator delete(size_t, ...), we may not have it available.
1561 if (isAlignedAllocation(Mode: Params.Alignment))
1562 DeleteArgs.add(rvalue: RValue::get(V: llvm::ConstantInt::get(
1563 Ty: CGF.SizeTy, V: AllocAlign.getQuantity())),
1564 type: CGF.getContext().getSizeType());
1565
1566 // Pass the rest of the arguments, which must match exactly.
1567 for (unsigned I = 0; I != NumPlacementArgs; ++I) {
1568 auto Arg = getPlacementArgs()[I];
1569 DeleteArgs.add(rvalue: Traits::get(CGF, Arg.ArgValue), type: Arg.ArgType);
1570 }
1571
1572 // Call 'operator delete'.
1573 EmitNewDeleteCall(CGF, CalleeDecl: OperatorDelete, CalleeType: FPT, Args: DeleteArgs);
1574 }
1575};
1576} // namespace
1577
1578/// Enter a cleanup to call 'operator delete' if the initializer in a
1579/// new-expression throws.
1580static void EnterNewDeleteCleanup(CodeGenFunction &CGF, const CXXNewExpr *E,
1581 RValue TypeIdentity, Address NewPtr,
1582 llvm::Value *AllocSize, CharUnits AllocAlign,
1583 const CallArgList &NewArgs) {
1584 unsigned NumNonPlacementArgs = E->getNumImplicitArgs();
1585
1586 // If we're not inside a conditional branch, then the cleanup will
1587 // dominate and we can do the easier (and more efficient) thing.
1588 if (!CGF.isInConditionalBranch()) {
1589 struct DirectCleanupTraits {
1590 typedef llvm::Value *ValueTy;
1591 typedef RValue RValueTy;
1592 static RValue get(CodeGenFunction &, ValueTy V) { return RValue::get(V); }
1593 static RValue get(CodeGenFunction &, RValueTy V) { return V; }
1594 };
1595
1596 typedef CallDeleteDuringNew<DirectCleanupTraits> DirectCleanup;
1597
1598 DirectCleanup *Cleanup = CGF.EHStack.pushCleanupWithExtra<DirectCleanup>(
1599 Kind: EHCleanup, N: E->getNumPlacementArgs(), A: E->getOperatorDelete(),
1600 A: TypeIdentity, A: NewPtr.emitRawPointer(CGF), A: AllocSize,
1601 A: E->implicitAllocationParameters(), A: AllocAlign);
1602 for (unsigned I = 0, N = E->getNumPlacementArgs(); I != N; ++I) {
1603 auto &Arg = NewArgs[I + NumNonPlacementArgs];
1604 Cleanup->setPlacementArg(I, Arg: Arg.getRValue(CGF), Type: Arg.Ty);
1605 }
1606
1607 return;
1608 }
1609
1610 // Otherwise, we need to save all this stuff.
1611 DominatingValue<RValue>::saved_type SavedNewPtr =
1612 DominatingValue<RValue>::save(CGF, value: RValue::get(Addr: NewPtr, CGF));
1613 DominatingValue<RValue>::saved_type SavedAllocSize =
1614 DominatingValue<RValue>::save(CGF, value: RValue::get(V: AllocSize));
1615 DominatingValue<RValue>::saved_type SavedTypeIdentity =
1616 DominatingValue<RValue>::save(CGF, value: TypeIdentity);
1617 struct ConditionalCleanupTraits {
1618 typedef DominatingValue<RValue>::saved_type ValueTy;
1619 typedef DominatingValue<RValue>::saved_type RValueTy;
1620 static RValue get(CodeGenFunction &CGF, ValueTy V) {
1621 return V.restore(CGF);
1622 }
1623 };
1624 typedef CallDeleteDuringNew<ConditionalCleanupTraits> ConditionalCleanup;
1625
1626 ConditionalCleanup *Cleanup =
1627 CGF.EHStack.pushCleanupWithExtra<ConditionalCleanup>(
1628 Kind: EHCleanup, N: E->getNumPlacementArgs(), A: E->getOperatorDelete(),
1629 A: SavedTypeIdentity, A: SavedNewPtr, A: SavedAllocSize,
1630 A: E->implicitAllocationParameters(), A: AllocAlign);
1631 for (unsigned I = 0, N = E->getNumPlacementArgs(); I != N; ++I) {
1632 auto &Arg = NewArgs[I + NumNonPlacementArgs];
1633 Cleanup->setPlacementArg(
1634 I, Arg: DominatingValue<RValue>::save(CGF, value: Arg.getRValue(CGF)), Type: Arg.Ty);
1635 }
1636
1637 CGF.initFullExprCleanup();
1638}
1639
1640llvm::Value *CodeGenFunction::EmitCXXNewExpr(const CXXNewExpr *E) {
1641 // The element type being allocated.
1642 QualType allocType = getContext().getBaseElementType(QT: E->getAllocatedType());
1643
1644 // 1. Build a call to the allocation function.
1645 FunctionDecl *allocator = E->getOperatorNew();
1646
1647 // If there is a brace-initializer or C++20 parenthesized initializer, cannot
1648 // allocate fewer elements than inits.
1649 unsigned minElements = 0;
1650 unsigned IndexOfAlignArg = 1;
1651 if (E->isArray() && E->hasInitializer()) {
1652 const Expr *Init = E->getInitializer();
1653 const InitListExpr *ILE = dyn_cast<InitListExpr>(Val: Init);
1654 const CXXParenListInitExpr *CPLIE = dyn_cast<CXXParenListInitExpr>(Val: Init);
1655 const Expr *IgnoreParen = Init->IgnoreParenImpCasts();
1656 if ((ILE && ILE->isStringLiteralInit()) ||
1657 isa<StringLiteral>(Val: IgnoreParen) || isa<ObjCEncodeExpr>(Val: IgnoreParen)) {
1658 minElements =
1659 cast<ConstantArrayType>(Val: Init->getType()->getAsArrayTypeUnsafe())
1660 ->getZExtSize();
1661 } else if (ILE || CPLIE) {
1662 minElements = ILE ? ILE->getNumInitsWithEmbedExpanded()
1663 : CPLIE->getInitExprs().size();
1664 }
1665 }
1666
1667 llvm::Value *numElements = nullptr;
1668 llvm::Value *allocSizeWithoutCookie = nullptr;
1669 llvm::Value *allocSize = EmitCXXNewAllocSize(
1670 CGF&: *this, e: E, minElements, numElements, sizeWithoutCookie&: allocSizeWithoutCookie);
1671 CharUnits allocAlign = getContext().getTypeAlignInChars(T: allocType);
1672
1673 // Emit the allocation call. If the allocator is a global placement
1674 // operator, just "inline" it directly.
1675 Address allocation = Address::invalid();
1676 CallArgList allocatorArgs;
1677 RValue TypeIdentityArg;
1678 if (allocator->isReservedGlobalPlacementOperator()) {
1679 assert(E->getNumPlacementArgs() == 1);
1680 const Expr *arg = *E->placement_arguments().begin();
1681
1682 LValueBaseInfo BaseInfo;
1683 allocation = EmitPointerWithAlignment(Addr: arg, BaseInfo: &BaseInfo);
1684
1685 // The pointer expression will, in many cases, be an opaque void*.
1686 // In these cases, discard the computed alignment and use the
1687 // formal alignment of the allocated type.
1688 if (BaseInfo.getAlignmentSource() != AlignmentSource::Decl)
1689 allocation.setAlignment(allocAlign);
1690
1691 // Set up allocatorArgs for the call to operator delete if it's not
1692 // the reserved global operator.
1693 if (E->getOperatorDelete() &&
1694 !E->getOperatorDelete()->isReservedGlobalPlacementOperator()) {
1695 allocatorArgs.add(rvalue: RValue::get(V: allocSize), type: getContext().getSizeType());
1696 allocatorArgs.add(rvalue: RValue::get(Addr: allocation, CGF&: *this), type: arg->getType());
1697 }
1698
1699 } else {
1700 const FunctionProtoType *allocatorType =
1701 allocator->getType()->castAs<FunctionProtoType>();
1702 ImplicitAllocationParameters IAP = E->implicitAllocationParameters();
1703 unsigned ParamsToSkip = 0;
1704 if (isTypeAwareAllocation(Mode: IAP.PassTypeIdentity)) {
1705 QualType SpecializedTypeIdentity = allocatorType->getParamType(i: 0);
1706 CXXScalarValueInitExpr TypeIdentityParam(SpecializedTypeIdentity, nullptr,
1707 SourceLocation());
1708 TypeIdentityArg = EmitAnyExprToTemp(E: &TypeIdentityParam);
1709 allocatorArgs.add(rvalue: TypeIdentityArg, type: SpecializedTypeIdentity);
1710 ++ParamsToSkip;
1711 ++IndexOfAlignArg;
1712 }
1713 // The allocation size is the first argument.
1714 QualType sizeType = getContext().getSizeType();
1715 allocatorArgs.add(rvalue: RValue::get(V: allocSize), type: sizeType);
1716 ++ParamsToSkip;
1717
1718 if (allocSize != allocSizeWithoutCookie) {
1719 CharUnits cookieAlign = getSizeAlign(); // FIXME: Ask the ABI.
1720 allocAlign = std::max(a: allocAlign, b: cookieAlign);
1721 }
1722
1723 // The allocation alignment may be passed as the second argument.
1724 if (isAlignedAllocation(Mode: IAP.PassAlignment)) {
1725 QualType AlignValT = sizeType;
1726 if (allocatorType->getNumParams() > IndexOfAlignArg) {
1727 AlignValT = allocatorType->getParamType(i: IndexOfAlignArg);
1728 assert(getContext().hasSameUnqualifiedType(
1729 AlignValT->castAsEnumDecl()->getIntegerType(), sizeType) &&
1730 "wrong type for alignment parameter");
1731 ++ParamsToSkip;
1732 } else {
1733 // Corner case, passing alignment to 'operator new(size_t, ...)'.
1734 assert(allocator->isVariadic() && "can't pass alignment to allocator");
1735 }
1736 allocatorArgs.add(
1737 rvalue: RValue::get(V: llvm::ConstantInt::get(Ty: SizeTy, V: allocAlign.getQuantity())),
1738 type: AlignValT);
1739 }
1740
1741 // FIXME: Why do we not pass a CalleeDecl here?
1742 EmitCallArgs(Args&: allocatorArgs, Prototype: allocatorType, ArgRange: E->placement_arguments(),
1743 /*AC*/ AbstractCallee(), /*ParamsToSkip*/ ParamsToSkip);
1744
1745 RValue RV =
1746 EmitNewDeleteCall(CGF&: *this, CalleeDecl: allocator, CalleeType: allocatorType, Args: allocatorArgs);
1747
1748 if (auto *newCall = dyn_cast<llvm::CallBase>(Val: RV.getScalarVal())) {
1749 if (auto *CGDI = getDebugInfo()) {
1750 // Set !heapallocsite metadata on the call to operator new.
1751 CGDI->addHeapAllocSiteMetadata(CallSite: newCall, AllocatedTy: allocType, Loc: E->getExprLoc());
1752 }
1753 if (SanOpts.has(K: SanitizerKind::AllocToken)) {
1754 // Set !alloc_token metadata.
1755 EmitAllocToken(CB: newCall, AllocType: allocType);
1756 }
1757 }
1758
1759 // If this was a call to a global replaceable allocation function that does
1760 // not take an alignment argument, the allocator is known to produce
1761 // storage that's suitably aligned for any object that fits, up to a known
1762 // threshold. Otherwise assume it's suitably aligned for the allocated type.
1763 CharUnits allocationAlign = allocAlign;
1764 if (!E->passAlignment() &&
1765 allocator->isReplaceableGlobalAllocationFunction()) {
1766 unsigned AllocatorAlign = llvm::bit_floor(Value: std::min<uint64_t>(
1767 a: Target.getNewAlign(), b: getContext().getTypeSize(T: allocType)));
1768 allocationAlign = std::max(
1769 a: allocationAlign, b: getContext().toCharUnitsFromBits(BitSize: AllocatorAlign));
1770 }
1771
1772 allocation = Address(RV.getScalarVal(), Int8Ty, allocationAlign);
1773 }
1774
1775 // Emit a null check on the allocation result if the allocation
1776 // function is allowed to return null (because it has a non-throwing
1777 // exception spec or is the reserved placement new) and we have an
1778 // interesting initializer will be running sanitizers on the initialization.
1779 bool nullCheck = E->shouldNullCheckAllocation() &&
1780 (!allocType.isPODType(Context: getContext()) || E->hasInitializer() ||
1781 sanitizePerformTypeCheck());
1782
1783 llvm::BasicBlock *nullCheckBB = nullptr;
1784 llvm::BasicBlock *contBB = nullptr;
1785
1786 // The null-check means that the initializer is conditionally
1787 // evaluated.
1788 ConditionalEvaluation conditional(*this);
1789
1790 if (nullCheck) {
1791 conditional.begin(CGF&: *this);
1792
1793 nullCheckBB = Builder.GetInsertBlock();
1794 llvm::BasicBlock *notNullBB = createBasicBlock(name: "new.notnull");
1795 contBB = createBasicBlock(name: "new.cont");
1796
1797 llvm::Value *isNull = Builder.CreateIsNull(Addr: allocation, Name: "new.isnull");
1798 Builder.CreateCondBr(Cond: isNull, True: contBB, False: notNullBB);
1799 EmitBlock(BB: notNullBB);
1800 }
1801
1802 // If there's an operator delete, enter a cleanup to call it if an
1803 // exception is thrown.
1804 EHScopeStack::stable_iterator operatorDeleteCleanup;
1805 llvm::Instruction *cleanupDominator = nullptr;
1806 if (E->getOperatorDelete() &&
1807 !E->getOperatorDelete()->isReservedGlobalPlacementOperator()) {
1808 // A potentially-throwing constructor inside __try requires C++ object
1809 // unwinding, which is incompatible with SEH.
1810 if (getLangOpts().CXXExceptions && currentFunctionUsesSEHTry()) {
1811 if (const auto *ConstructExpr = E->getConstructExpr()) {
1812 const auto *FPT = ConstructExpr->getConstructor()
1813 ->getType()
1814 ->castAs<FunctionProtoType>();
1815 if (!FPT->isNothrow())
1816 getContext().getDiagnostics().Report(Loc: E->getBeginLoc(),
1817 DiagID: diag::err_seh_object_unwinding);
1818 }
1819 }
1820 EnterNewDeleteCleanup(CGF&: *this, E, TypeIdentity: TypeIdentityArg, NewPtr: allocation, AllocSize: allocSize,
1821 AllocAlign: allocAlign, NewArgs: allocatorArgs);
1822 operatorDeleteCleanup = EHStack.stable_begin();
1823 cleanupDominator =
1824 Builder.CreateFlagLoad(Addr: llvm::Constant::getNullValue(Ty: Int8PtrTy));
1825 }
1826
1827 // Without a cookie the two sizes must match. With a cookie they usually
1828 // differ, but on overflow the allocation size is all-ones, which can
1829 // coincide with the size without the cookie.
1830 assert(allocSize == llvm::Constant::getAllOnesValue(SizeTy) ||
1831 ((allocSize == allocSizeWithoutCookie) ==
1832 CalculateCookiePadding(*this, E).isZero()));
1833 if (allocSize != allocSizeWithoutCookie) {
1834 assert(E->isArray());
1835 allocation = CGM.getCXXABI().InitializeArrayCookie(
1836 CGF&: *this, NewPtr: allocation, NumElements: numElements, expr: E, ElementType: allocType);
1837 }
1838
1839 llvm::Type *elementTy = ConvertTypeForMem(T: allocType);
1840 Address result = allocation.withElementType(ElemTy: elementTy);
1841
1842 // Passing pointer through launder.invariant.group to avoid propagation of
1843 // vptrs information which may be included in previous type.
1844 // To not break LTO with different optimizations levels, we do it regardless
1845 // of optimization level.
1846 if (CGM.getCodeGenOpts().StrictVTablePointers &&
1847 allocator->isReservedGlobalPlacementOperator())
1848 result = Builder.CreateLaunderInvariantGroup(Addr: result);
1849
1850 // Emit sanitizer checks for pointer value now, so that in the case of an
1851 // array it was checked only once and not at each constructor call. We may
1852 // have already checked that the pointer is non-null.
1853 // FIXME: If we have an array cookie and a potentially-throwing allocator,
1854 // we'll null check the wrong pointer here.
1855 SanitizerSet SkippedChecks;
1856 SkippedChecks.set(K: SanitizerKind::Null, Value: nullCheck);
1857 EmitTypeCheck(TCK: CodeGenFunction::TCK_ConstructorCall,
1858 Loc: E->getAllocatedTypeSourceInfo()->getTypeLoc().getBeginLoc(),
1859 Addr: result, Type: allocType, Alignment: result.getAlignment(), SkippedChecks,
1860 ArraySize: numElements);
1861
1862 EmitNewInitializer(CGF&: *this, E, ElementType: allocType, ElementTy: elementTy, NewPtr: result, NumElements: numElements,
1863 AllocSizeWithoutCookie: allocSizeWithoutCookie);
1864 llvm::Value *resultPtr = result.emitRawPointer(CGF&: *this);
1865
1866 // Deactivate the 'operator delete' cleanup if we finished
1867 // initialization.
1868 if (operatorDeleteCleanup.isValid()) {
1869 DeactivateCleanupBlock(Cleanup: operatorDeleteCleanup, DominatingIP: cleanupDominator);
1870 cleanupDominator->eraseFromParent();
1871 }
1872
1873 if (nullCheck) {
1874 conditional.end(CGF&: *this);
1875
1876 llvm::BasicBlock *notNullBB = Builder.GetInsertBlock();
1877 EmitBlock(BB: contBB);
1878
1879 llvm::PHINode *PHI = Builder.CreatePHI(Ty: resultPtr->getType(), NumReservedValues: 2);
1880 PHI->addIncoming(V: resultPtr, BB: notNullBB);
1881 PHI->addIncoming(V: llvm::Constant::getNullValue(Ty: resultPtr->getType()),
1882 BB: nullCheckBB);
1883
1884 resultPtr = PHI;
1885 }
1886
1887 return resultPtr;
1888}
1889
1890void CodeGenFunction::EmitDeleteCall(const FunctionDecl *DeleteFD,
1891 llvm::Value *DeletePtr, QualType DeleteTy,
1892 llvm::Value *NumElements,
1893 CharUnits CookieSize,
1894 llvm::Constant *CalleeOverride) {
1895 assert((!NumElements && CookieSize.isZero()) ||
1896 DeleteFD->getOverloadedOperator() == OO_Array_Delete);
1897
1898 const auto *DeleteFTy = DeleteFD->getType()->castAs<FunctionProtoType>();
1899 CallArgList DeleteArgs;
1900
1901 auto Params = DeleteFD->getUsualDeleteParams();
1902 auto ParamTypeIt = DeleteFTy->param_type_begin();
1903
1904 std::optional<llvm::AllocaInst *> TagAlloca;
1905 auto EmitTag = [&](QualType TagType, const char *TagName) {
1906 assert(!TagAlloca);
1907 llvm::Type *Ty = getTypes().ConvertType(T: TagType);
1908 CharUnits Align = CGM.getNaturalTypeAlignment(T: TagType);
1909 llvm::AllocaInst *TagAllocation = CreateTempAlloca(Ty, Name: TagName);
1910 TagAllocation->setAlignment(Align.getAsAlign());
1911 DeleteArgs.add(rvalue: RValue::getAggregate(addr: Address(TagAllocation, Ty, Align)),
1912 type: TagType);
1913 TagAlloca = TagAllocation;
1914 };
1915
1916 // Pass std::type_identity tag if present
1917 if (isTypeAwareAllocation(Mode: Params.TypeAwareDelete))
1918 EmitTag(*ParamTypeIt++, "typeaware.delete.tag");
1919
1920 // Pass the pointer itself.
1921 QualType ArgTy = *ParamTypeIt++;
1922 DeleteArgs.add(rvalue: RValue::get(V: DeletePtr), type: ArgTy);
1923
1924 // Pass the std::destroying_delete tag if present.
1925 if (Params.DestroyingDelete)
1926 EmitTag(*ParamTypeIt++, "destroying.delete.tag");
1927
1928 // Pass the size if the delete function has a size_t parameter.
1929 if (Params.Size) {
1930 QualType SizeType = *ParamTypeIt++;
1931 CharUnits DeleteTypeSize = getContext().getTypeSizeInChars(T: DeleteTy);
1932 llvm::Value *Size = llvm::ConstantInt::get(Ty: ConvertType(T: SizeType),
1933 V: DeleteTypeSize.getQuantity());
1934
1935 // For array new, multiply by the number of elements.
1936 if (NumElements)
1937 Size = Builder.CreateMul(LHS: Size, RHS: NumElements);
1938
1939 // If there is a cookie, add the cookie size.
1940 if (!CookieSize.isZero())
1941 Size = Builder.CreateAdd(
1942 LHS: Size, RHS: llvm::ConstantInt::get(Ty: SizeTy, V: CookieSize.getQuantity()));
1943
1944 DeleteArgs.add(rvalue: RValue::get(V: Size), type: SizeType);
1945 }
1946
1947 // Pass the alignment if the delete function has an align_val_t parameter.
1948 if (isAlignedAllocation(Mode: Params.Alignment)) {
1949 QualType AlignValType = *ParamTypeIt++;
1950 CharUnits DeleteTypeAlign =
1951 getContext().toCharUnitsFromBits(BitSize: getContext().getTypeAlignIfKnown(
1952 T: DeleteTy, NeedsPreferredAlignment: true /* NeedsPreferredAlignment */));
1953 llvm::Value *Align = llvm::ConstantInt::get(Ty: ConvertType(T: AlignValType),
1954 V: DeleteTypeAlign.getQuantity());
1955 DeleteArgs.add(rvalue: RValue::get(V: Align), type: AlignValType);
1956 }
1957
1958 assert(ParamTypeIt == DeleteFTy->param_type_end() &&
1959 "unknown parameter to usual delete function");
1960
1961 // Emit the call to delete.
1962 EmitNewDeleteCall(CGF&: *this, CalleeDecl: DeleteFD, CalleeType: DeleteFTy, Args: DeleteArgs, CalleeOverride);
1963
1964 // If call argument lowering didn't use a generated tag argument alloca we
1965 // remove them
1966 if (TagAlloca && (*TagAlloca)->use_empty())
1967 (*TagAlloca)->eraseFromParent();
1968}
1969namespace {
1970/// Calls the given 'operator delete' on a single object.
1971struct CallObjectDelete final : EHScopeStack::Cleanup {
1972 llvm::Value *Ptr;
1973 const FunctionDecl *OperatorDelete;
1974 QualType ElementType;
1975
1976 CallObjectDelete(llvm::Value *Ptr, const FunctionDecl *OperatorDelete,
1977 QualType ElementType)
1978 : Ptr(Ptr), OperatorDelete(OperatorDelete), ElementType(ElementType) {}
1979
1980 void Emit(CodeGenFunction &CGF, Flags flags) override {
1981 CGF.EmitDeleteCall(DeleteFD: OperatorDelete, DeletePtr: Ptr, DeleteTy: ElementType);
1982 }
1983};
1984} // namespace
1985
1986void CodeGenFunction::pushCallObjectDeleteCleanup(
1987 const FunctionDecl *OperatorDelete, llvm::Value *CompletePtr,
1988 QualType ElementType) {
1989 EHStack.pushCleanup<CallObjectDelete>(Kind: NormalAndEHCleanup, A: CompletePtr,
1990 A: OperatorDelete, A: ElementType);
1991}
1992
1993/// Emit the code for deleting a single object with a destroying operator
1994/// delete. If the element type has a non-virtual destructor, Ptr has already
1995/// been converted to the type of the parameter of 'operator delete'. Otherwise
1996/// Ptr points to an object of the static type.
1997static void EmitDestroyingObjectDelete(CodeGenFunction &CGF,
1998 const CXXDeleteExpr *DE, Address Ptr,
1999 QualType ElementType) {
2000 auto *Dtor = ElementType->getAsCXXRecordDecl()->getDestructor();
2001 if (Dtor && Dtor->isVirtual())
2002 CGF.CGM.getCXXABI().emitVirtualObjectDelete(CGF, DE, Ptr, ElementType,
2003 Dtor);
2004 else
2005 CGF.EmitDeleteCall(DeleteFD: DE->getOperatorDelete(), DeletePtr: Ptr.emitRawPointer(CGF),
2006 DeleteTy: ElementType);
2007}
2008
2009static CXXDestructorDecl *TryDevirtualizeDtorCall(const CXXDeleteExpr *E,
2010 CXXDestructorDecl *Dtor,
2011 const LangOptions &LO) {
2012 assert(Dtor && Dtor->isVirtual() && "virtual dtor is expected");
2013 const Expr *DBase = E->getArgument();
2014 if (auto *MaybeDevirtualizedDtor = dyn_cast_or_null<CXXDestructorDecl>(
2015 Val: Dtor->getDevirtualizedMethod(Base: DBase, IsAppleKext: LO.AppleKext))) {
2016 const CXXRecordDecl *DevirtualizedClass =
2017 MaybeDevirtualizedDtor->getParent();
2018 if (declaresSameEntity(D1: getCXXRecord(E: DBase), D2: DevirtualizedClass)) {
2019 // Devirtualized to the class of the base type (the type of the
2020 // whole expression).
2021 return MaybeDevirtualizedDtor;
2022 }
2023 // Devirtualized to some other type. Would need to cast the this
2024 // pointer to that type but we don't have support for that yet, so
2025 // do a virtual call. FIXME: handle the case where it is
2026 // devirtualized to the derived type (the type of the inner
2027 // expression) as in EmitCXXMemberOrOperatorMemberCallExpr.
2028 }
2029 return nullptr;
2030}
2031
2032/// Emit the code for deleting a single object.
2033/// \return \c true if we started emitting UnconditionalDeleteBlock, \c false
2034/// if not.
2035static bool EmitObjectDelete(CodeGenFunction &CGF, const CXXDeleteExpr *DE,
2036 Address Ptr, QualType ElementType,
2037 llvm::BasicBlock *UnconditionalDeleteBlock) {
2038 // C++11 [expr.delete]p3:
2039 // If the static type of the object to be deleted is different from its
2040 // dynamic type, the static type shall be a base class of the dynamic type
2041 // of the object to be deleted and the static type shall have a virtual
2042 // destructor or the behavior is undefined.
2043 CGF.EmitTypeCheck(TCK: CodeGenFunction::TCK_MemberCall, Loc: DE->getExprLoc(), Addr: Ptr,
2044 Type: ElementType);
2045
2046 const FunctionDecl *OperatorDelete = DE->getOperatorDelete();
2047 assert(!OperatorDelete->isDestroyingOperatorDelete());
2048
2049 // Find the destructor for the type, if applicable. If the
2050 // destructor is virtual, we'll just emit the vcall and return.
2051 CXXDestructorDecl *Dtor = nullptr;
2052 if (const auto *RD = ElementType->getAsCXXRecordDecl()) {
2053 if (RD->hasDefinition() && !RD->hasTrivialDestructor()) {
2054 Dtor = RD->getDestructor();
2055
2056 if (Dtor->isVirtual()) {
2057 if (auto *DevirtualizedDtor =
2058 TryDevirtualizeDtorCall(E: DE, Dtor, LO: CGF.CGM.getLangOpts())) {
2059 Dtor = DevirtualizedDtor;
2060 } else {
2061 CGF.CGM.getCXXABI().emitVirtualObjectDelete(CGF, DE, Ptr, ElementType,
2062 Dtor);
2063 return false;
2064 }
2065 }
2066 }
2067 }
2068
2069 // Make sure that we call delete even if the dtor throws.
2070 // This doesn't have to a conditional cleanup because we're going
2071 // to pop it off in a second.
2072 CGF.EHStack.pushCleanup<CallObjectDelete>(
2073 Kind: NormalAndEHCleanup, A: Ptr.emitRawPointer(CGF), A: OperatorDelete, A: ElementType);
2074
2075 if (Dtor)
2076 CGF.EmitCXXDestructorCall(D: Dtor, Type: Dtor_Complete,
2077 /*ForVirtualBase=*/false,
2078 /*Delegating=*/false, This: Ptr, ThisTy: ElementType);
2079 else if (auto Lifetime = ElementType.getObjCLifetime()) {
2080 switch (Lifetime) {
2081 case Qualifiers::OCL_None:
2082 case Qualifiers::OCL_ExplicitNone:
2083 case Qualifiers::OCL_Autoreleasing:
2084 break;
2085
2086 case Qualifiers::OCL_Strong:
2087 CGF.EmitARCDestroyStrong(addr: Ptr, precise: ARCPreciseLifetime);
2088 break;
2089
2090 case Qualifiers::OCL_Weak:
2091 CGF.EmitARCDestroyWeak(addr: Ptr);
2092 break;
2093 }
2094 }
2095
2096 // When optimizing for size, call 'operator delete' unconditionally.
2097 if (CGF.CGM.getCodeGenOpts().OptimizeSize > 1) {
2098 CGF.EmitBlock(BB: UnconditionalDeleteBlock);
2099 CGF.PopCleanupBlock();
2100 return true;
2101 }
2102
2103 CGF.PopCleanupBlock();
2104 return false;
2105}
2106
2107namespace {
2108/// Calls the given 'operator delete' on an array of objects.
2109struct CallArrayDelete final : EHScopeStack::Cleanup {
2110 llvm::Value *Ptr;
2111 const FunctionDecl *OperatorDelete;
2112 llvm::Value *NumElements;
2113 QualType ElementType;
2114 CharUnits CookieSize;
2115
2116 CallArrayDelete(llvm::Value *Ptr, const FunctionDecl *OperatorDelete,
2117 llvm::Value *NumElements, QualType ElementType,
2118 CharUnits CookieSize)
2119 : Ptr(Ptr), OperatorDelete(OperatorDelete), NumElements(NumElements),
2120 ElementType(ElementType), CookieSize(CookieSize) {}
2121
2122 void Emit(CodeGenFunction &CGF, Flags flags) override {
2123 CGF.EmitDeleteCall(DeleteFD: OperatorDelete, DeletePtr: Ptr, DeleteTy: ElementType, NumElements,
2124 CookieSize);
2125 }
2126};
2127} // namespace
2128
2129/// Emit the code for deleting an array of objects.
2130static void EmitArrayDelete(CodeGenFunction &CGF, const CXXDeleteExpr *E,
2131 Address deletedPtr, QualType elementType) {
2132 llvm::Value *numElements = nullptr;
2133 llvm::Value *allocatedPtr = nullptr;
2134 CharUnits cookieSize;
2135 CGF.CGM.getCXXABI().ReadArrayCookie(CGF, Ptr: deletedPtr, expr: E, ElementType: elementType,
2136 NumElements&: numElements, AllocPtr&: allocatedPtr, CookieSize&: cookieSize);
2137
2138 assert(allocatedPtr && "ReadArrayCookie didn't set allocated pointer");
2139
2140 // Make sure that we call delete even if one of the dtors throws.
2141 const FunctionDecl *operatorDelete = E->getOperatorDelete();
2142 CGF.EHStack.pushCleanup<CallArrayDelete>(Kind: NormalAndEHCleanup, A: allocatedPtr,
2143 A: operatorDelete, A: numElements,
2144 A: elementType, A: cookieSize);
2145
2146 // Destroy the elements.
2147 if (QualType::DestructionKind dtorKind = elementType.isDestructedType()) {
2148 assert(numElements && "no element count for a type with a destructor!");
2149
2150 CharUnits elementSize = CGF.getContext().getTypeSizeInChars(T: elementType);
2151 CharUnits elementAlign =
2152 deletedPtr.getAlignment().alignmentOfArrayElement(elementSize);
2153
2154 llvm::Value *arrayBegin = deletedPtr.emitRawPointer(CGF);
2155 llvm::Value *arrayEnd = CGF.Builder.CreateInBoundsGEP(
2156 Ty: deletedPtr.getElementType(), Ptr: arrayBegin, IdxList: numElements, Name: "delete.end");
2157
2158 // Note that it is legal to allocate a zero-length array, and we
2159 // can never fold the check away because the length should always
2160 // come from a cookie.
2161 CGF.emitArrayDestroy(begin: arrayBegin, end: arrayEnd, elementType, elementAlign,
2162 destroyer: CGF.getDestroyer(destructionKind: dtorKind),
2163 /*checkZeroLength*/ true,
2164 useEHCleanup: CGF.needsEHCleanup(kind: dtorKind));
2165 }
2166
2167 // Pop the cleanup block.
2168 CGF.PopCleanupBlock();
2169}
2170
2171void CodeGenFunction::EmitCXXDeleteExpr(const CXXDeleteExpr *E) {
2172 const Expr *Arg = E->getArgument();
2173 Address Ptr = EmitPointerWithAlignment(Addr: Arg);
2174
2175 // If this is a ::delete expression (explicit global scope) on a class type
2176 // with a non-trivial destructor, note it so we emit __global_delete
2177 // forwarding bodies. This matches MSVC which only engages the __global_delete
2178 // machinery when a deleting destructor is involved:
2179 // - a plain `delete`/`delete[]` (no `::`) never triggers it, even when it
2180 // resolves to a global operator delete;
2181 // - `::delete` on a non-class type (e.g. `::delete intPtr`) or on a class
2182 // with a trivial destructor is lowered as a plain direct operator delete
2183 // and does not trigger it;
2184 // - the destructor's virtualness and the presence of a class-level
2185 // operator delete are both irrelevant to the trigger.
2186 if (E->isGlobalDelete() && CGM.getTarget().getCXXABI().isMicrosoft()) {
2187 const CXXRecordDecl *RD = E->getDestroyedType()->getAsCXXRecordDecl();
2188 if (RD && RD->hasDefinition() && !RD->hasTrivialDestructor()) {
2189 CGM.noteDirectGlobalDelete();
2190 // Ensure a __global_delete wrapper (and thus a strong forwarding body)
2191 // is emitted in THIS TU for the resolved global ::operator delete, even
2192 // when no vector deleting destructor here references it. Without this, a
2193 // TU that only does ::delete (with the deleting destructor defined in
2194 // another TU) would emit no forwarder, leaving the wrapper bound to the
2195 // trapping empty fallback and crashing at runtime.
2196 const FunctionDecl *OD = E->getOperatorDelete();
2197 assert(!isa<CXXMethodDecl>(OD) &&
2198 "global ::delete should resolve to a namespace-scope "
2199 "operator delete");
2200 CGM.getOrCreateMSVCGlobalDeleteWrapper(GlobOD: OD);
2201 }
2202 }
2203
2204 // Null check the pointer.
2205 //
2206 // We could avoid this null check if we can determine that the object
2207 // destruction is trivial and doesn't require an array cookie; we can
2208 // unconditionally perform the operator delete call in that case. For now, we
2209 // assume that deleted pointers are null rarely enough that it's better to
2210 // keep the branch. This might be worth revisiting for a -O0 code size win.
2211 llvm::BasicBlock *DeleteNotNull = createBasicBlock(name: "delete.notnull");
2212 llvm::BasicBlock *DeleteEnd = createBasicBlock(name: "delete.end");
2213
2214 llvm::Value *IsNull = Builder.CreateIsNull(Addr: Ptr, Name: "isnull");
2215
2216 Builder.CreateCondBr(Cond: IsNull, True: DeleteEnd, False: DeleteNotNull);
2217 EmitBlock(BB: DeleteNotNull);
2218 Ptr.setKnownNonNull();
2219
2220 QualType DeleteTy = E->getDestroyedType();
2221
2222 // A destroying operator delete overrides the entire operation of the
2223 // delete expression.
2224 if (E->getOperatorDelete()->isDestroyingOperatorDelete()) {
2225 EmitDestroyingObjectDelete(CGF&: *this, DE: E, Ptr, ElementType: DeleteTy);
2226 EmitBlock(BB: DeleteEnd);
2227 return;
2228 }
2229
2230 // We might be deleting a pointer to array.
2231 DeleteTy = getContext().getBaseElementType(QT: DeleteTy);
2232 Ptr = Ptr.withElementType(ElemTy: ConvertTypeForMem(T: DeleteTy));
2233
2234 if (E->isArrayForm() &&
2235 CGM.getContext().getTargetInfo().emitVectorDeletingDtors(
2236 CGM.getContext().getLangOpts())) {
2237 if (auto *RD = DeleteTy->getAsCXXRecordDecl()) {
2238 auto *Dtor = RD->getDestructor();
2239 if (Dtor && Dtor->isVirtual()) {
2240 // Emit normal loop over the array elements if we can easily
2241 // devirtualize destructor call.
2242 // Emit virtual call to vector deleting destructor otherwise.
2243 if (!TryDevirtualizeDtorCall(E, Dtor, LO: CGM.getLangOpts())) {
2244 llvm::Value *NumElements = nullptr;
2245 llvm::Value *AllocatedPtr = nullptr;
2246 CharUnits CookieSize;
2247 llvm::BasicBlock *BodyBB = createBasicBlock(name: "vdtor.call");
2248 llvm::BasicBlock *DoneBB = createBasicBlock(name: "vdtor.nocall");
2249 // Check array cookie to see if the array has length 0. Don't call
2250 // the destructor in that case.
2251 CGM.getCXXABI().ReadArrayCookie(CGF&: *this, Ptr, expr: E, ElementType: DeleteTy, NumElements,
2252 AllocPtr&: AllocatedPtr, CookieSize);
2253
2254 auto *CondTy = cast<llvm::IntegerType>(Val: NumElements->getType());
2255 llvm::Value *IsEmpty = Builder.CreateICmpEQ(
2256 LHS: NumElements, RHS: llvm::ConstantInt::get(Ty: CondTy, V: 0));
2257 Builder.CreateCondBr(Cond: IsEmpty, True: DoneBB, False: BodyBB);
2258
2259 // Delete cookie for empty array.
2260 const FunctionDecl *OperatorDelete = E->getOperatorDelete();
2261 EmitBlock(BB: DoneBB);
2262 EmitDeleteCall(DeleteFD: OperatorDelete, DeletePtr: AllocatedPtr, DeleteTy, NumElements,
2263 CookieSize);
2264 EmitBranch(Block: DeleteEnd);
2265
2266 EmitBlock(BB: BodyBB);
2267 CGM.getCXXABI().emitVirtualObjectDelete(CGF&: *this, DE: E, Ptr, ElementType: DeleteTy,
2268 Dtor);
2269 EmitBlock(BB: DeleteEnd);
2270 return;
2271 }
2272 }
2273 }
2274 }
2275
2276 if (E->isArrayForm()) {
2277 EmitArrayDelete(CGF&: *this, E, deletedPtr: Ptr, elementType: DeleteTy);
2278 EmitBlock(BB: DeleteEnd);
2279 } else {
2280 if (!EmitObjectDelete(CGF&: *this, DE: E, Ptr, ElementType: DeleteTy, UnconditionalDeleteBlock: DeleteEnd))
2281 EmitBlock(BB: DeleteEnd);
2282 }
2283}
2284
2285static Address EmitTypeidOperand(CodeGenFunction &CGF, const Expr *E,
2286 bool HasNullCheck) {
2287 // Get the vtable pointer.
2288 Address ThisPtr = CGF.EmitLValue(E).getAddress();
2289
2290 QualType SrcRecordTy = E->getType();
2291
2292 // C++ [class.cdtor]p4:
2293 // If the operand of typeid refers to the object under construction or
2294 // destruction and the static type of the operand is neither the constructor
2295 // or destructor’s class nor one of its bases, the behavior is undefined.
2296 CGF.EmitTypeCheck(TCK: CodeGenFunction::TCK_DynamicOperation, Loc: E->getExprLoc(),
2297 Addr: ThisPtr, Type: SrcRecordTy);
2298
2299 // Whether we need an explicit null pointer check. For example, with the
2300 // Microsoft ABI, if this is a call to __RTtypeid, the null pointer check and
2301 // exception throw is inside the __RTtypeid(nullptr) call
2302 if (HasNullCheck &&
2303 CGF.CGM.getCXXABI().shouldTypeidBeNullChecked(SrcRecordTy)) {
2304 llvm::BasicBlock *BadTypeidBlock =
2305 CGF.createBasicBlock(name: "typeid.bad_typeid");
2306 llvm::BasicBlock *EndBlock = CGF.createBasicBlock(name: "typeid.end");
2307
2308 llvm::Value *IsNull = CGF.Builder.CreateIsNull(Addr: ThisPtr);
2309 CGF.Builder.CreateCondBr(Cond: IsNull, True: BadTypeidBlock, False: EndBlock);
2310
2311 CGF.EmitBlock(BB: BadTypeidBlock);
2312 CGF.CGM.getCXXABI().EmitBadTypeidCall(CGF);
2313 CGF.EmitBlock(BB: EndBlock);
2314 }
2315
2316 return ThisPtr;
2317}
2318
2319llvm::Value *CodeGenFunction::EmitCXXTypeidExpr(const CXXTypeidExpr *E) {
2320 // Ideally, we would like to use GlobalsInt8PtrTy here, however, we cannot,
2321 // primarily because the result of applying typeid is a value of type
2322 // type_info, which is declared & defined by the standard library
2323 // implementation and expects to operate on the generic (default) AS.
2324 // https://reviews.llvm.org/D157452 has more context, and a possible solution.
2325 llvm::Type *PtrTy = Int8PtrTy;
2326 LangAS GlobAS = CGM.GetGlobalVarAddressSpace(D: nullptr);
2327
2328 auto MaybeASCast = [=](llvm::Constant *TypeInfo) {
2329 if (GlobAS == LangAS::Default)
2330 return TypeInfo;
2331 return CGM.performAddrSpaceCast(Src: TypeInfo, DestTy: PtrTy);
2332 };
2333
2334 if (E->isTypeOperand()) {
2335 llvm::Constant *TypeInfo =
2336 CGM.GetAddrOfRTTIDescriptor(Ty: E->getTypeOperand(Context: getContext()));
2337 return MaybeASCast(TypeInfo);
2338 }
2339
2340 const Expr *Operand = E->getExprOperand();
2341 QualType OperandTy = Operand->getType();
2342
2343 // C++ [expr.typeid]p2:
2344 // When typeid is applied to a glvalue expression whose type is a
2345 // polymorphic class type, the result refers to a std::type_info object
2346 // representing the type of the most derived object (that is, the dynamic
2347 // type) to which the glvalue refers.
2348 if (E->isPotentiallyEvaluated()) {
2349 Address ThisPtr = EmitTypeidOperand(CGF&: *this, E: Operand, HasNullCheck: E->hasNullCheck());
2350 if (!E->isMostDerived(Context: getContext()))
2351 return CGM.getCXXABI().EmitTypeid(CGF&: *this, SrcRecordTy: OperandTy, ThisPtr, StdTypeInfoPtrTy: PtrTy);
2352 // If the operand is already most derived object, no need to look up vtable.
2353 }
2354
2355 return MaybeASCast(CGM.GetAddrOfRTTIDescriptor(Ty: OperandTy));
2356}
2357
2358static llvm::Value *EmitDynamicCastToNull(CodeGenFunction &CGF,
2359 QualType DestTy) {
2360 llvm::Type *DestLTy = CGF.ConvertType(T: DestTy);
2361 if (DestTy->isPointerType())
2362 return llvm::Constant::getNullValue(Ty: DestLTy);
2363
2364 /// C++ [expr.dynamic.cast]p9:
2365 /// A failed cast to reference type throws std::bad_cast
2366 if (!CGF.CGM.getCXXABI().EmitBadCastCall(CGF))
2367 return nullptr;
2368
2369 CGF.Builder.ClearInsertionPoint();
2370 return llvm::PoisonValue::get(T: DestLTy);
2371}
2372
2373llvm::Value *CodeGenFunction::EmitDynamicCast(Address ThisAddr,
2374 const CXXDynamicCastExpr *DCE) {
2375 CGM.EmitExplicitCastExprType(E: DCE, CGF: this);
2376 QualType DestTy = DCE->getTypeAsWritten();
2377
2378 QualType SrcTy = DCE->getSubExpr()->getType();
2379
2380 // C++ [expr.dynamic.cast]p7:
2381 // If T is "pointer to cv void," then the result is a pointer to the most
2382 // derived object pointed to by v.
2383 bool IsDynamicCastToVoid = DestTy->isVoidPointerType();
2384 QualType SrcRecordTy;
2385 QualType DestRecordTy;
2386 if (IsDynamicCastToVoid) {
2387 SrcRecordTy = SrcTy->getPointeeType();
2388 // No DestRecordTy.
2389 } else if (const PointerType *DestPTy = DestTy->getAs<PointerType>()) {
2390 SrcRecordTy = SrcTy->castAs<PointerType>()->getPointeeType();
2391 DestRecordTy = DestPTy->getPointeeType();
2392 } else {
2393 SrcRecordTy = SrcTy;
2394 DestRecordTy = DestTy->castAs<ReferenceType>()->getPointeeType();
2395 }
2396
2397 // C++ [class.cdtor]p5:
2398 // If the operand of the dynamic_cast refers to the object under
2399 // construction or destruction and the static type of the operand is not a
2400 // pointer to or object of the constructor or destructor’s own class or one
2401 // of its bases, the dynamic_cast results in undefined behavior.
2402 EmitTypeCheck(TCK: TCK_DynamicOperation, Loc: DCE->getExprLoc(), Addr: ThisAddr, Type: SrcRecordTy);
2403
2404 if (DCE->isAlwaysNull()) {
2405 if (llvm::Value *T = EmitDynamicCastToNull(CGF&: *this, DestTy)) {
2406 // Expression emission is expected to retain a valid insertion point.
2407 if (!Builder.GetInsertBlock())
2408 EmitBlock(BB: createBasicBlock(name: "dynamic_cast.unreachable"));
2409 return T;
2410 }
2411 }
2412
2413 assert(SrcRecordTy->isRecordType() && "source type must be a record type!");
2414
2415 // If the destination is effectively final, the cast succeeds if and only
2416 // if the dynamic type of the pointer is exactly the destination type.
2417 bool IsExact = !IsDynamicCastToVoid &&
2418 CGM.getCodeGenOpts().OptimizationLevel > 0 &&
2419 DestRecordTy->getAsCXXRecordDecl()->isEffectivelyFinal() &&
2420 CGM.getCXXABI().shouldEmitExactDynamicCast(DestRecordTy);
2421
2422 std::optional<CGCXXABI::ExactDynamicCastInfo> ExactCastInfo;
2423 if (IsExact) {
2424 ExactCastInfo = CGM.getCXXABI().getExactDynamicCastInfo(SrcRecordTy, DestTy,
2425 DestRecordTy);
2426 if (!ExactCastInfo) {
2427 llvm::Value *NullValue = EmitDynamicCastToNull(CGF&: *this, DestTy);
2428 if (!Builder.GetInsertBlock())
2429 EmitBlock(BB: createBasicBlock(name: "dynamic_cast.unreachable"));
2430 return NullValue;
2431 }
2432 }
2433
2434 // C++ [expr.dynamic.cast]p4:
2435 // If the value of v is a null pointer value in the pointer case, the result
2436 // is the null pointer value of type T.
2437 bool ShouldNullCheckSrcValue =
2438 IsExact || CGM.getCXXABI().shouldDynamicCastCallBeNullChecked(
2439 SrcIsPtr: SrcTy->isPointerType(), SrcRecordTy);
2440
2441 llvm::BasicBlock *CastNull = nullptr;
2442 llvm::BasicBlock *CastNotNull = nullptr;
2443 llvm::BasicBlock *CastEnd = createBasicBlock(name: "dynamic_cast.end");
2444
2445 if (ShouldNullCheckSrcValue) {
2446 CastNull = createBasicBlock(name: "dynamic_cast.null");
2447 CastNotNull = createBasicBlock(name: "dynamic_cast.notnull");
2448
2449 llvm::Value *IsNull = Builder.CreateIsNull(Addr: ThisAddr);
2450 Builder.CreateCondBr(Cond: IsNull, True: CastNull, False: CastNotNull);
2451 EmitBlock(BB: CastNotNull);
2452 }
2453
2454 llvm::Value *Value;
2455 if (IsDynamicCastToVoid) {
2456 Value = CGM.getCXXABI().emitDynamicCastToVoid(CGF&: *this, Value: ThisAddr, SrcRecordTy);
2457 } else if (IsExact) {
2458 // If the destination type is effectively final, this pointer points to the
2459 // right type if and only if its vptr has the right value.
2460 Value = CGM.getCXXABI().emitExactDynamicCast(
2461 CGF&: *this, Value: ThisAddr, SrcRecordTy, DestTy, DestRecordTy, CastInfo: *ExactCastInfo,
2462 CastSuccess: CastEnd, CastFail: CastNull);
2463 } else {
2464 assert(DestRecordTy->isRecordType() &&
2465 "destination type must be a record type!");
2466 Value = CGM.getCXXABI().emitDynamicCastCall(CGF&: *this, Value: ThisAddr, SrcRecordTy,
2467 DestTy, DestRecordTy, CastEnd);
2468 }
2469 CastNotNull = Builder.GetInsertBlock();
2470
2471 llvm::Value *NullValue = nullptr;
2472 if (ShouldNullCheckSrcValue) {
2473 EmitBranch(Block: CastEnd);
2474
2475 EmitBlock(BB: CastNull);
2476 NullValue = EmitDynamicCastToNull(CGF&: *this, DestTy);
2477 CastNull = Builder.GetInsertBlock();
2478
2479 EmitBranch(Block: CastEnd);
2480 }
2481
2482 EmitBlock(BB: CastEnd);
2483
2484 if (CastNull) {
2485 llvm::PHINode *PHI = Builder.CreatePHI(Ty: Value->getType(), NumReservedValues: 2);
2486 PHI->addIncoming(V: Value, BB: CastNotNull);
2487 PHI->addIncoming(V: NullValue, BB: CastNull);
2488
2489 Value = PHI;
2490 }
2491
2492 return Value;
2493}
2494