blob: f0a47af909e01dfe9ba8e9e1859b333ce7118fbe [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"
Anders Carlsson2e744e82008-08-30 19:51:14 +000023#include "llvm/ADT/STLExtras.h"
Daniel Dunbara08dff12008-09-24 04:04:31 +000024#include "llvm/Target/TargetData.h"
John McCall31168b02011-06-15 23:02:42 +000025#include "llvm/InlineAsm.h"
Anders Carlsson76f4a902007-08-21 17:43:55 +000026using namespace clang;
27using namespace CodeGen;
28
John McCall31168b02011-06-15 23:02:42 +000029typedef llvm::PointerIntPair<llvm::Value*,1,bool> TryEmitResult;
30static TryEmitResult
31tryEmitARCRetainScalarExpr(CodeGenFunction &CGF, const Expr *e);
32
33/// Given the address of a variable of pointer type, find the correct
34/// null to store into it.
35static llvm::Constant *getNullForVariable(llvm::Value *addr) {
Chris Lattner2192fe52011-07-18 04:24:23 +000036 llvm::Type *type =
John McCall31168b02011-06-15 23:02:42 +000037 cast<llvm::PointerType>(addr->getType())->getElementType();
38 return llvm::ConstantPointerNull::get(cast<llvm::PointerType>(type));
39}
40
Chris Lattnerb1d329d2008-06-24 17:04:18 +000041/// Emits an instance of NSConstantString representing the object.
Mike Stump11289f42009-09-09 15:08:12 +000042llvm::Value *CodeGenFunction::EmitObjCStringLiteral(const ObjCStringLiteral *E)
Daniel Dunbar44b58a22008-11-25 21:53:21 +000043{
David Chisnall481e3a82010-01-23 02:40:42 +000044 llvm::Constant *C =
45 CGM.getObjCRuntime().GenerateConstantString(E->getString());
Daniel Dunbar66912a12008-08-20 00:28:19 +000046 // FIXME: This bitcast should just be made an invariant on the Runtime.
Owen Andersonade90fd2009-07-29 18:54:39 +000047 return llvm::ConstantExpr::getBitCast(C, ConvertType(E->getType()));
Chris Lattnerb1d329d2008-06-24 17:04:18 +000048}
49
50/// Emit a selector.
51llvm::Value *CodeGenFunction::EmitObjCSelectorExpr(const ObjCSelectorExpr *E) {
52 // Untyped selector.
53 // Note that this implementation allows for non-constant strings to be passed
54 // as arguments to @selector(). Currently, the only thing preventing this
55 // behaviour is the type checking in the front end.
Daniel Dunbar45858d22010-02-03 20:11:42 +000056 return CGM.getObjCRuntime().GetSelector(Builder, E->getSelector());
Chris Lattnerb1d329d2008-06-24 17:04:18 +000057}
58
Daniel Dunbar66912a12008-08-20 00:28:19 +000059llvm::Value *CodeGenFunction::EmitObjCProtocolExpr(const ObjCProtocolExpr *E) {
60 // FIXME: This should pass the Decl not the name.
61 return CGM.getObjCRuntime().GenerateProtocolRef(Builder, E->getProtocol());
62}
Chris Lattnerb1d329d2008-06-24 17:04:18 +000063
Douglas Gregor33823722011-06-11 01:09:30 +000064/// \brief Adjust the type of the result of an Objective-C message send
65/// expression when the method has a related result type.
66static RValue AdjustRelatedResultType(CodeGenFunction &CGF,
67 const Expr *E,
68 const ObjCMethodDecl *Method,
69 RValue Result) {
70 if (!Method)
71 return Result;
John McCall31168b02011-06-15 23:02:42 +000072
Douglas Gregor33823722011-06-11 01:09:30 +000073 if (!Method->hasRelatedResultType() ||
74 CGF.getContext().hasSameType(E->getType(), Method->getResultType()) ||
75 !Result.isScalar())
76 return Result;
77
78 // We have applied a related result type. Cast the rvalue appropriately.
79 return RValue::get(CGF.Builder.CreateBitCast(Result.getScalarVal(),
80 CGF.ConvertType(E->getType())));
81}
Chris Lattnerb1d329d2008-06-24 17:04:18 +000082
John McCallcf166702011-07-22 08:53:00 +000083/// Decide whether to extend the lifetime of the receiver of a
84/// returns-inner-pointer message.
85static bool
86shouldExtendReceiverForInnerPointerMessage(const ObjCMessageExpr *message) {
87 switch (message->getReceiverKind()) {
88
89 // For a normal instance message, we should extend unless the
90 // receiver is loaded from a variable with precise lifetime.
91 case ObjCMessageExpr::Instance: {
92 const Expr *receiver = message->getInstanceReceiver();
93 const ImplicitCastExpr *ice = dyn_cast<ImplicitCastExpr>(receiver);
94 if (!ice || ice->getCastKind() != CK_LValueToRValue) return true;
95 receiver = ice->getSubExpr()->IgnoreParens();
96
97 // Only __strong variables.
98 if (receiver->getType().getObjCLifetime() != Qualifiers::OCL_Strong)
99 return true;
100
101 // All ivars and fields have precise lifetime.
102 if (isa<MemberExpr>(receiver) || isa<ObjCIvarRefExpr>(receiver))
103 return false;
104
105 // Otherwise, check for variables.
106 const DeclRefExpr *declRef = dyn_cast<DeclRefExpr>(ice->getSubExpr());
107 if (!declRef) return true;
108 const VarDecl *var = dyn_cast<VarDecl>(declRef->getDecl());
109 if (!var) return true;
110
111 // All variables have precise lifetime except local variables with
112 // automatic storage duration that aren't specially marked.
113 return (var->hasLocalStorage() &&
114 !var->hasAttr<ObjCPreciseLifetimeAttr>());
115 }
116
117 case ObjCMessageExpr::Class:
118 case ObjCMessageExpr::SuperClass:
119 // It's never necessary for class objects.
120 return false;
121
122 case ObjCMessageExpr::SuperInstance:
123 // We generally assume that 'self' lives throughout a method call.
124 return false;
125 }
126
127 llvm_unreachable("invalid receiver kind");
128}
129
John McCall78a15112010-05-22 01:48:05 +0000130RValue CodeGenFunction::EmitObjCMessageExpr(const ObjCMessageExpr *E,
131 ReturnValueSlot Return) {
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000132 // Only the lookup mechanism and first two arguments of the method
133 // implementation vary between runtimes. We can get the receiver and
134 // arguments in generic code.
Mike Stump11289f42009-09-09 15:08:12 +0000135
John McCall31168b02011-06-15 23:02:42 +0000136 bool isDelegateInit = E->isDelegateInitCall();
137
John McCallcf166702011-07-22 08:53:00 +0000138 const ObjCMethodDecl *method = E->getMethodDecl();
139
John McCall31168b02011-06-15 23:02:42 +0000140 // We don't retain the receiver in delegate init calls, and this is
141 // safe because the receiver value is always loaded from 'self',
142 // which we zero out. We don't want to Block_copy block receivers,
143 // though.
144 bool retainSelf =
145 (!isDelegateInit &&
146 CGM.getLangOptions().ObjCAutoRefCount &&
John McCallcf166702011-07-22 08:53:00 +0000147 method &&
148 method->hasAttr<NSConsumesSelfAttr>());
John McCall31168b02011-06-15 23:02:42 +0000149
Daniel Dunbar8d480592008-08-11 18:12:00 +0000150 CGObjCRuntime &Runtime = CGM.getObjCRuntime();
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000151 bool isSuperMessage = false;
Daniel Dunbarca8531a2008-08-25 08:19:24 +0000152 bool isClassMessage = false;
David Chisnall01aa4672010-04-28 19:33:36 +0000153 ObjCInterfaceDecl *OID = 0;
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000154 // Find the receiver
Douglas Gregor33823722011-06-11 01:09:30 +0000155 QualType ReceiverType;
Daniel Dunbarb2197802010-04-22 03:17:06 +0000156 llvm::Value *Receiver = 0;
Douglas Gregor9a129192010-04-21 00:45:42 +0000157 switch (E->getReceiverKind()) {
158 case ObjCMessageExpr::Instance:
Douglas Gregor33823722011-06-11 01:09:30 +0000159 ReceiverType = E->getInstanceReceiver()->getType();
John McCall31168b02011-06-15 23:02:42 +0000160 if (retainSelf) {
161 TryEmitResult ter = tryEmitARCRetainScalarExpr(*this,
162 E->getInstanceReceiver());
163 Receiver = ter.getPointer();
John McCallcf166702011-07-22 08:53:00 +0000164 if (ter.getInt()) retainSelf = false;
John McCall31168b02011-06-15 23:02:42 +0000165 } else
166 Receiver = EmitScalarExpr(E->getInstanceReceiver());
Douglas Gregor9a129192010-04-21 00:45:42 +0000167 break;
Daniel Dunbar7c6d3a72008-08-16 00:25:02 +0000168
Douglas Gregor9a129192010-04-21 00:45:42 +0000169 case ObjCMessageExpr::Class: {
Douglas Gregor33823722011-06-11 01:09:30 +0000170 ReceiverType = E->getClassReceiver();
171 const ObjCObjectType *ObjTy = ReceiverType->getAs<ObjCObjectType>();
John McCall3e294922010-05-17 20:12:43 +0000172 assert(ObjTy && "Invalid Objective-C class message send");
173 OID = ObjTy->getInterface();
174 assert(OID && "Invalid Objective-C class message send");
David Chisnall01aa4672010-04-28 19:33:36 +0000175 Receiver = Runtime.GetClass(Builder, OID);
Daniel Dunbarca8531a2008-08-25 08:19:24 +0000176 isClassMessage = true;
Douglas Gregor9a129192010-04-21 00:45:42 +0000177 break;
178 }
179
180 case ObjCMessageExpr::SuperInstance:
Douglas Gregor33823722011-06-11 01:09:30 +0000181 ReceiverType = E->getSuperType();
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000182 Receiver = LoadObjCSelf();
Douglas Gregor9a129192010-04-21 00:45:42 +0000183 isSuperMessage = true;
184 break;
185
186 case ObjCMessageExpr::SuperClass:
Douglas Gregor33823722011-06-11 01:09:30 +0000187 ReceiverType = E->getSuperType();
Douglas Gregor9a129192010-04-21 00:45:42 +0000188 Receiver = LoadObjCSelf();
189 isSuperMessage = true;
190 isClassMessage = true;
191 break;
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000192 }
193
John McCallcf166702011-07-22 08:53:00 +0000194 if (retainSelf)
195 Receiver = EmitARCRetainNonBlock(Receiver);
196
197 // In ARC, we sometimes want to "extend the lifetime"
198 // (i.e. retain+autorelease) of receivers of returns-inner-pointer
199 // messages.
200 if (getLangOptions().ObjCAutoRefCount && method &&
201 method->hasAttr<ObjCReturnsInnerPointerAttr>() &&
202 shouldExtendReceiverForInnerPointerMessage(E))
203 Receiver = EmitARCRetainAutorelease(ReceiverType, Receiver);
204
John McCall31168b02011-06-15 23:02:42 +0000205 QualType ResultType =
John McCallcf166702011-07-22 08:53:00 +0000206 method ? method->getResultType() : E->getType();
John McCall31168b02011-06-15 23:02:42 +0000207
Daniel Dunbarc722b852008-08-30 03:02:31 +0000208 CallArgList Args;
John McCallcf166702011-07-22 08:53:00 +0000209 EmitCallArgs(Args, method, E->arg_begin(), E->arg_end());
Mike Stump11289f42009-09-09 15:08:12 +0000210
John McCall31168b02011-06-15 23:02:42 +0000211 // For delegate init calls in ARC, do an unsafe store of null into
212 // self. This represents the call taking direct ownership of that
213 // value. We have to do this after emitting the other call
214 // arguments because they might also reference self, but we don't
215 // have to worry about any of them modifying self because that would
216 // be an undefined read and write of an object in unordered
217 // expressions.
218 if (isDelegateInit) {
219 assert(getLangOptions().ObjCAutoRefCount &&
220 "delegate init calls should only be marked in ARC");
221
222 // Do an unsafe store of null into self.
223 llvm::Value *selfAddr =
224 LocalDeclMap[cast<ObjCMethodDecl>(CurCodeDecl)->getSelfDecl()];
225 assert(selfAddr && "no self entry for a delegate init call?");
226
227 Builder.CreateStore(getNullForVariable(selfAddr), selfAddr);
228 }
Anders Carlsson280e61f12010-06-21 20:59:55 +0000229
Douglas Gregor33823722011-06-11 01:09:30 +0000230 RValue result;
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000231 if (isSuperMessage) {
Chris Lattner6cfec782008-06-26 04:42:20 +0000232 // super is only valid in an Objective-C method
233 const ObjCMethodDecl *OMD = cast<ObjCMethodDecl>(CurFuncDecl);
Fariborz Jahanianbac73ac2009-02-28 20:07:56 +0000234 bool isCategoryImpl = isa<ObjCCategoryImplDecl>(OMD->getDeclContext());
Douglas Gregor33823722011-06-11 01:09:30 +0000235 result = Runtime.GenerateMessageSendSuper(*this, Return, ResultType,
236 E->getSelector(),
237 OMD->getClassInterface(),
238 isCategoryImpl,
239 Receiver,
240 isClassMessage,
241 Args,
John McCallcf166702011-07-22 08:53:00 +0000242 method);
Douglas Gregor33823722011-06-11 01:09:30 +0000243 } else {
244 result = Runtime.GenerateMessageSend(*this, Return, ResultType,
245 E->getSelector(),
246 Receiver, Args, OID,
John McCallcf166702011-07-22 08:53:00 +0000247 method);
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000248 }
John McCall31168b02011-06-15 23:02:42 +0000249
250 // For delegate init calls in ARC, implicitly store the result of
251 // the call back into self. This takes ownership of the value.
252 if (isDelegateInit) {
253 llvm::Value *selfAddr =
254 LocalDeclMap[cast<ObjCMethodDecl>(CurCodeDecl)->getSelfDecl()];
255 llvm::Value *newSelf = result.getScalarVal();
256
257 // The delegate return type isn't necessarily a matching type; in
258 // fact, it's quite likely to be 'id'.
Chris Lattner2192fe52011-07-18 04:24:23 +0000259 llvm::Type *selfTy =
John McCall31168b02011-06-15 23:02:42 +0000260 cast<llvm::PointerType>(selfAddr->getType())->getElementType();
261 newSelf = Builder.CreateBitCast(newSelf, selfTy);
262
263 Builder.CreateStore(newSelf, selfAddr);
264 }
265
John McCallcf166702011-07-22 08:53:00 +0000266 return AdjustRelatedResultType(*this, E, method, result);
Anders Carlsson76f4a902007-08-21 17:43:55 +0000267}
268
John McCall31168b02011-06-15 23:02:42 +0000269namespace {
270struct FinishARCDealloc : EHScopeStack::Cleanup {
John McCall30317fd2011-07-12 20:27:29 +0000271 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCall31168b02011-06-15 23:02:42 +0000272 const ObjCMethodDecl *method = cast<ObjCMethodDecl>(CGF.CurCodeDecl);
John McCalldffafde2011-07-13 18:26:47 +0000273
274 const ObjCImplDecl *impl = cast<ObjCImplDecl>(method->getDeclContext());
John McCall31168b02011-06-15 23:02:42 +0000275 const ObjCInterfaceDecl *iface = impl->getClassInterface();
276 if (!iface->getSuperClass()) return;
277
John McCalldffafde2011-07-13 18:26:47 +0000278 bool isCategory = isa<ObjCCategoryImplDecl>(impl);
279
John McCall31168b02011-06-15 23:02:42 +0000280 // Call [super dealloc] if we have a superclass.
281 llvm::Value *self = CGF.LoadObjCSelf();
282
283 CallArgList args;
284 CGF.CGM.getObjCRuntime().GenerateMessageSendSuper(CGF, ReturnValueSlot(),
285 CGF.getContext().VoidTy,
286 method->getSelector(),
287 iface,
John McCalldffafde2011-07-13 18:26:47 +0000288 isCategory,
John McCall31168b02011-06-15 23:02:42 +0000289 self,
290 /*is class msg*/ false,
291 args,
292 method);
293 }
294};
295}
296
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000297/// StartObjCMethod - Begin emission of an ObjCMethod. This generates
298/// the LLVM function and sets the other context used by
299/// CodeGenFunction.
Fariborz Jahanian0196a1c2009-01-10 21:06:09 +0000300void CodeGenFunction::StartObjCMethod(const ObjCMethodDecl *OMD,
Devang Patele7ce5402011-05-19 23:37:41 +0000301 const ObjCContainerDecl *CD,
302 SourceLocation StartLoc) {
John McCalla738c252011-03-09 04:27:21 +0000303 FunctionArgList args;
Devang Patela2c048e2010-04-05 21:09:15 +0000304 // Check if we should generate debug info for this method.
Devang Pateld6ffebb2011-03-07 18:45:56 +0000305 if (CGM.getModuleDebugInfo() && !OMD->hasAttr<NoDebugAttr>())
306 DebugInfo = CGM.getModuleDebugInfo();
Devang Patela2c048e2010-04-05 21:09:15 +0000307
Fariborz Jahanian0196a1c2009-01-10 21:06:09 +0000308 llvm::Function *Fn = CGM.getObjCRuntime().GenerateMethod(OMD, CD);
Daniel Dunbar449a3392008-09-04 23:41:35 +0000309
Daniel Dunbarc3e7cff2009-04-17 00:48:04 +0000310 const CGFunctionInfo &FI = CGM.getTypes().getFunctionInfo(OMD);
311 CGM.SetInternalFunctionAttributes(OMD, Fn, FI);
Chris Lattner5696e7b2008-06-17 18:05:57 +0000312
John McCalla738c252011-03-09 04:27:21 +0000313 args.push_back(OMD->getSelfDecl());
314 args.push_back(OMD->getCmdDecl());
Chris Lattner5696e7b2008-06-17 18:05:57 +0000315
Chris Lattnera4997152009-02-20 18:43:26 +0000316 for (ObjCMethodDecl::param_iterator PI = OMD->param_begin(),
317 E = OMD->param_end(); PI != E; ++PI)
John McCalla738c252011-03-09 04:27:21 +0000318 args.push_back(*PI);
Chris Lattner5696e7b2008-06-17 18:05:57 +0000319
Peter Collingbourne0ff0b372011-01-13 18:57:25 +0000320 CurGD = OMD;
321
Devang Patele7ce5402011-05-19 23:37:41 +0000322 StartFunction(OMD, OMD->getResultType(), Fn, FI, args, StartLoc);
John McCall31168b02011-06-15 23:02:42 +0000323
324 // In ARC, certain methods get an extra cleanup.
325 if (CGM.getLangOptions().ObjCAutoRefCount &&
326 OMD->isInstanceMethod() &&
327 OMD->getSelector().isUnarySelector()) {
328 const IdentifierInfo *ident =
329 OMD->getSelector().getIdentifierInfoForSlot(0);
330 if (ident->isStr("dealloc"))
331 EHStack.pushCleanup<FinishARCDealloc>(getARCCleanupKind());
332 }
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000333}
Daniel Dunbara94ecd22008-08-16 03:19:19 +0000334
John McCall31168b02011-06-15 23:02:42 +0000335static llvm::Value *emitARCRetainLoadOfScalar(CodeGenFunction &CGF,
336 LValue lvalue, QualType type);
337
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000338/// Generate an Objective-C method. An Objective-C method is a C function with
Mike Stump11289f42009-09-09 15:08:12 +0000339/// its pointer, name, and types registered in the class struture.
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000340void CodeGenFunction::GenerateObjCMethod(const ObjCMethodDecl *OMD) {
Devang Patele7ce5402011-05-19 23:37:41 +0000341 StartObjCMethod(OMD, OMD->getClassInterface(), OMD->getLocStart());
Argyrios Kyrtzidisddcd1322009-06-30 02:35:26 +0000342 EmitStmt(OMD->getBody());
343 FinishFunction(OMD->getBodyRBrace());
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000344}
345
John McCallb923ece2011-09-12 23:06:44 +0000346/// emitStructGetterCall - Call the runtime function to load a property
347/// into the return value slot.
348static void emitStructGetterCall(CodeGenFunction &CGF, ObjCIvarDecl *ivar,
349 bool isAtomic, bool hasStrong) {
350 ASTContext &Context = CGF.getContext();
351
352 llvm::Value *src =
353 CGF.EmitLValueForIvar(CGF.TypeOfSelfObject(), CGF.LoadObjCSelf(),
354 ivar, 0).getAddress();
355
356 // objc_copyStruct (ReturnValue, &structIvar,
357 // sizeof (Type of Ivar), isAtomic, false);
358 CallArgList args;
359
360 llvm::Value *dest = CGF.Builder.CreateBitCast(CGF.ReturnValue, CGF.VoidPtrTy);
361 args.add(RValue::get(dest), Context.VoidPtrTy);
362
363 src = CGF.Builder.CreateBitCast(src, CGF.VoidPtrTy);
364 args.add(RValue::get(src), Context.VoidPtrTy);
365
366 CharUnits size = CGF.getContext().getTypeSizeInChars(ivar->getType());
367 args.add(RValue::get(CGF.CGM.getSize(size)), Context.getSizeType());
368 args.add(RValue::get(CGF.Builder.getInt1(isAtomic)), Context.BoolTy);
369 args.add(RValue::get(CGF.Builder.getInt1(hasStrong)), Context.BoolTy);
370
371 llvm::Value *fn = CGF.CGM.getObjCRuntime().GetGetStructFunction();
372 CGF.EmitCall(CGF.getTypes().getFunctionInfo(Context.VoidTy, args,
373 FunctionType::ExtInfo()),
374 fn, ReturnValueSlot(), args);
375}
376
John McCallf4528ae2011-09-13 03:34:09 +0000377/// Determine whether the given architecture supports unaligned atomic
378/// accesses. They don't have to be fast, just faster than a function
379/// call and a mutex.
380static bool hasUnalignedAtomics(llvm::Triple::ArchType arch) {
381 return (arch == llvm::Triple::x86 || arch == llvm::Triple::x86_64);
382}
383
384/// Return the maximum size that permits atomic accesses for the given
385/// architecture.
386static CharUnits getMaxAtomicAccessSize(CodeGenModule &CGM,
387 llvm::Triple::ArchType arch) {
388 // ARM has 8-byte atomic accesses, but it's not clear whether we
389 // want to rely on them here.
390
391 // In the default case, just assume that any size up to a pointer is
392 // fine given adequate alignment.
393 return CharUnits::fromQuantity(CGM.PointerSizeInBytes);
394}
395
396namespace {
397 class PropertyImplStrategy {
398 public:
399 enum StrategyKind {
400 /// The 'native' strategy is to use the architecture's provided
401 /// reads and writes.
402 Native,
403
404 /// Use objc_setProperty and objc_getProperty.
405 GetSetProperty,
406
407 /// Use objc_setProperty for the setter, but use expression
408 /// evaluation for the getter.
409 SetPropertyAndExpressionGet,
410
411 /// Use objc_copyStruct.
412 CopyStruct,
413
414 /// The 'expression' strategy is to emit normal assignment or
415 /// lvalue-to-rvalue expressions.
416 Expression
417 };
418
419 StrategyKind getKind() const { return StrategyKind(Kind); }
420
421 bool hasStrongMember() const { return HasStrong; }
422 bool isAtomic() const { return IsAtomic; }
423 bool isCopy() const { return IsCopy; }
424
425 CharUnits getIvarSize() const { return IvarSize; }
426 CharUnits getIvarAlignment() const { return IvarAlignment; }
427
428 PropertyImplStrategy(CodeGenModule &CGM,
429 const ObjCPropertyImplDecl *propImpl);
430
431 private:
432 unsigned Kind : 8;
433 unsigned IsAtomic : 1;
434 unsigned IsCopy : 1;
435 unsigned HasStrong : 1;
436
437 CharUnits IvarSize;
438 CharUnits IvarAlignment;
439 };
440}
441
442/// Pick an implementation strategy for the the given property synthesis.
443PropertyImplStrategy::PropertyImplStrategy(CodeGenModule &CGM,
444 const ObjCPropertyImplDecl *propImpl) {
445 const ObjCPropertyDecl *prop = propImpl->getPropertyDecl();
446 ObjCPropertyDecl::PropertyAttributeKind attrs = prop->getPropertyAttributes();
447
448 IsCopy = (attrs & ObjCPropertyDecl::OBJC_PR_copy);
449 IsAtomic = !(attrs & ObjCPropertyDecl::OBJC_PR_nonatomic);
450 HasStrong = false; // doesn't matter here.
451
452 // Evaluate the ivar's size and alignment.
453 ObjCIvarDecl *ivar = propImpl->getPropertyIvarDecl();
454 QualType ivarType = ivar->getType();
455 llvm::tie(IvarSize, IvarAlignment)
456 = CGM.getContext().getTypeInfoInChars(ivarType);
457
458 // If we have a copy property, we always have to use getProperty/setProperty.
459 if (IsCopy) {
460 Kind = GetSetProperty;
461 return;
462 }
463
464 // Handle retain/strong.
465 if (attrs & (ObjCPropertyDecl::OBJC_PR_retain
466 | ObjCPropertyDecl::OBJC_PR_strong)) {
467 // In GC-only, there's nothing special that needs to be done.
468 if (CGM.getLangOptions().getGCMode() == LangOptions::GCOnly) {
469 // fallthrough
470
471 // In ARC, if the property is non-atomic, use expression emission,
472 // which translates to objc_storeStrong. This isn't required, but
473 // it's slightly nicer.
474 } else if (CGM.getLangOptions().ObjCAutoRefCount && !IsAtomic) {
475 Kind = Expression;
476 return;
477
478 // Otherwise, we need to at least use setProperty. However, if
479 // the property isn't atomic, we can use normal expression
480 // emission for the getter.
481 } else if (!IsAtomic) {
482 Kind = SetPropertyAndExpressionGet;
483 return;
484
485 // Otherwise, we have to use both setProperty and getProperty.
486 } else {
487 Kind = GetSetProperty;
488 return;
489 }
490 }
491
492 // If we're not atomic, just use expression accesses.
493 if (!IsAtomic) {
494 Kind = Expression;
495 return;
496 }
497
John McCall0e5c0862011-09-13 05:36:29 +0000498 // Properties on bitfield ivars need to be emitted using expression
499 // accesses even if they're nominally atomic.
500 if (ivar->isBitField()) {
501 Kind = Expression;
502 return;
503 }
504
John McCallf4528ae2011-09-13 03:34:09 +0000505 // GC-qualified or ARC-qualified ivars need to be emitted as
506 // expressions. This actually works out to being atomic anyway,
507 // except for ARC __strong, but that should trigger the above code.
508 if (ivarType.hasNonTrivialObjCLifetime() ||
509 (CGM.getLangOptions().getGCMode() &&
510 CGM.getContext().getObjCGCAttrKind(ivarType))) {
511 Kind = Expression;
512 return;
513 }
514
515 // Compute whether the ivar has strong members.
516 if (CGM.getLangOptions().getGCMode())
517 if (const RecordType *recordType = ivarType->getAs<RecordType>())
518 HasStrong = recordType->getDecl()->hasObjectMember();
519
520 // We can never access structs with object members with a native
521 // access, because we need to use write barriers. This is what
522 // objc_copyStruct is for.
523 if (HasStrong) {
524 Kind = CopyStruct;
525 return;
526 }
527
528 // Otherwise, this is target-dependent and based on the size and
529 // alignment of the ivar.
530 llvm::Triple::ArchType arch =
531 CGM.getContext().getTargetInfo().getTriple().getArch();
532
533 // Most architectures require memory to fit within a single cache
534 // line, so the alignment has to be at least the size of the access.
535 // Otherwise we have to grab a lock.
536 if (IvarAlignment < IvarSize && !hasUnalignedAtomics(arch)) {
537 Kind = CopyStruct;
538 return;
539 }
540
541 // If the ivar's size exceeds the architecture's maximum atomic
542 // access size, we have to use CopyStruct.
543 if (IvarSize > getMaxAtomicAccessSize(CGM, arch)) {
544 Kind = CopyStruct;
545 return;
546 }
547
548 // Otherwise, we can use native loads and stores.
549 Kind = Native;
550}
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000551
552/// GenerateObjCGetter - Generate an Objective-C property getter
Steve Naroff5a7dd782009-01-10 22:55:25 +0000553/// function. The given Decl must be an ObjCImplementationDecl. @synthesize
554/// is illegal within a category.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +0000555void CodeGenFunction::GenerateObjCGetter(ObjCImplementationDecl *IMP,
556 const ObjCPropertyImplDecl *PID) {
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000557 const ObjCPropertyDecl *PD = PID->getPropertyDecl();
558 ObjCMethodDecl *OMD = PD->getGetterMethodDecl();
559 assert(OMD && "Invalid call to generate getter (empty method)");
Devang Patele7ce5402011-05-19 23:37:41 +0000560 StartObjCMethod(OMD, IMP->getClassInterface(), PID->getLocStart());
Mike Stump11289f42009-09-09 15:08:12 +0000561
John McCallf4528ae2011-09-13 03:34:09 +0000562 generateObjCGetterBody(IMP, PID);
563
564 FinishFunction();
565}
566
567static bool hasTrivialGetExpr(const ObjCPropertyImplDecl *PID) {
568 const Expr *getter = PID->getGetterCXXConstructor();
569 if (!getter) return true;
570
571 // Sema only makes only of these when the ivar has a C++ class type,
572 // so the form is pretty constrained.
573
574 // If we selected a trivial copy-constructor, we're okay.
575 if (const CXXConstructExpr *construct = dyn_cast<CXXConstructExpr>(getter))
576 return (construct->getConstructor()->isTrivial());
577
578 // The constructor might require cleanups (in which case it's never
579 // trivial).
580 assert(isa<ExprWithCleanups>(getter));
581 return false;
582}
583
584void
585CodeGenFunction::generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
586 const ObjCPropertyImplDecl *propImpl) {
587 // If there's a non-trivial 'get' expression, we just have to emit that.
588 if (!hasTrivialGetExpr(propImpl)) {
589 ReturnStmt ret(SourceLocation(), propImpl->getGetterCXXConstructor(),
590 /*nrvo*/ 0);
591 EmitReturnStmt(ret);
592 return;
593 }
594
595 const ObjCPropertyDecl *prop = propImpl->getPropertyDecl();
596 QualType propType = prop->getType();
597 ObjCMethodDecl *getterMethod = prop->getGetterMethodDecl();
598
599 ObjCIvarDecl *ivar = propImpl->getPropertyIvarDecl();
600
601 // Pick an implementation strategy.
602 PropertyImplStrategy strategy(CGM, propImpl);
603 switch (strategy.getKind()) {
604 case PropertyImplStrategy::Native: {
605 LValue LV = EmitLValueForIvar(TypeOfSelfObject(), LoadObjCSelf(), ivar, 0);
606
607 // Currently, all atomic accesses have to be through integer
608 // types, so there's no point in trying to pick a prettier type.
609 llvm::Type *bitcastType =
610 llvm::Type::getIntNTy(getLLVMContext(),
611 getContext().toBits(strategy.getIvarSize()));
612 bitcastType = bitcastType->getPointerTo(); // addrspace 0 okay
613
614 // Perform an atomic load. This does not impose ordering constraints.
615 llvm::Value *ivarAddr = LV.getAddress();
616 ivarAddr = Builder.CreateBitCast(ivarAddr, bitcastType);
617 llvm::LoadInst *load = Builder.CreateLoad(ivarAddr, "load");
618 load->setAlignment(strategy.getIvarAlignment().getQuantity());
619 load->setAtomic(llvm::Unordered);
620
621 // Store that value into the return address. Doing this with a
622 // bitcast is likely to produce some pretty ugly IR, but it's not
623 // the *most* terrible thing in the world.
624 Builder.CreateStore(load, Builder.CreateBitCast(ReturnValue, bitcastType));
625
626 // Make sure we don't do an autorelease.
627 AutoreleaseResult = false;
628 return;
629 }
630
631 case PropertyImplStrategy::GetSetProperty: {
632 llvm::Value *getPropertyFn =
633 CGM.getObjCRuntime().GetPropertyGetFunction();
634 if (!getPropertyFn) {
635 CGM.ErrorUnsupported(propImpl, "Obj-C getter requiring atomic copy");
Daniel Dunbara08dff12008-09-24 04:04:31 +0000636 return;
637 }
638
639 // Return (ivar-type) objc_getProperty((id) self, _cmd, offset, true).
640 // FIXME: Can't this be simpler? This might even be worse than the
641 // corresponding gcc code.
John McCallf4528ae2011-09-13 03:34:09 +0000642 llvm::Value *cmd =
643 Builder.CreateLoad(LocalDeclMap[getterMethod->getCmdDecl()], "cmd");
644 llvm::Value *self = Builder.CreateBitCast(LoadObjCSelf(), VoidPtrTy);
645 llvm::Value *ivarOffset =
646 EmitIvarOffset(classImpl->getClassInterface(), ivar);
647
648 CallArgList args;
649 args.add(RValue::get(self), getContext().getObjCIdType());
650 args.add(RValue::get(cmd), getContext().getObjCSelType());
651 args.add(RValue::get(ivarOffset), getContext().getPointerDiffType());
652
653 assert(strategy.isAtomic());
654 args.add(RValue::get(Builder.getTrue()), getContext().BoolTy);
655
Daniel Dunbar1ef73732009-02-03 23:43:59 +0000656 // FIXME: We shouldn't need to get the function info here, the
657 // runtime already should have computed it to build the function.
John McCallf4528ae2011-09-13 03:34:09 +0000658 RValue RV = EmitCall(getTypes().getFunctionInfo(propType, args,
John McCallb923ece2011-09-12 23:06:44 +0000659 FunctionType::ExtInfo()),
John McCallf4528ae2011-09-13 03:34:09 +0000660 getPropertyFn, ReturnValueSlot(), args);
661
Daniel Dunbara08dff12008-09-24 04:04:31 +0000662 // We need to fix the type here. Ivars with copy & retain are
663 // always objects so we don't need to worry about complex or
664 // aggregates.
Mike Stump11289f42009-09-09 15:08:12 +0000665 RV = RValue::get(Builder.CreateBitCast(RV.getScalarVal(),
John McCallf4528ae2011-09-13 03:34:09 +0000666 getTypes().ConvertType(propType)));
667
668 EmitReturnOfRValue(RV, propType);
John McCall31168b02011-06-15 23:02:42 +0000669
670 // objc_getProperty does an autorelease, so we should suppress ours.
671 AutoreleaseResult = false;
John McCall31168b02011-06-15 23:02:42 +0000672
John McCallf4528ae2011-09-13 03:34:09 +0000673 return;
674 }
675
676 case PropertyImplStrategy::CopyStruct:
677 emitStructGetterCall(*this, ivar, strategy.isAtomic(),
678 strategy.hasStrongMember());
679 return;
680
681 case PropertyImplStrategy::Expression:
682 case PropertyImplStrategy::SetPropertyAndExpressionGet: {
683 LValue LV = EmitLValueForIvar(TypeOfSelfObject(), LoadObjCSelf(), ivar, 0);
684
685 QualType ivarType = ivar->getType();
686 if (ivarType->isAnyComplexType()) {
687 ComplexPairTy pair = LoadComplexFromAddr(LV.getAddress(),
688 LV.isVolatileQualified());
689 StoreComplexToAddr(pair, ReturnValue, LV.isVolatileQualified());
690 } else if (hasAggregateLLVMType(ivarType)) {
691 // The return value slot is guaranteed to not be aliased, but
692 // that's not necessarily the same as "on the stack", so
693 // we still potentially need objc_memmove_collectable.
694 EmitAggregateCopy(ReturnValue, LV.getAddress(), ivarType);
695 } else {
John McCall24fada12011-07-22 05:23:13 +0000696 llvm::Value *value;
697 if (propType->isReferenceType()) {
698 value = LV.getAddress();
699 } else {
700 // We want to load and autoreleaseReturnValue ARC __weak ivars.
701 if (LV.getQuals().getObjCLifetime() == Qualifiers::OCL_Weak) {
John McCallf4528ae2011-09-13 03:34:09 +0000702 value = emitARCRetainLoadOfScalar(*this, LV, ivarType);
John McCall24fada12011-07-22 05:23:13 +0000703
704 // Otherwise we want to do a simple load, suppressing the
705 // final autorelease.
John McCall31168b02011-06-15 23:02:42 +0000706 } else {
John McCall24fada12011-07-22 05:23:13 +0000707 value = EmitLoadOfLValue(LV).getScalarVal();
708 AutoreleaseResult = false;
Fariborz Jahanianb24b5682011-03-28 23:47:18 +0000709 }
John McCall31168b02011-06-15 23:02:42 +0000710
John McCall24fada12011-07-22 05:23:13 +0000711 value = Builder.CreateBitCast(value, ConvertType(propType));
712 }
713
714 EmitReturnOfRValue(RValue::get(value), propType);
Fariborz Jahanianeab5ecd2009-03-03 18:49:40 +0000715 }
John McCallf4528ae2011-09-13 03:34:09 +0000716 return;
Daniel Dunbara08dff12008-09-24 04:04:31 +0000717 }
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000718
John McCallf4528ae2011-09-13 03:34:09 +0000719 }
720 llvm_unreachable("bad @property implementation strategy!");
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000721}
722
John McCallb923ece2011-09-12 23:06:44 +0000723/// emitStructSetterCall - Call the runtime function to store the value
724/// from the first formal parameter into the given ivar.
725static void emitStructSetterCall(CodeGenFunction &CGF, ObjCMethodDecl *OMD,
726 ObjCIvarDecl *ivar) {
Fariborz Jahanian302a3d42011-02-18 19:15:13 +0000727 // objc_copyStruct (&structIvar, &Arg,
728 // sizeof (struct something), true, false);
John McCall6acaef92011-09-10 09:30:49 +0000729 CallArgList args;
730
731 // The first argument is the address of the ivar.
John McCallb923ece2011-09-12 23:06:44 +0000732 llvm::Value *ivarAddr = CGF.EmitLValueForIvar(CGF.TypeOfSelfObject(),
733 CGF.LoadObjCSelf(), ivar, 0)
734 .getAddress();
735 ivarAddr = CGF.Builder.CreateBitCast(ivarAddr, CGF.Int8PtrTy);
736 args.add(RValue::get(ivarAddr), CGF.getContext().VoidPtrTy);
John McCall6acaef92011-09-10 09:30:49 +0000737
738 // The second argument is the address of the parameter variable.
John McCallb923ece2011-09-12 23:06:44 +0000739 ParmVarDecl *argVar = *OMD->param_begin();
740 DeclRefExpr argRef(argVar, argVar->getType(), VK_LValue, SourceLocation());
741 llvm::Value *argAddr = CGF.EmitLValue(&argRef).getAddress();
742 argAddr = CGF.Builder.CreateBitCast(argAddr, CGF.Int8PtrTy);
743 args.add(RValue::get(argAddr), CGF.getContext().VoidPtrTy);
John McCall6acaef92011-09-10 09:30:49 +0000744
745 // The third argument is the sizeof the type.
746 llvm::Value *size =
John McCallb923ece2011-09-12 23:06:44 +0000747 CGF.CGM.getSize(CGF.getContext().getTypeSizeInChars(ivar->getType()));
748 args.add(RValue::get(size), CGF.getContext().getSizeType());
John McCall6acaef92011-09-10 09:30:49 +0000749
John McCallb923ece2011-09-12 23:06:44 +0000750 // The fourth argument is the 'isAtomic' flag.
751 args.add(RValue::get(CGF.Builder.getTrue()), CGF.getContext().BoolTy);
John McCall6acaef92011-09-10 09:30:49 +0000752
John McCallb923ece2011-09-12 23:06:44 +0000753 // The fifth argument is the 'hasStrong' flag.
754 // FIXME: should this really always be false?
755 args.add(RValue::get(CGF.Builder.getFalse()), CGF.getContext().BoolTy);
756
757 llvm::Value *copyStructFn = CGF.CGM.getObjCRuntime().GetSetStructFunction();
758 CGF.EmitCall(CGF.getTypes().getFunctionInfo(CGF.getContext().VoidTy, args,
759 FunctionType::ExtInfo()),
760 copyStructFn, ReturnValueSlot(), args);
Fariborz Jahanian302a3d42011-02-18 19:15:13 +0000761}
762
John McCallf4528ae2011-09-13 03:34:09 +0000763static bool hasTrivialSetExpr(const ObjCPropertyImplDecl *PID) {
764 Expr *setter = PID->getSetterCXXAssignment();
765 if (!setter) return true;
766
767 // Sema only makes only of these when the ivar has a C++ class type,
768 // so the form is pretty constrained.
John McCall7f16c422011-09-10 09:17:20 +0000769
770 // An operator call is trivial if the function it calls is trivial.
John McCallf4528ae2011-09-13 03:34:09 +0000771 // This also implies that there's nothing non-trivial going on with
772 // the arguments, because operator= can only be trivial if it's a
773 // synthesized assignment operator and therefore both parameters are
774 // references.
775 if (CallExpr *call = dyn_cast<CallExpr>(setter)) {
John McCall7f16c422011-09-10 09:17:20 +0000776 if (const FunctionDecl *callee
777 = dyn_cast_or_null<FunctionDecl>(call->getCalleeDecl()))
778 if (callee->isTrivial())
779 return true;
780 return false;
Fariborz Jahanian5de53132011-04-06 16:05:26 +0000781 }
John McCall7f16c422011-09-10 09:17:20 +0000782
John McCallf4528ae2011-09-13 03:34:09 +0000783 assert(isa<ExprWithCleanups>(setter));
John McCall7f16c422011-09-10 09:17:20 +0000784 return false;
785}
786
John McCall7f16c422011-09-10 09:17:20 +0000787void
788CodeGenFunction::generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
789 const ObjCPropertyImplDecl *propImpl) {
790 // Just use the setter expression if Sema gave us one and it's
791 // non-trivial. There's no way to do this atomically.
John McCallf4528ae2011-09-13 03:34:09 +0000792 if (!hasTrivialSetExpr(propImpl)) {
John McCall7f16c422011-09-10 09:17:20 +0000793 EmitStmt(propImpl->getSetterCXXAssignment());
794 return;
795 }
796
797 const ObjCPropertyDecl *prop = propImpl->getPropertyDecl();
798 ObjCIvarDecl *ivar = propImpl->getPropertyIvarDecl();
799 ObjCMethodDecl *setterMethod = prop->getSetterMethodDecl();
800
John McCallf4528ae2011-09-13 03:34:09 +0000801 PropertyImplStrategy strategy(CGM, propImpl);
802 switch (strategy.getKind()) {
803 case PropertyImplStrategy::Native: {
804 llvm::Value *argAddr = LocalDeclMap[*setterMethod->param_begin()];
John McCall7f16c422011-09-10 09:17:20 +0000805
John McCallf4528ae2011-09-13 03:34:09 +0000806 LValue ivarLValue =
807 EmitLValueForIvar(TypeOfSelfObject(), LoadObjCSelf(), ivar, /*quals*/ 0);
808 llvm::Value *ivarAddr = ivarLValue.getAddress();
John McCall7f16c422011-09-10 09:17:20 +0000809
John McCallf4528ae2011-09-13 03:34:09 +0000810 // Currently, all atomic accesses have to be through integer
811 // types, so there's no point in trying to pick a prettier type.
812 llvm::Type *bitcastType =
813 llvm::Type::getIntNTy(getLLVMContext(),
814 getContext().toBits(strategy.getIvarSize()));
815 bitcastType = bitcastType->getPointerTo(); // addrspace 0 okay
816
817 // Cast both arguments to the chosen operation type.
818 argAddr = Builder.CreateBitCast(argAddr, bitcastType);
819 ivarAddr = Builder.CreateBitCast(ivarAddr, bitcastType);
820
821 // This bitcast load is likely to cause some nasty IR.
822 llvm::Value *load = Builder.CreateLoad(argAddr);
823
824 // Perform an atomic store. There are no memory ordering requirements.
825 llvm::StoreInst *store = Builder.CreateStore(load, ivarAddr);
826 store->setAlignment(strategy.getIvarAlignment().getQuantity());
827 store->setAtomic(llvm::Unordered);
828 return;
829 }
830
831 case PropertyImplStrategy::GetSetProperty:
832 case PropertyImplStrategy::SetPropertyAndExpressionGet: {
John McCall7f16c422011-09-10 09:17:20 +0000833 llvm::Value *setPropertyFn =
834 CGM.getObjCRuntime().GetPropertySetFunction();
835 if (!setPropertyFn) {
836 CGM.ErrorUnsupported(propImpl, "Obj-C setter requiring atomic copy");
837 return;
838 }
839
840 // Emit objc_setProperty((id) self, _cmd, offset, arg,
841 // <is-atomic>, <is-copy>).
842 llvm::Value *cmd =
843 Builder.CreateLoad(LocalDeclMap[setterMethod->getCmdDecl()]);
844 llvm::Value *self =
845 Builder.CreateBitCast(LoadObjCSelf(), VoidPtrTy);
846 llvm::Value *ivarOffset =
847 EmitIvarOffset(classImpl->getClassInterface(), ivar);
848 llvm::Value *arg = LocalDeclMap[*setterMethod->param_begin()];
849 arg = Builder.CreateBitCast(Builder.CreateLoad(arg, "arg"), VoidPtrTy);
850
851 CallArgList args;
852 args.add(RValue::get(self), getContext().getObjCIdType());
853 args.add(RValue::get(cmd), getContext().getObjCSelType());
854 args.add(RValue::get(ivarOffset), getContext().getPointerDiffType());
855 args.add(RValue::get(arg), getContext().getObjCIdType());
John McCallf4528ae2011-09-13 03:34:09 +0000856 args.add(RValue::get(Builder.getInt1(strategy.isAtomic())),
857 getContext().BoolTy);
858 args.add(RValue::get(Builder.getInt1(strategy.isCopy())),
859 getContext().BoolTy);
John McCall7f16c422011-09-10 09:17:20 +0000860 // FIXME: We shouldn't need to get the function info here, the runtime
861 // already should have computed it to build the function.
862 EmitCall(getTypes().getFunctionInfo(getContext().VoidTy, args,
863 FunctionType::ExtInfo()),
864 setPropertyFn, ReturnValueSlot(), args);
865 return;
866 }
867
John McCallf4528ae2011-09-13 03:34:09 +0000868 case PropertyImplStrategy::CopyStruct:
John McCallb923ece2011-09-12 23:06:44 +0000869 emitStructSetterCall(*this, setterMethod, ivar);
John McCall7f16c422011-09-10 09:17:20 +0000870 return;
John McCallf4528ae2011-09-13 03:34:09 +0000871
872 case PropertyImplStrategy::Expression:
873 break;
John McCall7f16c422011-09-10 09:17:20 +0000874 }
875
876 // Otherwise, fake up some ASTs and emit a normal assignment.
877 ValueDecl *selfDecl = setterMethod->getSelfDecl();
878 DeclRefExpr self(selfDecl, selfDecl->getType(), VK_LValue, SourceLocation());
879 ImplicitCastExpr selfLoad(ImplicitCastExpr::OnStack,
880 selfDecl->getType(), CK_LValueToRValue, &self,
881 VK_RValue);
882 ObjCIvarRefExpr ivarRef(ivar, ivar->getType().getNonReferenceType(),
883 SourceLocation(), &selfLoad, true, true);
884
885 ParmVarDecl *argDecl = *setterMethod->param_begin();
886 QualType argType = argDecl->getType().getNonReferenceType();
887 DeclRefExpr arg(argDecl, argType, VK_LValue, SourceLocation());
888 ImplicitCastExpr argLoad(ImplicitCastExpr::OnStack,
889 argType.getUnqualifiedType(), CK_LValueToRValue,
890 &arg, VK_RValue);
891
892 // The property type can differ from the ivar type in some situations with
893 // Objective-C pointer types, we can always bit cast the RHS in these cases.
894 // The following absurdity is just to ensure well-formed IR.
895 CastKind argCK = CK_NoOp;
896 if (ivarRef.getType()->isObjCObjectPointerType()) {
897 if (argLoad.getType()->isObjCObjectPointerType())
898 argCK = CK_BitCast;
899 else if (argLoad.getType()->isBlockPointerType())
900 argCK = CK_BlockPointerToObjCPointerCast;
901 else
902 argCK = CK_CPointerToObjCPointerCast;
903 } else if (ivarRef.getType()->isBlockPointerType()) {
904 if (argLoad.getType()->isBlockPointerType())
905 argCK = CK_BitCast;
906 else
907 argCK = CK_AnyPointerToBlockPointerCast;
908 } else if (ivarRef.getType()->isPointerType()) {
909 argCK = CK_BitCast;
910 }
911 ImplicitCastExpr argCast(ImplicitCastExpr::OnStack,
912 ivarRef.getType(), argCK, &argLoad,
913 VK_RValue);
914 Expr *finalArg = &argLoad;
915 if (!getContext().hasSameUnqualifiedType(ivarRef.getType(),
916 argLoad.getType()))
917 finalArg = &argCast;
918
919
920 BinaryOperator assign(&ivarRef, finalArg, BO_Assign,
921 ivarRef.getType(), VK_RValue, OK_Ordinary,
922 SourceLocation());
923 EmitStmt(&assign);
Fariborz Jahanian5de53132011-04-06 16:05:26 +0000924}
925
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000926/// GenerateObjCSetter - Generate an Objective-C property setter
Steve Naroff5a7dd782009-01-10 22:55:25 +0000927/// function. The given Decl must be an ObjCImplementationDecl. @synthesize
928/// is illegal within a category.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +0000929void CodeGenFunction::GenerateObjCSetter(ObjCImplementationDecl *IMP,
930 const ObjCPropertyImplDecl *PID) {
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000931 const ObjCPropertyDecl *PD = PID->getPropertyDecl();
932 ObjCMethodDecl *OMD = PD->getSetterMethodDecl();
933 assert(OMD && "Invalid call to generate setter (empty method)");
Devang Patele7ce5402011-05-19 23:37:41 +0000934 StartObjCMethod(OMD, IMP->getClassInterface(), PID->getLocStart());
Daniel Dunbar5449ce52008-09-24 06:32:09 +0000935
John McCall7f16c422011-09-10 09:17:20 +0000936 generateObjCSetterBody(IMP, PID);
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000937
938 FinishFunction();
Chris Lattner5696e7b2008-06-17 18:05:57 +0000939}
940
John McCall6a4fa522011-03-22 07:05:39 +0000941namespace {
John McCall4bd0fb12011-07-12 16:41:08 +0000942 struct DestroyIvar : EHScopeStack::Cleanup {
943 private:
944 llvm::Value *addr;
John McCall6a4fa522011-03-22 07:05:39 +0000945 const ObjCIvarDecl *ivar;
John McCall4bd0fb12011-07-12 16:41:08 +0000946 CodeGenFunction::Destroyer &destroyer;
947 bool useEHCleanupForArray;
948 public:
949 DestroyIvar(llvm::Value *addr, const ObjCIvarDecl *ivar,
950 CodeGenFunction::Destroyer *destroyer,
951 bool useEHCleanupForArray)
952 : addr(addr), ivar(ivar), destroyer(*destroyer),
953 useEHCleanupForArray(useEHCleanupForArray) {}
John McCall6a4fa522011-03-22 07:05:39 +0000954
John McCall30317fd2011-07-12 20:27:29 +0000955 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCall4bd0fb12011-07-12 16:41:08 +0000956 LValue lvalue
957 = CGF.EmitLValueForIvar(CGF.TypeOfSelfObject(), addr, ivar, /*CVR*/ 0);
958 CGF.emitDestroy(lvalue.getAddress(), ivar->getType(), destroyer,
John McCall30317fd2011-07-12 20:27:29 +0000959 flags.isForNormalCleanup() && useEHCleanupForArray);
John McCall6a4fa522011-03-22 07:05:39 +0000960 }
961 };
962}
963
John McCall4bd0fb12011-07-12 16:41:08 +0000964/// Like CodeGenFunction::destroyARCStrong, but do it with a call.
965static void destroyARCStrongWithStore(CodeGenFunction &CGF,
966 llvm::Value *addr,
967 QualType type) {
968 llvm::Value *null = getNullForVariable(addr);
969 CGF.EmitARCStoreStrongCall(addr, null, /*ignored*/ true);
970}
John McCall31168b02011-06-15 23:02:42 +0000971
John McCall6a4fa522011-03-22 07:05:39 +0000972static void emitCXXDestructMethod(CodeGenFunction &CGF,
973 ObjCImplementationDecl *impl) {
974 CodeGenFunction::RunCleanupsScope scope(CGF);
975
976 llvm::Value *self = CGF.LoadObjCSelf();
977
Jordy Rosea91768e2011-07-22 02:08:32 +0000978 const ObjCInterfaceDecl *iface = impl->getClassInterface();
979 for (const ObjCIvarDecl *ivar = iface->all_declared_ivar_begin();
John McCall6a4fa522011-03-22 07:05:39 +0000980 ivar; ivar = ivar->getNextIvar()) {
981 QualType type = ivar->getType();
982
John McCall6a4fa522011-03-22 07:05:39 +0000983 // Check whether the ivar is a destructible type.
John McCall4bd0fb12011-07-12 16:41:08 +0000984 QualType::DestructionKind dtorKind = type.isDestructedType();
985 if (!dtorKind) continue;
John McCall6a4fa522011-03-22 07:05:39 +0000986
John McCall4bd0fb12011-07-12 16:41:08 +0000987 CodeGenFunction::Destroyer *destroyer = 0;
John McCall6a4fa522011-03-22 07:05:39 +0000988
John McCall4bd0fb12011-07-12 16:41:08 +0000989 // Use a call to objc_storeStrong to destroy strong ivars, for the
990 // general benefit of the tools.
991 if (dtorKind == QualType::DK_objc_strong_lifetime) {
992 destroyer = &destroyARCStrongWithStore;
John McCall31168b02011-06-15 23:02:42 +0000993
John McCall4bd0fb12011-07-12 16:41:08 +0000994 // Otherwise use the default for the destruction kind.
995 } else {
996 destroyer = &CGF.getDestroyer(dtorKind);
John McCall6a4fa522011-03-22 07:05:39 +0000997 }
John McCall4bd0fb12011-07-12 16:41:08 +0000998
999 CleanupKind cleanupKind = CGF.getCleanupKind(dtorKind);
1000
1001 CGF.EHStack.pushCleanup<DestroyIvar>(cleanupKind, self, ivar, destroyer,
1002 cleanupKind & EHCleanup);
John McCall6a4fa522011-03-22 07:05:39 +00001003 }
1004
1005 assert(scope.requiresCleanups() && "nothing to do in .cxx_destruct?");
1006}
1007
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001008void CodeGenFunction::GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1009 ObjCMethodDecl *MD,
1010 bool ctor) {
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001011 MD->createImplicitParams(CGM.getContext(), IMP->getClassInterface());
Devang Patele7ce5402011-05-19 23:37:41 +00001012 StartObjCMethod(MD, IMP->getClassInterface(), MD->getLocStart());
John McCall6a4fa522011-03-22 07:05:39 +00001013
1014 // Emit .cxx_construct.
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001015 if (ctor) {
John McCall31168b02011-06-15 23:02:42 +00001016 // Suppress the final autorelease in ARC.
1017 AutoreleaseResult = false;
1018
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001019 SmallVector<CXXCtorInitializer *, 8> IvarInitializers;
John McCall6a4fa522011-03-22 07:05:39 +00001020 for (ObjCImplementationDecl::init_const_iterator B = IMP->init_begin(),
1021 E = IMP->init_end(); B != E; ++B) {
1022 CXXCtorInitializer *IvarInit = (*B);
Francois Pichetd583da02010-12-04 09:14:42 +00001023 FieldDecl *Field = IvarInit->getAnyMember();
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001024 ObjCIvarDecl *Ivar = cast<ObjCIvarDecl>(Field);
Fariborz Jahanian499b9022010-04-28 22:30:33 +00001025 LValue LV = EmitLValueForIvar(TypeOfSelfObject(),
1026 LoadObjCSelf(), Ivar, 0);
John McCall8d6fc952011-08-25 20:40:09 +00001027 EmitAggExpr(IvarInit->getInit(),
1028 AggValueSlot::forLValue(LV, AggValueSlot::IsDestructed,
John McCalla5efa732011-08-25 23:04:34 +00001029 AggValueSlot::DoesNotNeedGCBarriers,
1030 AggValueSlot::IsNotAliased));
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001031 }
1032 // constructor returns 'self'.
1033 CodeGenTypes &Types = CGM.getTypes();
1034 QualType IdTy(CGM.getContext().getObjCIdType());
1035 llvm::Value *SelfAsId =
1036 Builder.CreateBitCast(LoadObjCSelf(), Types.ConvertType(IdTy));
1037 EmitReturnOfRValue(RValue::get(SelfAsId), IdTy);
John McCall6a4fa522011-03-22 07:05:39 +00001038
1039 // Emit .cxx_destruct.
Chandler Carruthf3983652010-05-06 00:20:39 +00001040 } else {
John McCall6a4fa522011-03-22 07:05:39 +00001041 emitCXXDestructMethod(*this, IMP);
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001042 }
1043 FinishFunction();
1044}
1045
Fariborz Jahanian08b0f662010-04-13 00:38:05 +00001046bool CodeGenFunction::IndirectObjCSetterArg(const CGFunctionInfo &FI) {
1047 CGFunctionInfo::const_arg_iterator it = FI.arg_begin();
1048 it++; it++;
1049 const ABIArgInfo &AI = it->info;
1050 // FIXME. Is this sufficient check?
1051 return (AI.getKind() == ABIArgInfo::Indirect);
1052}
1053
Fariborz Jahanian7e9d52a2010-04-13 18:32:24 +00001054bool CodeGenFunction::IvarTypeWithAggrGCObjects(QualType Ty) {
1055 if (CGM.getLangOptions().getGCMode() == LangOptions::NonGC)
1056 return false;
1057 if (const RecordType *FDTTy = Ty.getTypePtr()->getAs<RecordType>())
1058 return FDTTy->getDecl()->hasObjectMember();
1059 return false;
1060}
1061
Daniel Dunbara08dff12008-09-24 04:04:31 +00001062llvm::Value *CodeGenFunction::LoadObjCSelf() {
Daniel Dunbara94ecd22008-08-16 03:19:19 +00001063 const ObjCMethodDecl *OMD = cast<ObjCMethodDecl>(CurFuncDecl);
1064 return Builder.CreateLoad(LocalDeclMap[OMD->getSelfDecl()], "self");
Chris Lattner5696e7b2008-06-17 18:05:57 +00001065}
1066
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00001067QualType CodeGenFunction::TypeOfSelfObject() {
1068 const ObjCMethodDecl *OMD = cast<ObjCMethodDecl>(CurFuncDecl);
1069 ImplicitParamDecl *selfDecl = OMD->getSelfDecl();
Steve Naroff7cae42b2009-07-10 23:34:53 +00001070 const ObjCObjectPointerType *PTy = cast<ObjCObjectPointerType>(
1071 getContext().getCanonicalType(selfDecl->getType()));
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00001072 return PTy->getPointeeType();
1073}
1074
John McCall0692a322010-12-04 03:11:00 +00001075LValue
1076CodeGenFunction::EmitObjCPropertyRefLValue(const ObjCPropertyRefExpr *E) {
1077 // This is a special l-value that just issues sends when we load or
1078 // store through it.
1079
1080 // For certain base kinds, we need to emit the base immediately.
1081 llvm::Value *Base;
1082 if (E->isSuperReceiver())
1083 Base = LoadObjCSelf();
1084 else if (E->isClassReceiver())
1085 Base = CGM.getObjCRuntime().GetClass(Builder, E->getClassReceiver());
1086 else
1087 Base = EmitScalarExpr(E->getBase());
1088 return LValue::MakePropertyRef(E, Base);
1089}
1090
1091static RValue GenerateMessageSendSuper(CodeGenFunction &CGF,
1092 ReturnValueSlot Return,
1093 QualType ResultType,
1094 Selector S,
1095 llvm::Value *Receiver,
1096 const CallArgList &CallArgs) {
1097 const ObjCMethodDecl *OMD = cast<ObjCMethodDecl>(CGF.CurFuncDecl);
Fariborz Jahanian391d4fc2009-03-20 19:18:21 +00001098 bool isClassMessage = OMD->isClassMethod();
1099 bool isCategoryImpl = isa<ObjCCategoryImplDecl>(OMD->getDeclContext());
John McCall0692a322010-12-04 03:11:00 +00001100 return CGF.CGM.getObjCRuntime()
1101 .GenerateMessageSendSuper(CGF, Return, ResultType,
1102 S, OMD->getClassInterface(),
1103 isCategoryImpl, Receiver,
1104 isClassMessage, CallArgs);
Fariborz Jahanian391d4fc2009-03-20 19:18:21 +00001105}
1106
John McCallf3eb96f2010-12-04 02:32:38 +00001107RValue CodeGenFunction::EmitLoadOfPropertyRefLValue(LValue LV,
1108 ReturnValueSlot Return) {
1109 const ObjCPropertyRefExpr *E = LV.getPropertyRefExpr();
Fariborz Jahanian7a26ba42011-03-30 16:11:20 +00001110 QualType ResultType = E->getGetterResultType();
John McCallb7bd14f2010-12-02 01:19:52 +00001111 Selector S;
Douglas Gregor33823722011-06-11 01:09:30 +00001112 const ObjCMethodDecl *method;
John McCallb7bd14f2010-12-02 01:19:52 +00001113 if (E->isExplicitProperty()) {
1114 const ObjCPropertyDecl *Property = E->getExplicitProperty();
1115 S = Property->getGetterName();
Douglas Gregor33823722011-06-11 01:09:30 +00001116 method = Property->getGetterMethodDecl();
Mike Stump658fe022009-07-30 22:28:39 +00001117 } else {
Douglas Gregor33823722011-06-11 01:09:30 +00001118 method = E->getImplicitPropertyGetter();
1119 S = method->getSelector();
Fariborz Jahanian9ac53512008-11-22 22:30:21 +00001120 }
John McCallb7bd14f2010-12-02 01:19:52 +00001121
John McCallf3eb96f2010-12-04 02:32:38 +00001122 llvm::Value *Receiver = LV.getPropertyRefBaseAddr();
John McCall0692a322010-12-04 03:11:00 +00001123
John McCall31168b02011-06-15 23:02:42 +00001124 if (CGM.getLangOptions().ObjCAutoRefCount) {
1125 QualType receiverType;
1126 if (E->isSuperReceiver())
1127 receiverType = E->getSuperReceiverType();
1128 else if (E->isClassReceiver())
1129 receiverType = getContext().getObjCClassType();
1130 else
1131 receiverType = E->getBase()->getType();
1132 }
1133
John McCall0692a322010-12-04 03:11:00 +00001134 // Accesses to 'super' follow a different code path.
1135 if (E->isSuperReceiver())
Douglas Gregor33823722011-06-11 01:09:30 +00001136 return AdjustRelatedResultType(*this, E, method,
1137 GenerateMessageSendSuper(*this, Return,
1138 ResultType,
1139 S, Receiver,
1140 CallArgList()));
John McCallf3eb96f2010-12-04 02:32:38 +00001141 const ObjCInterfaceDecl *ReceiverClass
1142 = (E->isClassReceiver() ? E->getClassReceiver() : 0);
Douglas Gregor33823722011-06-11 01:09:30 +00001143 return AdjustRelatedResultType(*this, E, method,
John McCall31168b02011-06-15 23:02:42 +00001144 CGM.getObjCRuntime().
1145 GenerateMessageSend(*this, Return, ResultType, S,
1146 Receiver, CallArgList(), ReceiverClass));
Daniel Dunbar55310df2008-08-27 06:57:25 +00001147}
1148
John McCallf3eb96f2010-12-04 02:32:38 +00001149void CodeGenFunction::EmitStoreThroughPropertyRefLValue(RValue Src,
1150 LValue Dst) {
1151 const ObjCPropertyRefExpr *E = Dst.getPropertyRefExpr();
John McCallb7bd14f2010-12-02 01:19:52 +00001152 Selector S = E->getSetterSelector();
Fariborz Jahanian7a26ba42011-03-30 16:11:20 +00001153 QualType ArgType = E->getSetterArgType();
1154
Fariborz Jahanian701f0942011-02-08 22:33:23 +00001155 // FIXME. Other than scalars, AST is not adequate for setter and
1156 // getter type mismatches which require conversion.
1157 if (Src.isScalar()) {
1158 llvm::Value *SrcVal = Src.getScalarVal();
1159 QualType DstType = getContext().getCanonicalType(ArgType);
Chris Lattner2192fe52011-07-18 04:24:23 +00001160 llvm::Type *DstTy = ConvertType(DstType);
Fariborz Jahanian701f0942011-02-08 22:33:23 +00001161 if (SrcVal->getType() != DstTy)
1162 Src =
1163 RValue::get(EmitScalarConversion(SrcVal, E->getType(), DstType));
1164 }
1165
John McCall0692a322010-12-04 03:11:00 +00001166 CallArgList Args;
Eli Friedman43dca6a2011-05-02 17:57:46 +00001167 Args.add(Src, ArgType);
John McCall0692a322010-12-04 03:11:00 +00001168
1169 llvm::Value *Receiver = Dst.getPropertyRefBaseAddr();
1170 QualType ResultType = getContext().VoidTy;
1171
John McCallb7bd14f2010-12-02 01:19:52 +00001172 if (E->isSuperReceiver()) {
John McCall0692a322010-12-04 03:11:00 +00001173 GenerateMessageSendSuper(*this, ReturnValueSlot(),
1174 ResultType, S, Receiver, Args);
John McCallb7bd14f2010-12-02 01:19:52 +00001175 return;
1176 }
1177
John McCallf3eb96f2010-12-04 02:32:38 +00001178 const ObjCInterfaceDecl *ReceiverClass
1179 = (E->isClassReceiver() ? E->getClassReceiver() : 0);
John McCallb7bd14f2010-12-02 01:19:52 +00001180
John McCallb7bd14f2010-12-02 01:19:52 +00001181 CGM.getObjCRuntime().GenerateMessageSend(*this, ReturnValueSlot(),
John McCall0692a322010-12-04 03:11:00 +00001182 ResultType, S, Receiver, Args,
1183 ReceiverClass);
Daniel Dunbar9e22c0d2008-08-29 08:11:39 +00001184}
1185
Chris Lattnerd4808922009-03-22 21:03:39 +00001186void CodeGenFunction::EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S){
Mike Stump11289f42009-09-09 15:08:12 +00001187 llvm::Constant *EnumerationMutationFn =
Daniel Dunbara08dff12008-09-24 04:04:31 +00001188 CGM.getObjCRuntime().EnumerationMutationFunction();
Mike Stump11289f42009-09-09 15:08:12 +00001189
Daniel Dunbara08dff12008-09-24 04:04:31 +00001190 if (!EnumerationMutationFn) {
1191 CGM.ErrorUnsupported(&S, "Obj-C fast enumeration for this runtime");
1192 return;
1193 }
1194
Devang Pateld2d66652011-01-19 01:36:36 +00001195 CGDebugInfo *DI = getDebugInfo();
1196 if (DI) {
1197 DI->setLocation(S.getSourceRange().getBegin());
1198 DI->EmitRegionStart(Builder);
1199 }
1200
Devang Patel297207f2011-06-13 23:15:32 +00001201 // The local variable comes into scope immediately.
1202 AutoVarEmission variable = AutoVarEmission::invalid();
1203 if (const DeclStmt *SD = dyn_cast<DeclStmt>(S.getElement()))
1204 variable = EmitAutoVarAlloca(*cast<VarDecl>(SD->getSingleDecl()));
1205
John McCall1c926b72011-01-07 01:49:06 +00001206 JumpDest LoopEnd = getJumpDestInCurrentScope("forcoll.end");
Mike Stump11289f42009-09-09 15:08:12 +00001207
Anders Carlsson75658592008-08-31 02:33:12 +00001208 // Fast enumeration state.
Douglas Gregor636e2002011-08-09 17:23:49 +00001209 QualType StateTy = CGM.getObjCFastEnumerationStateType();
Daniel Dunbara7566f12010-02-09 02:48:28 +00001210 llvm::Value *StatePtr = CreateMemTemp(StateTy, "state.ptr");
Anders Carlssonc0964b62010-05-22 17:35:42 +00001211 EmitNullInitialization(StatePtr, StateTy);
Mike Stump11289f42009-09-09 15:08:12 +00001212
Anders Carlsson75658592008-08-31 02:33:12 +00001213 // Number of elements in the items array.
Anders Carlsson3f35a262008-08-31 04:05:03 +00001214 static const unsigned NumItems = 16;
Mike Stump11289f42009-09-09 15:08:12 +00001215
John McCall1c926b72011-01-07 01:49:06 +00001216 // Fetch the countByEnumeratingWithState:objects:count: selector.
Benjamin Kramer9e649c32010-03-30 11:36:44 +00001217 IdentifierInfo *II[] = {
1218 &CGM.getContext().Idents.get("countByEnumeratingWithState"),
1219 &CGM.getContext().Idents.get("objects"),
1220 &CGM.getContext().Idents.get("count")
1221 };
1222 Selector FastEnumSel =
1223 CGM.getContext().Selectors.getSelector(llvm::array_lengthof(II), &II[0]);
Anders Carlsson75658592008-08-31 02:33:12 +00001224
1225 QualType ItemsTy =
1226 getContext().getConstantArrayType(getContext().getObjCIdType(),
Mike Stump11289f42009-09-09 15:08:12 +00001227 llvm::APInt(32, NumItems),
Anders Carlsson75658592008-08-31 02:33:12 +00001228 ArrayType::Normal, 0);
Daniel Dunbara7566f12010-02-09 02:48:28 +00001229 llvm::Value *ItemsPtr = CreateMemTemp(ItemsTy, "items.ptr");
Mike Stump11289f42009-09-09 15:08:12 +00001230
John McCall53848232011-07-27 01:07:15 +00001231 // Emit the collection pointer. In ARC, we do a retain.
1232 llvm::Value *Collection;
1233 if (getLangOptions().ObjCAutoRefCount) {
1234 Collection = EmitARCRetainScalarExpr(S.getCollection());
1235
1236 // Enter a cleanup to do the release.
1237 EmitObjCConsumeObject(S.getCollection()->getType(), Collection);
1238 } else {
1239 Collection = EmitScalarExpr(S.getCollection());
1240 }
Mike Stump11289f42009-09-09 15:08:12 +00001241
John McCall91e82dd2011-08-05 00:14:38 +00001242 // The 'continue' label needs to appear within the cleanup for the
1243 // collection object.
1244 JumpDest AfterBody = getJumpDestInCurrentScope("forcoll.next");
1245
John McCall1c926b72011-01-07 01:49:06 +00001246 // Send it our message:
Anders Carlsson75658592008-08-31 02:33:12 +00001247 CallArgList Args;
John McCall1c926b72011-01-07 01:49:06 +00001248
1249 // The first argument is a temporary of the enumeration-state type.
Eli Friedman43dca6a2011-05-02 17:57:46 +00001250 Args.add(RValue::get(StatePtr), getContext().getPointerType(StateTy));
Mike Stump11289f42009-09-09 15:08:12 +00001251
John McCall1c926b72011-01-07 01:49:06 +00001252 // The second argument is a temporary array with space for NumItems
1253 // pointers. We'll actually be loading elements from the array
1254 // pointer written into the control state; this buffer is so that
1255 // collections that *aren't* backed by arrays can still queue up
1256 // batches of elements.
Eli Friedman43dca6a2011-05-02 17:57:46 +00001257 Args.add(RValue::get(ItemsPtr), getContext().getPointerType(ItemsTy));
Mike Stump11289f42009-09-09 15:08:12 +00001258
John McCall1c926b72011-01-07 01:49:06 +00001259 // The third argument is the capacity of that temporary array.
Chris Lattner2192fe52011-07-18 04:24:23 +00001260 llvm::Type *UnsignedLongLTy = ConvertType(getContext().UnsignedLongTy);
Owen Andersonb7a2fe62009-07-24 23:12:58 +00001261 llvm::Constant *Count = llvm::ConstantInt::get(UnsignedLongLTy, NumItems);
Eli Friedman43dca6a2011-05-02 17:57:46 +00001262 Args.add(RValue::get(Count), getContext().UnsignedLongTy);
Mike Stump11289f42009-09-09 15:08:12 +00001263
John McCall1c926b72011-01-07 01:49:06 +00001264 // Start the enumeration.
Mike Stump11289f42009-09-09 15:08:12 +00001265 RValue CountRV =
John McCall78a15112010-05-22 01:48:05 +00001266 CGM.getObjCRuntime().GenerateMessageSend(*this, ReturnValueSlot(),
Anders Carlsson75658592008-08-31 02:33:12 +00001267 getContext().UnsignedLongTy,
1268 FastEnumSel,
David Chisnall01aa4672010-04-28 19:33:36 +00001269 Collection, Args);
Anders Carlsson75658592008-08-31 02:33:12 +00001270
John McCall1c926b72011-01-07 01:49:06 +00001271 // The initial number of objects that were returned in the buffer.
1272 llvm::Value *initialBufferLimit = CountRV.getScalarVal();
Mike Stump11289f42009-09-09 15:08:12 +00001273
John McCall1c926b72011-01-07 01:49:06 +00001274 llvm::BasicBlock *EmptyBB = createBasicBlock("forcoll.empty");
1275 llvm::BasicBlock *LoopInitBB = createBasicBlock("forcoll.loopinit");
Mike Stump11289f42009-09-09 15:08:12 +00001276
John McCall1c926b72011-01-07 01:49:06 +00001277 llvm::Value *zero = llvm::Constant::getNullValue(UnsignedLongLTy);
Anders Carlsson75658592008-08-31 02:33:12 +00001278
John McCall1c926b72011-01-07 01:49:06 +00001279 // If the limit pointer was zero to begin with, the collection is
1280 // empty; skip all this.
1281 Builder.CreateCondBr(Builder.CreateICmpEQ(initialBufferLimit, zero, "iszero"),
1282 EmptyBB, LoopInitBB);
Anders Carlsson75658592008-08-31 02:33:12 +00001283
John McCall1c926b72011-01-07 01:49:06 +00001284 // Otherwise, initialize the loop.
1285 EmitBlock(LoopInitBB);
Mike Stump11289f42009-09-09 15:08:12 +00001286
John McCall1c926b72011-01-07 01:49:06 +00001287 // Save the initial mutations value. This is the value at an
1288 // address that was written into the state object by
1289 // countByEnumeratingWithState:objects:count:.
Mike Stump11289f42009-09-09 15:08:12 +00001290 llvm::Value *StateMutationsPtrPtr =
Anders Carlsson3f35a262008-08-31 04:05:03 +00001291 Builder.CreateStructGEP(StatePtr, 2, "mutationsptr.ptr");
Mike Stump11289f42009-09-09 15:08:12 +00001292 llvm::Value *StateMutationsPtr = Builder.CreateLoad(StateMutationsPtrPtr,
Anders Carlsson3f35a262008-08-31 04:05:03 +00001293 "mutationsptr");
Mike Stump11289f42009-09-09 15:08:12 +00001294
John McCall1c926b72011-01-07 01:49:06 +00001295 llvm::Value *initialMutations =
1296 Builder.CreateLoad(StateMutationsPtr, "forcoll.initial-mutations");
Mike Stump11289f42009-09-09 15:08:12 +00001297
John McCall1c926b72011-01-07 01:49:06 +00001298 // Start looping. This is the point we return to whenever we have a
1299 // fresh, non-empty batch of objects.
1300 llvm::BasicBlock *LoopBodyBB = createBasicBlock("forcoll.loopbody");
1301 EmitBlock(LoopBodyBB);
Mike Stump11289f42009-09-09 15:08:12 +00001302
John McCall1c926b72011-01-07 01:49:06 +00001303 // The current index into the buffer.
Jay Foad20c0f022011-03-30 11:28:58 +00001304 llvm::PHINode *index = Builder.CreatePHI(UnsignedLongLTy, 3, "forcoll.index");
John McCall1c926b72011-01-07 01:49:06 +00001305 index->addIncoming(zero, LoopInitBB);
Anders Carlsson75658592008-08-31 02:33:12 +00001306
John McCall1c926b72011-01-07 01:49:06 +00001307 // The current buffer size.
Jay Foad20c0f022011-03-30 11:28:58 +00001308 llvm::PHINode *count = Builder.CreatePHI(UnsignedLongLTy, 3, "forcoll.count");
John McCall1c926b72011-01-07 01:49:06 +00001309 count->addIncoming(initialBufferLimit, LoopInitBB);
Mike Stump11289f42009-09-09 15:08:12 +00001310
John McCall1c926b72011-01-07 01:49:06 +00001311 // Check whether the mutations value has changed from where it was
1312 // at start. StateMutationsPtr should actually be invariant between
1313 // refreshes.
Anders Carlsson3f35a262008-08-31 04:05:03 +00001314 StateMutationsPtr = Builder.CreateLoad(StateMutationsPtrPtr, "mutationsptr");
John McCall1c926b72011-01-07 01:49:06 +00001315 llvm::Value *currentMutations
1316 = Builder.CreateLoad(StateMutationsPtr, "statemutations");
Anders Carlsson3f35a262008-08-31 04:05:03 +00001317
John McCall1c926b72011-01-07 01:49:06 +00001318 llvm::BasicBlock *WasMutatedBB = createBasicBlock("forcoll.mutated");
Dan Gohman6ca99822011-03-02 22:39:34 +00001319 llvm::BasicBlock *WasNotMutatedBB = createBasicBlock("forcoll.notmutated");
Mike Stump11289f42009-09-09 15:08:12 +00001320
John McCall1c926b72011-01-07 01:49:06 +00001321 Builder.CreateCondBr(Builder.CreateICmpEQ(currentMutations, initialMutations),
1322 WasNotMutatedBB, WasMutatedBB);
Mike Stump11289f42009-09-09 15:08:12 +00001323
John McCall1c926b72011-01-07 01:49:06 +00001324 // If so, call the enumeration-mutation function.
1325 EmitBlock(WasMutatedBB);
Anders Carlsson3f35a262008-08-31 04:05:03 +00001326 llvm::Value *V =
Mike Stump11289f42009-09-09 15:08:12 +00001327 Builder.CreateBitCast(Collection,
Anders Carlsson3f35a262008-08-31 04:05:03 +00001328 ConvertType(getContext().getObjCIdType()),
1329 "tmp");
Daniel Dunbar84388bf2009-02-03 23:55:40 +00001330 CallArgList Args2;
Eli Friedman43dca6a2011-05-02 17:57:46 +00001331 Args2.add(RValue::get(V), getContext().getObjCIdType());
Mike Stump18bb9282009-05-16 07:57:57 +00001332 // FIXME: We shouldn't need to get the function info here, the runtime already
1333 // should have computed it to build the function.
John McCallab26cfa2010-02-05 21:31:56 +00001334 EmitCall(CGM.getTypes().getFunctionInfo(getContext().VoidTy, Args2,
Rafael Espindolac50c27c2010-03-30 20:24:48 +00001335 FunctionType::ExtInfo()),
Anders Carlsson61a401c2009-12-24 19:25:24 +00001336 EnumerationMutationFn, ReturnValueSlot(), Args2);
Mike Stump11289f42009-09-09 15:08:12 +00001337
John McCall1c926b72011-01-07 01:49:06 +00001338 // Otherwise, or if the mutation function returns, just continue.
1339 EmitBlock(WasNotMutatedBB);
Mike Stump11289f42009-09-09 15:08:12 +00001340
John McCall1c926b72011-01-07 01:49:06 +00001341 // Initialize the element variable.
1342 RunCleanupsScope elementVariableScope(*this);
John McCall9e2e22f2011-02-22 07:16:58 +00001343 bool elementIsVariable;
John McCall1c926b72011-01-07 01:49:06 +00001344 LValue elementLValue;
1345 QualType elementType;
1346 if (const DeclStmt *SD = dyn_cast<DeclStmt>(S.getElement())) {
John McCall9e2e22f2011-02-22 07:16:58 +00001347 // Initialize the variable, in case it's a __block variable or something.
1348 EmitAutoVarInit(variable);
John McCall1c926b72011-01-07 01:49:06 +00001349
John McCall9e2e22f2011-02-22 07:16:58 +00001350 const VarDecl* D = cast<VarDecl>(SD->getSingleDecl());
John McCall1c926b72011-01-07 01:49:06 +00001351 DeclRefExpr tempDRE(const_cast<VarDecl*>(D), D->getType(),
1352 VK_LValue, SourceLocation());
1353 elementLValue = EmitLValue(&tempDRE);
1354 elementType = D->getType();
John McCall9e2e22f2011-02-22 07:16:58 +00001355 elementIsVariable = true;
John McCalld4631322011-06-17 06:42:21 +00001356
1357 if (D->isARCPseudoStrong())
1358 elementLValue.getQuals().setObjCLifetime(Qualifiers::OCL_ExplicitNone);
John McCall1c926b72011-01-07 01:49:06 +00001359 } else {
1360 elementLValue = LValue(); // suppress warning
1361 elementType = cast<Expr>(S.getElement())->getType();
John McCall9e2e22f2011-02-22 07:16:58 +00001362 elementIsVariable = false;
John McCall1c926b72011-01-07 01:49:06 +00001363 }
Chris Lattner2192fe52011-07-18 04:24:23 +00001364 llvm::Type *convertedElementType = ConvertType(elementType);
John McCall1c926b72011-01-07 01:49:06 +00001365
1366 // Fetch the buffer out of the enumeration state.
1367 // TODO: this pointer should actually be invariant between
1368 // refreshes, which would help us do certain loop optimizations.
Mike Stump11289f42009-09-09 15:08:12 +00001369 llvm::Value *StateItemsPtr =
Anders Carlsson75658592008-08-31 02:33:12 +00001370 Builder.CreateStructGEP(StatePtr, 1, "stateitems.ptr");
John McCall1c926b72011-01-07 01:49:06 +00001371 llvm::Value *EnumStateItems =
1372 Builder.CreateLoad(StateItemsPtr, "stateitems");
Anders Carlsson75658592008-08-31 02:33:12 +00001373
John McCall1c926b72011-01-07 01:49:06 +00001374 // Fetch the value at the current index from the buffer.
Mike Stump11289f42009-09-09 15:08:12 +00001375 llvm::Value *CurrentItemPtr =
John McCall1c926b72011-01-07 01:49:06 +00001376 Builder.CreateGEP(EnumStateItems, index, "currentitem.ptr");
1377 llvm::Value *CurrentItem = Builder.CreateLoad(CurrentItemPtr);
Mike Stump11289f42009-09-09 15:08:12 +00001378
John McCall1c926b72011-01-07 01:49:06 +00001379 // Cast that value to the right type.
1380 CurrentItem = Builder.CreateBitCast(CurrentItem, convertedElementType,
1381 "currentitem");
Mike Stump11289f42009-09-09 15:08:12 +00001382
John McCall1c926b72011-01-07 01:49:06 +00001383 // Make sure we have an l-value. Yes, this gets evaluated every
1384 // time through the loop.
John McCalld4631322011-06-17 06:42:21 +00001385 if (!elementIsVariable) {
John McCall1c926b72011-01-07 01:49:06 +00001386 elementLValue = EmitLValue(cast<Expr>(S.getElement()));
John McCall55e1fbc2011-06-25 02:11:03 +00001387 EmitStoreThroughLValue(RValue::get(CurrentItem), elementLValue);
John McCalld4631322011-06-17 06:42:21 +00001388 } else {
1389 EmitScalarInit(CurrentItem, elementLValue);
1390 }
Mike Stump11289f42009-09-09 15:08:12 +00001391
John McCall9e2e22f2011-02-22 07:16:58 +00001392 // If we do have an element variable, this assignment is the end of
1393 // its initialization.
1394 if (elementIsVariable)
1395 EmitAutoVarCleanups(variable);
1396
John McCall1c926b72011-01-07 01:49:06 +00001397 // Perform the loop body, setting up break and continue labels.
Anders Carlsson33747b62009-02-10 05:52:02 +00001398 BreakContinueStack.push_back(BreakContinue(LoopEnd, AfterBody));
John McCall1c926b72011-01-07 01:49:06 +00001399 {
1400 RunCleanupsScope Scope(*this);
1401 EmitStmt(S.getBody());
1402 }
Anders Carlsson75658592008-08-31 02:33:12 +00001403 BreakContinueStack.pop_back();
Mike Stump11289f42009-09-09 15:08:12 +00001404
John McCall1c926b72011-01-07 01:49:06 +00001405 // Destroy the element variable now.
1406 elementVariableScope.ForceCleanup();
1407
1408 // Check whether there are more elements.
John McCallad5d61e2010-07-23 21:56:41 +00001409 EmitBlock(AfterBody.getBlock());
Mike Stump11289f42009-09-09 15:08:12 +00001410
John McCall1c926b72011-01-07 01:49:06 +00001411 llvm::BasicBlock *FetchMoreBB = createBasicBlock("forcoll.refetch");
Fariborz Jahanian6e7ecc82009-01-06 18:56:31 +00001412
John McCall1c926b72011-01-07 01:49:06 +00001413 // First we check in the local buffer.
1414 llvm::Value *indexPlusOne
1415 = Builder.CreateAdd(index, llvm::ConstantInt::get(UnsignedLongLTy, 1));
Anders Carlsson75658592008-08-31 02:33:12 +00001416
John McCall1c926b72011-01-07 01:49:06 +00001417 // If we haven't overrun the buffer yet, we can continue.
1418 Builder.CreateCondBr(Builder.CreateICmpULT(indexPlusOne, count),
1419 LoopBodyBB, FetchMoreBB);
1420
1421 index->addIncoming(indexPlusOne, AfterBody.getBlock());
1422 count->addIncoming(count, AfterBody.getBlock());
1423
1424 // Otherwise, we have to fetch more elements.
1425 EmitBlock(FetchMoreBB);
Mike Stump11289f42009-09-09 15:08:12 +00001426
1427 CountRV =
John McCall78a15112010-05-22 01:48:05 +00001428 CGM.getObjCRuntime().GenerateMessageSend(*this, ReturnValueSlot(),
Anders Carlsson75658592008-08-31 02:33:12 +00001429 getContext().UnsignedLongTy,
Mike Stump11289f42009-09-09 15:08:12 +00001430 FastEnumSel,
David Chisnall01aa4672010-04-28 19:33:36 +00001431 Collection, Args);
Mike Stump11289f42009-09-09 15:08:12 +00001432
John McCall1c926b72011-01-07 01:49:06 +00001433 // If we got a zero count, we're done.
1434 llvm::Value *refetchCount = CountRV.getScalarVal();
1435
1436 // (note that the message send might split FetchMoreBB)
1437 index->addIncoming(zero, Builder.GetInsertBlock());
1438 count->addIncoming(refetchCount, Builder.GetInsertBlock());
1439
1440 Builder.CreateCondBr(Builder.CreateICmpEQ(refetchCount, zero),
1441 EmptyBB, LoopBodyBB);
Mike Stump11289f42009-09-09 15:08:12 +00001442
Anders Carlsson75658592008-08-31 02:33:12 +00001443 // No more elements.
John McCall1c926b72011-01-07 01:49:06 +00001444 EmitBlock(EmptyBB);
Anders Carlsson75658592008-08-31 02:33:12 +00001445
John McCall9e2e22f2011-02-22 07:16:58 +00001446 if (!elementIsVariable) {
Anders Carlsson75658592008-08-31 02:33:12 +00001447 // If the element was not a declaration, set it to be null.
1448
John McCall1c926b72011-01-07 01:49:06 +00001449 llvm::Value *null = llvm::Constant::getNullValue(convertedElementType);
1450 elementLValue = EmitLValue(cast<Expr>(S.getElement()));
John McCall55e1fbc2011-06-25 02:11:03 +00001451 EmitStoreThroughLValue(RValue::get(null), elementLValue);
Anders Carlsson75658592008-08-31 02:33:12 +00001452 }
1453
Devang Pateld2d66652011-01-19 01:36:36 +00001454 if (DI) {
1455 DI->setLocation(S.getSourceRange().getEnd());
1456 DI->EmitRegionEnd(Builder);
1457 }
1458
John McCall53848232011-07-27 01:07:15 +00001459 // Leave the cleanup we entered in ARC.
1460 if (getLangOptions().ObjCAutoRefCount)
1461 PopCleanupBlock();
1462
John McCallad5d61e2010-07-23 21:56:41 +00001463 EmitBlock(LoopEnd.getBlock());
Anders Carlsson2e744e82008-08-30 19:51:14 +00001464}
1465
Mike Stump11289f42009-09-09 15:08:12 +00001466void CodeGenFunction::EmitObjCAtTryStmt(const ObjCAtTryStmt &S) {
John McCallbd309292010-07-06 01:34:17 +00001467 CGM.getObjCRuntime().EmitTryStmt(*this, S);
Anders Carlsson1963b0c2008-09-09 10:04:29 +00001468}
1469
Mike Stump11289f42009-09-09 15:08:12 +00001470void CodeGenFunction::EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S) {
Anders Carlsson1963b0c2008-09-09 10:04:29 +00001471 CGM.getObjCRuntime().EmitThrowStmt(*this, S);
1472}
1473
Chris Lattnere132e242008-11-15 21:26:17 +00001474void CodeGenFunction::EmitObjCAtSynchronizedStmt(
Mike Stump11289f42009-09-09 15:08:12 +00001475 const ObjCAtSynchronizedStmt &S) {
John McCallbd309292010-07-06 01:34:17 +00001476 CGM.getObjCRuntime().EmitSynchronizedStmt(*this, S);
Chris Lattnere132e242008-11-15 21:26:17 +00001477}
1478
John McCall2d637d22011-09-10 06:18:15 +00001479/// Produce the code for a CK_ARCProduceObject. Just does a
John McCall31168b02011-06-15 23:02:42 +00001480/// primitive retain.
1481llvm::Value *CodeGenFunction::EmitObjCProduceObject(QualType type,
1482 llvm::Value *value) {
1483 return EmitARCRetain(type, value);
1484}
1485
1486namespace {
1487 struct CallObjCRelease : EHScopeStack::Cleanup {
John McCall9c8e1c92011-08-03 22:24:24 +00001488 CallObjCRelease(llvm::Value *object) : object(object) {}
1489 llvm::Value *object;
John McCall31168b02011-06-15 23:02:42 +00001490
John McCall30317fd2011-07-12 20:27:29 +00001491 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCall31168b02011-06-15 23:02:42 +00001492 CGF.EmitARCRelease(object, /*precise*/ true);
John McCall31168b02011-06-15 23:02:42 +00001493 }
1494 };
1495}
1496
John McCall2d637d22011-09-10 06:18:15 +00001497/// Produce the code for a CK_ARCConsumeObject. Does a primitive
John McCall31168b02011-06-15 23:02:42 +00001498/// release at the end of the full-expression.
1499llvm::Value *CodeGenFunction::EmitObjCConsumeObject(QualType type,
1500 llvm::Value *object) {
1501 // If we're in a conditional branch, we need to make the cleanup
John McCall9c8e1c92011-08-03 22:24:24 +00001502 // conditional.
1503 pushFullExprCleanup<CallObjCRelease>(getARCCleanupKind(), object);
John McCall31168b02011-06-15 23:02:42 +00001504 return object;
1505}
1506
1507llvm::Value *CodeGenFunction::EmitObjCExtendObjectLifetime(QualType type,
1508 llvm::Value *value) {
1509 return EmitARCRetainAutorelease(type, value);
1510}
1511
1512
1513static llvm::Constant *createARCRuntimeFunction(CodeGenModule &CGM,
Chris Lattner2192fe52011-07-18 04:24:23 +00001514 llvm::FunctionType *type,
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001515 StringRef fnName) {
John McCall31168b02011-06-15 23:02:42 +00001516 llvm::Constant *fn = CGM.CreateRuntimeFunction(type, fnName);
1517
1518 // In -fobjc-no-arc-runtime, emit weak references to the runtime
1519 // support library.
John McCall24fc0de2011-07-06 00:26:06 +00001520 if (!CGM.getCodeGenOpts().ObjCRuntimeHasARC)
John McCall31168b02011-06-15 23:02:42 +00001521 if (llvm::Function *f = dyn_cast<llvm::Function>(fn))
1522 f->setLinkage(llvm::Function::ExternalWeakLinkage);
1523
1524 return fn;
1525}
1526
1527/// Perform an operation having the signature
1528/// i8* (i8*)
1529/// where a null input causes a no-op and returns null.
1530static llvm::Value *emitARCValueOperation(CodeGenFunction &CGF,
1531 llvm::Value *value,
1532 llvm::Constant *&fn,
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001533 StringRef fnName) {
John McCall31168b02011-06-15 23:02:42 +00001534 if (isa<llvm::ConstantPointerNull>(value)) return value;
1535
1536 if (!fn) {
Chris Lattnera5f58b02011-07-09 17:41:47 +00001537 std::vector<llvm::Type*> args(1, CGF.Int8PtrTy);
Chris Lattner2192fe52011-07-18 04:24:23 +00001538 llvm::FunctionType *fnType =
John McCall31168b02011-06-15 23:02:42 +00001539 llvm::FunctionType::get(CGF.Int8PtrTy, args, false);
1540 fn = createARCRuntimeFunction(CGF.CGM, fnType, fnName);
1541 }
1542
1543 // Cast the argument to 'id'.
Chris Lattner2192fe52011-07-18 04:24:23 +00001544 llvm::Type *origType = value->getType();
John McCall31168b02011-06-15 23:02:42 +00001545 value = CGF.Builder.CreateBitCast(value, CGF.Int8PtrTy);
1546
1547 // Call the function.
1548 llvm::CallInst *call = CGF.Builder.CreateCall(fn, value);
1549 call->setDoesNotThrow();
1550
1551 // Cast the result back to the original type.
1552 return CGF.Builder.CreateBitCast(call, origType);
1553}
1554
1555/// Perform an operation having the following signature:
1556/// i8* (i8**)
1557static llvm::Value *emitARCLoadOperation(CodeGenFunction &CGF,
1558 llvm::Value *addr,
1559 llvm::Constant *&fn,
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001560 StringRef fnName) {
John McCall31168b02011-06-15 23:02:42 +00001561 if (!fn) {
Chris Lattnera5f58b02011-07-09 17:41:47 +00001562 std::vector<llvm::Type*> args(1, CGF.Int8PtrPtrTy);
Chris Lattner2192fe52011-07-18 04:24:23 +00001563 llvm::FunctionType *fnType =
John McCall31168b02011-06-15 23:02:42 +00001564 llvm::FunctionType::get(CGF.Int8PtrTy, args, false);
1565 fn = createARCRuntimeFunction(CGF.CGM, fnType, fnName);
1566 }
1567
1568 // Cast the argument to 'id*'.
Chris Lattner2192fe52011-07-18 04:24:23 +00001569 llvm::Type *origType = addr->getType();
John McCall31168b02011-06-15 23:02:42 +00001570 addr = CGF.Builder.CreateBitCast(addr, CGF.Int8PtrPtrTy);
1571
1572 // Call the function.
1573 llvm::CallInst *call = CGF.Builder.CreateCall(fn, addr);
1574 call->setDoesNotThrow();
1575
1576 // Cast the result back to a dereference of the original type.
1577 llvm::Value *result = call;
1578 if (origType != CGF.Int8PtrPtrTy)
1579 result = CGF.Builder.CreateBitCast(result,
1580 cast<llvm::PointerType>(origType)->getElementType());
1581
1582 return result;
1583}
1584
1585/// Perform an operation having the following signature:
1586/// i8* (i8**, i8*)
1587static llvm::Value *emitARCStoreOperation(CodeGenFunction &CGF,
1588 llvm::Value *addr,
1589 llvm::Value *value,
1590 llvm::Constant *&fn,
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001591 StringRef fnName,
John McCall31168b02011-06-15 23:02:42 +00001592 bool ignored) {
1593 assert(cast<llvm::PointerType>(addr->getType())->getElementType()
1594 == value->getType());
1595
1596 if (!fn) {
Chris Lattnera5f58b02011-07-09 17:41:47 +00001597 std::vector<llvm::Type*> argTypes(2);
John McCall31168b02011-06-15 23:02:42 +00001598 argTypes[0] = CGF.Int8PtrPtrTy;
1599 argTypes[1] = CGF.Int8PtrTy;
1600
Chris Lattner2192fe52011-07-18 04:24:23 +00001601 llvm::FunctionType *fnType
John McCall31168b02011-06-15 23:02:42 +00001602 = llvm::FunctionType::get(CGF.Int8PtrTy, argTypes, false);
1603 fn = createARCRuntimeFunction(CGF.CGM, fnType, fnName);
1604 }
1605
Chris Lattner2192fe52011-07-18 04:24:23 +00001606 llvm::Type *origType = value->getType();
John McCall31168b02011-06-15 23:02:42 +00001607
1608 addr = CGF.Builder.CreateBitCast(addr, CGF.Int8PtrPtrTy);
1609 value = CGF.Builder.CreateBitCast(value, CGF.Int8PtrTy);
1610
1611 llvm::CallInst *result = CGF.Builder.CreateCall2(fn, addr, value);
1612 result->setDoesNotThrow();
1613
1614 if (ignored) return 0;
1615
1616 return CGF.Builder.CreateBitCast(result, origType);
1617}
1618
1619/// Perform an operation having the following signature:
1620/// void (i8**, i8**)
1621static void emitARCCopyOperation(CodeGenFunction &CGF,
1622 llvm::Value *dst,
1623 llvm::Value *src,
1624 llvm::Constant *&fn,
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001625 StringRef fnName) {
John McCall31168b02011-06-15 23:02:42 +00001626 assert(dst->getType() == src->getType());
1627
1628 if (!fn) {
Chris Lattnera5f58b02011-07-09 17:41:47 +00001629 std::vector<llvm::Type*> argTypes(2, CGF.Int8PtrPtrTy);
Chris Lattner2192fe52011-07-18 04:24:23 +00001630 llvm::FunctionType *fnType
John McCall31168b02011-06-15 23:02:42 +00001631 = llvm::FunctionType::get(CGF.Builder.getVoidTy(), argTypes, false);
1632 fn = createARCRuntimeFunction(CGF.CGM, fnType, fnName);
1633 }
1634
1635 dst = CGF.Builder.CreateBitCast(dst, CGF.Int8PtrPtrTy);
1636 src = CGF.Builder.CreateBitCast(src, CGF.Int8PtrPtrTy);
1637
1638 llvm::CallInst *result = CGF.Builder.CreateCall2(fn, dst, src);
1639 result->setDoesNotThrow();
1640}
1641
1642/// Produce the code to do a retain. Based on the type, calls one of:
1643/// call i8* @objc_retain(i8* %value)
1644/// call i8* @objc_retainBlock(i8* %value)
1645llvm::Value *CodeGenFunction::EmitARCRetain(QualType type, llvm::Value *value) {
1646 if (type->isBlockPointerType())
1647 return EmitARCRetainBlock(value);
1648 else
1649 return EmitARCRetainNonBlock(value);
1650}
1651
1652/// Retain the given object, with normal retain semantics.
1653/// call i8* @objc_retain(i8* %value)
1654llvm::Value *CodeGenFunction::EmitARCRetainNonBlock(llvm::Value *value) {
1655 return emitARCValueOperation(*this, value,
1656 CGM.getARCEntrypoints().objc_retain,
1657 "objc_retain");
1658}
1659
1660/// Retain the given block, with _Block_copy semantics.
1661/// call i8* @objc_retainBlock(i8* %value)
1662llvm::Value *CodeGenFunction::EmitARCRetainBlock(llvm::Value *value) {
1663 return emitARCValueOperation(*this, value,
1664 CGM.getARCEntrypoints().objc_retainBlock,
1665 "objc_retainBlock");
1666}
1667
1668/// Retain the given object which is the result of a function call.
1669/// call i8* @objc_retainAutoreleasedReturnValue(i8* %value)
1670///
1671/// Yes, this function name is one character away from a different
1672/// call with completely different semantics.
1673llvm::Value *
1674CodeGenFunction::EmitARCRetainAutoreleasedReturnValue(llvm::Value *value) {
1675 // Fetch the void(void) inline asm which marks that we're going to
1676 // retain the autoreleased return value.
1677 llvm::InlineAsm *&marker
1678 = CGM.getARCEntrypoints().retainAutoreleasedReturnValueMarker;
1679 if (!marker) {
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001680 StringRef assembly
John McCall31168b02011-06-15 23:02:42 +00001681 = CGM.getTargetCodeGenInfo()
1682 .getARCRetainAutoreleasedReturnValueMarker();
1683
1684 // If we have an empty assembly string, there's nothing to do.
1685 if (assembly.empty()) {
1686
1687 // Otherwise, at -O0, build an inline asm that we're going to call
1688 // in a moment.
1689 } else if (CGM.getCodeGenOpts().OptimizationLevel == 0) {
1690 llvm::FunctionType *type =
1691 llvm::FunctionType::get(llvm::Type::getVoidTy(getLLVMContext()),
1692 /*variadic*/ false);
1693
1694 marker = llvm::InlineAsm::get(type, assembly, "", /*sideeffects*/ true);
1695
1696 // If we're at -O1 and above, we don't want to litter the code
1697 // with this marker yet, so leave a breadcrumb for the ARC
1698 // optimizer to pick up.
1699 } else {
1700 llvm::NamedMDNode *metadata =
1701 CGM.getModule().getOrInsertNamedMetadata(
1702 "clang.arc.retainAutoreleasedReturnValueMarker");
1703 assert(metadata->getNumOperands() <= 1);
1704 if (metadata->getNumOperands() == 0) {
1705 llvm::Value *string = llvm::MDString::get(getLLVMContext(), assembly);
Jay Foad5709f7c2011-07-29 13:56:53 +00001706 metadata->addOperand(llvm::MDNode::get(getLLVMContext(), string));
John McCall31168b02011-06-15 23:02:42 +00001707 }
1708 }
1709 }
1710
1711 // Call the marker asm if we made one, which we do only at -O0.
1712 if (marker) Builder.CreateCall(marker);
1713
1714 return emitARCValueOperation(*this, value,
1715 CGM.getARCEntrypoints().objc_retainAutoreleasedReturnValue,
1716 "objc_retainAutoreleasedReturnValue");
1717}
1718
1719/// Release the given object.
1720/// call void @objc_release(i8* %value)
1721void CodeGenFunction::EmitARCRelease(llvm::Value *value, bool precise) {
1722 if (isa<llvm::ConstantPointerNull>(value)) return;
1723
1724 llvm::Constant *&fn = CGM.getARCEntrypoints().objc_release;
1725 if (!fn) {
Chris Lattnera5f58b02011-07-09 17:41:47 +00001726 std::vector<llvm::Type*> args(1, Int8PtrTy);
Chris Lattner2192fe52011-07-18 04:24:23 +00001727 llvm::FunctionType *fnType =
John McCall31168b02011-06-15 23:02:42 +00001728 llvm::FunctionType::get(Builder.getVoidTy(), args, false);
1729 fn = createARCRuntimeFunction(CGM, fnType, "objc_release");
1730 }
1731
1732 // Cast the argument to 'id'.
1733 value = Builder.CreateBitCast(value, Int8PtrTy);
1734
1735 // Call objc_release.
1736 llvm::CallInst *call = Builder.CreateCall(fn, value);
1737 call->setDoesNotThrow();
1738
1739 if (!precise) {
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001740 SmallVector<llvm::Value*,1> args;
John McCall31168b02011-06-15 23:02:42 +00001741 call->setMetadata("clang.imprecise_release",
1742 llvm::MDNode::get(Builder.getContext(), args));
1743 }
1744}
1745
1746/// Store into a strong object. Always calls this:
1747/// call void @objc_storeStrong(i8** %addr, i8* %value)
1748llvm::Value *CodeGenFunction::EmitARCStoreStrongCall(llvm::Value *addr,
1749 llvm::Value *value,
1750 bool ignored) {
1751 assert(cast<llvm::PointerType>(addr->getType())->getElementType()
1752 == value->getType());
1753
1754 llvm::Constant *&fn = CGM.getARCEntrypoints().objc_storeStrong;
1755 if (!fn) {
Chris Lattnera5f58b02011-07-09 17:41:47 +00001756 llvm::Type *argTypes[] = { Int8PtrPtrTy, Int8PtrTy };
Chris Lattner2192fe52011-07-18 04:24:23 +00001757 llvm::FunctionType *fnType
John McCall31168b02011-06-15 23:02:42 +00001758 = llvm::FunctionType::get(Builder.getVoidTy(), argTypes, false);
1759 fn = createARCRuntimeFunction(CGM, fnType, "objc_storeStrong");
1760 }
1761
1762 addr = Builder.CreateBitCast(addr, Int8PtrPtrTy);
1763 llvm::Value *castValue = Builder.CreateBitCast(value, Int8PtrTy);
1764
1765 Builder.CreateCall2(fn, addr, castValue)->setDoesNotThrow();
1766
1767 if (ignored) return 0;
1768 return value;
1769}
1770
1771/// Store into a strong object. Sometimes calls this:
1772/// call void @objc_storeStrong(i8** %addr, i8* %value)
1773/// Other times, breaks it down into components.
John McCall55e1fbc2011-06-25 02:11:03 +00001774llvm::Value *CodeGenFunction::EmitARCStoreStrong(LValue dst,
John McCall31168b02011-06-15 23:02:42 +00001775 llvm::Value *newValue,
1776 bool ignored) {
John McCall55e1fbc2011-06-25 02:11:03 +00001777 QualType type = dst.getType();
John McCall31168b02011-06-15 23:02:42 +00001778 bool isBlock = type->isBlockPointerType();
1779
1780 // Use a store barrier at -O0 unless this is a block type or the
1781 // lvalue is inadequately aligned.
1782 if (shouldUseFusedARCCalls() &&
1783 !isBlock &&
1784 !(dst.getAlignment() && dst.getAlignment() < PointerAlignInBytes)) {
1785 return EmitARCStoreStrongCall(dst.getAddress(), newValue, ignored);
1786 }
1787
1788 // Otherwise, split it out.
1789
1790 // Retain the new value.
1791 newValue = EmitARCRetain(type, newValue);
1792
1793 // Read the old value.
John McCall55e1fbc2011-06-25 02:11:03 +00001794 llvm::Value *oldValue = EmitLoadOfScalar(dst);
John McCall31168b02011-06-15 23:02:42 +00001795
1796 // Store. We do this before the release so that any deallocs won't
1797 // see the old value.
John McCall55e1fbc2011-06-25 02:11:03 +00001798 EmitStoreOfScalar(newValue, dst);
John McCall31168b02011-06-15 23:02:42 +00001799
1800 // Finally, release the old value.
1801 EmitARCRelease(oldValue, /*precise*/ false);
1802
1803 return newValue;
1804}
1805
1806/// Autorelease the given object.
1807/// call i8* @objc_autorelease(i8* %value)
1808llvm::Value *CodeGenFunction::EmitARCAutorelease(llvm::Value *value) {
1809 return emitARCValueOperation(*this, value,
1810 CGM.getARCEntrypoints().objc_autorelease,
1811 "objc_autorelease");
1812}
1813
1814/// Autorelease the given object.
1815/// call i8* @objc_autoreleaseReturnValue(i8* %value)
1816llvm::Value *
1817CodeGenFunction::EmitARCAutoreleaseReturnValue(llvm::Value *value) {
1818 return emitARCValueOperation(*this, value,
1819 CGM.getARCEntrypoints().objc_autoreleaseReturnValue,
1820 "objc_autoreleaseReturnValue");
1821}
1822
1823/// Do a fused retain/autorelease of the given object.
1824/// call i8* @objc_retainAutoreleaseReturnValue(i8* %value)
1825llvm::Value *
1826CodeGenFunction::EmitARCRetainAutoreleaseReturnValue(llvm::Value *value) {
1827 return emitARCValueOperation(*this, value,
1828 CGM.getARCEntrypoints().objc_retainAutoreleaseReturnValue,
1829 "objc_retainAutoreleaseReturnValue");
1830}
1831
1832/// Do a fused retain/autorelease of the given object.
1833/// call i8* @objc_retainAutorelease(i8* %value)
1834/// or
1835/// %retain = call i8* @objc_retainBlock(i8* %value)
1836/// call i8* @objc_autorelease(i8* %retain)
1837llvm::Value *CodeGenFunction::EmitARCRetainAutorelease(QualType type,
1838 llvm::Value *value) {
1839 if (!type->isBlockPointerType())
1840 return EmitARCRetainAutoreleaseNonBlock(value);
1841
1842 if (isa<llvm::ConstantPointerNull>(value)) return value;
1843
Chris Lattner2192fe52011-07-18 04:24:23 +00001844 llvm::Type *origType = value->getType();
John McCall31168b02011-06-15 23:02:42 +00001845 value = Builder.CreateBitCast(value, Int8PtrTy);
1846 value = EmitARCRetainBlock(value);
1847 value = EmitARCAutorelease(value);
1848 return Builder.CreateBitCast(value, origType);
1849}
1850
1851/// Do a fused retain/autorelease of the given object.
1852/// call i8* @objc_retainAutorelease(i8* %value)
1853llvm::Value *
1854CodeGenFunction::EmitARCRetainAutoreleaseNonBlock(llvm::Value *value) {
1855 return emitARCValueOperation(*this, value,
1856 CGM.getARCEntrypoints().objc_retainAutorelease,
1857 "objc_retainAutorelease");
1858}
1859
1860/// i8* @objc_loadWeak(i8** %addr)
1861/// Essentially objc_autorelease(objc_loadWeakRetained(addr)).
1862llvm::Value *CodeGenFunction::EmitARCLoadWeak(llvm::Value *addr) {
1863 return emitARCLoadOperation(*this, addr,
1864 CGM.getARCEntrypoints().objc_loadWeak,
1865 "objc_loadWeak");
1866}
1867
1868/// i8* @objc_loadWeakRetained(i8** %addr)
1869llvm::Value *CodeGenFunction::EmitARCLoadWeakRetained(llvm::Value *addr) {
1870 return emitARCLoadOperation(*this, addr,
1871 CGM.getARCEntrypoints().objc_loadWeakRetained,
1872 "objc_loadWeakRetained");
1873}
1874
1875/// i8* @objc_storeWeak(i8** %addr, i8* %value)
1876/// Returns %value.
1877llvm::Value *CodeGenFunction::EmitARCStoreWeak(llvm::Value *addr,
1878 llvm::Value *value,
1879 bool ignored) {
1880 return emitARCStoreOperation(*this, addr, value,
1881 CGM.getARCEntrypoints().objc_storeWeak,
1882 "objc_storeWeak", ignored);
1883}
1884
1885/// i8* @objc_initWeak(i8** %addr, i8* %value)
1886/// Returns %value. %addr is known to not have a current weak entry.
1887/// Essentially equivalent to:
1888/// *addr = nil; objc_storeWeak(addr, value);
1889void CodeGenFunction::EmitARCInitWeak(llvm::Value *addr, llvm::Value *value) {
1890 // If we're initializing to null, just write null to memory; no need
1891 // to get the runtime involved. But don't do this if optimization
1892 // is enabled, because accounting for this would make the optimizer
1893 // much more complicated.
1894 if (isa<llvm::ConstantPointerNull>(value) &&
1895 CGM.getCodeGenOpts().OptimizationLevel == 0) {
1896 Builder.CreateStore(value, addr);
1897 return;
1898 }
1899
1900 emitARCStoreOperation(*this, addr, value,
1901 CGM.getARCEntrypoints().objc_initWeak,
1902 "objc_initWeak", /*ignored*/ true);
1903}
1904
1905/// void @objc_destroyWeak(i8** %addr)
1906/// Essentially objc_storeWeak(addr, nil).
1907void CodeGenFunction::EmitARCDestroyWeak(llvm::Value *addr) {
1908 llvm::Constant *&fn = CGM.getARCEntrypoints().objc_destroyWeak;
1909 if (!fn) {
Chris Lattnera5f58b02011-07-09 17:41:47 +00001910 std::vector<llvm::Type*> args(1, Int8PtrPtrTy);
Chris Lattner2192fe52011-07-18 04:24:23 +00001911 llvm::FunctionType *fnType =
John McCall31168b02011-06-15 23:02:42 +00001912 llvm::FunctionType::get(Builder.getVoidTy(), args, false);
1913 fn = createARCRuntimeFunction(CGM, fnType, "objc_destroyWeak");
1914 }
1915
1916 // Cast the argument to 'id*'.
1917 addr = Builder.CreateBitCast(addr, Int8PtrPtrTy);
1918
1919 llvm::CallInst *call = Builder.CreateCall(fn, addr);
1920 call->setDoesNotThrow();
1921}
1922
1923/// void @objc_moveWeak(i8** %dest, i8** %src)
1924/// Disregards the current value in %dest. Leaves %src pointing to nothing.
1925/// Essentially (objc_copyWeak(dest, src), objc_destroyWeak(src)).
1926void CodeGenFunction::EmitARCMoveWeak(llvm::Value *dst, llvm::Value *src) {
1927 emitARCCopyOperation(*this, dst, src,
1928 CGM.getARCEntrypoints().objc_moveWeak,
1929 "objc_moveWeak");
1930}
1931
1932/// void @objc_copyWeak(i8** %dest, i8** %src)
1933/// Disregards the current value in %dest. Essentially
1934/// objc_release(objc_initWeak(dest, objc_readWeakRetained(src)))
1935void CodeGenFunction::EmitARCCopyWeak(llvm::Value *dst, llvm::Value *src) {
1936 emitARCCopyOperation(*this, dst, src,
1937 CGM.getARCEntrypoints().objc_copyWeak,
1938 "objc_copyWeak");
1939}
1940
1941/// Produce the code to do a objc_autoreleasepool_push.
1942/// call i8* @objc_autoreleasePoolPush(void)
1943llvm::Value *CodeGenFunction::EmitObjCAutoreleasePoolPush() {
1944 llvm::Constant *&fn = CGM.getRREntrypoints().objc_autoreleasePoolPush;
1945 if (!fn) {
Chris Lattner2192fe52011-07-18 04:24:23 +00001946 llvm::FunctionType *fnType =
John McCall31168b02011-06-15 23:02:42 +00001947 llvm::FunctionType::get(Int8PtrTy, false);
1948 fn = createARCRuntimeFunction(CGM, fnType, "objc_autoreleasePoolPush");
1949 }
1950
1951 llvm::CallInst *call = Builder.CreateCall(fn);
1952 call->setDoesNotThrow();
1953
1954 return call;
1955}
1956
1957/// Produce the code to do a primitive release.
1958/// call void @objc_autoreleasePoolPop(i8* %ptr)
1959void CodeGenFunction::EmitObjCAutoreleasePoolPop(llvm::Value *value) {
1960 assert(value->getType() == Int8PtrTy);
1961
1962 llvm::Constant *&fn = CGM.getRREntrypoints().objc_autoreleasePoolPop;
1963 if (!fn) {
Chris Lattnera5f58b02011-07-09 17:41:47 +00001964 std::vector<llvm::Type*> args(1, Int8PtrTy);
Chris Lattner2192fe52011-07-18 04:24:23 +00001965 llvm::FunctionType *fnType =
John McCall31168b02011-06-15 23:02:42 +00001966 llvm::FunctionType::get(Builder.getVoidTy(), args, false);
1967
1968 // We don't want to use a weak import here; instead we should not
1969 // fall into this path.
1970 fn = createARCRuntimeFunction(CGM, fnType, "objc_autoreleasePoolPop");
1971 }
1972
1973 llvm::CallInst *call = Builder.CreateCall(fn, value);
1974 call->setDoesNotThrow();
1975}
1976
1977/// Produce the code to do an MRR version objc_autoreleasepool_push.
1978/// Which is: [[NSAutoreleasePool alloc] init];
1979/// Where alloc is declared as: + (id) alloc; in NSAutoreleasePool class.
1980/// init is declared as: - (id) init; in its NSObject super class.
1981///
1982llvm::Value *CodeGenFunction::EmitObjCMRRAutoreleasePoolPush() {
1983 CGObjCRuntime &Runtime = CGM.getObjCRuntime();
1984 llvm::Value *Receiver = Runtime.EmitNSAutoreleasePoolClassRef(Builder);
1985 // [NSAutoreleasePool alloc]
1986 IdentifierInfo *II = &CGM.getContext().Idents.get("alloc");
1987 Selector AllocSel = getContext().Selectors.getSelector(0, &II);
1988 CallArgList Args;
1989 RValue AllocRV =
1990 Runtime.GenerateMessageSend(*this, ReturnValueSlot(),
1991 getContext().getObjCIdType(),
1992 AllocSel, Receiver, Args);
1993
1994 // [Receiver init]
1995 Receiver = AllocRV.getScalarVal();
1996 II = &CGM.getContext().Idents.get("init");
1997 Selector InitSel = getContext().Selectors.getSelector(0, &II);
1998 RValue InitRV =
1999 Runtime.GenerateMessageSend(*this, ReturnValueSlot(),
2000 getContext().getObjCIdType(),
2001 InitSel, Receiver, Args);
2002 return InitRV.getScalarVal();
2003}
2004
2005/// Produce the code to do a primitive release.
2006/// [tmp drain];
2007void CodeGenFunction::EmitObjCMRRAutoreleasePoolPop(llvm::Value *Arg) {
2008 IdentifierInfo *II = &CGM.getContext().Idents.get("drain");
2009 Selector DrainSel = getContext().Selectors.getSelector(0, &II);
2010 CallArgList Args;
2011 CGM.getObjCRuntime().GenerateMessageSend(*this, ReturnValueSlot(),
2012 getContext().VoidTy, DrainSel, Arg, Args);
2013}
2014
John McCall82fe67b2011-07-09 01:37:26 +00002015void CodeGenFunction::destroyARCStrongPrecise(CodeGenFunction &CGF,
2016 llvm::Value *addr,
2017 QualType type) {
2018 llvm::Value *ptr = CGF.Builder.CreateLoad(addr, "strongdestroy");
2019 CGF.EmitARCRelease(ptr, /*precise*/ true);
2020}
2021
2022void CodeGenFunction::destroyARCStrongImprecise(CodeGenFunction &CGF,
2023 llvm::Value *addr,
2024 QualType type) {
2025 llvm::Value *ptr = CGF.Builder.CreateLoad(addr, "strongdestroy");
2026 CGF.EmitARCRelease(ptr, /*precise*/ false);
2027}
2028
2029void CodeGenFunction::destroyARCWeak(CodeGenFunction &CGF,
2030 llvm::Value *addr,
2031 QualType type) {
2032 CGF.EmitARCDestroyWeak(addr);
2033}
2034
John McCall31168b02011-06-15 23:02:42 +00002035namespace {
John McCall31168b02011-06-15 23:02:42 +00002036 struct CallObjCAutoreleasePoolObject : EHScopeStack::Cleanup {
2037 llvm::Value *Token;
2038
2039 CallObjCAutoreleasePoolObject(llvm::Value *token) : Token(token) {}
2040
John McCall30317fd2011-07-12 20:27:29 +00002041 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCall31168b02011-06-15 23:02:42 +00002042 CGF.EmitObjCAutoreleasePoolPop(Token);
2043 }
2044 };
2045 struct CallObjCMRRAutoreleasePoolObject : EHScopeStack::Cleanup {
2046 llvm::Value *Token;
2047
2048 CallObjCMRRAutoreleasePoolObject(llvm::Value *token) : Token(token) {}
2049
John McCall30317fd2011-07-12 20:27:29 +00002050 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCall31168b02011-06-15 23:02:42 +00002051 CGF.EmitObjCMRRAutoreleasePoolPop(Token);
2052 }
2053 };
2054}
2055
2056void CodeGenFunction::EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr) {
2057 if (CGM.getLangOptions().ObjCAutoRefCount)
2058 EHStack.pushCleanup<CallObjCAutoreleasePoolObject>(NormalCleanup, Ptr);
2059 else
2060 EHStack.pushCleanup<CallObjCMRRAutoreleasePoolObject>(NormalCleanup, Ptr);
2061}
2062
John McCall31168b02011-06-15 23:02:42 +00002063static TryEmitResult tryEmitARCRetainLoadOfScalar(CodeGenFunction &CGF,
2064 LValue lvalue,
2065 QualType type) {
2066 switch (type.getObjCLifetime()) {
2067 case Qualifiers::OCL_None:
2068 case Qualifiers::OCL_ExplicitNone:
2069 case Qualifiers::OCL_Strong:
2070 case Qualifiers::OCL_Autoreleasing:
John McCall55e1fbc2011-06-25 02:11:03 +00002071 return TryEmitResult(CGF.EmitLoadOfLValue(lvalue).getScalarVal(),
John McCall31168b02011-06-15 23:02:42 +00002072 false);
2073
2074 case Qualifiers::OCL_Weak:
2075 return TryEmitResult(CGF.EmitARCLoadWeakRetained(lvalue.getAddress()),
2076 true);
2077 }
2078
2079 llvm_unreachable("impossible lifetime!");
2080 return TryEmitResult();
2081}
2082
2083static TryEmitResult tryEmitARCRetainLoadOfScalar(CodeGenFunction &CGF,
2084 const Expr *e) {
2085 e = e->IgnoreParens();
2086 QualType type = e->getType();
2087
John McCall154a2fd2011-08-30 00:57:29 +00002088 // If we're loading retained from a __strong xvalue, we can avoid
2089 // an extra retain/release pair by zeroing out the source of this
2090 // "move" operation.
2091 if (e->isXValue() &&
2092 !type.isConstQualified() &&
2093 type.getObjCLifetime() == Qualifiers::OCL_Strong) {
2094 // Emit the lvalue.
2095 LValue lv = CGF.EmitLValue(e);
2096
2097 // Load the object pointer.
2098 llvm::Value *result = CGF.EmitLoadOfLValue(lv).getScalarVal();
2099
2100 // Set the source pointer to NULL.
2101 CGF.EmitStoreOfScalar(getNullForVariable(lv.getAddress()), lv);
2102
2103 return TryEmitResult(result, true);
2104 }
2105
John McCall31168b02011-06-15 23:02:42 +00002106 // As a very special optimization, in ARC++, if the l-value is the
2107 // result of a non-volatile assignment, do a simple retain of the
2108 // result of the call to objc_storeWeak instead of reloading.
2109 if (CGF.getLangOptions().CPlusPlus &&
2110 !type.isVolatileQualified() &&
2111 type.getObjCLifetime() == Qualifiers::OCL_Weak &&
2112 isa<BinaryOperator>(e) &&
2113 cast<BinaryOperator>(e)->getOpcode() == BO_Assign)
2114 return TryEmitResult(CGF.EmitScalarExpr(e), false);
2115
2116 return tryEmitARCRetainLoadOfScalar(CGF, CGF.EmitLValue(e), type);
2117}
2118
2119static llvm::Value *emitARCRetainAfterCall(CodeGenFunction &CGF,
2120 llvm::Value *value);
2121
2122/// Given that the given expression is some sort of call (which does
2123/// not return retained), emit a retain following it.
2124static llvm::Value *emitARCRetainCall(CodeGenFunction &CGF, const Expr *e) {
2125 llvm::Value *value = CGF.EmitScalarExpr(e);
2126 return emitARCRetainAfterCall(CGF, value);
2127}
2128
2129static llvm::Value *emitARCRetainAfterCall(CodeGenFunction &CGF,
2130 llvm::Value *value) {
2131 if (llvm::CallInst *call = dyn_cast<llvm::CallInst>(value)) {
2132 CGBuilderTy::InsertPoint ip = CGF.Builder.saveIP();
2133
2134 // Place the retain immediately following the call.
2135 CGF.Builder.SetInsertPoint(call->getParent(),
2136 ++llvm::BasicBlock::iterator(call));
2137 value = CGF.EmitARCRetainAutoreleasedReturnValue(value);
2138
2139 CGF.Builder.restoreIP(ip);
2140 return value;
2141 } else if (llvm::InvokeInst *invoke = dyn_cast<llvm::InvokeInst>(value)) {
2142 CGBuilderTy::InsertPoint ip = CGF.Builder.saveIP();
2143
2144 // Place the retain at the beginning of the normal destination block.
2145 llvm::BasicBlock *BB = invoke->getNormalDest();
2146 CGF.Builder.SetInsertPoint(BB, BB->begin());
2147 value = CGF.EmitARCRetainAutoreleasedReturnValue(value);
2148
2149 CGF.Builder.restoreIP(ip);
2150 return value;
2151
2152 // Bitcasts can arise because of related-result returns. Rewrite
2153 // the operand.
2154 } else if (llvm::BitCastInst *bitcast = dyn_cast<llvm::BitCastInst>(value)) {
2155 llvm::Value *operand = bitcast->getOperand(0);
2156 operand = emitARCRetainAfterCall(CGF, operand);
2157 bitcast->setOperand(0, operand);
2158 return bitcast;
2159
2160 // Generic fall-back case.
2161 } else {
2162 // Retain using the non-block variant: we never need to do a copy
2163 // of a block that's been returned to us.
2164 return CGF.EmitARCRetainNonBlock(value);
2165 }
2166}
2167
John McCallcd78e802011-09-10 01:16:55 +00002168/// Determine whether it might be important to emit a separate
2169/// objc_retain_block on the result of the given expression, or
2170/// whether it's okay to just emit it in a +1 context.
2171static bool shouldEmitSeparateBlockRetain(const Expr *e) {
2172 assert(e->getType()->isBlockPointerType());
2173 e = e->IgnoreParens();
2174
2175 // For future goodness, emit block expressions directly in +1
2176 // contexts if we can.
2177 if (isa<BlockExpr>(e))
2178 return false;
2179
2180 if (const CastExpr *cast = dyn_cast<CastExpr>(e)) {
2181 switch (cast->getCastKind()) {
2182 // Emitting these operations in +1 contexts is goodness.
2183 case CK_LValueToRValue:
John McCall2d637d22011-09-10 06:18:15 +00002184 case CK_ARCReclaimReturnedObject:
2185 case CK_ARCConsumeObject:
2186 case CK_ARCProduceObject:
John McCallcd78e802011-09-10 01:16:55 +00002187 return false;
2188
2189 // These operations preserve a block type.
2190 case CK_NoOp:
2191 case CK_BitCast:
2192 return shouldEmitSeparateBlockRetain(cast->getSubExpr());
2193
2194 // These operations are known to be bad (or haven't been considered).
2195 case CK_AnyPointerToBlockPointerCast:
2196 default:
2197 return true;
2198 }
2199 }
2200
2201 return true;
2202}
2203
John McCall31168b02011-06-15 23:02:42 +00002204static TryEmitResult
2205tryEmitARCRetainScalarExpr(CodeGenFunction &CGF, const Expr *e) {
John McCall53848232011-07-27 01:07:15 +00002206 // Look through cleanups.
2207 if (const ExprWithCleanups *cleanups = dyn_cast<ExprWithCleanups>(e)) {
2208 CodeGenFunction::RunCleanupsScope scope(CGF);
2209 return tryEmitARCRetainScalarExpr(CGF, cleanups->getSubExpr());
2210 }
2211
John McCall31168b02011-06-15 23:02:42 +00002212 // The desired result type, if it differs from the type of the
2213 // ultimate opaque expression.
Chris Lattner2192fe52011-07-18 04:24:23 +00002214 llvm::Type *resultType = 0;
John McCall31168b02011-06-15 23:02:42 +00002215
2216 while (true) {
2217 e = e->IgnoreParens();
2218
2219 // There's a break at the end of this if-chain; anything
2220 // that wants to keep looping has to explicitly continue.
2221 if (const CastExpr *ce = dyn_cast<CastExpr>(e)) {
2222 switch (ce->getCastKind()) {
2223 // No-op casts don't change the type, so we just ignore them.
2224 case CK_NoOp:
2225 e = ce->getSubExpr();
2226 continue;
2227
2228 case CK_LValueToRValue: {
2229 TryEmitResult loadResult
2230 = tryEmitARCRetainLoadOfScalar(CGF, ce->getSubExpr());
2231 if (resultType) {
2232 llvm::Value *value = loadResult.getPointer();
2233 value = CGF.Builder.CreateBitCast(value, resultType);
2234 loadResult.setPointer(value);
2235 }
2236 return loadResult;
2237 }
2238
2239 // These casts can change the type, so remember that and
2240 // soldier on. We only need to remember the outermost such
2241 // cast, though.
John McCall9320b872011-09-09 05:25:32 +00002242 case CK_CPointerToObjCPointerCast:
2243 case CK_BlockPointerToObjCPointerCast:
John McCall31168b02011-06-15 23:02:42 +00002244 case CK_AnyPointerToBlockPointerCast:
2245 case CK_BitCast:
2246 if (!resultType)
2247 resultType = CGF.ConvertType(ce->getType());
2248 e = ce->getSubExpr();
2249 assert(e->getType()->hasPointerRepresentation());
2250 continue;
2251
2252 // For consumptions, just emit the subexpression and thus elide
2253 // the retain/release pair.
John McCall2d637d22011-09-10 06:18:15 +00002254 case CK_ARCConsumeObject: {
John McCall31168b02011-06-15 23:02:42 +00002255 llvm::Value *result = CGF.EmitScalarExpr(ce->getSubExpr());
2256 if (resultType) result = CGF.Builder.CreateBitCast(result, resultType);
2257 return TryEmitResult(result, true);
2258 }
2259
John McCallcd78e802011-09-10 01:16:55 +00002260 // Block extends are net +0. Naively, we could just recurse on
2261 // the subexpression, but actually we need to ensure that the
2262 // value is copied as a block, so there's a little filter here.
John McCall2d637d22011-09-10 06:18:15 +00002263 case CK_ARCExtendBlockObject: {
John McCallcd78e802011-09-10 01:16:55 +00002264 llvm::Value *result; // will be a +0 value
2265
2266 // If we can't safely assume the sub-expression will produce a
2267 // block-copied value, emit the sub-expression at +0.
2268 if (shouldEmitSeparateBlockRetain(ce->getSubExpr())) {
2269 result = CGF.EmitScalarExpr(ce->getSubExpr());
2270
2271 // Otherwise, try to emit the sub-expression at +1 recursively.
2272 } else {
2273 TryEmitResult subresult
2274 = tryEmitARCRetainScalarExpr(CGF, ce->getSubExpr());
2275 result = subresult.getPointer();
2276
2277 // If that produced a retained value, just use that,
2278 // possibly casting down.
2279 if (subresult.getInt()) {
2280 if (resultType)
2281 result = CGF.Builder.CreateBitCast(result, resultType);
2282 return TryEmitResult(result, true);
2283 }
2284
2285 // Otherwise it's +0.
2286 }
2287
2288 // Retain the object as a block, then cast down.
2289 result = CGF.EmitARCRetainBlock(result);
2290 if (resultType) result = CGF.Builder.CreateBitCast(result, resultType);
2291 return TryEmitResult(result, true);
2292 }
2293
John McCall4db5c3c2011-07-07 06:58:02 +00002294 // For reclaims, emit the subexpression as a retained call and
2295 // skip the consumption.
John McCall2d637d22011-09-10 06:18:15 +00002296 case CK_ARCReclaimReturnedObject: {
John McCall4db5c3c2011-07-07 06:58:02 +00002297 llvm::Value *result = emitARCRetainCall(CGF, ce->getSubExpr());
2298 if (resultType) result = CGF.Builder.CreateBitCast(result, resultType);
2299 return TryEmitResult(result, true);
2300 }
2301
John McCall31168b02011-06-15 23:02:42 +00002302 case CK_GetObjCProperty: {
2303 llvm::Value *result = emitARCRetainCall(CGF, ce);
2304 if (resultType) result = CGF.Builder.CreateBitCast(result, resultType);
2305 return TryEmitResult(result, true);
2306 }
2307
2308 default:
2309 break;
2310 }
2311
2312 // Skip __extension__.
2313 } else if (const UnaryOperator *op = dyn_cast<UnaryOperator>(e)) {
2314 if (op->getOpcode() == UO_Extension) {
2315 e = op->getSubExpr();
2316 continue;
2317 }
2318
2319 // For calls and message sends, use the retained-call logic.
2320 // Delegate inits are a special case in that they're the only
2321 // returns-retained expression that *isn't* surrounded by
2322 // a consume.
2323 } else if (isa<CallExpr>(e) ||
2324 (isa<ObjCMessageExpr>(e) &&
2325 !cast<ObjCMessageExpr>(e)->isDelegateInitCall())) {
2326 llvm::Value *result = emitARCRetainCall(CGF, e);
2327 if (resultType) result = CGF.Builder.CreateBitCast(result, resultType);
2328 return TryEmitResult(result, true);
2329 }
2330
2331 // Conservatively halt the search at any other expression kind.
2332 break;
2333 }
2334
2335 // We didn't find an obvious production, so emit what we've got and
2336 // tell the caller that we didn't manage to retain.
2337 llvm::Value *result = CGF.EmitScalarExpr(e);
2338 if (resultType) result = CGF.Builder.CreateBitCast(result, resultType);
2339 return TryEmitResult(result, false);
2340}
2341
2342static llvm::Value *emitARCRetainLoadOfScalar(CodeGenFunction &CGF,
2343 LValue lvalue,
2344 QualType type) {
2345 TryEmitResult result = tryEmitARCRetainLoadOfScalar(CGF, lvalue, type);
2346 llvm::Value *value = result.getPointer();
2347 if (!result.getInt())
2348 value = CGF.EmitARCRetain(type, value);
2349 return value;
2350}
2351
2352/// EmitARCRetainScalarExpr - Semantically equivalent to
2353/// EmitARCRetainObject(e->getType(), EmitScalarExpr(e)), but making a
2354/// best-effort attempt to peephole expressions that naturally produce
2355/// retained objects.
2356llvm::Value *CodeGenFunction::EmitARCRetainScalarExpr(const Expr *e) {
2357 TryEmitResult result = tryEmitARCRetainScalarExpr(*this, e);
2358 llvm::Value *value = result.getPointer();
2359 if (!result.getInt())
2360 value = EmitARCRetain(e->getType(), value);
2361 return value;
2362}
2363
2364llvm::Value *
2365CodeGenFunction::EmitARCRetainAutoreleaseScalarExpr(const Expr *e) {
2366 TryEmitResult result = tryEmitARCRetainScalarExpr(*this, e);
2367 llvm::Value *value = result.getPointer();
2368 if (result.getInt())
2369 value = EmitARCAutorelease(value);
2370 else
2371 value = EmitARCRetainAutorelease(e->getType(), value);
2372 return value;
2373}
2374
2375std::pair<LValue,llvm::Value*>
2376CodeGenFunction::EmitARCStoreStrong(const BinaryOperator *e,
2377 bool ignored) {
2378 // Evaluate the RHS first.
2379 TryEmitResult result = tryEmitARCRetainScalarExpr(*this, e->getRHS());
2380 llvm::Value *value = result.getPointer();
2381
John McCallb726a552011-07-28 07:23:35 +00002382 bool hasImmediateRetain = result.getInt();
2383
2384 // If we didn't emit a retained object, and the l-value is of block
2385 // type, then we need to emit the block-retain immediately in case
2386 // it invalidates the l-value.
2387 if (!hasImmediateRetain && e->getType()->isBlockPointerType()) {
2388 value = EmitARCRetainBlock(value);
2389 hasImmediateRetain = true;
2390 }
2391
John McCall31168b02011-06-15 23:02:42 +00002392 LValue lvalue = EmitLValue(e->getLHS());
2393
2394 // If the RHS was emitted retained, expand this.
John McCallb726a552011-07-28 07:23:35 +00002395 if (hasImmediateRetain) {
John McCall31168b02011-06-15 23:02:42 +00002396 llvm::Value *oldValue =
2397 EmitLoadOfScalar(lvalue.getAddress(), lvalue.isVolatileQualified(),
2398 lvalue.getAlignment(), e->getType(),
2399 lvalue.getTBAAInfo());
2400 EmitStoreOfScalar(value, lvalue.getAddress(),
2401 lvalue.isVolatileQualified(), lvalue.getAlignment(),
2402 e->getType(), lvalue.getTBAAInfo());
2403 EmitARCRelease(oldValue, /*precise*/ false);
2404 } else {
John McCall55e1fbc2011-06-25 02:11:03 +00002405 value = EmitARCStoreStrong(lvalue, value, ignored);
John McCall31168b02011-06-15 23:02:42 +00002406 }
2407
2408 return std::pair<LValue,llvm::Value*>(lvalue, value);
2409}
2410
2411std::pair<LValue,llvm::Value*>
2412CodeGenFunction::EmitARCStoreAutoreleasing(const BinaryOperator *e) {
2413 llvm::Value *value = EmitARCRetainAutoreleaseScalarExpr(e->getRHS());
2414 LValue lvalue = EmitLValue(e->getLHS());
2415
2416 EmitStoreOfScalar(value, lvalue.getAddress(),
2417 lvalue.isVolatileQualified(), lvalue.getAlignment(),
2418 e->getType(), lvalue.getTBAAInfo());
2419
2420 return std::pair<LValue,llvm::Value*>(lvalue, value);
2421}
2422
2423void CodeGenFunction::EmitObjCAutoreleasePoolStmt(
2424 const ObjCAutoreleasePoolStmt &ARPS) {
2425 const Stmt *subStmt = ARPS.getSubStmt();
2426 const CompoundStmt &S = cast<CompoundStmt>(*subStmt);
2427
2428 CGDebugInfo *DI = getDebugInfo();
2429 if (DI) {
2430 DI->setLocation(S.getLBracLoc());
2431 DI->EmitRegionStart(Builder);
2432 }
2433
2434 // Keep track of the current cleanup stack depth.
2435 RunCleanupsScope Scope(*this);
John McCall24fc0de2011-07-06 00:26:06 +00002436 if (CGM.getCodeGenOpts().ObjCRuntimeHasARC) {
John McCall31168b02011-06-15 23:02:42 +00002437 llvm::Value *token = EmitObjCAutoreleasePoolPush();
2438 EHStack.pushCleanup<CallObjCAutoreleasePoolObject>(NormalCleanup, token);
2439 } else {
2440 llvm::Value *token = EmitObjCMRRAutoreleasePoolPush();
2441 EHStack.pushCleanup<CallObjCMRRAutoreleasePoolObject>(NormalCleanup, token);
2442 }
2443
2444 for (CompoundStmt::const_body_iterator I = S.body_begin(),
2445 E = S.body_end(); I != E; ++I)
2446 EmitStmt(*I);
2447
2448 if (DI) {
2449 DI->setLocation(S.getRBracLoc());
2450 DI->EmitRegionEnd(Builder);
2451 }
2452}
John McCall1bd25562011-06-24 23:21:27 +00002453
2454/// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
2455/// make sure it survives garbage collection until this point.
2456void CodeGenFunction::EmitExtendGCLifetime(llvm::Value *object) {
2457 // We just use an inline assembly.
John McCall1bd25562011-06-24 23:21:27 +00002458 llvm::FunctionType *extenderType
Jay Foad5709f7c2011-07-29 13:56:53 +00002459 = llvm::FunctionType::get(VoidTy, VoidPtrTy, /*variadic*/ false);
John McCall1bd25562011-06-24 23:21:27 +00002460 llvm::Value *extender
2461 = llvm::InlineAsm::get(extenderType,
2462 /* assembly */ "",
2463 /* constraints */ "r",
2464 /* side effects */ true);
2465
2466 object = Builder.CreateBitCast(object, VoidPtrTy);
2467 Builder.CreateCall(extender, object)->setDoesNotThrow();
2468}
2469
Ted Kremenek43e06332008-04-09 15:51:31 +00002470CGObjCRuntime::~CGObjCRuntime() {}