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