blob: 357d1ab818c4c022c1cd74ce620c64bf38efb309 [file] [log] [blame]
Erik Pilkington9227e102017-02-21 20:31:01 +00001//===---- CGObjC.cpp - Emit LLVM Code for Objective-C ---------------------===//
Anders Carlsson76f4a902007-08-21 17:43:55 +00002//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner5b12ab82007-12-29 19:59:25 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Anders Carlsson76f4a902007-08-21 17:43:55 +00007//
8//===----------------------------------------------------------------------===//
9//
10// This contains code to emit Objective-C code as LLVM code.
11//
12//===----------------------------------------------------------------------===//
13
Devang Pateld2d66652011-01-19 01:36:36 +000014#include "CGDebugInfo.h"
Ted Kremenek43e06332008-04-09 15:51:31 +000015#include "CGObjCRuntime.h"
Anders Carlsson76f4a902007-08-21 17:43:55 +000016#include "CodeGenFunction.h"
17#include "CodeGenModule.h"
John McCall31168b02011-06-15 23:02:42 +000018#include "TargetInfo.h"
Daniel Dunbar9e22c0d2008-08-29 08:11:39 +000019#include "clang/AST/ASTContext.h"
Daniel Dunbar6e8aa532008-08-11 05:35:13 +000020#include "clang/AST/DeclObjC.h"
Chris Lattnerf0b64d72009-04-26 01:32:48 +000021#include "clang/AST/StmtObjC.h"
Daniel Dunbarc5d33042008-09-03 00:27:26 +000022#include "clang/Basic/Diagnostic.h"
Mark Laceya8e7df32013-10-30 21:53:58 +000023#include "clang/CodeGen/CGFunctionInfo.h"
Anders Carlsson2e744e82008-08-30 19:51:14 +000024#include "llvm/ADT/STLExtras.h"
Chandler Carruthc80ceea2014-03-04 11:02:08 +000025#include "llvm/IR/CallSite.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000026#include "llvm/IR/DataLayout.h"
27#include "llvm/IR/InlineAsm.h"
Anders Carlsson76f4a902007-08-21 17:43:55 +000028using namespace clang;
29using namespace CodeGen;
30
John McCall31168b02011-06-15 23:02:42 +000031typedef llvm::PointerIntPair<llvm::Value*,1,bool> TryEmitResult;
32static TryEmitResult
33tryEmitARCRetainScalarExpr(CodeGenFunction &CGF, const Expr *e);
Douglas Gregore83b9562015-07-07 03:57:53 +000034static RValue AdjustObjCObjectType(CodeGenFunction &CGF,
35 QualType ET,
36 RValue Result);
John McCall31168b02011-06-15 23:02:42 +000037
38/// Given the address of a variable of pointer type, find the correct
39/// null to store into it.
John McCall7f416cc2015-09-08 08:05:57 +000040static llvm::Constant *getNullForVariable(Address addr) {
41 llvm::Type *type = addr.getElementType();
John McCall31168b02011-06-15 23:02:42 +000042 return llvm::ConstantPointerNull::get(cast<llvm::PointerType>(type));
43}
44
Chris Lattnerb1d329d2008-06-24 17:04:18 +000045/// Emits an instance of NSConstantString representing the object.
Mike Stump11289f42009-09-09 15:08:12 +000046llvm::Value *CodeGenFunction::EmitObjCStringLiteral(const ObjCStringLiteral *E)
Daniel Dunbar44b58a22008-11-25 21:53:21 +000047{
David Chisnall481e3a82010-01-23 02:40:42 +000048 llvm::Constant *C =
John McCall7f416cc2015-09-08 08:05:57 +000049 CGM.getObjCRuntime().GenerateConstantString(E->getString()).getPointer();
Daniel Dunbar66912a12008-08-20 00:28:19 +000050 // FIXME: This bitcast should just be made an invariant on the Runtime.
Owen Andersonade90fd2009-07-29 18:54:39 +000051 return llvm::ConstantExpr::getBitCast(C, ConvertType(E->getType()));
Chris Lattnerb1d329d2008-06-24 17:04:18 +000052}
53
Patrick Beard0caa3942012-04-19 00:25:12 +000054/// EmitObjCBoxedExpr - This routine generates code to call
55/// the appropriate expression boxing method. This will either be
Alex Denisovfde64952015-06-26 05:28:36 +000056/// one of +[NSNumber numberWith<Type>:], or +[NSString stringWithUTF8String:],
57/// or [NSValue valueWithBytes:objCType:].
Ted Kremeneke65b0862012-03-06 20:05:56 +000058///
Eric Christopher5d2b8d92012-03-29 17:31:31 +000059llvm::Value *
Patrick Beard0caa3942012-04-19 00:25:12 +000060CodeGenFunction::EmitObjCBoxedExpr(const ObjCBoxedExpr *E) {
Ted Kremeneke65b0862012-03-06 20:05:56 +000061 // Generate the correct selector for this literal's concrete type.
Ted Kremeneke65b0862012-03-06 20:05:56 +000062 // Get the method.
Patrick Beard0caa3942012-04-19 00:25:12 +000063 const ObjCMethodDecl *BoxingMethod = E->getBoxingMethod();
Alex Denisovfde64952015-06-26 05:28:36 +000064 const Expr *SubExpr = E->getSubExpr();
Patrick Beard0caa3942012-04-19 00:25:12 +000065 assert(BoxingMethod && "BoxingMethod is null");
66 assert(BoxingMethod->isClassMethod() && "BoxingMethod must be a class method");
67 Selector Sel = BoxingMethod->getSelector();
Ted Kremeneke65b0862012-03-06 20:05:56 +000068
69 // Generate a reference to the class pointer, which will be the receiver.
Patrick Beard0caa3942012-04-19 00:25:12 +000070 // Assumes that the method was introduced in the class that should be
71 // messaged (avoids pulling it out of the result type).
Ted Kremeneke65b0862012-03-06 20:05:56 +000072 CGObjCRuntime &Runtime = CGM.getObjCRuntime();
Patrick Beard0caa3942012-04-19 00:25:12 +000073 const ObjCInterfaceDecl *ClassDecl = BoxingMethod->getClassInterface();
John McCall882987f2013-02-28 19:01:20 +000074 llvm::Value *Receiver = Runtime.GetClass(*this, ClassDecl);
Fariborz Jahanian661a97b2014-12-18 17:13:56 +000075
Ted Kremeneke65b0862012-03-06 20:05:56 +000076 CallArgList Args;
Alex Denisovfde64952015-06-26 05:28:36 +000077 const ParmVarDecl *ArgDecl = *BoxingMethod->param_begin();
78 QualType ArgQT = ArgDecl->getType().getUnqualifiedType();
79
80 // ObjCBoxedExpr supports boxing of structs and unions
81 // via [NSValue valueWithBytes:objCType:]
82 const QualType ValueType(SubExpr->getType().getCanonicalType());
83 if (ValueType->isObjCBoxableRecordType()) {
84 // Emit CodeGen for first parameter
85 // and cast value to correct type
John McCall7f416cc2015-09-08 08:05:57 +000086 Address Temporary = CreateMemTemp(SubExpr->getType());
Alex Denisovfde64952015-06-26 05:28:36 +000087 EmitAnyExprToMem(SubExpr, Temporary, Qualifiers(), /*isInit*/ true);
John McCall7f416cc2015-09-08 08:05:57 +000088 Address BitCast = Builder.CreateBitCast(Temporary, ConvertType(ArgQT));
89 Args.add(RValue::get(BitCast.getPointer()), ArgQT);
Alex Denisovfde64952015-06-26 05:28:36 +000090
91 // Create char array to store type encoding
92 std::string Str;
93 getContext().getObjCEncodingForType(ValueType, Str);
John McCall7f416cc2015-09-08 08:05:57 +000094 llvm::Constant *GV = CGM.GetAddrOfConstantCString(Str).getPointer();
Alex Denisovfde64952015-06-26 05:28:36 +000095
96 // Cast type encoding to correct type
97 const ParmVarDecl *EncodingDecl = BoxingMethod->parameters()[1];
98 QualType EncodingQT = EncodingDecl->getType().getUnqualifiedType();
99 llvm::Value *Cast = Builder.CreateBitCast(GV, ConvertType(EncodingQT));
100
101 Args.add(RValue::get(Cast), EncodingQT);
102 } else {
103 Args.add(EmitAnyExpr(SubExpr), ArgQT);
104 }
Alp Toker314cc812014-01-25 16:55:45 +0000105
106 RValue result = Runtime.GenerateMessageSend(
107 *this, ReturnValueSlot(), BoxingMethod->getReturnType(), Sel, Receiver,
108 Args, ClassDecl, BoxingMethod);
Ted Kremeneke65b0862012-03-06 20:05:56 +0000109 return Builder.CreateBitCast(result.getScalarVal(),
110 ConvertType(E->getType()));
111}
112
113llvm::Value *CodeGenFunction::EmitObjCCollectionLiteral(const Expr *E,
Fariborz Jahanian9ad94aa2014-10-28 18:28:16 +0000114 const ObjCMethodDecl *MethodWithObjects) {
Ted Kremeneke65b0862012-03-06 20:05:56 +0000115 ASTContext &Context = CGM.getContext();
Craig Topper8a13c412014-05-21 05:09:00 +0000116 const ObjCDictionaryLiteral *DLE = nullptr;
Ted Kremeneke65b0862012-03-06 20:05:56 +0000117 const ObjCArrayLiteral *ALE = dyn_cast<ObjCArrayLiteral>(E);
118 if (!ALE)
119 DLE = cast<ObjCDictionaryLiteral>(E);
Akira Hatanaka4d53a1c2017-04-15 06:42:00 +0000120
121 // Optimize empty collections by referencing constants, when available.
Ted Kremeneke65b0862012-03-06 20:05:56 +0000122 uint64_t NumElements =
123 ALE ? ALE->getNumElements() : DLE->getNumElements();
Akira Hatanaka4d53a1c2017-04-15 06:42:00 +0000124 if (NumElements == 0 && CGM.getLangOpts().ObjCRuntime.hasEmptyCollections()) {
125 StringRef ConstantName = ALE ? "__NSArray0__" : "__NSDictionary0__";
126 QualType IdTy(CGM.getContext().getObjCIdType());
127 llvm::Constant *Constant =
128 CGM.CreateRuntimeVariable(ConvertType(IdTy), ConstantName);
Akira Hatanakab5d1ea42017-04-17 15:21:55 +0000129 LValue LV = MakeNaturalAlignAddrLValue(Constant, IdTy);
130 llvm::Value *Ptr = EmitLoadOfScalar(LV, E->getLocStart());
131 cast<llvm::LoadInst>(Ptr)->setMetadata(
132 CGM.getModule().getMDKindID("invariant.load"),
133 llvm::MDNode::get(getLLVMContext(), None));
134 return Builder.CreateBitCast(Ptr, ConvertType(E->getType()));
Akira Hatanaka4d53a1c2017-04-15 06:42:00 +0000135 }
136
137 // Compute the type of the array we're initializing.
Ted Kremeneke65b0862012-03-06 20:05:56 +0000138 llvm::APInt APNumElements(Context.getTypeSize(Context.getSizeType()),
139 NumElements);
140 QualType ElementType = Context.getObjCIdType().withConst();
141 QualType ElementArrayType
142 = Context.getConstantArrayType(ElementType, APNumElements,
143 ArrayType::Normal, /*IndexTypeQuals=*/0);
144
145 // Allocate the temporary array(s).
John McCall7f416cc2015-09-08 08:05:57 +0000146 Address Objects = CreateMemTemp(ElementArrayType, "objects");
147 Address Keys = Address::invalid();
Ted Kremeneke65b0862012-03-06 20:05:56 +0000148 if (DLE)
149 Keys = CreateMemTemp(ElementArrayType, "keys");
150
John McCall770a4c12013-04-04 00:20:38 +0000151 // In ARC, we may need to do extra work to keep all the keys and
152 // values alive until after the call.
153 SmallVector<llvm::Value *, 16> NeededObjects;
154 bool TrackNeededObjects =
155 (getLangOpts().ObjCAutoRefCount &&
156 CGM.getCodeGenOpts().OptimizationLevel != 0);
157
Ted Kremeneke65b0862012-03-06 20:05:56 +0000158 // Perform the actual initialialization of the array(s).
159 for (uint64_t i = 0; i < NumElements; i++) {
160 if (ALE) {
John McCall770a4c12013-04-04 00:20:38 +0000161 // Emit the element and store it to the appropriate array slot.
Ted Kremeneke65b0862012-03-06 20:05:56 +0000162 const Expr *Rhs = ALE->getElement(i);
John McCall7f416cc2015-09-08 08:05:57 +0000163 LValue LV = MakeAddrLValue(
164 Builder.CreateConstArrayGEP(Objects, i, getPointerSize()),
165 ElementType, AlignmentSource::Decl);
John McCall770a4c12013-04-04 00:20:38 +0000166
167 llvm::Value *value = EmitScalarExpr(Rhs);
168 EmitStoreThroughLValue(RValue::get(value), LV, true);
169 if (TrackNeededObjects) {
170 NeededObjects.push_back(value);
171 }
Ted Kremeneke65b0862012-03-06 20:05:56 +0000172 } else {
John McCall770a4c12013-04-04 00:20:38 +0000173 // Emit the key and store it to the appropriate array slot.
Ted Kremeneke65b0862012-03-06 20:05:56 +0000174 const Expr *Key = DLE->getKeyValueElement(i).Key;
John McCall7f416cc2015-09-08 08:05:57 +0000175 LValue KeyLV = MakeAddrLValue(
176 Builder.CreateConstArrayGEP(Keys, i, getPointerSize()),
177 ElementType, AlignmentSource::Decl);
John McCall770a4c12013-04-04 00:20:38 +0000178 llvm::Value *keyValue = EmitScalarExpr(Key);
179 EmitStoreThroughLValue(RValue::get(keyValue), KeyLV, /*isInit=*/true);
Ted Kremeneke65b0862012-03-06 20:05:56 +0000180
John McCall770a4c12013-04-04 00:20:38 +0000181 // Emit the value and store it to the appropriate array slot.
David Blaikie1ed728c2015-04-05 22:45:47 +0000182 const Expr *Value = DLE->getKeyValueElement(i).Value;
John McCall7f416cc2015-09-08 08:05:57 +0000183 LValue ValueLV = MakeAddrLValue(
184 Builder.CreateConstArrayGEP(Objects, i, getPointerSize()),
185 ElementType, AlignmentSource::Decl);
John McCall770a4c12013-04-04 00:20:38 +0000186 llvm::Value *valueValue = EmitScalarExpr(Value);
187 EmitStoreThroughLValue(RValue::get(valueValue), ValueLV, /*isInit=*/true);
188 if (TrackNeededObjects) {
189 NeededObjects.push_back(keyValue);
190 NeededObjects.push_back(valueValue);
191 }
Ted Kremeneke65b0862012-03-06 20:05:56 +0000192 }
193 }
194
195 // Generate the argument list.
196 CallArgList Args;
197 ObjCMethodDecl::param_const_iterator PI = MethodWithObjects->param_begin();
198 const ParmVarDecl *argDecl = *PI++;
199 QualType ArgQT = argDecl->getType().getUnqualifiedType();
John McCall7f416cc2015-09-08 08:05:57 +0000200 Args.add(RValue::get(Objects.getPointer()), ArgQT);
Ted Kremeneke65b0862012-03-06 20:05:56 +0000201 if (DLE) {
202 argDecl = *PI++;
203 ArgQT = argDecl->getType().getUnqualifiedType();
John McCall7f416cc2015-09-08 08:05:57 +0000204 Args.add(RValue::get(Keys.getPointer()), ArgQT);
Ted Kremeneke65b0862012-03-06 20:05:56 +0000205 }
206 argDecl = *PI;
207 ArgQT = argDecl->getType().getUnqualifiedType();
208 llvm::Value *Count =
209 llvm::ConstantInt::get(CGM.getTypes().ConvertType(ArgQT), NumElements);
210 Args.add(RValue::get(Count), ArgQT);
211
212 // Generate a reference to the class pointer, which will be the receiver.
213 Selector Sel = MethodWithObjects->getSelector();
214 QualType ResultType = E->getType();
215 const ObjCObjectPointerType *InterfacePointerType
216 = ResultType->getAsObjCInterfacePointerType();
217 ObjCInterfaceDecl *Class
218 = InterfacePointerType->getObjectType()->getInterface();
219 CGObjCRuntime &Runtime = CGM.getObjCRuntime();
John McCall882987f2013-02-28 19:01:20 +0000220 llvm::Value *Receiver = Runtime.GetClass(*this, Class);
Ted Kremeneke65b0862012-03-06 20:05:56 +0000221
222 // Generate the message send.
Alp Toker314cc812014-01-25 16:55:45 +0000223 RValue result = Runtime.GenerateMessageSend(
224 *this, ReturnValueSlot(), MethodWithObjects->getReturnType(), Sel,
225 Receiver, Args, Class, MethodWithObjects);
John McCall770a4c12013-04-04 00:20:38 +0000226
227 // The above message send needs these objects, but in ARC they are
228 // passed in a buffer that is essentially __unsafe_unretained.
229 // Therefore we must prevent the optimizer from releasing them until
230 // after the call.
231 if (TrackNeededObjects) {
232 EmitARCIntrinsicUse(NeededObjects);
233 }
234
Ted Kremeneke65b0862012-03-06 20:05:56 +0000235 return Builder.CreateBitCast(result.getScalarVal(),
236 ConvertType(E->getType()));
237}
238
239llvm::Value *CodeGenFunction::EmitObjCArrayLiteral(const ObjCArrayLiteral *E) {
Fariborz Jahanian9ad94aa2014-10-28 18:28:16 +0000240 return EmitObjCCollectionLiteral(E, E->getArrayWithObjectsMethod());
Ted Kremeneke65b0862012-03-06 20:05:56 +0000241}
242
243llvm::Value *CodeGenFunction::EmitObjCDictionaryLiteral(
244 const ObjCDictionaryLiteral *E) {
Fariborz Jahanian9ad94aa2014-10-28 18:28:16 +0000245 return EmitObjCCollectionLiteral(E, E->getDictWithObjectsMethod());
Ted Kremeneke65b0862012-03-06 20:05:56 +0000246}
247
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000248/// Emit a selector.
249llvm::Value *CodeGenFunction::EmitObjCSelectorExpr(const ObjCSelectorExpr *E) {
250 // Untyped selector.
251 // Note that this implementation allows for non-constant strings to be passed
252 // as arguments to @selector(). Currently, the only thing preventing this
253 // behaviour is the type checking in the front end.
John McCall882987f2013-02-28 19:01:20 +0000254 return CGM.getObjCRuntime().GetSelector(*this, E->getSelector());
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000255}
256
Daniel Dunbar66912a12008-08-20 00:28:19 +0000257llvm::Value *CodeGenFunction::EmitObjCProtocolExpr(const ObjCProtocolExpr *E) {
258 // FIXME: This should pass the Decl not the name.
John McCall882987f2013-02-28 19:01:20 +0000259 return CGM.getObjCRuntime().GenerateProtocolRef(*this, E->getProtocol());
Daniel Dunbar66912a12008-08-20 00:28:19 +0000260}
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000261
Douglas Gregore83b9562015-07-07 03:57:53 +0000262/// \brief Adjust the type of an Objective-C object that doesn't match up due
263/// to type erasure at various points, e.g., related result types or the use
264/// of parameterized classes.
265static RValue AdjustObjCObjectType(CodeGenFunction &CGF, QualType ExpT,
266 RValue Result) {
267 if (!ExpT->isObjCRetainableType())
Douglas Gregor33823722011-06-11 01:09:30 +0000268 return Result;
John McCall31168b02011-06-15 23:02:42 +0000269
Douglas Gregore83b9562015-07-07 03:57:53 +0000270 // If the converted types are the same, we're done.
271 llvm::Type *ExpLLVMTy = CGF.ConvertType(ExpT);
272 if (ExpLLVMTy == Result.getScalarVal()->getType())
Douglas Gregor33823722011-06-11 01:09:30 +0000273 return Result;
Douglas Gregore83b9562015-07-07 03:57:53 +0000274
275 // We have applied a substitution. Cast the rvalue appropriately.
Douglas Gregor33823722011-06-11 01:09:30 +0000276 return RValue::get(CGF.Builder.CreateBitCast(Result.getScalarVal(),
Douglas Gregore83b9562015-07-07 03:57:53 +0000277 ExpLLVMTy));
Douglas Gregor33823722011-06-11 01:09:30 +0000278}
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000279
John McCallcf166702011-07-22 08:53:00 +0000280/// Decide whether to extend the lifetime of the receiver of a
281/// returns-inner-pointer message.
282static bool
283shouldExtendReceiverForInnerPointerMessage(const ObjCMessageExpr *message) {
284 switch (message->getReceiverKind()) {
285
286 // For a normal instance message, we should extend unless the
287 // receiver is loaded from a variable with precise lifetime.
288 case ObjCMessageExpr::Instance: {
289 const Expr *receiver = message->getInstanceReceiver();
John McCall6380a282015-09-09 23:37:17 +0000290
291 // Look through OVEs.
292 if (auto opaque = dyn_cast<OpaqueValueExpr>(receiver)) {
293 if (opaque->getSourceExpr())
294 receiver = opaque->getSourceExpr()->IgnoreParens();
295 }
296
John McCallcf166702011-07-22 08:53:00 +0000297 const ImplicitCastExpr *ice = dyn_cast<ImplicitCastExpr>(receiver);
298 if (!ice || ice->getCastKind() != CK_LValueToRValue) return true;
299 receiver = ice->getSubExpr()->IgnoreParens();
300
John McCall6380a282015-09-09 23:37:17 +0000301 // Look through OVEs.
302 if (auto opaque = dyn_cast<OpaqueValueExpr>(receiver)) {
303 if (opaque->getSourceExpr())
304 receiver = opaque->getSourceExpr()->IgnoreParens();
305 }
306
John McCallcf166702011-07-22 08:53:00 +0000307 // Only __strong variables.
308 if (receiver->getType().getObjCLifetime() != Qualifiers::OCL_Strong)
309 return true;
310
311 // All ivars and fields have precise lifetime.
312 if (isa<MemberExpr>(receiver) || isa<ObjCIvarRefExpr>(receiver))
313 return false;
314
315 // Otherwise, check for variables.
316 const DeclRefExpr *declRef = dyn_cast<DeclRefExpr>(ice->getSubExpr());
317 if (!declRef) return true;
318 const VarDecl *var = dyn_cast<VarDecl>(declRef->getDecl());
319 if (!var) return true;
320
321 // All variables have precise lifetime except local variables with
322 // automatic storage duration that aren't specially marked.
323 return (var->hasLocalStorage() &&
324 !var->hasAttr<ObjCPreciseLifetimeAttr>());
325 }
326
327 case ObjCMessageExpr::Class:
328 case ObjCMessageExpr::SuperClass:
329 // It's never necessary for class objects.
330 return false;
331
332 case ObjCMessageExpr::SuperInstance:
333 // We generally assume that 'self' lives throughout a method call.
334 return false;
335 }
336
337 llvm_unreachable("invalid receiver kind");
338}
339
John McCall460ce582015-10-22 18:38:17 +0000340/// Given an expression of ObjC pointer type, check whether it was
341/// immediately loaded from an ARC __weak l-value.
342static const Expr *findWeakLValue(const Expr *E) {
343 assert(E->getType()->isObjCRetainableType());
344 E = E->IgnoreParens();
345 if (auto CE = dyn_cast<CastExpr>(E)) {
346 if (CE->getCastKind() == CK_LValueToRValue) {
347 if (CE->getSubExpr()->getType().getObjCLifetime() == Qualifiers::OCL_Weak)
348 return CE->getSubExpr();
349 }
350 }
351
352 return nullptr;
353}
354
John McCall78a15112010-05-22 01:48:05 +0000355RValue CodeGenFunction::EmitObjCMessageExpr(const ObjCMessageExpr *E,
356 ReturnValueSlot Return) {
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000357 // Only the lookup mechanism and first two arguments of the method
358 // implementation vary between runtimes. We can get the receiver and
359 // arguments in generic code.
Mike Stump11289f42009-09-09 15:08:12 +0000360
John McCall31168b02011-06-15 23:02:42 +0000361 bool isDelegateInit = E->isDelegateInitCall();
362
John McCallcf166702011-07-22 08:53:00 +0000363 const ObjCMethodDecl *method = E->getMethodDecl();
Fariborz Jahanian715fdd52012-01-29 20:27:13 +0000364
John McCall460ce582015-10-22 18:38:17 +0000365 // If the method is -retain, and the receiver's being loaded from
366 // a __weak variable, peephole the entire operation to objc_loadWeakRetained.
367 if (method && E->getReceiverKind() == ObjCMessageExpr::Instance &&
368 method->getMethodFamily() == OMF_retain) {
369 if (auto lvalueExpr = findWeakLValue(E->getInstanceReceiver())) {
370 LValue lvalue = EmitLValue(lvalueExpr);
371 llvm::Value *result = EmitARCLoadWeakRetained(lvalue.getAddress());
372 return AdjustObjCObjectType(*this, E->getType(), RValue::get(result));
373 }
374 }
375
John McCall31168b02011-06-15 23:02:42 +0000376 // We don't retain the receiver in delegate init calls, and this is
377 // safe because the receiver value is always loaded from 'self',
378 // which we zero out. We don't want to Block_copy block receivers,
379 // though.
380 bool retainSelf =
381 (!isDelegateInit &&
David Blaikiebbafb8a2012-03-11 07:00:24 +0000382 CGM.getLangOpts().ObjCAutoRefCount &&
John McCallcf166702011-07-22 08:53:00 +0000383 method &&
384 method->hasAttr<NSConsumesSelfAttr>());
John McCall31168b02011-06-15 23:02:42 +0000385
Daniel Dunbar8d480592008-08-11 18:12:00 +0000386 CGObjCRuntime &Runtime = CGM.getObjCRuntime();
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000387 bool isSuperMessage = false;
Daniel Dunbarca8531a2008-08-25 08:19:24 +0000388 bool isClassMessage = false;
Craig Topper8a13c412014-05-21 05:09:00 +0000389 ObjCInterfaceDecl *OID = nullptr;
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000390 // Find the receiver
Douglas Gregor33823722011-06-11 01:09:30 +0000391 QualType ReceiverType;
Craig Topper8a13c412014-05-21 05:09:00 +0000392 llvm::Value *Receiver = nullptr;
Douglas Gregor9a129192010-04-21 00:45:42 +0000393 switch (E->getReceiverKind()) {
394 case ObjCMessageExpr::Instance:
Douglas Gregor33823722011-06-11 01:09:30 +0000395 ReceiverType = E->getInstanceReceiver()->getType();
John McCall31168b02011-06-15 23:02:42 +0000396 if (retainSelf) {
397 TryEmitResult ter = tryEmitARCRetainScalarExpr(*this,
398 E->getInstanceReceiver());
399 Receiver = ter.getPointer();
John McCallcf166702011-07-22 08:53:00 +0000400 if (ter.getInt()) retainSelf = false;
John McCall31168b02011-06-15 23:02:42 +0000401 } else
402 Receiver = EmitScalarExpr(E->getInstanceReceiver());
Douglas Gregor9a129192010-04-21 00:45:42 +0000403 break;
Daniel Dunbar7c6d3a72008-08-16 00:25:02 +0000404
Douglas Gregor9a129192010-04-21 00:45:42 +0000405 case ObjCMessageExpr::Class: {
Douglas Gregor33823722011-06-11 01:09:30 +0000406 ReceiverType = E->getClassReceiver();
407 const ObjCObjectType *ObjTy = ReceiverType->getAs<ObjCObjectType>();
John McCall3e294922010-05-17 20:12:43 +0000408 assert(ObjTy && "Invalid Objective-C class message send");
409 OID = ObjTy->getInterface();
410 assert(OID && "Invalid Objective-C class message send");
John McCall882987f2013-02-28 19:01:20 +0000411 Receiver = Runtime.GetClass(*this, OID);
Daniel Dunbarca8531a2008-08-25 08:19:24 +0000412 isClassMessage = true;
Douglas Gregor9a129192010-04-21 00:45:42 +0000413 break;
414 }
415
416 case ObjCMessageExpr::SuperInstance:
Douglas Gregor33823722011-06-11 01:09:30 +0000417 ReceiverType = E->getSuperType();
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000418 Receiver = LoadObjCSelf();
Douglas Gregor9a129192010-04-21 00:45:42 +0000419 isSuperMessage = true;
420 break;
421
422 case ObjCMessageExpr::SuperClass:
Douglas Gregor33823722011-06-11 01:09:30 +0000423 ReceiverType = E->getSuperType();
Douglas Gregor9a129192010-04-21 00:45:42 +0000424 Receiver = LoadObjCSelf();
425 isSuperMessage = true;
426 isClassMessage = true;
427 break;
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000428 }
429
John McCallcf166702011-07-22 08:53:00 +0000430 if (retainSelf)
431 Receiver = EmitARCRetainNonBlock(Receiver);
432
433 // In ARC, we sometimes want to "extend the lifetime"
434 // (i.e. retain+autorelease) of receivers of returns-inner-pointer
435 // messages.
David Blaikiebbafb8a2012-03-11 07:00:24 +0000436 if (getLangOpts().ObjCAutoRefCount && method &&
John McCallcf166702011-07-22 08:53:00 +0000437 method->hasAttr<ObjCReturnsInnerPointerAttr>() &&
438 shouldExtendReceiverForInnerPointerMessage(E))
439 Receiver = EmitARCRetainAutorelease(ReceiverType, Receiver);
440
Alp Toker314cc812014-01-25 16:55:45 +0000441 QualType ResultType = method ? method->getReturnType() : E->getType();
John McCall31168b02011-06-15 23:02:42 +0000442
Daniel Dunbarc722b852008-08-30 03:02:31 +0000443 CallArgList Args;
Vedant Kumared00ea02017-03-06 05:28:22 +0000444 EmitCallArgs(Args, method, E->arguments(), /*AC*/AbstractCallee(method));
Mike Stump11289f42009-09-09 15:08:12 +0000445
John McCall31168b02011-06-15 23:02:42 +0000446 // For delegate init calls in ARC, do an unsafe store of null into
447 // self. This represents the call taking direct ownership of that
448 // value. We have to do this after emitting the other call
449 // arguments because they might also reference self, but we don't
450 // have to worry about any of them modifying self because that would
451 // be an undefined read and write of an object in unordered
452 // expressions.
453 if (isDelegateInit) {
David Blaikiebbafb8a2012-03-11 07:00:24 +0000454 assert(getLangOpts().ObjCAutoRefCount &&
John McCall31168b02011-06-15 23:02:42 +0000455 "delegate init calls should only be marked in ARC");
456
457 // Do an unsafe store of null into self.
John McCall7f416cc2015-09-08 08:05:57 +0000458 Address selfAddr =
459 GetAddrOfLocalVar(cast<ObjCMethodDecl>(CurCodeDecl)->getSelfDecl());
John McCall31168b02011-06-15 23:02:42 +0000460 Builder.CreateStore(getNullForVariable(selfAddr), selfAddr);
461 }
Anders Carlsson280e61f12010-06-21 20:59:55 +0000462
Douglas Gregor33823722011-06-11 01:09:30 +0000463 RValue result;
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000464 if (isSuperMessage) {
Chris Lattner6cfec782008-06-26 04:42:20 +0000465 // super is only valid in an Objective-C method
466 const ObjCMethodDecl *OMD = cast<ObjCMethodDecl>(CurFuncDecl);
Fariborz Jahanianbac73ac2009-02-28 20:07:56 +0000467 bool isCategoryImpl = isa<ObjCCategoryImplDecl>(OMD->getDeclContext());
Douglas Gregor33823722011-06-11 01:09:30 +0000468 result = Runtime.GenerateMessageSendSuper(*this, Return, ResultType,
469 E->getSelector(),
470 OMD->getClassInterface(),
471 isCategoryImpl,
472 Receiver,
473 isClassMessage,
474 Args,
John McCallcf166702011-07-22 08:53:00 +0000475 method);
Douglas Gregor33823722011-06-11 01:09:30 +0000476 } else {
Pete Cooper94867712016-03-21 20:50:03 +0000477 result = Runtime.GenerateMessageSend(*this, Return, ResultType,
478 E->getSelector(),
479 Receiver, Args, OID,
480 method);
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000481 }
John McCall31168b02011-06-15 23:02:42 +0000482
483 // For delegate init calls in ARC, implicitly store the result of
484 // the call back into self. This takes ownership of the value.
485 if (isDelegateInit) {
John McCall7f416cc2015-09-08 08:05:57 +0000486 Address selfAddr =
487 GetAddrOfLocalVar(cast<ObjCMethodDecl>(CurCodeDecl)->getSelfDecl());
John McCall31168b02011-06-15 23:02:42 +0000488 llvm::Value *newSelf = result.getScalarVal();
489
490 // The delegate return type isn't necessarily a matching type; in
491 // fact, it's quite likely to be 'id'.
John McCall7f416cc2015-09-08 08:05:57 +0000492 llvm::Type *selfTy = selfAddr.getElementType();
John McCall31168b02011-06-15 23:02:42 +0000493 newSelf = Builder.CreateBitCast(newSelf, selfTy);
494
495 Builder.CreateStore(newSelf, selfAddr);
496 }
Fariborz Jahanian715fdd52012-01-29 20:27:13 +0000497
Douglas Gregore83b9562015-07-07 03:57:53 +0000498 return AdjustObjCObjectType(*this, E->getType(), result);
Anders Carlsson76f4a902007-08-21 17:43:55 +0000499}
500
John McCall31168b02011-06-15 23:02:42 +0000501namespace {
David Blaikie7e70d682015-08-18 22:40:54 +0000502struct FinishARCDealloc final : EHScopeStack::Cleanup {
Craig Topper4f12f102014-03-12 06:41:41 +0000503 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall31168b02011-06-15 23:02:42 +0000504 const ObjCMethodDecl *method = cast<ObjCMethodDecl>(CGF.CurCodeDecl);
John McCalldffafde2011-07-13 18:26:47 +0000505
506 const ObjCImplDecl *impl = cast<ObjCImplDecl>(method->getDeclContext());
John McCall31168b02011-06-15 23:02:42 +0000507 const ObjCInterfaceDecl *iface = impl->getClassInterface();
508 if (!iface->getSuperClass()) return;
509
John McCalldffafde2011-07-13 18:26:47 +0000510 bool isCategory = isa<ObjCCategoryImplDecl>(impl);
511
John McCall31168b02011-06-15 23:02:42 +0000512 // Call [super dealloc] if we have a superclass.
513 llvm::Value *self = CGF.LoadObjCSelf();
514
515 CallArgList args;
516 CGF.CGM.getObjCRuntime().GenerateMessageSendSuper(CGF, ReturnValueSlot(),
517 CGF.getContext().VoidTy,
518 method->getSelector(),
519 iface,
John McCalldffafde2011-07-13 18:26:47 +0000520 isCategory,
John McCall31168b02011-06-15 23:02:42 +0000521 self,
522 /*is class msg*/ false,
523 args,
524 method);
525 }
526};
Alexander Kornienkoab9db512015-06-22 23:07:51 +0000527}
John McCall31168b02011-06-15 23:02:42 +0000528
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000529/// StartObjCMethod - Begin emission of an ObjCMethod. This generates
530/// the LLVM function and sets the other context used by
531/// CodeGenFunction.
Fariborz Jahanian0196a1c2009-01-10 21:06:09 +0000532void CodeGenFunction::StartObjCMethod(const ObjCMethodDecl *OMD,
David Blaikief1425802015-01-14 00:04:42 +0000533 const ObjCContainerDecl *CD) {
534 SourceLocation StartLoc = OMD->getLocStart();
John McCalla738c252011-03-09 04:27:21 +0000535 FunctionArgList args;
Devang Patela2c048e2010-04-05 21:09:15 +0000536 // Check if we should generate debug info for this method.
David Blaikie92848de2013-08-26 20:33:21 +0000537 if (OMD->hasAttr<NoDebugAttr>())
Craig Topper8a13c412014-05-21 05:09:00 +0000538 DebugInfo = nullptr; // disable debug info indefinitely for this function
Devang Patela2c048e2010-04-05 21:09:15 +0000539
Fariborz Jahanian0196a1c2009-01-10 21:06:09 +0000540 llvm::Function *Fn = CGM.getObjCRuntime().GenerateMethod(OMD, CD);
Daniel Dunbar449a3392008-09-04 23:41:35 +0000541
John McCalla729c622012-02-17 03:33:10 +0000542 const CGFunctionInfo &FI = CGM.getTypes().arrangeObjCMethodDeclaration(OMD);
Daniel Dunbarc3e7cff2009-04-17 00:48:04 +0000543 CGM.SetInternalFunctionAttributes(OMD, Fn, FI);
Chris Lattner5696e7b2008-06-17 18:05:57 +0000544
John McCalla738c252011-03-09 04:27:21 +0000545 args.push_back(OMD->getSelfDecl());
546 args.push_back(OMD->getCmdDecl());
Chris Lattner5696e7b2008-06-17 18:05:57 +0000547
Benjamin Kramerf9890422015-02-17 16:48:30 +0000548 args.append(OMD->param_begin(), OMD->param_end());
Chris Lattner5696e7b2008-06-17 18:05:57 +0000549
Peter Collingbourne0ff0b372011-01-13 18:57:25 +0000550 CurGD = OMD;
David Blaikie47d28e02015-01-14 07:10:46 +0000551 CurEHLocation = OMD->getLocEnd();
Peter Collingbourne0ff0b372011-01-13 18:57:25 +0000552
Adrian Prantl42d71b92014-04-10 23:21:53 +0000553 StartFunction(OMD, OMD->getReturnType(), Fn, FI, args,
554 OMD->getLocation(), StartLoc);
John McCall31168b02011-06-15 23:02:42 +0000555
556 // In ARC, certain methods get an extra cleanup.
David Blaikiebbafb8a2012-03-11 07:00:24 +0000557 if (CGM.getLangOpts().ObjCAutoRefCount &&
John McCall31168b02011-06-15 23:02:42 +0000558 OMD->isInstanceMethod() &&
559 OMD->getSelector().isUnarySelector()) {
560 const IdentifierInfo *ident =
561 OMD->getSelector().getIdentifierInfoForSlot(0);
562 if (ident->isStr("dealloc"))
563 EHStack.pushCleanup<FinishARCDealloc>(getARCCleanupKind());
564 }
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000565}
Daniel Dunbara94ecd22008-08-16 03:19:19 +0000566
John McCall31168b02011-06-15 23:02:42 +0000567static llvm::Value *emitARCRetainLoadOfScalar(CodeGenFunction &CGF,
568 LValue lvalue, QualType type);
569
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000570/// Generate an Objective-C method. An Objective-C method is a C function with
Mike Stump11289f42009-09-09 15:08:12 +0000571/// its pointer, name, and types registered in the class struture.
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000572void CodeGenFunction::GenerateObjCMethod(const ObjCMethodDecl *OMD) {
David Blaikief1425802015-01-14 00:04:42 +0000573 StartObjCMethod(OMD, OMD->getClassInterface());
Serge Pavlov3a561452015-12-06 14:32:39 +0000574 PGO.assignRegionCounters(GlobalDecl(OMD), CurFn);
Adrian Prantl56741e22014-01-07 22:05:55 +0000575 assert(isa<CompoundStmt>(OMD->getBody()));
Justin Bogner66242d62015-04-23 23:06:47 +0000576 incrementProfileCounter(OMD->getBody());
Adrian Prantl56741e22014-01-07 22:05:55 +0000577 EmitCompoundStmtWithoutScope(*cast<CompoundStmt>(OMD->getBody()));
Argyrios Kyrtzidisddcd1322009-06-30 02:35:26 +0000578 FinishFunction(OMD->getBodyRBrace());
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000579}
580
John McCallb923ece2011-09-12 23:06:44 +0000581/// emitStructGetterCall - Call the runtime function to load a property
582/// into the return value slot.
583static void emitStructGetterCall(CodeGenFunction &CGF, ObjCIvarDecl *ivar,
584 bool isAtomic, bool hasStrong) {
585 ASTContext &Context = CGF.getContext();
586
John McCall7f416cc2015-09-08 08:05:57 +0000587 Address src =
588 CGF.EmitLValueForIvar(CGF.TypeOfSelfObject(), CGF.LoadObjCSelf(), ivar, 0)
589 .getAddress();
John McCallb923ece2011-09-12 23:06:44 +0000590
591 // objc_copyStruct (ReturnValue, &structIvar,
592 // sizeof (Type of Ivar), isAtomic, false);
593 CallArgList args;
594
John McCall7f416cc2015-09-08 08:05:57 +0000595 Address dest = CGF.Builder.CreateBitCast(CGF.ReturnValue, CGF.VoidPtrTy);
596 args.add(RValue::get(dest.getPointer()), Context.VoidPtrTy);
John McCallb923ece2011-09-12 23:06:44 +0000597
598 src = CGF.Builder.CreateBitCast(src, CGF.VoidPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +0000599 args.add(RValue::get(src.getPointer()), Context.VoidPtrTy);
John McCallb923ece2011-09-12 23:06:44 +0000600
601 CharUnits size = CGF.getContext().getTypeSizeInChars(ivar->getType());
602 args.add(RValue::get(CGF.CGM.getSize(size)), Context.getSizeType());
603 args.add(RValue::get(CGF.Builder.getInt1(isAtomic)), Context.BoolTy);
604 args.add(RValue::get(CGF.Builder.getInt1(hasStrong)), Context.BoolTy);
605
John McCallb92ab1a2016-10-26 23:46:34 +0000606 llvm::Constant *fn = CGF.CGM.getObjCRuntime().GetGetStructFunction();
607 CGCallee callee = CGCallee::forDirect(fn);
John McCallc56a8b32016-03-11 04:30:31 +0000608 CGF.EmitCall(CGF.getTypes().arrangeBuiltinFunctionCall(Context.VoidTy, args),
John McCallb92ab1a2016-10-26 23:46:34 +0000609 callee, ReturnValueSlot(), args);
John McCallb923ece2011-09-12 23:06:44 +0000610}
611
John McCallf4528ae2011-09-13 03:34:09 +0000612/// Determine whether the given architecture supports unaligned atomic
613/// accesses. They don't have to be fast, just faster than a function
614/// call and a mutex.
615static bool hasUnalignedAtomics(llvm::Triple::ArchType arch) {
Eli Friedman5be3e6a2011-09-13 20:48:30 +0000616 // FIXME: Allow unaligned atomic load/store on x86. (It is not
617 // currently supported by the backend.)
618 return 0;
John McCallf4528ae2011-09-13 03:34:09 +0000619}
620
621/// Return the maximum size that permits atomic accesses for the given
622/// architecture.
623static CharUnits getMaxAtomicAccessSize(CodeGenModule &CGM,
624 llvm::Triple::ArchType arch) {
625 // ARM has 8-byte atomic accesses, but it's not clear whether we
626 // want to rely on them here.
627
628 // In the default case, just assume that any size up to a pointer is
629 // fine given adequate alignment.
630 return CharUnits::fromQuantity(CGM.PointerSizeInBytes);
631}
632
633namespace {
634 class PropertyImplStrategy {
635 public:
636 enum StrategyKind {
637 /// The 'native' strategy is to use the architecture's provided
638 /// reads and writes.
639 Native,
640
641 /// Use objc_setProperty and objc_getProperty.
642 GetSetProperty,
643
644 /// Use objc_setProperty for the setter, but use expression
645 /// evaluation for the getter.
646 SetPropertyAndExpressionGet,
647
648 /// Use objc_copyStruct.
649 CopyStruct,
650
651 /// The 'expression' strategy is to emit normal assignment or
652 /// lvalue-to-rvalue expressions.
653 Expression
654 };
655
656 StrategyKind getKind() const { return StrategyKind(Kind); }
657
658 bool hasStrongMember() const { return HasStrong; }
659 bool isAtomic() const { return IsAtomic; }
660 bool isCopy() const { return IsCopy; }
661
662 CharUnits getIvarSize() const { return IvarSize; }
663 CharUnits getIvarAlignment() const { return IvarAlignment; }
664
665 PropertyImplStrategy(CodeGenModule &CGM,
666 const ObjCPropertyImplDecl *propImpl);
667
668 private:
669 unsigned Kind : 8;
670 unsigned IsAtomic : 1;
671 unsigned IsCopy : 1;
672 unsigned HasStrong : 1;
673
674 CharUnits IvarSize;
675 CharUnits IvarAlignment;
676 };
Alexander Kornienkoab9db512015-06-22 23:07:51 +0000677}
John McCallf4528ae2011-09-13 03:34:09 +0000678
Sylvestre Ledru830885c2012-07-23 08:59:39 +0000679/// Pick an implementation strategy for the given property synthesis.
John McCallf4528ae2011-09-13 03:34:09 +0000680PropertyImplStrategy::PropertyImplStrategy(CodeGenModule &CGM,
681 const ObjCPropertyImplDecl *propImpl) {
682 const ObjCPropertyDecl *prop = propImpl->getPropertyDecl();
John McCall43192862011-09-13 18:31:23 +0000683 ObjCPropertyDecl::SetterKind setterKind = prop->getSetterKind();
John McCallf4528ae2011-09-13 03:34:09 +0000684
John McCall43192862011-09-13 18:31:23 +0000685 IsCopy = (setterKind == ObjCPropertyDecl::Copy);
686 IsAtomic = prop->isAtomic();
John McCallf4528ae2011-09-13 03:34:09 +0000687 HasStrong = false; // doesn't matter here.
688
689 // Evaluate the ivar's size and alignment.
690 ObjCIvarDecl *ivar = propImpl->getPropertyIvarDecl();
691 QualType ivarType = ivar->getType();
Benjamin Kramer867ea1d2014-03-02 13:01:17 +0000692 std::tie(IvarSize, IvarAlignment) =
693 CGM.getContext().getTypeInfoInChars(ivarType);
John McCallf4528ae2011-09-13 03:34:09 +0000694
695 // If we have a copy property, we always have to use getProperty/setProperty.
John McCall43192862011-09-13 18:31:23 +0000696 // TODO: we could actually use setProperty and an expression for non-atomics.
John McCallf4528ae2011-09-13 03:34:09 +0000697 if (IsCopy) {
698 Kind = GetSetProperty;
699 return;
700 }
701
John McCall43192862011-09-13 18:31:23 +0000702 // Handle retain.
703 if (setterKind == ObjCPropertyDecl::Retain) {
John McCallf4528ae2011-09-13 03:34:09 +0000704 // In GC-only, there's nothing special that needs to be done.
David Blaikiebbafb8a2012-03-11 07:00:24 +0000705 if (CGM.getLangOpts().getGC() == LangOptions::GCOnly) {
John McCallf4528ae2011-09-13 03:34:09 +0000706 // fallthrough
707
708 // In ARC, if the property is non-atomic, use expression emission,
709 // which translates to objc_storeStrong. This isn't required, but
710 // it's slightly nicer.
David Blaikiebbafb8a2012-03-11 07:00:24 +0000711 } else if (CGM.getLangOpts().ObjCAutoRefCount && !IsAtomic) {
John McCalld8561f02012-08-20 23:36:59 +0000712 // Using standard expression emission for the setter is only
713 // acceptable if the ivar is __strong, which won't be true if
714 // the property is annotated with __attribute__((NSObject)).
715 // TODO: falling all the way back to objc_setProperty here is
716 // just laziness, though; we could still use objc_storeStrong
717 // if we hacked it right.
718 if (ivarType.getObjCLifetime() == Qualifiers::OCL_Strong)
719 Kind = Expression;
720 else
721 Kind = SetPropertyAndExpressionGet;
John McCallf4528ae2011-09-13 03:34:09 +0000722 return;
723
724 // Otherwise, we need to at least use setProperty. However, if
725 // the property isn't atomic, we can use normal expression
726 // emission for the getter.
727 } else if (!IsAtomic) {
728 Kind = SetPropertyAndExpressionGet;
729 return;
730
731 // Otherwise, we have to use both setProperty and getProperty.
732 } else {
733 Kind = GetSetProperty;
734 return;
735 }
736 }
737
738 // If we're not atomic, just use expression accesses.
739 if (!IsAtomic) {
740 Kind = Expression;
741 return;
742 }
743
John McCall0e5c0862011-09-13 05:36:29 +0000744 // Properties on bitfield ivars need to be emitted using expression
745 // accesses even if they're nominally atomic.
746 if (ivar->isBitField()) {
747 Kind = Expression;
748 return;
749 }
750
John McCallf4528ae2011-09-13 03:34:09 +0000751 // GC-qualified or ARC-qualified ivars need to be emitted as
752 // expressions. This actually works out to being atomic anyway,
753 // except for ARC __strong, but that should trigger the above code.
754 if (ivarType.hasNonTrivialObjCLifetime() ||
David Blaikiebbafb8a2012-03-11 07:00:24 +0000755 (CGM.getLangOpts().getGC() &&
John McCallf4528ae2011-09-13 03:34:09 +0000756 CGM.getContext().getObjCGCAttrKind(ivarType))) {
757 Kind = Expression;
758 return;
759 }
760
761 // Compute whether the ivar has strong members.
David Blaikiebbafb8a2012-03-11 07:00:24 +0000762 if (CGM.getLangOpts().getGC())
John McCallf4528ae2011-09-13 03:34:09 +0000763 if (const RecordType *recordType = ivarType->getAs<RecordType>())
764 HasStrong = recordType->getDecl()->hasObjectMember();
765
766 // We can never access structs with object members with a native
767 // access, because we need to use write barriers. This is what
768 // objc_copyStruct is for.
769 if (HasStrong) {
770 Kind = CopyStruct;
771 return;
772 }
773
774 // Otherwise, this is target-dependent and based on the size and
775 // alignment of the ivar.
John McCall0bef0ba2011-09-13 07:33:34 +0000776
777 // If the size of the ivar is not a power of two, give up. We don't
778 // want to get into the business of doing compare-and-swaps.
779 if (!IvarSize.isPowerOfTwo()) {
780 Kind = CopyStruct;
781 return;
782 }
783
John McCallf4528ae2011-09-13 03:34:09 +0000784 llvm::Triple::ArchType arch =
John McCallc8e01702013-04-16 22:48:15 +0000785 CGM.getTarget().getTriple().getArch();
John McCallf4528ae2011-09-13 03:34:09 +0000786
787 // Most architectures require memory to fit within a single cache
788 // line, so the alignment has to be at least the size of the access.
789 // Otherwise we have to grab a lock.
790 if (IvarAlignment < IvarSize && !hasUnalignedAtomics(arch)) {
791 Kind = CopyStruct;
792 return;
793 }
794
795 // If the ivar's size exceeds the architecture's maximum atomic
796 // access size, we have to use CopyStruct.
797 if (IvarSize > getMaxAtomicAccessSize(CGM, arch)) {
798 Kind = CopyStruct;
799 return;
800 }
801
802 // Otherwise, we can use native loads and stores.
803 Kind = Native;
804}
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000805
James Dennettbe302452012-06-15 22:10:14 +0000806/// \brief Generate an Objective-C property getter function.
807///
808/// The given Decl must be an ObjCImplementationDecl. \@synthesize
Steve Naroff5a7dd782009-01-10 22:55:25 +0000809/// is illegal within a category.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +0000810void CodeGenFunction::GenerateObjCGetter(ObjCImplementationDecl *IMP,
811 const ObjCPropertyImplDecl *PID) {
David Blaikie8e6c36e2014-10-14 16:43:46 +0000812 llvm::Constant *AtomicHelperFn =
813 CodeGenFunction(CGM).GenerateObjCAtomicGetterCopyHelperFunction(PID);
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000814 const ObjCPropertyDecl *PD = PID->getPropertyDecl();
815 ObjCMethodDecl *OMD = PD->getGetterMethodDecl();
816 assert(OMD && "Invalid call to generate getter (empty method)");
David Blaikief1425802015-01-14 00:04:42 +0000817 StartObjCMethod(OMD, IMP->getClassInterface());
Mike Stump11289f42009-09-09 15:08:12 +0000818
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +0000819 generateObjCGetterBody(IMP, PID, OMD, AtomicHelperFn);
John McCallf4528ae2011-09-13 03:34:09 +0000820
821 FinishFunction();
822}
823
John McCallbdd81852011-09-13 06:00:03 +0000824static bool hasTrivialGetExpr(const ObjCPropertyImplDecl *propImpl) {
825 const Expr *getter = propImpl->getGetterCXXConstructor();
John McCallf4528ae2011-09-13 03:34:09 +0000826 if (!getter) return true;
827
828 // Sema only makes only of these when the ivar has a C++ class type,
829 // so the form is pretty constrained.
830
John McCallbdd81852011-09-13 06:00:03 +0000831 // If the property has a reference type, we might just be binding a
832 // reference, in which case the result will be a gl-value. We should
833 // treat this as a non-trivial operation.
834 if (getter->isGLValue())
835 return false;
836
John McCallf4528ae2011-09-13 03:34:09 +0000837 // If we selected a trivial copy-constructor, we're okay.
838 if (const CXXConstructExpr *construct = dyn_cast<CXXConstructExpr>(getter))
839 return (construct->getConstructor()->isTrivial());
840
841 // The constructor might require cleanups (in which case it's never
842 // trivial).
843 assert(isa<ExprWithCleanups>(getter));
844 return false;
845}
846
Fariborz Jahaniana08a7472012-01-10 00:37:01 +0000847/// emitCPPObjectAtomicGetterCall - Call the runtime function to
848/// copy the ivar into the resturn slot.
849static void emitCPPObjectAtomicGetterCall(CodeGenFunction &CGF,
850 llvm::Value *returnAddr,
851 ObjCIvarDecl *ivar,
852 llvm::Constant *AtomicHelperFn) {
853 // objc_copyCppObjectAtomic (&returnSlot, &CppObjectIvar,
854 // AtomicHelperFn);
855 CallArgList args;
856
857 // The 1st argument is the return Slot.
858 args.add(RValue::get(returnAddr), CGF.getContext().VoidPtrTy);
859
860 // The 2nd argument is the address of the ivar.
861 llvm::Value *ivarAddr =
John McCall7f416cc2015-09-08 08:05:57 +0000862 CGF.EmitLValueForIvar(CGF.TypeOfSelfObject(),
863 CGF.LoadObjCSelf(), ivar, 0).getPointer();
Fariborz Jahaniana08a7472012-01-10 00:37:01 +0000864 ivarAddr = CGF.Builder.CreateBitCast(ivarAddr, CGF.Int8PtrTy);
865 args.add(RValue::get(ivarAddr), CGF.getContext().VoidPtrTy);
866
867 // Third argument is the helper function.
868 args.add(RValue::get(AtomicHelperFn), CGF.getContext().VoidPtrTy);
869
John McCallb92ab1a2016-10-26 23:46:34 +0000870 llvm::Constant *copyCppAtomicObjectFn =
David Chisnall0d75e062012-12-17 18:54:24 +0000871 CGF.CGM.getObjCRuntime().GetCppAtomicObjectGetFunction();
John McCallb92ab1a2016-10-26 23:46:34 +0000872 CGCallee callee = CGCallee::forDirect(copyCppAtomicObjectFn);
John McCallc56a8b32016-03-11 04:30:31 +0000873 CGF.EmitCall(
874 CGF.getTypes().arrangeBuiltinFunctionCall(CGF.getContext().VoidTy, args),
John McCallb92ab1a2016-10-26 23:46:34 +0000875 callee, ReturnValueSlot(), args);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +0000876}
877
John McCallf4528ae2011-09-13 03:34:09 +0000878void
879CodeGenFunction::generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +0000880 const ObjCPropertyImplDecl *propImpl,
Fariborz Jahanianb5dd2cb2012-05-29 19:56:01 +0000881 const ObjCMethodDecl *GetterMethodDecl,
Fariborz Jahanian4b501a22012-01-07 18:56:22 +0000882 llvm::Constant *AtomicHelperFn) {
John McCallf4528ae2011-09-13 03:34:09 +0000883 // If there's a non-trivial 'get' expression, we just have to emit that.
884 if (!hasTrivialGetExpr(propImpl)) {
Fariborz Jahaniana08a7472012-01-10 00:37:01 +0000885 if (!AtomicHelperFn) {
886 ReturnStmt ret(SourceLocation(), propImpl->getGetterCXXConstructor(),
Craig Topper8a13c412014-05-21 05:09:00 +0000887 /*nrvo*/ nullptr);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +0000888 EmitReturnStmt(ret);
889 }
890 else {
891 ObjCIvarDecl *ivar = propImpl->getPropertyIvarDecl();
John McCall7f416cc2015-09-08 08:05:57 +0000892 emitCPPObjectAtomicGetterCall(*this, ReturnValue.getPointer(),
Fariborz Jahaniana08a7472012-01-10 00:37:01 +0000893 ivar, AtomicHelperFn);
894 }
John McCallf4528ae2011-09-13 03:34:09 +0000895 return;
896 }
897
898 const ObjCPropertyDecl *prop = propImpl->getPropertyDecl();
899 QualType propType = prop->getType();
900 ObjCMethodDecl *getterMethod = prop->getGetterMethodDecl();
901
902 ObjCIvarDecl *ivar = propImpl->getPropertyIvarDecl();
903
904 // Pick an implementation strategy.
905 PropertyImplStrategy strategy(CGM, propImpl);
906 switch (strategy.getKind()) {
907 case PropertyImplStrategy::Native: {
Eli Friedman0e846022012-10-26 22:38:05 +0000908 // We don't need to do anything for a zero-size struct.
909 if (strategy.getIvarSize().isZero())
910 return;
911
John McCallf4528ae2011-09-13 03:34:09 +0000912 LValue LV = EmitLValueForIvar(TypeOfSelfObject(), LoadObjCSelf(), ivar, 0);
913
914 // Currently, all atomic accesses have to be through integer
915 // types, so there's no point in trying to pick a prettier type.
Akira Hatanakade6f25f2016-05-26 00:37:30 +0000916 uint64_t ivarSize = getContext().toBits(strategy.getIvarSize());
917 llvm::Type *bitcastType = llvm::Type::getIntNTy(getLLVMContext(), ivarSize);
John McCallf4528ae2011-09-13 03:34:09 +0000918 bitcastType = bitcastType->getPointerTo(); // addrspace 0 okay
919
920 // Perform an atomic load. This does not impose ordering constraints.
John McCall7f416cc2015-09-08 08:05:57 +0000921 Address ivarAddr = LV.getAddress();
John McCallf4528ae2011-09-13 03:34:09 +0000922 ivarAddr = Builder.CreateBitCast(ivarAddr, bitcastType);
923 llvm::LoadInst *load = Builder.CreateLoad(ivarAddr, "load");
JF Bastien92f4ef12016-04-06 17:26:42 +0000924 load->setAtomic(llvm::AtomicOrdering::Unordered);
John McCallf4528ae2011-09-13 03:34:09 +0000925
926 // Store that value into the return address. Doing this with a
927 // bitcast is likely to produce some pretty ugly IR, but it's not
928 // the *most* terrible thing in the world.
Akira Hatanakade6f25f2016-05-26 00:37:30 +0000929 llvm::Type *retTy = ConvertType(getterMethod->getReturnType());
930 uint64_t retTySize = CGM.getDataLayout().getTypeSizeInBits(retTy);
931 llvm::Value *ivarVal = load;
932 if (ivarSize > retTySize) {
933 llvm::Type *newTy = llvm::Type::getIntNTy(getLLVMContext(), retTySize);
934 ivarVal = Builder.CreateTrunc(load, newTy);
935 bitcastType = newTy->getPointerTo();
936 }
937 Builder.CreateStore(ivarVal,
938 Builder.CreateBitCast(ReturnValue, bitcastType));
John McCallf4528ae2011-09-13 03:34:09 +0000939
940 // Make sure we don't do an autorelease.
941 AutoreleaseResult = false;
942 return;
943 }
944
945 case PropertyImplStrategy::GetSetProperty: {
John McCallb92ab1a2016-10-26 23:46:34 +0000946 llvm::Constant *getPropertyFn =
John McCallf4528ae2011-09-13 03:34:09 +0000947 CGM.getObjCRuntime().GetPropertyGetFunction();
948 if (!getPropertyFn) {
949 CGM.ErrorUnsupported(propImpl, "Obj-C getter requiring atomic copy");
Daniel Dunbara08dff12008-09-24 04:04:31 +0000950 return;
951 }
John McCallb92ab1a2016-10-26 23:46:34 +0000952 CGCallee callee = CGCallee::forDirect(getPropertyFn);
Daniel Dunbara08dff12008-09-24 04:04:31 +0000953
954 // Return (ivar-type) objc_getProperty((id) self, _cmd, offset, true).
955 // FIXME: Can't this be simpler? This might even be worse than the
956 // corresponding gcc code.
John McCallf4528ae2011-09-13 03:34:09 +0000957 llvm::Value *cmd =
John McCall7f416cc2015-09-08 08:05:57 +0000958 Builder.CreateLoad(GetAddrOfLocalVar(getterMethod->getCmdDecl()), "cmd");
John McCallf4528ae2011-09-13 03:34:09 +0000959 llvm::Value *self = Builder.CreateBitCast(LoadObjCSelf(), VoidPtrTy);
960 llvm::Value *ivarOffset =
961 EmitIvarOffset(classImpl->getClassInterface(), ivar);
962
963 CallArgList args;
964 args.add(RValue::get(self), getContext().getObjCIdType());
965 args.add(RValue::get(cmd), getContext().getObjCSelType());
966 args.add(RValue::get(ivarOffset), getContext().getPointerDiffType());
John McCall43192862011-09-13 18:31:23 +0000967 args.add(RValue::get(Builder.getInt1(strategy.isAtomic())),
968 getContext().BoolTy);
John McCallf4528ae2011-09-13 03:34:09 +0000969
Daniel Dunbar1ef73732009-02-03 23:43:59 +0000970 // FIXME: We shouldn't need to get the function info here, the
971 // runtime already should have computed it to build the function.
Fariborz Jahanian13b43042014-01-30 00:16:39 +0000972 llvm::Instruction *CallInstruction;
Samuel Antao798f11c2015-11-23 22:04:44 +0000973 RValue RV = EmitCall(
John McCallc56a8b32016-03-11 04:30:31 +0000974 getTypes().arrangeBuiltinFunctionCall(propType, args),
John McCallb92ab1a2016-10-26 23:46:34 +0000975 callee, ReturnValueSlot(), args, &CallInstruction);
Fariborz Jahanian13b43042014-01-30 00:16:39 +0000976 if (llvm::CallInst *call = dyn_cast<llvm::CallInst>(CallInstruction))
977 call->setTailCall();
John McCallf4528ae2011-09-13 03:34:09 +0000978
Daniel Dunbara08dff12008-09-24 04:04:31 +0000979 // We need to fix the type here. Ivars with copy & retain are
980 // always objects so we don't need to worry about complex or
981 // aggregates.
Alp Toker314cc812014-01-25 16:55:45 +0000982 RV = RValue::get(Builder.CreateBitCast(
983 RV.getScalarVal(),
984 getTypes().ConvertType(getterMethod->getReturnType())));
John McCallf4528ae2011-09-13 03:34:09 +0000985
986 EmitReturnOfRValue(RV, propType);
John McCall31168b02011-06-15 23:02:42 +0000987
988 // objc_getProperty does an autorelease, so we should suppress ours.
989 AutoreleaseResult = false;
John McCall31168b02011-06-15 23:02:42 +0000990
John McCallf4528ae2011-09-13 03:34:09 +0000991 return;
992 }
993
994 case PropertyImplStrategy::CopyStruct:
995 emitStructGetterCall(*this, ivar, strategy.isAtomic(),
996 strategy.hasStrongMember());
997 return;
998
999 case PropertyImplStrategy::Expression:
1000 case PropertyImplStrategy::SetPropertyAndExpressionGet: {
1001 LValue LV = EmitLValueForIvar(TypeOfSelfObject(), LoadObjCSelf(), ivar, 0);
1002
1003 QualType ivarType = ivar->getType();
John McCall47fb9502013-03-07 21:37:08 +00001004 switch (getEvaluationKind(ivarType)) {
1005 case TEK_Complex: {
Nick Lewycky2d84e842013-10-02 02:29:49 +00001006 ComplexPairTy pair = EmitLoadOfComplex(LV, SourceLocation());
John McCall7f416cc2015-09-08 08:05:57 +00001007 EmitStoreOfComplex(pair, MakeAddrLValue(ReturnValue, ivarType),
John McCall47fb9502013-03-07 21:37:08 +00001008 /*init*/ true);
1009 return;
1010 }
1011 case TEK_Aggregate:
John McCallf4528ae2011-09-13 03:34:09 +00001012 // The return value slot is guaranteed to not be aliased, but
1013 // that's not necessarily the same as "on the stack", so
1014 // we still potentially need objc_memmove_collectable.
Chad Rosier615ed1a2012-03-29 17:37:10 +00001015 EmitAggregateCopy(ReturnValue, LV.getAddress(), ivarType);
John McCall47fb9502013-03-07 21:37:08 +00001016 return;
1017 case TEK_Scalar: {
John McCall24fada12011-07-22 05:23:13 +00001018 llvm::Value *value;
1019 if (propType->isReferenceType()) {
John McCall7f416cc2015-09-08 08:05:57 +00001020 value = LV.getAddress().getPointer();
John McCall24fada12011-07-22 05:23:13 +00001021 } else {
1022 // We want to load and autoreleaseReturnValue ARC __weak ivars.
1023 if (LV.getQuals().getObjCLifetime() == Qualifiers::OCL_Weak) {
John McCall460ce582015-10-22 18:38:17 +00001024 if (getLangOpts().ObjCAutoRefCount) {
1025 value = emitARCRetainLoadOfScalar(*this, LV, ivarType);
1026 } else {
1027 value = EmitARCLoadWeak(LV.getAddress());
1028 }
John McCall24fada12011-07-22 05:23:13 +00001029
1030 // Otherwise we want to do a simple load, suppressing the
1031 // final autorelease.
John McCall31168b02011-06-15 23:02:42 +00001032 } else {
Nick Lewycky2d84e842013-10-02 02:29:49 +00001033 value = EmitLoadOfLValue(LV, SourceLocation()).getScalarVal();
John McCall24fada12011-07-22 05:23:13 +00001034 AutoreleaseResult = false;
Fariborz Jahanianb24b5682011-03-28 23:47:18 +00001035 }
John McCall31168b02011-06-15 23:02:42 +00001036
Alp Toker314cc812014-01-25 16:55:45 +00001037 value = Builder.CreateBitCast(
1038 value, ConvertType(GetterMethodDecl->getReturnType()));
John McCall24fada12011-07-22 05:23:13 +00001039 }
1040
1041 EmitReturnOfRValue(RValue::get(value), propType);
John McCall47fb9502013-03-07 21:37:08 +00001042 return;
Fariborz Jahanianeab5ecd2009-03-03 18:49:40 +00001043 }
John McCall47fb9502013-03-07 21:37:08 +00001044 }
1045 llvm_unreachable("bad evaluation kind");
Daniel Dunbara08dff12008-09-24 04:04:31 +00001046 }
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001047
John McCallf4528ae2011-09-13 03:34:09 +00001048 }
1049 llvm_unreachable("bad @property implementation strategy!");
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001050}
1051
John McCallb923ece2011-09-12 23:06:44 +00001052/// emitStructSetterCall - Call the runtime function to store the value
1053/// from the first formal parameter into the given ivar.
1054static void emitStructSetterCall(CodeGenFunction &CGF, ObjCMethodDecl *OMD,
1055 ObjCIvarDecl *ivar) {
Fariborz Jahanian302a3d42011-02-18 19:15:13 +00001056 // objc_copyStruct (&structIvar, &Arg,
1057 // sizeof (struct something), true, false);
John McCall6acaef92011-09-10 09:30:49 +00001058 CallArgList args;
1059
1060 // The first argument is the address of the ivar.
John McCallb923ece2011-09-12 23:06:44 +00001061 llvm::Value *ivarAddr = CGF.EmitLValueForIvar(CGF.TypeOfSelfObject(),
1062 CGF.LoadObjCSelf(), ivar, 0)
John McCall7f416cc2015-09-08 08:05:57 +00001063 .getPointer();
John McCallb923ece2011-09-12 23:06:44 +00001064 ivarAddr = CGF.Builder.CreateBitCast(ivarAddr, CGF.Int8PtrTy);
1065 args.add(RValue::get(ivarAddr), CGF.getContext().VoidPtrTy);
John McCall6acaef92011-09-10 09:30:49 +00001066
1067 // The second argument is the address of the parameter variable.
John McCallb923ece2011-09-12 23:06:44 +00001068 ParmVarDecl *argVar = *OMD->param_begin();
John McCall113bee02012-03-10 09:33:50 +00001069 DeclRefExpr argRef(argVar, false, argVar->getType().getNonReferenceType(),
Fariborz Jahanian088f1bc2012-01-05 00:10:16 +00001070 VK_LValue, SourceLocation());
John McCall7f416cc2015-09-08 08:05:57 +00001071 llvm::Value *argAddr = CGF.EmitLValue(&argRef).getPointer();
John McCallb923ece2011-09-12 23:06:44 +00001072 argAddr = CGF.Builder.CreateBitCast(argAddr, CGF.Int8PtrTy);
1073 args.add(RValue::get(argAddr), CGF.getContext().VoidPtrTy);
John McCall6acaef92011-09-10 09:30:49 +00001074
1075 // The third argument is the sizeof the type.
1076 llvm::Value *size =
John McCallb923ece2011-09-12 23:06:44 +00001077 CGF.CGM.getSize(CGF.getContext().getTypeSizeInChars(ivar->getType()));
1078 args.add(RValue::get(size), CGF.getContext().getSizeType());
John McCall6acaef92011-09-10 09:30:49 +00001079
John McCallb923ece2011-09-12 23:06:44 +00001080 // The fourth argument is the 'isAtomic' flag.
1081 args.add(RValue::get(CGF.Builder.getTrue()), CGF.getContext().BoolTy);
John McCall6acaef92011-09-10 09:30:49 +00001082
John McCallb923ece2011-09-12 23:06:44 +00001083 // The fifth argument is the 'hasStrong' flag.
1084 // FIXME: should this really always be false?
1085 args.add(RValue::get(CGF.Builder.getFalse()), CGF.getContext().BoolTy);
1086
John McCallb92ab1a2016-10-26 23:46:34 +00001087 llvm::Constant *fn = CGF.CGM.getObjCRuntime().GetSetStructFunction();
1088 CGCallee callee = CGCallee::forDirect(fn);
John McCallc56a8b32016-03-11 04:30:31 +00001089 CGF.EmitCall(
1090 CGF.getTypes().arrangeBuiltinFunctionCall(CGF.getContext().VoidTy, args),
John McCallb92ab1a2016-10-26 23:46:34 +00001091 callee, ReturnValueSlot(), args);
Fariborz Jahanian302a3d42011-02-18 19:15:13 +00001092}
1093
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001094/// emitCPPObjectAtomicSetterCall - Call the runtime function to store
1095/// the value from the first formal parameter into the given ivar, using
1096/// the Cpp API for atomic Cpp objects with non-trivial copy assignment.
1097static void emitCPPObjectAtomicSetterCall(CodeGenFunction &CGF,
1098 ObjCMethodDecl *OMD,
1099 ObjCIvarDecl *ivar,
1100 llvm::Constant *AtomicHelperFn) {
1101 // objc_copyCppObjectAtomic (&CppObjectIvar, &Arg,
1102 // AtomicHelperFn);
1103 CallArgList args;
1104
1105 // The first argument is the address of the ivar.
1106 llvm::Value *ivarAddr =
1107 CGF.EmitLValueForIvar(CGF.TypeOfSelfObject(),
John McCall7f416cc2015-09-08 08:05:57 +00001108 CGF.LoadObjCSelf(), ivar, 0).getPointer();
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001109 ivarAddr = CGF.Builder.CreateBitCast(ivarAddr, CGF.Int8PtrTy);
1110 args.add(RValue::get(ivarAddr), CGF.getContext().VoidPtrTy);
1111
1112 // The second argument is the address of the parameter variable.
1113 ParmVarDecl *argVar = *OMD->param_begin();
John McCall113bee02012-03-10 09:33:50 +00001114 DeclRefExpr argRef(argVar, false, argVar->getType().getNonReferenceType(),
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001115 VK_LValue, SourceLocation());
John McCall7f416cc2015-09-08 08:05:57 +00001116 llvm::Value *argAddr = CGF.EmitLValue(&argRef).getPointer();
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001117 argAddr = CGF.Builder.CreateBitCast(argAddr, CGF.Int8PtrTy);
1118 args.add(RValue::get(argAddr), CGF.getContext().VoidPtrTy);
1119
1120 // Third argument is the helper function.
1121 args.add(RValue::get(AtomicHelperFn), CGF.getContext().VoidPtrTy);
1122
John McCallb92ab1a2016-10-26 23:46:34 +00001123 llvm::Constant *fn =
David Chisnall0d75e062012-12-17 18:54:24 +00001124 CGF.CGM.getObjCRuntime().GetCppAtomicObjectSetFunction();
John McCallb92ab1a2016-10-26 23:46:34 +00001125 CGCallee callee = CGCallee::forDirect(fn);
John McCallc56a8b32016-03-11 04:30:31 +00001126 CGF.EmitCall(
1127 CGF.getTypes().arrangeBuiltinFunctionCall(CGF.getContext().VoidTy, args),
John McCallb92ab1a2016-10-26 23:46:34 +00001128 callee, ReturnValueSlot(), args);
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001129}
1130
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00001131
John McCallf4528ae2011-09-13 03:34:09 +00001132static bool hasTrivialSetExpr(const ObjCPropertyImplDecl *PID) {
1133 Expr *setter = PID->getSetterCXXAssignment();
1134 if (!setter) return true;
1135
1136 // Sema only makes only of these when the ivar has a C++ class type,
1137 // so the form is pretty constrained.
John McCall7f16c422011-09-10 09:17:20 +00001138
1139 // An operator call is trivial if the function it calls is trivial.
John McCallf4528ae2011-09-13 03:34:09 +00001140 // This also implies that there's nothing non-trivial going on with
1141 // the arguments, because operator= can only be trivial if it's a
1142 // synthesized assignment operator and therefore both parameters are
1143 // references.
1144 if (CallExpr *call = dyn_cast<CallExpr>(setter)) {
John McCall7f16c422011-09-10 09:17:20 +00001145 if (const FunctionDecl *callee
1146 = dyn_cast_or_null<FunctionDecl>(call->getCalleeDecl()))
1147 if (callee->isTrivial())
1148 return true;
1149 return false;
Fariborz Jahanian5de53132011-04-06 16:05:26 +00001150 }
John McCall7f16c422011-09-10 09:17:20 +00001151
John McCallf4528ae2011-09-13 03:34:09 +00001152 assert(isa<ExprWithCleanups>(setter));
John McCall7f16c422011-09-10 09:17:20 +00001153 return false;
1154}
1155
Benjamin Kramer53ba6362012-03-10 20:38:56 +00001156static bool UseOptimizedSetter(CodeGenModule &CGM) {
David Blaikiebbafb8a2012-03-11 07:00:24 +00001157 if (CGM.getLangOpts().getGC() != LangOptions::NonGC)
Ted Kremeneke65b0862012-03-06 20:05:56 +00001158 return false;
Daniel Dunbarbd847cc2012-10-15 22:23:53 +00001159 return CGM.getLangOpts().ObjCRuntime.hasOptimizedSetter();
Ted Kremeneke65b0862012-03-06 20:05:56 +00001160}
1161
John McCall7f16c422011-09-10 09:17:20 +00001162void
1163CodeGenFunction::generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001164 const ObjCPropertyImplDecl *propImpl,
1165 llvm::Constant *AtomicHelperFn) {
John McCall7f16c422011-09-10 09:17:20 +00001166 const ObjCPropertyDecl *prop = propImpl->getPropertyDecl();
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00001167 ObjCIvarDecl *ivar = propImpl->getPropertyIvarDecl();
John McCall7f16c422011-09-10 09:17:20 +00001168 ObjCMethodDecl *setterMethod = prop->getSetterMethodDecl();
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001169
1170 // Just use the setter expression if Sema gave us one and it's
1171 // non-trivial.
1172 if (!hasTrivialSetExpr(propImpl)) {
1173 if (!AtomicHelperFn)
1174 // If non-atomic, assignment is called directly.
1175 EmitStmt(propImpl->getSetterCXXAssignment());
1176 else
1177 // If atomic, assignment is called via a locking api.
1178 emitCPPObjectAtomicSetterCall(*this, setterMethod, ivar,
1179 AtomicHelperFn);
1180 return;
1181 }
John McCall7f16c422011-09-10 09:17:20 +00001182
John McCallf4528ae2011-09-13 03:34:09 +00001183 PropertyImplStrategy strategy(CGM, propImpl);
1184 switch (strategy.getKind()) {
1185 case PropertyImplStrategy::Native: {
Eli Friedman0e846022012-10-26 22:38:05 +00001186 // We don't need to do anything for a zero-size struct.
1187 if (strategy.getIvarSize().isZero())
1188 return;
1189
John McCall7f416cc2015-09-08 08:05:57 +00001190 Address argAddr = GetAddrOfLocalVar(*setterMethod->param_begin());
John McCall7f16c422011-09-10 09:17:20 +00001191
John McCallf4528ae2011-09-13 03:34:09 +00001192 LValue ivarLValue =
1193 EmitLValueForIvar(TypeOfSelfObject(), LoadObjCSelf(), ivar, /*quals*/ 0);
John McCall7f416cc2015-09-08 08:05:57 +00001194 Address ivarAddr = ivarLValue.getAddress();
John McCall7f16c422011-09-10 09:17:20 +00001195
John McCallf4528ae2011-09-13 03:34:09 +00001196 // Currently, all atomic accesses have to be through integer
1197 // types, so there's no point in trying to pick a prettier type.
1198 llvm::Type *bitcastType =
1199 llvm::Type::getIntNTy(getLLVMContext(),
1200 getContext().toBits(strategy.getIvarSize()));
John McCallf4528ae2011-09-13 03:34:09 +00001201
1202 // Cast both arguments to the chosen operation type.
John McCall7f416cc2015-09-08 08:05:57 +00001203 argAddr = Builder.CreateElementBitCast(argAddr, bitcastType);
1204 ivarAddr = Builder.CreateElementBitCast(ivarAddr, bitcastType);
John McCallf4528ae2011-09-13 03:34:09 +00001205
1206 // This bitcast load is likely to cause some nasty IR.
1207 llvm::Value *load = Builder.CreateLoad(argAddr);
1208
1209 // Perform an atomic store. There are no memory ordering requirements.
1210 llvm::StoreInst *store = Builder.CreateStore(load, ivarAddr);
JF Bastien92f4ef12016-04-06 17:26:42 +00001211 store->setAtomic(llvm::AtomicOrdering::Unordered);
John McCallf4528ae2011-09-13 03:34:09 +00001212 return;
1213 }
1214
1215 case PropertyImplStrategy::GetSetProperty:
1216 case PropertyImplStrategy::SetPropertyAndExpressionGet: {
Craig Topper8a13c412014-05-21 05:09:00 +00001217
John McCallb92ab1a2016-10-26 23:46:34 +00001218 llvm::Constant *setOptimizedPropertyFn = nullptr;
1219 llvm::Constant *setPropertyFn = nullptr;
Ted Kremeneke65b0862012-03-06 20:05:56 +00001220 if (UseOptimizedSetter(CGM)) {
Daniel Dunbarbd847cc2012-10-15 22:23:53 +00001221 // 10.8 and iOS 6.0 code and GC is off
Ted Kremeneke65b0862012-03-06 20:05:56 +00001222 setOptimizedPropertyFn =
Eric Christopher5d2b8d92012-03-29 17:31:31 +00001223 CGM.getObjCRuntime()
1224 .GetOptimizedPropertySetFunction(strategy.isAtomic(),
1225 strategy.isCopy());
Ted Kremeneke65b0862012-03-06 20:05:56 +00001226 if (!setOptimizedPropertyFn) {
1227 CGM.ErrorUnsupported(propImpl, "Obj-C optimized setter - NYI");
1228 return;
1229 }
John McCall7f16c422011-09-10 09:17:20 +00001230 }
Ted Kremeneke65b0862012-03-06 20:05:56 +00001231 else {
1232 setPropertyFn = CGM.getObjCRuntime().GetPropertySetFunction();
1233 if (!setPropertyFn) {
1234 CGM.ErrorUnsupported(propImpl, "Obj-C setter requiring atomic copy");
1235 return;
1236 }
1237 }
1238
John McCall7f16c422011-09-10 09:17:20 +00001239 // Emit objc_setProperty((id) self, _cmd, offset, arg,
1240 // <is-atomic>, <is-copy>).
1241 llvm::Value *cmd =
John McCall7f416cc2015-09-08 08:05:57 +00001242 Builder.CreateLoad(GetAddrOfLocalVar(setterMethod->getCmdDecl()));
John McCall7f16c422011-09-10 09:17:20 +00001243 llvm::Value *self =
1244 Builder.CreateBitCast(LoadObjCSelf(), VoidPtrTy);
1245 llvm::Value *ivarOffset =
1246 EmitIvarOffset(classImpl->getClassInterface(), ivar);
John McCall7f416cc2015-09-08 08:05:57 +00001247 Address argAddr = GetAddrOfLocalVar(*setterMethod->param_begin());
1248 llvm::Value *arg = Builder.CreateLoad(argAddr, "arg");
1249 arg = Builder.CreateBitCast(arg, VoidPtrTy);
John McCall7f16c422011-09-10 09:17:20 +00001250
1251 CallArgList args;
1252 args.add(RValue::get(self), getContext().getObjCIdType());
1253 args.add(RValue::get(cmd), getContext().getObjCSelType());
Ted Kremeneke65b0862012-03-06 20:05:56 +00001254 if (setOptimizedPropertyFn) {
1255 args.add(RValue::get(arg), getContext().getObjCIdType());
1256 args.add(RValue::get(ivarOffset), getContext().getPointerDiffType());
John McCallb92ab1a2016-10-26 23:46:34 +00001257 CGCallee callee = CGCallee::forDirect(setOptimizedPropertyFn);
John McCallc56a8b32016-03-11 04:30:31 +00001258 EmitCall(getTypes().arrangeBuiltinFunctionCall(getContext().VoidTy, args),
John McCallb92ab1a2016-10-26 23:46:34 +00001259 callee, ReturnValueSlot(), args);
Ted Kremeneke65b0862012-03-06 20:05:56 +00001260 } else {
1261 args.add(RValue::get(ivarOffset), getContext().getPointerDiffType());
1262 args.add(RValue::get(arg), getContext().getObjCIdType());
1263 args.add(RValue::get(Builder.getInt1(strategy.isAtomic())),
1264 getContext().BoolTy);
1265 args.add(RValue::get(Builder.getInt1(strategy.isCopy())),
1266 getContext().BoolTy);
1267 // FIXME: We shouldn't need to get the function info here, the runtime
1268 // already should have computed it to build the function.
John McCallb92ab1a2016-10-26 23:46:34 +00001269 CGCallee callee = CGCallee::forDirect(setPropertyFn);
John McCallc56a8b32016-03-11 04:30:31 +00001270 EmitCall(getTypes().arrangeBuiltinFunctionCall(getContext().VoidTy, args),
John McCallb92ab1a2016-10-26 23:46:34 +00001271 callee, ReturnValueSlot(), args);
Ted Kremeneke65b0862012-03-06 20:05:56 +00001272 }
1273
John McCall7f16c422011-09-10 09:17:20 +00001274 return;
1275 }
1276
John McCallf4528ae2011-09-13 03:34:09 +00001277 case PropertyImplStrategy::CopyStruct:
John McCallb923ece2011-09-12 23:06:44 +00001278 emitStructSetterCall(*this, setterMethod, ivar);
John McCall7f16c422011-09-10 09:17:20 +00001279 return;
John McCallf4528ae2011-09-13 03:34:09 +00001280
1281 case PropertyImplStrategy::Expression:
1282 break;
John McCall7f16c422011-09-10 09:17:20 +00001283 }
1284
1285 // Otherwise, fake up some ASTs and emit a normal assignment.
1286 ValueDecl *selfDecl = setterMethod->getSelfDecl();
John McCall113bee02012-03-10 09:33:50 +00001287 DeclRefExpr self(selfDecl, false, selfDecl->getType(),
1288 VK_LValue, SourceLocation());
John McCall7f16c422011-09-10 09:17:20 +00001289 ImplicitCastExpr selfLoad(ImplicitCastExpr::OnStack,
1290 selfDecl->getType(), CK_LValueToRValue, &self,
1291 VK_RValue);
1292 ObjCIvarRefExpr ivarRef(ivar, ivar->getType().getNonReferenceType(),
Fariborz Jahanianf12ff4df2013-04-02 18:57:54 +00001293 SourceLocation(), SourceLocation(),
1294 &selfLoad, true, true);
John McCall7f16c422011-09-10 09:17:20 +00001295
1296 ParmVarDecl *argDecl = *setterMethod->param_begin();
1297 QualType argType = argDecl->getType().getNonReferenceType();
John McCall113bee02012-03-10 09:33:50 +00001298 DeclRefExpr arg(argDecl, false, argType, VK_LValue, SourceLocation());
John McCall7f16c422011-09-10 09:17:20 +00001299 ImplicitCastExpr argLoad(ImplicitCastExpr::OnStack,
1300 argType.getUnqualifiedType(), CK_LValueToRValue,
1301 &arg, VK_RValue);
1302
1303 // The property type can differ from the ivar type in some situations with
1304 // Objective-C pointer types, we can always bit cast the RHS in these cases.
1305 // The following absurdity is just to ensure well-formed IR.
1306 CastKind argCK = CK_NoOp;
1307 if (ivarRef.getType()->isObjCObjectPointerType()) {
1308 if (argLoad.getType()->isObjCObjectPointerType())
1309 argCK = CK_BitCast;
1310 else if (argLoad.getType()->isBlockPointerType())
1311 argCK = CK_BlockPointerToObjCPointerCast;
1312 else
1313 argCK = CK_CPointerToObjCPointerCast;
1314 } else if (ivarRef.getType()->isBlockPointerType()) {
1315 if (argLoad.getType()->isBlockPointerType())
1316 argCK = CK_BitCast;
1317 else
1318 argCK = CK_AnyPointerToBlockPointerCast;
1319 } else if (ivarRef.getType()->isPointerType()) {
1320 argCK = CK_BitCast;
1321 }
1322 ImplicitCastExpr argCast(ImplicitCastExpr::OnStack,
1323 ivarRef.getType(), argCK, &argLoad,
1324 VK_RValue);
1325 Expr *finalArg = &argLoad;
1326 if (!getContext().hasSameUnqualifiedType(ivarRef.getType(),
1327 argLoad.getType()))
1328 finalArg = &argCast;
1329
1330
1331 BinaryOperator assign(&ivarRef, finalArg, BO_Assign,
1332 ivarRef.getType(), VK_RValue, OK_Ordinary,
Adam Nemet484aa452017-03-27 19:17:25 +00001333 SourceLocation(), FPOptions());
John McCall7f16c422011-09-10 09:17:20 +00001334 EmitStmt(&assign);
Fariborz Jahanian5de53132011-04-06 16:05:26 +00001335}
1336
James Dennettbe302452012-06-15 22:10:14 +00001337/// \brief Generate an Objective-C property setter function.
1338///
1339/// The given Decl must be an ObjCImplementationDecl. \@synthesize
Steve Naroff5a7dd782009-01-10 22:55:25 +00001340/// is illegal within a category.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +00001341void CodeGenFunction::GenerateObjCSetter(ObjCImplementationDecl *IMP,
1342 const ObjCPropertyImplDecl *PID) {
David Blaikie8e6c36e2014-10-14 16:43:46 +00001343 llvm::Constant *AtomicHelperFn =
1344 CodeGenFunction(CGM).GenerateObjCAtomicSetterCopyHelperFunction(PID);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001345 const ObjCPropertyDecl *PD = PID->getPropertyDecl();
1346 ObjCMethodDecl *OMD = PD->getSetterMethodDecl();
1347 assert(OMD && "Invalid call to generate setter (empty method)");
David Blaikief1425802015-01-14 00:04:42 +00001348 StartObjCMethod(OMD, IMP->getClassInterface());
Daniel Dunbar5449ce52008-09-24 06:32:09 +00001349
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00001350 generateObjCSetterBody(IMP, PID, AtomicHelperFn);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001351
1352 FinishFunction();
Chris Lattner5696e7b2008-06-17 18:05:57 +00001353}
1354
John McCall6a4fa522011-03-22 07:05:39 +00001355namespace {
David Blaikie7e70d682015-08-18 22:40:54 +00001356 struct DestroyIvar final : EHScopeStack::Cleanup {
John McCall4bd0fb12011-07-12 16:41:08 +00001357 private:
1358 llvm::Value *addr;
John McCall6a4fa522011-03-22 07:05:39 +00001359 const ObjCIvarDecl *ivar;
Peter Collingbourne1425b452012-01-26 03:33:36 +00001360 CodeGenFunction::Destroyer *destroyer;
John McCall4bd0fb12011-07-12 16:41:08 +00001361 bool useEHCleanupForArray;
1362 public:
1363 DestroyIvar(llvm::Value *addr, const ObjCIvarDecl *ivar,
1364 CodeGenFunction::Destroyer *destroyer,
1365 bool useEHCleanupForArray)
Peter Collingbourne1425b452012-01-26 03:33:36 +00001366 : addr(addr), ivar(ivar), destroyer(destroyer),
John McCall4bd0fb12011-07-12 16:41:08 +00001367 useEHCleanupForArray(useEHCleanupForArray) {}
John McCall6a4fa522011-03-22 07:05:39 +00001368
Craig Topper4f12f102014-03-12 06:41:41 +00001369 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall4bd0fb12011-07-12 16:41:08 +00001370 LValue lvalue
1371 = CGF.EmitLValueForIvar(CGF.TypeOfSelfObject(), addr, ivar, /*CVR*/ 0);
1372 CGF.emitDestroy(lvalue.getAddress(), ivar->getType(), destroyer,
John McCall30317fd2011-07-12 20:27:29 +00001373 flags.isForNormalCleanup() && useEHCleanupForArray);
John McCall6a4fa522011-03-22 07:05:39 +00001374 }
1375 };
Alexander Kornienkoab9db512015-06-22 23:07:51 +00001376}
John McCall6a4fa522011-03-22 07:05:39 +00001377
John McCall4bd0fb12011-07-12 16:41:08 +00001378/// Like CodeGenFunction::destroyARCStrong, but do it with a call.
1379static void destroyARCStrongWithStore(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001380 Address addr,
John McCall4bd0fb12011-07-12 16:41:08 +00001381 QualType type) {
1382 llvm::Value *null = getNullForVariable(addr);
1383 CGF.EmitARCStoreStrongCall(addr, null, /*ignored*/ true);
1384}
John McCall31168b02011-06-15 23:02:42 +00001385
John McCall6a4fa522011-03-22 07:05:39 +00001386static void emitCXXDestructMethod(CodeGenFunction &CGF,
1387 ObjCImplementationDecl *impl) {
1388 CodeGenFunction::RunCleanupsScope scope(CGF);
1389
1390 llvm::Value *self = CGF.LoadObjCSelf();
1391
Jordy Rosea91768e2011-07-22 02:08:32 +00001392 const ObjCInterfaceDecl *iface = impl->getClassInterface();
1393 for (const ObjCIvarDecl *ivar = iface->all_declared_ivar_begin();
John McCall6a4fa522011-03-22 07:05:39 +00001394 ivar; ivar = ivar->getNextIvar()) {
1395 QualType type = ivar->getType();
1396
John McCall6a4fa522011-03-22 07:05:39 +00001397 // Check whether the ivar is a destructible type.
John McCall4bd0fb12011-07-12 16:41:08 +00001398 QualType::DestructionKind dtorKind = type.isDestructedType();
1399 if (!dtorKind) continue;
John McCall6a4fa522011-03-22 07:05:39 +00001400
Craig Topper8a13c412014-05-21 05:09:00 +00001401 CodeGenFunction::Destroyer *destroyer = nullptr;
John McCall6a4fa522011-03-22 07:05:39 +00001402
John McCall4bd0fb12011-07-12 16:41:08 +00001403 // Use a call to objc_storeStrong to destroy strong ivars, for the
1404 // general benefit of the tools.
1405 if (dtorKind == QualType::DK_objc_strong_lifetime) {
Peter Collingbourne1425b452012-01-26 03:33:36 +00001406 destroyer = destroyARCStrongWithStore;
John McCall31168b02011-06-15 23:02:42 +00001407
John McCall4bd0fb12011-07-12 16:41:08 +00001408 // Otherwise use the default for the destruction kind.
1409 } else {
Peter Collingbourne1425b452012-01-26 03:33:36 +00001410 destroyer = CGF.getDestroyer(dtorKind);
John McCall6a4fa522011-03-22 07:05:39 +00001411 }
John McCall4bd0fb12011-07-12 16:41:08 +00001412
1413 CleanupKind cleanupKind = CGF.getCleanupKind(dtorKind);
1414
1415 CGF.EHStack.pushCleanup<DestroyIvar>(cleanupKind, self, ivar, destroyer,
1416 cleanupKind & EHCleanup);
John McCall6a4fa522011-03-22 07:05:39 +00001417 }
1418
1419 assert(scope.requiresCleanups() && "nothing to do in .cxx_destruct?");
1420}
1421
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001422void CodeGenFunction::GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1423 ObjCMethodDecl *MD,
1424 bool ctor) {
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001425 MD->createImplicitParams(CGM.getContext(), IMP->getClassInterface());
David Blaikief1425802015-01-14 00:04:42 +00001426 StartObjCMethod(MD, IMP->getClassInterface());
John McCall6a4fa522011-03-22 07:05:39 +00001427
1428 // Emit .cxx_construct.
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001429 if (ctor) {
John McCall31168b02011-06-15 23:02:42 +00001430 // Suppress the final autorelease in ARC.
1431 AutoreleaseResult = false;
1432
Aaron Ballman9bc5f362014-03-13 17:35:02 +00001433 for (const auto *IvarInit : IMP->inits()) {
Francois Pichetd583da02010-12-04 09:14:42 +00001434 FieldDecl *Field = IvarInit->getAnyMember();
Aaron Ballman9bc5f362014-03-13 17:35:02 +00001435 ObjCIvarDecl *Ivar = cast<ObjCIvarDecl>(Field);
Fariborz Jahanian499b9022010-04-28 22:30:33 +00001436 LValue LV = EmitLValueForIvar(TypeOfSelfObject(),
1437 LoadObjCSelf(), Ivar, 0);
John McCall8d6fc952011-08-25 20:40:09 +00001438 EmitAggExpr(IvarInit->getInit(),
1439 AggValueSlot::forLValue(LV, AggValueSlot::IsDestructed,
John McCalla5efa732011-08-25 23:04:34 +00001440 AggValueSlot::DoesNotNeedGCBarriers,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001441 AggValueSlot::IsNotAliased));
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001442 }
1443 // constructor returns 'self'.
1444 CodeGenTypes &Types = CGM.getTypes();
1445 QualType IdTy(CGM.getContext().getObjCIdType());
1446 llvm::Value *SelfAsId =
1447 Builder.CreateBitCast(LoadObjCSelf(), Types.ConvertType(IdTy));
1448 EmitReturnOfRValue(RValue::get(SelfAsId), IdTy);
John McCall6a4fa522011-03-22 07:05:39 +00001449
1450 // Emit .cxx_destruct.
Chandler Carruthf3983652010-05-06 00:20:39 +00001451 } else {
John McCall6a4fa522011-03-22 07:05:39 +00001452 emitCXXDestructMethod(*this, IMP);
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001453 }
1454 FinishFunction();
1455}
1456
Daniel Dunbara08dff12008-09-24 04:04:31 +00001457llvm::Value *CodeGenFunction::LoadObjCSelf() {
John McCalldec348f72013-05-03 07:33:41 +00001458 VarDecl *Self = cast<ObjCMethodDecl>(CurFuncDecl)->getSelfDecl();
1459 DeclRefExpr DRE(Self, /*is enclosing local*/ (CurFuncDecl != CurCodeDecl),
1460 Self->getType(), VK_LValue, SourceLocation());
Nick Lewycky2d84e842013-10-02 02:29:49 +00001461 return EmitLoadOfScalar(EmitDeclRefLValue(&DRE), SourceLocation());
Chris Lattner5696e7b2008-06-17 18:05:57 +00001462}
1463
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00001464QualType CodeGenFunction::TypeOfSelfObject() {
1465 const ObjCMethodDecl *OMD = cast<ObjCMethodDecl>(CurFuncDecl);
1466 ImplicitParamDecl *selfDecl = OMD->getSelfDecl();
Steve Naroff7cae42b2009-07-10 23:34:53 +00001467 const ObjCObjectPointerType *PTy = cast<ObjCObjectPointerType>(
1468 getContext().getCanonicalType(selfDecl->getType()));
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00001469 return PTy->getPointeeType();
1470}
1471
Chris Lattnerd4808922009-03-22 21:03:39 +00001472void CodeGenFunction::EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S){
John McCallb92ab1a2016-10-26 23:46:34 +00001473 llvm::Constant *EnumerationMutationFnPtr =
Daniel Dunbara08dff12008-09-24 04:04:31 +00001474 CGM.getObjCRuntime().EnumerationMutationFunction();
John McCallb92ab1a2016-10-26 23:46:34 +00001475 if (!EnumerationMutationFnPtr) {
Daniel Dunbara08dff12008-09-24 04:04:31 +00001476 CGM.ErrorUnsupported(&S, "Obj-C fast enumeration for this runtime");
1477 return;
1478 }
John McCallb92ab1a2016-10-26 23:46:34 +00001479 CGCallee EnumerationMutationFn =
1480 CGCallee::forDirect(EnumerationMutationFnPtr);
Daniel Dunbara08dff12008-09-24 04:04:31 +00001481
Devang Pateld2d66652011-01-19 01:36:36 +00001482 CGDebugInfo *DI = getDebugInfo();
Eric Christopher7cdf9482011-10-13 21:45:18 +00001483 if (DI)
1484 DI->EmitLexicalBlockStart(Builder, S.getSourceRange().getBegin());
Devang Pateld2d66652011-01-19 01:36:36 +00001485
Kuba Mracek5e5e4e72017-04-14 16:53:25 +00001486 RunCleanupsScope ForScope(*this);
1487
Kuba Mracek82c21752017-04-14 01:00:03 +00001488 // The local variable comes into scope immediately.
1489 AutoVarEmission variable = AutoVarEmission::invalid();
1490 if (const DeclStmt *SD = dyn_cast<DeclStmt>(S.getElement()))
1491 variable = EmitAutoVarAlloca(*cast<VarDecl>(SD->getSingleDecl()));
1492
John McCall1c926b72011-01-07 01:49:06 +00001493 JumpDest LoopEnd = getJumpDestInCurrentScope("forcoll.end");
Mike Stump11289f42009-09-09 15:08:12 +00001494
Anders Carlsson75658592008-08-31 02:33:12 +00001495 // Fast enumeration state.
Douglas Gregor636e2002011-08-09 17:23:49 +00001496 QualType StateTy = CGM.getObjCFastEnumerationStateType();
John McCall7f416cc2015-09-08 08:05:57 +00001497 Address StatePtr = CreateMemTemp(StateTy, "state.ptr");
Anders Carlssonc0964b62010-05-22 17:35:42 +00001498 EmitNullInitialization(StatePtr, StateTy);
Mike Stump11289f42009-09-09 15:08:12 +00001499
Anders Carlsson75658592008-08-31 02:33:12 +00001500 // Number of elements in the items array.
Anders Carlsson3f35a262008-08-31 04:05:03 +00001501 static const unsigned NumItems = 16;
Mike Stump11289f42009-09-09 15:08:12 +00001502
John McCall1c926b72011-01-07 01:49:06 +00001503 // Fetch the countByEnumeratingWithState:objects:count: selector.
Benjamin Kramer9e649c32010-03-30 11:36:44 +00001504 IdentifierInfo *II[] = {
1505 &CGM.getContext().Idents.get("countByEnumeratingWithState"),
1506 &CGM.getContext().Idents.get("objects"),
1507 &CGM.getContext().Idents.get("count")
1508 };
1509 Selector FastEnumSel =
1510 CGM.getContext().Selectors.getSelector(llvm::array_lengthof(II), &II[0]);
Anders Carlsson75658592008-08-31 02:33:12 +00001511
1512 QualType ItemsTy =
1513 getContext().getConstantArrayType(getContext().getObjCIdType(),
Mike Stump11289f42009-09-09 15:08:12 +00001514 llvm::APInt(32, NumItems),
Anders Carlsson75658592008-08-31 02:33:12 +00001515 ArrayType::Normal, 0);
John McCall7f416cc2015-09-08 08:05:57 +00001516 Address ItemsPtr = CreateMemTemp(ItemsTy, "items.ptr");
Mike Stump11289f42009-09-09 15:08:12 +00001517
John McCall53848232011-07-27 01:07:15 +00001518 // Emit the collection pointer. In ARC, we do a retain.
1519 llvm::Value *Collection;
David Blaikiebbafb8a2012-03-11 07:00:24 +00001520 if (getLangOpts().ObjCAutoRefCount) {
John McCall53848232011-07-27 01:07:15 +00001521 Collection = EmitARCRetainScalarExpr(S.getCollection());
1522
1523 // Enter a cleanup to do the release.
1524 EmitObjCConsumeObject(S.getCollection()->getType(), Collection);
1525 } else {
1526 Collection = EmitScalarExpr(S.getCollection());
1527 }
Mike Stump11289f42009-09-09 15:08:12 +00001528
John McCall91e82dd2011-08-05 00:14:38 +00001529 // The 'continue' label needs to appear within the cleanup for the
1530 // collection object.
1531 JumpDest AfterBody = getJumpDestInCurrentScope("forcoll.next");
1532
John McCall1c926b72011-01-07 01:49:06 +00001533 // Send it our message:
Anders Carlsson75658592008-08-31 02:33:12 +00001534 CallArgList Args;
John McCall1c926b72011-01-07 01:49:06 +00001535
1536 // The first argument is a temporary of the enumeration-state type.
John McCall7f416cc2015-09-08 08:05:57 +00001537 Args.add(RValue::get(StatePtr.getPointer()),
1538 getContext().getPointerType(StateTy));
Mike Stump11289f42009-09-09 15:08:12 +00001539
John McCall1c926b72011-01-07 01:49:06 +00001540 // The second argument is a temporary array with space for NumItems
1541 // pointers. We'll actually be loading elements from the array
1542 // pointer written into the control state; this buffer is so that
1543 // collections that *aren't* backed by arrays can still queue up
1544 // batches of elements.
John McCall7f416cc2015-09-08 08:05:57 +00001545 Args.add(RValue::get(ItemsPtr.getPointer()),
1546 getContext().getPointerType(ItemsTy));
Mike Stump11289f42009-09-09 15:08:12 +00001547
John McCall1c926b72011-01-07 01:49:06 +00001548 // The third argument is the capacity of that temporary array.
Chris Lattner2192fe52011-07-18 04:24:23 +00001549 llvm::Type *UnsignedLongLTy = ConvertType(getContext().UnsignedLongTy);
Owen Andersonb7a2fe62009-07-24 23:12:58 +00001550 llvm::Constant *Count = llvm::ConstantInt::get(UnsignedLongLTy, NumItems);
Eli Friedman43dca6a2011-05-02 17:57:46 +00001551 Args.add(RValue::get(Count), getContext().UnsignedLongTy);
Mike Stump11289f42009-09-09 15:08:12 +00001552
John McCall1c926b72011-01-07 01:49:06 +00001553 // Start the enumeration.
Mike Stump11289f42009-09-09 15:08:12 +00001554 RValue CountRV =
John McCall78a15112010-05-22 01:48:05 +00001555 CGM.getObjCRuntime().GenerateMessageSend(*this, ReturnValueSlot(),
Anders Carlsson75658592008-08-31 02:33:12 +00001556 getContext().UnsignedLongTy,
1557 FastEnumSel,
David Chisnall01aa4672010-04-28 19:33:36 +00001558 Collection, Args);
Anders Carlsson75658592008-08-31 02:33:12 +00001559
John McCall1c926b72011-01-07 01:49:06 +00001560 // The initial number of objects that were returned in the buffer.
1561 llvm::Value *initialBufferLimit = CountRV.getScalarVal();
Mike Stump11289f42009-09-09 15:08:12 +00001562
John McCall1c926b72011-01-07 01:49:06 +00001563 llvm::BasicBlock *EmptyBB = createBasicBlock("forcoll.empty");
1564 llvm::BasicBlock *LoopInitBB = createBasicBlock("forcoll.loopinit");
Mike Stump11289f42009-09-09 15:08:12 +00001565
John McCall1c926b72011-01-07 01:49:06 +00001566 llvm::Value *zero = llvm::Constant::getNullValue(UnsignedLongLTy);
Anders Carlsson75658592008-08-31 02:33:12 +00001567
John McCall1c926b72011-01-07 01:49:06 +00001568 // If the limit pointer was zero to begin with, the collection is
Bob Wilson0ed74d92014-03-25 23:26:31 +00001569 // empty; skip all this. Set the branch weight assuming this has the same
1570 // probability of exiting the loop as any other loop exit.
Justin Bogner66242d62015-04-23 23:06:47 +00001571 uint64_t EntryCount = getCurrentProfileCount();
1572 Builder.CreateCondBr(
1573 Builder.CreateICmpEQ(initialBufferLimit, zero, "iszero"), EmptyBB,
1574 LoopInitBB,
Justin Bogner65512642015-05-02 05:00:55 +00001575 createProfileWeights(EntryCount, getProfileCount(S.getBody())));
Anders Carlsson75658592008-08-31 02:33:12 +00001576
John McCall1c926b72011-01-07 01:49:06 +00001577 // Otherwise, initialize the loop.
1578 EmitBlock(LoopInitBB);
Mike Stump11289f42009-09-09 15:08:12 +00001579
John McCall1c926b72011-01-07 01:49:06 +00001580 // Save the initial mutations value. This is the value at an
1581 // address that was written into the state object by
1582 // countByEnumeratingWithState:objects:count:.
John McCall7f416cc2015-09-08 08:05:57 +00001583 Address StateMutationsPtrPtr = Builder.CreateStructGEP(
1584 StatePtr, 2, 2 * getPointerSize(), "mutationsptr.ptr");
1585 llvm::Value *StateMutationsPtr
1586 = Builder.CreateLoad(StateMutationsPtrPtr, "mutationsptr");
Mike Stump11289f42009-09-09 15:08:12 +00001587
John McCall1c926b72011-01-07 01:49:06 +00001588 llvm::Value *initialMutations =
John McCall7f416cc2015-09-08 08:05:57 +00001589 Builder.CreateAlignedLoad(StateMutationsPtr, getPointerAlign(),
1590 "forcoll.initial-mutations");
Mike Stump11289f42009-09-09 15:08:12 +00001591
John McCall1c926b72011-01-07 01:49:06 +00001592 // Start looping. This is the point we return to whenever we have a
1593 // fresh, non-empty batch of objects.
1594 llvm::BasicBlock *LoopBodyBB = createBasicBlock("forcoll.loopbody");
1595 EmitBlock(LoopBodyBB);
Mike Stump11289f42009-09-09 15:08:12 +00001596
John McCall1c926b72011-01-07 01:49:06 +00001597 // The current index into the buffer.
Jay Foad20c0f022011-03-30 11:28:58 +00001598 llvm::PHINode *index = Builder.CreatePHI(UnsignedLongLTy, 3, "forcoll.index");
John McCall1c926b72011-01-07 01:49:06 +00001599 index->addIncoming(zero, LoopInitBB);
Anders Carlsson75658592008-08-31 02:33:12 +00001600
John McCall1c926b72011-01-07 01:49:06 +00001601 // The current buffer size.
Jay Foad20c0f022011-03-30 11:28:58 +00001602 llvm::PHINode *count = Builder.CreatePHI(UnsignedLongLTy, 3, "forcoll.count");
John McCall1c926b72011-01-07 01:49:06 +00001603 count->addIncoming(initialBufferLimit, LoopInitBB);
Mike Stump11289f42009-09-09 15:08:12 +00001604
Justin Bogner66242d62015-04-23 23:06:47 +00001605 incrementProfileCounter(&S);
Bob Wilson8ab16912014-02-24 01:13:09 +00001606
John McCall1c926b72011-01-07 01:49:06 +00001607 // Check whether the mutations value has changed from where it was
1608 // at start. StateMutationsPtr should actually be invariant between
1609 // refreshes.
Anders Carlsson3f35a262008-08-31 04:05:03 +00001610 StateMutationsPtr = Builder.CreateLoad(StateMutationsPtrPtr, "mutationsptr");
John McCall1c926b72011-01-07 01:49:06 +00001611 llvm::Value *currentMutations
John McCall7f416cc2015-09-08 08:05:57 +00001612 = Builder.CreateAlignedLoad(StateMutationsPtr, getPointerAlign(),
1613 "statemutations");
Anders Carlsson3f35a262008-08-31 04:05:03 +00001614
John McCall1c926b72011-01-07 01:49:06 +00001615 llvm::BasicBlock *WasMutatedBB = createBasicBlock("forcoll.mutated");
Dan Gohman6ca99822011-03-02 22:39:34 +00001616 llvm::BasicBlock *WasNotMutatedBB = createBasicBlock("forcoll.notmutated");
Mike Stump11289f42009-09-09 15:08:12 +00001617
John McCall1c926b72011-01-07 01:49:06 +00001618 Builder.CreateCondBr(Builder.CreateICmpEQ(currentMutations, initialMutations),
1619 WasNotMutatedBB, WasMutatedBB);
Mike Stump11289f42009-09-09 15:08:12 +00001620
John McCall1c926b72011-01-07 01:49:06 +00001621 // If so, call the enumeration-mutation function.
1622 EmitBlock(WasMutatedBB);
Anders Carlsson3f35a262008-08-31 04:05:03 +00001623 llvm::Value *V =
Mike Stump11289f42009-09-09 15:08:12 +00001624 Builder.CreateBitCast(Collection,
Benjamin Kramer76399eb2011-09-27 21:06:10 +00001625 ConvertType(getContext().getObjCIdType()));
Daniel Dunbar84388bf2009-02-03 23:55:40 +00001626 CallArgList Args2;
Eli Friedman43dca6a2011-05-02 17:57:46 +00001627 Args2.add(RValue::get(V), getContext().getObjCIdType());
Mike Stump18bb9282009-05-16 07:57:57 +00001628 // FIXME: We shouldn't need to get the function info here, the runtime already
1629 // should have computed it to build the function.
John McCallc56a8b32016-03-11 04:30:31 +00001630 EmitCall(
1631 CGM.getTypes().arrangeBuiltinFunctionCall(getContext().VoidTy, Args2),
Anders Carlsson61a401c2009-12-24 19:25:24 +00001632 EnumerationMutationFn, ReturnValueSlot(), Args2);
Mike Stump11289f42009-09-09 15:08:12 +00001633
John McCall1c926b72011-01-07 01:49:06 +00001634 // Otherwise, or if the mutation function returns, just continue.
1635 EmitBlock(WasNotMutatedBB);
Mike Stump11289f42009-09-09 15:08:12 +00001636
John McCall1c926b72011-01-07 01:49:06 +00001637 // Initialize the element variable.
1638 RunCleanupsScope elementVariableScope(*this);
John McCall9e2e22f2011-02-22 07:16:58 +00001639 bool elementIsVariable;
John McCall1c926b72011-01-07 01:49:06 +00001640 LValue elementLValue;
1641 QualType elementType;
1642 if (const DeclStmt *SD = dyn_cast<DeclStmt>(S.getElement())) {
John McCall9e2e22f2011-02-22 07:16:58 +00001643 // Initialize the variable, in case it's a __block variable or something.
1644 EmitAutoVarInit(variable);
John McCall1c926b72011-01-07 01:49:06 +00001645
John McCall9e2e22f2011-02-22 07:16:58 +00001646 const VarDecl* D = cast<VarDecl>(SD->getSingleDecl());
John McCall113bee02012-03-10 09:33:50 +00001647 DeclRefExpr tempDRE(const_cast<VarDecl*>(D), false, D->getType(),
John McCall1c926b72011-01-07 01:49:06 +00001648 VK_LValue, SourceLocation());
1649 elementLValue = EmitLValue(&tempDRE);
1650 elementType = D->getType();
John McCall9e2e22f2011-02-22 07:16:58 +00001651 elementIsVariable = true;
John McCalld4631322011-06-17 06:42:21 +00001652
1653 if (D->isARCPseudoStrong())
1654 elementLValue.getQuals().setObjCLifetime(Qualifiers::OCL_ExplicitNone);
John McCall1c926b72011-01-07 01:49:06 +00001655 } else {
1656 elementLValue = LValue(); // suppress warning
1657 elementType = cast<Expr>(S.getElement())->getType();
John McCall9e2e22f2011-02-22 07:16:58 +00001658 elementIsVariable = false;
John McCall1c926b72011-01-07 01:49:06 +00001659 }
Chris Lattner2192fe52011-07-18 04:24:23 +00001660 llvm::Type *convertedElementType = ConvertType(elementType);
John McCall1c926b72011-01-07 01:49:06 +00001661
1662 // Fetch the buffer out of the enumeration state.
1663 // TODO: this pointer should actually be invariant between
1664 // refreshes, which would help us do certain loop optimizations.
John McCall7f416cc2015-09-08 08:05:57 +00001665 Address StateItemsPtr = Builder.CreateStructGEP(
1666 StatePtr, 1, getPointerSize(), "stateitems.ptr");
John McCall1c926b72011-01-07 01:49:06 +00001667 llvm::Value *EnumStateItems =
1668 Builder.CreateLoad(StateItemsPtr, "stateitems");
Anders Carlsson75658592008-08-31 02:33:12 +00001669
John McCall1c926b72011-01-07 01:49:06 +00001670 // Fetch the value at the current index from the buffer.
Mike Stump11289f42009-09-09 15:08:12 +00001671 llvm::Value *CurrentItemPtr =
John McCall1c926b72011-01-07 01:49:06 +00001672 Builder.CreateGEP(EnumStateItems, index, "currentitem.ptr");
John McCall7f416cc2015-09-08 08:05:57 +00001673 llvm::Value *CurrentItem =
1674 Builder.CreateAlignedLoad(CurrentItemPtr, getPointerAlign());
Mike Stump11289f42009-09-09 15:08:12 +00001675
John McCall1c926b72011-01-07 01:49:06 +00001676 // Cast that value to the right type.
1677 CurrentItem = Builder.CreateBitCast(CurrentItem, convertedElementType,
1678 "currentitem");
Mike Stump11289f42009-09-09 15:08:12 +00001679
John McCall1c926b72011-01-07 01:49:06 +00001680 // Make sure we have an l-value. Yes, this gets evaluated every
1681 // time through the loop.
John McCalld4631322011-06-17 06:42:21 +00001682 if (!elementIsVariable) {
John McCall1c926b72011-01-07 01:49:06 +00001683 elementLValue = EmitLValue(cast<Expr>(S.getElement()));
John McCall55e1fbc2011-06-25 02:11:03 +00001684 EmitStoreThroughLValue(RValue::get(CurrentItem), elementLValue);
John McCalld4631322011-06-17 06:42:21 +00001685 } else {
Akira Hatanaka642f7992016-10-18 19:05:41 +00001686 EmitStoreThroughLValue(RValue::get(CurrentItem), elementLValue,
1687 /*isInit*/ true);
John McCalld4631322011-06-17 06:42:21 +00001688 }
Mike Stump11289f42009-09-09 15:08:12 +00001689
John McCall9e2e22f2011-02-22 07:16:58 +00001690 // If we do have an element variable, this assignment is the end of
1691 // its initialization.
1692 if (elementIsVariable)
1693 EmitAutoVarCleanups(variable);
1694
John McCall1c926b72011-01-07 01:49:06 +00001695 // Perform the loop body, setting up break and continue labels.
Bob Wilsonbf854f02014-02-17 19:21:09 +00001696 BreakContinueStack.push_back(BreakContinue(LoopEnd, AfterBody));
John McCall1c926b72011-01-07 01:49:06 +00001697 {
1698 RunCleanupsScope Scope(*this);
1699 EmitStmt(S.getBody());
1700 }
Anders Carlsson75658592008-08-31 02:33:12 +00001701 BreakContinueStack.pop_back();
Mike Stump11289f42009-09-09 15:08:12 +00001702
John McCall1c926b72011-01-07 01:49:06 +00001703 // Destroy the element variable now.
1704 elementVariableScope.ForceCleanup();
1705
1706 // Check whether there are more elements.
John McCallad5d61e2010-07-23 21:56:41 +00001707 EmitBlock(AfterBody.getBlock());
Mike Stump11289f42009-09-09 15:08:12 +00001708
John McCall1c926b72011-01-07 01:49:06 +00001709 llvm::BasicBlock *FetchMoreBB = createBasicBlock("forcoll.refetch");
Fariborz Jahanian6e7ecc82009-01-06 18:56:31 +00001710
John McCall1c926b72011-01-07 01:49:06 +00001711 // First we check in the local buffer.
1712 llvm::Value *indexPlusOne
1713 = Builder.CreateAdd(index, llvm::ConstantInt::get(UnsignedLongLTy, 1));
Anders Carlsson75658592008-08-31 02:33:12 +00001714
John McCall1c926b72011-01-07 01:49:06 +00001715 // If we haven't overrun the buffer yet, we can continue.
Bob Wilson0ed74d92014-03-25 23:26:31 +00001716 // Set the branch weights based on the simplifying assumption that this is
1717 // like a while-loop, i.e., ignoring that the false branch fetches more
1718 // elements and then returns to the loop.
Justin Bogner66242d62015-04-23 23:06:47 +00001719 Builder.CreateCondBr(
1720 Builder.CreateICmpULT(indexPlusOne, count), LoopBodyBB, FetchMoreBB,
Justin Bogner65512642015-05-02 05:00:55 +00001721 createProfileWeights(getProfileCount(S.getBody()), EntryCount));
John McCall1c926b72011-01-07 01:49:06 +00001722
1723 index->addIncoming(indexPlusOne, AfterBody.getBlock());
1724 count->addIncoming(count, AfterBody.getBlock());
1725
1726 // Otherwise, we have to fetch more elements.
1727 EmitBlock(FetchMoreBB);
Mike Stump11289f42009-09-09 15:08:12 +00001728
1729 CountRV =
John McCall78a15112010-05-22 01:48:05 +00001730 CGM.getObjCRuntime().GenerateMessageSend(*this, ReturnValueSlot(),
Anders Carlsson75658592008-08-31 02:33:12 +00001731 getContext().UnsignedLongTy,
Mike Stump11289f42009-09-09 15:08:12 +00001732 FastEnumSel,
David Chisnall01aa4672010-04-28 19:33:36 +00001733 Collection, Args);
Mike Stump11289f42009-09-09 15:08:12 +00001734
John McCall1c926b72011-01-07 01:49:06 +00001735 // If we got a zero count, we're done.
1736 llvm::Value *refetchCount = CountRV.getScalarVal();
1737
1738 // (note that the message send might split FetchMoreBB)
1739 index->addIncoming(zero, Builder.GetInsertBlock());
1740 count->addIncoming(refetchCount, Builder.GetInsertBlock());
1741
1742 Builder.CreateCondBr(Builder.CreateICmpEQ(refetchCount, zero),
1743 EmptyBB, LoopBodyBB);
Mike Stump11289f42009-09-09 15:08:12 +00001744
Anders Carlsson75658592008-08-31 02:33:12 +00001745 // No more elements.
John McCall1c926b72011-01-07 01:49:06 +00001746 EmitBlock(EmptyBB);
Anders Carlsson75658592008-08-31 02:33:12 +00001747
John McCall9e2e22f2011-02-22 07:16:58 +00001748 if (!elementIsVariable) {
Anders Carlsson75658592008-08-31 02:33:12 +00001749 // If the element was not a declaration, set it to be null.
1750
John McCall1c926b72011-01-07 01:49:06 +00001751 llvm::Value *null = llvm::Constant::getNullValue(convertedElementType);
1752 elementLValue = EmitLValue(cast<Expr>(S.getElement()));
John McCall55e1fbc2011-06-25 02:11:03 +00001753 EmitStoreThroughLValue(RValue::get(null), elementLValue);
Anders Carlsson75658592008-08-31 02:33:12 +00001754 }
1755
Eric Christopher7cdf9482011-10-13 21:45:18 +00001756 if (DI)
1757 DI->EmitLexicalBlockEnd(Builder, S.getSourceRange().getEnd());
Devang Pateld2d66652011-01-19 01:36:36 +00001758
Akira Hatanaka2d3690b2016-04-12 23:10:58 +00001759 ForScope.ForceCleanup();
John McCallad5d61e2010-07-23 21:56:41 +00001760 EmitBlock(LoopEnd.getBlock());
Anders Carlsson2e744e82008-08-30 19:51:14 +00001761}
1762
Mike Stump11289f42009-09-09 15:08:12 +00001763void CodeGenFunction::EmitObjCAtTryStmt(const ObjCAtTryStmt &S) {
John McCallbd309292010-07-06 01:34:17 +00001764 CGM.getObjCRuntime().EmitTryStmt(*this, S);
Anders Carlsson1963b0c2008-09-09 10:04:29 +00001765}
1766
Mike Stump11289f42009-09-09 15:08:12 +00001767void CodeGenFunction::EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S) {
Anders Carlsson1963b0c2008-09-09 10:04:29 +00001768 CGM.getObjCRuntime().EmitThrowStmt(*this, S);
1769}
1770
Chris Lattnere132e242008-11-15 21:26:17 +00001771void CodeGenFunction::EmitObjCAtSynchronizedStmt(
Mike Stump11289f42009-09-09 15:08:12 +00001772 const ObjCAtSynchronizedStmt &S) {
John McCallbd309292010-07-06 01:34:17 +00001773 CGM.getObjCRuntime().EmitSynchronizedStmt(*this, S);
Chris Lattnere132e242008-11-15 21:26:17 +00001774}
1775
John McCall31168b02011-06-15 23:02:42 +00001776namespace {
David Blaikie7e70d682015-08-18 22:40:54 +00001777 struct CallObjCRelease final : EHScopeStack::Cleanup {
John McCall9c8e1c92011-08-03 22:24:24 +00001778 CallObjCRelease(llvm::Value *object) : object(object) {}
1779 llvm::Value *object;
John McCall31168b02011-06-15 23:02:42 +00001780
Craig Topper4f12f102014-03-12 06:41:41 +00001781 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCallcdda29c2013-03-13 03:10:54 +00001782 // Releases at the end of the full-expression are imprecise.
1783 CGF.EmitARCRelease(object, ARCImpreciseLifetime);
John McCall31168b02011-06-15 23:02:42 +00001784 }
1785 };
Alexander Kornienkoab9db512015-06-22 23:07:51 +00001786}
John McCall31168b02011-06-15 23:02:42 +00001787
John McCall2d637d22011-09-10 06:18:15 +00001788/// Produce the code for a CK_ARCConsumeObject. Does a primitive
John McCall31168b02011-06-15 23:02:42 +00001789/// release at the end of the full-expression.
1790llvm::Value *CodeGenFunction::EmitObjCConsumeObject(QualType type,
1791 llvm::Value *object) {
1792 // If we're in a conditional branch, we need to make the cleanup
John McCall9c8e1c92011-08-03 22:24:24 +00001793 // conditional.
1794 pushFullExprCleanup<CallObjCRelease>(getARCCleanupKind(), object);
John McCall31168b02011-06-15 23:02:42 +00001795 return object;
1796}
1797
1798llvm::Value *CodeGenFunction::EmitObjCExtendObjectLifetime(QualType type,
1799 llvm::Value *value) {
1800 return EmitARCRetainAutorelease(type, value);
1801}
1802
John McCalleff18842013-03-23 02:35:54 +00001803/// Given a number of pointers, inform the optimizer that they're
1804/// being intrinsically used up until this point in the program.
1805void CodeGenFunction::EmitARCIntrinsicUse(ArrayRef<llvm::Value*> values) {
John McCallb04ecb72015-10-21 18:06:43 +00001806 llvm::Constant *&fn = CGM.getObjCEntrypoints().clang_arc_use;
John McCalleff18842013-03-23 02:35:54 +00001807 if (!fn) {
1808 llvm::FunctionType *fnType =
Craig Topper5fc8fc22014-08-27 06:28:36 +00001809 llvm::FunctionType::get(CGM.VoidTy, None, true);
John McCalleff18842013-03-23 02:35:54 +00001810 fn = CGM.CreateRuntimeFunction(fnType, "clang.arc.use");
1811 }
1812
1813 // This isn't really a "runtime" function, but as an intrinsic it
1814 // doesn't really matter as long as we align things up.
1815 EmitNounwindRuntimeCall(fn, values);
1816}
1817
John McCall31168b02011-06-15 23:02:42 +00001818
Saleem Abdulrasoolc30cec22017-02-11 21:34:18 +00001819static bool IsForwarding(StringRef Name) {
1820 return llvm::StringSwitch<bool>(Name)
1821 .Cases("objc_autoreleaseReturnValue", // ARCInstKind::AutoreleaseRV
1822 "objc_autorelease", // ARCInstKind::Autorelease
1823 "objc_retainAutoreleaseReturnValue", // ARCInstKind::FusedRetainAutoreleaseRV
1824 "objc_retainAutoreleasedReturnValue", // ARCInstKind::RetainRV
1825 "objc_retainAutorelease", // ARCInstKind::FusedRetainAutorelease
1826 "objc_retainedObject", // ARCInstKind::NoopCast
1827 "objc_retain", // ARCInstKind::Retain
1828 "objc_unretainedObject", // ARCInstKind::NoopCast
1829 "objc_unretainedPointer", // ARCInstKind::NoopCast
1830 "objc_unsafeClaimAutoreleasedReturnValue", // ARCInstKind::ClaimRV
1831 true)
1832 .Default(false);
1833}
1834
John McCall31168b02011-06-15 23:02:42 +00001835static llvm::Constant *createARCRuntimeFunction(CodeGenModule &CGM,
Saleem Abdulrasoole60561c2017-02-11 17:24:07 +00001836 llvm::FunctionType *FTy,
1837 StringRef Name) {
1838 llvm::Constant *RTF = CGM.CreateRuntimeFunction(FTy, Name);
John McCall31168b02011-06-15 23:02:42 +00001839
Saleem Abdulrasoole60561c2017-02-11 17:24:07 +00001840 if (auto *F = dyn_cast<llvm::Function>(RTF)) {
Michael Gottesmanbe9614c2013-02-02 01:05:06 +00001841 // If the target runtime doesn't naturally support ARC, emit weak
1842 // references to the runtime support library. We don't really
1843 // permit this to fail, but we need a particular relocation style.
Saleem Abdulrasool6cb07442016-12-15 06:59:05 +00001844 if (!CGM.getLangOpts().ObjCRuntime.hasNativeARC() &&
1845 !CGM.getTriple().isOSBinFormatCOFF()) {
Saleem Abdulrasoole60561c2017-02-11 17:24:07 +00001846 F->setLinkage(llvm::Function::ExternalWeakLinkage);
1847 } else if (Name == "objc_retain" || Name == "objc_release") {
Michael Gottesmancf50e6d2013-02-02 00:57:44 +00001848 // If we have Native ARC, set nonlazybind attribute for these APIs for
1849 // performance.
Saleem Abdulrasoole60561c2017-02-11 17:24:07 +00001850 F->addFnAttr(llvm::Attribute::NonLazyBind);
Michael Gottesmanb46072d2013-02-02 01:03:01 +00001851 }
Saleem Abdulrasoolc30cec22017-02-11 21:34:18 +00001852
1853 if (IsForwarding(Name)) {
1854 llvm::AttrBuilder B;
1855 B.addAttribute(llvm::Attribute::Returned);
1856
Reid Klecknerde864822017-03-21 16:57:30 +00001857 F->arg_begin()->addAttr(llvm::AttributeList::get(F->getContext(), 1, B));
Saleem Abdulrasoolc30cec22017-02-11 21:34:18 +00001858 }
Michael Gottesmancf50e6d2013-02-02 00:57:44 +00001859 }
John McCall31168b02011-06-15 23:02:42 +00001860
Saleem Abdulrasoole60561c2017-02-11 17:24:07 +00001861 return RTF;
John McCall31168b02011-06-15 23:02:42 +00001862}
1863
1864/// Perform an operation having the signature
1865/// i8* (i8*)
1866/// where a null input causes a no-op and returns null.
1867static llvm::Value *emitARCValueOperation(CodeGenFunction &CGF,
1868 llvm::Value *value,
1869 llvm::Constant *&fn,
Chad Rosier13799b32012-12-12 17:52:21 +00001870 StringRef fnName,
1871 bool isTailCall = false) {
Saleem Abdulrasoole60561c2017-02-11 17:24:07 +00001872 if (isa<llvm::ConstantPointerNull>(value))
1873 return value;
John McCall31168b02011-06-15 23:02:42 +00001874
1875 if (!fn) {
Chris Lattner2192fe52011-07-18 04:24:23 +00001876 llvm::FunctionType *fnType =
Benjamin Kramer95e19362013-03-07 21:18:31 +00001877 llvm::FunctionType::get(CGF.Int8PtrTy, CGF.Int8PtrTy, false);
John McCall31168b02011-06-15 23:02:42 +00001878 fn = createARCRuntimeFunction(CGF.CGM, fnType, fnName);
1879 }
1880
1881 // Cast the argument to 'id'.
Pete Cooper94867712016-03-21 20:50:03 +00001882 llvm::Type *origType = value->getType();
John McCall31168b02011-06-15 23:02:42 +00001883 value = CGF.Builder.CreateBitCast(value, CGF.Int8PtrTy);
1884
1885 // Call the function.
John McCall882987f2013-02-28 19:01:20 +00001886 llvm::CallInst *call = CGF.EmitNounwindRuntimeCall(fn, value);
Chad Rosier13799b32012-12-12 17:52:21 +00001887 if (isTailCall)
1888 call->setTailCall();
John McCall31168b02011-06-15 23:02:42 +00001889
1890 // Cast the result back to the original type.
1891 return CGF.Builder.CreateBitCast(call, origType);
1892}
1893
1894/// Perform an operation having the following signature:
1895/// i8* (i8**)
1896static llvm::Value *emitARCLoadOperation(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001897 Address addr,
John McCall31168b02011-06-15 23:02:42 +00001898 llvm::Constant *&fn,
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001899 StringRef fnName) {
John McCall31168b02011-06-15 23:02:42 +00001900 if (!fn) {
Chris Lattner2192fe52011-07-18 04:24:23 +00001901 llvm::FunctionType *fnType =
Benjamin Kramer95e19362013-03-07 21:18:31 +00001902 llvm::FunctionType::get(CGF.Int8PtrTy, CGF.Int8PtrPtrTy, false);
John McCall31168b02011-06-15 23:02:42 +00001903 fn = createARCRuntimeFunction(CGF.CGM, fnType, fnName);
1904 }
1905
1906 // Cast the argument to 'id*'.
John McCall7f416cc2015-09-08 08:05:57 +00001907 llvm::Type *origType = addr.getElementType();
John McCall31168b02011-06-15 23:02:42 +00001908 addr = CGF.Builder.CreateBitCast(addr, CGF.Int8PtrPtrTy);
1909
1910 // Call the function.
John McCall7f416cc2015-09-08 08:05:57 +00001911 llvm::Value *result = CGF.EmitNounwindRuntimeCall(fn, addr.getPointer());
John McCall31168b02011-06-15 23:02:42 +00001912
1913 // Cast the result back to a dereference of the original type.
John McCall7f416cc2015-09-08 08:05:57 +00001914 if (origType != CGF.Int8PtrTy)
1915 result = CGF.Builder.CreateBitCast(result, origType);
John McCall31168b02011-06-15 23:02:42 +00001916
1917 return result;
1918}
1919
1920/// Perform an operation having the following signature:
1921/// i8* (i8**, i8*)
1922static llvm::Value *emitARCStoreOperation(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001923 Address addr,
John McCall31168b02011-06-15 23:02:42 +00001924 llvm::Value *value,
1925 llvm::Constant *&fn,
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001926 StringRef fnName,
John McCall31168b02011-06-15 23:02:42 +00001927 bool ignored) {
John McCall7f416cc2015-09-08 08:05:57 +00001928 assert(addr.getElementType() == value->getType());
John McCall31168b02011-06-15 23:02:42 +00001929
1930 if (!fn) {
Benjamin Kramer22d24c22011-10-15 12:20:02 +00001931 llvm::Type *argTypes[] = { CGF.Int8PtrPtrTy, CGF.Int8PtrTy };
John McCall31168b02011-06-15 23:02:42 +00001932
Chris Lattner2192fe52011-07-18 04:24:23 +00001933 llvm::FunctionType *fnType
John McCall31168b02011-06-15 23:02:42 +00001934 = llvm::FunctionType::get(CGF.Int8PtrTy, argTypes, false);
1935 fn = createARCRuntimeFunction(CGF.CGM, fnType, fnName);
1936 }
1937
Chris Lattner2192fe52011-07-18 04:24:23 +00001938 llvm::Type *origType = value->getType();
John McCall31168b02011-06-15 23:02:42 +00001939
John McCall882987f2013-02-28 19:01:20 +00001940 llvm::Value *args[] = {
John McCall7f416cc2015-09-08 08:05:57 +00001941 CGF.Builder.CreateBitCast(addr.getPointer(), CGF.Int8PtrPtrTy),
John McCall882987f2013-02-28 19:01:20 +00001942 CGF.Builder.CreateBitCast(value, CGF.Int8PtrTy)
1943 };
1944 llvm::CallInst *result = CGF.EmitNounwindRuntimeCall(fn, args);
John McCall31168b02011-06-15 23:02:42 +00001945
Craig Topper8a13c412014-05-21 05:09:00 +00001946 if (ignored) return nullptr;
John McCall31168b02011-06-15 23:02:42 +00001947
1948 return CGF.Builder.CreateBitCast(result, origType);
1949}
1950
1951/// Perform an operation having the following signature:
1952/// void (i8**, i8**)
1953static void emitARCCopyOperation(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001954 Address dst,
1955 Address src,
John McCall31168b02011-06-15 23:02:42 +00001956 llvm::Constant *&fn,
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001957 StringRef fnName) {
John McCall7f416cc2015-09-08 08:05:57 +00001958 assert(dst.getType() == src.getType());
John McCall31168b02011-06-15 23:02:42 +00001959
1960 if (!fn) {
Benjamin Kramer95e19362013-03-07 21:18:31 +00001961 llvm::Type *argTypes[] = { CGF.Int8PtrPtrTy, CGF.Int8PtrPtrTy };
1962
Chris Lattner2192fe52011-07-18 04:24:23 +00001963 llvm::FunctionType *fnType
John McCall31168b02011-06-15 23:02:42 +00001964 = llvm::FunctionType::get(CGF.Builder.getVoidTy(), argTypes, false);
1965 fn = createARCRuntimeFunction(CGF.CGM, fnType, fnName);
1966 }
1967
John McCall882987f2013-02-28 19:01:20 +00001968 llvm::Value *args[] = {
John McCall7f416cc2015-09-08 08:05:57 +00001969 CGF.Builder.CreateBitCast(dst.getPointer(), CGF.Int8PtrPtrTy),
1970 CGF.Builder.CreateBitCast(src.getPointer(), CGF.Int8PtrPtrTy)
John McCall882987f2013-02-28 19:01:20 +00001971 };
1972 CGF.EmitNounwindRuntimeCall(fn, args);
John McCall31168b02011-06-15 23:02:42 +00001973}
1974
1975/// Produce the code to do a retain. Based on the type, calls one of:
James Dennett14c41ea2012-06-22 05:41:30 +00001976/// call i8* \@objc_retain(i8* %value)
1977/// call i8* \@objc_retainBlock(i8* %value)
John McCall31168b02011-06-15 23:02:42 +00001978llvm::Value *CodeGenFunction::EmitARCRetain(QualType type, llvm::Value *value) {
1979 if (type->isBlockPointerType())
John McCallff613032011-10-04 06:23:45 +00001980 return EmitARCRetainBlock(value, /*mandatory*/ false);
John McCall31168b02011-06-15 23:02:42 +00001981 else
1982 return EmitARCRetainNonBlock(value);
1983}
1984
1985/// Retain the given object, with normal retain semantics.
James Dennett14c41ea2012-06-22 05:41:30 +00001986/// call i8* \@objc_retain(i8* %value)
Pete Cooper94867712016-03-21 20:50:03 +00001987llvm::Value *CodeGenFunction::EmitARCRetainNonBlock(llvm::Value *value) {
1988 return emitARCValueOperation(*this, value,
John McCallb04ecb72015-10-21 18:06:43 +00001989 CGM.getObjCEntrypoints().objc_retain,
John McCall31168b02011-06-15 23:02:42 +00001990 "objc_retain");
1991}
1992
1993/// Retain the given block, with _Block_copy semantics.
James Dennett14c41ea2012-06-22 05:41:30 +00001994/// call i8* \@objc_retainBlock(i8* %value)
John McCallff613032011-10-04 06:23:45 +00001995///
1996/// \param mandatory - If false, emit the call with metadata
1997/// indicating that it's okay for the optimizer to eliminate this call
1998/// if it can prove that the block never escapes except down the stack.
1999llvm::Value *CodeGenFunction::EmitARCRetainBlock(llvm::Value *value,
2000 bool mandatory) {
2001 llvm::Value *result
Pete Cooper94867712016-03-21 20:50:03 +00002002 = emitARCValueOperation(*this, value,
John McCallb04ecb72015-10-21 18:06:43 +00002003 CGM.getObjCEntrypoints().objc_retainBlock,
John McCallff613032011-10-04 06:23:45 +00002004 "objc_retainBlock");
2005
2006 // If the copy isn't mandatory, add !clang.arc.copy_on_escape to
2007 // tell the optimizer that it doesn't need to do this copy if the
2008 // block doesn't escape, where being passed as an argument doesn't
2009 // count as escaping.
2010 if (!mandatory && isa<llvm::Instruction>(result)) {
2011 llvm::CallInst *call
2012 = cast<llvm::CallInst>(result->stripPointerCasts());
John McCallb04ecb72015-10-21 18:06:43 +00002013 assert(call->getCalledValue() == CGM.getObjCEntrypoints().objc_retainBlock);
John McCallff613032011-10-04 06:23:45 +00002014
John McCallff613032011-10-04 06:23:45 +00002015 call->setMetadata("clang.arc.copy_on_escape",
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002016 llvm::MDNode::get(Builder.getContext(), None));
John McCallff613032011-10-04 06:23:45 +00002017 }
2018
2019 return result;
John McCall31168b02011-06-15 23:02:42 +00002020}
2021
John McCalle399e5b2016-01-27 18:32:30 +00002022static void emitAutoreleasedReturnValueMarker(CodeGenFunction &CGF) {
John McCall31168b02011-06-15 23:02:42 +00002023 // Fetch the void(void) inline asm which marks that we're going to
John McCalle399e5b2016-01-27 18:32:30 +00002024 // do something with the autoreleased return value.
John McCall31168b02011-06-15 23:02:42 +00002025 llvm::InlineAsm *&marker
John McCalle399e5b2016-01-27 18:32:30 +00002026 = CGF.CGM.getObjCEntrypoints().retainAutoreleasedReturnValueMarker;
John McCall31168b02011-06-15 23:02:42 +00002027 if (!marker) {
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002028 StringRef assembly
John McCalle399e5b2016-01-27 18:32:30 +00002029 = CGF.CGM.getTargetCodeGenInfo()
John McCall31168b02011-06-15 23:02:42 +00002030 .getARCRetainAutoreleasedReturnValueMarker();
2031
2032 // If we have an empty assembly string, there's nothing to do.
2033 if (assembly.empty()) {
2034
2035 // Otherwise, at -O0, build an inline asm that we're going to call
2036 // in a moment.
John McCalle399e5b2016-01-27 18:32:30 +00002037 } else if (CGF.CGM.getCodeGenOpts().OptimizationLevel == 0) {
John McCall31168b02011-06-15 23:02:42 +00002038 llvm::FunctionType *type =
John McCalle399e5b2016-01-27 18:32:30 +00002039 llvm::FunctionType::get(CGF.VoidTy, /*variadic*/false);
John McCall31168b02011-06-15 23:02:42 +00002040
2041 marker = llvm::InlineAsm::get(type, assembly, "", /*sideeffects*/ true);
2042
2043 // If we're at -O1 and above, we don't want to litter the code
2044 // with this marker yet, so leave a breadcrumb for the ARC
2045 // optimizer to pick up.
2046 } else {
2047 llvm::NamedMDNode *metadata =
John McCalle399e5b2016-01-27 18:32:30 +00002048 CGF.CGM.getModule().getOrInsertNamedMetadata(
John McCall31168b02011-06-15 23:02:42 +00002049 "clang.arc.retainAutoreleasedReturnValueMarker");
2050 assert(metadata->getNumOperands() <= 1);
2051 if (metadata->getNumOperands() == 0) {
John McCalle399e5b2016-01-27 18:32:30 +00002052 auto &ctx = CGF.getLLVMContext();
2053 metadata->addOperand(llvm::MDNode::get(ctx,
2054 llvm::MDString::get(ctx, assembly)));
John McCall31168b02011-06-15 23:02:42 +00002055 }
2056 }
2057 }
2058
2059 // Call the marker asm if we made one, which we do only at -O0.
David Blaikie43f9bb72015-05-18 22:14:03 +00002060 if (marker)
John McCalle399e5b2016-01-27 18:32:30 +00002061 CGF.Builder.CreateCall(marker);
2062}
John McCall31168b02011-06-15 23:02:42 +00002063
John McCalle399e5b2016-01-27 18:32:30 +00002064/// Retain the given object which is the result of a function call.
2065/// call i8* \@objc_retainAutoreleasedReturnValue(i8* %value)
2066///
2067/// Yes, this function name is one character away from a different
2068/// call with completely different semantics.
2069llvm::Value *
2070CodeGenFunction::EmitARCRetainAutoreleasedReturnValue(llvm::Value *value) {
2071 emitAutoreleasedReturnValueMarker(*this);
Pete Cooper94867712016-03-21 20:50:03 +00002072 return emitARCValueOperation(*this, value,
John McCalle399e5b2016-01-27 18:32:30 +00002073 CGM.getObjCEntrypoints().objc_retainAutoreleasedReturnValue,
John McCall31168b02011-06-15 23:02:42 +00002074 "objc_retainAutoreleasedReturnValue");
2075}
2076
John McCalle399e5b2016-01-27 18:32:30 +00002077/// Claim a possibly-autoreleased return value at +0. This is only
2078/// valid to do in contexts which do not rely on the retain to keep
2079/// the object valid for for all of its uses; for example, when
2080/// the value is ignored, or when it is being assigned to an
2081/// __unsafe_unretained variable.
2082///
2083/// call i8* \@objc_unsafeClaimAutoreleasedReturnValue(i8* %value)
2084llvm::Value *
2085CodeGenFunction::EmitARCUnsafeClaimAutoreleasedReturnValue(llvm::Value *value) {
2086 emitAutoreleasedReturnValueMarker(*this);
Pete Cooper94867712016-03-21 20:50:03 +00002087 return emitARCValueOperation(*this, value,
John McCalle399e5b2016-01-27 18:32:30 +00002088 CGM.getObjCEntrypoints().objc_unsafeClaimAutoreleasedReturnValue,
2089 "objc_unsafeClaimAutoreleasedReturnValue");
2090}
2091
John McCall31168b02011-06-15 23:02:42 +00002092/// Release the given object.
James Dennett14c41ea2012-06-22 05:41:30 +00002093/// call void \@objc_release(i8* %value)
John McCallcdda29c2013-03-13 03:10:54 +00002094void CodeGenFunction::EmitARCRelease(llvm::Value *value,
2095 ARCPreciseLifetime_t precise) {
John McCall31168b02011-06-15 23:02:42 +00002096 if (isa<llvm::ConstantPointerNull>(value)) return;
2097
John McCallb04ecb72015-10-21 18:06:43 +00002098 llvm::Constant *&fn = CGM.getObjCEntrypoints().objc_release;
John McCall31168b02011-06-15 23:02:42 +00002099 if (!fn) {
Chris Lattner2192fe52011-07-18 04:24:23 +00002100 llvm::FunctionType *fnType =
Benjamin Kramer95e19362013-03-07 21:18:31 +00002101 llvm::FunctionType::get(Builder.getVoidTy(), Int8PtrTy, false);
John McCall31168b02011-06-15 23:02:42 +00002102 fn = createARCRuntimeFunction(CGM, fnType, "objc_release");
2103 }
2104
2105 // Cast the argument to 'id'.
2106 value = Builder.CreateBitCast(value, Int8PtrTy);
2107
2108 // Call objc_release.
John McCall882987f2013-02-28 19:01:20 +00002109 llvm::CallInst *call = EmitNounwindRuntimeCall(fn, value);
John McCall31168b02011-06-15 23:02:42 +00002110
John McCallcdda29c2013-03-13 03:10:54 +00002111 if (precise == ARCImpreciseLifetime) {
John McCall31168b02011-06-15 23:02:42 +00002112 call->setMetadata("clang.imprecise_release",
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002113 llvm::MDNode::get(Builder.getContext(), None));
John McCall31168b02011-06-15 23:02:42 +00002114 }
2115}
2116
John McCalle68b8f42012-10-17 02:28:37 +00002117/// Destroy a __strong variable.
2118///
2119/// At -O0, emit a call to store 'null' into the address;
2120/// instrumenting tools prefer this because the address is exposed,
2121/// but it's relatively cumbersome to optimize.
2122///
2123/// At -O1 and above, just load and call objc_release.
2124///
2125/// call void \@objc_storeStrong(i8** %addr, i8* null)
John McCall7f416cc2015-09-08 08:05:57 +00002126void CodeGenFunction::EmitARCDestroyStrong(Address addr,
John McCallcdda29c2013-03-13 03:10:54 +00002127 ARCPreciseLifetime_t precise) {
John McCalle68b8f42012-10-17 02:28:37 +00002128 if (CGM.getCodeGenOpts().OptimizationLevel == 0) {
John McCall7f416cc2015-09-08 08:05:57 +00002129 llvm::Value *null = getNullForVariable(addr);
John McCalle68b8f42012-10-17 02:28:37 +00002130 EmitARCStoreStrongCall(addr, null, /*ignored*/ true);
2131 return;
2132 }
2133
2134 llvm::Value *value = Builder.CreateLoad(addr);
2135 EmitARCRelease(value, precise);
2136}
2137
John McCall31168b02011-06-15 23:02:42 +00002138/// Store into a strong object. Always calls this:
James Dennett14c41ea2012-06-22 05:41:30 +00002139/// call void \@objc_storeStrong(i8** %addr, i8* %value)
John McCall7f416cc2015-09-08 08:05:57 +00002140llvm::Value *CodeGenFunction::EmitARCStoreStrongCall(Address addr,
John McCall31168b02011-06-15 23:02:42 +00002141 llvm::Value *value,
2142 bool ignored) {
John McCall7f416cc2015-09-08 08:05:57 +00002143 assert(addr.getElementType() == value->getType());
John McCall31168b02011-06-15 23:02:42 +00002144
John McCallb04ecb72015-10-21 18:06:43 +00002145 llvm::Constant *&fn = CGM.getObjCEntrypoints().objc_storeStrong;
John McCall31168b02011-06-15 23:02:42 +00002146 if (!fn) {
Chris Lattnera5f58b02011-07-09 17:41:47 +00002147 llvm::Type *argTypes[] = { Int8PtrPtrTy, Int8PtrTy };
Chris Lattner2192fe52011-07-18 04:24:23 +00002148 llvm::FunctionType *fnType
John McCall31168b02011-06-15 23:02:42 +00002149 = llvm::FunctionType::get(Builder.getVoidTy(), argTypes, false);
2150 fn = createARCRuntimeFunction(CGM, fnType, "objc_storeStrong");
2151 }
2152
John McCall882987f2013-02-28 19:01:20 +00002153 llvm::Value *args[] = {
John McCall7f416cc2015-09-08 08:05:57 +00002154 Builder.CreateBitCast(addr.getPointer(), Int8PtrPtrTy),
John McCall882987f2013-02-28 19:01:20 +00002155 Builder.CreateBitCast(value, Int8PtrTy)
2156 };
2157 EmitNounwindRuntimeCall(fn, args);
John McCall31168b02011-06-15 23:02:42 +00002158
Craig Topper8a13c412014-05-21 05:09:00 +00002159 if (ignored) return nullptr;
John McCall31168b02011-06-15 23:02:42 +00002160 return value;
2161}
2162
2163/// Store into a strong object. Sometimes calls this:
James Dennett14c41ea2012-06-22 05:41:30 +00002164/// call void \@objc_storeStrong(i8** %addr, i8* %value)
John McCall31168b02011-06-15 23:02:42 +00002165/// Other times, breaks it down into components.
John McCall55e1fbc2011-06-25 02:11:03 +00002166llvm::Value *CodeGenFunction::EmitARCStoreStrong(LValue dst,
John McCall31168b02011-06-15 23:02:42 +00002167 llvm::Value *newValue,
2168 bool ignored) {
John McCall55e1fbc2011-06-25 02:11:03 +00002169 QualType type = dst.getType();
John McCall31168b02011-06-15 23:02:42 +00002170 bool isBlock = type->isBlockPointerType();
2171
2172 // Use a store barrier at -O0 unless this is a block type or the
2173 // lvalue is inadequately aligned.
2174 if (shouldUseFusedARCCalls() &&
2175 !isBlock &&
Eli Friedmana0544d62011-12-03 04:14:32 +00002176 (dst.getAlignment().isZero() ||
2177 dst.getAlignment() >= CharUnits::fromQuantity(PointerAlignInBytes))) {
John McCall31168b02011-06-15 23:02:42 +00002178 return EmitARCStoreStrongCall(dst.getAddress(), newValue, ignored);
2179 }
2180
2181 // Otherwise, split it out.
2182
2183 // Retain the new value.
2184 newValue = EmitARCRetain(type, newValue);
2185
2186 // Read the old value.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002187 llvm::Value *oldValue = EmitLoadOfScalar(dst, SourceLocation());
John McCall31168b02011-06-15 23:02:42 +00002188
2189 // Store. We do this before the release so that any deallocs won't
2190 // see the old value.
John McCall55e1fbc2011-06-25 02:11:03 +00002191 EmitStoreOfScalar(newValue, dst);
John McCall31168b02011-06-15 23:02:42 +00002192
2193 // Finally, release the old value.
John McCallcdda29c2013-03-13 03:10:54 +00002194 EmitARCRelease(oldValue, dst.isARCPreciseLifetime());
John McCall31168b02011-06-15 23:02:42 +00002195
2196 return newValue;
2197}
2198
2199/// Autorelease the given object.
James Dennett14c41ea2012-06-22 05:41:30 +00002200/// call i8* \@objc_autorelease(i8* %value)
Pete Cooper94867712016-03-21 20:50:03 +00002201llvm::Value *CodeGenFunction::EmitARCAutorelease(llvm::Value *value) {
2202 return emitARCValueOperation(*this, value,
John McCallb04ecb72015-10-21 18:06:43 +00002203 CGM.getObjCEntrypoints().objc_autorelease,
John McCall31168b02011-06-15 23:02:42 +00002204 "objc_autorelease");
2205}
2206
2207/// Autorelease the given object.
James Dennett14c41ea2012-06-22 05:41:30 +00002208/// call i8* \@objc_autoreleaseReturnValue(i8* %value)
John McCall31168b02011-06-15 23:02:42 +00002209llvm::Value *
2210CodeGenFunction::EmitARCAutoreleaseReturnValue(llvm::Value *value) {
Pete Cooper94867712016-03-21 20:50:03 +00002211 return emitARCValueOperation(*this, value,
John McCallb04ecb72015-10-21 18:06:43 +00002212 CGM.getObjCEntrypoints().objc_autoreleaseReturnValue,
Chad Rosier13799b32012-12-12 17:52:21 +00002213 "objc_autoreleaseReturnValue",
2214 /*isTailCall*/ true);
John McCall31168b02011-06-15 23:02:42 +00002215}
2216
2217/// Do a fused retain/autorelease of the given object.
James Dennett14c41ea2012-06-22 05:41:30 +00002218/// call i8* \@objc_retainAutoreleaseReturnValue(i8* %value)
John McCall31168b02011-06-15 23:02:42 +00002219llvm::Value *
2220CodeGenFunction::EmitARCRetainAutoreleaseReturnValue(llvm::Value *value) {
Pete Cooper94867712016-03-21 20:50:03 +00002221 return emitARCValueOperation(*this, value,
John McCallb04ecb72015-10-21 18:06:43 +00002222 CGM.getObjCEntrypoints().objc_retainAutoreleaseReturnValue,
Chad Rosier13799b32012-12-12 17:52:21 +00002223 "objc_retainAutoreleaseReturnValue",
2224 /*isTailCall*/ true);
John McCall31168b02011-06-15 23:02:42 +00002225}
2226
2227/// Do a fused retain/autorelease of the given object.
James Dennett14c41ea2012-06-22 05:41:30 +00002228/// call i8* \@objc_retainAutorelease(i8* %value)
John McCall31168b02011-06-15 23:02:42 +00002229/// or
James Dennett14c41ea2012-06-22 05:41:30 +00002230/// %retain = call i8* \@objc_retainBlock(i8* %value)
2231/// call i8* \@objc_autorelease(i8* %retain)
John McCall31168b02011-06-15 23:02:42 +00002232llvm::Value *CodeGenFunction::EmitARCRetainAutorelease(QualType type,
2233 llvm::Value *value) {
2234 if (!type->isBlockPointerType())
2235 return EmitARCRetainAutoreleaseNonBlock(value);
2236
2237 if (isa<llvm::ConstantPointerNull>(value)) return value;
2238
Chris Lattner2192fe52011-07-18 04:24:23 +00002239 llvm::Type *origType = value->getType();
John McCall31168b02011-06-15 23:02:42 +00002240 value = Builder.CreateBitCast(value, Int8PtrTy);
John McCallff613032011-10-04 06:23:45 +00002241 value = EmitARCRetainBlock(value, /*mandatory*/ true);
John McCall31168b02011-06-15 23:02:42 +00002242 value = EmitARCAutorelease(value);
2243 return Builder.CreateBitCast(value, origType);
2244}
2245
2246/// Do a fused retain/autorelease of the given object.
James Dennett14c41ea2012-06-22 05:41:30 +00002247/// call i8* \@objc_retainAutorelease(i8* %value)
John McCall31168b02011-06-15 23:02:42 +00002248llvm::Value *
2249CodeGenFunction::EmitARCRetainAutoreleaseNonBlock(llvm::Value *value) {
Pete Cooper94867712016-03-21 20:50:03 +00002250 return emitARCValueOperation(*this, value,
John McCallb04ecb72015-10-21 18:06:43 +00002251 CGM.getObjCEntrypoints().objc_retainAutorelease,
John McCall31168b02011-06-15 23:02:42 +00002252 "objc_retainAutorelease");
2253}
2254
John McCallb04ecb72015-10-21 18:06:43 +00002255/// i8* \@objc_loadWeak(i8** %addr)
2256/// Essentially objc_autorelease(objc_loadWeakRetained(addr)).
2257llvm::Value *CodeGenFunction::EmitARCLoadWeak(Address addr) {
2258 return emitARCLoadOperation(*this, addr,
2259 CGM.getObjCEntrypoints().objc_loadWeak,
2260 "objc_loadWeak");
2261}
2262
James Dennett14c41ea2012-06-22 05:41:30 +00002263/// i8* \@objc_loadWeakRetained(i8** %addr)
John McCall7f416cc2015-09-08 08:05:57 +00002264llvm::Value *CodeGenFunction::EmitARCLoadWeakRetained(Address addr) {
John McCall31168b02011-06-15 23:02:42 +00002265 return emitARCLoadOperation(*this, addr,
John McCallb04ecb72015-10-21 18:06:43 +00002266 CGM.getObjCEntrypoints().objc_loadWeakRetained,
John McCall31168b02011-06-15 23:02:42 +00002267 "objc_loadWeakRetained");
2268}
2269
James Dennett14c41ea2012-06-22 05:41:30 +00002270/// i8* \@objc_storeWeak(i8** %addr, i8* %value)
John McCall31168b02011-06-15 23:02:42 +00002271/// Returns %value.
John McCall7f416cc2015-09-08 08:05:57 +00002272llvm::Value *CodeGenFunction::EmitARCStoreWeak(Address addr,
John McCall31168b02011-06-15 23:02:42 +00002273 llvm::Value *value,
2274 bool ignored) {
2275 return emitARCStoreOperation(*this, addr, value,
John McCallb04ecb72015-10-21 18:06:43 +00002276 CGM.getObjCEntrypoints().objc_storeWeak,
John McCall31168b02011-06-15 23:02:42 +00002277 "objc_storeWeak", ignored);
2278}
2279
James Dennett14c41ea2012-06-22 05:41:30 +00002280/// i8* \@objc_initWeak(i8** %addr, i8* %value)
John McCall31168b02011-06-15 23:02:42 +00002281/// Returns %value. %addr is known to not have a current weak entry.
2282/// Essentially equivalent to:
2283/// *addr = nil; objc_storeWeak(addr, value);
John McCall7f416cc2015-09-08 08:05:57 +00002284void CodeGenFunction::EmitARCInitWeak(Address addr, llvm::Value *value) {
John McCall31168b02011-06-15 23:02:42 +00002285 // If we're initializing to null, just write null to memory; no need
2286 // to get the runtime involved. But don't do this if optimization
2287 // is enabled, because accounting for this would make the optimizer
2288 // much more complicated.
2289 if (isa<llvm::ConstantPointerNull>(value) &&
2290 CGM.getCodeGenOpts().OptimizationLevel == 0) {
2291 Builder.CreateStore(value, addr);
2292 return;
2293 }
2294
2295 emitARCStoreOperation(*this, addr, value,
John McCallb04ecb72015-10-21 18:06:43 +00002296 CGM.getObjCEntrypoints().objc_initWeak,
John McCall31168b02011-06-15 23:02:42 +00002297 "objc_initWeak", /*ignored*/ true);
2298}
2299
James Dennett14c41ea2012-06-22 05:41:30 +00002300/// void \@objc_destroyWeak(i8** %addr)
John McCall31168b02011-06-15 23:02:42 +00002301/// Essentially objc_storeWeak(addr, nil).
John McCall7f416cc2015-09-08 08:05:57 +00002302void CodeGenFunction::EmitARCDestroyWeak(Address addr) {
John McCallb04ecb72015-10-21 18:06:43 +00002303 llvm::Constant *&fn = CGM.getObjCEntrypoints().objc_destroyWeak;
John McCall31168b02011-06-15 23:02:42 +00002304 if (!fn) {
Chris Lattner2192fe52011-07-18 04:24:23 +00002305 llvm::FunctionType *fnType =
Benjamin Kramer95e19362013-03-07 21:18:31 +00002306 llvm::FunctionType::get(Builder.getVoidTy(), Int8PtrPtrTy, false);
John McCall31168b02011-06-15 23:02:42 +00002307 fn = createARCRuntimeFunction(CGM, fnType, "objc_destroyWeak");
2308 }
2309
2310 // Cast the argument to 'id*'.
2311 addr = Builder.CreateBitCast(addr, Int8PtrPtrTy);
2312
John McCall7f416cc2015-09-08 08:05:57 +00002313 EmitNounwindRuntimeCall(fn, addr.getPointer());
John McCall31168b02011-06-15 23:02:42 +00002314}
2315
James Dennett14c41ea2012-06-22 05:41:30 +00002316/// void \@objc_moveWeak(i8** %dest, i8** %src)
John McCall31168b02011-06-15 23:02:42 +00002317/// Disregards the current value in %dest. Leaves %src pointing to nothing.
2318/// Essentially (objc_copyWeak(dest, src), objc_destroyWeak(src)).
John McCall7f416cc2015-09-08 08:05:57 +00002319void CodeGenFunction::EmitARCMoveWeak(Address dst, Address src) {
John McCall31168b02011-06-15 23:02:42 +00002320 emitARCCopyOperation(*this, dst, src,
John McCallb04ecb72015-10-21 18:06:43 +00002321 CGM.getObjCEntrypoints().objc_moveWeak,
John McCall31168b02011-06-15 23:02:42 +00002322 "objc_moveWeak");
2323}
2324
James Dennett14c41ea2012-06-22 05:41:30 +00002325/// void \@objc_copyWeak(i8** %dest, i8** %src)
John McCall31168b02011-06-15 23:02:42 +00002326/// Disregards the current value in %dest. Essentially
2327/// objc_release(objc_initWeak(dest, objc_readWeakRetained(src)))
John McCall7f416cc2015-09-08 08:05:57 +00002328void CodeGenFunction::EmitARCCopyWeak(Address dst, Address src) {
John McCall31168b02011-06-15 23:02:42 +00002329 emitARCCopyOperation(*this, dst, src,
John McCallb04ecb72015-10-21 18:06:43 +00002330 CGM.getObjCEntrypoints().objc_copyWeak,
John McCall31168b02011-06-15 23:02:42 +00002331 "objc_copyWeak");
2332}
2333
2334/// Produce the code to do a objc_autoreleasepool_push.
James Dennett14c41ea2012-06-22 05:41:30 +00002335/// call i8* \@objc_autoreleasePoolPush(void)
John McCall31168b02011-06-15 23:02:42 +00002336llvm::Value *CodeGenFunction::EmitObjCAutoreleasePoolPush() {
John McCallb04ecb72015-10-21 18:06:43 +00002337 llvm::Constant *&fn = CGM.getObjCEntrypoints().objc_autoreleasePoolPush;
John McCall31168b02011-06-15 23:02:42 +00002338 if (!fn) {
Chris Lattner2192fe52011-07-18 04:24:23 +00002339 llvm::FunctionType *fnType =
John McCall31168b02011-06-15 23:02:42 +00002340 llvm::FunctionType::get(Int8PtrTy, false);
2341 fn = createARCRuntimeFunction(CGM, fnType, "objc_autoreleasePoolPush");
2342 }
2343
John McCall882987f2013-02-28 19:01:20 +00002344 return EmitNounwindRuntimeCall(fn);
John McCall31168b02011-06-15 23:02:42 +00002345}
2346
2347/// Produce the code to do a primitive release.
James Dennett14c41ea2012-06-22 05:41:30 +00002348/// call void \@objc_autoreleasePoolPop(i8* %ptr)
John McCall31168b02011-06-15 23:02:42 +00002349void CodeGenFunction::EmitObjCAutoreleasePoolPop(llvm::Value *value) {
2350 assert(value->getType() == Int8PtrTy);
2351
John McCallb04ecb72015-10-21 18:06:43 +00002352 llvm::Constant *&fn = CGM.getObjCEntrypoints().objc_autoreleasePoolPop;
John McCall31168b02011-06-15 23:02:42 +00002353 if (!fn) {
Chris Lattner2192fe52011-07-18 04:24:23 +00002354 llvm::FunctionType *fnType =
Benjamin Kramer95e19362013-03-07 21:18:31 +00002355 llvm::FunctionType::get(Builder.getVoidTy(), Int8PtrTy, false);
John McCall31168b02011-06-15 23:02:42 +00002356
2357 // We don't want to use a weak import here; instead we should not
2358 // fall into this path.
2359 fn = createARCRuntimeFunction(CGM, fnType, "objc_autoreleasePoolPop");
2360 }
2361
John McCallb7ff6db2013-04-16 21:29:40 +00002362 // objc_autoreleasePoolPop can throw.
2363 EmitRuntimeCallOrInvoke(fn, value);
John McCall31168b02011-06-15 23:02:42 +00002364}
2365
2366/// Produce the code to do an MRR version objc_autoreleasepool_push.
2367/// Which is: [[NSAutoreleasePool alloc] init];
2368/// Where alloc is declared as: + (id) alloc; in NSAutoreleasePool class.
2369/// init is declared as: - (id) init; in its NSObject super class.
2370///
2371llvm::Value *CodeGenFunction::EmitObjCMRRAutoreleasePoolPush() {
2372 CGObjCRuntime &Runtime = CGM.getObjCRuntime();
John McCall882987f2013-02-28 19:01:20 +00002373 llvm::Value *Receiver = Runtime.EmitNSAutoreleasePoolClassRef(*this);
John McCall31168b02011-06-15 23:02:42 +00002374 // [NSAutoreleasePool alloc]
2375 IdentifierInfo *II = &CGM.getContext().Idents.get("alloc");
2376 Selector AllocSel = getContext().Selectors.getSelector(0, &II);
2377 CallArgList Args;
2378 RValue AllocRV =
2379 Runtime.GenerateMessageSend(*this, ReturnValueSlot(),
2380 getContext().getObjCIdType(),
2381 AllocSel, Receiver, Args);
2382
2383 // [Receiver init]
2384 Receiver = AllocRV.getScalarVal();
2385 II = &CGM.getContext().Idents.get("init");
2386 Selector InitSel = getContext().Selectors.getSelector(0, &II);
2387 RValue InitRV =
2388 Runtime.GenerateMessageSend(*this, ReturnValueSlot(),
2389 getContext().getObjCIdType(),
2390 InitSel, Receiver, Args);
2391 return InitRV.getScalarVal();
2392}
2393
2394/// Produce the code to do a primitive release.
2395/// [tmp drain];
2396void CodeGenFunction::EmitObjCMRRAutoreleasePoolPop(llvm::Value *Arg) {
2397 IdentifierInfo *II = &CGM.getContext().Idents.get("drain");
2398 Selector DrainSel = getContext().Selectors.getSelector(0, &II);
2399 CallArgList Args;
2400 CGM.getObjCRuntime().GenerateMessageSend(*this, ReturnValueSlot(),
2401 getContext().VoidTy, DrainSel, Arg, Args);
2402}
2403
John McCall82fe67b2011-07-09 01:37:26 +00002404void CodeGenFunction::destroyARCStrongPrecise(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00002405 Address addr,
John McCall82fe67b2011-07-09 01:37:26 +00002406 QualType type) {
John McCallcdda29c2013-03-13 03:10:54 +00002407 CGF.EmitARCDestroyStrong(addr, ARCPreciseLifetime);
John McCall82fe67b2011-07-09 01:37:26 +00002408}
2409
2410void CodeGenFunction::destroyARCStrongImprecise(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00002411 Address addr,
John McCall82fe67b2011-07-09 01:37:26 +00002412 QualType type) {
John McCallcdda29c2013-03-13 03:10:54 +00002413 CGF.EmitARCDestroyStrong(addr, ARCImpreciseLifetime);
John McCall82fe67b2011-07-09 01:37:26 +00002414}
2415
2416void CodeGenFunction::destroyARCWeak(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00002417 Address addr,
John McCall82fe67b2011-07-09 01:37:26 +00002418 QualType type) {
2419 CGF.EmitARCDestroyWeak(addr);
2420}
2421
John McCall31168b02011-06-15 23:02:42 +00002422namespace {
David Blaikie7e70d682015-08-18 22:40:54 +00002423 struct CallObjCAutoreleasePoolObject final : EHScopeStack::Cleanup {
John McCall31168b02011-06-15 23:02:42 +00002424 llvm::Value *Token;
2425
2426 CallObjCAutoreleasePoolObject(llvm::Value *token) : Token(token) {}
2427
Craig Topper4f12f102014-03-12 06:41:41 +00002428 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall31168b02011-06-15 23:02:42 +00002429 CGF.EmitObjCAutoreleasePoolPop(Token);
2430 }
2431 };
David Blaikie7e70d682015-08-18 22:40:54 +00002432 struct CallObjCMRRAutoreleasePoolObject final : EHScopeStack::Cleanup {
John McCall31168b02011-06-15 23:02:42 +00002433 llvm::Value *Token;
2434
2435 CallObjCMRRAutoreleasePoolObject(llvm::Value *token) : Token(token) {}
2436
Craig Topper4f12f102014-03-12 06:41:41 +00002437 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall31168b02011-06-15 23:02:42 +00002438 CGF.EmitObjCMRRAutoreleasePoolPop(Token);
2439 }
2440 };
Alexander Kornienkoab9db512015-06-22 23:07:51 +00002441}
John McCall31168b02011-06-15 23:02:42 +00002442
2443void CodeGenFunction::EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr) {
David Blaikiebbafb8a2012-03-11 07:00:24 +00002444 if (CGM.getLangOpts().ObjCAutoRefCount)
John McCall31168b02011-06-15 23:02:42 +00002445 EHStack.pushCleanup<CallObjCAutoreleasePoolObject>(NormalCleanup, Ptr);
2446 else
2447 EHStack.pushCleanup<CallObjCMRRAutoreleasePoolObject>(NormalCleanup, Ptr);
2448}
2449
John McCall31168b02011-06-15 23:02:42 +00002450static TryEmitResult tryEmitARCRetainLoadOfScalar(CodeGenFunction &CGF,
2451 LValue lvalue,
2452 QualType type) {
2453 switch (type.getObjCLifetime()) {
2454 case Qualifiers::OCL_None:
2455 case Qualifiers::OCL_ExplicitNone:
2456 case Qualifiers::OCL_Strong:
2457 case Qualifiers::OCL_Autoreleasing:
Nick Lewycky2d84e842013-10-02 02:29:49 +00002458 return TryEmitResult(CGF.EmitLoadOfLValue(lvalue,
2459 SourceLocation()).getScalarVal(),
John McCall31168b02011-06-15 23:02:42 +00002460 false);
2461
2462 case Qualifiers::OCL_Weak:
2463 return TryEmitResult(CGF.EmitARCLoadWeakRetained(lvalue.getAddress()),
2464 true);
2465 }
2466
2467 llvm_unreachable("impossible lifetime!");
John McCall31168b02011-06-15 23:02:42 +00002468}
2469
2470static TryEmitResult tryEmitARCRetainLoadOfScalar(CodeGenFunction &CGF,
2471 const Expr *e) {
2472 e = e->IgnoreParens();
2473 QualType type = e->getType();
2474
John McCall154a2fd2011-08-30 00:57:29 +00002475 // If we're loading retained from a __strong xvalue, we can avoid
2476 // an extra retain/release pair by zeroing out the source of this
2477 // "move" operation.
2478 if (e->isXValue() &&
2479 !type.isConstQualified() &&
2480 type.getObjCLifetime() == Qualifiers::OCL_Strong) {
2481 // Emit the lvalue.
2482 LValue lv = CGF.EmitLValue(e);
2483
2484 // Load the object pointer.
Nick Lewycky2d84e842013-10-02 02:29:49 +00002485 llvm::Value *result = CGF.EmitLoadOfLValue(lv,
2486 SourceLocation()).getScalarVal();
John McCall154a2fd2011-08-30 00:57:29 +00002487
2488 // Set the source pointer to NULL.
2489 CGF.EmitStoreOfScalar(getNullForVariable(lv.getAddress()), lv);
2490
2491 return TryEmitResult(result, true);
2492 }
2493
John McCall31168b02011-06-15 23:02:42 +00002494 // As a very special optimization, in ARC++, if the l-value is the
2495 // result of a non-volatile assignment, do a simple retain of the
2496 // result of the call to objc_storeWeak instead of reloading.
David Blaikiebbafb8a2012-03-11 07:00:24 +00002497 if (CGF.getLangOpts().CPlusPlus &&
John McCall31168b02011-06-15 23:02:42 +00002498 !type.isVolatileQualified() &&
2499 type.getObjCLifetime() == Qualifiers::OCL_Weak &&
2500 isa<BinaryOperator>(e) &&
2501 cast<BinaryOperator>(e)->getOpcode() == BO_Assign)
2502 return TryEmitResult(CGF.EmitScalarExpr(e), false);
2503
2504 return tryEmitARCRetainLoadOfScalar(CGF, CGF.EmitLValue(e), type);
2505}
2506
John McCalle399e5b2016-01-27 18:32:30 +00002507typedef llvm::function_ref<llvm::Value *(CodeGenFunction &CGF,
2508 llvm::Value *value)>
2509 ValueTransform;
John McCall31168b02011-06-15 23:02:42 +00002510
John McCalle399e5b2016-01-27 18:32:30 +00002511/// Insert code immediately after a call.
2512static llvm::Value *emitARCOperationAfterCall(CodeGenFunction &CGF,
2513 llvm::Value *value,
2514 ValueTransform doAfterCall,
2515 ValueTransform doFallback) {
John McCall31168b02011-06-15 23:02:42 +00002516 if (llvm::CallInst *call = dyn_cast<llvm::CallInst>(value)) {
2517 CGBuilderTy::InsertPoint ip = CGF.Builder.saveIP();
2518
2519 // Place the retain immediately following the call.
2520 CGF.Builder.SetInsertPoint(call->getParent(),
2521 ++llvm::BasicBlock::iterator(call));
John McCalle399e5b2016-01-27 18:32:30 +00002522 value = doAfterCall(CGF, value);
John McCall31168b02011-06-15 23:02:42 +00002523
2524 CGF.Builder.restoreIP(ip);
2525 return value;
2526 } else if (llvm::InvokeInst *invoke = dyn_cast<llvm::InvokeInst>(value)) {
2527 CGBuilderTy::InsertPoint ip = CGF.Builder.saveIP();
2528
2529 // Place the retain at the beginning of the normal destination block.
2530 llvm::BasicBlock *BB = invoke->getNormalDest();
2531 CGF.Builder.SetInsertPoint(BB, BB->begin());
John McCalle399e5b2016-01-27 18:32:30 +00002532 value = doAfterCall(CGF, value);
John McCall31168b02011-06-15 23:02:42 +00002533
2534 CGF.Builder.restoreIP(ip);
2535 return value;
2536
2537 // Bitcasts can arise because of related-result returns. Rewrite
2538 // the operand.
2539 } else if (llvm::BitCastInst *bitcast = dyn_cast<llvm::BitCastInst>(value)) {
2540 llvm::Value *operand = bitcast->getOperand(0);
John McCalle399e5b2016-01-27 18:32:30 +00002541 operand = emitARCOperationAfterCall(CGF, operand, doAfterCall, doFallback);
John McCall31168b02011-06-15 23:02:42 +00002542 bitcast->setOperand(0, operand);
2543 return bitcast;
2544
2545 // Generic fall-back case.
2546 } else {
2547 // Retain using the non-block variant: we never need to do a copy
2548 // of a block that's been returned to us.
John McCalle399e5b2016-01-27 18:32:30 +00002549 return doFallback(CGF, value);
2550 }
2551}
2552
2553/// Given that the given expression is some sort of call (which does
2554/// not return retained), emit a retain following it.
2555static llvm::Value *emitARCRetainCallResult(CodeGenFunction &CGF,
2556 const Expr *e) {
2557 llvm::Value *value = CGF.EmitScalarExpr(e);
2558 return emitARCOperationAfterCall(CGF, value,
2559 [](CodeGenFunction &CGF, llvm::Value *value) {
2560 return CGF.EmitARCRetainAutoreleasedReturnValue(value);
2561 },
2562 [](CodeGenFunction &CGF, llvm::Value *value) {
2563 return CGF.EmitARCRetainNonBlock(value);
2564 });
2565}
2566
2567/// Given that the given expression is some sort of call (which does
2568/// not return retained), perform an unsafeClaim following it.
2569static llvm::Value *emitARCUnsafeClaimCallResult(CodeGenFunction &CGF,
2570 const Expr *e) {
2571 llvm::Value *value = CGF.EmitScalarExpr(e);
2572 return emitARCOperationAfterCall(CGF, value,
2573 [](CodeGenFunction &CGF, llvm::Value *value) {
2574 return CGF.EmitARCUnsafeClaimAutoreleasedReturnValue(value);
2575 },
2576 [](CodeGenFunction &CGF, llvm::Value *value) {
2577 return value;
2578 });
2579}
2580
2581llvm::Value *CodeGenFunction::EmitARCReclaimReturnedObject(const Expr *E,
2582 bool allowUnsafeClaim) {
2583 if (allowUnsafeClaim &&
2584 CGM.getLangOpts().ObjCRuntime.hasARCUnsafeClaimAutoreleasedReturnValue()) {
2585 return emitARCUnsafeClaimCallResult(*this, E);
2586 } else {
2587 llvm::Value *value = emitARCRetainCallResult(*this, E);
2588 return EmitObjCConsumeObject(E->getType(), value);
John McCall31168b02011-06-15 23:02:42 +00002589 }
2590}
2591
John McCallcd78e802011-09-10 01:16:55 +00002592/// Determine whether it might be important to emit a separate
2593/// objc_retain_block on the result of the given expression, or
2594/// whether it's okay to just emit it in a +1 context.
2595static bool shouldEmitSeparateBlockRetain(const Expr *e) {
2596 assert(e->getType()->isBlockPointerType());
2597 e = e->IgnoreParens();
2598
2599 // For future goodness, emit block expressions directly in +1
2600 // contexts if we can.
2601 if (isa<BlockExpr>(e))
2602 return false;
2603
2604 if (const CastExpr *cast = dyn_cast<CastExpr>(e)) {
2605 switch (cast->getCastKind()) {
2606 // Emitting these operations in +1 contexts is goodness.
2607 case CK_LValueToRValue:
John McCall2d637d22011-09-10 06:18:15 +00002608 case CK_ARCReclaimReturnedObject:
2609 case CK_ARCConsumeObject:
2610 case CK_ARCProduceObject:
John McCallcd78e802011-09-10 01:16:55 +00002611 return false;
2612
2613 // These operations preserve a block type.
2614 case CK_NoOp:
2615 case CK_BitCast:
2616 return shouldEmitSeparateBlockRetain(cast->getSubExpr());
2617
2618 // These operations are known to be bad (or haven't been considered).
2619 case CK_AnyPointerToBlockPointerCast:
2620 default:
2621 return true;
2622 }
2623 }
2624
2625 return true;
2626}
2627
John McCalle399e5b2016-01-27 18:32:30 +00002628namespace {
2629/// A CRTP base class for emitting expressions of retainable object
2630/// pointer type in ARC.
2631template <typename Impl, typename Result> class ARCExprEmitter {
2632protected:
2633 CodeGenFunction &CGF;
2634 Impl &asImpl() { return *static_cast<Impl*>(this); }
2635
2636 ARCExprEmitter(CodeGenFunction &CGF) : CGF(CGF) {}
2637
2638public:
2639 Result visit(const Expr *e);
2640 Result visitCastExpr(const CastExpr *e);
2641 Result visitPseudoObjectExpr(const PseudoObjectExpr *e);
2642 Result visitBinaryOperator(const BinaryOperator *e);
2643 Result visitBinAssign(const BinaryOperator *e);
2644 Result visitBinAssignUnsafeUnretained(const BinaryOperator *e);
2645 Result visitBinAssignAutoreleasing(const BinaryOperator *e);
2646 Result visitBinAssignWeak(const BinaryOperator *e);
2647 Result visitBinAssignStrong(const BinaryOperator *e);
2648
2649 // Minimal implementation:
2650 // Result visitLValueToRValue(const Expr *e)
2651 // Result visitConsumeObject(const Expr *e)
2652 // Result visitExtendBlockObject(const Expr *e)
2653 // Result visitReclaimReturnedObject(const Expr *e)
2654 // Result visitCall(const Expr *e)
2655 // Result visitExpr(const Expr *e)
2656 //
2657 // Result emitBitCast(Result result, llvm::Type *resultType)
2658 // llvm::Value *getValueOfResult(Result result)
2659};
2660}
2661
2662/// Try to emit a PseudoObjectExpr under special ARC rules.
John McCallfe96e0b2011-11-06 09:01:30 +00002663///
2664/// This massively duplicates emitPseudoObjectRValue.
John McCalle399e5b2016-01-27 18:32:30 +00002665template <typename Impl, typename Result>
2666Result
2667ARCExprEmitter<Impl,Result>::visitPseudoObjectExpr(const PseudoObjectExpr *E) {
Dmitri Gribenkof8579502013-01-12 19:30:44 +00002668 SmallVector<CodeGenFunction::OpaqueValueMappingData, 4> opaques;
John McCallfe96e0b2011-11-06 09:01:30 +00002669
2670 // Find the result expression.
2671 const Expr *resultExpr = E->getResultExpr();
2672 assert(resultExpr);
John McCalle399e5b2016-01-27 18:32:30 +00002673 Result result;
John McCallfe96e0b2011-11-06 09:01:30 +00002674
2675 for (PseudoObjectExpr::const_semantics_iterator
2676 i = E->semantics_begin(), e = E->semantics_end(); i != e; ++i) {
2677 const Expr *semantic = *i;
2678
2679 // If this semantic expression is an opaque value, bind it
2680 // to the result of its source expression.
2681 if (const OpaqueValueExpr *ov = dyn_cast<OpaqueValueExpr>(semantic)) {
2682 typedef CodeGenFunction::OpaqueValueMappingData OVMA;
2683 OVMA opaqueData;
2684
2685 // If this semantic is the result of the pseudo-object
2686 // expression, try to evaluate the source as +1.
2687 if (ov == resultExpr) {
2688 assert(!OVMA::shouldBindAsLValue(ov));
John McCalle399e5b2016-01-27 18:32:30 +00002689 result = asImpl().visit(ov->getSourceExpr());
2690 opaqueData = OVMA::bind(CGF, ov,
2691 RValue::get(asImpl().getValueOfResult(result)));
John McCallfe96e0b2011-11-06 09:01:30 +00002692
2693 // Otherwise, just bind it.
2694 } else {
2695 opaqueData = OVMA::bind(CGF, ov, ov->getSourceExpr());
2696 }
2697 opaques.push_back(opaqueData);
2698
2699 // Otherwise, if the expression is the result, evaluate it
2700 // and remember the result.
2701 } else if (semantic == resultExpr) {
John McCalle399e5b2016-01-27 18:32:30 +00002702 result = asImpl().visit(semantic);
John McCallfe96e0b2011-11-06 09:01:30 +00002703
2704 // Otherwise, evaluate the expression in an ignored context.
2705 } else {
2706 CGF.EmitIgnoredExpr(semantic);
2707 }
2708 }
2709
2710 // Unbind all the opaques now.
2711 for (unsigned i = 0, e = opaques.size(); i != e; ++i)
2712 opaques[i].unbind(CGF);
2713
2714 return result;
2715}
2716
John McCalle399e5b2016-01-27 18:32:30 +00002717template <typename Impl, typename Result>
2718Result ARCExprEmitter<Impl,Result>::visitCastExpr(const CastExpr *e) {
2719 switch (e->getCastKind()) {
John McCall53848232011-07-27 01:07:15 +00002720
John McCalle399e5b2016-01-27 18:32:30 +00002721 // No-op casts don't change the type, so we just ignore them.
2722 case CK_NoOp:
2723 return asImpl().visit(e->getSubExpr());
John McCall31168b02011-06-15 23:02:42 +00002724
John McCalle399e5b2016-01-27 18:32:30 +00002725 // These casts can change the type.
2726 case CK_CPointerToObjCPointerCast:
2727 case CK_BlockPointerToObjCPointerCast:
2728 case CK_AnyPointerToBlockPointerCast:
2729 case CK_BitCast: {
2730 llvm::Type *resultType = CGF.ConvertType(e->getType());
2731 assert(e->getSubExpr()->getType()->hasPointerRepresentation());
2732 Result result = asImpl().visit(e->getSubExpr());
2733 return asImpl().emitBitCast(result, resultType);
John McCall31168b02011-06-15 23:02:42 +00002734 }
2735
John McCalle399e5b2016-01-27 18:32:30 +00002736 // Handle some casts specially.
2737 case CK_LValueToRValue:
2738 return asImpl().visitLValueToRValue(e->getSubExpr());
2739 case CK_ARCConsumeObject:
2740 return asImpl().visitConsumeObject(e->getSubExpr());
2741 case CK_ARCExtendBlockObject:
2742 return asImpl().visitExtendBlockObject(e->getSubExpr());
2743 case CK_ARCReclaimReturnedObject:
2744 return asImpl().visitReclaimReturnedObject(e->getSubExpr());
2745
2746 // Otherwise, use the default logic.
2747 default:
2748 return asImpl().visitExpr(e);
2749 }
2750}
2751
2752template <typename Impl, typename Result>
2753Result
2754ARCExprEmitter<Impl,Result>::visitBinaryOperator(const BinaryOperator *e) {
2755 switch (e->getOpcode()) {
2756 case BO_Comma:
2757 CGF.EmitIgnoredExpr(e->getLHS());
2758 CGF.EnsureInsertPoint();
2759 return asImpl().visit(e->getRHS());
2760
2761 case BO_Assign:
2762 return asImpl().visitBinAssign(e);
2763
2764 default:
2765 return asImpl().visitExpr(e);
2766 }
2767}
2768
2769template <typename Impl, typename Result>
2770Result ARCExprEmitter<Impl,Result>::visitBinAssign(const BinaryOperator *e) {
2771 switch (e->getLHS()->getType().getObjCLifetime()) {
2772 case Qualifiers::OCL_ExplicitNone:
2773 return asImpl().visitBinAssignUnsafeUnretained(e);
2774
2775 case Qualifiers::OCL_Weak:
2776 return asImpl().visitBinAssignWeak(e);
2777
2778 case Qualifiers::OCL_Autoreleasing:
2779 return asImpl().visitBinAssignAutoreleasing(e);
2780
2781 case Qualifiers::OCL_Strong:
2782 return asImpl().visitBinAssignStrong(e);
2783
2784 case Qualifiers::OCL_None:
2785 return asImpl().visitExpr(e);
2786 }
2787 llvm_unreachable("bad ObjC ownership qualifier");
2788}
2789
2790/// The default rule for __unsafe_unretained emits the RHS recursively,
2791/// stores into the unsafe variable, and propagates the result outward.
2792template <typename Impl, typename Result>
2793Result ARCExprEmitter<Impl,Result>::
2794 visitBinAssignUnsafeUnretained(const BinaryOperator *e) {
2795 // Recursively emit the RHS.
2796 // For __block safety, do this before emitting the LHS.
2797 Result result = asImpl().visit(e->getRHS());
2798
2799 // Perform the store.
2800 LValue lvalue =
2801 CGF.EmitCheckedLValue(e->getLHS(), CodeGenFunction::TCK_Store);
2802 CGF.EmitStoreThroughLValue(RValue::get(asImpl().getValueOfResult(result)),
2803 lvalue);
2804
2805 return result;
2806}
2807
2808template <typename Impl, typename Result>
2809Result
2810ARCExprEmitter<Impl,Result>::visitBinAssignAutoreleasing(const BinaryOperator *e) {
2811 return asImpl().visitExpr(e);
2812}
2813
2814template <typename Impl, typename Result>
2815Result
2816ARCExprEmitter<Impl,Result>::visitBinAssignWeak(const BinaryOperator *e) {
2817 return asImpl().visitExpr(e);
2818}
2819
2820template <typename Impl, typename Result>
2821Result
2822ARCExprEmitter<Impl,Result>::visitBinAssignStrong(const BinaryOperator *e) {
2823 return asImpl().visitExpr(e);
2824}
2825
2826/// The general expression-emission logic.
2827template <typename Impl, typename Result>
2828Result ARCExprEmitter<Impl,Result>::visit(const Expr *e) {
2829 // We should *never* see a nested full-expression here, because if
2830 // we fail to emit at +1, our caller must not retain after we close
2831 // out the full-expression. This isn't as important in the unsafe
2832 // emitter.
2833 assert(!isa<ExprWithCleanups>(e));
2834
2835 // Look through parens, __extension__, generic selection, etc.
2836 e = e->IgnoreParens();
2837
2838 // Handle certain kinds of casts.
2839 if (const CastExpr *ce = dyn_cast<CastExpr>(e)) {
2840 return asImpl().visitCastExpr(ce);
2841
2842 // Handle the comma operator.
2843 } else if (auto op = dyn_cast<BinaryOperator>(e)) {
2844 return asImpl().visitBinaryOperator(op);
2845
2846 // TODO: handle conditional operators here
2847
2848 // For calls and message sends, use the retained-call logic.
2849 // Delegate inits are a special case in that they're the only
2850 // returns-retained expression that *isn't* surrounded by
2851 // a consume.
2852 } else if (isa<CallExpr>(e) ||
2853 (isa<ObjCMessageExpr>(e) &&
2854 !cast<ObjCMessageExpr>(e)->isDelegateInitCall())) {
2855 return asImpl().visitCall(e);
2856
2857 // Look through pseudo-object expressions.
2858 } else if (const PseudoObjectExpr *pseudo = dyn_cast<PseudoObjectExpr>(e)) {
2859 return asImpl().visitPseudoObjectExpr(pseudo);
2860 }
2861
2862 return asImpl().visitExpr(e);
2863}
2864
2865namespace {
2866
2867/// An emitter for +1 results.
2868struct ARCRetainExprEmitter :
2869 public ARCExprEmitter<ARCRetainExprEmitter, TryEmitResult> {
2870
2871 ARCRetainExprEmitter(CodeGenFunction &CGF) : ARCExprEmitter(CGF) {}
2872
2873 llvm::Value *getValueOfResult(TryEmitResult result) {
2874 return result.getPointer();
2875 }
2876
2877 TryEmitResult emitBitCast(TryEmitResult result, llvm::Type *resultType) {
2878 llvm::Value *value = result.getPointer();
2879 value = CGF.Builder.CreateBitCast(value, resultType);
2880 result.setPointer(value);
2881 return result;
2882 }
2883
2884 TryEmitResult visitLValueToRValue(const Expr *e) {
2885 return tryEmitARCRetainLoadOfScalar(CGF, e);
2886 }
2887
2888 /// For consumptions, just emit the subexpression and thus elide
2889 /// the retain/release pair.
2890 TryEmitResult visitConsumeObject(const Expr *e) {
2891 llvm::Value *result = CGF.EmitScalarExpr(e);
2892 return TryEmitResult(result, true);
2893 }
2894
2895 /// Block extends are net +0. Naively, we could just recurse on
2896 /// the subexpression, but actually we need to ensure that the
2897 /// value is copied as a block, so there's a little filter here.
2898 TryEmitResult visitExtendBlockObject(const Expr *e) {
2899 llvm::Value *result; // will be a +0 value
2900
2901 // If we can't safely assume the sub-expression will produce a
2902 // block-copied value, emit the sub-expression at +0.
2903 if (shouldEmitSeparateBlockRetain(e)) {
2904 result = CGF.EmitScalarExpr(e);
2905
2906 // Otherwise, try to emit the sub-expression at +1 recursively.
2907 } else {
2908 TryEmitResult subresult = asImpl().visit(e);
2909
2910 // If that produced a retained value, just use that.
2911 if (subresult.getInt()) {
2912 return subresult;
2913 }
2914
2915 // Otherwise it's +0.
2916 result = subresult.getPointer();
2917 }
2918
2919 // Retain the object as a block.
2920 result = CGF.EmitARCRetainBlock(result, /*mandatory*/ true);
2921 return TryEmitResult(result, true);
2922 }
2923
2924 /// For reclaims, emit the subexpression as a retained call and
2925 /// skip the consumption.
2926 TryEmitResult visitReclaimReturnedObject(const Expr *e) {
2927 llvm::Value *result = emitARCRetainCallResult(CGF, e);
2928 return TryEmitResult(result, true);
2929 }
2930
2931 /// When we have an undecorated call, retroactively do a claim.
2932 TryEmitResult visitCall(const Expr *e) {
2933 llvm::Value *result = emitARCRetainCallResult(CGF, e);
2934 return TryEmitResult(result, true);
2935 }
2936
2937 // TODO: maybe special-case visitBinAssignWeak?
2938
2939 TryEmitResult visitExpr(const Expr *e) {
2940 // We didn't find an obvious production, so emit what we've got and
2941 // tell the caller that we didn't manage to retain.
2942 llvm::Value *result = CGF.EmitScalarExpr(e);
2943 return TryEmitResult(result, false);
2944 }
2945};
2946}
2947
2948static TryEmitResult
2949tryEmitARCRetainScalarExpr(CodeGenFunction &CGF, const Expr *e) {
2950 return ARCRetainExprEmitter(CGF).visit(e);
John McCall31168b02011-06-15 23:02:42 +00002951}
2952
2953static llvm::Value *emitARCRetainLoadOfScalar(CodeGenFunction &CGF,
2954 LValue lvalue,
2955 QualType type) {
2956 TryEmitResult result = tryEmitARCRetainLoadOfScalar(CGF, lvalue, type);
2957 llvm::Value *value = result.getPointer();
2958 if (!result.getInt())
2959 value = CGF.EmitARCRetain(type, value);
2960 return value;
2961}
2962
2963/// EmitARCRetainScalarExpr - Semantically equivalent to
2964/// EmitARCRetainObject(e->getType(), EmitScalarExpr(e)), but making a
2965/// best-effort attempt to peephole expressions that naturally produce
2966/// retained objects.
2967llvm::Value *CodeGenFunction::EmitARCRetainScalarExpr(const Expr *e) {
John McCalld21cdd42013-02-12 00:25:08 +00002968 // The retain needs to happen within the full-expression.
2969 if (const ExprWithCleanups *cleanups = dyn_cast<ExprWithCleanups>(e)) {
2970 enterFullExpression(cleanups);
2971 RunCleanupsScope scope(*this);
2972 return EmitARCRetainScalarExpr(cleanups->getSubExpr());
2973 }
2974
John McCall31168b02011-06-15 23:02:42 +00002975 TryEmitResult result = tryEmitARCRetainScalarExpr(*this, e);
2976 llvm::Value *value = result.getPointer();
2977 if (!result.getInt())
2978 value = EmitARCRetain(e->getType(), value);
2979 return value;
2980}
2981
2982llvm::Value *
2983CodeGenFunction::EmitARCRetainAutoreleaseScalarExpr(const Expr *e) {
John McCalld21cdd42013-02-12 00:25:08 +00002984 // The retain needs to happen within the full-expression.
2985 if (const ExprWithCleanups *cleanups = dyn_cast<ExprWithCleanups>(e)) {
2986 enterFullExpression(cleanups);
2987 RunCleanupsScope scope(*this);
2988 return EmitARCRetainAutoreleaseScalarExpr(cleanups->getSubExpr());
2989 }
2990
John McCall31168b02011-06-15 23:02:42 +00002991 TryEmitResult result = tryEmitARCRetainScalarExpr(*this, e);
2992 llvm::Value *value = result.getPointer();
2993 if (result.getInt())
2994 value = EmitARCAutorelease(value);
2995 else
2996 value = EmitARCRetainAutorelease(e->getType(), value);
2997 return value;
2998}
2999
John McCallff613032011-10-04 06:23:45 +00003000llvm::Value *CodeGenFunction::EmitARCExtendBlockObject(const Expr *e) {
3001 llvm::Value *result;
3002 bool doRetain;
3003
3004 if (shouldEmitSeparateBlockRetain(e)) {
3005 result = EmitScalarExpr(e);
3006 doRetain = true;
3007 } else {
3008 TryEmitResult subresult = tryEmitARCRetainScalarExpr(*this, e);
3009 result = subresult.getPointer();
3010 doRetain = !subresult.getInt();
3011 }
3012
3013 if (doRetain)
3014 result = EmitARCRetainBlock(result, /*mandatory*/ true);
3015 return EmitObjCConsumeObject(e->getType(), result);
3016}
3017
John McCall248512a2011-10-01 10:32:24 +00003018llvm::Value *CodeGenFunction::EmitObjCThrowOperand(const Expr *expr) {
3019 // In ARC, retain and autorelease the expression.
David Blaikiebbafb8a2012-03-11 07:00:24 +00003020 if (getLangOpts().ObjCAutoRefCount) {
John McCall248512a2011-10-01 10:32:24 +00003021 // Do so before running any cleanups for the full-expression.
John McCalld21cdd42013-02-12 00:25:08 +00003022 // EmitARCRetainAutoreleaseScalarExpr does this for us.
John McCall248512a2011-10-01 10:32:24 +00003023 return EmitARCRetainAutoreleaseScalarExpr(expr);
3024 }
3025
3026 // Otherwise, use the normal scalar-expression emission. The
3027 // exception machinery doesn't do anything special with the
3028 // exception like retaining it, so there's no safety associated with
3029 // only running cleanups after the throw has started, and when it
3030 // matters it tends to be substantially inferior code.
3031 return EmitScalarExpr(expr);
3032}
3033
John McCalle399e5b2016-01-27 18:32:30 +00003034namespace {
3035
3036/// An emitter for assigning into an __unsafe_unretained context.
3037struct ARCUnsafeUnretainedExprEmitter :
3038 public ARCExprEmitter<ARCUnsafeUnretainedExprEmitter, llvm::Value*> {
3039
3040 ARCUnsafeUnretainedExprEmitter(CodeGenFunction &CGF) : ARCExprEmitter(CGF) {}
3041
3042 llvm::Value *getValueOfResult(llvm::Value *value) {
3043 return value;
3044 }
3045
3046 llvm::Value *emitBitCast(llvm::Value *value, llvm::Type *resultType) {
3047 return CGF.Builder.CreateBitCast(value, resultType);
3048 }
3049
3050 llvm::Value *visitLValueToRValue(const Expr *e) {
3051 return CGF.EmitScalarExpr(e);
3052 }
3053
3054 /// For consumptions, just emit the subexpression and perform the
3055 /// consumption like normal.
3056 llvm::Value *visitConsumeObject(const Expr *e) {
3057 llvm::Value *value = CGF.EmitScalarExpr(e);
3058 return CGF.EmitObjCConsumeObject(e->getType(), value);
3059 }
3060
3061 /// No special logic for block extensions. (This probably can't
3062 /// actually happen in this emitter, though.)
3063 llvm::Value *visitExtendBlockObject(const Expr *e) {
3064 return CGF.EmitARCExtendBlockObject(e);
3065 }
3066
3067 /// For reclaims, perform an unsafeClaim if that's enabled.
3068 llvm::Value *visitReclaimReturnedObject(const Expr *e) {
3069 return CGF.EmitARCReclaimReturnedObject(e, /*unsafe*/ true);
3070 }
3071
3072 /// When we have an undecorated call, just emit it without adding
3073 /// the unsafeClaim.
3074 llvm::Value *visitCall(const Expr *e) {
3075 return CGF.EmitScalarExpr(e);
3076 }
3077
3078 /// Just do normal scalar emission in the default case.
3079 llvm::Value *visitExpr(const Expr *e) {
3080 return CGF.EmitScalarExpr(e);
3081 }
3082};
3083}
3084
3085static llvm::Value *emitARCUnsafeUnretainedScalarExpr(CodeGenFunction &CGF,
3086 const Expr *e) {
3087 return ARCUnsafeUnretainedExprEmitter(CGF).visit(e);
3088}
3089
3090/// EmitARCUnsafeUnretainedScalarExpr - Semantically equivalent to
3091/// immediately releasing the resut of EmitARCRetainScalarExpr, but
3092/// avoiding any spurious retains, including by performing reclaims
3093/// with objc_unsafeClaimAutoreleasedReturnValue.
3094llvm::Value *CodeGenFunction::EmitARCUnsafeUnretainedScalarExpr(const Expr *e) {
3095 // Look through full-expressions.
3096 if (const ExprWithCleanups *cleanups = dyn_cast<ExprWithCleanups>(e)) {
3097 enterFullExpression(cleanups);
3098 RunCleanupsScope scope(*this);
3099 return emitARCUnsafeUnretainedScalarExpr(*this, cleanups->getSubExpr());
3100 }
3101
3102 return emitARCUnsafeUnretainedScalarExpr(*this, e);
3103}
3104
3105std::pair<LValue,llvm::Value*>
3106CodeGenFunction::EmitARCStoreUnsafeUnretained(const BinaryOperator *e,
3107 bool ignored) {
3108 // Evaluate the RHS first. If we're ignoring the result, assume
3109 // that we can emit at an unsafe +0.
3110 llvm::Value *value;
3111 if (ignored) {
3112 value = EmitARCUnsafeUnretainedScalarExpr(e->getRHS());
3113 } else {
3114 value = EmitScalarExpr(e->getRHS());
3115 }
3116
3117 // Emit the LHS and perform the store.
3118 LValue lvalue = EmitLValue(e->getLHS());
3119 EmitStoreOfScalar(value, lvalue);
3120
3121 return std::pair<LValue,llvm::Value*>(std::move(lvalue), value);
3122}
3123
John McCall31168b02011-06-15 23:02:42 +00003124std::pair<LValue,llvm::Value*>
3125CodeGenFunction::EmitARCStoreStrong(const BinaryOperator *e,
3126 bool ignored) {
3127 // Evaluate the RHS first.
3128 TryEmitResult result = tryEmitARCRetainScalarExpr(*this, e->getRHS());
3129 llvm::Value *value = result.getPointer();
3130
John McCallb726a552011-07-28 07:23:35 +00003131 bool hasImmediateRetain = result.getInt();
3132
3133 // If we didn't emit a retained object, and the l-value is of block
3134 // type, then we need to emit the block-retain immediately in case
3135 // it invalidates the l-value.
3136 if (!hasImmediateRetain && e->getType()->isBlockPointerType()) {
John McCallff613032011-10-04 06:23:45 +00003137 value = EmitARCRetainBlock(value, /*mandatory*/ false);
John McCallb726a552011-07-28 07:23:35 +00003138 hasImmediateRetain = true;
3139 }
3140
John McCall31168b02011-06-15 23:02:42 +00003141 LValue lvalue = EmitLValue(e->getLHS());
3142
3143 // If the RHS was emitted retained, expand this.
John McCallb726a552011-07-28 07:23:35 +00003144 if (hasImmediateRetain) {
Nick Lewyckyce550072013-10-02 02:33:11 +00003145 llvm::Value *oldValue = EmitLoadOfScalar(lvalue, SourceLocation());
Eli Friedmana0544d62011-12-03 04:14:32 +00003146 EmitStoreOfScalar(value, lvalue);
John McCallcdda29c2013-03-13 03:10:54 +00003147 EmitARCRelease(oldValue, lvalue.isARCPreciseLifetime());
John McCall31168b02011-06-15 23:02:42 +00003148 } else {
John McCall55e1fbc2011-06-25 02:11:03 +00003149 value = EmitARCStoreStrong(lvalue, value, ignored);
John McCall31168b02011-06-15 23:02:42 +00003150 }
3151
3152 return std::pair<LValue,llvm::Value*>(lvalue, value);
3153}
3154
3155std::pair<LValue,llvm::Value*>
3156CodeGenFunction::EmitARCStoreAutoreleasing(const BinaryOperator *e) {
3157 llvm::Value *value = EmitARCRetainAutoreleaseScalarExpr(e->getRHS());
3158 LValue lvalue = EmitLValue(e->getLHS());
3159
Eli Friedmana0544d62011-12-03 04:14:32 +00003160 EmitStoreOfScalar(value, lvalue);
John McCall31168b02011-06-15 23:02:42 +00003161
3162 return std::pair<LValue,llvm::Value*>(lvalue, value);
3163}
3164
3165void CodeGenFunction::EmitObjCAutoreleasePoolStmt(
Eric Christopher5d2b8d92012-03-29 17:31:31 +00003166 const ObjCAutoreleasePoolStmt &ARPS) {
John McCall31168b02011-06-15 23:02:42 +00003167 const Stmt *subStmt = ARPS.getSubStmt();
3168 const CompoundStmt &S = cast<CompoundStmt>(*subStmt);
3169
3170 CGDebugInfo *DI = getDebugInfo();
Eric Christopher7cdf9482011-10-13 21:45:18 +00003171 if (DI)
3172 DI->EmitLexicalBlockStart(Builder, S.getLBracLoc());
John McCall31168b02011-06-15 23:02:42 +00003173
3174 // Keep track of the current cleanup stack depth.
3175 RunCleanupsScope Scope(*this);
John McCall3deb1ad2012-08-21 02:47:43 +00003176 if (CGM.getLangOpts().ObjCRuntime.hasNativeARC()) {
John McCall31168b02011-06-15 23:02:42 +00003177 llvm::Value *token = EmitObjCAutoreleasePoolPush();
3178 EHStack.pushCleanup<CallObjCAutoreleasePoolObject>(NormalCleanup, token);
3179 } else {
3180 llvm::Value *token = EmitObjCMRRAutoreleasePoolPush();
3181 EHStack.pushCleanup<CallObjCMRRAutoreleasePoolObject>(NormalCleanup, token);
3182 }
3183
Aaron Ballmanc7e4e212014-03-17 14:19:37 +00003184 for (const auto *I : S.body())
3185 EmitStmt(I);
John McCall31168b02011-06-15 23:02:42 +00003186
Eric Christopher7cdf9482011-10-13 21:45:18 +00003187 if (DI)
3188 DI->EmitLexicalBlockEnd(Builder, S.getRBracLoc());
John McCall31168b02011-06-15 23:02:42 +00003189}
John McCall1bd25562011-06-24 23:21:27 +00003190
3191/// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
3192/// make sure it survives garbage collection until this point.
3193void CodeGenFunction::EmitExtendGCLifetime(llvm::Value *object) {
3194 // We just use an inline assembly.
John McCall1bd25562011-06-24 23:21:27 +00003195 llvm::FunctionType *extenderType
John McCalla729c622012-02-17 03:33:10 +00003196 = llvm::FunctionType::get(VoidTy, VoidPtrTy, RequiredArgs::All);
John McCall1bd25562011-06-24 23:21:27 +00003197 llvm::Value *extender
3198 = llvm::InlineAsm::get(extenderType,
3199 /* assembly */ "",
3200 /* constraints */ "r",
3201 /* side effects */ true);
3202
3203 object = Builder.CreateBitCast(object, VoidPtrTy);
John McCall882987f2013-02-28 19:01:20 +00003204 EmitNounwindRuntimeCall(extender, object);
John McCall1bd25562011-06-24 23:21:27 +00003205}
3206
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003207/// GenerateObjCAtomicSetterCopyHelperFunction - Given a c++ object type with
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003208/// non-trivial copy assignment function, produce following helper function.
3209/// static void copyHelper(Ty *dest, const Ty *source) { *dest = *source; }
3210///
3211llvm::Constant *
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003212CodeGenFunction::GenerateObjCAtomicSetterCopyHelperFunction(
3213 const ObjCPropertyImplDecl *PID) {
John McCall5fb5df92012-06-20 06:18:46 +00003214 if (!getLangOpts().CPlusPlus ||
Rafael Espindolad727d3d2012-12-18 04:29:34 +00003215 !getLangOpts().ObjCRuntime.hasAtomicCopyHelper())
Craig Topper8a13c412014-05-21 05:09:00 +00003216 return nullptr;
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003217 QualType Ty = PID->getPropertyIvarDecl()->getType();
3218 if (!Ty->isRecordType())
Craig Topper8a13c412014-05-21 05:09:00 +00003219 return nullptr;
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003220 const ObjCPropertyDecl *PD = PID->getPropertyDecl();
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003221 if ((!(PD->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_atomic)))
Craig Topper8a13c412014-05-21 05:09:00 +00003222 return nullptr;
3223 llvm::Constant *HelperFn = nullptr;
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003224 if (hasTrivialSetExpr(PID))
Craig Topper8a13c412014-05-21 05:09:00 +00003225 return nullptr;
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003226 assert(PID->getSetterCXXAssignment() && "SetterCXXAssignment - null");
3227 if ((HelperFn = CGM.getAtomicSetterHelperFnMap(Ty)))
3228 return HelperFn;
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003229
3230 ASTContext &C = getContext();
3231 IdentifierInfo *II
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003232 = &CGM.getContext().Idents.get("__assign_helper_atomic_property_");
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003233 FunctionDecl *FD = FunctionDecl::Create(C,
3234 C.getTranslationUnitDecl(),
3235 SourceLocation(),
Craig Topper8a13c412014-05-21 05:09:00 +00003236 SourceLocation(), II, C.VoidTy,
3237 nullptr, SC_Static,
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003238 false,
Eric Christopher0b1aef22012-04-12 02:16:49 +00003239 false);
Craig Topper8a13c412014-05-21 05:09:00 +00003240
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003241 QualType DestTy = C.getPointerType(Ty);
3242 QualType SrcTy = Ty;
3243 SrcTy.addConst();
3244 SrcTy = C.getPointerType(SrcTy);
3245
3246 FunctionArgList args;
Craig Topper8a13c412014-05-21 05:09:00 +00003247 ImplicitParamDecl dstDecl(getContext(), FD, SourceLocation(), nullptr,DestTy);
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003248 args.push_back(&dstDecl);
Craig Topper8a13c412014-05-21 05:09:00 +00003249 ImplicitParamDecl srcDecl(getContext(), FD, SourceLocation(), nullptr, SrcTy);
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003250 args.push_back(&srcDecl);
Reid Kleckner4982b822014-01-31 22:54:50 +00003251
John McCallc56a8b32016-03-11 04:30:31 +00003252 const CGFunctionInfo &FI =
3253 CGM.getTypes().arrangeBuiltinFunctionDeclaration(C.VoidTy, args);
Reid Kleckner4982b822014-01-31 22:54:50 +00003254
John McCalla729c622012-02-17 03:33:10 +00003255 llvm::FunctionType *LTy = CGM.getTypes().GetFunctionType(FI);
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003256
3257 llvm::Function *Fn =
3258 llvm::Function::Create(LTy, llvm::GlobalValue::InternalLinkage,
Eric Christopher5d2b8d92012-03-29 17:31:31 +00003259 "__assign_helper_atomic_property_",
3260 &CGM.getModule());
Akira Hatanaka44a59f82015-10-28 02:30:47 +00003261
3262 CGM.SetInternalFunctionAttributes(nullptr, Fn, FI);
3263
Adrian Prantl22e66b42014-04-11 01:13:04 +00003264 StartFunction(FD, C.VoidTy, Fn, FI, args);
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003265
John McCall113bee02012-03-10 09:33:50 +00003266 DeclRefExpr DstExpr(&dstDecl, false, DestTy,
3267 VK_RValue, SourceLocation());
3268 UnaryOperator DST(&DstExpr, UO_Deref, DestTy->getPointeeType(),
3269 VK_LValue, OK_Ordinary, SourceLocation());
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003270
John McCall113bee02012-03-10 09:33:50 +00003271 DeclRefExpr SrcExpr(&srcDecl, false, SrcTy,
3272 VK_RValue, SourceLocation());
3273 UnaryOperator SRC(&SrcExpr, UO_Deref, SrcTy->getPointeeType(),
3274 VK_LValue, OK_Ordinary, SourceLocation());
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003275
John McCall113bee02012-03-10 09:33:50 +00003276 Expr *Args[2] = { &DST, &SRC };
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003277 CallExpr *CalleeExp = cast<CallExpr>(PID->getSetterCXXAssignment());
John McCall113bee02012-03-10 09:33:50 +00003278 CXXOperatorCallExpr TheCall(C, OO_Equal, CalleeExp->getCallee(),
Benjamin Kramerc215e762012-08-24 11:54:20 +00003279 Args, DestTy->getPointeeType(),
Adam Nemet484aa452017-03-27 19:17:25 +00003280 VK_LValue, SourceLocation(), FPOptions());
John McCall113bee02012-03-10 09:33:50 +00003281
3282 EmitStmt(&TheCall);
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003283
3284 FinishFunction();
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00003285 HelperFn = llvm::ConstantExpr::getBitCast(Fn, VoidPtrTy);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003286 CGM.setAtomicSetterHelperFnMap(Ty, HelperFn);
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +00003287 return HelperFn;
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003288}
3289
3290llvm::Constant *
3291CodeGenFunction::GenerateObjCAtomicGetterCopyHelperFunction(
3292 const ObjCPropertyImplDecl *PID) {
John McCall5fb5df92012-06-20 06:18:46 +00003293 if (!getLangOpts().CPlusPlus ||
Rafael Espindolad727d3d2012-12-18 04:29:34 +00003294 !getLangOpts().ObjCRuntime.hasAtomicCopyHelper())
Craig Topper8a13c412014-05-21 05:09:00 +00003295 return nullptr;
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003296 const ObjCPropertyDecl *PD = PID->getPropertyDecl();
3297 QualType Ty = PD->getType();
3298 if (!Ty->isRecordType())
Craig Topper8a13c412014-05-21 05:09:00 +00003299 return nullptr;
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003300 if ((!(PD->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_atomic)))
Craig Topper8a13c412014-05-21 05:09:00 +00003301 return nullptr;
3302 llvm::Constant *HelperFn = nullptr;
3303
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003304 if (hasTrivialGetExpr(PID))
Craig Topper8a13c412014-05-21 05:09:00 +00003305 return nullptr;
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003306 assert(PID->getGetterCXXConstructor() && "getGetterCXXConstructor - null");
3307 if ((HelperFn = CGM.getAtomicGetterHelperFnMap(Ty)))
3308 return HelperFn;
3309
3310
3311 ASTContext &C = getContext();
3312 IdentifierInfo *II
3313 = &CGM.getContext().Idents.get("__copy_helper_atomic_property_");
3314 FunctionDecl *FD = FunctionDecl::Create(C,
3315 C.getTranslationUnitDecl(),
3316 SourceLocation(),
Craig Topper8a13c412014-05-21 05:09:00 +00003317 SourceLocation(), II, C.VoidTy,
3318 nullptr, SC_Static,
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003319 false,
Eric Christopher0b1aef22012-04-12 02:16:49 +00003320 false);
Craig Topper8a13c412014-05-21 05:09:00 +00003321
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003322 QualType DestTy = C.getPointerType(Ty);
3323 QualType SrcTy = Ty;
3324 SrcTy.addConst();
3325 SrcTy = C.getPointerType(SrcTy);
3326
3327 FunctionArgList args;
Craig Topper8a13c412014-05-21 05:09:00 +00003328 ImplicitParamDecl dstDecl(getContext(), FD, SourceLocation(), nullptr,DestTy);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003329 args.push_back(&dstDecl);
Craig Topper8a13c412014-05-21 05:09:00 +00003330 ImplicitParamDecl srcDecl(getContext(), FD, SourceLocation(), nullptr, SrcTy);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003331 args.push_back(&srcDecl);
Reid Kleckner4982b822014-01-31 22:54:50 +00003332
John McCallc56a8b32016-03-11 04:30:31 +00003333 const CGFunctionInfo &FI =
3334 CGM.getTypes().arrangeBuiltinFunctionDeclaration(C.VoidTy, args);
Reid Kleckner4982b822014-01-31 22:54:50 +00003335
John McCalla729c622012-02-17 03:33:10 +00003336 llvm::FunctionType *LTy = CGM.getTypes().GetFunctionType(FI);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003337
3338 llvm::Function *Fn =
3339 llvm::Function::Create(LTy, llvm::GlobalValue::InternalLinkage,
3340 "__copy_helper_atomic_property_", &CGM.getModule());
3341
Akira Hatanaka44a59f82015-10-28 02:30:47 +00003342 CGM.SetInternalFunctionAttributes(nullptr, Fn, FI);
3343
Adrian Prantl22e66b42014-04-11 01:13:04 +00003344 StartFunction(FD, C.VoidTy, Fn, FI, args);
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003345
John McCall113bee02012-03-10 09:33:50 +00003346 DeclRefExpr SrcExpr(&srcDecl, false, SrcTy,
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003347 VK_RValue, SourceLocation());
3348
John McCall113bee02012-03-10 09:33:50 +00003349 UnaryOperator SRC(&SrcExpr, UO_Deref, SrcTy->getPointeeType(),
3350 VK_LValue, OK_Ordinary, SourceLocation());
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003351
3352 CXXConstructExpr *CXXConstExpr =
3353 cast<CXXConstructExpr>(PID->getGetterCXXConstructor());
3354
3355 SmallVector<Expr*, 4> ConstructorArgs;
John McCall113bee02012-03-10 09:33:50 +00003356 ConstructorArgs.push_back(&SRC);
Benjamin Kramerf367dd92015-06-12 15:31:50 +00003357 ConstructorArgs.append(std::next(CXXConstExpr->arg_begin()),
3358 CXXConstExpr->arg_end());
3359
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003360 CXXConstructExpr *TheCXXConstructExpr =
3361 CXXConstructExpr::Create(C, Ty, SourceLocation(),
3362 CXXConstExpr->getConstructor(),
3363 CXXConstExpr->isElidable(),
Benjamin Kramerc215e762012-08-24 11:54:20 +00003364 ConstructorArgs,
Sebastian Redla9351792012-02-11 23:51:47 +00003365 CXXConstExpr->hadMultipleCandidates(),
3366 CXXConstExpr->isListInitialization(),
Richard Smithf8adcdc2014-07-17 05:12:35 +00003367 CXXConstExpr->isStdInitListInitialization(),
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003368 CXXConstExpr->requiresZeroInitialization(),
Eric Christopher5d2b8d92012-03-29 17:31:31 +00003369 CXXConstExpr->getConstructionKind(),
3370 SourceRange());
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003371
John McCall113bee02012-03-10 09:33:50 +00003372 DeclRefExpr DstExpr(&dstDecl, false, DestTy,
3373 VK_RValue, SourceLocation());
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003374
John McCall113bee02012-03-10 09:33:50 +00003375 RValue DV = EmitAnyExpr(&DstExpr);
Eric Christopher5d2b8d92012-03-29 17:31:31 +00003376 CharUnits Alignment
3377 = getContext().getTypeAlignInChars(TheCXXConstructExpr->getType());
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003378 EmitAggExpr(TheCXXConstructExpr,
John McCall7f416cc2015-09-08 08:05:57 +00003379 AggValueSlot::forAddr(Address(DV.getScalarVal(), Alignment),
3380 Qualifiers(),
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003381 AggValueSlot::IsDestructed,
3382 AggValueSlot::DoesNotNeedGCBarriers,
Chad Rosier615ed1a2012-03-29 17:37:10 +00003383 AggValueSlot::IsNotAliased));
Fariborz Jahaniana08a7472012-01-10 00:37:01 +00003384
3385 FinishFunction();
3386 HelperFn = llvm::ConstantExpr::getBitCast(Fn, VoidPtrTy);
3387 CGM.setAtomicGetterHelperFnMap(Ty, HelperFn);
3388 return HelperFn;
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003389}
3390
Eli Friedmanec75fec2012-02-28 01:08:45 +00003391llvm::Value *
3392CodeGenFunction::EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty) {
3393 // Get selectors for retain/autorelease.
Eli Friedmanc4e5d0c2012-03-01 22:52:28 +00003394 IdentifierInfo *CopyID = &getContext().Idents.get("copy");
3395 Selector CopySelector =
3396 getContext().Selectors.getNullarySelector(CopyID);
Eli Friedmanec75fec2012-02-28 01:08:45 +00003397 IdentifierInfo *AutoreleaseID = &getContext().Idents.get("autorelease");
3398 Selector AutoreleaseSelector =
3399 getContext().Selectors.getNullarySelector(AutoreleaseID);
3400
3401 // Emit calls to retain/autorelease.
3402 CGObjCRuntime &Runtime = CGM.getObjCRuntime();
3403 llvm::Value *Val = Block;
3404 RValue Result;
3405 Result = Runtime.GenerateMessageSend(*this, ReturnValueSlot(),
Eli Friedmanc4e5d0c2012-03-01 22:52:28 +00003406 Ty, CopySelector,
Craig Topper8a13c412014-05-21 05:09:00 +00003407 Val, CallArgList(), nullptr, nullptr);
Eli Friedmanec75fec2012-02-28 01:08:45 +00003408 Val = Result.getScalarVal();
3409 Result = Runtime.GenerateMessageSend(*this, ReturnValueSlot(),
3410 Ty, AutoreleaseSelector,
Craig Topper8a13c412014-05-21 05:09:00 +00003411 Val, CallArgList(), nullptr, nullptr);
Eli Friedmanec75fec2012-02-28 01:08:45 +00003412 Val = Result.getScalarVal();
3413 return Val;
3414}
3415
Erik Pilkington9c42a8d2017-02-23 21:08:08 +00003416llvm::Value *
3417CodeGenFunction::EmitBuiltinAvailable(ArrayRef<llvm::Value *> Args) {
3418 assert(Args.size() == 3 && "Expected 3 argument here!");
3419
3420 if (!CGM.IsOSVersionAtLeastFn) {
3421 llvm::FunctionType *FTy =
3422 llvm::FunctionType::get(Int32Ty, {Int32Ty, Int32Ty, Int32Ty}, false);
3423 CGM.IsOSVersionAtLeastFn =
3424 CGM.CreateRuntimeFunction(FTy, "__isOSVersionAtLeast");
3425 }
3426
3427 llvm::Value *CallRes =
3428 EmitNounwindRuntimeCall(CGM.IsOSVersionAtLeastFn, Args);
3429
3430 return Builder.CreateICmpNE(CallRes, llvm::Constant::getNullValue(Int32Ty));
3431}
Fariborz Jahanian17eaf402012-01-06 00:29:35 +00003432
Alex Lorenza8fbef42017-03-23 11:14:27 +00003433void CodeGenModule::emitAtAvailableLinkGuard() {
3434 if (!IsOSVersionAtLeastFn)
3435 return;
3436 // @available requires CoreFoundation only on Darwin.
3437 if (!Target.getTriple().isOSDarwin())
3438 return;
3439 // Add -framework CoreFoundation to the linker commands. We still want to
3440 // emit the core foundation reference down below because otherwise if
3441 // CoreFoundation is not used in the code, the linker won't link the
3442 // framework.
3443 auto &Context = getLLVMContext();
3444 llvm::Metadata *Args[2] = {llvm::MDString::get(Context, "-framework"),
3445 llvm::MDString::get(Context, "CoreFoundation")};
3446 LinkerOptionsMetadata.push_back(llvm::MDNode::get(Context, Args));
3447 // Emit a reference to a symbol from CoreFoundation to ensure that
3448 // CoreFoundation is linked into the final binary.
3449 llvm::FunctionType *FTy =
3450 llvm::FunctionType::get(Int32Ty, {VoidPtrTy}, false);
3451 llvm::Constant *CFFunc =
3452 CreateRuntimeFunction(FTy, "CFBundleGetVersionNumber");
3453
3454 llvm::FunctionType *CheckFTy = llvm::FunctionType::get(VoidTy, {}, false);
3455 llvm::Function *CFLinkCheckFunc = cast<llvm::Function>(CreateBuiltinFunction(
3456 CheckFTy, "__clang_at_available_requires_core_foundation_framework"));
3457 CFLinkCheckFunc->setLinkage(llvm::GlobalValue::LinkOnceAnyLinkage);
3458 CFLinkCheckFunc->setVisibility(llvm::GlobalValue::HiddenVisibility);
3459 CodeGenFunction CGF(*this);
3460 CGF.Builder.SetInsertPoint(CGF.createBasicBlock("", CFLinkCheckFunc));
3461 CGF.EmitNounwindRuntimeCall(CFFunc, llvm::Constant::getNullValue(VoidPtrTy));
3462 CGF.Builder.CreateUnreachable();
3463 addCompilerUsedGlobal(CFLinkCheckFunc);
3464}
3465
Angel Garcia Gomez637d1e62015-10-20 13:23:58 +00003466CGObjCRuntime::~CGObjCRuntime() {}