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