1 //===---- CGObjC.cpp - Emit LLVM Code for Objective-C ---------------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This contains code to emit Objective-C code as LLVM code.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #include "CGDebugInfo.h"
15 #include "CGObjCRuntime.h"
16 #include "CodeGenFunction.h"
17 #include "CodeGenModule.h"
18 #include "TargetInfo.h"
19 #include "clang/AST/ASTContext.h"
20 #include "clang/AST/DeclObjC.h"
21 #include "clang/AST/StmtObjC.h"
22 #include "clang/Basic/Diagnostic.h"
23 #include "clang/CodeGen/CGFunctionInfo.h"
24 #include "llvm/ADT/STLExtras.h"
25 #include "llvm/IR/CallSite.h"
26 #include "llvm/IR/DataLayout.h"
27 #include "llvm/IR/InlineAsm.h"
28 using namespace clang;
29 using namespace CodeGen;
30 
31 typedef llvm::PointerIntPair<llvm::Value*,1,bool> TryEmitResult;
32 static TryEmitResult
33 tryEmitARCRetainScalarExpr(CodeGenFunction &CGF, const Expr *e);
34 static RValue AdjustObjCObjectType(CodeGenFunction &CGF,
35                                    QualType ET,
36                                    RValue Result);
37 
38 /// Given the address of a variable of pointer type, find the correct
39 /// null to store into it.
40 static llvm::Constant *getNullForVariable(Address addr) {
41   llvm::Type *type = addr.getElementType();
42   return llvm::ConstantPointerNull::get(cast<llvm::PointerType>(type));
43 }
44 
45 /// Emits an instance of NSConstantString representing the object.
46 llvm::Value *CodeGenFunction::EmitObjCStringLiteral(const ObjCStringLiteral *E)
47 {
48   llvm::Constant *C =
49       CGM.getObjCRuntime().GenerateConstantString(E->getString()).getPointer();
50   // FIXME: This bitcast should just be made an invariant on the Runtime.
51   return llvm::ConstantExpr::getBitCast(C, ConvertType(E->getType()));
52 }
53 
54 /// EmitObjCBoxedExpr - This routine generates code to call
55 /// the appropriate expression boxing method. This will either be
56 /// one of +[NSNumber numberWith<Type>:], or +[NSString stringWithUTF8String:],
57 /// or [NSValue valueWithBytes:objCType:].
58 ///
59 llvm::Value *
60 CodeGenFunction::EmitObjCBoxedExpr(const ObjCBoxedExpr *E) {
61   // Generate the correct selector for this literal's concrete type.
62   // Get the method.
63   const ObjCMethodDecl *BoxingMethod = E->getBoxingMethod();
64   const Expr *SubExpr = E->getSubExpr();
65   assert(BoxingMethod && "BoxingMethod is null");
66   assert(BoxingMethod->isClassMethod() && "BoxingMethod must be a class method");
67   Selector Sel = BoxingMethod->getSelector();
68 
69   // Generate a reference to the class pointer, which will be the receiver.
70   // Assumes that the method was introduced in the class that should be
71   // messaged (avoids pulling it out of the result type).
72   CGObjCRuntime &Runtime = CGM.getObjCRuntime();
73   const ObjCInterfaceDecl *ClassDecl = BoxingMethod->getClassInterface();
74   llvm::Value *Receiver = Runtime.GetClass(*this, ClassDecl);
75 
76   CallArgList Args;
77   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
86     Address Temporary = CreateMemTemp(SubExpr->getType());
87     EmitAnyExprToMem(SubExpr, Temporary, Qualifiers(), /*isInit*/ true);
88     Address BitCast = Builder.CreateBitCast(Temporary, ConvertType(ArgQT));
89     Args.add(RValue::get(BitCast.getPointer()), ArgQT);
90 
91     // Create char array to store type encoding
92     std::string Str;
93     getContext().getObjCEncodingForType(ValueType, Str);
94     llvm::Constant *GV = CGM.GetAddrOfConstantCString(Str).getPointer();
95 
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   }
105 
106   RValue result = Runtime.GenerateMessageSend(
107       *this, ReturnValueSlot(), BoxingMethod->getReturnType(), Sel, Receiver,
108       Args, ClassDecl, BoxingMethod);
109   return Builder.CreateBitCast(result.getScalarVal(),
110                                ConvertType(E->getType()));
111 }
112 
113 llvm::Value *CodeGenFunction::EmitObjCCollectionLiteral(const Expr *E,
114                                     const ObjCMethodDecl *MethodWithObjects) {
115   ASTContext &Context = CGM.getContext();
116   const ObjCDictionaryLiteral *DLE = nullptr;
117   const ObjCArrayLiteral *ALE = dyn_cast<ObjCArrayLiteral>(E);
118   if (!ALE)
119     DLE = cast<ObjCDictionaryLiteral>(E);
120 
121   // Optimize empty collections by referencing constants, when available.
122   uint64_t NumElements =
123     ALE ? ALE->getNumElements() : DLE->getNumElements();
124   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);
129     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()));
135   }
136 
137   // Compute the type of the array we're initializing.
138   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).
146   Address Objects = CreateMemTemp(ElementArrayType, "objects");
147   Address Keys = Address::invalid();
148   if (DLE)
149     Keys = CreateMemTemp(ElementArrayType, "keys");
150 
151   // 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 
158   // Perform the actual initialialization of the array(s).
159   for (uint64_t i = 0; i < NumElements; i++) {
160     if (ALE) {
161       // Emit the element and store it to the appropriate array slot.
162       const Expr *Rhs = ALE->getElement(i);
163       LValue LV = MakeAddrLValue(
164           Builder.CreateConstArrayGEP(Objects, i, getPointerSize()),
165           ElementType, AlignmentSource::Decl);
166 
167       llvm::Value *value = EmitScalarExpr(Rhs);
168       EmitStoreThroughLValue(RValue::get(value), LV, true);
169       if (TrackNeededObjects) {
170         NeededObjects.push_back(value);
171       }
172     } else {
173       // Emit the key and store it to the appropriate array slot.
174       const Expr *Key = DLE->getKeyValueElement(i).Key;
175       LValue KeyLV = MakeAddrLValue(
176           Builder.CreateConstArrayGEP(Keys, i, getPointerSize()),
177           ElementType, AlignmentSource::Decl);
178       llvm::Value *keyValue = EmitScalarExpr(Key);
179       EmitStoreThroughLValue(RValue::get(keyValue), KeyLV, /*isInit=*/true);
180 
181       // Emit the value and store it to the appropriate array slot.
182       const Expr *Value = DLE->getKeyValueElement(i).Value;
183       LValue ValueLV = MakeAddrLValue(
184           Builder.CreateConstArrayGEP(Objects, i, getPointerSize()),
185           ElementType, AlignmentSource::Decl);
186       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       }
192     }
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();
200   Args.add(RValue::get(Objects.getPointer()), ArgQT);
201   if (DLE) {
202     argDecl = *PI++;
203     ArgQT = argDecl->getType().getUnqualifiedType();
204     Args.add(RValue::get(Keys.getPointer()), ArgQT);
205   }
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();
220   llvm::Value *Receiver = Runtime.GetClass(*this, Class);
221 
222   // Generate the message send.
223   RValue result = Runtime.GenerateMessageSend(
224       *this, ReturnValueSlot(), MethodWithObjects->getReturnType(), Sel,
225       Receiver, Args, Class, MethodWithObjects);
226 
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 
235   return Builder.CreateBitCast(result.getScalarVal(),
236                                ConvertType(E->getType()));
237 }
238 
239 llvm::Value *CodeGenFunction::EmitObjCArrayLiteral(const ObjCArrayLiteral *E) {
240   return EmitObjCCollectionLiteral(E, E->getArrayWithObjectsMethod());
241 }
242 
243 llvm::Value *CodeGenFunction::EmitObjCDictionaryLiteral(
244                                             const ObjCDictionaryLiteral *E) {
245   return EmitObjCCollectionLiteral(E, E->getDictWithObjectsMethod());
246 }
247 
248 /// Emit a selector.
249 llvm::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.
254   return CGM.getObjCRuntime().GetSelector(*this, E->getSelector());
255 }
256 
257 llvm::Value *CodeGenFunction::EmitObjCProtocolExpr(const ObjCProtocolExpr *E) {
258   // FIXME: This should pass the Decl not the name.
259   return CGM.getObjCRuntime().GenerateProtocolRef(*this, E->getProtocol());
260 }
261 
262 /// \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.
265 static RValue AdjustObjCObjectType(CodeGenFunction &CGF, QualType ExpT,
266                                    RValue Result) {
267   if (!ExpT->isObjCRetainableType())
268     return Result;
269 
270   // If the converted types are the same, we're done.
271   llvm::Type *ExpLLVMTy = CGF.ConvertType(ExpT);
272   if (ExpLLVMTy == Result.getScalarVal()->getType())
273     return Result;
274 
275   // We have applied a substitution. Cast the rvalue appropriately.
276   return RValue::get(CGF.Builder.CreateBitCast(Result.getScalarVal(),
277                                                ExpLLVMTy));
278 }
279 
280 /// Decide whether to extend the lifetime of the receiver of a
281 /// returns-inner-pointer message.
282 static bool
283 shouldExtendReceiverForInnerPointerMessage(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();
290 
291     // Look through OVEs.
292     if (auto opaque = dyn_cast<OpaqueValueExpr>(receiver)) {
293       if (opaque->getSourceExpr())
294         receiver = opaque->getSourceExpr()->IgnoreParens();
295     }
296 
297     const ImplicitCastExpr *ice = dyn_cast<ImplicitCastExpr>(receiver);
298     if (!ice || ice->getCastKind() != CK_LValueToRValue) return true;
299     receiver = ice->getSubExpr()->IgnoreParens();
300 
301     // Look through OVEs.
302     if (auto opaque = dyn_cast<OpaqueValueExpr>(receiver)) {
303       if (opaque->getSourceExpr())
304         receiver = opaque->getSourceExpr()->IgnoreParens();
305     }
306 
307     // 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 
340 /// Given an expression of ObjC pointer type, check whether it was
341 /// immediately loaded from an ARC __weak l-value.
342 static 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 
355 RValue CodeGenFunction::EmitObjCMessageExpr(const ObjCMessageExpr *E,
356                                             ReturnValueSlot Return) {
357   // 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.
360 
361   bool isDelegateInit = E->isDelegateInitCall();
362 
363   const ObjCMethodDecl *method = E->getMethodDecl();
364 
365   // 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 
376   // 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 &&
382      CGM.getLangOpts().ObjCAutoRefCount &&
383      method &&
384      method->hasAttr<NSConsumesSelfAttr>());
385 
386   CGObjCRuntime &Runtime = CGM.getObjCRuntime();
387   bool isSuperMessage = false;
388   bool isClassMessage = false;
389   ObjCInterfaceDecl *OID = nullptr;
390   // Find the receiver
391   QualType ReceiverType;
392   llvm::Value *Receiver = nullptr;
393   switch (E->getReceiverKind()) {
394   case ObjCMessageExpr::Instance:
395     ReceiverType = E->getInstanceReceiver()->getType();
396     if (retainSelf) {
397       TryEmitResult ter = tryEmitARCRetainScalarExpr(*this,
398                                                    E->getInstanceReceiver());
399       Receiver = ter.getPointer();
400       if (ter.getInt()) retainSelf = false;
401     } else
402       Receiver = EmitScalarExpr(E->getInstanceReceiver());
403     break;
404 
405   case ObjCMessageExpr::Class: {
406     ReceiverType = E->getClassReceiver();
407     const ObjCObjectType *ObjTy = ReceiverType->getAs<ObjCObjectType>();
408     assert(ObjTy && "Invalid Objective-C class message send");
409     OID = ObjTy->getInterface();
410     assert(OID && "Invalid Objective-C class message send");
411     Receiver = Runtime.GetClass(*this, OID);
412     isClassMessage = true;
413     break;
414   }
415 
416   case ObjCMessageExpr::SuperInstance:
417     ReceiverType = E->getSuperType();
418     Receiver = LoadObjCSelf();
419     isSuperMessage = true;
420     break;
421 
422   case ObjCMessageExpr::SuperClass:
423     ReceiverType = E->getSuperType();
424     Receiver = LoadObjCSelf();
425     isSuperMessage = true;
426     isClassMessage = true;
427     break;
428   }
429 
430   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.
436   if (getLangOpts().ObjCAutoRefCount && method &&
437       method->hasAttr<ObjCReturnsInnerPointerAttr>() &&
438       shouldExtendReceiverForInnerPointerMessage(E))
439     Receiver = EmitARCRetainAutorelease(ReceiverType, Receiver);
440 
441   QualType ResultType = method ? method->getReturnType() : E->getType();
442 
443   CallArgList Args;
444   EmitCallArgs(Args, method, E->arguments(), /*AC*/AbstractCallee(method));
445 
446   // 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) {
454     assert(getLangOpts().ObjCAutoRefCount &&
455            "delegate init calls should only be marked in ARC");
456 
457     // Do an unsafe store of null into self.
458     Address selfAddr =
459       GetAddrOfLocalVar(cast<ObjCMethodDecl>(CurCodeDecl)->getSelfDecl());
460     Builder.CreateStore(getNullForVariable(selfAddr), selfAddr);
461   }
462 
463   RValue result;
464   if (isSuperMessage) {
465     // super is only valid in an Objective-C method
466     const ObjCMethodDecl *OMD = cast<ObjCMethodDecl>(CurFuncDecl);
467     bool isCategoryImpl = isa<ObjCCategoryImplDecl>(OMD->getDeclContext());
468     result = Runtime.GenerateMessageSendSuper(*this, Return, ResultType,
469                                               E->getSelector(),
470                                               OMD->getClassInterface(),
471                                               isCategoryImpl,
472                                               Receiver,
473                                               isClassMessage,
474                                               Args,
475                                               method);
476   } else {
477     result = Runtime.GenerateMessageSend(*this, Return, ResultType,
478                                          E->getSelector(),
479                                          Receiver, Args, OID,
480                                          method);
481   }
482 
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) {
486     Address selfAddr =
487       GetAddrOfLocalVar(cast<ObjCMethodDecl>(CurCodeDecl)->getSelfDecl());
488     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'.
492     llvm::Type *selfTy = selfAddr.getElementType();
493     newSelf = Builder.CreateBitCast(newSelf, selfTy);
494 
495     Builder.CreateStore(newSelf, selfAddr);
496   }
497 
498   return AdjustObjCObjectType(*this, E->getType(), result);
499 }
500 
501 namespace {
502 struct FinishARCDealloc final : EHScopeStack::Cleanup {
503   void Emit(CodeGenFunction &CGF, Flags flags) override {
504     const ObjCMethodDecl *method = cast<ObjCMethodDecl>(CGF.CurCodeDecl);
505 
506     const ObjCImplDecl *impl = cast<ObjCImplDecl>(method->getDeclContext());
507     const ObjCInterfaceDecl *iface = impl->getClassInterface();
508     if (!iface->getSuperClass()) return;
509 
510     bool isCategory = isa<ObjCCategoryImplDecl>(impl);
511 
512     // 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,
520                                                       isCategory,
521                                                       self,
522                                                       /*is class msg*/ false,
523                                                       args,
524                                                       method);
525   }
526 };
527 }
528 
529 /// StartObjCMethod - Begin emission of an ObjCMethod. This generates
530 /// the LLVM function and sets the other context used by
531 /// CodeGenFunction.
532 void CodeGenFunction::StartObjCMethod(const ObjCMethodDecl *OMD,
533                                       const ObjCContainerDecl *CD) {
534   SourceLocation StartLoc = OMD->getLocStart();
535   FunctionArgList args;
536   // Check if we should generate debug info for this method.
537   if (OMD->hasAttr<NoDebugAttr>())
538     DebugInfo = nullptr; // disable debug info indefinitely for this function
539 
540   llvm::Function *Fn = CGM.getObjCRuntime().GenerateMethod(OMD, CD);
541 
542   const CGFunctionInfo &FI = CGM.getTypes().arrangeObjCMethodDeclaration(OMD);
543   CGM.SetInternalFunctionAttributes(OMD, Fn, FI);
544 
545   args.push_back(OMD->getSelfDecl());
546   args.push_back(OMD->getCmdDecl());
547 
548   args.append(OMD->param_begin(), OMD->param_end());
549 
550   CurGD = OMD;
551   CurEHLocation = OMD->getLocEnd();
552 
553   StartFunction(OMD, OMD->getReturnType(), Fn, FI, args,
554                 OMD->getLocation(), StartLoc);
555 
556   // In ARC, certain methods get an extra cleanup.
557   if (CGM.getLangOpts().ObjCAutoRefCount &&
558       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   }
565 }
566 
567 static llvm::Value *emitARCRetainLoadOfScalar(CodeGenFunction &CGF,
568                                               LValue lvalue, QualType type);
569 
570 /// Generate an Objective-C method.  An Objective-C method is a C function with
571 /// its pointer, name, and types registered in the class struture.
572 void CodeGenFunction::GenerateObjCMethod(const ObjCMethodDecl *OMD) {
573   StartObjCMethod(OMD, OMD->getClassInterface());
574   PGO.assignRegionCounters(GlobalDecl(OMD), CurFn);
575   assert(isa<CompoundStmt>(OMD->getBody()));
576   incrementProfileCounter(OMD->getBody());
577   EmitCompoundStmtWithoutScope(*cast<CompoundStmt>(OMD->getBody()));
578   FinishFunction(OMD->getBodyRBrace());
579 }
580 
581 /// emitStructGetterCall - Call the runtime function to load a property
582 /// into the return value slot.
583 static void emitStructGetterCall(CodeGenFunction &CGF, ObjCIvarDecl *ivar,
584                                  bool isAtomic, bool hasStrong) {
585   ASTContext &Context = CGF.getContext();
586 
587   Address src =
588     CGF.EmitLValueForIvar(CGF.TypeOfSelfObject(), CGF.LoadObjCSelf(), ivar, 0)
589        .getAddress();
590 
591   // objc_copyStruct (ReturnValue, &structIvar,
592   //                  sizeof (Type of Ivar), isAtomic, false);
593   CallArgList args;
594 
595   Address dest = CGF.Builder.CreateBitCast(CGF.ReturnValue, CGF.VoidPtrTy);
596   args.add(RValue::get(dest.getPointer()), Context.VoidPtrTy);
597 
598   src = CGF.Builder.CreateBitCast(src, CGF.VoidPtrTy);
599   args.add(RValue::get(src.getPointer()), Context.VoidPtrTy);
600 
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 
606   llvm::Constant *fn = CGF.CGM.getObjCRuntime().GetGetStructFunction();
607   CGCallee callee = CGCallee::forDirect(fn);
608   CGF.EmitCall(CGF.getTypes().arrangeBuiltinFunctionCall(Context.VoidTy, args),
609                callee, ReturnValueSlot(), args);
610 }
611 
612 /// 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.
615 static bool hasUnalignedAtomics(llvm::Triple::ArchType arch) {
616   // FIXME: Allow unaligned atomic load/store on x86.  (It is not
617   // currently supported by the backend.)
618   return 0;
619 }
620 
621 /// Return the maximum size that permits atomic accesses for the given
622 /// architecture.
623 static 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 
633 namespace {
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   };
677 }
678 
679 /// Pick an implementation strategy for the given property synthesis.
680 PropertyImplStrategy::PropertyImplStrategy(CodeGenModule &CGM,
681                                      const ObjCPropertyImplDecl *propImpl) {
682   const ObjCPropertyDecl *prop = propImpl->getPropertyDecl();
683   ObjCPropertyDecl::SetterKind setterKind = prop->getSetterKind();
684 
685   IsCopy = (setterKind == ObjCPropertyDecl::Copy);
686   IsAtomic = prop->isAtomic();
687   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();
692   std::tie(IvarSize, IvarAlignment) =
693       CGM.getContext().getTypeInfoInChars(ivarType);
694 
695   // If we have a copy property, we always have to use getProperty/setProperty.
696   // TODO: we could actually use setProperty and an expression for non-atomics.
697   if (IsCopy) {
698     Kind = GetSetProperty;
699     return;
700   }
701 
702   // Handle retain.
703   if (setterKind == ObjCPropertyDecl::Retain) {
704     // In GC-only, there's nothing special that needs to be done.
705     if (CGM.getLangOpts().getGC() == LangOptions::GCOnly) {
706       // 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.
711     } else if (CGM.getLangOpts().ObjCAutoRefCount && !IsAtomic) {
712       // 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;
722       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 
744   // 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 
751   // 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() ||
755       (CGM.getLangOpts().getGC() &&
756        CGM.getContext().getObjCGCAttrKind(ivarType))) {
757     Kind = Expression;
758     return;
759   }
760 
761   // Compute whether the ivar has strong members.
762   if (CGM.getLangOpts().getGC())
763     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.
776 
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 
784   llvm::Triple::ArchType arch =
785     CGM.getTarget().getTriple().getArch();
786 
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 }
805 
806 /// \brief Generate an Objective-C property getter function.
807 ///
808 /// The given Decl must be an ObjCImplementationDecl. \@synthesize
809 /// is illegal within a category.
810 void CodeGenFunction::GenerateObjCGetter(ObjCImplementationDecl *IMP,
811                                          const ObjCPropertyImplDecl *PID) {
812   llvm::Constant *AtomicHelperFn =
813       CodeGenFunction(CGM).GenerateObjCAtomicGetterCopyHelperFunction(PID);
814   const ObjCPropertyDecl *PD = PID->getPropertyDecl();
815   ObjCMethodDecl *OMD = PD->getGetterMethodDecl();
816   assert(OMD && "Invalid call to generate getter (empty method)");
817   StartObjCMethod(OMD, IMP->getClassInterface());
818 
819   generateObjCGetterBody(IMP, PID, OMD, AtomicHelperFn);
820 
821   FinishFunction();
822 }
823 
824 static bool hasTrivialGetExpr(const ObjCPropertyImplDecl *propImpl) {
825   const Expr *getter = propImpl->getGetterCXXConstructor();
826   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 
831   // 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 
837   // 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 
847 /// emitCPPObjectAtomicGetterCall - Call the runtime function to
848 /// copy the ivar into the resturn slot.
849 static 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 =
862     CGF.EmitLValueForIvar(CGF.TypeOfSelfObject(),
863                           CGF.LoadObjCSelf(), ivar, 0).getPointer();
864   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 
870   llvm::Constant *copyCppAtomicObjectFn =
871     CGF.CGM.getObjCRuntime().GetCppAtomicObjectGetFunction();
872   CGCallee callee = CGCallee::forDirect(copyCppAtomicObjectFn);
873   CGF.EmitCall(
874       CGF.getTypes().arrangeBuiltinFunctionCall(CGF.getContext().VoidTy, args),
875                callee, ReturnValueSlot(), args);
876 }
877 
878 void
879 CodeGenFunction::generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
880                                         const ObjCPropertyImplDecl *propImpl,
881                                         const ObjCMethodDecl *GetterMethodDecl,
882                                         llvm::Constant *AtomicHelperFn) {
883   // If there's a non-trivial 'get' expression, we just have to emit that.
884   if (!hasTrivialGetExpr(propImpl)) {
885     if (!AtomicHelperFn) {
886       ReturnStmt ret(SourceLocation(), propImpl->getGetterCXXConstructor(),
887                      /*nrvo*/ nullptr);
888       EmitReturnStmt(ret);
889     }
890     else {
891       ObjCIvarDecl *ivar = propImpl->getPropertyIvarDecl();
892       emitCPPObjectAtomicGetterCall(*this, ReturnValue.getPointer(),
893                                     ivar, AtomicHelperFn);
894     }
895     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: {
908     // We don't need to do anything for a zero-size struct.
909     if (strategy.getIvarSize().isZero())
910       return;
911 
912     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.
916     uint64_t ivarSize = getContext().toBits(strategy.getIvarSize());
917     llvm::Type *bitcastType = llvm::Type::getIntNTy(getLLVMContext(), ivarSize);
918     bitcastType = bitcastType->getPointerTo(); // addrspace 0 okay
919 
920     // Perform an atomic load.  This does not impose ordering constraints.
921     Address ivarAddr = LV.getAddress();
922     ivarAddr = Builder.CreateBitCast(ivarAddr, bitcastType);
923     llvm::LoadInst *load = Builder.CreateLoad(ivarAddr, "load");
924     load->setAtomic(llvm::AtomicOrdering::Unordered);
925 
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.
929     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));
939 
940     // Make sure we don't do an autorelease.
941     AutoreleaseResult = false;
942     return;
943   }
944 
945   case PropertyImplStrategy::GetSetProperty: {
946     llvm::Constant *getPropertyFn =
947       CGM.getObjCRuntime().GetPropertyGetFunction();
948     if (!getPropertyFn) {
949       CGM.ErrorUnsupported(propImpl, "Obj-C getter requiring atomic copy");
950       return;
951     }
952     CGCallee callee = CGCallee::forDirect(getPropertyFn);
953 
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.
957     llvm::Value *cmd =
958       Builder.CreateLoad(GetAddrOfLocalVar(getterMethod->getCmdDecl()), "cmd");
959     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());
967     args.add(RValue::get(Builder.getInt1(strategy.isAtomic())),
968              getContext().BoolTy);
969 
970     // FIXME: We shouldn't need to get the function info here, the
971     // runtime already should have computed it to build the function.
972     llvm::Instruction *CallInstruction;
973     RValue RV = EmitCall(
974         getTypes().arrangeBuiltinFunctionCall(propType, args),
975         callee, ReturnValueSlot(), args, &CallInstruction);
976     if (llvm::CallInst *call = dyn_cast<llvm::CallInst>(CallInstruction))
977       call->setTailCall();
978 
979     // 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.
982     RV = RValue::get(Builder.CreateBitCast(
983         RV.getScalarVal(),
984         getTypes().ConvertType(getterMethod->getReturnType())));
985 
986     EmitReturnOfRValue(RV, propType);
987 
988     // objc_getProperty does an autorelease, so we should suppress ours.
989     AutoreleaseResult = false;
990 
991     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();
1004     switch (getEvaluationKind(ivarType)) {
1005     case TEK_Complex: {
1006       ComplexPairTy pair = EmitLoadOfComplex(LV, SourceLocation());
1007       EmitStoreOfComplex(pair, MakeAddrLValue(ReturnValue, ivarType),
1008                          /*init*/ true);
1009       return;
1010     }
1011     case TEK_Aggregate: {
1012       // 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.
1015       EmitAggregateCopy(/* Dest= */ MakeAddrLValue(ReturnValue, ivarType),
1016                         /* Src= */ LV, ivarType);
1017       return; }
1018     case TEK_Scalar: {
1019       llvm::Value *value;
1020       if (propType->isReferenceType()) {
1021         value = LV.getAddress().getPointer();
1022       } else {
1023         // We want to load and autoreleaseReturnValue ARC __weak ivars.
1024         if (LV.getQuals().getObjCLifetime() == Qualifiers::OCL_Weak) {
1025           if (getLangOpts().ObjCAutoRefCount) {
1026             value = emitARCRetainLoadOfScalar(*this, LV, ivarType);
1027           } else {
1028             value = EmitARCLoadWeak(LV.getAddress());
1029           }
1030 
1031         // Otherwise we want to do a simple load, suppressing the
1032         // final autorelease.
1033         } else {
1034           value = EmitLoadOfLValue(LV, SourceLocation()).getScalarVal();
1035           AutoreleaseResult = false;
1036         }
1037 
1038         value = Builder.CreateBitCast(
1039             value, ConvertType(GetterMethodDecl->getReturnType()));
1040       }
1041 
1042       EmitReturnOfRValue(RValue::get(value), propType);
1043       return;
1044     }
1045     }
1046     llvm_unreachable("bad evaluation kind");
1047   }
1048 
1049   }
1050   llvm_unreachable("bad @property implementation strategy!");
1051 }
1052 
1053 /// emitStructSetterCall - Call the runtime function to store the value
1054 /// from the first formal parameter into the given ivar.
1055 static void emitStructSetterCall(CodeGenFunction &CGF, ObjCMethodDecl *OMD,
1056                                  ObjCIvarDecl *ivar) {
1057   // objc_copyStruct (&structIvar, &Arg,
1058   //                  sizeof (struct something), true, false);
1059   CallArgList args;
1060 
1061   // The first argument is the address of the ivar.
1062   llvm::Value *ivarAddr = CGF.EmitLValueForIvar(CGF.TypeOfSelfObject(),
1063                                                 CGF.LoadObjCSelf(), ivar, 0)
1064     .getPointer();
1065   ivarAddr = CGF.Builder.CreateBitCast(ivarAddr, CGF.Int8PtrTy);
1066   args.add(RValue::get(ivarAddr), CGF.getContext().VoidPtrTy);
1067 
1068   // The second argument is the address of the parameter variable.
1069   ParmVarDecl *argVar = *OMD->param_begin();
1070   DeclRefExpr argRef(argVar, false, argVar->getType().getNonReferenceType(),
1071                      VK_LValue, SourceLocation());
1072   llvm::Value *argAddr = CGF.EmitLValue(&argRef).getPointer();
1073   argAddr = CGF.Builder.CreateBitCast(argAddr, CGF.Int8PtrTy);
1074   args.add(RValue::get(argAddr), CGF.getContext().VoidPtrTy);
1075 
1076   // The third argument is the sizeof the type.
1077   llvm::Value *size =
1078     CGF.CGM.getSize(CGF.getContext().getTypeSizeInChars(ivar->getType()));
1079   args.add(RValue::get(size), CGF.getContext().getSizeType());
1080 
1081   // The fourth argument is the 'isAtomic' flag.
1082   args.add(RValue::get(CGF.Builder.getTrue()), CGF.getContext().BoolTy);
1083 
1084   // The fifth argument is the 'hasStrong' flag.
1085   // FIXME: should this really always be false?
1086   args.add(RValue::get(CGF.Builder.getFalse()), CGF.getContext().BoolTy);
1087 
1088   llvm::Constant *fn = CGF.CGM.getObjCRuntime().GetSetStructFunction();
1089   CGCallee callee = CGCallee::forDirect(fn);
1090   CGF.EmitCall(
1091       CGF.getTypes().arrangeBuiltinFunctionCall(CGF.getContext().VoidTy, args),
1092                callee, ReturnValueSlot(), args);
1093 }
1094 
1095 /// emitCPPObjectAtomicSetterCall - Call the runtime function to store
1096 /// the value from the first formal parameter into the given ivar, using
1097 /// the Cpp API for atomic Cpp objects with non-trivial copy assignment.
1098 static void emitCPPObjectAtomicSetterCall(CodeGenFunction &CGF,
1099                                           ObjCMethodDecl *OMD,
1100                                           ObjCIvarDecl *ivar,
1101                                           llvm::Constant *AtomicHelperFn) {
1102   // objc_copyCppObjectAtomic (&CppObjectIvar, &Arg,
1103   //                           AtomicHelperFn);
1104   CallArgList args;
1105 
1106   // The first argument is the address of the ivar.
1107   llvm::Value *ivarAddr =
1108     CGF.EmitLValueForIvar(CGF.TypeOfSelfObject(),
1109                           CGF.LoadObjCSelf(), ivar, 0).getPointer();
1110   ivarAddr = CGF.Builder.CreateBitCast(ivarAddr, CGF.Int8PtrTy);
1111   args.add(RValue::get(ivarAddr), CGF.getContext().VoidPtrTy);
1112 
1113   // The second argument is the address of the parameter variable.
1114   ParmVarDecl *argVar = *OMD->param_begin();
1115   DeclRefExpr argRef(argVar, false, argVar->getType().getNonReferenceType(),
1116                      VK_LValue, SourceLocation());
1117   llvm::Value *argAddr = CGF.EmitLValue(&argRef).getPointer();
1118   argAddr = CGF.Builder.CreateBitCast(argAddr, CGF.Int8PtrTy);
1119   args.add(RValue::get(argAddr), CGF.getContext().VoidPtrTy);
1120 
1121   // Third argument is the helper function.
1122   args.add(RValue::get(AtomicHelperFn), CGF.getContext().VoidPtrTy);
1123 
1124   llvm::Constant *fn =
1125     CGF.CGM.getObjCRuntime().GetCppAtomicObjectSetFunction();
1126   CGCallee callee = CGCallee::forDirect(fn);
1127   CGF.EmitCall(
1128       CGF.getTypes().arrangeBuiltinFunctionCall(CGF.getContext().VoidTy, args),
1129                callee, ReturnValueSlot(), args);
1130 }
1131 
1132 
1133 static bool hasTrivialSetExpr(const ObjCPropertyImplDecl *PID) {
1134   Expr *setter = PID->getSetterCXXAssignment();
1135   if (!setter) return true;
1136 
1137   // Sema only makes only of these when the ivar has a C++ class type,
1138   // so the form is pretty constrained.
1139 
1140   // An operator call is trivial if the function it calls is trivial.
1141   // This also implies that there's nothing non-trivial going on with
1142   // the arguments, because operator= can only be trivial if it's a
1143   // synthesized assignment operator and therefore both parameters are
1144   // references.
1145   if (CallExpr *call = dyn_cast<CallExpr>(setter)) {
1146     if (const FunctionDecl *callee
1147           = dyn_cast_or_null<FunctionDecl>(call->getCalleeDecl()))
1148       if (callee->isTrivial())
1149         return true;
1150     return false;
1151   }
1152 
1153   assert(isa<ExprWithCleanups>(setter));
1154   return false;
1155 }
1156 
1157 static bool UseOptimizedSetter(CodeGenModule &CGM) {
1158   if (CGM.getLangOpts().getGC() != LangOptions::NonGC)
1159     return false;
1160   return CGM.getLangOpts().ObjCRuntime.hasOptimizedSetter();
1161 }
1162 
1163 void
1164 CodeGenFunction::generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
1165                                         const ObjCPropertyImplDecl *propImpl,
1166                                         llvm::Constant *AtomicHelperFn) {
1167   const ObjCPropertyDecl *prop = propImpl->getPropertyDecl();
1168   ObjCIvarDecl *ivar = propImpl->getPropertyIvarDecl();
1169   ObjCMethodDecl *setterMethod = prop->getSetterMethodDecl();
1170 
1171   // Just use the setter expression if Sema gave us one and it's
1172   // non-trivial.
1173   if (!hasTrivialSetExpr(propImpl)) {
1174     if (!AtomicHelperFn)
1175       // If non-atomic, assignment is called directly.
1176       EmitStmt(propImpl->getSetterCXXAssignment());
1177     else
1178       // If atomic, assignment is called via a locking api.
1179       emitCPPObjectAtomicSetterCall(*this, setterMethod, ivar,
1180                                     AtomicHelperFn);
1181     return;
1182   }
1183 
1184   PropertyImplStrategy strategy(CGM, propImpl);
1185   switch (strategy.getKind()) {
1186   case PropertyImplStrategy::Native: {
1187     // We don't need to do anything for a zero-size struct.
1188     if (strategy.getIvarSize().isZero())
1189       return;
1190 
1191     Address argAddr = GetAddrOfLocalVar(*setterMethod->param_begin());
1192 
1193     LValue ivarLValue =
1194       EmitLValueForIvar(TypeOfSelfObject(), LoadObjCSelf(), ivar, /*quals*/ 0);
1195     Address ivarAddr = ivarLValue.getAddress();
1196 
1197     // Currently, all atomic accesses have to be through integer
1198     // types, so there's no point in trying to pick a prettier type.
1199     llvm::Type *bitcastType =
1200       llvm::Type::getIntNTy(getLLVMContext(),
1201                             getContext().toBits(strategy.getIvarSize()));
1202 
1203     // Cast both arguments to the chosen operation type.
1204     argAddr = Builder.CreateElementBitCast(argAddr, bitcastType);
1205     ivarAddr = Builder.CreateElementBitCast(ivarAddr, bitcastType);
1206 
1207     // This bitcast load is likely to cause some nasty IR.
1208     llvm::Value *load = Builder.CreateLoad(argAddr);
1209 
1210     // Perform an atomic store.  There are no memory ordering requirements.
1211     llvm::StoreInst *store = Builder.CreateStore(load, ivarAddr);
1212     store->setAtomic(llvm::AtomicOrdering::Unordered);
1213     return;
1214   }
1215 
1216   case PropertyImplStrategy::GetSetProperty:
1217   case PropertyImplStrategy::SetPropertyAndExpressionGet: {
1218 
1219     llvm::Constant *setOptimizedPropertyFn = nullptr;
1220     llvm::Constant *setPropertyFn = nullptr;
1221     if (UseOptimizedSetter(CGM)) {
1222       // 10.8 and iOS 6.0 code and GC is off
1223       setOptimizedPropertyFn =
1224         CGM.getObjCRuntime()
1225            .GetOptimizedPropertySetFunction(strategy.isAtomic(),
1226                                             strategy.isCopy());
1227       if (!setOptimizedPropertyFn) {
1228         CGM.ErrorUnsupported(propImpl, "Obj-C optimized setter - NYI");
1229         return;
1230       }
1231     }
1232     else {
1233       setPropertyFn = CGM.getObjCRuntime().GetPropertySetFunction();
1234       if (!setPropertyFn) {
1235         CGM.ErrorUnsupported(propImpl, "Obj-C setter requiring atomic copy");
1236         return;
1237       }
1238     }
1239 
1240     // Emit objc_setProperty((id) self, _cmd, offset, arg,
1241     //                       <is-atomic>, <is-copy>).
1242     llvm::Value *cmd =
1243       Builder.CreateLoad(GetAddrOfLocalVar(setterMethod->getCmdDecl()));
1244     llvm::Value *self =
1245       Builder.CreateBitCast(LoadObjCSelf(), VoidPtrTy);
1246     llvm::Value *ivarOffset =
1247       EmitIvarOffset(classImpl->getClassInterface(), ivar);
1248     Address argAddr = GetAddrOfLocalVar(*setterMethod->param_begin());
1249     llvm::Value *arg = Builder.CreateLoad(argAddr, "arg");
1250     arg = Builder.CreateBitCast(arg, VoidPtrTy);
1251 
1252     CallArgList args;
1253     args.add(RValue::get(self), getContext().getObjCIdType());
1254     args.add(RValue::get(cmd), getContext().getObjCSelType());
1255     if (setOptimizedPropertyFn) {
1256       args.add(RValue::get(arg), getContext().getObjCIdType());
1257       args.add(RValue::get(ivarOffset), getContext().getPointerDiffType());
1258       CGCallee callee = CGCallee::forDirect(setOptimizedPropertyFn);
1259       EmitCall(getTypes().arrangeBuiltinFunctionCall(getContext().VoidTy, args),
1260                callee, ReturnValueSlot(), args);
1261     } else {
1262       args.add(RValue::get(ivarOffset), getContext().getPointerDiffType());
1263       args.add(RValue::get(arg), getContext().getObjCIdType());
1264       args.add(RValue::get(Builder.getInt1(strategy.isAtomic())),
1265                getContext().BoolTy);
1266       args.add(RValue::get(Builder.getInt1(strategy.isCopy())),
1267                getContext().BoolTy);
1268       // FIXME: We shouldn't need to get the function info here, the runtime
1269       // already should have computed it to build the function.
1270       CGCallee callee = CGCallee::forDirect(setPropertyFn);
1271       EmitCall(getTypes().arrangeBuiltinFunctionCall(getContext().VoidTy, args),
1272                callee, ReturnValueSlot(), args);
1273     }
1274 
1275     return;
1276   }
1277 
1278   case PropertyImplStrategy::CopyStruct:
1279     emitStructSetterCall(*this, setterMethod, ivar);
1280     return;
1281 
1282   case PropertyImplStrategy::Expression:
1283     break;
1284   }
1285 
1286   // Otherwise, fake up some ASTs and emit a normal assignment.
1287   ValueDecl *selfDecl = setterMethod->getSelfDecl();
1288   DeclRefExpr self(selfDecl, false, selfDecl->getType(),
1289                    VK_LValue, SourceLocation());
1290   ImplicitCastExpr selfLoad(ImplicitCastExpr::OnStack,
1291                             selfDecl->getType(), CK_LValueToRValue, &self,
1292                             VK_RValue);
1293   ObjCIvarRefExpr ivarRef(ivar, ivar->getType().getNonReferenceType(),
1294                           SourceLocation(), SourceLocation(),
1295                           &selfLoad, true, true);
1296 
1297   ParmVarDecl *argDecl = *setterMethod->param_begin();
1298   QualType argType = argDecl->getType().getNonReferenceType();
1299   DeclRefExpr arg(argDecl, false, argType, VK_LValue, SourceLocation());
1300   ImplicitCastExpr argLoad(ImplicitCastExpr::OnStack,
1301                            argType.getUnqualifiedType(), CK_LValueToRValue,
1302                            &arg, VK_RValue);
1303 
1304   // The property type can differ from the ivar type in some situations with
1305   // Objective-C pointer types, we can always bit cast the RHS in these cases.
1306   // The following absurdity is just to ensure well-formed IR.
1307   CastKind argCK = CK_NoOp;
1308   if (ivarRef.getType()->isObjCObjectPointerType()) {
1309     if (argLoad.getType()->isObjCObjectPointerType())
1310       argCK = CK_BitCast;
1311     else if (argLoad.getType()->isBlockPointerType())
1312       argCK = CK_BlockPointerToObjCPointerCast;
1313     else
1314       argCK = CK_CPointerToObjCPointerCast;
1315   } else if (ivarRef.getType()->isBlockPointerType()) {
1316      if (argLoad.getType()->isBlockPointerType())
1317       argCK = CK_BitCast;
1318     else
1319       argCK = CK_AnyPointerToBlockPointerCast;
1320   } else if (ivarRef.getType()->isPointerType()) {
1321     argCK = CK_BitCast;
1322   }
1323   ImplicitCastExpr argCast(ImplicitCastExpr::OnStack,
1324                            ivarRef.getType(), argCK, &argLoad,
1325                            VK_RValue);
1326   Expr *finalArg = &argLoad;
1327   if (!getContext().hasSameUnqualifiedType(ivarRef.getType(),
1328                                            argLoad.getType()))
1329     finalArg = &argCast;
1330 
1331 
1332   BinaryOperator assign(&ivarRef, finalArg, BO_Assign,
1333                         ivarRef.getType(), VK_RValue, OK_Ordinary,
1334                         SourceLocation(), FPOptions());
1335   EmitStmt(&assign);
1336 }
1337 
1338 /// \brief Generate an Objective-C property setter function.
1339 ///
1340 /// The given Decl must be an ObjCImplementationDecl. \@synthesize
1341 /// is illegal within a category.
1342 void CodeGenFunction::GenerateObjCSetter(ObjCImplementationDecl *IMP,
1343                                          const ObjCPropertyImplDecl *PID) {
1344   llvm::Constant *AtomicHelperFn =
1345       CodeGenFunction(CGM).GenerateObjCAtomicSetterCopyHelperFunction(PID);
1346   const ObjCPropertyDecl *PD = PID->getPropertyDecl();
1347   ObjCMethodDecl *OMD = PD->getSetterMethodDecl();
1348   assert(OMD && "Invalid call to generate setter (empty method)");
1349   StartObjCMethod(OMD, IMP->getClassInterface());
1350 
1351   generateObjCSetterBody(IMP, PID, AtomicHelperFn);
1352 
1353   FinishFunction();
1354 }
1355 
1356 namespace {
1357   struct DestroyIvar final : EHScopeStack::Cleanup {
1358   private:
1359     llvm::Value *addr;
1360     const ObjCIvarDecl *ivar;
1361     CodeGenFunction::Destroyer *destroyer;
1362     bool useEHCleanupForArray;
1363   public:
1364     DestroyIvar(llvm::Value *addr, const ObjCIvarDecl *ivar,
1365                 CodeGenFunction::Destroyer *destroyer,
1366                 bool useEHCleanupForArray)
1367       : addr(addr), ivar(ivar), destroyer(destroyer),
1368         useEHCleanupForArray(useEHCleanupForArray) {}
1369 
1370     void Emit(CodeGenFunction &CGF, Flags flags) override {
1371       LValue lvalue
1372         = CGF.EmitLValueForIvar(CGF.TypeOfSelfObject(), addr, ivar, /*CVR*/ 0);
1373       CGF.emitDestroy(lvalue.getAddress(), ivar->getType(), destroyer,
1374                       flags.isForNormalCleanup() && useEHCleanupForArray);
1375     }
1376   };
1377 }
1378 
1379 /// Like CodeGenFunction::destroyARCStrong, but do it with a call.
1380 static void destroyARCStrongWithStore(CodeGenFunction &CGF,
1381                                       Address addr,
1382                                       QualType type) {
1383   llvm::Value *null = getNullForVariable(addr);
1384   CGF.EmitARCStoreStrongCall(addr, null, /*ignored*/ true);
1385 }
1386 
1387 static void emitCXXDestructMethod(CodeGenFunction &CGF,
1388                                   ObjCImplementationDecl *impl) {
1389   CodeGenFunction::RunCleanupsScope scope(CGF);
1390 
1391   llvm::Value *self = CGF.LoadObjCSelf();
1392 
1393   const ObjCInterfaceDecl *iface = impl->getClassInterface();
1394   for (const ObjCIvarDecl *ivar = iface->all_declared_ivar_begin();
1395        ivar; ivar = ivar->getNextIvar()) {
1396     QualType type = ivar->getType();
1397 
1398     // Check whether the ivar is a destructible type.
1399     QualType::DestructionKind dtorKind = type.isDestructedType();
1400     if (!dtorKind) continue;
1401 
1402     CodeGenFunction::Destroyer *destroyer = nullptr;
1403 
1404     // Use a call to objc_storeStrong to destroy strong ivars, for the
1405     // general benefit of the tools.
1406     if (dtorKind == QualType::DK_objc_strong_lifetime) {
1407       destroyer = destroyARCStrongWithStore;
1408 
1409     // Otherwise use the default for the destruction kind.
1410     } else {
1411       destroyer = CGF.getDestroyer(dtorKind);
1412     }
1413 
1414     CleanupKind cleanupKind = CGF.getCleanupKind(dtorKind);
1415 
1416     CGF.EHStack.pushCleanup<DestroyIvar>(cleanupKind, self, ivar, destroyer,
1417                                          cleanupKind & EHCleanup);
1418   }
1419 
1420   assert(scope.requiresCleanups() && "nothing to do in .cxx_destruct?");
1421 }
1422 
1423 void CodeGenFunction::GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1424                                                  ObjCMethodDecl *MD,
1425                                                  bool ctor) {
1426   MD->createImplicitParams(CGM.getContext(), IMP->getClassInterface());
1427   StartObjCMethod(MD, IMP->getClassInterface());
1428 
1429   // Emit .cxx_construct.
1430   if (ctor) {
1431     // Suppress the final autorelease in ARC.
1432     AutoreleaseResult = false;
1433 
1434     for (const auto *IvarInit : IMP->inits()) {
1435       FieldDecl *Field = IvarInit->getAnyMember();
1436       ObjCIvarDecl *Ivar = cast<ObjCIvarDecl>(Field);
1437       LValue LV = EmitLValueForIvar(TypeOfSelfObject(),
1438                                     LoadObjCSelf(), Ivar, 0);
1439       EmitAggExpr(IvarInit->getInit(),
1440                   AggValueSlot::forLValue(LV, AggValueSlot::IsDestructed,
1441                                           AggValueSlot::DoesNotNeedGCBarriers,
1442                                           AggValueSlot::IsNotAliased));
1443     }
1444     // constructor returns 'self'.
1445     CodeGenTypes &Types = CGM.getTypes();
1446     QualType IdTy(CGM.getContext().getObjCIdType());
1447     llvm::Value *SelfAsId =
1448       Builder.CreateBitCast(LoadObjCSelf(), Types.ConvertType(IdTy));
1449     EmitReturnOfRValue(RValue::get(SelfAsId), IdTy);
1450 
1451   // Emit .cxx_destruct.
1452   } else {
1453     emitCXXDestructMethod(*this, IMP);
1454   }
1455   FinishFunction();
1456 }
1457 
1458 llvm::Value *CodeGenFunction::LoadObjCSelf() {
1459   VarDecl *Self = cast<ObjCMethodDecl>(CurFuncDecl)->getSelfDecl();
1460   DeclRefExpr DRE(Self, /*is enclosing local*/ (CurFuncDecl != CurCodeDecl),
1461                   Self->getType(), VK_LValue, SourceLocation());
1462   return EmitLoadOfScalar(EmitDeclRefLValue(&DRE), SourceLocation());
1463 }
1464 
1465 QualType CodeGenFunction::TypeOfSelfObject() {
1466   const ObjCMethodDecl *OMD = cast<ObjCMethodDecl>(CurFuncDecl);
1467   ImplicitParamDecl *selfDecl = OMD->getSelfDecl();
1468   const ObjCObjectPointerType *PTy = cast<ObjCObjectPointerType>(
1469     getContext().getCanonicalType(selfDecl->getType()));
1470   return PTy->getPointeeType();
1471 }
1472 
1473 void CodeGenFunction::EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S){
1474   llvm::Constant *EnumerationMutationFnPtr =
1475     CGM.getObjCRuntime().EnumerationMutationFunction();
1476   if (!EnumerationMutationFnPtr) {
1477     CGM.ErrorUnsupported(&S, "Obj-C fast enumeration for this runtime");
1478     return;
1479   }
1480   CGCallee EnumerationMutationFn =
1481     CGCallee::forDirect(EnumerationMutationFnPtr);
1482 
1483   CGDebugInfo *DI = getDebugInfo();
1484   if (DI)
1485     DI->EmitLexicalBlockStart(Builder, S.getSourceRange().getBegin());
1486 
1487   RunCleanupsScope ForScope(*this);
1488 
1489   // The local variable comes into scope immediately.
1490   AutoVarEmission variable = AutoVarEmission::invalid();
1491   if (const DeclStmt *SD = dyn_cast<DeclStmt>(S.getElement()))
1492     variable = EmitAutoVarAlloca(*cast<VarDecl>(SD->getSingleDecl()));
1493 
1494   JumpDest LoopEnd = getJumpDestInCurrentScope("forcoll.end");
1495 
1496   // Fast enumeration state.
1497   QualType StateTy = CGM.getObjCFastEnumerationStateType();
1498   Address StatePtr = CreateMemTemp(StateTy, "state.ptr");
1499   EmitNullInitialization(StatePtr, StateTy);
1500 
1501   // Number of elements in the items array.
1502   static const unsigned NumItems = 16;
1503 
1504   // Fetch the countByEnumeratingWithState:objects:count: selector.
1505   IdentifierInfo *II[] = {
1506     &CGM.getContext().Idents.get("countByEnumeratingWithState"),
1507     &CGM.getContext().Idents.get("objects"),
1508     &CGM.getContext().Idents.get("count")
1509   };
1510   Selector FastEnumSel =
1511     CGM.getContext().Selectors.getSelector(llvm::array_lengthof(II), &II[0]);
1512 
1513   QualType ItemsTy =
1514     getContext().getConstantArrayType(getContext().getObjCIdType(),
1515                                       llvm::APInt(32, NumItems),
1516                                       ArrayType::Normal, 0);
1517   Address ItemsPtr = CreateMemTemp(ItemsTy, "items.ptr");
1518 
1519   // Emit the collection pointer.  In ARC, we do a retain.
1520   llvm::Value *Collection;
1521   if (getLangOpts().ObjCAutoRefCount) {
1522     Collection = EmitARCRetainScalarExpr(S.getCollection());
1523 
1524     // Enter a cleanup to do the release.
1525     EmitObjCConsumeObject(S.getCollection()->getType(), Collection);
1526   } else {
1527     Collection = EmitScalarExpr(S.getCollection());
1528   }
1529 
1530   // The 'continue' label needs to appear within the cleanup for the
1531   // collection object.
1532   JumpDest AfterBody = getJumpDestInCurrentScope("forcoll.next");
1533 
1534   // Send it our message:
1535   CallArgList Args;
1536 
1537   // The first argument is a temporary of the enumeration-state type.
1538   Args.add(RValue::get(StatePtr.getPointer()),
1539            getContext().getPointerType(StateTy));
1540 
1541   // The second argument is a temporary array with space for NumItems
1542   // pointers.  We'll actually be loading elements from the array
1543   // pointer written into the control state; this buffer is so that
1544   // collections that *aren't* backed by arrays can still queue up
1545   // batches of elements.
1546   Args.add(RValue::get(ItemsPtr.getPointer()),
1547            getContext().getPointerType(ItemsTy));
1548 
1549   // The third argument is the capacity of that temporary array.
1550   llvm::Type *NSUIntegerTy = ConvertType(getContext().getNSUIntegerType());
1551   llvm::Constant *Count = llvm::ConstantInt::get(NSUIntegerTy, NumItems);
1552   Args.add(RValue::get(Count), getContext().getNSUIntegerType());
1553 
1554   // Start the enumeration.
1555   RValue CountRV =
1556       CGM.getObjCRuntime().GenerateMessageSend(*this, ReturnValueSlot(),
1557                                                getContext().getNSUIntegerType(),
1558                                                FastEnumSel, Collection, Args);
1559 
1560   // The initial number of objects that were returned in the buffer.
1561   llvm::Value *initialBufferLimit = CountRV.getScalarVal();
1562 
1563   llvm::BasicBlock *EmptyBB = createBasicBlock("forcoll.empty");
1564   llvm::BasicBlock *LoopInitBB = createBasicBlock("forcoll.loopinit");
1565 
1566   llvm::Value *zero = llvm::Constant::getNullValue(NSUIntegerTy);
1567 
1568   // If the limit pointer was zero to begin with, the collection is
1569   // empty; skip all this. Set the branch weight assuming this has the same
1570   // probability of exiting the loop as any other loop exit.
1571   uint64_t EntryCount = getCurrentProfileCount();
1572   Builder.CreateCondBr(
1573       Builder.CreateICmpEQ(initialBufferLimit, zero, "iszero"), EmptyBB,
1574       LoopInitBB,
1575       createProfileWeights(EntryCount, getProfileCount(S.getBody())));
1576 
1577   // Otherwise, initialize the loop.
1578   EmitBlock(LoopInitBB);
1579 
1580   // 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:.
1583   Address StateMutationsPtrPtr = Builder.CreateStructGEP(
1584       StatePtr, 2, 2 * getPointerSize(), "mutationsptr.ptr");
1585   llvm::Value *StateMutationsPtr
1586     = Builder.CreateLoad(StateMutationsPtrPtr, "mutationsptr");
1587 
1588   llvm::Value *initialMutations =
1589     Builder.CreateAlignedLoad(StateMutationsPtr, getPointerAlign(),
1590                               "forcoll.initial-mutations");
1591 
1592   // 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);
1596 
1597   // The current index into the buffer.
1598   llvm::PHINode *index = Builder.CreatePHI(NSUIntegerTy, 3, "forcoll.index");
1599   index->addIncoming(zero, LoopInitBB);
1600 
1601   // The current buffer size.
1602   llvm::PHINode *count = Builder.CreatePHI(NSUIntegerTy, 3, "forcoll.count");
1603   count->addIncoming(initialBufferLimit, LoopInitBB);
1604 
1605   incrementProfileCounter(&S);
1606 
1607   // Check whether the mutations value has changed from where it was
1608   // at start.  StateMutationsPtr should actually be invariant between
1609   // refreshes.
1610   StateMutationsPtr = Builder.CreateLoad(StateMutationsPtrPtr, "mutationsptr");
1611   llvm::Value *currentMutations
1612     = Builder.CreateAlignedLoad(StateMutationsPtr, getPointerAlign(),
1613                                 "statemutations");
1614 
1615   llvm::BasicBlock *WasMutatedBB = createBasicBlock("forcoll.mutated");
1616   llvm::BasicBlock *WasNotMutatedBB = createBasicBlock("forcoll.notmutated");
1617 
1618   Builder.CreateCondBr(Builder.CreateICmpEQ(currentMutations, initialMutations),
1619                        WasNotMutatedBB, WasMutatedBB);
1620 
1621   // If so, call the enumeration-mutation function.
1622   EmitBlock(WasMutatedBB);
1623   llvm::Value *V =
1624     Builder.CreateBitCast(Collection,
1625                           ConvertType(getContext().getObjCIdType()));
1626   CallArgList Args2;
1627   Args2.add(RValue::get(V), getContext().getObjCIdType());
1628   // FIXME: We shouldn't need to get the function info here, the runtime already
1629   // should have computed it to build the function.
1630   EmitCall(
1631           CGM.getTypes().arrangeBuiltinFunctionCall(getContext().VoidTy, Args2),
1632            EnumerationMutationFn, ReturnValueSlot(), Args2);
1633 
1634   // Otherwise, or if the mutation function returns, just continue.
1635   EmitBlock(WasNotMutatedBB);
1636 
1637   // Initialize the element variable.
1638   RunCleanupsScope elementVariableScope(*this);
1639   bool elementIsVariable;
1640   LValue elementLValue;
1641   QualType elementType;
1642   if (const DeclStmt *SD = dyn_cast<DeclStmt>(S.getElement())) {
1643     // Initialize the variable, in case it's a __block variable or something.
1644     EmitAutoVarInit(variable);
1645 
1646     const VarDecl* D = cast<VarDecl>(SD->getSingleDecl());
1647     DeclRefExpr tempDRE(const_cast<VarDecl*>(D), false, D->getType(),
1648                         VK_LValue, SourceLocation());
1649     elementLValue = EmitLValue(&tempDRE);
1650     elementType = D->getType();
1651     elementIsVariable = true;
1652 
1653     if (D->isARCPseudoStrong())
1654       elementLValue.getQuals().setObjCLifetime(Qualifiers::OCL_ExplicitNone);
1655   } else {
1656     elementLValue = LValue(); // suppress warning
1657     elementType = cast<Expr>(S.getElement())->getType();
1658     elementIsVariable = false;
1659   }
1660   llvm::Type *convertedElementType = ConvertType(elementType);
1661 
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.
1665   Address StateItemsPtr = Builder.CreateStructGEP(
1666       StatePtr, 1, getPointerSize(), "stateitems.ptr");
1667   llvm::Value *EnumStateItems =
1668     Builder.CreateLoad(StateItemsPtr, "stateitems");
1669 
1670   // Fetch the value at the current index from the buffer.
1671   llvm::Value *CurrentItemPtr =
1672     Builder.CreateGEP(EnumStateItems, index, "currentitem.ptr");
1673   llvm::Value *CurrentItem =
1674     Builder.CreateAlignedLoad(CurrentItemPtr, getPointerAlign());
1675 
1676   // Cast that value to the right type.
1677   CurrentItem = Builder.CreateBitCast(CurrentItem, convertedElementType,
1678                                       "currentitem");
1679 
1680   // Make sure we have an l-value.  Yes, this gets evaluated every
1681   // time through the loop.
1682   if (!elementIsVariable) {
1683     elementLValue = EmitLValue(cast<Expr>(S.getElement()));
1684     EmitStoreThroughLValue(RValue::get(CurrentItem), elementLValue);
1685   } else {
1686     EmitStoreThroughLValue(RValue::get(CurrentItem), elementLValue,
1687                            /*isInit*/ true);
1688   }
1689 
1690   // If we do have an element variable, this assignment is the end of
1691   // its initialization.
1692   if (elementIsVariable)
1693     EmitAutoVarCleanups(variable);
1694 
1695   // Perform the loop body, setting up break and continue labels.
1696   BreakContinueStack.push_back(BreakContinue(LoopEnd, AfterBody));
1697   {
1698     RunCleanupsScope Scope(*this);
1699     EmitStmt(S.getBody());
1700   }
1701   BreakContinueStack.pop_back();
1702 
1703   // Destroy the element variable now.
1704   elementVariableScope.ForceCleanup();
1705 
1706   // Check whether there are more elements.
1707   EmitBlock(AfterBody.getBlock());
1708 
1709   llvm::BasicBlock *FetchMoreBB = createBasicBlock("forcoll.refetch");
1710 
1711   // First we check in the local buffer.
1712   llvm::Value *indexPlusOne =
1713       Builder.CreateAdd(index, llvm::ConstantInt::get(NSUIntegerTy, 1));
1714 
1715   // If we haven't overrun the buffer yet, we can continue.
1716   // 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.
1719   Builder.CreateCondBr(
1720       Builder.CreateICmpULT(indexPlusOne, count), LoopBodyBB, FetchMoreBB,
1721       createProfileWeights(getProfileCount(S.getBody()), EntryCount));
1722 
1723   index->addIncoming(indexPlusOne, AfterBody.getBlock());
1724   count->addIncoming(count, AfterBody.getBlock());
1725 
1726   // Otherwise, we have to fetch more elements.
1727   EmitBlock(FetchMoreBB);
1728 
1729   CountRV =
1730       CGM.getObjCRuntime().GenerateMessageSend(*this, ReturnValueSlot(),
1731                                                getContext().getNSUIntegerType(),
1732                                                FastEnumSel, Collection, Args);
1733 
1734   // If we got a zero count, we're done.
1735   llvm::Value *refetchCount = CountRV.getScalarVal();
1736 
1737   // (note that the message send might split FetchMoreBB)
1738   index->addIncoming(zero, Builder.GetInsertBlock());
1739   count->addIncoming(refetchCount, Builder.GetInsertBlock());
1740 
1741   Builder.CreateCondBr(Builder.CreateICmpEQ(refetchCount, zero),
1742                        EmptyBB, LoopBodyBB);
1743 
1744   // No more elements.
1745   EmitBlock(EmptyBB);
1746 
1747   if (!elementIsVariable) {
1748     // If the element was not a declaration, set it to be null.
1749 
1750     llvm::Value *null = llvm::Constant::getNullValue(convertedElementType);
1751     elementLValue = EmitLValue(cast<Expr>(S.getElement()));
1752     EmitStoreThroughLValue(RValue::get(null), elementLValue);
1753   }
1754 
1755   if (DI)
1756     DI->EmitLexicalBlockEnd(Builder, S.getSourceRange().getEnd());
1757 
1758   ForScope.ForceCleanup();
1759   EmitBlock(LoopEnd.getBlock());
1760 }
1761 
1762 void CodeGenFunction::EmitObjCAtTryStmt(const ObjCAtTryStmt &S) {
1763   CGM.getObjCRuntime().EmitTryStmt(*this, S);
1764 }
1765 
1766 void CodeGenFunction::EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S) {
1767   CGM.getObjCRuntime().EmitThrowStmt(*this, S);
1768 }
1769 
1770 void CodeGenFunction::EmitObjCAtSynchronizedStmt(
1771                                               const ObjCAtSynchronizedStmt &S) {
1772   CGM.getObjCRuntime().EmitSynchronizedStmt(*this, S);
1773 }
1774 
1775 namespace {
1776   struct CallObjCRelease final : EHScopeStack::Cleanup {
1777     CallObjCRelease(llvm::Value *object) : object(object) {}
1778     llvm::Value *object;
1779 
1780     void Emit(CodeGenFunction &CGF, Flags flags) override {
1781       // Releases at the end of the full-expression are imprecise.
1782       CGF.EmitARCRelease(object, ARCImpreciseLifetime);
1783     }
1784   };
1785 }
1786 
1787 /// Produce the code for a CK_ARCConsumeObject.  Does a primitive
1788 /// release at the end of the full-expression.
1789 llvm::Value *CodeGenFunction::EmitObjCConsumeObject(QualType type,
1790                                                     llvm::Value *object) {
1791   // If we're in a conditional branch, we need to make the cleanup
1792   // conditional.
1793   pushFullExprCleanup<CallObjCRelease>(getARCCleanupKind(), object);
1794   return object;
1795 }
1796 
1797 llvm::Value *CodeGenFunction::EmitObjCExtendObjectLifetime(QualType type,
1798                                                            llvm::Value *value) {
1799   return EmitARCRetainAutorelease(type, value);
1800 }
1801 
1802 /// Given a number of pointers, inform the optimizer that they're
1803 /// being intrinsically used up until this point in the program.
1804 void CodeGenFunction::EmitARCIntrinsicUse(ArrayRef<llvm::Value*> values) {
1805   llvm::Constant *&fn = CGM.getObjCEntrypoints().clang_arc_use;
1806   if (!fn) {
1807     llvm::FunctionType *fnType =
1808       llvm::FunctionType::get(CGM.VoidTy, None, true);
1809     fn = CGM.CreateRuntimeFunction(fnType, "clang.arc.use");
1810   }
1811 
1812   // This isn't really a "runtime" function, but as an intrinsic it
1813   // doesn't really matter as long as we align things up.
1814   EmitNounwindRuntimeCall(fn, values);
1815 }
1816 
1817 
1818 static bool IsForwarding(StringRef Name) {
1819   return llvm::StringSwitch<bool>(Name)
1820       .Cases("objc_autoreleaseReturnValue",             // ARCInstKind::AutoreleaseRV
1821              "objc_autorelease",                        // ARCInstKind::Autorelease
1822              "objc_retainAutoreleaseReturnValue",       // ARCInstKind::FusedRetainAutoreleaseRV
1823              "objc_retainAutoreleasedReturnValue",      // ARCInstKind::RetainRV
1824              "objc_retainAutorelease",                  // ARCInstKind::FusedRetainAutorelease
1825              "objc_retainedObject",                     // ARCInstKind::NoopCast
1826              "objc_retain",                             // ARCInstKind::Retain
1827              "objc_unretainedObject",                   // ARCInstKind::NoopCast
1828              "objc_unretainedPointer",                  // ARCInstKind::NoopCast
1829              "objc_unsafeClaimAutoreleasedReturnValue", // ARCInstKind::ClaimRV
1830              true)
1831       .Default(false);
1832 }
1833 
1834 static llvm::Constant *createARCRuntimeFunction(CodeGenModule &CGM,
1835                                                 llvm::FunctionType *FTy,
1836                                                 StringRef Name) {
1837   llvm::Constant *RTF = CGM.CreateRuntimeFunction(FTy, Name);
1838 
1839   if (auto *F = dyn_cast<llvm::Function>(RTF)) {
1840     // If the target runtime doesn't naturally support ARC, emit weak
1841     // references to the runtime support library.  We don't really
1842     // permit this to fail, but we need a particular relocation style.
1843     if (!CGM.getLangOpts().ObjCRuntime.hasNativeARC() &&
1844         !CGM.getTriple().isOSBinFormatCOFF()) {
1845       F->setLinkage(llvm::Function::ExternalWeakLinkage);
1846     } else if (Name == "objc_retain" || Name  == "objc_release") {
1847       // If we have Native ARC, set nonlazybind attribute for these APIs for
1848       // performance.
1849       F->addFnAttr(llvm::Attribute::NonLazyBind);
1850     }
1851 
1852     if (IsForwarding(Name))
1853       F->arg_begin()->addAttr(llvm::Attribute::Returned);
1854   }
1855 
1856   return RTF;
1857 }
1858 
1859 /// Perform an operation having the signature
1860 ///   i8* (i8*)
1861 /// where a null input causes a no-op and returns null.
1862 static llvm::Value *emitARCValueOperation(CodeGenFunction &CGF,
1863                                           llvm::Value *value,
1864                                           llvm::Constant *&fn,
1865                                           StringRef fnName,
1866                                           bool isTailCall = false) {
1867   if (isa<llvm::ConstantPointerNull>(value))
1868     return value;
1869 
1870   if (!fn) {
1871     llvm::FunctionType *fnType =
1872       llvm::FunctionType::get(CGF.Int8PtrTy, CGF.Int8PtrTy, false);
1873     fn = createARCRuntimeFunction(CGF.CGM, fnType, fnName);
1874   }
1875 
1876   // Cast the argument to 'id'.
1877   llvm::Type *origType = value->getType();
1878   value = CGF.Builder.CreateBitCast(value, CGF.Int8PtrTy);
1879 
1880   // Call the function.
1881   llvm::CallInst *call = CGF.EmitNounwindRuntimeCall(fn, value);
1882   if (isTailCall)
1883     call->setTailCall();
1884 
1885   // Cast the result back to the original type.
1886   return CGF.Builder.CreateBitCast(call, origType);
1887 }
1888 
1889 /// Perform an operation having the following signature:
1890 ///   i8* (i8**)
1891 static llvm::Value *emitARCLoadOperation(CodeGenFunction &CGF,
1892                                          Address addr,
1893                                          llvm::Constant *&fn,
1894                                          StringRef fnName) {
1895   if (!fn) {
1896     llvm::FunctionType *fnType =
1897       llvm::FunctionType::get(CGF.Int8PtrTy, CGF.Int8PtrPtrTy, false);
1898     fn = createARCRuntimeFunction(CGF.CGM, fnType, fnName);
1899   }
1900 
1901   // Cast the argument to 'id*'.
1902   llvm::Type *origType = addr.getElementType();
1903   addr = CGF.Builder.CreateBitCast(addr, CGF.Int8PtrPtrTy);
1904 
1905   // Call the function.
1906   llvm::Value *result = CGF.EmitNounwindRuntimeCall(fn, addr.getPointer());
1907 
1908   // Cast the result back to a dereference of the original type.
1909   if (origType != CGF.Int8PtrTy)
1910     result = CGF.Builder.CreateBitCast(result, origType);
1911 
1912   return result;
1913 }
1914 
1915 /// Perform an operation having the following signature:
1916 ///   i8* (i8**, i8*)
1917 static llvm::Value *emitARCStoreOperation(CodeGenFunction &CGF,
1918                                           Address addr,
1919                                           llvm::Value *value,
1920                                           llvm::Constant *&fn,
1921                                           StringRef fnName,
1922                                           bool ignored) {
1923   assert(addr.getElementType() == value->getType());
1924 
1925   if (!fn) {
1926     llvm::Type *argTypes[] = { CGF.Int8PtrPtrTy, CGF.Int8PtrTy };
1927 
1928     llvm::FunctionType *fnType
1929       = llvm::FunctionType::get(CGF.Int8PtrTy, argTypes, false);
1930     fn = createARCRuntimeFunction(CGF.CGM, fnType, fnName);
1931   }
1932 
1933   llvm::Type *origType = value->getType();
1934 
1935   llvm::Value *args[] = {
1936     CGF.Builder.CreateBitCast(addr.getPointer(), CGF.Int8PtrPtrTy),
1937     CGF.Builder.CreateBitCast(value, CGF.Int8PtrTy)
1938   };
1939   llvm::CallInst *result = CGF.EmitNounwindRuntimeCall(fn, args);
1940 
1941   if (ignored) return nullptr;
1942 
1943   return CGF.Builder.CreateBitCast(result, origType);
1944 }
1945 
1946 /// Perform an operation having the following signature:
1947 ///   void (i8**, i8**)
1948 static void emitARCCopyOperation(CodeGenFunction &CGF,
1949                                  Address dst,
1950                                  Address src,
1951                                  llvm::Constant *&fn,
1952                                  StringRef fnName) {
1953   assert(dst.getType() == src.getType());
1954 
1955   if (!fn) {
1956     llvm::Type *argTypes[] = { CGF.Int8PtrPtrTy, CGF.Int8PtrPtrTy };
1957 
1958     llvm::FunctionType *fnType
1959       = llvm::FunctionType::get(CGF.Builder.getVoidTy(), argTypes, false);
1960     fn = createARCRuntimeFunction(CGF.CGM, fnType, fnName);
1961   }
1962 
1963   llvm::Value *args[] = {
1964     CGF.Builder.CreateBitCast(dst.getPointer(), CGF.Int8PtrPtrTy),
1965     CGF.Builder.CreateBitCast(src.getPointer(), CGF.Int8PtrPtrTy)
1966   };
1967   CGF.EmitNounwindRuntimeCall(fn, args);
1968 }
1969 
1970 /// Produce the code to do a retain.  Based on the type, calls one of:
1971 ///   call i8* \@objc_retain(i8* %value)
1972 ///   call i8* \@objc_retainBlock(i8* %value)
1973 llvm::Value *CodeGenFunction::EmitARCRetain(QualType type, llvm::Value *value) {
1974   if (type->isBlockPointerType())
1975     return EmitARCRetainBlock(value, /*mandatory*/ false);
1976   else
1977     return EmitARCRetainNonBlock(value);
1978 }
1979 
1980 /// Retain the given object, with normal retain semantics.
1981 ///   call i8* \@objc_retain(i8* %value)
1982 llvm::Value *CodeGenFunction::EmitARCRetainNonBlock(llvm::Value *value) {
1983   return emitARCValueOperation(*this, value,
1984                                CGM.getObjCEntrypoints().objc_retain,
1985                                "objc_retain");
1986 }
1987 
1988 /// Retain the given block, with _Block_copy semantics.
1989 ///   call i8* \@objc_retainBlock(i8* %value)
1990 ///
1991 /// \param mandatory - If false, emit the call with metadata
1992 /// indicating that it's okay for the optimizer to eliminate this call
1993 /// if it can prove that the block never escapes except down the stack.
1994 llvm::Value *CodeGenFunction::EmitARCRetainBlock(llvm::Value *value,
1995                                                  bool mandatory) {
1996   llvm::Value *result
1997     = emitARCValueOperation(*this, value,
1998                             CGM.getObjCEntrypoints().objc_retainBlock,
1999                             "objc_retainBlock");
2000 
2001   // If the copy isn't mandatory, add !clang.arc.copy_on_escape to
2002   // tell the optimizer that it doesn't need to do this copy if the
2003   // block doesn't escape, where being passed as an argument doesn't
2004   // count as escaping.
2005   if (!mandatory && isa<llvm::Instruction>(result)) {
2006     llvm::CallInst *call
2007       = cast<llvm::CallInst>(result->stripPointerCasts());
2008     assert(call->getCalledValue() == CGM.getObjCEntrypoints().objc_retainBlock);
2009 
2010     call->setMetadata("clang.arc.copy_on_escape",
2011                       llvm::MDNode::get(Builder.getContext(), None));
2012   }
2013 
2014   return result;
2015 }
2016 
2017 static void emitAutoreleasedReturnValueMarker(CodeGenFunction &CGF) {
2018   // Fetch the void(void) inline asm which marks that we're going to
2019   // do something with the autoreleased return value.
2020   llvm::InlineAsm *&marker
2021     = CGF.CGM.getObjCEntrypoints().retainAutoreleasedReturnValueMarker;
2022   if (!marker) {
2023     StringRef assembly
2024       = CGF.CGM.getTargetCodeGenInfo()
2025            .getARCRetainAutoreleasedReturnValueMarker();
2026 
2027     // If we have an empty assembly string, there's nothing to do.
2028     if (assembly.empty()) {
2029 
2030     // Otherwise, at -O0, build an inline asm that we're going to call
2031     // in a moment.
2032     } else if (CGF.CGM.getCodeGenOpts().OptimizationLevel == 0) {
2033       llvm::FunctionType *type =
2034         llvm::FunctionType::get(CGF.VoidTy, /*variadic*/false);
2035 
2036       marker = llvm::InlineAsm::get(type, assembly, "", /*sideeffects*/ true);
2037 
2038     // If we're at -O1 and above, we don't want to litter the code
2039     // with this marker yet, so leave a breadcrumb for the ARC
2040     // optimizer to pick up.
2041     } else {
2042       llvm::NamedMDNode *metadata =
2043         CGF.CGM.getModule().getOrInsertNamedMetadata(
2044                             "clang.arc.retainAutoreleasedReturnValueMarker");
2045       assert(metadata->getNumOperands() <= 1);
2046       if (metadata->getNumOperands() == 0) {
2047         auto &ctx = CGF.getLLVMContext();
2048         metadata->addOperand(llvm::MDNode::get(ctx,
2049                                      llvm::MDString::get(ctx, assembly)));
2050       }
2051     }
2052   }
2053 
2054   // Call the marker asm if we made one, which we do only at -O0.
2055   if (marker)
2056     CGF.Builder.CreateCall(marker);
2057 }
2058 
2059 /// Retain the given object which is the result of a function call.
2060 ///   call i8* \@objc_retainAutoreleasedReturnValue(i8* %value)
2061 ///
2062 /// Yes, this function name is one character away from a different
2063 /// call with completely different semantics.
2064 llvm::Value *
2065 CodeGenFunction::EmitARCRetainAutoreleasedReturnValue(llvm::Value *value) {
2066   emitAutoreleasedReturnValueMarker(*this);
2067   return emitARCValueOperation(*this, value,
2068               CGM.getObjCEntrypoints().objc_retainAutoreleasedReturnValue,
2069                                "objc_retainAutoreleasedReturnValue");
2070 }
2071 
2072 /// Claim a possibly-autoreleased return value at +0.  This is only
2073 /// valid to do in contexts which do not rely on the retain to keep
2074 /// the object valid for for all of its uses; for example, when
2075 /// the value is ignored, or when it is being assigned to an
2076 /// __unsafe_unretained variable.
2077 ///
2078 ///   call i8* \@objc_unsafeClaimAutoreleasedReturnValue(i8* %value)
2079 llvm::Value *
2080 CodeGenFunction::EmitARCUnsafeClaimAutoreleasedReturnValue(llvm::Value *value) {
2081   emitAutoreleasedReturnValueMarker(*this);
2082   return emitARCValueOperation(*this, value,
2083               CGM.getObjCEntrypoints().objc_unsafeClaimAutoreleasedReturnValue,
2084                                "objc_unsafeClaimAutoreleasedReturnValue");
2085 }
2086 
2087 /// Release the given object.
2088 ///   call void \@objc_release(i8* %value)
2089 void CodeGenFunction::EmitARCRelease(llvm::Value *value,
2090                                      ARCPreciseLifetime_t precise) {
2091   if (isa<llvm::ConstantPointerNull>(value)) return;
2092 
2093   llvm::Constant *&fn = CGM.getObjCEntrypoints().objc_release;
2094   if (!fn) {
2095     llvm::FunctionType *fnType =
2096       llvm::FunctionType::get(Builder.getVoidTy(), Int8PtrTy, false);
2097     fn = createARCRuntimeFunction(CGM, fnType, "objc_release");
2098   }
2099 
2100   // Cast the argument to 'id'.
2101   value = Builder.CreateBitCast(value, Int8PtrTy);
2102 
2103   // Call objc_release.
2104   llvm::CallInst *call = EmitNounwindRuntimeCall(fn, value);
2105 
2106   if (precise == ARCImpreciseLifetime) {
2107     call->setMetadata("clang.imprecise_release",
2108                       llvm::MDNode::get(Builder.getContext(), None));
2109   }
2110 }
2111 
2112 /// Destroy a __strong variable.
2113 ///
2114 /// At -O0, emit a call to store 'null' into the address;
2115 /// instrumenting tools prefer this because the address is exposed,
2116 /// but it's relatively cumbersome to optimize.
2117 ///
2118 /// At -O1 and above, just load and call objc_release.
2119 ///
2120 ///   call void \@objc_storeStrong(i8** %addr, i8* null)
2121 void CodeGenFunction::EmitARCDestroyStrong(Address addr,
2122                                            ARCPreciseLifetime_t precise) {
2123   if (CGM.getCodeGenOpts().OptimizationLevel == 0) {
2124     llvm::Value *null = getNullForVariable(addr);
2125     EmitARCStoreStrongCall(addr, null, /*ignored*/ true);
2126     return;
2127   }
2128 
2129   llvm::Value *value = Builder.CreateLoad(addr);
2130   EmitARCRelease(value, precise);
2131 }
2132 
2133 /// Store into a strong object.  Always calls this:
2134 ///   call void \@objc_storeStrong(i8** %addr, i8* %value)
2135 llvm::Value *CodeGenFunction::EmitARCStoreStrongCall(Address addr,
2136                                                      llvm::Value *value,
2137                                                      bool ignored) {
2138   assert(addr.getElementType() == value->getType());
2139 
2140   llvm::Constant *&fn = CGM.getObjCEntrypoints().objc_storeStrong;
2141   if (!fn) {
2142     llvm::Type *argTypes[] = { Int8PtrPtrTy, Int8PtrTy };
2143     llvm::FunctionType *fnType
2144       = llvm::FunctionType::get(Builder.getVoidTy(), argTypes, false);
2145     fn = createARCRuntimeFunction(CGM, fnType, "objc_storeStrong");
2146   }
2147 
2148   llvm::Value *args[] = {
2149     Builder.CreateBitCast(addr.getPointer(), Int8PtrPtrTy),
2150     Builder.CreateBitCast(value, Int8PtrTy)
2151   };
2152   EmitNounwindRuntimeCall(fn, args);
2153 
2154   if (ignored) return nullptr;
2155   return value;
2156 }
2157 
2158 /// Store into a strong object.  Sometimes calls this:
2159 ///   call void \@objc_storeStrong(i8** %addr, i8* %value)
2160 /// Other times, breaks it down into components.
2161 llvm::Value *CodeGenFunction::EmitARCStoreStrong(LValue dst,
2162                                                  llvm::Value *newValue,
2163                                                  bool ignored) {
2164   QualType type = dst.getType();
2165   bool isBlock = type->isBlockPointerType();
2166 
2167   // Use a store barrier at -O0 unless this is a block type or the
2168   // lvalue is inadequately aligned.
2169   if (shouldUseFusedARCCalls() &&
2170       !isBlock &&
2171       (dst.getAlignment().isZero() ||
2172        dst.getAlignment() >= CharUnits::fromQuantity(PointerAlignInBytes))) {
2173     return EmitARCStoreStrongCall(dst.getAddress(), newValue, ignored);
2174   }
2175 
2176   // Otherwise, split it out.
2177 
2178   // Retain the new value.
2179   newValue = EmitARCRetain(type, newValue);
2180 
2181   // Read the old value.
2182   llvm::Value *oldValue = EmitLoadOfScalar(dst, SourceLocation());
2183 
2184   // Store.  We do this before the release so that any deallocs won't
2185   // see the old value.
2186   EmitStoreOfScalar(newValue, dst);
2187 
2188   // Finally, release the old value.
2189   EmitARCRelease(oldValue, dst.isARCPreciseLifetime());
2190 
2191   return newValue;
2192 }
2193 
2194 /// Autorelease the given object.
2195 ///   call i8* \@objc_autorelease(i8* %value)
2196 llvm::Value *CodeGenFunction::EmitARCAutorelease(llvm::Value *value) {
2197   return emitARCValueOperation(*this, value,
2198                                CGM.getObjCEntrypoints().objc_autorelease,
2199                                "objc_autorelease");
2200 }
2201 
2202 /// Autorelease the given object.
2203 ///   call i8* \@objc_autoreleaseReturnValue(i8* %value)
2204 llvm::Value *
2205 CodeGenFunction::EmitARCAutoreleaseReturnValue(llvm::Value *value) {
2206   return emitARCValueOperation(*this, value,
2207                             CGM.getObjCEntrypoints().objc_autoreleaseReturnValue,
2208                                "objc_autoreleaseReturnValue",
2209                                /*isTailCall*/ true);
2210 }
2211 
2212 /// Do a fused retain/autorelease of the given object.
2213 ///   call i8* \@objc_retainAutoreleaseReturnValue(i8* %value)
2214 llvm::Value *
2215 CodeGenFunction::EmitARCRetainAutoreleaseReturnValue(llvm::Value *value) {
2216   return emitARCValueOperation(*this, value,
2217                      CGM.getObjCEntrypoints().objc_retainAutoreleaseReturnValue,
2218                                "objc_retainAutoreleaseReturnValue",
2219                                /*isTailCall*/ true);
2220 }
2221 
2222 /// Do a fused retain/autorelease of the given object.
2223 ///   call i8* \@objc_retainAutorelease(i8* %value)
2224 /// or
2225 ///   %retain = call i8* \@objc_retainBlock(i8* %value)
2226 ///   call i8* \@objc_autorelease(i8* %retain)
2227 llvm::Value *CodeGenFunction::EmitARCRetainAutorelease(QualType type,
2228                                                        llvm::Value *value) {
2229   if (!type->isBlockPointerType())
2230     return EmitARCRetainAutoreleaseNonBlock(value);
2231 
2232   if (isa<llvm::ConstantPointerNull>(value)) return value;
2233 
2234   llvm::Type *origType = value->getType();
2235   value = Builder.CreateBitCast(value, Int8PtrTy);
2236   value = EmitARCRetainBlock(value, /*mandatory*/ true);
2237   value = EmitARCAutorelease(value);
2238   return Builder.CreateBitCast(value, origType);
2239 }
2240 
2241 /// Do a fused retain/autorelease of the given object.
2242 ///   call i8* \@objc_retainAutorelease(i8* %value)
2243 llvm::Value *
2244 CodeGenFunction::EmitARCRetainAutoreleaseNonBlock(llvm::Value *value) {
2245   return emitARCValueOperation(*this, value,
2246                                CGM.getObjCEntrypoints().objc_retainAutorelease,
2247                                "objc_retainAutorelease");
2248 }
2249 
2250 /// i8* \@objc_loadWeak(i8** %addr)
2251 /// Essentially objc_autorelease(objc_loadWeakRetained(addr)).
2252 llvm::Value *CodeGenFunction::EmitARCLoadWeak(Address addr) {
2253   return emitARCLoadOperation(*this, addr,
2254                               CGM.getObjCEntrypoints().objc_loadWeak,
2255                               "objc_loadWeak");
2256 }
2257 
2258 /// i8* \@objc_loadWeakRetained(i8** %addr)
2259 llvm::Value *CodeGenFunction::EmitARCLoadWeakRetained(Address addr) {
2260   return emitARCLoadOperation(*this, addr,
2261                               CGM.getObjCEntrypoints().objc_loadWeakRetained,
2262                               "objc_loadWeakRetained");
2263 }
2264 
2265 /// i8* \@objc_storeWeak(i8** %addr, i8* %value)
2266 /// Returns %value.
2267 llvm::Value *CodeGenFunction::EmitARCStoreWeak(Address addr,
2268                                                llvm::Value *value,
2269                                                bool ignored) {
2270   return emitARCStoreOperation(*this, addr, value,
2271                                CGM.getObjCEntrypoints().objc_storeWeak,
2272                                "objc_storeWeak", ignored);
2273 }
2274 
2275 /// i8* \@objc_initWeak(i8** %addr, i8* %value)
2276 /// Returns %value.  %addr is known to not have a current weak entry.
2277 /// Essentially equivalent to:
2278 ///   *addr = nil; objc_storeWeak(addr, value);
2279 void CodeGenFunction::EmitARCInitWeak(Address addr, llvm::Value *value) {
2280   // If we're initializing to null, just write null to memory; no need
2281   // to get the runtime involved.  But don't do this if optimization
2282   // is enabled, because accounting for this would make the optimizer
2283   // much more complicated.
2284   if (isa<llvm::ConstantPointerNull>(value) &&
2285       CGM.getCodeGenOpts().OptimizationLevel == 0) {
2286     Builder.CreateStore(value, addr);
2287     return;
2288   }
2289 
2290   emitARCStoreOperation(*this, addr, value,
2291                         CGM.getObjCEntrypoints().objc_initWeak,
2292                         "objc_initWeak", /*ignored*/ true);
2293 }
2294 
2295 /// void \@objc_destroyWeak(i8** %addr)
2296 /// Essentially objc_storeWeak(addr, nil).
2297 void CodeGenFunction::EmitARCDestroyWeak(Address addr) {
2298   llvm::Constant *&fn = CGM.getObjCEntrypoints().objc_destroyWeak;
2299   if (!fn) {
2300     llvm::FunctionType *fnType =
2301       llvm::FunctionType::get(Builder.getVoidTy(), Int8PtrPtrTy, false);
2302     fn = createARCRuntimeFunction(CGM, fnType, "objc_destroyWeak");
2303   }
2304 
2305   // Cast the argument to 'id*'.
2306   addr = Builder.CreateBitCast(addr, Int8PtrPtrTy);
2307 
2308   EmitNounwindRuntimeCall(fn, addr.getPointer());
2309 }
2310 
2311 /// void \@objc_moveWeak(i8** %dest, i8** %src)
2312 /// Disregards the current value in %dest.  Leaves %src pointing to nothing.
2313 /// Essentially (objc_copyWeak(dest, src), objc_destroyWeak(src)).
2314 void CodeGenFunction::EmitARCMoveWeak(Address dst, Address src) {
2315   emitARCCopyOperation(*this, dst, src,
2316                        CGM.getObjCEntrypoints().objc_moveWeak,
2317                        "objc_moveWeak");
2318 }
2319 
2320 /// void \@objc_copyWeak(i8** %dest, i8** %src)
2321 /// Disregards the current value in %dest.  Essentially
2322 ///   objc_release(objc_initWeak(dest, objc_readWeakRetained(src)))
2323 void CodeGenFunction::EmitARCCopyWeak(Address dst, Address src) {
2324   emitARCCopyOperation(*this, dst, src,
2325                        CGM.getObjCEntrypoints().objc_copyWeak,
2326                        "objc_copyWeak");
2327 }
2328 
2329 /// Produce the code to do a objc_autoreleasepool_push.
2330 ///   call i8* \@objc_autoreleasePoolPush(void)
2331 llvm::Value *CodeGenFunction::EmitObjCAutoreleasePoolPush() {
2332   llvm::Constant *&fn = CGM.getObjCEntrypoints().objc_autoreleasePoolPush;
2333   if (!fn) {
2334     llvm::FunctionType *fnType =
2335       llvm::FunctionType::get(Int8PtrTy, false);
2336     fn = createARCRuntimeFunction(CGM, fnType, "objc_autoreleasePoolPush");
2337   }
2338 
2339   return EmitNounwindRuntimeCall(fn);
2340 }
2341 
2342 /// Produce the code to do a primitive release.
2343 ///   call void \@objc_autoreleasePoolPop(i8* %ptr)
2344 void CodeGenFunction::EmitObjCAutoreleasePoolPop(llvm::Value *value) {
2345   assert(value->getType() == Int8PtrTy);
2346 
2347   llvm::Constant *&fn = CGM.getObjCEntrypoints().objc_autoreleasePoolPop;
2348   if (!fn) {
2349     llvm::FunctionType *fnType =
2350       llvm::FunctionType::get(Builder.getVoidTy(), Int8PtrTy, false);
2351 
2352     // We don't want to use a weak import here; instead we should not
2353     // fall into this path.
2354     fn = createARCRuntimeFunction(CGM, fnType, "objc_autoreleasePoolPop");
2355   }
2356 
2357   // objc_autoreleasePoolPop can throw.
2358   EmitRuntimeCallOrInvoke(fn, value);
2359 }
2360 
2361 /// Produce the code to do an MRR version objc_autoreleasepool_push.
2362 /// Which is: [[NSAutoreleasePool alloc] init];
2363 /// Where alloc is declared as: + (id) alloc; in NSAutoreleasePool class.
2364 /// init is declared as: - (id) init; in its NSObject super class.
2365 ///
2366 llvm::Value *CodeGenFunction::EmitObjCMRRAutoreleasePoolPush() {
2367   CGObjCRuntime &Runtime = CGM.getObjCRuntime();
2368   llvm::Value *Receiver = Runtime.EmitNSAutoreleasePoolClassRef(*this);
2369   // [NSAutoreleasePool alloc]
2370   IdentifierInfo *II = &CGM.getContext().Idents.get("alloc");
2371   Selector AllocSel = getContext().Selectors.getSelector(0, &II);
2372   CallArgList Args;
2373   RValue AllocRV =
2374     Runtime.GenerateMessageSend(*this, ReturnValueSlot(),
2375                                 getContext().getObjCIdType(),
2376                                 AllocSel, Receiver, Args);
2377 
2378   // [Receiver init]
2379   Receiver = AllocRV.getScalarVal();
2380   II = &CGM.getContext().Idents.get("init");
2381   Selector InitSel = getContext().Selectors.getSelector(0, &II);
2382   RValue InitRV =
2383     Runtime.GenerateMessageSend(*this, ReturnValueSlot(),
2384                                 getContext().getObjCIdType(),
2385                                 InitSel, Receiver, Args);
2386   return InitRV.getScalarVal();
2387 }
2388 
2389 /// Produce the code to do a primitive release.
2390 /// [tmp drain];
2391 void CodeGenFunction::EmitObjCMRRAutoreleasePoolPop(llvm::Value *Arg) {
2392   IdentifierInfo *II = &CGM.getContext().Idents.get("drain");
2393   Selector DrainSel = getContext().Selectors.getSelector(0, &II);
2394   CallArgList Args;
2395   CGM.getObjCRuntime().GenerateMessageSend(*this, ReturnValueSlot(),
2396                               getContext().VoidTy, DrainSel, Arg, Args);
2397 }
2398 
2399 void CodeGenFunction::destroyARCStrongPrecise(CodeGenFunction &CGF,
2400                                               Address addr,
2401                                               QualType type) {
2402   CGF.EmitARCDestroyStrong(addr, ARCPreciseLifetime);
2403 }
2404 
2405 void CodeGenFunction::destroyARCStrongImprecise(CodeGenFunction &CGF,
2406                                                 Address addr,
2407                                                 QualType type) {
2408   CGF.EmitARCDestroyStrong(addr, ARCImpreciseLifetime);
2409 }
2410 
2411 void CodeGenFunction::destroyARCWeak(CodeGenFunction &CGF,
2412                                      Address addr,
2413                                      QualType type) {
2414   CGF.EmitARCDestroyWeak(addr);
2415 }
2416 
2417 void CodeGenFunction::emitARCIntrinsicUse(CodeGenFunction &CGF, Address addr,
2418                                           QualType type) {
2419   llvm::Value *value = CGF.Builder.CreateLoad(addr);
2420   CGF.EmitARCIntrinsicUse(value);
2421 }
2422 
2423 namespace {
2424   struct CallObjCAutoreleasePoolObject final : EHScopeStack::Cleanup {
2425     llvm::Value *Token;
2426 
2427     CallObjCAutoreleasePoolObject(llvm::Value *token) : Token(token) {}
2428 
2429     void Emit(CodeGenFunction &CGF, Flags flags) override {
2430       CGF.EmitObjCAutoreleasePoolPop(Token);
2431     }
2432   };
2433   struct CallObjCMRRAutoreleasePoolObject final : EHScopeStack::Cleanup {
2434     llvm::Value *Token;
2435 
2436     CallObjCMRRAutoreleasePoolObject(llvm::Value *token) : Token(token) {}
2437 
2438     void Emit(CodeGenFunction &CGF, Flags flags) override {
2439       CGF.EmitObjCMRRAutoreleasePoolPop(Token);
2440     }
2441   };
2442 }
2443 
2444 void CodeGenFunction::EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr) {
2445   if (CGM.getLangOpts().ObjCAutoRefCount)
2446     EHStack.pushCleanup<CallObjCAutoreleasePoolObject>(NormalCleanup, Ptr);
2447   else
2448     EHStack.pushCleanup<CallObjCMRRAutoreleasePoolObject>(NormalCleanup, Ptr);
2449 }
2450 
2451 static TryEmitResult tryEmitARCRetainLoadOfScalar(CodeGenFunction &CGF,
2452                                                   LValue lvalue,
2453                                                   QualType type) {
2454   switch (type.getObjCLifetime()) {
2455   case Qualifiers::OCL_None:
2456   case Qualifiers::OCL_ExplicitNone:
2457   case Qualifiers::OCL_Strong:
2458   case Qualifiers::OCL_Autoreleasing:
2459     return TryEmitResult(CGF.EmitLoadOfLValue(lvalue,
2460                                               SourceLocation()).getScalarVal(),
2461                          false);
2462 
2463   case Qualifiers::OCL_Weak:
2464     return TryEmitResult(CGF.EmitARCLoadWeakRetained(lvalue.getAddress()),
2465                          true);
2466   }
2467 
2468   llvm_unreachable("impossible lifetime!");
2469 }
2470 
2471 static TryEmitResult tryEmitARCRetainLoadOfScalar(CodeGenFunction &CGF,
2472                                                   const Expr *e) {
2473   e = e->IgnoreParens();
2474   QualType type = e->getType();
2475 
2476   // If we're loading retained from a __strong xvalue, we can avoid
2477   // an extra retain/release pair by zeroing out the source of this
2478   // "move" operation.
2479   if (e->isXValue() &&
2480       !type.isConstQualified() &&
2481       type.getObjCLifetime() == Qualifiers::OCL_Strong) {
2482     // Emit the lvalue.
2483     LValue lv = CGF.EmitLValue(e);
2484 
2485     // Load the object pointer.
2486     llvm::Value *result = CGF.EmitLoadOfLValue(lv,
2487                                                SourceLocation()).getScalarVal();
2488 
2489     // Set the source pointer to NULL.
2490     CGF.EmitStoreOfScalar(getNullForVariable(lv.getAddress()), lv);
2491 
2492     return TryEmitResult(result, true);
2493   }
2494 
2495   // As a very special optimization, in ARC++, if the l-value is the
2496   // result of a non-volatile assignment, do a simple retain of the
2497   // result of the call to objc_storeWeak instead of reloading.
2498   if (CGF.getLangOpts().CPlusPlus &&
2499       !type.isVolatileQualified() &&
2500       type.getObjCLifetime() == Qualifiers::OCL_Weak &&
2501       isa<BinaryOperator>(e) &&
2502       cast<BinaryOperator>(e)->getOpcode() == BO_Assign)
2503     return TryEmitResult(CGF.EmitScalarExpr(e), false);
2504 
2505   return tryEmitARCRetainLoadOfScalar(CGF, CGF.EmitLValue(e), type);
2506 }
2507 
2508 typedef llvm::function_ref<llvm::Value *(CodeGenFunction &CGF,
2509                                          llvm::Value *value)>
2510   ValueTransform;
2511 
2512 /// Insert code immediately after a call.
2513 static llvm::Value *emitARCOperationAfterCall(CodeGenFunction &CGF,
2514                                               llvm::Value *value,
2515                                               ValueTransform doAfterCall,
2516                                               ValueTransform doFallback) {
2517   if (llvm::CallInst *call = dyn_cast<llvm::CallInst>(value)) {
2518     CGBuilderTy::InsertPoint ip = CGF.Builder.saveIP();
2519 
2520     // Place the retain immediately following the call.
2521     CGF.Builder.SetInsertPoint(call->getParent(),
2522                                ++llvm::BasicBlock::iterator(call));
2523     value = doAfterCall(CGF, value);
2524 
2525     CGF.Builder.restoreIP(ip);
2526     return value;
2527   } else if (llvm::InvokeInst *invoke = dyn_cast<llvm::InvokeInst>(value)) {
2528     CGBuilderTy::InsertPoint ip = CGF.Builder.saveIP();
2529 
2530     // Place the retain at the beginning of the normal destination block.
2531     llvm::BasicBlock *BB = invoke->getNormalDest();
2532     CGF.Builder.SetInsertPoint(BB, BB->begin());
2533     value = doAfterCall(CGF, value);
2534 
2535     CGF.Builder.restoreIP(ip);
2536     return value;
2537 
2538   // Bitcasts can arise because of related-result returns.  Rewrite
2539   // the operand.
2540   } else if (llvm::BitCastInst *bitcast = dyn_cast<llvm::BitCastInst>(value)) {
2541     llvm::Value *operand = bitcast->getOperand(0);
2542     operand = emitARCOperationAfterCall(CGF, operand, doAfterCall, doFallback);
2543     bitcast->setOperand(0, operand);
2544     return bitcast;
2545 
2546   // Generic fall-back case.
2547   } else {
2548     // Retain using the non-block variant: we never need to do a copy
2549     // of a block that's been returned to us.
2550     return doFallback(CGF, value);
2551   }
2552 }
2553 
2554 /// Given that the given expression is some sort of call (which does
2555 /// not return retained), emit a retain following it.
2556 static llvm::Value *emitARCRetainCallResult(CodeGenFunction &CGF,
2557                                             const Expr *e) {
2558   llvm::Value *value = CGF.EmitScalarExpr(e);
2559   return emitARCOperationAfterCall(CGF, value,
2560            [](CodeGenFunction &CGF, llvm::Value *value) {
2561              return CGF.EmitARCRetainAutoreleasedReturnValue(value);
2562            },
2563            [](CodeGenFunction &CGF, llvm::Value *value) {
2564              return CGF.EmitARCRetainNonBlock(value);
2565            });
2566 }
2567 
2568 /// Given that the given expression is some sort of call (which does
2569 /// not return retained), perform an unsafeClaim following it.
2570 static llvm::Value *emitARCUnsafeClaimCallResult(CodeGenFunction &CGF,
2571                                                  const Expr *e) {
2572   llvm::Value *value = CGF.EmitScalarExpr(e);
2573   return emitARCOperationAfterCall(CGF, value,
2574            [](CodeGenFunction &CGF, llvm::Value *value) {
2575              return CGF.EmitARCUnsafeClaimAutoreleasedReturnValue(value);
2576            },
2577            [](CodeGenFunction &CGF, llvm::Value *value) {
2578              return value;
2579            });
2580 }
2581 
2582 llvm::Value *CodeGenFunction::EmitARCReclaimReturnedObject(const Expr *E,
2583                                                       bool allowUnsafeClaim) {
2584   if (allowUnsafeClaim &&
2585       CGM.getLangOpts().ObjCRuntime.hasARCUnsafeClaimAutoreleasedReturnValue()) {
2586     return emitARCUnsafeClaimCallResult(*this, E);
2587   } else {
2588     llvm::Value *value = emitARCRetainCallResult(*this, E);
2589     return EmitObjCConsumeObject(E->getType(), value);
2590   }
2591 }
2592 
2593 /// Determine whether it might be important to emit a separate
2594 /// objc_retain_block on the result of the given expression, or
2595 /// whether it's okay to just emit it in a +1 context.
2596 static bool shouldEmitSeparateBlockRetain(const Expr *e) {
2597   assert(e->getType()->isBlockPointerType());
2598   e = e->IgnoreParens();
2599 
2600   // For future goodness, emit block expressions directly in +1
2601   // contexts if we can.
2602   if (isa<BlockExpr>(e))
2603     return false;
2604 
2605   if (const CastExpr *cast = dyn_cast<CastExpr>(e)) {
2606     switch (cast->getCastKind()) {
2607     // Emitting these operations in +1 contexts is goodness.
2608     case CK_LValueToRValue:
2609     case CK_ARCReclaimReturnedObject:
2610     case CK_ARCConsumeObject:
2611     case CK_ARCProduceObject:
2612       return false;
2613 
2614     // These operations preserve a block type.
2615     case CK_NoOp:
2616     case CK_BitCast:
2617       return shouldEmitSeparateBlockRetain(cast->getSubExpr());
2618 
2619     // These operations are known to be bad (or haven't been considered).
2620     case CK_AnyPointerToBlockPointerCast:
2621     default:
2622       return true;
2623     }
2624   }
2625 
2626   return true;
2627 }
2628 
2629 namespace {
2630 /// A CRTP base class for emitting expressions of retainable object
2631 /// pointer type in ARC.
2632 template <typename Impl, typename Result> class ARCExprEmitter {
2633 protected:
2634   CodeGenFunction &CGF;
2635   Impl &asImpl() { return *static_cast<Impl*>(this); }
2636 
2637   ARCExprEmitter(CodeGenFunction &CGF) : CGF(CGF) {}
2638 
2639 public:
2640   Result visit(const Expr *e);
2641   Result visitCastExpr(const CastExpr *e);
2642   Result visitPseudoObjectExpr(const PseudoObjectExpr *e);
2643   Result visitBinaryOperator(const BinaryOperator *e);
2644   Result visitBinAssign(const BinaryOperator *e);
2645   Result visitBinAssignUnsafeUnretained(const BinaryOperator *e);
2646   Result visitBinAssignAutoreleasing(const BinaryOperator *e);
2647   Result visitBinAssignWeak(const BinaryOperator *e);
2648   Result visitBinAssignStrong(const BinaryOperator *e);
2649 
2650   // Minimal implementation:
2651   //   Result visitLValueToRValue(const Expr *e)
2652   //   Result visitConsumeObject(const Expr *e)
2653   //   Result visitExtendBlockObject(const Expr *e)
2654   //   Result visitReclaimReturnedObject(const Expr *e)
2655   //   Result visitCall(const Expr *e)
2656   //   Result visitExpr(const Expr *e)
2657   //
2658   //   Result emitBitCast(Result result, llvm::Type *resultType)
2659   //   llvm::Value *getValueOfResult(Result result)
2660 };
2661 }
2662 
2663 /// Try to emit a PseudoObjectExpr under special ARC rules.
2664 ///
2665 /// This massively duplicates emitPseudoObjectRValue.
2666 template <typename Impl, typename Result>
2667 Result
2668 ARCExprEmitter<Impl,Result>::visitPseudoObjectExpr(const PseudoObjectExpr *E) {
2669   SmallVector<CodeGenFunction::OpaqueValueMappingData, 4> opaques;
2670 
2671   // Find the result expression.
2672   const Expr *resultExpr = E->getResultExpr();
2673   assert(resultExpr);
2674   Result result;
2675 
2676   for (PseudoObjectExpr::const_semantics_iterator
2677          i = E->semantics_begin(), e = E->semantics_end(); i != e; ++i) {
2678     const Expr *semantic = *i;
2679 
2680     // If this semantic expression is an opaque value, bind it
2681     // to the result of its source expression.
2682     if (const OpaqueValueExpr *ov = dyn_cast<OpaqueValueExpr>(semantic)) {
2683       typedef CodeGenFunction::OpaqueValueMappingData OVMA;
2684       OVMA opaqueData;
2685 
2686       // If this semantic is the result of the pseudo-object
2687       // expression, try to evaluate the source as +1.
2688       if (ov == resultExpr) {
2689         assert(!OVMA::shouldBindAsLValue(ov));
2690         result = asImpl().visit(ov->getSourceExpr());
2691         opaqueData = OVMA::bind(CGF, ov,
2692                             RValue::get(asImpl().getValueOfResult(result)));
2693 
2694       // Otherwise, just bind it.
2695       } else {
2696         opaqueData = OVMA::bind(CGF, ov, ov->getSourceExpr());
2697       }
2698       opaques.push_back(opaqueData);
2699 
2700     // Otherwise, if the expression is the result, evaluate it
2701     // and remember the result.
2702     } else if (semantic == resultExpr) {
2703       result = asImpl().visit(semantic);
2704 
2705     // Otherwise, evaluate the expression in an ignored context.
2706     } else {
2707       CGF.EmitIgnoredExpr(semantic);
2708     }
2709   }
2710 
2711   // Unbind all the opaques now.
2712   for (unsigned i = 0, e = opaques.size(); i != e; ++i)
2713     opaques[i].unbind(CGF);
2714 
2715   return result;
2716 }
2717 
2718 template <typename Impl, typename Result>
2719 Result ARCExprEmitter<Impl,Result>::visitCastExpr(const CastExpr *e) {
2720   switch (e->getCastKind()) {
2721 
2722   // No-op casts don't change the type, so we just ignore them.
2723   case CK_NoOp:
2724     return asImpl().visit(e->getSubExpr());
2725 
2726   // These casts can change the type.
2727   case CK_CPointerToObjCPointerCast:
2728   case CK_BlockPointerToObjCPointerCast:
2729   case CK_AnyPointerToBlockPointerCast:
2730   case CK_BitCast: {
2731     llvm::Type *resultType = CGF.ConvertType(e->getType());
2732     assert(e->getSubExpr()->getType()->hasPointerRepresentation());
2733     Result result = asImpl().visit(e->getSubExpr());
2734     return asImpl().emitBitCast(result, resultType);
2735   }
2736 
2737   // Handle some casts specially.
2738   case CK_LValueToRValue:
2739     return asImpl().visitLValueToRValue(e->getSubExpr());
2740   case CK_ARCConsumeObject:
2741     return asImpl().visitConsumeObject(e->getSubExpr());
2742   case CK_ARCExtendBlockObject:
2743     return asImpl().visitExtendBlockObject(e->getSubExpr());
2744   case CK_ARCReclaimReturnedObject:
2745     return asImpl().visitReclaimReturnedObject(e->getSubExpr());
2746 
2747   // Otherwise, use the default logic.
2748   default:
2749     return asImpl().visitExpr(e);
2750   }
2751 }
2752 
2753 template <typename Impl, typename Result>
2754 Result
2755 ARCExprEmitter<Impl,Result>::visitBinaryOperator(const BinaryOperator *e) {
2756   switch (e->getOpcode()) {
2757   case BO_Comma:
2758     CGF.EmitIgnoredExpr(e->getLHS());
2759     CGF.EnsureInsertPoint();
2760     return asImpl().visit(e->getRHS());
2761 
2762   case BO_Assign:
2763     return asImpl().visitBinAssign(e);
2764 
2765   default:
2766     return asImpl().visitExpr(e);
2767   }
2768 }
2769 
2770 template <typename Impl, typename Result>
2771 Result ARCExprEmitter<Impl,Result>::visitBinAssign(const BinaryOperator *e) {
2772   switch (e->getLHS()->getType().getObjCLifetime()) {
2773   case Qualifiers::OCL_ExplicitNone:
2774     return asImpl().visitBinAssignUnsafeUnretained(e);
2775 
2776   case Qualifiers::OCL_Weak:
2777     return asImpl().visitBinAssignWeak(e);
2778 
2779   case Qualifiers::OCL_Autoreleasing:
2780     return asImpl().visitBinAssignAutoreleasing(e);
2781 
2782   case Qualifiers::OCL_Strong:
2783     return asImpl().visitBinAssignStrong(e);
2784 
2785   case Qualifiers::OCL_None:
2786     return asImpl().visitExpr(e);
2787   }
2788   llvm_unreachable("bad ObjC ownership qualifier");
2789 }
2790 
2791 /// The default rule for __unsafe_unretained emits the RHS recursively,
2792 /// stores into the unsafe variable, and propagates the result outward.
2793 template <typename Impl, typename Result>
2794 Result ARCExprEmitter<Impl,Result>::
2795                     visitBinAssignUnsafeUnretained(const BinaryOperator *e) {
2796   // Recursively emit the RHS.
2797   // For __block safety, do this before emitting the LHS.
2798   Result result = asImpl().visit(e->getRHS());
2799 
2800   // Perform the store.
2801   LValue lvalue =
2802     CGF.EmitCheckedLValue(e->getLHS(), CodeGenFunction::TCK_Store);
2803   CGF.EmitStoreThroughLValue(RValue::get(asImpl().getValueOfResult(result)),
2804                              lvalue);
2805 
2806   return result;
2807 }
2808 
2809 template <typename Impl, typename Result>
2810 Result
2811 ARCExprEmitter<Impl,Result>::visitBinAssignAutoreleasing(const BinaryOperator *e) {
2812   return asImpl().visitExpr(e);
2813 }
2814 
2815 template <typename Impl, typename Result>
2816 Result
2817 ARCExprEmitter<Impl,Result>::visitBinAssignWeak(const BinaryOperator *e) {
2818   return asImpl().visitExpr(e);
2819 }
2820 
2821 template <typename Impl, typename Result>
2822 Result
2823 ARCExprEmitter<Impl,Result>::visitBinAssignStrong(const BinaryOperator *e) {
2824   return asImpl().visitExpr(e);
2825 }
2826 
2827 /// The general expression-emission logic.
2828 template <typename Impl, typename Result>
2829 Result ARCExprEmitter<Impl,Result>::visit(const Expr *e) {
2830   // We should *never* see a nested full-expression here, because if
2831   // we fail to emit at +1, our caller must not retain after we close
2832   // out the full-expression.  This isn't as important in the unsafe
2833   // emitter.
2834   assert(!isa<ExprWithCleanups>(e));
2835 
2836   // Look through parens, __extension__, generic selection, etc.
2837   e = e->IgnoreParens();
2838 
2839   // Handle certain kinds of casts.
2840   if (const CastExpr *ce = dyn_cast<CastExpr>(e)) {
2841     return asImpl().visitCastExpr(ce);
2842 
2843   // Handle the comma operator.
2844   } else if (auto op = dyn_cast<BinaryOperator>(e)) {
2845     return asImpl().visitBinaryOperator(op);
2846 
2847   // TODO: handle conditional operators here
2848 
2849   // For calls and message sends, use the retained-call logic.
2850   // Delegate inits are a special case in that they're the only
2851   // returns-retained expression that *isn't* surrounded by
2852   // a consume.
2853   } else if (isa<CallExpr>(e) ||
2854              (isa<ObjCMessageExpr>(e) &&
2855               !cast<ObjCMessageExpr>(e)->isDelegateInitCall())) {
2856     return asImpl().visitCall(e);
2857 
2858   // Look through pseudo-object expressions.
2859   } else if (const PseudoObjectExpr *pseudo = dyn_cast<PseudoObjectExpr>(e)) {
2860     return asImpl().visitPseudoObjectExpr(pseudo);
2861   }
2862 
2863   return asImpl().visitExpr(e);
2864 }
2865 
2866 namespace {
2867 
2868 /// An emitter for +1 results.
2869 struct ARCRetainExprEmitter :
2870   public ARCExprEmitter<ARCRetainExprEmitter, TryEmitResult> {
2871 
2872   ARCRetainExprEmitter(CodeGenFunction &CGF) : ARCExprEmitter(CGF) {}
2873 
2874   llvm::Value *getValueOfResult(TryEmitResult result) {
2875     return result.getPointer();
2876   }
2877 
2878   TryEmitResult emitBitCast(TryEmitResult result, llvm::Type *resultType) {
2879     llvm::Value *value = result.getPointer();
2880     value = CGF.Builder.CreateBitCast(value, resultType);
2881     result.setPointer(value);
2882     return result;
2883   }
2884 
2885   TryEmitResult visitLValueToRValue(const Expr *e) {
2886     return tryEmitARCRetainLoadOfScalar(CGF, e);
2887   }
2888 
2889   /// For consumptions, just emit the subexpression and thus elide
2890   /// the retain/release pair.
2891   TryEmitResult visitConsumeObject(const Expr *e) {
2892     llvm::Value *result = CGF.EmitScalarExpr(e);
2893     return TryEmitResult(result, true);
2894   }
2895 
2896   /// Block extends are net +0.  Naively, we could just recurse on
2897   /// the subexpression, but actually we need to ensure that the
2898   /// value is copied as a block, so there's a little filter here.
2899   TryEmitResult visitExtendBlockObject(const Expr *e) {
2900     llvm::Value *result; // will be a +0 value
2901 
2902     // If we can't safely assume the sub-expression will produce a
2903     // block-copied value, emit the sub-expression at +0.
2904     if (shouldEmitSeparateBlockRetain(e)) {
2905       result = CGF.EmitScalarExpr(e);
2906 
2907     // Otherwise, try to emit the sub-expression at +1 recursively.
2908     } else {
2909       TryEmitResult subresult = asImpl().visit(e);
2910 
2911       // If that produced a retained value, just use that.
2912       if (subresult.getInt()) {
2913         return subresult;
2914       }
2915 
2916       // Otherwise it's +0.
2917       result = subresult.getPointer();
2918     }
2919 
2920     // Retain the object as a block.
2921     result = CGF.EmitARCRetainBlock(result, /*mandatory*/ true);
2922     return TryEmitResult(result, true);
2923   }
2924 
2925   /// For reclaims, emit the subexpression as a retained call and
2926   /// skip the consumption.
2927   TryEmitResult visitReclaimReturnedObject(const Expr *e) {
2928     llvm::Value *result = emitARCRetainCallResult(CGF, e);
2929     return TryEmitResult(result, true);
2930   }
2931 
2932   /// When we have an undecorated call, retroactively do a claim.
2933   TryEmitResult visitCall(const Expr *e) {
2934     llvm::Value *result = emitARCRetainCallResult(CGF, e);
2935     return TryEmitResult(result, true);
2936   }
2937 
2938   // TODO: maybe special-case visitBinAssignWeak?
2939 
2940   TryEmitResult visitExpr(const Expr *e) {
2941     // We didn't find an obvious production, so emit what we've got and
2942     // tell the caller that we didn't manage to retain.
2943     llvm::Value *result = CGF.EmitScalarExpr(e);
2944     return TryEmitResult(result, false);
2945   }
2946 };
2947 }
2948 
2949 static TryEmitResult
2950 tryEmitARCRetainScalarExpr(CodeGenFunction &CGF, const Expr *e) {
2951   return ARCRetainExprEmitter(CGF).visit(e);
2952 }
2953 
2954 static llvm::Value *emitARCRetainLoadOfScalar(CodeGenFunction &CGF,
2955                                                 LValue lvalue,
2956                                                 QualType type) {
2957   TryEmitResult result = tryEmitARCRetainLoadOfScalar(CGF, lvalue, type);
2958   llvm::Value *value = result.getPointer();
2959   if (!result.getInt())
2960     value = CGF.EmitARCRetain(type, value);
2961   return value;
2962 }
2963 
2964 /// EmitARCRetainScalarExpr - Semantically equivalent to
2965 /// EmitARCRetainObject(e->getType(), EmitScalarExpr(e)), but making a
2966 /// best-effort attempt to peephole expressions that naturally produce
2967 /// retained objects.
2968 llvm::Value *CodeGenFunction::EmitARCRetainScalarExpr(const Expr *e) {
2969   // The retain needs to happen within the full-expression.
2970   if (const ExprWithCleanups *cleanups = dyn_cast<ExprWithCleanups>(e)) {
2971     enterFullExpression(cleanups);
2972     RunCleanupsScope scope(*this);
2973     return EmitARCRetainScalarExpr(cleanups->getSubExpr());
2974   }
2975 
2976   TryEmitResult result = tryEmitARCRetainScalarExpr(*this, e);
2977   llvm::Value *value = result.getPointer();
2978   if (!result.getInt())
2979     value = EmitARCRetain(e->getType(), value);
2980   return value;
2981 }
2982 
2983 llvm::Value *
2984 CodeGenFunction::EmitARCRetainAutoreleaseScalarExpr(const Expr *e) {
2985   // The retain needs to happen within the full-expression.
2986   if (const ExprWithCleanups *cleanups = dyn_cast<ExprWithCleanups>(e)) {
2987     enterFullExpression(cleanups);
2988     RunCleanupsScope scope(*this);
2989     return EmitARCRetainAutoreleaseScalarExpr(cleanups->getSubExpr());
2990   }
2991 
2992   TryEmitResult result = tryEmitARCRetainScalarExpr(*this, e);
2993   llvm::Value *value = result.getPointer();
2994   if (result.getInt())
2995     value = EmitARCAutorelease(value);
2996   else
2997     value = EmitARCRetainAutorelease(e->getType(), value);
2998   return value;
2999 }
3000 
3001 llvm::Value *CodeGenFunction::EmitARCExtendBlockObject(const Expr *e) {
3002   llvm::Value *result;
3003   bool doRetain;
3004 
3005   if (shouldEmitSeparateBlockRetain(e)) {
3006     result = EmitScalarExpr(e);
3007     doRetain = true;
3008   } else {
3009     TryEmitResult subresult = tryEmitARCRetainScalarExpr(*this, e);
3010     result = subresult.getPointer();
3011     doRetain = !subresult.getInt();
3012   }
3013 
3014   if (doRetain)
3015     result = EmitARCRetainBlock(result, /*mandatory*/ true);
3016   return EmitObjCConsumeObject(e->getType(), result);
3017 }
3018 
3019 llvm::Value *CodeGenFunction::EmitObjCThrowOperand(const Expr *expr) {
3020   // In ARC, retain and autorelease the expression.
3021   if (getLangOpts().ObjCAutoRefCount) {
3022     // Do so before running any cleanups for the full-expression.
3023     // EmitARCRetainAutoreleaseScalarExpr does this for us.
3024     return EmitARCRetainAutoreleaseScalarExpr(expr);
3025   }
3026 
3027   // Otherwise, use the normal scalar-expression emission.  The
3028   // exception machinery doesn't do anything special with the
3029   // exception like retaining it, so there's no safety associated with
3030   // only running cleanups after the throw has started, and when it
3031   // matters it tends to be substantially inferior code.
3032   return EmitScalarExpr(expr);
3033 }
3034 
3035 namespace {
3036 
3037 /// An emitter for assigning into an __unsafe_unretained context.
3038 struct ARCUnsafeUnretainedExprEmitter :
3039   public ARCExprEmitter<ARCUnsafeUnretainedExprEmitter, llvm::Value*> {
3040 
3041   ARCUnsafeUnretainedExprEmitter(CodeGenFunction &CGF) : ARCExprEmitter(CGF) {}
3042 
3043   llvm::Value *getValueOfResult(llvm::Value *value) {
3044     return value;
3045   }
3046 
3047   llvm::Value *emitBitCast(llvm::Value *value, llvm::Type *resultType) {
3048     return CGF.Builder.CreateBitCast(value, resultType);
3049   }
3050 
3051   llvm::Value *visitLValueToRValue(const Expr *e) {
3052     return CGF.EmitScalarExpr(e);
3053   }
3054 
3055   /// For consumptions, just emit the subexpression and perform the
3056   /// consumption like normal.
3057   llvm::Value *visitConsumeObject(const Expr *e) {
3058     llvm::Value *value = CGF.EmitScalarExpr(e);
3059     return CGF.EmitObjCConsumeObject(e->getType(), value);
3060   }
3061 
3062   /// No special logic for block extensions.  (This probably can't
3063   /// actually happen in this emitter, though.)
3064   llvm::Value *visitExtendBlockObject(const Expr *e) {
3065     return CGF.EmitARCExtendBlockObject(e);
3066   }
3067 
3068   /// For reclaims, perform an unsafeClaim if that's enabled.
3069   llvm::Value *visitReclaimReturnedObject(const Expr *e) {
3070     return CGF.EmitARCReclaimReturnedObject(e, /*unsafe*/ true);
3071   }
3072 
3073   /// When we have an undecorated call, just emit it without adding
3074   /// the unsafeClaim.
3075   llvm::Value *visitCall(const Expr *e) {
3076     return CGF.EmitScalarExpr(e);
3077   }
3078 
3079   /// Just do normal scalar emission in the default case.
3080   llvm::Value *visitExpr(const Expr *e) {
3081     return CGF.EmitScalarExpr(e);
3082   }
3083 };
3084 }
3085 
3086 static llvm::Value *emitARCUnsafeUnretainedScalarExpr(CodeGenFunction &CGF,
3087                                                       const Expr *e) {
3088   return ARCUnsafeUnretainedExprEmitter(CGF).visit(e);
3089 }
3090 
3091 /// EmitARCUnsafeUnretainedScalarExpr - Semantically equivalent to
3092 /// immediately releasing the resut of EmitARCRetainScalarExpr, but
3093 /// avoiding any spurious retains, including by performing reclaims
3094 /// with objc_unsafeClaimAutoreleasedReturnValue.
3095 llvm::Value *CodeGenFunction::EmitARCUnsafeUnretainedScalarExpr(const Expr *e) {
3096   // Look through full-expressions.
3097   if (const ExprWithCleanups *cleanups = dyn_cast<ExprWithCleanups>(e)) {
3098     enterFullExpression(cleanups);
3099     RunCleanupsScope scope(*this);
3100     return emitARCUnsafeUnretainedScalarExpr(*this, cleanups->getSubExpr());
3101   }
3102 
3103   return emitARCUnsafeUnretainedScalarExpr(*this, e);
3104 }
3105 
3106 std::pair<LValue,llvm::Value*>
3107 CodeGenFunction::EmitARCStoreUnsafeUnretained(const BinaryOperator *e,
3108                                               bool ignored) {
3109   // Evaluate the RHS first.  If we're ignoring the result, assume
3110   // that we can emit at an unsafe +0.
3111   llvm::Value *value;
3112   if (ignored) {
3113     value = EmitARCUnsafeUnretainedScalarExpr(e->getRHS());
3114   } else {
3115     value = EmitScalarExpr(e->getRHS());
3116   }
3117 
3118   // Emit the LHS and perform the store.
3119   LValue lvalue = EmitLValue(e->getLHS());
3120   EmitStoreOfScalar(value, lvalue);
3121 
3122   return std::pair<LValue,llvm::Value*>(std::move(lvalue), value);
3123 }
3124 
3125 std::pair<LValue,llvm::Value*>
3126 CodeGenFunction::EmitARCStoreStrong(const BinaryOperator *e,
3127                                     bool ignored) {
3128   // Evaluate the RHS first.
3129   TryEmitResult result = tryEmitARCRetainScalarExpr(*this, e->getRHS());
3130   llvm::Value *value = result.getPointer();
3131 
3132   bool hasImmediateRetain = result.getInt();
3133 
3134   // If we didn't emit a retained object, and the l-value is of block
3135   // type, then we need to emit the block-retain immediately in case
3136   // it invalidates the l-value.
3137   if (!hasImmediateRetain && e->getType()->isBlockPointerType()) {
3138     value = EmitARCRetainBlock(value, /*mandatory*/ false);
3139     hasImmediateRetain = true;
3140   }
3141 
3142   LValue lvalue = EmitLValue(e->getLHS());
3143 
3144   // If the RHS was emitted retained, expand this.
3145   if (hasImmediateRetain) {
3146     llvm::Value *oldValue = EmitLoadOfScalar(lvalue, SourceLocation());
3147     EmitStoreOfScalar(value, lvalue);
3148     EmitARCRelease(oldValue, lvalue.isARCPreciseLifetime());
3149   } else {
3150     value = EmitARCStoreStrong(lvalue, value, ignored);
3151   }
3152 
3153   return std::pair<LValue,llvm::Value*>(lvalue, value);
3154 }
3155 
3156 std::pair<LValue,llvm::Value*>
3157 CodeGenFunction::EmitARCStoreAutoreleasing(const BinaryOperator *e) {
3158   llvm::Value *value = EmitARCRetainAutoreleaseScalarExpr(e->getRHS());
3159   LValue lvalue = EmitLValue(e->getLHS());
3160 
3161   EmitStoreOfScalar(value, lvalue);
3162 
3163   return std::pair<LValue,llvm::Value*>(lvalue, value);
3164 }
3165 
3166 void CodeGenFunction::EmitObjCAutoreleasePoolStmt(
3167                                           const ObjCAutoreleasePoolStmt &ARPS) {
3168   const Stmt *subStmt = ARPS.getSubStmt();
3169   const CompoundStmt &S = cast<CompoundStmt>(*subStmt);
3170 
3171   CGDebugInfo *DI = getDebugInfo();
3172   if (DI)
3173     DI->EmitLexicalBlockStart(Builder, S.getLBracLoc());
3174 
3175   // Keep track of the current cleanup stack depth.
3176   RunCleanupsScope Scope(*this);
3177   if (CGM.getLangOpts().ObjCRuntime.hasNativeARC()) {
3178     llvm::Value *token = EmitObjCAutoreleasePoolPush();
3179     EHStack.pushCleanup<CallObjCAutoreleasePoolObject>(NormalCleanup, token);
3180   } else {
3181     llvm::Value *token = EmitObjCMRRAutoreleasePoolPush();
3182     EHStack.pushCleanup<CallObjCMRRAutoreleasePoolObject>(NormalCleanup, token);
3183   }
3184 
3185   for (const auto *I : S.body())
3186     EmitStmt(I);
3187 
3188   if (DI)
3189     DI->EmitLexicalBlockEnd(Builder, S.getRBracLoc());
3190 }
3191 
3192 /// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
3193 /// make sure it survives garbage collection until this point.
3194 void CodeGenFunction::EmitExtendGCLifetime(llvm::Value *object) {
3195   // We just use an inline assembly.
3196   llvm::FunctionType *extenderType
3197     = llvm::FunctionType::get(VoidTy, VoidPtrTy, RequiredArgs::All);
3198   llvm::Value *extender
3199     = llvm::InlineAsm::get(extenderType,
3200                            /* assembly */ "",
3201                            /* constraints */ "r",
3202                            /* side effects */ true);
3203 
3204   object = Builder.CreateBitCast(object, VoidPtrTy);
3205   EmitNounwindRuntimeCall(extender, object);
3206 }
3207 
3208 /// GenerateObjCAtomicSetterCopyHelperFunction - Given a c++ object type with
3209 /// non-trivial copy assignment function, produce following helper function.
3210 /// static void copyHelper(Ty *dest, const Ty *source) { *dest = *source; }
3211 ///
3212 llvm::Constant *
3213 CodeGenFunction::GenerateObjCAtomicSetterCopyHelperFunction(
3214                                         const ObjCPropertyImplDecl *PID) {
3215   if (!getLangOpts().CPlusPlus ||
3216       !getLangOpts().ObjCRuntime.hasAtomicCopyHelper())
3217     return nullptr;
3218   QualType Ty = PID->getPropertyIvarDecl()->getType();
3219   if (!Ty->isRecordType())
3220     return nullptr;
3221   const ObjCPropertyDecl *PD = PID->getPropertyDecl();
3222   if ((!(PD->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_atomic)))
3223     return nullptr;
3224   llvm::Constant *HelperFn = nullptr;
3225   if (hasTrivialSetExpr(PID))
3226     return nullptr;
3227   assert(PID->getSetterCXXAssignment() && "SetterCXXAssignment - null");
3228   if ((HelperFn = CGM.getAtomicSetterHelperFnMap(Ty)))
3229     return HelperFn;
3230 
3231   ASTContext &C = getContext();
3232   IdentifierInfo *II
3233     = &CGM.getContext().Idents.get("__assign_helper_atomic_property_");
3234   FunctionDecl *FD = FunctionDecl::Create(C,
3235                                           C.getTranslationUnitDecl(),
3236                                           SourceLocation(),
3237                                           SourceLocation(), II, C.VoidTy,
3238                                           nullptr, SC_Static,
3239                                           false,
3240                                           false);
3241 
3242   QualType DestTy = C.getPointerType(Ty);
3243   QualType SrcTy = Ty;
3244   SrcTy.addConst();
3245   SrcTy = C.getPointerType(SrcTy);
3246 
3247   FunctionArgList args;
3248   ImplicitParamDecl DstDecl(getContext(), FD, SourceLocation(), /*Id=*/nullptr,
3249                             DestTy, ImplicitParamDecl::Other);
3250   args.push_back(&DstDecl);
3251   ImplicitParamDecl SrcDecl(getContext(), FD, SourceLocation(), /*Id=*/nullptr,
3252                             SrcTy, ImplicitParamDecl::Other);
3253   args.push_back(&SrcDecl);
3254 
3255   const CGFunctionInfo &FI =
3256     CGM.getTypes().arrangeBuiltinFunctionDeclaration(C.VoidTy, args);
3257 
3258   llvm::FunctionType *LTy = CGM.getTypes().GetFunctionType(FI);
3259 
3260   llvm::Function *Fn =
3261     llvm::Function::Create(LTy, llvm::GlobalValue::InternalLinkage,
3262                            "__assign_helper_atomic_property_",
3263                            &CGM.getModule());
3264 
3265   CGM.SetInternalFunctionAttributes(nullptr, Fn, FI);
3266 
3267   StartFunction(FD, C.VoidTy, Fn, FI, args);
3268 
3269   DeclRefExpr DstExpr(&DstDecl, false, DestTy,
3270                       VK_RValue, SourceLocation());
3271   UnaryOperator DST(&DstExpr, UO_Deref, DestTy->getPointeeType(),
3272                     VK_LValue, OK_Ordinary, SourceLocation(), false);
3273 
3274   DeclRefExpr SrcExpr(&SrcDecl, false, SrcTy,
3275                       VK_RValue, SourceLocation());
3276   UnaryOperator SRC(&SrcExpr, UO_Deref, SrcTy->getPointeeType(),
3277                     VK_LValue, OK_Ordinary, SourceLocation(), false);
3278 
3279   Expr *Args[2] = { &DST, &SRC };
3280   CallExpr *CalleeExp = cast<CallExpr>(PID->getSetterCXXAssignment());
3281   CXXOperatorCallExpr TheCall(C, OO_Equal, CalleeExp->getCallee(),
3282                               Args, DestTy->getPointeeType(),
3283                               VK_LValue, SourceLocation(), FPOptions());
3284 
3285   EmitStmt(&TheCall);
3286 
3287   FinishFunction();
3288   HelperFn = llvm::ConstantExpr::getBitCast(Fn, VoidPtrTy);
3289   CGM.setAtomicSetterHelperFnMap(Ty, HelperFn);
3290   return HelperFn;
3291 }
3292 
3293 llvm::Constant *
3294 CodeGenFunction::GenerateObjCAtomicGetterCopyHelperFunction(
3295                                             const ObjCPropertyImplDecl *PID) {
3296   if (!getLangOpts().CPlusPlus ||
3297       !getLangOpts().ObjCRuntime.hasAtomicCopyHelper())
3298     return nullptr;
3299   const ObjCPropertyDecl *PD = PID->getPropertyDecl();
3300   QualType Ty = PD->getType();
3301   if (!Ty->isRecordType())
3302     return nullptr;
3303   if ((!(PD->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_atomic)))
3304     return nullptr;
3305   llvm::Constant *HelperFn = nullptr;
3306 
3307   if (hasTrivialGetExpr(PID))
3308     return nullptr;
3309   assert(PID->getGetterCXXConstructor() && "getGetterCXXConstructor - null");
3310   if ((HelperFn = CGM.getAtomicGetterHelperFnMap(Ty)))
3311     return HelperFn;
3312 
3313 
3314   ASTContext &C = getContext();
3315   IdentifierInfo *II
3316   = &CGM.getContext().Idents.get("__copy_helper_atomic_property_");
3317   FunctionDecl *FD = FunctionDecl::Create(C,
3318                                           C.getTranslationUnitDecl(),
3319                                           SourceLocation(),
3320                                           SourceLocation(), II, C.VoidTy,
3321                                           nullptr, SC_Static,
3322                                           false,
3323                                           false);
3324 
3325   QualType DestTy = C.getPointerType(Ty);
3326   QualType SrcTy = Ty;
3327   SrcTy.addConst();
3328   SrcTy = C.getPointerType(SrcTy);
3329 
3330   FunctionArgList args;
3331   ImplicitParamDecl DstDecl(getContext(), FD, SourceLocation(), /*Id=*/nullptr,
3332                             DestTy, ImplicitParamDecl::Other);
3333   args.push_back(&DstDecl);
3334   ImplicitParamDecl SrcDecl(getContext(), FD, SourceLocation(), /*Id=*/nullptr,
3335                             SrcTy, ImplicitParamDecl::Other);
3336   args.push_back(&SrcDecl);
3337 
3338   const CGFunctionInfo &FI =
3339     CGM.getTypes().arrangeBuiltinFunctionDeclaration(C.VoidTy, args);
3340 
3341   llvm::FunctionType *LTy = CGM.getTypes().GetFunctionType(FI);
3342 
3343   llvm::Function *Fn =
3344   llvm::Function::Create(LTy, llvm::GlobalValue::InternalLinkage,
3345                          "__copy_helper_atomic_property_", &CGM.getModule());
3346 
3347   CGM.SetInternalFunctionAttributes(nullptr, Fn, FI);
3348 
3349   StartFunction(FD, C.VoidTy, Fn, FI, args);
3350 
3351   DeclRefExpr SrcExpr(&SrcDecl, false, SrcTy,
3352                       VK_RValue, SourceLocation());
3353 
3354   UnaryOperator SRC(&SrcExpr, UO_Deref, SrcTy->getPointeeType(),
3355                     VK_LValue, OK_Ordinary, SourceLocation(), false);
3356 
3357   CXXConstructExpr *CXXConstExpr =
3358     cast<CXXConstructExpr>(PID->getGetterCXXConstructor());
3359 
3360   SmallVector<Expr*, 4> ConstructorArgs;
3361   ConstructorArgs.push_back(&SRC);
3362   ConstructorArgs.append(std::next(CXXConstExpr->arg_begin()),
3363                          CXXConstExpr->arg_end());
3364 
3365   CXXConstructExpr *TheCXXConstructExpr =
3366     CXXConstructExpr::Create(C, Ty, SourceLocation(),
3367                              CXXConstExpr->getConstructor(),
3368                              CXXConstExpr->isElidable(),
3369                              ConstructorArgs,
3370                              CXXConstExpr->hadMultipleCandidates(),
3371                              CXXConstExpr->isListInitialization(),
3372                              CXXConstExpr->isStdInitListInitialization(),
3373                              CXXConstExpr->requiresZeroInitialization(),
3374                              CXXConstExpr->getConstructionKind(),
3375                              SourceRange());
3376 
3377   DeclRefExpr DstExpr(&DstDecl, false, DestTy,
3378                       VK_RValue, SourceLocation());
3379 
3380   RValue DV = EmitAnyExpr(&DstExpr);
3381   CharUnits Alignment
3382     = getContext().getTypeAlignInChars(TheCXXConstructExpr->getType());
3383   EmitAggExpr(TheCXXConstructExpr,
3384               AggValueSlot::forAddr(Address(DV.getScalarVal(), Alignment),
3385                                     Qualifiers(),
3386                                     AggValueSlot::IsDestructed,
3387                                     AggValueSlot::DoesNotNeedGCBarriers,
3388                                     AggValueSlot::IsNotAliased));
3389 
3390   FinishFunction();
3391   HelperFn = llvm::ConstantExpr::getBitCast(Fn, VoidPtrTy);
3392   CGM.setAtomicGetterHelperFnMap(Ty, HelperFn);
3393   return HelperFn;
3394 }
3395 
3396 llvm::Value *
3397 CodeGenFunction::EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty) {
3398   // Get selectors for retain/autorelease.
3399   IdentifierInfo *CopyID = &getContext().Idents.get("copy");
3400   Selector CopySelector =
3401       getContext().Selectors.getNullarySelector(CopyID);
3402   IdentifierInfo *AutoreleaseID = &getContext().Idents.get("autorelease");
3403   Selector AutoreleaseSelector =
3404       getContext().Selectors.getNullarySelector(AutoreleaseID);
3405 
3406   // Emit calls to retain/autorelease.
3407   CGObjCRuntime &Runtime = CGM.getObjCRuntime();
3408   llvm::Value *Val = Block;
3409   RValue Result;
3410   Result = Runtime.GenerateMessageSend(*this, ReturnValueSlot(),
3411                                        Ty, CopySelector,
3412                                        Val, CallArgList(), nullptr, nullptr);
3413   Val = Result.getScalarVal();
3414   Result = Runtime.GenerateMessageSend(*this, ReturnValueSlot(),
3415                                        Ty, AutoreleaseSelector,
3416                                        Val, CallArgList(), nullptr, nullptr);
3417   Val = Result.getScalarVal();
3418   return Val;
3419 }
3420 
3421 llvm::Value *
3422 CodeGenFunction::EmitBuiltinAvailable(ArrayRef<llvm::Value *> Args) {
3423   assert(Args.size() == 3 && "Expected 3 argument here!");
3424 
3425   if (!CGM.IsOSVersionAtLeastFn) {
3426     llvm::FunctionType *FTy =
3427         llvm::FunctionType::get(Int32Ty, {Int32Ty, Int32Ty, Int32Ty}, false);
3428     CGM.IsOSVersionAtLeastFn =
3429         CGM.CreateRuntimeFunction(FTy, "__isOSVersionAtLeast");
3430   }
3431 
3432   llvm::Value *CallRes =
3433       EmitNounwindRuntimeCall(CGM.IsOSVersionAtLeastFn, Args);
3434 
3435   return Builder.CreateICmpNE(CallRes, llvm::Constant::getNullValue(Int32Ty));
3436 }
3437 
3438 void CodeGenModule::emitAtAvailableLinkGuard() {
3439   if (!IsOSVersionAtLeastFn)
3440     return;
3441   // @available requires CoreFoundation only on Darwin.
3442   if (!Target.getTriple().isOSDarwin())
3443     return;
3444   // Add -framework CoreFoundation to the linker commands. We still want to
3445   // emit the core foundation reference down below because otherwise if
3446   // CoreFoundation is not used in the code, the linker won't link the
3447   // framework.
3448   auto &Context = getLLVMContext();
3449   llvm::Metadata *Args[2] = {llvm::MDString::get(Context, "-framework"),
3450                              llvm::MDString::get(Context, "CoreFoundation")};
3451   LinkerOptionsMetadata.push_back(llvm::MDNode::get(Context, Args));
3452   // Emit a reference to a symbol from CoreFoundation to ensure that
3453   // CoreFoundation is linked into the final binary.
3454   llvm::FunctionType *FTy =
3455       llvm::FunctionType::get(Int32Ty, {VoidPtrTy}, false);
3456   llvm::Constant *CFFunc =
3457       CreateRuntimeFunction(FTy, "CFBundleGetVersionNumber");
3458 
3459   llvm::FunctionType *CheckFTy = llvm::FunctionType::get(VoidTy, {}, false);
3460   llvm::Function *CFLinkCheckFunc = cast<llvm::Function>(CreateBuiltinFunction(
3461       CheckFTy, "__clang_at_available_requires_core_foundation_framework"));
3462   CFLinkCheckFunc->setLinkage(llvm::GlobalValue::LinkOnceAnyLinkage);
3463   CFLinkCheckFunc->setVisibility(llvm::GlobalValue::HiddenVisibility);
3464   CodeGenFunction CGF(*this);
3465   CGF.Builder.SetInsertPoint(CGF.createBasicBlock("", CFLinkCheckFunc));
3466   CGF.EmitNounwindRuntimeCall(CFFunc, llvm::Constant::getNullValue(VoidPtrTy));
3467   CGF.Builder.CreateUnreachable();
3468   addCompilerUsedGlobal(CFLinkCheckFunc);
3469 }
3470 
3471 CGObjCRuntime::~CGObjCRuntime() {}
3472