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