blob: adeb6d1839be8f7d763f693255e305ce00e91c69 [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//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner5b12ab82007-12-29 19:59:25 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Anders Carlsson76f4a902007-08-21 17:43:55 +00007//
8//===----------------------------------------------------------------------===//
9//
10// This contains code to emit Objective-C code as LLVM code.
11//
12//===----------------------------------------------------------------------===//
13
Devang Pateld2d66652011-01-19 01:36:36 +000014#include "CGDebugInfo.h"
Ted Kremenek43e06332008-04-09 15:51:31 +000015#include "CGObjCRuntime.h"
Anders Carlsson76f4a902007-08-21 17:43:55 +000016#include "CodeGenFunction.h"
17#include "CodeGenModule.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 Carruthc80ceea2014-03-04 11:02:08 +000025#include "llvm/IR/CallSite.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000026#include "llvm/IR/DataLayout.h"
27#include "llvm/IR/InlineAsm.h"
Anders Carlsson76f4a902007-08-21 17:43:55 +000028using namespace clang;
29using namespace CodeGen;
30
John McCall31168b02011-06-15 23:02:42 +000031typedef llvm::PointerIntPair<llvm::Value*,1,bool> TryEmitResult;
32static TryEmitResult
33tryEmitARCRetainScalarExpr(CodeGenFunction &CGF, const Expr *e);
Douglas Gregore83b9562015-07-07 03:57:53 +000034static RValue AdjustObjCObjectType(CodeGenFunction &CGF,
35 QualType ET,
36 RValue Result);
John McCall31168b02011-06-15 23:02:42 +000037
38/// Given the address of a variable of pointer type, find the correct
39/// null to store into it.
John McCall7f416cc2015-09-08 08:05:57 +000040static llvm::Constant *getNullForVariable(Address addr) {
41 llvm::Type *type = addr.getElementType();
John McCall31168b02011-06-15 23:02:42 +000042 return llvm::ConstantPointerNull::get(cast<llvm::PointerType>(type));
43}
44
Chris Lattnerb1d329d2008-06-24 17:04:18 +000045/// Emits an instance of NSConstantString representing the object.
Mike Stump11289f42009-09-09 15:08:12 +000046llvm::Value *CodeGenFunction::EmitObjCStringLiteral(const ObjCStringLiteral *E)
Daniel Dunbar44b58a22008-11-25 21:53:21 +000047{
David Chisnall481e3a82010-01-23 02:40:42 +000048 llvm::Constant *C =
John McCall7f416cc2015-09-08 08:05:57 +000049 CGM.getObjCRuntime().GenerateConstantString(E->getString()).getPointer();
Daniel Dunbar66912a12008-08-20 00:28:19 +000050 // FIXME: This bitcast should just be made an invariant on the Runtime.
Owen Andersonade90fd2009-07-29 18:54:39 +000051 return llvm::ConstantExpr::getBitCast(C, ConvertType(E->getType()));
Chris Lattnerb1d329d2008-06-24 17:04:18 +000052}
53
Patrick Beard0caa3942012-04-19 00:25:12 +000054/// EmitObjCBoxedExpr - This routine generates code to call
55/// the appropriate expression boxing method. This will either be
Alex Denisovfde64952015-06-26 05:28:36 +000056/// one of +[NSNumber numberWith<Type>:], or +[NSString stringWithUTF8String:],
57/// or [NSValue valueWithBytes:objCType:].
Ted Kremeneke65b0862012-03-06 20:05:56 +000058///
Eric Christopher5d2b8d92012-03-29 17:31:31 +000059llvm::Value *
Patrick Beard0caa3942012-04-19 00:25:12 +000060CodeGenFunction::EmitObjCBoxedExpr(const ObjCBoxedExpr *E) {
Ted Kremeneke65b0862012-03-06 20:05:56 +000061 // Generate the correct selector for this literal's concrete type.
Ted Kremeneke65b0862012-03-06 20:05:56 +000062 // Get the method.
Patrick Beard0caa3942012-04-19 00:25:12 +000063 const ObjCMethodDecl *BoxingMethod = E->getBoxingMethod();
Alex Denisovfde64952015-06-26 05:28:36 +000064 const Expr *SubExpr = E->getSubExpr();
Patrick Beard0caa3942012-04-19 00:25:12 +000065 assert(BoxingMethod && "BoxingMethod is null");
66 assert(BoxingMethod->isClassMethod() && "BoxingMethod must be a class method");
67 Selector Sel = BoxingMethod->getSelector();
Ted Kremeneke65b0862012-03-06 20:05:56 +000068
69 // Generate a reference to the class pointer, which will be the receiver.
Patrick Beard0caa3942012-04-19 00:25:12 +000070 // Assumes that the method was introduced in the class that should be
71 // messaged (avoids pulling it out of the result type).
Ted Kremeneke65b0862012-03-06 20:05:56 +000072 CGObjCRuntime &Runtime = CGM.getObjCRuntime();
Patrick Beard0caa3942012-04-19 00:25:12 +000073 const ObjCInterfaceDecl *ClassDecl = BoxingMethod->getClassInterface();
John McCall882987f2013-02-28 19:01:20 +000074 llvm::Value *Receiver = Runtime.GetClass(*this, ClassDecl);
Fariborz Jahanian661a97b2014-12-18 17:13:56 +000075
Ted Kremeneke65b0862012-03-06 20:05:56 +000076 CallArgList Args;
Alex Denisovfde64952015-06-26 05:28:36 +000077 const ParmVarDecl *ArgDecl = *BoxingMethod->param_begin();
78 QualType ArgQT = ArgDecl->getType().getUnqualifiedType();
79
80 // ObjCBoxedExpr supports boxing of structs and unions
81 // via [NSValue valueWithBytes:objCType:]
82 const QualType ValueType(SubExpr->getType().getCanonicalType());
83 if (ValueType->isObjCBoxableRecordType()) {
84 // Emit CodeGen for first parameter
85 // and cast value to correct type
John McCall7f416cc2015-09-08 08:05:57 +000086 Address Temporary = CreateMemTemp(SubExpr->getType());
Alex Denisovfde64952015-06-26 05:28:36 +000087 EmitAnyExprToMem(SubExpr, Temporary, Qualifiers(), /*isInit*/ true);
John McCall7f416cc2015-09-08 08:05:57 +000088 Address BitCast = Builder.CreateBitCast(Temporary, ConvertType(ArgQT));
89 Args.add(RValue::get(BitCast.getPointer()), ArgQT);
Alex Denisovfde64952015-06-26 05:28:36 +000090
91 // Create char array to store type encoding
92 std::string Str;
93 getContext().getObjCEncodingForType(ValueType, Str);
John McCall7f416cc2015-09-08 08:05:57 +000094 llvm::Constant *GV = CGM.GetAddrOfConstantCString(Str).getPointer();
Alex Denisovfde64952015-06-26 05:28:36 +000095
96 // Cast type encoding to correct type
97 const ParmVarDecl *EncodingDecl = BoxingMethod->parameters()[1];
98 QualType EncodingQT = EncodingDecl->getType().getUnqualifiedType();
99 llvm::Value *Cast = Builder.CreateBitCast(GV, ConvertType(EncodingQT));
100
101 Args.add(RValue::get(Cast), EncodingQT);
102 } else {
103 Args.add(EmitAnyExpr(SubExpr), ArgQT);
104 }
Alp Toker314cc812014-01-25 16:55:45 +0000105
106 RValue result = Runtime.GenerateMessageSend(
107 *this, ReturnValueSlot(), BoxingMethod->getReturnType(), Sel, Receiver,
108 Args, ClassDecl, BoxingMethod);
Ted Kremeneke65b0862012-03-06 20:05:56 +0000109 return Builder.CreateBitCast(result.getScalarVal(),
110 ConvertType(E->getType()));
111}
112
113llvm::Value *CodeGenFunction::EmitObjCCollectionLiteral(const Expr *E,
Fariborz Jahanian9ad94aa2014-10-28 18:28:16 +0000114 const ObjCMethodDecl *MethodWithObjects) {
Ted Kremeneke65b0862012-03-06 20:05:56 +0000115 ASTContext &Context = CGM.getContext();
Craig Topper8a13c412014-05-21 05:09:00 +0000116 const ObjCDictionaryLiteral *DLE = nullptr;
Ted Kremeneke65b0862012-03-06 20:05:56 +0000117 const ObjCArrayLiteral *ALE = dyn_cast<ObjCArrayLiteral>(E);
118 if (!ALE)
119 DLE = cast<ObjCDictionaryLiteral>(E);
120
121 // Compute the type of the array we're initializing.
122 uint64_t NumElements =
123 ALE ? ALE->getNumElements() : DLE->getNumElements();
124 llvm::APInt APNumElements(Context.getTypeSize(Context.getSizeType()),
125 NumElements);
126 QualType ElementType = Context.getObjCIdType().withConst();
127 QualType ElementArrayType
128 = Context.getConstantArrayType(ElementType, APNumElements,
129 ArrayType::Normal, /*IndexTypeQuals=*/0);
130
131 // Allocate the temporary array(s).
John McCall7f416cc2015-09-08 08:05:57 +0000132 Address Objects = CreateMemTemp(ElementArrayType, "objects");
133 Address Keys = Address::invalid();
Ted Kremeneke65b0862012-03-06 20:05:56 +0000134 if (DLE)
135 Keys = CreateMemTemp(ElementArrayType, "keys");
136
John McCall770a4c12013-04-04 00:20:38 +0000137 // In ARC, we may need to do extra work to keep all the keys and
138 // values alive until after the call.
139 SmallVector<llvm::Value *, 16> NeededObjects;
140 bool TrackNeededObjects =
141 (getLangOpts().ObjCAutoRefCount &&
142 CGM.getCodeGenOpts().OptimizationLevel != 0);
143
Ted Kremeneke65b0862012-03-06 20:05:56 +0000144 // Perform the actual initialialization of the array(s).
145 for (uint64_t i = 0; i < NumElements; i++) {
146 if (ALE) {
John McCall770a4c12013-04-04 00:20:38 +0000147 // Emit the element and store it to the appropriate array slot.
Ted Kremeneke65b0862012-03-06 20:05:56 +0000148 const Expr *Rhs = ALE->getElement(i);
John McCall7f416cc2015-09-08 08:05:57 +0000149 LValue LV = MakeAddrLValue(
150 Builder.CreateConstArrayGEP(Objects, i, getPointerSize()),
151 ElementType, AlignmentSource::Decl);
John McCall770a4c12013-04-04 00:20:38 +0000152
153 llvm::Value *value = EmitScalarExpr(Rhs);
154 EmitStoreThroughLValue(RValue::get(value), LV, true);
155 if (TrackNeededObjects) {
156 NeededObjects.push_back(value);
157 }
Ted Kremeneke65b0862012-03-06 20:05:56 +0000158 } else {
John McCall770a4c12013-04-04 00:20:38 +0000159 // Emit the key and store it to the appropriate array slot.
Ted Kremeneke65b0862012-03-06 20:05:56 +0000160 const Expr *Key = DLE->getKeyValueElement(i).Key;
John McCall7f416cc2015-09-08 08:05:57 +0000161 LValue KeyLV = MakeAddrLValue(
162 Builder.CreateConstArrayGEP(Keys, i, getPointerSize()),
163 ElementType, AlignmentSource::Decl);
John McCall770a4c12013-04-04 00:20:38 +0000164 llvm::Value *keyValue = EmitScalarExpr(Key);
165 EmitStoreThroughLValue(RValue::get(keyValue), KeyLV, /*isInit=*/true);
Ted Kremeneke65b0862012-03-06 20:05:56 +0000166
John McCall770a4c12013-04-04 00:20:38 +0000167 // Emit the value and store it to the appropriate array slot.
David Blaikie1ed728c2015-04-05 22:45:47 +0000168 const Expr *Value = DLE->getKeyValueElement(i).Value;
John McCall7f416cc2015-09-08 08:05:57 +0000169 LValue ValueLV = MakeAddrLValue(
170 Builder.CreateConstArrayGEP(Objects, i, getPointerSize()),
171 ElementType, AlignmentSource::Decl);
John McCall770a4c12013-04-04 00:20:38 +0000172 llvm::Value *valueValue = EmitScalarExpr(Value);
173 EmitStoreThroughLValue(RValue::get(valueValue), ValueLV, /*isInit=*/true);
174 if (TrackNeededObjects) {
175 NeededObjects.push_back(keyValue);
176 NeededObjects.push_back(valueValue);
177 }
Ted Kremeneke65b0862012-03-06 20:05:56 +0000178 }
179 }
180
181 // Generate the argument list.
182 CallArgList Args;
183 ObjCMethodDecl::param_const_iterator PI = MethodWithObjects->param_begin();
184 const ParmVarDecl *argDecl = *PI++;
185 QualType ArgQT = argDecl->getType().getUnqualifiedType();
John McCall7f416cc2015-09-08 08:05:57 +0000186 Args.add(RValue::get(Objects.getPointer()), ArgQT);
Ted Kremeneke65b0862012-03-06 20:05:56 +0000187 if (DLE) {
188 argDecl = *PI++;
189 ArgQT = argDecl->getType().getUnqualifiedType();
John McCall7f416cc2015-09-08 08:05:57 +0000190 Args.add(RValue::get(Keys.getPointer()), ArgQT);
Ted Kremeneke65b0862012-03-06 20:05:56 +0000191 }
192 argDecl = *PI;
193 ArgQT = argDecl->getType().getUnqualifiedType();
194 llvm::Value *Count =
195 llvm::ConstantInt::get(CGM.getTypes().ConvertType(ArgQT), NumElements);
196 Args.add(RValue::get(Count), ArgQT);
197
198 // Generate a reference to the class pointer, which will be the receiver.
199 Selector Sel = MethodWithObjects->getSelector();
200 QualType ResultType = E->getType();
201 const ObjCObjectPointerType *InterfacePointerType
202 = ResultType->getAsObjCInterfacePointerType();
203 ObjCInterfaceDecl *Class
204 = InterfacePointerType->getObjectType()->getInterface();
205 CGObjCRuntime &Runtime = CGM.getObjCRuntime();
John McCall882987f2013-02-28 19:01:20 +0000206 llvm::Value *Receiver = Runtime.GetClass(*this, Class);
Ted Kremeneke65b0862012-03-06 20:05:56 +0000207
208 // Generate the message send.
Alp Toker314cc812014-01-25 16:55:45 +0000209 RValue result = Runtime.GenerateMessageSend(
210 *this, ReturnValueSlot(), MethodWithObjects->getReturnType(), Sel,
211 Receiver, Args, Class, MethodWithObjects);
John McCall770a4c12013-04-04 00:20:38 +0000212
213 // The above message send needs these objects, but in ARC they are
214 // passed in a buffer that is essentially __unsafe_unretained.
215 // Therefore we must prevent the optimizer from releasing them until
216 // after the call.
217 if (TrackNeededObjects) {
218 EmitARCIntrinsicUse(NeededObjects);
219 }
220
Ted Kremeneke65b0862012-03-06 20:05:56 +0000221 return Builder.CreateBitCast(result.getScalarVal(),
222 ConvertType(E->getType()));
223}
224
225llvm::Value *CodeGenFunction::EmitObjCArrayLiteral(const ObjCArrayLiteral *E) {
Fariborz Jahanian9ad94aa2014-10-28 18:28:16 +0000226 return EmitObjCCollectionLiteral(E, E->getArrayWithObjectsMethod());
Ted Kremeneke65b0862012-03-06 20:05:56 +0000227}
228
229llvm::Value *CodeGenFunction::EmitObjCDictionaryLiteral(
230 const ObjCDictionaryLiteral *E) {
Fariborz Jahanian9ad94aa2014-10-28 18:28:16 +0000231 return EmitObjCCollectionLiteral(E, E->getDictWithObjectsMethod());
Ted Kremeneke65b0862012-03-06 20:05:56 +0000232}
233
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000234/// Emit a selector.
235llvm::Value *CodeGenFunction::EmitObjCSelectorExpr(const ObjCSelectorExpr *E) {
236 // Untyped selector.
237 // Note that this implementation allows for non-constant strings to be passed
238 // as arguments to @selector(). Currently, the only thing preventing this
239 // behaviour is the type checking in the front end.
John McCall882987f2013-02-28 19:01:20 +0000240 return CGM.getObjCRuntime().GetSelector(*this, E->getSelector());
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000241}
242
Daniel Dunbar66912a12008-08-20 00:28:19 +0000243llvm::Value *CodeGenFunction::EmitObjCProtocolExpr(const ObjCProtocolExpr *E) {
244 // FIXME: This should pass the Decl not the name.
John McCall882987f2013-02-28 19:01:20 +0000245 return CGM.getObjCRuntime().GenerateProtocolRef(*this, E->getProtocol());
Daniel Dunbar66912a12008-08-20 00:28:19 +0000246}
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000247
Douglas Gregore83b9562015-07-07 03:57:53 +0000248/// \brief Adjust the type of an Objective-C object that doesn't match up due
249/// to type erasure at various points, e.g., related result types or the use
250/// of parameterized classes.
251static RValue AdjustObjCObjectType(CodeGenFunction &CGF, QualType ExpT,
252 RValue Result) {
253 if (!ExpT->isObjCRetainableType())
Douglas Gregor33823722011-06-11 01:09:30 +0000254 return Result;
John McCall31168b02011-06-15 23:02:42 +0000255
Douglas Gregore83b9562015-07-07 03:57:53 +0000256 // If the converted types are the same, we're done.
257 llvm::Type *ExpLLVMTy = CGF.ConvertType(ExpT);
258 if (ExpLLVMTy == Result.getScalarVal()->getType())
Douglas Gregor33823722011-06-11 01:09:30 +0000259 return Result;
Douglas Gregore83b9562015-07-07 03:57:53 +0000260
261 // We have applied a substitution. Cast the rvalue appropriately.
Douglas Gregor33823722011-06-11 01:09:30 +0000262 return RValue::get(CGF.Builder.CreateBitCast(Result.getScalarVal(),
Douglas Gregore83b9562015-07-07 03:57:53 +0000263 ExpLLVMTy));
Douglas Gregor33823722011-06-11 01:09:30 +0000264}
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000265
John McCallcf166702011-07-22 08:53:00 +0000266/// Decide whether to extend the lifetime of the receiver of a
267/// returns-inner-pointer message.
268static bool
269shouldExtendReceiverForInnerPointerMessage(const ObjCMessageExpr *message) {
270 switch (message->getReceiverKind()) {
271
272 // For a normal instance message, we should extend unless the
273 // receiver is loaded from a variable with precise lifetime.
274 case ObjCMessageExpr::Instance: {
275 const Expr *receiver = message->getInstanceReceiver();
John McCall6380a282015-09-09 23:37:17 +0000276
277 // Look through OVEs.
278 if (auto opaque = dyn_cast<OpaqueValueExpr>(receiver)) {
279 if (opaque->getSourceExpr())
280 receiver = opaque->getSourceExpr()->IgnoreParens();
281 }
282
John McCallcf166702011-07-22 08:53:00 +0000283 const ImplicitCastExpr *ice = dyn_cast<ImplicitCastExpr>(receiver);
284 if (!ice || ice->getCastKind() != CK_LValueToRValue) return true;
285 receiver = ice->getSubExpr()->IgnoreParens();
286
John McCall6380a282015-09-09 23:37:17 +0000287 // Look through OVEs.
288 if (auto opaque = dyn_cast<OpaqueValueExpr>(receiver)) {
289 if (opaque->getSourceExpr())
290 receiver = opaque->getSourceExpr()->IgnoreParens();
291 }
292
John McCallcf166702011-07-22 08:53:00 +0000293 // Only __strong variables.
294 if (receiver->getType().getObjCLifetime() != Qualifiers::OCL_Strong)
295 return true;
296
297 // All ivars and fields have precise lifetime.
298 if (isa<MemberExpr>(receiver) || isa<ObjCIvarRefExpr>(receiver))
299 return false;
300
301 // Otherwise, check for variables.
302 const DeclRefExpr *declRef = dyn_cast<DeclRefExpr>(ice->getSubExpr());
303 if (!declRef) return true;
304 const VarDecl *var = dyn_cast<VarDecl>(declRef->getDecl());
305 if (!var) return true;
306
307 // All variables have precise lifetime except local variables with
308 // automatic storage duration that aren't specially marked.
309 return (var->hasLocalStorage() &&
310 !var->hasAttr<ObjCPreciseLifetimeAttr>());
311 }
312
313 case ObjCMessageExpr::Class:
314 case ObjCMessageExpr::SuperClass:
315 // It's never necessary for class objects.
316 return false;
317
318 case ObjCMessageExpr::SuperInstance:
319 // We generally assume that 'self' lives throughout a method call.
320 return false;
321 }
322
323 llvm_unreachable("invalid receiver kind");
324}
325
John McCall460ce582015-10-22 18:38:17 +0000326/// Given an expression of ObjC pointer type, check whether it was
327/// immediately loaded from an ARC __weak l-value.
328static const Expr *findWeakLValue(const Expr *E) {
329 assert(E->getType()->isObjCRetainableType());
330 E = E->IgnoreParens();
331 if (auto CE = dyn_cast<CastExpr>(E)) {
332 if (CE->getCastKind() == CK_LValueToRValue) {
333 if (CE->getSubExpr()->getType().getObjCLifetime() == Qualifiers::OCL_Weak)
334 return CE->getSubExpr();
335 }
336 }
337
338 return nullptr;
339}
340
John McCall78a15112010-05-22 01:48:05 +0000341RValue CodeGenFunction::EmitObjCMessageExpr(const ObjCMessageExpr *E,
342 ReturnValueSlot Return) {
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000343 // Only the lookup mechanism and first two arguments of the method
344 // implementation vary between runtimes. We can get the receiver and
345 // arguments in generic code.
Mike Stump11289f42009-09-09 15:08:12 +0000346
John McCall31168b02011-06-15 23:02:42 +0000347 bool isDelegateInit = E->isDelegateInitCall();
348
John McCallcf166702011-07-22 08:53:00 +0000349 const ObjCMethodDecl *method = E->getMethodDecl();
Fariborz Jahanian715fdd52012-01-29 20:27:13 +0000350
John McCall460ce582015-10-22 18:38:17 +0000351 // If the method is -retain, and the receiver's being loaded from
352 // a __weak variable, peephole the entire operation to objc_loadWeakRetained.
353 if (method && E->getReceiverKind() == ObjCMessageExpr::Instance &&
354 method->getMethodFamily() == OMF_retain) {
355 if (auto lvalueExpr = findWeakLValue(E->getInstanceReceiver())) {
356 LValue lvalue = EmitLValue(lvalueExpr);
357 llvm::Value *result = EmitARCLoadWeakRetained(lvalue.getAddress());
358 return AdjustObjCObjectType(*this, E->getType(), RValue::get(result));
359 }
360 }
361
John McCall31168b02011-06-15 23:02:42 +0000362 // We don't retain the receiver in delegate init calls, and this is
363 // safe because the receiver value is always loaded from 'self',
364 // which we zero out. We don't want to Block_copy block receivers,
365 // though.
366 bool retainSelf =
367 (!isDelegateInit &&
David Blaikiebbafb8a2012-03-11 07:00:24 +0000368 CGM.getLangOpts().ObjCAutoRefCount &&
John McCallcf166702011-07-22 08:53:00 +0000369 method &&
370 method->hasAttr<NSConsumesSelfAttr>());
John McCall31168b02011-06-15 23:02:42 +0000371
Daniel Dunbar8d480592008-08-11 18:12:00 +0000372 CGObjCRuntime &Runtime = CGM.getObjCRuntime();
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000373 bool isSuperMessage = false;
Daniel Dunbarca8531a2008-08-25 08:19:24 +0000374 bool isClassMessage = false;
Craig Topper8a13c412014-05-21 05:09:00 +0000375 ObjCInterfaceDecl *OID = nullptr;
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000376 // Find the receiver
Douglas Gregor33823722011-06-11 01:09:30 +0000377 QualType ReceiverType;
Craig Topper8a13c412014-05-21 05:09:00 +0000378 llvm::Value *Receiver = nullptr;
Douglas Gregor9a129192010-04-21 00:45:42 +0000379 switch (E->getReceiverKind()) {
380 case ObjCMessageExpr::Instance:
Douglas Gregor33823722011-06-11 01:09:30 +0000381 ReceiverType = E->getInstanceReceiver()->getType();
John McCall31168b02011-06-15 23:02:42 +0000382 if (retainSelf) {
383 TryEmitResult ter = tryEmitARCRetainScalarExpr(*this,
384 E->getInstanceReceiver());
385 Receiver = ter.getPointer();
John McCallcf166702011-07-22 08:53:00 +0000386 if (ter.getInt()) retainSelf = false;
John McCall31168b02011-06-15 23:02:42 +0000387 } else
388 Receiver = EmitScalarExpr(E->getInstanceReceiver());
Douglas Gregor9a129192010-04-21 00:45:42 +0000389 break;
Daniel Dunbar7c6d3a72008-08-16 00:25:02 +0000390
Douglas Gregor9a129192010-04-21 00:45:42 +0000391 case ObjCMessageExpr::Class: {
Douglas Gregor33823722011-06-11 01:09:30 +0000392 ReceiverType = E->getClassReceiver();
393 const ObjCObjectType *ObjTy = ReceiverType->getAs<ObjCObjectType>();
John McCall3e294922010-05-17 20:12:43 +0000394 assert(ObjTy && "Invalid Objective-C class message send");
395 OID = ObjTy->getInterface();
396 assert(OID && "Invalid Objective-C class message send");
John McCall882987f2013-02-28 19:01:20 +0000397 Receiver = Runtime.GetClass(*this, OID);
Daniel Dunbarca8531a2008-08-25 08:19:24 +0000398 isClassMessage = true;
Douglas Gregor9a129192010-04-21 00:45:42 +0000399 break;
400 }
401
402 case ObjCMessageExpr::SuperInstance:
Douglas Gregor33823722011-06-11 01:09:30 +0000403 ReceiverType = E->getSuperType();
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000404 Receiver = LoadObjCSelf();
Douglas Gregor9a129192010-04-21 00:45:42 +0000405 isSuperMessage = true;
406 break;
407
408 case ObjCMessageExpr::SuperClass:
Douglas Gregor33823722011-06-11 01:09:30 +0000409 ReceiverType = E->getSuperType();
Douglas Gregor9a129192010-04-21 00:45:42 +0000410 Receiver = LoadObjCSelf();
411 isSuperMessage = true;
412 isClassMessage = true;
413 break;
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000414 }
415
John McCallcf166702011-07-22 08:53:00 +0000416 if (retainSelf)
417 Receiver = EmitARCRetainNonBlock(Receiver);
418
419 // In ARC, we sometimes want to "extend the lifetime"
420 // (i.e. retain+autorelease) of receivers of returns-inner-pointer
421 // messages.
David Blaikiebbafb8a2012-03-11 07:00:24 +0000422 if (getLangOpts().ObjCAutoRefCount && method &&
John McCallcf166702011-07-22 08:53:00 +0000423 method->hasAttr<ObjCReturnsInnerPointerAttr>() &&
424 shouldExtendReceiverForInnerPointerMessage(E))
425 Receiver = EmitARCRetainAutorelease(ReceiverType, Receiver);
426
Alp Toker314cc812014-01-25 16:55:45 +0000427 QualType ResultType = method ? method->getReturnType() : E->getType();
John McCall31168b02011-06-15 23:02:42 +0000428
Daniel Dunbarc722b852008-08-30 03:02:31 +0000429 CallArgList Args;
David Blaikief05779e2015-07-21 18:37:18 +0000430 EmitCallArgs(Args, method, E->arguments());
Mike Stump11289f42009-09-09 15:08:12 +0000431
John McCall31168b02011-06-15 23:02:42 +0000432 // For delegate init calls in ARC, do an unsafe store of null into
433 // self. This represents the call taking direct ownership of that
434 // value. We have to do this after emitting the other call
435 // arguments because they might also reference self, but we don't
436 // have to worry about any of them modifying self because that would
437 // be an undefined read and write of an object in unordered
438 // expressions.
439 if (isDelegateInit) {
David Blaikiebbafb8a2012-03-11 07:00:24 +0000440 assert(getLangOpts().ObjCAutoRefCount &&
John McCall31168b02011-06-15 23:02:42 +0000441 "delegate init calls should only be marked in ARC");
442
443 // Do an unsafe store of null into self.
John McCall7f416cc2015-09-08 08:05:57 +0000444 Address selfAddr =
445 GetAddrOfLocalVar(cast<ObjCMethodDecl>(CurCodeDecl)->getSelfDecl());
John McCall31168b02011-06-15 23:02:42 +0000446 Builder.CreateStore(getNullForVariable(selfAddr), selfAddr);
447 }
Anders Carlsson280e61f12010-06-21 20:59:55 +0000448
Douglas Gregor33823722011-06-11 01:09:30 +0000449 RValue result;
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000450 if (isSuperMessage) {
Chris Lattner6cfec782008-06-26 04:42:20 +0000451 // super is only valid in an Objective-C method
452 const ObjCMethodDecl *OMD = cast<ObjCMethodDecl>(CurFuncDecl);
Fariborz Jahanianbac73ac2009-02-28 20:07:56 +0000453 bool isCategoryImpl = isa<ObjCCategoryImplDecl>(OMD->getDeclContext());
Douglas Gregor33823722011-06-11 01:09:30 +0000454 result = Runtime.GenerateMessageSendSuper(*this, Return, ResultType,
455 E->getSelector(),
456 OMD->getClassInterface(),
457 isCategoryImpl,
458 Receiver,
459 isClassMessage,
460 Args,
John McCallcf166702011-07-22 08:53:00 +0000461 method);
Douglas Gregor33823722011-06-11 01:09:30 +0000462 } else {
Pete Cooper94867712016-03-21 20:50:03 +0000463 result = Runtime.GenerateMessageSend(*this, Return, ResultType,
464 E->getSelector(),
465 Receiver, Args, OID,
466 method);
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000467 }
John McCall31168b02011-06-15 23:02:42 +0000468
469 // For delegate init calls in ARC, implicitly store the result of
470 // the call back into self. This takes ownership of the value.
471 if (isDelegateInit) {
John McCall7f416cc2015-09-08 08:05:57 +0000472 Address selfAddr =
473 GetAddrOfLocalVar(cast<ObjCMethodDecl>(CurCodeDecl)->getSelfDecl());
John McCall31168b02011-06-15 23:02:42 +0000474 llvm::Value *newSelf = result.getScalarVal();
475
476 // The delegate return type isn't necessarily a matching type; in
477 // fact, it's quite likely to be 'id'.
John McCall7f416cc2015-09-08 08:05:57 +0000478 llvm::Type *selfTy = selfAddr.getElementType();
John McCall31168b02011-06-15 23:02:42 +0000479 newSelf = Builder.CreateBitCast(newSelf, selfTy);
480
481 Builder.CreateStore(newSelf, selfAddr);
482 }
Fariborz Jahanian715fdd52012-01-29 20:27:13 +0000483
Douglas Gregore83b9562015-07-07 03:57:53 +0000484 return AdjustObjCObjectType(*this, E->getType(), result);
Anders Carlsson76f4a902007-08-21 17:43:55 +0000485}
486
John McCall31168b02011-06-15 23:02:42 +0000487namespace {
David Blaikie7e70d682015-08-18 22:40:54 +0000488struct FinishARCDealloc final : EHScopeStack::Cleanup {
Craig Topper4f12f102014-03-12 06:41:41 +0000489 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall31168b02011-06-15 23:02:42 +0000490 const ObjCMethodDecl *method = cast<ObjCMethodDecl>(CGF.CurCodeDecl);
John McCalldffafde2011-07-13 18:26:47 +0000491
492 const ObjCImplDecl *impl = cast<ObjCImplDecl>(method->getDeclContext());
John McCall31168b02011-06-15 23:02:42 +0000493 const ObjCInterfaceDecl *iface = impl->getClassInterface();
494 if (!iface->getSuperClass()) return;
495
John McCalldffafde2011-07-13 18:26:47 +0000496 bool isCategory = isa<ObjCCategoryImplDecl>(impl);
497
John McCall31168b02011-06-15 23:02:42 +0000498 // Call [super dealloc] if we have a superclass.
499 llvm::Value *self = CGF.LoadObjCSelf();
500
501 CallArgList args;
502 CGF.CGM.getObjCRuntime().GenerateMessageSendSuper(CGF, ReturnValueSlot(),
503 CGF.getContext().VoidTy,
504 method->getSelector(),
505 iface,
John McCalldffafde2011-07-13 18:26:47 +0000506 isCategory,
John McCall31168b02011-06-15 23:02:42 +0000507 self,
508 /*is class msg*/ false,
509 args,
510 method);
511 }
512};
Alexander Kornienkoab9db512015-06-22 23:07:51 +0000513}
John McCall31168b02011-06-15 23:02:42 +0000514
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000515/// StartObjCMethod - Begin emission of an ObjCMethod. This generates
516/// the LLVM function and sets the other context used by
517/// CodeGenFunction.
Fariborz Jahanian0196a1c2009-01-10 21:06:09 +0000518void CodeGenFunction::StartObjCMethod(const ObjCMethodDecl *OMD,
David Blaikief1425802015-01-14 00:04:42 +0000519 const ObjCContainerDecl *CD) {
520 SourceLocation StartLoc = OMD->getLocStart();
John McCalla738c252011-03-09 04:27:21 +0000521 FunctionArgList args;
Devang Patela2c048e2010-04-05 21:09:15 +0000522 // Check if we should generate debug info for this method.
David Blaikie92848de2013-08-26 20:33:21 +0000523 if (OMD->hasAttr<NoDebugAttr>())
Craig Topper8a13c412014-05-21 05:09:00 +0000524 DebugInfo = nullptr; // disable debug info indefinitely for this function
Devang Patela2c048e2010-04-05 21:09:15 +0000525
Fariborz Jahanian0196a1c2009-01-10 21:06:09 +0000526 llvm::Function *Fn = CGM.getObjCRuntime().GenerateMethod(OMD, CD);
Daniel Dunbar449a3392008-09-04 23:41:35 +0000527
John McCalla729c622012-02-17 03:33:10 +0000528 const CGFunctionInfo &FI = CGM.getTypes().arrangeObjCMethodDeclaration(OMD);
Daniel Dunbarc3e7cff2009-04-17 00:48:04 +0000529 CGM.SetInternalFunctionAttributes(OMD, Fn, FI);
Chris Lattner5696e7b2008-06-17 18:05:57 +0000530
John McCalla738c252011-03-09 04:27:21 +0000531 args.push_back(OMD->getSelfDecl());
532 args.push_back(OMD->getCmdDecl());
Chris Lattner5696e7b2008-06-17 18:05:57 +0000533
Benjamin Kramerf9890422015-02-17 16:48:30 +0000534 args.append(OMD->param_begin(), OMD->param_end());
Chris Lattner5696e7b2008-06-17 18:05:57 +0000535
Peter Collingbourne0ff0b372011-01-13 18:57:25 +0000536 CurGD = OMD;
David Blaikie47d28e02015-01-14 07:10:46 +0000537 CurEHLocation = OMD->getLocEnd();
Peter Collingbourne0ff0b372011-01-13 18:57:25 +0000538
Adrian Prantl42d71b92014-04-10 23:21:53 +0000539 StartFunction(OMD, OMD->getReturnType(), Fn, FI, args,
540 OMD->getLocation(), StartLoc);
John McCall31168b02011-06-15 23:02:42 +0000541
542 // In ARC, certain methods get an extra cleanup.
David Blaikiebbafb8a2012-03-11 07:00:24 +0000543 if (CGM.getLangOpts().ObjCAutoRefCount &&
John McCall31168b02011-06-15 23:02:42 +0000544 OMD->isInstanceMethod() &&
545 OMD->getSelector().isUnarySelector()) {
546 const IdentifierInfo *ident =
547 OMD->getSelector().getIdentifierInfoForSlot(0);
548 if (ident->isStr("dealloc"))
549 EHStack.pushCleanup<FinishARCDealloc>(getARCCleanupKind());
550 }
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000551}
Daniel Dunbara94ecd22008-08-16 03:19:19 +0000552
John McCall31168b02011-06-15 23:02:42 +0000553static llvm::Value *emitARCRetainLoadOfScalar(CodeGenFunction &CGF,
554 LValue lvalue, QualType type);
555
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000556/// Generate an Objective-C method. An Objective-C method is a C function with
Mike Stump11289f42009-09-09 15:08:12 +0000557/// its pointer, name, and types registered in the class struture.
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000558void CodeGenFunction::GenerateObjCMethod(const ObjCMethodDecl *OMD) {
David Blaikief1425802015-01-14 00:04:42 +0000559 StartObjCMethod(OMD, OMD->getClassInterface());
Serge Pavlov3a561452015-12-06 14:32:39 +0000560 PGO.assignRegionCounters(GlobalDecl(OMD), CurFn);
Adrian Prantl56741e22014-01-07 22:05:55 +0000561 assert(isa<CompoundStmt>(OMD->getBody()));
Justin Bogner66242d62015-04-23 23:06:47 +0000562 incrementProfileCounter(OMD->getBody());
Adrian Prantl56741e22014-01-07 22:05:55 +0000563 EmitCompoundStmtWithoutScope(*cast<CompoundStmt>(OMD->getBody()));
Argyrios Kyrtzidisddcd1322009-06-30 02:35:26 +0000564 FinishFunction(OMD->getBodyRBrace());
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000565}
566
John McCallb923ece2011-09-12 23:06:44 +0000567/// emitStructGetterCall - Call the runtime function to load a property
568/// into the return value slot.
569static void emitStructGetterCall(CodeGenFunction &CGF, ObjCIvarDecl *ivar,
570 bool isAtomic, bool hasStrong) {
571 ASTContext &Context = CGF.getContext();
572
John McCall7f416cc2015-09-08 08:05:57 +0000573 Address src =
574 CGF.EmitLValueForIvar(CGF.TypeOfSelfObject(), CGF.LoadObjCSelf(), ivar, 0)
575 .getAddress();
John McCallb923ece2011-09-12 23:06:44 +0000576
577 // objc_copyStruct (ReturnValue, &structIvar,
578 // sizeof (Type of Ivar), isAtomic, false);
579 CallArgList args;
580
John McCall7f416cc2015-09-08 08:05:57 +0000581 Address dest = CGF.Builder.CreateBitCast(CGF.ReturnValue, CGF.VoidPtrTy);
582 args.add(RValue::get(dest.getPointer()), Context.VoidPtrTy);
John McCallb923ece2011-09-12 23:06:44 +0000583
584 src = CGF.Builder.CreateBitCast(src, CGF.VoidPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +0000585 args.add(RValue::get(src.getPointer()), Context.VoidPtrTy);
John McCallb923ece2011-09-12 23:06:44 +0000586
587 CharUnits size = CGF.getContext().getTypeSizeInChars(ivar->getType());
588 args.add(RValue::get(CGF.CGM.getSize(size)), Context.getSizeType());
589 args.add(RValue::get(CGF.Builder.getInt1(isAtomic)), Context.BoolTy);
590 args.add(RValue::get(CGF.Builder.getInt1(hasStrong)), Context.BoolTy);
591
John McCallb92ab1a2016-10-26 23:46:34 +0000592 llvm::Constant *fn = CGF.CGM.getObjCRuntime().GetGetStructFunction();
593 CGCallee callee = CGCallee::forDirect(fn);
John McCallc56a8b32016-03-11 04:30:31 +0000594 CGF.EmitCall(CGF.getTypes().arrangeBuiltinFunctionCall(Context.VoidTy, args),
John McCallb92ab1a2016-10-26 23:46:34 +0000595 callee, ReturnValueSlot(), args);
John McCallb923ece2011-09-12 23:06:44 +0000596}
597
John McCallf4528ae2011-09-13 03:34:09 +0000598/// Determine whether the given architecture supports unaligned atomic
599/// accesses. They don't have to be fast, just faster than a function
600/// call and a mutex.
601static bool hasUnalignedAtomics(llvm::Triple::ArchType arch) {
Eli Friedman5be3e6a2011-09-13 20:48:30 +0000602 // FIXME: Allow unaligned atomic load/store on x86. (It is not
603 // currently supported by the backend.)
604 return 0;
John McCallf4528ae2011-09-13 03:34:09 +0000605}
606
607/// Return the maximum size that permits atomic accesses for the given
608/// architecture.
609static CharUnits getMaxAtomicAccessSize(CodeGenModule &CGM,
610 llvm::Triple::ArchType arch) {
611 // ARM has 8-byte atomic accesses, but it's not clear whether we
612 // want to rely on them here.
613
614 // In the default case, just assume that any size up to a pointer is
615 // fine given adequate alignment.
616 return CharUnits::fromQuantity(CGM.PointerSizeInBytes);
617}
618
619namespace {
620 class PropertyImplStrategy {
621 public:
622 enum StrategyKind {
623 /// The 'native' strategy is to use the architecture's provided
624 /// reads and writes.
625 Native,
626
627 /// Use objc_setProperty and objc_getProperty.
628 GetSetProperty,
629
630 /// Use objc_setProperty for the setter, but use expression
631 /// evaluation for the getter.
632 SetPropertyAndExpressionGet,
633
634 /// Use objc_copyStruct.
635 CopyStruct,
636
637 /// The 'expression' strategy is to emit normal assignment or
638 /// lvalue-to-rvalue expressions.
639 Expression
640 };
641
642 StrategyKind getKind() const { return StrategyKind(Kind); }
643
644 bool hasStrongMember() const { return HasStrong; }
645 bool isAtomic() const { return IsAtomic; }
646 bool isCopy() const { return IsCopy; }
647
648 CharUnits getIvarSize() const { return IvarSize; }
649 CharUnits getIvarAlignment() const { return IvarAlignment; }
650
651 PropertyImplStrategy(CodeGenModule &CGM,
652 const ObjCPropertyImplDecl *propImpl);
653
654 private:
655 unsigned Kind : 8;
656 unsigned IsAtomic : 1;
657 unsigned IsCopy : 1;
658 unsigned HasStrong : 1;
659
660 CharUnits IvarSize;
661 CharUnits IvarAlignment;
662 };
Alexander Kornienkoab9db512015-06-22 23:07:51 +0000663}
John McCallf4528ae2011-09-13 03:34:09 +0000664
Sylvestre Ledru830885c2012-07-23 08:59:39 +0000665/// Pick an implementation strategy for the given property synthesis.
John McCallf4528ae2011-09-13 03:34:09 +0000666PropertyImplStrategy::PropertyImplStrategy(CodeGenModule &CGM,
667 const ObjCPropertyImplDecl *propImpl) {
668 const ObjCPropertyDecl *prop = propImpl->getPropertyDecl();
John McCall43192862011-09-13 18:31:23 +0000669 ObjCPropertyDecl::SetterKind setterKind = prop->getSetterKind();
John McCallf4528ae2011-09-13 03:34:09 +0000670
John McCall43192862011-09-13 18:31:23 +0000671 IsCopy = (setterKind == ObjCPropertyDecl::Copy);
672 IsAtomic = prop->isAtomic();
John McCallf4528ae2011-09-13 03:34:09 +0000673 HasStrong = false; // doesn't matter here.
674
675 // Evaluate the ivar's size and alignment.
676 ObjCIvarDecl *ivar = propImpl->getPropertyIvarDecl();
677 QualType ivarType = ivar->getType();
Benjamin Kramer867ea1d2014-03-02 13:01:17 +0000678 std::tie(IvarSize, IvarAlignment) =
679 CGM.getContext().getTypeInfoInChars(ivarType);
John McCallf4528ae2011-09-13 03:34:09 +0000680
681 // If we have a copy property, we always have to use getProperty/setProperty.
John McCall43192862011-09-13 18:31:23 +0000682 // TODO: we could actually use setProperty and an expression for non-atomics.
John McCallf4528ae2011-09-13 03:34:09 +0000683 if (IsCopy) {
684 Kind = GetSetProperty;
685 return;
686 }
687
John McCall43192862011-09-13 18:31:23 +0000688 // Handle retain.
689 if (setterKind == ObjCPropertyDecl::Retain) {
John McCallf4528ae2011-09-13 03:34:09 +0000690 // In GC-only, there's nothing special that needs to be done.
David Blaikiebbafb8a2012-03-11 07:00:24 +0000691 if (CGM.getLangOpts().getGC() == LangOptions::GCOnly) {
John McCallf4528ae2011-09-13 03:34:09 +0000692 // fallthrough
693
694 // In ARC, if the property is non-atomic, use expression emission,
695 // which translates to objc_storeStrong. This isn't required, but
696 // it's slightly nicer.
David Blaikiebbafb8a2012-03-11 07:00:24 +0000697 } else if (CGM.getLangOpts().ObjCAutoRefCount && !IsAtomic) {
John McCalld8561f02012-08-20 23:36:59 +0000698 // Using standard expression emission for the setter is only
699 // acceptable if the ivar is __strong, which won't be true if
700 // the property is annotated with __attribute__((NSObject)).
701 // TODO: falling all the way back to objc_setProperty here is
702 // just laziness, though; we could still use objc_storeStrong
703 // if we hacked it right.
704 if (ivarType.getObjCLifetime() == Qualifiers::OCL_Strong)
705 Kind = Expression;
706 else
707 Kind = SetPropertyAndExpressionGet;
John McCallf4528ae2011-09-13 03:34:09 +0000708 return;
709
710 // Otherwise, we need to at least use setProperty. However, if
711 // the property isn't atomic, we can use normal expression
712 // emission for the getter.
713 } else if (!IsAtomic) {
714 Kind = SetPropertyAndExpressionGet;
715 return;
716
717 // Otherwise, we have to use both setProperty and getProperty.
718 } else {
719 Kind = GetSetProperty;
720 return;
721 }
722 }
723
724 // If we're not atomic, just use expression accesses.
725 if (!IsAtomic) {
726 Kind = Expression;
727 return;
728 }
729
John McCall0e5c0862011-09-13 05:36:29 +0000730 // Properties on bitfield ivars need to be emitted using expression
731 // accesses even if they're nominally atomic.
732 if (ivar->isBitField()) {
733 Kind = Expression;
734 return;
735 }
736
John McCallf4528ae2011-09-13 03:34:09 +0000737 // GC-qualified or ARC-qualified ivars need to be emitted as
738 // expressions. This actually works out to being atomic anyway,
739 // except for ARC __strong, but that should trigger the above code.
740 if (ivarType.hasNonTrivialObjCLifetime() ||
David Blaikiebbafb8a2012-03-11 07:00:24 +0000741 (CGM.getLangOpts().getGC() &&
John McCallf4528ae2011-09-13 03:34:09 +0000742 CGM.getContext().getObjCGCAttrKind(ivarType))) {
743 Kind = Expression;
744 return;
745 }
746
747 // Compute whether the ivar has strong members.
David Blaikiebbafb8a2012-03-11 07:00:24 +0000748 if (CGM.getLangOpts().getGC())
John McCallf4528ae2011-09-13 03:34:09 +0000749 if (const RecordType *recordType = ivarType->getAs<RecordType>())
750 HasStrong = recordType->getDecl()->hasObjectMember();
751
752 // We can never access structs with object members with a native
753 // access, because we need to use write barriers. This is what
754 // objc_copyStruct is for.
755 if (HasStrong) {
756 Kind = CopyStruct;
757 return;
758 }
759
760 // Otherwise, this is target-dependent and based on the size and
761 // alignment of the ivar.
John McCall0bef0ba2011-09-13 07:33:34 +0000762
763 // If the size of the ivar is not a power of two, give up. We don't
764 // want to get into the business of doing compare-and-swaps.
765 if (!IvarSize.isPowerOfTwo()) {
766 Kind = CopyStruct;
767 return;
768 }
769
John McCallf4528ae2011-09-13 03:34:09 +0000770 llvm::Triple::ArchType arch =
John McCallc8e01702013-04-16 22:48:15 +0000771 CGM.getTarget().getTriple().getArch();
John McCallf4528ae2011-09-13 03:34:09 +0000772
773 // Most architectures require memory to fit within a single cache
774 // line, so the alignment has to be at least the size of the access.
775 // Otherwise we have to grab a lock.
776 if (IvarAlignment < IvarSize && !hasUnalignedAtomics(arch)) {
777 Kind = CopyStruct;
778 return;
779 }
780
781 // If the ivar's size exceeds the architecture's maximum atomic
782 // access size, we have to use CopyStruct.
783 if (IvarSize > getMaxAtomicAccessSize(CGM, arch)) {
784 Kind = CopyStruct;
785 return;
786 }
787
788 // Otherwise, we can use native loads and stores.
789 Kind = Native;
790}
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000791
James Dennettbe302452012-06-15 22:10:14 +0000792/// \brief Generate an Objective-C property getter function.
793///
794/// The given Decl must be an ObjCImplementationDecl. \@synthesize
Steve Naroff5a7dd782009-01-10 22:55:25 +0000795/// is illegal within a category.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +0000796void CodeGenFunction::GenerateObjCGetter(ObjCImplementationDecl *IMP,
797 const ObjCPropertyImplDecl *PID) {
David Blaikie8e6c36e2014-10-14 16:43:46 +0000798 llvm::Constant *AtomicHelperFn =
799 CodeGenFunction(CGM).GenerateObjCAtomicGetterCopyHelperFunction(PID);
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000800 const ObjCPropertyDecl *PD = PID->getPropertyDecl();
801 ObjCMethodDecl *OMD = PD->getGetterMethodDecl();
802 assert(OMD && "Invalid call to generate getter (empty method)");
David Blaikief1425802015-01-14 00:04:42 +0000803 StartObjCMethod(OMD, IMP->getClassInterface());
Mike Stump11289f42009-09-09 15:08:12 +0000804
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +0000805 generateObjCGetterBody(IMP, PID, OMD, AtomicHelperFn);
John McCallf4528ae2011-09-13 03:34:09 +0000806
807 FinishFunction();
808}
809
John McCallbdd81852011-09-13 06:00:03 +0000810static bool hasTrivialGetExpr(const ObjCPropertyImplDecl *propImpl) {
811 const Expr *getter = propImpl->getGetterCXXConstructor();
John McCallf4528ae2011-09-13 03:34:09 +0000812 if (!getter) return true;
813
814 // Sema only makes only of these when the ivar has a C++ class type,
815 // so the form is pretty constrained.
816
John McCallbdd81852011-09-13 06:00:03 +0000817 // If the property has a reference type, we might just be binding a
818 // reference, in which case the result will be a gl-value. We should
819 // treat this as a non-trivial operation.
820 if (getter->isGLValue())
821 return false;
822
John McCallf4528ae2011-09-13 03:34:09 +0000823 // If we selected a trivial copy-constructor, we're okay.
824 if (const CXXConstructExpr *construct = dyn_cast<CXXConstructExpr>(getter))
825 return (construct->getConstructor()->isTrivial());
826
827 // The constructor might require cleanups (in which case it's never
828 // trivial).
829 assert(isa<ExprWithCleanups>(getter));
830 return false;
831}
832
Fariborz Jahaniana08a7472012-01-10 00:37:01 +0000833/// emitCPPObjectAtomicGetterCall - Call the runtime function to
834/// copy the ivar into the resturn slot.
835static void emitCPPObjectAtomicGetterCall(CodeGenFunction &CGF,
836 llvm::Value *returnAddr,
837 ObjCIvarDecl *ivar,
838 llvm::Constant *AtomicHelperFn) {
839 // objc_copyCppObjectAtomic (&returnSlot, &CppObjectIvar,
840 // AtomicHelperFn);
841 CallArgList args;
842
843 // The 1st argument is the return Slot.
844 args.add(RValue::get(returnAddr), CGF.getContext().VoidPtrTy);
845
846 // The 2nd argument is the address of the ivar.
847 llvm::Value *ivarAddr =
John McCall7f416cc2015-09-08 08:05:57 +0000848 CGF.EmitLValueForIvar(CGF.TypeOfSelfObject(),
849 CGF.LoadObjCSelf(), ivar, 0).getPointer();
Fariborz Jahaniana08a7472012-01-10 00:37:01 +0000850 ivarAddr = CGF.Builder.CreateBitCast(ivarAddr, CGF.Int8PtrTy);
851 args.add(RValue::get(ivarAddr), CGF.getContext().VoidPtrTy);
852
853 // Third argument is the helper function.
854 args.add(RValue::get(AtomicHelperFn), CGF.getContext().VoidPtrTy);
855
John McCallb92ab1a2016-10-26 23:46:34 +0000856 llvm::Constant *copyCppAtomicObjectFn =
David Chisnall0d75e062012-12-17 18:54:24 +0000857 CGF.CGM.getObjCRuntime().GetCppAtomicObjectGetFunction();
John McCallb92ab1a2016-10-26 23:46:34 +0000858 CGCallee callee = CGCallee::forDirect(copyCppAtomicObjectFn);
John McCallc56a8b32016-03-11 04:30:31 +0000859 CGF.EmitCall(
860 CGF.getTypes().arrangeBuiltinFunctionCall(CGF.getContext().VoidTy, args),
John McCallb92ab1a2016-10-26 23:46:34 +0000861 callee, ReturnValueSlot(), args);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +0000862}
863
John McCallf4528ae2011-09-13 03:34:09 +0000864void
865CodeGenFunction::generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +0000866 const ObjCPropertyImplDecl *propImpl,
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +0000867 const ObjCMethodDecl *GetterMethodDecl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +0000868 llvm::Constant *AtomicHelperFn) {
John McCallf4528ae2011-09-13 03:34:09 +0000869 // If there's a non-trivial 'get' expression, we just have to emit that.
870 if (!hasTrivialGetExpr(propImpl)) {
Fariborz Jahaniana08a7472012-01-10 00:37:01 +0000871 if (!AtomicHelperFn) {
872 ReturnStmt ret(SourceLocation(), propImpl->getGetterCXXConstructor(),
Craig Topper8a13c412014-05-21 05:09:00 +0000873 /*nrvo*/ nullptr);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +0000874 EmitReturnStmt(ret);
875 }
876 else {
877 ObjCIvarDecl *ivar = propImpl->getPropertyIvarDecl();
John McCall7f416cc2015-09-08 08:05:57 +0000878 emitCPPObjectAtomicGetterCall(*this, ReturnValue.getPointer(),
Fariborz Jahaniana08a7472012-01-10 00:37:01 +0000879 ivar, AtomicHelperFn);
880 }
John McCallf4528ae2011-09-13 03:34:09 +0000881 return;
882 }
883
884 const ObjCPropertyDecl *prop = propImpl->getPropertyDecl();
885 QualType propType = prop->getType();
886 ObjCMethodDecl *getterMethod = prop->getGetterMethodDecl();
887
888 ObjCIvarDecl *ivar = propImpl->getPropertyIvarDecl();
889
890 // Pick an implementation strategy.
891 PropertyImplStrategy strategy(CGM, propImpl);
892 switch (strategy.getKind()) {
893 case PropertyImplStrategy::Native: {
Eli Friedman0e846022012-10-26 22:38:05 +0000894 // We don't need to do anything for a zero-size struct.
895 if (strategy.getIvarSize().isZero())
896 return;
897
John McCallf4528ae2011-09-13 03:34:09 +0000898 LValue LV = EmitLValueForIvar(TypeOfSelfObject(), LoadObjCSelf(), ivar, 0);
899
900 // Currently, all atomic accesses have to be through integer
901 // types, so there's no point in trying to pick a prettier type.
Akira Hatanakade6f25f2016-05-26 00:37:30 +0000902 uint64_t ivarSize = getContext().toBits(strategy.getIvarSize());
903 llvm::Type *bitcastType = llvm::Type::getIntNTy(getLLVMContext(), ivarSize);
John McCallf4528ae2011-09-13 03:34:09 +0000904 bitcastType = bitcastType->getPointerTo(); // addrspace 0 okay
905
906 // Perform an atomic load. This does not impose ordering constraints.
John McCall7f416cc2015-09-08 08:05:57 +0000907 Address ivarAddr = LV.getAddress();
John McCallf4528ae2011-09-13 03:34:09 +0000908 ivarAddr = Builder.CreateBitCast(ivarAddr, bitcastType);
909 llvm::LoadInst *load = Builder.CreateLoad(ivarAddr, "load");
JF Bastien92f4ef12016-04-06 17:26:42 +0000910 load->setAtomic(llvm::AtomicOrdering::Unordered);
John McCallf4528ae2011-09-13 03:34:09 +0000911
912 // Store that value into the return address. Doing this with a
913 // bitcast is likely to produce some pretty ugly IR, but it's not
914 // the *most* terrible thing in the world.
Akira Hatanakade6f25f2016-05-26 00:37:30 +0000915 llvm::Type *retTy = ConvertType(getterMethod->getReturnType());
916 uint64_t retTySize = CGM.getDataLayout().getTypeSizeInBits(retTy);
917 llvm::Value *ivarVal = load;
918 if (ivarSize > retTySize) {
919 llvm::Type *newTy = llvm::Type::getIntNTy(getLLVMContext(), retTySize);
920 ivarVal = Builder.CreateTrunc(load, newTy);
921 bitcastType = newTy->getPointerTo();
922 }
923 Builder.CreateStore(ivarVal,
924 Builder.CreateBitCast(ReturnValue, bitcastType));
John McCallf4528ae2011-09-13 03:34:09 +0000925
926 // Make sure we don't do an autorelease.
927 AutoreleaseResult = false;
928 return;
929 }
930
931 case PropertyImplStrategy::GetSetProperty: {
John McCallb92ab1a2016-10-26 23:46:34 +0000932 llvm::Constant *getPropertyFn =
John McCallf4528ae2011-09-13 03:34:09 +0000933 CGM.getObjCRuntime().GetPropertyGetFunction();
934 if (!getPropertyFn) {
935 CGM.ErrorUnsupported(propImpl, "Obj-C getter requiring atomic copy");
Daniel Dunbara08dff12008-09-24 04:04:31 +0000936 return;
937 }
John McCallb92ab1a2016-10-26 23:46:34 +0000938 CGCallee callee = CGCallee::forDirect(getPropertyFn);
Daniel Dunbara08dff12008-09-24 04:04:31 +0000939
940 // Return (ivar-type) objc_getProperty((id) self, _cmd, offset, true).
941 // FIXME: Can't this be simpler? This might even be worse than the
942 // corresponding gcc code.
John McCallf4528ae2011-09-13 03:34:09 +0000943 llvm::Value *cmd =
John McCall7f416cc2015-09-08 08:05:57 +0000944 Builder.CreateLoad(GetAddrOfLocalVar(getterMethod->getCmdDecl()), "cmd");
John McCallf4528ae2011-09-13 03:34:09 +0000945 llvm::Value *self = Builder.CreateBitCast(LoadObjCSelf(), VoidPtrTy);
946 llvm::Value *ivarOffset =
947 EmitIvarOffset(classImpl->getClassInterface(), ivar);
948
949 CallArgList args;
950 args.add(RValue::get(self), getContext().getObjCIdType());
951 args.add(RValue::get(cmd), getContext().getObjCSelType());
952 args.add(RValue::get(ivarOffset), getContext().getPointerDiffType());
John McCall43192862011-09-13 18:31:23 +0000953 args.add(RValue::get(Builder.getInt1(strategy.isAtomic())),
954 getContext().BoolTy);
John McCallf4528ae2011-09-13 03:34:09 +0000955
Daniel Dunbar1ef73732009-02-03 23:43:59 +0000956 // FIXME: We shouldn't need to get the function info here, the
957 // runtime already should have computed it to build the function.
Fariborz Jahanian13b43042014-01-30 00:16:39 +0000958 llvm::Instruction *CallInstruction;
Samuel Antao798f11c2015-11-23 22:04:44 +0000959 RValue RV = EmitCall(
John McCallc56a8b32016-03-11 04:30:31 +0000960 getTypes().arrangeBuiltinFunctionCall(propType, args),
John McCallb92ab1a2016-10-26 23:46:34 +0000961 callee, ReturnValueSlot(), args, &CallInstruction);
Fariborz Jahanian13b43042014-01-30 00:16:39 +0000962 if (llvm::CallInst *call = dyn_cast<llvm::CallInst>(CallInstruction))
963 call->setTailCall();
John McCallf4528ae2011-09-13 03:34:09 +0000964
Daniel Dunbara08dff12008-09-24 04:04:31 +0000965 // We need to fix the type here. Ivars with copy & retain are
966 // always objects so we don't need to worry about complex or
967 // aggregates.
Alp Toker314cc812014-01-25 16:55:45 +0000968 RV = RValue::get(Builder.CreateBitCast(
969 RV.getScalarVal(),
970 getTypes().ConvertType(getterMethod->getReturnType())));
John McCallf4528ae2011-09-13 03:34:09 +0000971
972 EmitReturnOfRValue(RV, propType);
John McCall31168b02011-06-15 23:02:42 +0000973
974 // objc_getProperty does an autorelease, so we should suppress ours.
975 AutoreleaseResult = false;
John McCall31168b02011-06-15 23:02:42 +0000976
John McCallf4528ae2011-09-13 03:34:09 +0000977 return;
978 }
979
980 case PropertyImplStrategy::CopyStruct:
981 emitStructGetterCall(*this, ivar, strategy.isAtomic(),
982 strategy.hasStrongMember());
983 return;
984
985 case PropertyImplStrategy::Expression:
986 case PropertyImplStrategy::SetPropertyAndExpressionGet: {
987 LValue LV = EmitLValueForIvar(TypeOfSelfObject(), LoadObjCSelf(), ivar, 0);
988
989 QualType ivarType = ivar->getType();
John McCall47fb9502013-03-07 21:37:08 +0000990 switch (getEvaluationKind(ivarType)) {
991 case TEK_Complex: {
Nick Lewycky2d84e842013-10-02 02:29:49 +0000992 ComplexPairTy pair = EmitLoadOfComplex(LV, SourceLocation());
John McCall7f416cc2015-09-08 08:05:57 +0000993 EmitStoreOfComplex(pair, MakeAddrLValue(ReturnValue, ivarType),
John McCall47fb9502013-03-07 21:37:08 +0000994 /*init*/ true);
995 return;
996 }
997 case TEK_Aggregate:
John McCallf4528ae2011-09-13 03:34:09 +0000998 // The return value slot is guaranteed to not be aliased, but
999 // that's not necessarily the same as "on the stack", so
1000 // we still potentially need objc_memmove_collectable.
Chad Rosier615ed1a2012-03-29 17:37:10 +00001001 EmitAggregateCopy(ReturnValue, LV.getAddress(), ivarType);
John McCall47fb9502013-03-07 21:37:08 +00001002 return;
1003 case TEK_Scalar: {
John McCall24fada12011-07-22 05:23:13 +00001004 llvm::Value *value;
1005 if (propType->isReferenceType()) {
John McCall7f416cc2015-09-08 08:05:57 +00001006 value = LV.getAddress().getPointer();
John McCall24fada12011-07-22 05:23:13 +00001007 } else {
1008 // We want to load and autoreleaseReturnValue ARC __weak ivars.
1009 if (LV.getQuals().getObjCLifetime() == Qualifiers::OCL_Weak) {
John McCall460ce582015-10-22 18:38:17 +00001010 if (getLangOpts().ObjCAutoRefCount) {
1011 value = emitARCRetainLoadOfScalar(*this, LV, ivarType);
1012 } else {
1013 value = EmitARCLoadWeak(LV.getAddress());
1014 }
John McCall24fada12011-07-22 05:23:13 +00001015
1016 // Otherwise we want to do a simple load, suppressing the
1017 // final autorelease.
John McCall31168b02011-06-15 23:02:42 +00001018 } else {
Nick Lewycky2d84e842013-10-02 02:29:49 +00001019 value = EmitLoadOfLValue(LV, SourceLocation()).getScalarVal();
John McCall24fada12011-07-22 05:23:13 +00001020 AutoreleaseResult = false;
Fariborz Jahanianb24b5682011-03-28 23:47:18 +00001021 }
John McCall31168b02011-06-15 23:02:42 +00001022
Alp Toker314cc812014-01-25 16:55:45 +00001023 value = Builder.CreateBitCast(
1024 value, ConvertType(GetterMethodDecl->getReturnType()));
John McCall24fada12011-07-22 05:23:13 +00001025 }
1026
1027 EmitReturnOfRValue(RValue::get(value), propType);
John McCall47fb9502013-03-07 21:37:08 +00001028 return;
Fariborz Jahanianeab5ecd2009-03-03 18:49:40 +00001029 }
John McCall47fb9502013-03-07 21:37:08 +00001030 }
1031 llvm_unreachable("bad evaluation kind");
Daniel Dunbara08dff12008-09-24 04:04:31 +00001032 }
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001033
John McCallf4528ae2011-09-13 03:34:09 +00001034 }
1035 llvm_unreachable("bad @property implementation strategy!");
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001036}
1037
John McCallb923ece2011-09-12 23:06:44 +00001038/// emitStructSetterCall - Call the runtime function to store the value
1039/// from the first formal parameter into the given ivar.
1040static void emitStructSetterCall(CodeGenFunction &CGF, ObjCMethodDecl *OMD,
1041 ObjCIvarDecl *ivar) {
Fariborz Jahanian302a3d42011-02-18 19:15:13 +00001042 // objc_copyStruct (&structIvar, &Arg,
1043 // sizeof (struct something), true, false);
John McCall6acaef92011-09-10 09:30:49 +00001044 CallArgList args;
1045
1046 // The first argument is the address of the ivar.
John McCallb923ece2011-09-12 23:06:44 +00001047 llvm::Value *ivarAddr = CGF.EmitLValueForIvar(CGF.TypeOfSelfObject(),
1048 CGF.LoadObjCSelf(), ivar, 0)
John McCall7f416cc2015-09-08 08:05:57 +00001049 .getPointer();
John McCallb923ece2011-09-12 23:06:44 +00001050 ivarAddr = CGF.Builder.CreateBitCast(ivarAddr, CGF.Int8PtrTy);
1051 args.add(RValue::get(ivarAddr), CGF.getContext().VoidPtrTy);
John McCall6acaef92011-09-10 09:30:49 +00001052
1053 // The second argument is the address of the parameter variable.
John McCallb923ece2011-09-12 23:06:44 +00001054 ParmVarDecl *argVar = *OMD->param_begin();
John McCall113bee02012-03-10 09:33:50 +00001055 DeclRefExpr argRef(argVar, false, argVar->getType().getNonReferenceType(),
Fariborz Jahanian088f1bc2012-01-05 00:10:16 +00001056 VK_LValue, SourceLocation());
John McCall7f416cc2015-09-08 08:05:57 +00001057 llvm::Value *argAddr = CGF.EmitLValue(&argRef).getPointer();
John McCallb923ece2011-09-12 23:06:44 +00001058 argAddr = CGF.Builder.CreateBitCast(argAddr, CGF.Int8PtrTy);
1059 args.add(RValue::get(argAddr), CGF.getContext().VoidPtrTy);
John McCall6acaef92011-09-10 09:30:49 +00001060
1061 // The third argument is the sizeof the type.
1062 llvm::Value *size =
John McCallb923ece2011-09-12 23:06:44 +00001063 CGF.CGM.getSize(CGF.getContext().getTypeSizeInChars(ivar->getType()));
1064 args.add(RValue::get(size), CGF.getContext().getSizeType());
John McCall6acaef92011-09-10 09:30:49 +00001065
John McCallb923ece2011-09-12 23:06:44 +00001066 // The fourth argument is the 'isAtomic' flag.
1067 args.add(RValue::get(CGF.Builder.getTrue()), CGF.getContext().BoolTy);
John McCall6acaef92011-09-10 09:30:49 +00001068
John McCallb923ece2011-09-12 23:06:44 +00001069 // The fifth argument is the 'hasStrong' flag.
1070 // FIXME: should this really always be false?
1071 args.add(RValue::get(CGF.Builder.getFalse()), CGF.getContext().BoolTy);
1072
John McCallb92ab1a2016-10-26 23:46:34 +00001073 llvm::Constant *fn = CGF.CGM.getObjCRuntime().GetSetStructFunction();
1074 CGCallee callee = CGCallee::forDirect(fn);
John McCallc56a8b32016-03-11 04:30:31 +00001075 CGF.EmitCall(
1076 CGF.getTypes().arrangeBuiltinFunctionCall(CGF.getContext().VoidTy, args),
John McCallb92ab1a2016-10-26 23:46:34 +00001077 callee, ReturnValueSlot(), args);
Fariborz Jahanian302a3d42011-02-18 19:15:13 +00001078}
1079
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001080/// emitCPPObjectAtomicSetterCall - Call the runtime function to store
1081/// the value from the first formal parameter into the given ivar, using
1082/// the Cpp API for atomic Cpp objects with non-trivial copy assignment.
1083static void emitCPPObjectAtomicSetterCall(CodeGenFunction &CGF,
1084 ObjCMethodDecl *OMD,
1085 ObjCIvarDecl *ivar,
1086 llvm::Constant *AtomicHelperFn) {
1087 // objc_copyCppObjectAtomic (&CppObjectIvar, &Arg,
1088 // AtomicHelperFn);
1089 CallArgList args;
1090
1091 // The first argument is the address of the ivar.
1092 llvm::Value *ivarAddr =
1093 CGF.EmitLValueForIvar(CGF.TypeOfSelfObject(),
John McCall7f416cc2015-09-08 08:05:57 +00001094 CGF.LoadObjCSelf(), ivar, 0).getPointer();
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001095 ivarAddr = CGF.Builder.CreateBitCast(ivarAddr, CGF.Int8PtrTy);
1096 args.add(RValue::get(ivarAddr), CGF.getContext().VoidPtrTy);
1097
1098 // The second argument is the address of the parameter variable.
1099 ParmVarDecl *argVar = *OMD->param_begin();
John McCall113bee02012-03-10 09:33:50 +00001100 DeclRefExpr argRef(argVar, false, argVar->getType().getNonReferenceType(),
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001101 VK_LValue, SourceLocation());
John McCall7f416cc2015-09-08 08:05:57 +00001102 llvm::Value *argAddr = CGF.EmitLValue(&argRef).getPointer();
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001103 argAddr = CGF.Builder.CreateBitCast(argAddr, CGF.Int8PtrTy);
1104 args.add(RValue::get(argAddr), CGF.getContext().VoidPtrTy);
1105
1106 // Third argument is the helper function.
1107 args.add(RValue::get(AtomicHelperFn), CGF.getContext().VoidPtrTy);
1108
John McCallb92ab1a2016-10-26 23:46:34 +00001109 llvm::Constant *fn =
David Chisnall0d75e062012-12-17 18:54:24 +00001110 CGF.CGM.getObjCRuntime().GetCppAtomicObjectSetFunction();
John McCallb92ab1a2016-10-26 23:46:34 +00001111 CGCallee callee = CGCallee::forDirect(fn);
John McCallc56a8b32016-03-11 04:30:31 +00001112 CGF.EmitCall(
1113 CGF.getTypes().arrangeBuiltinFunctionCall(CGF.getContext().VoidTy, args),
John McCallb92ab1a2016-10-26 23:46:34 +00001114 callee, ReturnValueSlot(), args);
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001115}
1116
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00001117
John McCallf4528ae2011-09-13 03:34:09 +00001118static bool hasTrivialSetExpr(const ObjCPropertyImplDecl *PID) {
1119 Expr *setter = PID->getSetterCXXAssignment();
1120 if (!setter) return true;
1121
1122 // Sema only makes only of these when the ivar has a C++ class type,
1123 // so the form is pretty constrained.
John McCall7f16c422011-09-10 09:17:20 +00001124
1125 // An operator call is trivial if the function it calls is trivial.
John McCallf4528ae2011-09-13 03:34:09 +00001126 // This also implies that there's nothing non-trivial going on with
1127 // the arguments, because operator= can only be trivial if it's a
1128 // synthesized assignment operator and therefore both parameters are
1129 // references.
1130 if (CallExpr *call = dyn_cast<CallExpr>(setter)) {
John McCall7f16c422011-09-10 09:17:20 +00001131 if (const FunctionDecl *callee
1132 = dyn_cast_or_null<FunctionDecl>(call->getCalleeDecl()))
1133 if (callee->isTrivial())
1134 return true;
1135 return false;
Fariborz Jahanian5de53132011-04-06 16:05:26 +00001136 }
John McCall7f16c422011-09-10 09:17:20 +00001137
John McCallf4528ae2011-09-13 03:34:09 +00001138 assert(isa<ExprWithCleanups>(setter));
John McCall7f16c422011-09-10 09:17:20 +00001139 return false;
1140}
1141
Benjamin Kramer53ba6362012-03-10 20:38:56 +00001142static bool UseOptimizedSetter(CodeGenModule &CGM) {
David Blaikiebbafb8a2012-03-11 07:00:24 +00001143 if (CGM.getLangOpts().getGC() != LangOptions::NonGC)
Ted Kremeneke65b0862012-03-06 20:05:56 +00001144 return false;
Daniel Dunbarbd847cc2012-10-15 22:23:53 +00001145 return CGM.getLangOpts().ObjCRuntime.hasOptimizedSetter();
Ted Kremeneke65b0862012-03-06 20:05:56 +00001146}
1147
John McCall7f16c422011-09-10 09:17:20 +00001148void
1149CodeGenFunction::generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001150 const ObjCPropertyImplDecl *propImpl,
1151 llvm::Constant *AtomicHelperFn) {
John McCall7f16c422011-09-10 09:17:20 +00001152 const ObjCPropertyDecl *prop = propImpl->getPropertyDecl();
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00001153 ObjCIvarDecl *ivar = propImpl->getPropertyIvarDecl();
John McCall7f16c422011-09-10 09:17:20 +00001154 ObjCMethodDecl *setterMethod = prop->getSetterMethodDecl();
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001155
1156 // Just use the setter expression if Sema gave us one and it's
1157 // non-trivial.
1158 if (!hasTrivialSetExpr(propImpl)) {
1159 if (!AtomicHelperFn)
1160 // If non-atomic, assignment is called directly.
1161 EmitStmt(propImpl->getSetterCXXAssignment());
1162 else
1163 // If atomic, assignment is called via a locking api.
1164 emitCPPObjectAtomicSetterCall(*this, setterMethod, ivar,
1165 AtomicHelperFn);
1166 return;
1167 }
John McCall7f16c422011-09-10 09:17:20 +00001168
John McCallf4528ae2011-09-13 03:34:09 +00001169 PropertyImplStrategy strategy(CGM, propImpl);
1170 switch (strategy.getKind()) {
1171 case PropertyImplStrategy::Native: {
Eli Friedman0e846022012-10-26 22:38:05 +00001172 // We don't need to do anything for a zero-size struct.
1173 if (strategy.getIvarSize().isZero())
1174 return;
1175
John McCall7f416cc2015-09-08 08:05:57 +00001176 Address argAddr = GetAddrOfLocalVar(*setterMethod->param_begin());
John McCall7f16c422011-09-10 09:17:20 +00001177
John McCallf4528ae2011-09-13 03:34:09 +00001178 LValue ivarLValue =
1179 EmitLValueForIvar(TypeOfSelfObject(), LoadObjCSelf(), ivar, /*quals*/ 0);
John McCall7f416cc2015-09-08 08:05:57 +00001180 Address ivarAddr = ivarLValue.getAddress();
John McCall7f16c422011-09-10 09:17:20 +00001181
John McCallf4528ae2011-09-13 03:34:09 +00001182 // Currently, all atomic accesses have to be through integer
1183 // types, so there's no point in trying to pick a prettier type.
1184 llvm::Type *bitcastType =
1185 llvm::Type::getIntNTy(getLLVMContext(),
1186 getContext().toBits(strategy.getIvarSize()));
John McCallf4528ae2011-09-13 03:34:09 +00001187
1188 // Cast both arguments to the chosen operation type.
John McCall7f416cc2015-09-08 08:05:57 +00001189 argAddr = Builder.CreateElementBitCast(argAddr, bitcastType);
1190 ivarAddr = Builder.CreateElementBitCast(ivarAddr, bitcastType);
John McCallf4528ae2011-09-13 03:34:09 +00001191
1192 // This bitcast load is likely to cause some nasty IR.
1193 llvm::Value *load = Builder.CreateLoad(argAddr);
1194
1195 // Perform an atomic store. There are no memory ordering requirements.
1196 llvm::StoreInst *store = Builder.CreateStore(load, ivarAddr);
JF Bastien92f4ef12016-04-06 17:26:42 +00001197 store->setAtomic(llvm::AtomicOrdering::Unordered);
John McCallf4528ae2011-09-13 03:34:09 +00001198 return;
1199 }
1200
1201 case PropertyImplStrategy::GetSetProperty:
1202 case PropertyImplStrategy::SetPropertyAndExpressionGet: {
Craig Topper8a13c412014-05-21 05:09:00 +00001203
John McCallb92ab1a2016-10-26 23:46:34 +00001204 llvm::Constant *setOptimizedPropertyFn = nullptr;
1205 llvm::Constant *setPropertyFn = nullptr;
Ted Kremeneke65b0862012-03-06 20:05:56 +00001206 if (UseOptimizedSetter(CGM)) {
Daniel Dunbarbd847cc2012-10-15 22:23:53 +00001207 // 10.8 and iOS 6.0 code and GC is off
Ted Kremeneke65b0862012-03-06 20:05:56 +00001208 setOptimizedPropertyFn =
Eric Christopher5d2b8d92012-03-29 17:31:31 +00001209 CGM.getObjCRuntime()
1210 .GetOptimizedPropertySetFunction(strategy.isAtomic(),
1211 strategy.isCopy());
Ted Kremeneke65b0862012-03-06 20:05:56 +00001212 if (!setOptimizedPropertyFn) {
1213 CGM.ErrorUnsupported(propImpl, "Obj-C optimized setter - NYI");
1214 return;
1215 }
John McCall7f16c422011-09-10 09:17:20 +00001216 }
Ted Kremeneke65b0862012-03-06 20:05:56 +00001217 else {
1218 setPropertyFn = CGM.getObjCRuntime().GetPropertySetFunction();
1219 if (!setPropertyFn) {
1220 CGM.ErrorUnsupported(propImpl, "Obj-C setter requiring atomic copy");
1221 return;
1222 }
1223 }
1224
John McCall7f16c422011-09-10 09:17:20 +00001225 // Emit objc_setProperty((id) self, _cmd, offset, arg,
1226 // <is-atomic>, <is-copy>).
1227 llvm::Value *cmd =
John McCall7f416cc2015-09-08 08:05:57 +00001228 Builder.CreateLoad(GetAddrOfLocalVar(setterMethod->getCmdDecl()));
John McCall7f16c422011-09-10 09:17:20 +00001229 llvm::Value *self =
1230 Builder.CreateBitCast(LoadObjCSelf(), VoidPtrTy);
1231 llvm::Value *ivarOffset =
1232 EmitIvarOffset(classImpl->getClassInterface(), ivar);
John McCall7f416cc2015-09-08 08:05:57 +00001233 Address argAddr = GetAddrOfLocalVar(*setterMethod->param_begin());
1234 llvm::Value *arg = Builder.CreateLoad(argAddr, "arg");
1235 arg = Builder.CreateBitCast(arg, VoidPtrTy);
John McCall7f16c422011-09-10 09:17:20 +00001236
1237 CallArgList args;
1238 args.add(RValue::get(self), getContext().getObjCIdType());
1239 args.add(RValue::get(cmd), getContext().getObjCSelType());
Ted Kremeneke65b0862012-03-06 20:05:56 +00001240 if (setOptimizedPropertyFn) {
1241 args.add(RValue::get(arg), getContext().getObjCIdType());
1242 args.add(RValue::get(ivarOffset), getContext().getPointerDiffType());
John McCallb92ab1a2016-10-26 23:46:34 +00001243 CGCallee callee = CGCallee::forDirect(setOptimizedPropertyFn);
John McCallc56a8b32016-03-11 04:30:31 +00001244 EmitCall(getTypes().arrangeBuiltinFunctionCall(getContext().VoidTy, args),
John McCallb92ab1a2016-10-26 23:46:34 +00001245 callee, ReturnValueSlot(), args);
Ted Kremeneke65b0862012-03-06 20:05:56 +00001246 } else {
1247 args.add(RValue::get(ivarOffset), getContext().getPointerDiffType());
1248 args.add(RValue::get(arg), getContext().getObjCIdType());
1249 args.add(RValue::get(Builder.getInt1(strategy.isAtomic())),
1250 getContext().BoolTy);
1251 args.add(RValue::get(Builder.getInt1(strategy.isCopy())),
1252 getContext().BoolTy);
1253 // FIXME: We shouldn't need to get the function info here, the runtime
1254 // already should have computed it to build the function.
John McCallb92ab1a2016-10-26 23:46:34 +00001255 CGCallee callee = CGCallee::forDirect(setPropertyFn);
John McCallc56a8b32016-03-11 04:30:31 +00001256 EmitCall(getTypes().arrangeBuiltinFunctionCall(getContext().VoidTy, args),
John McCallb92ab1a2016-10-26 23:46:34 +00001257 callee, ReturnValueSlot(), args);
Ted Kremeneke65b0862012-03-06 20:05:56 +00001258 }
1259
John McCall7f16c422011-09-10 09:17:20 +00001260 return;
1261 }
1262
John McCallf4528ae2011-09-13 03:34:09 +00001263 case PropertyImplStrategy::CopyStruct:
John McCallb923ece2011-09-12 23:06:44 +00001264 emitStructSetterCall(*this, setterMethod, ivar);
John McCall7f16c422011-09-10 09:17:20 +00001265 return;
John McCallf4528ae2011-09-13 03:34:09 +00001266
1267 case PropertyImplStrategy::Expression:
1268 break;
John McCall7f16c422011-09-10 09:17:20 +00001269 }
1270
1271 // Otherwise, fake up some ASTs and emit a normal assignment.
1272 ValueDecl *selfDecl = setterMethod->getSelfDecl();
John McCall113bee02012-03-10 09:33:50 +00001273 DeclRefExpr self(selfDecl, false, selfDecl->getType(),
1274 VK_LValue, SourceLocation());
John McCall7f16c422011-09-10 09:17:20 +00001275 ImplicitCastExpr selfLoad(ImplicitCastExpr::OnStack,
1276 selfDecl->getType(), CK_LValueToRValue, &self,
1277 VK_RValue);
1278 ObjCIvarRefExpr ivarRef(ivar, ivar->getType().getNonReferenceType(),
Fariborz Jahanianf12ff4df2013-04-02 18:57:54 +00001279 SourceLocation(), SourceLocation(),
1280 &selfLoad, true, true);
John McCall7f16c422011-09-10 09:17:20 +00001281
1282 ParmVarDecl *argDecl = *setterMethod->param_begin();
1283 QualType argType = argDecl->getType().getNonReferenceType();
John McCall113bee02012-03-10 09:33:50 +00001284 DeclRefExpr arg(argDecl, false, argType, VK_LValue, SourceLocation());
John McCall7f16c422011-09-10 09:17:20 +00001285 ImplicitCastExpr argLoad(ImplicitCastExpr::OnStack,
1286 argType.getUnqualifiedType(), CK_LValueToRValue,
1287 &arg, VK_RValue);
1288
1289 // The property type can differ from the ivar type in some situations with
1290 // Objective-C pointer types, we can always bit cast the RHS in these cases.
1291 // The following absurdity is just to ensure well-formed IR.
1292 CastKind argCK = CK_NoOp;
1293 if (ivarRef.getType()->isObjCObjectPointerType()) {
1294 if (argLoad.getType()->isObjCObjectPointerType())
1295 argCK = CK_BitCast;
1296 else if (argLoad.getType()->isBlockPointerType())
1297 argCK = CK_BlockPointerToObjCPointerCast;
1298 else
1299 argCK = CK_CPointerToObjCPointerCast;
1300 } else if (ivarRef.getType()->isBlockPointerType()) {
1301 if (argLoad.getType()->isBlockPointerType())
1302 argCK = CK_BitCast;
1303 else
1304 argCK = CK_AnyPointerToBlockPointerCast;
1305 } else if (ivarRef.getType()->isPointerType()) {
1306 argCK = CK_BitCast;
1307 }
1308 ImplicitCastExpr argCast(ImplicitCastExpr::OnStack,
1309 ivarRef.getType(), argCK, &argLoad,
1310 VK_RValue);
1311 Expr *finalArg = &argLoad;
1312 if (!getContext().hasSameUnqualifiedType(ivarRef.getType(),
1313 argLoad.getType()))
1314 finalArg = &argCast;
1315
1316
1317 BinaryOperator assign(&ivarRef, finalArg, BO_Assign,
1318 ivarRef.getType(), VK_RValue, OK_Ordinary,
Lang Hames5de91cc2012-10-02 04:45:10 +00001319 SourceLocation(), false);
John McCall7f16c422011-09-10 09:17:20 +00001320 EmitStmt(&assign);
Fariborz Jahanian5de53132011-04-06 16:05:26 +00001321}
1322
James Dennettbe302452012-06-15 22:10:14 +00001323/// \brief Generate an Objective-C property setter function.
1324///
1325/// The given Decl must be an ObjCImplementationDecl. \@synthesize
Steve Naroff5a7dd782009-01-10 22:55:25 +00001326/// is illegal within a category.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001327void CodeGenFunction::GenerateObjCSetter(ObjCImplementationDecl *IMP,
1328 const ObjCPropertyImplDecl *PID) {
David Blaikie8e6c36e2014-10-14 16:43:46 +00001329 llvm::Constant *AtomicHelperFn =
1330 CodeGenFunction(CGM).GenerateObjCAtomicSetterCopyHelperFunction(PID);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001331 const ObjCPropertyDecl *PD = PID->getPropertyDecl();
1332 ObjCMethodDecl *OMD = PD->getSetterMethodDecl();
1333 assert(OMD && "Invalid call to generate setter (empty method)");
David Blaikief1425802015-01-14 00:04:42 +00001334 StartObjCMethod(OMD, IMP->getClassInterface());
Daniel Dunbar5449ce52008-09-24 06:32:09 +00001335
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001336 generateObjCSetterBody(IMP, PID, AtomicHelperFn);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001337
1338 FinishFunction();
Chris Lattner5696e7b2008-06-17 18:05:57 +00001339}
1340
John McCall6a4fa522011-03-22 07:05:39 +00001341namespace {
David Blaikie7e70d682015-08-18 22:40:54 +00001342 struct DestroyIvar final : EHScopeStack::Cleanup {
John McCall4bd0fb12011-07-12 16:41:08 +00001343 private:
1344 llvm::Value *addr;
John McCall6a4fa522011-03-22 07:05:39 +00001345 const ObjCIvarDecl *ivar;
Peter Collingbourne1425b452012-01-26 03:33:36 +00001346 CodeGenFunction::Destroyer *destroyer;
John McCall4bd0fb12011-07-12 16:41:08 +00001347 bool useEHCleanupForArray;
1348 public:
1349 DestroyIvar(llvm::Value *addr, const ObjCIvarDecl *ivar,
1350 CodeGenFunction::Destroyer *destroyer,
1351 bool useEHCleanupForArray)
Peter Collingbourne1425b452012-01-26 03:33:36 +00001352 : addr(addr), ivar(ivar), destroyer(destroyer),
John McCall4bd0fb12011-07-12 16:41:08 +00001353 useEHCleanupForArray(useEHCleanupForArray) {}
John McCall6a4fa522011-03-22 07:05:39 +00001354
Craig Topper4f12f102014-03-12 06:41:41 +00001355 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall4bd0fb12011-07-12 16:41:08 +00001356 LValue lvalue
1357 = CGF.EmitLValueForIvar(CGF.TypeOfSelfObject(), addr, ivar, /*CVR*/ 0);
1358 CGF.emitDestroy(lvalue.getAddress(), ivar->getType(), destroyer,
John McCall30317fd2011-07-12 20:27:29 +00001359 flags.isForNormalCleanup() && useEHCleanupForArray);
John McCall6a4fa522011-03-22 07:05:39 +00001360 }
1361 };
Alexander Kornienkoab9db512015-06-22 23:07:51 +00001362}
John McCall6a4fa522011-03-22 07:05:39 +00001363
John McCall4bd0fb12011-07-12 16:41:08 +00001364/// Like CodeGenFunction::destroyARCStrong, but do it with a call.
1365static void destroyARCStrongWithStore(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001366 Address addr,
John McCall4bd0fb12011-07-12 16:41:08 +00001367 QualType type) {
1368 llvm::Value *null = getNullForVariable(addr);
1369 CGF.EmitARCStoreStrongCall(addr, null, /*ignored*/ true);
1370}
John McCall31168b02011-06-15 23:02:42 +00001371
John McCall6a4fa522011-03-22 07:05:39 +00001372static void emitCXXDestructMethod(CodeGenFunction &CGF,
1373 ObjCImplementationDecl *impl) {
1374 CodeGenFunction::RunCleanupsScope scope(CGF);
1375
1376 llvm::Value *self = CGF.LoadObjCSelf();
1377
Jordy Rosea91768e2011-07-22 02:08:32 +00001378 const ObjCInterfaceDecl *iface = impl->getClassInterface();
1379 for (const ObjCIvarDecl *ivar = iface->all_declared_ivar_begin();
John McCall6a4fa522011-03-22 07:05:39 +00001380 ivar; ivar = ivar->getNextIvar()) {
1381 QualType type = ivar->getType();
1382
John McCall6a4fa522011-03-22 07:05:39 +00001383 // Check whether the ivar is a destructible type.
John McCall4bd0fb12011-07-12 16:41:08 +00001384 QualType::DestructionKind dtorKind = type.isDestructedType();
1385 if (!dtorKind) continue;
John McCall6a4fa522011-03-22 07:05:39 +00001386
Craig Topper8a13c412014-05-21 05:09:00 +00001387 CodeGenFunction::Destroyer *destroyer = nullptr;
John McCall6a4fa522011-03-22 07:05:39 +00001388
John McCall4bd0fb12011-07-12 16:41:08 +00001389 // Use a call to objc_storeStrong to destroy strong ivars, for the
1390 // general benefit of the tools.
1391 if (dtorKind == QualType::DK_objc_strong_lifetime) {
Peter Collingbourne1425b452012-01-26 03:33:36 +00001392 destroyer = destroyARCStrongWithStore;
John McCall31168b02011-06-15 23:02:42 +00001393
John McCall4bd0fb12011-07-12 16:41:08 +00001394 // Otherwise use the default for the destruction kind.
1395 } else {
Peter Collingbourne1425b452012-01-26 03:33:36 +00001396 destroyer = CGF.getDestroyer(dtorKind);
John McCall6a4fa522011-03-22 07:05:39 +00001397 }
John McCall4bd0fb12011-07-12 16:41:08 +00001398
1399 CleanupKind cleanupKind = CGF.getCleanupKind(dtorKind);
1400
1401 CGF.EHStack.pushCleanup<DestroyIvar>(cleanupKind, self, ivar, destroyer,
1402 cleanupKind & EHCleanup);
John McCall6a4fa522011-03-22 07:05:39 +00001403 }
1404
1405 assert(scope.requiresCleanups() && "nothing to do in .cxx_destruct?");
1406}
1407
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001408void CodeGenFunction::GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1409 ObjCMethodDecl *MD,
1410 bool ctor) {
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001411 MD->createImplicitParams(CGM.getContext(), IMP->getClassInterface());
David Blaikief1425802015-01-14 00:04:42 +00001412 StartObjCMethod(MD, IMP->getClassInterface());
John McCall6a4fa522011-03-22 07:05:39 +00001413
1414 // Emit .cxx_construct.
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001415 if (ctor) {
John McCall31168b02011-06-15 23:02:42 +00001416 // Suppress the final autorelease in ARC.
1417 AutoreleaseResult = false;
1418
Aaron Ballman9bc5f362014-03-13 17:35:02 +00001419 for (const auto *IvarInit : IMP->inits()) {
Francois Pichetd583da02010-12-04 09:14:42 +00001420 FieldDecl *Field = IvarInit->getAnyMember();
Aaron Ballman9bc5f362014-03-13 17:35:02 +00001421 ObjCIvarDecl *Ivar = cast<ObjCIvarDecl>(Field);
Fariborz Jahanian499b9022010-04-28 22:30:33 +00001422 LValue LV = EmitLValueForIvar(TypeOfSelfObject(),
1423 LoadObjCSelf(), Ivar, 0);
John McCall8d6fc952011-08-25 20:40:09 +00001424 EmitAggExpr(IvarInit->getInit(),
1425 AggValueSlot::forLValue(LV, AggValueSlot::IsDestructed,
John McCalla5efa732011-08-25 23:04:34 +00001426 AggValueSlot::DoesNotNeedGCBarriers,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001427 AggValueSlot::IsNotAliased));
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001428 }
1429 // constructor returns 'self'.
1430 CodeGenTypes &Types = CGM.getTypes();
1431 QualType IdTy(CGM.getContext().getObjCIdType());
1432 llvm::Value *SelfAsId =
1433 Builder.CreateBitCast(LoadObjCSelf(), Types.ConvertType(IdTy));
1434 EmitReturnOfRValue(RValue::get(SelfAsId), IdTy);
John McCall6a4fa522011-03-22 07:05:39 +00001435
1436 // Emit .cxx_destruct.
Chandler Carruthf3983652010-05-06 00:20:39 +00001437 } else {
John McCall6a4fa522011-03-22 07:05:39 +00001438 emitCXXDestructMethod(*this, IMP);
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001439 }
1440 FinishFunction();
1441}
1442
Daniel Dunbara08dff12008-09-24 04:04:31 +00001443llvm::Value *CodeGenFunction::LoadObjCSelf() {
John McCalldec348f72013-05-03 07:33:41 +00001444 VarDecl *Self = cast<ObjCMethodDecl>(CurFuncDecl)->getSelfDecl();
1445 DeclRefExpr DRE(Self, /*is enclosing local*/ (CurFuncDecl != CurCodeDecl),
1446 Self->getType(), VK_LValue, SourceLocation());
Nick Lewycky2d84e842013-10-02 02:29:49 +00001447 return EmitLoadOfScalar(EmitDeclRefLValue(&DRE), SourceLocation());
Chris Lattner5696e7b2008-06-17 18:05:57 +00001448}
1449
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00001450QualType CodeGenFunction::TypeOfSelfObject() {
1451 const ObjCMethodDecl *OMD = cast<ObjCMethodDecl>(CurFuncDecl);
1452 ImplicitParamDecl *selfDecl = OMD->getSelfDecl();
Steve Naroff7cae42b2009-07-10 23:34:53 +00001453 const ObjCObjectPointerType *PTy = cast<ObjCObjectPointerType>(
1454 getContext().getCanonicalType(selfDecl->getType()));
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00001455 return PTy->getPointeeType();
1456}
1457
Chris Lattnerd4808922009-03-22 21:03:39 +00001458void CodeGenFunction::EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S){
John McCallb92ab1a2016-10-26 23:46:34 +00001459 llvm::Constant *EnumerationMutationFnPtr =
Daniel Dunbara08dff12008-09-24 04:04:31 +00001460 CGM.getObjCRuntime().EnumerationMutationFunction();
John McCallb92ab1a2016-10-26 23:46:34 +00001461 if (!EnumerationMutationFnPtr) {
Daniel Dunbara08dff12008-09-24 04:04:31 +00001462 CGM.ErrorUnsupported(&S, "Obj-C fast enumeration for this runtime");
1463 return;
1464 }
John McCallb92ab1a2016-10-26 23:46:34 +00001465 CGCallee EnumerationMutationFn =
1466 CGCallee::forDirect(EnumerationMutationFnPtr);
Daniel Dunbara08dff12008-09-24 04:04:31 +00001467
Devang Pateld2d66652011-01-19 01:36:36 +00001468 CGDebugInfo *DI = getDebugInfo();
Eric Christopher7cdf9482011-10-13 21:45:18 +00001469 if (DI)
1470 DI->EmitLexicalBlockStart(Builder, S.getSourceRange().getBegin());
Devang Pateld2d66652011-01-19 01:36:36 +00001471
Devang Patel297207f2011-06-13 23:15:32 +00001472 // The local variable comes into scope immediately.
1473 AutoVarEmission variable = AutoVarEmission::invalid();
1474 if (const DeclStmt *SD = dyn_cast<DeclStmt>(S.getElement()))
1475 variable = EmitAutoVarAlloca(*cast<VarDecl>(SD->getSingleDecl()));
1476
John McCall1c926b72011-01-07 01:49:06 +00001477 JumpDest LoopEnd = getJumpDestInCurrentScope("forcoll.end");
Mike Stump11289f42009-09-09 15:08:12 +00001478
Anders Carlsson75658592008-08-31 02:33:12 +00001479 // Fast enumeration state.
Douglas Gregor636e2002011-08-09 17:23:49 +00001480 QualType StateTy = CGM.getObjCFastEnumerationStateType();
John McCall7f416cc2015-09-08 08:05:57 +00001481 Address StatePtr = CreateMemTemp(StateTy, "state.ptr");
Anders Carlssonc0964b62010-05-22 17:35:42 +00001482 EmitNullInitialization(StatePtr, StateTy);
Mike Stump11289f42009-09-09 15:08:12 +00001483
Anders Carlsson75658592008-08-31 02:33:12 +00001484 // Number of elements in the items array.
Anders Carlsson3f35a262008-08-31 04:05:03 +00001485 static const unsigned NumItems = 16;
Mike Stump11289f42009-09-09 15:08:12 +00001486
John McCall1c926b72011-01-07 01:49:06 +00001487 // Fetch the countByEnumeratingWithState:objects:count: selector.
Benjamin Kramer9e649c32010-03-30 11:36:44 +00001488 IdentifierInfo *II[] = {
1489 &CGM.getContext().Idents.get("countByEnumeratingWithState"),
1490 &CGM.getContext().Idents.get("objects"),
1491 &CGM.getContext().Idents.get("count")
1492 };
1493 Selector FastEnumSel =
1494 CGM.getContext().Selectors.getSelector(llvm::array_lengthof(II), &II[0]);
Anders Carlsson75658592008-08-31 02:33:12 +00001495
1496 QualType ItemsTy =
1497 getContext().getConstantArrayType(getContext().getObjCIdType(),
Mike Stump11289f42009-09-09 15:08:12 +00001498 llvm::APInt(32, NumItems),
Anders Carlsson75658592008-08-31 02:33:12 +00001499 ArrayType::Normal, 0);
John McCall7f416cc2015-09-08 08:05:57 +00001500 Address ItemsPtr = CreateMemTemp(ItemsTy, "items.ptr");
Mike Stump11289f42009-09-09 15:08:12 +00001501
Akira Hatanaka2d3690b2016-04-12 23:10:58 +00001502 RunCleanupsScope ForScope(*this);
1503
John McCall53848232011-07-27 01:07:15 +00001504 // Emit the collection pointer. In ARC, we do a retain.
1505 llvm::Value *Collection;
David Blaikiebbafb8a2012-03-11 07:00:24 +00001506 if (getLangOpts().ObjCAutoRefCount) {
John McCall53848232011-07-27 01:07:15 +00001507 Collection = EmitARCRetainScalarExpr(S.getCollection());
1508
1509 // Enter a cleanup to do the release.
1510 EmitObjCConsumeObject(S.getCollection()->getType(), Collection);
1511 } else {
1512 Collection = EmitScalarExpr(S.getCollection());
1513 }
Mike Stump11289f42009-09-09 15:08:12 +00001514
John McCall91e82dd2011-08-05 00:14:38 +00001515 // The 'continue' label needs to appear within the cleanup for the
1516 // collection object.
1517 JumpDest AfterBody = getJumpDestInCurrentScope("forcoll.next");
1518
John McCall1c926b72011-01-07 01:49:06 +00001519 // Send it our message:
Anders Carlsson75658592008-08-31 02:33:12 +00001520 CallArgList Args;
John McCall1c926b72011-01-07 01:49:06 +00001521
1522 // The first argument is a temporary of the enumeration-state type.
John McCall7f416cc2015-09-08 08:05:57 +00001523 Args.add(RValue::get(StatePtr.getPointer()),
1524 getContext().getPointerType(StateTy));
Mike Stump11289f42009-09-09 15:08:12 +00001525
John McCall1c926b72011-01-07 01:49:06 +00001526 // The second argument is a temporary array with space for NumItems
1527 // pointers. We'll actually be loading elements from the array
1528 // pointer written into the control state; this buffer is so that
1529 // collections that *aren't* backed by arrays can still queue up
1530 // batches of elements.
John McCall7f416cc2015-09-08 08:05:57 +00001531 Args.add(RValue::get(ItemsPtr.getPointer()),
1532 getContext().getPointerType(ItemsTy));
Mike Stump11289f42009-09-09 15:08:12 +00001533
John McCall1c926b72011-01-07 01:49:06 +00001534 // The third argument is the capacity of that temporary array.
Chris Lattner2192fe52011-07-18 04:24:23 +00001535 llvm::Type *UnsignedLongLTy = ConvertType(getContext().UnsignedLongTy);
Owen Andersonb7a2fe62009-07-24 23:12:58 +00001536 llvm::Constant *Count = llvm::ConstantInt::get(UnsignedLongLTy, NumItems);
Eli Friedman43dca6a2011-05-02 17:57:46 +00001537 Args.add(RValue::get(Count), getContext().UnsignedLongTy);
Mike Stump11289f42009-09-09 15:08:12 +00001538
John McCall1c926b72011-01-07 01:49:06 +00001539 // Start the enumeration.
Mike Stump11289f42009-09-09 15:08:12 +00001540 RValue CountRV =
John McCall78a15112010-05-22 01:48:05 +00001541 CGM.getObjCRuntime().GenerateMessageSend(*this, ReturnValueSlot(),
Anders Carlsson75658592008-08-31 02:33:12 +00001542 getContext().UnsignedLongTy,
1543 FastEnumSel,
David Chisnall01aa4672010-04-28 19:33:36 +00001544 Collection, Args);
Anders Carlsson75658592008-08-31 02:33:12 +00001545
John McCall1c926b72011-01-07 01:49:06 +00001546 // The initial number of objects that were returned in the buffer.
1547 llvm::Value *initialBufferLimit = CountRV.getScalarVal();
Mike Stump11289f42009-09-09 15:08:12 +00001548
John McCall1c926b72011-01-07 01:49:06 +00001549 llvm::BasicBlock *EmptyBB = createBasicBlock("forcoll.empty");
1550 llvm::BasicBlock *LoopInitBB = createBasicBlock("forcoll.loopinit");
Mike Stump11289f42009-09-09 15:08:12 +00001551
John McCall1c926b72011-01-07 01:49:06 +00001552 llvm::Value *zero = llvm::Constant::getNullValue(UnsignedLongLTy);
Anders Carlsson75658592008-08-31 02:33:12 +00001553
John McCall1c926b72011-01-07 01:49:06 +00001554 // If the limit pointer was zero to begin with, the collection is
Bob Wilson0ed74d92014-03-25 23:26:31 +00001555 // empty; skip all this. Set the branch weight assuming this has the same
1556 // probability of exiting the loop as any other loop exit.
Justin Bogner66242d62015-04-23 23:06:47 +00001557 uint64_t EntryCount = getCurrentProfileCount();
1558 Builder.CreateCondBr(
1559 Builder.CreateICmpEQ(initialBufferLimit, zero, "iszero"), EmptyBB,
1560 LoopInitBB,
Justin Bogner65512642015-05-02 05:00:55 +00001561 createProfileWeights(EntryCount, getProfileCount(S.getBody())));
Anders Carlsson75658592008-08-31 02:33:12 +00001562
John McCall1c926b72011-01-07 01:49:06 +00001563 // Otherwise, initialize the loop.
1564 EmitBlock(LoopInitBB);
Mike Stump11289f42009-09-09 15:08:12 +00001565
John McCall1c926b72011-01-07 01:49:06 +00001566 // Save the initial mutations value. This is the value at an
1567 // address that was written into the state object by
1568 // countByEnumeratingWithState:objects:count:.
John McCall7f416cc2015-09-08 08:05:57 +00001569 Address StateMutationsPtrPtr = Builder.CreateStructGEP(
1570 StatePtr, 2, 2 * getPointerSize(), "mutationsptr.ptr");
1571 llvm::Value *StateMutationsPtr
1572 = Builder.CreateLoad(StateMutationsPtrPtr, "mutationsptr");
Mike Stump11289f42009-09-09 15:08:12 +00001573
John McCall1c926b72011-01-07 01:49:06 +00001574 llvm::Value *initialMutations =
John McCall7f416cc2015-09-08 08:05:57 +00001575 Builder.CreateAlignedLoad(StateMutationsPtr, getPointerAlign(),
1576 "forcoll.initial-mutations");
Mike Stump11289f42009-09-09 15:08:12 +00001577
John McCall1c926b72011-01-07 01:49:06 +00001578 // Start looping. This is the point we return to whenever we have a
1579 // fresh, non-empty batch of objects.
1580 llvm::BasicBlock *LoopBodyBB = createBasicBlock("forcoll.loopbody");
1581 EmitBlock(LoopBodyBB);
Mike Stump11289f42009-09-09 15:08:12 +00001582
John McCall1c926b72011-01-07 01:49:06 +00001583 // The current index into the buffer.
Jay Foad20c0f022011-03-30 11:28:58 +00001584 llvm::PHINode *index = Builder.CreatePHI(UnsignedLongLTy, 3, "forcoll.index");
John McCall1c926b72011-01-07 01:49:06 +00001585 index->addIncoming(zero, LoopInitBB);
Anders Carlsson75658592008-08-31 02:33:12 +00001586
John McCall1c926b72011-01-07 01:49:06 +00001587 // The current buffer size.
Jay Foad20c0f022011-03-30 11:28:58 +00001588 llvm::PHINode *count = Builder.CreatePHI(UnsignedLongLTy, 3, "forcoll.count");
John McCall1c926b72011-01-07 01:49:06 +00001589 count->addIncoming(initialBufferLimit, LoopInitBB);
Mike Stump11289f42009-09-09 15:08:12 +00001590
Justin Bogner66242d62015-04-23 23:06:47 +00001591 incrementProfileCounter(&S);
Bob Wilson8ab16912014-02-24 01:13:09 +00001592
John McCall1c926b72011-01-07 01:49:06 +00001593 // Check whether the mutations value has changed from where it was
1594 // at start. StateMutationsPtr should actually be invariant between
1595 // refreshes.
Anders Carlsson3f35a262008-08-31 04:05:03 +00001596 StateMutationsPtr = Builder.CreateLoad(StateMutationsPtrPtr, "mutationsptr");
John McCall1c926b72011-01-07 01:49:06 +00001597 llvm::Value *currentMutations
John McCall7f416cc2015-09-08 08:05:57 +00001598 = Builder.CreateAlignedLoad(StateMutationsPtr, getPointerAlign(),
1599 "statemutations");
Anders Carlsson3f35a262008-08-31 04:05:03 +00001600
John McCall1c926b72011-01-07 01:49:06 +00001601 llvm::BasicBlock *WasMutatedBB = createBasicBlock("forcoll.mutated");
Dan Gohman6ca99822011-03-02 22:39:34 +00001602 llvm::BasicBlock *WasNotMutatedBB = createBasicBlock("forcoll.notmutated");
Mike Stump11289f42009-09-09 15:08:12 +00001603
John McCall1c926b72011-01-07 01:49:06 +00001604 Builder.CreateCondBr(Builder.CreateICmpEQ(currentMutations, initialMutations),
1605 WasNotMutatedBB, WasMutatedBB);
Mike Stump11289f42009-09-09 15:08:12 +00001606
John McCall1c926b72011-01-07 01:49:06 +00001607 // If so, call the enumeration-mutation function.
1608 EmitBlock(WasMutatedBB);
Anders Carlsson3f35a262008-08-31 04:05:03 +00001609 llvm::Value *V =
Mike Stump11289f42009-09-09 15:08:12 +00001610 Builder.CreateBitCast(Collection,
Benjamin Kramer76399eb2011-09-27 21:06:10 +00001611 ConvertType(getContext().getObjCIdType()));
Daniel Dunbar84388bf2009-02-03 23:55:40 +00001612 CallArgList Args2;
Eli Friedman43dca6a2011-05-02 17:57:46 +00001613 Args2.add(RValue::get(V), getContext().getObjCIdType());
Mike Stump18bb9282009-05-16 07:57:57 +00001614 // FIXME: We shouldn't need to get the function info here, the runtime already
1615 // should have computed it to build the function.
John McCallc56a8b32016-03-11 04:30:31 +00001616 EmitCall(
1617 CGM.getTypes().arrangeBuiltinFunctionCall(getContext().VoidTy, Args2),
Anders Carlsson61a401c2009-12-24 19:25:24 +00001618 EnumerationMutationFn, ReturnValueSlot(), Args2);
Mike Stump11289f42009-09-09 15:08:12 +00001619
John McCall1c926b72011-01-07 01:49:06 +00001620 // Otherwise, or if the mutation function returns, just continue.
1621 EmitBlock(WasNotMutatedBB);
Mike Stump11289f42009-09-09 15:08:12 +00001622
John McCall1c926b72011-01-07 01:49:06 +00001623 // Initialize the element variable.
1624 RunCleanupsScope elementVariableScope(*this);
John McCall9e2e22f2011-02-22 07:16:58 +00001625 bool elementIsVariable;
John McCall1c926b72011-01-07 01:49:06 +00001626 LValue elementLValue;
1627 QualType elementType;
1628 if (const DeclStmt *SD = dyn_cast<DeclStmt>(S.getElement())) {
John McCall9e2e22f2011-02-22 07:16:58 +00001629 // Initialize the variable, in case it's a __block variable or something.
1630 EmitAutoVarInit(variable);
John McCall1c926b72011-01-07 01:49:06 +00001631
John McCall9e2e22f2011-02-22 07:16:58 +00001632 const VarDecl* D = cast<VarDecl>(SD->getSingleDecl());
John McCall113bee02012-03-10 09:33:50 +00001633 DeclRefExpr tempDRE(const_cast<VarDecl*>(D), false, D->getType(),
John McCall1c926b72011-01-07 01:49:06 +00001634 VK_LValue, SourceLocation());
1635 elementLValue = EmitLValue(&tempDRE);
1636 elementType = D->getType();
John McCall9e2e22f2011-02-22 07:16:58 +00001637 elementIsVariable = true;
John McCalld4631322011-06-17 06:42:21 +00001638
1639 if (D->isARCPseudoStrong())
1640 elementLValue.getQuals().setObjCLifetime(Qualifiers::OCL_ExplicitNone);
John McCall1c926b72011-01-07 01:49:06 +00001641 } else {
1642 elementLValue = LValue(); // suppress warning
1643 elementType = cast<Expr>(S.getElement())->getType();
John McCall9e2e22f2011-02-22 07:16:58 +00001644 elementIsVariable = false;
John McCall1c926b72011-01-07 01:49:06 +00001645 }
Chris Lattner2192fe52011-07-18 04:24:23 +00001646 llvm::Type *convertedElementType = ConvertType(elementType);
John McCall1c926b72011-01-07 01:49:06 +00001647
1648 // Fetch the buffer out of the enumeration state.
1649 // TODO: this pointer should actually be invariant between
1650 // refreshes, which would help us do certain loop optimizations.
John McCall7f416cc2015-09-08 08:05:57 +00001651 Address StateItemsPtr = Builder.CreateStructGEP(
1652 StatePtr, 1, getPointerSize(), "stateitems.ptr");
John McCall1c926b72011-01-07 01:49:06 +00001653 llvm::Value *EnumStateItems =
1654 Builder.CreateLoad(StateItemsPtr, "stateitems");
Anders Carlsson75658592008-08-31 02:33:12 +00001655
John McCall1c926b72011-01-07 01:49:06 +00001656 // Fetch the value at the current index from the buffer.
Mike Stump11289f42009-09-09 15:08:12 +00001657 llvm::Value *CurrentItemPtr =
John McCall1c926b72011-01-07 01:49:06 +00001658 Builder.CreateGEP(EnumStateItems, index, "currentitem.ptr");
John McCall7f416cc2015-09-08 08:05:57 +00001659 llvm::Value *CurrentItem =
1660 Builder.CreateAlignedLoad(CurrentItemPtr, getPointerAlign());
Mike Stump11289f42009-09-09 15:08:12 +00001661
John McCall1c926b72011-01-07 01:49:06 +00001662 // Cast that value to the right type.
1663 CurrentItem = Builder.CreateBitCast(CurrentItem, convertedElementType,
1664 "currentitem");
Mike Stump11289f42009-09-09 15:08:12 +00001665
John McCall1c926b72011-01-07 01:49:06 +00001666 // Make sure we have an l-value. Yes, this gets evaluated every
1667 // time through the loop.
John McCalld4631322011-06-17 06:42:21 +00001668 if (!elementIsVariable) {
John McCall1c926b72011-01-07 01:49:06 +00001669 elementLValue = EmitLValue(cast<Expr>(S.getElement()));
John McCall55e1fbc2011-06-25 02:11:03 +00001670 EmitStoreThroughLValue(RValue::get(CurrentItem), elementLValue);
John McCalld4631322011-06-17 06:42:21 +00001671 } else {
Akira Hatanaka642f7992016-10-18 19:05:41 +00001672 EmitStoreThroughLValue(RValue::get(CurrentItem), elementLValue,
1673 /*isInit*/ true);
John McCalld4631322011-06-17 06:42:21 +00001674 }
Mike Stump11289f42009-09-09 15:08:12 +00001675
John McCall9e2e22f2011-02-22 07:16:58 +00001676 // If we do have an element variable, this assignment is the end of
1677 // its initialization.
1678 if (elementIsVariable)
1679 EmitAutoVarCleanups(variable);
1680
John McCall1c926b72011-01-07 01:49:06 +00001681 // Perform the loop body, setting up break and continue labels.
Bob Wilsonbf854f02014-02-17 19:21:09 +00001682 BreakContinueStack.push_back(BreakContinue(LoopEnd, AfterBody));
John McCall1c926b72011-01-07 01:49:06 +00001683 {
1684 RunCleanupsScope Scope(*this);
1685 EmitStmt(S.getBody());
1686 }
Anders Carlsson75658592008-08-31 02:33:12 +00001687 BreakContinueStack.pop_back();
Mike Stump11289f42009-09-09 15:08:12 +00001688
John McCall1c926b72011-01-07 01:49:06 +00001689 // Destroy the element variable now.
1690 elementVariableScope.ForceCleanup();
1691
1692 // Check whether there are more elements.
John McCallad5d61e2010-07-23 21:56:41 +00001693 EmitBlock(AfterBody.getBlock());
Mike Stump11289f42009-09-09 15:08:12 +00001694
John McCall1c926b72011-01-07 01:49:06 +00001695 llvm::BasicBlock *FetchMoreBB = createBasicBlock("forcoll.refetch");
Fariborz Jahanian6e7ecc82009-01-06 18:56:31 +00001696
John McCall1c926b72011-01-07 01:49:06 +00001697 // First we check in the local buffer.
1698 llvm::Value *indexPlusOne
1699 = Builder.CreateAdd(index, llvm::ConstantInt::get(UnsignedLongLTy, 1));
Anders Carlsson75658592008-08-31 02:33:12 +00001700
John McCall1c926b72011-01-07 01:49:06 +00001701 // If we haven't overrun the buffer yet, we can continue.
Bob Wilson0ed74d92014-03-25 23:26:31 +00001702 // Set the branch weights based on the simplifying assumption that this is
1703 // like a while-loop, i.e., ignoring that the false branch fetches more
1704 // elements and then returns to the loop.
Justin Bogner66242d62015-04-23 23:06:47 +00001705 Builder.CreateCondBr(
1706 Builder.CreateICmpULT(indexPlusOne, count), LoopBodyBB, FetchMoreBB,
Justin Bogner65512642015-05-02 05:00:55 +00001707 createProfileWeights(getProfileCount(S.getBody()), EntryCount));
John McCall1c926b72011-01-07 01:49:06 +00001708
1709 index->addIncoming(indexPlusOne, AfterBody.getBlock());
1710 count->addIncoming(count, AfterBody.getBlock());
1711
1712 // Otherwise, we have to fetch more elements.
1713 EmitBlock(FetchMoreBB);
Mike Stump11289f42009-09-09 15:08:12 +00001714
1715 CountRV =
John McCall78a15112010-05-22 01:48:05 +00001716 CGM.getObjCRuntime().GenerateMessageSend(*this, ReturnValueSlot(),
Anders Carlsson75658592008-08-31 02:33:12 +00001717 getContext().UnsignedLongTy,
Mike Stump11289f42009-09-09 15:08:12 +00001718 FastEnumSel,
David Chisnall01aa4672010-04-28 19:33:36 +00001719 Collection, Args);
Mike Stump11289f42009-09-09 15:08:12 +00001720
John McCall1c926b72011-01-07 01:49:06 +00001721 // If we got a zero count, we're done.
1722 llvm::Value *refetchCount = CountRV.getScalarVal();
1723
1724 // (note that the message send might split FetchMoreBB)
1725 index->addIncoming(zero, Builder.GetInsertBlock());
1726 count->addIncoming(refetchCount, Builder.GetInsertBlock());
1727
1728 Builder.CreateCondBr(Builder.CreateICmpEQ(refetchCount, zero),
1729 EmptyBB, LoopBodyBB);
Mike Stump11289f42009-09-09 15:08:12 +00001730
Anders Carlsson75658592008-08-31 02:33:12 +00001731 // No more elements.
John McCall1c926b72011-01-07 01:49:06 +00001732 EmitBlock(EmptyBB);
Anders Carlsson75658592008-08-31 02:33:12 +00001733
John McCall9e2e22f2011-02-22 07:16:58 +00001734 if (!elementIsVariable) {
Anders Carlsson75658592008-08-31 02:33:12 +00001735 // If the element was not a declaration, set it to be null.
1736
John McCall1c926b72011-01-07 01:49:06 +00001737 llvm::Value *null = llvm::Constant::getNullValue(convertedElementType);
1738 elementLValue = EmitLValue(cast<Expr>(S.getElement()));
John McCall55e1fbc2011-06-25 02:11:03 +00001739 EmitStoreThroughLValue(RValue::get(null), elementLValue);
Anders Carlsson75658592008-08-31 02:33:12 +00001740 }
1741
Eric Christopher7cdf9482011-10-13 21:45:18 +00001742 if (DI)
1743 DI->EmitLexicalBlockEnd(Builder, S.getSourceRange().getEnd());
Devang Pateld2d66652011-01-19 01:36:36 +00001744
Akira Hatanaka2d3690b2016-04-12 23:10:58 +00001745 ForScope.ForceCleanup();
John McCallad5d61e2010-07-23 21:56:41 +00001746 EmitBlock(LoopEnd.getBlock());
Anders Carlsson2e744e82008-08-30 19:51:14 +00001747}
1748
Mike Stump11289f42009-09-09 15:08:12 +00001749void CodeGenFunction::EmitObjCAtTryStmt(const ObjCAtTryStmt &S) {
John McCallbd309292010-07-06 01:34:17 +00001750 CGM.getObjCRuntime().EmitTryStmt(*this, S);
Anders Carlsson1963b0c2008-09-09 10:04:29 +00001751}
1752
Mike Stump11289f42009-09-09 15:08:12 +00001753void CodeGenFunction::EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S) {
Anders Carlsson1963b0c2008-09-09 10:04:29 +00001754 CGM.getObjCRuntime().EmitThrowStmt(*this, S);
1755}
1756
Chris Lattnere132e242008-11-15 21:26:17 +00001757void CodeGenFunction::EmitObjCAtSynchronizedStmt(
Mike Stump11289f42009-09-09 15:08:12 +00001758 const ObjCAtSynchronizedStmt &S) {
John McCallbd309292010-07-06 01:34:17 +00001759 CGM.getObjCRuntime().EmitSynchronizedStmt(*this, S);
Chris Lattnere132e242008-11-15 21:26:17 +00001760}
1761
John McCall31168b02011-06-15 23:02:42 +00001762namespace {
David Blaikie7e70d682015-08-18 22:40:54 +00001763 struct CallObjCRelease final : EHScopeStack::Cleanup {
John McCall9c8e1c92011-08-03 22:24:24 +00001764 CallObjCRelease(llvm::Value *object) : object(object) {}
1765 llvm::Value *object;
John McCall31168b02011-06-15 23:02:42 +00001766
Craig Topper4f12f102014-03-12 06:41:41 +00001767 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCallcdda29c2013-03-13 03:10:54 +00001768 // Releases at the end of the full-expression are imprecise.
1769 CGF.EmitARCRelease(object, ARCImpreciseLifetime);
John McCall31168b02011-06-15 23:02:42 +00001770 }
1771 };
Alexander Kornienkoab9db512015-06-22 23:07:51 +00001772}
John McCall31168b02011-06-15 23:02:42 +00001773
John McCall2d637d22011-09-10 06:18:15 +00001774/// Produce the code for a CK_ARCConsumeObject. Does a primitive
John McCall31168b02011-06-15 23:02:42 +00001775/// release at the end of the full-expression.
1776llvm::Value *CodeGenFunction::EmitObjCConsumeObject(QualType type,
1777 llvm::Value *object) {
1778 // If we're in a conditional branch, we need to make the cleanup
John McCall9c8e1c92011-08-03 22:24:24 +00001779 // conditional.
1780 pushFullExprCleanup<CallObjCRelease>(getARCCleanupKind(), object);
John McCall31168b02011-06-15 23:02:42 +00001781 return object;
1782}
1783
1784llvm::Value *CodeGenFunction::EmitObjCExtendObjectLifetime(QualType type,
1785 llvm::Value *value) {
1786 return EmitARCRetainAutorelease(type, value);
1787}
1788
John McCalleff18842013-03-23 02:35:54 +00001789/// Given a number of pointers, inform the optimizer that they're
1790/// being intrinsically used up until this point in the program.
1791void CodeGenFunction::EmitARCIntrinsicUse(ArrayRef<llvm::Value*> values) {
John McCallb04ecb72015-10-21 18:06:43 +00001792 llvm::Constant *&fn = CGM.getObjCEntrypoints().clang_arc_use;
John McCalleff18842013-03-23 02:35:54 +00001793 if (!fn) {
1794 llvm::FunctionType *fnType =
Craig Topper5fc8fc22014-08-27 06:28:36 +00001795 llvm::FunctionType::get(CGM.VoidTy, None, true);
John McCalleff18842013-03-23 02:35:54 +00001796 fn = CGM.CreateRuntimeFunction(fnType, "clang.arc.use");
1797 }
1798
1799 // This isn't really a "runtime" function, but as an intrinsic it
1800 // doesn't really matter as long as we align things up.
1801 EmitNounwindRuntimeCall(fn, values);
1802}
1803
John McCall31168b02011-06-15 23:02:42 +00001804
Saleem Abdulrasoolc30cec22017-02-11 21:34:18 +00001805static bool IsForwarding(StringRef Name) {
1806 return llvm::StringSwitch<bool>(Name)
1807 .Cases("objc_autoreleaseReturnValue", // ARCInstKind::AutoreleaseRV
1808 "objc_autorelease", // ARCInstKind::Autorelease
1809 "objc_retainAutoreleaseReturnValue", // ARCInstKind::FusedRetainAutoreleaseRV
1810 "objc_retainAutoreleasedReturnValue", // ARCInstKind::RetainRV
1811 "objc_retainAutorelease", // ARCInstKind::FusedRetainAutorelease
1812 "objc_retainedObject", // ARCInstKind::NoopCast
1813 "objc_retain", // ARCInstKind::Retain
1814 "objc_unretainedObject", // ARCInstKind::NoopCast
1815 "objc_unretainedPointer", // ARCInstKind::NoopCast
1816 "objc_unsafeClaimAutoreleasedReturnValue", // ARCInstKind::ClaimRV
1817 true)
1818 .Default(false);
1819}
1820
John McCall31168b02011-06-15 23:02:42 +00001821static llvm::Constant *createARCRuntimeFunction(CodeGenModule &CGM,
Saleem Abdulrasoole60561c2017-02-11 17:24:07 +00001822 llvm::FunctionType *FTy,
1823 StringRef Name) {
1824 llvm::Constant *RTF = CGM.CreateRuntimeFunction(FTy, Name);
John McCall31168b02011-06-15 23:02:42 +00001825
Saleem Abdulrasoole60561c2017-02-11 17:24:07 +00001826 if (auto *F = dyn_cast<llvm::Function>(RTF)) {
Michael Gottesmanbe9614c2013-02-02 01:05:06 +00001827 // If the target runtime doesn't naturally support ARC, emit weak
1828 // references to the runtime support library. We don't really
1829 // permit this to fail, but we need a particular relocation style.
Saleem Abdulrasool6cb07442016-12-15 06:59:05 +00001830 if (!CGM.getLangOpts().ObjCRuntime.hasNativeARC() &&
1831 !CGM.getTriple().isOSBinFormatCOFF()) {
Saleem Abdulrasoole60561c2017-02-11 17:24:07 +00001832 F->setLinkage(llvm::Function::ExternalWeakLinkage);
1833 } else if (Name == "objc_retain" || Name == "objc_release") {
Michael Gottesmancf50e6d2013-02-02 00:57:44 +00001834 // If we have Native ARC, set nonlazybind attribute for these APIs for
1835 // performance.
Saleem Abdulrasoole60561c2017-02-11 17:24:07 +00001836 F->addFnAttr(llvm::Attribute::NonLazyBind);
Michael Gottesmanb46072d2013-02-02 01:03:01 +00001837 }
Saleem Abdulrasoolc30cec22017-02-11 21:34:18 +00001838
1839 if (IsForwarding(Name)) {
1840 llvm::AttrBuilder B;
1841 B.addAttribute(llvm::Attribute::Returned);
1842
1843 F->arg_begin()->addAttr(llvm::AttributeSet::get(F->getContext(), 1, B));
1844 }
Michael Gottesmancf50e6d2013-02-02 00:57:44 +00001845 }
John McCall31168b02011-06-15 23:02:42 +00001846
Saleem Abdulrasoole60561c2017-02-11 17:24:07 +00001847 return RTF;
John McCall31168b02011-06-15 23:02:42 +00001848}
1849
1850/// Perform an operation having the signature
1851/// i8* (i8*)
1852/// where a null input causes a no-op and returns null.
1853static llvm::Value *emitARCValueOperation(CodeGenFunction &CGF,
1854 llvm::Value *value,
1855 llvm::Constant *&fn,
Chad Rosier13799b32012-12-12 17:52:21 +00001856 StringRef fnName,
1857 bool isTailCall = false) {
Saleem Abdulrasoole60561c2017-02-11 17:24:07 +00001858 if (isa<llvm::ConstantPointerNull>(value))
1859 return value;
John McCall31168b02011-06-15 23:02:42 +00001860
1861 if (!fn) {
Chris Lattner2192fe52011-07-18 04:24:23 +00001862 llvm::FunctionType *fnType =
Benjamin Kramer95e19362013-03-07 21:18:31 +00001863 llvm::FunctionType::get(CGF.Int8PtrTy, CGF.Int8PtrTy, false);
John McCall31168b02011-06-15 23:02:42 +00001864 fn = createARCRuntimeFunction(CGF.CGM, fnType, fnName);
1865 }
1866
1867 // Cast the argument to 'id'.
Pete Cooper94867712016-03-21 20:50:03 +00001868 llvm::Type *origType = value->getType();
John McCall31168b02011-06-15 23:02:42 +00001869 value = CGF.Builder.CreateBitCast(value, CGF.Int8PtrTy);
1870
1871 // Call the function.
John McCall882987f2013-02-28 19:01:20 +00001872 llvm::CallInst *call = CGF.EmitNounwindRuntimeCall(fn, value);
Chad Rosier13799b32012-12-12 17:52:21 +00001873 if (isTailCall)
1874 call->setTailCall();
John McCall31168b02011-06-15 23:02:42 +00001875
1876 // Cast the result back to the original type.
1877 return CGF.Builder.CreateBitCast(call, origType);
1878}
1879
1880/// Perform an operation having the following signature:
1881/// i8* (i8**)
1882static llvm::Value *emitARCLoadOperation(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001883 Address addr,
John McCall31168b02011-06-15 23:02:42 +00001884 llvm::Constant *&fn,
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001885 StringRef fnName) {
John McCall31168b02011-06-15 23:02:42 +00001886 if (!fn) {
Chris Lattner2192fe52011-07-18 04:24:23 +00001887 llvm::FunctionType *fnType =
Benjamin Kramer95e19362013-03-07 21:18:31 +00001888 llvm::FunctionType::get(CGF.Int8PtrTy, CGF.Int8PtrPtrTy, false);
John McCall31168b02011-06-15 23:02:42 +00001889 fn = createARCRuntimeFunction(CGF.CGM, fnType, fnName);
1890 }
1891
1892 // Cast the argument to 'id*'.
John McCall7f416cc2015-09-08 08:05:57 +00001893 llvm::Type *origType = addr.getElementType();
John McCall31168b02011-06-15 23:02:42 +00001894 addr = CGF.Builder.CreateBitCast(addr, CGF.Int8PtrPtrTy);
1895
1896 // Call the function.
John McCall7f416cc2015-09-08 08:05:57 +00001897 llvm::Value *result = CGF.EmitNounwindRuntimeCall(fn, addr.getPointer());
John McCall31168b02011-06-15 23:02:42 +00001898
1899 // Cast the result back to a dereference of the original type.
John McCall7f416cc2015-09-08 08:05:57 +00001900 if (origType != CGF.Int8PtrTy)
1901 result = CGF.Builder.CreateBitCast(result, origType);
John McCall31168b02011-06-15 23:02:42 +00001902
1903 return result;
1904}
1905
1906/// Perform an operation having the following signature:
1907/// i8* (i8**, i8*)
1908static llvm::Value *emitARCStoreOperation(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001909 Address addr,
John McCall31168b02011-06-15 23:02:42 +00001910 llvm::Value *value,
1911 llvm::Constant *&fn,
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001912 StringRef fnName,
John McCall31168b02011-06-15 23:02:42 +00001913 bool ignored) {
John McCall7f416cc2015-09-08 08:05:57 +00001914 assert(addr.getElementType() == value->getType());
John McCall31168b02011-06-15 23:02:42 +00001915
1916 if (!fn) {
Benjamin Kramer22d24c22011-10-15 12:20:02 +00001917 llvm::Type *argTypes[] = { CGF.Int8PtrPtrTy, CGF.Int8PtrTy };
John McCall31168b02011-06-15 23:02:42 +00001918
Chris Lattner2192fe52011-07-18 04:24:23 +00001919 llvm::FunctionType *fnType
John McCall31168b02011-06-15 23:02:42 +00001920 = llvm::FunctionType::get(CGF.Int8PtrTy, argTypes, false);
1921 fn = createARCRuntimeFunction(CGF.CGM, fnType, fnName);
1922 }
1923
Chris Lattner2192fe52011-07-18 04:24:23 +00001924 llvm::Type *origType = value->getType();
John McCall31168b02011-06-15 23:02:42 +00001925
John McCall882987f2013-02-28 19:01:20 +00001926 llvm::Value *args[] = {
John McCall7f416cc2015-09-08 08:05:57 +00001927 CGF.Builder.CreateBitCast(addr.getPointer(), CGF.Int8PtrPtrTy),
John McCall882987f2013-02-28 19:01:20 +00001928 CGF.Builder.CreateBitCast(value, CGF.Int8PtrTy)
1929 };
1930 llvm::CallInst *result = CGF.EmitNounwindRuntimeCall(fn, args);
John McCall31168b02011-06-15 23:02:42 +00001931
Craig Topper8a13c412014-05-21 05:09:00 +00001932 if (ignored) return nullptr;
John McCall31168b02011-06-15 23:02:42 +00001933
1934 return CGF.Builder.CreateBitCast(result, origType);
1935}
1936
1937/// Perform an operation having the following signature:
1938/// void (i8**, i8**)
1939static void emitARCCopyOperation(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001940 Address dst,
1941 Address src,
John McCall31168b02011-06-15 23:02:42 +00001942 llvm::Constant *&fn,
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001943 StringRef fnName) {
John McCall7f416cc2015-09-08 08:05:57 +00001944 assert(dst.getType() == src.getType());
John McCall31168b02011-06-15 23:02:42 +00001945
1946 if (!fn) {
Benjamin Kramer95e19362013-03-07 21:18:31 +00001947 llvm::Type *argTypes[] = { CGF.Int8PtrPtrTy, CGF.Int8PtrPtrTy };
1948
Chris Lattner2192fe52011-07-18 04:24:23 +00001949 llvm::FunctionType *fnType
John McCall31168b02011-06-15 23:02:42 +00001950 = llvm::FunctionType::get(CGF.Builder.getVoidTy(), argTypes, false);
1951 fn = createARCRuntimeFunction(CGF.CGM, fnType, fnName);
1952 }
1953
John McCall882987f2013-02-28 19:01:20 +00001954 llvm::Value *args[] = {
John McCall7f416cc2015-09-08 08:05:57 +00001955 CGF.Builder.CreateBitCast(dst.getPointer(), CGF.Int8PtrPtrTy),
1956 CGF.Builder.CreateBitCast(src.getPointer(), CGF.Int8PtrPtrTy)
John McCall882987f2013-02-28 19:01:20 +00001957 };
1958 CGF.EmitNounwindRuntimeCall(fn, args);
John McCall31168b02011-06-15 23:02:42 +00001959}
1960
1961/// Produce the code to do a retain. Based on the type, calls one of:
James Dennett14c41ea2012-06-22 05:41:30 +00001962/// call i8* \@objc_retain(i8* %value)
1963/// call i8* \@objc_retainBlock(i8* %value)
John McCall31168b02011-06-15 23:02:42 +00001964llvm::Value *CodeGenFunction::EmitARCRetain(QualType type, llvm::Value *value) {
1965 if (type->isBlockPointerType())
John McCallff613032011-10-04 06:23:45 +00001966 return EmitARCRetainBlock(value, /*mandatory*/ false);
John McCall31168b02011-06-15 23:02:42 +00001967 else
1968 return EmitARCRetainNonBlock(value);
1969}
1970
1971/// Retain the given object, with normal retain semantics.
James Dennett14c41ea2012-06-22 05:41:30 +00001972/// call i8* \@objc_retain(i8* %value)
Pete Cooper94867712016-03-21 20:50:03 +00001973llvm::Value *CodeGenFunction::EmitARCRetainNonBlock(llvm::Value *value) {
1974 return emitARCValueOperation(*this, value,
John McCallb04ecb72015-10-21 18:06:43 +00001975 CGM.getObjCEntrypoints().objc_retain,
John McCall31168b02011-06-15 23:02:42 +00001976 "objc_retain");
1977}
1978
1979/// Retain the given block, with _Block_copy semantics.
James Dennett14c41ea2012-06-22 05:41:30 +00001980/// call i8* \@objc_retainBlock(i8* %value)
John McCallff613032011-10-04 06:23:45 +00001981///
1982/// \param mandatory - If false, emit the call with metadata
1983/// indicating that it's okay for the optimizer to eliminate this call
1984/// if it can prove that the block never escapes except down the stack.
1985llvm::Value *CodeGenFunction::EmitARCRetainBlock(llvm::Value *value,
1986 bool mandatory) {
1987 llvm::Value *result
Pete Cooper94867712016-03-21 20:50:03 +00001988 = emitARCValueOperation(*this, value,
John McCallb04ecb72015-10-21 18:06:43 +00001989 CGM.getObjCEntrypoints().objc_retainBlock,
John McCallff613032011-10-04 06:23:45 +00001990 "objc_retainBlock");
1991
1992 // If the copy isn't mandatory, add !clang.arc.copy_on_escape to
1993 // tell the optimizer that it doesn't need to do this copy if the
1994 // block doesn't escape, where being passed as an argument doesn't
1995 // count as escaping.
1996 if (!mandatory && isa<llvm::Instruction>(result)) {
1997 llvm::CallInst *call
1998 = cast<llvm::CallInst>(result->stripPointerCasts());
John McCallb04ecb72015-10-21 18:06:43 +00001999 assert(call->getCalledValue() == CGM.getObjCEntrypoints().objc_retainBlock);
John McCallff613032011-10-04 06:23:45 +00002000
John McCallff613032011-10-04 06:23:45 +00002001 call->setMetadata("clang.arc.copy_on_escape",
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002002 llvm::MDNode::get(Builder.getContext(), None));
John McCallff613032011-10-04 06:23:45 +00002003 }
2004
2005 return result;
John McCall31168b02011-06-15 23:02:42 +00002006}
2007
John McCalle399e5b2016-01-27 18:32:30 +00002008static void emitAutoreleasedReturnValueMarker(CodeGenFunction &CGF) {
John McCall31168b02011-06-15 23:02:42 +00002009 // Fetch the void(void) inline asm which marks that we're going to
John McCalle399e5b2016-01-27 18:32:30 +00002010 // do something with the autoreleased return value.
John McCall31168b02011-06-15 23:02:42 +00002011 llvm::InlineAsm *&marker
John McCalle399e5b2016-01-27 18:32:30 +00002012 = CGF.CGM.getObjCEntrypoints().retainAutoreleasedReturnValueMarker;
John McCall31168b02011-06-15 23:02:42 +00002013 if (!marker) {
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002014 StringRef assembly
John McCalle399e5b2016-01-27 18:32:30 +00002015 = CGF.CGM.getTargetCodeGenInfo()
John McCall31168b02011-06-15 23:02:42 +00002016 .getARCRetainAutoreleasedReturnValueMarker();
2017
2018 // If we have an empty assembly string, there's nothing to do.
2019 if (assembly.empty()) {
2020
2021 // Otherwise, at -O0, build an inline asm that we're going to call
2022 // in a moment.
John McCalle399e5b2016-01-27 18:32:30 +00002023 } else if (CGF.CGM.getCodeGenOpts().OptimizationLevel == 0) {
John McCall31168b02011-06-15 23:02:42 +00002024 llvm::FunctionType *type =
John McCalle399e5b2016-01-27 18:32:30 +00002025 llvm::FunctionType::get(CGF.VoidTy, /*variadic*/false);
John McCall31168b02011-06-15 23:02:42 +00002026
2027 marker = llvm::InlineAsm::get(type, assembly, "", /*sideeffects*/ true);
2028
2029 // If we're at -O1 and above, we don't want to litter the code
2030 // with this marker yet, so leave a breadcrumb for the ARC
2031 // optimizer to pick up.
2032 } else {
2033 llvm::NamedMDNode *metadata =
John McCalle399e5b2016-01-27 18:32:30 +00002034 CGF.CGM.getModule().getOrInsertNamedMetadata(
John McCall31168b02011-06-15 23:02:42 +00002035 "clang.arc.retainAutoreleasedReturnValueMarker");
2036 assert(metadata->getNumOperands() <= 1);
2037 if (metadata->getNumOperands() == 0) {
John McCalle399e5b2016-01-27 18:32:30 +00002038 auto &ctx = CGF.getLLVMContext();
2039 metadata->addOperand(llvm::MDNode::get(ctx,
2040 llvm::MDString::get(ctx, assembly)));
John McCall31168b02011-06-15 23:02:42 +00002041 }
2042 }
2043 }
2044
2045 // Call the marker asm if we made one, which we do only at -O0.
David Blaikie43f9bb72015-05-18 22:14:03 +00002046 if (marker)
John McCalle399e5b2016-01-27 18:32:30 +00002047 CGF.Builder.CreateCall(marker);
2048}
John McCall31168b02011-06-15 23:02:42 +00002049
John McCalle399e5b2016-01-27 18:32:30 +00002050/// Retain the given object which is the result of a function call.
2051/// call i8* \@objc_retainAutoreleasedReturnValue(i8* %value)
2052///
2053/// Yes, this function name is one character away from a different
2054/// call with completely different semantics.
2055llvm::Value *
2056CodeGenFunction::EmitARCRetainAutoreleasedReturnValue(llvm::Value *value) {
2057 emitAutoreleasedReturnValueMarker(*this);
Pete Cooper94867712016-03-21 20:50:03 +00002058 return emitARCValueOperation(*this, value,
John McCalle399e5b2016-01-27 18:32:30 +00002059 CGM.getObjCEntrypoints().objc_retainAutoreleasedReturnValue,
John McCall31168b02011-06-15 23:02:42 +00002060 "objc_retainAutoreleasedReturnValue");
2061}
2062
John McCalle399e5b2016-01-27 18:32:30 +00002063/// Claim a possibly-autoreleased return value at +0. This is only
2064/// valid to do in contexts which do not rely on the retain to keep
2065/// the object valid for for all of its uses; for example, when
2066/// the value is ignored, or when it is being assigned to an
2067/// __unsafe_unretained variable.
2068///
2069/// call i8* \@objc_unsafeClaimAutoreleasedReturnValue(i8* %value)
2070llvm::Value *
2071CodeGenFunction::EmitARCUnsafeClaimAutoreleasedReturnValue(llvm::Value *value) {
2072 emitAutoreleasedReturnValueMarker(*this);
Pete Cooper94867712016-03-21 20:50:03 +00002073 return emitARCValueOperation(*this, value,
John McCalle399e5b2016-01-27 18:32:30 +00002074 CGM.getObjCEntrypoints().objc_unsafeClaimAutoreleasedReturnValue,
2075 "objc_unsafeClaimAutoreleasedReturnValue");
2076}
2077
John McCall31168b02011-06-15 23:02:42 +00002078/// Release the given object.
James Dennett14c41ea2012-06-22 05:41:30 +00002079/// call void \@objc_release(i8* %value)
John McCallcdda29c2013-03-13 03:10:54 +00002080void CodeGenFunction::EmitARCRelease(llvm::Value *value,
2081 ARCPreciseLifetime_t precise) {
John McCall31168b02011-06-15 23:02:42 +00002082 if (isa<llvm::ConstantPointerNull>(value)) return;
2083
John McCallb04ecb72015-10-21 18:06:43 +00002084 llvm::Constant *&fn = CGM.getObjCEntrypoints().objc_release;
John McCall31168b02011-06-15 23:02:42 +00002085 if (!fn) {
Chris Lattner2192fe52011-07-18 04:24:23 +00002086 llvm::FunctionType *fnType =
Benjamin Kramer95e19362013-03-07 21:18:31 +00002087 llvm::FunctionType::get(Builder.getVoidTy(), Int8PtrTy, false);
John McCall31168b02011-06-15 23:02:42 +00002088 fn = createARCRuntimeFunction(CGM, fnType, "objc_release");
2089 }
2090
2091 // Cast the argument to 'id'.
2092 value = Builder.CreateBitCast(value, Int8PtrTy);
2093
2094 // Call objc_release.
John McCall882987f2013-02-28 19:01:20 +00002095 llvm::CallInst *call = EmitNounwindRuntimeCall(fn, value);
John McCall31168b02011-06-15 23:02:42 +00002096
John McCallcdda29c2013-03-13 03:10:54 +00002097 if (precise == ARCImpreciseLifetime) {
John McCall31168b02011-06-15 23:02:42 +00002098 call->setMetadata("clang.imprecise_release",
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002099 llvm::MDNode::get(Builder.getContext(), None));
John McCall31168b02011-06-15 23:02:42 +00002100 }
2101}
2102
John McCalle68b8f42012-10-17 02:28:37 +00002103/// Destroy a __strong variable.
2104///
2105/// At -O0, emit a call to store 'null' into the address;
2106/// instrumenting tools prefer this because the address is exposed,
2107/// but it's relatively cumbersome to optimize.
2108///
2109/// At -O1 and above, just load and call objc_release.
2110///
2111/// call void \@objc_storeStrong(i8** %addr, i8* null)
John McCall7f416cc2015-09-08 08:05:57 +00002112void CodeGenFunction::EmitARCDestroyStrong(Address addr,
John McCallcdda29c2013-03-13 03:10:54 +00002113 ARCPreciseLifetime_t precise) {
John McCalle68b8f42012-10-17 02:28:37 +00002114 if (CGM.getCodeGenOpts().OptimizationLevel == 0) {
John McCall7f416cc2015-09-08 08:05:57 +00002115 llvm::Value *null = getNullForVariable(addr);
John McCalle68b8f42012-10-17 02:28:37 +00002116 EmitARCStoreStrongCall(addr, null, /*ignored*/ true);
2117 return;
2118 }
2119
2120 llvm::Value *value = Builder.CreateLoad(addr);
2121 EmitARCRelease(value, precise);
2122}
2123
John McCall31168b02011-06-15 23:02:42 +00002124/// Store into a strong object. Always calls this:
James Dennett14c41ea2012-06-22 05:41:30 +00002125/// call void \@objc_storeStrong(i8** %addr, i8* %value)
John McCall7f416cc2015-09-08 08:05:57 +00002126llvm::Value *CodeGenFunction::EmitARCStoreStrongCall(Address addr,
John McCall31168b02011-06-15 23:02:42 +00002127 llvm::Value *value,
2128 bool ignored) {
John McCall7f416cc2015-09-08 08:05:57 +00002129 assert(addr.getElementType() == value->getType());
John McCall31168b02011-06-15 23:02:42 +00002130
John McCallb04ecb72015-10-21 18:06:43 +00002131 llvm::Constant *&fn = CGM.getObjCEntrypoints().objc_storeStrong;
John McCall31168b02011-06-15 23:02:42 +00002132 if (!fn) {
Chris Lattnera5f58b02011-07-09 17:41:47 +00002133 llvm::Type *argTypes[] = { Int8PtrPtrTy, Int8PtrTy };
Chris Lattner2192fe52011-07-18 04:24:23 +00002134 llvm::FunctionType *fnType
John McCall31168b02011-06-15 23:02:42 +00002135 = llvm::FunctionType::get(Builder.getVoidTy(), argTypes, false);
2136 fn = createARCRuntimeFunction(CGM, fnType, "objc_storeStrong");
2137 }
2138
John McCall882987f2013-02-28 19:01:20 +00002139 llvm::Value *args[] = {
John McCall7f416cc2015-09-08 08:05:57 +00002140 Builder.CreateBitCast(addr.getPointer(), Int8PtrPtrTy),
John McCall882987f2013-02-28 19:01:20 +00002141 Builder.CreateBitCast(value, Int8PtrTy)
2142 };
2143 EmitNounwindRuntimeCall(fn, args);
John McCall31168b02011-06-15 23:02:42 +00002144
Craig Topper8a13c412014-05-21 05:09:00 +00002145 if (ignored) return nullptr;
John McCall31168b02011-06-15 23:02:42 +00002146 return value;
2147}
2148
2149/// Store into a strong object. Sometimes calls this:
James Dennett14c41ea2012-06-22 05:41:30 +00002150/// call void \@objc_storeStrong(i8** %addr, i8* %value)
John McCall31168b02011-06-15 23:02:42 +00002151/// Other times, breaks it down into components.
John McCall55e1fbc2011-06-25 02:11:03 +00002152llvm::Value *CodeGenFunction::EmitARCStoreStrong(LValue dst,
John McCall31168b02011-06-15 23:02:42 +00002153 llvm::Value *newValue,
2154 bool ignored) {
John McCall55e1fbc2011-06-25 02:11:03 +00002155 QualType type = dst.getType();
John McCall31168b02011-06-15 23:02:42 +00002156 bool isBlock = type->isBlockPointerType();
2157
2158 // Use a store barrier at -O0 unless this is a block type or the
2159 // lvalue is inadequately aligned.
2160 if (shouldUseFusedARCCalls() &&
2161 !isBlock &&
Eli Friedmana0544d62011-12-03 04:14:32 +00002162 (dst.getAlignment().isZero() ||
2163 dst.getAlignment() >= CharUnits::fromQuantity(PointerAlignInBytes))) {
John McCall31168b02011-06-15 23:02:42 +00002164 return EmitARCStoreStrongCall(dst.getAddress(), newValue, ignored);
2165 }
2166
2167 // Otherwise, split it out.
2168
2169 // Retain the new value.
2170 newValue = EmitARCRetain(type, newValue);
2171
2172 // Read the old value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002173 llvm::Value *oldValue = EmitLoadOfScalar(dst, SourceLocation());
John McCall31168b02011-06-15 23:02:42 +00002174
2175 // Store. We do this before the release so that any deallocs won't
2176 // see the old value.
John McCall55e1fbc2011-06-25 02:11:03 +00002177 EmitStoreOfScalar(newValue, dst);
John McCall31168b02011-06-15 23:02:42 +00002178
2179 // Finally, release the old value.
John McCallcdda29c2013-03-13 03:10:54 +00002180 EmitARCRelease(oldValue, dst.isARCPreciseLifetime());
John McCall31168b02011-06-15 23:02:42 +00002181
2182 return newValue;
2183}
2184
2185/// Autorelease the given object.
James Dennett14c41ea2012-06-22 05:41:30 +00002186/// call i8* \@objc_autorelease(i8* %value)
Pete Cooper94867712016-03-21 20:50:03 +00002187llvm::Value *CodeGenFunction::EmitARCAutorelease(llvm::Value *value) {
2188 return emitARCValueOperation(*this, value,
John McCallb04ecb72015-10-21 18:06:43 +00002189 CGM.getObjCEntrypoints().objc_autorelease,
John McCall31168b02011-06-15 23:02:42 +00002190 "objc_autorelease");
2191}
2192
2193/// Autorelease the given object.
James Dennett14c41ea2012-06-22 05:41:30 +00002194/// call i8* \@objc_autoreleaseReturnValue(i8* %value)
John McCall31168b02011-06-15 23:02:42 +00002195llvm::Value *
2196CodeGenFunction::EmitARCAutoreleaseReturnValue(llvm::Value *value) {
Pete Cooper94867712016-03-21 20:50:03 +00002197 return emitARCValueOperation(*this, value,
John McCallb04ecb72015-10-21 18:06:43 +00002198 CGM.getObjCEntrypoints().objc_autoreleaseReturnValue,
Chad Rosier13799b32012-12-12 17:52:21 +00002199 "objc_autoreleaseReturnValue",
2200 /*isTailCall*/ true);
John McCall31168b02011-06-15 23:02:42 +00002201}
2202
2203/// Do a fused retain/autorelease of the given object.
James Dennett14c41ea2012-06-22 05:41:30 +00002204/// call i8* \@objc_retainAutoreleaseReturnValue(i8* %value)
John McCall31168b02011-06-15 23:02:42 +00002205llvm::Value *
2206CodeGenFunction::EmitARCRetainAutoreleaseReturnValue(llvm::Value *value) {
Pete Cooper94867712016-03-21 20:50:03 +00002207 return emitARCValueOperation(*this, value,
John McCallb04ecb72015-10-21 18:06:43 +00002208 CGM.getObjCEntrypoints().objc_retainAutoreleaseReturnValue,
Chad Rosier13799b32012-12-12 17:52:21 +00002209 "objc_retainAutoreleaseReturnValue",
2210 /*isTailCall*/ true);
John McCall31168b02011-06-15 23:02:42 +00002211}
2212
2213/// Do a fused retain/autorelease of the given object.
James Dennett14c41ea2012-06-22 05:41:30 +00002214/// call i8* \@objc_retainAutorelease(i8* %value)
John McCall31168b02011-06-15 23:02:42 +00002215/// or
James Dennett14c41ea2012-06-22 05:41:30 +00002216/// %retain = call i8* \@objc_retainBlock(i8* %value)
2217/// call i8* \@objc_autorelease(i8* %retain)
John McCall31168b02011-06-15 23:02:42 +00002218llvm::Value *CodeGenFunction::EmitARCRetainAutorelease(QualType type,
2219 llvm::Value *value) {
2220 if (!type->isBlockPointerType())
2221 return EmitARCRetainAutoreleaseNonBlock(value);
2222
2223 if (isa<llvm::ConstantPointerNull>(value)) return value;
2224
Chris Lattner2192fe52011-07-18 04:24:23 +00002225 llvm::Type *origType = value->getType();
John McCall31168b02011-06-15 23:02:42 +00002226 value = Builder.CreateBitCast(value, Int8PtrTy);
John McCallff613032011-10-04 06:23:45 +00002227 value = EmitARCRetainBlock(value, /*mandatory*/ true);
John McCall31168b02011-06-15 23:02:42 +00002228 value = EmitARCAutorelease(value);
2229 return Builder.CreateBitCast(value, origType);
2230}
2231
2232/// Do a fused retain/autorelease of the given object.
James Dennett14c41ea2012-06-22 05:41:30 +00002233/// call i8* \@objc_retainAutorelease(i8* %value)
John McCall31168b02011-06-15 23:02:42 +00002234llvm::Value *
2235CodeGenFunction::EmitARCRetainAutoreleaseNonBlock(llvm::Value *value) {
Pete Cooper94867712016-03-21 20:50:03 +00002236 return emitARCValueOperation(*this, value,
John McCallb04ecb72015-10-21 18:06:43 +00002237 CGM.getObjCEntrypoints().objc_retainAutorelease,
John McCall31168b02011-06-15 23:02:42 +00002238 "objc_retainAutorelease");
2239}
2240
John McCallb04ecb72015-10-21 18:06:43 +00002241/// i8* \@objc_loadWeak(i8** %addr)
2242/// Essentially objc_autorelease(objc_loadWeakRetained(addr)).
2243llvm::Value *CodeGenFunction::EmitARCLoadWeak(Address addr) {
2244 return emitARCLoadOperation(*this, addr,
2245 CGM.getObjCEntrypoints().objc_loadWeak,
2246 "objc_loadWeak");
2247}
2248
James Dennett14c41ea2012-06-22 05:41:30 +00002249/// i8* \@objc_loadWeakRetained(i8** %addr)
John McCall7f416cc2015-09-08 08:05:57 +00002250llvm::Value *CodeGenFunction::EmitARCLoadWeakRetained(Address addr) {
John McCall31168b02011-06-15 23:02:42 +00002251 return emitARCLoadOperation(*this, addr,
John McCallb04ecb72015-10-21 18:06:43 +00002252 CGM.getObjCEntrypoints().objc_loadWeakRetained,
John McCall31168b02011-06-15 23:02:42 +00002253 "objc_loadWeakRetained");
2254}
2255
James Dennett14c41ea2012-06-22 05:41:30 +00002256/// i8* \@objc_storeWeak(i8** %addr, i8* %value)
John McCall31168b02011-06-15 23:02:42 +00002257/// Returns %value.
John McCall7f416cc2015-09-08 08:05:57 +00002258llvm::Value *CodeGenFunction::EmitARCStoreWeak(Address addr,
John McCall31168b02011-06-15 23:02:42 +00002259 llvm::Value *value,
2260 bool ignored) {
2261 return emitARCStoreOperation(*this, addr, value,
John McCallb04ecb72015-10-21 18:06:43 +00002262 CGM.getObjCEntrypoints().objc_storeWeak,
John McCall31168b02011-06-15 23:02:42 +00002263 "objc_storeWeak", ignored);
2264}
2265
James Dennett14c41ea2012-06-22 05:41:30 +00002266/// i8* \@objc_initWeak(i8** %addr, i8* %value)
John McCall31168b02011-06-15 23:02:42 +00002267/// Returns %value. %addr is known to not have a current weak entry.
2268/// Essentially equivalent to:
2269/// *addr = nil; objc_storeWeak(addr, value);
John McCall7f416cc2015-09-08 08:05:57 +00002270void CodeGenFunction::EmitARCInitWeak(Address addr, llvm::Value *value) {
John McCall31168b02011-06-15 23:02:42 +00002271 // If we're initializing to null, just write null to memory; no need
2272 // to get the runtime involved. But don't do this if optimization
2273 // is enabled, because accounting for this would make the optimizer
2274 // much more complicated.
2275 if (isa<llvm::ConstantPointerNull>(value) &&
2276 CGM.getCodeGenOpts().OptimizationLevel == 0) {
2277 Builder.CreateStore(value, addr);
2278 return;
2279 }
2280
2281 emitARCStoreOperation(*this, addr, value,
John McCallb04ecb72015-10-21 18:06:43 +00002282 CGM.getObjCEntrypoints().objc_initWeak,
John McCall31168b02011-06-15 23:02:42 +00002283 "objc_initWeak", /*ignored*/ true);
2284}
2285
James Dennett14c41ea2012-06-22 05:41:30 +00002286/// void \@objc_destroyWeak(i8** %addr)
John McCall31168b02011-06-15 23:02:42 +00002287/// Essentially objc_storeWeak(addr, nil).
John McCall7f416cc2015-09-08 08:05:57 +00002288void CodeGenFunction::EmitARCDestroyWeak(Address addr) {
John McCallb04ecb72015-10-21 18:06:43 +00002289 llvm::Constant *&fn = CGM.getObjCEntrypoints().objc_destroyWeak;
John McCall31168b02011-06-15 23:02:42 +00002290 if (!fn) {
Chris Lattner2192fe52011-07-18 04:24:23 +00002291 llvm::FunctionType *fnType =
Benjamin Kramer95e19362013-03-07 21:18:31 +00002292 llvm::FunctionType::get(Builder.getVoidTy(), Int8PtrPtrTy, false);
John McCall31168b02011-06-15 23:02:42 +00002293 fn = createARCRuntimeFunction(CGM, fnType, "objc_destroyWeak");
2294 }
2295
2296 // Cast the argument to 'id*'.
2297 addr = Builder.CreateBitCast(addr, Int8PtrPtrTy);
2298
John McCall7f416cc2015-09-08 08:05:57 +00002299 EmitNounwindRuntimeCall(fn, addr.getPointer());
John McCall31168b02011-06-15 23:02:42 +00002300}
2301
James Dennett14c41ea2012-06-22 05:41:30 +00002302/// void \@objc_moveWeak(i8** %dest, i8** %src)
John McCall31168b02011-06-15 23:02:42 +00002303/// Disregards the current value in %dest. Leaves %src pointing to nothing.
2304/// Essentially (objc_copyWeak(dest, src), objc_destroyWeak(src)).
John McCall7f416cc2015-09-08 08:05:57 +00002305void CodeGenFunction::EmitARCMoveWeak(Address dst, Address src) {
John McCall31168b02011-06-15 23:02:42 +00002306 emitARCCopyOperation(*this, dst, src,
John McCallb04ecb72015-10-21 18:06:43 +00002307 CGM.getObjCEntrypoints().objc_moveWeak,
John McCall31168b02011-06-15 23:02:42 +00002308 "objc_moveWeak");
2309}
2310
James Dennett14c41ea2012-06-22 05:41:30 +00002311/// void \@objc_copyWeak(i8** %dest, i8** %src)
John McCall31168b02011-06-15 23:02:42 +00002312/// Disregards the current value in %dest. Essentially
2313/// objc_release(objc_initWeak(dest, objc_readWeakRetained(src)))
John McCall7f416cc2015-09-08 08:05:57 +00002314void CodeGenFunction::EmitARCCopyWeak(Address dst, Address src) {
John McCall31168b02011-06-15 23:02:42 +00002315 emitARCCopyOperation(*this, dst, src,
John McCallb04ecb72015-10-21 18:06:43 +00002316 CGM.getObjCEntrypoints().objc_copyWeak,
John McCall31168b02011-06-15 23:02:42 +00002317 "objc_copyWeak");
2318}
2319
2320/// Produce the code to do a objc_autoreleasepool_push.
James Dennett14c41ea2012-06-22 05:41:30 +00002321/// call i8* \@objc_autoreleasePoolPush(void)
John McCall31168b02011-06-15 23:02:42 +00002322llvm::Value *CodeGenFunction::EmitObjCAutoreleasePoolPush() {
John McCallb04ecb72015-10-21 18:06:43 +00002323 llvm::Constant *&fn = CGM.getObjCEntrypoints().objc_autoreleasePoolPush;
John McCall31168b02011-06-15 23:02:42 +00002324 if (!fn) {
Chris Lattner2192fe52011-07-18 04:24:23 +00002325 llvm::FunctionType *fnType =
John McCall31168b02011-06-15 23:02:42 +00002326 llvm::FunctionType::get(Int8PtrTy, false);
2327 fn = createARCRuntimeFunction(CGM, fnType, "objc_autoreleasePoolPush");
2328 }
2329
John McCall882987f2013-02-28 19:01:20 +00002330 return EmitNounwindRuntimeCall(fn);
John McCall31168b02011-06-15 23:02:42 +00002331}
2332
2333/// Produce the code to do a primitive release.
James Dennett14c41ea2012-06-22 05:41:30 +00002334/// call void \@objc_autoreleasePoolPop(i8* %ptr)
John McCall31168b02011-06-15 23:02:42 +00002335void CodeGenFunction::EmitObjCAutoreleasePoolPop(llvm::Value *value) {
2336 assert(value->getType() == Int8PtrTy);
2337
John McCallb04ecb72015-10-21 18:06:43 +00002338 llvm::Constant *&fn = CGM.getObjCEntrypoints().objc_autoreleasePoolPop;
John McCall31168b02011-06-15 23:02:42 +00002339 if (!fn) {
Chris Lattner2192fe52011-07-18 04:24:23 +00002340 llvm::FunctionType *fnType =
Benjamin Kramer95e19362013-03-07 21:18:31 +00002341 llvm::FunctionType::get(Builder.getVoidTy(), Int8PtrTy, false);
John McCall31168b02011-06-15 23:02:42 +00002342
2343 // We don't want to use a weak import here; instead we should not
2344 // fall into this path.
2345 fn = createARCRuntimeFunction(CGM, fnType, "objc_autoreleasePoolPop");
2346 }
2347
John McCallb7ff6db2013-04-16 21:29:40 +00002348 // objc_autoreleasePoolPop can throw.
2349 EmitRuntimeCallOrInvoke(fn, value);
John McCall31168b02011-06-15 23:02:42 +00002350}
2351
2352/// Produce the code to do an MRR version objc_autoreleasepool_push.
2353/// Which is: [[NSAutoreleasePool alloc] init];
2354/// Where alloc is declared as: + (id) alloc; in NSAutoreleasePool class.
2355/// init is declared as: - (id) init; in its NSObject super class.
2356///
2357llvm::Value *CodeGenFunction::EmitObjCMRRAutoreleasePoolPush() {
2358 CGObjCRuntime &Runtime = CGM.getObjCRuntime();
John McCall882987f2013-02-28 19:01:20 +00002359 llvm::Value *Receiver = Runtime.EmitNSAutoreleasePoolClassRef(*this);
John McCall31168b02011-06-15 23:02:42 +00002360 // [NSAutoreleasePool alloc]
2361 IdentifierInfo *II = &CGM.getContext().Idents.get("alloc");
2362 Selector AllocSel = getContext().Selectors.getSelector(0, &II);
2363 CallArgList Args;
2364 RValue AllocRV =
2365 Runtime.GenerateMessageSend(*this, ReturnValueSlot(),
2366 getContext().getObjCIdType(),
2367 AllocSel, Receiver, Args);
2368
2369 // [Receiver init]
2370 Receiver = AllocRV.getScalarVal();
2371 II = &CGM.getContext().Idents.get("init");
2372 Selector InitSel = getContext().Selectors.getSelector(0, &II);
2373 RValue InitRV =
2374 Runtime.GenerateMessageSend(*this, ReturnValueSlot(),
2375 getContext().getObjCIdType(),
2376 InitSel, Receiver, Args);
2377 return InitRV.getScalarVal();
2378}
2379
2380/// Produce the code to do a primitive release.
2381/// [tmp drain];
2382void CodeGenFunction::EmitObjCMRRAutoreleasePoolPop(llvm::Value *Arg) {
2383 IdentifierInfo *II = &CGM.getContext().Idents.get("drain");
2384 Selector DrainSel = getContext().Selectors.getSelector(0, &II);
2385 CallArgList Args;
2386 CGM.getObjCRuntime().GenerateMessageSend(*this, ReturnValueSlot(),
2387 getContext().VoidTy, DrainSel, Arg, Args);
2388}
2389
John McCall82fe67b2011-07-09 01:37:26 +00002390void CodeGenFunction::destroyARCStrongPrecise(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00002391 Address addr,
John McCall82fe67b2011-07-09 01:37:26 +00002392 QualType type) {
John McCallcdda29c2013-03-13 03:10:54 +00002393 CGF.EmitARCDestroyStrong(addr, ARCPreciseLifetime);
John McCall82fe67b2011-07-09 01:37:26 +00002394}
2395
2396void CodeGenFunction::destroyARCStrongImprecise(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00002397 Address addr,
John McCall82fe67b2011-07-09 01:37:26 +00002398 QualType type) {
John McCallcdda29c2013-03-13 03:10:54 +00002399 CGF.EmitARCDestroyStrong(addr, ARCImpreciseLifetime);
John McCall82fe67b2011-07-09 01:37:26 +00002400}
2401
2402void CodeGenFunction::destroyARCWeak(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00002403 Address addr,
John McCall82fe67b2011-07-09 01:37:26 +00002404 QualType type) {
2405 CGF.EmitARCDestroyWeak(addr);
2406}
2407
John McCall31168b02011-06-15 23:02:42 +00002408namespace {
David Blaikie7e70d682015-08-18 22:40:54 +00002409 struct CallObjCAutoreleasePoolObject final : EHScopeStack::Cleanup {
John McCall31168b02011-06-15 23:02:42 +00002410 llvm::Value *Token;
2411
2412 CallObjCAutoreleasePoolObject(llvm::Value *token) : Token(token) {}
2413
Craig Topper4f12f102014-03-12 06:41:41 +00002414 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall31168b02011-06-15 23:02:42 +00002415 CGF.EmitObjCAutoreleasePoolPop(Token);
2416 }
2417 };
David Blaikie7e70d682015-08-18 22:40:54 +00002418 struct CallObjCMRRAutoreleasePoolObject final : EHScopeStack::Cleanup {
John McCall31168b02011-06-15 23:02:42 +00002419 llvm::Value *Token;
2420
2421 CallObjCMRRAutoreleasePoolObject(llvm::Value *token) : Token(token) {}
2422
Craig Topper4f12f102014-03-12 06:41:41 +00002423 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall31168b02011-06-15 23:02:42 +00002424 CGF.EmitObjCMRRAutoreleasePoolPop(Token);
2425 }
2426 };
Alexander Kornienkoab9db512015-06-22 23:07:51 +00002427}
John McCall31168b02011-06-15 23:02:42 +00002428
2429void CodeGenFunction::EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr) {
David Blaikiebbafb8a2012-03-11 07:00:24 +00002430 if (CGM.getLangOpts().ObjCAutoRefCount)
John McCall31168b02011-06-15 23:02:42 +00002431 EHStack.pushCleanup<CallObjCAutoreleasePoolObject>(NormalCleanup, Ptr);
2432 else
2433 EHStack.pushCleanup<CallObjCMRRAutoreleasePoolObject>(NormalCleanup, Ptr);
2434}
2435
John McCall31168b02011-06-15 23:02:42 +00002436static TryEmitResult tryEmitARCRetainLoadOfScalar(CodeGenFunction &CGF,
2437 LValue lvalue,
2438 QualType type) {
2439 switch (type.getObjCLifetime()) {
2440 case Qualifiers::OCL_None:
2441 case Qualifiers::OCL_ExplicitNone:
2442 case Qualifiers::OCL_Strong:
2443 case Qualifiers::OCL_Autoreleasing:
Nick Lewycky2d84e842013-10-02 02:29:49 +00002444 return TryEmitResult(CGF.EmitLoadOfLValue(lvalue,
2445 SourceLocation()).getScalarVal(),
John McCall31168b02011-06-15 23:02:42 +00002446 false);
2447
2448 case Qualifiers::OCL_Weak:
2449 return TryEmitResult(CGF.EmitARCLoadWeakRetained(lvalue.getAddress()),
2450 true);
2451 }
2452
2453 llvm_unreachable("impossible lifetime!");
John McCall31168b02011-06-15 23:02:42 +00002454}
2455
2456static TryEmitResult tryEmitARCRetainLoadOfScalar(CodeGenFunction &CGF,
2457 const Expr *e) {
2458 e = e->IgnoreParens();
2459 QualType type = e->getType();
2460
John McCall154a2fd2011-08-30 00:57:29 +00002461 // If we're loading retained from a __strong xvalue, we can avoid
2462 // an extra retain/release pair by zeroing out the source of this
2463 // "move" operation.
2464 if (e->isXValue() &&
2465 !type.isConstQualified() &&
2466 type.getObjCLifetime() == Qualifiers::OCL_Strong) {
2467 // Emit the lvalue.
2468 LValue lv = CGF.EmitLValue(e);
2469
2470 // Load the object pointer.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002471 llvm::Value *result = CGF.EmitLoadOfLValue(lv,
2472 SourceLocation()).getScalarVal();
John McCall154a2fd2011-08-30 00:57:29 +00002473
2474 // Set the source pointer to NULL.
2475 CGF.EmitStoreOfScalar(getNullForVariable(lv.getAddress()), lv);
2476
2477 return TryEmitResult(result, true);
2478 }
2479
John McCall31168b02011-06-15 23:02:42 +00002480 // As a very special optimization, in ARC++, if the l-value is the
2481 // result of a non-volatile assignment, do a simple retain of the
2482 // result of the call to objc_storeWeak instead of reloading.
David Blaikiebbafb8a2012-03-11 07:00:24 +00002483 if (CGF.getLangOpts().CPlusPlus &&
John McCall31168b02011-06-15 23:02:42 +00002484 !type.isVolatileQualified() &&
2485 type.getObjCLifetime() == Qualifiers::OCL_Weak &&
2486 isa<BinaryOperator>(e) &&
2487 cast<BinaryOperator>(e)->getOpcode() == BO_Assign)
2488 return TryEmitResult(CGF.EmitScalarExpr(e), false);
2489
2490 return tryEmitARCRetainLoadOfScalar(CGF, CGF.EmitLValue(e), type);
2491}
2492
John McCalle399e5b2016-01-27 18:32:30 +00002493typedef llvm::function_ref<llvm::Value *(CodeGenFunction &CGF,
2494 llvm::Value *value)>
2495 ValueTransform;
John McCall31168b02011-06-15 23:02:42 +00002496
John McCalle399e5b2016-01-27 18:32:30 +00002497/// Insert code immediately after a call.
2498static llvm::Value *emitARCOperationAfterCall(CodeGenFunction &CGF,
2499 llvm::Value *value,
2500 ValueTransform doAfterCall,
2501 ValueTransform doFallback) {
John McCall31168b02011-06-15 23:02:42 +00002502 if (llvm::CallInst *call = dyn_cast<llvm::CallInst>(value)) {
2503 CGBuilderTy::InsertPoint ip = CGF.Builder.saveIP();
2504
2505 // Place the retain immediately following the call.
2506 CGF.Builder.SetInsertPoint(call->getParent(),
2507 ++llvm::BasicBlock::iterator(call));
John McCalle399e5b2016-01-27 18:32:30 +00002508 value = doAfterCall(CGF, value);
John McCall31168b02011-06-15 23:02:42 +00002509
2510 CGF.Builder.restoreIP(ip);
2511 return value;
2512 } else if (llvm::InvokeInst *invoke = dyn_cast<llvm::InvokeInst>(value)) {
2513 CGBuilderTy::InsertPoint ip = CGF.Builder.saveIP();
2514
2515 // Place the retain at the beginning of the normal destination block.
2516 llvm::BasicBlock *BB = invoke->getNormalDest();
2517 CGF.Builder.SetInsertPoint(BB, BB->begin());
John McCalle399e5b2016-01-27 18:32:30 +00002518 value = doAfterCall(CGF, value);
John McCall31168b02011-06-15 23:02:42 +00002519
2520 CGF.Builder.restoreIP(ip);
2521 return value;
2522
2523 // Bitcasts can arise because of related-result returns. Rewrite
2524 // the operand.
2525 } else if (llvm::BitCastInst *bitcast = dyn_cast<llvm::BitCastInst>(value)) {
2526 llvm::Value *operand = bitcast->getOperand(0);
John McCalle399e5b2016-01-27 18:32:30 +00002527 operand = emitARCOperationAfterCall(CGF, operand, doAfterCall, doFallback);
John McCall31168b02011-06-15 23:02:42 +00002528 bitcast->setOperand(0, operand);
2529 return bitcast;
2530
2531 // Generic fall-back case.
2532 } else {
2533 // Retain using the non-block variant: we never need to do a copy
2534 // of a block that's been returned to us.
John McCalle399e5b2016-01-27 18:32:30 +00002535 return doFallback(CGF, value);
2536 }
2537}
2538
2539/// Given that the given expression is some sort of call (which does
2540/// not return retained), emit a retain following it.
2541static llvm::Value *emitARCRetainCallResult(CodeGenFunction &CGF,
2542 const Expr *e) {
2543 llvm::Value *value = CGF.EmitScalarExpr(e);
2544 return emitARCOperationAfterCall(CGF, value,
2545 [](CodeGenFunction &CGF, llvm::Value *value) {
2546 return CGF.EmitARCRetainAutoreleasedReturnValue(value);
2547 },
2548 [](CodeGenFunction &CGF, llvm::Value *value) {
2549 return CGF.EmitARCRetainNonBlock(value);
2550 });
2551}
2552
2553/// Given that the given expression is some sort of call (which does
2554/// not return retained), perform an unsafeClaim following it.
2555static llvm::Value *emitARCUnsafeClaimCallResult(CodeGenFunction &CGF,
2556 const Expr *e) {
2557 llvm::Value *value = CGF.EmitScalarExpr(e);
2558 return emitARCOperationAfterCall(CGF, value,
2559 [](CodeGenFunction &CGF, llvm::Value *value) {
2560 return CGF.EmitARCUnsafeClaimAutoreleasedReturnValue(value);
2561 },
2562 [](CodeGenFunction &CGF, llvm::Value *value) {
2563 return value;
2564 });
2565}
2566
2567llvm::Value *CodeGenFunction::EmitARCReclaimReturnedObject(const Expr *E,
2568 bool allowUnsafeClaim) {
2569 if (allowUnsafeClaim &&
2570 CGM.getLangOpts().ObjCRuntime.hasARCUnsafeClaimAutoreleasedReturnValue()) {
2571 return emitARCUnsafeClaimCallResult(*this, E);
2572 } else {
2573 llvm::Value *value = emitARCRetainCallResult(*this, E);
2574 return EmitObjCConsumeObject(E->getType(), value);
John McCall31168b02011-06-15 23:02:42 +00002575 }
2576}
2577
John McCallcd78e802011-09-10 01:16:55 +00002578/// Determine whether it might be important to emit a separate
2579/// objc_retain_block on the result of the given expression, or
2580/// whether it's okay to just emit it in a +1 context.
2581static bool shouldEmitSeparateBlockRetain(const Expr *e) {
2582 assert(e->getType()->isBlockPointerType());
2583 e = e->IgnoreParens();
2584
2585 // For future goodness, emit block expressions directly in +1
2586 // contexts if we can.
2587 if (isa<BlockExpr>(e))
2588 return false;
2589
2590 if (const CastExpr *cast = dyn_cast<CastExpr>(e)) {
2591 switch (cast->getCastKind()) {
2592 // Emitting these operations in +1 contexts is goodness.
2593 case CK_LValueToRValue:
John McCall2d637d22011-09-10 06:18:15 +00002594 case CK_ARCReclaimReturnedObject:
2595 case CK_ARCConsumeObject:
2596 case CK_ARCProduceObject:
John McCallcd78e802011-09-10 01:16:55 +00002597 return false;
2598
2599 // These operations preserve a block type.
2600 case CK_NoOp:
2601 case CK_BitCast:
2602 return shouldEmitSeparateBlockRetain(cast->getSubExpr());
2603
2604 // These operations are known to be bad (or haven't been considered).
2605 case CK_AnyPointerToBlockPointerCast:
2606 default:
2607 return true;
2608 }
2609 }
2610
2611 return true;
2612}
2613
John McCalle399e5b2016-01-27 18:32:30 +00002614namespace {
2615/// A CRTP base class for emitting expressions of retainable object
2616/// pointer type in ARC.
2617template <typename Impl, typename Result> class ARCExprEmitter {
2618protected:
2619 CodeGenFunction &CGF;
2620 Impl &asImpl() { return *static_cast<Impl*>(this); }
2621
2622 ARCExprEmitter(CodeGenFunction &CGF) : CGF(CGF) {}
2623
2624public:
2625 Result visit(const Expr *e);
2626 Result visitCastExpr(const CastExpr *e);
2627 Result visitPseudoObjectExpr(const PseudoObjectExpr *e);
2628 Result visitBinaryOperator(const BinaryOperator *e);
2629 Result visitBinAssign(const BinaryOperator *e);
2630 Result visitBinAssignUnsafeUnretained(const BinaryOperator *e);
2631 Result visitBinAssignAutoreleasing(const BinaryOperator *e);
2632 Result visitBinAssignWeak(const BinaryOperator *e);
2633 Result visitBinAssignStrong(const BinaryOperator *e);
2634
2635 // Minimal implementation:
2636 // Result visitLValueToRValue(const Expr *e)
2637 // Result visitConsumeObject(const Expr *e)
2638 // Result visitExtendBlockObject(const Expr *e)
2639 // Result visitReclaimReturnedObject(const Expr *e)
2640 // Result visitCall(const Expr *e)
2641 // Result visitExpr(const Expr *e)
2642 //
2643 // Result emitBitCast(Result result, llvm::Type *resultType)
2644 // llvm::Value *getValueOfResult(Result result)
2645};
2646}
2647
2648/// Try to emit a PseudoObjectExpr under special ARC rules.
John McCallfe96e0b2011-11-06 09:01:30 +00002649///
2650/// This massively duplicates emitPseudoObjectRValue.
John McCalle399e5b2016-01-27 18:32:30 +00002651template <typename Impl, typename Result>
2652Result
2653ARCExprEmitter<Impl,Result>::visitPseudoObjectExpr(const PseudoObjectExpr *E) {
Dmitri Gribenkof8579502013-01-12 19:30:44 +00002654 SmallVector<CodeGenFunction::OpaqueValueMappingData, 4> opaques;
John McCallfe96e0b2011-11-06 09:01:30 +00002655
2656 // Find the result expression.
2657 const Expr *resultExpr = E->getResultExpr();
2658 assert(resultExpr);
John McCalle399e5b2016-01-27 18:32:30 +00002659 Result result;
John McCallfe96e0b2011-11-06 09:01:30 +00002660
2661 for (PseudoObjectExpr::const_semantics_iterator
2662 i = E->semantics_begin(), e = E->semantics_end(); i != e; ++i) {
2663 const Expr *semantic = *i;
2664
2665 // If this semantic expression is an opaque value, bind it
2666 // to the result of its source expression.
2667 if (const OpaqueValueExpr *ov = dyn_cast<OpaqueValueExpr>(semantic)) {
2668 typedef CodeGenFunction::OpaqueValueMappingData OVMA;
2669 OVMA opaqueData;
2670
2671 // If this semantic is the result of the pseudo-object
2672 // expression, try to evaluate the source as +1.
2673 if (ov == resultExpr) {
2674 assert(!OVMA::shouldBindAsLValue(ov));
John McCalle399e5b2016-01-27 18:32:30 +00002675 result = asImpl().visit(ov->getSourceExpr());
2676 opaqueData = OVMA::bind(CGF, ov,
2677 RValue::get(asImpl().getValueOfResult(result)));
John McCallfe96e0b2011-11-06 09:01:30 +00002678
2679 // Otherwise, just bind it.
2680 } else {
2681 opaqueData = OVMA::bind(CGF, ov, ov->getSourceExpr());
2682 }
2683 opaques.push_back(opaqueData);
2684
2685 // Otherwise, if the expression is the result, evaluate it
2686 // and remember the result.
2687 } else if (semantic == resultExpr) {
John McCalle399e5b2016-01-27 18:32:30 +00002688 result = asImpl().visit(semantic);
John McCallfe96e0b2011-11-06 09:01:30 +00002689
2690 // Otherwise, evaluate the expression in an ignored context.
2691 } else {
2692 CGF.EmitIgnoredExpr(semantic);
2693 }
2694 }
2695
2696 // Unbind all the opaques now.
2697 for (unsigned i = 0, e = opaques.size(); i != e; ++i)
2698 opaques[i].unbind(CGF);
2699
2700 return result;
2701}
2702
John McCalle399e5b2016-01-27 18:32:30 +00002703template <typename Impl, typename Result>
2704Result ARCExprEmitter<Impl,Result>::visitCastExpr(const CastExpr *e) {
2705 switch (e->getCastKind()) {
John McCall53848232011-07-27 01:07:15 +00002706
John McCalle399e5b2016-01-27 18:32:30 +00002707 // No-op casts don't change the type, so we just ignore them.
2708 case CK_NoOp:
2709 return asImpl().visit(e->getSubExpr());
John McCall31168b02011-06-15 23:02:42 +00002710
John McCalle399e5b2016-01-27 18:32:30 +00002711 // These casts can change the type.
2712 case CK_CPointerToObjCPointerCast:
2713 case CK_BlockPointerToObjCPointerCast:
2714 case CK_AnyPointerToBlockPointerCast:
2715 case CK_BitCast: {
2716 llvm::Type *resultType = CGF.ConvertType(e->getType());
2717 assert(e->getSubExpr()->getType()->hasPointerRepresentation());
2718 Result result = asImpl().visit(e->getSubExpr());
2719 return asImpl().emitBitCast(result, resultType);
John McCall31168b02011-06-15 23:02:42 +00002720 }
2721
John McCalle399e5b2016-01-27 18:32:30 +00002722 // Handle some casts specially.
2723 case CK_LValueToRValue:
2724 return asImpl().visitLValueToRValue(e->getSubExpr());
2725 case CK_ARCConsumeObject:
2726 return asImpl().visitConsumeObject(e->getSubExpr());
2727 case CK_ARCExtendBlockObject:
2728 return asImpl().visitExtendBlockObject(e->getSubExpr());
2729 case CK_ARCReclaimReturnedObject:
2730 return asImpl().visitReclaimReturnedObject(e->getSubExpr());
2731
2732 // Otherwise, use the default logic.
2733 default:
2734 return asImpl().visitExpr(e);
2735 }
2736}
2737
2738template <typename Impl, typename Result>
2739Result
2740ARCExprEmitter<Impl,Result>::visitBinaryOperator(const BinaryOperator *e) {
2741 switch (e->getOpcode()) {
2742 case BO_Comma:
2743 CGF.EmitIgnoredExpr(e->getLHS());
2744 CGF.EnsureInsertPoint();
2745 return asImpl().visit(e->getRHS());
2746
2747 case BO_Assign:
2748 return asImpl().visitBinAssign(e);
2749
2750 default:
2751 return asImpl().visitExpr(e);
2752 }
2753}
2754
2755template <typename Impl, typename Result>
2756Result ARCExprEmitter<Impl,Result>::visitBinAssign(const BinaryOperator *e) {
2757 switch (e->getLHS()->getType().getObjCLifetime()) {
2758 case Qualifiers::OCL_ExplicitNone:
2759 return asImpl().visitBinAssignUnsafeUnretained(e);
2760
2761 case Qualifiers::OCL_Weak:
2762 return asImpl().visitBinAssignWeak(e);
2763
2764 case Qualifiers::OCL_Autoreleasing:
2765 return asImpl().visitBinAssignAutoreleasing(e);
2766
2767 case Qualifiers::OCL_Strong:
2768 return asImpl().visitBinAssignStrong(e);
2769
2770 case Qualifiers::OCL_None:
2771 return asImpl().visitExpr(e);
2772 }
2773 llvm_unreachable("bad ObjC ownership qualifier");
2774}
2775
2776/// The default rule for __unsafe_unretained emits the RHS recursively,
2777/// stores into the unsafe variable, and propagates the result outward.
2778template <typename Impl, typename Result>
2779Result ARCExprEmitter<Impl,Result>::
2780 visitBinAssignUnsafeUnretained(const BinaryOperator *e) {
2781 // Recursively emit the RHS.
2782 // For __block safety, do this before emitting the LHS.
2783 Result result = asImpl().visit(e->getRHS());
2784
2785 // Perform the store.
2786 LValue lvalue =
2787 CGF.EmitCheckedLValue(e->getLHS(), CodeGenFunction::TCK_Store);
2788 CGF.EmitStoreThroughLValue(RValue::get(asImpl().getValueOfResult(result)),
2789 lvalue);
2790
2791 return result;
2792}
2793
2794template <typename Impl, typename Result>
2795Result
2796ARCExprEmitter<Impl,Result>::visitBinAssignAutoreleasing(const BinaryOperator *e) {
2797 return asImpl().visitExpr(e);
2798}
2799
2800template <typename Impl, typename Result>
2801Result
2802ARCExprEmitter<Impl,Result>::visitBinAssignWeak(const BinaryOperator *e) {
2803 return asImpl().visitExpr(e);
2804}
2805
2806template <typename Impl, typename Result>
2807Result
2808ARCExprEmitter<Impl,Result>::visitBinAssignStrong(const BinaryOperator *e) {
2809 return asImpl().visitExpr(e);
2810}
2811
2812/// The general expression-emission logic.
2813template <typename Impl, typename Result>
2814Result ARCExprEmitter<Impl,Result>::visit(const Expr *e) {
2815 // We should *never* see a nested full-expression here, because if
2816 // we fail to emit at +1, our caller must not retain after we close
2817 // out the full-expression. This isn't as important in the unsafe
2818 // emitter.
2819 assert(!isa<ExprWithCleanups>(e));
2820
2821 // Look through parens, __extension__, generic selection, etc.
2822 e = e->IgnoreParens();
2823
2824 // Handle certain kinds of casts.
2825 if (const CastExpr *ce = dyn_cast<CastExpr>(e)) {
2826 return asImpl().visitCastExpr(ce);
2827
2828 // Handle the comma operator.
2829 } else if (auto op = dyn_cast<BinaryOperator>(e)) {
2830 return asImpl().visitBinaryOperator(op);
2831
2832 // TODO: handle conditional operators here
2833
2834 // For calls and message sends, use the retained-call logic.
2835 // Delegate inits are a special case in that they're the only
2836 // returns-retained expression that *isn't* surrounded by
2837 // a consume.
2838 } else if (isa<CallExpr>(e) ||
2839 (isa<ObjCMessageExpr>(e) &&
2840 !cast<ObjCMessageExpr>(e)->isDelegateInitCall())) {
2841 return asImpl().visitCall(e);
2842
2843 // Look through pseudo-object expressions.
2844 } else if (const PseudoObjectExpr *pseudo = dyn_cast<PseudoObjectExpr>(e)) {
2845 return asImpl().visitPseudoObjectExpr(pseudo);
2846 }
2847
2848 return asImpl().visitExpr(e);
2849}
2850
2851namespace {
2852
2853/// An emitter for +1 results.
2854struct ARCRetainExprEmitter :
2855 public ARCExprEmitter<ARCRetainExprEmitter, TryEmitResult> {
2856
2857 ARCRetainExprEmitter(CodeGenFunction &CGF) : ARCExprEmitter(CGF) {}
2858
2859 llvm::Value *getValueOfResult(TryEmitResult result) {
2860 return result.getPointer();
2861 }
2862
2863 TryEmitResult emitBitCast(TryEmitResult result, llvm::Type *resultType) {
2864 llvm::Value *value = result.getPointer();
2865 value = CGF.Builder.CreateBitCast(value, resultType);
2866 result.setPointer(value);
2867 return result;
2868 }
2869
2870 TryEmitResult visitLValueToRValue(const Expr *e) {
2871 return tryEmitARCRetainLoadOfScalar(CGF, e);
2872 }
2873
2874 /// For consumptions, just emit the subexpression and thus elide
2875 /// the retain/release pair.
2876 TryEmitResult visitConsumeObject(const Expr *e) {
2877 llvm::Value *result = CGF.EmitScalarExpr(e);
2878 return TryEmitResult(result, true);
2879 }
2880
2881 /// Block extends are net +0. Naively, we could just recurse on
2882 /// the subexpression, but actually we need to ensure that the
2883 /// value is copied as a block, so there's a little filter here.
2884 TryEmitResult visitExtendBlockObject(const Expr *e) {
2885 llvm::Value *result; // will be a +0 value
2886
2887 // If we can't safely assume the sub-expression will produce a
2888 // block-copied value, emit the sub-expression at +0.
2889 if (shouldEmitSeparateBlockRetain(e)) {
2890 result = CGF.EmitScalarExpr(e);
2891
2892 // Otherwise, try to emit the sub-expression at +1 recursively.
2893 } else {
2894 TryEmitResult subresult = asImpl().visit(e);
2895
2896 // If that produced a retained value, just use that.
2897 if (subresult.getInt()) {
2898 return subresult;
2899 }
2900
2901 // Otherwise it's +0.
2902 result = subresult.getPointer();
2903 }
2904
2905 // Retain the object as a block.
2906 result = CGF.EmitARCRetainBlock(result, /*mandatory*/ true);
2907 return TryEmitResult(result, true);
2908 }
2909
2910 /// For reclaims, emit the subexpression as a retained call and
2911 /// skip the consumption.
2912 TryEmitResult visitReclaimReturnedObject(const Expr *e) {
2913 llvm::Value *result = emitARCRetainCallResult(CGF, e);
2914 return TryEmitResult(result, true);
2915 }
2916
2917 /// When we have an undecorated call, retroactively do a claim.
2918 TryEmitResult visitCall(const Expr *e) {
2919 llvm::Value *result = emitARCRetainCallResult(CGF, e);
2920 return TryEmitResult(result, true);
2921 }
2922
2923 // TODO: maybe special-case visitBinAssignWeak?
2924
2925 TryEmitResult visitExpr(const Expr *e) {
2926 // We didn't find an obvious production, so emit what we've got and
2927 // tell the caller that we didn't manage to retain.
2928 llvm::Value *result = CGF.EmitScalarExpr(e);
2929 return TryEmitResult(result, false);
2930 }
2931};
2932}
2933
2934static TryEmitResult
2935tryEmitARCRetainScalarExpr(CodeGenFunction &CGF, const Expr *e) {
2936 return ARCRetainExprEmitter(CGF).visit(e);
John McCall31168b02011-06-15 23:02:42 +00002937}
2938
2939static llvm::Value *emitARCRetainLoadOfScalar(CodeGenFunction &CGF,
2940 LValue lvalue,
2941 QualType type) {
2942 TryEmitResult result = tryEmitARCRetainLoadOfScalar(CGF, lvalue, type);
2943 llvm::Value *value = result.getPointer();
2944 if (!result.getInt())
2945 value = CGF.EmitARCRetain(type, value);
2946 return value;
2947}
2948
2949/// EmitARCRetainScalarExpr - Semantically equivalent to
2950/// EmitARCRetainObject(e->getType(), EmitScalarExpr(e)), but making a
2951/// best-effort attempt to peephole expressions that naturally produce
2952/// retained objects.
2953llvm::Value *CodeGenFunction::EmitARCRetainScalarExpr(const Expr *e) {
John McCalld21cdd42013-02-12 00:25:08 +00002954 // The retain needs to happen within the full-expression.
2955 if (const ExprWithCleanups *cleanups = dyn_cast<ExprWithCleanups>(e)) {
2956 enterFullExpression(cleanups);
2957 RunCleanupsScope scope(*this);
2958 return EmitARCRetainScalarExpr(cleanups->getSubExpr());
2959 }
2960
John McCall31168b02011-06-15 23:02:42 +00002961 TryEmitResult result = tryEmitARCRetainScalarExpr(*this, e);
2962 llvm::Value *value = result.getPointer();
2963 if (!result.getInt())
2964 value = EmitARCRetain(e->getType(), value);
2965 return value;
2966}
2967
2968llvm::Value *
2969CodeGenFunction::EmitARCRetainAutoreleaseScalarExpr(const Expr *e) {
John McCalld21cdd42013-02-12 00:25:08 +00002970 // The retain needs to happen within the full-expression.
2971 if (const ExprWithCleanups *cleanups = dyn_cast<ExprWithCleanups>(e)) {
2972 enterFullExpression(cleanups);
2973 RunCleanupsScope scope(*this);
2974 return EmitARCRetainAutoreleaseScalarExpr(cleanups->getSubExpr());
2975 }
2976
John McCall31168b02011-06-15 23:02:42 +00002977 TryEmitResult result = tryEmitARCRetainScalarExpr(*this, e);
2978 llvm::Value *value = result.getPointer();
2979 if (result.getInt())
2980 value = EmitARCAutorelease(value);
2981 else
2982 value = EmitARCRetainAutorelease(e->getType(), value);
2983 return value;
2984}
2985
John McCallff613032011-10-04 06:23:45 +00002986llvm::Value *CodeGenFunction::EmitARCExtendBlockObject(const Expr *e) {
2987 llvm::Value *result;
2988 bool doRetain;
2989
2990 if (shouldEmitSeparateBlockRetain(e)) {
2991 result = EmitScalarExpr(e);
2992 doRetain = true;
2993 } else {
2994 TryEmitResult subresult = tryEmitARCRetainScalarExpr(*this, e);
2995 result = subresult.getPointer();
2996 doRetain = !subresult.getInt();
2997 }
2998
2999 if (doRetain)
3000 result = EmitARCRetainBlock(result, /*mandatory*/ true);
3001 return EmitObjCConsumeObject(e->getType(), result);
3002}
3003
John McCall248512a2011-10-01 10:32:24 +00003004llvm::Value *CodeGenFunction::EmitObjCThrowOperand(const Expr *expr) {
3005 // In ARC, retain and autorelease the expression.
David Blaikiebbafb8a2012-03-11 07:00:24 +00003006 if (getLangOpts().ObjCAutoRefCount) {
John McCall248512a2011-10-01 10:32:24 +00003007 // Do so before running any cleanups for the full-expression.
John McCalld21cdd42013-02-12 00:25:08 +00003008 // EmitARCRetainAutoreleaseScalarExpr does this for us.
John McCall248512a2011-10-01 10:32:24 +00003009 return EmitARCRetainAutoreleaseScalarExpr(expr);
3010 }
3011
3012 // Otherwise, use the normal scalar-expression emission. The
3013 // exception machinery doesn't do anything special with the
3014 // exception like retaining it, so there's no safety associated with
3015 // only running cleanups after the throw has started, and when it
3016 // matters it tends to be substantially inferior code.
3017 return EmitScalarExpr(expr);
3018}
3019
John McCalle399e5b2016-01-27 18:32:30 +00003020namespace {
3021
3022/// An emitter for assigning into an __unsafe_unretained context.
3023struct ARCUnsafeUnretainedExprEmitter :
3024 public ARCExprEmitter<ARCUnsafeUnretainedExprEmitter, llvm::Value*> {
3025
3026 ARCUnsafeUnretainedExprEmitter(CodeGenFunction &CGF) : ARCExprEmitter(CGF) {}
3027
3028 llvm::Value *getValueOfResult(llvm::Value *value) {
3029 return value;
3030 }
3031
3032 llvm::Value *emitBitCast(llvm::Value *value, llvm::Type *resultType) {
3033 return CGF.Builder.CreateBitCast(value, resultType);
3034 }
3035
3036 llvm::Value *visitLValueToRValue(const Expr *e) {
3037 return CGF.EmitScalarExpr(e);
3038 }
3039
3040 /// For consumptions, just emit the subexpression and perform the
3041 /// consumption like normal.
3042 llvm::Value *visitConsumeObject(const Expr *e) {
3043 llvm::Value *value = CGF.EmitScalarExpr(e);
3044 return CGF.EmitObjCConsumeObject(e->getType(), value);
3045 }
3046
3047 /// No special logic for block extensions. (This probably can't
3048 /// actually happen in this emitter, though.)
3049 llvm::Value *visitExtendBlockObject(const Expr *e) {
3050 return CGF.EmitARCExtendBlockObject(e);
3051 }
3052
3053 /// For reclaims, perform an unsafeClaim if that's enabled.
3054 llvm::Value *visitReclaimReturnedObject(const Expr *e) {
3055 return CGF.EmitARCReclaimReturnedObject(e, /*unsafe*/ true);
3056 }
3057
3058 /// When we have an undecorated call, just emit it without adding
3059 /// the unsafeClaim.
3060 llvm::Value *visitCall(const Expr *e) {
3061 return CGF.EmitScalarExpr(e);
3062 }
3063
3064 /// Just do normal scalar emission in the default case.
3065 llvm::Value *visitExpr(const Expr *e) {
3066 return CGF.EmitScalarExpr(e);
3067 }
3068};
3069}
3070
3071static llvm::Value *emitARCUnsafeUnretainedScalarExpr(CodeGenFunction &CGF,
3072 const Expr *e) {
3073 return ARCUnsafeUnretainedExprEmitter(CGF).visit(e);
3074}
3075
3076/// EmitARCUnsafeUnretainedScalarExpr - Semantically equivalent to
3077/// immediately releasing the resut of EmitARCRetainScalarExpr, but
3078/// avoiding any spurious retains, including by performing reclaims
3079/// with objc_unsafeClaimAutoreleasedReturnValue.
3080llvm::Value *CodeGenFunction::EmitARCUnsafeUnretainedScalarExpr(const Expr *e) {
3081 // Look through full-expressions.
3082 if (const ExprWithCleanups *cleanups = dyn_cast<ExprWithCleanups>(e)) {
3083 enterFullExpression(cleanups);
3084 RunCleanupsScope scope(*this);
3085 return emitARCUnsafeUnretainedScalarExpr(*this, cleanups->getSubExpr());
3086 }
3087
3088 return emitARCUnsafeUnretainedScalarExpr(*this, e);
3089}
3090
3091std::pair<LValue,llvm::Value*>
3092CodeGenFunction::EmitARCStoreUnsafeUnretained(const BinaryOperator *e,
3093 bool ignored) {
3094 // Evaluate the RHS first. If we're ignoring the result, assume
3095 // that we can emit at an unsafe +0.
3096 llvm::Value *value;
3097 if (ignored) {
3098 value = EmitARCUnsafeUnretainedScalarExpr(e->getRHS());
3099 } else {
3100 value = EmitScalarExpr(e->getRHS());
3101 }
3102
3103 // Emit the LHS and perform the store.
3104 LValue lvalue = EmitLValue(e->getLHS());
3105 EmitStoreOfScalar(value, lvalue);
3106
3107 return std::pair<LValue,llvm::Value*>(std::move(lvalue), value);
3108}
3109
John McCall31168b02011-06-15 23:02:42 +00003110std::pair<LValue,llvm::Value*>
3111CodeGenFunction::EmitARCStoreStrong(const BinaryOperator *e,
3112 bool ignored) {
3113 // Evaluate the RHS first.
3114 TryEmitResult result = tryEmitARCRetainScalarExpr(*this, e->getRHS());
3115 llvm::Value *value = result.getPointer();
3116
John McCallb726a552011-07-28 07:23:35 +00003117 bool hasImmediateRetain = result.getInt();
3118
3119 // If we didn't emit a retained object, and the l-value is of block
3120 // type, then we need to emit the block-retain immediately in case
3121 // it invalidates the l-value.
3122 if (!hasImmediateRetain && e->getType()->isBlockPointerType()) {
John McCallff613032011-10-04 06:23:45 +00003123 value = EmitARCRetainBlock(value, /*mandatory*/ false);
John McCallb726a552011-07-28 07:23:35 +00003124 hasImmediateRetain = true;
3125 }
3126
John McCall31168b02011-06-15 23:02:42 +00003127 LValue lvalue = EmitLValue(e->getLHS());
3128
3129 // If the RHS was emitted retained, expand this.
John McCallb726a552011-07-28 07:23:35 +00003130 if (hasImmediateRetain) {
Nick Lewyckyce550072013-10-02 02:33:11 +00003131 llvm::Value *oldValue = EmitLoadOfScalar(lvalue, SourceLocation());
Eli Friedmana0544d62011-12-03 04:14:32 +00003132 EmitStoreOfScalar(value, lvalue);
John McCallcdda29c2013-03-13 03:10:54 +00003133 EmitARCRelease(oldValue, lvalue.isARCPreciseLifetime());
John McCall31168b02011-06-15 23:02:42 +00003134 } else {
John McCall55e1fbc2011-06-25 02:11:03 +00003135 value = EmitARCStoreStrong(lvalue, value, ignored);
John McCall31168b02011-06-15 23:02:42 +00003136 }
3137
3138 return std::pair<LValue,llvm::Value*>(lvalue, value);
3139}
3140
3141std::pair<LValue,llvm::Value*>
3142CodeGenFunction::EmitARCStoreAutoreleasing(const BinaryOperator *e) {
3143 llvm::Value *value = EmitARCRetainAutoreleaseScalarExpr(e->getRHS());
3144 LValue lvalue = EmitLValue(e->getLHS());
3145
Eli Friedmana0544d62011-12-03 04:14:32 +00003146 EmitStoreOfScalar(value, lvalue);
John McCall31168b02011-06-15 23:02:42 +00003147
3148 return std::pair<LValue,llvm::Value*>(lvalue, value);
3149}
3150
3151void CodeGenFunction::EmitObjCAutoreleasePoolStmt(
Eric Christopher5d2b8d92012-03-29 17:31:31 +00003152 const ObjCAutoreleasePoolStmt &ARPS) {
John McCall31168b02011-06-15 23:02:42 +00003153 const Stmt *subStmt = ARPS.getSubStmt();
3154 const CompoundStmt &S = cast<CompoundStmt>(*subStmt);
3155
3156 CGDebugInfo *DI = getDebugInfo();
Eric Christopher7cdf9482011-10-13 21:45:18 +00003157 if (DI)
3158 DI->EmitLexicalBlockStart(Builder, S.getLBracLoc());
John McCall31168b02011-06-15 23:02:42 +00003159
3160 // Keep track of the current cleanup stack depth.
3161 RunCleanupsScope Scope(*this);
John McCall3deb1ad2012-08-21 02:47:43 +00003162 if (CGM.getLangOpts().ObjCRuntime.hasNativeARC()) {
John McCall31168b02011-06-15 23:02:42 +00003163 llvm::Value *token = EmitObjCAutoreleasePoolPush();
3164 EHStack.pushCleanup<CallObjCAutoreleasePoolObject>(NormalCleanup, token);
3165 } else {
3166 llvm::Value *token = EmitObjCMRRAutoreleasePoolPush();
3167 EHStack.pushCleanup<CallObjCMRRAutoreleasePoolObject>(NormalCleanup, token);
3168 }
3169
Aaron Ballmanc7e4e212014-03-17 14:19:37 +00003170 for (const auto *I : S.body())
3171 EmitStmt(I);
John McCall31168b02011-06-15 23:02:42 +00003172
Eric Christopher7cdf9482011-10-13 21:45:18 +00003173 if (DI)
3174 DI->EmitLexicalBlockEnd(Builder, S.getRBracLoc());
John McCall31168b02011-06-15 23:02:42 +00003175}
John McCall1bd25562011-06-24 23:21:27 +00003176
3177/// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
3178/// make sure it survives garbage collection until this point.
3179void CodeGenFunction::EmitExtendGCLifetime(llvm::Value *object) {
3180 // We just use an inline assembly.
John McCall1bd25562011-06-24 23:21:27 +00003181 llvm::FunctionType *extenderType
John McCalla729c622012-02-17 03:33:10 +00003182 = llvm::FunctionType::get(VoidTy, VoidPtrTy, RequiredArgs::All);
John McCall1bd25562011-06-24 23:21:27 +00003183 llvm::Value *extender
3184 = llvm::InlineAsm::get(extenderType,
3185 /* assembly */ "",
3186 /* constraints */ "r",
3187 /* side effects */ true);
3188
3189 object = Builder.CreateBitCast(object, VoidPtrTy);
John McCall882987f2013-02-28 19:01:20 +00003190 EmitNounwindRuntimeCall(extender, object);
John McCall1bd25562011-06-24 23:21:27 +00003191}
3192
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003193/// GenerateObjCAtomicSetterCopyHelperFunction - Given a c++ object type with
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003194/// non-trivial copy assignment function, produce following helper function.
3195/// static void copyHelper(Ty *dest, const Ty *source) { *dest = *source; }
3196///
3197llvm::Constant *
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003198CodeGenFunction::GenerateObjCAtomicSetterCopyHelperFunction(
3199 const ObjCPropertyImplDecl *PID) {
John McCall5fb5df92012-06-20 06:18:46 +00003200 if (!getLangOpts().CPlusPlus ||
Rafael Espindolad727d3d2012-12-18 04:29:34 +00003201 !getLangOpts().ObjCRuntime.hasAtomicCopyHelper())
Craig Topper8a13c412014-05-21 05:09:00 +00003202 return nullptr;
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003203 QualType Ty = PID->getPropertyIvarDecl()->getType();
3204 if (!Ty->isRecordType())
Craig Topper8a13c412014-05-21 05:09:00 +00003205 return nullptr;
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003206 const ObjCPropertyDecl *PD = PID->getPropertyDecl();
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003207 if ((!(PD->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_atomic)))
Craig Topper8a13c412014-05-21 05:09:00 +00003208 return nullptr;
3209 llvm::Constant *HelperFn = nullptr;
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003210 if (hasTrivialSetExpr(PID))
Craig Topper8a13c412014-05-21 05:09:00 +00003211 return nullptr;
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003212 assert(PID->getSetterCXXAssignment() && "SetterCXXAssignment - null");
3213 if ((HelperFn = CGM.getAtomicSetterHelperFnMap(Ty)))
3214 return HelperFn;
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003215
3216 ASTContext &C = getContext();
3217 IdentifierInfo *II
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003218 = &CGM.getContext().Idents.get("__assign_helper_atomic_property_");
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003219 FunctionDecl *FD = FunctionDecl::Create(C,
3220 C.getTranslationUnitDecl(),
3221 SourceLocation(),
Craig Topper8a13c412014-05-21 05:09:00 +00003222 SourceLocation(), II, C.VoidTy,
3223 nullptr, SC_Static,
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003224 false,
Eric Christopher0b1aef22012-04-12 02:16:49 +00003225 false);
Craig Topper8a13c412014-05-21 05:09:00 +00003226
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003227 QualType DestTy = C.getPointerType(Ty);
3228 QualType SrcTy = Ty;
3229 SrcTy.addConst();
3230 SrcTy = C.getPointerType(SrcTy);
3231
3232 FunctionArgList args;
Craig Topper8a13c412014-05-21 05:09:00 +00003233 ImplicitParamDecl dstDecl(getContext(), FD, SourceLocation(), nullptr,DestTy);
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003234 args.push_back(&dstDecl);
Craig Topper8a13c412014-05-21 05:09:00 +00003235 ImplicitParamDecl srcDecl(getContext(), FD, SourceLocation(), nullptr, SrcTy);
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003236 args.push_back(&srcDecl);
Reid Kleckner4982b822014-01-31 22:54:50 +00003237
John McCallc56a8b32016-03-11 04:30:31 +00003238 const CGFunctionInfo &FI =
3239 CGM.getTypes().arrangeBuiltinFunctionDeclaration(C.VoidTy, args);
Reid Kleckner4982b822014-01-31 22:54:50 +00003240
John McCalla729c622012-02-17 03:33:10 +00003241 llvm::FunctionType *LTy = CGM.getTypes().GetFunctionType(FI);
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003242
3243 llvm::Function *Fn =
3244 llvm::Function::Create(LTy, llvm::GlobalValue::InternalLinkage,
Eric Christopher5d2b8d92012-03-29 17:31:31 +00003245 "__assign_helper_atomic_property_",
3246 &CGM.getModule());
Akira Hatanaka44a59f82015-10-28 02:30:47 +00003247
3248 CGM.SetInternalFunctionAttributes(nullptr, Fn, FI);
3249
Adrian Prantl22e66b42014-04-11 01:13:04 +00003250 StartFunction(FD, C.VoidTy, Fn, FI, args);
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003251
John McCall113bee02012-03-10 09:33:50 +00003252 DeclRefExpr DstExpr(&dstDecl, false, DestTy,
3253 VK_RValue, SourceLocation());
3254 UnaryOperator DST(&DstExpr, UO_Deref, DestTy->getPointeeType(),
3255 VK_LValue, OK_Ordinary, SourceLocation());
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003256
John McCall113bee02012-03-10 09:33:50 +00003257 DeclRefExpr SrcExpr(&srcDecl, false, SrcTy,
3258 VK_RValue, SourceLocation());
3259 UnaryOperator SRC(&SrcExpr, UO_Deref, SrcTy->getPointeeType(),
3260 VK_LValue, OK_Ordinary, SourceLocation());
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003261
John McCall113bee02012-03-10 09:33:50 +00003262 Expr *Args[2] = { &DST, &SRC };
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003263 CallExpr *CalleeExp = cast<CallExpr>(PID->getSetterCXXAssignment());
John McCall113bee02012-03-10 09:33:50 +00003264 CXXOperatorCallExpr TheCall(C, OO_Equal, CalleeExp->getCallee(),
Benjamin Kramerc215e762012-08-24 11:54:20 +00003265 Args, DestTy->getPointeeType(),
Lang Hames5de91cc2012-10-02 04:45:10 +00003266 VK_LValue, SourceLocation(), false);
John McCall113bee02012-03-10 09:33:50 +00003267
3268 EmitStmt(&TheCall);
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003269
3270 FinishFunction();
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00003271 HelperFn = llvm::ConstantExpr::getBitCast(Fn, VoidPtrTy);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003272 CGM.setAtomicSetterHelperFnMap(Ty, HelperFn);
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00003273 return HelperFn;
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003274}
3275
3276llvm::Constant *
3277CodeGenFunction::GenerateObjCAtomicGetterCopyHelperFunction(
3278 const ObjCPropertyImplDecl *PID) {
John McCall5fb5df92012-06-20 06:18:46 +00003279 if (!getLangOpts().CPlusPlus ||
Rafael Espindolad727d3d2012-12-18 04:29:34 +00003280 !getLangOpts().ObjCRuntime.hasAtomicCopyHelper())
Craig Topper8a13c412014-05-21 05:09:00 +00003281 return nullptr;
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003282 const ObjCPropertyDecl *PD = PID->getPropertyDecl();
3283 QualType Ty = PD->getType();
3284 if (!Ty->isRecordType())
Craig Topper8a13c412014-05-21 05:09:00 +00003285 return nullptr;
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003286 if ((!(PD->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_atomic)))
Craig Topper8a13c412014-05-21 05:09:00 +00003287 return nullptr;
3288 llvm::Constant *HelperFn = nullptr;
3289
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003290 if (hasTrivialGetExpr(PID))
Craig Topper8a13c412014-05-21 05:09:00 +00003291 return nullptr;
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003292 assert(PID->getGetterCXXConstructor() && "getGetterCXXConstructor - null");
3293 if ((HelperFn = CGM.getAtomicGetterHelperFnMap(Ty)))
3294 return HelperFn;
3295
3296
3297 ASTContext &C = getContext();
3298 IdentifierInfo *II
3299 = &CGM.getContext().Idents.get("__copy_helper_atomic_property_");
3300 FunctionDecl *FD = FunctionDecl::Create(C,
3301 C.getTranslationUnitDecl(),
3302 SourceLocation(),
Craig Topper8a13c412014-05-21 05:09:00 +00003303 SourceLocation(), II, C.VoidTy,
3304 nullptr, SC_Static,
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003305 false,
Eric Christopher0b1aef22012-04-12 02:16:49 +00003306 false);
Craig Topper8a13c412014-05-21 05:09:00 +00003307
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003308 QualType DestTy = C.getPointerType(Ty);
3309 QualType SrcTy = Ty;
3310 SrcTy.addConst();
3311 SrcTy = C.getPointerType(SrcTy);
3312
3313 FunctionArgList args;
Craig Topper8a13c412014-05-21 05:09:00 +00003314 ImplicitParamDecl dstDecl(getContext(), FD, SourceLocation(), nullptr,DestTy);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003315 args.push_back(&dstDecl);
Craig Topper8a13c412014-05-21 05:09:00 +00003316 ImplicitParamDecl srcDecl(getContext(), FD, SourceLocation(), nullptr, SrcTy);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003317 args.push_back(&srcDecl);
Reid Kleckner4982b822014-01-31 22:54:50 +00003318
John McCallc56a8b32016-03-11 04:30:31 +00003319 const CGFunctionInfo &FI =
3320 CGM.getTypes().arrangeBuiltinFunctionDeclaration(C.VoidTy, args);
Reid Kleckner4982b822014-01-31 22:54:50 +00003321
John McCalla729c622012-02-17 03:33:10 +00003322 llvm::FunctionType *LTy = CGM.getTypes().GetFunctionType(FI);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003323
3324 llvm::Function *Fn =
3325 llvm::Function::Create(LTy, llvm::GlobalValue::InternalLinkage,
3326 "__copy_helper_atomic_property_", &CGM.getModule());
3327
Akira Hatanaka44a59f82015-10-28 02:30:47 +00003328 CGM.SetInternalFunctionAttributes(nullptr, Fn, FI);
3329
Adrian Prantl22e66b42014-04-11 01:13:04 +00003330 StartFunction(FD, C.VoidTy, Fn, FI, args);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003331
John McCall113bee02012-03-10 09:33:50 +00003332 DeclRefExpr SrcExpr(&srcDecl, false, SrcTy,
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003333 VK_RValue, SourceLocation());
3334
John McCall113bee02012-03-10 09:33:50 +00003335 UnaryOperator SRC(&SrcExpr, UO_Deref, SrcTy->getPointeeType(),
3336 VK_LValue, OK_Ordinary, SourceLocation());
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003337
3338 CXXConstructExpr *CXXConstExpr =
3339 cast<CXXConstructExpr>(PID->getGetterCXXConstructor());
3340
3341 SmallVector<Expr*, 4> ConstructorArgs;
John McCall113bee02012-03-10 09:33:50 +00003342 ConstructorArgs.push_back(&SRC);
Benjamin Kramerf367dd92015-06-12 15:31:50 +00003343 ConstructorArgs.append(std::next(CXXConstExpr->arg_begin()),
3344 CXXConstExpr->arg_end());
3345
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003346 CXXConstructExpr *TheCXXConstructExpr =
3347 CXXConstructExpr::Create(C, Ty, SourceLocation(),
3348 CXXConstExpr->getConstructor(),
3349 CXXConstExpr->isElidable(),
Benjamin Kramerc215e762012-08-24 11:54:20 +00003350 ConstructorArgs,
Sebastian Redla9351792012-02-11 23:51:47 +00003351 CXXConstExpr->hadMultipleCandidates(),
3352 CXXConstExpr->isListInitialization(),
Richard Smithf8adcdc2014-07-17 05:12:35 +00003353 CXXConstExpr->isStdInitListInitialization(),
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003354 CXXConstExpr->requiresZeroInitialization(),
Eric Christopher5d2b8d92012-03-29 17:31:31 +00003355 CXXConstExpr->getConstructionKind(),
3356 SourceRange());
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003357
John McCall113bee02012-03-10 09:33:50 +00003358 DeclRefExpr DstExpr(&dstDecl, false, DestTy,
3359 VK_RValue, SourceLocation());
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003360
John McCall113bee02012-03-10 09:33:50 +00003361 RValue DV = EmitAnyExpr(&DstExpr);
Eric Christopher5d2b8d92012-03-29 17:31:31 +00003362 CharUnits Alignment
3363 = getContext().getTypeAlignInChars(TheCXXConstructExpr->getType());
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003364 EmitAggExpr(TheCXXConstructExpr,
John McCall7f416cc2015-09-08 08:05:57 +00003365 AggValueSlot::forAddr(Address(DV.getScalarVal(), Alignment),
3366 Qualifiers(),
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003367 AggValueSlot::IsDestructed,
3368 AggValueSlot::DoesNotNeedGCBarriers,
Chad Rosier615ed1a2012-03-29 17:37:10 +00003369 AggValueSlot::IsNotAliased));
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003370
3371 FinishFunction();
3372 HelperFn = llvm::ConstantExpr::getBitCast(Fn, VoidPtrTy);
3373 CGM.setAtomicGetterHelperFnMap(Ty, HelperFn);
3374 return HelperFn;
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003375}
3376
Eli Friedmanec75fec2012-02-28 01:08:45 +00003377llvm::Value *
3378CodeGenFunction::EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty) {
3379 // Get selectors for retain/autorelease.
Eli Friedmanc4e5d0c2012-03-01 22:52:28 +00003380 IdentifierInfo *CopyID = &getContext().Idents.get("copy");
3381 Selector CopySelector =
3382 getContext().Selectors.getNullarySelector(CopyID);
Eli Friedmanec75fec2012-02-28 01:08:45 +00003383 IdentifierInfo *AutoreleaseID = &getContext().Idents.get("autorelease");
3384 Selector AutoreleaseSelector =
3385 getContext().Selectors.getNullarySelector(AutoreleaseID);
3386
3387 // Emit calls to retain/autorelease.
3388 CGObjCRuntime &Runtime = CGM.getObjCRuntime();
3389 llvm::Value *Val = Block;
3390 RValue Result;
3391 Result = Runtime.GenerateMessageSend(*this, ReturnValueSlot(),
Eli Friedmanc4e5d0c2012-03-01 22:52:28 +00003392 Ty, CopySelector,
Craig Topper8a13c412014-05-21 05:09:00 +00003393 Val, CallArgList(), nullptr, nullptr);
Eli Friedmanec75fec2012-02-28 01:08:45 +00003394 Val = Result.getScalarVal();
3395 Result = Runtime.GenerateMessageSend(*this, ReturnValueSlot(),
3396 Ty, AutoreleaseSelector,
Craig Topper8a13c412014-05-21 05:09:00 +00003397 Val, CallArgList(), nullptr, nullptr);
Eli Friedmanec75fec2012-02-28 01:08:45 +00003398 Val = Result.getScalarVal();
3399 return Val;
3400}
3401
Erik Pilkington9c42a8d2017-02-23 21:08:08 +00003402llvm::Value *
3403CodeGenFunction::EmitBuiltinAvailable(ArrayRef<llvm::Value *> Args) {
3404 assert(Args.size() == 3 && "Expected 3 argument here!");
3405
3406 if (!CGM.IsOSVersionAtLeastFn) {
3407 llvm::FunctionType *FTy =
3408 llvm::FunctionType::get(Int32Ty, {Int32Ty, Int32Ty, Int32Ty}, false);
3409 CGM.IsOSVersionAtLeastFn =
3410 CGM.CreateRuntimeFunction(FTy, "__isOSVersionAtLeast");
3411 }
3412
3413 llvm::Value *CallRes =
3414 EmitNounwindRuntimeCall(CGM.IsOSVersionAtLeastFn, Args);
3415
3416 return Builder.CreateICmpNE(CallRes, llvm::Constant::getNullValue(Int32Ty));
3417}
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003418
Angel Garcia Gomez637d1e62015-10-20 13:23:58 +00003419CGObjCRuntime::~CGObjCRuntime() {}