1 //===---- CGBuiltin.cpp - Emit LLVM Code for builtins ---------------------===//
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   // Compute the type of the array we're initializing.
122   uint64_t NumElements =
123     ALE ? ALE->getNumElements() : DLE->getNumElements();
124   llvm::APInt APNumElements(Context.getTypeSize(Context.getSizeType()),
125                             NumElements);
126   QualType ElementType = Context.getObjCIdType().withConst();
127   QualType ElementArrayType
128     = Context.getConstantArrayType(ElementType, APNumElements,
129                                    ArrayType::Normal, /*IndexTypeQuals=*/0);
130 
131   // Allocate the temporary array(s).
132   Address Objects = CreateMemTemp(ElementArrayType, "objects");
133   Address Keys = Address::invalid();
134   if (DLE)
135     Keys = CreateMemTemp(ElementArrayType, "keys");
136 
137   // In ARC, we may need to do extra work to keep all the keys and
138   // values alive until after the call.
139   SmallVector<llvm::Value *, 16> NeededObjects;
140   bool TrackNeededObjects =
141     (getLangOpts().ObjCAutoRefCount &&
142     CGM.getCodeGenOpts().OptimizationLevel != 0);
143 
144   // Perform the actual initialialization of the array(s).
145   for (uint64_t i = 0; i < NumElements; i++) {
146     if (ALE) {
147       // Emit the element and store it to the appropriate array slot.
148       const Expr *Rhs = ALE->getElement(i);
149       LValue LV = MakeAddrLValue(
150           Builder.CreateConstArrayGEP(Objects, i, getPointerSize()),
151           ElementType, AlignmentSource::Decl);
152 
153       llvm::Value *value = EmitScalarExpr(Rhs);
154       EmitStoreThroughLValue(RValue::get(value), LV, true);
155       if (TrackNeededObjects) {
156         NeededObjects.push_back(value);
157       }
158     } else {
159       // Emit the key and store it to the appropriate array slot.
160       const Expr *Key = DLE->getKeyValueElement(i).Key;
161       LValue KeyLV = MakeAddrLValue(
162           Builder.CreateConstArrayGEP(Keys, i, getPointerSize()),
163           ElementType, AlignmentSource::Decl);
164       llvm::Value *keyValue = EmitScalarExpr(Key);
165       EmitStoreThroughLValue(RValue::get(keyValue), KeyLV, /*isInit=*/true);
166 
167       // Emit the value and store it to the appropriate array slot.
168       const Expr *Value = DLE->getKeyValueElement(i).Value;
169       LValue ValueLV = MakeAddrLValue(
170           Builder.CreateConstArrayGEP(Objects, i, getPointerSize()),
171           ElementType, AlignmentSource::Decl);
172       llvm::Value *valueValue = EmitScalarExpr(Value);
173       EmitStoreThroughLValue(RValue::get(valueValue), ValueLV, /*isInit=*/true);
174       if (TrackNeededObjects) {
175         NeededObjects.push_back(keyValue);
176         NeededObjects.push_back(valueValue);
177       }
178     }
179   }
180 
181   // Generate the argument list.
182   CallArgList Args;
183   ObjCMethodDecl::param_const_iterator PI = MethodWithObjects->param_begin();
184   const ParmVarDecl *argDecl = *PI++;
185   QualType ArgQT = argDecl->getType().getUnqualifiedType();
186   Args.add(RValue::get(Objects.getPointer()), ArgQT);
187   if (DLE) {
188     argDecl = *PI++;
189     ArgQT = argDecl->getType().getUnqualifiedType();
190     Args.add(RValue::get(Keys.getPointer()), ArgQT);
191   }
192   argDecl = *PI;
193   ArgQT = argDecl->getType().getUnqualifiedType();
194   llvm::Value *Count =
195     llvm::ConstantInt::get(CGM.getTypes().ConvertType(ArgQT), NumElements);
196   Args.add(RValue::get(Count), ArgQT);
197 
198   // Generate a reference to the class pointer, which will be the receiver.
199   Selector Sel = MethodWithObjects->getSelector();
200   QualType ResultType = E->getType();
201   const ObjCObjectPointerType *InterfacePointerType
202     = ResultType->getAsObjCInterfacePointerType();
203   ObjCInterfaceDecl *Class
204     = InterfacePointerType->getObjectType()->getInterface();
205   CGObjCRuntime &Runtime = CGM.getObjCRuntime();
206   llvm::Value *Receiver = Runtime.GetClass(*this, Class);
207 
208   // Generate the message send.
209   RValue result = Runtime.GenerateMessageSend(
210       *this, ReturnValueSlot(), MethodWithObjects->getReturnType(), Sel,
211       Receiver, Args, Class, MethodWithObjects);
212 
213   // The above message send needs these objects, but in ARC they are
214   // passed in a buffer that is essentially __unsafe_unretained.
215   // Therefore we must prevent the optimizer from releasing them until
216   // after the call.
217   if (TrackNeededObjects) {
218     EmitARCIntrinsicUse(NeededObjects);
219   }
220 
221   return Builder.CreateBitCast(result.getScalarVal(),
222                                ConvertType(E->getType()));
223 }
224 
225 llvm::Value *CodeGenFunction::EmitObjCArrayLiteral(const ObjCArrayLiteral *E) {
226   return EmitObjCCollectionLiteral(E, E->getArrayWithObjectsMethod());
227 }
228 
229 llvm::Value *CodeGenFunction::EmitObjCDictionaryLiteral(
230                                             const ObjCDictionaryLiteral *E) {
231   return EmitObjCCollectionLiteral(E, E->getDictWithObjectsMethod());
232 }
233 
234 /// Emit a selector.
235 llvm::Value *CodeGenFunction::EmitObjCSelectorExpr(const ObjCSelectorExpr *E) {
236   // Untyped selector.
237   // Note that this implementation allows for non-constant strings to be passed
238   // as arguments to @selector().  Currently, the only thing preventing this
239   // behaviour is the type checking in the front end.
240   return CGM.getObjCRuntime().GetSelector(*this, E->getSelector());
241 }
242 
243 llvm::Value *CodeGenFunction::EmitObjCProtocolExpr(const ObjCProtocolExpr *E) {
244   // FIXME: This should pass the Decl not the name.
245   return CGM.getObjCRuntime().GenerateProtocolRef(*this, E->getProtocol());
246 }
247 
248 /// \brief Adjust the type of an Objective-C object that doesn't match up due
249 /// to type erasure at various points, e.g., related result types or the use
250 /// of parameterized classes.
251 static RValue AdjustObjCObjectType(CodeGenFunction &CGF, QualType ExpT,
252                                    RValue Result) {
253   if (!ExpT->isObjCRetainableType())
254     return Result;
255 
256   // If the converted types are the same, we're done.
257   llvm::Type *ExpLLVMTy = CGF.ConvertType(ExpT);
258   if (ExpLLVMTy == Result.getScalarVal()->getType())
259     return Result;
260 
261   // We have applied a substitution. Cast the rvalue appropriately.
262   return RValue::get(CGF.Builder.CreateBitCast(Result.getScalarVal(),
263                                                ExpLLVMTy));
264 }
265 
266 /// Decide whether to extend the lifetime of the receiver of a
267 /// returns-inner-pointer message.
268 static bool
269 shouldExtendReceiverForInnerPointerMessage(const ObjCMessageExpr *message) {
270   switch (message->getReceiverKind()) {
271 
272   // For a normal instance message, we should extend unless the
273   // receiver is loaded from a variable with precise lifetime.
274   case ObjCMessageExpr::Instance: {
275     const Expr *receiver = message->getInstanceReceiver();
276 
277     // Look through OVEs.
278     if (auto opaque = dyn_cast<OpaqueValueExpr>(receiver)) {
279       if (opaque->getSourceExpr())
280         receiver = opaque->getSourceExpr()->IgnoreParens();
281     }
282 
283     const ImplicitCastExpr *ice = dyn_cast<ImplicitCastExpr>(receiver);
284     if (!ice || ice->getCastKind() != CK_LValueToRValue) return true;
285     receiver = ice->getSubExpr()->IgnoreParens();
286 
287     // Look through OVEs.
288     if (auto opaque = dyn_cast<OpaqueValueExpr>(receiver)) {
289       if (opaque->getSourceExpr())
290         receiver = opaque->getSourceExpr()->IgnoreParens();
291     }
292 
293     // Only __strong variables.
294     if (receiver->getType().getObjCLifetime() != Qualifiers::OCL_Strong)
295       return true;
296 
297     // All ivars and fields have precise lifetime.
298     if (isa<MemberExpr>(receiver) || isa<ObjCIvarRefExpr>(receiver))
299       return false;
300 
301     // Otherwise, check for variables.
302     const DeclRefExpr *declRef = dyn_cast<DeclRefExpr>(ice->getSubExpr());
303     if (!declRef) return true;
304     const VarDecl *var = dyn_cast<VarDecl>(declRef->getDecl());
305     if (!var) return true;
306 
307     // All variables have precise lifetime except local variables with
308     // automatic storage duration that aren't specially marked.
309     return (var->hasLocalStorage() &&
310             !var->hasAttr<ObjCPreciseLifetimeAttr>());
311   }
312 
313   case ObjCMessageExpr::Class:
314   case ObjCMessageExpr::SuperClass:
315     // It's never necessary for class objects.
316     return false;
317 
318   case ObjCMessageExpr::SuperInstance:
319     // We generally assume that 'self' lives throughout a method call.
320     return false;
321   }
322 
323   llvm_unreachable("invalid receiver kind");
324 }
325 
326 RValue CodeGenFunction::EmitObjCMessageExpr(const ObjCMessageExpr *E,
327                                             ReturnValueSlot Return) {
328   // Only the lookup mechanism and first two arguments of the method
329   // implementation vary between runtimes.  We can get the receiver and
330   // arguments in generic code.
331 
332   bool isDelegateInit = E->isDelegateInitCall();
333 
334   const ObjCMethodDecl *method = E->getMethodDecl();
335 
336   // We don't retain the receiver in delegate init calls, and this is
337   // safe because the receiver value is always loaded from 'self',
338   // which we zero out.  We don't want to Block_copy block receivers,
339   // though.
340   bool retainSelf =
341     (!isDelegateInit &&
342      CGM.getLangOpts().ObjCAutoRefCount &&
343      method &&
344      method->hasAttr<NSConsumesSelfAttr>());
345 
346   CGObjCRuntime &Runtime = CGM.getObjCRuntime();
347   bool isSuperMessage = false;
348   bool isClassMessage = false;
349   ObjCInterfaceDecl *OID = nullptr;
350   // Find the receiver
351   QualType ReceiverType;
352   llvm::Value *Receiver = nullptr;
353   switch (E->getReceiverKind()) {
354   case ObjCMessageExpr::Instance:
355     ReceiverType = E->getInstanceReceiver()->getType();
356     if (retainSelf) {
357       TryEmitResult ter = tryEmitARCRetainScalarExpr(*this,
358                                                    E->getInstanceReceiver());
359       Receiver = ter.getPointer();
360       if (ter.getInt()) retainSelf = false;
361     } else
362       Receiver = EmitScalarExpr(E->getInstanceReceiver());
363     break;
364 
365   case ObjCMessageExpr::Class: {
366     ReceiverType = E->getClassReceiver();
367     const ObjCObjectType *ObjTy = ReceiverType->getAs<ObjCObjectType>();
368     assert(ObjTy && "Invalid Objective-C class message send");
369     OID = ObjTy->getInterface();
370     assert(OID && "Invalid Objective-C class message send");
371     Receiver = Runtime.GetClass(*this, OID);
372     isClassMessage = true;
373     break;
374   }
375 
376   case ObjCMessageExpr::SuperInstance:
377     ReceiverType = E->getSuperType();
378     Receiver = LoadObjCSelf();
379     isSuperMessage = true;
380     break;
381 
382   case ObjCMessageExpr::SuperClass:
383     ReceiverType = E->getSuperType();
384     Receiver = LoadObjCSelf();
385     isSuperMessage = true;
386     isClassMessage = true;
387     break;
388   }
389 
390   if (retainSelf)
391     Receiver = EmitARCRetainNonBlock(Receiver);
392 
393   // In ARC, we sometimes want to "extend the lifetime"
394   // (i.e. retain+autorelease) of receivers of returns-inner-pointer
395   // messages.
396   if (getLangOpts().ObjCAutoRefCount && method &&
397       method->hasAttr<ObjCReturnsInnerPointerAttr>() &&
398       shouldExtendReceiverForInnerPointerMessage(E))
399     Receiver = EmitARCRetainAutorelease(ReceiverType, Receiver);
400 
401   QualType ResultType = method ? method->getReturnType() : E->getType();
402 
403   CallArgList Args;
404   EmitCallArgs(Args, method, E->arguments());
405 
406   // For delegate init calls in ARC, do an unsafe store of null into
407   // self.  This represents the call taking direct ownership of that
408   // value.  We have to do this after emitting the other call
409   // arguments because they might also reference self, but we don't
410   // have to worry about any of them modifying self because that would
411   // be an undefined read and write of an object in unordered
412   // expressions.
413   if (isDelegateInit) {
414     assert(getLangOpts().ObjCAutoRefCount &&
415            "delegate init calls should only be marked in ARC");
416 
417     // Do an unsafe store of null into self.
418     Address selfAddr =
419       GetAddrOfLocalVar(cast<ObjCMethodDecl>(CurCodeDecl)->getSelfDecl());
420     Builder.CreateStore(getNullForVariable(selfAddr), selfAddr);
421   }
422 
423   RValue result;
424   if (isSuperMessage) {
425     // super is only valid in an Objective-C method
426     const ObjCMethodDecl *OMD = cast<ObjCMethodDecl>(CurFuncDecl);
427     bool isCategoryImpl = isa<ObjCCategoryImplDecl>(OMD->getDeclContext());
428     result = Runtime.GenerateMessageSendSuper(*this, Return, ResultType,
429                                               E->getSelector(),
430                                               OMD->getClassInterface(),
431                                               isCategoryImpl,
432                                               Receiver,
433                                               isClassMessage,
434                                               Args,
435                                               method);
436   } else {
437     result = Runtime.GenerateMessageSend(*this, Return, ResultType,
438                                          E->getSelector(),
439                                          Receiver, Args, OID,
440                                          method);
441   }
442 
443   // For delegate init calls in ARC, implicitly store the result of
444   // the call back into self.  This takes ownership of the value.
445   if (isDelegateInit) {
446     Address selfAddr =
447       GetAddrOfLocalVar(cast<ObjCMethodDecl>(CurCodeDecl)->getSelfDecl());
448     llvm::Value *newSelf = result.getScalarVal();
449 
450     // The delegate return type isn't necessarily a matching type; in
451     // fact, it's quite likely to be 'id'.
452     llvm::Type *selfTy = selfAddr.getElementType();
453     newSelf = Builder.CreateBitCast(newSelf, selfTy);
454 
455     Builder.CreateStore(newSelf, selfAddr);
456   }
457 
458   return AdjustObjCObjectType(*this, E->getType(), result);
459 }
460 
461 namespace {
462 struct FinishARCDealloc final : EHScopeStack::Cleanup {
463   void Emit(CodeGenFunction &CGF, Flags flags) override {
464     const ObjCMethodDecl *method = cast<ObjCMethodDecl>(CGF.CurCodeDecl);
465 
466     const ObjCImplDecl *impl = cast<ObjCImplDecl>(method->getDeclContext());
467     const ObjCInterfaceDecl *iface = impl->getClassInterface();
468     if (!iface->getSuperClass()) return;
469 
470     bool isCategory = isa<ObjCCategoryImplDecl>(impl);
471 
472     // Call [super dealloc] if we have a superclass.
473     llvm::Value *self = CGF.LoadObjCSelf();
474 
475     CallArgList args;
476     CGF.CGM.getObjCRuntime().GenerateMessageSendSuper(CGF, ReturnValueSlot(),
477                                                       CGF.getContext().VoidTy,
478                                                       method->getSelector(),
479                                                       iface,
480                                                       isCategory,
481                                                       self,
482                                                       /*is class msg*/ false,
483                                                       args,
484                                                       method);
485   }
486 };
487 }
488 
489 /// StartObjCMethod - Begin emission of an ObjCMethod. This generates
490 /// the LLVM function and sets the other context used by
491 /// CodeGenFunction.
492 void CodeGenFunction::StartObjCMethod(const ObjCMethodDecl *OMD,
493                                       const ObjCContainerDecl *CD) {
494   SourceLocation StartLoc = OMD->getLocStart();
495   FunctionArgList args;
496   // Check if we should generate debug info for this method.
497   if (OMD->hasAttr<NoDebugAttr>())
498     DebugInfo = nullptr; // disable debug info indefinitely for this function
499 
500   llvm::Function *Fn = CGM.getObjCRuntime().GenerateMethod(OMD, CD);
501 
502   const CGFunctionInfo &FI = CGM.getTypes().arrangeObjCMethodDeclaration(OMD);
503   CGM.SetInternalFunctionAttributes(OMD, Fn, FI);
504 
505   args.push_back(OMD->getSelfDecl());
506   args.push_back(OMD->getCmdDecl());
507 
508   args.append(OMD->param_begin(), OMD->param_end());
509 
510   CurGD = OMD;
511   CurEHLocation = OMD->getLocEnd();
512 
513   StartFunction(OMD, OMD->getReturnType(), Fn, FI, args,
514                 OMD->getLocation(), StartLoc);
515 
516   // In ARC, certain methods get an extra cleanup.
517   if (CGM.getLangOpts().ObjCAutoRefCount &&
518       OMD->isInstanceMethod() &&
519       OMD->getSelector().isUnarySelector()) {
520     const IdentifierInfo *ident =
521       OMD->getSelector().getIdentifierInfoForSlot(0);
522     if (ident->isStr("dealloc"))
523       EHStack.pushCleanup<FinishARCDealloc>(getARCCleanupKind());
524   }
525 }
526 
527 static llvm::Value *emitARCRetainLoadOfScalar(CodeGenFunction &CGF,
528                                               LValue lvalue, QualType type);
529 
530 /// Generate an Objective-C method.  An Objective-C method is a C function with
531 /// its pointer, name, and types registered in the class struture.
532 void CodeGenFunction::GenerateObjCMethod(const ObjCMethodDecl *OMD) {
533   StartObjCMethod(OMD, OMD->getClassInterface());
534   PGO.assignRegionCounters(OMD, CurFn);
535   assert(isa<CompoundStmt>(OMD->getBody()));
536   incrementProfileCounter(OMD->getBody());
537   EmitCompoundStmtWithoutScope(*cast<CompoundStmt>(OMD->getBody()));
538   FinishFunction(OMD->getBodyRBrace());
539 }
540 
541 /// emitStructGetterCall - Call the runtime function to load a property
542 /// into the return value slot.
543 static void emitStructGetterCall(CodeGenFunction &CGF, ObjCIvarDecl *ivar,
544                                  bool isAtomic, bool hasStrong) {
545   ASTContext &Context = CGF.getContext();
546 
547   Address src =
548     CGF.EmitLValueForIvar(CGF.TypeOfSelfObject(), CGF.LoadObjCSelf(), ivar, 0)
549        .getAddress();
550 
551   // objc_copyStruct (ReturnValue, &structIvar,
552   //                  sizeof (Type of Ivar), isAtomic, false);
553   CallArgList args;
554 
555   Address dest = CGF.Builder.CreateBitCast(CGF.ReturnValue, CGF.VoidPtrTy);
556   args.add(RValue::get(dest.getPointer()), Context.VoidPtrTy);
557 
558   src = CGF.Builder.CreateBitCast(src, CGF.VoidPtrTy);
559   args.add(RValue::get(src.getPointer()), Context.VoidPtrTy);
560 
561   CharUnits size = CGF.getContext().getTypeSizeInChars(ivar->getType());
562   args.add(RValue::get(CGF.CGM.getSize(size)), Context.getSizeType());
563   args.add(RValue::get(CGF.Builder.getInt1(isAtomic)), Context.BoolTy);
564   args.add(RValue::get(CGF.Builder.getInt1(hasStrong)), Context.BoolTy);
565 
566   llvm::Value *fn = CGF.CGM.getObjCRuntime().GetGetStructFunction();
567   CGF.EmitCall(CGF.getTypes().arrangeFreeFunctionCall(Context.VoidTy, args,
568                                                       FunctionType::ExtInfo(),
569                                                       RequiredArgs::All),
570                fn, ReturnValueSlot(), args);
571 }
572 
573 /// Determine whether the given architecture supports unaligned atomic
574 /// accesses.  They don't have to be fast, just faster than a function
575 /// call and a mutex.
576 static bool hasUnalignedAtomics(llvm::Triple::ArchType arch) {
577   // FIXME: Allow unaligned atomic load/store on x86.  (It is not
578   // currently supported by the backend.)
579   return 0;
580 }
581 
582 /// Return the maximum size that permits atomic accesses for the given
583 /// architecture.
584 static CharUnits getMaxAtomicAccessSize(CodeGenModule &CGM,
585                                         llvm::Triple::ArchType arch) {
586   // ARM has 8-byte atomic accesses, but it's not clear whether we
587   // want to rely on them here.
588 
589   // In the default case, just assume that any size up to a pointer is
590   // fine given adequate alignment.
591   return CharUnits::fromQuantity(CGM.PointerSizeInBytes);
592 }
593 
594 namespace {
595   class PropertyImplStrategy {
596   public:
597     enum StrategyKind {
598       /// The 'native' strategy is to use the architecture's provided
599       /// reads and writes.
600       Native,
601 
602       /// Use objc_setProperty and objc_getProperty.
603       GetSetProperty,
604 
605       /// Use objc_setProperty for the setter, but use expression
606       /// evaluation for the getter.
607       SetPropertyAndExpressionGet,
608 
609       /// Use objc_copyStruct.
610       CopyStruct,
611 
612       /// The 'expression' strategy is to emit normal assignment or
613       /// lvalue-to-rvalue expressions.
614       Expression
615     };
616 
617     StrategyKind getKind() const { return StrategyKind(Kind); }
618 
619     bool hasStrongMember() const { return HasStrong; }
620     bool isAtomic() const { return IsAtomic; }
621     bool isCopy() const { return IsCopy; }
622 
623     CharUnits getIvarSize() const { return IvarSize; }
624     CharUnits getIvarAlignment() const { return IvarAlignment; }
625 
626     PropertyImplStrategy(CodeGenModule &CGM,
627                          const ObjCPropertyImplDecl *propImpl);
628 
629   private:
630     unsigned Kind : 8;
631     unsigned IsAtomic : 1;
632     unsigned IsCopy : 1;
633     unsigned HasStrong : 1;
634 
635     CharUnits IvarSize;
636     CharUnits IvarAlignment;
637   };
638 }
639 
640 /// Pick an implementation strategy for the given property synthesis.
641 PropertyImplStrategy::PropertyImplStrategy(CodeGenModule &CGM,
642                                      const ObjCPropertyImplDecl *propImpl) {
643   const ObjCPropertyDecl *prop = propImpl->getPropertyDecl();
644   ObjCPropertyDecl::SetterKind setterKind = prop->getSetterKind();
645 
646   IsCopy = (setterKind == ObjCPropertyDecl::Copy);
647   IsAtomic = prop->isAtomic();
648   HasStrong = false; // doesn't matter here.
649 
650   // Evaluate the ivar's size and alignment.
651   ObjCIvarDecl *ivar = propImpl->getPropertyIvarDecl();
652   QualType ivarType = ivar->getType();
653   std::tie(IvarSize, IvarAlignment) =
654       CGM.getContext().getTypeInfoInChars(ivarType);
655 
656   // If we have a copy property, we always have to use getProperty/setProperty.
657   // TODO: we could actually use setProperty and an expression for non-atomics.
658   if (IsCopy) {
659     Kind = GetSetProperty;
660     return;
661   }
662 
663   // Handle retain.
664   if (setterKind == ObjCPropertyDecl::Retain) {
665     // In GC-only, there's nothing special that needs to be done.
666     if (CGM.getLangOpts().getGC() == LangOptions::GCOnly) {
667       // fallthrough
668 
669     // In ARC, if the property is non-atomic, use expression emission,
670     // which translates to objc_storeStrong.  This isn't required, but
671     // it's slightly nicer.
672     } else if (CGM.getLangOpts().ObjCAutoRefCount && !IsAtomic) {
673       // Using standard expression emission for the setter is only
674       // acceptable if the ivar is __strong, which won't be true if
675       // the property is annotated with __attribute__((NSObject)).
676       // TODO: falling all the way back to objc_setProperty here is
677       // just laziness, though;  we could still use objc_storeStrong
678       // if we hacked it right.
679       if (ivarType.getObjCLifetime() == Qualifiers::OCL_Strong)
680         Kind = Expression;
681       else
682         Kind = SetPropertyAndExpressionGet;
683       return;
684 
685     // Otherwise, we need to at least use setProperty.  However, if
686     // the property isn't atomic, we can use normal expression
687     // emission for the getter.
688     } else if (!IsAtomic) {
689       Kind = SetPropertyAndExpressionGet;
690       return;
691 
692     // Otherwise, we have to use both setProperty and getProperty.
693     } else {
694       Kind = GetSetProperty;
695       return;
696     }
697   }
698 
699   // If we're not atomic, just use expression accesses.
700   if (!IsAtomic) {
701     Kind = Expression;
702     return;
703   }
704 
705   // Properties on bitfield ivars need to be emitted using expression
706   // accesses even if they're nominally atomic.
707   if (ivar->isBitField()) {
708     Kind = Expression;
709     return;
710   }
711 
712   // GC-qualified or ARC-qualified ivars need to be emitted as
713   // expressions.  This actually works out to being atomic anyway,
714   // except for ARC __strong, but that should trigger the above code.
715   if (ivarType.hasNonTrivialObjCLifetime() ||
716       (CGM.getLangOpts().getGC() &&
717        CGM.getContext().getObjCGCAttrKind(ivarType))) {
718     Kind = Expression;
719     return;
720   }
721 
722   // Compute whether the ivar has strong members.
723   if (CGM.getLangOpts().getGC())
724     if (const RecordType *recordType = ivarType->getAs<RecordType>())
725       HasStrong = recordType->getDecl()->hasObjectMember();
726 
727   // We can never access structs with object members with a native
728   // access, because we need to use write barriers.  This is what
729   // objc_copyStruct is for.
730   if (HasStrong) {
731     Kind = CopyStruct;
732     return;
733   }
734 
735   // Otherwise, this is target-dependent and based on the size and
736   // alignment of the ivar.
737 
738   // If the size of the ivar is not a power of two, give up.  We don't
739   // want to get into the business of doing compare-and-swaps.
740   if (!IvarSize.isPowerOfTwo()) {
741     Kind = CopyStruct;
742     return;
743   }
744 
745   llvm::Triple::ArchType arch =
746     CGM.getTarget().getTriple().getArch();
747 
748   // Most architectures require memory to fit within a single cache
749   // line, so the alignment has to be at least the size of the access.
750   // Otherwise we have to grab a lock.
751   if (IvarAlignment < IvarSize && !hasUnalignedAtomics(arch)) {
752     Kind = CopyStruct;
753     return;
754   }
755 
756   // If the ivar's size exceeds the architecture's maximum atomic
757   // access size, we have to use CopyStruct.
758   if (IvarSize > getMaxAtomicAccessSize(CGM, arch)) {
759     Kind = CopyStruct;
760     return;
761   }
762 
763   // Otherwise, we can use native loads and stores.
764   Kind = Native;
765 }
766 
767 /// \brief Generate an Objective-C property getter function.
768 ///
769 /// The given Decl must be an ObjCImplementationDecl. \@synthesize
770 /// is illegal within a category.
771 void CodeGenFunction::GenerateObjCGetter(ObjCImplementationDecl *IMP,
772                                          const ObjCPropertyImplDecl *PID) {
773   llvm::Constant *AtomicHelperFn =
774       CodeGenFunction(CGM).GenerateObjCAtomicGetterCopyHelperFunction(PID);
775   const ObjCPropertyDecl *PD = PID->getPropertyDecl();
776   ObjCMethodDecl *OMD = PD->getGetterMethodDecl();
777   assert(OMD && "Invalid call to generate getter (empty method)");
778   StartObjCMethod(OMD, IMP->getClassInterface());
779 
780   generateObjCGetterBody(IMP, PID, OMD, AtomicHelperFn);
781 
782   FinishFunction();
783 }
784 
785 static bool hasTrivialGetExpr(const ObjCPropertyImplDecl *propImpl) {
786   const Expr *getter = propImpl->getGetterCXXConstructor();
787   if (!getter) return true;
788 
789   // Sema only makes only of these when the ivar has a C++ class type,
790   // so the form is pretty constrained.
791 
792   // If the property has a reference type, we might just be binding a
793   // reference, in which case the result will be a gl-value.  We should
794   // treat this as a non-trivial operation.
795   if (getter->isGLValue())
796     return false;
797 
798   // If we selected a trivial copy-constructor, we're okay.
799   if (const CXXConstructExpr *construct = dyn_cast<CXXConstructExpr>(getter))
800     return (construct->getConstructor()->isTrivial());
801 
802   // The constructor might require cleanups (in which case it's never
803   // trivial).
804   assert(isa<ExprWithCleanups>(getter));
805   return false;
806 }
807 
808 /// emitCPPObjectAtomicGetterCall - Call the runtime function to
809 /// copy the ivar into the resturn slot.
810 static void emitCPPObjectAtomicGetterCall(CodeGenFunction &CGF,
811                                           llvm::Value *returnAddr,
812                                           ObjCIvarDecl *ivar,
813                                           llvm::Constant *AtomicHelperFn) {
814   // objc_copyCppObjectAtomic (&returnSlot, &CppObjectIvar,
815   //                           AtomicHelperFn);
816   CallArgList args;
817 
818   // The 1st argument is the return Slot.
819   args.add(RValue::get(returnAddr), CGF.getContext().VoidPtrTy);
820 
821   // The 2nd argument is the address of the ivar.
822   llvm::Value *ivarAddr =
823     CGF.EmitLValueForIvar(CGF.TypeOfSelfObject(),
824                           CGF.LoadObjCSelf(), ivar, 0).getPointer();
825   ivarAddr = CGF.Builder.CreateBitCast(ivarAddr, CGF.Int8PtrTy);
826   args.add(RValue::get(ivarAddr), CGF.getContext().VoidPtrTy);
827 
828   // Third argument is the helper function.
829   args.add(RValue::get(AtomicHelperFn), CGF.getContext().VoidPtrTy);
830 
831   llvm::Value *copyCppAtomicObjectFn =
832     CGF.CGM.getObjCRuntime().GetCppAtomicObjectGetFunction();
833   CGF.EmitCall(CGF.getTypes().arrangeFreeFunctionCall(CGF.getContext().VoidTy,
834                                                       args,
835                                                       FunctionType::ExtInfo(),
836                                                       RequiredArgs::All),
837                copyCppAtomicObjectFn, ReturnValueSlot(), args);
838 }
839 
840 void
841 CodeGenFunction::generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
842                                         const ObjCPropertyImplDecl *propImpl,
843                                         const ObjCMethodDecl *GetterMethodDecl,
844                                         llvm::Constant *AtomicHelperFn) {
845   // If there's a non-trivial 'get' expression, we just have to emit that.
846   if (!hasTrivialGetExpr(propImpl)) {
847     if (!AtomicHelperFn) {
848       ReturnStmt ret(SourceLocation(), propImpl->getGetterCXXConstructor(),
849                      /*nrvo*/ nullptr);
850       EmitReturnStmt(ret);
851     }
852     else {
853       ObjCIvarDecl *ivar = propImpl->getPropertyIvarDecl();
854       emitCPPObjectAtomicGetterCall(*this, ReturnValue.getPointer(),
855                                     ivar, AtomicHelperFn);
856     }
857     return;
858   }
859 
860   const ObjCPropertyDecl *prop = propImpl->getPropertyDecl();
861   QualType propType = prop->getType();
862   ObjCMethodDecl *getterMethod = prop->getGetterMethodDecl();
863 
864   ObjCIvarDecl *ivar = propImpl->getPropertyIvarDecl();
865 
866   // Pick an implementation strategy.
867   PropertyImplStrategy strategy(CGM, propImpl);
868   switch (strategy.getKind()) {
869   case PropertyImplStrategy::Native: {
870     // We don't need to do anything for a zero-size struct.
871     if (strategy.getIvarSize().isZero())
872       return;
873 
874     LValue LV = EmitLValueForIvar(TypeOfSelfObject(), LoadObjCSelf(), ivar, 0);
875 
876     // Currently, all atomic accesses have to be through integer
877     // types, so there's no point in trying to pick a prettier type.
878     llvm::Type *bitcastType =
879       llvm::Type::getIntNTy(getLLVMContext(),
880                             getContext().toBits(strategy.getIvarSize()));
881     bitcastType = bitcastType->getPointerTo(); // addrspace 0 okay
882 
883     // Perform an atomic load.  This does not impose ordering constraints.
884     Address ivarAddr = LV.getAddress();
885     ivarAddr = Builder.CreateBitCast(ivarAddr, bitcastType);
886     llvm::LoadInst *load = Builder.CreateLoad(ivarAddr, "load");
887     load->setAtomic(llvm::Unordered);
888 
889     // Store that value into the return address.  Doing this with a
890     // bitcast is likely to produce some pretty ugly IR, but it's not
891     // the *most* terrible thing in the world.
892     Builder.CreateStore(load, Builder.CreateBitCast(ReturnValue, bitcastType));
893 
894     // Make sure we don't do an autorelease.
895     AutoreleaseResult = false;
896     return;
897   }
898 
899   case PropertyImplStrategy::GetSetProperty: {
900     llvm::Value *getPropertyFn =
901       CGM.getObjCRuntime().GetPropertyGetFunction();
902     if (!getPropertyFn) {
903       CGM.ErrorUnsupported(propImpl, "Obj-C getter requiring atomic copy");
904       return;
905     }
906 
907     // Return (ivar-type) objc_getProperty((id) self, _cmd, offset, true).
908     // FIXME: Can't this be simpler? This might even be worse than the
909     // corresponding gcc code.
910     llvm::Value *cmd =
911       Builder.CreateLoad(GetAddrOfLocalVar(getterMethod->getCmdDecl()), "cmd");
912     llvm::Value *self = Builder.CreateBitCast(LoadObjCSelf(), VoidPtrTy);
913     llvm::Value *ivarOffset =
914       EmitIvarOffset(classImpl->getClassInterface(), ivar);
915 
916     CallArgList args;
917     args.add(RValue::get(self), getContext().getObjCIdType());
918     args.add(RValue::get(cmd), getContext().getObjCSelType());
919     args.add(RValue::get(ivarOffset), getContext().getPointerDiffType());
920     args.add(RValue::get(Builder.getInt1(strategy.isAtomic())),
921              getContext().BoolTy);
922 
923     // FIXME: We shouldn't need to get the function info here, the
924     // runtime already should have computed it to build the function.
925     llvm::Instruction *CallInstruction;
926     RValue RV = EmitCall(getTypes().arrangeFreeFunctionCall(propType, args,
927                                                        FunctionType::ExtInfo(),
928                                                             RequiredArgs::All),
929                          getPropertyFn, ReturnValueSlot(), args, nullptr,
930                          &CallInstruction);
931     if (llvm::CallInst *call = dyn_cast<llvm::CallInst>(CallInstruction))
932       call->setTailCall();
933 
934     // We need to fix the type here. Ivars with copy & retain are
935     // always objects so we don't need to worry about complex or
936     // aggregates.
937     RV = RValue::get(Builder.CreateBitCast(
938         RV.getScalarVal(),
939         getTypes().ConvertType(getterMethod->getReturnType())));
940 
941     EmitReturnOfRValue(RV, propType);
942 
943     // objc_getProperty does an autorelease, so we should suppress ours.
944     AutoreleaseResult = false;
945 
946     return;
947   }
948 
949   case PropertyImplStrategy::CopyStruct:
950     emitStructGetterCall(*this, ivar, strategy.isAtomic(),
951                          strategy.hasStrongMember());
952     return;
953 
954   case PropertyImplStrategy::Expression:
955   case PropertyImplStrategy::SetPropertyAndExpressionGet: {
956     LValue LV = EmitLValueForIvar(TypeOfSelfObject(), LoadObjCSelf(), ivar, 0);
957 
958     QualType ivarType = ivar->getType();
959     switch (getEvaluationKind(ivarType)) {
960     case TEK_Complex: {
961       ComplexPairTy pair = EmitLoadOfComplex(LV, SourceLocation());
962       EmitStoreOfComplex(pair, MakeAddrLValue(ReturnValue, ivarType),
963                          /*init*/ true);
964       return;
965     }
966     case TEK_Aggregate:
967       // The return value slot is guaranteed to not be aliased, but
968       // that's not necessarily the same as "on the stack", so
969       // we still potentially need objc_memmove_collectable.
970       EmitAggregateCopy(ReturnValue, LV.getAddress(), ivarType);
971       return;
972     case TEK_Scalar: {
973       llvm::Value *value;
974       if (propType->isReferenceType()) {
975         value = LV.getAddress().getPointer();
976       } else {
977         // We want to load and autoreleaseReturnValue ARC __weak ivars.
978         if (LV.getQuals().getObjCLifetime() == Qualifiers::OCL_Weak) {
979           value = emitARCRetainLoadOfScalar(*this, LV, ivarType);
980 
981         // Otherwise we want to do a simple load, suppressing the
982         // final autorelease.
983         } else {
984           value = EmitLoadOfLValue(LV, SourceLocation()).getScalarVal();
985           AutoreleaseResult = false;
986         }
987 
988         value = Builder.CreateBitCast(value, ConvertType(propType));
989         value = Builder.CreateBitCast(
990             value, ConvertType(GetterMethodDecl->getReturnType()));
991       }
992 
993       EmitReturnOfRValue(RValue::get(value), propType);
994       return;
995     }
996     }
997     llvm_unreachable("bad evaluation kind");
998   }
999 
1000   }
1001   llvm_unreachable("bad @property implementation strategy!");
1002 }
1003 
1004 /// emitStructSetterCall - Call the runtime function to store the value
1005 /// from the first formal parameter into the given ivar.
1006 static void emitStructSetterCall(CodeGenFunction &CGF, ObjCMethodDecl *OMD,
1007                                  ObjCIvarDecl *ivar) {
1008   // objc_copyStruct (&structIvar, &Arg,
1009   //                  sizeof (struct something), true, false);
1010   CallArgList args;
1011 
1012   // The first argument is the address of the ivar.
1013   llvm::Value *ivarAddr = CGF.EmitLValueForIvar(CGF.TypeOfSelfObject(),
1014                                                 CGF.LoadObjCSelf(), ivar, 0)
1015     .getPointer();
1016   ivarAddr = CGF.Builder.CreateBitCast(ivarAddr, CGF.Int8PtrTy);
1017   args.add(RValue::get(ivarAddr), CGF.getContext().VoidPtrTy);
1018 
1019   // The second argument is the address of the parameter variable.
1020   ParmVarDecl *argVar = *OMD->param_begin();
1021   DeclRefExpr argRef(argVar, false, argVar->getType().getNonReferenceType(),
1022                      VK_LValue, SourceLocation());
1023   llvm::Value *argAddr = CGF.EmitLValue(&argRef).getPointer();
1024   argAddr = CGF.Builder.CreateBitCast(argAddr, CGF.Int8PtrTy);
1025   args.add(RValue::get(argAddr), CGF.getContext().VoidPtrTy);
1026 
1027   // The third argument is the sizeof the type.
1028   llvm::Value *size =
1029     CGF.CGM.getSize(CGF.getContext().getTypeSizeInChars(ivar->getType()));
1030   args.add(RValue::get(size), CGF.getContext().getSizeType());
1031 
1032   // The fourth argument is the 'isAtomic' flag.
1033   args.add(RValue::get(CGF.Builder.getTrue()), CGF.getContext().BoolTy);
1034 
1035   // The fifth argument is the 'hasStrong' flag.
1036   // FIXME: should this really always be false?
1037   args.add(RValue::get(CGF.Builder.getFalse()), CGF.getContext().BoolTy);
1038 
1039   llvm::Value *copyStructFn = CGF.CGM.getObjCRuntime().GetSetStructFunction();
1040   CGF.EmitCall(CGF.getTypes().arrangeFreeFunctionCall(CGF.getContext().VoidTy,
1041                                                       args,
1042                                                       FunctionType::ExtInfo(),
1043                                                       RequiredArgs::All),
1044                copyStructFn, ReturnValueSlot(), args);
1045 }
1046 
1047 /// emitCPPObjectAtomicSetterCall - Call the runtime function to store
1048 /// the value from the first formal parameter into the given ivar, using
1049 /// the Cpp API for atomic Cpp objects with non-trivial copy assignment.
1050 static void emitCPPObjectAtomicSetterCall(CodeGenFunction &CGF,
1051                                           ObjCMethodDecl *OMD,
1052                                           ObjCIvarDecl *ivar,
1053                                           llvm::Constant *AtomicHelperFn) {
1054   // objc_copyCppObjectAtomic (&CppObjectIvar, &Arg,
1055   //                           AtomicHelperFn);
1056   CallArgList args;
1057 
1058   // The first argument is the address of the ivar.
1059   llvm::Value *ivarAddr =
1060     CGF.EmitLValueForIvar(CGF.TypeOfSelfObject(),
1061                           CGF.LoadObjCSelf(), ivar, 0).getPointer();
1062   ivarAddr = CGF.Builder.CreateBitCast(ivarAddr, CGF.Int8PtrTy);
1063   args.add(RValue::get(ivarAddr), CGF.getContext().VoidPtrTy);
1064 
1065   // The second argument is the address of the parameter variable.
1066   ParmVarDecl *argVar = *OMD->param_begin();
1067   DeclRefExpr argRef(argVar, false, argVar->getType().getNonReferenceType(),
1068                      VK_LValue, SourceLocation());
1069   llvm::Value *argAddr = CGF.EmitLValue(&argRef).getPointer();
1070   argAddr = CGF.Builder.CreateBitCast(argAddr, CGF.Int8PtrTy);
1071   args.add(RValue::get(argAddr), CGF.getContext().VoidPtrTy);
1072 
1073   // Third argument is the helper function.
1074   args.add(RValue::get(AtomicHelperFn), CGF.getContext().VoidPtrTy);
1075 
1076   llvm::Value *copyCppAtomicObjectFn =
1077     CGF.CGM.getObjCRuntime().GetCppAtomicObjectSetFunction();
1078   CGF.EmitCall(CGF.getTypes().arrangeFreeFunctionCall(CGF.getContext().VoidTy,
1079                                                       args,
1080                                                       FunctionType::ExtInfo(),
1081                                                       RequiredArgs::All),
1082                copyCppAtomicObjectFn, ReturnValueSlot(), args);
1083 }
1084 
1085 
1086 static bool hasTrivialSetExpr(const ObjCPropertyImplDecl *PID) {
1087   Expr *setter = PID->getSetterCXXAssignment();
1088   if (!setter) return true;
1089 
1090   // Sema only makes only of these when the ivar has a C++ class type,
1091   // so the form is pretty constrained.
1092 
1093   // An operator call is trivial if the function it calls is trivial.
1094   // This also implies that there's nothing non-trivial going on with
1095   // the arguments, because operator= can only be trivial if it's a
1096   // synthesized assignment operator and therefore both parameters are
1097   // references.
1098   if (CallExpr *call = dyn_cast<CallExpr>(setter)) {
1099     if (const FunctionDecl *callee
1100           = dyn_cast_or_null<FunctionDecl>(call->getCalleeDecl()))
1101       if (callee->isTrivial())
1102         return true;
1103     return false;
1104   }
1105 
1106   assert(isa<ExprWithCleanups>(setter));
1107   return false;
1108 }
1109 
1110 static bool UseOptimizedSetter(CodeGenModule &CGM) {
1111   if (CGM.getLangOpts().getGC() != LangOptions::NonGC)
1112     return false;
1113   return CGM.getLangOpts().ObjCRuntime.hasOptimizedSetter();
1114 }
1115 
1116 void
1117 CodeGenFunction::generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
1118                                         const ObjCPropertyImplDecl *propImpl,
1119                                         llvm::Constant *AtomicHelperFn) {
1120   const ObjCPropertyDecl *prop = propImpl->getPropertyDecl();
1121   ObjCIvarDecl *ivar = propImpl->getPropertyIvarDecl();
1122   ObjCMethodDecl *setterMethod = prop->getSetterMethodDecl();
1123 
1124   // Just use the setter expression if Sema gave us one and it's
1125   // non-trivial.
1126   if (!hasTrivialSetExpr(propImpl)) {
1127     if (!AtomicHelperFn)
1128       // If non-atomic, assignment is called directly.
1129       EmitStmt(propImpl->getSetterCXXAssignment());
1130     else
1131       // If atomic, assignment is called via a locking api.
1132       emitCPPObjectAtomicSetterCall(*this, setterMethod, ivar,
1133                                     AtomicHelperFn);
1134     return;
1135   }
1136 
1137   PropertyImplStrategy strategy(CGM, propImpl);
1138   switch (strategy.getKind()) {
1139   case PropertyImplStrategy::Native: {
1140     // We don't need to do anything for a zero-size struct.
1141     if (strategy.getIvarSize().isZero())
1142       return;
1143 
1144     Address argAddr = GetAddrOfLocalVar(*setterMethod->param_begin());
1145 
1146     LValue ivarLValue =
1147       EmitLValueForIvar(TypeOfSelfObject(), LoadObjCSelf(), ivar, /*quals*/ 0);
1148     Address ivarAddr = ivarLValue.getAddress();
1149 
1150     // Currently, all atomic accesses have to be through integer
1151     // types, so there's no point in trying to pick a prettier type.
1152     llvm::Type *bitcastType =
1153       llvm::Type::getIntNTy(getLLVMContext(),
1154                             getContext().toBits(strategy.getIvarSize()));
1155 
1156     // Cast both arguments to the chosen operation type.
1157     argAddr = Builder.CreateElementBitCast(argAddr, bitcastType);
1158     ivarAddr = Builder.CreateElementBitCast(ivarAddr, bitcastType);
1159 
1160     // This bitcast load is likely to cause some nasty IR.
1161     llvm::Value *load = Builder.CreateLoad(argAddr);
1162 
1163     // Perform an atomic store.  There are no memory ordering requirements.
1164     llvm::StoreInst *store = Builder.CreateStore(load, ivarAddr);
1165     store->setAtomic(llvm::Unordered);
1166     return;
1167   }
1168 
1169   case PropertyImplStrategy::GetSetProperty:
1170   case PropertyImplStrategy::SetPropertyAndExpressionGet: {
1171 
1172     llvm::Value *setOptimizedPropertyFn = nullptr;
1173     llvm::Value *setPropertyFn = nullptr;
1174     if (UseOptimizedSetter(CGM)) {
1175       // 10.8 and iOS 6.0 code and GC is off
1176       setOptimizedPropertyFn =
1177         CGM.getObjCRuntime()
1178            .GetOptimizedPropertySetFunction(strategy.isAtomic(),
1179                                             strategy.isCopy());
1180       if (!setOptimizedPropertyFn) {
1181         CGM.ErrorUnsupported(propImpl, "Obj-C optimized setter - NYI");
1182         return;
1183       }
1184     }
1185     else {
1186       setPropertyFn = CGM.getObjCRuntime().GetPropertySetFunction();
1187       if (!setPropertyFn) {
1188         CGM.ErrorUnsupported(propImpl, "Obj-C setter requiring atomic copy");
1189         return;
1190       }
1191     }
1192 
1193     // Emit objc_setProperty((id) self, _cmd, offset, arg,
1194     //                       <is-atomic>, <is-copy>).
1195     llvm::Value *cmd =
1196       Builder.CreateLoad(GetAddrOfLocalVar(setterMethod->getCmdDecl()));
1197     llvm::Value *self =
1198       Builder.CreateBitCast(LoadObjCSelf(), VoidPtrTy);
1199     llvm::Value *ivarOffset =
1200       EmitIvarOffset(classImpl->getClassInterface(), ivar);
1201     Address argAddr = GetAddrOfLocalVar(*setterMethod->param_begin());
1202     llvm::Value *arg = Builder.CreateLoad(argAddr, "arg");
1203     arg = Builder.CreateBitCast(arg, VoidPtrTy);
1204 
1205     CallArgList args;
1206     args.add(RValue::get(self), getContext().getObjCIdType());
1207     args.add(RValue::get(cmd), getContext().getObjCSelType());
1208     if (setOptimizedPropertyFn) {
1209       args.add(RValue::get(arg), getContext().getObjCIdType());
1210       args.add(RValue::get(ivarOffset), getContext().getPointerDiffType());
1211       EmitCall(getTypes().arrangeFreeFunctionCall(getContext().VoidTy, args,
1212                                                   FunctionType::ExtInfo(),
1213                                                   RequiredArgs::All),
1214                setOptimizedPropertyFn, ReturnValueSlot(), args);
1215     } else {
1216       args.add(RValue::get(ivarOffset), getContext().getPointerDiffType());
1217       args.add(RValue::get(arg), getContext().getObjCIdType());
1218       args.add(RValue::get(Builder.getInt1(strategy.isAtomic())),
1219                getContext().BoolTy);
1220       args.add(RValue::get(Builder.getInt1(strategy.isCopy())),
1221                getContext().BoolTy);
1222       // FIXME: We shouldn't need to get the function info here, the runtime
1223       // already should have computed it to build the function.
1224       EmitCall(getTypes().arrangeFreeFunctionCall(getContext().VoidTy, args,
1225                                                   FunctionType::ExtInfo(),
1226                                                   RequiredArgs::All),
1227                setPropertyFn, ReturnValueSlot(), args);
1228     }
1229 
1230     return;
1231   }
1232 
1233   case PropertyImplStrategy::CopyStruct:
1234     emitStructSetterCall(*this, setterMethod, ivar);
1235     return;
1236 
1237   case PropertyImplStrategy::Expression:
1238     break;
1239   }
1240 
1241   // Otherwise, fake up some ASTs and emit a normal assignment.
1242   ValueDecl *selfDecl = setterMethod->getSelfDecl();
1243   DeclRefExpr self(selfDecl, false, selfDecl->getType(),
1244                    VK_LValue, SourceLocation());
1245   ImplicitCastExpr selfLoad(ImplicitCastExpr::OnStack,
1246                             selfDecl->getType(), CK_LValueToRValue, &self,
1247                             VK_RValue);
1248   ObjCIvarRefExpr ivarRef(ivar, ivar->getType().getNonReferenceType(),
1249                           SourceLocation(), SourceLocation(),
1250                           &selfLoad, true, true);
1251 
1252   ParmVarDecl *argDecl = *setterMethod->param_begin();
1253   QualType argType = argDecl->getType().getNonReferenceType();
1254   DeclRefExpr arg(argDecl, false, argType, VK_LValue, SourceLocation());
1255   ImplicitCastExpr argLoad(ImplicitCastExpr::OnStack,
1256                            argType.getUnqualifiedType(), CK_LValueToRValue,
1257                            &arg, VK_RValue);
1258 
1259   // The property type can differ from the ivar type in some situations with
1260   // Objective-C pointer types, we can always bit cast the RHS in these cases.
1261   // The following absurdity is just to ensure well-formed IR.
1262   CastKind argCK = CK_NoOp;
1263   if (ivarRef.getType()->isObjCObjectPointerType()) {
1264     if (argLoad.getType()->isObjCObjectPointerType())
1265       argCK = CK_BitCast;
1266     else if (argLoad.getType()->isBlockPointerType())
1267       argCK = CK_BlockPointerToObjCPointerCast;
1268     else
1269       argCK = CK_CPointerToObjCPointerCast;
1270   } else if (ivarRef.getType()->isBlockPointerType()) {
1271      if (argLoad.getType()->isBlockPointerType())
1272       argCK = CK_BitCast;
1273     else
1274       argCK = CK_AnyPointerToBlockPointerCast;
1275   } else if (ivarRef.getType()->isPointerType()) {
1276     argCK = CK_BitCast;
1277   }
1278   ImplicitCastExpr argCast(ImplicitCastExpr::OnStack,
1279                            ivarRef.getType(), argCK, &argLoad,
1280                            VK_RValue);
1281   Expr *finalArg = &argLoad;
1282   if (!getContext().hasSameUnqualifiedType(ivarRef.getType(),
1283                                            argLoad.getType()))
1284     finalArg = &argCast;
1285 
1286 
1287   BinaryOperator assign(&ivarRef, finalArg, BO_Assign,
1288                         ivarRef.getType(), VK_RValue, OK_Ordinary,
1289                         SourceLocation(), false);
1290   EmitStmt(&assign);
1291 }
1292 
1293 /// \brief Generate an Objective-C property setter function.
1294 ///
1295 /// The given Decl must be an ObjCImplementationDecl. \@synthesize
1296 /// is illegal within a category.
1297 void CodeGenFunction::GenerateObjCSetter(ObjCImplementationDecl *IMP,
1298                                          const ObjCPropertyImplDecl *PID) {
1299   llvm::Constant *AtomicHelperFn =
1300       CodeGenFunction(CGM).GenerateObjCAtomicSetterCopyHelperFunction(PID);
1301   const ObjCPropertyDecl *PD = PID->getPropertyDecl();
1302   ObjCMethodDecl *OMD = PD->getSetterMethodDecl();
1303   assert(OMD && "Invalid call to generate setter (empty method)");
1304   StartObjCMethod(OMD, IMP->getClassInterface());
1305 
1306   generateObjCSetterBody(IMP, PID, AtomicHelperFn);
1307 
1308   FinishFunction();
1309 }
1310 
1311 namespace {
1312   struct DestroyIvar final : EHScopeStack::Cleanup {
1313   private:
1314     llvm::Value *addr;
1315     const ObjCIvarDecl *ivar;
1316     CodeGenFunction::Destroyer *destroyer;
1317     bool useEHCleanupForArray;
1318   public:
1319     DestroyIvar(llvm::Value *addr, const ObjCIvarDecl *ivar,
1320                 CodeGenFunction::Destroyer *destroyer,
1321                 bool useEHCleanupForArray)
1322       : addr(addr), ivar(ivar), destroyer(destroyer),
1323         useEHCleanupForArray(useEHCleanupForArray) {}
1324 
1325     void Emit(CodeGenFunction &CGF, Flags flags) override {
1326       LValue lvalue
1327         = CGF.EmitLValueForIvar(CGF.TypeOfSelfObject(), addr, ivar, /*CVR*/ 0);
1328       CGF.emitDestroy(lvalue.getAddress(), ivar->getType(), destroyer,
1329                       flags.isForNormalCleanup() && useEHCleanupForArray);
1330     }
1331   };
1332 }
1333 
1334 /// Like CodeGenFunction::destroyARCStrong, but do it with a call.
1335 static void destroyARCStrongWithStore(CodeGenFunction &CGF,
1336                                       Address addr,
1337                                       QualType type) {
1338   llvm::Value *null = getNullForVariable(addr);
1339   CGF.EmitARCStoreStrongCall(addr, null, /*ignored*/ true);
1340 }
1341 
1342 static void emitCXXDestructMethod(CodeGenFunction &CGF,
1343                                   ObjCImplementationDecl *impl) {
1344   CodeGenFunction::RunCleanupsScope scope(CGF);
1345 
1346   llvm::Value *self = CGF.LoadObjCSelf();
1347 
1348   const ObjCInterfaceDecl *iface = impl->getClassInterface();
1349   for (const ObjCIvarDecl *ivar = iface->all_declared_ivar_begin();
1350        ivar; ivar = ivar->getNextIvar()) {
1351     QualType type = ivar->getType();
1352 
1353     // Check whether the ivar is a destructible type.
1354     QualType::DestructionKind dtorKind = type.isDestructedType();
1355     if (!dtorKind) continue;
1356 
1357     CodeGenFunction::Destroyer *destroyer = nullptr;
1358 
1359     // Use a call to objc_storeStrong to destroy strong ivars, for the
1360     // general benefit of the tools.
1361     if (dtorKind == QualType::DK_objc_strong_lifetime) {
1362       destroyer = destroyARCStrongWithStore;
1363 
1364     // Otherwise use the default for the destruction kind.
1365     } else {
1366       destroyer = CGF.getDestroyer(dtorKind);
1367     }
1368 
1369     CleanupKind cleanupKind = CGF.getCleanupKind(dtorKind);
1370 
1371     CGF.EHStack.pushCleanup<DestroyIvar>(cleanupKind, self, ivar, destroyer,
1372                                          cleanupKind & EHCleanup);
1373   }
1374 
1375   assert(scope.requiresCleanups() && "nothing to do in .cxx_destruct?");
1376 }
1377 
1378 void CodeGenFunction::GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
1379                                                  ObjCMethodDecl *MD,
1380                                                  bool ctor) {
1381   MD->createImplicitParams(CGM.getContext(), IMP->getClassInterface());
1382   StartObjCMethod(MD, IMP->getClassInterface());
1383 
1384   // Emit .cxx_construct.
1385   if (ctor) {
1386     // Suppress the final autorelease in ARC.
1387     AutoreleaseResult = false;
1388 
1389     for (const auto *IvarInit : IMP->inits()) {
1390       FieldDecl *Field = IvarInit->getAnyMember();
1391       ObjCIvarDecl *Ivar = cast<ObjCIvarDecl>(Field);
1392       LValue LV = EmitLValueForIvar(TypeOfSelfObject(),
1393                                     LoadObjCSelf(), Ivar, 0);
1394       EmitAggExpr(IvarInit->getInit(),
1395                   AggValueSlot::forLValue(LV, AggValueSlot::IsDestructed,
1396                                           AggValueSlot::DoesNotNeedGCBarriers,
1397                                           AggValueSlot::IsNotAliased));
1398     }
1399     // constructor returns 'self'.
1400     CodeGenTypes &Types = CGM.getTypes();
1401     QualType IdTy(CGM.getContext().getObjCIdType());
1402     llvm::Value *SelfAsId =
1403       Builder.CreateBitCast(LoadObjCSelf(), Types.ConvertType(IdTy));
1404     EmitReturnOfRValue(RValue::get(SelfAsId), IdTy);
1405 
1406   // Emit .cxx_destruct.
1407   } else {
1408     emitCXXDestructMethod(*this, IMP);
1409   }
1410   FinishFunction();
1411 }
1412 
1413 llvm::Value *CodeGenFunction::LoadObjCSelf() {
1414   VarDecl *Self = cast<ObjCMethodDecl>(CurFuncDecl)->getSelfDecl();
1415   DeclRefExpr DRE(Self, /*is enclosing local*/ (CurFuncDecl != CurCodeDecl),
1416                   Self->getType(), VK_LValue, SourceLocation());
1417   return EmitLoadOfScalar(EmitDeclRefLValue(&DRE), SourceLocation());
1418 }
1419 
1420 QualType CodeGenFunction::TypeOfSelfObject() {
1421   const ObjCMethodDecl *OMD = cast<ObjCMethodDecl>(CurFuncDecl);
1422   ImplicitParamDecl *selfDecl = OMD->getSelfDecl();
1423   const ObjCObjectPointerType *PTy = cast<ObjCObjectPointerType>(
1424     getContext().getCanonicalType(selfDecl->getType()));
1425   return PTy->getPointeeType();
1426 }
1427 
1428 void CodeGenFunction::EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S){
1429   llvm::Constant *EnumerationMutationFn =
1430     CGM.getObjCRuntime().EnumerationMutationFunction();
1431 
1432   if (!EnumerationMutationFn) {
1433     CGM.ErrorUnsupported(&S, "Obj-C fast enumeration for this runtime");
1434     return;
1435   }
1436 
1437   CGDebugInfo *DI = getDebugInfo();
1438   if (DI)
1439     DI->EmitLexicalBlockStart(Builder, S.getSourceRange().getBegin());
1440 
1441   // The local variable comes into scope immediately.
1442   AutoVarEmission variable = AutoVarEmission::invalid();
1443   if (const DeclStmt *SD = dyn_cast<DeclStmt>(S.getElement()))
1444     variable = EmitAutoVarAlloca(*cast<VarDecl>(SD->getSingleDecl()));
1445 
1446   JumpDest LoopEnd = getJumpDestInCurrentScope("forcoll.end");
1447 
1448   // Fast enumeration state.
1449   QualType StateTy = CGM.getObjCFastEnumerationStateType();
1450   Address StatePtr = CreateMemTemp(StateTy, "state.ptr");
1451   EmitNullInitialization(StatePtr, StateTy);
1452 
1453   // Number of elements in the items array.
1454   static const unsigned NumItems = 16;
1455 
1456   // Fetch the countByEnumeratingWithState:objects:count: selector.
1457   IdentifierInfo *II[] = {
1458     &CGM.getContext().Idents.get("countByEnumeratingWithState"),
1459     &CGM.getContext().Idents.get("objects"),
1460     &CGM.getContext().Idents.get("count")
1461   };
1462   Selector FastEnumSel =
1463     CGM.getContext().Selectors.getSelector(llvm::array_lengthof(II), &II[0]);
1464 
1465   QualType ItemsTy =
1466     getContext().getConstantArrayType(getContext().getObjCIdType(),
1467                                       llvm::APInt(32, NumItems),
1468                                       ArrayType::Normal, 0);
1469   Address ItemsPtr = CreateMemTemp(ItemsTy, "items.ptr");
1470 
1471   // Emit the collection pointer.  In ARC, we do a retain.
1472   llvm::Value *Collection;
1473   if (getLangOpts().ObjCAutoRefCount) {
1474     Collection = EmitARCRetainScalarExpr(S.getCollection());
1475 
1476     // Enter a cleanup to do the release.
1477     EmitObjCConsumeObject(S.getCollection()->getType(), Collection);
1478   } else {
1479     Collection = EmitScalarExpr(S.getCollection());
1480   }
1481 
1482   // The 'continue' label needs to appear within the cleanup for the
1483   // collection object.
1484   JumpDest AfterBody = getJumpDestInCurrentScope("forcoll.next");
1485 
1486   // Send it our message:
1487   CallArgList Args;
1488 
1489   // The first argument is a temporary of the enumeration-state type.
1490   Args.add(RValue::get(StatePtr.getPointer()),
1491            getContext().getPointerType(StateTy));
1492 
1493   // The second argument is a temporary array with space for NumItems
1494   // pointers.  We'll actually be loading elements from the array
1495   // pointer written into the control state; this buffer is so that
1496   // collections that *aren't* backed by arrays can still queue up
1497   // batches of elements.
1498   Args.add(RValue::get(ItemsPtr.getPointer()),
1499            getContext().getPointerType(ItemsTy));
1500 
1501   // The third argument is the capacity of that temporary array.
1502   llvm::Type *UnsignedLongLTy = ConvertType(getContext().UnsignedLongTy);
1503   llvm::Constant *Count = llvm::ConstantInt::get(UnsignedLongLTy, NumItems);
1504   Args.add(RValue::get(Count), getContext().UnsignedLongTy);
1505 
1506   // Start the enumeration.
1507   RValue CountRV =
1508     CGM.getObjCRuntime().GenerateMessageSend(*this, ReturnValueSlot(),
1509                                              getContext().UnsignedLongTy,
1510                                              FastEnumSel,
1511                                              Collection, Args);
1512 
1513   // The initial number of objects that were returned in the buffer.
1514   llvm::Value *initialBufferLimit = CountRV.getScalarVal();
1515 
1516   llvm::BasicBlock *EmptyBB = createBasicBlock("forcoll.empty");
1517   llvm::BasicBlock *LoopInitBB = createBasicBlock("forcoll.loopinit");
1518 
1519   llvm::Value *zero = llvm::Constant::getNullValue(UnsignedLongLTy);
1520 
1521   // If the limit pointer was zero to begin with, the collection is
1522   // empty; skip all this. Set the branch weight assuming this has the same
1523   // probability of exiting the loop as any other loop exit.
1524   uint64_t EntryCount = getCurrentProfileCount();
1525   Builder.CreateCondBr(
1526       Builder.CreateICmpEQ(initialBufferLimit, zero, "iszero"), EmptyBB,
1527       LoopInitBB,
1528       createProfileWeights(EntryCount, getProfileCount(S.getBody())));
1529 
1530   // Otherwise, initialize the loop.
1531   EmitBlock(LoopInitBB);
1532 
1533   // Save the initial mutations value.  This is the value at an
1534   // address that was written into the state object by
1535   // countByEnumeratingWithState:objects:count:.
1536   Address StateMutationsPtrPtr = Builder.CreateStructGEP(
1537       StatePtr, 2, 2 * getPointerSize(), "mutationsptr.ptr");
1538   llvm::Value *StateMutationsPtr
1539     = Builder.CreateLoad(StateMutationsPtrPtr, "mutationsptr");
1540 
1541   llvm::Value *initialMutations =
1542     Builder.CreateAlignedLoad(StateMutationsPtr, getPointerAlign(),
1543                               "forcoll.initial-mutations");
1544 
1545   // Start looping.  This is the point we return to whenever we have a
1546   // fresh, non-empty batch of objects.
1547   llvm::BasicBlock *LoopBodyBB = createBasicBlock("forcoll.loopbody");
1548   EmitBlock(LoopBodyBB);
1549 
1550   // The current index into the buffer.
1551   llvm::PHINode *index = Builder.CreatePHI(UnsignedLongLTy, 3, "forcoll.index");
1552   index->addIncoming(zero, LoopInitBB);
1553 
1554   // The current buffer size.
1555   llvm::PHINode *count = Builder.CreatePHI(UnsignedLongLTy, 3, "forcoll.count");
1556   count->addIncoming(initialBufferLimit, LoopInitBB);
1557 
1558   incrementProfileCounter(&S);
1559 
1560   // Check whether the mutations value has changed from where it was
1561   // at start.  StateMutationsPtr should actually be invariant between
1562   // refreshes.
1563   StateMutationsPtr = Builder.CreateLoad(StateMutationsPtrPtr, "mutationsptr");
1564   llvm::Value *currentMutations
1565     = Builder.CreateAlignedLoad(StateMutationsPtr, getPointerAlign(),
1566                                 "statemutations");
1567 
1568   llvm::BasicBlock *WasMutatedBB = createBasicBlock("forcoll.mutated");
1569   llvm::BasicBlock *WasNotMutatedBB = createBasicBlock("forcoll.notmutated");
1570 
1571   Builder.CreateCondBr(Builder.CreateICmpEQ(currentMutations, initialMutations),
1572                        WasNotMutatedBB, WasMutatedBB);
1573 
1574   // If so, call the enumeration-mutation function.
1575   EmitBlock(WasMutatedBB);
1576   llvm::Value *V =
1577     Builder.CreateBitCast(Collection,
1578                           ConvertType(getContext().getObjCIdType()));
1579   CallArgList Args2;
1580   Args2.add(RValue::get(V), getContext().getObjCIdType());
1581   // FIXME: We shouldn't need to get the function info here, the runtime already
1582   // should have computed it to build the function.
1583   EmitCall(CGM.getTypes().arrangeFreeFunctionCall(getContext().VoidTy, Args2,
1584                                                   FunctionType::ExtInfo(),
1585                                                   RequiredArgs::All),
1586            EnumerationMutationFn, ReturnValueSlot(), Args2);
1587 
1588   // Otherwise, or if the mutation function returns, just continue.
1589   EmitBlock(WasNotMutatedBB);
1590 
1591   // Initialize the element variable.
1592   RunCleanupsScope elementVariableScope(*this);
1593   bool elementIsVariable;
1594   LValue elementLValue;
1595   QualType elementType;
1596   if (const DeclStmt *SD = dyn_cast<DeclStmt>(S.getElement())) {
1597     // Initialize the variable, in case it's a __block variable or something.
1598     EmitAutoVarInit(variable);
1599 
1600     const VarDecl* D = cast<VarDecl>(SD->getSingleDecl());
1601     DeclRefExpr tempDRE(const_cast<VarDecl*>(D), false, D->getType(),
1602                         VK_LValue, SourceLocation());
1603     elementLValue = EmitLValue(&tempDRE);
1604     elementType = D->getType();
1605     elementIsVariable = true;
1606 
1607     if (D->isARCPseudoStrong())
1608       elementLValue.getQuals().setObjCLifetime(Qualifiers::OCL_ExplicitNone);
1609   } else {
1610     elementLValue = LValue(); // suppress warning
1611     elementType = cast<Expr>(S.getElement())->getType();
1612     elementIsVariable = false;
1613   }
1614   llvm::Type *convertedElementType = ConvertType(elementType);
1615 
1616   // Fetch the buffer out of the enumeration state.
1617   // TODO: this pointer should actually be invariant between
1618   // refreshes, which would help us do certain loop optimizations.
1619   Address StateItemsPtr = Builder.CreateStructGEP(
1620       StatePtr, 1, getPointerSize(), "stateitems.ptr");
1621   llvm::Value *EnumStateItems =
1622     Builder.CreateLoad(StateItemsPtr, "stateitems");
1623 
1624   // Fetch the value at the current index from the buffer.
1625   llvm::Value *CurrentItemPtr =
1626     Builder.CreateGEP(EnumStateItems, index, "currentitem.ptr");
1627   llvm::Value *CurrentItem =
1628     Builder.CreateAlignedLoad(CurrentItemPtr, getPointerAlign());
1629 
1630   // Cast that value to the right type.
1631   CurrentItem = Builder.CreateBitCast(CurrentItem, convertedElementType,
1632                                       "currentitem");
1633 
1634   // Make sure we have an l-value.  Yes, this gets evaluated every
1635   // time through the loop.
1636   if (!elementIsVariable) {
1637     elementLValue = EmitLValue(cast<Expr>(S.getElement()));
1638     EmitStoreThroughLValue(RValue::get(CurrentItem), elementLValue);
1639   } else {
1640     EmitScalarInit(CurrentItem, elementLValue);
1641   }
1642 
1643   // If we do have an element variable, this assignment is the end of
1644   // its initialization.
1645   if (elementIsVariable)
1646     EmitAutoVarCleanups(variable);
1647 
1648   // Perform the loop body, setting up break and continue labels.
1649   BreakContinueStack.push_back(BreakContinue(LoopEnd, AfterBody));
1650   {
1651     RunCleanupsScope Scope(*this);
1652     EmitStmt(S.getBody());
1653   }
1654   BreakContinueStack.pop_back();
1655 
1656   // Destroy the element variable now.
1657   elementVariableScope.ForceCleanup();
1658 
1659   // Check whether there are more elements.
1660   EmitBlock(AfterBody.getBlock());
1661 
1662   llvm::BasicBlock *FetchMoreBB = createBasicBlock("forcoll.refetch");
1663 
1664   // First we check in the local buffer.
1665   llvm::Value *indexPlusOne
1666     = Builder.CreateAdd(index, llvm::ConstantInt::get(UnsignedLongLTy, 1));
1667 
1668   // If we haven't overrun the buffer yet, we can continue.
1669   // Set the branch weights based on the simplifying assumption that this is
1670   // like a while-loop, i.e., ignoring that the false branch fetches more
1671   // elements and then returns to the loop.
1672   Builder.CreateCondBr(
1673       Builder.CreateICmpULT(indexPlusOne, count), LoopBodyBB, FetchMoreBB,
1674       createProfileWeights(getProfileCount(S.getBody()), EntryCount));
1675 
1676   index->addIncoming(indexPlusOne, AfterBody.getBlock());
1677   count->addIncoming(count, AfterBody.getBlock());
1678 
1679   // Otherwise, we have to fetch more elements.
1680   EmitBlock(FetchMoreBB);
1681 
1682   CountRV =
1683     CGM.getObjCRuntime().GenerateMessageSend(*this, ReturnValueSlot(),
1684                                              getContext().UnsignedLongTy,
1685                                              FastEnumSel,
1686                                              Collection, Args);
1687 
1688   // If we got a zero count, we're done.
1689   llvm::Value *refetchCount = CountRV.getScalarVal();
1690 
1691   // (note that the message send might split FetchMoreBB)
1692   index->addIncoming(zero, Builder.GetInsertBlock());
1693   count->addIncoming(refetchCount, Builder.GetInsertBlock());
1694 
1695   Builder.CreateCondBr(Builder.CreateICmpEQ(refetchCount, zero),
1696                        EmptyBB, LoopBodyBB);
1697 
1698   // No more elements.
1699   EmitBlock(EmptyBB);
1700 
1701   if (!elementIsVariable) {
1702     // If the element was not a declaration, set it to be null.
1703 
1704     llvm::Value *null = llvm::Constant::getNullValue(convertedElementType);
1705     elementLValue = EmitLValue(cast<Expr>(S.getElement()));
1706     EmitStoreThroughLValue(RValue::get(null), elementLValue);
1707   }
1708 
1709   if (DI)
1710     DI->EmitLexicalBlockEnd(Builder, S.getSourceRange().getEnd());
1711 
1712   // Leave the cleanup we entered in ARC.
1713   if (getLangOpts().ObjCAutoRefCount)
1714     PopCleanupBlock();
1715 
1716   EmitBlock(LoopEnd.getBlock());
1717 }
1718 
1719 void CodeGenFunction::EmitObjCAtTryStmt(const ObjCAtTryStmt &S) {
1720   CGM.getObjCRuntime().EmitTryStmt(*this, S);
1721 }
1722 
1723 void CodeGenFunction::EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S) {
1724   CGM.getObjCRuntime().EmitThrowStmt(*this, S);
1725 }
1726 
1727 void CodeGenFunction::EmitObjCAtSynchronizedStmt(
1728                                               const ObjCAtSynchronizedStmt &S) {
1729   CGM.getObjCRuntime().EmitSynchronizedStmt(*this, S);
1730 }
1731 
1732 namespace {
1733   struct CallObjCRelease final : EHScopeStack::Cleanup {
1734     CallObjCRelease(llvm::Value *object) : object(object) {}
1735     llvm::Value *object;
1736 
1737     void Emit(CodeGenFunction &CGF, Flags flags) override {
1738       // Releases at the end of the full-expression are imprecise.
1739       CGF.EmitARCRelease(object, ARCImpreciseLifetime);
1740     }
1741   };
1742 }
1743 
1744 /// Produce the code for a CK_ARCConsumeObject.  Does a primitive
1745 /// release at the end of the full-expression.
1746 llvm::Value *CodeGenFunction::EmitObjCConsumeObject(QualType type,
1747                                                     llvm::Value *object) {
1748   // If we're in a conditional branch, we need to make the cleanup
1749   // conditional.
1750   pushFullExprCleanup<CallObjCRelease>(getARCCleanupKind(), object);
1751   return object;
1752 }
1753 
1754 llvm::Value *CodeGenFunction::EmitObjCExtendObjectLifetime(QualType type,
1755                                                            llvm::Value *value) {
1756   return EmitARCRetainAutorelease(type, value);
1757 }
1758 
1759 /// Given a number of pointers, inform the optimizer that they're
1760 /// being intrinsically used up until this point in the program.
1761 void CodeGenFunction::EmitARCIntrinsicUse(ArrayRef<llvm::Value*> values) {
1762   llvm::Constant *&fn = CGM.getARCEntrypoints().clang_arc_use;
1763   if (!fn) {
1764     llvm::FunctionType *fnType =
1765       llvm::FunctionType::get(CGM.VoidTy, None, true);
1766     fn = CGM.CreateRuntimeFunction(fnType, "clang.arc.use");
1767   }
1768 
1769   // This isn't really a "runtime" function, but as an intrinsic it
1770   // doesn't really matter as long as we align things up.
1771   EmitNounwindRuntimeCall(fn, values);
1772 }
1773 
1774 
1775 static llvm::Constant *createARCRuntimeFunction(CodeGenModule &CGM,
1776                                                 llvm::FunctionType *type,
1777                                                 StringRef fnName) {
1778   llvm::Constant *fn = CGM.CreateRuntimeFunction(type, fnName);
1779 
1780   if (llvm::Function *f = dyn_cast<llvm::Function>(fn)) {
1781     // If the target runtime doesn't naturally support ARC, emit weak
1782     // references to the runtime support library.  We don't really
1783     // permit this to fail, but we need a particular relocation style.
1784     if (!CGM.getLangOpts().ObjCRuntime.hasNativeARC()) {
1785       f->setLinkage(llvm::Function::ExternalWeakLinkage);
1786     } else if (fnName == "objc_retain" || fnName  == "objc_release") {
1787       // If we have Native ARC, set nonlazybind attribute for these APIs for
1788       // performance.
1789       f->addFnAttr(llvm::Attribute::NonLazyBind);
1790     }
1791   }
1792 
1793   return fn;
1794 }
1795 
1796 /// Perform an operation having the signature
1797 ///   i8* (i8*)
1798 /// where a null input causes a no-op and returns null.
1799 static llvm::Value *emitARCValueOperation(CodeGenFunction &CGF,
1800                                           llvm::Value *value,
1801                                           llvm::Constant *&fn,
1802                                           StringRef fnName,
1803                                           bool isTailCall = false) {
1804   if (isa<llvm::ConstantPointerNull>(value)) return value;
1805 
1806   if (!fn) {
1807     llvm::FunctionType *fnType =
1808       llvm::FunctionType::get(CGF.Int8PtrTy, CGF.Int8PtrTy, false);
1809     fn = createARCRuntimeFunction(CGF.CGM, fnType, fnName);
1810   }
1811 
1812   // Cast the argument to 'id'.
1813   llvm::Type *origType = value->getType();
1814   value = CGF.Builder.CreateBitCast(value, CGF.Int8PtrTy);
1815 
1816   // Call the function.
1817   llvm::CallInst *call = CGF.EmitNounwindRuntimeCall(fn, value);
1818   if (isTailCall)
1819     call->setTailCall();
1820 
1821   // Cast the result back to the original type.
1822   return CGF.Builder.CreateBitCast(call, origType);
1823 }
1824 
1825 /// Perform an operation having the following signature:
1826 ///   i8* (i8**)
1827 static llvm::Value *emitARCLoadOperation(CodeGenFunction &CGF,
1828                                          Address addr,
1829                                          llvm::Constant *&fn,
1830                                          StringRef fnName) {
1831   if (!fn) {
1832     llvm::FunctionType *fnType =
1833       llvm::FunctionType::get(CGF.Int8PtrTy, CGF.Int8PtrPtrTy, false);
1834     fn = createARCRuntimeFunction(CGF.CGM, fnType, fnName);
1835   }
1836 
1837   // Cast the argument to 'id*'.
1838   llvm::Type *origType = addr.getElementType();
1839   addr = CGF.Builder.CreateBitCast(addr, CGF.Int8PtrPtrTy);
1840 
1841   // Call the function.
1842   llvm::Value *result = CGF.EmitNounwindRuntimeCall(fn, addr.getPointer());
1843 
1844   // Cast the result back to a dereference of the original type.
1845   if (origType != CGF.Int8PtrTy)
1846     result = CGF.Builder.CreateBitCast(result, origType);
1847 
1848   return result;
1849 }
1850 
1851 /// Perform an operation having the following signature:
1852 ///   i8* (i8**, i8*)
1853 static llvm::Value *emitARCStoreOperation(CodeGenFunction &CGF,
1854                                           Address addr,
1855                                           llvm::Value *value,
1856                                           llvm::Constant *&fn,
1857                                           StringRef fnName,
1858                                           bool ignored) {
1859   assert(addr.getElementType() == value->getType());
1860 
1861   if (!fn) {
1862     llvm::Type *argTypes[] = { CGF.Int8PtrPtrTy, CGF.Int8PtrTy };
1863 
1864     llvm::FunctionType *fnType
1865       = llvm::FunctionType::get(CGF.Int8PtrTy, argTypes, false);
1866     fn = createARCRuntimeFunction(CGF.CGM, fnType, fnName);
1867   }
1868 
1869   llvm::Type *origType = value->getType();
1870 
1871   llvm::Value *args[] = {
1872     CGF.Builder.CreateBitCast(addr.getPointer(), CGF.Int8PtrPtrTy),
1873     CGF.Builder.CreateBitCast(value, CGF.Int8PtrTy)
1874   };
1875   llvm::CallInst *result = CGF.EmitNounwindRuntimeCall(fn, args);
1876 
1877   if (ignored) return nullptr;
1878 
1879   return CGF.Builder.CreateBitCast(result, origType);
1880 }
1881 
1882 /// Perform an operation having the following signature:
1883 ///   void (i8**, i8**)
1884 static void emitARCCopyOperation(CodeGenFunction &CGF,
1885                                  Address dst,
1886                                  Address src,
1887                                  llvm::Constant *&fn,
1888                                  StringRef fnName) {
1889   assert(dst.getType() == src.getType());
1890 
1891   if (!fn) {
1892     llvm::Type *argTypes[] = { CGF.Int8PtrPtrTy, CGF.Int8PtrPtrTy };
1893 
1894     llvm::FunctionType *fnType
1895       = llvm::FunctionType::get(CGF.Builder.getVoidTy(), argTypes, false);
1896     fn = createARCRuntimeFunction(CGF.CGM, fnType, fnName);
1897   }
1898 
1899   llvm::Value *args[] = {
1900     CGF.Builder.CreateBitCast(dst.getPointer(), CGF.Int8PtrPtrTy),
1901     CGF.Builder.CreateBitCast(src.getPointer(), CGF.Int8PtrPtrTy)
1902   };
1903   CGF.EmitNounwindRuntimeCall(fn, args);
1904 }
1905 
1906 /// Produce the code to do a retain.  Based on the type, calls one of:
1907 ///   call i8* \@objc_retain(i8* %value)
1908 ///   call i8* \@objc_retainBlock(i8* %value)
1909 llvm::Value *CodeGenFunction::EmitARCRetain(QualType type, llvm::Value *value) {
1910   if (type->isBlockPointerType())
1911     return EmitARCRetainBlock(value, /*mandatory*/ false);
1912   else
1913     return EmitARCRetainNonBlock(value);
1914 }
1915 
1916 /// Retain the given object, with normal retain semantics.
1917 ///   call i8* \@objc_retain(i8* %value)
1918 llvm::Value *CodeGenFunction::EmitARCRetainNonBlock(llvm::Value *value) {
1919   return emitARCValueOperation(*this, value,
1920                                CGM.getARCEntrypoints().objc_retain,
1921                                "objc_retain");
1922 }
1923 
1924 /// Retain the given block, with _Block_copy semantics.
1925 ///   call i8* \@objc_retainBlock(i8* %value)
1926 ///
1927 /// \param mandatory - If false, emit the call with metadata
1928 /// indicating that it's okay for the optimizer to eliminate this call
1929 /// if it can prove that the block never escapes except down the stack.
1930 llvm::Value *CodeGenFunction::EmitARCRetainBlock(llvm::Value *value,
1931                                                  bool mandatory) {
1932   llvm::Value *result
1933     = emitARCValueOperation(*this, value,
1934                             CGM.getARCEntrypoints().objc_retainBlock,
1935                             "objc_retainBlock");
1936 
1937   // If the copy isn't mandatory, add !clang.arc.copy_on_escape to
1938   // tell the optimizer that it doesn't need to do this copy if the
1939   // block doesn't escape, where being passed as an argument doesn't
1940   // count as escaping.
1941   if (!mandatory && isa<llvm::Instruction>(result)) {
1942     llvm::CallInst *call
1943       = cast<llvm::CallInst>(result->stripPointerCasts());
1944     assert(call->getCalledValue() == CGM.getARCEntrypoints().objc_retainBlock);
1945 
1946     call->setMetadata("clang.arc.copy_on_escape",
1947                       llvm::MDNode::get(Builder.getContext(), None));
1948   }
1949 
1950   return result;
1951 }
1952 
1953 /// Retain the given object which is the result of a function call.
1954 ///   call i8* \@objc_retainAutoreleasedReturnValue(i8* %value)
1955 ///
1956 /// Yes, this function name is one character away from a different
1957 /// call with completely different semantics.
1958 llvm::Value *
1959 CodeGenFunction::EmitARCRetainAutoreleasedReturnValue(llvm::Value *value) {
1960   // Fetch the void(void) inline asm which marks that we're going to
1961   // retain the autoreleased return value.
1962   llvm::InlineAsm *&marker
1963     = CGM.getARCEntrypoints().retainAutoreleasedReturnValueMarker;
1964   if (!marker) {
1965     StringRef assembly
1966       = CGM.getTargetCodeGenInfo()
1967            .getARCRetainAutoreleasedReturnValueMarker();
1968 
1969     // If we have an empty assembly string, there's nothing to do.
1970     if (assembly.empty()) {
1971 
1972     // Otherwise, at -O0, build an inline asm that we're going to call
1973     // in a moment.
1974     } else if (CGM.getCodeGenOpts().OptimizationLevel == 0) {
1975       llvm::FunctionType *type =
1976         llvm::FunctionType::get(VoidTy, /*variadic*/false);
1977 
1978       marker = llvm::InlineAsm::get(type, assembly, "", /*sideeffects*/ true);
1979 
1980     // If we're at -O1 and above, we don't want to litter the code
1981     // with this marker yet, so leave a breadcrumb for the ARC
1982     // optimizer to pick up.
1983     } else {
1984       llvm::NamedMDNode *metadata =
1985         CGM.getModule().getOrInsertNamedMetadata(
1986                             "clang.arc.retainAutoreleasedReturnValueMarker");
1987       assert(metadata->getNumOperands() <= 1);
1988       if (metadata->getNumOperands() == 0) {
1989         metadata->addOperand(llvm::MDNode::get(
1990             getLLVMContext(), llvm::MDString::get(getLLVMContext(), assembly)));
1991       }
1992     }
1993   }
1994 
1995   // Call the marker asm if we made one, which we do only at -O0.
1996   if (marker)
1997     Builder.CreateCall(marker);
1998 
1999   return emitARCValueOperation(*this, value,
2000                      CGM.getARCEntrypoints().objc_retainAutoreleasedReturnValue,
2001                                "objc_retainAutoreleasedReturnValue");
2002 }
2003 
2004 /// Release the given object.
2005 ///   call void \@objc_release(i8* %value)
2006 void CodeGenFunction::EmitARCRelease(llvm::Value *value,
2007                                      ARCPreciseLifetime_t precise) {
2008   if (isa<llvm::ConstantPointerNull>(value)) return;
2009 
2010   llvm::Constant *&fn = CGM.getARCEntrypoints().objc_release;
2011   if (!fn) {
2012     llvm::FunctionType *fnType =
2013       llvm::FunctionType::get(Builder.getVoidTy(), Int8PtrTy, false);
2014     fn = createARCRuntimeFunction(CGM, fnType, "objc_release");
2015   }
2016 
2017   // Cast the argument to 'id'.
2018   value = Builder.CreateBitCast(value, Int8PtrTy);
2019 
2020   // Call objc_release.
2021   llvm::CallInst *call = EmitNounwindRuntimeCall(fn, value);
2022 
2023   if (precise == ARCImpreciseLifetime) {
2024     call->setMetadata("clang.imprecise_release",
2025                       llvm::MDNode::get(Builder.getContext(), None));
2026   }
2027 }
2028 
2029 /// Destroy a __strong variable.
2030 ///
2031 /// At -O0, emit a call to store 'null' into the address;
2032 /// instrumenting tools prefer this because the address is exposed,
2033 /// but it's relatively cumbersome to optimize.
2034 ///
2035 /// At -O1 and above, just load and call objc_release.
2036 ///
2037 ///   call void \@objc_storeStrong(i8** %addr, i8* null)
2038 void CodeGenFunction::EmitARCDestroyStrong(Address addr,
2039                                            ARCPreciseLifetime_t precise) {
2040   if (CGM.getCodeGenOpts().OptimizationLevel == 0) {
2041     llvm::Value *null = getNullForVariable(addr);
2042     EmitARCStoreStrongCall(addr, null, /*ignored*/ true);
2043     return;
2044   }
2045 
2046   llvm::Value *value = Builder.CreateLoad(addr);
2047   EmitARCRelease(value, precise);
2048 }
2049 
2050 /// Store into a strong object.  Always calls this:
2051 ///   call void \@objc_storeStrong(i8** %addr, i8* %value)
2052 llvm::Value *CodeGenFunction::EmitARCStoreStrongCall(Address addr,
2053                                                      llvm::Value *value,
2054                                                      bool ignored) {
2055   assert(addr.getElementType() == value->getType());
2056 
2057   llvm::Constant *&fn = CGM.getARCEntrypoints().objc_storeStrong;
2058   if (!fn) {
2059     llvm::Type *argTypes[] = { Int8PtrPtrTy, Int8PtrTy };
2060     llvm::FunctionType *fnType
2061       = llvm::FunctionType::get(Builder.getVoidTy(), argTypes, false);
2062     fn = createARCRuntimeFunction(CGM, fnType, "objc_storeStrong");
2063   }
2064 
2065   llvm::Value *args[] = {
2066     Builder.CreateBitCast(addr.getPointer(), Int8PtrPtrTy),
2067     Builder.CreateBitCast(value, Int8PtrTy)
2068   };
2069   EmitNounwindRuntimeCall(fn, args);
2070 
2071   if (ignored) return nullptr;
2072   return value;
2073 }
2074 
2075 /// Store into a strong object.  Sometimes calls this:
2076 ///   call void \@objc_storeStrong(i8** %addr, i8* %value)
2077 /// Other times, breaks it down into components.
2078 llvm::Value *CodeGenFunction::EmitARCStoreStrong(LValue dst,
2079                                                  llvm::Value *newValue,
2080                                                  bool ignored) {
2081   QualType type = dst.getType();
2082   bool isBlock = type->isBlockPointerType();
2083 
2084   // Use a store barrier at -O0 unless this is a block type or the
2085   // lvalue is inadequately aligned.
2086   if (shouldUseFusedARCCalls() &&
2087       !isBlock &&
2088       (dst.getAlignment().isZero() ||
2089        dst.getAlignment() >= CharUnits::fromQuantity(PointerAlignInBytes))) {
2090     return EmitARCStoreStrongCall(dst.getAddress(), newValue, ignored);
2091   }
2092 
2093   // Otherwise, split it out.
2094 
2095   // Retain the new value.
2096   newValue = EmitARCRetain(type, newValue);
2097 
2098   // Read the old value.
2099   llvm::Value *oldValue = EmitLoadOfScalar(dst, SourceLocation());
2100 
2101   // Store.  We do this before the release so that any deallocs won't
2102   // see the old value.
2103   EmitStoreOfScalar(newValue, dst);
2104 
2105   // Finally, release the old value.
2106   EmitARCRelease(oldValue, dst.isARCPreciseLifetime());
2107 
2108   return newValue;
2109 }
2110 
2111 /// Autorelease the given object.
2112 ///   call i8* \@objc_autorelease(i8* %value)
2113 llvm::Value *CodeGenFunction::EmitARCAutorelease(llvm::Value *value) {
2114   return emitARCValueOperation(*this, value,
2115                                CGM.getARCEntrypoints().objc_autorelease,
2116                                "objc_autorelease");
2117 }
2118 
2119 /// Autorelease the given object.
2120 ///   call i8* \@objc_autoreleaseReturnValue(i8* %value)
2121 llvm::Value *
2122 CodeGenFunction::EmitARCAutoreleaseReturnValue(llvm::Value *value) {
2123   return emitARCValueOperation(*this, value,
2124                             CGM.getARCEntrypoints().objc_autoreleaseReturnValue,
2125                                "objc_autoreleaseReturnValue",
2126                                /*isTailCall*/ true);
2127 }
2128 
2129 /// Do a fused retain/autorelease of the given object.
2130 ///   call i8* \@objc_retainAutoreleaseReturnValue(i8* %value)
2131 llvm::Value *
2132 CodeGenFunction::EmitARCRetainAutoreleaseReturnValue(llvm::Value *value) {
2133   return emitARCValueOperation(*this, value,
2134                      CGM.getARCEntrypoints().objc_retainAutoreleaseReturnValue,
2135                                "objc_retainAutoreleaseReturnValue",
2136                                /*isTailCall*/ true);
2137 }
2138 
2139 /// Do a fused retain/autorelease of the given object.
2140 ///   call i8* \@objc_retainAutorelease(i8* %value)
2141 /// or
2142 ///   %retain = call i8* \@objc_retainBlock(i8* %value)
2143 ///   call i8* \@objc_autorelease(i8* %retain)
2144 llvm::Value *CodeGenFunction::EmitARCRetainAutorelease(QualType type,
2145                                                        llvm::Value *value) {
2146   if (!type->isBlockPointerType())
2147     return EmitARCRetainAutoreleaseNonBlock(value);
2148 
2149   if (isa<llvm::ConstantPointerNull>(value)) return value;
2150 
2151   llvm::Type *origType = value->getType();
2152   value = Builder.CreateBitCast(value, Int8PtrTy);
2153   value = EmitARCRetainBlock(value, /*mandatory*/ true);
2154   value = EmitARCAutorelease(value);
2155   return Builder.CreateBitCast(value, origType);
2156 }
2157 
2158 /// Do a fused retain/autorelease of the given object.
2159 ///   call i8* \@objc_retainAutorelease(i8* %value)
2160 llvm::Value *
2161 CodeGenFunction::EmitARCRetainAutoreleaseNonBlock(llvm::Value *value) {
2162   return emitARCValueOperation(*this, value,
2163                                CGM.getARCEntrypoints().objc_retainAutorelease,
2164                                "objc_retainAutorelease");
2165 }
2166 
2167 /// i8* \@objc_loadWeakRetained(i8** %addr)
2168 llvm::Value *CodeGenFunction::EmitARCLoadWeakRetained(Address addr) {
2169   return emitARCLoadOperation(*this, addr,
2170                               CGM.getARCEntrypoints().objc_loadWeakRetained,
2171                               "objc_loadWeakRetained");
2172 }
2173 
2174 /// i8* \@objc_storeWeak(i8** %addr, i8* %value)
2175 /// Returns %value.
2176 llvm::Value *CodeGenFunction::EmitARCStoreWeak(Address addr,
2177                                                llvm::Value *value,
2178                                                bool ignored) {
2179   return emitARCStoreOperation(*this, addr, value,
2180                                CGM.getARCEntrypoints().objc_storeWeak,
2181                                "objc_storeWeak", ignored);
2182 }
2183 
2184 /// i8* \@objc_initWeak(i8** %addr, i8* %value)
2185 /// Returns %value.  %addr is known to not have a current weak entry.
2186 /// Essentially equivalent to:
2187 ///   *addr = nil; objc_storeWeak(addr, value);
2188 void CodeGenFunction::EmitARCInitWeak(Address addr, llvm::Value *value) {
2189   // If we're initializing to null, just write null to memory; no need
2190   // to get the runtime involved.  But don't do this if optimization
2191   // is enabled, because accounting for this would make the optimizer
2192   // much more complicated.
2193   if (isa<llvm::ConstantPointerNull>(value) &&
2194       CGM.getCodeGenOpts().OptimizationLevel == 0) {
2195     Builder.CreateStore(value, addr);
2196     return;
2197   }
2198 
2199   emitARCStoreOperation(*this, addr, value,
2200                         CGM.getARCEntrypoints().objc_initWeak,
2201                         "objc_initWeak", /*ignored*/ true);
2202 }
2203 
2204 /// void \@objc_destroyWeak(i8** %addr)
2205 /// Essentially objc_storeWeak(addr, nil).
2206 void CodeGenFunction::EmitARCDestroyWeak(Address addr) {
2207   llvm::Constant *&fn = CGM.getARCEntrypoints().objc_destroyWeak;
2208   if (!fn) {
2209     llvm::FunctionType *fnType =
2210       llvm::FunctionType::get(Builder.getVoidTy(), Int8PtrPtrTy, false);
2211     fn = createARCRuntimeFunction(CGM, fnType, "objc_destroyWeak");
2212   }
2213 
2214   // Cast the argument to 'id*'.
2215   addr = Builder.CreateBitCast(addr, Int8PtrPtrTy);
2216 
2217   EmitNounwindRuntimeCall(fn, addr.getPointer());
2218 }
2219 
2220 /// void \@objc_moveWeak(i8** %dest, i8** %src)
2221 /// Disregards the current value in %dest.  Leaves %src pointing to nothing.
2222 /// Essentially (objc_copyWeak(dest, src), objc_destroyWeak(src)).
2223 void CodeGenFunction::EmitARCMoveWeak(Address dst, Address src) {
2224   emitARCCopyOperation(*this, dst, src,
2225                        CGM.getARCEntrypoints().objc_moveWeak,
2226                        "objc_moveWeak");
2227 }
2228 
2229 /// void \@objc_copyWeak(i8** %dest, i8** %src)
2230 /// Disregards the current value in %dest.  Essentially
2231 ///   objc_release(objc_initWeak(dest, objc_readWeakRetained(src)))
2232 void CodeGenFunction::EmitARCCopyWeak(Address dst, Address src) {
2233   emitARCCopyOperation(*this, dst, src,
2234                        CGM.getARCEntrypoints().objc_copyWeak,
2235                        "objc_copyWeak");
2236 }
2237 
2238 /// Produce the code to do a objc_autoreleasepool_push.
2239 ///   call i8* \@objc_autoreleasePoolPush(void)
2240 llvm::Value *CodeGenFunction::EmitObjCAutoreleasePoolPush() {
2241   llvm::Constant *&fn = CGM.getRREntrypoints().objc_autoreleasePoolPush;
2242   if (!fn) {
2243     llvm::FunctionType *fnType =
2244       llvm::FunctionType::get(Int8PtrTy, false);
2245     fn = createARCRuntimeFunction(CGM, fnType, "objc_autoreleasePoolPush");
2246   }
2247 
2248   return EmitNounwindRuntimeCall(fn);
2249 }
2250 
2251 /// Produce the code to do a primitive release.
2252 ///   call void \@objc_autoreleasePoolPop(i8* %ptr)
2253 void CodeGenFunction::EmitObjCAutoreleasePoolPop(llvm::Value *value) {
2254   assert(value->getType() == Int8PtrTy);
2255 
2256   llvm::Constant *&fn = CGM.getRREntrypoints().objc_autoreleasePoolPop;
2257   if (!fn) {
2258     llvm::FunctionType *fnType =
2259       llvm::FunctionType::get(Builder.getVoidTy(), Int8PtrTy, false);
2260 
2261     // We don't want to use a weak import here; instead we should not
2262     // fall into this path.
2263     fn = createARCRuntimeFunction(CGM, fnType, "objc_autoreleasePoolPop");
2264   }
2265 
2266   // objc_autoreleasePoolPop can throw.
2267   EmitRuntimeCallOrInvoke(fn, value);
2268 }
2269 
2270 /// Produce the code to do an MRR version objc_autoreleasepool_push.
2271 /// Which is: [[NSAutoreleasePool alloc] init];
2272 /// Where alloc is declared as: + (id) alloc; in NSAutoreleasePool class.
2273 /// init is declared as: - (id) init; in its NSObject super class.
2274 ///
2275 llvm::Value *CodeGenFunction::EmitObjCMRRAutoreleasePoolPush() {
2276   CGObjCRuntime &Runtime = CGM.getObjCRuntime();
2277   llvm::Value *Receiver = Runtime.EmitNSAutoreleasePoolClassRef(*this);
2278   // [NSAutoreleasePool alloc]
2279   IdentifierInfo *II = &CGM.getContext().Idents.get("alloc");
2280   Selector AllocSel = getContext().Selectors.getSelector(0, &II);
2281   CallArgList Args;
2282   RValue AllocRV =
2283     Runtime.GenerateMessageSend(*this, ReturnValueSlot(),
2284                                 getContext().getObjCIdType(),
2285                                 AllocSel, Receiver, Args);
2286 
2287   // [Receiver init]
2288   Receiver = AllocRV.getScalarVal();
2289   II = &CGM.getContext().Idents.get("init");
2290   Selector InitSel = getContext().Selectors.getSelector(0, &II);
2291   RValue InitRV =
2292     Runtime.GenerateMessageSend(*this, ReturnValueSlot(),
2293                                 getContext().getObjCIdType(),
2294                                 InitSel, Receiver, Args);
2295   return InitRV.getScalarVal();
2296 }
2297 
2298 /// Produce the code to do a primitive release.
2299 /// [tmp drain];
2300 void CodeGenFunction::EmitObjCMRRAutoreleasePoolPop(llvm::Value *Arg) {
2301   IdentifierInfo *II = &CGM.getContext().Idents.get("drain");
2302   Selector DrainSel = getContext().Selectors.getSelector(0, &II);
2303   CallArgList Args;
2304   CGM.getObjCRuntime().GenerateMessageSend(*this, ReturnValueSlot(),
2305                               getContext().VoidTy, DrainSel, Arg, Args);
2306 }
2307 
2308 void CodeGenFunction::destroyARCStrongPrecise(CodeGenFunction &CGF,
2309                                               Address addr,
2310                                               QualType type) {
2311   CGF.EmitARCDestroyStrong(addr, ARCPreciseLifetime);
2312 }
2313 
2314 void CodeGenFunction::destroyARCStrongImprecise(CodeGenFunction &CGF,
2315                                                 Address addr,
2316                                                 QualType type) {
2317   CGF.EmitARCDestroyStrong(addr, ARCImpreciseLifetime);
2318 }
2319 
2320 void CodeGenFunction::destroyARCWeak(CodeGenFunction &CGF,
2321                                      Address addr,
2322                                      QualType type) {
2323   CGF.EmitARCDestroyWeak(addr);
2324 }
2325 
2326 namespace {
2327   struct CallObjCAutoreleasePoolObject final : EHScopeStack::Cleanup {
2328     llvm::Value *Token;
2329 
2330     CallObjCAutoreleasePoolObject(llvm::Value *token) : Token(token) {}
2331 
2332     void Emit(CodeGenFunction &CGF, Flags flags) override {
2333       CGF.EmitObjCAutoreleasePoolPop(Token);
2334     }
2335   };
2336   struct CallObjCMRRAutoreleasePoolObject final : EHScopeStack::Cleanup {
2337     llvm::Value *Token;
2338 
2339     CallObjCMRRAutoreleasePoolObject(llvm::Value *token) : Token(token) {}
2340 
2341     void Emit(CodeGenFunction &CGF, Flags flags) override {
2342       CGF.EmitObjCMRRAutoreleasePoolPop(Token);
2343     }
2344   };
2345 }
2346 
2347 void CodeGenFunction::EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr) {
2348   if (CGM.getLangOpts().ObjCAutoRefCount)
2349     EHStack.pushCleanup<CallObjCAutoreleasePoolObject>(NormalCleanup, Ptr);
2350   else
2351     EHStack.pushCleanup<CallObjCMRRAutoreleasePoolObject>(NormalCleanup, Ptr);
2352 }
2353 
2354 static TryEmitResult tryEmitARCRetainLoadOfScalar(CodeGenFunction &CGF,
2355                                                   LValue lvalue,
2356                                                   QualType type) {
2357   switch (type.getObjCLifetime()) {
2358   case Qualifiers::OCL_None:
2359   case Qualifiers::OCL_ExplicitNone:
2360   case Qualifiers::OCL_Strong:
2361   case Qualifiers::OCL_Autoreleasing:
2362     return TryEmitResult(CGF.EmitLoadOfLValue(lvalue,
2363                                               SourceLocation()).getScalarVal(),
2364                          false);
2365 
2366   case Qualifiers::OCL_Weak:
2367     return TryEmitResult(CGF.EmitARCLoadWeakRetained(lvalue.getAddress()),
2368                          true);
2369   }
2370 
2371   llvm_unreachable("impossible lifetime!");
2372 }
2373 
2374 static TryEmitResult tryEmitARCRetainLoadOfScalar(CodeGenFunction &CGF,
2375                                                   const Expr *e) {
2376   e = e->IgnoreParens();
2377   QualType type = e->getType();
2378 
2379   // If we're loading retained from a __strong xvalue, we can avoid
2380   // an extra retain/release pair by zeroing out the source of this
2381   // "move" operation.
2382   if (e->isXValue() &&
2383       !type.isConstQualified() &&
2384       type.getObjCLifetime() == Qualifiers::OCL_Strong) {
2385     // Emit the lvalue.
2386     LValue lv = CGF.EmitLValue(e);
2387 
2388     // Load the object pointer.
2389     llvm::Value *result = CGF.EmitLoadOfLValue(lv,
2390                                                SourceLocation()).getScalarVal();
2391 
2392     // Set the source pointer to NULL.
2393     CGF.EmitStoreOfScalar(getNullForVariable(lv.getAddress()), lv);
2394 
2395     return TryEmitResult(result, true);
2396   }
2397 
2398   // As a very special optimization, in ARC++, if the l-value is the
2399   // result of a non-volatile assignment, do a simple retain of the
2400   // result of the call to objc_storeWeak instead of reloading.
2401   if (CGF.getLangOpts().CPlusPlus &&
2402       !type.isVolatileQualified() &&
2403       type.getObjCLifetime() == Qualifiers::OCL_Weak &&
2404       isa<BinaryOperator>(e) &&
2405       cast<BinaryOperator>(e)->getOpcode() == BO_Assign)
2406     return TryEmitResult(CGF.EmitScalarExpr(e), false);
2407 
2408   return tryEmitARCRetainLoadOfScalar(CGF, CGF.EmitLValue(e), type);
2409 }
2410 
2411 static llvm::Value *emitARCRetainAfterCall(CodeGenFunction &CGF,
2412                                            llvm::Value *value);
2413 
2414 /// Given that the given expression is some sort of call (which does
2415 /// not return retained), emit a retain following it.
2416 static llvm::Value *emitARCRetainCall(CodeGenFunction &CGF, const Expr *e) {
2417   llvm::Value *value = CGF.EmitScalarExpr(e);
2418   return emitARCRetainAfterCall(CGF, value);
2419 }
2420 
2421 static llvm::Value *emitARCRetainAfterCall(CodeGenFunction &CGF,
2422                                            llvm::Value *value) {
2423   if (llvm::CallInst *call = dyn_cast<llvm::CallInst>(value)) {
2424     CGBuilderTy::InsertPoint ip = CGF.Builder.saveIP();
2425 
2426     // Place the retain immediately following the call.
2427     CGF.Builder.SetInsertPoint(call->getParent(),
2428                                ++llvm::BasicBlock::iterator(call));
2429     value = CGF.EmitARCRetainAutoreleasedReturnValue(value);
2430 
2431     CGF.Builder.restoreIP(ip);
2432     return value;
2433   } else if (llvm::InvokeInst *invoke = dyn_cast<llvm::InvokeInst>(value)) {
2434     CGBuilderTy::InsertPoint ip = CGF.Builder.saveIP();
2435 
2436     // Place the retain at the beginning of the normal destination block.
2437     llvm::BasicBlock *BB = invoke->getNormalDest();
2438     CGF.Builder.SetInsertPoint(BB, BB->begin());
2439     value = CGF.EmitARCRetainAutoreleasedReturnValue(value);
2440 
2441     CGF.Builder.restoreIP(ip);
2442     return value;
2443 
2444   // Bitcasts can arise because of related-result returns.  Rewrite
2445   // the operand.
2446   } else if (llvm::BitCastInst *bitcast = dyn_cast<llvm::BitCastInst>(value)) {
2447     llvm::Value *operand = bitcast->getOperand(0);
2448     operand = emitARCRetainAfterCall(CGF, operand);
2449     bitcast->setOperand(0, operand);
2450     return bitcast;
2451 
2452   // Generic fall-back case.
2453   } else {
2454     // Retain using the non-block variant: we never need to do a copy
2455     // of a block that's been returned to us.
2456     return CGF.EmitARCRetainNonBlock(value);
2457   }
2458 }
2459 
2460 /// Determine whether it might be important to emit a separate
2461 /// objc_retain_block on the result of the given expression, or
2462 /// whether it's okay to just emit it in a +1 context.
2463 static bool shouldEmitSeparateBlockRetain(const Expr *e) {
2464   assert(e->getType()->isBlockPointerType());
2465   e = e->IgnoreParens();
2466 
2467   // For future goodness, emit block expressions directly in +1
2468   // contexts if we can.
2469   if (isa<BlockExpr>(e))
2470     return false;
2471 
2472   if (const CastExpr *cast = dyn_cast<CastExpr>(e)) {
2473     switch (cast->getCastKind()) {
2474     // Emitting these operations in +1 contexts is goodness.
2475     case CK_LValueToRValue:
2476     case CK_ARCReclaimReturnedObject:
2477     case CK_ARCConsumeObject:
2478     case CK_ARCProduceObject:
2479       return false;
2480 
2481     // These operations preserve a block type.
2482     case CK_NoOp:
2483     case CK_BitCast:
2484       return shouldEmitSeparateBlockRetain(cast->getSubExpr());
2485 
2486     // These operations are known to be bad (or haven't been considered).
2487     case CK_AnyPointerToBlockPointerCast:
2488     default:
2489       return true;
2490     }
2491   }
2492 
2493   return true;
2494 }
2495 
2496 /// Try to emit a PseudoObjectExpr at +1.
2497 ///
2498 /// This massively duplicates emitPseudoObjectRValue.
2499 static TryEmitResult tryEmitARCRetainPseudoObject(CodeGenFunction &CGF,
2500                                                   const PseudoObjectExpr *E) {
2501   SmallVector<CodeGenFunction::OpaqueValueMappingData, 4> opaques;
2502 
2503   // Find the result expression.
2504   const Expr *resultExpr = E->getResultExpr();
2505   assert(resultExpr);
2506   TryEmitResult result;
2507 
2508   for (PseudoObjectExpr::const_semantics_iterator
2509          i = E->semantics_begin(), e = E->semantics_end(); i != e; ++i) {
2510     const Expr *semantic = *i;
2511 
2512     // If this semantic expression is an opaque value, bind it
2513     // to the result of its source expression.
2514     if (const OpaqueValueExpr *ov = dyn_cast<OpaqueValueExpr>(semantic)) {
2515       typedef CodeGenFunction::OpaqueValueMappingData OVMA;
2516       OVMA opaqueData;
2517 
2518       // If this semantic is the result of the pseudo-object
2519       // expression, try to evaluate the source as +1.
2520       if (ov == resultExpr) {
2521         assert(!OVMA::shouldBindAsLValue(ov));
2522         result = tryEmitARCRetainScalarExpr(CGF, ov->getSourceExpr());
2523         opaqueData = OVMA::bind(CGF, ov, RValue::get(result.getPointer()));
2524 
2525       // Otherwise, just bind it.
2526       } else {
2527         opaqueData = OVMA::bind(CGF, ov, ov->getSourceExpr());
2528       }
2529       opaques.push_back(opaqueData);
2530 
2531     // Otherwise, if the expression is the result, evaluate it
2532     // and remember the result.
2533     } else if (semantic == resultExpr) {
2534       result = tryEmitARCRetainScalarExpr(CGF, semantic);
2535 
2536     // Otherwise, evaluate the expression in an ignored context.
2537     } else {
2538       CGF.EmitIgnoredExpr(semantic);
2539     }
2540   }
2541 
2542   // Unbind all the opaques now.
2543   for (unsigned i = 0, e = opaques.size(); i != e; ++i)
2544     opaques[i].unbind(CGF);
2545 
2546   return result;
2547 }
2548 
2549 static TryEmitResult
2550 tryEmitARCRetainScalarExpr(CodeGenFunction &CGF, const Expr *e) {
2551   // We should *never* see a nested full-expression here, because if
2552   // we fail to emit at +1, our caller must not retain after we close
2553   // out the full-expression.
2554   assert(!isa<ExprWithCleanups>(e));
2555 
2556   // The desired result type, if it differs from the type of the
2557   // ultimate opaque expression.
2558   llvm::Type *resultType = nullptr;
2559 
2560   while (true) {
2561     e = e->IgnoreParens();
2562 
2563     // There's a break at the end of this if-chain;  anything
2564     // that wants to keep looping has to explicitly continue.
2565     if (const CastExpr *ce = dyn_cast<CastExpr>(e)) {
2566       switch (ce->getCastKind()) {
2567       // No-op casts don't change the type, so we just ignore them.
2568       case CK_NoOp:
2569         e = ce->getSubExpr();
2570         continue;
2571 
2572       case CK_LValueToRValue: {
2573         TryEmitResult loadResult
2574           = tryEmitARCRetainLoadOfScalar(CGF, ce->getSubExpr());
2575         if (resultType) {
2576           llvm::Value *value = loadResult.getPointer();
2577           value = CGF.Builder.CreateBitCast(value, resultType);
2578           loadResult.setPointer(value);
2579         }
2580         return loadResult;
2581       }
2582 
2583       // These casts can change the type, so remember that and
2584       // soldier on.  We only need to remember the outermost such
2585       // cast, though.
2586       case CK_CPointerToObjCPointerCast:
2587       case CK_BlockPointerToObjCPointerCast:
2588       case CK_AnyPointerToBlockPointerCast:
2589       case CK_BitCast:
2590         if (!resultType)
2591           resultType = CGF.ConvertType(ce->getType());
2592         e = ce->getSubExpr();
2593         assert(e->getType()->hasPointerRepresentation());
2594         continue;
2595 
2596       // For consumptions, just emit the subexpression and thus elide
2597       // the retain/release pair.
2598       case CK_ARCConsumeObject: {
2599         llvm::Value *result = CGF.EmitScalarExpr(ce->getSubExpr());
2600         if (resultType) result = CGF.Builder.CreateBitCast(result, resultType);
2601         return TryEmitResult(result, true);
2602       }
2603 
2604       // Block extends are net +0.  Naively, we could just recurse on
2605       // the subexpression, but actually we need to ensure that the
2606       // value is copied as a block, so there's a little filter here.
2607       case CK_ARCExtendBlockObject: {
2608         llvm::Value *result; // will be a +0 value
2609 
2610         // If we can't safely assume the sub-expression will produce a
2611         // block-copied value, emit the sub-expression at +0.
2612         if (shouldEmitSeparateBlockRetain(ce->getSubExpr())) {
2613           result = CGF.EmitScalarExpr(ce->getSubExpr());
2614 
2615         // Otherwise, try to emit the sub-expression at +1 recursively.
2616         } else {
2617           TryEmitResult subresult
2618             = tryEmitARCRetainScalarExpr(CGF, ce->getSubExpr());
2619           result = subresult.getPointer();
2620 
2621           // If that produced a retained value, just use that,
2622           // possibly casting down.
2623           if (subresult.getInt()) {
2624             if (resultType)
2625               result = CGF.Builder.CreateBitCast(result, resultType);
2626             return TryEmitResult(result, true);
2627           }
2628 
2629           // Otherwise it's +0.
2630         }
2631 
2632         // Retain the object as a block, then cast down.
2633         result = CGF.EmitARCRetainBlock(result, /*mandatory*/ true);
2634         if (resultType) result = CGF.Builder.CreateBitCast(result, resultType);
2635         return TryEmitResult(result, true);
2636       }
2637 
2638       // For reclaims, emit the subexpression as a retained call and
2639       // skip the consumption.
2640       case CK_ARCReclaimReturnedObject: {
2641         llvm::Value *result = emitARCRetainCall(CGF, ce->getSubExpr());
2642         if (resultType) result = CGF.Builder.CreateBitCast(result, resultType);
2643         return TryEmitResult(result, true);
2644       }
2645 
2646       default:
2647         break;
2648       }
2649 
2650     // Skip __extension__.
2651     } else if (const UnaryOperator *op = dyn_cast<UnaryOperator>(e)) {
2652       if (op->getOpcode() == UO_Extension) {
2653         e = op->getSubExpr();
2654         continue;
2655       }
2656 
2657     // For calls and message sends, use the retained-call logic.
2658     // Delegate inits are a special case in that they're the only
2659     // returns-retained expression that *isn't* surrounded by
2660     // a consume.
2661     } else if (isa<CallExpr>(e) ||
2662                (isa<ObjCMessageExpr>(e) &&
2663                 !cast<ObjCMessageExpr>(e)->isDelegateInitCall())) {
2664       llvm::Value *result = emitARCRetainCall(CGF, e);
2665       if (resultType) result = CGF.Builder.CreateBitCast(result, resultType);
2666       return TryEmitResult(result, true);
2667 
2668     // Look through pseudo-object expressions.
2669     } else if (const PseudoObjectExpr *pseudo = dyn_cast<PseudoObjectExpr>(e)) {
2670       TryEmitResult result
2671         = tryEmitARCRetainPseudoObject(CGF, pseudo);
2672       if (resultType) {
2673         llvm::Value *value = result.getPointer();
2674         value = CGF.Builder.CreateBitCast(value, resultType);
2675         result.setPointer(value);
2676       }
2677       return result;
2678     }
2679 
2680     // Conservatively halt the search at any other expression kind.
2681     break;
2682   }
2683 
2684   // We didn't find an obvious production, so emit what we've got and
2685   // tell the caller that we didn't manage to retain.
2686   llvm::Value *result = CGF.EmitScalarExpr(e);
2687   if (resultType) result = CGF.Builder.CreateBitCast(result, resultType);
2688   return TryEmitResult(result, false);
2689 }
2690 
2691 static llvm::Value *emitARCRetainLoadOfScalar(CodeGenFunction &CGF,
2692                                                 LValue lvalue,
2693                                                 QualType type) {
2694   TryEmitResult result = tryEmitARCRetainLoadOfScalar(CGF, lvalue, type);
2695   llvm::Value *value = result.getPointer();
2696   if (!result.getInt())
2697     value = CGF.EmitARCRetain(type, value);
2698   return value;
2699 }
2700 
2701 /// EmitARCRetainScalarExpr - Semantically equivalent to
2702 /// EmitARCRetainObject(e->getType(), EmitScalarExpr(e)), but making a
2703 /// best-effort attempt to peephole expressions that naturally produce
2704 /// retained objects.
2705 llvm::Value *CodeGenFunction::EmitARCRetainScalarExpr(const Expr *e) {
2706   // The retain needs to happen within the full-expression.
2707   if (const ExprWithCleanups *cleanups = dyn_cast<ExprWithCleanups>(e)) {
2708     enterFullExpression(cleanups);
2709     RunCleanupsScope scope(*this);
2710     return EmitARCRetainScalarExpr(cleanups->getSubExpr());
2711   }
2712 
2713   TryEmitResult result = tryEmitARCRetainScalarExpr(*this, e);
2714   llvm::Value *value = result.getPointer();
2715   if (!result.getInt())
2716     value = EmitARCRetain(e->getType(), value);
2717   return value;
2718 }
2719 
2720 llvm::Value *
2721 CodeGenFunction::EmitARCRetainAutoreleaseScalarExpr(const Expr *e) {
2722   // The retain needs to happen within the full-expression.
2723   if (const ExprWithCleanups *cleanups = dyn_cast<ExprWithCleanups>(e)) {
2724     enterFullExpression(cleanups);
2725     RunCleanupsScope scope(*this);
2726     return EmitARCRetainAutoreleaseScalarExpr(cleanups->getSubExpr());
2727   }
2728 
2729   TryEmitResult result = tryEmitARCRetainScalarExpr(*this, e);
2730   llvm::Value *value = result.getPointer();
2731   if (result.getInt())
2732     value = EmitARCAutorelease(value);
2733   else
2734     value = EmitARCRetainAutorelease(e->getType(), value);
2735   return value;
2736 }
2737 
2738 llvm::Value *CodeGenFunction::EmitARCExtendBlockObject(const Expr *e) {
2739   llvm::Value *result;
2740   bool doRetain;
2741 
2742   if (shouldEmitSeparateBlockRetain(e)) {
2743     result = EmitScalarExpr(e);
2744     doRetain = true;
2745   } else {
2746     TryEmitResult subresult = tryEmitARCRetainScalarExpr(*this, e);
2747     result = subresult.getPointer();
2748     doRetain = !subresult.getInt();
2749   }
2750 
2751   if (doRetain)
2752     result = EmitARCRetainBlock(result, /*mandatory*/ true);
2753   return EmitObjCConsumeObject(e->getType(), result);
2754 }
2755 
2756 llvm::Value *CodeGenFunction::EmitObjCThrowOperand(const Expr *expr) {
2757   // In ARC, retain and autorelease the expression.
2758   if (getLangOpts().ObjCAutoRefCount) {
2759     // Do so before running any cleanups for the full-expression.
2760     // EmitARCRetainAutoreleaseScalarExpr does this for us.
2761     return EmitARCRetainAutoreleaseScalarExpr(expr);
2762   }
2763 
2764   // Otherwise, use the normal scalar-expression emission.  The
2765   // exception machinery doesn't do anything special with the
2766   // exception like retaining it, so there's no safety associated with
2767   // only running cleanups after the throw has started, and when it
2768   // matters it tends to be substantially inferior code.
2769   return EmitScalarExpr(expr);
2770 }
2771 
2772 std::pair<LValue,llvm::Value*>
2773 CodeGenFunction::EmitARCStoreStrong(const BinaryOperator *e,
2774                                     bool ignored) {
2775   // Evaluate the RHS first.
2776   TryEmitResult result = tryEmitARCRetainScalarExpr(*this, e->getRHS());
2777   llvm::Value *value = result.getPointer();
2778 
2779   bool hasImmediateRetain = result.getInt();
2780 
2781   // If we didn't emit a retained object, and the l-value is of block
2782   // type, then we need to emit the block-retain immediately in case
2783   // it invalidates the l-value.
2784   if (!hasImmediateRetain && e->getType()->isBlockPointerType()) {
2785     value = EmitARCRetainBlock(value, /*mandatory*/ false);
2786     hasImmediateRetain = true;
2787   }
2788 
2789   LValue lvalue = EmitLValue(e->getLHS());
2790 
2791   // If the RHS was emitted retained, expand this.
2792   if (hasImmediateRetain) {
2793     llvm::Value *oldValue = EmitLoadOfScalar(lvalue, SourceLocation());
2794     EmitStoreOfScalar(value, lvalue);
2795     EmitARCRelease(oldValue, lvalue.isARCPreciseLifetime());
2796   } else {
2797     value = EmitARCStoreStrong(lvalue, value, ignored);
2798   }
2799 
2800   return std::pair<LValue,llvm::Value*>(lvalue, value);
2801 }
2802 
2803 std::pair<LValue,llvm::Value*>
2804 CodeGenFunction::EmitARCStoreAutoreleasing(const BinaryOperator *e) {
2805   llvm::Value *value = EmitARCRetainAutoreleaseScalarExpr(e->getRHS());
2806   LValue lvalue = EmitLValue(e->getLHS());
2807 
2808   EmitStoreOfScalar(value, lvalue);
2809 
2810   return std::pair<LValue,llvm::Value*>(lvalue, value);
2811 }
2812 
2813 void CodeGenFunction::EmitObjCAutoreleasePoolStmt(
2814                                           const ObjCAutoreleasePoolStmt &ARPS) {
2815   const Stmt *subStmt = ARPS.getSubStmt();
2816   const CompoundStmt &S = cast<CompoundStmt>(*subStmt);
2817 
2818   CGDebugInfo *DI = getDebugInfo();
2819   if (DI)
2820     DI->EmitLexicalBlockStart(Builder, S.getLBracLoc());
2821 
2822   // Keep track of the current cleanup stack depth.
2823   RunCleanupsScope Scope(*this);
2824   if (CGM.getLangOpts().ObjCRuntime.hasNativeARC()) {
2825     llvm::Value *token = EmitObjCAutoreleasePoolPush();
2826     EHStack.pushCleanup<CallObjCAutoreleasePoolObject>(NormalCleanup, token);
2827   } else {
2828     llvm::Value *token = EmitObjCMRRAutoreleasePoolPush();
2829     EHStack.pushCleanup<CallObjCMRRAutoreleasePoolObject>(NormalCleanup, token);
2830   }
2831 
2832   for (const auto *I : S.body())
2833     EmitStmt(I);
2834 
2835   if (DI)
2836     DI->EmitLexicalBlockEnd(Builder, S.getRBracLoc());
2837 }
2838 
2839 /// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
2840 /// make sure it survives garbage collection until this point.
2841 void CodeGenFunction::EmitExtendGCLifetime(llvm::Value *object) {
2842   // We just use an inline assembly.
2843   llvm::FunctionType *extenderType
2844     = llvm::FunctionType::get(VoidTy, VoidPtrTy, RequiredArgs::All);
2845   llvm::Value *extender
2846     = llvm::InlineAsm::get(extenderType,
2847                            /* assembly */ "",
2848                            /* constraints */ "r",
2849                            /* side effects */ true);
2850 
2851   object = Builder.CreateBitCast(object, VoidPtrTy);
2852   EmitNounwindRuntimeCall(extender, object);
2853 }
2854 
2855 /// GenerateObjCAtomicSetterCopyHelperFunction - Given a c++ object type with
2856 /// non-trivial copy assignment function, produce following helper function.
2857 /// static void copyHelper(Ty *dest, const Ty *source) { *dest = *source; }
2858 ///
2859 llvm::Constant *
2860 CodeGenFunction::GenerateObjCAtomicSetterCopyHelperFunction(
2861                                         const ObjCPropertyImplDecl *PID) {
2862   if (!getLangOpts().CPlusPlus ||
2863       !getLangOpts().ObjCRuntime.hasAtomicCopyHelper())
2864     return nullptr;
2865   QualType Ty = PID->getPropertyIvarDecl()->getType();
2866   if (!Ty->isRecordType())
2867     return nullptr;
2868   const ObjCPropertyDecl *PD = PID->getPropertyDecl();
2869   if ((!(PD->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_atomic)))
2870     return nullptr;
2871   llvm::Constant *HelperFn = nullptr;
2872   if (hasTrivialSetExpr(PID))
2873     return nullptr;
2874   assert(PID->getSetterCXXAssignment() && "SetterCXXAssignment - null");
2875   if ((HelperFn = CGM.getAtomicSetterHelperFnMap(Ty)))
2876     return HelperFn;
2877 
2878   ASTContext &C = getContext();
2879   IdentifierInfo *II
2880     = &CGM.getContext().Idents.get("__assign_helper_atomic_property_");
2881   FunctionDecl *FD = FunctionDecl::Create(C,
2882                                           C.getTranslationUnitDecl(),
2883                                           SourceLocation(),
2884                                           SourceLocation(), II, C.VoidTy,
2885                                           nullptr, SC_Static,
2886                                           false,
2887                                           false);
2888 
2889   QualType DestTy = C.getPointerType(Ty);
2890   QualType SrcTy = Ty;
2891   SrcTy.addConst();
2892   SrcTy = C.getPointerType(SrcTy);
2893 
2894   FunctionArgList args;
2895   ImplicitParamDecl dstDecl(getContext(), FD, SourceLocation(), nullptr,DestTy);
2896   args.push_back(&dstDecl);
2897   ImplicitParamDecl srcDecl(getContext(), FD, SourceLocation(), nullptr, SrcTy);
2898   args.push_back(&srcDecl);
2899 
2900   const CGFunctionInfo &FI = CGM.getTypes().arrangeFreeFunctionDeclaration(
2901       C.VoidTy, args, FunctionType::ExtInfo(), RequiredArgs::All);
2902 
2903   llvm::FunctionType *LTy = CGM.getTypes().GetFunctionType(FI);
2904 
2905   llvm::Function *Fn =
2906     llvm::Function::Create(LTy, llvm::GlobalValue::InternalLinkage,
2907                            "__assign_helper_atomic_property_",
2908                            &CGM.getModule());
2909 
2910   StartFunction(FD, C.VoidTy, Fn, FI, args);
2911 
2912   DeclRefExpr DstExpr(&dstDecl, false, DestTy,
2913                       VK_RValue, SourceLocation());
2914   UnaryOperator DST(&DstExpr, UO_Deref, DestTy->getPointeeType(),
2915                     VK_LValue, OK_Ordinary, SourceLocation());
2916 
2917   DeclRefExpr SrcExpr(&srcDecl, false, SrcTy,
2918                       VK_RValue, SourceLocation());
2919   UnaryOperator SRC(&SrcExpr, UO_Deref, SrcTy->getPointeeType(),
2920                     VK_LValue, OK_Ordinary, SourceLocation());
2921 
2922   Expr *Args[2] = { &DST, &SRC };
2923   CallExpr *CalleeExp = cast<CallExpr>(PID->getSetterCXXAssignment());
2924   CXXOperatorCallExpr TheCall(C, OO_Equal, CalleeExp->getCallee(),
2925                               Args, DestTy->getPointeeType(),
2926                               VK_LValue, SourceLocation(), false);
2927 
2928   EmitStmt(&TheCall);
2929 
2930   FinishFunction();
2931   HelperFn = llvm::ConstantExpr::getBitCast(Fn, VoidPtrTy);
2932   CGM.setAtomicSetterHelperFnMap(Ty, HelperFn);
2933   return HelperFn;
2934 }
2935 
2936 llvm::Constant *
2937 CodeGenFunction::GenerateObjCAtomicGetterCopyHelperFunction(
2938                                             const ObjCPropertyImplDecl *PID) {
2939   if (!getLangOpts().CPlusPlus ||
2940       !getLangOpts().ObjCRuntime.hasAtomicCopyHelper())
2941     return nullptr;
2942   const ObjCPropertyDecl *PD = PID->getPropertyDecl();
2943   QualType Ty = PD->getType();
2944   if (!Ty->isRecordType())
2945     return nullptr;
2946   if ((!(PD->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_atomic)))
2947     return nullptr;
2948   llvm::Constant *HelperFn = nullptr;
2949 
2950   if (hasTrivialGetExpr(PID))
2951     return nullptr;
2952   assert(PID->getGetterCXXConstructor() && "getGetterCXXConstructor - null");
2953   if ((HelperFn = CGM.getAtomicGetterHelperFnMap(Ty)))
2954     return HelperFn;
2955 
2956 
2957   ASTContext &C = getContext();
2958   IdentifierInfo *II
2959   = &CGM.getContext().Idents.get("__copy_helper_atomic_property_");
2960   FunctionDecl *FD = FunctionDecl::Create(C,
2961                                           C.getTranslationUnitDecl(),
2962                                           SourceLocation(),
2963                                           SourceLocation(), II, C.VoidTy,
2964                                           nullptr, SC_Static,
2965                                           false,
2966                                           false);
2967 
2968   QualType DestTy = C.getPointerType(Ty);
2969   QualType SrcTy = Ty;
2970   SrcTy.addConst();
2971   SrcTy = C.getPointerType(SrcTy);
2972 
2973   FunctionArgList args;
2974   ImplicitParamDecl dstDecl(getContext(), FD, SourceLocation(), nullptr,DestTy);
2975   args.push_back(&dstDecl);
2976   ImplicitParamDecl srcDecl(getContext(), FD, SourceLocation(), nullptr, SrcTy);
2977   args.push_back(&srcDecl);
2978 
2979   const CGFunctionInfo &FI = CGM.getTypes().arrangeFreeFunctionDeclaration(
2980       C.VoidTy, args, FunctionType::ExtInfo(), RequiredArgs::All);
2981 
2982   llvm::FunctionType *LTy = CGM.getTypes().GetFunctionType(FI);
2983 
2984   llvm::Function *Fn =
2985   llvm::Function::Create(LTy, llvm::GlobalValue::InternalLinkage,
2986                          "__copy_helper_atomic_property_", &CGM.getModule());
2987 
2988   StartFunction(FD, C.VoidTy, Fn, FI, args);
2989 
2990   DeclRefExpr SrcExpr(&srcDecl, false, SrcTy,
2991                       VK_RValue, SourceLocation());
2992 
2993   UnaryOperator SRC(&SrcExpr, UO_Deref, SrcTy->getPointeeType(),
2994                     VK_LValue, OK_Ordinary, SourceLocation());
2995 
2996   CXXConstructExpr *CXXConstExpr =
2997     cast<CXXConstructExpr>(PID->getGetterCXXConstructor());
2998 
2999   SmallVector<Expr*, 4> ConstructorArgs;
3000   ConstructorArgs.push_back(&SRC);
3001   ConstructorArgs.append(std::next(CXXConstExpr->arg_begin()),
3002                          CXXConstExpr->arg_end());
3003 
3004   CXXConstructExpr *TheCXXConstructExpr =
3005     CXXConstructExpr::Create(C, Ty, SourceLocation(),
3006                              CXXConstExpr->getConstructor(),
3007                              CXXConstExpr->isElidable(),
3008                              ConstructorArgs,
3009                              CXXConstExpr->hadMultipleCandidates(),
3010                              CXXConstExpr->isListInitialization(),
3011                              CXXConstExpr->isStdInitListInitialization(),
3012                              CXXConstExpr->requiresZeroInitialization(),
3013                              CXXConstExpr->getConstructionKind(),
3014                              SourceRange());
3015 
3016   DeclRefExpr DstExpr(&dstDecl, false, DestTy,
3017                       VK_RValue, SourceLocation());
3018 
3019   RValue DV = EmitAnyExpr(&DstExpr);
3020   CharUnits Alignment
3021     = getContext().getTypeAlignInChars(TheCXXConstructExpr->getType());
3022   EmitAggExpr(TheCXXConstructExpr,
3023               AggValueSlot::forAddr(Address(DV.getScalarVal(), Alignment),
3024                                     Qualifiers(),
3025                                     AggValueSlot::IsDestructed,
3026                                     AggValueSlot::DoesNotNeedGCBarriers,
3027                                     AggValueSlot::IsNotAliased));
3028 
3029   FinishFunction();
3030   HelperFn = llvm::ConstantExpr::getBitCast(Fn, VoidPtrTy);
3031   CGM.setAtomicGetterHelperFnMap(Ty, HelperFn);
3032   return HelperFn;
3033 }
3034 
3035 llvm::Value *
3036 CodeGenFunction::EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty) {
3037   // Get selectors for retain/autorelease.
3038   IdentifierInfo *CopyID = &getContext().Idents.get("copy");
3039   Selector CopySelector =
3040       getContext().Selectors.getNullarySelector(CopyID);
3041   IdentifierInfo *AutoreleaseID = &getContext().Idents.get("autorelease");
3042   Selector AutoreleaseSelector =
3043       getContext().Selectors.getNullarySelector(AutoreleaseID);
3044 
3045   // Emit calls to retain/autorelease.
3046   CGObjCRuntime &Runtime = CGM.getObjCRuntime();
3047   llvm::Value *Val = Block;
3048   RValue Result;
3049   Result = Runtime.GenerateMessageSend(*this, ReturnValueSlot(),
3050                                        Ty, CopySelector,
3051                                        Val, CallArgList(), nullptr, nullptr);
3052   Val = Result.getScalarVal();
3053   Result = Runtime.GenerateMessageSend(*this, ReturnValueSlot(),
3054                                        Ty, AutoreleaseSelector,
3055                                        Val, CallArgList(), nullptr, nullptr);
3056   Val = Result.getScalarVal();
3057   return Val;
3058 }
3059 
3060 
3061 CGObjCRuntime::~CGObjCRuntime() {}
3062