blob: 8302c10d66dd9922b0a69ce8c01a06722408adfa [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"
Daniel Dunbar6e8aa532008-08-11 05:35:13 +000020#include "clang/AST/DeclObjC.h"
Chris Lattnerf0b64d72009-04-26 01:32:48 +000021#include "clang/AST/StmtObjC.h"
Daniel Dunbarc5d33042008-09-03 00:27:26 +000022#include "clang/Basic/Diagnostic.h"
Mark Laceya8e7df32013-10-30 21:53:58 +000023#include "clang/CodeGen/CGFunctionInfo.h"
Anders Carlsson2e744e82008-08-30 19:51:14 +000024#include "llvm/ADT/STLExtras.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000025#include "llvm/IR/DataLayout.h"
26#include "llvm/IR/InlineAsm.h"
Anders Carlsson76f4a902007-08-21 17:43:55 +000027using namespace clang;
28using namespace CodeGen;
29
John McCall31168b02011-06-15 23:02:42 +000030typedef llvm::PointerIntPair<llvm::Value*,1,bool> TryEmitResult;
31static TryEmitResult
32tryEmitARCRetainScalarExpr(CodeGenFunction &CGF, const Expr *e);
Douglas Gregore83b9562015-07-07 03:57:53 +000033static RValue AdjustObjCObjectType(CodeGenFunction &CGF,
34 QualType ET,
35 RValue Result);
John McCall31168b02011-06-15 23:02:42 +000036
37/// Given the address of a variable of pointer type, find the correct
38/// null to store into it.
John McCall7f416cc2015-09-08 08:05:57 +000039static llvm::Constant *getNullForVariable(Address addr) {
40 llvm::Type *type = addr.getElementType();
John McCall31168b02011-06-15 23:02:42 +000041 return llvm::ConstantPointerNull::get(cast<llvm::PointerType>(type));
42}
43
Chris Lattnerb1d329d2008-06-24 17:04:18 +000044/// Emits an instance of NSConstantString representing the object.
Mike Stump11289f42009-09-09 15:08:12 +000045llvm::Value *CodeGenFunction::EmitObjCStringLiteral(const ObjCStringLiteral *E)
Daniel Dunbar44b58a22008-11-25 21:53:21 +000046{
Fangrui Song6907ce22018-07-30 19:24:48 +000047 llvm::Constant *C =
John McCall7f416cc2015-09-08 08:05:57 +000048 CGM.getObjCRuntime().GenerateConstantString(E->getString()).getPointer();
Daniel Dunbar66912a12008-08-20 00:28:19 +000049 // FIXME: This bitcast should just be made an invariant on the Runtime.
Owen Andersonade90fd2009-07-29 18:54:39 +000050 return llvm::ConstantExpr::getBitCast(C, ConvertType(E->getType()));
Chris Lattnerb1d329d2008-06-24 17:04:18 +000051}
52
Patrick Beard0caa3942012-04-19 00:25:12 +000053/// EmitObjCBoxedExpr - This routine generates code to call
54/// the appropriate expression boxing method. This will either be
Alex Denisovfde64952015-06-26 05:28:36 +000055/// one of +[NSNumber numberWith<Type>:], or +[NSString stringWithUTF8String:],
56/// or [NSValue valueWithBytes:objCType:].
Ted Kremeneke65b0862012-03-06 20:05:56 +000057///
Eric Christopher5d2b8d92012-03-29 17:31:31 +000058llvm::Value *
Patrick Beard0caa3942012-04-19 00:25:12 +000059CodeGenFunction::EmitObjCBoxedExpr(const ObjCBoxedExpr *E) {
Ted Kremeneke65b0862012-03-06 20:05:56 +000060 // Generate the correct selector for this literal's concrete type.
Ted Kremeneke65b0862012-03-06 20:05:56 +000061 // Get the method.
Patrick Beard0caa3942012-04-19 00:25:12 +000062 const ObjCMethodDecl *BoxingMethod = E->getBoxingMethod();
Alex Denisovfde64952015-06-26 05:28:36 +000063 const Expr *SubExpr = E->getSubExpr();
Akira Hatanaka1488ee42019-03-08 04:45:37 +000064
65 if (E->isExpressibleAsConstantInitializer()) {
66 ConstantEmitter ConstEmitter(CGM);
67 return ConstEmitter.tryEmitAbstract(E, E->getType());
68 }
69
Patrick Beard0caa3942012-04-19 00:25:12 +000070 assert(BoxingMethod->isClassMethod() && "BoxingMethod must be a class method");
71 Selector Sel = BoxingMethod->getSelector();
Fangrui Song6907ce22018-07-30 19:24:48 +000072
Ted Kremeneke65b0862012-03-06 20:05:56 +000073 // Generate a reference to the class pointer, which will be the receiver.
Patrick Beard0caa3942012-04-19 00:25:12 +000074 // Assumes that the method was introduced in the class that should be
75 // messaged (avoids pulling it out of the result type).
Ted Kremeneke65b0862012-03-06 20:05:56 +000076 CGObjCRuntime &Runtime = CGM.getObjCRuntime();
Patrick Beard0caa3942012-04-19 00:25:12 +000077 const ObjCInterfaceDecl *ClassDecl = BoxingMethod->getClassInterface();
John McCall882987f2013-02-28 19:01:20 +000078 llvm::Value *Receiver = Runtime.GetClass(*this, ClassDecl);
Fariborz Jahanian661a97b2014-12-18 17:13:56 +000079
Ted Kremeneke65b0862012-03-06 20:05:56 +000080 CallArgList Args;
Alex Denisovfde64952015-06-26 05:28:36 +000081 const ParmVarDecl *ArgDecl = *BoxingMethod->param_begin();
82 QualType ArgQT = ArgDecl->getType().getUnqualifiedType();
Fangrui Song6907ce22018-07-30 19:24:48 +000083
84 // ObjCBoxedExpr supports boxing of structs and unions
Alex Denisovfde64952015-06-26 05:28:36 +000085 // via [NSValue valueWithBytes:objCType:]
86 const QualType ValueType(SubExpr->getType().getCanonicalType());
87 if (ValueType->isObjCBoxableRecordType()) {
88 // Emit CodeGen for first parameter
89 // and cast value to correct type
John McCall7f416cc2015-09-08 08:05:57 +000090 Address Temporary = CreateMemTemp(SubExpr->getType());
Alex Denisovfde64952015-06-26 05:28:36 +000091 EmitAnyExprToMem(SubExpr, Temporary, Qualifiers(), /*isInit*/ true);
John McCall7f416cc2015-09-08 08:05:57 +000092 Address BitCast = Builder.CreateBitCast(Temporary, ConvertType(ArgQT));
93 Args.add(RValue::get(BitCast.getPointer()), ArgQT);
Alex Denisovfde64952015-06-26 05:28:36 +000094
95 // Create char array to store type encoding
96 std::string Str;
97 getContext().getObjCEncodingForType(ValueType, Str);
John McCall7f416cc2015-09-08 08:05:57 +000098 llvm::Constant *GV = CGM.GetAddrOfConstantCString(Str).getPointer();
Fangrui Song6907ce22018-07-30 19:24:48 +000099
Alex Denisovfde64952015-06-26 05:28:36 +0000100 // Cast type encoding to correct type
101 const ParmVarDecl *EncodingDecl = BoxingMethod->parameters()[1];
102 QualType EncodingQT = EncodingDecl->getType().getUnqualifiedType();
103 llvm::Value *Cast = Builder.CreateBitCast(GV, ConvertType(EncodingQT));
104
105 Args.add(RValue::get(Cast), EncodingQT);
106 } else {
107 Args.add(EmitAnyExpr(SubExpr), ArgQT);
108 }
Alp Toker314cc812014-01-25 16:55:45 +0000109
110 RValue result = Runtime.GenerateMessageSend(
111 *this, ReturnValueSlot(), BoxingMethod->getReturnType(), Sel, Receiver,
112 Args, ClassDecl, BoxingMethod);
Fangrui Song6907ce22018-07-30 19:24:48 +0000113 return Builder.CreateBitCast(result.getScalarVal(),
Ted Kremeneke65b0862012-03-06 20:05:56 +0000114 ConvertType(E->getType()));
115}
116
117llvm::Value *CodeGenFunction::EmitObjCCollectionLiteral(const Expr *E,
Fariborz Jahanian9ad94aa2014-10-28 18:28:16 +0000118 const ObjCMethodDecl *MethodWithObjects) {
Ted Kremeneke65b0862012-03-06 20:05:56 +0000119 ASTContext &Context = CGM.getContext();
Craig Topper8a13c412014-05-21 05:09:00 +0000120 const ObjCDictionaryLiteral *DLE = nullptr;
Ted Kremeneke65b0862012-03-06 20:05:56 +0000121 const ObjCArrayLiteral *ALE = dyn_cast<ObjCArrayLiteral>(E);
122 if (!ALE)
123 DLE = cast<ObjCDictionaryLiteral>(E);
Akira Hatanaka4d53a1c2017-04-15 06:42:00 +0000124
125 // Optimize empty collections by referencing constants, when available.
Fangrui Song6907ce22018-07-30 19:24:48 +0000126 uint64_t NumElements =
Ted Kremeneke65b0862012-03-06 20:05:56 +0000127 ALE ? ALE->getNumElements() : DLE->getNumElements();
Akira Hatanaka4d53a1c2017-04-15 06:42:00 +0000128 if (NumElements == 0 && CGM.getLangOpts().ObjCRuntime.hasEmptyCollections()) {
129 StringRef ConstantName = ALE ? "__NSArray0__" : "__NSDictionary0__";
130 QualType IdTy(CGM.getContext().getObjCIdType());
131 llvm::Constant *Constant =
132 CGM.CreateRuntimeVariable(ConvertType(IdTy), ConstantName);
Akira Hatanakab5d1ea42017-04-17 15:21:55 +0000133 LValue LV = MakeNaturalAlignAddrLValue(Constant, IdTy);
Stephen Kellyf2ceec42018-08-09 21:08:08 +0000134 llvm::Value *Ptr = EmitLoadOfScalar(LV, E->getBeginLoc());
Akira Hatanakab5d1ea42017-04-17 15:21:55 +0000135 cast<llvm::LoadInst>(Ptr)->setMetadata(
136 CGM.getModule().getMDKindID("invariant.load"),
137 llvm::MDNode::get(getLLVMContext(), None));
138 return Builder.CreateBitCast(Ptr, ConvertType(E->getType()));
Akira Hatanaka4d53a1c2017-04-15 06:42:00 +0000139 }
140
141 // Compute the type of the array we're initializing.
Ted Kremeneke65b0862012-03-06 20:05:56 +0000142 llvm::APInt APNumElements(Context.getTypeSize(Context.getSizeType()),
143 NumElements);
144 QualType ElementType = Context.getObjCIdType().withConst();
Fangrui Song6907ce22018-07-30 19:24:48 +0000145 QualType ElementArrayType
146 = Context.getConstantArrayType(ElementType, APNumElements,
Ted Kremeneke65b0862012-03-06 20:05:56 +0000147 ArrayType::Normal, /*IndexTypeQuals=*/0);
148
149 // Allocate the temporary array(s).
John McCall7f416cc2015-09-08 08:05:57 +0000150 Address Objects = CreateMemTemp(ElementArrayType, "objects");
151 Address Keys = Address::invalid();
Ted Kremeneke65b0862012-03-06 20:05:56 +0000152 if (DLE)
153 Keys = CreateMemTemp(ElementArrayType, "keys");
Fangrui Song6907ce22018-07-30 19:24:48 +0000154
John McCall770a4c12013-04-04 00:20:38 +0000155 // In ARC, we may need to do extra work to keep all the keys and
156 // values alive until after the call.
157 SmallVector<llvm::Value *, 16> NeededObjects;
158 bool TrackNeededObjects =
159 (getLangOpts().ObjCAutoRefCount &&
160 CGM.getCodeGenOpts().OptimizationLevel != 0);
161
Ted Kremeneke65b0862012-03-06 20:05:56 +0000162 // Perform the actual initialialization of the array(s).
163 for (uint64_t i = 0; i < NumElements; i++) {
164 if (ALE) {
John McCall770a4c12013-04-04 00:20:38 +0000165 // Emit the element and store it to the appropriate array slot.
Ted Kremeneke65b0862012-03-06 20:05:56 +0000166 const Expr *Rhs = ALE->getElement(i);
James Y Knight751fe282019-02-09 22:22:28 +0000167 LValue LV = MakeAddrLValue(Builder.CreateConstArrayGEP(Objects, i),
168 ElementType, AlignmentSource::Decl);
John McCall770a4c12013-04-04 00:20:38 +0000169
170 llvm::Value *value = EmitScalarExpr(Rhs);
171 EmitStoreThroughLValue(RValue::get(value), LV, true);
172 if (TrackNeededObjects) {
173 NeededObjects.push_back(value);
174 }
Fangrui Song6907ce22018-07-30 19:24:48 +0000175 } else {
John McCall770a4c12013-04-04 00:20:38 +0000176 // Emit the key and store it to the appropriate array slot.
Ted Kremeneke65b0862012-03-06 20:05:56 +0000177 const Expr *Key = DLE->getKeyValueElement(i).Key;
James Y Knight751fe282019-02-09 22:22:28 +0000178 LValue KeyLV = MakeAddrLValue(Builder.CreateConstArrayGEP(Keys, i),
179 ElementType, AlignmentSource::Decl);
John McCall770a4c12013-04-04 00:20:38 +0000180 llvm::Value *keyValue = EmitScalarExpr(Key);
181 EmitStoreThroughLValue(RValue::get(keyValue), KeyLV, /*isInit=*/true);
Ted Kremeneke65b0862012-03-06 20:05:56 +0000182
John McCall770a4c12013-04-04 00:20:38 +0000183 // Emit the value and store it to the appropriate array slot.
David Blaikie1ed728c2015-04-05 22:45:47 +0000184 const Expr *Value = DLE->getKeyValueElement(i).Value;
James Y Knight751fe282019-02-09 22:22:28 +0000185 LValue ValueLV = MakeAddrLValue(Builder.CreateConstArrayGEP(Objects, i),
186 ElementType, AlignmentSource::Decl);
John McCall770a4c12013-04-04 00:20:38 +0000187 llvm::Value *valueValue = EmitScalarExpr(Value);
188 EmitStoreThroughLValue(RValue::get(valueValue), ValueLV, /*isInit=*/true);
189 if (TrackNeededObjects) {
190 NeededObjects.push_back(keyValue);
191 NeededObjects.push_back(valueValue);
192 }
Ted Kremeneke65b0862012-03-06 20:05:56 +0000193 }
194 }
Fangrui Song6907ce22018-07-30 19:24:48 +0000195
Ted Kremeneke65b0862012-03-06 20:05:56 +0000196 // Generate the argument list.
Fangrui Song6907ce22018-07-30 19:24:48 +0000197 CallArgList Args;
Ted Kremeneke65b0862012-03-06 20:05:56 +0000198 ObjCMethodDecl::param_const_iterator PI = MethodWithObjects->param_begin();
199 const ParmVarDecl *argDecl = *PI++;
200 QualType ArgQT = argDecl->getType().getUnqualifiedType();
John McCall7f416cc2015-09-08 08:05:57 +0000201 Args.add(RValue::get(Objects.getPointer()), ArgQT);
Ted Kremeneke65b0862012-03-06 20:05:56 +0000202 if (DLE) {
203 argDecl = *PI++;
204 ArgQT = argDecl->getType().getUnqualifiedType();
John McCall7f416cc2015-09-08 08:05:57 +0000205 Args.add(RValue::get(Keys.getPointer()), ArgQT);
Ted Kremeneke65b0862012-03-06 20:05:56 +0000206 }
207 argDecl = *PI;
208 ArgQT = argDecl->getType().getUnqualifiedType();
Fangrui Song6907ce22018-07-30 19:24:48 +0000209 llvm::Value *Count =
Ted Kremeneke65b0862012-03-06 20:05:56 +0000210 llvm::ConstantInt::get(CGM.getTypes().ConvertType(ArgQT), NumElements);
211 Args.add(RValue::get(Count), ArgQT);
212
213 // Generate a reference to the class pointer, which will be the receiver.
214 Selector Sel = MethodWithObjects->getSelector();
215 QualType ResultType = E->getType();
216 const ObjCObjectPointerType *InterfacePointerType
217 = ResultType->getAsObjCInterfacePointerType();
Fangrui Song6907ce22018-07-30 19:24:48 +0000218 ObjCInterfaceDecl *Class
Ted Kremeneke65b0862012-03-06 20:05:56 +0000219 = InterfacePointerType->getObjectType()->getInterface();
220 CGObjCRuntime &Runtime = CGM.getObjCRuntime();
John McCall882987f2013-02-28 19:01:20 +0000221 llvm::Value *Receiver = Runtime.GetClass(*this, Class);
Ted Kremeneke65b0862012-03-06 20:05:56 +0000222
223 // Generate the message send.
Alp Toker314cc812014-01-25 16:55:45 +0000224 RValue result = Runtime.GenerateMessageSend(
225 *this, ReturnValueSlot(), MethodWithObjects->getReturnType(), Sel,
226 Receiver, Args, Class, MethodWithObjects);
John McCall770a4c12013-04-04 00:20:38 +0000227
228 // The above message send needs these objects, but in ARC they are
229 // passed in a buffer that is essentially __unsafe_unretained.
230 // Therefore we must prevent the optimizer from releasing them until
231 // after the call.
232 if (TrackNeededObjects) {
233 EmitARCIntrinsicUse(NeededObjects);
234 }
235
Fangrui Song6907ce22018-07-30 19:24:48 +0000236 return Builder.CreateBitCast(result.getScalarVal(),
Ted Kremeneke65b0862012-03-06 20:05:56 +0000237 ConvertType(E->getType()));
238}
239
240llvm::Value *CodeGenFunction::EmitObjCArrayLiteral(const ObjCArrayLiteral *E) {
Fariborz Jahanian9ad94aa2014-10-28 18:28:16 +0000241 return EmitObjCCollectionLiteral(E, E->getArrayWithObjectsMethod());
Ted Kremeneke65b0862012-03-06 20:05:56 +0000242}
243
244llvm::Value *CodeGenFunction::EmitObjCDictionaryLiteral(
245 const ObjCDictionaryLiteral *E) {
Fariborz Jahanian9ad94aa2014-10-28 18:28:16 +0000246 return EmitObjCCollectionLiteral(E, E->getDictWithObjectsMethod());
Ted Kremeneke65b0862012-03-06 20:05:56 +0000247}
248
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000249/// Emit a selector.
250llvm::Value *CodeGenFunction::EmitObjCSelectorExpr(const ObjCSelectorExpr *E) {
251 // Untyped selector.
252 // Note that this implementation allows for non-constant strings to be passed
253 // as arguments to @selector(). Currently, the only thing preventing this
254 // behaviour is the type checking in the front end.
John McCall882987f2013-02-28 19:01:20 +0000255 return CGM.getObjCRuntime().GetSelector(*this, E->getSelector());
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000256}
257
Daniel Dunbar66912a12008-08-20 00:28:19 +0000258llvm::Value *CodeGenFunction::EmitObjCProtocolExpr(const ObjCProtocolExpr *E) {
259 // FIXME: This should pass the Decl not the name.
John McCall882987f2013-02-28 19:01:20 +0000260 return CGM.getObjCRuntime().GenerateProtocolRef(*this, E->getProtocol());
Daniel Dunbar66912a12008-08-20 00:28:19 +0000261}
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000262
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000263/// Adjust the type of an Objective-C object that doesn't match up due
Douglas Gregore83b9562015-07-07 03:57:53 +0000264/// to type erasure at various points, e.g., related result types or the use
265/// of parameterized classes.
266static RValue AdjustObjCObjectType(CodeGenFunction &CGF, QualType ExpT,
267 RValue Result) {
268 if (!ExpT->isObjCRetainableType())
Douglas Gregor33823722011-06-11 01:09:30 +0000269 return Result;
John McCall31168b02011-06-15 23:02:42 +0000270
Douglas Gregore83b9562015-07-07 03:57:53 +0000271 // If the converted types are the same, we're done.
272 llvm::Type *ExpLLVMTy = CGF.ConvertType(ExpT);
273 if (ExpLLVMTy == Result.getScalarVal()->getType())
Douglas Gregor33823722011-06-11 01:09:30 +0000274 return Result;
Douglas Gregore83b9562015-07-07 03:57:53 +0000275
276 // We have applied a substitution. Cast the rvalue appropriately.
Douglas Gregor33823722011-06-11 01:09:30 +0000277 return RValue::get(CGF.Builder.CreateBitCast(Result.getScalarVal(),
Douglas Gregore83b9562015-07-07 03:57:53 +0000278 ExpLLVMTy));
Douglas Gregor33823722011-06-11 01:09:30 +0000279}
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000280
John McCallcf166702011-07-22 08:53:00 +0000281/// Decide whether to extend the lifetime of the receiver of a
282/// returns-inner-pointer message.
283static bool
284shouldExtendReceiverForInnerPointerMessage(const ObjCMessageExpr *message) {
285 switch (message->getReceiverKind()) {
286
287 // For a normal instance message, we should extend unless the
288 // receiver is loaded from a variable with precise lifetime.
289 case ObjCMessageExpr::Instance: {
290 const Expr *receiver = message->getInstanceReceiver();
John McCall6380a282015-09-09 23:37:17 +0000291
292 // Look through OVEs.
293 if (auto opaque = dyn_cast<OpaqueValueExpr>(receiver)) {
294 if (opaque->getSourceExpr())
295 receiver = opaque->getSourceExpr()->IgnoreParens();
296 }
297
John McCallcf166702011-07-22 08:53:00 +0000298 const ImplicitCastExpr *ice = dyn_cast<ImplicitCastExpr>(receiver);
299 if (!ice || ice->getCastKind() != CK_LValueToRValue) return true;
300 receiver = ice->getSubExpr()->IgnoreParens();
301
John McCall6380a282015-09-09 23:37:17 +0000302 // Look through OVEs.
303 if (auto opaque = dyn_cast<OpaqueValueExpr>(receiver)) {
304 if (opaque->getSourceExpr())
305 receiver = opaque->getSourceExpr()->IgnoreParens();
306 }
307
John McCallcf166702011-07-22 08:53:00 +0000308 // Only __strong variables.
309 if (receiver->getType().getObjCLifetime() != Qualifiers::OCL_Strong)
310 return true;
311
312 // All ivars and fields have precise lifetime.
313 if (isa<MemberExpr>(receiver) || isa<ObjCIvarRefExpr>(receiver))
314 return false;
315
316 // Otherwise, check for variables.
317 const DeclRefExpr *declRef = dyn_cast<DeclRefExpr>(ice->getSubExpr());
318 if (!declRef) return true;
319 const VarDecl *var = dyn_cast<VarDecl>(declRef->getDecl());
320 if (!var) return true;
321
322 // All variables have precise lifetime except local variables with
323 // automatic storage duration that aren't specially marked.
324 return (var->hasLocalStorage() &&
325 !var->hasAttr<ObjCPreciseLifetimeAttr>());
326 }
327
328 case ObjCMessageExpr::Class:
329 case ObjCMessageExpr::SuperClass:
330 // It's never necessary for class objects.
331 return false;
332
333 case ObjCMessageExpr::SuperInstance:
334 // We generally assume that 'self' lives throughout a method call.
335 return false;
336 }
337
338 llvm_unreachable("invalid receiver kind");
339}
340
John McCall460ce582015-10-22 18:38:17 +0000341/// Given an expression of ObjC pointer type, check whether it was
342/// immediately loaded from an ARC __weak l-value.
343static const Expr *findWeakLValue(const Expr *E) {
344 assert(E->getType()->isObjCRetainableType());
345 E = E->IgnoreParens();
346 if (auto CE = dyn_cast<CastExpr>(E)) {
347 if (CE->getCastKind() == CK_LValueToRValue) {
348 if (CE->getSubExpr()->getType().getObjCLifetime() == Qualifiers::OCL_Weak)
349 return CE->getSubExpr();
350 }
351 }
352
353 return nullptr;
354}
355
Pete Coopere3886802018-12-08 05:13:50 +0000356/// The ObjC runtime may provide entrypoints that are likely to be faster
357/// than an ordinary message send of the appropriate selector.
358///
359/// The entrypoints are guaranteed to be equivalent to just sending the
360/// corresponding message. If the entrypoint is implemented naively as just a
361/// message send, using it is a trade-off: it sacrifices a few cycles of
362/// overhead to save a small amount of code. However, it's possible for
363/// runtimes to detect and special-case classes that use "standard"
364/// behavior; if that's dynamically a large proportion of all objects, using
365/// the entrypoint will also be faster than using a message send.
366///
367/// If the runtime does support a required entrypoint, then this method will
368/// generate a call and return the resulting value. Otherwise it will return
369/// None and the caller can generate a msgSend instead.
370static Optional<llvm::Value *>
371tryGenerateSpecializedMessageSend(CodeGenFunction &CGF, QualType ResultType,
372 llvm::Value *Receiver,
373 const CallArgList& Args, Selector Sel,
Pete Cooperde0a8d32019-01-02 17:25:30 +0000374 const ObjCMethodDecl *method,
375 bool isClassMessage) {
Pete Coopere3886802018-12-08 05:13:50 +0000376 auto &CGM = CGF.CGM;
377 if (!CGM.getCodeGenOpts().ObjCConvertMessagesToRuntimeCalls)
378 return None;
379
380 auto &Runtime = CGM.getLangOpts().ObjCRuntime;
381 switch (Sel.getMethodFamily()) {
382 case OMF_alloc:
Pete Cooperde0a8d32019-01-02 17:25:30 +0000383 if (isClassMessage &&
384 Runtime.shouldUseRuntimeFunctionsForAlloc() &&
Pete Coopere3886802018-12-08 05:13:50 +0000385 ResultType->isObjCObjectPointerType()) {
386 // [Foo alloc] -> objc_alloc(Foo)
387 if (Sel.isUnarySelector() && Sel.getNameForSlot(0) == "alloc")
388 return CGF.EmitObjCAlloc(Receiver, CGF.ConvertType(ResultType));
389 // [Foo allocWithZone:nil] -> objc_allocWithZone(Foo)
390 if (Sel.isKeywordSelector() && Sel.getNumArgs() == 1 &&
391 Args.size() == 1 && Args.front().getType()->isPointerType() &&
392 Sel.getNameForSlot(0) == "allocWithZone") {
393 const llvm::Value* arg = Args.front().getKnownRValue().getScalarVal();
394 if (isa<llvm::ConstantPointerNull>(arg))
395 return CGF.EmitObjCAllocWithZone(Receiver,
396 CGF.ConvertType(ResultType));
397 return None;
398 }
399 }
400 break;
401
Pete Coopere5b64ea2018-12-21 21:00:32 +0000402 case OMF_autorelease:
403 if (ResultType->isObjCObjectPointerType() &&
404 CGM.getLangOpts().getGC() == LangOptions::NonGC &&
405 Runtime.shouldUseARCFunctionsForRetainRelease())
406 return CGF.EmitObjCAutorelease(Receiver, CGF.ConvertType(ResultType));
407 break;
408
409 case OMF_retain:
410 if (ResultType->isObjCObjectPointerType() &&
411 CGM.getLangOpts().getGC() == LangOptions::NonGC &&
412 Runtime.shouldUseARCFunctionsForRetainRelease())
413 return CGF.EmitObjCRetainNonBlock(Receiver, CGF.ConvertType(ResultType));
414 break;
415
416 case OMF_release:
417 if (ResultType->isVoidType() &&
418 CGM.getLangOpts().getGC() == LangOptions::NonGC &&
419 Runtime.shouldUseARCFunctionsForRetainRelease()) {
420 CGF.EmitObjCRelease(Receiver, ARCPreciseLifetime);
421 return nullptr;
422 }
423 break;
424
Pete Coopere3886802018-12-08 05:13:50 +0000425 default:
426 break;
427 }
428 return None;
429}
430
Erik Pilkingtonec389b02019-02-14 19:58:37 +0000431/// Instead of '[[MyClass alloc] init]', try to generate
432/// 'objc_alloc_init(MyClass)'. This provides a code size improvement on the
433/// caller side, as well as the optimized objc_alloc.
434static Optional<llvm::Value *>
435tryEmitSpecializedAllocInit(CodeGenFunction &CGF, const ObjCMessageExpr *OME) {
436 auto &Runtime = CGF.getLangOpts().ObjCRuntime;
437 if (!Runtime.shouldUseRuntimeFunctionForCombinedAllocInit())
438 return None;
439
440 // Match the exact pattern '[[MyClass alloc] init]'.
441 Selector Sel = OME->getSelector();
Erik Pilkington55e703a2019-02-25 21:35:14 +0000442 if (OME->getReceiverKind() != ObjCMessageExpr::Instance ||
443 !OME->getType()->isObjCObjectPointerType() || !Sel.isUnarySelector() ||
444 Sel.getNameForSlot(0) != "init")
Erik Pilkingtonec389b02019-02-14 19:58:37 +0000445 return None;
446
447 // Okay, this is '[receiver init]', check if 'receiver' is '[cls alloc]'.
448 auto *SubOME =
449 dyn_cast<ObjCMessageExpr>(OME->getInstanceReceiver()->IgnoreParens());
450 if (!SubOME)
451 return None;
452 Selector SubSel = SubOME->getSelector();
453 if (SubOME->getReceiverKind() != ObjCMessageExpr::Class ||
454 !SubOME->getType()->isObjCObjectPointerType() ||
455 !SubSel.isUnarySelector() || SubSel.getNameForSlot(0) != "alloc")
456 return None;
457
458 QualType ReceiverType = SubOME->getClassReceiver();
459 const ObjCObjectType *ObjTy = ReceiverType->getAs<ObjCObjectType>();
460 const ObjCInterfaceDecl *ID = ObjTy->getInterface();
461 assert(ID && "null interface should be impossible here");
462 llvm::Value *Receiver = CGF.CGM.getObjCRuntime().GetClass(CGF, ID);
463 return CGF.EmitObjCAllocInit(Receiver, CGF.ConvertType(OME->getType()));
464}
465
John McCall78a15112010-05-22 01:48:05 +0000466RValue CodeGenFunction::EmitObjCMessageExpr(const ObjCMessageExpr *E,
467 ReturnValueSlot Return) {
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000468 // Only the lookup mechanism and first two arguments of the method
469 // implementation vary between runtimes. We can get the receiver and
470 // arguments in generic code.
Mike Stump11289f42009-09-09 15:08:12 +0000471
John McCall31168b02011-06-15 23:02:42 +0000472 bool isDelegateInit = E->isDelegateInitCall();
473
John McCallcf166702011-07-22 08:53:00 +0000474 const ObjCMethodDecl *method = E->getMethodDecl();
Fariborz Jahanian715fdd52012-01-29 20:27:13 +0000475
John McCall460ce582015-10-22 18:38:17 +0000476 // If the method is -retain, and the receiver's being loaded from
477 // a __weak variable, peephole the entire operation to objc_loadWeakRetained.
478 if (method && E->getReceiverKind() == ObjCMessageExpr::Instance &&
479 method->getMethodFamily() == OMF_retain) {
480 if (auto lvalueExpr = findWeakLValue(E->getInstanceReceiver())) {
481 LValue lvalue = EmitLValue(lvalueExpr);
482 llvm::Value *result = EmitARCLoadWeakRetained(lvalue.getAddress());
483 return AdjustObjCObjectType(*this, E->getType(), RValue::get(result));
484 }
485 }
486
Erik Pilkingtonec389b02019-02-14 19:58:37 +0000487 if (Optional<llvm::Value *> Val = tryEmitSpecializedAllocInit(*this, E))
488 return AdjustObjCObjectType(*this, E->getType(), RValue::get(*Val));
489
John McCall31168b02011-06-15 23:02:42 +0000490 // We don't retain the receiver in delegate init calls, and this is
491 // safe because the receiver value is always loaded from 'self',
492 // which we zero out. We don't want to Block_copy block receivers,
493 // though.
494 bool retainSelf =
495 (!isDelegateInit &&
David Blaikiebbafb8a2012-03-11 07:00:24 +0000496 CGM.getLangOpts().ObjCAutoRefCount &&
John McCallcf166702011-07-22 08:53:00 +0000497 method &&
498 method->hasAttr<NSConsumesSelfAttr>());
John McCall31168b02011-06-15 23:02:42 +0000499
Daniel Dunbar8d480592008-08-11 18:12:00 +0000500 CGObjCRuntime &Runtime = CGM.getObjCRuntime();
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000501 bool isSuperMessage = false;
Daniel Dunbarca8531a2008-08-25 08:19:24 +0000502 bool isClassMessage = false;
Craig Topper8a13c412014-05-21 05:09:00 +0000503 ObjCInterfaceDecl *OID = nullptr;
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000504 // Find the receiver
Douglas Gregor33823722011-06-11 01:09:30 +0000505 QualType ReceiverType;
Craig Topper8a13c412014-05-21 05:09:00 +0000506 llvm::Value *Receiver = nullptr;
Douglas Gregor9a129192010-04-21 00:45:42 +0000507 switch (E->getReceiverKind()) {
508 case ObjCMessageExpr::Instance:
Douglas Gregor33823722011-06-11 01:09:30 +0000509 ReceiverType = E->getInstanceReceiver()->getType();
John McCall31168b02011-06-15 23:02:42 +0000510 if (retainSelf) {
511 TryEmitResult ter = tryEmitARCRetainScalarExpr(*this,
512 E->getInstanceReceiver());
513 Receiver = ter.getPointer();
John McCallcf166702011-07-22 08:53:00 +0000514 if (ter.getInt()) retainSelf = false;
John McCall31168b02011-06-15 23:02:42 +0000515 } else
516 Receiver = EmitScalarExpr(E->getInstanceReceiver());
Douglas Gregor9a129192010-04-21 00:45:42 +0000517 break;
Daniel Dunbar7c6d3a72008-08-16 00:25:02 +0000518
Douglas Gregor9a129192010-04-21 00:45:42 +0000519 case ObjCMessageExpr::Class: {
Douglas Gregor33823722011-06-11 01:09:30 +0000520 ReceiverType = E->getClassReceiver();
521 const ObjCObjectType *ObjTy = ReceiverType->getAs<ObjCObjectType>();
John McCall3e294922010-05-17 20:12:43 +0000522 assert(ObjTy && "Invalid Objective-C class message send");
523 OID = ObjTy->getInterface();
524 assert(OID && "Invalid Objective-C class message send");
John McCall882987f2013-02-28 19:01:20 +0000525 Receiver = Runtime.GetClass(*this, OID);
Daniel Dunbarca8531a2008-08-25 08:19:24 +0000526 isClassMessage = true;
Douglas Gregor9a129192010-04-21 00:45:42 +0000527 break;
528 }
529
530 case ObjCMessageExpr::SuperInstance:
Douglas Gregor33823722011-06-11 01:09:30 +0000531 ReceiverType = E->getSuperType();
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000532 Receiver = LoadObjCSelf();
Douglas Gregor9a129192010-04-21 00:45:42 +0000533 isSuperMessage = true;
534 break;
535
536 case ObjCMessageExpr::SuperClass:
Douglas Gregor33823722011-06-11 01:09:30 +0000537 ReceiverType = E->getSuperType();
Douglas Gregor9a129192010-04-21 00:45:42 +0000538 Receiver = LoadObjCSelf();
539 isSuperMessage = true;
540 isClassMessage = true;
541 break;
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000542 }
543
John McCallcf166702011-07-22 08:53:00 +0000544 if (retainSelf)
545 Receiver = EmitARCRetainNonBlock(Receiver);
546
547 // In ARC, we sometimes want to "extend the lifetime"
548 // (i.e. retain+autorelease) of receivers of returns-inner-pointer
549 // messages.
David Blaikiebbafb8a2012-03-11 07:00:24 +0000550 if (getLangOpts().ObjCAutoRefCount && method &&
John McCallcf166702011-07-22 08:53:00 +0000551 method->hasAttr<ObjCReturnsInnerPointerAttr>() &&
552 shouldExtendReceiverForInnerPointerMessage(E))
553 Receiver = EmitARCRetainAutorelease(ReceiverType, Receiver);
554
Alp Toker314cc812014-01-25 16:55:45 +0000555 QualType ResultType = method ? method->getReturnType() : E->getType();
John McCall31168b02011-06-15 23:02:42 +0000556
Daniel Dunbarc722b852008-08-30 03:02:31 +0000557 CallArgList Args;
Vedant Kumared00ea02017-03-06 05:28:22 +0000558 EmitCallArgs(Args, method, E->arguments(), /*AC*/AbstractCallee(method));
Mike Stump11289f42009-09-09 15:08:12 +0000559
John McCall31168b02011-06-15 23:02:42 +0000560 // For delegate init calls in ARC, do an unsafe store of null into
561 // self. This represents the call taking direct ownership of that
562 // value. We have to do this after emitting the other call
563 // arguments because they might also reference self, but we don't
564 // have to worry about any of them modifying self because that would
565 // be an undefined read and write of an object in unordered
566 // expressions.
567 if (isDelegateInit) {
David Blaikiebbafb8a2012-03-11 07:00:24 +0000568 assert(getLangOpts().ObjCAutoRefCount &&
John McCall31168b02011-06-15 23:02:42 +0000569 "delegate init calls should only be marked in ARC");
570
571 // Do an unsafe store of null into self.
John McCall7f416cc2015-09-08 08:05:57 +0000572 Address selfAddr =
573 GetAddrOfLocalVar(cast<ObjCMethodDecl>(CurCodeDecl)->getSelfDecl());
John McCall31168b02011-06-15 23:02:42 +0000574 Builder.CreateStore(getNullForVariable(selfAddr), selfAddr);
575 }
Anders Carlsson280e61f12010-06-21 20:59:55 +0000576
Douglas Gregor33823722011-06-11 01:09:30 +0000577 RValue result;
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000578 if (isSuperMessage) {
Chris Lattner6cfec782008-06-26 04:42:20 +0000579 // super is only valid in an Objective-C method
580 const ObjCMethodDecl *OMD = cast<ObjCMethodDecl>(CurFuncDecl);
Fariborz Jahanianbac73ac2009-02-28 20:07:56 +0000581 bool isCategoryImpl = isa<ObjCCategoryImplDecl>(OMD->getDeclContext());
Douglas Gregor33823722011-06-11 01:09:30 +0000582 result = Runtime.GenerateMessageSendSuper(*this, Return, ResultType,
583 E->getSelector(),
584 OMD->getClassInterface(),
585 isCategoryImpl,
586 Receiver,
587 isClassMessage,
588 Args,
John McCallcf166702011-07-22 08:53:00 +0000589 method);
Douglas Gregor33823722011-06-11 01:09:30 +0000590 } else {
Pete Coopere3886802018-12-08 05:13:50 +0000591 // Call runtime methods directly if we can.
592 if (Optional<llvm::Value *> SpecializedResult =
593 tryGenerateSpecializedMessageSend(*this, ResultType, Receiver, Args,
Pete Cooperde0a8d32019-01-02 17:25:30 +0000594 E->getSelector(), method,
595 isClassMessage)) {
Pete Coopere3886802018-12-08 05:13:50 +0000596 result = RValue::get(SpecializedResult.getValue());
597 } else {
598 result = Runtime.GenerateMessageSend(*this, Return, ResultType,
599 E->getSelector(), Receiver, Args,
600 OID, method);
601 }
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000602 }
John McCall31168b02011-06-15 23:02:42 +0000603
604 // For delegate init calls in ARC, implicitly store the result of
605 // the call back into self. This takes ownership of the value.
606 if (isDelegateInit) {
John McCall7f416cc2015-09-08 08:05:57 +0000607 Address selfAddr =
608 GetAddrOfLocalVar(cast<ObjCMethodDecl>(CurCodeDecl)->getSelfDecl());
John McCall31168b02011-06-15 23:02:42 +0000609 llvm::Value *newSelf = result.getScalarVal();
610
611 // The delegate return type isn't necessarily a matching type; in
612 // fact, it's quite likely to be 'id'.
John McCall7f416cc2015-09-08 08:05:57 +0000613 llvm::Type *selfTy = selfAddr.getElementType();
John McCall31168b02011-06-15 23:02:42 +0000614 newSelf = Builder.CreateBitCast(newSelf, selfTy);
615
616 Builder.CreateStore(newSelf, selfAddr);
617 }
Fariborz Jahanian715fdd52012-01-29 20:27:13 +0000618
Douglas Gregore83b9562015-07-07 03:57:53 +0000619 return AdjustObjCObjectType(*this, E->getType(), result);
Anders Carlsson76f4a902007-08-21 17:43:55 +0000620}
621
John McCall31168b02011-06-15 23:02:42 +0000622namespace {
David Blaikie7e70d682015-08-18 22:40:54 +0000623struct FinishARCDealloc final : EHScopeStack::Cleanup {
Craig Topper4f12f102014-03-12 06:41:41 +0000624 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall31168b02011-06-15 23:02:42 +0000625 const ObjCMethodDecl *method = cast<ObjCMethodDecl>(CGF.CurCodeDecl);
John McCalldffafde2011-07-13 18:26:47 +0000626
627 const ObjCImplDecl *impl = cast<ObjCImplDecl>(method->getDeclContext());
John McCall31168b02011-06-15 23:02:42 +0000628 const ObjCInterfaceDecl *iface = impl->getClassInterface();
629 if (!iface->getSuperClass()) return;
630
John McCalldffafde2011-07-13 18:26:47 +0000631 bool isCategory = isa<ObjCCategoryImplDecl>(impl);
632
John McCall31168b02011-06-15 23:02:42 +0000633 // Call [super dealloc] if we have a superclass.
634 llvm::Value *self = CGF.LoadObjCSelf();
635
636 CallArgList args;
637 CGF.CGM.getObjCRuntime().GenerateMessageSendSuper(CGF, ReturnValueSlot(),
638 CGF.getContext().VoidTy,
639 method->getSelector(),
640 iface,
John McCalldffafde2011-07-13 18:26:47 +0000641 isCategory,
John McCall31168b02011-06-15 23:02:42 +0000642 self,
643 /*is class msg*/ false,
644 args,
645 method);
646 }
647};
Alexander Kornienkoab9db512015-06-22 23:07:51 +0000648}
John McCall31168b02011-06-15 23:02:42 +0000649
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000650/// StartObjCMethod - Begin emission of an ObjCMethod. This generates
651/// the LLVM function and sets the other context used by
652/// CodeGenFunction.
Fariborz Jahanian0196a1c2009-01-10 21:06:09 +0000653void CodeGenFunction::StartObjCMethod(const ObjCMethodDecl *OMD,
David Blaikief1425802015-01-14 00:04:42 +0000654 const ObjCContainerDecl *CD) {
Stephen Kellyf2ceec42018-08-09 21:08:08 +0000655 SourceLocation StartLoc = OMD->getBeginLoc();
John McCalla738c252011-03-09 04:27:21 +0000656 FunctionArgList args;
Devang Patela2c048e2010-04-05 21:09:15 +0000657 // Check if we should generate debug info for this method.
David Blaikie92848de2013-08-26 20:33:21 +0000658 if (OMD->hasAttr<NoDebugAttr>())
Craig Topper8a13c412014-05-21 05:09:00 +0000659 DebugInfo = nullptr; // disable debug info indefinitely for this function
Devang Patela2c048e2010-04-05 21:09:15 +0000660
Fariborz Jahanian0196a1c2009-01-10 21:06:09 +0000661 llvm::Function *Fn = CGM.getObjCRuntime().GenerateMethod(OMD, CD);
Daniel Dunbar449a3392008-09-04 23:41:35 +0000662
John McCalla729c622012-02-17 03:33:10 +0000663 const CGFunctionInfo &FI = CGM.getTypes().arrangeObjCMethodDeclaration(OMD);
Daniel Dunbarc3e7cff2009-04-17 00:48:04 +0000664 CGM.SetInternalFunctionAttributes(OMD, Fn, FI);
Chris Lattner5696e7b2008-06-17 18:05:57 +0000665
John McCalla738c252011-03-09 04:27:21 +0000666 args.push_back(OMD->getSelfDecl());
667 args.push_back(OMD->getCmdDecl());
Chris Lattner5696e7b2008-06-17 18:05:57 +0000668
Benjamin Kramerf9890422015-02-17 16:48:30 +0000669 args.append(OMD->param_begin(), OMD->param_end());
Chris Lattner5696e7b2008-06-17 18:05:57 +0000670
Peter Collingbourne0ff0b372011-01-13 18:57:25 +0000671 CurGD = OMD;
Stephen Kelly1c301dc2018-08-09 21:09:38 +0000672 CurEHLocation = OMD->getEndLoc();
Peter Collingbourne0ff0b372011-01-13 18:57:25 +0000673
Adrian Prantl42d71b92014-04-10 23:21:53 +0000674 StartFunction(OMD, OMD->getReturnType(), Fn, FI, args,
675 OMD->getLocation(), StartLoc);
John McCall31168b02011-06-15 23:02:42 +0000676
677 // In ARC, certain methods get an extra cleanup.
David Blaikiebbafb8a2012-03-11 07:00:24 +0000678 if (CGM.getLangOpts().ObjCAutoRefCount &&
John McCall31168b02011-06-15 23:02:42 +0000679 OMD->isInstanceMethod() &&
680 OMD->getSelector().isUnarySelector()) {
Fangrui Song6907ce22018-07-30 19:24:48 +0000681 const IdentifierInfo *ident =
John McCall31168b02011-06-15 23:02:42 +0000682 OMD->getSelector().getIdentifierInfoForSlot(0);
683 if (ident->isStr("dealloc"))
684 EHStack.pushCleanup<FinishARCDealloc>(getARCCleanupKind());
685 }
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000686}
Daniel Dunbara94ecd22008-08-16 03:19:19 +0000687
John McCall31168b02011-06-15 23:02:42 +0000688static llvm::Value *emitARCRetainLoadOfScalar(CodeGenFunction &CGF,
689 LValue lvalue, QualType type);
690
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000691/// Generate an Objective-C method. An Objective-C method is a C function with
Raphael Isemannb23ccec2018-12-10 12:37:46 +0000692/// its pointer, name, and types registered in the class structure.
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000693void CodeGenFunction::GenerateObjCMethod(const ObjCMethodDecl *OMD) {
David Blaikief1425802015-01-14 00:04:42 +0000694 StartObjCMethod(OMD, OMD->getClassInterface());
Serge Pavlov3a561452015-12-06 14:32:39 +0000695 PGO.assignRegionCounters(GlobalDecl(OMD), CurFn);
Adrian Prantl56741e22014-01-07 22:05:55 +0000696 assert(isa<CompoundStmt>(OMD->getBody()));
Justin Bogner66242d62015-04-23 23:06:47 +0000697 incrementProfileCounter(OMD->getBody());
Adrian Prantl56741e22014-01-07 22:05:55 +0000698 EmitCompoundStmtWithoutScope(*cast<CompoundStmt>(OMD->getBody()));
Argyrios Kyrtzidisddcd1322009-06-30 02:35:26 +0000699 FinishFunction(OMD->getBodyRBrace());
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000700}
701
John McCallb923ece2011-09-12 23:06:44 +0000702/// emitStructGetterCall - Call the runtime function to load a property
703/// into the return value slot.
Fangrui Song6907ce22018-07-30 19:24:48 +0000704static void emitStructGetterCall(CodeGenFunction &CGF, ObjCIvarDecl *ivar,
John McCallb923ece2011-09-12 23:06:44 +0000705 bool isAtomic, bool hasStrong) {
706 ASTContext &Context = CGF.getContext();
707
John McCall7f416cc2015-09-08 08:05:57 +0000708 Address src =
709 CGF.EmitLValueForIvar(CGF.TypeOfSelfObject(), CGF.LoadObjCSelf(), ivar, 0)
710 .getAddress();
John McCallb923ece2011-09-12 23:06:44 +0000711
Fangrui Song6907ce22018-07-30 19:24:48 +0000712 // objc_copyStruct (ReturnValue, &structIvar,
John McCallb923ece2011-09-12 23:06:44 +0000713 // sizeof (Type of Ivar), isAtomic, false);
714 CallArgList args;
715
John McCall7f416cc2015-09-08 08:05:57 +0000716 Address dest = CGF.Builder.CreateBitCast(CGF.ReturnValue, CGF.VoidPtrTy);
717 args.add(RValue::get(dest.getPointer()), Context.VoidPtrTy);
John McCallb923ece2011-09-12 23:06:44 +0000718
719 src = CGF.Builder.CreateBitCast(src, CGF.VoidPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +0000720 args.add(RValue::get(src.getPointer()), Context.VoidPtrTy);
John McCallb923ece2011-09-12 23:06:44 +0000721
722 CharUnits size = CGF.getContext().getTypeSizeInChars(ivar->getType());
723 args.add(RValue::get(CGF.CGM.getSize(size)), Context.getSizeType());
724 args.add(RValue::get(CGF.Builder.getInt1(isAtomic)), Context.BoolTy);
725 args.add(RValue::get(CGF.Builder.getInt1(hasStrong)), Context.BoolTy);
726
James Y Knight9871db02019-02-05 16:42:33 +0000727 llvm::FunctionCallee fn = CGF.CGM.getObjCRuntime().GetGetStructFunction();
John McCallb92ab1a2016-10-26 23:46:34 +0000728 CGCallee callee = CGCallee::forDirect(fn);
John McCallc56a8b32016-03-11 04:30:31 +0000729 CGF.EmitCall(CGF.getTypes().arrangeBuiltinFunctionCall(Context.VoidTy, args),
John McCallb92ab1a2016-10-26 23:46:34 +0000730 callee, ReturnValueSlot(), args);
John McCallb923ece2011-09-12 23:06:44 +0000731}
732
John McCallf4528ae2011-09-13 03:34:09 +0000733/// Determine whether the given architecture supports unaligned atomic
734/// accesses. They don't have to be fast, just faster than a function
735/// call and a mutex.
736static bool hasUnalignedAtomics(llvm::Triple::ArchType arch) {
Eli Friedman5be3e6a2011-09-13 20:48:30 +0000737 // FIXME: Allow unaligned atomic load/store on x86. (It is not
738 // currently supported by the backend.)
739 return 0;
John McCallf4528ae2011-09-13 03:34:09 +0000740}
741
742/// Return the maximum size that permits atomic accesses for the given
743/// architecture.
744static CharUnits getMaxAtomicAccessSize(CodeGenModule &CGM,
745 llvm::Triple::ArchType arch) {
746 // ARM has 8-byte atomic accesses, but it's not clear whether we
747 // want to rely on them here.
748
749 // In the default case, just assume that any size up to a pointer is
750 // fine given adequate alignment.
751 return CharUnits::fromQuantity(CGM.PointerSizeInBytes);
752}
753
754namespace {
755 class PropertyImplStrategy {
756 public:
757 enum StrategyKind {
758 /// The 'native' strategy is to use the architecture's provided
759 /// reads and writes.
760 Native,
761
762 /// Use objc_setProperty and objc_getProperty.
763 GetSetProperty,
764
765 /// Use objc_setProperty for the setter, but use expression
766 /// evaluation for the getter.
767 SetPropertyAndExpressionGet,
768
769 /// Use objc_copyStruct.
770 CopyStruct,
771
772 /// The 'expression' strategy is to emit normal assignment or
773 /// lvalue-to-rvalue expressions.
774 Expression
775 };
776
777 StrategyKind getKind() const { return StrategyKind(Kind); }
778
779 bool hasStrongMember() const { return HasStrong; }
780 bool isAtomic() const { return IsAtomic; }
781 bool isCopy() const { return IsCopy; }
782
783 CharUnits getIvarSize() const { return IvarSize; }
784 CharUnits getIvarAlignment() const { return IvarAlignment; }
785
786 PropertyImplStrategy(CodeGenModule &CGM,
787 const ObjCPropertyImplDecl *propImpl);
788
789 private:
790 unsigned Kind : 8;
791 unsigned IsAtomic : 1;
792 unsigned IsCopy : 1;
793 unsigned HasStrong : 1;
794
795 CharUnits IvarSize;
796 CharUnits IvarAlignment;
797 };
Alexander Kornienkoab9db512015-06-22 23:07:51 +0000798}
John McCallf4528ae2011-09-13 03:34:09 +0000799
Sylvestre Ledru830885c2012-07-23 08:59:39 +0000800/// Pick an implementation strategy for the given property synthesis.
John McCallf4528ae2011-09-13 03:34:09 +0000801PropertyImplStrategy::PropertyImplStrategy(CodeGenModule &CGM,
802 const ObjCPropertyImplDecl *propImpl) {
803 const ObjCPropertyDecl *prop = propImpl->getPropertyDecl();
John McCall43192862011-09-13 18:31:23 +0000804 ObjCPropertyDecl::SetterKind setterKind = prop->getSetterKind();
John McCallf4528ae2011-09-13 03:34:09 +0000805
John McCall43192862011-09-13 18:31:23 +0000806 IsCopy = (setterKind == ObjCPropertyDecl::Copy);
807 IsAtomic = prop->isAtomic();
John McCallf4528ae2011-09-13 03:34:09 +0000808 HasStrong = false; // doesn't matter here.
809
810 // Evaluate the ivar's size and alignment.
811 ObjCIvarDecl *ivar = propImpl->getPropertyIvarDecl();
812 QualType ivarType = ivar->getType();
Benjamin Kramer867ea1d2014-03-02 13:01:17 +0000813 std::tie(IvarSize, IvarAlignment) =
814 CGM.getContext().getTypeInfoInChars(ivarType);
John McCallf4528ae2011-09-13 03:34:09 +0000815
816 // If we have a copy property, we always have to use getProperty/setProperty.
John McCall43192862011-09-13 18:31:23 +0000817 // TODO: we could actually use setProperty and an expression for non-atomics.
John McCallf4528ae2011-09-13 03:34:09 +0000818 if (IsCopy) {
819 Kind = GetSetProperty;
820 return;
821 }
822
John McCall43192862011-09-13 18:31:23 +0000823 // Handle retain.
824 if (setterKind == ObjCPropertyDecl::Retain) {
John McCallf4528ae2011-09-13 03:34:09 +0000825 // In GC-only, there's nothing special that needs to be done.
David Blaikiebbafb8a2012-03-11 07:00:24 +0000826 if (CGM.getLangOpts().getGC() == LangOptions::GCOnly) {
John McCallf4528ae2011-09-13 03:34:09 +0000827 // fallthrough
828
829 // In ARC, if the property is non-atomic, use expression emission,
830 // which translates to objc_storeStrong. This isn't required, but
831 // it's slightly nicer.
David Blaikiebbafb8a2012-03-11 07:00:24 +0000832 } else if (CGM.getLangOpts().ObjCAutoRefCount && !IsAtomic) {
John McCalld8561f02012-08-20 23:36:59 +0000833 // Using standard expression emission for the setter is only
834 // acceptable if the ivar is __strong, which won't be true if
835 // the property is annotated with __attribute__((NSObject)).
836 // TODO: falling all the way back to objc_setProperty here is
837 // just laziness, though; we could still use objc_storeStrong
838 // if we hacked it right.
839 if (ivarType.getObjCLifetime() == Qualifiers::OCL_Strong)
840 Kind = Expression;
841 else
842 Kind = SetPropertyAndExpressionGet;
John McCallf4528ae2011-09-13 03:34:09 +0000843 return;
844
845 // Otherwise, we need to at least use setProperty. However, if
846 // the property isn't atomic, we can use normal expression
847 // emission for the getter.
848 } else if (!IsAtomic) {
849 Kind = SetPropertyAndExpressionGet;
850 return;
851
852 // Otherwise, we have to use both setProperty and getProperty.
853 } else {
854 Kind = GetSetProperty;
855 return;
856 }
857 }
858
859 // If we're not atomic, just use expression accesses.
860 if (!IsAtomic) {
861 Kind = Expression;
862 return;
863 }
864
John McCall0e5c0862011-09-13 05:36:29 +0000865 // Properties on bitfield ivars need to be emitted using expression
866 // accesses even if they're nominally atomic.
867 if (ivar->isBitField()) {
868 Kind = Expression;
869 return;
870 }
871
John McCallf4528ae2011-09-13 03:34:09 +0000872 // GC-qualified or ARC-qualified ivars need to be emitted as
873 // expressions. This actually works out to being atomic anyway,
874 // except for ARC __strong, but that should trigger the above code.
875 if (ivarType.hasNonTrivialObjCLifetime() ||
David Blaikiebbafb8a2012-03-11 07:00:24 +0000876 (CGM.getLangOpts().getGC() &&
John McCallf4528ae2011-09-13 03:34:09 +0000877 CGM.getContext().getObjCGCAttrKind(ivarType))) {
878 Kind = Expression;
879 return;
880 }
881
882 // Compute whether the ivar has strong members.
David Blaikiebbafb8a2012-03-11 07:00:24 +0000883 if (CGM.getLangOpts().getGC())
John McCallf4528ae2011-09-13 03:34:09 +0000884 if (const RecordType *recordType = ivarType->getAs<RecordType>())
885 HasStrong = recordType->getDecl()->hasObjectMember();
886
887 // We can never access structs with object members with a native
888 // access, because we need to use write barriers. This is what
889 // objc_copyStruct is for.
890 if (HasStrong) {
891 Kind = CopyStruct;
892 return;
893 }
894
895 // Otherwise, this is target-dependent and based on the size and
896 // alignment of the ivar.
John McCall0bef0ba2011-09-13 07:33:34 +0000897
898 // If the size of the ivar is not a power of two, give up. We don't
899 // want to get into the business of doing compare-and-swaps.
900 if (!IvarSize.isPowerOfTwo()) {
901 Kind = CopyStruct;
902 return;
903 }
904
John McCallf4528ae2011-09-13 03:34:09 +0000905 llvm::Triple::ArchType arch =
John McCallc8e01702013-04-16 22:48:15 +0000906 CGM.getTarget().getTriple().getArch();
John McCallf4528ae2011-09-13 03:34:09 +0000907
908 // Most architectures require memory to fit within a single cache
909 // line, so the alignment has to be at least the size of the access.
910 // Otherwise we have to grab a lock.
911 if (IvarAlignment < IvarSize && !hasUnalignedAtomics(arch)) {
912 Kind = CopyStruct;
913 return;
914 }
915
916 // If the ivar's size exceeds the architecture's maximum atomic
917 // access size, we have to use CopyStruct.
918 if (IvarSize > getMaxAtomicAccessSize(CGM, arch)) {
919 Kind = CopyStruct;
920 return;
921 }
922
923 // Otherwise, we can use native loads and stores.
924 Kind = Native;
925}
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000926
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000927/// Generate an Objective-C property getter function.
James Dennettbe302452012-06-15 22:10:14 +0000928///
929/// The given Decl must be an ObjCImplementationDecl. \@synthesize
Steve Naroff5a7dd782009-01-10 22:55:25 +0000930/// is illegal within a category.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +0000931void CodeGenFunction::GenerateObjCGetter(ObjCImplementationDecl *IMP,
932 const ObjCPropertyImplDecl *PID) {
David Blaikie8e6c36e2014-10-14 16:43:46 +0000933 llvm::Constant *AtomicHelperFn =
934 CodeGenFunction(CGM).GenerateObjCAtomicGetterCopyHelperFunction(PID);
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000935 const ObjCPropertyDecl *PD = PID->getPropertyDecl();
936 ObjCMethodDecl *OMD = PD->getGetterMethodDecl();
937 assert(OMD && "Invalid call to generate getter (empty method)");
David Blaikief1425802015-01-14 00:04:42 +0000938 StartObjCMethod(OMD, IMP->getClassInterface());
Mike Stump11289f42009-09-09 15:08:12 +0000939
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +0000940 generateObjCGetterBody(IMP, PID, OMD, AtomicHelperFn);
John McCallf4528ae2011-09-13 03:34:09 +0000941
942 FinishFunction();
943}
944
John McCallbdd81852011-09-13 06:00:03 +0000945static bool hasTrivialGetExpr(const ObjCPropertyImplDecl *propImpl) {
946 const Expr *getter = propImpl->getGetterCXXConstructor();
John McCallf4528ae2011-09-13 03:34:09 +0000947 if (!getter) return true;
948
949 // Sema only makes only of these when the ivar has a C++ class type,
950 // so the form is pretty constrained.
951
John McCallbdd81852011-09-13 06:00:03 +0000952 // If the property has a reference type, we might just be binding a
953 // reference, in which case the result will be a gl-value. We should
954 // treat this as a non-trivial operation.
955 if (getter->isGLValue())
956 return false;
957
John McCallf4528ae2011-09-13 03:34:09 +0000958 // If we selected a trivial copy-constructor, we're okay.
959 if (const CXXConstructExpr *construct = dyn_cast<CXXConstructExpr>(getter))
960 return (construct->getConstructor()->isTrivial());
961
962 // The constructor might require cleanups (in which case it's never
963 // trivial).
964 assert(isa<ExprWithCleanups>(getter));
965 return false;
966}
967
Fangrui Song6907ce22018-07-30 19:24:48 +0000968/// emitCPPObjectAtomicGetterCall - Call the runtime function to
Fariborz Jahaniana08a7472012-01-10 00:37:01 +0000969/// copy the ivar into the resturn slot.
Fangrui Song6907ce22018-07-30 19:24:48 +0000970static void emitCPPObjectAtomicGetterCall(CodeGenFunction &CGF,
Fariborz Jahaniana08a7472012-01-10 00:37:01 +0000971 llvm::Value *returnAddr,
972 ObjCIvarDecl *ivar,
973 llvm::Constant *AtomicHelperFn) {
974 // objc_copyCppObjectAtomic (&returnSlot, &CppObjectIvar,
975 // AtomicHelperFn);
976 CallArgList args;
Fangrui Song6907ce22018-07-30 19:24:48 +0000977
Fariborz Jahaniana08a7472012-01-10 00:37:01 +0000978 // The 1st argument is the return Slot.
979 args.add(RValue::get(returnAddr), CGF.getContext().VoidPtrTy);
Fangrui Song6907ce22018-07-30 19:24:48 +0000980
Fariborz Jahaniana08a7472012-01-10 00:37:01 +0000981 // The 2nd argument is the address of the ivar.
Fangrui Song6907ce22018-07-30 19:24:48 +0000982 llvm::Value *ivarAddr =
983 CGF.EmitLValueForIvar(CGF.TypeOfSelfObject(),
John McCall7f416cc2015-09-08 08:05:57 +0000984 CGF.LoadObjCSelf(), ivar, 0).getPointer();
Fariborz Jahaniana08a7472012-01-10 00:37:01 +0000985 ivarAddr = CGF.Builder.CreateBitCast(ivarAddr, CGF.Int8PtrTy);
986 args.add(RValue::get(ivarAddr), CGF.getContext().VoidPtrTy);
Fangrui Song6907ce22018-07-30 19:24:48 +0000987
Fariborz Jahaniana08a7472012-01-10 00:37:01 +0000988 // Third argument is the helper function.
989 args.add(RValue::get(AtomicHelperFn), CGF.getContext().VoidPtrTy);
Fangrui Song6907ce22018-07-30 19:24:48 +0000990
James Y Knight9871db02019-02-05 16:42:33 +0000991 llvm::FunctionCallee copyCppAtomicObjectFn =
992 CGF.CGM.getObjCRuntime().GetCppAtomicObjectGetFunction();
John McCallb92ab1a2016-10-26 23:46:34 +0000993 CGCallee callee = CGCallee::forDirect(copyCppAtomicObjectFn);
John McCallc56a8b32016-03-11 04:30:31 +0000994 CGF.EmitCall(
995 CGF.getTypes().arrangeBuiltinFunctionCall(CGF.getContext().VoidTy, args),
John McCallb92ab1a2016-10-26 23:46:34 +0000996 callee, ReturnValueSlot(), args);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +0000997}
998
John McCallf4528ae2011-09-13 03:34:09 +0000999void
1000CodeGenFunction::generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001001 const ObjCPropertyImplDecl *propImpl,
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +00001002 const ObjCMethodDecl *GetterMethodDecl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001003 llvm::Constant *AtomicHelperFn) {
John McCallf4528ae2011-09-13 03:34:09 +00001004 // If there's a non-trivial 'get' expression, we just have to emit that.
1005 if (!hasTrivialGetExpr(propImpl)) {
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00001006 if (!AtomicHelperFn) {
Bruno Ricci023b1d12018-10-30 14:40:49 +00001007 auto *ret = ReturnStmt::Create(getContext(), SourceLocation(),
1008 propImpl->getGetterCXXConstructor(),
1009 /* NRVOCandidate=*/nullptr);
1010 EmitReturnStmt(*ret);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00001011 }
1012 else {
1013 ObjCIvarDecl *ivar = propImpl->getPropertyIvarDecl();
Fangrui Song6907ce22018-07-30 19:24:48 +00001014 emitCPPObjectAtomicGetterCall(*this, ReturnValue.getPointer(),
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00001015 ivar, AtomicHelperFn);
1016 }
John McCallf4528ae2011-09-13 03:34:09 +00001017 return;
1018 }
1019
1020 const ObjCPropertyDecl *prop = propImpl->getPropertyDecl();
1021 QualType propType = prop->getType();
1022 ObjCMethodDecl *getterMethod = prop->getGetterMethodDecl();
1023
Fangrui Song6907ce22018-07-30 19:24:48 +00001024 ObjCIvarDecl *ivar = propImpl->getPropertyIvarDecl();
John McCallf4528ae2011-09-13 03:34:09 +00001025
1026 // Pick an implementation strategy.
1027 PropertyImplStrategy strategy(CGM, propImpl);
1028 switch (strategy.getKind()) {
1029 case PropertyImplStrategy::Native: {
Eli Friedman0e846022012-10-26 22:38:05 +00001030 // We don't need to do anything for a zero-size struct.
1031 if (strategy.getIvarSize().isZero())
1032 return;
1033
John McCallf4528ae2011-09-13 03:34:09 +00001034 LValue LV = EmitLValueForIvar(TypeOfSelfObject(), LoadObjCSelf(), ivar, 0);
1035
1036 // Currently, all atomic accesses have to be through integer
1037 // types, so there's no point in trying to pick a prettier type.
Akira Hatanakade6f25f2016-05-26 00:37:30 +00001038 uint64_t ivarSize = getContext().toBits(strategy.getIvarSize());
1039 llvm::Type *bitcastType = llvm::Type::getIntNTy(getLLVMContext(), ivarSize);
John McCallf4528ae2011-09-13 03:34:09 +00001040 bitcastType = bitcastType->getPointerTo(); // addrspace 0 okay
1041
1042 // Perform an atomic load. This does not impose ordering constraints.
John McCall7f416cc2015-09-08 08:05:57 +00001043 Address ivarAddr = LV.getAddress();
John McCallf4528ae2011-09-13 03:34:09 +00001044 ivarAddr = Builder.CreateBitCast(ivarAddr, bitcastType);
1045 llvm::LoadInst *load = Builder.CreateLoad(ivarAddr, "load");
JF Bastien92f4ef12016-04-06 17:26:42 +00001046 load->setAtomic(llvm::AtomicOrdering::Unordered);
John McCallf4528ae2011-09-13 03:34:09 +00001047
1048 // Store that value into the return address. Doing this with a
1049 // bitcast is likely to produce some pretty ugly IR, but it's not
1050 // the *most* terrible thing in the world.
Akira Hatanakade6f25f2016-05-26 00:37:30 +00001051 llvm::Type *retTy = ConvertType(getterMethod->getReturnType());
1052 uint64_t retTySize = CGM.getDataLayout().getTypeSizeInBits(retTy);
1053 llvm::Value *ivarVal = load;
1054 if (ivarSize > retTySize) {
1055 llvm::Type *newTy = llvm::Type::getIntNTy(getLLVMContext(), retTySize);
1056 ivarVal = Builder.CreateTrunc(load, newTy);
1057 bitcastType = newTy->getPointerTo();
1058 }
1059 Builder.CreateStore(ivarVal,
1060 Builder.CreateBitCast(ReturnValue, bitcastType));
John McCallf4528ae2011-09-13 03:34:09 +00001061
1062 // Make sure we don't do an autorelease.
1063 AutoreleaseResult = false;
1064 return;
1065 }
1066
1067 case PropertyImplStrategy::GetSetProperty: {
James Y Knight9871db02019-02-05 16:42:33 +00001068 llvm::FunctionCallee getPropertyFn =
1069 CGM.getObjCRuntime().GetPropertyGetFunction();
John McCallf4528ae2011-09-13 03:34:09 +00001070 if (!getPropertyFn) {
1071 CGM.ErrorUnsupported(propImpl, "Obj-C getter requiring atomic copy");
Daniel Dunbara08dff12008-09-24 04:04:31 +00001072 return;
1073 }
John McCallb92ab1a2016-10-26 23:46:34 +00001074 CGCallee callee = CGCallee::forDirect(getPropertyFn);
Daniel Dunbara08dff12008-09-24 04:04:31 +00001075
1076 // Return (ivar-type) objc_getProperty((id) self, _cmd, offset, true).
1077 // FIXME: Can't this be simpler? This might even be worse than the
1078 // corresponding gcc code.
John McCallf4528ae2011-09-13 03:34:09 +00001079 llvm::Value *cmd =
John McCall7f416cc2015-09-08 08:05:57 +00001080 Builder.CreateLoad(GetAddrOfLocalVar(getterMethod->getCmdDecl()), "cmd");
John McCallf4528ae2011-09-13 03:34:09 +00001081 llvm::Value *self = Builder.CreateBitCast(LoadObjCSelf(), VoidPtrTy);
1082 llvm::Value *ivarOffset =
1083 EmitIvarOffset(classImpl->getClassInterface(), ivar);
1084
1085 CallArgList args;
1086 args.add(RValue::get(self), getContext().getObjCIdType());
1087 args.add(RValue::get(cmd), getContext().getObjCSelType());
1088 args.add(RValue::get(ivarOffset), getContext().getPointerDiffType());
John McCall43192862011-09-13 18:31:23 +00001089 args.add(RValue::get(Builder.getInt1(strategy.isAtomic())),
1090 getContext().BoolTy);
John McCallf4528ae2011-09-13 03:34:09 +00001091
Daniel Dunbar1ef73732009-02-03 23:43:59 +00001092 // FIXME: We shouldn't need to get the function info here, the
1093 // runtime already should have computed it to build the function.
James Y Knight3933add2019-01-30 02:54:28 +00001094 llvm::CallBase *CallInstruction;
James Y Knightb92d2902019-02-05 16:05:50 +00001095 RValue RV = EmitCall(getTypes().arrangeBuiltinFunctionCall(
1096 getContext().getObjCIdType(), args),
1097 callee, ReturnValueSlot(), args, &CallInstruction);
Fariborz Jahanian13b43042014-01-30 00:16:39 +00001098 if (llvm::CallInst *call = dyn_cast<llvm::CallInst>(CallInstruction))
1099 call->setTailCall();
John McCallf4528ae2011-09-13 03:34:09 +00001100
Daniel Dunbara08dff12008-09-24 04:04:31 +00001101 // We need to fix the type here. Ivars with copy & retain are
1102 // always objects so we don't need to worry about complex or
1103 // aggregates.
Alp Toker314cc812014-01-25 16:55:45 +00001104 RV = RValue::get(Builder.CreateBitCast(
1105 RV.getScalarVal(),
1106 getTypes().ConvertType(getterMethod->getReturnType())));
John McCallf4528ae2011-09-13 03:34:09 +00001107
1108 EmitReturnOfRValue(RV, propType);
John McCall31168b02011-06-15 23:02:42 +00001109
1110 // objc_getProperty does an autorelease, so we should suppress ours.
1111 AutoreleaseResult = false;
John McCall31168b02011-06-15 23:02:42 +00001112
John McCallf4528ae2011-09-13 03:34:09 +00001113 return;
1114 }
1115
1116 case PropertyImplStrategy::CopyStruct:
1117 emitStructGetterCall(*this, ivar, strategy.isAtomic(),
1118 strategy.hasStrongMember());
1119 return;
1120
1121 case PropertyImplStrategy::Expression:
1122 case PropertyImplStrategy::SetPropertyAndExpressionGet: {
1123 LValue LV = EmitLValueForIvar(TypeOfSelfObject(), LoadObjCSelf(), ivar, 0);
1124
1125 QualType ivarType = ivar->getType();
John McCall47fb9502013-03-07 21:37:08 +00001126 switch (getEvaluationKind(ivarType)) {
1127 case TEK_Complex: {
Nick Lewycky2d84e842013-10-02 02:29:49 +00001128 ComplexPairTy pair = EmitLoadOfComplex(LV, SourceLocation());
John McCall7f416cc2015-09-08 08:05:57 +00001129 EmitStoreOfComplex(pair, MakeAddrLValue(ReturnValue, ivarType),
John McCall47fb9502013-03-07 21:37:08 +00001130 /*init*/ true);
1131 return;
1132 }
Ivan A. Kosarev1860b522018-01-25 14:21:55 +00001133 case TEK_Aggregate: {
John McCallf4528ae2011-09-13 03:34:09 +00001134 // The return value slot is guaranteed to not be aliased, but
1135 // that's not necessarily the same as "on the stack", so
1136 // we still potentially need objc_memmove_collectable.
Ivan A. Kosarev1860b522018-01-25 14:21:55 +00001137 EmitAggregateCopy(/* Dest= */ MakeAddrLValue(ReturnValue, ivarType),
Richard Smithe78fac52018-04-05 20:52:58 +00001138 /* Src= */ LV, ivarType, overlapForReturnValue());
1139 return;
1140 }
John McCall47fb9502013-03-07 21:37:08 +00001141 case TEK_Scalar: {
John McCall24fada12011-07-22 05:23:13 +00001142 llvm::Value *value;
1143 if (propType->isReferenceType()) {
John McCall7f416cc2015-09-08 08:05:57 +00001144 value = LV.getAddress().getPointer();
John McCall24fada12011-07-22 05:23:13 +00001145 } else {
1146 // We want to load and autoreleaseReturnValue ARC __weak ivars.
1147 if (LV.getQuals().getObjCLifetime() == Qualifiers::OCL_Weak) {
John McCall460ce582015-10-22 18:38:17 +00001148 if (getLangOpts().ObjCAutoRefCount) {
1149 value = emitARCRetainLoadOfScalar(*this, LV, ivarType);
1150 } else {
1151 value = EmitARCLoadWeak(LV.getAddress());
1152 }
John McCall24fada12011-07-22 05:23:13 +00001153
1154 // Otherwise we want to do a simple load, suppressing the
1155 // final autorelease.
John McCall31168b02011-06-15 23:02:42 +00001156 } else {
Nick Lewycky2d84e842013-10-02 02:29:49 +00001157 value = EmitLoadOfLValue(LV, SourceLocation()).getScalarVal();
John McCall24fada12011-07-22 05:23:13 +00001158 AutoreleaseResult = false;
Fariborz Jahanianb24b5682011-03-28 23:47:18 +00001159 }
John McCall31168b02011-06-15 23:02:42 +00001160
Alp Toker314cc812014-01-25 16:55:45 +00001161 value = Builder.CreateBitCast(
1162 value, ConvertType(GetterMethodDecl->getReturnType()));
John McCall24fada12011-07-22 05:23:13 +00001163 }
Fangrui Song6907ce22018-07-30 19:24:48 +00001164
John McCall24fada12011-07-22 05:23:13 +00001165 EmitReturnOfRValue(RValue::get(value), propType);
John McCall47fb9502013-03-07 21:37:08 +00001166 return;
Fariborz Jahanianeab5ecd2009-03-03 18:49:40 +00001167 }
John McCall47fb9502013-03-07 21:37:08 +00001168 }
1169 llvm_unreachable("bad evaluation kind");
Daniel Dunbara08dff12008-09-24 04:04:31 +00001170 }
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001171
John McCallf4528ae2011-09-13 03:34:09 +00001172 }
1173 llvm_unreachable("bad @property implementation strategy!");
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001174}
1175
John McCallb923ece2011-09-12 23:06:44 +00001176/// emitStructSetterCall - Call the runtime function to store the value
1177/// from the first formal parameter into the given ivar.
1178static void emitStructSetterCall(CodeGenFunction &CGF, ObjCMethodDecl *OMD,
1179 ObjCIvarDecl *ivar) {
Fangrui Song6907ce22018-07-30 19:24:48 +00001180 // objc_copyStruct (&structIvar, &Arg,
Fariborz Jahanian302a3d42011-02-18 19:15:13 +00001181 // sizeof (struct something), true, false);
John McCall6acaef92011-09-10 09:30:49 +00001182 CallArgList args;
1183
1184 // The first argument is the address of the ivar.
John McCallb923ece2011-09-12 23:06:44 +00001185 llvm::Value *ivarAddr = CGF.EmitLValueForIvar(CGF.TypeOfSelfObject(),
1186 CGF.LoadObjCSelf(), ivar, 0)
John McCall7f416cc2015-09-08 08:05:57 +00001187 .getPointer();
John McCallb923ece2011-09-12 23:06:44 +00001188 ivarAddr = CGF.Builder.CreateBitCast(ivarAddr, CGF.Int8PtrTy);
1189 args.add(RValue::get(ivarAddr), CGF.getContext().VoidPtrTy);
John McCall6acaef92011-09-10 09:30:49 +00001190
1191 // The second argument is the address of the parameter variable.
John McCallb923ece2011-09-12 23:06:44 +00001192 ParmVarDecl *argVar = *OMD->param_begin();
Bruno Ricci5fc4db72018-12-21 14:10:18 +00001193 DeclRefExpr argRef(CGF.getContext(), argVar, false,
1194 argVar->getType().getNonReferenceType(), VK_LValue,
1195 SourceLocation());
John McCall7f416cc2015-09-08 08:05:57 +00001196 llvm::Value *argAddr = CGF.EmitLValue(&argRef).getPointer();
John McCallb923ece2011-09-12 23:06:44 +00001197 argAddr = CGF.Builder.CreateBitCast(argAddr, CGF.Int8PtrTy);
1198 args.add(RValue::get(argAddr), CGF.getContext().VoidPtrTy);
John McCall6acaef92011-09-10 09:30:49 +00001199
1200 // The third argument is the sizeof the type.
1201 llvm::Value *size =
John McCallb923ece2011-09-12 23:06:44 +00001202 CGF.CGM.getSize(CGF.getContext().getTypeSizeInChars(ivar->getType()));
1203 args.add(RValue::get(size), CGF.getContext().getSizeType());
John McCall6acaef92011-09-10 09:30:49 +00001204
John McCallb923ece2011-09-12 23:06:44 +00001205 // The fourth argument is the 'isAtomic' flag.
1206 args.add(RValue::get(CGF.Builder.getTrue()), CGF.getContext().BoolTy);
John McCall6acaef92011-09-10 09:30:49 +00001207
John McCallb923ece2011-09-12 23:06:44 +00001208 // The fifth argument is the 'hasStrong' flag.
1209 // FIXME: should this really always be false?
1210 args.add(RValue::get(CGF.Builder.getFalse()), CGF.getContext().BoolTy);
1211
James Y Knight9871db02019-02-05 16:42:33 +00001212 llvm::FunctionCallee fn = CGF.CGM.getObjCRuntime().GetSetStructFunction();
John McCallb92ab1a2016-10-26 23:46:34 +00001213 CGCallee callee = CGCallee::forDirect(fn);
John McCallc56a8b32016-03-11 04:30:31 +00001214 CGF.EmitCall(
1215 CGF.getTypes().arrangeBuiltinFunctionCall(CGF.getContext().VoidTy, args),
John McCallb92ab1a2016-10-26 23:46:34 +00001216 callee, ReturnValueSlot(), args);
Fariborz Jahanian302a3d42011-02-18 19:15:13 +00001217}
1218
Fangrui Song6907ce22018-07-30 19:24:48 +00001219/// emitCPPObjectAtomicSetterCall - Call the runtime function to store
1220/// the value from the first formal parameter into the given ivar, using
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001221/// the Cpp API for atomic Cpp objects with non-trivial copy assignment.
Fangrui Song6907ce22018-07-30 19:24:48 +00001222static void emitCPPObjectAtomicSetterCall(CodeGenFunction &CGF,
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001223 ObjCMethodDecl *OMD,
1224 ObjCIvarDecl *ivar,
1225 llvm::Constant *AtomicHelperFn) {
Fangrui Song6907ce22018-07-30 19:24:48 +00001226 // objc_copyCppObjectAtomic (&CppObjectIvar, &Arg,
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001227 // AtomicHelperFn);
1228 CallArgList args;
Fangrui Song6907ce22018-07-30 19:24:48 +00001229
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001230 // The first argument is the address of the ivar.
Fangrui Song6907ce22018-07-30 19:24:48 +00001231 llvm::Value *ivarAddr =
1232 CGF.EmitLValueForIvar(CGF.TypeOfSelfObject(),
John McCall7f416cc2015-09-08 08:05:57 +00001233 CGF.LoadObjCSelf(), ivar, 0).getPointer();
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001234 ivarAddr = CGF.Builder.CreateBitCast(ivarAddr, CGF.Int8PtrTy);
1235 args.add(RValue::get(ivarAddr), CGF.getContext().VoidPtrTy);
Fangrui Song6907ce22018-07-30 19:24:48 +00001236
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001237 // The second argument is the address of the parameter variable.
1238 ParmVarDecl *argVar = *OMD->param_begin();
Bruno Ricci5fc4db72018-12-21 14:10:18 +00001239 DeclRefExpr argRef(CGF.getContext(), argVar, false,
1240 argVar->getType().getNonReferenceType(), VK_LValue,
1241 SourceLocation());
John McCall7f416cc2015-09-08 08:05:57 +00001242 llvm::Value *argAddr = CGF.EmitLValue(&argRef).getPointer();
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001243 argAddr = CGF.Builder.CreateBitCast(argAddr, CGF.Int8PtrTy);
1244 args.add(RValue::get(argAddr), CGF.getContext().VoidPtrTy);
Fangrui Song6907ce22018-07-30 19:24:48 +00001245
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001246 // Third argument is the helper function.
1247 args.add(RValue::get(AtomicHelperFn), CGF.getContext().VoidPtrTy);
Fangrui Song6907ce22018-07-30 19:24:48 +00001248
James Y Knight9871db02019-02-05 16:42:33 +00001249 llvm::FunctionCallee fn =
1250 CGF.CGM.getObjCRuntime().GetCppAtomicObjectSetFunction();
John McCallb92ab1a2016-10-26 23:46:34 +00001251 CGCallee callee = CGCallee::forDirect(fn);
John McCallc56a8b32016-03-11 04:30:31 +00001252 CGF.EmitCall(
1253 CGF.getTypes().arrangeBuiltinFunctionCall(CGF.getContext().VoidTy, args),
John McCallb92ab1a2016-10-26 23:46:34 +00001254 callee, ReturnValueSlot(), args);
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001255}
1256
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00001257
John McCallf4528ae2011-09-13 03:34:09 +00001258static bool hasTrivialSetExpr(const ObjCPropertyImplDecl *PID) {
1259 Expr *setter = PID->getSetterCXXAssignment();
1260 if (!setter) return true;
1261
1262 // Sema only makes only of these when the ivar has a C++ class type,
1263 // so the form is pretty constrained.
John McCall7f16c422011-09-10 09:17:20 +00001264
1265 // An operator call is trivial if the function it calls is trivial.
John McCallf4528ae2011-09-13 03:34:09 +00001266 // This also implies that there's nothing non-trivial going on with
1267 // the arguments, because operator= can only be trivial if it's a
1268 // synthesized assignment operator and therefore both parameters are
1269 // references.
1270 if (CallExpr *call = dyn_cast<CallExpr>(setter)) {
John McCall7f16c422011-09-10 09:17:20 +00001271 if (const FunctionDecl *callee
1272 = dyn_cast_or_null<FunctionDecl>(call->getCalleeDecl()))
1273 if (callee->isTrivial())
1274 return true;
1275 return false;
Fariborz Jahanian5de53132011-04-06 16:05:26 +00001276 }
John McCall7f16c422011-09-10 09:17:20 +00001277
John McCallf4528ae2011-09-13 03:34:09 +00001278 assert(isa<ExprWithCleanups>(setter));
John McCall7f16c422011-09-10 09:17:20 +00001279 return false;
1280}
1281
Benjamin Kramer53ba6362012-03-10 20:38:56 +00001282static bool UseOptimizedSetter(CodeGenModule &CGM) {
David Blaikiebbafb8a2012-03-11 07:00:24 +00001283 if (CGM.getLangOpts().getGC() != LangOptions::NonGC)
Ted Kremeneke65b0862012-03-06 20:05:56 +00001284 return false;
Daniel Dunbarbd847cc2012-10-15 22:23:53 +00001285 return CGM.getLangOpts().ObjCRuntime.hasOptimizedSetter();
Ted Kremeneke65b0862012-03-06 20:05:56 +00001286}
1287
John McCall7f16c422011-09-10 09:17:20 +00001288void
1289CodeGenFunction::generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001290 const ObjCPropertyImplDecl *propImpl,
1291 llvm::Constant *AtomicHelperFn) {
John McCall7f16c422011-09-10 09:17:20 +00001292 const ObjCPropertyDecl *prop = propImpl->getPropertyDecl();
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00001293 ObjCIvarDecl *ivar = propImpl->getPropertyIvarDecl();
John McCall7f16c422011-09-10 09:17:20 +00001294 ObjCMethodDecl *setterMethod = prop->getSetterMethodDecl();
Fangrui Song6907ce22018-07-30 19:24:48 +00001295
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001296 // Just use the setter expression if Sema gave us one and it's
1297 // non-trivial.
1298 if (!hasTrivialSetExpr(propImpl)) {
1299 if (!AtomicHelperFn)
1300 // If non-atomic, assignment is called directly.
1301 EmitStmt(propImpl->getSetterCXXAssignment());
1302 else
1303 // If atomic, assignment is called via a locking api.
1304 emitCPPObjectAtomicSetterCall(*this, setterMethod, ivar,
1305 AtomicHelperFn);
1306 return;
1307 }
John McCall7f16c422011-09-10 09:17:20 +00001308
John McCallf4528ae2011-09-13 03:34:09 +00001309 PropertyImplStrategy strategy(CGM, propImpl);
1310 switch (strategy.getKind()) {
1311 case PropertyImplStrategy::Native: {
Eli Friedman0e846022012-10-26 22:38:05 +00001312 // We don't need to do anything for a zero-size struct.
1313 if (strategy.getIvarSize().isZero())
1314 return;
1315
John McCall7f416cc2015-09-08 08:05:57 +00001316 Address argAddr = GetAddrOfLocalVar(*setterMethod->param_begin());
John McCall7f16c422011-09-10 09:17:20 +00001317
John McCallf4528ae2011-09-13 03:34:09 +00001318 LValue ivarLValue =
1319 EmitLValueForIvar(TypeOfSelfObject(), LoadObjCSelf(), ivar, /*quals*/ 0);
John McCall7f416cc2015-09-08 08:05:57 +00001320 Address ivarAddr = ivarLValue.getAddress();
John McCall7f16c422011-09-10 09:17:20 +00001321
John McCallf4528ae2011-09-13 03:34:09 +00001322 // Currently, all atomic accesses have to be through integer
1323 // types, so there's no point in trying to pick a prettier type.
1324 llvm::Type *bitcastType =
1325 llvm::Type::getIntNTy(getLLVMContext(),
1326 getContext().toBits(strategy.getIvarSize()));
John McCallf4528ae2011-09-13 03:34:09 +00001327
1328 // Cast both arguments to the chosen operation type.
John McCall7f416cc2015-09-08 08:05:57 +00001329 argAddr = Builder.CreateElementBitCast(argAddr, bitcastType);
1330 ivarAddr = Builder.CreateElementBitCast(ivarAddr, bitcastType);
John McCallf4528ae2011-09-13 03:34:09 +00001331
1332 // This bitcast load is likely to cause some nasty IR.
1333 llvm::Value *load = Builder.CreateLoad(argAddr);
1334
1335 // Perform an atomic store. There are no memory ordering requirements.
1336 llvm::StoreInst *store = Builder.CreateStore(load, ivarAddr);
JF Bastien92f4ef12016-04-06 17:26:42 +00001337 store->setAtomic(llvm::AtomicOrdering::Unordered);
John McCallf4528ae2011-09-13 03:34:09 +00001338 return;
1339 }
1340
1341 case PropertyImplStrategy::GetSetProperty:
1342 case PropertyImplStrategy::SetPropertyAndExpressionGet: {
Craig Topper8a13c412014-05-21 05:09:00 +00001343
James Y Knight9871db02019-02-05 16:42:33 +00001344 llvm::FunctionCallee setOptimizedPropertyFn = nullptr;
1345 llvm::FunctionCallee setPropertyFn = nullptr;
Ted Kremeneke65b0862012-03-06 20:05:56 +00001346 if (UseOptimizedSetter(CGM)) {
Daniel Dunbarbd847cc2012-10-15 22:23:53 +00001347 // 10.8 and iOS 6.0 code and GC is off
Fangrui Song6907ce22018-07-30 19:24:48 +00001348 setOptimizedPropertyFn =
James Y Knight9871db02019-02-05 16:42:33 +00001349 CGM.getObjCRuntime().GetOptimizedPropertySetFunction(
1350 strategy.isAtomic(), strategy.isCopy());
Ted Kremeneke65b0862012-03-06 20:05:56 +00001351 if (!setOptimizedPropertyFn) {
1352 CGM.ErrorUnsupported(propImpl, "Obj-C optimized setter - NYI");
1353 return;
1354 }
John McCall7f16c422011-09-10 09:17:20 +00001355 }
Ted Kremeneke65b0862012-03-06 20:05:56 +00001356 else {
1357 setPropertyFn = CGM.getObjCRuntime().GetPropertySetFunction();
1358 if (!setPropertyFn) {
1359 CGM.ErrorUnsupported(propImpl, "Obj-C setter requiring atomic copy");
1360 return;
1361 }
1362 }
Fangrui Song6907ce22018-07-30 19:24:48 +00001363
John McCall7f16c422011-09-10 09:17:20 +00001364 // Emit objc_setProperty((id) self, _cmd, offset, arg,
1365 // <is-atomic>, <is-copy>).
1366 llvm::Value *cmd =
John McCall7f416cc2015-09-08 08:05:57 +00001367 Builder.CreateLoad(GetAddrOfLocalVar(setterMethod->getCmdDecl()));
John McCall7f16c422011-09-10 09:17:20 +00001368 llvm::Value *self =
1369 Builder.CreateBitCast(LoadObjCSelf(), VoidPtrTy);
1370 llvm::Value *ivarOffset =
1371 EmitIvarOffset(classImpl->getClassInterface(), ivar);
John McCall7f416cc2015-09-08 08:05:57 +00001372 Address argAddr = GetAddrOfLocalVar(*setterMethod->param_begin());
1373 llvm::Value *arg = Builder.CreateLoad(argAddr, "arg");
1374 arg = Builder.CreateBitCast(arg, VoidPtrTy);
John McCall7f16c422011-09-10 09:17:20 +00001375
1376 CallArgList args;
1377 args.add(RValue::get(self), getContext().getObjCIdType());
1378 args.add(RValue::get(cmd), getContext().getObjCSelType());
Ted Kremeneke65b0862012-03-06 20:05:56 +00001379 if (setOptimizedPropertyFn) {
1380 args.add(RValue::get(arg), getContext().getObjCIdType());
1381 args.add(RValue::get(ivarOffset), getContext().getPointerDiffType());
John McCallb92ab1a2016-10-26 23:46:34 +00001382 CGCallee callee = CGCallee::forDirect(setOptimizedPropertyFn);
John McCallc56a8b32016-03-11 04:30:31 +00001383 EmitCall(getTypes().arrangeBuiltinFunctionCall(getContext().VoidTy, args),
John McCallb92ab1a2016-10-26 23:46:34 +00001384 callee, ReturnValueSlot(), args);
Ted Kremeneke65b0862012-03-06 20:05:56 +00001385 } else {
1386 args.add(RValue::get(ivarOffset), getContext().getPointerDiffType());
1387 args.add(RValue::get(arg), getContext().getObjCIdType());
1388 args.add(RValue::get(Builder.getInt1(strategy.isAtomic())),
1389 getContext().BoolTy);
1390 args.add(RValue::get(Builder.getInt1(strategy.isCopy())),
1391 getContext().BoolTy);
1392 // FIXME: We shouldn't need to get the function info here, the runtime
1393 // already should have computed it to build the function.
John McCallb92ab1a2016-10-26 23:46:34 +00001394 CGCallee callee = CGCallee::forDirect(setPropertyFn);
John McCallc56a8b32016-03-11 04:30:31 +00001395 EmitCall(getTypes().arrangeBuiltinFunctionCall(getContext().VoidTy, args),
John McCallb92ab1a2016-10-26 23:46:34 +00001396 callee, ReturnValueSlot(), args);
Ted Kremeneke65b0862012-03-06 20:05:56 +00001397 }
Fangrui Song6907ce22018-07-30 19:24:48 +00001398
John McCall7f16c422011-09-10 09:17:20 +00001399 return;
1400 }
1401
John McCallf4528ae2011-09-13 03:34:09 +00001402 case PropertyImplStrategy::CopyStruct:
John McCallb923ece2011-09-12 23:06:44 +00001403 emitStructSetterCall(*this, setterMethod, ivar);
John McCall7f16c422011-09-10 09:17:20 +00001404 return;
John McCallf4528ae2011-09-13 03:34:09 +00001405
1406 case PropertyImplStrategy::Expression:
1407 break;
John McCall7f16c422011-09-10 09:17:20 +00001408 }
1409
1410 // Otherwise, fake up some ASTs and emit a normal assignment.
1411 ValueDecl *selfDecl = setterMethod->getSelfDecl();
Bruno Ricci5fc4db72018-12-21 14:10:18 +00001412 DeclRefExpr self(getContext(), selfDecl, false, selfDecl->getType(),
John McCall113bee02012-03-10 09:33:50 +00001413 VK_LValue, SourceLocation());
John McCall7f16c422011-09-10 09:17:20 +00001414 ImplicitCastExpr selfLoad(ImplicitCastExpr::OnStack,
1415 selfDecl->getType(), CK_LValueToRValue, &self,
1416 VK_RValue);
1417 ObjCIvarRefExpr ivarRef(ivar, ivar->getType().getNonReferenceType(),
Fariborz Jahanianf12ff4df2013-04-02 18:57:54 +00001418 SourceLocation(), SourceLocation(),
1419 &selfLoad, true, true);
John McCall7f16c422011-09-10 09:17:20 +00001420
1421 ParmVarDecl *argDecl = *setterMethod->param_begin();
1422 QualType argType = argDecl->getType().getNonReferenceType();
Bruno Ricci5fc4db72018-12-21 14:10:18 +00001423 DeclRefExpr arg(getContext(), argDecl, false, argType, VK_LValue,
1424 SourceLocation());
John McCall7f16c422011-09-10 09:17:20 +00001425 ImplicitCastExpr argLoad(ImplicitCastExpr::OnStack,
1426 argType.getUnqualifiedType(), CK_LValueToRValue,
1427 &arg, VK_RValue);
Fangrui Song6907ce22018-07-30 19:24:48 +00001428
John McCall7f16c422011-09-10 09:17:20 +00001429 // The property type can differ from the ivar type in some situations with
1430 // Objective-C pointer types, we can always bit cast the RHS in these cases.
1431 // The following absurdity is just to ensure well-formed IR.
1432 CastKind argCK = CK_NoOp;
1433 if (ivarRef.getType()->isObjCObjectPointerType()) {
1434 if (argLoad.getType()->isObjCObjectPointerType())
1435 argCK = CK_BitCast;
1436 else if (argLoad.getType()->isBlockPointerType())
1437 argCK = CK_BlockPointerToObjCPointerCast;
1438 else
1439 argCK = CK_CPointerToObjCPointerCast;
1440 } else if (ivarRef.getType()->isBlockPointerType()) {
1441 if (argLoad.getType()->isBlockPointerType())
1442 argCK = CK_BitCast;
1443 else
1444 argCK = CK_AnyPointerToBlockPointerCast;
1445 } else if (ivarRef.getType()->isPointerType()) {
1446 argCK = CK_BitCast;
1447 }
1448 ImplicitCastExpr argCast(ImplicitCastExpr::OnStack,
1449 ivarRef.getType(), argCK, &argLoad,
1450 VK_RValue);
1451 Expr *finalArg = &argLoad;
1452 if (!getContext().hasSameUnqualifiedType(ivarRef.getType(),
1453 argLoad.getType()))
1454 finalArg = &argCast;
1455
1456
1457 BinaryOperator assign(&ivarRef, finalArg, BO_Assign,
1458 ivarRef.getType(), VK_RValue, OK_Ordinary,
Adam Nemet484aa452017-03-27 19:17:25 +00001459 SourceLocation(), FPOptions());
John McCall7f16c422011-09-10 09:17:20 +00001460 EmitStmt(&assign);
Fariborz Jahanian5de53132011-04-06 16:05:26 +00001461}
1462
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001463/// Generate an Objective-C property setter function.
James Dennettbe302452012-06-15 22:10:14 +00001464///
1465/// The given Decl must be an ObjCImplementationDecl. \@synthesize
Steve Naroff5a7dd782009-01-10 22:55:25 +00001466/// is illegal within a category.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001467void CodeGenFunction::GenerateObjCSetter(ObjCImplementationDecl *IMP,
1468 const ObjCPropertyImplDecl *PID) {
David Blaikie8e6c36e2014-10-14 16:43:46 +00001469 llvm::Constant *AtomicHelperFn =
1470 CodeGenFunction(CGM).GenerateObjCAtomicSetterCopyHelperFunction(PID);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001471 const ObjCPropertyDecl *PD = PID->getPropertyDecl();
1472 ObjCMethodDecl *OMD = PD->getSetterMethodDecl();
1473 assert(OMD && "Invalid call to generate setter (empty method)");
David Blaikief1425802015-01-14 00:04:42 +00001474 StartObjCMethod(OMD, IMP->getClassInterface());
Daniel Dunbar5449ce52008-09-24 06:32:09 +00001475
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001476 generateObjCSetterBody(IMP, PID, AtomicHelperFn);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001477
1478 FinishFunction();
Chris Lattner5696e7b2008-06-17 18:05:57 +00001479}
1480
John McCall6a4fa522011-03-22 07:05:39 +00001481namespace {
David Blaikie7e70d682015-08-18 22:40:54 +00001482 struct DestroyIvar final : EHScopeStack::Cleanup {
John McCall4bd0fb12011-07-12 16:41:08 +00001483 private:
1484 llvm::Value *addr;
John McCall6a4fa522011-03-22 07:05:39 +00001485 const ObjCIvarDecl *ivar;
Peter Collingbourne1425b452012-01-26 03:33:36 +00001486 CodeGenFunction::Destroyer *destroyer;
John McCall4bd0fb12011-07-12 16:41:08 +00001487 bool useEHCleanupForArray;
1488 public:
1489 DestroyIvar(llvm::Value *addr, const ObjCIvarDecl *ivar,
1490 CodeGenFunction::Destroyer *destroyer,
1491 bool useEHCleanupForArray)
Peter Collingbourne1425b452012-01-26 03:33:36 +00001492 : addr(addr), ivar(ivar), destroyer(destroyer),
John McCall4bd0fb12011-07-12 16:41:08 +00001493 useEHCleanupForArray(useEHCleanupForArray) {}
John McCall6a4fa522011-03-22 07:05:39 +00001494
Craig Topper4f12f102014-03-12 06:41:41 +00001495 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall4bd0fb12011-07-12 16:41:08 +00001496 LValue lvalue
1497 = CGF.EmitLValueForIvar(CGF.TypeOfSelfObject(), addr, ivar, /*CVR*/ 0);
1498 CGF.emitDestroy(lvalue.getAddress(), ivar->getType(), destroyer,
John McCall30317fd2011-07-12 20:27:29 +00001499 flags.isForNormalCleanup() && useEHCleanupForArray);
John McCall6a4fa522011-03-22 07:05:39 +00001500 }
1501 };
Alexander Kornienkoab9db512015-06-22 23:07:51 +00001502}
John McCall6a4fa522011-03-22 07:05:39 +00001503
John McCall4bd0fb12011-07-12 16:41:08 +00001504/// Like CodeGenFunction::destroyARCStrong, but do it with a call.
1505static void destroyARCStrongWithStore(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001506 Address addr,
John McCall4bd0fb12011-07-12 16:41:08 +00001507 QualType type) {
1508 llvm::Value *null = getNullForVariable(addr);
1509 CGF.EmitARCStoreStrongCall(addr, null, /*ignored*/ true);
1510}
John McCall31168b02011-06-15 23:02:42 +00001511
John McCall6a4fa522011-03-22 07:05:39 +00001512static void emitCXXDestructMethod(CodeGenFunction &CGF,
1513 ObjCImplementationDecl *impl) {
1514 CodeGenFunction::RunCleanupsScope scope(CGF);
1515
1516 llvm::Value *self = CGF.LoadObjCSelf();
1517
Jordy Rosea91768e2011-07-22 02:08:32 +00001518 const ObjCInterfaceDecl *iface = impl->getClassInterface();
1519 for (const ObjCIvarDecl *ivar = iface->all_declared_ivar_begin();
John McCall6a4fa522011-03-22 07:05:39 +00001520 ivar; ivar = ivar->getNextIvar()) {
1521 QualType type = ivar->getType();
1522
John McCall6a4fa522011-03-22 07:05:39 +00001523 // Check whether the ivar is a destructible type.
John McCall4bd0fb12011-07-12 16:41:08 +00001524 QualType::DestructionKind dtorKind = type.isDestructedType();
1525 if (!dtorKind) continue;
John McCall6a4fa522011-03-22 07:05:39 +00001526
Craig Topper8a13c412014-05-21 05:09:00 +00001527 CodeGenFunction::Destroyer *destroyer = nullptr;
John McCall6a4fa522011-03-22 07:05:39 +00001528
John McCall4bd0fb12011-07-12 16:41:08 +00001529 // Use a call to objc_storeStrong to destroy strong ivars, for the
1530 // general benefit of the tools.
1531 if (dtorKind == QualType::DK_objc_strong_lifetime) {
Peter Collingbourne1425b452012-01-26 03:33:36 +00001532 destroyer = destroyARCStrongWithStore;
John McCall31168b02011-06-15 23:02:42 +00001533
John McCall4bd0fb12011-07-12 16:41:08 +00001534 // Otherwise use the default for the destruction kind.
1535 } else {
Peter Collingbourne1425b452012-01-26 03:33:36 +00001536 destroyer = CGF.getDestroyer(dtorKind);
John McCall6a4fa522011-03-22 07:05:39 +00001537 }
John McCall4bd0fb12011-07-12 16:41:08 +00001538
1539 CleanupKind cleanupKind = CGF.getCleanupKind(dtorKind);
1540
1541 CGF.EHStack.pushCleanup<DestroyIvar>(cleanupKind, self, ivar, destroyer,
1542 cleanupKind & EHCleanup);
John McCall6a4fa522011-03-22 07:05:39 +00001543 }
1544
1545 assert(scope.requiresCleanups() && "nothing to do in .cxx_destruct?");
1546}
1547
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001548void CodeGenFunction::GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1549 ObjCMethodDecl *MD,
1550 bool ctor) {
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001551 MD->createImplicitParams(CGM.getContext(), IMP->getClassInterface());
David Blaikief1425802015-01-14 00:04:42 +00001552 StartObjCMethod(MD, IMP->getClassInterface());
John McCall6a4fa522011-03-22 07:05:39 +00001553
1554 // Emit .cxx_construct.
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001555 if (ctor) {
John McCall31168b02011-06-15 23:02:42 +00001556 // Suppress the final autorelease in ARC.
1557 AutoreleaseResult = false;
1558
Aaron Ballman9bc5f362014-03-13 17:35:02 +00001559 for (const auto *IvarInit : IMP->inits()) {
Francois Pichetd583da02010-12-04 09:14:42 +00001560 FieldDecl *Field = IvarInit->getAnyMember();
Aaron Ballman9bc5f362014-03-13 17:35:02 +00001561 ObjCIvarDecl *Ivar = cast<ObjCIvarDecl>(Field);
Fangrui Song6907ce22018-07-30 19:24:48 +00001562 LValue LV = EmitLValueForIvar(TypeOfSelfObject(),
Fariborz Jahanian499b9022010-04-28 22:30:33 +00001563 LoadObjCSelf(), Ivar, 0);
John McCall8d6fc952011-08-25 20:40:09 +00001564 EmitAggExpr(IvarInit->getInit(),
1565 AggValueSlot::forLValue(LV, AggValueSlot::IsDestructed,
John McCalla5efa732011-08-25 23:04:34 +00001566 AggValueSlot::DoesNotNeedGCBarriers,
Richard Smithe78fac52018-04-05 20:52:58 +00001567 AggValueSlot::IsNotAliased,
1568 AggValueSlot::DoesNotOverlap));
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001569 }
1570 // constructor returns 'self'.
1571 CodeGenTypes &Types = CGM.getTypes();
1572 QualType IdTy(CGM.getContext().getObjCIdType());
1573 llvm::Value *SelfAsId =
1574 Builder.CreateBitCast(LoadObjCSelf(), Types.ConvertType(IdTy));
1575 EmitReturnOfRValue(RValue::get(SelfAsId), IdTy);
John McCall6a4fa522011-03-22 07:05:39 +00001576
1577 // Emit .cxx_destruct.
Chandler Carruthf3983652010-05-06 00:20:39 +00001578 } else {
John McCall6a4fa522011-03-22 07:05:39 +00001579 emitCXXDestructMethod(*this, IMP);
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001580 }
1581 FinishFunction();
1582}
1583
Daniel Dunbara08dff12008-09-24 04:04:31 +00001584llvm::Value *CodeGenFunction::LoadObjCSelf() {
John McCalldec348f72013-05-03 07:33:41 +00001585 VarDecl *Self = cast<ObjCMethodDecl>(CurFuncDecl)->getSelfDecl();
Bruno Ricci5fc4db72018-12-21 14:10:18 +00001586 DeclRefExpr DRE(getContext(), Self,
1587 /*is enclosing local*/ (CurFuncDecl != CurCodeDecl),
John McCalldec348f72013-05-03 07:33:41 +00001588 Self->getType(), VK_LValue, SourceLocation());
Nick Lewycky2d84e842013-10-02 02:29:49 +00001589 return EmitLoadOfScalar(EmitDeclRefLValue(&DRE), SourceLocation());
Chris Lattner5696e7b2008-06-17 18:05:57 +00001590}
1591
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00001592QualType CodeGenFunction::TypeOfSelfObject() {
1593 const ObjCMethodDecl *OMD = cast<ObjCMethodDecl>(CurFuncDecl);
1594 ImplicitParamDecl *selfDecl = OMD->getSelfDecl();
Steve Naroff7cae42b2009-07-10 23:34:53 +00001595 const ObjCObjectPointerType *PTy = cast<ObjCObjectPointerType>(
1596 getContext().getCanonicalType(selfDecl->getType()));
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00001597 return PTy->getPointeeType();
1598}
1599
Chris Lattnerd4808922009-03-22 21:03:39 +00001600void CodeGenFunction::EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S){
James Y Knight9871db02019-02-05 16:42:33 +00001601 llvm::FunctionCallee EnumerationMutationFnPtr =
1602 CGM.getObjCRuntime().EnumerationMutationFunction();
John McCallb92ab1a2016-10-26 23:46:34 +00001603 if (!EnumerationMutationFnPtr) {
Daniel Dunbara08dff12008-09-24 04:04:31 +00001604 CGM.ErrorUnsupported(&S, "Obj-C fast enumeration for this runtime");
1605 return;
1606 }
John McCallb92ab1a2016-10-26 23:46:34 +00001607 CGCallee EnumerationMutationFn =
1608 CGCallee::forDirect(EnumerationMutationFnPtr);
Daniel Dunbara08dff12008-09-24 04:04:31 +00001609
Devang Pateld2d66652011-01-19 01:36:36 +00001610 CGDebugInfo *DI = getDebugInfo();
Eric Christopher7cdf9482011-10-13 21:45:18 +00001611 if (DI)
1612 DI->EmitLexicalBlockStart(Builder, S.getSourceRange().getBegin());
Devang Pateld2d66652011-01-19 01:36:36 +00001613
Kuba Mracek5e5e4e72017-04-14 16:53:25 +00001614 RunCleanupsScope ForScope(*this);
1615
Kuba Mracek82c21752017-04-14 01:00:03 +00001616 // The local variable comes into scope immediately.
1617 AutoVarEmission variable = AutoVarEmission::invalid();
1618 if (const DeclStmt *SD = dyn_cast<DeclStmt>(S.getElement()))
1619 variable = EmitAutoVarAlloca(*cast<VarDecl>(SD->getSingleDecl()));
1620
John McCall1c926b72011-01-07 01:49:06 +00001621 JumpDest LoopEnd = getJumpDestInCurrentScope("forcoll.end");
Mike Stump11289f42009-09-09 15:08:12 +00001622
Anders Carlsson75658592008-08-31 02:33:12 +00001623 // Fast enumeration state.
Douglas Gregor636e2002011-08-09 17:23:49 +00001624 QualType StateTy = CGM.getObjCFastEnumerationStateType();
John McCall7f416cc2015-09-08 08:05:57 +00001625 Address StatePtr = CreateMemTemp(StateTy, "state.ptr");
Anders Carlssonc0964b62010-05-22 17:35:42 +00001626 EmitNullInitialization(StatePtr, StateTy);
Mike Stump11289f42009-09-09 15:08:12 +00001627
Anders Carlsson75658592008-08-31 02:33:12 +00001628 // Number of elements in the items array.
Anders Carlsson3f35a262008-08-31 04:05:03 +00001629 static const unsigned NumItems = 16;
Mike Stump11289f42009-09-09 15:08:12 +00001630
John McCall1c926b72011-01-07 01:49:06 +00001631 // Fetch the countByEnumeratingWithState:objects:count: selector.
Benjamin Kramer9e649c32010-03-30 11:36:44 +00001632 IdentifierInfo *II[] = {
1633 &CGM.getContext().Idents.get("countByEnumeratingWithState"),
1634 &CGM.getContext().Idents.get("objects"),
1635 &CGM.getContext().Idents.get("count")
1636 };
1637 Selector FastEnumSel =
1638 CGM.getContext().Selectors.getSelector(llvm::array_lengthof(II), &II[0]);
Anders Carlsson75658592008-08-31 02:33:12 +00001639
1640 QualType ItemsTy =
1641 getContext().getConstantArrayType(getContext().getObjCIdType(),
Mike Stump11289f42009-09-09 15:08:12 +00001642 llvm::APInt(32, NumItems),
Anders Carlsson75658592008-08-31 02:33:12 +00001643 ArrayType::Normal, 0);
John McCall7f416cc2015-09-08 08:05:57 +00001644 Address ItemsPtr = CreateMemTemp(ItemsTy, "items.ptr");
Mike Stump11289f42009-09-09 15:08:12 +00001645
John McCall53848232011-07-27 01:07:15 +00001646 // Emit the collection pointer. In ARC, we do a retain.
1647 llvm::Value *Collection;
David Blaikiebbafb8a2012-03-11 07:00:24 +00001648 if (getLangOpts().ObjCAutoRefCount) {
John McCall53848232011-07-27 01:07:15 +00001649 Collection = EmitARCRetainScalarExpr(S.getCollection());
1650
1651 // Enter a cleanup to do the release.
1652 EmitObjCConsumeObject(S.getCollection()->getType(), Collection);
1653 } else {
1654 Collection = EmitScalarExpr(S.getCollection());
1655 }
Mike Stump11289f42009-09-09 15:08:12 +00001656
John McCall91e82dd2011-08-05 00:14:38 +00001657 // The 'continue' label needs to appear within the cleanup for the
1658 // collection object.
1659 JumpDest AfterBody = getJumpDestInCurrentScope("forcoll.next");
1660
John McCall1c926b72011-01-07 01:49:06 +00001661 // Send it our message:
Anders Carlsson75658592008-08-31 02:33:12 +00001662 CallArgList Args;
John McCall1c926b72011-01-07 01:49:06 +00001663
1664 // The first argument is a temporary of the enumeration-state type.
John McCall7f416cc2015-09-08 08:05:57 +00001665 Args.add(RValue::get(StatePtr.getPointer()),
1666 getContext().getPointerType(StateTy));
Mike Stump11289f42009-09-09 15:08:12 +00001667
John McCall1c926b72011-01-07 01:49:06 +00001668 // The second argument is a temporary array with space for NumItems
1669 // pointers. We'll actually be loading elements from the array
1670 // pointer written into the control state; this buffer is so that
1671 // collections that *aren't* backed by arrays can still queue up
1672 // batches of elements.
John McCall7f416cc2015-09-08 08:05:57 +00001673 Args.add(RValue::get(ItemsPtr.getPointer()),
1674 getContext().getPointerType(ItemsTy));
Mike Stump11289f42009-09-09 15:08:12 +00001675
John McCall1c926b72011-01-07 01:49:06 +00001676 // The third argument is the capacity of that temporary array.
Saleem Abdulrasool94bb1a02017-09-08 23:41:17 +00001677 llvm::Type *NSUIntegerTy = ConvertType(getContext().getNSUIntegerType());
1678 llvm::Constant *Count = llvm::ConstantInt::get(NSUIntegerTy, NumItems);
1679 Args.add(RValue::get(Count), getContext().getNSUIntegerType());
Mike Stump11289f42009-09-09 15:08:12 +00001680
John McCall1c926b72011-01-07 01:49:06 +00001681 // Start the enumeration.
Mike Stump11289f42009-09-09 15:08:12 +00001682 RValue CountRV =
Saleem Abdulrasool94bb1a02017-09-08 23:41:17 +00001683 CGM.getObjCRuntime().GenerateMessageSend(*this, ReturnValueSlot(),
1684 getContext().getNSUIntegerType(),
1685 FastEnumSel, Collection, Args);
Anders Carlsson75658592008-08-31 02:33:12 +00001686
John McCall1c926b72011-01-07 01:49:06 +00001687 // The initial number of objects that were returned in the buffer.
1688 llvm::Value *initialBufferLimit = CountRV.getScalarVal();
Mike Stump11289f42009-09-09 15:08:12 +00001689
John McCall1c926b72011-01-07 01:49:06 +00001690 llvm::BasicBlock *EmptyBB = createBasicBlock("forcoll.empty");
1691 llvm::BasicBlock *LoopInitBB = createBasicBlock("forcoll.loopinit");
Mike Stump11289f42009-09-09 15:08:12 +00001692
Saleem Abdulrasool94bb1a02017-09-08 23:41:17 +00001693 llvm::Value *zero = llvm::Constant::getNullValue(NSUIntegerTy);
Anders Carlsson75658592008-08-31 02:33:12 +00001694
John McCall1c926b72011-01-07 01:49:06 +00001695 // If the limit pointer was zero to begin with, the collection is
Bob Wilson0ed74d92014-03-25 23:26:31 +00001696 // empty; skip all this. Set the branch weight assuming this has the same
1697 // probability of exiting the loop as any other loop exit.
Justin Bogner66242d62015-04-23 23:06:47 +00001698 uint64_t EntryCount = getCurrentProfileCount();
1699 Builder.CreateCondBr(
1700 Builder.CreateICmpEQ(initialBufferLimit, zero, "iszero"), EmptyBB,
1701 LoopInitBB,
Justin Bogner65512642015-05-02 05:00:55 +00001702 createProfileWeights(EntryCount, getProfileCount(S.getBody())));
Anders Carlsson75658592008-08-31 02:33:12 +00001703
John McCall1c926b72011-01-07 01:49:06 +00001704 // Otherwise, initialize the loop.
1705 EmitBlock(LoopInitBB);
Mike Stump11289f42009-09-09 15:08:12 +00001706
John McCall1c926b72011-01-07 01:49:06 +00001707 // Save the initial mutations value. This is the value at an
1708 // address that was written into the state object by
1709 // countByEnumeratingWithState:objects:count:.
James Y Knight751fe282019-02-09 22:22:28 +00001710 Address StateMutationsPtrPtr =
1711 Builder.CreateStructGEP(StatePtr, 2, "mutationsptr.ptr");
John McCall7f416cc2015-09-08 08:05:57 +00001712 llvm::Value *StateMutationsPtr
1713 = Builder.CreateLoad(StateMutationsPtrPtr, "mutationsptr");
Mike Stump11289f42009-09-09 15:08:12 +00001714
John McCall1c926b72011-01-07 01:49:06 +00001715 llvm::Value *initialMutations =
John McCall7f416cc2015-09-08 08:05:57 +00001716 Builder.CreateAlignedLoad(StateMutationsPtr, getPointerAlign(),
1717 "forcoll.initial-mutations");
Mike Stump11289f42009-09-09 15:08:12 +00001718
John McCall1c926b72011-01-07 01:49:06 +00001719 // Start looping. This is the point we return to whenever we have a
1720 // fresh, non-empty batch of objects.
1721 llvm::BasicBlock *LoopBodyBB = createBasicBlock("forcoll.loopbody");
1722 EmitBlock(LoopBodyBB);
Mike Stump11289f42009-09-09 15:08:12 +00001723
John McCall1c926b72011-01-07 01:49:06 +00001724 // The current index into the buffer.
Saleem Abdulrasool94bb1a02017-09-08 23:41:17 +00001725 llvm::PHINode *index = Builder.CreatePHI(NSUIntegerTy, 3, "forcoll.index");
John McCall1c926b72011-01-07 01:49:06 +00001726 index->addIncoming(zero, LoopInitBB);
Anders Carlsson75658592008-08-31 02:33:12 +00001727
John McCall1c926b72011-01-07 01:49:06 +00001728 // The current buffer size.
Saleem Abdulrasool94bb1a02017-09-08 23:41:17 +00001729 llvm::PHINode *count = Builder.CreatePHI(NSUIntegerTy, 3, "forcoll.count");
John McCall1c926b72011-01-07 01:49:06 +00001730 count->addIncoming(initialBufferLimit, LoopInitBB);
Mike Stump11289f42009-09-09 15:08:12 +00001731
Justin Bogner66242d62015-04-23 23:06:47 +00001732 incrementProfileCounter(&S);
Bob Wilson8ab16912014-02-24 01:13:09 +00001733
John McCall1c926b72011-01-07 01:49:06 +00001734 // Check whether the mutations value has changed from where it was
1735 // at start. StateMutationsPtr should actually be invariant between
1736 // refreshes.
Anders Carlsson3f35a262008-08-31 04:05:03 +00001737 StateMutationsPtr = Builder.CreateLoad(StateMutationsPtrPtr, "mutationsptr");
John McCall1c926b72011-01-07 01:49:06 +00001738 llvm::Value *currentMutations
John McCall7f416cc2015-09-08 08:05:57 +00001739 = Builder.CreateAlignedLoad(StateMutationsPtr, getPointerAlign(),
1740 "statemutations");
Anders Carlsson3f35a262008-08-31 04:05:03 +00001741
John McCall1c926b72011-01-07 01:49:06 +00001742 llvm::BasicBlock *WasMutatedBB = createBasicBlock("forcoll.mutated");
Dan Gohman6ca99822011-03-02 22:39:34 +00001743 llvm::BasicBlock *WasNotMutatedBB = createBasicBlock("forcoll.notmutated");
Mike Stump11289f42009-09-09 15:08:12 +00001744
John McCall1c926b72011-01-07 01:49:06 +00001745 Builder.CreateCondBr(Builder.CreateICmpEQ(currentMutations, initialMutations),
1746 WasNotMutatedBB, WasMutatedBB);
Mike Stump11289f42009-09-09 15:08:12 +00001747
John McCall1c926b72011-01-07 01:49:06 +00001748 // If so, call the enumeration-mutation function.
1749 EmitBlock(WasMutatedBB);
Anders Carlsson3f35a262008-08-31 04:05:03 +00001750 llvm::Value *V =
Mike Stump11289f42009-09-09 15:08:12 +00001751 Builder.CreateBitCast(Collection,
Benjamin Kramer76399eb2011-09-27 21:06:10 +00001752 ConvertType(getContext().getObjCIdType()));
Daniel Dunbar84388bf2009-02-03 23:55:40 +00001753 CallArgList Args2;
Eli Friedman43dca6a2011-05-02 17:57:46 +00001754 Args2.add(RValue::get(V), getContext().getObjCIdType());
Mike Stump18bb9282009-05-16 07:57:57 +00001755 // FIXME: We shouldn't need to get the function info here, the runtime already
1756 // should have computed it to build the function.
John McCallc56a8b32016-03-11 04:30:31 +00001757 EmitCall(
1758 CGM.getTypes().arrangeBuiltinFunctionCall(getContext().VoidTy, Args2),
Anders Carlsson61a401c2009-12-24 19:25:24 +00001759 EnumerationMutationFn, ReturnValueSlot(), Args2);
Mike Stump11289f42009-09-09 15:08:12 +00001760
John McCall1c926b72011-01-07 01:49:06 +00001761 // Otherwise, or if the mutation function returns, just continue.
1762 EmitBlock(WasNotMutatedBB);
Mike Stump11289f42009-09-09 15:08:12 +00001763
John McCall1c926b72011-01-07 01:49:06 +00001764 // Initialize the element variable.
1765 RunCleanupsScope elementVariableScope(*this);
John McCall9e2e22f2011-02-22 07:16:58 +00001766 bool elementIsVariable;
John McCall1c926b72011-01-07 01:49:06 +00001767 LValue elementLValue;
1768 QualType elementType;
1769 if (const DeclStmt *SD = dyn_cast<DeclStmt>(S.getElement())) {
John McCall9e2e22f2011-02-22 07:16:58 +00001770 // Initialize the variable, in case it's a __block variable or something.
1771 EmitAutoVarInit(variable);
John McCall1c926b72011-01-07 01:49:06 +00001772
Bruno Ricci5fc4db72018-12-21 14:10:18 +00001773 const VarDecl *D = cast<VarDecl>(SD->getSingleDecl());
1774 DeclRefExpr tempDRE(getContext(), const_cast<VarDecl *>(D), false,
1775 D->getType(), VK_LValue, SourceLocation());
John McCall1c926b72011-01-07 01:49:06 +00001776 elementLValue = EmitLValue(&tempDRE);
1777 elementType = D->getType();
John McCall9e2e22f2011-02-22 07:16:58 +00001778 elementIsVariable = true;
John McCalld4631322011-06-17 06:42:21 +00001779
1780 if (D->isARCPseudoStrong())
1781 elementLValue.getQuals().setObjCLifetime(Qualifiers::OCL_ExplicitNone);
John McCall1c926b72011-01-07 01:49:06 +00001782 } else {
1783 elementLValue = LValue(); // suppress warning
1784 elementType = cast<Expr>(S.getElement())->getType();
John McCall9e2e22f2011-02-22 07:16:58 +00001785 elementIsVariable = false;
John McCall1c926b72011-01-07 01:49:06 +00001786 }
Chris Lattner2192fe52011-07-18 04:24:23 +00001787 llvm::Type *convertedElementType = ConvertType(elementType);
John McCall1c926b72011-01-07 01:49:06 +00001788
1789 // Fetch the buffer out of the enumeration state.
1790 // TODO: this pointer should actually be invariant between
1791 // refreshes, which would help us do certain loop optimizations.
James Y Knight751fe282019-02-09 22:22:28 +00001792 Address StateItemsPtr =
1793 Builder.CreateStructGEP(StatePtr, 1, "stateitems.ptr");
John McCall1c926b72011-01-07 01:49:06 +00001794 llvm::Value *EnumStateItems =
1795 Builder.CreateLoad(StateItemsPtr, "stateitems");
Anders Carlsson75658592008-08-31 02:33:12 +00001796
John McCall1c926b72011-01-07 01:49:06 +00001797 // Fetch the value at the current index from the buffer.
Mike Stump11289f42009-09-09 15:08:12 +00001798 llvm::Value *CurrentItemPtr =
John McCall1c926b72011-01-07 01:49:06 +00001799 Builder.CreateGEP(EnumStateItems, index, "currentitem.ptr");
John McCall7f416cc2015-09-08 08:05:57 +00001800 llvm::Value *CurrentItem =
1801 Builder.CreateAlignedLoad(CurrentItemPtr, getPointerAlign());
Mike Stump11289f42009-09-09 15:08:12 +00001802
John McCall1c926b72011-01-07 01:49:06 +00001803 // Cast that value to the right type.
1804 CurrentItem = Builder.CreateBitCast(CurrentItem, convertedElementType,
1805 "currentitem");
Mike Stump11289f42009-09-09 15:08:12 +00001806
John McCall1c926b72011-01-07 01:49:06 +00001807 // Make sure we have an l-value. Yes, this gets evaluated every
1808 // time through the loop.
John McCalld4631322011-06-17 06:42:21 +00001809 if (!elementIsVariable) {
John McCall1c926b72011-01-07 01:49:06 +00001810 elementLValue = EmitLValue(cast<Expr>(S.getElement()));
John McCall55e1fbc2011-06-25 02:11:03 +00001811 EmitStoreThroughLValue(RValue::get(CurrentItem), elementLValue);
John McCalld4631322011-06-17 06:42:21 +00001812 } else {
Akira Hatanaka642f7992016-10-18 19:05:41 +00001813 EmitStoreThroughLValue(RValue::get(CurrentItem), elementLValue,
1814 /*isInit*/ true);
John McCalld4631322011-06-17 06:42:21 +00001815 }
Mike Stump11289f42009-09-09 15:08:12 +00001816
John McCall9e2e22f2011-02-22 07:16:58 +00001817 // If we do have an element variable, this assignment is the end of
1818 // its initialization.
1819 if (elementIsVariable)
1820 EmitAutoVarCleanups(variable);
1821
John McCall1c926b72011-01-07 01:49:06 +00001822 // Perform the loop body, setting up break and continue labels.
Bob Wilsonbf854f02014-02-17 19:21:09 +00001823 BreakContinueStack.push_back(BreakContinue(LoopEnd, AfterBody));
John McCall1c926b72011-01-07 01:49:06 +00001824 {
1825 RunCleanupsScope Scope(*this);
1826 EmitStmt(S.getBody());
1827 }
Anders Carlsson75658592008-08-31 02:33:12 +00001828 BreakContinueStack.pop_back();
Mike Stump11289f42009-09-09 15:08:12 +00001829
John McCall1c926b72011-01-07 01:49:06 +00001830 // Destroy the element variable now.
1831 elementVariableScope.ForceCleanup();
1832
1833 // Check whether there are more elements.
John McCallad5d61e2010-07-23 21:56:41 +00001834 EmitBlock(AfterBody.getBlock());
Mike Stump11289f42009-09-09 15:08:12 +00001835
John McCall1c926b72011-01-07 01:49:06 +00001836 llvm::BasicBlock *FetchMoreBB = createBasicBlock("forcoll.refetch");
Fariborz Jahanian6e7ecc82009-01-06 18:56:31 +00001837
John McCall1c926b72011-01-07 01:49:06 +00001838 // First we check in the local buffer.
Saleem Abdulrasool94bb1a02017-09-08 23:41:17 +00001839 llvm::Value *indexPlusOne =
1840 Builder.CreateAdd(index, llvm::ConstantInt::get(NSUIntegerTy, 1));
Anders Carlsson75658592008-08-31 02:33:12 +00001841
John McCall1c926b72011-01-07 01:49:06 +00001842 // If we haven't overrun the buffer yet, we can continue.
Bob Wilson0ed74d92014-03-25 23:26:31 +00001843 // Set the branch weights based on the simplifying assumption that this is
1844 // like a while-loop, i.e., ignoring that the false branch fetches more
1845 // elements and then returns to the loop.
Justin Bogner66242d62015-04-23 23:06:47 +00001846 Builder.CreateCondBr(
1847 Builder.CreateICmpULT(indexPlusOne, count), LoopBodyBB, FetchMoreBB,
Justin Bogner65512642015-05-02 05:00:55 +00001848 createProfileWeights(getProfileCount(S.getBody()), EntryCount));
John McCall1c926b72011-01-07 01:49:06 +00001849
1850 index->addIncoming(indexPlusOne, AfterBody.getBlock());
1851 count->addIncoming(count, AfterBody.getBlock());
1852
1853 // Otherwise, we have to fetch more elements.
1854 EmitBlock(FetchMoreBB);
Mike Stump11289f42009-09-09 15:08:12 +00001855
1856 CountRV =
Saleem Abdulrasool94bb1a02017-09-08 23:41:17 +00001857 CGM.getObjCRuntime().GenerateMessageSend(*this, ReturnValueSlot(),
1858 getContext().getNSUIntegerType(),
1859 FastEnumSel, Collection, Args);
Mike Stump11289f42009-09-09 15:08:12 +00001860
John McCall1c926b72011-01-07 01:49:06 +00001861 // If we got a zero count, we're done.
1862 llvm::Value *refetchCount = CountRV.getScalarVal();
1863
1864 // (note that the message send might split FetchMoreBB)
1865 index->addIncoming(zero, Builder.GetInsertBlock());
1866 count->addIncoming(refetchCount, Builder.GetInsertBlock());
1867
1868 Builder.CreateCondBr(Builder.CreateICmpEQ(refetchCount, zero),
1869 EmptyBB, LoopBodyBB);
Mike Stump11289f42009-09-09 15:08:12 +00001870
Anders Carlsson75658592008-08-31 02:33:12 +00001871 // No more elements.
John McCall1c926b72011-01-07 01:49:06 +00001872 EmitBlock(EmptyBB);
Anders Carlsson75658592008-08-31 02:33:12 +00001873
John McCall9e2e22f2011-02-22 07:16:58 +00001874 if (!elementIsVariable) {
Anders Carlsson75658592008-08-31 02:33:12 +00001875 // If the element was not a declaration, set it to be null.
1876
John McCall1c926b72011-01-07 01:49:06 +00001877 llvm::Value *null = llvm::Constant::getNullValue(convertedElementType);
1878 elementLValue = EmitLValue(cast<Expr>(S.getElement()));
John McCall55e1fbc2011-06-25 02:11:03 +00001879 EmitStoreThroughLValue(RValue::get(null), elementLValue);
Anders Carlsson75658592008-08-31 02:33:12 +00001880 }
1881
Eric Christopher7cdf9482011-10-13 21:45:18 +00001882 if (DI)
1883 DI->EmitLexicalBlockEnd(Builder, S.getSourceRange().getEnd());
Devang Pateld2d66652011-01-19 01:36:36 +00001884
Akira Hatanaka2d3690b2016-04-12 23:10:58 +00001885 ForScope.ForceCleanup();
John McCallad5d61e2010-07-23 21:56:41 +00001886 EmitBlock(LoopEnd.getBlock());
Anders Carlsson2e744e82008-08-30 19:51:14 +00001887}
1888
Mike Stump11289f42009-09-09 15:08:12 +00001889void CodeGenFunction::EmitObjCAtTryStmt(const ObjCAtTryStmt &S) {
John McCallbd309292010-07-06 01:34:17 +00001890 CGM.getObjCRuntime().EmitTryStmt(*this, S);
Anders Carlsson1963b0c2008-09-09 10:04:29 +00001891}
1892
Mike Stump11289f42009-09-09 15:08:12 +00001893void CodeGenFunction::EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S) {
Anders Carlsson1963b0c2008-09-09 10:04:29 +00001894 CGM.getObjCRuntime().EmitThrowStmt(*this, S);
1895}
1896
Chris Lattnere132e242008-11-15 21:26:17 +00001897void CodeGenFunction::EmitObjCAtSynchronizedStmt(
Mike Stump11289f42009-09-09 15:08:12 +00001898 const ObjCAtSynchronizedStmt &S) {
John McCallbd309292010-07-06 01:34:17 +00001899 CGM.getObjCRuntime().EmitSynchronizedStmt(*this, S);
Chris Lattnere132e242008-11-15 21:26:17 +00001900}
1901
John McCall31168b02011-06-15 23:02:42 +00001902namespace {
David Blaikie7e70d682015-08-18 22:40:54 +00001903 struct CallObjCRelease final : EHScopeStack::Cleanup {
John McCall9c8e1c92011-08-03 22:24:24 +00001904 CallObjCRelease(llvm::Value *object) : object(object) {}
1905 llvm::Value *object;
John McCall31168b02011-06-15 23:02:42 +00001906
Craig Topper4f12f102014-03-12 06:41:41 +00001907 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCallcdda29c2013-03-13 03:10:54 +00001908 // Releases at the end of the full-expression are imprecise.
1909 CGF.EmitARCRelease(object, ARCImpreciseLifetime);
John McCall31168b02011-06-15 23:02:42 +00001910 }
1911 };
Alexander Kornienkoab9db512015-06-22 23:07:51 +00001912}
John McCall31168b02011-06-15 23:02:42 +00001913
John McCall2d637d22011-09-10 06:18:15 +00001914/// Produce the code for a CK_ARCConsumeObject. Does a primitive
John McCall31168b02011-06-15 23:02:42 +00001915/// release at the end of the full-expression.
1916llvm::Value *CodeGenFunction::EmitObjCConsumeObject(QualType type,
1917 llvm::Value *object) {
1918 // If we're in a conditional branch, we need to make the cleanup
John McCall9c8e1c92011-08-03 22:24:24 +00001919 // conditional.
1920 pushFullExprCleanup<CallObjCRelease>(getARCCleanupKind(), object);
John McCall31168b02011-06-15 23:02:42 +00001921 return object;
1922}
1923
1924llvm::Value *CodeGenFunction::EmitObjCExtendObjectLifetime(QualType type,
1925 llvm::Value *value) {
1926 return EmitARCRetainAutorelease(type, value);
1927}
1928
John McCalleff18842013-03-23 02:35:54 +00001929/// Given a number of pointers, inform the optimizer that they're
1930/// being intrinsically used up until this point in the program.
1931void CodeGenFunction::EmitARCIntrinsicUse(ArrayRef<llvm::Value*> values) {
James Y Knight9871db02019-02-05 16:42:33 +00001932 llvm::Function *&fn = CGM.getObjCEntrypoints().clang_arc_use;
Pete Cooper6c47f542018-12-20 18:05:41 +00001933 if (!fn)
1934 fn = CGM.getIntrinsic(llvm::Intrinsic::objc_clang_arc_use);
John McCalleff18842013-03-23 02:35:54 +00001935
1936 // This isn't really a "runtime" function, but as an intrinsic it
1937 // doesn't really matter as long as we align things up.
1938 EmitNounwindRuntimeCall(fn, values);
1939}
1940
James Y Knight9871db02019-02-05 16:42:33 +00001941static void setARCRuntimeFunctionLinkage(CodeGenModule &CGM, llvm::Value *RTF) {
Saleem Abdulrasoole60561c2017-02-11 17:24:07 +00001942 if (auto *F = dyn_cast<llvm::Function>(RTF)) {
Michael Gottesmanbe9614c2013-02-02 01:05:06 +00001943 // If the target runtime doesn't naturally support ARC, emit weak
1944 // references to the runtime support library. We don't really
1945 // permit this to fail, but we need a particular relocation style.
Saleem Abdulrasool6cb07442016-12-15 06:59:05 +00001946 if (!CGM.getLangOpts().ObjCRuntime.hasNativeARC() &&
1947 !CGM.getTriple().isOSBinFormatCOFF()) {
Saleem Abdulrasoole60561c2017-02-11 17:24:07 +00001948 F->setLinkage(llvm::Function::ExternalWeakLinkage);
Michael Gottesmanb46072d2013-02-02 01:03:01 +00001949 }
Michael Gottesmancf50e6d2013-02-02 00:57:44 +00001950 }
John McCall31168b02011-06-15 23:02:42 +00001951}
1952
James Y Knight9871db02019-02-05 16:42:33 +00001953static void setARCRuntimeFunctionLinkage(CodeGenModule &CGM,
1954 llvm::FunctionCallee RTF) {
1955 setARCRuntimeFunctionLinkage(CGM, RTF.getCallee());
1956}
1957
John McCall31168b02011-06-15 23:02:42 +00001958/// Perform an operation having the signature
1959/// i8* (i8*)
1960/// where a null input causes a no-op and returns null.
Akira Hatanaka65bb3f92019-03-21 19:59:49 +00001961static llvm::Value *emitARCValueOperation(
1962 CodeGenFunction &CGF, llvm::Value *value, llvm::Type *returnType,
1963 llvm::Function *&fn, llvm::Intrinsic::ID IntID,
1964 llvm::CallInst::TailCallKind tailKind = llvm::CallInst::TCK_None) {
Saleem Abdulrasoole60561c2017-02-11 17:24:07 +00001965 if (isa<llvm::ConstantPointerNull>(value))
1966 return value;
John McCall31168b02011-06-15 23:02:42 +00001967
1968 if (!fn) {
Pete Cooper2cd35962018-12-18 20:33:00 +00001969 fn = CGF.CGM.getIntrinsic(IntID);
1970 setARCRuntimeFunctionLinkage(CGF.CGM, fn);
John McCall31168b02011-06-15 23:02:42 +00001971 }
1972
1973 // Cast the argument to 'id'.
Pete Coopere3886802018-12-08 05:13:50 +00001974 llvm::Type *origType = returnType ? returnType : value->getType();
John McCall31168b02011-06-15 23:02:42 +00001975 value = CGF.Builder.CreateBitCast(value, CGF.Int8PtrTy);
1976
1977 // Call the function.
John McCall882987f2013-02-28 19:01:20 +00001978 llvm::CallInst *call = CGF.EmitNounwindRuntimeCall(fn, value);
Akira Hatanaka65bb3f92019-03-21 19:59:49 +00001979 call->setTailCallKind(tailKind);
John McCall31168b02011-06-15 23:02:42 +00001980
1981 // Cast the result back to the original type.
1982 return CGF.Builder.CreateBitCast(call, origType);
1983}
1984
1985/// Perform an operation having the following signature:
1986/// i8* (i8**)
James Y Knight9871db02019-02-05 16:42:33 +00001987static llvm::Value *emitARCLoadOperation(CodeGenFunction &CGF, Address addr,
1988 llvm::Function *&fn,
Pete Cooper2cd35962018-12-18 20:33:00 +00001989 llvm::Intrinsic::ID IntID) {
John McCall31168b02011-06-15 23:02:42 +00001990 if (!fn) {
Pete Cooper2cd35962018-12-18 20:33:00 +00001991 fn = CGF.CGM.getIntrinsic(IntID);
1992 setARCRuntimeFunctionLinkage(CGF.CGM, fn);
John McCall31168b02011-06-15 23:02:42 +00001993 }
1994
1995 // Cast the argument to 'id*'.
John McCall7f416cc2015-09-08 08:05:57 +00001996 llvm::Type *origType = addr.getElementType();
John McCall31168b02011-06-15 23:02:42 +00001997 addr = CGF.Builder.CreateBitCast(addr, CGF.Int8PtrPtrTy);
1998
1999 // Call the function.
John McCall7f416cc2015-09-08 08:05:57 +00002000 llvm::Value *result = CGF.EmitNounwindRuntimeCall(fn, addr.getPointer());
John McCall31168b02011-06-15 23:02:42 +00002001
2002 // Cast the result back to a dereference of the original type.
John McCall7f416cc2015-09-08 08:05:57 +00002003 if (origType != CGF.Int8PtrTy)
2004 result = CGF.Builder.CreateBitCast(result, origType);
John McCall31168b02011-06-15 23:02:42 +00002005
2006 return result;
2007}
2008
2009/// Perform an operation having the following signature:
2010/// i8* (i8**, i8*)
James Y Knight9871db02019-02-05 16:42:33 +00002011static llvm::Value *emitARCStoreOperation(CodeGenFunction &CGF, Address addr,
John McCall31168b02011-06-15 23:02:42 +00002012 llvm::Value *value,
James Y Knight9871db02019-02-05 16:42:33 +00002013 llvm::Function *&fn,
Pete Cooper2cd35962018-12-18 20:33:00 +00002014 llvm::Intrinsic::ID IntID,
John McCall31168b02011-06-15 23:02:42 +00002015 bool ignored) {
John McCall7f416cc2015-09-08 08:05:57 +00002016 assert(addr.getElementType() == value->getType());
John McCall31168b02011-06-15 23:02:42 +00002017
2018 if (!fn) {
Pete Cooper2cd35962018-12-18 20:33:00 +00002019 fn = CGF.CGM.getIntrinsic(IntID);
2020 setARCRuntimeFunctionLinkage(CGF.CGM, fn);
John McCall31168b02011-06-15 23:02:42 +00002021 }
2022
Chris Lattner2192fe52011-07-18 04:24:23 +00002023 llvm::Type *origType = value->getType();
John McCall31168b02011-06-15 23:02:42 +00002024
John McCall882987f2013-02-28 19:01:20 +00002025 llvm::Value *args[] = {
John McCall7f416cc2015-09-08 08:05:57 +00002026 CGF.Builder.CreateBitCast(addr.getPointer(), CGF.Int8PtrPtrTy),
John McCall882987f2013-02-28 19:01:20 +00002027 CGF.Builder.CreateBitCast(value, CGF.Int8PtrTy)
2028 };
2029 llvm::CallInst *result = CGF.EmitNounwindRuntimeCall(fn, args);
John McCall31168b02011-06-15 23:02:42 +00002030
Craig Topper8a13c412014-05-21 05:09:00 +00002031 if (ignored) return nullptr;
John McCall31168b02011-06-15 23:02:42 +00002032
2033 return CGF.Builder.CreateBitCast(result, origType);
2034}
2035
2036/// Perform an operation having the following signature:
2037/// void (i8**, i8**)
James Y Knight9871db02019-02-05 16:42:33 +00002038static void emitARCCopyOperation(CodeGenFunction &CGF, Address dst, Address src,
2039 llvm::Function *&fn,
Pete Cooper2cd35962018-12-18 20:33:00 +00002040 llvm::Intrinsic::ID IntID) {
John McCall7f416cc2015-09-08 08:05:57 +00002041 assert(dst.getType() == src.getType());
John McCall31168b02011-06-15 23:02:42 +00002042
2043 if (!fn) {
Pete Cooper2cd35962018-12-18 20:33:00 +00002044 fn = CGF.CGM.getIntrinsic(IntID);
2045 setARCRuntimeFunctionLinkage(CGF.CGM, fn);
John McCall31168b02011-06-15 23:02:42 +00002046 }
2047
John McCall882987f2013-02-28 19:01:20 +00002048 llvm::Value *args[] = {
John McCall7f416cc2015-09-08 08:05:57 +00002049 CGF.Builder.CreateBitCast(dst.getPointer(), CGF.Int8PtrPtrTy),
2050 CGF.Builder.CreateBitCast(src.getPointer(), CGF.Int8PtrPtrTy)
John McCall882987f2013-02-28 19:01:20 +00002051 };
2052 CGF.EmitNounwindRuntimeCall(fn, args);
John McCall31168b02011-06-15 23:02:42 +00002053}
2054
Pete Cooper2cd35962018-12-18 20:33:00 +00002055/// Perform an operation having the signature
2056/// i8* (i8*)
2057/// where a null input causes a no-op and returns null.
2058static llvm::Value *emitObjCValueOperation(CodeGenFunction &CGF,
2059 llvm::Value *value,
2060 llvm::Type *returnType,
James Y Knight9871db02019-02-05 16:42:33 +00002061 llvm::FunctionCallee &fn,
Erik Pilkingtonf6c645f2019-05-15 20:15:01 +00002062 StringRef fnName) {
Pete Cooper2cd35962018-12-18 20:33:00 +00002063 if (isa<llvm::ConstantPointerNull>(value))
2064 return value;
2065
2066 if (!fn) {
2067 llvm::FunctionType *fnType =
2068 llvm::FunctionType::get(CGF.Int8PtrTy, CGF.Int8PtrTy, false);
2069 fn = CGF.CGM.CreateRuntimeFunction(fnType, fnName);
Pete Coopere5b64ea2018-12-21 21:00:32 +00002070
2071 // We have Native ARC, so set nonlazybind attribute for performance
James Y Knight9871db02019-02-05 16:42:33 +00002072 if (llvm::Function *f = dyn_cast<llvm::Function>(fn.getCallee()))
Pete Coopere5b64ea2018-12-21 21:00:32 +00002073 if (fnName == "objc_retain")
2074 f->addFnAttr(llvm::Attribute::NonLazyBind);
Pete Cooper2cd35962018-12-18 20:33:00 +00002075 }
2076
2077 // Cast the argument to 'id'.
2078 llvm::Type *origType = returnType ? returnType : value->getType();
2079 value = CGF.Builder.CreateBitCast(value, CGF.Int8PtrTy);
2080
2081 // Call the function.
Erik Pilkingtonf6c645f2019-05-15 20:15:01 +00002082 llvm::CallBase *Inst = CGF.EmitCallOrInvoke(fn, value);
Pete Cooper2cd35962018-12-18 20:33:00 +00002083
2084 // Cast the result back to the original type.
Erik Pilkington1f7eda52019-01-30 23:17:38 +00002085 return CGF.Builder.CreateBitCast(Inst, origType);
Pete Cooper2cd35962018-12-18 20:33:00 +00002086}
2087
John McCall31168b02011-06-15 23:02:42 +00002088/// Produce the code to do a retain. Based on the type, calls one of:
James Dennett14c41ea2012-06-22 05:41:30 +00002089/// call i8* \@objc_retain(i8* %value)
2090/// call i8* \@objc_retainBlock(i8* %value)
John McCall31168b02011-06-15 23:02:42 +00002091llvm::Value *CodeGenFunction::EmitARCRetain(QualType type, llvm::Value *value) {
2092 if (type->isBlockPointerType())
John McCallff613032011-10-04 06:23:45 +00002093 return EmitARCRetainBlock(value, /*mandatory*/ false);
John McCall31168b02011-06-15 23:02:42 +00002094 else
2095 return EmitARCRetainNonBlock(value);
2096}
2097
2098/// Retain the given object, with normal retain semantics.
James Dennett14c41ea2012-06-22 05:41:30 +00002099/// call i8* \@objc_retain(i8* %value)
Pete Cooper94867712016-03-21 20:50:03 +00002100llvm::Value *CodeGenFunction::EmitARCRetainNonBlock(llvm::Value *value) {
Pete Coopere3886802018-12-08 05:13:50 +00002101 return emitARCValueOperation(*this, value, nullptr,
John McCallb04ecb72015-10-21 18:06:43 +00002102 CGM.getObjCEntrypoints().objc_retain,
Pete Cooper2cd35962018-12-18 20:33:00 +00002103 llvm::Intrinsic::objc_retain);
John McCall31168b02011-06-15 23:02:42 +00002104}
2105
2106/// Retain the given block, with _Block_copy semantics.
James Dennett14c41ea2012-06-22 05:41:30 +00002107/// call i8* \@objc_retainBlock(i8* %value)
John McCallff613032011-10-04 06:23:45 +00002108///
2109/// \param mandatory - If false, emit the call with metadata
2110/// indicating that it's okay for the optimizer to eliminate this call
2111/// if it can prove that the block never escapes except down the stack.
2112llvm::Value *CodeGenFunction::EmitARCRetainBlock(llvm::Value *value,
2113 bool mandatory) {
2114 llvm::Value *result
Pete Coopere3886802018-12-08 05:13:50 +00002115 = emitARCValueOperation(*this, value, nullptr,
John McCallb04ecb72015-10-21 18:06:43 +00002116 CGM.getObjCEntrypoints().objc_retainBlock,
Pete Cooper2cd35962018-12-18 20:33:00 +00002117 llvm::Intrinsic::objc_retainBlock);
John McCallff613032011-10-04 06:23:45 +00002118
2119 // If the copy isn't mandatory, add !clang.arc.copy_on_escape to
2120 // tell the optimizer that it doesn't need to do this copy if the
2121 // block doesn't escape, where being passed as an argument doesn't
2122 // count as escaping.
2123 if (!mandatory && isa<llvm::Instruction>(result)) {
2124 llvm::CallInst *call
2125 = cast<llvm::CallInst>(result->stripPointerCasts());
John McCallb04ecb72015-10-21 18:06:43 +00002126 assert(call->getCalledValue() == CGM.getObjCEntrypoints().objc_retainBlock);
John McCallff613032011-10-04 06:23:45 +00002127
John McCallff613032011-10-04 06:23:45 +00002128 call->setMetadata("clang.arc.copy_on_escape",
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002129 llvm::MDNode::get(Builder.getContext(), None));
John McCallff613032011-10-04 06:23:45 +00002130 }
2131
2132 return result;
John McCall31168b02011-06-15 23:02:42 +00002133}
2134
John McCalle399e5b2016-01-27 18:32:30 +00002135static void emitAutoreleasedReturnValueMarker(CodeGenFunction &CGF) {
John McCall31168b02011-06-15 23:02:42 +00002136 // Fetch the void(void) inline asm which marks that we're going to
John McCalle399e5b2016-01-27 18:32:30 +00002137 // do something with the autoreleased return value.
John McCall31168b02011-06-15 23:02:42 +00002138 llvm::InlineAsm *&marker
John McCalle399e5b2016-01-27 18:32:30 +00002139 = CGF.CGM.getObjCEntrypoints().retainAutoreleasedReturnValueMarker;
John McCall31168b02011-06-15 23:02:42 +00002140 if (!marker) {
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002141 StringRef assembly
John McCalle399e5b2016-01-27 18:32:30 +00002142 = CGF.CGM.getTargetCodeGenInfo()
John McCall31168b02011-06-15 23:02:42 +00002143 .getARCRetainAutoreleasedReturnValueMarker();
2144
2145 // If we have an empty assembly string, there's nothing to do.
2146 if (assembly.empty()) {
2147
2148 // Otherwise, at -O0, build an inline asm that we're going to call
2149 // in a moment.
John McCalle399e5b2016-01-27 18:32:30 +00002150 } else if (CGF.CGM.getCodeGenOpts().OptimizationLevel == 0) {
John McCall31168b02011-06-15 23:02:42 +00002151 llvm::FunctionType *type =
John McCalle399e5b2016-01-27 18:32:30 +00002152 llvm::FunctionType::get(CGF.VoidTy, /*variadic*/false);
Fangrui Song6907ce22018-07-30 19:24:48 +00002153
John McCall31168b02011-06-15 23:02:42 +00002154 marker = llvm::InlineAsm::get(type, assembly, "", /*sideeffects*/ true);
2155
2156 // If we're at -O1 and above, we don't want to litter the code
2157 // with this marker yet, so leave a breadcrumb for the ARC
2158 // optimizer to pick up.
2159 } else {
Akira Hatanaka60c3a3b2019-04-10 06:20:23 +00002160 const char *markerKey = "clang.arc.retainAutoreleasedReturnValueMarker";
2161 if (!CGF.CGM.getModule().getModuleFlag(markerKey)) {
2162 auto *str = llvm::MDString::get(CGF.getLLVMContext(), assembly);
2163 CGF.CGM.getModule().addModuleFlag(llvm::Module::Error, markerKey, str);
John McCall31168b02011-06-15 23:02:42 +00002164 }
2165 }
2166 }
2167
2168 // Call the marker asm if we made one, which we do only at -O0.
David Blaikie43f9bb72015-05-18 22:14:03 +00002169 if (marker)
Shoaib Meenaif6985692018-03-19 19:34:39 +00002170 CGF.Builder.CreateCall(marker, None, CGF.getBundlesForFunclet(marker));
John McCalle399e5b2016-01-27 18:32:30 +00002171}
John McCall31168b02011-06-15 23:02:42 +00002172
John McCalle399e5b2016-01-27 18:32:30 +00002173/// Retain the given object which is the result of a function call.
2174/// call i8* \@objc_retainAutoreleasedReturnValue(i8* %value)
2175///
2176/// Yes, this function name is one character away from a different
2177/// call with completely different semantics.
2178llvm::Value *
2179CodeGenFunction::EmitARCRetainAutoreleasedReturnValue(llvm::Value *value) {
2180 emitAutoreleasedReturnValueMarker(*this);
Akira Hatanaka65bb3f92019-03-21 19:59:49 +00002181 llvm::CallInst::TailCallKind tailKind =
2182 CGM.getTargetCodeGenInfo()
2183 .shouldSuppressTailCallsOfRetainAutoreleasedReturnValue()
2184 ? llvm::CallInst::TCK_NoTail
2185 : llvm::CallInst::TCK_None;
2186 return emitARCValueOperation(
2187 *this, value, nullptr,
2188 CGM.getObjCEntrypoints().objc_retainAutoreleasedReturnValue,
2189 llvm::Intrinsic::objc_retainAutoreleasedReturnValue, tailKind);
John McCall31168b02011-06-15 23:02:42 +00002190}
2191
John McCalle399e5b2016-01-27 18:32:30 +00002192/// Claim a possibly-autoreleased return value at +0. This is only
2193/// valid to do in contexts which do not rely on the retain to keep
Hiroshi Inoueef04f642018-01-26 08:15:52 +00002194/// the object valid for all of its uses; for example, when
John McCalle399e5b2016-01-27 18:32:30 +00002195/// the value is ignored, or when it is being assigned to an
2196/// __unsafe_unretained variable.
2197///
2198/// call i8* \@objc_unsafeClaimAutoreleasedReturnValue(i8* %value)
2199llvm::Value *
2200CodeGenFunction::EmitARCUnsafeClaimAutoreleasedReturnValue(llvm::Value *value) {
2201 emitAutoreleasedReturnValueMarker(*this);
Pete Coopere3886802018-12-08 05:13:50 +00002202 return emitARCValueOperation(*this, value, nullptr,
John McCalle399e5b2016-01-27 18:32:30 +00002203 CGM.getObjCEntrypoints().objc_unsafeClaimAutoreleasedReturnValue,
Pete Cooper2cd35962018-12-18 20:33:00 +00002204 llvm::Intrinsic::objc_unsafeClaimAutoreleasedReturnValue);
John McCalle399e5b2016-01-27 18:32:30 +00002205}
2206
John McCall31168b02011-06-15 23:02:42 +00002207/// Release the given object.
James Dennett14c41ea2012-06-22 05:41:30 +00002208/// call void \@objc_release(i8* %value)
John McCallcdda29c2013-03-13 03:10:54 +00002209void CodeGenFunction::EmitARCRelease(llvm::Value *value,
2210 ARCPreciseLifetime_t precise) {
John McCall31168b02011-06-15 23:02:42 +00002211 if (isa<llvm::ConstantPointerNull>(value)) return;
2212
James Y Knight9871db02019-02-05 16:42:33 +00002213 llvm::Function *&fn = CGM.getObjCEntrypoints().objc_release;
John McCall31168b02011-06-15 23:02:42 +00002214 if (!fn) {
Pete Cooper2cd35962018-12-18 20:33:00 +00002215 fn = CGM.getIntrinsic(llvm::Intrinsic::objc_release);
2216 setARCRuntimeFunctionLinkage(CGM, fn);
John McCall31168b02011-06-15 23:02:42 +00002217 }
2218
2219 // Cast the argument to 'id'.
2220 value = Builder.CreateBitCast(value, Int8PtrTy);
2221
2222 // Call objc_release.
John McCall882987f2013-02-28 19:01:20 +00002223 llvm::CallInst *call = EmitNounwindRuntimeCall(fn, value);
John McCall31168b02011-06-15 23:02:42 +00002224
John McCallcdda29c2013-03-13 03:10:54 +00002225 if (precise == ARCImpreciseLifetime) {
John McCall31168b02011-06-15 23:02:42 +00002226 call->setMetadata("clang.imprecise_release",
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002227 llvm::MDNode::get(Builder.getContext(), None));
John McCall31168b02011-06-15 23:02:42 +00002228 }
2229}
2230
John McCalle68b8f42012-10-17 02:28:37 +00002231/// Destroy a __strong variable.
2232///
2233/// At -O0, emit a call to store 'null' into the address;
2234/// instrumenting tools prefer this because the address is exposed,
2235/// but it's relatively cumbersome to optimize.
2236///
2237/// At -O1 and above, just load and call objc_release.
2238///
2239/// call void \@objc_storeStrong(i8** %addr, i8* null)
John McCall7f416cc2015-09-08 08:05:57 +00002240void CodeGenFunction::EmitARCDestroyStrong(Address addr,
John McCallcdda29c2013-03-13 03:10:54 +00002241 ARCPreciseLifetime_t precise) {
John McCalle68b8f42012-10-17 02:28:37 +00002242 if (CGM.getCodeGenOpts().OptimizationLevel == 0) {
John McCall7f416cc2015-09-08 08:05:57 +00002243 llvm::Value *null = getNullForVariable(addr);
John McCalle68b8f42012-10-17 02:28:37 +00002244 EmitARCStoreStrongCall(addr, null, /*ignored*/ true);
2245 return;
2246 }
2247
2248 llvm::Value *value = Builder.CreateLoad(addr);
2249 EmitARCRelease(value, precise);
2250}
2251
John McCall31168b02011-06-15 23:02:42 +00002252/// Store into a strong object. Always calls this:
James Dennett14c41ea2012-06-22 05:41:30 +00002253/// call void \@objc_storeStrong(i8** %addr, i8* %value)
John McCall7f416cc2015-09-08 08:05:57 +00002254llvm::Value *CodeGenFunction::EmitARCStoreStrongCall(Address addr,
John McCall31168b02011-06-15 23:02:42 +00002255 llvm::Value *value,
2256 bool ignored) {
John McCall7f416cc2015-09-08 08:05:57 +00002257 assert(addr.getElementType() == value->getType());
John McCall31168b02011-06-15 23:02:42 +00002258
James Y Knight9871db02019-02-05 16:42:33 +00002259 llvm::Function *&fn = CGM.getObjCEntrypoints().objc_storeStrong;
John McCall31168b02011-06-15 23:02:42 +00002260 if (!fn) {
Pete Cooper2cd35962018-12-18 20:33:00 +00002261 fn = CGM.getIntrinsic(llvm::Intrinsic::objc_storeStrong);
2262 setARCRuntimeFunctionLinkage(CGM, fn);
John McCall31168b02011-06-15 23:02:42 +00002263 }
2264
John McCall882987f2013-02-28 19:01:20 +00002265 llvm::Value *args[] = {
John McCall7f416cc2015-09-08 08:05:57 +00002266 Builder.CreateBitCast(addr.getPointer(), Int8PtrPtrTy),
John McCall882987f2013-02-28 19:01:20 +00002267 Builder.CreateBitCast(value, Int8PtrTy)
2268 };
2269 EmitNounwindRuntimeCall(fn, args);
John McCall31168b02011-06-15 23:02:42 +00002270
Craig Topper8a13c412014-05-21 05:09:00 +00002271 if (ignored) return nullptr;
John McCall31168b02011-06-15 23:02:42 +00002272 return value;
2273}
2274
2275/// Store into a strong object. Sometimes calls this:
James Dennett14c41ea2012-06-22 05:41:30 +00002276/// call void \@objc_storeStrong(i8** %addr, i8* %value)
John McCall31168b02011-06-15 23:02:42 +00002277/// Other times, breaks it down into components.
John McCall55e1fbc2011-06-25 02:11:03 +00002278llvm::Value *CodeGenFunction::EmitARCStoreStrong(LValue dst,
John McCall31168b02011-06-15 23:02:42 +00002279 llvm::Value *newValue,
2280 bool ignored) {
John McCall55e1fbc2011-06-25 02:11:03 +00002281 QualType type = dst.getType();
John McCall31168b02011-06-15 23:02:42 +00002282 bool isBlock = type->isBlockPointerType();
2283
2284 // Use a store barrier at -O0 unless this is a block type or the
2285 // lvalue is inadequately aligned.
2286 if (shouldUseFusedARCCalls() &&
2287 !isBlock &&
Eli Friedmana0544d62011-12-03 04:14:32 +00002288 (dst.getAlignment().isZero() ||
2289 dst.getAlignment() >= CharUnits::fromQuantity(PointerAlignInBytes))) {
John McCall31168b02011-06-15 23:02:42 +00002290 return EmitARCStoreStrongCall(dst.getAddress(), newValue, ignored);
2291 }
2292
2293 // Otherwise, split it out.
2294
2295 // Retain the new value.
2296 newValue = EmitARCRetain(type, newValue);
2297
2298 // Read the old value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002299 llvm::Value *oldValue = EmitLoadOfScalar(dst, SourceLocation());
John McCall31168b02011-06-15 23:02:42 +00002300
2301 // Store. We do this before the release so that any deallocs won't
2302 // see the old value.
John McCall55e1fbc2011-06-25 02:11:03 +00002303 EmitStoreOfScalar(newValue, dst);
John McCall31168b02011-06-15 23:02:42 +00002304
2305 // Finally, release the old value.
John McCallcdda29c2013-03-13 03:10:54 +00002306 EmitARCRelease(oldValue, dst.isARCPreciseLifetime());
John McCall31168b02011-06-15 23:02:42 +00002307
2308 return newValue;
2309}
2310
2311/// Autorelease the given object.
James Dennett14c41ea2012-06-22 05:41:30 +00002312/// call i8* \@objc_autorelease(i8* %value)
Pete Cooper94867712016-03-21 20:50:03 +00002313llvm::Value *CodeGenFunction::EmitARCAutorelease(llvm::Value *value) {
Pete Coopere3886802018-12-08 05:13:50 +00002314 return emitARCValueOperation(*this, value, nullptr,
John McCallb04ecb72015-10-21 18:06:43 +00002315 CGM.getObjCEntrypoints().objc_autorelease,
Pete Cooper2cd35962018-12-18 20:33:00 +00002316 llvm::Intrinsic::objc_autorelease);
John McCall31168b02011-06-15 23:02:42 +00002317}
2318
2319/// Autorelease the given object.
James Dennett14c41ea2012-06-22 05:41:30 +00002320/// call i8* \@objc_autoreleaseReturnValue(i8* %value)
John McCall31168b02011-06-15 23:02:42 +00002321llvm::Value *
2322CodeGenFunction::EmitARCAutoreleaseReturnValue(llvm::Value *value) {
Pete Coopere3886802018-12-08 05:13:50 +00002323 return emitARCValueOperation(*this, value, nullptr,
John McCallb04ecb72015-10-21 18:06:43 +00002324 CGM.getObjCEntrypoints().objc_autoreleaseReturnValue,
Pete Cooper2cd35962018-12-18 20:33:00 +00002325 llvm::Intrinsic::objc_autoreleaseReturnValue,
Akira Hatanaka65bb3f92019-03-21 19:59:49 +00002326 llvm::CallInst::TCK_Tail);
John McCall31168b02011-06-15 23:02:42 +00002327}
2328
2329/// Do a fused retain/autorelease of the given object.
James Dennett14c41ea2012-06-22 05:41:30 +00002330/// call i8* \@objc_retainAutoreleaseReturnValue(i8* %value)
John McCall31168b02011-06-15 23:02:42 +00002331llvm::Value *
2332CodeGenFunction::EmitARCRetainAutoreleaseReturnValue(llvm::Value *value) {
Pete Coopere3886802018-12-08 05:13:50 +00002333 return emitARCValueOperation(*this, value, nullptr,
John McCallb04ecb72015-10-21 18:06:43 +00002334 CGM.getObjCEntrypoints().objc_retainAutoreleaseReturnValue,
Pete Cooper2cd35962018-12-18 20:33:00 +00002335 llvm::Intrinsic::objc_retainAutoreleaseReturnValue,
Akira Hatanaka65bb3f92019-03-21 19:59:49 +00002336 llvm::CallInst::TCK_Tail);
John McCall31168b02011-06-15 23:02:42 +00002337}
2338
2339/// Do a fused retain/autorelease of the given object.
James Dennett14c41ea2012-06-22 05:41:30 +00002340/// call i8* \@objc_retainAutorelease(i8* %value)
John McCall31168b02011-06-15 23:02:42 +00002341/// or
James Dennett14c41ea2012-06-22 05:41:30 +00002342/// %retain = call i8* \@objc_retainBlock(i8* %value)
2343/// call i8* \@objc_autorelease(i8* %retain)
John McCall31168b02011-06-15 23:02:42 +00002344llvm::Value *CodeGenFunction::EmitARCRetainAutorelease(QualType type,
2345 llvm::Value *value) {
2346 if (!type->isBlockPointerType())
2347 return EmitARCRetainAutoreleaseNonBlock(value);
2348
2349 if (isa<llvm::ConstantPointerNull>(value)) return value;
2350
Chris Lattner2192fe52011-07-18 04:24:23 +00002351 llvm::Type *origType = value->getType();
John McCall31168b02011-06-15 23:02:42 +00002352 value = Builder.CreateBitCast(value, Int8PtrTy);
John McCallff613032011-10-04 06:23:45 +00002353 value = EmitARCRetainBlock(value, /*mandatory*/ true);
John McCall31168b02011-06-15 23:02:42 +00002354 value = EmitARCAutorelease(value);
2355 return Builder.CreateBitCast(value, origType);
2356}
2357
2358/// Do a fused retain/autorelease of the given object.
James Dennett14c41ea2012-06-22 05:41:30 +00002359/// call i8* \@objc_retainAutorelease(i8* %value)
John McCall31168b02011-06-15 23:02:42 +00002360llvm::Value *
2361CodeGenFunction::EmitARCRetainAutoreleaseNonBlock(llvm::Value *value) {
Pete Coopere3886802018-12-08 05:13:50 +00002362 return emitARCValueOperation(*this, value, nullptr,
John McCallb04ecb72015-10-21 18:06:43 +00002363 CGM.getObjCEntrypoints().objc_retainAutorelease,
Pete Cooper2cd35962018-12-18 20:33:00 +00002364 llvm::Intrinsic::objc_retainAutorelease);
John McCall31168b02011-06-15 23:02:42 +00002365}
2366
John McCallb04ecb72015-10-21 18:06:43 +00002367/// i8* \@objc_loadWeak(i8** %addr)
2368/// Essentially objc_autorelease(objc_loadWeakRetained(addr)).
2369llvm::Value *CodeGenFunction::EmitARCLoadWeak(Address addr) {
2370 return emitARCLoadOperation(*this, addr,
2371 CGM.getObjCEntrypoints().objc_loadWeak,
Pete Cooper2cd35962018-12-18 20:33:00 +00002372 llvm::Intrinsic::objc_loadWeak);
John McCallb04ecb72015-10-21 18:06:43 +00002373}
2374
James Dennett14c41ea2012-06-22 05:41:30 +00002375/// i8* \@objc_loadWeakRetained(i8** %addr)
John McCall7f416cc2015-09-08 08:05:57 +00002376llvm::Value *CodeGenFunction::EmitARCLoadWeakRetained(Address addr) {
John McCall31168b02011-06-15 23:02:42 +00002377 return emitARCLoadOperation(*this, addr,
John McCallb04ecb72015-10-21 18:06:43 +00002378 CGM.getObjCEntrypoints().objc_loadWeakRetained,
Pete Cooper2cd35962018-12-18 20:33:00 +00002379 llvm::Intrinsic::objc_loadWeakRetained);
John McCall31168b02011-06-15 23:02:42 +00002380}
2381
James Dennett14c41ea2012-06-22 05:41:30 +00002382/// i8* \@objc_storeWeak(i8** %addr, i8* %value)
John McCall31168b02011-06-15 23:02:42 +00002383/// Returns %value.
John McCall7f416cc2015-09-08 08:05:57 +00002384llvm::Value *CodeGenFunction::EmitARCStoreWeak(Address addr,
John McCall31168b02011-06-15 23:02:42 +00002385 llvm::Value *value,
2386 bool ignored) {
2387 return emitARCStoreOperation(*this, addr, value,
John McCallb04ecb72015-10-21 18:06:43 +00002388 CGM.getObjCEntrypoints().objc_storeWeak,
Pete Cooper2cd35962018-12-18 20:33:00 +00002389 llvm::Intrinsic::objc_storeWeak, ignored);
John McCall31168b02011-06-15 23:02:42 +00002390}
2391
James Dennett14c41ea2012-06-22 05:41:30 +00002392/// i8* \@objc_initWeak(i8** %addr, i8* %value)
John McCall31168b02011-06-15 23:02:42 +00002393/// Returns %value. %addr is known to not have a current weak entry.
2394/// Essentially equivalent to:
2395/// *addr = nil; objc_storeWeak(addr, value);
John McCall7f416cc2015-09-08 08:05:57 +00002396void CodeGenFunction::EmitARCInitWeak(Address addr, llvm::Value *value) {
John McCall31168b02011-06-15 23:02:42 +00002397 // If we're initializing to null, just write null to memory; no need
2398 // to get the runtime involved. But don't do this if optimization
2399 // is enabled, because accounting for this would make the optimizer
2400 // much more complicated.
2401 if (isa<llvm::ConstantPointerNull>(value) &&
2402 CGM.getCodeGenOpts().OptimizationLevel == 0) {
2403 Builder.CreateStore(value, addr);
2404 return;
2405 }
2406
2407 emitARCStoreOperation(*this, addr, value,
John McCallb04ecb72015-10-21 18:06:43 +00002408 CGM.getObjCEntrypoints().objc_initWeak,
Pete Cooper2cd35962018-12-18 20:33:00 +00002409 llvm::Intrinsic::objc_initWeak, /*ignored*/ true);
John McCall31168b02011-06-15 23:02:42 +00002410}
2411
James Dennett14c41ea2012-06-22 05:41:30 +00002412/// void \@objc_destroyWeak(i8** %addr)
John McCall31168b02011-06-15 23:02:42 +00002413/// Essentially objc_storeWeak(addr, nil).
John McCall7f416cc2015-09-08 08:05:57 +00002414void CodeGenFunction::EmitARCDestroyWeak(Address addr) {
James Y Knight9871db02019-02-05 16:42:33 +00002415 llvm::Function *&fn = CGM.getObjCEntrypoints().objc_destroyWeak;
John McCall31168b02011-06-15 23:02:42 +00002416 if (!fn) {
Pete Cooper2cd35962018-12-18 20:33:00 +00002417 fn = CGM.getIntrinsic(llvm::Intrinsic::objc_destroyWeak);
2418 setARCRuntimeFunctionLinkage(CGM, fn);
John McCall31168b02011-06-15 23:02:42 +00002419 }
2420
2421 // Cast the argument to 'id*'.
2422 addr = Builder.CreateBitCast(addr, Int8PtrPtrTy);
2423
John McCall7f416cc2015-09-08 08:05:57 +00002424 EmitNounwindRuntimeCall(fn, addr.getPointer());
John McCall31168b02011-06-15 23:02:42 +00002425}
2426
James Dennett14c41ea2012-06-22 05:41:30 +00002427/// void \@objc_moveWeak(i8** %dest, i8** %src)
John McCall31168b02011-06-15 23:02:42 +00002428/// Disregards the current value in %dest. Leaves %src pointing to nothing.
2429/// Essentially (objc_copyWeak(dest, src), objc_destroyWeak(src)).
John McCall7f416cc2015-09-08 08:05:57 +00002430void CodeGenFunction::EmitARCMoveWeak(Address dst, Address src) {
John McCall31168b02011-06-15 23:02:42 +00002431 emitARCCopyOperation(*this, dst, src,
John McCallb04ecb72015-10-21 18:06:43 +00002432 CGM.getObjCEntrypoints().objc_moveWeak,
Pete Cooper2cd35962018-12-18 20:33:00 +00002433 llvm::Intrinsic::objc_moveWeak);
John McCall31168b02011-06-15 23:02:42 +00002434}
2435
James Dennett14c41ea2012-06-22 05:41:30 +00002436/// void \@objc_copyWeak(i8** %dest, i8** %src)
John McCall31168b02011-06-15 23:02:42 +00002437/// Disregards the current value in %dest. Essentially
2438/// objc_release(objc_initWeak(dest, objc_readWeakRetained(src)))
John McCall7f416cc2015-09-08 08:05:57 +00002439void CodeGenFunction::EmitARCCopyWeak(Address dst, Address src) {
John McCall31168b02011-06-15 23:02:42 +00002440 emitARCCopyOperation(*this, dst, src,
John McCallb04ecb72015-10-21 18:06:43 +00002441 CGM.getObjCEntrypoints().objc_copyWeak,
Pete Cooper2cd35962018-12-18 20:33:00 +00002442 llvm::Intrinsic::objc_copyWeak);
John McCall31168b02011-06-15 23:02:42 +00002443}
2444
Akira Hatanakad791e922018-03-19 17:38:40 +00002445void CodeGenFunction::emitARCCopyAssignWeak(QualType Ty, Address DstAddr,
2446 Address SrcAddr) {
2447 llvm::Value *Object = EmitARCLoadWeakRetained(SrcAddr);
2448 Object = EmitObjCConsumeObject(Ty, Object);
2449 EmitARCStoreWeak(DstAddr, Object, false);
2450}
2451
2452void CodeGenFunction::emitARCMoveAssignWeak(QualType Ty, Address DstAddr,
2453 Address SrcAddr) {
2454 llvm::Value *Object = EmitARCLoadWeakRetained(SrcAddr);
2455 Object = EmitObjCConsumeObject(Ty, Object);
2456 EmitARCStoreWeak(DstAddr, Object, false);
2457 EmitARCDestroyWeak(SrcAddr);
2458}
2459
John McCall31168b02011-06-15 23:02:42 +00002460/// Produce the code to do a objc_autoreleasepool_push.
James Dennett14c41ea2012-06-22 05:41:30 +00002461/// call i8* \@objc_autoreleasePoolPush(void)
John McCall31168b02011-06-15 23:02:42 +00002462llvm::Value *CodeGenFunction::EmitObjCAutoreleasePoolPush() {
James Y Knight9871db02019-02-05 16:42:33 +00002463 llvm::Function *&fn = CGM.getObjCEntrypoints().objc_autoreleasePoolPush;
John McCall31168b02011-06-15 23:02:42 +00002464 if (!fn) {
Pete Cooper2cd35962018-12-18 20:33:00 +00002465 fn = CGM.getIntrinsic(llvm::Intrinsic::objc_autoreleasePoolPush);
2466 setARCRuntimeFunctionLinkage(CGM, fn);
John McCall31168b02011-06-15 23:02:42 +00002467 }
2468
John McCall882987f2013-02-28 19:01:20 +00002469 return EmitNounwindRuntimeCall(fn);
John McCall31168b02011-06-15 23:02:42 +00002470}
2471
2472/// Produce the code to do a primitive release.
James Dennett14c41ea2012-06-22 05:41:30 +00002473/// call void \@objc_autoreleasePoolPop(i8* %ptr)
John McCall31168b02011-06-15 23:02:42 +00002474void CodeGenFunction::EmitObjCAutoreleasePoolPop(llvm::Value *value) {
2475 assert(value->getType() == Int8PtrTy);
2476
Pete Cooper2cd35962018-12-18 20:33:00 +00002477 if (getInvokeDest()) {
2478 // Call the runtime method not the intrinsic if we are handling exceptions
James Y Knight9871db02019-02-05 16:42:33 +00002479 llvm::FunctionCallee &fn =
2480 CGM.getObjCEntrypoints().objc_autoreleasePoolPopInvoke;
Pete Cooper2cd35962018-12-18 20:33:00 +00002481 if (!fn) {
2482 llvm::FunctionType *fnType =
2483 llvm::FunctionType::get(Builder.getVoidTy(), Int8PtrTy, false);
2484 fn = CGM.CreateRuntimeFunction(fnType, "objc_autoreleasePoolPop");
2485 setARCRuntimeFunctionLinkage(CGM, fn);
2486 }
John McCall31168b02011-06-15 23:02:42 +00002487
Pete Cooper2cd35962018-12-18 20:33:00 +00002488 // objc_autoreleasePoolPop can throw.
2489 EmitRuntimeCallOrInvoke(fn, value);
2490 } else {
James Y Knight9871db02019-02-05 16:42:33 +00002491 llvm::FunctionCallee &fn = CGM.getObjCEntrypoints().objc_autoreleasePoolPop;
Pete Cooper2cd35962018-12-18 20:33:00 +00002492 if (!fn) {
2493 fn = CGM.getIntrinsic(llvm::Intrinsic::objc_autoreleasePoolPop);
2494 setARCRuntimeFunctionLinkage(CGM, fn);
2495 }
2496
2497 EmitRuntimeCall(fn, value);
John McCall31168b02011-06-15 23:02:42 +00002498 }
John McCall31168b02011-06-15 23:02:42 +00002499}
2500
2501/// Produce the code to do an MRR version objc_autoreleasepool_push.
2502/// Which is: [[NSAutoreleasePool alloc] init];
2503/// Where alloc is declared as: + (id) alloc; in NSAutoreleasePool class.
2504/// init is declared as: - (id) init; in its NSObject super class.
2505///
2506llvm::Value *CodeGenFunction::EmitObjCMRRAutoreleasePoolPush() {
2507 CGObjCRuntime &Runtime = CGM.getObjCRuntime();
John McCall882987f2013-02-28 19:01:20 +00002508 llvm::Value *Receiver = Runtime.EmitNSAutoreleasePoolClassRef(*this);
John McCall31168b02011-06-15 23:02:42 +00002509 // [NSAutoreleasePool alloc]
2510 IdentifierInfo *II = &CGM.getContext().Idents.get("alloc");
2511 Selector AllocSel = getContext().Selectors.getSelector(0, &II);
2512 CallArgList Args;
Fangrui Song6907ce22018-07-30 19:24:48 +00002513 RValue AllocRV =
2514 Runtime.GenerateMessageSend(*this, ReturnValueSlot(),
John McCall31168b02011-06-15 23:02:42 +00002515 getContext().getObjCIdType(),
Fangrui Song6907ce22018-07-30 19:24:48 +00002516 AllocSel, Receiver, Args);
John McCall31168b02011-06-15 23:02:42 +00002517
2518 // [Receiver init]
2519 Receiver = AllocRV.getScalarVal();
2520 II = &CGM.getContext().Idents.get("init");
2521 Selector InitSel = getContext().Selectors.getSelector(0, &II);
2522 RValue InitRV =
2523 Runtime.GenerateMessageSend(*this, ReturnValueSlot(),
2524 getContext().getObjCIdType(),
Fangrui Song6907ce22018-07-30 19:24:48 +00002525 InitSel, Receiver, Args);
John McCall31168b02011-06-15 23:02:42 +00002526 return InitRV.getScalarVal();
2527}
2528
Pete Coopere3886802018-12-08 05:13:50 +00002529/// Allocate the given objc object.
2530/// call i8* \@objc_alloc(i8* %value)
2531llvm::Value *CodeGenFunction::EmitObjCAlloc(llvm::Value *value,
2532 llvm::Type *resultType) {
Pete Cooper2cd35962018-12-18 20:33:00 +00002533 return emitObjCValueOperation(*this, value, resultType,
2534 CGM.getObjCEntrypoints().objc_alloc,
Erik Pilkingtonf6c645f2019-05-15 20:15:01 +00002535 "objc_alloc");
Pete Coopere3886802018-12-08 05:13:50 +00002536}
2537
2538/// Allocate the given objc object.
2539/// call i8* \@objc_allocWithZone(i8* %value)
2540llvm::Value *CodeGenFunction::EmitObjCAllocWithZone(llvm::Value *value,
2541 llvm::Type *resultType) {
Pete Cooper2cd35962018-12-18 20:33:00 +00002542 return emitObjCValueOperation(*this, value, resultType,
2543 CGM.getObjCEntrypoints().objc_allocWithZone,
Erik Pilkingtonf6c645f2019-05-15 20:15:01 +00002544 "objc_allocWithZone");
Pete Coopere3886802018-12-08 05:13:50 +00002545}
2546
Erik Pilkingtonec389b02019-02-14 19:58:37 +00002547llvm::Value *CodeGenFunction::EmitObjCAllocInit(llvm::Value *value,
2548 llvm::Type *resultType) {
2549 return emitObjCValueOperation(*this, value, resultType,
2550 CGM.getObjCEntrypoints().objc_alloc_init,
Erik Pilkingtonf6c645f2019-05-15 20:15:01 +00002551 "objc_alloc_init");
Erik Pilkingtonec389b02019-02-14 19:58:37 +00002552}
2553
John McCall31168b02011-06-15 23:02:42 +00002554/// Produce the code to do a primitive release.
2555/// [tmp drain];
2556void CodeGenFunction::EmitObjCMRRAutoreleasePoolPop(llvm::Value *Arg) {
2557 IdentifierInfo *II = &CGM.getContext().Idents.get("drain");
2558 Selector DrainSel = getContext().Selectors.getSelector(0, &II);
2559 CallArgList Args;
2560 CGM.getObjCRuntime().GenerateMessageSend(*this, ReturnValueSlot(),
Fangrui Song6907ce22018-07-30 19:24:48 +00002561 getContext().VoidTy, DrainSel, Arg, Args);
John McCall31168b02011-06-15 23:02:42 +00002562}
2563
John McCall82fe67b2011-07-09 01:37:26 +00002564void CodeGenFunction::destroyARCStrongPrecise(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00002565 Address addr,
John McCall82fe67b2011-07-09 01:37:26 +00002566 QualType type) {
John McCallcdda29c2013-03-13 03:10:54 +00002567 CGF.EmitARCDestroyStrong(addr, ARCPreciseLifetime);
John McCall82fe67b2011-07-09 01:37:26 +00002568}
2569
2570void CodeGenFunction::destroyARCStrongImprecise(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00002571 Address addr,
John McCall82fe67b2011-07-09 01:37:26 +00002572 QualType type) {
John McCallcdda29c2013-03-13 03:10:54 +00002573 CGF.EmitARCDestroyStrong(addr, ARCImpreciseLifetime);
John McCall82fe67b2011-07-09 01:37:26 +00002574}
2575
2576void CodeGenFunction::destroyARCWeak(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00002577 Address addr,
John McCall82fe67b2011-07-09 01:37:26 +00002578 QualType type) {
2579 CGF.EmitARCDestroyWeak(addr);
2580}
2581
Akira Hatanakaa6b6dcc2017-04-28 18:50:57 +00002582void CodeGenFunction::emitARCIntrinsicUse(CodeGenFunction &CGF, Address addr,
2583 QualType type) {
2584 llvm::Value *value = CGF.Builder.CreateLoad(addr);
2585 CGF.EmitARCIntrinsicUse(value);
2586}
2587
Pete Coopere5b64ea2018-12-21 21:00:32 +00002588/// Autorelease the given object.
2589/// call i8* \@objc_autorelease(i8* %value)
2590llvm::Value *CodeGenFunction::EmitObjCAutorelease(llvm::Value *value,
2591 llvm::Type *returnType) {
Erik Pilkington1f7eda52019-01-30 23:17:38 +00002592 return emitObjCValueOperation(
2593 *this, value, returnType,
2594 CGM.getObjCEntrypoints().objc_autoreleaseRuntimeFunction,
Erik Pilkingtonf6c645f2019-05-15 20:15:01 +00002595 "objc_autorelease");
Pete Coopere5b64ea2018-12-21 21:00:32 +00002596}
2597
2598/// Retain the given object, with normal retain semantics.
2599/// call i8* \@objc_retain(i8* %value)
2600llvm::Value *CodeGenFunction::EmitObjCRetainNonBlock(llvm::Value *value,
2601 llvm::Type *returnType) {
Erik Pilkington1f7eda52019-01-30 23:17:38 +00002602 return emitObjCValueOperation(
2603 *this, value, returnType,
Erik Pilkingtonf6c645f2019-05-15 20:15:01 +00002604 CGM.getObjCEntrypoints().objc_retainRuntimeFunction, "objc_retain");
Pete Coopere5b64ea2018-12-21 21:00:32 +00002605}
2606
2607/// Release the given object.
2608/// call void \@objc_release(i8* %value)
2609void CodeGenFunction::EmitObjCRelease(llvm::Value *value,
2610 ARCPreciseLifetime_t precise) {
2611 if (isa<llvm::ConstantPointerNull>(value)) return;
2612
James Y Knight9871db02019-02-05 16:42:33 +00002613 llvm::FunctionCallee &fn =
2614 CGM.getObjCEntrypoints().objc_releaseRuntimeFunction;
Pete Coopere5b64ea2018-12-21 21:00:32 +00002615 if (!fn) {
James Y Knight9871db02019-02-05 16:42:33 +00002616 llvm::FunctionType *fnType =
Pete Coopere5b64ea2018-12-21 21:00:32 +00002617 llvm::FunctionType::get(Builder.getVoidTy(), Int8PtrTy, false);
James Y Knight9871db02019-02-05 16:42:33 +00002618 fn = CGM.CreateRuntimeFunction(fnType, "objc_release");
2619 setARCRuntimeFunctionLinkage(CGM, fn);
2620 // We have Native ARC, so set nonlazybind attribute for performance
2621 if (llvm::Function *f = dyn_cast<llvm::Function>(fn.getCallee()))
2622 f->addFnAttr(llvm::Attribute::NonLazyBind);
Pete Coopere5b64ea2018-12-21 21:00:32 +00002623 }
2624
2625 // Cast the argument to 'id'.
2626 value = Builder.CreateBitCast(value, Int8PtrTy);
2627
2628 // Call objc_release.
Akira Hatanaka34d28cf2019-05-10 21:54:16 +00002629 llvm::CallBase *call = EmitCallOrInvoke(fn, value);
Pete Coopere5b64ea2018-12-21 21:00:32 +00002630
2631 if (precise == ARCImpreciseLifetime) {
2632 call->setMetadata("clang.imprecise_release",
2633 llvm::MDNode::get(Builder.getContext(), None));
2634 }
2635}
2636
John McCall31168b02011-06-15 23:02:42 +00002637namespace {
David Blaikie7e70d682015-08-18 22:40:54 +00002638 struct CallObjCAutoreleasePoolObject final : EHScopeStack::Cleanup {
John McCall31168b02011-06-15 23:02:42 +00002639 llvm::Value *Token;
2640
2641 CallObjCAutoreleasePoolObject(llvm::Value *token) : Token(token) {}
2642
Craig Topper4f12f102014-03-12 06:41:41 +00002643 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall31168b02011-06-15 23:02:42 +00002644 CGF.EmitObjCAutoreleasePoolPop(Token);
2645 }
2646 };
David Blaikie7e70d682015-08-18 22:40:54 +00002647 struct CallObjCMRRAutoreleasePoolObject final : EHScopeStack::Cleanup {
John McCall31168b02011-06-15 23:02:42 +00002648 llvm::Value *Token;
2649
2650 CallObjCMRRAutoreleasePoolObject(llvm::Value *token) : Token(token) {}
2651
Craig Topper4f12f102014-03-12 06:41:41 +00002652 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall31168b02011-06-15 23:02:42 +00002653 CGF.EmitObjCMRRAutoreleasePoolPop(Token);
2654 }
2655 };
Alexander Kornienkoab9db512015-06-22 23:07:51 +00002656}
John McCall31168b02011-06-15 23:02:42 +00002657
2658void CodeGenFunction::EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr) {
David Blaikiebbafb8a2012-03-11 07:00:24 +00002659 if (CGM.getLangOpts().ObjCAutoRefCount)
John McCall31168b02011-06-15 23:02:42 +00002660 EHStack.pushCleanup<CallObjCAutoreleasePoolObject>(NormalCleanup, Ptr);
2661 else
2662 EHStack.pushCleanup<CallObjCMRRAutoreleasePoolObject>(NormalCleanup, Ptr);
2663}
2664
Volodymyr Sapsai8b286f92018-11-01 22:50:08 +00002665static bool shouldRetainObjCLifetime(Qualifiers::ObjCLifetime lifetime) {
2666 switch (lifetime) {
John McCall31168b02011-06-15 23:02:42 +00002667 case Qualifiers::OCL_None:
2668 case Qualifiers::OCL_ExplicitNone:
2669 case Qualifiers::OCL_Strong:
2670 case Qualifiers::OCL_Autoreleasing:
Volodymyr Sapsai8b286f92018-11-01 22:50:08 +00002671 return true;
John McCall31168b02011-06-15 23:02:42 +00002672
2673 case Qualifiers::OCL_Weak:
Volodymyr Sapsai8b286f92018-11-01 22:50:08 +00002674 return false;
John McCall31168b02011-06-15 23:02:42 +00002675 }
2676
2677 llvm_unreachable("impossible lifetime!");
John McCall31168b02011-06-15 23:02:42 +00002678}
2679
2680static TryEmitResult tryEmitARCRetainLoadOfScalar(CodeGenFunction &CGF,
Volodymyr Sapsai8b286f92018-11-01 22:50:08 +00002681 LValue lvalue,
2682 QualType type) {
2683 llvm::Value *result;
2684 bool shouldRetain = shouldRetainObjCLifetime(type.getObjCLifetime());
2685 if (shouldRetain) {
2686 result = CGF.EmitLoadOfLValue(lvalue, SourceLocation()).getScalarVal();
2687 } else {
2688 assert(type.getObjCLifetime() == Qualifiers::OCL_Weak);
2689 result = CGF.EmitARCLoadWeakRetained(lvalue.getAddress());
2690 }
2691 return TryEmitResult(result, !shouldRetain);
2692}
2693
2694static TryEmitResult tryEmitARCRetainLoadOfScalar(CodeGenFunction &CGF,
John McCall31168b02011-06-15 23:02:42 +00002695 const Expr *e) {
2696 e = e->IgnoreParens();
2697 QualType type = e->getType();
2698
Fangrui Song6907ce22018-07-30 19:24:48 +00002699 // If we're loading retained from a __strong xvalue, we can avoid
John McCall154a2fd2011-08-30 00:57:29 +00002700 // an extra retain/release pair by zeroing out the source of this
2701 // "move" operation.
2702 if (e->isXValue() &&
2703 !type.isConstQualified() &&
2704 type.getObjCLifetime() == Qualifiers::OCL_Strong) {
2705 // Emit the lvalue.
2706 LValue lv = CGF.EmitLValue(e);
Fangrui Song6907ce22018-07-30 19:24:48 +00002707
John McCall154a2fd2011-08-30 00:57:29 +00002708 // Load the object pointer.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002709 llvm::Value *result = CGF.EmitLoadOfLValue(lv,
2710 SourceLocation()).getScalarVal();
Fangrui Song6907ce22018-07-30 19:24:48 +00002711
John McCall154a2fd2011-08-30 00:57:29 +00002712 // Set the source pointer to NULL.
2713 CGF.EmitStoreOfScalar(getNullForVariable(lv.getAddress()), lv);
Fangrui Song6907ce22018-07-30 19:24:48 +00002714
John McCall154a2fd2011-08-30 00:57:29 +00002715 return TryEmitResult(result, true);
2716 }
2717
John McCall31168b02011-06-15 23:02:42 +00002718 // As a very special optimization, in ARC++, if the l-value is the
2719 // result of a non-volatile assignment, do a simple retain of the
2720 // result of the call to objc_storeWeak instead of reloading.
David Blaikiebbafb8a2012-03-11 07:00:24 +00002721 if (CGF.getLangOpts().CPlusPlus &&
John McCall31168b02011-06-15 23:02:42 +00002722 !type.isVolatileQualified() &&
2723 type.getObjCLifetime() == Qualifiers::OCL_Weak &&
2724 isa<BinaryOperator>(e) &&
2725 cast<BinaryOperator>(e)->getOpcode() == BO_Assign)
2726 return TryEmitResult(CGF.EmitScalarExpr(e), false);
2727
Volodymyr Sapsai8b286f92018-11-01 22:50:08 +00002728 // Try to emit code for scalar constant instead of emitting LValue and
2729 // loading it because we are not guaranteed to have an l-value. One of such
2730 // cases is DeclRefExpr referencing non-odr-used constant-evaluated variable.
2731 if (const auto *decl_expr = dyn_cast<DeclRefExpr>(e)) {
2732 auto *DRE = const_cast<DeclRefExpr *>(decl_expr);
2733 if (CodeGenFunction::ConstantEmission constant = CGF.tryEmitAsConstant(DRE))
2734 return TryEmitResult(CGF.emitScalarConstant(constant, DRE),
2735 !shouldRetainObjCLifetime(type.getObjCLifetime()));
2736 }
2737
John McCall31168b02011-06-15 23:02:42 +00002738 return tryEmitARCRetainLoadOfScalar(CGF, CGF.EmitLValue(e), type);
2739}
2740
John McCalle399e5b2016-01-27 18:32:30 +00002741typedef llvm::function_ref<llvm::Value *(CodeGenFunction &CGF,
2742 llvm::Value *value)>
2743 ValueTransform;
John McCall31168b02011-06-15 23:02:42 +00002744
John McCalle399e5b2016-01-27 18:32:30 +00002745/// Insert code immediately after a call.
2746static llvm::Value *emitARCOperationAfterCall(CodeGenFunction &CGF,
2747 llvm::Value *value,
2748 ValueTransform doAfterCall,
2749 ValueTransform doFallback) {
John McCall31168b02011-06-15 23:02:42 +00002750 if (llvm::CallInst *call = dyn_cast<llvm::CallInst>(value)) {
2751 CGBuilderTy::InsertPoint ip = CGF.Builder.saveIP();
2752
2753 // Place the retain immediately following the call.
2754 CGF.Builder.SetInsertPoint(call->getParent(),
2755 ++llvm::BasicBlock::iterator(call));
John McCalle399e5b2016-01-27 18:32:30 +00002756 value = doAfterCall(CGF, value);
John McCall31168b02011-06-15 23:02:42 +00002757
2758 CGF.Builder.restoreIP(ip);
2759 return value;
2760 } else if (llvm::InvokeInst *invoke = dyn_cast<llvm::InvokeInst>(value)) {
2761 CGBuilderTy::InsertPoint ip = CGF.Builder.saveIP();
2762
2763 // Place the retain at the beginning of the normal destination block.
2764 llvm::BasicBlock *BB = invoke->getNormalDest();
2765 CGF.Builder.SetInsertPoint(BB, BB->begin());
John McCalle399e5b2016-01-27 18:32:30 +00002766 value = doAfterCall(CGF, value);
John McCall31168b02011-06-15 23:02:42 +00002767
2768 CGF.Builder.restoreIP(ip);
2769 return value;
2770
2771 // Bitcasts can arise because of related-result returns. Rewrite
2772 // the operand.
2773 } else if (llvm::BitCastInst *bitcast = dyn_cast<llvm::BitCastInst>(value)) {
2774 llvm::Value *operand = bitcast->getOperand(0);
John McCalle399e5b2016-01-27 18:32:30 +00002775 operand = emitARCOperationAfterCall(CGF, operand, doAfterCall, doFallback);
John McCall31168b02011-06-15 23:02:42 +00002776 bitcast->setOperand(0, operand);
2777 return bitcast;
2778
2779 // Generic fall-back case.
2780 } else {
2781 // Retain using the non-block variant: we never need to do a copy
2782 // of a block that's been returned to us.
John McCalle399e5b2016-01-27 18:32:30 +00002783 return doFallback(CGF, value);
2784 }
2785}
2786
2787/// Given that the given expression is some sort of call (which does
2788/// not return retained), emit a retain following it.
2789static llvm::Value *emitARCRetainCallResult(CodeGenFunction &CGF,
2790 const Expr *e) {
2791 llvm::Value *value = CGF.EmitScalarExpr(e);
2792 return emitARCOperationAfterCall(CGF, value,
2793 [](CodeGenFunction &CGF, llvm::Value *value) {
2794 return CGF.EmitARCRetainAutoreleasedReturnValue(value);
2795 },
2796 [](CodeGenFunction &CGF, llvm::Value *value) {
2797 return CGF.EmitARCRetainNonBlock(value);
2798 });
2799}
2800
2801/// Given that the given expression is some sort of call (which does
2802/// not return retained), perform an unsafeClaim following it.
2803static llvm::Value *emitARCUnsafeClaimCallResult(CodeGenFunction &CGF,
2804 const Expr *e) {
2805 llvm::Value *value = CGF.EmitScalarExpr(e);
2806 return emitARCOperationAfterCall(CGF, value,
2807 [](CodeGenFunction &CGF, llvm::Value *value) {
2808 return CGF.EmitARCUnsafeClaimAutoreleasedReturnValue(value);
2809 },
2810 [](CodeGenFunction &CGF, llvm::Value *value) {
2811 return value;
2812 });
2813}
2814
2815llvm::Value *CodeGenFunction::EmitARCReclaimReturnedObject(const Expr *E,
2816 bool allowUnsafeClaim) {
2817 if (allowUnsafeClaim &&
2818 CGM.getLangOpts().ObjCRuntime.hasARCUnsafeClaimAutoreleasedReturnValue()) {
2819 return emitARCUnsafeClaimCallResult(*this, E);
2820 } else {
2821 llvm::Value *value = emitARCRetainCallResult(*this, E);
2822 return EmitObjCConsumeObject(E->getType(), value);
John McCall31168b02011-06-15 23:02:42 +00002823 }
2824}
2825
John McCallcd78e802011-09-10 01:16:55 +00002826/// Determine whether it might be important to emit a separate
2827/// objc_retain_block on the result of the given expression, or
2828/// whether it's okay to just emit it in a +1 context.
2829static bool shouldEmitSeparateBlockRetain(const Expr *e) {
2830 assert(e->getType()->isBlockPointerType());
2831 e = e->IgnoreParens();
2832
2833 // For future goodness, emit block expressions directly in +1
2834 // contexts if we can.
2835 if (isa<BlockExpr>(e))
2836 return false;
2837
2838 if (const CastExpr *cast = dyn_cast<CastExpr>(e)) {
2839 switch (cast->getCastKind()) {
2840 // Emitting these operations in +1 contexts is goodness.
2841 case CK_LValueToRValue:
John McCall2d637d22011-09-10 06:18:15 +00002842 case CK_ARCReclaimReturnedObject:
2843 case CK_ARCConsumeObject:
2844 case CK_ARCProduceObject:
John McCallcd78e802011-09-10 01:16:55 +00002845 return false;
2846
2847 // These operations preserve a block type.
2848 case CK_NoOp:
2849 case CK_BitCast:
2850 return shouldEmitSeparateBlockRetain(cast->getSubExpr());
2851
2852 // These operations are known to be bad (or haven't been considered).
2853 case CK_AnyPointerToBlockPointerCast:
2854 default:
2855 return true;
2856 }
2857 }
2858
2859 return true;
2860}
2861
John McCalle399e5b2016-01-27 18:32:30 +00002862namespace {
2863/// A CRTP base class for emitting expressions of retainable object
2864/// pointer type in ARC.
2865template <typename Impl, typename Result> class ARCExprEmitter {
2866protected:
2867 CodeGenFunction &CGF;
2868 Impl &asImpl() { return *static_cast<Impl*>(this); }
2869
2870 ARCExprEmitter(CodeGenFunction &CGF) : CGF(CGF) {}
2871
2872public:
2873 Result visit(const Expr *e);
2874 Result visitCastExpr(const CastExpr *e);
2875 Result visitPseudoObjectExpr(const PseudoObjectExpr *e);
Akira Hatanakac5792aa2019-02-27 18:17:16 +00002876 Result visitBlockExpr(const BlockExpr *e);
John McCalle399e5b2016-01-27 18:32:30 +00002877 Result visitBinaryOperator(const BinaryOperator *e);
2878 Result visitBinAssign(const BinaryOperator *e);
2879 Result visitBinAssignUnsafeUnretained(const BinaryOperator *e);
2880 Result visitBinAssignAutoreleasing(const BinaryOperator *e);
2881 Result visitBinAssignWeak(const BinaryOperator *e);
2882 Result visitBinAssignStrong(const BinaryOperator *e);
2883
2884 // Minimal implementation:
2885 // Result visitLValueToRValue(const Expr *e)
2886 // Result visitConsumeObject(const Expr *e)
2887 // Result visitExtendBlockObject(const Expr *e)
2888 // Result visitReclaimReturnedObject(const Expr *e)
2889 // Result visitCall(const Expr *e)
2890 // Result visitExpr(const Expr *e)
2891 //
2892 // Result emitBitCast(Result result, llvm::Type *resultType)
2893 // llvm::Value *getValueOfResult(Result result)
2894};
2895}
2896
2897/// Try to emit a PseudoObjectExpr under special ARC rules.
John McCallfe96e0b2011-11-06 09:01:30 +00002898///
2899/// This massively duplicates emitPseudoObjectRValue.
John McCalle399e5b2016-01-27 18:32:30 +00002900template <typename Impl, typename Result>
2901Result
2902ARCExprEmitter<Impl,Result>::visitPseudoObjectExpr(const PseudoObjectExpr *E) {
Dmitri Gribenkof8579502013-01-12 19:30:44 +00002903 SmallVector<CodeGenFunction::OpaqueValueMappingData, 4> opaques;
John McCallfe96e0b2011-11-06 09:01:30 +00002904
2905 // Find the result expression.
2906 const Expr *resultExpr = E->getResultExpr();
2907 assert(resultExpr);
John McCalle399e5b2016-01-27 18:32:30 +00002908 Result result;
John McCallfe96e0b2011-11-06 09:01:30 +00002909
2910 for (PseudoObjectExpr::const_semantics_iterator
2911 i = E->semantics_begin(), e = E->semantics_end(); i != e; ++i) {
2912 const Expr *semantic = *i;
2913
2914 // If this semantic expression is an opaque value, bind it
2915 // to the result of its source expression.
2916 if (const OpaqueValueExpr *ov = dyn_cast<OpaqueValueExpr>(semantic)) {
2917 typedef CodeGenFunction::OpaqueValueMappingData OVMA;
2918 OVMA opaqueData;
2919
2920 // If this semantic is the result of the pseudo-object
2921 // expression, try to evaluate the source as +1.
2922 if (ov == resultExpr) {
2923 assert(!OVMA::shouldBindAsLValue(ov));
John McCalle399e5b2016-01-27 18:32:30 +00002924 result = asImpl().visit(ov->getSourceExpr());
2925 opaqueData = OVMA::bind(CGF, ov,
2926 RValue::get(asImpl().getValueOfResult(result)));
John McCallfe96e0b2011-11-06 09:01:30 +00002927
2928 // Otherwise, just bind it.
2929 } else {
2930 opaqueData = OVMA::bind(CGF, ov, ov->getSourceExpr());
2931 }
2932 opaques.push_back(opaqueData);
2933
2934 // Otherwise, if the expression is the result, evaluate it
2935 // and remember the result.
2936 } else if (semantic == resultExpr) {
John McCalle399e5b2016-01-27 18:32:30 +00002937 result = asImpl().visit(semantic);
John McCallfe96e0b2011-11-06 09:01:30 +00002938
2939 // Otherwise, evaluate the expression in an ignored context.
2940 } else {
2941 CGF.EmitIgnoredExpr(semantic);
2942 }
2943 }
2944
2945 // Unbind all the opaques now.
2946 for (unsigned i = 0, e = opaques.size(); i != e; ++i)
2947 opaques[i].unbind(CGF);
2948
2949 return result;
2950}
2951
John McCalle399e5b2016-01-27 18:32:30 +00002952template <typename Impl, typename Result>
Akira Hatanakac5792aa2019-02-27 18:17:16 +00002953Result ARCExprEmitter<Impl, Result>::visitBlockExpr(const BlockExpr *e) {
2954 // The default implementation just forwards the expression to visitExpr.
2955 return asImpl().visitExpr(e);
2956}
2957
2958template <typename Impl, typename Result>
John McCalle399e5b2016-01-27 18:32:30 +00002959Result ARCExprEmitter<Impl,Result>::visitCastExpr(const CastExpr *e) {
2960 switch (e->getCastKind()) {
John McCall53848232011-07-27 01:07:15 +00002961
John McCalle399e5b2016-01-27 18:32:30 +00002962 // No-op casts don't change the type, so we just ignore them.
2963 case CK_NoOp:
2964 return asImpl().visit(e->getSubExpr());
John McCall31168b02011-06-15 23:02:42 +00002965
John McCalle399e5b2016-01-27 18:32:30 +00002966 // These casts can change the type.
2967 case CK_CPointerToObjCPointerCast:
2968 case CK_BlockPointerToObjCPointerCast:
2969 case CK_AnyPointerToBlockPointerCast:
2970 case CK_BitCast: {
2971 llvm::Type *resultType = CGF.ConvertType(e->getType());
2972 assert(e->getSubExpr()->getType()->hasPointerRepresentation());
2973 Result result = asImpl().visit(e->getSubExpr());
2974 return asImpl().emitBitCast(result, resultType);
John McCall31168b02011-06-15 23:02:42 +00002975 }
2976
John McCalle399e5b2016-01-27 18:32:30 +00002977 // Handle some casts specially.
2978 case CK_LValueToRValue:
2979 return asImpl().visitLValueToRValue(e->getSubExpr());
2980 case CK_ARCConsumeObject:
2981 return asImpl().visitConsumeObject(e->getSubExpr());
2982 case CK_ARCExtendBlockObject:
2983 return asImpl().visitExtendBlockObject(e->getSubExpr());
2984 case CK_ARCReclaimReturnedObject:
2985 return asImpl().visitReclaimReturnedObject(e->getSubExpr());
2986
2987 // Otherwise, use the default logic.
2988 default:
2989 return asImpl().visitExpr(e);
2990 }
2991}
2992
2993template <typename Impl, typename Result>
2994Result
2995ARCExprEmitter<Impl,Result>::visitBinaryOperator(const BinaryOperator *e) {
2996 switch (e->getOpcode()) {
2997 case BO_Comma:
2998 CGF.EmitIgnoredExpr(e->getLHS());
2999 CGF.EnsureInsertPoint();
3000 return asImpl().visit(e->getRHS());
3001
3002 case BO_Assign:
3003 return asImpl().visitBinAssign(e);
3004
3005 default:
3006 return asImpl().visitExpr(e);
3007 }
3008}
3009
3010template <typename Impl, typename Result>
3011Result ARCExprEmitter<Impl,Result>::visitBinAssign(const BinaryOperator *e) {
3012 switch (e->getLHS()->getType().getObjCLifetime()) {
3013 case Qualifiers::OCL_ExplicitNone:
3014 return asImpl().visitBinAssignUnsafeUnretained(e);
3015
3016 case Qualifiers::OCL_Weak:
3017 return asImpl().visitBinAssignWeak(e);
3018
3019 case Qualifiers::OCL_Autoreleasing:
3020 return asImpl().visitBinAssignAutoreleasing(e);
3021
3022 case Qualifiers::OCL_Strong:
3023 return asImpl().visitBinAssignStrong(e);
3024
3025 case Qualifiers::OCL_None:
3026 return asImpl().visitExpr(e);
3027 }
3028 llvm_unreachable("bad ObjC ownership qualifier");
3029}
3030
3031/// The default rule for __unsafe_unretained emits the RHS recursively,
3032/// stores into the unsafe variable, and propagates the result outward.
3033template <typename Impl, typename Result>
3034Result ARCExprEmitter<Impl,Result>::
3035 visitBinAssignUnsafeUnretained(const BinaryOperator *e) {
3036 // Recursively emit the RHS.
3037 // For __block safety, do this before emitting the LHS.
3038 Result result = asImpl().visit(e->getRHS());
3039
3040 // Perform the store.
3041 LValue lvalue =
3042 CGF.EmitCheckedLValue(e->getLHS(), CodeGenFunction::TCK_Store);
3043 CGF.EmitStoreThroughLValue(RValue::get(asImpl().getValueOfResult(result)),
3044 lvalue);
3045
3046 return result;
3047}
3048
3049template <typename Impl, typename Result>
3050Result
3051ARCExprEmitter<Impl,Result>::visitBinAssignAutoreleasing(const BinaryOperator *e) {
3052 return asImpl().visitExpr(e);
3053}
3054
3055template <typename Impl, typename Result>
3056Result
3057ARCExprEmitter<Impl,Result>::visitBinAssignWeak(const BinaryOperator *e) {
3058 return asImpl().visitExpr(e);
3059}
3060
3061template <typename Impl, typename Result>
3062Result
3063ARCExprEmitter<Impl,Result>::visitBinAssignStrong(const BinaryOperator *e) {
3064 return asImpl().visitExpr(e);
3065}
3066
3067/// The general expression-emission logic.
3068template <typename Impl, typename Result>
3069Result ARCExprEmitter<Impl,Result>::visit(const Expr *e) {
3070 // We should *never* see a nested full-expression here, because if
3071 // we fail to emit at +1, our caller must not retain after we close
3072 // out the full-expression. This isn't as important in the unsafe
3073 // emitter.
3074 assert(!isa<ExprWithCleanups>(e));
3075
3076 // Look through parens, __extension__, generic selection, etc.
3077 e = e->IgnoreParens();
3078
3079 // Handle certain kinds of casts.
3080 if (const CastExpr *ce = dyn_cast<CastExpr>(e)) {
3081 return asImpl().visitCastExpr(ce);
3082
3083 // Handle the comma operator.
3084 } else if (auto op = dyn_cast<BinaryOperator>(e)) {
3085 return asImpl().visitBinaryOperator(op);
3086
3087 // TODO: handle conditional operators here
3088
3089 // For calls and message sends, use the retained-call logic.
3090 // Delegate inits are a special case in that they're the only
3091 // returns-retained expression that *isn't* surrounded by
3092 // a consume.
3093 } else if (isa<CallExpr>(e) ||
3094 (isa<ObjCMessageExpr>(e) &&
3095 !cast<ObjCMessageExpr>(e)->isDelegateInitCall())) {
3096 return asImpl().visitCall(e);
3097
3098 // Look through pseudo-object expressions.
3099 } else if (const PseudoObjectExpr *pseudo = dyn_cast<PseudoObjectExpr>(e)) {
3100 return asImpl().visitPseudoObjectExpr(pseudo);
Akira Hatanakac5792aa2019-02-27 18:17:16 +00003101 } else if (auto *be = dyn_cast<BlockExpr>(e))
3102 return asImpl().visitBlockExpr(be);
John McCalle399e5b2016-01-27 18:32:30 +00003103
3104 return asImpl().visitExpr(e);
3105}
3106
3107namespace {
3108
3109/// An emitter for +1 results.
3110struct ARCRetainExprEmitter :
3111 public ARCExprEmitter<ARCRetainExprEmitter, TryEmitResult> {
3112
3113 ARCRetainExprEmitter(CodeGenFunction &CGF) : ARCExprEmitter(CGF) {}
3114
3115 llvm::Value *getValueOfResult(TryEmitResult result) {
3116 return result.getPointer();
3117 }
3118
3119 TryEmitResult emitBitCast(TryEmitResult result, llvm::Type *resultType) {
3120 llvm::Value *value = result.getPointer();
3121 value = CGF.Builder.CreateBitCast(value, resultType);
3122 result.setPointer(value);
3123 return result;
3124 }
3125
3126 TryEmitResult visitLValueToRValue(const Expr *e) {
3127 return tryEmitARCRetainLoadOfScalar(CGF, e);
3128 }
3129
3130 /// For consumptions, just emit the subexpression and thus elide
3131 /// the retain/release pair.
3132 TryEmitResult visitConsumeObject(const Expr *e) {
3133 llvm::Value *result = CGF.EmitScalarExpr(e);
3134 return TryEmitResult(result, true);
3135 }
3136
Akira Hatanakac5792aa2019-02-27 18:17:16 +00003137 TryEmitResult visitBlockExpr(const BlockExpr *e) {
3138 TryEmitResult result = visitExpr(e);
3139 // Avoid the block-retain if this is a block literal that doesn't need to be
3140 // copied to the heap.
3141 if (e->getBlockDecl()->canAvoidCopyToHeap())
3142 result.setInt(true);
3143 return result;
3144 }
3145
John McCalle399e5b2016-01-27 18:32:30 +00003146 /// Block extends are net +0. Naively, we could just recurse on
3147 /// the subexpression, but actually we need to ensure that the
3148 /// value is copied as a block, so there's a little filter here.
3149 TryEmitResult visitExtendBlockObject(const Expr *e) {
3150 llvm::Value *result; // will be a +0 value
3151
3152 // If we can't safely assume the sub-expression will produce a
3153 // block-copied value, emit the sub-expression at +0.
3154 if (shouldEmitSeparateBlockRetain(e)) {
3155 result = CGF.EmitScalarExpr(e);
3156
3157 // Otherwise, try to emit the sub-expression at +1 recursively.
3158 } else {
3159 TryEmitResult subresult = asImpl().visit(e);
3160
3161 // If that produced a retained value, just use that.
3162 if (subresult.getInt()) {
3163 return subresult;
3164 }
3165
3166 // Otherwise it's +0.
3167 result = subresult.getPointer();
3168 }
3169
3170 // Retain the object as a block.
3171 result = CGF.EmitARCRetainBlock(result, /*mandatory*/ true);
3172 return TryEmitResult(result, true);
3173 }
3174
3175 /// For reclaims, emit the subexpression as a retained call and
3176 /// skip the consumption.
3177 TryEmitResult visitReclaimReturnedObject(const Expr *e) {
3178 llvm::Value *result = emitARCRetainCallResult(CGF, e);
3179 return TryEmitResult(result, true);
3180 }
3181
3182 /// When we have an undecorated call, retroactively do a claim.
3183 TryEmitResult visitCall(const Expr *e) {
3184 llvm::Value *result = emitARCRetainCallResult(CGF, e);
3185 return TryEmitResult(result, true);
3186 }
3187
3188 // TODO: maybe special-case visitBinAssignWeak?
3189
3190 TryEmitResult visitExpr(const Expr *e) {
3191 // We didn't find an obvious production, so emit what we've got and
3192 // tell the caller that we didn't manage to retain.
3193 llvm::Value *result = CGF.EmitScalarExpr(e);
3194 return TryEmitResult(result, false);
3195 }
3196};
3197}
3198
3199static TryEmitResult
3200tryEmitARCRetainScalarExpr(CodeGenFunction &CGF, const Expr *e) {
3201 return ARCRetainExprEmitter(CGF).visit(e);
John McCall31168b02011-06-15 23:02:42 +00003202}
3203
3204static llvm::Value *emitARCRetainLoadOfScalar(CodeGenFunction &CGF,
3205 LValue lvalue,
3206 QualType type) {
3207 TryEmitResult result = tryEmitARCRetainLoadOfScalar(CGF, lvalue, type);
3208 llvm::Value *value = result.getPointer();
3209 if (!result.getInt())
3210 value = CGF.EmitARCRetain(type, value);
3211 return value;
3212}
3213
3214/// EmitARCRetainScalarExpr - Semantically equivalent to
3215/// EmitARCRetainObject(e->getType(), EmitScalarExpr(e)), but making a
3216/// best-effort attempt to peephole expressions that naturally produce
3217/// retained objects.
3218llvm::Value *CodeGenFunction::EmitARCRetainScalarExpr(const Expr *e) {
John McCalld21cdd42013-02-12 00:25:08 +00003219 // The retain needs to happen within the full-expression.
3220 if (const ExprWithCleanups *cleanups = dyn_cast<ExprWithCleanups>(e)) {
3221 enterFullExpression(cleanups);
3222 RunCleanupsScope scope(*this);
3223 return EmitARCRetainScalarExpr(cleanups->getSubExpr());
3224 }
3225
John McCall31168b02011-06-15 23:02:42 +00003226 TryEmitResult result = tryEmitARCRetainScalarExpr(*this, e);
3227 llvm::Value *value = result.getPointer();
3228 if (!result.getInt())
3229 value = EmitARCRetain(e->getType(), value);
3230 return value;
3231}
3232
3233llvm::Value *
3234CodeGenFunction::EmitARCRetainAutoreleaseScalarExpr(const Expr *e) {
John McCalld21cdd42013-02-12 00:25:08 +00003235 // The retain needs to happen within the full-expression.
3236 if (const ExprWithCleanups *cleanups = dyn_cast<ExprWithCleanups>(e)) {
3237 enterFullExpression(cleanups);
3238 RunCleanupsScope scope(*this);
3239 return EmitARCRetainAutoreleaseScalarExpr(cleanups->getSubExpr());
3240 }
3241
John McCall31168b02011-06-15 23:02:42 +00003242 TryEmitResult result = tryEmitARCRetainScalarExpr(*this, e);
3243 llvm::Value *value = result.getPointer();
3244 if (result.getInt())
3245 value = EmitARCAutorelease(value);
3246 else
3247 value = EmitARCRetainAutorelease(e->getType(), value);
3248 return value;
3249}
3250
John McCallff613032011-10-04 06:23:45 +00003251llvm::Value *CodeGenFunction::EmitARCExtendBlockObject(const Expr *e) {
3252 llvm::Value *result;
3253 bool doRetain;
3254
3255 if (shouldEmitSeparateBlockRetain(e)) {
3256 result = EmitScalarExpr(e);
3257 doRetain = true;
3258 } else {
3259 TryEmitResult subresult = tryEmitARCRetainScalarExpr(*this, e);
3260 result = subresult.getPointer();
3261 doRetain = !subresult.getInt();
3262 }
3263
3264 if (doRetain)
3265 result = EmitARCRetainBlock(result, /*mandatory*/ true);
3266 return EmitObjCConsumeObject(e->getType(), result);
3267}
3268
John McCall248512a2011-10-01 10:32:24 +00003269llvm::Value *CodeGenFunction::EmitObjCThrowOperand(const Expr *expr) {
3270 // In ARC, retain and autorelease the expression.
David Blaikiebbafb8a2012-03-11 07:00:24 +00003271 if (getLangOpts().ObjCAutoRefCount) {
John McCall248512a2011-10-01 10:32:24 +00003272 // Do so before running any cleanups for the full-expression.
John McCalld21cdd42013-02-12 00:25:08 +00003273 // EmitARCRetainAutoreleaseScalarExpr does this for us.
John McCall248512a2011-10-01 10:32:24 +00003274 return EmitARCRetainAutoreleaseScalarExpr(expr);
3275 }
3276
3277 // Otherwise, use the normal scalar-expression emission. The
3278 // exception machinery doesn't do anything special with the
3279 // exception like retaining it, so there's no safety associated with
3280 // only running cleanups after the throw has started, and when it
3281 // matters it tends to be substantially inferior code.
3282 return EmitScalarExpr(expr);
3283}
3284
John McCalle399e5b2016-01-27 18:32:30 +00003285namespace {
3286
3287/// An emitter for assigning into an __unsafe_unretained context.
3288struct ARCUnsafeUnretainedExprEmitter :
3289 public ARCExprEmitter<ARCUnsafeUnretainedExprEmitter, llvm::Value*> {
3290
3291 ARCUnsafeUnretainedExprEmitter(CodeGenFunction &CGF) : ARCExprEmitter(CGF) {}
3292
3293 llvm::Value *getValueOfResult(llvm::Value *value) {
3294 return value;
3295 }
3296
3297 llvm::Value *emitBitCast(llvm::Value *value, llvm::Type *resultType) {
3298 return CGF.Builder.CreateBitCast(value, resultType);
3299 }
3300
3301 llvm::Value *visitLValueToRValue(const Expr *e) {
3302 return CGF.EmitScalarExpr(e);
3303 }
3304
3305 /// For consumptions, just emit the subexpression and perform the
3306 /// consumption like normal.
3307 llvm::Value *visitConsumeObject(const Expr *e) {
3308 llvm::Value *value = CGF.EmitScalarExpr(e);
3309 return CGF.EmitObjCConsumeObject(e->getType(), value);
3310 }
3311
3312 /// No special logic for block extensions. (This probably can't
3313 /// actually happen in this emitter, though.)
3314 llvm::Value *visitExtendBlockObject(const Expr *e) {
3315 return CGF.EmitARCExtendBlockObject(e);
3316 }
3317
3318 /// For reclaims, perform an unsafeClaim if that's enabled.
3319 llvm::Value *visitReclaimReturnedObject(const Expr *e) {
3320 return CGF.EmitARCReclaimReturnedObject(e, /*unsafe*/ true);
3321 }
3322
3323 /// When we have an undecorated call, just emit it without adding
3324 /// the unsafeClaim.
3325 llvm::Value *visitCall(const Expr *e) {
3326 return CGF.EmitScalarExpr(e);
3327 }
3328
3329 /// Just do normal scalar emission in the default case.
3330 llvm::Value *visitExpr(const Expr *e) {
3331 return CGF.EmitScalarExpr(e);
3332 }
3333};
3334}
3335
3336static llvm::Value *emitARCUnsafeUnretainedScalarExpr(CodeGenFunction &CGF,
3337 const Expr *e) {
3338 return ARCUnsafeUnretainedExprEmitter(CGF).visit(e);
3339}
3340
3341/// EmitARCUnsafeUnretainedScalarExpr - Semantically equivalent to
3342/// immediately releasing the resut of EmitARCRetainScalarExpr, but
3343/// avoiding any spurious retains, including by performing reclaims
3344/// with objc_unsafeClaimAutoreleasedReturnValue.
3345llvm::Value *CodeGenFunction::EmitARCUnsafeUnretainedScalarExpr(const Expr *e) {
3346 // Look through full-expressions.
3347 if (const ExprWithCleanups *cleanups = dyn_cast<ExprWithCleanups>(e)) {
3348 enterFullExpression(cleanups);
3349 RunCleanupsScope scope(*this);
3350 return emitARCUnsafeUnretainedScalarExpr(*this, cleanups->getSubExpr());
3351 }
3352
3353 return emitARCUnsafeUnretainedScalarExpr(*this, e);
3354}
3355
3356std::pair<LValue,llvm::Value*>
3357CodeGenFunction::EmitARCStoreUnsafeUnretained(const BinaryOperator *e,
3358 bool ignored) {
3359 // Evaluate the RHS first. If we're ignoring the result, assume
3360 // that we can emit at an unsafe +0.
3361 llvm::Value *value;
3362 if (ignored) {
3363 value = EmitARCUnsafeUnretainedScalarExpr(e->getRHS());
3364 } else {
3365 value = EmitScalarExpr(e->getRHS());
3366 }
3367
3368 // Emit the LHS and perform the store.
3369 LValue lvalue = EmitLValue(e->getLHS());
3370 EmitStoreOfScalar(value, lvalue);
3371
3372 return std::pair<LValue,llvm::Value*>(std::move(lvalue), value);
3373}
3374
John McCall31168b02011-06-15 23:02:42 +00003375std::pair<LValue,llvm::Value*>
3376CodeGenFunction::EmitARCStoreStrong(const BinaryOperator *e,
3377 bool ignored) {
3378 // Evaluate the RHS first.
3379 TryEmitResult result = tryEmitARCRetainScalarExpr(*this, e->getRHS());
3380 llvm::Value *value = result.getPointer();
3381
John McCallb726a552011-07-28 07:23:35 +00003382 bool hasImmediateRetain = result.getInt();
3383
3384 // If we didn't emit a retained object, and the l-value is of block
3385 // type, then we need to emit the block-retain immediately in case
3386 // it invalidates the l-value.
3387 if (!hasImmediateRetain && e->getType()->isBlockPointerType()) {
John McCallff613032011-10-04 06:23:45 +00003388 value = EmitARCRetainBlock(value, /*mandatory*/ false);
John McCallb726a552011-07-28 07:23:35 +00003389 hasImmediateRetain = true;
3390 }
3391
John McCall31168b02011-06-15 23:02:42 +00003392 LValue lvalue = EmitLValue(e->getLHS());
3393
3394 // If the RHS was emitted retained, expand this.
John McCallb726a552011-07-28 07:23:35 +00003395 if (hasImmediateRetain) {
Nick Lewyckyce550072013-10-02 02:33:11 +00003396 llvm::Value *oldValue = EmitLoadOfScalar(lvalue, SourceLocation());
Eli Friedmana0544d62011-12-03 04:14:32 +00003397 EmitStoreOfScalar(value, lvalue);
John McCallcdda29c2013-03-13 03:10:54 +00003398 EmitARCRelease(oldValue, lvalue.isARCPreciseLifetime());
John McCall31168b02011-06-15 23:02:42 +00003399 } else {
John McCall55e1fbc2011-06-25 02:11:03 +00003400 value = EmitARCStoreStrong(lvalue, value, ignored);
John McCall31168b02011-06-15 23:02:42 +00003401 }
3402
3403 return std::pair<LValue,llvm::Value*>(lvalue, value);
3404}
3405
3406std::pair<LValue,llvm::Value*>
3407CodeGenFunction::EmitARCStoreAutoreleasing(const BinaryOperator *e) {
3408 llvm::Value *value = EmitARCRetainAutoreleaseScalarExpr(e->getRHS());
3409 LValue lvalue = EmitLValue(e->getLHS());
3410
Eli Friedmana0544d62011-12-03 04:14:32 +00003411 EmitStoreOfScalar(value, lvalue);
John McCall31168b02011-06-15 23:02:42 +00003412
3413 return std::pair<LValue,llvm::Value*>(lvalue, value);
3414}
3415
3416void CodeGenFunction::EmitObjCAutoreleasePoolStmt(
Eric Christopher5d2b8d92012-03-29 17:31:31 +00003417 const ObjCAutoreleasePoolStmt &ARPS) {
John McCall31168b02011-06-15 23:02:42 +00003418 const Stmt *subStmt = ARPS.getSubStmt();
3419 const CompoundStmt &S = cast<CompoundStmt>(*subStmt);
3420
3421 CGDebugInfo *DI = getDebugInfo();
Eric Christopher7cdf9482011-10-13 21:45:18 +00003422 if (DI)
3423 DI->EmitLexicalBlockStart(Builder, S.getLBracLoc());
John McCall31168b02011-06-15 23:02:42 +00003424
3425 // Keep track of the current cleanup stack depth.
3426 RunCleanupsScope Scope(*this);
John McCall3deb1ad2012-08-21 02:47:43 +00003427 if (CGM.getLangOpts().ObjCRuntime.hasNativeARC()) {
John McCall31168b02011-06-15 23:02:42 +00003428 llvm::Value *token = EmitObjCAutoreleasePoolPush();
3429 EHStack.pushCleanup<CallObjCAutoreleasePoolObject>(NormalCleanup, token);
3430 } else {
3431 llvm::Value *token = EmitObjCMRRAutoreleasePoolPush();
3432 EHStack.pushCleanup<CallObjCMRRAutoreleasePoolObject>(NormalCleanup, token);
3433 }
3434
Aaron Ballmanc7e4e212014-03-17 14:19:37 +00003435 for (const auto *I : S.body())
3436 EmitStmt(I);
John McCall31168b02011-06-15 23:02:42 +00003437
Eric Christopher7cdf9482011-10-13 21:45:18 +00003438 if (DI)
3439 DI->EmitLexicalBlockEnd(Builder, S.getRBracLoc());
John McCall31168b02011-06-15 23:02:42 +00003440}
John McCall1bd25562011-06-24 23:21:27 +00003441
3442/// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
3443/// make sure it survives garbage collection until this point.
3444void CodeGenFunction::EmitExtendGCLifetime(llvm::Value *object) {
3445 // We just use an inline assembly.
John McCall1bd25562011-06-24 23:21:27 +00003446 llvm::FunctionType *extenderType
John McCalla729c622012-02-17 03:33:10 +00003447 = llvm::FunctionType::get(VoidTy, VoidPtrTy, RequiredArgs::All);
James Y Knight9871db02019-02-05 16:42:33 +00003448 llvm::InlineAsm *extender = llvm::InlineAsm::get(extenderType,
3449 /* assembly */ "",
3450 /* constraints */ "r",
3451 /* side effects */ true);
John McCall1bd25562011-06-24 23:21:27 +00003452
3453 object = Builder.CreateBitCast(object, VoidPtrTy);
John McCall882987f2013-02-28 19:01:20 +00003454 EmitNounwindRuntimeCall(extender, object);
John McCall1bd25562011-06-24 23:21:27 +00003455}
3456
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003457/// GenerateObjCAtomicSetterCopyHelperFunction - Given a c++ object type with
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003458/// non-trivial copy assignment function, produce following helper function.
3459/// static void copyHelper(Ty *dest, const Ty *source) { *dest = *source; }
3460///
3461llvm::Constant *
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003462CodeGenFunction::GenerateObjCAtomicSetterCopyHelperFunction(
3463 const ObjCPropertyImplDecl *PID) {
John McCall5fb5df92012-06-20 06:18:46 +00003464 if (!getLangOpts().CPlusPlus ||
Rafael Espindolad727d3d2012-12-18 04:29:34 +00003465 !getLangOpts().ObjCRuntime.hasAtomicCopyHelper())
Craig Topper8a13c412014-05-21 05:09:00 +00003466 return nullptr;
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003467 QualType Ty = PID->getPropertyIvarDecl()->getType();
3468 if (!Ty->isRecordType())
Craig Topper8a13c412014-05-21 05:09:00 +00003469 return nullptr;
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003470 const ObjCPropertyDecl *PD = PID->getPropertyDecl();
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003471 if ((!(PD->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_atomic)))
Craig Topper8a13c412014-05-21 05:09:00 +00003472 return nullptr;
3473 llvm::Constant *HelperFn = nullptr;
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003474 if (hasTrivialSetExpr(PID))
Craig Topper8a13c412014-05-21 05:09:00 +00003475 return nullptr;
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003476 assert(PID->getSetterCXXAssignment() && "SetterCXXAssignment - null");
3477 if ((HelperFn = CGM.getAtomicSetterHelperFnMap(Ty)))
3478 return HelperFn;
Fangrui Song6907ce22018-07-30 19:24:48 +00003479
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003480 ASTContext &C = getContext();
3481 IdentifierInfo *II
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003482 = &CGM.getContext().Idents.get("__assign_helper_atomic_property_");
Craig Topper8a13c412014-05-21 05:09:00 +00003483
Jonas Devlieghere64a26302018-11-11 00:56:15 +00003484 QualType ReturnTy = C.VoidTy;
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003485 QualType DestTy = C.getPointerType(Ty);
3486 QualType SrcTy = Ty;
3487 SrcTy.addConst();
3488 SrcTy = C.getPointerType(SrcTy);
Fangrui Song6907ce22018-07-30 19:24:48 +00003489
Jonas Devlieghere64a26302018-11-11 00:56:15 +00003490 SmallVector<QualType, 2> ArgTys;
3491 ArgTys.push_back(DestTy);
3492 ArgTys.push_back(SrcTy);
3493 QualType FunctionTy = C.getFunctionType(ReturnTy, ArgTys, {});
3494
3495 FunctionDecl *FD = FunctionDecl::Create(
3496 C, C.getTranslationUnitDecl(), SourceLocation(), SourceLocation(), II,
3497 FunctionTy, nullptr, SC_Static, false, false);
3498
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003499 FunctionArgList args;
Jonas Devlieghere64a26302018-11-11 00:56:15 +00003500 ImplicitParamDecl DstDecl(C, FD, SourceLocation(), /*Id=*/nullptr, DestTy,
3501 ImplicitParamDecl::Other);
Alexey Bataev56223232017-06-09 13:40:18 +00003502 args.push_back(&DstDecl);
Jonas Devlieghere64a26302018-11-11 00:56:15 +00003503 ImplicitParamDecl SrcDecl(C, FD, SourceLocation(), /*Id=*/nullptr, SrcTy,
3504 ImplicitParamDecl::Other);
Alexey Bataev56223232017-06-09 13:40:18 +00003505 args.push_back(&SrcDecl);
Reid Kleckner4982b822014-01-31 22:54:50 +00003506
John McCallc56a8b32016-03-11 04:30:31 +00003507 const CGFunctionInfo &FI =
Jonas Devlieghere64a26302018-11-11 00:56:15 +00003508 CGM.getTypes().arrangeBuiltinFunctionDeclaration(ReturnTy, args);
Reid Kleckner4982b822014-01-31 22:54:50 +00003509
John McCalla729c622012-02-17 03:33:10 +00003510 llvm::FunctionType *LTy = CGM.getTypes().GetFunctionType(FI);
Fangrui Song6907ce22018-07-30 19:24:48 +00003511
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003512 llvm::Function *Fn =
3513 llvm::Function::Create(LTy, llvm::GlobalValue::InternalLinkage,
Eric Christopher5d2b8d92012-03-29 17:31:31 +00003514 "__assign_helper_atomic_property_",
3515 &CGM.getModule());
Akira Hatanaka44a59f82015-10-28 02:30:47 +00003516
Rafael Espindola51ec5a92018-02-28 23:46:35 +00003517 CGM.SetInternalFunctionAttributes(GlobalDecl(), Fn, FI);
Akira Hatanaka44a59f82015-10-28 02:30:47 +00003518
Jonas Devlieghere64a26302018-11-11 00:56:15 +00003519 StartFunction(FD, ReturnTy, Fn, FI, args);
Fangrui Song6907ce22018-07-30 19:24:48 +00003520
Bruno Ricci5fc4db72018-12-21 14:10:18 +00003521 DeclRefExpr DstExpr(getContext(), &DstDecl, false, DestTy, VK_RValue,
3522 SourceLocation());
John McCall113bee02012-03-10 09:33:50 +00003523 UnaryOperator DST(&DstExpr, UO_Deref, DestTy->getPointeeType(),
Aaron Ballmana5038552018-01-09 13:07:03 +00003524 VK_LValue, OK_Ordinary, SourceLocation(), false);
Fangrui Song6907ce22018-07-30 19:24:48 +00003525
Bruno Ricci5fc4db72018-12-21 14:10:18 +00003526 DeclRefExpr SrcExpr(getContext(), &SrcDecl, false, SrcTy, VK_RValue,
3527 SourceLocation());
John McCall113bee02012-03-10 09:33:50 +00003528 UnaryOperator SRC(&SrcExpr, UO_Deref, SrcTy->getPointeeType(),
Aaron Ballmana5038552018-01-09 13:07:03 +00003529 VK_LValue, OK_Ordinary, SourceLocation(), false);
Fangrui Song6907ce22018-07-30 19:24:48 +00003530
John McCall113bee02012-03-10 09:33:50 +00003531 Expr *Args[2] = { &DST, &SRC };
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003532 CallExpr *CalleeExp = cast<CallExpr>(PID->getSetterCXXAssignment());
Bruno Riccic5885cf2018-12-21 15:20:32 +00003533 CXXOperatorCallExpr *TheCall = CXXOperatorCallExpr::Create(
3534 C, OO_Equal, CalleeExp->getCallee(), Args, DestTy->getPointeeType(),
3535 VK_LValue, SourceLocation(), FPOptions());
Fangrui Song6907ce22018-07-30 19:24:48 +00003536
Bruno Riccic5885cf2018-12-21 15:20:32 +00003537 EmitStmt(TheCall);
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003538
3539 FinishFunction();
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00003540 HelperFn = llvm::ConstantExpr::getBitCast(Fn, VoidPtrTy);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003541 CGM.setAtomicSetterHelperFnMap(Ty, HelperFn);
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00003542 return HelperFn;
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003543}
3544
3545llvm::Constant *
3546CodeGenFunction::GenerateObjCAtomicGetterCopyHelperFunction(
3547 const ObjCPropertyImplDecl *PID) {
John McCall5fb5df92012-06-20 06:18:46 +00003548 if (!getLangOpts().CPlusPlus ||
Rafael Espindolad727d3d2012-12-18 04:29:34 +00003549 !getLangOpts().ObjCRuntime.hasAtomicCopyHelper())
Craig Topper8a13c412014-05-21 05:09:00 +00003550 return nullptr;
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003551 const ObjCPropertyDecl *PD = PID->getPropertyDecl();
3552 QualType Ty = PD->getType();
3553 if (!Ty->isRecordType())
Craig Topper8a13c412014-05-21 05:09:00 +00003554 return nullptr;
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003555 if ((!(PD->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_atomic)))
Craig Topper8a13c412014-05-21 05:09:00 +00003556 return nullptr;
3557 llvm::Constant *HelperFn = nullptr;
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003558 if (hasTrivialGetExpr(PID))
Craig Topper8a13c412014-05-21 05:09:00 +00003559 return nullptr;
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003560 assert(PID->getGetterCXXConstructor() && "getGetterCXXConstructor - null");
3561 if ((HelperFn = CGM.getAtomicGetterHelperFnMap(Ty)))
3562 return HelperFn;
Fangrui Song6907ce22018-07-30 19:24:48 +00003563
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003564 ASTContext &C = getContext();
Jonas Devlieghere64a26302018-11-11 00:56:15 +00003565 IdentifierInfo *II =
3566 &CGM.getContext().Idents.get("__copy_helper_atomic_property_");
Craig Topper8a13c412014-05-21 05:09:00 +00003567
Jonas Devlieghere64a26302018-11-11 00:56:15 +00003568 QualType ReturnTy = C.VoidTy;
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003569 QualType DestTy = C.getPointerType(Ty);
3570 QualType SrcTy = Ty;
3571 SrcTy.addConst();
3572 SrcTy = C.getPointerType(SrcTy);
Fangrui Song6907ce22018-07-30 19:24:48 +00003573
Jonas Devlieghere64a26302018-11-11 00:56:15 +00003574 SmallVector<QualType, 2> ArgTys;
3575 ArgTys.push_back(DestTy);
3576 ArgTys.push_back(SrcTy);
3577 QualType FunctionTy = C.getFunctionType(ReturnTy, ArgTys, {});
3578
3579 FunctionDecl *FD = FunctionDecl::Create(
3580 C, C.getTranslationUnitDecl(), SourceLocation(), SourceLocation(), II,
3581 FunctionTy, nullptr, SC_Static, false, false);
3582
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003583 FunctionArgList args;
Jonas Devlieghere64a26302018-11-11 00:56:15 +00003584 ImplicitParamDecl DstDecl(C, FD, SourceLocation(), /*Id=*/nullptr, DestTy,
3585 ImplicitParamDecl::Other);
Alexey Bataev56223232017-06-09 13:40:18 +00003586 args.push_back(&DstDecl);
Jonas Devlieghere64a26302018-11-11 00:56:15 +00003587 ImplicitParamDecl SrcDecl(C, FD, SourceLocation(), /*Id=*/nullptr, SrcTy,
3588 ImplicitParamDecl::Other);
Alexey Bataev56223232017-06-09 13:40:18 +00003589 args.push_back(&SrcDecl);
Reid Kleckner4982b822014-01-31 22:54:50 +00003590
John McCallc56a8b32016-03-11 04:30:31 +00003591 const CGFunctionInfo &FI =
Jonas Devlieghere64a26302018-11-11 00:56:15 +00003592 CGM.getTypes().arrangeBuiltinFunctionDeclaration(ReturnTy, args);
Reid Kleckner4982b822014-01-31 22:54:50 +00003593
John McCalla729c622012-02-17 03:33:10 +00003594 llvm::FunctionType *LTy = CGM.getTypes().GetFunctionType(FI);
Fangrui Song6907ce22018-07-30 19:24:48 +00003595
Jonas Devlieghere64a26302018-11-11 00:56:15 +00003596 llvm::Function *Fn = llvm::Function::Create(
3597 LTy, llvm::GlobalValue::InternalLinkage, "__copy_helper_atomic_property_",
3598 &CGM.getModule());
Rafael Espindola51ec5a92018-02-28 23:46:35 +00003599
3600 CGM.SetInternalFunctionAttributes(GlobalDecl(), Fn, FI);
Akira Hatanaka44a59f82015-10-28 02:30:47 +00003601
Jonas Devlieghere64a26302018-11-11 00:56:15 +00003602 StartFunction(FD, ReturnTy, Fn, FI, args);
Fangrui Song6907ce22018-07-30 19:24:48 +00003603
Bruno Ricci5fc4db72018-12-21 14:10:18 +00003604 DeclRefExpr SrcExpr(getContext(), &SrcDecl, false, SrcTy, VK_RValue,
3605 SourceLocation());
Fangrui Song6907ce22018-07-30 19:24:48 +00003606
John McCall113bee02012-03-10 09:33:50 +00003607 UnaryOperator SRC(&SrcExpr, UO_Deref, SrcTy->getPointeeType(),
Aaron Ballmana5038552018-01-09 13:07:03 +00003608 VK_LValue, OK_Ordinary, SourceLocation(), false);
Fangrui Song6907ce22018-07-30 19:24:48 +00003609
3610 CXXConstructExpr *CXXConstExpr =
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003611 cast<CXXConstructExpr>(PID->getGetterCXXConstructor());
Fangrui Song6907ce22018-07-30 19:24:48 +00003612
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003613 SmallVector<Expr*, 4> ConstructorArgs;
John McCall113bee02012-03-10 09:33:50 +00003614 ConstructorArgs.push_back(&SRC);
Benjamin Kramerf367dd92015-06-12 15:31:50 +00003615 ConstructorArgs.append(std::next(CXXConstExpr->arg_begin()),
3616 CXXConstExpr->arg_end());
3617
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003618 CXXConstructExpr *TheCXXConstructExpr =
3619 CXXConstructExpr::Create(C, Ty, SourceLocation(),
3620 CXXConstExpr->getConstructor(),
3621 CXXConstExpr->isElidable(),
Benjamin Kramerc215e762012-08-24 11:54:20 +00003622 ConstructorArgs,
Sebastian Redla9351792012-02-11 23:51:47 +00003623 CXXConstExpr->hadMultipleCandidates(),
3624 CXXConstExpr->isListInitialization(),
Richard Smithf8adcdc2014-07-17 05:12:35 +00003625 CXXConstExpr->isStdInitListInitialization(),
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003626 CXXConstExpr->requiresZeroInitialization(),
Eric Christopher5d2b8d92012-03-29 17:31:31 +00003627 CXXConstExpr->getConstructionKind(),
3628 SourceRange());
Fangrui Song6907ce22018-07-30 19:24:48 +00003629
Bruno Ricci5fc4db72018-12-21 14:10:18 +00003630 DeclRefExpr DstExpr(getContext(), &DstDecl, false, DestTy, VK_RValue,
3631 SourceLocation());
Fangrui Song6907ce22018-07-30 19:24:48 +00003632
John McCall113bee02012-03-10 09:33:50 +00003633 RValue DV = EmitAnyExpr(&DstExpr);
Eric Christopher5d2b8d92012-03-29 17:31:31 +00003634 CharUnits Alignment
3635 = getContext().getTypeAlignInChars(TheCXXConstructExpr->getType());
Fangrui Song6907ce22018-07-30 19:24:48 +00003636 EmitAggExpr(TheCXXConstructExpr,
John McCall7f416cc2015-09-08 08:05:57 +00003637 AggValueSlot::forAddr(Address(DV.getScalarVal(), Alignment),
3638 Qualifiers(),
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003639 AggValueSlot::IsDestructed,
3640 AggValueSlot::DoesNotNeedGCBarriers,
Richard Smithe78fac52018-04-05 20:52:58 +00003641 AggValueSlot::IsNotAliased,
3642 AggValueSlot::DoesNotOverlap));
Fangrui Song6907ce22018-07-30 19:24:48 +00003643
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003644 FinishFunction();
3645 HelperFn = llvm::ConstantExpr::getBitCast(Fn, VoidPtrTy);
3646 CGM.setAtomicGetterHelperFnMap(Ty, HelperFn);
3647 return HelperFn;
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003648}
3649
Eli Friedmanec75fec2012-02-28 01:08:45 +00003650llvm::Value *
3651CodeGenFunction::EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty) {
3652 // Get selectors for retain/autorelease.
Eli Friedmanc4e5d0c2012-03-01 22:52:28 +00003653 IdentifierInfo *CopyID = &getContext().Idents.get("copy");
3654 Selector CopySelector =
3655 getContext().Selectors.getNullarySelector(CopyID);
Eli Friedmanec75fec2012-02-28 01:08:45 +00003656 IdentifierInfo *AutoreleaseID = &getContext().Idents.get("autorelease");
3657 Selector AutoreleaseSelector =
3658 getContext().Selectors.getNullarySelector(AutoreleaseID);
3659
3660 // Emit calls to retain/autorelease.
3661 CGObjCRuntime &Runtime = CGM.getObjCRuntime();
3662 llvm::Value *Val = Block;
3663 RValue Result;
3664 Result = Runtime.GenerateMessageSend(*this, ReturnValueSlot(),
Eli Friedmanc4e5d0c2012-03-01 22:52:28 +00003665 Ty, CopySelector,
Craig Topper8a13c412014-05-21 05:09:00 +00003666 Val, CallArgList(), nullptr, nullptr);
Eli Friedmanec75fec2012-02-28 01:08:45 +00003667 Val = Result.getScalarVal();
3668 Result = Runtime.GenerateMessageSend(*this, ReturnValueSlot(),
3669 Ty, AutoreleaseSelector,
Craig Topper8a13c412014-05-21 05:09:00 +00003670 Val, CallArgList(), nullptr, nullptr);
Eli Friedmanec75fec2012-02-28 01:08:45 +00003671 Val = Result.getScalarVal();
3672 return Val;
3673}
3674
Erik Pilkington9c42a8d2017-02-23 21:08:08 +00003675llvm::Value *
3676CodeGenFunction::EmitBuiltinAvailable(ArrayRef<llvm::Value *> Args) {
3677 assert(Args.size() == 3 && "Expected 3 argument here!");
3678
3679 if (!CGM.IsOSVersionAtLeastFn) {
3680 llvm::FunctionType *FTy =
3681 llvm::FunctionType::get(Int32Ty, {Int32Ty, Int32Ty, Int32Ty}, false);
3682 CGM.IsOSVersionAtLeastFn =
3683 CGM.CreateRuntimeFunction(FTy, "__isOSVersionAtLeast");
3684 }
3685
3686 llvm::Value *CallRes =
3687 EmitNounwindRuntimeCall(CGM.IsOSVersionAtLeastFn, Args);
3688
3689 return Builder.CreateICmpNE(CallRes, llvm::Constant::getNullValue(Int32Ty));
3690}
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003691
Alex Lorenza8fbef42017-03-23 11:14:27 +00003692void CodeGenModule::emitAtAvailableLinkGuard() {
3693 if (!IsOSVersionAtLeastFn)
3694 return;
3695 // @available requires CoreFoundation only on Darwin.
3696 if (!Target.getTriple().isOSDarwin())
3697 return;
3698 // Add -framework CoreFoundation to the linker commands. We still want to
3699 // emit the core foundation reference down below because otherwise if
3700 // CoreFoundation is not used in the code, the linker won't link the
3701 // framework.
3702 auto &Context = getLLVMContext();
3703 llvm::Metadata *Args[2] = {llvm::MDString::get(Context, "-framework"),
3704 llvm::MDString::get(Context, "CoreFoundation")};
3705 LinkerOptionsMetadata.push_back(llvm::MDNode::get(Context, Args));
3706 // Emit a reference to a symbol from CoreFoundation to ensure that
3707 // CoreFoundation is linked into the final binary.
3708 llvm::FunctionType *FTy =
3709 llvm::FunctionType::get(Int32Ty, {VoidPtrTy}, false);
James Y Knight9871db02019-02-05 16:42:33 +00003710 llvm::FunctionCallee CFFunc =
Alex Lorenza8fbef42017-03-23 11:14:27 +00003711 CreateRuntimeFunction(FTy, "CFBundleGetVersionNumber");
3712
3713 llvm::FunctionType *CheckFTy = llvm::FunctionType::get(VoidTy, {}, false);
James Y Knight9871db02019-02-05 16:42:33 +00003714 llvm::FunctionCallee CFLinkCheckFuncRef = CreateRuntimeFunction(
3715 CheckFTy, "__clang_at_available_requires_core_foundation_framework",
3716 llvm::AttributeList(), /*IsLocal=*/true);
3717 llvm::Function *CFLinkCheckFunc =
3718 cast<llvm::Function>(CFLinkCheckFuncRef.getCallee()->stripPointerCasts());
3719 if (CFLinkCheckFunc->empty()) {
3720 CFLinkCheckFunc->setLinkage(llvm::GlobalValue::LinkOnceAnyLinkage);
3721 CFLinkCheckFunc->setVisibility(llvm::GlobalValue::HiddenVisibility);
3722 CodeGenFunction CGF(*this);
3723 CGF.Builder.SetInsertPoint(CGF.createBasicBlock("", CFLinkCheckFunc));
3724 CGF.EmitNounwindRuntimeCall(CFFunc,
3725 llvm::Constant::getNullValue(VoidPtrTy));
3726 CGF.Builder.CreateUnreachable();
3727 addCompilerUsedGlobal(CFLinkCheckFunc);
3728 }
Alex Lorenza8fbef42017-03-23 11:14:27 +00003729}
3730
Angel Garcia Gomez637d1e62015-10-20 13:23:58 +00003731CGObjCRuntime::~CGObjCRuntime() {}