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 "CGBlocks.h" 18 #include "CGCXXABI.h" 19 #include "CGCleanup.h" 20 #include "CodeGenFunction.h" 21 #include "CodeGenModule.h" 22 #include "TargetInfo.h" 23 #include "clang/AST/Decl.h" 24 #include "clang/AST/DeclCXX.h" 25 #include "clang/AST/DeclObjC.h" 26 #include "clang/Basic/TargetBuiltins.h" 27 #include "clang/Basic/TargetInfo.h" 28 #include "clang/CodeGen/CGFunctionInfo.h" 29 #include "clang/CodeGen/SwiftCallingConv.h" 30 #include "clang/Frontend/CodeGenOptions.h" 31 #include "llvm/ADT/StringExtras.h" 32 #include "llvm/Analysis/ValueTracking.h" 33 #include "llvm/IR/Attributes.h" 34 #include "llvm/IR/CallingConv.h" 35 #include "llvm/IR/CallSite.h" 36 #include "llvm/IR/DataLayout.h" 37 #include "llvm/IR/InlineAsm.h" 38 #include "llvm/IR/Intrinsics.h" 39 #include "llvm/IR/IntrinsicInst.h" 40 #include "llvm/Transforms/Utils/Local.h" 41 using namespace clang; 42 using namespace CodeGen; 43 44 /***/ 45 46 unsigned CodeGenTypes::ClangCallConvToLLVMCallConv(CallingConv CC) { 47 switch (CC) { 48 default: return llvm::CallingConv::C; 49 case CC_X86StdCall: return llvm::CallingConv::X86_StdCall; 50 case CC_X86FastCall: return llvm::CallingConv::X86_FastCall; 51 case CC_X86RegCall: return llvm::CallingConv::X86_RegCall; 52 case CC_X86ThisCall: return llvm::CallingConv::X86_ThisCall; 53 case CC_X86_64Win64: return llvm::CallingConv::X86_64_Win64; 54 case CC_X86_64SysV: return llvm::CallingConv::X86_64_SysV; 55 case CC_AAPCS: return llvm::CallingConv::ARM_AAPCS; 56 case CC_AAPCS_VFP: return llvm::CallingConv::ARM_AAPCS_VFP; 57 case CC_IntelOclBicc: return llvm::CallingConv::Intel_OCL_BI; 58 // TODO: Add support for __pascal to LLVM. 59 case CC_X86Pascal: return llvm::CallingConv::C; 60 // TODO: Add support for __vectorcall to LLVM. 61 case CC_X86VectorCall: return llvm::CallingConv::X86_VectorCall; 62 case CC_SpirFunction: return llvm::CallingConv::SPIR_FUNC; 63 case CC_OpenCLKernel: return CGM.getTargetCodeGenInfo().getOpenCLKernelCallingConv(); 64 case CC_PreserveMost: return llvm::CallingConv::PreserveMost; 65 case CC_PreserveAll: return llvm::CallingConv::PreserveAll; 66 case CC_Swift: return llvm::CallingConv::Swift; 67 } 68 } 69 70 /// Derives the 'this' type for codegen purposes, i.e. ignoring method 71 /// qualification. 72 /// FIXME: address space qualification? 73 static CanQualType GetThisType(ASTContext &Context, const CXXRecordDecl *RD) { 74 QualType RecTy = Context.getTagDeclType(RD)->getCanonicalTypeInternal(); 75 return Context.getPointerType(CanQualType::CreateUnsafe(RecTy)); 76 } 77 78 /// Returns the canonical formal type of the given C++ method. 79 static CanQual<FunctionProtoType> GetFormalType(const CXXMethodDecl *MD) { 80 return MD->getType()->getCanonicalTypeUnqualified() 81 .getAs<FunctionProtoType>(); 82 } 83 84 /// Returns the "extra-canonicalized" return type, which discards 85 /// qualifiers on the return type. Codegen doesn't care about them, 86 /// and it makes ABI code a little easier to be able to assume that 87 /// all parameter and return types are top-level unqualified. 88 static CanQualType GetReturnType(QualType RetTy) { 89 return RetTy->getCanonicalTypeUnqualified().getUnqualifiedType(); 90 } 91 92 /// Arrange the argument and result information for a value of the given 93 /// unprototyped freestanding function type. 94 const CGFunctionInfo & 95 CodeGenTypes::arrangeFreeFunctionType(CanQual<FunctionNoProtoType> FTNP) { 96 // When translating an unprototyped function type, always use a 97 // variadic type. 98 return arrangeLLVMFunctionInfo(FTNP->getReturnType().getUnqualifiedType(), 99 /*instanceMethod=*/false, 100 /*chainCall=*/false, None, 101 FTNP->getExtInfo(), {}, RequiredArgs(0)); 102 } 103 104 static void addExtParameterInfosForCall( 105 llvm::SmallVectorImpl<FunctionProtoType::ExtParameterInfo> ¶mInfos, 106 const FunctionProtoType *proto, 107 unsigned prefixArgs, 108 unsigned totalArgs) { 109 assert(proto->hasExtParameterInfos()); 110 assert(paramInfos.size() <= prefixArgs); 111 assert(proto->getNumParams() + prefixArgs <= totalArgs); 112 113 paramInfos.reserve(totalArgs); 114 115 // Add default infos for any prefix args that don't already have infos. 116 paramInfos.resize(prefixArgs); 117 118 // Add infos for the prototype. 119 for (const auto &ParamInfo : proto->getExtParameterInfos()) { 120 paramInfos.push_back(ParamInfo); 121 // pass_object_size params have no parameter info. 122 if (ParamInfo.hasPassObjectSize()) 123 paramInfos.emplace_back(); 124 } 125 126 assert(paramInfos.size() <= totalArgs && 127 "Did we forget to insert pass_object_size args?"); 128 // Add default infos for the variadic and/or suffix arguments. 129 paramInfos.resize(totalArgs); 130 } 131 132 /// Adds the formal paramaters in FPT to the given prefix. If any parameter in 133 /// FPT has pass_object_size attrs, then we'll add parameters for those, too. 134 static void appendParameterTypes(const CodeGenTypes &CGT, 135 SmallVectorImpl<CanQualType> &prefix, 136 SmallVectorImpl<FunctionProtoType::ExtParameterInfo> ¶mInfos, 137 CanQual<FunctionProtoType> FPT) { 138 // Fast path: don't touch param info if we don't need to. 139 if (!FPT->hasExtParameterInfos()) { 140 assert(paramInfos.empty() && 141 "We have paramInfos, but the prototype doesn't?"); 142 prefix.append(FPT->param_type_begin(), FPT->param_type_end()); 143 return; 144 } 145 146 unsigned PrefixSize = prefix.size(); 147 // In the vast majority of cases, we'll have precisely FPT->getNumParams() 148 // parameters; the only thing that can change this is the presence of 149 // pass_object_size. So, we preallocate for the common case. 150 prefix.reserve(prefix.size() + FPT->getNumParams()); 151 152 auto ExtInfos = FPT->getExtParameterInfos(); 153 assert(ExtInfos.size() == FPT->getNumParams()); 154 for (unsigned I = 0, E = FPT->getNumParams(); I != E; ++I) { 155 prefix.push_back(FPT->getParamType(I)); 156 if (ExtInfos[I].hasPassObjectSize()) 157 prefix.push_back(CGT.getContext().getSizeType()); 158 } 159 160 addExtParameterInfosForCall(paramInfos, FPT.getTypePtr(), PrefixSize, 161 prefix.size()); 162 } 163 164 /// Arrange the LLVM function layout for a value of the given function 165 /// type, on top of any implicit parameters already stored. 166 static const CGFunctionInfo & 167 arrangeLLVMFunctionInfo(CodeGenTypes &CGT, bool instanceMethod, 168 SmallVectorImpl<CanQualType> &prefix, 169 CanQual<FunctionProtoType> FTP, 170 const FunctionDecl *FD) { 171 SmallVector<FunctionProtoType::ExtParameterInfo, 16> paramInfos; 172 RequiredArgs Required = 173 RequiredArgs::forPrototypePlus(FTP, prefix.size(), FD); 174 // FIXME: Kill copy. 175 appendParameterTypes(CGT, prefix, paramInfos, FTP); 176 CanQualType resultType = FTP->getReturnType().getUnqualifiedType(); 177 178 return CGT.arrangeLLVMFunctionInfo(resultType, instanceMethod, 179 /*chainCall=*/false, prefix, 180 FTP->getExtInfo(), paramInfos, 181 Required); 182 } 183 184 /// Arrange the argument and result information for a value of the 185 /// given freestanding function type. 186 const CGFunctionInfo & 187 CodeGenTypes::arrangeFreeFunctionType(CanQual<FunctionProtoType> FTP, 188 const FunctionDecl *FD) { 189 SmallVector<CanQualType, 16> argTypes; 190 return ::arrangeLLVMFunctionInfo(*this, /*instanceMethod=*/false, argTypes, 191 FTP, FD); 192 } 193 194 static CallingConv getCallingConventionForDecl(const Decl *D, bool IsWindows) { 195 // Set the appropriate calling convention for the Function. 196 if (D->hasAttr<StdCallAttr>()) 197 return CC_X86StdCall; 198 199 if (D->hasAttr<FastCallAttr>()) 200 return CC_X86FastCall; 201 202 if (D->hasAttr<RegCallAttr>()) 203 return CC_X86RegCall; 204 205 if (D->hasAttr<ThisCallAttr>()) 206 return CC_X86ThisCall; 207 208 if (D->hasAttr<VectorCallAttr>()) 209 return CC_X86VectorCall; 210 211 if (D->hasAttr<PascalAttr>()) 212 return CC_X86Pascal; 213 214 if (PcsAttr *PCS = D->getAttr<PcsAttr>()) 215 return (PCS->getPCS() == PcsAttr::AAPCS ? CC_AAPCS : CC_AAPCS_VFP); 216 217 if (D->hasAttr<IntelOclBiccAttr>()) 218 return CC_IntelOclBicc; 219 220 if (D->hasAttr<MSABIAttr>()) 221 return IsWindows ? CC_C : CC_X86_64Win64; 222 223 if (D->hasAttr<SysVABIAttr>()) 224 return IsWindows ? CC_X86_64SysV : CC_C; 225 226 if (D->hasAttr<PreserveMostAttr>()) 227 return CC_PreserveMost; 228 229 if (D->hasAttr<PreserveAllAttr>()) 230 return CC_PreserveAll; 231 232 return CC_C; 233 } 234 235 /// Arrange the argument and result information for a call to an 236 /// unknown C++ non-static member function of the given abstract type. 237 /// (Zero value of RD means we don't have any meaningful "this" argument type, 238 /// so fall back to a generic pointer type). 239 /// The member function must be an ordinary function, i.e. not a 240 /// constructor or destructor. 241 const CGFunctionInfo & 242 CodeGenTypes::arrangeCXXMethodType(const CXXRecordDecl *RD, 243 const FunctionProtoType *FTP, 244 const CXXMethodDecl *MD) { 245 SmallVector<CanQualType, 16> argTypes; 246 247 // Add the 'this' pointer. 248 if (RD) 249 argTypes.push_back(GetThisType(Context, RD)); 250 else 251 argTypes.push_back(Context.VoidPtrTy); 252 253 return ::arrangeLLVMFunctionInfo( 254 *this, true, argTypes, 255 FTP->getCanonicalTypeUnqualified().getAs<FunctionProtoType>(), MD); 256 } 257 258 /// Arrange the argument and result information for a declaration or 259 /// definition of the given C++ non-static member function. The 260 /// member function must be an ordinary function, i.e. not a 261 /// constructor or destructor. 262 const CGFunctionInfo & 263 CodeGenTypes::arrangeCXXMethodDeclaration(const CXXMethodDecl *MD) { 264 assert(!isa<CXXConstructorDecl>(MD) && "wrong method for constructors!"); 265 assert(!isa<CXXDestructorDecl>(MD) && "wrong method for destructors!"); 266 267 CanQual<FunctionProtoType> prototype = GetFormalType(MD); 268 269 if (MD->isInstance()) { 270 // The abstract case is perfectly fine. 271 const CXXRecordDecl *ThisType = TheCXXABI.getThisArgumentTypeForMethod(MD); 272 return arrangeCXXMethodType(ThisType, prototype.getTypePtr(), MD); 273 } 274 275 return arrangeFreeFunctionType(prototype, MD); 276 } 277 278 bool CodeGenTypes::inheritingCtorHasParams( 279 const InheritedConstructor &Inherited, CXXCtorType Type) { 280 // Parameters are unnecessary if we're constructing a base class subobject 281 // and the inherited constructor lives in a virtual base. 282 return Type == Ctor_Complete || 283 !Inherited.getShadowDecl()->constructsVirtualBase() || 284 !Target.getCXXABI().hasConstructorVariants(); 285 } 286 287 const CGFunctionInfo & 288 CodeGenTypes::arrangeCXXStructorDeclaration(const CXXMethodDecl *MD, 289 StructorType Type) { 290 291 SmallVector<CanQualType, 16> argTypes; 292 SmallVector<FunctionProtoType::ExtParameterInfo, 16> paramInfos; 293 argTypes.push_back(GetThisType(Context, MD->getParent())); 294 295 bool PassParams = true; 296 297 GlobalDecl GD; 298 if (auto *CD = dyn_cast<CXXConstructorDecl>(MD)) { 299 GD = GlobalDecl(CD, toCXXCtorType(Type)); 300 301 // A base class inheriting constructor doesn't get forwarded arguments 302 // needed to construct a virtual base (or base class thereof). 303 if (auto Inherited = CD->getInheritedConstructor()) 304 PassParams = inheritingCtorHasParams(Inherited, toCXXCtorType(Type)); 305 } else { 306 auto *DD = dyn_cast<CXXDestructorDecl>(MD); 307 GD = GlobalDecl(DD, toCXXDtorType(Type)); 308 } 309 310 CanQual<FunctionProtoType> FTP = GetFormalType(MD); 311 312 // Add the formal parameters. 313 if (PassParams) 314 appendParameterTypes(*this, argTypes, paramInfos, FTP); 315 316 CGCXXABI::AddedStructorArgs AddedArgs = 317 TheCXXABI.buildStructorSignature(MD, Type, argTypes); 318 if (!paramInfos.empty()) { 319 // Note: prefix implies after the first param. 320 if (AddedArgs.Prefix) 321 paramInfos.insert(paramInfos.begin() + 1, AddedArgs.Prefix, 322 FunctionProtoType::ExtParameterInfo{}); 323 if (AddedArgs.Suffix) 324 paramInfos.append(AddedArgs.Suffix, 325 FunctionProtoType::ExtParameterInfo{}); 326 } 327 328 RequiredArgs required = 329 (PassParams && MD->isVariadic() ? RequiredArgs(argTypes.size()) 330 : RequiredArgs::All); 331 332 FunctionType::ExtInfo extInfo = FTP->getExtInfo(); 333 CanQualType resultType = TheCXXABI.HasThisReturn(GD) 334 ? argTypes.front() 335 : TheCXXABI.hasMostDerivedReturn(GD) 336 ? CGM.getContext().VoidPtrTy 337 : Context.VoidTy; 338 return arrangeLLVMFunctionInfo(resultType, /*instanceMethod=*/true, 339 /*chainCall=*/false, argTypes, extInfo, 340 paramInfos, required); 341 } 342 343 static SmallVector<CanQualType, 16> 344 getArgTypesForCall(ASTContext &ctx, const CallArgList &args) { 345 SmallVector<CanQualType, 16> argTypes; 346 for (auto &arg : args) 347 argTypes.push_back(ctx.getCanonicalParamType(arg.Ty)); 348 return argTypes; 349 } 350 351 static SmallVector<CanQualType, 16> 352 getArgTypesForDeclaration(ASTContext &ctx, const FunctionArgList &args) { 353 SmallVector<CanQualType, 16> argTypes; 354 for (auto &arg : args) 355 argTypes.push_back(ctx.getCanonicalParamType(arg->getType())); 356 return argTypes; 357 } 358 359 static llvm::SmallVector<FunctionProtoType::ExtParameterInfo, 16> 360 getExtParameterInfosForCall(const FunctionProtoType *proto, 361 unsigned prefixArgs, unsigned totalArgs) { 362 llvm::SmallVector<FunctionProtoType::ExtParameterInfo, 16> result; 363 if (proto->hasExtParameterInfos()) { 364 addExtParameterInfosForCall(result, proto, prefixArgs, totalArgs); 365 } 366 return result; 367 } 368 369 /// Arrange a call to a C++ method, passing the given arguments. 370 /// 371 /// ExtraPrefixArgs is the number of ABI-specific args passed after the `this` 372 /// parameter. 373 /// ExtraSuffixArgs is the number of ABI-specific args passed at the end of 374 /// args. 375 /// PassProtoArgs indicates whether `args` has args for the parameters in the 376 /// given CXXConstructorDecl. 377 const CGFunctionInfo & 378 CodeGenTypes::arrangeCXXConstructorCall(const CallArgList &args, 379 const CXXConstructorDecl *D, 380 CXXCtorType CtorKind, 381 unsigned ExtraPrefixArgs, 382 unsigned ExtraSuffixArgs, 383 bool PassProtoArgs) { 384 // FIXME: Kill copy. 385 SmallVector<CanQualType, 16> ArgTypes; 386 for (const auto &Arg : args) 387 ArgTypes.push_back(Context.getCanonicalParamType(Arg.Ty)); 388 389 // +1 for implicit this, which should always be args[0]. 390 unsigned TotalPrefixArgs = 1 + ExtraPrefixArgs; 391 392 CanQual<FunctionProtoType> FPT = GetFormalType(D); 393 RequiredArgs Required = 394 RequiredArgs::forPrototypePlus(FPT, TotalPrefixArgs + ExtraSuffixArgs, D); 395 GlobalDecl GD(D, CtorKind); 396 CanQualType ResultType = TheCXXABI.HasThisReturn(GD) 397 ? ArgTypes.front() 398 : TheCXXABI.hasMostDerivedReturn(GD) 399 ? CGM.getContext().VoidPtrTy 400 : Context.VoidTy; 401 402 FunctionType::ExtInfo Info = FPT->getExtInfo(); 403 llvm::SmallVector<FunctionProtoType::ExtParameterInfo, 16> ParamInfos; 404 // If the prototype args are elided, we should only have ABI-specific args, 405 // which never have param info. 406 if (PassProtoArgs && FPT->hasExtParameterInfos()) { 407 // ABI-specific suffix arguments are treated the same as variadic arguments. 408 addExtParameterInfosForCall(ParamInfos, FPT.getTypePtr(), TotalPrefixArgs, 409 ArgTypes.size()); 410 } 411 return arrangeLLVMFunctionInfo(ResultType, /*instanceMethod=*/true, 412 /*chainCall=*/false, ArgTypes, Info, 413 ParamInfos, Required); 414 } 415 416 /// Arrange the argument and result information for the declaration or 417 /// definition of the given function. 418 const CGFunctionInfo & 419 CodeGenTypes::arrangeFunctionDeclaration(const FunctionDecl *FD) { 420 if (const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(FD)) 421 if (MD->isInstance()) 422 return arrangeCXXMethodDeclaration(MD); 423 424 CanQualType FTy = FD->getType()->getCanonicalTypeUnqualified(); 425 426 assert(isa<FunctionType>(FTy)); 427 428 // When declaring a function without a prototype, always use a 429 // non-variadic type. 430 if (CanQual<FunctionNoProtoType> noProto = FTy.getAs<FunctionNoProtoType>()) { 431 return arrangeLLVMFunctionInfo( 432 noProto->getReturnType(), /*instanceMethod=*/false, 433 /*chainCall=*/false, None, noProto->getExtInfo(), {},RequiredArgs::All); 434 } 435 436 return arrangeFreeFunctionType(FTy.castAs<FunctionProtoType>(), FD); 437 } 438 439 /// Arrange the argument and result information for the declaration or 440 /// definition of an Objective-C method. 441 const CGFunctionInfo & 442 CodeGenTypes::arrangeObjCMethodDeclaration(const ObjCMethodDecl *MD) { 443 // It happens that this is the same as a call with no optional 444 // arguments, except also using the formal 'self' type. 445 return arrangeObjCMessageSendSignature(MD, MD->getSelfDecl()->getType()); 446 } 447 448 /// Arrange the argument and result information for the function type 449 /// through which to perform a send to the given Objective-C method, 450 /// using the given receiver type. The receiver type is not always 451 /// the 'self' type of the method or even an Objective-C pointer type. 452 /// This is *not* the right method for actually performing such a 453 /// message send, due to the possibility of optional arguments. 454 const CGFunctionInfo & 455 CodeGenTypes::arrangeObjCMessageSendSignature(const ObjCMethodDecl *MD, 456 QualType receiverType) { 457 SmallVector<CanQualType, 16> argTys; 458 argTys.push_back(Context.getCanonicalParamType(receiverType)); 459 argTys.push_back(Context.getCanonicalParamType(Context.getObjCSelType())); 460 // FIXME: Kill copy? 461 for (const auto *I : MD->parameters()) { 462 argTys.push_back(Context.getCanonicalParamType(I->getType())); 463 } 464 465 FunctionType::ExtInfo einfo; 466 bool IsWindows = getContext().getTargetInfo().getTriple().isOSWindows(); 467 einfo = einfo.withCallingConv(getCallingConventionForDecl(MD, IsWindows)); 468 469 if (getContext().getLangOpts().ObjCAutoRefCount && 470 MD->hasAttr<NSReturnsRetainedAttr>()) 471 einfo = einfo.withProducesResult(true); 472 473 RequiredArgs required = 474 (MD->isVariadic() ? RequiredArgs(argTys.size()) : RequiredArgs::All); 475 476 return arrangeLLVMFunctionInfo( 477 GetReturnType(MD->getReturnType()), /*instanceMethod=*/false, 478 /*chainCall=*/false, argTys, einfo, {}, required); 479 } 480 481 const CGFunctionInfo & 482 CodeGenTypes::arrangeUnprototypedObjCMessageSend(QualType returnType, 483 const CallArgList &args) { 484 auto argTypes = getArgTypesForCall(Context, args); 485 FunctionType::ExtInfo einfo; 486 487 return arrangeLLVMFunctionInfo( 488 GetReturnType(returnType), /*instanceMethod=*/false, 489 /*chainCall=*/false, argTypes, einfo, {}, RequiredArgs::All); 490 } 491 492 const CGFunctionInfo & 493 CodeGenTypes::arrangeGlobalDeclaration(GlobalDecl GD) { 494 // FIXME: Do we need to handle ObjCMethodDecl? 495 const FunctionDecl *FD = cast<FunctionDecl>(GD.getDecl()); 496 497 if (const CXXConstructorDecl *CD = dyn_cast<CXXConstructorDecl>(FD)) 498 return arrangeCXXStructorDeclaration(CD, getFromCtorType(GD.getCtorType())); 499 500 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(FD)) 501 return arrangeCXXStructorDeclaration(DD, getFromDtorType(GD.getDtorType())); 502 503 return arrangeFunctionDeclaration(FD); 504 } 505 506 /// Arrange a thunk that takes 'this' as the first parameter followed by 507 /// varargs. Return a void pointer, regardless of the actual return type. 508 /// The body of the thunk will end in a musttail call to a function of the 509 /// correct type, and the caller will bitcast the function to the correct 510 /// prototype. 511 const CGFunctionInfo & 512 CodeGenTypes::arrangeMSMemberPointerThunk(const CXXMethodDecl *MD) { 513 assert(MD->isVirtual() && "only virtual memptrs have thunks"); 514 CanQual<FunctionProtoType> FTP = GetFormalType(MD); 515 CanQualType ArgTys[] = { GetThisType(Context, MD->getParent()) }; 516 return arrangeLLVMFunctionInfo(Context.VoidTy, /*instanceMethod=*/false, 517 /*chainCall=*/false, ArgTys, 518 FTP->getExtInfo(), {}, RequiredArgs(1)); 519 } 520 521 const CGFunctionInfo & 522 CodeGenTypes::arrangeMSCtorClosure(const CXXConstructorDecl *CD, 523 CXXCtorType CT) { 524 assert(CT == Ctor_CopyingClosure || CT == Ctor_DefaultClosure); 525 526 CanQual<FunctionProtoType> FTP = GetFormalType(CD); 527 SmallVector<CanQualType, 2> ArgTys; 528 const CXXRecordDecl *RD = CD->getParent(); 529 ArgTys.push_back(GetThisType(Context, RD)); 530 if (CT == Ctor_CopyingClosure) 531 ArgTys.push_back(*FTP->param_type_begin()); 532 if (RD->getNumVBases() > 0) 533 ArgTys.push_back(Context.IntTy); 534 CallingConv CC = Context.getDefaultCallingConvention( 535 /*IsVariadic=*/false, /*IsCXXMethod=*/true); 536 return arrangeLLVMFunctionInfo(Context.VoidTy, /*instanceMethod=*/true, 537 /*chainCall=*/false, ArgTys, 538 FunctionType::ExtInfo(CC), {}, 539 RequiredArgs::All); 540 } 541 542 /// Arrange a call as unto a free function, except possibly with an 543 /// additional number of formal parameters considered required. 544 static const CGFunctionInfo & 545 arrangeFreeFunctionLikeCall(CodeGenTypes &CGT, 546 CodeGenModule &CGM, 547 const CallArgList &args, 548 const FunctionType *fnType, 549 unsigned numExtraRequiredArgs, 550 bool chainCall) { 551 assert(args.size() >= numExtraRequiredArgs); 552 553 llvm::SmallVector<FunctionProtoType::ExtParameterInfo, 16> paramInfos; 554 555 // In most cases, there are no optional arguments. 556 RequiredArgs required = RequiredArgs::All; 557 558 // If we have a variadic prototype, the required arguments are the 559 // extra prefix plus the arguments in the prototype. 560 if (const FunctionProtoType *proto = dyn_cast<FunctionProtoType>(fnType)) { 561 if (proto->isVariadic()) 562 required = RequiredArgs(proto->getNumParams() + numExtraRequiredArgs); 563 564 if (proto->hasExtParameterInfos()) 565 addExtParameterInfosForCall(paramInfos, proto, numExtraRequiredArgs, 566 args.size()); 567 568 // If we don't have a prototype at all, but we're supposed to 569 // explicitly use the variadic convention for unprototyped calls, 570 // treat all of the arguments as required but preserve the nominal 571 // possibility of variadics. 572 } else if (CGM.getTargetCodeGenInfo() 573 .isNoProtoCallVariadic(args, 574 cast<FunctionNoProtoType>(fnType))) { 575 required = RequiredArgs(args.size()); 576 } 577 578 // FIXME: Kill copy. 579 SmallVector<CanQualType, 16> argTypes; 580 for (const auto &arg : args) 581 argTypes.push_back(CGT.getContext().getCanonicalParamType(arg.Ty)); 582 return CGT.arrangeLLVMFunctionInfo(GetReturnType(fnType->getReturnType()), 583 /*instanceMethod=*/false, chainCall, 584 argTypes, fnType->getExtInfo(), paramInfos, 585 required); 586 } 587 588 /// Figure out the rules for calling a function with the given formal 589 /// type using the given arguments. The arguments are necessary 590 /// because the function might be unprototyped, in which case it's 591 /// target-dependent in crazy ways. 592 const CGFunctionInfo & 593 CodeGenTypes::arrangeFreeFunctionCall(const CallArgList &args, 594 const FunctionType *fnType, 595 bool chainCall) { 596 return arrangeFreeFunctionLikeCall(*this, CGM, args, fnType, 597 chainCall ? 1 : 0, chainCall); 598 } 599 600 /// A block function is essentially a free function with an 601 /// extra implicit argument. 602 const CGFunctionInfo & 603 CodeGenTypes::arrangeBlockFunctionCall(const CallArgList &args, 604 const FunctionType *fnType) { 605 return arrangeFreeFunctionLikeCall(*this, CGM, args, fnType, 1, 606 /*chainCall=*/false); 607 } 608 609 const CGFunctionInfo & 610 CodeGenTypes::arrangeBlockFunctionDeclaration(const FunctionProtoType *proto, 611 const FunctionArgList ¶ms) { 612 auto paramInfos = getExtParameterInfosForCall(proto, 1, params.size()); 613 auto argTypes = getArgTypesForDeclaration(Context, params); 614 615 return arrangeLLVMFunctionInfo( 616 GetReturnType(proto->getReturnType()), 617 /*instanceMethod*/ false, /*chainCall*/ false, argTypes, 618 proto->getExtInfo(), paramInfos, 619 RequiredArgs::forPrototypePlus(proto, 1, nullptr)); 620 } 621 622 const CGFunctionInfo & 623 CodeGenTypes::arrangeBuiltinFunctionCall(QualType resultType, 624 const CallArgList &args) { 625 // FIXME: Kill copy. 626 SmallVector<CanQualType, 16> argTypes; 627 for (const auto &Arg : args) 628 argTypes.push_back(Context.getCanonicalParamType(Arg.Ty)); 629 return arrangeLLVMFunctionInfo( 630 GetReturnType(resultType), /*instanceMethod=*/false, 631 /*chainCall=*/false, argTypes, FunctionType::ExtInfo(), 632 /*paramInfos=*/ {}, RequiredArgs::All); 633 } 634 635 const CGFunctionInfo & 636 CodeGenTypes::arrangeBuiltinFunctionDeclaration(QualType resultType, 637 const FunctionArgList &args) { 638 auto argTypes = getArgTypesForDeclaration(Context, args); 639 640 return arrangeLLVMFunctionInfo( 641 GetReturnType(resultType), /*instanceMethod=*/false, /*chainCall=*/false, 642 argTypes, FunctionType::ExtInfo(), {}, RequiredArgs::All); 643 } 644 645 const CGFunctionInfo & 646 CodeGenTypes::arrangeBuiltinFunctionDeclaration(CanQualType resultType, 647 ArrayRef<CanQualType> argTypes) { 648 return arrangeLLVMFunctionInfo( 649 resultType, /*instanceMethod=*/false, /*chainCall=*/false, 650 argTypes, FunctionType::ExtInfo(), {}, RequiredArgs::All); 651 } 652 653 /// Arrange a call to a C++ method, passing the given arguments. 654 /// 655 /// numPrefixArgs is the number of ABI-specific prefix arguments we have. It 656 /// does not count `this`. 657 const CGFunctionInfo & 658 CodeGenTypes::arrangeCXXMethodCall(const CallArgList &args, 659 const FunctionProtoType *proto, 660 RequiredArgs required, 661 unsigned numPrefixArgs) { 662 assert(numPrefixArgs + 1 <= args.size() && 663 "Emitting a call with less args than the required prefix?"); 664 // Add one to account for `this`. It's a bit awkward here, but we don't count 665 // `this` in similar places elsewhere. 666 auto paramInfos = 667 getExtParameterInfosForCall(proto, numPrefixArgs + 1, args.size()); 668 669 // FIXME: Kill copy. 670 auto argTypes = getArgTypesForCall(Context, args); 671 672 FunctionType::ExtInfo info = proto->getExtInfo(); 673 return arrangeLLVMFunctionInfo( 674 GetReturnType(proto->getReturnType()), /*instanceMethod=*/true, 675 /*chainCall=*/false, argTypes, info, paramInfos, required); 676 } 677 678 const CGFunctionInfo &CodeGenTypes::arrangeNullaryFunction() { 679 return arrangeLLVMFunctionInfo( 680 getContext().VoidTy, /*instanceMethod=*/false, /*chainCall=*/false, 681 None, FunctionType::ExtInfo(), {}, RequiredArgs::All); 682 } 683 684 const CGFunctionInfo & 685 CodeGenTypes::arrangeCall(const CGFunctionInfo &signature, 686 const CallArgList &args) { 687 assert(signature.arg_size() <= args.size()); 688 if (signature.arg_size() == args.size()) 689 return signature; 690 691 SmallVector<FunctionProtoType::ExtParameterInfo, 16> paramInfos; 692 auto sigParamInfos = signature.getExtParameterInfos(); 693 if (!sigParamInfos.empty()) { 694 paramInfos.append(sigParamInfos.begin(), sigParamInfos.end()); 695 paramInfos.resize(args.size()); 696 } 697 698 auto argTypes = getArgTypesForCall(Context, args); 699 700 assert(signature.getRequiredArgs().allowsOptionalArgs()); 701 return arrangeLLVMFunctionInfo(signature.getReturnType(), 702 signature.isInstanceMethod(), 703 signature.isChainCall(), 704 argTypes, 705 signature.getExtInfo(), 706 paramInfos, 707 signature.getRequiredArgs()); 708 } 709 710 /// Arrange the argument and result information for an abstract value 711 /// of a given function type. This is the method which all of the 712 /// above functions ultimately defer to. 713 const CGFunctionInfo & 714 CodeGenTypes::arrangeLLVMFunctionInfo(CanQualType resultType, 715 bool instanceMethod, 716 bool chainCall, 717 ArrayRef<CanQualType> argTypes, 718 FunctionType::ExtInfo info, 719 ArrayRef<FunctionProtoType::ExtParameterInfo> paramInfos, 720 RequiredArgs required) { 721 assert(std::all_of(argTypes.begin(), argTypes.end(), 722 std::mem_fun_ref(&CanQualType::isCanonicalAsParam))); 723 724 // Lookup or create unique function info. 725 llvm::FoldingSetNodeID ID; 726 CGFunctionInfo::Profile(ID, instanceMethod, chainCall, info, paramInfos, 727 required, resultType, argTypes); 728 729 void *insertPos = nullptr; 730 CGFunctionInfo *FI = FunctionInfos.FindNodeOrInsertPos(ID, insertPos); 731 if (FI) 732 return *FI; 733 734 unsigned CC = ClangCallConvToLLVMCallConv(info.getCC()); 735 736 // Construct the function info. We co-allocate the ArgInfos. 737 FI = CGFunctionInfo::create(CC, instanceMethod, chainCall, info, 738 paramInfos, resultType, argTypes, required); 739 FunctionInfos.InsertNode(FI, insertPos); 740 741 bool inserted = FunctionsBeingProcessed.insert(FI).second; 742 (void)inserted; 743 assert(inserted && "Recursively being processed?"); 744 745 // Compute ABI information. 746 if (info.getCC() != CC_Swift) { 747 getABIInfo().computeInfo(*FI); 748 } else { 749 swiftcall::computeABIInfo(CGM, *FI); 750 } 751 752 // Loop over all of the computed argument and return value info. If any of 753 // them are direct or extend without a specified coerce type, specify the 754 // default now. 755 ABIArgInfo &retInfo = FI->getReturnInfo(); 756 if (retInfo.canHaveCoerceToType() && retInfo.getCoerceToType() == nullptr) 757 retInfo.setCoerceToType(ConvertType(FI->getReturnType())); 758 759 for (auto &I : FI->arguments()) 760 if (I.info.canHaveCoerceToType() && I.info.getCoerceToType() == nullptr) 761 I.info.setCoerceToType(ConvertType(I.type)); 762 763 bool erased = FunctionsBeingProcessed.erase(FI); (void)erased; 764 assert(erased && "Not in set?"); 765 766 return *FI; 767 } 768 769 CGFunctionInfo *CGFunctionInfo::create(unsigned llvmCC, 770 bool instanceMethod, 771 bool chainCall, 772 const FunctionType::ExtInfo &info, 773 ArrayRef<ExtParameterInfo> paramInfos, 774 CanQualType resultType, 775 ArrayRef<CanQualType> argTypes, 776 RequiredArgs required) { 777 assert(paramInfos.empty() || paramInfos.size() == argTypes.size()); 778 779 void *buffer = 780 operator new(totalSizeToAlloc<ArgInfo, ExtParameterInfo>( 781 argTypes.size() + 1, paramInfos.size())); 782 783 CGFunctionInfo *FI = new(buffer) CGFunctionInfo(); 784 FI->CallingConvention = llvmCC; 785 FI->EffectiveCallingConvention = llvmCC; 786 FI->ASTCallingConvention = info.getCC(); 787 FI->InstanceMethod = instanceMethod; 788 FI->ChainCall = chainCall; 789 FI->NoReturn = info.getNoReturn(); 790 FI->ReturnsRetained = info.getProducesResult(); 791 FI->Required = required; 792 FI->HasRegParm = info.getHasRegParm(); 793 FI->RegParm = info.getRegParm(); 794 FI->ArgStruct = nullptr; 795 FI->ArgStructAlign = 0; 796 FI->NumArgs = argTypes.size(); 797 FI->HasExtParameterInfos = !paramInfos.empty(); 798 FI->getArgsBuffer()[0].type = resultType; 799 for (unsigned i = 0, e = argTypes.size(); i != e; ++i) 800 FI->getArgsBuffer()[i + 1].type = argTypes[i]; 801 for (unsigned i = 0, e = paramInfos.size(); i != e; ++i) 802 FI->getExtParameterInfosBuffer()[i] = paramInfos[i]; 803 return FI; 804 } 805 806 /***/ 807 808 namespace { 809 // ABIArgInfo::Expand implementation. 810 811 // Specifies the way QualType passed as ABIArgInfo::Expand is expanded. 812 struct TypeExpansion { 813 enum TypeExpansionKind { 814 // Elements of constant arrays are expanded recursively. 815 TEK_ConstantArray, 816 // Record fields are expanded recursively (but if record is a union, only 817 // the field with the largest size is expanded). 818 TEK_Record, 819 // For complex types, real and imaginary parts are expanded recursively. 820 TEK_Complex, 821 // All other types are not expandable. 822 TEK_None 823 }; 824 825 const TypeExpansionKind Kind; 826 827 TypeExpansion(TypeExpansionKind K) : Kind(K) {} 828 virtual ~TypeExpansion() {} 829 }; 830 831 struct ConstantArrayExpansion : TypeExpansion { 832 QualType EltTy; 833 uint64_t NumElts; 834 835 ConstantArrayExpansion(QualType EltTy, uint64_t NumElts) 836 : TypeExpansion(TEK_ConstantArray), EltTy(EltTy), NumElts(NumElts) {} 837 static bool classof(const TypeExpansion *TE) { 838 return TE->Kind == TEK_ConstantArray; 839 } 840 }; 841 842 struct RecordExpansion : TypeExpansion { 843 SmallVector<const CXXBaseSpecifier *, 1> Bases; 844 845 SmallVector<const FieldDecl *, 1> Fields; 846 847 RecordExpansion(SmallVector<const CXXBaseSpecifier *, 1> &&Bases, 848 SmallVector<const FieldDecl *, 1> &&Fields) 849 : TypeExpansion(TEK_Record), Bases(std::move(Bases)), 850 Fields(std::move(Fields)) {} 851 static bool classof(const TypeExpansion *TE) { 852 return TE->Kind == TEK_Record; 853 } 854 }; 855 856 struct ComplexExpansion : TypeExpansion { 857 QualType EltTy; 858 859 ComplexExpansion(QualType EltTy) : TypeExpansion(TEK_Complex), EltTy(EltTy) {} 860 static bool classof(const TypeExpansion *TE) { 861 return TE->Kind == TEK_Complex; 862 } 863 }; 864 865 struct NoExpansion : TypeExpansion { 866 NoExpansion() : TypeExpansion(TEK_None) {} 867 static bool classof(const TypeExpansion *TE) { 868 return TE->Kind == TEK_None; 869 } 870 }; 871 } // namespace 872 873 static std::unique_ptr<TypeExpansion> 874 getTypeExpansion(QualType Ty, const ASTContext &Context) { 875 if (const ConstantArrayType *AT = Context.getAsConstantArrayType(Ty)) { 876 return llvm::make_unique<ConstantArrayExpansion>( 877 AT->getElementType(), AT->getSize().getZExtValue()); 878 } 879 if (const RecordType *RT = Ty->getAs<RecordType>()) { 880 SmallVector<const CXXBaseSpecifier *, 1> Bases; 881 SmallVector<const FieldDecl *, 1> Fields; 882 const RecordDecl *RD = RT->getDecl(); 883 assert(!RD->hasFlexibleArrayMember() && 884 "Cannot expand structure with flexible array."); 885 if (RD->isUnion()) { 886 // Unions can be here only in degenerative cases - all the fields are same 887 // after flattening. Thus we have to use the "largest" field. 888 const FieldDecl *LargestFD = nullptr; 889 CharUnits UnionSize = CharUnits::Zero(); 890 891 for (const auto *FD : RD->fields()) { 892 // Skip zero length bitfields. 893 if (FD->isBitField() && FD->getBitWidthValue(Context) == 0) 894 continue; 895 assert(!FD->isBitField() && 896 "Cannot expand structure with bit-field members."); 897 CharUnits FieldSize = Context.getTypeSizeInChars(FD->getType()); 898 if (UnionSize < FieldSize) { 899 UnionSize = FieldSize; 900 LargestFD = FD; 901 } 902 } 903 if (LargestFD) 904 Fields.push_back(LargestFD); 905 } else { 906 if (const auto *CXXRD = dyn_cast<CXXRecordDecl>(RD)) { 907 assert(!CXXRD->isDynamicClass() && 908 "cannot expand vtable pointers in dynamic classes"); 909 for (const CXXBaseSpecifier &BS : CXXRD->bases()) 910 Bases.push_back(&BS); 911 } 912 913 for (const auto *FD : RD->fields()) { 914 // Skip zero length bitfields. 915 if (FD->isBitField() && FD->getBitWidthValue(Context) == 0) 916 continue; 917 assert(!FD->isBitField() && 918 "Cannot expand structure with bit-field members."); 919 Fields.push_back(FD); 920 } 921 } 922 return llvm::make_unique<RecordExpansion>(std::move(Bases), 923 std::move(Fields)); 924 } 925 if (const ComplexType *CT = Ty->getAs<ComplexType>()) { 926 return llvm::make_unique<ComplexExpansion>(CT->getElementType()); 927 } 928 return llvm::make_unique<NoExpansion>(); 929 } 930 931 static int getExpansionSize(QualType Ty, const ASTContext &Context) { 932 auto Exp = getTypeExpansion(Ty, Context); 933 if (auto CAExp = dyn_cast<ConstantArrayExpansion>(Exp.get())) { 934 return CAExp->NumElts * getExpansionSize(CAExp->EltTy, Context); 935 } 936 if (auto RExp = dyn_cast<RecordExpansion>(Exp.get())) { 937 int Res = 0; 938 for (auto BS : RExp->Bases) 939 Res += getExpansionSize(BS->getType(), Context); 940 for (auto FD : RExp->Fields) 941 Res += getExpansionSize(FD->getType(), Context); 942 return Res; 943 } 944 if (isa<ComplexExpansion>(Exp.get())) 945 return 2; 946 assert(isa<NoExpansion>(Exp.get())); 947 return 1; 948 } 949 950 void 951 CodeGenTypes::getExpandedTypes(QualType Ty, 952 SmallVectorImpl<llvm::Type *>::iterator &TI) { 953 auto Exp = getTypeExpansion(Ty, Context); 954 if (auto CAExp = dyn_cast<ConstantArrayExpansion>(Exp.get())) { 955 for (int i = 0, n = CAExp->NumElts; i < n; i++) { 956 getExpandedTypes(CAExp->EltTy, TI); 957 } 958 } else if (auto RExp = dyn_cast<RecordExpansion>(Exp.get())) { 959 for (auto BS : RExp->Bases) 960 getExpandedTypes(BS->getType(), TI); 961 for (auto FD : RExp->Fields) 962 getExpandedTypes(FD->getType(), TI); 963 } else if (auto CExp = dyn_cast<ComplexExpansion>(Exp.get())) { 964 llvm::Type *EltTy = ConvertType(CExp->EltTy); 965 *TI++ = EltTy; 966 *TI++ = EltTy; 967 } else { 968 assert(isa<NoExpansion>(Exp.get())); 969 *TI++ = ConvertType(Ty); 970 } 971 } 972 973 static void forConstantArrayExpansion(CodeGenFunction &CGF, 974 ConstantArrayExpansion *CAE, 975 Address BaseAddr, 976 llvm::function_ref<void(Address)> Fn) { 977 CharUnits EltSize = CGF.getContext().getTypeSizeInChars(CAE->EltTy); 978 CharUnits EltAlign = 979 BaseAddr.getAlignment().alignmentOfArrayElement(EltSize); 980 981 for (int i = 0, n = CAE->NumElts; i < n; i++) { 982 llvm::Value *EltAddr = 983 CGF.Builder.CreateConstGEP2_32(nullptr, BaseAddr.getPointer(), 0, i); 984 Fn(Address(EltAddr, EltAlign)); 985 } 986 } 987 988 void CodeGenFunction::ExpandTypeFromArgs( 989 QualType Ty, LValue LV, SmallVectorImpl<llvm::Value *>::iterator &AI) { 990 assert(LV.isSimple() && 991 "Unexpected non-simple lvalue during struct expansion."); 992 993 auto Exp = getTypeExpansion(Ty, getContext()); 994 if (auto CAExp = dyn_cast<ConstantArrayExpansion>(Exp.get())) { 995 forConstantArrayExpansion(*this, CAExp, LV.getAddress(), 996 [&](Address EltAddr) { 997 LValue LV = MakeAddrLValue(EltAddr, CAExp->EltTy); 998 ExpandTypeFromArgs(CAExp->EltTy, LV, AI); 999 }); 1000 } else if (auto RExp = dyn_cast<RecordExpansion>(Exp.get())) { 1001 Address This = LV.getAddress(); 1002 for (const CXXBaseSpecifier *BS : RExp->Bases) { 1003 // Perform a single step derived-to-base conversion. 1004 Address Base = 1005 GetAddressOfBaseClass(This, Ty->getAsCXXRecordDecl(), &BS, &BS + 1, 1006 /*NullCheckValue=*/false, SourceLocation()); 1007 LValue SubLV = MakeAddrLValue(Base, BS->getType()); 1008 1009 // Recurse onto bases. 1010 ExpandTypeFromArgs(BS->getType(), SubLV, AI); 1011 } 1012 for (auto FD : RExp->Fields) { 1013 // FIXME: What are the right qualifiers here? 1014 LValue SubLV = EmitLValueForFieldInitialization(LV, FD); 1015 ExpandTypeFromArgs(FD->getType(), SubLV, AI); 1016 } 1017 } else if (isa<ComplexExpansion>(Exp.get())) { 1018 auto realValue = *AI++; 1019 auto imagValue = *AI++; 1020 EmitStoreOfComplex(ComplexPairTy(realValue, imagValue), LV, /*init*/ true); 1021 } else { 1022 assert(isa<NoExpansion>(Exp.get())); 1023 EmitStoreThroughLValue(RValue::get(*AI++), LV); 1024 } 1025 } 1026 1027 void CodeGenFunction::ExpandTypeToArgs( 1028 QualType Ty, RValue RV, llvm::FunctionType *IRFuncTy, 1029 SmallVectorImpl<llvm::Value *> &IRCallArgs, unsigned &IRCallArgPos) { 1030 auto Exp = getTypeExpansion(Ty, getContext()); 1031 if (auto CAExp = dyn_cast<ConstantArrayExpansion>(Exp.get())) { 1032 forConstantArrayExpansion(*this, CAExp, RV.getAggregateAddress(), 1033 [&](Address EltAddr) { 1034 RValue EltRV = 1035 convertTempToRValue(EltAddr, CAExp->EltTy, SourceLocation()); 1036 ExpandTypeToArgs(CAExp->EltTy, EltRV, IRFuncTy, IRCallArgs, IRCallArgPos); 1037 }); 1038 } else if (auto RExp = dyn_cast<RecordExpansion>(Exp.get())) { 1039 Address This = RV.getAggregateAddress(); 1040 for (const CXXBaseSpecifier *BS : RExp->Bases) { 1041 // Perform a single step derived-to-base conversion. 1042 Address Base = 1043 GetAddressOfBaseClass(This, Ty->getAsCXXRecordDecl(), &BS, &BS + 1, 1044 /*NullCheckValue=*/false, SourceLocation()); 1045 RValue BaseRV = RValue::getAggregate(Base); 1046 1047 // Recurse onto bases. 1048 ExpandTypeToArgs(BS->getType(), BaseRV, IRFuncTy, IRCallArgs, 1049 IRCallArgPos); 1050 } 1051 1052 LValue LV = MakeAddrLValue(This, Ty); 1053 for (auto FD : RExp->Fields) { 1054 RValue FldRV = EmitRValueForField(LV, FD, SourceLocation()); 1055 ExpandTypeToArgs(FD->getType(), FldRV, IRFuncTy, IRCallArgs, 1056 IRCallArgPos); 1057 } 1058 } else if (isa<ComplexExpansion>(Exp.get())) { 1059 ComplexPairTy CV = RV.getComplexVal(); 1060 IRCallArgs[IRCallArgPos++] = CV.first; 1061 IRCallArgs[IRCallArgPos++] = CV.second; 1062 } else { 1063 assert(isa<NoExpansion>(Exp.get())); 1064 assert(RV.isScalar() && 1065 "Unexpected non-scalar rvalue during struct expansion."); 1066 1067 // Insert a bitcast as needed. 1068 llvm::Value *V = RV.getScalarVal(); 1069 if (IRCallArgPos < IRFuncTy->getNumParams() && 1070 V->getType() != IRFuncTy->getParamType(IRCallArgPos)) 1071 V = Builder.CreateBitCast(V, IRFuncTy->getParamType(IRCallArgPos)); 1072 1073 IRCallArgs[IRCallArgPos++] = V; 1074 } 1075 } 1076 1077 /// Create a temporary allocation for the purposes of coercion. 1078 static Address CreateTempAllocaForCoercion(CodeGenFunction &CGF, llvm::Type *Ty, 1079 CharUnits MinAlign) { 1080 // Don't use an alignment that's worse than what LLVM would prefer. 1081 auto PrefAlign = CGF.CGM.getDataLayout().getPrefTypeAlignment(Ty); 1082 CharUnits Align = std::max(MinAlign, CharUnits::fromQuantity(PrefAlign)); 1083 1084 return CGF.CreateTempAlloca(Ty, Align); 1085 } 1086 1087 /// EnterStructPointerForCoercedAccess - Given a struct pointer that we are 1088 /// accessing some number of bytes out of it, try to gep into the struct to get 1089 /// at its inner goodness. Dive as deep as possible without entering an element 1090 /// with an in-memory size smaller than DstSize. 1091 static Address 1092 EnterStructPointerForCoercedAccess(Address SrcPtr, 1093 llvm::StructType *SrcSTy, 1094 uint64_t DstSize, CodeGenFunction &CGF) { 1095 // We can't dive into a zero-element struct. 1096 if (SrcSTy->getNumElements() == 0) return SrcPtr; 1097 1098 llvm::Type *FirstElt = SrcSTy->getElementType(0); 1099 1100 // If the first elt is at least as large as what we're looking for, or if the 1101 // first element is the same size as the whole struct, we can enter it. The 1102 // comparison must be made on the store size and not the alloca size. Using 1103 // the alloca size may overstate the size of the load. 1104 uint64_t FirstEltSize = 1105 CGF.CGM.getDataLayout().getTypeStoreSize(FirstElt); 1106 if (FirstEltSize < DstSize && 1107 FirstEltSize < CGF.CGM.getDataLayout().getTypeStoreSize(SrcSTy)) 1108 return SrcPtr; 1109 1110 // GEP into the first element. 1111 SrcPtr = CGF.Builder.CreateStructGEP(SrcPtr, 0, CharUnits(), "coerce.dive"); 1112 1113 // If the first element is a struct, recurse. 1114 llvm::Type *SrcTy = SrcPtr.getElementType(); 1115 if (llvm::StructType *SrcSTy = dyn_cast<llvm::StructType>(SrcTy)) 1116 return EnterStructPointerForCoercedAccess(SrcPtr, SrcSTy, DstSize, CGF); 1117 1118 return SrcPtr; 1119 } 1120 1121 /// CoerceIntOrPtrToIntOrPtr - Convert a value Val to the specific Ty where both 1122 /// are either integers or pointers. This does a truncation of the value if it 1123 /// is too large or a zero extension if it is too small. 1124 /// 1125 /// This behaves as if the value were coerced through memory, so on big-endian 1126 /// targets the high bits are preserved in a truncation, while little-endian 1127 /// targets preserve the low bits. 1128 static llvm::Value *CoerceIntOrPtrToIntOrPtr(llvm::Value *Val, 1129 llvm::Type *Ty, 1130 CodeGenFunction &CGF) { 1131 if (Val->getType() == Ty) 1132 return Val; 1133 1134 if (isa<llvm::PointerType>(Val->getType())) { 1135 // If this is Pointer->Pointer avoid conversion to and from int. 1136 if (isa<llvm::PointerType>(Ty)) 1137 return CGF.Builder.CreateBitCast(Val, Ty, "coerce.val"); 1138 1139 // Convert the pointer to an integer so we can play with its width. 1140 Val = CGF.Builder.CreatePtrToInt(Val, CGF.IntPtrTy, "coerce.val.pi"); 1141 } 1142 1143 llvm::Type *DestIntTy = Ty; 1144 if (isa<llvm::PointerType>(DestIntTy)) 1145 DestIntTy = CGF.IntPtrTy; 1146 1147 if (Val->getType() != DestIntTy) { 1148 const llvm::DataLayout &DL = CGF.CGM.getDataLayout(); 1149 if (DL.isBigEndian()) { 1150 // Preserve the high bits on big-endian targets. 1151 // That is what memory coercion does. 1152 uint64_t SrcSize = DL.getTypeSizeInBits(Val->getType()); 1153 uint64_t DstSize = DL.getTypeSizeInBits(DestIntTy); 1154 1155 if (SrcSize > DstSize) { 1156 Val = CGF.Builder.CreateLShr(Val, SrcSize - DstSize, "coerce.highbits"); 1157 Val = CGF.Builder.CreateTrunc(Val, DestIntTy, "coerce.val.ii"); 1158 } else { 1159 Val = CGF.Builder.CreateZExt(Val, DestIntTy, "coerce.val.ii"); 1160 Val = CGF.Builder.CreateShl(Val, DstSize - SrcSize, "coerce.highbits"); 1161 } 1162 } else { 1163 // Little-endian targets preserve the low bits. No shifts required. 1164 Val = CGF.Builder.CreateIntCast(Val, DestIntTy, false, "coerce.val.ii"); 1165 } 1166 } 1167 1168 if (isa<llvm::PointerType>(Ty)) 1169 Val = CGF.Builder.CreateIntToPtr(Val, Ty, "coerce.val.ip"); 1170 return Val; 1171 } 1172 1173 1174 1175 /// CreateCoercedLoad - Create a load from \arg SrcPtr interpreted as 1176 /// a pointer to an object of type \arg Ty, known to be aligned to 1177 /// \arg SrcAlign bytes. 1178 /// 1179 /// This safely handles the case when the src type is smaller than the 1180 /// destination type; in this situation the values of bits which not 1181 /// present in the src are undefined. 1182 static llvm::Value *CreateCoercedLoad(Address Src, llvm::Type *Ty, 1183 CodeGenFunction &CGF) { 1184 llvm::Type *SrcTy = Src.getElementType(); 1185 1186 // If SrcTy and Ty are the same, just do a load. 1187 if (SrcTy == Ty) 1188 return CGF.Builder.CreateLoad(Src); 1189 1190 uint64_t DstSize = CGF.CGM.getDataLayout().getTypeAllocSize(Ty); 1191 1192 if (llvm::StructType *SrcSTy = dyn_cast<llvm::StructType>(SrcTy)) { 1193 Src = EnterStructPointerForCoercedAccess(Src, SrcSTy, DstSize, CGF); 1194 SrcTy = Src.getType()->getElementType(); 1195 } 1196 1197 uint64_t SrcSize = CGF.CGM.getDataLayout().getTypeAllocSize(SrcTy); 1198 1199 // If the source and destination are integer or pointer types, just do an 1200 // extension or truncation to the desired type. 1201 if ((isa<llvm::IntegerType>(Ty) || isa<llvm::PointerType>(Ty)) && 1202 (isa<llvm::IntegerType>(SrcTy) || isa<llvm::PointerType>(SrcTy))) { 1203 llvm::Value *Load = CGF.Builder.CreateLoad(Src); 1204 return CoerceIntOrPtrToIntOrPtr(Load, Ty, CGF); 1205 } 1206 1207 // If load is legal, just bitcast the src pointer. 1208 if (SrcSize >= DstSize) { 1209 // Generally SrcSize is never greater than DstSize, since this means we are 1210 // losing bits. However, this can happen in cases where the structure has 1211 // additional padding, for example due to a user specified alignment. 1212 // 1213 // FIXME: Assert that we aren't truncating non-padding bits when have access 1214 // to that information. 1215 Src = CGF.Builder.CreateBitCast(Src, llvm::PointerType::getUnqual(Ty)); 1216 return CGF.Builder.CreateLoad(Src); 1217 } 1218 1219 // Otherwise do coercion through memory. This is stupid, but simple. 1220 Address Tmp = CreateTempAllocaForCoercion(CGF, Ty, Src.getAlignment()); 1221 Address Casted = CGF.Builder.CreateBitCast(Tmp, CGF.Int8PtrTy); 1222 Address SrcCasted = CGF.Builder.CreateBitCast(Src, CGF.Int8PtrTy); 1223 CGF.Builder.CreateMemCpy(Casted, SrcCasted, 1224 llvm::ConstantInt::get(CGF.IntPtrTy, SrcSize), 1225 false); 1226 return CGF.Builder.CreateLoad(Tmp); 1227 } 1228 1229 // Function to store a first-class aggregate into memory. We prefer to 1230 // store the elements rather than the aggregate to be more friendly to 1231 // fast-isel. 1232 // FIXME: Do we need to recurse here? 1233 static void BuildAggStore(CodeGenFunction &CGF, llvm::Value *Val, 1234 Address Dest, bool DestIsVolatile) { 1235 // Prefer scalar stores to first-class aggregate stores. 1236 if (llvm::StructType *STy = 1237 dyn_cast<llvm::StructType>(Val->getType())) { 1238 const llvm::StructLayout *Layout = 1239 CGF.CGM.getDataLayout().getStructLayout(STy); 1240 1241 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) { 1242 auto EltOffset = CharUnits::fromQuantity(Layout->getElementOffset(i)); 1243 Address EltPtr = CGF.Builder.CreateStructGEP(Dest, i, EltOffset); 1244 llvm::Value *Elt = CGF.Builder.CreateExtractValue(Val, i); 1245 CGF.Builder.CreateStore(Elt, EltPtr, DestIsVolatile); 1246 } 1247 } else { 1248 CGF.Builder.CreateStore(Val, Dest, DestIsVolatile); 1249 } 1250 } 1251 1252 /// CreateCoercedStore - Create a store to \arg DstPtr from \arg Src, 1253 /// where the source and destination may have different types. The 1254 /// destination is known to be aligned to \arg DstAlign bytes. 1255 /// 1256 /// This safely handles the case when the src type is larger than the 1257 /// destination type; the upper bits of the src will be lost. 1258 static void CreateCoercedStore(llvm::Value *Src, 1259 Address Dst, 1260 bool DstIsVolatile, 1261 CodeGenFunction &CGF) { 1262 llvm::Type *SrcTy = Src->getType(); 1263 llvm::Type *DstTy = Dst.getType()->getElementType(); 1264 if (SrcTy == DstTy) { 1265 CGF.Builder.CreateStore(Src, Dst, DstIsVolatile); 1266 return; 1267 } 1268 1269 uint64_t SrcSize = CGF.CGM.getDataLayout().getTypeAllocSize(SrcTy); 1270 1271 if (llvm::StructType *DstSTy = dyn_cast<llvm::StructType>(DstTy)) { 1272 Dst = EnterStructPointerForCoercedAccess(Dst, DstSTy, SrcSize, CGF); 1273 DstTy = Dst.getType()->getElementType(); 1274 } 1275 1276 // If the source and destination are integer or pointer types, just do an 1277 // extension or truncation to the desired type. 1278 if ((isa<llvm::IntegerType>(SrcTy) || isa<llvm::PointerType>(SrcTy)) && 1279 (isa<llvm::IntegerType>(DstTy) || isa<llvm::PointerType>(DstTy))) { 1280 Src = CoerceIntOrPtrToIntOrPtr(Src, DstTy, CGF); 1281 CGF.Builder.CreateStore(Src, Dst, DstIsVolatile); 1282 return; 1283 } 1284 1285 uint64_t DstSize = CGF.CGM.getDataLayout().getTypeAllocSize(DstTy); 1286 1287 // If store is legal, just bitcast the src pointer. 1288 if (SrcSize <= DstSize) { 1289 Dst = CGF.Builder.CreateBitCast(Dst, llvm::PointerType::getUnqual(SrcTy)); 1290 BuildAggStore(CGF, Src, Dst, DstIsVolatile); 1291 } else { 1292 // Otherwise do coercion through memory. This is stupid, but 1293 // simple. 1294 1295 // Generally SrcSize is never greater than DstSize, since this means we are 1296 // losing bits. However, this can happen in cases where the structure has 1297 // additional padding, for example due to a user specified alignment. 1298 // 1299 // FIXME: Assert that we aren't truncating non-padding bits when have access 1300 // to that information. 1301 Address Tmp = CreateTempAllocaForCoercion(CGF, SrcTy, Dst.getAlignment()); 1302 CGF.Builder.CreateStore(Src, Tmp); 1303 Address Casted = CGF.Builder.CreateBitCast(Tmp, CGF.Int8PtrTy); 1304 Address DstCasted = CGF.Builder.CreateBitCast(Dst, CGF.Int8PtrTy); 1305 CGF.Builder.CreateMemCpy(DstCasted, Casted, 1306 llvm::ConstantInt::get(CGF.IntPtrTy, DstSize), 1307 false); 1308 } 1309 } 1310 1311 static Address emitAddressAtOffset(CodeGenFunction &CGF, Address addr, 1312 const ABIArgInfo &info) { 1313 if (unsigned offset = info.getDirectOffset()) { 1314 addr = CGF.Builder.CreateElementBitCast(addr, CGF.Int8Ty); 1315 addr = CGF.Builder.CreateConstInBoundsByteGEP(addr, 1316 CharUnits::fromQuantity(offset)); 1317 addr = CGF.Builder.CreateElementBitCast(addr, info.getCoerceToType()); 1318 } 1319 return addr; 1320 } 1321 1322 namespace { 1323 1324 /// Encapsulates information about the way function arguments from 1325 /// CGFunctionInfo should be passed to actual LLVM IR function. 1326 class ClangToLLVMArgMapping { 1327 static const unsigned InvalidIndex = ~0U; 1328 unsigned InallocaArgNo; 1329 unsigned SRetArgNo; 1330 unsigned TotalIRArgs; 1331 1332 /// Arguments of LLVM IR function corresponding to single Clang argument. 1333 struct IRArgs { 1334 unsigned PaddingArgIndex; 1335 // Argument is expanded to IR arguments at positions 1336 // [FirstArgIndex, FirstArgIndex + NumberOfArgs). 1337 unsigned FirstArgIndex; 1338 unsigned NumberOfArgs; 1339 1340 IRArgs() 1341 : PaddingArgIndex(InvalidIndex), FirstArgIndex(InvalidIndex), 1342 NumberOfArgs(0) {} 1343 }; 1344 1345 SmallVector<IRArgs, 8> ArgInfo; 1346 1347 public: 1348 ClangToLLVMArgMapping(const ASTContext &Context, const CGFunctionInfo &FI, 1349 bool OnlyRequiredArgs = false) 1350 : InallocaArgNo(InvalidIndex), SRetArgNo(InvalidIndex), TotalIRArgs(0), 1351 ArgInfo(OnlyRequiredArgs ? FI.getNumRequiredArgs() : FI.arg_size()) { 1352 construct(Context, FI, OnlyRequiredArgs); 1353 } 1354 1355 bool hasInallocaArg() const { return InallocaArgNo != InvalidIndex; } 1356 unsigned getInallocaArgNo() const { 1357 assert(hasInallocaArg()); 1358 return InallocaArgNo; 1359 } 1360 1361 bool hasSRetArg() const { return SRetArgNo != InvalidIndex; } 1362 unsigned getSRetArgNo() const { 1363 assert(hasSRetArg()); 1364 return SRetArgNo; 1365 } 1366 1367 unsigned totalIRArgs() const { return TotalIRArgs; } 1368 1369 bool hasPaddingArg(unsigned ArgNo) const { 1370 assert(ArgNo < ArgInfo.size()); 1371 return ArgInfo[ArgNo].PaddingArgIndex != InvalidIndex; 1372 } 1373 unsigned getPaddingArgNo(unsigned ArgNo) const { 1374 assert(hasPaddingArg(ArgNo)); 1375 return ArgInfo[ArgNo].PaddingArgIndex; 1376 } 1377 1378 /// Returns index of first IR argument corresponding to ArgNo, and their 1379 /// quantity. 1380 std::pair<unsigned, unsigned> getIRArgs(unsigned ArgNo) const { 1381 assert(ArgNo < ArgInfo.size()); 1382 return std::make_pair(ArgInfo[ArgNo].FirstArgIndex, 1383 ArgInfo[ArgNo].NumberOfArgs); 1384 } 1385 1386 private: 1387 void construct(const ASTContext &Context, const CGFunctionInfo &FI, 1388 bool OnlyRequiredArgs); 1389 }; 1390 1391 void ClangToLLVMArgMapping::construct(const ASTContext &Context, 1392 const CGFunctionInfo &FI, 1393 bool OnlyRequiredArgs) { 1394 unsigned IRArgNo = 0; 1395 bool SwapThisWithSRet = false; 1396 const ABIArgInfo &RetAI = FI.getReturnInfo(); 1397 1398 if (RetAI.getKind() == ABIArgInfo::Indirect) { 1399 SwapThisWithSRet = RetAI.isSRetAfterThis(); 1400 SRetArgNo = SwapThisWithSRet ? 1 : IRArgNo++; 1401 } 1402 1403 unsigned ArgNo = 0; 1404 unsigned NumArgs = OnlyRequiredArgs ? FI.getNumRequiredArgs() : FI.arg_size(); 1405 for (CGFunctionInfo::const_arg_iterator I = FI.arg_begin(); ArgNo < NumArgs; 1406 ++I, ++ArgNo) { 1407 assert(I != FI.arg_end()); 1408 QualType ArgType = I->type; 1409 const ABIArgInfo &AI = I->info; 1410 // Collect data about IR arguments corresponding to Clang argument ArgNo. 1411 auto &IRArgs = ArgInfo[ArgNo]; 1412 1413 if (AI.getPaddingType()) 1414 IRArgs.PaddingArgIndex = IRArgNo++; 1415 1416 switch (AI.getKind()) { 1417 case ABIArgInfo::Extend: 1418 case ABIArgInfo::Direct: { 1419 // FIXME: handle sseregparm someday... 1420 llvm::StructType *STy = dyn_cast<llvm::StructType>(AI.getCoerceToType()); 1421 if (AI.isDirect() && AI.getCanBeFlattened() && STy) { 1422 IRArgs.NumberOfArgs = STy->getNumElements(); 1423 } else { 1424 IRArgs.NumberOfArgs = 1; 1425 } 1426 break; 1427 } 1428 case ABIArgInfo::Indirect: 1429 IRArgs.NumberOfArgs = 1; 1430 break; 1431 case ABIArgInfo::Ignore: 1432 case ABIArgInfo::InAlloca: 1433 // ignore and inalloca doesn't have matching LLVM parameters. 1434 IRArgs.NumberOfArgs = 0; 1435 break; 1436 case ABIArgInfo::CoerceAndExpand: 1437 IRArgs.NumberOfArgs = AI.getCoerceAndExpandTypeSequence().size(); 1438 break; 1439 case ABIArgInfo::Expand: 1440 IRArgs.NumberOfArgs = getExpansionSize(ArgType, Context); 1441 break; 1442 } 1443 1444 if (IRArgs.NumberOfArgs > 0) { 1445 IRArgs.FirstArgIndex = IRArgNo; 1446 IRArgNo += IRArgs.NumberOfArgs; 1447 } 1448 1449 // Skip over the sret parameter when it comes second. We already handled it 1450 // above. 1451 if (IRArgNo == 1 && SwapThisWithSRet) 1452 IRArgNo++; 1453 } 1454 assert(ArgNo == ArgInfo.size()); 1455 1456 if (FI.usesInAlloca()) 1457 InallocaArgNo = IRArgNo++; 1458 1459 TotalIRArgs = IRArgNo; 1460 } 1461 } // namespace 1462 1463 /***/ 1464 1465 bool CodeGenModule::ReturnTypeUsesSRet(const CGFunctionInfo &FI) { 1466 return FI.getReturnInfo().isIndirect(); 1467 } 1468 1469 bool CodeGenModule::ReturnSlotInterferesWithArgs(const CGFunctionInfo &FI) { 1470 return ReturnTypeUsesSRet(FI) && 1471 getTargetCodeGenInfo().doesReturnSlotInterfereWithArgs(); 1472 } 1473 1474 bool CodeGenModule::ReturnTypeUsesFPRet(QualType ResultType) { 1475 if (const BuiltinType *BT = ResultType->getAs<BuiltinType>()) { 1476 switch (BT->getKind()) { 1477 default: 1478 return false; 1479 case BuiltinType::Float: 1480 return getTarget().useObjCFPRetForRealType(TargetInfo::Float); 1481 case BuiltinType::Double: 1482 return getTarget().useObjCFPRetForRealType(TargetInfo::Double); 1483 case BuiltinType::LongDouble: 1484 return getTarget().useObjCFPRetForRealType(TargetInfo::LongDouble); 1485 } 1486 } 1487 1488 return false; 1489 } 1490 1491 bool CodeGenModule::ReturnTypeUsesFP2Ret(QualType ResultType) { 1492 if (const ComplexType *CT = ResultType->getAs<ComplexType>()) { 1493 if (const BuiltinType *BT = CT->getElementType()->getAs<BuiltinType>()) { 1494 if (BT->getKind() == BuiltinType::LongDouble) 1495 return getTarget().useObjCFP2RetForComplexLongDouble(); 1496 } 1497 } 1498 1499 return false; 1500 } 1501 1502 llvm::FunctionType *CodeGenTypes::GetFunctionType(GlobalDecl GD) { 1503 const CGFunctionInfo &FI = arrangeGlobalDeclaration(GD); 1504 return GetFunctionType(FI); 1505 } 1506 1507 llvm::FunctionType * 1508 CodeGenTypes::GetFunctionType(const CGFunctionInfo &FI) { 1509 1510 bool Inserted = FunctionsBeingProcessed.insert(&FI).second; 1511 (void)Inserted; 1512 assert(Inserted && "Recursively being processed?"); 1513 1514 llvm::Type *resultType = nullptr; 1515 const ABIArgInfo &retAI = FI.getReturnInfo(); 1516 switch (retAI.getKind()) { 1517 case ABIArgInfo::Expand: 1518 llvm_unreachable("Invalid ABI kind for return argument"); 1519 1520 case ABIArgInfo::Extend: 1521 case ABIArgInfo::Direct: 1522 resultType = retAI.getCoerceToType(); 1523 break; 1524 1525 case ABIArgInfo::InAlloca: 1526 if (retAI.getInAllocaSRet()) { 1527 // sret things on win32 aren't void, they return the sret pointer. 1528 QualType ret = FI.getReturnType(); 1529 llvm::Type *ty = ConvertType(ret); 1530 unsigned addressSpace = Context.getTargetAddressSpace(ret); 1531 resultType = llvm::PointerType::get(ty, addressSpace); 1532 } else { 1533 resultType = llvm::Type::getVoidTy(getLLVMContext()); 1534 } 1535 break; 1536 1537 case ABIArgInfo::Indirect: 1538 case ABIArgInfo::Ignore: 1539 resultType = llvm::Type::getVoidTy(getLLVMContext()); 1540 break; 1541 1542 case ABIArgInfo::CoerceAndExpand: 1543 resultType = retAI.getUnpaddedCoerceAndExpandType(); 1544 break; 1545 } 1546 1547 ClangToLLVMArgMapping IRFunctionArgs(getContext(), FI, true); 1548 SmallVector<llvm::Type*, 8> ArgTypes(IRFunctionArgs.totalIRArgs()); 1549 1550 // Add type for sret argument. 1551 if (IRFunctionArgs.hasSRetArg()) { 1552 QualType Ret = FI.getReturnType(); 1553 llvm::Type *Ty = ConvertType(Ret); 1554 unsigned AddressSpace = Context.getTargetAddressSpace(Ret); 1555 ArgTypes[IRFunctionArgs.getSRetArgNo()] = 1556 llvm::PointerType::get(Ty, AddressSpace); 1557 } 1558 1559 // Add type for inalloca argument. 1560 if (IRFunctionArgs.hasInallocaArg()) { 1561 auto ArgStruct = FI.getArgStruct(); 1562 assert(ArgStruct); 1563 ArgTypes[IRFunctionArgs.getInallocaArgNo()] = ArgStruct->getPointerTo(); 1564 } 1565 1566 // Add in all of the required arguments. 1567 unsigned ArgNo = 0; 1568 CGFunctionInfo::const_arg_iterator it = FI.arg_begin(), 1569 ie = it + FI.getNumRequiredArgs(); 1570 for (; it != ie; ++it, ++ArgNo) { 1571 const ABIArgInfo &ArgInfo = it->info; 1572 1573 // Insert a padding type to ensure proper alignment. 1574 if (IRFunctionArgs.hasPaddingArg(ArgNo)) 1575 ArgTypes[IRFunctionArgs.getPaddingArgNo(ArgNo)] = 1576 ArgInfo.getPaddingType(); 1577 1578 unsigned FirstIRArg, NumIRArgs; 1579 std::tie(FirstIRArg, NumIRArgs) = IRFunctionArgs.getIRArgs(ArgNo); 1580 1581 switch (ArgInfo.getKind()) { 1582 case ABIArgInfo::Ignore: 1583 case ABIArgInfo::InAlloca: 1584 assert(NumIRArgs == 0); 1585 break; 1586 1587 case ABIArgInfo::Indirect: { 1588 assert(NumIRArgs == 1); 1589 // indirect arguments are always on the stack, which is addr space #0. 1590 llvm::Type *LTy = ConvertTypeForMem(it->type); 1591 ArgTypes[FirstIRArg] = LTy->getPointerTo(); 1592 break; 1593 } 1594 1595 case ABIArgInfo::Extend: 1596 case ABIArgInfo::Direct: { 1597 // Fast-isel and the optimizer generally like scalar values better than 1598 // FCAs, so we flatten them if this is safe to do for this argument. 1599 llvm::Type *argType = ArgInfo.getCoerceToType(); 1600 llvm::StructType *st = dyn_cast<llvm::StructType>(argType); 1601 if (st && ArgInfo.isDirect() && ArgInfo.getCanBeFlattened()) { 1602 assert(NumIRArgs == st->getNumElements()); 1603 for (unsigned i = 0, e = st->getNumElements(); i != e; ++i) 1604 ArgTypes[FirstIRArg + i] = st->getElementType(i); 1605 } else { 1606 assert(NumIRArgs == 1); 1607 ArgTypes[FirstIRArg] = argType; 1608 } 1609 break; 1610 } 1611 1612 case ABIArgInfo::CoerceAndExpand: { 1613 auto ArgTypesIter = ArgTypes.begin() + FirstIRArg; 1614 for (auto EltTy : ArgInfo.getCoerceAndExpandTypeSequence()) { 1615 *ArgTypesIter++ = EltTy; 1616 } 1617 assert(ArgTypesIter == ArgTypes.begin() + FirstIRArg + NumIRArgs); 1618 break; 1619 } 1620 1621 case ABIArgInfo::Expand: 1622 auto ArgTypesIter = ArgTypes.begin() + FirstIRArg; 1623 getExpandedTypes(it->type, ArgTypesIter); 1624 assert(ArgTypesIter == ArgTypes.begin() + FirstIRArg + NumIRArgs); 1625 break; 1626 } 1627 } 1628 1629 bool Erased = FunctionsBeingProcessed.erase(&FI); (void)Erased; 1630 assert(Erased && "Not in set?"); 1631 1632 return llvm::FunctionType::get(resultType, ArgTypes, FI.isVariadic()); 1633 } 1634 1635 llvm::Type *CodeGenTypes::GetFunctionTypeForVTable(GlobalDecl GD) { 1636 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl()); 1637 const FunctionProtoType *FPT = MD->getType()->getAs<FunctionProtoType>(); 1638 1639 if (!isFuncTypeConvertible(FPT)) 1640 return llvm::StructType::get(getLLVMContext()); 1641 1642 const CGFunctionInfo *Info; 1643 if (isa<CXXDestructorDecl>(MD)) 1644 Info = 1645 &arrangeCXXStructorDeclaration(MD, getFromDtorType(GD.getDtorType())); 1646 else 1647 Info = &arrangeCXXMethodDeclaration(MD); 1648 return GetFunctionType(*Info); 1649 } 1650 1651 static void AddAttributesFromFunctionProtoType(ASTContext &Ctx, 1652 llvm::AttrBuilder &FuncAttrs, 1653 const FunctionProtoType *FPT) { 1654 if (!FPT) 1655 return; 1656 1657 if (!isUnresolvedExceptionSpec(FPT->getExceptionSpecType()) && 1658 FPT->isNothrow(Ctx)) 1659 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind); 1660 } 1661 1662 void CodeGenModule::ConstructDefaultFnAttrList(StringRef Name, bool HasOptnone, 1663 bool AttrOnCallSite, 1664 llvm::AttrBuilder &FuncAttrs) { 1665 // OptimizeNoneAttr takes precedence over -Os or -Oz. No warning needed. 1666 if (!HasOptnone) { 1667 if (CodeGenOpts.OptimizeSize) 1668 FuncAttrs.addAttribute(llvm::Attribute::OptimizeForSize); 1669 if (CodeGenOpts.OptimizeSize == 2) 1670 FuncAttrs.addAttribute(llvm::Attribute::MinSize); 1671 } 1672 1673 if (CodeGenOpts.DisableRedZone) 1674 FuncAttrs.addAttribute(llvm::Attribute::NoRedZone); 1675 if (CodeGenOpts.NoImplicitFloat) 1676 FuncAttrs.addAttribute(llvm::Attribute::NoImplicitFloat); 1677 1678 if (AttrOnCallSite) { 1679 // Attributes that should go on the call site only. 1680 if (!CodeGenOpts.SimplifyLibCalls || 1681 CodeGenOpts.isNoBuiltinFunc(Name.data())) 1682 FuncAttrs.addAttribute(llvm::Attribute::NoBuiltin); 1683 if (!CodeGenOpts.TrapFuncName.empty()) 1684 FuncAttrs.addAttribute("trap-func-name", CodeGenOpts.TrapFuncName); 1685 } else { 1686 // Attributes that should go on the function, but not the call site. 1687 if (!CodeGenOpts.DisableFPElim) { 1688 FuncAttrs.addAttribute("no-frame-pointer-elim", "false"); 1689 } else if (CodeGenOpts.OmitLeafFramePointer) { 1690 FuncAttrs.addAttribute("no-frame-pointer-elim", "false"); 1691 FuncAttrs.addAttribute("no-frame-pointer-elim-non-leaf"); 1692 } else { 1693 FuncAttrs.addAttribute("no-frame-pointer-elim", "true"); 1694 FuncAttrs.addAttribute("no-frame-pointer-elim-non-leaf"); 1695 } 1696 1697 FuncAttrs.addAttribute("less-precise-fpmad", 1698 llvm::toStringRef(CodeGenOpts.LessPreciseFPMAD)); 1699 1700 if (!CodeGenOpts.FPDenormalMode.empty()) 1701 FuncAttrs.addAttribute("denormal-fp-math", CodeGenOpts.FPDenormalMode); 1702 1703 FuncAttrs.addAttribute("no-trapping-math", 1704 llvm::toStringRef(CodeGenOpts.NoTrappingMath)); 1705 1706 // TODO: Are these all needed? 1707 // unsafe/inf/nan/nsz are handled by instruction-level FastMathFlags. 1708 FuncAttrs.addAttribute("no-infs-fp-math", 1709 llvm::toStringRef(CodeGenOpts.NoInfsFPMath)); 1710 FuncAttrs.addAttribute("no-nans-fp-math", 1711 llvm::toStringRef(CodeGenOpts.NoNaNsFPMath)); 1712 FuncAttrs.addAttribute("unsafe-fp-math", 1713 llvm::toStringRef(CodeGenOpts.UnsafeFPMath)); 1714 FuncAttrs.addAttribute("use-soft-float", 1715 llvm::toStringRef(CodeGenOpts.SoftFloat)); 1716 FuncAttrs.addAttribute("stack-protector-buffer-size", 1717 llvm::utostr(CodeGenOpts.SSPBufferSize)); 1718 FuncAttrs.addAttribute("no-signed-zeros-fp-math", 1719 llvm::toStringRef(CodeGenOpts.NoSignedZeros)); 1720 FuncAttrs.addAttribute( 1721 "correctly-rounded-divide-sqrt-fp-math", 1722 llvm::toStringRef(CodeGenOpts.CorrectlyRoundedDivSqrt)); 1723 1724 // TODO: Reciprocal estimate codegen options should apply to instructions? 1725 std::vector<std::string> &Recips = getTarget().getTargetOpts().Reciprocals; 1726 if (!Recips.empty()) 1727 FuncAttrs.addAttribute("reciprocal-estimates", 1728 llvm::join(Recips.begin(), Recips.end(), ",")); 1729 1730 if (CodeGenOpts.StackRealignment) 1731 FuncAttrs.addAttribute("stackrealign"); 1732 if (CodeGenOpts.Backchain) 1733 FuncAttrs.addAttribute("backchain"); 1734 } 1735 1736 if (getLangOpts().CUDA && getLangOpts().CUDAIsDevice) { 1737 // Conservatively, mark all functions and calls in CUDA as convergent 1738 // (meaning, they may call an intrinsically convergent op, such as 1739 // __syncthreads(), and so can't have certain optimizations applied around 1740 // them). LLVM will remove this attribute where it safely can. 1741 FuncAttrs.addAttribute(llvm::Attribute::Convergent); 1742 1743 // Exceptions aren't supported in CUDA device code. 1744 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind); 1745 1746 // Respect -fcuda-flush-denormals-to-zero. 1747 if (getLangOpts().CUDADeviceFlushDenormalsToZero) 1748 FuncAttrs.addAttribute("nvptx-f32ftz", "true"); 1749 } 1750 } 1751 1752 void CodeGenModule::AddDefaultFnAttrs(llvm::Function &F) { 1753 llvm::AttrBuilder FuncAttrs; 1754 ConstructDefaultFnAttrList(F.getName(), 1755 F.hasFnAttribute(llvm::Attribute::OptimizeNone), 1756 /* AttrOnCallsite = */ false, FuncAttrs); 1757 llvm::AttributeList AS = llvm::AttributeList::get( 1758 getLLVMContext(), llvm::AttributeList::FunctionIndex, FuncAttrs); 1759 F.addAttributes(llvm::AttributeList::FunctionIndex, AS); 1760 } 1761 1762 /// Returns the attribute (either parameter attribute, or function 1763 /// attribute), which declares argument ArgNo to be non-null. 1764 static const NonNullAttr *getNonNullAttr(const Decl *FD, const ParmVarDecl *PVD, 1765 QualType ArgType, unsigned ArgNo) { 1766 // FIXME: __attribute__((nonnull)) can also be applied to: 1767 // - references to pointers, where the pointee is known to be 1768 // nonnull (apparently a Clang extension) 1769 // - transparent unions containing pointers 1770 // In the former case, LLVM IR cannot represent the constraint. In 1771 // the latter case, we have no guarantee that the transparent union 1772 // is in fact passed as a pointer. 1773 if (!ArgType->isAnyPointerType() && !ArgType->isBlockPointerType()) 1774 return nullptr; 1775 // First, check attribute on parameter itself. 1776 if (PVD) { 1777 if (auto ParmNNAttr = PVD->getAttr<NonNullAttr>()) 1778 return ParmNNAttr; 1779 } 1780 // Check function attributes. 1781 if (!FD) 1782 return nullptr; 1783 for (const auto *NNAttr : FD->specific_attrs<NonNullAttr>()) { 1784 if (NNAttr->isNonNull(ArgNo)) 1785 return NNAttr; 1786 } 1787 return nullptr; 1788 } 1789 1790 void CodeGenModule::ConstructAttributeList( 1791 StringRef Name, const CGFunctionInfo &FI, CGCalleeInfo CalleeInfo, 1792 AttributeListType &PAL, unsigned &CallingConv, bool AttrOnCallSite) { 1793 llvm::AttrBuilder FuncAttrs; 1794 llvm::AttrBuilder RetAttrs; 1795 1796 CallingConv = FI.getEffectiveCallingConvention(); 1797 if (FI.isNoReturn()) 1798 FuncAttrs.addAttribute(llvm::Attribute::NoReturn); 1799 1800 // If we have information about the function prototype, we can learn 1801 // attributes form there. 1802 AddAttributesFromFunctionProtoType(getContext(), FuncAttrs, 1803 CalleeInfo.getCalleeFunctionProtoType()); 1804 1805 const Decl *TargetDecl = CalleeInfo.getCalleeDecl(); 1806 const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(TargetDecl); 1807 1808 // Check if this is a builtin function that might override some attributes. 1809 unsigned BuiltinID = FD ? FD->getBuiltinID() : 0; 1810 bool OverrideNonnullReturn = false; 1811 unsigned OverrideNonnullArgs = 0; 1812 if (BuiltinID) { 1813 ASTContext::GetBuiltinTypeError Error; 1814 getContext().GetBuiltinType(BuiltinID, Error, nullptr, 1815 &OverrideNonnullReturn, &OverrideNonnullArgs); 1816 // Note that we can't check the 'Error' here as there may be errors that 1817 // have been diagnosed and reported to the programmer as warnings but 1818 // repaired in the AST such as for implicit declarations of builtin 1819 // functions. None of those impact our usage of this to analyze attributes 1820 // for the builtins. 1821 } 1822 1823 bool HasOptnone = false; 1824 // FIXME: handle sseregparm someday... 1825 if (TargetDecl) { 1826 if (TargetDecl->hasAttr<ReturnsTwiceAttr>()) 1827 FuncAttrs.addAttribute(llvm::Attribute::ReturnsTwice); 1828 if (TargetDecl->hasAttr<NoThrowAttr>()) 1829 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind); 1830 if (TargetDecl->hasAttr<NoReturnAttr>()) 1831 FuncAttrs.addAttribute(llvm::Attribute::NoReturn); 1832 if (TargetDecl->hasAttr<NoDuplicateAttr>()) 1833 FuncAttrs.addAttribute(llvm::Attribute::NoDuplicate); 1834 if (TargetDecl->hasAttr<ConvergentAttr>()) 1835 FuncAttrs.addAttribute(llvm::Attribute::Convergent); 1836 1837 if (FD) { 1838 AddAttributesFromFunctionProtoType( 1839 getContext(), FuncAttrs, FD->getType()->getAs<FunctionProtoType>()); 1840 // Don't use [[noreturn]] or _Noreturn for a call to a virtual function. 1841 // These attributes are not inherited by overloads. 1842 const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(FD); 1843 if (FD->isNoReturn() && !(AttrOnCallSite && MD && MD->isVirtual())) 1844 FuncAttrs.addAttribute(llvm::Attribute::NoReturn); 1845 } 1846 1847 // 'const', 'pure' and 'noalias' attributed functions are also nounwind. 1848 if (TargetDecl->hasAttr<ConstAttr>()) { 1849 FuncAttrs.addAttribute(llvm::Attribute::ReadNone); 1850 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind); 1851 } else if (TargetDecl->hasAttr<PureAttr>()) { 1852 FuncAttrs.addAttribute(llvm::Attribute::ReadOnly); 1853 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind); 1854 } else if (TargetDecl->hasAttr<NoAliasAttr>()) { 1855 FuncAttrs.addAttribute(llvm::Attribute::ArgMemOnly); 1856 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind); 1857 } 1858 if (TargetDecl->hasAttr<RestrictAttr>()) 1859 RetAttrs.addAttribute(llvm::Attribute::NoAlias); 1860 if (TargetDecl->hasAttr<ReturnsNonNullAttr>() && !OverrideNonnullReturn) 1861 RetAttrs.addAttribute(llvm::Attribute::NonNull); 1862 1863 HasOptnone = TargetDecl->hasAttr<OptimizeNoneAttr>(); 1864 if (auto *AllocSize = TargetDecl->getAttr<AllocSizeAttr>()) { 1865 Optional<unsigned> NumElemsParam; 1866 // alloc_size args are base-1, 0 means not present. 1867 if (unsigned N = AllocSize->getNumElemsParam()) 1868 NumElemsParam = N - 1; 1869 FuncAttrs.addAllocSizeAttr(AllocSize->getElemSizeParam() - 1, 1870 NumElemsParam); 1871 } 1872 } 1873 1874 ConstructDefaultFnAttrList(Name, HasOptnone, AttrOnCallSite, FuncAttrs); 1875 1876 if (CodeGenOpts.EnableSegmentedStacks && 1877 !(TargetDecl && TargetDecl->hasAttr<NoSplitStackAttr>())) 1878 FuncAttrs.addAttribute("split-stack"); 1879 1880 if (!AttrOnCallSite) { 1881 bool DisableTailCalls = 1882 CodeGenOpts.DisableTailCalls || 1883 (TargetDecl && (TargetDecl->hasAttr<DisableTailCallsAttr>() || 1884 TargetDecl->hasAttr<AnyX86InterruptAttr>())); 1885 FuncAttrs.addAttribute("disable-tail-calls", 1886 llvm::toStringRef(DisableTailCalls)); 1887 1888 // Add target-cpu and target-features attributes to functions. If 1889 // we have a decl for the function and it has a target attribute then 1890 // parse that and add it to the feature set. 1891 StringRef TargetCPU = getTarget().getTargetOpts().CPU; 1892 if (FD && FD->hasAttr<TargetAttr>()) { 1893 llvm::StringMap<bool> FeatureMap; 1894 getFunctionFeatureMap(FeatureMap, FD); 1895 1896 // Produce the canonical string for this set of features. 1897 std::vector<std::string> Features; 1898 for (llvm::StringMap<bool>::const_iterator it = FeatureMap.begin(), 1899 ie = FeatureMap.end(); 1900 it != ie; ++it) 1901 Features.push_back((it->second ? "+" : "-") + it->first().str()); 1902 1903 // Now add the target-cpu and target-features to the function. 1904 // While we populated the feature map above, we still need to 1905 // get and parse the target attribute so we can get the cpu for 1906 // the function. 1907 const auto *TD = FD->getAttr<TargetAttr>(); 1908 TargetAttr::ParsedTargetAttr ParsedAttr = TD->parse(); 1909 if (ParsedAttr.second != "") 1910 TargetCPU = ParsedAttr.second; 1911 if (TargetCPU != "") 1912 FuncAttrs.addAttribute("target-cpu", TargetCPU); 1913 if (!Features.empty()) { 1914 std::sort(Features.begin(), Features.end()); 1915 FuncAttrs.addAttribute( 1916 "target-features", 1917 llvm::join(Features.begin(), Features.end(), ",")); 1918 } 1919 } else { 1920 // Otherwise just add the existing target cpu and target features to the 1921 // function. 1922 std::vector<std::string> &Features = getTarget().getTargetOpts().Features; 1923 if (TargetCPU != "") 1924 FuncAttrs.addAttribute("target-cpu", TargetCPU); 1925 if (!Features.empty()) { 1926 std::sort(Features.begin(), Features.end()); 1927 FuncAttrs.addAttribute( 1928 "target-features", 1929 llvm::join(Features.begin(), Features.end(), ",")); 1930 } 1931 } 1932 } 1933 1934 ClangToLLVMArgMapping IRFunctionArgs(getContext(), FI); 1935 1936 QualType RetTy = FI.getReturnType(); 1937 const ABIArgInfo &RetAI = FI.getReturnInfo(); 1938 switch (RetAI.getKind()) { 1939 case ABIArgInfo::Extend: 1940 if (RetTy->hasSignedIntegerRepresentation()) 1941 RetAttrs.addAttribute(llvm::Attribute::SExt); 1942 else if (RetTy->hasUnsignedIntegerRepresentation()) 1943 RetAttrs.addAttribute(llvm::Attribute::ZExt); 1944 // FALL THROUGH 1945 case ABIArgInfo::Direct: 1946 if (RetAI.getInReg()) 1947 RetAttrs.addAttribute(llvm::Attribute::InReg); 1948 break; 1949 case ABIArgInfo::Ignore: 1950 break; 1951 1952 case ABIArgInfo::InAlloca: 1953 case ABIArgInfo::Indirect: { 1954 // inalloca and sret disable readnone and readonly 1955 FuncAttrs.removeAttribute(llvm::Attribute::ReadOnly) 1956 .removeAttribute(llvm::Attribute::ReadNone); 1957 break; 1958 } 1959 1960 case ABIArgInfo::CoerceAndExpand: 1961 break; 1962 1963 case ABIArgInfo::Expand: 1964 llvm_unreachable("Invalid ABI kind for return argument"); 1965 } 1966 1967 if (const auto *RefTy = RetTy->getAs<ReferenceType>()) { 1968 QualType PTy = RefTy->getPointeeType(); 1969 if (!PTy->isIncompleteType() && PTy->isConstantSizeType()) 1970 RetAttrs.addDereferenceableAttr(getContext().getTypeSizeInChars(PTy) 1971 .getQuantity()); 1972 else if (getContext().getTargetAddressSpace(PTy) == 0) 1973 RetAttrs.addAttribute(llvm::Attribute::NonNull); 1974 } 1975 1976 // Attach return attributes. 1977 if (RetAttrs.hasAttributes()) { 1978 PAL.push_back(llvm::AttributeList::get( 1979 getLLVMContext(), llvm::AttributeList::ReturnIndex, RetAttrs)); 1980 } 1981 1982 bool hasUsedSRet = false; 1983 1984 // Attach attributes to sret. 1985 if (IRFunctionArgs.hasSRetArg()) { 1986 llvm::AttrBuilder SRETAttrs; 1987 SRETAttrs.addAttribute(llvm::Attribute::StructRet); 1988 hasUsedSRet = true; 1989 if (RetAI.getInReg()) 1990 SRETAttrs.addAttribute(llvm::Attribute::InReg); 1991 PAL.push_back(llvm::AttributeList::get( 1992 getLLVMContext(), IRFunctionArgs.getSRetArgNo() + 1, SRETAttrs)); 1993 } 1994 1995 // Attach attributes to inalloca argument. 1996 if (IRFunctionArgs.hasInallocaArg()) { 1997 llvm::AttrBuilder Attrs; 1998 Attrs.addAttribute(llvm::Attribute::InAlloca); 1999 PAL.push_back(llvm::AttributeList::get( 2000 getLLVMContext(), IRFunctionArgs.getInallocaArgNo() + 1, Attrs)); 2001 } 2002 2003 unsigned ArgNo = 0; 2004 for (CGFunctionInfo::const_arg_iterator I = FI.arg_begin(), 2005 E = FI.arg_end(); 2006 I != E; ++I, ++ArgNo) { 2007 QualType ParamType = I->type; 2008 const ABIArgInfo &AI = I->info; 2009 llvm::AttrBuilder Attrs; 2010 2011 // Add attribute for padding argument, if necessary. 2012 if (IRFunctionArgs.hasPaddingArg(ArgNo)) { 2013 if (AI.getPaddingInReg()) 2014 PAL.push_back(llvm::AttributeList::get( 2015 getLLVMContext(), IRFunctionArgs.getPaddingArgNo(ArgNo) + 1, 2016 llvm::Attribute::InReg)); 2017 } 2018 2019 // 'restrict' -> 'noalias' is done in EmitFunctionProlog when we 2020 // have the corresponding parameter variable. It doesn't make 2021 // sense to do it here because parameters are so messed up. 2022 switch (AI.getKind()) { 2023 case ABIArgInfo::Extend: 2024 if (ParamType->isSignedIntegerOrEnumerationType()) 2025 Attrs.addAttribute(llvm::Attribute::SExt); 2026 else if (ParamType->isUnsignedIntegerOrEnumerationType()) { 2027 if (getTypes().getABIInfo().shouldSignExtUnsignedType(ParamType)) 2028 Attrs.addAttribute(llvm::Attribute::SExt); 2029 else 2030 Attrs.addAttribute(llvm::Attribute::ZExt); 2031 } 2032 // FALL THROUGH 2033 case ABIArgInfo::Direct: 2034 if (ArgNo == 0 && FI.isChainCall()) 2035 Attrs.addAttribute(llvm::Attribute::Nest); 2036 else if (AI.getInReg()) 2037 Attrs.addAttribute(llvm::Attribute::InReg); 2038 break; 2039 2040 case ABIArgInfo::Indirect: { 2041 if (AI.getInReg()) 2042 Attrs.addAttribute(llvm::Attribute::InReg); 2043 2044 if (AI.getIndirectByVal()) 2045 Attrs.addAttribute(llvm::Attribute::ByVal); 2046 2047 CharUnits Align = AI.getIndirectAlign(); 2048 2049 // In a byval argument, it is important that the required 2050 // alignment of the type is honored, as LLVM might be creating a 2051 // *new* stack object, and needs to know what alignment to give 2052 // it. (Sometimes it can deduce a sensible alignment on its own, 2053 // but not if clang decides it must emit a packed struct, or the 2054 // user specifies increased alignment requirements.) 2055 // 2056 // This is different from indirect *not* byval, where the object 2057 // exists already, and the align attribute is purely 2058 // informative. 2059 assert(!Align.isZero()); 2060 2061 // For now, only add this when we have a byval argument. 2062 // TODO: be less lazy about updating test cases. 2063 if (AI.getIndirectByVal()) 2064 Attrs.addAlignmentAttr(Align.getQuantity()); 2065 2066 // byval disables readnone and readonly. 2067 FuncAttrs.removeAttribute(llvm::Attribute::ReadOnly) 2068 .removeAttribute(llvm::Attribute::ReadNone); 2069 break; 2070 } 2071 case ABIArgInfo::Ignore: 2072 case ABIArgInfo::Expand: 2073 case ABIArgInfo::CoerceAndExpand: 2074 break; 2075 2076 case ABIArgInfo::InAlloca: 2077 // inalloca disables readnone and readonly. 2078 FuncAttrs.removeAttribute(llvm::Attribute::ReadOnly) 2079 .removeAttribute(llvm::Attribute::ReadNone); 2080 continue; 2081 } 2082 2083 if (FD && ArgNo < FD->param_size() && ParamType->isPointerType()) { 2084 auto *PVD = FD->getParamDecl(ArgNo); 2085 if (getNonNullAttr(FD, PVD, ParamType, PVD->getFunctionScopeIndex()) && 2086 (!BuiltinID || (OverrideNonnullArgs & (1 << ArgNo)) == 0)) 2087 Attrs.addAttribute(llvm::Attribute::NonNull); 2088 } 2089 2090 if (const auto *RefTy = ParamType->getAs<ReferenceType>()) { 2091 QualType PTy = RefTy->getPointeeType(); 2092 if (!PTy->isIncompleteType() && PTy->isConstantSizeType()) 2093 Attrs.addDereferenceableAttr(getContext().getTypeSizeInChars(PTy) 2094 .getQuantity()); 2095 else if (getContext().getTargetAddressSpace(PTy) == 0) 2096 Attrs.addAttribute(llvm::Attribute::NonNull); 2097 } 2098 2099 switch (FI.getExtParameterInfo(ArgNo).getABI()) { 2100 case ParameterABI::Ordinary: 2101 break; 2102 2103 case ParameterABI::SwiftIndirectResult: { 2104 // Add 'sret' if we haven't already used it for something, but 2105 // only if the result is void. 2106 if (!hasUsedSRet && RetTy->isVoidType()) { 2107 Attrs.addAttribute(llvm::Attribute::StructRet); 2108 hasUsedSRet = true; 2109 } 2110 2111 // Add 'noalias' in either case. 2112 Attrs.addAttribute(llvm::Attribute::NoAlias); 2113 2114 // Add 'dereferenceable' and 'alignment'. 2115 auto PTy = ParamType->getPointeeType(); 2116 if (!PTy->isIncompleteType() && PTy->isConstantSizeType()) { 2117 auto info = getContext().getTypeInfoInChars(PTy); 2118 Attrs.addDereferenceableAttr(info.first.getQuantity()); 2119 Attrs.addAttribute(llvm::Attribute::getWithAlignment(getLLVMContext(), 2120 info.second.getQuantity())); 2121 } 2122 break; 2123 } 2124 2125 case ParameterABI::SwiftErrorResult: 2126 Attrs.addAttribute(llvm::Attribute::SwiftError); 2127 break; 2128 2129 case ParameterABI::SwiftContext: 2130 Attrs.addAttribute(llvm::Attribute::SwiftSelf); 2131 break; 2132 } 2133 2134 if (Attrs.hasAttributes()) { 2135 unsigned FirstIRArg, NumIRArgs; 2136 std::tie(FirstIRArg, NumIRArgs) = IRFunctionArgs.getIRArgs(ArgNo); 2137 for (unsigned i = 0; i < NumIRArgs; i++) 2138 PAL.push_back(llvm::AttributeList::get(getLLVMContext(), 2139 FirstIRArg + i + 1, Attrs)); 2140 } 2141 } 2142 assert(ArgNo == FI.arg_size()); 2143 2144 if (FuncAttrs.hasAttributes()) 2145 PAL.push_back(llvm::AttributeList::get( 2146 getLLVMContext(), llvm::AttributeList::FunctionIndex, FuncAttrs)); 2147 } 2148 2149 /// An argument came in as a promoted argument; demote it back to its 2150 /// declared type. 2151 static llvm::Value *emitArgumentDemotion(CodeGenFunction &CGF, 2152 const VarDecl *var, 2153 llvm::Value *value) { 2154 llvm::Type *varType = CGF.ConvertType(var->getType()); 2155 2156 // This can happen with promotions that actually don't change the 2157 // underlying type, like the enum promotions. 2158 if (value->getType() == varType) return value; 2159 2160 assert((varType->isIntegerTy() || varType->isFloatingPointTy()) 2161 && "unexpected promotion type"); 2162 2163 if (isa<llvm::IntegerType>(varType)) 2164 return CGF.Builder.CreateTrunc(value, varType, "arg.unpromote"); 2165 2166 return CGF.Builder.CreateFPCast(value, varType, "arg.unpromote"); 2167 } 2168 2169 namespace { 2170 struct CopyBackSwiftError final : EHScopeStack::Cleanup { 2171 Address Temp; 2172 Address Arg; 2173 CopyBackSwiftError(Address temp, Address arg) : Temp(temp), Arg(arg) {} 2174 void Emit(CodeGenFunction &CGF, Flags flags) override { 2175 llvm::Value *errorValue = CGF.Builder.CreateLoad(Temp); 2176 CGF.Builder.CreateStore(errorValue, Arg); 2177 } 2178 }; 2179 } 2180 2181 void CodeGenFunction::EmitFunctionProlog(const CGFunctionInfo &FI, 2182 llvm::Function *Fn, 2183 const FunctionArgList &Args) { 2184 if (CurCodeDecl && CurCodeDecl->hasAttr<NakedAttr>()) 2185 // Naked functions don't have prologues. 2186 return; 2187 2188 // If this is an implicit-return-zero function, go ahead and 2189 // initialize the return value. TODO: it might be nice to have 2190 // a more general mechanism for this that didn't require synthesized 2191 // return statements. 2192 if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(CurCodeDecl)) { 2193 if (FD->hasImplicitReturnZero()) { 2194 QualType RetTy = FD->getReturnType().getUnqualifiedType(); 2195 llvm::Type* LLVMTy = CGM.getTypes().ConvertType(RetTy); 2196 llvm::Constant* Zero = llvm::Constant::getNullValue(LLVMTy); 2197 Builder.CreateStore(Zero, ReturnValue); 2198 } 2199 } 2200 2201 // FIXME: We no longer need the types from FunctionArgList; lift up and 2202 // simplify. 2203 2204 ClangToLLVMArgMapping IRFunctionArgs(CGM.getContext(), FI); 2205 // Flattened function arguments. 2206 SmallVector<llvm::Value *, 16> FnArgs; 2207 FnArgs.reserve(IRFunctionArgs.totalIRArgs()); 2208 for (auto &Arg : Fn->args()) { 2209 FnArgs.push_back(&Arg); 2210 } 2211 assert(FnArgs.size() == IRFunctionArgs.totalIRArgs()); 2212 2213 // If we're using inalloca, all the memory arguments are GEPs off of the last 2214 // parameter, which is a pointer to the complete memory area. 2215 Address ArgStruct = Address::invalid(); 2216 const llvm::StructLayout *ArgStructLayout = nullptr; 2217 if (IRFunctionArgs.hasInallocaArg()) { 2218 ArgStructLayout = CGM.getDataLayout().getStructLayout(FI.getArgStruct()); 2219 ArgStruct = Address(FnArgs[IRFunctionArgs.getInallocaArgNo()], 2220 FI.getArgStructAlignment()); 2221 2222 assert(ArgStruct.getType() == FI.getArgStruct()->getPointerTo()); 2223 } 2224 2225 // Name the struct return parameter. 2226 if (IRFunctionArgs.hasSRetArg()) { 2227 auto AI = cast<llvm::Argument>(FnArgs[IRFunctionArgs.getSRetArgNo()]); 2228 AI->setName("agg.result"); 2229 AI->addAttr(llvm::AttributeList::get(getLLVMContext(), AI->getArgNo() + 1, 2230 llvm::Attribute::NoAlias)); 2231 } 2232 2233 // Track if we received the parameter as a pointer (indirect, byval, or 2234 // inalloca). If already have a pointer, EmitParmDecl doesn't need to copy it 2235 // into a local alloca for us. 2236 SmallVector<ParamValue, 16> ArgVals; 2237 ArgVals.reserve(Args.size()); 2238 2239 // Create a pointer value for every parameter declaration. This usually 2240 // entails copying one or more LLVM IR arguments into an alloca. Don't push 2241 // any cleanups or do anything that might unwind. We do that separately, so 2242 // we can push the cleanups in the correct order for the ABI. 2243 assert(FI.arg_size() == Args.size() && 2244 "Mismatch between function signature & arguments."); 2245 unsigned ArgNo = 0; 2246 CGFunctionInfo::const_arg_iterator info_it = FI.arg_begin(); 2247 for (FunctionArgList::const_iterator i = Args.begin(), e = Args.end(); 2248 i != e; ++i, ++info_it, ++ArgNo) { 2249 const VarDecl *Arg = *i; 2250 QualType Ty = info_it->type; 2251 const ABIArgInfo &ArgI = info_it->info; 2252 2253 bool isPromoted = 2254 isa<ParmVarDecl>(Arg) && cast<ParmVarDecl>(Arg)->isKNRPromoted(); 2255 2256 unsigned FirstIRArg, NumIRArgs; 2257 std::tie(FirstIRArg, NumIRArgs) = IRFunctionArgs.getIRArgs(ArgNo); 2258 2259 switch (ArgI.getKind()) { 2260 case ABIArgInfo::InAlloca: { 2261 assert(NumIRArgs == 0); 2262 auto FieldIndex = ArgI.getInAllocaFieldIndex(); 2263 CharUnits FieldOffset = 2264 CharUnits::fromQuantity(ArgStructLayout->getElementOffset(FieldIndex)); 2265 Address V = Builder.CreateStructGEP(ArgStruct, FieldIndex, FieldOffset, 2266 Arg->getName()); 2267 ArgVals.push_back(ParamValue::forIndirect(V)); 2268 break; 2269 } 2270 2271 case ABIArgInfo::Indirect: { 2272 assert(NumIRArgs == 1); 2273 Address ParamAddr = Address(FnArgs[FirstIRArg], ArgI.getIndirectAlign()); 2274 2275 if (!hasScalarEvaluationKind(Ty)) { 2276 // Aggregates and complex variables are accessed by reference. All we 2277 // need to do is realign the value, if requested. 2278 Address V = ParamAddr; 2279 if (ArgI.getIndirectRealign()) { 2280 Address AlignedTemp = CreateMemTemp(Ty, "coerce"); 2281 2282 // Copy from the incoming argument pointer to the temporary with the 2283 // appropriate alignment. 2284 // 2285 // FIXME: We should have a common utility for generating an aggregate 2286 // copy. 2287 CharUnits Size = getContext().getTypeSizeInChars(Ty); 2288 auto SizeVal = llvm::ConstantInt::get(IntPtrTy, Size.getQuantity()); 2289 Address Dst = Builder.CreateBitCast(AlignedTemp, Int8PtrTy); 2290 Address Src = Builder.CreateBitCast(ParamAddr, Int8PtrTy); 2291 Builder.CreateMemCpy(Dst, Src, SizeVal, false); 2292 V = AlignedTemp; 2293 } 2294 ArgVals.push_back(ParamValue::forIndirect(V)); 2295 } else { 2296 // Load scalar value from indirect argument. 2297 llvm::Value *V = 2298 EmitLoadOfScalar(ParamAddr, false, Ty, Arg->getLocStart()); 2299 2300 if (isPromoted) 2301 V = emitArgumentDemotion(*this, Arg, V); 2302 ArgVals.push_back(ParamValue::forDirect(V)); 2303 } 2304 break; 2305 } 2306 2307 case ABIArgInfo::Extend: 2308 case ABIArgInfo::Direct: { 2309 2310 // If we have the trivial case, handle it with no muss and fuss. 2311 if (!isa<llvm::StructType>(ArgI.getCoerceToType()) && 2312 ArgI.getCoerceToType() == ConvertType(Ty) && 2313 ArgI.getDirectOffset() == 0) { 2314 assert(NumIRArgs == 1); 2315 llvm::Value *V = FnArgs[FirstIRArg]; 2316 auto AI = cast<llvm::Argument>(V); 2317 2318 if (const ParmVarDecl *PVD = dyn_cast<ParmVarDecl>(Arg)) { 2319 if (getNonNullAttr(CurCodeDecl, PVD, PVD->getType(), 2320 PVD->getFunctionScopeIndex())) 2321 AI->addAttr(llvm::AttributeList::get(getLLVMContext(), 2322 AI->getArgNo() + 1, 2323 llvm::Attribute::NonNull)); 2324 2325 QualType OTy = PVD->getOriginalType(); 2326 if (const auto *ArrTy = 2327 getContext().getAsConstantArrayType(OTy)) { 2328 // A C99 array parameter declaration with the static keyword also 2329 // indicates dereferenceability, and if the size is constant we can 2330 // use the dereferenceable attribute (which requires the size in 2331 // bytes). 2332 if (ArrTy->getSizeModifier() == ArrayType::Static) { 2333 QualType ETy = ArrTy->getElementType(); 2334 uint64_t ArrSize = ArrTy->getSize().getZExtValue(); 2335 if (!ETy->isIncompleteType() && ETy->isConstantSizeType() && 2336 ArrSize) { 2337 llvm::AttrBuilder Attrs; 2338 Attrs.addDereferenceableAttr( 2339 getContext().getTypeSizeInChars(ETy).getQuantity()*ArrSize); 2340 AI->addAttr(llvm::AttributeList::get( 2341 getLLVMContext(), AI->getArgNo() + 1, Attrs)); 2342 } else if (getContext().getTargetAddressSpace(ETy) == 0) { 2343 AI->addAttr(llvm::AttributeList::get(getLLVMContext(), 2344 AI->getArgNo() + 1, 2345 llvm::Attribute::NonNull)); 2346 } 2347 } 2348 } else if (const auto *ArrTy = 2349 getContext().getAsVariableArrayType(OTy)) { 2350 // For C99 VLAs with the static keyword, we don't know the size so 2351 // we can't use the dereferenceable attribute, but in addrspace(0) 2352 // we know that it must be nonnull. 2353 if (ArrTy->getSizeModifier() == VariableArrayType::Static && 2354 !getContext().getTargetAddressSpace(ArrTy->getElementType())) 2355 AI->addAttr(llvm::AttributeList::get(getLLVMContext(), 2356 AI->getArgNo() + 1, 2357 llvm::Attribute::NonNull)); 2358 } 2359 2360 const auto *AVAttr = PVD->getAttr<AlignValueAttr>(); 2361 if (!AVAttr) 2362 if (const auto *TOTy = dyn_cast<TypedefType>(OTy)) 2363 AVAttr = TOTy->getDecl()->getAttr<AlignValueAttr>(); 2364 if (AVAttr) { 2365 llvm::Value *AlignmentValue = 2366 EmitScalarExpr(AVAttr->getAlignment()); 2367 llvm::ConstantInt *AlignmentCI = 2368 cast<llvm::ConstantInt>(AlignmentValue); 2369 unsigned Alignment = 2370 std::min((unsigned) AlignmentCI->getZExtValue(), 2371 +llvm::Value::MaximumAlignment); 2372 2373 llvm::AttrBuilder Attrs; 2374 Attrs.addAlignmentAttr(Alignment); 2375 AI->addAttr(llvm::AttributeList::get(getLLVMContext(), 2376 AI->getArgNo() + 1, Attrs)); 2377 } 2378 } 2379 2380 if (Arg->getType().isRestrictQualified()) 2381 AI->addAttr(llvm::AttributeList::get( 2382 getLLVMContext(), AI->getArgNo() + 1, llvm::Attribute::NoAlias)); 2383 2384 // LLVM expects swifterror parameters to be used in very restricted 2385 // ways. Copy the value into a less-restricted temporary. 2386 if (FI.getExtParameterInfo(ArgNo).getABI() 2387 == ParameterABI::SwiftErrorResult) { 2388 QualType pointeeTy = Ty->getPointeeType(); 2389 assert(pointeeTy->isPointerType()); 2390 Address temp = 2391 CreateMemTemp(pointeeTy, getPointerAlign(), "swifterror.temp"); 2392 Address arg = Address(V, getContext().getTypeAlignInChars(pointeeTy)); 2393 llvm::Value *incomingErrorValue = Builder.CreateLoad(arg); 2394 Builder.CreateStore(incomingErrorValue, temp); 2395 V = temp.getPointer(); 2396 2397 // Push a cleanup to copy the value back at the end of the function. 2398 // The convention does not guarantee that the value will be written 2399 // back if the function exits with an unwind exception. 2400 EHStack.pushCleanup<CopyBackSwiftError>(NormalCleanup, temp, arg); 2401 } 2402 2403 // Ensure the argument is the correct type. 2404 if (V->getType() != ArgI.getCoerceToType()) 2405 V = Builder.CreateBitCast(V, ArgI.getCoerceToType()); 2406 2407 if (isPromoted) 2408 V = emitArgumentDemotion(*this, Arg, V); 2409 2410 // Because of merging of function types from multiple decls it is 2411 // possible for the type of an argument to not match the corresponding 2412 // type in the function type. Since we are codegening the callee 2413 // in here, add a cast to the argument type. 2414 llvm::Type *LTy = ConvertType(Arg->getType()); 2415 if (V->getType() != LTy) 2416 V = Builder.CreateBitCast(V, LTy); 2417 2418 ArgVals.push_back(ParamValue::forDirect(V)); 2419 break; 2420 } 2421 2422 Address Alloca = CreateMemTemp(Ty, getContext().getDeclAlign(Arg), 2423 Arg->getName()); 2424 2425 // Pointer to store into. 2426 Address Ptr = emitAddressAtOffset(*this, Alloca, ArgI); 2427 2428 // Fast-isel and the optimizer generally like scalar values better than 2429 // FCAs, so we flatten them if this is safe to do for this argument. 2430 llvm::StructType *STy = dyn_cast<llvm::StructType>(ArgI.getCoerceToType()); 2431 if (ArgI.isDirect() && ArgI.getCanBeFlattened() && STy && 2432 STy->getNumElements() > 1) { 2433 auto SrcLayout = CGM.getDataLayout().getStructLayout(STy); 2434 uint64_t SrcSize = CGM.getDataLayout().getTypeAllocSize(STy); 2435 llvm::Type *DstTy = Ptr.getElementType(); 2436 uint64_t DstSize = CGM.getDataLayout().getTypeAllocSize(DstTy); 2437 2438 Address AddrToStoreInto = Address::invalid(); 2439 if (SrcSize <= DstSize) { 2440 AddrToStoreInto = 2441 Builder.CreateBitCast(Ptr, llvm::PointerType::getUnqual(STy)); 2442 } else { 2443 AddrToStoreInto = 2444 CreateTempAlloca(STy, Alloca.getAlignment(), "coerce"); 2445 } 2446 2447 assert(STy->getNumElements() == NumIRArgs); 2448 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) { 2449 auto AI = FnArgs[FirstIRArg + i]; 2450 AI->setName(Arg->getName() + ".coerce" + Twine(i)); 2451 auto Offset = CharUnits::fromQuantity(SrcLayout->getElementOffset(i)); 2452 Address EltPtr = 2453 Builder.CreateStructGEP(AddrToStoreInto, i, Offset); 2454 Builder.CreateStore(AI, EltPtr); 2455 } 2456 2457 if (SrcSize > DstSize) { 2458 Builder.CreateMemCpy(Ptr, AddrToStoreInto, DstSize); 2459 } 2460 2461 } else { 2462 // Simple case, just do a coerced store of the argument into the alloca. 2463 assert(NumIRArgs == 1); 2464 auto AI = FnArgs[FirstIRArg]; 2465 AI->setName(Arg->getName() + ".coerce"); 2466 CreateCoercedStore(AI, Ptr, /*DestIsVolatile=*/false, *this); 2467 } 2468 2469 // Match to what EmitParmDecl is expecting for this type. 2470 if (CodeGenFunction::hasScalarEvaluationKind(Ty)) { 2471 llvm::Value *V = 2472 EmitLoadOfScalar(Alloca, false, Ty, Arg->getLocStart()); 2473 if (isPromoted) 2474 V = emitArgumentDemotion(*this, Arg, V); 2475 ArgVals.push_back(ParamValue::forDirect(V)); 2476 } else { 2477 ArgVals.push_back(ParamValue::forIndirect(Alloca)); 2478 } 2479 break; 2480 } 2481 2482 case ABIArgInfo::CoerceAndExpand: { 2483 // Reconstruct into a temporary. 2484 Address alloca = CreateMemTemp(Ty, getContext().getDeclAlign(Arg)); 2485 ArgVals.push_back(ParamValue::forIndirect(alloca)); 2486 2487 auto coercionType = ArgI.getCoerceAndExpandType(); 2488 alloca = Builder.CreateElementBitCast(alloca, coercionType); 2489 auto layout = CGM.getDataLayout().getStructLayout(coercionType); 2490 2491 unsigned argIndex = FirstIRArg; 2492 for (unsigned i = 0, e = coercionType->getNumElements(); i != e; ++i) { 2493 llvm::Type *eltType = coercionType->getElementType(i); 2494 if (ABIArgInfo::isPaddingForCoerceAndExpand(eltType)) 2495 continue; 2496 2497 auto eltAddr = Builder.CreateStructGEP(alloca, i, layout); 2498 auto elt = FnArgs[argIndex++]; 2499 Builder.CreateStore(elt, eltAddr); 2500 } 2501 assert(argIndex == FirstIRArg + NumIRArgs); 2502 break; 2503 } 2504 2505 case ABIArgInfo::Expand: { 2506 // If this structure was expanded into multiple arguments then 2507 // we need to create a temporary and reconstruct it from the 2508 // arguments. 2509 Address Alloca = CreateMemTemp(Ty, getContext().getDeclAlign(Arg)); 2510 LValue LV = MakeAddrLValue(Alloca, Ty); 2511 ArgVals.push_back(ParamValue::forIndirect(Alloca)); 2512 2513 auto FnArgIter = FnArgs.begin() + FirstIRArg; 2514 ExpandTypeFromArgs(Ty, LV, FnArgIter); 2515 assert(FnArgIter == FnArgs.begin() + FirstIRArg + NumIRArgs); 2516 for (unsigned i = 0, e = NumIRArgs; i != e; ++i) { 2517 auto AI = FnArgs[FirstIRArg + i]; 2518 AI->setName(Arg->getName() + "." + Twine(i)); 2519 } 2520 break; 2521 } 2522 2523 case ABIArgInfo::Ignore: 2524 assert(NumIRArgs == 0); 2525 // Initialize the local variable appropriately. 2526 if (!hasScalarEvaluationKind(Ty)) { 2527 ArgVals.push_back(ParamValue::forIndirect(CreateMemTemp(Ty))); 2528 } else { 2529 llvm::Value *U = llvm::UndefValue::get(ConvertType(Arg->getType())); 2530 ArgVals.push_back(ParamValue::forDirect(U)); 2531 } 2532 break; 2533 } 2534 } 2535 2536 if (getTarget().getCXXABI().areArgsDestroyedLeftToRightInCallee()) { 2537 for (int I = Args.size() - 1; I >= 0; --I) 2538 EmitParmDecl(*Args[I], ArgVals[I], I + 1); 2539 } else { 2540 for (unsigned I = 0, E = Args.size(); I != E; ++I) 2541 EmitParmDecl(*Args[I], ArgVals[I], I + 1); 2542 } 2543 } 2544 2545 static void eraseUnusedBitCasts(llvm::Instruction *insn) { 2546 while (insn->use_empty()) { 2547 llvm::BitCastInst *bitcast = dyn_cast<llvm::BitCastInst>(insn); 2548 if (!bitcast) return; 2549 2550 // This is "safe" because we would have used a ConstantExpr otherwise. 2551 insn = cast<llvm::Instruction>(bitcast->getOperand(0)); 2552 bitcast->eraseFromParent(); 2553 } 2554 } 2555 2556 /// Try to emit a fused autorelease of a return result. 2557 static llvm::Value *tryEmitFusedAutoreleaseOfResult(CodeGenFunction &CGF, 2558 llvm::Value *result) { 2559 // We must be immediately followed the cast. 2560 llvm::BasicBlock *BB = CGF.Builder.GetInsertBlock(); 2561 if (BB->empty()) return nullptr; 2562 if (&BB->back() != result) return nullptr; 2563 2564 llvm::Type *resultType = result->getType(); 2565 2566 // result is in a BasicBlock and is therefore an Instruction. 2567 llvm::Instruction *generator = cast<llvm::Instruction>(result); 2568 2569 SmallVector<llvm::Instruction *, 4> InstsToKill; 2570 2571 // Look for: 2572 // %generator = bitcast %type1* %generator2 to %type2* 2573 while (llvm::BitCastInst *bitcast = dyn_cast<llvm::BitCastInst>(generator)) { 2574 // We would have emitted this as a constant if the operand weren't 2575 // an Instruction. 2576 generator = cast<llvm::Instruction>(bitcast->getOperand(0)); 2577 2578 // Require the generator to be immediately followed by the cast. 2579 if (generator->getNextNode() != bitcast) 2580 return nullptr; 2581 2582 InstsToKill.push_back(bitcast); 2583 } 2584 2585 // Look for: 2586 // %generator = call i8* @objc_retain(i8* %originalResult) 2587 // or 2588 // %generator = call i8* @objc_retainAutoreleasedReturnValue(i8* %originalResult) 2589 llvm::CallInst *call = dyn_cast<llvm::CallInst>(generator); 2590 if (!call) return nullptr; 2591 2592 bool doRetainAutorelease; 2593 2594 if (call->getCalledValue() == CGF.CGM.getObjCEntrypoints().objc_retain) { 2595 doRetainAutorelease = true; 2596 } else if (call->getCalledValue() == CGF.CGM.getObjCEntrypoints() 2597 .objc_retainAutoreleasedReturnValue) { 2598 doRetainAutorelease = false; 2599 2600 // If we emitted an assembly marker for this call (and the 2601 // ARCEntrypoints field should have been set if so), go looking 2602 // for that call. If we can't find it, we can't do this 2603 // optimization. But it should always be the immediately previous 2604 // instruction, unless we needed bitcasts around the call. 2605 if (CGF.CGM.getObjCEntrypoints().retainAutoreleasedReturnValueMarker) { 2606 llvm::Instruction *prev = call->getPrevNode(); 2607 assert(prev); 2608 if (isa<llvm::BitCastInst>(prev)) { 2609 prev = prev->getPrevNode(); 2610 assert(prev); 2611 } 2612 assert(isa<llvm::CallInst>(prev)); 2613 assert(cast<llvm::CallInst>(prev)->getCalledValue() == 2614 CGF.CGM.getObjCEntrypoints().retainAutoreleasedReturnValueMarker); 2615 InstsToKill.push_back(prev); 2616 } 2617 } else { 2618 return nullptr; 2619 } 2620 2621 result = call->getArgOperand(0); 2622 InstsToKill.push_back(call); 2623 2624 // Keep killing bitcasts, for sanity. Note that we no longer care 2625 // about precise ordering as long as there's exactly one use. 2626 while (llvm::BitCastInst *bitcast = dyn_cast<llvm::BitCastInst>(result)) { 2627 if (!bitcast->hasOneUse()) break; 2628 InstsToKill.push_back(bitcast); 2629 result = bitcast->getOperand(0); 2630 } 2631 2632 // Delete all the unnecessary instructions, from latest to earliest. 2633 for (auto *I : InstsToKill) 2634 I->eraseFromParent(); 2635 2636 // Do the fused retain/autorelease if we were asked to. 2637 if (doRetainAutorelease) 2638 result = CGF.EmitARCRetainAutoreleaseReturnValue(result); 2639 2640 // Cast back to the result type. 2641 return CGF.Builder.CreateBitCast(result, resultType); 2642 } 2643 2644 /// If this is a +1 of the value of an immutable 'self', remove it. 2645 static llvm::Value *tryRemoveRetainOfSelf(CodeGenFunction &CGF, 2646 llvm::Value *result) { 2647 // This is only applicable to a method with an immutable 'self'. 2648 const ObjCMethodDecl *method = 2649 dyn_cast_or_null<ObjCMethodDecl>(CGF.CurCodeDecl); 2650 if (!method) return nullptr; 2651 const VarDecl *self = method->getSelfDecl(); 2652 if (!self->getType().isConstQualified()) return nullptr; 2653 2654 // Look for a retain call. 2655 llvm::CallInst *retainCall = 2656 dyn_cast<llvm::CallInst>(result->stripPointerCasts()); 2657 if (!retainCall || 2658 retainCall->getCalledValue() != CGF.CGM.getObjCEntrypoints().objc_retain) 2659 return nullptr; 2660 2661 // Look for an ordinary load of 'self'. 2662 llvm::Value *retainedValue = retainCall->getArgOperand(0); 2663 llvm::LoadInst *load = 2664 dyn_cast<llvm::LoadInst>(retainedValue->stripPointerCasts()); 2665 if (!load || load->isAtomic() || load->isVolatile() || 2666 load->getPointerOperand() != CGF.GetAddrOfLocalVar(self).getPointer()) 2667 return nullptr; 2668 2669 // Okay! Burn it all down. This relies for correctness on the 2670 // assumption that the retain is emitted as part of the return and 2671 // that thereafter everything is used "linearly". 2672 llvm::Type *resultType = result->getType(); 2673 eraseUnusedBitCasts(cast<llvm::Instruction>(result)); 2674 assert(retainCall->use_empty()); 2675 retainCall->eraseFromParent(); 2676 eraseUnusedBitCasts(cast<llvm::Instruction>(retainedValue)); 2677 2678 return CGF.Builder.CreateBitCast(load, resultType); 2679 } 2680 2681 /// Emit an ARC autorelease of the result of a function. 2682 /// 2683 /// \return the value to actually return from the function 2684 static llvm::Value *emitAutoreleaseOfResult(CodeGenFunction &CGF, 2685 llvm::Value *result) { 2686 // If we're returning 'self', kill the initial retain. This is a 2687 // heuristic attempt to "encourage correctness" in the really unfortunate 2688 // case where we have a return of self during a dealloc and we desperately 2689 // need to avoid the possible autorelease. 2690 if (llvm::Value *self = tryRemoveRetainOfSelf(CGF, result)) 2691 return self; 2692 2693 // At -O0, try to emit a fused retain/autorelease. 2694 if (CGF.shouldUseFusedARCCalls()) 2695 if (llvm::Value *fused = tryEmitFusedAutoreleaseOfResult(CGF, result)) 2696 return fused; 2697 2698 return CGF.EmitARCAutoreleaseReturnValue(result); 2699 } 2700 2701 /// Heuristically search for a dominating store to the return-value slot. 2702 static llvm::StoreInst *findDominatingStoreToReturnValue(CodeGenFunction &CGF) { 2703 // Check if a User is a store which pointerOperand is the ReturnValue. 2704 // We are looking for stores to the ReturnValue, not for stores of the 2705 // ReturnValue to some other location. 2706 auto GetStoreIfValid = [&CGF](llvm::User *U) -> llvm::StoreInst * { 2707 auto *SI = dyn_cast<llvm::StoreInst>(U); 2708 if (!SI || SI->getPointerOperand() != CGF.ReturnValue.getPointer()) 2709 return nullptr; 2710 // These aren't actually possible for non-coerced returns, and we 2711 // only care about non-coerced returns on this code path. 2712 assert(!SI->isAtomic() && !SI->isVolatile()); 2713 return SI; 2714 }; 2715 // If there are multiple uses of the return-value slot, just check 2716 // for something immediately preceding the IP. Sometimes this can 2717 // happen with how we generate implicit-returns; it can also happen 2718 // with noreturn cleanups. 2719 if (!CGF.ReturnValue.getPointer()->hasOneUse()) { 2720 llvm::BasicBlock *IP = CGF.Builder.GetInsertBlock(); 2721 if (IP->empty()) return nullptr; 2722 llvm::Instruction *I = &IP->back(); 2723 2724 // Skip lifetime markers 2725 for (llvm::BasicBlock::reverse_iterator II = IP->rbegin(), 2726 IE = IP->rend(); 2727 II != IE; ++II) { 2728 if (llvm::IntrinsicInst *Intrinsic = 2729 dyn_cast<llvm::IntrinsicInst>(&*II)) { 2730 if (Intrinsic->getIntrinsicID() == llvm::Intrinsic::lifetime_end) { 2731 const llvm::Value *CastAddr = Intrinsic->getArgOperand(1); 2732 ++II; 2733 if (II == IE) 2734 break; 2735 if (isa<llvm::BitCastInst>(&*II) && (CastAddr == &*II)) 2736 continue; 2737 } 2738 } 2739 I = &*II; 2740 break; 2741 } 2742 2743 return GetStoreIfValid(I); 2744 } 2745 2746 llvm::StoreInst *store = 2747 GetStoreIfValid(CGF.ReturnValue.getPointer()->user_back()); 2748 if (!store) return nullptr; 2749 2750 // Now do a first-and-dirty dominance check: just walk up the 2751 // single-predecessors chain from the current insertion point. 2752 llvm::BasicBlock *StoreBB = store->getParent(); 2753 llvm::BasicBlock *IP = CGF.Builder.GetInsertBlock(); 2754 while (IP != StoreBB) { 2755 if (!(IP = IP->getSinglePredecessor())) 2756 return nullptr; 2757 } 2758 2759 // Okay, the store's basic block dominates the insertion point; we 2760 // can do our thing. 2761 return store; 2762 } 2763 2764 void CodeGenFunction::EmitFunctionEpilog(const CGFunctionInfo &FI, 2765 bool EmitRetDbgLoc, 2766 SourceLocation EndLoc) { 2767 if (CurCodeDecl && CurCodeDecl->hasAttr<NakedAttr>()) { 2768 // Naked functions don't have epilogues. 2769 Builder.CreateUnreachable(); 2770 return; 2771 } 2772 2773 // Functions with no result always return void. 2774 if (!ReturnValue.isValid()) { 2775 Builder.CreateRetVoid(); 2776 return; 2777 } 2778 2779 llvm::DebugLoc RetDbgLoc; 2780 llvm::Value *RV = nullptr; 2781 QualType RetTy = FI.getReturnType(); 2782 const ABIArgInfo &RetAI = FI.getReturnInfo(); 2783 2784 switch (RetAI.getKind()) { 2785 case ABIArgInfo::InAlloca: 2786 // Aggregrates get evaluated directly into the destination. Sometimes we 2787 // need to return the sret value in a register, though. 2788 assert(hasAggregateEvaluationKind(RetTy)); 2789 if (RetAI.getInAllocaSRet()) { 2790 llvm::Function::arg_iterator EI = CurFn->arg_end(); 2791 --EI; 2792 llvm::Value *ArgStruct = &*EI; 2793 llvm::Value *SRet = Builder.CreateStructGEP( 2794 nullptr, ArgStruct, RetAI.getInAllocaFieldIndex()); 2795 RV = Builder.CreateAlignedLoad(SRet, getPointerAlign(), "sret"); 2796 } 2797 break; 2798 2799 case ABIArgInfo::Indirect: { 2800 auto AI = CurFn->arg_begin(); 2801 if (RetAI.isSRetAfterThis()) 2802 ++AI; 2803 switch (getEvaluationKind(RetTy)) { 2804 case TEK_Complex: { 2805 ComplexPairTy RT = 2806 EmitLoadOfComplex(MakeAddrLValue(ReturnValue, RetTy), EndLoc); 2807 EmitStoreOfComplex(RT, MakeNaturalAlignAddrLValue(&*AI, RetTy), 2808 /*isInit*/ true); 2809 break; 2810 } 2811 case TEK_Aggregate: 2812 // Do nothing; aggregrates get evaluated directly into the destination. 2813 break; 2814 case TEK_Scalar: 2815 EmitStoreOfScalar(Builder.CreateLoad(ReturnValue), 2816 MakeNaturalAlignAddrLValue(&*AI, RetTy), 2817 /*isInit*/ true); 2818 break; 2819 } 2820 break; 2821 } 2822 2823 case ABIArgInfo::Extend: 2824 case ABIArgInfo::Direct: 2825 if (RetAI.getCoerceToType() == ConvertType(RetTy) && 2826 RetAI.getDirectOffset() == 0) { 2827 // The internal return value temp always will have pointer-to-return-type 2828 // type, just do a load. 2829 2830 // If there is a dominating store to ReturnValue, we can elide 2831 // the load, zap the store, and usually zap the alloca. 2832 if (llvm::StoreInst *SI = 2833 findDominatingStoreToReturnValue(*this)) { 2834 // Reuse the debug location from the store unless there is 2835 // cleanup code to be emitted between the store and return 2836 // instruction. 2837 if (EmitRetDbgLoc && !AutoreleaseResult) 2838 RetDbgLoc = SI->getDebugLoc(); 2839 // Get the stored value and nuke the now-dead store. 2840 RV = SI->getValueOperand(); 2841 SI->eraseFromParent(); 2842 2843 // If that was the only use of the return value, nuke it as well now. 2844 auto returnValueInst = ReturnValue.getPointer(); 2845 if (returnValueInst->use_empty()) { 2846 if (auto alloca = dyn_cast<llvm::AllocaInst>(returnValueInst)) { 2847 alloca->eraseFromParent(); 2848 ReturnValue = Address::invalid(); 2849 } 2850 } 2851 2852 // Otherwise, we have to do a simple load. 2853 } else { 2854 RV = Builder.CreateLoad(ReturnValue); 2855 } 2856 } else { 2857 // If the value is offset in memory, apply the offset now. 2858 Address V = emitAddressAtOffset(*this, ReturnValue, RetAI); 2859 2860 RV = CreateCoercedLoad(V, RetAI.getCoerceToType(), *this); 2861 } 2862 2863 // In ARC, end functions that return a retainable type with a call 2864 // to objc_autoreleaseReturnValue. 2865 if (AutoreleaseResult) { 2866 #ifndef NDEBUG 2867 // Type::isObjCRetainabletype has to be called on a QualType that hasn't 2868 // been stripped of the typedefs, so we cannot use RetTy here. Get the 2869 // original return type of FunctionDecl, CurCodeDecl, and BlockDecl from 2870 // CurCodeDecl or BlockInfo. 2871 QualType RT; 2872 2873 if (auto *FD = dyn_cast<FunctionDecl>(CurCodeDecl)) 2874 RT = FD->getReturnType(); 2875 else if (auto *MD = dyn_cast<ObjCMethodDecl>(CurCodeDecl)) 2876 RT = MD->getReturnType(); 2877 else if (isa<BlockDecl>(CurCodeDecl)) 2878 RT = BlockInfo->BlockExpression->getFunctionType()->getReturnType(); 2879 else 2880 llvm_unreachable("Unexpected function/method type"); 2881 2882 assert(getLangOpts().ObjCAutoRefCount && 2883 !FI.isReturnsRetained() && 2884 RT->isObjCRetainableType()); 2885 #endif 2886 RV = emitAutoreleaseOfResult(*this, RV); 2887 } 2888 2889 break; 2890 2891 case ABIArgInfo::Ignore: 2892 break; 2893 2894 case ABIArgInfo::CoerceAndExpand: { 2895 auto coercionType = RetAI.getCoerceAndExpandType(); 2896 auto layout = CGM.getDataLayout().getStructLayout(coercionType); 2897 2898 // Load all of the coerced elements out into results. 2899 llvm::SmallVector<llvm::Value*, 4> results; 2900 Address addr = Builder.CreateElementBitCast(ReturnValue, coercionType); 2901 for (unsigned i = 0, e = coercionType->getNumElements(); i != e; ++i) { 2902 auto coercedEltType = coercionType->getElementType(i); 2903 if (ABIArgInfo::isPaddingForCoerceAndExpand(coercedEltType)) 2904 continue; 2905 2906 auto eltAddr = Builder.CreateStructGEP(addr, i, layout); 2907 auto elt = Builder.CreateLoad(eltAddr); 2908 results.push_back(elt); 2909 } 2910 2911 // If we have one result, it's the single direct result type. 2912 if (results.size() == 1) { 2913 RV = results[0]; 2914 2915 // Otherwise, we need to make a first-class aggregate. 2916 } else { 2917 // Construct a return type that lacks padding elements. 2918 llvm::Type *returnType = RetAI.getUnpaddedCoerceAndExpandType(); 2919 2920 RV = llvm::UndefValue::get(returnType); 2921 for (unsigned i = 0, e = results.size(); i != e; ++i) { 2922 RV = Builder.CreateInsertValue(RV, results[i], i); 2923 } 2924 } 2925 break; 2926 } 2927 2928 case ABIArgInfo::Expand: 2929 llvm_unreachable("Invalid ABI kind for return argument"); 2930 } 2931 2932 llvm::Instruction *Ret; 2933 if (RV) { 2934 EmitReturnValueCheck(RV, EndLoc); 2935 Ret = Builder.CreateRet(RV); 2936 } else { 2937 Ret = Builder.CreateRetVoid(); 2938 } 2939 2940 if (RetDbgLoc) 2941 Ret->setDebugLoc(std::move(RetDbgLoc)); 2942 } 2943 2944 void CodeGenFunction::EmitReturnValueCheck(llvm::Value *RV, 2945 SourceLocation EndLoc) { 2946 // A current decl may not be available when emitting vtable thunks. 2947 if (!CurCodeDecl) 2948 return; 2949 2950 ReturnsNonNullAttr *RetNNAttr = nullptr; 2951 if (SanOpts.has(SanitizerKind::ReturnsNonnullAttribute)) 2952 RetNNAttr = CurCodeDecl->getAttr<ReturnsNonNullAttr>(); 2953 2954 if (!RetNNAttr && !requiresReturnValueNullabilityCheck()) 2955 return; 2956 2957 // Prefer the returns_nonnull attribute if it's present. 2958 SourceLocation AttrLoc; 2959 SanitizerMask CheckKind; 2960 SanitizerHandler Handler; 2961 if (RetNNAttr) { 2962 assert(!requiresReturnValueNullabilityCheck() && 2963 "Cannot check nullability and the nonnull attribute"); 2964 AttrLoc = RetNNAttr->getLocation(); 2965 CheckKind = SanitizerKind::ReturnsNonnullAttribute; 2966 Handler = SanitizerHandler::NonnullReturn; 2967 } else { 2968 if (auto *DD = dyn_cast<DeclaratorDecl>(CurCodeDecl)) 2969 if (auto *TSI = DD->getTypeSourceInfo()) 2970 if (auto FTL = TSI->getTypeLoc().castAs<FunctionTypeLoc>()) 2971 AttrLoc = FTL.getReturnLoc().findNullabilityLoc(); 2972 CheckKind = SanitizerKind::NullabilityReturn; 2973 Handler = SanitizerHandler::NullabilityReturn; 2974 } 2975 2976 SanitizerScope SanScope(this); 2977 2978 llvm::BasicBlock *Check = nullptr; 2979 llvm::BasicBlock *NoCheck = nullptr; 2980 if (requiresReturnValueNullabilityCheck()) { 2981 // Before doing the nullability check, make sure that the preconditions for 2982 // the check are met. 2983 Check = createBasicBlock("nullcheck"); 2984 NoCheck = createBasicBlock("no.nullcheck"); 2985 Builder.CreateCondBr(RetValNullabilityPrecondition, Check, NoCheck); 2986 EmitBlock(Check); 2987 } 2988 2989 // Now do the null check. If the returns_nonnull attribute is present, this 2990 // is done unconditionally. 2991 llvm::Value *Cond = Builder.CreateIsNotNull(RV); 2992 llvm::Constant *StaticData[] = { 2993 EmitCheckSourceLocation(EndLoc), EmitCheckSourceLocation(AttrLoc), 2994 }; 2995 EmitCheck(std::make_pair(Cond, CheckKind), Handler, StaticData, None); 2996 2997 if (requiresReturnValueNullabilityCheck()) 2998 EmitBlock(NoCheck); 2999 } 3000 3001 static bool isInAllocaArgument(CGCXXABI &ABI, QualType type) { 3002 const CXXRecordDecl *RD = type->getAsCXXRecordDecl(); 3003 return RD && ABI.getRecordArgABI(RD) == CGCXXABI::RAA_DirectInMemory; 3004 } 3005 3006 static AggValueSlot createPlaceholderSlot(CodeGenFunction &CGF, 3007 QualType Ty) { 3008 // FIXME: Generate IR in one pass, rather than going back and fixing up these 3009 // placeholders. 3010 llvm::Type *IRTy = CGF.ConvertTypeForMem(Ty); 3011 llvm::Type *IRPtrTy = IRTy->getPointerTo(); 3012 llvm::Value *Placeholder = llvm::UndefValue::get(IRPtrTy->getPointerTo()); 3013 3014 // FIXME: When we generate this IR in one pass, we shouldn't need 3015 // this win32-specific alignment hack. 3016 CharUnits Align = CharUnits::fromQuantity(4); 3017 Placeholder = CGF.Builder.CreateAlignedLoad(IRPtrTy, Placeholder, Align); 3018 3019 return AggValueSlot::forAddr(Address(Placeholder, Align), 3020 Ty.getQualifiers(), 3021 AggValueSlot::IsNotDestructed, 3022 AggValueSlot::DoesNotNeedGCBarriers, 3023 AggValueSlot::IsNotAliased); 3024 } 3025 3026 void CodeGenFunction::EmitDelegateCallArg(CallArgList &args, 3027 const VarDecl *param, 3028 SourceLocation loc) { 3029 // StartFunction converted the ABI-lowered parameter(s) into a 3030 // local alloca. We need to turn that into an r-value suitable 3031 // for EmitCall. 3032 Address local = GetAddrOfLocalVar(param); 3033 3034 QualType type = param->getType(); 3035 3036 assert(!isInAllocaArgument(CGM.getCXXABI(), type) && 3037 "cannot emit delegate call arguments for inalloca arguments!"); 3038 3039 // GetAddrOfLocalVar returns a pointer-to-pointer for references, 3040 // but the argument needs to be the original pointer. 3041 if (type->isReferenceType()) { 3042 args.add(RValue::get(Builder.CreateLoad(local)), type); 3043 3044 // In ARC, move out of consumed arguments so that the release cleanup 3045 // entered by StartFunction doesn't cause an over-release. This isn't 3046 // optimal -O0 code generation, but it should get cleaned up when 3047 // optimization is enabled. This also assumes that delegate calls are 3048 // performed exactly once for a set of arguments, but that should be safe. 3049 } else if (getLangOpts().ObjCAutoRefCount && 3050 param->hasAttr<NSConsumedAttr>() && 3051 type->isObjCRetainableType()) { 3052 llvm::Value *ptr = Builder.CreateLoad(local); 3053 auto null = 3054 llvm::ConstantPointerNull::get(cast<llvm::PointerType>(ptr->getType())); 3055 Builder.CreateStore(null, local); 3056 args.add(RValue::get(ptr), type); 3057 3058 // For the most part, we just need to load the alloca, except that 3059 // aggregate r-values are actually pointers to temporaries. 3060 } else { 3061 args.add(convertTempToRValue(local, type, loc), type); 3062 } 3063 } 3064 3065 static bool isProvablyNull(llvm::Value *addr) { 3066 return isa<llvm::ConstantPointerNull>(addr); 3067 } 3068 3069 /// Emit the actual writing-back of a writeback. 3070 static void emitWriteback(CodeGenFunction &CGF, 3071 const CallArgList::Writeback &writeback) { 3072 const LValue &srcLV = writeback.Source; 3073 Address srcAddr = srcLV.getAddress(); 3074 assert(!isProvablyNull(srcAddr.getPointer()) && 3075 "shouldn't have writeback for provably null argument"); 3076 3077 llvm::BasicBlock *contBB = nullptr; 3078 3079 // If the argument wasn't provably non-null, we need to null check 3080 // before doing the store. 3081 bool provablyNonNull = llvm::isKnownNonNull(srcAddr.getPointer()); 3082 if (!provablyNonNull) { 3083 llvm::BasicBlock *writebackBB = CGF.createBasicBlock("icr.writeback"); 3084 contBB = CGF.createBasicBlock("icr.done"); 3085 3086 llvm::Value *isNull = 3087 CGF.Builder.CreateIsNull(srcAddr.getPointer(), "icr.isnull"); 3088 CGF.Builder.CreateCondBr(isNull, contBB, writebackBB); 3089 CGF.EmitBlock(writebackBB); 3090 } 3091 3092 // Load the value to writeback. 3093 llvm::Value *value = CGF.Builder.CreateLoad(writeback.Temporary); 3094 3095 // Cast it back, in case we're writing an id to a Foo* or something. 3096 value = CGF.Builder.CreateBitCast(value, srcAddr.getElementType(), 3097 "icr.writeback-cast"); 3098 3099 // Perform the writeback. 3100 3101 // If we have a "to use" value, it's something we need to emit a use 3102 // of. This has to be carefully threaded in: if it's done after the 3103 // release it's potentially undefined behavior (and the optimizer 3104 // will ignore it), and if it happens before the retain then the 3105 // optimizer could move the release there. 3106 if (writeback.ToUse) { 3107 assert(srcLV.getObjCLifetime() == Qualifiers::OCL_Strong); 3108 3109 // Retain the new value. No need to block-copy here: the block's 3110 // being passed up the stack. 3111 value = CGF.EmitARCRetainNonBlock(value); 3112 3113 // Emit the intrinsic use here. 3114 CGF.EmitARCIntrinsicUse(writeback.ToUse); 3115 3116 // Load the old value (primitively). 3117 llvm::Value *oldValue = CGF.EmitLoadOfScalar(srcLV, SourceLocation()); 3118 3119 // Put the new value in place (primitively). 3120 CGF.EmitStoreOfScalar(value, srcLV, /*init*/ false); 3121 3122 // Release the old value. 3123 CGF.EmitARCRelease(oldValue, srcLV.isARCPreciseLifetime()); 3124 3125 // Otherwise, we can just do a normal lvalue store. 3126 } else { 3127 CGF.EmitStoreThroughLValue(RValue::get(value), srcLV); 3128 } 3129 3130 // Jump to the continuation block. 3131 if (!provablyNonNull) 3132 CGF.EmitBlock(contBB); 3133 } 3134 3135 static void emitWritebacks(CodeGenFunction &CGF, 3136 const CallArgList &args) { 3137 for (const auto &I : args.writebacks()) 3138 emitWriteback(CGF, I); 3139 } 3140 3141 static void deactivateArgCleanupsBeforeCall(CodeGenFunction &CGF, 3142 const CallArgList &CallArgs) { 3143 assert(CGF.getTarget().getCXXABI().areArgsDestroyedLeftToRightInCallee()); 3144 ArrayRef<CallArgList::CallArgCleanup> Cleanups = 3145 CallArgs.getCleanupsToDeactivate(); 3146 // Iterate in reverse to increase the likelihood of popping the cleanup. 3147 for (const auto &I : llvm::reverse(Cleanups)) { 3148 CGF.DeactivateCleanupBlock(I.Cleanup, I.IsActiveIP); 3149 I.IsActiveIP->eraseFromParent(); 3150 } 3151 } 3152 3153 static const Expr *maybeGetUnaryAddrOfOperand(const Expr *E) { 3154 if (const UnaryOperator *uop = dyn_cast<UnaryOperator>(E->IgnoreParens())) 3155 if (uop->getOpcode() == UO_AddrOf) 3156 return uop->getSubExpr(); 3157 return nullptr; 3158 } 3159 3160 /// Emit an argument that's being passed call-by-writeback. That is, 3161 /// we are passing the address of an __autoreleased temporary; it 3162 /// might be copy-initialized with the current value of the given 3163 /// address, but it will definitely be copied out of after the call. 3164 static void emitWritebackArg(CodeGenFunction &CGF, CallArgList &args, 3165 const ObjCIndirectCopyRestoreExpr *CRE) { 3166 LValue srcLV; 3167 3168 // Make an optimistic effort to emit the address as an l-value. 3169 // This can fail if the argument expression is more complicated. 3170 if (const Expr *lvExpr = maybeGetUnaryAddrOfOperand(CRE->getSubExpr())) { 3171 srcLV = CGF.EmitLValue(lvExpr); 3172 3173 // Otherwise, just emit it as a scalar. 3174 } else { 3175 Address srcAddr = CGF.EmitPointerWithAlignment(CRE->getSubExpr()); 3176 3177 QualType srcAddrType = 3178 CRE->getSubExpr()->getType()->castAs<PointerType>()->getPointeeType(); 3179 srcLV = CGF.MakeAddrLValue(srcAddr, srcAddrType); 3180 } 3181 Address srcAddr = srcLV.getAddress(); 3182 3183 // The dest and src types don't necessarily match in LLVM terms 3184 // because of the crazy ObjC compatibility rules. 3185 3186 llvm::PointerType *destType = 3187 cast<llvm::PointerType>(CGF.ConvertType(CRE->getType())); 3188 3189 // If the address is a constant null, just pass the appropriate null. 3190 if (isProvablyNull(srcAddr.getPointer())) { 3191 args.add(RValue::get(llvm::ConstantPointerNull::get(destType)), 3192 CRE->getType()); 3193 return; 3194 } 3195 3196 // Create the temporary. 3197 Address temp = CGF.CreateTempAlloca(destType->getElementType(), 3198 CGF.getPointerAlign(), 3199 "icr.temp"); 3200 // Loading an l-value can introduce a cleanup if the l-value is __weak, 3201 // and that cleanup will be conditional if we can't prove that the l-value 3202 // isn't null, so we need to register a dominating point so that the cleanups 3203 // system will make valid IR. 3204 CodeGenFunction::ConditionalEvaluation condEval(CGF); 3205 3206 // Zero-initialize it if we're not doing a copy-initialization. 3207 bool shouldCopy = CRE->shouldCopy(); 3208 if (!shouldCopy) { 3209 llvm::Value *null = 3210 llvm::ConstantPointerNull::get( 3211 cast<llvm::PointerType>(destType->getElementType())); 3212 CGF.Builder.CreateStore(null, temp); 3213 } 3214 3215 llvm::BasicBlock *contBB = nullptr; 3216 llvm::BasicBlock *originBB = nullptr; 3217 3218 // If the address is *not* known to be non-null, we need to switch. 3219 llvm::Value *finalArgument; 3220 3221 bool provablyNonNull = llvm::isKnownNonNull(srcAddr.getPointer()); 3222 if (provablyNonNull) { 3223 finalArgument = temp.getPointer(); 3224 } else { 3225 llvm::Value *isNull = 3226 CGF.Builder.CreateIsNull(srcAddr.getPointer(), "icr.isnull"); 3227 3228 finalArgument = CGF.Builder.CreateSelect(isNull, 3229 llvm::ConstantPointerNull::get(destType), 3230 temp.getPointer(), "icr.argument"); 3231 3232 // If we need to copy, then the load has to be conditional, which 3233 // means we need control flow. 3234 if (shouldCopy) { 3235 originBB = CGF.Builder.GetInsertBlock(); 3236 contBB = CGF.createBasicBlock("icr.cont"); 3237 llvm::BasicBlock *copyBB = CGF.createBasicBlock("icr.copy"); 3238 CGF.Builder.CreateCondBr(isNull, contBB, copyBB); 3239 CGF.EmitBlock(copyBB); 3240 condEval.begin(CGF); 3241 } 3242 } 3243 3244 llvm::Value *valueToUse = nullptr; 3245 3246 // Perform a copy if necessary. 3247 if (shouldCopy) { 3248 RValue srcRV = CGF.EmitLoadOfLValue(srcLV, SourceLocation()); 3249 assert(srcRV.isScalar()); 3250 3251 llvm::Value *src = srcRV.getScalarVal(); 3252 src = CGF.Builder.CreateBitCast(src, destType->getElementType(), 3253 "icr.cast"); 3254 3255 // Use an ordinary store, not a store-to-lvalue. 3256 CGF.Builder.CreateStore(src, temp); 3257 3258 // If optimization is enabled, and the value was held in a 3259 // __strong variable, we need to tell the optimizer that this 3260 // value has to stay alive until we're doing the store back. 3261 // This is because the temporary is effectively unretained, 3262 // and so otherwise we can violate the high-level semantics. 3263 if (CGF.CGM.getCodeGenOpts().OptimizationLevel != 0 && 3264 srcLV.getObjCLifetime() == Qualifiers::OCL_Strong) { 3265 valueToUse = src; 3266 } 3267 } 3268 3269 // Finish the control flow if we needed it. 3270 if (shouldCopy && !provablyNonNull) { 3271 llvm::BasicBlock *copyBB = CGF.Builder.GetInsertBlock(); 3272 CGF.EmitBlock(contBB); 3273 3274 // Make a phi for the value to intrinsically use. 3275 if (valueToUse) { 3276 llvm::PHINode *phiToUse = CGF.Builder.CreatePHI(valueToUse->getType(), 2, 3277 "icr.to-use"); 3278 phiToUse->addIncoming(valueToUse, copyBB); 3279 phiToUse->addIncoming(llvm::UndefValue::get(valueToUse->getType()), 3280 originBB); 3281 valueToUse = phiToUse; 3282 } 3283 3284 condEval.end(CGF); 3285 } 3286 3287 args.addWriteback(srcLV, temp, valueToUse); 3288 args.add(RValue::get(finalArgument), CRE->getType()); 3289 } 3290 3291 void CallArgList::allocateArgumentMemory(CodeGenFunction &CGF) { 3292 assert(!StackBase); 3293 3294 // Save the stack. 3295 llvm::Function *F = CGF.CGM.getIntrinsic(llvm::Intrinsic::stacksave); 3296 StackBase = CGF.Builder.CreateCall(F, {}, "inalloca.save"); 3297 } 3298 3299 void CallArgList::freeArgumentMemory(CodeGenFunction &CGF) const { 3300 if (StackBase) { 3301 // Restore the stack after the call. 3302 llvm::Value *F = CGF.CGM.getIntrinsic(llvm::Intrinsic::stackrestore); 3303 CGF.Builder.CreateCall(F, StackBase); 3304 } 3305 } 3306 3307 void CodeGenFunction::EmitNonNullArgCheck(RValue RV, QualType ArgType, 3308 SourceLocation ArgLoc, 3309 AbstractCallee AC, 3310 unsigned ParmNum) { 3311 if (!AC.getDecl() || !(SanOpts.has(SanitizerKind::NonnullAttribute) || 3312 SanOpts.has(SanitizerKind::NullabilityArg))) 3313 return; 3314 3315 // The param decl may be missing in a variadic function. 3316 auto PVD = ParmNum < AC.getNumParams() ? AC.getParamDecl(ParmNum) : nullptr; 3317 unsigned ArgNo = PVD ? PVD->getFunctionScopeIndex() : ParmNum; 3318 3319 // Prefer the nonnull attribute if it's present. 3320 const NonNullAttr *NNAttr = nullptr; 3321 if (SanOpts.has(SanitizerKind::NonnullAttribute)) 3322 NNAttr = getNonNullAttr(AC.getDecl(), PVD, ArgType, ArgNo); 3323 3324 bool CanCheckNullability = false; 3325 if (SanOpts.has(SanitizerKind::NullabilityArg) && !NNAttr && PVD) { 3326 auto Nullability = PVD->getType()->getNullability(getContext()); 3327 CanCheckNullability = Nullability && 3328 *Nullability == NullabilityKind::NonNull && 3329 PVD->getTypeSourceInfo(); 3330 } 3331 3332 if (!NNAttr && !CanCheckNullability) 3333 return; 3334 3335 SourceLocation AttrLoc; 3336 SanitizerMask CheckKind; 3337 SanitizerHandler Handler; 3338 if (NNAttr) { 3339 AttrLoc = NNAttr->getLocation(); 3340 CheckKind = SanitizerKind::NonnullAttribute; 3341 Handler = SanitizerHandler::NonnullArg; 3342 } else { 3343 AttrLoc = PVD->getTypeSourceInfo()->getTypeLoc().findNullabilityLoc(); 3344 CheckKind = SanitizerKind::NullabilityArg; 3345 Handler = SanitizerHandler::NullabilityArg; 3346 } 3347 3348 SanitizerScope SanScope(this); 3349 assert(RV.isScalar()); 3350 llvm::Value *V = RV.getScalarVal(); 3351 llvm::Value *Cond = 3352 Builder.CreateICmpNE(V, llvm::Constant::getNullValue(V->getType())); 3353 llvm::Constant *StaticData[] = { 3354 EmitCheckSourceLocation(ArgLoc), EmitCheckSourceLocation(AttrLoc), 3355 llvm::ConstantInt::get(Int32Ty, ArgNo + 1), 3356 }; 3357 EmitCheck(std::make_pair(Cond, CheckKind), Handler, StaticData, None); 3358 } 3359 3360 void CodeGenFunction::EmitCallArgs( 3361 CallArgList &Args, ArrayRef<QualType> ArgTypes, 3362 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange, 3363 AbstractCallee AC, unsigned ParamsToSkip, EvaluationOrder Order) { 3364 assert((int)ArgTypes.size() == (ArgRange.end() - ArgRange.begin())); 3365 3366 // We *have* to evaluate arguments from right to left in the MS C++ ABI, 3367 // because arguments are destroyed left to right in the callee. As a special 3368 // case, there are certain language constructs that require left-to-right 3369 // evaluation, and in those cases we consider the evaluation order requirement 3370 // to trump the "destruction order is reverse construction order" guarantee. 3371 bool LeftToRight = 3372 CGM.getTarget().getCXXABI().areArgsDestroyedLeftToRightInCallee() 3373 ? Order == EvaluationOrder::ForceLeftToRight 3374 : Order != EvaluationOrder::ForceRightToLeft; 3375 3376 auto MaybeEmitImplicitObjectSize = [&](unsigned I, const Expr *Arg, 3377 RValue EmittedArg) { 3378 if (!AC.hasFunctionDecl() || I >= AC.getNumParams()) 3379 return; 3380 auto *PS = AC.getParamDecl(I)->getAttr<PassObjectSizeAttr>(); 3381 if (PS == nullptr) 3382 return; 3383 3384 const auto &Context = getContext(); 3385 auto SizeTy = Context.getSizeType(); 3386 auto T = Builder.getIntNTy(Context.getTypeSize(SizeTy)); 3387 assert(EmittedArg.getScalarVal() && "We emitted nothing for the arg?"); 3388 llvm::Value *V = evaluateOrEmitBuiltinObjectSize(Arg, PS->getType(), T, 3389 EmittedArg.getScalarVal()); 3390 Args.add(RValue::get(V), SizeTy); 3391 // If we're emitting args in reverse, be sure to do so with 3392 // pass_object_size, as well. 3393 if (!LeftToRight) 3394 std::swap(Args.back(), *(&Args.back() - 1)); 3395 }; 3396 3397 // Insert a stack save if we're going to need any inalloca args. 3398 bool HasInAllocaArgs = false; 3399 if (CGM.getTarget().getCXXABI().isMicrosoft()) { 3400 for (ArrayRef<QualType>::iterator I = ArgTypes.begin(), E = ArgTypes.end(); 3401 I != E && !HasInAllocaArgs; ++I) 3402 HasInAllocaArgs = isInAllocaArgument(CGM.getCXXABI(), *I); 3403 if (HasInAllocaArgs) { 3404 assert(getTarget().getTriple().getArch() == llvm::Triple::x86); 3405 Args.allocateArgumentMemory(*this); 3406 } 3407 } 3408 3409 // Evaluate each argument in the appropriate order. 3410 size_t CallArgsStart = Args.size(); 3411 for (unsigned I = 0, E = ArgTypes.size(); I != E; ++I) { 3412 unsigned Idx = LeftToRight ? I : E - I - 1; 3413 CallExpr::const_arg_iterator Arg = ArgRange.begin() + Idx; 3414 unsigned InitialArgSize = Args.size(); 3415 EmitCallArg(Args, *Arg, ArgTypes[Idx]); 3416 // In particular, we depend on it being the last arg in Args, and the 3417 // objectsize bits depend on there only being one arg if !LeftToRight. 3418 assert(InitialArgSize + 1 == Args.size() && 3419 "The code below depends on only adding one arg per EmitCallArg"); 3420 (void)InitialArgSize; 3421 RValue RVArg = Args.back().RV; 3422 EmitNonNullArgCheck(RVArg, ArgTypes[Idx], (*Arg)->getExprLoc(), AC, 3423 ParamsToSkip + Idx); 3424 // @llvm.objectsize should never have side-effects and shouldn't need 3425 // destruction/cleanups, so we can safely "emit" it after its arg, 3426 // regardless of right-to-leftness 3427 MaybeEmitImplicitObjectSize(Idx, *Arg, RVArg); 3428 } 3429 3430 if (!LeftToRight) { 3431 // Un-reverse the arguments we just evaluated so they match up with the LLVM 3432 // IR function. 3433 std::reverse(Args.begin() + CallArgsStart, Args.end()); 3434 } 3435 } 3436 3437 namespace { 3438 3439 struct DestroyUnpassedArg final : EHScopeStack::Cleanup { 3440 DestroyUnpassedArg(Address Addr, QualType Ty) 3441 : Addr(Addr), Ty(Ty) {} 3442 3443 Address Addr; 3444 QualType Ty; 3445 3446 void Emit(CodeGenFunction &CGF, Flags flags) override { 3447 const CXXDestructorDecl *Dtor = Ty->getAsCXXRecordDecl()->getDestructor(); 3448 assert(!Dtor->isTrivial()); 3449 CGF.EmitCXXDestructorCall(Dtor, Dtor_Complete, /*for vbase*/ false, 3450 /*Delegating=*/false, Addr); 3451 } 3452 }; 3453 3454 struct DisableDebugLocationUpdates { 3455 CodeGenFunction &CGF; 3456 bool disabledDebugInfo; 3457 DisableDebugLocationUpdates(CodeGenFunction &CGF, const Expr *E) : CGF(CGF) { 3458 if ((disabledDebugInfo = isa<CXXDefaultArgExpr>(E) && CGF.getDebugInfo())) 3459 CGF.disableDebugInfo(); 3460 } 3461 ~DisableDebugLocationUpdates() { 3462 if (disabledDebugInfo) 3463 CGF.enableDebugInfo(); 3464 } 3465 }; 3466 3467 } // end anonymous namespace 3468 3469 void CodeGenFunction::EmitCallArg(CallArgList &args, const Expr *E, 3470 QualType type) { 3471 DisableDebugLocationUpdates Dis(*this, E); 3472 if (const ObjCIndirectCopyRestoreExpr *CRE 3473 = dyn_cast<ObjCIndirectCopyRestoreExpr>(E)) { 3474 assert(getLangOpts().ObjCAutoRefCount); 3475 assert(getContext().hasSameUnqualifiedType(E->getType(), type)); 3476 return emitWritebackArg(*this, args, CRE); 3477 } 3478 3479 assert(type->isReferenceType() == E->isGLValue() && 3480 "reference binding to unmaterialized r-value!"); 3481 3482 if (E->isGLValue()) { 3483 assert(E->getObjectKind() == OK_Ordinary); 3484 return args.add(EmitReferenceBindingToExpr(E), type); 3485 } 3486 3487 bool HasAggregateEvalKind = hasAggregateEvaluationKind(type); 3488 3489 // In the Microsoft C++ ABI, aggregate arguments are destructed by the callee. 3490 // However, we still have to push an EH-only cleanup in case we unwind before 3491 // we make it to the call. 3492 if (HasAggregateEvalKind && 3493 CGM.getTarget().getCXXABI().areArgsDestroyedLeftToRightInCallee()) { 3494 // If we're using inalloca, use the argument memory. Otherwise, use a 3495 // temporary. 3496 AggValueSlot Slot; 3497 if (args.isUsingInAlloca()) 3498 Slot = createPlaceholderSlot(*this, type); 3499 else 3500 Slot = CreateAggTemp(type, "agg.tmp"); 3501 3502 const CXXRecordDecl *RD = type->getAsCXXRecordDecl(); 3503 bool DestroyedInCallee = 3504 RD && RD->hasNonTrivialDestructor() && 3505 CGM.getCXXABI().getRecordArgABI(RD) != CGCXXABI::RAA_Default; 3506 if (DestroyedInCallee) 3507 Slot.setExternallyDestructed(); 3508 3509 EmitAggExpr(E, Slot); 3510 RValue RV = Slot.asRValue(); 3511 args.add(RV, type); 3512 3513 if (DestroyedInCallee) { 3514 // Create a no-op GEP between the placeholder and the cleanup so we can 3515 // RAUW it successfully. It also serves as a marker of the first 3516 // instruction where the cleanup is active. 3517 pushFullExprCleanup<DestroyUnpassedArg>(EHCleanup, Slot.getAddress(), 3518 type); 3519 // This unreachable is a temporary marker which will be removed later. 3520 llvm::Instruction *IsActive = Builder.CreateUnreachable(); 3521 args.addArgCleanupDeactivation(EHStack.getInnermostEHScope(), IsActive); 3522 } 3523 return; 3524 } 3525 3526 if (HasAggregateEvalKind && isa<ImplicitCastExpr>(E) && 3527 cast<CastExpr>(E)->getCastKind() == CK_LValueToRValue) { 3528 LValue L = EmitLValue(cast<CastExpr>(E)->getSubExpr()); 3529 assert(L.isSimple()); 3530 if (L.getAlignment() >= getContext().getTypeAlignInChars(type)) { 3531 args.add(L.asAggregateRValue(), type, /*NeedsCopy*/true); 3532 } else { 3533 // We can't represent a misaligned lvalue in the CallArgList, so copy 3534 // to an aligned temporary now. 3535 Address tmp = CreateMemTemp(type); 3536 EmitAggregateCopy(tmp, L.getAddress(), type, L.isVolatile()); 3537 args.add(RValue::getAggregate(tmp), type); 3538 } 3539 return; 3540 } 3541 3542 args.add(EmitAnyExprToTemp(E), type); 3543 } 3544 3545 QualType CodeGenFunction::getVarArgType(const Expr *Arg) { 3546 // System headers on Windows define NULL to 0 instead of 0LL on Win64. MSVC 3547 // implicitly widens null pointer constants that are arguments to varargs 3548 // functions to pointer-sized ints. 3549 if (!getTarget().getTriple().isOSWindows()) 3550 return Arg->getType(); 3551 3552 if (Arg->getType()->isIntegerType() && 3553 getContext().getTypeSize(Arg->getType()) < 3554 getContext().getTargetInfo().getPointerWidth(0) && 3555 Arg->isNullPointerConstant(getContext(), 3556 Expr::NPC_ValueDependentIsNotNull)) { 3557 return getContext().getIntPtrType(); 3558 } 3559 3560 return Arg->getType(); 3561 } 3562 3563 // In ObjC ARC mode with no ObjC ARC exception safety, tell the ARC 3564 // optimizer it can aggressively ignore unwind edges. 3565 void 3566 CodeGenFunction::AddObjCARCExceptionMetadata(llvm::Instruction *Inst) { 3567 if (CGM.getCodeGenOpts().OptimizationLevel != 0 && 3568 !CGM.getCodeGenOpts().ObjCAutoRefCountExceptions) 3569 Inst->setMetadata("clang.arc.no_objc_arc_exceptions", 3570 CGM.getNoObjCARCExceptionsMetadata()); 3571 } 3572 3573 /// Emits a call to the given no-arguments nounwind runtime function. 3574 llvm::CallInst * 3575 CodeGenFunction::EmitNounwindRuntimeCall(llvm::Value *callee, 3576 const llvm::Twine &name) { 3577 return EmitNounwindRuntimeCall(callee, None, name); 3578 } 3579 3580 /// Emits a call to the given nounwind runtime function. 3581 llvm::CallInst * 3582 CodeGenFunction::EmitNounwindRuntimeCall(llvm::Value *callee, 3583 ArrayRef<llvm::Value*> args, 3584 const llvm::Twine &name) { 3585 llvm::CallInst *call = EmitRuntimeCall(callee, args, name); 3586 call->setDoesNotThrow(); 3587 return call; 3588 } 3589 3590 /// Emits a simple call (never an invoke) to the given no-arguments 3591 /// runtime function. 3592 llvm::CallInst * 3593 CodeGenFunction::EmitRuntimeCall(llvm::Value *callee, 3594 const llvm::Twine &name) { 3595 return EmitRuntimeCall(callee, None, name); 3596 } 3597 3598 // Calls which may throw must have operand bundles indicating which funclet 3599 // they are nested within. 3600 static void 3601 getBundlesForFunclet(llvm::Value *Callee, llvm::Instruction *CurrentFuncletPad, 3602 SmallVectorImpl<llvm::OperandBundleDef> &BundleList) { 3603 // There is no need for a funclet operand bundle if we aren't inside a 3604 // funclet. 3605 if (!CurrentFuncletPad) 3606 return; 3607 3608 // Skip intrinsics which cannot throw. 3609 auto *CalleeFn = dyn_cast<llvm::Function>(Callee->stripPointerCasts()); 3610 if (CalleeFn && CalleeFn->isIntrinsic() && CalleeFn->doesNotThrow()) 3611 return; 3612 3613 BundleList.emplace_back("funclet", CurrentFuncletPad); 3614 } 3615 3616 /// Emits a simple call (never an invoke) to the given runtime function. 3617 llvm::CallInst * 3618 CodeGenFunction::EmitRuntimeCall(llvm::Value *callee, 3619 ArrayRef<llvm::Value*> args, 3620 const llvm::Twine &name) { 3621 SmallVector<llvm::OperandBundleDef, 1> BundleList; 3622 getBundlesForFunclet(callee, CurrentFuncletPad, BundleList); 3623 3624 llvm::CallInst *call = Builder.CreateCall(callee, args, BundleList, name); 3625 call->setCallingConv(getRuntimeCC()); 3626 return call; 3627 } 3628 3629 /// Emits a call or invoke to the given noreturn runtime function. 3630 void CodeGenFunction::EmitNoreturnRuntimeCallOrInvoke(llvm::Value *callee, 3631 ArrayRef<llvm::Value*> args) { 3632 SmallVector<llvm::OperandBundleDef, 1> BundleList; 3633 getBundlesForFunclet(callee, CurrentFuncletPad, BundleList); 3634 3635 if (getInvokeDest()) { 3636 llvm::InvokeInst *invoke = 3637 Builder.CreateInvoke(callee, 3638 getUnreachableBlock(), 3639 getInvokeDest(), 3640 args, 3641 BundleList); 3642 invoke->setDoesNotReturn(); 3643 invoke->setCallingConv(getRuntimeCC()); 3644 } else { 3645 llvm::CallInst *call = Builder.CreateCall(callee, args, BundleList); 3646 call->setDoesNotReturn(); 3647 call->setCallingConv(getRuntimeCC()); 3648 Builder.CreateUnreachable(); 3649 } 3650 } 3651 3652 /// Emits a call or invoke instruction to the given nullary runtime function. 3653 llvm::CallSite 3654 CodeGenFunction::EmitRuntimeCallOrInvoke(llvm::Value *callee, 3655 const Twine &name) { 3656 return EmitRuntimeCallOrInvoke(callee, None, name); 3657 } 3658 3659 /// Emits a call or invoke instruction to the given runtime function. 3660 llvm::CallSite 3661 CodeGenFunction::EmitRuntimeCallOrInvoke(llvm::Value *callee, 3662 ArrayRef<llvm::Value*> args, 3663 const Twine &name) { 3664 llvm::CallSite callSite = EmitCallOrInvoke(callee, args, name); 3665 callSite.setCallingConv(getRuntimeCC()); 3666 return callSite; 3667 } 3668 3669 /// Emits a call or invoke instruction to the given function, depending 3670 /// on the current state of the EH stack. 3671 llvm::CallSite 3672 CodeGenFunction::EmitCallOrInvoke(llvm::Value *Callee, 3673 ArrayRef<llvm::Value *> Args, 3674 const Twine &Name) { 3675 llvm::BasicBlock *InvokeDest = getInvokeDest(); 3676 SmallVector<llvm::OperandBundleDef, 1> BundleList; 3677 getBundlesForFunclet(Callee, CurrentFuncletPad, BundleList); 3678 3679 llvm::Instruction *Inst; 3680 if (!InvokeDest) 3681 Inst = Builder.CreateCall(Callee, Args, BundleList, Name); 3682 else { 3683 llvm::BasicBlock *ContBB = createBasicBlock("invoke.cont"); 3684 Inst = Builder.CreateInvoke(Callee, ContBB, InvokeDest, Args, BundleList, 3685 Name); 3686 EmitBlock(ContBB); 3687 } 3688 3689 // In ObjC ARC mode with no ObjC ARC exception safety, tell the ARC 3690 // optimizer it can aggressively ignore unwind edges. 3691 if (CGM.getLangOpts().ObjCAutoRefCount) 3692 AddObjCARCExceptionMetadata(Inst); 3693 3694 return llvm::CallSite(Inst); 3695 } 3696 3697 /// \brief Store a non-aggregate value to an address to initialize it. For 3698 /// initialization, a non-atomic store will be used. 3699 static void EmitInitStoreOfNonAggregate(CodeGenFunction &CGF, RValue Src, 3700 LValue Dst) { 3701 if (Src.isScalar()) 3702 CGF.EmitStoreOfScalar(Src.getScalarVal(), Dst, /*init=*/true); 3703 else 3704 CGF.EmitStoreOfComplex(Src.getComplexVal(), Dst, /*init=*/true); 3705 } 3706 3707 void CodeGenFunction::deferPlaceholderReplacement(llvm::Instruction *Old, 3708 llvm::Value *New) { 3709 DeferredReplacements.push_back(std::make_pair(Old, New)); 3710 } 3711 3712 RValue CodeGenFunction::EmitCall(const CGFunctionInfo &CallInfo, 3713 const CGCallee &Callee, 3714 ReturnValueSlot ReturnValue, 3715 const CallArgList &CallArgs, 3716 llvm::Instruction **callOrInvoke) { 3717 // FIXME: We no longer need the types from CallArgs; lift up and simplify. 3718 3719 assert(Callee.isOrdinary()); 3720 3721 // Handle struct-return functions by passing a pointer to the 3722 // location that we would like to return into. 3723 QualType RetTy = CallInfo.getReturnType(); 3724 const ABIArgInfo &RetAI = CallInfo.getReturnInfo(); 3725 3726 llvm::FunctionType *IRFuncTy = Callee.getFunctionType(); 3727 3728 // 1. Set up the arguments. 3729 3730 // If we're using inalloca, insert the allocation after the stack save. 3731 // FIXME: Do this earlier rather than hacking it in here! 3732 Address ArgMemory = Address::invalid(); 3733 const llvm::StructLayout *ArgMemoryLayout = nullptr; 3734 if (llvm::StructType *ArgStruct = CallInfo.getArgStruct()) { 3735 ArgMemoryLayout = CGM.getDataLayout().getStructLayout(ArgStruct); 3736 llvm::Instruction *IP = CallArgs.getStackBase(); 3737 llvm::AllocaInst *AI; 3738 if (IP) { 3739 IP = IP->getNextNode(); 3740 AI = new llvm::AllocaInst(ArgStruct, "argmem", IP); 3741 } else { 3742 AI = CreateTempAlloca(ArgStruct, "argmem"); 3743 } 3744 auto Align = CallInfo.getArgStructAlignment(); 3745 AI->setAlignment(Align.getQuantity()); 3746 AI->setUsedWithInAlloca(true); 3747 assert(AI->isUsedWithInAlloca() && !AI->isStaticAlloca()); 3748 ArgMemory = Address(AI, Align); 3749 } 3750 3751 // Helper function to drill into the inalloca allocation. 3752 auto createInAllocaStructGEP = [&](unsigned FieldIndex) -> Address { 3753 auto FieldOffset = 3754 CharUnits::fromQuantity(ArgMemoryLayout->getElementOffset(FieldIndex)); 3755 return Builder.CreateStructGEP(ArgMemory, FieldIndex, FieldOffset); 3756 }; 3757 3758 ClangToLLVMArgMapping IRFunctionArgs(CGM.getContext(), CallInfo); 3759 SmallVector<llvm::Value *, 16> IRCallArgs(IRFunctionArgs.totalIRArgs()); 3760 3761 // If the call returns a temporary with struct return, create a temporary 3762 // alloca to hold the result, unless one is given to us. 3763 Address SRetPtr = Address::invalid(); 3764 size_t UnusedReturnSize = 0; 3765 if (RetAI.isIndirect() || RetAI.isInAlloca() || RetAI.isCoerceAndExpand()) { 3766 if (!ReturnValue.isNull()) { 3767 SRetPtr = ReturnValue.getValue(); 3768 } else { 3769 SRetPtr = CreateMemTemp(RetTy); 3770 if (HaveInsertPoint() && ReturnValue.isUnused()) { 3771 uint64_t size = 3772 CGM.getDataLayout().getTypeAllocSize(ConvertTypeForMem(RetTy)); 3773 if (EmitLifetimeStart(size, SRetPtr.getPointer())) 3774 UnusedReturnSize = size; 3775 } 3776 } 3777 if (IRFunctionArgs.hasSRetArg()) { 3778 IRCallArgs[IRFunctionArgs.getSRetArgNo()] = SRetPtr.getPointer(); 3779 } else if (RetAI.isInAlloca()) { 3780 Address Addr = createInAllocaStructGEP(RetAI.getInAllocaFieldIndex()); 3781 Builder.CreateStore(SRetPtr.getPointer(), Addr); 3782 } 3783 } 3784 3785 Address swiftErrorTemp = Address::invalid(); 3786 Address swiftErrorArg = Address::invalid(); 3787 3788 // Translate all of the arguments as necessary to match the IR lowering. 3789 assert(CallInfo.arg_size() == CallArgs.size() && 3790 "Mismatch between function signature & arguments."); 3791 unsigned ArgNo = 0; 3792 CGFunctionInfo::const_arg_iterator info_it = CallInfo.arg_begin(); 3793 for (CallArgList::const_iterator I = CallArgs.begin(), E = CallArgs.end(); 3794 I != E; ++I, ++info_it, ++ArgNo) { 3795 const ABIArgInfo &ArgInfo = info_it->info; 3796 RValue RV = I->RV; 3797 3798 // Insert a padding argument to ensure proper alignment. 3799 if (IRFunctionArgs.hasPaddingArg(ArgNo)) 3800 IRCallArgs[IRFunctionArgs.getPaddingArgNo(ArgNo)] = 3801 llvm::UndefValue::get(ArgInfo.getPaddingType()); 3802 3803 unsigned FirstIRArg, NumIRArgs; 3804 std::tie(FirstIRArg, NumIRArgs) = IRFunctionArgs.getIRArgs(ArgNo); 3805 3806 switch (ArgInfo.getKind()) { 3807 case ABIArgInfo::InAlloca: { 3808 assert(NumIRArgs == 0); 3809 assert(getTarget().getTriple().getArch() == llvm::Triple::x86); 3810 if (RV.isAggregate()) { 3811 // Replace the placeholder with the appropriate argument slot GEP. 3812 llvm::Instruction *Placeholder = 3813 cast<llvm::Instruction>(RV.getAggregatePointer()); 3814 CGBuilderTy::InsertPoint IP = Builder.saveIP(); 3815 Builder.SetInsertPoint(Placeholder); 3816 Address Addr = createInAllocaStructGEP(ArgInfo.getInAllocaFieldIndex()); 3817 Builder.restoreIP(IP); 3818 deferPlaceholderReplacement(Placeholder, Addr.getPointer()); 3819 } else { 3820 // Store the RValue into the argument struct. 3821 Address Addr = createInAllocaStructGEP(ArgInfo.getInAllocaFieldIndex()); 3822 unsigned AS = Addr.getType()->getPointerAddressSpace(); 3823 llvm::Type *MemType = ConvertTypeForMem(I->Ty)->getPointerTo(AS); 3824 // There are some cases where a trivial bitcast is not avoidable. The 3825 // definition of a type later in a translation unit may change it's type 3826 // from {}* to (%struct.foo*)*. 3827 if (Addr.getType() != MemType) 3828 Addr = Builder.CreateBitCast(Addr, MemType); 3829 LValue argLV = MakeAddrLValue(Addr, I->Ty); 3830 EmitInitStoreOfNonAggregate(*this, RV, argLV); 3831 } 3832 break; 3833 } 3834 3835 case ABIArgInfo::Indirect: { 3836 assert(NumIRArgs == 1); 3837 if (RV.isScalar() || RV.isComplex()) { 3838 // Make a temporary alloca to pass the argument. 3839 Address Addr = CreateMemTemp(I->Ty, ArgInfo.getIndirectAlign()); 3840 IRCallArgs[FirstIRArg] = Addr.getPointer(); 3841 3842 LValue argLV = MakeAddrLValue(Addr, I->Ty); 3843 EmitInitStoreOfNonAggregate(*this, RV, argLV); 3844 } else { 3845 // We want to avoid creating an unnecessary temporary+copy here; 3846 // however, we need one in three cases: 3847 // 1. If the argument is not byval, and we are required to copy the 3848 // source. (This case doesn't occur on any common architecture.) 3849 // 2. If the argument is byval, RV is not sufficiently aligned, and 3850 // we cannot force it to be sufficiently aligned. 3851 // 3. If the argument is byval, but RV is located in an address space 3852 // different than that of the argument (0). 3853 Address Addr = RV.getAggregateAddress(); 3854 CharUnits Align = ArgInfo.getIndirectAlign(); 3855 const llvm::DataLayout *TD = &CGM.getDataLayout(); 3856 const unsigned RVAddrSpace = Addr.getType()->getAddressSpace(); 3857 const unsigned ArgAddrSpace = 3858 (FirstIRArg < IRFuncTy->getNumParams() 3859 ? IRFuncTy->getParamType(FirstIRArg)->getPointerAddressSpace() 3860 : 0); 3861 if ((!ArgInfo.getIndirectByVal() && I->NeedsCopy) || 3862 (ArgInfo.getIndirectByVal() && Addr.getAlignment() < Align && 3863 llvm::getOrEnforceKnownAlignment(Addr.getPointer(), 3864 Align.getQuantity(), *TD) 3865 < Align.getQuantity()) || 3866 (ArgInfo.getIndirectByVal() && (RVAddrSpace != ArgAddrSpace))) { 3867 // Create an aligned temporary, and copy to it. 3868 Address AI = CreateMemTemp(I->Ty, ArgInfo.getIndirectAlign()); 3869 IRCallArgs[FirstIRArg] = AI.getPointer(); 3870 EmitAggregateCopy(AI, Addr, I->Ty, RV.isVolatileQualified()); 3871 } else { 3872 // Skip the extra memcpy call. 3873 IRCallArgs[FirstIRArg] = Addr.getPointer(); 3874 } 3875 } 3876 break; 3877 } 3878 3879 case ABIArgInfo::Ignore: 3880 assert(NumIRArgs == 0); 3881 break; 3882 3883 case ABIArgInfo::Extend: 3884 case ABIArgInfo::Direct: { 3885 if (!isa<llvm::StructType>(ArgInfo.getCoerceToType()) && 3886 ArgInfo.getCoerceToType() == ConvertType(info_it->type) && 3887 ArgInfo.getDirectOffset() == 0) { 3888 assert(NumIRArgs == 1); 3889 llvm::Value *V; 3890 if (RV.isScalar()) 3891 V = RV.getScalarVal(); 3892 else 3893 V = Builder.CreateLoad(RV.getAggregateAddress()); 3894 3895 // Implement swifterror by copying into a new swifterror argument. 3896 // We'll write back in the normal path out of the call. 3897 if (CallInfo.getExtParameterInfo(ArgNo).getABI() 3898 == ParameterABI::SwiftErrorResult) { 3899 assert(!swiftErrorTemp.isValid() && "multiple swifterror args"); 3900 3901 QualType pointeeTy = I->Ty->getPointeeType(); 3902 swiftErrorArg = 3903 Address(V, getContext().getTypeAlignInChars(pointeeTy)); 3904 3905 swiftErrorTemp = 3906 CreateMemTemp(pointeeTy, getPointerAlign(), "swifterror.temp"); 3907 V = swiftErrorTemp.getPointer(); 3908 cast<llvm::AllocaInst>(V)->setSwiftError(true); 3909 3910 llvm::Value *errorValue = Builder.CreateLoad(swiftErrorArg); 3911 Builder.CreateStore(errorValue, swiftErrorTemp); 3912 } 3913 3914 // We might have to widen integers, but we should never truncate. 3915 if (ArgInfo.getCoerceToType() != V->getType() && 3916 V->getType()->isIntegerTy()) 3917 V = Builder.CreateZExt(V, ArgInfo.getCoerceToType()); 3918 3919 // If the argument doesn't match, perform a bitcast to coerce it. This 3920 // can happen due to trivial type mismatches. 3921 if (FirstIRArg < IRFuncTy->getNumParams() && 3922 V->getType() != IRFuncTy->getParamType(FirstIRArg)) 3923 V = Builder.CreateBitCast(V, IRFuncTy->getParamType(FirstIRArg)); 3924 3925 IRCallArgs[FirstIRArg] = V; 3926 break; 3927 } 3928 3929 // FIXME: Avoid the conversion through memory if possible. 3930 Address Src = Address::invalid(); 3931 if (RV.isScalar() || RV.isComplex()) { 3932 Src = CreateMemTemp(I->Ty, "coerce"); 3933 LValue SrcLV = MakeAddrLValue(Src, I->Ty); 3934 EmitInitStoreOfNonAggregate(*this, RV, SrcLV); 3935 } else { 3936 Src = RV.getAggregateAddress(); 3937 } 3938 3939 // If the value is offset in memory, apply the offset now. 3940 Src = emitAddressAtOffset(*this, Src, ArgInfo); 3941 3942 // Fast-isel and the optimizer generally like scalar values better than 3943 // FCAs, so we flatten them if this is safe to do for this argument. 3944 llvm::StructType *STy = 3945 dyn_cast<llvm::StructType>(ArgInfo.getCoerceToType()); 3946 if (STy && ArgInfo.isDirect() && ArgInfo.getCanBeFlattened()) { 3947 llvm::Type *SrcTy = Src.getType()->getElementType(); 3948 uint64_t SrcSize = CGM.getDataLayout().getTypeAllocSize(SrcTy); 3949 uint64_t DstSize = CGM.getDataLayout().getTypeAllocSize(STy); 3950 3951 // If the source type is smaller than the destination type of the 3952 // coerce-to logic, copy the source value into a temp alloca the size 3953 // of the destination type to allow loading all of it. The bits past 3954 // the source value are left undef. 3955 if (SrcSize < DstSize) { 3956 Address TempAlloca 3957 = CreateTempAlloca(STy, Src.getAlignment(), 3958 Src.getName() + ".coerce"); 3959 Builder.CreateMemCpy(TempAlloca, Src, SrcSize); 3960 Src = TempAlloca; 3961 } else { 3962 Src = Builder.CreateBitCast(Src, llvm::PointerType::getUnqual(STy)); 3963 } 3964 3965 auto SrcLayout = CGM.getDataLayout().getStructLayout(STy); 3966 assert(NumIRArgs == STy->getNumElements()); 3967 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) { 3968 auto Offset = CharUnits::fromQuantity(SrcLayout->getElementOffset(i)); 3969 Address EltPtr = Builder.CreateStructGEP(Src, i, Offset); 3970 llvm::Value *LI = Builder.CreateLoad(EltPtr); 3971 IRCallArgs[FirstIRArg + i] = LI; 3972 } 3973 } else { 3974 // In the simple case, just pass the coerced loaded value. 3975 assert(NumIRArgs == 1); 3976 IRCallArgs[FirstIRArg] = 3977 CreateCoercedLoad(Src, ArgInfo.getCoerceToType(), *this); 3978 } 3979 3980 break; 3981 } 3982 3983 case ABIArgInfo::CoerceAndExpand: { 3984 auto coercionType = ArgInfo.getCoerceAndExpandType(); 3985 auto layout = CGM.getDataLayout().getStructLayout(coercionType); 3986 3987 llvm::Value *tempSize = nullptr; 3988 Address addr = Address::invalid(); 3989 if (RV.isAggregate()) { 3990 addr = RV.getAggregateAddress(); 3991 } else { 3992 assert(RV.isScalar()); // complex should always just be direct 3993 3994 llvm::Type *scalarType = RV.getScalarVal()->getType(); 3995 auto scalarSize = CGM.getDataLayout().getTypeAllocSize(scalarType); 3996 auto scalarAlign = CGM.getDataLayout().getPrefTypeAlignment(scalarType); 3997 3998 tempSize = llvm::ConstantInt::get(CGM.Int64Ty, scalarSize); 3999 4000 // Materialize to a temporary. 4001 addr = CreateTempAlloca(RV.getScalarVal()->getType(), 4002 CharUnits::fromQuantity(std::max(layout->getAlignment(), 4003 scalarAlign))); 4004 EmitLifetimeStart(scalarSize, addr.getPointer()); 4005 4006 Builder.CreateStore(RV.getScalarVal(), addr); 4007 } 4008 4009 addr = Builder.CreateElementBitCast(addr, coercionType); 4010 4011 unsigned IRArgPos = FirstIRArg; 4012 for (unsigned i = 0, e = coercionType->getNumElements(); i != e; ++i) { 4013 llvm::Type *eltType = coercionType->getElementType(i); 4014 if (ABIArgInfo::isPaddingForCoerceAndExpand(eltType)) continue; 4015 Address eltAddr = Builder.CreateStructGEP(addr, i, layout); 4016 llvm::Value *elt = Builder.CreateLoad(eltAddr); 4017 IRCallArgs[IRArgPos++] = elt; 4018 } 4019 assert(IRArgPos == FirstIRArg + NumIRArgs); 4020 4021 if (tempSize) { 4022 EmitLifetimeEnd(tempSize, addr.getPointer()); 4023 } 4024 4025 break; 4026 } 4027 4028 case ABIArgInfo::Expand: 4029 unsigned IRArgPos = FirstIRArg; 4030 ExpandTypeToArgs(I->Ty, RV, IRFuncTy, IRCallArgs, IRArgPos); 4031 assert(IRArgPos == FirstIRArg + NumIRArgs); 4032 break; 4033 } 4034 } 4035 4036 llvm::Value *CalleePtr = Callee.getFunctionPointer(); 4037 4038 // If we're using inalloca, set up that argument. 4039 if (ArgMemory.isValid()) { 4040 llvm::Value *Arg = ArgMemory.getPointer(); 4041 if (CallInfo.isVariadic()) { 4042 // When passing non-POD arguments by value to variadic functions, we will 4043 // end up with a variadic prototype and an inalloca call site. In such 4044 // cases, we can't do any parameter mismatch checks. Give up and bitcast 4045 // the callee. 4046 unsigned CalleeAS = CalleePtr->getType()->getPointerAddressSpace(); 4047 auto FnTy = getTypes().GetFunctionType(CallInfo)->getPointerTo(CalleeAS); 4048 CalleePtr = Builder.CreateBitCast(CalleePtr, FnTy); 4049 } else { 4050 llvm::Type *LastParamTy = 4051 IRFuncTy->getParamType(IRFuncTy->getNumParams() - 1); 4052 if (Arg->getType() != LastParamTy) { 4053 #ifndef NDEBUG 4054 // Assert that these structs have equivalent element types. 4055 llvm::StructType *FullTy = CallInfo.getArgStruct(); 4056 llvm::StructType *DeclaredTy = cast<llvm::StructType>( 4057 cast<llvm::PointerType>(LastParamTy)->getElementType()); 4058 assert(DeclaredTy->getNumElements() == FullTy->getNumElements()); 4059 for (llvm::StructType::element_iterator DI = DeclaredTy->element_begin(), 4060 DE = DeclaredTy->element_end(), 4061 FI = FullTy->element_begin(); 4062 DI != DE; ++DI, ++FI) 4063 assert(*DI == *FI); 4064 #endif 4065 Arg = Builder.CreateBitCast(Arg, LastParamTy); 4066 } 4067 } 4068 assert(IRFunctionArgs.hasInallocaArg()); 4069 IRCallArgs[IRFunctionArgs.getInallocaArgNo()] = Arg; 4070 } 4071 4072 // 2. Prepare the function pointer. 4073 4074 // If the callee is a bitcast of a non-variadic function to have a 4075 // variadic function pointer type, check to see if we can remove the 4076 // bitcast. This comes up with unprototyped functions. 4077 // 4078 // This makes the IR nicer, but more importantly it ensures that we 4079 // can inline the function at -O0 if it is marked always_inline. 4080 auto simplifyVariadicCallee = [](llvm::Value *Ptr) -> llvm::Value* { 4081 llvm::FunctionType *CalleeFT = 4082 cast<llvm::FunctionType>(Ptr->getType()->getPointerElementType()); 4083 if (!CalleeFT->isVarArg()) 4084 return Ptr; 4085 4086 llvm::ConstantExpr *CE = dyn_cast<llvm::ConstantExpr>(Ptr); 4087 if (!CE || CE->getOpcode() != llvm::Instruction::BitCast) 4088 return Ptr; 4089 4090 llvm::Function *OrigFn = dyn_cast<llvm::Function>(CE->getOperand(0)); 4091 if (!OrigFn) 4092 return Ptr; 4093 4094 llvm::FunctionType *OrigFT = OrigFn->getFunctionType(); 4095 4096 // If the original type is variadic, or if any of the component types 4097 // disagree, we cannot remove the cast. 4098 if (OrigFT->isVarArg() || 4099 OrigFT->getNumParams() != CalleeFT->getNumParams() || 4100 OrigFT->getReturnType() != CalleeFT->getReturnType()) 4101 return Ptr; 4102 4103 for (unsigned i = 0, e = OrigFT->getNumParams(); i != e; ++i) 4104 if (OrigFT->getParamType(i) != CalleeFT->getParamType(i)) 4105 return Ptr; 4106 4107 return OrigFn; 4108 }; 4109 CalleePtr = simplifyVariadicCallee(CalleePtr); 4110 4111 // 3. Perform the actual call. 4112 4113 // Deactivate any cleanups that we're supposed to do immediately before 4114 // the call. 4115 if (!CallArgs.getCleanupsToDeactivate().empty()) 4116 deactivateArgCleanupsBeforeCall(*this, CallArgs); 4117 4118 // Assert that the arguments we computed match up. The IR verifier 4119 // will catch this, but this is a common enough source of problems 4120 // during IRGen changes that it's way better for debugging to catch 4121 // it ourselves here. 4122 #ifndef NDEBUG 4123 assert(IRCallArgs.size() == IRFuncTy->getNumParams() || IRFuncTy->isVarArg()); 4124 for (unsigned i = 0; i < IRCallArgs.size(); ++i) { 4125 // Inalloca argument can have different type. 4126 if (IRFunctionArgs.hasInallocaArg() && 4127 i == IRFunctionArgs.getInallocaArgNo()) 4128 continue; 4129 if (i < IRFuncTy->getNumParams()) 4130 assert(IRCallArgs[i]->getType() == IRFuncTy->getParamType(i)); 4131 } 4132 #endif 4133 4134 // Compute the calling convention and attributes. 4135 unsigned CallingConv; 4136 CodeGen::AttributeListType AttributeList; 4137 CGM.ConstructAttributeList(CalleePtr->getName(), CallInfo, 4138 Callee.getAbstractInfo(), 4139 AttributeList, CallingConv, 4140 /*AttrOnCallSite=*/true); 4141 llvm::AttributeList Attrs = 4142 llvm::AttributeList::get(getLLVMContext(), AttributeList); 4143 4144 // Apply some call-site-specific attributes. 4145 // TODO: work this into building the attribute set. 4146 4147 // Apply always_inline to all calls within flatten functions. 4148 // FIXME: should this really take priority over __try, below? 4149 if (CurCodeDecl && CurCodeDecl->hasAttr<FlattenAttr>() && 4150 !(Callee.getAbstractInfo().getCalleeDecl() && 4151 Callee.getAbstractInfo().getCalleeDecl()->hasAttr<NoInlineAttr>())) { 4152 Attrs = 4153 Attrs.addAttribute(getLLVMContext(), llvm::AttributeList::FunctionIndex, 4154 llvm::Attribute::AlwaysInline); 4155 } 4156 4157 // Disable inlining inside SEH __try blocks. 4158 if (isSEHTryScope()) { 4159 Attrs = 4160 Attrs.addAttribute(getLLVMContext(), llvm::AttributeList::FunctionIndex, 4161 llvm::Attribute::NoInline); 4162 } 4163 4164 // Decide whether to use a call or an invoke. 4165 bool CannotThrow; 4166 if (currentFunctionUsesSEHTry()) { 4167 // SEH cares about asynchronous exceptions, so everything can "throw." 4168 CannotThrow = false; 4169 } else if (isCleanupPadScope() && 4170 EHPersonality::get(*this).isMSVCXXPersonality()) { 4171 // The MSVC++ personality will implicitly terminate the program if an 4172 // exception is thrown during a cleanup outside of a try/catch. 4173 // We don't need to model anything in IR to get this behavior. 4174 CannotThrow = true; 4175 } else { 4176 // Otherwise, nounwind call sites will never throw. 4177 CannotThrow = Attrs.hasAttribute(llvm::AttributeList::FunctionIndex, 4178 llvm::Attribute::NoUnwind); 4179 } 4180 llvm::BasicBlock *InvokeDest = CannotThrow ? nullptr : getInvokeDest(); 4181 4182 SmallVector<llvm::OperandBundleDef, 1> BundleList; 4183 getBundlesForFunclet(CalleePtr, CurrentFuncletPad, BundleList); 4184 4185 // Emit the actual call/invoke instruction. 4186 llvm::CallSite CS; 4187 if (!InvokeDest) { 4188 CS = Builder.CreateCall(CalleePtr, IRCallArgs, BundleList); 4189 } else { 4190 llvm::BasicBlock *Cont = createBasicBlock("invoke.cont"); 4191 CS = Builder.CreateInvoke(CalleePtr, Cont, InvokeDest, IRCallArgs, 4192 BundleList); 4193 EmitBlock(Cont); 4194 } 4195 llvm::Instruction *CI = CS.getInstruction(); 4196 if (callOrInvoke) 4197 *callOrInvoke = CI; 4198 4199 // Apply the attributes and calling convention. 4200 CS.setAttributes(Attrs); 4201 CS.setCallingConv(static_cast<llvm::CallingConv::ID>(CallingConv)); 4202 4203 // Apply various metadata. 4204 4205 if (!CI->getType()->isVoidTy()) 4206 CI->setName("call"); 4207 4208 // Insert instrumentation or attach profile metadata at indirect call sites. 4209 // For more details, see the comment before the definition of 4210 // IPVK_IndirectCallTarget in InstrProfData.inc. 4211 if (!CS.getCalledFunction()) 4212 PGO.valueProfile(Builder, llvm::IPVK_IndirectCallTarget, 4213 CI, CalleePtr); 4214 4215 // In ObjC ARC mode with no ObjC ARC exception safety, tell the ARC 4216 // optimizer it can aggressively ignore unwind edges. 4217 if (CGM.getLangOpts().ObjCAutoRefCount) 4218 AddObjCARCExceptionMetadata(CI); 4219 4220 // Suppress tail calls if requested. 4221 if (llvm::CallInst *Call = dyn_cast<llvm::CallInst>(CI)) { 4222 const Decl *TargetDecl = Callee.getAbstractInfo().getCalleeDecl(); 4223 if (TargetDecl && TargetDecl->hasAttr<NotTailCalledAttr>()) 4224 Call->setTailCallKind(llvm::CallInst::TCK_NoTail); 4225 } 4226 4227 // 4. Finish the call. 4228 4229 // If the call doesn't return, finish the basic block and clear the 4230 // insertion point; this allows the rest of IRGen to discard 4231 // unreachable code. 4232 if (CS.doesNotReturn()) { 4233 if (UnusedReturnSize) 4234 EmitLifetimeEnd(llvm::ConstantInt::get(Int64Ty, UnusedReturnSize), 4235 SRetPtr.getPointer()); 4236 4237 Builder.CreateUnreachable(); 4238 Builder.ClearInsertionPoint(); 4239 4240 // FIXME: For now, emit a dummy basic block because expr emitters in 4241 // generally are not ready to handle emitting expressions at unreachable 4242 // points. 4243 EnsureInsertPoint(); 4244 4245 // Return a reasonable RValue. 4246 return GetUndefRValue(RetTy); 4247 } 4248 4249 // Perform the swifterror writeback. 4250 if (swiftErrorTemp.isValid()) { 4251 llvm::Value *errorResult = Builder.CreateLoad(swiftErrorTemp); 4252 Builder.CreateStore(errorResult, swiftErrorArg); 4253 } 4254 4255 // Emit any call-associated writebacks immediately. Arguably this 4256 // should happen after any return-value munging. 4257 if (CallArgs.hasWritebacks()) 4258 emitWritebacks(*this, CallArgs); 4259 4260 // The stack cleanup for inalloca arguments has to run out of the normal 4261 // lexical order, so deactivate it and run it manually here. 4262 CallArgs.freeArgumentMemory(*this); 4263 4264 // Extract the return value. 4265 RValue Ret = [&] { 4266 switch (RetAI.getKind()) { 4267 case ABIArgInfo::CoerceAndExpand: { 4268 auto coercionType = RetAI.getCoerceAndExpandType(); 4269 auto layout = CGM.getDataLayout().getStructLayout(coercionType); 4270 4271 Address addr = SRetPtr; 4272 addr = Builder.CreateElementBitCast(addr, coercionType); 4273 4274 assert(CI->getType() == RetAI.getUnpaddedCoerceAndExpandType()); 4275 bool requiresExtract = isa<llvm::StructType>(CI->getType()); 4276 4277 unsigned unpaddedIndex = 0; 4278 for (unsigned i = 0, e = coercionType->getNumElements(); i != e; ++i) { 4279 llvm::Type *eltType = coercionType->getElementType(i); 4280 if (ABIArgInfo::isPaddingForCoerceAndExpand(eltType)) continue; 4281 Address eltAddr = Builder.CreateStructGEP(addr, i, layout); 4282 llvm::Value *elt = CI; 4283 if (requiresExtract) 4284 elt = Builder.CreateExtractValue(elt, unpaddedIndex++); 4285 else 4286 assert(unpaddedIndex == 0); 4287 Builder.CreateStore(elt, eltAddr); 4288 } 4289 // FALLTHROUGH 4290 } 4291 4292 case ABIArgInfo::InAlloca: 4293 case ABIArgInfo::Indirect: { 4294 RValue ret = convertTempToRValue(SRetPtr, RetTy, SourceLocation()); 4295 if (UnusedReturnSize) 4296 EmitLifetimeEnd(llvm::ConstantInt::get(Int64Ty, UnusedReturnSize), 4297 SRetPtr.getPointer()); 4298 return ret; 4299 } 4300 4301 case ABIArgInfo::Ignore: 4302 // If we are ignoring an argument that had a result, make sure to 4303 // construct the appropriate return value for our caller. 4304 return GetUndefRValue(RetTy); 4305 4306 case ABIArgInfo::Extend: 4307 case ABIArgInfo::Direct: { 4308 llvm::Type *RetIRTy = ConvertType(RetTy); 4309 if (RetAI.getCoerceToType() == RetIRTy && RetAI.getDirectOffset() == 0) { 4310 switch (getEvaluationKind(RetTy)) { 4311 case TEK_Complex: { 4312 llvm::Value *Real = Builder.CreateExtractValue(CI, 0); 4313 llvm::Value *Imag = Builder.CreateExtractValue(CI, 1); 4314 return RValue::getComplex(std::make_pair(Real, Imag)); 4315 } 4316 case TEK_Aggregate: { 4317 Address DestPtr = ReturnValue.getValue(); 4318 bool DestIsVolatile = ReturnValue.isVolatile(); 4319 4320 if (!DestPtr.isValid()) { 4321 DestPtr = CreateMemTemp(RetTy, "agg.tmp"); 4322 DestIsVolatile = false; 4323 } 4324 BuildAggStore(*this, CI, DestPtr, DestIsVolatile); 4325 return RValue::getAggregate(DestPtr); 4326 } 4327 case TEK_Scalar: { 4328 // If the argument doesn't match, perform a bitcast to coerce it. This 4329 // can happen due to trivial type mismatches. 4330 llvm::Value *V = CI; 4331 if (V->getType() != RetIRTy) 4332 V = Builder.CreateBitCast(V, RetIRTy); 4333 return RValue::get(V); 4334 } 4335 } 4336 llvm_unreachable("bad evaluation kind"); 4337 } 4338 4339 Address DestPtr = ReturnValue.getValue(); 4340 bool DestIsVolatile = ReturnValue.isVolatile(); 4341 4342 if (!DestPtr.isValid()) { 4343 DestPtr = CreateMemTemp(RetTy, "coerce"); 4344 DestIsVolatile = false; 4345 } 4346 4347 // If the value is offset in memory, apply the offset now. 4348 Address StorePtr = emitAddressAtOffset(*this, DestPtr, RetAI); 4349 CreateCoercedStore(CI, StorePtr, DestIsVolatile, *this); 4350 4351 return convertTempToRValue(DestPtr, RetTy, SourceLocation()); 4352 } 4353 4354 case ABIArgInfo::Expand: 4355 llvm_unreachable("Invalid ABI kind for return argument"); 4356 } 4357 4358 llvm_unreachable("Unhandled ABIArgInfo::Kind"); 4359 } (); 4360 4361 // Emit the assume_aligned check on the return value. 4362 const Decl *TargetDecl = Callee.getAbstractInfo().getCalleeDecl(); 4363 if (Ret.isScalar() && TargetDecl) { 4364 if (const auto *AA = TargetDecl->getAttr<AssumeAlignedAttr>()) { 4365 llvm::Value *OffsetValue = nullptr; 4366 if (const auto *Offset = AA->getOffset()) 4367 OffsetValue = EmitScalarExpr(Offset); 4368 4369 llvm::Value *Alignment = EmitScalarExpr(AA->getAlignment()); 4370 llvm::ConstantInt *AlignmentCI = cast<llvm::ConstantInt>(Alignment); 4371 EmitAlignmentAssumption(Ret.getScalarVal(), AlignmentCI->getZExtValue(), 4372 OffsetValue); 4373 } 4374 } 4375 4376 return Ret; 4377 } 4378 4379 /* VarArg handling */ 4380 4381 Address CodeGenFunction::EmitVAArg(VAArgExpr *VE, Address &VAListAddr) { 4382 VAListAddr = VE->isMicrosoftABI() 4383 ? EmitMSVAListRef(VE->getSubExpr()) 4384 : EmitVAListRef(VE->getSubExpr()); 4385 QualType Ty = VE->getType(); 4386 if (VE->isMicrosoftABI()) 4387 return CGM.getTypes().getABIInfo().EmitMSVAArg(*this, VAListAddr, Ty); 4388 return CGM.getTypes().getABIInfo().EmitVAArg(*this, VAListAddr, Ty); 4389 } 4390