blob: aa990143ac23efc8411bbe011301c37bfcc7046e [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 Carruthffd55512013-01-02 11:45:17 +000025#include "llvm/IR/DataLayout.h"
26#include "llvm/IR/InlineAsm.h"
Chandler Carruth5553d0d2014-01-07 11:51:46 +000027#include "llvm/Support/CallSite.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);
Ted Kremeneke65b0862012-03-06 20:05:56 +000034static RValue AdjustRelatedResultType(CodeGenFunction &CGF,
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +000035 QualType ET,
Ted Kremeneke65b0862012-03-06 20:05:56 +000036 const ObjCMethodDecl *Method,
37 RValue Result);
John McCall31168b02011-06-15 23:02:42 +000038
39/// Given the address of a variable of pointer type, find the correct
40/// null to store into it.
41static llvm::Constant *getNullForVariable(llvm::Value *addr) {
Chris Lattner2192fe52011-07-18 04:24:23 +000042 llvm::Type *type =
John McCall31168b02011-06-15 23:02:42 +000043 cast<llvm::PointerType>(addr->getType())->getElementType();
44 return llvm::ConstantPointerNull::get(cast<llvm::PointerType>(type));
45}
46
Chris Lattnerb1d329d2008-06-24 17:04:18 +000047/// Emits an instance of NSConstantString representing the object.
Mike Stump11289f42009-09-09 15:08:12 +000048llvm::Value *CodeGenFunction::EmitObjCStringLiteral(const ObjCStringLiteral *E)
Daniel Dunbar44b58a22008-11-25 21:53:21 +000049{
David Chisnall481e3a82010-01-23 02:40:42 +000050 llvm::Constant *C =
51 CGM.getObjCRuntime().GenerateConstantString(E->getString());
Daniel Dunbar66912a12008-08-20 00:28:19 +000052 // FIXME: This bitcast should just be made an invariant on the Runtime.
Owen Andersonade90fd2009-07-29 18:54:39 +000053 return llvm::ConstantExpr::getBitCast(C, ConvertType(E->getType()));
Chris Lattnerb1d329d2008-06-24 17:04:18 +000054}
55
Patrick Beard0caa3942012-04-19 00:25:12 +000056/// EmitObjCBoxedExpr - This routine generates code to call
57/// the appropriate expression boxing method. This will either be
58/// one of +[NSNumber numberWith<Type>:], or +[NSString stringWithUTF8String:].
Ted Kremeneke65b0862012-03-06 20:05:56 +000059///
Eric Christopher5d2b8d92012-03-29 17:31:31 +000060llvm::Value *
Patrick Beard0caa3942012-04-19 00:25:12 +000061CodeGenFunction::EmitObjCBoxedExpr(const ObjCBoxedExpr *E) {
Ted Kremeneke65b0862012-03-06 20:05:56 +000062 // Generate the correct selector for this literal's concrete type.
Patrick Beard0caa3942012-04-19 00:25:12 +000063 const Expr *SubExpr = E->getSubExpr();
Ted Kremeneke65b0862012-03-06 20:05:56 +000064 // Get the method.
Patrick Beard0caa3942012-04-19 00:25:12 +000065 const ObjCMethodDecl *BoxingMethod = E->getBoxingMethod();
66 assert(BoxingMethod && "BoxingMethod is null");
67 assert(BoxingMethod->isClassMethod() && "BoxingMethod must be a class method");
68 Selector Sel = BoxingMethod->getSelector();
Ted Kremeneke65b0862012-03-06 20:05:56 +000069
70 // Generate a reference to the class pointer, which will be the receiver.
Patrick Beard0caa3942012-04-19 00:25:12 +000071 // Assumes that the method was introduced in the class that should be
72 // messaged (avoids pulling it out of the result type).
Ted Kremeneke65b0862012-03-06 20:05:56 +000073 CGObjCRuntime &Runtime = CGM.getObjCRuntime();
Patrick Beard0caa3942012-04-19 00:25:12 +000074 const ObjCInterfaceDecl *ClassDecl = BoxingMethod->getClassInterface();
John McCall882987f2013-02-28 19:01:20 +000075 llvm::Value *Receiver = Runtime.GetClass(*this, ClassDecl);
Patrick Beard0caa3942012-04-19 00:25:12 +000076
77 const ParmVarDecl *argDecl = *BoxingMethod->param_begin();
Ted Kremeneke65b0862012-03-06 20:05:56 +000078 QualType ArgQT = argDecl->getType().getUnqualifiedType();
Patrick Beard0caa3942012-04-19 00:25:12 +000079 RValue RV = EmitAnyExpr(SubExpr);
Ted Kremeneke65b0862012-03-06 20:05:56 +000080 CallArgList Args;
81 Args.add(RV, ArgQT);
Patrick Beard0caa3942012-04-19 00:25:12 +000082
Ted Kremeneke65b0862012-03-06 20:05:56 +000083 RValue result = Runtime.GenerateMessageSend(*this, ReturnValueSlot(),
Patrick Beard0caa3942012-04-19 00:25:12 +000084 BoxingMethod->getResultType(), Sel, Receiver, Args,
85 ClassDecl, BoxingMethod);
Ted Kremeneke65b0862012-03-06 20:05:56 +000086 return Builder.CreateBitCast(result.getScalarVal(),
87 ConvertType(E->getType()));
88}
89
90llvm::Value *CodeGenFunction::EmitObjCCollectionLiteral(const Expr *E,
91 const ObjCMethodDecl *MethodWithObjects) {
92 ASTContext &Context = CGM.getContext();
93 const ObjCDictionaryLiteral *DLE = 0;
94 const ObjCArrayLiteral *ALE = dyn_cast<ObjCArrayLiteral>(E);
95 if (!ALE)
96 DLE = cast<ObjCDictionaryLiteral>(E);
97
98 // Compute the type of the array we're initializing.
99 uint64_t NumElements =
100 ALE ? ALE->getNumElements() : DLE->getNumElements();
101 llvm::APInt APNumElements(Context.getTypeSize(Context.getSizeType()),
102 NumElements);
103 QualType ElementType = Context.getObjCIdType().withConst();
104 QualType ElementArrayType
105 = Context.getConstantArrayType(ElementType, APNumElements,
106 ArrayType::Normal, /*IndexTypeQuals=*/0);
107
108 // Allocate the temporary array(s).
109 llvm::Value *Objects = CreateMemTemp(ElementArrayType, "objects");
110 llvm::Value *Keys = 0;
111 if (DLE)
112 Keys = CreateMemTemp(ElementArrayType, "keys");
113
John McCall770a4c12013-04-04 00:20:38 +0000114 // In ARC, we may need to do extra work to keep all the keys and
115 // values alive until after the call.
116 SmallVector<llvm::Value *, 16> NeededObjects;
117 bool TrackNeededObjects =
118 (getLangOpts().ObjCAutoRefCount &&
119 CGM.getCodeGenOpts().OptimizationLevel != 0);
120
Ted Kremeneke65b0862012-03-06 20:05:56 +0000121 // Perform the actual initialialization of the array(s).
122 for (uint64_t i = 0; i < NumElements; i++) {
123 if (ALE) {
John McCall770a4c12013-04-04 00:20:38 +0000124 // Emit the element and store it to the appropriate array slot.
Ted Kremeneke65b0862012-03-06 20:05:56 +0000125 const Expr *Rhs = ALE->getElement(i);
126 LValue LV = LValue::MakeAddr(Builder.CreateStructGEP(Objects, i),
127 ElementType,
128 Context.getTypeAlignInChars(Rhs->getType()),
129 Context);
John McCall770a4c12013-04-04 00:20:38 +0000130
131 llvm::Value *value = EmitScalarExpr(Rhs);
132 EmitStoreThroughLValue(RValue::get(value), LV, true);
133 if (TrackNeededObjects) {
134 NeededObjects.push_back(value);
135 }
Ted Kremeneke65b0862012-03-06 20:05:56 +0000136 } else {
John McCall770a4c12013-04-04 00:20:38 +0000137 // Emit the key and store it to the appropriate array slot.
Ted Kremeneke65b0862012-03-06 20:05:56 +0000138 const Expr *Key = DLE->getKeyValueElement(i).Key;
139 LValue KeyLV = LValue::MakeAddr(Builder.CreateStructGEP(Keys, i),
140 ElementType,
141 Context.getTypeAlignInChars(Key->getType()),
142 Context);
John McCall770a4c12013-04-04 00:20:38 +0000143 llvm::Value *keyValue = EmitScalarExpr(Key);
144 EmitStoreThroughLValue(RValue::get(keyValue), KeyLV, /*isInit=*/true);
Ted Kremeneke65b0862012-03-06 20:05:56 +0000145
John McCall770a4c12013-04-04 00:20:38 +0000146 // Emit the value and store it to the appropriate array slot.
Ted Kremeneke65b0862012-03-06 20:05:56 +0000147 const Expr *Value = DLE->getKeyValueElement(i).Value;
148 LValue ValueLV = LValue::MakeAddr(Builder.CreateStructGEP(Objects, i),
149 ElementType,
150 Context.getTypeAlignInChars(Value->getType()),
151 Context);
John McCall770a4c12013-04-04 00:20:38 +0000152 llvm::Value *valueValue = EmitScalarExpr(Value);
153 EmitStoreThroughLValue(RValue::get(valueValue), ValueLV, /*isInit=*/true);
154 if (TrackNeededObjects) {
155 NeededObjects.push_back(keyValue);
156 NeededObjects.push_back(valueValue);
157 }
Ted Kremeneke65b0862012-03-06 20:05:56 +0000158 }
159 }
160
161 // Generate the argument list.
162 CallArgList Args;
163 ObjCMethodDecl::param_const_iterator PI = MethodWithObjects->param_begin();
164 const ParmVarDecl *argDecl = *PI++;
165 QualType ArgQT = argDecl->getType().getUnqualifiedType();
166 Args.add(RValue::get(Objects), ArgQT);
167 if (DLE) {
168 argDecl = *PI++;
169 ArgQT = argDecl->getType().getUnqualifiedType();
170 Args.add(RValue::get(Keys), ArgQT);
171 }
172 argDecl = *PI;
173 ArgQT = argDecl->getType().getUnqualifiedType();
174 llvm::Value *Count =
175 llvm::ConstantInt::get(CGM.getTypes().ConvertType(ArgQT), NumElements);
176 Args.add(RValue::get(Count), ArgQT);
177
178 // Generate a reference to the class pointer, which will be the receiver.
179 Selector Sel = MethodWithObjects->getSelector();
180 QualType ResultType = E->getType();
181 const ObjCObjectPointerType *InterfacePointerType
182 = ResultType->getAsObjCInterfacePointerType();
183 ObjCInterfaceDecl *Class
184 = InterfacePointerType->getObjectType()->getInterface();
185 CGObjCRuntime &Runtime = CGM.getObjCRuntime();
John McCall882987f2013-02-28 19:01:20 +0000186 llvm::Value *Receiver = Runtime.GetClass(*this, Class);
Ted Kremeneke65b0862012-03-06 20:05:56 +0000187
188 // Generate the message send.
Eric Christopher5d2b8d92012-03-29 17:31:31 +0000189 RValue result
190 = Runtime.GenerateMessageSend(*this, ReturnValueSlot(),
191 MethodWithObjects->getResultType(),
192 Sel,
193 Receiver, Args, Class,
194 MethodWithObjects);
John McCall770a4c12013-04-04 00:20:38 +0000195
196 // The above message send needs these objects, but in ARC they are
197 // passed in a buffer that is essentially __unsafe_unretained.
198 // Therefore we must prevent the optimizer from releasing them until
199 // after the call.
200 if (TrackNeededObjects) {
201 EmitARCIntrinsicUse(NeededObjects);
202 }
203
Ted Kremeneke65b0862012-03-06 20:05:56 +0000204 return Builder.CreateBitCast(result.getScalarVal(),
205 ConvertType(E->getType()));
206}
207
208llvm::Value *CodeGenFunction::EmitObjCArrayLiteral(const ObjCArrayLiteral *E) {
209 return EmitObjCCollectionLiteral(E, E->getArrayWithObjectsMethod());
210}
211
212llvm::Value *CodeGenFunction::EmitObjCDictionaryLiteral(
213 const ObjCDictionaryLiteral *E) {
214 return EmitObjCCollectionLiteral(E, E->getDictWithObjectsMethod());
215}
216
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000217/// Emit a selector.
218llvm::Value *CodeGenFunction::EmitObjCSelectorExpr(const ObjCSelectorExpr *E) {
219 // Untyped selector.
220 // Note that this implementation allows for non-constant strings to be passed
221 // as arguments to @selector(). Currently, the only thing preventing this
222 // behaviour is the type checking in the front end.
John McCall882987f2013-02-28 19:01:20 +0000223 return CGM.getObjCRuntime().GetSelector(*this, E->getSelector());
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000224}
225
Daniel Dunbar66912a12008-08-20 00:28:19 +0000226llvm::Value *CodeGenFunction::EmitObjCProtocolExpr(const ObjCProtocolExpr *E) {
227 // FIXME: This should pass the Decl not the name.
John McCall882987f2013-02-28 19:01:20 +0000228 return CGM.getObjCRuntime().GenerateProtocolRef(*this, E->getProtocol());
Daniel Dunbar66912a12008-08-20 00:28:19 +0000229}
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000230
Douglas Gregor33823722011-06-11 01:09:30 +0000231/// \brief Adjust the type of the result of an Objective-C message send
232/// expression when the method has a related result type.
233static RValue AdjustRelatedResultType(CodeGenFunction &CGF,
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +0000234 QualType ExpT,
Douglas Gregor33823722011-06-11 01:09:30 +0000235 const ObjCMethodDecl *Method,
236 RValue Result) {
237 if (!Method)
238 return Result;
John McCall31168b02011-06-15 23:02:42 +0000239
Douglas Gregor33823722011-06-11 01:09:30 +0000240 if (!Method->hasRelatedResultType() ||
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +0000241 CGF.getContext().hasSameType(ExpT, Method->getResultType()) ||
Douglas Gregor33823722011-06-11 01:09:30 +0000242 !Result.isScalar())
243 return Result;
244
245 // We have applied a related result type. Cast the rvalue appropriately.
246 return RValue::get(CGF.Builder.CreateBitCast(Result.getScalarVal(),
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +0000247 CGF.ConvertType(ExpT)));
Douglas Gregor33823722011-06-11 01:09:30 +0000248}
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000249
John McCallcf166702011-07-22 08:53:00 +0000250/// Decide whether to extend the lifetime of the receiver of a
251/// returns-inner-pointer message.
252static bool
253shouldExtendReceiverForInnerPointerMessage(const ObjCMessageExpr *message) {
254 switch (message->getReceiverKind()) {
255
256 // For a normal instance message, we should extend unless the
257 // receiver is loaded from a variable with precise lifetime.
258 case ObjCMessageExpr::Instance: {
259 const Expr *receiver = message->getInstanceReceiver();
260 const ImplicitCastExpr *ice = dyn_cast<ImplicitCastExpr>(receiver);
261 if (!ice || ice->getCastKind() != CK_LValueToRValue) return true;
262 receiver = ice->getSubExpr()->IgnoreParens();
263
264 // Only __strong variables.
265 if (receiver->getType().getObjCLifetime() != Qualifiers::OCL_Strong)
266 return true;
267
268 // All ivars and fields have precise lifetime.
269 if (isa<MemberExpr>(receiver) || isa<ObjCIvarRefExpr>(receiver))
270 return false;
271
272 // Otherwise, check for variables.
273 const DeclRefExpr *declRef = dyn_cast<DeclRefExpr>(ice->getSubExpr());
274 if (!declRef) return true;
275 const VarDecl *var = dyn_cast<VarDecl>(declRef->getDecl());
276 if (!var) return true;
277
278 // All variables have precise lifetime except local variables with
279 // automatic storage duration that aren't specially marked.
280 return (var->hasLocalStorage() &&
281 !var->hasAttr<ObjCPreciseLifetimeAttr>());
282 }
283
284 case ObjCMessageExpr::Class:
285 case ObjCMessageExpr::SuperClass:
286 // It's never necessary for class objects.
287 return false;
288
289 case ObjCMessageExpr::SuperInstance:
290 // We generally assume that 'self' lives throughout a method call.
291 return false;
292 }
293
294 llvm_unreachable("invalid receiver kind");
295}
296
John McCall78a15112010-05-22 01:48:05 +0000297RValue CodeGenFunction::EmitObjCMessageExpr(const ObjCMessageExpr *E,
298 ReturnValueSlot Return) {
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000299 // Only the lookup mechanism and first two arguments of the method
300 // implementation vary between runtimes. We can get the receiver and
301 // arguments in generic code.
Mike Stump11289f42009-09-09 15:08:12 +0000302
John McCall31168b02011-06-15 23:02:42 +0000303 bool isDelegateInit = E->isDelegateInitCall();
304
John McCallcf166702011-07-22 08:53:00 +0000305 const ObjCMethodDecl *method = E->getMethodDecl();
Fariborz Jahanian715fdd52012-01-29 20:27:13 +0000306
John McCall31168b02011-06-15 23:02:42 +0000307 // We don't retain the receiver in delegate init calls, and this is
308 // safe because the receiver value is always loaded from 'self',
309 // which we zero out. We don't want to Block_copy block receivers,
310 // though.
311 bool retainSelf =
312 (!isDelegateInit &&
David Blaikiebbafb8a2012-03-11 07:00:24 +0000313 CGM.getLangOpts().ObjCAutoRefCount &&
John McCallcf166702011-07-22 08:53:00 +0000314 method &&
315 method->hasAttr<NSConsumesSelfAttr>());
John McCall31168b02011-06-15 23:02:42 +0000316
Daniel Dunbar8d480592008-08-11 18:12:00 +0000317 CGObjCRuntime &Runtime = CGM.getObjCRuntime();
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000318 bool isSuperMessage = false;
Daniel Dunbarca8531a2008-08-25 08:19:24 +0000319 bool isClassMessage = false;
David Chisnall01aa4672010-04-28 19:33:36 +0000320 ObjCInterfaceDecl *OID = 0;
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000321 // Find the receiver
Douglas Gregor33823722011-06-11 01:09:30 +0000322 QualType ReceiverType;
Daniel Dunbarb2197802010-04-22 03:17:06 +0000323 llvm::Value *Receiver = 0;
Douglas Gregor9a129192010-04-21 00:45:42 +0000324 switch (E->getReceiverKind()) {
325 case ObjCMessageExpr::Instance:
Douglas Gregor33823722011-06-11 01:09:30 +0000326 ReceiverType = E->getInstanceReceiver()->getType();
John McCall31168b02011-06-15 23:02:42 +0000327 if (retainSelf) {
328 TryEmitResult ter = tryEmitARCRetainScalarExpr(*this,
329 E->getInstanceReceiver());
330 Receiver = ter.getPointer();
John McCallcf166702011-07-22 08:53:00 +0000331 if (ter.getInt()) retainSelf = false;
John McCall31168b02011-06-15 23:02:42 +0000332 } else
333 Receiver = EmitScalarExpr(E->getInstanceReceiver());
Douglas Gregor9a129192010-04-21 00:45:42 +0000334 break;
Daniel Dunbar7c6d3a72008-08-16 00:25:02 +0000335
Douglas Gregor9a129192010-04-21 00:45:42 +0000336 case ObjCMessageExpr::Class: {
Douglas Gregor33823722011-06-11 01:09:30 +0000337 ReceiverType = E->getClassReceiver();
338 const ObjCObjectType *ObjTy = ReceiverType->getAs<ObjCObjectType>();
John McCall3e294922010-05-17 20:12:43 +0000339 assert(ObjTy && "Invalid Objective-C class message send");
340 OID = ObjTy->getInterface();
341 assert(OID && "Invalid Objective-C class message send");
John McCall882987f2013-02-28 19:01:20 +0000342 Receiver = Runtime.GetClass(*this, OID);
Daniel Dunbarca8531a2008-08-25 08:19:24 +0000343 isClassMessage = true;
Douglas Gregor9a129192010-04-21 00:45:42 +0000344 break;
345 }
346
347 case ObjCMessageExpr::SuperInstance:
Douglas Gregor33823722011-06-11 01:09:30 +0000348 ReceiverType = E->getSuperType();
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000349 Receiver = LoadObjCSelf();
Douglas Gregor9a129192010-04-21 00:45:42 +0000350 isSuperMessage = true;
351 break;
352
353 case ObjCMessageExpr::SuperClass:
Douglas Gregor33823722011-06-11 01:09:30 +0000354 ReceiverType = E->getSuperType();
Douglas Gregor9a129192010-04-21 00:45:42 +0000355 Receiver = LoadObjCSelf();
356 isSuperMessage = true;
357 isClassMessage = true;
358 break;
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000359 }
360
John McCallcf166702011-07-22 08:53:00 +0000361 if (retainSelf)
362 Receiver = EmitARCRetainNonBlock(Receiver);
363
364 // In ARC, we sometimes want to "extend the lifetime"
365 // (i.e. retain+autorelease) of receivers of returns-inner-pointer
366 // messages.
David Blaikiebbafb8a2012-03-11 07:00:24 +0000367 if (getLangOpts().ObjCAutoRefCount && method &&
John McCallcf166702011-07-22 08:53:00 +0000368 method->hasAttr<ObjCReturnsInnerPointerAttr>() &&
369 shouldExtendReceiverForInnerPointerMessage(E))
370 Receiver = EmitARCRetainAutorelease(ReceiverType, Receiver);
371
John McCall31168b02011-06-15 23:02:42 +0000372 QualType ResultType =
John McCallcf166702011-07-22 08:53:00 +0000373 method ? method->getResultType() : E->getType();
John McCall31168b02011-06-15 23:02:42 +0000374
Daniel Dunbarc722b852008-08-30 03:02:31 +0000375 CallArgList Args;
John McCallcf166702011-07-22 08:53:00 +0000376 EmitCallArgs(Args, method, E->arg_begin(), E->arg_end());
Mike Stump11289f42009-09-09 15:08:12 +0000377
John McCall31168b02011-06-15 23:02:42 +0000378 // For delegate init calls in ARC, do an unsafe store of null into
379 // self. This represents the call taking direct ownership of that
380 // value. We have to do this after emitting the other call
381 // arguments because they might also reference self, but we don't
382 // have to worry about any of them modifying self because that would
383 // be an undefined read and write of an object in unordered
384 // expressions.
385 if (isDelegateInit) {
David Blaikiebbafb8a2012-03-11 07:00:24 +0000386 assert(getLangOpts().ObjCAutoRefCount &&
John McCall31168b02011-06-15 23:02:42 +0000387 "delegate init calls should only be marked in ARC");
388
389 // Do an unsafe store of null into self.
390 llvm::Value *selfAddr =
391 LocalDeclMap[cast<ObjCMethodDecl>(CurCodeDecl)->getSelfDecl()];
392 assert(selfAddr && "no self entry for a delegate init call?");
393
394 Builder.CreateStore(getNullForVariable(selfAddr), selfAddr);
395 }
Anders Carlsson280e61f12010-06-21 20:59:55 +0000396
Douglas Gregor33823722011-06-11 01:09:30 +0000397 RValue result;
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000398 if (isSuperMessage) {
Chris Lattner6cfec782008-06-26 04:42:20 +0000399 // super is only valid in an Objective-C method
400 const ObjCMethodDecl *OMD = cast<ObjCMethodDecl>(CurFuncDecl);
Fariborz Jahanianbac73ac2009-02-28 20:07:56 +0000401 bool isCategoryImpl = isa<ObjCCategoryImplDecl>(OMD->getDeclContext());
Douglas Gregor33823722011-06-11 01:09:30 +0000402 result = Runtime.GenerateMessageSendSuper(*this, Return, ResultType,
403 E->getSelector(),
404 OMD->getClassInterface(),
405 isCategoryImpl,
406 Receiver,
407 isClassMessage,
408 Args,
John McCallcf166702011-07-22 08:53:00 +0000409 method);
Douglas Gregor33823722011-06-11 01:09:30 +0000410 } else {
411 result = Runtime.GenerateMessageSend(*this, Return, ResultType,
412 E->getSelector(),
413 Receiver, Args, OID,
John McCallcf166702011-07-22 08:53:00 +0000414 method);
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000415 }
John McCall31168b02011-06-15 23:02:42 +0000416
417 // For delegate init calls in ARC, implicitly store the result of
418 // the call back into self. This takes ownership of the value.
419 if (isDelegateInit) {
420 llvm::Value *selfAddr =
421 LocalDeclMap[cast<ObjCMethodDecl>(CurCodeDecl)->getSelfDecl()];
422 llvm::Value *newSelf = result.getScalarVal();
423
424 // The delegate return type isn't necessarily a matching type; in
425 // fact, it's quite likely to be 'id'.
Chris Lattner2192fe52011-07-18 04:24:23 +0000426 llvm::Type *selfTy =
John McCall31168b02011-06-15 23:02:42 +0000427 cast<llvm::PointerType>(selfAddr->getType())->getElementType();
428 newSelf = Builder.CreateBitCast(newSelf, selfTy);
429
430 Builder.CreateStore(newSelf, selfAddr);
431 }
Fariborz Jahanian715fdd52012-01-29 20:27:13 +0000432
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +0000433 return AdjustRelatedResultType(*this, E->getType(), method, result);
Anders Carlsson76f4a902007-08-21 17:43:55 +0000434}
435
John McCall31168b02011-06-15 23:02:42 +0000436namespace {
437struct FinishARCDealloc : EHScopeStack::Cleanup {
John McCall30317fd2011-07-12 20:27:29 +0000438 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCall31168b02011-06-15 23:02:42 +0000439 const ObjCMethodDecl *method = cast<ObjCMethodDecl>(CGF.CurCodeDecl);
John McCalldffafde2011-07-13 18:26:47 +0000440
441 const ObjCImplDecl *impl = cast<ObjCImplDecl>(method->getDeclContext());
John McCall31168b02011-06-15 23:02:42 +0000442 const ObjCInterfaceDecl *iface = impl->getClassInterface();
443 if (!iface->getSuperClass()) return;
444
John McCalldffafde2011-07-13 18:26:47 +0000445 bool isCategory = isa<ObjCCategoryImplDecl>(impl);
446
John McCall31168b02011-06-15 23:02:42 +0000447 // Call [super dealloc] if we have a superclass.
448 llvm::Value *self = CGF.LoadObjCSelf();
449
450 CallArgList args;
451 CGF.CGM.getObjCRuntime().GenerateMessageSendSuper(CGF, ReturnValueSlot(),
452 CGF.getContext().VoidTy,
453 method->getSelector(),
454 iface,
John McCalldffafde2011-07-13 18:26:47 +0000455 isCategory,
John McCall31168b02011-06-15 23:02:42 +0000456 self,
457 /*is class msg*/ false,
458 args,
459 method);
460 }
461};
462}
463
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000464/// StartObjCMethod - Begin emission of an ObjCMethod. This generates
465/// the LLVM function and sets the other context used by
466/// CodeGenFunction.
Fariborz Jahanian0196a1c2009-01-10 21:06:09 +0000467void CodeGenFunction::StartObjCMethod(const ObjCMethodDecl *OMD,
Devang Patele7ce5402011-05-19 23:37:41 +0000468 const ObjCContainerDecl *CD,
469 SourceLocation StartLoc) {
John McCalla738c252011-03-09 04:27:21 +0000470 FunctionArgList args;
Devang Patela2c048e2010-04-05 21:09:15 +0000471 // Check if we should generate debug info for this method.
David Blaikie92848de2013-08-26 20:33:21 +0000472 if (OMD->hasAttr<NoDebugAttr>())
473 DebugInfo = NULL; // disable debug info indefinitely for this function
Devang Patela2c048e2010-04-05 21:09:15 +0000474
Fariborz Jahanian0196a1c2009-01-10 21:06:09 +0000475 llvm::Function *Fn = CGM.getObjCRuntime().GenerateMethod(OMD, CD);
Daniel Dunbar449a3392008-09-04 23:41:35 +0000476
John McCalla729c622012-02-17 03:33:10 +0000477 const CGFunctionInfo &FI = CGM.getTypes().arrangeObjCMethodDeclaration(OMD);
Daniel Dunbarc3e7cff2009-04-17 00:48:04 +0000478 CGM.SetInternalFunctionAttributes(OMD, Fn, FI);
Chris Lattner5696e7b2008-06-17 18:05:57 +0000479
John McCalla738c252011-03-09 04:27:21 +0000480 args.push_back(OMD->getSelfDecl());
481 args.push_back(OMD->getCmdDecl());
Chris Lattner5696e7b2008-06-17 18:05:57 +0000482
Argyrios Kyrtzidisb8c3aaf2011-10-03 06:37:04 +0000483 for (ObjCMethodDecl::param_const_iterator PI = OMD->param_begin(),
Eric Christopher5d2b8d92012-03-29 17:31:31 +0000484 E = OMD->param_end(); PI != E; ++PI)
John McCalla738c252011-03-09 04:27:21 +0000485 args.push_back(*PI);
Chris Lattner5696e7b2008-06-17 18:05:57 +0000486
Peter Collingbourne0ff0b372011-01-13 18:57:25 +0000487 CurGD = OMD;
488
Devang Patele7ce5402011-05-19 23:37:41 +0000489 StartFunction(OMD, OMD->getResultType(), Fn, FI, args, StartLoc);
John McCall31168b02011-06-15 23:02:42 +0000490
491 // In ARC, certain methods get an extra cleanup.
David Blaikiebbafb8a2012-03-11 07:00:24 +0000492 if (CGM.getLangOpts().ObjCAutoRefCount &&
John McCall31168b02011-06-15 23:02:42 +0000493 OMD->isInstanceMethod() &&
494 OMD->getSelector().isUnarySelector()) {
495 const IdentifierInfo *ident =
496 OMD->getSelector().getIdentifierInfoForSlot(0);
497 if (ident->isStr("dealloc"))
498 EHStack.pushCleanup<FinishARCDealloc>(getARCCleanupKind());
499 }
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000500}
Daniel Dunbara94ecd22008-08-16 03:19:19 +0000501
John McCall31168b02011-06-15 23:02:42 +0000502static llvm::Value *emitARCRetainLoadOfScalar(CodeGenFunction &CGF,
503 LValue lvalue, QualType type);
504
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000505/// Generate an Objective-C method. An Objective-C method is a C function with
Mike Stump11289f42009-09-09 15:08:12 +0000506/// its pointer, name, and types registered in the class struture.
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000507void CodeGenFunction::GenerateObjCMethod(const ObjCMethodDecl *OMD) {
Devang Patele7ce5402011-05-19 23:37:41 +0000508 StartObjCMethod(OMD, OMD->getClassInterface(), OMD->getLocStart());
Adrian Prantl56741e22014-01-07 22:05:55 +0000509 assert(isa<CompoundStmt>(OMD->getBody()));
510 EmitCompoundStmtWithoutScope(*cast<CompoundStmt>(OMD->getBody()));
Argyrios Kyrtzidisddcd1322009-06-30 02:35:26 +0000511 FinishFunction(OMD->getBodyRBrace());
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000512}
513
John McCallb923ece2011-09-12 23:06:44 +0000514/// emitStructGetterCall - Call the runtime function to load a property
515/// into the return value slot.
516static void emitStructGetterCall(CodeGenFunction &CGF, ObjCIvarDecl *ivar,
517 bool isAtomic, bool hasStrong) {
518 ASTContext &Context = CGF.getContext();
519
520 llvm::Value *src =
521 CGF.EmitLValueForIvar(CGF.TypeOfSelfObject(), CGF.LoadObjCSelf(),
522 ivar, 0).getAddress();
523
524 // objc_copyStruct (ReturnValue, &structIvar,
525 // sizeof (Type of Ivar), isAtomic, false);
526 CallArgList args;
527
528 llvm::Value *dest = CGF.Builder.CreateBitCast(CGF.ReturnValue, CGF.VoidPtrTy);
529 args.add(RValue::get(dest), Context.VoidPtrTy);
530
531 src = CGF.Builder.CreateBitCast(src, CGF.VoidPtrTy);
532 args.add(RValue::get(src), Context.VoidPtrTy);
533
534 CharUnits size = CGF.getContext().getTypeSizeInChars(ivar->getType());
535 args.add(RValue::get(CGF.CGM.getSize(size)), Context.getSizeType());
536 args.add(RValue::get(CGF.Builder.getInt1(isAtomic)), Context.BoolTy);
537 args.add(RValue::get(CGF.Builder.getInt1(hasStrong)), Context.BoolTy);
538
539 llvm::Value *fn = CGF.CGM.getObjCRuntime().GetGetStructFunction();
John McCall8dda7b22012-07-07 06:41:13 +0000540 CGF.EmitCall(CGF.getTypes().arrangeFreeFunctionCall(Context.VoidTy, args,
541 FunctionType::ExtInfo(),
542 RequiredArgs::All),
John McCallb923ece2011-09-12 23:06:44 +0000543 fn, ReturnValueSlot(), args);
544}
545
John McCallf4528ae2011-09-13 03:34:09 +0000546/// Determine whether the given architecture supports unaligned atomic
547/// accesses. They don't have to be fast, just faster than a function
548/// call and a mutex.
549static bool hasUnalignedAtomics(llvm::Triple::ArchType arch) {
Eli Friedman5be3e6a2011-09-13 20:48:30 +0000550 // FIXME: Allow unaligned atomic load/store on x86. (It is not
551 // currently supported by the backend.)
552 return 0;
John McCallf4528ae2011-09-13 03:34:09 +0000553}
554
555/// Return the maximum size that permits atomic accesses for the given
556/// architecture.
557static CharUnits getMaxAtomicAccessSize(CodeGenModule &CGM,
558 llvm::Triple::ArchType arch) {
559 // ARM has 8-byte atomic accesses, but it's not clear whether we
560 // want to rely on them here.
561
562 // In the default case, just assume that any size up to a pointer is
563 // fine given adequate alignment.
564 return CharUnits::fromQuantity(CGM.PointerSizeInBytes);
565}
566
567namespace {
568 class PropertyImplStrategy {
569 public:
570 enum StrategyKind {
571 /// The 'native' strategy is to use the architecture's provided
572 /// reads and writes.
573 Native,
574
575 /// Use objc_setProperty and objc_getProperty.
576 GetSetProperty,
577
578 /// Use objc_setProperty for the setter, but use expression
579 /// evaluation for the getter.
580 SetPropertyAndExpressionGet,
581
582 /// Use objc_copyStruct.
583 CopyStruct,
584
585 /// The 'expression' strategy is to emit normal assignment or
586 /// lvalue-to-rvalue expressions.
587 Expression
588 };
589
590 StrategyKind getKind() const { return StrategyKind(Kind); }
591
592 bool hasStrongMember() const { return HasStrong; }
593 bool isAtomic() const { return IsAtomic; }
594 bool isCopy() const { return IsCopy; }
595
596 CharUnits getIvarSize() const { return IvarSize; }
597 CharUnits getIvarAlignment() const { return IvarAlignment; }
598
599 PropertyImplStrategy(CodeGenModule &CGM,
600 const ObjCPropertyImplDecl *propImpl);
601
602 private:
603 unsigned Kind : 8;
604 unsigned IsAtomic : 1;
605 unsigned IsCopy : 1;
606 unsigned HasStrong : 1;
607
608 CharUnits IvarSize;
609 CharUnits IvarAlignment;
610 };
611}
612
Sylvestre Ledru830885c2012-07-23 08:59:39 +0000613/// Pick an implementation strategy for the given property synthesis.
John McCallf4528ae2011-09-13 03:34:09 +0000614PropertyImplStrategy::PropertyImplStrategy(CodeGenModule &CGM,
615 const ObjCPropertyImplDecl *propImpl) {
616 const ObjCPropertyDecl *prop = propImpl->getPropertyDecl();
John McCall43192862011-09-13 18:31:23 +0000617 ObjCPropertyDecl::SetterKind setterKind = prop->getSetterKind();
John McCallf4528ae2011-09-13 03:34:09 +0000618
John McCall43192862011-09-13 18:31:23 +0000619 IsCopy = (setterKind == ObjCPropertyDecl::Copy);
620 IsAtomic = prop->isAtomic();
John McCallf4528ae2011-09-13 03:34:09 +0000621 HasStrong = false; // doesn't matter here.
622
623 // Evaluate the ivar's size and alignment.
624 ObjCIvarDecl *ivar = propImpl->getPropertyIvarDecl();
625 QualType ivarType = ivar->getType();
626 llvm::tie(IvarSize, IvarAlignment)
627 = CGM.getContext().getTypeInfoInChars(ivarType);
628
629 // If we have a copy property, we always have to use getProperty/setProperty.
John McCall43192862011-09-13 18:31:23 +0000630 // TODO: we could actually use setProperty and an expression for non-atomics.
John McCallf4528ae2011-09-13 03:34:09 +0000631 if (IsCopy) {
632 Kind = GetSetProperty;
633 return;
634 }
635
John McCall43192862011-09-13 18:31:23 +0000636 // Handle retain.
637 if (setterKind == ObjCPropertyDecl::Retain) {
John McCallf4528ae2011-09-13 03:34:09 +0000638 // In GC-only, there's nothing special that needs to be done.
David Blaikiebbafb8a2012-03-11 07:00:24 +0000639 if (CGM.getLangOpts().getGC() == LangOptions::GCOnly) {
John McCallf4528ae2011-09-13 03:34:09 +0000640 // fallthrough
641
642 // In ARC, if the property is non-atomic, use expression emission,
643 // which translates to objc_storeStrong. This isn't required, but
644 // it's slightly nicer.
David Blaikiebbafb8a2012-03-11 07:00:24 +0000645 } else if (CGM.getLangOpts().ObjCAutoRefCount && !IsAtomic) {
John McCalld8561f02012-08-20 23:36:59 +0000646 // Using standard expression emission for the setter is only
647 // acceptable if the ivar is __strong, which won't be true if
648 // the property is annotated with __attribute__((NSObject)).
649 // TODO: falling all the way back to objc_setProperty here is
650 // just laziness, though; we could still use objc_storeStrong
651 // if we hacked it right.
652 if (ivarType.getObjCLifetime() == Qualifiers::OCL_Strong)
653 Kind = Expression;
654 else
655 Kind = SetPropertyAndExpressionGet;
John McCallf4528ae2011-09-13 03:34:09 +0000656 return;
657
658 // Otherwise, we need to at least use setProperty. However, if
659 // the property isn't atomic, we can use normal expression
660 // emission for the getter.
661 } else if (!IsAtomic) {
662 Kind = SetPropertyAndExpressionGet;
663 return;
664
665 // Otherwise, we have to use both setProperty and getProperty.
666 } else {
667 Kind = GetSetProperty;
668 return;
669 }
670 }
671
672 // If we're not atomic, just use expression accesses.
673 if (!IsAtomic) {
674 Kind = Expression;
675 return;
676 }
677
John McCall0e5c0862011-09-13 05:36:29 +0000678 // Properties on bitfield ivars need to be emitted using expression
679 // accesses even if they're nominally atomic.
680 if (ivar->isBitField()) {
681 Kind = Expression;
682 return;
683 }
684
John McCallf4528ae2011-09-13 03:34:09 +0000685 // GC-qualified or ARC-qualified ivars need to be emitted as
686 // expressions. This actually works out to being atomic anyway,
687 // except for ARC __strong, but that should trigger the above code.
688 if (ivarType.hasNonTrivialObjCLifetime() ||
David Blaikiebbafb8a2012-03-11 07:00:24 +0000689 (CGM.getLangOpts().getGC() &&
John McCallf4528ae2011-09-13 03:34:09 +0000690 CGM.getContext().getObjCGCAttrKind(ivarType))) {
691 Kind = Expression;
692 return;
693 }
694
695 // Compute whether the ivar has strong members.
David Blaikiebbafb8a2012-03-11 07:00:24 +0000696 if (CGM.getLangOpts().getGC())
John McCallf4528ae2011-09-13 03:34:09 +0000697 if (const RecordType *recordType = ivarType->getAs<RecordType>())
698 HasStrong = recordType->getDecl()->hasObjectMember();
699
700 // We can never access structs with object members with a native
701 // access, because we need to use write barriers. This is what
702 // objc_copyStruct is for.
703 if (HasStrong) {
704 Kind = CopyStruct;
705 return;
706 }
707
708 // Otherwise, this is target-dependent and based on the size and
709 // alignment of the ivar.
John McCall0bef0ba2011-09-13 07:33:34 +0000710
711 // If the size of the ivar is not a power of two, give up. We don't
712 // want to get into the business of doing compare-and-swaps.
713 if (!IvarSize.isPowerOfTwo()) {
714 Kind = CopyStruct;
715 return;
716 }
717
John McCallf4528ae2011-09-13 03:34:09 +0000718 llvm::Triple::ArchType arch =
John McCallc8e01702013-04-16 22:48:15 +0000719 CGM.getTarget().getTriple().getArch();
John McCallf4528ae2011-09-13 03:34:09 +0000720
721 // Most architectures require memory to fit within a single cache
722 // line, so the alignment has to be at least the size of the access.
723 // Otherwise we have to grab a lock.
724 if (IvarAlignment < IvarSize && !hasUnalignedAtomics(arch)) {
725 Kind = CopyStruct;
726 return;
727 }
728
729 // If the ivar's size exceeds the architecture's maximum atomic
730 // access size, we have to use CopyStruct.
731 if (IvarSize > getMaxAtomicAccessSize(CGM, arch)) {
732 Kind = CopyStruct;
733 return;
734 }
735
736 // Otherwise, we can use native loads and stores.
737 Kind = Native;
738}
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000739
James Dennettbe302452012-06-15 22:10:14 +0000740/// \brief Generate an Objective-C property getter function.
741///
742/// The given Decl must be an ObjCImplementationDecl. \@synthesize
Steve Naroff5a7dd782009-01-10 22:55:25 +0000743/// is illegal within a category.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +0000744void CodeGenFunction::GenerateObjCGetter(ObjCImplementationDecl *IMP,
745 const ObjCPropertyImplDecl *PID) {
Fariborz Jahanian4b501a22012-01-07 18:56:22 +0000746 llvm::Constant *AtomicHelperFn =
Fariborz Jahaniana08a7472012-01-10 00:37:01 +0000747 GenerateObjCAtomicGetterCopyHelperFunction(PID);
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000748 const ObjCPropertyDecl *PD = PID->getPropertyDecl();
749 ObjCMethodDecl *OMD = PD->getGetterMethodDecl();
750 assert(OMD && "Invalid call to generate getter (empty method)");
Eric Christopherb7e821a2012-04-03 00:44:15 +0000751 StartObjCMethod(OMD, IMP->getClassInterface(), OMD->getLocStart());
Mike Stump11289f42009-09-09 15:08:12 +0000752
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +0000753 generateObjCGetterBody(IMP, PID, OMD, AtomicHelperFn);
John McCallf4528ae2011-09-13 03:34:09 +0000754
755 FinishFunction();
756}
757
John McCallbdd81852011-09-13 06:00:03 +0000758static bool hasTrivialGetExpr(const ObjCPropertyImplDecl *propImpl) {
759 const Expr *getter = propImpl->getGetterCXXConstructor();
John McCallf4528ae2011-09-13 03:34:09 +0000760 if (!getter) return true;
761
762 // Sema only makes only of these when the ivar has a C++ class type,
763 // so the form is pretty constrained.
764
John McCallbdd81852011-09-13 06:00:03 +0000765 // If the property has a reference type, we might just be binding a
766 // reference, in which case the result will be a gl-value. We should
767 // treat this as a non-trivial operation.
768 if (getter->isGLValue())
769 return false;
770
John McCallf4528ae2011-09-13 03:34:09 +0000771 // If we selected a trivial copy-constructor, we're okay.
772 if (const CXXConstructExpr *construct = dyn_cast<CXXConstructExpr>(getter))
773 return (construct->getConstructor()->isTrivial());
774
775 // The constructor might require cleanups (in which case it's never
776 // trivial).
777 assert(isa<ExprWithCleanups>(getter));
778 return false;
779}
780
Fariborz Jahaniana08a7472012-01-10 00:37:01 +0000781/// emitCPPObjectAtomicGetterCall - Call the runtime function to
782/// copy the ivar into the resturn slot.
783static void emitCPPObjectAtomicGetterCall(CodeGenFunction &CGF,
784 llvm::Value *returnAddr,
785 ObjCIvarDecl *ivar,
786 llvm::Constant *AtomicHelperFn) {
787 // objc_copyCppObjectAtomic (&returnSlot, &CppObjectIvar,
788 // AtomicHelperFn);
789 CallArgList args;
790
791 // The 1st argument is the return Slot.
792 args.add(RValue::get(returnAddr), CGF.getContext().VoidPtrTy);
793
794 // The 2nd argument is the address of the ivar.
795 llvm::Value *ivarAddr =
796 CGF.EmitLValueForIvar(CGF.TypeOfSelfObject(),
797 CGF.LoadObjCSelf(), ivar, 0).getAddress();
798 ivarAddr = CGF.Builder.CreateBitCast(ivarAddr, CGF.Int8PtrTy);
799 args.add(RValue::get(ivarAddr), CGF.getContext().VoidPtrTy);
800
801 // Third argument is the helper function.
802 args.add(RValue::get(AtomicHelperFn), CGF.getContext().VoidPtrTy);
803
804 llvm::Value *copyCppAtomicObjectFn =
David Chisnall0d75e062012-12-17 18:54:24 +0000805 CGF.CGM.getObjCRuntime().GetCppAtomicObjectGetFunction();
John McCall8dda7b22012-07-07 06:41:13 +0000806 CGF.EmitCall(CGF.getTypes().arrangeFreeFunctionCall(CGF.getContext().VoidTy,
807 args,
808 FunctionType::ExtInfo(),
809 RequiredArgs::All),
Fariborz Jahaniana08a7472012-01-10 00:37:01 +0000810 copyCppAtomicObjectFn, ReturnValueSlot(), args);
811}
812
John McCallf4528ae2011-09-13 03:34:09 +0000813void
814CodeGenFunction::generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +0000815 const ObjCPropertyImplDecl *propImpl,
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +0000816 const ObjCMethodDecl *GetterMethodDecl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +0000817 llvm::Constant *AtomicHelperFn) {
John McCallf4528ae2011-09-13 03:34:09 +0000818 // If there's a non-trivial 'get' expression, we just have to emit that.
819 if (!hasTrivialGetExpr(propImpl)) {
Fariborz Jahaniana08a7472012-01-10 00:37:01 +0000820 if (!AtomicHelperFn) {
821 ReturnStmt ret(SourceLocation(), propImpl->getGetterCXXConstructor(),
822 /*nrvo*/ 0);
823 EmitReturnStmt(ret);
824 }
825 else {
826 ObjCIvarDecl *ivar = propImpl->getPropertyIvarDecl();
827 emitCPPObjectAtomicGetterCall(*this, ReturnValue,
828 ivar, AtomicHelperFn);
829 }
John McCallf4528ae2011-09-13 03:34:09 +0000830 return;
831 }
832
833 const ObjCPropertyDecl *prop = propImpl->getPropertyDecl();
834 QualType propType = prop->getType();
835 ObjCMethodDecl *getterMethod = prop->getGetterMethodDecl();
836
837 ObjCIvarDecl *ivar = propImpl->getPropertyIvarDecl();
838
839 // Pick an implementation strategy.
840 PropertyImplStrategy strategy(CGM, propImpl);
841 switch (strategy.getKind()) {
842 case PropertyImplStrategy::Native: {
Eli Friedman0e846022012-10-26 22:38:05 +0000843 // We don't need to do anything for a zero-size struct.
844 if (strategy.getIvarSize().isZero())
845 return;
846
John McCallf4528ae2011-09-13 03:34:09 +0000847 LValue LV = EmitLValueForIvar(TypeOfSelfObject(), LoadObjCSelf(), ivar, 0);
848
849 // Currently, all atomic accesses have to be through integer
850 // types, so there's no point in trying to pick a prettier type.
851 llvm::Type *bitcastType =
852 llvm::Type::getIntNTy(getLLVMContext(),
853 getContext().toBits(strategy.getIvarSize()));
854 bitcastType = bitcastType->getPointerTo(); // addrspace 0 okay
855
856 // Perform an atomic load. This does not impose ordering constraints.
857 llvm::Value *ivarAddr = LV.getAddress();
858 ivarAddr = Builder.CreateBitCast(ivarAddr, bitcastType);
859 llvm::LoadInst *load = Builder.CreateLoad(ivarAddr, "load");
860 load->setAlignment(strategy.getIvarAlignment().getQuantity());
861 load->setAtomic(llvm::Unordered);
862
863 // Store that value into the return address. Doing this with a
864 // bitcast is likely to produce some pretty ugly IR, but it's not
865 // the *most* terrible thing in the world.
866 Builder.CreateStore(load, Builder.CreateBitCast(ReturnValue, bitcastType));
867
868 // Make sure we don't do an autorelease.
869 AutoreleaseResult = false;
870 return;
871 }
872
873 case PropertyImplStrategy::GetSetProperty: {
874 llvm::Value *getPropertyFn =
875 CGM.getObjCRuntime().GetPropertyGetFunction();
876 if (!getPropertyFn) {
877 CGM.ErrorUnsupported(propImpl, "Obj-C getter requiring atomic copy");
Daniel Dunbara08dff12008-09-24 04:04:31 +0000878 return;
879 }
880
881 // Return (ivar-type) objc_getProperty((id) self, _cmd, offset, true).
882 // FIXME: Can't this be simpler? This might even be worse than the
883 // corresponding gcc code.
John McCallf4528ae2011-09-13 03:34:09 +0000884 llvm::Value *cmd =
885 Builder.CreateLoad(LocalDeclMap[getterMethod->getCmdDecl()], "cmd");
886 llvm::Value *self = Builder.CreateBitCast(LoadObjCSelf(), VoidPtrTy);
887 llvm::Value *ivarOffset =
888 EmitIvarOffset(classImpl->getClassInterface(), ivar);
889
890 CallArgList args;
891 args.add(RValue::get(self), getContext().getObjCIdType());
892 args.add(RValue::get(cmd), getContext().getObjCSelType());
893 args.add(RValue::get(ivarOffset), getContext().getPointerDiffType());
John McCall43192862011-09-13 18:31:23 +0000894 args.add(RValue::get(Builder.getInt1(strategy.isAtomic())),
895 getContext().BoolTy);
John McCallf4528ae2011-09-13 03:34:09 +0000896
Daniel Dunbar1ef73732009-02-03 23:43:59 +0000897 // FIXME: We shouldn't need to get the function info here, the
898 // runtime already should have computed it to build the function.
John McCall8dda7b22012-07-07 06:41:13 +0000899 RValue RV = EmitCall(getTypes().arrangeFreeFunctionCall(propType, args,
900 FunctionType::ExtInfo(),
901 RequiredArgs::All),
John McCallf4528ae2011-09-13 03:34:09 +0000902 getPropertyFn, ReturnValueSlot(), args);
903
Daniel Dunbara08dff12008-09-24 04:04:31 +0000904 // We need to fix the type here. Ivars with copy & retain are
905 // always objects so we don't need to worry about complex or
906 // aggregates.
Mike Stump11289f42009-09-09 15:08:12 +0000907 RV = RValue::get(Builder.CreateBitCast(RV.getScalarVal(),
Fariborz Jahanian0ec8fbe2012-04-26 21:33:14 +0000908 getTypes().ConvertType(getterMethod->getResultType())));
John McCallf4528ae2011-09-13 03:34:09 +0000909
910 EmitReturnOfRValue(RV, propType);
John McCall31168b02011-06-15 23:02:42 +0000911
912 // objc_getProperty does an autorelease, so we should suppress ours.
913 AutoreleaseResult = false;
John McCall31168b02011-06-15 23:02:42 +0000914
John McCallf4528ae2011-09-13 03:34:09 +0000915 return;
916 }
917
918 case PropertyImplStrategy::CopyStruct:
919 emitStructGetterCall(*this, ivar, strategy.isAtomic(),
920 strategy.hasStrongMember());
921 return;
922
923 case PropertyImplStrategy::Expression:
924 case PropertyImplStrategy::SetPropertyAndExpressionGet: {
925 LValue LV = EmitLValueForIvar(TypeOfSelfObject(), LoadObjCSelf(), ivar, 0);
926
927 QualType ivarType = ivar->getType();
John McCall47fb9502013-03-07 21:37:08 +0000928 switch (getEvaluationKind(ivarType)) {
929 case TEK_Complex: {
Nick Lewycky2d84e842013-10-02 02:29:49 +0000930 ComplexPairTy pair = EmitLoadOfComplex(LV, SourceLocation());
John McCall47fb9502013-03-07 21:37:08 +0000931 EmitStoreOfComplex(pair,
932 MakeNaturalAlignAddrLValue(ReturnValue, ivarType),
933 /*init*/ true);
934 return;
935 }
936 case TEK_Aggregate:
John McCallf4528ae2011-09-13 03:34:09 +0000937 // The return value slot is guaranteed to not be aliased, but
938 // that's not necessarily the same as "on the stack", so
939 // we still potentially need objc_memmove_collectable.
Chad Rosier615ed1a2012-03-29 17:37:10 +0000940 EmitAggregateCopy(ReturnValue, LV.getAddress(), ivarType);
John McCall47fb9502013-03-07 21:37:08 +0000941 return;
942 case TEK_Scalar: {
John McCall24fada12011-07-22 05:23:13 +0000943 llvm::Value *value;
944 if (propType->isReferenceType()) {
945 value = LV.getAddress();
946 } else {
947 // We want to load and autoreleaseReturnValue ARC __weak ivars.
948 if (LV.getQuals().getObjCLifetime() == Qualifiers::OCL_Weak) {
John McCallf4528ae2011-09-13 03:34:09 +0000949 value = emitARCRetainLoadOfScalar(*this, LV, ivarType);
John McCall24fada12011-07-22 05:23:13 +0000950
951 // Otherwise we want to do a simple load, suppressing the
952 // final autorelease.
John McCall31168b02011-06-15 23:02:42 +0000953 } else {
Nick Lewycky2d84e842013-10-02 02:29:49 +0000954 value = EmitLoadOfLValue(LV, SourceLocation()).getScalarVal();
John McCall24fada12011-07-22 05:23:13 +0000955 AutoreleaseResult = false;
Fariborz Jahanianb24b5682011-03-28 23:47:18 +0000956 }
John McCall31168b02011-06-15 23:02:42 +0000957
John McCall24fada12011-07-22 05:23:13 +0000958 value = Builder.CreateBitCast(value, ConvertType(propType));
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +0000959 value = Builder.CreateBitCast(value,
960 ConvertType(GetterMethodDecl->getResultType()));
John McCall24fada12011-07-22 05:23:13 +0000961 }
962
963 EmitReturnOfRValue(RValue::get(value), propType);
John McCall47fb9502013-03-07 21:37:08 +0000964 return;
Fariborz Jahanianeab5ecd2009-03-03 18:49:40 +0000965 }
John McCall47fb9502013-03-07 21:37:08 +0000966 }
967 llvm_unreachable("bad evaluation kind");
Daniel Dunbara08dff12008-09-24 04:04:31 +0000968 }
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000969
John McCallf4528ae2011-09-13 03:34:09 +0000970 }
971 llvm_unreachable("bad @property implementation strategy!");
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000972}
973
John McCallb923ece2011-09-12 23:06:44 +0000974/// emitStructSetterCall - Call the runtime function to store the value
975/// from the first formal parameter into the given ivar.
976static void emitStructSetterCall(CodeGenFunction &CGF, ObjCMethodDecl *OMD,
977 ObjCIvarDecl *ivar) {
Fariborz Jahanian302a3d42011-02-18 19:15:13 +0000978 // objc_copyStruct (&structIvar, &Arg,
979 // sizeof (struct something), true, false);
John McCall6acaef92011-09-10 09:30:49 +0000980 CallArgList args;
981
982 // The first argument is the address of the ivar.
John McCallb923ece2011-09-12 23:06:44 +0000983 llvm::Value *ivarAddr = CGF.EmitLValueForIvar(CGF.TypeOfSelfObject(),
984 CGF.LoadObjCSelf(), ivar, 0)
985 .getAddress();
986 ivarAddr = CGF.Builder.CreateBitCast(ivarAddr, CGF.Int8PtrTy);
987 args.add(RValue::get(ivarAddr), CGF.getContext().VoidPtrTy);
John McCall6acaef92011-09-10 09:30:49 +0000988
989 // The second argument is the address of the parameter variable.
John McCallb923ece2011-09-12 23:06:44 +0000990 ParmVarDecl *argVar = *OMD->param_begin();
John McCall113bee02012-03-10 09:33:50 +0000991 DeclRefExpr argRef(argVar, false, argVar->getType().getNonReferenceType(),
Fariborz Jahanian088f1bc2012-01-05 00:10:16 +0000992 VK_LValue, SourceLocation());
John McCallb923ece2011-09-12 23:06:44 +0000993 llvm::Value *argAddr = CGF.EmitLValue(&argRef).getAddress();
994 argAddr = CGF.Builder.CreateBitCast(argAddr, CGF.Int8PtrTy);
995 args.add(RValue::get(argAddr), CGF.getContext().VoidPtrTy);
John McCall6acaef92011-09-10 09:30:49 +0000996
997 // The third argument is the sizeof the type.
998 llvm::Value *size =
John McCallb923ece2011-09-12 23:06:44 +0000999 CGF.CGM.getSize(CGF.getContext().getTypeSizeInChars(ivar->getType()));
1000 args.add(RValue::get(size), CGF.getContext().getSizeType());
John McCall6acaef92011-09-10 09:30:49 +00001001
John McCallb923ece2011-09-12 23:06:44 +00001002 // The fourth argument is the 'isAtomic' flag.
1003 args.add(RValue::get(CGF.Builder.getTrue()), CGF.getContext().BoolTy);
John McCall6acaef92011-09-10 09:30:49 +00001004
John McCallb923ece2011-09-12 23:06:44 +00001005 // The fifth argument is the 'hasStrong' flag.
1006 // FIXME: should this really always be false?
1007 args.add(RValue::get(CGF.Builder.getFalse()), CGF.getContext().BoolTy);
1008
1009 llvm::Value *copyStructFn = CGF.CGM.getObjCRuntime().GetSetStructFunction();
John McCall8dda7b22012-07-07 06:41:13 +00001010 CGF.EmitCall(CGF.getTypes().arrangeFreeFunctionCall(CGF.getContext().VoidTy,
1011 args,
1012 FunctionType::ExtInfo(),
1013 RequiredArgs::All),
John McCallb923ece2011-09-12 23:06:44 +00001014 copyStructFn, ReturnValueSlot(), args);
Fariborz Jahanian302a3d42011-02-18 19:15:13 +00001015}
1016
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001017/// emitCPPObjectAtomicSetterCall - Call the runtime function to store
1018/// the value from the first formal parameter into the given ivar, using
1019/// the Cpp API for atomic Cpp objects with non-trivial copy assignment.
1020static void emitCPPObjectAtomicSetterCall(CodeGenFunction &CGF,
1021 ObjCMethodDecl *OMD,
1022 ObjCIvarDecl *ivar,
1023 llvm::Constant *AtomicHelperFn) {
1024 // objc_copyCppObjectAtomic (&CppObjectIvar, &Arg,
1025 // AtomicHelperFn);
1026 CallArgList args;
1027
1028 // The first argument is the address of the ivar.
1029 llvm::Value *ivarAddr =
1030 CGF.EmitLValueForIvar(CGF.TypeOfSelfObject(),
1031 CGF.LoadObjCSelf(), ivar, 0).getAddress();
1032 ivarAddr = CGF.Builder.CreateBitCast(ivarAddr, CGF.Int8PtrTy);
1033 args.add(RValue::get(ivarAddr), CGF.getContext().VoidPtrTy);
1034
1035 // The second argument is the address of the parameter variable.
1036 ParmVarDecl *argVar = *OMD->param_begin();
John McCall113bee02012-03-10 09:33:50 +00001037 DeclRefExpr argRef(argVar, false, argVar->getType().getNonReferenceType(),
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001038 VK_LValue, SourceLocation());
1039 llvm::Value *argAddr = CGF.EmitLValue(&argRef).getAddress();
1040 argAddr = CGF.Builder.CreateBitCast(argAddr, CGF.Int8PtrTy);
1041 args.add(RValue::get(argAddr), CGF.getContext().VoidPtrTy);
1042
1043 // Third argument is the helper function.
1044 args.add(RValue::get(AtomicHelperFn), CGF.getContext().VoidPtrTy);
1045
1046 llvm::Value *copyCppAtomicObjectFn =
David Chisnall0d75e062012-12-17 18:54:24 +00001047 CGF.CGM.getObjCRuntime().GetCppAtomicObjectSetFunction();
John McCall8dda7b22012-07-07 06:41:13 +00001048 CGF.EmitCall(CGF.getTypes().arrangeFreeFunctionCall(CGF.getContext().VoidTy,
1049 args,
1050 FunctionType::ExtInfo(),
1051 RequiredArgs::All),
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001052 copyCppAtomicObjectFn, ReturnValueSlot(), args);
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001053}
1054
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00001055
John McCallf4528ae2011-09-13 03:34:09 +00001056static bool hasTrivialSetExpr(const ObjCPropertyImplDecl *PID) {
1057 Expr *setter = PID->getSetterCXXAssignment();
1058 if (!setter) return true;
1059
1060 // Sema only makes only of these when the ivar has a C++ class type,
1061 // so the form is pretty constrained.
John McCall7f16c422011-09-10 09:17:20 +00001062
1063 // An operator call is trivial if the function it calls is trivial.
John McCallf4528ae2011-09-13 03:34:09 +00001064 // This also implies that there's nothing non-trivial going on with
1065 // the arguments, because operator= can only be trivial if it's a
1066 // synthesized assignment operator and therefore both parameters are
1067 // references.
1068 if (CallExpr *call = dyn_cast<CallExpr>(setter)) {
John McCall7f16c422011-09-10 09:17:20 +00001069 if (const FunctionDecl *callee
1070 = dyn_cast_or_null<FunctionDecl>(call->getCalleeDecl()))
1071 if (callee->isTrivial())
1072 return true;
1073 return false;
Fariborz Jahanian5de53132011-04-06 16:05:26 +00001074 }
John McCall7f16c422011-09-10 09:17:20 +00001075
John McCallf4528ae2011-09-13 03:34:09 +00001076 assert(isa<ExprWithCleanups>(setter));
John McCall7f16c422011-09-10 09:17:20 +00001077 return false;
1078}
1079
Benjamin Kramer53ba6362012-03-10 20:38:56 +00001080static bool UseOptimizedSetter(CodeGenModule &CGM) {
David Blaikiebbafb8a2012-03-11 07:00:24 +00001081 if (CGM.getLangOpts().getGC() != LangOptions::NonGC)
Ted Kremeneke65b0862012-03-06 20:05:56 +00001082 return false;
Daniel Dunbarbd847cc2012-10-15 22:23:53 +00001083 return CGM.getLangOpts().ObjCRuntime.hasOptimizedSetter();
Ted Kremeneke65b0862012-03-06 20:05:56 +00001084}
1085
John McCall7f16c422011-09-10 09:17:20 +00001086void
1087CodeGenFunction::generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001088 const ObjCPropertyImplDecl *propImpl,
1089 llvm::Constant *AtomicHelperFn) {
John McCall7f16c422011-09-10 09:17:20 +00001090 const ObjCPropertyDecl *prop = propImpl->getPropertyDecl();
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00001091 ObjCIvarDecl *ivar = propImpl->getPropertyIvarDecl();
John McCall7f16c422011-09-10 09:17:20 +00001092 ObjCMethodDecl *setterMethod = prop->getSetterMethodDecl();
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001093
1094 // Just use the setter expression if Sema gave us one and it's
1095 // non-trivial.
1096 if (!hasTrivialSetExpr(propImpl)) {
1097 if (!AtomicHelperFn)
1098 // If non-atomic, assignment is called directly.
1099 EmitStmt(propImpl->getSetterCXXAssignment());
1100 else
1101 // If atomic, assignment is called via a locking api.
1102 emitCPPObjectAtomicSetterCall(*this, setterMethod, ivar,
1103 AtomicHelperFn);
1104 return;
1105 }
John McCall7f16c422011-09-10 09:17:20 +00001106
John McCallf4528ae2011-09-13 03:34:09 +00001107 PropertyImplStrategy strategy(CGM, propImpl);
1108 switch (strategy.getKind()) {
1109 case PropertyImplStrategy::Native: {
Eli Friedman0e846022012-10-26 22:38:05 +00001110 // We don't need to do anything for a zero-size struct.
1111 if (strategy.getIvarSize().isZero())
1112 return;
1113
John McCallf4528ae2011-09-13 03:34:09 +00001114 llvm::Value *argAddr = LocalDeclMap[*setterMethod->param_begin()];
John McCall7f16c422011-09-10 09:17:20 +00001115
John McCallf4528ae2011-09-13 03:34:09 +00001116 LValue ivarLValue =
1117 EmitLValueForIvar(TypeOfSelfObject(), LoadObjCSelf(), ivar, /*quals*/ 0);
1118 llvm::Value *ivarAddr = ivarLValue.getAddress();
John McCall7f16c422011-09-10 09:17:20 +00001119
John McCallf4528ae2011-09-13 03:34:09 +00001120 // Currently, all atomic accesses have to be through integer
1121 // types, so there's no point in trying to pick a prettier type.
1122 llvm::Type *bitcastType =
1123 llvm::Type::getIntNTy(getLLVMContext(),
1124 getContext().toBits(strategy.getIvarSize()));
1125 bitcastType = bitcastType->getPointerTo(); // addrspace 0 okay
1126
1127 // Cast both arguments to the chosen operation type.
1128 argAddr = Builder.CreateBitCast(argAddr, bitcastType);
1129 ivarAddr = Builder.CreateBitCast(ivarAddr, bitcastType);
1130
1131 // This bitcast load is likely to cause some nasty IR.
1132 llvm::Value *load = Builder.CreateLoad(argAddr);
1133
1134 // Perform an atomic store. There are no memory ordering requirements.
1135 llvm::StoreInst *store = Builder.CreateStore(load, ivarAddr);
1136 store->setAlignment(strategy.getIvarAlignment().getQuantity());
1137 store->setAtomic(llvm::Unordered);
1138 return;
1139 }
1140
1141 case PropertyImplStrategy::GetSetProperty:
1142 case PropertyImplStrategy::SetPropertyAndExpressionGet: {
Ted Kremeneke65b0862012-03-06 20:05:56 +00001143
1144 llvm::Value *setOptimizedPropertyFn = 0;
1145 llvm::Value *setPropertyFn = 0;
1146 if (UseOptimizedSetter(CGM)) {
Daniel Dunbarbd847cc2012-10-15 22:23:53 +00001147 // 10.8 and iOS 6.0 code and GC is off
Ted Kremeneke65b0862012-03-06 20:05:56 +00001148 setOptimizedPropertyFn =
Eric Christopher5d2b8d92012-03-29 17:31:31 +00001149 CGM.getObjCRuntime()
1150 .GetOptimizedPropertySetFunction(strategy.isAtomic(),
1151 strategy.isCopy());
Ted Kremeneke65b0862012-03-06 20:05:56 +00001152 if (!setOptimizedPropertyFn) {
1153 CGM.ErrorUnsupported(propImpl, "Obj-C optimized setter - NYI");
1154 return;
1155 }
John McCall7f16c422011-09-10 09:17:20 +00001156 }
Ted Kremeneke65b0862012-03-06 20:05:56 +00001157 else {
1158 setPropertyFn = CGM.getObjCRuntime().GetPropertySetFunction();
1159 if (!setPropertyFn) {
1160 CGM.ErrorUnsupported(propImpl, "Obj-C setter requiring atomic copy");
1161 return;
1162 }
1163 }
1164
John McCall7f16c422011-09-10 09:17:20 +00001165 // Emit objc_setProperty((id) self, _cmd, offset, arg,
1166 // <is-atomic>, <is-copy>).
1167 llvm::Value *cmd =
1168 Builder.CreateLoad(LocalDeclMap[setterMethod->getCmdDecl()]);
1169 llvm::Value *self =
1170 Builder.CreateBitCast(LoadObjCSelf(), VoidPtrTy);
1171 llvm::Value *ivarOffset =
1172 EmitIvarOffset(classImpl->getClassInterface(), ivar);
1173 llvm::Value *arg = LocalDeclMap[*setterMethod->param_begin()];
1174 arg = Builder.CreateBitCast(Builder.CreateLoad(arg, "arg"), VoidPtrTy);
1175
1176 CallArgList args;
1177 args.add(RValue::get(self), getContext().getObjCIdType());
1178 args.add(RValue::get(cmd), getContext().getObjCSelType());
Ted Kremeneke65b0862012-03-06 20:05:56 +00001179 if (setOptimizedPropertyFn) {
1180 args.add(RValue::get(arg), getContext().getObjCIdType());
1181 args.add(RValue::get(ivarOffset), getContext().getPointerDiffType());
John McCall8dda7b22012-07-07 06:41:13 +00001182 EmitCall(getTypes().arrangeFreeFunctionCall(getContext().VoidTy, args,
1183 FunctionType::ExtInfo(),
1184 RequiredArgs::All),
Ted Kremeneke65b0862012-03-06 20:05:56 +00001185 setOptimizedPropertyFn, ReturnValueSlot(), args);
1186 } else {
1187 args.add(RValue::get(ivarOffset), getContext().getPointerDiffType());
1188 args.add(RValue::get(arg), getContext().getObjCIdType());
1189 args.add(RValue::get(Builder.getInt1(strategy.isAtomic())),
1190 getContext().BoolTy);
1191 args.add(RValue::get(Builder.getInt1(strategy.isCopy())),
1192 getContext().BoolTy);
1193 // FIXME: We shouldn't need to get the function info here, the runtime
1194 // already should have computed it to build the function.
John McCall8dda7b22012-07-07 06:41:13 +00001195 EmitCall(getTypes().arrangeFreeFunctionCall(getContext().VoidTy, args,
1196 FunctionType::ExtInfo(),
1197 RequiredArgs::All),
Ted Kremeneke65b0862012-03-06 20:05:56 +00001198 setPropertyFn, ReturnValueSlot(), args);
1199 }
1200
John McCall7f16c422011-09-10 09:17:20 +00001201 return;
1202 }
1203
John McCallf4528ae2011-09-13 03:34:09 +00001204 case PropertyImplStrategy::CopyStruct:
John McCallb923ece2011-09-12 23:06:44 +00001205 emitStructSetterCall(*this, setterMethod, ivar);
John McCall7f16c422011-09-10 09:17:20 +00001206 return;
John McCallf4528ae2011-09-13 03:34:09 +00001207
1208 case PropertyImplStrategy::Expression:
1209 break;
John McCall7f16c422011-09-10 09:17:20 +00001210 }
1211
1212 // Otherwise, fake up some ASTs and emit a normal assignment.
1213 ValueDecl *selfDecl = setterMethod->getSelfDecl();
John McCall113bee02012-03-10 09:33:50 +00001214 DeclRefExpr self(selfDecl, false, selfDecl->getType(),
1215 VK_LValue, SourceLocation());
John McCall7f16c422011-09-10 09:17:20 +00001216 ImplicitCastExpr selfLoad(ImplicitCastExpr::OnStack,
1217 selfDecl->getType(), CK_LValueToRValue, &self,
1218 VK_RValue);
1219 ObjCIvarRefExpr ivarRef(ivar, ivar->getType().getNonReferenceType(),
Fariborz Jahanianf12ff4df2013-04-02 18:57:54 +00001220 SourceLocation(), SourceLocation(),
1221 &selfLoad, true, true);
John McCall7f16c422011-09-10 09:17:20 +00001222
1223 ParmVarDecl *argDecl = *setterMethod->param_begin();
1224 QualType argType = argDecl->getType().getNonReferenceType();
John McCall113bee02012-03-10 09:33:50 +00001225 DeclRefExpr arg(argDecl, false, argType, VK_LValue, SourceLocation());
John McCall7f16c422011-09-10 09:17:20 +00001226 ImplicitCastExpr argLoad(ImplicitCastExpr::OnStack,
1227 argType.getUnqualifiedType(), CK_LValueToRValue,
1228 &arg, VK_RValue);
1229
1230 // The property type can differ from the ivar type in some situations with
1231 // Objective-C pointer types, we can always bit cast the RHS in these cases.
1232 // The following absurdity is just to ensure well-formed IR.
1233 CastKind argCK = CK_NoOp;
1234 if (ivarRef.getType()->isObjCObjectPointerType()) {
1235 if (argLoad.getType()->isObjCObjectPointerType())
1236 argCK = CK_BitCast;
1237 else if (argLoad.getType()->isBlockPointerType())
1238 argCK = CK_BlockPointerToObjCPointerCast;
1239 else
1240 argCK = CK_CPointerToObjCPointerCast;
1241 } else if (ivarRef.getType()->isBlockPointerType()) {
1242 if (argLoad.getType()->isBlockPointerType())
1243 argCK = CK_BitCast;
1244 else
1245 argCK = CK_AnyPointerToBlockPointerCast;
1246 } else if (ivarRef.getType()->isPointerType()) {
1247 argCK = CK_BitCast;
1248 }
1249 ImplicitCastExpr argCast(ImplicitCastExpr::OnStack,
1250 ivarRef.getType(), argCK, &argLoad,
1251 VK_RValue);
1252 Expr *finalArg = &argLoad;
1253 if (!getContext().hasSameUnqualifiedType(ivarRef.getType(),
1254 argLoad.getType()))
1255 finalArg = &argCast;
1256
1257
1258 BinaryOperator assign(&ivarRef, finalArg, BO_Assign,
1259 ivarRef.getType(), VK_RValue, OK_Ordinary,
Lang Hames5de91cc2012-10-02 04:45:10 +00001260 SourceLocation(), false);
John McCall7f16c422011-09-10 09:17:20 +00001261 EmitStmt(&assign);
Fariborz Jahanian5de53132011-04-06 16:05:26 +00001262}
1263
James Dennettbe302452012-06-15 22:10:14 +00001264/// \brief Generate an Objective-C property setter function.
1265///
1266/// The given Decl must be an ObjCImplementationDecl. \@synthesize
Steve Naroff5a7dd782009-01-10 22:55:25 +00001267/// is illegal within a category.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001268void CodeGenFunction::GenerateObjCSetter(ObjCImplementationDecl *IMP,
1269 const ObjCPropertyImplDecl *PID) {
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001270 llvm::Constant *AtomicHelperFn =
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00001271 GenerateObjCAtomicSetterCopyHelperFunction(PID);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001272 const ObjCPropertyDecl *PD = PID->getPropertyDecl();
1273 ObjCMethodDecl *OMD = PD->getSetterMethodDecl();
1274 assert(OMD && "Invalid call to generate setter (empty method)");
Eric Christopherb7e821a2012-04-03 00:44:15 +00001275 StartObjCMethod(OMD, IMP->getClassInterface(), OMD->getLocStart());
Daniel Dunbar5449ce52008-09-24 06:32:09 +00001276
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001277 generateObjCSetterBody(IMP, PID, AtomicHelperFn);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001278
1279 FinishFunction();
Chris Lattner5696e7b2008-06-17 18:05:57 +00001280}
1281
John McCall6a4fa522011-03-22 07:05:39 +00001282namespace {
John McCall4bd0fb12011-07-12 16:41:08 +00001283 struct DestroyIvar : EHScopeStack::Cleanup {
1284 private:
1285 llvm::Value *addr;
John McCall6a4fa522011-03-22 07:05:39 +00001286 const ObjCIvarDecl *ivar;
Peter Collingbourne1425b452012-01-26 03:33:36 +00001287 CodeGenFunction::Destroyer *destroyer;
John McCall4bd0fb12011-07-12 16:41:08 +00001288 bool useEHCleanupForArray;
1289 public:
1290 DestroyIvar(llvm::Value *addr, const ObjCIvarDecl *ivar,
1291 CodeGenFunction::Destroyer *destroyer,
1292 bool useEHCleanupForArray)
Peter Collingbourne1425b452012-01-26 03:33:36 +00001293 : addr(addr), ivar(ivar), destroyer(destroyer),
John McCall4bd0fb12011-07-12 16:41:08 +00001294 useEHCleanupForArray(useEHCleanupForArray) {}
John McCall6a4fa522011-03-22 07:05:39 +00001295
John McCall30317fd2011-07-12 20:27:29 +00001296 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCall4bd0fb12011-07-12 16:41:08 +00001297 LValue lvalue
1298 = CGF.EmitLValueForIvar(CGF.TypeOfSelfObject(), addr, ivar, /*CVR*/ 0);
1299 CGF.emitDestroy(lvalue.getAddress(), ivar->getType(), destroyer,
John McCall30317fd2011-07-12 20:27:29 +00001300 flags.isForNormalCleanup() && useEHCleanupForArray);
John McCall6a4fa522011-03-22 07:05:39 +00001301 }
1302 };
1303}
1304
John McCall4bd0fb12011-07-12 16:41:08 +00001305/// Like CodeGenFunction::destroyARCStrong, but do it with a call.
1306static void destroyARCStrongWithStore(CodeGenFunction &CGF,
1307 llvm::Value *addr,
1308 QualType type) {
1309 llvm::Value *null = getNullForVariable(addr);
1310 CGF.EmitARCStoreStrongCall(addr, null, /*ignored*/ true);
1311}
John McCall31168b02011-06-15 23:02:42 +00001312
John McCall6a4fa522011-03-22 07:05:39 +00001313static void emitCXXDestructMethod(CodeGenFunction &CGF,
1314 ObjCImplementationDecl *impl) {
1315 CodeGenFunction::RunCleanupsScope scope(CGF);
1316
1317 llvm::Value *self = CGF.LoadObjCSelf();
1318
Jordy Rosea91768e2011-07-22 02:08:32 +00001319 const ObjCInterfaceDecl *iface = impl->getClassInterface();
1320 for (const ObjCIvarDecl *ivar = iface->all_declared_ivar_begin();
John McCall6a4fa522011-03-22 07:05:39 +00001321 ivar; ivar = ivar->getNextIvar()) {
1322 QualType type = ivar->getType();
1323
John McCall6a4fa522011-03-22 07:05:39 +00001324 // Check whether the ivar is a destructible type.
John McCall4bd0fb12011-07-12 16:41:08 +00001325 QualType::DestructionKind dtorKind = type.isDestructedType();
1326 if (!dtorKind) continue;
John McCall6a4fa522011-03-22 07:05:39 +00001327
John McCall4bd0fb12011-07-12 16:41:08 +00001328 CodeGenFunction::Destroyer *destroyer = 0;
John McCall6a4fa522011-03-22 07:05:39 +00001329
John McCall4bd0fb12011-07-12 16:41:08 +00001330 // Use a call to objc_storeStrong to destroy strong ivars, for the
1331 // general benefit of the tools.
1332 if (dtorKind == QualType::DK_objc_strong_lifetime) {
Peter Collingbourne1425b452012-01-26 03:33:36 +00001333 destroyer = destroyARCStrongWithStore;
John McCall31168b02011-06-15 23:02:42 +00001334
John McCall4bd0fb12011-07-12 16:41:08 +00001335 // Otherwise use the default for the destruction kind.
1336 } else {
Peter Collingbourne1425b452012-01-26 03:33:36 +00001337 destroyer = CGF.getDestroyer(dtorKind);
John McCall6a4fa522011-03-22 07:05:39 +00001338 }
John McCall4bd0fb12011-07-12 16:41:08 +00001339
1340 CleanupKind cleanupKind = CGF.getCleanupKind(dtorKind);
1341
1342 CGF.EHStack.pushCleanup<DestroyIvar>(cleanupKind, self, ivar, destroyer,
1343 cleanupKind & EHCleanup);
John McCall6a4fa522011-03-22 07:05:39 +00001344 }
1345
1346 assert(scope.requiresCleanups() && "nothing to do in .cxx_destruct?");
1347}
1348
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001349void CodeGenFunction::GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1350 ObjCMethodDecl *MD,
1351 bool ctor) {
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001352 MD->createImplicitParams(CGM.getContext(), IMP->getClassInterface());
Devang Patele7ce5402011-05-19 23:37:41 +00001353 StartObjCMethod(MD, IMP->getClassInterface(), MD->getLocStart());
John McCall6a4fa522011-03-22 07:05:39 +00001354
1355 // Emit .cxx_construct.
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001356 if (ctor) {
John McCall31168b02011-06-15 23:02:42 +00001357 // Suppress the final autorelease in ARC.
1358 AutoreleaseResult = false;
1359
John McCall6a4fa522011-03-22 07:05:39 +00001360 for (ObjCImplementationDecl::init_const_iterator B = IMP->init_begin(),
1361 E = IMP->init_end(); B != E; ++B) {
1362 CXXCtorInitializer *IvarInit = (*B);
Francois Pichetd583da02010-12-04 09:14:42 +00001363 FieldDecl *Field = IvarInit->getAnyMember();
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001364 ObjCIvarDecl *Ivar = cast<ObjCIvarDecl>(Field);
Fariborz Jahanian499b9022010-04-28 22:30:33 +00001365 LValue LV = EmitLValueForIvar(TypeOfSelfObject(),
1366 LoadObjCSelf(), Ivar, 0);
John McCall8d6fc952011-08-25 20:40:09 +00001367 EmitAggExpr(IvarInit->getInit(),
1368 AggValueSlot::forLValue(LV, AggValueSlot::IsDestructed,
John McCalla5efa732011-08-25 23:04:34 +00001369 AggValueSlot::DoesNotNeedGCBarriers,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001370 AggValueSlot::IsNotAliased));
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001371 }
1372 // constructor returns 'self'.
1373 CodeGenTypes &Types = CGM.getTypes();
1374 QualType IdTy(CGM.getContext().getObjCIdType());
1375 llvm::Value *SelfAsId =
1376 Builder.CreateBitCast(LoadObjCSelf(), Types.ConvertType(IdTy));
1377 EmitReturnOfRValue(RValue::get(SelfAsId), IdTy);
John McCall6a4fa522011-03-22 07:05:39 +00001378
1379 // Emit .cxx_destruct.
Chandler Carruthf3983652010-05-06 00:20:39 +00001380 } else {
John McCall6a4fa522011-03-22 07:05:39 +00001381 emitCXXDestructMethod(*this, IMP);
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001382 }
1383 FinishFunction();
1384}
1385
Fariborz Jahanian08b0f662010-04-13 00:38:05 +00001386bool CodeGenFunction::IndirectObjCSetterArg(const CGFunctionInfo &FI) {
1387 CGFunctionInfo::const_arg_iterator it = FI.arg_begin();
1388 it++; it++;
1389 const ABIArgInfo &AI = it->info;
1390 // FIXME. Is this sufficient check?
1391 return (AI.getKind() == ABIArgInfo::Indirect);
1392}
1393
Fariborz Jahanian7e9d52a2010-04-13 18:32:24 +00001394bool CodeGenFunction::IvarTypeWithAggrGCObjects(QualType Ty) {
David Blaikiebbafb8a2012-03-11 07:00:24 +00001395 if (CGM.getLangOpts().getGC() == LangOptions::NonGC)
Fariborz Jahanian7e9d52a2010-04-13 18:32:24 +00001396 return false;
1397 if (const RecordType *FDTTy = Ty.getTypePtr()->getAs<RecordType>())
1398 return FDTTy->getDecl()->hasObjectMember();
1399 return false;
1400}
1401
Daniel Dunbara08dff12008-09-24 04:04:31 +00001402llvm::Value *CodeGenFunction::LoadObjCSelf() {
John McCalldec348f72013-05-03 07:33:41 +00001403 VarDecl *Self = cast<ObjCMethodDecl>(CurFuncDecl)->getSelfDecl();
1404 DeclRefExpr DRE(Self, /*is enclosing local*/ (CurFuncDecl != CurCodeDecl),
1405 Self->getType(), VK_LValue, SourceLocation());
Nick Lewycky2d84e842013-10-02 02:29:49 +00001406 return EmitLoadOfScalar(EmitDeclRefLValue(&DRE), SourceLocation());
Chris Lattner5696e7b2008-06-17 18:05:57 +00001407}
1408
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00001409QualType CodeGenFunction::TypeOfSelfObject() {
1410 const ObjCMethodDecl *OMD = cast<ObjCMethodDecl>(CurFuncDecl);
1411 ImplicitParamDecl *selfDecl = OMD->getSelfDecl();
Steve Naroff7cae42b2009-07-10 23:34:53 +00001412 const ObjCObjectPointerType *PTy = cast<ObjCObjectPointerType>(
1413 getContext().getCanonicalType(selfDecl->getType()));
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00001414 return PTy->getPointeeType();
1415}
1416
Chris Lattnerd4808922009-03-22 21:03:39 +00001417void CodeGenFunction::EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S){
Mike Stump11289f42009-09-09 15:08:12 +00001418 llvm::Constant *EnumerationMutationFn =
Daniel Dunbara08dff12008-09-24 04:04:31 +00001419 CGM.getObjCRuntime().EnumerationMutationFunction();
Mike Stump11289f42009-09-09 15:08:12 +00001420
Daniel Dunbara08dff12008-09-24 04:04:31 +00001421 if (!EnumerationMutationFn) {
1422 CGM.ErrorUnsupported(&S, "Obj-C fast enumeration for this runtime");
1423 return;
1424 }
1425
Devang Pateld2d66652011-01-19 01:36:36 +00001426 CGDebugInfo *DI = getDebugInfo();
Eric Christopher7cdf9482011-10-13 21:45:18 +00001427 if (DI)
1428 DI->EmitLexicalBlockStart(Builder, S.getSourceRange().getBegin());
Devang Pateld2d66652011-01-19 01:36:36 +00001429
Devang Patel297207f2011-06-13 23:15:32 +00001430 // The local variable comes into scope immediately.
1431 AutoVarEmission variable = AutoVarEmission::invalid();
1432 if (const DeclStmt *SD = dyn_cast<DeclStmt>(S.getElement()))
1433 variable = EmitAutoVarAlloca(*cast<VarDecl>(SD->getSingleDecl()));
1434
John McCall1c926b72011-01-07 01:49:06 +00001435 JumpDest LoopEnd = getJumpDestInCurrentScope("forcoll.end");
Mike Stump11289f42009-09-09 15:08:12 +00001436
Anders Carlsson75658592008-08-31 02:33:12 +00001437 // Fast enumeration state.
Douglas Gregor636e2002011-08-09 17:23:49 +00001438 QualType StateTy = CGM.getObjCFastEnumerationStateType();
Daniel Dunbara7566f12010-02-09 02:48:28 +00001439 llvm::Value *StatePtr = CreateMemTemp(StateTy, "state.ptr");
Anders Carlssonc0964b62010-05-22 17:35:42 +00001440 EmitNullInitialization(StatePtr, StateTy);
Mike Stump11289f42009-09-09 15:08:12 +00001441
Anders Carlsson75658592008-08-31 02:33:12 +00001442 // Number of elements in the items array.
Anders Carlsson3f35a262008-08-31 04:05:03 +00001443 static const unsigned NumItems = 16;
Mike Stump11289f42009-09-09 15:08:12 +00001444
John McCall1c926b72011-01-07 01:49:06 +00001445 // Fetch the countByEnumeratingWithState:objects:count: selector.
Benjamin Kramer9e649c32010-03-30 11:36:44 +00001446 IdentifierInfo *II[] = {
1447 &CGM.getContext().Idents.get("countByEnumeratingWithState"),
1448 &CGM.getContext().Idents.get("objects"),
1449 &CGM.getContext().Idents.get("count")
1450 };
1451 Selector FastEnumSel =
1452 CGM.getContext().Selectors.getSelector(llvm::array_lengthof(II), &II[0]);
Anders Carlsson75658592008-08-31 02:33:12 +00001453
1454 QualType ItemsTy =
1455 getContext().getConstantArrayType(getContext().getObjCIdType(),
Mike Stump11289f42009-09-09 15:08:12 +00001456 llvm::APInt(32, NumItems),
Anders Carlsson75658592008-08-31 02:33:12 +00001457 ArrayType::Normal, 0);
Daniel Dunbara7566f12010-02-09 02:48:28 +00001458 llvm::Value *ItemsPtr = CreateMemTemp(ItemsTy, "items.ptr");
Mike Stump11289f42009-09-09 15:08:12 +00001459
John McCall53848232011-07-27 01:07:15 +00001460 // Emit the collection pointer. In ARC, we do a retain.
1461 llvm::Value *Collection;
David Blaikiebbafb8a2012-03-11 07:00:24 +00001462 if (getLangOpts().ObjCAutoRefCount) {
John McCall53848232011-07-27 01:07:15 +00001463 Collection = EmitARCRetainScalarExpr(S.getCollection());
1464
1465 // Enter a cleanup to do the release.
1466 EmitObjCConsumeObject(S.getCollection()->getType(), Collection);
1467 } else {
1468 Collection = EmitScalarExpr(S.getCollection());
1469 }
Mike Stump11289f42009-09-09 15:08:12 +00001470
John McCall91e82dd2011-08-05 00:14:38 +00001471 // The 'continue' label needs to appear within the cleanup for the
1472 // collection object.
1473 JumpDest AfterBody = getJumpDestInCurrentScope("forcoll.next");
1474
John McCall1c926b72011-01-07 01:49:06 +00001475 // Send it our message:
Anders Carlsson75658592008-08-31 02:33:12 +00001476 CallArgList Args;
John McCall1c926b72011-01-07 01:49:06 +00001477
1478 // The first argument is a temporary of the enumeration-state type.
Eli Friedman43dca6a2011-05-02 17:57:46 +00001479 Args.add(RValue::get(StatePtr), getContext().getPointerType(StateTy));
Mike Stump11289f42009-09-09 15:08:12 +00001480
John McCall1c926b72011-01-07 01:49:06 +00001481 // The second argument is a temporary array with space for NumItems
1482 // pointers. We'll actually be loading elements from the array
1483 // pointer written into the control state; this buffer is so that
1484 // collections that *aren't* backed by arrays can still queue up
1485 // batches of elements.
Eli Friedman43dca6a2011-05-02 17:57:46 +00001486 Args.add(RValue::get(ItemsPtr), getContext().getPointerType(ItemsTy));
Mike Stump11289f42009-09-09 15:08:12 +00001487
John McCall1c926b72011-01-07 01:49:06 +00001488 // The third argument is the capacity of that temporary array.
Chris Lattner2192fe52011-07-18 04:24:23 +00001489 llvm::Type *UnsignedLongLTy = ConvertType(getContext().UnsignedLongTy);
Owen Andersonb7a2fe62009-07-24 23:12:58 +00001490 llvm::Constant *Count = llvm::ConstantInt::get(UnsignedLongLTy, NumItems);
Eli Friedman43dca6a2011-05-02 17:57:46 +00001491 Args.add(RValue::get(Count), getContext().UnsignedLongTy);
Mike Stump11289f42009-09-09 15:08:12 +00001492
John McCall1c926b72011-01-07 01:49:06 +00001493 // Start the enumeration.
Mike Stump11289f42009-09-09 15:08:12 +00001494 RValue CountRV =
John McCall78a15112010-05-22 01:48:05 +00001495 CGM.getObjCRuntime().GenerateMessageSend(*this, ReturnValueSlot(),
Anders Carlsson75658592008-08-31 02:33:12 +00001496 getContext().UnsignedLongTy,
1497 FastEnumSel,
David Chisnall01aa4672010-04-28 19:33:36 +00001498 Collection, Args);
Anders Carlsson75658592008-08-31 02:33:12 +00001499
John McCall1c926b72011-01-07 01:49:06 +00001500 // The initial number of objects that were returned in the buffer.
1501 llvm::Value *initialBufferLimit = CountRV.getScalarVal();
Mike Stump11289f42009-09-09 15:08:12 +00001502
John McCall1c926b72011-01-07 01:49:06 +00001503 llvm::BasicBlock *EmptyBB = createBasicBlock("forcoll.empty");
1504 llvm::BasicBlock *LoopInitBB = createBasicBlock("forcoll.loopinit");
Mike Stump11289f42009-09-09 15:08:12 +00001505
John McCall1c926b72011-01-07 01:49:06 +00001506 llvm::Value *zero = llvm::Constant::getNullValue(UnsignedLongLTy);
Anders Carlsson75658592008-08-31 02:33:12 +00001507
John McCall1c926b72011-01-07 01:49:06 +00001508 // If the limit pointer was zero to begin with, the collection is
1509 // empty; skip all this.
1510 Builder.CreateCondBr(Builder.CreateICmpEQ(initialBufferLimit, zero, "iszero"),
1511 EmptyBB, LoopInitBB);
Anders Carlsson75658592008-08-31 02:33:12 +00001512
John McCall1c926b72011-01-07 01:49:06 +00001513 // Otherwise, initialize the loop.
1514 EmitBlock(LoopInitBB);
Mike Stump11289f42009-09-09 15:08:12 +00001515
John McCall1c926b72011-01-07 01:49:06 +00001516 // Save the initial mutations value. This is the value at an
1517 // address that was written into the state object by
1518 // countByEnumeratingWithState:objects:count:.
Mike Stump11289f42009-09-09 15:08:12 +00001519 llvm::Value *StateMutationsPtrPtr =
Anders Carlsson3f35a262008-08-31 04:05:03 +00001520 Builder.CreateStructGEP(StatePtr, 2, "mutationsptr.ptr");
Mike Stump11289f42009-09-09 15:08:12 +00001521 llvm::Value *StateMutationsPtr = Builder.CreateLoad(StateMutationsPtrPtr,
Anders Carlsson3f35a262008-08-31 04:05:03 +00001522 "mutationsptr");
Mike Stump11289f42009-09-09 15:08:12 +00001523
John McCall1c926b72011-01-07 01:49:06 +00001524 llvm::Value *initialMutations =
1525 Builder.CreateLoad(StateMutationsPtr, "forcoll.initial-mutations");
Mike Stump11289f42009-09-09 15:08:12 +00001526
Justin Bogneref512b92014-01-06 22:27:43 +00001527 RegionCounter Cnt = getPGORegionCounter(&S);
1528
John McCall1c926b72011-01-07 01:49:06 +00001529 // Start looping. This is the point we return to whenever we have a
1530 // fresh, non-empty batch of objects.
1531 llvm::BasicBlock *LoopBodyBB = createBasicBlock("forcoll.loopbody");
1532 EmitBlock(LoopBodyBB);
Justin Bogneref512b92014-01-06 22:27:43 +00001533 Cnt.beginRegion(Builder);
Mike Stump11289f42009-09-09 15:08:12 +00001534
John McCall1c926b72011-01-07 01:49:06 +00001535 // The current index into the buffer.
Jay Foad20c0f022011-03-30 11:28:58 +00001536 llvm::PHINode *index = Builder.CreatePHI(UnsignedLongLTy, 3, "forcoll.index");
John McCall1c926b72011-01-07 01:49:06 +00001537 index->addIncoming(zero, LoopInitBB);
Anders Carlsson75658592008-08-31 02:33:12 +00001538
John McCall1c926b72011-01-07 01:49:06 +00001539 // The current buffer size.
Jay Foad20c0f022011-03-30 11:28:58 +00001540 llvm::PHINode *count = Builder.CreatePHI(UnsignedLongLTy, 3, "forcoll.count");
John McCall1c926b72011-01-07 01:49:06 +00001541 count->addIncoming(initialBufferLimit, LoopInitBB);
Mike Stump11289f42009-09-09 15:08:12 +00001542
John McCall1c926b72011-01-07 01:49:06 +00001543 // Check whether the mutations value has changed from where it was
1544 // at start. StateMutationsPtr should actually be invariant between
1545 // refreshes.
Anders Carlsson3f35a262008-08-31 04:05:03 +00001546 StateMutationsPtr = Builder.CreateLoad(StateMutationsPtrPtr, "mutationsptr");
John McCall1c926b72011-01-07 01:49:06 +00001547 llvm::Value *currentMutations
1548 = Builder.CreateLoad(StateMutationsPtr, "statemutations");
Anders Carlsson3f35a262008-08-31 04:05:03 +00001549
John McCall1c926b72011-01-07 01:49:06 +00001550 llvm::BasicBlock *WasMutatedBB = createBasicBlock("forcoll.mutated");
Dan Gohman6ca99822011-03-02 22:39:34 +00001551 llvm::BasicBlock *WasNotMutatedBB = createBasicBlock("forcoll.notmutated");
Mike Stump11289f42009-09-09 15:08:12 +00001552
John McCall1c926b72011-01-07 01:49:06 +00001553 Builder.CreateCondBr(Builder.CreateICmpEQ(currentMutations, initialMutations),
1554 WasNotMutatedBB, WasMutatedBB);
Mike Stump11289f42009-09-09 15:08:12 +00001555
John McCall1c926b72011-01-07 01:49:06 +00001556 // If so, call the enumeration-mutation function.
1557 EmitBlock(WasMutatedBB);
Anders Carlsson3f35a262008-08-31 04:05:03 +00001558 llvm::Value *V =
Mike Stump11289f42009-09-09 15:08:12 +00001559 Builder.CreateBitCast(Collection,
Benjamin Kramer76399eb2011-09-27 21:06:10 +00001560 ConvertType(getContext().getObjCIdType()));
Daniel Dunbar84388bf2009-02-03 23:55:40 +00001561 CallArgList Args2;
Eli Friedman43dca6a2011-05-02 17:57:46 +00001562 Args2.add(RValue::get(V), getContext().getObjCIdType());
Mike Stump18bb9282009-05-16 07:57:57 +00001563 // FIXME: We shouldn't need to get the function info here, the runtime already
1564 // should have computed it to build the function.
John McCall8dda7b22012-07-07 06:41:13 +00001565 EmitCall(CGM.getTypes().arrangeFreeFunctionCall(getContext().VoidTy, Args2,
1566 FunctionType::ExtInfo(),
1567 RequiredArgs::All),
Anders Carlsson61a401c2009-12-24 19:25:24 +00001568 EnumerationMutationFn, ReturnValueSlot(), Args2);
Mike Stump11289f42009-09-09 15:08:12 +00001569
John McCall1c926b72011-01-07 01:49:06 +00001570 // Otherwise, or if the mutation function returns, just continue.
1571 EmitBlock(WasNotMutatedBB);
Mike Stump11289f42009-09-09 15:08:12 +00001572
John McCall1c926b72011-01-07 01:49:06 +00001573 // Initialize the element variable.
1574 RunCleanupsScope elementVariableScope(*this);
John McCall9e2e22f2011-02-22 07:16:58 +00001575 bool elementIsVariable;
John McCall1c926b72011-01-07 01:49:06 +00001576 LValue elementLValue;
1577 QualType elementType;
1578 if (const DeclStmt *SD = dyn_cast<DeclStmt>(S.getElement())) {
John McCall9e2e22f2011-02-22 07:16:58 +00001579 // Initialize the variable, in case it's a __block variable or something.
1580 EmitAutoVarInit(variable);
John McCall1c926b72011-01-07 01:49:06 +00001581
John McCall9e2e22f2011-02-22 07:16:58 +00001582 const VarDecl* D = cast<VarDecl>(SD->getSingleDecl());
John McCall113bee02012-03-10 09:33:50 +00001583 DeclRefExpr tempDRE(const_cast<VarDecl*>(D), false, D->getType(),
John McCall1c926b72011-01-07 01:49:06 +00001584 VK_LValue, SourceLocation());
1585 elementLValue = EmitLValue(&tempDRE);
1586 elementType = D->getType();
John McCall9e2e22f2011-02-22 07:16:58 +00001587 elementIsVariable = true;
John McCalld4631322011-06-17 06:42:21 +00001588
1589 if (D->isARCPseudoStrong())
1590 elementLValue.getQuals().setObjCLifetime(Qualifiers::OCL_ExplicitNone);
John McCall1c926b72011-01-07 01:49:06 +00001591 } else {
1592 elementLValue = LValue(); // suppress warning
1593 elementType = cast<Expr>(S.getElement())->getType();
John McCall9e2e22f2011-02-22 07:16:58 +00001594 elementIsVariable = false;
John McCall1c926b72011-01-07 01:49:06 +00001595 }
Chris Lattner2192fe52011-07-18 04:24:23 +00001596 llvm::Type *convertedElementType = ConvertType(elementType);
John McCall1c926b72011-01-07 01:49:06 +00001597
1598 // Fetch the buffer out of the enumeration state.
1599 // TODO: this pointer should actually be invariant between
1600 // refreshes, which would help us do certain loop optimizations.
Mike Stump11289f42009-09-09 15:08:12 +00001601 llvm::Value *StateItemsPtr =
Anders Carlsson75658592008-08-31 02:33:12 +00001602 Builder.CreateStructGEP(StatePtr, 1, "stateitems.ptr");
John McCall1c926b72011-01-07 01:49:06 +00001603 llvm::Value *EnumStateItems =
1604 Builder.CreateLoad(StateItemsPtr, "stateitems");
Anders Carlsson75658592008-08-31 02:33:12 +00001605
John McCall1c926b72011-01-07 01:49:06 +00001606 // Fetch the value at the current index from the buffer.
Mike Stump11289f42009-09-09 15:08:12 +00001607 llvm::Value *CurrentItemPtr =
John McCall1c926b72011-01-07 01:49:06 +00001608 Builder.CreateGEP(EnumStateItems, index, "currentitem.ptr");
1609 llvm::Value *CurrentItem = Builder.CreateLoad(CurrentItemPtr);
Mike Stump11289f42009-09-09 15:08:12 +00001610
John McCall1c926b72011-01-07 01:49:06 +00001611 // Cast that value to the right type.
1612 CurrentItem = Builder.CreateBitCast(CurrentItem, convertedElementType,
1613 "currentitem");
Mike Stump11289f42009-09-09 15:08:12 +00001614
John McCall1c926b72011-01-07 01:49:06 +00001615 // Make sure we have an l-value. Yes, this gets evaluated every
1616 // time through the loop.
John McCalld4631322011-06-17 06:42:21 +00001617 if (!elementIsVariable) {
John McCall1c926b72011-01-07 01:49:06 +00001618 elementLValue = EmitLValue(cast<Expr>(S.getElement()));
John McCall55e1fbc2011-06-25 02:11:03 +00001619 EmitStoreThroughLValue(RValue::get(CurrentItem), elementLValue);
John McCalld4631322011-06-17 06:42:21 +00001620 } else {
1621 EmitScalarInit(CurrentItem, elementLValue);
1622 }
Mike Stump11289f42009-09-09 15:08:12 +00001623
John McCall9e2e22f2011-02-22 07:16:58 +00001624 // If we do have an element variable, this assignment is the end of
1625 // its initialization.
1626 if (elementIsVariable)
1627 EmitAutoVarCleanups(variable);
1628
John McCall1c926b72011-01-07 01:49:06 +00001629 // Perform the loop body, setting up break and continue labels.
Justin Bogneref512b92014-01-06 22:27:43 +00001630 BreakContinueStack.push_back(BreakContinue(LoopEnd, AfterBody, &Cnt));
John McCall1c926b72011-01-07 01:49:06 +00001631 {
1632 RunCleanupsScope Scope(*this);
1633 EmitStmt(S.getBody());
1634 }
Anders Carlsson75658592008-08-31 02:33:12 +00001635 BreakContinueStack.pop_back();
Mike Stump11289f42009-09-09 15:08:12 +00001636
John McCall1c926b72011-01-07 01:49:06 +00001637 // Destroy the element variable now.
1638 elementVariableScope.ForceCleanup();
1639
1640 // Check whether there are more elements.
John McCallad5d61e2010-07-23 21:56:41 +00001641 EmitBlock(AfterBody.getBlock());
Mike Stump11289f42009-09-09 15:08:12 +00001642
John McCall1c926b72011-01-07 01:49:06 +00001643 llvm::BasicBlock *FetchMoreBB = createBasicBlock("forcoll.refetch");
Fariborz Jahanian6e7ecc82009-01-06 18:56:31 +00001644
John McCall1c926b72011-01-07 01:49:06 +00001645 // First we check in the local buffer.
1646 llvm::Value *indexPlusOne
1647 = Builder.CreateAdd(index, llvm::ConstantInt::get(UnsignedLongLTy, 1));
Anders Carlsson75658592008-08-31 02:33:12 +00001648
Justin Bogneref512b92014-01-06 22:27:43 +00001649 // TODO: We should probably model this as a "continue" for PGO
John McCall1c926b72011-01-07 01:49:06 +00001650 // If we haven't overrun the buffer yet, we can continue.
1651 Builder.CreateCondBr(Builder.CreateICmpULT(indexPlusOne, count),
1652 LoopBodyBB, FetchMoreBB);
1653
1654 index->addIncoming(indexPlusOne, AfterBody.getBlock());
1655 count->addIncoming(count, AfterBody.getBlock());
1656
1657 // Otherwise, we have to fetch more elements.
1658 EmitBlock(FetchMoreBB);
Mike Stump11289f42009-09-09 15:08:12 +00001659
1660 CountRV =
John McCall78a15112010-05-22 01:48:05 +00001661 CGM.getObjCRuntime().GenerateMessageSend(*this, ReturnValueSlot(),
Anders Carlsson75658592008-08-31 02:33:12 +00001662 getContext().UnsignedLongTy,
Mike Stump11289f42009-09-09 15:08:12 +00001663 FastEnumSel,
David Chisnall01aa4672010-04-28 19:33:36 +00001664 Collection, Args);
Mike Stump11289f42009-09-09 15:08:12 +00001665
John McCall1c926b72011-01-07 01:49:06 +00001666 // If we got a zero count, we're done.
1667 llvm::Value *refetchCount = CountRV.getScalarVal();
1668
1669 // (note that the message send might split FetchMoreBB)
1670 index->addIncoming(zero, Builder.GetInsertBlock());
1671 count->addIncoming(refetchCount, Builder.GetInsertBlock());
1672
Justin Bogneref512b92014-01-06 22:27:43 +00001673 // TODO: We should be applying PGO weights here, but this needs to handle the
1674 // branch before FetchMoreBB or we risk getting the numbers wrong.
John McCall1c926b72011-01-07 01:49:06 +00001675 Builder.CreateCondBr(Builder.CreateICmpEQ(refetchCount, zero),
1676 EmptyBB, LoopBodyBB);
Mike Stump11289f42009-09-09 15:08:12 +00001677
Anders Carlsson75658592008-08-31 02:33:12 +00001678 // No more elements.
John McCall1c926b72011-01-07 01:49:06 +00001679 EmitBlock(EmptyBB);
Anders Carlsson75658592008-08-31 02:33:12 +00001680
John McCall9e2e22f2011-02-22 07:16:58 +00001681 if (!elementIsVariable) {
Anders Carlsson75658592008-08-31 02:33:12 +00001682 // If the element was not a declaration, set it to be null.
1683
John McCall1c926b72011-01-07 01:49:06 +00001684 llvm::Value *null = llvm::Constant::getNullValue(convertedElementType);
1685 elementLValue = EmitLValue(cast<Expr>(S.getElement()));
John McCall55e1fbc2011-06-25 02:11:03 +00001686 EmitStoreThroughLValue(RValue::get(null), elementLValue);
Anders Carlsson75658592008-08-31 02:33:12 +00001687 }
1688
Eric Christopher7cdf9482011-10-13 21:45:18 +00001689 if (DI)
1690 DI->EmitLexicalBlockEnd(Builder, S.getSourceRange().getEnd());
Devang Pateld2d66652011-01-19 01:36:36 +00001691
John McCall53848232011-07-27 01:07:15 +00001692 // Leave the cleanup we entered in ARC.
David Blaikiebbafb8a2012-03-11 07:00:24 +00001693 if (getLangOpts().ObjCAutoRefCount)
John McCall53848232011-07-27 01:07:15 +00001694 PopCleanupBlock();
1695
John McCallad5d61e2010-07-23 21:56:41 +00001696 EmitBlock(LoopEnd.getBlock());
Justin Bogneref512b92014-01-06 22:27:43 +00001697 // TODO: Once we calculate PGO weights above, set the region count here
Anders Carlsson2e744e82008-08-30 19:51:14 +00001698}
1699
Mike Stump11289f42009-09-09 15:08:12 +00001700void CodeGenFunction::EmitObjCAtTryStmt(const ObjCAtTryStmt &S) {
John McCallbd309292010-07-06 01:34:17 +00001701 CGM.getObjCRuntime().EmitTryStmt(*this, S);
Anders Carlsson1963b0c2008-09-09 10:04:29 +00001702}
1703
Mike Stump11289f42009-09-09 15:08:12 +00001704void CodeGenFunction::EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S) {
Anders Carlsson1963b0c2008-09-09 10:04:29 +00001705 CGM.getObjCRuntime().EmitThrowStmt(*this, S);
1706}
1707
Chris Lattnere132e242008-11-15 21:26:17 +00001708void CodeGenFunction::EmitObjCAtSynchronizedStmt(
Mike Stump11289f42009-09-09 15:08:12 +00001709 const ObjCAtSynchronizedStmt &S) {
John McCallbd309292010-07-06 01:34:17 +00001710 CGM.getObjCRuntime().EmitSynchronizedStmt(*this, S);
Chris Lattnere132e242008-11-15 21:26:17 +00001711}
1712
John McCall2d637d22011-09-10 06:18:15 +00001713/// Produce the code for a CK_ARCProduceObject. Just does a
John McCall31168b02011-06-15 23:02:42 +00001714/// primitive retain.
1715llvm::Value *CodeGenFunction::EmitObjCProduceObject(QualType type,
1716 llvm::Value *value) {
1717 return EmitARCRetain(type, value);
1718}
1719
1720namespace {
1721 struct CallObjCRelease : EHScopeStack::Cleanup {
John McCall9c8e1c92011-08-03 22:24:24 +00001722 CallObjCRelease(llvm::Value *object) : object(object) {}
1723 llvm::Value *object;
John McCall31168b02011-06-15 23:02:42 +00001724
John McCall30317fd2011-07-12 20:27:29 +00001725 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCallcdda29c2013-03-13 03:10:54 +00001726 // Releases at the end of the full-expression are imprecise.
1727 CGF.EmitARCRelease(object, ARCImpreciseLifetime);
John McCall31168b02011-06-15 23:02:42 +00001728 }
1729 };
1730}
1731
John McCall2d637d22011-09-10 06:18:15 +00001732/// Produce the code for a CK_ARCConsumeObject. Does a primitive
John McCall31168b02011-06-15 23:02:42 +00001733/// release at the end of the full-expression.
1734llvm::Value *CodeGenFunction::EmitObjCConsumeObject(QualType type,
1735 llvm::Value *object) {
1736 // If we're in a conditional branch, we need to make the cleanup
John McCall9c8e1c92011-08-03 22:24:24 +00001737 // conditional.
1738 pushFullExprCleanup<CallObjCRelease>(getARCCleanupKind(), object);
John McCall31168b02011-06-15 23:02:42 +00001739 return object;
1740}
1741
1742llvm::Value *CodeGenFunction::EmitObjCExtendObjectLifetime(QualType type,
1743 llvm::Value *value) {
1744 return EmitARCRetainAutorelease(type, value);
1745}
1746
John McCalleff18842013-03-23 02:35:54 +00001747/// Given a number of pointers, inform the optimizer that they're
1748/// being intrinsically used up until this point in the program.
1749void CodeGenFunction::EmitARCIntrinsicUse(ArrayRef<llvm::Value*> values) {
1750 llvm::Constant *&fn = CGM.getARCEntrypoints().clang_arc_use;
1751 if (!fn) {
1752 llvm::FunctionType *fnType =
1753 llvm::FunctionType::get(CGM.VoidTy, ArrayRef<llvm::Type*>(), true);
1754 fn = CGM.CreateRuntimeFunction(fnType, "clang.arc.use");
1755 }
1756
1757 // This isn't really a "runtime" function, but as an intrinsic it
1758 // doesn't really matter as long as we align things up.
1759 EmitNounwindRuntimeCall(fn, values);
1760}
1761
John McCall31168b02011-06-15 23:02:42 +00001762
1763static llvm::Constant *createARCRuntimeFunction(CodeGenModule &CGM,
Chris Lattner2192fe52011-07-18 04:24:23 +00001764 llvm::FunctionType *type,
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001765 StringRef fnName) {
John McCall31168b02011-06-15 23:02:42 +00001766 llvm::Constant *fn = CGM.CreateRuntimeFunction(type, fnName);
1767
Michael Gottesmancf50e6d2013-02-02 00:57:44 +00001768 if (llvm::Function *f = dyn_cast<llvm::Function>(fn)) {
Michael Gottesmanbe9614c2013-02-02 01:05:06 +00001769 // If the target runtime doesn't naturally support ARC, emit weak
1770 // references to the runtime support library. We don't really
1771 // permit this to fail, but we need a particular relocation style.
Michael Gottesmancf50e6d2013-02-02 00:57:44 +00001772 if (!CGM.getLangOpts().ObjCRuntime.hasNativeARC()) {
John McCall31168b02011-06-15 23:02:42 +00001773 f->setLinkage(llvm::Function::ExternalWeakLinkage);
Michael Gottesmancf50e6d2013-02-02 00:57:44 +00001774 } else if (fnName == "objc_retain" || fnName == "objc_release") {
1775 // If we have Native ARC, set nonlazybind attribute for these APIs for
1776 // performance.
Bill Wendling207f0532012-12-20 19:27:06 +00001777 f->addFnAttr(llvm::Attribute::NonLazyBind);
Michael Gottesmanb46072d2013-02-02 01:03:01 +00001778 }
Michael Gottesmancf50e6d2013-02-02 00:57:44 +00001779 }
John McCall31168b02011-06-15 23:02:42 +00001780
1781 return fn;
1782}
1783
1784/// Perform an operation having the signature
1785/// i8* (i8*)
1786/// where a null input causes a no-op and returns null.
1787static llvm::Value *emitARCValueOperation(CodeGenFunction &CGF,
1788 llvm::Value *value,
1789 llvm::Constant *&fn,
Chad Rosier13799b32012-12-12 17:52:21 +00001790 StringRef fnName,
1791 bool isTailCall = false) {
John McCall31168b02011-06-15 23:02:42 +00001792 if (isa<llvm::ConstantPointerNull>(value)) return value;
1793
1794 if (!fn) {
Chris Lattner2192fe52011-07-18 04:24:23 +00001795 llvm::FunctionType *fnType =
Benjamin Kramer95e19362013-03-07 21:18:31 +00001796 llvm::FunctionType::get(CGF.Int8PtrTy, CGF.Int8PtrTy, false);
John McCall31168b02011-06-15 23:02:42 +00001797 fn = createARCRuntimeFunction(CGF.CGM, fnType, fnName);
1798 }
1799
1800 // Cast the argument to 'id'.
Chris Lattner2192fe52011-07-18 04:24:23 +00001801 llvm::Type *origType = value->getType();
John McCall31168b02011-06-15 23:02:42 +00001802 value = CGF.Builder.CreateBitCast(value, CGF.Int8PtrTy);
1803
1804 // Call the function.
John McCall882987f2013-02-28 19:01:20 +00001805 llvm::CallInst *call = CGF.EmitNounwindRuntimeCall(fn, value);
Chad Rosier13799b32012-12-12 17:52:21 +00001806 if (isTailCall)
1807 call->setTailCall();
John McCall31168b02011-06-15 23:02:42 +00001808
1809 // Cast the result back to the original type.
1810 return CGF.Builder.CreateBitCast(call, origType);
1811}
1812
1813/// Perform an operation having the following signature:
1814/// i8* (i8**)
1815static llvm::Value *emitARCLoadOperation(CodeGenFunction &CGF,
1816 llvm::Value *addr,
1817 llvm::Constant *&fn,
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001818 StringRef fnName) {
John McCall31168b02011-06-15 23:02:42 +00001819 if (!fn) {
Chris Lattner2192fe52011-07-18 04:24:23 +00001820 llvm::FunctionType *fnType =
Benjamin Kramer95e19362013-03-07 21:18:31 +00001821 llvm::FunctionType::get(CGF.Int8PtrTy, CGF.Int8PtrPtrTy, false);
John McCall31168b02011-06-15 23:02:42 +00001822 fn = createARCRuntimeFunction(CGF.CGM, fnType, fnName);
1823 }
1824
1825 // Cast the argument to 'id*'.
Chris Lattner2192fe52011-07-18 04:24:23 +00001826 llvm::Type *origType = addr->getType();
John McCall31168b02011-06-15 23:02:42 +00001827 addr = CGF.Builder.CreateBitCast(addr, CGF.Int8PtrPtrTy);
1828
1829 // Call the function.
John McCall882987f2013-02-28 19:01:20 +00001830 llvm::Value *result = CGF.EmitNounwindRuntimeCall(fn, addr);
John McCall31168b02011-06-15 23:02:42 +00001831
1832 // Cast the result back to a dereference of the original type.
John McCall31168b02011-06-15 23:02:42 +00001833 if (origType != CGF.Int8PtrPtrTy)
1834 result = CGF.Builder.CreateBitCast(result,
1835 cast<llvm::PointerType>(origType)->getElementType());
1836
1837 return result;
1838}
1839
1840/// Perform an operation having the following signature:
1841/// i8* (i8**, i8*)
1842static llvm::Value *emitARCStoreOperation(CodeGenFunction &CGF,
1843 llvm::Value *addr,
1844 llvm::Value *value,
1845 llvm::Constant *&fn,
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001846 StringRef fnName,
John McCall31168b02011-06-15 23:02:42 +00001847 bool ignored) {
1848 assert(cast<llvm::PointerType>(addr->getType())->getElementType()
1849 == value->getType());
1850
1851 if (!fn) {
Benjamin Kramer22d24c22011-10-15 12:20:02 +00001852 llvm::Type *argTypes[] = { CGF.Int8PtrPtrTy, CGF.Int8PtrTy };
John McCall31168b02011-06-15 23:02:42 +00001853
Chris Lattner2192fe52011-07-18 04:24:23 +00001854 llvm::FunctionType *fnType
John McCall31168b02011-06-15 23:02:42 +00001855 = llvm::FunctionType::get(CGF.Int8PtrTy, argTypes, false);
1856 fn = createARCRuntimeFunction(CGF.CGM, fnType, fnName);
1857 }
1858
Chris Lattner2192fe52011-07-18 04:24:23 +00001859 llvm::Type *origType = value->getType();
John McCall31168b02011-06-15 23:02:42 +00001860
John McCall882987f2013-02-28 19:01:20 +00001861 llvm::Value *args[] = {
1862 CGF.Builder.CreateBitCast(addr, CGF.Int8PtrPtrTy),
1863 CGF.Builder.CreateBitCast(value, CGF.Int8PtrTy)
1864 };
1865 llvm::CallInst *result = CGF.EmitNounwindRuntimeCall(fn, args);
John McCall31168b02011-06-15 23:02:42 +00001866
1867 if (ignored) return 0;
1868
1869 return CGF.Builder.CreateBitCast(result, origType);
1870}
1871
1872/// Perform an operation having the following signature:
1873/// void (i8**, i8**)
1874static void emitARCCopyOperation(CodeGenFunction &CGF,
1875 llvm::Value *dst,
1876 llvm::Value *src,
1877 llvm::Constant *&fn,
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001878 StringRef fnName) {
John McCall31168b02011-06-15 23:02:42 +00001879 assert(dst->getType() == src->getType());
1880
1881 if (!fn) {
Benjamin Kramer95e19362013-03-07 21:18:31 +00001882 llvm::Type *argTypes[] = { CGF.Int8PtrPtrTy, CGF.Int8PtrPtrTy };
1883
Chris Lattner2192fe52011-07-18 04:24:23 +00001884 llvm::FunctionType *fnType
John McCall31168b02011-06-15 23:02:42 +00001885 = llvm::FunctionType::get(CGF.Builder.getVoidTy(), argTypes, false);
1886 fn = createARCRuntimeFunction(CGF.CGM, fnType, fnName);
1887 }
1888
John McCall882987f2013-02-28 19:01:20 +00001889 llvm::Value *args[] = {
1890 CGF.Builder.CreateBitCast(dst, CGF.Int8PtrPtrTy),
1891 CGF.Builder.CreateBitCast(src, CGF.Int8PtrPtrTy)
1892 };
1893 CGF.EmitNounwindRuntimeCall(fn, args);
John McCall31168b02011-06-15 23:02:42 +00001894}
1895
1896/// Produce the code to do a retain. Based on the type, calls one of:
James Dennett14c41ea2012-06-22 05:41:30 +00001897/// call i8* \@objc_retain(i8* %value)
1898/// call i8* \@objc_retainBlock(i8* %value)
John McCall31168b02011-06-15 23:02:42 +00001899llvm::Value *CodeGenFunction::EmitARCRetain(QualType type, llvm::Value *value) {
1900 if (type->isBlockPointerType())
John McCallff613032011-10-04 06:23:45 +00001901 return EmitARCRetainBlock(value, /*mandatory*/ false);
John McCall31168b02011-06-15 23:02:42 +00001902 else
1903 return EmitARCRetainNonBlock(value);
1904}
1905
1906/// Retain the given object, with normal retain semantics.
James Dennett14c41ea2012-06-22 05:41:30 +00001907/// call i8* \@objc_retain(i8* %value)
John McCall31168b02011-06-15 23:02:42 +00001908llvm::Value *CodeGenFunction::EmitARCRetainNonBlock(llvm::Value *value) {
1909 return emitARCValueOperation(*this, value,
1910 CGM.getARCEntrypoints().objc_retain,
1911 "objc_retain");
1912}
1913
1914/// Retain the given block, with _Block_copy semantics.
James Dennett14c41ea2012-06-22 05:41:30 +00001915/// call i8* \@objc_retainBlock(i8* %value)
John McCallff613032011-10-04 06:23:45 +00001916///
1917/// \param mandatory - If false, emit the call with metadata
1918/// indicating that it's okay for the optimizer to eliminate this call
1919/// if it can prove that the block never escapes except down the stack.
1920llvm::Value *CodeGenFunction::EmitARCRetainBlock(llvm::Value *value,
1921 bool mandatory) {
1922 llvm::Value *result
1923 = emitARCValueOperation(*this, value,
1924 CGM.getARCEntrypoints().objc_retainBlock,
1925 "objc_retainBlock");
1926
1927 // If the copy isn't mandatory, add !clang.arc.copy_on_escape to
1928 // tell the optimizer that it doesn't need to do this copy if the
1929 // block doesn't escape, where being passed as an argument doesn't
1930 // count as escaping.
1931 if (!mandatory && isa<llvm::Instruction>(result)) {
1932 llvm::CallInst *call
1933 = cast<llvm::CallInst>(result->stripPointerCasts());
1934 assert(call->getCalledValue() == CGM.getARCEntrypoints().objc_retainBlock);
1935
1936 SmallVector<llvm::Value*,1> args;
1937 call->setMetadata("clang.arc.copy_on_escape",
1938 llvm::MDNode::get(Builder.getContext(), args));
1939 }
1940
1941 return result;
John McCall31168b02011-06-15 23:02:42 +00001942}
1943
1944/// Retain the given object which is the result of a function call.
James Dennett14c41ea2012-06-22 05:41:30 +00001945/// call i8* \@objc_retainAutoreleasedReturnValue(i8* %value)
John McCall31168b02011-06-15 23:02:42 +00001946///
1947/// Yes, this function name is one character away from a different
1948/// call with completely different semantics.
1949llvm::Value *
1950CodeGenFunction::EmitARCRetainAutoreleasedReturnValue(llvm::Value *value) {
1951 // Fetch the void(void) inline asm which marks that we're going to
1952 // retain the autoreleased return value.
1953 llvm::InlineAsm *&marker
1954 = CGM.getARCEntrypoints().retainAutoreleasedReturnValueMarker;
1955 if (!marker) {
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001956 StringRef assembly
John McCall31168b02011-06-15 23:02:42 +00001957 = CGM.getTargetCodeGenInfo()
1958 .getARCRetainAutoreleasedReturnValueMarker();
1959
1960 // If we have an empty assembly string, there's nothing to do.
1961 if (assembly.empty()) {
1962
1963 // Otherwise, at -O0, build an inline asm that we're going to call
1964 // in a moment.
1965 } else if (CGM.getCodeGenOpts().OptimizationLevel == 0) {
1966 llvm::FunctionType *type =
Chris Lattnerece04092012-02-07 00:39:47 +00001967 llvm::FunctionType::get(VoidTy, /*variadic*/false);
John McCall31168b02011-06-15 23:02:42 +00001968
1969 marker = llvm::InlineAsm::get(type, assembly, "", /*sideeffects*/ true);
1970
1971 // If we're at -O1 and above, we don't want to litter the code
1972 // with this marker yet, so leave a breadcrumb for the ARC
1973 // optimizer to pick up.
1974 } else {
1975 llvm::NamedMDNode *metadata =
1976 CGM.getModule().getOrInsertNamedMetadata(
1977 "clang.arc.retainAutoreleasedReturnValueMarker");
1978 assert(metadata->getNumOperands() <= 1);
1979 if (metadata->getNumOperands() == 0) {
1980 llvm::Value *string = llvm::MDString::get(getLLVMContext(), assembly);
Jay Foad5709f7c2011-07-29 13:56:53 +00001981 metadata->addOperand(llvm::MDNode::get(getLLVMContext(), string));
John McCall31168b02011-06-15 23:02:42 +00001982 }
1983 }
1984 }
1985
1986 // Call the marker asm if we made one, which we do only at -O0.
1987 if (marker) Builder.CreateCall(marker);
1988
1989 return emitARCValueOperation(*this, value,
1990 CGM.getARCEntrypoints().objc_retainAutoreleasedReturnValue,
1991 "objc_retainAutoreleasedReturnValue");
1992}
1993
1994/// Release the given object.
James Dennett14c41ea2012-06-22 05:41:30 +00001995/// call void \@objc_release(i8* %value)
John McCallcdda29c2013-03-13 03:10:54 +00001996void CodeGenFunction::EmitARCRelease(llvm::Value *value,
1997 ARCPreciseLifetime_t precise) {
John McCall31168b02011-06-15 23:02:42 +00001998 if (isa<llvm::ConstantPointerNull>(value)) return;
1999
2000 llvm::Constant *&fn = CGM.getARCEntrypoints().objc_release;
2001 if (!fn) {
Chris Lattner2192fe52011-07-18 04:24:23 +00002002 llvm::FunctionType *fnType =
Benjamin Kramer95e19362013-03-07 21:18:31 +00002003 llvm::FunctionType::get(Builder.getVoidTy(), Int8PtrTy, false);
John McCall31168b02011-06-15 23:02:42 +00002004 fn = createARCRuntimeFunction(CGM, fnType, "objc_release");
2005 }
2006
2007 // Cast the argument to 'id'.
2008 value = Builder.CreateBitCast(value, Int8PtrTy);
2009
2010 // Call objc_release.
John McCall882987f2013-02-28 19:01:20 +00002011 llvm::CallInst *call = EmitNounwindRuntimeCall(fn, value);
John McCall31168b02011-06-15 23:02:42 +00002012
John McCallcdda29c2013-03-13 03:10:54 +00002013 if (precise == ARCImpreciseLifetime) {
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002014 SmallVector<llvm::Value*,1> args;
John McCall31168b02011-06-15 23:02:42 +00002015 call->setMetadata("clang.imprecise_release",
2016 llvm::MDNode::get(Builder.getContext(), args));
2017 }
2018}
2019
John McCalle68b8f42012-10-17 02:28:37 +00002020/// Destroy a __strong variable.
2021///
2022/// At -O0, emit a call to store 'null' into the address;
2023/// instrumenting tools prefer this because the address is exposed,
2024/// but it's relatively cumbersome to optimize.
2025///
2026/// At -O1 and above, just load and call objc_release.
2027///
2028/// call void \@objc_storeStrong(i8** %addr, i8* null)
John McCallcdda29c2013-03-13 03:10:54 +00002029void CodeGenFunction::EmitARCDestroyStrong(llvm::Value *addr,
2030 ARCPreciseLifetime_t precise) {
John McCalle68b8f42012-10-17 02:28:37 +00002031 if (CGM.getCodeGenOpts().OptimizationLevel == 0) {
2032 llvm::PointerType *addrTy = cast<llvm::PointerType>(addr->getType());
2033 llvm::Value *null = llvm::ConstantPointerNull::get(
2034 cast<llvm::PointerType>(addrTy->getElementType()));
2035 EmitARCStoreStrongCall(addr, null, /*ignored*/ true);
2036 return;
2037 }
2038
2039 llvm::Value *value = Builder.CreateLoad(addr);
2040 EmitARCRelease(value, precise);
2041}
2042
John McCall31168b02011-06-15 23:02:42 +00002043/// Store into a strong object. Always calls this:
James Dennett14c41ea2012-06-22 05:41:30 +00002044/// call void \@objc_storeStrong(i8** %addr, i8* %value)
John McCall31168b02011-06-15 23:02:42 +00002045llvm::Value *CodeGenFunction::EmitARCStoreStrongCall(llvm::Value *addr,
2046 llvm::Value *value,
2047 bool ignored) {
2048 assert(cast<llvm::PointerType>(addr->getType())->getElementType()
2049 == value->getType());
2050
2051 llvm::Constant *&fn = CGM.getARCEntrypoints().objc_storeStrong;
2052 if (!fn) {
Chris Lattnera5f58b02011-07-09 17:41:47 +00002053 llvm::Type *argTypes[] = { Int8PtrPtrTy, Int8PtrTy };
Chris Lattner2192fe52011-07-18 04:24:23 +00002054 llvm::FunctionType *fnType
John McCall31168b02011-06-15 23:02:42 +00002055 = llvm::FunctionType::get(Builder.getVoidTy(), argTypes, false);
2056 fn = createARCRuntimeFunction(CGM, fnType, "objc_storeStrong");
2057 }
2058
John McCall882987f2013-02-28 19:01:20 +00002059 llvm::Value *args[] = {
2060 Builder.CreateBitCast(addr, Int8PtrPtrTy),
2061 Builder.CreateBitCast(value, Int8PtrTy)
2062 };
2063 EmitNounwindRuntimeCall(fn, args);
John McCall31168b02011-06-15 23:02:42 +00002064
2065 if (ignored) return 0;
2066 return value;
2067}
2068
2069/// Store into a strong object. Sometimes calls this:
James Dennett14c41ea2012-06-22 05:41:30 +00002070/// call void \@objc_storeStrong(i8** %addr, i8* %value)
John McCall31168b02011-06-15 23:02:42 +00002071/// Other times, breaks it down into components.
John McCall55e1fbc2011-06-25 02:11:03 +00002072llvm::Value *CodeGenFunction::EmitARCStoreStrong(LValue dst,
John McCall31168b02011-06-15 23:02:42 +00002073 llvm::Value *newValue,
2074 bool ignored) {
John McCall55e1fbc2011-06-25 02:11:03 +00002075 QualType type = dst.getType();
John McCall31168b02011-06-15 23:02:42 +00002076 bool isBlock = type->isBlockPointerType();
2077
2078 // Use a store barrier at -O0 unless this is a block type or the
2079 // lvalue is inadequately aligned.
2080 if (shouldUseFusedARCCalls() &&
2081 !isBlock &&
Eli Friedmana0544d62011-12-03 04:14:32 +00002082 (dst.getAlignment().isZero() ||
2083 dst.getAlignment() >= CharUnits::fromQuantity(PointerAlignInBytes))) {
John McCall31168b02011-06-15 23:02:42 +00002084 return EmitARCStoreStrongCall(dst.getAddress(), newValue, ignored);
2085 }
2086
2087 // Otherwise, split it out.
2088
2089 // Retain the new value.
2090 newValue = EmitARCRetain(type, newValue);
2091
2092 // Read the old value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002093 llvm::Value *oldValue = EmitLoadOfScalar(dst, SourceLocation());
John McCall31168b02011-06-15 23:02:42 +00002094
2095 // Store. We do this before the release so that any deallocs won't
2096 // see the old value.
John McCall55e1fbc2011-06-25 02:11:03 +00002097 EmitStoreOfScalar(newValue, dst);
John McCall31168b02011-06-15 23:02:42 +00002098
2099 // Finally, release the old value.
John McCallcdda29c2013-03-13 03:10:54 +00002100 EmitARCRelease(oldValue, dst.isARCPreciseLifetime());
John McCall31168b02011-06-15 23:02:42 +00002101
2102 return newValue;
2103}
2104
2105/// Autorelease the given object.
James Dennett14c41ea2012-06-22 05:41:30 +00002106/// call i8* \@objc_autorelease(i8* %value)
John McCall31168b02011-06-15 23:02:42 +00002107llvm::Value *CodeGenFunction::EmitARCAutorelease(llvm::Value *value) {
2108 return emitARCValueOperation(*this, value,
2109 CGM.getARCEntrypoints().objc_autorelease,
2110 "objc_autorelease");
2111}
2112
2113/// Autorelease the given object.
James Dennett14c41ea2012-06-22 05:41:30 +00002114/// call i8* \@objc_autoreleaseReturnValue(i8* %value)
John McCall31168b02011-06-15 23:02:42 +00002115llvm::Value *
2116CodeGenFunction::EmitARCAutoreleaseReturnValue(llvm::Value *value) {
2117 return emitARCValueOperation(*this, value,
2118 CGM.getARCEntrypoints().objc_autoreleaseReturnValue,
Chad Rosier13799b32012-12-12 17:52:21 +00002119 "objc_autoreleaseReturnValue",
2120 /*isTailCall*/ true);
John McCall31168b02011-06-15 23:02:42 +00002121}
2122
2123/// Do a fused retain/autorelease of the given object.
James Dennett14c41ea2012-06-22 05:41:30 +00002124/// call i8* \@objc_retainAutoreleaseReturnValue(i8* %value)
John McCall31168b02011-06-15 23:02:42 +00002125llvm::Value *
2126CodeGenFunction::EmitARCRetainAutoreleaseReturnValue(llvm::Value *value) {
2127 return emitARCValueOperation(*this, value,
2128 CGM.getARCEntrypoints().objc_retainAutoreleaseReturnValue,
Chad Rosier13799b32012-12-12 17:52:21 +00002129 "objc_retainAutoreleaseReturnValue",
2130 /*isTailCall*/ true);
John McCall31168b02011-06-15 23:02:42 +00002131}
2132
2133/// Do a fused retain/autorelease of the given object.
James Dennett14c41ea2012-06-22 05:41:30 +00002134/// call i8* \@objc_retainAutorelease(i8* %value)
John McCall31168b02011-06-15 23:02:42 +00002135/// or
James Dennett14c41ea2012-06-22 05:41:30 +00002136/// %retain = call i8* \@objc_retainBlock(i8* %value)
2137/// call i8* \@objc_autorelease(i8* %retain)
John McCall31168b02011-06-15 23:02:42 +00002138llvm::Value *CodeGenFunction::EmitARCRetainAutorelease(QualType type,
2139 llvm::Value *value) {
2140 if (!type->isBlockPointerType())
2141 return EmitARCRetainAutoreleaseNonBlock(value);
2142
2143 if (isa<llvm::ConstantPointerNull>(value)) return value;
2144
Chris Lattner2192fe52011-07-18 04:24:23 +00002145 llvm::Type *origType = value->getType();
John McCall31168b02011-06-15 23:02:42 +00002146 value = Builder.CreateBitCast(value, Int8PtrTy);
John McCallff613032011-10-04 06:23:45 +00002147 value = EmitARCRetainBlock(value, /*mandatory*/ true);
John McCall31168b02011-06-15 23:02:42 +00002148 value = EmitARCAutorelease(value);
2149 return Builder.CreateBitCast(value, origType);
2150}
2151
2152/// Do a fused retain/autorelease of the given object.
James Dennett14c41ea2012-06-22 05:41:30 +00002153/// call i8* \@objc_retainAutorelease(i8* %value)
John McCall31168b02011-06-15 23:02:42 +00002154llvm::Value *
2155CodeGenFunction::EmitARCRetainAutoreleaseNonBlock(llvm::Value *value) {
2156 return emitARCValueOperation(*this, value,
2157 CGM.getARCEntrypoints().objc_retainAutorelease,
2158 "objc_retainAutorelease");
2159}
2160
James Dennett14c41ea2012-06-22 05:41:30 +00002161/// i8* \@objc_loadWeak(i8** %addr)
John McCall31168b02011-06-15 23:02:42 +00002162/// Essentially objc_autorelease(objc_loadWeakRetained(addr)).
2163llvm::Value *CodeGenFunction::EmitARCLoadWeak(llvm::Value *addr) {
2164 return emitARCLoadOperation(*this, addr,
2165 CGM.getARCEntrypoints().objc_loadWeak,
2166 "objc_loadWeak");
2167}
2168
James Dennett14c41ea2012-06-22 05:41:30 +00002169/// i8* \@objc_loadWeakRetained(i8** %addr)
John McCall31168b02011-06-15 23:02:42 +00002170llvm::Value *CodeGenFunction::EmitARCLoadWeakRetained(llvm::Value *addr) {
2171 return emitARCLoadOperation(*this, addr,
2172 CGM.getARCEntrypoints().objc_loadWeakRetained,
2173 "objc_loadWeakRetained");
2174}
2175
James Dennett14c41ea2012-06-22 05:41:30 +00002176/// i8* \@objc_storeWeak(i8** %addr, i8* %value)
John McCall31168b02011-06-15 23:02:42 +00002177/// Returns %value.
2178llvm::Value *CodeGenFunction::EmitARCStoreWeak(llvm::Value *addr,
2179 llvm::Value *value,
2180 bool ignored) {
2181 return emitARCStoreOperation(*this, addr, value,
2182 CGM.getARCEntrypoints().objc_storeWeak,
2183 "objc_storeWeak", ignored);
2184}
2185
James Dennett14c41ea2012-06-22 05:41:30 +00002186/// i8* \@objc_initWeak(i8** %addr, i8* %value)
John McCall31168b02011-06-15 23:02:42 +00002187/// Returns %value. %addr is known to not have a current weak entry.
2188/// Essentially equivalent to:
2189/// *addr = nil; objc_storeWeak(addr, value);
2190void CodeGenFunction::EmitARCInitWeak(llvm::Value *addr, llvm::Value *value) {
2191 // If we're initializing to null, just write null to memory; no need
2192 // to get the runtime involved. But don't do this if optimization
2193 // is enabled, because accounting for this would make the optimizer
2194 // much more complicated.
2195 if (isa<llvm::ConstantPointerNull>(value) &&
2196 CGM.getCodeGenOpts().OptimizationLevel == 0) {
2197 Builder.CreateStore(value, addr);
2198 return;
2199 }
2200
2201 emitARCStoreOperation(*this, addr, value,
2202 CGM.getARCEntrypoints().objc_initWeak,
2203 "objc_initWeak", /*ignored*/ true);
2204}
2205
James Dennett14c41ea2012-06-22 05:41:30 +00002206/// void \@objc_destroyWeak(i8** %addr)
John McCall31168b02011-06-15 23:02:42 +00002207/// Essentially objc_storeWeak(addr, nil).
2208void CodeGenFunction::EmitARCDestroyWeak(llvm::Value *addr) {
2209 llvm::Constant *&fn = CGM.getARCEntrypoints().objc_destroyWeak;
2210 if (!fn) {
Chris Lattner2192fe52011-07-18 04:24:23 +00002211 llvm::FunctionType *fnType =
Benjamin Kramer95e19362013-03-07 21:18:31 +00002212 llvm::FunctionType::get(Builder.getVoidTy(), Int8PtrPtrTy, false);
John McCall31168b02011-06-15 23:02:42 +00002213 fn = createARCRuntimeFunction(CGM, fnType, "objc_destroyWeak");
2214 }
2215
2216 // Cast the argument to 'id*'.
2217 addr = Builder.CreateBitCast(addr, Int8PtrPtrTy);
2218
John McCall882987f2013-02-28 19:01:20 +00002219 EmitNounwindRuntimeCall(fn, addr);
John McCall31168b02011-06-15 23:02:42 +00002220}
2221
James Dennett14c41ea2012-06-22 05:41:30 +00002222/// void \@objc_moveWeak(i8** %dest, i8** %src)
John McCall31168b02011-06-15 23:02:42 +00002223/// Disregards the current value in %dest. Leaves %src pointing to nothing.
2224/// Essentially (objc_copyWeak(dest, src), objc_destroyWeak(src)).
2225void CodeGenFunction::EmitARCMoveWeak(llvm::Value *dst, llvm::Value *src) {
2226 emitARCCopyOperation(*this, dst, src,
2227 CGM.getARCEntrypoints().objc_moveWeak,
2228 "objc_moveWeak");
2229}
2230
James Dennett14c41ea2012-06-22 05:41:30 +00002231/// void \@objc_copyWeak(i8** %dest, i8** %src)
John McCall31168b02011-06-15 23:02:42 +00002232/// Disregards the current value in %dest. Essentially
2233/// objc_release(objc_initWeak(dest, objc_readWeakRetained(src)))
2234void CodeGenFunction::EmitARCCopyWeak(llvm::Value *dst, llvm::Value *src) {
2235 emitARCCopyOperation(*this, dst, src,
2236 CGM.getARCEntrypoints().objc_copyWeak,
2237 "objc_copyWeak");
2238}
2239
2240/// Produce the code to do a objc_autoreleasepool_push.
James Dennett14c41ea2012-06-22 05:41:30 +00002241/// call i8* \@objc_autoreleasePoolPush(void)
John McCall31168b02011-06-15 23:02:42 +00002242llvm::Value *CodeGenFunction::EmitObjCAutoreleasePoolPush() {
2243 llvm::Constant *&fn = CGM.getRREntrypoints().objc_autoreleasePoolPush;
2244 if (!fn) {
Chris Lattner2192fe52011-07-18 04:24:23 +00002245 llvm::FunctionType *fnType =
John McCall31168b02011-06-15 23:02:42 +00002246 llvm::FunctionType::get(Int8PtrTy, false);
2247 fn = createARCRuntimeFunction(CGM, fnType, "objc_autoreleasePoolPush");
2248 }
2249
John McCall882987f2013-02-28 19:01:20 +00002250 return EmitNounwindRuntimeCall(fn);
John McCall31168b02011-06-15 23:02:42 +00002251}
2252
2253/// Produce the code to do a primitive release.
James Dennett14c41ea2012-06-22 05:41:30 +00002254/// call void \@objc_autoreleasePoolPop(i8* %ptr)
John McCall31168b02011-06-15 23:02:42 +00002255void CodeGenFunction::EmitObjCAutoreleasePoolPop(llvm::Value *value) {
2256 assert(value->getType() == Int8PtrTy);
2257
2258 llvm::Constant *&fn = CGM.getRREntrypoints().objc_autoreleasePoolPop;
2259 if (!fn) {
Chris Lattner2192fe52011-07-18 04:24:23 +00002260 llvm::FunctionType *fnType =
Benjamin Kramer95e19362013-03-07 21:18:31 +00002261 llvm::FunctionType::get(Builder.getVoidTy(), Int8PtrTy, false);
John McCall31168b02011-06-15 23:02:42 +00002262
2263 // We don't want to use a weak import here; instead we should not
2264 // fall into this path.
2265 fn = createARCRuntimeFunction(CGM, fnType, "objc_autoreleasePoolPop");
2266 }
2267
John McCallb7ff6db2013-04-16 21:29:40 +00002268 // objc_autoreleasePoolPop can throw.
2269 EmitRuntimeCallOrInvoke(fn, value);
John McCall31168b02011-06-15 23:02:42 +00002270}
2271
2272/// Produce the code to do an MRR version objc_autoreleasepool_push.
2273/// Which is: [[NSAutoreleasePool alloc] init];
2274/// Where alloc is declared as: + (id) alloc; in NSAutoreleasePool class.
2275/// init is declared as: - (id) init; in its NSObject super class.
2276///
2277llvm::Value *CodeGenFunction::EmitObjCMRRAutoreleasePoolPush() {
2278 CGObjCRuntime &Runtime = CGM.getObjCRuntime();
John McCall882987f2013-02-28 19:01:20 +00002279 llvm::Value *Receiver = Runtime.EmitNSAutoreleasePoolClassRef(*this);
John McCall31168b02011-06-15 23:02:42 +00002280 // [NSAutoreleasePool alloc]
2281 IdentifierInfo *II = &CGM.getContext().Idents.get("alloc");
2282 Selector AllocSel = getContext().Selectors.getSelector(0, &II);
2283 CallArgList Args;
2284 RValue AllocRV =
2285 Runtime.GenerateMessageSend(*this, ReturnValueSlot(),
2286 getContext().getObjCIdType(),
2287 AllocSel, Receiver, Args);
2288
2289 // [Receiver init]
2290 Receiver = AllocRV.getScalarVal();
2291 II = &CGM.getContext().Idents.get("init");
2292 Selector InitSel = getContext().Selectors.getSelector(0, &II);
2293 RValue InitRV =
2294 Runtime.GenerateMessageSend(*this, ReturnValueSlot(),
2295 getContext().getObjCIdType(),
2296 InitSel, Receiver, Args);
2297 return InitRV.getScalarVal();
2298}
2299
2300/// Produce the code to do a primitive release.
2301/// [tmp drain];
2302void CodeGenFunction::EmitObjCMRRAutoreleasePoolPop(llvm::Value *Arg) {
2303 IdentifierInfo *II = &CGM.getContext().Idents.get("drain");
2304 Selector DrainSel = getContext().Selectors.getSelector(0, &II);
2305 CallArgList Args;
2306 CGM.getObjCRuntime().GenerateMessageSend(*this, ReturnValueSlot(),
2307 getContext().VoidTy, DrainSel, Arg, Args);
2308}
2309
John McCall82fe67b2011-07-09 01:37:26 +00002310void CodeGenFunction::destroyARCStrongPrecise(CodeGenFunction &CGF,
2311 llvm::Value *addr,
2312 QualType type) {
John McCallcdda29c2013-03-13 03:10:54 +00002313 CGF.EmitARCDestroyStrong(addr, ARCPreciseLifetime);
John McCall82fe67b2011-07-09 01:37:26 +00002314}
2315
2316void CodeGenFunction::destroyARCStrongImprecise(CodeGenFunction &CGF,
2317 llvm::Value *addr,
2318 QualType type) {
John McCallcdda29c2013-03-13 03:10:54 +00002319 CGF.EmitARCDestroyStrong(addr, ARCImpreciseLifetime);
John McCall82fe67b2011-07-09 01:37:26 +00002320}
2321
2322void CodeGenFunction::destroyARCWeak(CodeGenFunction &CGF,
2323 llvm::Value *addr,
2324 QualType type) {
2325 CGF.EmitARCDestroyWeak(addr);
2326}
2327
John McCall31168b02011-06-15 23:02:42 +00002328namespace {
John McCall31168b02011-06-15 23:02:42 +00002329 struct CallObjCAutoreleasePoolObject : EHScopeStack::Cleanup {
2330 llvm::Value *Token;
2331
2332 CallObjCAutoreleasePoolObject(llvm::Value *token) : Token(token) {}
2333
John McCall30317fd2011-07-12 20:27:29 +00002334 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCall31168b02011-06-15 23:02:42 +00002335 CGF.EmitObjCAutoreleasePoolPop(Token);
2336 }
2337 };
2338 struct CallObjCMRRAutoreleasePoolObject : EHScopeStack::Cleanup {
2339 llvm::Value *Token;
2340
2341 CallObjCMRRAutoreleasePoolObject(llvm::Value *token) : Token(token) {}
2342
John McCall30317fd2011-07-12 20:27:29 +00002343 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCall31168b02011-06-15 23:02:42 +00002344 CGF.EmitObjCMRRAutoreleasePoolPop(Token);
2345 }
2346 };
2347}
2348
2349void CodeGenFunction::EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr) {
David Blaikiebbafb8a2012-03-11 07:00:24 +00002350 if (CGM.getLangOpts().ObjCAutoRefCount)
John McCall31168b02011-06-15 23:02:42 +00002351 EHStack.pushCleanup<CallObjCAutoreleasePoolObject>(NormalCleanup, Ptr);
2352 else
2353 EHStack.pushCleanup<CallObjCMRRAutoreleasePoolObject>(NormalCleanup, Ptr);
2354}
2355
John McCall31168b02011-06-15 23:02:42 +00002356static TryEmitResult tryEmitARCRetainLoadOfScalar(CodeGenFunction &CGF,
2357 LValue lvalue,
2358 QualType type) {
2359 switch (type.getObjCLifetime()) {
2360 case Qualifiers::OCL_None:
2361 case Qualifiers::OCL_ExplicitNone:
2362 case Qualifiers::OCL_Strong:
2363 case Qualifiers::OCL_Autoreleasing:
Nick Lewycky2d84e842013-10-02 02:29:49 +00002364 return TryEmitResult(CGF.EmitLoadOfLValue(lvalue,
2365 SourceLocation()).getScalarVal(),
John McCall31168b02011-06-15 23:02:42 +00002366 false);
2367
2368 case Qualifiers::OCL_Weak:
2369 return TryEmitResult(CGF.EmitARCLoadWeakRetained(lvalue.getAddress()),
2370 true);
2371 }
2372
2373 llvm_unreachable("impossible lifetime!");
John McCall31168b02011-06-15 23:02:42 +00002374}
2375
2376static TryEmitResult tryEmitARCRetainLoadOfScalar(CodeGenFunction &CGF,
2377 const Expr *e) {
2378 e = e->IgnoreParens();
2379 QualType type = e->getType();
2380
John McCall154a2fd2011-08-30 00:57:29 +00002381 // If we're loading retained from a __strong xvalue, we can avoid
2382 // an extra retain/release pair by zeroing out the source of this
2383 // "move" operation.
2384 if (e->isXValue() &&
2385 !type.isConstQualified() &&
2386 type.getObjCLifetime() == Qualifiers::OCL_Strong) {
2387 // Emit the lvalue.
2388 LValue lv = CGF.EmitLValue(e);
2389
2390 // Load the object pointer.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002391 llvm::Value *result = CGF.EmitLoadOfLValue(lv,
2392 SourceLocation()).getScalarVal();
John McCall154a2fd2011-08-30 00:57:29 +00002393
2394 // Set the source pointer to NULL.
2395 CGF.EmitStoreOfScalar(getNullForVariable(lv.getAddress()), lv);
2396
2397 return TryEmitResult(result, true);
2398 }
2399
John McCall31168b02011-06-15 23:02:42 +00002400 // As a very special optimization, in ARC++, if the l-value is the
2401 // result of a non-volatile assignment, do a simple retain of the
2402 // result of the call to objc_storeWeak instead of reloading.
David Blaikiebbafb8a2012-03-11 07:00:24 +00002403 if (CGF.getLangOpts().CPlusPlus &&
John McCall31168b02011-06-15 23:02:42 +00002404 !type.isVolatileQualified() &&
2405 type.getObjCLifetime() == Qualifiers::OCL_Weak &&
2406 isa<BinaryOperator>(e) &&
2407 cast<BinaryOperator>(e)->getOpcode() == BO_Assign)
2408 return TryEmitResult(CGF.EmitScalarExpr(e), false);
2409
2410 return tryEmitARCRetainLoadOfScalar(CGF, CGF.EmitLValue(e), type);
2411}
2412
2413static llvm::Value *emitARCRetainAfterCall(CodeGenFunction &CGF,
2414 llvm::Value *value);
2415
2416/// Given that the given expression is some sort of call (which does
2417/// not return retained), emit a retain following it.
2418static llvm::Value *emitARCRetainCall(CodeGenFunction &CGF, const Expr *e) {
2419 llvm::Value *value = CGF.EmitScalarExpr(e);
2420 return emitARCRetainAfterCall(CGF, value);
2421}
2422
2423static llvm::Value *emitARCRetainAfterCall(CodeGenFunction &CGF,
2424 llvm::Value *value) {
2425 if (llvm::CallInst *call = dyn_cast<llvm::CallInst>(value)) {
2426 CGBuilderTy::InsertPoint ip = CGF.Builder.saveIP();
2427
2428 // Place the retain immediately following the call.
2429 CGF.Builder.SetInsertPoint(call->getParent(),
2430 ++llvm::BasicBlock::iterator(call));
2431 value = CGF.EmitARCRetainAutoreleasedReturnValue(value);
2432
2433 CGF.Builder.restoreIP(ip);
2434 return value;
2435 } else if (llvm::InvokeInst *invoke = dyn_cast<llvm::InvokeInst>(value)) {
2436 CGBuilderTy::InsertPoint ip = CGF.Builder.saveIP();
2437
2438 // Place the retain at the beginning of the normal destination block.
2439 llvm::BasicBlock *BB = invoke->getNormalDest();
2440 CGF.Builder.SetInsertPoint(BB, BB->begin());
2441 value = CGF.EmitARCRetainAutoreleasedReturnValue(value);
2442
2443 CGF.Builder.restoreIP(ip);
2444 return value;
2445
2446 // Bitcasts can arise because of related-result returns. Rewrite
2447 // the operand.
2448 } else if (llvm::BitCastInst *bitcast = dyn_cast<llvm::BitCastInst>(value)) {
2449 llvm::Value *operand = bitcast->getOperand(0);
2450 operand = emitARCRetainAfterCall(CGF, operand);
2451 bitcast->setOperand(0, operand);
2452 return bitcast;
2453
2454 // Generic fall-back case.
2455 } else {
2456 // Retain using the non-block variant: we never need to do a copy
2457 // of a block that's been returned to us.
2458 return CGF.EmitARCRetainNonBlock(value);
2459 }
2460}
2461
John McCallcd78e802011-09-10 01:16:55 +00002462/// Determine whether it might be important to emit a separate
2463/// objc_retain_block on the result of the given expression, or
2464/// whether it's okay to just emit it in a +1 context.
2465static bool shouldEmitSeparateBlockRetain(const Expr *e) {
2466 assert(e->getType()->isBlockPointerType());
2467 e = e->IgnoreParens();
2468
2469 // For future goodness, emit block expressions directly in +1
2470 // contexts if we can.
2471 if (isa<BlockExpr>(e))
2472 return false;
2473
2474 if (const CastExpr *cast = dyn_cast<CastExpr>(e)) {
2475 switch (cast->getCastKind()) {
2476 // Emitting these operations in +1 contexts is goodness.
2477 case CK_LValueToRValue:
John McCall2d637d22011-09-10 06:18:15 +00002478 case CK_ARCReclaimReturnedObject:
2479 case CK_ARCConsumeObject:
2480 case CK_ARCProduceObject:
John McCallcd78e802011-09-10 01:16:55 +00002481 return false;
2482
2483 // These operations preserve a block type.
2484 case CK_NoOp:
2485 case CK_BitCast:
2486 return shouldEmitSeparateBlockRetain(cast->getSubExpr());
2487
2488 // These operations are known to be bad (or haven't been considered).
2489 case CK_AnyPointerToBlockPointerCast:
2490 default:
2491 return true;
2492 }
2493 }
2494
2495 return true;
2496}
2497
John McCallfe96e0b2011-11-06 09:01:30 +00002498/// Try to emit a PseudoObjectExpr at +1.
2499///
2500/// This massively duplicates emitPseudoObjectRValue.
2501static TryEmitResult tryEmitARCRetainPseudoObject(CodeGenFunction &CGF,
2502 const PseudoObjectExpr *E) {
Dmitri Gribenkof8579502013-01-12 19:30:44 +00002503 SmallVector<CodeGenFunction::OpaqueValueMappingData, 4> opaques;
John McCallfe96e0b2011-11-06 09:01:30 +00002504
2505 // Find the result expression.
2506 const Expr *resultExpr = E->getResultExpr();
2507 assert(resultExpr);
2508 TryEmitResult result;
2509
2510 for (PseudoObjectExpr::const_semantics_iterator
2511 i = E->semantics_begin(), e = E->semantics_end(); i != e; ++i) {
2512 const Expr *semantic = *i;
2513
2514 // If this semantic expression is an opaque value, bind it
2515 // to the result of its source expression.
2516 if (const OpaqueValueExpr *ov = dyn_cast<OpaqueValueExpr>(semantic)) {
2517 typedef CodeGenFunction::OpaqueValueMappingData OVMA;
2518 OVMA opaqueData;
2519
2520 // If this semantic is the result of the pseudo-object
2521 // expression, try to evaluate the source as +1.
2522 if (ov == resultExpr) {
2523 assert(!OVMA::shouldBindAsLValue(ov));
2524 result = tryEmitARCRetainScalarExpr(CGF, ov->getSourceExpr());
2525 opaqueData = OVMA::bind(CGF, ov, RValue::get(result.getPointer()));
2526
2527 // Otherwise, just bind it.
2528 } else {
2529 opaqueData = OVMA::bind(CGF, ov, ov->getSourceExpr());
2530 }
2531 opaques.push_back(opaqueData);
2532
2533 // Otherwise, if the expression is the result, evaluate it
2534 // and remember the result.
2535 } else if (semantic == resultExpr) {
2536 result = tryEmitARCRetainScalarExpr(CGF, semantic);
2537
2538 // Otherwise, evaluate the expression in an ignored context.
2539 } else {
2540 CGF.EmitIgnoredExpr(semantic);
2541 }
2542 }
2543
2544 // Unbind all the opaques now.
2545 for (unsigned i = 0, e = opaques.size(); i != e; ++i)
2546 opaques[i].unbind(CGF);
2547
2548 return result;
2549}
2550
John McCall31168b02011-06-15 23:02:42 +00002551static TryEmitResult
2552tryEmitARCRetainScalarExpr(CodeGenFunction &CGF, const Expr *e) {
John McCalld21cdd42013-02-12 00:25:08 +00002553 // We should *never* see a nested full-expression here, because if
2554 // we fail to emit at +1, our caller must not retain after we close
2555 // out the full-expression.
2556 assert(!isa<ExprWithCleanups>(e));
John McCall53848232011-07-27 01:07:15 +00002557
John McCall31168b02011-06-15 23:02:42 +00002558 // The desired result type, if it differs from the type of the
2559 // ultimate opaque expression.
Chris Lattner2192fe52011-07-18 04:24:23 +00002560 llvm::Type *resultType = 0;
John McCall31168b02011-06-15 23:02:42 +00002561
2562 while (true) {
2563 e = e->IgnoreParens();
2564
2565 // There's a break at the end of this if-chain; anything
2566 // that wants to keep looping has to explicitly continue.
2567 if (const CastExpr *ce = dyn_cast<CastExpr>(e)) {
2568 switch (ce->getCastKind()) {
2569 // No-op casts don't change the type, so we just ignore them.
2570 case CK_NoOp:
2571 e = ce->getSubExpr();
2572 continue;
2573
2574 case CK_LValueToRValue: {
2575 TryEmitResult loadResult
2576 = tryEmitARCRetainLoadOfScalar(CGF, ce->getSubExpr());
2577 if (resultType) {
2578 llvm::Value *value = loadResult.getPointer();
2579 value = CGF.Builder.CreateBitCast(value, resultType);
2580 loadResult.setPointer(value);
2581 }
2582 return loadResult;
2583 }
2584
2585 // These casts can change the type, so remember that and
2586 // soldier on. We only need to remember the outermost such
2587 // cast, though.
John McCall9320b872011-09-09 05:25:32 +00002588 case CK_CPointerToObjCPointerCast:
2589 case CK_BlockPointerToObjCPointerCast:
John McCall31168b02011-06-15 23:02:42 +00002590 case CK_AnyPointerToBlockPointerCast:
2591 case CK_BitCast:
2592 if (!resultType)
2593 resultType = CGF.ConvertType(ce->getType());
2594 e = ce->getSubExpr();
2595 assert(e->getType()->hasPointerRepresentation());
2596 continue;
2597
2598 // For consumptions, just emit the subexpression and thus elide
2599 // the retain/release pair.
John McCall2d637d22011-09-10 06:18:15 +00002600 case CK_ARCConsumeObject: {
John McCall31168b02011-06-15 23:02:42 +00002601 llvm::Value *result = CGF.EmitScalarExpr(ce->getSubExpr());
2602 if (resultType) result = CGF.Builder.CreateBitCast(result, resultType);
2603 return TryEmitResult(result, true);
2604 }
2605
John McCallcd78e802011-09-10 01:16:55 +00002606 // Block extends are net +0. Naively, we could just recurse on
2607 // the subexpression, but actually we need to ensure that the
2608 // value is copied as a block, so there's a little filter here.
John McCall2d637d22011-09-10 06:18:15 +00002609 case CK_ARCExtendBlockObject: {
John McCallcd78e802011-09-10 01:16:55 +00002610 llvm::Value *result; // will be a +0 value
2611
2612 // If we can't safely assume the sub-expression will produce a
2613 // block-copied value, emit the sub-expression at +0.
2614 if (shouldEmitSeparateBlockRetain(ce->getSubExpr())) {
2615 result = CGF.EmitScalarExpr(ce->getSubExpr());
2616
2617 // Otherwise, try to emit the sub-expression at +1 recursively.
2618 } else {
2619 TryEmitResult subresult
2620 = tryEmitARCRetainScalarExpr(CGF, ce->getSubExpr());
2621 result = subresult.getPointer();
2622
2623 // If that produced a retained value, just use that,
2624 // possibly casting down.
2625 if (subresult.getInt()) {
2626 if (resultType)
2627 result = CGF.Builder.CreateBitCast(result, resultType);
2628 return TryEmitResult(result, true);
2629 }
2630
2631 // Otherwise it's +0.
2632 }
2633
2634 // Retain the object as a block, then cast down.
John McCallff613032011-10-04 06:23:45 +00002635 result = CGF.EmitARCRetainBlock(result, /*mandatory*/ true);
John McCallcd78e802011-09-10 01:16:55 +00002636 if (resultType) result = CGF.Builder.CreateBitCast(result, resultType);
2637 return TryEmitResult(result, true);
2638 }
2639
John McCall4db5c3c2011-07-07 06:58:02 +00002640 // For reclaims, emit the subexpression as a retained call and
2641 // skip the consumption.
John McCall2d637d22011-09-10 06:18:15 +00002642 case CK_ARCReclaimReturnedObject: {
John McCall4db5c3c2011-07-07 06:58:02 +00002643 llvm::Value *result = emitARCRetainCall(CGF, ce->getSubExpr());
2644 if (resultType) result = CGF.Builder.CreateBitCast(result, resultType);
2645 return TryEmitResult(result, true);
2646 }
2647
John McCall31168b02011-06-15 23:02:42 +00002648 default:
2649 break;
2650 }
2651
2652 // Skip __extension__.
2653 } else if (const UnaryOperator *op = dyn_cast<UnaryOperator>(e)) {
2654 if (op->getOpcode() == UO_Extension) {
2655 e = op->getSubExpr();
2656 continue;
2657 }
2658
2659 // For calls and message sends, use the retained-call logic.
2660 // Delegate inits are a special case in that they're the only
2661 // returns-retained expression that *isn't* surrounded by
2662 // a consume.
2663 } else if (isa<CallExpr>(e) ||
2664 (isa<ObjCMessageExpr>(e) &&
2665 !cast<ObjCMessageExpr>(e)->isDelegateInitCall())) {
2666 llvm::Value *result = emitARCRetainCall(CGF, e);
2667 if (resultType) result = CGF.Builder.CreateBitCast(result, resultType);
2668 return TryEmitResult(result, true);
John McCallfe96e0b2011-11-06 09:01:30 +00002669
2670 // Look through pseudo-object expressions.
2671 } else if (const PseudoObjectExpr *pseudo = dyn_cast<PseudoObjectExpr>(e)) {
2672 TryEmitResult result
2673 = tryEmitARCRetainPseudoObject(CGF, pseudo);
2674 if (resultType) {
2675 llvm::Value *value = result.getPointer();
2676 value = CGF.Builder.CreateBitCast(value, resultType);
2677 result.setPointer(value);
2678 }
2679 return result;
John McCall31168b02011-06-15 23:02:42 +00002680 }
2681
2682 // Conservatively halt the search at any other expression kind.
2683 break;
2684 }
2685
2686 // We didn't find an obvious production, so emit what we've got and
2687 // tell the caller that we didn't manage to retain.
2688 llvm::Value *result = CGF.EmitScalarExpr(e);
2689 if (resultType) result = CGF.Builder.CreateBitCast(result, resultType);
2690 return TryEmitResult(result, false);
2691}
2692
2693static llvm::Value *emitARCRetainLoadOfScalar(CodeGenFunction &CGF,
2694 LValue lvalue,
2695 QualType type) {
2696 TryEmitResult result = tryEmitARCRetainLoadOfScalar(CGF, lvalue, type);
2697 llvm::Value *value = result.getPointer();
2698 if (!result.getInt())
2699 value = CGF.EmitARCRetain(type, value);
2700 return value;
2701}
2702
2703/// EmitARCRetainScalarExpr - Semantically equivalent to
2704/// EmitARCRetainObject(e->getType(), EmitScalarExpr(e)), but making a
2705/// best-effort attempt to peephole expressions that naturally produce
2706/// retained objects.
2707llvm::Value *CodeGenFunction::EmitARCRetainScalarExpr(const Expr *e) {
John McCalld21cdd42013-02-12 00:25:08 +00002708 // The retain needs to happen within the full-expression.
2709 if (const ExprWithCleanups *cleanups = dyn_cast<ExprWithCleanups>(e)) {
2710 enterFullExpression(cleanups);
2711 RunCleanupsScope scope(*this);
2712 return EmitARCRetainScalarExpr(cleanups->getSubExpr());
2713 }
2714
John McCall31168b02011-06-15 23:02:42 +00002715 TryEmitResult result = tryEmitARCRetainScalarExpr(*this, e);
2716 llvm::Value *value = result.getPointer();
2717 if (!result.getInt())
2718 value = EmitARCRetain(e->getType(), value);
2719 return value;
2720}
2721
2722llvm::Value *
2723CodeGenFunction::EmitARCRetainAutoreleaseScalarExpr(const Expr *e) {
John McCalld21cdd42013-02-12 00:25:08 +00002724 // The retain needs to happen within the full-expression.
2725 if (const ExprWithCleanups *cleanups = dyn_cast<ExprWithCleanups>(e)) {
2726 enterFullExpression(cleanups);
2727 RunCleanupsScope scope(*this);
2728 return EmitARCRetainAutoreleaseScalarExpr(cleanups->getSubExpr());
2729 }
2730
John McCall31168b02011-06-15 23:02:42 +00002731 TryEmitResult result = tryEmitARCRetainScalarExpr(*this, e);
2732 llvm::Value *value = result.getPointer();
2733 if (result.getInt())
2734 value = EmitARCAutorelease(value);
2735 else
2736 value = EmitARCRetainAutorelease(e->getType(), value);
2737 return value;
2738}
2739
John McCallff613032011-10-04 06:23:45 +00002740llvm::Value *CodeGenFunction::EmitARCExtendBlockObject(const Expr *e) {
2741 llvm::Value *result;
2742 bool doRetain;
2743
2744 if (shouldEmitSeparateBlockRetain(e)) {
2745 result = EmitScalarExpr(e);
2746 doRetain = true;
2747 } else {
2748 TryEmitResult subresult = tryEmitARCRetainScalarExpr(*this, e);
2749 result = subresult.getPointer();
2750 doRetain = !subresult.getInt();
2751 }
2752
2753 if (doRetain)
2754 result = EmitARCRetainBlock(result, /*mandatory*/ true);
2755 return EmitObjCConsumeObject(e->getType(), result);
2756}
2757
John McCall248512a2011-10-01 10:32:24 +00002758llvm::Value *CodeGenFunction::EmitObjCThrowOperand(const Expr *expr) {
2759 // In ARC, retain and autorelease the expression.
David Blaikiebbafb8a2012-03-11 07:00:24 +00002760 if (getLangOpts().ObjCAutoRefCount) {
John McCall248512a2011-10-01 10:32:24 +00002761 // Do so before running any cleanups for the full-expression.
John McCalld21cdd42013-02-12 00:25:08 +00002762 // EmitARCRetainAutoreleaseScalarExpr does this for us.
John McCall248512a2011-10-01 10:32:24 +00002763 return EmitARCRetainAutoreleaseScalarExpr(expr);
2764 }
2765
2766 // Otherwise, use the normal scalar-expression emission. The
2767 // exception machinery doesn't do anything special with the
2768 // exception like retaining it, so there's no safety associated with
2769 // only running cleanups after the throw has started, and when it
2770 // matters it tends to be substantially inferior code.
2771 return EmitScalarExpr(expr);
2772}
2773
John McCall31168b02011-06-15 23:02:42 +00002774std::pair<LValue,llvm::Value*>
2775CodeGenFunction::EmitARCStoreStrong(const BinaryOperator *e,
2776 bool ignored) {
2777 // Evaluate the RHS first.
2778 TryEmitResult result = tryEmitARCRetainScalarExpr(*this, e->getRHS());
2779 llvm::Value *value = result.getPointer();
2780
John McCallb726a552011-07-28 07:23:35 +00002781 bool hasImmediateRetain = result.getInt();
2782
2783 // If we didn't emit a retained object, and the l-value is of block
2784 // type, then we need to emit the block-retain immediately in case
2785 // it invalidates the l-value.
2786 if (!hasImmediateRetain && e->getType()->isBlockPointerType()) {
John McCallff613032011-10-04 06:23:45 +00002787 value = EmitARCRetainBlock(value, /*mandatory*/ false);
John McCallb726a552011-07-28 07:23:35 +00002788 hasImmediateRetain = true;
2789 }
2790
John McCall31168b02011-06-15 23:02:42 +00002791 LValue lvalue = EmitLValue(e->getLHS());
2792
2793 // If the RHS was emitted retained, expand this.
John McCallb726a552011-07-28 07:23:35 +00002794 if (hasImmediateRetain) {
Nick Lewyckyce550072013-10-02 02:33:11 +00002795 llvm::Value *oldValue = EmitLoadOfScalar(lvalue, SourceLocation());
Eli Friedmana0544d62011-12-03 04:14:32 +00002796 EmitStoreOfScalar(value, lvalue);
John McCallcdda29c2013-03-13 03:10:54 +00002797 EmitARCRelease(oldValue, lvalue.isARCPreciseLifetime());
John McCall31168b02011-06-15 23:02:42 +00002798 } else {
John McCall55e1fbc2011-06-25 02:11:03 +00002799 value = EmitARCStoreStrong(lvalue, value, ignored);
John McCall31168b02011-06-15 23:02:42 +00002800 }
2801
2802 return std::pair<LValue,llvm::Value*>(lvalue, value);
2803}
2804
2805std::pair<LValue,llvm::Value*>
2806CodeGenFunction::EmitARCStoreAutoreleasing(const BinaryOperator *e) {
2807 llvm::Value *value = EmitARCRetainAutoreleaseScalarExpr(e->getRHS());
2808 LValue lvalue = EmitLValue(e->getLHS());
2809
Eli Friedmana0544d62011-12-03 04:14:32 +00002810 EmitStoreOfScalar(value, lvalue);
John McCall31168b02011-06-15 23:02:42 +00002811
2812 return std::pair<LValue,llvm::Value*>(lvalue, value);
2813}
2814
2815void CodeGenFunction::EmitObjCAutoreleasePoolStmt(
Eric Christopher5d2b8d92012-03-29 17:31:31 +00002816 const ObjCAutoreleasePoolStmt &ARPS) {
John McCall31168b02011-06-15 23:02:42 +00002817 const Stmt *subStmt = ARPS.getSubStmt();
2818 const CompoundStmt &S = cast<CompoundStmt>(*subStmt);
2819
2820 CGDebugInfo *DI = getDebugInfo();
Eric Christopher7cdf9482011-10-13 21:45:18 +00002821 if (DI)
2822 DI->EmitLexicalBlockStart(Builder, S.getLBracLoc());
John McCall31168b02011-06-15 23:02:42 +00002823
2824 // Keep track of the current cleanup stack depth.
2825 RunCleanupsScope Scope(*this);
John McCall3deb1ad2012-08-21 02:47:43 +00002826 if (CGM.getLangOpts().ObjCRuntime.hasNativeARC()) {
John McCall31168b02011-06-15 23:02:42 +00002827 llvm::Value *token = EmitObjCAutoreleasePoolPush();
2828 EHStack.pushCleanup<CallObjCAutoreleasePoolObject>(NormalCleanup, token);
2829 } else {
2830 llvm::Value *token = EmitObjCMRRAutoreleasePoolPush();
2831 EHStack.pushCleanup<CallObjCMRRAutoreleasePoolObject>(NormalCleanup, token);
2832 }
2833
2834 for (CompoundStmt::const_body_iterator I = S.body_begin(),
2835 E = S.body_end(); I != E; ++I)
2836 EmitStmt(*I);
2837
Eric Christopher7cdf9482011-10-13 21:45:18 +00002838 if (DI)
2839 DI->EmitLexicalBlockEnd(Builder, S.getRBracLoc());
John McCall31168b02011-06-15 23:02:42 +00002840}
John McCall1bd25562011-06-24 23:21:27 +00002841
2842/// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
2843/// make sure it survives garbage collection until this point.
2844void CodeGenFunction::EmitExtendGCLifetime(llvm::Value *object) {
2845 // We just use an inline assembly.
John McCall1bd25562011-06-24 23:21:27 +00002846 llvm::FunctionType *extenderType
John McCalla729c622012-02-17 03:33:10 +00002847 = llvm::FunctionType::get(VoidTy, VoidPtrTy, RequiredArgs::All);
John McCall1bd25562011-06-24 23:21:27 +00002848 llvm::Value *extender
2849 = llvm::InlineAsm::get(extenderType,
2850 /* assembly */ "",
2851 /* constraints */ "r",
2852 /* side effects */ true);
2853
2854 object = Builder.CreateBitCast(object, VoidPtrTy);
John McCall882987f2013-02-28 19:01:20 +00002855 EmitNounwindRuntimeCall(extender, object);
John McCall1bd25562011-06-24 23:21:27 +00002856}
2857
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00002858/// GenerateObjCAtomicSetterCopyHelperFunction - Given a c++ object type with
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00002859/// non-trivial copy assignment function, produce following helper function.
2860/// static void copyHelper(Ty *dest, const Ty *source) { *dest = *source; }
2861///
2862llvm::Constant *
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00002863CodeGenFunction::GenerateObjCAtomicSetterCopyHelperFunction(
2864 const ObjCPropertyImplDecl *PID) {
John McCall5fb5df92012-06-20 06:18:46 +00002865 if (!getLangOpts().CPlusPlus ||
Rafael Espindolad727d3d2012-12-18 04:29:34 +00002866 !getLangOpts().ObjCRuntime.hasAtomicCopyHelper())
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00002867 return 0;
2868 QualType Ty = PID->getPropertyIvarDecl()->getType();
2869 if (!Ty->isRecordType())
2870 return 0;
2871 const ObjCPropertyDecl *PD = PID->getPropertyDecl();
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00002872 if ((!(PD->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_atomic)))
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00002873 return 0;
Fariborz Jahanian1bed4132012-01-08 19:13:23 +00002874 llvm::Constant * HelperFn = 0;
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00002875 if (hasTrivialSetExpr(PID))
2876 return 0;
2877 assert(PID->getSetterCXXAssignment() && "SetterCXXAssignment - null");
2878 if ((HelperFn = CGM.getAtomicSetterHelperFnMap(Ty)))
2879 return HelperFn;
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00002880
2881 ASTContext &C = getContext();
2882 IdentifierInfo *II
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00002883 = &CGM.getContext().Idents.get("__assign_helper_atomic_property_");
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00002884 FunctionDecl *FD = FunctionDecl::Create(C,
2885 C.getTranslationUnitDecl(),
2886 SourceLocation(),
2887 SourceLocation(), II, C.VoidTy, 0,
2888 SC_Static,
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00002889 false,
Eric Christopher0b1aef22012-04-12 02:16:49 +00002890 false);
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00002891
2892 QualType DestTy = C.getPointerType(Ty);
2893 QualType SrcTy = Ty;
2894 SrcTy.addConst();
2895 SrcTy = C.getPointerType(SrcTy);
2896
2897 FunctionArgList args;
2898 ImplicitParamDecl dstDecl(FD, SourceLocation(), 0, DestTy);
2899 args.push_back(&dstDecl);
2900 ImplicitParamDecl srcDecl(FD, SourceLocation(), 0, SrcTy);
2901 args.push_back(&srcDecl);
2902
2903 const CGFunctionInfo &FI =
John McCalla729c622012-02-17 03:33:10 +00002904 CGM.getTypes().arrangeFunctionDeclaration(C.VoidTy, args,
2905 FunctionType::ExtInfo(),
2906 RequiredArgs::All);
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00002907
John McCalla729c622012-02-17 03:33:10 +00002908 llvm::FunctionType *LTy = CGM.getTypes().GetFunctionType(FI);
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00002909
2910 llvm::Function *Fn =
2911 llvm::Function::Create(LTy, llvm::GlobalValue::InternalLinkage,
Eric Christopher5d2b8d92012-03-29 17:31:31 +00002912 "__assign_helper_atomic_property_",
2913 &CGM.getModule());
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00002914
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00002915 StartFunction(FD, C.VoidTy, Fn, FI, args, SourceLocation());
2916
John McCall113bee02012-03-10 09:33:50 +00002917 DeclRefExpr DstExpr(&dstDecl, false, DestTy,
2918 VK_RValue, SourceLocation());
2919 UnaryOperator DST(&DstExpr, UO_Deref, DestTy->getPointeeType(),
2920 VK_LValue, OK_Ordinary, SourceLocation());
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00002921
John McCall113bee02012-03-10 09:33:50 +00002922 DeclRefExpr SrcExpr(&srcDecl, false, SrcTy,
2923 VK_RValue, SourceLocation());
2924 UnaryOperator SRC(&SrcExpr, UO_Deref, SrcTy->getPointeeType(),
2925 VK_LValue, OK_Ordinary, SourceLocation());
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00002926
John McCall113bee02012-03-10 09:33:50 +00002927 Expr *Args[2] = { &DST, &SRC };
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00002928 CallExpr *CalleeExp = cast<CallExpr>(PID->getSetterCXXAssignment());
John McCall113bee02012-03-10 09:33:50 +00002929 CXXOperatorCallExpr TheCall(C, OO_Equal, CalleeExp->getCallee(),
Benjamin Kramerc215e762012-08-24 11:54:20 +00002930 Args, DestTy->getPointeeType(),
Lang Hames5de91cc2012-10-02 04:45:10 +00002931 VK_LValue, SourceLocation(), false);
John McCall113bee02012-03-10 09:33:50 +00002932
2933 EmitStmt(&TheCall);
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00002934
2935 FinishFunction();
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00002936 HelperFn = llvm::ConstantExpr::getBitCast(Fn, VoidPtrTy);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00002937 CGM.setAtomicSetterHelperFnMap(Ty, HelperFn);
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00002938 return HelperFn;
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00002939}
2940
2941llvm::Constant *
2942CodeGenFunction::GenerateObjCAtomicGetterCopyHelperFunction(
2943 const ObjCPropertyImplDecl *PID) {
John McCall5fb5df92012-06-20 06:18:46 +00002944 if (!getLangOpts().CPlusPlus ||
Rafael Espindolad727d3d2012-12-18 04:29:34 +00002945 !getLangOpts().ObjCRuntime.hasAtomicCopyHelper())
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00002946 return 0;
2947 const ObjCPropertyDecl *PD = PID->getPropertyDecl();
2948 QualType Ty = PD->getType();
2949 if (!Ty->isRecordType())
2950 return 0;
2951 if ((!(PD->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_atomic)))
2952 return 0;
2953 llvm::Constant * HelperFn = 0;
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00002954
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00002955 if (hasTrivialGetExpr(PID))
2956 return 0;
2957 assert(PID->getGetterCXXConstructor() && "getGetterCXXConstructor - null");
2958 if ((HelperFn = CGM.getAtomicGetterHelperFnMap(Ty)))
2959 return HelperFn;
2960
2961
2962 ASTContext &C = getContext();
2963 IdentifierInfo *II
2964 = &CGM.getContext().Idents.get("__copy_helper_atomic_property_");
2965 FunctionDecl *FD = FunctionDecl::Create(C,
2966 C.getTranslationUnitDecl(),
2967 SourceLocation(),
2968 SourceLocation(), II, C.VoidTy, 0,
2969 SC_Static,
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00002970 false,
Eric Christopher0b1aef22012-04-12 02:16:49 +00002971 false);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00002972
2973 QualType DestTy = C.getPointerType(Ty);
2974 QualType SrcTy = Ty;
2975 SrcTy.addConst();
2976 SrcTy = C.getPointerType(SrcTy);
2977
2978 FunctionArgList args;
2979 ImplicitParamDecl dstDecl(FD, SourceLocation(), 0, DestTy);
2980 args.push_back(&dstDecl);
2981 ImplicitParamDecl srcDecl(FD, SourceLocation(), 0, SrcTy);
2982 args.push_back(&srcDecl);
2983
2984 const CGFunctionInfo &FI =
John McCalla729c622012-02-17 03:33:10 +00002985 CGM.getTypes().arrangeFunctionDeclaration(C.VoidTy, args,
2986 FunctionType::ExtInfo(),
2987 RequiredArgs::All);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00002988
John McCalla729c622012-02-17 03:33:10 +00002989 llvm::FunctionType *LTy = CGM.getTypes().GetFunctionType(FI);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00002990
2991 llvm::Function *Fn =
2992 llvm::Function::Create(LTy, llvm::GlobalValue::InternalLinkage,
2993 "__copy_helper_atomic_property_", &CGM.getModule());
2994
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00002995 StartFunction(FD, C.VoidTy, Fn, FI, args, SourceLocation());
2996
John McCall113bee02012-03-10 09:33:50 +00002997 DeclRefExpr SrcExpr(&srcDecl, false, SrcTy,
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00002998 VK_RValue, SourceLocation());
2999
John McCall113bee02012-03-10 09:33:50 +00003000 UnaryOperator SRC(&SrcExpr, UO_Deref, SrcTy->getPointeeType(),
3001 VK_LValue, OK_Ordinary, SourceLocation());
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003002
3003 CXXConstructExpr *CXXConstExpr =
3004 cast<CXXConstructExpr>(PID->getGetterCXXConstructor());
3005
3006 SmallVector<Expr*, 4> ConstructorArgs;
John McCall113bee02012-03-10 09:33:50 +00003007 ConstructorArgs.push_back(&SRC);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003008 CXXConstructExpr::arg_iterator A = CXXConstExpr->arg_begin();
3009 ++A;
3010
3011 for (CXXConstructExpr::arg_iterator AEnd = CXXConstExpr->arg_end();
3012 A != AEnd; ++A)
3013 ConstructorArgs.push_back(*A);
3014
3015 CXXConstructExpr *TheCXXConstructExpr =
3016 CXXConstructExpr::Create(C, Ty, SourceLocation(),
3017 CXXConstExpr->getConstructor(),
3018 CXXConstExpr->isElidable(),
Benjamin Kramerc215e762012-08-24 11:54:20 +00003019 ConstructorArgs,
Sebastian Redla9351792012-02-11 23:51:47 +00003020 CXXConstExpr->hadMultipleCandidates(),
3021 CXXConstExpr->isListInitialization(),
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003022 CXXConstExpr->requiresZeroInitialization(),
Eric Christopher5d2b8d92012-03-29 17:31:31 +00003023 CXXConstExpr->getConstructionKind(),
3024 SourceRange());
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003025
John McCall113bee02012-03-10 09:33:50 +00003026 DeclRefExpr DstExpr(&dstDecl, false, DestTy,
3027 VK_RValue, SourceLocation());
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003028
John McCall113bee02012-03-10 09:33:50 +00003029 RValue DV = EmitAnyExpr(&DstExpr);
Eric Christopher5d2b8d92012-03-29 17:31:31 +00003030 CharUnits Alignment
3031 = getContext().getTypeAlignInChars(TheCXXConstructExpr->getType());
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003032 EmitAggExpr(TheCXXConstructExpr,
3033 AggValueSlot::forAddr(DV.getScalarVal(), Alignment, Qualifiers(),
3034 AggValueSlot::IsDestructed,
3035 AggValueSlot::DoesNotNeedGCBarriers,
Chad Rosier615ed1a2012-03-29 17:37:10 +00003036 AggValueSlot::IsNotAliased));
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003037
3038 FinishFunction();
3039 HelperFn = llvm::ConstantExpr::getBitCast(Fn, VoidPtrTy);
3040 CGM.setAtomicGetterHelperFnMap(Ty, HelperFn);
3041 return HelperFn;
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003042}
3043
Eli Friedmanec75fec2012-02-28 01:08:45 +00003044llvm::Value *
3045CodeGenFunction::EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty) {
3046 // Get selectors for retain/autorelease.
Eli Friedmanc4e5d0c2012-03-01 22:52:28 +00003047 IdentifierInfo *CopyID = &getContext().Idents.get("copy");
3048 Selector CopySelector =
3049 getContext().Selectors.getNullarySelector(CopyID);
Eli Friedmanec75fec2012-02-28 01:08:45 +00003050 IdentifierInfo *AutoreleaseID = &getContext().Idents.get("autorelease");
3051 Selector AutoreleaseSelector =
3052 getContext().Selectors.getNullarySelector(AutoreleaseID);
3053
3054 // Emit calls to retain/autorelease.
3055 CGObjCRuntime &Runtime = CGM.getObjCRuntime();
3056 llvm::Value *Val = Block;
3057 RValue Result;
3058 Result = Runtime.GenerateMessageSend(*this, ReturnValueSlot(),
Eli Friedmanc4e5d0c2012-03-01 22:52:28 +00003059 Ty, CopySelector,
Eli Friedmanec75fec2012-02-28 01:08:45 +00003060 Val, CallArgList(), 0, 0);
3061 Val = Result.getScalarVal();
3062 Result = Runtime.GenerateMessageSend(*this, ReturnValueSlot(),
3063 Ty, AutoreleaseSelector,
3064 Val, CallArgList(), 0, 0);
3065 Val = Result.getScalarVal();
3066 return Val;
3067}
3068
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003069
Ted Kremenek43e06332008-04-09 15:51:31 +00003070CGObjCRuntime::~CGObjCRuntime() {}