blob: 344c1ee18047de1203601fe178831c2f8bad27cf [file] [log] [blame]
Anders Carlsson55085182007-08-21 17:43:55 +00001//===---- CGBuiltin.cpp - Emit LLVM Code for builtins ---------------------===//
2//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner0bc735f2007-12-29 19:59:25 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Anders Carlsson55085182007-08-21 17:43:55 +00007//
8//===----------------------------------------------------------------------===//
9//
10// This contains code to emit Objective-C code as LLVM code.
11//
12//===----------------------------------------------------------------------===//
13
Devang Patelbcbd03a2011-01-19 01:36:36 +000014#include "CGDebugInfo.h"
Ted Kremenek2979ec72008-04-09 15:51:31 +000015#include "CGObjCRuntime.h"
Anders Carlsson55085182007-08-21 17:43:55 +000016#include "CodeGenFunction.h"
17#include "CodeGenModule.h"
John McCallf85e1932011-06-15 23:02:42 +000018#include "TargetInfo.h"
Daniel Dunbar85c59ed2008-08-29 08:11:39 +000019#include "clang/AST/ASTContext.h"
Daniel Dunbarc4a1dea2008-08-11 05:35:13 +000020#include "clang/AST/DeclObjC.h"
Chris Lattner16f00492009-04-26 01:32:48 +000021#include "clang/AST/StmtObjC.h"
Daniel Dunbare66f4e32008-09-03 00:27:26 +000022#include "clang/Basic/Diagnostic.h"
Anders Carlsson3d8400d2008-08-30 19:51:14 +000023#include "llvm/ADT/STLExtras.h"
Daniel Dunbarc1cf4a52008-09-24 04:04:31 +000024#include "llvm/Target/TargetData.h"
John McCallf85e1932011-06-15 23:02:42 +000025#include "llvm/InlineAsm.h"
Anders Carlsson55085182007-08-21 17:43:55 +000026using namespace clang;
27using namespace CodeGen;
28
John McCallf85e1932011-06-15 23:02:42 +000029typedef llvm::PointerIntPair<llvm::Value*,1,bool> TryEmitResult;
30static TryEmitResult
31tryEmitARCRetainScalarExpr(CodeGenFunction &CGF, const Expr *e);
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 Lattner2acc6e32011-07-18 04:24:23 +000036 llvm::Type *type =
John McCallf85e1932011-06-15 23:02:42 +000037 cast<llvm::PointerType>(addr->getType())->getElementType();
38 return llvm::ConstantPointerNull::get(cast<llvm::PointerType>(type));
39}
40
Chris Lattner8fdf3282008-06-24 17:04:18 +000041/// Emits an instance of NSConstantString representing the object.
Mike Stump1eb44332009-09-09 15:08:12 +000042llvm::Value *CodeGenFunction::EmitObjCStringLiteral(const ObjCStringLiteral *E)
Daniel Dunbar71fcec92008-11-25 21:53:21 +000043{
David Chisnall0d13f6f2010-01-23 02:40:42 +000044 llvm::Constant *C =
45 CGM.getObjCRuntime().GenerateConstantString(E->getString());
Daniel Dunbared7c6182008-08-20 00:28:19 +000046 // FIXME: This bitcast should just be made an invariant on the Runtime.
Owen Anderson3c4972d2009-07-29 18:54:39 +000047 return llvm::ConstantExpr::getBitCast(C, ConvertType(E->getType()));
Chris Lattner8fdf3282008-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 Dunbar6d5a1c22010-02-03 20:11:42 +000056 return CGM.getObjCRuntime().GetSelector(Builder, E->getSelector());
Chris Lattner8fdf3282008-06-24 17:04:18 +000057}
58
Daniel Dunbared7c6182008-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 Lattner8fdf3282008-06-24 17:04:18 +000063
Douglas Gregor926df6c2011-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 McCallf85e1932011-06-15 23:02:42 +000072
Douglas Gregor926df6c2011-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 Lattner8fdf3282008-06-24 17:04:18 +000082
John McCalldc7c5ad2011-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 McCallef072fd2010-05-22 01:48:05 +0000130RValue CodeGenFunction::EmitObjCMessageExpr(const ObjCMessageExpr *E,
131 ReturnValueSlot Return) {
Chris Lattner8fdf3282008-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 Stump1eb44332009-09-09 15:08:12 +0000135
John McCallf85e1932011-06-15 23:02:42 +0000136 bool isDelegateInit = E->isDelegateInitCall();
137
John McCalldc7c5ad2011-07-22 08:53:00 +0000138 const ObjCMethodDecl *method = E->getMethodDecl();
139
John McCallf85e1932011-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 McCalldc7c5ad2011-07-22 08:53:00 +0000147 method &&
148 method->hasAttr<NSConsumesSelfAttr>());
John McCallf85e1932011-06-15 23:02:42 +0000149
Daniel Dunbar208ff5e2008-08-11 18:12:00 +0000150 CGObjCRuntime &Runtime = CGM.getObjCRuntime();
Chris Lattner8fdf3282008-06-24 17:04:18 +0000151 bool isSuperMessage = false;
Daniel Dunbarf56f1912008-08-25 08:19:24 +0000152 bool isClassMessage = false;
David Chisnallc6cd5fd2010-04-28 19:33:36 +0000153 ObjCInterfaceDecl *OID = 0;
Chris Lattner8fdf3282008-06-24 17:04:18 +0000154 // Find the receiver
Douglas Gregor926df6c2011-06-11 01:09:30 +0000155 QualType ReceiverType;
Daniel Dunbar0b647a62010-04-22 03:17:06 +0000156 llvm::Value *Receiver = 0;
Douglas Gregor04badcf2010-04-21 00:45:42 +0000157 switch (E->getReceiverKind()) {
158 case ObjCMessageExpr::Instance:
Douglas Gregor926df6c2011-06-11 01:09:30 +0000159 ReceiverType = E->getInstanceReceiver()->getType();
John McCallf85e1932011-06-15 23:02:42 +0000160 if (retainSelf) {
161 TryEmitResult ter = tryEmitARCRetainScalarExpr(*this,
162 E->getInstanceReceiver());
163 Receiver = ter.getPointer();
John McCalldc7c5ad2011-07-22 08:53:00 +0000164 if (ter.getInt()) retainSelf = false;
John McCallf85e1932011-06-15 23:02:42 +0000165 } else
166 Receiver = EmitScalarExpr(E->getInstanceReceiver());
Douglas Gregor04badcf2010-04-21 00:45:42 +0000167 break;
Daniel Dunbarddb2a3d2008-08-16 00:25:02 +0000168
Douglas Gregor04badcf2010-04-21 00:45:42 +0000169 case ObjCMessageExpr::Class: {
Douglas Gregor926df6c2011-06-11 01:09:30 +0000170 ReceiverType = E->getClassReceiver();
171 const ObjCObjectType *ObjTy = ReceiverType->getAs<ObjCObjectType>();
John McCall3031c632010-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 Chisnallc6cd5fd2010-04-28 19:33:36 +0000175 Receiver = Runtime.GetClass(Builder, OID);
Daniel Dunbarf56f1912008-08-25 08:19:24 +0000176 isClassMessage = true;
Douglas Gregor04badcf2010-04-21 00:45:42 +0000177 break;
178 }
179
180 case ObjCMessageExpr::SuperInstance:
Douglas Gregor926df6c2011-06-11 01:09:30 +0000181 ReceiverType = E->getSuperType();
Chris Lattner8fdf3282008-06-24 17:04:18 +0000182 Receiver = LoadObjCSelf();
Douglas Gregor04badcf2010-04-21 00:45:42 +0000183 isSuperMessage = true;
184 break;
185
186 case ObjCMessageExpr::SuperClass:
Douglas Gregor926df6c2011-06-11 01:09:30 +0000187 ReceiverType = E->getSuperType();
Douglas Gregor04badcf2010-04-21 00:45:42 +0000188 Receiver = LoadObjCSelf();
189 isSuperMessage = true;
190 isClassMessage = true;
191 break;
Chris Lattner8fdf3282008-06-24 17:04:18 +0000192 }
193
John McCalldc7c5ad2011-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 McCallf85e1932011-06-15 23:02:42 +0000205 QualType ResultType =
John McCalldc7c5ad2011-07-22 08:53:00 +0000206 method ? method->getResultType() : E->getType();
John McCallf85e1932011-06-15 23:02:42 +0000207
Daniel Dunbar19cd87e2008-08-30 03:02:31 +0000208 CallArgList Args;
John McCalldc7c5ad2011-07-22 08:53:00 +0000209 EmitCallArgs(Args, method, E->arg_begin(), E->arg_end());
Mike Stump1eb44332009-09-09 15:08:12 +0000210
John McCallf85e1932011-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 Carlsson7e70fb22010-06-21 20:59:55 +0000229
Douglas Gregor926df6c2011-06-11 01:09:30 +0000230 RValue result;
Chris Lattner8fdf3282008-06-24 17:04:18 +0000231 if (isSuperMessage) {
Chris Lattner9384c762008-06-26 04:42:20 +0000232 // super is only valid in an Objective-C method
233 const ObjCMethodDecl *OMD = cast<ObjCMethodDecl>(CurFuncDecl);
Fariborz Jahanian7ce77922009-02-28 20:07:56 +0000234 bool isCategoryImpl = isa<ObjCCategoryImplDecl>(OMD->getDeclContext());
Douglas Gregor926df6c2011-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 McCalldc7c5ad2011-07-22 08:53:00 +0000242 method);
Douglas Gregor926df6c2011-06-11 01:09:30 +0000243 } else {
244 result = Runtime.GenerateMessageSend(*this, Return, ResultType,
245 E->getSelector(),
246 Receiver, Args, OID,
John McCalldc7c5ad2011-07-22 08:53:00 +0000247 method);
Chris Lattner8fdf3282008-06-24 17:04:18 +0000248 }
John McCallf85e1932011-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 Lattner2acc6e32011-07-18 04:24:23 +0000259 llvm::Type *selfTy =
John McCallf85e1932011-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 McCalldc7c5ad2011-07-22 08:53:00 +0000266 return AdjustRelatedResultType(*this, E, method, result);
Anders Carlsson55085182007-08-21 17:43:55 +0000267}
268
John McCallf85e1932011-06-15 23:02:42 +0000269namespace {
270struct FinishARCDealloc : EHScopeStack::Cleanup {
John McCallad346f42011-07-12 20:27:29 +0000271 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCallf85e1932011-06-15 23:02:42 +0000272 const ObjCMethodDecl *method = cast<ObjCMethodDecl>(CGF.CurCodeDecl);
John McCall799d34e2011-07-13 18:26:47 +0000273
274 const ObjCImplDecl *impl = cast<ObjCImplDecl>(method->getDeclContext());
John McCallf85e1932011-06-15 23:02:42 +0000275 const ObjCInterfaceDecl *iface = impl->getClassInterface();
276 if (!iface->getSuperClass()) return;
277
John McCall799d34e2011-07-13 18:26:47 +0000278 bool isCategory = isa<ObjCCategoryImplDecl>(impl);
279
John McCallf85e1932011-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 McCall799d34e2011-07-13 18:26:47 +0000288 isCategory,
John McCallf85e1932011-06-15 23:02:42 +0000289 self,
290 /*is class msg*/ false,
291 args,
292 method);
293 }
294};
295}
296
Daniel Dunbaraf05bb92008-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 Jahanian679a5022009-01-10 21:06:09 +0000300void CodeGenFunction::StartObjCMethod(const ObjCMethodDecl *OMD,
Devang Patel8d3f8972011-05-19 23:37:41 +0000301 const ObjCContainerDecl *CD,
302 SourceLocation StartLoc) {
John McCalld26bc762011-03-09 04:27:21 +0000303 FunctionArgList args;
Devang Patel4800ea62010-04-05 21:09:15 +0000304 // Check if we should generate debug info for this method.
Devang Patelaa112892011-03-07 18:45:56 +0000305 if (CGM.getModuleDebugInfo() && !OMD->hasAttr<NoDebugAttr>())
306 DebugInfo = CGM.getModuleDebugInfo();
Devang Patel4800ea62010-04-05 21:09:15 +0000307
Fariborz Jahanian679a5022009-01-10 21:06:09 +0000308 llvm::Function *Fn = CGM.getObjCRuntime().GenerateMethod(OMD, CD);
Daniel Dunbarf80519b2008-09-04 23:41:35 +0000309
Daniel Dunbar0e4f40e2009-04-17 00:48:04 +0000310 const CGFunctionInfo &FI = CGM.getTypes().getFunctionInfo(OMD);
311 CGM.SetInternalFunctionAttributes(OMD, Fn, FI);
Chris Lattner41110242008-06-17 18:05:57 +0000312
John McCalld26bc762011-03-09 04:27:21 +0000313 args.push_back(OMD->getSelfDecl());
314 args.push_back(OMD->getCmdDecl());
Chris Lattner41110242008-06-17 18:05:57 +0000315
Argyrios Kyrtzidis491306a2011-10-03 06:37:04 +0000316 for (ObjCMethodDecl::param_const_iterator PI = OMD->param_begin(),
Chris Lattner89951a82009-02-20 18:43:26 +0000317 E = OMD->param_end(); PI != E; ++PI)
John McCalld26bc762011-03-09 04:27:21 +0000318 args.push_back(*PI);
Chris Lattner41110242008-06-17 18:05:57 +0000319
Peter Collingbourne14110472011-01-13 18:57:25 +0000320 CurGD = OMD;
321
Devang Patel8d3f8972011-05-19 23:37:41 +0000322 StartFunction(OMD, OMD->getResultType(), Fn, FI, args, StartLoc);
John McCallf85e1932011-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 Dunbaraf05bb92008-08-26 08:29:31 +0000333}
Daniel Dunbarb7ec2462008-08-16 03:19:19 +0000334
John McCallf85e1932011-06-15 23:02:42 +0000335static llvm::Value *emitARCRetainLoadOfScalar(CodeGenFunction &CGF,
336 LValue lvalue, QualType type);
337
Daniel Dunbaraf05bb92008-08-26 08:29:31 +0000338/// Generate an Objective-C method. An Objective-C method is a C function with
Mike Stump1eb44332009-09-09 15:08:12 +0000339/// its pointer, name, and types registered in the class struture.
Daniel Dunbaraf05bb92008-08-26 08:29:31 +0000340void CodeGenFunction::GenerateObjCMethod(const ObjCMethodDecl *OMD) {
Devang Patel8d3f8972011-05-19 23:37:41 +0000341 StartObjCMethod(OMD, OMD->getClassInterface(), OMD->getLocStart());
Argyrios Kyrtzidis6fb0aee2009-06-30 02:35:26 +0000342 EmitStmt(OMD->getBody());
343 FinishFunction(OMD->getBodyRBrace());
Daniel Dunbaraf05bb92008-08-26 08:29:31 +0000344}
345
John McCall41bdde92011-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 McCall1e1f4872011-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) {
Eli Friedmande24d442011-09-13 20:48:30 +0000381 // FIXME: Allow unaligned atomic load/store on x86. (It is not
382 // currently supported by the backend.)
383 return 0;
John McCall1e1f4872011-09-13 03:34:09 +0000384}
385
386/// Return the maximum size that permits atomic accesses for the given
387/// architecture.
388static CharUnits getMaxAtomicAccessSize(CodeGenModule &CGM,
389 llvm::Triple::ArchType arch) {
390 // ARM has 8-byte atomic accesses, but it's not clear whether we
391 // want to rely on them here.
392
393 // In the default case, just assume that any size up to a pointer is
394 // fine given adequate alignment.
395 return CharUnits::fromQuantity(CGM.PointerSizeInBytes);
396}
397
398namespace {
399 class PropertyImplStrategy {
400 public:
401 enum StrategyKind {
402 /// The 'native' strategy is to use the architecture's provided
403 /// reads and writes.
404 Native,
405
406 /// Use objc_setProperty and objc_getProperty.
407 GetSetProperty,
408
409 /// Use objc_setProperty for the setter, but use expression
410 /// evaluation for the getter.
411 SetPropertyAndExpressionGet,
412
413 /// Use objc_copyStruct.
414 CopyStruct,
415
416 /// The 'expression' strategy is to emit normal assignment or
417 /// lvalue-to-rvalue expressions.
418 Expression
419 };
420
421 StrategyKind getKind() const { return StrategyKind(Kind); }
422
423 bool hasStrongMember() const { return HasStrong; }
424 bool isAtomic() const { return IsAtomic; }
425 bool isCopy() const { return IsCopy; }
426
427 CharUnits getIvarSize() const { return IvarSize; }
428 CharUnits getIvarAlignment() const { return IvarAlignment; }
429
430 PropertyImplStrategy(CodeGenModule &CGM,
431 const ObjCPropertyImplDecl *propImpl);
432
433 private:
434 unsigned Kind : 8;
435 unsigned IsAtomic : 1;
436 unsigned IsCopy : 1;
437 unsigned HasStrong : 1;
438
439 CharUnits IvarSize;
440 CharUnits IvarAlignment;
441 };
442}
443
444/// Pick an implementation strategy for the the given property synthesis.
445PropertyImplStrategy::PropertyImplStrategy(CodeGenModule &CGM,
446 const ObjCPropertyImplDecl *propImpl) {
447 const ObjCPropertyDecl *prop = propImpl->getPropertyDecl();
John McCall265941b2011-09-13 18:31:23 +0000448 ObjCPropertyDecl::SetterKind setterKind = prop->getSetterKind();
John McCall1e1f4872011-09-13 03:34:09 +0000449
John McCall265941b2011-09-13 18:31:23 +0000450 IsCopy = (setterKind == ObjCPropertyDecl::Copy);
451 IsAtomic = prop->isAtomic();
John McCall1e1f4872011-09-13 03:34:09 +0000452 HasStrong = false; // doesn't matter here.
453
454 // Evaluate the ivar's size and alignment.
455 ObjCIvarDecl *ivar = propImpl->getPropertyIvarDecl();
456 QualType ivarType = ivar->getType();
457 llvm::tie(IvarSize, IvarAlignment)
458 = CGM.getContext().getTypeInfoInChars(ivarType);
459
460 // If we have a copy property, we always have to use getProperty/setProperty.
John McCall265941b2011-09-13 18:31:23 +0000461 // TODO: we could actually use setProperty and an expression for non-atomics.
John McCall1e1f4872011-09-13 03:34:09 +0000462 if (IsCopy) {
463 Kind = GetSetProperty;
464 return;
465 }
466
John McCall265941b2011-09-13 18:31:23 +0000467 // Handle retain.
468 if (setterKind == ObjCPropertyDecl::Retain) {
John McCall1e1f4872011-09-13 03:34:09 +0000469 // In GC-only, there's nothing special that needs to be done.
Douglas Gregore289d812011-09-13 17:21:33 +0000470 if (CGM.getLangOptions().getGC() == LangOptions::GCOnly) {
John McCall1e1f4872011-09-13 03:34:09 +0000471 // fallthrough
472
473 // In ARC, if the property is non-atomic, use expression emission,
474 // which translates to objc_storeStrong. This isn't required, but
475 // it's slightly nicer.
476 } else if (CGM.getLangOptions().ObjCAutoRefCount && !IsAtomic) {
477 Kind = Expression;
478 return;
479
480 // Otherwise, we need to at least use setProperty. However, if
481 // the property isn't atomic, we can use normal expression
482 // emission for the getter.
483 } else if (!IsAtomic) {
484 Kind = SetPropertyAndExpressionGet;
485 return;
486
487 // Otherwise, we have to use both setProperty and getProperty.
488 } else {
489 Kind = GetSetProperty;
490 return;
491 }
492 }
493
494 // If we're not atomic, just use expression accesses.
495 if (!IsAtomic) {
496 Kind = Expression;
497 return;
498 }
499
John McCall5889c602011-09-13 05:36:29 +0000500 // Properties on bitfield ivars need to be emitted using expression
501 // accesses even if they're nominally atomic.
502 if (ivar->isBitField()) {
503 Kind = Expression;
504 return;
505 }
506
John McCall1e1f4872011-09-13 03:34:09 +0000507 // GC-qualified or ARC-qualified ivars need to be emitted as
508 // expressions. This actually works out to being atomic anyway,
509 // except for ARC __strong, but that should trigger the above code.
510 if (ivarType.hasNonTrivialObjCLifetime() ||
Douglas Gregore289d812011-09-13 17:21:33 +0000511 (CGM.getLangOptions().getGC() &&
John McCall1e1f4872011-09-13 03:34:09 +0000512 CGM.getContext().getObjCGCAttrKind(ivarType))) {
513 Kind = Expression;
514 return;
515 }
516
517 // Compute whether the ivar has strong members.
Douglas Gregore289d812011-09-13 17:21:33 +0000518 if (CGM.getLangOptions().getGC())
John McCall1e1f4872011-09-13 03:34:09 +0000519 if (const RecordType *recordType = ivarType->getAs<RecordType>())
520 HasStrong = recordType->getDecl()->hasObjectMember();
521
522 // We can never access structs with object members with a native
523 // access, because we need to use write barriers. This is what
524 // objc_copyStruct is for.
525 if (HasStrong) {
526 Kind = CopyStruct;
527 return;
528 }
529
530 // Otherwise, this is target-dependent and based on the size and
531 // alignment of the ivar.
John McCallc5d9a902011-09-13 07:33:34 +0000532
533 // If the size of the ivar is not a power of two, give up. We don't
534 // want to get into the business of doing compare-and-swaps.
535 if (!IvarSize.isPowerOfTwo()) {
536 Kind = CopyStruct;
537 return;
538 }
539
John McCall1e1f4872011-09-13 03:34:09 +0000540 llvm::Triple::ArchType arch =
541 CGM.getContext().getTargetInfo().getTriple().getArch();
542
543 // Most architectures require memory to fit within a single cache
544 // line, so the alignment has to be at least the size of the access.
545 // Otherwise we have to grab a lock.
546 if (IvarAlignment < IvarSize && !hasUnalignedAtomics(arch)) {
547 Kind = CopyStruct;
548 return;
549 }
550
551 // If the ivar's size exceeds the architecture's maximum atomic
552 // access size, we have to use CopyStruct.
553 if (IvarSize > getMaxAtomicAccessSize(CGM, arch)) {
554 Kind = CopyStruct;
555 return;
556 }
557
558 // Otherwise, we can use native loads and stores.
559 Kind = Native;
560}
Daniel Dunbaraf05bb92008-08-26 08:29:31 +0000561
562/// GenerateObjCGetter - Generate an Objective-C property getter
Steve Naroff489034c2009-01-10 22:55:25 +0000563/// function. The given Decl must be an ObjCImplementationDecl. @synthesize
564/// is illegal within a category.
Fariborz Jahanianfef30b52008-12-09 20:23:04 +0000565void CodeGenFunction::GenerateObjCGetter(ObjCImplementationDecl *IMP,
566 const ObjCPropertyImplDecl *PID) {
Daniel Dunbaraf05bb92008-08-26 08:29:31 +0000567 const ObjCPropertyDecl *PD = PID->getPropertyDecl();
568 ObjCMethodDecl *OMD = PD->getGetterMethodDecl();
569 assert(OMD && "Invalid call to generate getter (empty method)");
Devang Patel8d3f8972011-05-19 23:37:41 +0000570 StartObjCMethod(OMD, IMP->getClassInterface(), PID->getLocStart());
Mike Stump1eb44332009-09-09 15:08:12 +0000571
John McCall1e1f4872011-09-13 03:34:09 +0000572 generateObjCGetterBody(IMP, PID);
573
574 FinishFunction();
575}
576
John McCall6c11f0b2011-09-13 06:00:03 +0000577static bool hasTrivialGetExpr(const ObjCPropertyImplDecl *propImpl) {
578 const Expr *getter = propImpl->getGetterCXXConstructor();
John McCall1e1f4872011-09-13 03:34:09 +0000579 if (!getter) return true;
580
581 // Sema only makes only of these when the ivar has a C++ class type,
582 // so the form is pretty constrained.
583
John McCall6c11f0b2011-09-13 06:00:03 +0000584 // If the property has a reference type, we might just be binding a
585 // reference, in which case the result will be a gl-value. We should
586 // treat this as a non-trivial operation.
587 if (getter->isGLValue())
588 return false;
589
John McCall1e1f4872011-09-13 03:34:09 +0000590 // If we selected a trivial copy-constructor, we're okay.
591 if (const CXXConstructExpr *construct = dyn_cast<CXXConstructExpr>(getter))
592 return (construct->getConstructor()->isTrivial());
593
594 // The constructor might require cleanups (in which case it's never
595 // trivial).
596 assert(isa<ExprWithCleanups>(getter));
597 return false;
598}
599
600void
601CodeGenFunction::generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
602 const ObjCPropertyImplDecl *propImpl) {
603 // If there's a non-trivial 'get' expression, we just have to emit that.
604 if (!hasTrivialGetExpr(propImpl)) {
605 ReturnStmt ret(SourceLocation(), propImpl->getGetterCXXConstructor(),
606 /*nrvo*/ 0);
607 EmitReturnStmt(ret);
608 return;
609 }
610
611 const ObjCPropertyDecl *prop = propImpl->getPropertyDecl();
612 QualType propType = prop->getType();
613 ObjCMethodDecl *getterMethod = prop->getGetterMethodDecl();
614
615 ObjCIvarDecl *ivar = propImpl->getPropertyIvarDecl();
616
617 // Pick an implementation strategy.
618 PropertyImplStrategy strategy(CGM, propImpl);
619 switch (strategy.getKind()) {
620 case PropertyImplStrategy::Native: {
621 LValue LV = EmitLValueForIvar(TypeOfSelfObject(), LoadObjCSelf(), ivar, 0);
622
623 // Currently, all atomic accesses have to be through integer
624 // types, so there's no point in trying to pick a prettier type.
625 llvm::Type *bitcastType =
626 llvm::Type::getIntNTy(getLLVMContext(),
627 getContext().toBits(strategy.getIvarSize()));
628 bitcastType = bitcastType->getPointerTo(); // addrspace 0 okay
629
630 // Perform an atomic load. This does not impose ordering constraints.
631 llvm::Value *ivarAddr = LV.getAddress();
632 ivarAddr = Builder.CreateBitCast(ivarAddr, bitcastType);
633 llvm::LoadInst *load = Builder.CreateLoad(ivarAddr, "load");
634 load->setAlignment(strategy.getIvarAlignment().getQuantity());
635 load->setAtomic(llvm::Unordered);
636
637 // Store that value into the return address. Doing this with a
638 // bitcast is likely to produce some pretty ugly IR, but it's not
639 // the *most* terrible thing in the world.
640 Builder.CreateStore(load, Builder.CreateBitCast(ReturnValue, bitcastType));
641
642 // Make sure we don't do an autorelease.
643 AutoreleaseResult = false;
644 return;
645 }
646
647 case PropertyImplStrategy::GetSetProperty: {
648 llvm::Value *getPropertyFn =
649 CGM.getObjCRuntime().GetPropertyGetFunction();
650 if (!getPropertyFn) {
651 CGM.ErrorUnsupported(propImpl, "Obj-C getter requiring atomic copy");
Daniel Dunbarc1cf4a52008-09-24 04:04:31 +0000652 return;
653 }
654
655 // Return (ivar-type) objc_getProperty((id) self, _cmd, offset, true).
656 // FIXME: Can't this be simpler? This might even be worse than the
657 // corresponding gcc code.
John McCall1e1f4872011-09-13 03:34:09 +0000658 llvm::Value *cmd =
659 Builder.CreateLoad(LocalDeclMap[getterMethod->getCmdDecl()], "cmd");
660 llvm::Value *self = Builder.CreateBitCast(LoadObjCSelf(), VoidPtrTy);
661 llvm::Value *ivarOffset =
662 EmitIvarOffset(classImpl->getClassInterface(), ivar);
663
664 CallArgList args;
665 args.add(RValue::get(self), getContext().getObjCIdType());
666 args.add(RValue::get(cmd), getContext().getObjCSelType());
667 args.add(RValue::get(ivarOffset), getContext().getPointerDiffType());
John McCall265941b2011-09-13 18:31:23 +0000668 args.add(RValue::get(Builder.getInt1(strategy.isAtomic())),
669 getContext().BoolTy);
John McCall1e1f4872011-09-13 03:34:09 +0000670
Daniel Dunbare4be5a62009-02-03 23:43:59 +0000671 // FIXME: We shouldn't need to get the function info here, the
672 // runtime already should have computed it to build the function.
John McCall1e1f4872011-09-13 03:34:09 +0000673 RValue RV = EmitCall(getTypes().getFunctionInfo(propType, args,
John McCall41bdde92011-09-12 23:06:44 +0000674 FunctionType::ExtInfo()),
John McCall1e1f4872011-09-13 03:34:09 +0000675 getPropertyFn, ReturnValueSlot(), args);
676
Daniel Dunbarc1cf4a52008-09-24 04:04:31 +0000677 // We need to fix the type here. Ivars with copy & retain are
678 // always objects so we don't need to worry about complex or
679 // aggregates.
Mike Stump1eb44332009-09-09 15:08:12 +0000680 RV = RValue::get(Builder.CreateBitCast(RV.getScalarVal(),
John McCall1e1f4872011-09-13 03:34:09 +0000681 getTypes().ConvertType(propType)));
682
683 EmitReturnOfRValue(RV, propType);
John McCallf85e1932011-06-15 23:02:42 +0000684
685 // objc_getProperty does an autorelease, so we should suppress ours.
686 AutoreleaseResult = false;
John McCallf85e1932011-06-15 23:02:42 +0000687
John McCall1e1f4872011-09-13 03:34:09 +0000688 return;
689 }
690
691 case PropertyImplStrategy::CopyStruct:
692 emitStructGetterCall(*this, ivar, strategy.isAtomic(),
693 strategy.hasStrongMember());
694 return;
695
696 case PropertyImplStrategy::Expression:
697 case PropertyImplStrategy::SetPropertyAndExpressionGet: {
698 LValue LV = EmitLValueForIvar(TypeOfSelfObject(), LoadObjCSelf(), ivar, 0);
699
700 QualType ivarType = ivar->getType();
701 if (ivarType->isAnyComplexType()) {
702 ComplexPairTy pair = LoadComplexFromAddr(LV.getAddress(),
703 LV.isVolatileQualified());
704 StoreComplexToAddr(pair, ReturnValue, LV.isVolatileQualified());
705 } else if (hasAggregateLLVMType(ivarType)) {
706 // The return value slot is guaranteed to not be aliased, but
707 // that's not necessarily the same as "on the stack", so
708 // we still potentially need objc_memmove_collectable.
709 EmitAggregateCopy(ReturnValue, LV.getAddress(), ivarType);
710 } else {
John McCallba3dd902011-07-22 05:23:13 +0000711 llvm::Value *value;
712 if (propType->isReferenceType()) {
713 value = LV.getAddress();
714 } else {
715 // We want to load and autoreleaseReturnValue ARC __weak ivars.
716 if (LV.getQuals().getObjCLifetime() == Qualifiers::OCL_Weak) {
John McCall1e1f4872011-09-13 03:34:09 +0000717 value = emitARCRetainLoadOfScalar(*this, LV, ivarType);
John McCallba3dd902011-07-22 05:23:13 +0000718
719 // Otherwise we want to do a simple load, suppressing the
720 // final autorelease.
John McCallf85e1932011-06-15 23:02:42 +0000721 } else {
John McCallba3dd902011-07-22 05:23:13 +0000722 value = EmitLoadOfLValue(LV).getScalarVal();
723 AutoreleaseResult = false;
Fariborz Jahanian14086762011-03-28 23:47:18 +0000724 }
John McCallf85e1932011-06-15 23:02:42 +0000725
John McCallba3dd902011-07-22 05:23:13 +0000726 value = Builder.CreateBitCast(value, ConvertType(propType));
727 }
728
729 EmitReturnOfRValue(RValue::get(value), propType);
Fariborz Jahanianed1d29d2009-03-03 18:49:40 +0000730 }
John McCall1e1f4872011-09-13 03:34:09 +0000731 return;
Daniel Dunbarc1cf4a52008-09-24 04:04:31 +0000732 }
Daniel Dunbaraf05bb92008-08-26 08:29:31 +0000733
John McCall1e1f4872011-09-13 03:34:09 +0000734 }
735 llvm_unreachable("bad @property implementation strategy!");
Daniel Dunbaraf05bb92008-08-26 08:29:31 +0000736}
737
John McCall41bdde92011-09-12 23:06:44 +0000738/// emitStructSetterCall - Call the runtime function to store the value
739/// from the first formal parameter into the given ivar.
740static void emitStructSetterCall(CodeGenFunction &CGF, ObjCMethodDecl *OMD,
741 ObjCIvarDecl *ivar) {
Fariborz Jahanian2846b972011-02-18 19:15:13 +0000742 // objc_copyStruct (&structIvar, &Arg,
743 // sizeof (struct something), true, false);
John McCallbbb253c2011-09-10 09:30:49 +0000744 CallArgList args;
745
746 // The first argument is the address of the ivar.
John McCall41bdde92011-09-12 23:06:44 +0000747 llvm::Value *ivarAddr = CGF.EmitLValueForIvar(CGF.TypeOfSelfObject(),
748 CGF.LoadObjCSelf(), ivar, 0)
749 .getAddress();
750 ivarAddr = CGF.Builder.CreateBitCast(ivarAddr, CGF.Int8PtrTy);
751 args.add(RValue::get(ivarAddr), CGF.getContext().VoidPtrTy);
John McCallbbb253c2011-09-10 09:30:49 +0000752
753 // The second argument is the address of the parameter variable.
John McCall41bdde92011-09-12 23:06:44 +0000754 ParmVarDecl *argVar = *OMD->param_begin();
755 DeclRefExpr argRef(argVar, argVar->getType(), VK_LValue, SourceLocation());
756 llvm::Value *argAddr = CGF.EmitLValue(&argRef).getAddress();
757 argAddr = CGF.Builder.CreateBitCast(argAddr, CGF.Int8PtrTy);
758 args.add(RValue::get(argAddr), CGF.getContext().VoidPtrTy);
John McCallbbb253c2011-09-10 09:30:49 +0000759
760 // The third argument is the sizeof the type.
761 llvm::Value *size =
John McCall41bdde92011-09-12 23:06:44 +0000762 CGF.CGM.getSize(CGF.getContext().getTypeSizeInChars(ivar->getType()));
763 args.add(RValue::get(size), CGF.getContext().getSizeType());
John McCallbbb253c2011-09-10 09:30:49 +0000764
John McCall41bdde92011-09-12 23:06:44 +0000765 // The fourth argument is the 'isAtomic' flag.
766 args.add(RValue::get(CGF.Builder.getTrue()), CGF.getContext().BoolTy);
John McCallbbb253c2011-09-10 09:30:49 +0000767
John McCall41bdde92011-09-12 23:06:44 +0000768 // The fifth argument is the 'hasStrong' flag.
769 // FIXME: should this really always be false?
770 args.add(RValue::get(CGF.Builder.getFalse()), CGF.getContext().BoolTy);
771
772 llvm::Value *copyStructFn = CGF.CGM.getObjCRuntime().GetSetStructFunction();
773 CGF.EmitCall(CGF.getTypes().getFunctionInfo(CGF.getContext().VoidTy, args,
774 FunctionType::ExtInfo()),
775 copyStructFn, ReturnValueSlot(), args);
Fariborz Jahanian2846b972011-02-18 19:15:13 +0000776}
777
John McCall1e1f4872011-09-13 03:34:09 +0000778static bool hasTrivialSetExpr(const ObjCPropertyImplDecl *PID) {
779 Expr *setter = PID->getSetterCXXAssignment();
780 if (!setter) return true;
781
782 // Sema only makes only of these when the ivar has a C++ class type,
783 // so the form is pretty constrained.
John McCall71c758d2011-09-10 09:17:20 +0000784
785 // An operator call is trivial if the function it calls is trivial.
John McCall1e1f4872011-09-13 03:34:09 +0000786 // This also implies that there's nothing non-trivial going on with
787 // the arguments, because operator= can only be trivial if it's a
788 // synthesized assignment operator and therefore both parameters are
789 // references.
790 if (CallExpr *call = dyn_cast<CallExpr>(setter)) {
John McCall71c758d2011-09-10 09:17:20 +0000791 if (const FunctionDecl *callee
792 = dyn_cast_or_null<FunctionDecl>(call->getCalleeDecl()))
793 if (callee->isTrivial())
794 return true;
795 return false;
Fariborz Jahanian01cb3072011-04-06 16:05:26 +0000796 }
John McCall71c758d2011-09-10 09:17:20 +0000797
John McCall1e1f4872011-09-13 03:34:09 +0000798 assert(isa<ExprWithCleanups>(setter));
John McCall71c758d2011-09-10 09:17:20 +0000799 return false;
800}
801
John McCall71c758d2011-09-10 09:17:20 +0000802void
803CodeGenFunction::generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
804 const ObjCPropertyImplDecl *propImpl) {
805 // Just use the setter expression if Sema gave us one and it's
806 // non-trivial. There's no way to do this atomically.
John McCall1e1f4872011-09-13 03:34:09 +0000807 if (!hasTrivialSetExpr(propImpl)) {
John McCall71c758d2011-09-10 09:17:20 +0000808 EmitStmt(propImpl->getSetterCXXAssignment());
809 return;
810 }
811
812 const ObjCPropertyDecl *prop = propImpl->getPropertyDecl();
813 ObjCIvarDecl *ivar = propImpl->getPropertyIvarDecl();
814 ObjCMethodDecl *setterMethod = prop->getSetterMethodDecl();
815
John McCall1e1f4872011-09-13 03:34:09 +0000816 PropertyImplStrategy strategy(CGM, propImpl);
817 switch (strategy.getKind()) {
818 case PropertyImplStrategy::Native: {
819 llvm::Value *argAddr = LocalDeclMap[*setterMethod->param_begin()];
John McCall71c758d2011-09-10 09:17:20 +0000820
John McCall1e1f4872011-09-13 03:34:09 +0000821 LValue ivarLValue =
822 EmitLValueForIvar(TypeOfSelfObject(), LoadObjCSelf(), ivar, /*quals*/ 0);
823 llvm::Value *ivarAddr = ivarLValue.getAddress();
John McCall71c758d2011-09-10 09:17:20 +0000824
John McCall1e1f4872011-09-13 03:34:09 +0000825 // Currently, all atomic accesses have to be through integer
826 // types, so there's no point in trying to pick a prettier type.
827 llvm::Type *bitcastType =
828 llvm::Type::getIntNTy(getLLVMContext(),
829 getContext().toBits(strategy.getIvarSize()));
830 bitcastType = bitcastType->getPointerTo(); // addrspace 0 okay
831
832 // Cast both arguments to the chosen operation type.
833 argAddr = Builder.CreateBitCast(argAddr, bitcastType);
834 ivarAddr = Builder.CreateBitCast(ivarAddr, bitcastType);
835
836 // This bitcast load is likely to cause some nasty IR.
837 llvm::Value *load = Builder.CreateLoad(argAddr);
838
839 // Perform an atomic store. There are no memory ordering requirements.
840 llvm::StoreInst *store = Builder.CreateStore(load, ivarAddr);
841 store->setAlignment(strategy.getIvarAlignment().getQuantity());
842 store->setAtomic(llvm::Unordered);
843 return;
844 }
845
846 case PropertyImplStrategy::GetSetProperty:
847 case PropertyImplStrategy::SetPropertyAndExpressionGet: {
John McCall71c758d2011-09-10 09:17:20 +0000848 llvm::Value *setPropertyFn =
849 CGM.getObjCRuntime().GetPropertySetFunction();
850 if (!setPropertyFn) {
851 CGM.ErrorUnsupported(propImpl, "Obj-C setter requiring atomic copy");
852 return;
853 }
854
855 // Emit objc_setProperty((id) self, _cmd, offset, arg,
856 // <is-atomic>, <is-copy>).
857 llvm::Value *cmd =
858 Builder.CreateLoad(LocalDeclMap[setterMethod->getCmdDecl()]);
859 llvm::Value *self =
860 Builder.CreateBitCast(LoadObjCSelf(), VoidPtrTy);
861 llvm::Value *ivarOffset =
862 EmitIvarOffset(classImpl->getClassInterface(), ivar);
863 llvm::Value *arg = LocalDeclMap[*setterMethod->param_begin()];
864 arg = Builder.CreateBitCast(Builder.CreateLoad(arg, "arg"), VoidPtrTy);
865
866 CallArgList args;
867 args.add(RValue::get(self), getContext().getObjCIdType());
868 args.add(RValue::get(cmd), getContext().getObjCSelType());
869 args.add(RValue::get(ivarOffset), getContext().getPointerDiffType());
870 args.add(RValue::get(arg), getContext().getObjCIdType());
John McCall1e1f4872011-09-13 03:34:09 +0000871 args.add(RValue::get(Builder.getInt1(strategy.isAtomic())),
872 getContext().BoolTy);
873 args.add(RValue::get(Builder.getInt1(strategy.isCopy())),
874 getContext().BoolTy);
John McCall71c758d2011-09-10 09:17:20 +0000875 // FIXME: We shouldn't need to get the function info here, the runtime
876 // already should have computed it to build the function.
877 EmitCall(getTypes().getFunctionInfo(getContext().VoidTy, args,
878 FunctionType::ExtInfo()),
879 setPropertyFn, ReturnValueSlot(), args);
880 return;
881 }
882
John McCall1e1f4872011-09-13 03:34:09 +0000883 case PropertyImplStrategy::CopyStruct:
John McCall41bdde92011-09-12 23:06:44 +0000884 emitStructSetterCall(*this, setterMethod, ivar);
John McCall71c758d2011-09-10 09:17:20 +0000885 return;
John McCall1e1f4872011-09-13 03:34:09 +0000886
887 case PropertyImplStrategy::Expression:
888 break;
John McCall71c758d2011-09-10 09:17:20 +0000889 }
890
891 // Otherwise, fake up some ASTs and emit a normal assignment.
892 ValueDecl *selfDecl = setterMethod->getSelfDecl();
893 DeclRefExpr self(selfDecl, selfDecl->getType(), VK_LValue, SourceLocation());
894 ImplicitCastExpr selfLoad(ImplicitCastExpr::OnStack,
895 selfDecl->getType(), CK_LValueToRValue, &self,
896 VK_RValue);
897 ObjCIvarRefExpr ivarRef(ivar, ivar->getType().getNonReferenceType(),
898 SourceLocation(), &selfLoad, true, true);
899
900 ParmVarDecl *argDecl = *setterMethod->param_begin();
901 QualType argType = argDecl->getType().getNonReferenceType();
902 DeclRefExpr arg(argDecl, argType, VK_LValue, SourceLocation());
903 ImplicitCastExpr argLoad(ImplicitCastExpr::OnStack,
904 argType.getUnqualifiedType(), CK_LValueToRValue,
905 &arg, VK_RValue);
906
907 // The property type can differ from the ivar type in some situations with
908 // Objective-C pointer types, we can always bit cast the RHS in these cases.
909 // The following absurdity is just to ensure well-formed IR.
910 CastKind argCK = CK_NoOp;
911 if (ivarRef.getType()->isObjCObjectPointerType()) {
912 if (argLoad.getType()->isObjCObjectPointerType())
913 argCK = CK_BitCast;
914 else if (argLoad.getType()->isBlockPointerType())
915 argCK = CK_BlockPointerToObjCPointerCast;
916 else
917 argCK = CK_CPointerToObjCPointerCast;
918 } else if (ivarRef.getType()->isBlockPointerType()) {
919 if (argLoad.getType()->isBlockPointerType())
920 argCK = CK_BitCast;
921 else
922 argCK = CK_AnyPointerToBlockPointerCast;
923 } else if (ivarRef.getType()->isPointerType()) {
924 argCK = CK_BitCast;
925 }
926 ImplicitCastExpr argCast(ImplicitCastExpr::OnStack,
927 ivarRef.getType(), argCK, &argLoad,
928 VK_RValue);
929 Expr *finalArg = &argLoad;
930 if (!getContext().hasSameUnqualifiedType(ivarRef.getType(),
931 argLoad.getType()))
932 finalArg = &argCast;
933
934
935 BinaryOperator assign(&ivarRef, finalArg, BO_Assign,
936 ivarRef.getType(), VK_RValue, OK_Ordinary,
937 SourceLocation());
938 EmitStmt(&assign);
Fariborz Jahanian01cb3072011-04-06 16:05:26 +0000939}
940
Daniel Dunbaraf05bb92008-08-26 08:29:31 +0000941/// GenerateObjCSetter - Generate an Objective-C property setter
Steve Naroff489034c2009-01-10 22:55:25 +0000942/// function. The given Decl must be an ObjCImplementationDecl. @synthesize
943/// is illegal within a category.
Fariborz Jahanianfef30b52008-12-09 20:23:04 +0000944void CodeGenFunction::GenerateObjCSetter(ObjCImplementationDecl *IMP,
945 const ObjCPropertyImplDecl *PID) {
Daniel Dunbaraf05bb92008-08-26 08:29:31 +0000946 const ObjCPropertyDecl *PD = PID->getPropertyDecl();
947 ObjCMethodDecl *OMD = PD->getSetterMethodDecl();
948 assert(OMD && "Invalid call to generate setter (empty method)");
Devang Patel8d3f8972011-05-19 23:37:41 +0000949 StartObjCMethod(OMD, IMP->getClassInterface(), PID->getLocStart());
Daniel Dunbar86957eb2008-09-24 06:32:09 +0000950
John McCall71c758d2011-09-10 09:17:20 +0000951 generateObjCSetterBody(IMP, PID);
Daniel Dunbaraf05bb92008-08-26 08:29:31 +0000952
953 FinishFunction();
Chris Lattner41110242008-06-17 18:05:57 +0000954}
955
John McCalle81ac692011-03-22 07:05:39 +0000956namespace {
John McCall9928c482011-07-12 16:41:08 +0000957 struct DestroyIvar : EHScopeStack::Cleanup {
958 private:
959 llvm::Value *addr;
John McCalle81ac692011-03-22 07:05:39 +0000960 const ObjCIvarDecl *ivar;
John McCall9928c482011-07-12 16:41:08 +0000961 CodeGenFunction::Destroyer &destroyer;
962 bool useEHCleanupForArray;
963 public:
964 DestroyIvar(llvm::Value *addr, const ObjCIvarDecl *ivar,
965 CodeGenFunction::Destroyer *destroyer,
966 bool useEHCleanupForArray)
967 : addr(addr), ivar(ivar), destroyer(*destroyer),
968 useEHCleanupForArray(useEHCleanupForArray) {}
John McCalle81ac692011-03-22 07:05:39 +0000969
John McCallad346f42011-07-12 20:27:29 +0000970 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCall9928c482011-07-12 16:41:08 +0000971 LValue lvalue
972 = CGF.EmitLValueForIvar(CGF.TypeOfSelfObject(), addr, ivar, /*CVR*/ 0);
973 CGF.emitDestroy(lvalue.getAddress(), ivar->getType(), destroyer,
John McCallad346f42011-07-12 20:27:29 +0000974 flags.isForNormalCleanup() && useEHCleanupForArray);
John McCalle81ac692011-03-22 07:05:39 +0000975 }
976 };
977}
978
John McCall9928c482011-07-12 16:41:08 +0000979/// Like CodeGenFunction::destroyARCStrong, but do it with a call.
980static void destroyARCStrongWithStore(CodeGenFunction &CGF,
981 llvm::Value *addr,
982 QualType type) {
983 llvm::Value *null = getNullForVariable(addr);
984 CGF.EmitARCStoreStrongCall(addr, null, /*ignored*/ true);
985}
John McCallf85e1932011-06-15 23:02:42 +0000986
John McCalle81ac692011-03-22 07:05:39 +0000987static void emitCXXDestructMethod(CodeGenFunction &CGF,
988 ObjCImplementationDecl *impl) {
989 CodeGenFunction::RunCleanupsScope scope(CGF);
990
991 llvm::Value *self = CGF.LoadObjCSelf();
992
Jordy Rosedb8264e2011-07-22 02:08:32 +0000993 const ObjCInterfaceDecl *iface = impl->getClassInterface();
994 for (const ObjCIvarDecl *ivar = iface->all_declared_ivar_begin();
John McCalle81ac692011-03-22 07:05:39 +0000995 ivar; ivar = ivar->getNextIvar()) {
996 QualType type = ivar->getType();
997
John McCalle81ac692011-03-22 07:05:39 +0000998 // Check whether the ivar is a destructible type.
John McCall9928c482011-07-12 16:41:08 +0000999 QualType::DestructionKind dtorKind = type.isDestructedType();
1000 if (!dtorKind) continue;
John McCalle81ac692011-03-22 07:05:39 +00001001
John McCall9928c482011-07-12 16:41:08 +00001002 CodeGenFunction::Destroyer *destroyer = 0;
John McCalle81ac692011-03-22 07:05:39 +00001003
John McCall9928c482011-07-12 16:41:08 +00001004 // Use a call to objc_storeStrong to destroy strong ivars, for the
1005 // general benefit of the tools.
1006 if (dtorKind == QualType::DK_objc_strong_lifetime) {
1007 destroyer = &destroyARCStrongWithStore;
John McCallf85e1932011-06-15 23:02:42 +00001008
John McCall9928c482011-07-12 16:41:08 +00001009 // Otherwise use the default for the destruction kind.
1010 } else {
1011 destroyer = &CGF.getDestroyer(dtorKind);
John McCalle81ac692011-03-22 07:05:39 +00001012 }
John McCall9928c482011-07-12 16:41:08 +00001013
1014 CleanupKind cleanupKind = CGF.getCleanupKind(dtorKind);
1015
1016 CGF.EHStack.pushCleanup<DestroyIvar>(cleanupKind, self, ivar, destroyer,
1017 cleanupKind & EHCleanup);
John McCalle81ac692011-03-22 07:05:39 +00001018 }
1019
1020 assert(scope.requiresCleanups() && "nothing to do in .cxx_destruct?");
1021}
1022
Fariborz Jahanian109dfc62010-04-28 21:28:56 +00001023void CodeGenFunction::GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1024 ObjCMethodDecl *MD,
1025 bool ctor) {
Fariborz Jahanian109dfc62010-04-28 21:28:56 +00001026 MD->createImplicitParams(CGM.getContext(), IMP->getClassInterface());
Devang Patel8d3f8972011-05-19 23:37:41 +00001027 StartObjCMethod(MD, IMP->getClassInterface(), MD->getLocStart());
John McCalle81ac692011-03-22 07:05:39 +00001028
1029 // Emit .cxx_construct.
Fariborz Jahanian109dfc62010-04-28 21:28:56 +00001030 if (ctor) {
John McCallf85e1932011-06-15 23:02:42 +00001031 // Suppress the final autorelease in ARC.
1032 AutoreleaseResult = false;
1033
Chris Lattner5f9e2722011-07-23 10:55:15 +00001034 SmallVector<CXXCtorInitializer *, 8> IvarInitializers;
John McCalle81ac692011-03-22 07:05:39 +00001035 for (ObjCImplementationDecl::init_const_iterator B = IMP->init_begin(),
1036 E = IMP->init_end(); B != E; ++B) {
1037 CXXCtorInitializer *IvarInit = (*B);
Francois Pichet00eb3f92010-12-04 09:14:42 +00001038 FieldDecl *Field = IvarInit->getAnyMember();
Fariborz Jahanian109dfc62010-04-28 21:28:56 +00001039 ObjCIvarDecl *Ivar = cast<ObjCIvarDecl>(Field);
Fariborz Jahanian9b4d4fc2010-04-28 22:30:33 +00001040 LValue LV = EmitLValueForIvar(TypeOfSelfObject(),
1041 LoadObjCSelf(), Ivar, 0);
John McCall7c2349b2011-08-25 20:40:09 +00001042 EmitAggExpr(IvarInit->getInit(),
1043 AggValueSlot::forLValue(LV, AggValueSlot::IsDestructed,
John McCall410ffb22011-08-25 23:04:34 +00001044 AggValueSlot::DoesNotNeedGCBarriers,
1045 AggValueSlot::IsNotAliased));
Fariborz Jahanian109dfc62010-04-28 21:28:56 +00001046 }
1047 // constructor returns 'self'.
1048 CodeGenTypes &Types = CGM.getTypes();
1049 QualType IdTy(CGM.getContext().getObjCIdType());
1050 llvm::Value *SelfAsId =
1051 Builder.CreateBitCast(LoadObjCSelf(), Types.ConvertType(IdTy));
1052 EmitReturnOfRValue(RValue::get(SelfAsId), IdTy);
John McCalle81ac692011-03-22 07:05:39 +00001053
1054 // Emit .cxx_destruct.
Chandler Carruthbc397cf2010-05-06 00:20:39 +00001055 } else {
John McCalle81ac692011-03-22 07:05:39 +00001056 emitCXXDestructMethod(*this, IMP);
Fariborz Jahanian109dfc62010-04-28 21:28:56 +00001057 }
1058 FinishFunction();
1059}
1060
Fariborz Jahanian0b2bd472010-04-13 00:38:05 +00001061bool CodeGenFunction::IndirectObjCSetterArg(const CGFunctionInfo &FI) {
1062 CGFunctionInfo::const_arg_iterator it = FI.arg_begin();
1063 it++; it++;
1064 const ABIArgInfo &AI = it->info;
1065 // FIXME. Is this sufficient check?
1066 return (AI.getKind() == ABIArgInfo::Indirect);
1067}
1068
Fariborz Jahanian15bd5882010-04-13 18:32:24 +00001069bool CodeGenFunction::IvarTypeWithAggrGCObjects(QualType Ty) {
Douglas Gregore289d812011-09-13 17:21:33 +00001070 if (CGM.getLangOptions().getGC() == LangOptions::NonGC)
Fariborz Jahanian15bd5882010-04-13 18:32:24 +00001071 return false;
1072 if (const RecordType *FDTTy = Ty.getTypePtr()->getAs<RecordType>())
1073 return FDTTy->getDecl()->hasObjectMember();
1074 return false;
1075}
1076
Daniel Dunbarc1cf4a52008-09-24 04:04:31 +00001077llvm::Value *CodeGenFunction::LoadObjCSelf() {
Daniel Dunbarb7ec2462008-08-16 03:19:19 +00001078 const ObjCMethodDecl *OMD = cast<ObjCMethodDecl>(CurFuncDecl);
1079 return Builder.CreateLoad(LocalDeclMap[OMD->getSelfDecl()], "self");
Chris Lattner41110242008-06-17 18:05:57 +00001080}
1081
Fariborz Jahanian45012a72009-02-03 00:09:52 +00001082QualType CodeGenFunction::TypeOfSelfObject() {
1083 const ObjCMethodDecl *OMD = cast<ObjCMethodDecl>(CurFuncDecl);
1084 ImplicitParamDecl *selfDecl = OMD->getSelfDecl();
Steve Naroff14108da2009-07-10 23:34:53 +00001085 const ObjCObjectPointerType *PTy = cast<ObjCObjectPointerType>(
1086 getContext().getCanonicalType(selfDecl->getType()));
Fariborz Jahanian45012a72009-02-03 00:09:52 +00001087 return PTy->getPointeeType();
1088}
1089
John McCalle68b9842010-12-04 03:11:00 +00001090LValue
1091CodeGenFunction::EmitObjCPropertyRefLValue(const ObjCPropertyRefExpr *E) {
1092 // This is a special l-value that just issues sends when we load or
1093 // store through it.
1094
1095 // For certain base kinds, we need to emit the base immediately.
1096 llvm::Value *Base;
1097 if (E->isSuperReceiver())
1098 Base = LoadObjCSelf();
1099 else if (E->isClassReceiver())
1100 Base = CGM.getObjCRuntime().GetClass(Builder, E->getClassReceiver());
1101 else
1102 Base = EmitScalarExpr(E->getBase());
1103 return LValue::MakePropertyRef(E, Base);
1104}
1105
1106static RValue GenerateMessageSendSuper(CodeGenFunction &CGF,
1107 ReturnValueSlot Return,
1108 QualType ResultType,
1109 Selector S,
1110 llvm::Value *Receiver,
1111 const CallArgList &CallArgs) {
1112 const ObjCMethodDecl *OMD = cast<ObjCMethodDecl>(CGF.CurFuncDecl);
Fariborz Jahanianf4695572009-03-20 19:18:21 +00001113 bool isClassMessage = OMD->isClassMethod();
1114 bool isCategoryImpl = isa<ObjCCategoryImplDecl>(OMD->getDeclContext());
John McCalle68b9842010-12-04 03:11:00 +00001115 return CGF.CGM.getObjCRuntime()
1116 .GenerateMessageSendSuper(CGF, Return, ResultType,
1117 S, OMD->getClassInterface(),
1118 isCategoryImpl, Receiver,
1119 isClassMessage, CallArgs);
Fariborz Jahanianf4695572009-03-20 19:18:21 +00001120}
1121
John McCall119a1c62010-12-04 02:32:38 +00001122RValue CodeGenFunction::EmitLoadOfPropertyRefLValue(LValue LV,
1123 ReturnValueSlot Return) {
1124 const ObjCPropertyRefExpr *E = LV.getPropertyRefExpr();
Fariborz Jahanian68af13f2011-03-30 16:11:20 +00001125 QualType ResultType = E->getGetterResultType();
John McCall12f78a62010-12-02 01:19:52 +00001126 Selector S;
Douglas Gregor926df6c2011-06-11 01:09:30 +00001127 const ObjCMethodDecl *method;
John McCall12f78a62010-12-02 01:19:52 +00001128 if (E->isExplicitProperty()) {
1129 const ObjCPropertyDecl *Property = E->getExplicitProperty();
1130 S = Property->getGetterName();
Douglas Gregor926df6c2011-06-11 01:09:30 +00001131 method = Property->getGetterMethodDecl();
Mike Stumpb3589f42009-07-30 22:28:39 +00001132 } else {
Douglas Gregor926df6c2011-06-11 01:09:30 +00001133 method = E->getImplicitPropertyGetter();
1134 S = method->getSelector();
Fariborz Jahanian43f44702008-11-22 22:30:21 +00001135 }
John McCall12f78a62010-12-02 01:19:52 +00001136
John McCall119a1c62010-12-04 02:32:38 +00001137 llvm::Value *Receiver = LV.getPropertyRefBaseAddr();
John McCalle68b9842010-12-04 03:11:00 +00001138
John McCallf85e1932011-06-15 23:02:42 +00001139 if (CGM.getLangOptions().ObjCAutoRefCount) {
1140 QualType receiverType;
1141 if (E->isSuperReceiver())
1142 receiverType = E->getSuperReceiverType();
1143 else if (E->isClassReceiver())
1144 receiverType = getContext().getObjCClassType();
1145 else
1146 receiverType = E->getBase()->getType();
1147 }
1148
John McCalle68b9842010-12-04 03:11:00 +00001149 // Accesses to 'super' follow a different code path.
1150 if (E->isSuperReceiver())
Douglas Gregor926df6c2011-06-11 01:09:30 +00001151 return AdjustRelatedResultType(*this, E, method,
1152 GenerateMessageSendSuper(*this, Return,
1153 ResultType,
1154 S, Receiver,
1155 CallArgList()));
John McCall119a1c62010-12-04 02:32:38 +00001156 const ObjCInterfaceDecl *ReceiverClass
1157 = (E->isClassReceiver() ? E->getClassReceiver() : 0);
Douglas Gregor926df6c2011-06-11 01:09:30 +00001158 return AdjustRelatedResultType(*this, E, method,
John McCallf85e1932011-06-15 23:02:42 +00001159 CGM.getObjCRuntime().
1160 GenerateMessageSend(*this, Return, ResultType, S,
1161 Receiver, CallArgList(), ReceiverClass));
Daniel Dunbar9c3fc702008-08-27 06:57:25 +00001162}
1163
John McCall119a1c62010-12-04 02:32:38 +00001164void CodeGenFunction::EmitStoreThroughPropertyRefLValue(RValue Src,
1165 LValue Dst) {
1166 const ObjCPropertyRefExpr *E = Dst.getPropertyRefExpr();
John McCall12f78a62010-12-02 01:19:52 +00001167 Selector S = E->getSetterSelector();
Fariborz Jahanian68af13f2011-03-30 16:11:20 +00001168 QualType ArgType = E->getSetterArgType();
1169
Fariborz Jahanianb19c76e2011-02-08 22:33:23 +00001170 // FIXME. Other than scalars, AST is not adequate for setter and
1171 // getter type mismatches which require conversion.
1172 if (Src.isScalar()) {
1173 llvm::Value *SrcVal = Src.getScalarVal();
1174 QualType DstType = getContext().getCanonicalType(ArgType);
Chris Lattner2acc6e32011-07-18 04:24:23 +00001175 llvm::Type *DstTy = ConvertType(DstType);
Fariborz Jahanianb19c76e2011-02-08 22:33:23 +00001176 if (SrcVal->getType() != DstTy)
1177 Src =
1178 RValue::get(EmitScalarConversion(SrcVal, E->getType(), DstType));
1179 }
1180
John McCalle68b9842010-12-04 03:11:00 +00001181 CallArgList Args;
Eli Friedman04c9a492011-05-02 17:57:46 +00001182 Args.add(Src, ArgType);
John McCalle68b9842010-12-04 03:11:00 +00001183
1184 llvm::Value *Receiver = Dst.getPropertyRefBaseAddr();
1185 QualType ResultType = getContext().VoidTy;
1186
John McCall12f78a62010-12-02 01:19:52 +00001187 if (E->isSuperReceiver()) {
John McCalle68b9842010-12-04 03:11:00 +00001188 GenerateMessageSendSuper(*this, ReturnValueSlot(),
1189 ResultType, S, Receiver, Args);
John McCall12f78a62010-12-02 01:19:52 +00001190 return;
1191 }
1192
John McCall119a1c62010-12-04 02:32:38 +00001193 const ObjCInterfaceDecl *ReceiverClass
1194 = (E->isClassReceiver() ? E->getClassReceiver() : 0);
John McCall12f78a62010-12-02 01:19:52 +00001195
John McCall12f78a62010-12-02 01:19:52 +00001196 CGM.getObjCRuntime().GenerateMessageSend(*this, ReturnValueSlot(),
John McCalle68b9842010-12-04 03:11:00 +00001197 ResultType, S, Receiver, Args,
1198 ReceiverClass);
Daniel Dunbar85c59ed2008-08-29 08:11:39 +00001199}
1200
Chris Lattner74391b42009-03-22 21:03:39 +00001201void CodeGenFunction::EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S){
Mike Stump1eb44332009-09-09 15:08:12 +00001202 llvm::Constant *EnumerationMutationFn =
Daniel Dunbarc1cf4a52008-09-24 04:04:31 +00001203 CGM.getObjCRuntime().EnumerationMutationFunction();
Mike Stump1eb44332009-09-09 15:08:12 +00001204
Daniel Dunbarc1cf4a52008-09-24 04:04:31 +00001205 if (!EnumerationMutationFn) {
1206 CGM.ErrorUnsupported(&S, "Obj-C fast enumeration for this runtime");
1207 return;
1208 }
1209
Devang Patelbcbd03a2011-01-19 01:36:36 +00001210 CGDebugInfo *DI = getDebugInfo();
1211 if (DI) {
1212 DI->setLocation(S.getSourceRange().getBegin());
Eric Christopheraa2164c2011-09-29 00:00:45 +00001213 DI->EmitLexicalBlockStart(Builder);
Devang Patelbcbd03a2011-01-19 01:36:36 +00001214 }
1215
Devang Patel9d99f2d2011-06-13 23:15:32 +00001216 // The local variable comes into scope immediately.
1217 AutoVarEmission variable = AutoVarEmission::invalid();
1218 if (const DeclStmt *SD = dyn_cast<DeclStmt>(S.getElement()))
1219 variable = EmitAutoVarAlloca(*cast<VarDecl>(SD->getSingleDecl()));
1220
John McCalld88687f2011-01-07 01:49:06 +00001221 JumpDest LoopEnd = getJumpDestInCurrentScope("forcoll.end");
Mike Stump1eb44332009-09-09 15:08:12 +00001222
Anders Carlssonf484c312008-08-31 02:33:12 +00001223 // Fast enumeration state.
Douglas Gregor0815b572011-08-09 17:23:49 +00001224 QualType StateTy = CGM.getObjCFastEnumerationStateType();
Daniel Dunbar195337d2010-02-09 02:48:28 +00001225 llvm::Value *StatePtr = CreateMemTemp(StateTy, "state.ptr");
Anders Carlsson1884eb02010-05-22 17:35:42 +00001226 EmitNullInitialization(StatePtr, StateTy);
Mike Stump1eb44332009-09-09 15:08:12 +00001227
Anders Carlssonf484c312008-08-31 02:33:12 +00001228 // Number of elements in the items array.
Anders Carlsson2abd89c2008-08-31 04:05:03 +00001229 static const unsigned NumItems = 16;
Mike Stump1eb44332009-09-09 15:08:12 +00001230
John McCalld88687f2011-01-07 01:49:06 +00001231 // Fetch the countByEnumeratingWithState:objects:count: selector.
Benjamin Kramerad468862010-03-30 11:36:44 +00001232 IdentifierInfo *II[] = {
1233 &CGM.getContext().Idents.get("countByEnumeratingWithState"),
1234 &CGM.getContext().Idents.get("objects"),
1235 &CGM.getContext().Idents.get("count")
1236 };
1237 Selector FastEnumSel =
1238 CGM.getContext().Selectors.getSelector(llvm::array_lengthof(II), &II[0]);
Anders Carlssonf484c312008-08-31 02:33:12 +00001239
1240 QualType ItemsTy =
1241 getContext().getConstantArrayType(getContext().getObjCIdType(),
Mike Stump1eb44332009-09-09 15:08:12 +00001242 llvm::APInt(32, NumItems),
Anders Carlssonf484c312008-08-31 02:33:12 +00001243 ArrayType::Normal, 0);
Daniel Dunbar195337d2010-02-09 02:48:28 +00001244 llvm::Value *ItemsPtr = CreateMemTemp(ItemsTy, "items.ptr");
Mike Stump1eb44332009-09-09 15:08:12 +00001245
John McCall990567c2011-07-27 01:07:15 +00001246 // Emit the collection pointer. In ARC, we do a retain.
1247 llvm::Value *Collection;
1248 if (getLangOptions().ObjCAutoRefCount) {
1249 Collection = EmitARCRetainScalarExpr(S.getCollection());
1250
1251 // Enter a cleanup to do the release.
1252 EmitObjCConsumeObject(S.getCollection()->getType(), Collection);
1253 } else {
1254 Collection = EmitScalarExpr(S.getCollection());
1255 }
Mike Stump1eb44332009-09-09 15:08:12 +00001256
John McCall4b302d32011-08-05 00:14:38 +00001257 // The 'continue' label needs to appear within the cleanup for the
1258 // collection object.
1259 JumpDest AfterBody = getJumpDestInCurrentScope("forcoll.next");
1260
John McCalld88687f2011-01-07 01:49:06 +00001261 // Send it our message:
Anders Carlssonf484c312008-08-31 02:33:12 +00001262 CallArgList Args;
John McCalld88687f2011-01-07 01:49:06 +00001263
1264 // The first argument is a temporary of the enumeration-state type.
Eli Friedman04c9a492011-05-02 17:57:46 +00001265 Args.add(RValue::get(StatePtr), getContext().getPointerType(StateTy));
Mike Stump1eb44332009-09-09 15:08:12 +00001266
John McCalld88687f2011-01-07 01:49:06 +00001267 // The second argument is a temporary array with space for NumItems
1268 // pointers. We'll actually be loading elements from the array
1269 // pointer written into the control state; this buffer is so that
1270 // collections that *aren't* backed by arrays can still queue up
1271 // batches of elements.
Eli Friedman04c9a492011-05-02 17:57:46 +00001272 Args.add(RValue::get(ItemsPtr), getContext().getPointerType(ItemsTy));
Mike Stump1eb44332009-09-09 15:08:12 +00001273
John McCalld88687f2011-01-07 01:49:06 +00001274 // The third argument is the capacity of that temporary array.
Chris Lattner2acc6e32011-07-18 04:24:23 +00001275 llvm::Type *UnsignedLongLTy = ConvertType(getContext().UnsignedLongTy);
Owen Anderson4a28d5d2009-07-24 23:12:58 +00001276 llvm::Constant *Count = llvm::ConstantInt::get(UnsignedLongLTy, NumItems);
Eli Friedman04c9a492011-05-02 17:57:46 +00001277 Args.add(RValue::get(Count), getContext().UnsignedLongTy);
Mike Stump1eb44332009-09-09 15:08:12 +00001278
John McCalld88687f2011-01-07 01:49:06 +00001279 // Start the enumeration.
Mike Stump1eb44332009-09-09 15:08:12 +00001280 RValue CountRV =
John McCallef072fd2010-05-22 01:48:05 +00001281 CGM.getObjCRuntime().GenerateMessageSend(*this, ReturnValueSlot(),
Anders Carlssonf484c312008-08-31 02:33:12 +00001282 getContext().UnsignedLongTy,
1283 FastEnumSel,
David Chisnallc6cd5fd2010-04-28 19:33:36 +00001284 Collection, Args);
Anders Carlssonf484c312008-08-31 02:33:12 +00001285
John McCalld88687f2011-01-07 01:49:06 +00001286 // The initial number of objects that were returned in the buffer.
1287 llvm::Value *initialBufferLimit = CountRV.getScalarVal();
Mike Stump1eb44332009-09-09 15:08:12 +00001288
John McCalld88687f2011-01-07 01:49:06 +00001289 llvm::BasicBlock *EmptyBB = createBasicBlock("forcoll.empty");
1290 llvm::BasicBlock *LoopInitBB = createBasicBlock("forcoll.loopinit");
Mike Stump1eb44332009-09-09 15:08:12 +00001291
John McCalld88687f2011-01-07 01:49:06 +00001292 llvm::Value *zero = llvm::Constant::getNullValue(UnsignedLongLTy);
Anders Carlssonf484c312008-08-31 02:33:12 +00001293
John McCalld88687f2011-01-07 01:49:06 +00001294 // If the limit pointer was zero to begin with, the collection is
1295 // empty; skip all this.
1296 Builder.CreateCondBr(Builder.CreateICmpEQ(initialBufferLimit, zero, "iszero"),
1297 EmptyBB, LoopInitBB);
Anders Carlssonf484c312008-08-31 02:33:12 +00001298
John McCalld88687f2011-01-07 01:49:06 +00001299 // Otherwise, initialize the loop.
1300 EmitBlock(LoopInitBB);
Mike Stump1eb44332009-09-09 15:08:12 +00001301
John McCalld88687f2011-01-07 01:49:06 +00001302 // Save the initial mutations value. This is the value at an
1303 // address that was written into the state object by
1304 // countByEnumeratingWithState:objects:count:.
Mike Stump1eb44332009-09-09 15:08:12 +00001305 llvm::Value *StateMutationsPtrPtr =
Anders Carlsson2abd89c2008-08-31 04:05:03 +00001306 Builder.CreateStructGEP(StatePtr, 2, "mutationsptr.ptr");
Mike Stump1eb44332009-09-09 15:08:12 +00001307 llvm::Value *StateMutationsPtr = Builder.CreateLoad(StateMutationsPtrPtr,
Anders Carlsson2abd89c2008-08-31 04:05:03 +00001308 "mutationsptr");
Mike Stump1eb44332009-09-09 15:08:12 +00001309
John McCalld88687f2011-01-07 01:49:06 +00001310 llvm::Value *initialMutations =
1311 Builder.CreateLoad(StateMutationsPtr, "forcoll.initial-mutations");
Mike Stump1eb44332009-09-09 15:08:12 +00001312
John McCalld88687f2011-01-07 01:49:06 +00001313 // Start looping. This is the point we return to whenever we have a
1314 // fresh, non-empty batch of objects.
1315 llvm::BasicBlock *LoopBodyBB = createBasicBlock("forcoll.loopbody");
1316 EmitBlock(LoopBodyBB);
Mike Stump1eb44332009-09-09 15:08:12 +00001317
John McCalld88687f2011-01-07 01:49:06 +00001318 // The current index into the buffer.
Jay Foadbbf3bac2011-03-30 11:28:58 +00001319 llvm::PHINode *index = Builder.CreatePHI(UnsignedLongLTy, 3, "forcoll.index");
John McCalld88687f2011-01-07 01:49:06 +00001320 index->addIncoming(zero, LoopInitBB);
Anders Carlssonf484c312008-08-31 02:33:12 +00001321
John McCalld88687f2011-01-07 01:49:06 +00001322 // The current buffer size.
Jay Foadbbf3bac2011-03-30 11:28:58 +00001323 llvm::PHINode *count = Builder.CreatePHI(UnsignedLongLTy, 3, "forcoll.count");
John McCalld88687f2011-01-07 01:49:06 +00001324 count->addIncoming(initialBufferLimit, LoopInitBB);
Mike Stump1eb44332009-09-09 15:08:12 +00001325
John McCalld88687f2011-01-07 01:49:06 +00001326 // Check whether the mutations value has changed from where it was
1327 // at start. StateMutationsPtr should actually be invariant between
1328 // refreshes.
Anders Carlsson2abd89c2008-08-31 04:05:03 +00001329 StateMutationsPtr = Builder.CreateLoad(StateMutationsPtrPtr, "mutationsptr");
John McCalld88687f2011-01-07 01:49:06 +00001330 llvm::Value *currentMutations
1331 = Builder.CreateLoad(StateMutationsPtr, "statemutations");
Anders Carlsson2abd89c2008-08-31 04:05:03 +00001332
John McCalld88687f2011-01-07 01:49:06 +00001333 llvm::BasicBlock *WasMutatedBB = createBasicBlock("forcoll.mutated");
Dan Gohman361cf982011-03-02 22:39:34 +00001334 llvm::BasicBlock *WasNotMutatedBB = createBasicBlock("forcoll.notmutated");
Mike Stump1eb44332009-09-09 15:08:12 +00001335
John McCalld88687f2011-01-07 01:49:06 +00001336 Builder.CreateCondBr(Builder.CreateICmpEQ(currentMutations, initialMutations),
1337 WasNotMutatedBB, WasMutatedBB);
Mike Stump1eb44332009-09-09 15:08:12 +00001338
John McCalld88687f2011-01-07 01:49:06 +00001339 // If so, call the enumeration-mutation function.
1340 EmitBlock(WasMutatedBB);
Anders Carlsson2abd89c2008-08-31 04:05:03 +00001341 llvm::Value *V =
Mike Stump1eb44332009-09-09 15:08:12 +00001342 Builder.CreateBitCast(Collection,
Benjamin Kramer578faa82011-09-27 21:06:10 +00001343 ConvertType(getContext().getObjCIdType()));
Daniel Dunbar2b2105e2009-02-03 23:55:40 +00001344 CallArgList Args2;
Eli Friedman04c9a492011-05-02 17:57:46 +00001345 Args2.add(RValue::get(V), getContext().getObjCIdType());
Mike Stumpf5408fe2009-05-16 07:57:57 +00001346 // FIXME: We shouldn't need to get the function info here, the runtime already
1347 // should have computed it to build the function.
John McCall04a67a62010-02-05 21:31:56 +00001348 EmitCall(CGM.getTypes().getFunctionInfo(getContext().VoidTy, Args2,
Rafael Espindola264ba482010-03-30 20:24:48 +00001349 FunctionType::ExtInfo()),
Anders Carlssonf3c47c92009-12-24 19:25:24 +00001350 EnumerationMutationFn, ReturnValueSlot(), Args2);
Mike Stump1eb44332009-09-09 15:08:12 +00001351
John McCalld88687f2011-01-07 01:49:06 +00001352 // Otherwise, or if the mutation function returns, just continue.
1353 EmitBlock(WasNotMutatedBB);
Mike Stump1eb44332009-09-09 15:08:12 +00001354
John McCalld88687f2011-01-07 01:49:06 +00001355 // Initialize the element variable.
1356 RunCleanupsScope elementVariableScope(*this);
John McCall57b3b6a2011-02-22 07:16:58 +00001357 bool elementIsVariable;
John McCalld88687f2011-01-07 01:49:06 +00001358 LValue elementLValue;
1359 QualType elementType;
1360 if (const DeclStmt *SD = dyn_cast<DeclStmt>(S.getElement())) {
John McCall57b3b6a2011-02-22 07:16:58 +00001361 // Initialize the variable, in case it's a __block variable or something.
1362 EmitAutoVarInit(variable);
John McCalld88687f2011-01-07 01:49:06 +00001363
John McCall57b3b6a2011-02-22 07:16:58 +00001364 const VarDecl* D = cast<VarDecl>(SD->getSingleDecl());
John McCalld88687f2011-01-07 01:49:06 +00001365 DeclRefExpr tempDRE(const_cast<VarDecl*>(D), D->getType(),
1366 VK_LValue, SourceLocation());
1367 elementLValue = EmitLValue(&tempDRE);
1368 elementType = D->getType();
John McCall57b3b6a2011-02-22 07:16:58 +00001369 elementIsVariable = true;
John McCall7acddac2011-06-17 06:42:21 +00001370
1371 if (D->isARCPseudoStrong())
1372 elementLValue.getQuals().setObjCLifetime(Qualifiers::OCL_ExplicitNone);
John McCalld88687f2011-01-07 01:49:06 +00001373 } else {
1374 elementLValue = LValue(); // suppress warning
1375 elementType = cast<Expr>(S.getElement())->getType();
John McCall57b3b6a2011-02-22 07:16:58 +00001376 elementIsVariable = false;
John McCalld88687f2011-01-07 01:49:06 +00001377 }
Chris Lattner2acc6e32011-07-18 04:24:23 +00001378 llvm::Type *convertedElementType = ConvertType(elementType);
John McCalld88687f2011-01-07 01:49:06 +00001379
1380 // Fetch the buffer out of the enumeration state.
1381 // TODO: this pointer should actually be invariant between
1382 // refreshes, which would help us do certain loop optimizations.
Mike Stump1eb44332009-09-09 15:08:12 +00001383 llvm::Value *StateItemsPtr =
Anders Carlssonf484c312008-08-31 02:33:12 +00001384 Builder.CreateStructGEP(StatePtr, 1, "stateitems.ptr");
John McCalld88687f2011-01-07 01:49:06 +00001385 llvm::Value *EnumStateItems =
1386 Builder.CreateLoad(StateItemsPtr, "stateitems");
Anders Carlssonf484c312008-08-31 02:33:12 +00001387
John McCalld88687f2011-01-07 01:49:06 +00001388 // Fetch the value at the current index from the buffer.
Mike Stump1eb44332009-09-09 15:08:12 +00001389 llvm::Value *CurrentItemPtr =
John McCalld88687f2011-01-07 01:49:06 +00001390 Builder.CreateGEP(EnumStateItems, index, "currentitem.ptr");
1391 llvm::Value *CurrentItem = Builder.CreateLoad(CurrentItemPtr);
Mike Stump1eb44332009-09-09 15:08:12 +00001392
John McCalld88687f2011-01-07 01:49:06 +00001393 // Cast that value to the right type.
1394 CurrentItem = Builder.CreateBitCast(CurrentItem, convertedElementType,
1395 "currentitem");
Mike Stump1eb44332009-09-09 15:08:12 +00001396
John McCalld88687f2011-01-07 01:49:06 +00001397 // Make sure we have an l-value. Yes, this gets evaluated every
1398 // time through the loop.
John McCall7acddac2011-06-17 06:42:21 +00001399 if (!elementIsVariable) {
John McCalld88687f2011-01-07 01:49:06 +00001400 elementLValue = EmitLValue(cast<Expr>(S.getElement()));
John McCall545d9962011-06-25 02:11:03 +00001401 EmitStoreThroughLValue(RValue::get(CurrentItem), elementLValue);
John McCall7acddac2011-06-17 06:42:21 +00001402 } else {
1403 EmitScalarInit(CurrentItem, elementLValue);
1404 }
Mike Stump1eb44332009-09-09 15:08:12 +00001405
John McCall57b3b6a2011-02-22 07:16:58 +00001406 // If we do have an element variable, this assignment is the end of
1407 // its initialization.
1408 if (elementIsVariable)
1409 EmitAutoVarCleanups(variable);
1410
John McCalld88687f2011-01-07 01:49:06 +00001411 // Perform the loop body, setting up break and continue labels.
Anders Carlssone4b6d342009-02-10 05:52:02 +00001412 BreakContinueStack.push_back(BreakContinue(LoopEnd, AfterBody));
John McCalld88687f2011-01-07 01:49:06 +00001413 {
1414 RunCleanupsScope Scope(*this);
1415 EmitStmt(S.getBody());
1416 }
Anders Carlssonf484c312008-08-31 02:33:12 +00001417 BreakContinueStack.pop_back();
Mike Stump1eb44332009-09-09 15:08:12 +00001418
John McCalld88687f2011-01-07 01:49:06 +00001419 // Destroy the element variable now.
1420 elementVariableScope.ForceCleanup();
1421
1422 // Check whether there are more elements.
John McCallff8e1152010-07-23 21:56:41 +00001423 EmitBlock(AfterBody.getBlock());
Mike Stump1eb44332009-09-09 15:08:12 +00001424
John McCalld88687f2011-01-07 01:49:06 +00001425 llvm::BasicBlock *FetchMoreBB = createBasicBlock("forcoll.refetch");
Fariborz Jahanianf0906c42009-01-06 18:56:31 +00001426
John McCalld88687f2011-01-07 01:49:06 +00001427 // First we check in the local buffer.
1428 llvm::Value *indexPlusOne
1429 = Builder.CreateAdd(index, llvm::ConstantInt::get(UnsignedLongLTy, 1));
Anders Carlssonf484c312008-08-31 02:33:12 +00001430
John McCalld88687f2011-01-07 01:49:06 +00001431 // If we haven't overrun the buffer yet, we can continue.
1432 Builder.CreateCondBr(Builder.CreateICmpULT(indexPlusOne, count),
1433 LoopBodyBB, FetchMoreBB);
1434
1435 index->addIncoming(indexPlusOne, AfterBody.getBlock());
1436 count->addIncoming(count, AfterBody.getBlock());
1437
1438 // Otherwise, we have to fetch more elements.
1439 EmitBlock(FetchMoreBB);
Mike Stump1eb44332009-09-09 15:08:12 +00001440
1441 CountRV =
John McCallef072fd2010-05-22 01:48:05 +00001442 CGM.getObjCRuntime().GenerateMessageSend(*this, ReturnValueSlot(),
Anders Carlssonf484c312008-08-31 02:33:12 +00001443 getContext().UnsignedLongTy,
Mike Stump1eb44332009-09-09 15:08:12 +00001444 FastEnumSel,
David Chisnallc6cd5fd2010-04-28 19:33:36 +00001445 Collection, Args);
Mike Stump1eb44332009-09-09 15:08:12 +00001446
John McCalld88687f2011-01-07 01:49:06 +00001447 // If we got a zero count, we're done.
1448 llvm::Value *refetchCount = CountRV.getScalarVal();
1449
1450 // (note that the message send might split FetchMoreBB)
1451 index->addIncoming(zero, Builder.GetInsertBlock());
1452 count->addIncoming(refetchCount, Builder.GetInsertBlock());
1453
1454 Builder.CreateCondBr(Builder.CreateICmpEQ(refetchCount, zero),
1455 EmptyBB, LoopBodyBB);
Mike Stump1eb44332009-09-09 15:08:12 +00001456
Anders Carlssonf484c312008-08-31 02:33:12 +00001457 // No more elements.
John McCalld88687f2011-01-07 01:49:06 +00001458 EmitBlock(EmptyBB);
Anders Carlssonf484c312008-08-31 02:33:12 +00001459
John McCall57b3b6a2011-02-22 07:16:58 +00001460 if (!elementIsVariable) {
Anders Carlssonf484c312008-08-31 02:33:12 +00001461 // If the element was not a declaration, set it to be null.
1462
John McCalld88687f2011-01-07 01:49:06 +00001463 llvm::Value *null = llvm::Constant::getNullValue(convertedElementType);
1464 elementLValue = EmitLValue(cast<Expr>(S.getElement()));
John McCall545d9962011-06-25 02:11:03 +00001465 EmitStoreThroughLValue(RValue::get(null), elementLValue);
Anders Carlssonf484c312008-08-31 02:33:12 +00001466 }
1467
Devang Patelbcbd03a2011-01-19 01:36:36 +00001468 if (DI) {
1469 DI->setLocation(S.getSourceRange().getEnd());
Eric Christopheraa2164c2011-09-29 00:00:45 +00001470 DI->EmitLexicalBlockEnd(Builder);
Devang Patelbcbd03a2011-01-19 01:36:36 +00001471 }
1472
John McCall990567c2011-07-27 01:07:15 +00001473 // Leave the cleanup we entered in ARC.
1474 if (getLangOptions().ObjCAutoRefCount)
1475 PopCleanupBlock();
1476
John McCallff8e1152010-07-23 21:56:41 +00001477 EmitBlock(LoopEnd.getBlock());
Anders Carlsson3d8400d2008-08-30 19:51:14 +00001478}
1479
Mike Stump1eb44332009-09-09 15:08:12 +00001480void CodeGenFunction::EmitObjCAtTryStmt(const ObjCAtTryStmt &S) {
John McCallf1549f62010-07-06 01:34:17 +00001481 CGM.getObjCRuntime().EmitTryStmt(*this, S);
Anders Carlsson64d5d6c2008-09-09 10:04:29 +00001482}
1483
Mike Stump1eb44332009-09-09 15:08:12 +00001484void CodeGenFunction::EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S) {
Anders Carlsson64d5d6c2008-09-09 10:04:29 +00001485 CGM.getObjCRuntime().EmitThrowStmt(*this, S);
1486}
1487
Chris Lattner10cac6f2008-11-15 21:26:17 +00001488void CodeGenFunction::EmitObjCAtSynchronizedStmt(
Mike Stump1eb44332009-09-09 15:08:12 +00001489 const ObjCAtSynchronizedStmt &S) {
John McCallf1549f62010-07-06 01:34:17 +00001490 CGM.getObjCRuntime().EmitSynchronizedStmt(*this, S);
Chris Lattner10cac6f2008-11-15 21:26:17 +00001491}
1492
John McCall33e56f32011-09-10 06:18:15 +00001493/// Produce the code for a CK_ARCProduceObject. Just does a
John McCallf85e1932011-06-15 23:02:42 +00001494/// primitive retain.
1495llvm::Value *CodeGenFunction::EmitObjCProduceObject(QualType type,
1496 llvm::Value *value) {
1497 return EmitARCRetain(type, value);
1498}
1499
1500namespace {
1501 struct CallObjCRelease : EHScopeStack::Cleanup {
John McCallbddfd872011-08-03 22:24:24 +00001502 CallObjCRelease(llvm::Value *object) : object(object) {}
1503 llvm::Value *object;
John McCallf85e1932011-06-15 23:02:42 +00001504
John McCallad346f42011-07-12 20:27:29 +00001505 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCallf85e1932011-06-15 23:02:42 +00001506 CGF.EmitARCRelease(object, /*precise*/ true);
John McCallf85e1932011-06-15 23:02:42 +00001507 }
1508 };
1509}
1510
John McCall33e56f32011-09-10 06:18:15 +00001511/// Produce the code for a CK_ARCConsumeObject. Does a primitive
John McCallf85e1932011-06-15 23:02:42 +00001512/// release at the end of the full-expression.
1513llvm::Value *CodeGenFunction::EmitObjCConsumeObject(QualType type,
1514 llvm::Value *object) {
1515 // If we're in a conditional branch, we need to make the cleanup
John McCallbddfd872011-08-03 22:24:24 +00001516 // conditional.
1517 pushFullExprCleanup<CallObjCRelease>(getARCCleanupKind(), object);
John McCallf85e1932011-06-15 23:02:42 +00001518 return object;
1519}
1520
1521llvm::Value *CodeGenFunction::EmitObjCExtendObjectLifetime(QualType type,
1522 llvm::Value *value) {
1523 return EmitARCRetainAutorelease(type, value);
1524}
1525
1526
1527static llvm::Constant *createARCRuntimeFunction(CodeGenModule &CGM,
Chris Lattner2acc6e32011-07-18 04:24:23 +00001528 llvm::FunctionType *type,
Chris Lattner5f9e2722011-07-23 10:55:15 +00001529 StringRef fnName) {
John McCallf85e1932011-06-15 23:02:42 +00001530 llvm::Constant *fn = CGM.CreateRuntimeFunction(type, fnName);
1531
1532 // In -fobjc-no-arc-runtime, emit weak references to the runtime
1533 // support library.
John McCall9f084a32011-07-06 00:26:06 +00001534 if (!CGM.getCodeGenOpts().ObjCRuntimeHasARC)
John McCallf85e1932011-06-15 23:02:42 +00001535 if (llvm::Function *f = dyn_cast<llvm::Function>(fn))
1536 f->setLinkage(llvm::Function::ExternalWeakLinkage);
1537
1538 return fn;
1539}
1540
1541/// Perform an operation having the signature
1542/// i8* (i8*)
1543/// where a null input causes a no-op and returns null.
1544static llvm::Value *emitARCValueOperation(CodeGenFunction &CGF,
1545 llvm::Value *value,
1546 llvm::Constant *&fn,
Chris Lattner5f9e2722011-07-23 10:55:15 +00001547 StringRef fnName) {
John McCallf85e1932011-06-15 23:02:42 +00001548 if (isa<llvm::ConstantPointerNull>(value)) return value;
1549
1550 if (!fn) {
Chris Lattner9cbe4f02011-07-09 17:41:47 +00001551 std::vector<llvm::Type*> args(1, CGF.Int8PtrTy);
Chris Lattner2acc6e32011-07-18 04:24:23 +00001552 llvm::FunctionType *fnType =
John McCallf85e1932011-06-15 23:02:42 +00001553 llvm::FunctionType::get(CGF.Int8PtrTy, args, false);
1554 fn = createARCRuntimeFunction(CGF.CGM, fnType, fnName);
1555 }
1556
1557 // Cast the argument to 'id'.
Chris Lattner2acc6e32011-07-18 04:24:23 +00001558 llvm::Type *origType = value->getType();
John McCallf85e1932011-06-15 23:02:42 +00001559 value = CGF.Builder.CreateBitCast(value, CGF.Int8PtrTy);
1560
1561 // Call the function.
1562 llvm::CallInst *call = CGF.Builder.CreateCall(fn, value);
1563 call->setDoesNotThrow();
1564
1565 // Cast the result back to the original type.
1566 return CGF.Builder.CreateBitCast(call, origType);
1567}
1568
1569/// Perform an operation having the following signature:
1570/// i8* (i8**)
1571static llvm::Value *emitARCLoadOperation(CodeGenFunction &CGF,
1572 llvm::Value *addr,
1573 llvm::Constant *&fn,
Chris Lattner5f9e2722011-07-23 10:55:15 +00001574 StringRef fnName) {
John McCallf85e1932011-06-15 23:02:42 +00001575 if (!fn) {
Chris Lattner9cbe4f02011-07-09 17:41:47 +00001576 std::vector<llvm::Type*> args(1, CGF.Int8PtrPtrTy);
Chris Lattner2acc6e32011-07-18 04:24:23 +00001577 llvm::FunctionType *fnType =
John McCallf85e1932011-06-15 23:02:42 +00001578 llvm::FunctionType::get(CGF.Int8PtrTy, args, false);
1579 fn = createARCRuntimeFunction(CGF.CGM, fnType, fnName);
1580 }
1581
1582 // Cast the argument to 'id*'.
Chris Lattner2acc6e32011-07-18 04:24:23 +00001583 llvm::Type *origType = addr->getType();
John McCallf85e1932011-06-15 23:02:42 +00001584 addr = CGF.Builder.CreateBitCast(addr, CGF.Int8PtrPtrTy);
1585
1586 // Call the function.
1587 llvm::CallInst *call = CGF.Builder.CreateCall(fn, addr);
1588 call->setDoesNotThrow();
1589
1590 // Cast the result back to a dereference of the original type.
1591 llvm::Value *result = call;
1592 if (origType != CGF.Int8PtrPtrTy)
1593 result = CGF.Builder.CreateBitCast(result,
1594 cast<llvm::PointerType>(origType)->getElementType());
1595
1596 return result;
1597}
1598
1599/// Perform an operation having the following signature:
1600/// i8* (i8**, i8*)
1601static llvm::Value *emitARCStoreOperation(CodeGenFunction &CGF,
1602 llvm::Value *addr,
1603 llvm::Value *value,
1604 llvm::Constant *&fn,
Chris Lattner5f9e2722011-07-23 10:55:15 +00001605 StringRef fnName,
John McCallf85e1932011-06-15 23:02:42 +00001606 bool ignored) {
1607 assert(cast<llvm::PointerType>(addr->getType())->getElementType()
1608 == value->getType());
1609
1610 if (!fn) {
Chris Lattner9cbe4f02011-07-09 17:41:47 +00001611 std::vector<llvm::Type*> argTypes(2);
John McCallf85e1932011-06-15 23:02:42 +00001612 argTypes[0] = CGF.Int8PtrPtrTy;
1613 argTypes[1] = CGF.Int8PtrTy;
1614
Chris Lattner2acc6e32011-07-18 04:24:23 +00001615 llvm::FunctionType *fnType
John McCallf85e1932011-06-15 23:02:42 +00001616 = llvm::FunctionType::get(CGF.Int8PtrTy, argTypes, false);
1617 fn = createARCRuntimeFunction(CGF.CGM, fnType, fnName);
1618 }
1619
Chris Lattner2acc6e32011-07-18 04:24:23 +00001620 llvm::Type *origType = value->getType();
John McCallf85e1932011-06-15 23:02:42 +00001621
1622 addr = CGF.Builder.CreateBitCast(addr, CGF.Int8PtrPtrTy);
1623 value = CGF.Builder.CreateBitCast(value, CGF.Int8PtrTy);
1624
1625 llvm::CallInst *result = CGF.Builder.CreateCall2(fn, addr, value);
1626 result->setDoesNotThrow();
1627
1628 if (ignored) return 0;
1629
1630 return CGF.Builder.CreateBitCast(result, origType);
1631}
1632
1633/// Perform an operation having the following signature:
1634/// void (i8**, i8**)
1635static void emitARCCopyOperation(CodeGenFunction &CGF,
1636 llvm::Value *dst,
1637 llvm::Value *src,
1638 llvm::Constant *&fn,
Chris Lattner5f9e2722011-07-23 10:55:15 +00001639 StringRef fnName) {
John McCallf85e1932011-06-15 23:02:42 +00001640 assert(dst->getType() == src->getType());
1641
1642 if (!fn) {
Chris Lattner9cbe4f02011-07-09 17:41:47 +00001643 std::vector<llvm::Type*> argTypes(2, CGF.Int8PtrPtrTy);
Chris Lattner2acc6e32011-07-18 04:24:23 +00001644 llvm::FunctionType *fnType
John McCallf85e1932011-06-15 23:02:42 +00001645 = llvm::FunctionType::get(CGF.Builder.getVoidTy(), argTypes, false);
1646 fn = createARCRuntimeFunction(CGF.CGM, fnType, fnName);
1647 }
1648
1649 dst = CGF.Builder.CreateBitCast(dst, CGF.Int8PtrPtrTy);
1650 src = CGF.Builder.CreateBitCast(src, CGF.Int8PtrPtrTy);
1651
1652 llvm::CallInst *result = CGF.Builder.CreateCall2(fn, dst, src);
1653 result->setDoesNotThrow();
1654}
1655
1656/// Produce the code to do a retain. Based on the type, calls one of:
1657/// call i8* @objc_retain(i8* %value)
1658/// call i8* @objc_retainBlock(i8* %value)
1659llvm::Value *CodeGenFunction::EmitARCRetain(QualType type, llvm::Value *value) {
1660 if (type->isBlockPointerType())
John McCall348f16f2011-10-04 06:23:45 +00001661 return EmitARCRetainBlock(value, /*mandatory*/ false);
John McCallf85e1932011-06-15 23:02:42 +00001662 else
1663 return EmitARCRetainNonBlock(value);
1664}
1665
1666/// Retain the given object, with normal retain semantics.
1667/// call i8* @objc_retain(i8* %value)
1668llvm::Value *CodeGenFunction::EmitARCRetainNonBlock(llvm::Value *value) {
1669 return emitARCValueOperation(*this, value,
1670 CGM.getARCEntrypoints().objc_retain,
1671 "objc_retain");
1672}
1673
1674/// Retain the given block, with _Block_copy semantics.
1675/// call i8* @objc_retainBlock(i8* %value)
John McCall348f16f2011-10-04 06:23:45 +00001676///
1677/// \param mandatory - If false, emit the call with metadata
1678/// indicating that it's okay for the optimizer to eliminate this call
1679/// if it can prove that the block never escapes except down the stack.
1680llvm::Value *CodeGenFunction::EmitARCRetainBlock(llvm::Value *value,
1681 bool mandatory) {
1682 llvm::Value *result
1683 = emitARCValueOperation(*this, value,
1684 CGM.getARCEntrypoints().objc_retainBlock,
1685 "objc_retainBlock");
1686
1687 // If the copy isn't mandatory, add !clang.arc.copy_on_escape to
1688 // tell the optimizer that it doesn't need to do this copy if the
1689 // block doesn't escape, where being passed as an argument doesn't
1690 // count as escaping.
1691 if (!mandatory && isa<llvm::Instruction>(result)) {
1692 llvm::CallInst *call
1693 = cast<llvm::CallInst>(result->stripPointerCasts());
1694 assert(call->getCalledValue() == CGM.getARCEntrypoints().objc_retainBlock);
1695
1696 SmallVector<llvm::Value*,1> args;
1697 call->setMetadata("clang.arc.copy_on_escape",
1698 llvm::MDNode::get(Builder.getContext(), args));
1699 }
1700
1701 return result;
John McCallf85e1932011-06-15 23:02:42 +00001702}
1703
1704/// Retain the given object which is the result of a function call.
1705/// call i8* @objc_retainAutoreleasedReturnValue(i8* %value)
1706///
1707/// Yes, this function name is one character away from a different
1708/// call with completely different semantics.
1709llvm::Value *
1710CodeGenFunction::EmitARCRetainAutoreleasedReturnValue(llvm::Value *value) {
1711 // Fetch the void(void) inline asm which marks that we're going to
1712 // retain the autoreleased return value.
1713 llvm::InlineAsm *&marker
1714 = CGM.getARCEntrypoints().retainAutoreleasedReturnValueMarker;
1715 if (!marker) {
Chris Lattner5f9e2722011-07-23 10:55:15 +00001716 StringRef assembly
John McCallf85e1932011-06-15 23:02:42 +00001717 = CGM.getTargetCodeGenInfo()
1718 .getARCRetainAutoreleasedReturnValueMarker();
1719
1720 // If we have an empty assembly string, there's nothing to do.
1721 if (assembly.empty()) {
1722
1723 // Otherwise, at -O0, build an inline asm that we're going to call
1724 // in a moment.
1725 } else if (CGM.getCodeGenOpts().OptimizationLevel == 0) {
1726 llvm::FunctionType *type =
1727 llvm::FunctionType::get(llvm::Type::getVoidTy(getLLVMContext()),
1728 /*variadic*/ false);
1729
1730 marker = llvm::InlineAsm::get(type, assembly, "", /*sideeffects*/ true);
1731
1732 // If we're at -O1 and above, we don't want to litter the code
1733 // with this marker yet, so leave a breadcrumb for the ARC
1734 // optimizer to pick up.
1735 } else {
1736 llvm::NamedMDNode *metadata =
1737 CGM.getModule().getOrInsertNamedMetadata(
1738 "clang.arc.retainAutoreleasedReturnValueMarker");
1739 assert(metadata->getNumOperands() <= 1);
1740 if (metadata->getNumOperands() == 0) {
1741 llvm::Value *string = llvm::MDString::get(getLLVMContext(), assembly);
Jay Foadda549e82011-07-29 13:56:53 +00001742 metadata->addOperand(llvm::MDNode::get(getLLVMContext(), string));
John McCallf85e1932011-06-15 23:02:42 +00001743 }
1744 }
1745 }
1746
1747 // Call the marker asm if we made one, which we do only at -O0.
1748 if (marker) Builder.CreateCall(marker);
1749
1750 return emitARCValueOperation(*this, value,
1751 CGM.getARCEntrypoints().objc_retainAutoreleasedReturnValue,
1752 "objc_retainAutoreleasedReturnValue");
1753}
1754
1755/// Release the given object.
1756/// call void @objc_release(i8* %value)
1757void CodeGenFunction::EmitARCRelease(llvm::Value *value, bool precise) {
1758 if (isa<llvm::ConstantPointerNull>(value)) return;
1759
1760 llvm::Constant *&fn = CGM.getARCEntrypoints().objc_release;
1761 if (!fn) {
Chris Lattner9cbe4f02011-07-09 17:41:47 +00001762 std::vector<llvm::Type*> args(1, Int8PtrTy);
Chris Lattner2acc6e32011-07-18 04:24:23 +00001763 llvm::FunctionType *fnType =
John McCallf85e1932011-06-15 23:02:42 +00001764 llvm::FunctionType::get(Builder.getVoidTy(), args, false);
1765 fn = createARCRuntimeFunction(CGM, fnType, "objc_release");
1766 }
1767
1768 // Cast the argument to 'id'.
1769 value = Builder.CreateBitCast(value, Int8PtrTy);
1770
1771 // Call objc_release.
1772 llvm::CallInst *call = Builder.CreateCall(fn, value);
1773 call->setDoesNotThrow();
1774
1775 if (!precise) {
Chris Lattner5f9e2722011-07-23 10:55:15 +00001776 SmallVector<llvm::Value*,1> args;
John McCallf85e1932011-06-15 23:02:42 +00001777 call->setMetadata("clang.imprecise_release",
1778 llvm::MDNode::get(Builder.getContext(), args));
1779 }
1780}
1781
1782/// Store into a strong object. Always calls this:
1783/// call void @objc_storeStrong(i8** %addr, i8* %value)
1784llvm::Value *CodeGenFunction::EmitARCStoreStrongCall(llvm::Value *addr,
1785 llvm::Value *value,
1786 bool ignored) {
1787 assert(cast<llvm::PointerType>(addr->getType())->getElementType()
1788 == value->getType());
1789
1790 llvm::Constant *&fn = CGM.getARCEntrypoints().objc_storeStrong;
1791 if (!fn) {
Chris Lattner9cbe4f02011-07-09 17:41:47 +00001792 llvm::Type *argTypes[] = { Int8PtrPtrTy, Int8PtrTy };
Chris Lattner2acc6e32011-07-18 04:24:23 +00001793 llvm::FunctionType *fnType
John McCallf85e1932011-06-15 23:02:42 +00001794 = llvm::FunctionType::get(Builder.getVoidTy(), argTypes, false);
1795 fn = createARCRuntimeFunction(CGM, fnType, "objc_storeStrong");
1796 }
1797
1798 addr = Builder.CreateBitCast(addr, Int8PtrPtrTy);
1799 llvm::Value *castValue = Builder.CreateBitCast(value, Int8PtrTy);
1800
1801 Builder.CreateCall2(fn, addr, castValue)->setDoesNotThrow();
1802
1803 if (ignored) return 0;
1804 return value;
1805}
1806
1807/// Store into a strong object. Sometimes calls this:
1808/// call void @objc_storeStrong(i8** %addr, i8* %value)
1809/// Other times, breaks it down into components.
John McCall545d9962011-06-25 02:11:03 +00001810llvm::Value *CodeGenFunction::EmitARCStoreStrong(LValue dst,
John McCallf85e1932011-06-15 23:02:42 +00001811 llvm::Value *newValue,
1812 bool ignored) {
John McCall545d9962011-06-25 02:11:03 +00001813 QualType type = dst.getType();
John McCallf85e1932011-06-15 23:02:42 +00001814 bool isBlock = type->isBlockPointerType();
1815
1816 // Use a store barrier at -O0 unless this is a block type or the
1817 // lvalue is inadequately aligned.
1818 if (shouldUseFusedARCCalls() &&
1819 !isBlock &&
1820 !(dst.getAlignment() && dst.getAlignment() < PointerAlignInBytes)) {
1821 return EmitARCStoreStrongCall(dst.getAddress(), newValue, ignored);
1822 }
1823
1824 // Otherwise, split it out.
1825
1826 // Retain the new value.
1827 newValue = EmitARCRetain(type, newValue);
1828
1829 // Read the old value.
John McCall545d9962011-06-25 02:11:03 +00001830 llvm::Value *oldValue = EmitLoadOfScalar(dst);
John McCallf85e1932011-06-15 23:02:42 +00001831
1832 // Store. We do this before the release so that any deallocs won't
1833 // see the old value.
John McCall545d9962011-06-25 02:11:03 +00001834 EmitStoreOfScalar(newValue, dst);
John McCallf85e1932011-06-15 23:02:42 +00001835
1836 // Finally, release the old value.
1837 EmitARCRelease(oldValue, /*precise*/ false);
1838
1839 return newValue;
1840}
1841
1842/// Autorelease the given object.
1843/// call i8* @objc_autorelease(i8* %value)
1844llvm::Value *CodeGenFunction::EmitARCAutorelease(llvm::Value *value) {
1845 return emitARCValueOperation(*this, value,
1846 CGM.getARCEntrypoints().objc_autorelease,
1847 "objc_autorelease");
1848}
1849
1850/// Autorelease the given object.
1851/// call i8* @objc_autoreleaseReturnValue(i8* %value)
1852llvm::Value *
1853CodeGenFunction::EmitARCAutoreleaseReturnValue(llvm::Value *value) {
1854 return emitARCValueOperation(*this, value,
1855 CGM.getARCEntrypoints().objc_autoreleaseReturnValue,
1856 "objc_autoreleaseReturnValue");
1857}
1858
1859/// Do a fused retain/autorelease of the given object.
1860/// call i8* @objc_retainAutoreleaseReturnValue(i8* %value)
1861llvm::Value *
1862CodeGenFunction::EmitARCRetainAutoreleaseReturnValue(llvm::Value *value) {
1863 return emitARCValueOperation(*this, value,
1864 CGM.getARCEntrypoints().objc_retainAutoreleaseReturnValue,
1865 "objc_retainAutoreleaseReturnValue");
1866}
1867
1868/// Do a fused retain/autorelease of the given object.
1869/// call i8* @objc_retainAutorelease(i8* %value)
1870/// or
1871/// %retain = call i8* @objc_retainBlock(i8* %value)
1872/// call i8* @objc_autorelease(i8* %retain)
1873llvm::Value *CodeGenFunction::EmitARCRetainAutorelease(QualType type,
1874 llvm::Value *value) {
1875 if (!type->isBlockPointerType())
1876 return EmitARCRetainAutoreleaseNonBlock(value);
1877
1878 if (isa<llvm::ConstantPointerNull>(value)) return value;
1879
Chris Lattner2acc6e32011-07-18 04:24:23 +00001880 llvm::Type *origType = value->getType();
John McCallf85e1932011-06-15 23:02:42 +00001881 value = Builder.CreateBitCast(value, Int8PtrTy);
John McCall348f16f2011-10-04 06:23:45 +00001882 value = EmitARCRetainBlock(value, /*mandatory*/ true);
John McCallf85e1932011-06-15 23:02:42 +00001883 value = EmitARCAutorelease(value);
1884 return Builder.CreateBitCast(value, origType);
1885}
1886
1887/// Do a fused retain/autorelease of the given object.
1888/// call i8* @objc_retainAutorelease(i8* %value)
1889llvm::Value *
1890CodeGenFunction::EmitARCRetainAutoreleaseNonBlock(llvm::Value *value) {
1891 return emitARCValueOperation(*this, value,
1892 CGM.getARCEntrypoints().objc_retainAutorelease,
1893 "objc_retainAutorelease");
1894}
1895
1896/// i8* @objc_loadWeak(i8** %addr)
1897/// Essentially objc_autorelease(objc_loadWeakRetained(addr)).
1898llvm::Value *CodeGenFunction::EmitARCLoadWeak(llvm::Value *addr) {
1899 return emitARCLoadOperation(*this, addr,
1900 CGM.getARCEntrypoints().objc_loadWeak,
1901 "objc_loadWeak");
1902}
1903
1904/// i8* @objc_loadWeakRetained(i8** %addr)
1905llvm::Value *CodeGenFunction::EmitARCLoadWeakRetained(llvm::Value *addr) {
1906 return emitARCLoadOperation(*this, addr,
1907 CGM.getARCEntrypoints().objc_loadWeakRetained,
1908 "objc_loadWeakRetained");
1909}
1910
1911/// i8* @objc_storeWeak(i8** %addr, i8* %value)
1912/// Returns %value.
1913llvm::Value *CodeGenFunction::EmitARCStoreWeak(llvm::Value *addr,
1914 llvm::Value *value,
1915 bool ignored) {
1916 return emitARCStoreOperation(*this, addr, value,
1917 CGM.getARCEntrypoints().objc_storeWeak,
1918 "objc_storeWeak", ignored);
1919}
1920
1921/// i8* @objc_initWeak(i8** %addr, i8* %value)
1922/// Returns %value. %addr is known to not have a current weak entry.
1923/// Essentially equivalent to:
1924/// *addr = nil; objc_storeWeak(addr, value);
1925void CodeGenFunction::EmitARCInitWeak(llvm::Value *addr, llvm::Value *value) {
1926 // If we're initializing to null, just write null to memory; no need
1927 // to get the runtime involved. But don't do this if optimization
1928 // is enabled, because accounting for this would make the optimizer
1929 // much more complicated.
1930 if (isa<llvm::ConstantPointerNull>(value) &&
1931 CGM.getCodeGenOpts().OptimizationLevel == 0) {
1932 Builder.CreateStore(value, addr);
1933 return;
1934 }
1935
1936 emitARCStoreOperation(*this, addr, value,
1937 CGM.getARCEntrypoints().objc_initWeak,
1938 "objc_initWeak", /*ignored*/ true);
1939}
1940
1941/// void @objc_destroyWeak(i8** %addr)
1942/// Essentially objc_storeWeak(addr, nil).
1943void CodeGenFunction::EmitARCDestroyWeak(llvm::Value *addr) {
1944 llvm::Constant *&fn = CGM.getARCEntrypoints().objc_destroyWeak;
1945 if (!fn) {
Chris Lattner9cbe4f02011-07-09 17:41:47 +00001946 std::vector<llvm::Type*> args(1, Int8PtrPtrTy);
Chris Lattner2acc6e32011-07-18 04:24:23 +00001947 llvm::FunctionType *fnType =
John McCallf85e1932011-06-15 23:02:42 +00001948 llvm::FunctionType::get(Builder.getVoidTy(), args, false);
1949 fn = createARCRuntimeFunction(CGM, fnType, "objc_destroyWeak");
1950 }
1951
1952 // Cast the argument to 'id*'.
1953 addr = Builder.CreateBitCast(addr, Int8PtrPtrTy);
1954
1955 llvm::CallInst *call = Builder.CreateCall(fn, addr);
1956 call->setDoesNotThrow();
1957}
1958
1959/// void @objc_moveWeak(i8** %dest, i8** %src)
1960/// Disregards the current value in %dest. Leaves %src pointing to nothing.
1961/// Essentially (objc_copyWeak(dest, src), objc_destroyWeak(src)).
1962void CodeGenFunction::EmitARCMoveWeak(llvm::Value *dst, llvm::Value *src) {
1963 emitARCCopyOperation(*this, dst, src,
1964 CGM.getARCEntrypoints().objc_moveWeak,
1965 "objc_moveWeak");
1966}
1967
1968/// void @objc_copyWeak(i8** %dest, i8** %src)
1969/// Disregards the current value in %dest. Essentially
1970/// objc_release(objc_initWeak(dest, objc_readWeakRetained(src)))
1971void CodeGenFunction::EmitARCCopyWeak(llvm::Value *dst, llvm::Value *src) {
1972 emitARCCopyOperation(*this, dst, src,
1973 CGM.getARCEntrypoints().objc_copyWeak,
1974 "objc_copyWeak");
1975}
1976
1977/// Produce the code to do a objc_autoreleasepool_push.
1978/// call i8* @objc_autoreleasePoolPush(void)
1979llvm::Value *CodeGenFunction::EmitObjCAutoreleasePoolPush() {
1980 llvm::Constant *&fn = CGM.getRREntrypoints().objc_autoreleasePoolPush;
1981 if (!fn) {
Chris Lattner2acc6e32011-07-18 04:24:23 +00001982 llvm::FunctionType *fnType =
John McCallf85e1932011-06-15 23:02:42 +00001983 llvm::FunctionType::get(Int8PtrTy, false);
1984 fn = createARCRuntimeFunction(CGM, fnType, "objc_autoreleasePoolPush");
1985 }
1986
1987 llvm::CallInst *call = Builder.CreateCall(fn);
1988 call->setDoesNotThrow();
1989
1990 return call;
1991}
1992
1993/// Produce the code to do a primitive release.
1994/// call void @objc_autoreleasePoolPop(i8* %ptr)
1995void CodeGenFunction::EmitObjCAutoreleasePoolPop(llvm::Value *value) {
1996 assert(value->getType() == Int8PtrTy);
1997
1998 llvm::Constant *&fn = CGM.getRREntrypoints().objc_autoreleasePoolPop;
1999 if (!fn) {
Chris Lattner9cbe4f02011-07-09 17:41:47 +00002000 std::vector<llvm::Type*> args(1, Int8PtrTy);
Chris Lattner2acc6e32011-07-18 04:24:23 +00002001 llvm::FunctionType *fnType =
John McCallf85e1932011-06-15 23:02:42 +00002002 llvm::FunctionType::get(Builder.getVoidTy(), args, false);
2003
2004 // We don't want to use a weak import here; instead we should not
2005 // fall into this path.
2006 fn = createARCRuntimeFunction(CGM, fnType, "objc_autoreleasePoolPop");
2007 }
2008
2009 llvm::CallInst *call = Builder.CreateCall(fn, value);
2010 call->setDoesNotThrow();
2011}
2012
2013/// Produce the code to do an MRR version objc_autoreleasepool_push.
2014/// Which is: [[NSAutoreleasePool alloc] init];
2015/// Where alloc is declared as: + (id) alloc; in NSAutoreleasePool class.
2016/// init is declared as: - (id) init; in its NSObject super class.
2017///
2018llvm::Value *CodeGenFunction::EmitObjCMRRAutoreleasePoolPush() {
2019 CGObjCRuntime &Runtime = CGM.getObjCRuntime();
2020 llvm::Value *Receiver = Runtime.EmitNSAutoreleasePoolClassRef(Builder);
2021 // [NSAutoreleasePool alloc]
2022 IdentifierInfo *II = &CGM.getContext().Idents.get("alloc");
2023 Selector AllocSel = getContext().Selectors.getSelector(0, &II);
2024 CallArgList Args;
2025 RValue AllocRV =
2026 Runtime.GenerateMessageSend(*this, ReturnValueSlot(),
2027 getContext().getObjCIdType(),
2028 AllocSel, Receiver, Args);
2029
2030 // [Receiver init]
2031 Receiver = AllocRV.getScalarVal();
2032 II = &CGM.getContext().Idents.get("init");
2033 Selector InitSel = getContext().Selectors.getSelector(0, &II);
2034 RValue InitRV =
2035 Runtime.GenerateMessageSend(*this, ReturnValueSlot(),
2036 getContext().getObjCIdType(),
2037 InitSel, Receiver, Args);
2038 return InitRV.getScalarVal();
2039}
2040
2041/// Produce the code to do a primitive release.
2042/// [tmp drain];
2043void CodeGenFunction::EmitObjCMRRAutoreleasePoolPop(llvm::Value *Arg) {
2044 IdentifierInfo *II = &CGM.getContext().Idents.get("drain");
2045 Selector DrainSel = getContext().Selectors.getSelector(0, &II);
2046 CallArgList Args;
2047 CGM.getObjCRuntime().GenerateMessageSend(*this, ReturnValueSlot(),
2048 getContext().VoidTy, DrainSel, Arg, Args);
2049}
2050
John McCallbdc4d802011-07-09 01:37:26 +00002051void CodeGenFunction::destroyARCStrongPrecise(CodeGenFunction &CGF,
2052 llvm::Value *addr,
2053 QualType type) {
2054 llvm::Value *ptr = CGF.Builder.CreateLoad(addr, "strongdestroy");
2055 CGF.EmitARCRelease(ptr, /*precise*/ true);
2056}
2057
2058void CodeGenFunction::destroyARCStrongImprecise(CodeGenFunction &CGF,
2059 llvm::Value *addr,
2060 QualType type) {
2061 llvm::Value *ptr = CGF.Builder.CreateLoad(addr, "strongdestroy");
2062 CGF.EmitARCRelease(ptr, /*precise*/ false);
2063}
2064
2065void CodeGenFunction::destroyARCWeak(CodeGenFunction &CGF,
2066 llvm::Value *addr,
2067 QualType type) {
2068 CGF.EmitARCDestroyWeak(addr);
2069}
2070
John McCallf85e1932011-06-15 23:02:42 +00002071namespace {
John McCallf85e1932011-06-15 23:02:42 +00002072 struct CallObjCAutoreleasePoolObject : EHScopeStack::Cleanup {
2073 llvm::Value *Token;
2074
2075 CallObjCAutoreleasePoolObject(llvm::Value *token) : Token(token) {}
2076
John McCallad346f42011-07-12 20:27:29 +00002077 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCallf85e1932011-06-15 23:02:42 +00002078 CGF.EmitObjCAutoreleasePoolPop(Token);
2079 }
2080 };
2081 struct CallObjCMRRAutoreleasePoolObject : EHScopeStack::Cleanup {
2082 llvm::Value *Token;
2083
2084 CallObjCMRRAutoreleasePoolObject(llvm::Value *token) : Token(token) {}
2085
John McCallad346f42011-07-12 20:27:29 +00002086 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCallf85e1932011-06-15 23:02:42 +00002087 CGF.EmitObjCMRRAutoreleasePoolPop(Token);
2088 }
2089 };
2090}
2091
2092void CodeGenFunction::EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr) {
2093 if (CGM.getLangOptions().ObjCAutoRefCount)
2094 EHStack.pushCleanup<CallObjCAutoreleasePoolObject>(NormalCleanup, Ptr);
2095 else
2096 EHStack.pushCleanup<CallObjCMRRAutoreleasePoolObject>(NormalCleanup, Ptr);
2097}
2098
John McCallf85e1932011-06-15 23:02:42 +00002099static TryEmitResult tryEmitARCRetainLoadOfScalar(CodeGenFunction &CGF,
2100 LValue lvalue,
2101 QualType type) {
2102 switch (type.getObjCLifetime()) {
2103 case Qualifiers::OCL_None:
2104 case Qualifiers::OCL_ExplicitNone:
2105 case Qualifiers::OCL_Strong:
2106 case Qualifiers::OCL_Autoreleasing:
John McCall545d9962011-06-25 02:11:03 +00002107 return TryEmitResult(CGF.EmitLoadOfLValue(lvalue).getScalarVal(),
John McCallf85e1932011-06-15 23:02:42 +00002108 false);
2109
2110 case Qualifiers::OCL_Weak:
2111 return TryEmitResult(CGF.EmitARCLoadWeakRetained(lvalue.getAddress()),
2112 true);
2113 }
2114
2115 llvm_unreachable("impossible lifetime!");
2116 return TryEmitResult();
2117}
2118
2119static TryEmitResult tryEmitARCRetainLoadOfScalar(CodeGenFunction &CGF,
2120 const Expr *e) {
2121 e = e->IgnoreParens();
2122 QualType type = e->getType();
2123
John McCall21480112011-08-30 00:57:29 +00002124 // If we're loading retained from a __strong xvalue, we can avoid
2125 // an extra retain/release pair by zeroing out the source of this
2126 // "move" operation.
2127 if (e->isXValue() &&
2128 !type.isConstQualified() &&
2129 type.getObjCLifetime() == Qualifiers::OCL_Strong) {
2130 // Emit the lvalue.
2131 LValue lv = CGF.EmitLValue(e);
2132
2133 // Load the object pointer.
2134 llvm::Value *result = CGF.EmitLoadOfLValue(lv).getScalarVal();
2135
2136 // Set the source pointer to NULL.
2137 CGF.EmitStoreOfScalar(getNullForVariable(lv.getAddress()), lv);
2138
2139 return TryEmitResult(result, true);
2140 }
2141
John McCallf85e1932011-06-15 23:02:42 +00002142 // As a very special optimization, in ARC++, if the l-value is the
2143 // result of a non-volatile assignment, do a simple retain of the
2144 // result of the call to objc_storeWeak instead of reloading.
2145 if (CGF.getLangOptions().CPlusPlus &&
2146 !type.isVolatileQualified() &&
2147 type.getObjCLifetime() == Qualifiers::OCL_Weak &&
2148 isa<BinaryOperator>(e) &&
2149 cast<BinaryOperator>(e)->getOpcode() == BO_Assign)
2150 return TryEmitResult(CGF.EmitScalarExpr(e), false);
2151
2152 return tryEmitARCRetainLoadOfScalar(CGF, CGF.EmitLValue(e), type);
2153}
2154
2155static llvm::Value *emitARCRetainAfterCall(CodeGenFunction &CGF,
2156 llvm::Value *value);
2157
2158/// Given that the given expression is some sort of call (which does
2159/// not return retained), emit a retain following it.
2160static llvm::Value *emitARCRetainCall(CodeGenFunction &CGF, const Expr *e) {
2161 llvm::Value *value = CGF.EmitScalarExpr(e);
2162 return emitARCRetainAfterCall(CGF, value);
2163}
2164
2165static llvm::Value *emitARCRetainAfterCall(CodeGenFunction &CGF,
2166 llvm::Value *value) {
2167 if (llvm::CallInst *call = dyn_cast<llvm::CallInst>(value)) {
2168 CGBuilderTy::InsertPoint ip = CGF.Builder.saveIP();
2169
2170 // Place the retain immediately following the call.
2171 CGF.Builder.SetInsertPoint(call->getParent(),
2172 ++llvm::BasicBlock::iterator(call));
2173 value = CGF.EmitARCRetainAutoreleasedReturnValue(value);
2174
2175 CGF.Builder.restoreIP(ip);
2176 return value;
2177 } else if (llvm::InvokeInst *invoke = dyn_cast<llvm::InvokeInst>(value)) {
2178 CGBuilderTy::InsertPoint ip = CGF.Builder.saveIP();
2179
2180 // Place the retain at the beginning of the normal destination block.
2181 llvm::BasicBlock *BB = invoke->getNormalDest();
2182 CGF.Builder.SetInsertPoint(BB, BB->begin());
2183 value = CGF.EmitARCRetainAutoreleasedReturnValue(value);
2184
2185 CGF.Builder.restoreIP(ip);
2186 return value;
2187
2188 // Bitcasts can arise because of related-result returns. Rewrite
2189 // the operand.
2190 } else if (llvm::BitCastInst *bitcast = dyn_cast<llvm::BitCastInst>(value)) {
2191 llvm::Value *operand = bitcast->getOperand(0);
2192 operand = emitARCRetainAfterCall(CGF, operand);
2193 bitcast->setOperand(0, operand);
2194 return bitcast;
2195
2196 // Generic fall-back case.
2197 } else {
2198 // Retain using the non-block variant: we never need to do a copy
2199 // of a block that's been returned to us.
2200 return CGF.EmitARCRetainNonBlock(value);
2201 }
2202}
2203
John McCalldc05b112011-09-10 01:16:55 +00002204/// Determine whether it might be important to emit a separate
2205/// objc_retain_block on the result of the given expression, or
2206/// whether it's okay to just emit it in a +1 context.
2207static bool shouldEmitSeparateBlockRetain(const Expr *e) {
2208 assert(e->getType()->isBlockPointerType());
2209 e = e->IgnoreParens();
2210
2211 // For future goodness, emit block expressions directly in +1
2212 // contexts if we can.
2213 if (isa<BlockExpr>(e))
2214 return false;
2215
2216 if (const CastExpr *cast = dyn_cast<CastExpr>(e)) {
2217 switch (cast->getCastKind()) {
2218 // Emitting these operations in +1 contexts is goodness.
2219 case CK_LValueToRValue:
John McCall33e56f32011-09-10 06:18:15 +00002220 case CK_ARCReclaimReturnedObject:
2221 case CK_ARCConsumeObject:
2222 case CK_ARCProduceObject:
John McCalldc05b112011-09-10 01:16:55 +00002223 return false;
2224
2225 // These operations preserve a block type.
2226 case CK_NoOp:
2227 case CK_BitCast:
2228 return shouldEmitSeparateBlockRetain(cast->getSubExpr());
2229
2230 // These operations are known to be bad (or haven't been considered).
2231 case CK_AnyPointerToBlockPointerCast:
2232 default:
2233 return true;
2234 }
2235 }
2236
2237 return true;
2238}
2239
John McCallf85e1932011-06-15 23:02:42 +00002240static TryEmitResult
2241tryEmitARCRetainScalarExpr(CodeGenFunction &CGF, const Expr *e) {
John McCall990567c2011-07-27 01:07:15 +00002242 // Look through cleanups.
2243 if (const ExprWithCleanups *cleanups = dyn_cast<ExprWithCleanups>(e)) {
2244 CodeGenFunction::RunCleanupsScope scope(CGF);
2245 return tryEmitARCRetainScalarExpr(CGF, cleanups->getSubExpr());
2246 }
2247
John McCallf85e1932011-06-15 23:02:42 +00002248 // The desired result type, if it differs from the type of the
2249 // ultimate opaque expression.
Chris Lattner2acc6e32011-07-18 04:24:23 +00002250 llvm::Type *resultType = 0;
John McCallf85e1932011-06-15 23:02:42 +00002251
2252 while (true) {
2253 e = e->IgnoreParens();
2254
2255 // There's a break at the end of this if-chain; anything
2256 // that wants to keep looping has to explicitly continue.
2257 if (const CastExpr *ce = dyn_cast<CastExpr>(e)) {
2258 switch (ce->getCastKind()) {
2259 // No-op casts don't change the type, so we just ignore them.
2260 case CK_NoOp:
2261 e = ce->getSubExpr();
2262 continue;
2263
2264 case CK_LValueToRValue: {
2265 TryEmitResult loadResult
2266 = tryEmitARCRetainLoadOfScalar(CGF, ce->getSubExpr());
2267 if (resultType) {
2268 llvm::Value *value = loadResult.getPointer();
2269 value = CGF.Builder.CreateBitCast(value, resultType);
2270 loadResult.setPointer(value);
2271 }
2272 return loadResult;
2273 }
2274
2275 // These casts can change the type, so remember that and
2276 // soldier on. We only need to remember the outermost such
2277 // cast, though.
John McCall1d9b3b22011-09-09 05:25:32 +00002278 case CK_CPointerToObjCPointerCast:
2279 case CK_BlockPointerToObjCPointerCast:
John McCallf85e1932011-06-15 23:02:42 +00002280 case CK_AnyPointerToBlockPointerCast:
2281 case CK_BitCast:
2282 if (!resultType)
2283 resultType = CGF.ConvertType(ce->getType());
2284 e = ce->getSubExpr();
2285 assert(e->getType()->hasPointerRepresentation());
2286 continue;
2287
2288 // For consumptions, just emit the subexpression and thus elide
2289 // the retain/release pair.
John McCall33e56f32011-09-10 06:18:15 +00002290 case CK_ARCConsumeObject: {
John McCallf85e1932011-06-15 23:02:42 +00002291 llvm::Value *result = CGF.EmitScalarExpr(ce->getSubExpr());
2292 if (resultType) result = CGF.Builder.CreateBitCast(result, resultType);
2293 return TryEmitResult(result, true);
2294 }
2295
John McCalldc05b112011-09-10 01:16:55 +00002296 // Block extends are net +0. Naively, we could just recurse on
2297 // the subexpression, but actually we need to ensure that the
2298 // value is copied as a block, so there's a little filter here.
John McCall33e56f32011-09-10 06:18:15 +00002299 case CK_ARCExtendBlockObject: {
John McCalldc05b112011-09-10 01:16:55 +00002300 llvm::Value *result; // will be a +0 value
2301
2302 // If we can't safely assume the sub-expression will produce a
2303 // block-copied value, emit the sub-expression at +0.
2304 if (shouldEmitSeparateBlockRetain(ce->getSubExpr())) {
2305 result = CGF.EmitScalarExpr(ce->getSubExpr());
2306
2307 // Otherwise, try to emit the sub-expression at +1 recursively.
2308 } else {
2309 TryEmitResult subresult
2310 = tryEmitARCRetainScalarExpr(CGF, ce->getSubExpr());
2311 result = subresult.getPointer();
2312
2313 // If that produced a retained value, just use that,
2314 // possibly casting down.
2315 if (subresult.getInt()) {
2316 if (resultType)
2317 result = CGF.Builder.CreateBitCast(result, resultType);
2318 return TryEmitResult(result, true);
2319 }
2320
2321 // Otherwise it's +0.
2322 }
2323
2324 // Retain the object as a block, then cast down.
John McCall348f16f2011-10-04 06:23:45 +00002325 result = CGF.EmitARCRetainBlock(result, /*mandatory*/ true);
John McCalldc05b112011-09-10 01:16:55 +00002326 if (resultType) result = CGF.Builder.CreateBitCast(result, resultType);
2327 return TryEmitResult(result, true);
2328 }
2329
John McCall7e5e5f42011-07-07 06:58:02 +00002330 // For reclaims, emit the subexpression as a retained call and
2331 // skip the consumption.
John McCall33e56f32011-09-10 06:18:15 +00002332 case CK_ARCReclaimReturnedObject: {
John McCall7e5e5f42011-07-07 06:58:02 +00002333 llvm::Value *result = emitARCRetainCall(CGF, ce->getSubExpr());
2334 if (resultType) result = CGF.Builder.CreateBitCast(result, resultType);
2335 return TryEmitResult(result, true);
2336 }
2337
John McCallf85e1932011-06-15 23:02:42 +00002338 case CK_GetObjCProperty: {
2339 llvm::Value *result = emitARCRetainCall(CGF, ce);
2340 if (resultType) result = CGF.Builder.CreateBitCast(result, resultType);
2341 return TryEmitResult(result, true);
2342 }
2343
2344 default:
2345 break;
2346 }
2347
2348 // Skip __extension__.
2349 } else if (const UnaryOperator *op = dyn_cast<UnaryOperator>(e)) {
2350 if (op->getOpcode() == UO_Extension) {
2351 e = op->getSubExpr();
2352 continue;
2353 }
2354
2355 // For calls and message sends, use the retained-call logic.
2356 // Delegate inits are a special case in that they're the only
2357 // returns-retained expression that *isn't* surrounded by
2358 // a consume.
2359 } else if (isa<CallExpr>(e) ||
2360 (isa<ObjCMessageExpr>(e) &&
2361 !cast<ObjCMessageExpr>(e)->isDelegateInitCall())) {
2362 llvm::Value *result = emitARCRetainCall(CGF, e);
2363 if (resultType) result = CGF.Builder.CreateBitCast(result, resultType);
2364 return TryEmitResult(result, true);
2365 }
2366
2367 // Conservatively halt the search at any other expression kind.
2368 break;
2369 }
2370
2371 // We didn't find an obvious production, so emit what we've got and
2372 // tell the caller that we didn't manage to retain.
2373 llvm::Value *result = CGF.EmitScalarExpr(e);
2374 if (resultType) result = CGF.Builder.CreateBitCast(result, resultType);
2375 return TryEmitResult(result, false);
2376}
2377
2378static llvm::Value *emitARCRetainLoadOfScalar(CodeGenFunction &CGF,
2379 LValue lvalue,
2380 QualType type) {
2381 TryEmitResult result = tryEmitARCRetainLoadOfScalar(CGF, lvalue, type);
2382 llvm::Value *value = result.getPointer();
2383 if (!result.getInt())
2384 value = CGF.EmitARCRetain(type, value);
2385 return value;
2386}
2387
2388/// EmitARCRetainScalarExpr - Semantically equivalent to
2389/// EmitARCRetainObject(e->getType(), EmitScalarExpr(e)), but making a
2390/// best-effort attempt to peephole expressions that naturally produce
2391/// retained objects.
2392llvm::Value *CodeGenFunction::EmitARCRetainScalarExpr(const Expr *e) {
2393 TryEmitResult result = tryEmitARCRetainScalarExpr(*this, e);
2394 llvm::Value *value = result.getPointer();
2395 if (!result.getInt())
2396 value = EmitARCRetain(e->getType(), value);
2397 return value;
2398}
2399
2400llvm::Value *
2401CodeGenFunction::EmitARCRetainAutoreleaseScalarExpr(const Expr *e) {
2402 TryEmitResult result = tryEmitARCRetainScalarExpr(*this, e);
2403 llvm::Value *value = result.getPointer();
2404 if (result.getInt())
2405 value = EmitARCAutorelease(value);
2406 else
2407 value = EmitARCRetainAutorelease(e->getType(), value);
2408 return value;
2409}
2410
John McCall348f16f2011-10-04 06:23:45 +00002411llvm::Value *CodeGenFunction::EmitARCExtendBlockObject(const Expr *e) {
2412 llvm::Value *result;
2413 bool doRetain;
2414
2415 if (shouldEmitSeparateBlockRetain(e)) {
2416 result = EmitScalarExpr(e);
2417 doRetain = true;
2418 } else {
2419 TryEmitResult subresult = tryEmitARCRetainScalarExpr(*this, e);
2420 result = subresult.getPointer();
2421 doRetain = !subresult.getInt();
2422 }
2423
2424 if (doRetain)
2425 result = EmitARCRetainBlock(result, /*mandatory*/ true);
2426 return EmitObjCConsumeObject(e->getType(), result);
2427}
2428
John McCall2b014d62011-10-01 10:32:24 +00002429llvm::Value *CodeGenFunction::EmitObjCThrowOperand(const Expr *expr) {
2430 // In ARC, retain and autorelease the expression.
2431 if (getLangOptions().ObjCAutoRefCount) {
2432 // Do so before running any cleanups for the full-expression.
2433 // tryEmitARCRetainScalarExpr does make an effort to do things
2434 // inside cleanups, but there are crazy cases like
2435 // @throw A().foo;
2436 // where a full retain+autorelease is required and would
2437 // otherwise happen after the destructor for the temporary.
2438 CodeGenFunction::RunCleanupsScope cleanups(*this);
2439 if (const ExprWithCleanups *ewc = dyn_cast<ExprWithCleanups>(expr))
2440 expr = ewc->getSubExpr();
2441
2442 return EmitARCRetainAutoreleaseScalarExpr(expr);
2443 }
2444
2445 // Otherwise, use the normal scalar-expression emission. The
2446 // exception machinery doesn't do anything special with the
2447 // exception like retaining it, so there's no safety associated with
2448 // only running cleanups after the throw has started, and when it
2449 // matters it tends to be substantially inferior code.
2450 return EmitScalarExpr(expr);
2451}
2452
John McCallf85e1932011-06-15 23:02:42 +00002453std::pair<LValue,llvm::Value*>
2454CodeGenFunction::EmitARCStoreStrong(const BinaryOperator *e,
2455 bool ignored) {
2456 // Evaluate the RHS first.
2457 TryEmitResult result = tryEmitARCRetainScalarExpr(*this, e->getRHS());
2458 llvm::Value *value = result.getPointer();
2459
John McCallfb720812011-07-28 07:23:35 +00002460 bool hasImmediateRetain = result.getInt();
2461
2462 // If we didn't emit a retained object, and the l-value is of block
2463 // type, then we need to emit the block-retain immediately in case
2464 // it invalidates the l-value.
2465 if (!hasImmediateRetain && e->getType()->isBlockPointerType()) {
John McCall348f16f2011-10-04 06:23:45 +00002466 value = EmitARCRetainBlock(value, /*mandatory*/ false);
John McCallfb720812011-07-28 07:23:35 +00002467 hasImmediateRetain = true;
2468 }
2469
John McCallf85e1932011-06-15 23:02:42 +00002470 LValue lvalue = EmitLValue(e->getLHS());
2471
2472 // If the RHS was emitted retained, expand this.
John McCallfb720812011-07-28 07:23:35 +00002473 if (hasImmediateRetain) {
John McCallf85e1932011-06-15 23:02:42 +00002474 llvm::Value *oldValue =
2475 EmitLoadOfScalar(lvalue.getAddress(), lvalue.isVolatileQualified(),
2476 lvalue.getAlignment(), e->getType(),
2477 lvalue.getTBAAInfo());
2478 EmitStoreOfScalar(value, lvalue.getAddress(),
2479 lvalue.isVolatileQualified(), lvalue.getAlignment(),
2480 e->getType(), lvalue.getTBAAInfo());
2481 EmitARCRelease(oldValue, /*precise*/ false);
2482 } else {
John McCall545d9962011-06-25 02:11:03 +00002483 value = EmitARCStoreStrong(lvalue, value, ignored);
John McCallf85e1932011-06-15 23:02:42 +00002484 }
2485
2486 return std::pair<LValue,llvm::Value*>(lvalue, value);
2487}
2488
2489std::pair<LValue,llvm::Value*>
2490CodeGenFunction::EmitARCStoreAutoreleasing(const BinaryOperator *e) {
2491 llvm::Value *value = EmitARCRetainAutoreleaseScalarExpr(e->getRHS());
2492 LValue lvalue = EmitLValue(e->getLHS());
2493
2494 EmitStoreOfScalar(value, lvalue.getAddress(),
2495 lvalue.isVolatileQualified(), lvalue.getAlignment(),
2496 e->getType(), lvalue.getTBAAInfo());
2497
2498 return std::pair<LValue,llvm::Value*>(lvalue, value);
2499}
2500
2501void CodeGenFunction::EmitObjCAutoreleasePoolStmt(
2502 const ObjCAutoreleasePoolStmt &ARPS) {
2503 const Stmt *subStmt = ARPS.getSubStmt();
2504 const CompoundStmt &S = cast<CompoundStmt>(*subStmt);
2505
2506 CGDebugInfo *DI = getDebugInfo();
2507 if (DI) {
2508 DI->setLocation(S.getLBracLoc());
Eric Christopheraa2164c2011-09-29 00:00:45 +00002509 DI->EmitLexicalBlockStart(Builder);
John McCallf85e1932011-06-15 23:02:42 +00002510 }
2511
2512 // Keep track of the current cleanup stack depth.
2513 RunCleanupsScope Scope(*this);
John McCall9f084a32011-07-06 00:26:06 +00002514 if (CGM.getCodeGenOpts().ObjCRuntimeHasARC) {
John McCallf85e1932011-06-15 23:02:42 +00002515 llvm::Value *token = EmitObjCAutoreleasePoolPush();
2516 EHStack.pushCleanup<CallObjCAutoreleasePoolObject>(NormalCleanup, token);
2517 } else {
2518 llvm::Value *token = EmitObjCMRRAutoreleasePoolPush();
2519 EHStack.pushCleanup<CallObjCMRRAutoreleasePoolObject>(NormalCleanup, token);
2520 }
2521
2522 for (CompoundStmt::const_body_iterator I = S.body_begin(),
2523 E = S.body_end(); I != E; ++I)
2524 EmitStmt(*I);
2525
2526 if (DI) {
2527 DI->setLocation(S.getRBracLoc());
Eric Christopheraa2164c2011-09-29 00:00:45 +00002528 DI->EmitLexicalBlockEnd(Builder);
John McCallf85e1932011-06-15 23:02:42 +00002529 }
2530}
John McCall0c24c802011-06-24 23:21:27 +00002531
2532/// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
2533/// make sure it survives garbage collection until this point.
2534void CodeGenFunction::EmitExtendGCLifetime(llvm::Value *object) {
2535 // We just use an inline assembly.
John McCall0c24c802011-06-24 23:21:27 +00002536 llvm::FunctionType *extenderType
Jay Foadda549e82011-07-29 13:56:53 +00002537 = llvm::FunctionType::get(VoidTy, VoidPtrTy, /*variadic*/ false);
John McCall0c24c802011-06-24 23:21:27 +00002538 llvm::Value *extender
2539 = llvm::InlineAsm::get(extenderType,
2540 /* assembly */ "",
2541 /* constraints */ "r",
2542 /* side effects */ true);
2543
2544 object = Builder.CreateBitCast(object, VoidPtrTy);
2545 Builder.CreateCall(extender, object)->setDoesNotThrow();
2546}
2547
Ted Kremenek2979ec72008-04-09 15:51:31 +00002548CGObjCRuntime::~CGObjCRuntime() {}