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