blob: 89bf402c19f8a9adbc5225f2d471cf1811abcdf6 [file] [log] [blame]
Erik Pilkington9227e102017-02-21 20:31:01 +00001//===---- CGObjC.cpp - Emit LLVM Code for Objective-C ---------------------===//
Anders Carlsson76f4a902007-08-21 17:43:55 +00002//
Chandler Carruth2946cd72019-01-19 08:50:56 +00003// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
Anders Carlsson76f4a902007-08-21 17:43:55 +00006//
7//===----------------------------------------------------------------------===//
8//
9// This contains code to emit Objective-C code as LLVM code.
10//
11//===----------------------------------------------------------------------===//
12
Devang Pateld2d66652011-01-19 01:36:36 +000013#include "CGDebugInfo.h"
Ted Kremenek43e06332008-04-09 15:51:31 +000014#include "CGObjCRuntime.h"
Anders Carlsson76f4a902007-08-21 17:43:55 +000015#include "CodeGenFunction.h"
16#include "CodeGenModule.h"
Akira Hatanaka1488ee42019-03-08 04:45:37 +000017#include "ConstantEmitter.h"
John McCall31168b02011-06-15 23:02:42 +000018#include "TargetInfo.h"
Daniel Dunbar9e22c0d2008-08-29 08:11:39 +000019#include "clang/AST/ASTContext.h"
Reid Kleckner98031782019-12-09 16:11:56 -080020#include "clang/AST/Attr.h"
Daniel Dunbar6e8aa532008-08-11 05:35:13 +000021#include "clang/AST/DeclObjC.h"
Chris Lattnerf0b64d72009-04-26 01:32:48 +000022#include "clang/AST/StmtObjC.h"
Daniel Dunbarc5d33042008-09-03 00:27:26 +000023#include "clang/Basic/Diagnostic.h"
Mark Laceya8e7df32013-10-30 21:53:58 +000024#include "clang/CodeGen/CGFunctionInfo.h"
Anders Carlsson2e744e82008-08-30 19:51:14 +000025#include "llvm/ADT/STLExtras.h"
Alex Lorenz701456b2020-10-28 22:48:59 -070026#include "llvm/BinaryFormat/MachO.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000027#include "llvm/IR/DataLayout.h"
28#include "llvm/IR/InlineAsm.h"
Anders Carlsson76f4a902007-08-21 17:43:55 +000029using namespace clang;
30using namespace CodeGen;
31
John McCall31168b02011-06-15 23:02:42 +000032typedef llvm::PointerIntPair<llvm::Value*,1,bool> TryEmitResult;
33static TryEmitResult
34tryEmitARCRetainScalarExpr(CodeGenFunction &CGF, const Expr *e);
Douglas Gregore83b9562015-07-07 03:57:53 +000035static RValue AdjustObjCObjectType(CodeGenFunction &CGF,
36 QualType ET,
37 RValue Result);
John McCall31168b02011-06-15 23:02:42 +000038
39/// Given the address of a variable of pointer type, find the correct
40/// null to store into it.
John McCall7f416cc2015-09-08 08:05:57 +000041static llvm::Constant *getNullForVariable(Address addr) {
42 llvm::Type *type = addr.getElementType();
John McCall31168b02011-06-15 23:02:42 +000043 return llvm::ConstantPointerNull::get(cast<llvm::PointerType>(type));
44}
45
Chris Lattnerb1d329d2008-06-24 17:04:18 +000046/// Emits an instance of NSConstantString representing the object.
Mike Stump11289f42009-09-09 15:08:12 +000047llvm::Value *CodeGenFunction::EmitObjCStringLiteral(const ObjCStringLiteral *E)
Daniel Dunbar44b58a22008-11-25 21:53:21 +000048{
Fangrui Song6907ce22018-07-30 19:24:48 +000049 llvm::Constant *C =
John McCall7f416cc2015-09-08 08:05:57 +000050 CGM.getObjCRuntime().GenerateConstantString(E->getString()).getPointer();
Daniel Dunbar66912a12008-08-20 00:28:19 +000051 // FIXME: This bitcast should just be made an invariant on the Runtime.
Owen Andersonade90fd2009-07-29 18:54:39 +000052 return llvm::ConstantExpr::getBitCast(C, ConvertType(E->getType()));
Chris Lattnerb1d329d2008-06-24 17:04:18 +000053}
54
Patrick Beard0caa3942012-04-19 00:25:12 +000055/// EmitObjCBoxedExpr - This routine generates code to call
56/// the appropriate expression boxing method. This will either be
Alex Denisovfde64952015-06-26 05:28:36 +000057/// one of +[NSNumber numberWith<Type>:], or +[NSString stringWithUTF8String:],
58/// or [NSValue valueWithBytes:objCType:].
Ted Kremeneke65b0862012-03-06 20:05:56 +000059///
Eric Christopher5d2b8d92012-03-29 17:31:31 +000060llvm::Value *
Patrick Beard0caa3942012-04-19 00:25:12 +000061CodeGenFunction::EmitObjCBoxedExpr(const ObjCBoxedExpr *E) {
Ted Kremeneke65b0862012-03-06 20:05:56 +000062 // Generate the correct selector for this literal's concrete type.
Ted Kremeneke65b0862012-03-06 20:05:56 +000063 // Get the method.
Patrick Beard0caa3942012-04-19 00:25:12 +000064 const ObjCMethodDecl *BoxingMethod = E->getBoxingMethod();
Alex Denisovfde64952015-06-26 05:28:36 +000065 const Expr *SubExpr = E->getSubExpr();
Akira Hatanaka1488ee42019-03-08 04:45:37 +000066
67 if (E->isExpressibleAsConstantInitializer()) {
68 ConstantEmitter ConstEmitter(CGM);
69 return ConstEmitter.tryEmitAbstract(E, E->getType());
70 }
71
Patrick Beard0caa3942012-04-19 00:25:12 +000072 assert(BoxingMethod->isClassMethod() && "BoxingMethod must be a class method");
73 Selector Sel = BoxingMethod->getSelector();
Fangrui Song6907ce22018-07-30 19:24:48 +000074
Ted Kremeneke65b0862012-03-06 20:05:56 +000075 // Generate a reference to the class pointer, which will be the receiver.
Patrick Beard0caa3942012-04-19 00:25:12 +000076 // Assumes that the method was introduced in the class that should be
77 // messaged (avoids pulling it out of the result type).
Ted Kremeneke65b0862012-03-06 20:05:56 +000078 CGObjCRuntime &Runtime = CGM.getObjCRuntime();
Patrick Beard0caa3942012-04-19 00:25:12 +000079 const ObjCInterfaceDecl *ClassDecl = BoxingMethod->getClassInterface();
John McCall882987f2013-02-28 19:01:20 +000080 llvm::Value *Receiver = Runtime.GetClass(*this, ClassDecl);
Fariborz Jahanian661a97b2014-12-18 17:13:56 +000081
Ted Kremeneke65b0862012-03-06 20:05:56 +000082 CallArgList Args;
Alex Denisovfde64952015-06-26 05:28:36 +000083 const ParmVarDecl *ArgDecl = *BoxingMethod->param_begin();
84 QualType ArgQT = ArgDecl->getType().getUnqualifiedType();
Fangrui Song6907ce22018-07-30 19:24:48 +000085
86 // ObjCBoxedExpr supports boxing of structs and unions
Alex Denisovfde64952015-06-26 05:28:36 +000087 // via [NSValue valueWithBytes:objCType:]
88 const QualType ValueType(SubExpr->getType().getCanonicalType());
89 if (ValueType->isObjCBoxableRecordType()) {
90 // Emit CodeGen for first parameter
91 // and cast value to correct type
John McCall7f416cc2015-09-08 08:05:57 +000092 Address Temporary = CreateMemTemp(SubExpr->getType());
Alex Denisovfde64952015-06-26 05:28:36 +000093 EmitAnyExprToMem(SubExpr, Temporary, Qualifiers(), /*isInit*/ true);
John McCall7f416cc2015-09-08 08:05:57 +000094 Address BitCast = Builder.CreateBitCast(Temporary, ConvertType(ArgQT));
95 Args.add(RValue::get(BitCast.getPointer()), ArgQT);
Alex Denisovfde64952015-06-26 05:28:36 +000096
97 // Create char array to store type encoding
98 std::string Str;
99 getContext().getObjCEncodingForType(ValueType, Str);
John McCall7f416cc2015-09-08 08:05:57 +0000100 llvm::Constant *GV = CGM.GetAddrOfConstantCString(Str).getPointer();
Fangrui Song6907ce22018-07-30 19:24:48 +0000101
Alex Denisovfde64952015-06-26 05:28:36 +0000102 // Cast type encoding to correct type
103 const ParmVarDecl *EncodingDecl = BoxingMethod->parameters()[1];
104 QualType EncodingQT = EncodingDecl->getType().getUnqualifiedType();
105 llvm::Value *Cast = Builder.CreateBitCast(GV, ConvertType(EncodingQT));
106
107 Args.add(RValue::get(Cast), EncodingQT);
108 } else {
109 Args.add(EmitAnyExpr(SubExpr), ArgQT);
110 }
Alp Toker314cc812014-01-25 16:55:45 +0000111
112 RValue result = Runtime.GenerateMessageSend(
113 *this, ReturnValueSlot(), BoxingMethod->getReturnType(), Sel, Receiver,
114 Args, ClassDecl, BoxingMethod);
Fangrui Song6907ce22018-07-30 19:24:48 +0000115 return Builder.CreateBitCast(result.getScalarVal(),
Ted Kremeneke65b0862012-03-06 20:05:56 +0000116 ConvertType(E->getType()));
117}
118
119llvm::Value *CodeGenFunction::EmitObjCCollectionLiteral(const Expr *E,
Fariborz Jahanian9ad94aa2014-10-28 18:28:16 +0000120 const ObjCMethodDecl *MethodWithObjects) {
Ted Kremeneke65b0862012-03-06 20:05:56 +0000121 ASTContext &Context = CGM.getContext();
Craig Topper8a13c412014-05-21 05:09:00 +0000122 const ObjCDictionaryLiteral *DLE = nullptr;
Ted Kremeneke65b0862012-03-06 20:05:56 +0000123 const ObjCArrayLiteral *ALE = dyn_cast<ObjCArrayLiteral>(E);
124 if (!ALE)
125 DLE = cast<ObjCDictionaryLiteral>(E);
Akira Hatanaka4d53a1c2017-04-15 06:42:00 +0000126
127 // Optimize empty collections by referencing constants, when available.
Fangrui Song6907ce22018-07-30 19:24:48 +0000128 uint64_t NumElements =
Ted Kremeneke65b0862012-03-06 20:05:56 +0000129 ALE ? ALE->getNumElements() : DLE->getNumElements();
Akira Hatanaka4d53a1c2017-04-15 06:42:00 +0000130 if (NumElements == 0 && CGM.getLangOpts().ObjCRuntime.hasEmptyCollections()) {
131 StringRef ConstantName = ALE ? "__NSArray0__" : "__NSDictionary0__";
132 QualType IdTy(CGM.getContext().getObjCIdType());
133 llvm::Constant *Constant =
134 CGM.CreateRuntimeVariable(ConvertType(IdTy), ConstantName);
Akira Hatanakab5d1ea42017-04-17 15:21:55 +0000135 LValue LV = MakeNaturalAlignAddrLValue(Constant, IdTy);
Stephen Kellyf2ceec42018-08-09 21:08:08 +0000136 llvm::Value *Ptr = EmitLoadOfScalar(LV, E->getBeginLoc());
Akira Hatanakab5d1ea42017-04-17 15:21:55 +0000137 cast<llvm::LoadInst>(Ptr)->setMetadata(
138 CGM.getModule().getMDKindID("invariant.load"),
139 llvm::MDNode::get(getLLVMContext(), None));
140 return Builder.CreateBitCast(Ptr, ConvertType(E->getType()));
Akira Hatanaka4d53a1c2017-04-15 06:42:00 +0000141 }
142
143 // Compute the type of the array we're initializing.
Ted Kremeneke65b0862012-03-06 20:05:56 +0000144 llvm::APInt APNumElements(Context.getTypeSize(Context.getSizeType()),
145 NumElements);
146 QualType ElementType = Context.getObjCIdType().withConst();
Fangrui Song6907ce22018-07-30 19:24:48 +0000147 QualType ElementArrayType
Richard Smith772e2662019-10-04 01:25:59 +0000148 = Context.getConstantArrayType(ElementType, APNumElements, nullptr,
Ted Kremeneke65b0862012-03-06 20:05:56 +0000149 ArrayType::Normal, /*IndexTypeQuals=*/0);
150
151 // Allocate the temporary array(s).
John McCall7f416cc2015-09-08 08:05:57 +0000152 Address Objects = CreateMemTemp(ElementArrayType, "objects");
153 Address Keys = Address::invalid();
Ted Kremeneke65b0862012-03-06 20:05:56 +0000154 if (DLE)
155 Keys = CreateMemTemp(ElementArrayType, "keys");
Fangrui Song6907ce22018-07-30 19:24:48 +0000156
John McCall770a4c12013-04-04 00:20:38 +0000157 // In ARC, we may need to do extra work to keep all the keys and
158 // values alive until after the call.
159 SmallVector<llvm::Value *, 16> NeededObjects;
160 bool TrackNeededObjects =
161 (getLangOpts().ObjCAutoRefCount &&
162 CGM.getCodeGenOpts().OptimizationLevel != 0);
163
Ted Kremeneke65b0862012-03-06 20:05:56 +0000164 // Perform the actual initialialization of the array(s).
165 for (uint64_t i = 0; i < NumElements; i++) {
166 if (ALE) {
John McCall770a4c12013-04-04 00:20:38 +0000167 // Emit the element and store it to the appropriate array slot.
Ted Kremeneke65b0862012-03-06 20:05:56 +0000168 const Expr *Rhs = ALE->getElement(i);
James Y Knight751fe282019-02-09 22:22:28 +0000169 LValue LV = MakeAddrLValue(Builder.CreateConstArrayGEP(Objects, i),
170 ElementType, AlignmentSource::Decl);
John McCall770a4c12013-04-04 00:20:38 +0000171
172 llvm::Value *value = EmitScalarExpr(Rhs);
173 EmitStoreThroughLValue(RValue::get(value), LV, true);
174 if (TrackNeededObjects) {
175 NeededObjects.push_back(value);
176 }
Fangrui Song6907ce22018-07-30 19:24:48 +0000177 } else {
John McCall770a4c12013-04-04 00:20:38 +0000178 // Emit the key and store it to the appropriate array slot.
Ted Kremeneke65b0862012-03-06 20:05:56 +0000179 const Expr *Key = DLE->getKeyValueElement(i).Key;
James Y Knight751fe282019-02-09 22:22:28 +0000180 LValue KeyLV = MakeAddrLValue(Builder.CreateConstArrayGEP(Keys, i),
181 ElementType, AlignmentSource::Decl);
John McCall770a4c12013-04-04 00:20:38 +0000182 llvm::Value *keyValue = EmitScalarExpr(Key);
183 EmitStoreThroughLValue(RValue::get(keyValue), KeyLV, /*isInit=*/true);
Ted Kremeneke65b0862012-03-06 20:05:56 +0000184
John McCall770a4c12013-04-04 00:20:38 +0000185 // Emit the value and store it to the appropriate array slot.
David Blaikie1ed728c2015-04-05 22:45:47 +0000186 const Expr *Value = DLE->getKeyValueElement(i).Value;
James Y Knight751fe282019-02-09 22:22:28 +0000187 LValue ValueLV = MakeAddrLValue(Builder.CreateConstArrayGEP(Objects, i),
188 ElementType, AlignmentSource::Decl);
John McCall770a4c12013-04-04 00:20:38 +0000189 llvm::Value *valueValue = EmitScalarExpr(Value);
190 EmitStoreThroughLValue(RValue::get(valueValue), ValueLV, /*isInit=*/true);
191 if (TrackNeededObjects) {
192 NeededObjects.push_back(keyValue);
193 NeededObjects.push_back(valueValue);
194 }
Ted Kremeneke65b0862012-03-06 20:05:56 +0000195 }
196 }
Fangrui Song6907ce22018-07-30 19:24:48 +0000197
Ted Kremeneke65b0862012-03-06 20:05:56 +0000198 // Generate the argument list.
Fangrui Song6907ce22018-07-30 19:24:48 +0000199 CallArgList Args;
Ted Kremeneke65b0862012-03-06 20:05:56 +0000200 ObjCMethodDecl::param_const_iterator PI = MethodWithObjects->param_begin();
201 const ParmVarDecl *argDecl = *PI++;
202 QualType ArgQT = argDecl->getType().getUnqualifiedType();
John McCall7f416cc2015-09-08 08:05:57 +0000203 Args.add(RValue::get(Objects.getPointer()), ArgQT);
Ted Kremeneke65b0862012-03-06 20:05:56 +0000204 if (DLE) {
205 argDecl = *PI++;
206 ArgQT = argDecl->getType().getUnqualifiedType();
John McCall7f416cc2015-09-08 08:05:57 +0000207 Args.add(RValue::get(Keys.getPointer()), ArgQT);
Ted Kremeneke65b0862012-03-06 20:05:56 +0000208 }
209 argDecl = *PI;
210 ArgQT = argDecl->getType().getUnqualifiedType();
Fangrui Song6907ce22018-07-30 19:24:48 +0000211 llvm::Value *Count =
Ted Kremeneke65b0862012-03-06 20:05:56 +0000212 llvm::ConstantInt::get(CGM.getTypes().ConvertType(ArgQT), NumElements);
213 Args.add(RValue::get(Count), ArgQT);
214
215 // Generate a reference to the class pointer, which will be the receiver.
216 Selector Sel = MethodWithObjects->getSelector();
217 QualType ResultType = E->getType();
218 const ObjCObjectPointerType *InterfacePointerType
219 = ResultType->getAsObjCInterfacePointerType();
Fangrui Song6907ce22018-07-30 19:24:48 +0000220 ObjCInterfaceDecl *Class
Ted Kremeneke65b0862012-03-06 20:05:56 +0000221 = InterfacePointerType->getObjectType()->getInterface();
222 CGObjCRuntime &Runtime = CGM.getObjCRuntime();
John McCall882987f2013-02-28 19:01:20 +0000223 llvm::Value *Receiver = Runtime.GetClass(*this, Class);
Ted Kremeneke65b0862012-03-06 20:05:56 +0000224
225 // Generate the message send.
Alp Toker314cc812014-01-25 16:55:45 +0000226 RValue result = Runtime.GenerateMessageSend(
227 *this, ReturnValueSlot(), MethodWithObjects->getReturnType(), Sel,
228 Receiver, Args, Class, MethodWithObjects);
John McCall770a4c12013-04-04 00:20:38 +0000229
230 // The above message send needs these objects, but in ARC they are
231 // passed in a buffer that is essentially __unsafe_unretained.
232 // Therefore we must prevent the optimizer from releasing them until
233 // after the call.
234 if (TrackNeededObjects) {
235 EmitARCIntrinsicUse(NeededObjects);
236 }
237
Fangrui Song6907ce22018-07-30 19:24:48 +0000238 return Builder.CreateBitCast(result.getScalarVal(),
Ted Kremeneke65b0862012-03-06 20:05:56 +0000239 ConvertType(E->getType()));
240}
241
242llvm::Value *CodeGenFunction::EmitObjCArrayLiteral(const ObjCArrayLiteral *E) {
Fariborz Jahanian9ad94aa2014-10-28 18:28:16 +0000243 return EmitObjCCollectionLiteral(E, E->getArrayWithObjectsMethod());
Ted Kremeneke65b0862012-03-06 20:05:56 +0000244}
245
246llvm::Value *CodeGenFunction::EmitObjCDictionaryLiteral(
247 const ObjCDictionaryLiteral *E) {
Fariborz Jahanian9ad94aa2014-10-28 18:28:16 +0000248 return EmitObjCCollectionLiteral(E, E->getDictWithObjectsMethod());
Ted Kremeneke65b0862012-03-06 20:05:56 +0000249}
250
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000251/// Emit a selector.
252llvm::Value *CodeGenFunction::EmitObjCSelectorExpr(const ObjCSelectorExpr *E) {
253 // Untyped selector.
254 // Note that this implementation allows for non-constant strings to be passed
255 // as arguments to @selector(). Currently, the only thing preventing this
256 // behaviour is the type checking in the front end.
John McCall882987f2013-02-28 19:01:20 +0000257 return CGM.getObjCRuntime().GetSelector(*this, E->getSelector());
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000258}
259
Daniel Dunbar66912a12008-08-20 00:28:19 +0000260llvm::Value *CodeGenFunction::EmitObjCProtocolExpr(const ObjCProtocolExpr *E) {
261 // FIXME: This should pass the Decl not the name.
John McCall882987f2013-02-28 19:01:20 +0000262 return CGM.getObjCRuntime().GenerateProtocolRef(*this, E->getProtocol());
Daniel Dunbar66912a12008-08-20 00:28:19 +0000263}
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000264
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000265/// Adjust the type of an Objective-C object that doesn't match up due
Douglas Gregore83b9562015-07-07 03:57:53 +0000266/// to type erasure at various points, e.g., related result types or the use
267/// of parameterized classes.
268static RValue AdjustObjCObjectType(CodeGenFunction &CGF, QualType ExpT,
269 RValue Result) {
270 if (!ExpT->isObjCRetainableType())
Douglas Gregor33823722011-06-11 01:09:30 +0000271 return Result;
John McCall31168b02011-06-15 23:02:42 +0000272
Douglas Gregore83b9562015-07-07 03:57:53 +0000273 // If the converted types are the same, we're done.
274 llvm::Type *ExpLLVMTy = CGF.ConvertType(ExpT);
275 if (ExpLLVMTy == Result.getScalarVal()->getType())
Douglas Gregor33823722011-06-11 01:09:30 +0000276 return Result;
Douglas Gregore83b9562015-07-07 03:57:53 +0000277
278 // We have applied a substitution. Cast the rvalue appropriately.
Douglas Gregor33823722011-06-11 01:09:30 +0000279 return RValue::get(CGF.Builder.CreateBitCast(Result.getScalarVal(),
Douglas Gregore83b9562015-07-07 03:57:53 +0000280 ExpLLVMTy));
Douglas Gregor33823722011-06-11 01:09:30 +0000281}
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000282
John McCallcf166702011-07-22 08:53:00 +0000283/// Decide whether to extend the lifetime of the receiver of a
284/// returns-inner-pointer message.
285static bool
286shouldExtendReceiverForInnerPointerMessage(const ObjCMessageExpr *message) {
287 switch (message->getReceiverKind()) {
288
289 // For a normal instance message, we should extend unless the
290 // receiver is loaded from a variable with precise lifetime.
291 case ObjCMessageExpr::Instance: {
292 const Expr *receiver = message->getInstanceReceiver();
John McCall6380a282015-09-09 23:37:17 +0000293
294 // Look through OVEs.
295 if (auto opaque = dyn_cast<OpaqueValueExpr>(receiver)) {
296 if (opaque->getSourceExpr())
297 receiver = opaque->getSourceExpr()->IgnoreParens();
298 }
299
John McCallcf166702011-07-22 08:53:00 +0000300 const ImplicitCastExpr *ice = dyn_cast<ImplicitCastExpr>(receiver);
301 if (!ice || ice->getCastKind() != CK_LValueToRValue) return true;
302 receiver = ice->getSubExpr()->IgnoreParens();
303
John McCall6380a282015-09-09 23:37:17 +0000304 // Look through OVEs.
305 if (auto opaque = dyn_cast<OpaqueValueExpr>(receiver)) {
306 if (opaque->getSourceExpr())
307 receiver = opaque->getSourceExpr()->IgnoreParens();
308 }
309
John McCallcf166702011-07-22 08:53:00 +0000310 // Only __strong variables.
311 if (receiver->getType().getObjCLifetime() != Qualifiers::OCL_Strong)
312 return true;
313
314 // All ivars and fields have precise lifetime.
315 if (isa<MemberExpr>(receiver) || isa<ObjCIvarRefExpr>(receiver))
316 return false;
317
318 // Otherwise, check for variables.
319 const DeclRefExpr *declRef = dyn_cast<DeclRefExpr>(ice->getSubExpr());
320 if (!declRef) return true;
321 const VarDecl *var = dyn_cast<VarDecl>(declRef->getDecl());
322 if (!var) return true;
323
324 // All variables have precise lifetime except local variables with
325 // automatic storage duration that aren't specially marked.
326 return (var->hasLocalStorage() &&
327 !var->hasAttr<ObjCPreciseLifetimeAttr>());
328 }
329
330 case ObjCMessageExpr::Class:
331 case ObjCMessageExpr::SuperClass:
332 // It's never necessary for class objects.
333 return false;
334
335 case ObjCMessageExpr::SuperInstance:
336 // We generally assume that 'self' lives throughout a method call.
337 return false;
338 }
339
340 llvm_unreachable("invalid receiver kind");
341}
342
John McCall460ce582015-10-22 18:38:17 +0000343/// Given an expression of ObjC pointer type, check whether it was
344/// immediately loaded from an ARC __weak l-value.
345static const Expr *findWeakLValue(const Expr *E) {
346 assert(E->getType()->isObjCRetainableType());
347 E = E->IgnoreParens();
348 if (auto CE = dyn_cast<CastExpr>(E)) {
349 if (CE->getCastKind() == CK_LValueToRValue) {
350 if (CE->getSubExpr()->getType().getObjCLifetime() == Qualifiers::OCL_Weak)
351 return CE->getSubExpr();
352 }
353 }
354
355 return nullptr;
356}
357
Pete Coopere3886802018-12-08 05:13:50 +0000358/// The ObjC runtime may provide entrypoints that are likely to be faster
359/// than an ordinary message send of the appropriate selector.
360///
361/// The entrypoints are guaranteed to be equivalent to just sending the
362/// corresponding message. If the entrypoint is implemented naively as just a
363/// message send, using it is a trade-off: it sacrifices a few cycles of
364/// overhead to save a small amount of code. However, it's possible for
365/// runtimes to detect and special-case classes that use "standard"
366/// behavior; if that's dynamically a large proportion of all objects, using
367/// the entrypoint will also be faster than using a message send.
368///
369/// If the runtime does support a required entrypoint, then this method will
370/// generate a call and return the resulting value. Otherwise it will return
371/// None and the caller can generate a msgSend instead.
372static Optional<llvm::Value *>
373tryGenerateSpecializedMessageSend(CodeGenFunction &CGF, QualType ResultType,
374 llvm::Value *Receiver,
375 const CallArgList& Args, Selector Sel,
Pete Cooperde0a8d32019-01-02 17:25:30 +0000376 const ObjCMethodDecl *method,
377 bool isClassMessage) {
Pete Coopere3886802018-12-08 05:13:50 +0000378 auto &CGM = CGF.CGM;
379 if (!CGM.getCodeGenOpts().ObjCConvertMessagesToRuntimeCalls)
380 return None;
381
382 auto &Runtime = CGM.getLangOpts().ObjCRuntime;
383 switch (Sel.getMethodFamily()) {
384 case OMF_alloc:
Pete Cooperde0a8d32019-01-02 17:25:30 +0000385 if (isClassMessage &&
386 Runtime.shouldUseRuntimeFunctionsForAlloc() &&
Pete Coopere3886802018-12-08 05:13:50 +0000387 ResultType->isObjCObjectPointerType()) {
Akira Hatanaka48566aa2019-06-04 16:29:58 +0000388 // [Foo alloc] -> objc_alloc(Foo) or
389 // [self alloc] -> objc_alloc(self)
Pete Coopere3886802018-12-08 05:13:50 +0000390 if (Sel.isUnarySelector() && Sel.getNameForSlot(0) == "alloc")
391 return CGF.EmitObjCAlloc(Receiver, CGF.ConvertType(ResultType));
Akira Hatanaka48566aa2019-06-04 16:29:58 +0000392 // [Foo allocWithZone:nil] -> objc_allocWithZone(Foo) or
393 // [self allocWithZone:nil] -> objc_allocWithZone(self)
Pete Coopere3886802018-12-08 05:13:50 +0000394 if (Sel.isKeywordSelector() && Sel.getNumArgs() == 1 &&
395 Args.size() == 1 && Args.front().getType()->isPointerType() &&
396 Sel.getNameForSlot(0) == "allocWithZone") {
397 const llvm::Value* arg = Args.front().getKnownRValue().getScalarVal();
398 if (isa<llvm::ConstantPointerNull>(arg))
399 return CGF.EmitObjCAllocWithZone(Receiver,
400 CGF.ConvertType(ResultType));
401 return None;
402 }
403 }
404 break;
405
Pete Coopere5b64ea2018-12-21 21:00:32 +0000406 case OMF_autorelease:
407 if (ResultType->isObjCObjectPointerType() &&
408 CGM.getLangOpts().getGC() == LangOptions::NonGC &&
409 Runtime.shouldUseARCFunctionsForRetainRelease())
410 return CGF.EmitObjCAutorelease(Receiver, CGF.ConvertType(ResultType));
411 break;
412
413 case OMF_retain:
414 if (ResultType->isObjCObjectPointerType() &&
415 CGM.getLangOpts().getGC() == LangOptions::NonGC &&
416 Runtime.shouldUseARCFunctionsForRetainRelease())
417 return CGF.EmitObjCRetainNonBlock(Receiver, CGF.ConvertType(ResultType));
418 break;
419
420 case OMF_release:
421 if (ResultType->isVoidType() &&
422 CGM.getLangOpts().getGC() == LangOptions::NonGC &&
423 Runtime.shouldUseARCFunctionsForRetainRelease()) {
424 CGF.EmitObjCRelease(Receiver, ARCPreciseLifetime);
425 return nullptr;
426 }
427 break;
428
Pete Coopere3886802018-12-08 05:13:50 +0000429 default:
430 break;
431 }
432 return None;
433}
434
Pierre Habouzitd4e1ba32019-11-07 23:14:58 -0800435CodeGen::RValue CGObjCRuntime::GeneratePossiblySpecializedMessageSend(
436 CodeGenFunction &CGF, ReturnValueSlot Return, QualType ResultType,
437 Selector Sel, llvm::Value *Receiver, const CallArgList &Args,
438 const ObjCInterfaceDecl *OID, const ObjCMethodDecl *Method,
439 bool isClassMessage) {
440 if (Optional<llvm::Value *> SpecializedResult =
441 tryGenerateSpecializedMessageSend(CGF, ResultType, Receiver, Args,
442 Sel, Method, isClassMessage)) {
443 return RValue::get(SpecializedResult.getValue());
444 }
445 return GenerateMessageSend(CGF, Return, ResultType, Sel, Receiver, Args, OID,
446 Method);
447}
448
Nathan Lanza14f6bfc2020-02-27 15:57:44 -0800449static void AppendFirstImpliedRuntimeProtocols(
450 const ObjCProtocolDecl *PD,
451 llvm::UniqueVector<const ObjCProtocolDecl *> &PDs) {
452 if (!PD->isNonRuntimeProtocol()) {
453 const auto *Can = PD->getCanonicalDecl();
454 PDs.insert(Can);
455 return;
456 }
457
458 for (const auto *ParentPD : PD->protocols())
459 AppendFirstImpliedRuntimeProtocols(ParentPD, PDs);
460}
461
462std::vector<const ObjCProtocolDecl *>
463CGObjCRuntime::GetRuntimeProtocolList(ObjCProtocolDecl::protocol_iterator begin,
464 ObjCProtocolDecl::protocol_iterator end) {
465 std::vector<const ObjCProtocolDecl *> RuntimePds;
466 llvm::DenseSet<const ObjCProtocolDecl *> NonRuntimePDs;
467
468 for (; begin != end; ++begin) {
469 const auto *It = *begin;
470 const auto *Can = It->getCanonicalDecl();
471 if (Can->isNonRuntimeProtocol())
472 NonRuntimePDs.insert(Can);
473 else
474 RuntimePds.push_back(Can);
475 }
476
477 // If there are no non-runtime protocols then we can just stop now.
478 if (NonRuntimePDs.empty())
479 return RuntimePds;
480
481 // Else we have to search through the non-runtime protocol's inheritancy
482 // hierarchy DAG stopping whenever a branch either finds a runtime protocol or
483 // a non-runtime protocol without any parents. These are the "first-implied"
484 // protocols from a non-runtime protocol.
485 llvm::UniqueVector<const ObjCProtocolDecl *> FirstImpliedProtos;
486 for (const auto *PD : NonRuntimePDs)
487 AppendFirstImpliedRuntimeProtocols(PD, FirstImpliedProtos);
488
489 // Walk the Runtime list to get all protocols implied via the inclusion of
490 // this protocol, e.g. all protocols it inherits from including itself.
491 llvm::DenseSet<const ObjCProtocolDecl *> AllImpliedProtocols;
492 for (const auto *PD : RuntimePds) {
493 const auto *Can = PD->getCanonicalDecl();
494 AllImpliedProtocols.insert(Can);
495 Can->getImpliedProtocols(AllImpliedProtocols);
496 }
497
498 // Similar to above, walk the list of first-implied protocols to find the set
499 // all the protocols implied excluding the listed protocols themselves since
500 // they are not yet a part of the `RuntimePds` list.
501 for (const auto *PD : FirstImpliedProtos) {
502 PD->getImpliedProtocols(AllImpliedProtocols);
503 }
504
505 // From the first-implied list we have to finish building the final protocol
506 // list. If a protocol in the first-implied list was already implied via some
507 // inheritance path through some other protocols then it would be redundant to
508 // add it here and so we skip over it.
509 for (const auto *PD : FirstImpliedProtos) {
510 if (!AllImpliedProtocols.contains(PD)) {
511 RuntimePds.push_back(PD);
512 }
513 }
514
515 return RuntimePds;
516}
517
Erik Pilkingtonec389b02019-02-14 19:58:37 +0000518/// Instead of '[[MyClass alloc] init]', try to generate
519/// 'objc_alloc_init(MyClass)'. This provides a code size improvement on the
520/// caller side, as well as the optimized objc_alloc.
521static Optional<llvm::Value *>
522tryEmitSpecializedAllocInit(CodeGenFunction &CGF, const ObjCMessageExpr *OME) {
523 auto &Runtime = CGF.getLangOpts().ObjCRuntime;
524 if (!Runtime.shouldUseRuntimeFunctionForCombinedAllocInit())
525 return None;
526
527 // Match the exact pattern '[[MyClass alloc] init]'.
528 Selector Sel = OME->getSelector();
Erik Pilkington55e703a2019-02-25 21:35:14 +0000529 if (OME->getReceiverKind() != ObjCMessageExpr::Instance ||
530 !OME->getType()->isObjCObjectPointerType() || !Sel.isUnarySelector() ||
531 Sel.getNameForSlot(0) != "init")
Erik Pilkingtonec389b02019-02-14 19:58:37 +0000532 return None;
533
Pierre Habouzitd18fbfc2020-01-14 18:56:26 -0800534 // Okay, this is '[receiver init]', check if 'receiver' is '[cls alloc]'
535 // with 'cls' a Class.
Erik Pilkingtonec389b02019-02-14 19:58:37 +0000536 auto *SubOME =
Akira Hatanaka48566aa2019-06-04 16:29:58 +0000537 dyn_cast<ObjCMessageExpr>(OME->getInstanceReceiver()->IgnoreParenCasts());
Erik Pilkingtonec389b02019-02-14 19:58:37 +0000538 if (!SubOME)
539 return None;
540 Selector SubSel = SubOME->getSelector();
Akira Hatanaka48566aa2019-06-04 16:29:58 +0000541
Pierre Habouzitd18fbfc2020-01-14 18:56:26 -0800542 if (!SubOME->getType()->isObjCObjectPointerType() ||
Erik Pilkingtonec389b02019-02-14 19:58:37 +0000543 !SubSel.isUnarySelector() || SubSel.getNameForSlot(0) != "alloc")
544 return None;
545
Pierre Habouzitd18fbfc2020-01-14 18:56:26 -0800546 llvm::Value *Receiver = nullptr;
547 switch (SubOME->getReceiverKind()) {
548 case ObjCMessageExpr::Instance:
549 if (!SubOME->getInstanceReceiver()->getType()->isObjCClassType())
550 return None;
551 Receiver = CGF.EmitScalarExpr(SubOME->getInstanceReceiver());
552 break;
553
554 case ObjCMessageExpr::Class: {
Akira Hatanaka48566aa2019-06-04 16:29:58 +0000555 QualType ReceiverType = SubOME->getClassReceiver();
Simon Pilgrim25dc5c72020-01-14 13:28:46 +0000556 const ObjCObjectType *ObjTy = ReceiverType->castAs<ObjCObjectType>();
Akira Hatanaka48566aa2019-06-04 16:29:58 +0000557 const ObjCInterfaceDecl *ID = ObjTy->getInterface();
558 assert(ID && "null interface should be impossible here");
559 Receiver = CGF.CGM.getObjCRuntime().GetClass(CGF, ID);
Pierre Habouzitd18fbfc2020-01-14 18:56:26 -0800560 break;
Akira Hatanaka48566aa2019-06-04 16:29:58 +0000561 }
Pierre Habouzitd18fbfc2020-01-14 18:56:26 -0800562 case ObjCMessageExpr::SuperInstance:
563 case ObjCMessageExpr::SuperClass:
564 return None;
565 }
566
Erik Pilkingtonec389b02019-02-14 19:58:37 +0000567 return CGF.EmitObjCAllocInit(Receiver, CGF.ConvertType(OME->getType()));
568}
569
John McCall78a15112010-05-22 01:48:05 +0000570RValue CodeGenFunction::EmitObjCMessageExpr(const ObjCMessageExpr *E,
571 ReturnValueSlot Return) {
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000572 // Only the lookup mechanism and first two arguments of the method
573 // implementation vary between runtimes. We can get the receiver and
574 // arguments in generic code.
Mike Stump11289f42009-09-09 15:08:12 +0000575
John McCall31168b02011-06-15 23:02:42 +0000576 bool isDelegateInit = E->isDelegateInitCall();
577
John McCallcf166702011-07-22 08:53:00 +0000578 const ObjCMethodDecl *method = E->getMethodDecl();
Fariborz Jahanian715fdd52012-01-29 20:27:13 +0000579
John McCall460ce582015-10-22 18:38:17 +0000580 // If the method is -retain, and the receiver's being loaded from
581 // a __weak variable, peephole the entire operation to objc_loadWeakRetained.
582 if (method && E->getReceiverKind() == ObjCMessageExpr::Instance &&
583 method->getMethodFamily() == OMF_retain) {
584 if (auto lvalueExpr = findWeakLValue(E->getInstanceReceiver())) {
585 LValue lvalue = EmitLValue(lvalueExpr);
Akira Hatanakaf139ae32019-12-03 15:17:01 -0800586 llvm::Value *result = EmitARCLoadWeakRetained(lvalue.getAddress(*this));
John McCall460ce582015-10-22 18:38:17 +0000587 return AdjustObjCObjectType(*this, E->getType(), RValue::get(result));
588 }
589 }
590
Erik Pilkingtonec389b02019-02-14 19:58:37 +0000591 if (Optional<llvm::Value *> Val = tryEmitSpecializedAllocInit(*this, E))
592 return AdjustObjCObjectType(*this, E->getType(), RValue::get(*Val));
593
John McCall31168b02011-06-15 23:02:42 +0000594 // We don't retain the receiver in delegate init calls, and this is
595 // safe because the receiver value is always loaded from 'self',
596 // which we zero out. We don't want to Block_copy block receivers,
597 // though.
598 bool retainSelf =
599 (!isDelegateInit &&
David Blaikiebbafb8a2012-03-11 07:00:24 +0000600 CGM.getLangOpts().ObjCAutoRefCount &&
John McCallcf166702011-07-22 08:53:00 +0000601 method &&
602 method->hasAttr<NSConsumesSelfAttr>());
John McCall31168b02011-06-15 23:02:42 +0000603
Daniel Dunbar8d480592008-08-11 18:12:00 +0000604 CGObjCRuntime &Runtime = CGM.getObjCRuntime();
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000605 bool isSuperMessage = false;
Daniel Dunbarca8531a2008-08-25 08:19:24 +0000606 bool isClassMessage = false;
Craig Topper8a13c412014-05-21 05:09:00 +0000607 ObjCInterfaceDecl *OID = nullptr;
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000608 // Find the receiver
Douglas Gregor33823722011-06-11 01:09:30 +0000609 QualType ReceiverType;
Craig Topper8a13c412014-05-21 05:09:00 +0000610 llvm::Value *Receiver = nullptr;
Douglas Gregor9a129192010-04-21 00:45:42 +0000611 switch (E->getReceiverKind()) {
612 case ObjCMessageExpr::Instance:
Douglas Gregor33823722011-06-11 01:09:30 +0000613 ReceiverType = E->getInstanceReceiver()->getType();
Pierre Habouzitd18fbfc2020-01-14 18:56:26 -0800614 isClassMessage = ReceiverType->isObjCClassType();
John McCall31168b02011-06-15 23:02:42 +0000615 if (retainSelf) {
616 TryEmitResult ter = tryEmitARCRetainScalarExpr(*this,
617 E->getInstanceReceiver());
618 Receiver = ter.getPointer();
John McCallcf166702011-07-22 08:53:00 +0000619 if (ter.getInt()) retainSelf = false;
John McCall31168b02011-06-15 23:02:42 +0000620 } else
621 Receiver = EmitScalarExpr(E->getInstanceReceiver());
Douglas Gregor9a129192010-04-21 00:45:42 +0000622 break;
Daniel Dunbar7c6d3a72008-08-16 00:25:02 +0000623
Douglas Gregor9a129192010-04-21 00:45:42 +0000624 case ObjCMessageExpr::Class: {
Douglas Gregor33823722011-06-11 01:09:30 +0000625 ReceiverType = E->getClassReceiver();
Simon Pilgrim25dc5c72020-01-14 13:28:46 +0000626 OID = ReceiverType->castAs<ObjCObjectType>()->getInterface();
John McCall3e294922010-05-17 20:12:43 +0000627 assert(OID && "Invalid Objective-C class message send");
John McCall882987f2013-02-28 19:01:20 +0000628 Receiver = Runtime.GetClass(*this, OID);
Daniel Dunbarca8531a2008-08-25 08:19:24 +0000629 isClassMessage = true;
Douglas Gregor9a129192010-04-21 00:45:42 +0000630 break;
631 }
632
633 case ObjCMessageExpr::SuperInstance:
Douglas Gregor33823722011-06-11 01:09:30 +0000634 ReceiverType = E->getSuperType();
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000635 Receiver = LoadObjCSelf();
Douglas Gregor9a129192010-04-21 00:45:42 +0000636 isSuperMessage = true;
637 break;
638
639 case ObjCMessageExpr::SuperClass:
Douglas Gregor33823722011-06-11 01:09:30 +0000640 ReceiverType = E->getSuperType();
Douglas Gregor9a129192010-04-21 00:45:42 +0000641 Receiver = LoadObjCSelf();
642 isSuperMessage = true;
643 isClassMessage = true;
644 break;
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000645 }
646
John McCallcf166702011-07-22 08:53:00 +0000647 if (retainSelf)
648 Receiver = EmitARCRetainNonBlock(Receiver);
649
650 // In ARC, we sometimes want to "extend the lifetime"
651 // (i.e. retain+autorelease) of receivers of returns-inner-pointer
652 // messages.
David Blaikiebbafb8a2012-03-11 07:00:24 +0000653 if (getLangOpts().ObjCAutoRefCount && method &&
John McCallcf166702011-07-22 08:53:00 +0000654 method->hasAttr<ObjCReturnsInnerPointerAttr>() &&
655 shouldExtendReceiverForInnerPointerMessage(E))
656 Receiver = EmitARCRetainAutorelease(ReceiverType, Receiver);
657
Alp Toker314cc812014-01-25 16:55:45 +0000658 QualType ResultType = method ? method->getReturnType() : E->getType();
John McCall31168b02011-06-15 23:02:42 +0000659
Daniel Dunbarc722b852008-08-30 03:02:31 +0000660 CallArgList Args;
Vedant Kumared00ea02017-03-06 05:28:22 +0000661 EmitCallArgs(Args, method, E->arguments(), /*AC*/AbstractCallee(method));
Mike Stump11289f42009-09-09 15:08:12 +0000662
John McCall31168b02011-06-15 23:02:42 +0000663 // For delegate init calls in ARC, do an unsafe store of null into
664 // self. This represents the call taking direct ownership of that
665 // value. We have to do this after emitting the other call
666 // arguments because they might also reference self, but we don't
667 // have to worry about any of them modifying self because that would
668 // be an undefined read and write of an object in unordered
669 // expressions.
670 if (isDelegateInit) {
David Blaikiebbafb8a2012-03-11 07:00:24 +0000671 assert(getLangOpts().ObjCAutoRefCount &&
John McCall31168b02011-06-15 23:02:42 +0000672 "delegate init calls should only be marked in ARC");
673
674 // Do an unsafe store of null into self.
John McCall7f416cc2015-09-08 08:05:57 +0000675 Address selfAddr =
676 GetAddrOfLocalVar(cast<ObjCMethodDecl>(CurCodeDecl)->getSelfDecl());
John McCall31168b02011-06-15 23:02:42 +0000677 Builder.CreateStore(getNullForVariable(selfAddr), selfAddr);
678 }
Anders Carlsson280e61f12010-06-21 20:59:55 +0000679
Douglas Gregor33823722011-06-11 01:09:30 +0000680 RValue result;
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000681 if (isSuperMessage) {
Chris Lattner6cfec782008-06-26 04:42:20 +0000682 // super is only valid in an Objective-C method
683 const ObjCMethodDecl *OMD = cast<ObjCMethodDecl>(CurFuncDecl);
Fariborz Jahanianbac73ac2009-02-28 20:07:56 +0000684 bool isCategoryImpl = isa<ObjCCategoryImplDecl>(OMD->getDeclContext());
Douglas Gregor33823722011-06-11 01:09:30 +0000685 result = Runtime.GenerateMessageSendSuper(*this, Return, ResultType,
686 E->getSelector(),
687 OMD->getClassInterface(),
688 isCategoryImpl,
689 Receiver,
690 isClassMessage,
691 Args,
John McCallcf166702011-07-22 08:53:00 +0000692 method);
Douglas Gregor33823722011-06-11 01:09:30 +0000693 } else {
Pete Coopere3886802018-12-08 05:13:50 +0000694 // Call runtime methods directly if we can.
Pierre Habouzitd4e1ba32019-11-07 23:14:58 -0800695 result = Runtime.GeneratePossiblySpecializedMessageSend(
696 *this, Return, ResultType, E->getSelector(), Receiver, Args, OID,
697 method, isClassMessage);
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000698 }
John McCall31168b02011-06-15 23:02:42 +0000699
700 // For delegate init calls in ARC, implicitly store the result of
701 // the call back into self. This takes ownership of the value.
702 if (isDelegateInit) {
John McCall7f416cc2015-09-08 08:05:57 +0000703 Address selfAddr =
704 GetAddrOfLocalVar(cast<ObjCMethodDecl>(CurCodeDecl)->getSelfDecl());
John McCall31168b02011-06-15 23:02:42 +0000705 llvm::Value *newSelf = result.getScalarVal();
706
707 // The delegate return type isn't necessarily a matching type; in
708 // fact, it's quite likely to be 'id'.
John McCall7f416cc2015-09-08 08:05:57 +0000709 llvm::Type *selfTy = selfAddr.getElementType();
John McCall31168b02011-06-15 23:02:42 +0000710 newSelf = Builder.CreateBitCast(newSelf, selfTy);
711
712 Builder.CreateStore(newSelf, selfAddr);
713 }
Fariborz Jahanian715fdd52012-01-29 20:27:13 +0000714
Douglas Gregore83b9562015-07-07 03:57:53 +0000715 return AdjustObjCObjectType(*this, E->getType(), result);
Anders Carlsson76f4a902007-08-21 17:43:55 +0000716}
717
John McCall31168b02011-06-15 23:02:42 +0000718namespace {
David Blaikie7e70d682015-08-18 22:40:54 +0000719struct FinishARCDealloc final : EHScopeStack::Cleanup {
Craig Topper4f12f102014-03-12 06:41:41 +0000720 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall31168b02011-06-15 23:02:42 +0000721 const ObjCMethodDecl *method = cast<ObjCMethodDecl>(CGF.CurCodeDecl);
John McCalldffafde2011-07-13 18:26:47 +0000722
723 const ObjCImplDecl *impl = cast<ObjCImplDecl>(method->getDeclContext());
John McCall31168b02011-06-15 23:02:42 +0000724 const ObjCInterfaceDecl *iface = impl->getClassInterface();
725 if (!iface->getSuperClass()) return;
726
John McCalldffafde2011-07-13 18:26:47 +0000727 bool isCategory = isa<ObjCCategoryImplDecl>(impl);
728
John McCall31168b02011-06-15 23:02:42 +0000729 // Call [super dealloc] if we have a superclass.
730 llvm::Value *self = CGF.LoadObjCSelf();
731
732 CallArgList args;
733 CGF.CGM.getObjCRuntime().GenerateMessageSendSuper(CGF, ReturnValueSlot(),
734 CGF.getContext().VoidTy,
735 method->getSelector(),
736 iface,
John McCalldffafde2011-07-13 18:26:47 +0000737 isCategory,
John McCall31168b02011-06-15 23:02:42 +0000738 self,
739 /*is class msg*/ false,
740 args,
741 method);
742 }
743};
Alexander Kornienkoab9db512015-06-22 23:07:51 +0000744}
John McCall31168b02011-06-15 23:02:42 +0000745
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000746/// StartObjCMethod - Begin emission of an ObjCMethod. This generates
747/// the LLVM function and sets the other context used by
748/// CodeGenFunction.
Fariborz Jahanian0196a1c2009-01-10 21:06:09 +0000749void CodeGenFunction::StartObjCMethod(const ObjCMethodDecl *OMD,
David Blaikief1425802015-01-14 00:04:42 +0000750 const ObjCContainerDecl *CD) {
Stephen Kellyf2ceec42018-08-09 21:08:08 +0000751 SourceLocation StartLoc = OMD->getBeginLoc();
John McCalla738c252011-03-09 04:27:21 +0000752 FunctionArgList args;
Devang Patela2c048e2010-04-05 21:09:15 +0000753 // Check if we should generate debug info for this method.
David Blaikie92848de2013-08-26 20:33:21 +0000754 if (OMD->hasAttr<NoDebugAttr>())
Craig Topper8a13c412014-05-21 05:09:00 +0000755 DebugInfo = nullptr; // disable debug info indefinitely for this function
Devang Patela2c048e2010-04-05 21:09:15 +0000756
Fariborz Jahanian0196a1c2009-01-10 21:06:09 +0000757 llvm::Function *Fn = CGM.getObjCRuntime().GenerateMethod(OMD, CD);
Daniel Dunbar449a3392008-09-04 23:41:35 +0000758
John McCalla729c622012-02-17 03:33:10 +0000759 const CGFunctionInfo &FI = CGM.getTypes().arrangeObjCMethodDeclaration(OMD);
Pierre Habouzitd4e1ba32019-11-07 23:14:58 -0800760 if (OMD->isDirectMethod()) {
761 Fn->setVisibility(llvm::Function::HiddenVisibility);
762 CGM.SetLLVMFunctionAttributes(OMD, FI, Fn);
763 CGM.SetLLVMFunctionAttributesForDefinition(OMD, Fn);
764 } else {
765 CGM.SetInternalFunctionAttributes(OMD, Fn, FI);
766 }
Chris Lattner5696e7b2008-06-17 18:05:57 +0000767
John McCalla738c252011-03-09 04:27:21 +0000768 args.push_back(OMD->getSelfDecl());
769 args.push_back(OMD->getCmdDecl());
Chris Lattner5696e7b2008-06-17 18:05:57 +0000770
Benjamin Kramerf9890422015-02-17 16:48:30 +0000771 args.append(OMD->param_begin(), OMD->param_end());
Chris Lattner5696e7b2008-06-17 18:05:57 +0000772
Peter Collingbourne0ff0b372011-01-13 18:57:25 +0000773 CurGD = OMD;
Stephen Kelly1c301dc2018-08-09 21:09:38 +0000774 CurEHLocation = OMD->getEndLoc();
Peter Collingbourne0ff0b372011-01-13 18:57:25 +0000775
Adrian Prantl42d71b92014-04-10 23:21:53 +0000776 StartFunction(OMD, OMD->getReturnType(), Fn, FI, args,
777 OMD->getLocation(), StartLoc);
John McCall31168b02011-06-15 23:02:42 +0000778
Pierre Habouzitd4e1ba32019-11-07 23:14:58 -0800779 if (OMD->isDirectMethod()) {
780 // This function is a direct call, it has to implement a nil check
781 // on entry.
782 //
783 // TODO: possibly have several entry points to elide the check
784 CGM.getObjCRuntime().GenerateDirectMethodPrologue(*this, Fn, OMD, CD);
785 }
786
John McCall31168b02011-06-15 23:02:42 +0000787 // In ARC, certain methods get an extra cleanup.
David Blaikiebbafb8a2012-03-11 07:00:24 +0000788 if (CGM.getLangOpts().ObjCAutoRefCount &&
John McCall31168b02011-06-15 23:02:42 +0000789 OMD->isInstanceMethod() &&
790 OMD->getSelector().isUnarySelector()) {
Fangrui Song6907ce22018-07-30 19:24:48 +0000791 const IdentifierInfo *ident =
John McCall31168b02011-06-15 23:02:42 +0000792 OMD->getSelector().getIdentifierInfoForSlot(0);
793 if (ident->isStr("dealloc"))
794 EHStack.pushCleanup<FinishARCDealloc>(getARCCleanupKind());
795 }
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000796}
Daniel Dunbara94ecd22008-08-16 03:19:19 +0000797
John McCall31168b02011-06-15 23:02:42 +0000798static llvm::Value *emitARCRetainLoadOfScalar(CodeGenFunction &CGF,
799 LValue lvalue, QualType type);
800
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000801/// Generate an Objective-C method. An Objective-C method is a C function with
Raphael Isemannb23ccec2018-12-10 12:37:46 +0000802/// its pointer, name, and types registered in the class structure.
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000803void CodeGenFunction::GenerateObjCMethod(const ObjCMethodDecl *OMD) {
David Blaikief1425802015-01-14 00:04:42 +0000804 StartObjCMethod(OMD, OMD->getClassInterface());
Serge Pavlov3a561452015-12-06 14:32:39 +0000805 PGO.assignRegionCounters(GlobalDecl(OMD), CurFn);
Adrian Prantl56741e22014-01-07 22:05:55 +0000806 assert(isa<CompoundStmt>(OMD->getBody()));
Justin Bogner66242d62015-04-23 23:06:47 +0000807 incrementProfileCounter(OMD->getBody());
Adrian Prantl56741e22014-01-07 22:05:55 +0000808 EmitCompoundStmtWithoutScope(*cast<CompoundStmt>(OMD->getBody()));
Argyrios Kyrtzidisddcd1322009-06-30 02:35:26 +0000809 FinishFunction(OMD->getBodyRBrace());
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000810}
811
John McCallb923ece2011-09-12 23:06:44 +0000812/// emitStructGetterCall - Call the runtime function to load a property
813/// into the return value slot.
Fangrui Song6907ce22018-07-30 19:24:48 +0000814static void emitStructGetterCall(CodeGenFunction &CGF, ObjCIvarDecl *ivar,
John McCallb923ece2011-09-12 23:06:44 +0000815 bool isAtomic, bool hasStrong) {
816 ASTContext &Context = CGF.getContext();
817
John McCall7f416cc2015-09-08 08:05:57 +0000818 Address src =
Akira Hatanakaf139ae32019-12-03 15:17:01 -0800819 CGF.EmitLValueForIvar(CGF.TypeOfSelfObject(), CGF.LoadObjCSelf(), ivar, 0)
820 .getAddress(CGF);
John McCallb923ece2011-09-12 23:06:44 +0000821
Fangrui Song6907ce22018-07-30 19:24:48 +0000822 // objc_copyStruct (ReturnValue, &structIvar,
John McCallb923ece2011-09-12 23:06:44 +0000823 // sizeof (Type of Ivar), isAtomic, false);
824 CallArgList args;
825
John McCall7f416cc2015-09-08 08:05:57 +0000826 Address dest = CGF.Builder.CreateBitCast(CGF.ReturnValue, CGF.VoidPtrTy);
827 args.add(RValue::get(dest.getPointer()), Context.VoidPtrTy);
John McCallb923ece2011-09-12 23:06:44 +0000828
829 src = CGF.Builder.CreateBitCast(src, CGF.VoidPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +0000830 args.add(RValue::get(src.getPointer()), Context.VoidPtrTy);
John McCallb923ece2011-09-12 23:06:44 +0000831
832 CharUnits size = CGF.getContext().getTypeSizeInChars(ivar->getType());
833 args.add(RValue::get(CGF.CGM.getSize(size)), Context.getSizeType());
834 args.add(RValue::get(CGF.Builder.getInt1(isAtomic)), Context.BoolTy);
835 args.add(RValue::get(CGF.Builder.getInt1(hasStrong)), Context.BoolTy);
836
James Y Knight9871db02019-02-05 16:42:33 +0000837 llvm::FunctionCallee fn = CGF.CGM.getObjCRuntime().GetGetStructFunction();
John McCallb92ab1a2016-10-26 23:46:34 +0000838 CGCallee callee = CGCallee::forDirect(fn);
John McCallc56a8b32016-03-11 04:30:31 +0000839 CGF.EmitCall(CGF.getTypes().arrangeBuiltinFunctionCall(Context.VoidTy, args),
John McCallb92ab1a2016-10-26 23:46:34 +0000840 callee, ReturnValueSlot(), args);
John McCallb923ece2011-09-12 23:06:44 +0000841}
842
John McCallf4528ae2011-09-13 03:34:09 +0000843/// Determine whether the given architecture supports unaligned atomic
844/// accesses. They don't have to be fast, just faster than a function
845/// call and a mutex.
846static bool hasUnalignedAtomics(llvm::Triple::ArchType arch) {
Eli Friedman5be3e6a2011-09-13 20:48:30 +0000847 // FIXME: Allow unaligned atomic load/store on x86. (It is not
848 // currently supported by the backend.)
849 return 0;
John McCallf4528ae2011-09-13 03:34:09 +0000850}
851
852/// Return the maximum size that permits atomic accesses for the given
853/// architecture.
854static CharUnits getMaxAtomicAccessSize(CodeGenModule &CGM,
855 llvm::Triple::ArchType arch) {
856 // ARM has 8-byte atomic accesses, but it's not clear whether we
857 // want to rely on them here.
858
859 // In the default case, just assume that any size up to a pointer is
860 // fine given adequate alignment.
861 return CharUnits::fromQuantity(CGM.PointerSizeInBytes);
862}
863
864namespace {
865 class PropertyImplStrategy {
866 public:
867 enum StrategyKind {
868 /// The 'native' strategy is to use the architecture's provided
869 /// reads and writes.
870 Native,
871
872 /// Use objc_setProperty and objc_getProperty.
873 GetSetProperty,
874
875 /// Use objc_setProperty for the setter, but use expression
876 /// evaluation for the getter.
877 SetPropertyAndExpressionGet,
878
879 /// Use objc_copyStruct.
880 CopyStruct,
881
882 /// The 'expression' strategy is to emit normal assignment or
883 /// lvalue-to-rvalue expressions.
884 Expression
885 };
886
887 StrategyKind getKind() const { return StrategyKind(Kind); }
888
889 bool hasStrongMember() const { return HasStrong; }
890 bool isAtomic() const { return IsAtomic; }
891 bool isCopy() const { return IsCopy; }
892
893 CharUnits getIvarSize() const { return IvarSize; }
894 CharUnits getIvarAlignment() const { return IvarAlignment; }
895
896 PropertyImplStrategy(CodeGenModule &CGM,
897 const ObjCPropertyImplDecl *propImpl);
898
899 private:
900 unsigned Kind : 8;
901 unsigned IsAtomic : 1;
902 unsigned IsCopy : 1;
903 unsigned HasStrong : 1;
904
905 CharUnits IvarSize;
906 CharUnits IvarAlignment;
907 };
Alexander Kornienkoab9db512015-06-22 23:07:51 +0000908}
John McCallf4528ae2011-09-13 03:34:09 +0000909
Sylvestre Ledru830885c2012-07-23 08:59:39 +0000910/// Pick an implementation strategy for the given property synthesis.
John McCallf4528ae2011-09-13 03:34:09 +0000911PropertyImplStrategy::PropertyImplStrategy(CodeGenModule &CGM,
912 const ObjCPropertyImplDecl *propImpl) {
913 const ObjCPropertyDecl *prop = propImpl->getPropertyDecl();
John McCall43192862011-09-13 18:31:23 +0000914 ObjCPropertyDecl::SetterKind setterKind = prop->getSetterKind();
John McCallf4528ae2011-09-13 03:34:09 +0000915
John McCall43192862011-09-13 18:31:23 +0000916 IsCopy = (setterKind == ObjCPropertyDecl::Copy);
917 IsAtomic = prop->isAtomic();
John McCallf4528ae2011-09-13 03:34:09 +0000918 HasStrong = false; // doesn't matter here.
919
920 // Evaluate the ivar's size and alignment.
921 ObjCIvarDecl *ivar = propImpl->getPropertyIvarDecl();
922 QualType ivarType = ivar->getType();
Bevin Hansson101309f2020-08-24 10:19:29 +0200923 auto TInfo = CGM.getContext().getTypeInfoInChars(ivarType);
924 IvarSize = TInfo.Width;
925 IvarAlignment = TInfo.Align;
John McCallf4528ae2011-09-13 03:34:09 +0000926
927 // If we have a copy property, we always have to use getProperty/setProperty.
John McCall43192862011-09-13 18:31:23 +0000928 // TODO: we could actually use setProperty and an expression for non-atomics.
John McCallf4528ae2011-09-13 03:34:09 +0000929 if (IsCopy) {
930 Kind = GetSetProperty;
931 return;
932 }
933
John McCall43192862011-09-13 18:31:23 +0000934 // Handle retain.
935 if (setterKind == ObjCPropertyDecl::Retain) {
John McCallf4528ae2011-09-13 03:34:09 +0000936 // In GC-only, there's nothing special that needs to be done.
David Blaikiebbafb8a2012-03-11 07:00:24 +0000937 if (CGM.getLangOpts().getGC() == LangOptions::GCOnly) {
John McCallf4528ae2011-09-13 03:34:09 +0000938 // fallthrough
939
940 // In ARC, if the property is non-atomic, use expression emission,
941 // which translates to objc_storeStrong. This isn't required, but
942 // it's slightly nicer.
David Blaikiebbafb8a2012-03-11 07:00:24 +0000943 } else if (CGM.getLangOpts().ObjCAutoRefCount && !IsAtomic) {
John McCalld8561f02012-08-20 23:36:59 +0000944 // Using standard expression emission for the setter is only
945 // acceptable if the ivar is __strong, which won't be true if
946 // the property is annotated with __attribute__((NSObject)).
947 // TODO: falling all the way back to objc_setProperty here is
948 // just laziness, though; we could still use objc_storeStrong
949 // if we hacked it right.
950 if (ivarType.getObjCLifetime() == Qualifiers::OCL_Strong)
951 Kind = Expression;
952 else
953 Kind = SetPropertyAndExpressionGet;
John McCallf4528ae2011-09-13 03:34:09 +0000954 return;
955
956 // Otherwise, we need to at least use setProperty. However, if
957 // the property isn't atomic, we can use normal expression
958 // emission for the getter.
959 } else if (!IsAtomic) {
960 Kind = SetPropertyAndExpressionGet;
961 return;
962
963 // Otherwise, we have to use both setProperty and getProperty.
964 } else {
965 Kind = GetSetProperty;
966 return;
967 }
968 }
969
970 // If we're not atomic, just use expression accesses.
971 if (!IsAtomic) {
972 Kind = Expression;
973 return;
974 }
975
John McCall0e5c0862011-09-13 05:36:29 +0000976 // Properties on bitfield ivars need to be emitted using expression
977 // accesses even if they're nominally atomic.
978 if (ivar->isBitField()) {
979 Kind = Expression;
980 return;
981 }
982
John McCallf4528ae2011-09-13 03:34:09 +0000983 // GC-qualified or ARC-qualified ivars need to be emitted as
984 // expressions. This actually works out to being atomic anyway,
985 // except for ARC __strong, but that should trigger the above code.
986 if (ivarType.hasNonTrivialObjCLifetime() ||
David Blaikiebbafb8a2012-03-11 07:00:24 +0000987 (CGM.getLangOpts().getGC() &&
John McCallf4528ae2011-09-13 03:34:09 +0000988 CGM.getContext().getObjCGCAttrKind(ivarType))) {
989 Kind = Expression;
990 return;
991 }
992
993 // Compute whether the ivar has strong members.
David Blaikiebbafb8a2012-03-11 07:00:24 +0000994 if (CGM.getLangOpts().getGC())
John McCallf4528ae2011-09-13 03:34:09 +0000995 if (const RecordType *recordType = ivarType->getAs<RecordType>())
996 HasStrong = recordType->getDecl()->hasObjectMember();
997
998 // We can never access structs with object members with a native
999 // access, because we need to use write barriers. This is what
1000 // objc_copyStruct is for.
1001 if (HasStrong) {
1002 Kind = CopyStruct;
1003 return;
1004 }
1005
1006 // Otherwise, this is target-dependent and based on the size and
1007 // alignment of the ivar.
John McCall0bef0ba2011-09-13 07:33:34 +00001008
1009 // If the size of the ivar is not a power of two, give up. We don't
1010 // want to get into the business of doing compare-and-swaps.
1011 if (!IvarSize.isPowerOfTwo()) {
1012 Kind = CopyStruct;
1013 return;
1014 }
1015
John McCallf4528ae2011-09-13 03:34:09 +00001016 llvm::Triple::ArchType arch =
John McCallc8e01702013-04-16 22:48:15 +00001017 CGM.getTarget().getTriple().getArch();
John McCallf4528ae2011-09-13 03:34:09 +00001018
1019 // Most architectures require memory to fit within a single cache
1020 // line, so the alignment has to be at least the size of the access.
1021 // Otherwise we have to grab a lock.
1022 if (IvarAlignment < IvarSize && !hasUnalignedAtomics(arch)) {
1023 Kind = CopyStruct;
1024 return;
1025 }
1026
1027 // If the ivar's size exceeds the architecture's maximum atomic
1028 // access size, we have to use CopyStruct.
1029 if (IvarSize > getMaxAtomicAccessSize(CGM, arch)) {
1030 Kind = CopyStruct;
1031 return;
1032 }
1033
1034 // Otherwise, we can use native loads and stores.
1035 Kind = Native;
1036}
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001037
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001038/// Generate an Objective-C property getter function.
James Dennettbe302452012-06-15 22:10:14 +00001039///
1040/// The given Decl must be an ObjCImplementationDecl. \@synthesize
Steve Naroff5a7dd782009-01-10 22:55:25 +00001041/// is illegal within a category.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001042void CodeGenFunction::GenerateObjCGetter(ObjCImplementationDecl *IMP,
1043 const ObjCPropertyImplDecl *PID) {
David Blaikie8e6c36e2014-10-14 16:43:46 +00001044 llvm::Constant *AtomicHelperFn =
1045 CodeGenFunction(CGM).GenerateObjCAtomicGetterCopyHelperFunction(PID);
Adrian Prantl2073dd22019-11-04 14:28:14 -08001046 ObjCMethodDecl *OMD = PID->getGetterMethodDecl();
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001047 assert(OMD && "Invalid call to generate getter (empty method)");
David Blaikief1425802015-01-14 00:04:42 +00001048 StartObjCMethod(OMD, IMP->getClassInterface());
Mike Stump11289f42009-09-09 15:08:12 +00001049
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +00001050 generateObjCGetterBody(IMP, PID, OMD, AtomicHelperFn);
John McCallf4528ae2011-09-13 03:34:09 +00001051
Adrian Prantlce7d3592019-12-05 12:26:16 -08001052 FinishFunction(OMD->getEndLoc());
John McCallf4528ae2011-09-13 03:34:09 +00001053}
1054
John McCallbdd81852011-09-13 06:00:03 +00001055static bool hasTrivialGetExpr(const ObjCPropertyImplDecl *propImpl) {
1056 const Expr *getter = propImpl->getGetterCXXConstructor();
John McCallf4528ae2011-09-13 03:34:09 +00001057 if (!getter) return true;
1058
1059 // Sema only makes only of these when the ivar has a C++ class type,
1060 // so the form is pretty constrained.
1061
John McCallbdd81852011-09-13 06:00:03 +00001062 // If the property has a reference type, we might just be binding a
1063 // reference, in which case the result will be a gl-value. We should
1064 // treat this as a non-trivial operation.
1065 if (getter->isGLValue())
1066 return false;
1067
John McCallf4528ae2011-09-13 03:34:09 +00001068 // If we selected a trivial copy-constructor, we're okay.
1069 if (const CXXConstructExpr *construct = dyn_cast<CXXConstructExpr>(getter))
1070 return (construct->getConstructor()->isTrivial());
1071
1072 // The constructor might require cleanups (in which case it's never
1073 // trivial).
1074 assert(isa<ExprWithCleanups>(getter));
1075 return false;
1076}
1077
Fangrui Song6907ce22018-07-30 19:24:48 +00001078/// emitCPPObjectAtomicGetterCall - Call the runtime function to
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00001079/// copy the ivar into the resturn slot.
Fangrui Song6907ce22018-07-30 19:24:48 +00001080static void emitCPPObjectAtomicGetterCall(CodeGenFunction &CGF,
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00001081 llvm::Value *returnAddr,
1082 ObjCIvarDecl *ivar,
1083 llvm::Constant *AtomicHelperFn) {
1084 // objc_copyCppObjectAtomic (&returnSlot, &CppObjectIvar,
1085 // AtomicHelperFn);
1086 CallArgList args;
Fangrui Song6907ce22018-07-30 19:24:48 +00001087
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00001088 // The 1st argument is the return Slot.
1089 args.add(RValue::get(returnAddr), CGF.getContext().VoidPtrTy);
Fangrui Song6907ce22018-07-30 19:24:48 +00001090
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00001091 // The 2nd argument is the address of the ivar.
Fangrui Song6907ce22018-07-30 19:24:48 +00001092 llvm::Value *ivarAddr =
Akira Hatanakaf139ae32019-12-03 15:17:01 -08001093 CGF.EmitLValueForIvar(CGF.TypeOfSelfObject(), CGF.LoadObjCSelf(), ivar, 0)
1094 .getPointer(CGF);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00001095 ivarAddr = CGF.Builder.CreateBitCast(ivarAddr, CGF.Int8PtrTy);
1096 args.add(RValue::get(ivarAddr), CGF.getContext().VoidPtrTy);
Fangrui Song6907ce22018-07-30 19:24:48 +00001097
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00001098 // Third argument is the helper function.
1099 args.add(RValue::get(AtomicHelperFn), CGF.getContext().VoidPtrTy);
Fangrui Song6907ce22018-07-30 19:24:48 +00001100
James Y Knight9871db02019-02-05 16:42:33 +00001101 llvm::FunctionCallee copyCppAtomicObjectFn =
1102 CGF.CGM.getObjCRuntime().GetCppAtomicObjectGetFunction();
John McCallb92ab1a2016-10-26 23:46:34 +00001103 CGCallee callee = CGCallee::forDirect(copyCppAtomicObjectFn);
John McCallc56a8b32016-03-11 04:30:31 +00001104 CGF.EmitCall(
1105 CGF.getTypes().arrangeBuiltinFunctionCall(CGF.getContext().VoidTy, args),
John McCallb92ab1a2016-10-26 23:46:34 +00001106 callee, ReturnValueSlot(), args);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00001107}
1108
John McCallf4528ae2011-09-13 03:34:09 +00001109void
1110CodeGenFunction::generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001111 const ObjCPropertyImplDecl *propImpl,
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +00001112 const ObjCMethodDecl *GetterMethodDecl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001113 llvm::Constant *AtomicHelperFn) {
John McCallf4528ae2011-09-13 03:34:09 +00001114 // If there's a non-trivial 'get' expression, we just have to emit that.
1115 if (!hasTrivialGetExpr(propImpl)) {
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00001116 if (!AtomicHelperFn) {
Bruno Ricci023b1d12018-10-30 14:40:49 +00001117 auto *ret = ReturnStmt::Create(getContext(), SourceLocation(),
1118 propImpl->getGetterCXXConstructor(),
1119 /* NRVOCandidate=*/nullptr);
1120 EmitReturnStmt(*ret);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00001121 }
1122 else {
1123 ObjCIvarDecl *ivar = propImpl->getPropertyIvarDecl();
Fangrui Song6907ce22018-07-30 19:24:48 +00001124 emitCPPObjectAtomicGetterCall(*this, ReturnValue.getPointer(),
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00001125 ivar, AtomicHelperFn);
1126 }
John McCallf4528ae2011-09-13 03:34:09 +00001127 return;
1128 }
1129
1130 const ObjCPropertyDecl *prop = propImpl->getPropertyDecl();
1131 QualType propType = prop->getType();
Adrian Prantl2073dd22019-11-04 14:28:14 -08001132 ObjCMethodDecl *getterMethod = propImpl->getGetterMethodDecl();
John McCallf4528ae2011-09-13 03:34:09 +00001133
Fangrui Song6907ce22018-07-30 19:24:48 +00001134 ObjCIvarDecl *ivar = propImpl->getPropertyIvarDecl();
John McCallf4528ae2011-09-13 03:34:09 +00001135
1136 // Pick an implementation strategy.
1137 PropertyImplStrategy strategy(CGM, propImpl);
1138 switch (strategy.getKind()) {
1139 case PropertyImplStrategy::Native: {
Eli Friedman0e846022012-10-26 22:38:05 +00001140 // We don't need to do anything for a zero-size struct.
1141 if (strategy.getIvarSize().isZero())
1142 return;
1143
John McCallf4528ae2011-09-13 03:34:09 +00001144 LValue LV = EmitLValueForIvar(TypeOfSelfObject(), LoadObjCSelf(), ivar, 0);
1145
1146 // Currently, all atomic accesses have to be through integer
1147 // types, so there's no point in trying to pick a prettier type.
Akira Hatanakade6f25f2016-05-26 00:37:30 +00001148 uint64_t ivarSize = getContext().toBits(strategy.getIvarSize());
1149 llvm::Type *bitcastType = llvm::Type::getIntNTy(getLLVMContext(), ivarSize);
John McCallf4528ae2011-09-13 03:34:09 +00001150 bitcastType = bitcastType->getPointerTo(); // addrspace 0 okay
1151
1152 // Perform an atomic load. This does not impose ordering constraints.
Akira Hatanakaf139ae32019-12-03 15:17:01 -08001153 Address ivarAddr = LV.getAddress(*this);
John McCallf4528ae2011-09-13 03:34:09 +00001154 ivarAddr = Builder.CreateBitCast(ivarAddr, bitcastType);
1155 llvm::LoadInst *load = Builder.CreateLoad(ivarAddr, "load");
JF Bastien92f4ef12016-04-06 17:26:42 +00001156 load->setAtomic(llvm::AtomicOrdering::Unordered);
John McCallf4528ae2011-09-13 03:34:09 +00001157
1158 // Store that value into the return address. Doing this with a
1159 // bitcast is likely to produce some pretty ugly IR, but it's not
1160 // the *most* terrible thing in the world.
Akira Hatanakade6f25f2016-05-26 00:37:30 +00001161 llvm::Type *retTy = ConvertType(getterMethod->getReturnType());
1162 uint64_t retTySize = CGM.getDataLayout().getTypeSizeInBits(retTy);
1163 llvm::Value *ivarVal = load;
1164 if (ivarSize > retTySize) {
1165 llvm::Type *newTy = llvm::Type::getIntNTy(getLLVMContext(), retTySize);
1166 ivarVal = Builder.CreateTrunc(load, newTy);
1167 bitcastType = newTy->getPointerTo();
1168 }
1169 Builder.CreateStore(ivarVal,
1170 Builder.CreateBitCast(ReturnValue, bitcastType));
John McCallf4528ae2011-09-13 03:34:09 +00001171
1172 // Make sure we don't do an autorelease.
1173 AutoreleaseResult = false;
1174 return;
1175 }
1176
1177 case PropertyImplStrategy::GetSetProperty: {
James Y Knight9871db02019-02-05 16:42:33 +00001178 llvm::FunctionCallee getPropertyFn =
1179 CGM.getObjCRuntime().GetPropertyGetFunction();
John McCallf4528ae2011-09-13 03:34:09 +00001180 if (!getPropertyFn) {
1181 CGM.ErrorUnsupported(propImpl, "Obj-C getter requiring atomic copy");
Daniel Dunbara08dff12008-09-24 04:04:31 +00001182 return;
1183 }
John McCallb92ab1a2016-10-26 23:46:34 +00001184 CGCallee callee = CGCallee::forDirect(getPropertyFn);
Daniel Dunbara08dff12008-09-24 04:04:31 +00001185
1186 // Return (ivar-type) objc_getProperty((id) self, _cmd, offset, true).
1187 // FIXME: Can't this be simpler? This might even be worse than the
1188 // corresponding gcc code.
John McCallf4528ae2011-09-13 03:34:09 +00001189 llvm::Value *cmd =
John McCall7f416cc2015-09-08 08:05:57 +00001190 Builder.CreateLoad(GetAddrOfLocalVar(getterMethod->getCmdDecl()), "cmd");
John McCallf4528ae2011-09-13 03:34:09 +00001191 llvm::Value *self = Builder.CreateBitCast(LoadObjCSelf(), VoidPtrTy);
1192 llvm::Value *ivarOffset =
1193 EmitIvarOffset(classImpl->getClassInterface(), ivar);
1194
1195 CallArgList args;
1196 args.add(RValue::get(self), getContext().getObjCIdType());
1197 args.add(RValue::get(cmd), getContext().getObjCSelType());
1198 args.add(RValue::get(ivarOffset), getContext().getPointerDiffType());
John McCall43192862011-09-13 18:31:23 +00001199 args.add(RValue::get(Builder.getInt1(strategy.isAtomic())),
1200 getContext().BoolTy);
John McCallf4528ae2011-09-13 03:34:09 +00001201
Daniel Dunbar1ef73732009-02-03 23:43:59 +00001202 // FIXME: We shouldn't need to get the function info here, the
1203 // runtime already should have computed it to build the function.
James Y Knight3933add2019-01-30 02:54:28 +00001204 llvm::CallBase *CallInstruction;
James Y Knightb92d2902019-02-05 16:05:50 +00001205 RValue RV = EmitCall(getTypes().arrangeBuiltinFunctionCall(
1206 getContext().getObjCIdType(), args),
1207 callee, ReturnValueSlot(), args, &CallInstruction);
Fariborz Jahanian13b43042014-01-30 00:16:39 +00001208 if (llvm::CallInst *call = dyn_cast<llvm::CallInst>(CallInstruction))
1209 call->setTailCall();
John McCallf4528ae2011-09-13 03:34:09 +00001210
Daniel Dunbara08dff12008-09-24 04:04:31 +00001211 // We need to fix the type here. Ivars with copy & retain are
1212 // always objects so we don't need to worry about complex or
1213 // aggregates.
Alp Toker314cc812014-01-25 16:55:45 +00001214 RV = RValue::get(Builder.CreateBitCast(
1215 RV.getScalarVal(),
1216 getTypes().ConvertType(getterMethod->getReturnType())));
John McCallf4528ae2011-09-13 03:34:09 +00001217
1218 EmitReturnOfRValue(RV, propType);
John McCall31168b02011-06-15 23:02:42 +00001219
1220 // objc_getProperty does an autorelease, so we should suppress ours.
1221 AutoreleaseResult = false;
John McCall31168b02011-06-15 23:02:42 +00001222
John McCallf4528ae2011-09-13 03:34:09 +00001223 return;
1224 }
1225
1226 case PropertyImplStrategy::CopyStruct:
1227 emitStructGetterCall(*this, ivar, strategy.isAtomic(),
1228 strategy.hasStrongMember());
1229 return;
1230
1231 case PropertyImplStrategy::Expression:
1232 case PropertyImplStrategy::SetPropertyAndExpressionGet: {
1233 LValue LV = EmitLValueForIvar(TypeOfSelfObject(), LoadObjCSelf(), ivar, 0);
1234
1235 QualType ivarType = ivar->getType();
John McCall47fb9502013-03-07 21:37:08 +00001236 switch (getEvaluationKind(ivarType)) {
1237 case TEK_Complex: {
Nick Lewycky2d84e842013-10-02 02:29:49 +00001238 ComplexPairTy pair = EmitLoadOfComplex(LV, SourceLocation());
John McCall7f416cc2015-09-08 08:05:57 +00001239 EmitStoreOfComplex(pair, MakeAddrLValue(ReturnValue, ivarType),
John McCall47fb9502013-03-07 21:37:08 +00001240 /*init*/ true);
1241 return;
1242 }
Ivan A. Kosarev1860b522018-01-25 14:21:55 +00001243 case TEK_Aggregate: {
John McCallf4528ae2011-09-13 03:34:09 +00001244 // The return value slot is guaranteed to not be aliased, but
1245 // that's not necessarily the same as "on the stack", so
1246 // we still potentially need objc_memmove_collectable.
Ivan A. Kosarev1860b522018-01-25 14:21:55 +00001247 EmitAggregateCopy(/* Dest= */ MakeAddrLValue(ReturnValue, ivarType),
Richard Smith8cca3a52019-06-20 20:56:20 +00001248 /* Src= */ LV, ivarType, getOverlapForReturnValue());
Richard Smithe78fac52018-04-05 20:52:58 +00001249 return;
1250 }
John McCall47fb9502013-03-07 21:37:08 +00001251 case TEK_Scalar: {
John McCall24fada12011-07-22 05:23:13 +00001252 llvm::Value *value;
1253 if (propType->isReferenceType()) {
Akira Hatanakaf139ae32019-12-03 15:17:01 -08001254 value = LV.getAddress(*this).getPointer();
John McCall24fada12011-07-22 05:23:13 +00001255 } else {
1256 // We want to load and autoreleaseReturnValue ARC __weak ivars.
1257 if (LV.getQuals().getObjCLifetime() == Qualifiers::OCL_Weak) {
John McCall460ce582015-10-22 18:38:17 +00001258 if (getLangOpts().ObjCAutoRefCount) {
1259 value = emitARCRetainLoadOfScalar(*this, LV, ivarType);
1260 } else {
Akira Hatanakaf139ae32019-12-03 15:17:01 -08001261 value = EmitARCLoadWeak(LV.getAddress(*this));
John McCall460ce582015-10-22 18:38:17 +00001262 }
John McCall24fada12011-07-22 05:23:13 +00001263
1264 // Otherwise we want to do a simple load, suppressing the
1265 // final autorelease.
John McCall31168b02011-06-15 23:02:42 +00001266 } else {
Nick Lewycky2d84e842013-10-02 02:29:49 +00001267 value = EmitLoadOfLValue(LV, SourceLocation()).getScalarVal();
John McCall24fada12011-07-22 05:23:13 +00001268 AutoreleaseResult = false;
Fariborz Jahanianb24b5682011-03-28 23:47:18 +00001269 }
John McCall31168b02011-06-15 23:02:42 +00001270
Alp Toker314cc812014-01-25 16:55:45 +00001271 value = Builder.CreateBitCast(
1272 value, ConvertType(GetterMethodDecl->getReturnType()));
John McCall24fada12011-07-22 05:23:13 +00001273 }
Fangrui Song6907ce22018-07-30 19:24:48 +00001274
John McCall24fada12011-07-22 05:23:13 +00001275 EmitReturnOfRValue(RValue::get(value), propType);
John McCall47fb9502013-03-07 21:37:08 +00001276 return;
Fariborz Jahanianeab5ecd2009-03-03 18:49:40 +00001277 }
John McCall47fb9502013-03-07 21:37:08 +00001278 }
1279 llvm_unreachable("bad evaluation kind");
Daniel Dunbara08dff12008-09-24 04:04:31 +00001280 }
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001281
John McCallf4528ae2011-09-13 03:34:09 +00001282 }
1283 llvm_unreachable("bad @property implementation strategy!");
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001284}
1285
John McCallb923ece2011-09-12 23:06:44 +00001286/// emitStructSetterCall - Call the runtime function to store the value
1287/// from the first formal parameter into the given ivar.
1288static void emitStructSetterCall(CodeGenFunction &CGF, ObjCMethodDecl *OMD,
1289 ObjCIvarDecl *ivar) {
Fangrui Song6907ce22018-07-30 19:24:48 +00001290 // objc_copyStruct (&structIvar, &Arg,
Fariborz Jahanian302a3d42011-02-18 19:15:13 +00001291 // sizeof (struct something), true, false);
John McCall6acaef92011-09-10 09:30:49 +00001292 CallArgList args;
1293
1294 // The first argument is the address of the ivar.
Akira Hatanakaf139ae32019-12-03 15:17:01 -08001295 llvm::Value *ivarAddr =
1296 CGF.EmitLValueForIvar(CGF.TypeOfSelfObject(), CGF.LoadObjCSelf(), ivar, 0)
1297 .getPointer(CGF);
John McCallb923ece2011-09-12 23:06:44 +00001298 ivarAddr = CGF.Builder.CreateBitCast(ivarAddr, CGF.Int8PtrTy);
1299 args.add(RValue::get(ivarAddr), CGF.getContext().VoidPtrTy);
John McCall6acaef92011-09-10 09:30:49 +00001300
1301 // The second argument is the address of the parameter variable.
John McCallb923ece2011-09-12 23:06:44 +00001302 ParmVarDecl *argVar = *OMD->param_begin();
Bruno Ricci5fc4db72018-12-21 14:10:18 +00001303 DeclRefExpr argRef(CGF.getContext(), argVar, false,
1304 argVar->getType().getNonReferenceType(), VK_LValue,
1305 SourceLocation());
Akira Hatanakaf139ae32019-12-03 15:17:01 -08001306 llvm::Value *argAddr = CGF.EmitLValue(&argRef).getPointer(CGF);
John McCallb923ece2011-09-12 23:06:44 +00001307 argAddr = CGF.Builder.CreateBitCast(argAddr, CGF.Int8PtrTy);
1308 args.add(RValue::get(argAddr), CGF.getContext().VoidPtrTy);
John McCall6acaef92011-09-10 09:30:49 +00001309
1310 // The third argument is the sizeof the type.
1311 llvm::Value *size =
John McCallb923ece2011-09-12 23:06:44 +00001312 CGF.CGM.getSize(CGF.getContext().getTypeSizeInChars(ivar->getType()));
1313 args.add(RValue::get(size), CGF.getContext().getSizeType());
John McCall6acaef92011-09-10 09:30:49 +00001314
John McCallb923ece2011-09-12 23:06:44 +00001315 // The fourth argument is the 'isAtomic' flag.
1316 args.add(RValue::get(CGF.Builder.getTrue()), CGF.getContext().BoolTy);
John McCall6acaef92011-09-10 09:30:49 +00001317
John McCallb923ece2011-09-12 23:06:44 +00001318 // The fifth argument is the 'hasStrong' flag.
1319 // FIXME: should this really always be false?
1320 args.add(RValue::get(CGF.Builder.getFalse()), CGF.getContext().BoolTy);
1321
James Y Knight9871db02019-02-05 16:42:33 +00001322 llvm::FunctionCallee fn = CGF.CGM.getObjCRuntime().GetSetStructFunction();
John McCallb92ab1a2016-10-26 23:46:34 +00001323 CGCallee callee = CGCallee::forDirect(fn);
John McCallc56a8b32016-03-11 04:30:31 +00001324 CGF.EmitCall(
1325 CGF.getTypes().arrangeBuiltinFunctionCall(CGF.getContext().VoidTy, args),
John McCallb92ab1a2016-10-26 23:46:34 +00001326 callee, ReturnValueSlot(), args);
Fariborz Jahanian302a3d42011-02-18 19:15:13 +00001327}
1328
Fangrui Song6907ce22018-07-30 19:24:48 +00001329/// emitCPPObjectAtomicSetterCall - Call the runtime function to store
1330/// the value from the first formal parameter into the given ivar, using
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001331/// the Cpp API for atomic Cpp objects with non-trivial copy assignment.
Fangrui Song6907ce22018-07-30 19:24:48 +00001332static void emitCPPObjectAtomicSetterCall(CodeGenFunction &CGF,
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001333 ObjCMethodDecl *OMD,
1334 ObjCIvarDecl *ivar,
1335 llvm::Constant *AtomicHelperFn) {
Fangrui Song6907ce22018-07-30 19:24:48 +00001336 // objc_copyCppObjectAtomic (&CppObjectIvar, &Arg,
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001337 // AtomicHelperFn);
1338 CallArgList args;
Fangrui Song6907ce22018-07-30 19:24:48 +00001339
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001340 // The first argument is the address of the ivar.
Fangrui Song6907ce22018-07-30 19:24:48 +00001341 llvm::Value *ivarAddr =
Akira Hatanakaf139ae32019-12-03 15:17:01 -08001342 CGF.EmitLValueForIvar(CGF.TypeOfSelfObject(), CGF.LoadObjCSelf(), ivar, 0)
1343 .getPointer(CGF);
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001344 ivarAddr = CGF.Builder.CreateBitCast(ivarAddr, CGF.Int8PtrTy);
1345 args.add(RValue::get(ivarAddr), CGF.getContext().VoidPtrTy);
Fangrui Song6907ce22018-07-30 19:24:48 +00001346
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001347 // The second argument is the address of the parameter variable.
1348 ParmVarDecl *argVar = *OMD->param_begin();
Bruno Ricci5fc4db72018-12-21 14:10:18 +00001349 DeclRefExpr argRef(CGF.getContext(), argVar, false,
1350 argVar->getType().getNonReferenceType(), VK_LValue,
1351 SourceLocation());
Akira Hatanakaf139ae32019-12-03 15:17:01 -08001352 llvm::Value *argAddr = CGF.EmitLValue(&argRef).getPointer(CGF);
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001353 argAddr = CGF.Builder.CreateBitCast(argAddr, CGF.Int8PtrTy);
1354 args.add(RValue::get(argAddr), CGF.getContext().VoidPtrTy);
Fangrui Song6907ce22018-07-30 19:24:48 +00001355
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001356 // Third argument is the helper function.
1357 args.add(RValue::get(AtomicHelperFn), CGF.getContext().VoidPtrTy);
Fangrui Song6907ce22018-07-30 19:24:48 +00001358
James Y Knight9871db02019-02-05 16:42:33 +00001359 llvm::FunctionCallee fn =
1360 CGF.CGM.getObjCRuntime().GetCppAtomicObjectSetFunction();
John McCallb92ab1a2016-10-26 23:46:34 +00001361 CGCallee callee = CGCallee::forDirect(fn);
John McCallc56a8b32016-03-11 04:30:31 +00001362 CGF.EmitCall(
1363 CGF.getTypes().arrangeBuiltinFunctionCall(CGF.getContext().VoidTy, args),
John McCallb92ab1a2016-10-26 23:46:34 +00001364 callee, ReturnValueSlot(), args);
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001365}
1366
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00001367
John McCallf4528ae2011-09-13 03:34:09 +00001368static bool hasTrivialSetExpr(const ObjCPropertyImplDecl *PID) {
1369 Expr *setter = PID->getSetterCXXAssignment();
1370 if (!setter) return true;
1371
1372 // Sema only makes only of these when the ivar has a C++ class type,
1373 // so the form is pretty constrained.
John McCall7f16c422011-09-10 09:17:20 +00001374
1375 // An operator call is trivial if the function it calls is trivial.
John McCallf4528ae2011-09-13 03:34:09 +00001376 // This also implies that there's nothing non-trivial going on with
1377 // the arguments, because operator= can only be trivial if it's a
1378 // synthesized assignment operator and therefore both parameters are
1379 // references.
1380 if (CallExpr *call = dyn_cast<CallExpr>(setter)) {
John McCall7f16c422011-09-10 09:17:20 +00001381 if (const FunctionDecl *callee
1382 = dyn_cast_or_null<FunctionDecl>(call->getCalleeDecl()))
1383 if (callee->isTrivial())
1384 return true;
1385 return false;
Fariborz Jahanian5de53132011-04-06 16:05:26 +00001386 }
John McCall7f16c422011-09-10 09:17:20 +00001387
John McCallf4528ae2011-09-13 03:34:09 +00001388 assert(isa<ExprWithCleanups>(setter));
John McCall7f16c422011-09-10 09:17:20 +00001389 return false;
1390}
1391
Benjamin Kramer53ba6362012-03-10 20:38:56 +00001392static bool UseOptimizedSetter(CodeGenModule &CGM) {
David Blaikiebbafb8a2012-03-11 07:00:24 +00001393 if (CGM.getLangOpts().getGC() != LangOptions::NonGC)
Ted Kremeneke65b0862012-03-06 20:05:56 +00001394 return false;
Daniel Dunbarbd847cc2012-10-15 22:23:53 +00001395 return CGM.getLangOpts().ObjCRuntime.hasOptimizedSetter();
Ted Kremeneke65b0862012-03-06 20:05:56 +00001396}
1397
John McCall7f16c422011-09-10 09:17:20 +00001398void
1399CodeGenFunction::generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001400 const ObjCPropertyImplDecl *propImpl,
1401 llvm::Constant *AtomicHelperFn) {
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00001402 ObjCIvarDecl *ivar = propImpl->getPropertyIvarDecl();
Adrian Prantl2073dd22019-11-04 14:28:14 -08001403 ObjCMethodDecl *setterMethod = propImpl->getSetterMethodDecl();
Fangrui Song6907ce22018-07-30 19:24:48 +00001404
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001405 // Just use the setter expression if Sema gave us one and it's
1406 // non-trivial.
1407 if (!hasTrivialSetExpr(propImpl)) {
1408 if (!AtomicHelperFn)
1409 // If non-atomic, assignment is called directly.
1410 EmitStmt(propImpl->getSetterCXXAssignment());
1411 else
1412 // If atomic, assignment is called via a locking api.
1413 emitCPPObjectAtomicSetterCall(*this, setterMethod, ivar,
1414 AtomicHelperFn);
1415 return;
1416 }
John McCall7f16c422011-09-10 09:17:20 +00001417
John McCallf4528ae2011-09-13 03:34:09 +00001418 PropertyImplStrategy strategy(CGM, propImpl);
1419 switch (strategy.getKind()) {
1420 case PropertyImplStrategy::Native: {
Eli Friedman0e846022012-10-26 22:38:05 +00001421 // We don't need to do anything for a zero-size struct.
1422 if (strategy.getIvarSize().isZero())
1423 return;
1424
John McCall7f416cc2015-09-08 08:05:57 +00001425 Address argAddr = GetAddrOfLocalVar(*setterMethod->param_begin());
John McCall7f16c422011-09-10 09:17:20 +00001426
John McCallf4528ae2011-09-13 03:34:09 +00001427 LValue ivarLValue =
1428 EmitLValueForIvar(TypeOfSelfObject(), LoadObjCSelf(), ivar, /*quals*/ 0);
Akira Hatanakaf139ae32019-12-03 15:17:01 -08001429 Address ivarAddr = ivarLValue.getAddress(*this);
John McCall7f16c422011-09-10 09:17:20 +00001430
John McCallf4528ae2011-09-13 03:34:09 +00001431 // Currently, all atomic accesses have to be through integer
1432 // types, so there's no point in trying to pick a prettier type.
1433 llvm::Type *bitcastType =
1434 llvm::Type::getIntNTy(getLLVMContext(),
1435 getContext().toBits(strategy.getIvarSize()));
John McCallf4528ae2011-09-13 03:34:09 +00001436
1437 // Cast both arguments to the chosen operation type.
John McCall7f416cc2015-09-08 08:05:57 +00001438 argAddr = Builder.CreateElementBitCast(argAddr, bitcastType);
1439 ivarAddr = Builder.CreateElementBitCast(ivarAddr, bitcastType);
John McCallf4528ae2011-09-13 03:34:09 +00001440
1441 // This bitcast load is likely to cause some nasty IR.
1442 llvm::Value *load = Builder.CreateLoad(argAddr);
1443
1444 // Perform an atomic store. There are no memory ordering requirements.
1445 llvm::StoreInst *store = Builder.CreateStore(load, ivarAddr);
JF Bastien92f4ef12016-04-06 17:26:42 +00001446 store->setAtomic(llvm::AtomicOrdering::Unordered);
John McCallf4528ae2011-09-13 03:34:09 +00001447 return;
1448 }
1449
1450 case PropertyImplStrategy::GetSetProperty:
1451 case PropertyImplStrategy::SetPropertyAndExpressionGet: {
Craig Topper8a13c412014-05-21 05:09:00 +00001452
James Y Knight9871db02019-02-05 16:42:33 +00001453 llvm::FunctionCallee setOptimizedPropertyFn = nullptr;
1454 llvm::FunctionCallee setPropertyFn = nullptr;
Ted Kremeneke65b0862012-03-06 20:05:56 +00001455 if (UseOptimizedSetter(CGM)) {
Daniel Dunbarbd847cc2012-10-15 22:23:53 +00001456 // 10.8 and iOS 6.0 code and GC is off
Fangrui Song6907ce22018-07-30 19:24:48 +00001457 setOptimizedPropertyFn =
James Y Knight9871db02019-02-05 16:42:33 +00001458 CGM.getObjCRuntime().GetOptimizedPropertySetFunction(
1459 strategy.isAtomic(), strategy.isCopy());
Ted Kremeneke65b0862012-03-06 20:05:56 +00001460 if (!setOptimizedPropertyFn) {
1461 CGM.ErrorUnsupported(propImpl, "Obj-C optimized setter - NYI");
1462 return;
1463 }
John McCall7f16c422011-09-10 09:17:20 +00001464 }
Ted Kremeneke65b0862012-03-06 20:05:56 +00001465 else {
1466 setPropertyFn = CGM.getObjCRuntime().GetPropertySetFunction();
1467 if (!setPropertyFn) {
1468 CGM.ErrorUnsupported(propImpl, "Obj-C setter requiring atomic copy");
1469 return;
1470 }
1471 }
Fangrui Song6907ce22018-07-30 19:24:48 +00001472
John McCall7f16c422011-09-10 09:17:20 +00001473 // Emit objc_setProperty((id) self, _cmd, offset, arg,
1474 // <is-atomic>, <is-copy>).
1475 llvm::Value *cmd =
John McCall7f416cc2015-09-08 08:05:57 +00001476 Builder.CreateLoad(GetAddrOfLocalVar(setterMethod->getCmdDecl()));
John McCall7f16c422011-09-10 09:17:20 +00001477 llvm::Value *self =
1478 Builder.CreateBitCast(LoadObjCSelf(), VoidPtrTy);
1479 llvm::Value *ivarOffset =
1480 EmitIvarOffset(classImpl->getClassInterface(), ivar);
John McCall7f416cc2015-09-08 08:05:57 +00001481 Address argAddr = GetAddrOfLocalVar(*setterMethod->param_begin());
1482 llvm::Value *arg = Builder.CreateLoad(argAddr, "arg");
1483 arg = Builder.CreateBitCast(arg, VoidPtrTy);
John McCall7f16c422011-09-10 09:17:20 +00001484
1485 CallArgList args;
1486 args.add(RValue::get(self), getContext().getObjCIdType());
1487 args.add(RValue::get(cmd), getContext().getObjCSelType());
Ted Kremeneke65b0862012-03-06 20:05:56 +00001488 if (setOptimizedPropertyFn) {
1489 args.add(RValue::get(arg), getContext().getObjCIdType());
1490 args.add(RValue::get(ivarOffset), getContext().getPointerDiffType());
John McCallb92ab1a2016-10-26 23:46:34 +00001491 CGCallee callee = CGCallee::forDirect(setOptimizedPropertyFn);
John McCallc56a8b32016-03-11 04:30:31 +00001492 EmitCall(getTypes().arrangeBuiltinFunctionCall(getContext().VoidTy, args),
John McCallb92ab1a2016-10-26 23:46:34 +00001493 callee, ReturnValueSlot(), args);
Ted Kremeneke65b0862012-03-06 20:05:56 +00001494 } else {
1495 args.add(RValue::get(ivarOffset), getContext().getPointerDiffType());
1496 args.add(RValue::get(arg), getContext().getObjCIdType());
1497 args.add(RValue::get(Builder.getInt1(strategy.isAtomic())),
1498 getContext().BoolTy);
1499 args.add(RValue::get(Builder.getInt1(strategy.isCopy())),
1500 getContext().BoolTy);
1501 // FIXME: We shouldn't need to get the function info here, the runtime
1502 // already should have computed it to build the function.
John McCallb92ab1a2016-10-26 23:46:34 +00001503 CGCallee callee = CGCallee::forDirect(setPropertyFn);
John McCallc56a8b32016-03-11 04:30:31 +00001504 EmitCall(getTypes().arrangeBuiltinFunctionCall(getContext().VoidTy, args),
John McCallb92ab1a2016-10-26 23:46:34 +00001505 callee, ReturnValueSlot(), args);
Ted Kremeneke65b0862012-03-06 20:05:56 +00001506 }
Fangrui Song6907ce22018-07-30 19:24:48 +00001507
John McCall7f16c422011-09-10 09:17:20 +00001508 return;
1509 }
1510
John McCallf4528ae2011-09-13 03:34:09 +00001511 case PropertyImplStrategy::CopyStruct:
John McCallb923ece2011-09-12 23:06:44 +00001512 emitStructSetterCall(*this, setterMethod, ivar);
John McCall7f16c422011-09-10 09:17:20 +00001513 return;
John McCallf4528ae2011-09-13 03:34:09 +00001514
1515 case PropertyImplStrategy::Expression:
1516 break;
John McCall7f16c422011-09-10 09:17:20 +00001517 }
1518
1519 // Otherwise, fake up some ASTs and emit a normal assignment.
1520 ValueDecl *selfDecl = setterMethod->getSelfDecl();
Bruno Ricci5fc4db72018-12-21 14:10:18 +00001521 DeclRefExpr self(getContext(), selfDecl, false, selfDecl->getType(),
John McCall113bee02012-03-10 09:33:50 +00001522 VK_LValue, SourceLocation());
Serge Pavlovf1cd6592020-09-12 21:54:14 +07001523 ImplicitCastExpr selfLoad(ImplicitCastExpr::OnStack, selfDecl->getType(),
1524 CK_LValueToRValue, &self, VK_RValue,
1525 FPOptionsOverride());
John McCall7f16c422011-09-10 09:17:20 +00001526 ObjCIvarRefExpr ivarRef(ivar, ivar->getType().getNonReferenceType(),
Fariborz Jahanianf12ff4df2013-04-02 18:57:54 +00001527 SourceLocation(), SourceLocation(),
1528 &selfLoad, true, true);
John McCall7f16c422011-09-10 09:17:20 +00001529
1530 ParmVarDecl *argDecl = *setterMethod->param_begin();
1531 QualType argType = argDecl->getType().getNonReferenceType();
Bruno Ricci5fc4db72018-12-21 14:10:18 +00001532 DeclRefExpr arg(getContext(), argDecl, false, argType, VK_LValue,
1533 SourceLocation());
John McCall7f16c422011-09-10 09:17:20 +00001534 ImplicitCastExpr argLoad(ImplicitCastExpr::OnStack,
1535 argType.getUnqualifiedType(), CK_LValueToRValue,
Serge Pavlovf1cd6592020-09-12 21:54:14 +07001536 &arg, VK_RValue, FPOptionsOverride());
Fangrui Song6907ce22018-07-30 19:24:48 +00001537
John McCall7f16c422011-09-10 09:17:20 +00001538 // The property type can differ from the ivar type in some situations with
1539 // Objective-C pointer types, we can always bit cast the RHS in these cases.
1540 // The following absurdity is just to ensure well-formed IR.
1541 CastKind argCK = CK_NoOp;
1542 if (ivarRef.getType()->isObjCObjectPointerType()) {
1543 if (argLoad.getType()->isObjCObjectPointerType())
1544 argCK = CK_BitCast;
1545 else if (argLoad.getType()->isBlockPointerType())
1546 argCK = CK_BlockPointerToObjCPointerCast;
1547 else
1548 argCK = CK_CPointerToObjCPointerCast;
1549 } else if (ivarRef.getType()->isBlockPointerType()) {
1550 if (argLoad.getType()->isBlockPointerType())
1551 argCK = CK_BitCast;
1552 else
1553 argCK = CK_AnyPointerToBlockPointerCast;
1554 } else if (ivarRef.getType()->isPointerType()) {
1555 argCK = CK_BitCast;
1556 }
Serge Pavlovf1cd6592020-09-12 21:54:14 +07001557 ImplicitCastExpr argCast(ImplicitCastExpr::OnStack, ivarRef.getType(), argCK,
1558 &argLoad, VK_RValue, FPOptionsOverride());
John McCall7f16c422011-09-10 09:17:20 +00001559 Expr *finalArg = &argLoad;
1560 if (!getContext().hasSameUnqualifiedType(ivarRef.getType(),
1561 argLoad.getType()))
1562 finalArg = &argCast;
1563
Melanie Blower2ba4e3a2020-04-10 13:34:46 -07001564 BinaryOperator *assign = BinaryOperator::Create(
1565 getContext(), &ivarRef, finalArg, BO_Assign, ivarRef.getType(), VK_RValue,
Melanie Blowerf4aaed32020-06-26 09:23:45 -07001566 OK_Ordinary, SourceLocation(), FPOptionsOverride());
Melanie Blower2ba4e3a2020-04-10 13:34:46 -07001567 EmitStmt(assign);
Fariborz Jahanian5de53132011-04-06 16:05:26 +00001568}
1569
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001570/// Generate an Objective-C property setter function.
James Dennettbe302452012-06-15 22:10:14 +00001571///
1572/// The given Decl must be an ObjCImplementationDecl. \@synthesize
Steve Naroff5a7dd782009-01-10 22:55:25 +00001573/// is illegal within a category.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001574void CodeGenFunction::GenerateObjCSetter(ObjCImplementationDecl *IMP,
1575 const ObjCPropertyImplDecl *PID) {
David Blaikie8e6c36e2014-10-14 16:43:46 +00001576 llvm::Constant *AtomicHelperFn =
1577 CodeGenFunction(CGM).GenerateObjCAtomicSetterCopyHelperFunction(PID);
Adrian Prantl2073dd22019-11-04 14:28:14 -08001578 ObjCMethodDecl *OMD = PID->getSetterMethodDecl();
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001579 assert(OMD && "Invalid call to generate setter (empty method)");
David Blaikief1425802015-01-14 00:04:42 +00001580 StartObjCMethod(OMD, IMP->getClassInterface());
Daniel Dunbar5449ce52008-09-24 06:32:09 +00001581
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001582 generateObjCSetterBody(IMP, PID, AtomicHelperFn);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001583
Adrian Prantlce7d3592019-12-05 12:26:16 -08001584 FinishFunction(OMD->getEndLoc());
Chris Lattner5696e7b2008-06-17 18:05:57 +00001585}
1586
John McCall6a4fa522011-03-22 07:05:39 +00001587namespace {
David Blaikie7e70d682015-08-18 22:40:54 +00001588 struct DestroyIvar final : EHScopeStack::Cleanup {
John McCall4bd0fb12011-07-12 16:41:08 +00001589 private:
1590 llvm::Value *addr;
John McCall6a4fa522011-03-22 07:05:39 +00001591 const ObjCIvarDecl *ivar;
Peter Collingbourne1425b452012-01-26 03:33:36 +00001592 CodeGenFunction::Destroyer *destroyer;
John McCall4bd0fb12011-07-12 16:41:08 +00001593 bool useEHCleanupForArray;
1594 public:
1595 DestroyIvar(llvm::Value *addr, const ObjCIvarDecl *ivar,
1596 CodeGenFunction::Destroyer *destroyer,
1597 bool useEHCleanupForArray)
Peter Collingbourne1425b452012-01-26 03:33:36 +00001598 : addr(addr), ivar(ivar), destroyer(destroyer),
John McCall4bd0fb12011-07-12 16:41:08 +00001599 useEHCleanupForArray(useEHCleanupForArray) {}
John McCall6a4fa522011-03-22 07:05:39 +00001600
Craig Topper4f12f102014-03-12 06:41:41 +00001601 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall4bd0fb12011-07-12 16:41:08 +00001602 LValue lvalue
1603 = CGF.EmitLValueForIvar(CGF.TypeOfSelfObject(), addr, ivar, /*CVR*/ 0);
Akira Hatanakaf139ae32019-12-03 15:17:01 -08001604 CGF.emitDestroy(lvalue.getAddress(CGF), ivar->getType(), destroyer,
John McCall30317fd2011-07-12 20:27:29 +00001605 flags.isForNormalCleanup() && useEHCleanupForArray);
John McCall6a4fa522011-03-22 07:05:39 +00001606 }
1607 };
Alexander Kornienkoab9db512015-06-22 23:07:51 +00001608}
John McCall6a4fa522011-03-22 07:05:39 +00001609
John McCall4bd0fb12011-07-12 16:41:08 +00001610/// Like CodeGenFunction::destroyARCStrong, but do it with a call.
1611static void destroyARCStrongWithStore(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001612 Address addr,
John McCall4bd0fb12011-07-12 16:41:08 +00001613 QualType type) {
1614 llvm::Value *null = getNullForVariable(addr);
1615 CGF.EmitARCStoreStrongCall(addr, null, /*ignored*/ true);
1616}
John McCall31168b02011-06-15 23:02:42 +00001617
John McCall6a4fa522011-03-22 07:05:39 +00001618static void emitCXXDestructMethod(CodeGenFunction &CGF,
1619 ObjCImplementationDecl *impl) {
1620 CodeGenFunction::RunCleanupsScope scope(CGF);
1621
1622 llvm::Value *self = CGF.LoadObjCSelf();
1623
Jordy Rosea91768e2011-07-22 02:08:32 +00001624 const ObjCInterfaceDecl *iface = impl->getClassInterface();
1625 for (const ObjCIvarDecl *ivar = iface->all_declared_ivar_begin();
John McCall6a4fa522011-03-22 07:05:39 +00001626 ivar; ivar = ivar->getNextIvar()) {
1627 QualType type = ivar->getType();
1628
John McCall6a4fa522011-03-22 07:05:39 +00001629 // Check whether the ivar is a destructible type.
John McCall4bd0fb12011-07-12 16:41:08 +00001630 QualType::DestructionKind dtorKind = type.isDestructedType();
1631 if (!dtorKind) continue;
John McCall6a4fa522011-03-22 07:05:39 +00001632
Craig Topper8a13c412014-05-21 05:09:00 +00001633 CodeGenFunction::Destroyer *destroyer = nullptr;
John McCall6a4fa522011-03-22 07:05:39 +00001634
John McCall4bd0fb12011-07-12 16:41:08 +00001635 // Use a call to objc_storeStrong to destroy strong ivars, for the
1636 // general benefit of the tools.
1637 if (dtorKind == QualType::DK_objc_strong_lifetime) {
Peter Collingbourne1425b452012-01-26 03:33:36 +00001638 destroyer = destroyARCStrongWithStore;
John McCall31168b02011-06-15 23:02:42 +00001639
John McCall4bd0fb12011-07-12 16:41:08 +00001640 // Otherwise use the default for the destruction kind.
1641 } else {
Peter Collingbourne1425b452012-01-26 03:33:36 +00001642 destroyer = CGF.getDestroyer(dtorKind);
John McCall6a4fa522011-03-22 07:05:39 +00001643 }
John McCall4bd0fb12011-07-12 16:41:08 +00001644
1645 CleanupKind cleanupKind = CGF.getCleanupKind(dtorKind);
1646
1647 CGF.EHStack.pushCleanup<DestroyIvar>(cleanupKind, self, ivar, destroyer,
1648 cleanupKind & EHCleanup);
John McCall6a4fa522011-03-22 07:05:39 +00001649 }
1650
1651 assert(scope.requiresCleanups() && "nothing to do in .cxx_destruct?");
1652}
1653
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001654void CodeGenFunction::GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1655 ObjCMethodDecl *MD,
1656 bool ctor) {
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001657 MD->createImplicitParams(CGM.getContext(), IMP->getClassInterface());
David Blaikief1425802015-01-14 00:04:42 +00001658 StartObjCMethod(MD, IMP->getClassInterface());
John McCall6a4fa522011-03-22 07:05:39 +00001659
1660 // Emit .cxx_construct.
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001661 if (ctor) {
John McCall31168b02011-06-15 23:02:42 +00001662 // Suppress the final autorelease in ARC.
1663 AutoreleaseResult = false;
1664
Aaron Ballman9bc5f362014-03-13 17:35:02 +00001665 for (const auto *IvarInit : IMP->inits()) {
Francois Pichetd583da02010-12-04 09:14:42 +00001666 FieldDecl *Field = IvarInit->getAnyMember();
Aaron Ballman9bc5f362014-03-13 17:35:02 +00001667 ObjCIvarDecl *Ivar = cast<ObjCIvarDecl>(Field);
Fangrui Song6907ce22018-07-30 19:24:48 +00001668 LValue LV = EmitLValueForIvar(TypeOfSelfObject(),
Fariborz Jahanian499b9022010-04-28 22:30:33 +00001669 LoadObjCSelf(), Ivar, 0);
John McCall8d6fc952011-08-25 20:40:09 +00001670 EmitAggExpr(IvarInit->getInit(),
Akira Hatanakaf139ae32019-12-03 15:17:01 -08001671 AggValueSlot::forLValue(LV, *this, AggValueSlot::IsDestructed,
John McCalla5efa732011-08-25 23:04:34 +00001672 AggValueSlot::DoesNotNeedGCBarriers,
Richard Smithe78fac52018-04-05 20:52:58 +00001673 AggValueSlot::IsNotAliased,
1674 AggValueSlot::DoesNotOverlap));
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001675 }
1676 // constructor returns 'self'.
1677 CodeGenTypes &Types = CGM.getTypes();
1678 QualType IdTy(CGM.getContext().getObjCIdType());
1679 llvm::Value *SelfAsId =
1680 Builder.CreateBitCast(LoadObjCSelf(), Types.ConvertType(IdTy));
1681 EmitReturnOfRValue(RValue::get(SelfAsId), IdTy);
John McCall6a4fa522011-03-22 07:05:39 +00001682
1683 // Emit .cxx_destruct.
Chandler Carruthf3983652010-05-06 00:20:39 +00001684 } else {
John McCall6a4fa522011-03-22 07:05:39 +00001685 emitCXXDestructMethod(*this, IMP);
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001686 }
1687 FinishFunction();
1688}
1689
Daniel Dunbara08dff12008-09-24 04:04:31 +00001690llvm::Value *CodeGenFunction::LoadObjCSelf() {
John McCalldec348f72013-05-03 07:33:41 +00001691 VarDecl *Self = cast<ObjCMethodDecl>(CurFuncDecl)->getSelfDecl();
Bruno Ricci5fc4db72018-12-21 14:10:18 +00001692 DeclRefExpr DRE(getContext(), Self,
1693 /*is enclosing local*/ (CurFuncDecl != CurCodeDecl),
John McCalldec348f72013-05-03 07:33:41 +00001694 Self->getType(), VK_LValue, SourceLocation());
Nick Lewycky2d84e842013-10-02 02:29:49 +00001695 return EmitLoadOfScalar(EmitDeclRefLValue(&DRE), SourceLocation());
Chris Lattner5696e7b2008-06-17 18:05:57 +00001696}
1697
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00001698QualType CodeGenFunction::TypeOfSelfObject() {
1699 const ObjCMethodDecl *OMD = cast<ObjCMethodDecl>(CurFuncDecl);
1700 ImplicitParamDecl *selfDecl = OMD->getSelfDecl();
Steve Naroff7cae42b2009-07-10 23:34:53 +00001701 const ObjCObjectPointerType *PTy = cast<ObjCObjectPointerType>(
1702 getContext().getCanonicalType(selfDecl->getType()));
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00001703 return PTy->getPointeeType();
1704}
1705
Chris Lattnerd4808922009-03-22 21:03:39 +00001706void CodeGenFunction::EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S){
James Y Knight9871db02019-02-05 16:42:33 +00001707 llvm::FunctionCallee EnumerationMutationFnPtr =
1708 CGM.getObjCRuntime().EnumerationMutationFunction();
John McCallb92ab1a2016-10-26 23:46:34 +00001709 if (!EnumerationMutationFnPtr) {
Daniel Dunbara08dff12008-09-24 04:04:31 +00001710 CGM.ErrorUnsupported(&S, "Obj-C fast enumeration for this runtime");
1711 return;
1712 }
John McCallb92ab1a2016-10-26 23:46:34 +00001713 CGCallee EnumerationMutationFn =
1714 CGCallee::forDirect(EnumerationMutationFnPtr);
Daniel Dunbara08dff12008-09-24 04:04:31 +00001715
Devang Pateld2d66652011-01-19 01:36:36 +00001716 CGDebugInfo *DI = getDebugInfo();
Eric Christopher7cdf9482011-10-13 21:45:18 +00001717 if (DI)
1718 DI->EmitLexicalBlockStart(Builder, S.getSourceRange().getBegin());
Devang Pateld2d66652011-01-19 01:36:36 +00001719
Kuba Mracek5e5e4e72017-04-14 16:53:25 +00001720 RunCleanupsScope ForScope(*this);
1721
Kuba Mracek82c21752017-04-14 01:00:03 +00001722 // The local variable comes into scope immediately.
1723 AutoVarEmission variable = AutoVarEmission::invalid();
1724 if (const DeclStmt *SD = dyn_cast<DeclStmt>(S.getElement()))
1725 variable = EmitAutoVarAlloca(*cast<VarDecl>(SD->getSingleDecl()));
1726
John McCall1c926b72011-01-07 01:49:06 +00001727 JumpDest LoopEnd = getJumpDestInCurrentScope("forcoll.end");
Mike Stump11289f42009-09-09 15:08:12 +00001728
Anders Carlsson75658592008-08-31 02:33:12 +00001729 // Fast enumeration state.
Douglas Gregor636e2002011-08-09 17:23:49 +00001730 QualType StateTy = CGM.getObjCFastEnumerationStateType();
John McCall7f416cc2015-09-08 08:05:57 +00001731 Address StatePtr = CreateMemTemp(StateTy, "state.ptr");
Anders Carlssonc0964b62010-05-22 17:35:42 +00001732 EmitNullInitialization(StatePtr, StateTy);
Mike Stump11289f42009-09-09 15:08:12 +00001733
Anders Carlsson75658592008-08-31 02:33:12 +00001734 // Number of elements in the items array.
Anders Carlsson3f35a262008-08-31 04:05:03 +00001735 static const unsigned NumItems = 16;
Mike Stump11289f42009-09-09 15:08:12 +00001736
John McCall1c926b72011-01-07 01:49:06 +00001737 // Fetch the countByEnumeratingWithState:objects:count: selector.
Benjamin Kramer9e649c32010-03-30 11:36:44 +00001738 IdentifierInfo *II[] = {
1739 &CGM.getContext().Idents.get("countByEnumeratingWithState"),
1740 &CGM.getContext().Idents.get("objects"),
1741 &CGM.getContext().Idents.get("count")
1742 };
1743 Selector FastEnumSel =
1744 CGM.getContext().Selectors.getSelector(llvm::array_lengthof(II), &II[0]);
Anders Carlsson75658592008-08-31 02:33:12 +00001745
1746 QualType ItemsTy =
1747 getContext().getConstantArrayType(getContext().getObjCIdType(),
Richard Smith772e2662019-10-04 01:25:59 +00001748 llvm::APInt(32, NumItems), nullptr,
Anders Carlsson75658592008-08-31 02:33:12 +00001749 ArrayType::Normal, 0);
John McCall7f416cc2015-09-08 08:05:57 +00001750 Address ItemsPtr = CreateMemTemp(ItemsTy, "items.ptr");
Mike Stump11289f42009-09-09 15:08:12 +00001751
John McCall53848232011-07-27 01:07:15 +00001752 // Emit the collection pointer. In ARC, we do a retain.
1753 llvm::Value *Collection;
David Blaikiebbafb8a2012-03-11 07:00:24 +00001754 if (getLangOpts().ObjCAutoRefCount) {
John McCall53848232011-07-27 01:07:15 +00001755 Collection = EmitARCRetainScalarExpr(S.getCollection());
1756
1757 // Enter a cleanup to do the release.
1758 EmitObjCConsumeObject(S.getCollection()->getType(), Collection);
1759 } else {
1760 Collection = EmitScalarExpr(S.getCollection());
1761 }
Mike Stump11289f42009-09-09 15:08:12 +00001762
John McCall91e82dd2011-08-05 00:14:38 +00001763 // The 'continue' label needs to appear within the cleanup for the
1764 // collection object.
1765 JumpDest AfterBody = getJumpDestInCurrentScope("forcoll.next");
1766
John McCall1c926b72011-01-07 01:49:06 +00001767 // Send it our message:
Anders Carlsson75658592008-08-31 02:33:12 +00001768 CallArgList Args;
John McCall1c926b72011-01-07 01:49:06 +00001769
1770 // The first argument is a temporary of the enumeration-state type.
John McCall7f416cc2015-09-08 08:05:57 +00001771 Args.add(RValue::get(StatePtr.getPointer()),
1772 getContext().getPointerType(StateTy));
Mike Stump11289f42009-09-09 15:08:12 +00001773
John McCall1c926b72011-01-07 01:49:06 +00001774 // The second argument is a temporary array with space for NumItems
1775 // pointers. We'll actually be loading elements from the array
1776 // pointer written into the control state; this buffer is so that
1777 // collections that *aren't* backed by arrays can still queue up
1778 // batches of elements.
John McCall7f416cc2015-09-08 08:05:57 +00001779 Args.add(RValue::get(ItemsPtr.getPointer()),
1780 getContext().getPointerType(ItemsTy));
Mike Stump11289f42009-09-09 15:08:12 +00001781
John McCall1c926b72011-01-07 01:49:06 +00001782 // The third argument is the capacity of that temporary array.
Saleem Abdulrasool94bb1a02017-09-08 23:41:17 +00001783 llvm::Type *NSUIntegerTy = ConvertType(getContext().getNSUIntegerType());
1784 llvm::Constant *Count = llvm::ConstantInt::get(NSUIntegerTy, NumItems);
1785 Args.add(RValue::get(Count), getContext().getNSUIntegerType());
Mike Stump11289f42009-09-09 15:08:12 +00001786
John McCall1c926b72011-01-07 01:49:06 +00001787 // Start the enumeration.
Mike Stump11289f42009-09-09 15:08:12 +00001788 RValue CountRV =
Saleem Abdulrasool94bb1a02017-09-08 23:41:17 +00001789 CGM.getObjCRuntime().GenerateMessageSend(*this, ReturnValueSlot(),
1790 getContext().getNSUIntegerType(),
1791 FastEnumSel, Collection, Args);
Anders Carlsson75658592008-08-31 02:33:12 +00001792
John McCall1c926b72011-01-07 01:49:06 +00001793 // The initial number of objects that were returned in the buffer.
1794 llvm::Value *initialBufferLimit = CountRV.getScalarVal();
Mike Stump11289f42009-09-09 15:08:12 +00001795
John McCall1c926b72011-01-07 01:49:06 +00001796 llvm::BasicBlock *EmptyBB = createBasicBlock("forcoll.empty");
1797 llvm::BasicBlock *LoopInitBB = createBasicBlock("forcoll.loopinit");
Mike Stump11289f42009-09-09 15:08:12 +00001798
Saleem Abdulrasool94bb1a02017-09-08 23:41:17 +00001799 llvm::Value *zero = llvm::Constant::getNullValue(NSUIntegerTy);
Anders Carlsson75658592008-08-31 02:33:12 +00001800
John McCall1c926b72011-01-07 01:49:06 +00001801 // If the limit pointer was zero to begin with, the collection is
Bob Wilson0ed74d92014-03-25 23:26:31 +00001802 // empty; skip all this. Set the branch weight assuming this has the same
1803 // probability of exiting the loop as any other loop exit.
Justin Bogner66242d62015-04-23 23:06:47 +00001804 uint64_t EntryCount = getCurrentProfileCount();
1805 Builder.CreateCondBr(
1806 Builder.CreateICmpEQ(initialBufferLimit, zero, "iszero"), EmptyBB,
1807 LoopInitBB,
Justin Bogner65512642015-05-02 05:00:55 +00001808 createProfileWeights(EntryCount, getProfileCount(S.getBody())));
Anders Carlsson75658592008-08-31 02:33:12 +00001809
John McCall1c926b72011-01-07 01:49:06 +00001810 // Otherwise, initialize the loop.
1811 EmitBlock(LoopInitBB);
Mike Stump11289f42009-09-09 15:08:12 +00001812
John McCall1c926b72011-01-07 01:49:06 +00001813 // Save the initial mutations value. This is the value at an
1814 // address that was written into the state object by
1815 // countByEnumeratingWithState:objects:count:.
James Y Knight751fe282019-02-09 22:22:28 +00001816 Address StateMutationsPtrPtr =
1817 Builder.CreateStructGEP(StatePtr, 2, "mutationsptr.ptr");
John McCall7f416cc2015-09-08 08:05:57 +00001818 llvm::Value *StateMutationsPtr
1819 = Builder.CreateLoad(StateMutationsPtrPtr, "mutationsptr");
Mike Stump11289f42009-09-09 15:08:12 +00001820
John McCall1c926b72011-01-07 01:49:06 +00001821 llvm::Value *initialMutations =
John McCall7f416cc2015-09-08 08:05:57 +00001822 Builder.CreateAlignedLoad(StateMutationsPtr, getPointerAlign(),
1823 "forcoll.initial-mutations");
Mike Stump11289f42009-09-09 15:08:12 +00001824
John McCall1c926b72011-01-07 01:49:06 +00001825 // Start looping. This is the point we return to whenever we have a
1826 // fresh, non-empty batch of objects.
1827 llvm::BasicBlock *LoopBodyBB = createBasicBlock("forcoll.loopbody");
1828 EmitBlock(LoopBodyBB);
Mike Stump11289f42009-09-09 15:08:12 +00001829
John McCall1c926b72011-01-07 01:49:06 +00001830 // The current index into the buffer.
Saleem Abdulrasool94bb1a02017-09-08 23:41:17 +00001831 llvm::PHINode *index = Builder.CreatePHI(NSUIntegerTy, 3, "forcoll.index");
John McCall1c926b72011-01-07 01:49:06 +00001832 index->addIncoming(zero, LoopInitBB);
Anders Carlsson75658592008-08-31 02:33:12 +00001833
John McCall1c926b72011-01-07 01:49:06 +00001834 // The current buffer size.
Saleem Abdulrasool94bb1a02017-09-08 23:41:17 +00001835 llvm::PHINode *count = Builder.CreatePHI(NSUIntegerTy, 3, "forcoll.count");
John McCall1c926b72011-01-07 01:49:06 +00001836 count->addIncoming(initialBufferLimit, LoopInitBB);
Mike Stump11289f42009-09-09 15:08:12 +00001837
Justin Bogner66242d62015-04-23 23:06:47 +00001838 incrementProfileCounter(&S);
Bob Wilson8ab16912014-02-24 01:13:09 +00001839
John McCall1c926b72011-01-07 01:49:06 +00001840 // Check whether the mutations value has changed from where it was
1841 // at start. StateMutationsPtr should actually be invariant between
1842 // refreshes.
Anders Carlsson3f35a262008-08-31 04:05:03 +00001843 StateMutationsPtr = Builder.CreateLoad(StateMutationsPtrPtr, "mutationsptr");
John McCall1c926b72011-01-07 01:49:06 +00001844 llvm::Value *currentMutations
John McCall7f416cc2015-09-08 08:05:57 +00001845 = Builder.CreateAlignedLoad(StateMutationsPtr, getPointerAlign(),
1846 "statemutations");
Anders Carlsson3f35a262008-08-31 04:05:03 +00001847
John McCall1c926b72011-01-07 01:49:06 +00001848 llvm::BasicBlock *WasMutatedBB = createBasicBlock("forcoll.mutated");
Dan Gohman6ca99822011-03-02 22:39:34 +00001849 llvm::BasicBlock *WasNotMutatedBB = createBasicBlock("forcoll.notmutated");
Mike Stump11289f42009-09-09 15:08:12 +00001850
John McCall1c926b72011-01-07 01:49:06 +00001851 Builder.CreateCondBr(Builder.CreateICmpEQ(currentMutations, initialMutations),
1852 WasNotMutatedBB, WasMutatedBB);
Mike Stump11289f42009-09-09 15:08:12 +00001853
John McCall1c926b72011-01-07 01:49:06 +00001854 // If so, call the enumeration-mutation function.
1855 EmitBlock(WasMutatedBB);
Anders Carlsson3f35a262008-08-31 04:05:03 +00001856 llvm::Value *V =
Mike Stump11289f42009-09-09 15:08:12 +00001857 Builder.CreateBitCast(Collection,
Benjamin Kramer76399eb2011-09-27 21:06:10 +00001858 ConvertType(getContext().getObjCIdType()));
Daniel Dunbar84388bf2009-02-03 23:55:40 +00001859 CallArgList Args2;
Eli Friedman43dca6a2011-05-02 17:57:46 +00001860 Args2.add(RValue::get(V), getContext().getObjCIdType());
Mike Stump18bb9282009-05-16 07:57:57 +00001861 // FIXME: We shouldn't need to get the function info here, the runtime already
1862 // should have computed it to build the function.
John McCallc56a8b32016-03-11 04:30:31 +00001863 EmitCall(
1864 CGM.getTypes().arrangeBuiltinFunctionCall(getContext().VoidTy, Args2),
Anders Carlsson61a401c2009-12-24 19:25:24 +00001865 EnumerationMutationFn, ReturnValueSlot(), Args2);
Mike Stump11289f42009-09-09 15:08:12 +00001866
John McCall1c926b72011-01-07 01:49:06 +00001867 // Otherwise, or if the mutation function returns, just continue.
1868 EmitBlock(WasNotMutatedBB);
Mike Stump11289f42009-09-09 15:08:12 +00001869
John McCall1c926b72011-01-07 01:49:06 +00001870 // Initialize the element variable.
1871 RunCleanupsScope elementVariableScope(*this);
John McCall9e2e22f2011-02-22 07:16:58 +00001872 bool elementIsVariable;
John McCall1c926b72011-01-07 01:49:06 +00001873 LValue elementLValue;
1874 QualType elementType;
1875 if (const DeclStmt *SD = dyn_cast<DeclStmt>(S.getElement())) {
John McCall9e2e22f2011-02-22 07:16:58 +00001876 // Initialize the variable, in case it's a __block variable or something.
1877 EmitAutoVarInit(variable);
John McCall1c926b72011-01-07 01:49:06 +00001878
Bruno Ricci5fc4db72018-12-21 14:10:18 +00001879 const VarDecl *D = cast<VarDecl>(SD->getSingleDecl());
1880 DeclRefExpr tempDRE(getContext(), const_cast<VarDecl *>(D), false,
1881 D->getType(), VK_LValue, SourceLocation());
John McCall1c926b72011-01-07 01:49:06 +00001882 elementLValue = EmitLValue(&tempDRE);
1883 elementType = D->getType();
John McCall9e2e22f2011-02-22 07:16:58 +00001884 elementIsVariable = true;
John McCalld4631322011-06-17 06:42:21 +00001885
1886 if (D->isARCPseudoStrong())
1887 elementLValue.getQuals().setObjCLifetime(Qualifiers::OCL_ExplicitNone);
John McCall1c926b72011-01-07 01:49:06 +00001888 } else {
1889 elementLValue = LValue(); // suppress warning
1890 elementType = cast<Expr>(S.getElement())->getType();
John McCall9e2e22f2011-02-22 07:16:58 +00001891 elementIsVariable = false;
John McCall1c926b72011-01-07 01:49:06 +00001892 }
Chris Lattner2192fe52011-07-18 04:24:23 +00001893 llvm::Type *convertedElementType = ConvertType(elementType);
John McCall1c926b72011-01-07 01:49:06 +00001894
1895 // Fetch the buffer out of the enumeration state.
1896 // TODO: this pointer should actually be invariant between
1897 // refreshes, which would help us do certain loop optimizations.
James Y Knight751fe282019-02-09 22:22:28 +00001898 Address StateItemsPtr =
1899 Builder.CreateStructGEP(StatePtr, 1, "stateitems.ptr");
John McCall1c926b72011-01-07 01:49:06 +00001900 llvm::Value *EnumStateItems =
1901 Builder.CreateLoad(StateItemsPtr, "stateitems");
Anders Carlsson75658592008-08-31 02:33:12 +00001902
John McCall1c926b72011-01-07 01:49:06 +00001903 // Fetch the value at the current index from the buffer.
Mike Stump11289f42009-09-09 15:08:12 +00001904 llvm::Value *CurrentItemPtr =
John McCall1c926b72011-01-07 01:49:06 +00001905 Builder.CreateGEP(EnumStateItems, index, "currentitem.ptr");
John McCall7f416cc2015-09-08 08:05:57 +00001906 llvm::Value *CurrentItem =
1907 Builder.CreateAlignedLoad(CurrentItemPtr, getPointerAlign());
Mike Stump11289f42009-09-09 15:08:12 +00001908
Vedant Kumar8c4a65b2019-12-13 12:59:40 -08001909 if (SanOpts.has(SanitizerKind::ObjCCast)) {
1910 // Before using an item from the collection, check that the implicit cast
1911 // from id to the element type is valid. This is done with instrumentation
1912 // roughly corresponding to:
1913 //
1914 // if (![item isKindOfClass:expectedCls]) { /* emit diagnostic */ }
1915 const ObjCObjectPointerType *ObjPtrTy =
1916 elementType->getAsObjCInterfacePointerType();
1917 const ObjCInterfaceType *InterfaceTy =
1918 ObjPtrTy ? ObjPtrTy->getInterfaceType() : nullptr;
1919 if (InterfaceTy) {
1920 SanitizerScope SanScope(this);
1921 auto &C = CGM.getContext();
1922 assert(InterfaceTy->getDecl() && "No decl for ObjC interface type");
1923 Selector IsKindOfClassSel = GetUnarySelector("isKindOfClass", C);
1924 CallArgList IsKindOfClassArgs;
1925 llvm::Value *Cls =
1926 CGM.getObjCRuntime().GetClass(*this, InterfaceTy->getDecl());
1927 IsKindOfClassArgs.add(RValue::get(Cls), C.getObjCClassType());
1928 llvm::Value *IsClass =
1929 CGM.getObjCRuntime()
1930 .GenerateMessageSend(*this, ReturnValueSlot(), C.BoolTy,
1931 IsKindOfClassSel, CurrentItem,
1932 IsKindOfClassArgs)
1933 .getScalarVal();
1934 llvm::Constant *StaticData[] = {
1935 EmitCheckSourceLocation(S.getBeginLoc()),
1936 EmitCheckTypeDescriptor(QualType(InterfaceTy, 0))};
1937 EmitCheck({{IsClass, SanitizerKind::ObjCCast}},
1938 SanitizerHandler::InvalidObjCCast,
1939 ArrayRef<llvm::Constant *>(StaticData), CurrentItem);
1940 }
1941 }
1942
John McCall1c926b72011-01-07 01:49:06 +00001943 // Cast that value to the right type.
1944 CurrentItem = Builder.CreateBitCast(CurrentItem, convertedElementType,
1945 "currentitem");
Mike Stump11289f42009-09-09 15:08:12 +00001946
John McCall1c926b72011-01-07 01:49:06 +00001947 // Make sure we have an l-value. Yes, this gets evaluated every
1948 // time through the loop.
John McCalld4631322011-06-17 06:42:21 +00001949 if (!elementIsVariable) {
John McCall1c926b72011-01-07 01:49:06 +00001950 elementLValue = EmitLValue(cast<Expr>(S.getElement()));
John McCall55e1fbc2011-06-25 02:11:03 +00001951 EmitStoreThroughLValue(RValue::get(CurrentItem), elementLValue);
John McCalld4631322011-06-17 06:42:21 +00001952 } else {
Akira Hatanaka642f7992016-10-18 19:05:41 +00001953 EmitStoreThroughLValue(RValue::get(CurrentItem), elementLValue,
1954 /*isInit*/ true);
John McCalld4631322011-06-17 06:42:21 +00001955 }
Mike Stump11289f42009-09-09 15:08:12 +00001956
John McCall9e2e22f2011-02-22 07:16:58 +00001957 // If we do have an element variable, this assignment is the end of
1958 // its initialization.
1959 if (elementIsVariable)
1960 EmitAutoVarCleanups(variable);
1961
John McCall1c926b72011-01-07 01:49:06 +00001962 // Perform the loop body, setting up break and continue labels.
Bob Wilsonbf854f02014-02-17 19:21:09 +00001963 BreakContinueStack.push_back(BreakContinue(LoopEnd, AfterBody));
John McCall1c926b72011-01-07 01:49:06 +00001964 {
1965 RunCleanupsScope Scope(*this);
1966 EmitStmt(S.getBody());
1967 }
Anders Carlsson75658592008-08-31 02:33:12 +00001968 BreakContinueStack.pop_back();
Mike Stump11289f42009-09-09 15:08:12 +00001969
John McCall1c926b72011-01-07 01:49:06 +00001970 // Destroy the element variable now.
1971 elementVariableScope.ForceCleanup();
1972
1973 // Check whether there are more elements.
John McCallad5d61e2010-07-23 21:56:41 +00001974 EmitBlock(AfterBody.getBlock());
Mike Stump11289f42009-09-09 15:08:12 +00001975
John McCall1c926b72011-01-07 01:49:06 +00001976 llvm::BasicBlock *FetchMoreBB = createBasicBlock("forcoll.refetch");
Fariborz Jahanian6e7ecc82009-01-06 18:56:31 +00001977
John McCall1c926b72011-01-07 01:49:06 +00001978 // First we check in the local buffer.
Saleem Abdulrasool94bb1a02017-09-08 23:41:17 +00001979 llvm::Value *indexPlusOne =
1980 Builder.CreateAdd(index, llvm::ConstantInt::get(NSUIntegerTy, 1));
Anders Carlsson75658592008-08-31 02:33:12 +00001981
John McCall1c926b72011-01-07 01:49:06 +00001982 // If we haven't overrun the buffer yet, we can continue.
Bob Wilson0ed74d92014-03-25 23:26:31 +00001983 // Set the branch weights based on the simplifying assumption that this is
1984 // like a while-loop, i.e., ignoring that the false branch fetches more
1985 // elements and then returns to the loop.
Justin Bogner66242d62015-04-23 23:06:47 +00001986 Builder.CreateCondBr(
1987 Builder.CreateICmpULT(indexPlusOne, count), LoopBodyBB, FetchMoreBB,
Justin Bogner65512642015-05-02 05:00:55 +00001988 createProfileWeights(getProfileCount(S.getBody()), EntryCount));
John McCall1c926b72011-01-07 01:49:06 +00001989
1990 index->addIncoming(indexPlusOne, AfterBody.getBlock());
1991 count->addIncoming(count, AfterBody.getBlock());
1992
1993 // Otherwise, we have to fetch more elements.
1994 EmitBlock(FetchMoreBB);
Mike Stump11289f42009-09-09 15:08:12 +00001995
1996 CountRV =
Saleem Abdulrasool94bb1a02017-09-08 23:41:17 +00001997 CGM.getObjCRuntime().GenerateMessageSend(*this, ReturnValueSlot(),
1998 getContext().getNSUIntegerType(),
1999 FastEnumSel, Collection, Args);
Mike Stump11289f42009-09-09 15:08:12 +00002000
John McCall1c926b72011-01-07 01:49:06 +00002001 // If we got a zero count, we're done.
2002 llvm::Value *refetchCount = CountRV.getScalarVal();
2003
2004 // (note that the message send might split FetchMoreBB)
2005 index->addIncoming(zero, Builder.GetInsertBlock());
2006 count->addIncoming(refetchCount, Builder.GetInsertBlock());
2007
2008 Builder.CreateCondBr(Builder.CreateICmpEQ(refetchCount, zero),
2009 EmptyBB, LoopBodyBB);
Mike Stump11289f42009-09-09 15:08:12 +00002010
Anders Carlsson75658592008-08-31 02:33:12 +00002011 // No more elements.
John McCall1c926b72011-01-07 01:49:06 +00002012 EmitBlock(EmptyBB);
Anders Carlsson75658592008-08-31 02:33:12 +00002013
John McCall9e2e22f2011-02-22 07:16:58 +00002014 if (!elementIsVariable) {
Anders Carlsson75658592008-08-31 02:33:12 +00002015 // If the element was not a declaration, set it to be null.
2016
John McCall1c926b72011-01-07 01:49:06 +00002017 llvm::Value *null = llvm::Constant::getNullValue(convertedElementType);
2018 elementLValue = EmitLValue(cast<Expr>(S.getElement()));
John McCall55e1fbc2011-06-25 02:11:03 +00002019 EmitStoreThroughLValue(RValue::get(null), elementLValue);
Anders Carlsson75658592008-08-31 02:33:12 +00002020 }
2021
Eric Christopher7cdf9482011-10-13 21:45:18 +00002022 if (DI)
2023 DI->EmitLexicalBlockEnd(Builder, S.getSourceRange().getEnd());
Devang Pateld2d66652011-01-19 01:36:36 +00002024
Akira Hatanaka2d3690b2016-04-12 23:10:58 +00002025 ForScope.ForceCleanup();
John McCallad5d61e2010-07-23 21:56:41 +00002026 EmitBlock(LoopEnd.getBlock());
Anders Carlsson2e744e82008-08-30 19:51:14 +00002027}
2028
Mike Stump11289f42009-09-09 15:08:12 +00002029void CodeGenFunction::EmitObjCAtTryStmt(const ObjCAtTryStmt &S) {
John McCallbd309292010-07-06 01:34:17 +00002030 CGM.getObjCRuntime().EmitTryStmt(*this, S);
Anders Carlsson1963b0c2008-09-09 10:04:29 +00002031}
2032
Mike Stump11289f42009-09-09 15:08:12 +00002033void CodeGenFunction::EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S) {
Anders Carlsson1963b0c2008-09-09 10:04:29 +00002034 CGM.getObjCRuntime().EmitThrowStmt(*this, S);
2035}
2036
Chris Lattnere132e242008-11-15 21:26:17 +00002037void CodeGenFunction::EmitObjCAtSynchronizedStmt(
Mike Stump11289f42009-09-09 15:08:12 +00002038 const ObjCAtSynchronizedStmt &S) {
John McCallbd309292010-07-06 01:34:17 +00002039 CGM.getObjCRuntime().EmitSynchronizedStmt(*this, S);
Chris Lattnere132e242008-11-15 21:26:17 +00002040}
2041
John McCall31168b02011-06-15 23:02:42 +00002042namespace {
David Blaikie7e70d682015-08-18 22:40:54 +00002043 struct CallObjCRelease final : EHScopeStack::Cleanup {
John McCall9c8e1c92011-08-03 22:24:24 +00002044 CallObjCRelease(llvm::Value *object) : object(object) {}
2045 llvm::Value *object;
John McCall31168b02011-06-15 23:02:42 +00002046
Craig Topper4f12f102014-03-12 06:41:41 +00002047 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCallcdda29c2013-03-13 03:10:54 +00002048 // Releases at the end of the full-expression are imprecise.
2049 CGF.EmitARCRelease(object, ARCImpreciseLifetime);
John McCall31168b02011-06-15 23:02:42 +00002050 }
2051 };
Alexander Kornienkoab9db512015-06-22 23:07:51 +00002052}
John McCall31168b02011-06-15 23:02:42 +00002053
John McCall2d637d22011-09-10 06:18:15 +00002054/// Produce the code for a CK_ARCConsumeObject. Does a primitive
John McCall31168b02011-06-15 23:02:42 +00002055/// release at the end of the full-expression.
2056llvm::Value *CodeGenFunction::EmitObjCConsumeObject(QualType type,
2057 llvm::Value *object) {
2058 // If we're in a conditional branch, we need to make the cleanup
John McCall9c8e1c92011-08-03 22:24:24 +00002059 // conditional.
2060 pushFullExprCleanup<CallObjCRelease>(getARCCleanupKind(), object);
John McCall31168b02011-06-15 23:02:42 +00002061 return object;
2062}
2063
2064llvm::Value *CodeGenFunction::EmitObjCExtendObjectLifetime(QualType type,
2065 llvm::Value *value) {
2066 return EmitARCRetainAutorelease(type, value);
2067}
2068
John McCalleff18842013-03-23 02:35:54 +00002069/// Given a number of pointers, inform the optimizer that they're
2070/// being intrinsically used up until this point in the program.
2071void CodeGenFunction::EmitARCIntrinsicUse(ArrayRef<llvm::Value*> values) {
James Y Knight9871db02019-02-05 16:42:33 +00002072 llvm::Function *&fn = CGM.getObjCEntrypoints().clang_arc_use;
Pete Cooper6c47f542018-12-20 18:05:41 +00002073 if (!fn)
2074 fn = CGM.getIntrinsic(llvm::Intrinsic::objc_clang_arc_use);
John McCalleff18842013-03-23 02:35:54 +00002075
2076 // This isn't really a "runtime" function, but as an intrinsic it
2077 // doesn't really matter as long as we align things up.
2078 EmitNounwindRuntimeCall(fn, values);
2079}
2080
James Y Knight9871db02019-02-05 16:42:33 +00002081static void setARCRuntimeFunctionLinkage(CodeGenModule &CGM, llvm::Value *RTF) {
Saleem Abdulrasoole60561c2017-02-11 17:24:07 +00002082 if (auto *F = dyn_cast<llvm::Function>(RTF)) {
Michael Gottesmanbe9614c2013-02-02 01:05:06 +00002083 // If the target runtime doesn't naturally support ARC, emit weak
2084 // references to the runtime support library. We don't really
2085 // permit this to fail, but we need a particular relocation style.
Saleem Abdulrasool6cb07442016-12-15 06:59:05 +00002086 if (!CGM.getLangOpts().ObjCRuntime.hasNativeARC() &&
2087 !CGM.getTriple().isOSBinFormatCOFF()) {
Saleem Abdulrasoole60561c2017-02-11 17:24:07 +00002088 F->setLinkage(llvm::Function::ExternalWeakLinkage);
Michael Gottesmanb46072d2013-02-02 01:03:01 +00002089 }
Michael Gottesmancf50e6d2013-02-02 00:57:44 +00002090 }
John McCall31168b02011-06-15 23:02:42 +00002091}
2092
James Y Knight9871db02019-02-05 16:42:33 +00002093static void setARCRuntimeFunctionLinkage(CodeGenModule &CGM,
2094 llvm::FunctionCallee RTF) {
2095 setARCRuntimeFunctionLinkage(CGM, RTF.getCallee());
2096}
2097
John McCall31168b02011-06-15 23:02:42 +00002098/// Perform an operation having the signature
2099/// i8* (i8*)
2100/// where a null input causes a no-op and returns null.
Akira Hatanaka65bb3f92019-03-21 19:59:49 +00002101static llvm::Value *emitARCValueOperation(
2102 CodeGenFunction &CGF, llvm::Value *value, llvm::Type *returnType,
2103 llvm::Function *&fn, llvm::Intrinsic::ID IntID,
2104 llvm::CallInst::TailCallKind tailKind = llvm::CallInst::TCK_None) {
Saleem Abdulrasoole60561c2017-02-11 17:24:07 +00002105 if (isa<llvm::ConstantPointerNull>(value))
2106 return value;
John McCall31168b02011-06-15 23:02:42 +00002107
2108 if (!fn) {
Pete Cooper2cd35962018-12-18 20:33:00 +00002109 fn = CGF.CGM.getIntrinsic(IntID);
2110 setARCRuntimeFunctionLinkage(CGF.CGM, fn);
John McCall31168b02011-06-15 23:02:42 +00002111 }
2112
2113 // Cast the argument to 'id'.
Pete Coopere3886802018-12-08 05:13:50 +00002114 llvm::Type *origType = returnType ? returnType : value->getType();
John McCall31168b02011-06-15 23:02:42 +00002115 value = CGF.Builder.CreateBitCast(value, CGF.Int8PtrTy);
2116
2117 // Call the function.
John McCall882987f2013-02-28 19:01:20 +00002118 llvm::CallInst *call = CGF.EmitNounwindRuntimeCall(fn, value);
Akira Hatanaka65bb3f92019-03-21 19:59:49 +00002119 call->setTailCallKind(tailKind);
John McCall31168b02011-06-15 23:02:42 +00002120
2121 // Cast the result back to the original type.
2122 return CGF.Builder.CreateBitCast(call, origType);
2123}
2124
2125/// Perform an operation having the following signature:
2126/// i8* (i8**)
James Y Knight9871db02019-02-05 16:42:33 +00002127static llvm::Value *emitARCLoadOperation(CodeGenFunction &CGF, Address addr,
2128 llvm::Function *&fn,
Pete Cooper2cd35962018-12-18 20:33:00 +00002129 llvm::Intrinsic::ID IntID) {
John McCall31168b02011-06-15 23:02:42 +00002130 if (!fn) {
Pete Cooper2cd35962018-12-18 20:33:00 +00002131 fn = CGF.CGM.getIntrinsic(IntID);
2132 setARCRuntimeFunctionLinkage(CGF.CGM, fn);
John McCall31168b02011-06-15 23:02:42 +00002133 }
2134
2135 // Cast the argument to 'id*'.
John McCall7f416cc2015-09-08 08:05:57 +00002136 llvm::Type *origType = addr.getElementType();
John McCall31168b02011-06-15 23:02:42 +00002137 addr = CGF.Builder.CreateBitCast(addr, CGF.Int8PtrPtrTy);
2138
2139 // Call the function.
John McCall7f416cc2015-09-08 08:05:57 +00002140 llvm::Value *result = CGF.EmitNounwindRuntimeCall(fn, addr.getPointer());
John McCall31168b02011-06-15 23:02:42 +00002141
2142 // Cast the result back to a dereference of the original type.
John McCall7f416cc2015-09-08 08:05:57 +00002143 if (origType != CGF.Int8PtrTy)
2144 result = CGF.Builder.CreateBitCast(result, origType);
John McCall31168b02011-06-15 23:02:42 +00002145
2146 return result;
2147}
2148
2149/// Perform an operation having the following signature:
2150/// i8* (i8**, i8*)
James Y Knight9871db02019-02-05 16:42:33 +00002151static llvm::Value *emitARCStoreOperation(CodeGenFunction &CGF, Address addr,
John McCall31168b02011-06-15 23:02:42 +00002152 llvm::Value *value,
James Y Knight9871db02019-02-05 16:42:33 +00002153 llvm::Function *&fn,
Pete Cooper2cd35962018-12-18 20:33:00 +00002154 llvm::Intrinsic::ID IntID,
John McCall31168b02011-06-15 23:02:42 +00002155 bool ignored) {
John McCall7f416cc2015-09-08 08:05:57 +00002156 assert(addr.getElementType() == value->getType());
John McCall31168b02011-06-15 23:02:42 +00002157
2158 if (!fn) {
Pete Cooper2cd35962018-12-18 20:33:00 +00002159 fn = CGF.CGM.getIntrinsic(IntID);
2160 setARCRuntimeFunctionLinkage(CGF.CGM, fn);
John McCall31168b02011-06-15 23:02:42 +00002161 }
2162
Chris Lattner2192fe52011-07-18 04:24:23 +00002163 llvm::Type *origType = value->getType();
John McCall31168b02011-06-15 23:02:42 +00002164
John McCall882987f2013-02-28 19:01:20 +00002165 llvm::Value *args[] = {
John McCall7f416cc2015-09-08 08:05:57 +00002166 CGF.Builder.CreateBitCast(addr.getPointer(), CGF.Int8PtrPtrTy),
John McCall882987f2013-02-28 19:01:20 +00002167 CGF.Builder.CreateBitCast(value, CGF.Int8PtrTy)
2168 };
2169 llvm::CallInst *result = CGF.EmitNounwindRuntimeCall(fn, args);
John McCall31168b02011-06-15 23:02:42 +00002170
Craig Topper8a13c412014-05-21 05:09:00 +00002171 if (ignored) return nullptr;
John McCall31168b02011-06-15 23:02:42 +00002172
2173 return CGF.Builder.CreateBitCast(result, origType);
2174}
2175
2176/// Perform an operation having the following signature:
2177/// void (i8**, i8**)
James Y Knight9871db02019-02-05 16:42:33 +00002178static void emitARCCopyOperation(CodeGenFunction &CGF, Address dst, Address src,
2179 llvm::Function *&fn,
Pete Cooper2cd35962018-12-18 20:33:00 +00002180 llvm::Intrinsic::ID IntID) {
John McCall7f416cc2015-09-08 08:05:57 +00002181 assert(dst.getType() == src.getType());
John McCall31168b02011-06-15 23:02:42 +00002182
2183 if (!fn) {
Pete Cooper2cd35962018-12-18 20:33:00 +00002184 fn = CGF.CGM.getIntrinsic(IntID);
2185 setARCRuntimeFunctionLinkage(CGF.CGM, fn);
John McCall31168b02011-06-15 23:02:42 +00002186 }
2187
John McCall882987f2013-02-28 19:01:20 +00002188 llvm::Value *args[] = {
John McCall7f416cc2015-09-08 08:05:57 +00002189 CGF.Builder.CreateBitCast(dst.getPointer(), CGF.Int8PtrPtrTy),
2190 CGF.Builder.CreateBitCast(src.getPointer(), CGF.Int8PtrPtrTy)
John McCall882987f2013-02-28 19:01:20 +00002191 };
2192 CGF.EmitNounwindRuntimeCall(fn, args);
John McCall31168b02011-06-15 23:02:42 +00002193}
2194
Pete Cooper2cd35962018-12-18 20:33:00 +00002195/// Perform an operation having the signature
2196/// i8* (i8*)
2197/// where a null input causes a no-op and returns null.
2198static llvm::Value *emitObjCValueOperation(CodeGenFunction &CGF,
2199 llvm::Value *value,
2200 llvm::Type *returnType,
James Y Knight9871db02019-02-05 16:42:33 +00002201 llvm::FunctionCallee &fn,
Erik Pilkingtonf6c645f2019-05-15 20:15:01 +00002202 StringRef fnName) {
Pete Cooper2cd35962018-12-18 20:33:00 +00002203 if (isa<llvm::ConstantPointerNull>(value))
2204 return value;
2205
2206 if (!fn) {
2207 llvm::FunctionType *fnType =
2208 llvm::FunctionType::get(CGF.Int8PtrTy, CGF.Int8PtrTy, false);
2209 fn = CGF.CGM.CreateRuntimeFunction(fnType, fnName);
Pete Coopere5b64ea2018-12-21 21:00:32 +00002210
2211 // We have Native ARC, so set nonlazybind attribute for performance
James Y Knight9871db02019-02-05 16:42:33 +00002212 if (llvm::Function *f = dyn_cast<llvm::Function>(fn.getCallee()))
Pete Coopere5b64ea2018-12-21 21:00:32 +00002213 if (fnName == "objc_retain")
2214 f->addFnAttr(llvm::Attribute::NonLazyBind);
Pete Cooper2cd35962018-12-18 20:33:00 +00002215 }
2216
2217 // Cast the argument to 'id'.
2218 llvm::Type *origType = returnType ? returnType : value->getType();
2219 value = CGF.Builder.CreateBitCast(value, CGF.Int8PtrTy);
2220
2221 // Call the function.
Erik Pilkingtonf6c645f2019-05-15 20:15:01 +00002222 llvm::CallBase *Inst = CGF.EmitCallOrInvoke(fn, value);
Pete Cooper2cd35962018-12-18 20:33:00 +00002223
2224 // Cast the result back to the original type.
Erik Pilkington1f7eda52019-01-30 23:17:38 +00002225 return CGF.Builder.CreateBitCast(Inst, origType);
Pete Cooper2cd35962018-12-18 20:33:00 +00002226}
2227
John McCall31168b02011-06-15 23:02:42 +00002228/// Produce the code to do a retain. Based on the type, calls one of:
James Dennett14c41ea2012-06-22 05:41:30 +00002229/// call i8* \@objc_retain(i8* %value)
2230/// call i8* \@objc_retainBlock(i8* %value)
John McCall31168b02011-06-15 23:02:42 +00002231llvm::Value *CodeGenFunction::EmitARCRetain(QualType type, llvm::Value *value) {
2232 if (type->isBlockPointerType())
John McCallff613032011-10-04 06:23:45 +00002233 return EmitARCRetainBlock(value, /*mandatory*/ false);
John McCall31168b02011-06-15 23:02:42 +00002234 else
2235 return EmitARCRetainNonBlock(value);
2236}
2237
2238/// Retain the given object, with normal retain semantics.
James Dennett14c41ea2012-06-22 05:41:30 +00002239/// call i8* \@objc_retain(i8* %value)
Pete Cooper94867712016-03-21 20:50:03 +00002240llvm::Value *CodeGenFunction::EmitARCRetainNonBlock(llvm::Value *value) {
Pete Coopere3886802018-12-08 05:13:50 +00002241 return emitARCValueOperation(*this, value, nullptr,
John McCallb04ecb72015-10-21 18:06:43 +00002242 CGM.getObjCEntrypoints().objc_retain,
Pete Cooper2cd35962018-12-18 20:33:00 +00002243 llvm::Intrinsic::objc_retain);
John McCall31168b02011-06-15 23:02:42 +00002244}
2245
2246/// Retain the given block, with _Block_copy semantics.
James Dennett14c41ea2012-06-22 05:41:30 +00002247/// call i8* \@objc_retainBlock(i8* %value)
John McCallff613032011-10-04 06:23:45 +00002248///
2249/// \param mandatory - If false, emit the call with metadata
2250/// indicating that it's okay for the optimizer to eliminate this call
2251/// if it can prove that the block never escapes except down the stack.
2252llvm::Value *CodeGenFunction::EmitARCRetainBlock(llvm::Value *value,
2253 bool mandatory) {
2254 llvm::Value *result
Pete Coopere3886802018-12-08 05:13:50 +00002255 = emitARCValueOperation(*this, value, nullptr,
John McCallb04ecb72015-10-21 18:06:43 +00002256 CGM.getObjCEntrypoints().objc_retainBlock,
Pete Cooper2cd35962018-12-18 20:33:00 +00002257 llvm::Intrinsic::objc_retainBlock);
John McCallff613032011-10-04 06:23:45 +00002258
2259 // If the copy isn't mandatory, add !clang.arc.copy_on_escape to
2260 // tell the optimizer that it doesn't need to do this copy if the
2261 // block doesn't escape, where being passed as an argument doesn't
2262 // count as escaping.
2263 if (!mandatory && isa<llvm::Instruction>(result)) {
2264 llvm::CallInst *call
2265 = cast<llvm::CallInst>(result->stripPointerCasts());
Craig Toppera58b62b2020-04-27 20:15:59 -07002266 assert(call->getCalledOperand() ==
2267 CGM.getObjCEntrypoints().objc_retainBlock);
John McCallff613032011-10-04 06:23:45 +00002268
John McCallff613032011-10-04 06:23:45 +00002269 call->setMetadata("clang.arc.copy_on_escape",
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002270 llvm::MDNode::get(Builder.getContext(), None));
John McCallff613032011-10-04 06:23:45 +00002271 }
2272
2273 return result;
John McCall31168b02011-06-15 23:02:42 +00002274}
2275
John McCalle399e5b2016-01-27 18:32:30 +00002276static void emitAutoreleasedReturnValueMarker(CodeGenFunction &CGF) {
John McCall31168b02011-06-15 23:02:42 +00002277 // Fetch the void(void) inline asm which marks that we're going to
John McCalle399e5b2016-01-27 18:32:30 +00002278 // do something with the autoreleased return value.
John McCall31168b02011-06-15 23:02:42 +00002279 llvm::InlineAsm *&marker
John McCalle399e5b2016-01-27 18:32:30 +00002280 = CGF.CGM.getObjCEntrypoints().retainAutoreleasedReturnValueMarker;
John McCall31168b02011-06-15 23:02:42 +00002281 if (!marker) {
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002282 StringRef assembly
John McCalle399e5b2016-01-27 18:32:30 +00002283 = CGF.CGM.getTargetCodeGenInfo()
John McCall31168b02011-06-15 23:02:42 +00002284 .getARCRetainAutoreleasedReturnValueMarker();
2285
2286 // If we have an empty assembly string, there's nothing to do.
2287 if (assembly.empty()) {
2288
2289 // Otherwise, at -O0, build an inline asm that we're going to call
2290 // in a moment.
John McCalle399e5b2016-01-27 18:32:30 +00002291 } else if (CGF.CGM.getCodeGenOpts().OptimizationLevel == 0) {
John McCall31168b02011-06-15 23:02:42 +00002292 llvm::FunctionType *type =
John McCalle399e5b2016-01-27 18:32:30 +00002293 llvm::FunctionType::get(CGF.VoidTy, /*variadic*/false);
Fangrui Song6907ce22018-07-30 19:24:48 +00002294
John McCall31168b02011-06-15 23:02:42 +00002295 marker = llvm::InlineAsm::get(type, assembly, "", /*sideeffects*/ true);
2296
2297 // If we're at -O1 and above, we don't want to litter the code
2298 // with this marker yet, so leave a breadcrumb for the ARC
2299 // optimizer to pick up.
2300 } else {
Akira Hatanaka60c3a3b2019-04-10 06:20:23 +00002301 const char *markerKey = "clang.arc.retainAutoreleasedReturnValueMarker";
2302 if (!CGF.CGM.getModule().getModuleFlag(markerKey)) {
2303 auto *str = llvm::MDString::get(CGF.getLLVMContext(), assembly);
2304 CGF.CGM.getModule().addModuleFlag(llvm::Module::Error, markerKey, str);
John McCall31168b02011-06-15 23:02:42 +00002305 }
2306 }
2307 }
2308
2309 // Call the marker asm if we made one, which we do only at -O0.
David Blaikie43f9bb72015-05-18 22:14:03 +00002310 if (marker)
Shoaib Meenaif6985692018-03-19 19:34:39 +00002311 CGF.Builder.CreateCall(marker, None, CGF.getBundlesForFunclet(marker));
John McCalle399e5b2016-01-27 18:32:30 +00002312}
John McCall31168b02011-06-15 23:02:42 +00002313
John McCalle399e5b2016-01-27 18:32:30 +00002314/// Retain the given object which is the result of a function call.
2315/// call i8* \@objc_retainAutoreleasedReturnValue(i8* %value)
2316///
2317/// Yes, this function name is one character away from a different
2318/// call with completely different semantics.
2319llvm::Value *
2320CodeGenFunction::EmitARCRetainAutoreleasedReturnValue(llvm::Value *value) {
2321 emitAutoreleasedReturnValueMarker(*this);
Akira Hatanaka65bb3f92019-03-21 19:59:49 +00002322 llvm::CallInst::TailCallKind tailKind =
Akira Hatanaka41b1e972020-08-03 13:25:25 -07002323 CGM.getTargetCodeGenInfo().markARCOptimizedReturnCallsAsNoTail()
Akira Hatanaka65bb3f92019-03-21 19:59:49 +00002324 ? llvm::CallInst::TCK_NoTail
2325 : llvm::CallInst::TCK_None;
2326 return emitARCValueOperation(
2327 *this, value, nullptr,
2328 CGM.getObjCEntrypoints().objc_retainAutoreleasedReturnValue,
2329 llvm::Intrinsic::objc_retainAutoreleasedReturnValue, tailKind);
John McCall31168b02011-06-15 23:02:42 +00002330}
2331
John McCalle399e5b2016-01-27 18:32:30 +00002332/// Claim a possibly-autoreleased return value at +0. This is only
2333/// valid to do in contexts which do not rely on the retain to keep
Hiroshi Inoueef04f642018-01-26 08:15:52 +00002334/// the object valid for all of its uses; for example, when
John McCalle399e5b2016-01-27 18:32:30 +00002335/// the value is ignored, or when it is being assigned to an
2336/// __unsafe_unretained variable.
2337///
2338/// call i8* \@objc_unsafeClaimAutoreleasedReturnValue(i8* %value)
2339llvm::Value *
2340CodeGenFunction::EmitARCUnsafeClaimAutoreleasedReturnValue(llvm::Value *value) {
2341 emitAutoreleasedReturnValueMarker(*this);
Akira Hatanaka41b1e972020-08-03 13:25:25 -07002342 llvm::CallInst::TailCallKind tailKind =
2343 CGM.getTargetCodeGenInfo().markARCOptimizedReturnCallsAsNoTail()
2344 ? llvm::CallInst::TCK_NoTail
2345 : llvm::CallInst::TCK_None;
2346 return emitARCValueOperation(
2347 *this, value, nullptr,
2348 CGM.getObjCEntrypoints().objc_unsafeClaimAutoreleasedReturnValue,
2349 llvm::Intrinsic::objc_unsafeClaimAutoreleasedReturnValue, tailKind);
John McCalle399e5b2016-01-27 18:32:30 +00002350}
2351
John McCall31168b02011-06-15 23:02:42 +00002352/// Release the given object.
James Dennett14c41ea2012-06-22 05:41:30 +00002353/// call void \@objc_release(i8* %value)
John McCallcdda29c2013-03-13 03:10:54 +00002354void CodeGenFunction::EmitARCRelease(llvm::Value *value,
2355 ARCPreciseLifetime_t precise) {
John McCall31168b02011-06-15 23:02:42 +00002356 if (isa<llvm::ConstantPointerNull>(value)) return;
2357
James Y Knight9871db02019-02-05 16:42:33 +00002358 llvm::Function *&fn = CGM.getObjCEntrypoints().objc_release;
John McCall31168b02011-06-15 23:02:42 +00002359 if (!fn) {
Pete Cooper2cd35962018-12-18 20:33:00 +00002360 fn = CGM.getIntrinsic(llvm::Intrinsic::objc_release);
2361 setARCRuntimeFunctionLinkage(CGM, fn);
John McCall31168b02011-06-15 23:02:42 +00002362 }
2363
2364 // Cast the argument to 'id'.
2365 value = Builder.CreateBitCast(value, Int8PtrTy);
2366
2367 // Call objc_release.
John McCall882987f2013-02-28 19:01:20 +00002368 llvm::CallInst *call = EmitNounwindRuntimeCall(fn, value);
John McCall31168b02011-06-15 23:02:42 +00002369
John McCallcdda29c2013-03-13 03:10:54 +00002370 if (precise == ARCImpreciseLifetime) {
John McCall31168b02011-06-15 23:02:42 +00002371 call->setMetadata("clang.imprecise_release",
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002372 llvm::MDNode::get(Builder.getContext(), None));
John McCall31168b02011-06-15 23:02:42 +00002373 }
2374}
2375
John McCalle68b8f42012-10-17 02:28:37 +00002376/// Destroy a __strong variable.
2377///
2378/// At -O0, emit a call to store 'null' into the address;
2379/// instrumenting tools prefer this because the address is exposed,
2380/// but it's relatively cumbersome to optimize.
2381///
2382/// At -O1 and above, just load and call objc_release.
2383///
2384/// call void \@objc_storeStrong(i8** %addr, i8* null)
John McCall7f416cc2015-09-08 08:05:57 +00002385void CodeGenFunction::EmitARCDestroyStrong(Address addr,
John McCallcdda29c2013-03-13 03:10:54 +00002386 ARCPreciseLifetime_t precise) {
John McCalle68b8f42012-10-17 02:28:37 +00002387 if (CGM.getCodeGenOpts().OptimizationLevel == 0) {
John McCall7f416cc2015-09-08 08:05:57 +00002388 llvm::Value *null = getNullForVariable(addr);
John McCalle68b8f42012-10-17 02:28:37 +00002389 EmitARCStoreStrongCall(addr, null, /*ignored*/ true);
2390 return;
2391 }
2392
2393 llvm::Value *value = Builder.CreateLoad(addr);
2394 EmitARCRelease(value, precise);
2395}
2396
John McCall31168b02011-06-15 23:02:42 +00002397/// Store into a strong object. Always calls this:
James Dennett14c41ea2012-06-22 05:41:30 +00002398/// call void \@objc_storeStrong(i8** %addr, i8* %value)
John McCall7f416cc2015-09-08 08:05:57 +00002399llvm::Value *CodeGenFunction::EmitARCStoreStrongCall(Address addr,
John McCall31168b02011-06-15 23:02:42 +00002400 llvm::Value *value,
2401 bool ignored) {
John McCall7f416cc2015-09-08 08:05:57 +00002402 assert(addr.getElementType() == value->getType());
John McCall31168b02011-06-15 23:02:42 +00002403
James Y Knight9871db02019-02-05 16:42:33 +00002404 llvm::Function *&fn = CGM.getObjCEntrypoints().objc_storeStrong;
John McCall31168b02011-06-15 23:02:42 +00002405 if (!fn) {
Pete Cooper2cd35962018-12-18 20:33:00 +00002406 fn = CGM.getIntrinsic(llvm::Intrinsic::objc_storeStrong);
2407 setARCRuntimeFunctionLinkage(CGM, fn);
John McCall31168b02011-06-15 23:02:42 +00002408 }
2409
John McCall882987f2013-02-28 19:01:20 +00002410 llvm::Value *args[] = {
John McCall7f416cc2015-09-08 08:05:57 +00002411 Builder.CreateBitCast(addr.getPointer(), Int8PtrPtrTy),
John McCall882987f2013-02-28 19:01:20 +00002412 Builder.CreateBitCast(value, Int8PtrTy)
2413 };
2414 EmitNounwindRuntimeCall(fn, args);
John McCall31168b02011-06-15 23:02:42 +00002415
Craig Topper8a13c412014-05-21 05:09:00 +00002416 if (ignored) return nullptr;
John McCall31168b02011-06-15 23:02:42 +00002417 return value;
2418}
2419
2420/// Store into a strong object. Sometimes calls this:
James Dennett14c41ea2012-06-22 05:41:30 +00002421/// call void \@objc_storeStrong(i8** %addr, i8* %value)
John McCall31168b02011-06-15 23:02:42 +00002422/// Other times, breaks it down into components.
John McCall55e1fbc2011-06-25 02:11:03 +00002423llvm::Value *CodeGenFunction::EmitARCStoreStrong(LValue dst,
John McCall31168b02011-06-15 23:02:42 +00002424 llvm::Value *newValue,
2425 bool ignored) {
John McCall55e1fbc2011-06-25 02:11:03 +00002426 QualType type = dst.getType();
John McCall31168b02011-06-15 23:02:42 +00002427 bool isBlock = type->isBlockPointerType();
2428
2429 // Use a store barrier at -O0 unless this is a block type or the
2430 // lvalue is inadequately aligned.
2431 if (shouldUseFusedARCCalls() &&
2432 !isBlock &&
Eli Friedmana0544d62011-12-03 04:14:32 +00002433 (dst.getAlignment().isZero() ||
2434 dst.getAlignment() >= CharUnits::fromQuantity(PointerAlignInBytes))) {
Akira Hatanakaf139ae32019-12-03 15:17:01 -08002435 return EmitARCStoreStrongCall(dst.getAddress(*this), newValue, ignored);
John McCall31168b02011-06-15 23:02:42 +00002436 }
2437
2438 // Otherwise, split it out.
2439
2440 // Retain the new value.
2441 newValue = EmitARCRetain(type, newValue);
2442
2443 // Read the old value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002444 llvm::Value *oldValue = EmitLoadOfScalar(dst, SourceLocation());
John McCall31168b02011-06-15 23:02:42 +00002445
2446 // Store. We do this before the release so that any deallocs won't
2447 // see the old value.
John McCall55e1fbc2011-06-25 02:11:03 +00002448 EmitStoreOfScalar(newValue, dst);
John McCall31168b02011-06-15 23:02:42 +00002449
2450 // Finally, release the old value.
John McCallcdda29c2013-03-13 03:10:54 +00002451 EmitARCRelease(oldValue, dst.isARCPreciseLifetime());
John McCall31168b02011-06-15 23:02:42 +00002452
2453 return newValue;
2454}
2455
2456/// Autorelease the given object.
James Dennett14c41ea2012-06-22 05:41:30 +00002457/// call i8* \@objc_autorelease(i8* %value)
Pete Cooper94867712016-03-21 20:50:03 +00002458llvm::Value *CodeGenFunction::EmitARCAutorelease(llvm::Value *value) {
Pete Coopere3886802018-12-08 05:13:50 +00002459 return emitARCValueOperation(*this, value, nullptr,
John McCallb04ecb72015-10-21 18:06:43 +00002460 CGM.getObjCEntrypoints().objc_autorelease,
Pete Cooper2cd35962018-12-18 20:33:00 +00002461 llvm::Intrinsic::objc_autorelease);
John McCall31168b02011-06-15 23:02:42 +00002462}
2463
2464/// Autorelease the given object.
James Dennett14c41ea2012-06-22 05:41:30 +00002465/// call i8* \@objc_autoreleaseReturnValue(i8* %value)
John McCall31168b02011-06-15 23:02:42 +00002466llvm::Value *
2467CodeGenFunction::EmitARCAutoreleaseReturnValue(llvm::Value *value) {
Pete Coopere3886802018-12-08 05:13:50 +00002468 return emitARCValueOperation(*this, value, nullptr,
John McCallb04ecb72015-10-21 18:06:43 +00002469 CGM.getObjCEntrypoints().objc_autoreleaseReturnValue,
Pete Cooper2cd35962018-12-18 20:33:00 +00002470 llvm::Intrinsic::objc_autoreleaseReturnValue,
Akira Hatanaka65bb3f92019-03-21 19:59:49 +00002471 llvm::CallInst::TCK_Tail);
John McCall31168b02011-06-15 23:02:42 +00002472}
2473
2474/// Do a fused retain/autorelease of the given object.
James Dennett14c41ea2012-06-22 05:41:30 +00002475/// call i8* \@objc_retainAutoreleaseReturnValue(i8* %value)
John McCall31168b02011-06-15 23:02:42 +00002476llvm::Value *
2477CodeGenFunction::EmitARCRetainAutoreleaseReturnValue(llvm::Value *value) {
Pete Coopere3886802018-12-08 05:13:50 +00002478 return emitARCValueOperation(*this, value, nullptr,
John McCallb04ecb72015-10-21 18:06:43 +00002479 CGM.getObjCEntrypoints().objc_retainAutoreleaseReturnValue,
Pete Cooper2cd35962018-12-18 20:33:00 +00002480 llvm::Intrinsic::objc_retainAutoreleaseReturnValue,
Akira Hatanaka65bb3f92019-03-21 19:59:49 +00002481 llvm::CallInst::TCK_Tail);
John McCall31168b02011-06-15 23:02:42 +00002482}
2483
2484/// Do a fused retain/autorelease of the given object.
James Dennett14c41ea2012-06-22 05:41:30 +00002485/// call i8* \@objc_retainAutorelease(i8* %value)
John McCall31168b02011-06-15 23:02:42 +00002486/// or
James Dennett14c41ea2012-06-22 05:41:30 +00002487/// %retain = call i8* \@objc_retainBlock(i8* %value)
2488/// call i8* \@objc_autorelease(i8* %retain)
John McCall31168b02011-06-15 23:02:42 +00002489llvm::Value *CodeGenFunction::EmitARCRetainAutorelease(QualType type,
2490 llvm::Value *value) {
2491 if (!type->isBlockPointerType())
2492 return EmitARCRetainAutoreleaseNonBlock(value);
2493
2494 if (isa<llvm::ConstantPointerNull>(value)) return value;
2495
Chris Lattner2192fe52011-07-18 04:24:23 +00002496 llvm::Type *origType = value->getType();
John McCall31168b02011-06-15 23:02:42 +00002497 value = Builder.CreateBitCast(value, Int8PtrTy);
John McCallff613032011-10-04 06:23:45 +00002498 value = EmitARCRetainBlock(value, /*mandatory*/ true);
John McCall31168b02011-06-15 23:02:42 +00002499 value = EmitARCAutorelease(value);
2500 return Builder.CreateBitCast(value, origType);
2501}
2502
2503/// Do a fused retain/autorelease of the given object.
James Dennett14c41ea2012-06-22 05:41:30 +00002504/// call i8* \@objc_retainAutorelease(i8* %value)
John McCall31168b02011-06-15 23:02:42 +00002505llvm::Value *
2506CodeGenFunction::EmitARCRetainAutoreleaseNonBlock(llvm::Value *value) {
Pete Coopere3886802018-12-08 05:13:50 +00002507 return emitARCValueOperation(*this, value, nullptr,
John McCallb04ecb72015-10-21 18:06:43 +00002508 CGM.getObjCEntrypoints().objc_retainAutorelease,
Pete Cooper2cd35962018-12-18 20:33:00 +00002509 llvm::Intrinsic::objc_retainAutorelease);
John McCall31168b02011-06-15 23:02:42 +00002510}
2511
John McCallb04ecb72015-10-21 18:06:43 +00002512/// i8* \@objc_loadWeak(i8** %addr)
2513/// Essentially objc_autorelease(objc_loadWeakRetained(addr)).
2514llvm::Value *CodeGenFunction::EmitARCLoadWeak(Address addr) {
2515 return emitARCLoadOperation(*this, addr,
2516 CGM.getObjCEntrypoints().objc_loadWeak,
Pete Cooper2cd35962018-12-18 20:33:00 +00002517 llvm::Intrinsic::objc_loadWeak);
John McCallb04ecb72015-10-21 18:06:43 +00002518}
2519
James Dennett14c41ea2012-06-22 05:41:30 +00002520/// i8* \@objc_loadWeakRetained(i8** %addr)
John McCall7f416cc2015-09-08 08:05:57 +00002521llvm::Value *CodeGenFunction::EmitARCLoadWeakRetained(Address addr) {
John McCall31168b02011-06-15 23:02:42 +00002522 return emitARCLoadOperation(*this, addr,
John McCallb04ecb72015-10-21 18:06:43 +00002523 CGM.getObjCEntrypoints().objc_loadWeakRetained,
Pete Cooper2cd35962018-12-18 20:33:00 +00002524 llvm::Intrinsic::objc_loadWeakRetained);
John McCall31168b02011-06-15 23:02:42 +00002525}
2526
James Dennett14c41ea2012-06-22 05:41:30 +00002527/// i8* \@objc_storeWeak(i8** %addr, i8* %value)
John McCall31168b02011-06-15 23:02:42 +00002528/// Returns %value.
John McCall7f416cc2015-09-08 08:05:57 +00002529llvm::Value *CodeGenFunction::EmitARCStoreWeak(Address addr,
John McCall31168b02011-06-15 23:02:42 +00002530 llvm::Value *value,
2531 bool ignored) {
2532 return emitARCStoreOperation(*this, addr, value,
John McCallb04ecb72015-10-21 18:06:43 +00002533 CGM.getObjCEntrypoints().objc_storeWeak,
Pete Cooper2cd35962018-12-18 20:33:00 +00002534 llvm::Intrinsic::objc_storeWeak, ignored);
John McCall31168b02011-06-15 23:02:42 +00002535}
2536
James Dennett14c41ea2012-06-22 05:41:30 +00002537/// i8* \@objc_initWeak(i8** %addr, i8* %value)
John McCall31168b02011-06-15 23:02:42 +00002538/// Returns %value. %addr is known to not have a current weak entry.
2539/// Essentially equivalent to:
2540/// *addr = nil; objc_storeWeak(addr, value);
John McCall7f416cc2015-09-08 08:05:57 +00002541void CodeGenFunction::EmitARCInitWeak(Address addr, llvm::Value *value) {
John McCall31168b02011-06-15 23:02:42 +00002542 // If we're initializing to null, just write null to memory; no need
2543 // to get the runtime involved. But don't do this if optimization
2544 // is enabled, because accounting for this would make the optimizer
2545 // much more complicated.
2546 if (isa<llvm::ConstantPointerNull>(value) &&
2547 CGM.getCodeGenOpts().OptimizationLevel == 0) {
2548 Builder.CreateStore(value, addr);
2549 return;
2550 }
2551
2552 emitARCStoreOperation(*this, addr, value,
John McCallb04ecb72015-10-21 18:06:43 +00002553 CGM.getObjCEntrypoints().objc_initWeak,
Pete Cooper2cd35962018-12-18 20:33:00 +00002554 llvm::Intrinsic::objc_initWeak, /*ignored*/ true);
John McCall31168b02011-06-15 23:02:42 +00002555}
2556
James Dennett14c41ea2012-06-22 05:41:30 +00002557/// void \@objc_destroyWeak(i8** %addr)
John McCall31168b02011-06-15 23:02:42 +00002558/// Essentially objc_storeWeak(addr, nil).
John McCall7f416cc2015-09-08 08:05:57 +00002559void CodeGenFunction::EmitARCDestroyWeak(Address addr) {
James Y Knight9871db02019-02-05 16:42:33 +00002560 llvm::Function *&fn = CGM.getObjCEntrypoints().objc_destroyWeak;
John McCall31168b02011-06-15 23:02:42 +00002561 if (!fn) {
Pete Cooper2cd35962018-12-18 20:33:00 +00002562 fn = CGM.getIntrinsic(llvm::Intrinsic::objc_destroyWeak);
2563 setARCRuntimeFunctionLinkage(CGM, fn);
John McCall31168b02011-06-15 23:02:42 +00002564 }
2565
2566 // Cast the argument to 'id*'.
2567 addr = Builder.CreateBitCast(addr, Int8PtrPtrTy);
2568
John McCall7f416cc2015-09-08 08:05:57 +00002569 EmitNounwindRuntimeCall(fn, addr.getPointer());
John McCall31168b02011-06-15 23:02:42 +00002570}
2571
James Dennett14c41ea2012-06-22 05:41:30 +00002572/// void \@objc_moveWeak(i8** %dest, i8** %src)
John McCall31168b02011-06-15 23:02:42 +00002573/// Disregards the current value in %dest. Leaves %src pointing to nothing.
2574/// Essentially (objc_copyWeak(dest, src), objc_destroyWeak(src)).
John McCall7f416cc2015-09-08 08:05:57 +00002575void CodeGenFunction::EmitARCMoveWeak(Address dst, Address src) {
John McCall31168b02011-06-15 23:02:42 +00002576 emitARCCopyOperation(*this, dst, src,
John McCallb04ecb72015-10-21 18:06:43 +00002577 CGM.getObjCEntrypoints().objc_moveWeak,
Pete Cooper2cd35962018-12-18 20:33:00 +00002578 llvm::Intrinsic::objc_moveWeak);
John McCall31168b02011-06-15 23:02:42 +00002579}
2580
James Dennett14c41ea2012-06-22 05:41:30 +00002581/// void \@objc_copyWeak(i8** %dest, i8** %src)
John McCall31168b02011-06-15 23:02:42 +00002582/// Disregards the current value in %dest. Essentially
2583/// objc_release(objc_initWeak(dest, objc_readWeakRetained(src)))
John McCall7f416cc2015-09-08 08:05:57 +00002584void CodeGenFunction::EmitARCCopyWeak(Address dst, Address src) {
John McCall31168b02011-06-15 23:02:42 +00002585 emitARCCopyOperation(*this, dst, src,
John McCallb04ecb72015-10-21 18:06:43 +00002586 CGM.getObjCEntrypoints().objc_copyWeak,
Pete Cooper2cd35962018-12-18 20:33:00 +00002587 llvm::Intrinsic::objc_copyWeak);
John McCall31168b02011-06-15 23:02:42 +00002588}
2589
Akira Hatanakad791e922018-03-19 17:38:40 +00002590void CodeGenFunction::emitARCCopyAssignWeak(QualType Ty, Address DstAddr,
2591 Address SrcAddr) {
2592 llvm::Value *Object = EmitARCLoadWeakRetained(SrcAddr);
2593 Object = EmitObjCConsumeObject(Ty, Object);
2594 EmitARCStoreWeak(DstAddr, Object, false);
2595}
2596
2597void CodeGenFunction::emitARCMoveAssignWeak(QualType Ty, Address DstAddr,
2598 Address SrcAddr) {
2599 llvm::Value *Object = EmitARCLoadWeakRetained(SrcAddr);
2600 Object = EmitObjCConsumeObject(Ty, Object);
2601 EmitARCStoreWeak(DstAddr, Object, false);
2602 EmitARCDestroyWeak(SrcAddr);
2603}
2604
John McCall31168b02011-06-15 23:02:42 +00002605/// Produce the code to do a objc_autoreleasepool_push.
James Dennett14c41ea2012-06-22 05:41:30 +00002606/// call i8* \@objc_autoreleasePoolPush(void)
John McCall31168b02011-06-15 23:02:42 +00002607llvm::Value *CodeGenFunction::EmitObjCAutoreleasePoolPush() {
James Y Knight9871db02019-02-05 16:42:33 +00002608 llvm::Function *&fn = CGM.getObjCEntrypoints().objc_autoreleasePoolPush;
John McCall31168b02011-06-15 23:02:42 +00002609 if (!fn) {
Pete Cooper2cd35962018-12-18 20:33:00 +00002610 fn = CGM.getIntrinsic(llvm::Intrinsic::objc_autoreleasePoolPush);
2611 setARCRuntimeFunctionLinkage(CGM, fn);
John McCall31168b02011-06-15 23:02:42 +00002612 }
2613
John McCall882987f2013-02-28 19:01:20 +00002614 return EmitNounwindRuntimeCall(fn);
John McCall31168b02011-06-15 23:02:42 +00002615}
2616
2617/// Produce the code to do a primitive release.
James Dennett14c41ea2012-06-22 05:41:30 +00002618/// call void \@objc_autoreleasePoolPop(i8* %ptr)
John McCall31168b02011-06-15 23:02:42 +00002619void CodeGenFunction::EmitObjCAutoreleasePoolPop(llvm::Value *value) {
2620 assert(value->getType() == Int8PtrTy);
2621
Pete Cooper2cd35962018-12-18 20:33:00 +00002622 if (getInvokeDest()) {
2623 // Call the runtime method not the intrinsic if we are handling exceptions
James Y Knight9871db02019-02-05 16:42:33 +00002624 llvm::FunctionCallee &fn =
2625 CGM.getObjCEntrypoints().objc_autoreleasePoolPopInvoke;
Pete Cooper2cd35962018-12-18 20:33:00 +00002626 if (!fn) {
2627 llvm::FunctionType *fnType =
2628 llvm::FunctionType::get(Builder.getVoidTy(), Int8PtrTy, false);
2629 fn = CGM.CreateRuntimeFunction(fnType, "objc_autoreleasePoolPop");
2630 setARCRuntimeFunctionLinkage(CGM, fn);
2631 }
John McCall31168b02011-06-15 23:02:42 +00002632
Pete Cooper2cd35962018-12-18 20:33:00 +00002633 // objc_autoreleasePoolPop can throw.
2634 EmitRuntimeCallOrInvoke(fn, value);
2635 } else {
James Y Knight9871db02019-02-05 16:42:33 +00002636 llvm::FunctionCallee &fn = CGM.getObjCEntrypoints().objc_autoreleasePoolPop;
Pete Cooper2cd35962018-12-18 20:33:00 +00002637 if (!fn) {
2638 fn = CGM.getIntrinsic(llvm::Intrinsic::objc_autoreleasePoolPop);
2639 setARCRuntimeFunctionLinkage(CGM, fn);
2640 }
2641
2642 EmitRuntimeCall(fn, value);
John McCall31168b02011-06-15 23:02:42 +00002643 }
John McCall31168b02011-06-15 23:02:42 +00002644}
2645
2646/// Produce the code to do an MRR version objc_autoreleasepool_push.
2647/// Which is: [[NSAutoreleasePool alloc] init];
2648/// Where alloc is declared as: + (id) alloc; in NSAutoreleasePool class.
2649/// init is declared as: - (id) init; in its NSObject super class.
2650///
2651llvm::Value *CodeGenFunction::EmitObjCMRRAutoreleasePoolPush() {
2652 CGObjCRuntime &Runtime = CGM.getObjCRuntime();
John McCall882987f2013-02-28 19:01:20 +00002653 llvm::Value *Receiver = Runtime.EmitNSAutoreleasePoolClassRef(*this);
John McCall31168b02011-06-15 23:02:42 +00002654 // [NSAutoreleasePool alloc]
2655 IdentifierInfo *II = &CGM.getContext().Idents.get("alloc");
2656 Selector AllocSel = getContext().Selectors.getSelector(0, &II);
2657 CallArgList Args;
Fangrui Song6907ce22018-07-30 19:24:48 +00002658 RValue AllocRV =
2659 Runtime.GenerateMessageSend(*this, ReturnValueSlot(),
John McCall31168b02011-06-15 23:02:42 +00002660 getContext().getObjCIdType(),
Fangrui Song6907ce22018-07-30 19:24:48 +00002661 AllocSel, Receiver, Args);
John McCall31168b02011-06-15 23:02:42 +00002662
2663 // [Receiver init]
2664 Receiver = AllocRV.getScalarVal();
2665 II = &CGM.getContext().Idents.get("init");
2666 Selector InitSel = getContext().Selectors.getSelector(0, &II);
2667 RValue InitRV =
2668 Runtime.GenerateMessageSend(*this, ReturnValueSlot(),
2669 getContext().getObjCIdType(),
Fangrui Song6907ce22018-07-30 19:24:48 +00002670 InitSel, Receiver, Args);
John McCall31168b02011-06-15 23:02:42 +00002671 return InitRV.getScalarVal();
2672}
2673
Pete Coopere3886802018-12-08 05:13:50 +00002674/// Allocate the given objc object.
2675/// call i8* \@objc_alloc(i8* %value)
2676llvm::Value *CodeGenFunction::EmitObjCAlloc(llvm::Value *value,
2677 llvm::Type *resultType) {
Pete Cooper2cd35962018-12-18 20:33:00 +00002678 return emitObjCValueOperation(*this, value, resultType,
2679 CGM.getObjCEntrypoints().objc_alloc,
Erik Pilkingtonf6c645f2019-05-15 20:15:01 +00002680 "objc_alloc");
Pete Coopere3886802018-12-08 05:13:50 +00002681}
2682
2683/// Allocate the given objc object.
2684/// call i8* \@objc_allocWithZone(i8* %value)
2685llvm::Value *CodeGenFunction::EmitObjCAllocWithZone(llvm::Value *value,
2686 llvm::Type *resultType) {
Pete Cooper2cd35962018-12-18 20:33:00 +00002687 return emitObjCValueOperation(*this, value, resultType,
2688 CGM.getObjCEntrypoints().objc_allocWithZone,
Erik Pilkingtonf6c645f2019-05-15 20:15:01 +00002689 "objc_allocWithZone");
Pete Coopere3886802018-12-08 05:13:50 +00002690}
2691
Erik Pilkingtonec389b02019-02-14 19:58:37 +00002692llvm::Value *CodeGenFunction::EmitObjCAllocInit(llvm::Value *value,
2693 llvm::Type *resultType) {
2694 return emitObjCValueOperation(*this, value, resultType,
2695 CGM.getObjCEntrypoints().objc_alloc_init,
Erik Pilkingtonf6c645f2019-05-15 20:15:01 +00002696 "objc_alloc_init");
Erik Pilkingtonec389b02019-02-14 19:58:37 +00002697}
2698
John McCall31168b02011-06-15 23:02:42 +00002699/// Produce the code to do a primitive release.
2700/// [tmp drain];
2701void CodeGenFunction::EmitObjCMRRAutoreleasePoolPop(llvm::Value *Arg) {
2702 IdentifierInfo *II = &CGM.getContext().Idents.get("drain");
2703 Selector DrainSel = getContext().Selectors.getSelector(0, &II);
2704 CallArgList Args;
2705 CGM.getObjCRuntime().GenerateMessageSend(*this, ReturnValueSlot(),
Fangrui Song6907ce22018-07-30 19:24:48 +00002706 getContext().VoidTy, DrainSel, Arg, Args);
John McCall31168b02011-06-15 23:02:42 +00002707}
2708
John McCall82fe67b2011-07-09 01:37:26 +00002709void CodeGenFunction::destroyARCStrongPrecise(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00002710 Address addr,
John McCall82fe67b2011-07-09 01:37:26 +00002711 QualType type) {
John McCallcdda29c2013-03-13 03:10:54 +00002712 CGF.EmitARCDestroyStrong(addr, ARCPreciseLifetime);
John McCall82fe67b2011-07-09 01:37:26 +00002713}
2714
2715void CodeGenFunction::destroyARCStrongImprecise(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00002716 Address addr,
John McCall82fe67b2011-07-09 01:37:26 +00002717 QualType type) {
John McCallcdda29c2013-03-13 03:10:54 +00002718 CGF.EmitARCDestroyStrong(addr, ARCImpreciseLifetime);
John McCall82fe67b2011-07-09 01:37:26 +00002719}
2720
2721void CodeGenFunction::destroyARCWeak(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00002722 Address addr,
John McCall82fe67b2011-07-09 01:37:26 +00002723 QualType type) {
2724 CGF.EmitARCDestroyWeak(addr);
2725}
2726
Akira Hatanakaa6b6dcc2017-04-28 18:50:57 +00002727void CodeGenFunction::emitARCIntrinsicUse(CodeGenFunction &CGF, Address addr,
2728 QualType type) {
2729 llvm::Value *value = CGF.Builder.CreateLoad(addr);
2730 CGF.EmitARCIntrinsicUse(value);
2731}
2732
Pete Coopere5b64ea2018-12-21 21:00:32 +00002733/// Autorelease the given object.
2734/// call i8* \@objc_autorelease(i8* %value)
2735llvm::Value *CodeGenFunction::EmitObjCAutorelease(llvm::Value *value,
2736 llvm::Type *returnType) {
Erik Pilkington1f7eda52019-01-30 23:17:38 +00002737 return emitObjCValueOperation(
2738 *this, value, returnType,
2739 CGM.getObjCEntrypoints().objc_autoreleaseRuntimeFunction,
Erik Pilkingtonf6c645f2019-05-15 20:15:01 +00002740 "objc_autorelease");
Pete Coopere5b64ea2018-12-21 21:00:32 +00002741}
2742
2743/// Retain the given object, with normal retain semantics.
2744/// call i8* \@objc_retain(i8* %value)
2745llvm::Value *CodeGenFunction::EmitObjCRetainNonBlock(llvm::Value *value,
2746 llvm::Type *returnType) {
Erik Pilkington1f7eda52019-01-30 23:17:38 +00002747 return emitObjCValueOperation(
2748 *this, value, returnType,
Erik Pilkingtonf6c645f2019-05-15 20:15:01 +00002749 CGM.getObjCEntrypoints().objc_retainRuntimeFunction, "objc_retain");
Pete Coopere5b64ea2018-12-21 21:00:32 +00002750}
2751
2752/// Release the given object.
2753/// call void \@objc_release(i8* %value)
2754void CodeGenFunction::EmitObjCRelease(llvm::Value *value,
2755 ARCPreciseLifetime_t precise) {
2756 if (isa<llvm::ConstantPointerNull>(value)) return;
2757
James Y Knight9871db02019-02-05 16:42:33 +00002758 llvm::FunctionCallee &fn =
2759 CGM.getObjCEntrypoints().objc_releaseRuntimeFunction;
Pete Coopere5b64ea2018-12-21 21:00:32 +00002760 if (!fn) {
James Y Knight9871db02019-02-05 16:42:33 +00002761 llvm::FunctionType *fnType =
Pete Coopere5b64ea2018-12-21 21:00:32 +00002762 llvm::FunctionType::get(Builder.getVoidTy(), Int8PtrTy, false);
James Y Knight9871db02019-02-05 16:42:33 +00002763 fn = CGM.CreateRuntimeFunction(fnType, "objc_release");
2764 setARCRuntimeFunctionLinkage(CGM, fn);
2765 // We have Native ARC, so set nonlazybind attribute for performance
2766 if (llvm::Function *f = dyn_cast<llvm::Function>(fn.getCallee()))
2767 f->addFnAttr(llvm::Attribute::NonLazyBind);
Pete Coopere5b64ea2018-12-21 21:00:32 +00002768 }
2769
2770 // Cast the argument to 'id'.
2771 value = Builder.CreateBitCast(value, Int8PtrTy);
2772
2773 // Call objc_release.
Akira Hatanaka34d28cf2019-05-10 21:54:16 +00002774 llvm::CallBase *call = EmitCallOrInvoke(fn, value);
Pete Coopere5b64ea2018-12-21 21:00:32 +00002775
2776 if (precise == ARCImpreciseLifetime) {
2777 call->setMetadata("clang.imprecise_release",
2778 llvm::MDNode::get(Builder.getContext(), None));
2779 }
2780}
2781
John McCall31168b02011-06-15 23:02:42 +00002782namespace {
David Blaikie7e70d682015-08-18 22:40:54 +00002783 struct CallObjCAutoreleasePoolObject final : EHScopeStack::Cleanup {
John McCall31168b02011-06-15 23:02:42 +00002784 llvm::Value *Token;
2785
2786 CallObjCAutoreleasePoolObject(llvm::Value *token) : Token(token) {}
2787
Craig Topper4f12f102014-03-12 06:41:41 +00002788 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall31168b02011-06-15 23:02:42 +00002789 CGF.EmitObjCAutoreleasePoolPop(Token);
2790 }
2791 };
David Blaikie7e70d682015-08-18 22:40:54 +00002792 struct CallObjCMRRAutoreleasePoolObject final : EHScopeStack::Cleanup {
John McCall31168b02011-06-15 23:02:42 +00002793 llvm::Value *Token;
2794
2795 CallObjCMRRAutoreleasePoolObject(llvm::Value *token) : Token(token) {}
2796
Craig Topper4f12f102014-03-12 06:41:41 +00002797 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall31168b02011-06-15 23:02:42 +00002798 CGF.EmitObjCMRRAutoreleasePoolPop(Token);
2799 }
2800 };
Alexander Kornienkoab9db512015-06-22 23:07:51 +00002801}
John McCall31168b02011-06-15 23:02:42 +00002802
2803void CodeGenFunction::EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr) {
David Blaikiebbafb8a2012-03-11 07:00:24 +00002804 if (CGM.getLangOpts().ObjCAutoRefCount)
John McCall31168b02011-06-15 23:02:42 +00002805 EHStack.pushCleanup<CallObjCAutoreleasePoolObject>(NormalCleanup, Ptr);
2806 else
2807 EHStack.pushCleanup<CallObjCMRRAutoreleasePoolObject>(NormalCleanup, Ptr);
2808}
2809
Volodymyr Sapsai8b286f92018-11-01 22:50:08 +00002810static bool shouldRetainObjCLifetime(Qualifiers::ObjCLifetime lifetime) {
2811 switch (lifetime) {
John McCall31168b02011-06-15 23:02:42 +00002812 case Qualifiers::OCL_None:
2813 case Qualifiers::OCL_ExplicitNone:
2814 case Qualifiers::OCL_Strong:
2815 case Qualifiers::OCL_Autoreleasing:
Volodymyr Sapsai8b286f92018-11-01 22:50:08 +00002816 return true;
John McCall31168b02011-06-15 23:02:42 +00002817
2818 case Qualifiers::OCL_Weak:
Volodymyr Sapsai8b286f92018-11-01 22:50:08 +00002819 return false;
John McCall31168b02011-06-15 23:02:42 +00002820 }
2821
2822 llvm_unreachable("impossible lifetime!");
John McCall31168b02011-06-15 23:02:42 +00002823}
2824
2825static TryEmitResult tryEmitARCRetainLoadOfScalar(CodeGenFunction &CGF,
Volodymyr Sapsai8b286f92018-11-01 22:50:08 +00002826 LValue lvalue,
2827 QualType type) {
2828 llvm::Value *result;
2829 bool shouldRetain = shouldRetainObjCLifetime(type.getObjCLifetime());
2830 if (shouldRetain) {
2831 result = CGF.EmitLoadOfLValue(lvalue, SourceLocation()).getScalarVal();
2832 } else {
2833 assert(type.getObjCLifetime() == Qualifiers::OCL_Weak);
Akira Hatanakaf139ae32019-12-03 15:17:01 -08002834 result = CGF.EmitARCLoadWeakRetained(lvalue.getAddress(CGF));
Volodymyr Sapsai8b286f92018-11-01 22:50:08 +00002835 }
2836 return TryEmitResult(result, !shouldRetain);
2837}
2838
2839static TryEmitResult tryEmitARCRetainLoadOfScalar(CodeGenFunction &CGF,
John McCall31168b02011-06-15 23:02:42 +00002840 const Expr *e) {
2841 e = e->IgnoreParens();
2842 QualType type = e->getType();
2843
Fangrui Song6907ce22018-07-30 19:24:48 +00002844 // If we're loading retained from a __strong xvalue, we can avoid
John McCall154a2fd2011-08-30 00:57:29 +00002845 // an extra retain/release pair by zeroing out the source of this
2846 // "move" operation.
2847 if (e->isXValue() &&
2848 !type.isConstQualified() &&
2849 type.getObjCLifetime() == Qualifiers::OCL_Strong) {
2850 // Emit the lvalue.
2851 LValue lv = CGF.EmitLValue(e);
Fangrui Song6907ce22018-07-30 19:24:48 +00002852
John McCall154a2fd2011-08-30 00:57:29 +00002853 // Load the object pointer.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002854 llvm::Value *result = CGF.EmitLoadOfLValue(lv,
2855 SourceLocation()).getScalarVal();
Fangrui Song6907ce22018-07-30 19:24:48 +00002856
John McCall154a2fd2011-08-30 00:57:29 +00002857 // Set the source pointer to NULL.
Akira Hatanakaf139ae32019-12-03 15:17:01 -08002858 CGF.EmitStoreOfScalar(getNullForVariable(lv.getAddress(CGF)), lv);
Fangrui Song6907ce22018-07-30 19:24:48 +00002859
John McCall154a2fd2011-08-30 00:57:29 +00002860 return TryEmitResult(result, true);
2861 }
2862
John McCall31168b02011-06-15 23:02:42 +00002863 // As a very special optimization, in ARC++, if the l-value is the
2864 // result of a non-volatile assignment, do a simple retain of the
2865 // result of the call to objc_storeWeak instead of reloading.
David Blaikiebbafb8a2012-03-11 07:00:24 +00002866 if (CGF.getLangOpts().CPlusPlus &&
John McCall31168b02011-06-15 23:02:42 +00002867 !type.isVolatileQualified() &&
2868 type.getObjCLifetime() == Qualifiers::OCL_Weak &&
2869 isa<BinaryOperator>(e) &&
2870 cast<BinaryOperator>(e)->getOpcode() == BO_Assign)
2871 return TryEmitResult(CGF.EmitScalarExpr(e), false);
2872
Volodymyr Sapsai8b286f92018-11-01 22:50:08 +00002873 // Try to emit code for scalar constant instead of emitting LValue and
2874 // loading it because we are not guaranteed to have an l-value. One of such
2875 // cases is DeclRefExpr referencing non-odr-used constant-evaluated variable.
2876 if (const auto *decl_expr = dyn_cast<DeclRefExpr>(e)) {
2877 auto *DRE = const_cast<DeclRefExpr *>(decl_expr);
2878 if (CodeGenFunction::ConstantEmission constant = CGF.tryEmitAsConstant(DRE))
2879 return TryEmitResult(CGF.emitScalarConstant(constant, DRE),
2880 !shouldRetainObjCLifetime(type.getObjCLifetime()));
2881 }
2882
John McCall31168b02011-06-15 23:02:42 +00002883 return tryEmitARCRetainLoadOfScalar(CGF, CGF.EmitLValue(e), type);
2884}
2885
John McCalle399e5b2016-01-27 18:32:30 +00002886typedef llvm::function_ref<llvm::Value *(CodeGenFunction &CGF,
2887 llvm::Value *value)>
2888 ValueTransform;
John McCall31168b02011-06-15 23:02:42 +00002889
John McCalle399e5b2016-01-27 18:32:30 +00002890/// Insert code immediately after a call.
2891static llvm::Value *emitARCOperationAfterCall(CodeGenFunction &CGF,
2892 llvm::Value *value,
2893 ValueTransform doAfterCall,
2894 ValueTransform doFallback) {
John McCall31168b02011-06-15 23:02:42 +00002895 if (llvm::CallInst *call = dyn_cast<llvm::CallInst>(value)) {
2896 CGBuilderTy::InsertPoint ip = CGF.Builder.saveIP();
2897
2898 // Place the retain immediately following the call.
2899 CGF.Builder.SetInsertPoint(call->getParent(),
2900 ++llvm::BasicBlock::iterator(call));
John McCalle399e5b2016-01-27 18:32:30 +00002901 value = doAfterCall(CGF, value);
John McCall31168b02011-06-15 23:02:42 +00002902
2903 CGF.Builder.restoreIP(ip);
2904 return value;
2905 } else if (llvm::InvokeInst *invoke = dyn_cast<llvm::InvokeInst>(value)) {
2906 CGBuilderTy::InsertPoint ip = CGF.Builder.saveIP();
2907
2908 // Place the retain at the beginning of the normal destination block.
2909 llvm::BasicBlock *BB = invoke->getNormalDest();
2910 CGF.Builder.SetInsertPoint(BB, BB->begin());
John McCalle399e5b2016-01-27 18:32:30 +00002911 value = doAfterCall(CGF, value);
John McCall31168b02011-06-15 23:02:42 +00002912
2913 CGF.Builder.restoreIP(ip);
2914 return value;
2915
2916 // Bitcasts can arise because of related-result returns. Rewrite
2917 // the operand.
2918 } else if (llvm::BitCastInst *bitcast = dyn_cast<llvm::BitCastInst>(value)) {
2919 llvm::Value *operand = bitcast->getOperand(0);
John McCalle399e5b2016-01-27 18:32:30 +00002920 operand = emitARCOperationAfterCall(CGF, operand, doAfterCall, doFallback);
John McCall31168b02011-06-15 23:02:42 +00002921 bitcast->setOperand(0, operand);
2922 return bitcast;
2923
2924 // Generic fall-back case.
2925 } else {
2926 // Retain using the non-block variant: we never need to do a copy
2927 // of a block that's been returned to us.
John McCalle399e5b2016-01-27 18:32:30 +00002928 return doFallback(CGF, value);
2929 }
2930}
2931
2932/// Given that the given expression is some sort of call (which does
2933/// not return retained), emit a retain following it.
2934static llvm::Value *emitARCRetainCallResult(CodeGenFunction &CGF,
2935 const Expr *e) {
2936 llvm::Value *value = CGF.EmitScalarExpr(e);
2937 return emitARCOperationAfterCall(CGF, value,
2938 [](CodeGenFunction &CGF, llvm::Value *value) {
2939 return CGF.EmitARCRetainAutoreleasedReturnValue(value);
2940 },
2941 [](CodeGenFunction &CGF, llvm::Value *value) {
2942 return CGF.EmitARCRetainNonBlock(value);
2943 });
2944}
2945
2946/// Given that the given expression is some sort of call (which does
2947/// not return retained), perform an unsafeClaim following it.
2948static llvm::Value *emitARCUnsafeClaimCallResult(CodeGenFunction &CGF,
2949 const Expr *e) {
2950 llvm::Value *value = CGF.EmitScalarExpr(e);
2951 return emitARCOperationAfterCall(CGF, value,
2952 [](CodeGenFunction &CGF, llvm::Value *value) {
2953 return CGF.EmitARCUnsafeClaimAutoreleasedReturnValue(value);
2954 },
2955 [](CodeGenFunction &CGF, llvm::Value *value) {
2956 return value;
2957 });
2958}
2959
2960llvm::Value *CodeGenFunction::EmitARCReclaimReturnedObject(const Expr *E,
2961 bool allowUnsafeClaim) {
2962 if (allowUnsafeClaim &&
2963 CGM.getLangOpts().ObjCRuntime.hasARCUnsafeClaimAutoreleasedReturnValue()) {
2964 return emitARCUnsafeClaimCallResult(*this, E);
2965 } else {
2966 llvm::Value *value = emitARCRetainCallResult(*this, E);
2967 return EmitObjCConsumeObject(E->getType(), value);
John McCall31168b02011-06-15 23:02:42 +00002968 }
2969}
2970
John McCallcd78e802011-09-10 01:16:55 +00002971/// Determine whether it might be important to emit a separate
2972/// objc_retain_block on the result of the given expression, or
2973/// whether it's okay to just emit it in a +1 context.
2974static bool shouldEmitSeparateBlockRetain(const Expr *e) {
2975 assert(e->getType()->isBlockPointerType());
2976 e = e->IgnoreParens();
2977
2978 // For future goodness, emit block expressions directly in +1
2979 // contexts if we can.
2980 if (isa<BlockExpr>(e))
2981 return false;
2982
2983 if (const CastExpr *cast = dyn_cast<CastExpr>(e)) {
2984 switch (cast->getCastKind()) {
2985 // Emitting these operations in +1 contexts is goodness.
2986 case CK_LValueToRValue:
John McCall2d637d22011-09-10 06:18:15 +00002987 case CK_ARCReclaimReturnedObject:
2988 case CK_ARCConsumeObject:
2989 case CK_ARCProduceObject:
John McCallcd78e802011-09-10 01:16:55 +00002990 return false;
2991
2992 // These operations preserve a block type.
2993 case CK_NoOp:
2994 case CK_BitCast:
2995 return shouldEmitSeparateBlockRetain(cast->getSubExpr());
2996
2997 // These operations are known to be bad (or haven't been considered).
2998 case CK_AnyPointerToBlockPointerCast:
2999 default:
3000 return true;
3001 }
3002 }
3003
3004 return true;
3005}
3006
John McCalle399e5b2016-01-27 18:32:30 +00003007namespace {
3008/// A CRTP base class for emitting expressions of retainable object
3009/// pointer type in ARC.
3010template <typename Impl, typename Result> class ARCExprEmitter {
3011protected:
3012 CodeGenFunction &CGF;
3013 Impl &asImpl() { return *static_cast<Impl*>(this); }
3014
3015 ARCExprEmitter(CodeGenFunction &CGF) : CGF(CGF) {}
3016
3017public:
3018 Result visit(const Expr *e);
3019 Result visitCastExpr(const CastExpr *e);
3020 Result visitPseudoObjectExpr(const PseudoObjectExpr *e);
Akira Hatanakac5792aa2019-02-27 18:17:16 +00003021 Result visitBlockExpr(const BlockExpr *e);
John McCalle399e5b2016-01-27 18:32:30 +00003022 Result visitBinaryOperator(const BinaryOperator *e);
3023 Result visitBinAssign(const BinaryOperator *e);
3024 Result visitBinAssignUnsafeUnretained(const BinaryOperator *e);
3025 Result visitBinAssignAutoreleasing(const BinaryOperator *e);
3026 Result visitBinAssignWeak(const BinaryOperator *e);
3027 Result visitBinAssignStrong(const BinaryOperator *e);
3028
3029 // Minimal implementation:
3030 // Result visitLValueToRValue(const Expr *e)
3031 // Result visitConsumeObject(const Expr *e)
3032 // Result visitExtendBlockObject(const Expr *e)
3033 // Result visitReclaimReturnedObject(const Expr *e)
3034 // Result visitCall(const Expr *e)
3035 // Result visitExpr(const Expr *e)
3036 //
3037 // Result emitBitCast(Result result, llvm::Type *resultType)
3038 // llvm::Value *getValueOfResult(Result result)
3039};
3040}
3041
3042/// Try to emit a PseudoObjectExpr under special ARC rules.
John McCallfe96e0b2011-11-06 09:01:30 +00003043///
3044/// This massively duplicates emitPseudoObjectRValue.
John McCalle399e5b2016-01-27 18:32:30 +00003045template <typename Impl, typename Result>
3046Result
3047ARCExprEmitter<Impl,Result>::visitPseudoObjectExpr(const PseudoObjectExpr *E) {
Dmitri Gribenkof8579502013-01-12 19:30:44 +00003048 SmallVector<CodeGenFunction::OpaqueValueMappingData, 4> opaques;
John McCallfe96e0b2011-11-06 09:01:30 +00003049
3050 // Find the result expression.
3051 const Expr *resultExpr = E->getResultExpr();
3052 assert(resultExpr);
John McCalle399e5b2016-01-27 18:32:30 +00003053 Result result;
John McCallfe96e0b2011-11-06 09:01:30 +00003054
3055 for (PseudoObjectExpr::const_semantics_iterator
3056 i = E->semantics_begin(), e = E->semantics_end(); i != e; ++i) {
3057 const Expr *semantic = *i;
3058
3059 // If this semantic expression is an opaque value, bind it
3060 // to the result of its source expression.
3061 if (const OpaqueValueExpr *ov = dyn_cast<OpaqueValueExpr>(semantic)) {
3062 typedef CodeGenFunction::OpaqueValueMappingData OVMA;
3063 OVMA opaqueData;
3064
3065 // If this semantic is the result of the pseudo-object
3066 // expression, try to evaluate the source as +1.
3067 if (ov == resultExpr) {
3068 assert(!OVMA::shouldBindAsLValue(ov));
John McCalle399e5b2016-01-27 18:32:30 +00003069 result = asImpl().visit(ov->getSourceExpr());
3070 opaqueData = OVMA::bind(CGF, ov,
3071 RValue::get(asImpl().getValueOfResult(result)));
John McCallfe96e0b2011-11-06 09:01:30 +00003072
3073 // Otherwise, just bind it.
3074 } else {
3075 opaqueData = OVMA::bind(CGF, ov, ov->getSourceExpr());
3076 }
3077 opaques.push_back(opaqueData);
3078
3079 // Otherwise, if the expression is the result, evaluate it
3080 // and remember the result.
3081 } else if (semantic == resultExpr) {
John McCalle399e5b2016-01-27 18:32:30 +00003082 result = asImpl().visit(semantic);
John McCallfe96e0b2011-11-06 09:01:30 +00003083
3084 // Otherwise, evaluate the expression in an ignored context.
3085 } else {
3086 CGF.EmitIgnoredExpr(semantic);
3087 }
3088 }
3089
3090 // Unbind all the opaques now.
3091 for (unsigned i = 0, e = opaques.size(); i != e; ++i)
3092 opaques[i].unbind(CGF);
3093
3094 return result;
3095}
3096
John McCalle399e5b2016-01-27 18:32:30 +00003097template <typename Impl, typename Result>
Akira Hatanakac5792aa2019-02-27 18:17:16 +00003098Result ARCExprEmitter<Impl, Result>::visitBlockExpr(const BlockExpr *e) {
3099 // The default implementation just forwards the expression to visitExpr.
3100 return asImpl().visitExpr(e);
3101}
3102
3103template <typename Impl, typename Result>
John McCalle399e5b2016-01-27 18:32:30 +00003104Result ARCExprEmitter<Impl,Result>::visitCastExpr(const CastExpr *e) {
3105 switch (e->getCastKind()) {
John McCall53848232011-07-27 01:07:15 +00003106
John McCalle399e5b2016-01-27 18:32:30 +00003107 // No-op casts don't change the type, so we just ignore them.
3108 case CK_NoOp:
3109 return asImpl().visit(e->getSubExpr());
John McCall31168b02011-06-15 23:02:42 +00003110
John McCalle399e5b2016-01-27 18:32:30 +00003111 // These casts can change the type.
3112 case CK_CPointerToObjCPointerCast:
3113 case CK_BlockPointerToObjCPointerCast:
3114 case CK_AnyPointerToBlockPointerCast:
3115 case CK_BitCast: {
3116 llvm::Type *resultType = CGF.ConvertType(e->getType());
3117 assert(e->getSubExpr()->getType()->hasPointerRepresentation());
3118 Result result = asImpl().visit(e->getSubExpr());
3119 return asImpl().emitBitCast(result, resultType);
John McCall31168b02011-06-15 23:02:42 +00003120 }
3121
John McCalle399e5b2016-01-27 18:32:30 +00003122 // Handle some casts specially.
3123 case CK_LValueToRValue:
3124 return asImpl().visitLValueToRValue(e->getSubExpr());
3125 case CK_ARCConsumeObject:
3126 return asImpl().visitConsumeObject(e->getSubExpr());
3127 case CK_ARCExtendBlockObject:
3128 return asImpl().visitExtendBlockObject(e->getSubExpr());
3129 case CK_ARCReclaimReturnedObject:
3130 return asImpl().visitReclaimReturnedObject(e->getSubExpr());
3131
3132 // Otherwise, use the default logic.
3133 default:
3134 return asImpl().visitExpr(e);
3135 }
3136}
3137
3138template <typename Impl, typename Result>
3139Result
3140ARCExprEmitter<Impl,Result>::visitBinaryOperator(const BinaryOperator *e) {
3141 switch (e->getOpcode()) {
3142 case BO_Comma:
3143 CGF.EmitIgnoredExpr(e->getLHS());
3144 CGF.EnsureInsertPoint();
3145 return asImpl().visit(e->getRHS());
3146
3147 case BO_Assign:
3148 return asImpl().visitBinAssign(e);
3149
3150 default:
3151 return asImpl().visitExpr(e);
3152 }
3153}
3154
3155template <typename Impl, typename Result>
3156Result ARCExprEmitter<Impl,Result>::visitBinAssign(const BinaryOperator *e) {
3157 switch (e->getLHS()->getType().getObjCLifetime()) {
3158 case Qualifiers::OCL_ExplicitNone:
3159 return asImpl().visitBinAssignUnsafeUnretained(e);
3160
3161 case Qualifiers::OCL_Weak:
3162 return asImpl().visitBinAssignWeak(e);
3163
3164 case Qualifiers::OCL_Autoreleasing:
3165 return asImpl().visitBinAssignAutoreleasing(e);
3166
3167 case Qualifiers::OCL_Strong:
3168 return asImpl().visitBinAssignStrong(e);
3169
3170 case Qualifiers::OCL_None:
3171 return asImpl().visitExpr(e);
3172 }
3173 llvm_unreachable("bad ObjC ownership qualifier");
3174}
3175
3176/// The default rule for __unsafe_unretained emits the RHS recursively,
3177/// stores into the unsafe variable, and propagates the result outward.
3178template <typename Impl, typename Result>
3179Result ARCExprEmitter<Impl,Result>::
3180 visitBinAssignUnsafeUnretained(const BinaryOperator *e) {
3181 // Recursively emit the RHS.
3182 // For __block safety, do this before emitting the LHS.
3183 Result result = asImpl().visit(e->getRHS());
3184
3185 // Perform the store.
3186 LValue lvalue =
3187 CGF.EmitCheckedLValue(e->getLHS(), CodeGenFunction::TCK_Store);
3188 CGF.EmitStoreThroughLValue(RValue::get(asImpl().getValueOfResult(result)),
3189 lvalue);
3190
3191 return result;
3192}
3193
3194template <typename Impl, typename Result>
3195Result
3196ARCExprEmitter<Impl,Result>::visitBinAssignAutoreleasing(const BinaryOperator *e) {
3197 return asImpl().visitExpr(e);
3198}
3199
3200template <typename Impl, typename Result>
3201Result
3202ARCExprEmitter<Impl,Result>::visitBinAssignWeak(const BinaryOperator *e) {
3203 return asImpl().visitExpr(e);
3204}
3205
3206template <typename Impl, typename Result>
3207Result
3208ARCExprEmitter<Impl,Result>::visitBinAssignStrong(const BinaryOperator *e) {
3209 return asImpl().visitExpr(e);
3210}
3211
3212/// The general expression-emission logic.
3213template <typename Impl, typename Result>
3214Result ARCExprEmitter<Impl,Result>::visit(const Expr *e) {
3215 // We should *never* see a nested full-expression here, because if
3216 // we fail to emit at +1, our caller must not retain after we close
3217 // out the full-expression. This isn't as important in the unsafe
3218 // emitter.
3219 assert(!isa<ExprWithCleanups>(e));
3220
3221 // Look through parens, __extension__, generic selection, etc.
3222 e = e->IgnoreParens();
3223
3224 // Handle certain kinds of casts.
3225 if (const CastExpr *ce = dyn_cast<CastExpr>(e)) {
3226 return asImpl().visitCastExpr(ce);
3227
3228 // Handle the comma operator.
3229 } else if (auto op = dyn_cast<BinaryOperator>(e)) {
3230 return asImpl().visitBinaryOperator(op);
3231
3232 // TODO: handle conditional operators here
3233
3234 // For calls and message sends, use the retained-call logic.
3235 // Delegate inits are a special case in that they're the only
3236 // returns-retained expression that *isn't* surrounded by
3237 // a consume.
3238 } else if (isa<CallExpr>(e) ||
3239 (isa<ObjCMessageExpr>(e) &&
3240 !cast<ObjCMessageExpr>(e)->isDelegateInitCall())) {
3241 return asImpl().visitCall(e);
3242
3243 // Look through pseudo-object expressions.
3244 } else if (const PseudoObjectExpr *pseudo = dyn_cast<PseudoObjectExpr>(e)) {
3245 return asImpl().visitPseudoObjectExpr(pseudo);
Akira Hatanakac5792aa2019-02-27 18:17:16 +00003246 } else if (auto *be = dyn_cast<BlockExpr>(e))
3247 return asImpl().visitBlockExpr(be);
John McCalle399e5b2016-01-27 18:32:30 +00003248
3249 return asImpl().visitExpr(e);
3250}
3251
3252namespace {
3253
3254/// An emitter for +1 results.
3255struct ARCRetainExprEmitter :
3256 public ARCExprEmitter<ARCRetainExprEmitter, TryEmitResult> {
3257
3258 ARCRetainExprEmitter(CodeGenFunction &CGF) : ARCExprEmitter(CGF) {}
3259
3260 llvm::Value *getValueOfResult(TryEmitResult result) {
3261 return result.getPointer();
3262 }
3263
3264 TryEmitResult emitBitCast(TryEmitResult result, llvm::Type *resultType) {
3265 llvm::Value *value = result.getPointer();
3266 value = CGF.Builder.CreateBitCast(value, resultType);
3267 result.setPointer(value);
3268 return result;
3269 }
3270
3271 TryEmitResult visitLValueToRValue(const Expr *e) {
3272 return tryEmitARCRetainLoadOfScalar(CGF, e);
3273 }
3274
3275 /// For consumptions, just emit the subexpression and thus elide
3276 /// the retain/release pair.
3277 TryEmitResult visitConsumeObject(const Expr *e) {
3278 llvm::Value *result = CGF.EmitScalarExpr(e);
3279 return TryEmitResult(result, true);
3280 }
3281
Akira Hatanakac5792aa2019-02-27 18:17:16 +00003282 TryEmitResult visitBlockExpr(const BlockExpr *e) {
3283 TryEmitResult result = visitExpr(e);
3284 // Avoid the block-retain if this is a block literal that doesn't need to be
3285 // copied to the heap.
3286 if (e->getBlockDecl()->canAvoidCopyToHeap())
3287 result.setInt(true);
3288 return result;
3289 }
3290
John McCalle399e5b2016-01-27 18:32:30 +00003291 /// Block extends are net +0. Naively, we could just recurse on
3292 /// the subexpression, but actually we need to ensure that the
3293 /// value is copied as a block, so there's a little filter here.
3294 TryEmitResult visitExtendBlockObject(const Expr *e) {
3295 llvm::Value *result; // will be a +0 value
3296
3297 // If we can't safely assume the sub-expression will produce a
3298 // block-copied value, emit the sub-expression at +0.
3299 if (shouldEmitSeparateBlockRetain(e)) {
3300 result = CGF.EmitScalarExpr(e);
3301
3302 // Otherwise, try to emit the sub-expression at +1 recursively.
3303 } else {
3304 TryEmitResult subresult = asImpl().visit(e);
3305
3306 // If that produced a retained value, just use that.
3307 if (subresult.getInt()) {
3308 return subresult;
3309 }
3310
3311 // Otherwise it's +0.
3312 result = subresult.getPointer();
3313 }
3314
3315 // Retain the object as a block.
3316 result = CGF.EmitARCRetainBlock(result, /*mandatory*/ true);
3317 return TryEmitResult(result, true);
3318 }
3319
3320 /// For reclaims, emit the subexpression as a retained call and
3321 /// skip the consumption.
3322 TryEmitResult visitReclaimReturnedObject(const Expr *e) {
3323 llvm::Value *result = emitARCRetainCallResult(CGF, e);
3324 return TryEmitResult(result, true);
3325 }
3326
3327 /// When we have an undecorated call, retroactively do a claim.
3328 TryEmitResult visitCall(const Expr *e) {
3329 llvm::Value *result = emitARCRetainCallResult(CGF, e);
3330 return TryEmitResult(result, true);
3331 }
3332
3333 // TODO: maybe special-case visitBinAssignWeak?
3334
3335 TryEmitResult visitExpr(const Expr *e) {
3336 // We didn't find an obvious production, so emit what we've got and
3337 // tell the caller that we didn't manage to retain.
3338 llvm::Value *result = CGF.EmitScalarExpr(e);
3339 return TryEmitResult(result, false);
3340 }
3341};
3342}
3343
3344static TryEmitResult
3345tryEmitARCRetainScalarExpr(CodeGenFunction &CGF, const Expr *e) {
3346 return ARCRetainExprEmitter(CGF).visit(e);
John McCall31168b02011-06-15 23:02:42 +00003347}
3348
3349static llvm::Value *emitARCRetainLoadOfScalar(CodeGenFunction &CGF,
3350 LValue lvalue,
3351 QualType type) {
3352 TryEmitResult result = tryEmitARCRetainLoadOfScalar(CGF, lvalue, type);
3353 llvm::Value *value = result.getPointer();
3354 if (!result.getInt())
3355 value = CGF.EmitARCRetain(type, value);
3356 return value;
3357}
3358
3359/// EmitARCRetainScalarExpr - Semantically equivalent to
3360/// EmitARCRetainObject(e->getType(), EmitScalarExpr(e)), but making a
3361/// best-effort attempt to peephole expressions that naturally produce
3362/// retained objects.
3363llvm::Value *CodeGenFunction::EmitARCRetainScalarExpr(const Expr *e) {
John McCalld21cdd42013-02-12 00:25:08 +00003364 // The retain needs to happen within the full-expression.
3365 if (const ExprWithCleanups *cleanups = dyn_cast<ExprWithCleanups>(e)) {
John McCalld21cdd42013-02-12 00:25:08 +00003366 RunCleanupsScope scope(*this);
3367 return EmitARCRetainScalarExpr(cleanups->getSubExpr());
3368 }
3369
John McCall31168b02011-06-15 23:02:42 +00003370 TryEmitResult result = tryEmitARCRetainScalarExpr(*this, e);
3371 llvm::Value *value = result.getPointer();
3372 if (!result.getInt())
3373 value = EmitARCRetain(e->getType(), value);
3374 return value;
3375}
3376
3377llvm::Value *
3378CodeGenFunction::EmitARCRetainAutoreleaseScalarExpr(const Expr *e) {
John McCalld21cdd42013-02-12 00:25:08 +00003379 // The retain needs to happen within the full-expression.
3380 if (const ExprWithCleanups *cleanups = dyn_cast<ExprWithCleanups>(e)) {
John McCalld21cdd42013-02-12 00:25:08 +00003381 RunCleanupsScope scope(*this);
3382 return EmitARCRetainAutoreleaseScalarExpr(cleanups->getSubExpr());
3383 }
3384
John McCall31168b02011-06-15 23:02:42 +00003385 TryEmitResult result = tryEmitARCRetainScalarExpr(*this, e);
3386 llvm::Value *value = result.getPointer();
3387 if (result.getInt())
3388 value = EmitARCAutorelease(value);
3389 else
3390 value = EmitARCRetainAutorelease(e->getType(), value);
3391 return value;
3392}
3393
John McCallff613032011-10-04 06:23:45 +00003394llvm::Value *CodeGenFunction::EmitARCExtendBlockObject(const Expr *e) {
3395 llvm::Value *result;
3396 bool doRetain;
3397
3398 if (shouldEmitSeparateBlockRetain(e)) {
3399 result = EmitScalarExpr(e);
3400 doRetain = true;
3401 } else {
3402 TryEmitResult subresult = tryEmitARCRetainScalarExpr(*this, e);
3403 result = subresult.getPointer();
3404 doRetain = !subresult.getInt();
3405 }
3406
3407 if (doRetain)
3408 result = EmitARCRetainBlock(result, /*mandatory*/ true);
3409 return EmitObjCConsumeObject(e->getType(), result);
3410}
3411
John McCall248512a2011-10-01 10:32:24 +00003412llvm::Value *CodeGenFunction::EmitObjCThrowOperand(const Expr *expr) {
3413 // In ARC, retain and autorelease the expression.
David Blaikiebbafb8a2012-03-11 07:00:24 +00003414 if (getLangOpts().ObjCAutoRefCount) {
John McCall248512a2011-10-01 10:32:24 +00003415 // Do so before running any cleanups for the full-expression.
John McCalld21cdd42013-02-12 00:25:08 +00003416 // EmitARCRetainAutoreleaseScalarExpr does this for us.
John McCall248512a2011-10-01 10:32:24 +00003417 return EmitARCRetainAutoreleaseScalarExpr(expr);
3418 }
3419
3420 // Otherwise, use the normal scalar-expression emission. The
3421 // exception machinery doesn't do anything special with the
3422 // exception like retaining it, so there's no safety associated with
3423 // only running cleanups after the throw has started, and when it
3424 // matters it tends to be substantially inferior code.
3425 return EmitScalarExpr(expr);
3426}
3427
John McCalle399e5b2016-01-27 18:32:30 +00003428namespace {
3429
3430/// An emitter for assigning into an __unsafe_unretained context.
3431struct ARCUnsafeUnretainedExprEmitter :
3432 public ARCExprEmitter<ARCUnsafeUnretainedExprEmitter, llvm::Value*> {
3433
3434 ARCUnsafeUnretainedExprEmitter(CodeGenFunction &CGF) : ARCExprEmitter(CGF) {}
3435
3436 llvm::Value *getValueOfResult(llvm::Value *value) {
3437 return value;
3438 }
3439
3440 llvm::Value *emitBitCast(llvm::Value *value, llvm::Type *resultType) {
3441 return CGF.Builder.CreateBitCast(value, resultType);
3442 }
3443
3444 llvm::Value *visitLValueToRValue(const Expr *e) {
3445 return CGF.EmitScalarExpr(e);
3446 }
3447
3448 /// For consumptions, just emit the subexpression and perform the
3449 /// consumption like normal.
3450 llvm::Value *visitConsumeObject(const Expr *e) {
3451 llvm::Value *value = CGF.EmitScalarExpr(e);
3452 return CGF.EmitObjCConsumeObject(e->getType(), value);
3453 }
3454
3455 /// No special logic for block extensions. (This probably can't
3456 /// actually happen in this emitter, though.)
3457 llvm::Value *visitExtendBlockObject(const Expr *e) {
3458 return CGF.EmitARCExtendBlockObject(e);
3459 }
3460
3461 /// For reclaims, perform an unsafeClaim if that's enabled.
3462 llvm::Value *visitReclaimReturnedObject(const Expr *e) {
3463 return CGF.EmitARCReclaimReturnedObject(e, /*unsafe*/ true);
3464 }
3465
3466 /// When we have an undecorated call, just emit it without adding
3467 /// the unsafeClaim.
3468 llvm::Value *visitCall(const Expr *e) {
3469 return CGF.EmitScalarExpr(e);
3470 }
3471
3472 /// Just do normal scalar emission in the default case.
3473 llvm::Value *visitExpr(const Expr *e) {
3474 return CGF.EmitScalarExpr(e);
3475 }
3476};
3477}
3478
3479static llvm::Value *emitARCUnsafeUnretainedScalarExpr(CodeGenFunction &CGF,
3480 const Expr *e) {
3481 return ARCUnsafeUnretainedExprEmitter(CGF).visit(e);
3482}
3483
3484/// EmitARCUnsafeUnretainedScalarExpr - Semantically equivalent to
3485/// immediately releasing the resut of EmitARCRetainScalarExpr, but
3486/// avoiding any spurious retains, including by performing reclaims
3487/// with objc_unsafeClaimAutoreleasedReturnValue.
3488llvm::Value *CodeGenFunction::EmitARCUnsafeUnretainedScalarExpr(const Expr *e) {
3489 // Look through full-expressions.
3490 if (const ExprWithCleanups *cleanups = dyn_cast<ExprWithCleanups>(e)) {
John McCalle399e5b2016-01-27 18:32:30 +00003491 RunCleanupsScope scope(*this);
3492 return emitARCUnsafeUnretainedScalarExpr(*this, cleanups->getSubExpr());
3493 }
3494
3495 return emitARCUnsafeUnretainedScalarExpr(*this, e);
3496}
3497
3498std::pair<LValue,llvm::Value*>
3499CodeGenFunction::EmitARCStoreUnsafeUnretained(const BinaryOperator *e,
3500 bool ignored) {
3501 // Evaluate the RHS first. If we're ignoring the result, assume
3502 // that we can emit at an unsafe +0.
3503 llvm::Value *value;
3504 if (ignored) {
3505 value = EmitARCUnsafeUnretainedScalarExpr(e->getRHS());
3506 } else {
3507 value = EmitScalarExpr(e->getRHS());
3508 }
3509
3510 // Emit the LHS and perform the store.
3511 LValue lvalue = EmitLValue(e->getLHS());
3512 EmitStoreOfScalar(value, lvalue);
3513
3514 return std::pair<LValue,llvm::Value*>(std::move(lvalue), value);
3515}
3516
John McCall31168b02011-06-15 23:02:42 +00003517std::pair<LValue,llvm::Value*>
3518CodeGenFunction::EmitARCStoreStrong(const BinaryOperator *e,
3519 bool ignored) {
3520 // Evaluate the RHS first.
3521 TryEmitResult result = tryEmitARCRetainScalarExpr(*this, e->getRHS());
3522 llvm::Value *value = result.getPointer();
3523
John McCallb726a552011-07-28 07:23:35 +00003524 bool hasImmediateRetain = result.getInt();
3525
3526 // If we didn't emit a retained object, and the l-value is of block
3527 // type, then we need to emit the block-retain immediately in case
3528 // it invalidates the l-value.
3529 if (!hasImmediateRetain && e->getType()->isBlockPointerType()) {
John McCallff613032011-10-04 06:23:45 +00003530 value = EmitARCRetainBlock(value, /*mandatory*/ false);
John McCallb726a552011-07-28 07:23:35 +00003531 hasImmediateRetain = true;
3532 }
3533
John McCall31168b02011-06-15 23:02:42 +00003534 LValue lvalue = EmitLValue(e->getLHS());
3535
3536 // If the RHS was emitted retained, expand this.
John McCallb726a552011-07-28 07:23:35 +00003537 if (hasImmediateRetain) {
Nick Lewyckyce550072013-10-02 02:33:11 +00003538 llvm::Value *oldValue = EmitLoadOfScalar(lvalue, SourceLocation());
Eli Friedmana0544d62011-12-03 04:14:32 +00003539 EmitStoreOfScalar(value, lvalue);
John McCallcdda29c2013-03-13 03:10:54 +00003540 EmitARCRelease(oldValue, lvalue.isARCPreciseLifetime());
John McCall31168b02011-06-15 23:02:42 +00003541 } else {
John McCall55e1fbc2011-06-25 02:11:03 +00003542 value = EmitARCStoreStrong(lvalue, value, ignored);
John McCall31168b02011-06-15 23:02:42 +00003543 }
3544
3545 return std::pair<LValue,llvm::Value*>(lvalue, value);
3546}
3547
3548std::pair<LValue,llvm::Value*>
3549CodeGenFunction::EmitARCStoreAutoreleasing(const BinaryOperator *e) {
3550 llvm::Value *value = EmitARCRetainAutoreleaseScalarExpr(e->getRHS());
3551 LValue lvalue = EmitLValue(e->getLHS());
3552
Eli Friedmana0544d62011-12-03 04:14:32 +00003553 EmitStoreOfScalar(value, lvalue);
John McCall31168b02011-06-15 23:02:42 +00003554
3555 return std::pair<LValue,llvm::Value*>(lvalue, value);
3556}
3557
3558void CodeGenFunction::EmitObjCAutoreleasePoolStmt(
Eric Christopher5d2b8d92012-03-29 17:31:31 +00003559 const ObjCAutoreleasePoolStmt &ARPS) {
John McCall31168b02011-06-15 23:02:42 +00003560 const Stmt *subStmt = ARPS.getSubStmt();
3561 const CompoundStmt &S = cast<CompoundStmt>(*subStmt);
3562
3563 CGDebugInfo *DI = getDebugInfo();
Eric Christopher7cdf9482011-10-13 21:45:18 +00003564 if (DI)
3565 DI->EmitLexicalBlockStart(Builder, S.getLBracLoc());
John McCall31168b02011-06-15 23:02:42 +00003566
3567 // Keep track of the current cleanup stack depth.
3568 RunCleanupsScope Scope(*this);
John McCall3deb1ad2012-08-21 02:47:43 +00003569 if (CGM.getLangOpts().ObjCRuntime.hasNativeARC()) {
John McCall31168b02011-06-15 23:02:42 +00003570 llvm::Value *token = EmitObjCAutoreleasePoolPush();
3571 EHStack.pushCleanup<CallObjCAutoreleasePoolObject>(NormalCleanup, token);
3572 } else {
3573 llvm::Value *token = EmitObjCMRRAutoreleasePoolPush();
3574 EHStack.pushCleanup<CallObjCMRRAutoreleasePoolObject>(NormalCleanup, token);
3575 }
3576
Aaron Ballmanc7e4e212014-03-17 14:19:37 +00003577 for (const auto *I : S.body())
3578 EmitStmt(I);
John McCall31168b02011-06-15 23:02:42 +00003579
Eric Christopher7cdf9482011-10-13 21:45:18 +00003580 if (DI)
3581 DI->EmitLexicalBlockEnd(Builder, S.getRBracLoc());
John McCall31168b02011-06-15 23:02:42 +00003582}
John McCall1bd25562011-06-24 23:21:27 +00003583
3584/// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
3585/// make sure it survives garbage collection until this point.
3586void CodeGenFunction::EmitExtendGCLifetime(llvm::Value *object) {
3587 // We just use an inline assembly.
John McCall1bd25562011-06-24 23:21:27 +00003588 llvm::FunctionType *extenderType
John McCalla729c622012-02-17 03:33:10 +00003589 = llvm::FunctionType::get(VoidTy, VoidPtrTy, RequiredArgs::All);
James Y Knight9871db02019-02-05 16:42:33 +00003590 llvm::InlineAsm *extender = llvm::InlineAsm::get(extenderType,
3591 /* assembly */ "",
3592 /* constraints */ "r",
3593 /* side effects */ true);
John McCall1bd25562011-06-24 23:21:27 +00003594
3595 object = Builder.CreateBitCast(object, VoidPtrTy);
John McCall882987f2013-02-28 19:01:20 +00003596 EmitNounwindRuntimeCall(extender, object);
John McCall1bd25562011-06-24 23:21:27 +00003597}
3598
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003599/// GenerateObjCAtomicSetterCopyHelperFunction - Given a c++ object type with
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003600/// non-trivial copy assignment function, produce following helper function.
3601/// static void copyHelper(Ty *dest, const Ty *source) { *dest = *source; }
3602///
3603llvm::Constant *
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003604CodeGenFunction::GenerateObjCAtomicSetterCopyHelperFunction(
3605 const ObjCPropertyImplDecl *PID) {
John McCall5fb5df92012-06-20 06:18:46 +00003606 if (!getLangOpts().CPlusPlus ||
Rafael Espindolad727d3d2012-12-18 04:29:34 +00003607 !getLangOpts().ObjCRuntime.hasAtomicCopyHelper())
Craig Topper8a13c412014-05-21 05:09:00 +00003608 return nullptr;
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003609 QualType Ty = PID->getPropertyIvarDecl()->getType();
3610 if (!Ty->isRecordType())
Craig Topper8a13c412014-05-21 05:09:00 +00003611 return nullptr;
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003612 const ObjCPropertyDecl *PD = PID->getPropertyDecl();
Puyan Lotfi9721fbf2020-04-23 02:20:56 -04003613 if ((!(PD->getPropertyAttributes() & ObjCPropertyAttribute::kind_atomic)))
Craig Topper8a13c412014-05-21 05:09:00 +00003614 return nullptr;
3615 llvm::Constant *HelperFn = nullptr;
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003616 if (hasTrivialSetExpr(PID))
Craig Topper8a13c412014-05-21 05:09:00 +00003617 return nullptr;
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003618 assert(PID->getSetterCXXAssignment() && "SetterCXXAssignment - null");
3619 if ((HelperFn = CGM.getAtomicSetterHelperFnMap(Ty)))
3620 return HelperFn;
Fangrui Song6907ce22018-07-30 19:24:48 +00003621
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003622 ASTContext &C = getContext();
3623 IdentifierInfo *II
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003624 = &CGM.getContext().Idents.get("__assign_helper_atomic_property_");
Craig Topper8a13c412014-05-21 05:09:00 +00003625
Jonas Devlieghere64a26302018-11-11 00:56:15 +00003626 QualType ReturnTy = C.VoidTy;
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003627 QualType DestTy = C.getPointerType(Ty);
3628 QualType SrcTy = Ty;
3629 SrcTy.addConst();
3630 SrcTy = C.getPointerType(SrcTy);
Fangrui Song6907ce22018-07-30 19:24:48 +00003631
Jonas Devlieghere64a26302018-11-11 00:56:15 +00003632 SmallVector<QualType, 2> ArgTys;
3633 ArgTys.push_back(DestTy);
3634 ArgTys.push_back(SrcTy);
3635 QualType FunctionTy = C.getFunctionType(ReturnTy, ArgTys, {});
3636
3637 FunctionDecl *FD = FunctionDecl::Create(
3638 C, C.getTranslationUnitDecl(), SourceLocation(), SourceLocation(), II,
3639 FunctionTy, nullptr, SC_Static, false, false);
3640
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003641 FunctionArgList args;
Jonas Devlieghere64a26302018-11-11 00:56:15 +00003642 ImplicitParamDecl DstDecl(C, FD, SourceLocation(), /*Id=*/nullptr, DestTy,
3643 ImplicitParamDecl::Other);
Alexey Bataev56223232017-06-09 13:40:18 +00003644 args.push_back(&DstDecl);
Jonas Devlieghere64a26302018-11-11 00:56:15 +00003645 ImplicitParamDecl SrcDecl(C, FD, SourceLocation(), /*Id=*/nullptr, SrcTy,
3646 ImplicitParamDecl::Other);
Alexey Bataev56223232017-06-09 13:40:18 +00003647 args.push_back(&SrcDecl);
Reid Kleckner4982b822014-01-31 22:54:50 +00003648
John McCallc56a8b32016-03-11 04:30:31 +00003649 const CGFunctionInfo &FI =
Jonas Devlieghere64a26302018-11-11 00:56:15 +00003650 CGM.getTypes().arrangeBuiltinFunctionDeclaration(ReturnTy, args);
Reid Kleckner4982b822014-01-31 22:54:50 +00003651
John McCalla729c622012-02-17 03:33:10 +00003652 llvm::FunctionType *LTy = CGM.getTypes().GetFunctionType(FI);
Fangrui Song6907ce22018-07-30 19:24:48 +00003653
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003654 llvm::Function *Fn =
3655 llvm::Function::Create(LTy, llvm::GlobalValue::InternalLinkage,
Eric Christopher5d2b8d92012-03-29 17:31:31 +00003656 "__assign_helper_atomic_property_",
3657 &CGM.getModule());
Akira Hatanaka44a59f82015-10-28 02:30:47 +00003658
Rafael Espindola51ec5a92018-02-28 23:46:35 +00003659 CGM.SetInternalFunctionAttributes(GlobalDecl(), Fn, FI);
Akira Hatanaka44a59f82015-10-28 02:30:47 +00003660
Jonas Devlieghere64a26302018-11-11 00:56:15 +00003661 StartFunction(FD, ReturnTy, Fn, FI, args);
Fangrui Song6907ce22018-07-30 19:24:48 +00003662
Melanie Blowerf5360d42020-05-01 10:32:06 -07003663 DeclRefExpr DstExpr(C, &DstDecl, false, DestTy, VK_RValue, SourceLocation());
3664 UnaryOperator *DST = UnaryOperator::Create(
3665 C, &DstExpr, UO_Deref, DestTy->getPointeeType(), VK_LValue, OK_Ordinary,
Melanie Blowerf4aaed32020-06-26 09:23:45 -07003666 SourceLocation(), false, FPOptionsOverride());
Fangrui Song6907ce22018-07-30 19:24:48 +00003667
Melanie Blowerf5360d42020-05-01 10:32:06 -07003668 DeclRefExpr SrcExpr(C, &SrcDecl, false, SrcTy, VK_RValue, SourceLocation());
3669 UnaryOperator *SRC = UnaryOperator::Create(
3670 C, &SrcExpr, UO_Deref, SrcTy->getPointeeType(), VK_LValue, OK_Ordinary,
Melanie Blowerf4aaed32020-06-26 09:23:45 -07003671 SourceLocation(), false, FPOptionsOverride());
Fangrui Song6907ce22018-07-30 19:24:48 +00003672
Melanie Blowerf5360d42020-05-01 10:32:06 -07003673 Expr *Args[2] = {DST, SRC};
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003674 CallExpr *CalleeExp = cast<CallExpr>(PID->getSetterCXXAssignment());
Bruno Riccic5885cf2018-12-21 15:20:32 +00003675 CXXOperatorCallExpr *TheCall = CXXOperatorCallExpr::Create(
3676 C, OO_Equal, CalleeExp->getCallee(), Args, DestTy->getPointeeType(),
Melanie Blowerf4aaed32020-06-26 09:23:45 -07003677 VK_LValue, SourceLocation(), FPOptionsOverride());
Fangrui Song6907ce22018-07-30 19:24:48 +00003678
Bruno Riccic5885cf2018-12-21 15:20:32 +00003679 EmitStmt(TheCall);
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003680
3681 FinishFunction();
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00003682 HelperFn = llvm::ConstantExpr::getBitCast(Fn, VoidPtrTy);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003683 CGM.setAtomicSetterHelperFnMap(Ty, HelperFn);
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00003684 return HelperFn;
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003685}
3686
3687llvm::Constant *
3688CodeGenFunction::GenerateObjCAtomicGetterCopyHelperFunction(
3689 const ObjCPropertyImplDecl *PID) {
John McCall5fb5df92012-06-20 06:18:46 +00003690 if (!getLangOpts().CPlusPlus ||
Rafael Espindolad727d3d2012-12-18 04:29:34 +00003691 !getLangOpts().ObjCRuntime.hasAtomicCopyHelper())
Craig Topper8a13c412014-05-21 05:09:00 +00003692 return nullptr;
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003693 const ObjCPropertyDecl *PD = PID->getPropertyDecl();
3694 QualType Ty = PD->getType();
3695 if (!Ty->isRecordType())
Craig Topper8a13c412014-05-21 05:09:00 +00003696 return nullptr;
Puyan Lotfi9721fbf2020-04-23 02:20:56 -04003697 if ((!(PD->getPropertyAttributes() & ObjCPropertyAttribute::kind_atomic)))
Craig Topper8a13c412014-05-21 05:09:00 +00003698 return nullptr;
3699 llvm::Constant *HelperFn = nullptr;
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003700 if (hasTrivialGetExpr(PID))
Craig Topper8a13c412014-05-21 05:09:00 +00003701 return nullptr;
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003702 assert(PID->getGetterCXXConstructor() && "getGetterCXXConstructor - null");
3703 if ((HelperFn = CGM.getAtomicGetterHelperFnMap(Ty)))
3704 return HelperFn;
Fangrui Song6907ce22018-07-30 19:24:48 +00003705
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003706 ASTContext &C = getContext();
Jonas Devlieghere64a26302018-11-11 00:56:15 +00003707 IdentifierInfo *II =
3708 &CGM.getContext().Idents.get("__copy_helper_atomic_property_");
Craig Topper8a13c412014-05-21 05:09:00 +00003709
Jonas Devlieghere64a26302018-11-11 00:56:15 +00003710 QualType ReturnTy = C.VoidTy;
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003711 QualType DestTy = C.getPointerType(Ty);
3712 QualType SrcTy = Ty;
3713 SrcTy.addConst();
3714 SrcTy = C.getPointerType(SrcTy);
Fangrui Song6907ce22018-07-30 19:24:48 +00003715
Jonas Devlieghere64a26302018-11-11 00:56:15 +00003716 SmallVector<QualType, 2> ArgTys;
3717 ArgTys.push_back(DestTy);
3718 ArgTys.push_back(SrcTy);
3719 QualType FunctionTy = C.getFunctionType(ReturnTy, ArgTys, {});
3720
3721 FunctionDecl *FD = FunctionDecl::Create(
3722 C, C.getTranslationUnitDecl(), SourceLocation(), SourceLocation(), II,
3723 FunctionTy, nullptr, SC_Static, false, false);
3724
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003725 FunctionArgList args;
Jonas Devlieghere64a26302018-11-11 00:56:15 +00003726 ImplicitParamDecl DstDecl(C, FD, SourceLocation(), /*Id=*/nullptr, DestTy,
3727 ImplicitParamDecl::Other);
Alexey Bataev56223232017-06-09 13:40:18 +00003728 args.push_back(&DstDecl);
Jonas Devlieghere64a26302018-11-11 00:56:15 +00003729 ImplicitParamDecl SrcDecl(C, FD, SourceLocation(), /*Id=*/nullptr, SrcTy,
3730 ImplicitParamDecl::Other);
Alexey Bataev56223232017-06-09 13:40:18 +00003731 args.push_back(&SrcDecl);
Reid Kleckner4982b822014-01-31 22:54:50 +00003732
John McCallc56a8b32016-03-11 04:30:31 +00003733 const CGFunctionInfo &FI =
Jonas Devlieghere64a26302018-11-11 00:56:15 +00003734 CGM.getTypes().arrangeBuiltinFunctionDeclaration(ReturnTy, args);
Reid Kleckner4982b822014-01-31 22:54:50 +00003735
John McCalla729c622012-02-17 03:33:10 +00003736 llvm::FunctionType *LTy = CGM.getTypes().GetFunctionType(FI);
Fangrui Song6907ce22018-07-30 19:24:48 +00003737
Jonas Devlieghere64a26302018-11-11 00:56:15 +00003738 llvm::Function *Fn = llvm::Function::Create(
3739 LTy, llvm::GlobalValue::InternalLinkage, "__copy_helper_atomic_property_",
3740 &CGM.getModule());
Rafael Espindola51ec5a92018-02-28 23:46:35 +00003741
3742 CGM.SetInternalFunctionAttributes(GlobalDecl(), Fn, FI);
Akira Hatanaka44a59f82015-10-28 02:30:47 +00003743
Jonas Devlieghere64a26302018-11-11 00:56:15 +00003744 StartFunction(FD, ReturnTy, Fn, FI, args);
Fangrui Song6907ce22018-07-30 19:24:48 +00003745
Bruno Ricci5fc4db72018-12-21 14:10:18 +00003746 DeclRefExpr SrcExpr(getContext(), &SrcDecl, false, SrcTy, VK_RValue,
3747 SourceLocation());
Fangrui Song6907ce22018-07-30 19:24:48 +00003748
Melanie Blowerf5360d42020-05-01 10:32:06 -07003749 UnaryOperator *SRC = UnaryOperator::Create(
3750 C, &SrcExpr, UO_Deref, SrcTy->getPointeeType(), VK_LValue, OK_Ordinary,
Melanie Blowerf4aaed32020-06-26 09:23:45 -07003751 SourceLocation(), false, FPOptionsOverride());
Fangrui Song6907ce22018-07-30 19:24:48 +00003752
3753 CXXConstructExpr *CXXConstExpr =
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003754 cast<CXXConstructExpr>(PID->getGetterCXXConstructor());
Fangrui Song6907ce22018-07-30 19:24:48 +00003755
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003756 SmallVector<Expr*, 4> ConstructorArgs;
Melanie Blowerf5360d42020-05-01 10:32:06 -07003757 ConstructorArgs.push_back(SRC);
Benjamin Kramerf367dd92015-06-12 15:31:50 +00003758 ConstructorArgs.append(std::next(CXXConstExpr->arg_begin()),
3759 CXXConstExpr->arg_end());
3760
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003761 CXXConstructExpr *TheCXXConstructExpr =
3762 CXXConstructExpr::Create(C, Ty, SourceLocation(),
3763 CXXConstExpr->getConstructor(),
3764 CXXConstExpr->isElidable(),
Benjamin Kramerc215e762012-08-24 11:54:20 +00003765 ConstructorArgs,
Sebastian Redla9351792012-02-11 23:51:47 +00003766 CXXConstExpr->hadMultipleCandidates(),
3767 CXXConstExpr->isListInitialization(),
Richard Smithf8adcdc2014-07-17 05:12:35 +00003768 CXXConstExpr->isStdInitListInitialization(),
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003769 CXXConstExpr->requiresZeroInitialization(),
Eric Christopher5d2b8d92012-03-29 17:31:31 +00003770 CXXConstExpr->getConstructionKind(),
3771 SourceRange());
Fangrui Song6907ce22018-07-30 19:24:48 +00003772
Bruno Ricci5fc4db72018-12-21 14:10:18 +00003773 DeclRefExpr DstExpr(getContext(), &DstDecl, false, DestTy, VK_RValue,
3774 SourceLocation());
Fangrui Song6907ce22018-07-30 19:24:48 +00003775
John McCall113bee02012-03-10 09:33:50 +00003776 RValue DV = EmitAnyExpr(&DstExpr);
Eric Christopher5d2b8d92012-03-29 17:31:31 +00003777 CharUnits Alignment
3778 = getContext().getTypeAlignInChars(TheCXXConstructExpr->getType());
Fangrui Song6907ce22018-07-30 19:24:48 +00003779 EmitAggExpr(TheCXXConstructExpr,
John McCall7f416cc2015-09-08 08:05:57 +00003780 AggValueSlot::forAddr(Address(DV.getScalarVal(), Alignment),
3781 Qualifiers(),
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003782 AggValueSlot::IsDestructed,
3783 AggValueSlot::DoesNotNeedGCBarriers,
Richard Smithe78fac52018-04-05 20:52:58 +00003784 AggValueSlot::IsNotAliased,
3785 AggValueSlot::DoesNotOverlap));
Fangrui Song6907ce22018-07-30 19:24:48 +00003786
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003787 FinishFunction();
3788 HelperFn = llvm::ConstantExpr::getBitCast(Fn, VoidPtrTy);
3789 CGM.setAtomicGetterHelperFnMap(Ty, HelperFn);
3790 return HelperFn;
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003791}
3792
Eli Friedmanec75fec2012-02-28 01:08:45 +00003793llvm::Value *
3794CodeGenFunction::EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty) {
3795 // Get selectors for retain/autorelease.
Eli Friedmanc4e5d0c2012-03-01 22:52:28 +00003796 IdentifierInfo *CopyID = &getContext().Idents.get("copy");
3797 Selector CopySelector =
3798 getContext().Selectors.getNullarySelector(CopyID);
Eli Friedmanec75fec2012-02-28 01:08:45 +00003799 IdentifierInfo *AutoreleaseID = &getContext().Idents.get("autorelease");
3800 Selector AutoreleaseSelector =
3801 getContext().Selectors.getNullarySelector(AutoreleaseID);
3802
3803 // Emit calls to retain/autorelease.
3804 CGObjCRuntime &Runtime = CGM.getObjCRuntime();
3805 llvm::Value *Val = Block;
3806 RValue Result;
3807 Result = Runtime.GenerateMessageSend(*this, ReturnValueSlot(),
Eli Friedmanc4e5d0c2012-03-01 22:52:28 +00003808 Ty, CopySelector,
Craig Topper8a13c412014-05-21 05:09:00 +00003809 Val, CallArgList(), nullptr, nullptr);
Eli Friedmanec75fec2012-02-28 01:08:45 +00003810 Val = Result.getScalarVal();
3811 Result = Runtime.GenerateMessageSend(*this, ReturnValueSlot(),
3812 Ty, AutoreleaseSelector,
Craig Topper8a13c412014-05-21 05:09:00 +00003813 Val, CallArgList(), nullptr, nullptr);
Eli Friedmanec75fec2012-02-28 01:08:45 +00003814 Val = Result.getScalarVal();
3815 return Val;
3816}
3817
Alex Lorenz701456b2020-10-28 22:48:59 -07003818static unsigned getBaseMachOPlatformID(const llvm::Triple &TT) {
3819 switch (TT.getOS()) {
3820 case llvm::Triple::Darwin:
3821 case llvm::Triple::MacOSX:
3822 return llvm::MachO::PLATFORM_MACOS;
3823 case llvm::Triple::IOS:
3824 return llvm::MachO::PLATFORM_IOS;
3825 case llvm::Triple::TvOS:
3826 return llvm::MachO::PLATFORM_TVOS;
3827 case llvm::Triple::WatchOS:
3828 return llvm::MachO::PLATFORM_WATCHOS;
3829 default:
3830 return /*Unknown platform*/ 0;
3831 }
3832}
3833
3834static llvm::Value *emitIsPlatformVersionAtLeast(CodeGenFunction &CGF,
3835 const VersionTuple &Version) {
3836 CodeGenModule &CGM = CGF.CGM;
3837 // Note: we intend to support multi-platform version checks, so reserve
3838 // the room for a dual platform checking invocation that will be
3839 // implemented in the future.
3840 llvm::SmallVector<llvm::Value *, 8> Args;
3841
3842 auto EmitArgs = [&](const VersionTuple &Version, const llvm::Triple &TT) {
3843 Optional<unsigned> Min = Version.getMinor(), SMin = Version.getSubminor();
3844 Args.push_back(
3845 llvm::ConstantInt::get(CGM.Int32Ty, getBaseMachOPlatformID(TT)));
3846 Args.push_back(llvm::ConstantInt::get(CGM.Int32Ty, Version.getMajor()));
3847 Args.push_back(llvm::ConstantInt::get(CGM.Int32Ty, Min ? *Min : 0));
3848 Args.push_back(llvm::ConstantInt::get(CGM.Int32Ty, SMin ? *SMin : 0));
3849 };
3850
3851 assert(!Version.empty() && "unexpected empty version");
3852 EmitArgs(Version, CGM.getTarget().getTriple());
3853
3854 if (!CGM.IsPlatformVersionAtLeastFn) {
3855 llvm::FunctionType *FTy = llvm::FunctionType::get(
3856 CGM.Int32Ty, {CGM.Int32Ty, CGM.Int32Ty, CGM.Int32Ty, CGM.Int32Ty},
3857 false);
3858 CGM.IsPlatformVersionAtLeastFn =
3859 CGM.CreateRuntimeFunction(FTy, "__isPlatformVersionAtLeast");
3860 }
3861
3862 llvm::Value *Check =
3863 CGF.EmitNounwindRuntimeCall(CGM.IsPlatformVersionAtLeastFn, Args);
3864 return CGF.Builder.CreateICmpNE(Check,
3865 llvm::Constant::getNullValue(CGM.Int32Ty));
3866}
3867
Erik Pilkington9c42a8d2017-02-23 21:08:08 +00003868llvm::Value *
Alex Lorenz701456b2020-10-28 22:48:59 -07003869CodeGenFunction::EmitBuiltinAvailable(const VersionTuple &Version) {
3870 // Darwin uses the new __isPlatformVersionAtLeast family of routines.
3871 if (CGM.getTarget().getTriple().isOSDarwin())
3872 return emitIsPlatformVersionAtLeast(*this, Version);
Erik Pilkington9c42a8d2017-02-23 21:08:08 +00003873
3874 if (!CGM.IsOSVersionAtLeastFn) {
3875 llvm::FunctionType *FTy =
3876 llvm::FunctionType::get(Int32Ty, {Int32Ty, Int32Ty, Int32Ty}, false);
3877 CGM.IsOSVersionAtLeastFn =
3878 CGM.CreateRuntimeFunction(FTy, "__isOSVersionAtLeast");
3879 }
3880
Alex Lorenz701456b2020-10-28 22:48:59 -07003881 Optional<unsigned> Min = Version.getMinor(), SMin = Version.getSubminor();
3882 llvm::Value *Args[] = {
3883 llvm::ConstantInt::get(CGM.Int32Ty, Version.getMajor()),
3884 llvm::ConstantInt::get(CGM.Int32Ty, Min ? *Min : 0),
3885 llvm::ConstantInt::get(CGM.Int32Ty, SMin ? *SMin : 0),
3886 };
3887
Erik Pilkington9c42a8d2017-02-23 21:08:08 +00003888 llvm::Value *CallRes =
3889 EmitNounwindRuntimeCall(CGM.IsOSVersionAtLeastFn, Args);
3890
3891 return Builder.CreateICmpNE(CallRes, llvm::Constant::getNullValue(Int32Ty));
3892}
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003893
Alex Lorenz701456b2020-10-28 22:48:59 -07003894static bool isFoundationNeededForDarwinAvailabilityCheck(
3895 const llvm::Triple &TT, const VersionTuple &TargetVersion) {
3896 VersionTuple FoundationDroppedInVersion;
3897 switch (TT.getOS()) {
3898 case llvm::Triple::IOS:
3899 case llvm::Triple::TvOS:
3900 FoundationDroppedInVersion = VersionTuple(/*Major=*/13);
3901 break;
3902 case llvm::Triple::WatchOS:
3903 FoundationDroppedInVersion = VersionTuple(/*Major=*/6);
3904 break;
3905 case llvm::Triple::Darwin:
3906 case llvm::Triple::MacOSX:
3907 FoundationDroppedInVersion = VersionTuple(/*Major=*/10, /*Minor=*/15);
3908 break;
3909 default:
3910 llvm_unreachable("Unexpected OS");
3911 }
3912 return TargetVersion < FoundationDroppedInVersion;
3913}
3914
Alex Lorenza8fbef42017-03-23 11:14:27 +00003915void CodeGenModule::emitAtAvailableLinkGuard() {
Alex Lorenz701456b2020-10-28 22:48:59 -07003916 if (!IsPlatformVersionAtLeastFn)
Alex Lorenza8fbef42017-03-23 11:14:27 +00003917 return;
3918 // @available requires CoreFoundation only on Darwin.
3919 if (!Target.getTriple().isOSDarwin())
3920 return;
Alex Lorenz701456b2020-10-28 22:48:59 -07003921 // @available doesn't need Foundation on macOS 10.15+, iOS/tvOS 13+, or
3922 // watchOS 6+.
3923 if (!isFoundationNeededForDarwinAvailabilityCheck(
3924 Target.getTriple(), Target.getPlatformMinVersion()))
3925 return;
Alex Lorenza8fbef42017-03-23 11:14:27 +00003926 // Add -framework CoreFoundation to the linker commands. We still want to
3927 // emit the core foundation reference down below because otherwise if
3928 // CoreFoundation is not used in the code, the linker won't link the
3929 // framework.
3930 auto &Context = getLLVMContext();
3931 llvm::Metadata *Args[2] = {llvm::MDString::get(Context, "-framework"),
3932 llvm::MDString::get(Context, "CoreFoundation")};
3933 LinkerOptionsMetadata.push_back(llvm::MDNode::get(Context, Args));
3934 // Emit a reference to a symbol from CoreFoundation to ensure that
3935 // CoreFoundation is linked into the final binary.
3936 llvm::FunctionType *FTy =
3937 llvm::FunctionType::get(Int32Ty, {VoidPtrTy}, false);
James Y Knight9871db02019-02-05 16:42:33 +00003938 llvm::FunctionCallee CFFunc =
Alex Lorenza8fbef42017-03-23 11:14:27 +00003939 CreateRuntimeFunction(FTy, "CFBundleGetVersionNumber");
3940
3941 llvm::FunctionType *CheckFTy = llvm::FunctionType::get(VoidTy, {}, false);
James Y Knight9871db02019-02-05 16:42:33 +00003942 llvm::FunctionCallee CFLinkCheckFuncRef = CreateRuntimeFunction(
3943 CheckFTy, "__clang_at_available_requires_core_foundation_framework",
Rui Ueyama49a3ad22019-07-16 04:46:31 +00003944 llvm::AttributeList(), /*Local=*/true);
James Y Knight9871db02019-02-05 16:42:33 +00003945 llvm::Function *CFLinkCheckFunc =
3946 cast<llvm::Function>(CFLinkCheckFuncRef.getCallee()->stripPointerCasts());
3947 if (CFLinkCheckFunc->empty()) {
3948 CFLinkCheckFunc->setLinkage(llvm::GlobalValue::LinkOnceAnyLinkage);
3949 CFLinkCheckFunc->setVisibility(llvm::GlobalValue::HiddenVisibility);
3950 CodeGenFunction CGF(*this);
3951 CGF.Builder.SetInsertPoint(CGF.createBasicBlock("", CFLinkCheckFunc));
3952 CGF.EmitNounwindRuntimeCall(CFFunc,
3953 llvm::Constant::getNullValue(VoidPtrTy));
3954 CGF.Builder.CreateUnreachable();
3955 addCompilerUsedGlobal(CFLinkCheckFunc);
3956 }
Alex Lorenza8fbef42017-03-23 11:14:27 +00003957}
3958
Angel Garcia Gomez637d1e62015-10-20 13:23:58 +00003959CGObjCRuntime::~CGObjCRuntime() {}