1 //===--- CGCall.cpp - Encapsulate calling convention details --------------===// 2 // 3 // The LLVM Compiler Infrastructure 4 // 5 // This file is distributed under the University of Illinois Open Source 6 // License. See LICENSE.TXT for details. 7 // 8 //===----------------------------------------------------------------------===// 9 // 10 // These classes wrap the information about a call or function 11 // definition used to handle ABI compliancy. 12 // 13 //===----------------------------------------------------------------------===// 14 15 #include "CGCall.h" 16 #include "ABIInfo.h" 17 #include "CGCXXABI.h" 18 #include "CodeGenFunction.h" 19 #include "CodeGenModule.h" 20 #include "TargetInfo.h" 21 #include "clang/AST/Decl.h" 22 #include "clang/AST/DeclCXX.h" 23 #include "clang/AST/DeclObjC.h" 24 #include "clang/Basic/TargetInfo.h" 25 #include "clang/CodeGen/CGFunctionInfo.h" 26 #include "clang/Frontend/CodeGenOptions.h" 27 #include "llvm/ADT/StringExtras.h" 28 #include "llvm/IR/Attributes.h" 29 #include "llvm/IR/CallSite.h" 30 #include "llvm/IR/DataLayout.h" 31 #include "llvm/IR/InlineAsm.h" 32 #include "llvm/IR/Intrinsics.h" 33 #include "llvm/Transforms/Utils/Local.h" 34 using namespace clang; 35 using namespace CodeGen; 36 37 /***/ 38 39 static unsigned ClangCallConvToLLVMCallConv(CallingConv CC) { 40 switch (CC) { 41 default: return llvm::CallingConv::C; 42 case CC_X86StdCall: return llvm::CallingConv::X86_StdCall; 43 case CC_X86FastCall: return llvm::CallingConv::X86_FastCall; 44 case CC_X86ThisCall: return llvm::CallingConv::X86_ThisCall; 45 case CC_X86_64Win64: return llvm::CallingConv::X86_64_Win64; 46 case CC_X86_64SysV: return llvm::CallingConv::X86_64_SysV; 47 case CC_AAPCS: return llvm::CallingConv::ARM_AAPCS; 48 case CC_AAPCS_VFP: return llvm::CallingConv::ARM_AAPCS_VFP; 49 case CC_IntelOclBicc: return llvm::CallingConv::Intel_OCL_BI; 50 // TODO: Add support for __pascal to LLVM. 51 case CC_X86Pascal: return llvm::CallingConv::C; 52 // TODO: Add support for __vectorcall to LLVM. 53 case CC_X86VectorCall: return llvm::CallingConv::X86_VectorCall; 54 } 55 } 56 57 /// Derives the 'this' type for codegen purposes, i.e. ignoring method 58 /// qualification. 59 /// FIXME: address space qualification? 60 static CanQualType GetThisType(ASTContext &Context, const CXXRecordDecl *RD) { 61 QualType RecTy = Context.getTagDeclType(RD)->getCanonicalTypeInternal(); 62 return Context.getPointerType(CanQualType::CreateUnsafe(RecTy)); 63 } 64 65 /// Returns the canonical formal type of the given C++ method. 66 static CanQual<FunctionProtoType> GetFormalType(const CXXMethodDecl *MD) { 67 return MD->getType()->getCanonicalTypeUnqualified() 68 .getAs<FunctionProtoType>(); 69 } 70 71 /// Returns the "extra-canonicalized" return type, which discards 72 /// qualifiers on the return type. Codegen doesn't care about them, 73 /// and it makes ABI code a little easier to be able to assume that 74 /// all parameter and return types are top-level unqualified. 75 static CanQualType GetReturnType(QualType RetTy) { 76 return RetTy->getCanonicalTypeUnqualified().getUnqualifiedType(); 77 } 78 79 /// Arrange the argument and result information for a value of the given 80 /// unprototyped freestanding function type. 81 const CGFunctionInfo & 82 CodeGenTypes::arrangeFreeFunctionType(CanQual<FunctionNoProtoType> FTNP) { 83 // When translating an unprototyped function type, always use a 84 // variadic type. 85 return arrangeLLVMFunctionInfo(FTNP->getReturnType().getUnqualifiedType(), 86 false, None, FTNP->getExtInfo(), 87 RequiredArgs(0)); 88 } 89 90 /// Arrange the LLVM function layout for a value of the given function 91 /// type, on top of any implicit parameters already stored. 92 static const CGFunctionInfo & 93 arrangeLLVMFunctionInfo(CodeGenTypes &CGT, bool IsInstanceMethod, 94 SmallVectorImpl<CanQualType> &prefix, 95 CanQual<FunctionProtoType> FTP) { 96 RequiredArgs required = RequiredArgs::forPrototypePlus(FTP, prefix.size()); 97 // FIXME: Kill copy. 98 for (unsigned i = 0, e = FTP->getNumParams(); i != e; ++i) 99 prefix.push_back(FTP->getParamType(i)); 100 CanQualType resultType = FTP->getReturnType().getUnqualifiedType(); 101 return CGT.arrangeLLVMFunctionInfo(resultType, IsInstanceMethod, prefix, 102 FTP->getExtInfo(), required); 103 } 104 105 /// Arrange the argument and result information for a value of the 106 /// given freestanding function type. 107 const CGFunctionInfo & 108 CodeGenTypes::arrangeFreeFunctionType(CanQual<FunctionProtoType> FTP) { 109 SmallVector<CanQualType, 16> argTypes; 110 return ::arrangeLLVMFunctionInfo(*this, false, argTypes, FTP); 111 } 112 113 static CallingConv getCallingConventionForDecl(const Decl *D, bool IsWindows) { 114 // Set the appropriate calling convention for the Function. 115 if (D->hasAttr<StdCallAttr>()) 116 return CC_X86StdCall; 117 118 if (D->hasAttr<FastCallAttr>()) 119 return CC_X86FastCall; 120 121 if (D->hasAttr<ThisCallAttr>()) 122 return CC_X86ThisCall; 123 124 if (D->hasAttr<VectorCallAttr>()) 125 return CC_X86VectorCall; 126 127 if (D->hasAttr<PascalAttr>()) 128 return CC_X86Pascal; 129 130 if (PcsAttr *PCS = D->getAttr<PcsAttr>()) 131 return (PCS->getPCS() == PcsAttr::AAPCS ? CC_AAPCS : CC_AAPCS_VFP); 132 133 if (D->hasAttr<PnaclCallAttr>()) 134 return CC_PnaclCall; 135 136 if (D->hasAttr<IntelOclBiccAttr>()) 137 return CC_IntelOclBicc; 138 139 if (D->hasAttr<MSABIAttr>()) 140 return IsWindows ? CC_C : CC_X86_64Win64; 141 142 if (D->hasAttr<SysVABIAttr>()) 143 return IsWindows ? CC_X86_64SysV : CC_C; 144 145 return CC_C; 146 } 147 148 /// Arrange the argument and result information for a call to an 149 /// unknown C++ non-static member function of the given abstract type. 150 /// (Zero value of RD means we don't have any meaningful "this" argument type, 151 /// so fall back to a generic pointer type). 152 /// The member function must be an ordinary function, i.e. not a 153 /// constructor or destructor. 154 const CGFunctionInfo & 155 CodeGenTypes::arrangeCXXMethodType(const CXXRecordDecl *RD, 156 const FunctionProtoType *FTP) { 157 SmallVector<CanQualType, 16> argTypes; 158 159 // Add the 'this' pointer. 160 if (RD) 161 argTypes.push_back(GetThisType(Context, RD)); 162 else 163 argTypes.push_back(Context.VoidPtrTy); 164 165 return ::arrangeLLVMFunctionInfo( 166 *this, true, argTypes, 167 FTP->getCanonicalTypeUnqualified().getAs<FunctionProtoType>()); 168 } 169 170 /// Arrange the argument and result information for a declaration or 171 /// definition of the given C++ non-static member function. The 172 /// member function must be an ordinary function, i.e. not a 173 /// constructor or destructor. 174 const CGFunctionInfo & 175 CodeGenTypes::arrangeCXXMethodDeclaration(const CXXMethodDecl *MD) { 176 assert(!isa<CXXConstructorDecl>(MD) && "wrong method for constructors!"); 177 assert(!isa<CXXDestructorDecl>(MD) && "wrong method for destructors!"); 178 179 CanQual<FunctionProtoType> prototype = GetFormalType(MD); 180 181 if (MD->isInstance()) { 182 // The abstract case is perfectly fine. 183 const CXXRecordDecl *ThisType = TheCXXABI.getThisArgumentTypeForMethod(MD); 184 return arrangeCXXMethodType(ThisType, prototype.getTypePtr()); 185 } 186 187 return arrangeFreeFunctionType(prototype); 188 } 189 190 const CGFunctionInfo & 191 CodeGenTypes::arrangeCXXStructorDeclaration(const CXXMethodDecl *MD, 192 StructorType Type) { 193 194 SmallVector<CanQualType, 16> argTypes; 195 argTypes.push_back(GetThisType(Context, MD->getParent())); 196 197 GlobalDecl GD; 198 if (auto *CD = dyn_cast<CXXConstructorDecl>(MD)) { 199 GD = GlobalDecl(CD, toCXXCtorType(Type)); 200 } else { 201 auto *DD = dyn_cast<CXXDestructorDecl>(MD); 202 GD = GlobalDecl(DD, toCXXDtorType(Type)); 203 } 204 205 CanQual<FunctionProtoType> FTP = GetFormalType(MD); 206 207 // Add the formal parameters. 208 for (unsigned i = 0, e = FTP->getNumParams(); i != e; ++i) 209 argTypes.push_back(FTP->getParamType(i)); 210 211 TheCXXABI.buildStructorSignature(MD, Type, argTypes); 212 213 RequiredArgs required = 214 (MD->isVariadic() ? RequiredArgs(argTypes.size()) : RequiredArgs::All); 215 216 FunctionType::ExtInfo extInfo = FTP->getExtInfo(); 217 CanQualType resultType = TheCXXABI.HasThisReturn(GD) 218 ? argTypes.front() 219 : TheCXXABI.hasMostDerivedReturn(GD) 220 ? CGM.getContext().VoidPtrTy 221 : Context.VoidTy; 222 return arrangeLLVMFunctionInfo(resultType, true, argTypes, extInfo, required); 223 } 224 225 /// Arrange a call to a C++ method, passing the given arguments. 226 const CGFunctionInfo & 227 CodeGenTypes::arrangeCXXConstructorCall(const CallArgList &args, 228 const CXXConstructorDecl *D, 229 CXXCtorType CtorKind, 230 unsigned ExtraArgs) { 231 // FIXME: Kill copy. 232 SmallVector<CanQualType, 16> ArgTypes; 233 for (const auto &Arg : args) 234 ArgTypes.push_back(Context.getCanonicalParamType(Arg.Ty)); 235 236 CanQual<FunctionProtoType> FPT = GetFormalType(D); 237 RequiredArgs Required = RequiredArgs::forPrototypePlus(FPT, 1 + ExtraArgs); 238 GlobalDecl GD(D, CtorKind); 239 CanQualType ResultType = TheCXXABI.HasThisReturn(GD) 240 ? ArgTypes.front() 241 : TheCXXABI.hasMostDerivedReturn(GD) 242 ? CGM.getContext().VoidPtrTy 243 : Context.VoidTy; 244 245 FunctionType::ExtInfo Info = FPT->getExtInfo(); 246 return arrangeLLVMFunctionInfo(ResultType, true, ArgTypes, Info, Required); 247 } 248 249 /// Arrange the argument and result information for the declaration or 250 /// definition of the given function. 251 const CGFunctionInfo & 252 CodeGenTypes::arrangeFunctionDeclaration(const FunctionDecl *FD) { 253 if (const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(FD)) 254 if (MD->isInstance()) 255 return arrangeCXXMethodDeclaration(MD); 256 257 CanQualType FTy = FD->getType()->getCanonicalTypeUnqualified(); 258 259 assert(isa<FunctionType>(FTy)); 260 261 // When declaring a function without a prototype, always use a 262 // non-variadic type. 263 if (isa<FunctionNoProtoType>(FTy)) { 264 CanQual<FunctionNoProtoType> noProto = FTy.getAs<FunctionNoProtoType>(); 265 return arrangeLLVMFunctionInfo(noProto->getReturnType(), false, None, 266 noProto->getExtInfo(), RequiredArgs::All); 267 } 268 269 assert(isa<FunctionProtoType>(FTy)); 270 return arrangeFreeFunctionType(FTy.getAs<FunctionProtoType>()); 271 } 272 273 /// Arrange the argument and result information for the declaration or 274 /// definition of an Objective-C method. 275 const CGFunctionInfo & 276 CodeGenTypes::arrangeObjCMethodDeclaration(const ObjCMethodDecl *MD) { 277 // It happens that this is the same as a call with no optional 278 // arguments, except also using the formal 'self' type. 279 return arrangeObjCMessageSendSignature(MD, MD->getSelfDecl()->getType()); 280 } 281 282 /// Arrange the argument and result information for the function type 283 /// through which to perform a send to the given Objective-C method, 284 /// using the given receiver type. The receiver type is not always 285 /// the 'self' type of the method or even an Objective-C pointer type. 286 /// This is *not* the right method for actually performing such a 287 /// message send, due to the possibility of optional arguments. 288 const CGFunctionInfo & 289 CodeGenTypes::arrangeObjCMessageSendSignature(const ObjCMethodDecl *MD, 290 QualType receiverType) { 291 SmallVector<CanQualType, 16> argTys; 292 argTys.push_back(Context.getCanonicalParamType(receiverType)); 293 argTys.push_back(Context.getCanonicalParamType(Context.getObjCSelType())); 294 // FIXME: Kill copy? 295 for (const auto *I : MD->params()) { 296 argTys.push_back(Context.getCanonicalParamType(I->getType())); 297 } 298 299 FunctionType::ExtInfo einfo; 300 bool IsWindows = getContext().getTargetInfo().getTriple().isOSWindows(); 301 einfo = einfo.withCallingConv(getCallingConventionForDecl(MD, IsWindows)); 302 303 if (getContext().getLangOpts().ObjCAutoRefCount && 304 MD->hasAttr<NSReturnsRetainedAttr>()) 305 einfo = einfo.withProducesResult(true); 306 307 RequiredArgs required = 308 (MD->isVariadic() ? RequiredArgs(argTys.size()) : RequiredArgs::All); 309 310 return arrangeLLVMFunctionInfo(GetReturnType(MD->getReturnType()), false, 311 argTys, einfo, required); 312 } 313 314 const CGFunctionInfo & 315 CodeGenTypes::arrangeGlobalDeclaration(GlobalDecl GD) { 316 // FIXME: Do we need to handle ObjCMethodDecl? 317 const FunctionDecl *FD = cast<FunctionDecl>(GD.getDecl()); 318 319 if (const CXXConstructorDecl *CD = dyn_cast<CXXConstructorDecl>(FD)) 320 return arrangeCXXStructorDeclaration(CD, getFromCtorType(GD.getCtorType())); 321 322 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(FD)) 323 return arrangeCXXStructorDeclaration(DD, getFromDtorType(GD.getDtorType())); 324 325 return arrangeFunctionDeclaration(FD); 326 } 327 328 /// Arrange a thunk that takes 'this' as the first parameter followed by 329 /// varargs. Return a void pointer, regardless of the actual return type. 330 /// The body of the thunk will end in a musttail call to a function of the 331 /// correct type, and the caller will bitcast the function to the correct 332 /// prototype. 333 const CGFunctionInfo & 334 CodeGenTypes::arrangeMSMemberPointerThunk(const CXXMethodDecl *MD) { 335 assert(MD->isVirtual() && "only virtual memptrs have thunks"); 336 CanQual<FunctionProtoType> FTP = GetFormalType(MD); 337 CanQualType ArgTys[] = { GetThisType(Context, MD->getParent()) }; 338 return arrangeLLVMFunctionInfo(Context.VoidTy, false, ArgTys, 339 FTP->getExtInfo(), RequiredArgs(1)); 340 } 341 342 /// Arrange a call as unto a free function, except possibly with an 343 /// additional number of formal parameters considered required. 344 static const CGFunctionInfo & 345 arrangeFreeFunctionLikeCall(CodeGenTypes &CGT, 346 CodeGenModule &CGM, 347 const CallArgList &args, 348 const FunctionType *fnType, 349 unsigned numExtraRequiredArgs) { 350 assert(args.size() >= numExtraRequiredArgs); 351 352 // In most cases, there are no optional arguments. 353 RequiredArgs required = RequiredArgs::All; 354 355 // If we have a variadic prototype, the required arguments are the 356 // extra prefix plus the arguments in the prototype. 357 if (const FunctionProtoType *proto = dyn_cast<FunctionProtoType>(fnType)) { 358 if (proto->isVariadic()) 359 required = RequiredArgs(proto->getNumParams() + numExtraRequiredArgs); 360 361 // If we don't have a prototype at all, but we're supposed to 362 // explicitly use the variadic convention for unprototyped calls, 363 // treat all of the arguments as required but preserve the nominal 364 // possibility of variadics. 365 } else if (CGM.getTargetCodeGenInfo() 366 .isNoProtoCallVariadic(args, 367 cast<FunctionNoProtoType>(fnType))) { 368 required = RequiredArgs(args.size()); 369 } 370 371 return CGT.arrangeFreeFunctionCall(fnType->getReturnType(), args, 372 fnType->getExtInfo(), required); 373 } 374 375 /// Figure out the rules for calling a function with the given formal 376 /// type using the given arguments. The arguments are necessary 377 /// because the function might be unprototyped, in which case it's 378 /// target-dependent in crazy ways. 379 const CGFunctionInfo & 380 CodeGenTypes::arrangeFreeFunctionCall(const CallArgList &args, 381 const FunctionType *fnType) { 382 return arrangeFreeFunctionLikeCall(*this, CGM, args, fnType, 0); 383 } 384 385 /// A block function call is essentially a free-function call with an 386 /// extra implicit argument. 387 const CGFunctionInfo & 388 CodeGenTypes::arrangeBlockFunctionCall(const CallArgList &args, 389 const FunctionType *fnType) { 390 return arrangeFreeFunctionLikeCall(*this, CGM, args, fnType, 1); 391 } 392 393 const CGFunctionInfo & 394 CodeGenTypes::arrangeFreeFunctionCall(QualType resultType, 395 const CallArgList &args, 396 FunctionType::ExtInfo info, 397 RequiredArgs required) { 398 // FIXME: Kill copy. 399 SmallVector<CanQualType, 16> argTypes; 400 for (const auto &Arg : args) 401 argTypes.push_back(Context.getCanonicalParamType(Arg.Ty)); 402 return arrangeLLVMFunctionInfo(GetReturnType(resultType), false, argTypes, 403 info, required); 404 } 405 406 /// Arrange a call to a C++ method, passing the given arguments. 407 const CGFunctionInfo & 408 CodeGenTypes::arrangeCXXMethodCall(const CallArgList &args, 409 const FunctionProtoType *FPT, 410 RequiredArgs required) { 411 // FIXME: Kill copy. 412 SmallVector<CanQualType, 16> argTypes; 413 for (const auto &Arg : args) 414 argTypes.push_back(Context.getCanonicalParamType(Arg.Ty)); 415 416 FunctionType::ExtInfo info = FPT->getExtInfo(); 417 return arrangeLLVMFunctionInfo(GetReturnType(FPT->getReturnType()), true, 418 argTypes, info, required); 419 } 420 421 const CGFunctionInfo &CodeGenTypes::arrangeFreeFunctionDeclaration( 422 QualType resultType, const FunctionArgList &args, 423 const FunctionType::ExtInfo &info, bool isVariadic) { 424 // FIXME: Kill copy. 425 SmallVector<CanQualType, 16> argTypes; 426 for (auto Arg : args) 427 argTypes.push_back(Context.getCanonicalParamType(Arg->getType())); 428 429 RequiredArgs required = 430 (isVariadic ? RequiredArgs(args.size()) : RequiredArgs::All); 431 return arrangeLLVMFunctionInfo(GetReturnType(resultType), false, argTypes, info, 432 required); 433 } 434 435 const CGFunctionInfo &CodeGenTypes::arrangeNullaryFunction() { 436 return arrangeLLVMFunctionInfo(getContext().VoidTy, false, None, 437 FunctionType::ExtInfo(), RequiredArgs::All); 438 } 439 440 /// Arrange the argument and result information for an abstract value 441 /// of a given function type. This is the method which all of the 442 /// above functions ultimately defer to. 443 const CGFunctionInfo & 444 CodeGenTypes::arrangeLLVMFunctionInfo(CanQualType resultType, 445 bool IsInstanceMethod, 446 ArrayRef<CanQualType> argTypes, 447 FunctionType::ExtInfo info, 448 RequiredArgs required) { 449 #ifndef NDEBUG 450 for (ArrayRef<CanQualType>::const_iterator 451 I = argTypes.begin(), E = argTypes.end(); I != E; ++I) 452 assert(I->isCanonicalAsParam()); 453 #endif 454 455 unsigned CC = ClangCallConvToLLVMCallConv(info.getCC()); 456 457 // Lookup or create unique function info. 458 llvm::FoldingSetNodeID ID; 459 CGFunctionInfo::Profile(ID, IsInstanceMethod, info, required, resultType, 460 argTypes); 461 462 void *insertPos = nullptr; 463 CGFunctionInfo *FI = FunctionInfos.FindNodeOrInsertPos(ID, insertPos); 464 if (FI) 465 return *FI; 466 467 // Construct the function info. We co-allocate the ArgInfos. 468 FI = CGFunctionInfo::create(CC, IsInstanceMethod, info, resultType, argTypes, 469 required); 470 FunctionInfos.InsertNode(FI, insertPos); 471 472 bool inserted = FunctionsBeingProcessed.insert(FI); (void)inserted; 473 assert(inserted && "Recursively being processed?"); 474 475 // Compute ABI information. 476 getABIInfo().computeInfo(*FI); 477 478 // Loop over all of the computed argument and return value info. If any of 479 // them are direct or extend without a specified coerce type, specify the 480 // default now. 481 ABIArgInfo &retInfo = FI->getReturnInfo(); 482 if (retInfo.canHaveCoerceToType() && retInfo.getCoerceToType() == nullptr) 483 retInfo.setCoerceToType(ConvertType(FI->getReturnType())); 484 485 for (auto &I : FI->arguments()) 486 if (I.info.canHaveCoerceToType() && I.info.getCoerceToType() == nullptr) 487 I.info.setCoerceToType(ConvertType(I.type)); 488 489 bool erased = FunctionsBeingProcessed.erase(FI); (void)erased; 490 assert(erased && "Not in set?"); 491 492 return *FI; 493 } 494 495 CGFunctionInfo *CGFunctionInfo::create(unsigned llvmCC, 496 bool IsInstanceMethod, 497 const FunctionType::ExtInfo &info, 498 CanQualType resultType, 499 ArrayRef<CanQualType> argTypes, 500 RequiredArgs required) { 501 void *buffer = operator new(sizeof(CGFunctionInfo) + 502 sizeof(ArgInfo) * (argTypes.size() + 1)); 503 CGFunctionInfo *FI = new(buffer) CGFunctionInfo(); 504 FI->CallingConvention = llvmCC; 505 FI->EffectiveCallingConvention = llvmCC; 506 FI->ASTCallingConvention = info.getCC(); 507 FI->InstanceMethod = IsInstanceMethod; 508 FI->NoReturn = info.getNoReturn(); 509 FI->ReturnsRetained = info.getProducesResult(); 510 FI->Required = required; 511 FI->HasRegParm = info.getHasRegParm(); 512 FI->RegParm = info.getRegParm(); 513 FI->ArgStruct = nullptr; 514 FI->NumArgs = argTypes.size(); 515 FI->getArgsBuffer()[0].type = resultType; 516 for (unsigned i = 0, e = argTypes.size(); i != e; ++i) 517 FI->getArgsBuffer()[i + 1].type = argTypes[i]; 518 return FI; 519 } 520 521 /***/ 522 523 namespace { 524 // ABIArgInfo::Expand implementation. 525 526 // Specifies the way QualType passed as ABIArgInfo::Expand is expanded. 527 struct TypeExpansion { 528 enum TypeExpansionKind { 529 // Elements of constant arrays are expanded recursively. 530 TEK_ConstantArray, 531 // Record fields are expanded recursively (but if record is a union, only 532 // the field with the largest size is expanded). 533 TEK_Record, 534 // For complex types, real and imaginary parts are expanded recursively. 535 TEK_Complex, 536 // All other types are not expandable. 537 TEK_None 538 }; 539 540 const TypeExpansionKind Kind; 541 542 TypeExpansion(TypeExpansionKind K) : Kind(K) {} 543 virtual ~TypeExpansion() {} 544 }; 545 546 struct ConstantArrayExpansion : TypeExpansion { 547 QualType EltTy; 548 uint64_t NumElts; 549 550 ConstantArrayExpansion(QualType EltTy, uint64_t NumElts) 551 : TypeExpansion(TEK_ConstantArray), EltTy(EltTy), NumElts(NumElts) {} 552 static bool classof(const TypeExpansion *TE) { 553 return TE->Kind == TEK_ConstantArray; 554 } 555 }; 556 557 struct RecordExpansion : TypeExpansion { 558 SmallVector<const CXXBaseSpecifier *, 1> Bases; 559 560 SmallVector<const FieldDecl *, 1> Fields; 561 562 RecordExpansion(SmallVector<const CXXBaseSpecifier *, 1> &&Bases, 563 SmallVector<const FieldDecl *, 1> &&Fields) 564 : TypeExpansion(TEK_Record), Bases(Bases), Fields(Fields) {} 565 static bool classof(const TypeExpansion *TE) { 566 return TE->Kind == TEK_Record; 567 } 568 }; 569 570 struct ComplexExpansion : TypeExpansion { 571 QualType EltTy; 572 573 ComplexExpansion(QualType EltTy) : TypeExpansion(TEK_Complex), EltTy(EltTy) {} 574 static bool classof(const TypeExpansion *TE) { 575 return TE->Kind == TEK_Complex; 576 } 577 }; 578 579 struct NoExpansion : TypeExpansion { 580 NoExpansion() : TypeExpansion(TEK_None) {} 581 static bool classof(const TypeExpansion *TE) { 582 return TE->Kind == TEK_None; 583 } 584 }; 585 } // namespace 586 587 static std::unique_ptr<TypeExpansion> 588 getTypeExpansion(QualType Ty, const ASTContext &Context) { 589 if (const ConstantArrayType *AT = Context.getAsConstantArrayType(Ty)) { 590 return llvm::make_unique<ConstantArrayExpansion>( 591 AT->getElementType(), AT->getSize().getZExtValue()); 592 } 593 if (const RecordType *RT = Ty->getAs<RecordType>()) { 594 SmallVector<const CXXBaseSpecifier *, 1> Bases; 595 SmallVector<const FieldDecl *, 1> Fields; 596 const RecordDecl *RD = RT->getDecl(); 597 assert(!RD->hasFlexibleArrayMember() && 598 "Cannot expand structure with flexible array."); 599 if (RD->isUnion()) { 600 // Unions can be here only in degenerative cases - all the fields are same 601 // after flattening. Thus we have to use the "largest" field. 602 const FieldDecl *LargestFD = nullptr; 603 CharUnits UnionSize = CharUnits::Zero(); 604 605 for (const auto *FD : RD->fields()) { 606 // Skip zero length bitfields. 607 if (FD->isBitField() && FD->getBitWidthValue(Context) == 0) 608 continue; 609 assert(!FD->isBitField() && 610 "Cannot expand structure with bit-field members."); 611 CharUnits FieldSize = Context.getTypeSizeInChars(FD->getType()); 612 if (UnionSize < FieldSize) { 613 UnionSize = FieldSize; 614 LargestFD = FD; 615 } 616 } 617 if (LargestFD) 618 Fields.push_back(LargestFD); 619 } else { 620 if (const auto *CXXRD = dyn_cast<CXXRecordDecl>(RD)) { 621 assert(!CXXRD->isDynamicClass() && 622 "cannot expand vtable pointers in dynamic classes"); 623 for (const CXXBaseSpecifier &BS : CXXRD->bases()) 624 Bases.push_back(&BS); 625 } 626 627 for (const auto *FD : RD->fields()) { 628 // Skip zero length bitfields. 629 if (FD->isBitField() && FD->getBitWidthValue(Context) == 0) 630 continue; 631 assert(!FD->isBitField() && 632 "Cannot expand structure with bit-field members."); 633 Fields.push_back(FD); 634 } 635 } 636 return llvm::make_unique<RecordExpansion>(std::move(Bases), 637 std::move(Fields)); 638 } 639 if (const ComplexType *CT = Ty->getAs<ComplexType>()) { 640 return llvm::make_unique<ComplexExpansion>(CT->getElementType()); 641 } 642 return llvm::make_unique<NoExpansion>(); 643 } 644 645 static int getExpansionSize(QualType Ty, const ASTContext &Context) { 646 auto Exp = getTypeExpansion(Ty, Context); 647 if (auto CAExp = dyn_cast<ConstantArrayExpansion>(Exp.get())) { 648 return CAExp->NumElts * getExpansionSize(CAExp->EltTy, Context); 649 } 650 if (auto RExp = dyn_cast<RecordExpansion>(Exp.get())) { 651 int Res = 0; 652 for (auto BS : RExp->Bases) 653 Res += getExpansionSize(BS->getType(), Context); 654 for (auto FD : RExp->Fields) 655 Res += getExpansionSize(FD->getType(), Context); 656 return Res; 657 } 658 if (isa<ComplexExpansion>(Exp.get())) 659 return 2; 660 assert(isa<NoExpansion>(Exp.get())); 661 return 1; 662 } 663 664 void 665 CodeGenTypes::getExpandedTypes(QualType Ty, 666 SmallVectorImpl<llvm::Type *>::iterator &TI) { 667 auto Exp = getTypeExpansion(Ty, Context); 668 if (auto CAExp = dyn_cast<ConstantArrayExpansion>(Exp.get())) { 669 for (int i = 0, n = CAExp->NumElts; i < n; i++) { 670 getExpandedTypes(CAExp->EltTy, TI); 671 } 672 } else if (auto RExp = dyn_cast<RecordExpansion>(Exp.get())) { 673 for (auto BS : RExp->Bases) 674 getExpandedTypes(BS->getType(), TI); 675 for (auto FD : RExp->Fields) 676 getExpandedTypes(FD->getType(), TI); 677 } else if (auto CExp = dyn_cast<ComplexExpansion>(Exp.get())) { 678 llvm::Type *EltTy = ConvertType(CExp->EltTy); 679 *TI++ = EltTy; 680 *TI++ = EltTy; 681 } else { 682 assert(isa<NoExpansion>(Exp.get())); 683 *TI++ = ConvertType(Ty); 684 } 685 } 686 687 void CodeGenFunction::ExpandTypeFromArgs( 688 QualType Ty, LValue LV, SmallVectorImpl<llvm::Argument *>::iterator &AI) { 689 assert(LV.isSimple() && 690 "Unexpected non-simple lvalue during struct expansion."); 691 692 auto Exp = getTypeExpansion(Ty, getContext()); 693 if (auto CAExp = dyn_cast<ConstantArrayExpansion>(Exp.get())) { 694 for (int i = 0, n = CAExp->NumElts; i < n; i++) { 695 llvm::Value *EltAddr = Builder.CreateConstGEP2_32(LV.getAddress(), 0, i); 696 LValue LV = MakeAddrLValue(EltAddr, CAExp->EltTy); 697 ExpandTypeFromArgs(CAExp->EltTy, LV, AI); 698 } 699 } else if (auto RExp = dyn_cast<RecordExpansion>(Exp.get())) { 700 llvm::Value *This = LV.getAddress(); 701 for (const CXXBaseSpecifier *BS : RExp->Bases) { 702 // Perform a single step derived-to-base conversion. 703 llvm::Value *Base = 704 GetAddressOfBaseClass(This, Ty->getAsCXXRecordDecl(), &BS, &BS + 1, 705 /*NullCheckValue=*/false, SourceLocation()); 706 LValue SubLV = MakeAddrLValue(Base, BS->getType()); 707 708 // Recurse onto bases. 709 ExpandTypeFromArgs(BS->getType(), SubLV, AI); 710 } 711 for (auto FD : RExp->Fields) { 712 // FIXME: What are the right qualifiers here? 713 LValue SubLV = EmitLValueForField(LV, FD); 714 ExpandTypeFromArgs(FD->getType(), SubLV, AI); 715 } 716 } else if (auto CExp = dyn_cast<ComplexExpansion>(Exp.get())) { 717 llvm::Value *RealAddr = Builder.CreateStructGEP(LV.getAddress(), 0, "real"); 718 EmitStoreThroughLValue(RValue::get(*AI++), 719 MakeAddrLValue(RealAddr, CExp->EltTy)); 720 llvm::Value *ImagAddr = Builder.CreateStructGEP(LV.getAddress(), 1, "imag"); 721 EmitStoreThroughLValue(RValue::get(*AI++), 722 MakeAddrLValue(ImagAddr, CExp->EltTy)); 723 } else { 724 assert(isa<NoExpansion>(Exp.get())); 725 EmitStoreThroughLValue(RValue::get(*AI++), LV); 726 } 727 } 728 729 void CodeGenFunction::ExpandTypeToArgs( 730 QualType Ty, RValue RV, llvm::FunctionType *IRFuncTy, 731 SmallVectorImpl<llvm::Value *> &IRCallArgs, unsigned &IRCallArgPos) { 732 auto Exp = getTypeExpansion(Ty, getContext()); 733 if (auto CAExp = dyn_cast<ConstantArrayExpansion>(Exp.get())) { 734 llvm::Value *Addr = RV.getAggregateAddr(); 735 for (int i = 0, n = CAExp->NumElts; i < n; i++) { 736 llvm::Value *EltAddr = Builder.CreateConstGEP2_32(Addr, 0, i); 737 RValue EltRV = 738 convertTempToRValue(EltAddr, CAExp->EltTy, SourceLocation()); 739 ExpandTypeToArgs(CAExp->EltTy, EltRV, IRFuncTy, IRCallArgs, IRCallArgPos); 740 } 741 } else if (auto RExp = dyn_cast<RecordExpansion>(Exp.get())) { 742 llvm::Value *This = RV.getAggregateAddr(); 743 for (const CXXBaseSpecifier *BS : RExp->Bases) { 744 // Perform a single step derived-to-base conversion. 745 llvm::Value *Base = 746 GetAddressOfBaseClass(This, Ty->getAsCXXRecordDecl(), &BS, &BS + 1, 747 /*NullCheckValue=*/false, SourceLocation()); 748 RValue BaseRV = RValue::getAggregate(Base); 749 750 // Recurse onto bases. 751 ExpandTypeToArgs(BS->getType(), BaseRV, IRFuncTy, IRCallArgs, 752 IRCallArgPos); 753 } 754 755 LValue LV = MakeAddrLValue(This, Ty); 756 for (auto FD : RExp->Fields) { 757 RValue FldRV = EmitRValueForField(LV, FD, SourceLocation()); 758 ExpandTypeToArgs(FD->getType(), FldRV, IRFuncTy, IRCallArgs, 759 IRCallArgPos); 760 } 761 } else if (isa<ComplexExpansion>(Exp.get())) { 762 ComplexPairTy CV = RV.getComplexVal(); 763 IRCallArgs[IRCallArgPos++] = CV.first; 764 IRCallArgs[IRCallArgPos++] = CV.second; 765 } else { 766 assert(isa<NoExpansion>(Exp.get())); 767 assert(RV.isScalar() && 768 "Unexpected non-scalar rvalue during struct expansion."); 769 770 // Insert a bitcast as needed. 771 llvm::Value *V = RV.getScalarVal(); 772 if (IRCallArgPos < IRFuncTy->getNumParams() && 773 V->getType() != IRFuncTy->getParamType(IRCallArgPos)) 774 V = Builder.CreateBitCast(V, IRFuncTy->getParamType(IRCallArgPos)); 775 776 IRCallArgs[IRCallArgPos++] = V; 777 } 778 } 779 780 /// EnterStructPointerForCoercedAccess - Given a struct pointer that we are 781 /// accessing some number of bytes out of it, try to gep into the struct to get 782 /// at its inner goodness. Dive as deep as possible without entering an element 783 /// with an in-memory size smaller than DstSize. 784 static llvm::Value * 785 EnterStructPointerForCoercedAccess(llvm::Value *SrcPtr, 786 llvm::StructType *SrcSTy, 787 uint64_t DstSize, CodeGenFunction &CGF) { 788 // We can't dive into a zero-element struct. 789 if (SrcSTy->getNumElements() == 0) return SrcPtr; 790 791 llvm::Type *FirstElt = SrcSTy->getElementType(0); 792 793 // If the first elt is at least as large as what we're looking for, or if the 794 // first element is the same size as the whole struct, we can enter it. The 795 // comparison must be made on the store size and not the alloca size. Using 796 // the alloca size may overstate the size of the load. 797 uint64_t FirstEltSize = 798 CGF.CGM.getDataLayout().getTypeStoreSize(FirstElt); 799 if (FirstEltSize < DstSize && 800 FirstEltSize < CGF.CGM.getDataLayout().getTypeStoreSize(SrcSTy)) 801 return SrcPtr; 802 803 // GEP into the first element. 804 SrcPtr = CGF.Builder.CreateConstGEP2_32(SrcPtr, 0, 0, "coerce.dive"); 805 806 // If the first element is a struct, recurse. 807 llvm::Type *SrcTy = 808 cast<llvm::PointerType>(SrcPtr->getType())->getElementType(); 809 if (llvm::StructType *SrcSTy = dyn_cast<llvm::StructType>(SrcTy)) 810 return EnterStructPointerForCoercedAccess(SrcPtr, SrcSTy, DstSize, CGF); 811 812 return SrcPtr; 813 } 814 815 /// CoerceIntOrPtrToIntOrPtr - Convert a value Val to the specific Ty where both 816 /// are either integers or pointers. This does a truncation of the value if it 817 /// is too large or a zero extension if it is too small. 818 /// 819 /// This behaves as if the value were coerced through memory, so on big-endian 820 /// targets the high bits are preserved in a truncation, while little-endian 821 /// targets preserve the low bits. 822 static llvm::Value *CoerceIntOrPtrToIntOrPtr(llvm::Value *Val, 823 llvm::Type *Ty, 824 CodeGenFunction &CGF) { 825 if (Val->getType() == Ty) 826 return Val; 827 828 if (isa<llvm::PointerType>(Val->getType())) { 829 // If this is Pointer->Pointer avoid conversion to and from int. 830 if (isa<llvm::PointerType>(Ty)) 831 return CGF.Builder.CreateBitCast(Val, Ty, "coerce.val"); 832 833 // Convert the pointer to an integer so we can play with its width. 834 Val = CGF.Builder.CreatePtrToInt(Val, CGF.IntPtrTy, "coerce.val.pi"); 835 } 836 837 llvm::Type *DestIntTy = Ty; 838 if (isa<llvm::PointerType>(DestIntTy)) 839 DestIntTy = CGF.IntPtrTy; 840 841 if (Val->getType() != DestIntTy) { 842 const llvm::DataLayout &DL = CGF.CGM.getDataLayout(); 843 if (DL.isBigEndian()) { 844 // Preserve the high bits on big-endian targets. 845 // That is what memory coercion does. 846 uint64_t SrcSize = DL.getTypeSizeInBits(Val->getType()); 847 uint64_t DstSize = DL.getTypeSizeInBits(DestIntTy); 848 849 if (SrcSize > DstSize) { 850 Val = CGF.Builder.CreateLShr(Val, SrcSize - DstSize, "coerce.highbits"); 851 Val = CGF.Builder.CreateTrunc(Val, DestIntTy, "coerce.val.ii"); 852 } else { 853 Val = CGF.Builder.CreateZExt(Val, DestIntTy, "coerce.val.ii"); 854 Val = CGF.Builder.CreateShl(Val, DstSize - SrcSize, "coerce.highbits"); 855 } 856 } else { 857 // Little-endian targets preserve the low bits. No shifts required. 858 Val = CGF.Builder.CreateIntCast(Val, DestIntTy, false, "coerce.val.ii"); 859 } 860 } 861 862 if (isa<llvm::PointerType>(Ty)) 863 Val = CGF.Builder.CreateIntToPtr(Val, Ty, "coerce.val.ip"); 864 return Val; 865 } 866 867 868 869 /// CreateCoercedLoad - Create a load from \arg SrcPtr interpreted as 870 /// a pointer to an object of type \arg Ty. 871 /// 872 /// This safely handles the case when the src type is smaller than the 873 /// destination type; in this situation the values of bits which not 874 /// present in the src are undefined. 875 static llvm::Value *CreateCoercedLoad(llvm::Value *SrcPtr, 876 llvm::Type *Ty, 877 CodeGenFunction &CGF) { 878 llvm::Type *SrcTy = 879 cast<llvm::PointerType>(SrcPtr->getType())->getElementType(); 880 881 // If SrcTy and Ty are the same, just do a load. 882 if (SrcTy == Ty) 883 return CGF.Builder.CreateLoad(SrcPtr); 884 885 uint64_t DstSize = CGF.CGM.getDataLayout().getTypeAllocSize(Ty); 886 887 if (llvm::StructType *SrcSTy = dyn_cast<llvm::StructType>(SrcTy)) { 888 SrcPtr = EnterStructPointerForCoercedAccess(SrcPtr, SrcSTy, DstSize, CGF); 889 SrcTy = cast<llvm::PointerType>(SrcPtr->getType())->getElementType(); 890 } 891 892 uint64_t SrcSize = CGF.CGM.getDataLayout().getTypeAllocSize(SrcTy); 893 894 // If the source and destination are integer or pointer types, just do an 895 // extension or truncation to the desired type. 896 if ((isa<llvm::IntegerType>(Ty) || isa<llvm::PointerType>(Ty)) && 897 (isa<llvm::IntegerType>(SrcTy) || isa<llvm::PointerType>(SrcTy))) { 898 llvm::LoadInst *Load = CGF.Builder.CreateLoad(SrcPtr); 899 return CoerceIntOrPtrToIntOrPtr(Load, Ty, CGF); 900 } 901 902 // If load is legal, just bitcast the src pointer. 903 if (SrcSize >= DstSize) { 904 // Generally SrcSize is never greater than DstSize, since this means we are 905 // losing bits. However, this can happen in cases where the structure has 906 // additional padding, for example due to a user specified alignment. 907 // 908 // FIXME: Assert that we aren't truncating non-padding bits when have access 909 // to that information. 910 llvm::Value *Casted = 911 CGF.Builder.CreateBitCast(SrcPtr, llvm::PointerType::getUnqual(Ty)); 912 llvm::LoadInst *Load = CGF.Builder.CreateLoad(Casted); 913 // FIXME: Use better alignment / avoid requiring aligned load. 914 Load->setAlignment(1); 915 return Load; 916 } 917 918 // Otherwise do coercion through memory. This is stupid, but 919 // simple. 920 llvm::Value *Tmp = CGF.CreateTempAlloca(Ty); 921 llvm::Type *I8PtrTy = CGF.Builder.getInt8PtrTy(); 922 llvm::Value *Casted = CGF.Builder.CreateBitCast(Tmp, I8PtrTy); 923 llvm::Value *SrcCasted = CGF.Builder.CreateBitCast(SrcPtr, I8PtrTy); 924 // FIXME: Use better alignment. 925 CGF.Builder.CreateMemCpy(Casted, SrcCasted, 926 llvm::ConstantInt::get(CGF.IntPtrTy, SrcSize), 927 1, false); 928 return CGF.Builder.CreateLoad(Tmp); 929 } 930 931 // Function to store a first-class aggregate into memory. We prefer to 932 // store the elements rather than the aggregate to be more friendly to 933 // fast-isel. 934 // FIXME: Do we need to recurse here? 935 static void BuildAggStore(CodeGenFunction &CGF, llvm::Value *Val, 936 llvm::Value *DestPtr, bool DestIsVolatile, 937 bool LowAlignment) { 938 // Prefer scalar stores to first-class aggregate stores. 939 if (llvm::StructType *STy = 940 dyn_cast<llvm::StructType>(Val->getType())) { 941 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) { 942 llvm::Value *EltPtr = CGF.Builder.CreateConstGEP2_32(DestPtr, 0, i); 943 llvm::Value *Elt = CGF.Builder.CreateExtractValue(Val, i); 944 llvm::StoreInst *SI = CGF.Builder.CreateStore(Elt, EltPtr, 945 DestIsVolatile); 946 if (LowAlignment) 947 SI->setAlignment(1); 948 } 949 } else { 950 llvm::StoreInst *SI = CGF.Builder.CreateStore(Val, DestPtr, DestIsVolatile); 951 if (LowAlignment) 952 SI->setAlignment(1); 953 } 954 } 955 956 /// CreateCoercedStore - Create a store to \arg DstPtr from \arg Src, 957 /// where the source and destination may have different types. 958 /// 959 /// This safely handles the case when the src type is larger than the 960 /// destination type; the upper bits of the src will be lost. 961 static void CreateCoercedStore(llvm::Value *Src, 962 llvm::Value *DstPtr, 963 bool DstIsVolatile, 964 CodeGenFunction &CGF) { 965 llvm::Type *SrcTy = Src->getType(); 966 llvm::Type *DstTy = 967 cast<llvm::PointerType>(DstPtr->getType())->getElementType(); 968 if (SrcTy == DstTy) { 969 CGF.Builder.CreateStore(Src, DstPtr, DstIsVolatile); 970 return; 971 } 972 973 uint64_t SrcSize = CGF.CGM.getDataLayout().getTypeAllocSize(SrcTy); 974 975 if (llvm::StructType *DstSTy = dyn_cast<llvm::StructType>(DstTy)) { 976 DstPtr = EnterStructPointerForCoercedAccess(DstPtr, DstSTy, SrcSize, CGF); 977 DstTy = cast<llvm::PointerType>(DstPtr->getType())->getElementType(); 978 } 979 980 // If the source and destination are integer or pointer types, just do an 981 // extension or truncation to the desired type. 982 if ((isa<llvm::IntegerType>(SrcTy) || isa<llvm::PointerType>(SrcTy)) && 983 (isa<llvm::IntegerType>(DstTy) || isa<llvm::PointerType>(DstTy))) { 984 Src = CoerceIntOrPtrToIntOrPtr(Src, DstTy, CGF); 985 CGF.Builder.CreateStore(Src, DstPtr, DstIsVolatile); 986 return; 987 } 988 989 uint64_t DstSize = CGF.CGM.getDataLayout().getTypeAllocSize(DstTy); 990 991 // If store is legal, just bitcast the src pointer. 992 if (SrcSize <= DstSize) { 993 llvm::Value *Casted = 994 CGF.Builder.CreateBitCast(DstPtr, llvm::PointerType::getUnqual(SrcTy)); 995 // FIXME: Use better alignment / avoid requiring aligned store. 996 BuildAggStore(CGF, Src, Casted, DstIsVolatile, true); 997 } else { 998 // Otherwise do coercion through memory. This is stupid, but 999 // simple. 1000 1001 // Generally SrcSize is never greater than DstSize, since this means we are 1002 // losing bits. However, this can happen in cases where the structure has 1003 // additional padding, for example due to a user specified alignment. 1004 // 1005 // FIXME: Assert that we aren't truncating non-padding bits when have access 1006 // to that information. 1007 llvm::Value *Tmp = CGF.CreateTempAlloca(SrcTy); 1008 CGF.Builder.CreateStore(Src, Tmp); 1009 llvm::Type *I8PtrTy = CGF.Builder.getInt8PtrTy(); 1010 llvm::Value *Casted = CGF.Builder.CreateBitCast(Tmp, I8PtrTy); 1011 llvm::Value *DstCasted = CGF.Builder.CreateBitCast(DstPtr, I8PtrTy); 1012 // FIXME: Use better alignment. 1013 CGF.Builder.CreateMemCpy(DstCasted, Casted, 1014 llvm::ConstantInt::get(CGF.IntPtrTy, DstSize), 1015 1, false); 1016 } 1017 } 1018 1019 namespace { 1020 1021 /// Encapsulates information about the way function arguments from 1022 /// CGFunctionInfo should be passed to actual LLVM IR function. 1023 class ClangToLLVMArgMapping { 1024 static const unsigned InvalidIndex = ~0U; 1025 unsigned InallocaArgNo; 1026 unsigned SRetArgNo; 1027 unsigned TotalIRArgs; 1028 1029 /// Arguments of LLVM IR function corresponding to single Clang argument. 1030 struct IRArgs { 1031 unsigned PaddingArgIndex; 1032 // Argument is expanded to IR arguments at positions 1033 // [FirstArgIndex, FirstArgIndex + NumberOfArgs). 1034 unsigned FirstArgIndex; 1035 unsigned NumberOfArgs; 1036 1037 IRArgs() 1038 : PaddingArgIndex(InvalidIndex), FirstArgIndex(InvalidIndex), 1039 NumberOfArgs(0) {} 1040 }; 1041 1042 SmallVector<IRArgs, 8> ArgInfo; 1043 1044 public: 1045 ClangToLLVMArgMapping(const ASTContext &Context, const CGFunctionInfo &FI, 1046 bool OnlyRequiredArgs = false) 1047 : InallocaArgNo(InvalidIndex), SRetArgNo(InvalidIndex), TotalIRArgs(0), 1048 ArgInfo(OnlyRequiredArgs ? FI.getNumRequiredArgs() : FI.arg_size()) { 1049 construct(Context, FI, OnlyRequiredArgs); 1050 } 1051 1052 bool hasInallocaArg() const { return InallocaArgNo != InvalidIndex; } 1053 unsigned getInallocaArgNo() const { 1054 assert(hasInallocaArg()); 1055 return InallocaArgNo; 1056 } 1057 1058 bool hasSRetArg() const { return SRetArgNo != InvalidIndex; } 1059 unsigned getSRetArgNo() const { 1060 assert(hasSRetArg()); 1061 return SRetArgNo; 1062 } 1063 1064 unsigned totalIRArgs() const { return TotalIRArgs; } 1065 1066 bool hasPaddingArg(unsigned ArgNo) const { 1067 assert(ArgNo < ArgInfo.size()); 1068 return ArgInfo[ArgNo].PaddingArgIndex != InvalidIndex; 1069 } 1070 unsigned getPaddingArgNo(unsigned ArgNo) const { 1071 assert(hasPaddingArg(ArgNo)); 1072 return ArgInfo[ArgNo].PaddingArgIndex; 1073 } 1074 1075 /// Returns index of first IR argument corresponding to ArgNo, and their 1076 /// quantity. 1077 std::pair<unsigned, unsigned> getIRArgs(unsigned ArgNo) const { 1078 assert(ArgNo < ArgInfo.size()); 1079 return std::make_pair(ArgInfo[ArgNo].FirstArgIndex, 1080 ArgInfo[ArgNo].NumberOfArgs); 1081 } 1082 1083 private: 1084 void construct(const ASTContext &Context, const CGFunctionInfo &FI, 1085 bool OnlyRequiredArgs); 1086 }; 1087 1088 void ClangToLLVMArgMapping::construct(const ASTContext &Context, 1089 const CGFunctionInfo &FI, 1090 bool OnlyRequiredArgs) { 1091 unsigned IRArgNo = 0; 1092 bool SwapThisWithSRet = false; 1093 const ABIArgInfo &RetAI = FI.getReturnInfo(); 1094 1095 if (RetAI.getKind() == ABIArgInfo::Indirect) { 1096 SwapThisWithSRet = RetAI.isSRetAfterThis(); 1097 SRetArgNo = SwapThisWithSRet ? 1 : IRArgNo++; 1098 } 1099 1100 unsigned ArgNo = 0; 1101 unsigned NumArgs = OnlyRequiredArgs ? FI.getNumRequiredArgs() : FI.arg_size(); 1102 for (CGFunctionInfo::const_arg_iterator I = FI.arg_begin(); ArgNo < NumArgs; 1103 ++I, ++ArgNo) { 1104 assert(I != FI.arg_end()); 1105 QualType ArgType = I->type; 1106 const ABIArgInfo &AI = I->info; 1107 // Collect data about IR arguments corresponding to Clang argument ArgNo. 1108 auto &IRArgs = ArgInfo[ArgNo]; 1109 1110 if (AI.getPaddingType()) 1111 IRArgs.PaddingArgIndex = IRArgNo++; 1112 1113 switch (AI.getKind()) { 1114 case ABIArgInfo::Extend: 1115 case ABIArgInfo::Direct: { 1116 // FIXME: handle sseregparm someday... 1117 llvm::StructType *STy = dyn_cast<llvm::StructType>(AI.getCoerceToType()); 1118 if (AI.isDirect() && AI.getCanBeFlattened() && STy) { 1119 IRArgs.NumberOfArgs = STy->getNumElements(); 1120 } else { 1121 IRArgs.NumberOfArgs = 1; 1122 } 1123 break; 1124 } 1125 case ABIArgInfo::Indirect: 1126 IRArgs.NumberOfArgs = 1; 1127 break; 1128 case ABIArgInfo::Ignore: 1129 case ABIArgInfo::InAlloca: 1130 // ignore and inalloca doesn't have matching LLVM parameters. 1131 IRArgs.NumberOfArgs = 0; 1132 break; 1133 case ABIArgInfo::Expand: { 1134 IRArgs.NumberOfArgs = getExpansionSize(ArgType, Context); 1135 break; 1136 } 1137 } 1138 1139 if (IRArgs.NumberOfArgs > 0) { 1140 IRArgs.FirstArgIndex = IRArgNo; 1141 IRArgNo += IRArgs.NumberOfArgs; 1142 } 1143 1144 // Skip over the sret parameter when it comes second. We already handled it 1145 // above. 1146 if (IRArgNo == 1 && SwapThisWithSRet) 1147 IRArgNo++; 1148 } 1149 assert(ArgNo == ArgInfo.size()); 1150 1151 if (FI.usesInAlloca()) 1152 InallocaArgNo = IRArgNo++; 1153 1154 TotalIRArgs = IRArgNo; 1155 } 1156 } // namespace 1157 1158 /***/ 1159 1160 bool CodeGenModule::ReturnTypeUsesSRet(const CGFunctionInfo &FI) { 1161 return FI.getReturnInfo().isIndirect(); 1162 } 1163 1164 bool CodeGenModule::ReturnSlotInterferesWithArgs(const CGFunctionInfo &FI) { 1165 return ReturnTypeUsesSRet(FI) && 1166 getTargetCodeGenInfo().doesReturnSlotInterfereWithArgs(); 1167 } 1168 1169 bool CodeGenModule::ReturnTypeUsesFPRet(QualType ResultType) { 1170 if (const BuiltinType *BT = ResultType->getAs<BuiltinType>()) { 1171 switch (BT->getKind()) { 1172 default: 1173 return false; 1174 case BuiltinType::Float: 1175 return getTarget().useObjCFPRetForRealType(TargetInfo::Float); 1176 case BuiltinType::Double: 1177 return getTarget().useObjCFPRetForRealType(TargetInfo::Double); 1178 case BuiltinType::LongDouble: 1179 return getTarget().useObjCFPRetForRealType(TargetInfo::LongDouble); 1180 } 1181 } 1182 1183 return false; 1184 } 1185 1186 bool CodeGenModule::ReturnTypeUsesFP2Ret(QualType ResultType) { 1187 if (const ComplexType *CT = ResultType->getAs<ComplexType>()) { 1188 if (const BuiltinType *BT = CT->getElementType()->getAs<BuiltinType>()) { 1189 if (BT->getKind() == BuiltinType::LongDouble) 1190 return getTarget().useObjCFP2RetForComplexLongDouble(); 1191 } 1192 } 1193 1194 return false; 1195 } 1196 1197 llvm::FunctionType *CodeGenTypes::GetFunctionType(GlobalDecl GD) { 1198 const CGFunctionInfo &FI = arrangeGlobalDeclaration(GD); 1199 return GetFunctionType(FI); 1200 } 1201 1202 llvm::FunctionType * 1203 CodeGenTypes::GetFunctionType(const CGFunctionInfo &FI) { 1204 1205 bool Inserted = FunctionsBeingProcessed.insert(&FI); (void)Inserted; 1206 assert(Inserted && "Recursively being processed?"); 1207 1208 llvm::Type *resultType = nullptr; 1209 const ABIArgInfo &retAI = FI.getReturnInfo(); 1210 switch (retAI.getKind()) { 1211 case ABIArgInfo::Expand: 1212 llvm_unreachable("Invalid ABI kind for return argument"); 1213 1214 case ABIArgInfo::Extend: 1215 case ABIArgInfo::Direct: 1216 resultType = retAI.getCoerceToType(); 1217 break; 1218 1219 case ABIArgInfo::InAlloca: 1220 if (retAI.getInAllocaSRet()) { 1221 // sret things on win32 aren't void, they return the sret pointer. 1222 QualType ret = FI.getReturnType(); 1223 llvm::Type *ty = ConvertType(ret); 1224 unsigned addressSpace = Context.getTargetAddressSpace(ret); 1225 resultType = llvm::PointerType::get(ty, addressSpace); 1226 } else { 1227 resultType = llvm::Type::getVoidTy(getLLVMContext()); 1228 } 1229 break; 1230 1231 case ABIArgInfo::Indirect: { 1232 assert(!retAI.getIndirectAlign() && "Align unused on indirect return."); 1233 resultType = llvm::Type::getVoidTy(getLLVMContext()); 1234 break; 1235 } 1236 1237 case ABIArgInfo::Ignore: 1238 resultType = llvm::Type::getVoidTy(getLLVMContext()); 1239 break; 1240 } 1241 1242 ClangToLLVMArgMapping IRFunctionArgs(getContext(), FI, true); 1243 SmallVector<llvm::Type*, 8> ArgTypes(IRFunctionArgs.totalIRArgs()); 1244 1245 // Add type for sret argument. 1246 if (IRFunctionArgs.hasSRetArg()) { 1247 QualType Ret = FI.getReturnType(); 1248 llvm::Type *Ty = ConvertType(Ret); 1249 unsigned AddressSpace = Context.getTargetAddressSpace(Ret); 1250 ArgTypes[IRFunctionArgs.getSRetArgNo()] = 1251 llvm::PointerType::get(Ty, AddressSpace); 1252 } 1253 1254 // Add type for inalloca argument. 1255 if (IRFunctionArgs.hasInallocaArg()) { 1256 auto ArgStruct = FI.getArgStruct(); 1257 assert(ArgStruct); 1258 ArgTypes[IRFunctionArgs.getInallocaArgNo()] = ArgStruct->getPointerTo(); 1259 } 1260 1261 // Add in all of the required arguments. 1262 unsigned ArgNo = 0; 1263 CGFunctionInfo::const_arg_iterator it = FI.arg_begin(), 1264 ie = it + FI.getNumRequiredArgs(); 1265 for (; it != ie; ++it, ++ArgNo) { 1266 const ABIArgInfo &ArgInfo = it->info; 1267 1268 // Insert a padding type to ensure proper alignment. 1269 if (IRFunctionArgs.hasPaddingArg(ArgNo)) 1270 ArgTypes[IRFunctionArgs.getPaddingArgNo(ArgNo)] = 1271 ArgInfo.getPaddingType(); 1272 1273 unsigned FirstIRArg, NumIRArgs; 1274 std::tie(FirstIRArg, NumIRArgs) = IRFunctionArgs.getIRArgs(ArgNo); 1275 1276 switch (ArgInfo.getKind()) { 1277 case ABIArgInfo::Ignore: 1278 case ABIArgInfo::InAlloca: 1279 assert(NumIRArgs == 0); 1280 break; 1281 1282 case ABIArgInfo::Indirect: { 1283 assert(NumIRArgs == 1); 1284 // indirect arguments are always on the stack, which is addr space #0. 1285 llvm::Type *LTy = ConvertTypeForMem(it->type); 1286 ArgTypes[FirstIRArg] = LTy->getPointerTo(); 1287 break; 1288 } 1289 1290 case ABIArgInfo::Extend: 1291 case ABIArgInfo::Direct: { 1292 // Fast-isel and the optimizer generally like scalar values better than 1293 // FCAs, so we flatten them if this is safe to do for this argument. 1294 llvm::Type *argType = ArgInfo.getCoerceToType(); 1295 llvm::StructType *st = dyn_cast<llvm::StructType>(argType); 1296 if (st && ArgInfo.isDirect() && ArgInfo.getCanBeFlattened()) { 1297 assert(NumIRArgs == st->getNumElements()); 1298 for (unsigned i = 0, e = st->getNumElements(); i != e; ++i) 1299 ArgTypes[FirstIRArg + i] = st->getElementType(i); 1300 } else { 1301 assert(NumIRArgs == 1); 1302 ArgTypes[FirstIRArg] = argType; 1303 } 1304 break; 1305 } 1306 1307 case ABIArgInfo::Expand: 1308 auto ArgTypesIter = ArgTypes.begin() + FirstIRArg; 1309 getExpandedTypes(it->type, ArgTypesIter); 1310 assert(ArgTypesIter == ArgTypes.begin() + FirstIRArg + NumIRArgs); 1311 break; 1312 } 1313 } 1314 1315 bool Erased = FunctionsBeingProcessed.erase(&FI); (void)Erased; 1316 assert(Erased && "Not in set?"); 1317 1318 return llvm::FunctionType::get(resultType, ArgTypes, FI.isVariadic()); 1319 } 1320 1321 llvm::Type *CodeGenTypes::GetFunctionTypeForVTable(GlobalDecl GD) { 1322 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl()); 1323 const FunctionProtoType *FPT = MD->getType()->getAs<FunctionProtoType>(); 1324 1325 if (!isFuncTypeConvertible(FPT)) 1326 return llvm::StructType::get(getLLVMContext()); 1327 1328 const CGFunctionInfo *Info; 1329 if (isa<CXXDestructorDecl>(MD)) 1330 Info = 1331 &arrangeCXXStructorDeclaration(MD, getFromDtorType(GD.getDtorType())); 1332 else 1333 Info = &arrangeCXXMethodDeclaration(MD); 1334 return GetFunctionType(*Info); 1335 } 1336 1337 void CodeGenModule::ConstructAttributeList(const CGFunctionInfo &FI, 1338 const Decl *TargetDecl, 1339 AttributeListType &PAL, 1340 unsigned &CallingConv, 1341 bool AttrOnCallSite) { 1342 llvm::AttrBuilder FuncAttrs; 1343 llvm::AttrBuilder RetAttrs; 1344 1345 CallingConv = FI.getEffectiveCallingConvention(); 1346 1347 if (FI.isNoReturn()) 1348 FuncAttrs.addAttribute(llvm::Attribute::NoReturn); 1349 1350 // FIXME: handle sseregparm someday... 1351 if (TargetDecl) { 1352 if (TargetDecl->hasAttr<ReturnsTwiceAttr>()) 1353 FuncAttrs.addAttribute(llvm::Attribute::ReturnsTwice); 1354 if (TargetDecl->hasAttr<NoThrowAttr>()) 1355 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind); 1356 if (TargetDecl->hasAttr<NoReturnAttr>()) 1357 FuncAttrs.addAttribute(llvm::Attribute::NoReturn); 1358 if (TargetDecl->hasAttr<NoDuplicateAttr>()) 1359 FuncAttrs.addAttribute(llvm::Attribute::NoDuplicate); 1360 1361 if (const FunctionDecl *Fn = dyn_cast<FunctionDecl>(TargetDecl)) { 1362 const FunctionProtoType *FPT = Fn->getType()->getAs<FunctionProtoType>(); 1363 if (FPT && FPT->isNothrow(getContext())) 1364 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind); 1365 // Don't use [[noreturn]] or _Noreturn for a call to a virtual function. 1366 // These attributes are not inherited by overloads. 1367 const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(Fn); 1368 if (Fn->isNoReturn() && !(AttrOnCallSite && MD && MD->isVirtual())) 1369 FuncAttrs.addAttribute(llvm::Attribute::NoReturn); 1370 } 1371 1372 // 'const' and 'pure' attribute functions are also nounwind. 1373 if (TargetDecl->hasAttr<ConstAttr>()) { 1374 FuncAttrs.addAttribute(llvm::Attribute::ReadNone); 1375 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind); 1376 } else if (TargetDecl->hasAttr<PureAttr>()) { 1377 FuncAttrs.addAttribute(llvm::Attribute::ReadOnly); 1378 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind); 1379 } 1380 if (TargetDecl->hasAttr<MallocAttr>()) 1381 RetAttrs.addAttribute(llvm::Attribute::NoAlias); 1382 if (TargetDecl->hasAttr<ReturnsNonNullAttr>()) 1383 RetAttrs.addAttribute(llvm::Attribute::NonNull); 1384 } 1385 1386 if (CodeGenOpts.OptimizeSize) 1387 FuncAttrs.addAttribute(llvm::Attribute::OptimizeForSize); 1388 if (CodeGenOpts.OptimizeSize == 2) 1389 FuncAttrs.addAttribute(llvm::Attribute::MinSize); 1390 if (CodeGenOpts.DisableRedZone) 1391 FuncAttrs.addAttribute(llvm::Attribute::NoRedZone); 1392 if (CodeGenOpts.NoImplicitFloat) 1393 FuncAttrs.addAttribute(llvm::Attribute::NoImplicitFloat); 1394 if (CodeGenOpts.EnableSegmentedStacks && 1395 !(TargetDecl && TargetDecl->hasAttr<NoSplitStackAttr>())) 1396 FuncAttrs.addAttribute("split-stack"); 1397 1398 if (AttrOnCallSite) { 1399 // Attributes that should go on the call site only. 1400 if (!CodeGenOpts.SimplifyLibCalls) 1401 FuncAttrs.addAttribute(llvm::Attribute::NoBuiltin); 1402 } else { 1403 // Attributes that should go on the function, but not the call site. 1404 if (!CodeGenOpts.DisableFPElim) { 1405 FuncAttrs.addAttribute("no-frame-pointer-elim", "false"); 1406 } else if (CodeGenOpts.OmitLeafFramePointer) { 1407 FuncAttrs.addAttribute("no-frame-pointer-elim", "false"); 1408 FuncAttrs.addAttribute("no-frame-pointer-elim-non-leaf"); 1409 } else { 1410 FuncAttrs.addAttribute("no-frame-pointer-elim", "true"); 1411 FuncAttrs.addAttribute("no-frame-pointer-elim-non-leaf"); 1412 } 1413 1414 FuncAttrs.addAttribute("less-precise-fpmad", 1415 llvm::toStringRef(CodeGenOpts.LessPreciseFPMAD)); 1416 FuncAttrs.addAttribute("no-infs-fp-math", 1417 llvm::toStringRef(CodeGenOpts.NoInfsFPMath)); 1418 FuncAttrs.addAttribute("no-nans-fp-math", 1419 llvm::toStringRef(CodeGenOpts.NoNaNsFPMath)); 1420 FuncAttrs.addAttribute("unsafe-fp-math", 1421 llvm::toStringRef(CodeGenOpts.UnsafeFPMath)); 1422 FuncAttrs.addAttribute("use-soft-float", 1423 llvm::toStringRef(CodeGenOpts.SoftFloat)); 1424 FuncAttrs.addAttribute("stack-protector-buffer-size", 1425 llvm::utostr(CodeGenOpts.SSPBufferSize)); 1426 1427 if (!CodeGenOpts.StackRealignment) 1428 FuncAttrs.addAttribute("no-realign-stack"); 1429 } 1430 1431 ClangToLLVMArgMapping IRFunctionArgs(getContext(), FI); 1432 1433 QualType RetTy = FI.getReturnType(); 1434 const ABIArgInfo &RetAI = FI.getReturnInfo(); 1435 switch (RetAI.getKind()) { 1436 case ABIArgInfo::Extend: 1437 if (RetTy->hasSignedIntegerRepresentation()) 1438 RetAttrs.addAttribute(llvm::Attribute::SExt); 1439 else if (RetTy->hasUnsignedIntegerRepresentation()) 1440 RetAttrs.addAttribute(llvm::Attribute::ZExt); 1441 // FALL THROUGH 1442 case ABIArgInfo::Direct: 1443 if (RetAI.getInReg()) 1444 RetAttrs.addAttribute(llvm::Attribute::InReg); 1445 break; 1446 case ABIArgInfo::Ignore: 1447 break; 1448 1449 case ABIArgInfo::InAlloca: 1450 case ABIArgInfo::Indirect: { 1451 // inalloca and sret disable readnone and readonly 1452 FuncAttrs.removeAttribute(llvm::Attribute::ReadOnly) 1453 .removeAttribute(llvm::Attribute::ReadNone); 1454 break; 1455 } 1456 1457 case ABIArgInfo::Expand: 1458 llvm_unreachable("Invalid ABI kind for return argument"); 1459 } 1460 1461 if (const auto *RefTy = RetTy->getAs<ReferenceType>()) { 1462 QualType PTy = RefTy->getPointeeType(); 1463 if (!PTy->isIncompleteType() && PTy->isConstantSizeType()) 1464 RetAttrs.addDereferenceableAttr(getContext().getTypeSizeInChars(PTy) 1465 .getQuantity()); 1466 else if (getContext().getTargetAddressSpace(PTy) == 0) 1467 RetAttrs.addAttribute(llvm::Attribute::NonNull); 1468 } 1469 1470 // Attach return attributes. 1471 if (RetAttrs.hasAttributes()) { 1472 PAL.push_back(llvm::AttributeSet::get( 1473 getLLVMContext(), llvm::AttributeSet::ReturnIndex, RetAttrs)); 1474 } 1475 1476 // Attach attributes to sret. 1477 if (IRFunctionArgs.hasSRetArg()) { 1478 llvm::AttrBuilder SRETAttrs; 1479 SRETAttrs.addAttribute(llvm::Attribute::StructRet); 1480 if (RetAI.getInReg()) 1481 SRETAttrs.addAttribute(llvm::Attribute::InReg); 1482 PAL.push_back(llvm::AttributeSet::get( 1483 getLLVMContext(), IRFunctionArgs.getSRetArgNo() + 1, SRETAttrs)); 1484 } 1485 1486 // Attach attributes to inalloca argument. 1487 if (IRFunctionArgs.hasInallocaArg()) { 1488 llvm::AttrBuilder Attrs; 1489 Attrs.addAttribute(llvm::Attribute::InAlloca); 1490 PAL.push_back(llvm::AttributeSet::get( 1491 getLLVMContext(), IRFunctionArgs.getInallocaArgNo() + 1, Attrs)); 1492 } 1493 1494 1495 unsigned ArgNo = 0; 1496 for (CGFunctionInfo::const_arg_iterator I = FI.arg_begin(), 1497 E = FI.arg_end(); 1498 I != E; ++I, ++ArgNo) { 1499 QualType ParamType = I->type; 1500 const ABIArgInfo &AI = I->info; 1501 llvm::AttrBuilder Attrs; 1502 1503 // Add attribute for padding argument, if necessary. 1504 if (IRFunctionArgs.hasPaddingArg(ArgNo)) { 1505 if (AI.getPaddingInReg()) 1506 PAL.push_back(llvm::AttributeSet::get( 1507 getLLVMContext(), IRFunctionArgs.getPaddingArgNo(ArgNo) + 1, 1508 llvm::Attribute::InReg)); 1509 } 1510 1511 // 'restrict' -> 'noalias' is done in EmitFunctionProlog when we 1512 // have the corresponding parameter variable. It doesn't make 1513 // sense to do it here because parameters are so messed up. 1514 switch (AI.getKind()) { 1515 case ABIArgInfo::Extend: 1516 if (ParamType->isSignedIntegerOrEnumerationType()) 1517 Attrs.addAttribute(llvm::Attribute::SExt); 1518 else if (ParamType->isUnsignedIntegerOrEnumerationType()) 1519 Attrs.addAttribute(llvm::Attribute::ZExt); 1520 // FALL THROUGH 1521 case ABIArgInfo::Direct: 1522 if (AI.getInReg()) 1523 Attrs.addAttribute(llvm::Attribute::InReg); 1524 break; 1525 1526 case ABIArgInfo::Indirect: 1527 if (AI.getInReg()) 1528 Attrs.addAttribute(llvm::Attribute::InReg); 1529 1530 if (AI.getIndirectByVal()) 1531 Attrs.addAttribute(llvm::Attribute::ByVal); 1532 1533 Attrs.addAlignmentAttr(AI.getIndirectAlign()); 1534 1535 // byval disables readnone and readonly. 1536 FuncAttrs.removeAttribute(llvm::Attribute::ReadOnly) 1537 .removeAttribute(llvm::Attribute::ReadNone); 1538 break; 1539 1540 case ABIArgInfo::Ignore: 1541 case ABIArgInfo::Expand: 1542 continue; 1543 1544 case ABIArgInfo::InAlloca: 1545 // inalloca disables readnone and readonly. 1546 FuncAttrs.removeAttribute(llvm::Attribute::ReadOnly) 1547 .removeAttribute(llvm::Attribute::ReadNone); 1548 continue; 1549 } 1550 1551 if (const auto *RefTy = ParamType->getAs<ReferenceType>()) { 1552 QualType PTy = RefTy->getPointeeType(); 1553 if (!PTy->isIncompleteType() && PTy->isConstantSizeType()) 1554 Attrs.addDereferenceableAttr(getContext().getTypeSizeInChars(PTy) 1555 .getQuantity()); 1556 else if (getContext().getTargetAddressSpace(PTy) == 0) 1557 Attrs.addAttribute(llvm::Attribute::NonNull); 1558 } 1559 1560 if (Attrs.hasAttributes()) { 1561 unsigned FirstIRArg, NumIRArgs; 1562 std::tie(FirstIRArg, NumIRArgs) = IRFunctionArgs.getIRArgs(ArgNo); 1563 for (unsigned i = 0; i < NumIRArgs; i++) 1564 PAL.push_back(llvm::AttributeSet::get(getLLVMContext(), 1565 FirstIRArg + i + 1, Attrs)); 1566 } 1567 } 1568 assert(ArgNo == FI.arg_size()); 1569 1570 if (FuncAttrs.hasAttributes()) 1571 PAL.push_back(llvm:: 1572 AttributeSet::get(getLLVMContext(), 1573 llvm::AttributeSet::FunctionIndex, 1574 FuncAttrs)); 1575 } 1576 1577 /// An argument came in as a promoted argument; demote it back to its 1578 /// declared type. 1579 static llvm::Value *emitArgumentDemotion(CodeGenFunction &CGF, 1580 const VarDecl *var, 1581 llvm::Value *value) { 1582 llvm::Type *varType = CGF.ConvertType(var->getType()); 1583 1584 // This can happen with promotions that actually don't change the 1585 // underlying type, like the enum promotions. 1586 if (value->getType() == varType) return value; 1587 1588 assert((varType->isIntegerTy() || varType->isFloatingPointTy()) 1589 && "unexpected promotion type"); 1590 1591 if (isa<llvm::IntegerType>(varType)) 1592 return CGF.Builder.CreateTrunc(value, varType, "arg.unpromote"); 1593 1594 return CGF.Builder.CreateFPCast(value, varType, "arg.unpromote"); 1595 } 1596 1597 /// Returns the attribute (either parameter attribute, or function 1598 /// attribute), which declares argument ArgNo to be non-null. 1599 static const NonNullAttr *getNonNullAttr(const Decl *FD, const ParmVarDecl *PVD, 1600 QualType ArgType, unsigned ArgNo) { 1601 // FIXME: __attribute__((nonnull)) can also be applied to: 1602 // - references to pointers, where the pointee is known to be 1603 // nonnull (apparently a Clang extension) 1604 // - transparent unions containing pointers 1605 // In the former case, LLVM IR cannot represent the constraint. In 1606 // the latter case, we have no guarantee that the transparent union 1607 // is in fact passed as a pointer. 1608 if (!ArgType->isAnyPointerType() && !ArgType->isBlockPointerType()) 1609 return nullptr; 1610 // First, check attribute on parameter itself. 1611 if (PVD) { 1612 if (auto ParmNNAttr = PVD->getAttr<NonNullAttr>()) 1613 return ParmNNAttr; 1614 } 1615 // Check function attributes. 1616 if (!FD) 1617 return nullptr; 1618 for (const auto *NNAttr : FD->specific_attrs<NonNullAttr>()) { 1619 if (NNAttr->isNonNull(ArgNo)) 1620 return NNAttr; 1621 } 1622 return nullptr; 1623 } 1624 1625 void CodeGenFunction::EmitFunctionProlog(const CGFunctionInfo &FI, 1626 llvm::Function *Fn, 1627 const FunctionArgList &Args) { 1628 if (CurCodeDecl && CurCodeDecl->hasAttr<NakedAttr>()) 1629 // Naked functions don't have prologues. 1630 return; 1631 1632 // If this is an implicit-return-zero function, go ahead and 1633 // initialize the return value. TODO: it might be nice to have 1634 // a more general mechanism for this that didn't require synthesized 1635 // return statements. 1636 if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(CurCodeDecl)) { 1637 if (FD->hasImplicitReturnZero()) { 1638 QualType RetTy = FD->getReturnType().getUnqualifiedType(); 1639 llvm::Type* LLVMTy = CGM.getTypes().ConvertType(RetTy); 1640 llvm::Constant* Zero = llvm::Constant::getNullValue(LLVMTy); 1641 Builder.CreateStore(Zero, ReturnValue); 1642 } 1643 } 1644 1645 // FIXME: We no longer need the types from FunctionArgList; lift up and 1646 // simplify. 1647 1648 ClangToLLVMArgMapping IRFunctionArgs(CGM.getContext(), FI); 1649 // Flattened function arguments. 1650 SmallVector<llvm::Argument *, 16> FnArgs; 1651 FnArgs.reserve(IRFunctionArgs.totalIRArgs()); 1652 for (auto &Arg : Fn->args()) { 1653 FnArgs.push_back(&Arg); 1654 } 1655 assert(FnArgs.size() == IRFunctionArgs.totalIRArgs()); 1656 1657 // If we're using inalloca, all the memory arguments are GEPs off of the last 1658 // parameter, which is a pointer to the complete memory area. 1659 llvm::Value *ArgStruct = nullptr; 1660 if (IRFunctionArgs.hasInallocaArg()) { 1661 ArgStruct = FnArgs[IRFunctionArgs.getInallocaArgNo()]; 1662 assert(ArgStruct->getType() == FI.getArgStruct()->getPointerTo()); 1663 } 1664 1665 // Name the struct return parameter. 1666 if (IRFunctionArgs.hasSRetArg()) { 1667 auto AI = FnArgs[IRFunctionArgs.getSRetArgNo()]; 1668 AI->setName("agg.result"); 1669 AI->addAttr(llvm::AttributeSet::get(getLLVMContext(), AI->getArgNo() + 1, 1670 llvm::Attribute::NoAlias)); 1671 } 1672 1673 // Track if we received the parameter as a pointer (indirect, byval, or 1674 // inalloca). If already have a pointer, EmitParmDecl doesn't need to copy it 1675 // into a local alloca for us. 1676 enum ValOrPointer { HaveValue = 0, HavePointer = 1 }; 1677 typedef llvm::PointerIntPair<llvm::Value *, 1> ValueAndIsPtr; 1678 SmallVector<ValueAndIsPtr, 16> ArgVals; 1679 ArgVals.reserve(Args.size()); 1680 1681 // Create a pointer value for every parameter declaration. This usually 1682 // entails copying one or more LLVM IR arguments into an alloca. Don't push 1683 // any cleanups or do anything that might unwind. We do that separately, so 1684 // we can push the cleanups in the correct order for the ABI. 1685 assert(FI.arg_size() == Args.size() && 1686 "Mismatch between function signature & arguments."); 1687 unsigned ArgNo = 0; 1688 CGFunctionInfo::const_arg_iterator info_it = FI.arg_begin(); 1689 for (FunctionArgList::const_iterator i = Args.begin(), e = Args.end(); 1690 i != e; ++i, ++info_it, ++ArgNo) { 1691 const VarDecl *Arg = *i; 1692 QualType Ty = info_it->type; 1693 const ABIArgInfo &ArgI = info_it->info; 1694 1695 bool isPromoted = 1696 isa<ParmVarDecl>(Arg) && cast<ParmVarDecl>(Arg)->isKNRPromoted(); 1697 1698 unsigned FirstIRArg, NumIRArgs; 1699 std::tie(FirstIRArg, NumIRArgs) = IRFunctionArgs.getIRArgs(ArgNo); 1700 1701 switch (ArgI.getKind()) { 1702 case ABIArgInfo::InAlloca: { 1703 assert(NumIRArgs == 0); 1704 llvm::Value *V = Builder.CreateStructGEP( 1705 ArgStruct, ArgI.getInAllocaFieldIndex(), Arg->getName()); 1706 ArgVals.push_back(ValueAndIsPtr(V, HavePointer)); 1707 break; 1708 } 1709 1710 case ABIArgInfo::Indirect: { 1711 assert(NumIRArgs == 1); 1712 llvm::Value *V = FnArgs[FirstIRArg]; 1713 1714 if (!hasScalarEvaluationKind(Ty)) { 1715 // Aggregates and complex variables are accessed by reference. All we 1716 // need to do is realign the value, if requested 1717 if (ArgI.getIndirectRealign()) { 1718 llvm::Value *AlignedTemp = CreateMemTemp(Ty, "coerce"); 1719 1720 // Copy from the incoming argument pointer to the temporary with the 1721 // appropriate alignment. 1722 // 1723 // FIXME: We should have a common utility for generating an aggregate 1724 // copy. 1725 llvm::Type *I8PtrTy = Builder.getInt8PtrTy(); 1726 CharUnits Size = getContext().getTypeSizeInChars(Ty); 1727 llvm::Value *Dst = Builder.CreateBitCast(AlignedTemp, I8PtrTy); 1728 llvm::Value *Src = Builder.CreateBitCast(V, I8PtrTy); 1729 Builder.CreateMemCpy(Dst, 1730 Src, 1731 llvm::ConstantInt::get(IntPtrTy, 1732 Size.getQuantity()), 1733 ArgI.getIndirectAlign(), 1734 false); 1735 V = AlignedTemp; 1736 } 1737 ArgVals.push_back(ValueAndIsPtr(V, HavePointer)); 1738 } else { 1739 // Load scalar value from indirect argument. 1740 CharUnits Alignment = getContext().getTypeAlignInChars(Ty); 1741 V = EmitLoadOfScalar(V, false, Alignment.getQuantity(), Ty, 1742 Arg->getLocStart()); 1743 1744 if (isPromoted) 1745 V = emitArgumentDemotion(*this, Arg, V); 1746 ArgVals.push_back(ValueAndIsPtr(V, HaveValue)); 1747 } 1748 break; 1749 } 1750 1751 case ABIArgInfo::Extend: 1752 case ABIArgInfo::Direct: { 1753 1754 // If we have the trivial case, handle it with no muss and fuss. 1755 if (!isa<llvm::StructType>(ArgI.getCoerceToType()) && 1756 ArgI.getCoerceToType() == ConvertType(Ty) && 1757 ArgI.getDirectOffset() == 0) { 1758 assert(NumIRArgs == 1); 1759 auto AI = FnArgs[FirstIRArg]; 1760 llvm::Value *V = AI; 1761 1762 if (const ParmVarDecl *PVD = dyn_cast<ParmVarDecl>(Arg)) { 1763 if (getNonNullAttr(CurCodeDecl, PVD, PVD->getType(), 1764 PVD->getFunctionScopeIndex())) 1765 AI->addAttr(llvm::AttributeSet::get(getLLVMContext(), 1766 AI->getArgNo() + 1, 1767 llvm::Attribute::NonNull)); 1768 1769 QualType OTy = PVD->getOriginalType(); 1770 if (const auto *ArrTy = 1771 getContext().getAsConstantArrayType(OTy)) { 1772 // A C99 array parameter declaration with the static keyword also 1773 // indicates dereferenceability, and if the size is constant we can 1774 // use the dereferenceable attribute (which requires the size in 1775 // bytes). 1776 if (ArrTy->getSizeModifier() == ArrayType::Static) { 1777 QualType ETy = ArrTy->getElementType(); 1778 uint64_t ArrSize = ArrTy->getSize().getZExtValue(); 1779 if (!ETy->isIncompleteType() && ETy->isConstantSizeType() && 1780 ArrSize) { 1781 llvm::AttrBuilder Attrs; 1782 Attrs.addDereferenceableAttr( 1783 getContext().getTypeSizeInChars(ETy).getQuantity()*ArrSize); 1784 AI->addAttr(llvm::AttributeSet::get(getLLVMContext(), 1785 AI->getArgNo() + 1, Attrs)); 1786 } else if (getContext().getTargetAddressSpace(ETy) == 0) { 1787 AI->addAttr(llvm::AttributeSet::get(getLLVMContext(), 1788 AI->getArgNo() + 1, 1789 llvm::Attribute::NonNull)); 1790 } 1791 } 1792 } else if (const auto *ArrTy = 1793 getContext().getAsVariableArrayType(OTy)) { 1794 // For C99 VLAs with the static keyword, we don't know the size so 1795 // we can't use the dereferenceable attribute, but in addrspace(0) 1796 // we know that it must be nonnull. 1797 if (ArrTy->getSizeModifier() == VariableArrayType::Static && 1798 !getContext().getTargetAddressSpace(ArrTy->getElementType())) 1799 AI->addAttr(llvm::AttributeSet::get(getLLVMContext(), 1800 AI->getArgNo() + 1, 1801 llvm::Attribute::NonNull)); 1802 } 1803 1804 const auto *AVAttr = PVD->getAttr<AlignValueAttr>(); 1805 if (!AVAttr) 1806 if (const auto *TOTy = dyn_cast<TypedefType>(OTy)) 1807 AVAttr = TOTy->getDecl()->getAttr<AlignValueAttr>(); 1808 if (AVAttr) { 1809 llvm::Value *AlignmentValue = 1810 EmitScalarExpr(AVAttr->getAlignment()); 1811 llvm::ConstantInt *AlignmentCI = 1812 cast<llvm::ConstantInt>(AlignmentValue); 1813 unsigned Alignment = 1814 std::min((unsigned) AlignmentCI->getZExtValue(), 1815 +llvm::Value::MaximumAlignment); 1816 1817 llvm::AttrBuilder Attrs; 1818 Attrs.addAlignmentAttr(Alignment); 1819 AI->addAttr(llvm::AttributeSet::get(getLLVMContext(), 1820 AI->getArgNo() + 1, Attrs)); 1821 } 1822 } 1823 1824 if (Arg->getType().isRestrictQualified()) 1825 AI->addAttr(llvm::AttributeSet::get(getLLVMContext(), 1826 AI->getArgNo() + 1, 1827 llvm::Attribute::NoAlias)); 1828 1829 // Ensure the argument is the correct type. 1830 if (V->getType() != ArgI.getCoerceToType()) 1831 V = Builder.CreateBitCast(V, ArgI.getCoerceToType()); 1832 1833 if (isPromoted) 1834 V = emitArgumentDemotion(*this, Arg, V); 1835 1836 if (const CXXMethodDecl *MD = 1837 dyn_cast_or_null<CXXMethodDecl>(CurCodeDecl)) { 1838 if (MD->isVirtual() && Arg == CXXABIThisDecl) 1839 V = CGM.getCXXABI(). 1840 adjustThisParameterInVirtualFunctionPrologue(*this, CurGD, V); 1841 } 1842 1843 // Because of merging of function types from multiple decls it is 1844 // possible for the type of an argument to not match the corresponding 1845 // type in the function type. Since we are codegening the callee 1846 // in here, add a cast to the argument type. 1847 llvm::Type *LTy = ConvertType(Arg->getType()); 1848 if (V->getType() != LTy) 1849 V = Builder.CreateBitCast(V, LTy); 1850 1851 ArgVals.push_back(ValueAndIsPtr(V, HaveValue)); 1852 break; 1853 } 1854 1855 llvm::AllocaInst *Alloca = CreateMemTemp(Ty, Arg->getName()); 1856 1857 // The alignment we need to use is the max of the requested alignment for 1858 // the argument plus the alignment required by our access code below. 1859 unsigned AlignmentToUse = 1860 CGM.getDataLayout().getABITypeAlignment(ArgI.getCoerceToType()); 1861 AlignmentToUse = std::max(AlignmentToUse, 1862 (unsigned)getContext().getDeclAlign(Arg).getQuantity()); 1863 1864 Alloca->setAlignment(AlignmentToUse); 1865 llvm::Value *V = Alloca; 1866 llvm::Value *Ptr = V; // Pointer to store into. 1867 1868 // If the value is offset in memory, apply the offset now. 1869 if (unsigned Offs = ArgI.getDirectOffset()) { 1870 Ptr = Builder.CreateBitCast(Ptr, Builder.getInt8PtrTy()); 1871 Ptr = Builder.CreateConstGEP1_32(Ptr, Offs); 1872 Ptr = Builder.CreateBitCast(Ptr, 1873 llvm::PointerType::getUnqual(ArgI.getCoerceToType())); 1874 } 1875 1876 // Fast-isel and the optimizer generally like scalar values better than 1877 // FCAs, so we flatten them if this is safe to do for this argument. 1878 llvm::StructType *STy = dyn_cast<llvm::StructType>(ArgI.getCoerceToType()); 1879 if (ArgI.isDirect() && ArgI.getCanBeFlattened() && STy && 1880 STy->getNumElements() > 1) { 1881 uint64_t SrcSize = CGM.getDataLayout().getTypeAllocSize(STy); 1882 llvm::Type *DstTy = 1883 cast<llvm::PointerType>(Ptr->getType())->getElementType(); 1884 uint64_t DstSize = CGM.getDataLayout().getTypeAllocSize(DstTy); 1885 1886 if (SrcSize <= DstSize) { 1887 Ptr = Builder.CreateBitCast(Ptr, llvm::PointerType::getUnqual(STy)); 1888 1889 assert(STy->getNumElements() == NumIRArgs); 1890 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) { 1891 auto AI = FnArgs[FirstIRArg + i]; 1892 AI->setName(Arg->getName() + ".coerce" + Twine(i)); 1893 llvm::Value *EltPtr = Builder.CreateConstGEP2_32(Ptr, 0, i); 1894 Builder.CreateStore(AI, EltPtr); 1895 } 1896 } else { 1897 llvm::AllocaInst *TempAlloca = 1898 CreateTempAlloca(ArgI.getCoerceToType(), "coerce"); 1899 TempAlloca->setAlignment(AlignmentToUse); 1900 llvm::Value *TempV = TempAlloca; 1901 1902 assert(STy->getNumElements() == NumIRArgs); 1903 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) { 1904 auto AI = FnArgs[FirstIRArg + i]; 1905 AI->setName(Arg->getName() + ".coerce" + Twine(i)); 1906 llvm::Value *EltPtr = Builder.CreateConstGEP2_32(TempV, 0, i); 1907 Builder.CreateStore(AI, EltPtr); 1908 } 1909 1910 Builder.CreateMemCpy(Ptr, TempV, DstSize, AlignmentToUse); 1911 } 1912 } else { 1913 // Simple case, just do a coerced store of the argument into the alloca. 1914 assert(NumIRArgs == 1); 1915 auto AI = FnArgs[FirstIRArg]; 1916 AI->setName(Arg->getName() + ".coerce"); 1917 CreateCoercedStore(AI, Ptr, /*DestIsVolatile=*/false, *this); 1918 } 1919 1920 1921 // Match to what EmitParmDecl is expecting for this type. 1922 if (CodeGenFunction::hasScalarEvaluationKind(Ty)) { 1923 V = EmitLoadOfScalar(V, false, AlignmentToUse, Ty, Arg->getLocStart()); 1924 if (isPromoted) 1925 V = emitArgumentDemotion(*this, Arg, V); 1926 ArgVals.push_back(ValueAndIsPtr(V, HaveValue)); 1927 } else { 1928 ArgVals.push_back(ValueAndIsPtr(V, HavePointer)); 1929 } 1930 break; 1931 } 1932 1933 case ABIArgInfo::Expand: { 1934 // If this structure was expanded into multiple arguments then 1935 // we need to create a temporary and reconstruct it from the 1936 // arguments. 1937 llvm::AllocaInst *Alloca = CreateMemTemp(Ty); 1938 CharUnits Align = getContext().getDeclAlign(Arg); 1939 Alloca->setAlignment(Align.getQuantity()); 1940 LValue LV = MakeAddrLValue(Alloca, Ty, Align); 1941 ArgVals.push_back(ValueAndIsPtr(Alloca, HavePointer)); 1942 1943 auto FnArgIter = FnArgs.begin() + FirstIRArg; 1944 ExpandTypeFromArgs(Ty, LV, FnArgIter); 1945 assert(FnArgIter == FnArgs.begin() + FirstIRArg + NumIRArgs); 1946 for (unsigned i = 0, e = NumIRArgs; i != e; ++i) { 1947 auto AI = FnArgs[FirstIRArg + i]; 1948 AI->setName(Arg->getName() + "." + Twine(i)); 1949 } 1950 break; 1951 } 1952 1953 case ABIArgInfo::Ignore: 1954 assert(NumIRArgs == 0); 1955 // Initialize the local variable appropriately. 1956 if (!hasScalarEvaluationKind(Ty)) { 1957 ArgVals.push_back(ValueAndIsPtr(CreateMemTemp(Ty), HavePointer)); 1958 } else { 1959 llvm::Value *U = llvm::UndefValue::get(ConvertType(Arg->getType())); 1960 ArgVals.push_back(ValueAndIsPtr(U, HaveValue)); 1961 } 1962 break; 1963 } 1964 } 1965 1966 if (getTarget().getCXXABI().areArgsDestroyedLeftToRightInCallee()) { 1967 for (int I = Args.size() - 1; I >= 0; --I) 1968 EmitParmDecl(*Args[I], ArgVals[I].getPointer(), ArgVals[I].getInt(), 1969 I + 1); 1970 } else { 1971 for (unsigned I = 0, E = Args.size(); I != E; ++I) 1972 EmitParmDecl(*Args[I], ArgVals[I].getPointer(), ArgVals[I].getInt(), 1973 I + 1); 1974 } 1975 } 1976 1977 static void eraseUnusedBitCasts(llvm::Instruction *insn) { 1978 while (insn->use_empty()) { 1979 llvm::BitCastInst *bitcast = dyn_cast<llvm::BitCastInst>(insn); 1980 if (!bitcast) return; 1981 1982 // This is "safe" because we would have used a ConstantExpr otherwise. 1983 insn = cast<llvm::Instruction>(bitcast->getOperand(0)); 1984 bitcast->eraseFromParent(); 1985 } 1986 } 1987 1988 /// Try to emit a fused autorelease of a return result. 1989 static llvm::Value *tryEmitFusedAutoreleaseOfResult(CodeGenFunction &CGF, 1990 llvm::Value *result) { 1991 // We must be immediately followed the cast. 1992 llvm::BasicBlock *BB = CGF.Builder.GetInsertBlock(); 1993 if (BB->empty()) return nullptr; 1994 if (&BB->back() != result) return nullptr; 1995 1996 llvm::Type *resultType = result->getType(); 1997 1998 // result is in a BasicBlock and is therefore an Instruction. 1999 llvm::Instruction *generator = cast<llvm::Instruction>(result); 2000 2001 SmallVector<llvm::Instruction*,4> insnsToKill; 2002 2003 // Look for: 2004 // %generator = bitcast %type1* %generator2 to %type2* 2005 while (llvm::BitCastInst *bitcast = dyn_cast<llvm::BitCastInst>(generator)) { 2006 // We would have emitted this as a constant if the operand weren't 2007 // an Instruction. 2008 generator = cast<llvm::Instruction>(bitcast->getOperand(0)); 2009 2010 // Require the generator to be immediately followed by the cast. 2011 if (generator->getNextNode() != bitcast) 2012 return nullptr; 2013 2014 insnsToKill.push_back(bitcast); 2015 } 2016 2017 // Look for: 2018 // %generator = call i8* @objc_retain(i8* %originalResult) 2019 // or 2020 // %generator = call i8* @objc_retainAutoreleasedReturnValue(i8* %originalResult) 2021 llvm::CallInst *call = dyn_cast<llvm::CallInst>(generator); 2022 if (!call) return nullptr; 2023 2024 bool doRetainAutorelease; 2025 2026 if (call->getCalledValue() == CGF.CGM.getARCEntrypoints().objc_retain) { 2027 doRetainAutorelease = true; 2028 } else if (call->getCalledValue() == CGF.CGM.getARCEntrypoints() 2029 .objc_retainAutoreleasedReturnValue) { 2030 doRetainAutorelease = false; 2031 2032 // If we emitted an assembly marker for this call (and the 2033 // ARCEntrypoints field should have been set if so), go looking 2034 // for that call. If we can't find it, we can't do this 2035 // optimization. But it should always be the immediately previous 2036 // instruction, unless we needed bitcasts around the call. 2037 if (CGF.CGM.getARCEntrypoints().retainAutoreleasedReturnValueMarker) { 2038 llvm::Instruction *prev = call->getPrevNode(); 2039 assert(prev); 2040 if (isa<llvm::BitCastInst>(prev)) { 2041 prev = prev->getPrevNode(); 2042 assert(prev); 2043 } 2044 assert(isa<llvm::CallInst>(prev)); 2045 assert(cast<llvm::CallInst>(prev)->getCalledValue() == 2046 CGF.CGM.getARCEntrypoints().retainAutoreleasedReturnValueMarker); 2047 insnsToKill.push_back(prev); 2048 } 2049 } else { 2050 return nullptr; 2051 } 2052 2053 result = call->getArgOperand(0); 2054 insnsToKill.push_back(call); 2055 2056 // Keep killing bitcasts, for sanity. Note that we no longer care 2057 // about precise ordering as long as there's exactly one use. 2058 while (llvm::BitCastInst *bitcast = dyn_cast<llvm::BitCastInst>(result)) { 2059 if (!bitcast->hasOneUse()) break; 2060 insnsToKill.push_back(bitcast); 2061 result = bitcast->getOperand(0); 2062 } 2063 2064 // Delete all the unnecessary instructions, from latest to earliest. 2065 for (SmallVectorImpl<llvm::Instruction*>::iterator 2066 i = insnsToKill.begin(), e = insnsToKill.end(); i != e; ++i) 2067 (*i)->eraseFromParent(); 2068 2069 // Do the fused retain/autorelease if we were asked to. 2070 if (doRetainAutorelease) 2071 result = CGF.EmitARCRetainAutoreleaseReturnValue(result); 2072 2073 // Cast back to the result type. 2074 return CGF.Builder.CreateBitCast(result, resultType); 2075 } 2076 2077 /// If this is a +1 of the value of an immutable 'self', remove it. 2078 static llvm::Value *tryRemoveRetainOfSelf(CodeGenFunction &CGF, 2079 llvm::Value *result) { 2080 // This is only applicable to a method with an immutable 'self'. 2081 const ObjCMethodDecl *method = 2082 dyn_cast_or_null<ObjCMethodDecl>(CGF.CurCodeDecl); 2083 if (!method) return nullptr; 2084 const VarDecl *self = method->getSelfDecl(); 2085 if (!self->getType().isConstQualified()) return nullptr; 2086 2087 // Look for a retain call. 2088 llvm::CallInst *retainCall = 2089 dyn_cast<llvm::CallInst>(result->stripPointerCasts()); 2090 if (!retainCall || 2091 retainCall->getCalledValue() != CGF.CGM.getARCEntrypoints().objc_retain) 2092 return nullptr; 2093 2094 // Look for an ordinary load of 'self'. 2095 llvm::Value *retainedValue = retainCall->getArgOperand(0); 2096 llvm::LoadInst *load = 2097 dyn_cast<llvm::LoadInst>(retainedValue->stripPointerCasts()); 2098 if (!load || load->isAtomic() || load->isVolatile() || 2099 load->getPointerOperand() != CGF.GetAddrOfLocalVar(self)) 2100 return nullptr; 2101 2102 // Okay! Burn it all down. This relies for correctness on the 2103 // assumption that the retain is emitted as part of the return and 2104 // that thereafter everything is used "linearly". 2105 llvm::Type *resultType = result->getType(); 2106 eraseUnusedBitCasts(cast<llvm::Instruction>(result)); 2107 assert(retainCall->use_empty()); 2108 retainCall->eraseFromParent(); 2109 eraseUnusedBitCasts(cast<llvm::Instruction>(retainedValue)); 2110 2111 return CGF.Builder.CreateBitCast(load, resultType); 2112 } 2113 2114 /// Emit an ARC autorelease of the result of a function. 2115 /// 2116 /// \return the value to actually return from the function 2117 static llvm::Value *emitAutoreleaseOfResult(CodeGenFunction &CGF, 2118 llvm::Value *result) { 2119 // If we're returning 'self', kill the initial retain. This is a 2120 // heuristic attempt to "encourage correctness" in the really unfortunate 2121 // case where we have a return of self during a dealloc and we desperately 2122 // need to avoid the possible autorelease. 2123 if (llvm::Value *self = tryRemoveRetainOfSelf(CGF, result)) 2124 return self; 2125 2126 // At -O0, try to emit a fused retain/autorelease. 2127 if (CGF.shouldUseFusedARCCalls()) 2128 if (llvm::Value *fused = tryEmitFusedAutoreleaseOfResult(CGF, result)) 2129 return fused; 2130 2131 return CGF.EmitARCAutoreleaseReturnValue(result); 2132 } 2133 2134 /// Heuristically search for a dominating store to the return-value slot. 2135 static llvm::StoreInst *findDominatingStoreToReturnValue(CodeGenFunction &CGF) { 2136 // If there are multiple uses of the return-value slot, just check 2137 // for something immediately preceding the IP. Sometimes this can 2138 // happen with how we generate implicit-returns; it can also happen 2139 // with noreturn cleanups. 2140 if (!CGF.ReturnValue->hasOneUse()) { 2141 llvm::BasicBlock *IP = CGF.Builder.GetInsertBlock(); 2142 if (IP->empty()) return nullptr; 2143 llvm::StoreInst *store = dyn_cast<llvm::StoreInst>(&IP->back()); 2144 if (!store) return nullptr; 2145 if (store->getPointerOperand() != CGF.ReturnValue) return nullptr; 2146 assert(!store->isAtomic() && !store->isVolatile()); // see below 2147 return store; 2148 } 2149 2150 llvm::StoreInst *store = 2151 dyn_cast<llvm::StoreInst>(CGF.ReturnValue->user_back()); 2152 if (!store) return nullptr; 2153 2154 // These aren't actually possible for non-coerced returns, and we 2155 // only care about non-coerced returns on this code path. 2156 assert(!store->isAtomic() && !store->isVolatile()); 2157 2158 // Now do a first-and-dirty dominance check: just walk up the 2159 // single-predecessors chain from the current insertion point. 2160 llvm::BasicBlock *StoreBB = store->getParent(); 2161 llvm::BasicBlock *IP = CGF.Builder.GetInsertBlock(); 2162 while (IP != StoreBB) { 2163 if (!(IP = IP->getSinglePredecessor())) 2164 return nullptr; 2165 } 2166 2167 // Okay, the store's basic block dominates the insertion point; we 2168 // can do our thing. 2169 return store; 2170 } 2171 2172 void CodeGenFunction::EmitFunctionEpilog(const CGFunctionInfo &FI, 2173 bool EmitRetDbgLoc, 2174 SourceLocation EndLoc) { 2175 if (CurCodeDecl && CurCodeDecl->hasAttr<NakedAttr>()) { 2176 // Naked functions don't have epilogues. 2177 Builder.CreateUnreachable(); 2178 return; 2179 } 2180 2181 // Functions with no result always return void. 2182 if (!ReturnValue) { 2183 Builder.CreateRetVoid(); 2184 return; 2185 } 2186 2187 llvm::DebugLoc RetDbgLoc; 2188 llvm::Value *RV = nullptr; 2189 QualType RetTy = FI.getReturnType(); 2190 const ABIArgInfo &RetAI = FI.getReturnInfo(); 2191 2192 switch (RetAI.getKind()) { 2193 case ABIArgInfo::InAlloca: 2194 // Aggregrates get evaluated directly into the destination. Sometimes we 2195 // need to return the sret value in a register, though. 2196 assert(hasAggregateEvaluationKind(RetTy)); 2197 if (RetAI.getInAllocaSRet()) { 2198 llvm::Function::arg_iterator EI = CurFn->arg_end(); 2199 --EI; 2200 llvm::Value *ArgStruct = EI; 2201 llvm::Value *SRet = 2202 Builder.CreateStructGEP(ArgStruct, RetAI.getInAllocaFieldIndex()); 2203 RV = Builder.CreateLoad(SRet, "sret"); 2204 } 2205 break; 2206 2207 case ABIArgInfo::Indirect: { 2208 auto AI = CurFn->arg_begin(); 2209 if (RetAI.isSRetAfterThis()) 2210 ++AI; 2211 switch (getEvaluationKind(RetTy)) { 2212 case TEK_Complex: { 2213 ComplexPairTy RT = 2214 EmitLoadOfComplex(MakeNaturalAlignAddrLValue(ReturnValue, RetTy), 2215 EndLoc); 2216 EmitStoreOfComplex(RT, MakeNaturalAlignAddrLValue(AI, RetTy), 2217 /*isInit*/ true); 2218 break; 2219 } 2220 case TEK_Aggregate: 2221 // Do nothing; aggregrates get evaluated directly into the destination. 2222 break; 2223 case TEK_Scalar: 2224 EmitStoreOfScalar(Builder.CreateLoad(ReturnValue), 2225 MakeNaturalAlignAddrLValue(AI, RetTy), 2226 /*isInit*/ true); 2227 break; 2228 } 2229 break; 2230 } 2231 2232 case ABIArgInfo::Extend: 2233 case ABIArgInfo::Direct: 2234 if (RetAI.getCoerceToType() == ConvertType(RetTy) && 2235 RetAI.getDirectOffset() == 0) { 2236 // The internal return value temp always will have pointer-to-return-type 2237 // type, just do a load. 2238 2239 // If there is a dominating store to ReturnValue, we can elide 2240 // the load, zap the store, and usually zap the alloca. 2241 if (llvm::StoreInst *SI = findDominatingStoreToReturnValue(*this)) { 2242 // Reuse the debug location from the store unless there is 2243 // cleanup code to be emitted between the store and return 2244 // instruction. 2245 if (EmitRetDbgLoc && !AutoreleaseResult) 2246 RetDbgLoc = SI->getDebugLoc(); 2247 // Get the stored value and nuke the now-dead store. 2248 RV = SI->getValueOperand(); 2249 SI->eraseFromParent(); 2250 2251 // If that was the only use of the return value, nuke it as well now. 2252 if (ReturnValue->use_empty() && isa<llvm::AllocaInst>(ReturnValue)) { 2253 cast<llvm::AllocaInst>(ReturnValue)->eraseFromParent(); 2254 ReturnValue = nullptr; 2255 } 2256 2257 // Otherwise, we have to do a simple load. 2258 } else { 2259 RV = Builder.CreateLoad(ReturnValue); 2260 } 2261 } else { 2262 llvm::Value *V = ReturnValue; 2263 // If the value is offset in memory, apply the offset now. 2264 if (unsigned Offs = RetAI.getDirectOffset()) { 2265 V = Builder.CreateBitCast(V, Builder.getInt8PtrTy()); 2266 V = Builder.CreateConstGEP1_32(V, Offs); 2267 V = Builder.CreateBitCast(V, 2268 llvm::PointerType::getUnqual(RetAI.getCoerceToType())); 2269 } 2270 2271 RV = CreateCoercedLoad(V, RetAI.getCoerceToType(), *this); 2272 } 2273 2274 // In ARC, end functions that return a retainable type with a call 2275 // to objc_autoreleaseReturnValue. 2276 if (AutoreleaseResult) { 2277 assert(getLangOpts().ObjCAutoRefCount && 2278 !FI.isReturnsRetained() && 2279 RetTy->isObjCRetainableType()); 2280 RV = emitAutoreleaseOfResult(*this, RV); 2281 } 2282 2283 break; 2284 2285 case ABIArgInfo::Ignore: 2286 break; 2287 2288 case ABIArgInfo::Expand: 2289 llvm_unreachable("Invalid ABI kind for return argument"); 2290 } 2291 2292 llvm::Instruction *Ret; 2293 if (RV) { 2294 if (SanOpts.ReturnsNonnullAttribute) { 2295 if (auto RetNNAttr = CurGD.getDecl()->getAttr<ReturnsNonNullAttr>()) { 2296 SanitizerScope SanScope(this); 2297 llvm::Value *Cond = Builder.CreateICmpNE( 2298 RV, llvm::Constant::getNullValue(RV->getType())); 2299 llvm::Constant *StaticData[] = { 2300 EmitCheckSourceLocation(EndLoc), 2301 EmitCheckSourceLocation(RetNNAttr->getLocation()), 2302 }; 2303 EmitCheck(Cond, "nonnull_return", StaticData, None, CRK_Recoverable); 2304 } 2305 } 2306 Ret = Builder.CreateRet(RV); 2307 } else { 2308 Ret = Builder.CreateRetVoid(); 2309 } 2310 2311 if (!RetDbgLoc.isUnknown()) 2312 Ret->setDebugLoc(RetDbgLoc); 2313 } 2314 2315 static bool isInAllocaArgument(CGCXXABI &ABI, QualType type) { 2316 const CXXRecordDecl *RD = type->getAsCXXRecordDecl(); 2317 return RD && ABI.getRecordArgABI(RD) == CGCXXABI::RAA_DirectInMemory; 2318 } 2319 2320 static AggValueSlot createPlaceholderSlot(CodeGenFunction &CGF, QualType Ty) { 2321 // FIXME: Generate IR in one pass, rather than going back and fixing up these 2322 // placeholders. 2323 llvm::Type *IRTy = CGF.ConvertTypeForMem(Ty); 2324 llvm::Value *Placeholder = 2325 llvm::UndefValue::get(IRTy->getPointerTo()->getPointerTo()); 2326 Placeholder = CGF.Builder.CreateLoad(Placeholder); 2327 return AggValueSlot::forAddr(Placeholder, CharUnits::Zero(), 2328 Ty.getQualifiers(), 2329 AggValueSlot::IsNotDestructed, 2330 AggValueSlot::DoesNotNeedGCBarriers, 2331 AggValueSlot::IsNotAliased); 2332 } 2333 2334 void CodeGenFunction::EmitDelegateCallArg(CallArgList &args, 2335 const VarDecl *param, 2336 SourceLocation loc) { 2337 // StartFunction converted the ABI-lowered parameter(s) into a 2338 // local alloca. We need to turn that into an r-value suitable 2339 // for EmitCall. 2340 llvm::Value *local = GetAddrOfLocalVar(param); 2341 2342 QualType type = param->getType(); 2343 2344 // For the most part, we just need to load the alloca, except: 2345 // 1) aggregate r-values are actually pointers to temporaries, and 2346 // 2) references to non-scalars are pointers directly to the aggregate. 2347 // I don't know why references to scalars are different here. 2348 if (const ReferenceType *ref = type->getAs<ReferenceType>()) { 2349 if (!hasScalarEvaluationKind(ref->getPointeeType())) 2350 return args.add(RValue::getAggregate(local), type); 2351 2352 // Locals which are references to scalars are represented 2353 // with allocas holding the pointer. 2354 return args.add(RValue::get(Builder.CreateLoad(local)), type); 2355 } 2356 2357 assert(!isInAllocaArgument(CGM.getCXXABI(), type) && 2358 "cannot emit delegate call arguments for inalloca arguments!"); 2359 2360 args.add(convertTempToRValue(local, type, loc), type); 2361 } 2362 2363 static bool isProvablyNull(llvm::Value *addr) { 2364 return isa<llvm::ConstantPointerNull>(addr); 2365 } 2366 2367 static bool isProvablyNonNull(llvm::Value *addr) { 2368 return isa<llvm::AllocaInst>(addr); 2369 } 2370 2371 /// Emit the actual writing-back of a writeback. 2372 static void emitWriteback(CodeGenFunction &CGF, 2373 const CallArgList::Writeback &writeback) { 2374 const LValue &srcLV = writeback.Source; 2375 llvm::Value *srcAddr = srcLV.getAddress(); 2376 assert(!isProvablyNull(srcAddr) && 2377 "shouldn't have writeback for provably null argument"); 2378 2379 llvm::BasicBlock *contBB = nullptr; 2380 2381 // If the argument wasn't provably non-null, we need to null check 2382 // before doing the store. 2383 bool provablyNonNull = isProvablyNonNull(srcAddr); 2384 if (!provablyNonNull) { 2385 llvm::BasicBlock *writebackBB = CGF.createBasicBlock("icr.writeback"); 2386 contBB = CGF.createBasicBlock("icr.done"); 2387 2388 llvm::Value *isNull = CGF.Builder.CreateIsNull(srcAddr, "icr.isnull"); 2389 CGF.Builder.CreateCondBr(isNull, contBB, writebackBB); 2390 CGF.EmitBlock(writebackBB); 2391 } 2392 2393 // Load the value to writeback. 2394 llvm::Value *value = CGF.Builder.CreateLoad(writeback.Temporary); 2395 2396 // Cast it back, in case we're writing an id to a Foo* or something. 2397 value = CGF.Builder.CreateBitCast(value, 2398 cast<llvm::PointerType>(srcAddr->getType())->getElementType(), 2399 "icr.writeback-cast"); 2400 2401 // Perform the writeback. 2402 2403 // If we have a "to use" value, it's something we need to emit a use 2404 // of. This has to be carefully threaded in: if it's done after the 2405 // release it's potentially undefined behavior (and the optimizer 2406 // will ignore it), and if it happens before the retain then the 2407 // optimizer could move the release there. 2408 if (writeback.ToUse) { 2409 assert(srcLV.getObjCLifetime() == Qualifiers::OCL_Strong); 2410 2411 // Retain the new value. No need to block-copy here: the block's 2412 // being passed up the stack. 2413 value = CGF.EmitARCRetainNonBlock(value); 2414 2415 // Emit the intrinsic use here. 2416 CGF.EmitARCIntrinsicUse(writeback.ToUse); 2417 2418 // Load the old value (primitively). 2419 llvm::Value *oldValue = CGF.EmitLoadOfScalar(srcLV, SourceLocation()); 2420 2421 // Put the new value in place (primitively). 2422 CGF.EmitStoreOfScalar(value, srcLV, /*init*/ false); 2423 2424 // Release the old value. 2425 CGF.EmitARCRelease(oldValue, srcLV.isARCPreciseLifetime()); 2426 2427 // Otherwise, we can just do a normal lvalue store. 2428 } else { 2429 CGF.EmitStoreThroughLValue(RValue::get(value), srcLV); 2430 } 2431 2432 // Jump to the continuation block. 2433 if (!provablyNonNull) 2434 CGF.EmitBlock(contBB); 2435 } 2436 2437 static void emitWritebacks(CodeGenFunction &CGF, 2438 const CallArgList &args) { 2439 for (const auto &I : args.writebacks()) 2440 emitWriteback(CGF, I); 2441 } 2442 2443 static void deactivateArgCleanupsBeforeCall(CodeGenFunction &CGF, 2444 const CallArgList &CallArgs) { 2445 assert(CGF.getTarget().getCXXABI().areArgsDestroyedLeftToRightInCallee()); 2446 ArrayRef<CallArgList::CallArgCleanup> Cleanups = 2447 CallArgs.getCleanupsToDeactivate(); 2448 // Iterate in reverse to increase the likelihood of popping the cleanup. 2449 for (ArrayRef<CallArgList::CallArgCleanup>::reverse_iterator 2450 I = Cleanups.rbegin(), E = Cleanups.rend(); I != E; ++I) { 2451 CGF.DeactivateCleanupBlock(I->Cleanup, I->IsActiveIP); 2452 I->IsActiveIP->eraseFromParent(); 2453 } 2454 } 2455 2456 static const Expr *maybeGetUnaryAddrOfOperand(const Expr *E) { 2457 if (const UnaryOperator *uop = dyn_cast<UnaryOperator>(E->IgnoreParens())) 2458 if (uop->getOpcode() == UO_AddrOf) 2459 return uop->getSubExpr(); 2460 return nullptr; 2461 } 2462 2463 /// Emit an argument that's being passed call-by-writeback. That is, 2464 /// we are passing the address of 2465 static void emitWritebackArg(CodeGenFunction &CGF, CallArgList &args, 2466 const ObjCIndirectCopyRestoreExpr *CRE) { 2467 LValue srcLV; 2468 2469 // Make an optimistic effort to emit the address as an l-value. 2470 // This can fail if the the argument expression is more complicated. 2471 if (const Expr *lvExpr = maybeGetUnaryAddrOfOperand(CRE->getSubExpr())) { 2472 srcLV = CGF.EmitLValue(lvExpr); 2473 2474 // Otherwise, just emit it as a scalar. 2475 } else { 2476 llvm::Value *srcAddr = CGF.EmitScalarExpr(CRE->getSubExpr()); 2477 2478 QualType srcAddrType = 2479 CRE->getSubExpr()->getType()->castAs<PointerType>()->getPointeeType(); 2480 srcLV = CGF.MakeNaturalAlignAddrLValue(srcAddr, srcAddrType); 2481 } 2482 llvm::Value *srcAddr = srcLV.getAddress(); 2483 2484 // The dest and src types don't necessarily match in LLVM terms 2485 // because of the crazy ObjC compatibility rules. 2486 2487 llvm::PointerType *destType = 2488 cast<llvm::PointerType>(CGF.ConvertType(CRE->getType())); 2489 2490 // If the address is a constant null, just pass the appropriate null. 2491 if (isProvablyNull(srcAddr)) { 2492 args.add(RValue::get(llvm::ConstantPointerNull::get(destType)), 2493 CRE->getType()); 2494 return; 2495 } 2496 2497 // Create the temporary. 2498 llvm::Value *temp = CGF.CreateTempAlloca(destType->getElementType(), 2499 "icr.temp"); 2500 // Loading an l-value can introduce a cleanup if the l-value is __weak, 2501 // and that cleanup will be conditional if we can't prove that the l-value 2502 // isn't null, so we need to register a dominating point so that the cleanups 2503 // system will make valid IR. 2504 CodeGenFunction::ConditionalEvaluation condEval(CGF); 2505 2506 // Zero-initialize it if we're not doing a copy-initialization. 2507 bool shouldCopy = CRE->shouldCopy(); 2508 if (!shouldCopy) { 2509 llvm::Value *null = 2510 llvm::ConstantPointerNull::get( 2511 cast<llvm::PointerType>(destType->getElementType())); 2512 CGF.Builder.CreateStore(null, temp); 2513 } 2514 2515 llvm::BasicBlock *contBB = nullptr; 2516 llvm::BasicBlock *originBB = nullptr; 2517 2518 // If the address is *not* known to be non-null, we need to switch. 2519 llvm::Value *finalArgument; 2520 2521 bool provablyNonNull = isProvablyNonNull(srcAddr); 2522 if (provablyNonNull) { 2523 finalArgument = temp; 2524 } else { 2525 llvm::Value *isNull = CGF.Builder.CreateIsNull(srcAddr, "icr.isnull"); 2526 2527 finalArgument = CGF.Builder.CreateSelect(isNull, 2528 llvm::ConstantPointerNull::get(destType), 2529 temp, "icr.argument"); 2530 2531 // If we need to copy, then the load has to be conditional, which 2532 // means we need control flow. 2533 if (shouldCopy) { 2534 originBB = CGF.Builder.GetInsertBlock(); 2535 contBB = CGF.createBasicBlock("icr.cont"); 2536 llvm::BasicBlock *copyBB = CGF.createBasicBlock("icr.copy"); 2537 CGF.Builder.CreateCondBr(isNull, contBB, copyBB); 2538 CGF.EmitBlock(copyBB); 2539 condEval.begin(CGF); 2540 } 2541 } 2542 2543 llvm::Value *valueToUse = nullptr; 2544 2545 // Perform a copy if necessary. 2546 if (shouldCopy) { 2547 RValue srcRV = CGF.EmitLoadOfLValue(srcLV, SourceLocation()); 2548 assert(srcRV.isScalar()); 2549 2550 llvm::Value *src = srcRV.getScalarVal(); 2551 src = CGF.Builder.CreateBitCast(src, destType->getElementType(), 2552 "icr.cast"); 2553 2554 // Use an ordinary store, not a store-to-lvalue. 2555 CGF.Builder.CreateStore(src, temp); 2556 2557 // If optimization is enabled, and the value was held in a 2558 // __strong variable, we need to tell the optimizer that this 2559 // value has to stay alive until we're doing the store back. 2560 // This is because the temporary is effectively unretained, 2561 // and so otherwise we can violate the high-level semantics. 2562 if (CGF.CGM.getCodeGenOpts().OptimizationLevel != 0 && 2563 srcLV.getObjCLifetime() == Qualifiers::OCL_Strong) { 2564 valueToUse = src; 2565 } 2566 } 2567 2568 // Finish the control flow if we needed it. 2569 if (shouldCopy && !provablyNonNull) { 2570 llvm::BasicBlock *copyBB = CGF.Builder.GetInsertBlock(); 2571 CGF.EmitBlock(contBB); 2572 2573 // Make a phi for the value to intrinsically use. 2574 if (valueToUse) { 2575 llvm::PHINode *phiToUse = CGF.Builder.CreatePHI(valueToUse->getType(), 2, 2576 "icr.to-use"); 2577 phiToUse->addIncoming(valueToUse, copyBB); 2578 phiToUse->addIncoming(llvm::UndefValue::get(valueToUse->getType()), 2579 originBB); 2580 valueToUse = phiToUse; 2581 } 2582 2583 condEval.end(CGF); 2584 } 2585 2586 args.addWriteback(srcLV, temp, valueToUse); 2587 args.add(RValue::get(finalArgument), CRE->getType()); 2588 } 2589 2590 void CallArgList::allocateArgumentMemory(CodeGenFunction &CGF) { 2591 assert(!StackBase && !StackCleanup.isValid()); 2592 2593 // Save the stack. 2594 llvm::Function *F = CGF.CGM.getIntrinsic(llvm::Intrinsic::stacksave); 2595 StackBase = CGF.Builder.CreateCall(F, "inalloca.save"); 2596 2597 // Control gets really tied up in landing pads, so we have to spill the 2598 // stacksave to an alloca to avoid violating SSA form. 2599 // TODO: This is dead if we never emit the cleanup. We should create the 2600 // alloca and store lazily on the first cleanup emission. 2601 StackBaseMem = CGF.CreateTempAlloca(CGF.Int8PtrTy, "inalloca.spmem"); 2602 CGF.Builder.CreateStore(StackBase, StackBaseMem); 2603 CGF.pushStackRestore(EHCleanup, StackBaseMem); 2604 StackCleanup = CGF.EHStack.getInnermostEHScope(); 2605 assert(StackCleanup.isValid()); 2606 } 2607 2608 void CallArgList::freeArgumentMemory(CodeGenFunction &CGF) const { 2609 if (StackBase) { 2610 CGF.DeactivateCleanupBlock(StackCleanup, StackBase); 2611 llvm::Value *F = CGF.CGM.getIntrinsic(llvm::Intrinsic::stackrestore); 2612 // We could load StackBase from StackBaseMem, but in the non-exceptional 2613 // case we can skip it. 2614 CGF.Builder.CreateCall(F, StackBase); 2615 } 2616 } 2617 2618 static void emitNonNullArgCheck(CodeGenFunction &CGF, RValue RV, 2619 QualType ArgType, SourceLocation ArgLoc, 2620 const FunctionDecl *FD, unsigned ParmNum) { 2621 if (!CGF.SanOpts.NonnullAttribute || !FD) 2622 return; 2623 auto PVD = ParmNum < FD->getNumParams() ? FD->getParamDecl(ParmNum) : nullptr; 2624 unsigned ArgNo = PVD ? PVD->getFunctionScopeIndex() : ParmNum; 2625 auto NNAttr = getNonNullAttr(FD, PVD, ArgType, ArgNo); 2626 if (!NNAttr) 2627 return; 2628 CodeGenFunction::SanitizerScope SanScope(&CGF); 2629 assert(RV.isScalar()); 2630 llvm::Value *V = RV.getScalarVal(); 2631 llvm::Value *Cond = 2632 CGF.Builder.CreateICmpNE(V, llvm::Constant::getNullValue(V->getType())); 2633 llvm::Constant *StaticData[] = { 2634 CGF.EmitCheckSourceLocation(ArgLoc), 2635 CGF.EmitCheckSourceLocation(NNAttr->getLocation()), 2636 llvm::ConstantInt::get(CGF.Int32Ty, ArgNo + 1), 2637 }; 2638 CGF.EmitCheck(Cond, "nonnull_arg", StaticData, None, 2639 CodeGenFunction::CRK_Recoverable); 2640 } 2641 2642 void CodeGenFunction::EmitCallArgs(CallArgList &Args, 2643 ArrayRef<QualType> ArgTypes, 2644 CallExpr::const_arg_iterator ArgBeg, 2645 CallExpr::const_arg_iterator ArgEnd, 2646 const FunctionDecl *CalleeDecl, 2647 unsigned ParamsToSkip, 2648 bool ForceColumnInfo) { 2649 CGDebugInfo *DI = getDebugInfo(); 2650 SourceLocation CallLoc; 2651 if (DI) CallLoc = DI->getLocation(); 2652 2653 // We *have* to evaluate arguments from right to left in the MS C++ ABI, 2654 // because arguments are destroyed left to right in the callee. 2655 if (CGM.getTarget().getCXXABI().areArgsDestroyedLeftToRightInCallee()) { 2656 // Insert a stack save if we're going to need any inalloca args. 2657 bool HasInAllocaArgs = false; 2658 for (ArrayRef<QualType>::iterator I = ArgTypes.begin(), E = ArgTypes.end(); 2659 I != E && !HasInAllocaArgs; ++I) 2660 HasInAllocaArgs = isInAllocaArgument(CGM.getCXXABI(), *I); 2661 if (HasInAllocaArgs) { 2662 assert(getTarget().getTriple().getArch() == llvm::Triple::x86); 2663 Args.allocateArgumentMemory(*this); 2664 } 2665 2666 // Evaluate each argument. 2667 size_t CallArgsStart = Args.size(); 2668 for (int I = ArgTypes.size() - 1; I >= 0; --I) { 2669 CallExpr::const_arg_iterator Arg = ArgBeg + I; 2670 EmitCallArg(Args, *Arg, ArgTypes[I]); 2671 emitNonNullArgCheck(*this, Args.back().RV, ArgTypes[I], Arg->getExprLoc(), 2672 CalleeDecl, ParamsToSkip + I); 2673 // Restore the debug location. 2674 if (DI) DI->EmitLocation(Builder, CallLoc, ForceColumnInfo); 2675 } 2676 2677 // Un-reverse the arguments we just evaluated so they match up with the LLVM 2678 // IR function. 2679 std::reverse(Args.begin() + CallArgsStart, Args.end()); 2680 return; 2681 } 2682 2683 for (unsigned I = 0, E = ArgTypes.size(); I != E; ++I) { 2684 CallExpr::const_arg_iterator Arg = ArgBeg + I; 2685 assert(Arg != ArgEnd); 2686 EmitCallArg(Args, *Arg, ArgTypes[I]); 2687 emitNonNullArgCheck(*this, Args.back().RV, ArgTypes[I], Arg->getExprLoc(), 2688 CalleeDecl, ParamsToSkip + I); 2689 // Restore the debug location. 2690 if (DI) DI->EmitLocation(Builder, CallLoc, ForceColumnInfo); 2691 } 2692 } 2693 2694 namespace { 2695 2696 struct DestroyUnpassedArg : EHScopeStack::Cleanup { 2697 DestroyUnpassedArg(llvm::Value *Addr, QualType Ty) 2698 : Addr(Addr), Ty(Ty) {} 2699 2700 llvm::Value *Addr; 2701 QualType Ty; 2702 2703 void Emit(CodeGenFunction &CGF, Flags flags) override { 2704 const CXXDestructorDecl *Dtor = Ty->getAsCXXRecordDecl()->getDestructor(); 2705 assert(!Dtor->isTrivial()); 2706 CGF.EmitCXXDestructorCall(Dtor, Dtor_Complete, /*for vbase*/ false, 2707 /*Delegating=*/false, Addr); 2708 } 2709 }; 2710 2711 } 2712 2713 void CodeGenFunction::EmitCallArg(CallArgList &args, const Expr *E, 2714 QualType type) { 2715 if (const ObjCIndirectCopyRestoreExpr *CRE 2716 = dyn_cast<ObjCIndirectCopyRestoreExpr>(E)) { 2717 assert(getLangOpts().ObjCAutoRefCount); 2718 assert(getContext().hasSameType(E->getType(), type)); 2719 return emitWritebackArg(*this, args, CRE); 2720 } 2721 2722 assert(type->isReferenceType() == E->isGLValue() && 2723 "reference binding to unmaterialized r-value!"); 2724 2725 if (E->isGLValue()) { 2726 assert(E->getObjectKind() == OK_Ordinary); 2727 return args.add(EmitReferenceBindingToExpr(E), type); 2728 } 2729 2730 bool HasAggregateEvalKind = hasAggregateEvaluationKind(type); 2731 2732 // In the Microsoft C++ ABI, aggregate arguments are destructed by the callee. 2733 // However, we still have to push an EH-only cleanup in case we unwind before 2734 // we make it to the call. 2735 if (HasAggregateEvalKind && 2736 CGM.getTarget().getCXXABI().areArgsDestroyedLeftToRightInCallee()) { 2737 // If we're using inalloca, use the argument memory. Otherwise, use a 2738 // temporary. 2739 AggValueSlot Slot; 2740 if (args.isUsingInAlloca()) 2741 Slot = createPlaceholderSlot(*this, type); 2742 else 2743 Slot = CreateAggTemp(type, "agg.tmp"); 2744 2745 const CXXRecordDecl *RD = type->getAsCXXRecordDecl(); 2746 bool DestroyedInCallee = 2747 RD && RD->hasNonTrivialDestructor() && 2748 CGM.getCXXABI().getRecordArgABI(RD) != CGCXXABI::RAA_Default; 2749 if (DestroyedInCallee) 2750 Slot.setExternallyDestructed(); 2751 2752 EmitAggExpr(E, Slot); 2753 RValue RV = Slot.asRValue(); 2754 args.add(RV, type); 2755 2756 if (DestroyedInCallee) { 2757 // Create a no-op GEP between the placeholder and the cleanup so we can 2758 // RAUW it successfully. It also serves as a marker of the first 2759 // instruction where the cleanup is active. 2760 pushFullExprCleanup<DestroyUnpassedArg>(EHCleanup, Slot.getAddr(), type); 2761 // This unreachable is a temporary marker which will be removed later. 2762 llvm::Instruction *IsActive = Builder.CreateUnreachable(); 2763 args.addArgCleanupDeactivation(EHStack.getInnermostEHScope(), IsActive); 2764 } 2765 return; 2766 } 2767 2768 if (HasAggregateEvalKind && isa<ImplicitCastExpr>(E) && 2769 cast<CastExpr>(E)->getCastKind() == CK_LValueToRValue) { 2770 LValue L = EmitLValue(cast<CastExpr>(E)->getSubExpr()); 2771 assert(L.isSimple()); 2772 if (L.getAlignment() >= getContext().getTypeAlignInChars(type)) { 2773 args.add(L.asAggregateRValue(), type, /*NeedsCopy*/true); 2774 } else { 2775 // We can't represent a misaligned lvalue in the CallArgList, so copy 2776 // to an aligned temporary now. 2777 llvm::Value *tmp = CreateMemTemp(type); 2778 EmitAggregateCopy(tmp, L.getAddress(), type, L.isVolatile(), 2779 L.getAlignment()); 2780 args.add(RValue::getAggregate(tmp), type); 2781 } 2782 return; 2783 } 2784 2785 args.add(EmitAnyExprToTemp(E), type); 2786 } 2787 2788 QualType CodeGenFunction::getVarArgType(const Expr *Arg) { 2789 // System headers on Windows define NULL to 0 instead of 0LL on Win64. MSVC 2790 // implicitly widens null pointer constants that are arguments to varargs 2791 // functions to pointer-sized ints. 2792 if (!getTarget().getTriple().isOSWindows()) 2793 return Arg->getType(); 2794 2795 if (Arg->getType()->isIntegerType() && 2796 getContext().getTypeSize(Arg->getType()) < 2797 getContext().getTargetInfo().getPointerWidth(0) && 2798 Arg->isNullPointerConstant(getContext(), 2799 Expr::NPC_ValueDependentIsNotNull)) { 2800 return getContext().getIntPtrType(); 2801 } 2802 2803 return Arg->getType(); 2804 } 2805 2806 // In ObjC ARC mode with no ObjC ARC exception safety, tell the ARC 2807 // optimizer it can aggressively ignore unwind edges. 2808 void 2809 CodeGenFunction::AddObjCARCExceptionMetadata(llvm::Instruction *Inst) { 2810 if (CGM.getCodeGenOpts().OptimizationLevel != 0 && 2811 !CGM.getCodeGenOpts().ObjCAutoRefCountExceptions) 2812 Inst->setMetadata("clang.arc.no_objc_arc_exceptions", 2813 CGM.getNoObjCARCExceptionsMetadata()); 2814 } 2815 2816 /// Emits a call to the given no-arguments nounwind runtime function. 2817 llvm::CallInst * 2818 CodeGenFunction::EmitNounwindRuntimeCall(llvm::Value *callee, 2819 const llvm::Twine &name) { 2820 return EmitNounwindRuntimeCall(callee, None, name); 2821 } 2822 2823 /// Emits a call to the given nounwind runtime function. 2824 llvm::CallInst * 2825 CodeGenFunction::EmitNounwindRuntimeCall(llvm::Value *callee, 2826 ArrayRef<llvm::Value*> args, 2827 const llvm::Twine &name) { 2828 llvm::CallInst *call = EmitRuntimeCall(callee, args, name); 2829 call->setDoesNotThrow(); 2830 return call; 2831 } 2832 2833 /// Emits a simple call (never an invoke) to the given no-arguments 2834 /// runtime function. 2835 llvm::CallInst * 2836 CodeGenFunction::EmitRuntimeCall(llvm::Value *callee, 2837 const llvm::Twine &name) { 2838 return EmitRuntimeCall(callee, None, name); 2839 } 2840 2841 /// Emits a simple call (never an invoke) to the given runtime 2842 /// function. 2843 llvm::CallInst * 2844 CodeGenFunction::EmitRuntimeCall(llvm::Value *callee, 2845 ArrayRef<llvm::Value*> args, 2846 const llvm::Twine &name) { 2847 llvm::CallInst *call = Builder.CreateCall(callee, args, name); 2848 call->setCallingConv(getRuntimeCC()); 2849 return call; 2850 } 2851 2852 /// Emits a call or invoke to the given noreturn runtime function. 2853 void CodeGenFunction::EmitNoreturnRuntimeCallOrInvoke(llvm::Value *callee, 2854 ArrayRef<llvm::Value*> args) { 2855 if (getInvokeDest()) { 2856 llvm::InvokeInst *invoke = 2857 Builder.CreateInvoke(callee, 2858 getUnreachableBlock(), 2859 getInvokeDest(), 2860 args); 2861 invoke->setDoesNotReturn(); 2862 invoke->setCallingConv(getRuntimeCC()); 2863 } else { 2864 llvm::CallInst *call = Builder.CreateCall(callee, args); 2865 call->setDoesNotReturn(); 2866 call->setCallingConv(getRuntimeCC()); 2867 Builder.CreateUnreachable(); 2868 } 2869 PGO.setCurrentRegionUnreachable(); 2870 } 2871 2872 /// Emits a call or invoke instruction to the given nullary runtime 2873 /// function. 2874 llvm::CallSite 2875 CodeGenFunction::EmitRuntimeCallOrInvoke(llvm::Value *callee, 2876 const Twine &name) { 2877 return EmitRuntimeCallOrInvoke(callee, None, name); 2878 } 2879 2880 /// Emits a call or invoke instruction to the given runtime function. 2881 llvm::CallSite 2882 CodeGenFunction::EmitRuntimeCallOrInvoke(llvm::Value *callee, 2883 ArrayRef<llvm::Value*> args, 2884 const Twine &name) { 2885 llvm::CallSite callSite = EmitCallOrInvoke(callee, args, name); 2886 callSite.setCallingConv(getRuntimeCC()); 2887 return callSite; 2888 } 2889 2890 llvm::CallSite 2891 CodeGenFunction::EmitCallOrInvoke(llvm::Value *Callee, 2892 const Twine &Name) { 2893 return EmitCallOrInvoke(Callee, None, Name); 2894 } 2895 2896 /// Emits a call or invoke instruction to the given function, depending 2897 /// on the current state of the EH stack. 2898 llvm::CallSite 2899 CodeGenFunction::EmitCallOrInvoke(llvm::Value *Callee, 2900 ArrayRef<llvm::Value *> Args, 2901 const Twine &Name) { 2902 llvm::BasicBlock *InvokeDest = getInvokeDest(); 2903 2904 llvm::Instruction *Inst; 2905 if (!InvokeDest) 2906 Inst = Builder.CreateCall(Callee, Args, Name); 2907 else { 2908 llvm::BasicBlock *ContBB = createBasicBlock("invoke.cont"); 2909 Inst = Builder.CreateInvoke(Callee, ContBB, InvokeDest, Args, Name); 2910 EmitBlock(ContBB); 2911 } 2912 2913 // In ObjC ARC mode with no ObjC ARC exception safety, tell the ARC 2914 // optimizer it can aggressively ignore unwind edges. 2915 if (CGM.getLangOpts().ObjCAutoRefCount) 2916 AddObjCARCExceptionMetadata(Inst); 2917 2918 return Inst; 2919 } 2920 2921 /// \brief Store a non-aggregate value to an address to initialize it. For 2922 /// initialization, a non-atomic store will be used. 2923 static void EmitInitStoreOfNonAggregate(CodeGenFunction &CGF, RValue Src, 2924 LValue Dst) { 2925 if (Src.isScalar()) 2926 CGF.EmitStoreOfScalar(Src.getScalarVal(), Dst, /*init=*/true); 2927 else 2928 CGF.EmitStoreOfComplex(Src.getComplexVal(), Dst, /*init=*/true); 2929 } 2930 2931 void CodeGenFunction::deferPlaceholderReplacement(llvm::Instruction *Old, 2932 llvm::Value *New) { 2933 DeferredReplacements.push_back(std::make_pair(Old, New)); 2934 } 2935 2936 RValue CodeGenFunction::EmitCall(const CGFunctionInfo &CallInfo, 2937 llvm::Value *Callee, 2938 ReturnValueSlot ReturnValue, 2939 const CallArgList &CallArgs, 2940 const Decl *TargetDecl, 2941 llvm::Instruction **callOrInvoke) { 2942 // FIXME: We no longer need the types from CallArgs; lift up and simplify. 2943 2944 // Handle struct-return functions by passing a pointer to the 2945 // location that we would like to return into. 2946 QualType RetTy = CallInfo.getReturnType(); 2947 const ABIArgInfo &RetAI = CallInfo.getReturnInfo(); 2948 2949 llvm::FunctionType *IRFuncTy = 2950 cast<llvm::FunctionType>( 2951 cast<llvm::PointerType>(Callee->getType())->getElementType()); 2952 2953 // If we're using inalloca, insert the allocation after the stack save. 2954 // FIXME: Do this earlier rather than hacking it in here! 2955 llvm::Value *ArgMemory = nullptr; 2956 if (llvm::StructType *ArgStruct = CallInfo.getArgStruct()) { 2957 llvm::Instruction *IP = CallArgs.getStackBase(); 2958 llvm::AllocaInst *AI; 2959 if (IP) { 2960 IP = IP->getNextNode(); 2961 AI = new llvm::AllocaInst(ArgStruct, "argmem", IP); 2962 } else { 2963 AI = CreateTempAlloca(ArgStruct, "argmem"); 2964 } 2965 AI->setUsedWithInAlloca(true); 2966 assert(AI->isUsedWithInAlloca() && !AI->isStaticAlloca()); 2967 ArgMemory = AI; 2968 } 2969 2970 ClangToLLVMArgMapping IRFunctionArgs(CGM.getContext(), CallInfo); 2971 SmallVector<llvm::Value *, 16> IRCallArgs(IRFunctionArgs.totalIRArgs()); 2972 2973 // If the call returns a temporary with struct return, create a temporary 2974 // alloca to hold the result, unless one is given to us. 2975 llvm::Value *SRetPtr = nullptr; 2976 if (RetAI.isIndirect() || RetAI.isInAlloca()) { 2977 SRetPtr = ReturnValue.getValue(); 2978 if (!SRetPtr) 2979 SRetPtr = CreateMemTemp(RetTy); 2980 if (IRFunctionArgs.hasSRetArg()) { 2981 IRCallArgs[IRFunctionArgs.getSRetArgNo()] = SRetPtr; 2982 } else { 2983 llvm::Value *Addr = 2984 Builder.CreateStructGEP(ArgMemory, RetAI.getInAllocaFieldIndex()); 2985 Builder.CreateStore(SRetPtr, Addr); 2986 } 2987 } 2988 2989 assert(CallInfo.arg_size() == CallArgs.size() && 2990 "Mismatch between function signature & arguments."); 2991 unsigned ArgNo = 0; 2992 CGFunctionInfo::const_arg_iterator info_it = CallInfo.arg_begin(); 2993 for (CallArgList::const_iterator I = CallArgs.begin(), E = CallArgs.end(); 2994 I != E; ++I, ++info_it, ++ArgNo) { 2995 const ABIArgInfo &ArgInfo = info_it->info; 2996 RValue RV = I->RV; 2997 2998 CharUnits TypeAlign = getContext().getTypeAlignInChars(I->Ty); 2999 3000 // Insert a padding argument to ensure proper alignment. 3001 if (IRFunctionArgs.hasPaddingArg(ArgNo)) 3002 IRCallArgs[IRFunctionArgs.getPaddingArgNo(ArgNo)] = 3003 llvm::UndefValue::get(ArgInfo.getPaddingType()); 3004 3005 unsigned FirstIRArg, NumIRArgs; 3006 std::tie(FirstIRArg, NumIRArgs) = IRFunctionArgs.getIRArgs(ArgNo); 3007 3008 switch (ArgInfo.getKind()) { 3009 case ABIArgInfo::InAlloca: { 3010 assert(NumIRArgs == 0); 3011 assert(getTarget().getTriple().getArch() == llvm::Triple::x86); 3012 if (RV.isAggregate()) { 3013 // Replace the placeholder with the appropriate argument slot GEP. 3014 llvm::Instruction *Placeholder = 3015 cast<llvm::Instruction>(RV.getAggregateAddr()); 3016 CGBuilderTy::InsertPoint IP = Builder.saveIP(); 3017 Builder.SetInsertPoint(Placeholder); 3018 llvm::Value *Addr = Builder.CreateStructGEP( 3019 ArgMemory, ArgInfo.getInAllocaFieldIndex()); 3020 Builder.restoreIP(IP); 3021 deferPlaceholderReplacement(Placeholder, Addr); 3022 } else { 3023 // Store the RValue into the argument struct. 3024 llvm::Value *Addr = 3025 Builder.CreateStructGEP(ArgMemory, ArgInfo.getInAllocaFieldIndex()); 3026 unsigned AS = Addr->getType()->getPointerAddressSpace(); 3027 llvm::Type *MemType = ConvertTypeForMem(I->Ty)->getPointerTo(AS); 3028 // There are some cases where a trivial bitcast is not avoidable. The 3029 // definition of a type later in a translation unit may change it's type 3030 // from {}* to (%struct.foo*)*. 3031 if (Addr->getType() != MemType) 3032 Addr = Builder.CreateBitCast(Addr, MemType); 3033 LValue argLV = MakeAddrLValue(Addr, I->Ty, TypeAlign); 3034 EmitInitStoreOfNonAggregate(*this, RV, argLV); 3035 } 3036 break; 3037 } 3038 3039 case ABIArgInfo::Indirect: { 3040 assert(NumIRArgs == 1); 3041 if (RV.isScalar() || RV.isComplex()) { 3042 // Make a temporary alloca to pass the argument. 3043 llvm::AllocaInst *AI = CreateMemTemp(I->Ty); 3044 if (ArgInfo.getIndirectAlign() > AI->getAlignment()) 3045 AI->setAlignment(ArgInfo.getIndirectAlign()); 3046 IRCallArgs[FirstIRArg] = AI; 3047 3048 LValue argLV = MakeAddrLValue(AI, I->Ty, TypeAlign); 3049 EmitInitStoreOfNonAggregate(*this, RV, argLV); 3050 } else { 3051 // We want to avoid creating an unnecessary temporary+copy here; 3052 // however, we need one in three cases: 3053 // 1. If the argument is not byval, and we are required to copy the 3054 // source. (This case doesn't occur on any common architecture.) 3055 // 2. If the argument is byval, RV is not sufficiently aligned, and 3056 // we cannot force it to be sufficiently aligned. 3057 // 3. If the argument is byval, but RV is located in an address space 3058 // different than that of the argument (0). 3059 llvm::Value *Addr = RV.getAggregateAddr(); 3060 unsigned Align = ArgInfo.getIndirectAlign(); 3061 const llvm::DataLayout *TD = &CGM.getDataLayout(); 3062 const unsigned RVAddrSpace = Addr->getType()->getPointerAddressSpace(); 3063 const unsigned ArgAddrSpace = 3064 (FirstIRArg < IRFuncTy->getNumParams() 3065 ? IRFuncTy->getParamType(FirstIRArg)->getPointerAddressSpace() 3066 : 0); 3067 if ((!ArgInfo.getIndirectByVal() && I->NeedsCopy) || 3068 (ArgInfo.getIndirectByVal() && TypeAlign.getQuantity() < Align && 3069 llvm::getOrEnforceKnownAlignment(Addr, Align, TD) < Align) || 3070 (ArgInfo.getIndirectByVal() && (RVAddrSpace != ArgAddrSpace))) { 3071 // Create an aligned temporary, and copy to it. 3072 llvm::AllocaInst *AI = CreateMemTemp(I->Ty); 3073 if (Align > AI->getAlignment()) 3074 AI->setAlignment(Align); 3075 IRCallArgs[FirstIRArg] = AI; 3076 EmitAggregateCopy(AI, Addr, I->Ty, RV.isVolatileQualified()); 3077 } else { 3078 // Skip the extra memcpy call. 3079 IRCallArgs[FirstIRArg] = Addr; 3080 } 3081 } 3082 break; 3083 } 3084 3085 case ABIArgInfo::Ignore: 3086 assert(NumIRArgs == 0); 3087 break; 3088 3089 case ABIArgInfo::Extend: 3090 case ABIArgInfo::Direct: { 3091 if (!isa<llvm::StructType>(ArgInfo.getCoerceToType()) && 3092 ArgInfo.getCoerceToType() == ConvertType(info_it->type) && 3093 ArgInfo.getDirectOffset() == 0) { 3094 assert(NumIRArgs == 1); 3095 llvm::Value *V; 3096 if (RV.isScalar()) 3097 V = RV.getScalarVal(); 3098 else 3099 V = Builder.CreateLoad(RV.getAggregateAddr()); 3100 3101 // We might have to widen integers, but we should never truncate. 3102 if (ArgInfo.getCoerceToType() != V->getType() && 3103 V->getType()->isIntegerTy()) 3104 V = Builder.CreateZExt(V, ArgInfo.getCoerceToType()); 3105 3106 // If the argument doesn't match, perform a bitcast to coerce it. This 3107 // can happen due to trivial type mismatches. 3108 if (FirstIRArg < IRFuncTy->getNumParams() && 3109 V->getType() != IRFuncTy->getParamType(FirstIRArg)) 3110 V = Builder.CreateBitCast(V, IRFuncTy->getParamType(FirstIRArg)); 3111 IRCallArgs[FirstIRArg] = V; 3112 break; 3113 } 3114 3115 // FIXME: Avoid the conversion through memory if possible. 3116 llvm::Value *SrcPtr; 3117 if (RV.isScalar() || RV.isComplex()) { 3118 SrcPtr = CreateMemTemp(I->Ty, "coerce"); 3119 LValue SrcLV = MakeAddrLValue(SrcPtr, I->Ty, TypeAlign); 3120 EmitInitStoreOfNonAggregate(*this, RV, SrcLV); 3121 } else 3122 SrcPtr = RV.getAggregateAddr(); 3123 3124 // If the value is offset in memory, apply the offset now. 3125 if (unsigned Offs = ArgInfo.getDirectOffset()) { 3126 SrcPtr = Builder.CreateBitCast(SrcPtr, Builder.getInt8PtrTy()); 3127 SrcPtr = Builder.CreateConstGEP1_32(SrcPtr, Offs); 3128 SrcPtr = Builder.CreateBitCast(SrcPtr, 3129 llvm::PointerType::getUnqual(ArgInfo.getCoerceToType())); 3130 3131 } 3132 3133 // Fast-isel and the optimizer generally like scalar values better than 3134 // FCAs, so we flatten them if this is safe to do for this argument. 3135 llvm::StructType *STy = 3136 dyn_cast<llvm::StructType>(ArgInfo.getCoerceToType()); 3137 if (STy && ArgInfo.isDirect() && ArgInfo.getCanBeFlattened()) { 3138 llvm::Type *SrcTy = 3139 cast<llvm::PointerType>(SrcPtr->getType())->getElementType(); 3140 uint64_t SrcSize = CGM.getDataLayout().getTypeAllocSize(SrcTy); 3141 uint64_t DstSize = CGM.getDataLayout().getTypeAllocSize(STy); 3142 3143 // If the source type is smaller than the destination type of the 3144 // coerce-to logic, copy the source value into a temp alloca the size 3145 // of the destination type to allow loading all of it. The bits past 3146 // the source value are left undef. 3147 if (SrcSize < DstSize) { 3148 llvm::AllocaInst *TempAlloca 3149 = CreateTempAlloca(STy, SrcPtr->getName() + ".coerce"); 3150 Builder.CreateMemCpy(TempAlloca, SrcPtr, SrcSize, 0); 3151 SrcPtr = TempAlloca; 3152 } else { 3153 SrcPtr = Builder.CreateBitCast(SrcPtr, 3154 llvm::PointerType::getUnqual(STy)); 3155 } 3156 3157 assert(NumIRArgs == STy->getNumElements()); 3158 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) { 3159 llvm::Value *EltPtr = Builder.CreateConstGEP2_32(SrcPtr, 0, i); 3160 llvm::LoadInst *LI = Builder.CreateLoad(EltPtr); 3161 // We don't know what we're loading from. 3162 LI->setAlignment(1); 3163 IRCallArgs[FirstIRArg + i] = LI; 3164 } 3165 } else { 3166 // In the simple case, just pass the coerced loaded value. 3167 assert(NumIRArgs == 1); 3168 IRCallArgs[FirstIRArg] = 3169 CreateCoercedLoad(SrcPtr, ArgInfo.getCoerceToType(), *this); 3170 } 3171 3172 break; 3173 } 3174 3175 case ABIArgInfo::Expand: 3176 unsigned IRArgPos = FirstIRArg; 3177 ExpandTypeToArgs(I->Ty, RV, IRFuncTy, IRCallArgs, IRArgPos); 3178 assert(IRArgPos == FirstIRArg + NumIRArgs); 3179 break; 3180 } 3181 } 3182 3183 if (ArgMemory) { 3184 llvm::Value *Arg = ArgMemory; 3185 if (CallInfo.isVariadic()) { 3186 // When passing non-POD arguments by value to variadic functions, we will 3187 // end up with a variadic prototype and an inalloca call site. In such 3188 // cases, we can't do any parameter mismatch checks. Give up and bitcast 3189 // the callee. 3190 unsigned CalleeAS = 3191 cast<llvm::PointerType>(Callee->getType())->getAddressSpace(); 3192 Callee = Builder.CreateBitCast( 3193 Callee, getTypes().GetFunctionType(CallInfo)->getPointerTo(CalleeAS)); 3194 } else { 3195 llvm::Type *LastParamTy = 3196 IRFuncTy->getParamType(IRFuncTy->getNumParams() - 1); 3197 if (Arg->getType() != LastParamTy) { 3198 #ifndef NDEBUG 3199 // Assert that these structs have equivalent element types. 3200 llvm::StructType *FullTy = CallInfo.getArgStruct(); 3201 llvm::StructType *DeclaredTy = cast<llvm::StructType>( 3202 cast<llvm::PointerType>(LastParamTy)->getElementType()); 3203 assert(DeclaredTy->getNumElements() == FullTy->getNumElements()); 3204 for (llvm::StructType::element_iterator DI = DeclaredTy->element_begin(), 3205 DE = DeclaredTy->element_end(), 3206 FI = FullTy->element_begin(); 3207 DI != DE; ++DI, ++FI) 3208 assert(*DI == *FI); 3209 #endif 3210 Arg = Builder.CreateBitCast(Arg, LastParamTy); 3211 } 3212 } 3213 assert(IRFunctionArgs.hasInallocaArg()); 3214 IRCallArgs[IRFunctionArgs.getInallocaArgNo()] = Arg; 3215 } 3216 3217 if (!CallArgs.getCleanupsToDeactivate().empty()) 3218 deactivateArgCleanupsBeforeCall(*this, CallArgs); 3219 3220 // If the callee is a bitcast of a function to a varargs pointer to function 3221 // type, check to see if we can remove the bitcast. This handles some cases 3222 // with unprototyped functions. 3223 if (llvm::ConstantExpr *CE = dyn_cast<llvm::ConstantExpr>(Callee)) 3224 if (llvm::Function *CalleeF = dyn_cast<llvm::Function>(CE->getOperand(0))) { 3225 llvm::PointerType *CurPT=cast<llvm::PointerType>(Callee->getType()); 3226 llvm::FunctionType *CurFT = 3227 cast<llvm::FunctionType>(CurPT->getElementType()); 3228 llvm::FunctionType *ActualFT = CalleeF->getFunctionType(); 3229 3230 if (CE->getOpcode() == llvm::Instruction::BitCast && 3231 ActualFT->getReturnType() == CurFT->getReturnType() && 3232 ActualFT->getNumParams() == CurFT->getNumParams() && 3233 ActualFT->getNumParams() == IRCallArgs.size() && 3234 (CurFT->isVarArg() || !ActualFT->isVarArg())) { 3235 bool ArgsMatch = true; 3236 for (unsigned i = 0, e = ActualFT->getNumParams(); i != e; ++i) 3237 if (ActualFT->getParamType(i) != CurFT->getParamType(i)) { 3238 ArgsMatch = false; 3239 break; 3240 } 3241 3242 // Strip the cast if we can get away with it. This is a nice cleanup, 3243 // but also allows us to inline the function at -O0 if it is marked 3244 // always_inline. 3245 if (ArgsMatch) 3246 Callee = CalleeF; 3247 } 3248 } 3249 3250 assert(IRCallArgs.size() == IRFuncTy->getNumParams() || IRFuncTy->isVarArg()); 3251 for (unsigned i = 0; i < IRCallArgs.size(); ++i) { 3252 // Inalloca argument can have different type. 3253 if (IRFunctionArgs.hasInallocaArg() && 3254 i == IRFunctionArgs.getInallocaArgNo()) 3255 continue; 3256 if (i < IRFuncTy->getNumParams()) 3257 assert(IRCallArgs[i]->getType() == IRFuncTy->getParamType(i)); 3258 } 3259 3260 unsigned CallingConv; 3261 CodeGen::AttributeListType AttributeList; 3262 CGM.ConstructAttributeList(CallInfo, TargetDecl, AttributeList, 3263 CallingConv, true); 3264 llvm::AttributeSet Attrs = llvm::AttributeSet::get(getLLVMContext(), 3265 AttributeList); 3266 3267 llvm::BasicBlock *InvokeDest = nullptr; 3268 if (!Attrs.hasAttribute(llvm::AttributeSet::FunctionIndex, 3269 llvm::Attribute::NoUnwind)) 3270 InvokeDest = getInvokeDest(); 3271 3272 llvm::CallSite CS; 3273 if (!InvokeDest) { 3274 CS = Builder.CreateCall(Callee, IRCallArgs); 3275 } else { 3276 llvm::BasicBlock *Cont = createBasicBlock("invoke.cont"); 3277 CS = Builder.CreateInvoke(Callee, Cont, InvokeDest, IRCallArgs); 3278 EmitBlock(Cont); 3279 } 3280 if (callOrInvoke) 3281 *callOrInvoke = CS.getInstruction(); 3282 3283 if (CurCodeDecl && CurCodeDecl->hasAttr<FlattenAttr>() && 3284 !CS.hasFnAttr(llvm::Attribute::NoInline)) 3285 Attrs = 3286 Attrs.addAttribute(getLLVMContext(), llvm::AttributeSet::FunctionIndex, 3287 llvm::Attribute::AlwaysInline); 3288 3289 CS.setAttributes(Attrs); 3290 CS.setCallingConv(static_cast<llvm::CallingConv::ID>(CallingConv)); 3291 3292 // In ObjC ARC mode with no ObjC ARC exception safety, tell the ARC 3293 // optimizer it can aggressively ignore unwind edges. 3294 if (CGM.getLangOpts().ObjCAutoRefCount) 3295 AddObjCARCExceptionMetadata(CS.getInstruction()); 3296 3297 // If the call doesn't return, finish the basic block and clear the 3298 // insertion point; this allows the rest of IRgen to discard 3299 // unreachable code. 3300 if (CS.doesNotReturn()) { 3301 Builder.CreateUnreachable(); 3302 Builder.ClearInsertionPoint(); 3303 3304 // FIXME: For now, emit a dummy basic block because expr emitters in 3305 // generally are not ready to handle emitting expressions at unreachable 3306 // points. 3307 EnsureInsertPoint(); 3308 3309 // Return a reasonable RValue. 3310 return GetUndefRValue(RetTy); 3311 } 3312 3313 llvm::Instruction *CI = CS.getInstruction(); 3314 if (Builder.isNamePreserving() && !CI->getType()->isVoidTy()) 3315 CI->setName("call"); 3316 3317 // Emit any writebacks immediately. Arguably this should happen 3318 // after any return-value munging. 3319 if (CallArgs.hasWritebacks()) 3320 emitWritebacks(*this, CallArgs); 3321 3322 // The stack cleanup for inalloca arguments has to run out of the normal 3323 // lexical order, so deactivate it and run it manually here. 3324 CallArgs.freeArgumentMemory(*this); 3325 3326 RValue Ret = [&] { 3327 switch (RetAI.getKind()) { 3328 case ABIArgInfo::InAlloca: 3329 case ABIArgInfo::Indirect: 3330 return convertTempToRValue(SRetPtr, RetTy, SourceLocation()); 3331 3332 case ABIArgInfo::Ignore: 3333 // If we are ignoring an argument that had a result, make sure to 3334 // construct the appropriate return value for our caller. 3335 return GetUndefRValue(RetTy); 3336 3337 case ABIArgInfo::Extend: 3338 case ABIArgInfo::Direct: { 3339 llvm::Type *RetIRTy = ConvertType(RetTy); 3340 if (RetAI.getCoerceToType() == RetIRTy && RetAI.getDirectOffset() == 0) { 3341 switch (getEvaluationKind(RetTy)) { 3342 case TEK_Complex: { 3343 llvm::Value *Real = Builder.CreateExtractValue(CI, 0); 3344 llvm::Value *Imag = Builder.CreateExtractValue(CI, 1); 3345 return RValue::getComplex(std::make_pair(Real, Imag)); 3346 } 3347 case TEK_Aggregate: { 3348 llvm::Value *DestPtr = ReturnValue.getValue(); 3349 bool DestIsVolatile = ReturnValue.isVolatile(); 3350 3351 if (!DestPtr) { 3352 DestPtr = CreateMemTemp(RetTy, "agg.tmp"); 3353 DestIsVolatile = false; 3354 } 3355 BuildAggStore(*this, CI, DestPtr, DestIsVolatile, false); 3356 return RValue::getAggregate(DestPtr); 3357 } 3358 case TEK_Scalar: { 3359 // If the argument doesn't match, perform a bitcast to coerce it. This 3360 // can happen due to trivial type mismatches. 3361 llvm::Value *V = CI; 3362 if (V->getType() != RetIRTy) 3363 V = Builder.CreateBitCast(V, RetIRTy); 3364 return RValue::get(V); 3365 } 3366 } 3367 llvm_unreachable("bad evaluation kind"); 3368 } 3369 3370 llvm::Value *DestPtr = ReturnValue.getValue(); 3371 bool DestIsVolatile = ReturnValue.isVolatile(); 3372 3373 if (!DestPtr) { 3374 DestPtr = CreateMemTemp(RetTy, "coerce"); 3375 DestIsVolatile = false; 3376 } 3377 3378 // If the value is offset in memory, apply the offset now. 3379 llvm::Value *StorePtr = DestPtr; 3380 if (unsigned Offs = RetAI.getDirectOffset()) { 3381 StorePtr = Builder.CreateBitCast(StorePtr, Builder.getInt8PtrTy()); 3382 StorePtr = Builder.CreateConstGEP1_32(StorePtr, Offs); 3383 StorePtr = Builder.CreateBitCast(StorePtr, 3384 llvm::PointerType::getUnqual(RetAI.getCoerceToType())); 3385 } 3386 CreateCoercedStore(CI, StorePtr, DestIsVolatile, *this); 3387 3388 return convertTempToRValue(DestPtr, RetTy, SourceLocation()); 3389 } 3390 3391 case ABIArgInfo::Expand: 3392 llvm_unreachable("Invalid ABI kind for return argument"); 3393 } 3394 3395 llvm_unreachable("Unhandled ABIArgInfo::Kind"); 3396 } (); 3397 3398 if (Ret.isScalar() && TargetDecl) { 3399 if (const auto *AA = TargetDecl->getAttr<AssumeAlignedAttr>()) { 3400 llvm::Value *OffsetValue = nullptr; 3401 if (const auto *Offset = AA->getOffset()) 3402 OffsetValue = EmitScalarExpr(Offset); 3403 3404 llvm::Value *Alignment = EmitScalarExpr(AA->getAlignment()); 3405 llvm::ConstantInt *AlignmentCI = cast<llvm::ConstantInt>(Alignment); 3406 EmitAlignmentAssumption(Ret.getScalarVal(), AlignmentCI->getZExtValue(), 3407 OffsetValue); 3408 } 3409 } 3410 3411 return Ret; 3412 } 3413 3414 /* VarArg handling */ 3415 3416 llvm::Value *CodeGenFunction::EmitVAArg(llvm::Value *VAListAddr, QualType Ty) { 3417 return CGM.getTypes().getABIInfo().EmitVAArg(VAListAddr, Ty, *this); 3418 } 3419