blob: 06d15b6af7bcbdb8015a66e438fddb8563e89ecb [file] [log] [blame]
Anders Carlsson76f4a902007-08-21 17:43:55 +00001//===---- CGBuiltin.cpp - Emit LLVM Code for builtins ---------------------===//
2//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner5b12ab82007-12-29 19:59:25 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Anders Carlsson76f4a902007-08-21 17:43:55 +00007//
8//===----------------------------------------------------------------------===//
9//
10// This contains code to emit Objective-C code as LLVM code.
11//
12//===----------------------------------------------------------------------===//
13
Devang Pateld2d66652011-01-19 01:36:36 +000014#include "CGDebugInfo.h"
Ted Kremenek43e06332008-04-09 15:51:31 +000015#include "CGObjCRuntime.h"
Anders Carlsson76f4a902007-08-21 17:43:55 +000016#include "CodeGenFunction.h"
17#include "CodeGenModule.h"
John McCall31168b02011-06-15 23:02:42 +000018#include "TargetInfo.h"
Daniel Dunbar9e22c0d2008-08-29 08:11:39 +000019#include "clang/AST/ASTContext.h"
Daniel Dunbar6e8aa532008-08-11 05:35:13 +000020#include "clang/AST/DeclObjC.h"
Chris Lattnerf0b64d72009-04-26 01:32:48 +000021#include "clang/AST/StmtObjC.h"
Daniel Dunbarc5d33042008-09-03 00:27:26 +000022#include "clang/Basic/Diagnostic.h"
Mark Laceya8e7df32013-10-30 21:53:58 +000023#include "clang/CodeGen/CGFunctionInfo.h"
Anders Carlsson2e744e82008-08-30 19:51:14 +000024#include "llvm/ADT/STLExtras.h"
Chandler Carruthc80ceea2014-03-04 11:02:08 +000025#include "llvm/IR/CallSite.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000026#include "llvm/IR/DataLayout.h"
27#include "llvm/IR/InlineAsm.h"
Anders Carlsson76f4a902007-08-21 17:43:55 +000028using namespace clang;
29using namespace CodeGen;
30
John McCall31168b02011-06-15 23:02:42 +000031typedef llvm::PointerIntPair<llvm::Value*,1,bool> TryEmitResult;
32static TryEmitResult
33tryEmitARCRetainScalarExpr(CodeGenFunction &CGF, const Expr *e);
Ted Kremeneke65b0862012-03-06 20:05:56 +000034static RValue AdjustRelatedResultType(CodeGenFunction &CGF,
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +000035 QualType ET,
Ted Kremeneke65b0862012-03-06 20:05:56 +000036 const ObjCMethodDecl *Method,
37 RValue Result);
John McCall31168b02011-06-15 23:02:42 +000038
39/// Given the address of a variable of pointer type, find the correct
40/// null to store into it.
41static llvm::Constant *getNullForVariable(llvm::Value *addr) {
Chris Lattner2192fe52011-07-18 04:24:23 +000042 llvm::Type *type =
John McCall31168b02011-06-15 23:02:42 +000043 cast<llvm::PointerType>(addr->getType())->getElementType();
44 return llvm::ConstantPointerNull::get(cast<llvm::PointerType>(type));
45}
46
Chris Lattnerb1d329d2008-06-24 17:04:18 +000047/// Emits an instance of NSConstantString representing the object.
Mike Stump11289f42009-09-09 15:08:12 +000048llvm::Value *CodeGenFunction::EmitObjCStringLiteral(const ObjCStringLiteral *E)
Daniel Dunbar44b58a22008-11-25 21:53:21 +000049{
David Chisnall481e3a82010-01-23 02:40:42 +000050 llvm::Constant *C =
51 CGM.getObjCRuntime().GenerateConstantString(E->getString());
Daniel Dunbar66912a12008-08-20 00:28:19 +000052 // FIXME: This bitcast should just be made an invariant on the Runtime.
Owen Andersonade90fd2009-07-29 18:54:39 +000053 return llvm::ConstantExpr::getBitCast(C, ConvertType(E->getType()));
Chris Lattnerb1d329d2008-06-24 17:04:18 +000054}
55
Patrick Beard0caa3942012-04-19 00:25:12 +000056/// EmitObjCBoxedExpr - This routine generates code to call
57/// the appropriate expression boxing method. This will either be
58/// one of +[NSNumber numberWith<Type>:], or +[NSString stringWithUTF8String:].
Ted Kremeneke65b0862012-03-06 20:05:56 +000059///
Eric Christopher5d2b8d92012-03-29 17:31:31 +000060llvm::Value *
Patrick Beard0caa3942012-04-19 00:25:12 +000061CodeGenFunction::EmitObjCBoxedExpr(const ObjCBoxedExpr *E) {
Ted Kremeneke65b0862012-03-06 20:05:56 +000062 // Generate the correct selector for this literal's concrete type.
Patrick Beard0caa3942012-04-19 00:25:12 +000063 const Expr *SubExpr = E->getSubExpr();
Ted Kremeneke65b0862012-03-06 20:05:56 +000064 // Get the method.
Patrick Beard0caa3942012-04-19 00:25:12 +000065 const ObjCMethodDecl *BoxingMethod = E->getBoxingMethod();
66 assert(BoxingMethod && "BoxingMethod is null");
67 assert(BoxingMethod->isClassMethod() && "BoxingMethod must be a class method");
68 Selector Sel = BoxingMethod->getSelector();
Ted Kremeneke65b0862012-03-06 20:05:56 +000069
70 // Generate a reference to the class pointer, which will be the receiver.
Patrick Beard0caa3942012-04-19 00:25:12 +000071 // Assumes that the method was introduced in the class that should be
72 // messaged (avoids pulling it out of the result type).
Ted Kremeneke65b0862012-03-06 20:05:56 +000073 CGObjCRuntime &Runtime = CGM.getObjCRuntime();
Patrick Beard0caa3942012-04-19 00:25:12 +000074 const ObjCInterfaceDecl *ClassDecl = BoxingMethod->getClassInterface();
John McCall882987f2013-02-28 19:01:20 +000075 llvm::Value *Receiver = Runtime.GetClass(*this, ClassDecl);
Patrick Beard0caa3942012-04-19 00:25:12 +000076
77 const ParmVarDecl *argDecl = *BoxingMethod->param_begin();
Ted Kremeneke65b0862012-03-06 20:05:56 +000078 QualType ArgQT = argDecl->getType().getUnqualifiedType();
Patrick Beard0caa3942012-04-19 00:25:12 +000079 RValue RV = EmitAnyExpr(SubExpr);
Ted Kremeneke65b0862012-03-06 20:05:56 +000080 CallArgList Args;
81 Args.add(RV, ArgQT);
Alp Toker314cc812014-01-25 16:55:45 +000082
83 RValue result = Runtime.GenerateMessageSend(
84 *this, ReturnValueSlot(), BoxingMethod->getReturnType(), Sel, Receiver,
85 Args, ClassDecl, BoxingMethod);
Ted Kremeneke65b0862012-03-06 20:05:56 +000086 return Builder.CreateBitCast(result.getScalarVal(),
87 ConvertType(E->getType()));
88}
89
90llvm::Value *CodeGenFunction::EmitObjCCollectionLiteral(const Expr *E,
91 const ObjCMethodDecl *MethodWithObjects) {
92 ASTContext &Context = CGM.getContext();
93 const ObjCDictionaryLiteral *DLE = 0;
94 const ObjCArrayLiteral *ALE = dyn_cast<ObjCArrayLiteral>(E);
95 if (!ALE)
96 DLE = cast<ObjCDictionaryLiteral>(E);
97
98 // Compute the type of the array we're initializing.
99 uint64_t NumElements =
100 ALE ? ALE->getNumElements() : DLE->getNumElements();
101 llvm::APInt APNumElements(Context.getTypeSize(Context.getSizeType()),
102 NumElements);
103 QualType ElementType = Context.getObjCIdType().withConst();
104 QualType ElementArrayType
105 = Context.getConstantArrayType(ElementType, APNumElements,
106 ArrayType::Normal, /*IndexTypeQuals=*/0);
107
108 // Allocate the temporary array(s).
109 llvm::Value *Objects = CreateMemTemp(ElementArrayType, "objects");
110 llvm::Value *Keys = 0;
111 if (DLE)
112 Keys = CreateMemTemp(ElementArrayType, "keys");
113
John McCall770a4c12013-04-04 00:20:38 +0000114 // In ARC, we may need to do extra work to keep all the keys and
115 // values alive until after the call.
116 SmallVector<llvm::Value *, 16> NeededObjects;
117 bool TrackNeededObjects =
118 (getLangOpts().ObjCAutoRefCount &&
119 CGM.getCodeGenOpts().OptimizationLevel != 0);
120
Ted Kremeneke65b0862012-03-06 20:05:56 +0000121 // Perform the actual initialialization of the array(s).
122 for (uint64_t i = 0; i < NumElements; i++) {
123 if (ALE) {
John McCall770a4c12013-04-04 00:20:38 +0000124 // Emit the element and store it to the appropriate array slot.
Ted Kremeneke65b0862012-03-06 20:05:56 +0000125 const Expr *Rhs = ALE->getElement(i);
126 LValue LV = LValue::MakeAddr(Builder.CreateStructGEP(Objects, i),
127 ElementType,
128 Context.getTypeAlignInChars(Rhs->getType()),
129 Context);
John McCall770a4c12013-04-04 00:20:38 +0000130
131 llvm::Value *value = EmitScalarExpr(Rhs);
132 EmitStoreThroughLValue(RValue::get(value), LV, true);
133 if (TrackNeededObjects) {
134 NeededObjects.push_back(value);
135 }
Ted Kremeneke65b0862012-03-06 20:05:56 +0000136 } else {
John McCall770a4c12013-04-04 00:20:38 +0000137 // Emit the key and store it to the appropriate array slot.
Ted Kremeneke65b0862012-03-06 20:05:56 +0000138 const Expr *Key = DLE->getKeyValueElement(i).Key;
139 LValue KeyLV = LValue::MakeAddr(Builder.CreateStructGEP(Keys, i),
140 ElementType,
141 Context.getTypeAlignInChars(Key->getType()),
142 Context);
John McCall770a4c12013-04-04 00:20:38 +0000143 llvm::Value *keyValue = EmitScalarExpr(Key);
144 EmitStoreThroughLValue(RValue::get(keyValue), KeyLV, /*isInit=*/true);
Ted Kremeneke65b0862012-03-06 20:05:56 +0000145
John McCall770a4c12013-04-04 00:20:38 +0000146 // Emit the value and store it to the appropriate array slot.
Ted Kremeneke65b0862012-03-06 20:05:56 +0000147 const Expr *Value = DLE->getKeyValueElement(i).Value;
148 LValue ValueLV = LValue::MakeAddr(Builder.CreateStructGEP(Objects, i),
149 ElementType,
150 Context.getTypeAlignInChars(Value->getType()),
151 Context);
John McCall770a4c12013-04-04 00:20:38 +0000152 llvm::Value *valueValue = EmitScalarExpr(Value);
153 EmitStoreThroughLValue(RValue::get(valueValue), ValueLV, /*isInit=*/true);
154 if (TrackNeededObjects) {
155 NeededObjects.push_back(keyValue);
156 NeededObjects.push_back(valueValue);
157 }
Ted Kremeneke65b0862012-03-06 20:05:56 +0000158 }
159 }
160
161 // Generate the argument list.
162 CallArgList Args;
163 ObjCMethodDecl::param_const_iterator PI = MethodWithObjects->param_begin();
164 const ParmVarDecl *argDecl = *PI++;
165 QualType ArgQT = argDecl->getType().getUnqualifiedType();
166 Args.add(RValue::get(Objects), ArgQT);
167 if (DLE) {
168 argDecl = *PI++;
169 ArgQT = argDecl->getType().getUnqualifiedType();
170 Args.add(RValue::get(Keys), ArgQT);
171 }
172 argDecl = *PI;
173 ArgQT = argDecl->getType().getUnqualifiedType();
174 llvm::Value *Count =
175 llvm::ConstantInt::get(CGM.getTypes().ConvertType(ArgQT), NumElements);
176 Args.add(RValue::get(Count), ArgQT);
177
178 // Generate a reference to the class pointer, which will be the receiver.
179 Selector Sel = MethodWithObjects->getSelector();
180 QualType ResultType = E->getType();
181 const ObjCObjectPointerType *InterfacePointerType
182 = ResultType->getAsObjCInterfacePointerType();
183 ObjCInterfaceDecl *Class
184 = InterfacePointerType->getObjectType()->getInterface();
185 CGObjCRuntime &Runtime = CGM.getObjCRuntime();
John McCall882987f2013-02-28 19:01:20 +0000186 llvm::Value *Receiver = Runtime.GetClass(*this, Class);
Ted Kremeneke65b0862012-03-06 20:05:56 +0000187
188 // Generate the message send.
Alp Toker314cc812014-01-25 16:55:45 +0000189 RValue result = Runtime.GenerateMessageSend(
190 *this, ReturnValueSlot(), MethodWithObjects->getReturnType(), Sel,
191 Receiver, Args, Class, MethodWithObjects);
John McCall770a4c12013-04-04 00:20:38 +0000192
193 // The above message send needs these objects, but in ARC they are
194 // passed in a buffer that is essentially __unsafe_unretained.
195 // Therefore we must prevent the optimizer from releasing them until
196 // after the call.
197 if (TrackNeededObjects) {
198 EmitARCIntrinsicUse(NeededObjects);
199 }
200
Ted Kremeneke65b0862012-03-06 20:05:56 +0000201 return Builder.CreateBitCast(result.getScalarVal(),
202 ConvertType(E->getType()));
203}
204
205llvm::Value *CodeGenFunction::EmitObjCArrayLiteral(const ObjCArrayLiteral *E) {
206 return EmitObjCCollectionLiteral(E, E->getArrayWithObjectsMethod());
207}
208
209llvm::Value *CodeGenFunction::EmitObjCDictionaryLiteral(
210 const ObjCDictionaryLiteral *E) {
211 return EmitObjCCollectionLiteral(E, E->getDictWithObjectsMethod());
212}
213
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000214/// Emit a selector.
215llvm::Value *CodeGenFunction::EmitObjCSelectorExpr(const ObjCSelectorExpr *E) {
216 // Untyped selector.
217 // Note that this implementation allows for non-constant strings to be passed
218 // as arguments to @selector(). Currently, the only thing preventing this
219 // behaviour is the type checking in the front end.
John McCall882987f2013-02-28 19:01:20 +0000220 return CGM.getObjCRuntime().GetSelector(*this, E->getSelector());
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000221}
222
Daniel Dunbar66912a12008-08-20 00:28:19 +0000223llvm::Value *CodeGenFunction::EmitObjCProtocolExpr(const ObjCProtocolExpr *E) {
224 // FIXME: This should pass the Decl not the name.
John McCall882987f2013-02-28 19:01:20 +0000225 return CGM.getObjCRuntime().GenerateProtocolRef(*this, E->getProtocol());
Daniel Dunbar66912a12008-08-20 00:28:19 +0000226}
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000227
Douglas Gregor33823722011-06-11 01:09:30 +0000228/// \brief Adjust the type of the result of an Objective-C message send
229/// expression when the method has a related result type.
230static RValue AdjustRelatedResultType(CodeGenFunction &CGF,
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +0000231 QualType ExpT,
Douglas Gregor33823722011-06-11 01:09:30 +0000232 const ObjCMethodDecl *Method,
233 RValue Result) {
234 if (!Method)
235 return Result;
John McCall31168b02011-06-15 23:02:42 +0000236
Douglas Gregor33823722011-06-11 01:09:30 +0000237 if (!Method->hasRelatedResultType() ||
Alp Toker314cc812014-01-25 16:55:45 +0000238 CGF.getContext().hasSameType(ExpT, Method->getReturnType()) ||
Douglas Gregor33823722011-06-11 01:09:30 +0000239 !Result.isScalar())
240 return Result;
241
242 // We have applied a related result type. Cast the rvalue appropriately.
243 return RValue::get(CGF.Builder.CreateBitCast(Result.getScalarVal(),
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +0000244 CGF.ConvertType(ExpT)));
Douglas Gregor33823722011-06-11 01:09:30 +0000245}
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000246
John McCallcf166702011-07-22 08:53:00 +0000247/// Decide whether to extend the lifetime of the receiver of a
248/// returns-inner-pointer message.
249static bool
250shouldExtendReceiverForInnerPointerMessage(const ObjCMessageExpr *message) {
251 switch (message->getReceiverKind()) {
252
253 // For a normal instance message, we should extend unless the
254 // receiver is loaded from a variable with precise lifetime.
255 case ObjCMessageExpr::Instance: {
256 const Expr *receiver = message->getInstanceReceiver();
257 const ImplicitCastExpr *ice = dyn_cast<ImplicitCastExpr>(receiver);
258 if (!ice || ice->getCastKind() != CK_LValueToRValue) return true;
259 receiver = ice->getSubExpr()->IgnoreParens();
260
261 // Only __strong variables.
262 if (receiver->getType().getObjCLifetime() != Qualifiers::OCL_Strong)
263 return true;
264
265 // All ivars and fields have precise lifetime.
266 if (isa<MemberExpr>(receiver) || isa<ObjCIvarRefExpr>(receiver))
267 return false;
268
269 // Otherwise, check for variables.
270 const DeclRefExpr *declRef = dyn_cast<DeclRefExpr>(ice->getSubExpr());
271 if (!declRef) return true;
272 const VarDecl *var = dyn_cast<VarDecl>(declRef->getDecl());
273 if (!var) return true;
274
275 // All variables have precise lifetime except local variables with
276 // automatic storage duration that aren't specially marked.
277 return (var->hasLocalStorage() &&
278 !var->hasAttr<ObjCPreciseLifetimeAttr>());
279 }
280
281 case ObjCMessageExpr::Class:
282 case ObjCMessageExpr::SuperClass:
283 // It's never necessary for class objects.
284 return false;
285
286 case ObjCMessageExpr::SuperInstance:
287 // We generally assume that 'self' lives throughout a method call.
288 return false;
289 }
290
291 llvm_unreachable("invalid receiver kind");
292}
293
John McCall78a15112010-05-22 01:48:05 +0000294RValue CodeGenFunction::EmitObjCMessageExpr(const ObjCMessageExpr *E,
295 ReturnValueSlot Return) {
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000296 // Only the lookup mechanism and first two arguments of the method
297 // implementation vary between runtimes. We can get the receiver and
298 // arguments in generic code.
Mike Stump11289f42009-09-09 15:08:12 +0000299
John McCall31168b02011-06-15 23:02:42 +0000300 bool isDelegateInit = E->isDelegateInitCall();
301
John McCallcf166702011-07-22 08:53:00 +0000302 const ObjCMethodDecl *method = E->getMethodDecl();
Fariborz Jahanian715fdd52012-01-29 20:27:13 +0000303
John McCall31168b02011-06-15 23:02:42 +0000304 // We don't retain the receiver in delegate init calls, and this is
305 // safe because the receiver value is always loaded from 'self',
306 // which we zero out. We don't want to Block_copy block receivers,
307 // though.
308 bool retainSelf =
309 (!isDelegateInit &&
David Blaikiebbafb8a2012-03-11 07:00:24 +0000310 CGM.getLangOpts().ObjCAutoRefCount &&
John McCallcf166702011-07-22 08:53:00 +0000311 method &&
312 method->hasAttr<NSConsumesSelfAttr>());
John McCall31168b02011-06-15 23:02:42 +0000313
Daniel Dunbar8d480592008-08-11 18:12:00 +0000314 CGObjCRuntime &Runtime = CGM.getObjCRuntime();
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000315 bool isSuperMessage = false;
Daniel Dunbarca8531a2008-08-25 08:19:24 +0000316 bool isClassMessage = false;
David Chisnall01aa4672010-04-28 19:33:36 +0000317 ObjCInterfaceDecl *OID = 0;
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000318 // Find the receiver
Douglas Gregor33823722011-06-11 01:09:30 +0000319 QualType ReceiverType;
Daniel Dunbarb2197802010-04-22 03:17:06 +0000320 llvm::Value *Receiver = 0;
Douglas Gregor9a129192010-04-21 00:45:42 +0000321 switch (E->getReceiverKind()) {
322 case ObjCMessageExpr::Instance:
Douglas Gregor33823722011-06-11 01:09:30 +0000323 ReceiverType = E->getInstanceReceiver()->getType();
John McCall31168b02011-06-15 23:02:42 +0000324 if (retainSelf) {
325 TryEmitResult ter = tryEmitARCRetainScalarExpr(*this,
326 E->getInstanceReceiver());
327 Receiver = ter.getPointer();
John McCallcf166702011-07-22 08:53:00 +0000328 if (ter.getInt()) retainSelf = false;
John McCall31168b02011-06-15 23:02:42 +0000329 } else
330 Receiver = EmitScalarExpr(E->getInstanceReceiver());
Douglas Gregor9a129192010-04-21 00:45:42 +0000331 break;
Daniel Dunbar7c6d3a72008-08-16 00:25:02 +0000332
Douglas Gregor9a129192010-04-21 00:45:42 +0000333 case ObjCMessageExpr::Class: {
Douglas Gregor33823722011-06-11 01:09:30 +0000334 ReceiverType = E->getClassReceiver();
335 const ObjCObjectType *ObjTy = ReceiverType->getAs<ObjCObjectType>();
John McCall3e294922010-05-17 20:12:43 +0000336 assert(ObjTy && "Invalid Objective-C class message send");
337 OID = ObjTy->getInterface();
338 assert(OID && "Invalid Objective-C class message send");
John McCall882987f2013-02-28 19:01:20 +0000339 Receiver = Runtime.GetClass(*this, OID);
Daniel Dunbarca8531a2008-08-25 08:19:24 +0000340 isClassMessage = true;
Douglas Gregor9a129192010-04-21 00:45:42 +0000341 break;
342 }
343
344 case ObjCMessageExpr::SuperInstance:
Douglas Gregor33823722011-06-11 01:09:30 +0000345 ReceiverType = E->getSuperType();
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000346 Receiver = LoadObjCSelf();
Douglas Gregor9a129192010-04-21 00:45:42 +0000347 isSuperMessage = true;
348 break;
349
350 case ObjCMessageExpr::SuperClass:
Douglas Gregor33823722011-06-11 01:09:30 +0000351 ReceiverType = E->getSuperType();
Douglas Gregor9a129192010-04-21 00:45:42 +0000352 Receiver = LoadObjCSelf();
353 isSuperMessage = true;
354 isClassMessage = true;
355 break;
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000356 }
357
John McCallcf166702011-07-22 08:53:00 +0000358 if (retainSelf)
359 Receiver = EmitARCRetainNonBlock(Receiver);
360
361 // In ARC, we sometimes want to "extend the lifetime"
362 // (i.e. retain+autorelease) of receivers of returns-inner-pointer
363 // messages.
David Blaikiebbafb8a2012-03-11 07:00:24 +0000364 if (getLangOpts().ObjCAutoRefCount && method &&
John McCallcf166702011-07-22 08:53:00 +0000365 method->hasAttr<ObjCReturnsInnerPointerAttr>() &&
366 shouldExtendReceiverForInnerPointerMessage(E))
367 Receiver = EmitARCRetainAutorelease(ReceiverType, Receiver);
368
Alp Toker314cc812014-01-25 16:55:45 +0000369 QualType ResultType = method ? method->getReturnType() : E->getType();
John McCall31168b02011-06-15 23:02:42 +0000370
Daniel Dunbarc722b852008-08-30 03:02:31 +0000371 CallArgList Args;
John McCallcf166702011-07-22 08:53:00 +0000372 EmitCallArgs(Args, method, E->arg_begin(), E->arg_end());
Mike Stump11289f42009-09-09 15:08:12 +0000373
John McCall31168b02011-06-15 23:02:42 +0000374 // For delegate init calls in ARC, do an unsafe store of null into
375 // self. This represents the call taking direct ownership of that
376 // value. We have to do this after emitting the other call
377 // arguments because they might also reference self, but we don't
378 // have to worry about any of them modifying self because that would
379 // be an undefined read and write of an object in unordered
380 // expressions.
381 if (isDelegateInit) {
David Blaikiebbafb8a2012-03-11 07:00:24 +0000382 assert(getLangOpts().ObjCAutoRefCount &&
John McCall31168b02011-06-15 23:02:42 +0000383 "delegate init calls should only be marked in ARC");
384
385 // Do an unsafe store of null into self.
386 llvm::Value *selfAddr =
387 LocalDeclMap[cast<ObjCMethodDecl>(CurCodeDecl)->getSelfDecl()];
388 assert(selfAddr && "no self entry for a delegate init call?");
389
390 Builder.CreateStore(getNullForVariable(selfAddr), selfAddr);
391 }
Anders Carlsson280e61f12010-06-21 20:59:55 +0000392
Douglas Gregor33823722011-06-11 01:09:30 +0000393 RValue result;
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000394 if (isSuperMessage) {
Chris Lattner6cfec782008-06-26 04:42:20 +0000395 // super is only valid in an Objective-C method
396 const ObjCMethodDecl *OMD = cast<ObjCMethodDecl>(CurFuncDecl);
Fariborz Jahanianbac73ac2009-02-28 20:07:56 +0000397 bool isCategoryImpl = isa<ObjCCategoryImplDecl>(OMD->getDeclContext());
Douglas Gregor33823722011-06-11 01:09:30 +0000398 result = Runtime.GenerateMessageSendSuper(*this, Return, ResultType,
399 E->getSelector(),
400 OMD->getClassInterface(),
401 isCategoryImpl,
402 Receiver,
403 isClassMessage,
404 Args,
John McCallcf166702011-07-22 08:53:00 +0000405 method);
Douglas Gregor33823722011-06-11 01:09:30 +0000406 } else {
407 result = Runtime.GenerateMessageSend(*this, Return, ResultType,
408 E->getSelector(),
409 Receiver, Args, OID,
John McCallcf166702011-07-22 08:53:00 +0000410 method);
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000411 }
John McCall31168b02011-06-15 23:02:42 +0000412
413 // For delegate init calls in ARC, implicitly store the result of
414 // the call back into self. This takes ownership of the value.
415 if (isDelegateInit) {
416 llvm::Value *selfAddr =
417 LocalDeclMap[cast<ObjCMethodDecl>(CurCodeDecl)->getSelfDecl()];
418 llvm::Value *newSelf = result.getScalarVal();
419
420 // The delegate return type isn't necessarily a matching type; in
421 // fact, it's quite likely to be 'id'.
Chris Lattner2192fe52011-07-18 04:24:23 +0000422 llvm::Type *selfTy =
John McCall31168b02011-06-15 23:02:42 +0000423 cast<llvm::PointerType>(selfAddr->getType())->getElementType();
424 newSelf = Builder.CreateBitCast(newSelf, selfTy);
425
426 Builder.CreateStore(newSelf, selfAddr);
427 }
Fariborz Jahanian715fdd52012-01-29 20:27:13 +0000428
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +0000429 return AdjustRelatedResultType(*this, E->getType(), method, result);
Anders Carlsson76f4a902007-08-21 17:43:55 +0000430}
431
John McCall31168b02011-06-15 23:02:42 +0000432namespace {
433struct FinishARCDealloc : EHScopeStack::Cleanup {
John McCall30317fd2011-07-12 20:27:29 +0000434 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCall31168b02011-06-15 23:02:42 +0000435 const ObjCMethodDecl *method = cast<ObjCMethodDecl>(CGF.CurCodeDecl);
John McCalldffafde2011-07-13 18:26:47 +0000436
437 const ObjCImplDecl *impl = cast<ObjCImplDecl>(method->getDeclContext());
John McCall31168b02011-06-15 23:02:42 +0000438 const ObjCInterfaceDecl *iface = impl->getClassInterface();
439 if (!iface->getSuperClass()) return;
440
John McCalldffafde2011-07-13 18:26:47 +0000441 bool isCategory = isa<ObjCCategoryImplDecl>(impl);
442
John McCall31168b02011-06-15 23:02:42 +0000443 // Call [super dealloc] if we have a superclass.
444 llvm::Value *self = CGF.LoadObjCSelf();
445
446 CallArgList args;
447 CGF.CGM.getObjCRuntime().GenerateMessageSendSuper(CGF, ReturnValueSlot(),
448 CGF.getContext().VoidTy,
449 method->getSelector(),
450 iface,
John McCalldffafde2011-07-13 18:26:47 +0000451 isCategory,
John McCall31168b02011-06-15 23:02:42 +0000452 self,
453 /*is class msg*/ false,
454 args,
455 method);
456 }
457};
458}
459
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000460/// StartObjCMethod - Begin emission of an ObjCMethod. This generates
461/// the LLVM function and sets the other context used by
462/// CodeGenFunction.
Fariborz Jahanian0196a1c2009-01-10 21:06:09 +0000463void CodeGenFunction::StartObjCMethod(const ObjCMethodDecl *OMD,
Devang Patele7ce5402011-05-19 23:37:41 +0000464 const ObjCContainerDecl *CD,
465 SourceLocation StartLoc) {
John McCalla738c252011-03-09 04:27:21 +0000466 FunctionArgList args;
Devang Patela2c048e2010-04-05 21:09:15 +0000467 // Check if we should generate debug info for this method.
David Blaikie92848de2013-08-26 20:33:21 +0000468 if (OMD->hasAttr<NoDebugAttr>())
469 DebugInfo = NULL; // disable debug info indefinitely for this function
Devang Patela2c048e2010-04-05 21:09:15 +0000470
Fariborz Jahanian0196a1c2009-01-10 21:06:09 +0000471 llvm::Function *Fn = CGM.getObjCRuntime().GenerateMethod(OMD, CD);
Daniel Dunbar449a3392008-09-04 23:41:35 +0000472
John McCalla729c622012-02-17 03:33:10 +0000473 const CGFunctionInfo &FI = CGM.getTypes().arrangeObjCMethodDeclaration(OMD);
Daniel Dunbarc3e7cff2009-04-17 00:48:04 +0000474 CGM.SetInternalFunctionAttributes(OMD, Fn, FI);
Chris Lattner5696e7b2008-06-17 18:05:57 +0000475
John McCalla738c252011-03-09 04:27:21 +0000476 args.push_back(OMD->getSelfDecl());
477 args.push_back(OMD->getCmdDecl());
Chris Lattner5696e7b2008-06-17 18:05:57 +0000478
Aaron Ballman43b68be2014-03-07 17:50:17 +0000479 for (const auto *PI : OMD->params())
480 args.push_back(PI);
Chris Lattner5696e7b2008-06-17 18:05:57 +0000481
Peter Collingbourne0ff0b372011-01-13 18:57:25 +0000482 CurGD = OMD;
483
Alp Toker314cc812014-01-25 16:55:45 +0000484 StartFunction(OMD, OMD->getReturnType(), Fn, FI, args, StartLoc);
John McCall31168b02011-06-15 23:02:42 +0000485
486 // In ARC, certain methods get an extra cleanup.
David Blaikiebbafb8a2012-03-11 07:00:24 +0000487 if (CGM.getLangOpts().ObjCAutoRefCount &&
John McCall31168b02011-06-15 23:02:42 +0000488 OMD->isInstanceMethod() &&
489 OMD->getSelector().isUnarySelector()) {
490 const IdentifierInfo *ident =
491 OMD->getSelector().getIdentifierInfoForSlot(0);
492 if (ident->isStr("dealloc"))
493 EHStack.pushCleanup<FinishARCDealloc>(getARCCleanupKind());
494 }
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000495}
Daniel Dunbara94ecd22008-08-16 03:19:19 +0000496
John McCall31168b02011-06-15 23:02:42 +0000497static llvm::Value *emitARCRetainLoadOfScalar(CodeGenFunction &CGF,
498 LValue lvalue, QualType type);
499
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000500/// Generate an Objective-C method. An Objective-C method is a C function with
Mike Stump11289f42009-09-09 15:08:12 +0000501/// its pointer, name, and types registered in the class struture.
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000502void CodeGenFunction::GenerateObjCMethod(const ObjCMethodDecl *OMD) {
Devang Patele7ce5402011-05-19 23:37:41 +0000503 StartObjCMethod(OMD, OMD->getClassInterface(), OMD->getLocStart());
Bob Wilson5ec8fe12014-03-06 06:10:02 +0000504 PGO.assignRegionCounters(OMD, CurFn);
Adrian Prantl56741e22014-01-07 22:05:55 +0000505 assert(isa<CompoundStmt>(OMD->getBody()));
Bob Wilson5ec8fe12014-03-06 06:10:02 +0000506 RegionCounter Cnt = getPGORegionCounter(OMD->getBody());
507 Cnt.beginRegion(Builder);
Adrian Prantl56741e22014-01-07 22:05:55 +0000508 EmitCompoundStmtWithoutScope(*cast<CompoundStmt>(OMD->getBody()));
Argyrios Kyrtzidisddcd1322009-06-30 02:35:26 +0000509 FinishFunction(OMD->getBodyRBrace());
Bob Wilson5ec8fe12014-03-06 06:10:02 +0000510 PGO.emitWriteoutFunction();
511 PGO.destroyRegionCounters();
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000512}
513
John McCallb923ece2011-09-12 23:06:44 +0000514/// emitStructGetterCall - Call the runtime function to load a property
515/// into the return value slot.
516static void emitStructGetterCall(CodeGenFunction &CGF, ObjCIvarDecl *ivar,
517 bool isAtomic, bool hasStrong) {
518 ASTContext &Context = CGF.getContext();
519
520 llvm::Value *src =
521 CGF.EmitLValueForIvar(CGF.TypeOfSelfObject(), CGF.LoadObjCSelf(),
522 ivar, 0).getAddress();
523
524 // objc_copyStruct (ReturnValue, &structIvar,
525 // sizeof (Type of Ivar), isAtomic, false);
526 CallArgList args;
527
528 llvm::Value *dest = CGF.Builder.CreateBitCast(CGF.ReturnValue, CGF.VoidPtrTy);
529 args.add(RValue::get(dest), Context.VoidPtrTy);
530
531 src = CGF.Builder.CreateBitCast(src, CGF.VoidPtrTy);
532 args.add(RValue::get(src), Context.VoidPtrTy);
533
534 CharUnits size = CGF.getContext().getTypeSizeInChars(ivar->getType());
535 args.add(RValue::get(CGF.CGM.getSize(size)), Context.getSizeType());
536 args.add(RValue::get(CGF.Builder.getInt1(isAtomic)), Context.BoolTy);
537 args.add(RValue::get(CGF.Builder.getInt1(hasStrong)), Context.BoolTy);
538
539 llvm::Value *fn = CGF.CGM.getObjCRuntime().GetGetStructFunction();
John McCall8dda7b22012-07-07 06:41:13 +0000540 CGF.EmitCall(CGF.getTypes().arrangeFreeFunctionCall(Context.VoidTy, args,
541 FunctionType::ExtInfo(),
542 RequiredArgs::All),
John McCallb923ece2011-09-12 23:06:44 +0000543 fn, ReturnValueSlot(), args);
544}
545
John McCallf4528ae2011-09-13 03:34:09 +0000546/// Determine whether the given architecture supports unaligned atomic
547/// accesses. They don't have to be fast, just faster than a function
548/// call and a mutex.
549static bool hasUnalignedAtomics(llvm::Triple::ArchType arch) {
Eli Friedman5be3e6a2011-09-13 20:48:30 +0000550 // FIXME: Allow unaligned atomic load/store on x86. (It is not
551 // currently supported by the backend.)
552 return 0;
John McCallf4528ae2011-09-13 03:34:09 +0000553}
554
555/// Return the maximum size that permits atomic accesses for the given
556/// architecture.
557static CharUnits getMaxAtomicAccessSize(CodeGenModule &CGM,
558 llvm::Triple::ArchType arch) {
559 // ARM has 8-byte atomic accesses, but it's not clear whether we
560 // want to rely on them here.
561
562 // In the default case, just assume that any size up to a pointer is
563 // fine given adequate alignment.
564 return CharUnits::fromQuantity(CGM.PointerSizeInBytes);
565}
566
567namespace {
568 class PropertyImplStrategy {
569 public:
570 enum StrategyKind {
571 /// The 'native' strategy is to use the architecture's provided
572 /// reads and writes.
573 Native,
574
575 /// Use objc_setProperty and objc_getProperty.
576 GetSetProperty,
577
578 /// Use objc_setProperty for the setter, but use expression
579 /// evaluation for the getter.
580 SetPropertyAndExpressionGet,
581
582 /// Use objc_copyStruct.
583 CopyStruct,
584
585 /// The 'expression' strategy is to emit normal assignment or
586 /// lvalue-to-rvalue expressions.
587 Expression
588 };
589
590 StrategyKind getKind() const { return StrategyKind(Kind); }
591
592 bool hasStrongMember() const { return HasStrong; }
593 bool isAtomic() const { return IsAtomic; }
594 bool isCopy() const { return IsCopy; }
595
596 CharUnits getIvarSize() const { return IvarSize; }
597 CharUnits getIvarAlignment() const { return IvarAlignment; }
598
599 PropertyImplStrategy(CodeGenModule &CGM,
600 const ObjCPropertyImplDecl *propImpl);
601
602 private:
603 unsigned Kind : 8;
604 unsigned IsAtomic : 1;
605 unsigned IsCopy : 1;
606 unsigned HasStrong : 1;
607
608 CharUnits IvarSize;
609 CharUnits IvarAlignment;
610 };
611}
612
Sylvestre Ledru830885c2012-07-23 08:59:39 +0000613/// Pick an implementation strategy for the given property synthesis.
John McCallf4528ae2011-09-13 03:34:09 +0000614PropertyImplStrategy::PropertyImplStrategy(CodeGenModule &CGM,
615 const ObjCPropertyImplDecl *propImpl) {
616 const ObjCPropertyDecl *prop = propImpl->getPropertyDecl();
John McCall43192862011-09-13 18:31:23 +0000617 ObjCPropertyDecl::SetterKind setterKind = prop->getSetterKind();
John McCallf4528ae2011-09-13 03:34:09 +0000618
John McCall43192862011-09-13 18:31:23 +0000619 IsCopy = (setterKind == ObjCPropertyDecl::Copy);
620 IsAtomic = prop->isAtomic();
John McCallf4528ae2011-09-13 03:34:09 +0000621 HasStrong = false; // doesn't matter here.
622
623 // Evaluate the ivar's size and alignment.
624 ObjCIvarDecl *ivar = propImpl->getPropertyIvarDecl();
625 QualType ivarType = ivar->getType();
Benjamin Kramer867ea1d2014-03-02 13:01:17 +0000626 std::tie(IvarSize, IvarAlignment) =
627 CGM.getContext().getTypeInfoInChars(ivarType);
John McCallf4528ae2011-09-13 03:34:09 +0000628
629 // If we have a copy property, we always have to use getProperty/setProperty.
John McCall43192862011-09-13 18:31:23 +0000630 // TODO: we could actually use setProperty and an expression for non-atomics.
John McCallf4528ae2011-09-13 03:34:09 +0000631 if (IsCopy) {
632 Kind = GetSetProperty;
633 return;
634 }
635
John McCall43192862011-09-13 18:31:23 +0000636 // Handle retain.
637 if (setterKind == ObjCPropertyDecl::Retain) {
John McCallf4528ae2011-09-13 03:34:09 +0000638 // In GC-only, there's nothing special that needs to be done.
David Blaikiebbafb8a2012-03-11 07:00:24 +0000639 if (CGM.getLangOpts().getGC() == LangOptions::GCOnly) {
John McCallf4528ae2011-09-13 03:34:09 +0000640 // fallthrough
641
642 // In ARC, if the property is non-atomic, use expression emission,
643 // which translates to objc_storeStrong. This isn't required, but
644 // it's slightly nicer.
David Blaikiebbafb8a2012-03-11 07:00:24 +0000645 } else if (CGM.getLangOpts().ObjCAutoRefCount && !IsAtomic) {
John McCalld8561f02012-08-20 23:36:59 +0000646 // Using standard expression emission for the setter is only
647 // acceptable if the ivar is __strong, which won't be true if
648 // the property is annotated with __attribute__((NSObject)).
649 // TODO: falling all the way back to objc_setProperty here is
650 // just laziness, though; we could still use objc_storeStrong
651 // if we hacked it right.
652 if (ivarType.getObjCLifetime() == Qualifiers::OCL_Strong)
653 Kind = Expression;
654 else
655 Kind = SetPropertyAndExpressionGet;
John McCallf4528ae2011-09-13 03:34:09 +0000656 return;
657
658 // Otherwise, we need to at least use setProperty. However, if
659 // the property isn't atomic, we can use normal expression
660 // emission for the getter.
661 } else if (!IsAtomic) {
662 Kind = SetPropertyAndExpressionGet;
663 return;
664
665 // Otherwise, we have to use both setProperty and getProperty.
666 } else {
667 Kind = GetSetProperty;
668 return;
669 }
670 }
671
672 // If we're not atomic, just use expression accesses.
673 if (!IsAtomic) {
674 Kind = Expression;
675 return;
676 }
677
John McCall0e5c0862011-09-13 05:36:29 +0000678 // Properties on bitfield ivars need to be emitted using expression
679 // accesses even if they're nominally atomic.
680 if (ivar->isBitField()) {
681 Kind = Expression;
682 return;
683 }
684
John McCallf4528ae2011-09-13 03:34:09 +0000685 // GC-qualified or ARC-qualified ivars need to be emitted as
686 // expressions. This actually works out to being atomic anyway,
687 // except for ARC __strong, but that should trigger the above code.
688 if (ivarType.hasNonTrivialObjCLifetime() ||
David Blaikiebbafb8a2012-03-11 07:00:24 +0000689 (CGM.getLangOpts().getGC() &&
John McCallf4528ae2011-09-13 03:34:09 +0000690 CGM.getContext().getObjCGCAttrKind(ivarType))) {
691 Kind = Expression;
692 return;
693 }
694
695 // Compute whether the ivar has strong members.
David Blaikiebbafb8a2012-03-11 07:00:24 +0000696 if (CGM.getLangOpts().getGC())
John McCallf4528ae2011-09-13 03:34:09 +0000697 if (const RecordType *recordType = ivarType->getAs<RecordType>())
698 HasStrong = recordType->getDecl()->hasObjectMember();
699
700 // We can never access structs with object members with a native
701 // access, because we need to use write barriers. This is what
702 // objc_copyStruct is for.
703 if (HasStrong) {
704 Kind = CopyStruct;
705 return;
706 }
707
708 // Otherwise, this is target-dependent and based on the size and
709 // alignment of the ivar.
John McCall0bef0ba2011-09-13 07:33:34 +0000710
711 // If the size of the ivar is not a power of two, give up. We don't
712 // want to get into the business of doing compare-and-swaps.
713 if (!IvarSize.isPowerOfTwo()) {
714 Kind = CopyStruct;
715 return;
716 }
717
John McCallf4528ae2011-09-13 03:34:09 +0000718 llvm::Triple::ArchType arch =
John McCallc8e01702013-04-16 22:48:15 +0000719 CGM.getTarget().getTriple().getArch();
John McCallf4528ae2011-09-13 03:34:09 +0000720
721 // Most architectures require memory to fit within a single cache
722 // line, so the alignment has to be at least the size of the access.
723 // Otherwise we have to grab a lock.
724 if (IvarAlignment < IvarSize && !hasUnalignedAtomics(arch)) {
725 Kind = CopyStruct;
726 return;
727 }
728
729 // If the ivar's size exceeds the architecture's maximum atomic
730 // access size, we have to use CopyStruct.
731 if (IvarSize > getMaxAtomicAccessSize(CGM, arch)) {
732 Kind = CopyStruct;
733 return;
734 }
735
736 // Otherwise, we can use native loads and stores.
737 Kind = Native;
738}
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000739
James Dennettbe302452012-06-15 22:10:14 +0000740/// \brief Generate an Objective-C property getter function.
741///
742/// The given Decl must be an ObjCImplementationDecl. \@synthesize
Steve Naroff5a7dd782009-01-10 22:55:25 +0000743/// is illegal within a category.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +0000744void CodeGenFunction::GenerateObjCGetter(ObjCImplementationDecl *IMP,
745 const ObjCPropertyImplDecl *PID) {
Fariborz Jahanian4b501a22012-01-07 18:56:22 +0000746 llvm::Constant *AtomicHelperFn =
Fariborz Jahaniana08a7472012-01-10 00:37:01 +0000747 GenerateObjCAtomicGetterCopyHelperFunction(PID);
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000748 const ObjCPropertyDecl *PD = PID->getPropertyDecl();
749 ObjCMethodDecl *OMD = PD->getGetterMethodDecl();
750 assert(OMD && "Invalid call to generate getter (empty method)");
Eric Christopherb7e821a2012-04-03 00:44:15 +0000751 StartObjCMethod(OMD, IMP->getClassInterface(), OMD->getLocStart());
Mike Stump11289f42009-09-09 15:08:12 +0000752
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +0000753 generateObjCGetterBody(IMP, PID, OMD, AtomicHelperFn);
John McCallf4528ae2011-09-13 03:34:09 +0000754
755 FinishFunction();
756}
757
John McCallbdd81852011-09-13 06:00:03 +0000758static bool hasTrivialGetExpr(const ObjCPropertyImplDecl *propImpl) {
759 const Expr *getter = propImpl->getGetterCXXConstructor();
John McCallf4528ae2011-09-13 03:34:09 +0000760 if (!getter) return true;
761
762 // Sema only makes only of these when the ivar has a C++ class type,
763 // so the form is pretty constrained.
764
John McCallbdd81852011-09-13 06:00:03 +0000765 // If the property has a reference type, we might just be binding a
766 // reference, in which case the result will be a gl-value. We should
767 // treat this as a non-trivial operation.
768 if (getter->isGLValue())
769 return false;
770
John McCallf4528ae2011-09-13 03:34:09 +0000771 // If we selected a trivial copy-constructor, we're okay.
772 if (const CXXConstructExpr *construct = dyn_cast<CXXConstructExpr>(getter))
773 return (construct->getConstructor()->isTrivial());
774
775 // The constructor might require cleanups (in which case it's never
776 // trivial).
777 assert(isa<ExprWithCleanups>(getter));
778 return false;
779}
780
Fariborz Jahaniana08a7472012-01-10 00:37:01 +0000781/// emitCPPObjectAtomicGetterCall - Call the runtime function to
782/// copy the ivar into the resturn slot.
783static void emitCPPObjectAtomicGetterCall(CodeGenFunction &CGF,
784 llvm::Value *returnAddr,
785 ObjCIvarDecl *ivar,
786 llvm::Constant *AtomicHelperFn) {
787 // objc_copyCppObjectAtomic (&returnSlot, &CppObjectIvar,
788 // AtomicHelperFn);
789 CallArgList args;
790
791 // The 1st argument is the return Slot.
792 args.add(RValue::get(returnAddr), CGF.getContext().VoidPtrTy);
793
794 // The 2nd argument is the address of the ivar.
795 llvm::Value *ivarAddr =
796 CGF.EmitLValueForIvar(CGF.TypeOfSelfObject(),
797 CGF.LoadObjCSelf(), ivar, 0).getAddress();
798 ivarAddr = CGF.Builder.CreateBitCast(ivarAddr, CGF.Int8PtrTy);
799 args.add(RValue::get(ivarAddr), CGF.getContext().VoidPtrTy);
800
801 // Third argument is the helper function.
802 args.add(RValue::get(AtomicHelperFn), CGF.getContext().VoidPtrTy);
803
804 llvm::Value *copyCppAtomicObjectFn =
David Chisnall0d75e062012-12-17 18:54:24 +0000805 CGF.CGM.getObjCRuntime().GetCppAtomicObjectGetFunction();
John McCall8dda7b22012-07-07 06:41:13 +0000806 CGF.EmitCall(CGF.getTypes().arrangeFreeFunctionCall(CGF.getContext().VoidTy,
807 args,
808 FunctionType::ExtInfo(),
809 RequiredArgs::All),
Fariborz Jahaniana08a7472012-01-10 00:37:01 +0000810 copyCppAtomicObjectFn, ReturnValueSlot(), args);
811}
812
John McCallf4528ae2011-09-13 03:34:09 +0000813void
814CodeGenFunction::generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +0000815 const ObjCPropertyImplDecl *propImpl,
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +0000816 const ObjCMethodDecl *GetterMethodDecl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +0000817 llvm::Constant *AtomicHelperFn) {
John McCallf4528ae2011-09-13 03:34:09 +0000818 // If there's a non-trivial 'get' expression, we just have to emit that.
819 if (!hasTrivialGetExpr(propImpl)) {
Fariborz Jahaniana08a7472012-01-10 00:37:01 +0000820 if (!AtomicHelperFn) {
821 ReturnStmt ret(SourceLocation(), propImpl->getGetterCXXConstructor(),
822 /*nrvo*/ 0);
823 EmitReturnStmt(ret);
824 }
825 else {
826 ObjCIvarDecl *ivar = propImpl->getPropertyIvarDecl();
827 emitCPPObjectAtomicGetterCall(*this, ReturnValue,
828 ivar, AtomicHelperFn);
829 }
John McCallf4528ae2011-09-13 03:34:09 +0000830 return;
831 }
832
833 const ObjCPropertyDecl *prop = propImpl->getPropertyDecl();
834 QualType propType = prop->getType();
835 ObjCMethodDecl *getterMethod = prop->getGetterMethodDecl();
836
837 ObjCIvarDecl *ivar = propImpl->getPropertyIvarDecl();
838
839 // Pick an implementation strategy.
840 PropertyImplStrategy strategy(CGM, propImpl);
841 switch (strategy.getKind()) {
842 case PropertyImplStrategy::Native: {
Eli Friedman0e846022012-10-26 22:38:05 +0000843 // We don't need to do anything for a zero-size struct.
844 if (strategy.getIvarSize().isZero())
845 return;
846
John McCallf4528ae2011-09-13 03:34:09 +0000847 LValue LV = EmitLValueForIvar(TypeOfSelfObject(), LoadObjCSelf(), ivar, 0);
848
849 // Currently, all atomic accesses have to be through integer
850 // types, so there's no point in trying to pick a prettier type.
851 llvm::Type *bitcastType =
852 llvm::Type::getIntNTy(getLLVMContext(),
853 getContext().toBits(strategy.getIvarSize()));
854 bitcastType = bitcastType->getPointerTo(); // addrspace 0 okay
855
856 // Perform an atomic load. This does not impose ordering constraints.
857 llvm::Value *ivarAddr = LV.getAddress();
858 ivarAddr = Builder.CreateBitCast(ivarAddr, bitcastType);
859 llvm::LoadInst *load = Builder.CreateLoad(ivarAddr, "load");
860 load->setAlignment(strategy.getIvarAlignment().getQuantity());
861 load->setAtomic(llvm::Unordered);
862
863 // Store that value into the return address. Doing this with a
864 // bitcast is likely to produce some pretty ugly IR, but it's not
865 // the *most* terrible thing in the world.
866 Builder.CreateStore(load, Builder.CreateBitCast(ReturnValue, bitcastType));
867
868 // Make sure we don't do an autorelease.
869 AutoreleaseResult = false;
870 return;
871 }
872
873 case PropertyImplStrategy::GetSetProperty: {
874 llvm::Value *getPropertyFn =
875 CGM.getObjCRuntime().GetPropertyGetFunction();
876 if (!getPropertyFn) {
877 CGM.ErrorUnsupported(propImpl, "Obj-C getter requiring atomic copy");
Daniel Dunbara08dff12008-09-24 04:04:31 +0000878 return;
879 }
880
881 // Return (ivar-type) objc_getProperty((id) self, _cmd, offset, true).
882 // FIXME: Can't this be simpler? This might even be worse than the
883 // corresponding gcc code.
John McCallf4528ae2011-09-13 03:34:09 +0000884 llvm::Value *cmd =
885 Builder.CreateLoad(LocalDeclMap[getterMethod->getCmdDecl()], "cmd");
886 llvm::Value *self = Builder.CreateBitCast(LoadObjCSelf(), VoidPtrTy);
887 llvm::Value *ivarOffset =
888 EmitIvarOffset(classImpl->getClassInterface(), ivar);
889
890 CallArgList args;
891 args.add(RValue::get(self), getContext().getObjCIdType());
892 args.add(RValue::get(cmd), getContext().getObjCSelType());
893 args.add(RValue::get(ivarOffset), getContext().getPointerDiffType());
John McCall43192862011-09-13 18:31:23 +0000894 args.add(RValue::get(Builder.getInt1(strategy.isAtomic())),
895 getContext().BoolTy);
John McCallf4528ae2011-09-13 03:34:09 +0000896
Daniel Dunbar1ef73732009-02-03 23:43:59 +0000897 // FIXME: We shouldn't need to get the function info here, the
898 // runtime already should have computed it to build the function.
Fariborz Jahanian13b43042014-01-30 00:16:39 +0000899 llvm::Instruction *CallInstruction;
John McCall8dda7b22012-07-07 06:41:13 +0000900 RValue RV = EmitCall(getTypes().arrangeFreeFunctionCall(propType, args,
901 FunctionType::ExtInfo(),
902 RequiredArgs::All),
Fariborz Jahanian13b43042014-01-30 00:16:39 +0000903 getPropertyFn, ReturnValueSlot(), args, 0,
904 &CallInstruction);
905 if (llvm::CallInst *call = dyn_cast<llvm::CallInst>(CallInstruction))
906 call->setTailCall();
John McCallf4528ae2011-09-13 03:34:09 +0000907
Daniel Dunbara08dff12008-09-24 04:04:31 +0000908 // We need to fix the type here. Ivars with copy & retain are
909 // always objects so we don't need to worry about complex or
910 // aggregates.
Alp Toker314cc812014-01-25 16:55:45 +0000911 RV = RValue::get(Builder.CreateBitCast(
912 RV.getScalarVal(),
913 getTypes().ConvertType(getterMethod->getReturnType())));
John McCallf4528ae2011-09-13 03:34:09 +0000914
915 EmitReturnOfRValue(RV, propType);
John McCall31168b02011-06-15 23:02:42 +0000916
917 // objc_getProperty does an autorelease, so we should suppress ours.
918 AutoreleaseResult = false;
John McCall31168b02011-06-15 23:02:42 +0000919
John McCallf4528ae2011-09-13 03:34:09 +0000920 return;
921 }
922
923 case PropertyImplStrategy::CopyStruct:
924 emitStructGetterCall(*this, ivar, strategy.isAtomic(),
925 strategy.hasStrongMember());
926 return;
927
928 case PropertyImplStrategy::Expression:
929 case PropertyImplStrategy::SetPropertyAndExpressionGet: {
930 LValue LV = EmitLValueForIvar(TypeOfSelfObject(), LoadObjCSelf(), ivar, 0);
931
932 QualType ivarType = ivar->getType();
John McCall47fb9502013-03-07 21:37:08 +0000933 switch (getEvaluationKind(ivarType)) {
934 case TEK_Complex: {
Nick Lewycky2d84e842013-10-02 02:29:49 +0000935 ComplexPairTy pair = EmitLoadOfComplex(LV, SourceLocation());
John McCall47fb9502013-03-07 21:37:08 +0000936 EmitStoreOfComplex(pair,
937 MakeNaturalAlignAddrLValue(ReturnValue, ivarType),
938 /*init*/ true);
939 return;
940 }
941 case TEK_Aggregate:
John McCallf4528ae2011-09-13 03:34:09 +0000942 // The return value slot is guaranteed to not be aliased, but
943 // that's not necessarily the same as "on the stack", so
944 // we still potentially need objc_memmove_collectable.
Chad Rosier615ed1a2012-03-29 17:37:10 +0000945 EmitAggregateCopy(ReturnValue, LV.getAddress(), ivarType);
John McCall47fb9502013-03-07 21:37:08 +0000946 return;
947 case TEK_Scalar: {
John McCall24fada12011-07-22 05:23:13 +0000948 llvm::Value *value;
949 if (propType->isReferenceType()) {
950 value = LV.getAddress();
951 } else {
952 // We want to load and autoreleaseReturnValue ARC __weak ivars.
953 if (LV.getQuals().getObjCLifetime() == Qualifiers::OCL_Weak) {
John McCallf4528ae2011-09-13 03:34:09 +0000954 value = emitARCRetainLoadOfScalar(*this, LV, ivarType);
John McCall24fada12011-07-22 05:23:13 +0000955
956 // Otherwise we want to do a simple load, suppressing the
957 // final autorelease.
John McCall31168b02011-06-15 23:02:42 +0000958 } else {
Nick Lewycky2d84e842013-10-02 02:29:49 +0000959 value = EmitLoadOfLValue(LV, SourceLocation()).getScalarVal();
John McCall24fada12011-07-22 05:23:13 +0000960 AutoreleaseResult = false;
Fariborz Jahanianb24b5682011-03-28 23:47:18 +0000961 }
John McCall31168b02011-06-15 23:02:42 +0000962
John McCall24fada12011-07-22 05:23:13 +0000963 value = Builder.CreateBitCast(value, ConvertType(propType));
Alp Toker314cc812014-01-25 16:55:45 +0000964 value = Builder.CreateBitCast(
965 value, ConvertType(GetterMethodDecl->getReturnType()));
John McCall24fada12011-07-22 05:23:13 +0000966 }
967
968 EmitReturnOfRValue(RValue::get(value), propType);
John McCall47fb9502013-03-07 21:37:08 +0000969 return;
Fariborz Jahanianeab5ecd2009-03-03 18:49:40 +0000970 }
John McCall47fb9502013-03-07 21:37:08 +0000971 }
972 llvm_unreachable("bad evaluation kind");
Daniel Dunbara08dff12008-09-24 04:04:31 +0000973 }
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000974
John McCallf4528ae2011-09-13 03:34:09 +0000975 }
976 llvm_unreachable("bad @property implementation strategy!");
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000977}
978
John McCallb923ece2011-09-12 23:06:44 +0000979/// emitStructSetterCall - Call the runtime function to store the value
980/// from the first formal parameter into the given ivar.
981static void emitStructSetterCall(CodeGenFunction &CGF, ObjCMethodDecl *OMD,
982 ObjCIvarDecl *ivar) {
Fariborz Jahanian302a3d42011-02-18 19:15:13 +0000983 // objc_copyStruct (&structIvar, &Arg,
984 // sizeof (struct something), true, false);
John McCall6acaef92011-09-10 09:30:49 +0000985 CallArgList args;
986
987 // The first argument is the address of the ivar.
John McCallb923ece2011-09-12 23:06:44 +0000988 llvm::Value *ivarAddr = CGF.EmitLValueForIvar(CGF.TypeOfSelfObject(),
989 CGF.LoadObjCSelf(), ivar, 0)
990 .getAddress();
991 ivarAddr = CGF.Builder.CreateBitCast(ivarAddr, CGF.Int8PtrTy);
992 args.add(RValue::get(ivarAddr), CGF.getContext().VoidPtrTy);
John McCall6acaef92011-09-10 09:30:49 +0000993
994 // The second argument is the address of the parameter variable.
John McCallb923ece2011-09-12 23:06:44 +0000995 ParmVarDecl *argVar = *OMD->param_begin();
John McCall113bee02012-03-10 09:33:50 +0000996 DeclRefExpr argRef(argVar, false, argVar->getType().getNonReferenceType(),
Fariborz Jahanian088f1bc2012-01-05 00:10:16 +0000997 VK_LValue, SourceLocation());
John McCallb923ece2011-09-12 23:06:44 +0000998 llvm::Value *argAddr = CGF.EmitLValue(&argRef).getAddress();
999 argAddr = CGF.Builder.CreateBitCast(argAddr, CGF.Int8PtrTy);
1000 args.add(RValue::get(argAddr), CGF.getContext().VoidPtrTy);
John McCall6acaef92011-09-10 09:30:49 +00001001
1002 // The third argument is the sizeof the type.
1003 llvm::Value *size =
John McCallb923ece2011-09-12 23:06:44 +00001004 CGF.CGM.getSize(CGF.getContext().getTypeSizeInChars(ivar->getType()));
1005 args.add(RValue::get(size), CGF.getContext().getSizeType());
John McCall6acaef92011-09-10 09:30:49 +00001006
John McCallb923ece2011-09-12 23:06:44 +00001007 // The fourth argument is the 'isAtomic' flag.
1008 args.add(RValue::get(CGF.Builder.getTrue()), CGF.getContext().BoolTy);
John McCall6acaef92011-09-10 09:30:49 +00001009
John McCallb923ece2011-09-12 23:06:44 +00001010 // The fifth argument is the 'hasStrong' flag.
1011 // FIXME: should this really always be false?
1012 args.add(RValue::get(CGF.Builder.getFalse()), CGF.getContext().BoolTy);
1013
1014 llvm::Value *copyStructFn = CGF.CGM.getObjCRuntime().GetSetStructFunction();
John McCall8dda7b22012-07-07 06:41:13 +00001015 CGF.EmitCall(CGF.getTypes().arrangeFreeFunctionCall(CGF.getContext().VoidTy,
1016 args,
1017 FunctionType::ExtInfo(),
1018 RequiredArgs::All),
John McCallb923ece2011-09-12 23:06:44 +00001019 copyStructFn, ReturnValueSlot(), args);
Fariborz Jahanian302a3d42011-02-18 19:15:13 +00001020}
1021
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001022/// emitCPPObjectAtomicSetterCall - Call the runtime function to store
1023/// the value from the first formal parameter into the given ivar, using
1024/// the Cpp API for atomic Cpp objects with non-trivial copy assignment.
1025static void emitCPPObjectAtomicSetterCall(CodeGenFunction &CGF,
1026 ObjCMethodDecl *OMD,
1027 ObjCIvarDecl *ivar,
1028 llvm::Constant *AtomicHelperFn) {
1029 // objc_copyCppObjectAtomic (&CppObjectIvar, &Arg,
1030 // AtomicHelperFn);
1031 CallArgList args;
1032
1033 // The first argument is the address of the ivar.
1034 llvm::Value *ivarAddr =
1035 CGF.EmitLValueForIvar(CGF.TypeOfSelfObject(),
1036 CGF.LoadObjCSelf(), ivar, 0).getAddress();
1037 ivarAddr = CGF.Builder.CreateBitCast(ivarAddr, CGF.Int8PtrTy);
1038 args.add(RValue::get(ivarAddr), CGF.getContext().VoidPtrTy);
1039
1040 // The second argument is the address of the parameter variable.
1041 ParmVarDecl *argVar = *OMD->param_begin();
John McCall113bee02012-03-10 09:33:50 +00001042 DeclRefExpr argRef(argVar, false, argVar->getType().getNonReferenceType(),
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001043 VK_LValue, SourceLocation());
1044 llvm::Value *argAddr = CGF.EmitLValue(&argRef).getAddress();
1045 argAddr = CGF.Builder.CreateBitCast(argAddr, CGF.Int8PtrTy);
1046 args.add(RValue::get(argAddr), CGF.getContext().VoidPtrTy);
1047
1048 // Third argument is the helper function.
1049 args.add(RValue::get(AtomicHelperFn), CGF.getContext().VoidPtrTy);
1050
1051 llvm::Value *copyCppAtomicObjectFn =
David Chisnall0d75e062012-12-17 18:54:24 +00001052 CGF.CGM.getObjCRuntime().GetCppAtomicObjectSetFunction();
John McCall8dda7b22012-07-07 06:41:13 +00001053 CGF.EmitCall(CGF.getTypes().arrangeFreeFunctionCall(CGF.getContext().VoidTy,
1054 args,
1055 FunctionType::ExtInfo(),
1056 RequiredArgs::All),
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001057 copyCppAtomicObjectFn, ReturnValueSlot(), args);
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001058}
1059
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00001060
John McCallf4528ae2011-09-13 03:34:09 +00001061static bool hasTrivialSetExpr(const ObjCPropertyImplDecl *PID) {
1062 Expr *setter = PID->getSetterCXXAssignment();
1063 if (!setter) return true;
1064
1065 // Sema only makes only of these when the ivar has a C++ class type,
1066 // so the form is pretty constrained.
John McCall7f16c422011-09-10 09:17:20 +00001067
1068 // An operator call is trivial if the function it calls is trivial.
John McCallf4528ae2011-09-13 03:34:09 +00001069 // This also implies that there's nothing non-trivial going on with
1070 // the arguments, because operator= can only be trivial if it's a
1071 // synthesized assignment operator and therefore both parameters are
1072 // references.
1073 if (CallExpr *call = dyn_cast<CallExpr>(setter)) {
John McCall7f16c422011-09-10 09:17:20 +00001074 if (const FunctionDecl *callee
1075 = dyn_cast_or_null<FunctionDecl>(call->getCalleeDecl()))
1076 if (callee->isTrivial())
1077 return true;
1078 return false;
Fariborz Jahanian5de53132011-04-06 16:05:26 +00001079 }
John McCall7f16c422011-09-10 09:17:20 +00001080
John McCallf4528ae2011-09-13 03:34:09 +00001081 assert(isa<ExprWithCleanups>(setter));
John McCall7f16c422011-09-10 09:17:20 +00001082 return false;
1083}
1084
Benjamin Kramer53ba6362012-03-10 20:38:56 +00001085static bool UseOptimizedSetter(CodeGenModule &CGM) {
David Blaikiebbafb8a2012-03-11 07:00:24 +00001086 if (CGM.getLangOpts().getGC() != LangOptions::NonGC)
Ted Kremeneke65b0862012-03-06 20:05:56 +00001087 return false;
Daniel Dunbarbd847cc2012-10-15 22:23:53 +00001088 return CGM.getLangOpts().ObjCRuntime.hasOptimizedSetter();
Ted Kremeneke65b0862012-03-06 20:05:56 +00001089}
1090
John McCall7f16c422011-09-10 09:17:20 +00001091void
1092CodeGenFunction::generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001093 const ObjCPropertyImplDecl *propImpl,
1094 llvm::Constant *AtomicHelperFn) {
John McCall7f16c422011-09-10 09:17:20 +00001095 const ObjCPropertyDecl *prop = propImpl->getPropertyDecl();
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00001096 ObjCIvarDecl *ivar = propImpl->getPropertyIvarDecl();
John McCall7f16c422011-09-10 09:17:20 +00001097 ObjCMethodDecl *setterMethod = prop->getSetterMethodDecl();
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001098
1099 // Just use the setter expression if Sema gave us one and it's
1100 // non-trivial.
1101 if (!hasTrivialSetExpr(propImpl)) {
1102 if (!AtomicHelperFn)
1103 // If non-atomic, assignment is called directly.
1104 EmitStmt(propImpl->getSetterCXXAssignment());
1105 else
1106 // If atomic, assignment is called via a locking api.
1107 emitCPPObjectAtomicSetterCall(*this, setterMethod, ivar,
1108 AtomicHelperFn);
1109 return;
1110 }
John McCall7f16c422011-09-10 09:17:20 +00001111
John McCallf4528ae2011-09-13 03:34:09 +00001112 PropertyImplStrategy strategy(CGM, propImpl);
1113 switch (strategy.getKind()) {
1114 case PropertyImplStrategy::Native: {
Eli Friedman0e846022012-10-26 22:38:05 +00001115 // We don't need to do anything for a zero-size struct.
1116 if (strategy.getIvarSize().isZero())
1117 return;
1118
John McCallf4528ae2011-09-13 03:34:09 +00001119 llvm::Value *argAddr = LocalDeclMap[*setterMethod->param_begin()];
John McCall7f16c422011-09-10 09:17:20 +00001120
John McCallf4528ae2011-09-13 03:34:09 +00001121 LValue ivarLValue =
1122 EmitLValueForIvar(TypeOfSelfObject(), LoadObjCSelf(), ivar, /*quals*/ 0);
1123 llvm::Value *ivarAddr = ivarLValue.getAddress();
John McCall7f16c422011-09-10 09:17:20 +00001124
John McCallf4528ae2011-09-13 03:34:09 +00001125 // Currently, all atomic accesses have to be through integer
1126 // types, so there's no point in trying to pick a prettier type.
1127 llvm::Type *bitcastType =
1128 llvm::Type::getIntNTy(getLLVMContext(),
1129 getContext().toBits(strategy.getIvarSize()));
1130 bitcastType = bitcastType->getPointerTo(); // addrspace 0 okay
1131
1132 // Cast both arguments to the chosen operation type.
1133 argAddr = Builder.CreateBitCast(argAddr, bitcastType);
1134 ivarAddr = Builder.CreateBitCast(ivarAddr, bitcastType);
1135
1136 // This bitcast load is likely to cause some nasty IR.
1137 llvm::Value *load = Builder.CreateLoad(argAddr);
1138
1139 // Perform an atomic store. There are no memory ordering requirements.
1140 llvm::StoreInst *store = Builder.CreateStore(load, ivarAddr);
1141 store->setAlignment(strategy.getIvarAlignment().getQuantity());
1142 store->setAtomic(llvm::Unordered);
1143 return;
1144 }
1145
1146 case PropertyImplStrategy::GetSetProperty:
1147 case PropertyImplStrategy::SetPropertyAndExpressionGet: {
Ted Kremeneke65b0862012-03-06 20:05:56 +00001148
1149 llvm::Value *setOptimizedPropertyFn = 0;
1150 llvm::Value *setPropertyFn = 0;
1151 if (UseOptimizedSetter(CGM)) {
Daniel Dunbarbd847cc2012-10-15 22:23:53 +00001152 // 10.8 and iOS 6.0 code and GC is off
Ted Kremeneke65b0862012-03-06 20:05:56 +00001153 setOptimizedPropertyFn =
Eric Christopher5d2b8d92012-03-29 17:31:31 +00001154 CGM.getObjCRuntime()
1155 .GetOptimizedPropertySetFunction(strategy.isAtomic(),
1156 strategy.isCopy());
Ted Kremeneke65b0862012-03-06 20:05:56 +00001157 if (!setOptimizedPropertyFn) {
1158 CGM.ErrorUnsupported(propImpl, "Obj-C optimized setter - NYI");
1159 return;
1160 }
John McCall7f16c422011-09-10 09:17:20 +00001161 }
Ted Kremeneke65b0862012-03-06 20:05:56 +00001162 else {
1163 setPropertyFn = CGM.getObjCRuntime().GetPropertySetFunction();
1164 if (!setPropertyFn) {
1165 CGM.ErrorUnsupported(propImpl, "Obj-C setter requiring atomic copy");
1166 return;
1167 }
1168 }
1169
John McCall7f16c422011-09-10 09:17:20 +00001170 // Emit objc_setProperty((id) self, _cmd, offset, arg,
1171 // <is-atomic>, <is-copy>).
1172 llvm::Value *cmd =
1173 Builder.CreateLoad(LocalDeclMap[setterMethod->getCmdDecl()]);
1174 llvm::Value *self =
1175 Builder.CreateBitCast(LoadObjCSelf(), VoidPtrTy);
1176 llvm::Value *ivarOffset =
1177 EmitIvarOffset(classImpl->getClassInterface(), ivar);
1178 llvm::Value *arg = LocalDeclMap[*setterMethod->param_begin()];
1179 arg = Builder.CreateBitCast(Builder.CreateLoad(arg, "arg"), VoidPtrTy);
1180
1181 CallArgList args;
1182 args.add(RValue::get(self), getContext().getObjCIdType());
1183 args.add(RValue::get(cmd), getContext().getObjCSelType());
Ted Kremeneke65b0862012-03-06 20:05:56 +00001184 if (setOptimizedPropertyFn) {
1185 args.add(RValue::get(arg), getContext().getObjCIdType());
1186 args.add(RValue::get(ivarOffset), getContext().getPointerDiffType());
John McCall8dda7b22012-07-07 06:41:13 +00001187 EmitCall(getTypes().arrangeFreeFunctionCall(getContext().VoidTy, args,
1188 FunctionType::ExtInfo(),
1189 RequiredArgs::All),
Ted Kremeneke65b0862012-03-06 20:05:56 +00001190 setOptimizedPropertyFn, ReturnValueSlot(), args);
1191 } else {
1192 args.add(RValue::get(ivarOffset), getContext().getPointerDiffType());
1193 args.add(RValue::get(arg), getContext().getObjCIdType());
1194 args.add(RValue::get(Builder.getInt1(strategy.isAtomic())),
1195 getContext().BoolTy);
1196 args.add(RValue::get(Builder.getInt1(strategy.isCopy())),
1197 getContext().BoolTy);
1198 // FIXME: We shouldn't need to get the function info here, the runtime
1199 // already should have computed it to build the function.
John McCall8dda7b22012-07-07 06:41:13 +00001200 EmitCall(getTypes().arrangeFreeFunctionCall(getContext().VoidTy, args,
1201 FunctionType::ExtInfo(),
1202 RequiredArgs::All),
Ted Kremeneke65b0862012-03-06 20:05:56 +00001203 setPropertyFn, ReturnValueSlot(), args);
1204 }
1205
John McCall7f16c422011-09-10 09:17:20 +00001206 return;
1207 }
1208
John McCallf4528ae2011-09-13 03:34:09 +00001209 case PropertyImplStrategy::CopyStruct:
John McCallb923ece2011-09-12 23:06:44 +00001210 emitStructSetterCall(*this, setterMethod, ivar);
John McCall7f16c422011-09-10 09:17:20 +00001211 return;
John McCallf4528ae2011-09-13 03:34:09 +00001212
1213 case PropertyImplStrategy::Expression:
1214 break;
John McCall7f16c422011-09-10 09:17:20 +00001215 }
1216
1217 // Otherwise, fake up some ASTs and emit a normal assignment.
1218 ValueDecl *selfDecl = setterMethod->getSelfDecl();
John McCall113bee02012-03-10 09:33:50 +00001219 DeclRefExpr self(selfDecl, false, selfDecl->getType(),
1220 VK_LValue, SourceLocation());
John McCall7f16c422011-09-10 09:17:20 +00001221 ImplicitCastExpr selfLoad(ImplicitCastExpr::OnStack,
1222 selfDecl->getType(), CK_LValueToRValue, &self,
1223 VK_RValue);
1224 ObjCIvarRefExpr ivarRef(ivar, ivar->getType().getNonReferenceType(),
Fariborz Jahanianf12ff4df2013-04-02 18:57:54 +00001225 SourceLocation(), SourceLocation(),
1226 &selfLoad, true, true);
John McCall7f16c422011-09-10 09:17:20 +00001227
1228 ParmVarDecl *argDecl = *setterMethod->param_begin();
1229 QualType argType = argDecl->getType().getNonReferenceType();
John McCall113bee02012-03-10 09:33:50 +00001230 DeclRefExpr arg(argDecl, false, argType, VK_LValue, SourceLocation());
John McCall7f16c422011-09-10 09:17:20 +00001231 ImplicitCastExpr argLoad(ImplicitCastExpr::OnStack,
1232 argType.getUnqualifiedType(), CK_LValueToRValue,
1233 &arg, VK_RValue);
1234
1235 // The property type can differ from the ivar type in some situations with
1236 // Objective-C pointer types, we can always bit cast the RHS in these cases.
1237 // The following absurdity is just to ensure well-formed IR.
1238 CastKind argCK = CK_NoOp;
1239 if (ivarRef.getType()->isObjCObjectPointerType()) {
1240 if (argLoad.getType()->isObjCObjectPointerType())
1241 argCK = CK_BitCast;
1242 else if (argLoad.getType()->isBlockPointerType())
1243 argCK = CK_BlockPointerToObjCPointerCast;
1244 else
1245 argCK = CK_CPointerToObjCPointerCast;
1246 } else if (ivarRef.getType()->isBlockPointerType()) {
1247 if (argLoad.getType()->isBlockPointerType())
1248 argCK = CK_BitCast;
1249 else
1250 argCK = CK_AnyPointerToBlockPointerCast;
1251 } else if (ivarRef.getType()->isPointerType()) {
1252 argCK = CK_BitCast;
1253 }
1254 ImplicitCastExpr argCast(ImplicitCastExpr::OnStack,
1255 ivarRef.getType(), argCK, &argLoad,
1256 VK_RValue);
1257 Expr *finalArg = &argLoad;
1258 if (!getContext().hasSameUnqualifiedType(ivarRef.getType(),
1259 argLoad.getType()))
1260 finalArg = &argCast;
1261
1262
1263 BinaryOperator assign(&ivarRef, finalArg, BO_Assign,
1264 ivarRef.getType(), VK_RValue, OK_Ordinary,
Lang Hames5de91cc2012-10-02 04:45:10 +00001265 SourceLocation(), false);
John McCall7f16c422011-09-10 09:17:20 +00001266 EmitStmt(&assign);
Fariborz Jahanian5de53132011-04-06 16:05:26 +00001267}
1268
James Dennettbe302452012-06-15 22:10:14 +00001269/// \brief Generate an Objective-C property setter function.
1270///
1271/// The given Decl must be an ObjCImplementationDecl. \@synthesize
Steve Naroff5a7dd782009-01-10 22:55:25 +00001272/// is illegal within a category.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001273void CodeGenFunction::GenerateObjCSetter(ObjCImplementationDecl *IMP,
1274 const ObjCPropertyImplDecl *PID) {
Fariborz Jahanian4b501a22012-01-07 18:56:22 +00001275 llvm::Constant *AtomicHelperFn =
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00001276 GenerateObjCAtomicSetterCopyHelperFunction(PID);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001277 const ObjCPropertyDecl *PD = PID->getPropertyDecl();
1278 ObjCMethodDecl *OMD = PD->getSetterMethodDecl();
1279 assert(OMD && "Invalid call to generate setter (empty method)");
Eric Christopherb7e821a2012-04-03 00:44:15 +00001280 StartObjCMethod(OMD, IMP->getClassInterface(), OMD->getLocStart());
Daniel Dunbar5449ce52008-09-24 06:32:09 +00001281
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001282 generateObjCSetterBody(IMP, PID, AtomicHelperFn);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001283
1284 FinishFunction();
Chris Lattner5696e7b2008-06-17 18:05:57 +00001285}
1286
John McCall6a4fa522011-03-22 07:05:39 +00001287namespace {
John McCall4bd0fb12011-07-12 16:41:08 +00001288 struct DestroyIvar : EHScopeStack::Cleanup {
1289 private:
1290 llvm::Value *addr;
John McCall6a4fa522011-03-22 07:05:39 +00001291 const ObjCIvarDecl *ivar;
Peter Collingbourne1425b452012-01-26 03:33:36 +00001292 CodeGenFunction::Destroyer *destroyer;
John McCall4bd0fb12011-07-12 16:41:08 +00001293 bool useEHCleanupForArray;
1294 public:
1295 DestroyIvar(llvm::Value *addr, const ObjCIvarDecl *ivar,
1296 CodeGenFunction::Destroyer *destroyer,
1297 bool useEHCleanupForArray)
Peter Collingbourne1425b452012-01-26 03:33:36 +00001298 : addr(addr), ivar(ivar), destroyer(destroyer),
John McCall4bd0fb12011-07-12 16:41:08 +00001299 useEHCleanupForArray(useEHCleanupForArray) {}
John McCall6a4fa522011-03-22 07:05:39 +00001300
John McCall30317fd2011-07-12 20:27:29 +00001301 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCall4bd0fb12011-07-12 16:41:08 +00001302 LValue lvalue
1303 = CGF.EmitLValueForIvar(CGF.TypeOfSelfObject(), addr, ivar, /*CVR*/ 0);
1304 CGF.emitDestroy(lvalue.getAddress(), ivar->getType(), destroyer,
John McCall30317fd2011-07-12 20:27:29 +00001305 flags.isForNormalCleanup() && useEHCleanupForArray);
John McCall6a4fa522011-03-22 07:05:39 +00001306 }
1307 };
1308}
1309
John McCall4bd0fb12011-07-12 16:41:08 +00001310/// Like CodeGenFunction::destroyARCStrong, but do it with a call.
1311static void destroyARCStrongWithStore(CodeGenFunction &CGF,
1312 llvm::Value *addr,
1313 QualType type) {
1314 llvm::Value *null = getNullForVariable(addr);
1315 CGF.EmitARCStoreStrongCall(addr, null, /*ignored*/ true);
1316}
John McCall31168b02011-06-15 23:02:42 +00001317
John McCall6a4fa522011-03-22 07:05:39 +00001318static void emitCXXDestructMethod(CodeGenFunction &CGF,
1319 ObjCImplementationDecl *impl) {
1320 CodeGenFunction::RunCleanupsScope scope(CGF);
1321
1322 llvm::Value *self = CGF.LoadObjCSelf();
1323
Jordy Rosea91768e2011-07-22 02:08:32 +00001324 const ObjCInterfaceDecl *iface = impl->getClassInterface();
1325 for (const ObjCIvarDecl *ivar = iface->all_declared_ivar_begin();
John McCall6a4fa522011-03-22 07:05:39 +00001326 ivar; ivar = ivar->getNextIvar()) {
1327 QualType type = ivar->getType();
1328
John McCall6a4fa522011-03-22 07:05:39 +00001329 // Check whether the ivar is a destructible type.
John McCall4bd0fb12011-07-12 16:41:08 +00001330 QualType::DestructionKind dtorKind = type.isDestructedType();
1331 if (!dtorKind) continue;
John McCall6a4fa522011-03-22 07:05:39 +00001332
John McCall4bd0fb12011-07-12 16:41:08 +00001333 CodeGenFunction::Destroyer *destroyer = 0;
John McCall6a4fa522011-03-22 07:05:39 +00001334
John McCall4bd0fb12011-07-12 16:41:08 +00001335 // Use a call to objc_storeStrong to destroy strong ivars, for the
1336 // general benefit of the tools.
1337 if (dtorKind == QualType::DK_objc_strong_lifetime) {
Peter Collingbourne1425b452012-01-26 03:33:36 +00001338 destroyer = destroyARCStrongWithStore;
John McCall31168b02011-06-15 23:02:42 +00001339
John McCall4bd0fb12011-07-12 16:41:08 +00001340 // Otherwise use the default for the destruction kind.
1341 } else {
Peter Collingbourne1425b452012-01-26 03:33:36 +00001342 destroyer = CGF.getDestroyer(dtorKind);
John McCall6a4fa522011-03-22 07:05:39 +00001343 }
John McCall4bd0fb12011-07-12 16:41:08 +00001344
1345 CleanupKind cleanupKind = CGF.getCleanupKind(dtorKind);
1346
1347 CGF.EHStack.pushCleanup<DestroyIvar>(cleanupKind, self, ivar, destroyer,
1348 cleanupKind & EHCleanup);
John McCall6a4fa522011-03-22 07:05:39 +00001349 }
1350
1351 assert(scope.requiresCleanups() && "nothing to do in .cxx_destruct?");
1352}
1353
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001354void CodeGenFunction::GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1355 ObjCMethodDecl *MD,
1356 bool ctor) {
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001357 MD->createImplicitParams(CGM.getContext(), IMP->getClassInterface());
Devang Patele7ce5402011-05-19 23:37:41 +00001358 StartObjCMethod(MD, IMP->getClassInterface(), MD->getLocStart());
John McCall6a4fa522011-03-22 07:05:39 +00001359
1360 // Emit .cxx_construct.
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001361 if (ctor) {
John McCall31168b02011-06-15 23:02:42 +00001362 // Suppress the final autorelease in ARC.
1363 AutoreleaseResult = false;
1364
John McCall6a4fa522011-03-22 07:05:39 +00001365 for (ObjCImplementationDecl::init_const_iterator B = IMP->init_begin(),
1366 E = IMP->init_end(); B != E; ++B) {
1367 CXXCtorInitializer *IvarInit = (*B);
Francois Pichetd583da02010-12-04 09:14:42 +00001368 FieldDecl *Field = IvarInit->getAnyMember();
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001369 ObjCIvarDecl *Ivar = cast<ObjCIvarDecl>(Field);
Fariborz Jahanian499b9022010-04-28 22:30:33 +00001370 LValue LV = EmitLValueForIvar(TypeOfSelfObject(),
1371 LoadObjCSelf(), Ivar, 0);
John McCall8d6fc952011-08-25 20:40:09 +00001372 EmitAggExpr(IvarInit->getInit(),
1373 AggValueSlot::forLValue(LV, AggValueSlot::IsDestructed,
John McCalla5efa732011-08-25 23:04:34 +00001374 AggValueSlot::DoesNotNeedGCBarriers,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001375 AggValueSlot::IsNotAliased));
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001376 }
1377 // constructor returns 'self'.
1378 CodeGenTypes &Types = CGM.getTypes();
1379 QualType IdTy(CGM.getContext().getObjCIdType());
1380 llvm::Value *SelfAsId =
1381 Builder.CreateBitCast(LoadObjCSelf(), Types.ConvertType(IdTy));
1382 EmitReturnOfRValue(RValue::get(SelfAsId), IdTy);
John McCall6a4fa522011-03-22 07:05:39 +00001383
1384 // Emit .cxx_destruct.
Chandler Carruthf3983652010-05-06 00:20:39 +00001385 } else {
John McCall6a4fa522011-03-22 07:05:39 +00001386 emitCXXDestructMethod(*this, IMP);
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001387 }
1388 FinishFunction();
1389}
1390
Fariborz Jahanian08b0f662010-04-13 00:38:05 +00001391bool CodeGenFunction::IndirectObjCSetterArg(const CGFunctionInfo &FI) {
1392 CGFunctionInfo::const_arg_iterator it = FI.arg_begin();
1393 it++; it++;
1394 const ABIArgInfo &AI = it->info;
1395 // FIXME. Is this sufficient check?
1396 return (AI.getKind() == ABIArgInfo::Indirect);
1397}
1398
Fariborz Jahanian7e9d52a2010-04-13 18:32:24 +00001399bool CodeGenFunction::IvarTypeWithAggrGCObjects(QualType Ty) {
David Blaikiebbafb8a2012-03-11 07:00:24 +00001400 if (CGM.getLangOpts().getGC() == LangOptions::NonGC)
Fariborz Jahanian7e9d52a2010-04-13 18:32:24 +00001401 return false;
1402 if (const RecordType *FDTTy = Ty.getTypePtr()->getAs<RecordType>())
1403 return FDTTy->getDecl()->hasObjectMember();
1404 return false;
1405}
1406
Daniel Dunbara08dff12008-09-24 04:04:31 +00001407llvm::Value *CodeGenFunction::LoadObjCSelf() {
John McCalldec348f72013-05-03 07:33:41 +00001408 VarDecl *Self = cast<ObjCMethodDecl>(CurFuncDecl)->getSelfDecl();
1409 DeclRefExpr DRE(Self, /*is enclosing local*/ (CurFuncDecl != CurCodeDecl),
1410 Self->getType(), VK_LValue, SourceLocation());
Nick Lewycky2d84e842013-10-02 02:29:49 +00001411 return EmitLoadOfScalar(EmitDeclRefLValue(&DRE), SourceLocation());
Chris Lattner5696e7b2008-06-17 18:05:57 +00001412}
1413
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00001414QualType CodeGenFunction::TypeOfSelfObject() {
1415 const ObjCMethodDecl *OMD = cast<ObjCMethodDecl>(CurFuncDecl);
1416 ImplicitParamDecl *selfDecl = OMD->getSelfDecl();
Steve Naroff7cae42b2009-07-10 23:34:53 +00001417 const ObjCObjectPointerType *PTy = cast<ObjCObjectPointerType>(
1418 getContext().getCanonicalType(selfDecl->getType()));
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00001419 return PTy->getPointeeType();
1420}
1421
Chris Lattnerd4808922009-03-22 21:03:39 +00001422void CodeGenFunction::EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S){
Mike Stump11289f42009-09-09 15:08:12 +00001423 llvm::Constant *EnumerationMutationFn =
Daniel Dunbara08dff12008-09-24 04:04:31 +00001424 CGM.getObjCRuntime().EnumerationMutationFunction();
Mike Stump11289f42009-09-09 15:08:12 +00001425
Daniel Dunbara08dff12008-09-24 04:04:31 +00001426 if (!EnumerationMutationFn) {
1427 CGM.ErrorUnsupported(&S, "Obj-C fast enumeration for this runtime");
1428 return;
1429 }
1430
Devang Pateld2d66652011-01-19 01:36:36 +00001431 CGDebugInfo *DI = getDebugInfo();
Eric Christopher7cdf9482011-10-13 21:45:18 +00001432 if (DI)
1433 DI->EmitLexicalBlockStart(Builder, S.getSourceRange().getBegin());
Devang Pateld2d66652011-01-19 01:36:36 +00001434
Devang Patel297207f2011-06-13 23:15:32 +00001435 // The local variable comes into scope immediately.
1436 AutoVarEmission variable = AutoVarEmission::invalid();
1437 if (const DeclStmt *SD = dyn_cast<DeclStmt>(S.getElement()))
1438 variable = EmitAutoVarAlloca(*cast<VarDecl>(SD->getSingleDecl()));
1439
John McCall1c926b72011-01-07 01:49:06 +00001440 JumpDest LoopEnd = getJumpDestInCurrentScope("forcoll.end");
Mike Stump11289f42009-09-09 15:08:12 +00001441
Anders Carlsson75658592008-08-31 02:33:12 +00001442 // Fast enumeration state.
Douglas Gregor636e2002011-08-09 17:23:49 +00001443 QualType StateTy = CGM.getObjCFastEnumerationStateType();
Daniel Dunbara7566f12010-02-09 02:48:28 +00001444 llvm::Value *StatePtr = CreateMemTemp(StateTy, "state.ptr");
Anders Carlssonc0964b62010-05-22 17:35:42 +00001445 EmitNullInitialization(StatePtr, StateTy);
Mike Stump11289f42009-09-09 15:08:12 +00001446
Anders Carlsson75658592008-08-31 02:33:12 +00001447 // Number of elements in the items array.
Anders Carlsson3f35a262008-08-31 04:05:03 +00001448 static const unsigned NumItems = 16;
Mike Stump11289f42009-09-09 15:08:12 +00001449
John McCall1c926b72011-01-07 01:49:06 +00001450 // Fetch the countByEnumeratingWithState:objects:count: selector.
Benjamin Kramer9e649c32010-03-30 11:36:44 +00001451 IdentifierInfo *II[] = {
1452 &CGM.getContext().Idents.get("countByEnumeratingWithState"),
1453 &CGM.getContext().Idents.get("objects"),
1454 &CGM.getContext().Idents.get("count")
1455 };
1456 Selector FastEnumSel =
1457 CGM.getContext().Selectors.getSelector(llvm::array_lengthof(II), &II[0]);
Anders Carlsson75658592008-08-31 02:33:12 +00001458
1459 QualType ItemsTy =
1460 getContext().getConstantArrayType(getContext().getObjCIdType(),
Mike Stump11289f42009-09-09 15:08:12 +00001461 llvm::APInt(32, NumItems),
Anders Carlsson75658592008-08-31 02:33:12 +00001462 ArrayType::Normal, 0);
Daniel Dunbara7566f12010-02-09 02:48:28 +00001463 llvm::Value *ItemsPtr = CreateMemTemp(ItemsTy, "items.ptr");
Mike Stump11289f42009-09-09 15:08:12 +00001464
John McCall53848232011-07-27 01:07:15 +00001465 // Emit the collection pointer. In ARC, we do a retain.
1466 llvm::Value *Collection;
David Blaikiebbafb8a2012-03-11 07:00:24 +00001467 if (getLangOpts().ObjCAutoRefCount) {
John McCall53848232011-07-27 01:07:15 +00001468 Collection = EmitARCRetainScalarExpr(S.getCollection());
1469
1470 // Enter a cleanup to do the release.
1471 EmitObjCConsumeObject(S.getCollection()->getType(), Collection);
1472 } else {
1473 Collection = EmitScalarExpr(S.getCollection());
1474 }
Mike Stump11289f42009-09-09 15:08:12 +00001475
John McCall91e82dd2011-08-05 00:14:38 +00001476 // The 'continue' label needs to appear within the cleanup for the
1477 // collection object.
1478 JumpDest AfterBody = getJumpDestInCurrentScope("forcoll.next");
1479
John McCall1c926b72011-01-07 01:49:06 +00001480 // Send it our message:
Anders Carlsson75658592008-08-31 02:33:12 +00001481 CallArgList Args;
John McCall1c926b72011-01-07 01:49:06 +00001482
1483 // The first argument is a temporary of the enumeration-state type.
Eli Friedman43dca6a2011-05-02 17:57:46 +00001484 Args.add(RValue::get(StatePtr), getContext().getPointerType(StateTy));
Mike Stump11289f42009-09-09 15:08:12 +00001485
John McCall1c926b72011-01-07 01:49:06 +00001486 // The second argument is a temporary array with space for NumItems
1487 // pointers. We'll actually be loading elements from the array
1488 // pointer written into the control state; this buffer is so that
1489 // collections that *aren't* backed by arrays can still queue up
1490 // batches of elements.
Eli Friedman43dca6a2011-05-02 17:57:46 +00001491 Args.add(RValue::get(ItemsPtr), getContext().getPointerType(ItemsTy));
Mike Stump11289f42009-09-09 15:08:12 +00001492
John McCall1c926b72011-01-07 01:49:06 +00001493 // The third argument is the capacity of that temporary array.
Chris Lattner2192fe52011-07-18 04:24:23 +00001494 llvm::Type *UnsignedLongLTy = ConvertType(getContext().UnsignedLongTy);
Owen Andersonb7a2fe62009-07-24 23:12:58 +00001495 llvm::Constant *Count = llvm::ConstantInt::get(UnsignedLongLTy, NumItems);
Eli Friedman43dca6a2011-05-02 17:57:46 +00001496 Args.add(RValue::get(Count), getContext().UnsignedLongTy);
Mike Stump11289f42009-09-09 15:08:12 +00001497
John McCall1c926b72011-01-07 01:49:06 +00001498 // Start the enumeration.
Mike Stump11289f42009-09-09 15:08:12 +00001499 RValue CountRV =
John McCall78a15112010-05-22 01:48:05 +00001500 CGM.getObjCRuntime().GenerateMessageSend(*this, ReturnValueSlot(),
Anders Carlsson75658592008-08-31 02:33:12 +00001501 getContext().UnsignedLongTy,
1502 FastEnumSel,
David Chisnall01aa4672010-04-28 19:33:36 +00001503 Collection, Args);
Anders Carlsson75658592008-08-31 02:33:12 +00001504
John McCall1c926b72011-01-07 01:49:06 +00001505 // The initial number of objects that were returned in the buffer.
1506 llvm::Value *initialBufferLimit = CountRV.getScalarVal();
Mike Stump11289f42009-09-09 15:08:12 +00001507
John McCall1c926b72011-01-07 01:49:06 +00001508 llvm::BasicBlock *EmptyBB = createBasicBlock("forcoll.empty");
1509 llvm::BasicBlock *LoopInitBB = createBasicBlock("forcoll.loopinit");
Mike Stump11289f42009-09-09 15:08:12 +00001510
John McCall1c926b72011-01-07 01:49:06 +00001511 llvm::Value *zero = llvm::Constant::getNullValue(UnsignedLongLTy);
Anders Carlsson75658592008-08-31 02:33:12 +00001512
John McCall1c926b72011-01-07 01:49:06 +00001513 // If the limit pointer was zero to begin with, the collection is
1514 // empty; skip all this.
1515 Builder.CreateCondBr(Builder.CreateICmpEQ(initialBufferLimit, zero, "iszero"),
1516 EmptyBB, LoopInitBB);
Anders Carlsson75658592008-08-31 02:33:12 +00001517
John McCall1c926b72011-01-07 01:49:06 +00001518 // Otherwise, initialize the loop.
1519 EmitBlock(LoopInitBB);
Mike Stump11289f42009-09-09 15:08:12 +00001520
John McCall1c926b72011-01-07 01:49:06 +00001521 // Save the initial mutations value. This is the value at an
1522 // address that was written into the state object by
1523 // countByEnumeratingWithState:objects:count:.
Mike Stump11289f42009-09-09 15:08:12 +00001524 llvm::Value *StateMutationsPtrPtr =
Anders Carlsson3f35a262008-08-31 04:05:03 +00001525 Builder.CreateStructGEP(StatePtr, 2, "mutationsptr.ptr");
Mike Stump11289f42009-09-09 15:08:12 +00001526 llvm::Value *StateMutationsPtr = Builder.CreateLoad(StateMutationsPtrPtr,
Anders Carlsson3f35a262008-08-31 04:05:03 +00001527 "mutationsptr");
Mike Stump11289f42009-09-09 15:08:12 +00001528
John McCall1c926b72011-01-07 01:49:06 +00001529 llvm::Value *initialMutations =
1530 Builder.CreateLoad(StateMutationsPtr, "forcoll.initial-mutations");
Mike Stump11289f42009-09-09 15:08:12 +00001531
John McCall1c926b72011-01-07 01:49:06 +00001532 // Start looping. This is the point we return to whenever we have a
1533 // fresh, non-empty batch of objects.
1534 llvm::BasicBlock *LoopBodyBB = createBasicBlock("forcoll.loopbody");
1535 EmitBlock(LoopBodyBB);
Mike Stump11289f42009-09-09 15:08:12 +00001536
John McCall1c926b72011-01-07 01:49:06 +00001537 // The current index into the buffer.
Jay Foad20c0f022011-03-30 11:28:58 +00001538 llvm::PHINode *index = Builder.CreatePHI(UnsignedLongLTy, 3, "forcoll.index");
John McCall1c926b72011-01-07 01:49:06 +00001539 index->addIncoming(zero, LoopInitBB);
Anders Carlsson75658592008-08-31 02:33:12 +00001540
John McCall1c926b72011-01-07 01:49:06 +00001541 // The current buffer size.
Jay Foad20c0f022011-03-30 11:28:58 +00001542 llvm::PHINode *count = Builder.CreatePHI(UnsignedLongLTy, 3, "forcoll.count");
John McCall1c926b72011-01-07 01:49:06 +00001543 count->addIncoming(initialBufferLimit, LoopInitBB);
Mike Stump11289f42009-09-09 15:08:12 +00001544
Bob Wilson8ab16912014-02-24 01:13:09 +00001545 RegionCounter Cnt = getPGORegionCounter(&S);
1546 Cnt.beginRegion(Builder);
1547
John McCall1c926b72011-01-07 01:49:06 +00001548 // Check whether the mutations value has changed from where it was
1549 // at start. StateMutationsPtr should actually be invariant between
1550 // refreshes.
Anders Carlsson3f35a262008-08-31 04:05:03 +00001551 StateMutationsPtr = Builder.CreateLoad(StateMutationsPtrPtr, "mutationsptr");
John McCall1c926b72011-01-07 01:49:06 +00001552 llvm::Value *currentMutations
1553 = Builder.CreateLoad(StateMutationsPtr, "statemutations");
Anders Carlsson3f35a262008-08-31 04:05:03 +00001554
John McCall1c926b72011-01-07 01:49:06 +00001555 llvm::BasicBlock *WasMutatedBB = createBasicBlock("forcoll.mutated");
Dan Gohman6ca99822011-03-02 22:39:34 +00001556 llvm::BasicBlock *WasNotMutatedBB = createBasicBlock("forcoll.notmutated");
Mike Stump11289f42009-09-09 15:08:12 +00001557
John McCall1c926b72011-01-07 01:49:06 +00001558 Builder.CreateCondBr(Builder.CreateICmpEQ(currentMutations, initialMutations),
1559 WasNotMutatedBB, WasMutatedBB);
Mike Stump11289f42009-09-09 15:08:12 +00001560
John McCall1c926b72011-01-07 01:49:06 +00001561 // If so, call the enumeration-mutation function.
1562 EmitBlock(WasMutatedBB);
Anders Carlsson3f35a262008-08-31 04:05:03 +00001563 llvm::Value *V =
Mike Stump11289f42009-09-09 15:08:12 +00001564 Builder.CreateBitCast(Collection,
Benjamin Kramer76399eb2011-09-27 21:06:10 +00001565 ConvertType(getContext().getObjCIdType()));
Daniel Dunbar84388bf2009-02-03 23:55:40 +00001566 CallArgList Args2;
Eli Friedman43dca6a2011-05-02 17:57:46 +00001567 Args2.add(RValue::get(V), getContext().getObjCIdType());
Mike Stump18bb9282009-05-16 07:57:57 +00001568 // FIXME: We shouldn't need to get the function info here, the runtime already
1569 // should have computed it to build the function.
John McCall8dda7b22012-07-07 06:41:13 +00001570 EmitCall(CGM.getTypes().arrangeFreeFunctionCall(getContext().VoidTy, Args2,
1571 FunctionType::ExtInfo(),
1572 RequiredArgs::All),
Anders Carlsson61a401c2009-12-24 19:25:24 +00001573 EnumerationMutationFn, ReturnValueSlot(), Args2);
Mike Stump11289f42009-09-09 15:08:12 +00001574
John McCall1c926b72011-01-07 01:49:06 +00001575 // Otherwise, or if the mutation function returns, just continue.
1576 EmitBlock(WasNotMutatedBB);
Mike Stump11289f42009-09-09 15:08:12 +00001577
John McCall1c926b72011-01-07 01:49:06 +00001578 // Initialize the element variable.
1579 RunCleanupsScope elementVariableScope(*this);
John McCall9e2e22f2011-02-22 07:16:58 +00001580 bool elementIsVariable;
John McCall1c926b72011-01-07 01:49:06 +00001581 LValue elementLValue;
1582 QualType elementType;
1583 if (const DeclStmt *SD = dyn_cast<DeclStmt>(S.getElement())) {
John McCall9e2e22f2011-02-22 07:16:58 +00001584 // Initialize the variable, in case it's a __block variable or something.
1585 EmitAutoVarInit(variable);
John McCall1c926b72011-01-07 01:49:06 +00001586
John McCall9e2e22f2011-02-22 07:16:58 +00001587 const VarDecl* D = cast<VarDecl>(SD->getSingleDecl());
John McCall113bee02012-03-10 09:33:50 +00001588 DeclRefExpr tempDRE(const_cast<VarDecl*>(D), false, D->getType(),
John McCall1c926b72011-01-07 01:49:06 +00001589 VK_LValue, SourceLocation());
1590 elementLValue = EmitLValue(&tempDRE);
1591 elementType = D->getType();
John McCall9e2e22f2011-02-22 07:16:58 +00001592 elementIsVariable = true;
John McCalld4631322011-06-17 06:42:21 +00001593
1594 if (D->isARCPseudoStrong())
1595 elementLValue.getQuals().setObjCLifetime(Qualifiers::OCL_ExplicitNone);
John McCall1c926b72011-01-07 01:49:06 +00001596 } else {
1597 elementLValue = LValue(); // suppress warning
1598 elementType = cast<Expr>(S.getElement())->getType();
John McCall9e2e22f2011-02-22 07:16:58 +00001599 elementIsVariable = false;
John McCall1c926b72011-01-07 01:49:06 +00001600 }
Chris Lattner2192fe52011-07-18 04:24:23 +00001601 llvm::Type *convertedElementType = ConvertType(elementType);
John McCall1c926b72011-01-07 01:49:06 +00001602
1603 // Fetch the buffer out of the enumeration state.
1604 // TODO: this pointer should actually be invariant between
1605 // refreshes, which would help us do certain loop optimizations.
Mike Stump11289f42009-09-09 15:08:12 +00001606 llvm::Value *StateItemsPtr =
Anders Carlsson75658592008-08-31 02:33:12 +00001607 Builder.CreateStructGEP(StatePtr, 1, "stateitems.ptr");
John McCall1c926b72011-01-07 01:49:06 +00001608 llvm::Value *EnumStateItems =
1609 Builder.CreateLoad(StateItemsPtr, "stateitems");
Anders Carlsson75658592008-08-31 02:33:12 +00001610
John McCall1c926b72011-01-07 01:49:06 +00001611 // Fetch the value at the current index from the buffer.
Mike Stump11289f42009-09-09 15:08:12 +00001612 llvm::Value *CurrentItemPtr =
John McCall1c926b72011-01-07 01:49:06 +00001613 Builder.CreateGEP(EnumStateItems, index, "currentitem.ptr");
1614 llvm::Value *CurrentItem = Builder.CreateLoad(CurrentItemPtr);
Mike Stump11289f42009-09-09 15:08:12 +00001615
John McCall1c926b72011-01-07 01:49:06 +00001616 // Cast that value to the right type.
1617 CurrentItem = Builder.CreateBitCast(CurrentItem, convertedElementType,
1618 "currentitem");
Mike Stump11289f42009-09-09 15:08:12 +00001619
John McCall1c926b72011-01-07 01:49:06 +00001620 // Make sure we have an l-value. Yes, this gets evaluated every
1621 // time through the loop.
John McCalld4631322011-06-17 06:42:21 +00001622 if (!elementIsVariable) {
John McCall1c926b72011-01-07 01:49:06 +00001623 elementLValue = EmitLValue(cast<Expr>(S.getElement()));
John McCall55e1fbc2011-06-25 02:11:03 +00001624 EmitStoreThroughLValue(RValue::get(CurrentItem), elementLValue);
John McCalld4631322011-06-17 06:42:21 +00001625 } else {
1626 EmitScalarInit(CurrentItem, elementLValue);
1627 }
Mike Stump11289f42009-09-09 15:08:12 +00001628
John McCall9e2e22f2011-02-22 07:16:58 +00001629 // If we do have an element variable, this assignment is the end of
1630 // its initialization.
1631 if (elementIsVariable)
1632 EmitAutoVarCleanups(variable);
1633
John McCall1c926b72011-01-07 01:49:06 +00001634 // Perform the loop body, setting up break and continue labels.
Bob Wilsonbf854f02014-02-17 19:21:09 +00001635 BreakContinueStack.push_back(BreakContinue(LoopEnd, AfterBody));
John McCall1c926b72011-01-07 01:49:06 +00001636 {
1637 RunCleanupsScope Scope(*this);
1638 EmitStmt(S.getBody());
1639 }
Anders Carlsson75658592008-08-31 02:33:12 +00001640 BreakContinueStack.pop_back();
Mike Stump11289f42009-09-09 15:08:12 +00001641
John McCall1c926b72011-01-07 01:49:06 +00001642 // Destroy the element variable now.
1643 elementVariableScope.ForceCleanup();
1644
1645 // Check whether there are more elements.
John McCallad5d61e2010-07-23 21:56:41 +00001646 EmitBlock(AfterBody.getBlock());
Mike Stump11289f42009-09-09 15:08:12 +00001647
John McCall1c926b72011-01-07 01:49:06 +00001648 llvm::BasicBlock *FetchMoreBB = createBasicBlock("forcoll.refetch");
Fariborz Jahanian6e7ecc82009-01-06 18:56:31 +00001649
John McCall1c926b72011-01-07 01:49:06 +00001650 // First we check in the local buffer.
1651 llvm::Value *indexPlusOne
1652 = Builder.CreateAdd(index, llvm::ConstantInt::get(UnsignedLongLTy, 1));
Anders Carlsson75658592008-08-31 02:33:12 +00001653
Justin Bogneref512b92014-01-06 22:27:43 +00001654 // TODO: We should probably model this as a "continue" for PGO
John McCall1c926b72011-01-07 01:49:06 +00001655 // If we haven't overrun the buffer yet, we can continue.
1656 Builder.CreateCondBr(Builder.CreateICmpULT(indexPlusOne, count),
1657 LoopBodyBB, FetchMoreBB);
1658
1659 index->addIncoming(indexPlusOne, AfterBody.getBlock());
1660 count->addIncoming(count, AfterBody.getBlock());
1661
1662 // Otherwise, we have to fetch more elements.
1663 EmitBlock(FetchMoreBB);
Mike Stump11289f42009-09-09 15:08:12 +00001664
1665 CountRV =
John McCall78a15112010-05-22 01:48:05 +00001666 CGM.getObjCRuntime().GenerateMessageSend(*this, ReturnValueSlot(),
Anders Carlsson75658592008-08-31 02:33:12 +00001667 getContext().UnsignedLongTy,
Mike Stump11289f42009-09-09 15:08:12 +00001668 FastEnumSel,
David Chisnall01aa4672010-04-28 19:33:36 +00001669 Collection, Args);
Mike Stump11289f42009-09-09 15:08:12 +00001670
John McCall1c926b72011-01-07 01:49:06 +00001671 // If we got a zero count, we're done.
1672 llvm::Value *refetchCount = CountRV.getScalarVal();
1673
1674 // (note that the message send might split FetchMoreBB)
1675 index->addIncoming(zero, Builder.GetInsertBlock());
1676 count->addIncoming(refetchCount, Builder.GetInsertBlock());
1677
Justin Bogneref512b92014-01-06 22:27:43 +00001678 // TODO: We should be applying PGO weights here, but this needs to handle the
1679 // branch before FetchMoreBB or we risk getting the numbers wrong.
John McCall1c926b72011-01-07 01:49:06 +00001680 Builder.CreateCondBr(Builder.CreateICmpEQ(refetchCount, zero),
1681 EmptyBB, LoopBodyBB);
Mike Stump11289f42009-09-09 15:08:12 +00001682
Anders Carlsson75658592008-08-31 02:33:12 +00001683 // No more elements.
John McCall1c926b72011-01-07 01:49:06 +00001684 EmitBlock(EmptyBB);
Anders Carlsson75658592008-08-31 02:33:12 +00001685
John McCall9e2e22f2011-02-22 07:16:58 +00001686 if (!elementIsVariable) {
Anders Carlsson75658592008-08-31 02:33:12 +00001687 // If the element was not a declaration, set it to be null.
1688
John McCall1c926b72011-01-07 01:49:06 +00001689 llvm::Value *null = llvm::Constant::getNullValue(convertedElementType);
1690 elementLValue = EmitLValue(cast<Expr>(S.getElement()));
John McCall55e1fbc2011-06-25 02:11:03 +00001691 EmitStoreThroughLValue(RValue::get(null), elementLValue);
Anders Carlsson75658592008-08-31 02:33:12 +00001692 }
1693
Eric Christopher7cdf9482011-10-13 21:45:18 +00001694 if (DI)
1695 DI->EmitLexicalBlockEnd(Builder, S.getSourceRange().getEnd());
Devang Pateld2d66652011-01-19 01:36:36 +00001696
John McCall53848232011-07-27 01:07:15 +00001697 // Leave the cleanup we entered in ARC.
David Blaikiebbafb8a2012-03-11 07:00:24 +00001698 if (getLangOpts().ObjCAutoRefCount)
John McCall53848232011-07-27 01:07:15 +00001699 PopCleanupBlock();
1700
John McCallad5d61e2010-07-23 21:56:41 +00001701 EmitBlock(LoopEnd.getBlock());
Justin Bogneref512b92014-01-06 22:27:43 +00001702 // TODO: Once we calculate PGO weights above, set the region count here
Anders Carlsson2e744e82008-08-30 19:51:14 +00001703}
1704
Mike Stump11289f42009-09-09 15:08:12 +00001705void CodeGenFunction::EmitObjCAtTryStmt(const ObjCAtTryStmt &S) {
John McCallbd309292010-07-06 01:34:17 +00001706 CGM.getObjCRuntime().EmitTryStmt(*this, S);
Anders Carlsson1963b0c2008-09-09 10:04:29 +00001707}
1708
Mike Stump11289f42009-09-09 15:08:12 +00001709void CodeGenFunction::EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S) {
Anders Carlsson1963b0c2008-09-09 10:04:29 +00001710 CGM.getObjCRuntime().EmitThrowStmt(*this, S);
1711}
1712
Chris Lattnere132e242008-11-15 21:26:17 +00001713void CodeGenFunction::EmitObjCAtSynchronizedStmt(
Mike Stump11289f42009-09-09 15:08:12 +00001714 const ObjCAtSynchronizedStmt &S) {
John McCallbd309292010-07-06 01:34:17 +00001715 CGM.getObjCRuntime().EmitSynchronizedStmt(*this, S);
Chris Lattnere132e242008-11-15 21:26:17 +00001716}
1717
John McCall2d637d22011-09-10 06:18:15 +00001718/// Produce the code for a CK_ARCProduceObject. Just does a
John McCall31168b02011-06-15 23:02:42 +00001719/// primitive retain.
1720llvm::Value *CodeGenFunction::EmitObjCProduceObject(QualType type,
1721 llvm::Value *value) {
1722 return EmitARCRetain(type, value);
1723}
1724
1725namespace {
1726 struct CallObjCRelease : EHScopeStack::Cleanup {
John McCall9c8e1c92011-08-03 22:24:24 +00001727 CallObjCRelease(llvm::Value *object) : object(object) {}
1728 llvm::Value *object;
John McCall31168b02011-06-15 23:02:42 +00001729
John McCall30317fd2011-07-12 20:27:29 +00001730 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCallcdda29c2013-03-13 03:10:54 +00001731 // Releases at the end of the full-expression are imprecise.
1732 CGF.EmitARCRelease(object, ARCImpreciseLifetime);
John McCall31168b02011-06-15 23:02:42 +00001733 }
1734 };
1735}
1736
John McCall2d637d22011-09-10 06:18:15 +00001737/// Produce the code for a CK_ARCConsumeObject. Does a primitive
John McCall31168b02011-06-15 23:02:42 +00001738/// release at the end of the full-expression.
1739llvm::Value *CodeGenFunction::EmitObjCConsumeObject(QualType type,
1740 llvm::Value *object) {
1741 // If we're in a conditional branch, we need to make the cleanup
John McCall9c8e1c92011-08-03 22:24:24 +00001742 // conditional.
1743 pushFullExprCleanup<CallObjCRelease>(getARCCleanupKind(), object);
John McCall31168b02011-06-15 23:02:42 +00001744 return object;
1745}
1746
1747llvm::Value *CodeGenFunction::EmitObjCExtendObjectLifetime(QualType type,
1748 llvm::Value *value) {
1749 return EmitARCRetainAutorelease(type, value);
1750}
1751
John McCalleff18842013-03-23 02:35:54 +00001752/// Given a number of pointers, inform the optimizer that they're
1753/// being intrinsically used up until this point in the program.
1754void CodeGenFunction::EmitARCIntrinsicUse(ArrayRef<llvm::Value*> values) {
1755 llvm::Constant *&fn = CGM.getARCEntrypoints().clang_arc_use;
1756 if (!fn) {
1757 llvm::FunctionType *fnType =
1758 llvm::FunctionType::get(CGM.VoidTy, ArrayRef<llvm::Type*>(), true);
1759 fn = CGM.CreateRuntimeFunction(fnType, "clang.arc.use");
1760 }
1761
1762 // This isn't really a "runtime" function, but as an intrinsic it
1763 // doesn't really matter as long as we align things up.
1764 EmitNounwindRuntimeCall(fn, values);
1765}
1766
John McCall31168b02011-06-15 23:02:42 +00001767
1768static llvm::Constant *createARCRuntimeFunction(CodeGenModule &CGM,
Chris Lattner2192fe52011-07-18 04:24:23 +00001769 llvm::FunctionType *type,
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001770 StringRef fnName) {
John McCall31168b02011-06-15 23:02:42 +00001771 llvm::Constant *fn = CGM.CreateRuntimeFunction(type, fnName);
1772
Michael Gottesmancf50e6d2013-02-02 00:57:44 +00001773 if (llvm::Function *f = dyn_cast<llvm::Function>(fn)) {
Michael Gottesmanbe9614c2013-02-02 01:05:06 +00001774 // If the target runtime doesn't naturally support ARC, emit weak
1775 // references to the runtime support library. We don't really
1776 // permit this to fail, but we need a particular relocation style.
Michael Gottesmancf50e6d2013-02-02 00:57:44 +00001777 if (!CGM.getLangOpts().ObjCRuntime.hasNativeARC()) {
John McCall31168b02011-06-15 23:02:42 +00001778 f->setLinkage(llvm::Function::ExternalWeakLinkage);
Michael Gottesmancf50e6d2013-02-02 00:57:44 +00001779 } else if (fnName == "objc_retain" || fnName == "objc_release") {
1780 // If we have Native ARC, set nonlazybind attribute for these APIs for
1781 // performance.
Bill Wendling207f0532012-12-20 19:27:06 +00001782 f->addFnAttr(llvm::Attribute::NonLazyBind);
Michael Gottesmanb46072d2013-02-02 01:03:01 +00001783 }
Michael Gottesmancf50e6d2013-02-02 00:57:44 +00001784 }
John McCall31168b02011-06-15 23:02:42 +00001785
1786 return fn;
1787}
1788
1789/// Perform an operation having the signature
1790/// i8* (i8*)
1791/// where a null input causes a no-op and returns null.
1792static llvm::Value *emitARCValueOperation(CodeGenFunction &CGF,
1793 llvm::Value *value,
1794 llvm::Constant *&fn,
Chad Rosier13799b32012-12-12 17:52:21 +00001795 StringRef fnName,
1796 bool isTailCall = false) {
John McCall31168b02011-06-15 23:02:42 +00001797 if (isa<llvm::ConstantPointerNull>(value)) return value;
1798
1799 if (!fn) {
Chris Lattner2192fe52011-07-18 04:24:23 +00001800 llvm::FunctionType *fnType =
Benjamin Kramer95e19362013-03-07 21:18:31 +00001801 llvm::FunctionType::get(CGF.Int8PtrTy, CGF.Int8PtrTy, false);
John McCall31168b02011-06-15 23:02:42 +00001802 fn = createARCRuntimeFunction(CGF.CGM, fnType, fnName);
1803 }
1804
1805 // Cast the argument to 'id'.
Chris Lattner2192fe52011-07-18 04:24:23 +00001806 llvm::Type *origType = value->getType();
John McCall31168b02011-06-15 23:02:42 +00001807 value = CGF.Builder.CreateBitCast(value, CGF.Int8PtrTy);
1808
1809 // Call the function.
John McCall882987f2013-02-28 19:01:20 +00001810 llvm::CallInst *call = CGF.EmitNounwindRuntimeCall(fn, value);
Chad Rosier13799b32012-12-12 17:52:21 +00001811 if (isTailCall)
1812 call->setTailCall();
John McCall31168b02011-06-15 23:02:42 +00001813
1814 // Cast the result back to the original type.
1815 return CGF.Builder.CreateBitCast(call, origType);
1816}
1817
1818/// Perform an operation having the following signature:
1819/// i8* (i8**)
1820static llvm::Value *emitARCLoadOperation(CodeGenFunction &CGF,
1821 llvm::Value *addr,
1822 llvm::Constant *&fn,
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001823 StringRef fnName) {
John McCall31168b02011-06-15 23:02:42 +00001824 if (!fn) {
Chris Lattner2192fe52011-07-18 04:24:23 +00001825 llvm::FunctionType *fnType =
Benjamin Kramer95e19362013-03-07 21:18:31 +00001826 llvm::FunctionType::get(CGF.Int8PtrTy, CGF.Int8PtrPtrTy, false);
John McCall31168b02011-06-15 23:02:42 +00001827 fn = createARCRuntimeFunction(CGF.CGM, fnType, fnName);
1828 }
1829
1830 // Cast the argument to 'id*'.
Chris Lattner2192fe52011-07-18 04:24:23 +00001831 llvm::Type *origType = addr->getType();
John McCall31168b02011-06-15 23:02:42 +00001832 addr = CGF.Builder.CreateBitCast(addr, CGF.Int8PtrPtrTy);
1833
1834 // Call the function.
John McCall882987f2013-02-28 19:01:20 +00001835 llvm::Value *result = CGF.EmitNounwindRuntimeCall(fn, addr);
John McCall31168b02011-06-15 23:02:42 +00001836
1837 // Cast the result back to a dereference of the original type.
John McCall31168b02011-06-15 23:02:42 +00001838 if (origType != CGF.Int8PtrPtrTy)
1839 result = CGF.Builder.CreateBitCast(result,
1840 cast<llvm::PointerType>(origType)->getElementType());
1841
1842 return result;
1843}
1844
1845/// Perform an operation having the following signature:
1846/// i8* (i8**, i8*)
1847static llvm::Value *emitARCStoreOperation(CodeGenFunction &CGF,
1848 llvm::Value *addr,
1849 llvm::Value *value,
1850 llvm::Constant *&fn,
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001851 StringRef fnName,
John McCall31168b02011-06-15 23:02:42 +00001852 bool ignored) {
1853 assert(cast<llvm::PointerType>(addr->getType())->getElementType()
1854 == value->getType());
1855
1856 if (!fn) {
Benjamin Kramer22d24c22011-10-15 12:20:02 +00001857 llvm::Type *argTypes[] = { CGF.Int8PtrPtrTy, CGF.Int8PtrTy };
John McCall31168b02011-06-15 23:02:42 +00001858
Chris Lattner2192fe52011-07-18 04:24:23 +00001859 llvm::FunctionType *fnType
John McCall31168b02011-06-15 23:02:42 +00001860 = llvm::FunctionType::get(CGF.Int8PtrTy, argTypes, false);
1861 fn = createARCRuntimeFunction(CGF.CGM, fnType, fnName);
1862 }
1863
Chris Lattner2192fe52011-07-18 04:24:23 +00001864 llvm::Type *origType = value->getType();
John McCall31168b02011-06-15 23:02:42 +00001865
John McCall882987f2013-02-28 19:01:20 +00001866 llvm::Value *args[] = {
1867 CGF.Builder.CreateBitCast(addr, CGF.Int8PtrPtrTy),
1868 CGF.Builder.CreateBitCast(value, CGF.Int8PtrTy)
1869 };
1870 llvm::CallInst *result = CGF.EmitNounwindRuntimeCall(fn, args);
John McCall31168b02011-06-15 23:02:42 +00001871
1872 if (ignored) return 0;
1873
1874 return CGF.Builder.CreateBitCast(result, origType);
1875}
1876
1877/// Perform an operation having the following signature:
1878/// void (i8**, i8**)
1879static void emitARCCopyOperation(CodeGenFunction &CGF,
1880 llvm::Value *dst,
1881 llvm::Value *src,
1882 llvm::Constant *&fn,
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001883 StringRef fnName) {
John McCall31168b02011-06-15 23:02:42 +00001884 assert(dst->getType() == src->getType());
1885
1886 if (!fn) {
Benjamin Kramer95e19362013-03-07 21:18:31 +00001887 llvm::Type *argTypes[] = { CGF.Int8PtrPtrTy, CGF.Int8PtrPtrTy };
1888
Chris Lattner2192fe52011-07-18 04:24:23 +00001889 llvm::FunctionType *fnType
John McCall31168b02011-06-15 23:02:42 +00001890 = llvm::FunctionType::get(CGF.Builder.getVoidTy(), argTypes, false);
1891 fn = createARCRuntimeFunction(CGF.CGM, fnType, fnName);
1892 }
1893
John McCall882987f2013-02-28 19:01:20 +00001894 llvm::Value *args[] = {
1895 CGF.Builder.CreateBitCast(dst, CGF.Int8PtrPtrTy),
1896 CGF.Builder.CreateBitCast(src, CGF.Int8PtrPtrTy)
1897 };
1898 CGF.EmitNounwindRuntimeCall(fn, args);
John McCall31168b02011-06-15 23:02:42 +00001899}
1900
1901/// Produce the code to do a retain. Based on the type, calls one of:
James Dennett14c41ea2012-06-22 05:41:30 +00001902/// call i8* \@objc_retain(i8* %value)
1903/// call i8* \@objc_retainBlock(i8* %value)
John McCall31168b02011-06-15 23:02:42 +00001904llvm::Value *CodeGenFunction::EmitARCRetain(QualType type, llvm::Value *value) {
1905 if (type->isBlockPointerType())
John McCallff613032011-10-04 06:23:45 +00001906 return EmitARCRetainBlock(value, /*mandatory*/ false);
John McCall31168b02011-06-15 23:02:42 +00001907 else
1908 return EmitARCRetainNonBlock(value);
1909}
1910
1911/// Retain the given object, with normal retain semantics.
James Dennett14c41ea2012-06-22 05:41:30 +00001912/// call i8* \@objc_retain(i8* %value)
John McCall31168b02011-06-15 23:02:42 +00001913llvm::Value *CodeGenFunction::EmitARCRetainNonBlock(llvm::Value *value) {
1914 return emitARCValueOperation(*this, value,
1915 CGM.getARCEntrypoints().objc_retain,
1916 "objc_retain");
1917}
1918
1919/// Retain the given block, with _Block_copy semantics.
James Dennett14c41ea2012-06-22 05:41:30 +00001920/// call i8* \@objc_retainBlock(i8* %value)
John McCallff613032011-10-04 06:23:45 +00001921///
1922/// \param mandatory - If false, emit the call with metadata
1923/// indicating that it's okay for the optimizer to eliminate this call
1924/// if it can prove that the block never escapes except down the stack.
1925llvm::Value *CodeGenFunction::EmitARCRetainBlock(llvm::Value *value,
1926 bool mandatory) {
1927 llvm::Value *result
1928 = emitARCValueOperation(*this, value,
1929 CGM.getARCEntrypoints().objc_retainBlock,
1930 "objc_retainBlock");
1931
1932 // If the copy isn't mandatory, add !clang.arc.copy_on_escape to
1933 // tell the optimizer that it doesn't need to do this copy if the
1934 // block doesn't escape, where being passed as an argument doesn't
1935 // count as escaping.
1936 if (!mandatory && isa<llvm::Instruction>(result)) {
1937 llvm::CallInst *call
1938 = cast<llvm::CallInst>(result->stripPointerCasts());
1939 assert(call->getCalledValue() == CGM.getARCEntrypoints().objc_retainBlock);
1940
1941 SmallVector<llvm::Value*,1> args;
1942 call->setMetadata("clang.arc.copy_on_escape",
1943 llvm::MDNode::get(Builder.getContext(), args));
1944 }
1945
1946 return result;
John McCall31168b02011-06-15 23:02:42 +00001947}
1948
1949/// Retain the given object which is the result of a function call.
James Dennett14c41ea2012-06-22 05:41:30 +00001950/// call i8* \@objc_retainAutoreleasedReturnValue(i8* %value)
John McCall31168b02011-06-15 23:02:42 +00001951///
1952/// Yes, this function name is one character away from a different
1953/// call with completely different semantics.
1954llvm::Value *
1955CodeGenFunction::EmitARCRetainAutoreleasedReturnValue(llvm::Value *value) {
1956 // Fetch the void(void) inline asm which marks that we're going to
1957 // retain the autoreleased return value.
1958 llvm::InlineAsm *&marker
1959 = CGM.getARCEntrypoints().retainAutoreleasedReturnValueMarker;
1960 if (!marker) {
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001961 StringRef assembly
John McCall31168b02011-06-15 23:02:42 +00001962 = CGM.getTargetCodeGenInfo()
1963 .getARCRetainAutoreleasedReturnValueMarker();
1964
1965 // If we have an empty assembly string, there's nothing to do.
1966 if (assembly.empty()) {
1967
1968 // Otherwise, at -O0, build an inline asm that we're going to call
1969 // in a moment.
1970 } else if (CGM.getCodeGenOpts().OptimizationLevel == 0) {
1971 llvm::FunctionType *type =
Chris Lattnerece04092012-02-07 00:39:47 +00001972 llvm::FunctionType::get(VoidTy, /*variadic*/false);
John McCall31168b02011-06-15 23:02:42 +00001973
1974 marker = llvm::InlineAsm::get(type, assembly, "", /*sideeffects*/ true);
1975
1976 // If we're at -O1 and above, we don't want to litter the code
1977 // with this marker yet, so leave a breadcrumb for the ARC
1978 // optimizer to pick up.
1979 } else {
1980 llvm::NamedMDNode *metadata =
1981 CGM.getModule().getOrInsertNamedMetadata(
1982 "clang.arc.retainAutoreleasedReturnValueMarker");
1983 assert(metadata->getNumOperands() <= 1);
1984 if (metadata->getNumOperands() == 0) {
1985 llvm::Value *string = llvm::MDString::get(getLLVMContext(), assembly);
Jay Foad5709f7c2011-07-29 13:56:53 +00001986 metadata->addOperand(llvm::MDNode::get(getLLVMContext(), string));
John McCall31168b02011-06-15 23:02:42 +00001987 }
1988 }
1989 }
1990
1991 // Call the marker asm if we made one, which we do only at -O0.
1992 if (marker) Builder.CreateCall(marker);
1993
1994 return emitARCValueOperation(*this, value,
1995 CGM.getARCEntrypoints().objc_retainAutoreleasedReturnValue,
1996 "objc_retainAutoreleasedReturnValue");
1997}
1998
1999/// Release the given object.
James Dennett14c41ea2012-06-22 05:41:30 +00002000/// call void \@objc_release(i8* %value)
John McCallcdda29c2013-03-13 03:10:54 +00002001void CodeGenFunction::EmitARCRelease(llvm::Value *value,
2002 ARCPreciseLifetime_t precise) {
John McCall31168b02011-06-15 23:02:42 +00002003 if (isa<llvm::ConstantPointerNull>(value)) return;
2004
2005 llvm::Constant *&fn = CGM.getARCEntrypoints().objc_release;
2006 if (!fn) {
Chris Lattner2192fe52011-07-18 04:24:23 +00002007 llvm::FunctionType *fnType =
Benjamin Kramer95e19362013-03-07 21:18:31 +00002008 llvm::FunctionType::get(Builder.getVoidTy(), Int8PtrTy, false);
John McCall31168b02011-06-15 23:02:42 +00002009 fn = createARCRuntimeFunction(CGM, fnType, "objc_release");
2010 }
2011
2012 // Cast the argument to 'id'.
2013 value = Builder.CreateBitCast(value, Int8PtrTy);
2014
2015 // Call objc_release.
John McCall882987f2013-02-28 19:01:20 +00002016 llvm::CallInst *call = EmitNounwindRuntimeCall(fn, value);
John McCall31168b02011-06-15 23:02:42 +00002017
John McCallcdda29c2013-03-13 03:10:54 +00002018 if (precise == ARCImpreciseLifetime) {
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002019 SmallVector<llvm::Value*,1> args;
John McCall31168b02011-06-15 23:02:42 +00002020 call->setMetadata("clang.imprecise_release",
2021 llvm::MDNode::get(Builder.getContext(), args));
2022 }
2023}
2024
John McCalle68b8f42012-10-17 02:28:37 +00002025/// Destroy a __strong variable.
2026///
2027/// At -O0, emit a call to store 'null' into the address;
2028/// instrumenting tools prefer this because the address is exposed,
2029/// but it's relatively cumbersome to optimize.
2030///
2031/// At -O1 and above, just load and call objc_release.
2032///
2033/// call void \@objc_storeStrong(i8** %addr, i8* null)
John McCallcdda29c2013-03-13 03:10:54 +00002034void CodeGenFunction::EmitARCDestroyStrong(llvm::Value *addr,
2035 ARCPreciseLifetime_t precise) {
John McCalle68b8f42012-10-17 02:28:37 +00002036 if (CGM.getCodeGenOpts().OptimizationLevel == 0) {
2037 llvm::PointerType *addrTy = cast<llvm::PointerType>(addr->getType());
2038 llvm::Value *null = llvm::ConstantPointerNull::get(
2039 cast<llvm::PointerType>(addrTy->getElementType()));
2040 EmitARCStoreStrongCall(addr, null, /*ignored*/ true);
2041 return;
2042 }
2043
2044 llvm::Value *value = Builder.CreateLoad(addr);
2045 EmitARCRelease(value, precise);
2046}
2047
John McCall31168b02011-06-15 23:02:42 +00002048/// Store into a strong object. Always calls this:
James Dennett14c41ea2012-06-22 05:41:30 +00002049/// call void \@objc_storeStrong(i8** %addr, i8* %value)
John McCall31168b02011-06-15 23:02:42 +00002050llvm::Value *CodeGenFunction::EmitARCStoreStrongCall(llvm::Value *addr,
2051 llvm::Value *value,
2052 bool ignored) {
2053 assert(cast<llvm::PointerType>(addr->getType())->getElementType()
2054 == value->getType());
2055
2056 llvm::Constant *&fn = CGM.getARCEntrypoints().objc_storeStrong;
2057 if (!fn) {
Chris Lattnera5f58b02011-07-09 17:41:47 +00002058 llvm::Type *argTypes[] = { Int8PtrPtrTy, Int8PtrTy };
Chris Lattner2192fe52011-07-18 04:24:23 +00002059 llvm::FunctionType *fnType
John McCall31168b02011-06-15 23:02:42 +00002060 = llvm::FunctionType::get(Builder.getVoidTy(), argTypes, false);
2061 fn = createARCRuntimeFunction(CGM, fnType, "objc_storeStrong");
2062 }
2063
John McCall882987f2013-02-28 19:01:20 +00002064 llvm::Value *args[] = {
2065 Builder.CreateBitCast(addr, Int8PtrPtrTy),
2066 Builder.CreateBitCast(value, Int8PtrTy)
2067 };
2068 EmitNounwindRuntimeCall(fn, args);
John McCall31168b02011-06-15 23:02:42 +00002069
2070 if (ignored) return 0;
2071 return value;
2072}
2073
2074/// Store into a strong object. Sometimes calls this:
James Dennett14c41ea2012-06-22 05:41:30 +00002075/// call void \@objc_storeStrong(i8** %addr, i8* %value)
John McCall31168b02011-06-15 23:02:42 +00002076/// Other times, breaks it down into components.
John McCall55e1fbc2011-06-25 02:11:03 +00002077llvm::Value *CodeGenFunction::EmitARCStoreStrong(LValue dst,
John McCall31168b02011-06-15 23:02:42 +00002078 llvm::Value *newValue,
2079 bool ignored) {
John McCall55e1fbc2011-06-25 02:11:03 +00002080 QualType type = dst.getType();
John McCall31168b02011-06-15 23:02:42 +00002081 bool isBlock = type->isBlockPointerType();
2082
2083 // Use a store barrier at -O0 unless this is a block type or the
2084 // lvalue is inadequately aligned.
2085 if (shouldUseFusedARCCalls() &&
2086 !isBlock &&
Eli Friedmana0544d62011-12-03 04:14:32 +00002087 (dst.getAlignment().isZero() ||
2088 dst.getAlignment() >= CharUnits::fromQuantity(PointerAlignInBytes))) {
John McCall31168b02011-06-15 23:02:42 +00002089 return EmitARCStoreStrongCall(dst.getAddress(), newValue, ignored);
2090 }
2091
2092 // Otherwise, split it out.
2093
2094 // Retain the new value.
2095 newValue = EmitARCRetain(type, newValue);
2096
2097 // Read the old value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002098 llvm::Value *oldValue = EmitLoadOfScalar(dst, SourceLocation());
John McCall31168b02011-06-15 23:02:42 +00002099
2100 // Store. We do this before the release so that any deallocs won't
2101 // see the old value.
John McCall55e1fbc2011-06-25 02:11:03 +00002102 EmitStoreOfScalar(newValue, dst);
John McCall31168b02011-06-15 23:02:42 +00002103
2104 // Finally, release the old value.
John McCallcdda29c2013-03-13 03:10:54 +00002105 EmitARCRelease(oldValue, dst.isARCPreciseLifetime());
John McCall31168b02011-06-15 23:02:42 +00002106
2107 return newValue;
2108}
2109
2110/// Autorelease the given object.
James Dennett14c41ea2012-06-22 05:41:30 +00002111/// call i8* \@objc_autorelease(i8* %value)
John McCall31168b02011-06-15 23:02:42 +00002112llvm::Value *CodeGenFunction::EmitARCAutorelease(llvm::Value *value) {
2113 return emitARCValueOperation(*this, value,
2114 CGM.getARCEntrypoints().objc_autorelease,
2115 "objc_autorelease");
2116}
2117
2118/// Autorelease the given object.
James Dennett14c41ea2012-06-22 05:41:30 +00002119/// call i8* \@objc_autoreleaseReturnValue(i8* %value)
John McCall31168b02011-06-15 23:02:42 +00002120llvm::Value *
2121CodeGenFunction::EmitARCAutoreleaseReturnValue(llvm::Value *value) {
2122 return emitARCValueOperation(*this, value,
2123 CGM.getARCEntrypoints().objc_autoreleaseReturnValue,
Chad Rosier13799b32012-12-12 17:52:21 +00002124 "objc_autoreleaseReturnValue",
2125 /*isTailCall*/ true);
John McCall31168b02011-06-15 23:02:42 +00002126}
2127
2128/// Do a fused retain/autorelease of the given object.
James Dennett14c41ea2012-06-22 05:41:30 +00002129/// call i8* \@objc_retainAutoreleaseReturnValue(i8* %value)
John McCall31168b02011-06-15 23:02:42 +00002130llvm::Value *
2131CodeGenFunction::EmitARCRetainAutoreleaseReturnValue(llvm::Value *value) {
2132 return emitARCValueOperation(*this, value,
2133 CGM.getARCEntrypoints().objc_retainAutoreleaseReturnValue,
Chad Rosier13799b32012-12-12 17:52:21 +00002134 "objc_retainAutoreleaseReturnValue",
2135 /*isTailCall*/ true);
John McCall31168b02011-06-15 23:02:42 +00002136}
2137
2138/// Do a fused retain/autorelease of the given object.
James Dennett14c41ea2012-06-22 05:41:30 +00002139/// call i8* \@objc_retainAutorelease(i8* %value)
John McCall31168b02011-06-15 23:02:42 +00002140/// or
James Dennett14c41ea2012-06-22 05:41:30 +00002141/// %retain = call i8* \@objc_retainBlock(i8* %value)
2142/// call i8* \@objc_autorelease(i8* %retain)
John McCall31168b02011-06-15 23:02:42 +00002143llvm::Value *CodeGenFunction::EmitARCRetainAutorelease(QualType type,
2144 llvm::Value *value) {
2145 if (!type->isBlockPointerType())
2146 return EmitARCRetainAutoreleaseNonBlock(value);
2147
2148 if (isa<llvm::ConstantPointerNull>(value)) return value;
2149
Chris Lattner2192fe52011-07-18 04:24:23 +00002150 llvm::Type *origType = value->getType();
John McCall31168b02011-06-15 23:02:42 +00002151 value = Builder.CreateBitCast(value, Int8PtrTy);
John McCallff613032011-10-04 06:23:45 +00002152 value = EmitARCRetainBlock(value, /*mandatory*/ true);
John McCall31168b02011-06-15 23:02:42 +00002153 value = EmitARCAutorelease(value);
2154 return Builder.CreateBitCast(value, origType);
2155}
2156
2157/// Do a fused retain/autorelease of the given object.
James Dennett14c41ea2012-06-22 05:41:30 +00002158/// call i8* \@objc_retainAutorelease(i8* %value)
John McCall31168b02011-06-15 23:02:42 +00002159llvm::Value *
2160CodeGenFunction::EmitARCRetainAutoreleaseNonBlock(llvm::Value *value) {
2161 return emitARCValueOperation(*this, value,
2162 CGM.getARCEntrypoints().objc_retainAutorelease,
2163 "objc_retainAutorelease");
2164}
2165
James Dennett14c41ea2012-06-22 05:41:30 +00002166/// i8* \@objc_loadWeak(i8** %addr)
John McCall31168b02011-06-15 23:02:42 +00002167/// Essentially objc_autorelease(objc_loadWeakRetained(addr)).
2168llvm::Value *CodeGenFunction::EmitARCLoadWeak(llvm::Value *addr) {
2169 return emitARCLoadOperation(*this, addr,
2170 CGM.getARCEntrypoints().objc_loadWeak,
2171 "objc_loadWeak");
2172}
2173
James Dennett14c41ea2012-06-22 05:41:30 +00002174/// i8* \@objc_loadWeakRetained(i8** %addr)
John McCall31168b02011-06-15 23:02:42 +00002175llvm::Value *CodeGenFunction::EmitARCLoadWeakRetained(llvm::Value *addr) {
2176 return emitARCLoadOperation(*this, addr,
2177 CGM.getARCEntrypoints().objc_loadWeakRetained,
2178 "objc_loadWeakRetained");
2179}
2180
James Dennett14c41ea2012-06-22 05:41:30 +00002181/// i8* \@objc_storeWeak(i8** %addr, i8* %value)
John McCall31168b02011-06-15 23:02:42 +00002182/// Returns %value.
2183llvm::Value *CodeGenFunction::EmitARCStoreWeak(llvm::Value *addr,
2184 llvm::Value *value,
2185 bool ignored) {
2186 return emitARCStoreOperation(*this, addr, value,
2187 CGM.getARCEntrypoints().objc_storeWeak,
2188 "objc_storeWeak", ignored);
2189}
2190
James Dennett14c41ea2012-06-22 05:41:30 +00002191/// i8* \@objc_initWeak(i8** %addr, i8* %value)
John McCall31168b02011-06-15 23:02:42 +00002192/// Returns %value. %addr is known to not have a current weak entry.
2193/// Essentially equivalent to:
2194/// *addr = nil; objc_storeWeak(addr, value);
2195void CodeGenFunction::EmitARCInitWeak(llvm::Value *addr, llvm::Value *value) {
2196 // If we're initializing to null, just write null to memory; no need
2197 // to get the runtime involved. But don't do this if optimization
2198 // is enabled, because accounting for this would make the optimizer
2199 // much more complicated.
2200 if (isa<llvm::ConstantPointerNull>(value) &&
2201 CGM.getCodeGenOpts().OptimizationLevel == 0) {
2202 Builder.CreateStore(value, addr);
2203 return;
2204 }
2205
2206 emitARCStoreOperation(*this, addr, value,
2207 CGM.getARCEntrypoints().objc_initWeak,
2208 "objc_initWeak", /*ignored*/ true);
2209}
2210
James Dennett14c41ea2012-06-22 05:41:30 +00002211/// void \@objc_destroyWeak(i8** %addr)
John McCall31168b02011-06-15 23:02:42 +00002212/// Essentially objc_storeWeak(addr, nil).
2213void CodeGenFunction::EmitARCDestroyWeak(llvm::Value *addr) {
2214 llvm::Constant *&fn = CGM.getARCEntrypoints().objc_destroyWeak;
2215 if (!fn) {
Chris Lattner2192fe52011-07-18 04:24:23 +00002216 llvm::FunctionType *fnType =
Benjamin Kramer95e19362013-03-07 21:18:31 +00002217 llvm::FunctionType::get(Builder.getVoidTy(), Int8PtrPtrTy, false);
John McCall31168b02011-06-15 23:02:42 +00002218 fn = createARCRuntimeFunction(CGM, fnType, "objc_destroyWeak");
2219 }
2220
2221 // Cast the argument to 'id*'.
2222 addr = Builder.CreateBitCast(addr, Int8PtrPtrTy);
2223
John McCall882987f2013-02-28 19:01:20 +00002224 EmitNounwindRuntimeCall(fn, addr);
John McCall31168b02011-06-15 23:02:42 +00002225}
2226
James Dennett14c41ea2012-06-22 05:41:30 +00002227/// void \@objc_moveWeak(i8** %dest, i8** %src)
John McCall31168b02011-06-15 23:02:42 +00002228/// Disregards the current value in %dest. Leaves %src pointing to nothing.
2229/// Essentially (objc_copyWeak(dest, src), objc_destroyWeak(src)).
2230void CodeGenFunction::EmitARCMoveWeak(llvm::Value *dst, llvm::Value *src) {
2231 emitARCCopyOperation(*this, dst, src,
2232 CGM.getARCEntrypoints().objc_moveWeak,
2233 "objc_moveWeak");
2234}
2235
James Dennett14c41ea2012-06-22 05:41:30 +00002236/// void \@objc_copyWeak(i8** %dest, i8** %src)
John McCall31168b02011-06-15 23:02:42 +00002237/// Disregards the current value in %dest. Essentially
2238/// objc_release(objc_initWeak(dest, objc_readWeakRetained(src)))
2239void CodeGenFunction::EmitARCCopyWeak(llvm::Value *dst, llvm::Value *src) {
2240 emitARCCopyOperation(*this, dst, src,
2241 CGM.getARCEntrypoints().objc_copyWeak,
2242 "objc_copyWeak");
2243}
2244
2245/// Produce the code to do a objc_autoreleasepool_push.
James Dennett14c41ea2012-06-22 05:41:30 +00002246/// call i8* \@objc_autoreleasePoolPush(void)
John McCall31168b02011-06-15 23:02:42 +00002247llvm::Value *CodeGenFunction::EmitObjCAutoreleasePoolPush() {
2248 llvm::Constant *&fn = CGM.getRREntrypoints().objc_autoreleasePoolPush;
2249 if (!fn) {
Chris Lattner2192fe52011-07-18 04:24:23 +00002250 llvm::FunctionType *fnType =
John McCall31168b02011-06-15 23:02:42 +00002251 llvm::FunctionType::get(Int8PtrTy, false);
2252 fn = createARCRuntimeFunction(CGM, fnType, "objc_autoreleasePoolPush");
2253 }
2254
John McCall882987f2013-02-28 19:01:20 +00002255 return EmitNounwindRuntimeCall(fn);
John McCall31168b02011-06-15 23:02:42 +00002256}
2257
2258/// Produce the code to do a primitive release.
James Dennett14c41ea2012-06-22 05:41:30 +00002259/// call void \@objc_autoreleasePoolPop(i8* %ptr)
John McCall31168b02011-06-15 23:02:42 +00002260void CodeGenFunction::EmitObjCAutoreleasePoolPop(llvm::Value *value) {
2261 assert(value->getType() == Int8PtrTy);
2262
2263 llvm::Constant *&fn = CGM.getRREntrypoints().objc_autoreleasePoolPop;
2264 if (!fn) {
Chris Lattner2192fe52011-07-18 04:24:23 +00002265 llvm::FunctionType *fnType =
Benjamin Kramer95e19362013-03-07 21:18:31 +00002266 llvm::FunctionType::get(Builder.getVoidTy(), Int8PtrTy, false);
John McCall31168b02011-06-15 23:02:42 +00002267
2268 // We don't want to use a weak import here; instead we should not
2269 // fall into this path.
2270 fn = createARCRuntimeFunction(CGM, fnType, "objc_autoreleasePoolPop");
2271 }
2272
John McCallb7ff6db2013-04-16 21:29:40 +00002273 // objc_autoreleasePoolPop can throw.
2274 EmitRuntimeCallOrInvoke(fn, value);
John McCall31168b02011-06-15 23:02:42 +00002275}
2276
2277/// Produce the code to do an MRR version objc_autoreleasepool_push.
2278/// Which is: [[NSAutoreleasePool alloc] init];
2279/// Where alloc is declared as: + (id) alloc; in NSAutoreleasePool class.
2280/// init is declared as: - (id) init; in its NSObject super class.
2281///
2282llvm::Value *CodeGenFunction::EmitObjCMRRAutoreleasePoolPush() {
2283 CGObjCRuntime &Runtime = CGM.getObjCRuntime();
John McCall882987f2013-02-28 19:01:20 +00002284 llvm::Value *Receiver = Runtime.EmitNSAutoreleasePoolClassRef(*this);
John McCall31168b02011-06-15 23:02:42 +00002285 // [NSAutoreleasePool alloc]
2286 IdentifierInfo *II = &CGM.getContext().Idents.get("alloc");
2287 Selector AllocSel = getContext().Selectors.getSelector(0, &II);
2288 CallArgList Args;
2289 RValue AllocRV =
2290 Runtime.GenerateMessageSend(*this, ReturnValueSlot(),
2291 getContext().getObjCIdType(),
2292 AllocSel, Receiver, Args);
2293
2294 // [Receiver init]
2295 Receiver = AllocRV.getScalarVal();
2296 II = &CGM.getContext().Idents.get("init");
2297 Selector InitSel = getContext().Selectors.getSelector(0, &II);
2298 RValue InitRV =
2299 Runtime.GenerateMessageSend(*this, ReturnValueSlot(),
2300 getContext().getObjCIdType(),
2301 InitSel, Receiver, Args);
2302 return InitRV.getScalarVal();
2303}
2304
2305/// Produce the code to do a primitive release.
2306/// [tmp drain];
2307void CodeGenFunction::EmitObjCMRRAutoreleasePoolPop(llvm::Value *Arg) {
2308 IdentifierInfo *II = &CGM.getContext().Idents.get("drain");
2309 Selector DrainSel = getContext().Selectors.getSelector(0, &II);
2310 CallArgList Args;
2311 CGM.getObjCRuntime().GenerateMessageSend(*this, ReturnValueSlot(),
2312 getContext().VoidTy, DrainSel, Arg, Args);
2313}
2314
John McCall82fe67b2011-07-09 01:37:26 +00002315void CodeGenFunction::destroyARCStrongPrecise(CodeGenFunction &CGF,
2316 llvm::Value *addr,
2317 QualType type) {
John McCallcdda29c2013-03-13 03:10:54 +00002318 CGF.EmitARCDestroyStrong(addr, ARCPreciseLifetime);
John McCall82fe67b2011-07-09 01:37:26 +00002319}
2320
2321void CodeGenFunction::destroyARCStrongImprecise(CodeGenFunction &CGF,
2322 llvm::Value *addr,
2323 QualType type) {
John McCallcdda29c2013-03-13 03:10:54 +00002324 CGF.EmitARCDestroyStrong(addr, ARCImpreciseLifetime);
John McCall82fe67b2011-07-09 01:37:26 +00002325}
2326
2327void CodeGenFunction::destroyARCWeak(CodeGenFunction &CGF,
2328 llvm::Value *addr,
2329 QualType type) {
2330 CGF.EmitARCDestroyWeak(addr);
2331}
2332
John McCall31168b02011-06-15 23:02:42 +00002333namespace {
John McCall31168b02011-06-15 23:02:42 +00002334 struct CallObjCAutoreleasePoolObject : EHScopeStack::Cleanup {
2335 llvm::Value *Token;
2336
2337 CallObjCAutoreleasePoolObject(llvm::Value *token) : Token(token) {}
2338
John McCall30317fd2011-07-12 20:27:29 +00002339 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCall31168b02011-06-15 23:02:42 +00002340 CGF.EmitObjCAutoreleasePoolPop(Token);
2341 }
2342 };
2343 struct CallObjCMRRAutoreleasePoolObject : EHScopeStack::Cleanup {
2344 llvm::Value *Token;
2345
2346 CallObjCMRRAutoreleasePoolObject(llvm::Value *token) : Token(token) {}
2347
John McCall30317fd2011-07-12 20:27:29 +00002348 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCall31168b02011-06-15 23:02:42 +00002349 CGF.EmitObjCMRRAutoreleasePoolPop(Token);
2350 }
2351 };
2352}
2353
2354void CodeGenFunction::EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr) {
David Blaikiebbafb8a2012-03-11 07:00:24 +00002355 if (CGM.getLangOpts().ObjCAutoRefCount)
John McCall31168b02011-06-15 23:02:42 +00002356 EHStack.pushCleanup<CallObjCAutoreleasePoolObject>(NormalCleanup, Ptr);
2357 else
2358 EHStack.pushCleanup<CallObjCMRRAutoreleasePoolObject>(NormalCleanup, Ptr);
2359}
2360
John McCall31168b02011-06-15 23:02:42 +00002361static TryEmitResult tryEmitARCRetainLoadOfScalar(CodeGenFunction &CGF,
2362 LValue lvalue,
2363 QualType type) {
2364 switch (type.getObjCLifetime()) {
2365 case Qualifiers::OCL_None:
2366 case Qualifiers::OCL_ExplicitNone:
2367 case Qualifiers::OCL_Strong:
2368 case Qualifiers::OCL_Autoreleasing:
Nick Lewycky2d84e842013-10-02 02:29:49 +00002369 return TryEmitResult(CGF.EmitLoadOfLValue(lvalue,
2370 SourceLocation()).getScalarVal(),
John McCall31168b02011-06-15 23:02:42 +00002371 false);
2372
2373 case Qualifiers::OCL_Weak:
2374 return TryEmitResult(CGF.EmitARCLoadWeakRetained(lvalue.getAddress()),
2375 true);
2376 }
2377
2378 llvm_unreachable("impossible lifetime!");
John McCall31168b02011-06-15 23:02:42 +00002379}
2380
2381static TryEmitResult tryEmitARCRetainLoadOfScalar(CodeGenFunction &CGF,
2382 const Expr *e) {
2383 e = e->IgnoreParens();
2384 QualType type = e->getType();
2385
John McCall154a2fd2011-08-30 00:57:29 +00002386 // If we're loading retained from a __strong xvalue, we can avoid
2387 // an extra retain/release pair by zeroing out the source of this
2388 // "move" operation.
2389 if (e->isXValue() &&
2390 !type.isConstQualified() &&
2391 type.getObjCLifetime() == Qualifiers::OCL_Strong) {
2392 // Emit the lvalue.
2393 LValue lv = CGF.EmitLValue(e);
2394
2395 // Load the object pointer.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002396 llvm::Value *result = CGF.EmitLoadOfLValue(lv,
2397 SourceLocation()).getScalarVal();
John McCall154a2fd2011-08-30 00:57:29 +00002398
2399 // Set the source pointer to NULL.
2400 CGF.EmitStoreOfScalar(getNullForVariable(lv.getAddress()), lv);
2401
2402 return TryEmitResult(result, true);
2403 }
2404
John McCall31168b02011-06-15 23:02:42 +00002405 // As a very special optimization, in ARC++, if the l-value is the
2406 // result of a non-volatile assignment, do a simple retain of the
2407 // result of the call to objc_storeWeak instead of reloading.
David Blaikiebbafb8a2012-03-11 07:00:24 +00002408 if (CGF.getLangOpts().CPlusPlus &&
John McCall31168b02011-06-15 23:02:42 +00002409 !type.isVolatileQualified() &&
2410 type.getObjCLifetime() == Qualifiers::OCL_Weak &&
2411 isa<BinaryOperator>(e) &&
2412 cast<BinaryOperator>(e)->getOpcode() == BO_Assign)
2413 return TryEmitResult(CGF.EmitScalarExpr(e), false);
2414
2415 return tryEmitARCRetainLoadOfScalar(CGF, CGF.EmitLValue(e), type);
2416}
2417
2418static llvm::Value *emitARCRetainAfterCall(CodeGenFunction &CGF,
2419 llvm::Value *value);
2420
2421/// Given that the given expression is some sort of call (which does
2422/// not return retained), emit a retain following it.
2423static llvm::Value *emitARCRetainCall(CodeGenFunction &CGF, const Expr *e) {
2424 llvm::Value *value = CGF.EmitScalarExpr(e);
2425 return emitARCRetainAfterCall(CGF, value);
2426}
2427
2428static llvm::Value *emitARCRetainAfterCall(CodeGenFunction &CGF,
2429 llvm::Value *value) {
2430 if (llvm::CallInst *call = dyn_cast<llvm::CallInst>(value)) {
2431 CGBuilderTy::InsertPoint ip = CGF.Builder.saveIP();
2432
2433 // Place the retain immediately following the call.
2434 CGF.Builder.SetInsertPoint(call->getParent(),
2435 ++llvm::BasicBlock::iterator(call));
2436 value = CGF.EmitARCRetainAutoreleasedReturnValue(value);
2437
2438 CGF.Builder.restoreIP(ip);
2439 return value;
2440 } else if (llvm::InvokeInst *invoke = dyn_cast<llvm::InvokeInst>(value)) {
2441 CGBuilderTy::InsertPoint ip = CGF.Builder.saveIP();
2442
2443 // Place the retain at the beginning of the normal destination block.
2444 llvm::BasicBlock *BB = invoke->getNormalDest();
2445 CGF.Builder.SetInsertPoint(BB, BB->begin());
2446 value = CGF.EmitARCRetainAutoreleasedReturnValue(value);
2447
2448 CGF.Builder.restoreIP(ip);
2449 return value;
2450
2451 // Bitcasts can arise because of related-result returns. Rewrite
2452 // the operand.
2453 } else if (llvm::BitCastInst *bitcast = dyn_cast<llvm::BitCastInst>(value)) {
2454 llvm::Value *operand = bitcast->getOperand(0);
2455 operand = emitARCRetainAfterCall(CGF, operand);
2456 bitcast->setOperand(0, operand);
2457 return bitcast;
2458
2459 // Generic fall-back case.
2460 } else {
2461 // Retain using the non-block variant: we never need to do a copy
2462 // of a block that's been returned to us.
2463 return CGF.EmitARCRetainNonBlock(value);
2464 }
2465}
2466
John McCallcd78e802011-09-10 01:16:55 +00002467/// Determine whether it might be important to emit a separate
2468/// objc_retain_block on the result of the given expression, or
2469/// whether it's okay to just emit it in a +1 context.
2470static bool shouldEmitSeparateBlockRetain(const Expr *e) {
2471 assert(e->getType()->isBlockPointerType());
2472 e = e->IgnoreParens();
2473
2474 // For future goodness, emit block expressions directly in +1
2475 // contexts if we can.
2476 if (isa<BlockExpr>(e))
2477 return false;
2478
2479 if (const CastExpr *cast = dyn_cast<CastExpr>(e)) {
2480 switch (cast->getCastKind()) {
2481 // Emitting these operations in +1 contexts is goodness.
2482 case CK_LValueToRValue:
John McCall2d637d22011-09-10 06:18:15 +00002483 case CK_ARCReclaimReturnedObject:
2484 case CK_ARCConsumeObject:
2485 case CK_ARCProduceObject:
John McCallcd78e802011-09-10 01:16:55 +00002486 return false;
2487
2488 // These operations preserve a block type.
2489 case CK_NoOp:
2490 case CK_BitCast:
2491 return shouldEmitSeparateBlockRetain(cast->getSubExpr());
2492
2493 // These operations are known to be bad (or haven't been considered).
2494 case CK_AnyPointerToBlockPointerCast:
2495 default:
2496 return true;
2497 }
2498 }
2499
2500 return true;
2501}
2502
John McCallfe96e0b2011-11-06 09:01:30 +00002503/// Try to emit a PseudoObjectExpr at +1.
2504///
2505/// This massively duplicates emitPseudoObjectRValue.
2506static TryEmitResult tryEmitARCRetainPseudoObject(CodeGenFunction &CGF,
2507 const PseudoObjectExpr *E) {
Dmitri Gribenkof8579502013-01-12 19:30:44 +00002508 SmallVector<CodeGenFunction::OpaqueValueMappingData, 4> opaques;
John McCallfe96e0b2011-11-06 09:01:30 +00002509
2510 // Find the result expression.
2511 const Expr *resultExpr = E->getResultExpr();
2512 assert(resultExpr);
2513 TryEmitResult result;
2514
2515 for (PseudoObjectExpr::const_semantics_iterator
2516 i = E->semantics_begin(), e = E->semantics_end(); i != e; ++i) {
2517 const Expr *semantic = *i;
2518
2519 // If this semantic expression is an opaque value, bind it
2520 // to the result of its source expression.
2521 if (const OpaqueValueExpr *ov = dyn_cast<OpaqueValueExpr>(semantic)) {
2522 typedef CodeGenFunction::OpaqueValueMappingData OVMA;
2523 OVMA opaqueData;
2524
2525 // If this semantic is the result of the pseudo-object
2526 // expression, try to evaluate the source as +1.
2527 if (ov == resultExpr) {
2528 assert(!OVMA::shouldBindAsLValue(ov));
2529 result = tryEmitARCRetainScalarExpr(CGF, ov->getSourceExpr());
2530 opaqueData = OVMA::bind(CGF, ov, RValue::get(result.getPointer()));
2531
2532 // Otherwise, just bind it.
2533 } else {
2534 opaqueData = OVMA::bind(CGF, ov, ov->getSourceExpr());
2535 }
2536 opaques.push_back(opaqueData);
2537
2538 // Otherwise, if the expression is the result, evaluate it
2539 // and remember the result.
2540 } else if (semantic == resultExpr) {
2541 result = tryEmitARCRetainScalarExpr(CGF, semantic);
2542
2543 // Otherwise, evaluate the expression in an ignored context.
2544 } else {
2545 CGF.EmitIgnoredExpr(semantic);
2546 }
2547 }
2548
2549 // Unbind all the opaques now.
2550 for (unsigned i = 0, e = opaques.size(); i != e; ++i)
2551 opaques[i].unbind(CGF);
2552
2553 return result;
2554}
2555
John McCall31168b02011-06-15 23:02:42 +00002556static TryEmitResult
2557tryEmitARCRetainScalarExpr(CodeGenFunction &CGF, const Expr *e) {
John McCalld21cdd42013-02-12 00:25:08 +00002558 // We should *never* see a nested full-expression here, because if
2559 // we fail to emit at +1, our caller must not retain after we close
2560 // out the full-expression.
2561 assert(!isa<ExprWithCleanups>(e));
John McCall53848232011-07-27 01:07:15 +00002562
John McCall31168b02011-06-15 23:02:42 +00002563 // The desired result type, if it differs from the type of the
2564 // ultimate opaque expression.
Chris Lattner2192fe52011-07-18 04:24:23 +00002565 llvm::Type *resultType = 0;
John McCall31168b02011-06-15 23:02:42 +00002566
2567 while (true) {
2568 e = e->IgnoreParens();
2569
2570 // There's a break at the end of this if-chain; anything
2571 // that wants to keep looping has to explicitly continue.
2572 if (const CastExpr *ce = dyn_cast<CastExpr>(e)) {
2573 switch (ce->getCastKind()) {
2574 // No-op casts don't change the type, so we just ignore them.
2575 case CK_NoOp:
2576 e = ce->getSubExpr();
2577 continue;
2578
2579 case CK_LValueToRValue: {
2580 TryEmitResult loadResult
2581 = tryEmitARCRetainLoadOfScalar(CGF, ce->getSubExpr());
2582 if (resultType) {
2583 llvm::Value *value = loadResult.getPointer();
2584 value = CGF.Builder.CreateBitCast(value, resultType);
2585 loadResult.setPointer(value);
2586 }
2587 return loadResult;
2588 }
2589
2590 // These casts can change the type, so remember that and
2591 // soldier on. We only need to remember the outermost such
2592 // cast, though.
John McCall9320b872011-09-09 05:25:32 +00002593 case CK_CPointerToObjCPointerCast:
2594 case CK_BlockPointerToObjCPointerCast:
John McCall31168b02011-06-15 23:02:42 +00002595 case CK_AnyPointerToBlockPointerCast:
2596 case CK_BitCast:
2597 if (!resultType)
2598 resultType = CGF.ConvertType(ce->getType());
2599 e = ce->getSubExpr();
2600 assert(e->getType()->hasPointerRepresentation());
2601 continue;
2602
2603 // For consumptions, just emit the subexpression and thus elide
2604 // the retain/release pair.
John McCall2d637d22011-09-10 06:18:15 +00002605 case CK_ARCConsumeObject: {
John McCall31168b02011-06-15 23:02:42 +00002606 llvm::Value *result = CGF.EmitScalarExpr(ce->getSubExpr());
2607 if (resultType) result = CGF.Builder.CreateBitCast(result, resultType);
2608 return TryEmitResult(result, true);
2609 }
2610
John McCallcd78e802011-09-10 01:16:55 +00002611 // Block extends are net +0. Naively, we could just recurse on
2612 // the subexpression, but actually we need to ensure that the
2613 // value is copied as a block, so there's a little filter here.
John McCall2d637d22011-09-10 06:18:15 +00002614 case CK_ARCExtendBlockObject: {
John McCallcd78e802011-09-10 01:16:55 +00002615 llvm::Value *result; // will be a +0 value
2616
2617 // If we can't safely assume the sub-expression will produce a
2618 // block-copied value, emit the sub-expression at +0.
2619 if (shouldEmitSeparateBlockRetain(ce->getSubExpr())) {
2620 result = CGF.EmitScalarExpr(ce->getSubExpr());
2621
2622 // Otherwise, try to emit the sub-expression at +1 recursively.
2623 } else {
2624 TryEmitResult subresult
2625 = tryEmitARCRetainScalarExpr(CGF, ce->getSubExpr());
2626 result = subresult.getPointer();
2627
2628 // If that produced a retained value, just use that,
2629 // possibly casting down.
2630 if (subresult.getInt()) {
2631 if (resultType)
2632 result = CGF.Builder.CreateBitCast(result, resultType);
2633 return TryEmitResult(result, true);
2634 }
2635
2636 // Otherwise it's +0.
2637 }
2638
2639 // Retain the object as a block, then cast down.
John McCallff613032011-10-04 06:23:45 +00002640 result = CGF.EmitARCRetainBlock(result, /*mandatory*/ true);
John McCallcd78e802011-09-10 01:16:55 +00002641 if (resultType) result = CGF.Builder.CreateBitCast(result, resultType);
2642 return TryEmitResult(result, true);
2643 }
2644
John McCall4db5c3c2011-07-07 06:58:02 +00002645 // For reclaims, emit the subexpression as a retained call and
2646 // skip the consumption.
John McCall2d637d22011-09-10 06:18:15 +00002647 case CK_ARCReclaimReturnedObject: {
John McCall4db5c3c2011-07-07 06:58:02 +00002648 llvm::Value *result = emitARCRetainCall(CGF, ce->getSubExpr());
2649 if (resultType) result = CGF.Builder.CreateBitCast(result, resultType);
2650 return TryEmitResult(result, true);
2651 }
2652
John McCall31168b02011-06-15 23:02:42 +00002653 default:
2654 break;
2655 }
2656
2657 // Skip __extension__.
2658 } else if (const UnaryOperator *op = dyn_cast<UnaryOperator>(e)) {
2659 if (op->getOpcode() == UO_Extension) {
2660 e = op->getSubExpr();
2661 continue;
2662 }
2663
2664 // For calls and message sends, use the retained-call logic.
2665 // Delegate inits are a special case in that they're the only
2666 // returns-retained expression that *isn't* surrounded by
2667 // a consume.
2668 } else if (isa<CallExpr>(e) ||
2669 (isa<ObjCMessageExpr>(e) &&
2670 !cast<ObjCMessageExpr>(e)->isDelegateInitCall())) {
2671 llvm::Value *result = emitARCRetainCall(CGF, e);
2672 if (resultType) result = CGF.Builder.CreateBitCast(result, resultType);
2673 return TryEmitResult(result, true);
John McCallfe96e0b2011-11-06 09:01:30 +00002674
2675 // Look through pseudo-object expressions.
2676 } else if (const PseudoObjectExpr *pseudo = dyn_cast<PseudoObjectExpr>(e)) {
2677 TryEmitResult result
2678 = tryEmitARCRetainPseudoObject(CGF, pseudo);
2679 if (resultType) {
2680 llvm::Value *value = result.getPointer();
2681 value = CGF.Builder.CreateBitCast(value, resultType);
2682 result.setPointer(value);
2683 }
2684 return result;
John McCall31168b02011-06-15 23:02:42 +00002685 }
2686
2687 // Conservatively halt the search at any other expression kind.
2688 break;
2689 }
2690
2691 // We didn't find an obvious production, so emit what we've got and
2692 // tell the caller that we didn't manage to retain.
2693 llvm::Value *result = CGF.EmitScalarExpr(e);
2694 if (resultType) result = CGF.Builder.CreateBitCast(result, resultType);
2695 return TryEmitResult(result, false);
2696}
2697
2698static llvm::Value *emitARCRetainLoadOfScalar(CodeGenFunction &CGF,
2699 LValue lvalue,
2700 QualType type) {
2701 TryEmitResult result = tryEmitARCRetainLoadOfScalar(CGF, lvalue, type);
2702 llvm::Value *value = result.getPointer();
2703 if (!result.getInt())
2704 value = CGF.EmitARCRetain(type, value);
2705 return value;
2706}
2707
2708/// EmitARCRetainScalarExpr - Semantically equivalent to
2709/// EmitARCRetainObject(e->getType(), EmitScalarExpr(e)), but making a
2710/// best-effort attempt to peephole expressions that naturally produce
2711/// retained objects.
2712llvm::Value *CodeGenFunction::EmitARCRetainScalarExpr(const Expr *e) {
John McCalld21cdd42013-02-12 00:25:08 +00002713 // The retain needs to happen within the full-expression.
2714 if (const ExprWithCleanups *cleanups = dyn_cast<ExprWithCleanups>(e)) {
2715 enterFullExpression(cleanups);
2716 RunCleanupsScope scope(*this);
2717 return EmitARCRetainScalarExpr(cleanups->getSubExpr());
2718 }
2719
John McCall31168b02011-06-15 23:02:42 +00002720 TryEmitResult result = tryEmitARCRetainScalarExpr(*this, e);
2721 llvm::Value *value = result.getPointer();
2722 if (!result.getInt())
2723 value = EmitARCRetain(e->getType(), value);
2724 return value;
2725}
2726
2727llvm::Value *
2728CodeGenFunction::EmitARCRetainAutoreleaseScalarExpr(const Expr *e) {
John McCalld21cdd42013-02-12 00:25:08 +00002729 // The retain needs to happen within the full-expression.
2730 if (const ExprWithCleanups *cleanups = dyn_cast<ExprWithCleanups>(e)) {
2731 enterFullExpression(cleanups);
2732 RunCleanupsScope scope(*this);
2733 return EmitARCRetainAutoreleaseScalarExpr(cleanups->getSubExpr());
2734 }
2735
John McCall31168b02011-06-15 23:02:42 +00002736 TryEmitResult result = tryEmitARCRetainScalarExpr(*this, e);
2737 llvm::Value *value = result.getPointer();
2738 if (result.getInt())
2739 value = EmitARCAutorelease(value);
2740 else
2741 value = EmitARCRetainAutorelease(e->getType(), value);
2742 return value;
2743}
2744
John McCallff613032011-10-04 06:23:45 +00002745llvm::Value *CodeGenFunction::EmitARCExtendBlockObject(const Expr *e) {
2746 llvm::Value *result;
2747 bool doRetain;
2748
2749 if (shouldEmitSeparateBlockRetain(e)) {
2750 result = EmitScalarExpr(e);
2751 doRetain = true;
2752 } else {
2753 TryEmitResult subresult = tryEmitARCRetainScalarExpr(*this, e);
2754 result = subresult.getPointer();
2755 doRetain = !subresult.getInt();
2756 }
2757
2758 if (doRetain)
2759 result = EmitARCRetainBlock(result, /*mandatory*/ true);
2760 return EmitObjCConsumeObject(e->getType(), result);
2761}
2762
John McCall248512a2011-10-01 10:32:24 +00002763llvm::Value *CodeGenFunction::EmitObjCThrowOperand(const Expr *expr) {
2764 // In ARC, retain and autorelease the expression.
David Blaikiebbafb8a2012-03-11 07:00:24 +00002765 if (getLangOpts().ObjCAutoRefCount) {
John McCall248512a2011-10-01 10:32:24 +00002766 // Do so before running any cleanups for the full-expression.
John McCalld21cdd42013-02-12 00:25:08 +00002767 // EmitARCRetainAutoreleaseScalarExpr does this for us.
John McCall248512a2011-10-01 10:32:24 +00002768 return EmitARCRetainAutoreleaseScalarExpr(expr);
2769 }
2770
2771 // Otherwise, use the normal scalar-expression emission. The
2772 // exception machinery doesn't do anything special with the
2773 // exception like retaining it, so there's no safety associated with
2774 // only running cleanups after the throw has started, and when it
2775 // matters it tends to be substantially inferior code.
2776 return EmitScalarExpr(expr);
2777}
2778
John McCall31168b02011-06-15 23:02:42 +00002779std::pair<LValue,llvm::Value*>
2780CodeGenFunction::EmitARCStoreStrong(const BinaryOperator *e,
2781 bool ignored) {
2782 // Evaluate the RHS first.
2783 TryEmitResult result = tryEmitARCRetainScalarExpr(*this, e->getRHS());
2784 llvm::Value *value = result.getPointer();
2785
John McCallb726a552011-07-28 07:23:35 +00002786 bool hasImmediateRetain = result.getInt();
2787
2788 // If we didn't emit a retained object, and the l-value is of block
2789 // type, then we need to emit the block-retain immediately in case
2790 // it invalidates the l-value.
2791 if (!hasImmediateRetain && e->getType()->isBlockPointerType()) {
John McCallff613032011-10-04 06:23:45 +00002792 value = EmitARCRetainBlock(value, /*mandatory*/ false);
John McCallb726a552011-07-28 07:23:35 +00002793 hasImmediateRetain = true;
2794 }
2795
John McCall31168b02011-06-15 23:02:42 +00002796 LValue lvalue = EmitLValue(e->getLHS());
2797
2798 // If the RHS was emitted retained, expand this.
John McCallb726a552011-07-28 07:23:35 +00002799 if (hasImmediateRetain) {
Nick Lewyckyce550072013-10-02 02:33:11 +00002800 llvm::Value *oldValue = EmitLoadOfScalar(lvalue, SourceLocation());
Eli Friedmana0544d62011-12-03 04:14:32 +00002801 EmitStoreOfScalar(value, lvalue);
John McCallcdda29c2013-03-13 03:10:54 +00002802 EmitARCRelease(oldValue, lvalue.isARCPreciseLifetime());
John McCall31168b02011-06-15 23:02:42 +00002803 } else {
John McCall55e1fbc2011-06-25 02:11:03 +00002804 value = EmitARCStoreStrong(lvalue, value, ignored);
John McCall31168b02011-06-15 23:02:42 +00002805 }
2806
2807 return std::pair<LValue,llvm::Value*>(lvalue, value);
2808}
2809
2810std::pair<LValue,llvm::Value*>
2811CodeGenFunction::EmitARCStoreAutoreleasing(const BinaryOperator *e) {
2812 llvm::Value *value = EmitARCRetainAutoreleaseScalarExpr(e->getRHS());
2813 LValue lvalue = EmitLValue(e->getLHS());
2814
Eli Friedmana0544d62011-12-03 04:14:32 +00002815 EmitStoreOfScalar(value, lvalue);
John McCall31168b02011-06-15 23:02:42 +00002816
2817 return std::pair<LValue,llvm::Value*>(lvalue, value);
2818}
2819
2820void CodeGenFunction::EmitObjCAutoreleasePoolStmt(
Eric Christopher5d2b8d92012-03-29 17:31:31 +00002821 const ObjCAutoreleasePoolStmt &ARPS) {
John McCall31168b02011-06-15 23:02:42 +00002822 const Stmt *subStmt = ARPS.getSubStmt();
2823 const CompoundStmt &S = cast<CompoundStmt>(*subStmt);
2824
2825 CGDebugInfo *DI = getDebugInfo();
Eric Christopher7cdf9482011-10-13 21:45:18 +00002826 if (DI)
2827 DI->EmitLexicalBlockStart(Builder, S.getLBracLoc());
John McCall31168b02011-06-15 23:02:42 +00002828
2829 // Keep track of the current cleanup stack depth.
2830 RunCleanupsScope Scope(*this);
John McCall3deb1ad2012-08-21 02:47:43 +00002831 if (CGM.getLangOpts().ObjCRuntime.hasNativeARC()) {
John McCall31168b02011-06-15 23:02:42 +00002832 llvm::Value *token = EmitObjCAutoreleasePoolPush();
2833 EHStack.pushCleanup<CallObjCAutoreleasePoolObject>(NormalCleanup, token);
2834 } else {
2835 llvm::Value *token = EmitObjCMRRAutoreleasePoolPush();
2836 EHStack.pushCleanup<CallObjCMRRAutoreleasePoolObject>(NormalCleanup, token);
2837 }
2838
2839 for (CompoundStmt::const_body_iterator I = S.body_begin(),
2840 E = S.body_end(); I != E; ++I)
2841 EmitStmt(*I);
2842
Eric Christopher7cdf9482011-10-13 21:45:18 +00002843 if (DI)
2844 DI->EmitLexicalBlockEnd(Builder, S.getRBracLoc());
John McCall31168b02011-06-15 23:02:42 +00002845}
John McCall1bd25562011-06-24 23:21:27 +00002846
2847/// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
2848/// make sure it survives garbage collection until this point.
2849void CodeGenFunction::EmitExtendGCLifetime(llvm::Value *object) {
2850 // We just use an inline assembly.
John McCall1bd25562011-06-24 23:21:27 +00002851 llvm::FunctionType *extenderType
John McCalla729c622012-02-17 03:33:10 +00002852 = llvm::FunctionType::get(VoidTy, VoidPtrTy, RequiredArgs::All);
John McCall1bd25562011-06-24 23:21:27 +00002853 llvm::Value *extender
2854 = llvm::InlineAsm::get(extenderType,
2855 /* assembly */ "",
2856 /* constraints */ "r",
2857 /* side effects */ true);
2858
2859 object = Builder.CreateBitCast(object, VoidPtrTy);
John McCall882987f2013-02-28 19:01:20 +00002860 EmitNounwindRuntimeCall(extender, object);
John McCall1bd25562011-06-24 23:21:27 +00002861}
2862
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00002863/// GenerateObjCAtomicSetterCopyHelperFunction - Given a c++ object type with
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00002864/// non-trivial copy assignment function, produce following helper function.
2865/// static void copyHelper(Ty *dest, const Ty *source) { *dest = *source; }
2866///
2867llvm::Constant *
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00002868CodeGenFunction::GenerateObjCAtomicSetterCopyHelperFunction(
2869 const ObjCPropertyImplDecl *PID) {
John McCall5fb5df92012-06-20 06:18:46 +00002870 if (!getLangOpts().CPlusPlus ||
Rafael Espindolad727d3d2012-12-18 04:29:34 +00002871 !getLangOpts().ObjCRuntime.hasAtomicCopyHelper())
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00002872 return 0;
2873 QualType Ty = PID->getPropertyIvarDecl()->getType();
2874 if (!Ty->isRecordType())
2875 return 0;
2876 const ObjCPropertyDecl *PD = PID->getPropertyDecl();
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00002877 if ((!(PD->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_atomic)))
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00002878 return 0;
Fariborz Jahanian1bed4132012-01-08 19:13:23 +00002879 llvm::Constant * HelperFn = 0;
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00002880 if (hasTrivialSetExpr(PID))
2881 return 0;
2882 assert(PID->getSetterCXXAssignment() && "SetterCXXAssignment - null");
2883 if ((HelperFn = CGM.getAtomicSetterHelperFnMap(Ty)))
2884 return HelperFn;
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00002885
2886 ASTContext &C = getContext();
2887 IdentifierInfo *II
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00002888 = &CGM.getContext().Idents.get("__assign_helper_atomic_property_");
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00002889 FunctionDecl *FD = FunctionDecl::Create(C,
2890 C.getTranslationUnitDecl(),
2891 SourceLocation(),
2892 SourceLocation(), II, C.VoidTy, 0,
2893 SC_Static,
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00002894 false,
Eric Christopher0b1aef22012-04-12 02:16:49 +00002895 false);
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00002896
2897 QualType DestTy = C.getPointerType(Ty);
2898 QualType SrcTy = Ty;
2899 SrcTy.addConst();
2900 SrcTy = C.getPointerType(SrcTy);
2901
2902 FunctionArgList args;
2903 ImplicitParamDecl dstDecl(FD, SourceLocation(), 0, DestTy);
2904 args.push_back(&dstDecl);
2905 ImplicitParamDecl srcDecl(FD, SourceLocation(), 0, SrcTy);
2906 args.push_back(&srcDecl);
Reid Kleckner4982b822014-01-31 22:54:50 +00002907
2908 const CGFunctionInfo &FI = CGM.getTypes().arrangeFreeFunctionDeclaration(
2909 C.VoidTy, args, FunctionType::ExtInfo(), RequiredArgs::All);
2910
John McCalla729c622012-02-17 03:33:10 +00002911 llvm::FunctionType *LTy = CGM.getTypes().GetFunctionType(FI);
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00002912
2913 llvm::Function *Fn =
2914 llvm::Function::Create(LTy, llvm::GlobalValue::InternalLinkage,
Eric Christopher5d2b8d92012-03-29 17:31:31 +00002915 "__assign_helper_atomic_property_",
2916 &CGM.getModule());
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00002917
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00002918 StartFunction(FD, C.VoidTy, Fn, FI, args, SourceLocation());
2919
John McCall113bee02012-03-10 09:33:50 +00002920 DeclRefExpr DstExpr(&dstDecl, false, DestTy,
2921 VK_RValue, SourceLocation());
2922 UnaryOperator DST(&DstExpr, UO_Deref, DestTy->getPointeeType(),
2923 VK_LValue, OK_Ordinary, SourceLocation());
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00002924
John McCall113bee02012-03-10 09:33:50 +00002925 DeclRefExpr SrcExpr(&srcDecl, false, SrcTy,
2926 VK_RValue, SourceLocation());
2927 UnaryOperator SRC(&SrcExpr, UO_Deref, SrcTy->getPointeeType(),
2928 VK_LValue, OK_Ordinary, SourceLocation());
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00002929
John McCall113bee02012-03-10 09:33:50 +00002930 Expr *Args[2] = { &DST, &SRC };
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00002931 CallExpr *CalleeExp = cast<CallExpr>(PID->getSetterCXXAssignment());
John McCall113bee02012-03-10 09:33:50 +00002932 CXXOperatorCallExpr TheCall(C, OO_Equal, CalleeExp->getCallee(),
Benjamin Kramerc215e762012-08-24 11:54:20 +00002933 Args, DestTy->getPointeeType(),
Lang Hames5de91cc2012-10-02 04:45:10 +00002934 VK_LValue, SourceLocation(), false);
John McCall113bee02012-03-10 09:33:50 +00002935
2936 EmitStmt(&TheCall);
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00002937
2938 FinishFunction();
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00002939 HelperFn = llvm::ConstantExpr::getBitCast(Fn, VoidPtrTy);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00002940 CGM.setAtomicSetterHelperFnMap(Ty, HelperFn);
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00002941 return HelperFn;
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00002942}
2943
2944llvm::Constant *
2945CodeGenFunction::GenerateObjCAtomicGetterCopyHelperFunction(
2946 const ObjCPropertyImplDecl *PID) {
John McCall5fb5df92012-06-20 06:18:46 +00002947 if (!getLangOpts().CPlusPlus ||
Rafael Espindolad727d3d2012-12-18 04:29:34 +00002948 !getLangOpts().ObjCRuntime.hasAtomicCopyHelper())
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00002949 return 0;
2950 const ObjCPropertyDecl *PD = PID->getPropertyDecl();
2951 QualType Ty = PD->getType();
2952 if (!Ty->isRecordType())
2953 return 0;
2954 if ((!(PD->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_atomic)))
2955 return 0;
2956 llvm::Constant * HelperFn = 0;
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00002957
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00002958 if (hasTrivialGetExpr(PID))
2959 return 0;
2960 assert(PID->getGetterCXXConstructor() && "getGetterCXXConstructor - null");
2961 if ((HelperFn = CGM.getAtomicGetterHelperFnMap(Ty)))
2962 return HelperFn;
2963
2964
2965 ASTContext &C = getContext();
2966 IdentifierInfo *II
2967 = &CGM.getContext().Idents.get("__copy_helper_atomic_property_");
2968 FunctionDecl *FD = FunctionDecl::Create(C,
2969 C.getTranslationUnitDecl(),
2970 SourceLocation(),
2971 SourceLocation(), II, C.VoidTy, 0,
2972 SC_Static,
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00002973 false,
Eric Christopher0b1aef22012-04-12 02:16:49 +00002974 false);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00002975
2976 QualType DestTy = C.getPointerType(Ty);
2977 QualType SrcTy = Ty;
2978 SrcTy.addConst();
2979 SrcTy = C.getPointerType(SrcTy);
2980
2981 FunctionArgList args;
2982 ImplicitParamDecl dstDecl(FD, SourceLocation(), 0, DestTy);
2983 args.push_back(&dstDecl);
2984 ImplicitParamDecl srcDecl(FD, SourceLocation(), 0, SrcTy);
2985 args.push_back(&srcDecl);
Reid Kleckner4982b822014-01-31 22:54:50 +00002986
2987 const CGFunctionInfo &FI = CGM.getTypes().arrangeFreeFunctionDeclaration(
2988 C.VoidTy, args, FunctionType::ExtInfo(), RequiredArgs::All);
2989
John McCalla729c622012-02-17 03:33:10 +00002990 llvm::FunctionType *LTy = CGM.getTypes().GetFunctionType(FI);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00002991
2992 llvm::Function *Fn =
2993 llvm::Function::Create(LTy, llvm::GlobalValue::InternalLinkage,
2994 "__copy_helper_atomic_property_", &CGM.getModule());
2995
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00002996 StartFunction(FD, C.VoidTy, Fn, FI, args, SourceLocation());
2997
John McCall113bee02012-03-10 09:33:50 +00002998 DeclRefExpr SrcExpr(&srcDecl, false, SrcTy,
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00002999 VK_RValue, SourceLocation());
3000
John McCall113bee02012-03-10 09:33:50 +00003001 UnaryOperator SRC(&SrcExpr, UO_Deref, SrcTy->getPointeeType(),
3002 VK_LValue, OK_Ordinary, SourceLocation());
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003003
3004 CXXConstructExpr *CXXConstExpr =
3005 cast<CXXConstructExpr>(PID->getGetterCXXConstructor());
3006
3007 SmallVector<Expr*, 4> ConstructorArgs;
John McCall113bee02012-03-10 09:33:50 +00003008 ConstructorArgs.push_back(&SRC);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003009 CXXConstructExpr::arg_iterator A = CXXConstExpr->arg_begin();
3010 ++A;
3011
3012 for (CXXConstructExpr::arg_iterator AEnd = CXXConstExpr->arg_end();
3013 A != AEnd; ++A)
3014 ConstructorArgs.push_back(*A);
3015
3016 CXXConstructExpr *TheCXXConstructExpr =
3017 CXXConstructExpr::Create(C, Ty, SourceLocation(),
3018 CXXConstExpr->getConstructor(),
3019 CXXConstExpr->isElidable(),
Benjamin Kramerc215e762012-08-24 11:54:20 +00003020 ConstructorArgs,
Sebastian Redla9351792012-02-11 23:51:47 +00003021 CXXConstExpr->hadMultipleCandidates(),
3022 CXXConstExpr->isListInitialization(),
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003023 CXXConstExpr->requiresZeroInitialization(),
Eric Christopher5d2b8d92012-03-29 17:31:31 +00003024 CXXConstExpr->getConstructionKind(),
3025 SourceRange());
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003026
John McCall113bee02012-03-10 09:33:50 +00003027 DeclRefExpr DstExpr(&dstDecl, false, DestTy,
3028 VK_RValue, SourceLocation());
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003029
John McCall113bee02012-03-10 09:33:50 +00003030 RValue DV = EmitAnyExpr(&DstExpr);
Eric Christopher5d2b8d92012-03-29 17:31:31 +00003031 CharUnits Alignment
3032 = getContext().getTypeAlignInChars(TheCXXConstructExpr->getType());
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003033 EmitAggExpr(TheCXXConstructExpr,
3034 AggValueSlot::forAddr(DV.getScalarVal(), Alignment, Qualifiers(),
3035 AggValueSlot::IsDestructed,
3036 AggValueSlot::DoesNotNeedGCBarriers,
Chad Rosier615ed1a2012-03-29 17:37:10 +00003037 AggValueSlot::IsNotAliased));
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003038
3039 FinishFunction();
3040 HelperFn = llvm::ConstantExpr::getBitCast(Fn, VoidPtrTy);
3041 CGM.setAtomicGetterHelperFnMap(Ty, HelperFn);
3042 return HelperFn;
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003043}
3044
Eli Friedmanec75fec2012-02-28 01:08:45 +00003045llvm::Value *
3046CodeGenFunction::EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty) {
3047 // Get selectors for retain/autorelease.
Eli Friedmanc4e5d0c2012-03-01 22:52:28 +00003048 IdentifierInfo *CopyID = &getContext().Idents.get("copy");
3049 Selector CopySelector =
3050 getContext().Selectors.getNullarySelector(CopyID);
Eli Friedmanec75fec2012-02-28 01:08:45 +00003051 IdentifierInfo *AutoreleaseID = &getContext().Idents.get("autorelease");
3052 Selector AutoreleaseSelector =
3053 getContext().Selectors.getNullarySelector(AutoreleaseID);
3054
3055 // Emit calls to retain/autorelease.
3056 CGObjCRuntime &Runtime = CGM.getObjCRuntime();
3057 llvm::Value *Val = Block;
3058 RValue Result;
3059 Result = Runtime.GenerateMessageSend(*this, ReturnValueSlot(),
Eli Friedmanc4e5d0c2012-03-01 22:52:28 +00003060 Ty, CopySelector,
Eli Friedmanec75fec2012-02-28 01:08:45 +00003061 Val, CallArgList(), 0, 0);
3062 Val = Result.getScalarVal();
3063 Result = Runtime.GenerateMessageSend(*this, ReturnValueSlot(),
3064 Ty, AutoreleaseSelector,
3065 Val, CallArgList(), 0, 0);
3066 Val = Result.getScalarVal();
3067 return Val;
3068}
3069
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003070
Ted Kremenek43e06332008-04-09 15:51:31 +00003071CGObjCRuntime::~CGObjCRuntime() {}