blob: 2e3bd5f7f17f0c3a35e396e30dcc48ce11220429 [file] [log] [blame]
Anders Carlsson55085182007-08-21 17:43:55 +00001//===---- CGBuiltin.cpp - Emit LLVM Code for builtins ---------------------===//
2//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner0bc735f2007-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 Carlsson55085182007-08-21 17:43:55 +00007//
8//===----------------------------------------------------------------------===//
9//
10// This contains code to emit Objective-C code as LLVM code.
11//
12//===----------------------------------------------------------------------===//
13
Devang Patelbcbd03a2011-01-19 01:36:36 +000014#include "CGDebugInfo.h"
Ted Kremenek2979ec72008-04-09 15:51:31 +000015#include "CGObjCRuntime.h"
Anders Carlsson55085182007-08-21 17:43:55 +000016#include "CodeGenFunction.h"
17#include "CodeGenModule.h"
John McCallf85e1932011-06-15 23:02:42 +000018#include "TargetInfo.h"
Daniel Dunbar85c59ed2008-08-29 08:11:39 +000019#include "clang/AST/ASTContext.h"
Daniel Dunbarc4a1dea2008-08-11 05:35:13 +000020#include "clang/AST/DeclObjC.h"
Chris Lattner16f00492009-04-26 01:32:48 +000021#include "clang/AST/StmtObjC.h"
Daniel Dunbare66f4e32008-09-03 00:27:26 +000022#include "clang/Basic/Diagnostic.h"
Anders Carlsson3d8400d2008-08-30 19:51:14 +000023#include "llvm/ADT/STLExtras.h"
Chandler Carruth3b844ba2013-01-02 11:45:17 +000024#include "llvm/IR/DataLayout.h"
25#include "llvm/IR/InlineAsm.h"
Anders Carlsson55085182007-08-21 17:43:55 +000026using namespace clang;
27using namespace CodeGen;
28
John McCallf85e1932011-06-15 23:02:42 +000029typedef llvm::PointerIntPair<llvm::Value*,1,bool> TryEmitResult;
30static TryEmitResult
31tryEmitARCRetainScalarExpr(CodeGenFunction &CGF, const Expr *e);
Ted Kremenekebcb57a2012-03-06 20:05:56 +000032static RValue AdjustRelatedResultType(CodeGenFunction &CGF,
Fariborz Jahanian490a52b2012-05-29 19:56:01 +000033 QualType ET,
Ted Kremenekebcb57a2012-03-06 20:05:56 +000034 const ObjCMethodDecl *Method,
35 RValue Result);
John McCallf85e1932011-06-15 23:02:42 +000036
37/// Given the address of a variable of pointer type, find the correct
38/// null to store into it.
39static llvm::Constant *getNullForVariable(llvm::Value *addr) {
Chris Lattner2acc6e32011-07-18 04:24:23 +000040 llvm::Type *type =
John McCallf85e1932011-06-15 23:02:42 +000041 cast<llvm::PointerType>(addr->getType())->getElementType();
42 return llvm::ConstantPointerNull::get(cast<llvm::PointerType>(type));
43}
44
Chris Lattner8fdf3282008-06-24 17:04:18 +000045/// Emits an instance of NSConstantString representing the object.
Mike Stump1eb44332009-09-09 15:08:12 +000046llvm::Value *CodeGenFunction::EmitObjCStringLiteral(const ObjCStringLiteral *E)
Daniel Dunbar71fcec92008-11-25 21:53:21 +000047{
David Chisnall0d13f6f2010-01-23 02:40:42 +000048 llvm::Constant *C =
49 CGM.getObjCRuntime().GenerateConstantString(E->getString());
Daniel Dunbared7c6182008-08-20 00:28:19 +000050 // FIXME: This bitcast should just be made an invariant on the Runtime.
Owen Anderson3c4972d2009-07-29 18:54:39 +000051 return llvm::ConstantExpr::getBitCast(C, ConvertType(E->getType()));
Chris Lattner8fdf3282008-06-24 17:04:18 +000052}
53
Patrick Beardeb382ec2012-04-19 00:25:12 +000054/// EmitObjCBoxedExpr - This routine generates code to call
55/// the appropriate expression boxing method. This will either be
56/// one of +[NSNumber numberWith<Type>:], or +[NSString stringWithUTF8String:].
Ted Kremenekebcb57a2012-03-06 20:05:56 +000057///
Eric Christopher16098f32012-03-29 17:31:31 +000058llvm::Value *
Patrick Beardeb382ec2012-04-19 00:25:12 +000059CodeGenFunction::EmitObjCBoxedExpr(const ObjCBoxedExpr *E) {
Ted Kremenekebcb57a2012-03-06 20:05:56 +000060 // Generate the correct selector for this literal's concrete type.
Patrick Beardeb382ec2012-04-19 00:25:12 +000061 const Expr *SubExpr = E->getSubExpr();
Ted Kremenekebcb57a2012-03-06 20:05:56 +000062 // Get the method.
Patrick Beardeb382ec2012-04-19 00:25:12 +000063 const ObjCMethodDecl *BoxingMethod = E->getBoxingMethod();
64 assert(BoxingMethod && "BoxingMethod is null");
65 assert(BoxingMethod->isClassMethod() && "BoxingMethod must be a class method");
66 Selector Sel = BoxingMethod->getSelector();
Ted Kremenekebcb57a2012-03-06 20:05:56 +000067
68 // Generate a reference to the class pointer, which will be the receiver.
Patrick Beardeb382ec2012-04-19 00:25:12 +000069 // Assumes that the method was introduced in the class that should be
70 // messaged (avoids pulling it out of the result type).
Ted Kremenekebcb57a2012-03-06 20:05:56 +000071 CGObjCRuntime &Runtime = CGM.getObjCRuntime();
Patrick Beardeb382ec2012-04-19 00:25:12 +000072 const ObjCInterfaceDecl *ClassDecl = BoxingMethod->getClassInterface();
John McCallbd7370a2013-02-28 19:01:20 +000073 llvm::Value *Receiver = Runtime.GetClass(*this, ClassDecl);
Patrick Beardeb382ec2012-04-19 00:25:12 +000074
75 const ParmVarDecl *argDecl = *BoxingMethod->param_begin();
Ted Kremenekebcb57a2012-03-06 20:05:56 +000076 QualType ArgQT = argDecl->getType().getUnqualifiedType();
Patrick Beardeb382ec2012-04-19 00:25:12 +000077 RValue RV = EmitAnyExpr(SubExpr);
Ted Kremenekebcb57a2012-03-06 20:05:56 +000078 CallArgList Args;
79 Args.add(RV, ArgQT);
Patrick Beardeb382ec2012-04-19 00:25:12 +000080
Ted Kremenekebcb57a2012-03-06 20:05:56 +000081 RValue result = Runtime.GenerateMessageSend(*this, ReturnValueSlot(),
Patrick Beardeb382ec2012-04-19 00:25:12 +000082 BoxingMethod->getResultType(), Sel, Receiver, Args,
83 ClassDecl, BoxingMethod);
Ted Kremenekebcb57a2012-03-06 20:05:56 +000084 return Builder.CreateBitCast(result.getScalarVal(),
85 ConvertType(E->getType()));
86}
87
88llvm::Value *CodeGenFunction::EmitObjCCollectionLiteral(const Expr *E,
89 const ObjCMethodDecl *MethodWithObjects) {
90 ASTContext &Context = CGM.getContext();
91 const ObjCDictionaryLiteral *DLE = 0;
92 const ObjCArrayLiteral *ALE = dyn_cast<ObjCArrayLiteral>(E);
93 if (!ALE)
94 DLE = cast<ObjCDictionaryLiteral>(E);
95
96 // Compute the type of the array we're initializing.
97 uint64_t NumElements =
98 ALE ? ALE->getNumElements() : DLE->getNumElements();
99 llvm::APInt APNumElements(Context.getTypeSize(Context.getSizeType()),
100 NumElements);
101 QualType ElementType = Context.getObjCIdType().withConst();
102 QualType ElementArrayType
103 = Context.getConstantArrayType(ElementType, APNumElements,
104 ArrayType::Normal, /*IndexTypeQuals=*/0);
105
106 // Allocate the temporary array(s).
107 llvm::Value *Objects = CreateMemTemp(ElementArrayType, "objects");
108 llvm::Value *Keys = 0;
109 if (DLE)
110 Keys = CreateMemTemp(ElementArrayType, "keys");
111
112 // Perform the actual initialialization of the array(s).
113 for (uint64_t i = 0; i < NumElements; i++) {
114 if (ALE) {
115 // Emit the initializer.
116 const Expr *Rhs = ALE->getElement(i);
117 LValue LV = LValue::MakeAddr(Builder.CreateStructGEP(Objects, i),
118 ElementType,
119 Context.getTypeAlignInChars(Rhs->getType()),
120 Context);
121 EmitScalarInit(Rhs, /*D=*/0, LV, /*capturedByInit=*/false);
122 } else {
123 // Emit the key initializer.
124 const Expr *Key = DLE->getKeyValueElement(i).Key;
125 LValue KeyLV = LValue::MakeAddr(Builder.CreateStructGEP(Keys, i),
126 ElementType,
127 Context.getTypeAlignInChars(Key->getType()),
128 Context);
129 EmitScalarInit(Key, /*D=*/0, KeyLV, /*capturedByInit=*/false);
130
131 // Emit the value initializer.
132 const Expr *Value = DLE->getKeyValueElement(i).Value;
133 LValue ValueLV = LValue::MakeAddr(Builder.CreateStructGEP(Objects, i),
134 ElementType,
135 Context.getTypeAlignInChars(Value->getType()),
136 Context);
137 EmitScalarInit(Value, /*D=*/0, ValueLV, /*capturedByInit=*/false);
138 }
139 }
140
141 // Generate the argument list.
142 CallArgList Args;
143 ObjCMethodDecl::param_const_iterator PI = MethodWithObjects->param_begin();
144 const ParmVarDecl *argDecl = *PI++;
145 QualType ArgQT = argDecl->getType().getUnqualifiedType();
146 Args.add(RValue::get(Objects), ArgQT);
147 if (DLE) {
148 argDecl = *PI++;
149 ArgQT = argDecl->getType().getUnqualifiedType();
150 Args.add(RValue::get(Keys), ArgQT);
151 }
152 argDecl = *PI;
153 ArgQT = argDecl->getType().getUnqualifiedType();
154 llvm::Value *Count =
155 llvm::ConstantInt::get(CGM.getTypes().ConvertType(ArgQT), NumElements);
156 Args.add(RValue::get(Count), ArgQT);
157
158 // Generate a reference to the class pointer, which will be the receiver.
159 Selector Sel = MethodWithObjects->getSelector();
160 QualType ResultType = E->getType();
161 const ObjCObjectPointerType *InterfacePointerType
162 = ResultType->getAsObjCInterfacePointerType();
163 ObjCInterfaceDecl *Class
164 = InterfacePointerType->getObjectType()->getInterface();
165 CGObjCRuntime &Runtime = CGM.getObjCRuntime();
John McCallbd7370a2013-02-28 19:01:20 +0000166 llvm::Value *Receiver = Runtime.GetClass(*this, Class);
Ted Kremenekebcb57a2012-03-06 20:05:56 +0000167
168 // Generate the message send.
Eric Christopher16098f32012-03-29 17:31:31 +0000169 RValue result
170 = Runtime.GenerateMessageSend(*this, ReturnValueSlot(),
171 MethodWithObjects->getResultType(),
172 Sel,
173 Receiver, Args, Class,
174 MethodWithObjects);
Ted Kremenekebcb57a2012-03-06 20:05:56 +0000175 return Builder.CreateBitCast(result.getScalarVal(),
176 ConvertType(E->getType()));
177}
178
179llvm::Value *CodeGenFunction::EmitObjCArrayLiteral(const ObjCArrayLiteral *E) {
180 return EmitObjCCollectionLiteral(E, E->getArrayWithObjectsMethod());
181}
182
183llvm::Value *CodeGenFunction::EmitObjCDictionaryLiteral(
184 const ObjCDictionaryLiteral *E) {
185 return EmitObjCCollectionLiteral(E, E->getDictWithObjectsMethod());
186}
187
Chris Lattner8fdf3282008-06-24 17:04:18 +0000188/// Emit a selector.
189llvm::Value *CodeGenFunction::EmitObjCSelectorExpr(const ObjCSelectorExpr *E) {
190 // Untyped selector.
191 // Note that this implementation allows for non-constant strings to be passed
192 // as arguments to @selector(). Currently, the only thing preventing this
193 // behaviour is the type checking in the front end.
John McCallbd7370a2013-02-28 19:01:20 +0000194 return CGM.getObjCRuntime().GetSelector(*this, E->getSelector());
Chris Lattner8fdf3282008-06-24 17:04:18 +0000195}
196
Daniel Dunbared7c6182008-08-20 00:28:19 +0000197llvm::Value *CodeGenFunction::EmitObjCProtocolExpr(const ObjCProtocolExpr *E) {
198 // FIXME: This should pass the Decl not the name.
John McCallbd7370a2013-02-28 19:01:20 +0000199 return CGM.getObjCRuntime().GenerateProtocolRef(*this, E->getProtocol());
Daniel Dunbared7c6182008-08-20 00:28:19 +0000200}
Chris Lattner8fdf3282008-06-24 17:04:18 +0000201
Douglas Gregor926df6c2011-06-11 01:09:30 +0000202/// \brief Adjust the type of the result of an Objective-C message send
203/// expression when the method has a related result type.
204static RValue AdjustRelatedResultType(CodeGenFunction &CGF,
Fariborz Jahanian490a52b2012-05-29 19:56:01 +0000205 QualType ExpT,
Douglas Gregor926df6c2011-06-11 01:09:30 +0000206 const ObjCMethodDecl *Method,
207 RValue Result) {
208 if (!Method)
209 return Result;
John McCallf85e1932011-06-15 23:02:42 +0000210
Douglas Gregor926df6c2011-06-11 01:09:30 +0000211 if (!Method->hasRelatedResultType() ||
Fariborz Jahanian490a52b2012-05-29 19:56:01 +0000212 CGF.getContext().hasSameType(ExpT, Method->getResultType()) ||
Douglas Gregor926df6c2011-06-11 01:09:30 +0000213 !Result.isScalar())
214 return Result;
215
216 // We have applied a related result type. Cast the rvalue appropriately.
217 return RValue::get(CGF.Builder.CreateBitCast(Result.getScalarVal(),
Fariborz Jahanian490a52b2012-05-29 19:56:01 +0000218 CGF.ConvertType(ExpT)));
Douglas Gregor926df6c2011-06-11 01:09:30 +0000219}
Chris Lattner8fdf3282008-06-24 17:04:18 +0000220
John McCalldc7c5ad2011-07-22 08:53:00 +0000221/// Decide whether to extend the lifetime of the receiver of a
222/// returns-inner-pointer message.
223static bool
224shouldExtendReceiverForInnerPointerMessage(const ObjCMessageExpr *message) {
225 switch (message->getReceiverKind()) {
226
227 // For a normal instance message, we should extend unless the
228 // receiver is loaded from a variable with precise lifetime.
229 case ObjCMessageExpr::Instance: {
230 const Expr *receiver = message->getInstanceReceiver();
231 const ImplicitCastExpr *ice = dyn_cast<ImplicitCastExpr>(receiver);
232 if (!ice || ice->getCastKind() != CK_LValueToRValue) return true;
233 receiver = ice->getSubExpr()->IgnoreParens();
234
235 // Only __strong variables.
236 if (receiver->getType().getObjCLifetime() != Qualifiers::OCL_Strong)
237 return true;
238
239 // All ivars and fields have precise lifetime.
240 if (isa<MemberExpr>(receiver) || isa<ObjCIvarRefExpr>(receiver))
241 return false;
242
243 // Otherwise, check for variables.
244 const DeclRefExpr *declRef = dyn_cast<DeclRefExpr>(ice->getSubExpr());
245 if (!declRef) return true;
246 const VarDecl *var = dyn_cast<VarDecl>(declRef->getDecl());
247 if (!var) return true;
248
249 // All variables have precise lifetime except local variables with
250 // automatic storage duration that aren't specially marked.
251 return (var->hasLocalStorage() &&
252 !var->hasAttr<ObjCPreciseLifetimeAttr>());
253 }
254
255 case ObjCMessageExpr::Class:
256 case ObjCMessageExpr::SuperClass:
257 // It's never necessary for class objects.
258 return false;
259
260 case ObjCMessageExpr::SuperInstance:
261 // We generally assume that 'self' lives throughout a method call.
262 return false;
263 }
264
265 llvm_unreachable("invalid receiver kind");
266}
267
John McCallef072fd2010-05-22 01:48:05 +0000268RValue CodeGenFunction::EmitObjCMessageExpr(const ObjCMessageExpr *E,
269 ReturnValueSlot Return) {
Chris Lattner8fdf3282008-06-24 17:04:18 +0000270 // Only the lookup mechanism and first two arguments of the method
271 // implementation vary between runtimes. We can get the receiver and
272 // arguments in generic code.
Mike Stump1eb44332009-09-09 15:08:12 +0000273
John McCallf85e1932011-06-15 23:02:42 +0000274 bool isDelegateInit = E->isDelegateInitCall();
275
John McCalldc7c5ad2011-07-22 08:53:00 +0000276 const ObjCMethodDecl *method = E->getMethodDecl();
Fariborz Jahanian4e1524b2012-01-29 20:27:13 +0000277
John McCallf85e1932011-06-15 23:02:42 +0000278 // We don't retain the receiver in delegate init calls, and this is
279 // safe because the receiver value is always loaded from 'self',
280 // which we zero out. We don't want to Block_copy block receivers,
281 // though.
282 bool retainSelf =
283 (!isDelegateInit &&
David Blaikie4e4d0842012-03-11 07:00:24 +0000284 CGM.getLangOpts().ObjCAutoRefCount &&
John McCalldc7c5ad2011-07-22 08:53:00 +0000285 method &&
286 method->hasAttr<NSConsumesSelfAttr>());
John McCallf85e1932011-06-15 23:02:42 +0000287
Daniel Dunbar208ff5e2008-08-11 18:12:00 +0000288 CGObjCRuntime &Runtime = CGM.getObjCRuntime();
Chris Lattner8fdf3282008-06-24 17:04:18 +0000289 bool isSuperMessage = false;
Daniel Dunbarf56f1912008-08-25 08:19:24 +0000290 bool isClassMessage = false;
David Chisnallc6cd5fd2010-04-28 19:33:36 +0000291 ObjCInterfaceDecl *OID = 0;
Chris Lattner8fdf3282008-06-24 17:04:18 +0000292 // Find the receiver
Douglas Gregor926df6c2011-06-11 01:09:30 +0000293 QualType ReceiverType;
Daniel Dunbar0b647a62010-04-22 03:17:06 +0000294 llvm::Value *Receiver = 0;
Douglas Gregor04badcf2010-04-21 00:45:42 +0000295 switch (E->getReceiverKind()) {
296 case ObjCMessageExpr::Instance:
Douglas Gregor926df6c2011-06-11 01:09:30 +0000297 ReceiverType = E->getInstanceReceiver()->getType();
John McCallf85e1932011-06-15 23:02:42 +0000298 if (retainSelf) {
299 TryEmitResult ter = tryEmitARCRetainScalarExpr(*this,
300 E->getInstanceReceiver());
301 Receiver = ter.getPointer();
John McCalldc7c5ad2011-07-22 08:53:00 +0000302 if (ter.getInt()) retainSelf = false;
John McCallf85e1932011-06-15 23:02:42 +0000303 } else
304 Receiver = EmitScalarExpr(E->getInstanceReceiver());
Douglas Gregor04badcf2010-04-21 00:45:42 +0000305 break;
Daniel Dunbarddb2a3d2008-08-16 00:25:02 +0000306
Douglas Gregor04badcf2010-04-21 00:45:42 +0000307 case ObjCMessageExpr::Class: {
Douglas Gregor926df6c2011-06-11 01:09:30 +0000308 ReceiverType = E->getClassReceiver();
309 const ObjCObjectType *ObjTy = ReceiverType->getAs<ObjCObjectType>();
John McCall3031c632010-05-17 20:12:43 +0000310 assert(ObjTy && "Invalid Objective-C class message send");
311 OID = ObjTy->getInterface();
312 assert(OID && "Invalid Objective-C class message send");
John McCallbd7370a2013-02-28 19:01:20 +0000313 Receiver = Runtime.GetClass(*this, OID);
Daniel Dunbarf56f1912008-08-25 08:19:24 +0000314 isClassMessage = true;
Douglas Gregor04badcf2010-04-21 00:45:42 +0000315 break;
316 }
317
318 case ObjCMessageExpr::SuperInstance:
Douglas Gregor926df6c2011-06-11 01:09:30 +0000319 ReceiverType = E->getSuperType();
Chris Lattner8fdf3282008-06-24 17:04:18 +0000320 Receiver = LoadObjCSelf();
Douglas Gregor04badcf2010-04-21 00:45:42 +0000321 isSuperMessage = true;
322 break;
323
324 case ObjCMessageExpr::SuperClass:
Douglas Gregor926df6c2011-06-11 01:09:30 +0000325 ReceiverType = E->getSuperType();
Douglas Gregor04badcf2010-04-21 00:45:42 +0000326 Receiver = LoadObjCSelf();
327 isSuperMessage = true;
328 isClassMessage = true;
329 break;
Chris Lattner8fdf3282008-06-24 17:04:18 +0000330 }
331
John McCalldc7c5ad2011-07-22 08:53:00 +0000332 if (retainSelf)
333 Receiver = EmitARCRetainNonBlock(Receiver);
334
335 // In ARC, we sometimes want to "extend the lifetime"
336 // (i.e. retain+autorelease) of receivers of returns-inner-pointer
337 // messages.
David Blaikie4e4d0842012-03-11 07:00:24 +0000338 if (getLangOpts().ObjCAutoRefCount && method &&
John McCalldc7c5ad2011-07-22 08:53:00 +0000339 method->hasAttr<ObjCReturnsInnerPointerAttr>() &&
340 shouldExtendReceiverForInnerPointerMessage(E))
341 Receiver = EmitARCRetainAutorelease(ReceiverType, Receiver);
342
John McCallf85e1932011-06-15 23:02:42 +0000343 QualType ResultType =
John McCalldc7c5ad2011-07-22 08:53:00 +0000344 method ? method->getResultType() : E->getType();
John McCallf85e1932011-06-15 23:02:42 +0000345
Daniel Dunbar19cd87e2008-08-30 03:02:31 +0000346 CallArgList Args;
John McCalldc7c5ad2011-07-22 08:53:00 +0000347 EmitCallArgs(Args, method, E->arg_begin(), E->arg_end());
Mike Stump1eb44332009-09-09 15:08:12 +0000348
John McCallf85e1932011-06-15 23:02:42 +0000349 // For delegate init calls in ARC, do an unsafe store of null into
350 // self. This represents the call taking direct ownership of that
351 // value. We have to do this after emitting the other call
352 // arguments because they might also reference self, but we don't
353 // have to worry about any of them modifying self because that would
354 // be an undefined read and write of an object in unordered
355 // expressions.
356 if (isDelegateInit) {
David Blaikie4e4d0842012-03-11 07:00:24 +0000357 assert(getLangOpts().ObjCAutoRefCount &&
John McCallf85e1932011-06-15 23:02:42 +0000358 "delegate init calls should only be marked in ARC");
359
360 // Do an unsafe store of null into self.
361 llvm::Value *selfAddr =
362 LocalDeclMap[cast<ObjCMethodDecl>(CurCodeDecl)->getSelfDecl()];
363 assert(selfAddr && "no self entry for a delegate init call?");
364
365 Builder.CreateStore(getNullForVariable(selfAddr), selfAddr);
366 }
Anders Carlsson7e70fb22010-06-21 20:59:55 +0000367
Douglas Gregor926df6c2011-06-11 01:09:30 +0000368 RValue result;
Chris Lattner8fdf3282008-06-24 17:04:18 +0000369 if (isSuperMessage) {
Chris Lattner9384c762008-06-26 04:42:20 +0000370 // super is only valid in an Objective-C method
371 const ObjCMethodDecl *OMD = cast<ObjCMethodDecl>(CurFuncDecl);
Fariborz Jahanian7ce77922009-02-28 20:07:56 +0000372 bool isCategoryImpl = isa<ObjCCategoryImplDecl>(OMD->getDeclContext());
Douglas Gregor926df6c2011-06-11 01:09:30 +0000373 result = Runtime.GenerateMessageSendSuper(*this, Return, ResultType,
374 E->getSelector(),
375 OMD->getClassInterface(),
376 isCategoryImpl,
377 Receiver,
378 isClassMessage,
379 Args,
John McCalldc7c5ad2011-07-22 08:53:00 +0000380 method);
Douglas Gregor926df6c2011-06-11 01:09:30 +0000381 } else {
382 result = Runtime.GenerateMessageSend(*this, Return, ResultType,
383 E->getSelector(),
384 Receiver, Args, OID,
John McCalldc7c5ad2011-07-22 08:53:00 +0000385 method);
Chris Lattner8fdf3282008-06-24 17:04:18 +0000386 }
John McCallf85e1932011-06-15 23:02:42 +0000387
388 // For delegate init calls in ARC, implicitly store the result of
389 // the call back into self. This takes ownership of the value.
390 if (isDelegateInit) {
391 llvm::Value *selfAddr =
392 LocalDeclMap[cast<ObjCMethodDecl>(CurCodeDecl)->getSelfDecl()];
393 llvm::Value *newSelf = result.getScalarVal();
394
395 // The delegate return type isn't necessarily a matching type; in
396 // fact, it's quite likely to be 'id'.
Chris Lattner2acc6e32011-07-18 04:24:23 +0000397 llvm::Type *selfTy =
John McCallf85e1932011-06-15 23:02:42 +0000398 cast<llvm::PointerType>(selfAddr->getType())->getElementType();
399 newSelf = Builder.CreateBitCast(newSelf, selfTy);
400
401 Builder.CreateStore(newSelf, selfAddr);
402 }
Fariborz Jahanian4e1524b2012-01-29 20:27:13 +0000403
Fariborz Jahanian490a52b2012-05-29 19:56:01 +0000404 return AdjustRelatedResultType(*this, E->getType(), method, result);
Anders Carlsson55085182007-08-21 17:43:55 +0000405}
406
John McCallf85e1932011-06-15 23:02:42 +0000407namespace {
408struct FinishARCDealloc : EHScopeStack::Cleanup {
John McCallad346f42011-07-12 20:27:29 +0000409 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCallf85e1932011-06-15 23:02:42 +0000410 const ObjCMethodDecl *method = cast<ObjCMethodDecl>(CGF.CurCodeDecl);
John McCall799d34e2011-07-13 18:26:47 +0000411
412 const ObjCImplDecl *impl = cast<ObjCImplDecl>(method->getDeclContext());
John McCallf85e1932011-06-15 23:02:42 +0000413 const ObjCInterfaceDecl *iface = impl->getClassInterface();
414 if (!iface->getSuperClass()) return;
415
John McCall799d34e2011-07-13 18:26:47 +0000416 bool isCategory = isa<ObjCCategoryImplDecl>(impl);
417
John McCallf85e1932011-06-15 23:02:42 +0000418 // Call [super dealloc] if we have a superclass.
419 llvm::Value *self = CGF.LoadObjCSelf();
420
421 CallArgList args;
422 CGF.CGM.getObjCRuntime().GenerateMessageSendSuper(CGF, ReturnValueSlot(),
423 CGF.getContext().VoidTy,
424 method->getSelector(),
425 iface,
John McCall799d34e2011-07-13 18:26:47 +0000426 isCategory,
John McCallf85e1932011-06-15 23:02:42 +0000427 self,
428 /*is class msg*/ false,
429 args,
430 method);
431 }
432};
433}
434
Daniel Dunbaraf05bb92008-08-26 08:29:31 +0000435/// StartObjCMethod - Begin emission of an ObjCMethod. This generates
436/// the LLVM function and sets the other context used by
437/// CodeGenFunction.
Fariborz Jahanian679a5022009-01-10 21:06:09 +0000438void CodeGenFunction::StartObjCMethod(const ObjCMethodDecl *OMD,
Devang Patel8d3f8972011-05-19 23:37:41 +0000439 const ObjCContainerDecl *CD,
440 SourceLocation StartLoc) {
John McCalld26bc762011-03-09 04:27:21 +0000441 FunctionArgList args;
Devang Patel4800ea62010-04-05 21:09:15 +0000442 // Check if we should generate debug info for this method.
Alexey Samsonova240df22012-10-16 07:22:28 +0000443 if (!OMD->hasAttr<NoDebugAttr>())
444 maybeInitializeDebugInfo();
Devang Patel4800ea62010-04-05 21:09:15 +0000445
Fariborz Jahanian679a5022009-01-10 21:06:09 +0000446 llvm::Function *Fn = CGM.getObjCRuntime().GenerateMethod(OMD, CD);
Daniel Dunbarf80519b2008-09-04 23:41:35 +0000447
John McCallde5d3c72012-02-17 03:33:10 +0000448 const CGFunctionInfo &FI = CGM.getTypes().arrangeObjCMethodDeclaration(OMD);
Daniel Dunbar0e4f40e2009-04-17 00:48:04 +0000449 CGM.SetInternalFunctionAttributes(OMD, Fn, FI);
Chris Lattner41110242008-06-17 18:05:57 +0000450
John McCalld26bc762011-03-09 04:27:21 +0000451 args.push_back(OMD->getSelfDecl());
452 args.push_back(OMD->getCmdDecl());
Chris Lattner41110242008-06-17 18:05:57 +0000453
Argyrios Kyrtzidis491306a2011-10-03 06:37:04 +0000454 for (ObjCMethodDecl::param_const_iterator PI = OMD->param_begin(),
Eric Christopher16098f32012-03-29 17:31:31 +0000455 E = OMD->param_end(); PI != E; ++PI)
John McCalld26bc762011-03-09 04:27:21 +0000456 args.push_back(*PI);
Chris Lattner41110242008-06-17 18:05:57 +0000457
Peter Collingbourne14110472011-01-13 18:57:25 +0000458 CurGD = OMD;
459
Devang Patel8d3f8972011-05-19 23:37:41 +0000460 StartFunction(OMD, OMD->getResultType(), Fn, FI, args, StartLoc);
John McCallf85e1932011-06-15 23:02:42 +0000461
462 // In ARC, certain methods get an extra cleanup.
David Blaikie4e4d0842012-03-11 07:00:24 +0000463 if (CGM.getLangOpts().ObjCAutoRefCount &&
John McCallf85e1932011-06-15 23:02:42 +0000464 OMD->isInstanceMethod() &&
465 OMD->getSelector().isUnarySelector()) {
466 const IdentifierInfo *ident =
467 OMD->getSelector().getIdentifierInfoForSlot(0);
468 if (ident->isStr("dealloc"))
469 EHStack.pushCleanup<FinishARCDealloc>(getARCCleanupKind());
470 }
Daniel Dunbaraf05bb92008-08-26 08:29:31 +0000471}
Daniel Dunbarb7ec2462008-08-16 03:19:19 +0000472
John McCallf85e1932011-06-15 23:02:42 +0000473static llvm::Value *emitARCRetainLoadOfScalar(CodeGenFunction &CGF,
474 LValue lvalue, QualType type);
475
Daniel Dunbaraf05bb92008-08-26 08:29:31 +0000476/// Generate an Objective-C method. An Objective-C method is a C function with
Mike Stump1eb44332009-09-09 15:08:12 +0000477/// its pointer, name, and types registered in the class struture.
Daniel Dunbaraf05bb92008-08-26 08:29:31 +0000478void CodeGenFunction::GenerateObjCMethod(const ObjCMethodDecl *OMD) {
Devang Patel8d3f8972011-05-19 23:37:41 +0000479 StartObjCMethod(OMD, OMD->getClassInterface(), OMD->getLocStart());
Argyrios Kyrtzidis6fb0aee2009-06-30 02:35:26 +0000480 EmitStmt(OMD->getBody());
481 FinishFunction(OMD->getBodyRBrace());
Daniel Dunbaraf05bb92008-08-26 08:29:31 +0000482}
483
John McCall41bdde92011-09-12 23:06:44 +0000484/// emitStructGetterCall - Call the runtime function to load a property
485/// into the return value slot.
486static void emitStructGetterCall(CodeGenFunction &CGF, ObjCIvarDecl *ivar,
487 bool isAtomic, bool hasStrong) {
488 ASTContext &Context = CGF.getContext();
489
490 llvm::Value *src =
491 CGF.EmitLValueForIvar(CGF.TypeOfSelfObject(), CGF.LoadObjCSelf(),
492 ivar, 0).getAddress();
493
494 // objc_copyStruct (ReturnValue, &structIvar,
495 // sizeof (Type of Ivar), isAtomic, false);
496 CallArgList args;
497
498 llvm::Value *dest = CGF.Builder.CreateBitCast(CGF.ReturnValue, CGF.VoidPtrTy);
499 args.add(RValue::get(dest), Context.VoidPtrTy);
500
501 src = CGF.Builder.CreateBitCast(src, CGF.VoidPtrTy);
502 args.add(RValue::get(src), Context.VoidPtrTy);
503
504 CharUnits size = CGF.getContext().getTypeSizeInChars(ivar->getType());
505 args.add(RValue::get(CGF.CGM.getSize(size)), Context.getSizeType());
506 args.add(RValue::get(CGF.Builder.getInt1(isAtomic)), Context.BoolTy);
507 args.add(RValue::get(CGF.Builder.getInt1(hasStrong)), Context.BoolTy);
508
509 llvm::Value *fn = CGF.CGM.getObjCRuntime().GetGetStructFunction();
John McCall0f3d0972012-07-07 06:41:13 +0000510 CGF.EmitCall(CGF.getTypes().arrangeFreeFunctionCall(Context.VoidTy, args,
511 FunctionType::ExtInfo(),
512 RequiredArgs::All),
John McCall41bdde92011-09-12 23:06:44 +0000513 fn, ReturnValueSlot(), args);
514}
515
John McCall1e1f4872011-09-13 03:34:09 +0000516/// Determine whether the given architecture supports unaligned atomic
517/// accesses. They don't have to be fast, just faster than a function
518/// call and a mutex.
519static bool hasUnalignedAtomics(llvm::Triple::ArchType arch) {
Eli Friedmande24d442011-09-13 20:48:30 +0000520 // FIXME: Allow unaligned atomic load/store on x86. (It is not
521 // currently supported by the backend.)
522 return 0;
John McCall1e1f4872011-09-13 03:34:09 +0000523}
524
525/// Return the maximum size that permits atomic accesses for the given
526/// architecture.
527static CharUnits getMaxAtomicAccessSize(CodeGenModule &CGM,
528 llvm::Triple::ArchType arch) {
529 // ARM has 8-byte atomic accesses, but it's not clear whether we
530 // want to rely on them here.
531
532 // In the default case, just assume that any size up to a pointer is
533 // fine given adequate alignment.
534 return CharUnits::fromQuantity(CGM.PointerSizeInBytes);
535}
536
537namespace {
538 class PropertyImplStrategy {
539 public:
540 enum StrategyKind {
541 /// The 'native' strategy is to use the architecture's provided
542 /// reads and writes.
543 Native,
544
545 /// Use objc_setProperty and objc_getProperty.
546 GetSetProperty,
547
548 /// Use objc_setProperty for the setter, but use expression
549 /// evaluation for the getter.
550 SetPropertyAndExpressionGet,
551
552 /// Use objc_copyStruct.
553 CopyStruct,
554
555 /// The 'expression' strategy is to emit normal assignment or
556 /// lvalue-to-rvalue expressions.
557 Expression
558 };
559
560 StrategyKind getKind() const { return StrategyKind(Kind); }
561
562 bool hasStrongMember() const { return HasStrong; }
563 bool isAtomic() const { return IsAtomic; }
564 bool isCopy() const { return IsCopy; }
565
566 CharUnits getIvarSize() const { return IvarSize; }
567 CharUnits getIvarAlignment() const { return IvarAlignment; }
568
569 PropertyImplStrategy(CodeGenModule &CGM,
570 const ObjCPropertyImplDecl *propImpl);
571
572 private:
573 unsigned Kind : 8;
574 unsigned IsAtomic : 1;
575 unsigned IsCopy : 1;
576 unsigned HasStrong : 1;
577
578 CharUnits IvarSize;
579 CharUnits IvarAlignment;
580 };
581}
582
Sylvestre Ledrubed28ac2012-07-23 08:59:39 +0000583/// Pick an implementation strategy for the given property synthesis.
John McCall1e1f4872011-09-13 03:34:09 +0000584PropertyImplStrategy::PropertyImplStrategy(CodeGenModule &CGM,
585 const ObjCPropertyImplDecl *propImpl) {
586 const ObjCPropertyDecl *prop = propImpl->getPropertyDecl();
John McCall265941b2011-09-13 18:31:23 +0000587 ObjCPropertyDecl::SetterKind setterKind = prop->getSetterKind();
John McCall1e1f4872011-09-13 03:34:09 +0000588
John McCall265941b2011-09-13 18:31:23 +0000589 IsCopy = (setterKind == ObjCPropertyDecl::Copy);
590 IsAtomic = prop->isAtomic();
John McCall1e1f4872011-09-13 03:34:09 +0000591 HasStrong = false; // doesn't matter here.
592
593 // Evaluate the ivar's size and alignment.
594 ObjCIvarDecl *ivar = propImpl->getPropertyIvarDecl();
595 QualType ivarType = ivar->getType();
596 llvm::tie(IvarSize, IvarAlignment)
597 = CGM.getContext().getTypeInfoInChars(ivarType);
598
599 // If we have a copy property, we always have to use getProperty/setProperty.
John McCall265941b2011-09-13 18:31:23 +0000600 // TODO: we could actually use setProperty and an expression for non-atomics.
John McCall1e1f4872011-09-13 03:34:09 +0000601 if (IsCopy) {
602 Kind = GetSetProperty;
603 return;
604 }
605
John McCall265941b2011-09-13 18:31:23 +0000606 // Handle retain.
607 if (setterKind == ObjCPropertyDecl::Retain) {
John McCall1e1f4872011-09-13 03:34:09 +0000608 // In GC-only, there's nothing special that needs to be done.
David Blaikie4e4d0842012-03-11 07:00:24 +0000609 if (CGM.getLangOpts().getGC() == LangOptions::GCOnly) {
John McCall1e1f4872011-09-13 03:34:09 +0000610 // fallthrough
611
612 // In ARC, if the property is non-atomic, use expression emission,
613 // which translates to objc_storeStrong. This isn't required, but
614 // it's slightly nicer.
David Blaikie4e4d0842012-03-11 07:00:24 +0000615 } else if (CGM.getLangOpts().ObjCAutoRefCount && !IsAtomic) {
John McCalld64c2eb2012-08-20 23:36:59 +0000616 // Using standard expression emission for the setter is only
617 // acceptable if the ivar is __strong, which won't be true if
618 // the property is annotated with __attribute__((NSObject)).
619 // TODO: falling all the way back to objc_setProperty here is
620 // just laziness, though; we could still use objc_storeStrong
621 // if we hacked it right.
622 if (ivarType.getObjCLifetime() == Qualifiers::OCL_Strong)
623 Kind = Expression;
624 else
625 Kind = SetPropertyAndExpressionGet;
John McCall1e1f4872011-09-13 03:34:09 +0000626 return;
627
628 // Otherwise, we need to at least use setProperty. However, if
629 // the property isn't atomic, we can use normal expression
630 // emission for the getter.
631 } else if (!IsAtomic) {
632 Kind = SetPropertyAndExpressionGet;
633 return;
634
635 // Otherwise, we have to use both setProperty and getProperty.
636 } else {
637 Kind = GetSetProperty;
638 return;
639 }
640 }
641
642 // If we're not atomic, just use expression accesses.
643 if (!IsAtomic) {
644 Kind = Expression;
645 return;
646 }
647
John McCall5889c602011-09-13 05:36:29 +0000648 // Properties on bitfield ivars need to be emitted using expression
649 // accesses even if they're nominally atomic.
650 if (ivar->isBitField()) {
651 Kind = Expression;
652 return;
653 }
654
John McCall1e1f4872011-09-13 03:34:09 +0000655 // GC-qualified or ARC-qualified ivars need to be emitted as
656 // expressions. This actually works out to being atomic anyway,
657 // except for ARC __strong, but that should trigger the above code.
658 if (ivarType.hasNonTrivialObjCLifetime() ||
David Blaikie4e4d0842012-03-11 07:00:24 +0000659 (CGM.getLangOpts().getGC() &&
John McCall1e1f4872011-09-13 03:34:09 +0000660 CGM.getContext().getObjCGCAttrKind(ivarType))) {
661 Kind = Expression;
662 return;
663 }
664
665 // Compute whether the ivar has strong members.
David Blaikie4e4d0842012-03-11 07:00:24 +0000666 if (CGM.getLangOpts().getGC())
John McCall1e1f4872011-09-13 03:34:09 +0000667 if (const RecordType *recordType = ivarType->getAs<RecordType>())
668 HasStrong = recordType->getDecl()->hasObjectMember();
669
670 // We can never access structs with object members with a native
671 // access, because we need to use write barriers. This is what
672 // objc_copyStruct is for.
673 if (HasStrong) {
674 Kind = CopyStruct;
675 return;
676 }
677
678 // Otherwise, this is target-dependent and based on the size and
679 // alignment of the ivar.
John McCallc5d9a902011-09-13 07:33:34 +0000680
681 // If the size of the ivar is not a power of two, give up. We don't
682 // want to get into the business of doing compare-and-swaps.
683 if (!IvarSize.isPowerOfTwo()) {
684 Kind = CopyStruct;
685 return;
686 }
687
John McCall1e1f4872011-09-13 03:34:09 +0000688 llvm::Triple::ArchType arch =
689 CGM.getContext().getTargetInfo().getTriple().getArch();
690
691 // Most architectures require memory to fit within a single cache
692 // line, so the alignment has to be at least the size of the access.
693 // Otherwise we have to grab a lock.
694 if (IvarAlignment < IvarSize && !hasUnalignedAtomics(arch)) {
695 Kind = CopyStruct;
696 return;
697 }
698
699 // If the ivar's size exceeds the architecture's maximum atomic
700 // access size, we have to use CopyStruct.
701 if (IvarSize > getMaxAtomicAccessSize(CGM, arch)) {
702 Kind = CopyStruct;
703 return;
704 }
705
706 // Otherwise, we can use native loads and stores.
707 Kind = Native;
708}
Daniel Dunbaraf05bb92008-08-26 08:29:31 +0000709
James Dennett2ee5ba32012-06-15 22:10:14 +0000710/// \brief Generate an Objective-C property getter function.
711///
712/// The given Decl must be an ObjCImplementationDecl. \@synthesize
Steve Naroff489034c2009-01-10 22:55:25 +0000713/// is illegal within a category.
Fariborz Jahanianfef30b52008-12-09 20:23:04 +0000714void CodeGenFunction::GenerateObjCGetter(ObjCImplementationDecl *IMP,
715 const ObjCPropertyImplDecl *PID) {
Fariborz Jahanianb6e5fe32012-01-07 18:56:22 +0000716 llvm::Constant *AtomicHelperFn =
Fariborz Jahanian20abee62012-01-10 00:37:01 +0000717 GenerateObjCAtomicGetterCopyHelperFunction(PID);
Daniel Dunbaraf05bb92008-08-26 08:29:31 +0000718 const ObjCPropertyDecl *PD = PID->getPropertyDecl();
719 ObjCMethodDecl *OMD = PD->getGetterMethodDecl();
720 assert(OMD && "Invalid call to generate getter (empty method)");
Eric Christopherea320472012-04-03 00:44:15 +0000721 StartObjCMethod(OMD, IMP->getClassInterface(), OMD->getLocStart());
Mike Stump1eb44332009-09-09 15:08:12 +0000722
Fariborz Jahanian490a52b2012-05-29 19:56:01 +0000723 generateObjCGetterBody(IMP, PID, OMD, AtomicHelperFn);
John McCall1e1f4872011-09-13 03:34:09 +0000724
725 FinishFunction();
726}
727
John McCall6c11f0b2011-09-13 06:00:03 +0000728static bool hasTrivialGetExpr(const ObjCPropertyImplDecl *propImpl) {
729 const Expr *getter = propImpl->getGetterCXXConstructor();
John McCall1e1f4872011-09-13 03:34:09 +0000730 if (!getter) return true;
731
732 // Sema only makes only of these when the ivar has a C++ class type,
733 // so the form is pretty constrained.
734
John McCall6c11f0b2011-09-13 06:00:03 +0000735 // If the property has a reference type, we might just be binding a
736 // reference, in which case the result will be a gl-value. We should
737 // treat this as a non-trivial operation.
738 if (getter->isGLValue())
739 return false;
740
John McCall1e1f4872011-09-13 03:34:09 +0000741 // If we selected a trivial copy-constructor, we're okay.
742 if (const CXXConstructExpr *construct = dyn_cast<CXXConstructExpr>(getter))
743 return (construct->getConstructor()->isTrivial());
744
745 // The constructor might require cleanups (in which case it's never
746 // trivial).
747 assert(isa<ExprWithCleanups>(getter));
748 return false;
749}
750
Fariborz Jahanian20abee62012-01-10 00:37:01 +0000751/// emitCPPObjectAtomicGetterCall - Call the runtime function to
752/// copy the ivar into the resturn slot.
753static void emitCPPObjectAtomicGetterCall(CodeGenFunction &CGF,
754 llvm::Value *returnAddr,
755 ObjCIvarDecl *ivar,
756 llvm::Constant *AtomicHelperFn) {
757 // objc_copyCppObjectAtomic (&returnSlot, &CppObjectIvar,
758 // AtomicHelperFn);
759 CallArgList args;
760
761 // The 1st argument is the return Slot.
762 args.add(RValue::get(returnAddr), CGF.getContext().VoidPtrTy);
763
764 // The 2nd argument is the address of the ivar.
765 llvm::Value *ivarAddr =
766 CGF.EmitLValueForIvar(CGF.TypeOfSelfObject(),
767 CGF.LoadObjCSelf(), ivar, 0).getAddress();
768 ivarAddr = CGF.Builder.CreateBitCast(ivarAddr, CGF.Int8PtrTy);
769 args.add(RValue::get(ivarAddr), CGF.getContext().VoidPtrTy);
770
771 // Third argument is the helper function.
772 args.add(RValue::get(AtomicHelperFn), CGF.getContext().VoidPtrTy);
773
774 llvm::Value *copyCppAtomicObjectFn =
David Chisnalld397cfe2012-12-17 18:54:24 +0000775 CGF.CGM.getObjCRuntime().GetCppAtomicObjectGetFunction();
John McCall0f3d0972012-07-07 06:41:13 +0000776 CGF.EmitCall(CGF.getTypes().arrangeFreeFunctionCall(CGF.getContext().VoidTy,
777 args,
778 FunctionType::ExtInfo(),
779 RequiredArgs::All),
Fariborz Jahanian20abee62012-01-10 00:37:01 +0000780 copyCppAtomicObjectFn, ReturnValueSlot(), args);
781}
782
John McCall1e1f4872011-09-13 03:34:09 +0000783void
784CodeGenFunction::generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanianb6e5fe32012-01-07 18:56:22 +0000785 const ObjCPropertyImplDecl *propImpl,
Fariborz Jahanian490a52b2012-05-29 19:56:01 +0000786 const ObjCMethodDecl *GetterMethodDecl,
Fariborz Jahanianb6e5fe32012-01-07 18:56:22 +0000787 llvm::Constant *AtomicHelperFn) {
John McCall1e1f4872011-09-13 03:34:09 +0000788 // If there's a non-trivial 'get' expression, we just have to emit that.
789 if (!hasTrivialGetExpr(propImpl)) {
Fariborz Jahanian20abee62012-01-10 00:37:01 +0000790 if (!AtomicHelperFn) {
791 ReturnStmt ret(SourceLocation(), propImpl->getGetterCXXConstructor(),
792 /*nrvo*/ 0);
793 EmitReturnStmt(ret);
794 }
795 else {
796 ObjCIvarDecl *ivar = propImpl->getPropertyIvarDecl();
797 emitCPPObjectAtomicGetterCall(*this, ReturnValue,
798 ivar, AtomicHelperFn);
799 }
John McCall1e1f4872011-09-13 03:34:09 +0000800 return;
801 }
802
803 const ObjCPropertyDecl *prop = propImpl->getPropertyDecl();
804 QualType propType = prop->getType();
805 ObjCMethodDecl *getterMethod = prop->getGetterMethodDecl();
806
807 ObjCIvarDecl *ivar = propImpl->getPropertyIvarDecl();
808
809 // Pick an implementation strategy.
810 PropertyImplStrategy strategy(CGM, propImpl);
811 switch (strategy.getKind()) {
812 case PropertyImplStrategy::Native: {
Eli Friedmanaa014662012-10-26 22:38:05 +0000813 // We don't need to do anything for a zero-size struct.
814 if (strategy.getIvarSize().isZero())
815 return;
816
John McCall1e1f4872011-09-13 03:34:09 +0000817 LValue LV = EmitLValueForIvar(TypeOfSelfObject(), LoadObjCSelf(), ivar, 0);
818
819 // Currently, all atomic accesses have to be through integer
820 // types, so there's no point in trying to pick a prettier type.
821 llvm::Type *bitcastType =
822 llvm::Type::getIntNTy(getLLVMContext(),
823 getContext().toBits(strategy.getIvarSize()));
824 bitcastType = bitcastType->getPointerTo(); // addrspace 0 okay
825
826 // Perform an atomic load. This does not impose ordering constraints.
827 llvm::Value *ivarAddr = LV.getAddress();
828 ivarAddr = Builder.CreateBitCast(ivarAddr, bitcastType);
829 llvm::LoadInst *load = Builder.CreateLoad(ivarAddr, "load");
830 load->setAlignment(strategy.getIvarAlignment().getQuantity());
831 load->setAtomic(llvm::Unordered);
832
833 // Store that value into the return address. Doing this with a
834 // bitcast is likely to produce some pretty ugly IR, but it's not
835 // the *most* terrible thing in the world.
836 Builder.CreateStore(load, Builder.CreateBitCast(ReturnValue, bitcastType));
837
838 // Make sure we don't do an autorelease.
839 AutoreleaseResult = false;
840 return;
841 }
842
843 case PropertyImplStrategy::GetSetProperty: {
844 llvm::Value *getPropertyFn =
845 CGM.getObjCRuntime().GetPropertyGetFunction();
846 if (!getPropertyFn) {
847 CGM.ErrorUnsupported(propImpl, "Obj-C getter requiring atomic copy");
Daniel Dunbarc1cf4a52008-09-24 04:04:31 +0000848 return;
849 }
850
851 // Return (ivar-type) objc_getProperty((id) self, _cmd, offset, true).
852 // FIXME: Can't this be simpler? This might even be worse than the
853 // corresponding gcc code.
John McCall1e1f4872011-09-13 03:34:09 +0000854 llvm::Value *cmd =
855 Builder.CreateLoad(LocalDeclMap[getterMethod->getCmdDecl()], "cmd");
856 llvm::Value *self = Builder.CreateBitCast(LoadObjCSelf(), VoidPtrTy);
857 llvm::Value *ivarOffset =
858 EmitIvarOffset(classImpl->getClassInterface(), ivar);
859
860 CallArgList args;
861 args.add(RValue::get(self), getContext().getObjCIdType());
862 args.add(RValue::get(cmd), getContext().getObjCSelType());
863 args.add(RValue::get(ivarOffset), getContext().getPointerDiffType());
John McCall265941b2011-09-13 18:31:23 +0000864 args.add(RValue::get(Builder.getInt1(strategy.isAtomic())),
865 getContext().BoolTy);
John McCall1e1f4872011-09-13 03:34:09 +0000866
Daniel Dunbare4be5a62009-02-03 23:43:59 +0000867 // FIXME: We shouldn't need to get the function info here, the
868 // runtime already should have computed it to build the function.
John McCall0f3d0972012-07-07 06:41:13 +0000869 RValue RV = EmitCall(getTypes().arrangeFreeFunctionCall(propType, args,
870 FunctionType::ExtInfo(),
871 RequiredArgs::All),
John McCall1e1f4872011-09-13 03:34:09 +0000872 getPropertyFn, ReturnValueSlot(), args);
873
Daniel Dunbarc1cf4a52008-09-24 04:04:31 +0000874 // We need to fix the type here. Ivars with copy & retain are
875 // always objects so we don't need to worry about complex or
876 // aggregates.
Mike Stump1eb44332009-09-09 15:08:12 +0000877 RV = RValue::get(Builder.CreateBitCast(RV.getScalarVal(),
Fariborz Jahanian52c18b02012-04-26 21:33:14 +0000878 getTypes().ConvertType(getterMethod->getResultType())));
John McCall1e1f4872011-09-13 03:34:09 +0000879
880 EmitReturnOfRValue(RV, propType);
John McCallf85e1932011-06-15 23:02:42 +0000881
882 // objc_getProperty does an autorelease, so we should suppress ours.
883 AutoreleaseResult = false;
John McCallf85e1932011-06-15 23:02:42 +0000884
John McCall1e1f4872011-09-13 03:34:09 +0000885 return;
886 }
887
888 case PropertyImplStrategy::CopyStruct:
889 emitStructGetterCall(*this, ivar, strategy.isAtomic(),
890 strategy.hasStrongMember());
891 return;
892
893 case PropertyImplStrategy::Expression:
894 case PropertyImplStrategy::SetPropertyAndExpressionGet: {
895 LValue LV = EmitLValueForIvar(TypeOfSelfObject(), LoadObjCSelf(), ivar, 0);
896
897 QualType ivarType = ivar->getType();
John McCall9d232c82013-03-07 21:37:08 +0000898 switch (getEvaluationKind(ivarType)) {
899 case TEK_Complex: {
900 ComplexPairTy pair = EmitLoadOfComplex(LV);
901 EmitStoreOfComplex(pair,
902 MakeNaturalAlignAddrLValue(ReturnValue, ivarType),
903 /*init*/ true);
904 return;
905 }
906 case TEK_Aggregate:
John McCall1e1f4872011-09-13 03:34:09 +0000907 // The return value slot is guaranteed to not be aliased, but
908 // that's not necessarily the same as "on the stack", so
909 // we still potentially need objc_memmove_collectable.
Chad Rosier649b4a12012-03-29 17:37:10 +0000910 EmitAggregateCopy(ReturnValue, LV.getAddress(), ivarType);
John McCall9d232c82013-03-07 21:37:08 +0000911 return;
912 case TEK_Scalar: {
John McCallba3dd902011-07-22 05:23:13 +0000913 llvm::Value *value;
914 if (propType->isReferenceType()) {
915 value = LV.getAddress();
916 } else {
917 // We want to load and autoreleaseReturnValue ARC __weak ivars.
918 if (LV.getQuals().getObjCLifetime() == Qualifiers::OCL_Weak) {
John McCall1e1f4872011-09-13 03:34:09 +0000919 value = emitARCRetainLoadOfScalar(*this, LV, ivarType);
John McCallba3dd902011-07-22 05:23:13 +0000920
921 // Otherwise we want to do a simple load, suppressing the
922 // final autorelease.
John McCallf85e1932011-06-15 23:02:42 +0000923 } else {
John McCallba3dd902011-07-22 05:23:13 +0000924 value = EmitLoadOfLValue(LV).getScalarVal();
925 AutoreleaseResult = false;
Fariborz Jahanian14086762011-03-28 23:47:18 +0000926 }
John McCallf85e1932011-06-15 23:02:42 +0000927
John McCallba3dd902011-07-22 05:23:13 +0000928 value = Builder.CreateBitCast(value, ConvertType(propType));
Fariborz Jahanian490a52b2012-05-29 19:56:01 +0000929 value = Builder.CreateBitCast(value,
930 ConvertType(GetterMethodDecl->getResultType()));
John McCallba3dd902011-07-22 05:23:13 +0000931 }
932
933 EmitReturnOfRValue(RValue::get(value), propType);
John McCall9d232c82013-03-07 21:37:08 +0000934 return;
Fariborz Jahanianed1d29d2009-03-03 18:49:40 +0000935 }
John McCall9d232c82013-03-07 21:37:08 +0000936 }
937 llvm_unreachable("bad evaluation kind");
Daniel Dunbarc1cf4a52008-09-24 04:04:31 +0000938 }
Daniel Dunbaraf05bb92008-08-26 08:29:31 +0000939
John McCall1e1f4872011-09-13 03:34:09 +0000940 }
941 llvm_unreachable("bad @property implementation strategy!");
Daniel Dunbaraf05bb92008-08-26 08:29:31 +0000942}
943
John McCall41bdde92011-09-12 23:06:44 +0000944/// emitStructSetterCall - Call the runtime function to store the value
945/// from the first formal parameter into the given ivar.
946static void emitStructSetterCall(CodeGenFunction &CGF, ObjCMethodDecl *OMD,
947 ObjCIvarDecl *ivar) {
Fariborz Jahanian2846b972011-02-18 19:15:13 +0000948 // objc_copyStruct (&structIvar, &Arg,
949 // sizeof (struct something), true, false);
John McCallbbb253c2011-09-10 09:30:49 +0000950 CallArgList args;
951
952 // The first argument is the address of the ivar.
John McCall41bdde92011-09-12 23:06:44 +0000953 llvm::Value *ivarAddr = CGF.EmitLValueForIvar(CGF.TypeOfSelfObject(),
954 CGF.LoadObjCSelf(), ivar, 0)
955 .getAddress();
956 ivarAddr = CGF.Builder.CreateBitCast(ivarAddr, CGF.Int8PtrTy);
957 args.add(RValue::get(ivarAddr), CGF.getContext().VoidPtrTy);
John McCallbbb253c2011-09-10 09:30:49 +0000958
959 // The second argument is the address of the parameter variable.
John McCall41bdde92011-09-12 23:06:44 +0000960 ParmVarDecl *argVar = *OMD->param_begin();
John McCallf4b88a42012-03-10 09:33:50 +0000961 DeclRefExpr argRef(argVar, false, argVar->getType().getNonReferenceType(),
Fariborz Jahanianc3953aa2012-01-05 00:10:16 +0000962 VK_LValue, SourceLocation());
John McCall41bdde92011-09-12 23:06:44 +0000963 llvm::Value *argAddr = CGF.EmitLValue(&argRef).getAddress();
964 argAddr = CGF.Builder.CreateBitCast(argAddr, CGF.Int8PtrTy);
965 args.add(RValue::get(argAddr), CGF.getContext().VoidPtrTy);
John McCallbbb253c2011-09-10 09:30:49 +0000966
967 // The third argument is the sizeof the type.
968 llvm::Value *size =
John McCall41bdde92011-09-12 23:06:44 +0000969 CGF.CGM.getSize(CGF.getContext().getTypeSizeInChars(ivar->getType()));
970 args.add(RValue::get(size), CGF.getContext().getSizeType());
John McCallbbb253c2011-09-10 09:30:49 +0000971
John McCall41bdde92011-09-12 23:06:44 +0000972 // The fourth argument is the 'isAtomic' flag.
973 args.add(RValue::get(CGF.Builder.getTrue()), CGF.getContext().BoolTy);
John McCallbbb253c2011-09-10 09:30:49 +0000974
John McCall41bdde92011-09-12 23:06:44 +0000975 // The fifth argument is the 'hasStrong' flag.
976 // FIXME: should this really always be false?
977 args.add(RValue::get(CGF.Builder.getFalse()), CGF.getContext().BoolTy);
978
979 llvm::Value *copyStructFn = CGF.CGM.getObjCRuntime().GetSetStructFunction();
John McCall0f3d0972012-07-07 06:41:13 +0000980 CGF.EmitCall(CGF.getTypes().arrangeFreeFunctionCall(CGF.getContext().VoidTy,
981 args,
982 FunctionType::ExtInfo(),
983 RequiredArgs::All),
John McCall41bdde92011-09-12 23:06:44 +0000984 copyStructFn, ReturnValueSlot(), args);
Fariborz Jahanian2846b972011-02-18 19:15:13 +0000985}
986
Fariborz Jahaniancd93b962012-01-06 22:33:54 +0000987/// emitCPPObjectAtomicSetterCall - Call the runtime function to store
988/// the value from the first formal parameter into the given ivar, using
989/// the Cpp API for atomic Cpp objects with non-trivial copy assignment.
990static void emitCPPObjectAtomicSetterCall(CodeGenFunction &CGF,
991 ObjCMethodDecl *OMD,
992 ObjCIvarDecl *ivar,
993 llvm::Constant *AtomicHelperFn) {
994 // objc_copyCppObjectAtomic (&CppObjectIvar, &Arg,
995 // AtomicHelperFn);
996 CallArgList args;
997
998 // The first argument is the address of the ivar.
999 llvm::Value *ivarAddr =
1000 CGF.EmitLValueForIvar(CGF.TypeOfSelfObject(),
1001 CGF.LoadObjCSelf(), ivar, 0).getAddress();
1002 ivarAddr = CGF.Builder.CreateBitCast(ivarAddr, CGF.Int8PtrTy);
1003 args.add(RValue::get(ivarAddr), CGF.getContext().VoidPtrTy);
1004
1005 // The second argument is the address of the parameter variable.
1006 ParmVarDecl *argVar = *OMD->param_begin();
John McCallf4b88a42012-03-10 09:33:50 +00001007 DeclRefExpr argRef(argVar, false, argVar->getType().getNonReferenceType(),
Fariborz Jahaniancd93b962012-01-06 22:33:54 +00001008 VK_LValue, SourceLocation());
1009 llvm::Value *argAddr = CGF.EmitLValue(&argRef).getAddress();
1010 argAddr = CGF.Builder.CreateBitCast(argAddr, CGF.Int8PtrTy);
1011 args.add(RValue::get(argAddr), CGF.getContext().VoidPtrTy);
1012
1013 // Third argument is the helper function.
1014 args.add(RValue::get(AtomicHelperFn), CGF.getContext().VoidPtrTy);
1015
1016 llvm::Value *copyCppAtomicObjectFn =
David Chisnalld397cfe2012-12-17 18:54:24 +00001017 CGF.CGM.getObjCRuntime().GetCppAtomicObjectSetFunction();
John McCall0f3d0972012-07-07 06:41:13 +00001018 CGF.EmitCall(CGF.getTypes().arrangeFreeFunctionCall(CGF.getContext().VoidTy,
1019 args,
1020 FunctionType::ExtInfo(),
1021 RequiredArgs::All),
Fariborz Jahaniancd93b962012-01-06 22:33:54 +00001022 copyCppAtomicObjectFn, ReturnValueSlot(), args);
1023
1024
1025}
1026
Fariborz Jahanian20abee62012-01-10 00:37:01 +00001027
John McCall1e1f4872011-09-13 03:34:09 +00001028static bool hasTrivialSetExpr(const ObjCPropertyImplDecl *PID) {
1029 Expr *setter = PID->getSetterCXXAssignment();
1030 if (!setter) return true;
1031
1032 // Sema only makes only of these when the ivar has a C++ class type,
1033 // so the form is pretty constrained.
John McCall71c758d2011-09-10 09:17:20 +00001034
1035 // An operator call is trivial if the function it calls is trivial.
John McCall1e1f4872011-09-13 03:34:09 +00001036 // This also implies that there's nothing non-trivial going on with
1037 // the arguments, because operator= can only be trivial if it's a
1038 // synthesized assignment operator and therefore both parameters are
1039 // references.
1040 if (CallExpr *call = dyn_cast<CallExpr>(setter)) {
John McCall71c758d2011-09-10 09:17:20 +00001041 if (const FunctionDecl *callee
1042 = dyn_cast_or_null<FunctionDecl>(call->getCalleeDecl()))
1043 if (callee->isTrivial())
1044 return true;
1045 return false;
Fariborz Jahanian01cb3072011-04-06 16:05:26 +00001046 }
John McCall71c758d2011-09-10 09:17:20 +00001047
John McCall1e1f4872011-09-13 03:34:09 +00001048 assert(isa<ExprWithCleanups>(setter));
John McCall71c758d2011-09-10 09:17:20 +00001049 return false;
1050}
1051
Benjamin Kramer4e494cf2012-03-10 20:38:56 +00001052static bool UseOptimizedSetter(CodeGenModule &CGM) {
David Blaikie4e4d0842012-03-11 07:00:24 +00001053 if (CGM.getLangOpts().getGC() != LangOptions::NonGC)
Ted Kremenekebcb57a2012-03-06 20:05:56 +00001054 return false;
Daniel Dunbar7a0c0642012-10-15 22:23:53 +00001055 return CGM.getLangOpts().ObjCRuntime.hasOptimizedSetter();
Ted Kremenekebcb57a2012-03-06 20:05:56 +00001056}
1057
John McCall71c758d2011-09-10 09:17:20 +00001058void
1059CodeGenFunction::generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahaniancd93b962012-01-06 22:33:54 +00001060 const ObjCPropertyImplDecl *propImpl,
1061 llvm::Constant *AtomicHelperFn) {
John McCall71c758d2011-09-10 09:17:20 +00001062 const ObjCPropertyDecl *prop = propImpl->getPropertyDecl();
Fariborz Jahanian84e49862012-01-06 00:29:35 +00001063 ObjCIvarDecl *ivar = propImpl->getPropertyIvarDecl();
John McCall71c758d2011-09-10 09:17:20 +00001064 ObjCMethodDecl *setterMethod = prop->getSetterMethodDecl();
Fariborz Jahaniancd93b962012-01-06 22:33:54 +00001065
1066 // Just use the setter expression if Sema gave us one and it's
1067 // non-trivial.
1068 if (!hasTrivialSetExpr(propImpl)) {
1069 if (!AtomicHelperFn)
1070 // If non-atomic, assignment is called directly.
1071 EmitStmt(propImpl->getSetterCXXAssignment());
1072 else
1073 // If atomic, assignment is called via a locking api.
1074 emitCPPObjectAtomicSetterCall(*this, setterMethod, ivar,
1075 AtomicHelperFn);
1076 return;
1077 }
John McCall71c758d2011-09-10 09:17:20 +00001078
John McCall1e1f4872011-09-13 03:34:09 +00001079 PropertyImplStrategy strategy(CGM, propImpl);
1080 switch (strategy.getKind()) {
1081 case PropertyImplStrategy::Native: {
Eli Friedmanaa014662012-10-26 22:38:05 +00001082 // We don't need to do anything for a zero-size struct.
1083 if (strategy.getIvarSize().isZero())
1084 return;
1085
John McCall1e1f4872011-09-13 03:34:09 +00001086 llvm::Value *argAddr = LocalDeclMap[*setterMethod->param_begin()];
John McCall71c758d2011-09-10 09:17:20 +00001087
John McCall1e1f4872011-09-13 03:34:09 +00001088 LValue ivarLValue =
1089 EmitLValueForIvar(TypeOfSelfObject(), LoadObjCSelf(), ivar, /*quals*/ 0);
1090 llvm::Value *ivarAddr = ivarLValue.getAddress();
John McCall71c758d2011-09-10 09:17:20 +00001091
John McCall1e1f4872011-09-13 03:34:09 +00001092 // Currently, all atomic accesses have to be through integer
1093 // types, so there's no point in trying to pick a prettier type.
1094 llvm::Type *bitcastType =
1095 llvm::Type::getIntNTy(getLLVMContext(),
1096 getContext().toBits(strategy.getIvarSize()));
1097 bitcastType = bitcastType->getPointerTo(); // addrspace 0 okay
1098
1099 // Cast both arguments to the chosen operation type.
1100 argAddr = Builder.CreateBitCast(argAddr, bitcastType);
1101 ivarAddr = Builder.CreateBitCast(ivarAddr, bitcastType);
1102
1103 // This bitcast load is likely to cause some nasty IR.
1104 llvm::Value *load = Builder.CreateLoad(argAddr);
1105
1106 // Perform an atomic store. There are no memory ordering requirements.
1107 llvm::StoreInst *store = Builder.CreateStore(load, ivarAddr);
1108 store->setAlignment(strategy.getIvarAlignment().getQuantity());
1109 store->setAtomic(llvm::Unordered);
1110 return;
1111 }
1112
1113 case PropertyImplStrategy::GetSetProperty:
1114 case PropertyImplStrategy::SetPropertyAndExpressionGet: {
Ted Kremenekebcb57a2012-03-06 20:05:56 +00001115
1116 llvm::Value *setOptimizedPropertyFn = 0;
1117 llvm::Value *setPropertyFn = 0;
1118 if (UseOptimizedSetter(CGM)) {
Daniel Dunbar7a0c0642012-10-15 22:23:53 +00001119 // 10.8 and iOS 6.0 code and GC is off
Ted Kremenekebcb57a2012-03-06 20:05:56 +00001120 setOptimizedPropertyFn =
Eric Christopher16098f32012-03-29 17:31:31 +00001121 CGM.getObjCRuntime()
1122 .GetOptimizedPropertySetFunction(strategy.isAtomic(),
1123 strategy.isCopy());
Ted Kremenekebcb57a2012-03-06 20:05:56 +00001124 if (!setOptimizedPropertyFn) {
1125 CGM.ErrorUnsupported(propImpl, "Obj-C optimized setter - NYI");
1126 return;
1127 }
John McCall71c758d2011-09-10 09:17:20 +00001128 }
Ted Kremenekebcb57a2012-03-06 20:05:56 +00001129 else {
1130 setPropertyFn = CGM.getObjCRuntime().GetPropertySetFunction();
1131 if (!setPropertyFn) {
1132 CGM.ErrorUnsupported(propImpl, "Obj-C setter requiring atomic copy");
1133 return;
1134 }
1135 }
1136
John McCall71c758d2011-09-10 09:17:20 +00001137 // Emit objc_setProperty((id) self, _cmd, offset, arg,
1138 // <is-atomic>, <is-copy>).
1139 llvm::Value *cmd =
1140 Builder.CreateLoad(LocalDeclMap[setterMethod->getCmdDecl()]);
1141 llvm::Value *self =
1142 Builder.CreateBitCast(LoadObjCSelf(), VoidPtrTy);
1143 llvm::Value *ivarOffset =
1144 EmitIvarOffset(classImpl->getClassInterface(), ivar);
1145 llvm::Value *arg = LocalDeclMap[*setterMethod->param_begin()];
1146 arg = Builder.CreateBitCast(Builder.CreateLoad(arg, "arg"), VoidPtrTy);
1147
1148 CallArgList args;
1149 args.add(RValue::get(self), getContext().getObjCIdType());
1150 args.add(RValue::get(cmd), getContext().getObjCSelType());
Ted Kremenekebcb57a2012-03-06 20:05:56 +00001151 if (setOptimizedPropertyFn) {
1152 args.add(RValue::get(arg), getContext().getObjCIdType());
1153 args.add(RValue::get(ivarOffset), getContext().getPointerDiffType());
John McCall0f3d0972012-07-07 06:41:13 +00001154 EmitCall(getTypes().arrangeFreeFunctionCall(getContext().VoidTy, args,
1155 FunctionType::ExtInfo(),
1156 RequiredArgs::All),
Ted Kremenekebcb57a2012-03-06 20:05:56 +00001157 setOptimizedPropertyFn, ReturnValueSlot(), args);
1158 } else {
1159 args.add(RValue::get(ivarOffset), getContext().getPointerDiffType());
1160 args.add(RValue::get(arg), getContext().getObjCIdType());
1161 args.add(RValue::get(Builder.getInt1(strategy.isAtomic())),
1162 getContext().BoolTy);
1163 args.add(RValue::get(Builder.getInt1(strategy.isCopy())),
1164 getContext().BoolTy);
1165 // FIXME: We shouldn't need to get the function info here, the runtime
1166 // already should have computed it to build the function.
John McCall0f3d0972012-07-07 06:41:13 +00001167 EmitCall(getTypes().arrangeFreeFunctionCall(getContext().VoidTy, args,
1168 FunctionType::ExtInfo(),
1169 RequiredArgs::All),
Ted Kremenekebcb57a2012-03-06 20:05:56 +00001170 setPropertyFn, ReturnValueSlot(), args);
1171 }
1172
John McCall71c758d2011-09-10 09:17:20 +00001173 return;
1174 }
1175
John McCall1e1f4872011-09-13 03:34:09 +00001176 case PropertyImplStrategy::CopyStruct:
John McCall41bdde92011-09-12 23:06:44 +00001177 emitStructSetterCall(*this, setterMethod, ivar);
John McCall71c758d2011-09-10 09:17:20 +00001178 return;
John McCall1e1f4872011-09-13 03:34:09 +00001179
1180 case PropertyImplStrategy::Expression:
1181 break;
John McCall71c758d2011-09-10 09:17:20 +00001182 }
1183
1184 // Otherwise, fake up some ASTs and emit a normal assignment.
1185 ValueDecl *selfDecl = setterMethod->getSelfDecl();
John McCallf4b88a42012-03-10 09:33:50 +00001186 DeclRefExpr self(selfDecl, false, selfDecl->getType(),
1187 VK_LValue, SourceLocation());
John McCall71c758d2011-09-10 09:17:20 +00001188 ImplicitCastExpr selfLoad(ImplicitCastExpr::OnStack,
1189 selfDecl->getType(), CK_LValueToRValue, &self,
1190 VK_RValue);
1191 ObjCIvarRefExpr ivarRef(ivar, ivar->getType().getNonReferenceType(),
Fariborz Jahanian0c701812013-04-02 18:57:54 +00001192 SourceLocation(), SourceLocation(),
1193 &selfLoad, true, true);
John McCall71c758d2011-09-10 09:17:20 +00001194
1195 ParmVarDecl *argDecl = *setterMethod->param_begin();
1196 QualType argType = argDecl->getType().getNonReferenceType();
John McCallf4b88a42012-03-10 09:33:50 +00001197 DeclRefExpr arg(argDecl, false, argType, VK_LValue, SourceLocation());
John McCall71c758d2011-09-10 09:17:20 +00001198 ImplicitCastExpr argLoad(ImplicitCastExpr::OnStack,
1199 argType.getUnqualifiedType(), CK_LValueToRValue,
1200 &arg, VK_RValue);
1201
1202 // The property type can differ from the ivar type in some situations with
1203 // Objective-C pointer types, we can always bit cast the RHS in these cases.
1204 // The following absurdity is just to ensure well-formed IR.
1205 CastKind argCK = CK_NoOp;
1206 if (ivarRef.getType()->isObjCObjectPointerType()) {
1207 if (argLoad.getType()->isObjCObjectPointerType())
1208 argCK = CK_BitCast;
1209 else if (argLoad.getType()->isBlockPointerType())
1210 argCK = CK_BlockPointerToObjCPointerCast;
1211 else
1212 argCK = CK_CPointerToObjCPointerCast;
1213 } else if (ivarRef.getType()->isBlockPointerType()) {
1214 if (argLoad.getType()->isBlockPointerType())
1215 argCK = CK_BitCast;
1216 else
1217 argCK = CK_AnyPointerToBlockPointerCast;
1218 } else if (ivarRef.getType()->isPointerType()) {
1219 argCK = CK_BitCast;
1220 }
1221 ImplicitCastExpr argCast(ImplicitCastExpr::OnStack,
1222 ivarRef.getType(), argCK, &argLoad,
1223 VK_RValue);
1224 Expr *finalArg = &argLoad;
1225 if (!getContext().hasSameUnqualifiedType(ivarRef.getType(),
1226 argLoad.getType()))
1227 finalArg = &argCast;
1228
1229
1230 BinaryOperator assign(&ivarRef, finalArg, BO_Assign,
1231 ivarRef.getType(), VK_RValue, OK_Ordinary,
Lang Hamesbe9af122012-10-02 04:45:10 +00001232 SourceLocation(), false);
John McCall71c758d2011-09-10 09:17:20 +00001233 EmitStmt(&assign);
Fariborz Jahanian01cb3072011-04-06 16:05:26 +00001234}
1235
James Dennett2ee5ba32012-06-15 22:10:14 +00001236/// \brief Generate an Objective-C property setter function.
1237///
1238/// The given Decl must be an ObjCImplementationDecl. \@synthesize
Steve Naroff489034c2009-01-10 22:55:25 +00001239/// is illegal within a category.
Fariborz Jahanianfef30b52008-12-09 20:23:04 +00001240void CodeGenFunction::GenerateObjCSetter(ObjCImplementationDecl *IMP,
1241 const ObjCPropertyImplDecl *PID) {
Fariborz Jahanianb6e5fe32012-01-07 18:56:22 +00001242 llvm::Constant *AtomicHelperFn =
Fariborz Jahanian20abee62012-01-10 00:37:01 +00001243 GenerateObjCAtomicSetterCopyHelperFunction(PID);
Daniel Dunbaraf05bb92008-08-26 08:29:31 +00001244 const ObjCPropertyDecl *PD = PID->getPropertyDecl();
1245 ObjCMethodDecl *OMD = PD->getSetterMethodDecl();
1246 assert(OMD && "Invalid call to generate setter (empty method)");
Eric Christopherea320472012-04-03 00:44:15 +00001247 StartObjCMethod(OMD, IMP->getClassInterface(), OMD->getLocStart());
Daniel Dunbar86957eb2008-09-24 06:32:09 +00001248
Fariborz Jahaniancd93b962012-01-06 22:33:54 +00001249 generateObjCSetterBody(IMP, PID, AtomicHelperFn);
Daniel Dunbaraf05bb92008-08-26 08:29:31 +00001250
1251 FinishFunction();
Chris Lattner41110242008-06-17 18:05:57 +00001252}
1253
John McCalle81ac692011-03-22 07:05:39 +00001254namespace {
John McCall9928c482011-07-12 16:41:08 +00001255 struct DestroyIvar : EHScopeStack::Cleanup {
1256 private:
1257 llvm::Value *addr;
John McCalle81ac692011-03-22 07:05:39 +00001258 const ObjCIvarDecl *ivar;
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001259 CodeGenFunction::Destroyer *destroyer;
John McCall9928c482011-07-12 16:41:08 +00001260 bool useEHCleanupForArray;
1261 public:
1262 DestroyIvar(llvm::Value *addr, const ObjCIvarDecl *ivar,
1263 CodeGenFunction::Destroyer *destroyer,
1264 bool useEHCleanupForArray)
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001265 : addr(addr), ivar(ivar), destroyer(destroyer),
John McCall9928c482011-07-12 16:41:08 +00001266 useEHCleanupForArray(useEHCleanupForArray) {}
John McCalle81ac692011-03-22 07:05:39 +00001267
John McCallad346f42011-07-12 20:27:29 +00001268 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCall9928c482011-07-12 16:41:08 +00001269 LValue lvalue
1270 = CGF.EmitLValueForIvar(CGF.TypeOfSelfObject(), addr, ivar, /*CVR*/ 0);
1271 CGF.emitDestroy(lvalue.getAddress(), ivar->getType(), destroyer,
John McCallad346f42011-07-12 20:27:29 +00001272 flags.isForNormalCleanup() && useEHCleanupForArray);
John McCalle81ac692011-03-22 07:05:39 +00001273 }
1274 };
1275}
1276
John McCall9928c482011-07-12 16:41:08 +00001277/// Like CodeGenFunction::destroyARCStrong, but do it with a call.
1278static void destroyARCStrongWithStore(CodeGenFunction &CGF,
1279 llvm::Value *addr,
1280 QualType type) {
1281 llvm::Value *null = getNullForVariable(addr);
1282 CGF.EmitARCStoreStrongCall(addr, null, /*ignored*/ true);
1283}
John McCallf85e1932011-06-15 23:02:42 +00001284
John McCalle81ac692011-03-22 07:05:39 +00001285static void emitCXXDestructMethod(CodeGenFunction &CGF,
1286 ObjCImplementationDecl *impl) {
1287 CodeGenFunction::RunCleanupsScope scope(CGF);
1288
1289 llvm::Value *self = CGF.LoadObjCSelf();
1290
Jordy Rosedb8264e2011-07-22 02:08:32 +00001291 const ObjCInterfaceDecl *iface = impl->getClassInterface();
1292 for (const ObjCIvarDecl *ivar = iface->all_declared_ivar_begin();
John McCalle81ac692011-03-22 07:05:39 +00001293 ivar; ivar = ivar->getNextIvar()) {
1294 QualType type = ivar->getType();
1295
John McCalle81ac692011-03-22 07:05:39 +00001296 // Check whether the ivar is a destructible type.
John McCall9928c482011-07-12 16:41:08 +00001297 QualType::DestructionKind dtorKind = type.isDestructedType();
1298 if (!dtorKind) continue;
John McCalle81ac692011-03-22 07:05:39 +00001299
John McCall9928c482011-07-12 16:41:08 +00001300 CodeGenFunction::Destroyer *destroyer = 0;
John McCalle81ac692011-03-22 07:05:39 +00001301
John McCall9928c482011-07-12 16:41:08 +00001302 // Use a call to objc_storeStrong to destroy strong ivars, for the
1303 // general benefit of the tools.
1304 if (dtorKind == QualType::DK_objc_strong_lifetime) {
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001305 destroyer = destroyARCStrongWithStore;
John McCallf85e1932011-06-15 23:02:42 +00001306
John McCall9928c482011-07-12 16:41:08 +00001307 // Otherwise use the default for the destruction kind.
1308 } else {
Peter Collingbourne516bbd42012-01-26 03:33:36 +00001309 destroyer = CGF.getDestroyer(dtorKind);
John McCalle81ac692011-03-22 07:05:39 +00001310 }
John McCall9928c482011-07-12 16:41:08 +00001311
1312 CleanupKind cleanupKind = CGF.getCleanupKind(dtorKind);
1313
1314 CGF.EHStack.pushCleanup<DestroyIvar>(cleanupKind, self, ivar, destroyer,
1315 cleanupKind & EHCleanup);
John McCalle81ac692011-03-22 07:05:39 +00001316 }
1317
1318 assert(scope.requiresCleanups() && "nothing to do in .cxx_destruct?");
1319}
1320
Fariborz Jahanian109dfc62010-04-28 21:28:56 +00001321void CodeGenFunction::GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1322 ObjCMethodDecl *MD,
1323 bool ctor) {
Fariborz Jahanian109dfc62010-04-28 21:28:56 +00001324 MD->createImplicitParams(CGM.getContext(), IMP->getClassInterface());
Devang Patel8d3f8972011-05-19 23:37:41 +00001325 StartObjCMethod(MD, IMP->getClassInterface(), MD->getLocStart());
John McCalle81ac692011-03-22 07:05:39 +00001326
1327 // Emit .cxx_construct.
Fariborz Jahanian109dfc62010-04-28 21:28:56 +00001328 if (ctor) {
John McCallf85e1932011-06-15 23:02:42 +00001329 // Suppress the final autorelease in ARC.
1330 AutoreleaseResult = false;
1331
Chris Lattner5f9e2722011-07-23 10:55:15 +00001332 SmallVector<CXXCtorInitializer *, 8> IvarInitializers;
John McCalle81ac692011-03-22 07:05:39 +00001333 for (ObjCImplementationDecl::init_const_iterator B = IMP->init_begin(),
1334 E = IMP->init_end(); B != E; ++B) {
1335 CXXCtorInitializer *IvarInit = (*B);
Francois Pichet00eb3f92010-12-04 09:14:42 +00001336 FieldDecl *Field = IvarInit->getAnyMember();
Fariborz Jahanian109dfc62010-04-28 21:28:56 +00001337 ObjCIvarDecl *Ivar = cast<ObjCIvarDecl>(Field);
Fariborz Jahanian9b4d4fc2010-04-28 22:30:33 +00001338 LValue LV = EmitLValueForIvar(TypeOfSelfObject(),
1339 LoadObjCSelf(), Ivar, 0);
John McCall7c2349b2011-08-25 20:40:09 +00001340 EmitAggExpr(IvarInit->getInit(),
1341 AggValueSlot::forLValue(LV, AggValueSlot::IsDestructed,
John McCall410ffb22011-08-25 23:04:34 +00001342 AggValueSlot::DoesNotNeedGCBarriers,
Chad Rosier649b4a12012-03-29 17:37:10 +00001343 AggValueSlot::IsNotAliased));
Fariborz Jahanian109dfc62010-04-28 21:28:56 +00001344 }
1345 // constructor returns 'self'.
1346 CodeGenTypes &Types = CGM.getTypes();
1347 QualType IdTy(CGM.getContext().getObjCIdType());
1348 llvm::Value *SelfAsId =
1349 Builder.CreateBitCast(LoadObjCSelf(), Types.ConvertType(IdTy));
1350 EmitReturnOfRValue(RValue::get(SelfAsId), IdTy);
John McCalle81ac692011-03-22 07:05:39 +00001351
1352 // Emit .cxx_destruct.
Chandler Carruthbc397cf2010-05-06 00:20:39 +00001353 } else {
John McCalle81ac692011-03-22 07:05:39 +00001354 emitCXXDestructMethod(*this, IMP);
Fariborz Jahanian109dfc62010-04-28 21:28:56 +00001355 }
1356 FinishFunction();
1357}
1358
Fariborz Jahanian0b2bd472010-04-13 00:38:05 +00001359bool CodeGenFunction::IndirectObjCSetterArg(const CGFunctionInfo &FI) {
1360 CGFunctionInfo::const_arg_iterator it = FI.arg_begin();
1361 it++; it++;
1362 const ABIArgInfo &AI = it->info;
1363 // FIXME. Is this sufficient check?
1364 return (AI.getKind() == ABIArgInfo::Indirect);
1365}
1366
Fariborz Jahanian15bd5882010-04-13 18:32:24 +00001367bool CodeGenFunction::IvarTypeWithAggrGCObjects(QualType Ty) {
David Blaikie4e4d0842012-03-11 07:00:24 +00001368 if (CGM.getLangOpts().getGC() == LangOptions::NonGC)
Fariborz Jahanian15bd5882010-04-13 18:32:24 +00001369 return false;
1370 if (const RecordType *FDTTy = Ty.getTypePtr()->getAs<RecordType>())
1371 return FDTTy->getDecl()->hasObjectMember();
1372 return false;
1373}
1374
Daniel Dunbarc1cf4a52008-09-24 04:04:31 +00001375llvm::Value *CodeGenFunction::LoadObjCSelf() {
Daniel Dunbarb7ec2462008-08-16 03:19:19 +00001376 const ObjCMethodDecl *OMD = cast<ObjCMethodDecl>(CurFuncDecl);
1377 return Builder.CreateLoad(LocalDeclMap[OMD->getSelfDecl()], "self");
Chris Lattner41110242008-06-17 18:05:57 +00001378}
1379
Fariborz Jahanian45012a72009-02-03 00:09:52 +00001380QualType CodeGenFunction::TypeOfSelfObject() {
1381 const ObjCMethodDecl *OMD = cast<ObjCMethodDecl>(CurFuncDecl);
1382 ImplicitParamDecl *selfDecl = OMD->getSelfDecl();
Steve Naroff14108da2009-07-10 23:34:53 +00001383 const ObjCObjectPointerType *PTy = cast<ObjCObjectPointerType>(
1384 getContext().getCanonicalType(selfDecl->getType()));
Fariborz Jahanian45012a72009-02-03 00:09:52 +00001385 return PTy->getPointeeType();
1386}
1387
Chris Lattner74391b42009-03-22 21:03:39 +00001388void CodeGenFunction::EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S){
Mike Stump1eb44332009-09-09 15:08:12 +00001389 llvm::Constant *EnumerationMutationFn =
Daniel Dunbarc1cf4a52008-09-24 04:04:31 +00001390 CGM.getObjCRuntime().EnumerationMutationFunction();
Mike Stump1eb44332009-09-09 15:08:12 +00001391
Daniel Dunbarc1cf4a52008-09-24 04:04:31 +00001392 if (!EnumerationMutationFn) {
1393 CGM.ErrorUnsupported(&S, "Obj-C fast enumeration for this runtime");
1394 return;
1395 }
1396
Devang Patelbcbd03a2011-01-19 01:36:36 +00001397 CGDebugInfo *DI = getDebugInfo();
Eric Christopher73fb3502011-10-13 21:45:18 +00001398 if (DI)
1399 DI->EmitLexicalBlockStart(Builder, S.getSourceRange().getBegin());
Devang Patelbcbd03a2011-01-19 01:36:36 +00001400
Devang Patel9d99f2d2011-06-13 23:15:32 +00001401 // The local variable comes into scope immediately.
1402 AutoVarEmission variable = AutoVarEmission::invalid();
1403 if (const DeclStmt *SD = dyn_cast<DeclStmt>(S.getElement()))
1404 variable = EmitAutoVarAlloca(*cast<VarDecl>(SD->getSingleDecl()));
1405
John McCalld88687f2011-01-07 01:49:06 +00001406 JumpDest LoopEnd = getJumpDestInCurrentScope("forcoll.end");
Mike Stump1eb44332009-09-09 15:08:12 +00001407
Anders Carlssonf484c312008-08-31 02:33:12 +00001408 // Fast enumeration state.
Douglas Gregor0815b572011-08-09 17:23:49 +00001409 QualType StateTy = CGM.getObjCFastEnumerationStateType();
Daniel Dunbar195337d2010-02-09 02:48:28 +00001410 llvm::Value *StatePtr = CreateMemTemp(StateTy, "state.ptr");
Anders Carlsson1884eb02010-05-22 17:35:42 +00001411 EmitNullInitialization(StatePtr, StateTy);
Mike Stump1eb44332009-09-09 15:08:12 +00001412
Anders Carlssonf484c312008-08-31 02:33:12 +00001413 // Number of elements in the items array.
Anders Carlsson2abd89c2008-08-31 04:05:03 +00001414 static const unsigned NumItems = 16;
Mike Stump1eb44332009-09-09 15:08:12 +00001415
John McCalld88687f2011-01-07 01:49:06 +00001416 // Fetch the countByEnumeratingWithState:objects:count: selector.
Benjamin Kramerad468862010-03-30 11:36:44 +00001417 IdentifierInfo *II[] = {
1418 &CGM.getContext().Idents.get("countByEnumeratingWithState"),
1419 &CGM.getContext().Idents.get("objects"),
1420 &CGM.getContext().Idents.get("count")
1421 };
1422 Selector FastEnumSel =
1423 CGM.getContext().Selectors.getSelector(llvm::array_lengthof(II), &II[0]);
Anders Carlssonf484c312008-08-31 02:33:12 +00001424
1425 QualType ItemsTy =
1426 getContext().getConstantArrayType(getContext().getObjCIdType(),
Mike Stump1eb44332009-09-09 15:08:12 +00001427 llvm::APInt(32, NumItems),
Anders Carlssonf484c312008-08-31 02:33:12 +00001428 ArrayType::Normal, 0);
Daniel Dunbar195337d2010-02-09 02:48:28 +00001429 llvm::Value *ItemsPtr = CreateMemTemp(ItemsTy, "items.ptr");
Mike Stump1eb44332009-09-09 15:08:12 +00001430
John McCall990567c2011-07-27 01:07:15 +00001431 // Emit the collection pointer. In ARC, we do a retain.
1432 llvm::Value *Collection;
David Blaikie4e4d0842012-03-11 07:00:24 +00001433 if (getLangOpts().ObjCAutoRefCount) {
John McCall990567c2011-07-27 01:07:15 +00001434 Collection = EmitARCRetainScalarExpr(S.getCollection());
1435
1436 // Enter a cleanup to do the release.
1437 EmitObjCConsumeObject(S.getCollection()->getType(), Collection);
1438 } else {
1439 Collection = EmitScalarExpr(S.getCollection());
1440 }
Mike Stump1eb44332009-09-09 15:08:12 +00001441
John McCall4b302d32011-08-05 00:14:38 +00001442 // The 'continue' label needs to appear within the cleanup for the
1443 // collection object.
1444 JumpDest AfterBody = getJumpDestInCurrentScope("forcoll.next");
1445
John McCalld88687f2011-01-07 01:49:06 +00001446 // Send it our message:
Anders Carlssonf484c312008-08-31 02:33:12 +00001447 CallArgList Args;
John McCalld88687f2011-01-07 01:49:06 +00001448
1449 // The first argument is a temporary of the enumeration-state type.
Eli Friedman04c9a492011-05-02 17:57:46 +00001450 Args.add(RValue::get(StatePtr), getContext().getPointerType(StateTy));
Mike Stump1eb44332009-09-09 15:08:12 +00001451
John McCalld88687f2011-01-07 01:49:06 +00001452 // The second argument is a temporary array with space for NumItems
1453 // pointers. We'll actually be loading elements from the array
1454 // pointer written into the control state; this buffer is so that
1455 // collections that *aren't* backed by arrays can still queue up
1456 // batches of elements.
Eli Friedman04c9a492011-05-02 17:57:46 +00001457 Args.add(RValue::get(ItemsPtr), getContext().getPointerType(ItemsTy));
Mike Stump1eb44332009-09-09 15:08:12 +00001458
John McCalld88687f2011-01-07 01:49:06 +00001459 // The third argument is the capacity of that temporary array.
Chris Lattner2acc6e32011-07-18 04:24:23 +00001460 llvm::Type *UnsignedLongLTy = ConvertType(getContext().UnsignedLongTy);
Owen Anderson4a28d5d2009-07-24 23:12:58 +00001461 llvm::Constant *Count = llvm::ConstantInt::get(UnsignedLongLTy, NumItems);
Eli Friedman04c9a492011-05-02 17:57:46 +00001462 Args.add(RValue::get(Count), getContext().UnsignedLongTy);
Mike Stump1eb44332009-09-09 15:08:12 +00001463
John McCalld88687f2011-01-07 01:49:06 +00001464 // Start the enumeration.
Mike Stump1eb44332009-09-09 15:08:12 +00001465 RValue CountRV =
John McCallef072fd2010-05-22 01:48:05 +00001466 CGM.getObjCRuntime().GenerateMessageSend(*this, ReturnValueSlot(),
Anders Carlssonf484c312008-08-31 02:33:12 +00001467 getContext().UnsignedLongTy,
1468 FastEnumSel,
David Chisnallc6cd5fd2010-04-28 19:33:36 +00001469 Collection, Args);
Anders Carlssonf484c312008-08-31 02:33:12 +00001470
John McCalld88687f2011-01-07 01:49:06 +00001471 // The initial number of objects that were returned in the buffer.
1472 llvm::Value *initialBufferLimit = CountRV.getScalarVal();
Mike Stump1eb44332009-09-09 15:08:12 +00001473
John McCalld88687f2011-01-07 01:49:06 +00001474 llvm::BasicBlock *EmptyBB = createBasicBlock("forcoll.empty");
1475 llvm::BasicBlock *LoopInitBB = createBasicBlock("forcoll.loopinit");
Mike Stump1eb44332009-09-09 15:08:12 +00001476
John McCalld88687f2011-01-07 01:49:06 +00001477 llvm::Value *zero = llvm::Constant::getNullValue(UnsignedLongLTy);
Anders Carlssonf484c312008-08-31 02:33:12 +00001478
John McCalld88687f2011-01-07 01:49:06 +00001479 // If the limit pointer was zero to begin with, the collection is
1480 // empty; skip all this.
1481 Builder.CreateCondBr(Builder.CreateICmpEQ(initialBufferLimit, zero, "iszero"),
1482 EmptyBB, LoopInitBB);
Anders Carlssonf484c312008-08-31 02:33:12 +00001483
John McCalld88687f2011-01-07 01:49:06 +00001484 // Otherwise, initialize the loop.
1485 EmitBlock(LoopInitBB);
Mike Stump1eb44332009-09-09 15:08:12 +00001486
John McCalld88687f2011-01-07 01:49:06 +00001487 // Save the initial mutations value. This is the value at an
1488 // address that was written into the state object by
1489 // countByEnumeratingWithState:objects:count:.
Mike Stump1eb44332009-09-09 15:08:12 +00001490 llvm::Value *StateMutationsPtrPtr =
Anders Carlsson2abd89c2008-08-31 04:05:03 +00001491 Builder.CreateStructGEP(StatePtr, 2, "mutationsptr.ptr");
Mike Stump1eb44332009-09-09 15:08:12 +00001492 llvm::Value *StateMutationsPtr = Builder.CreateLoad(StateMutationsPtrPtr,
Anders Carlsson2abd89c2008-08-31 04:05:03 +00001493 "mutationsptr");
Mike Stump1eb44332009-09-09 15:08:12 +00001494
John McCalld88687f2011-01-07 01:49:06 +00001495 llvm::Value *initialMutations =
1496 Builder.CreateLoad(StateMutationsPtr, "forcoll.initial-mutations");
Mike Stump1eb44332009-09-09 15:08:12 +00001497
John McCalld88687f2011-01-07 01:49:06 +00001498 // Start looping. This is the point we return to whenever we have a
1499 // fresh, non-empty batch of objects.
1500 llvm::BasicBlock *LoopBodyBB = createBasicBlock("forcoll.loopbody");
1501 EmitBlock(LoopBodyBB);
Mike Stump1eb44332009-09-09 15:08:12 +00001502
John McCalld88687f2011-01-07 01:49:06 +00001503 // The current index into the buffer.
Jay Foadbbf3bac2011-03-30 11:28:58 +00001504 llvm::PHINode *index = Builder.CreatePHI(UnsignedLongLTy, 3, "forcoll.index");
John McCalld88687f2011-01-07 01:49:06 +00001505 index->addIncoming(zero, LoopInitBB);
Anders Carlssonf484c312008-08-31 02:33:12 +00001506
John McCalld88687f2011-01-07 01:49:06 +00001507 // The current buffer size.
Jay Foadbbf3bac2011-03-30 11:28:58 +00001508 llvm::PHINode *count = Builder.CreatePHI(UnsignedLongLTy, 3, "forcoll.count");
John McCalld88687f2011-01-07 01:49:06 +00001509 count->addIncoming(initialBufferLimit, LoopInitBB);
Mike Stump1eb44332009-09-09 15:08:12 +00001510
John McCalld88687f2011-01-07 01:49:06 +00001511 // Check whether the mutations value has changed from where it was
1512 // at start. StateMutationsPtr should actually be invariant between
1513 // refreshes.
Anders Carlsson2abd89c2008-08-31 04:05:03 +00001514 StateMutationsPtr = Builder.CreateLoad(StateMutationsPtrPtr, "mutationsptr");
John McCalld88687f2011-01-07 01:49:06 +00001515 llvm::Value *currentMutations
1516 = Builder.CreateLoad(StateMutationsPtr, "statemutations");
Anders Carlsson2abd89c2008-08-31 04:05:03 +00001517
John McCalld88687f2011-01-07 01:49:06 +00001518 llvm::BasicBlock *WasMutatedBB = createBasicBlock("forcoll.mutated");
Dan Gohman361cf982011-03-02 22:39:34 +00001519 llvm::BasicBlock *WasNotMutatedBB = createBasicBlock("forcoll.notmutated");
Mike Stump1eb44332009-09-09 15:08:12 +00001520
John McCalld88687f2011-01-07 01:49:06 +00001521 Builder.CreateCondBr(Builder.CreateICmpEQ(currentMutations, initialMutations),
1522 WasNotMutatedBB, WasMutatedBB);
Mike Stump1eb44332009-09-09 15:08:12 +00001523
John McCalld88687f2011-01-07 01:49:06 +00001524 // If so, call the enumeration-mutation function.
1525 EmitBlock(WasMutatedBB);
Anders Carlsson2abd89c2008-08-31 04:05:03 +00001526 llvm::Value *V =
Mike Stump1eb44332009-09-09 15:08:12 +00001527 Builder.CreateBitCast(Collection,
Benjamin Kramer578faa82011-09-27 21:06:10 +00001528 ConvertType(getContext().getObjCIdType()));
Daniel Dunbar2b2105e2009-02-03 23:55:40 +00001529 CallArgList Args2;
Eli Friedman04c9a492011-05-02 17:57:46 +00001530 Args2.add(RValue::get(V), getContext().getObjCIdType());
Mike Stumpf5408fe2009-05-16 07:57:57 +00001531 // FIXME: We shouldn't need to get the function info here, the runtime already
1532 // should have computed it to build the function.
John McCall0f3d0972012-07-07 06:41:13 +00001533 EmitCall(CGM.getTypes().arrangeFreeFunctionCall(getContext().VoidTy, Args2,
1534 FunctionType::ExtInfo(),
1535 RequiredArgs::All),
Anders Carlssonf3c47c92009-12-24 19:25:24 +00001536 EnumerationMutationFn, ReturnValueSlot(), Args2);
Mike Stump1eb44332009-09-09 15:08:12 +00001537
John McCalld88687f2011-01-07 01:49:06 +00001538 // Otherwise, or if the mutation function returns, just continue.
1539 EmitBlock(WasNotMutatedBB);
Mike Stump1eb44332009-09-09 15:08:12 +00001540
John McCalld88687f2011-01-07 01:49:06 +00001541 // Initialize the element variable.
1542 RunCleanupsScope elementVariableScope(*this);
John McCall57b3b6a2011-02-22 07:16:58 +00001543 bool elementIsVariable;
John McCalld88687f2011-01-07 01:49:06 +00001544 LValue elementLValue;
1545 QualType elementType;
1546 if (const DeclStmt *SD = dyn_cast<DeclStmt>(S.getElement())) {
John McCall57b3b6a2011-02-22 07:16:58 +00001547 // Initialize the variable, in case it's a __block variable or something.
1548 EmitAutoVarInit(variable);
John McCalld88687f2011-01-07 01:49:06 +00001549
John McCall57b3b6a2011-02-22 07:16:58 +00001550 const VarDecl* D = cast<VarDecl>(SD->getSingleDecl());
John McCallf4b88a42012-03-10 09:33:50 +00001551 DeclRefExpr tempDRE(const_cast<VarDecl*>(D), false, D->getType(),
John McCalld88687f2011-01-07 01:49:06 +00001552 VK_LValue, SourceLocation());
1553 elementLValue = EmitLValue(&tempDRE);
1554 elementType = D->getType();
John McCall57b3b6a2011-02-22 07:16:58 +00001555 elementIsVariable = true;
John McCall7acddac2011-06-17 06:42:21 +00001556
1557 if (D->isARCPseudoStrong())
1558 elementLValue.getQuals().setObjCLifetime(Qualifiers::OCL_ExplicitNone);
John McCalld88687f2011-01-07 01:49:06 +00001559 } else {
1560 elementLValue = LValue(); // suppress warning
1561 elementType = cast<Expr>(S.getElement())->getType();
John McCall57b3b6a2011-02-22 07:16:58 +00001562 elementIsVariable = false;
John McCalld88687f2011-01-07 01:49:06 +00001563 }
Chris Lattner2acc6e32011-07-18 04:24:23 +00001564 llvm::Type *convertedElementType = ConvertType(elementType);
John McCalld88687f2011-01-07 01:49:06 +00001565
1566 // Fetch the buffer out of the enumeration state.
1567 // TODO: this pointer should actually be invariant between
1568 // refreshes, which would help us do certain loop optimizations.
Mike Stump1eb44332009-09-09 15:08:12 +00001569 llvm::Value *StateItemsPtr =
Anders Carlssonf484c312008-08-31 02:33:12 +00001570 Builder.CreateStructGEP(StatePtr, 1, "stateitems.ptr");
John McCalld88687f2011-01-07 01:49:06 +00001571 llvm::Value *EnumStateItems =
1572 Builder.CreateLoad(StateItemsPtr, "stateitems");
Anders Carlssonf484c312008-08-31 02:33:12 +00001573
John McCalld88687f2011-01-07 01:49:06 +00001574 // Fetch the value at the current index from the buffer.
Mike Stump1eb44332009-09-09 15:08:12 +00001575 llvm::Value *CurrentItemPtr =
John McCalld88687f2011-01-07 01:49:06 +00001576 Builder.CreateGEP(EnumStateItems, index, "currentitem.ptr");
1577 llvm::Value *CurrentItem = Builder.CreateLoad(CurrentItemPtr);
Mike Stump1eb44332009-09-09 15:08:12 +00001578
John McCalld88687f2011-01-07 01:49:06 +00001579 // Cast that value to the right type.
1580 CurrentItem = Builder.CreateBitCast(CurrentItem, convertedElementType,
1581 "currentitem");
Mike Stump1eb44332009-09-09 15:08:12 +00001582
John McCalld88687f2011-01-07 01:49:06 +00001583 // Make sure we have an l-value. Yes, this gets evaluated every
1584 // time through the loop.
John McCall7acddac2011-06-17 06:42:21 +00001585 if (!elementIsVariable) {
John McCalld88687f2011-01-07 01:49:06 +00001586 elementLValue = EmitLValue(cast<Expr>(S.getElement()));
John McCall545d9962011-06-25 02:11:03 +00001587 EmitStoreThroughLValue(RValue::get(CurrentItem), elementLValue);
John McCall7acddac2011-06-17 06:42:21 +00001588 } else {
1589 EmitScalarInit(CurrentItem, elementLValue);
1590 }
Mike Stump1eb44332009-09-09 15:08:12 +00001591
John McCall57b3b6a2011-02-22 07:16:58 +00001592 // If we do have an element variable, this assignment is the end of
1593 // its initialization.
1594 if (elementIsVariable)
1595 EmitAutoVarCleanups(variable);
1596
John McCalld88687f2011-01-07 01:49:06 +00001597 // Perform the loop body, setting up break and continue labels.
Anders Carlssone4b6d342009-02-10 05:52:02 +00001598 BreakContinueStack.push_back(BreakContinue(LoopEnd, AfterBody));
John McCalld88687f2011-01-07 01:49:06 +00001599 {
1600 RunCleanupsScope Scope(*this);
1601 EmitStmt(S.getBody());
1602 }
Anders Carlssonf484c312008-08-31 02:33:12 +00001603 BreakContinueStack.pop_back();
Mike Stump1eb44332009-09-09 15:08:12 +00001604
John McCalld88687f2011-01-07 01:49:06 +00001605 // Destroy the element variable now.
1606 elementVariableScope.ForceCleanup();
1607
1608 // Check whether there are more elements.
John McCallff8e1152010-07-23 21:56:41 +00001609 EmitBlock(AfterBody.getBlock());
Mike Stump1eb44332009-09-09 15:08:12 +00001610
John McCalld88687f2011-01-07 01:49:06 +00001611 llvm::BasicBlock *FetchMoreBB = createBasicBlock("forcoll.refetch");
Fariborz Jahanianf0906c42009-01-06 18:56:31 +00001612
John McCalld88687f2011-01-07 01:49:06 +00001613 // First we check in the local buffer.
1614 llvm::Value *indexPlusOne
1615 = Builder.CreateAdd(index, llvm::ConstantInt::get(UnsignedLongLTy, 1));
Anders Carlssonf484c312008-08-31 02:33:12 +00001616
John McCalld88687f2011-01-07 01:49:06 +00001617 // If we haven't overrun the buffer yet, we can continue.
1618 Builder.CreateCondBr(Builder.CreateICmpULT(indexPlusOne, count),
1619 LoopBodyBB, FetchMoreBB);
1620
1621 index->addIncoming(indexPlusOne, AfterBody.getBlock());
1622 count->addIncoming(count, AfterBody.getBlock());
1623
1624 // Otherwise, we have to fetch more elements.
1625 EmitBlock(FetchMoreBB);
Mike Stump1eb44332009-09-09 15:08:12 +00001626
1627 CountRV =
John McCallef072fd2010-05-22 01:48:05 +00001628 CGM.getObjCRuntime().GenerateMessageSend(*this, ReturnValueSlot(),
Anders Carlssonf484c312008-08-31 02:33:12 +00001629 getContext().UnsignedLongTy,
Mike Stump1eb44332009-09-09 15:08:12 +00001630 FastEnumSel,
David Chisnallc6cd5fd2010-04-28 19:33:36 +00001631 Collection, Args);
Mike Stump1eb44332009-09-09 15:08:12 +00001632
John McCalld88687f2011-01-07 01:49:06 +00001633 // If we got a zero count, we're done.
1634 llvm::Value *refetchCount = CountRV.getScalarVal();
1635
1636 // (note that the message send might split FetchMoreBB)
1637 index->addIncoming(zero, Builder.GetInsertBlock());
1638 count->addIncoming(refetchCount, Builder.GetInsertBlock());
1639
1640 Builder.CreateCondBr(Builder.CreateICmpEQ(refetchCount, zero),
1641 EmptyBB, LoopBodyBB);
Mike Stump1eb44332009-09-09 15:08:12 +00001642
Anders Carlssonf484c312008-08-31 02:33:12 +00001643 // No more elements.
John McCalld88687f2011-01-07 01:49:06 +00001644 EmitBlock(EmptyBB);
Anders Carlssonf484c312008-08-31 02:33:12 +00001645
John McCall57b3b6a2011-02-22 07:16:58 +00001646 if (!elementIsVariable) {
Anders Carlssonf484c312008-08-31 02:33:12 +00001647 // If the element was not a declaration, set it to be null.
1648
John McCalld88687f2011-01-07 01:49:06 +00001649 llvm::Value *null = llvm::Constant::getNullValue(convertedElementType);
1650 elementLValue = EmitLValue(cast<Expr>(S.getElement()));
John McCall545d9962011-06-25 02:11:03 +00001651 EmitStoreThroughLValue(RValue::get(null), elementLValue);
Anders Carlssonf484c312008-08-31 02:33:12 +00001652 }
1653
Eric Christopher73fb3502011-10-13 21:45:18 +00001654 if (DI)
1655 DI->EmitLexicalBlockEnd(Builder, S.getSourceRange().getEnd());
Devang Patelbcbd03a2011-01-19 01:36:36 +00001656
John McCall990567c2011-07-27 01:07:15 +00001657 // Leave the cleanup we entered in ARC.
David Blaikie4e4d0842012-03-11 07:00:24 +00001658 if (getLangOpts().ObjCAutoRefCount)
John McCall990567c2011-07-27 01:07:15 +00001659 PopCleanupBlock();
1660
John McCallff8e1152010-07-23 21:56:41 +00001661 EmitBlock(LoopEnd.getBlock());
Anders Carlsson3d8400d2008-08-30 19:51:14 +00001662}
1663
Mike Stump1eb44332009-09-09 15:08:12 +00001664void CodeGenFunction::EmitObjCAtTryStmt(const ObjCAtTryStmt &S) {
John McCallf1549f62010-07-06 01:34:17 +00001665 CGM.getObjCRuntime().EmitTryStmt(*this, S);
Anders Carlsson64d5d6c2008-09-09 10:04:29 +00001666}
1667
Mike Stump1eb44332009-09-09 15:08:12 +00001668void CodeGenFunction::EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S) {
Anders Carlsson64d5d6c2008-09-09 10:04:29 +00001669 CGM.getObjCRuntime().EmitThrowStmt(*this, S);
1670}
1671
Chris Lattner10cac6f2008-11-15 21:26:17 +00001672void CodeGenFunction::EmitObjCAtSynchronizedStmt(
Mike Stump1eb44332009-09-09 15:08:12 +00001673 const ObjCAtSynchronizedStmt &S) {
John McCallf1549f62010-07-06 01:34:17 +00001674 CGM.getObjCRuntime().EmitSynchronizedStmt(*this, S);
Chris Lattner10cac6f2008-11-15 21:26:17 +00001675}
1676
John McCall33e56f32011-09-10 06:18:15 +00001677/// Produce the code for a CK_ARCProduceObject. Just does a
John McCallf85e1932011-06-15 23:02:42 +00001678/// primitive retain.
1679llvm::Value *CodeGenFunction::EmitObjCProduceObject(QualType type,
1680 llvm::Value *value) {
1681 return EmitARCRetain(type, value);
1682}
1683
1684namespace {
1685 struct CallObjCRelease : EHScopeStack::Cleanup {
John McCallbddfd872011-08-03 22:24:24 +00001686 CallObjCRelease(llvm::Value *object) : object(object) {}
1687 llvm::Value *object;
John McCallf85e1932011-06-15 23:02:42 +00001688
John McCallad346f42011-07-12 20:27:29 +00001689 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCall5b07e802013-03-13 03:10:54 +00001690 // Releases at the end of the full-expression are imprecise.
1691 CGF.EmitARCRelease(object, ARCImpreciseLifetime);
John McCallf85e1932011-06-15 23:02:42 +00001692 }
1693 };
1694}
1695
John McCall33e56f32011-09-10 06:18:15 +00001696/// Produce the code for a CK_ARCConsumeObject. Does a primitive
John McCallf85e1932011-06-15 23:02:42 +00001697/// release at the end of the full-expression.
1698llvm::Value *CodeGenFunction::EmitObjCConsumeObject(QualType type,
1699 llvm::Value *object) {
1700 // If we're in a conditional branch, we need to make the cleanup
John McCallbddfd872011-08-03 22:24:24 +00001701 // conditional.
1702 pushFullExprCleanup<CallObjCRelease>(getARCCleanupKind(), object);
John McCallf85e1932011-06-15 23:02:42 +00001703 return object;
1704}
1705
1706llvm::Value *CodeGenFunction::EmitObjCExtendObjectLifetime(QualType type,
1707 llvm::Value *value) {
1708 return EmitARCRetainAutorelease(type, value);
1709}
1710
John McCallb6a60792013-03-23 02:35:54 +00001711/// Given a number of pointers, inform the optimizer that they're
1712/// being intrinsically used up until this point in the program.
1713void CodeGenFunction::EmitARCIntrinsicUse(ArrayRef<llvm::Value*> values) {
1714 llvm::Constant *&fn = CGM.getARCEntrypoints().clang_arc_use;
1715 if (!fn) {
1716 llvm::FunctionType *fnType =
1717 llvm::FunctionType::get(CGM.VoidTy, ArrayRef<llvm::Type*>(), true);
1718 fn = CGM.CreateRuntimeFunction(fnType, "clang.arc.use");
1719 }
1720
1721 // This isn't really a "runtime" function, but as an intrinsic it
1722 // doesn't really matter as long as we align things up.
1723 EmitNounwindRuntimeCall(fn, values);
1724}
1725
John McCallf85e1932011-06-15 23:02:42 +00001726
1727static llvm::Constant *createARCRuntimeFunction(CodeGenModule &CGM,
Chris Lattner2acc6e32011-07-18 04:24:23 +00001728 llvm::FunctionType *type,
Chris Lattner5f9e2722011-07-23 10:55:15 +00001729 StringRef fnName) {
John McCallf85e1932011-06-15 23:02:42 +00001730 llvm::Constant *fn = CGM.CreateRuntimeFunction(type, fnName);
1731
Michael Gottesman554b07d2013-02-02 00:57:44 +00001732 if (llvm::Function *f = dyn_cast<llvm::Function>(fn)) {
Michael Gottesmancfe18a12013-02-02 01:05:06 +00001733 // If the target runtime doesn't naturally support ARC, emit weak
1734 // references to the runtime support library. We don't really
1735 // permit this to fail, but we need a particular relocation style.
Michael Gottesman554b07d2013-02-02 00:57:44 +00001736 if (!CGM.getLangOpts().ObjCRuntime.hasNativeARC()) {
John McCallf85e1932011-06-15 23:02:42 +00001737 f->setLinkage(llvm::Function::ExternalWeakLinkage);
Michael Gottesman554b07d2013-02-02 00:57:44 +00001738 } else if (fnName == "objc_retain" || fnName == "objc_release") {
1739 // If we have Native ARC, set nonlazybind attribute for these APIs for
1740 // performance.
Bill Wendling72390b32012-12-20 19:27:06 +00001741 f->addFnAttr(llvm::Attribute::NonLazyBind);
Michael Gottesmandb99e8b2013-02-02 01:03:01 +00001742 }
Michael Gottesman554b07d2013-02-02 00:57:44 +00001743 }
John McCallf85e1932011-06-15 23:02:42 +00001744
1745 return fn;
1746}
1747
1748/// Perform an operation having the signature
1749/// i8* (i8*)
1750/// where a null input causes a no-op and returns null.
1751static llvm::Value *emitARCValueOperation(CodeGenFunction &CGF,
1752 llvm::Value *value,
1753 llvm::Constant *&fn,
Chad Rosierdf76f1e2012-12-12 17:52:21 +00001754 StringRef fnName,
1755 bool isTailCall = false) {
John McCallf85e1932011-06-15 23:02:42 +00001756 if (isa<llvm::ConstantPointerNull>(value)) return value;
1757
1758 if (!fn) {
Chris Lattner2acc6e32011-07-18 04:24:23 +00001759 llvm::FunctionType *fnType =
Benjamin Kramer76ecdfc2013-03-07 21:18:31 +00001760 llvm::FunctionType::get(CGF.Int8PtrTy, CGF.Int8PtrTy, false);
John McCallf85e1932011-06-15 23:02:42 +00001761 fn = createARCRuntimeFunction(CGF.CGM, fnType, fnName);
1762 }
1763
1764 // Cast the argument to 'id'.
Chris Lattner2acc6e32011-07-18 04:24:23 +00001765 llvm::Type *origType = value->getType();
John McCallf85e1932011-06-15 23:02:42 +00001766 value = CGF.Builder.CreateBitCast(value, CGF.Int8PtrTy);
1767
1768 // Call the function.
John McCallbd7370a2013-02-28 19:01:20 +00001769 llvm::CallInst *call = CGF.EmitNounwindRuntimeCall(fn, value);
Chad Rosierdf76f1e2012-12-12 17:52:21 +00001770 if (isTailCall)
1771 call->setTailCall();
John McCallf85e1932011-06-15 23:02:42 +00001772
1773 // Cast the result back to the original type.
1774 return CGF.Builder.CreateBitCast(call, origType);
1775}
1776
1777/// Perform an operation having the following signature:
1778/// i8* (i8**)
1779static llvm::Value *emitARCLoadOperation(CodeGenFunction &CGF,
1780 llvm::Value *addr,
1781 llvm::Constant *&fn,
Chris Lattner5f9e2722011-07-23 10:55:15 +00001782 StringRef fnName) {
John McCallf85e1932011-06-15 23:02:42 +00001783 if (!fn) {
Chris Lattner2acc6e32011-07-18 04:24:23 +00001784 llvm::FunctionType *fnType =
Benjamin Kramer76ecdfc2013-03-07 21:18:31 +00001785 llvm::FunctionType::get(CGF.Int8PtrTy, CGF.Int8PtrPtrTy, false);
John McCallf85e1932011-06-15 23:02:42 +00001786 fn = createARCRuntimeFunction(CGF.CGM, fnType, fnName);
1787 }
1788
1789 // Cast the argument to 'id*'.
Chris Lattner2acc6e32011-07-18 04:24:23 +00001790 llvm::Type *origType = addr->getType();
John McCallf85e1932011-06-15 23:02:42 +00001791 addr = CGF.Builder.CreateBitCast(addr, CGF.Int8PtrPtrTy);
1792
1793 // Call the function.
John McCallbd7370a2013-02-28 19:01:20 +00001794 llvm::Value *result = CGF.EmitNounwindRuntimeCall(fn, addr);
John McCallf85e1932011-06-15 23:02:42 +00001795
1796 // Cast the result back to a dereference of the original type.
John McCallf85e1932011-06-15 23:02:42 +00001797 if (origType != CGF.Int8PtrPtrTy)
1798 result = CGF.Builder.CreateBitCast(result,
1799 cast<llvm::PointerType>(origType)->getElementType());
1800
1801 return result;
1802}
1803
1804/// Perform an operation having the following signature:
1805/// i8* (i8**, i8*)
1806static llvm::Value *emitARCStoreOperation(CodeGenFunction &CGF,
1807 llvm::Value *addr,
1808 llvm::Value *value,
1809 llvm::Constant *&fn,
Chris Lattner5f9e2722011-07-23 10:55:15 +00001810 StringRef fnName,
John McCallf85e1932011-06-15 23:02:42 +00001811 bool ignored) {
1812 assert(cast<llvm::PointerType>(addr->getType())->getElementType()
1813 == value->getType());
1814
1815 if (!fn) {
Benjamin Kramer1d236ab2011-10-15 12:20:02 +00001816 llvm::Type *argTypes[] = { CGF.Int8PtrPtrTy, CGF.Int8PtrTy };
John McCallf85e1932011-06-15 23:02:42 +00001817
Chris Lattner2acc6e32011-07-18 04:24:23 +00001818 llvm::FunctionType *fnType
John McCallf85e1932011-06-15 23:02:42 +00001819 = llvm::FunctionType::get(CGF.Int8PtrTy, argTypes, false);
1820 fn = createARCRuntimeFunction(CGF.CGM, fnType, fnName);
1821 }
1822
Chris Lattner2acc6e32011-07-18 04:24:23 +00001823 llvm::Type *origType = value->getType();
John McCallf85e1932011-06-15 23:02:42 +00001824
John McCallbd7370a2013-02-28 19:01:20 +00001825 llvm::Value *args[] = {
1826 CGF.Builder.CreateBitCast(addr, CGF.Int8PtrPtrTy),
1827 CGF.Builder.CreateBitCast(value, CGF.Int8PtrTy)
1828 };
1829 llvm::CallInst *result = CGF.EmitNounwindRuntimeCall(fn, args);
John McCallf85e1932011-06-15 23:02:42 +00001830
1831 if (ignored) return 0;
1832
1833 return CGF.Builder.CreateBitCast(result, origType);
1834}
1835
1836/// Perform an operation having the following signature:
1837/// void (i8**, i8**)
1838static void emitARCCopyOperation(CodeGenFunction &CGF,
1839 llvm::Value *dst,
1840 llvm::Value *src,
1841 llvm::Constant *&fn,
Chris Lattner5f9e2722011-07-23 10:55:15 +00001842 StringRef fnName) {
John McCallf85e1932011-06-15 23:02:42 +00001843 assert(dst->getType() == src->getType());
1844
1845 if (!fn) {
Benjamin Kramer76ecdfc2013-03-07 21:18:31 +00001846 llvm::Type *argTypes[] = { CGF.Int8PtrPtrTy, CGF.Int8PtrPtrTy };
1847
Chris Lattner2acc6e32011-07-18 04:24:23 +00001848 llvm::FunctionType *fnType
John McCallf85e1932011-06-15 23:02:42 +00001849 = llvm::FunctionType::get(CGF.Builder.getVoidTy(), argTypes, false);
1850 fn = createARCRuntimeFunction(CGF.CGM, fnType, fnName);
1851 }
1852
John McCallbd7370a2013-02-28 19:01:20 +00001853 llvm::Value *args[] = {
1854 CGF.Builder.CreateBitCast(dst, CGF.Int8PtrPtrTy),
1855 CGF.Builder.CreateBitCast(src, CGF.Int8PtrPtrTy)
1856 };
1857 CGF.EmitNounwindRuntimeCall(fn, args);
John McCallf85e1932011-06-15 23:02:42 +00001858}
1859
1860/// Produce the code to do a retain. Based on the type, calls one of:
James Dennett9d96e9c2012-06-22 05:41:30 +00001861/// call i8* \@objc_retain(i8* %value)
1862/// call i8* \@objc_retainBlock(i8* %value)
John McCallf85e1932011-06-15 23:02:42 +00001863llvm::Value *CodeGenFunction::EmitARCRetain(QualType type, llvm::Value *value) {
1864 if (type->isBlockPointerType())
John McCall348f16f2011-10-04 06:23:45 +00001865 return EmitARCRetainBlock(value, /*mandatory*/ false);
John McCallf85e1932011-06-15 23:02:42 +00001866 else
1867 return EmitARCRetainNonBlock(value);
1868}
1869
1870/// Retain the given object, with normal retain semantics.
James Dennett9d96e9c2012-06-22 05:41:30 +00001871/// call i8* \@objc_retain(i8* %value)
John McCallf85e1932011-06-15 23:02:42 +00001872llvm::Value *CodeGenFunction::EmitARCRetainNonBlock(llvm::Value *value) {
1873 return emitARCValueOperation(*this, value,
1874 CGM.getARCEntrypoints().objc_retain,
1875 "objc_retain");
1876}
1877
1878/// Retain the given block, with _Block_copy semantics.
James Dennett9d96e9c2012-06-22 05:41:30 +00001879/// call i8* \@objc_retainBlock(i8* %value)
John McCall348f16f2011-10-04 06:23:45 +00001880///
1881/// \param mandatory - If false, emit the call with metadata
1882/// indicating that it's okay for the optimizer to eliminate this call
1883/// if it can prove that the block never escapes except down the stack.
1884llvm::Value *CodeGenFunction::EmitARCRetainBlock(llvm::Value *value,
1885 bool mandatory) {
1886 llvm::Value *result
1887 = emitARCValueOperation(*this, value,
1888 CGM.getARCEntrypoints().objc_retainBlock,
1889 "objc_retainBlock");
1890
1891 // If the copy isn't mandatory, add !clang.arc.copy_on_escape to
1892 // tell the optimizer that it doesn't need to do this copy if the
1893 // block doesn't escape, where being passed as an argument doesn't
1894 // count as escaping.
1895 if (!mandatory && isa<llvm::Instruction>(result)) {
1896 llvm::CallInst *call
1897 = cast<llvm::CallInst>(result->stripPointerCasts());
1898 assert(call->getCalledValue() == CGM.getARCEntrypoints().objc_retainBlock);
1899
1900 SmallVector<llvm::Value*,1> args;
1901 call->setMetadata("clang.arc.copy_on_escape",
1902 llvm::MDNode::get(Builder.getContext(), args));
1903 }
1904
1905 return result;
John McCallf85e1932011-06-15 23:02:42 +00001906}
1907
1908/// Retain the given object which is the result of a function call.
James Dennett9d96e9c2012-06-22 05:41:30 +00001909/// call i8* \@objc_retainAutoreleasedReturnValue(i8* %value)
John McCallf85e1932011-06-15 23:02:42 +00001910///
1911/// Yes, this function name is one character away from a different
1912/// call with completely different semantics.
1913llvm::Value *
1914CodeGenFunction::EmitARCRetainAutoreleasedReturnValue(llvm::Value *value) {
1915 // Fetch the void(void) inline asm which marks that we're going to
1916 // retain the autoreleased return value.
1917 llvm::InlineAsm *&marker
1918 = CGM.getARCEntrypoints().retainAutoreleasedReturnValueMarker;
1919 if (!marker) {
Chris Lattner5f9e2722011-07-23 10:55:15 +00001920 StringRef assembly
John McCallf85e1932011-06-15 23:02:42 +00001921 = CGM.getTargetCodeGenInfo()
1922 .getARCRetainAutoreleasedReturnValueMarker();
1923
1924 // If we have an empty assembly string, there's nothing to do.
1925 if (assembly.empty()) {
1926
1927 // Otherwise, at -O0, build an inline asm that we're going to call
1928 // in a moment.
1929 } else if (CGM.getCodeGenOpts().OptimizationLevel == 0) {
1930 llvm::FunctionType *type =
Chris Lattner8b418682012-02-07 00:39:47 +00001931 llvm::FunctionType::get(VoidTy, /*variadic*/false);
John McCallf85e1932011-06-15 23:02:42 +00001932
1933 marker = llvm::InlineAsm::get(type, assembly, "", /*sideeffects*/ true);
1934
1935 // If we're at -O1 and above, we don't want to litter the code
1936 // with this marker yet, so leave a breadcrumb for the ARC
1937 // optimizer to pick up.
1938 } else {
1939 llvm::NamedMDNode *metadata =
1940 CGM.getModule().getOrInsertNamedMetadata(
1941 "clang.arc.retainAutoreleasedReturnValueMarker");
1942 assert(metadata->getNumOperands() <= 1);
1943 if (metadata->getNumOperands() == 0) {
1944 llvm::Value *string = llvm::MDString::get(getLLVMContext(), assembly);
Jay Foadda549e82011-07-29 13:56:53 +00001945 metadata->addOperand(llvm::MDNode::get(getLLVMContext(), string));
John McCallf85e1932011-06-15 23:02:42 +00001946 }
1947 }
1948 }
1949
1950 // Call the marker asm if we made one, which we do only at -O0.
1951 if (marker) Builder.CreateCall(marker);
1952
1953 return emitARCValueOperation(*this, value,
1954 CGM.getARCEntrypoints().objc_retainAutoreleasedReturnValue,
1955 "objc_retainAutoreleasedReturnValue");
1956}
1957
1958/// Release the given object.
James Dennett9d96e9c2012-06-22 05:41:30 +00001959/// call void \@objc_release(i8* %value)
John McCall5b07e802013-03-13 03:10:54 +00001960void CodeGenFunction::EmitARCRelease(llvm::Value *value,
1961 ARCPreciseLifetime_t precise) {
John McCallf85e1932011-06-15 23:02:42 +00001962 if (isa<llvm::ConstantPointerNull>(value)) return;
1963
1964 llvm::Constant *&fn = CGM.getARCEntrypoints().objc_release;
1965 if (!fn) {
Chris Lattner2acc6e32011-07-18 04:24:23 +00001966 llvm::FunctionType *fnType =
Benjamin Kramer76ecdfc2013-03-07 21:18:31 +00001967 llvm::FunctionType::get(Builder.getVoidTy(), Int8PtrTy, false);
John McCallf85e1932011-06-15 23:02:42 +00001968 fn = createARCRuntimeFunction(CGM, fnType, "objc_release");
1969 }
1970
1971 // Cast the argument to 'id'.
1972 value = Builder.CreateBitCast(value, Int8PtrTy);
1973
1974 // Call objc_release.
John McCallbd7370a2013-02-28 19:01:20 +00001975 llvm::CallInst *call = EmitNounwindRuntimeCall(fn, value);
John McCallf85e1932011-06-15 23:02:42 +00001976
John McCall5b07e802013-03-13 03:10:54 +00001977 if (precise == ARCImpreciseLifetime) {
Chris Lattner5f9e2722011-07-23 10:55:15 +00001978 SmallVector<llvm::Value*,1> args;
John McCallf85e1932011-06-15 23:02:42 +00001979 call->setMetadata("clang.imprecise_release",
1980 llvm::MDNode::get(Builder.getContext(), args));
1981 }
1982}
1983
John McCall015f33b2012-10-17 02:28:37 +00001984/// Destroy a __strong variable.
1985///
1986/// At -O0, emit a call to store 'null' into the address;
1987/// instrumenting tools prefer this because the address is exposed,
1988/// but it's relatively cumbersome to optimize.
1989///
1990/// At -O1 and above, just load and call objc_release.
1991///
1992/// call void \@objc_storeStrong(i8** %addr, i8* null)
John McCall5b07e802013-03-13 03:10:54 +00001993void CodeGenFunction::EmitARCDestroyStrong(llvm::Value *addr,
1994 ARCPreciseLifetime_t precise) {
John McCall015f33b2012-10-17 02:28:37 +00001995 if (CGM.getCodeGenOpts().OptimizationLevel == 0) {
1996 llvm::PointerType *addrTy = cast<llvm::PointerType>(addr->getType());
1997 llvm::Value *null = llvm::ConstantPointerNull::get(
1998 cast<llvm::PointerType>(addrTy->getElementType()));
1999 EmitARCStoreStrongCall(addr, null, /*ignored*/ true);
2000 return;
2001 }
2002
2003 llvm::Value *value = Builder.CreateLoad(addr);
2004 EmitARCRelease(value, precise);
2005}
2006
John McCallf85e1932011-06-15 23:02:42 +00002007/// Store into a strong object. Always calls this:
James Dennett9d96e9c2012-06-22 05:41:30 +00002008/// call void \@objc_storeStrong(i8** %addr, i8* %value)
John McCallf85e1932011-06-15 23:02:42 +00002009llvm::Value *CodeGenFunction::EmitARCStoreStrongCall(llvm::Value *addr,
2010 llvm::Value *value,
2011 bool ignored) {
2012 assert(cast<llvm::PointerType>(addr->getType())->getElementType()
2013 == value->getType());
2014
2015 llvm::Constant *&fn = CGM.getARCEntrypoints().objc_storeStrong;
2016 if (!fn) {
Chris Lattner9cbe4f02011-07-09 17:41:47 +00002017 llvm::Type *argTypes[] = { Int8PtrPtrTy, Int8PtrTy };
Chris Lattner2acc6e32011-07-18 04:24:23 +00002018 llvm::FunctionType *fnType
John McCallf85e1932011-06-15 23:02:42 +00002019 = llvm::FunctionType::get(Builder.getVoidTy(), argTypes, false);
2020 fn = createARCRuntimeFunction(CGM, fnType, "objc_storeStrong");
2021 }
2022
John McCallbd7370a2013-02-28 19:01:20 +00002023 llvm::Value *args[] = {
2024 Builder.CreateBitCast(addr, Int8PtrPtrTy),
2025 Builder.CreateBitCast(value, Int8PtrTy)
2026 };
2027 EmitNounwindRuntimeCall(fn, args);
John McCallf85e1932011-06-15 23:02:42 +00002028
2029 if (ignored) return 0;
2030 return value;
2031}
2032
2033/// Store into a strong object. Sometimes calls this:
James Dennett9d96e9c2012-06-22 05:41:30 +00002034/// call void \@objc_storeStrong(i8** %addr, i8* %value)
John McCallf85e1932011-06-15 23:02:42 +00002035/// Other times, breaks it down into components.
John McCall545d9962011-06-25 02:11:03 +00002036llvm::Value *CodeGenFunction::EmitARCStoreStrong(LValue dst,
John McCallf85e1932011-06-15 23:02:42 +00002037 llvm::Value *newValue,
2038 bool ignored) {
John McCall545d9962011-06-25 02:11:03 +00002039 QualType type = dst.getType();
John McCallf85e1932011-06-15 23:02:42 +00002040 bool isBlock = type->isBlockPointerType();
2041
2042 // Use a store barrier at -O0 unless this is a block type or the
2043 // lvalue is inadequately aligned.
2044 if (shouldUseFusedARCCalls() &&
2045 !isBlock &&
Eli Friedman6da2c712011-12-03 04:14:32 +00002046 (dst.getAlignment().isZero() ||
2047 dst.getAlignment() >= CharUnits::fromQuantity(PointerAlignInBytes))) {
John McCallf85e1932011-06-15 23:02:42 +00002048 return EmitARCStoreStrongCall(dst.getAddress(), newValue, ignored);
2049 }
2050
2051 // Otherwise, split it out.
2052
2053 // Retain the new value.
2054 newValue = EmitARCRetain(type, newValue);
2055
2056 // Read the old value.
John McCall545d9962011-06-25 02:11:03 +00002057 llvm::Value *oldValue = EmitLoadOfScalar(dst);
John McCallf85e1932011-06-15 23:02:42 +00002058
2059 // Store. We do this before the release so that any deallocs won't
2060 // see the old value.
John McCall545d9962011-06-25 02:11:03 +00002061 EmitStoreOfScalar(newValue, dst);
John McCallf85e1932011-06-15 23:02:42 +00002062
2063 // Finally, release the old value.
John McCall5b07e802013-03-13 03:10:54 +00002064 EmitARCRelease(oldValue, dst.isARCPreciseLifetime());
John McCallf85e1932011-06-15 23:02:42 +00002065
2066 return newValue;
2067}
2068
2069/// Autorelease the given object.
James Dennett9d96e9c2012-06-22 05:41:30 +00002070/// call i8* \@objc_autorelease(i8* %value)
John McCallf85e1932011-06-15 23:02:42 +00002071llvm::Value *CodeGenFunction::EmitARCAutorelease(llvm::Value *value) {
2072 return emitARCValueOperation(*this, value,
2073 CGM.getARCEntrypoints().objc_autorelease,
2074 "objc_autorelease");
2075}
2076
2077/// Autorelease the given object.
James Dennett9d96e9c2012-06-22 05:41:30 +00002078/// call i8* \@objc_autoreleaseReturnValue(i8* %value)
John McCallf85e1932011-06-15 23:02:42 +00002079llvm::Value *
2080CodeGenFunction::EmitARCAutoreleaseReturnValue(llvm::Value *value) {
2081 return emitARCValueOperation(*this, value,
2082 CGM.getARCEntrypoints().objc_autoreleaseReturnValue,
Chad Rosierdf76f1e2012-12-12 17:52:21 +00002083 "objc_autoreleaseReturnValue",
2084 /*isTailCall*/ true);
John McCallf85e1932011-06-15 23:02:42 +00002085}
2086
2087/// Do a fused retain/autorelease of the given object.
James Dennett9d96e9c2012-06-22 05:41:30 +00002088/// call i8* \@objc_retainAutoreleaseReturnValue(i8* %value)
John McCallf85e1932011-06-15 23:02:42 +00002089llvm::Value *
2090CodeGenFunction::EmitARCRetainAutoreleaseReturnValue(llvm::Value *value) {
2091 return emitARCValueOperation(*this, value,
2092 CGM.getARCEntrypoints().objc_retainAutoreleaseReturnValue,
Chad Rosierdf76f1e2012-12-12 17:52:21 +00002093 "objc_retainAutoreleaseReturnValue",
2094 /*isTailCall*/ true);
John McCallf85e1932011-06-15 23:02:42 +00002095}
2096
2097/// Do a fused retain/autorelease of the given object.
James Dennett9d96e9c2012-06-22 05:41:30 +00002098/// call i8* \@objc_retainAutorelease(i8* %value)
John McCallf85e1932011-06-15 23:02:42 +00002099/// or
James Dennett9d96e9c2012-06-22 05:41:30 +00002100/// %retain = call i8* \@objc_retainBlock(i8* %value)
2101/// call i8* \@objc_autorelease(i8* %retain)
John McCallf85e1932011-06-15 23:02:42 +00002102llvm::Value *CodeGenFunction::EmitARCRetainAutorelease(QualType type,
2103 llvm::Value *value) {
2104 if (!type->isBlockPointerType())
2105 return EmitARCRetainAutoreleaseNonBlock(value);
2106
2107 if (isa<llvm::ConstantPointerNull>(value)) return value;
2108
Chris Lattner2acc6e32011-07-18 04:24:23 +00002109 llvm::Type *origType = value->getType();
John McCallf85e1932011-06-15 23:02:42 +00002110 value = Builder.CreateBitCast(value, Int8PtrTy);
John McCall348f16f2011-10-04 06:23:45 +00002111 value = EmitARCRetainBlock(value, /*mandatory*/ true);
John McCallf85e1932011-06-15 23:02:42 +00002112 value = EmitARCAutorelease(value);
2113 return Builder.CreateBitCast(value, origType);
2114}
2115
2116/// Do a fused retain/autorelease of the given object.
James Dennett9d96e9c2012-06-22 05:41:30 +00002117/// call i8* \@objc_retainAutorelease(i8* %value)
John McCallf85e1932011-06-15 23:02:42 +00002118llvm::Value *
2119CodeGenFunction::EmitARCRetainAutoreleaseNonBlock(llvm::Value *value) {
2120 return emitARCValueOperation(*this, value,
2121 CGM.getARCEntrypoints().objc_retainAutorelease,
2122 "objc_retainAutorelease");
2123}
2124
James Dennett9d96e9c2012-06-22 05:41:30 +00002125/// i8* \@objc_loadWeak(i8** %addr)
John McCallf85e1932011-06-15 23:02:42 +00002126/// Essentially objc_autorelease(objc_loadWeakRetained(addr)).
2127llvm::Value *CodeGenFunction::EmitARCLoadWeak(llvm::Value *addr) {
2128 return emitARCLoadOperation(*this, addr,
2129 CGM.getARCEntrypoints().objc_loadWeak,
2130 "objc_loadWeak");
2131}
2132
James Dennett9d96e9c2012-06-22 05:41:30 +00002133/// i8* \@objc_loadWeakRetained(i8** %addr)
John McCallf85e1932011-06-15 23:02:42 +00002134llvm::Value *CodeGenFunction::EmitARCLoadWeakRetained(llvm::Value *addr) {
2135 return emitARCLoadOperation(*this, addr,
2136 CGM.getARCEntrypoints().objc_loadWeakRetained,
2137 "objc_loadWeakRetained");
2138}
2139
James Dennett9d96e9c2012-06-22 05:41:30 +00002140/// i8* \@objc_storeWeak(i8** %addr, i8* %value)
John McCallf85e1932011-06-15 23:02:42 +00002141/// Returns %value.
2142llvm::Value *CodeGenFunction::EmitARCStoreWeak(llvm::Value *addr,
2143 llvm::Value *value,
2144 bool ignored) {
2145 return emitARCStoreOperation(*this, addr, value,
2146 CGM.getARCEntrypoints().objc_storeWeak,
2147 "objc_storeWeak", ignored);
2148}
2149
James Dennett9d96e9c2012-06-22 05:41:30 +00002150/// i8* \@objc_initWeak(i8** %addr, i8* %value)
John McCallf85e1932011-06-15 23:02:42 +00002151/// Returns %value. %addr is known to not have a current weak entry.
2152/// Essentially equivalent to:
2153/// *addr = nil; objc_storeWeak(addr, value);
2154void CodeGenFunction::EmitARCInitWeak(llvm::Value *addr, llvm::Value *value) {
2155 // If we're initializing to null, just write null to memory; no need
2156 // to get the runtime involved. But don't do this if optimization
2157 // is enabled, because accounting for this would make the optimizer
2158 // much more complicated.
2159 if (isa<llvm::ConstantPointerNull>(value) &&
2160 CGM.getCodeGenOpts().OptimizationLevel == 0) {
2161 Builder.CreateStore(value, addr);
2162 return;
2163 }
2164
2165 emitARCStoreOperation(*this, addr, value,
2166 CGM.getARCEntrypoints().objc_initWeak,
2167 "objc_initWeak", /*ignored*/ true);
2168}
2169
James Dennett9d96e9c2012-06-22 05:41:30 +00002170/// void \@objc_destroyWeak(i8** %addr)
John McCallf85e1932011-06-15 23:02:42 +00002171/// Essentially objc_storeWeak(addr, nil).
2172void CodeGenFunction::EmitARCDestroyWeak(llvm::Value *addr) {
2173 llvm::Constant *&fn = CGM.getARCEntrypoints().objc_destroyWeak;
2174 if (!fn) {
Chris Lattner2acc6e32011-07-18 04:24:23 +00002175 llvm::FunctionType *fnType =
Benjamin Kramer76ecdfc2013-03-07 21:18:31 +00002176 llvm::FunctionType::get(Builder.getVoidTy(), Int8PtrPtrTy, false);
John McCallf85e1932011-06-15 23:02:42 +00002177 fn = createARCRuntimeFunction(CGM, fnType, "objc_destroyWeak");
2178 }
2179
2180 // Cast the argument to 'id*'.
2181 addr = Builder.CreateBitCast(addr, Int8PtrPtrTy);
2182
John McCallbd7370a2013-02-28 19:01:20 +00002183 EmitNounwindRuntimeCall(fn, addr);
John McCallf85e1932011-06-15 23:02:42 +00002184}
2185
James Dennett9d96e9c2012-06-22 05:41:30 +00002186/// void \@objc_moveWeak(i8** %dest, i8** %src)
John McCallf85e1932011-06-15 23:02:42 +00002187/// Disregards the current value in %dest. Leaves %src pointing to nothing.
2188/// Essentially (objc_copyWeak(dest, src), objc_destroyWeak(src)).
2189void CodeGenFunction::EmitARCMoveWeak(llvm::Value *dst, llvm::Value *src) {
2190 emitARCCopyOperation(*this, dst, src,
2191 CGM.getARCEntrypoints().objc_moveWeak,
2192 "objc_moveWeak");
2193}
2194
James Dennett9d96e9c2012-06-22 05:41:30 +00002195/// void \@objc_copyWeak(i8** %dest, i8** %src)
John McCallf85e1932011-06-15 23:02:42 +00002196/// Disregards the current value in %dest. Essentially
2197/// objc_release(objc_initWeak(dest, objc_readWeakRetained(src)))
2198void CodeGenFunction::EmitARCCopyWeak(llvm::Value *dst, llvm::Value *src) {
2199 emitARCCopyOperation(*this, dst, src,
2200 CGM.getARCEntrypoints().objc_copyWeak,
2201 "objc_copyWeak");
2202}
2203
2204/// Produce the code to do a objc_autoreleasepool_push.
James Dennett9d96e9c2012-06-22 05:41:30 +00002205/// call i8* \@objc_autoreleasePoolPush(void)
John McCallf85e1932011-06-15 23:02:42 +00002206llvm::Value *CodeGenFunction::EmitObjCAutoreleasePoolPush() {
2207 llvm::Constant *&fn = CGM.getRREntrypoints().objc_autoreleasePoolPush;
2208 if (!fn) {
Chris Lattner2acc6e32011-07-18 04:24:23 +00002209 llvm::FunctionType *fnType =
John McCallf85e1932011-06-15 23:02:42 +00002210 llvm::FunctionType::get(Int8PtrTy, false);
2211 fn = createARCRuntimeFunction(CGM, fnType, "objc_autoreleasePoolPush");
2212 }
2213
John McCallbd7370a2013-02-28 19:01:20 +00002214 return EmitNounwindRuntimeCall(fn);
John McCallf85e1932011-06-15 23:02:42 +00002215}
2216
2217/// Produce the code to do a primitive release.
James Dennett9d96e9c2012-06-22 05:41:30 +00002218/// call void \@objc_autoreleasePoolPop(i8* %ptr)
John McCallf85e1932011-06-15 23:02:42 +00002219void CodeGenFunction::EmitObjCAutoreleasePoolPop(llvm::Value *value) {
2220 assert(value->getType() == Int8PtrTy);
2221
2222 llvm::Constant *&fn = CGM.getRREntrypoints().objc_autoreleasePoolPop;
2223 if (!fn) {
Chris Lattner2acc6e32011-07-18 04:24:23 +00002224 llvm::FunctionType *fnType =
Benjamin Kramer76ecdfc2013-03-07 21:18:31 +00002225 llvm::FunctionType::get(Builder.getVoidTy(), Int8PtrTy, false);
John McCallf85e1932011-06-15 23:02:42 +00002226
2227 // We don't want to use a weak import here; instead we should not
2228 // fall into this path.
2229 fn = createARCRuntimeFunction(CGM, fnType, "objc_autoreleasePoolPop");
2230 }
2231
John McCallbd7370a2013-02-28 19:01:20 +00002232 EmitNounwindRuntimeCall(fn, value);
John McCallf85e1932011-06-15 23:02:42 +00002233}
2234
2235/// Produce the code to do an MRR version objc_autoreleasepool_push.
2236/// Which is: [[NSAutoreleasePool alloc] init];
2237/// Where alloc is declared as: + (id) alloc; in NSAutoreleasePool class.
2238/// init is declared as: - (id) init; in its NSObject super class.
2239///
2240llvm::Value *CodeGenFunction::EmitObjCMRRAutoreleasePoolPush() {
2241 CGObjCRuntime &Runtime = CGM.getObjCRuntime();
John McCallbd7370a2013-02-28 19:01:20 +00002242 llvm::Value *Receiver = Runtime.EmitNSAutoreleasePoolClassRef(*this);
John McCallf85e1932011-06-15 23:02:42 +00002243 // [NSAutoreleasePool alloc]
2244 IdentifierInfo *II = &CGM.getContext().Idents.get("alloc");
2245 Selector AllocSel = getContext().Selectors.getSelector(0, &II);
2246 CallArgList Args;
2247 RValue AllocRV =
2248 Runtime.GenerateMessageSend(*this, ReturnValueSlot(),
2249 getContext().getObjCIdType(),
2250 AllocSel, Receiver, Args);
2251
2252 // [Receiver init]
2253 Receiver = AllocRV.getScalarVal();
2254 II = &CGM.getContext().Idents.get("init");
2255 Selector InitSel = getContext().Selectors.getSelector(0, &II);
2256 RValue InitRV =
2257 Runtime.GenerateMessageSend(*this, ReturnValueSlot(),
2258 getContext().getObjCIdType(),
2259 InitSel, Receiver, Args);
2260 return InitRV.getScalarVal();
2261}
2262
2263/// Produce the code to do a primitive release.
2264/// [tmp drain];
2265void CodeGenFunction::EmitObjCMRRAutoreleasePoolPop(llvm::Value *Arg) {
2266 IdentifierInfo *II = &CGM.getContext().Idents.get("drain");
2267 Selector DrainSel = getContext().Selectors.getSelector(0, &II);
2268 CallArgList Args;
2269 CGM.getObjCRuntime().GenerateMessageSend(*this, ReturnValueSlot(),
2270 getContext().VoidTy, DrainSel, Arg, Args);
2271}
2272
John McCallbdc4d802011-07-09 01:37:26 +00002273void CodeGenFunction::destroyARCStrongPrecise(CodeGenFunction &CGF,
2274 llvm::Value *addr,
2275 QualType type) {
John McCall5b07e802013-03-13 03:10:54 +00002276 CGF.EmitARCDestroyStrong(addr, ARCPreciseLifetime);
John McCallbdc4d802011-07-09 01:37:26 +00002277}
2278
2279void CodeGenFunction::destroyARCStrongImprecise(CodeGenFunction &CGF,
2280 llvm::Value *addr,
2281 QualType type) {
John McCall5b07e802013-03-13 03:10:54 +00002282 CGF.EmitARCDestroyStrong(addr, ARCImpreciseLifetime);
John McCallbdc4d802011-07-09 01:37:26 +00002283}
2284
2285void CodeGenFunction::destroyARCWeak(CodeGenFunction &CGF,
2286 llvm::Value *addr,
2287 QualType type) {
2288 CGF.EmitARCDestroyWeak(addr);
2289}
2290
John McCallf85e1932011-06-15 23:02:42 +00002291namespace {
John McCallf85e1932011-06-15 23:02:42 +00002292 struct CallObjCAutoreleasePoolObject : EHScopeStack::Cleanup {
2293 llvm::Value *Token;
2294
2295 CallObjCAutoreleasePoolObject(llvm::Value *token) : Token(token) {}
2296
John McCallad346f42011-07-12 20:27:29 +00002297 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCallf85e1932011-06-15 23:02:42 +00002298 CGF.EmitObjCAutoreleasePoolPop(Token);
2299 }
2300 };
2301 struct CallObjCMRRAutoreleasePoolObject : EHScopeStack::Cleanup {
2302 llvm::Value *Token;
2303
2304 CallObjCMRRAutoreleasePoolObject(llvm::Value *token) : Token(token) {}
2305
John McCallad346f42011-07-12 20:27:29 +00002306 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCallf85e1932011-06-15 23:02:42 +00002307 CGF.EmitObjCMRRAutoreleasePoolPop(Token);
2308 }
2309 };
2310}
2311
2312void CodeGenFunction::EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr) {
David Blaikie4e4d0842012-03-11 07:00:24 +00002313 if (CGM.getLangOpts().ObjCAutoRefCount)
John McCallf85e1932011-06-15 23:02:42 +00002314 EHStack.pushCleanup<CallObjCAutoreleasePoolObject>(NormalCleanup, Ptr);
2315 else
2316 EHStack.pushCleanup<CallObjCMRRAutoreleasePoolObject>(NormalCleanup, Ptr);
2317}
2318
John McCallf85e1932011-06-15 23:02:42 +00002319static TryEmitResult tryEmitARCRetainLoadOfScalar(CodeGenFunction &CGF,
2320 LValue lvalue,
2321 QualType type) {
2322 switch (type.getObjCLifetime()) {
2323 case Qualifiers::OCL_None:
2324 case Qualifiers::OCL_ExplicitNone:
2325 case Qualifiers::OCL_Strong:
2326 case Qualifiers::OCL_Autoreleasing:
John McCall545d9962011-06-25 02:11:03 +00002327 return TryEmitResult(CGF.EmitLoadOfLValue(lvalue).getScalarVal(),
John McCallf85e1932011-06-15 23:02:42 +00002328 false);
2329
2330 case Qualifiers::OCL_Weak:
2331 return TryEmitResult(CGF.EmitARCLoadWeakRetained(lvalue.getAddress()),
2332 true);
2333 }
2334
2335 llvm_unreachable("impossible lifetime!");
John McCallf85e1932011-06-15 23:02:42 +00002336}
2337
2338static TryEmitResult tryEmitARCRetainLoadOfScalar(CodeGenFunction &CGF,
2339 const Expr *e) {
2340 e = e->IgnoreParens();
2341 QualType type = e->getType();
2342
John McCall21480112011-08-30 00:57:29 +00002343 // If we're loading retained from a __strong xvalue, we can avoid
2344 // an extra retain/release pair by zeroing out the source of this
2345 // "move" operation.
2346 if (e->isXValue() &&
2347 !type.isConstQualified() &&
2348 type.getObjCLifetime() == Qualifiers::OCL_Strong) {
2349 // Emit the lvalue.
2350 LValue lv = CGF.EmitLValue(e);
2351
2352 // Load the object pointer.
2353 llvm::Value *result = CGF.EmitLoadOfLValue(lv).getScalarVal();
2354
2355 // Set the source pointer to NULL.
2356 CGF.EmitStoreOfScalar(getNullForVariable(lv.getAddress()), lv);
2357
2358 return TryEmitResult(result, true);
2359 }
2360
John McCallf85e1932011-06-15 23:02:42 +00002361 // As a very special optimization, in ARC++, if the l-value is the
2362 // result of a non-volatile assignment, do a simple retain of the
2363 // result of the call to objc_storeWeak instead of reloading.
David Blaikie4e4d0842012-03-11 07:00:24 +00002364 if (CGF.getLangOpts().CPlusPlus &&
John McCallf85e1932011-06-15 23:02:42 +00002365 !type.isVolatileQualified() &&
2366 type.getObjCLifetime() == Qualifiers::OCL_Weak &&
2367 isa<BinaryOperator>(e) &&
2368 cast<BinaryOperator>(e)->getOpcode() == BO_Assign)
2369 return TryEmitResult(CGF.EmitScalarExpr(e), false);
2370
2371 return tryEmitARCRetainLoadOfScalar(CGF, CGF.EmitLValue(e), type);
2372}
2373
2374static llvm::Value *emitARCRetainAfterCall(CodeGenFunction &CGF,
2375 llvm::Value *value);
2376
2377/// Given that the given expression is some sort of call (which does
2378/// not return retained), emit a retain following it.
2379static llvm::Value *emitARCRetainCall(CodeGenFunction &CGF, const Expr *e) {
2380 llvm::Value *value = CGF.EmitScalarExpr(e);
2381 return emitARCRetainAfterCall(CGF, value);
2382}
2383
2384static llvm::Value *emitARCRetainAfterCall(CodeGenFunction &CGF,
2385 llvm::Value *value) {
2386 if (llvm::CallInst *call = dyn_cast<llvm::CallInst>(value)) {
2387 CGBuilderTy::InsertPoint ip = CGF.Builder.saveIP();
2388
2389 // Place the retain immediately following the call.
2390 CGF.Builder.SetInsertPoint(call->getParent(),
2391 ++llvm::BasicBlock::iterator(call));
2392 value = CGF.EmitARCRetainAutoreleasedReturnValue(value);
2393
2394 CGF.Builder.restoreIP(ip);
2395 return value;
2396 } else if (llvm::InvokeInst *invoke = dyn_cast<llvm::InvokeInst>(value)) {
2397 CGBuilderTy::InsertPoint ip = CGF.Builder.saveIP();
2398
2399 // Place the retain at the beginning of the normal destination block.
2400 llvm::BasicBlock *BB = invoke->getNormalDest();
2401 CGF.Builder.SetInsertPoint(BB, BB->begin());
2402 value = CGF.EmitARCRetainAutoreleasedReturnValue(value);
2403
2404 CGF.Builder.restoreIP(ip);
2405 return value;
2406
2407 // Bitcasts can arise because of related-result returns. Rewrite
2408 // the operand.
2409 } else if (llvm::BitCastInst *bitcast = dyn_cast<llvm::BitCastInst>(value)) {
2410 llvm::Value *operand = bitcast->getOperand(0);
2411 operand = emitARCRetainAfterCall(CGF, operand);
2412 bitcast->setOperand(0, operand);
2413 return bitcast;
2414
2415 // Generic fall-back case.
2416 } else {
2417 // Retain using the non-block variant: we never need to do a copy
2418 // of a block that's been returned to us.
2419 return CGF.EmitARCRetainNonBlock(value);
2420 }
2421}
2422
John McCalldc05b112011-09-10 01:16:55 +00002423/// Determine whether it might be important to emit a separate
2424/// objc_retain_block on the result of the given expression, or
2425/// whether it's okay to just emit it in a +1 context.
2426static bool shouldEmitSeparateBlockRetain(const Expr *e) {
2427 assert(e->getType()->isBlockPointerType());
2428 e = e->IgnoreParens();
2429
2430 // For future goodness, emit block expressions directly in +1
2431 // contexts if we can.
2432 if (isa<BlockExpr>(e))
2433 return false;
2434
2435 if (const CastExpr *cast = dyn_cast<CastExpr>(e)) {
2436 switch (cast->getCastKind()) {
2437 // Emitting these operations in +1 contexts is goodness.
2438 case CK_LValueToRValue:
John McCall33e56f32011-09-10 06:18:15 +00002439 case CK_ARCReclaimReturnedObject:
2440 case CK_ARCConsumeObject:
2441 case CK_ARCProduceObject:
John McCalldc05b112011-09-10 01:16:55 +00002442 return false;
2443
2444 // These operations preserve a block type.
2445 case CK_NoOp:
2446 case CK_BitCast:
2447 return shouldEmitSeparateBlockRetain(cast->getSubExpr());
2448
2449 // These operations are known to be bad (or haven't been considered).
2450 case CK_AnyPointerToBlockPointerCast:
2451 default:
2452 return true;
2453 }
2454 }
2455
2456 return true;
2457}
2458
John McCall4b9c2d22011-11-06 09:01:30 +00002459/// Try to emit a PseudoObjectExpr at +1.
2460///
2461/// This massively duplicates emitPseudoObjectRValue.
2462static TryEmitResult tryEmitARCRetainPseudoObject(CodeGenFunction &CGF,
2463 const PseudoObjectExpr *E) {
Dmitri Gribenkocfa88f82013-01-12 19:30:44 +00002464 SmallVector<CodeGenFunction::OpaqueValueMappingData, 4> opaques;
John McCall4b9c2d22011-11-06 09:01:30 +00002465
2466 // Find the result expression.
2467 const Expr *resultExpr = E->getResultExpr();
2468 assert(resultExpr);
2469 TryEmitResult result;
2470
2471 for (PseudoObjectExpr::const_semantics_iterator
2472 i = E->semantics_begin(), e = E->semantics_end(); i != e; ++i) {
2473 const Expr *semantic = *i;
2474
2475 // If this semantic expression is an opaque value, bind it
2476 // to the result of its source expression.
2477 if (const OpaqueValueExpr *ov = dyn_cast<OpaqueValueExpr>(semantic)) {
2478 typedef CodeGenFunction::OpaqueValueMappingData OVMA;
2479 OVMA opaqueData;
2480
2481 // If this semantic is the result of the pseudo-object
2482 // expression, try to evaluate the source as +1.
2483 if (ov == resultExpr) {
2484 assert(!OVMA::shouldBindAsLValue(ov));
2485 result = tryEmitARCRetainScalarExpr(CGF, ov->getSourceExpr());
2486 opaqueData = OVMA::bind(CGF, ov, RValue::get(result.getPointer()));
2487
2488 // Otherwise, just bind it.
2489 } else {
2490 opaqueData = OVMA::bind(CGF, ov, ov->getSourceExpr());
2491 }
2492 opaques.push_back(opaqueData);
2493
2494 // Otherwise, if the expression is the result, evaluate it
2495 // and remember the result.
2496 } else if (semantic == resultExpr) {
2497 result = tryEmitARCRetainScalarExpr(CGF, semantic);
2498
2499 // Otherwise, evaluate the expression in an ignored context.
2500 } else {
2501 CGF.EmitIgnoredExpr(semantic);
2502 }
2503 }
2504
2505 // Unbind all the opaques now.
2506 for (unsigned i = 0, e = opaques.size(); i != e; ++i)
2507 opaques[i].unbind(CGF);
2508
2509 return result;
2510}
2511
John McCallf85e1932011-06-15 23:02:42 +00002512static TryEmitResult
2513tryEmitARCRetainScalarExpr(CodeGenFunction &CGF, const Expr *e) {
John McCall72dcecc2013-02-12 00:25:08 +00002514 // We should *never* see a nested full-expression here, because if
2515 // we fail to emit at +1, our caller must not retain after we close
2516 // out the full-expression.
2517 assert(!isa<ExprWithCleanups>(e));
John McCall990567c2011-07-27 01:07:15 +00002518
John McCallf85e1932011-06-15 23:02:42 +00002519 // The desired result type, if it differs from the type of the
2520 // ultimate opaque expression.
Chris Lattner2acc6e32011-07-18 04:24:23 +00002521 llvm::Type *resultType = 0;
John McCallf85e1932011-06-15 23:02:42 +00002522
2523 while (true) {
2524 e = e->IgnoreParens();
2525
2526 // There's a break at the end of this if-chain; anything
2527 // that wants to keep looping has to explicitly continue.
2528 if (const CastExpr *ce = dyn_cast<CastExpr>(e)) {
2529 switch (ce->getCastKind()) {
2530 // No-op casts don't change the type, so we just ignore them.
2531 case CK_NoOp:
2532 e = ce->getSubExpr();
2533 continue;
2534
2535 case CK_LValueToRValue: {
2536 TryEmitResult loadResult
2537 = tryEmitARCRetainLoadOfScalar(CGF, ce->getSubExpr());
2538 if (resultType) {
2539 llvm::Value *value = loadResult.getPointer();
2540 value = CGF.Builder.CreateBitCast(value, resultType);
2541 loadResult.setPointer(value);
2542 }
2543 return loadResult;
2544 }
2545
2546 // These casts can change the type, so remember that and
2547 // soldier on. We only need to remember the outermost such
2548 // cast, though.
John McCall1d9b3b22011-09-09 05:25:32 +00002549 case CK_CPointerToObjCPointerCast:
2550 case CK_BlockPointerToObjCPointerCast:
John McCallf85e1932011-06-15 23:02:42 +00002551 case CK_AnyPointerToBlockPointerCast:
2552 case CK_BitCast:
2553 if (!resultType)
2554 resultType = CGF.ConvertType(ce->getType());
2555 e = ce->getSubExpr();
2556 assert(e->getType()->hasPointerRepresentation());
2557 continue;
2558
2559 // For consumptions, just emit the subexpression and thus elide
2560 // the retain/release pair.
John McCall33e56f32011-09-10 06:18:15 +00002561 case CK_ARCConsumeObject: {
John McCallf85e1932011-06-15 23:02:42 +00002562 llvm::Value *result = CGF.EmitScalarExpr(ce->getSubExpr());
2563 if (resultType) result = CGF.Builder.CreateBitCast(result, resultType);
2564 return TryEmitResult(result, true);
2565 }
2566
John McCalldc05b112011-09-10 01:16:55 +00002567 // Block extends are net +0. Naively, we could just recurse on
2568 // the subexpression, but actually we need to ensure that the
2569 // value is copied as a block, so there's a little filter here.
John McCall33e56f32011-09-10 06:18:15 +00002570 case CK_ARCExtendBlockObject: {
John McCalldc05b112011-09-10 01:16:55 +00002571 llvm::Value *result; // will be a +0 value
2572
2573 // If we can't safely assume the sub-expression will produce a
2574 // block-copied value, emit the sub-expression at +0.
2575 if (shouldEmitSeparateBlockRetain(ce->getSubExpr())) {
2576 result = CGF.EmitScalarExpr(ce->getSubExpr());
2577
2578 // Otherwise, try to emit the sub-expression at +1 recursively.
2579 } else {
2580 TryEmitResult subresult
2581 = tryEmitARCRetainScalarExpr(CGF, ce->getSubExpr());
2582 result = subresult.getPointer();
2583
2584 // If that produced a retained value, just use that,
2585 // possibly casting down.
2586 if (subresult.getInt()) {
2587 if (resultType)
2588 result = CGF.Builder.CreateBitCast(result, resultType);
2589 return TryEmitResult(result, true);
2590 }
2591
2592 // Otherwise it's +0.
2593 }
2594
2595 // Retain the object as a block, then cast down.
John McCall348f16f2011-10-04 06:23:45 +00002596 result = CGF.EmitARCRetainBlock(result, /*mandatory*/ true);
John McCalldc05b112011-09-10 01:16:55 +00002597 if (resultType) result = CGF.Builder.CreateBitCast(result, resultType);
2598 return TryEmitResult(result, true);
2599 }
2600
John McCall7e5e5f42011-07-07 06:58:02 +00002601 // For reclaims, emit the subexpression as a retained call and
2602 // skip the consumption.
John McCall33e56f32011-09-10 06:18:15 +00002603 case CK_ARCReclaimReturnedObject: {
John McCall7e5e5f42011-07-07 06:58:02 +00002604 llvm::Value *result = emitARCRetainCall(CGF, ce->getSubExpr());
2605 if (resultType) result = CGF.Builder.CreateBitCast(result, resultType);
2606 return TryEmitResult(result, true);
2607 }
2608
John McCallf85e1932011-06-15 23:02:42 +00002609 default:
2610 break;
2611 }
2612
2613 // Skip __extension__.
2614 } else if (const UnaryOperator *op = dyn_cast<UnaryOperator>(e)) {
2615 if (op->getOpcode() == UO_Extension) {
2616 e = op->getSubExpr();
2617 continue;
2618 }
2619
2620 // For calls and message sends, use the retained-call logic.
2621 // Delegate inits are a special case in that they're the only
2622 // returns-retained expression that *isn't* surrounded by
2623 // a consume.
2624 } else if (isa<CallExpr>(e) ||
2625 (isa<ObjCMessageExpr>(e) &&
2626 !cast<ObjCMessageExpr>(e)->isDelegateInitCall())) {
2627 llvm::Value *result = emitARCRetainCall(CGF, e);
2628 if (resultType) result = CGF.Builder.CreateBitCast(result, resultType);
2629 return TryEmitResult(result, true);
John McCall4b9c2d22011-11-06 09:01:30 +00002630
2631 // Look through pseudo-object expressions.
2632 } else if (const PseudoObjectExpr *pseudo = dyn_cast<PseudoObjectExpr>(e)) {
2633 TryEmitResult result
2634 = tryEmitARCRetainPseudoObject(CGF, pseudo);
2635 if (resultType) {
2636 llvm::Value *value = result.getPointer();
2637 value = CGF.Builder.CreateBitCast(value, resultType);
2638 result.setPointer(value);
2639 }
2640 return result;
John McCallf85e1932011-06-15 23:02:42 +00002641 }
2642
2643 // Conservatively halt the search at any other expression kind.
2644 break;
2645 }
2646
2647 // We didn't find an obvious production, so emit what we've got and
2648 // tell the caller that we didn't manage to retain.
2649 llvm::Value *result = CGF.EmitScalarExpr(e);
2650 if (resultType) result = CGF.Builder.CreateBitCast(result, resultType);
2651 return TryEmitResult(result, false);
2652}
2653
2654static llvm::Value *emitARCRetainLoadOfScalar(CodeGenFunction &CGF,
2655 LValue lvalue,
2656 QualType type) {
2657 TryEmitResult result = tryEmitARCRetainLoadOfScalar(CGF, lvalue, type);
2658 llvm::Value *value = result.getPointer();
2659 if (!result.getInt())
2660 value = CGF.EmitARCRetain(type, value);
2661 return value;
2662}
2663
2664/// EmitARCRetainScalarExpr - Semantically equivalent to
2665/// EmitARCRetainObject(e->getType(), EmitScalarExpr(e)), but making a
2666/// best-effort attempt to peephole expressions that naturally produce
2667/// retained objects.
2668llvm::Value *CodeGenFunction::EmitARCRetainScalarExpr(const Expr *e) {
John McCall72dcecc2013-02-12 00:25:08 +00002669 // The retain needs to happen within the full-expression.
2670 if (const ExprWithCleanups *cleanups = dyn_cast<ExprWithCleanups>(e)) {
2671 enterFullExpression(cleanups);
2672 RunCleanupsScope scope(*this);
2673 return EmitARCRetainScalarExpr(cleanups->getSubExpr());
2674 }
2675
John McCallf85e1932011-06-15 23:02:42 +00002676 TryEmitResult result = tryEmitARCRetainScalarExpr(*this, e);
2677 llvm::Value *value = result.getPointer();
2678 if (!result.getInt())
2679 value = EmitARCRetain(e->getType(), value);
2680 return value;
2681}
2682
2683llvm::Value *
2684CodeGenFunction::EmitARCRetainAutoreleaseScalarExpr(const Expr *e) {
John McCall72dcecc2013-02-12 00:25:08 +00002685 // The retain needs to happen within the full-expression.
2686 if (const ExprWithCleanups *cleanups = dyn_cast<ExprWithCleanups>(e)) {
2687 enterFullExpression(cleanups);
2688 RunCleanupsScope scope(*this);
2689 return EmitARCRetainAutoreleaseScalarExpr(cleanups->getSubExpr());
2690 }
2691
John McCallf85e1932011-06-15 23:02:42 +00002692 TryEmitResult result = tryEmitARCRetainScalarExpr(*this, e);
2693 llvm::Value *value = result.getPointer();
2694 if (result.getInt())
2695 value = EmitARCAutorelease(value);
2696 else
2697 value = EmitARCRetainAutorelease(e->getType(), value);
2698 return value;
2699}
2700
John McCall348f16f2011-10-04 06:23:45 +00002701llvm::Value *CodeGenFunction::EmitARCExtendBlockObject(const Expr *e) {
2702 llvm::Value *result;
2703 bool doRetain;
2704
2705 if (shouldEmitSeparateBlockRetain(e)) {
2706 result = EmitScalarExpr(e);
2707 doRetain = true;
2708 } else {
2709 TryEmitResult subresult = tryEmitARCRetainScalarExpr(*this, e);
2710 result = subresult.getPointer();
2711 doRetain = !subresult.getInt();
2712 }
2713
2714 if (doRetain)
2715 result = EmitARCRetainBlock(result, /*mandatory*/ true);
2716 return EmitObjCConsumeObject(e->getType(), result);
2717}
2718
John McCall2b014d62011-10-01 10:32:24 +00002719llvm::Value *CodeGenFunction::EmitObjCThrowOperand(const Expr *expr) {
2720 // In ARC, retain and autorelease the expression.
David Blaikie4e4d0842012-03-11 07:00:24 +00002721 if (getLangOpts().ObjCAutoRefCount) {
John McCall2b014d62011-10-01 10:32:24 +00002722 // Do so before running any cleanups for the full-expression.
John McCall72dcecc2013-02-12 00:25:08 +00002723 // EmitARCRetainAutoreleaseScalarExpr does this for us.
John McCall2b014d62011-10-01 10:32:24 +00002724 return EmitARCRetainAutoreleaseScalarExpr(expr);
2725 }
2726
2727 // Otherwise, use the normal scalar-expression emission. The
2728 // exception machinery doesn't do anything special with the
2729 // exception like retaining it, so there's no safety associated with
2730 // only running cleanups after the throw has started, and when it
2731 // matters it tends to be substantially inferior code.
2732 return EmitScalarExpr(expr);
2733}
2734
John McCallf85e1932011-06-15 23:02:42 +00002735std::pair<LValue,llvm::Value*>
2736CodeGenFunction::EmitARCStoreStrong(const BinaryOperator *e,
2737 bool ignored) {
2738 // Evaluate the RHS first.
2739 TryEmitResult result = tryEmitARCRetainScalarExpr(*this, e->getRHS());
2740 llvm::Value *value = result.getPointer();
2741
John McCallfb720812011-07-28 07:23:35 +00002742 bool hasImmediateRetain = result.getInt();
2743
2744 // If we didn't emit a retained object, and the l-value is of block
2745 // type, then we need to emit the block-retain immediately in case
2746 // it invalidates the l-value.
2747 if (!hasImmediateRetain && e->getType()->isBlockPointerType()) {
John McCall348f16f2011-10-04 06:23:45 +00002748 value = EmitARCRetainBlock(value, /*mandatory*/ false);
John McCallfb720812011-07-28 07:23:35 +00002749 hasImmediateRetain = true;
2750 }
2751
John McCallf85e1932011-06-15 23:02:42 +00002752 LValue lvalue = EmitLValue(e->getLHS());
2753
2754 // If the RHS was emitted retained, expand this.
John McCallfb720812011-07-28 07:23:35 +00002755 if (hasImmediateRetain) {
John McCallf85e1932011-06-15 23:02:42 +00002756 llvm::Value *oldValue =
Eli Friedman6da2c712011-12-03 04:14:32 +00002757 EmitLoadOfScalar(lvalue);
2758 EmitStoreOfScalar(value, lvalue);
John McCall5b07e802013-03-13 03:10:54 +00002759 EmitARCRelease(oldValue, lvalue.isARCPreciseLifetime());
John McCallf85e1932011-06-15 23:02:42 +00002760 } else {
John McCall545d9962011-06-25 02:11:03 +00002761 value = EmitARCStoreStrong(lvalue, value, ignored);
John McCallf85e1932011-06-15 23:02:42 +00002762 }
2763
2764 return std::pair<LValue,llvm::Value*>(lvalue, value);
2765}
2766
2767std::pair<LValue,llvm::Value*>
2768CodeGenFunction::EmitARCStoreAutoreleasing(const BinaryOperator *e) {
2769 llvm::Value *value = EmitARCRetainAutoreleaseScalarExpr(e->getRHS());
2770 LValue lvalue = EmitLValue(e->getLHS());
2771
Eli Friedman6da2c712011-12-03 04:14:32 +00002772 EmitStoreOfScalar(value, lvalue);
John McCallf85e1932011-06-15 23:02:42 +00002773
2774 return std::pair<LValue,llvm::Value*>(lvalue, value);
2775}
2776
2777void CodeGenFunction::EmitObjCAutoreleasePoolStmt(
Eric Christopher16098f32012-03-29 17:31:31 +00002778 const ObjCAutoreleasePoolStmt &ARPS) {
John McCallf85e1932011-06-15 23:02:42 +00002779 const Stmt *subStmt = ARPS.getSubStmt();
2780 const CompoundStmt &S = cast<CompoundStmt>(*subStmt);
2781
2782 CGDebugInfo *DI = getDebugInfo();
Eric Christopher73fb3502011-10-13 21:45:18 +00002783 if (DI)
2784 DI->EmitLexicalBlockStart(Builder, S.getLBracLoc());
John McCallf85e1932011-06-15 23:02:42 +00002785
2786 // Keep track of the current cleanup stack depth.
2787 RunCleanupsScope Scope(*this);
John McCall0a7dd782012-08-21 02:47:43 +00002788 if (CGM.getLangOpts().ObjCRuntime.hasNativeARC()) {
John McCallf85e1932011-06-15 23:02:42 +00002789 llvm::Value *token = EmitObjCAutoreleasePoolPush();
2790 EHStack.pushCleanup<CallObjCAutoreleasePoolObject>(NormalCleanup, token);
2791 } else {
2792 llvm::Value *token = EmitObjCMRRAutoreleasePoolPush();
2793 EHStack.pushCleanup<CallObjCMRRAutoreleasePoolObject>(NormalCleanup, token);
2794 }
2795
2796 for (CompoundStmt::const_body_iterator I = S.body_begin(),
2797 E = S.body_end(); I != E; ++I)
2798 EmitStmt(*I);
2799
Eric Christopher73fb3502011-10-13 21:45:18 +00002800 if (DI)
2801 DI->EmitLexicalBlockEnd(Builder, S.getRBracLoc());
John McCallf85e1932011-06-15 23:02:42 +00002802}
John McCall0c24c802011-06-24 23:21:27 +00002803
2804/// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
2805/// make sure it survives garbage collection until this point.
2806void CodeGenFunction::EmitExtendGCLifetime(llvm::Value *object) {
2807 // We just use an inline assembly.
John McCall0c24c802011-06-24 23:21:27 +00002808 llvm::FunctionType *extenderType
John McCallde5d3c72012-02-17 03:33:10 +00002809 = llvm::FunctionType::get(VoidTy, VoidPtrTy, RequiredArgs::All);
John McCall0c24c802011-06-24 23:21:27 +00002810 llvm::Value *extender
2811 = llvm::InlineAsm::get(extenderType,
2812 /* assembly */ "",
2813 /* constraints */ "r",
2814 /* side effects */ true);
2815
2816 object = Builder.CreateBitCast(object, VoidPtrTy);
John McCallbd7370a2013-02-28 19:01:20 +00002817 EmitNounwindRuntimeCall(extender, object);
John McCall0c24c802011-06-24 23:21:27 +00002818}
2819
Fariborz Jahanian20abee62012-01-10 00:37:01 +00002820/// GenerateObjCAtomicSetterCopyHelperFunction - Given a c++ object type with
Fariborz Jahanian84e49862012-01-06 00:29:35 +00002821/// non-trivial copy assignment function, produce following helper function.
2822/// static void copyHelper(Ty *dest, const Ty *source) { *dest = *source; }
2823///
2824llvm::Constant *
Fariborz Jahanian20abee62012-01-10 00:37:01 +00002825CodeGenFunction::GenerateObjCAtomicSetterCopyHelperFunction(
2826 const ObjCPropertyImplDecl *PID) {
John McCall260611a2012-06-20 06:18:46 +00002827 if (!getLangOpts().CPlusPlus ||
Rafael Espindola90f69262012-12-18 04:29:34 +00002828 !getLangOpts().ObjCRuntime.hasAtomicCopyHelper())
Fariborz Jahanian84e49862012-01-06 00:29:35 +00002829 return 0;
2830 QualType Ty = PID->getPropertyIvarDecl()->getType();
2831 if (!Ty->isRecordType())
2832 return 0;
2833 const ObjCPropertyDecl *PD = PID->getPropertyDecl();
Fariborz Jahanian20abee62012-01-10 00:37:01 +00002834 if ((!(PD->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_atomic)))
Fariborz Jahanian84e49862012-01-06 00:29:35 +00002835 return 0;
Fariborz Jahanianb08cfb32012-01-08 19:13:23 +00002836 llvm::Constant * HelperFn = 0;
Fariborz Jahanian20abee62012-01-10 00:37:01 +00002837 if (hasTrivialSetExpr(PID))
2838 return 0;
2839 assert(PID->getSetterCXXAssignment() && "SetterCXXAssignment - null");
2840 if ((HelperFn = CGM.getAtomicSetterHelperFnMap(Ty)))
2841 return HelperFn;
Fariborz Jahanian84e49862012-01-06 00:29:35 +00002842
2843 ASTContext &C = getContext();
2844 IdentifierInfo *II
Fariborz Jahanian20abee62012-01-10 00:37:01 +00002845 = &CGM.getContext().Idents.get("__assign_helper_atomic_property_");
Fariborz Jahanian84e49862012-01-06 00:29:35 +00002846 FunctionDecl *FD = FunctionDecl::Create(C,
2847 C.getTranslationUnitDecl(),
2848 SourceLocation(),
2849 SourceLocation(), II, C.VoidTy, 0,
2850 SC_Static,
Fariborz Jahanian84e49862012-01-06 00:29:35 +00002851 false,
Eric Christopherb92bd4b2012-04-12 02:16:49 +00002852 false);
Fariborz Jahanian84e49862012-01-06 00:29:35 +00002853
2854 QualType DestTy = C.getPointerType(Ty);
2855 QualType SrcTy = Ty;
2856 SrcTy.addConst();
2857 SrcTy = C.getPointerType(SrcTy);
2858
2859 FunctionArgList args;
2860 ImplicitParamDecl dstDecl(FD, SourceLocation(), 0, DestTy);
2861 args.push_back(&dstDecl);
2862 ImplicitParamDecl srcDecl(FD, SourceLocation(), 0, SrcTy);
2863 args.push_back(&srcDecl);
2864
2865 const CGFunctionInfo &FI =
John McCallde5d3c72012-02-17 03:33:10 +00002866 CGM.getTypes().arrangeFunctionDeclaration(C.VoidTy, args,
2867 FunctionType::ExtInfo(),
2868 RequiredArgs::All);
Fariborz Jahanian84e49862012-01-06 00:29:35 +00002869
John McCallde5d3c72012-02-17 03:33:10 +00002870 llvm::FunctionType *LTy = CGM.getTypes().GetFunctionType(FI);
Fariborz Jahanian84e49862012-01-06 00:29:35 +00002871
2872 llvm::Function *Fn =
2873 llvm::Function::Create(LTy, llvm::GlobalValue::InternalLinkage,
Eric Christopher16098f32012-03-29 17:31:31 +00002874 "__assign_helper_atomic_property_",
2875 &CGM.getModule());
Fariborz Jahanian84e49862012-01-06 00:29:35 +00002876
Alexey Samsonova240df22012-10-16 07:22:28 +00002877 // Initialize debug info if needed.
2878 maybeInitializeDebugInfo();
Fariborz Jahanian84e49862012-01-06 00:29:35 +00002879
2880 StartFunction(FD, C.VoidTy, Fn, FI, args, SourceLocation());
2881
John McCallf4b88a42012-03-10 09:33:50 +00002882 DeclRefExpr DstExpr(&dstDecl, false, DestTy,
2883 VK_RValue, SourceLocation());
2884 UnaryOperator DST(&DstExpr, UO_Deref, DestTy->getPointeeType(),
2885 VK_LValue, OK_Ordinary, SourceLocation());
Fariborz Jahanian84e49862012-01-06 00:29:35 +00002886
John McCallf4b88a42012-03-10 09:33:50 +00002887 DeclRefExpr SrcExpr(&srcDecl, false, SrcTy,
2888 VK_RValue, SourceLocation());
2889 UnaryOperator SRC(&SrcExpr, UO_Deref, SrcTy->getPointeeType(),
2890 VK_LValue, OK_Ordinary, SourceLocation());
Fariborz Jahanian84e49862012-01-06 00:29:35 +00002891
John McCallf4b88a42012-03-10 09:33:50 +00002892 Expr *Args[2] = { &DST, &SRC };
Fariborz Jahanian20abee62012-01-10 00:37:01 +00002893 CallExpr *CalleeExp = cast<CallExpr>(PID->getSetterCXXAssignment());
John McCallf4b88a42012-03-10 09:33:50 +00002894 CXXOperatorCallExpr TheCall(C, OO_Equal, CalleeExp->getCallee(),
Benjamin Kramer3b6bef92012-08-24 11:54:20 +00002895 Args, DestTy->getPointeeType(),
Lang Hamesbe9af122012-10-02 04:45:10 +00002896 VK_LValue, SourceLocation(), false);
John McCallf4b88a42012-03-10 09:33:50 +00002897
2898 EmitStmt(&TheCall);
Fariborz Jahanian84e49862012-01-06 00:29:35 +00002899
2900 FinishFunction();
Fariborz Jahaniancd93b962012-01-06 22:33:54 +00002901 HelperFn = llvm::ConstantExpr::getBitCast(Fn, VoidPtrTy);
Fariborz Jahanian20abee62012-01-10 00:37:01 +00002902 CGM.setAtomicSetterHelperFnMap(Ty, HelperFn);
Fariborz Jahaniancd93b962012-01-06 22:33:54 +00002903 return HelperFn;
Fariborz Jahanian20abee62012-01-10 00:37:01 +00002904}
2905
2906llvm::Constant *
2907CodeGenFunction::GenerateObjCAtomicGetterCopyHelperFunction(
2908 const ObjCPropertyImplDecl *PID) {
John McCall260611a2012-06-20 06:18:46 +00002909 if (!getLangOpts().CPlusPlus ||
Rafael Espindola90f69262012-12-18 04:29:34 +00002910 !getLangOpts().ObjCRuntime.hasAtomicCopyHelper())
Fariborz Jahanian20abee62012-01-10 00:37:01 +00002911 return 0;
2912 const ObjCPropertyDecl *PD = PID->getPropertyDecl();
2913 QualType Ty = PD->getType();
2914 if (!Ty->isRecordType())
2915 return 0;
2916 if ((!(PD->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_atomic)))
2917 return 0;
2918 llvm::Constant * HelperFn = 0;
Fariborz Jahanian84e49862012-01-06 00:29:35 +00002919
Fariborz Jahanian20abee62012-01-10 00:37:01 +00002920 if (hasTrivialGetExpr(PID))
2921 return 0;
2922 assert(PID->getGetterCXXConstructor() && "getGetterCXXConstructor - null");
2923 if ((HelperFn = CGM.getAtomicGetterHelperFnMap(Ty)))
2924 return HelperFn;
2925
2926
2927 ASTContext &C = getContext();
2928 IdentifierInfo *II
2929 = &CGM.getContext().Idents.get("__copy_helper_atomic_property_");
2930 FunctionDecl *FD = FunctionDecl::Create(C,
2931 C.getTranslationUnitDecl(),
2932 SourceLocation(),
2933 SourceLocation(), II, C.VoidTy, 0,
2934 SC_Static,
Fariborz Jahanian20abee62012-01-10 00:37:01 +00002935 false,
Eric Christopherb92bd4b2012-04-12 02:16:49 +00002936 false);
Fariborz Jahanian20abee62012-01-10 00:37:01 +00002937
2938 QualType DestTy = C.getPointerType(Ty);
2939 QualType SrcTy = Ty;
2940 SrcTy.addConst();
2941 SrcTy = C.getPointerType(SrcTy);
2942
2943 FunctionArgList args;
2944 ImplicitParamDecl dstDecl(FD, SourceLocation(), 0, DestTy);
2945 args.push_back(&dstDecl);
2946 ImplicitParamDecl srcDecl(FD, SourceLocation(), 0, SrcTy);
2947 args.push_back(&srcDecl);
2948
2949 const CGFunctionInfo &FI =
John McCallde5d3c72012-02-17 03:33:10 +00002950 CGM.getTypes().arrangeFunctionDeclaration(C.VoidTy, args,
2951 FunctionType::ExtInfo(),
2952 RequiredArgs::All);
Fariborz Jahanian20abee62012-01-10 00:37:01 +00002953
John McCallde5d3c72012-02-17 03:33:10 +00002954 llvm::FunctionType *LTy = CGM.getTypes().GetFunctionType(FI);
Fariborz Jahanian20abee62012-01-10 00:37:01 +00002955
2956 llvm::Function *Fn =
2957 llvm::Function::Create(LTy, llvm::GlobalValue::InternalLinkage,
2958 "__copy_helper_atomic_property_", &CGM.getModule());
2959
Alexey Samsonova240df22012-10-16 07:22:28 +00002960 // Initialize debug info if needed.
2961 maybeInitializeDebugInfo();
Fariborz Jahanian20abee62012-01-10 00:37:01 +00002962
2963 StartFunction(FD, C.VoidTy, Fn, FI, args, SourceLocation());
2964
John McCallf4b88a42012-03-10 09:33:50 +00002965 DeclRefExpr SrcExpr(&srcDecl, false, SrcTy,
Fariborz Jahanian20abee62012-01-10 00:37:01 +00002966 VK_RValue, SourceLocation());
2967
John McCallf4b88a42012-03-10 09:33:50 +00002968 UnaryOperator SRC(&SrcExpr, UO_Deref, SrcTy->getPointeeType(),
2969 VK_LValue, OK_Ordinary, SourceLocation());
Fariborz Jahanian20abee62012-01-10 00:37:01 +00002970
2971 CXXConstructExpr *CXXConstExpr =
2972 cast<CXXConstructExpr>(PID->getGetterCXXConstructor());
2973
2974 SmallVector<Expr*, 4> ConstructorArgs;
John McCallf4b88a42012-03-10 09:33:50 +00002975 ConstructorArgs.push_back(&SRC);
Fariborz Jahanian20abee62012-01-10 00:37:01 +00002976 CXXConstructExpr::arg_iterator A = CXXConstExpr->arg_begin();
2977 ++A;
2978
2979 for (CXXConstructExpr::arg_iterator AEnd = CXXConstExpr->arg_end();
2980 A != AEnd; ++A)
2981 ConstructorArgs.push_back(*A);
2982
2983 CXXConstructExpr *TheCXXConstructExpr =
2984 CXXConstructExpr::Create(C, Ty, SourceLocation(),
2985 CXXConstExpr->getConstructor(),
2986 CXXConstExpr->isElidable(),
Benjamin Kramer3b6bef92012-08-24 11:54:20 +00002987 ConstructorArgs,
Sebastian Redl5b9cc5d2012-02-11 23:51:47 +00002988 CXXConstExpr->hadMultipleCandidates(),
2989 CXXConstExpr->isListInitialization(),
Fariborz Jahanian20abee62012-01-10 00:37:01 +00002990 CXXConstExpr->requiresZeroInitialization(),
Eric Christopher16098f32012-03-29 17:31:31 +00002991 CXXConstExpr->getConstructionKind(),
2992 SourceRange());
Fariborz Jahanian20abee62012-01-10 00:37:01 +00002993
John McCallf4b88a42012-03-10 09:33:50 +00002994 DeclRefExpr DstExpr(&dstDecl, false, DestTy,
2995 VK_RValue, SourceLocation());
Fariborz Jahanian20abee62012-01-10 00:37:01 +00002996
John McCallf4b88a42012-03-10 09:33:50 +00002997 RValue DV = EmitAnyExpr(&DstExpr);
Eric Christopher16098f32012-03-29 17:31:31 +00002998 CharUnits Alignment
2999 = getContext().getTypeAlignInChars(TheCXXConstructExpr->getType());
Fariborz Jahanian20abee62012-01-10 00:37:01 +00003000 EmitAggExpr(TheCXXConstructExpr,
3001 AggValueSlot::forAddr(DV.getScalarVal(), Alignment, Qualifiers(),
3002 AggValueSlot::IsDestructed,
3003 AggValueSlot::DoesNotNeedGCBarriers,
Chad Rosier649b4a12012-03-29 17:37:10 +00003004 AggValueSlot::IsNotAliased));
Fariborz Jahanian20abee62012-01-10 00:37:01 +00003005
3006 FinishFunction();
3007 HelperFn = llvm::ConstantExpr::getBitCast(Fn, VoidPtrTy);
3008 CGM.setAtomicGetterHelperFnMap(Ty, HelperFn);
3009 return HelperFn;
Fariborz Jahanian84e49862012-01-06 00:29:35 +00003010}
3011
Eli Friedmancae40c42012-02-28 01:08:45 +00003012llvm::Value *
3013CodeGenFunction::EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty) {
3014 // Get selectors for retain/autorelease.
Eli Friedman8c72a7d2012-03-01 22:52:28 +00003015 IdentifierInfo *CopyID = &getContext().Idents.get("copy");
3016 Selector CopySelector =
3017 getContext().Selectors.getNullarySelector(CopyID);
Eli Friedmancae40c42012-02-28 01:08:45 +00003018 IdentifierInfo *AutoreleaseID = &getContext().Idents.get("autorelease");
3019 Selector AutoreleaseSelector =
3020 getContext().Selectors.getNullarySelector(AutoreleaseID);
3021
3022 // Emit calls to retain/autorelease.
3023 CGObjCRuntime &Runtime = CGM.getObjCRuntime();
3024 llvm::Value *Val = Block;
3025 RValue Result;
3026 Result = Runtime.GenerateMessageSend(*this, ReturnValueSlot(),
Eli Friedman8c72a7d2012-03-01 22:52:28 +00003027 Ty, CopySelector,
Eli Friedmancae40c42012-02-28 01:08:45 +00003028 Val, CallArgList(), 0, 0);
3029 Val = Result.getScalarVal();
3030 Result = Runtime.GenerateMessageSend(*this, ReturnValueSlot(),
3031 Ty, AutoreleaseSelector,
3032 Val, CallArgList(), 0, 0);
3033 Val = Result.getScalarVal();
3034 return Val;
3035}
3036
Fariborz Jahanian84e49862012-01-06 00:29:35 +00003037
Ted Kremenek2979ec72008-04-09 15:51:31 +00003038CGObjCRuntime::~CGObjCRuntime() {}