blob: 766102e723e0e78269bb825896506967f1b31eb1 [file] [log] [blame]
Anders Carlsson76f4a902007-08-21 17:43:55 +00001//===---- CGBuiltin.cpp - Emit LLVM Code for builtins ---------------------===//
2//
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 {
463 result = Runtime.GenerateMessageSend(*this, Return, ResultType,
464 E->getSelector(),
465 Receiver, Args, OID,
John McCallcf166702011-07-22 08:53:00 +0000466 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());
Bob Wilson5ec8fe12014-03-06 06:10:02 +0000560 PGO.assignRegionCounters(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
592 llvm::Value *fn = CGF.CGM.getObjCRuntime().GetGetStructFunction();
John McCall8dda7b22012-07-07 06:41:13 +0000593 CGF.EmitCall(CGF.getTypes().arrangeFreeFunctionCall(Context.VoidTy, args,
594 FunctionType::ExtInfo(),
595 RequiredArgs::All),
John McCallb923ece2011-09-12 23:06:44 +0000596 fn, ReturnValueSlot(), args);
597}
598
John McCallf4528ae2011-09-13 03:34:09 +0000599/// Determine whether the given architecture supports unaligned atomic
600/// accesses. They don't have to be fast, just faster than a function
601/// call and a mutex.
602static bool hasUnalignedAtomics(llvm::Triple::ArchType arch) {
Eli Friedman5be3e6a2011-09-13 20:48:30 +0000603 // FIXME: Allow unaligned atomic load/store on x86. (It is not
604 // currently supported by the backend.)
605 return 0;
John McCallf4528ae2011-09-13 03:34:09 +0000606}
607
608/// Return the maximum size that permits atomic accesses for the given
609/// architecture.
610static CharUnits getMaxAtomicAccessSize(CodeGenModule &CGM,
611 llvm::Triple::ArchType arch) {
612 // ARM has 8-byte atomic accesses, but it's not clear whether we
613 // want to rely on them here.
614
615 // In the default case, just assume that any size up to a pointer is
616 // fine given adequate alignment.
617 return CharUnits::fromQuantity(CGM.PointerSizeInBytes);
618}
619
620namespace {
621 class PropertyImplStrategy {
622 public:
623 enum StrategyKind {
624 /// The 'native' strategy is to use the architecture's provided
625 /// reads and writes.
626 Native,
627
628 /// Use objc_setProperty and objc_getProperty.
629 GetSetProperty,
630
631 /// Use objc_setProperty for the setter, but use expression
632 /// evaluation for the getter.
633 SetPropertyAndExpressionGet,
634
635 /// Use objc_copyStruct.
636 CopyStruct,
637
638 /// The 'expression' strategy is to emit normal assignment or
639 /// lvalue-to-rvalue expressions.
640 Expression
641 };
642
643 StrategyKind getKind() const { return StrategyKind(Kind); }
644
645 bool hasStrongMember() const { return HasStrong; }
646 bool isAtomic() const { return IsAtomic; }
647 bool isCopy() const { return IsCopy; }
648
649 CharUnits getIvarSize() const { return IvarSize; }
650 CharUnits getIvarAlignment() const { return IvarAlignment; }
651
652 PropertyImplStrategy(CodeGenModule &CGM,
653 const ObjCPropertyImplDecl *propImpl);
654
655 private:
656 unsigned Kind : 8;
657 unsigned IsAtomic : 1;
658 unsigned IsCopy : 1;
659 unsigned HasStrong : 1;
660
661 CharUnits IvarSize;
662 CharUnits IvarAlignment;
663 };
Alexander Kornienkoab9db512015-06-22 23:07:51 +0000664}
John McCallf4528ae2011-09-13 03:34:09 +0000665
Sylvestre Ledru830885c2012-07-23 08:59:39 +0000666/// Pick an implementation strategy for the given property synthesis.
John McCallf4528ae2011-09-13 03:34:09 +0000667PropertyImplStrategy::PropertyImplStrategy(CodeGenModule &CGM,
668 const ObjCPropertyImplDecl *propImpl) {
669 const ObjCPropertyDecl *prop = propImpl->getPropertyDecl();
John McCall43192862011-09-13 18:31:23 +0000670 ObjCPropertyDecl::SetterKind setterKind = prop->getSetterKind();
John McCallf4528ae2011-09-13 03:34:09 +0000671
John McCall43192862011-09-13 18:31:23 +0000672 IsCopy = (setterKind == ObjCPropertyDecl::Copy);
673 IsAtomic = prop->isAtomic();
John McCallf4528ae2011-09-13 03:34:09 +0000674 HasStrong = false; // doesn't matter here.
675
676 // Evaluate the ivar's size and alignment.
677 ObjCIvarDecl *ivar = propImpl->getPropertyIvarDecl();
678 QualType ivarType = ivar->getType();
Benjamin Kramer867ea1d2014-03-02 13:01:17 +0000679 std::tie(IvarSize, IvarAlignment) =
680 CGM.getContext().getTypeInfoInChars(ivarType);
John McCallf4528ae2011-09-13 03:34:09 +0000681
682 // If we have a copy property, we always have to use getProperty/setProperty.
John McCall43192862011-09-13 18:31:23 +0000683 // TODO: we could actually use setProperty and an expression for non-atomics.
John McCallf4528ae2011-09-13 03:34:09 +0000684 if (IsCopy) {
685 Kind = GetSetProperty;
686 return;
687 }
688
John McCall43192862011-09-13 18:31:23 +0000689 // Handle retain.
690 if (setterKind == ObjCPropertyDecl::Retain) {
John McCallf4528ae2011-09-13 03:34:09 +0000691 // In GC-only, there's nothing special that needs to be done.
David Blaikiebbafb8a2012-03-11 07:00:24 +0000692 if (CGM.getLangOpts().getGC() == LangOptions::GCOnly) {
John McCallf4528ae2011-09-13 03:34:09 +0000693 // fallthrough
694
695 // In ARC, if the property is non-atomic, use expression emission,
696 // which translates to objc_storeStrong. This isn't required, but
697 // it's slightly nicer.
David Blaikiebbafb8a2012-03-11 07:00:24 +0000698 } else if (CGM.getLangOpts().ObjCAutoRefCount && !IsAtomic) {
John McCalld8561f02012-08-20 23:36:59 +0000699 // Using standard expression emission for the setter is only
700 // acceptable if the ivar is __strong, which won't be true if
701 // the property is annotated with __attribute__((NSObject)).
702 // TODO: falling all the way back to objc_setProperty here is
703 // just laziness, though; we could still use objc_storeStrong
704 // if we hacked it right.
705 if (ivarType.getObjCLifetime() == Qualifiers::OCL_Strong)
706 Kind = Expression;
707 else
708 Kind = SetPropertyAndExpressionGet;
John McCallf4528ae2011-09-13 03:34:09 +0000709 return;
710
711 // Otherwise, we need to at least use setProperty. However, if
712 // the property isn't atomic, we can use normal expression
713 // emission for the getter.
714 } else if (!IsAtomic) {
715 Kind = SetPropertyAndExpressionGet;
716 return;
717
718 // Otherwise, we have to use both setProperty and getProperty.
719 } else {
720 Kind = GetSetProperty;
721 return;
722 }
723 }
724
725 // If we're not atomic, just use expression accesses.
726 if (!IsAtomic) {
727 Kind = Expression;
728 return;
729 }
730
John McCall0e5c0862011-09-13 05:36:29 +0000731 // Properties on bitfield ivars need to be emitted using expression
732 // accesses even if they're nominally atomic.
733 if (ivar->isBitField()) {
734 Kind = Expression;
735 return;
736 }
737
John McCallf4528ae2011-09-13 03:34:09 +0000738 // GC-qualified or ARC-qualified ivars need to be emitted as
739 // expressions. This actually works out to being atomic anyway,
740 // except for ARC __strong, but that should trigger the above code.
741 if (ivarType.hasNonTrivialObjCLifetime() ||
David Blaikiebbafb8a2012-03-11 07:00:24 +0000742 (CGM.getLangOpts().getGC() &&
John McCallf4528ae2011-09-13 03:34:09 +0000743 CGM.getContext().getObjCGCAttrKind(ivarType))) {
744 Kind = Expression;
745 return;
746 }
747
748 // Compute whether the ivar has strong members.
David Blaikiebbafb8a2012-03-11 07:00:24 +0000749 if (CGM.getLangOpts().getGC())
John McCallf4528ae2011-09-13 03:34:09 +0000750 if (const RecordType *recordType = ivarType->getAs<RecordType>())
751 HasStrong = recordType->getDecl()->hasObjectMember();
752
753 // We can never access structs with object members with a native
754 // access, because we need to use write barriers. This is what
755 // objc_copyStruct is for.
756 if (HasStrong) {
757 Kind = CopyStruct;
758 return;
759 }
760
761 // Otherwise, this is target-dependent and based on the size and
762 // alignment of the ivar.
John McCall0bef0ba2011-09-13 07:33:34 +0000763
764 // If the size of the ivar is not a power of two, give up. We don't
765 // want to get into the business of doing compare-and-swaps.
766 if (!IvarSize.isPowerOfTwo()) {
767 Kind = CopyStruct;
768 return;
769 }
770
John McCallf4528ae2011-09-13 03:34:09 +0000771 llvm::Triple::ArchType arch =
John McCallc8e01702013-04-16 22:48:15 +0000772 CGM.getTarget().getTriple().getArch();
John McCallf4528ae2011-09-13 03:34:09 +0000773
774 // Most architectures require memory to fit within a single cache
775 // line, so the alignment has to be at least the size of the access.
776 // Otherwise we have to grab a lock.
777 if (IvarAlignment < IvarSize && !hasUnalignedAtomics(arch)) {
778 Kind = CopyStruct;
779 return;
780 }
781
782 // If the ivar's size exceeds the architecture's maximum atomic
783 // access size, we have to use CopyStruct.
784 if (IvarSize > getMaxAtomicAccessSize(CGM, arch)) {
785 Kind = CopyStruct;
786 return;
787 }
788
789 // Otherwise, we can use native loads and stores.
790 Kind = Native;
791}
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000792
James Dennettbe302452012-06-15 22:10:14 +0000793/// \brief Generate an Objective-C property getter function.
794///
795/// The given Decl must be an ObjCImplementationDecl. \@synthesize
Steve Naroff5a7dd782009-01-10 22:55:25 +0000796/// is illegal within a category.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +0000797void CodeGenFunction::GenerateObjCGetter(ObjCImplementationDecl *IMP,
798 const ObjCPropertyImplDecl *PID) {
David Blaikie8e6c36e2014-10-14 16:43:46 +0000799 llvm::Constant *AtomicHelperFn =
800 CodeGenFunction(CGM).GenerateObjCAtomicGetterCopyHelperFunction(PID);
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000801 const ObjCPropertyDecl *PD = PID->getPropertyDecl();
802 ObjCMethodDecl *OMD = PD->getGetterMethodDecl();
803 assert(OMD && "Invalid call to generate getter (empty method)");
David Blaikief1425802015-01-14 00:04:42 +0000804 StartObjCMethod(OMD, IMP->getClassInterface());
Mike Stump11289f42009-09-09 15:08:12 +0000805
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +0000806 generateObjCGetterBody(IMP, PID, OMD, AtomicHelperFn);
John McCallf4528ae2011-09-13 03:34:09 +0000807
808 FinishFunction();
809}
810
John McCallbdd81852011-09-13 06:00:03 +0000811static bool hasTrivialGetExpr(const ObjCPropertyImplDecl *propImpl) {
812 const Expr *getter = propImpl->getGetterCXXConstructor();
John McCallf4528ae2011-09-13 03:34:09 +0000813 if (!getter) return true;
814
815 // Sema only makes only of these when the ivar has a C++ class type,
816 // so the form is pretty constrained.
817
John McCallbdd81852011-09-13 06:00:03 +0000818 // If the property has a reference type, we might just be binding a
819 // reference, in which case the result will be a gl-value. We should
820 // treat this as a non-trivial operation.
821 if (getter->isGLValue())
822 return false;
823
John McCallf4528ae2011-09-13 03:34:09 +0000824 // If we selected a trivial copy-constructor, we're okay.
825 if (const CXXConstructExpr *construct = dyn_cast<CXXConstructExpr>(getter))
826 return (construct->getConstructor()->isTrivial());
827
828 // The constructor might require cleanups (in which case it's never
829 // trivial).
830 assert(isa<ExprWithCleanups>(getter));
831 return false;
832}
833
Fariborz Jahaniana08a7472012-01-10 00:37:01 +0000834/// emitCPPObjectAtomicGetterCall - Call the runtime function to
835/// copy the ivar into the resturn slot.
836static void emitCPPObjectAtomicGetterCall(CodeGenFunction &CGF,
837 llvm::Value *returnAddr,
838 ObjCIvarDecl *ivar,
839 llvm::Constant *AtomicHelperFn) {
840 // objc_copyCppObjectAtomic (&returnSlot, &CppObjectIvar,
841 // AtomicHelperFn);
842 CallArgList args;
843
844 // The 1st argument is the return Slot.
845 args.add(RValue::get(returnAddr), CGF.getContext().VoidPtrTy);
846
847 // The 2nd argument is the address of the ivar.
848 llvm::Value *ivarAddr =
John McCall7f416cc2015-09-08 08:05:57 +0000849 CGF.EmitLValueForIvar(CGF.TypeOfSelfObject(),
850 CGF.LoadObjCSelf(), ivar, 0).getPointer();
Fariborz Jahaniana08a7472012-01-10 00:37:01 +0000851 ivarAddr = CGF.Builder.CreateBitCast(ivarAddr, CGF.Int8PtrTy);
852 args.add(RValue::get(ivarAddr), CGF.getContext().VoidPtrTy);
853
854 // Third argument is the helper function.
855 args.add(RValue::get(AtomicHelperFn), CGF.getContext().VoidPtrTy);
856
857 llvm::Value *copyCppAtomicObjectFn =
David Chisnall0d75e062012-12-17 18:54:24 +0000858 CGF.CGM.getObjCRuntime().GetCppAtomicObjectGetFunction();
John McCall8dda7b22012-07-07 06:41:13 +0000859 CGF.EmitCall(CGF.getTypes().arrangeFreeFunctionCall(CGF.getContext().VoidTy,
860 args,
861 FunctionType::ExtInfo(),
862 RequiredArgs::All),
Fariborz Jahaniana08a7472012-01-10 00:37:01 +0000863 copyCppAtomicObjectFn, ReturnValueSlot(), args);
864}
865
John McCallf4528ae2011-09-13 03:34:09 +0000866void
867CodeGenFunction::generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +0000868 const ObjCPropertyImplDecl *propImpl,
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +0000869 const ObjCMethodDecl *GetterMethodDecl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +0000870 llvm::Constant *AtomicHelperFn) {
John McCallf4528ae2011-09-13 03:34:09 +0000871 // If there's a non-trivial 'get' expression, we just have to emit that.
872 if (!hasTrivialGetExpr(propImpl)) {
Fariborz Jahaniana08a7472012-01-10 00:37:01 +0000873 if (!AtomicHelperFn) {
874 ReturnStmt ret(SourceLocation(), propImpl->getGetterCXXConstructor(),
Craig Topper8a13c412014-05-21 05:09:00 +0000875 /*nrvo*/ nullptr);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +0000876 EmitReturnStmt(ret);
877 }
878 else {
879 ObjCIvarDecl *ivar = propImpl->getPropertyIvarDecl();
John McCall7f416cc2015-09-08 08:05:57 +0000880 emitCPPObjectAtomicGetterCall(*this, ReturnValue.getPointer(),
Fariborz Jahaniana08a7472012-01-10 00:37:01 +0000881 ivar, AtomicHelperFn);
882 }
John McCallf4528ae2011-09-13 03:34:09 +0000883 return;
884 }
885
886 const ObjCPropertyDecl *prop = propImpl->getPropertyDecl();
887 QualType propType = prop->getType();
888 ObjCMethodDecl *getterMethod = prop->getGetterMethodDecl();
889
890 ObjCIvarDecl *ivar = propImpl->getPropertyIvarDecl();
891
892 // Pick an implementation strategy.
893 PropertyImplStrategy strategy(CGM, propImpl);
894 switch (strategy.getKind()) {
895 case PropertyImplStrategy::Native: {
Eli Friedman0e846022012-10-26 22:38:05 +0000896 // We don't need to do anything for a zero-size struct.
897 if (strategy.getIvarSize().isZero())
898 return;
899
John McCallf4528ae2011-09-13 03:34:09 +0000900 LValue LV = EmitLValueForIvar(TypeOfSelfObject(), LoadObjCSelf(), ivar, 0);
901
902 // Currently, all atomic accesses have to be through integer
903 // types, so there's no point in trying to pick a prettier type.
904 llvm::Type *bitcastType =
905 llvm::Type::getIntNTy(getLLVMContext(),
906 getContext().toBits(strategy.getIvarSize()));
907 bitcastType = bitcastType->getPointerTo(); // addrspace 0 okay
908
909 // Perform an atomic load. This does not impose ordering constraints.
John McCall7f416cc2015-09-08 08:05:57 +0000910 Address ivarAddr = LV.getAddress();
John McCallf4528ae2011-09-13 03:34:09 +0000911 ivarAddr = Builder.CreateBitCast(ivarAddr, bitcastType);
912 llvm::LoadInst *load = Builder.CreateLoad(ivarAddr, "load");
John McCallf4528ae2011-09-13 03:34:09 +0000913 load->setAtomic(llvm::Unordered);
914
915 // Store that value into the return address. Doing this with a
916 // bitcast is likely to produce some pretty ugly IR, but it's not
917 // the *most* terrible thing in the world.
918 Builder.CreateStore(load, Builder.CreateBitCast(ReturnValue, bitcastType));
919
920 // Make sure we don't do an autorelease.
921 AutoreleaseResult = false;
922 return;
923 }
924
925 case PropertyImplStrategy::GetSetProperty: {
926 llvm::Value *getPropertyFn =
927 CGM.getObjCRuntime().GetPropertyGetFunction();
928 if (!getPropertyFn) {
929 CGM.ErrorUnsupported(propImpl, "Obj-C getter requiring atomic copy");
Daniel Dunbara08dff12008-09-24 04:04:31 +0000930 return;
931 }
932
933 // Return (ivar-type) objc_getProperty((id) self, _cmd, offset, true).
934 // FIXME: Can't this be simpler? This might even be worse than the
935 // corresponding gcc code.
John McCallf4528ae2011-09-13 03:34:09 +0000936 llvm::Value *cmd =
John McCall7f416cc2015-09-08 08:05:57 +0000937 Builder.CreateLoad(GetAddrOfLocalVar(getterMethod->getCmdDecl()), "cmd");
John McCallf4528ae2011-09-13 03:34:09 +0000938 llvm::Value *self = Builder.CreateBitCast(LoadObjCSelf(), VoidPtrTy);
939 llvm::Value *ivarOffset =
940 EmitIvarOffset(classImpl->getClassInterface(), ivar);
941
942 CallArgList args;
943 args.add(RValue::get(self), getContext().getObjCIdType());
944 args.add(RValue::get(cmd), getContext().getObjCSelType());
945 args.add(RValue::get(ivarOffset), getContext().getPointerDiffType());
John McCall43192862011-09-13 18:31:23 +0000946 args.add(RValue::get(Builder.getInt1(strategy.isAtomic())),
947 getContext().BoolTy);
John McCallf4528ae2011-09-13 03:34:09 +0000948
Daniel Dunbar1ef73732009-02-03 23:43:59 +0000949 // FIXME: We shouldn't need to get the function info here, the
950 // runtime already should have computed it to build the function.
Fariborz Jahanian13b43042014-01-30 00:16:39 +0000951 llvm::Instruction *CallInstruction;
John McCall8dda7b22012-07-07 06:41:13 +0000952 RValue RV = EmitCall(getTypes().arrangeFreeFunctionCall(propType, args,
953 FunctionType::ExtInfo(),
954 RequiredArgs::All),
Craig Topper8a13c412014-05-21 05:09:00 +0000955 getPropertyFn, ReturnValueSlot(), args, nullptr,
Fariborz Jahanian13b43042014-01-30 00:16:39 +0000956 &CallInstruction);
957 if (llvm::CallInst *call = dyn_cast<llvm::CallInst>(CallInstruction))
958 call->setTailCall();
John McCallf4528ae2011-09-13 03:34:09 +0000959
Daniel Dunbara08dff12008-09-24 04:04:31 +0000960 // We need to fix the type here. Ivars with copy & retain are
961 // always objects so we don't need to worry about complex or
962 // aggregates.
Alp Toker314cc812014-01-25 16:55:45 +0000963 RV = RValue::get(Builder.CreateBitCast(
964 RV.getScalarVal(),
965 getTypes().ConvertType(getterMethod->getReturnType())));
John McCallf4528ae2011-09-13 03:34:09 +0000966
967 EmitReturnOfRValue(RV, propType);
John McCall31168b02011-06-15 23:02:42 +0000968
969 // objc_getProperty does an autorelease, so we should suppress ours.
970 AutoreleaseResult = false;
John McCall31168b02011-06-15 23:02:42 +0000971
John McCallf4528ae2011-09-13 03:34:09 +0000972 return;
973 }
974
975 case PropertyImplStrategy::CopyStruct:
976 emitStructGetterCall(*this, ivar, strategy.isAtomic(),
977 strategy.hasStrongMember());
978 return;
979
980 case PropertyImplStrategy::Expression:
981 case PropertyImplStrategy::SetPropertyAndExpressionGet: {
982 LValue LV = EmitLValueForIvar(TypeOfSelfObject(), LoadObjCSelf(), ivar, 0);
983
984 QualType ivarType = ivar->getType();
John McCall47fb9502013-03-07 21:37:08 +0000985 switch (getEvaluationKind(ivarType)) {
986 case TEK_Complex: {
Nick Lewycky2d84e842013-10-02 02:29:49 +0000987 ComplexPairTy pair = EmitLoadOfComplex(LV, SourceLocation());
John McCall7f416cc2015-09-08 08:05:57 +0000988 EmitStoreOfComplex(pair, MakeAddrLValue(ReturnValue, ivarType),
John McCall47fb9502013-03-07 21:37:08 +0000989 /*init*/ true);
990 return;
991 }
992 case TEK_Aggregate:
John McCallf4528ae2011-09-13 03:34:09 +0000993 // The return value slot is guaranteed to not be aliased, but
994 // that's not necessarily the same as "on the stack", so
995 // we still potentially need objc_memmove_collectable.
Chad Rosier615ed1a2012-03-29 17:37:10 +0000996 EmitAggregateCopy(ReturnValue, LV.getAddress(), ivarType);
John McCall47fb9502013-03-07 21:37:08 +0000997 return;
998 case TEK_Scalar: {
John McCall24fada12011-07-22 05:23:13 +0000999 llvm::Value *value;
1000 if (propType->isReferenceType()) {
John McCall7f416cc2015-09-08 08:05:57 +00001001 value = LV.getAddress().getPointer();
John McCall24fada12011-07-22 05:23:13 +00001002 } else {
1003 // We want to load and autoreleaseReturnValue ARC __weak ivars.
1004 if (LV.getQuals().getObjCLifetime() == Qualifiers::OCL_Weak) {
John McCall460ce582015-10-22 18:38:17 +00001005 if (getLangOpts().ObjCAutoRefCount) {
1006 value = emitARCRetainLoadOfScalar(*this, LV, ivarType);
1007 } else {
1008 value = EmitARCLoadWeak(LV.getAddress());
1009 }
John McCall24fada12011-07-22 05:23:13 +00001010
1011 // Otherwise we want to do a simple load, suppressing the
1012 // final autorelease.
John McCall31168b02011-06-15 23:02:42 +00001013 } else {
Nick Lewycky2d84e842013-10-02 02:29:49 +00001014 value = EmitLoadOfLValue(LV, SourceLocation()).getScalarVal();
John McCall24fada12011-07-22 05:23:13 +00001015 AutoreleaseResult = false;
Fariborz Jahanianb24b5682011-03-28 23:47:18 +00001016 }
John McCall31168b02011-06-15 23:02:42 +00001017
John McCall24fada12011-07-22 05:23:13 +00001018 value = Builder.CreateBitCast(value, ConvertType(propType));
Alp Toker314cc812014-01-25 16:55:45 +00001019 value = Builder.CreateBitCast(
1020 value, ConvertType(GetterMethodDecl->getReturnType()));
John McCall24fada12011-07-22 05:23:13 +00001021 }
1022
1023 EmitReturnOfRValue(RValue::get(value), propType);
John McCall47fb9502013-03-07 21:37:08 +00001024 return;
Fariborz Jahanianeab5ecd2009-03-03 18:49:40 +00001025 }
John McCall47fb9502013-03-07 21:37:08 +00001026 }
1027 llvm_unreachable("bad evaluation kind");
Daniel Dunbara08dff12008-09-24 04:04:31 +00001028 }
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001029
John McCallf4528ae2011-09-13 03:34:09 +00001030 }
1031 llvm_unreachable("bad @property implementation strategy!");
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001032}
1033
John McCallb923ece2011-09-12 23:06:44 +00001034/// emitStructSetterCall - Call the runtime function to store the value
1035/// from the first formal parameter into the given ivar.
1036static void emitStructSetterCall(CodeGenFunction &CGF, ObjCMethodDecl *OMD,
1037 ObjCIvarDecl *ivar) {
Fariborz Jahanian302a3d42011-02-18 19:15:13 +00001038 // objc_copyStruct (&structIvar, &Arg,
1039 // sizeof (struct something), true, false);
John McCall6acaef92011-09-10 09:30:49 +00001040 CallArgList args;
1041
1042 // The first argument is the address of the ivar.
John McCallb923ece2011-09-12 23:06:44 +00001043 llvm::Value *ivarAddr = CGF.EmitLValueForIvar(CGF.TypeOfSelfObject(),
1044 CGF.LoadObjCSelf(), ivar, 0)
John McCall7f416cc2015-09-08 08:05:57 +00001045 .getPointer();
John McCallb923ece2011-09-12 23:06:44 +00001046 ivarAddr = CGF.Builder.CreateBitCast(ivarAddr, CGF.Int8PtrTy);
1047 args.add(RValue::get(ivarAddr), CGF.getContext().VoidPtrTy);
John McCall6acaef92011-09-10 09:30:49 +00001048
1049 // The second argument is the address of the parameter variable.
John McCallb923ece2011-09-12 23:06:44 +00001050 ParmVarDecl *argVar = *OMD->param_begin();
John McCall113bee02012-03-10 09:33:50 +00001051 DeclRefExpr argRef(argVar, false, argVar->getType().getNonReferenceType(),
Fariborz Jahanian088f1bc2012-01-05 00:10:16 +00001052 VK_LValue, SourceLocation());
John McCall7f416cc2015-09-08 08:05:57 +00001053 llvm::Value *argAddr = CGF.EmitLValue(&argRef).getPointer();
John McCallb923ece2011-09-12 23:06:44 +00001054 argAddr = CGF.Builder.CreateBitCast(argAddr, CGF.Int8PtrTy);
1055 args.add(RValue::get(argAddr), CGF.getContext().VoidPtrTy);
John McCall6acaef92011-09-10 09:30:49 +00001056
1057 // The third argument is the sizeof the type.
1058 llvm::Value *size =
John McCallb923ece2011-09-12 23:06:44 +00001059 CGF.CGM.getSize(CGF.getContext().getTypeSizeInChars(ivar->getType()));
1060 args.add(RValue::get(size), CGF.getContext().getSizeType());
John McCall6acaef92011-09-10 09:30:49 +00001061
John McCallb923ece2011-09-12 23:06:44 +00001062 // The fourth argument is the 'isAtomic' flag.
1063 args.add(RValue::get(CGF.Builder.getTrue()), CGF.getContext().BoolTy);
John McCall6acaef92011-09-10 09:30:49 +00001064
John McCallb923ece2011-09-12 23:06:44 +00001065 // The fifth argument is the 'hasStrong' flag.
1066 // FIXME: should this really always be false?
1067 args.add(RValue::get(CGF.Builder.getFalse()), CGF.getContext().BoolTy);
1068
1069 llvm::Value *copyStructFn = CGF.CGM.getObjCRuntime().GetSetStructFunction();
John McCall8dda7b22012-07-07 06:41:13 +00001070 CGF.EmitCall(CGF.getTypes().arrangeFreeFunctionCall(CGF.getContext().VoidTy,
1071 args,
1072 FunctionType::ExtInfo(),
1073 RequiredArgs::All),
John McCallb923ece2011-09-12 23:06:44 +00001074 copyStructFn, ReturnValueSlot(), args);
Fariborz Jahanian302a3d42011-02-18 19:15:13 +00001075}
1076
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001077/// emitCPPObjectAtomicSetterCall - Call the runtime function to store
1078/// the value from the first formal parameter into the given ivar, using
1079/// the Cpp API for atomic Cpp objects with non-trivial copy assignment.
1080static void emitCPPObjectAtomicSetterCall(CodeGenFunction &CGF,
1081 ObjCMethodDecl *OMD,
1082 ObjCIvarDecl *ivar,
1083 llvm::Constant *AtomicHelperFn) {
1084 // objc_copyCppObjectAtomic (&CppObjectIvar, &Arg,
1085 // AtomicHelperFn);
1086 CallArgList args;
1087
1088 // The first argument is the address of the ivar.
1089 llvm::Value *ivarAddr =
1090 CGF.EmitLValueForIvar(CGF.TypeOfSelfObject(),
John McCall7f416cc2015-09-08 08:05:57 +00001091 CGF.LoadObjCSelf(), ivar, 0).getPointer();
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001092 ivarAddr = CGF.Builder.CreateBitCast(ivarAddr, CGF.Int8PtrTy);
1093 args.add(RValue::get(ivarAddr), CGF.getContext().VoidPtrTy);
1094
1095 // The second argument is the address of the parameter variable.
1096 ParmVarDecl *argVar = *OMD->param_begin();
John McCall113bee02012-03-10 09:33:50 +00001097 DeclRefExpr argRef(argVar, false, argVar->getType().getNonReferenceType(),
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001098 VK_LValue, SourceLocation());
John McCall7f416cc2015-09-08 08:05:57 +00001099 llvm::Value *argAddr = CGF.EmitLValue(&argRef).getPointer();
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001100 argAddr = CGF.Builder.CreateBitCast(argAddr, CGF.Int8PtrTy);
1101 args.add(RValue::get(argAddr), CGF.getContext().VoidPtrTy);
1102
1103 // Third argument is the helper function.
1104 args.add(RValue::get(AtomicHelperFn), CGF.getContext().VoidPtrTy);
1105
1106 llvm::Value *copyCppAtomicObjectFn =
David Chisnall0d75e062012-12-17 18:54:24 +00001107 CGF.CGM.getObjCRuntime().GetCppAtomicObjectSetFunction();
John McCall8dda7b22012-07-07 06:41:13 +00001108 CGF.EmitCall(CGF.getTypes().arrangeFreeFunctionCall(CGF.getContext().VoidTy,
1109 args,
1110 FunctionType::ExtInfo(),
1111 RequiredArgs::All),
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001112 copyCppAtomicObjectFn, ReturnValueSlot(), args);
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001113}
1114
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00001115
John McCallf4528ae2011-09-13 03:34:09 +00001116static bool hasTrivialSetExpr(const ObjCPropertyImplDecl *PID) {
1117 Expr *setter = PID->getSetterCXXAssignment();
1118 if (!setter) return true;
1119
1120 // Sema only makes only of these when the ivar has a C++ class type,
1121 // so the form is pretty constrained.
John McCall7f16c422011-09-10 09:17:20 +00001122
1123 // An operator call is trivial if the function it calls is trivial.
John McCallf4528ae2011-09-13 03:34:09 +00001124 // This also implies that there's nothing non-trivial going on with
1125 // the arguments, because operator= can only be trivial if it's a
1126 // synthesized assignment operator and therefore both parameters are
1127 // references.
1128 if (CallExpr *call = dyn_cast<CallExpr>(setter)) {
John McCall7f16c422011-09-10 09:17:20 +00001129 if (const FunctionDecl *callee
1130 = dyn_cast_or_null<FunctionDecl>(call->getCalleeDecl()))
1131 if (callee->isTrivial())
1132 return true;
1133 return false;
Fariborz Jahanian5de53132011-04-06 16:05:26 +00001134 }
John McCall7f16c422011-09-10 09:17:20 +00001135
John McCallf4528ae2011-09-13 03:34:09 +00001136 assert(isa<ExprWithCleanups>(setter));
John McCall7f16c422011-09-10 09:17:20 +00001137 return false;
1138}
1139
Benjamin Kramer53ba6362012-03-10 20:38:56 +00001140static bool UseOptimizedSetter(CodeGenModule &CGM) {
David Blaikiebbafb8a2012-03-11 07:00:24 +00001141 if (CGM.getLangOpts().getGC() != LangOptions::NonGC)
Ted Kremeneke65b0862012-03-06 20:05:56 +00001142 return false;
Daniel Dunbarbd847cc2012-10-15 22:23:53 +00001143 return CGM.getLangOpts().ObjCRuntime.hasOptimizedSetter();
Ted Kremeneke65b0862012-03-06 20:05:56 +00001144}
1145
John McCall7f16c422011-09-10 09:17:20 +00001146void
1147CodeGenFunction::generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001148 const ObjCPropertyImplDecl *propImpl,
1149 llvm::Constant *AtomicHelperFn) {
John McCall7f16c422011-09-10 09:17:20 +00001150 const ObjCPropertyDecl *prop = propImpl->getPropertyDecl();
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00001151 ObjCIvarDecl *ivar = propImpl->getPropertyIvarDecl();
John McCall7f16c422011-09-10 09:17:20 +00001152 ObjCMethodDecl *setterMethod = prop->getSetterMethodDecl();
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001153
1154 // Just use the setter expression if Sema gave us one and it's
1155 // non-trivial.
1156 if (!hasTrivialSetExpr(propImpl)) {
1157 if (!AtomicHelperFn)
1158 // If non-atomic, assignment is called directly.
1159 EmitStmt(propImpl->getSetterCXXAssignment());
1160 else
1161 // If atomic, assignment is called via a locking api.
1162 emitCPPObjectAtomicSetterCall(*this, setterMethod, ivar,
1163 AtomicHelperFn);
1164 return;
1165 }
John McCall7f16c422011-09-10 09:17:20 +00001166
John McCallf4528ae2011-09-13 03:34:09 +00001167 PropertyImplStrategy strategy(CGM, propImpl);
1168 switch (strategy.getKind()) {
1169 case PropertyImplStrategy::Native: {
Eli Friedman0e846022012-10-26 22:38:05 +00001170 // We don't need to do anything for a zero-size struct.
1171 if (strategy.getIvarSize().isZero())
1172 return;
1173
John McCall7f416cc2015-09-08 08:05:57 +00001174 Address argAddr = GetAddrOfLocalVar(*setterMethod->param_begin());
John McCall7f16c422011-09-10 09:17:20 +00001175
John McCallf4528ae2011-09-13 03:34:09 +00001176 LValue ivarLValue =
1177 EmitLValueForIvar(TypeOfSelfObject(), LoadObjCSelf(), ivar, /*quals*/ 0);
John McCall7f416cc2015-09-08 08:05:57 +00001178 Address ivarAddr = ivarLValue.getAddress();
John McCall7f16c422011-09-10 09:17:20 +00001179
John McCallf4528ae2011-09-13 03:34:09 +00001180 // Currently, all atomic accesses have to be through integer
1181 // types, so there's no point in trying to pick a prettier type.
1182 llvm::Type *bitcastType =
1183 llvm::Type::getIntNTy(getLLVMContext(),
1184 getContext().toBits(strategy.getIvarSize()));
John McCallf4528ae2011-09-13 03:34:09 +00001185
1186 // Cast both arguments to the chosen operation type.
John McCall7f416cc2015-09-08 08:05:57 +00001187 argAddr = Builder.CreateElementBitCast(argAddr, bitcastType);
1188 ivarAddr = Builder.CreateElementBitCast(ivarAddr, bitcastType);
John McCallf4528ae2011-09-13 03:34:09 +00001189
1190 // This bitcast load is likely to cause some nasty IR.
1191 llvm::Value *load = Builder.CreateLoad(argAddr);
1192
1193 // Perform an atomic store. There are no memory ordering requirements.
1194 llvm::StoreInst *store = Builder.CreateStore(load, ivarAddr);
John McCallf4528ae2011-09-13 03:34:09 +00001195 store->setAtomic(llvm::Unordered);
1196 return;
1197 }
1198
1199 case PropertyImplStrategy::GetSetProperty:
1200 case PropertyImplStrategy::SetPropertyAndExpressionGet: {
Craig Topper8a13c412014-05-21 05:09:00 +00001201
1202 llvm::Value *setOptimizedPropertyFn = nullptr;
1203 llvm::Value *setPropertyFn = nullptr;
Ted Kremeneke65b0862012-03-06 20:05:56 +00001204 if (UseOptimizedSetter(CGM)) {
Daniel Dunbarbd847cc2012-10-15 22:23:53 +00001205 // 10.8 and iOS 6.0 code and GC is off
Ted Kremeneke65b0862012-03-06 20:05:56 +00001206 setOptimizedPropertyFn =
Eric Christopher5d2b8d92012-03-29 17:31:31 +00001207 CGM.getObjCRuntime()
1208 .GetOptimizedPropertySetFunction(strategy.isAtomic(),
1209 strategy.isCopy());
Ted Kremeneke65b0862012-03-06 20:05:56 +00001210 if (!setOptimizedPropertyFn) {
1211 CGM.ErrorUnsupported(propImpl, "Obj-C optimized setter - NYI");
1212 return;
1213 }
John McCall7f16c422011-09-10 09:17:20 +00001214 }
Ted Kremeneke65b0862012-03-06 20:05:56 +00001215 else {
1216 setPropertyFn = CGM.getObjCRuntime().GetPropertySetFunction();
1217 if (!setPropertyFn) {
1218 CGM.ErrorUnsupported(propImpl, "Obj-C setter requiring atomic copy");
1219 return;
1220 }
1221 }
1222
John McCall7f16c422011-09-10 09:17:20 +00001223 // Emit objc_setProperty((id) self, _cmd, offset, arg,
1224 // <is-atomic>, <is-copy>).
1225 llvm::Value *cmd =
John McCall7f416cc2015-09-08 08:05:57 +00001226 Builder.CreateLoad(GetAddrOfLocalVar(setterMethod->getCmdDecl()));
John McCall7f16c422011-09-10 09:17:20 +00001227 llvm::Value *self =
1228 Builder.CreateBitCast(LoadObjCSelf(), VoidPtrTy);
1229 llvm::Value *ivarOffset =
1230 EmitIvarOffset(classImpl->getClassInterface(), ivar);
John McCall7f416cc2015-09-08 08:05:57 +00001231 Address argAddr = GetAddrOfLocalVar(*setterMethod->param_begin());
1232 llvm::Value *arg = Builder.CreateLoad(argAddr, "arg");
1233 arg = Builder.CreateBitCast(arg, VoidPtrTy);
John McCall7f16c422011-09-10 09:17:20 +00001234
1235 CallArgList args;
1236 args.add(RValue::get(self), getContext().getObjCIdType());
1237 args.add(RValue::get(cmd), getContext().getObjCSelType());
Ted Kremeneke65b0862012-03-06 20:05:56 +00001238 if (setOptimizedPropertyFn) {
1239 args.add(RValue::get(arg), getContext().getObjCIdType());
1240 args.add(RValue::get(ivarOffset), getContext().getPointerDiffType());
John McCall8dda7b22012-07-07 06:41:13 +00001241 EmitCall(getTypes().arrangeFreeFunctionCall(getContext().VoidTy, args,
1242 FunctionType::ExtInfo(),
1243 RequiredArgs::All),
Ted Kremeneke65b0862012-03-06 20:05:56 +00001244 setOptimizedPropertyFn, ReturnValueSlot(), args);
1245 } else {
1246 args.add(RValue::get(ivarOffset), getContext().getPointerDiffType());
1247 args.add(RValue::get(arg), getContext().getObjCIdType());
1248 args.add(RValue::get(Builder.getInt1(strategy.isAtomic())),
1249 getContext().BoolTy);
1250 args.add(RValue::get(Builder.getInt1(strategy.isCopy())),
1251 getContext().BoolTy);
1252 // FIXME: We shouldn't need to get the function info here, the runtime
1253 // already should have computed it to build the function.
John McCall8dda7b22012-07-07 06:41:13 +00001254 EmitCall(getTypes().arrangeFreeFunctionCall(getContext().VoidTy, args,
1255 FunctionType::ExtInfo(),
1256 RequiredArgs::All),
Ted Kremeneke65b0862012-03-06 20:05:56 +00001257 setPropertyFn, ReturnValueSlot(), args);
1258 }
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){
Mike Stump11289f42009-09-09 15:08:12 +00001459 llvm::Constant *EnumerationMutationFn =
Daniel Dunbara08dff12008-09-24 04:04:31 +00001460 CGM.getObjCRuntime().EnumerationMutationFunction();
Mike Stump11289f42009-09-09 15:08:12 +00001461
Daniel Dunbara08dff12008-09-24 04:04:31 +00001462 if (!EnumerationMutationFn) {
1463 CGM.ErrorUnsupported(&S, "Obj-C fast enumeration for this runtime");
1464 return;
1465 }
1466
Devang Pateld2d66652011-01-19 01:36:36 +00001467 CGDebugInfo *DI = getDebugInfo();
Eric Christopher7cdf9482011-10-13 21:45:18 +00001468 if (DI)
1469 DI->EmitLexicalBlockStart(Builder, S.getSourceRange().getBegin());
Devang Pateld2d66652011-01-19 01:36:36 +00001470
Devang Patel297207f2011-06-13 23:15:32 +00001471 // The local variable comes into scope immediately.
1472 AutoVarEmission variable = AutoVarEmission::invalid();
1473 if (const DeclStmt *SD = dyn_cast<DeclStmt>(S.getElement()))
1474 variable = EmitAutoVarAlloca(*cast<VarDecl>(SD->getSingleDecl()));
1475
John McCall1c926b72011-01-07 01:49:06 +00001476 JumpDest LoopEnd = getJumpDestInCurrentScope("forcoll.end");
Mike Stump11289f42009-09-09 15:08:12 +00001477
Anders Carlsson75658592008-08-31 02:33:12 +00001478 // Fast enumeration state.
Douglas Gregor636e2002011-08-09 17:23:49 +00001479 QualType StateTy = CGM.getObjCFastEnumerationStateType();
John McCall7f416cc2015-09-08 08:05:57 +00001480 Address StatePtr = CreateMemTemp(StateTy, "state.ptr");
Anders Carlssonc0964b62010-05-22 17:35:42 +00001481 EmitNullInitialization(StatePtr, StateTy);
Mike Stump11289f42009-09-09 15:08:12 +00001482
Anders Carlsson75658592008-08-31 02:33:12 +00001483 // Number of elements in the items array.
Anders Carlsson3f35a262008-08-31 04:05:03 +00001484 static const unsigned NumItems = 16;
Mike Stump11289f42009-09-09 15:08:12 +00001485
John McCall1c926b72011-01-07 01:49:06 +00001486 // Fetch the countByEnumeratingWithState:objects:count: selector.
Benjamin Kramer9e649c32010-03-30 11:36:44 +00001487 IdentifierInfo *II[] = {
1488 &CGM.getContext().Idents.get("countByEnumeratingWithState"),
1489 &CGM.getContext().Idents.get("objects"),
1490 &CGM.getContext().Idents.get("count")
1491 };
1492 Selector FastEnumSel =
1493 CGM.getContext().Selectors.getSelector(llvm::array_lengthof(II), &II[0]);
Anders Carlsson75658592008-08-31 02:33:12 +00001494
1495 QualType ItemsTy =
1496 getContext().getConstantArrayType(getContext().getObjCIdType(),
Mike Stump11289f42009-09-09 15:08:12 +00001497 llvm::APInt(32, NumItems),
Anders Carlsson75658592008-08-31 02:33:12 +00001498 ArrayType::Normal, 0);
John McCall7f416cc2015-09-08 08:05:57 +00001499 Address ItemsPtr = CreateMemTemp(ItemsTy, "items.ptr");
Mike Stump11289f42009-09-09 15:08:12 +00001500
John McCall53848232011-07-27 01:07:15 +00001501 // Emit the collection pointer. In ARC, we do a retain.
1502 llvm::Value *Collection;
David Blaikiebbafb8a2012-03-11 07:00:24 +00001503 if (getLangOpts().ObjCAutoRefCount) {
John McCall53848232011-07-27 01:07:15 +00001504 Collection = EmitARCRetainScalarExpr(S.getCollection());
1505
1506 // Enter a cleanup to do the release.
1507 EmitObjCConsumeObject(S.getCollection()->getType(), Collection);
1508 } else {
1509 Collection = EmitScalarExpr(S.getCollection());
1510 }
Mike Stump11289f42009-09-09 15:08:12 +00001511
John McCall91e82dd2011-08-05 00:14:38 +00001512 // The 'continue' label needs to appear within the cleanup for the
1513 // collection object.
1514 JumpDest AfterBody = getJumpDestInCurrentScope("forcoll.next");
1515
John McCall1c926b72011-01-07 01:49:06 +00001516 // Send it our message:
Anders Carlsson75658592008-08-31 02:33:12 +00001517 CallArgList Args;
John McCall1c926b72011-01-07 01:49:06 +00001518
1519 // The first argument is a temporary of the enumeration-state type.
John McCall7f416cc2015-09-08 08:05:57 +00001520 Args.add(RValue::get(StatePtr.getPointer()),
1521 getContext().getPointerType(StateTy));
Mike Stump11289f42009-09-09 15:08:12 +00001522
John McCall1c926b72011-01-07 01:49:06 +00001523 // The second argument is a temporary array with space for NumItems
1524 // pointers. We'll actually be loading elements from the array
1525 // pointer written into the control state; this buffer is so that
1526 // collections that *aren't* backed by arrays can still queue up
1527 // batches of elements.
John McCall7f416cc2015-09-08 08:05:57 +00001528 Args.add(RValue::get(ItemsPtr.getPointer()),
1529 getContext().getPointerType(ItemsTy));
Mike Stump11289f42009-09-09 15:08:12 +00001530
John McCall1c926b72011-01-07 01:49:06 +00001531 // The third argument is the capacity of that temporary array.
Chris Lattner2192fe52011-07-18 04:24:23 +00001532 llvm::Type *UnsignedLongLTy = ConvertType(getContext().UnsignedLongTy);
Owen Andersonb7a2fe62009-07-24 23:12:58 +00001533 llvm::Constant *Count = llvm::ConstantInt::get(UnsignedLongLTy, NumItems);
Eli Friedman43dca6a2011-05-02 17:57:46 +00001534 Args.add(RValue::get(Count), getContext().UnsignedLongTy);
Mike Stump11289f42009-09-09 15:08:12 +00001535
John McCall1c926b72011-01-07 01:49:06 +00001536 // Start the enumeration.
Mike Stump11289f42009-09-09 15:08:12 +00001537 RValue CountRV =
John McCall78a15112010-05-22 01:48:05 +00001538 CGM.getObjCRuntime().GenerateMessageSend(*this, ReturnValueSlot(),
Anders Carlsson75658592008-08-31 02:33:12 +00001539 getContext().UnsignedLongTy,
1540 FastEnumSel,
David Chisnall01aa4672010-04-28 19:33:36 +00001541 Collection, Args);
Anders Carlsson75658592008-08-31 02:33:12 +00001542
John McCall1c926b72011-01-07 01:49:06 +00001543 // The initial number of objects that were returned in the buffer.
1544 llvm::Value *initialBufferLimit = CountRV.getScalarVal();
Mike Stump11289f42009-09-09 15:08:12 +00001545
John McCall1c926b72011-01-07 01:49:06 +00001546 llvm::BasicBlock *EmptyBB = createBasicBlock("forcoll.empty");
1547 llvm::BasicBlock *LoopInitBB = createBasicBlock("forcoll.loopinit");
Mike Stump11289f42009-09-09 15:08:12 +00001548
John McCall1c926b72011-01-07 01:49:06 +00001549 llvm::Value *zero = llvm::Constant::getNullValue(UnsignedLongLTy);
Anders Carlsson75658592008-08-31 02:33:12 +00001550
John McCall1c926b72011-01-07 01:49:06 +00001551 // If the limit pointer was zero to begin with, the collection is
Bob Wilson0ed74d92014-03-25 23:26:31 +00001552 // empty; skip all this. Set the branch weight assuming this has the same
1553 // probability of exiting the loop as any other loop exit.
Justin Bogner66242d62015-04-23 23:06:47 +00001554 uint64_t EntryCount = getCurrentProfileCount();
1555 Builder.CreateCondBr(
1556 Builder.CreateICmpEQ(initialBufferLimit, zero, "iszero"), EmptyBB,
1557 LoopInitBB,
Justin Bogner65512642015-05-02 05:00:55 +00001558 createProfileWeights(EntryCount, getProfileCount(S.getBody())));
Anders Carlsson75658592008-08-31 02:33:12 +00001559
John McCall1c926b72011-01-07 01:49:06 +00001560 // Otherwise, initialize the loop.
1561 EmitBlock(LoopInitBB);
Mike Stump11289f42009-09-09 15:08:12 +00001562
John McCall1c926b72011-01-07 01:49:06 +00001563 // Save the initial mutations value. This is the value at an
1564 // address that was written into the state object by
1565 // countByEnumeratingWithState:objects:count:.
John McCall7f416cc2015-09-08 08:05:57 +00001566 Address StateMutationsPtrPtr = Builder.CreateStructGEP(
1567 StatePtr, 2, 2 * getPointerSize(), "mutationsptr.ptr");
1568 llvm::Value *StateMutationsPtr
1569 = Builder.CreateLoad(StateMutationsPtrPtr, "mutationsptr");
Mike Stump11289f42009-09-09 15:08:12 +00001570
John McCall1c926b72011-01-07 01:49:06 +00001571 llvm::Value *initialMutations =
John McCall7f416cc2015-09-08 08:05:57 +00001572 Builder.CreateAlignedLoad(StateMutationsPtr, getPointerAlign(),
1573 "forcoll.initial-mutations");
Mike Stump11289f42009-09-09 15:08:12 +00001574
John McCall1c926b72011-01-07 01:49:06 +00001575 // Start looping. This is the point we return to whenever we have a
1576 // fresh, non-empty batch of objects.
1577 llvm::BasicBlock *LoopBodyBB = createBasicBlock("forcoll.loopbody");
1578 EmitBlock(LoopBodyBB);
Mike Stump11289f42009-09-09 15:08:12 +00001579
John McCall1c926b72011-01-07 01:49:06 +00001580 // The current index into the buffer.
Jay Foad20c0f022011-03-30 11:28:58 +00001581 llvm::PHINode *index = Builder.CreatePHI(UnsignedLongLTy, 3, "forcoll.index");
John McCall1c926b72011-01-07 01:49:06 +00001582 index->addIncoming(zero, LoopInitBB);
Anders Carlsson75658592008-08-31 02:33:12 +00001583
John McCall1c926b72011-01-07 01:49:06 +00001584 // The current buffer size.
Jay Foad20c0f022011-03-30 11:28:58 +00001585 llvm::PHINode *count = Builder.CreatePHI(UnsignedLongLTy, 3, "forcoll.count");
John McCall1c926b72011-01-07 01:49:06 +00001586 count->addIncoming(initialBufferLimit, LoopInitBB);
Mike Stump11289f42009-09-09 15:08:12 +00001587
Justin Bogner66242d62015-04-23 23:06:47 +00001588 incrementProfileCounter(&S);
Bob Wilson8ab16912014-02-24 01:13:09 +00001589
John McCall1c926b72011-01-07 01:49:06 +00001590 // Check whether the mutations value has changed from where it was
1591 // at start. StateMutationsPtr should actually be invariant between
1592 // refreshes.
Anders Carlsson3f35a262008-08-31 04:05:03 +00001593 StateMutationsPtr = Builder.CreateLoad(StateMutationsPtrPtr, "mutationsptr");
John McCall1c926b72011-01-07 01:49:06 +00001594 llvm::Value *currentMutations
John McCall7f416cc2015-09-08 08:05:57 +00001595 = Builder.CreateAlignedLoad(StateMutationsPtr, getPointerAlign(),
1596 "statemutations");
Anders Carlsson3f35a262008-08-31 04:05:03 +00001597
John McCall1c926b72011-01-07 01:49:06 +00001598 llvm::BasicBlock *WasMutatedBB = createBasicBlock("forcoll.mutated");
Dan Gohman6ca99822011-03-02 22:39:34 +00001599 llvm::BasicBlock *WasNotMutatedBB = createBasicBlock("forcoll.notmutated");
Mike Stump11289f42009-09-09 15:08:12 +00001600
John McCall1c926b72011-01-07 01:49:06 +00001601 Builder.CreateCondBr(Builder.CreateICmpEQ(currentMutations, initialMutations),
1602 WasNotMutatedBB, WasMutatedBB);
Mike Stump11289f42009-09-09 15:08:12 +00001603
John McCall1c926b72011-01-07 01:49:06 +00001604 // If so, call the enumeration-mutation function.
1605 EmitBlock(WasMutatedBB);
Anders Carlsson3f35a262008-08-31 04:05:03 +00001606 llvm::Value *V =
Mike Stump11289f42009-09-09 15:08:12 +00001607 Builder.CreateBitCast(Collection,
Benjamin Kramer76399eb2011-09-27 21:06:10 +00001608 ConvertType(getContext().getObjCIdType()));
Daniel Dunbar84388bf2009-02-03 23:55:40 +00001609 CallArgList Args2;
Eli Friedman43dca6a2011-05-02 17:57:46 +00001610 Args2.add(RValue::get(V), getContext().getObjCIdType());
Mike Stump18bb9282009-05-16 07:57:57 +00001611 // FIXME: We shouldn't need to get the function info here, the runtime already
1612 // should have computed it to build the function.
John McCall8dda7b22012-07-07 06:41:13 +00001613 EmitCall(CGM.getTypes().arrangeFreeFunctionCall(getContext().VoidTy, Args2,
1614 FunctionType::ExtInfo(),
1615 RequiredArgs::All),
Anders Carlsson61a401c2009-12-24 19:25:24 +00001616 EnumerationMutationFn, ReturnValueSlot(), Args2);
Mike Stump11289f42009-09-09 15:08:12 +00001617
John McCall1c926b72011-01-07 01:49:06 +00001618 // Otherwise, or if the mutation function returns, just continue.
1619 EmitBlock(WasNotMutatedBB);
Mike Stump11289f42009-09-09 15:08:12 +00001620
John McCall1c926b72011-01-07 01:49:06 +00001621 // Initialize the element variable.
1622 RunCleanupsScope elementVariableScope(*this);
John McCall9e2e22f2011-02-22 07:16:58 +00001623 bool elementIsVariable;
John McCall1c926b72011-01-07 01:49:06 +00001624 LValue elementLValue;
1625 QualType elementType;
1626 if (const DeclStmt *SD = dyn_cast<DeclStmt>(S.getElement())) {
John McCall9e2e22f2011-02-22 07:16:58 +00001627 // Initialize the variable, in case it's a __block variable or something.
1628 EmitAutoVarInit(variable);
John McCall1c926b72011-01-07 01:49:06 +00001629
John McCall9e2e22f2011-02-22 07:16:58 +00001630 const VarDecl* D = cast<VarDecl>(SD->getSingleDecl());
John McCall113bee02012-03-10 09:33:50 +00001631 DeclRefExpr tempDRE(const_cast<VarDecl*>(D), false, D->getType(),
John McCall1c926b72011-01-07 01:49:06 +00001632 VK_LValue, SourceLocation());
1633 elementLValue = EmitLValue(&tempDRE);
1634 elementType = D->getType();
John McCall9e2e22f2011-02-22 07:16:58 +00001635 elementIsVariable = true;
John McCalld4631322011-06-17 06:42:21 +00001636
1637 if (D->isARCPseudoStrong())
1638 elementLValue.getQuals().setObjCLifetime(Qualifiers::OCL_ExplicitNone);
John McCall1c926b72011-01-07 01:49:06 +00001639 } else {
1640 elementLValue = LValue(); // suppress warning
1641 elementType = cast<Expr>(S.getElement())->getType();
John McCall9e2e22f2011-02-22 07:16:58 +00001642 elementIsVariable = false;
John McCall1c926b72011-01-07 01:49:06 +00001643 }
Chris Lattner2192fe52011-07-18 04:24:23 +00001644 llvm::Type *convertedElementType = ConvertType(elementType);
John McCall1c926b72011-01-07 01:49:06 +00001645
1646 // Fetch the buffer out of the enumeration state.
1647 // TODO: this pointer should actually be invariant between
1648 // refreshes, which would help us do certain loop optimizations.
John McCall7f416cc2015-09-08 08:05:57 +00001649 Address StateItemsPtr = Builder.CreateStructGEP(
1650 StatePtr, 1, getPointerSize(), "stateitems.ptr");
John McCall1c926b72011-01-07 01:49:06 +00001651 llvm::Value *EnumStateItems =
1652 Builder.CreateLoad(StateItemsPtr, "stateitems");
Anders Carlsson75658592008-08-31 02:33:12 +00001653
John McCall1c926b72011-01-07 01:49:06 +00001654 // Fetch the value at the current index from the buffer.
Mike Stump11289f42009-09-09 15:08:12 +00001655 llvm::Value *CurrentItemPtr =
John McCall1c926b72011-01-07 01:49:06 +00001656 Builder.CreateGEP(EnumStateItems, index, "currentitem.ptr");
John McCall7f416cc2015-09-08 08:05:57 +00001657 llvm::Value *CurrentItem =
1658 Builder.CreateAlignedLoad(CurrentItemPtr, getPointerAlign());
Mike Stump11289f42009-09-09 15:08:12 +00001659
John McCall1c926b72011-01-07 01:49:06 +00001660 // Cast that value to the right type.
1661 CurrentItem = Builder.CreateBitCast(CurrentItem, convertedElementType,
1662 "currentitem");
Mike Stump11289f42009-09-09 15:08:12 +00001663
John McCall1c926b72011-01-07 01:49:06 +00001664 // Make sure we have an l-value. Yes, this gets evaluated every
1665 // time through the loop.
John McCalld4631322011-06-17 06:42:21 +00001666 if (!elementIsVariable) {
John McCall1c926b72011-01-07 01:49:06 +00001667 elementLValue = EmitLValue(cast<Expr>(S.getElement()));
John McCall55e1fbc2011-06-25 02:11:03 +00001668 EmitStoreThroughLValue(RValue::get(CurrentItem), elementLValue);
John McCalld4631322011-06-17 06:42:21 +00001669 } else {
1670 EmitScalarInit(CurrentItem, elementLValue);
1671 }
Mike Stump11289f42009-09-09 15:08:12 +00001672
John McCall9e2e22f2011-02-22 07:16:58 +00001673 // If we do have an element variable, this assignment is the end of
1674 // its initialization.
1675 if (elementIsVariable)
1676 EmitAutoVarCleanups(variable);
1677
John McCall1c926b72011-01-07 01:49:06 +00001678 // Perform the loop body, setting up break and continue labels.
Bob Wilsonbf854f02014-02-17 19:21:09 +00001679 BreakContinueStack.push_back(BreakContinue(LoopEnd, AfterBody));
John McCall1c926b72011-01-07 01:49:06 +00001680 {
1681 RunCleanupsScope Scope(*this);
1682 EmitStmt(S.getBody());
1683 }
Anders Carlsson75658592008-08-31 02:33:12 +00001684 BreakContinueStack.pop_back();
Mike Stump11289f42009-09-09 15:08:12 +00001685
John McCall1c926b72011-01-07 01:49:06 +00001686 // Destroy the element variable now.
1687 elementVariableScope.ForceCleanup();
1688
1689 // Check whether there are more elements.
John McCallad5d61e2010-07-23 21:56:41 +00001690 EmitBlock(AfterBody.getBlock());
Mike Stump11289f42009-09-09 15:08:12 +00001691
John McCall1c926b72011-01-07 01:49:06 +00001692 llvm::BasicBlock *FetchMoreBB = createBasicBlock("forcoll.refetch");
Fariborz Jahanian6e7ecc82009-01-06 18:56:31 +00001693
John McCall1c926b72011-01-07 01:49:06 +00001694 // First we check in the local buffer.
1695 llvm::Value *indexPlusOne
1696 = Builder.CreateAdd(index, llvm::ConstantInt::get(UnsignedLongLTy, 1));
Anders Carlsson75658592008-08-31 02:33:12 +00001697
John McCall1c926b72011-01-07 01:49:06 +00001698 // If we haven't overrun the buffer yet, we can continue.
Bob Wilson0ed74d92014-03-25 23:26:31 +00001699 // Set the branch weights based on the simplifying assumption that this is
1700 // like a while-loop, i.e., ignoring that the false branch fetches more
1701 // elements and then returns to the loop.
Justin Bogner66242d62015-04-23 23:06:47 +00001702 Builder.CreateCondBr(
1703 Builder.CreateICmpULT(indexPlusOne, count), LoopBodyBB, FetchMoreBB,
Justin Bogner65512642015-05-02 05:00:55 +00001704 createProfileWeights(getProfileCount(S.getBody()), EntryCount));
John McCall1c926b72011-01-07 01:49:06 +00001705
1706 index->addIncoming(indexPlusOne, AfterBody.getBlock());
1707 count->addIncoming(count, AfterBody.getBlock());
1708
1709 // Otherwise, we have to fetch more elements.
1710 EmitBlock(FetchMoreBB);
Mike Stump11289f42009-09-09 15:08:12 +00001711
1712 CountRV =
John McCall78a15112010-05-22 01:48:05 +00001713 CGM.getObjCRuntime().GenerateMessageSend(*this, ReturnValueSlot(),
Anders Carlsson75658592008-08-31 02:33:12 +00001714 getContext().UnsignedLongTy,
Mike Stump11289f42009-09-09 15:08:12 +00001715 FastEnumSel,
David Chisnall01aa4672010-04-28 19:33:36 +00001716 Collection, Args);
Mike Stump11289f42009-09-09 15:08:12 +00001717
John McCall1c926b72011-01-07 01:49:06 +00001718 // If we got a zero count, we're done.
1719 llvm::Value *refetchCount = CountRV.getScalarVal();
1720
1721 // (note that the message send might split FetchMoreBB)
1722 index->addIncoming(zero, Builder.GetInsertBlock());
1723 count->addIncoming(refetchCount, Builder.GetInsertBlock());
1724
1725 Builder.CreateCondBr(Builder.CreateICmpEQ(refetchCount, zero),
1726 EmptyBB, LoopBodyBB);
Mike Stump11289f42009-09-09 15:08:12 +00001727
Anders Carlsson75658592008-08-31 02:33:12 +00001728 // No more elements.
John McCall1c926b72011-01-07 01:49:06 +00001729 EmitBlock(EmptyBB);
Anders Carlsson75658592008-08-31 02:33:12 +00001730
John McCall9e2e22f2011-02-22 07:16:58 +00001731 if (!elementIsVariable) {
Anders Carlsson75658592008-08-31 02:33:12 +00001732 // If the element was not a declaration, set it to be null.
1733
John McCall1c926b72011-01-07 01:49:06 +00001734 llvm::Value *null = llvm::Constant::getNullValue(convertedElementType);
1735 elementLValue = EmitLValue(cast<Expr>(S.getElement()));
John McCall55e1fbc2011-06-25 02:11:03 +00001736 EmitStoreThroughLValue(RValue::get(null), elementLValue);
Anders Carlsson75658592008-08-31 02:33:12 +00001737 }
1738
Eric Christopher7cdf9482011-10-13 21:45:18 +00001739 if (DI)
1740 DI->EmitLexicalBlockEnd(Builder, S.getSourceRange().getEnd());
Devang Pateld2d66652011-01-19 01:36:36 +00001741
John McCall53848232011-07-27 01:07:15 +00001742 // Leave the cleanup we entered in ARC.
David Blaikiebbafb8a2012-03-11 07:00:24 +00001743 if (getLangOpts().ObjCAutoRefCount)
John McCall53848232011-07-27 01:07:15 +00001744 PopCleanupBlock();
1745
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
1805static llvm::Constant *createARCRuntimeFunction(CodeGenModule &CGM,
Chris Lattner2192fe52011-07-18 04:24:23 +00001806 llvm::FunctionType *type,
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001807 StringRef fnName) {
John McCall31168b02011-06-15 23:02:42 +00001808 llvm::Constant *fn = CGM.CreateRuntimeFunction(type, fnName);
1809
Michael Gottesmancf50e6d2013-02-02 00:57:44 +00001810 if (llvm::Function *f = dyn_cast<llvm::Function>(fn)) {
Michael Gottesmanbe9614c2013-02-02 01:05:06 +00001811 // If the target runtime doesn't naturally support ARC, emit weak
1812 // references to the runtime support library. We don't really
1813 // permit this to fail, but we need a particular relocation style.
Michael Gottesmancf50e6d2013-02-02 00:57:44 +00001814 if (!CGM.getLangOpts().ObjCRuntime.hasNativeARC()) {
John McCall31168b02011-06-15 23:02:42 +00001815 f->setLinkage(llvm::Function::ExternalWeakLinkage);
Michael Gottesmancf50e6d2013-02-02 00:57:44 +00001816 } else if (fnName == "objc_retain" || fnName == "objc_release") {
1817 // If we have Native ARC, set nonlazybind attribute for these APIs for
1818 // performance.
Bill Wendling207f0532012-12-20 19:27:06 +00001819 f->addFnAttr(llvm::Attribute::NonLazyBind);
Michael Gottesmanb46072d2013-02-02 01:03:01 +00001820 }
Michael Gottesmancf50e6d2013-02-02 00:57:44 +00001821 }
John McCall31168b02011-06-15 23:02:42 +00001822
1823 return fn;
1824}
1825
1826/// Perform an operation having the signature
1827/// i8* (i8*)
1828/// where a null input causes a no-op and returns null.
1829static llvm::Value *emitARCValueOperation(CodeGenFunction &CGF,
1830 llvm::Value *value,
1831 llvm::Constant *&fn,
Chad Rosier13799b32012-12-12 17:52:21 +00001832 StringRef fnName,
1833 bool isTailCall = false) {
John McCall31168b02011-06-15 23:02:42 +00001834 if (isa<llvm::ConstantPointerNull>(value)) return value;
1835
1836 if (!fn) {
Chris Lattner2192fe52011-07-18 04:24:23 +00001837 llvm::FunctionType *fnType =
Benjamin Kramer95e19362013-03-07 21:18:31 +00001838 llvm::FunctionType::get(CGF.Int8PtrTy, CGF.Int8PtrTy, false);
John McCall31168b02011-06-15 23:02:42 +00001839 fn = createARCRuntimeFunction(CGF.CGM, fnType, fnName);
1840 }
1841
1842 // Cast the argument to 'id'.
Chris Lattner2192fe52011-07-18 04:24:23 +00001843 llvm::Type *origType = value->getType();
John McCall31168b02011-06-15 23:02:42 +00001844 value = CGF.Builder.CreateBitCast(value, CGF.Int8PtrTy);
1845
1846 // Call the function.
John McCall882987f2013-02-28 19:01:20 +00001847 llvm::CallInst *call = CGF.EmitNounwindRuntimeCall(fn, value);
Chad Rosier13799b32012-12-12 17:52:21 +00001848 if (isTailCall)
1849 call->setTailCall();
John McCall31168b02011-06-15 23:02:42 +00001850
1851 // Cast the result back to the original type.
1852 return CGF.Builder.CreateBitCast(call, origType);
1853}
1854
1855/// Perform an operation having the following signature:
1856/// i8* (i8**)
1857static llvm::Value *emitARCLoadOperation(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001858 Address addr,
John McCall31168b02011-06-15 23:02:42 +00001859 llvm::Constant *&fn,
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001860 StringRef fnName) {
John McCall31168b02011-06-15 23:02:42 +00001861 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.Int8PtrPtrTy, false);
John McCall31168b02011-06-15 23:02:42 +00001864 fn = createARCRuntimeFunction(CGF.CGM, fnType, fnName);
1865 }
1866
1867 // Cast the argument to 'id*'.
John McCall7f416cc2015-09-08 08:05:57 +00001868 llvm::Type *origType = addr.getElementType();
John McCall31168b02011-06-15 23:02:42 +00001869 addr = CGF.Builder.CreateBitCast(addr, CGF.Int8PtrPtrTy);
1870
1871 // Call the function.
John McCall7f416cc2015-09-08 08:05:57 +00001872 llvm::Value *result = CGF.EmitNounwindRuntimeCall(fn, addr.getPointer());
John McCall31168b02011-06-15 23:02:42 +00001873
1874 // Cast the result back to a dereference of the original type.
John McCall7f416cc2015-09-08 08:05:57 +00001875 if (origType != CGF.Int8PtrTy)
1876 result = CGF.Builder.CreateBitCast(result, origType);
John McCall31168b02011-06-15 23:02:42 +00001877
1878 return result;
1879}
1880
1881/// Perform an operation having the following signature:
1882/// i8* (i8**, i8*)
1883static llvm::Value *emitARCStoreOperation(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001884 Address addr,
John McCall31168b02011-06-15 23:02:42 +00001885 llvm::Value *value,
1886 llvm::Constant *&fn,
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001887 StringRef fnName,
John McCall31168b02011-06-15 23:02:42 +00001888 bool ignored) {
John McCall7f416cc2015-09-08 08:05:57 +00001889 assert(addr.getElementType() == value->getType());
John McCall31168b02011-06-15 23:02:42 +00001890
1891 if (!fn) {
Benjamin Kramer22d24c22011-10-15 12:20:02 +00001892 llvm::Type *argTypes[] = { CGF.Int8PtrPtrTy, CGF.Int8PtrTy };
John McCall31168b02011-06-15 23:02:42 +00001893
Chris Lattner2192fe52011-07-18 04:24:23 +00001894 llvm::FunctionType *fnType
John McCall31168b02011-06-15 23:02:42 +00001895 = llvm::FunctionType::get(CGF.Int8PtrTy, argTypes, false);
1896 fn = createARCRuntimeFunction(CGF.CGM, fnType, fnName);
1897 }
1898
Chris Lattner2192fe52011-07-18 04:24:23 +00001899 llvm::Type *origType = value->getType();
John McCall31168b02011-06-15 23:02:42 +00001900
John McCall882987f2013-02-28 19:01:20 +00001901 llvm::Value *args[] = {
John McCall7f416cc2015-09-08 08:05:57 +00001902 CGF.Builder.CreateBitCast(addr.getPointer(), CGF.Int8PtrPtrTy),
John McCall882987f2013-02-28 19:01:20 +00001903 CGF.Builder.CreateBitCast(value, CGF.Int8PtrTy)
1904 };
1905 llvm::CallInst *result = CGF.EmitNounwindRuntimeCall(fn, args);
John McCall31168b02011-06-15 23:02:42 +00001906
Craig Topper8a13c412014-05-21 05:09:00 +00001907 if (ignored) return nullptr;
John McCall31168b02011-06-15 23:02:42 +00001908
1909 return CGF.Builder.CreateBitCast(result, origType);
1910}
1911
1912/// Perform an operation having the following signature:
1913/// void (i8**, i8**)
1914static void emitARCCopyOperation(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001915 Address dst,
1916 Address src,
John McCall31168b02011-06-15 23:02:42 +00001917 llvm::Constant *&fn,
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001918 StringRef fnName) {
John McCall7f416cc2015-09-08 08:05:57 +00001919 assert(dst.getType() == src.getType());
John McCall31168b02011-06-15 23:02:42 +00001920
1921 if (!fn) {
Benjamin Kramer95e19362013-03-07 21:18:31 +00001922 llvm::Type *argTypes[] = { CGF.Int8PtrPtrTy, CGF.Int8PtrPtrTy };
1923
Chris Lattner2192fe52011-07-18 04:24:23 +00001924 llvm::FunctionType *fnType
John McCall31168b02011-06-15 23:02:42 +00001925 = llvm::FunctionType::get(CGF.Builder.getVoidTy(), argTypes, false);
1926 fn = createARCRuntimeFunction(CGF.CGM, fnType, fnName);
1927 }
1928
John McCall882987f2013-02-28 19:01:20 +00001929 llvm::Value *args[] = {
John McCall7f416cc2015-09-08 08:05:57 +00001930 CGF.Builder.CreateBitCast(dst.getPointer(), CGF.Int8PtrPtrTy),
1931 CGF.Builder.CreateBitCast(src.getPointer(), CGF.Int8PtrPtrTy)
John McCall882987f2013-02-28 19:01:20 +00001932 };
1933 CGF.EmitNounwindRuntimeCall(fn, args);
John McCall31168b02011-06-15 23:02:42 +00001934}
1935
1936/// Produce the code to do a retain. Based on the type, calls one of:
James Dennett14c41ea2012-06-22 05:41:30 +00001937/// call i8* \@objc_retain(i8* %value)
1938/// call i8* \@objc_retainBlock(i8* %value)
John McCall31168b02011-06-15 23:02:42 +00001939llvm::Value *CodeGenFunction::EmitARCRetain(QualType type, llvm::Value *value) {
1940 if (type->isBlockPointerType())
John McCallff613032011-10-04 06:23:45 +00001941 return EmitARCRetainBlock(value, /*mandatory*/ false);
John McCall31168b02011-06-15 23:02:42 +00001942 else
1943 return EmitARCRetainNonBlock(value);
1944}
1945
1946/// Retain the given object, with normal retain semantics.
James Dennett14c41ea2012-06-22 05:41:30 +00001947/// call i8* \@objc_retain(i8* %value)
John McCall31168b02011-06-15 23:02:42 +00001948llvm::Value *CodeGenFunction::EmitARCRetainNonBlock(llvm::Value *value) {
1949 return emitARCValueOperation(*this, value,
John McCallb04ecb72015-10-21 18:06:43 +00001950 CGM.getObjCEntrypoints().objc_retain,
John McCall31168b02011-06-15 23:02:42 +00001951 "objc_retain");
1952}
1953
1954/// Retain the given block, with _Block_copy semantics.
James Dennett14c41ea2012-06-22 05:41:30 +00001955/// call i8* \@objc_retainBlock(i8* %value)
John McCallff613032011-10-04 06:23:45 +00001956///
1957/// \param mandatory - If false, emit the call with metadata
1958/// indicating that it's okay for the optimizer to eliminate this call
1959/// if it can prove that the block never escapes except down the stack.
1960llvm::Value *CodeGenFunction::EmitARCRetainBlock(llvm::Value *value,
1961 bool mandatory) {
1962 llvm::Value *result
1963 = emitARCValueOperation(*this, value,
John McCallb04ecb72015-10-21 18:06:43 +00001964 CGM.getObjCEntrypoints().objc_retainBlock,
John McCallff613032011-10-04 06:23:45 +00001965 "objc_retainBlock");
1966
1967 // If the copy isn't mandatory, add !clang.arc.copy_on_escape to
1968 // tell the optimizer that it doesn't need to do this copy if the
1969 // block doesn't escape, where being passed as an argument doesn't
1970 // count as escaping.
1971 if (!mandatory && isa<llvm::Instruction>(result)) {
1972 llvm::CallInst *call
1973 = cast<llvm::CallInst>(result->stripPointerCasts());
John McCallb04ecb72015-10-21 18:06:43 +00001974 assert(call->getCalledValue() == CGM.getObjCEntrypoints().objc_retainBlock);
John McCallff613032011-10-04 06:23:45 +00001975
John McCallff613032011-10-04 06:23:45 +00001976 call->setMetadata("clang.arc.copy_on_escape",
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001977 llvm::MDNode::get(Builder.getContext(), None));
John McCallff613032011-10-04 06:23:45 +00001978 }
1979
1980 return result;
John McCall31168b02011-06-15 23:02:42 +00001981}
1982
1983/// Retain the given object which is the result of a function call.
James Dennett14c41ea2012-06-22 05:41:30 +00001984/// call i8* \@objc_retainAutoreleasedReturnValue(i8* %value)
John McCall31168b02011-06-15 23:02:42 +00001985///
1986/// Yes, this function name is one character away from a different
1987/// call with completely different semantics.
1988llvm::Value *
1989CodeGenFunction::EmitARCRetainAutoreleasedReturnValue(llvm::Value *value) {
1990 // Fetch the void(void) inline asm which marks that we're going to
1991 // retain the autoreleased return value.
1992 llvm::InlineAsm *&marker
John McCallb04ecb72015-10-21 18:06:43 +00001993 = CGM.getObjCEntrypoints().retainAutoreleasedReturnValueMarker;
John McCall31168b02011-06-15 23:02:42 +00001994 if (!marker) {
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001995 StringRef assembly
John McCall31168b02011-06-15 23:02:42 +00001996 = CGM.getTargetCodeGenInfo()
1997 .getARCRetainAutoreleasedReturnValueMarker();
1998
1999 // If we have an empty assembly string, there's nothing to do.
2000 if (assembly.empty()) {
2001
2002 // Otherwise, at -O0, build an inline asm that we're going to call
2003 // in a moment.
2004 } else if (CGM.getCodeGenOpts().OptimizationLevel == 0) {
2005 llvm::FunctionType *type =
Chris Lattnerece04092012-02-07 00:39:47 +00002006 llvm::FunctionType::get(VoidTy, /*variadic*/false);
John McCall31168b02011-06-15 23:02:42 +00002007
2008 marker = llvm::InlineAsm::get(type, assembly, "", /*sideeffects*/ true);
2009
2010 // If we're at -O1 and above, we don't want to litter the code
2011 // with this marker yet, so leave a breadcrumb for the ARC
2012 // optimizer to pick up.
2013 } else {
2014 llvm::NamedMDNode *metadata =
2015 CGM.getModule().getOrInsertNamedMetadata(
2016 "clang.arc.retainAutoreleasedReturnValueMarker");
2017 assert(metadata->getNumOperands() <= 1);
2018 if (metadata->getNumOperands() == 0) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002019 metadata->addOperand(llvm::MDNode::get(
2020 getLLVMContext(), llvm::MDString::get(getLLVMContext(), assembly)));
John McCall31168b02011-06-15 23:02:42 +00002021 }
2022 }
2023 }
2024
2025 // Call the marker asm if we made one, which we do only at -O0.
David Blaikie43f9bb72015-05-18 22:14:03 +00002026 if (marker)
David Blaikie4ba525b2015-07-14 17:27:39 +00002027 Builder.CreateCall(marker);
John McCall31168b02011-06-15 23:02:42 +00002028
2029 return emitARCValueOperation(*this, value,
John McCallb04ecb72015-10-21 18:06:43 +00002030 CGM.getObjCEntrypoints().objc_retainAutoreleasedReturnValue,
John McCall31168b02011-06-15 23:02:42 +00002031 "objc_retainAutoreleasedReturnValue");
2032}
2033
2034/// Release the given object.
James Dennett14c41ea2012-06-22 05:41:30 +00002035/// call void \@objc_release(i8* %value)
John McCallcdda29c2013-03-13 03:10:54 +00002036void CodeGenFunction::EmitARCRelease(llvm::Value *value,
2037 ARCPreciseLifetime_t precise) {
John McCall31168b02011-06-15 23:02:42 +00002038 if (isa<llvm::ConstantPointerNull>(value)) return;
2039
John McCallb04ecb72015-10-21 18:06:43 +00002040 llvm::Constant *&fn = CGM.getObjCEntrypoints().objc_release;
John McCall31168b02011-06-15 23:02:42 +00002041 if (!fn) {
Chris Lattner2192fe52011-07-18 04:24:23 +00002042 llvm::FunctionType *fnType =
Benjamin Kramer95e19362013-03-07 21:18:31 +00002043 llvm::FunctionType::get(Builder.getVoidTy(), Int8PtrTy, false);
John McCall31168b02011-06-15 23:02:42 +00002044 fn = createARCRuntimeFunction(CGM, fnType, "objc_release");
2045 }
2046
2047 // Cast the argument to 'id'.
2048 value = Builder.CreateBitCast(value, Int8PtrTy);
2049
2050 // Call objc_release.
John McCall882987f2013-02-28 19:01:20 +00002051 llvm::CallInst *call = EmitNounwindRuntimeCall(fn, value);
John McCall31168b02011-06-15 23:02:42 +00002052
John McCallcdda29c2013-03-13 03:10:54 +00002053 if (precise == ARCImpreciseLifetime) {
John McCall31168b02011-06-15 23:02:42 +00002054 call->setMetadata("clang.imprecise_release",
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002055 llvm::MDNode::get(Builder.getContext(), None));
John McCall31168b02011-06-15 23:02:42 +00002056 }
2057}
2058
John McCalle68b8f42012-10-17 02:28:37 +00002059/// Destroy a __strong variable.
2060///
2061/// At -O0, emit a call to store 'null' into the address;
2062/// instrumenting tools prefer this because the address is exposed,
2063/// but it's relatively cumbersome to optimize.
2064///
2065/// At -O1 and above, just load and call objc_release.
2066///
2067/// call void \@objc_storeStrong(i8** %addr, i8* null)
John McCall7f416cc2015-09-08 08:05:57 +00002068void CodeGenFunction::EmitARCDestroyStrong(Address addr,
John McCallcdda29c2013-03-13 03:10:54 +00002069 ARCPreciseLifetime_t precise) {
John McCalle68b8f42012-10-17 02:28:37 +00002070 if (CGM.getCodeGenOpts().OptimizationLevel == 0) {
John McCall7f416cc2015-09-08 08:05:57 +00002071 llvm::Value *null = getNullForVariable(addr);
John McCalle68b8f42012-10-17 02:28:37 +00002072 EmitARCStoreStrongCall(addr, null, /*ignored*/ true);
2073 return;
2074 }
2075
2076 llvm::Value *value = Builder.CreateLoad(addr);
2077 EmitARCRelease(value, precise);
2078}
2079
John McCall31168b02011-06-15 23:02:42 +00002080/// Store into a strong object. Always calls this:
James Dennett14c41ea2012-06-22 05:41:30 +00002081/// call void \@objc_storeStrong(i8** %addr, i8* %value)
John McCall7f416cc2015-09-08 08:05:57 +00002082llvm::Value *CodeGenFunction::EmitARCStoreStrongCall(Address addr,
John McCall31168b02011-06-15 23:02:42 +00002083 llvm::Value *value,
2084 bool ignored) {
John McCall7f416cc2015-09-08 08:05:57 +00002085 assert(addr.getElementType() == value->getType());
John McCall31168b02011-06-15 23:02:42 +00002086
John McCallb04ecb72015-10-21 18:06:43 +00002087 llvm::Constant *&fn = CGM.getObjCEntrypoints().objc_storeStrong;
John McCall31168b02011-06-15 23:02:42 +00002088 if (!fn) {
Chris Lattnera5f58b02011-07-09 17:41:47 +00002089 llvm::Type *argTypes[] = { Int8PtrPtrTy, Int8PtrTy };
Chris Lattner2192fe52011-07-18 04:24:23 +00002090 llvm::FunctionType *fnType
John McCall31168b02011-06-15 23:02:42 +00002091 = llvm::FunctionType::get(Builder.getVoidTy(), argTypes, false);
2092 fn = createARCRuntimeFunction(CGM, fnType, "objc_storeStrong");
2093 }
2094
John McCall882987f2013-02-28 19:01:20 +00002095 llvm::Value *args[] = {
John McCall7f416cc2015-09-08 08:05:57 +00002096 Builder.CreateBitCast(addr.getPointer(), Int8PtrPtrTy),
John McCall882987f2013-02-28 19:01:20 +00002097 Builder.CreateBitCast(value, Int8PtrTy)
2098 };
2099 EmitNounwindRuntimeCall(fn, args);
John McCall31168b02011-06-15 23:02:42 +00002100
Craig Topper8a13c412014-05-21 05:09:00 +00002101 if (ignored) return nullptr;
John McCall31168b02011-06-15 23:02:42 +00002102 return value;
2103}
2104
2105/// Store into a strong object. Sometimes calls this:
James Dennett14c41ea2012-06-22 05:41:30 +00002106/// call void \@objc_storeStrong(i8** %addr, i8* %value)
John McCall31168b02011-06-15 23:02:42 +00002107/// Other times, breaks it down into components.
John McCall55e1fbc2011-06-25 02:11:03 +00002108llvm::Value *CodeGenFunction::EmitARCStoreStrong(LValue dst,
John McCall31168b02011-06-15 23:02:42 +00002109 llvm::Value *newValue,
2110 bool ignored) {
John McCall55e1fbc2011-06-25 02:11:03 +00002111 QualType type = dst.getType();
John McCall31168b02011-06-15 23:02:42 +00002112 bool isBlock = type->isBlockPointerType();
2113
2114 // Use a store barrier at -O0 unless this is a block type or the
2115 // lvalue is inadequately aligned.
2116 if (shouldUseFusedARCCalls() &&
2117 !isBlock &&
Eli Friedmana0544d62011-12-03 04:14:32 +00002118 (dst.getAlignment().isZero() ||
2119 dst.getAlignment() >= CharUnits::fromQuantity(PointerAlignInBytes))) {
John McCall31168b02011-06-15 23:02:42 +00002120 return EmitARCStoreStrongCall(dst.getAddress(), newValue, ignored);
2121 }
2122
2123 // Otherwise, split it out.
2124
2125 // Retain the new value.
2126 newValue = EmitARCRetain(type, newValue);
2127
2128 // Read the old value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002129 llvm::Value *oldValue = EmitLoadOfScalar(dst, SourceLocation());
John McCall31168b02011-06-15 23:02:42 +00002130
2131 // Store. We do this before the release so that any deallocs won't
2132 // see the old value.
John McCall55e1fbc2011-06-25 02:11:03 +00002133 EmitStoreOfScalar(newValue, dst);
John McCall31168b02011-06-15 23:02:42 +00002134
2135 // Finally, release the old value.
John McCallcdda29c2013-03-13 03:10:54 +00002136 EmitARCRelease(oldValue, dst.isARCPreciseLifetime());
John McCall31168b02011-06-15 23:02:42 +00002137
2138 return newValue;
2139}
2140
2141/// Autorelease the given object.
James Dennett14c41ea2012-06-22 05:41:30 +00002142/// call i8* \@objc_autorelease(i8* %value)
John McCall31168b02011-06-15 23:02:42 +00002143llvm::Value *CodeGenFunction::EmitARCAutorelease(llvm::Value *value) {
2144 return emitARCValueOperation(*this, value,
John McCallb04ecb72015-10-21 18:06:43 +00002145 CGM.getObjCEntrypoints().objc_autorelease,
John McCall31168b02011-06-15 23:02:42 +00002146 "objc_autorelease");
2147}
2148
2149/// Autorelease the given object.
James Dennett14c41ea2012-06-22 05:41:30 +00002150/// call i8* \@objc_autoreleaseReturnValue(i8* %value)
John McCall31168b02011-06-15 23:02:42 +00002151llvm::Value *
2152CodeGenFunction::EmitARCAutoreleaseReturnValue(llvm::Value *value) {
2153 return emitARCValueOperation(*this, value,
John McCallb04ecb72015-10-21 18:06:43 +00002154 CGM.getObjCEntrypoints().objc_autoreleaseReturnValue,
Chad Rosier13799b32012-12-12 17:52:21 +00002155 "objc_autoreleaseReturnValue",
2156 /*isTailCall*/ true);
John McCall31168b02011-06-15 23:02:42 +00002157}
2158
2159/// Do a fused retain/autorelease of the given object.
James Dennett14c41ea2012-06-22 05:41:30 +00002160/// call i8* \@objc_retainAutoreleaseReturnValue(i8* %value)
John McCall31168b02011-06-15 23:02:42 +00002161llvm::Value *
2162CodeGenFunction::EmitARCRetainAutoreleaseReturnValue(llvm::Value *value) {
2163 return emitARCValueOperation(*this, value,
John McCallb04ecb72015-10-21 18:06:43 +00002164 CGM.getObjCEntrypoints().objc_retainAutoreleaseReturnValue,
Chad Rosier13799b32012-12-12 17:52:21 +00002165 "objc_retainAutoreleaseReturnValue",
2166 /*isTailCall*/ true);
John McCall31168b02011-06-15 23:02:42 +00002167}
2168
2169/// Do a fused retain/autorelease of the given object.
James Dennett14c41ea2012-06-22 05:41:30 +00002170/// call i8* \@objc_retainAutorelease(i8* %value)
John McCall31168b02011-06-15 23:02:42 +00002171/// or
James Dennett14c41ea2012-06-22 05:41:30 +00002172/// %retain = call i8* \@objc_retainBlock(i8* %value)
2173/// call i8* \@objc_autorelease(i8* %retain)
John McCall31168b02011-06-15 23:02:42 +00002174llvm::Value *CodeGenFunction::EmitARCRetainAutorelease(QualType type,
2175 llvm::Value *value) {
2176 if (!type->isBlockPointerType())
2177 return EmitARCRetainAutoreleaseNonBlock(value);
2178
2179 if (isa<llvm::ConstantPointerNull>(value)) return value;
2180
Chris Lattner2192fe52011-07-18 04:24:23 +00002181 llvm::Type *origType = value->getType();
John McCall31168b02011-06-15 23:02:42 +00002182 value = Builder.CreateBitCast(value, Int8PtrTy);
John McCallff613032011-10-04 06:23:45 +00002183 value = EmitARCRetainBlock(value, /*mandatory*/ true);
John McCall31168b02011-06-15 23:02:42 +00002184 value = EmitARCAutorelease(value);
2185 return Builder.CreateBitCast(value, origType);
2186}
2187
2188/// Do a fused retain/autorelease of the given object.
James Dennett14c41ea2012-06-22 05:41:30 +00002189/// call i8* \@objc_retainAutorelease(i8* %value)
John McCall31168b02011-06-15 23:02:42 +00002190llvm::Value *
2191CodeGenFunction::EmitARCRetainAutoreleaseNonBlock(llvm::Value *value) {
2192 return emitARCValueOperation(*this, value,
John McCallb04ecb72015-10-21 18:06:43 +00002193 CGM.getObjCEntrypoints().objc_retainAutorelease,
John McCall31168b02011-06-15 23:02:42 +00002194 "objc_retainAutorelease");
2195}
2196
John McCallb04ecb72015-10-21 18:06:43 +00002197/// i8* \@objc_loadWeak(i8** %addr)
2198/// Essentially objc_autorelease(objc_loadWeakRetained(addr)).
2199llvm::Value *CodeGenFunction::EmitARCLoadWeak(Address addr) {
2200 return emitARCLoadOperation(*this, addr,
2201 CGM.getObjCEntrypoints().objc_loadWeak,
2202 "objc_loadWeak");
2203}
2204
James Dennett14c41ea2012-06-22 05:41:30 +00002205/// i8* \@objc_loadWeakRetained(i8** %addr)
John McCall7f416cc2015-09-08 08:05:57 +00002206llvm::Value *CodeGenFunction::EmitARCLoadWeakRetained(Address addr) {
John McCall31168b02011-06-15 23:02:42 +00002207 return emitARCLoadOperation(*this, addr,
John McCallb04ecb72015-10-21 18:06:43 +00002208 CGM.getObjCEntrypoints().objc_loadWeakRetained,
John McCall31168b02011-06-15 23:02:42 +00002209 "objc_loadWeakRetained");
2210}
2211
James Dennett14c41ea2012-06-22 05:41:30 +00002212/// i8* \@objc_storeWeak(i8** %addr, i8* %value)
John McCall31168b02011-06-15 23:02:42 +00002213/// Returns %value.
John McCall7f416cc2015-09-08 08:05:57 +00002214llvm::Value *CodeGenFunction::EmitARCStoreWeak(Address addr,
John McCall31168b02011-06-15 23:02:42 +00002215 llvm::Value *value,
2216 bool ignored) {
2217 return emitARCStoreOperation(*this, addr, value,
John McCallb04ecb72015-10-21 18:06:43 +00002218 CGM.getObjCEntrypoints().objc_storeWeak,
John McCall31168b02011-06-15 23:02:42 +00002219 "objc_storeWeak", ignored);
2220}
2221
James Dennett14c41ea2012-06-22 05:41:30 +00002222/// i8* \@objc_initWeak(i8** %addr, i8* %value)
John McCall31168b02011-06-15 23:02:42 +00002223/// Returns %value. %addr is known to not have a current weak entry.
2224/// Essentially equivalent to:
2225/// *addr = nil; objc_storeWeak(addr, value);
John McCall7f416cc2015-09-08 08:05:57 +00002226void CodeGenFunction::EmitARCInitWeak(Address addr, llvm::Value *value) {
John McCall31168b02011-06-15 23:02:42 +00002227 // If we're initializing to null, just write null to memory; no need
2228 // to get the runtime involved. But don't do this if optimization
2229 // is enabled, because accounting for this would make the optimizer
2230 // much more complicated.
2231 if (isa<llvm::ConstantPointerNull>(value) &&
2232 CGM.getCodeGenOpts().OptimizationLevel == 0) {
2233 Builder.CreateStore(value, addr);
2234 return;
2235 }
2236
2237 emitARCStoreOperation(*this, addr, value,
John McCallb04ecb72015-10-21 18:06:43 +00002238 CGM.getObjCEntrypoints().objc_initWeak,
John McCall31168b02011-06-15 23:02:42 +00002239 "objc_initWeak", /*ignored*/ true);
2240}
2241
James Dennett14c41ea2012-06-22 05:41:30 +00002242/// void \@objc_destroyWeak(i8** %addr)
John McCall31168b02011-06-15 23:02:42 +00002243/// Essentially objc_storeWeak(addr, nil).
John McCall7f416cc2015-09-08 08:05:57 +00002244void CodeGenFunction::EmitARCDestroyWeak(Address addr) {
John McCallb04ecb72015-10-21 18:06:43 +00002245 llvm::Constant *&fn = CGM.getObjCEntrypoints().objc_destroyWeak;
John McCall31168b02011-06-15 23:02:42 +00002246 if (!fn) {
Chris Lattner2192fe52011-07-18 04:24:23 +00002247 llvm::FunctionType *fnType =
Benjamin Kramer95e19362013-03-07 21:18:31 +00002248 llvm::FunctionType::get(Builder.getVoidTy(), Int8PtrPtrTy, false);
John McCall31168b02011-06-15 23:02:42 +00002249 fn = createARCRuntimeFunction(CGM, fnType, "objc_destroyWeak");
2250 }
2251
2252 // Cast the argument to 'id*'.
2253 addr = Builder.CreateBitCast(addr, Int8PtrPtrTy);
2254
John McCall7f416cc2015-09-08 08:05:57 +00002255 EmitNounwindRuntimeCall(fn, addr.getPointer());
John McCall31168b02011-06-15 23:02:42 +00002256}
2257
James Dennett14c41ea2012-06-22 05:41:30 +00002258/// void \@objc_moveWeak(i8** %dest, i8** %src)
John McCall31168b02011-06-15 23:02:42 +00002259/// Disregards the current value in %dest. Leaves %src pointing to nothing.
2260/// Essentially (objc_copyWeak(dest, src), objc_destroyWeak(src)).
John McCall7f416cc2015-09-08 08:05:57 +00002261void CodeGenFunction::EmitARCMoveWeak(Address dst, Address src) {
John McCall31168b02011-06-15 23:02:42 +00002262 emitARCCopyOperation(*this, dst, src,
John McCallb04ecb72015-10-21 18:06:43 +00002263 CGM.getObjCEntrypoints().objc_moveWeak,
John McCall31168b02011-06-15 23:02:42 +00002264 "objc_moveWeak");
2265}
2266
James Dennett14c41ea2012-06-22 05:41:30 +00002267/// void \@objc_copyWeak(i8** %dest, i8** %src)
John McCall31168b02011-06-15 23:02:42 +00002268/// Disregards the current value in %dest. Essentially
2269/// objc_release(objc_initWeak(dest, objc_readWeakRetained(src)))
John McCall7f416cc2015-09-08 08:05:57 +00002270void CodeGenFunction::EmitARCCopyWeak(Address dst, Address src) {
John McCall31168b02011-06-15 23:02:42 +00002271 emitARCCopyOperation(*this, dst, src,
John McCallb04ecb72015-10-21 18:06:43 +00002272 CGM.getObjCEntrypoints().objc_copyWeak,
John McCall31168b02011-06-15 23:02:42 +00002273 "objc_copyWeak");
2274}
2275
2276/// Produce the code to do a objc_autoreleasepool_push.
James Dennett14c41ea2012-06-22 05:41:30 +00002277/// call i8* \@objc_autoreleasePoolPush(void)
John McCall31168b02011-06-15 23:02:42 +00002278llvm::Value *CodeGenFunction::EmitObjCAutoreleasePoolPush() {
John McCallb04ecb72015-10-21 18:06:43 +00002279 llvm::Constant *&fn = CGM.getObjCEntrypoints().objc_autoreleasePoolPush;
John McCall31168b02011-06-15 23:02:42 +00002280 if (!fn) {
Chris Lattner2192fe52011-07-18 04:24:23 +00002281 llvm::FunctionType *fnType =
John McCall31168b02011-06-15 23:02:42 +00002282 llvm::FunctionType::get(Int8PtrTy, false);
2283 fn = createARCRuntimeFunction(CGM, fnType, "objc_autoreleasePoolPush");
2284 }
2285
John McCall882987f2013-02-28 19:01:20 +00002286 return EmitNounwindRuntimeCall(fn);
John McCall31168b02011-06-15 23:02:42 +00002287}
2288
2289/// Produce the code to do a primitive release.
James Dennett14c41ea2012-06-22 05:41:30 +00002290/// call void \@objc_autoreleasePoolPop(i8* %ptr)
John McCall31168b02011-06-15 23:02:42 +00002291void CodeGenFunction::EmitObjCAutoreleasePoolPop(llvm::Value *value) {
2292 assert(value->getType() == Int8PtrTy);
2293
John McCallb04ecb72015-10-21 18:06:43 +00002294 llvm::Constant *&fn = CGM.getObjCEntrypoints().objc_autoreleasePoolPop;
John McCall31168b02011-06-15 23:02:42 +00002295 if (!fn) {
Chris Lattner2192fe52011-07-18 04:24:23 +00002296 llvm::FunctionType *fnType =
Benjamin Kramer95e19362013-03-07 21:18:31 +00002297 llvm::FunctionType::get(Builder.getVoidTy(), Int8PtrTy, false);
John McCall31168b02011-06-15 23:02:42 +00002298
2299 // We don't want to use a weak import here; instead we should not
2300 // fall into this path.
2301 fn = createARCRuntimeFunction(CGM, fnType, "objc_autoreleasePoolPop");
2302 }
2303
John McCallb7ff6db2013-04-16 21:29:40 +00002304 // objc_autoreleasePoolPop can throw.
2305 EmitRuntimeCallOrInvoke(fn, value);
John McCall31168b02011-06-15 23:02:42 +00002306}
2307
2308/// Produce the code to do an MRR version objc_autoreleasepool_push.
2309/// Which is: [[NSAutoreleasePool alloc] init];
2310/// Where alloc is declared as: + (id) alloc; in NSAutoreleasePool class.
2311/// init is declared as: - (id) init; in its NSObject super class.
2312///
2313llvm::Value *CodeGenFunction::EmitObjCMRRAutoreleasePoolPush() {
2314 CGObjCRuntime &Runtime = CGM.getObjCRuntime();
John McCall882987f2013-02-28 19:01:20 +00002315 llvm::Value *Receiver = Runtime.EmitNSAutoreleasePoolClassRef(*this);
John McCall31168b02011-06-15 23:02:42 +00002316 // [NSAutoreleasePool alloc]
2317 IdentifierInfo *II = &CGM.getContext().Idents.get("alloc");
2318 Selector AllocSel = getContext().Selectors.getSelector(0, &II);
2319 CallArgList Args;
2320 RValue AllocRV =
2321 Runtime.GenerateMessageSend(*this, ReturnValueSlot(),
2322 getContext().getObjCIdType(),
2323 AllocSel, Receiver, Args);
2324
2325 // [Receiver init]
2326 Receiver = AllocRV.getScalarVal();
2327 II = &CGM.getContext().Idents.get("init");
2328 Selector InitSel = getContext().Selectors.getSelector(0, &II);
2329 RValue InitRV =
2330 Runtime.GenerateMessageSend(*this, ReturnValueSlot(),
2331 getContext().getObjCIdType(),
2332 InitSel, Receiver, Args);
2333 return InitRV.getScalarVal();
2334}
2335
2336/// Produce the code to do a primitive release.
2337/// [tmp drain];
2338void CodeGenFunction::EmitObjCMRRAutoreleasePoolPop(llvm::Value *Arg) {
2339 IdentifierInfo *II = &CGM.getContext().Idents.get("drain");
2340 Selector DrainSel = getContext().Selectors.getSelector(0, &II);
2341 CallArgList Args;
2342 CGM.getObjCRuntime().GenerateMessageSend(*this, ReturnValueSlot(),
2343 getContext().VoidTy, DrainSel, Arg, Args);
2344}
2345
John McCall82fe67b2011-07-09 01:37:26 +00002346void CodeGenFunction::destroyARCStrongPrecise(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00002347 Address addr,
John McCall82fe67b2011-07-09 01:37:26 +00002348 QualType type) {
John McCallcdda29c2013-03-13 03:10:54 +00002349 CGF.EmitARCDestroyStrong(addr, ARCPreciseLifetime);
John McCall82fe67b2011-07-09 01:37:26 +00002350}
2351
2352void CodeGenFunction::destroyARCStrongImprecise(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00002353 Address addr,
John McCall82fe67b2011-07-09 01:37:26 +00002354 QualType type) {
John McCallcdda29c2013-03-13 03:10:54 +00002355 CGF.EmitARCDestroyStrong(addr, ARCImpreciseLifetime);
John McCall82fe67b2011-07-09 01:37:26 +00002356}
2357
2358void CodeGenFunction::destroyARCWeak(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00002359 Address addr,
John McCall82fe67b2011-07-09 01:37:26 +00002360 QualType type) {
2361 CGF.EmitARCDestroyWeak(addr);
2362}
2363
John McCall31168b02011-06-15 23:02:42 +00002364namespace {
David Blaikie7e70d682015-08-18 22:40:54 +00002365 struct CallObjCAutoreleasePoolObject final : EHScopeStack::Cleanup {
John McCall31168b02011-06-15 23:02:42 +00002366 llvm::Value *Token;
2367
2368 CallObjCAutoreleasePoolObject(llvm::Value *token) : Token(token) {}
2369
Craig Topper4f12f102014-03-12 06:41:41 +00002370 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall31168b02011-06-15 23:02:42 +00002371 CGF.EmitObjCAutoreleasePoolPop(Token);
2372 }
2373 };
David Blaikie7e70d682015-08-18 22:40:54 +00002374 struct CallObjCMRRAutoreleasePoolObject final : EHScopeStack::Cleanup {
John McCall31168b02011-06-15 23:02:42 +00002375 llvm::Value *Token;
2376
2377 CallObjCMRRAutoreleasePoolObject(llvm::Value *token) : Token(token) {}
2378
Craig Topper4f12f102014-03-12 06:41:41 +00002379 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall31168b02011-06-15 23:02:42 +00002380 CGF.EmitObjCMRRAutoreleasePoolPop(Token);
2381 }
2382 };
Alexander Kornienkoab9db512015-06-22 23:07:51 +00002383}
John McCall31168b02011-06-15 23:02:42 +00002384
2385void CodeGenFunction::EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr) {
David Blaikiebbafb8a2012-03-11 07:00:24 +00002386 if (CGM.getLangOpts().ObjCAutoRefCount)
John McCall31168b02011-06-15 23:02:42 +00002387 EHStack.pushCleanup<CallObjCAutoreleasePoolObject>(NormalCleanup, Ptr);
2388 else
2389 EHStack.pushCleanup<CallObjCMRRAutoreleasePoolObject>(NormalCleanup, Ptr);
2390}
2391
John McCall31168b02011-06-15 23:02:42 +00002392static TryEmitResult tryEmitARCRetainLoadOfScalar(CodeGenFunction &CGF,
2393 LValue lvalue,
2394 QualType type) {
2395 switch (type.getObjCLifetime()) {
2396 case Qualifiers::OCL_None:
2397 case Qualifiers::OCL_ExplicitNone:
2398 case Qualifiers::OCL_Strong:
2399 case Qualifiers::OCL_Autoreleasing:
Nick Lewycky2d84e842013-10-02 02:29:49 +00002400 return TryEmitResult(CGF.EmitLoadOfLValue(lvalue,
2401 SourceLocation()).getScalarVal(),
John McCall31168b02011-06-15 23:02:42 +00002402 false);
2403
2404 case Qualifiers::OCL_Weak:
2405 return TryEmitResult(CGF.EmitARCLoadWeakRetained(lvalue.getAddress()),
2406 true);
2407 }
2408
2409 llvm_unreachable("impossible lifetime!");
John McCall31168b02011-06-15 23:02:42 +00002410}
2411
2412static TryEmitResult tryEmitARCRetainLoadOfScalar(CodeGenFunction &CGF,
2413 const Expr *e) {
2414 e = e->IgnoreParens();
2415 QualType type = e->getType();
2416
John McCall154a2fd2011-08-30 00:57:29 +00002417 // If we're loading retained from a __strong xvalue, we can avoid
2418 // an extra retain/release pair by zeroing out the source of this
2419 // "move" operation.
2420 if (e->isXValue() &&
2421 !type.isConstQualified() &&
2422 type.getObjCLifetime() == Qualifiers::OCL_Strong) {
2423 // Emit the lvalue.
2424 LValue lv = CGF.EmitLValue(e);
2425
2426 // Load the object pointer.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002427 llvm::Value *result = CGF.EmitLoadOfLValue(lv,
2428 SourceLocation()).getScalarVal();
John McCall154a2fd2011-08-30 00:57:29 +00002429
2430 // Set the source pointer to NULL.
2431 CGF.EmitStoreOfScalar(getNullForVariable(lv.getAddress()), lv);
2432
2433 return TryEmitResult(result, true);
2434 }
2435
John McCall31168b02011-06-15 23:02:42 +00002436 // As a very special optimization, in ARC++, if the l-value is the
2437 // result of a non-volatile assignment, do a simple retain of the
2438 // result of the call to objc_storeWeak instead of reloading.
David Blaikiebbafb8a2012-03-11 07:00:24 +00002439 if (CGF.getLangOpts().CPlusPlus &&
John McCall31168b02011-06-15 23:02:42 +00002440 !type.isVolatileQualified() &&
2441 type.getObjCLifetime() == Qualifiers::OCL_Weak &&
2442 isa<BinaryOperator>(e) &&
2443 cast<BinaryOperator>(e)->getOpcode() == BO_Assign)
2444 return TryEmitResult(CGF.EmitScalarExpr(e), false);
2445
2446 return tryEmitARCRetainLoadOfScalar(CGF, CGF.EmitLValue(e), type);
2447}
2448
2449static llvm::Value *emitARCRetainAfterCall(CodeGenFunction &CGF,
2450 llvm::Value *value);
2451
2452/// Given that the given expression is some sort of call (which does
2453/// not return retained), emit a retain following it.
2454static llvm::Value *emitARCRetainCall(CodeGenFunction &CGF, const Expr *e) {
2455 llvm::Value *value = CGF.EmitScalarExpr(e);
2456 return emitARCRetainAfterCall(CGF, value);
2457}
2458
2459static llvm::Value *emitARCRetainAfterCall(CodeGenFunction &CGF,
2460 llvm::Value *value) {
2461 if (llvm::CallInst *call = dyn_cast<llvm::CallInst>(value)) {
2462 CGBuilderTy::InsertPoint ip = CGF.Builder.saveIP();
2463
2464 // Place the retain immediately following the call.
2465 CGF.Builder.SetInsertPoint(call->getParent(),
2466 ++llvm::BasicBlock::iterator(call));
2467 value = CGF.EmitARCRetainAutoreleasedReturnValue(value);
2468
2469 CGF.Builder.restoreIP(ip);
2470 return value;
2471 } else if (llvm::InvokeInst *invoke = dyn_cast<llvm::InvokeInst>(value)) {
2472 CGBuilderTy::InsertPoint ip = CGF.Builder.saveIP();
2473
2474 // Place the retain at the beginning of the normal destination block.
2475 llvm::BasicBlock *BB = invoke->getNormalDest();
2476 CGF.Builder.SetInsertPoint(BB, BB->begin());
2477 value = CGF.EmitARCRetainAutoreleasedReturnValue(value);
2478
2479 CGF.Builder.restoreIP(ip);
2480 return value;
2481
2482 // Bitcasts can arise because of related-result returns. Rewrite
2483 // the operand.
2484 } else if (llvm::BitCastInst *bitcast = dyn_cast<llvm::BitCastInst>(value)) {
2485 llvm::Value *operand = bitcast->getOperand(0);
2486 operand = emitARCRetainAfterCall(CGF, operand);
2487 bitcast->setOperand(0, operand);
2488 return bitcast;
2489
2490 // Generic fall-back case.
2491 } else {
2492 // Retain using the non-block variant: we never need to do a copy
2493 // of a block that's been returned to us.
2494 return CGF.EmitARCRetainNonBlock(value);
2495 }
2496}
2497
John McCallcd78e802011-09-10 01:16:55 +00002498/// Determine whether it might be important to emit a separate
2499/// objc_retain_block on the result of the given expression, or
2500/// whether it's okay to just emit it in a +1 context.
2501static bool shouldEmitSeparateBlockRetain(const Expr *e) {
2502 assert(e->getType()->isBlockPointerType());
2503 e = e->IgnoreParens();
2504
2505 // For future goodness, emit block expressions directly in +1
2506 // contexts if we can.
2507 if (isa<BlockExpr>(e))
2508 return false;
2509
2510 if (const CastExpr *cast = dyn_cast<CastExpr>(e)) {
2511 switch (cast->getCastKind()) {
2512 // Emitting these operations in +1 contexts is goodness.
2513 case CK_LValueToRValue:
John McCall2d637d22011-09-10 06:18:15 +00002514 case CK_ARCReclaimReturnedObject:
2515 case CK_ARCConsumeObject:
2516 case CK_ARCProduceObject:
John McCallcd78e802011-09-10 01:16:55 +00002517 return false;
2518
2519 // These operations preserve a block type.
2520 case CK_NoOp:
2521 case CK_BitCast:
2522 return shouldEmitSeparateBlockRetain(cast->getSubExpr());
2523
2524 // These operations are known to be bad (or haven't been considered).
2525 case CK_AnyPointerToBlockPointerCast:
2526 default:
2527 return true;
2528 }
2529 }
2530
2531 return true;
2532}
2533
John McCallfe96e0b2011-11-06 09:01:30 +00002534/// Try to emit a PseudoObjectExpr at +1.
2535///
2536/// This massively duplicates emitPseudoObjectRValue.
2537static TryEmitResult tryEmitARCRetainPseudoObject(CodeGenFunction &CGF,
2538 const PseudoObjectExpr *E) {
Dmitri Gribenkof8579502013-01-12 19:30:44 +00002539 SmallVector<CodeGenFunction::OpaqueValueMappingData, 4> opaques;
John McCallfe96e0b2011-11-06 09:01:30 +00002540
2541 // Find the result expression.
2542 const Expr *resultExpr = E->getResultExpr();
2543 assert(resultExpr);
2544 TryEmitResult result;
2545
2546 for (PseudoObjectExpr::const_semantics_iterator
2547 i = E->semantics_begin(), e = E->semantics_end(); i != e; ++i) {
2548 const Expr *semantic = *i;
2549
2550 // If this semantic expression is an opaque value, bind it
2551 // to the result of its source expression.
2552 if (const OpaqueValueExpr *ov = dyn_cast<OpaqueValueExpr>(semantic)) {
2553 typedef CodeGenFunction::OpaqueValueMappingData OVMA;
2554 OVMA opaqueData;
2555
2556 // If this semantic is the result of the pseudo-object
2557 // expression, try to evaluate the source as +1.
2558 if (ov == resultExpr) {
2559 assert(!OVMA::shouldBindAsLValue(ov));
2560 result = tryEmitARCRetainScalarExpr(CGF, ov->getSourceExpr());
2561 opaqueData = OVMA::bind(CGF, ov, RValue::get(result.getPointer()));
2562
2563 // Otherwise, just bind it.
2564 } else {
2565 opaqueData = OVMA::bind(CGF, ov, ov->getSourceExpr());
2566 }
2567 opaques.push_back(opaqueData);
2568
2569 // Otherwise, if the expression is the result, evaluate it
2570 // and remember the result.
2571 } else if (semantic == resultExpr) {
2572 result = tryEmitARCRetainScalarExpr(CGF, semantic);
2573
2574 // Otherwise, evaluate the expression in an ignored context.
2575 } else {
2576 CGF.EmitIgnoredExpr(semantic);
2577 }
2578 }
2579
2580 // Unbind all the opaques now.
2581 for (unsigned i = 0, e = opaques.size(); i != e; ++i)
2582 opaques[i].unbind(CGF);
2583
2584 return result;
2585}
2586
John McCall31168b02011-06-15 23:02:42 +00002587static TryEmitResult
2588tryEmitARCRetainScalarExpr(CodeGenFunction &CGF, const Expr *e) {
John McCalld21cdd42013-02-12 00:25:08 +00002589 // We should *never* see a nested full-expression here, because if
2590 // we fail to emit at +1, our caller must not retain after we close
2591 // out the full-expression.
2592 assert(!isa<ExprWithCleanups>(e));
John McCall53848232011-07-27 01:07:15 +00002593
John McCall31168b02011-06-15 23:02:42 +00002594 // The desired result type, if it differs from the type of the
2595 // ultimate opaque expression.
Craig Topper8a13c412014-05-21 05:09:00 +00002596 llvm::Type *resultType = nullptr;
John McCall31168b02011-06-15 23:02:42 +00002597
2598 while (true) {
2599 e = e->IgnoreParens();
2600
2601 // There's a break at the end of this if-chain; anything
2602 // that wants to keep looping has to explicitly continue.
2603 if (const CastExpr *ce = dyn_cast<CastExpr>(e)) {
2604 switch (ce->getCastKind()) {
2605 // No-op casts don't change the type, so we just ignore them.
2606 case CK_NoOp:
2607 e = ce->getSubExpr();
2608 continue;
2609
2610 case CK_LValueToRValue: {
2611 TryEmitResult loadResult
2612 = tryEmitARCRetainLoadOfScalar(CGF, ce->getSubExpr());
2613 if (resultType) {
2614 llvm::Value *value = loadResult.getPointer();
2615 value = CGF.Builder.CreateBitCast(value, resultType);
2616 loadResult.setPointer(value);
2617 }
2618 return loadResult;
2619 }
2620
2621 // These casts can change the type, so remember that and
2622 // soldier on. We only need to remember the outermost such
2623 // cast, though.
John McCall9320b872011-09-09 05:25:32 +00002624 case CK_CPointerToObjCPointerCast:
2625 case CK_BlockPointerToObjCPointerCast:
John McCall31168b02011-06-15 23:02:42 +00002626 case CK_AnyPointerToBlockPointerCast:
2627 case CK_BitCast:
2628 if (!resultType)
2629 resultType = CGF.ConvertType(ce->getType());
2630 e = ce->getSubExpr();
2631 assert(e->getType()->hasPointerRepresentation());
2632 continue;
2633
2634 // For consumptions, just emit the subexpression and thus elide
2635 // the retain/release pair.
John McCall2d637d22011-09-10 06:18:15 +00002636 case CK_ARCConsumeObject: {
John McCall31168b02011-06-15 23:02:42 +00002637 llvm::Value *result = CGF.EmitScalarExpr(ce->getSubExpr());
2638 if (resultType) result = CGF.Builder.CreateBitCast(result, resultType);
2639 return TryEmitResult(result, true);
2640 }
2641
John McCallcd78e802011-09-10 01:16:55 +00002642 // Block extends are net +0. Naively, we could just recurse on
2643 // the subexpression, but actually we need to ensure that the
2644 // value is copied as a block, so there's a little filter here.
John McCall2d637d22011-09-10 06:18:15 +00002645 case CK_ARCExtendBlockObject: {
John McCallcd78e802011-09-10 01:16:55 +00002646 llvm::Value *result; // will be a +0 value
2647
2648 // If we can't safely assume the sub-expression will produce a
2649 // block-copied value, emit the sub-expression at +0.
2650 if (shouldEmitSeparateBlockRetain(ce->getSubExpr())) {
2651 result = CGF.EmitScalarExpr(ce->getSubExpr());
2652
2653 // Otherwise, try to emit the sub-expression at +1 recursively.
2654 } else {
2655 TryEmitResult subresult
2656 = tryEmitARCRetainScalarExpr(CGF, ce->getSubExpr());
2657 result = subresult.getPointer();
2658
2659 // If that produced a retained value, just use that,
2660 // possibly casting down.
2661 if (subresult.getInt()) {
2662 if (resultType)
2663 result = CGF.Builder.CreateBitCast(result, resultType);
2664 return TryEmitResult(result, true);
2665 }
2666
2667 // Otherwise it's +0.
2668 }
2669
2670 // Retain the object as a block, then cast down.
John McCallff613032011-10-04 06:23:45 +00002671 result = CGF.EmitARCRetainBlock(result, /*mandatory*/ true);
John McCallcd78e802011-09-10 01:16:55 +00002672 if (resultType) result = CGF.Builder.CreateBitCast(result, resultType);
2673 return TryEmitResult(result, true);
2674 }
2675
John McCall4db5c3c2011-07-07 06:58:02 +00002676 // For reclaims, emit the subexpression as a retained call and
2677 // skip the consumption.
John McCall2d637d22011-09-10 06:18:15 +00002678 case CK_ARCReclaimReturnedObject: {
John McCall4db5c3c2011-07-07 06:58:02 +00002679 llvm::Value *result = emitARCRetainCall(CGF, ce->getSubExpr());
2680 if (resultType) result = CGF.Builder.CreateBitCast(result, resultType);
2681 return TryEmitResult(result, true);
2682 }
2683
John McCall31168b02011-06-15 23:02:42 +00002684 default:
2685 break;
2686 }
2687
2688 // Skip __extension__.
2689 } else if (const UnaryOperator *op = dyn_cast<UnaryOperator>(e)) {
2690 if (op->getOpcode() == UO_Extension) {
2691 e = op->getSubExpr();
2692 continue;
2693 }
2694
2695 // For calls and message sends, use the retained-call logic.
2696 // Delegate inits are a special case in that they're the only
2697 // returns-retained expression that *isn't* surrounded by
2698 // a consume.
2699 } else if (isa<CallExpr>(e) ||
2700 (isa<ObjCMessageExpr>(e) &&
2701 !cast<ObjCMessageExpr>(e)->isDelegateInitCall())) {
2702 llvm::Value *result = emitARCRetainCall(CGF, e);
2703 if (resultType) result = CGF.Builder.CreateBitCast(result, resultType);
2704 return TryEmitResult(result, true);
John McCallfe96e0b2011-11-06 09:01:30 +00002705
2706 // Look through pseudo-object expressions.
2707 } else if (const PseudoObjectExpr *pseudo = dyn_cast<PseudoObjectExpr>(e)) {
2708 TryEmitResult result
2709 = tryEmitARCRetainPseudoObject(CGF, pseudo);
2710 if (resultType) {
2711 llvm::Value *value = result.getPointer();
2712 value = CGF.Builder.CreateBitCast(value, resultType);
2713 result.setPointer(value);
2714 }
2715 return result;
John McCall31168b02011-06-15 23:02:42 +00002716 }
2717
2718 // Conservatively halt the search at any other expression kind.
2719 break;
2720 }
2721
2722 // We didn't find an obvious production, so emit what we've got and
2723 // tell the caller that we didn't manage to retain.
2724 llvm::Value *result = CGF.EmitScalarExpr(e);
2725 if (resultType) result = CGF.Builder.CreateBitCast(result, resultType);
2726 return TryEmitResult(result, false);
2727}
2728
2729static llvm::Value *emitARCRetainLoadOfScalar(CodeGenFunction &CGF,
2730 LValue lvalue,
2731 QualType type) {
2732 TryEmitResult result = tryEmitARCRetainLoadOfScalar(CGF, lvalue, type);
2733 llvm::Value *value = result.getPointer();
2734 if (!result.getInt())
2735 value = CGF.EmitARCRetain(type, value);
2736 return value;
2737}
2738
2739/// EmitARCRetainScalarExpr - Semantically equivalent to
2740/// EmitARCRetainObject(e->getType(), EmitScalarExpr(e)), but making a
2741/// best-effort attempt to peephole expressions that naturally produce
2742/// retained objects.
2743llvm::Value *CodeGenFunction::EmitARCRetainScalarExpr(const Expr *e) {
John McCalld21cdd42013-02-12 00:25:08 +00002744 // The retain needs to happen within the full-expression.
2745 if (const ExprWithCleanups *cleanups = dyn_cast<ExprWithCleanups>(e)) {
2746 enterFullExpression(cleanups);
2747 RunCleanupsScope scope(*this);
2748 return EmitARCRetainScalarExpr(cleanups->getSubExpr());
2749 }
2750
John McCall31168b02011-06-15 23:02:42 +00002751 TryEmitResult result = tryEmitARCRetainScalarExpr(*this, e);
2752 llvm::Value *value = result.getPointer();
2753 if (!result.getInt())
2754 value = EmitARCRetain(e->getType(), value);
2755 return value;
2756}
2757
2758llvm::Value *
2759CodeGenFunction::EmitARCRetainAutoreleaseScalarExpr(const Expr *e) {
John McCalld21cdd42013-02-12 00:25:08 +00002760 // The retain needs to happen within the full-expression.
2761 if (const ExprWithCleanups *cleanups = dyn_cast<ExprWithCleanups>(e)) {
2762 enterFullExpression(cleanups);
2763 RunCleanupsScope scope(*this);
2764 return EmitARCRetainAutoreleaseScalarExpr(cleanups->getSubExpr());
2765 }
2766
John McCall31168b02011-06-15 23:02:42 +00002767 TryEmitResult result = tryEmitARCRetainScalarExpr(*this, e);
2768 llvm::Value *value = result.getPointer();
2769 if (result.getInt())
2770 value = EmitARCAutorelease(value);
2771 else
2772 value = EmitARCRetainAutorelease(e->getType(), value);
2773 return value;
2774}
2775
John McCallff613032011-10-04 06:23:45 +00002776llvm::Value *CodeGenFunction::EmitARCExtendBlockObject(const Expr *e) {
2777 llvm::Value *result;
2778 bool doRetain;
2779
2780 if (shouldEmitSeparateBlockRetain(e)) {
2781 result = EmitScalarExpr(e);
2782 doRetain = true;
2783 } else {
2784 TryEmitResult subresult = tryEmitARCRetainScalarExpr(*this, e);
2785 result = subresult.getPointer();
2786 doRetain = !subresult.getInt();
2787 }
2788
2789 if (doRetain)
2790 result = EmitARCRetainBlock(result, /*mandatory*/ true);
2791 return EmitObjCConsumeObject(e->getType(), result);
2792}
2793
John McCall248512a2011-10-01 10:32:24 +00002794llvm::Value *CodeGenFunction::EmitObjCThrowOperand(const Expr *expr) {
2795 // In ARC, retain and autorelease the expression.
David Blaikiebbafb8a2012-03-11 07:00:24 +00002796 if (getLangOpts().ObjCAutoRefCount) {
John McCall248512a2011-10-01 10:32:24 +00002797 // Do so before running any cleanups for the full-expression.
John McCalld21cdd42013-02-12 00:25:08 +00002798 // EmitARCRetainAutoreleaseScalarExpr does this for us.
John McCall248512a2011-10-01 10:32:24 +00002799 return EmitARCRetainAutoreleaseScalarExpr(expr);
2800 }
2801
2802 // Otherwise, use the normal scalar-expression emission. The
2803 // exception machinery doesn't do anything special with the
2804 // exception like retaining it, so there's no safety associated with
2805 // only running cleanups after the throw has started, and when it
2806 // matters it tends to be substantially inferior code.
2807 return EmitScalarExpr(expr);
2808}
2809
John McCall31168b02011-06-15 23:02:42 +00002810std::pair<LValue,llvm::Value*>
2811CodeGenFunction::EmitARCStoreStrong(const BinaryOperator *e,
2812 bool ignored) {
2813 // Evaluate the RHS first.
2814 TryEmitResult result = tryEmitARCRetainScalarExpr(*this, e->getRHS());
2815 llvm::Value *value = result.getPointer();
2816
John McCallb726a552011-07-28 07:23:35 +00002817 bool hasImmediateRetain = result.getInt();
2818
2819 // If we didn't emit a retained object, and the l-value is of block
2820 // type, then we need to emit the block-retain immediately in case
2821 // it invalidates the l-value.
2822 if (!hasImmediateRetain && e->getType()->isBlockPointerType()) {
John McCallff613032011-10-04 06:23:45 +00002823 value = EmitARCRetainBlock(value, /*mandatory*/ false);
John McCallb726a552011-07-28 07:23:35 +00002824 hasImmediateRetain = true;
2825 }
2826
John McCall31168b02011-06-15 23:02:42 +00002827 LValue lvalue = EmitLValue(e->getLHS());
2828
2829 // If the RHS was emitted retained, expand this.
John McCallb726a552011-07-28 07:23:35 +00002830 if (hasImmediateRetain) {
Nick Lewyckyce550072013-10-02 02:33:11 +00002831 llvm::Value *oldValue = EmitLoadOfScalar(lvalue, SourceLocation());
Eli Friedmana0544d62011-12-03 04:14:32 +00002832 EmitStoreOfScalar(value, lvalue);
John McCallcdda29c2013-03-13 03:10:54 +00002833 EmitARCRelease(oldValue, lvalue.isARCPreciseLifetime());
John McCall31168b02011-06-15 23:02:42 +00002834 } else {
John McCall55e1fbc2011-06-25 02:11:03 +00002835 value = EmitARCStoreStrong(lvalue, value, ignored);
John McCall31168b02011-06-15 23:02:42 +00002836 }
2837
2838 return std::pair<LValue,llvm::Value*>(lvalue, value);
2839}
2840
2841std::pair<LValue,llvm::Value*>
2842CodeGenFunction::EmitARCStoreAutoreleasing(const BinaryOperator *e) {
2843 llvm::Value *value = EmitARCRetainAutoreleaseScalarExpr(e->getRHS());
2844 LValue lvalue = EmitLValue(e->getLHS());
2845
Eli Friedmana0544d62011-12-03 04:14:32 +00002846 EmitStoreOfScalar(value, lvalue);
John McCall31168b02011-06-15 23:02:42 +00002847
2848 return std::pair<LValue,llvm::Value*>(lvalue, value);
2849}
2850
2851void CodeGenFunction::EmitObjCAutoreleasePoolStmt(
Eric Christopher5d2b8d92012-03-29 17:31:31 +00002852 const ObjCAutoreleasePoolStmt &ARPS) {
John McCall31168b02011-06-15 23:02:42 +00002853 const Stmt *subStmt = ARPS.getSubStmt();
2854 const CompoundStmt &S = cast<CompoundStmt>(*subStmt);
2855
2856 CGDebugInfo *DI = getDebugInfo();
Eric Christopher7cdf9482011-10-13 21:45:18 +00002857 if (DI)
2858 DI->EmitLexicalBlockStart(Builder, S.getLBracLoc());
John McCall31168b02011-06-15 23:02:42 +00002859
2860 // Keep track of the current cleanup stack depth.
2861 RunCleanupsScope Scope(*this);
John McCall3deb1ad2012-08-21 02:47:43 +00002862 if (CGM.getLangOpts().ObjCRuntime.hasNativeARC()) {
John McCall31168b02011-06-15 23:02:42 +00002863 llvm::Value *token = EmitObjCAutoreleasePoolPush();
2864 EHStack.pushCleanup<CallObjCAutoreleasePoolObject>(NormalCleanup, token);
2865 } else {
2866 llvm::Value *token = EmitObjCMRRAutoreleasePoolPush();
2867 EHStack.pushCleanup<CallObjCMRRAutoreleasePoolObject>(NormalCleanup, token);
2868 }
2869
Aaron Ballmanc7e4e212014-03-17 14:19:37 +00002870 for (const auto *I : S.body())
2871 EmitStmt(I);
John McCall31168b02011-06-15 23:02:42 +00002872
Eric Christopher7cdf9482011-10-13 21:45:18 +00002873 if (DI)
2874 DI->EmitLexicalBlockEnd(Builder, S.getRBracLoc());
John McCall31168b02011-06-15 23:02:42 +00002875}
John McCall1bd25562011-06-24 23:21:27 +00002876
2877/// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
2878/// make sure it survives garbage collection until this point.
2879void CodeGenFunction::EmitExtendGCLifetime(llvm::Value *object) {
2880 // We just use an inline assembly.
John McCall1bd25562011-06-24 23:21:27 +00002881 llvm::FunctionType *extenderType
John McCalla729c622012-02-17 03:33:10 +00002882 = llvm::FunctionType::get(VoidTy, VoidPtrTy, RequiredArgs::All);
John McCall1bd25562011-06-24 23:21:27 +00002883 llvm::Value *extender
2884 = llvm::InlineAsm::get(extenderType,
2885 /* assembly */ "",
2886 /* constraints */ "r",
2887 /* side effects */ true);
2888
2889 object = Builder.CreateBitCast(object, VoidPtrTy);
John McCall882987f2013-02-28 19:01:20 +00002890 EmitNounwindRuntimeCall(extender, object);
John McCall1bd25562011-06-24 23:21:27 +00002891}
2892
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00002893/// GenerateObjCAtomicSetterCopyHelperFunction - Given a c++ object type with
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00002894/// non-trivial copy assignment function, produce following helper function.
2895/// static void copyHelper(Ty *dest, const Ty *source) { *dest = *source; }
2896///
2897llvm::Constant *
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00002898CodeGenFunction::GenerateObjCAtomicSetterCopyHelperFunction(
2899 const ObjCPropertyImplDecl *PID) {
John McCall5fb5df92012-06-20 06:18:46 +00002900 if (!getLangOpts().CPlusPlus ||
Rafael Espindolad727d3d2012-12-18 04:29:34 +00002901 !getLangOpts().ObjCRuntime.hasAtomicCopyHelper())
Craig Topper8a13c412014-05-21 05:09:00 +00002902 return nullptr;
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00002903 QualType Ty = PID->getPropertyIvarDecl()->getType();
2904 if (!Ty->isRecordType())
Craig Topper8a13c412014-05-21 05:09:00 +00002905 return nullptr;
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00002906 const ObjCPropertyDecl *PD = PID->getPropertyDecl();
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00002907 if ((!(PD->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_atomic)))
Craig Topper8a13c412014-05-21 05:09:00 +00002908 return nullptr;
2909 llvm::Constant *HelperFn = nullptr;
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00002910 if (hasTrivialSetExpr(PID))
Craig Topper8a13c412014-05-21 05:09:00 +00002911 return nullptr;
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00002912 assert(PID->getSetterCXXAssignment() && "SetterCXXAssignment - null");
2913 if ((HelperFn = CGM.getAtomicSetterHelperFnMap(Ty)))
2914 return HelperFn;
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00002915
2916 ASTContext &C = getContext();
2917 IdentifierInfo *II
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00002918 = &CGM.getContext().Idents.get("__assign_helper_atomic_property_");
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00002919 FunctionDecl *FD = FunctionDecl::Create(C,
2920 C.getTranslationUnitDecl(),
2921 SourceLocation(),
Craig Topper8a13c412014-05-21 05:09:00 +00002922 SourceLocation(), II, C.VoidTy,
2923 nullptr, SC_Static,
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00002924 false,
Eric Christopher0b1aef22012-04-12 02:16:49 +00002925 false);
Craig Topper8a13c412014-05-21 05:09:00 +00002926
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00002927 QualType DestTy = C.getPointerType(Ty);
2928 QualType SrcTy = Ty;
2929 SrcTy.addConst();
2930 SrcTy = C.getPointerType(SrcTy);
2931
2932 FunctionArgList args;
Craig Topper8a13c412014-05-21 05:09:00 +00002933 ImplicitParamDecl dstDecl(getContext(), FD, SourceLocation(), nullptr,DestTy);
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00002934 args.push_back(&dstDecl);
Craig Topper8a13c412014-05-21 05:09:00 +00002935 ImplicitParamDecl srcDecl(getContext(), FD, SourceLocation(), nullptr, SrcTy);
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00002936 args.push_back(&srcDecl);
Reid Kleckner4982b822014-01-31 22:54:50 +00002937
2938 const CGFunctionInfo &FI = CGM.getTypes().arrangeFreeFunctionDeclaration(
2939 C.VoidTy, args, FunctionType::ExtInfo(), RequiredArgs::All);
2940
John McCalla729c622012-02-17 03:33:10 +00002941 llvm::FunctionType *LTy = CGM.getTypes().GetFunctionType(FI);
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00002942
2943 llvm::Function *Fn =
2944 llvm::Function::Create(LTy, llvm::GlobalValue::InternalLinkage,
Eric Christopher5d2b8d92012-03-29 17:31:31 +00002945 "__assign_helper_atomic_property_",
2946 &CGM.getModule());
Akira Hatanaka44a59f82015-10-28 02:30:47 +00002947
2948 CGM.SetInternalFunctionAttributes(nullptr, Fn, FI);
2949
Adrian Prantl22e66b42014-04-11 01:13:04 +00002950 StartFunction(FD, C.VoidTy, Fn, FI, args);
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00002951
John McCall113bee02012-03-10 09:33:50 +00002952 DeclRefExpr DstExpr(&dstDecl, false, DestTy,
2953 VK_RValue, SourceLocation());
2954 UnaryOperator DST(&DstExpr, UO_Deref, DestTy->getPointeeType(),
2955 VK_LValue, OK_Ordinary, SourceLocation());
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00002956
John McCall113bee02012-03-10 09:33:50 +00002957 DeclRefExpr SrcExpr(&srcDecl, false, SrcTy,
2958 VK_RValue, SourceLocation());
2959 UnaryOperator SRC(&SrcExpr, UO_Deref, SrcTy->getPointeeType(),
2960 VK_LValue, OK_Ordinary, SourceLocation());
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00002961
John McCall113bee02012-03-10 09:33:50 +00002962 Expr *Args[2] = { &DST, &SRC };
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00002963 CallExpr *CalleeExp = cast<CallExpr>(PID->getSetterCXXAssignment());
John McCall113bee02012-03-10 09:33:50 +00002964 CXXOperatorCallExpr TheCall(C, OO_Equal, CalleeExp->getCallee(),
Benjamin Kramerc215e762012-08-24 11:54:20 +00002965 Args, DestTy->getPointeeType(),
Lang Hames5de91cc2012-10-02 04:45:10 +00002966 VK_LValue, SourceLocation(), false);
John McCall113bee02012-03-10 09:33:50 +00002967
2968 EmitStmt(&TheCall);
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00002969
2970 FinishFunction();
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00002971 HelperFn = llvm::ConstantExpr::getBitCast(Fn, VoidPtrTy);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00002972 CGM.setAtomicSetterHelperFnMap(Ty, HelperFn);
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00002973 return HelperFn;
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00002974}
2975
2976llvm::Constant *
2977CodeGenFunction::GenerateObjCAtomicGetterCopyHelperFunction(
2978 const ObjCPropertyImplDecl *PID) {
John McCall5fb5df92012-06-20 06:18:46 +00002979 if (!getLangOpts().CPlusPlus ||
Rafael Espindolad727d3d2012-12-18 04:29:34 +00002980 !getLangOpts().ObjCRuntime.hasAtomicCopyHelper())
Craig Topper8a13c412014-05-21 05:09:00 +00002981 return nullptr;
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00002982 const ObjCPropertyDecl *PD = PID->getPropertyDecl();
2983 QualType Ty = PD->getType();
2984 if (!Ty->isRecordType())
Craig Topper8a13c412014-05-21 05:09:00 +00002985 return nullptr;
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00002986 if ((!(PD->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_atomic)))
Craig Topper8a13c412014-05-21 05:09:00 +00002987 return nullptr;
2988 llvm::Constant *HelperFn = nullptr;
2989
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00002990 if (hasTrivialGetExpr(PID))
Craig Topper8a13c412014-05-21 05:09:00 +00002991 return nullptr;
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00002992 assert(PID->getGetterCXXConstructor() && "getGetterCXXConstructor - null");
2993 if ((HelperFn = CGM.getAtomicGetterHelperFnMap(Ty)))
2994 return HelperFn;
2995
2996
2997 ASTContext &C = getContext();
2998 IdentifierInfo *II
2999 = &CGM.getContext().Idents.get("__copy_helper_atomic_property_");
3000 FunctionDecl *FD = FunctionDecl::Create(C,
3001 C.getTranslationUnitDecl(),
3002 SourceLocation(),
Craig Topper8a13c412014-05-21 05:09:00 +00003003 SourceLocation(), II, C.VoidTy,
3004 nullptr, SC_Static,
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003005 false,
Eric Christopher0b1aef22012-04-12 02:16:49 +00003006 false);
Craig Topper8a13c412014-05-21 05:09:00 +00003007
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003008 QualType DestTy = C.getPointerType(Ty);
3009 QualType SrcTy = Ty;
3010 SrcTy.addConst();
3011 SrcTy = C.getPointerType(SrcTy);
3012
3013 FunctionArgList args;
Craig Topper8a13c412014-05-21 05:09:00 +00003014 ImplicitParamDecl dstDecl(getContext(), FD, SourceLocation(), nullptr,DestTy);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003015 args.push_back(&dstDecl);
Craig Topper8a13c412014-05-21 05:09:00 +00003016 ImplicitParamDecl srcDecl(getContext(), FD, SourceLocation(), nullptr, SrcTy);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003017 args.push_back(&srcDecl);
Reid Kleckner4982b822014-01-31 22:54:50 +00003018
3019 const CGFunctionInfo &FI = CGM.getTypes().arrangeFreeFunctionDeclaration(
3020 C.VoidTy, args, FunctionType::ExtInfo(), RequiredArgs::All);
3021
John McCalla729c622012-02-17 03:33:10 +00003022 llvm::FunctionType *LTy = CGM.getTypes().GetFunctionType(FI);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003023
3024 llvm::Function *Fn =
3025 llvm::Function::Create(LTy, llvm::GlobalValue::InternalLinkage,
3026 "__copy_helper_atomic_property_", &CGM.getModule());
3027
Akira Hatanaka44a59f82015-10-28 02:30:47 +00003028 CGM.SetInternalFunctionAttributes(nullptr, Fn, FI);
3029
Adrian Prantl22e66b42014-04-11 01:13:04 +00003030 StartFunction(FD, C.VoidTy, Fn, FI, args);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003031
John McCall113bee02012-03-10 09:33:50 +00003032 DeclRefExpr SrcExpr(&srcDecl, false, SrcTy,
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003033 VK_RValue, SourceLocation());
3034
John McCall113bee02012-03-10 09:33:50 +00003035 UnaryOperator SRC(&SrcExpr, UO_Deref, SrcTy->getPointeeType(),
3036 VK_LValue, OK_Ordinary, SourceLocation());
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003037
3038 CXXConstructExpr *CXXConstExpr =
3039 cast<CXXConstructExpr>(PID->getGetterCXXConstructor());
3040
3041 SmallVector<Expr*, 4> ConstructorArgs;
John McCall113bee02012-03-10 09:33:50 +00003042 ConstructorArgs.push_back(&SRC);
Benjamin Kramerf367dd92015-06-12 15:31:50 +00003043 ConstructorArgs.append(std::next(CXXConstExpr->arg_begin()),
3044 CXXConstExpr->arg_end());
3045
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003046 CXXConstructExpr *TheCXXConstructExpr =
3047 CXXConstructExpr::Create(C, Ty, SourceLocation(),
3048 CXXConstExpr->getConstructor(),
3049 CXXConstExpr->isElidable(),
Benjamin Kramerc215e762012-08-24 11:54:20 +00003050 ConstructorArgs,
Sebastian Redla9351792012-02-11 23:51:47 +00003051 CXXConstExpr->hadMultipleCandidates(),
3052 CXXConstExpr->isListInitialization(),
Richard Smithf8adcdc2014-07-17 05:12:35 +00003053 CXXConstExpr->isStdInitListInitialization(),
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003054 CXXConstExpr->requiresZeroInitialization(),
Eric Christopher5d2b8d92012-03-29 17:31:31 +00003055 CXXConstExpr->getConstructionKind(),
3056 SourceRange());
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003057
John McCall113bee02012-03-10 09:33:50 +00003058 DeclRefExpr DstExpr(&dstDecl, false, DestTy,
3059 VK_RValue, SourceLocation());
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003060
John McCall113bee02012-03-10 09:33:50 +00003061 RValue DV = EmitAnyExpr(&DstExpr);
Eric Christopher5d2b8d92012-03-29 17:31:31 +00003062 CharUnits Alignment
3063 = getContext().getTypeAlignInChars(TheCXXConstructExpr->getType());
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003064 EmitAggExpr(TheCXXConstructExpr,
John McCall7f416cc2015-09-08 08:05:57 +00003065 AggValueSlot::forAddr(Address(DV.getScalarVal(), Alignment),
3066 Qualifiers(),
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003067 AggValueSlot::IsDestructed,
3068 AggValueSlot::DoesNotNeedGCBarriers,
Chad Rosier615ed1a2012-03-29 17:37:10 +00003069 AggValueSlot::IsNotAliased));
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003070
3071 FinishFunction();
3072 HelperFn = llvm::ConstantExpr::getBitCast(Fn, VoidPtrTy);
3073 CGM.setAtomicGetterHelperFnMap(Ty, HelperFn);
3074 return HelperFn;
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003075}
3076
Eli Friedmanec75fec2012-02-28 01:08:45 +00003077llvm::Value *
3078CodeGenFunction::EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty) {
3079 // Get selectors for retain/autorelease.
Eli Friedmanc4e5d0c2012-03-01 22:52:28 +00003080 IdentifierInfo *CopyID = &getContext().Idents.get("copy");
3081 Selector CopySelector =
3082 getContext().Selectors.getNullarySelector(CopyID);
Eli Friedmanec75fec2012-02-28 01:08:45 +00003083 IdentifierInfo *AutoreleaseID = &getContext().Idents.get("autorelease");
3084 Selector AutoreleaseSelector =
3085 getContext().Selectors.getNullarySelector(AutoreleaseID);
3086
3087 // Emit calls to retain/autorelease.
3088 CGObjCRuntime &Runtime = CGM.getObjCRuntime();
3089 llvm::Value *Val = Block;
3090 RValue Result;
3091 Result = Runtime.GenerateMessageSend(*this, ReturnValueSlot(),
Eli Friedmanc4e5d0c2012-03-01 22:52:28 +00003092 Ty, CopySelector,
Craig Topper8a13c412014-05-21 05:09:00 +00003093 Val, CallArgList(), nullptr, nullptr);
Eli Friedmanec75fec2012-02-28 01:08:45 +00003094 Val = Result.getScalarVal();
3095 Result = Runtime.GenerateMessageSend(*this, ReturnValueSlot(),
3096 Ty, AutoreleaseSelector,
Craig Topper8a13c412014-05-21 05:09:00 +00003097 Val, CallArgList(), nullptr, nullptr);
Eli Friedmanec75fec2012-02-28 01:08:45 +00003098 Val = Result.getScalarVal();
3099 return Val;
3100}
3101
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003102
Angel Garcia Gomez637d1e62015-10-20 13:23:58 +00003103CGObjCRuntime::~CGObjCRuntime() {}