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