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