blob: c582b9a32d072e828defa421ae2b12ea37e32973 [file] [log] [blame]
Nick Lewycky5fa40c32013-10-01 21:51:38 +00001//===--- CGCall.cpp - Encapsulate calling convention details --------------===//
Daniel Dunbar3d7c90b2008-09-08 21:33:45 +00002//
Chandler Carruth2946cd72019-01-19 08:50:56 +00003// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
Daniel Dunbar3d7c90b2008-09-08 21:33:45 +00006//
7//===----------------------------------------------------------------------===//
8//
9// These classes wrap the information about a call or function
10// definition used to handle ABI compliancy.
11//
12//===----------------------------------------------------------------------===//
13
14#include "CGCall.h"
Chris Lattnere70a0072010-06-29 16:40:28 +000015#include "ABIInfo.h"
Akira Hatanaka9d8ac612016-02-17 21:09:50 +000016#include "CGBlocks.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000017#include "CGCXXABI.h"
David Majnemer4e52d6f2015-12-12 05:39:21 +000018#include "CGCleanup.h"
Daniel Dunbar3d7c90b2008-09-08 21:33:45 +000019#include "CodeGenFunction.h"
Daniel Dunbarc68897d2008-09-10 00:41:16 +000020#include "CodeGenModule.h"
John McCalla729c622012-02-17 03:33:10 +000021#include "TargetInfo.h"
Reid Kleckner98031782019-12-09 16:11:56 -080022#include "clang/AST/Attr.h"
Daniel Dunbar3d7c90b2008-09-08 21:33:45 +000023#include "clang/AST/Decl.h"
Anders Carlssonb15b55c2009-04-03 22:48:58 +000024#include "clang/AST/DeclCXX.h"
Daniel Dunbar3d7c90b2008-09-08 21:33:45 +000025#include "clang/AST/DeclObjC.h"
Richard Trieu63688182018-12-11 03:18:39 +000026#include "clang/Basic/CodeGenOptions.h"
Eric Christopher15709992015-10-15 23:47:11 +000027#include "clang/Basic/TargetBuiltins.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000028#include "clang/Basic/TargetInfo.h"
Mark Laceya8e7df32013-10-30 21:53:58 +000029#include "clang/CodeGen/CGFunctionInfo.h"
John McCall12f23522016-04-04 18:33:08 +000030#include "clang/CodeGen/SwiftCallingConv.h"
Bill Wendling706469b2013-02-28 22:49:57 +000031#include "llvm/ADT/StringExtras.h"
Nick Lewyckyd9bce502016-09-20 15:49:58 +000032#include "llvm/Analysis/ValueTracking.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000033#include "llvm/IR/Attributes.h"
David Blaikief47ca252018-03-21 22:34:27 +000034#include "llvm/IR/CallingConv.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000035#include "llvm/IR/DataLayout.h"
36#include "llvm/IR/InlineAsm.h"
Saleem Abdulrasool10a49722016-04-08 16:52:00 +000037#include "llvm/IR/IntrinsicInst.h"
David Blaikief47ca252018-03-21 22:34:27 +000038#include "llvm/IR/Intrinsics.h"
Reid Kleckner98031782019-12-09 16:11:56 -080039#include "llvm/Transforms/Utils/Local.h"
Daniel Dunbar3d7c90b2008-09-08 21:33:45 +000040using namespace clang;
41using namespace CodeGen;
42
43/***/
44
Nikolay Haustov8c6538b2016-06-30 09:06:33 +000045unsigned CodeGenTypes::ClangCallConvToLLVMCallConv(CallingConv CC) {
John McCallab26cfa2010-02-05 21:31:56 +000046 switch (CC) {
47 default: return llvm::CallingConv::C;
48 case CC_X86StdCall: return llvm::CallingConv::X86_StdCall;
49 case CC_X86FastCall: return llvm::CallingConv::X86_FastCall;
Erich Keane757d3172016-11-02 18:29:35 +000050 case CC_X86RegCall: return llvm::CallingConv::X86_RegCall;
Douglas Gregora941dca2010-05-18 16:57:00 +000051 case CC_X86ThisCall: return llvm::CallingConv::X86_ThisCall;
Martin Storsjo022e7822017-07-17 20:49:45 +000052 case CC_Win64: return llvm::CallingConv::Win64;
Charles Davisb5a214e2013-08-30 04:39:01 +000053 case CC_X86_64SysV: return llvm::CallingConv::X86_64_SysV;
Anton Korobeynikov231e8752011-04-14 20:06:49 +000054 case CC_AAPCS: return llvm::CallingConv::ARM_AAPCS;
55 case CC_AAPCS_VFP: return llvm::CallingConv::ARM_AAPCS_VFP;
Guy Benyeif0a014b2012-12-25 08:53:55 +000056 case CC_IntelOclBicc: return llvm::CallingConv::Intel_OCL_BI;
Reid Klecknerd7857f02014-10-24 17:42:17 +000057 // TODO: Add support for __pascal to LLVM.
58 case CC_X86Pascal: return llvm::CallingConv::C;
59 // TODO: Add support for __vectorcall to LLVM.
Reid Kleckner80944df2014-10-31 22:00:51 +000060 case CC_X86VectorCall: return llvm::CallingConv::X86_VectorCall;
Sander de Smalen44a22532018-11-26 16:38:37 +000061 case CC_AArch64VectorCall: return llvm::CallingConv::AArch64_VectorCall;
Alexander Kornienko21de0ae2015-01-20 11:20:41 +000062 case CC_SpirFunction: return llvm::CallingConv::SPIR_FUNC;
Nikolay Haustov8c6538b2016-06-30 09:06:33 +000063 case CC_OpenCLKernel: return CGM.getTargetCodeGenInfo().getOpenCLKernelCallingConv();
Roman Levenstein35aa5ce2016-03-16 18:00:46 +000064 case CC_PreserveMost: return llvm::CallingConv::PreserveMost;
65 case CC_PreserveAll: return llvm::CallingConv::PreserveAll;
John McCall12f23522016-04-04 18:33:08 +000066 case CC_Swift: return llvm::CallingConv::Swift;
John McCallab26cfa2010-02-05 21:31:56 +000067 }
68}
69
Mikael Nilsson9d2872d2018-12-13 10:15:27 +000070/// Derives the 'this' type for codegen purposes, i.e. ignoring method CVR
James Y Knightb92d2902019-02-05 16:05:50 +000071/// qualification. Either or both of RD and MD may be null. A null RD indicates
72/// that there is no meaningful 'this' type, and a null MD can occur when
73/// calling a method pointer.
74CanQualType CodeGenTypes::DeriveThisType(const CXXRecordDecl *RD,
75 const CXXMethodDecl *MD) {
76 QualType RecTy;
77 if (RD)
78 RecTy = Context.getTagDeclType(RD)->getCanonicalTypeInternal();
79 else
80 RecTy = Context.VoidTy;
81
Mikael Nilsson9d2872d2018-12-13 10:15:27 +000082 if (MD)
Anastasia Stulovac61eaa52019-01-28 11:37:49 +000083 RecTy = Context.getAddrSpaceQualType(RecTy, MD->getMethodQualifiers().getAddressSpace());
John McCall2da83a32010-02-26 00:48:12 +000084 return Context.getPointerType(CanQualType::CreateUnsafe(RecTy));
Daniel Dunbar7a95ca32008-09-10 04:01:49 +000085}
86
John McCall8ee376f2010-02-24 07:14:12 +000087/// Returns the canonical formal type of the given C++ method.
John McCall2da83a32010-02-26 00:48:12 +000088static CanQual<FunctionProtoType> GetFormalType(const CXXMethodDecl *MD) {
89 return MD->getType()->getCanonicalTypeUnqualified()
90 .getAs<FunctionProtoType>();
John McCall8ee376f2010-02-24 07:14:12 +000091}
92
93/// Returns the "extra-canonicalized" return type, which discards
94/// qualifiers on the return type. Codegen doesn't care about them,
95/// and it makes ABI code a little easier to be able to assume that
96/// all parameter and return types are top-level unqualified.
John McCall2da83a32010-02-26 00:48:12 +000097static CanQualType GetReturnType(QualType RetTy) {
98 return RetTy->getCanonicalTypeUnqualified().getUnqualifiedType();
John McCall8ee376f2010-02-24 07:14:12 +000099}
100
John McCall8dda7b22012-07-07 06:41:13 +0000101/// Arrange the argument and result information for a value of the given
102/// unprototyped freestanding function type.
John McCall8ee376f2010-02-24 07:14:12 +0000103const CGFunctionInfo &
John McCall8dda7b22012-07-07 06:41:13 +0000104CodeGenTypes::arrangeFreeFunctionType(CanQual<FunctionNoProtoType> FTNP) {
John McCalla729c622012-02-17 03:33:10 +0000105 // When translating an unprototyped function type, always use a
106 // variadic type.
Alp Toker314cc812014-01-25 16:55:45 +0000107 return arrangeLLVMFunctionInfo(FTNP->getReturnType().getUnqualifiedType(),
Peter Collingbournef7706832014-12-12 23:41:25 +0000108 /*instanceMethod=*/false,
109 /*chainCall=*/false, None,
John McCallc56a8b32016-03-11 04:30:31 +0000110 FTNP->getExtInfo(), {}, RequiredArgs(0));
John McCall8ee376f2010-02-24 07:14:12 +0000111}
112
George Burgess IVb7760212017-02-24 02:49:47 +0000113static void addExtParameterInfosForCall(
114 llvm::SmallVectorImpl<FunctionProtoType::ExtParameterInfo> &paramInfos,
115 const FunctionProtoType *proto,
116 unsigned prefixArgs,
117 unsigned totalArgs) {
118 assert(proto->hasExtParameterInfos());
119 assert(paramInfos.size() <= prefixArgs);
120 assert(proto->getNumParams() + prefixArgs <= totalArgs);
121
122 paramInfos.reserve(totalArgs);
123
124 // Add default infos for any prefix args that don't already have infos.
125 paramInfos.resize(prefixArgs);
126
127 // Add infos for the prototype.
128 for (const auto &ParamInfo : proto->getExtParameterInfos()) {
129 paramInfos.push_back(ParamInfo);
130 // pass_object_size params have no parameter info.
131 if (ParamInfo.hasPassObjectSize())
132 paramInfos.emplace_back();
133 }
134
135 assert(paramInfos.size() <= totalArgs &&
136 "Did we forget to insert pass_object_size args?");
137 // Add default infos for the variadic and/or suffix arguments.
138 paramInfos.resize(totalArgs);
139}
140
Hiroshi Inouec5e54dd2017-07-03 08:49:44 +0000141/// Adds the formal parameters in FPT to the given prefix. If any parameter in
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000142/// FPT has pass_object_size attrs, then we'll add parameters for those, too.
143static void appendParameterTypes(const CodeGenTypes &CGT,
144 SmallVectorImpl<CanQualType> &prefix,
John McCallc56a8b32016-03-11 04:30:31 +0000145 SmallVectorImpl<FunctionProtoType::ExtParameterInfo> &paramInfos,
George Burgess IVb7760212017-02-24 02:49:47 +0000146 CanQual<FunctionProtoType> FPT) {
147 // Fast path: don't touch param info if we don't need to.
148 if (!FPT->hasExtParameterInfos()) {
149 assert(paramInfos.empty() &&
150 "We have paramInfos, but the prototype doesn't?");
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000151 prefix.append(FPT->param_type_begin(), FPT->param_type_end());
152 return;
153 }
154
George Burgess IVb7760212017-02-24 02:49:47 +0000155 unsigned PrefixSize = prefix.size();
156 // In the vast majority of cases, we'll have precisely FPT->getNumParams()
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000157 // parameters; the only thing that can change this is the presence of
158 // pass_object_size. So, we preallocate for the common case.
159 prefix.reserve(prefix.size() + FPT->getNumParams());
160
George Burgess IVb7760212017-02-24 02:49:47 +0000161 auto ExtInfos = FPT->getExtParameterInfos();
162 assert(ExtInfos.size() == FPT->getNumParams());
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000163 for (unsigned I = 0, E = FPT->getNumParams(); I != E; ++I) {
164 prefix.push_back(FPT->getParamType(I));
George Burgess IVb7760212017-02-24 02:49:47 +0000165 if (ExtInfos[I].hasPassObjectSize())
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000166 prefix.push_back(CGT.getContext().getSizeType());
167 }
George Burgess IVb7760212017-02-24 02:49:47 +0000168
169 addExtParameterInfosForCall(paramInfos, FPT.getTypePtr(), PrefixSize,
170 prefix.size());
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000171}
172
John McCall8dda7b22012-07-07 06:41:13 +0000173/// Arrange the LLVM function layout for a value of the given function
Alexey Samsonove5ef3ca2014-08-13 23:55:54 +0000174/// type, on top of any implicit parameters already stored.
175static const CGFunctionInfo &
Peter Collingbournef7706832014-12-12 23:41:25 +0000176arrangeLLVMFunctionInfo(CodeGenTypes &CGT, bool instanceMethod,
Alexey Samsonove5ef3ca2014-08-13 23:55:54 +0000177 SmallVectorImpl<CanQualType> &prefix,
James Y Knight916db652019-02-02 01:48:23 +0000178 CanQual<FunctionProtoType> FTP) {
John McCallc56a8b32016-03-11 04:30:31 +0000179 SmallVector<FunctionProtoType::ExtParameterInfo, 16> paramInfos;
James Y Knight916db652019-02-02 01:48:23 +0000180 RequiredArgs Required = RequiredArgs::forPrototypePlus(FTP, prefix.size());
Daniel Dunbarbf8c24a2009-02-02 23:23:47 +0000181 // FIXME: Kill copy.
George Burgess IVb7760212017-02-24 02:49:47 +0000182 appendParameterTypes(CGT, prefix, paramInfos, FTP);
Alp Toker314cc812014-01-25 16:55:45 +0000183 CanQualType resultType = FTP->getReturnType().getUnqualifiedType();
John McCallc56a8b32016-03-11 04:30:31 +0000184
Peter Collingbournef7706832014-12-12 23:41:25 +0000185 return CGT.arrangeLLVMFunctionInfo(resultType, instanceMethod,
186 /*chainCall=*/false, prefix,
John McCallc56a8b32016-03-11 04:30:31 +0000187 FTP->getExtInfo(), paramInfos,
George Burgess IV419996c2016-06-16 23:06:04 +0000188 Required);
John McCall8ee376f2010-02-24 07:14:12 +0000189}
190
John McCalla729c622012-02-17 03:33:10 +0000191/// Arrange the argument and result information for a value of the
John McCall8dda7b22012-07-07 06:41:13 +0000192/// given freestanding function type.
John McCall8ee376f2010-02-24 07:14:12 +0000193const CGFunctionInfo &
James Y Knight916db652019-02-02 01:48:23 +0000194CodeGenTypes::arrangeFreeFunctionType(CanQual<FunctionProtoType> FTP) {
John McCalla729c622012-02-17 03:33:10 +0000195 SmallVector<CanQualType, 16> argTypes;
Peter Collingbournef7706832014-12-12 23:41:25 +0000196 return ::arrangeLLVMFunctionInfo(*this, /*instanceMethod=*/false, argTypes,
James Y Knight916db652019-02-02 01:48:23 +0000197 FTP);
Daniel Dunbar7feafc72009-09-11 22:24:53 +0000198}
199
Aaron Ballman0362a6d2013-12-18 16:23:37 +0000200static CallingConv getCallingConventionForDecl(const Decl *D, bool IsWindows) {
Daniel Dunbar7feafc72009-09-11 22:24:53 +0000201 // Set the appropriate calling convention for the Function.
202 if (D->hasAttr<StdCallAttr>())
John McCallab26cfa2010-02-05 21:31:56 +0000203 return CC_X86StdCall;
Daniel Dunbar7feafc72009-09-11 22:24:53 +0000204
205 if (D->hasAttr<FastCallAttr>())
John McCallab26cfa2010-02-05 21:31:56 +0000206 return CC_X86FastCall;
Daniel Dunbar7feafc72009-09-11 22:24:53 +0000207
Erich Keane757d3172016-11-02 18:29:35 +0000208 if (D->hasAttr<RegCallAttr>())
209 return CC_X86RegCall;
210
Douglas Gregora941dca2010-05-18 16:57:00 +0000211 if (D->hasAttr<ThisCallAttr>())
212 return CC_X86ThisCall;
213
Reid Klecknerd7857f02014-10-24 17:42:17 +0000214 if (D->hasAttr<VectorCallAttr>())
215 return CC_X86VectorCall;
216
Dawn Perchik335e16b2010-09-03 01:29:35 +0000217 if (D->hasAttr<PascalAttr>())
218 return CC_X86Pascal;
219
Anton Korobeynikov231e8752011-04-14 20:06:49 +0000220 if (PcsAttr *PCS = D->getAttr<PcsAttr>())
221 return (PCS->getPCS() == PcsAttr::AAPCS ? CC_AAPCS : CC_AAPCS_VFP);
222
Sander de Smalen44a22532018-11-26 16:38:37 +0000223 if (D->hasAttr<AArch64VectorPcsAttr>())
224 return CC_AArch64VectorCall;
225
Guy Benyeif0a014b2012-12-25 08:53:55 +0000226 if (D->hasAttr<IntelOclBiccAttr>())
227 return CC_IntelOclBicc;
228
Aaron Ballman0362a6d2013-12-18 16:23:37 +0000229 if (D->hasAttr<MSABIAttr>())
Martin Storsjo022e7822017-07-17 20:49:45 +0000230 return IsWindows ? CC_C : CC_Win64;
Aaron Ballman0362a6d2013-12-18 16:23:37 +0000231
232 if (D->hasAttr<SysVABIAttr>())
233 return IsWindows ? CC_X86_64SysV : CC_C;
234
Roman Levenstein35aa5ce2016-03-16 18:00:46 +0000235 if (D->hasAttr<PreserveMostAttr>())
236 return CC_PreserveMost;
237
238 if (D->hasAttr<PreserveAllAttr>())
239 return CC_PreserveAll;
240
John McCallab26cfa2010-02-05 21:31:56 +0000241 return CC_C;
Daniel Dunbar7a95ca32008-09-10 04:01:49 +0000242}
243
John McCalla729c622012-02-17 03:33:10 +0000244/// Arrange the argument and result information for a call to an
245/// unknown C++ non-static member function of the given abstract type.
James Y Knightb92d2902019-02-05 16:05:50 +0000246/// (A null RD means we don't have any meaningful "this" argument type,
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000247/// so fall back to a generic pointer type).
John McCalla729c622012-02-17 03:33:10 +0000248/// The member function must be an ordinary function, i.e. not a
249/// constructor or destructor.
250const CGFunctionInfo &
251CodeGenTypes::arrangeCXXMethodType(const CXXRecordDecl *RD,
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000252 const FunctionProtoType *FTP,
253 const CXXMethodDecl *MD) {
John McCalla729c622012-02-17 03:33:10 +0000254 SmallVector<CanQualType, 16> argTypes;
John McCall8ee376f2010-02-24 07:14:12 +0000255
Anders Carlsson2ee3c012009-10-03 19:43:08 +0000256 // Add the 'this' pointer.
James Y Knightb92d2902019-02-05 16:05:50 +0000257 argTypes.push_back(DeriveThisType(RD, MD));
John McCall8ee376f2010-02-24 07:14:12 +0000258
Alexey Samsonove5ef3ca2014-08-13 23:55:54 +0000259 return ::arrangeLLVMFunctionInfo(
260 *this, true, argTypes,
James Y Knight916db652019-02-02 01:48:23 +0000261 FTP->getCanonicalTypeUnqualified().getAs<FunctionProtoType>());
Anders Carlsson2ee3c012009-10-03 19:43:08 +0000262}
263
Yaxun Liu6c10a662018-06-12 00:16:33 +0000264/// Set calling convention for CUDA/HIP kernel.
265static void setCUDAKernelCallingConvention(CanQualType &FTy, CodeGenModule &CGM,
266 const FunctionDecl *FD) {
267 if (FD->hasAttr<CUDAGlobalAttr>()) {
268 const FunctionType *FT = FTy->getAs<FunctionType>();
269 CGM.getTargetCodeGenInfo().setCUDAKernelCallingConvention(FT);
270 FTy = FT->getCanonicalTypeUnqualified();
271 }
272}
273
John McCalla729c622012-02-17 03:33:10 +0000274/// Arrange the argument and result information for a declaration or
275/// definition of the given C++ non-static member function. The
276/// member function must be an ordinary function, i.e. not a
277/// constructor or destructor.
278const CGFunctionInfo &
279CodeGenTypes::arrangeCXXMethodDeclaration(const CXXMethodDecl *MD) {
Benjamin Kramer60509af2013-09-09 14:48:42 +0000280 assert(!isa<CXXConstructorDecl>(MD) && "wrong method for constructors!");
John McCall0d635f52010-09-03 01:26:39 +0000281 assert(!isa<CXXDestructorDecl>(MD) && "wrong method for destructors!");
282
Yaxun Liu6c10a662018-06-12 00:16:33 +0000283 CanQualType FT = GetFormalType(MD).getAs<Type>();
284 setCUDAKernelCallingConvention(FT, CGM, MD);
285 auto prototype = FT.getAs<FunctionProtoType>();
Mike Stump11289f42009-09-09 15:08:12 +0000286
John McCalla729c622012-02-17 03:33:10 +0000287 if (MD->isInstance()) {
288 // The abstract case is perfectly fine.
Mark Lacey5ea993b2013-10-02 20:35:23 +0000289 const CXXRecordDecl *ThisType = TheCXXABI.getThisArgumentTypeForMethod(MD);
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000290 return arrangeCXXMethodType(ThisType, prototype.getTypePtr(), MD);
John McCalla729c622012-02-17 03:33:10 +0000291 }
292
James Y Knight916db652019-02-02 01:48:23 +0000293 return arrangeFreeFunctionType(prototype);
Anders Carlssonb15b55c2009-04-03 22:48:58 +0000294}
295
Richard Smith5179eb72016-06-28 19:03:57 +0000296bool CodeGenTypes::inheritingCtorHasParams(
297 const InheritedConstructor &Inherited, CXXCtorType Type) {
298 // Parameters are unnecessary if we're constructing a base class subobject
299 // and the inherited constructor lives in a virtual base.
300 return Type == Ctor_Complete ||
301 !Inherited.getShadowDecl()->constructsVirtualBase() ||
302 !Target.getCXXABI().hasConstructorVariants();
Peter Collingbourned1c5b282019-03-22 23:05:10 +0000303}
Richard Smith5179eb72016-06-28 19:03:57 +0000304
John McCalla729c622012-02-17 03:33:10 +0000305const CGFunctionInfo &
Peter Collingbourned1c5b282019-03-22 23:05:10 +0000306CodeGenTypes::arrangeCXXStructorDeclaration(GlobalDecl GD) {
307 auto *MD = cast<CXXMethodDecl>(GD.getDecl());
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000308
John McCalla729c622012-02-17 03:33:10 +0000309 SmallVector<CanQualType, 16> argTypes;
John McCallc56a8b32016-03-11 04:30:31 +0000310 SmallVector<FunctionProtoType::ExtParameterInfo, 16> paramInfos;
James Y Knightb92d2902019-02-05 16:05:50 +0000311 argTypes.push_back(DeriveThisType(MD->getParent(), MD));
Stephen Lin9dc6eef2013-06-30 20:40:16 +0000312
Richard Smith5179eb72016-06-28 19:03:57 +0000313 bool PassParams = true;
314
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000315 if (auto *CD = dyn_cast<CXXConstructorDecl>(MD)) {
Richard Smith5179eb72016-06-28 19:03:57 +0000316 // A base class inheriting constructor doesn't get forwarded arguments
317 // needed to construct a virtual base (or base class thereof).
318 if (auto Inherited = CD->getInheritedConstructor())
Peter Collingbourned1c5b282019-03-22 23:05:10 +0000319 PassParams = inheritingCtorHasParams(Inherited, GD.getCtorType());
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000320 }
Anders Carlsson82ba57c2009-11-25 03:15:49 +0000321
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000322 CanQual<FunctionProtoType> FTP = GetFormalType(MD);
John McCall5d865c322010-08-31 07:33:07 +0000323
324 // Add the formal parameters.
Richard Smith5179eb72016-06-28 19:03:57 +0000325 if (PassParams)
George Burgess IVb7760212017-02-24 02:49:47 +0000326 appendParameterTypes(*this, argTypes, paramInfos, FTP);
John McCall5d865c322010-08-31 07:33:07 +0000327
George Burgess IV75b34a92017-02-22 22:38:25 +0000328 CGCXXABI::AddedStructorArgs AddedArgs =
Peter Collingbourned1c5b282019-03-22 23:05:10 +0000329 TheCXXABI.buildStructorSignature(GD, argTypes);
George Burgess IV75b34a92017-02-22 22:38:25 +0000330 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 }
Reid Kleckner89077a12013-12-17 19:46:40 +0000339
340 RequiredArgs required =
Richard Smith5179eb72016-06-28 19:03:57 +0000341 (PassParams && MD->isVariadic() ? RequiredArgs(argTypes.size())
342 : RequiredArgs::All);
Reid Kleckner89077a12013-12-17 19:46:40 +0000343
John McCall8dda7b22012-07-07 06:41:13 +0000344 FunctionType::ExtInfo extInfo = FTP->getExtInfo();
David Majnemer0c0b6d92014-10-31 20:09:12 +0000345 CanQualType resultType = TheCXXABI.HasThisReturn(GD)
346 ? argTypes.front()
347 : TheCXXABI.hasMostDerivedReturn(GD)
348 ? CGM.getContext().VoidPtrTy
349 : Context.VoidTy;
Peter Collingbournef7706832014-12-12 23:41:25 +0000350 return arrangeLLVMFunctionInfo(resultType, /*instanceMethod=*/true,
351 /*chainCall=*/false, argTypes, extInfo,
John McCallc56a8b32016-03-11 04:30:31 +0000352 paramInfos, required);
353}
354
355static SmallVector<CanQualType, 16>
356getArgTypesForCall(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
363static SmallVector<CanQualType, 16>
364getArgTypesForDeclaration(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
John McCallc56a8b32016-03-11 04:30:31 +0000371static llvm::SmallVector<FunctionProtoType::ExtParameterInfo, 16>
372getExtParameterInfosForCall(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;
Anders Carlsson82ba57c2009-11-25 03:15:49 +0000379}
380
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000381/// Arrange a call to a C++ method, passing the given arguments.
George Burgess IVd0a9e802017-02-23 22:07:35 +0000382///
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.
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000389const CGFunctionInfo &
390CodeGenTypes::arrangeCXXConstructorCall(const CallArgList &args,
391 const CXXConstructorDecl *D,
392 CXXCtorType CtorKind,
George Burgess IVd0a9e802017-02-23 22:07:35 +0000393 unsigned ExtraPrefixArgs,
394 unsigned ExtraSuffixArgs,
395 bool PassProtoArgs) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000396 // FIXME: Kill copy.
397 SmallVector<CanQualType, 16> ArgTypes;
Alexey Samsonov3551e312014-08-13 20:06:24 +0000398 for (const auto &Arg : args)
399 ArgTypes.push_back(Context.getCanonicalParamType(Arg.Ty));
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000400
George Burgess IVd0a9e802017-02-23 22:07:35 +0000401 // +1 for implicit this, which should always be args[0].
402 unsigned TotalPrefixArgs = 1 + ExtraPrefixArgs;
403
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000404 CanQual<FunctionProtoType> FPT = GetFormalType(D);
James Y Knightb92d2902019-02-05 16:05:50 +0000405 RequiredArgs Required = PassProtoArgs
406 ? RequiredArgs::forPrototypePlus(
407 FPT, TotalPrefixArgs + ExtraSuffixArgs)
408 : RequiredArgs::All;
409
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000410 GlobalDecl GD(D, CtorKind);
David Majnemer0c0b6d92014-10-31 20:09:12 +0000411 CanQualType ResultType = TheCXXABI.HasThisReturn(GD)
412 ? ArgTypes.front()
413 : TheCXXABI.hasMostDerivedReturn(GD)
414 ? CGM.getContext().VoidPtrTy
415 : Context.VoidTy;
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000416
417 FunctionType::ExtInfo Info = FPT->getExtInfo();
George Burgess IVd0a9e802017-02-23 22:07:35 +0000418 llvm::SmallVector<FunctionProtoType::ExtParameterInfo, 16> ParamInfos;
419 // If the prototype args are elided, we should only have ABI-specific args,
420 // which never have param info.
421 if (PassProtoArgs && FPT->hasExtParameterInfos()) {
422 // ABI-specific suffix arguments are treated the same as variadic arguments.
423 addExtParameterInfosForCall(ParamInfos, FPT.getTypePtr(), TotalPrefixArgs,
424 ArgTypes.size());
425 }
Peter Collingbournef7706832014-12-12 23:41:25 +0000426 return arrangeLLVMFunctionInfo(ResultType, /*instanceMethod=*/true,
427 /*chainCall=*/false, ArgTypes, Info,
John McCallc56a8b32016-03-11 04:30:31 +0000428 ParamInfos, Required);
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000429}
430
John McCalla729c622012-02-17 03:33:10 +0000431/// Arrange the argument and result information for the declaration or
432/// definition of the given function.
433const CGFunctionInfo &
434CodeGenTypes::arrangeFunctionDeclaration(const FunctionDecl *FD) {
Chris Lattnerbea5b622009-05-12 20:27:19 +0000435 if (const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(FD))
Anders Carlssonb15b55c2009-04-03 22:48:58 +0000436 if (MD->isInstance())
John McCalla729c622012-02-17 03:33:10 +0000437 return arrangeCXXMethodDeclaration(MD);
Mike Stump11289f42009-09-09 15:08:12 +0000438
John McCall2da83a32010-02-26 00:48:12 +0000439 CanQualType FTy = FD->getType()->getCanonicalTypeUnqualified();
John McCalla729c622012-02-17 03:33:10 +0000440
John McCall2da83a32010-02-26 00:48:12 +0000441 assert(isa<FunctionType>(FTy));
Yaxun Liu6c10a662018-06-12 00:16:33 +0000442 setCUDAKernelCallingConvention(FTy, CGM, FD);
John McCalla729c622012-02-17 03:33:10 +0000443
444 // When declaring a function without a prototype, always use a
445 // non-variadic type.
George Burgess IV35cfca22017-01-06 19:10:48 +0000446 if (CanQual<FunctionNoProtoType> noProto = FTy.getAs<FunctionNoProtoType>()) {
Peter Collingbournef7706832014-12-12 23:41:25 +0000447 return arrangeLLVMFunctionInfo(
448 noProto->getReturnType(), /*instanceMethod=*/false,
John McCallc56a8b32016-03-11 04:30:31 +0000449 /*chainCall=*/false, None, noProto->getExtInfo(), {},RequiredArgs::All);
John McCalla729c622012-02-17 03:33:10 +0000450 }
451
James Y Knight916db652019-02-02 01:48:23 +0000452 return arrangeFreeFunctionType(FTy.castAs<FunctionProtoType>());
Daniel Dunbar3d7c90b2008-09-08 21:33:45 +0000453}
454
John McCalla729c622012-02-17 03:33:10 +0000455/// Arrange the argument and result information for the declaration or
456/// definition of an Objective-C method.
457const CGFunctionInfo &
458CodeGenTypes::arrangeObjCMethodDeclaration(const ObjCMethodDecl *MD) {
459 // It happens that this is the same as a call with no optional
460 // arguments, except also using the formal 'self' type.
461 return arrangeObjCMessageSendSignature(MD, MD->getSelfDecl()->getType());
462}
463
464/// Arrange the argument and result information for the function type
465/// through which to perform a send to the given Objective-C method,
466/// using the given receiver type. The receiver type is not always
467/// the 'self' type of the method or even an Objective-C pointer type.
468/// This is *not* the right method for actually performing such a
469/// message send, due to the possibility of optional arguments.
470const CGFunctionInfo &
471CodeGenTypes::arrangeObjCMessageSendSignature(const ObjCMethodDecl *MD,
472 QualType receiverType) {
473 SmallVector<CanQualType, 16> argTys;
Akira Hatanaka98a49332017-09-22 00:41:05 +0000474 SmallVector<FunctionProtoType::ExtParameterInfo, 4> extParamInfos(2);
John McCalla729c622012-02-17 03:33:10 +0000475 argTys.push_back(Context.getCanonicalParamType(receiverType));
476 argTys.push_back(Context.getCanonicalParamType(Context.getObjCSelType()));
Daniel Dunbarbf8c24a2009-02-02 23:23:47 +0000477 // FIXME: Kill copy?
David Majnemer59f77922016-06-24 04:05:48 +0000478 for (const auto *I : MD->parameters()) {
Aaron Ballman43b68be2014-03-07 17:50:17 +0000479 argTys.push_back(Context.getCanonicalParamType(I->getType()));
Akira Hatanaka98a49332017-09-22 00:41:05 +0000480 auto extParamInfo = FunctionProtoType::ExtParameterInfo().withIsNoEscape(
481 I->hasAttr<NoEscapeAttr>());
482 extParamInfos.push_back(extParamInfo);
John McCall8ee376f2010-02-24 07:14:12 +0000483 }
John McCall31168b02011-06-15 23:02:42 +0000484
485 FunctionType::ExtInfo einfo;
Aaron Ballman0362a6d2013-12-18 16:23:37 +0000486 bool IsWindows = getContext().getTargetInfo().getTriple().isOSWindows();
487 einfo = einfo.withCallingConv(getCallingConventionForDecl(MD, IsWindows));
John McCall31168b02011-06-15 23:02:42 +0000488
David Blaikiebbafb8a2012-03-11 07:00:24 +0000489 if (getContext().getLangOpts().ObjCAutoRefCount &&
John McCall31168b02011-06-15 23:02:42 +0000490 MD->hasAttr<NSReturnsRetainedAttr>())
491 einfo = einfo.withProducesResult(true);
492
John McCalla729c622012-02-17 03:33:10 +0000493 RequiredArgs required =
494 (MD->isVariadic() ? RequiredArgs(argTys.size()) : RequiredArgs::All);
495
Peter Collingbournef7706832014-12-12 23:41:25 +0000496 return arrangeLLVMFunctionInfo(
497 GetReturnType(MD->getReturnType()), /*instanceMethod=*/false,
Akira Hatanaka98a49332017-09-22 00:41:05 +0000498 /*chainCall=*/false, argTys, einfo, extParamInfos, required);
John McCallc56a8b32016-03-11 04:30:31 +0000499}
500
501const CGFunctionInfo &
502CodeGenTypes::arrangeUnprototypedObjCMessageSend(QualType returnType,
503 const CallArgList &args) {
504 auto argTypes = getArgTypesForCall(Context, args);
505 FunctionType::ExtInfo einfo;
506
507 return arrangeLLVMFunctionInfo(
508 GetReturnType(returnType), /*instanceMethod=*/false,
509 /*chainCall=*/false, argTypes, einfo, {}, RequiredArgs::All);
Daniel Dunbar3d7c90b2008-09-08 21:33:45 +0000510}
511
John McCalla729c622012-02-17 03:33:10 +0000512const CGFunctionInfo &
513CodeGenTypes::arrangeGlobalDeclaration(GlobalDecl GD) {
Anders Carlsson6710c532010-02-06 02:44:09 +0000514 // FIXME: Do we need to handle ObjCMethodDecl?
515 const FunctionDecl *FD = cast<FunctionDecl>(GD.getDecl());
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000516
Peter Collingbourned1c5b282019-03-22 23:05:10 +0000517 if (isa<CXXConstructorDecl>(GD.getDecl()) ||
518 isa<CXXDestructorDecl>(GD.getDecl()))
519 return arrangeCXXStructorDeclaration(GD);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000520
John McCalla729c622012-02-17 03:33:10 +0000521 return arrangeFunctionDeclaration(FD);
Anders Carlsson6710c532010-02-06 02:44:09 +0000522}
523
Reid Klecknerc3473512014-08-29 21:43:29 +0000524/// Arrange a thunk that takes 'this' as the first parameter followed by
525/// varargs. Return a void pointer, regardless of the actual return type.
526/// The body of the thunk will end in a musttail call to a function of the
527/// correct type, and the caller will bitcast the function to the correct
528/// prototype.
529const CGFunctionInfo &
Reid Kleckner399d96e2018-04-02 20:20:33 +0000530CodeGenTypes::arrangeUnprototypedMustTailThunk(const CXXMethodDecl *MD) {
531 assert(MD->isVirtual() && "only methods have thunks");
Reid Klecknerc3473512014-08-29 21:43:29 +0000532 CanQual<FunctionProtoType> FTP = GetFormalType(MD);
James Y Knightb92d2902019-02-05 16:05:50 +0000533 CanQualType ArgTys[] = {DeriveThisType(MD->getParent(), MD)};
Peter Collingbournef7706832014-12-12 23:41:25 +0000534 return arrangeLLVMFunctionInfo(Context.VoidTy, /*instanceMethod=*/false,
535 /*chainCall=*/false, ArgTys,
John McCallc56a8b32016-03-11 04:30:31 +0000536 FTP->getExtInfo(), {}, RequiredArgs(1));
Reid Klecknerc3473512014-08-29 21:43:29 +0000537}
538
David Majnemerdfa6d202015-03-11 18:36:39 +0000539const CGFunctionInfo &
David Majnemer37fd66e2015-03-13 22:36:55 +0000540CodeGenTypes::arrangeMSCtorClosure(const CXXConstructorDecl *CD,
541 CXXCtorType CT) {
542 assert(CT == Ctor_CopyingClosure || CT == Ctor_DefaultClosure);
543
David Majnemerdfa6d202015-03-11 18:36:39 +0000544 CanQual<FunctionProtoType> FTP = GetFormalType(CD);
545 SmallVector<CanQualType, 2> ArgTys;
546 const CXXRecordDecl *RD = CD->getParent();
James Y Knightb92d2902019-02-05 16:05:50 +0000547 ArgTys.push_back(DeriveThisType(RD, CD));
David Majnemer37fd66e2015-03-13 22:36:55 +0000548 if (CT == Ctor_CopyingClosure)
549 ArgTys.push_back(*FTP->param_type_begin());
David Majnemerdfa6d202015-03-11 18:36:39 +0000550 if (RD->getNumVBases() > 0)
551 ArgTys.push_back(Context.IntTy);
552 CallingConv CC = Context.getDefaultCallingConvention(
553 /*IsVariadic=*/false, /*IsCXXMethod=*/true);
554 return arrangeLLVMFunctionInfo(Context.VoidTy, /*instanceMethod=*/true,
555 /*chainCall=*/false, ArgTys,
John McCallc56a8b32016-03-11 04:30:31 +0000556 FunctionType::ExtInfo(CC), {},
557 RequiredArgs::All);
David Majnemerdfa6d202015-03-11 18:36:39 +0000558}
559
John McCallc818bbb2012-12-07 07:03:17 +0000560/// Arrange a call as unto a free function, except possibly with an
561/// additional number of formal parameters considered required.
562static const CGFunctionInfo &
563arrangeFreeFunctionLikeCall(CodeGenTypes &CGT,
Mark Lacey23455752013-10-10 20:57:00 +0000564 CodeGenModule &CGM,
John McCallc818bbb2012-12-07 07:03:17 +0000565 const CallArgList &args,
566 const FunctionType *fnType,
Peter Collingbournef7706832014-12-12 23:41:25 +0000567 unsigned numExtraRequiredArgs,
568 bool chainCall) {
John McCallc818bbb2012-12-07 07:03:17 +0000569 assert(args.size() >= numExtraRequiredArgs);
570
John McCallc56a8b32016-03-11 04:30:31 +0000571 llvm::SmallVector<FunctionProtoType::ExtParameterInfo, 16> paramInfos;
572
John McCallc818bbb2012-12-07 07:03:17 +0000573 // In most cases, there are no optional arguments.
574 RequiredArgs required = RequiredArgs::All;
575
576 // If we have a variadic prototype, the required arguments are the
577 // extra prefix plus the arguments in the prototype.
578 if (const FunctionProtoType *proto = dyn_cast<FunctionProtoType>(fnType)) {
579 if (proto->isVariadic())
James Y Knightb92d2902019-02-05 16:05:50 +0000580 required = RequiredArgs::forPrototypePlus(proto, numExtraRequiredArgs);
John McCallc818bbb2012-12-07 07:03:17 +0000581
John McCallc56a8b32016-03-11 04:30:31 +0000582 if (proto->hasExtParameterInfos())
583 addExtParameterInfosForCall(paramInfos, proto, numExtraRequiredArgs,
584 args.size());
585
John McCallc818bbb2012-12-07 07:03:17 +0000586 // If we don't have a prototype at all, but we're supposed to
587 // explicitly use the variadic convention for unprototyped calls,
588 // treat all of the arguments as required but preserve the nominal
589 // possibility of variadics.
Mark Lacey23455752013-10-10 20:57:00 +0000590 } else if (CGM.getTargetCodeGenInfo()
591 .isNoProtoCallVariadic(args,
592 cast<FunctionNoProtoType>(fnType))) {
John McCallc818bbb2012-12-07 07:03:17 +0000593 required = RequiredArgs(args.size());
594 }
595
Peter Collingbournef7706832014-12-12 23:41:25 +0000596 // FIXME: Kill copy.
597 SmallVector<CanQualType, 16> argTypes;
598 for (const auto &arg : args)
599 argTypes.push_back(CGT.getContext().getCanonicalParamType(arg.Ty));
600 return CGT.arrangeLLVMFunctionInfo(GetReturnType(fnType->getReturnType()),
601 /*instanceMethod=*/false, chainCall,
John McCallc56a8b32016-03-11 04:30:31 +0000602 argTypes, fnType->getExtInfo(), paramInfos,
603 required);
John McCallc818bbb2012-12-07 07:03:17 +0000604}
605
John McCalla729c622012-02-17 03:33:10 +0000606/// Figure out the rules for calling a function with the given formal
607/// type using the given arguments. The arguments are necessary
608/// because the function might be unprototyped, in which case it's
609/// target-dependent in crazy ways.
610const CGFunctionInfo &
John McCall8dda7b22012-07-07 06:41:13 +0000611CodeGenTypes::arrangeFreeFunctionCall(const CallArgList &args,
Peter Collingbournef7706832014-12-12 23:41:25 +0000612 const FunctionType *fnType,
613 bool chainCall) {
614 return arrangeFreeFunctionLikeCall(*this, CGM, args, fnType,
615 chainCall ? 1 : 0, chainCall);
John McCallc818bbb2012-12-07 07:03:17 +0000616}
John McCalla729c622012-02-17 03:33:10 +0000617
John McCallc56a8b32016-03-11 04:30:31 +0000618/// A block function is essentially a free function with an
John McCallc818bbb2012-12-07 07:03:17 +0000619/// extra implicit argument.
620const CGFunctionInfo &
621CodeGenTypes::arrangeBlockFunctionCall(const CallArgList &args,
622 const FunctionType *fnType) {
Peter Collingbournef7706832014-12-12 23:41:25 +0000623 return arrangeFreeFunctionLikeCall(*this, CGM, args, fnType, 1,
624 /*chainCall=*/false);
John McCalla729c622012-02-17 03:33:10 +0000625}
626
627const CGFunctionInfo &
John McCallc56a8b32016-03-11 04:30:31 +0000628CodeGenTypes::arrangeBlockFunctionDeclaration(const FunctionProtoType *proto,
629 const FunctionArgList &params) {
630 auto paramInfos = getExtParameterInfosForCall(proto, 1, params.size());
631 auto argTypes = getArgTypesForDeclaration(Context, params);
632
James Y Knight916db652019-02-02 01:48:23 +0000633 return arrangeLLVMFunctionInfo(GetReturnType(proto->getReturnType()),
634 /*instanceMethod*/ false, /*chainCall*/ false,
635 argTypes, proto->getExtInfo(), paramInfos,
636 RequiredArgs::forPrototypePlus(proto, 1));
John McCallc56a8b32016-03-11 04:30:31 +0000637}
638
639const CGFunctionInfo &
640CodeGenTypes::arrangeBuiltinFunctionCall(QualType resultType,
641 const CallArgList &args) {
Daniel Dunbarbf8c24a2009-02-02 23:23:47 +0000642 // FIXME: Kill copy.
John McCalla729c622012-02-17 03:33:10 +0000643 SmallVector<CanQualType, 16> argTypes;
Alexey Samsonov3551e312014-08-13 20:06:24 +0000644 for (const auto &Arg : args)
645 argTypes.push_back(Context.getCanonicalParamType(Arg.Ty));
Peter Collingbournef7706832014-12-12 23:41:25 +0000646 return arrangeLLVMFunctionInfo(
647 GetReturnType(resultType), /*instanceMethod=*/false,
John McCallc56a8b32016-03-11 04:30:31 +0000648 /*chainCall=*/false, argTypes, FunctionType::ExtInfo(),
649 /*paramInfos=*/ {}, RequiredArgs::All);
John McCall8dda7b22012-07-07 06:41:13 +0000650}
651
John McCallc56a8b32016-03-11 04:30:31 +0000652const CGFunctionInfo &
653CodeGenTypes::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
662const CGFunctionInfo &
663CodeGenTypes::arrangeBuiltinFunctionDeclaration(CanQualType resultType,
664 ArrayRef<CanQualType> argTypes) {
665 return arrangeLLVMFunctionInfo(
666 resultType, /*instanceMethod=*/false, /*chainCall=*/false,
667 argTypes, FunctionType::ExtInfo(), {}, RequiredArgs::All);
668}
669
John McCall8dda7b22012-07-07 06:41:13 +0000670/// Arrange a call to a C++ method, passing the given arguments.
George Burgess IVd0a9e802017-02-23 22:07:35 +0000671///
672/// numPrefixArgs is the number of ABI-specific prefix arguments we have. It
673/// does not count `this`.
John McCall8dda7b22012-07-07 06:41:13 +0000674const CGFunctionInfo &
675CodeGenTypes::arrangeCXXMethodCall(const CallArgList &args,
John McCallc56a8b32016-03-11 04:30:31 +0000676 const FunctionProtoType *proto,
George Burgess IVd0a9e802017-02-23 22:07:35 +0000677 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.
John McCallc56a8b32016-03-11 04:30:31 +0000683 auto paramInfos =
George Burgess IVd0a9e802017-02-23 22:07:35 +0000684 getExtParameterInfosForCall(proto, numPrefixArgs + 1, args.size());
John McCallc56a8b32016-03-11 04:30:31 +0000685
John McCall8dda7b22012-07-07 06:41:13 +0000686 // FIXME: Kill copy.
John McCallc56a8b32016-03-11 04:30:31 +0000687 auto argTypes = getArgTypesForCall(Context, args);
John McCall8dda7b22012-07-07 06:41:13 +0000688
John McCallc56a8b32016-03-11 04:30:31 +0000689 FunctionType::ExtInfo info = proto->getExtInfo();
Peter Collingbournef7706832014-12-12 23:41:25 +0000690 return arrangeLLVMFunctionInfo(
John McCallc56a8b32016-03-11 04:30:31 +0000691 GetReturnType(proto->getReturnType()), /*instanceMethod=*/true,
692 /*chainCall=*/false, argTypes, info, paramInfos, required);
Daniel Dunbarbf8c24a2009-02-02 23:23:47 +0000693}
694
John McCalla729c622012-02-17 03:33:10 +0000695const CGFunctionInfo &CodeGenTypes::arrangeNullaryFunction() {
Peter Collingbournef7706832014-12-12 23:41:25 +0000696 return arrangeLLVMFunctionInfo(
697 getContext().VoidTy, /*instanceMethod=*/false, /*chainCall=*/false,
John McCallc56a8b32016-03-11 04:30:31 +0000698 None, FunctionType::ExtInfo(), {}, RequiredArgs::All);
699}
700
701const CGFunctionInfo &
702CodeGenTypes::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());
John McCalla738c252011-03-09 04:27:21 +0000725}
726
Pekka Jaaskelainenfc2629a2017-06-01 07:18:49 +0000727namespace clang {
728namespace CodeGen {
729void computeSPIRKernelABIInfo(CodeGenModule &CGM, CGFunctionInfo &FI);
730}
731}
732
John McCalla729c622012-02-17 03:33:10 +0000733/// 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.
736const CGFunctionInfo &
John McCall8dda7b22012-07-07 06:41:13 +0000737CodeGenTypes::arrangeLLVMFunctionInfo(CanQualType resultType,
Peter Collingbournef7706832014-12-12 23:41:25 +0000738 bool instanceMethod,
739 bool chainCall,
John McCall8dda7b22012-07-07 06:41:13 +0000740 ArrayRef<CanQualType> argTypes,
741 FunctionType::ExtInfo info,
John McCallc56a8b32016-03-11 04:30:31 +0000742 ArrayRef<FunctionProtoType::ExtParameterInfo> paramInfos,
John McCall8dda7b22012-07-07 06:41:13 +0000743 RequiredArgs required) {
Fangrui Song3117b172018-10-20 17:53:42 +0000744 assert(llvm::all_of(argTypes,
745 [](CanQualType T) { return T.isCanonicalAsParam(); }));
John McCall2da83a32010-02-26 00:48:12 +0000746
Daniel Dunbare0be8292009-02-03 00:07:12 +0000747 // Lookup or create unique function info.
748 llvm::FoldingSetNodeID ID;
John McCallc56a8b32016-03-11 04:30:31 +0000749 CGFunctionInfo::Profile(ID, instanceMethod, chainCall, info, paramInfos,
750 required, resultType, argTypes);
Daniel Dunbare0be8292009-02-03 00:07:12 +0000751
Craig Topper8a13c412014-05-21 05:09:00 +0000752 void *insertPos = nullptr;
John McCalla729c622012-02-17 03:33:10 +0000753 CGFunctionInfo *FI = FunctionInfos.FindNodeOrInsertPos(ID, insertPos);
Daniel Dunbare0be8292009-02-03 00:07:12 +0000754 if (FI)
755 return *FI;
756
John McCallc56a8b32016-03-11 04:30:31 +0000757 unsigned CC = ClangCallConvToLLVMCallConv(info.getCC());
758
John McCalla729c622012-02-17 03:33:10 +0000759 // Construct the function info. We co-allocate the ArgInfos.
Peter Collingbournef7706832014-12-12 23:41:25 +0000760 FI = CGFunctionInfo::create(CC, instanceMethod, chainCall, info,
John McCallc56a8b32016-03-11 04:30:31 +0000761 paramInfos, resultType, argTypes, required);
John McCalla729c622012-02-17 03:33:10 +0000762 FunctionInfos.InsertNode(FI, insertPos);
Daniel Dunbar313321e2009-02-03 05:31:23 +0000763
David Blaikie82e95a32014-11-19 07:49:47 +0000764 bool inserted = FunctionsBeingProcessed.insert(FI).second;
765 (void)inserted;
John McCalla729c622012-02-17 03:33:10 +0000766 assert(inserted && "Recursively being processed?");
Pekka Jaaskelainenfc2629a2017-06-01 07:18:49 +0000767
Daniel Dunbar313321e2009-02-03 05:31:23 +0000768 // Compute ABI information.
Pekka Jaaskelainenfc2629a2017-06-01 07:18:49 +0000769 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) {
John McCall12f23522016-04-04 18:33:08 +0000774 swiftcall::computeABIInfo(CGM, *FI);
Pekka Jaaskelainenfc2629a2017-06-01 07:18:49 +0000775 } else {
776 getABIInfo().computeInfo(*FI);
John McCall12f23522016-04-04 18:33:08 +0000777 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000778
Chris Lattnerfe34c1d2010-07-29 06:26:06 +0000779 // 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.
John McCalla729c622012-02-17 03:33:10 +0000782 ABIArgInfo &retInfo = FI->getReturnInfo();
Craig Topper8a13c412014-05-21 05:09:00 +0000783 if (retInfo.canHaveCoerceToType() && retInfo.getCoerceToType() == nullptr)
John McCalla729c622012-02-17 03:33:10 +0000784 retInfo.setCoerceToType(ConvertType(FI->getReturnType()));
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000785
Aaron Ballmanec47bc22014-03-17 18:10:01 +0000786 for (auto &I : FI->arguments())
Craig Topper8a13c412014-05-21 05:09:00 +0000787 if (I.info.canHaveCoerceToType() && I.info.getCoerceToType() == nullptr)
Aaron Ballmanec47bc22014-03-17 18:10:01 +0000788 I.info.setCoerceToType(ConvertType(I.type));
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000789
John McCalla729c622012-02-17 03:33:10 +0000790 bool erased = FunctionsBeingProcessed.erase(FI); (void)erased;
791 assert(erased && "Not in set?");
Fangrui Song6907ce22018-07-30 19:24:48 +0000792
Daniel Dunbare0be8292009-02-03 00:07:12 +0000793 return *FI;
Daniel Dunbarbf8c24a2009-02-02 23:23:47 +0000794}
795
John McCalla729c622012-02-17 03:33:10 +0000796CGFunctionInfo *CGFunctionInfo::create(unsigned llvmCC,
Peter Collingbournef7706832014-12-12 23:41:25 +0000797 bool instanceMethod,
798 bool chainCall,
John McCalla729c622012-02-17 03:33:10 +0000799 const FunctionType::ExtInfo &info,
John McCallc56a8b32016-03-11 04:30:31 +0000800 ArrayRef<ExtParameterInfo> paramInfos,
John McCalla729c622012-02-17 03:33:10 +0000801 CanQualType resultType,
802 ArrayRef<CanQualType> argTypes,
803 RequiredArgs required) {
John McCallc56a8b32016-03-11 04:30:31 +0000804 assert(paramInfos.empty() || paramInfos.size() == argTypes.size());
James Y Knightb92d2902019-02-05 16:05:50 +0000805 assert(!required.allowsOptionalArgs() ||
806 required.getNumRequiredArgs() <= argTypes.size());
John McCallc56a8b32016-03-11 04:30:31 +0000807
808 void *buffer =
809 operator new(totalSizeToAlloc<ArgInfo, ExtParameterInfo>(
810 argTypes.size() + 1, paramInfos.size()));
811
John McCalla729c622012-02-17 03:33:10 +0000812 CGFunctionInfo *FI = new(buffer) CGFunctionInfo();
813 FI->CallingConvention = llvmCC;
814 FI->EffectiveCallingConvention = llvmCC;
815 FI->ASTCallingConvention = info.getCC();
Peter Collingbournef7706832014-12-12 23:41:25 +0000816 FI->InstanceMethod = instanceMethod;
817 FI->ChainCall = chainCall;
John McCalla729c622012-02-17 03:33:10 +0000818 FI->NoReturn = info.getNoReturn();
819 FI->ReturnsRetained = info.getProducesResult();
Oren Ben Simhon318a6ea2017-04-27 12:01:00 +0000820 FI->NoCallerSavedRegs = info.getNoCallerSavedRegs();
Oren Ben Simhon220671a2018-03-17 13:31:35 +0000821 FI->NoCfCheck = info.getNoCfCheck();
John McCalla729c622012-02-17 03:33:10 +0000822 FI->Required = required;
823 FI->HasRegParm = info.getHasRegParm();
824 FI->RegParm = info.getRegParm();
Craig Topper8a13c412014-05-21 05:09:00 +0000825 FI->ArgStruct = nullptr;
John McCall7f416cc2015-09-08 08:05:57 +0000826 FI->ArgStructAlign = 0;
John McCalla729c622012-02-17 03:33:10 +0000827 FI->NumArgs = argTypes.size();
John McCallc56a8b32016-03-11 04:30:31 +0000828 FI->HasExtParameterInfos = !paramInfos.empty();
John McCalla729c622012-02-17 03:33:10 +0000829 FI->getArgsBuffer()[0].type = resultType;
830 for (unsigned i = 0, e = argTypes.size(); i != e; ++i)
831 FI->getArgsBuffer()[i + 1].type = argTypes[i];
John McCallc56a8b32016-03-11 04:30:31 +0000832 for (unsigned i = 0, e = paramInfos.size(); i != e; ++i)
833 FI->getExtParameterInfosBuffer()[i] = paramInfos[i];
John McCalla729c622012-02-17 03:33:10 +0000834 return FI;
Daniel Dunbar313321e2009-02-03 05:31:23 +0000835}
836
837/***/
838
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000839namespace {
840// ABIArgInfo::Expand implementation.
841
842// Specifies the way QualType passed as ABIArgInfo::Expand is expanded.
843struct TypeExpansion {
844 enum TypeExpansionKind {
845 // Elements of constant arrays are expanded recursively.
846 TEK_ConstantArray,
847 // Record fields are expanded recursively (but if record is a union, only
848 // the field with the largest size is expanded).
849 TEK_Record,
850 // For complex types, real and imaginary parts are expanded recursively.
851 TEK_Complex,
852 // All other types are not expandable.
853 TEK_None
854 };
855
856 const TypeExpansionKind Kind;
857
858 TypeExpansion(TypeExpansionKind K) : Kind(K) {}
Angel Garcia Gomez637d1e62015-10-20 13:23:58 +0000859 virtual ~TypeExpansion() {}
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000860};
861
862struct ConstantArrayExpansion : TypeExpansion {
863 QualType EltTy;
864 uint64_t NumElts;
865
866 ConstantArrayExpansion(QualType EltTy, uint64_t NumElts)
867 : TypeExpansion(TEK_ConstantArray), EltTy(EltTy), NumElts(NumElts) {}
868 static bool classof(const TypeExpansion *TE) {
869 return TE->Kind == TEK_ConstantArray;
870 }
871};
872
873struct RecordExpansion : TypeExpansion {
Reid Klecknere9f6a712014-10-31 17:10:41 +0000874 SmallVector<const CXXBaseSpecifier *, 1> Bases;
875
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000876 SmallVector<const FieldDecl *, 1> Fields;
877
Reid Klecknere9f6a712014-10-31 17:10:41 +0000878 RecordExpansion(SmallVector<const CXXBaseSpecifier *, 1> &&Bases,
879 SmallVector<const FieldDecl *, 1> &&Fields)
Benjamin Kramer0bb97742016-02-13 16:00:13 +0000880 : TypeExpansion(TEK_Record), Bases(std::move(Bases)),
881 Fields(std::move(Fields)) {}
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000882 static bool classof(const TypeExpansion *TE) {
883 return TE->Kind == TEK_Record;
884 }
885};
886
887struct ComplexExpansion : TypeExpansion {
888 QualType EltTy;
889
890 ComplexExpansion(QualType EltTy) : TypeExpansion(TEK_Complex), EltTy(EltTy) {}
891 static bool classof(const TypeExpansion *TE) {
892 return TE->Kind == TEK_Complex;
893 }
894};
895
896struct NoExpansion : TypeExpansion {
897 NoExpansion() : TypeExpansion(TEK_None) {}
898 static bool classof(const TypeExpansion *TE) {
899 return TE->Kind == TEK_None;
900 }
901};
902} // namespace
903
904static std::unique_ptr<TypeExpansion>
905getTypeExpansion(QualType Ty, const ASTContext &Context) {
906 if (const ConstantArrayType *AT = Context.getAsConstantArrayType(Ty)) {
Jonas Devlieghere2b3d49b2019-08-14 23:04:18 +0000907 return std::make_unique<ConstantArrayExpansion>(
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000908 AT->getElementType(), AT->getSize().getZExtValue());
909 }
910 if (const RecordType *RT = Ty->getAs<RecordType>()) {
Reid Klecknere9f6a712014-10-31 17:10:41 +0000911 SmallVector<const CXXBaseSpecifier *, 1> Bases;
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000912 SmallVector<const FieldDecl *, 1> Fields;
Bob Wilsone826a2a2011-08-03 05:58:22 +0000913 const RecordDecl *RD = RT->getDecl();
914 assert(!RD->hasFlexibleArrayMember() &&
915 "Cannot expand structure with flexible array.");
Anton Korobeynikov4215ca72012-04-13 11:22:00 +0000916 if (RD->isUnion()) {
917 // Unions can be here only in degenerative cases - all the fields are same
918 // after flattening. Thus we have to use the "largest" field.
Craig Topper8a13c412014-05-21 05:09:00 +0000919 const FieldDecl *LargestFD = nullptr;
Anton Korobeynikov4215ca72012-04-13 11:22:00 +0000920 CharUnits UnionSize = CharUnits::Zero();
921
Aaron Ballmane8a8bae2014-03-08 20:12:42 +0000922 for (const auto *FD : RD->fields()) {
Richard Smith866dee42018-04-02 18:29:43 +0000923 if (FD->isZeroLengthBitField(Context))
Reid Kleckner80944df2014-10-31 22:00:51 +0000924 continue;
Anton Korobeynikov4215ca72012-04-13 11:22:00 +0000925 assert(!FD->isBitField() &&
926 "Cannot expand structure with bit-field members.");
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000927 CharUnits FieldSize = Context.getTypeSizeInChars(FD->getType());
Anton Korobeynikov4215ca72012-04-13 11:22:00 +0000928 if (UnionSize < FieldSize) {
929 UnionSize = FieldSize;
930 LargestFD = FD;
931 }
932 }
933 if (LargestFD)
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000934 Fields.push_back(LargestFD);
Anton Korobeynikov4215ca72012-04-13 11:22:00 +0000935 } else {
Reid Klecknere9f6a712014-10-31 17:10:41 +0000936 if (const auto *CXXRD = dyn_cast<CXXRecordDecl>(RD)) {
937 assert(!CXXRD->isDynamicClass() &&
938 "cannot expand vtable pointers in dynamic classes");
939 for (const CXXBaseSpecifier &BS : CXXRD->bases())
940 Bases.push_back(&BS);
941 }
942
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000943 for (const auto *FD : RD->fields()) {
Richard Smith866dee42018-04-02 18:29:43 +0000944 if (FD->isZeroLengthBitField(Context))
Reid Kleckner80944df2014-10-31 22:00:51 +0000945 continue;
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000946 assert(!FD->isBitField() &&
Anton Korobeynikov4215ca72012-04-13 11:22:00 +0000947 "Cannot expand structure with bit-field members.");
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000948 Fields.push_back(FD);
Anton Korobeynikov4215ca72012-04-13 11:22:00 +0000949 }
Bob Wilsone826a2a2011-08-03 05:58:22 +0000950 }
Jonas Devlieghere2b3d49b2019-08-14 23:04:18 +0000951 return std::make_unique<RecordExpansion>(std::move(Bases),
Reid Klecknere9f6a712014-10-31 17:10:41 +0000952 std::move(Fields));
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000953 }
954 if (const ComplexType *CT = Ty->getAs<ComplexType>()) {
Jonas Devlieghere2b3d49b2019-08-14 23:04:18 +0000955 return std::make_unique<ComplexExpansion>(CT->getElementType());
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000956 }
Jonas Devlieghere2b3d49b2019-08-14 23:04:18 +0000957 return std::make_unique<NoExpansion>();
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000958}
959
Alexey Samsonov52c0f6a2014-09-29 20:30:22 +0000960static int getExpansionSize(QualType Ty, const ASTContext &Context) {
961 auto Exp = getTypeExpansion(Ty, Context);
962 if (auto CAExp = dyn_cast<ConstantArrayExpansion>(Exp.get())) {
963 return CAExp->NumElts * getExpansionSize(CAExp->EltTy, Context);
964 }
965 if (auto RExp = dyn_cast<RecordExpansion>(Exp.get())) {
966 int Res = 0;
Reid Klecknere9f6a712014-10-31 17:10:41 +0000967 for (auto BS : RExp->Bases)
968 Res += getExpansionSize(BS->getType(), Context);
Alexey Samsonov52c0f6a2014-09-29 20:30:22 +0000969 for (auto FD : RExp->Fields)
970 Res += getExpansionSize(FD->getType(), Context);
971 return Res;
972 }
973 if (isa<ComplexExpansion>(Exp.get()))
974 return 2;
975 assert(isa<NoExpansion>(Exp.get()));
976 return 1;
977}
978
Alexey Samsonov153004f2014-09-29 22:08:00 +0000979void
980CodeGenTypes::getExpandedTypes(QualType Ty,
981 SmallVectorImpl<llvm::Type *>::iterator &TI) {
982 auto Exp = getTypeExpansion(Ty, Context);
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000983 if (auto CAExp = dyn_cast<ConstantArrayExpansion>(Exp.get())) {
984 for (int i = 0, n = CAExp->NumElts; i < n; i++) {
Alexey Samsonov153004f2014-09-29 22:08:00 +0000985 getExpandedTypes(CAExp->EltTy, TI);
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000986 }
987 } else if (auto RExp = dyn_cast<RecordExpansion>(Exp.get())) {
Reid Klecknere9f6a712014-10-31 17:10:41 +0000988 for (auto BS : RExp->Bases)
989 getExpandedTypes(BS->getType(), TI);
990 for (auto FD : RExp->Fields)
Alexey Samsonov153004f2014-09-29 22:08:00 +0000991 getExpandedTypes(FD->getType(), TI);
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000992 } else if (auto CExp = dyn_cast<ComplexExpansion>(Exp.get())) {
993 llvm::Type *EltTy = ConvertType(CExp->EltTy);
Alexey Samsonov153004f2014-09-29 22:08:00 +0000994 *TI++ = EltTy;
995 *TI++ = EltTy;
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000996 } else {
997 assert(isa<NoExpansion>(Exp.get()));
Alexey Samsonov153004f2014-09-29 22:08:00 +0000998 *TI++ = ConvertType(Ty);
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000999 }
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00001000}
1001
John McCall7f416cc2015-09-08 08:05:57 +00001002static void forConstantArrayExpansion(CodeGenFunction &CGF,
1003 ConstantArrayExpansion *CAE,
1004 Address BaseAddr,
1005 llvm::function_ref<void(Address)> Fn) {
1006 CharUnits EltSize = CGF.getContext().getTypeSizeInChars(CAE->EltTy);
1007 CharUnits EltAlign =
1008 BaseAddr.getAlignment().alignmentOfArrayElement(EltSize);
1009
1010 for (int i = 0, n = CAE->NumElts; i < n; i++) {
1011 llvm::Value *EltAddr =
1012 CGF.Builder.CreateConstGEP2_32(nullptr, BaseAddr.getPointer(), 0, i);
1013 Fn(Address(EltAddr, EltAlign));
1014 }
1015}
1016
Alexey Samsonov91cf4552014-08-22 01:06:06 +00001017void CodeGenFunction::ExpandTypeFromArgs(
John McCall12f23522016-04-04 18:33:08 +00001018 QualType Ty, LValue LV, SmallVectorImpl<llvm::Value *>::iterator &AI) {
Mike Stump11289f42009-09-09 15:08:12 +00001019 assert(LV.isSimple() &&
1020 "Unexpected non-simple lvalue during struct expansion.");
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00001021
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001022 auto Exp = getTypeExpansion(Ty, getContext());
1023 if (auto CAExp = dyn_cast<ConstantArrayExpansion>(Exp.get())) {
Akira Hatanakaf139ae32019-12-03 15:17:01 -08001024 forConstantArrayExpansion(
1025 *this, CAExp, LV.getAddress(*this), [&](Address EltAddr) {
1026 LValue LV = MakeAddrLValue(EltAddr, CAExp->EltTy);
1027 ExpandTypeFromArgs(CAExp->EltTy, LV, AI);
1028 });
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001029 } else if (auto RExp = dyn_cast<RecordExpansion>(Exp.get())) {
Akira Hatanakaf139ae32019-12-03 15:17:01 -08001030 Address This = LV.getAddress(*this);
Reid Klecknere9f6a712014-10-31 17:10:41 +00001031 for (const CXXBaseSpecifier *BS : RExp->Bases) {
1032 // Perform a single step derived-to-base conversion.
John McCall7f416cc2015-09-08 08:05:57 +00001033 Address Base =
Reid Klecknere9f6a712014-10-31 17:10:41 +00001034 GetAddressOfBaseClass(This, Ty->getAsCXXRecordDecl(), &BS, &BS + 1,
1035 /*NullCheckValue=*/false, SourceLocation());
1036 LValue SubLV = MakeAddrLValue(Base, BS->getType());
1037
1038 // Recurse onto bases.
1039 ExpandTypeFromArgs(BS->getType(), SubLV, AI);
1040 }
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001041 for (auto FD : RExp->Fields) {
1042 // FIXME: What are the right qualifiers here?
Reid Kleckner9d031092016-05-02 22:42:34 +00001043 LValue SubLV = EmitLValueForFieldInitialization(LV, FD);
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001044 ExpandTypeFromArgs(FD->getType(), SubLV, AI);
Bob Wilsone826a2a2011-08-03 05:58:22 +00001045 }
John McCall7f416cc2015-09-08 08:05:57 +00001046 } else if (isa<ComplexExpansion>(Exp.get())) {
1047 auto realValue = *AI++;
1048 auto imagValue = *AI++;
1049 EmitStoreOfComplex(ComplexPairTy(realValue, imagValue), LV, /*init*/ true);
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001050 } else {
Akira Hatanakad8136f12019-11-29 09:56:02 -08001051 // Call EmitStoreOfScalar except when the lvalue is a bitfield to emit a
1052 // primitive store.
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001053 assert(isa<NoExpansion>(Exp.get()));
Akira Hatanakad8136f12019-11-29 09:56:02 -08001054 if (LV.isBitField())
1055 EmitStoreThroughLValue(RValue::get(*AI++), LV);
1056 else
1057 EmitStoreOfScalar(*AI++, LV);
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00001058 }
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001059}
1060
1061void CodeGenFunction::ExpandTypeToArgs(
Yaxun Liu5b330e82018-03-15 15:25:19 +00001062 QualType Ty, CallArg Arg, llvm::FunctionType *IRFuncTy,
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001063 SmallVectorImpl<llvm::Value *> &IRCallArgs, unsigned &IRCallArgPos) {
1064 auto Exp = getTypeExpansion(Ty, getContext());
1065 if (auto CAExp = dyn_cast<ConstantArrayExpansion>(Exp.get())) {
Akira Hatanakaf139ae32019-12-03 15:17:01 -08001066 Address Addr = Arg.hasLValue() ? Arg.getKnownLValue().getAddress(*this)
Yaxun Liu5b330e82018-03-15 15:25:19 +00001067 : Arg.getKnownRValue().getAggregateAddress();
1068 forConstantArrayExpansion(
1069 *this, CAExp, Addr, [&](Address EltAddr) {
1070 CallArg EltArg = CallArg(
1071 convertTempToRValue(EltAddr, CAExp->EltTy, SourceLocation()),
1072 CAExp->EltTy);
1073 ExpandTypeToArgs(CAExp->EltTy, EltArg, IRFuncTy, IRCallArgs,
1074 IRCallArgPos);
1075 });
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001076 } else if (auto RExp = dyn_cast<RecordExpansion>(Exp.get())) {
Akira Hatanakaf139ae32019-12-03 15:17:01 -08001077 Address This = Arg.hasLValue() ? Arg.getKnownLValue().getAddress(*this)
Yaxun Liu5b330e82018-03-15 15:25:19 +00001078 : Arg.getKnownRValue().getAggregateAddress();
Reid Klecknere9f6a712014-10-31 17:10:41 +00001079 for (const CXXBaseSpecifier *BS : RExp->Bases) {
1080 // Perform a single step derived-to-base conversion.
John McCall7f416cc2015-09-08 08:05:57 +00001081 Address Base =
Reid Klecknere9f6a712014-10-31 17:10:41 +00001082 GetAddressOfBaseClass(This, Ty->getAsCXXRecordDecl(), &BS, &BS + 1,
1083 /*NullCheckValue=*/false, SourceLocation());
Yaxun Liu5b330e82018-03-15 15:25:19 +00001084 CallArg BaseArg = CallArg(RValue::getAggregate(Base), BS->getType());
Reid Klecknere9f6a712014-10-31 17:10:41 +00001085
1086 // Recurse onto bases.
Yaxun Liu5b330e82018-03-15 15:25:19 +00001087 ExpandTypeToArgs(BS->getType(), BaseArg, IRFuncTy, IRCallArgs,
Reid Klecknere9f6a712014-10-31 17:10:41 +00001088 IRCallArgPos);
1089 }
1090
1091 LValue LV = MakeAddrLValue(This, Ty);
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001092 for (auto FD : RExp->Fields) {
Yaxun Liu5b330e82018-03-15 15:25:19 +00001093 CallArg FldArg =
1094 CallArg(EmitRValueForField(LV, FD, SourceLocation()), FD->getType());
1095 ExpandTypeToArgs(FD->getType(), FldArg, IRFuncTy, IRCallArgs,
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001096 IRCallArgPos);
1097 }
1098 } else if (isa<ComplexExpansion>(Exp.get())) {
Yaxun Liu5b330e82018-03-15 15:25:19 +00001099 ComplexPairTy CV = Arg.getKnownRValue().getComplexVal();
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001100 IRCallArgs[IRCallArgPos++] = CV.first;
1101 IRCallArgs[IRCallArgPos++] = CV.second;
1102 } else {
1103 assert(isa<NoExpansion>(Exp.get()));
Yaxun Liu5b330e82018-03-15 15:25:19 +00001104 auto RV = Arg.getKnownRValue();
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001105 assert(RV.isScalar() &&
1106 "Unexpected non-scalar rvalue during struct expansion.");
1107
1108 // Insert a bitcast as needed.
1109 llvm::Value *V = RV.getScalarVal();
1110 if (IRCallArgPos < IRFuncTy->getNumParams() &&
1111 V->getType() != IRFuncTy->getParamType(IRCallArgPos))
1112 V = Builder.CreateBitCast(V, IRFuncTy->getParamType(IRCallArgPos));
1113
1114 IRCallArgs[IRCallArgPos++] = V;
1115 }
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00001116}
1117
John McCall7f416cc2015-09-08 08:05:57 +00001118/// Create a temporary allocation for the purposes of coercion.
1119static Address CreateTempAllocaForCoercion(CodeGenFunction &CGF, llvm::Type *Ty,
1120 CharUnits MinAlign) {
1121 // Don't use an alignment that's worse than what LLVM would prefer.
1122 auto PrefAlign = CGF.CGM.getDataLayout().getPrefTypeAlignment(Ty);
1123 CharUnits Align = std::max(MinAlign, CharUnits::fromQuantity(PrefAlign));
1124
1125 return CGF.CreateTempAlloca(Ty, Align);
1126}
1127
Chris Lattner895c52b2010-06-27 06:04:18 +00001128/// EnterStructPointerForCoercedAccess - Given a struct pointer that we are
Chris Lattner1cd66982010-06-27 05:56:15 +00001129/// accessing some number of bytes out of it, try to gep into the struct to get
1130/// at its inner goodness. Dive as deep as possible without entering an element
1131/// with an in-memory size smaller than DstSize.
John McCall7f416cc2015-09-08 08:05:57 +00001132static Address
1133EnterStructPointerForCoercedAccess(Address SrcPtr,
Chris Lattner2192fe52011-07-18 04:24:23 +00001134 llvm::StructType *SrcSTy,
Chris Lattner895c52b2010-06-27 06:04:18 +00001135 uint64_t DstSize, CodeGenFunction &CGF) {
Chris Lattner1cd66982010-06-27 05:56:15 +00001136 // We can't dive into a zero-element struct.
1137 if (SrcSTy->getNumElements() == 0) return SrcPtr;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001138
Chris Lattner2192fe52011-07-18 04:24:23 +00001139 llvm::Type *FirstElt = SrcSTy->getElementType(0);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001140
Chris Lattner1cd66982010-06-27 05:56:15 +00001141 // If the first elt is at least as large as what we're looking for, or if the
James Molloy90d61012014-08-29 10:17:52 +00001142 // first element is the same size as the whole struct, we can enter it. The
1143 // comparison must be made on the store size and not the alloca size. Using
1144 // the alloca size may overstate the size of the load.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001145 uint64_t FirstEltSize =
James Molloy90d61012014-08-29 10:17:52 +00001146 CGF.CGM.getDataLayout().getTypeStoreSize(FirstElt);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001147 if (FirstEltSize < DstSize &&
James Molloy90d61012014-08-29 10:17:52 +00001148 FirstEltSize < CGF.CGM.getDataLayout().getTypeStoreSize(SrcSTy))
Chris Lattner1cd66982010-06-27 05:56:15 +00001149 return SrcPtr;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001150
Chris Lattner1cd66982010-06-27 05:56:15 +00001151 // GEP into the first element.
James Y Knight751fe282019-02-09 22:22:28 +00001152 SrcPtr = CGF.Builder.CreateStructGEP(SrcPtr, 0, "coerce.dive");
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001153
Chris Lattner1cd66982010-06-27 05:56:15 +00001154 // If the first element is a struct, recurse.
John McCall7f416cc2015-09-08 08:05:57 +00001155 llvm::Type *SrcTy = SrcPtr.getElementType();
Chris Lattner2192fe52011-07-18 04:24:23 +00001156 if (llvm::StructType *SrcSTy = dyn_cast<llvm::StructType>(SrcTy))
Chris Lattner895c52b2010-06-27 06:04:18 +00001157 return EnterStructPointerForCoercedAccess(SrcPtr, SrcSTy, DstSize, CGF);
Chris Lattner1cd66982010-06-27 05:56:15 +00001158
1159 return SrcPtr;
1160}
1161
Chris Lattner055097f2010-06-27 06:26:04 +00001162/// CoerceIntOrPtrToIntOrPtr - Convert a value Val to the specific Ty where both
1163/// are either integers or pointers. This does a truncation of the value if it
1164/// is too large or a zero extension if it is too small.
Jakob Stoklund Olesen36af2522013-06-05 03:00:13 +00001165///
1166/// This behaves as if the value were coerced through memory, so on big-endian
1167/// targets the high bits are preserved in a truncation, while little-endian
1168/// targets preserve the low bits.
Chris Lattner055097f2010-06-27 06:26:04 +00001169static llvm::Value *CoerceIntOrPtrToIntOrPtr(llvm::Value *Val,
Chris Lattner2192fe52011-07-18 04:24:23 +00001170 llvm::Type *Ty,
Chris Lattner055097f2010-06-27 06:26:04 +00001171 CodeGenFunction &CGF) {
1172 if (Val->getType() == Ty)
1173 return Val;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001174
Chris Lattner055097f2010-06-27 06:26:04 +00001175 if (isa<llvm::PointerType>(Val->getType())) {
1176 // If this is Pointer->Pointer avoid conversion to and from int.
1177 if (isa<llvm::PointerType>(Ty))
1178 return CGF.Builder.CreateBitCast(Val, Ty, "coerce.val");
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001179
Chris Lattner055097f2010-06-27 06:26:04 +00001180 // Convert the pointer to an integer so we can play with its width.
Chris Lattner5e016ae2010-06-27 07:15:29 +00001181 Val = CGF.Builder.CreatePtrToInt(Val, CGF.IntPtrTy, "coerce.val.pi");
Chris Lattner055097f2010-06-27 06:26:04 +00001182 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001183
Chris Lattner2192fe52011-07-18 04:24:23 +00001184 llvm::Type *DestIntTy = Ty;
Chris Lattner055097f2010-06-27 06:26:04 +00001185 if (isa<llvm::PointerType>(DestIntTy))
Chris Lattner5e016ae2010-06-27 07:15:29 +00001186 DestIntTy = CGF.IntPtrTy;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001187
Jakob Stoklund Olesen36af2522013-06-05 03:00:13 +00001188 if (Val->getType() != DestIntTy) {
1189 const llvm::DataLayout &DL = CGF.CGM.getDataLayout();
1190 if (DL.isBigEndian()) {
1191 // Preserve the high bits on big-endian targets.
1192 // That is what memory coercion does.
James Molloy491cefb2014-05-07 17:41:15 +00001193 uint64_t SrcSize = DL.getTypeSizeInBits(Val->getType());
1194 uint64_t DstSize = DL.getTypeSizeInBits(DestIntTy);
1195
Jakob Stoklund Olesen36af2522013-06-05 03:00:13 +00001196 if (SrcSize > DstSize) {
1197 Val = CGF.Builder.CreateLShr(Val, SrcSize - DstSize, "coerce.highbits");
1198 Val = CGF.Builder.CreateTrunc(Val, DestIntTy, "coerce.val.ii");
1199 } else {
1200 Val = CGF.Builder.CreateZExt(Val, DestIntTy, "coerce.val.ii");
1201 Val = CGF.Builder.CreateShl(Val, DstSize - SrcSize, "coerce.highbits");
1202 }
1203 } else {
1204 // Little-endian targets preserve the low bits. No shifts required.
1205 Val = CGF.Builder.CreateIntCast(Val, DestIntTy, false, "coerce.val.ii");
1206 }
1207 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001208
Chris Lattner055097f2010-06-27 06:26:04 +00001209 if (isa<llvm::PointerType>(Ty))
1210 Val = CGF.Builder.CreateIntToPtr(Val, Ty, "coerce.val.ip");
1211 return Val;
1212}
1213
Chris Lattner1cd66982010-06-27 05:56:15 +00001214
1215
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001216/// CreateCoercedLoad - Create a load from \arg SrcPtr interpreted as
Ulrich Weigand6e2cea62015-07-10 11:31:43 +00001217/// a pointer to an object of type \arg Ty, known to be aligned to
1218/// \arg SrcAlign bytes.
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001219///
1220/// This safely handles the case when the src type is smaller than the
1221/// destination type; in this situation the values of bits which not
1222/// present in the src are undefined.
John McCall7f416cc2015-09-08 08:05:57 +00001223static llvm::Value *CreateCoercedLoad(Address Src, llvm::Type *Ty,
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001224 CodeGenFunction &CGF) {
John McCall7f416cc2015-09-08 08:05:57 +00001225 llvm::Type *SrcTy = Src.getElementType();
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001226
Chris Lattnerd200eda2010-06-28 22:51:39 +00001227 // If SrcTy and Ty are the same, just do a load.
1228 if (SrcTy == Ty)
John McCall7f416cc2015-09-08 08:05:57 +00001229 return CGF.Builder.CreateLoad(Src);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001230
Micah Villmowdd31ca12012-10-08 16:25:52 +00001231 uint64_t DstSize = CGF.CGM.getDataLayout().getTypeAllocSize(Ty);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001232
Chris Lattner2192fe52011-07-18 04:24:23 +00001233 if (llvm::StructType *SrcSTy = dyn_cast<llvm::StructType>(SrcTy)) {
John McCall7f416cc2015-09-08 08:05:57 +00001234 Src = EnterStructPointerForCoercedAccess(Src, SrcSTy, DstSize, CGF);
1235 SrcTy = Src.getType()->getElementType();
Chris Lattner1cd66982010-06-27 05:56:15 +00001236 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001237
Micah Villmowdd31ca12012-10-08 16:25:52 +00001238 uint64_t SrcSize = CGF.CGM.getDataLayout().getTypeAllocSize(SrcTy);
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001239
Chris Lattner055097f2010-06-27 06:26:04 +00001240 // If the source and destination are integer or pointer types, just do an
1241 // extension or truncation to the desired type.
1242 if ((isa<llvm::IntegerType>(Ty) || isa<llvm::PointerType>(Ty)) &&
1243 (isa<llvm::IntegerType>(SrcTy) || isa<llvm::PointerType>(SrcTy))) {
John McCall7f416cc2015-09-08 08:05:57 +00001244 llvm::Value *Load = CGF.Builder.CreateLoad(Src);
Chris Lattner055097f2010-06-27 06:26:04 +00001245 return CoerceIntOrPtrToIntOrPtr(Load, Ty, CGF);
1246 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001247
Daniel Dunbarb52d0772009-02-03 05:59:18 +00001248 // If load is legal, just bitcast the src pointer.
Daniel Dunbarffdb8432009-05-13 18:54:26 +00001249 if (SrcSize >= DstSize) {
Mike Stump18bb9282009-05-16 07:57:57 +00001250 // Generally SrcSize is never greater than DstSize, since this means we are
1251 // losing bits. However, this can happen in cases where the structure has
1252 // additional padding, for example due to a user specified alignment.
Daniel Dunbarffdb8432009-05-13 18:54:26 +00001253 //
Mike Stump18bb9282009-05-16 07:57:57 +00001254 // FIXME: Assert that we aren't truncating non-padding bits when have access
1255 // to that information.
Matt Arsenault7a124f32017-08-01 20:36:57 +00001256 Src = CGF.Builder.CreateBitCast(Src,
1257 Ty->getPointerTo(Src.getAddressSpace()));
John McCall7f416cc2015-09-08 08:05:57 +00001258 return CGF.Builder.CreateLoad(Src);
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001259 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001260
John McCall7f416cc2015-09-08 08:05:57 +00001261 // Otherwise do coercion through memory. This is stupid, but simple.
1262 Address Tmp = CreateTempAllocaForCoercion(CGF, Ty, Src.getAlignment());
Yaxun Liu4bbdebc2018-11-08 16:55:46 +00001263 Address Casted = CGF.Builder.CreateElementBitCast(Tmp,CGF.Int8Ty);
1264 Address SrcCasted = CGF.Builder.CreateElementBitCast(Src,CGF.Int8Ty);
Manman Ren84b921f2012-11-28 22:08:52 +00001265 CGF.Builder.CreateMemCpy(Casted, SrcCasted,
1266 llvm::ConstantInt::get(CGF.IntPtrTy, SrcSize),
John McCall7f416cc2015-09-08 08:05:57 +00001267 false);
1268 return CGF.Builder.CreateLoad(Tmp);
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001269}
1270
Eli Friedmanaf9b3252011-05-17 21:08:01 +00001271// Function to store a first-class aggregate into memory. We prefer to
1272// store the elements rather than the aggregate to be more friendly to
1273// fast-isel.
1274// FIXME: Do we need to recurse here?
1275static void BuildAggStore(CodeGenFunction &CGF, llvm::Value *Val,
John McCall7f416cc2015-09-08 08:05:57 +00001276 Address Dest, bool DestIsVolatile) {
Eli Friedmanaf9b3252011-05-17 21:08:01 +00001277 // Prefer scalar stores to first-class aggregate stores.
Chris Lattner2192fe52011-07-18 04:24:23 +00001278 if (llvm::StructType *STy =
Eli Friedmanaf9b3252011-05-17 21:08:01 +00001279 dyn_cast<llvm::StructType>(Val->getType())) {
1280 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
James Y Knight751fe282019-02-09 22:22:28 +00001281 Address EltPtr = CGF.Builder.CreateStructGEP(Dest, i);
Eli Friedmanaf9b3252011-05-17 21:08:01 +00001282 llvm::Value *Elt = CGF.Builder.CreateExtractValue(Val, i);
John McCall7f416cc2015-09-08 08:05:57 +00001283 CGF.Builder.CreateStore(Elt, EltPtr, DestIsVolatile);
Eli Friedmanaf9b3252011-05-17 21:08:01 +00001284 }
1285 } else {
John McCall7f416cc2015-09-08 08:05:57 +00001286 CGF.Builder.CreateStore(Val, Dest, DestIsVolatile);
Eli Friedmanaf9b3252011-05-17 21:08:01 +00001287 }
1288}
1289
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001290/// CreateCoercedStore - Create a store to \arg DstPtr from \arg Src,
Ulrich Weigand6e2cea62015-07-10 11:31:43 +00001291/// where the source and destination may have different types. The
1292/// destination is known to be aligned to \arg DstAlign bytes.
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001293///
1294/// This safely handles the case when the src type is larger than the
1295/// destination type; the upper bits of the src will be lost.
1296static void CreateCoercedStore(llvm::Value *Src,
John McCall7f416cc2015-09-08 08:05:57 +00001297 Address Dst,
Anders Carlsson17490832009-12-24 20:40:36 +00001298 bool DstIsVolatile,
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001299 CodeGenFunction &CGF) {
Chris Lattner2192fe52011-07-18 04:24:23 +00001300 llvm::Type *SrcTy = Src->getType();
John McCall7f416cc2015-09-08 08:05:57 +00001301 llvm::Type *DstTy = Dst.getType()->getElementType();
Chris Lattnerd200eda2010-06-28 22:51:39 +00001302 if (SrcTy == DstTy) {
John McCall7f416cc2015-09-08 08:05:57 +00001303 CGF.Builder.CreateStore(Src, Dst, DstIsVolatile);
Chris Lattnerd200eda2010-06-28 22:51:39 +00001304 return;
1305 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001306
Micah Villmowdd31ca12012-10-08 16:25:52 +00001307 uint64_t SrcSize = CGF.CGM.getDataLayout().getTypeAllocSize(SrcTy);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001308
Chris Lattner2192fe52011-07-18 04:24:23 +00001309 if (llvm::StructType *DstSTy = dyn_cast<llvm::StructType>(DstTy)) {
John McCall7f416cc2015-09-08 08:05:57 +00001310 Dst = EnterStructPointerForCoercedAccess(Dst, DstSTy, SrcSize, CGF);
1311 DstTy = Dst.getType()->getElementType();
Chris Lattner895c52b2010-06-27 06:04:18 +00001312 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001313
Michael Liao15140e42019-11-04 11:41:07 -05001314 llvm::PointerType *SrcPtrTy = llvm::dyn_cast<llvm::PointerType>(SrcTy);
1315 llvm::PointerType *DstPtrTy = llvm::dyn_cast<llvm::PointerType>(DstTy);
1316 if (SrcPtrTy && DstPtrTy &&
1317 SrcPtrTy->getAddressSpace() != DstPtrTy->getAddressSpace()) {
1318 Src = CGF.Builder.CreatePointerBitCastOrAddrSpaceCast(Src, DstTy);
1319 CGF.Builder.CreateStore(Src, Dst, DstIsVolatile);
1320 return;
1321 }
1322
Chris Lattner055097f2010-06-27 06:26:04 +00001323 // If the source and destination are integer or pointer types, just do an
1324 // extension or truncation to the desired type.
1325 if ((isa<llvm::IntegerType>(SrcTy) || isa<llvm::PointerType>(SrcTy)) &&
1326 (isa<llvm::IntegerType>(DstTy) || isa<llvm::PointerType>(DstTy))) {
1327 Src = CoerceIntOrPtrToIntOrPtr(Src, DstTy, CGF);
John McCall7f416cc2015-09-08 08:05:57 +00001328 CGF.Builder.CreateStore(Src, Dst, DstIsVolatile);
Chris Lattner055097f2010-06-27 06:26:04 +00001329 return;
1330 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001331
Micah Villmowdd31ca12012-10-08 16:25:52 +00001332 uint64_t DstSize = CGF.CGM.getDataLayout().getTypeAllocSize(DstTy);
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001333
Daniel Dunbar313321e2009-02-03 05:31:23 +00001334 // If store is legal, just bitcast the src pointer.
Daniel Dunbar4be99ff2009-06-05 07:58:54 +00001335 if (SrcSize <= DstSize) {
Yaxun Liue9e5c4f2017-06-29 18:47:45 +00001336 Dst = CGF.Builder.CreateElementBitCast(Dst, SrcTy);
John McCall7f416cc2015-09-08 08:05:57 +00001337 BuildAggStore(CGF, Src, Dst, DstIsVolatile);
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001338 } else {
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001339 // Otherwise do coercion through memory. This is stupid, but
1340 // simple.
Daniel Dunbar4be99ff2009-06-05 07:58:54 +00001341
1342 // Generally SrcSize is never greater than DstSize, since this means we are
1343 // losing bits. However, this can happen in cases where the structure has
1344 // additional padding, for example due to a user specified alignment.
1345 //
1346 // FIXME: Assert that we aren't truncating non-padding bits when have access
1347 // to that information.
John McCall7f416cc2015-09-08 08:05:57 +00001348 Address Tmp = CreateTempAllocaForCoercion(CGF, SrcTy, Dst.getAlignment());
1349 CGF.Builder.CreateStore(Src, Tmp);
Yaxun Liu4bbdebc2018-11-08 16:55:46 +00001350 Address Casted = CGF.Builder.CreateElementBitCast(Tmp,CGF.Int8Ty);
1351 Address DstCasted = CGF.Builder.CreateElementBitCast(Dst,CGF.Int8Ty);
Manman Ren84b921f2012-11-28 22:08:52 +00001352 CGF.Builder.CreateMemCpy(DstCasted, Casted,
1353 llvm::ConstantInt::get(CGF.IntPtrTy, DstSize),
John McCall7f416cc2015-09-08 08:05:57 +00001354 false);
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001355 }
1356}
1357
John McCall7f416cc2015-09-08 08:05:57 +00001358static Address emitAddressAtOffset(CodeGenFunction &CGF, Address addr,
Fangrui Song6907ce22018-07-30 19:24:48 +00001359 const ABIArgInfo &info) {
John McCall7f416cc2015-09-08 08:05:57 +00001360 if (unsigned offset = info.getDirectOffset()) {
1361 addr = CGF.Builder.CreateElementBitCast(addr, CGF.Int8Ty);
1362 addr = CGF.Builder.CreateConstInBoundsByteGEP(addr,
1363 CharUnits::fromQuantity(offset));
1364 addr = CGF.Builder.CreateElementBitCast(addr, info.getCoerceToType());
1365 }
1366 return addr;
1367}
1368
Alexey Samsonov153004f2014-09-29 22:08:00 +00001369namespace {
1370
1371/// Encapsulates information about the way function arguments from
1372/// CGFunctionInfo should be passed to actual LLVM IR function.
1373class ClangToLLVMArgMapping {
1374 static const unsigned InvalidIndex = ~0U;
1375 unsigned InallocaArgNo;
1376 unsigned SRetArgNo;
1377 unsigned TotalIRArgs;
1378
1379 /// Arguments of LLVM IR function corresponding to single Clang argument.
1380 struct IRArgs {
1381 unsigned PaddingArgIndex;
1382 // Argument is expanded to IR arguments at positions
1383 // [FirstArgIndex, FirstArgIndex + NumberOfArgs).
1384 unsigned FirstArgIndex;
1385 unsigned NumberOfArgs;
1386
1387 IRArgs()
1388 : PaddingArgIndex(InvalidIndex), FirstArgIndex(InvalidIndex),
1389 NumberOfArgs(0) {}
1390 };
1391
1392 SmallVector<IRArgs, 8> ArgInfo;
1393
1394public:
1395 ClangToLLVMArgMapping(const ASTContext &Context, const CGFunctionInfo &FI,
1396 bool OnlyRequiredArgs = false)
1397 : InallocaArgNo(InvalidIndex), SRetArgNo(InvalidIndex), TotalIRArgs(0),
1398 ArgInfo(OnlyRequiredArgs ? FI.getNumRequiredArgs() : FI.arg_size()) {
1399 construct(Context, FI, OnlyRequiredArgs);
1400 }
1401
1402 bool hasInallocaArg() const { return InallocaArgNo != InvalidIndex; }
1403 unsigned getInallocaArgNo() const {
1404 assert(hasInallocaArg());
1405 return InallocaArgNo;
1406 }
1407
1408 bool hasSRetArg() const { return SRetArgNo != InvalidIndex; }
1409 unsigned getSRetArgNo() const {
1410 assert(hasSRetArg());
1411 return SRetArgNo;
1412 }
1413
1414 unsigned totalIRArgs() const { return TotalIRArgs; }
1415
1416 bool hasPaddingArg(unsigned ArgNo) const {
1417 assert(ArgNo < ArgInfo.size());
1418 return ArgInfo[ArgNo].PaddingArgIndex != InvalidIndex;
1419 }
1420 unsigned getPaddingArgNo(unsigned ArgNo) const {
1421 assert(hasPaddingArg(ArgNo));
1422 return ArgInfo[ArgNo].PaddingArgIndex;
1423 }
1424
1425 /// Returns index of first IR argument corresponding to ArgNo, and their
1426 /// quantity.
1427 std::pair<unsigned, unsigned> getIRArgs(unsigned ArgNo) const {
1428 assert(ArgNo < ArgInfo.size());
1429 return std::make_pair(ArgInfo[ArgNo].FirstArgIndex,
1430 ArgInfo[ArgNo].NumberOfArgs);
1431 }
1432
1433private:
1434 void construct(const ASTContext &Context, const CGFunctionInfo &FI,
1435 bool OnlyRequiredArgs);
1436};
1437
1438void ClangToLLVMArgMapping::construct(const ASTContext &Context,
1439 const CGFunctionInfo &FI,
1440 bool OnlyRequiredArgs) {
1441 unsigned IRArgNo = 0;
1442 bool SwapThisWithSRet = false;
1443 const ABIArgInfo &RetAI = FI.getReturnInfo();
1444
1445 if (RetAI.getKind() == ABIArgInfo::Indirect) {
1446 SwapThisWithSRet = RetAI.isSRetAfterThis();
1447 SRetArgNo = SwapThisWithSRet ? 1 : IRArgNo++;
1448 }
1449
1450 unsigned ArgNo = 0;
1451 unsigned NumArgs = OnlyRequiredArgs ? FI.getNumRequiredArgs() : FI.arg_size();
1452 for (CGFunctionInfo::const_arg_iterator I = FI.arg_begin(); ArgNo < NumArgs;
1453 ++I, ++ArgNo) {
1454 assert(I != FI.arg_end());
1455 QualType ArgType = I->type;
1456 const ABIArgInfo &AI = I->info;
1457 // Collect data about IR arguments corresponding to Clang argument ArgNo.
1458 auto &IRArgs = ArgInfo[ArgNo];
1459
1460 if (AI.getPaddingType())
1461 IRArgs.PaddingArgIndex = IRArgNo++;
1462
1463 switch (AI.getKind()) {
1464 case ABIArgInfo::Extend:
1465 case ABIArgInfo::Direct: {
1466 // FIXME: handle sseregparm someday...
1467 llvm::StructType *STy = dyn_cast<llvm::StructType>(AI.getCoerceToType());
1468 if (AI.isDirect() && AI.getCanBeFlattened() && STy) {
1469 IRArgs.NumberOfArgs = STy->getNumElements();
1470 } else {
1471 IRArgs.NumberOfArgs = 1;
1472 }
1473 break;
1474 }
1475 case ABIArgInfo::Indirect:
1476 IRArgs.NumberOfArgs = 1;
1477 break;
1478 case ABIArgInfo::Ignore:
1479 case ABIArgInfo::InAlloca:
1480 // ignore and inalloca doesn't have matching LLVM parameters.
1481 IRArgs.NumberOfArgs = 0;
1482 break;
John McCallf26e73d2016-03-11 04:30:43 +00001483 case ABIArgInfo::CoerceAndExpand:
1484 IRArgs.NumberOfArgs = AI.getCoerceAndExpandTypeSequence().size();
1485 break;
1486 case ABIArgInfo::Expand:
Alexey Samsonov153004f2014-09-29 22:08:00 +00001487 IRArgs.NumberOfArgs = getExpansionSize(ArgType, Context);
1488 break;
1489 }
Alexey Samsonov153004f2014-09-29 22:08:00 +00001490
1491 if (IRArgs.NumberOfArgs > 0) {
1492 IRArgs.FirstArgIndex = IRArgNo;
1493 IRArgNo += IRArgs.NumberOfArgs;
1494 }
1495
1496 // Skip over the sret parameter when it comes second. We already handled it
1497 // above.
1498 if (IRArgNo == 1 && SwapThisWithSRet)
1499 IRArgNo++;
1500 }
1501 assert(ArgNo == ArgInfo.size());
1502
1503 if (FI.usesInAlloca())
1504 InallocaArgNo = IRArgNo++;
1505
1506 TotalIRArgs = IRArgNo;
1507}
1508} // namespace
1509
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00001510/***/
1511
Daniel Dunbar6f2e8392010-07-14 23:39:36 +00001512bool CodeGenModule::ReturnTypeUsesSRet(const CGFunctionInfo &FI) {
Saleem Abdulrasoolf181f1a2018-02-28 20:16:12 +00001513 const auto &RI = FI.getReturnInfo();
1514 return RI.isIndirect() || (RI.isInAlloca() && RI.getInAllocaSRet());
Daniel Dunbar7633cbf2009-02-02 21:43:58 +00001515}
1516
Tim Northovere77cc392014-03-29 13:28:05 +00001517bool CodeGenModule::ReturnSlotInterferesWithArgs(const CGFunctionInfo &FI) {
1518 return ReturnTypeUsesSRet(FI) &&
1519 getTargetCodeGenInfo().doesReturnSlotInterfereWithArgs();
1520}
1521
Daniel Dunbar6f2e8392010-07-14 23:39:36 +00001522bool CodeGenModule::ReturnTypeUsesFPRet(QualType ResultType) {
1523 if (const BuiltinType *BT = ResultType->getAs<BuiltinType>()) {
1524 switch (BT->getKind()) {
1525 default:
1526 return false;
1527 case BuiltinType::Float:
John McCallc8e01702013-04-16 22:48:15 +00001528 return getTarget().useObjCFPRetForRealType(TargetInfo::Float);
Daniel Dunbar6f2e8392010-07-14 23:39:36 +00001529 case BuiltinType::Double:
John McCallc8e01702013-04-16 22:48:15 +00001530 return getTarget().useObjCFPRetForRealType(TargetInfo::Double);
Daniel Dunbar6f2e8392010-07-14 23:39:36 +00001531 case BuiltinType::LongDouble:
John McCallc8e01702013-04-16 22:48:15 +00001532 return getTarget().useObjCFPRetForRealType(TargetInfo::LongDouble);
Daniel Dunbar6f2e8392010-07-14 23:39:36 +00001533 }
1534 }
1535
1536 return false;
1537}
1538
Anders Carlsson2f1a6c32011-10-31 16:27:11 +00001539bool CodeGenModule::ReturnTypeUsesFP2Ret(QualType ResultType) {
1540 if (const ComplexType *CT = ResultType->getAs<ComplexType>()) {
1541 if (const BuiltinType *BT = CT->getElementType()->getAs<BuiltinType>()) {
1542 if (BT->getKind() == BuiltinType::LongDouble)
John McCallc8e01702013-04-16 22:48:15 +00001543 return getTarget().useObjCFP2RetForComplexLongDouble();
Anders Carlsson2f1a6c32011-10-31 16:27:11 +00001544 }
1545 }
1546
1547 return false;
1548}
1549
Chris Lattnera5f58b02011-07-09 17:41:47 +00001550llvm::FunctionType *CodeGenTypes::GetFunctionType(GlobalDecl GD) {
John McCalla729c622012-02-17 03:33:10 +00001551 const CGFunctionInfo &FI = arrangeGlobalDeclaration(GD);
1552 return GetFunctionType(FI);
John McCallf8ff7b92010-02-23 00:48:20 +00001553}
1554
Chris Lattnera5f58b02011-07-09 17:41:47 +00001555llvm::FunctionType *
John McCalla729c622012-02-17 03:33:10 +00001556CodeGenTypes::GetFunctionType(const CGFunctionInfo &FI) {
Alexey Samsonov153004f2014-09-29 22:08:00 +00001557
David Blaikie82e95a32014-11-19 07:49:47 +00001558 bool Inserted = FunctionsBeingProcessed.insert(&FI).second;
1559 (void)Inserted;
Chris Lattner6fb0ccf2011-07-15 05:16:14 +00001560 assert(Inserted && "Recursively being processed?");
Daniel Dunbar7a95ca32008-09-10 04:01:49 +00001561
Alexey Samsonov153004f2014-09-29 22:08:00 +00001562 llvm::Type *resultType = nullptr;
John McCall85dd2c52011-05-15 02:19:42 +00001563 const ABIArgInfo &retAI = FI.getReturnInfo();
1564 switch (retAI.getKind()) {
Daniel Dunbard3674e62008-09-11 01:48:57 +00001565 case ABIArgInfo::Expand:
John McCall85dd2c52011-05-15 02:19:42 +00001566 llvm_unreachable("Invalid ABI kind for return argument");
Daniel Dunbard3674e62008-09-11 01:48:57 +00001567
Anton Korobeynikov18adbf52009-06-06 09:36:29 +00001568 case ABIArgInfo::Extend:
Daniel Dunbar67dace892009-02-03 06:17:37 +00001569 case ABIArgInfo::Direct:
John McCall85dd2c52011-05-15 02:19:42 +00001570 resultType = retAI.getCoerceToType();
Daniel Dunbar67dace892009-02-03 06:17:37 +00001571 break;
1572
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001573 case ABIArgInfo::InAlloca:
Reid Klecknerfab1e892014-02-25 00:59:14 +00001574 if (retAI.getInAllocaSRet()) {
1575 // sret things on win32 aren't void, they return the sret pointer.
1576 QualType ret = FI.getReturnType();
1577 llvm::Type *ty = ConvertType(ret);
1578 unsigned addressSpace = Context.getTargetAddressSpace(ret);
1579 resultType = llvm::PointerType::get(ty, addressSpace);
1580 } else {
1581 resultType = llvm::Type::getVoidTy(getLLVMContext());
1582 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001583 break;
1584
John McCall7f416cc2015-09-08 08:05:57 +00001585 case ABIArgInfo::Indirect:
Daniel Dunbar94a6f252009-01-26 21:26:08 +00001586 case ABIArgInfo::Ignore:
John McCall85dd2c52011-05-15 02:19:42 +00001587 resultType = llvm::Type::getVoidTy(getLLVMContext());
Daniel Dunbar94a6f252009-01-26 21:26:08 +00001588 break;
John McCallf26e73d2016-03-11 04:30:43 +00001589
1590 case ABIArgInfo::CoerceAndExpand:
1591 resultType = retAI.getUnpaddedCoerceAndExpandType();
1592 break;
Daniel Dunbar7a95ca32008-09-10 04:01:49 +00001593 }
Mike Stump11289f42009-09-09 15:08:12 +00001594
Alexey Samsonov153004f2014-09-29 22:08:00 +00001595 ClangToLLVMArgMapping IRFunctionArgs(getContext(), FI, true);
1596 SmallVector<llvm::Type*, 8> ArgTypes(IRFunctionArgs.totalIRArgs());
1597
1598 // Add type for sret argument.
1599 if (IRFunctionArgs.hasSRetArg()) {
1600 QualType Ret = FI.getReturnType();
1601 llvm::Type *Ty = ConvertType(Ret);
1602 unsigned AddressSpace = Context.getTargetAddressSpace(Ret);
1603 ArgTypes[IRFunctionArgs.getSRetArgNo()] =
1604 llvm::PointerType::get(Ty, AddressSpace);
1605 }
1606
1607 // Add type for inalloca argument.
1608 if (IRFunctionArgs.hasInallocaArg()) {
1609 auto ArgStruct = FI.getArgStruct();
1610 assert(ArgStruct);
1611 ArgTypes[IRFunctionArgs.getInallocaArgNo()] = ArgStruct->getPointerTo();
1612 }
1613
John McCallc818bbb2012-12-07 07:03:17 +00001614 // Add in all of the required arguments.
Alexey Samsonov153004f2014-09-29 22:08:00 +00001615 unsigned ArgNo = 0;
Alexey Samsonov34625dd2014-09-29 21:21:48 +00001616 CGFunctionInfo::const_arg_iterator it = FI.arg_begin(),
1617 ie = it + FI.getNumRequiredArgs();
Alexey Samsonov153004f2014-09-29 22:08:00 +00001618 for (; it != ie; ++it, ++ArgNo) {
1619 const ABIArgInfo &ArgInfo = it->info;
Mike Stump11289f42009-09-09 15:08:12 +00001620
Rafael Espindolafad28de2012-10-24 01:59:00 +00001621 // Insert a padding type to ensure proper alignment.
Alexey Samsonov153004f2014-09-29 22:08:00 +00001622 if (IRFunctionArgs.hasPaddingArg(ArgNo))
1623 ArgTypes[IRFunctionArgs.getPaddingArgNo(ArgNo)] =
1624 ArgInfo.getPaddingType();
Rafael Espindolafad28de2012-10-24 01:59:00 +00001625
Alexey Samsonov153004f2014-09-29 22:08:00 +00001626 unsigned FirstIRArg, NumIRArgs;
1627 std::tie(FirstIRArg, NumIRArgs) = IRFunctionArgs.getIRArgs(ArgNo);
1628
1629 switch (ArgInfo.getKind()) {
Daniel Dunbar94a6f252009-01-26 21:26:08 +00001630 case ABIArgInfo::Ignore:
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001631 case ABIArgInfo::InAlloca:
Alexey Samsonov153004f2014-09-29 22:08:00 +00001632 assert(NumIRArgs == 0);
Daniel Dunbar94a6f252009-01-26 21:26:08 +00001633 break;
1634
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00001635 case ABIArgInfo::Indirect: {
Alexey Samsonov153004f2014-09-29 22:08:00 +00001636 assert(NumIRArgs == 1);
Yaxun Liud7523282017-04-17 20:10:44 +00001637 // indirect arguments are always on the stack, which is alloca addr space.
Chris Lattner2192fe52011-07-18 04:24:23 +00001638 llvm::Type *LTy = ConvertTypeForMem(it->type);
Yaxun Liud7523282017-04-17 20:10:44 +00001639 ArgTypes[FirstIRArg] = LTy->getPointerTo(
1640 CGM.getDataLayout().getAllocaAddrSpace());
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00001641 break;
1642 }
1643
1644 case ABIArgInfo::Extend:
Chris Lattner2cdfda42010-07-29 06:44:09 +00001645 case ABIArgInfo::Direct: {
Oliver Stannard2bfdc5b2014-08-27 10:43:15 +00001646 // Fast-isel and the optimizer generally like scalar values better than
1647 // FCAs, so we flatten them if this is safe to do for this argument.
Alexey Samsonov153004f2014-09-29 22:08:00 +00001648 llvm::Type *argType = ArgInfo.getCoerceToType();
James Molloy6f244b62014-05-09 16:21:39 +00001649 llvm::StructType *st = dyn_cast<llvm::StructType>(argType);
Alexey Samsonov153004f2014-09-29 22:08:00 +00001650 if (st && ArgInfo.isDirect() && ArgInfo.getCanBeFlattened()) {
1651 assert(NumIRArgs == st->getNumElements());
John McCall85dd2c52011-05-15 02:19:42 +00001652 for (unsigned i = 0, e = st->getNumElements(); i != e; ++i)
Alexey Samsonov153004f2014-09-29 22:08:00 +00001653 ArgTypes[FirstIRArg + i] = st->getElementType(i);
Chris Lattner3dd716c2010-06-28 23:44:11 +00001654 } else {
Alexey Samsonov153004f2014-09-29 22:08:00 +00001655 assert(NumIRArgs == 1);
1656 ArgTypes[FirstIRArg] = argType;
Chris Lattner3dd716c2010-06-28 23:44:11 +00001657 }
Daniel Dunbar2f219b02009-02-03 19:12:28 +00001658 break;
Chris Lattner2cdfda42010-07-29 06:44:09 +00001659 }
Mike Stump11289f42009-09-09 15:08:12 +00001660
John McCallf26e73d2016-03-11 04:30:43 +00001661 case ABIArgInfo::CoerceAndExpand: {
1662 auto ArgTypesIter = ArgTypes.begin() + FirstIRArg;
1663 for (auto EltTy : ArgInfo.getCoerceAndExpandTypeSequence()) {
1664 *ArgTypesIter++ = EltTy;
1665 }
1666 assert(ArgTypesIter == ArgTypes.begin() + FirstIRArg + NumIRArgs);
1667 break;
1668 }
1669
Daniel Dunbard3674e62008-09-11 01:48:57 +00001670 case ABIArgInfo::Expand:
Alexey Samsonov153004f2014-09-29 22:08:00 +00001671 auto ArgTypesIter = ArgTypes.begin() + FirstIRArg;
1672 getExpandedTypes(it->type, ArgTypesIter);
1673 assert(ArgTypesIter == ArgTypes.begin() + FirstIRArg + NumIRArgs);
Daniel Dunbard3674e62008-09-11 01:48:57 +00001674 break;
1675 }
Daniel Dunbar7a95ca32008-09-10 04:01:49 +00001676 }
1677
Chris Lattner6fb0ccf2011-07-15 05:16:14 +00001678 bool Erased = FunctionsBeingProcessed.erase(&FI); (void)Erased;
1679 assert(Erased && "Not in set?");
Alexey Samsonov153004f2014-09-29 22:08:00 +00001680
1681 return llvm::FunctionType::get(resultType, ArgTypes, FI.isVariadic());
Daniel Dunbar81cf67f2008-09-09 23:48:28 +00001682}
1683
Chris Lattner2192fe52011-07-18 04:24:23 +00001684llvm::Type *CodeGenTypes::GetFunctionTypeForVTable(GlobalDecl GD) {
John McCall5d865c322010-08-31 07:33:07 +00001685 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
Anders Carlsson64457732009-11-24 05:08:52 +00001686 const FunctionProtoType *FPT = MD->getType()->getAs<FunctionProtoType>();
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001687
Chris Lattner8806e322011-07-10 00:18:59 +00001688 if (!isFuncTypeConvertible(FPT))
1689 return llvm::StructType::get(getLLVMContext());
Fangrui Song6907ce22018-07-30 19:24:48 +00001690
Peter Collingbourned1c5b282019-03-22 23:05:10 +00001691 return GetFunctionType(GD);
Anders Carlsson64457732009-11-24 05:08:52 +00001692}
1693
Samuel Antao798f11c2015-11-23 22:04:44 +00001694static void AddAttributesFromFunctionProtoType(ASTContext &Ctx,
1695 llvm::AttrBuilder &FuncAttrs,
1696 const FunctionProtoType *FPT) {
1697 if (!FPT)
1698 return;
1699
1700 if (!isUnresolvedExceptionSpec(FPT->getExceptionSpecType()) &&
Richard Smitheaf11ad2018-05-03 03:58:32 +00001701 FPT->isNothrow())
Samuel Antao798f11c2015-11-23 22:04:44 +00001702 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
1703}
1704
Justin Lebarb080b632017-01-25 21:29:48 +00001705void CodeGenModule::ConstructDefaultFnAttrList(StringRef Name, bool HasOptnone,
1706 bool AttrOnCallSite,
1707 llvm::AttrBuilder &FuncAttrs) {
1708 // OptimizeNoneAttr takes precedence over -Os or -Oz. No warning needed.
1709 if (!HasOptnone) {
1710 if (CodeGenOpts.OptimizeSize)
1711 FuncAttrs.addAttribute(llvm::Attribute::OptimizeForSize);
1712 if (CodeGenOpts.OptimizeSize == 2)
1713 FuncAttrs.addAttribute(llvm::Attribute::MinSize);
1714 }
1715
1716 if (CodeGenOpts.DisableRedZone)
1717 FuncAttrs.addAttribute(llvm::Attribute::NoRedZone);
Kristina Brooks7f569b72018-10-18 14:07:02 +00001718 if (CodeGenOpts.IndirectTlsSegRefs)
1719 FuncAttrs.addAttribute("indirect-tls-seg-refs");
Justin Lebarb080b632017-01-25 21:29:48 +00001720 if (CodeGenOpts.NoImplicitFloat)
1721 FuncAttrs.addAttribute(llvm::Attribute::NoImplicitFloat);
1722
1723 if (AttrOnCallSite) {
1724 // Attributes that should go on the call site only.
1725 if (!CodeGenOpts.SimplifyLibCalls ||
1726 CodeGenOpts.isNoBuiltinFunc(Name.data()))
1727 FuncAttrs.addAttribute(llvm::Attribute::NoBuiltin);
1728 if (!CodeGenOpts.TrapFuncName.empty())
1729 FuncAttrs.addAttribute("trap-func-name", CodeGenOpts.TrapFuncName);
1730 } else {
Yuanfang Chenff22ec32019-07-20 22:50:50 +00001731 StringRef FpKind;
1732 switch (CodeGenOpts.getFramePointer()) {
1733 case CodeGenOptions::FramePointerKind::None:
1734 FpKind = "none";
1735 break;
1736 case CodeGenOptions::FramePointerKind::NonLeaf:
1737 FpKind = "non-leaf";
1738 break;
1739 case CodeGenOptions::FramePointerKind::All:
1740 FpKind = "all";
1741 break;
Justin Lebarb080b632017-01-25 21:29:48 +00001742 }
Yuanfang Chenff22ec32019-07-20 22:50:50 +00001743 FuncAttrs.addAttribute("frame-pointer", FpKind);
Justin Lebarb080b632017-01-25 21:29:48 +00001744
1745 FuncAttrs.addAttribute("less-precise-fpmad",
1746 llvm::toStringRef(CodeGenOpts.LessPreciseFPMAD));
1747
Manoj Guptada08f6a2018-07-19 00:44:52 +00001748 if (CodeGenOpts.NullPointerIsValid)
1749 FuncAttrs.addAttribute("null-pointer-is-valid", "true");
Matt Arsenaulta4451d82019-11-01 17:57:29 -07001750
Matt Arsenaulta4e71f02019-11-06 10:26:43 -08001751 if (CodeGenOpts.FPDenormalMode != llvm::DenormalMode::getIEEE())
Matt Arsenault7fe94352019-10-29 16:16:05 -07001752 FuncAttrs.addAttribute("denormal-fp-math",
Matt Arsenaulta3c814d2019-11-06 17:10:52 -08001753 CodeGenOpts.FPDenormalMode.str());
Matt Arsenaulta4e71f02019-11-06 10:26:43 -08001754 if (CodeGenOpts.FP32DenormalMode != CodeGenOpts.FPDenormalMode) {
Matt Arsenaulta4451d82019-11-01 17:57:29 -07001755 FuncAttrs.addAttribute(
1756 "denormal-fp-math-f32",
Matt Arsenaulta3c814d2019-11-06 17:10:52 -08001757 CodeGenOpts.FP32DenormalMode.str());
1758 }
Matt Arsenaulta4451d82019-11-01 17:57:29 -07001759
Justin Lebarb080b632017-01-25 21:29:48 +00001760 FuncAttrs.addAttribute("no-trapping-math",
1761 llvm::toStringRef(CodeGenOpts.NoTrappingMath));
1762
Sanjay Patelc81450e2018-04-30 18:19:03 +00001763 // Strict (compliant) code is the default, so only add this attribute to
1764 // indicate that we are trying to workaround a problem case.
1765 if (!CodeGenOpts.StrictFloatCastOverflow)
1766 FuncAttrs.addAttribute("strict-float-cast-overflow", "false");
Sanjay Pateld1754762018-04-27 14:22:48 +00001767
Justin Lebarb080b632017-01-25 21:29:48 +00001768 // TODO: Are these all needed?
1769 // unsafe/inf/nan/nsz are handled by instruction-level FastMathFlags.
1770 FuncAttrs.addAttribute("no-infs-fp-math",
1771 llvm::toStringRef(CodeGenOpts.NoInfsFPMath));
1772 FuncAttrs.addAttribute("no-nans-fp-math",
1773 llvm::toStringRef(CodeGenOpts.NoNaNsFPMath));
1774 FuncAttrs.addAttribute("unsafe-fp-math",
1775 llvm::toStringRef(CodeGenOpts.UnsafeFPMath));
1776 FuncAttrs.addAttribute("use-soft-float",
1777 llvm::toStringRef(CodeGenOpts.SoftFloat));
1778 FuncAttrs.addAttribute("stack-protector-buffer-size",
1779 llvm::utostr(CodeGenOpts.SSPBufferSize));
1780 FuncAttrs.addAttribute("no-signed-zeros-fp-math",
1781 llvm::toStringRef(CodeGenOpts.NoSignedZeros));
1782 FuncAttrs.addAttribute(
1783 "correctly-rounded-divide-sqrt-fp-math",
1784 llvm::toStringRef(CodeGenOpts.CorrectlyRoundedDivSqrt));
1785
1786 // TODO: Reciprocal estimate codegen options should apply to instructions?
Craig Topper402b4312017-11-20 17:09:22 +00001787 const std::vector<std::string> &Recips = CodeGenOpts.Reciprocals;
Justin Lebarb080b632017-01-25 21:29:48 +00001788 if (!Recips.empty())
1789 FuncAttrs.addAttribute("reciprocal-estimates",
Erich Keane857ac592017-10-27 18:45:06 +00001790 llvm::join(Recips, ","));
Justin Lebarb080b632017-01-25 21:29:48 +00001791
Craig Topper9a724aa2017-12-11 21:09:19 +00001792 if (!CodeGenOpts.PreferVectorWidth.empty() &&
1793 CodeGenOpts.PreferVectorWidth != "none")
1794 FuncAttrs.addAttribute("prefer-vector-width",
1795 CodeGenOpts.PreferVectorWidth);
1796
Justin Lebarb080b632017-01-25 21:29:48 +00001797 if (CodeGenOpts.StackRealignment)
1798 FuncAttrs.addAttribute("stackrealign");
1799 if (CodeGenOpts.Backchain)
1800 FuncAttrs.addAttribute("backchain");
Chandler Carruth664aa862018-09-04 12:38:00 +00001801
1802 if (CodeGenOpts.SpeculativeLoadHardening)
1803 FuncAttrs.addAttribute(llvm::Attribute::SpeculativeLoadHardening);
Justin Lebarb080b632017-01-25 21:29:48 +00001804 }
1805
Matt Arsenaulta1cf61b2017-10-06 19:34:40 +00001806 if (getLangOpts().assumeFunctionsAreConvergent()) {
1807 // Conservatively, mark all functions and calls in CUDA and OpenCL as
1808 // convergent (meaning, they may call an intrinsically convergent op, such
1809 // as __syncthreads() / barrier(), and so can't have certain optimizations
1810 // applied around them). LLVM will remove this attribute where it safely
1811 // can.
Justin Lebarb080b632017-01-25 21:29:48 +00001812 FuncAttrs.addAttribute(llvm::Attribute::Convergent);
Matt Arsenaulta1cf61b2017-10-06 19:34:40 +00001813 }
Justin Lebarb080b632017-01-25 21:29:48 +00001814
Matt Arsenaulta1cf61b2017-10-06 19:34:40 +00001815 if (getLangOpts().CUDA && getLangOpts().CUDAIsDevice) {
Justin Lebarb080b632017-01-25 21:29:48 +00001816 // Exceptions aren't supported in CUDA device code.
1817 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
Justin Lebarb080b632017-01-25 21:29:48 +00001818 }
Peter Collingbourne87f477b2019-01-04 19:27:04 +00001819
1820 for (StringRef Attr : CodeGenOpts.DefaultFunctionAttrs) {
1821 StringRef Var, Value;
1822 std::tie(Var, Value) = Attr.split('=');
1823 FuncAttrs.addAttribute(Var, Value);
1824 }
Justin Lebarb080b632017-01-25 21:29:48 +00001825}
1826
1827void CodeGenModule::AddDefaultFnAttrs(llvm::Function &F) {
1828 llvm::AttrBuilder FuncAttrs;
Evandro Menezes85bd3972019-04-04 22:40:06 +00001829 ConstructDefaultFnAttrList(F.getName(), F.hasOptNone(),
Rui Ueyama49a3ad22019-07-16 04:46:31 +00001830 /* AttrOnCallSite = */ false, FuncAttrs);
Reid Kleckneree4930b2017-05-02 22:07:37 +00001831 F.addAttributes(llvm::AttributeList::FunctionIndex, FuncAttrs);
Justin Lebarb080b632017-01-25 21:29:48 +00001832}
1833
Francis Visoiu Mistrih4e799ad2020-01-27 10:40:14 -08001834static void addNoBuiltinAttributes(llvm::AttrBuilder &FuncAttrs,
1835 const LangOptions &LangOpts,
1836 const NoBuiltinAttr *NBA = nullptr) {
1837 auto AddNoBuiltinAttr = [&FuncAttrs](StringRef BuiltinName) {
1838 SmallString<32> AttributeName;
1839 AttributeName += "no-builtin-";
1840 AttributeName += BuiltinName;
1841 FuncAttrs.addAttribute(AttributeName);
1842 };
1843
Francis Visoiu Mistrihb1a81892020-01-28 15:23:28 -08001844 // First, handle the language options passed through -fno-builtin.
Francis Visoiu Mistrih4e799ad2020-01-27 10:40:14 -08001845 if (LangOpts.NoBuiltin) {
1846 // -fno-builtin disables them all.
1847 FuncAttrs.addAttribute("no-builtins");
1848 return;
1849 }
1850
1851 // Then, add attributes for builtins specified through -fno-builtin-<name>.
1852 llvm::for_each(LangOpts.NoBuiltinFuncs, AddNoBuiltinAttr);
1853
1854 // Now, let's check the __attribute__((no_builtin("...")) attribute added to
1855 // the source.
1856 if (!NBA)
1857 return;
1858
1859 // If there is a wildcard in the builtin names specified through the
1860 // attribute, disable them all.
1861 if (llvm::is_contained(NBA->builtinNames(), "*")) {
1862 FuncAttrs.addAttribute("no-builtins");
1863 return;
1864 }
1865
1866 // And last, add the rest of the builtin names.
1867 llvm::for_each(NBA->builtinNames(), AddNoBuiltinAttr);
1868}
1869
Chad Rosier7dbc9cf2016-01-06 14:35:46 +00001870void CodeGenModule::ConstructAttributeList(
1871 StringRef Name, const CGFunctionInfo &FI, CGCalleeInfo CalleeInfo,
Reid Klecknercdd26792017-04-18 23:50:03 +00001872 llvm::AttributeList &AttrList, unsigned &CallingConv, bool AttrOnCallSite) {
Bill Wendlinga514ebc2012-10-15 20:36:26 +00001873 llvm::AttrBuilder FuncAttrs;
1874 llvm::AttrBuilder RetAttrs;
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00001875
Daniel Dunbar0ef34792009-09-12 00:59:20 +00001876 CallingConv = FI.getEffectiveCallingConvention();
John McCallab26cfa2010-02-05 21:31:56 +00001877 if (FI.isNoReturn())
Bill Wendling207f0532012-12-20 19:27:06 +00001878 FuncAttrs.addAttribute(llvm::Attribute::NoReturn);
John McCallab26cfa2010-02-05 21:31:56 +00001879
Samuel Antao798f11c2015-11-23 22:04:44 +00001880 // If we have information about the function prototype, we can learn
Craig Topper13d759f2018-04-30 22:02:48 +00001881 // attributes from there.
Samuel Antao798f11c2015-11-23 22:04:44 +00001882 AddAttributesFromFunctionProtoType(getContext(), FuncAttrs,
1883 CalleeInfo.getCalleeFunctionProtoType());
1884
Erich Keanede6480a32018-11-13 15:48:08 +00001885 const Decl *TargetDecl = CalleeInfo.getCalleeDecl().getDecl();
Samuel Antao798f11c2015-11-23 22:04:44 +00001886
Justin Lebarb080b632017-01-25 21:29:48 +00001887 bool HasOptnone = false;
Francis Visoiu Mistrih4e799ad2020-01-27 10:40:14 -08001888 // The NoBuiltinAttr attached to a TargetDecl (only allowed on FunctionDecls).
1889 const NoBuiltinAttr *NBA = nullptr;
Anton Korobeynikovc8478242009-04-04 00:49:24 +00001890 // FIXME: handle sseregparm someday...
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00001891 if (TargetDecl) {
Rafael Espindola2d21ab02011-10-12 19:51:18 +00001892 if (TargetDecl->hasAttr<ReturnsTwiceAttr>())
Bill Wendling207f0532012-12-20 19:27:06 +00001893 FuncAttrs.addAttribute(llvm::Attribute::ReturnsTwice);
Argyrios Kyrtzidisb4b64ca2009-06-30 02:34:44 +00001894 if (TargetDecl->hasAttr<NoThrowAttr>())
Bill Wendling207f0532012-12-20 19:27:06 +00001895 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
Richard Smithdebc59d2013-01-30 05:45:05 +00001896 if (TargetDecl->hasAttr<NoReturnAttr>())
1897 FuncAttrs.addAttribute(llvm::Attribute::NoReturn);
Xinliang David Li4ec36062017-06-13 21:14:07 +00001898 if (TargetDecl->hasAttr<ColdAttr>())
1899 FuncAttrs.addAttribute(llvm::Attribute::Cold);
Aaron Ballman7c19ab12014-02-22 16:59:24 +00001900 if (TargetDecl->hasAttr<NoDuplicateAttr>())
1901 FuncAttrs.addAttribute(llvm::Attribute::NoDuplicate);
Yaxun Liu7d07ae72016-11-01 18:45:32 +00001902 if (TargetDecl->hasAttr<ConvergentAttr>())
1903 FuncAttrs.addAttribute(llvm::Attribute::Convergent);
Richard Smithdebc59d2013-01-30 05:45:05 +00001904
Chandler Carruth45bbe012017-03-24 09:11:57 +00001905 if (const FunctionDecl *Fn = dyn_cast<FunctionDecl>(TargetDecl)) {
Samuel Antao798f11c2015-11-23 22:04:44 +00001906 AddAttributesFromFunctionProtoType(
Chandler Carruth45bbe012017-03-24 09:11:57 +00001907 getContext(), FuncAttrs, Fn->getType()->getAs<FunctionProtoType>());
Roman Lebedev3dd5a292020-02-26 01:37:17 +03001908 if (AttrOnCallSite && Fn->isReplaceableGlobalAllocationFunction()) {
1909 // A sane operator new returns a non-aliasing pointer.
1910 auto Kind = Fn->getDeclName().getCXXOverloadedOperator();
1911 if (getCodeGenOpts().AssumeSaneOperatorNew &&
1912 (Kind == OO_New || Kind == OO_Array_New))
1913 RetAttrs.addAttribute(llvm::Attribute::NoAlias);
1914 }
Chandler Carruth45bbe012017-03-24 09:11:57 +00001915 const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(Fn);
Guillaume Chatelet98f31512019-09-25 11:31:28 +02001916 const bool IsVirtualCall = MD && MD->isVirtual();
1917 // Don't use [[noreturn]], _Noreturn or [[no_builtin]] for a call to a
1918 // virtual function. These attributes are not inherited by overloads.
1919 if (!(AttrOnCallSite && IsVirtualCall)) {
1920 if (Fn->isNoReturn())
1921 FuncAttrs.addAttribute(llvm::Attribute::NoReturn);
Francis Visoiu Mistrih4e799ad2020-01-27 10:40:14 -08001922 NBA = Fn->getAttr<NoBuiltinAttr>();
Guillaume Chatelet98f31512019-09-25 11:31:28 +02001923 }
John McCallbe349de2010-07-08 06:48:12 +00001924 }
1925
David Majnemer1bf0f8e2015-07-20 22:51:52 +00001926 // 'const', 'pure' and 'noalias' attributed functions are also nounwind.
Eric Christopherbf005ec2011-08-15 22:38:22 +00001927 if (TargetDecl->hasAttr<ConstAttr>()) {
Bill Wendling207f0532012-12-20 19:27:06 +00001928 FuncAttrs.addAttribute(llvm::Attribute::ReadNone);
1929 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
Eric Christopherbf005ec2011-08-15 22:38:22 +00001930 } else if (TargetDecl->hasAttr<PureAttr>()) {
Bill Wendling207f0532012-12-20 19:27:06 +00001931 FuncAttrs.addAttribute(llvm::Attribute::ReadOnly);
1932 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
David Majnemer1bf0f8e2015-07-20 22:51:52 +00001933 } else if (TargetDecl->hasAttr<NoAliasAttr>()) {
1934 FuncAttrs.addAttribute(llvm::Attribute::ArgMemOnly);
1935 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
Eric Christopherbf005ec2011-08-15 22:38:22 +00001936 }
David Majnemer631a90b2015-02-04 07:23:21 +00001937 if (TargetDecl->hasAttr<RestrictAttr>())
Bill Wendling207f0532012-12-20 19:27:06 +00001938 RetAttrs.addAttribute(llvm::Attribute::NoAlias);
Manoj Guptada08f6a2018-07-19 00:44:52 +00001939 if (TargetDecl->hasAttr<ReturnsNonNullAttr>() &&
1940 !CodeGenOpts.NullPointerIsValid)
Hal Finkeld8442b12014-07-12 04:51:04 +00001941 RetAttrs.addAttribute(llvm::Attribute::NonNull);
Oren Ben Simhon318a6ea2017-04-27 12:01:00 +00001942 if (TargetDecl->hasAttr<AnyX86NoCallerSavedRegistersAttr>())
1943 FuncAttrs.addAttribute("no_caller_saved_registers");
Oren Ben Simhon220671a2018-03-17 13:31:35 +00001944 if (TargetDecl->hasAttr<AnyX86NoCfCheckAttr>())
1945 FuncAttrs.addAttribute(llvm::Attribute::NoCfCheck);
Paul Robinson08556952014-12-11 20:14:04 +00001946
1947 HasOptnone = TargetDecl->hasAttr<OptimizeNoneAttr>();
George Burgess IVe3763372016-12-22 02:50:20 +00001948 if (auto *AllocSize = TargetDecl->getAttr<AllocSizeAttr>()) {
1949 Optional<unsigned> NumElemsParam;
Joel E. Denny81508102018-03-13 14:51:22 +00001950 if (AllocSize->getNumElemsParam().isValid())
1951 NumElemsParam = AllocSize->getNumElemsParam().getLLVMIndex();
1952 FuncAttrs.addAllocSizeAttr(AllocSize->getElemSizeParam().getLLVMIndex(),
George Burgess IVe3763372016-12-22 02:50:20 +00001953 NumElemsParam);
1954 }
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00001955 }
1956
Francis Visoiu Mistrih4e799ad2020-01-27 10:40:14 -08001957 // Attach "no-builtins" attributes to:
1958 // * call sites: both `nobuiltin` and "no-builtins" or "no-builtin-<name>".
1959 // * definitions: "no-builtins" or "no-builtin-<name>" only.
1960 // The attributes can come from:
1961 // * LangOpts: -ffreestanding, -fno-builtin, -fno-builtin-<name>
1962 // * FunctionDecl attributes: __attribute__((no_builtin(...)))
1963 addNoBuiltinAttributes(FuncAttrs, getLangOpts(), NBA);
1964
Justin Lebarb080b632017-01-25 21:29:48 +00001965 ConstructDefaultFnAttrList(Name, HasOptnone, AttrOnCallSite, FuncAttrs);
Paul Robinson08556952014-12-11 20:14:04 +00001966
Zola Bridges826ef592019-01-18 17:20:46 +00001967 // This must run after constructing the default function attribute list
1968 // to ensure that the speculative load hardening attribute is removed
1969 // in the case where the -mspeculative-load-hardening flag was passed.
1970 if (TargetDecl) {
1971 if (TargetDecl->hasAttr<NoSpeculativeLoadHardeningAttr>())
1972 FuncAttrs.removeAttribute(llvm::Attribute::SpeculativeLoadHardening);
1973 if (TargetDecl->hasAttr<SpeculativeLoadHardeningAttr>())
1974 FuncAttrs.addAttribute(llvm::Attribute::SpeculativeLoadHardening);
1975 }
1976
Peter Collingbourneb4728c12014-05-19 22:14:34 +00001977 if (CodeGenOpts.EnableSegmentedStacks &&
1978 !(TargetDecl && TargetDecl->hasAttr<NoSplitStackAttr>()))
Reid Klecknerfb873af2014-04-10 22:59:13 +00001979 FuncAttrs.addAttribute("split-stack");
Devang Patel6e467b12009-06-04 23:32:02 +00001980
Sriraman Tallam5c651482017-11-07 19:37:51 +00001981 // Add NonLazyBind attribute to function declarations when -fno-plt
1982 // is used.
1983 if (TargetDecl && CodeGenOpts.NoPLT) {
1984 if (auto *Fn = dyn_cast<FunctionDecl>(TargetDecl)) {
1985 if (!Fn->isDefined() && !AttrOnCallSite) {
1986 FuncAttrs.addAttribute(llvm::Attribute::NonLazyBind);
1987 }
1988 }
1989 }
1990
Alexey Sotkin20f65922018-02-22 11:54:14 +00001991 if (TargetDecl && TargetDecl->hasAttr<OpenCLKernelAttr>()) {
1992 if (getLangOpts().OpenCLVersion <= 120) {
1993 // OpenCL v1.2 Work groups are always uniform
1994 FuncAttrs.addAttribute("uniform-work-group-size", "true");
1995 } else {
1996 // OpenCL v2.0 Work groups may be whether uniform or not.
1997 // '-cl-uniform-work-group-size' compile option gets a hint
1998 // to the compiler that the global work-size be a multiple of
1999 // the work-group size specified to clEnqueueNDRangeKernel
2000 // (i.e. work groups are uniform).
2001 FuncAttrs.addAttribute("uniform-work-group-size",
2002 llvm::toStringRef(CodeGenOpts.UniformWGSize));
2003 }
2004 }
2005
Justin Lebarb080b632017-01-25 21:29:48 +00002006 if (!AttrOnCallSite) {
Akira Hatanaka627586b2018-03-02 01:53:15 +00002007 bool DisableTailCalls = false;
2008
2009 if (CodeGenOpts.DisableTailCalls)
2010 DisableTailCalls = true;
2011 else if (TargetDecl) {
2012 if (TargetDecl->hasAttr<DisableTailCallsAttr>() ||
2013 TargetDecl->hasAttr<AnyX86InterruptAttr>())
2014 DisableTailCalls = true;
2015 else if (CodeGenOpts.NoEscapingBlockTailCalls) {
2016 if (const auto *BD = dyn_cast<BlockDecl>(TargetDecl))
2017 if (!BD->doesNotEscape())
2018 DisableTailCalls = true;
2019 }
2020 }
2021
Justin Lebarb080b632017-01-25 21:29:48 +00002022 FuncAttrs.addAttribute("disable-tail-calls",
2023 llvm::toStringRef(DisableTailCalls));
Erich Keanede6480a32018-11-13 15:48:08 +00002024 GetCPUAndFeaturesAttributes(CalleeInfo.getCalleeDecl(), FuncAttrs);
Bill Wendling985d1c52013-02-15 21:30:01 +00002025 }
2026
Alexey Samsonov153004f2014-09-29 22:08:00 +00002027 ClangToLLVMArgMapping IRFunctionArgs(getContext(), FI);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002028
Daniel Dunbar3668cb22009-02-02 23:43:58 +00002029 QualType RetTy = FI.getReturnType();
Daniel Dunbarb52d0772009-02-03 05:59:18 +00002030 const ABIArgInfo &RetAI = FI.getReturnInfo();
Daniel Dunbar7a95ca32008-09-10 04:01:49 +00002031 switch (RetAI.getKind()) {
Anton Korobeynikov18adbf52009-06-06 09:36:29 +00002032 case ABIArgInfo::Extend:
Alex Bradburye41a5e22018-01-12 20:08:16 +00002033 if (RetAI.isSignExt())
Jakob Stoklund Olesend7bf2932013-05-29 03:57:23 +00002034 RetAttrs.addAttribute(llvm::Attribute::SExt);
Alex Bradburye41a5e22018-01-12 20:08:16 +00002035 else
Jakob Stoklund Olesend7bf2932013-05-29 03:57:23 +00002036 RetAttrs.addAttribute(llvm::Attribute::ZExt);
Adrian Prantlf3b3ccd2017-12-19 22:06:11 +00002037 LLVM_FALLTHROUGH;
Daniel Dunbar67dace892009-02-03 06:17:37 +00002038 case ABIArgInfo::Direct:
Jakob Stoklund Olesena3661142013-06-05 03:00:09 +00002039 if (RetAI.getInReg())
2040 RetAttrs.addAttribute(llvm::Attribute::InReg);
2041 break;
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002042 case ABIArgInfo::Ignore:
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00002043 break;
2044
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002045 case ABIArgInfo::InAlloca:
Rafael Espindola06b2b4a2012-07-31 02:44:24 +00002046 case ABIArgInfo::Indirect: {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002047 // inalloca and sret disable readnone and readonly
Bill Wendling207f0532012-12-20 19:27:06 +00002048 FuncAttrs.removeAttribute(llvm::Attribute::ReadOnly)
2049 .removeAttribute(llvm::Attribute::ReadNone);
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00002050 break;
Rafael Espindola06b2b4a2012-07-31 02:44:24 +00002051 }
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00002052
John McCallf26e73d2016-03-11 04:30:43 +00002053 case ABIArgInfo::CoerceAndExpand:
2054 break;
2055
Daniel Dunbard3674e62008-09-11 01:48:57 +00002056 case ABIArgInfo::Expand:
David Blaikie83d382b2011-09-23 05:06:16 +00002057 llvm_unreachable("Invalid ABI kind for return argument");
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00002058 }
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00002059
Hal Finkela2347ba2014-07-18 15:52:10 +00002060 if (const auto *RefTy = RetTy->getAs<ReferenceType>()) {
2061 QualType PTy = RefTy->getPointeeType();
David Majnemer9df56372015-09-10 21:52:00 +00002062 if (!PTy->isIncompleteType() && PTy->isConstantSizeType())
Richard Smith0130b6c2020-01-31 19:06:21 -08002063 RetAttrs.addDereferenceableAttr(
2064 getMinimumObjectSize(PTy).getQuantity());
Manoj Guptada08f6a2018-07-19 00:44:52 +00002065 else if (getContext().getTargetAddressSpace(PTy) == 0 &&
2066 !CodeGenOpts.NullPointerIsValid)
Hal Finkela2347ba2014-07-18 15:52:10 +00002067 RetAttrs.addAttribute(llvm::Attribute::NonNull);
2068 }
Nick Lewycky9b46eb82014-05-28 09:56:42 +00002069
John McCall12f23522016-04-04 18:33:08 +00002070 bool hasUsedSRet = false;
Reid Klecknercdd26792017-04-18 23:50:03 +00002071 SmallVector<llvm::AttributeSet, 4> ArgAttrs(IRFunctionArgs.totalIRArgs());
John McCall12f23522016-04-04 18:33:08 +00002072
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002073 // Attach attributes to sret.
2074 if (IRFunctionArgs.hasSRetArg()) {
2075 llvm::AttrBuilder SRETAttrs;
Mandeep Singh Grang85a0f8f2019-05-03 21:12:24 +00002076 SRETAttrs.addAttribute(llvm::Attribute::StructRet);
John McCall12f23522016-04-04 18:33:08 +00002077 hasUsedSRet = true;
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002078 if (RetAI.getInReg())
2079 SRETAttrs.addAttribute(llvm::Attribute::InReg);
Reid Klecknercdd26792017-04-18 23:50:03 +00002080 ArgAttrs[IRFunctionArgs.getSRetArgNo()] =
2081 llvm::AttributeSet::get(getLLVMContext(), SRETAttrs);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002082 }
2083
2084 // Attach attributes to inalloca argument.
2085 if (IRFunctionArgs.hasInallocaArg()) {
2086 llvm::AttrBuilder Attrs;
2087 Attrs.addAttribute(llvm::Attribute::InAlloca);
Reid Klecknercdd26792017-04-18 23:50:03 +00002088 ArgAttrs[IRFunctionArgs.getInallocaArgNo()] =
2089 llvm::AttributeSet::get(getLLVMContext(), Attrs);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002090 }
2091
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002092 unsigned ArgNo = 0;
2093 for (CGFunctionInfo::const_arg_iterator I = FI.arg_begin(),
2094 E = FI.arg_end();
2095 I != E; ++I, ++ArgNo) {
2096 QualType ParamType = I->type;
2097 const ABIArgInfo &AI = I->info;
Bill Wendlinga514ebc2012-10-15 20:36:26 +00002098 llvm::AttrBuilder Attrs;
Anton Korobeynikovc8478242009-04-04 00:49:24 +00002099
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002100 // Add attribute for padding argument, if necessary.
2101 if (IRFunctionArgs.hasPaddingArg(ArgNo)) {
Reid Klecknercdd26792017-04-18 23:50:03 +00002102 if (AI.getPaddingInReg()) {
2103 ArgAttrs[IRFunctionArgs.getPaddingArgNo(ArgNo)] =
2104 llvm::AttributeSet::get(
2105 getLLVMContext(),
2106 llvm::AttrBuilder().addAttribute(llvm::Attribute::InReg));
2107 }
Rafael Espindolafad28de2012-10-24 01:59:00 +00002108 }
2109
John McCall39ec71f2010-03-27 00:47:27 +00002110 // 'restrict' -> 'noalias' is done in EmitFunctionProlog when we
2111 // have the corresponding parameter variable. It doesn't make
Daniel Dunbarcb2b3d02011-02-10 18:10:07 +00002112 // sense to do it here because parameters are so messed up.
Daniel Dunbard3674e62008-09-11 01:48:57 +00002113 switch (AI.getKind()) {
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002114 case ABIArgInfo::Extend:
Alex Bradburye41a5e22018-01-12 20:08:16 +00002115 if (AI.isSignExt())
Bill Wendling207f0532012-12-20 19:27:06 +00002116 Attrs.addAttribute(llvm::Attribute::SExt);
Alex Bradburye41a5e22018-01-12 20:08:16 +00002117 else
2118 Attrs.addAttribute(llvm::Attribute::ZExt);
Adrian Prantlf3b3ccd2017-12-19 22:06:11 +00002119 LLVM_FALLTHROUGH;
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002120 case ABIArgInfo::Direct:
Peter Collingbournef7706832014-12-12 23:41:25 +00002121 if (ArgNo == 0 && FI.isChainCall())
2122 Attrs.addAttribute(llvm::Attribute::Nest);
2123 else if (AI.getInReg())
Bill Wendling207f0532012-12-20 19:27:06 +00002124 Attrs.addAttribute(llvm::Attribute::InReg);
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002125 break;
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002126
James Y Knight71608572015-08-21 18:19:06 +00002127 case ABIArgInfo::Indirect: {
Rafael Espindola703c47f2012-10-19 05:04:37 +00002128 if (AI.getInReg())
Bill Wendling207f0532012-12-20 19:27:06 +00002129 Attrs.addAttribute(llvm::Attribute::InReg);
Rafael Espindola703c47f2012-10-19 05:04:37 +00002130
Anders Carlsson20759ad2009-09-16 15:53:40 +00002131 if (AI.getIndirectByVal())
Tim Northoverc46827c2019-06-05 21:12:14 +00002132 Attrs.addByValAttr(getTypes().ConvertTypeForMem(ParamType));
Anders Carlsson20759ad2009-09-16 15:53:40 +00002133
John McCall7f416cc2015-09-08 08:05:57 +00002134 CharUnits Align = AI.getIndirectAlign();
James Y Knight71608572015-08-21 18:19:06 +00002135
2136 // In a byval argument, it is important that the required
2137 // alignment of the type is honored, as LLVM might be creating a
2138 // *new* stack object, and needs to know what alignment to give
2139 // it. (Sometimes it can deduce a sensible alignment on its own,
2140 // but not if clang decides it must emit a packed struct, or the
2141 // user specifies increased alignment requirements.)
2142 //
2143 // This is different from indirect *not* byval, where the object
2144 // exists already, and the align attribute is purely
2145 // informative.
John McCall7f416cc2015-09-08 08:05:57 +00002146 assert(!Align.isZero());
James Y Knight71608572015-08-21 18:19:06 +00002147
John McCall7f416cc2015-09-08 08:05:57 +00002148 // For now, only add this when we have a byval argument.
2149 // TODO: be less lazy about updating test cases.
2150 if (AI.getIndirectByVal())
2151 Attrs.addAlignmentAttr(Align.getQuantity());
Bill Wendlinga7912f82012-10-10 07:36:56 +00002152
Daniel Dunbarc2304432009-03-18 19:51:01 +00002153 // byval disables readnone and readonly.
Bill Wendling207f0532012-12-20 19:27:06 +00002154 FuncAttrs.removeAttribute(llvm::Attribute::ReadOnly)
2155 .removeAttribute(llvm::Attribute::ReadNone);
Daniel Dunbard3674e62008-09-11 01:48:57 +00002156 break;
James Y Knight71608572015-08-21 18:19:06 +00002157 }
Daniel Dunbar94a6f252009-01-26 21:26:08 +00002158 case ABIArgInfo::Ignore:
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002159 case ABIArgInfo::Expand:
John McCallf26e73d2016-03-11 04:30:43 +00002160 case ABIArgInfo::CoerceAndExpand:
2161 break;
Daniel Dunbar94a6f252009-01-26 21:26:08 +00002162
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002163 case ABIArgInfo::InAlloca:
2164 // inalloca disables readnone and readonly.
2165 FuncAttrs.removeAttribute(llvm::Attribute::ReadOnly)
2166 .removeAttribute(llvm::Attribute::ReadNone);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002167 continue;
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00002168 }
Mike Stump11289f42009-09-09 15:08:12 +00002169
Hal Finkela2347ba2014-07-18 15:52:10 +00002170 if (const auto *RefTy = ParamType->getAs<ReferenceType>()) {
2171 QualType PTy = RefTy->getPointeeType();
David Majnemer9df56372015-09-10 21:52:00 +00002172 if (!PTy->isIncompleteType() && PTy->isConstantSizeType())
Richard Smith0130b6c2020-01-31 19:06:21 -08002173 Attrs.addDereferenceableAttr(
2174 getMinimumObjectSize(PTy).getQuantity());
Manoj Guptada08f6a2018-07-19 00:44:52 +00002175 else if (getContext().getTargetAddressSpace(PTy) == 0 &&
2176 !CodeGenOpts.NullPointerIsValid)
Hal Finkela2347ba2014-07-18 15:52:10 +00002177 Attrs.addAttribute(llvm::Attribute::NonNull);
2178 }
Nick Lewycky9b46eb82014-05-28 09:56:42 +00002179
John McCall12f23522016-04-04 18:33:08 +00002180 switch (FI.getExtParameterInfo(ArgNo).getABI()) {
2181 case ParameterABI::Ordinary:
2182 break;
2183
2184 case ParameterABI::SwiftIndirectResult: {
2185 // Add 'sret' if we haven't already used it for something, but
2186 // only if the result is void.
2187 if (!hasUsedSRet && RetTy->isVoidType()) {
2188 Attrs.addAttribute(llvm::Attribute::StructRet);
2189 hasUsedSRet = true;
2190 }
2191
2192 // Add 'noalias' in either case.
2193 Attrs.addAttribute(llvm::Attribute::NoAlias);
2194
2195 // Add 'dereferenceable' and 'alignment'.
2196 auto PTy = ParamType->getPointeeType();
2197 if (!PTy->isIncompleteType() && PTy->isConstantSizeType()) {
2198 auto info = getContext().getTypeInfoInChars(PTy);
2199 Attrs.addDereferenceableAttr(info.first.getQuantity());
Guillaume Chateletb65fa482019-10-15 12:56:24 +00002200 Attrs.addAttribute(llvm::Attribute::getWithAlignment(
2201 getLLVMContext(), info.second.getAsAlign()));
John McCall12f23522016-04-04 18:33:08 +00002202 }
2203 break;
2204 }
2205
2206 case ParameterABI::SwiftErrorResult:
2207 Attrs.addAttribute(llvm::Attribute::SwiftError);
2208 break;
2209
2210 case ParameterABI::SwiftContext:
2211 Attrs.addAttribute(llvm::Attribute::SwiftSelf);
2212 break;
2213 }
2214
Akira Hatanaka98a49332017-09-22 00:41:05 +00002215 if (FI.getExtParameterInfo(ArgNo).isNoEscape())
2216 Attrs.addAttribute(llvm::Attribute::NoCapture);
2217
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002218 if (Attrs.hasAttributes()) {
2219 unsigned FirstIRArg, NumIRArgs;
2220 std::tie(FirstIRArg, NumIRArgs) = IRFunctionArgs.getIRArgs(ArgNo);
2221 for (unsigned i = 0; i < NumIRArgs; i++)
Reid Klecknercdd26792017-04-18 23:50:03 +00002222 ArgAttrs[FirstIRArg + i] =
2223 llvm::AttributeSet::get(getLLVMContext(), Attrs);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002224 }
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00002225 }
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002226 assert(ArgNo == FI.arg_size());
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002227
Reid Klecknercdd26792017-04-18 23:50:03 +00002228 AttrList = llvm::AttributeList::get(
2229 getLLVMContext(), llvm::AttributeSet::get(getLLVMContext(), FuncAttrs),
2230 llvm::AttributeSet::get(getLLVMContext(), RetAttrs), ArgAttrs);
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00002231}
2232
John McCalla738c252011-03-09 04:27:21 +00002233/// An argument came in as a promoted argument; demote it back to its
2234/// declared type.
2235static llvm::Value *emitArgumentDemotion(CodeGenFunction &CGF,
2236 const VarDecl *var,
2237 llvm::Value *value) {
Chris Lattner2192fe52011-07-18 04:24:23 +00002238 llvm::Type *varType = CGF.ConvertType(var->getType());
John McCalla738c252011-03-09 04:27:21 +00002239
2240 // This can happen with promotions that actually don't change the
2241 // underlying type, like the enum promotions.
2242 if (value->getType() == varType) return value;
2243
2244 assert((varType->isIntegerTy() || varType->isFloatingPointTy())
2245 && "unexpected promotion type");
2246
2247 if (isa<llvm::IntegerType>(varType))
2248 return CGF.Builder.CreateTrunc(value, varType, "arg.unpromote");
2249
2250 return CGF.Builder.CreateFPCast(value, varType, "arg.unpromote");
2251}
2252
Chandler Carruth45bbe012017-03-24 09:11:57 +00002253/// Returns the attribute (either parameter attribute, or function
2254/// attribute), which declares argument ArgNo to be non-null.
2255static const NonNullAttr *getNonNullAttr(const Decl *FD, const ParmVarDecl *PVD,
2256 QualType ArgType, unsigned ArgNo) {
2257 // FIXME: __attribute__((nonnull)) can also be applied to:
2258 // - references to pointers, where the pointee is known to be
2259 // nonnull (apparently a Clang extension)
2260 // - transparent unions containing pointers
2261 // In the former case, LLVM IR cannot represent the constraint. In
2262 // the latter case, we have no guarantee that the transparent union
2263 // is in fact passed as a pointer.
2264 if (!ArgType->isAnyPointerType() && !ArgType->isBlockPointerType())
2265 return nullptr;
2266 // First, check attribute on parameter itself.
2267 if (PVD) {
2268 if (auto ParmNNAttr = PVD->getAttr<NonNullAttr>())
2269 return ParmNNAttr;
2270 }
2271 // Check function attributes.
2272 if (!FD)
2273 return nullptr;
2274 for (const auto *NNAttr : FD->specific_attrs<NonNullAttr>()) {
2275 if (NNAttr->isNonNull(ArgNo))
2276 return NNAttr;
2277 }
2278 return nullptr;
2279}
2280
John McCall12f23522016-04-04 18:33:08 +00002281namespace {
2282 struct CopyBackSwiftError final : EHScopeStack::Cleanup {
2283 Address Temp;
2284 Address Arg;
2285 CopyBackSwiftError(Address temp, Address arg) : Temp(temp), Arg(arg) {}
2286 void Emit(CodeGenFunction &CGF, Flags flags) override {
2287 llvm::Value *errorValue = CGF.Builder.CreateLoad(Temp);
2288 CGF.Builder.CreateStore(errorValue, Arg);
2289 }
2290 };
2291}
2292
Daniel Dunbard931a872009-02-02 22:03:45 +00002293void CodeGenFunction::EmitFunctionProlog(const CGFunctionInfo &FI,
2294 llvm::Function *Fn,
Daniel Dunbar613855c2008-09-09 23:27:19 +00002295 const FunctionArgList &Args) {
Hans Wennborgd71907d2014-09-04 22:16:33 +00002296 if (CurCodeDecl && CurCodeDecl->hasAttr<NakedAttr>())
2297 // Naked functions don't have prologues.
2298 return;
2299
John McCallcaa19452009-07-28 01:00:58 +00002300 // If this is an implicit-return-zero function, go ahead and
2301 // initialize the return value. TODO: it might be nice to have
2302 // a more general mechanism for this that didn't require synthesized
2303 // return statements.
John McCalldec348f72013-05-03 07:33:41 +00002304 if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(CurCodeDecl)) {
John McCallcaa19452009-07-28 01:00:58 +00002305 if (FD->hasImplicitReturnZero()) {
Alp Toker314cc812014-01-25 16:55:45 +00002306 QualType RetTy = FD->getReturnType().getUnqualifiedType();
Chris Lattner2192fe52011-07-18 04:24:23 +00002307 llvm::Type* LLVMTy = CGM.getTypes().ConvertType(RetTy);
Owen Anderson0b75f232009-07-31 20:28:54 +00002308 llvm::Constant* Zero = llvm::Constant::getNullValue(LLVMTy);
John McCallcaa19452009-07-28 01:00:58 +00002309 Builder.CreateStore(Zero, ReturnValue);
2310 }
2311 }
2312
Mike Stump18bb9282009-05-16 07:57:57 +00002313 // FIXME: We no longer need the types from FunctionArgList; lift up and
2314 // simplify.
Daniel Dunbar5a0acdc92009-02-03 06:02:10 +00002315
Alexey Samsonov153004f2014-09-29 22:08:00 +00002316 ClangToLLVMArgMapping IRFunctionArgs(CGM.getContext(), FI);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002317 // Flattened function arguments.
John McCall12f23522016-04-04 18:33:08 +00002318 SmallVector<llvm::Value *, 16> FnArgs;
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002319 FnArgs.reserve(IRFunctionArgs.totalIRArgs());
2320 for (auto &Arg : Fn->args()) {
2321 FnArgs.push_back(&Arg);
2322 }
2323 assert(FnArgs.size() == IRFunctionArgs.totalIRArgs());
Mike Stump11289f42009-09-09 15:08:12 +00002324
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002325 // If we're using inalloca, all the memory arguments are GEPs off of the last
2326 // parameter, which is a pointer to the complete memory area.
John McCall7f416cc2015-09-08 08:05:57 +00002327 Address ArgStruct = Address::invalid();
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002328 if (IRFunctionArgs.hasInallocaArg()) {
John McCall7f416cc2015-09-08 08:05:57 +00002329 ArgStruct = Address(FnArgs[IRFunctionArgs.getInallocaArgNo()],
2330 FI.getArgStructAlignment());
2331
2332 assert(ArgStruct.getType() == FI.getArgStruct()->getPointerTo());
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002333 }
2334
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002335 // Name the struct return parameter.
2336 if (IRFunctionArgs.hasSRetArg()) {
John McCall12f23522016-04-04 18:33:08 +00002337 auto AI = cast<llvm::Argument>(FnArgs[IRFunctionArgs.getSRetArgNo()]);
Daniel Dunbar613855c2008-09-09 23:27:19 +00002338 AI->setName("agg.result");
Reid Klecknercdd26792017-04-18 23:50:03 +00002339 AI->addAttr(llvm::Attribute::NoAlias);
Daniel Dunbar613855c2008-09-09 23:27:19 +00002340 }
Mike Stump11289f42009-09-09 15:08:12 +00002341
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002342 // Track if we received the parameter as a pointer (indirect, byval, or
2343 // inalloca). If already have a pointer, EmitParmDecl doesn't need to copy it
2344 // into a local alloca for us.
John McCall7f416cc2015-09-08 08:05:57 +00002345 SmallVector<ParamValue, 16> ArgVals;
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002346 ArgVals.reserve(Args.size());
2347
Reid Kleckner739756c2013-12-04 19:23:12 +00002348 // Create a pointer value for every parameter declaration. This usually
2349 // entails copying one or more LLVM IR arguments into an alloca. Don't push
2350 // any cleanups or do anything that might unwind. We do that separately, so
2351 // we can push the cleanups in the correct order for the ABI.
Daniel Dunbara45bdbb2009-02-04 21:17:21 +00002352 assert(FI.arg_size() == Args.size() &&
2353 "Mismatch between function signature & arguments.");
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002354 unsigned ArgNo = 0;
Daniel Dunbarb52d0772009-02-03 05:59:18 +00002355 CGFunctionInfo::const_arg_iterator info_it = FI.arg_begin();
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002356 for (FunctionArgList::const_iterator i = Args.begin(), e = Args.end();
Devang Patel68a15252011-03-03 20:13:15 +00002357 i != e; ++i, ++info_it, ++ArgNo) {
John McCalla738c252011-03-09 04:27:21 +00002358 const VarDecl *Arg = *i;
Daniel Dunbarb52d0772009-02-03 05:59:18 +00002359 const ABIArgInfo &ArgI = info_it->info;
Daniel Dunbard3674e62008-09-11 01:48:57 +00002360
John McCalla738c252011-03-09 04:27:21 +00002361 bool isPromoted =
2362 isa<ParmVarDecl>(Arg) && cast<ParmVarDecl>(Arg)->isKNRPromoted();
Volodymyr Sapsai17ebdb22018-01-22 22:29:24 +00002363 // We are converting from ABIArgInfo type to VarDecl type directly, unless
2364 // the parameter is promoted. In this case we convert to
2365 // CGFunctionInfo::ArgInfo type with subsequent argument demotion.
2366 QualType Ty = isPromoted ? info_it->type : Arg->getType();
2367 assert(hasScalarEvaluationKind(Ty) ==
2368 hasScalarEvaluationKind(Arg->getType()));
John McCalla738c252011-03-09 04:27:21 +00002369
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002370 unsigned FirstIRArg, NumIRArgs;
2371 std::tie(FirstIRArg, NumIRArgs) = IRFunctionArgs.getIRArgs(ArgNo);
Rafael Espindolafad28de2012-10-24 01:59:00 +00002372
Daniel Dunbard3674e62008-09-11 01:48:57 +00002373 switch (ArgI.getKind()) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002374 case ABIArgInfo::InAlloca: {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002375 assert(NumIRArgs == 0);
John McCall7f416cc2015-09-08 08:05:57 +00002376 auto FieldIndex = ArgI.getInAllocaFieldIndex();
James Y Knight751fe282019-02-09 22:22:28 +00002377 Address V =
2378 Builder.CreateStructGEP(ArgStruct, FieldIndex, Arg->getName());
Reid Kleckner2c6a3892020-02-11 16:03:26 -08002379 if (ArgI.getInAllocaIndirect())
2380 V = Address(Builder.CreateLoad(V),
2381 getContext().getTypeAlignInChars(Ty));
John McCall7f416cc2015-09-08 08:05:57 +00002382 ArgVals.push_back(ParamValue::forIndirect(V));
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002383 break;
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002384 }
2385
Daniel Dunbar747865a2009-02-05 09:16:39 +00002386 case ABIArgInfo::Indirect: {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002387 assert(NumIRArgs == 1);
John McCall7f416cc2015-09-08 08:05:57 +00002388 Address ParamAddr = Address(FnArgs[FirstIRArg], ArgI.getIndirectAlign());
Daniel Dunbar7b7c2932010-09-16 20:42:02 +00002389
John McCall47fb9502013-03-07 21:37:08 +00002390 if (!hasScalarEvaluationKind(Ty)) {
Daniel Dunbar7b7c2932010-09-16 20:42:02 +00002391 // Aggregates and complex variables are accessed by reference. All we
John McCall7f416cc2015-09-08 08:05:57 +00002392 // need to do is realign the value, if requested.
2393 Address V = ParamAddr;
Daniel Dunbar7b7c2932010-09-16 20:42:02 +00002394 if (ArgI.getIndirectRealign()) {
John McCall7f416cc2015-09-08 08:05:57 +00002395 Address AlignedTemp = CreateMemTemp(Ty, "coerce");
Daniel Dunbar7b7c2932010-09-16 20:42:02 +00002396
2397 // Copy from the incoming argument pointer to the temporary with the
2398 // appropriate alignment.
2399 //
2400 // FIXME: We should have a common utility for generating an aggregate
2401 // copy.
Ken Dyck705ba072011-01-19 01:58:38 +00002402 CharUnits Size = getContext().getTypeSizeInChars(Ty);
John McCall7f416cc2015-09-08 08:05:57 +00002403 auto SizeVal = llvm::ConstantInt::get(IntPtrTy, Size.getQuantity());
2404 Address Dst = Builder.CreateBitCast(AlignedTemp, Int8PtrTy);
2405 Address Src = Builder.CreateBitCast(ParamAddr, Int8PtrTy);
2406 Builder.CreateMemCpy(Dst, Src, SizeVal, false);
Daniel Dunbar7b7c2932010-09-16 20:42:02 +00002407 V = AlignedTemp;
2408 }
John McCall7f416cc2015-09-08 08:05:57 +00002409 ArgVals.push_back(ParamValue::forIndirect(V));
Daniel Dunbar747865a2009-02-05 09:16:39 +00002410 } else {
2411 // Load scalar value from indirect argument.
John McCall7f416cc2015-09-08 08:05:57 +00002412 llvm::Value *V =
Stephen Kellyf2ceec42018-08-09 21:08:08 +00002413 EmitLoadOfScalar(ParamAddr, false, Ty, Arg->getBeginLoc());
John McCalla738c252011-03-09 04:27:21 +00002414
2415 if (isPromoted)
2416 V = emitArgumentDemotion(*this, Arg, V);
John McCall7f416cc2015-09-08 08:05:57 +00002417 ArgVals.push_back(ParamValue::forDirect(V));
Daniel Dunbar747865a2009-02-05 09:16:39 +00002418 }
Daniel Dunbar747865a2009-02-05 09:16:39 +00002419 break;
2420 }
Anton Korobeynikov18adbf52009-06-06 09:36:29 +00002421
2422 case ABIArgInfo::Extend:
Daniel Dunbar67dace892009-02-03 06:17:37 +00002423 case ABIArgInfo::Direct: {
Akira Hatanaka18334dd2012-01-09 19:08:06 +00002424
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002425 // If we have the trivial case, handle it with no muss and fuss.
2426 if (!isa<llvm::StructType>(ArgI.getCoerceToType()) &&
Volodymyr Sapsai22b00ec2017-12-21 20:52:59 +00002427 ArgI.getCoerceToType() == ConvertType(Ty) &&
Chris Lattner8a2f3c72010-07-30 04:02:24 +00002428 ArgI.getDirectOffset() == 0) {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002429 assert(NumIRArgs == 1);
John McCall12f23522016-04-04 18:33:08 +00002430 llvm::Value *V = FnArgs[FirstIRArg];
2431 auto AI = cast<llvm::Argument>(V);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002432
Hal Finkel48d53e22014-07-19 01:41:07 +00002433 if (const ParmVarDecl *PVD = dyn_cast<ParmVarDecl>(Arg)) {
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00002434 if (getNonNullAttr(CurCodeDecl, PVD, PVD->getType(),
Manoj Guptada08f6a2018-07-19 00:44:52 +00002435 PVD->getFunctionScopeIndex()) &&
2436 !CGM.getCodeGenOpts().NullPointerIsValid)
Reid Klecknercdd26792017-04-18 23:50:03 +00002437 AI->addAttr(llvm::Attribute::NonNull);
Hal Finkel82504f02014-07-11 17:35:21 +00002438
Hal Finkel48d53e22014-07-19 01:41:07 +00002439 QualType OTy = PVD->getOriginalType();
2440 if (const auto *ArrTy =
2441 getContext().getAsConstantArrayType(OTy)) {
2442 // A C99 array parameter declaration with the static keyword also
2443 // indicates dereferenceability, and if the size is constant we can
2444 // use the dereferenceable attribute (which requires the size in
2445 // bytes).
Hal Finkel16e394a2014-07-19 02:13:40 +00002446 if (ArrTy->getSizeModifier() == ArrayType::Static) {
Hal Finkel48d53e22014-07-19 01:41:07 +00002447 QualType ETy = ArrTy->getElementType();
2448 uint64_t ArrSize = ArrTy->getSize().getZExtValue();
2449 if (!ETy->isIncompleteType() && ETy->isConstantSizeType() &&
2450 ArrSize) {
2451 llvm::AttrBuilder Attrs;
2452 Attrs.addDereferenceableAttr(
2453 getContext().getTypeSizeInChars(ETy).getQuantity()*ArrSize);
Reid Kleckner9d16fa02017-04-19 17:28:52 +00002454 AI->addAttrs(Attrs);
Manoj Guptada08f6a2018-07-19 00:44:52 +00002455 } else if (getContext().getTargetAddressSpace(ETy) == 0 &&
2456 !CGM.getCodeGenOpts().NullPointerIsValid) {
Reid Klecknercdd26792017-04-18 23:50:03 +00002457 AI->addAttr(llvm::Attribute::NonNull);
Hal Finkel48d53e22014-07-19 01:41:07 +00002458 }
2459 }
2460 } else if (const auto *ArrTy =
2461 getContext().getAsVariableArrayType(OTy)) {
2462 // For C99 VLAs with the static keyword, we don't know the size so
2463 // we can't use the dereferenceable attribute, but in addrspace(0)
2464 // we know that it must be nonnull.
2465 if (ArrTy->getSizeModifier() == VariableArrayType::Static &&
Manoj Guptada08f6a2018-07-19 00:44:52 +00002466 !getContext().getTargetAddressSpace(ArrTy->getElementType()) &&
2467 !CGM.getCodeGenOpts().NullPointerIsValid)
Reid Klecknercdd26792017-04-18 23:50:03 +00002468 AI->addAttr(llvm::Attribute::NonNull);
Hal Finkel48d53e22014-07-19 01:41:07 +00002469 }
Hal Finkel1b0d24e2014-10-02 21:21:25 +00002470
2471 const auto *AVAttr = PVD->getAttr<AlignValueAttr>();
2472 if (!AVAttr)
2473 if (const auto *TOTy = dyn_cast<TypedefType>(OTy))
2474 AVAttr = TOTy->getDecl()->getAttr<AlignValueAttr>();
Roman Lebedevbd1c0872019-01-15 09:44:25 +00002475 if (AVAttr && !SanOpts.has(SanitizerKind::Alignment)) {
2476 // If alignment-assumption sanitizer is enabled, we do *not* add
2477 // alignment attribute here, but emit normal alignment assumption,
2478 // so the UBSAN check could function.
Hal Finkel1b0d24e2014-10-02 21:21:25 +00002479 llvm::Value *AlignmentValue =
2480 EmitScalarExpr(AVAttr->getAlignment());
2481 llvm::ConstantInt *AlignmentCI =
2482 cast<llvm::ConstantInt>(AlignmentValue);
Roman Lebedev6b2f8202020-01-21 21:18:29 +03002483 AI->addAttrs(llvm::AttrBuilder().addAlignmentAttr(llvm::MaybeAlign(
2484 AlignmentCI->getLimitedValue(llvm::Value::MaximumAlignment))));
Hal Finkel1b0d24e2014-10-02 21:21:25 +00002485 }
Hal Finkel48d53e22014-07-19 01:41:07 +00002486 }
2487
Bill Wendling507c3512012-10-16 05:23:44 +00002488 if (Arg->getType().isRestrictQualified())
Reid Klecknercdd26792017-04-18 23:50:03 +00002489 AI->addAttr(llvm::Attribute::NoAlias);
John McCall39ec71f2010-03-27 00:47:27 +00002490
John McCall12f23522016-04-04 18:33:08 +00002491 // LLVM expects swifterror parameters to be used in very restricted
2492 // ways. Copy the value into a less-restricted temporary.
2493 if (FI.getExtParameterInfo(ArgNo).getABI()
2494 == ParameterABI::SwiftErrorResult) {
2495 QualType pointeeTy = Ty->getPointeeType();
2496 assert(pointeeTy->isPointerType());
2497 Address temp =
2498 CreateMemTemp(pointeeTy, getPointerAlign(), "swifterror.temp");
2499 Address arg = Address(V, getContext().getTypeAlignInChars(pointeeTy));
2500 llvm::Value *incomingErrorValue = Builder.CreateLoad(arg);
2501 Builder.CreateStore(incomingErrorValue, temp);
2502 V = temp.getPointer();
2503
2504 // Push a cleanup to copy the value back at the end of the function.
2505 // The convention does not guarantee that the value will be written
2506 // back if the function exits with an unwind exception.
2507 EHStack.pushCleanup<CopyBackSwiftError>(NormalCleanup, temp, arg);
2508 }
2509
Chris Lattner7369c142011-07-20 06:29:00 +00002510 // Ensure the argument is the correct type.
2511 if (V->getType() != ArgI.getCoerceToType())
2512 V = Builder.CreateBitCast(V, ArgI.getCoerceToType());
2513
John McCalla738c252011-03-09 04:27:21 +00002514 if (isPromoted)
2515 V = emitArgumentDemotion(*this, Arg, V);
Rafael Espindola8778c282012-11-29 16:09:03 +00002516
2517 // Because of merging of function types from multiple decls it is
2518 // possible for the type of an argument to not match the corresponding
2519 // type in the function type. Since we are codegening the callee
2520 // in here, add a cast to the argument type.
2521 llvm::Type *LTy = ConvertType(Arg->getType());
2522 if (V->getType() != LTy)
2523 V = Builder.CreateBitCast(V, LTy);
2524
John McCall7f416cc2015-09-08 08:05:57 +00002525 ArgVals.push_back(ParamValue::forDirect(V));
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002526 break;
Daniel Dunbard5f1f552009-02-10 00:06:49 +00002527 }
Mike Stump11289f42009-09-09 15:08:12 +00002528
Volodymyr Sapsai22b00ec2017-12-21 20:52:59 +00002529 Address Alloca = CreateMemTemp(Ty, getContext().getDeclAlign(Arg),
2530 Arg->getName());
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002531
John McCall7f416cc2015-09-08 08:05:57 +00002532 // Pointer to store into.
2533 Address Ptr = emitAddressAtOffset(*this, Alloca, ArgI);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002534
Oliver Stannard2bfdc5b2014-08-27 10:43:15 +00002535 // Fast-isel and the optimizer generally like scalar values better than
2536 // FCAs, so we flatten them if this is safe to do for this argument.
Evgeniy Stepanov3fae4ae2012-02-10 09:30:15 +00002537 llvm::StructType *STy = dyn_cast<llvm::StructType>(ArgI.getCoerceToType());
Oliver Stannard2bfdc5b2014-08-27 10:43:15 +00002538 if (ArgI.isDirect() && ArgI.getCanBeFlattened() && STy &&
2539 STy->getNumElements() > 1) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00002540 uint64_t SrcSize = CGM.getDataLayout().getTypeAllocSize(STy);
John McCall7f416cc2015-09-08 08:05:57 +00002541 llvm::Type *DstTy = Ptr.getElementType();
Micah Villmowdd31ca12012-10-08 16:25:52 +00002542 uint64_t DstSize = CGM.getDataLayout().getTypeAllocSize(DstTy);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002543
John McCall7f416cc2015-09-08 08:05:57 +00002544 Address AddrToStoreInto = Address::invalid();
Evgeniy Stepanov3fae4ae2012-02-10 09:30:15 +00002545 if (SrcSize <= DstSize) {
Yaxun Liue9e5c4f2017-06-29 18:47:45 +00002546 AddrToStoreInto = Builder.CreateElementBitCast(Ptr, STy);
Evgeniy Stepanov3fae4ae2012-02-10 09:30:15 +00002547 } else {
John McCall7f416cc2015-09-08 08:05:57 +00002548 AddrToStoreInto =
2549 CreateTempAlloca(STy, Alloca.getAlignment(), "coerce");
Chris Lattner15ec3612010-06-29 00:06:42 +00002550 }
John McCall7f416cc2015-09-08 08:05:57 +00002551
2552 assert(STy->getNumElements() == NumIRArgs);
2553 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
2554 auto AI = FnArgs[FirstIRArg + i];
2555 AI->setName(Arg->getName() + ".coerce" + Twine(i));
James Y Knight751fe282019-02-09 22:22:28 +00002556 Address EltPtr = Builder.CreateStructGEP(AddrToStoreInto, i);
John McCall7f416cc2015-09-08 08:05:57 +00002557 Builder.CreateStore(AI, EltPtr);
2558 }
2559
2560 if (SrcSize > DstSize) {
2561 Builder.CreateMemCpy(Ptr, AddrToStoreInto, DstSize);
2562 }
2563
Chris Lattner15ec3612010-06-29 00:06:42 +00002564 } else {
2565 // Simple case, just do a coerced store of the argument into the alloca.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002566 assert(NumIRArgs == 1);
2567 auto AI = FnArgs[FirstIRArg];
Chris Lattner9e748e92010-06-29 00:14:52 +00002568 AI->setName(Arg->getName() + ".coerce");
Rui Ueyama49a3ad22019-07-16 04:46:31 +00002569 CreateCoercedStore(AI, Ptr, /*DstIsVolatile=*/false, *this);
Chris Lattner15ec3612010-06-29 00:06:42 +00002570 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002571
Daniel Dunbar2f219b02009-02-03 19:12:28 +00002572 // Match to what EmitParmDecl is expecting for this type.
Volodymyr Sapsai22b00ec2017-12-21 20:52:59 +00002573 if (CodeGenFunction::hasScalarEvaluationKind(Ty)) {
John McCall7f416cc2015-09-08 08:05:57 +00002574 llvm::Value *V =
Stephen Kellyf2ceec42018-08-09 21:08:08 +00002575 EmitLoadOfScalar(Alloca, false, Ty, Arg->getBeginLoc());
John McCalla738c252011-03-09 04:27:21 +00002576 if (isPromoted)
2577 V = emitArgumentDemotion(*this, Arg, V);
John McCall7f416cc2015-09-08 08:05:57 +00002578 ArgVals.push_back(ParamValue::forDirect(V));
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002579 } else {
John McCall7f416cc2015-09-08 08:05:57 +00002580 ArgVals.push_back(ParamValue::forIndirect(Alloca));
Daniel Dunbar6e3b7df2009-02-04 07:22:24 +00002581 }
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002582 break;
Daniel Dunbar2f219b02009-02-03 19:12:28 +00002583 }
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002584
John McCallf26e73d2016-03-11 04:30:43 +00002585 case ABIArgInfo::CoerceAndExpand: {
2586 // Reconstruct into a temporary.
2587 Address alloca = CreateMemTemp(Ty, getContext().getDeclAlign(Arg));
2588 ArgVals.push_back(ParamValue::forIndirect(alloca));
2589
2590 auto coercionType = ArgI.getCoerceAndExpandType();
2591 alloca = Builder.CreateElementBitCast(alloca, coercionType);
John McCallf26e73d2016-03-11 04:30:43 +00002592
2593 unsigned argIndex = FirstIRArg;
2594 for (unsigned i = 0, e = coercionType->getNumElements(); i != e; ++i) {
2595 llvm::Type *eltType = coercionType->getElementType(i);
2596 if (ABIArgInfo::isPaddingForCoerceAndExpand(eltType))
2597 continue;
2598
James Y Knight751fe282019-02-09 22:22:28 +00002599 auto eltAddr = Builder.CreateStructGEP(alloca, i);
John McCallf26e73d2016-03-11 04:30:43 +00002600 auto elt = FnArgs[argIndex++];
2601 Builder.CreateStore(elt, eltAddr);
2602 }
2603 assert(argIndex == FirstIRArg + NumIRArgs);
2604 break;
2605 }
2606
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002607 case ABIArgInfo::Expand: {
2608 // If this structure was expanded into multiple arguments then
2609 // we need to create a temporary and reconstruct it from the
2610 // arguments.
John McCall7f416cc2015-09-08 08:05:57 +00002611 Address Alloca = CreateMemTemp(Ty, getContext().getDeclAlign(Arg));
2612 LValue LV = MakeAddrLValue(Alloca, Ty);
2613 ArgVals.push_back(ParamValue::forIndirect(Alloca));
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002614
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002615 auto FnArgIter = FnArgs.begin() + FirstIRArg;
2616 ExpandTypeFromArgs(Ty, LV, FnArgIter);
2617 assert(FnArgIter == FnArgs.begin() + FirstIRArg + NumIRArgs);
2618 for (unsigned i = 0, e = NumIRArgs; i != e; ++i) {
2619 auto AI = FnArgs[FirstIRArg + i];
2620 AI->setName(Arg->getName() + "." + Twine(i));
2621 }
2622 break;
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002623 }
2624
2625 case ABIArgInfo::Ignore:
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002626 assert(NumIRArgs == 0);
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002627 // Initialize the local variable appropriately.
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002628 if (!hasScalarEvaluationKind(Ty)) {
John McCall7f416cc2015-09-08 08:05:57 +00002629 ArgVals.push_back(ParamValue::forIndirect(CreateMemTemp(Ty)));
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002630 } else {
2631 llvm::Value *U = llvm::UndefValue::get(ConvertType(Arg->getType()));
John McCall7f416cc2015-09-08 08:05:57 +00002632 ArgVals.push_back(ParamValue::forDirect(U));
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002633 }
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002634 break;
Daniel Dunbard3674e62008-09-11 01:48:57 +00002635 }
Daniel Dunbar613855c2008-09-09 23:27:19 +00002636 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002637
Reid Kleckner739756c2013-12-04 19:23:12 +00002638 if (getTarget().getCXXABI().areArgsDestroyedLeftToRightInCallee()) {
2639 for (int I = Args.size() - 1; I >= 0; --I)
John McCall7f416cc2015-09-08 08:05:57 +00002640 EmitParmDecl(*Args[I], ArgVals[I], I + 1);
Reid Kleckner739756c2013-12-04 19:23:12 +00002641 } else {
2642 for (unsigned I = 0, E = Args.size(); I != E; ++I)
John McCall7f416cc2015-09-08 08:05:57 +00002643 EmitParmDecl(*Args[I], ArgVals[I], I + 1);
Reid Kleckner739756c2013-12-04 19:23:12 +00002644 }
Daniel Dunbar613855c2008-09-09 23:27:19 +00002645}
2646
John McCallffa2c1a2012-01-29 07:46:59 +00002647static void eraseUnusedBitCasts(llvm::Instruction *insn) {
2648 while (insn->use_empty()) {
2649 llvm::BitCastInst *bitcast = dyn_cast<llvm::BitCastInst>(insn);
2650 if (!bitcast) return;
2651
2652 // This is "safe" because we would have used a ConstantExpr otherwise.
2653 insn = cast<llvm::Instruction>(bitcast->getOperand(0));
2654 bitcast->eraseFromParent();
2655 }
2656}
2657
John McCall31168b02011-06-15 23:02:42 +00002658/// Try to emit a fused autorelease of a return result.
2659static llvm::Value *tryEmitFusedAutoreleaseOfResult(CodeGenFunction &CGF,
2660 llvm::Value *result) {
2661 // We must be immediately followed the cast.
2662 llvm::BasicBlock *BB = CGF.Builder.GetInsertBlock();
Craig Topper8a13c412014-05-21 05:09:00 +00002663 if (BB->empty()) return nullptr;
2664 if (&BB->back() != result) return nullptr;
John McCall31168b02011-06-15 23:02:42 +00002665
Chris Lattner2192fe52011-07-18 04:24:23 +00002666 llvm::Type *resultType = result->getType();
John McCall31168b02011-06-15 23:02:42 +00002667
2668 // result is in a BasicBlock and is therefore an Instruction.
2669 llvm::Instruction *generator = cast<llvm::Instruction>(result);
2670
Justin Bogner882f8612016-08-18 21:46:54 +00002671 SmallVector<llvm::Instruction *, 4> InstsToKill;
John McCall31168b02011-06-15 23:02:42 +00002672
2673 // Look for:
2674 // %generator = bitcast %type1* %generator2 to %type2*
2675 while (llvm::BitCastInst *bitcast = dyn_cast<llvm::BitCastInst>(generator)) {
2676 // We would have emitted this as a constant if the operand weren't
2677 // an Instruction.
2678 generator = cast<llvm::Instruction>(bitcast->getOperand(0));
2679
2680 // Require the generator to be immediately followed by the cast.
2681 if (generator->getNextNode() != bitcast)
Craig Topper8a13c412014-05-21 05:09:00 +00002682 return nullptr;
John McCall31168b02011-06-15 23:02:42 +00002683
Justin Bogner882f8612016-08-18 21:46:54 +00002684 InstsToKill.push_back(bitcast);
John McCall31168b02011-06-15 23:02:42 +00002685 }
2686
2687 // Look for:
2688 // %generator = call i8* @objc_retain(i8* %originalResult)
2689 // or
2690 // %generator = call i8* @objc_retainAutoreleasedReturnValue(i8* %originalResult)
2691 llvm::CallInst *call = dyn_cast<llvm::CallInst>(generator);
Craig Topper8a13c412014-05-21 05:09:00 +00002692 if (!call) return nullptr;
John McCall31168b02011-06-15 23:02:42 +00002693
2694 bool doRetainAutorelease;
2695
John McCallb04ecb72015-10-21 18:06:43 +00002696 if (call->getCalledValue() == CGF.CGM.getObjCEntrypoints().objc_retain) {
John McCall31168b02011-06-15 23:02:42 +00002697 doRetainAutorelease = true;
John McCallb04ecb72015-10-21 18:06:43 +00002698 } else if (call->getCalledValue() == CGF.CGM.getObjCEntrypoints()
John McCall31168b02011-06-15 23:02:42 +00002699 .objc_retainAutoreleasedReturnValue) {
2700 doRetainAutorelease = false;
2701
John McCallcfa4e9b2012-09-07 23:30:50 +00002702 // If we emitted an assembly marker for this call (and the
2703 // ARCEntrypoints field should have been set if so), go looking
2704 // for that call. If we can't find it, we can't do this
2705 // optimization. But it should always be the immediately previous
2706 // instruction, unless we needed bitcasts around the call.
John McCallb04ecb72015-10-21 18:06:43 +00002707 if (CGF.CGM.getObjCEntrypoints().retainAutoreleasedReturnValueMarker) {
John McCallcfa4e9b2012-09-07 23:30:50 +00002708 llvm::Instruction *prev = call->getPrevNode();
2709 assert(prev);
2710 if (isa<llvm::BitCastInst>(prev)) {
2711 prev = prev->getPrevNode();
2712 assert(prev);
2713 }
2714 assert(isa<llvm::CallInst>(prev));
2715 assert(cast<llvm::CallInst>(prev)->getCalledValue() ==
John McCallb04ecb72015-10-21 18:06:43 +00002716 CGF.CGM.getObjCEntrypoints().retainAutoreleasedReturnValueMarker);
Justin Bogner882f8612016-08-18 21:46:54 +00002717 InstsToKill.push_back(prev);
John McCallcfa4e9b2012-09-07 23:30:50 +00002718 }
John McCall31168b02011-06-15 23:02:42 +00002719 } else {
Craig Topper8a13c412014-05-21 05:09:00 +00002720 return nullptr;
John McCall31168b02011-06-15 23:02:42 +00002721 }
2722
2723 result = call->getArgOperand(0);
Justin Bogner882f8612016-08-18 21:46:54 +00002724 InstsToKill.push_back(call);
John McCall31168b02011-06-15 23:02:42 +00002725
2726 // Keep killing bitcasts, for sanity. Note that we no longer care
2727 // about precise ordering as long as there's exactly one use.
2728 while (llvm::BitCastInst *bitcast = dyn_cast<llvm::BitCastInst>(result)) {
2729 if (!bitcast->hasOneUse()) break;
Justin Bogner882f8612016-08-18 21:46:54 +00002730 InstsToKill.push_back(bitcast);
John McCall31168b02011-06-15 23:02:42 +00002731 result = bitcast->getOperand(0);
2732 }
2733
2734 // Delete all the unnecessary instructions, from latest to earliest.
Justin Bogner882f8612016-08-18 21:46:54 +00002735 for (auto *I : InstsToKill)
Saleem Abdulrasoolbe25c482016-08-18 21:40:06 +00002736 I->eraseFromParent();
John McCall31168b02011-06-15 23:02:42 +00002737
2738 // Do the fused retain/autorelease if we were asked to.
2739 if (doRetainAutorelease)
2740 result = CGF.EmitARCRetainAutoreleaseReturnValue(result);
2741
2742 // Cast back to the result type.
2743 return CGF.Builder.CreateBitCast(result, resultType);
2744}
2745
John McCallffa2c1a2012-01-29 07:46:59 +00002746/// If this is a +1 of the value of an immutable 'self', remove it.
2747static llvm::Value *tryRemoveRetainOfSelf(CodeGenFunction &CGF,
2748 llvm::Value *result) {
2749 // This is only applicable to a method with an immutable 'self'.
John McCallff755cd2012-07-31 00:33:55 +00002750 const ObjCMethodDecl *method =
2751 dyn_cast_or_null<ObjCMethodDecl>(CGF.CurCodeDecl);
Craig Topper8a13c412014-05-21 05:09:00 +00002752 if (!method) return nullptr;
John McCallffa2c1a2012-01-29 07:46:59 +00002753 const VarDecl *self = method->getSelfDecl();
Craig Topper8a13c412014-05-21 05:09:00 +00002754 if (!self->getType().isConstQualified()) return nullptr;
John McCallffa2c1a2012-01-29 07:46:59 +00002755
2756 // Look for a retain call.
2757 llvm::CallInst *retainCall =
2758 dyn_cast<llvm::CallInst>(result->stripPointerCasts());
2759 if (!retainCall ||
John McCallb04ecb72015-10-21 18:06:43 +00002760 retainCall->getCalledValue() != CGF.CGM.getObjCEntrypoints().objc_retain)
Craig Topper8a13c412014-05-21 05:09:00 +00002761 return nullptr;
John McCallffa2c1a2012-01-29 07:46:59 +00002762
2763 // Look for an ordinary load of 'self'.
2764 llvm::Value *retainedValue = retainCall->getArgOperand(0);
2765 llvm::LoadInst *load =
2766 dyn_cast<llvm::LoadInst>(retainedValue->stripPointerCasts());
Fangrui Song6907ce22018-07-30 19:24:48 +00002767 if (!load || load->isAtomic() || load->isVolatile() ||
John McCall7f416cc2015-09-08 08:05:57 +00002768 load->getPointerOperand() != CGF.GetAddrOfLocalVar(self).getPointer())
Craig Topper8a13c412014-05-21 05:09:00 +00002769 return nullptr;
John McCallffa2c1a2012-01-29 07:46:59 +00002770
2771 // Okay! Burn it all down. This relies for correctness on the
2772 // assumption that the retain is emitted as part of the return and
2773 // that thereafter everything is used "linearly".
2774 llvm::Type *resultType = result->getType();
2775 eraseUnusedBitCasts(cast<llvm::Instruction>(result));
2776 assert(retainCall->use_empty());
2777 retainCall->eraseFromParent();
2778 eraseUnusedBitCasts(cast<llvm::Instruction>(retainedValue));
2779
2780 return CGF.Builder.CreateBitCast(load, resultType);
2781}
2782
John McCall31168b02011-06-15 23:02:42 +00002783/// Emit an ARC autorelease of the result of a function.
John McCallffa2c1a2012-01-29 07:46:59 +00002784///
2785/// \return the value to actually return from the function
John McCall31168b02011-06-15 23:02:42 +00002786static llvm::Value *emitAutoreleaseOfResult(CodeGenFunction &CGF,
2787 llvm::Value *result) {
John McCallffa2c1a2012-01-29 07:46:59 +00002788 // If we're returning 'self', kill the initial retain. This is a
2789 // heuristic attempt to "encourage correctness" in the really unfortunate
2790 // case where we have a return of self during a dealloc and we desperately
2791 // need to avoid the possible autorelease.
2792 if (llvm::Value *self = tryRemoveRetainOfSelf(CGF, result))
2793 return self;
2794
John McCall31168b02011-06-15 23:02:42 +00002795 // At -O0, try to emit a fused retain/autorelease.
2796 if (CGF.shouldUseFusedARCCalls())
2797 if (llvm::Value *fused = tryEmitFusedAutoreleaseOfResult(CGF, result))
2798 return fused;
2799
2800 return CGF.EmitARCAutoreleaseReturnValue(result);
2801}
2802
John McCall6e1c0122012-01-29 02:35:02 +00002803/// Heuristically search for a dominating store to the return-value slot.
2804static llvm::StoreInst *findDominatingStoreToReturnValue(CodeGenFunction &CGF) {
Jakub Kuderskif50ab0f2015-09-08 10:36:42 +00002805 // Check if a User is a store which pointerOperand is the ReturnValue.
2806 // We are looking for stores to the ReturnValue, not for stores of the
2807 // ReturnValue to some other location.
2808 auto GetStoreIfValid = [&CGF](llvm::User *U) -> llvm::StoreInst * {
2809 auto *SI = dyn_cast<llvm::StoreInst>(U);
2810 if (!SI || SI->getPointerOperand() != CGF.ReturnValue.getPointer())
2811 return nullptr;
2812 // These aren't actually possible for non-coerced returns, and we
2813 // only care about non-coerced returns on this code path.
2814 assert(!SI->isAtomic() && !SI->isVolatile());
2815 return SI;
2816 };
John McCall6e1c0122012-01-29 02:35:02 +00002817 // If there are multiple uses of the return-value slot, just check
2818 // for something immediately preceding the IP. Sometimes this can
2819 // happen with how we generate implicit-returns; it can also happen
2820 // with noreturn cleanups.
John McCall7f416cc2015-09-08 08:05:57 +00002821 if (!CGF.ReturnValue.getPointer()->hasOneUse()) {
John McCall6e1c0122012-01-29 02:35:02 +00002822 llvm::BasicBlock *IP = CGF.Builder.GetInsertBlock();
Craig Topper8a13c412014-05-21 05:09:00 +00002823 if (IP->empty()) return nullptr;
David Majnemerdc012fa2015-04-22 21:38:15 +00002824 llvm::Instruction *I = &IP->back();
2825
2826 // Skip lifetime markers
2827 for (llvm::BasicBlock::reverse_iterator II = IP->rbegin(),
2828 IE = IP->rend();
2829 II != IE; ++II) {
2830 if (llvm::IntrinsicInst *Intrinsic =
2831 dyn_cast<llvm::IntrinsicInst>(&*II)) {
2832 if (Intrinsic->getIntrinsicID() == llvm::Intrinsic::lifetime_end) {
2833 const llvm::Value *CastAddr = Intrinsic->getArgOperand(1);
2834 ++II;
Alexey Samsonov10544202015-06-12 21:05:32 +00002835 if (II == IE)
2836 break;
2837 if (isa<llvm::BitCastInst>(&*II) && (CastAddr == &*II))
2838 continue;
David Majnemerdc012fa2015-04-22 21:38:15 +00002839 }
2840 }
2841 I = &*II;
2842 break;
2843 }
2844
Jakub Kuderskif50ab0f2015-09-08 10:36:42 +00002845 return GetStoreIfValid(I);
John McCall6e1c0122012-01-29 02:35:02 +00002846 }
2847
2848 llvm::StoreInst *store =
Jakub Kuderskif50ab0f2015-09-08 10:36:42 +00002849 GetStoreIfValid(CGF.ReturnValue.getPointer()->user_back());
Craig Topper8a13c412014-05-21 05:09:00 +00002850 if (!store) return nullptr;
John McCall6e1c0122012-01-29 02:35:02 +00002851
John McCall6e1c0122012-01-29 02:35:02 +00002852 // Now do a first-and-dirty dominance check: just walk up the
2853 // single-predecessors chain from the current insertion point.
2854 llvm::BasicBlock *StoreBB = store->getParent();
2855 llvm::BasicBlock *IP = CGF.Builder.GetInsertBlock();
2856 while (IP != StoreBB) {
2857 if (!(IP = IP->getSinglePredecessor()))
Craig Topper8a13c412014-05-21 05:09:00 +00002858 return nullptr;
John McCall6e1c0122012-01-29 02:35:02 +00002859 }
2860
2861 // Okay, the store's basic block dominates the insertion point; we
2862 // can do our thing.
2863 return store;
2864}
2865
Adrian Prantl3be10542013-05-02 17:30:20 +00002866void CodeGenFunction::EmitFunctionEpilog(const CGFunctionInfo &FI,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002867 bool EmitRetDbgLoc,
2868 SourceLocation EndLoc) {
Vedant Kumar09b5bfd2017-12-21 00:10:25 +00002869 if (FI.isNoReturn()) {
2870 // Noreturn functions don't return.
2871 EmitUnreachable(EndLoc);
2872 return;
2873 }
2874
Hans Wennborgd71907d2014-09-04 22:16:33 +00002875 if (CurCodeDecl && CurCodeDecl->hasAttr<NakedAttr>()) {
2876 // Naked functions don't have epilogues.
2877 Builder.CreateUnreachable();
2878 return;
2879 }
2880
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00002881 // Functions with no result always return void.
John McCall7f416cc2015-09-08 08:05:57 +00002882 if (!ReturnValue.isValid()) {
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00002883 Builder.CreateRetVoid();
Chris Lattner726b3d02010-06-26 23:13:19 +00002884 return;
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00002885 }
Daniel Dunbar6696e222010-06-30 21:27:58 +00002886
Dan Gohman481e40c2010-07-20 20:13:52 +00002887 llvm::DebugLoc RetDbgLoc;
Craig Topper8a13c412014-05-21 05:09:00 +00002888 llvm::Value *RV = nullptr;
Chris Lattner726b3d02010-06-26 23:13:19 +00002889 QualType RetTy = FI.getReturnType();
2890 const ABIArgInfo &RetAI = FI.getReturnInfo();
2891
2892 switch (RetAI.getKind()) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002893 case ABIArgInfo::InAlloca:
Reid Klecknerfab1e892014-02-25 00:59:14 +00002894 // Aggregrates get evaluated directly into the destination. Sometimes we
2895 // need to return the sret value in a register, though.
2896 assert(hasAggregateEvaluationKind(RetTy));
2897 if (RetAI.getInAllocaSRet()) {
2898 llvm::Function::arg_iterator EI = CurFn->arg_end();
2899 --EI;
Duncan P. N. Exon Smith9f5260a2015-11-06 23:00:41 +00002900 llvm::Value *ArgStruct = &*EI;
David Blaikie2e804282015-04-05 22:47:07 +00002901 llvm::Value *SRet = Builder.CreateStructGEP(
2902 nullptr, ArgStruct, RetAI.getInAllocaFieldIndex());
John McCall7f416cc2015-09-08 08:05:57 +00002903 RV = Builder.CreateAlignedLoad(SRet, getPointerAlign(), "sret");
Reid Klecknerfab1e892014-02-25 00:59:14 +00002904 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002905 break;
2906
Daniel Dunbar03816342010-08-21 02:24:36 +00002907 case ABIArgInfo::Indirect: {
Reid Kleckner37abaca2014-05-09 22:46:15 +00002908 auto AI = CurFn->arg_begin();
2909 if (RetAI.isSRetAfterThis())
2910 ++AI;
John McCall47fb9502013-03-07 21:37:08 +00002911 switch (getEvaluationKind(RetTy)) {
2912 case TEK_Complex: {
2913 ComplexPairTy RT =
John McCall7f416cc2015-09-08 08:05:57 +00002914 EmitLoadOfComplex(MakeAddrLValue(ReturnValue, RetTy), EndLoc);
Duncan P. N. Exon Smith9f5260a2015-11-06 23:00:41 +00002915 EmitStoreOfComplex(RT, MakeNaturalAlignAddrLValue(&*AI, RetTy),
John McCall47fb9502013-03-07 21:37:08 +00002916 /*isInit*/ true);
2917 break;
2918 }
2919 case TEK_Aggregate:
Chris Lattner726b3d02010-06-26 23:13:19 +00002920 // Do nothing; aggregrates get evaluated directly into the destination.
John McCall47fb9502013-03-07 21:37:08 +00002921 break;
2922 case TEK_Scalar:
2923 EmitStoreOfScalar(Builder.CreateLoad(ReturnValue),
Duncan P. N. Exon Smith9f5260a2015-11-06 23:00:41 +00002924 MakeNaturalAlignAddrLValue(&*AI, RetTy),
John McCall47fb9502013-03-07 21:37:08 +00002925 /*isInit*/ true);
2926 break;
Chris Lattner726b3d02010-06-26 23:13:19 +00002927 }
2928 break;
Daniel Dunbar03816342010-08-21 02:24:36 +00002929 }
Chris Lattner726b3d02010-06-26 23:13:19 +00002930
2931 case ABIArgInfo::Extend:
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002932 case ABIArgInfo::Direct:
Chris Lattner8a2f3c72010-07-30 04:02:24 +00002933 if (RetAI.getCoerceToType() == ConvertType(RetTy) &&
2934 RetAI.getDirectOffset() == 0) {
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002935 // The internal return value temp always will have pointer-to-return-type
2936 // type, just do a load.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002937
John McCall6e1c0122012-01-29 02:35:02 +00002938 // If there is a dominating store to ReturnValue, we can elide
2939 // the load, zap the store, and usually zap the alloca.
David Majnemerdc012fa2015-04-22 21:38:15 +00002940 if (llvm::StoreInst *SI =
2941 findDominatingStoreToReturnValue(*this)) {
Adrian Prantl4c9a38a2013-05-30 18:12:23 +00002942 // Reuse the debug location from the store unless there is
2943 // cleanup code to be emitted between the store and return
2944 // instruction.
2945 if (EmitRetDbgLoc && !AutoreleaseResult)
Adrian Prantl3be10542013-05-02 17:30:20 +00002946 RetDbgLoc = SI->getDebugLoc();
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002947 // Get the stored value and nuke the now-dead store.
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002948 RV = SI->getValueOperand();
2949 SI->eraseFromParent();
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002950
John McCall6e1c0122012-01-29 02:35:02 +00002951 // Otherwise, we have to do a simple load.
2952 } else {
2953 RV = Builder.CreateLoad(ReturnValue);
Chris Lattner3fcc7902010-06-27 01:06:27 +00002954 }
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002955 } else {
Chris Lattner8a2f3c72010-07-30 04:02:24 +00002956 // If the value is offset in memory, apply the offset now.
John McCall7f416cc2015-09-08 08:05:57 +00002957 Address V = emitAddressAtOffset(*this, ReturnValue, RetAI);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002958
John McCall7f416cc2015-09-08 08:05:57 +00002959 RV = CreateCoercedLoad(V, RetAI.getCoerceToType(), *this);
Chris Lattner3fcc7902010-06-27 01:06:27 +00002960 }
John McCall31168b02011-06-15 23:02:42 +00002961
2962 // In ARC, end functions that return a retainable type with a call
2963 // to objc_autoreleaseReturnValue.
2964 if (AutoreleaseResult) {
Akira Hatanaka9d8ac612016-02-17 21:09:50 +00002965#ifndef NDEBUG
2966 // Type::isObjCRetainabletype has to be called on a QualType that hasn't
2967 // been stripped of the typedefs, so we cannot use RetTy here. Get the
2968 // original return type of FunctionDecl, CurCodeDecl, and BlockDecl from
2969 // CurCodeDecl or BlockInfo.
2970 QualType RT;
2971
2972 if (auto *FD = dyn_cast<FunctionDecl>(CurCodeDecl))
2973 RT = FD->getReturnType();
2974 else if (auto *MD = dyn_cast<ObjCMethodDecl>(CurCodeDecl))
2975 RT = MD->getReturnType();
2976 else if (isa<BlockDecl>(CurCodeDecl))
2977 RT = BlockInfo->BlockExpression->getFunctionType()->getReturnType();
2978 else
2979 llvm_unreachable("Unexpected function/method type");
2980
David Blaikiebbafb8a2012-03-11 07:00:24 +00002981 assert(getLangOpts().ObjCAutoRefCount &&
John McCall31168b02011-06-15 23:02:42 +00002982 !FI.isReturnsRetained() &&
Akira Hatanaka9d8ac612016-02-17 21:09:50 +00002983 RT->isObjCRetainableType());
2984#endif
John McCall31168b02011-06-15 23:02:42 +00002985 RV = emitAutoreleaseOfResult(*this, RV);
2986 }
2987
Chris Lattner726b3d02010-06-26 23:13:19 +00002988 break;
Chris Lattner726b3d02010-06-26 23:13:19 +00002989
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002990 case ABIArgInfo::Ignore:
Chris Lattner726b3d02010-06-26 23:13:19 +00002991 break;
2992
John McCallf26e73d2016-03-11 04:30:43 +00002993 case ABIArgInfo::CoerceAndExpand: {
2994 auto coercionType = RetAI.getCoerceAndExpandType();
John McCallf26e73d2016-03-11 04:30:43 +00002995
2996 // Load all of the coerced elements out into results.
2997 llvm::SmallVector<llvm::Value*, 4> results;
2998 Address addr = Builder.CreateElementBitCast(ReturnValue, coercionType);
2999 for (unsigned i = 0, e = coercionType->getNumElements(); i != e; ++i) {
3000 auto coercedEltType = coercionType->getElementType(i);
3001 if (ABIArgInfo::isPaddingForCoerceAndExpand(coercedEltType))
3002 continue;
3003
James Y Knight751fe282019-02-09 22:22:28 +00003004 auto eltAddr = Builder.CreateStructGEP(addr, i);
John McCallf26e73d2016-03-11 04:30:43 +00003005 auto elt = Builder.CreateLoad(eltAddr);
3006 results.push_back(elt);
3007 }
3008
3009 // If we have one result, it's the single direct result type.
3010 if (results.size() == 1) {
3011 RV = results[0];
3012
3013 // Otherwise, we need to make a first-class aggregate.
3014 } else {
3015 // Construct a return type that lacks padding elements.
3016 llvm::Type *returnType = RetAI.getUnpaddedCoerceAndExpandType();
3017
3018 RV = llvm::UndefValue::get(returnType);
3019 for (unsigned i = 0, e = results.size(); i != e; ++i) {
3020 RV = Builder.CreateInsertValue(RV, results[i], i);
3021 }
3022 }
3023 break;
3024 }
3025
Chris Lattner726b3d02010-06-26 23:13:19 +00003026 case ABIArgInfo::Expand:
David Blaikie83d382b2011-09-23 05:06:16 +00003027 llvm_unreachable("Invalid ABI kind for return argument");
Chris Lattner726b3d02010-06-26 23:13:19 +00003028 }
3029
Alexey Samsonovde443c52014-08-13 00:26:40 +00003030 llvm::Instruction *Ret;
3031 if (RV) {
Vedant Kumarc34d3432017-06-23 21:32:38 +00003032 EmitReturnValueCheck(RV);
Alexey Samsonovde443c52014-08-13 00:26:40 +00003033 Ret = Builder.CreateRet(RV);
3034 } else {
3035 Ret = Builder.CreateRetVoid();
3036 }
3037
Duncan P. N. Exon Smith2809cc72015-03-30 20:01:41 +00003038 if (RetDbgLoc)
Benjamin Kramer03278662015-02-07 13:15:54 +00003039 Ret->setDebugLoc(std::move(RetDbgLoc));
Daniel Dunbar613855c2008-09-09 23:27:19 +00003040}
3041
Vedant Kumarc34d3432017-06-23 21:32:38 +00003042void CodeGenFunction::EmitReturnValueCheck(llvm::Value *RV) {
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003043 // A current decl may not be available when emitting vtable thunks.
3044 if (!CurCodeDecl)
3045 return;
3046
Vedant Kumar65f07852020-02-06 10:17:36 -08003047 // If the return block isn't reachable, neither is this check, so don't emit
3048 // it.
3049 if (ReturnBlock.isValid() && ReturnBlock.getBlock()->use_empty())
3050 return;
3051
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003052 ReturnsNonNullAttr *RetNNAttr = nullptr;
3053 if (SanOpts.has(SanitizerKind::ReturnsNonnullAttribute))
3054 RetNNAttr = CurCodeDecl->getAttr<ReturnsNonNullAttr>();
3055
3056 if (!RetNNAttr && !requiresReturnValueNullabilityCheck())
3057 return;
3058
3059 // Prefer the returns_nonnull attribute if it's present.
3060 SourceLocation AttrLoc;
3061 SanitizerMask CheckKind;
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00003062 SanitizerHandler Handler;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003063 if (RetNNAttr) {
3064 assert(!requiresReturnValueNullabilityCheck() &&
3065 "Cannot check nullability and the nonnull attribute");
3066 AttrLoc = RetNNAttr->getLocation();
3067 CheckKind = SanitizerKind::ReturnsNonnullAttribute;
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00003068 Handler = SanitizerHandler::NonnullReturn;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003069 } else {
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003070 if (auto *DD = dyn_cast<DeclaratorDecl>(CurCodeDecl))
3071 if (auto *TSI = DD->getTypeSourceInfo())
Vedant Kumar8b81ebf2020-02-10 13:10:47 -08003072 if (auto FTL = TSI->getTypeLoc().getAsAdjusted<FunctionTypeLoc>())
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003073 AttrLoc = FTL.getReturnLoc().findNullabilityLoc();
3074 CheckKind = SanitizerKind::NullabilityReturn;
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00003075 Handler = SanitizerHandler::NullabilityReturn;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003076 }
3077
3078 SanitizerScope SanScope(this);
3079
Vedant Kumarc34d3432017-06-23 21:32:38 +00003080 // Make sure the "return" source location is valid. If we're checking a
3081 // nullability annotation, make sure the preconditions for the check are met.
3082 llvm::BasicBlock *Check = createBasicBlock("nullcheck");
3083 llvm::BasicBlock *NoCheck = createBasicBlock("no.nullcheck");
3084 llvm::Value *SLocPtr = Builder.CreateLoad(ReturnLocation, "return.sloc.load");
3085 llvm::Value *CanNullCheck = Builder.CreateIsNotNull(SLocPtr);
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003086 if (requiresReturnValueNullabilityCheck())
Vedant Kumarc34d3432017-06-23 21:32:38 +00003087 CanNullCheck =
3088 Builder.CreateAnd(CanNullCheck, RetValNullabilityPrecondition);
3089 Builder.CreateCondBr(CanNullCheck, Check, NoCheck);
3090 EmitBlock(Check);
3091
3092 // Now do the null check.
3093 llvm::Value *Cond = Builder.CreateIsNotNull(RV);
3094 llvm::Constant *StaticData[] = {EmitCheckSourceLocation(AttrLoc)};
3095 llvm::Value *DynamicData[] = {SLocPtr};
3096 EmitCheck(std::make_pair(Cond, CheckKind), Handler, StaticData, DynamicData);
3097
3098 EmitBlock(NoCheck);
3099
3100#ifndef NDEBUG
3101 // The return location should not be used after the check has been emitted.
3102 ReturnLocation = Address::invalid();
3103#endif
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003104}
3105
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003106static bool isInAllocaArgument(CGCXXABI &ABI, QualType type) {
3107 const CXXRecordDecl *RD = type->getAsCXXRecordDecl();
3108 return RD && ABI.getRecordArgABI(RD) == CGCXXABI::RAA_DirectInMemory;
3109}
3110
John McCall7f416cc2015-09-08 08:05:57 +00003111static AggValueSlot createPlaceholderSlot(CodeGenFunction &CGF,
3112 QualType Ty) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003113 // FIXME: Generate IR in one pass, rather than going back and fixing up these
3114 // placeholders.
3115 llvm::Type *IRTy = CGF.ConvertTypeForMem(Ty);
Peter Collingbourneb367c562016-11-28 22:30:21 +00003116 llvm::Type *IRPtrTy = IRTy->getPointerTo();
3117 llvm::Value *Placeholder = llvm::UndefValue::get(IRPtrTy->getPointerTo());
John McCall7f416cc2015-09-08 08:05:57 +00003118
3119 // FIXME: When we generate this IR in one pass, we shouldn't need
3120 // this win32-specific alignment hack.
3121 CharUnits Align = CharUnits::fromQuantity(4);
Peter Collingbourneb367c562016-11-28 22:30:21 +00003122 Placeholder = CGF.Builder.CreateAlignedLoad(IRPtrTy, Placeholder, Align);
John McCall7f416cc2015-09-08 08:05:57 +00003123
3124 return AggValueSlot::forAddr(Address(Placeholder, Align),
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003125 Ty.getQualifiers(),
3126 AggValueSlot::IsNotDestructed,
3127 AggValueSlot::DoesNotNeedGCBarriers,
Richard Smithe78fac52018-04-05 20:52:58 +00003128 AggValueSlot::IsNotAliased,
3129 AggValueSlot::DoesNotOverlap);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003130}
3131
John McCall32ea9692011-03-11 20:59:21 +00003132void CodeGenFunction::EmitDelegateCallArg(CallArgList &args,
Nick Lewycky2d84e842013-10-02 02:29:49 +00003133 const VarDecl *param,
3134 SourceLocation loc) {
John McCall23f66262010-05-26 22:34:26 +00003135 // StartFunction converted the ABI-lowered parameter(s) into a
3136 // local alloca. We need to turn that into an r-value suitable
3137 // for EmitCall.
John McCall7f416cc2015-09-08 08:05:57 +00003138 Address local = GetAddrOfLocalVar(param);
John McCall23f66262010-05-26 22:34:26 +00003139
John McCall32ea9692011-03-11 20:59:21 +00003140 QualType type = param->getType();
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003141
Reid Kleckner25b56022018-12-12 23:46:06 +00003142 if (isInAllocaArgument(CGM.getCXXABI(), type)) {
3143 CGM.ErrorUnsupported(param, "forwarded non-trivially copyable parameter");
3144 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003145
John McCall811b2912016-11-18 01:08:24 +00003146 // GetAddrOfLocalVar returns a pointer-to-pointer for references,
3147 // but the argument needs to be the original pointer.
3148 if (type->isReferenceType()) {
3149 args.add(RValue::get(Builder.CreateLoad(local)), type);
3150
3151 // In ARC, move out of consumed arguments so that the release cleanup
3152 // entered by StartFunction doesn't cause an over-release. This isn't
3153 // optimal -O0 code generation, but it should get cleaned up when
3154 // optimization is enabled. This also assumes that delegate calls are
3155 // performed exactly once for a set of arguments, but that should be safe.
3156 } else if (getLangOpts().ObjCAutoRefCount &&
3157 param->hasAttr<NSConsumedAttr>() &&
3158 type->isObjCRetainableType()) {
3159 llvm::Value *ptr = Builder.CreateLoad(local);
3160 auto null =
3161 llvm::ConstantPointerNull::get(cast<llvm::PointerType>(ptr->getType()));
3162 Builder.CreateStore(null, local);
3163 args.add(RValue::get(ptr), type);
3164
Richard Smithd62d4982016-06-14 01:13:21 +00003165 // For the most part, we just need to load the alloca, except that
3166 // aggregate r-values are actually pointers to temporaries.
John McCall811b2912016-11-18 01:08:24 +00003167 } else {
Richard Smithd62d4982016-06-14 01:13:21 +00003168 args.add(convertTempToRValue(local, type, loc), type);
John McCall811b2912016-11-18 01:08:24 +00003169 }
Akira Hatanakaccda3d22018-04-27 06:57:00 +00003170
3171 // Deactivate the cleanup for the callee-destructed param that was pushed.
3172 if (hasAggregateEvaluationKind(type) && !CurFuncIsThunk &&
Simon Pilgrim1cd399c2019-10-03 11:22:48 +00003173 type->castAs<RecordType>()->getDecl()->isParamDestroyedInCallee() &&
Richard Smith2b4fa532019-09-29 05:08:46 +00003174 param->needsDestruction(getContext())) {
Akira Hatanakaccda3d22018-04-27 06:57:00 +00003175 EHScopeStack::stable_iterator cleanup =
3176 CalleeDestructedParamCleanups.lookup(cast<ParmVarDecl>(param));
3177 assert(cleanup.isValid() &&
3178 "cleanup for callee-destructed param not recorded");
3179 // This unreachable is a temporary marker which will be removed later.
3180 llvm::Instruction *isActive = Builder.CreateUnreachable();
3181 args.addArgCleanupDeactivation(cleanup, isActive);
3182 }
John McCall23f66262010-05-26 22:34:26 +00003183}
3184
John McCall31168b02011-06-15 23:02:42 +00003185static bool isProvablyNull(llvm::Value *addr) {
3186 return isa<llvm::ConstantPointerNull>(addr);
3187}
3188
John McCall31168b02011-06-15 23:02:42 +00003189/// Emit the actual writing-back of a writeback.
3190static void emitWriteback(CodeGenFunction &CGF,
3191 const CallArgList::Writeback &writeback) {
John McCalleff18842013-03-23 02:35:54 +00003192 const LValue &srcLV = writeback.Source;
Akira Hatanakaf139ae32019-12-03 15:17:01 -08003193 Address srcAddr = srcLV.getAddress(CGF);
John McCall7f416cc2015-09-08 08:05:57 +00003194 assert(!isProvablyNull(srcAddr.getPointer()) &&
John McCall31168b02011-06-15 23:02:42 +00003195 "shouldn't have writeback for provably null argument");
3196
Craig Topper8a13c412014-05-21 05:09:00 +00003197 llvm::BasicBlock *contBB = nullptr;
John McCall31168b02011-06-15 23:02:42 +00003198
3199 // If the argument wasn't provably non-null, we need to null check
3200 // before doing the store.
Nuno Lopes9211cee2017-09-09 18:25:36 +00003201 bool provablyNonNull = llvm::isKnownNonZero(srcAddr.getPointer(),
3202 CGF.CGM.getDataLayout());
John McCall31168b02011-06-15 23:02:42 +00003203 if (!provablyNonNull) {
3204 llvm::BasicBlock *writebackBB = CGF.createBasicBlock("icr.writeback");
3205 contBB = CGF.createBasicBlock("icr.done");
3206
John McCall7f416cc2015-09-08 08:05:57 +00003207 llvm::Value *isNull =
3208 CGF.Builder.CreateIsNull(srcAddr.getPointer(), "icr.isnull");
John McCall31168b02011-06-15 23:02:42 +00003209 CGF.Builder.CreateCondBr(isNull, contBB, writebackBB);
3210 CGF.EmitBlock(writebackBB);
3211 }
3212
3213 // Load the value to writeback.
3214 llvm::Value *value = CGF.Builder.CreateLoad(writeback.Temporary);
3215
3216 // Cast it back, in case we're writing an id to a Foo* or something.
John McCall7f416cc2015-09-08 08:05:57 +00003217 value = CGF.Builder.CreateBitCast(value, srcAddr.getElementType(),
3218 "icr.writeback-cast");
Fangrui Song6907ce22018-07-30 19:24:48 +00003219
John McCall31168b02011-06-15 23:02:42 +00003220 // Perform the writeback.
John McCalleff18842013-03-23 02:35:54 +00003221
3222 // If we have a "to use" value, it's something we need to emit a use
3223 // of. This has to be carefully threaded in: if it's done after the
3224 // release it's potentially undefined behavior (and the optimizer
3225 // will ignore it), and if it happens before the retain then the
3226 // optimizer could move the release there.
3227 if (writeback.ToUse) {
3228 assert(srcLV.getObjCLifetime() == Qualifiers::OCL_Strong);
3229
3230 // Retain the new value. No need to block-copy here: the block's
3231 // being passed up the stack.
3232 value = CGF.EmitARCRetainNonBlock(value);
3233
3234 // Emit the intrinsic use here.
3235 CGF.EmitARCIntrinsicUse(writeback.ToUse);
3236
3237 // Load the old value (primitively).
Nick Lewycky2d84e842013-10-02 02:29:49 +00003238 llvm::Value *oldValue = CGF.EmitLoadOfScalar(srcLV, SourceLocation());
John McCalleff18842013-03-23 02:35:54 +00003239
3240 // Put the new value in place (primitively).
3241 CGF.EmitStoreOfScalar(value, srcLV, /*init*/ false);
3242
3243 // Release the old value.
3244 CGF.EmitARCRelease(oldValue, srcLV.isARCPreciseLifetime());
3245
3246 // Otherwise, we can just do a normal lvalue store.
3247 } else {
3248 CGF.EmitStoreThroughLValue(RValue::get(value), srcLV);
3249 }
John McCall31168b02011-06-15 23:02:42 +00003250
3251 // Jump to the continuation block.
3252 if (!provablyNonNull)
3253 CGF.EmitBlock(contBB);
3254}
3255
3256static void emitWritebacks(CodeGenFunction &CGF,
3257 const CallArgList &args) {
Aaron Ballman36a7fa82014-03-17 17:22:27 +00003258 for (const auto &I : args.writebacks())
3259 emitWriteback(CGF, I);
John McCall31168b02011-06-15 23:02:42 +00003260}
3261
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003262static void deactivateArgCleanupsBeforeCall(CodeGenFunction &CGF,
3263 const CallArgList &CallArgs) {
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003264 ArrayRef<CallArgList::CallArgCleanup> Cleanups =
3265 CallArgs.getCleanupsToDeactivate();
3266 // Iterate in reverse to increase the likelihood of popping the cleanup.
Pete Cooper57d3f142015-07-30 17:22:52 +00003267 for (const auto &I : llvm::reverse(Cleanups)) {
3268 CGF.DeactivateCleanupBlock(I.Cleanup, I.IsActiveIP);
3269 I.IsActiveIP->eraseFromParent();
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003270 }
3271}
3272
John McCalleff18842013-03-23 02:35:54 +00003273static const Expr *maybeGetUnaryAddrOfOperand(const Expr *E) {
3274 if (const UnaryOperator *uop = dyn_cast<UnaryOperator>(E->IgnoreParens()))
3275 if (uop->getOpcode() == UO_AddrOf)
3276 return uop->getSubExpr();
Craig Topper8a13c412014-05-21 05:09:00 +00003277 return nullptr;
John McCalleff18842013-03-23 02:35:54 +00003278}
3279
John McCall31168b02011-06-15 23:02:42 +00003280/// Emit an argument that's being passed call-by-writeback. That is,
John McCall7f416cc2015-09-08 08:05:57 +00003281/// we are passing the address of an __autoreleased temporary; it
3282/// might be copy-initialized with the current value of the given
3283/// address, but it will definitely be copied out of after the call.
John McCall31168b02011-06-15 23:02:42 +00003284static void emitWritebackArg(CodeGenFunction &CGF, CallArgList &args,
3285 const ObjCIndirectCopyRestoreExpr *CRE) {
John McCalleff18842013-03-23 02:35:54 +00003286 LValue srcLV;
3287
3288 // Make an optimistic effort to emit the address as an l-value.
Eric Christopher2c4555a2015-06-19 01:52:53 +00003289 // This can fail if the argument expression is more complicated.
John McCalleff18842013-03-23 02:35:54 +00003290 if (const Expr *lvExpr = maybeGetUnaryAddrOfOperand(CRE->getSubExpr())) {
3291 srcLV = CGF.EmitLValue(lvExpr);
3292
3293 // Otherwise, just emit it as a scalar.
3294 } else {
John McCall7f416cc2015-09-08 08:05:57 +00003295 Address srcAddr = CGF.EmitPointerWithAlignment(CRE->getSubExpr());
John McCalleff18842013-03-23 02:35:54 +00003296
3297 QualType srcAddrType =
3298 CRE->getSubExpr()->getType()->castAs<PointerType>()->getPointeeType();
John McCall7f416cc2015-09-08 08:05:57 +00003299 srcLV = CGF.MakeAddrLValue(srcAddr, srcAddrType);
John McCalleff18842013-03-23 02:35:54 +00003300 }
Akira Hatanakaf139ae32019-12-03 15:17:01 -08003301 Address srcAddr = srcLV.getAddress(CGF);
John McCall31168b02011-06-15 23:02:42 +00003302
3303 // The dest and src types don't necessarily match in LLVM terms
3304 // because of the crazy ObjC compatibility rules.
3305
Chris Lattner2192fe52011-07-18 04:24:23 +00003306 llvm::PointerType *destType =
John McCall31168b02011-06-15 23:02:42 +00003307 cast<llvm::PointerType>(CGF.ConvertType(CRE->getType()));
3308
3309 // If the address is a constant null, just pass the appropriate null.
John McCall7f416cc2015-09-08 08:05:57 +00003310 if (isProvablyNull(srcAddr.getPointer())) {
John McCall31168b02011-06-15 23:02:42 +00003311 args.add(RValue::get(llvm::ConstantPointerNull::get(destType)),
3312 CRE->getType());
3313 return;
3314 }
3315
John McCall31168b02011-06-15 23:02:42 +00003316 // Create the temporary.
John McCall7f416cc2015-09-08 08:05:57 +00003317 Address temp = CGF.CreateTempAlloca(destType->getElementType(),
3318 CGF.getPointerAlign(),
3319 "icr.temp");
Fariborz Jahanianfbd19742012-11-27 23:02:53 +00003320 // Loading an l-value can introduce a cleanup if the l-value is __weak,
3321 // and that cleanup will be conditional if we can't prove that the l-value
3322 // isn't null, so we need to register a dominating point so that the cleanups
3323 // system will make valid IR.
3324 CodeGenFunction::ConditionalEvaluation condEval(CGF);
Fangrui Song6907ce22018-07-30 19:24:48 +00003325
John McCall31168b02011-06-15 23:02:42 +00003326 // Zero-initialize it if we're not doing a copy-initialization.
3327 bool shouldCopy = CRE->shouldCopy();
3328 if (!shouldCopy) {
3329 llvm::Value *null =
3330 llvm::ConstantPointerNull::get(
3331 cast<llvm::PointerType>(destType->getElementType()));
3332 CGF.Builder.CreateStore(null, temp);
3333 }
Craig Topper8a13c412014-05-21 05:09:00 +00003334
3335 llvm::BasicBlock *contBB = nullptr;
3336 llvm::BasicBlock *originBB = nullptr;
John McCall31168b02011-06-15 23:02:42 +00003337
3338 // If the address is *not* known to be non-null, we need to switch.
3339 llvm::Value *finalArgument;
3340
Nuno Lopes9211cee2017-09-09 18:25:36 +00003341 bool provablyNonNull = llvm::isKnownNonZero(srcAddr.getPointer(),
3342 CGF.CGM.getDataLayout());
John McCall31168b02011-06-15 23:02:42 +00003343 if (provablyNonNull) {
John McCall7f416cc2015-09-08 08:05:57 +00003344 finalArgument = temp.getPointer();
John McCall31168b02011-06-15 23:02:42 +00003345 } else {
John McCall7f416cc2015-09-08 08:05:57 +00003346 llvm::Value *isNull =
3347 CGF.Builder.CreateIsNull(srcAddr.getPointer(), "icr.isnull");
John McCall31168b02011-06-15 23:02:42 +00003348
Fangrui Song6907ce22018-07-30 19:24:48 +00003349 finalArgument = CGF.Builder.CreateSelect(isNull,
John McCall31168b02011-06-15 23:02:42 +00003350 llvm::ConstantPointerNull::get(destType),
John McCall7f416cc2015-09-08 08:05:57 +00003351 temp.getPointer(), "icr.argument");
John McCall31168b02011-06-15 23:02:42 +00003352
3353 // If we need to copy, then the load has to be conditional, which
3354 // means we need control flow.
3355 if (shouldCopy) {
John McCalleff18842013-03-23 02:35:54 +00003356 originBB = CGF.Builder.GetInsertBlock();
John McCall31168b02011-06-15 23:02:42 +00003357 contBB = CGF.createBasicBlock("icr.cont");
3358 llvm::BasicBlock *copyBB = CGF.createBasicBlock("icr.copy");
3359 CGF.Builder.CreateCondBr(isNull, contBB, copyBB);
3360 CGF.EmitBlock(copyBB);
Fariborz Jahanianfbd19742012-11-27 23:02:53 +00003361 condEval.begin(CGF);
John McCall31168b02011-06-15 23:02:42 +00003362 }
3363 }
3364
Craig Topper8a13c412014-05-21 05:09:00 +00003365 llvm::Value *valueToUse = nullptr;
John McCalleff18842013-03-23 02:35:54 +00003366
John McCall31168b02011-06-15 23:02:42 +00003367 // Perform a copy if necessary.
3368 if (shouldCopy) {
Nick Lewycky2d84e842013-10-02 02:29:49 +00003369 RValue srcRV = CGF.EmitLoadOfLValue(srcLV, SourceLocation());
John McCall31168b02011-06-15 23:02:42 +00003370 assert(srcRV.isScalar());
3371
3372 llvm::Value *src = srcRV.getScalarVal();
3373 src = CGF.Builder.CreateBitCast(src, destType->getElementType(),
3374 "icr.cast");
3375
3376 // Use an ordinary store, not a store-to-lvalue.
3377 CGF.Builder.CreateStore(src, temp);
John McCalleff18842013-03-23 02:35:54 +00003378
3379 // If optimization is enabled, and the value was held in a
3380 // __strong variable, we need to tell the optimizer that this
3381 // value has to stay alive until we're doing the store back.
3382 // This is because the temporary is effectively unretained,
3383 // and so otherwise we can violate the high-level semantics.
3384 if (CGF.CGM.getCodeGenOpts().OptimizationLevel != 0 &&
3385 srcLV.getObjCLifetime() == Qualifiers::OCL_Strong) {
3386 valueToUse = src;
3387 }
John McCall31168b02011-06-15 23:02:42 +00003388 }
Fangrui Song6907ce22018-07-30 19:24:48 +00003389
John McCall31168b02011-06-15 23:02:42 +00003390 // Finish the control flow if we needed it.
Fariborz Jahanianfbd19742012-11-27 23:02:53 +00003391 if (shouldCopy && !provablyNonNull) {
John McCalleff18842013-03-23 02:35:54 +00003392 llvm::BasicBlock *copyBB = CGF.Builder.GetInsertBlock();
John McCall31168b02011-06-15 23:02:42 +00003393 CGF.EmitBlock(contBB);
John McCalleff18842013-03-23 02:35:54 +00003394
3395 // Make a phi for the value to intrinsically use.
3396 if (valueToUse) {
3397 llvm::PHINode *phiToUse = CGF.Builder.CreatePHI(valueToUse->getType(), 2,
3398 "icr.to-use");
3399 phiToUse->addIncoming(valueToUse, copyBB);
3400 phiToUse->addIncoming(llvm::UndefValue::get(valueToUse->getType()),
3401 originBB);
3402 valueToUse = phiToUse;
3403 }
3404
Fariborz Jahanianfbd19742012-11-27 23:02:53 +00003405 condEval.end(CGF);
3406 }
John McCall31168b02011-06-15 23:02:42 +00003407
John McCalleff18842013-03-23 02:35:54 +00003408 args.addWriteback(srcLV, temp, valueToUse);
John McCall31168b02011-06-15 23:02:42 +00003409 args.add(RValue::get(finalArgument), CRE->getType());
3410}
3411
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003412void CallArgList::allocateArgumentMemory(CodeGenFunction &CGF) {
Richard Smith762672a2016-09-28 19:09:10 +00003413 assert(!StackBase);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003414
3415 // Save the stack.
3416 llvm::Function *F = CGF.CGM.getIntrinsic(llvm::Intrinsic::stacksave);
David Blaikie43f9bb72015-05-18 22:14:03 +00003417 StackBase = CGF.Builder.CreateCall(F, {}, "inalloca.save");
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003418}
3419
Nico Weber8cdb3f92015-08-25 18:43:32 +00003420void CallArgList::freeArgumentMemory(CodeGenFunction &CGF) const {
3421 if (StackBase) {
Reid Kleckner7c2f9e82015-10-08 00:17:45 +00003422 // Restore the stack after the call.
James Y Knight8799cae2019-02-03 21:53:49 +00003423 llvm::Function *F = CGF.CGM.getIntrinsic(llvm::Intrinsic::stackrestore);
Nico Weber8cdb3f92015-08-25 18:43:32 +00003424 CGF.Builder.CreateCall(F, StackBase);
3425 }
3426}
3427
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003428void CodeGenFunction::EmitNonNullArgCheck(RValue RV, QualType ArgType,
3429 SourceLocation ArgLoc,
Vedant Kumared00ea02017-03-06 05:28:22 +00003430 AbstractCallee AC,
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003431 unsigned ParmNum) {
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003432 if (!AC.getDecl() || !(SanOpts.has(SanitizerKind::NonnullAttribute) ||
3433 SanOpts.has(SanitizerKind::NullabilityArg)))
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003434 return;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003435
3436 // The param decl may be missing in a variadic function.
Vedant Kumared00ea02017-03-06 05:28:22 +00003437 auto PVD = ParmNum < AC.getNumParams() ? AC.getParamDecl(ParmNum) : nullptr;
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003438 unsigned ArgNo = PVD ? PVD->getFunctionScopeIndex() : ParmNum;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003439
Fangrui Song6907ce22018-07-30 19:24:48 +00003440 // Prefer the nonnull attribute if it's present.
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003441 const NonNullAttr *NNAttr = nullptr;
3442 if (SanOpts.has(SanitizerKind::NonnullAttribute))
3443 NNAttr = getNonNullAttr(AC.getDecl(), PVD, ArgType, ArgNo);
3444
3445 bool CanCheckNullability = false;
3446 if (SanOpts.has(SanitizerKind::NullabilityArg) && !NNAttr && PVD) {
3447 auto Nullability = PVD->getType()->getNullability(getContext());
3448 CanCheckNullability = Nullability &&
3449 *Nullability == NullabilityKind::NonNull &&
3450 PVD->getTypeSourceInfo();
3451 }
3452
3453 if (!NNAttr && !CanCheckNullability)
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003454 return;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003455
3456 SourceLocation AttrLoc;
3457 SanitizerMask CheckKind;
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00003458 SanitizerHandler Handler;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003459 if (NNAttr) {
3460 AttrLoc = NNAttr->getLocation();
3461 CheckKind = SanitizerKind::NonnullAttribute;
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00003462 Handler = SanitizerHandler::NonnullArg;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003463 } else {
3464 AttrLoc = PVD->getTypeSourceInfo()->getTypeLoc().findNullabilityLoc();
3465 CheckKind = SanitizerKind::NullabilityArg;
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00003466 Handler = SanitizerHandler::NullabilityArg;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003467 }
3468
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003469 SanitizerScope SanScope(this);
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003470 assert(RV.isScalar());
3471 llvm::Value *V = RV.getScalarVal();
3472 llvm::Value *Cond =
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003473 Builder.CreateICmpNE(V, llvm::Constant::getNullValue(V->getType()));
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003474 llvm::Constant *StaticData[] = {
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003475 EmitCheckSourceLocation(ArgLoc), EmitCheckSourceLocation(AttrLoc),
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003476 llvm::ConstantInt::get(Int32Ty, ArgNo + 1),
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003477 };
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00003478 EmitCheck(std::make_pair(Cond, CheckKind), Handler, StaticData, None);
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003479}
3480
David Blaikief05779e2015-07-21 18:37:18 +00003481void CodeGenFunction::EmitCallArgs(
3482 CallArgList &Args, ArrayRef<QualType> ArgTypes,
3483 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Vedant Kumared00ea02017-03-06 05:28:22 +00003484 AbstractCallee AC, unsigned ParamsToSkip, EvaluationOrder Order) {
David Blaikief05779e2015-07-21 18:37:18 +00003485 assert((int)ArgTypes.size() == (ArgRange.end() - ArgRange.begin()));
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003486
Reid Kleckner739756c2013-12-04 19:23:12 +00003487 // We *have* to evaluate arguments from right to left in the MS C++ ABI,
Richard Smitha560ccf2016-09-29 21:30:12 +00003488 // because arguments are destroyed left to right in the callee. As a special
3489 // case, there are certain language constructs that require left-to-right
3490 // evaluation, and in those cases we consider the evaluation order requirement
3491 // to trump the "destruction order is reverse construction order" guarantee.
3492 bool LeftToRight =
3493 CGM.getTarget().getCXXABI().areArgsDestroyedLeftToRightInCallee()
3494 ? Order == EvaluationOrder::ForceLeftToRight
3495 : Order != EvaluationOrder::ForceRightToLeft;
3496
George Burgess IV0d6592a2017-02-23 05:59:56 +00003497 auto MaybeEmitImplicitObjectSize = [&](unsigned I, const Expr *Arg,
3498 RValue EmittedArg) {
Vedant Kumared00ea02017-03-06 05:28:22 +00003499 if (!AC.hasFunctionDecl() || I >= AC.getNumParams())
George Burgess IV0d6592a2017-02-23 05:59:56 +00003500 return;
Vedant Kumared00ea02017-03-06 05:28:22 +00003501 auto *PS = AC.getParamDecl(I)->getAttr<PassObjectSizeAttr>();
George Burgess IV0d6592a2017-02-23 05:59:56 +00003502 if (PS == nullptr)
3503 return;
3504
3505 const auto &Context = getContext();
3506 auto SizeTy = Context.getSizeType();
3507 auto T = Builder.getIntNTy(Context.getTypeSize(SizeTy));
3508 assert(EmittedArg.getScalarVal() && "We emitted nothing for the arg?");
3509 llvm::Value *V = evaluateOrEmitBuiltinObjectSize(Arg, PS->getType(), T,
Erik Pilkington9c3b5882019-01-30 20:34:53 +00003510 EmittedArg.getScalarVal(),
Erik Pilkington02d5fb12019-03-19 20:44:18 +00003511 PS->isDynamic());
George Burgess IV0d6592a2017-02-23 05:59:56 +00003512 Args.add(RValue::get(V), SizeTy);
3513 // If we're emitting args in reverse, be sure to do so with
3514 // pass_object_size, as well.
3515 if (!LeftToRight)
3516 std::swap(Args.back(), *(&Args.back() - 1));
3517 };
3518
Richard Smitha560ccf2016-09-29 21:30:12 +00003519 // Insert a stack save if we're going to need any inalloca args.
3520 bool HasInAllocaArgs = false;
3521 if (CGM.getTarget().getCXXABI().isMicrosoft()) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003522 for (ArrayRef<QualType>::iterator I = ArgTypes.begin(), E = ArgTypes.end();
3523 I != E && !HasInAllocaArgs; ++I)
3524 HasInAllocaArgs = isInAllocaArgument(CGM.getCXXABI(), *I);
3525 if (HasInAllocaArgs) {
3526 assert(getTarget().getTriple().getArch() == llvm::Triple::x86);
3527 Args.allocateArgumentMemory(*this);
3528 }
Richard Smitha560ccf2016-09-29 21:30:12 +00003529 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003530
Richard Smitha560ccf2016-09-29 21:30:12 +00003531 // Evaluate each argument in the appropriate order.
3532 size_t CallArgsStart = Args.size();
3533 for (unsigned I = 0, E = ArgTypes.size(); I != E; ++I) {
3534 unsigned Idx = LeftToRight ? I : E - I - 1;
3535 CallExpr::const_arg_iterator Arg = ArgRange.begin() + Idx;
George Burgess IV0d6592a2017-02-23 05:59:56 +00003536 unsigned InitialArgSize = Args.size();
Akira Hatanaka46dd7dbc2017-06-28 00:42:48 +00003537 // If *Arg is an ObjCIndirectCopyRestoreExpr, check that either the types of
3538 // the argument and parameter match or the objc method is parameterized.
3539 assert((!isa<ObjCIndirectCopyRestoreExpr>(*Arg) ||
3540 getContext().hasSameUnqualifiedType((*Arg)->getType(),
3541 ArgTypes[Idx]) ||
3542 (isa<ObjCMethodDecl>(AC.getDecl()) &&
3543 isObjCMethodWithTypeParams(cast<ObjCMethodDecl>(AC.getDecl())))) &&
3544 "Argument and parameter types don't match");
Richard Smitha560ccf2016-09-29 21:30:12 +00003545 EmitCallArg(Args, *Arg, ArgTypes[Idx]);
George Burgess IV0d6592a2017-02-23 05:59:56 +00003546 // In particular, we depend on it being the last arg in Args, and the
3547 // objectsize bits depend on there only being one arg if !LeftToRight.
3548 assert(InitialArgSize + 1 == Args.size() &&
3549 "The code below depends on only adding one arg per EmitCallArg");
3550 (void)InitialArgSize;
Yaxun Liu5b330e82018-03-15 15:25:19 +00003551 // Since pointer argument are never emitted as LValue, it is safe to emit
3552 // non-null argument check for r-value only.
3553 if (!Args.back().hasLValue()) {
3554 RValue RVArg = Args.back().getKnownRValue();
3555 EmitNonNullArgCheck(RVArg, ArgTypes[Idx], (*Arg)->getExprLoc(), AC,
3556 ParamsToSkip + Idx);
3557 // @llvm.objectsize should never have side-effects and shouldn't need
3558 // destruction/cleanups, so we can safely "emit" it after its arg,
3559 // regardless of right-to-leftness
3560 MaybeEmitImplicitObjectSize(Idx, *Arg, RVArg);
3561 }
Richard Smitha560ccf2016-09-29 21:30:12 +00003562 }
Reid Kleckner739756c2013-12-04 19:23:12 +00003563
Richard Smitha560ccf2016-09-29 21:30:12 +00003564 if (!LeftToRight) {
Reid Kleckner739756c2013-12-04 19:23:12 +00003565 // Un-reverse the arguments we just evaluated so they match up with the LLVM
3566 // IR function.
3567 std::reverse(Args.begin() + CallArgsStart, Args.end());
Reid Kleckner739756c2013-12-04 19:23:12 +00003568 }
3569}
3570
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003571namespace {
3572
David Blaikie7e70d682015-08-18 22:40:54 +00003573struct DestroyUnpassedArg final : EHScopeStack::Cleanup {
John McCall7f416cc2015-09-08 08:05:57 +00003574 DestroyUnpassedArg(Address Addr, QualType Ty)
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003575 : Addr(Addr), Ty(Ty) {}
3576
John McCall7f416cc2015-09-08 08:05:57 +00003577 Address Addr;
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003578 QualType Ty;
3579
Craig Topper4f12f102014-03-12 06:41:41 +00003580 void Emit(CodeGenFunction &CGF, Flags flags) override {
Akira Hatanaka7275da02018-02-28 07:15:55 +00003581 QualType::DestructionKind DtorKind = Ty.isDestructedType();
3582 if (DtorKind == QualType::DK_cxx_destructor) {
3583 const CXXDestructorDecl *Dtor = Ty->getAsCXXRecordDecl()->getDestructor();
3584 assert(!Dtor->isTrivial());
3585 CGF.EmitCXXDestructorCall(Dtor, Dtor_Complete, /*for vbase*/ false,
Marco Antognini88559632019-07-22 09:39:13 +00003586 /*Delegating=*/false, Addr, Ty);
Akira Hatanaka7275da02018-02-28 07:15:55 +00003587 } else {
3588 CGF.callCStructDestructor(CGF.MakeAddrLValue(Addr, Ty));
3589 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003590 }
3591};
3592
David Blaikie38b25912015-02-09 19:13:51 +00003593struct DisableDebugLocationUpdates {
3594 CodeGenFunction &CGF;
3595 bool disabledDebugInfo;
3596 DisableDebugLocationUpdates(CodeGenFunction &CGF, const Expr *E) : CGF(CGF) {
3597 if ((disabledDebugInfo = isa<CXXDefaultArgExpr>(E) && CGF.getDebugInfo()))
3598 CGF.disableDebugInfo();
3599 }
3600 ~DisableDebugLocationUpdates() {
3601 if (disabledDebugInfo)
3602 CGF.enableDebugInfo();
3603 }
3604};
3605
Benjamin Kramer5b4296a2015-10-28 17:16:26 +00003606} // end anonymous namespace
3607
Yaxun Liu5b330e82018-03-15 15:25:19 +00003608RValue CallArg::getRValue(CodeGenFunction &CGF) const {
3609 if (!HasLV)
3610 return RV;
3611 LValue Copy = CGF.MakeAddrLValue(CGF.CreateMemTemp(Ty), Ty);
Richard Smithe78fac52018-04-05 20:52:58 +00003612 CGF.EmitAggregateCopy(Copy, LV, Ty, AggValueSlot::DoesNotOverlap,
3613 LV.isVolatile());
Yaxun Liu5b330e82018-03-15 15:25:19 +00003614 IsUsed = true;
Akira Hatanakaf139ae32019-12-03 15:17:01 -08003615 return RValue::getAggregate(Copy.getAddress(CGF));
Yaxun Liu5b330e82018-03-15 15:25:19 +00003616}
3617
3618void CallArg::copyInto(CodeGenFunction &CGF, Address Addr) const {
3619 LValue Dst = CGF.MakeAddrLValue(Addr, Ty);
3620 if (!HasLV && RV.isScalar())
Rui Ueyama49a3ad22019-07-16 04:46:31 +00003621 CGF.EmitStoreOfScalar(RV.getScalarVal(), Dst, /*isInit=*/true);
Yaxun Liu5b330e82018-03-15 15:25:19 +00003622 else if (!HasLV && RV.isComplex())
3623 CGF.EmitStoreOfComplex(RV.getComplexVal(), Dst, /*init=*/true);
3624 else {
Akira Hatanakaf139ae32019-12-03 15:17:01 -08003625 auto Addr = HasLV ? LV.getAddress(CGF) : RV.getAggregateAddress();
Yaxun Liu5b330e82018-03-15 15:25:19 +00003626 LValue SrcLV = CGF.MakeAddrLValue(Addr, Ty);
Richard Smithe78fac52018-04-05 20:52:58 +00003627 // We assume that call args are never copied into subobjects.
3628 CGF.EmitAggregateCopy(Dst, SrcLV, Ty, AggValueSlot::DoesNotOverlap,
Yaxun Liu5b330e82018-03-15 15:25:19 +00003629 HasLV ? LV.isVolatileQualified()
3630 : RV.isVolatileQualified());
3631 }
3632 IsUsed = true;
3633}
3634
John McCall32ea9692011-03-11 20:59:21 +00003635void CodeGenFunction::EmitCallArg(CallArgList &args, const Expr *E,
3636 QualType type) {
David Blaikie38b25912015-02-09 19:13:51 +00003637 DisableDebugLocationUpdates Dis(*this, E);
John McCall31168b02011-06-15 23:02:42 +00003638 if (const ObjCIndirectCopyRestoreExpr *CRE
3639 = dyn_cast<ObjCIndirectCopyRestoreExpr>(E)) {
Richard Smith9c6890a2012-11-01 22:30:59 +00003640 assert(getLangOpts().ObjCAutoRefCount);
John McCall31168b02011-06-15 23:02:42 +00003641 return emitWritebackArg(*this, args, CRE);
3642 }
3643
John McCall0a76c0c2011-08-26 18:42:59 +00003644 assert(type->isReferenceType() == E->isGLValue() &&
3645 "reference binding to unmaterialized r-value!");
3646
John McCall17054bd62011-08-26 21:08:13 +00003647 if (E->isGLValue()) {
3648 assert(E->getObjectKind() == OK_Ordinary);
Richard Smitha1c9d4d2013-06-12 23:38:09 +00003649 return args.add(EmitReferenceBindingToExpr(E), type);
John McCall17054bd62011-08-26 21:08:13 +00003650 }
Mike Stump11289f42009-09-09 15:08:12 +00003651
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003652 bool HasAggregateEvalKind = hasAggregateEvaluationKind(type);
3653
3654 // In the Microsoft C++ ABI, aggregate arguments are destructed by the callee.
3655 // However, we still have to push an EH-only cleanup in case we unwind before
3656 // we make it to the call.
Akira Hatanaka85282972018-05-15 21:00:30 +00003657 if (HasAggregateEvalKind &&
Simon Pilgrim1cd399c2019-10-03 11:22:48 +00003658 type->castAs<RecordType>()->getDecl()->isParamDestroyedInCallee()) {
Reid Klecknerac640602014-05-01 03:07:18 +00003659 // If we're using inalloca, use the argument memory. Otherwise, use a
Reid Klecknere39ee212014-05-03 00:33:28 +00003660 // temporary.
Reid Klecknerac640602014-05-01 03:07:18 +00003661 AggValueSlot Slot;
3662 if (args.isUsingInAlloca())
3663 Slot = createPlaceholderSlot(*this, type);
3664 else
3665 Slot = CreateAggTemp(type, "agg.tmp");
Reid Klecknere39ee212014-05-03 00:33:28 +00003666
Akira Hatanaka4ce0e5a2018-04-18 23:33:15 +00003667 bool DestroyedInCallee = true, NeedsEHCleanup = true;
3668 if (const auto *RD = type->getAsCXXRecordDecl())
3669 DestroyedInCallee = RD->hasNonTrivialDestructor();
3670 else
3671 NeedsEHCleanup = needsEHCleanup(type.isDestructedType());
3672
3673 if (DestroyedInCallee)
3674 Slot.setExternallyDestructed();
Reid Klecknere39ee212014-05-03 00:33:28 +00003675
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003676 EmitAggExpr(E, Slot);
3677 RValue RV = Slot.asRValue();
3678 args.add(RV, type);
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003679
Akira Hatanaka4ce0e5a2018-04-18 23:33:15 +00003680 if (DestroyedInCallee && NeedsEHCleanup) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003681 // Create a no-op GEP between the placeholder and the cleanup so we can
3682 // RAUW it successfully. It also serves as a marker of the first
3683 // instruction where the cleanup is active.
John McCall7f416cc2015-09-08 08:05:57 +00003684 pushFullExprCleanup<DestroyUnpassedArg>(EHCleanup, Slot.getAddress(),
3685 type);
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003686 // This unreachable is a temporary marker which will be removed later.
3687 llvm::Instruction *IsActive = Builder.CreateUnreachable();
3688 args.addArgCleanupDeactivation(EHStack.getInnermostEHScope(), IsActive);
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003689 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003690 return;
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003691 }
3692
3693 if (HasAggregateEvalKind && isa<ImplicitCastExpr>(E) &&
Eli Friedmandf968192011-05-26 00:10:27 +00003694 cast<CastExpr>(E)->getCastKind() == CK_LValueToRValue) {
3695 LValue L = EmitLValue(cast<CastExpr>(E)->getSubExpr());
3696 assert(L.isSimple());
Yaxun Liu5b330e82018-03-15 15:25:19 +00003697 args.addUncopiedAggregate(L, type);
Eli Friedmandf968192011-05-26 00:10:27 +00003698 return;
3699 }
3700
Erik Pilkingtone26c24b2020-02-12 12:02:58 -08003701 args.add(EmitAnyExprToTemp(E), type);
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00003702}
3703
Reid Kleckner79b0fd72014-10-10 00:05:45 +00003704QualType CodeGenFunction::getVarArgType(const Expr *Arg) {
3705 // System headers on Windows define NULL to 0 instead of 0LL on Win64. MSVC
3706 // implicitly widens null pointer constants that are arguments to varargs
3707 // functions to pointer-sized ints.
3708 if (!getTarget().getTriple().isOSWindows())
3709 return Arg->getType();
3710
3711 if (Arg->getType()->isIntegerType() &&
3712 getContext().getTypeSize(Arg->getType()) <
3713 getContext().getTargetInfo().getPointerWidth(0) &&
3714 Arg->isNullPointerConstant(getContext(),
3715 Expr::NPC_ValueDependentIsNotNull)) {
3716 return getContext().getIntPtrType();
3717 }
3718
3719 return Arg->getType();
3720}
3721
Dan Gohman515a60d2012-02-16 00:57:37 +00003722// In ObjC ARC mode with no ObjC ARC exception safety, tell the ARC
3723// optimizer it can aggressively ignore unwind edges.
3724void
3725CodeGenFunction::AddObjCARCExceptionMetadata(llvm::Instruction *Inst) {
3726 if (CGM.getCodeGenOpts().OptimizationLevel != 0 &&
3727 !CGM.getCodeGenOpts().ObjCAutoRefCountExceptions)
3728 Inst->setMetadata("clang.arc.no_objc_arc_exceptions",
3729 CGM.getNoObjCARCExceptionsMetadata());
3730}
3731
John McCall882987f2013-02-28 19:01:20 +00003732/// Emits a call to the given no-arguments nounwind runtime function.
3733llvm::CallInst *
James Y Knight9871db02019-02-05 16:42:33 +00003734CodeGenFunction::EmitNounwindRuntimeCall(llvm::FunctionCallee callee,
John McCall882987f2013-02-28 19:01:20 +00003735 const llvm::Twine &name) {
Craig Topper5fc8fc22014-08-27 06:28:36 +00003736 return EmitNounwindRuntimeCall(callee, None, name);
John McCall882987f2013-02-28 19:01:20 +00003737}
3738
3739/// Emits a call to the given nounwind runtime function.
3740llvm::CallInst *
James Y Knight9871db02019-02-05 16:42:33 +00003741CodeGenFunction::EmitNounwindRuntimeCall(llvm::FunctionCallee callee,
3742 ArrayRef<llvm::Value *> args,
John McCall882987f2013-02-28 19:01:20 +00003743 const llvm::Twine &name) {
3744 llvm::CallInst *call = EmitRuntimeCall(callee, args, name);
3745 call->setDoesNotThrow();
3746 return call;
3747}
3748
3749/// Emits a simple call (never an invoke) to the given no-arguments
3750/// runtime function.
James Y Knight9871db02019-02-05 16:42:33 +00003751llvm::CallInst *CodeGenFunction::EmitRuntimeCall(llvm::FunctionCallee callee,
3752 const llvm::Twine &name) {
Craig Topper5fc8fc22014-08-27 06:28:36 +00003753 return EmitRuntimeCall(callee, None, name);
John McCall882987f2013-02-28 19:01:20 +00003754}
3755
David Majnemer0b17d442015-12-15 21:27:59 +00003756// Calls which may throw must have operand bundles indicating which funclet
3757// they are nested within.
Reid Klecknerb75a3f02018-02-09 00:16:41 +00003758SmallVector<llvm::OperandBundleDef, 1>
3759CodeGenFunction::getBundlesForFunclet(llvm::Value *Callee) {
3760 SmallVector<llvm::OperandBundleDef, 1> BundleList;
Sanjay Patel846b63b2016-01-18 22:15:33 +00003761 // There is no need for a funclet operand bundle if we aren't inside a
3762 // funclet.
David Majnemer0b17d442015-12-15 21:27:59 +00003763 if (!CurrentFuncletPad)
Reid Klecknerb75a3f02018-02-09 00:16:41 +00003764 return BundleList;
David Majnemer0b17d442015-12-15 21:27:59 +00003765
3766 // Skip intrinsics which cannot throw.
3767 auto *CalleeFn = dyn_cast<llvm::Function>(Callee->stripPointerCasts());
3768 if (CalleeFn && CalleeFn->isIntrinsic() && CalleeFn->doesNotThrow())
Reid Klecknerb75a3f02018-02-09 00:16:41 +00003769 return BundleList;
David Majnemer0b17d442015-12-15 21:27:59 +00003770
3771 BundleList.emplace_back("funclet", CurrentFuncletPad);
Reid Klecknerb75a3f02018-02-09 00:16:41 +00003772 return BundleList;
David Majnemer0b17d442015-12-15 21:27:59 +00003773}
3774
David Majnemer971d31b2016-02-24 17:02:45 +00003775/// Emits a simple call (never an invoke) to the given runtime function.
James Y Knight9871db02019-02-05 16:42:33 +00003776llvm::CallInst *CodeGenFunction::EmitRuntimeCall(llvm::FunctionCallee callee,
3777 ArrayRef<llvm::Value *> args,
3778 const llvm::Twine &name) {
3779 llvm::CallInst *call = Builder.CreateCall(
3780 callee, args, getBundlesForFunclet(callee.getCallee()), name);
David Majnemer971d31b2016-02-24 17:02:45 +00003781 call->setCallingConv(getRuntimeCC());
3782 return call;
3783}
3784
John McCall882987f2013-02-28 19:01:20 +00003785/// Emits a call or invoke to the given noreturn runtime function.
James Y Knight9871db02019-02-05 16:42:33 +00003786void CodeGenFunction::EmitNoreturnRuntimeCallOrInvoke(
3787 llvm::FunctionCallee callee, ArrayRef<llvm::Value *> args) {
Reid Klecknerb75a3f02018-02-09 00:16:41 +00003788 SmallVector<llvm::OperandBundleDef, 1> BundleList =
James Y Knight9871db02019-02-05 16:42:33 +00003789 getBundlesForFunclet(callee.getCallee());
David Majnemer0b17d442015-12-15 21:27:59 +00003790
John McCall882987f2013-02-28 19:01:20 +00003791 if (getInvokeDest()) {
Fangrui Song6907ce22018-07-30 19:24:48 +00003792 llvm::InvokeInst *invoke =
John McCall882987f2013-02-28 19:01:20 +00003793 Builder.CreateInvoke(callee,
3794 getUnreachableBlock(),
3795 getInvokeDest(),
David Majnemer0b17d442015-12-15 21:27:59 +00003796 args,
3797 BundleList);
John McCall882987f2013-02-28 19:01:20 +00003798 invoke->setDoesNotReturn();
3799 invoke->setCallingConv(getRuntimeCC());
3800 } else {
David Majnemer0b17d442015-12-15 21:27:59 +00003801 llvm::CallInst *call = Builder.CreateCall(callee, args, BundleList);
John McCall882987f2013-02-28 19:01:20 +00003802 call->setDoesNotReturn();
3803 call->setCallingConv(getRuntimeCC());
3804 Builder.CreateUnreachable();
3805 }
3806}
3807
Sanjay Patel846b63b2016-01-18 22:15:33 +00003808/// Emits a call or invoke instruction to the given nullary runtime function.
James Y Knight9871db02019-02-05 16:42:33 +00003809llvm::CallBase *
3810CodeGenFunction::EmitRuntimeCallOrInvoke(llvm::FunctionCallee callee,
3811 const Twine &name) {
Craig Topper5fc8fc22014-08-27 06:28:36 +00003812 return EmitRuntimeCallOrInvoke(callee, None, name);
John McCall882987f2013-02-28 19:01:20 +00003813}
3814
3815/// Emits a call or invoke instruction to the given runtime function.
James Y Knight9871db02019-02-05 16:42:33 +00003816llvm::CallBase *
3817CodeGenFunction::EmitRuntimeCallOrInvoke(llvm::FunctionCallee callee,
3818 ArrayRef<llvm::Value *> args,
3819 const Twine &name) {
James Y Knight3933add2019-01-30 02:54:28 +00003820 llvm::CallBase *call = EmitCallOrInvoke(callee, args, name);
3821 call->setCallingConv(getRuntimeCC());
3822 return call;
John McCall882987f2013-02-28 19:01:20 +00003823}
3824
John McCallbd309292010-07-06 01:34:17 +00003825/// Emits a call or invoke instruction to the given function, depending
3826/// on the current state of the EH stack.
James Y Knight9871db02019-02-05 16:42:33 +00003827llvm::CallBase *CodeGenFunction::EmitCallOrInvoke(llvm::FunctionCallee Callee,
James Y Knight3933add2019-01-30 02:54:28 +00003828 ArrayRef<llvm::Value *> Args,
3829 const Twine &Name) {
John McCallbd309292010-07-06 01:34:17 +00003830 llvm::BasicBlock *InvokeDest = getInvokeDest();
Reid Klecknerb75a3f02018-02-09 00:16:41 +00003831 SmallVector<llvm::OperandBundleDef, 1> BundleList =
James Y Knight9871db02019-02-05 16:42:33 +00003832 getBundlesForFunclet(Callee.getCallee());
John McCallbd309292010-07-06 01:34:17 +00003833
James Y Knight3933add2019-01-30 02:54:28 +00003834 llvm::CallBase *Inst;
Dan Gohman515a60d2012-02-16 00:57:37 +00003835 if (!InvokeDest)
David Majnemer3df77bc2016-01-26 23:14:47 +00003836 Inst = Builder.CreateCall(Callee, Args, BundleList, Name);
Dan Gohman515a60d2012-02-16 00:57:37 +00003837 else {
3838 llvm::BasicBlock *ContBB = createBasicBlock("invoke.cont");
David Majnemer3df77bc2016-01-26 23:14:47 +00003839 Inst = Builder.CreateInvoke(Callee, ContBB, InvokeDest, Args, BundleList,
3840 Name);
Dan Gohman515a60d2012-02-16 00:57:37 +00003841 EmitBlock(ContBB);
3842 }
3843
3844 // In ObjC ARC mode with no ObjC ARC exception safety, tell the ARC
3845 // optimizer it can aggressively ignore unwind edges.
David Blaikiebbafb8a2012-03-11 07:00:24 +00003846 if (CGM.getLangOpts().ObjCAutoRefCount)
Dan Gohman515a60d2012-02-16 00:57:37 +00003847 AddObjCARCExceptionMetadata(Inst);
3848
James Y Knight3933add2019-01-30 02:54:28 +00003849 return Inst;
John McCallbd309292010-07-06 01:34:17 +00003850}
3851
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003852void CodeGenFunction::deferPlaceholderReplacement(llvm::Instruction *Old,
3853 llvm::Value *New) {
3854 DeferredReplacements.push_back(std::make_pair(Old, New));
3855}
Chris Lattnerd59d8672011-07-12 06:29:11 +00003856
Roman Lebedeve819f7c2020-01-23 22:50:15 +03003857namespace {
3858
3859/// Specify given \p NewAlign as the alignment of return value attribute. If
3860/// such attribute already exists, re-set it to the maximal one of two options.
3861LLVM_NODISCARD llvm::AttributeList
3862maybeRaiseRetAlignmentAttribute(llvm::LLVMContext &Ctx,
3863 const llvm::AttributeList &Attrs,
3864 llvm::Align NewAlign) {
3865 llvm::Align CurAlign = Attrs.getRetAlignment().valueOrOne();
3866 if (CurAlign >= NewAlign)
3867 return Attrs;
3868 llvm::Attribute AlignAttr = llvm::Attribute::getWithAlignment(Ctx, NewAlign);
3869 return Attrs
3870 .removeAttribute(Ctx, llvm::AttributeList::ReturnIndex,
3871 llvm::Attribute::AttrKind::Alignment)
3872 .addAttribute(Ctx, llvm::AttributeList::ReturnIndex, AlignAttr);
3873}
3874
3875template <typename AlignedAttrTy> class AbstractAssumeAlignedAttrEmitter {
3876protected:
3877 CodeGenFunction &CGF;
3878
3879 /// We do nothing if this is, or becomes, nullptr.
3880 const AlignedAttrTy *AA = nullptr;
3881
3882 llvm::Value *Alignment = nullptr; // May or may not be a constant.
3883 llvm::ConstantInt *OffsetCI = nullptr; // Constant, hopefully zero.
3884
3885 AbstractAssumeAlignedAttrEmitter(CodeGenFunction &CGF_, const Decl *FuncDecl)
3886 : CGF(CGF_) {
3887 if (!FuncDecl)
3888 return;
3889 AA = FuncDecl->getAttr<AlignedAttrTy>();
3890 }
3891
3892public:
3893 /// If we can, materialize the alignment as an attribute on return value.
3894 LLVM_NODISCARD llvm::AttributeList
3895 TryEmitAsCallSiteAttribute(const llvm::AttributeList &Attrs) {
3896 if (!AA || OffsetCI || CGF.SanOpts.has(SanitizerKind::Alignment))
3897 return Attrs;
3898 const auto *AlignmentCI = dyn_cast<llvm::ConstantInt>(Alignment);
3899 if (!AlignmentCI)
3900 return Attrs;
Roman Lebedev9ea5d172020-02-20 16:39:26 +03003901 // We may legitimately have non-power-of-2 alignment here.
3902 // If so, this is UB land, emit it via `@llvm.assume` instead.
3903 if (!AlignmentCI->getValue().isPowerOf2())
3904 return Attrs;
Roman Lebedeve819f7c2020-01-23 22:50:15 +03003905 llvm::AttributeList NewAttrs = maybeRaiseRetAlignmentAttribute(
3906 CGF.getLLVMContext(), Attrs,
3907 llvm::Align(
3908 AlignmentCI->getLimitedValue(llvm::Value::MaximumAlignment)));
3909 AA = nullptr; // We're done. Disallow doing anything else.
3910 return NewAttrs;
3911 }
3912
3913 /// Emit alignment assumption.
3914 /// This is a general fallback that we take if either there is an offset,
3915 /// or the alignment is variable or we are sanitizing for alignment.
3916 void EmitAsAnAssumption(SourceLocation Loc, QualType RetTy, RValue &Ret) {
3917 if (!AA)
3918 return;
Fangrui Song1d49eb02020-02-13 16:36:27 -08003919 CGF.emitAlignmentAssumption(Ret.getScalarVal(), RetTy, Loc,
Roman Lebedeve819f7c2020-01-23 22:50:15 +03003920 AA->getLocation(), Alignment, OffsetCI);
3921 AA = nullptr; // We're done. Disallow doing anything else.
3922 }
3923};
3924
3925/// Helper data structure to emit `AssumeAlignedAttr`.
3926class AssumeAlignedAttrEmitter final
3927 : public AbstractAssumeAlignedAttrEmitter<AssumeAlignedAttr> {
3928public:
3929 AssumeAlignedAttrEmitter(CodeGenFunction &CGF_, const Decl *FuncDecl)
3930 : AbstractAssumeAlignedAttrEmitter(CGF_, FuncDecl) {
3931 if (!AA)
3932 return;
3933 // It is guaranteed that the alignment/offset are constants.
3934 Alignment = cast<llvm::ConstantInt>(CGF.EmitScalarExpr(AA->getAlignment()));
3935 if (Expr *Offset = AA->getOffset()) {
3936 OffsetCI = cast<llvm::ConstantInt>(CGF.EmitScalarExpr(Offset));
3937 if (OffsetCI->isNullValue()) // Canonicalize zero offset to no offset.
3938 OffsetCI = nullptr;
3939 }
3940 }
3941};
3942
Roman Lebedev5ffe6402020-01-23 22:50:24 +03003943/// Helper data structure to emit `AllocAlignAttr`.
3944class AllocAlignAttrEmitter final
3945 : public AbstractAssumeAlignedAttrEmitter<AllocAlignAttr> {
3946public:
3947 AllocAlignAttrEmitter(CodeGenFunction &CGF_, const Decl *FuncDecl,
3948 const CallArgList &CallArgs)
3949 : AbstractAssumeAlignedAttrEmitter(CGF_, FuncDecl) {
3950 if (!AA)
3951 return;
3952 // Alignment may or may not be a constant, and that is okay.
3953 Alignment = CallArgs[AA->getParamIndex().getLLVMIndex()]
3954 .getRValue(CGF)
3955 .getScalarVal();
3956 }
3957};
3958
Roman Lebedeve819f7c2020-01-23 22:50:15 +03003959} // namespace
3960
Daniel Dunbard931a872009-02-02 22:03:45 +00003961RValue CodeGenFunction::EmitCall(const CGFunctionInfo &CallInfo,
John McCallb92ab1a2016-10-26 23:46:34 +00003962 const CGCallee &Callee,
Anders Carlsson61a401c2009-12-24 19:25:24 +00003963 ReturnValueSlot ReturnValue,
Daniel Dunbarcdbb5e32009-02-20 18:06:48 +00003964 const CallArgList &CallArgs,
James Y Knight3933add2019-01-30 02:54:28 +00003965 llvm::CallBase **callOrInvoke,
Vedant Kumar09b5bfd2017-12-21 00:10:25 +00003966 SourceLocation Loc) {
Mike Stump18bb9282009-05-16 07:57:57 +00003967 // FIXME: We no longer need the types from CallArgs; lift up and simplify.
Daniel Dunbar613855c2008-09-09 23:27:19 +00003968
Peter Collingbourneea211002018-02-05 23:09:13 +00003969 assert(Callee.isOrdinary() || Callee.isVirtual());
John McCallb92ab1a2016-10-26 23:46:34 +00003970
Daniel Dunbar613855c2008-09-09 23:27:19 +00003971 // Handle struct-return functions by passing a pointer to the
3972 // location that we would like to return into.
Daniel Dunbar7633cbf2009-02-02 21:43:58 +00003973 QualType RetTy = CallInfo.getReturnType();
Daniel Dunbarb52d0772009-02-03 05:59:18 +00003974 const ABIArgInfo &RetAI = CallInfo.getReturnInfo();
Mike Stump11289f42009-09-09 15:08:12 +00003975
James Y Knightcfe8cd72019-02-07 01:15:41 +00003976 llvm::FunctionType *IRFuncTy = getTypes().GetFunctionType(CallInfo);
John McCallb92ab1a2016-10-26 23:46:34 +00003977
Amy Huang0d0334f2019-04-12 20:25:30 +00003978 const Decl *TargetDecl = Callee.getAbstractInfo().getCalleeDecl().getDecl();
Erich Keane36176242019-06-21 22:29:32 +00003979 if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(TargetDecl))
3980 // We can only guarantee that a function is called from the correct
3981 // context/function based on the appropriate target attributes,
3982 // so only check in the case where we have both always_inline and target
3983 // since otherwise we could be making a conditional call after a check for
3984 // the proper cpu features (and it won't cause code generation issues due to
3985 // function based code generation).
3986 if (TargetDecl->hasAttr<AlwaysInlineAttr>() &&
3987 TargetDecl->hasAttr<TargetAttr>())
3988 checkTargetFeatures(Loc, FD);
Amy Huang0d0334f2019-04-12 20:25:30 +00003989
James Y Knightb92d2902019-02-05 16:05:50 +00003990#ifndef NDEBUG
3991 if (!(CallInfo.isVariadic() && CallInfo.getArgStruct())) {
3992 // For an inalloca varargs function, we don't expect CallInfo to match the
3993 // function pointer's type, because the inalloca struct a will have extra
3994 // fields in it for the varargs parameters. Code later in this function
3995 // bitcasts the function pointer to the type derived from CallInfo.
3996 //
3997 // In other cases, we assert that the types match up (until pointers stop
3998 // having pointee types).
James Y Knightcfe8cd72019-02-07 01:15:41 +00003999 llvm::Type *TypeFromVal;
4000 if (Callee.isVirtual())
4001 TypeFromVal = Callee.getVirtualFunctionType();
4002 else
4003 TypeFromVal =
4004 Callee.getFunctionPointer()->getType()->getPointerElementType();
4005 assert(IRFuncTy == TypeFromVal);
James Y Knightb92d2902019-02-05 16:05:50 +00004006 }
4007#endif
4008
John McCallb92ab1a2016-10-26 23:46:34 +00004009 // 1. Set up the arguments.
Mike Stump11289f42009-09-09 15:08:12 +00004010
Reid Kleckner314ef7b2014-02-01 00:04:45 +00004011 // If we're using inalloca, insert the allocation after the stack save.
4012 // FIXME: Do this earlier rather than hacking it in here!
John McCall7f416cc2015-09-08 08:05:57 +00004013 Address ArgMemory = Address::invalid();
Reid Kleckner314ef7b2014-02-01 00:04:45 +00004014 if (llvm::StructType *ArgStruct = CallInfo.getArgStruct()) {
Matt Arsenault502ad602017-04-10 22:28:02 +00004015 const llvm::DataLayout &DL = CGM.getDataLayout();
Reid Kleckner9df1d972014-04-10 01:40:15 +00004016 llvm::Instruction *IP = CallArgs.getStackBase();
4017 llvm::AllocaInst *AI;
4018 if (IP) {
4019 IP = IP->getNextNode();
Matt Arsenault502ad602017-04-10 22:28:02 +00004020 AI = new llvm::AllocaInst(ArgStruct, DL.getAllocaAddrSpace(),
4021 "argmem", IP);
Reid Kleckner9df1d972014-04-10 01:40:15 +00004022 } else {
Reid Kleckner966abe72014-05-15 23:01:46 +00004023 AI = CreateTempAlloca(ArgStruct, "argmem");
Reid Kleckner9df1d972014-04-10 01:40:15 +00004024 }
John McCall7f416cc2015-09-08 08:05:57 +00004025 auto Align = CallInfo.getArgStructAlignment();
Guillaume Chateletc79099e2019-10-03 13:00:29 +00004026 AI->setAlignment(Align.getAsAlign());
Reid Kleckner314ef7b2014-02-01 00:04:45 +00004027 AI->setUsedWithInAlloca(true);
4028 assert(AI->isUsedWithInAlloca() && !AI->isStaticAlloca());
John McCall7f416cc2015-09-08 08:05:57 +00004029 ArgMemory = Address(AI, Align);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00004030 }
4031
Alexey Samsonov153004f2014-09-29 22:08:00 +00004032 ClangToLLVMArgMapping IRFunctionArgs(CGM.getContext(), CallInfo);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004033 SmallVector<llvm::Value *, 16> IRCallArgs(IRFunctionArgs.totalIRArgs());
4034
Chris Lattner4ca97c32009-06-13 00:26:38 +00004035 // If the call returns a temporary with struct return, create a temporary
Anders Carlsson17490832009-12-24 20:40:36 +00004036 // alloca to hold the result, unless one is given to us.
John McCall7f416cc2015-09-08 08:05:57 +00004037 Address SRetPtr = Address::invalid();
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00004038 Address SRetAlloca = Address::invalid();
George Burgess IV003be7c2018-03-08 05:32:30 +00004039 llvm::Value *UnusedReturnSizePtr = nullptr;
John McCallf26e73d2016-03-11 04:30:43 +00004040 if (RetAI.isIndirect() || RetAI.isInAlloca() || RetAI.isCoerceAndExpand()) {
John McCall7f416cc2015-09-08 08:05:57 +00004041 if (!ReturnValue.isNull()) {
4042 SRetPtr = ReturnValue.getValue();
4043 } else {
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00004044 SRetPtr = CreateMemTemp(RetTy, "tmp", &SRetAlloca);
Leny Kholodov6aab1112015-06-08 10:23:49 +00004045 if (HaveInsertPoint() && ReturnValue.isUnused()) {
4046 uint64_t size =
4047 CGM.getDataLayout().getTypeAllocSize(ConvertTypeForMem(RetTy));
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00004048 UnusedReturnSizePtr = EmitLifetimeStart(size, SRetAlloca.getPointer());
Leny Kholodov6aab1112015-06-08 10:23:49 +00004049 }
4050 }
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004051 if (IRFunctionArgs.hasSRetArg()) {
John McCall7f416cc2015-09-08 08:05:57 +00004052 IRCallArgs[IRFunctionArgs.getSRetArgNo()] = SRetPtr.getPointer();
John McCallf26e73d2016-03-11 04:30:43 +00004053 } else if (RetAI.isInAlloca()) {
James Y Knight751fe282019-02-09 22:22:28 +00004054 Address Addr =
4055 Builder.CreateStructGEP(ArgMemory, RetAI.getInAllocaFieldIndex());
John McCall7f416cc2015-09-08 08:05:57 +00004056 Builder.CreateStore(SRetPtr.getPointer(), Addr);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00004057 }
Anders Carlsson17490832009-12-24 20:40:36 +00004058 }
Mike Stump11289f42009-09-09 15:08:12 +00004059
John McCall12f23522016-04-04 18:33:08 +00004060 Address swiftErrorTemp = Address::invalid();
4061 Address swiftErrorArg = Address::invalid();
4062
Francis Visoiu Mistrih143f6b82019-10-08 22:10:38 +00004063 // When passing arguments using temporary allocas, we need to add the
4064 // appropriate lifetime markers. This vector keeps track of all the lifetime
4065 // markers that need to be ended right after the call.
4066 SmallVector<CallLifetimeEnd, 2> CallLifetimeEndAfterCall;
4067
John McCallb92ab1a2016-10-26 23:46:34 +00004068 // Translate all of the arguments as necessary to match the IR lowering.
Daniel Dunbara45bdbb2009-02-04 21:17:21 +00004069 assert(CallInfo.arg_size() == CallArgs.size() &&
4070 "Mismatch between function signature & arguments.");
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004071 unsigned ArgNo = 0;
Daniel Dunbarb52d0772009-02-03 05:59:18 +00004072 CGFunctionInfo::const_arg_iterator info_it = CallInfo.arg_begin();
Mike Stump11289f42009-09-09 15:08:12 +00004073 for (CallArgList::const_iterator I = CallArgs.begin(), E = CallArgs.end();
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004074 I != E; ++I, ++info_it, ++ArgNo) {
Daniel Dunbarb52d0772009-02-03 05:59:18 +00004075 const ABIArgInfo &ArgInfo = info_it->info;
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00004076
Rafael Espindolafad28de2012-10-24 01:59:00 +00004077 // Insert a padding argument to ensure proper alignment.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004078 if (IRFunctionArgs.hasPaddingArg(ArgNo))
4079 IRCallArgs[IRFunctionArgs.getPaddingArgNo(ArgNo)] =
4080 llvm::UndefValue::get(ArgInfo.getPaddingType());
4081
4082 unsigned FirstIRArg, NumIRArgs;
4083 std::tie(FirstIRArg, NumIRArgs) = IRFunctionArgs.getIRArgs(ArgNo);
Rafael Espindolafad28de2012-10-24 01:59:00 +00004084
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00004085 switch (ArgInfo.getKind()) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00004086 case ABIArgInfo::InAlloca: {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004087 assert(NumIRArgs == 0);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00004088 assert(getTarget().getTriple().getArch() == llvm::Triple::x86);
Yaxun Liu5b330e82018-03-15 15:25:19 +00004089 if (I->isAggregate()) {
Yaxun Liu5b330e82018-03-15 15:25:19 +00004090 Address Addr = I->hasLValue()
Akira Hatanakaf139ae32019-12-03 15:17:01 -08004091 ? I->getKnownLValue().getAddress(*this)
Yaxun Liu5b330e82018-03-15 15:25:19 +00004092 : I->getKnownRValue().getAggregateAddress();
Reid Kleckner314ef7b2014-02-01 00:04:45 +00004093 llvm::Instruction *Placeholder =
Yaxun Liu5b330e82018-03-15 15:25:19 +00004094 cast<llvm::Instruction>(Addr.getPointer());
Reid Kleckner2c6a3892020-02-11 16:03:26 -08004095
4096 if (!ArgInfo.getInAllocaIndirect()) {
4097 // Replace the placeholder with the appropriate argument slot GEP.
4098 CGBuilderTy::InsertPoint IP = Builder.saveIP();
4099 Builder.SetInsertPoint(Placeholder);
4100 Addr = Builder.CreateStructGEP(ArgMemory,
4101 ArgInfo.getInAllocaFieldIndex());
4102 Builder.restoreIP(IP);
4103 } else {
4104 // For indirect things such as overaligned structs, replace the
4105 // placeholder with a regular aggregate temporary alloca. Store the
4106 // address of this alloca into the struct.
4107 Addr = CreateMemTemp(info_it->type, "inalloca.indirect.tmp");
4108 Address ArgSlot = Builder.CreateStructGEP(
4109 ArgMemory, ArgInfo.getInAllocaFieldIndex());
4110 Builder.CreateStore(Addr.getPointer(), ArgSlot);
4111 }
Hans Wennborgeaabaf72020-01-28 22:17:31 +01004112 deferPlaceholderReplacement(Placeholder, Addr.getPointer());
Reid Kleckner2c6a3892020-02-11 16:03:26 -08004113 } else if (ArgInfo.getInAllocaIndirect()) {
4114 // Make a temporary alloca and store the address of it into the argument
4115 // struct.
4116 Address Addr = CreateMemTempWithoutCast(
4117 I->Ty, getContext().getTypeAlignInChars(I->Ty),
4118 "indirect-arg-temp");
4119 I->copyInto(*this, Addr);
4120 Address ArgSlot =
4121 Builder.CreateStructGEP(ArgMemory, ArgInfo.getInAllocaFieldIndex());
4122 Builder.CreateStore(Addr.getPointer(), ArgSlot);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00004123 } else {
4124 // Store the RValue into the argument struct.
James Y Knight751fe282019-02-09 22:22:28 +00004125 Address Addr =
4126 Builder.CreateStructGEP(ArgMemory, ArgInfo.getInAllocaFieldIndex());
John McCall7f416cc2015-09-08 08:05:57 +00004127 unsigned AS = Addr.getType()->getPointerAddressSpace();
David Majnemer32b57b02014-03-31 16:12:47 +00004128 llvm::Type *MemType = ConvertTypeForMem(I->Ty)->getPointerTo(AS);
4129 // There are some cases where a trivial bitcast is not avoidable. The
4130 // definition of a type later in a translation unit may change it's type
4131 // from {}* to (%struct.foo*)*.
John McCall7f416cc2015-09-08 08:05:57 +00004132 if (Addr.getType() != MemType)
David Majnemer32b57b02014-03-31 16:12:47 +00004133 Addr = Builder.CreateBitCast(Addr, MemType);
Yaxun Liu5b330e82018-03-15 15:25:19 +00004134 I->copyInto(*this, Addr);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00004135 }
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004136 break;
Reid Kleckner314ef7b2014-02-01 00:04:45 +00004137 }
4138
Daniel Dunbar03816342010-08-21 02:24:36 +00004139 case ABIArgInfo::Indirect: {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004140 assert(NumIRArgs == 1);
Yaxun Liu5b330e82018-03-15 15:25:19 +00004141 if (!I->isAggregate()) {
Daniel Dunbar747865a2009-02-05 09:16:39 +00004142 // Make a temporary alloca to pass the argument.
Yaxun Liuaefdb8e2018-06-15 15:33:22 +00004143 Address Addr = CreateMemTempWithoutCast(
4144 I->Ty, ArgInfo.getIndirectAlign(), "indirect-arg-temp");
John McCall7f416cc2015-09-08 08:05:57 +00004145 IRCallArgs[FirstIRArg] = Addr.getPointer();
John McCall47fb9502013-03-07 21:37:08 +00004146
Yaxun Liu5b330e82018-03-15 15:25:19 +00004147 I->copyInto(*this, Addr);
Daniel Dunbar747865a2009-02-05 09:16:39 +00004148 } else {
Eli Friedmaneb7fab62011-06-14 01:37:52 +00004149 // We want to avoid creating an unnecessary temporary+copy here;
Guy Benyei3832bfd2013-03-10 12:59:00 +00004150 // however, we need one in three cases:
Eli Friedmaneb7fab62011-06-14 01:37:52 +00004151 // 1. If the argument is not byval, and we are required to copy the
4152 // source. (This case doesn't occur on any common architecture.)
4153 // 2. If the argument is byval, RV is not sufficiently aligned, and
4154 // we cannot force it to be sufficiently aligned.
Yaxun Liu5b330e82018-03-15 15:25:19 +00004155 // 3. If the argument is byval, but RV is not located in default
4156 // or alloca address space.
4157 Address Addr = I->hasLValue()
Akira Hatanakaf139ae32019-12-03 15:17:01 -08004158 ? I->getKnownLValue().getAddress(*this)
Yaxun Liu5b330e82018-03-15 15:25:19 +00004159 : I->getKnownRValue().getAggregateAddress();
4160 llvm::Value *V = Addr.getPointer();
John McCall7f416cc2015-09-08 08:05:57 +00004161 CharUnits Align = ArgInfo.getIndirectAlign();
Micah Villmowdd31ca12012-10-08 16:25:52 +00004162 const llvm::DataLayout *TD = &CGM.getDataLayout();
Yaxun Liu5b330e82018-03-15 15:25:19 +00004163
4164 assert((FirstIRArg >= IRFuncTy->getNumParams() ||
4165 IRFuncTy->getParamType(FirstIRArg)->getPointerAddressSpace() ==
4166 TD->getAllocaAddrSpace()) &&
4167 "indirect argument must be in alloca address space");
4168
4169 bool NeedCopy = false;
4170
4171 if (Addr.getAlignment() < Align &&
4172 llvm::getOrEnforceKnownAlignment(V, Align.getQuantity(), *TD) <
4173 Align.getQuantity()) {
4174 NeedCopy = true;
4175 } else if (I->hasLValue()) {
4176 auto LV = I->getKnownLValue();
4177 auto AS = LV.getAddressSpace();
Andrew Savonichev1bf1a152018-12-10 12:03:00 +00004178
Yaxun (Sam) Liu21b43882019-12-10 11:55:33 -05004179 if (!ArgInfo.getIndirectByVal() ||
4180 (LV.getAlignment() < getContext().getTypeAlignInChars(I->Ty))) {
Andrew Savonichev1bf1a152018-12-10 12:03:00 +00004181 NeedCopy = true;
4182 }
4183 if (!getLangOpts().OpenCL) {
4184 if ((ArgInfo.getIndirectByVal() &&
4185 (AS != LangAS::Default &&
4186 AS != CGM.getASTAllocaAddressSpace()))) {
4187 NeedCopy = true;
4188 }
4189 }
4190 // For OpenCL even if RV is located in default or alloca address space
4191 // we don't want to perform address space cast for it.
4192 else if ((ArgInfo.getIndirectByVal() &&
4193 Addr.getType()->getAddressSpace() != IRFuncTy->
4194 getParamType(FirstIRArg)->getPointerAddressSpace())) {
Yaxun Liu5b330e82018-03-15 15:25:19 +00004195 NeedCopy = true;
4196 }
4197 }
Andrew Savonichev1bf1a152018-12-10 12:03:00 +00004198
Yaxun Liu5b330e82018-03-15 15:25:19 +00004199 if (NeedCopy) {
Eli Friedmaneb7fab62011-06-14 01:37:52 +00004200 // Create an aligned temporary, and copy to it.
Yaxun Liuaefdb8e2018-06-15 15:33:22 +00004201 Address AI = CreateMemTempWithoutCast(
4202 I->Ty, ArgInfo.getIndirectAlign(), "byval-temp");
John McCall7f416cc2015-09-08 08:05:57 +00004203 IRCallArgs[FirstIRArg] = AI.getPointer();
Francis Visoiu Mistrih143f6b82019-10-08 22:10:38 +00004204
4205 // Emit lifetime markers for the temporary alloca.
4206 uint64_t ByvalTempElementSize =
4207 CGM.getDataLayout().getTypeAllocSize(AI.getElementType());
4208 llvm::Value *LifetimeSize =
4209 EmitLifetimeStart(ByvalTempElementSize, AI.getPointer());
4210
4211 // Add cleanup code to emit the end lifetime marker after the call.
4212 if (LifetimeSize) // In case we disabled lifetime markers.
4213 CallLifetimeEndAfterCall.emplace_back(AI, LifetimeSize);
4214
4215 // Generate the copy.
Yaxun Liu5b330e82018-03-15 15:25:19 +00004216 I->copyInto(*this, AI);
Eli Friedmaneb7fab62011-06-14 01:37:52 +00004217 } else {
4218 // Skip the extra memcpy call.
Yaxun Liu5b330e82018-03-15 15:25:19 +00004219 auto *T = V->getType()->getPointerElementType()->getPointerTo(
4220 CGM.getDataLayout().getAllocaAddrSpace());
4221 IRCallArgs[FirstIRArg] = getTargetHooks().performAddrSpaceCast(
4222 *this, V, LangAS::Default, CGM.getASTAllocaAddressSpace(), T,
4223 true);
Eli Friedmaneb7fab62011-06-14 01:37:52 +00004224 }
Daniel Dunbar747865a2009-02-05 09:16:39 +00004225 }
4226 break;
Daniel Dunbar03816342010-08-21 02:24:36 +00004227 }
Daniel Dunbar747865a2009-02-05 09:16:39 +00004228
Daniel Dunbar94a6f252009-01-26 21:26:08 +00004229 case ABIArgInfo::Ignore:
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004230 assert(NumIRArgs == 0);
Daniel Dunbar94a6f252009-01-26 21:26:08 +00004231 break;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004232
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00004233 case ABIArgInfo::Extend:
4234 case ABIArgInfo::Direct: {
4235 if (!isa<llvm::StructType>(ArgInfo.getCoerceToType()) &&
Chris Lattner8a2f3c72010-07-30 04:02:24 +00004236 ArgInfo.getCoerceToType() == ConvertType(info_it->type) &&
4237 ArgInfo.getDirectOffset() == 0) {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004238 assert(NumIRArgs == 1);
Chris Lattnerbb1952c2011-07-12 04:46:18 +00004239 llvm::Value *V;
Yaxun Liu5b330e82018-03-15 15:25:19 +00004240 if (!I->isAggregate())
4241 V = I->getKnownRValue().getScalarVal();
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00004242 else
Yaxun Liu5b330e82018-03-15 15:25:19 +00004243 V = Builder.CreateLoad(
Akira Hatanakaf139ae32019-12-03 15:17:01 -08004244 I->hasLValue() ? I->getKnownLValue().getAddress(*this)
Yaxun Liu5b330e82018-03-15 15:25:19 +00004245 : I->getKnownRValue().getAggregateAddress());
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004246
John McCall12f23522016-04-04 18:33:08 +00004247 // Implement swifterror by copying into a new swifterror argument.
4248 // We'll write back in the normal path out of the call.
4249 if (CallInfo.getExtParameterInfo(ArgNo).getABI()
4250 == ParameterABI::SwiftErrorResult) {
4251 assert(!swiftErrorTemp.isValid() && "multiple swifterror args");
4252
4253 QualType pointeeTy = I->Ty->getPointeeType();
4254 swiftErrorArg =
4255 Address(V, getContext().getTypeAlignInChars(pointeeTy));
4256
4257 swiftErrorTemp =
4258 CreateMemTemp(pointeeTy, getPointerAlign(), "swifterror.temp");
4259 V = swiftErrorTemp.getPointer();
4260 cast<llvm::AllocaInst>(V)->setSwiftError(true);
4261
4262 llvm::Value *errorValue = Builder.CreateLoad(swiftErrorArg);
4263 Builder.CreateStore(errorValue, swiftErrorTemp);
4264 }
4265
Reid Kleckner79b0fd72014-10-10 00:05:45 +00004266 // We might have to widen integers, but we should never truncate.
4267 if (ArgInfo.getCoerceToType() != V->getType() &&
4268 V->getType()->isIntegerTy())
4269 V = Builder.CreateZExt(V, ArgInfo.getCoerceToType());
4270
Chris Lattner3ce86682011-07-12 04:53:39 +00004271 // If the argument doesn't match, perform a bitcast to coerce it. This
4272 // can happen due to trivial type mismatches.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004273 if (FirstIRArg < IRFuncTy->getNumParams() &&
4274 V->getType() != IRFuncTy->getParamType(FirstIRArg))
4275 V = Builder.CreateBitCast(V, IRFuncTy->getParamType(FirstIRArg));
John McCall12f23522016-04-04 18:33:08 +00004276
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004277 IRCallArgs[FirstIRArg] = V;
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00004278 break;
4279 }
Daniel Dunbar94a6f252009-01-26 21:26:08 +00004280
Daniel Dunbar2f219b02009-02-03 19:12:28 +00004281 // FIXME: Avoid the conversion through memory if possible.
John McCall7f416cc2015-09-08 08:05:57 +00004282 Address Src = Address::invalid();
Yaxun Liu5b330e82018-03-15 15:25:19 +00004283 if (!I->isAggregate()) {
John McCall7f416cc2015-09-08 08:05:57 +00004284 Src = CreateMemTemp(I->Ty, "coerce");
Yaxun Liu5b330e82018-03-15 15:25:19 +00004285 I->copyInto(*this, Src);
Ulrich Weigand6e2cea62015-07-10 11:31:43 +00004286 } else {
Akira Hatanakaf139ae32019-12-03 15:17:01 -08004287 Src = I->hasLValue() ? I->getKnownLValue().getAddress(*this)
Yaxun Liu5b330e82018-03-15 15:25:19 +00004288 : I->getKnownRValue().getAggregateAddress();
Ulrich Weigand6e2cea62015-07-10 11:31:43 +00004289 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004290
Chris Lattner8a2f3c72010-07-30 04:02:24 +00004291 // If the value is offset in memory, apply the offset now.
John McCall7f416cc2015-09-08 08:05:57 +00004292 Src = emitAddressAtOffset(*this, Src, ArgInfo);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004293
Oliver Stannard2bfdc5b2014-08-27 10:43:15 +00004294 // Fast-isel and the optimizer generally like scalar values better than
4295 // FCAs, so we flatten them if this is safe to do for this argument.
James Molloy6f244b62014-05-09 16:21:39 +00004296 llvm::StructType *STy =
4297 dyn_cast<llvm::StructType>(ArgInfo.getCoerceToType());
Oliver Stannard2bfdc5b2014-08-27 10:43:15 +00004298 if (STy && ArgInfo.isDirect() && ArgInfo.getCanBeFlattened()) {
John McCall7f416cc2015-09-08 08:05:57 +00004299 llvm::Type *SrcTy = Src.getType()->getElementType();
Chandler Carrutha6399a52012-10-10 11:29:08 +00004300 uint64_t SrcSize = CGM.getDataLayout().getTypeAllocSize(SrcTy);
4301 uint64_t DstSize = CGM.getDataLayout().getTypeAllocSize(STy);
4302
4303 // If the source type is smaller than the destination type of the
4304 // coerce-to logic, copy the source value into a temp alloca the size
4305 // of the destination type to allow loading all of it. The bits past
4306 // the source value are left undef.
4307 if (SrcSize < DstSize) {
John McCall7f416cc2015-09-08 08:05:57 +00004308 Address TempAlloca
4309 = CreateTempAlloca(STy, Src.getAlignment(),
4310 Src.getName() + ".coerce");
4311 Builder.CreateMemCpy(TempAlloca, Src, SrcSize);
4312 Src = TempAlloca;
Chandler Carrutha6399a52012-10-10 11:29:08 +00004313 } else {
Matt Arsenault7a124f32017-08-01 20:36:57 +00004314 Src = Builder.CreateBitCast(Src,
4315 STy->getPointerTo(Src.getAddressSpace()));
Chandler Carrutha6399a52012-10-10 11:29:08 +00004316 }
4317
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004318 assert(NumIRArgs == STy->getNumElements());
Chris Lattnerceddafb2010-07-05 20:41:41 +00004319 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
James Y Knight751fe282019-02-09 22:22:28 +00004320 Address EltPtr = Builder.CreateStructGEP(Src, i);
John McCall7f416cc2015-09-08 08:05:57 +00004321 llvm::Value *LI = Builder.CreateLoad(EltPtr);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004322 IRCallArgs[FirstIRArg + i] = LI;
Chris Lattner15ec3612010-06-29 00:06:42 +00004323 }
Chris Lattner3dd716c2010-06-28 23:44:11 +00004324 } else {
Chris Lattner15ec3612010-06-29 00:06:42 +00004325 // In the simple case, just pass the coerced loaded value.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004326 assert(NumIRArgs == 1);
4327 IRCallArgs[FirstIRArg] =
John McCall7f416cc2015-09-08 08:05:57 +00004328 CreateCoercedLoad(Src, ArgInfo.getCoerceToType(), *this);
Chris Lattner3dd716c2010-06-28 23:44:11 +00004329 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004330
Daniel Dunbar2f219b02009-02-03 19:12:28 +00004331 break;
4332 }
4333
John McCallf26e73d2016-03-11 04:30:43 +00004334 case ABIArgInfo::CoerceAndExpand: {
John McCallf26e73d2016-03-11 04:30:43 +00004335 auto coercionType = ArgInfo.getCoerceAndExpandType();
4336 auto layout = CGM.getDataLayout().getStructLayout(coercionType);
4337
John McCall12f23522016-04-04 18:33:08 +00004338 llvm::Value *tempSize = nullptr;
4339 Address addr = Address::invalid();
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00004340 Address AllocaAddr = Address::invalid();
Yaxun Liu5b330e82018-03-15 15:25:19 +00004341 if (I->isAggregate()) {
Akira Hatanakaf139ae32019-12-03 15:17:01 -08004342 addr = I->hasLValue() ? I->getKnownLValue().getAddress(*this)
Yaxun Liu5b330e82018-03-15 15:25:19 +00004343 : I->getKnownRValue().getAggregateAddress();
4344
John McCall12f23522016-04-04 18:33:08 +00004345 } else {
Yaxun Liu5b330e82018-03-15 15:25:19 +00004346 RValue RV = I->getKnownRValue();
John McCall12f23522016-04-04 18:33:08 +00004347 assert(RV.isScalar()); // complex should always just be direct
4348
4349 llvm::Type *scalarType = RV.getScalarVal()->getType();
4350 auto scalarSize = CGM.getDataLayout().getTypeAllocSize(scalarType);
4351 auto scalarAlign = CGM.getDataLayout().getPrefTypeAlignment(scalarType);
4352
John McCall12f23522016-04-04 18:33:08 +00004353 // Materialize to a temporary.
Guillaume Chateletf7caf3c2019-09-23 09:04:12 +00004354 addr = CreateTempAlloca(
4355 RV.getScalarVal()->getType(),
4356 CharUnits::fromQuantity(std::max(
4357 (unsigned)layout->getAlignment().value(), scalarAlign)),
4358 "tmp",
4359 /*ArraySize=*/nullptr, &AllocaAddr);
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00004360 tempSize = EmitLifetimeStart(scalarSize, AllocaAddr.getPointer());
John McCall12f23522016-04-04 18:33:08 +00004361
4362 Builder.CreateStore(RV.getScalarVal(), addr);
4363 }
4364
John McCallf26e73d2016-03-11 04:30:43 +00004365 addr = Builder.CreateElementBitCast(addr, coercionType);
4366
4367 unsigned IRArgPos = FirstIRArg;
4368 for (unsigned i = 0, e = coercionType->getNumElements(); i != e; ++i) {
4369 llvm::Type *eltType = coercionType->getElementType(i);
4370 if (ABIArgInfo::isPaddingForCoerceAndExpand(eltType)) continue;
James Y Knight751fe282019-02-09 22:22:28 +00004371 Address eltAddr = Builder.CreateStructGEP(addr, i);
John McCallf26e73d2016-03-11 04:30:43 +00004372 llvm::Value *elt = Builder.CreateLoad(eltAddr);
4373 IRCallArgs[IRArgPos++] = elt;
4374 }
4375 assert(IRArgPos == FirstIRArg + NumIRArgs);
4376
John McCall12f23522016-04-04 18:33:08 +00004377 if (tempSize) {
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00004378 EmitLifetimeEnd(tempSize, AllocaAddr.getPointer());
John McCall12f23522016-04-04 18:33:08 +00004379 }
4380
John McCallf26e73d2016-03-11 04:30:43 +00004381 break;
4382 }
4383
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00004384 case ABIArgInfo::Expand:
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004385 unsigned IRArgPos = FirstIRArg;
Yaxun Liu5b330e82018-03-15 15:25:19 +00004386 ExpandTypeToArgs(I->Ty, *I, IRFuncTy, IRCallArgs, IRArgPos);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004387 assert(IRArgPos == FirstIRArg + NumIRArgs);
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00004388 break;
Daniel Dunbar613855c2008-09-09 23:27:19 +00004389 }
4390 }
Mike Stump11289f42009-09-09 15:08:12 +00004391
John McCall9831b842018-02-06 18:52:44 +00004392 const CGCallee &ConcreteCallee = Callee.prepareConcreteCallee(*this);
4393 llvm::Value *CalleePtr = ConcreteCallee.getFunctionPointer();
John McCallb92ab1a2016-10-26 23:46:34 +00004394
4395 // If we're using inalloca, set up that argument.
John McCall7f416cc2015-09-08 08:05:57 +00004396 if (ArgMemory.isValid()) {
4397 llvm::Value *Arg = ArgMemory.getPointer();
Reid Klecknerafba553e2014-07-08 02:24:27 +00004398 if (CallInfo.isVariadic()) {
4399 // When passing non-POD arguments by value to variadic functions, we will
4400 // end up with a variadic prototype and an inalloca call site. In such
4401 // cases, we can't do any parameter mismatch checks. Give up and bitcast
4402 // the callee.
John McCallb92ab1a2016-10-26 23:46:34 +00004403 unsigned CalleeAS = CalleePtr->getType()->getPointerAddressSpace();
James Y Knightcfe8cd72019-02-07 01:15:41 +00004404 CalleePtr =
4405 Builder.CreateBitCast(CalleePtr, IRFuncTy->getPointerTo(CalleeAS));
Reid Klecknerafba553e2014-07-08 02:24:27 +00004406 } else {
4407 llvm::Type *LastParamTy =
4408 IRFuncTy->getParamType(IRFuncTy->getNumParams() - 1);
4409 if (Arg->getType() != LastParamTy) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00004410#ifndef NDEBUG
Reid Klecknerafba553e2014-07-08 02:24:27 +00004411 // Assert that these structs have equivalent element types.
4412 llvm::StructType *FullTy = CallInfo.getArgStruct();
4413 llvm::StructType *DeclaredTy = cast<llvm::StructType>(
4414 cast<llvm::PointerType>(LastParamTy)->getElementType());
4415 assert(DeclaredTy->getNumElements() == FullTy->getNumElements());
4416 for (llvm::StructType::element_iterator DI = DeclaredTy->element_begin(),
4417 DE = DeclaredTy->element_end(),
4418 FI = FullTy->element_begin();
4419 DI != DE; ++DI, ++FI)
4420 assert(*DI == *FI);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00004421#endif
Reid Klecknerafba553e2014-07-08 02:24:27 +00004422 Arg = Builder.CreateBitCast(Arg, LastParamTy);
4423 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00004424 }
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004425 assert(IRFunctionArgs.hasInallocaArg());
4426 IRCallArgs[IRFunctionArgs.getInallocaArgNo()] = Arg;
Reid Kleckner314ef7b2014-02-01 00:04:45 +00004427 }
4428
John McCallb92ab1a2016-10-26 23:46:34 +00004429 // 2. Prepare the function pointer.
4430
4431 // If the callee is a bitcast of a non-variadic function to have a
4432 // variadic function pointer type, check to see if we can remove the
4433 // bitcast. This comes up with unprototyped functions.
4434 //
4435 // This makes the IR nicer, but more importantly it ensures that we
4436 // can inline the function at -O0 if it is marked always_inline.
James Y Knightcfe8cd72019-02-07 01:15:41 +00004437 auto simplifyVariadicCallee = [](llvm::FunctionType *CalleeFT,
4438 llvm::Value *Ptr) -> llvm::Function * {
John McCallb92ab1a2016-10-26 23:46:34 +00004439 if (!CalleeFT->isVarArg())
James Y Knightcfe8cd72019-02-07 01:15:41 +00004440 return nullptr;
John McCallb92ab1a2016-10-26 23:46:34 +00004441
James Y Knightcfe8cd72019-02-07 01:15:41 +00004442 // Get underlying value if it's a bitcast
4443 if (llvm::ConstantExpr *CE = dyn_cast<llvm::ConstantExpr>(Ptr)) {
4444 if (CE->getOpcode() == llvm::Instruction::BitCast)
4445 Ptr = CE->getOperand(0);
4446 }
John McCallb92ab1a2016-10-26 23:46:34 +00004447
James Y Knightcfe8cd72019-02-07 01:15:41 +00004448 llvm::Function *OrigFn = dyn_cast<llvm::Function>(Ptr);
John McCallb92ab1a2016-10-26 23:46:34 +00004449 if (!OrigFn)
James Y Knightcfe8cd72019-02-07 01:15:41 +00004450 return nullptr;
John McCallb92ab1a2016-10-26 23:46:34 +00004451
4452 llvm::FunctionType *OrigFT = OrigFn->getFunctionType();
4453
4454 // If the original type is variadic, or if any of the component types
4455 // disagree, we cannot remove the cast.
4456 if (OrigFT->isVarArg() ||
4457 OrigFT->getNumParams() != CalleeFT->getNumParams() ||
4458 OrigFT->getReturnType() != CalleeFT->getReturnType())
James Y Knightcfe8cd72019-02-07 01:15:41 +00004459 return nullptr;
John McCallb92ab1a2016-10-26 23:46:34 +00004460
4461 for (unsigned i = 0, e = OrigFT->getNumParams(); i != e; ++i)
4462 if (OrigFT->getParamType(i) != CalleeFT->getParamType(i))
James Y Knightcfe8cd72019-02-07 01:15:41 +00004463 return nullptr;
John McCallb92ab1a2016-10-26 23:46:34 +00004464
4465 return OrigFn;
4466 };
James Y Knightcfe8cd72019-02-07 01:15:41 +00004467
4468 if (llvm::Function *OrigFn = simplifyVariadicCallee(IRFuncTy, CalleePtr)) {
4469 CalleePtr = OrigFn;
4470 IRFuncTy = OrigFn->getFunctionType();
4471 }
John McCallb92ab1a2016-10-26 23:46:34 +00004472
4473 // 3. Perform the actual call.
4474
4475 // Deactivate any cleanups that we're supposed to do immediately before
4476 // the call.
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00004477 if (!CallArgs.getCleanupsToDeactivate().empty())
4478 deactivateArgCleanupsBeforeCall(*this, CallArgs);
4479
John McCallb92ab1a2016-10-26 23:46:34 +00004480 // Assert that the arguments we computed match up. The IR verifier
4481 // will catch this, but this is a common enough source of problems
4482 // during IRGen changes that it's way better for debugging to catch
4483 // it ourselves here.
4484#ifndef NDEBUG
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004485 assert(IRCallArgs.size() == IRFuncTy->getNumParams() || IRFuncTy->isVarArg());
4486 for (unsigned i = 0; i < IRCallArgs.size(); ++i) {
4487 // Inalloca argument can have different type.
4488 if (IRFunctionArgs.hasInallocaArg() &&
4489 i == IRFunctionArgs.getInallocaArgNo())
4490 continue;
4491 if (i < IRFuncTy->getNumParams())
4492 assert(IRCallArgs[i]->getType() == IRFuncTy->getParamType(i));
4493 }
John McCallb92ab1a2016-10-26 23:46:34 +00004494#endif
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004495
Craig Topper3113ec32018-10-24 17:42:17 +00004496 // Update the largest vector width if any arguments have vector types.
4497 for (unsigned i = 0; i < IRCallArgs.size(); ++i) {
4498 if (auto *VT = dyn_cast<llvm::VectorType>(IRCallArgs[i]->getType()))
Kerry McLaughlinaf649482020-03-17 10:27:29 +00004499 LargestVectorWidth =
4500 std::max((uint64_t)LargestVectorWidth,
4501 VT->getPrimitiveSizeInBits().getKnownMinSize());
Craig Topper3113ec32018-10-24 17:42:17 +00004502 }
4503
John McCallb92ab1a2016-10-26 23:46:34 +00004504 // Compute the calling convention and attributes.
Daniel Dunbar0ef34792009-09-12 00:59:20 +00004505 unsigned CallingConv;
Reid Klecknercdd26792017-04-18 23:50:03 +00004506 llvm::AttributeList Attrs;
John McCallb92ab1a2016-10-26 23:46:34 +00004507 CGM.ConstructAttributeList(CalleePtr->getName(), CallInfo,
Reid Klecknercdd26792017-04-18 23:50:03 +00004508 Callee.getAbstractInfo(), Attrs, CallingConv,
Chad Rosier7dbc9cf2016-01-06 14:35:46 +00004509 /*AttrOnCallSite=*/true);
Mike Stump11289f42009-09-09 15:08:12 +00004510
Melanie Blower7f9b5132019-12-04 12:23:46 -08004511 if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(CurFuncDecl))
4512 if (FD->usesFPIntrin())
4513 // All calls within a strictfp function are marked strictfp
4514 Attrs =
4515 Attrs.addAttribute(getLLVMContext(), llvm::AttributeList::FunctionIndex,
4516 llvm::Attribute::StrictFP);
4517
John McCallb92ab1a2016-10-26 23:46:34 +00004518 // Apply some call-site-specific attributes.
4519 // TODO: work this into building the attribute set.
4520
4521 // Apply always_inline to all calls within flatten functions.
4522 // FIXME: should this really take priority over __try, below?
4523 if (CurCodeDecl && CurCodeDecl->hasAttr<FlattenAttr>() &&
Amy Huang0d0334f2019-04-12 20:25:30 +00004524 !(TargetDecl && TargetDecl->hasAttr<NoInlineAttr>())) {
John McCallb92ab1a2016-10-26 23:46:34 +00004525 Attrs =
Reid Klecknerde864822017-03-21 16:57:30 +00004526 Attrs.addAttribute(getLLVMContext(), llvm::AttributeList::FunctionIndex,
John McCallb92ab1a2016-10-26 23:46:34 +00004527 llvm::Attribute::AlwaysInline);
4528 }
4529
4530 // Disable inlining inside SEH __try blocks.
4531 if (isSEHTryScope()) {
4532 Attrs =
Reid Klecknerde864822017-03-21 16:57:30 +00004533 Attrs.addAttribute(getLLVMContext(), llvm::AttributeList::FunctionIndex,
John McCallb92ab1a2016-10-26 23:46:34 +00004534 llvm::Attribute::NoInline);
4535 }
4536
4537 // Decide whether to use a call or an invoke.
David Majnemer4e52d6f2015-12-12 05:39:21 +00004538 bool CannotThrow;
4539 if (currentFunctionUsesSEHTry()) {
John McCallb92ab1a2016-10-26 23:46:34 +00004540 // SEH cares about asynchronous exceptions, so everything can "throw."
David Majnemer4e52d6f2015-12-12 05:39:21 +00004541 CannotThrow = false;
4542 } else if (isCleanupPadScope() &&
4543 EHPersonality::get(*this).isMSVCXXPersonality()) {
4544 // The MSVC++ personality will implicitly terminate the program if an
John McCallb92ab1a2016-10-26 23:46:34 +00004545 // exception is thrown during a cleanup outside of a try/catch.
4546 // We don't need to model anything in IR to get this behavior.
David Majnemer4e52d6f2015-12-12 05:39:21 +00004547 CannotThrow = true;
4548 } else {
John McCallb92ab1a2016-10-26 23:46:34 +00004549 // Otherwise, nounwind call sites will never throw.
Reid Klecknerde864822017-03-21 16:57:30 +00004550 CannotThrow = Attrs.hasAttribute(llvm::AttributeList::FunctionIndex,
David Majnemer4e52d6f2015-12-12 05:39:21 +00004551 llvm::Attribute::NoUnwind);
4552 }
George Burgess IV003be7c2018-03-08 05:32:30 +00004553
4554 // If we made a temporary, be sure to clean up after ourselves. Note that we
4555 // can't depend on being inside of an ExprWithCleanups, so we need to manually
4556 // pop this cleanup later on. Being eager about this is OK, since this
4557 // temporary is 'invisible' outside of the callee.
4558 if (UnusedReturnSizePtr)
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00004559 pushFullExprCleanup<CallLifetimeEnd>(NormalEHLifetimeMarker, SRetAlloca,
George Burgess IV003be7c2018-03-08 05:32:30 +00004560 UnusedReturnSizePtr);
4561
David Majnemer4e52d6f2015-12-12 05:39:21 +00004562 llvm::BasicBlock *InvokeDest = CannotThrow ? nullptr : getInvokeDest();
John McCallbd309292010-07-06 01:34:17 +00004563
Reid Klecknerb75a3f02018-02-09 00:16:41 +00004564 SmallVector<llvm::OperandBundleDef, 1> BundleList =
4565 getBundlesForFunclet(CalleePtr);
David Majnemer0b17d442015-12-15 21:27:59 +00004566
Melanie Blower7f9b5132019-12-04 12:23:46 -08004567 if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(CurFuncDecl))
4568 if (FD->usesFPIntrin())
4569 // All calls within a strictfp function are marked strictfp
4570 Attrs =
4571 Attrs.addAttribute(getLLVMContext(), llvm::AttributeList::FunctionIndex,
4572 llvm::Attribute::StrictFP);
4573
Roman Lebedeve819f7c2020-01-23 22:50:15 +03004574 AssumeAlignedAttrEmitter AssumeAlignedAttrEmitter(*this, TargetDecl);
4575 Attrs = AssumeAlignedAttrEmitter.TryEmitAsCallSiteAttribute(Attrs);
4576
Roman Lebedev5ffe6402020-01-23 22:50:24 +03004577 AllocAlignAttrEmitter AllocAlignAttrEmitter(*this, TargetDecl, CallArgs);
4578 Attrs = AllocAlignAttrEmitter.TryEmitAsCallSiteAttribute(Attrs);
4579
John McCallb92ab1a2016-10-26 23:46:34 +00004580 // Emit the actual call/invoke instruction.
James Y Knight3933add2019-01-30 02:54:28 +00004581 llvm::CallBase *CI;
John McCallbd309292010-07-06 01:34:17 +00004582 if (!InvokeDest) {
James Y Knightcfe8cd72019-02-07 01:15:41 +00004583 CI = Builder.CreateCall(IRFuncTy, CalleePtr, IRCallArgs, BundleList);
Daniel Dunbar12347492009-02-23 17:26:39 +00004584 } else {
4585 llvm::BasicBlock *Cont = createBasicBlock("invoke.cont");
James Y Knightcfe8cd72019-02-07 01:15:41 +00004586 CI = Builder.CreateInvoke(IRFuncTy, CalleePtr, Cont, InvokeDest, IRCallArgs,
David Majnemer0b17d442015-12-15 21:27:59 +00004587 BundleList);
Daniel Dunbar12347492009-02-23 17:26:39 +00004588 EmitBlock(Cont);
Daniel Dunbar5006f4a2009-02-20 18:54:31 +00004589 }
Chris Lattnere70a0072010-06-29 16:40:28 +00004590 if (callOrInvoke)
John McCallb92ab1a2016-10-26 23:46:34 +00004591 *callOrInvoke = CI;
Daniel Dunbar5006f4a2009-02-20 18:54:31 +00004592
Andrew Paverdbdd88b72020-01-10 11:08:18 +00004593 // If this is within a function that has the guard(nocf) attribute and is an
4594 // indirect call, add the "guard_nocf" attribute to this call to indicate that
4595 // Control Flow Guard checks should not be added, even if the call is inlined.
4596 if (const auto *FD = dyn_cast_or_null<FunctionDecl>(CurFuncDecl)) {
4597 if (const auto *A = FD->getAttr<CFGuardAttr>()) {
4598 if (A->getGuard() == CFGuardAttr::GuardArg::nocf && !CI->getCalledFunction())
4599 Attrs = Attrs.addAttribute(
4600 getLLVMContext(), llvm::AttributeList::FunctionIndex, "guard_nocf");
4601 }
4602 }
4603
John McCallb92ab1a2016-10-26 23:46:34 +00004604 // Apply the attributes and calling convention.
James Y Knight3933add2019-01-30 02:54:28 +00004605 CI->setAttributes(Attrs);
4606 CI->setCallingConv(static_cast<llvm::CallingConv::ID>(CallingConv));
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004607
John McCallb92ab1a2016-10-26 23:46:34 +00004608 // Apply various metadata.
4609
4610 if (!CI->getType()->isVoidTy())
4611 CI->setName("call");
4612
Craig Topper3113ec32018-10-24 17:42:17 +00004613 // Update largest vector width from the return type.
4614 if (auto *VT = dyn_cast<llvm::VectorType>(CI->getType()))
Kerry McLaughlinaf649482020-03-17 10:27:29 +00004615 LargestVectorWidth =
4616 std::max((uint64_t)LargestVectorWidth,
4617 VT->getPrimitiveSizeInBits().getKnownMinSize());
Craig Topper3113ec32018-10-24 17:42:17 +00004618
Adam Nemet1e217bc2016-03-28 22:18:53 +00004619 // Insert instrumentation or attach profile metadata at indirect call sites.
4620 // For more details, see the comment before the definition of
4621 // IPVK_IndirectCallTarget in InstrProfData.inc.
James Y Knight3933add2019-01-30 02:54:28 +00004622 if (!CI->getCalledFunction())
Betul Buyukkurt518276a2016-01-23 22:50:44 +00004623 PGO.valueProfile(Builder, llvm::IPVK_IndirectCallTarget,
John McCallb92ab1a2016-10-26 23:46:34 +00004624 CI, CalleePtr);
Betul Buyukkurt518276a2016-01-23 22:50:44 +00004625
Dan Gohman515a60d2012-02-16 00:57:37 +00004626 // In ObjC ARC mode with no ObjC ARC exception safety, tell the ARC
4627 // optimizer it can aggressively ignore unwind edges.
David Blaikiebbafb8a2012-03-11 07:00:24 +00004628 if (CGM.getLangOpts().ObjCAutoRefCount)
John McCallb92ab1a2016-10-26 23:46:34 +00004629 AddObjCARCExceptionMetadata(CI);
4630
4631 // Suppress tail calls if requested.
4632 if (llvm::CallInst *Call = dyn_cast<llvm::CallInst>(CI)) {
John McCallb92ab1a2016-10-26 23:46:34 +00004633 if (TargetDecl && TargetDecl->hasAttr<NotTailCalledAttr>())
4634 Call->setTailCallKind(llvm::CallInst::TCK_NoTail);
4635 }
4636
Amy Huang0d0334f2019-04-12 20:25:30 +00004637 // Add metadata for calls to MSAllocator functions
Amy Huang0d0334f2019-04-12 20:25:30 +00004638 if (getDebugInfo() && TargetDecl &&
4639 TargetDecl->hasAttr<MSAllocatorAttr>())
4640 getDebugInfo()->addHeapAllocSiteMetadata(CI, RetTy, Loc);
4641
John McCallb92ab1a2016-10-26 23:46:34 +00004642 // 4. Finish the call.
Dan Gohman515a60d2012-02-16 00:57:37 +00004643
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004644 // If the call doesn't return, finish the basic block and clear the
John McCallb92ab1a2016-10-26 23:46:34 +00004645 // insertion point; this allows the rest of IRGen to discard
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004646 // unreachable code.
James Y Knight3933add2019-01-30 02:54:28 +00004647 if (CI->doesNotReturn()) {
George Burgess IV003be7c2018-03-08 05:32:30 +00004648 if (UnusedReturnSizePtr)
4649 PopCleanupBlock();
Leny Kholodov6aab1112015-06-08 10:23:49 +00004650
Julian Lettnerb62e9dc2019-01-24 18:04:21 +00004651 // Strip away the noreturn attribute to better diagnose unreachable UB.
Vedant Kumar09b5bfd2017-12-21 00:10:25 +00004652 if (SanOpts.has(SanitizerKind::Unreachable)) {
Julian Lettnerf82d8922019-02-02 02:05:16 +00004653 // Also remove from function since CallBase::hasFnAttr additionally checks
4654 // attributes of the called function.
James Y Knight3933add2019-01-30 02:54:28 +00004655 if (auto *F = CI->getCalledFunction())
Vedant Kumar09b5bfd2017-12-21 00:10:25 +00004656 F->removeFnAttr(llvm::Attribute::NoReturn);
James Y Knight3933add2019-01-30 02:54:28 +00004657 CI->removeAttribute(llvm::AttributeList::FunctionIndex,
4658 llvm::Attribute::NoReturn);
Julian Lettnerb6c06dc2019-02-01 02:51:00 +00004659
4660 // Avoid incompatibility with ASan which relies on the `noreturn`
4661 // attribute to insert handler calls.
Julian Lettner98b9f5b2019-02-04 23:37:50 +00004662 if (SanOpts.hasOneOf(SanitizerKind::Address |
4663 SanitizerKind::KernelAddress)) {
Julian Lettnerb6c06dc2019-02-01 02:51:00 +00004664 SanitizerScope SanScope(this);
4665 llvm::IRBuilder<>::InsertPointGuard IPGuard(Builder);
4666 Builder.SetInsertPoint(CI);
4667 auto *FnType = llvm::FunctionType::get(CGM.VoidTy, /*isVarArg=*/false);
James Y Knight9871db02019-02-05 16:42:33 +00004668 llvm::FunctionCallee Fn =
4669 CGM.CreateRuntimeFunction(FnType, "__asan_handle_no_return");
Julian Lettnerb6c06dc2019-02-01 02:51:00 +00004670 EmitNounwindRuntimeCall(Fn);
4671 }
Vedant Kumar09b5bfd2017-12-21 00:10:25 +00004672 }
4673
4674 EmitUnreachable(Loc);
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004675 Builder.ClearInsertionPoint();
Mike Stump11289f42009-09-09 15:08:12 +00004676
Mike Stump18bb9282009-05-16 07:57:57 +00004677 // FIXME: For now, emit a dummy basic block because expr emitters in
4678 // generally are not ready to handle emitting expressions at unreachable
4679 // points.
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004680 EnsureInsertPoint();
Mike Stump11289f42009-09-09 15:08:12 +00004681
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004682 // Return a reasonable RValue.
4683 return GetUndefRValue(RetTy);
Mike Stump11289f42009-09-09 15:08:12 +00004684 }
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004685
John McCall12f23522016-04-04 18:33:08 +00004686 // Perform the swifterror writeback.
4687 if (swiftErrorTemp.isValid()) {
4688 llvm::Value *errorResult = Builder.CreateLoad(swiftErrorTemp);
4689 Builder.CreateStore(errorResult, swiftErrorArg);
4690 }
4691
John McCallb92ab1a2016-10-26 23:46:34 +00004692 // Emit any call-associated writebacks immediately. Arguably this
4693 // should happen after any return-value munging.
John McCall31168b02011-06-15 23:02:42 +00004694 if (CallArgs.hasWritebacks())
4695 emitWritebacks(*this, CallArgs);
4696
Nico Weber8cdb3f92015-08-25 18:43:32 +00004697 // The stack cleanup for inalloca arguments has to run out of the normal
4698 // lexical order, so deactivate it and run it manually here.
4699 CallArgs.freeArgumentMemory(*this);
4700
John McCallb92ab1a2016-10-26 23:46:34 +00004701 // Extract the return value.
Hal Finkelee90a222014-09-26 05:04:30 +00004702 RValue Ret = [&] {
4703 switch (RetAI.getKind()) {
John McCallf26e73d2016-03-11 04:30:43 +00004704 case ABIArgInfo::CoerceAndExpand: {
4705 auto coercionType = RetAI.getCoerceAndExpandType();
John McCallf26e73d2016-03-11 04:30:43 +00004706
4707 Address addr = SRetPtr;
4708 addr = Builder.CreateElementBitCast(addr, coercionType);
4709
John McCall12f23522016-04-04 18:33:08 +00004710 assert(CI->getType() == RetAI.getUnpaddedCoerceAndExpandType());
4711 bool requiresExtract = isa<llvm::StructType>(CI->getType());
4712
John McCallf26e73d2016-03-11 04:30:43 +00004713 unsigned unpaddedIndex = 0;
4714 for (unsigned i = 0, e = coercionType->getNumElements(); i != e; ++i) {
4715 llvm::Type *eltType = coercionType->getElementType(i);
4716 if (ABIArgInfo::isPaddingForCoerceAndExpand(eltType)) continue;
James Y Knight751fe282019-02-09 22:22:28 +00004717 Address eltAddr = Builder.CreateStructGEP(addr, i);
John McCall12f23522016-04-04 18:33:08 +00004718 llvm::Value *elt = CI;
4719 if (requiresExtract)
4720 elt = Builder.CreateExtractValue(elt, unpaddedIndex++);
4721 else
4722 assert(unpaddedIndex == 0);
John McCallf26e73d2016-03-11 04:30:43 +00004723 Builder.CreateStore(elt, eltAddr);
4724 }
John McCall12f23522016-04-04 18:33:08 +00004725 // FALLTHROUGH
Galina Kistanova0872d6c2017-06-03 06:30:46 +00004726 LLVM_FALLTHROUGH;
John McCall12f23522016-04-04 18:33:08 +00004727 }
4728
4729 case ABIArgInfo::InAlloca:
4730 case ABIArgInfo::Indirect: {
4731 RValue ret = convertTempToRValue(SRetPtr, RetTy, SourceLocation());
George Burgess IV003be7c2018-03-08 05:32:30 +00004732 if (UnusedReturnSizePtr)
4733 PopCleanupBlock();
John McCall12f23522016-04-04 18:33:08 +00004734 return ret;
John McCallf26e73d2016-03-11 04:30:43 +00004735 }
4736
Hal Finkelee90a222014-09-26 05:04:30 +00004737 case ABIArgInfo::Ignore:
4738 // If we are ignoring an argument that had a result, make sure to
4739 // construct the appropriate return value for our caller.
4740 return GetUndefRValue(RetTy);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004741
Hal Finkelee90a222014-09-26 05:04:30 +00004742 case ABIArgInfo::Extend:
4743 case ABIArgInfo::Direct: {
4744 llvm::Type *RetIRTy = ConvertType(RetTy);
4745 if (RetAI.getCoerceToType() == RetIRTy && RetAI.getDirectOffset() == 0) {
4746 switch (getEvaluationKind(RetTy)) {
4747 case TEK_Complex: {
4748 llvm::Value *Real = Builder.CreateExtractValue(CI, 0);
4749 llvm::Value *Imag = Builder.CreateExtractValue(CI, 1);
4750 return RValue::getComplex(std::make_pair(Real, Imag));
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00004751 }
Hal Finkelee90a222014-09-26 05:04:30 +00004752 case TEK_Aggregate: {
John McCall7f416cc2015-09-08 08:05:57 +00004753 Address DestPtr = ReturnValue.getValue();
Hal Finkelee90a222014-09-26 05:04:30 +00004754 bool DestIsVolatile = ReturnValue.isVolatile();
4755
John McCall7f416cc2015-09-08 08:05:57 +00004756 if (!DestPtr.isValid()) {
Hal Finkelee90a222014-09-26 05:04:30 +00004757 DestPtr = CreateMemTemp(RetTy, "agg.tmp");
4758 DestIsVolatile = false;
4759 }
John McCall7f416cc2015-09-08 08:05:57 +00004760 BuildAggStore(*this, CI, DestPtr, DestIsVolatile);
Hal Finkelee90a222014-09-26 05:04:30 +00004761 return RValue::getAggregate(DestPtr);
4762 }
4763 case TEK_Scalar: {
4764 // If the argument doesn't match, perform a bitcast to coerce it. This
4765 // can happen due to trivial type mismatches.
4766 llvm::Value *V = CI;
4767 if (V->getType() != RetIRTy)
4768 V = Builder.CreateBitCast(V, RetIRTy);
4769 return RValue::get(V);
4770 }
4771 }
4772 llvm_unreachable("bad evaluation kind");
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00004773 }
Hal Finkelee90a222014-09-26 05:04:30 +00004774
John McCall7f416cc2015-09-08 08:05:57 +00004775 Address DestPtr = ReturnValue.getValue();
Hal Finkelee90a222014-09-26 05:04:30 +00004776 bool DestIsVolatile = ReturnValue.isVolatile();
4777
John McCall7f416cc2015-09-08 08:05:57 +00004778 if (!DestPtr.isValid()) {
Hal Finkelee90a222014-09-26 05:04:30 +00004779 DestPtr = CreateMemTemp(RetTy, "coerce");
4780 DestIsVolatile = false;
John McCall47fb9502013-03-07 21:37:08 +00004781 }
Hal Finkelee90a222014-09-26 05:04:30 +00004782
4783 // If the value is offset in memory, apply the offset now.
John McCall7f416cc2015-09-08 08:05:57 +00004784 Address StorePtr = emitAddressAtOffset(*this, DestPtr, RetAI);
4785 CreateCoercedStore(CI, StorePtr, DestIsVolatile, *this);
Hal Finkelee90a222014-09-26 05:04:30 +00004786
4787 return convertTempToRValue(DestPtr, RetTy, SourceLocation());
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00004788 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004789
Hal Finkelee90a222014-09-26 05:04:30 +00004790 case ABIArgInfo::Expand:
4791 llvm_unreachable("Invalid ABI kind for return argument");
Anders Carlsson17490832009-12-24 20:40:36 +00004792 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004793
Hal Finkelee90a222014-09-26 05:04:30 +00004794 llvm_unreachable("Unhandled ABIArgInfo::Kind");
4795 } ();
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004796
John McCallb92ab1a2016-10-26 23:46:34 +00004797 // Emit the assume_aligned check on the return value.
Hal Finkelee90a222014-09-26 05:04:30 +00004798 if (Ret.isScalar() && TargetDecl) {
Roman Lebedeve819f7c2020-01-23 22:50:15 +03004799 AssumeAlignedAttrEmitter.EmitAsAnAssumption(Loc, RetTy, Ret);
Roman Lebedev5ffe6402020-01-23 22:50:24 +03004800 AllocAlignAttrEmitter.EmitAsAnAssumption(Loc, RetTy, Ret);
Daniel Dunbar573884e2008-09-10 07:04:09 +00004801 }
Daniel Dunbard3674e62008-09-11 01:48:57 +00004802
Francis Visoiu Mistrih143f6b82019-10-08 22:10:38 +00004803 // Explicitly call CallLifetimeEnd::Emit just to re-use the code even though
4804 // we can't use the full cleanup mechanism.
4805 for (CallLifetimeEnd &LifetimeEnd : CallLifetimeEndAfterCall)
4806 LifetimeEnd.Emit(*this, /*Flags=*/{});
4807
Akira Hatanakad35a4542019-11-20 18:13:44 -08004808 if (!ReturnValue.isExternallyDestructed() &&
4809 RetTy.isDestructedType() == QualType::DK_nontrivial_c_struct)
4810 pushDestroy(QualType::DK_nontrivial_c_struct, Ret.getAggregateAddress(),
4811 RetTy);
4812
Hal Finkelee90a222014-09-26 05:04:30 +00004813 return Ret;
Daniel Dunbar613855c2008-09-09 23:27:19 +00004814}
Daniel Dunbar2d0746f2009-02-10 20:44:09 +00004815
John McCall9831b842018-02-06 18:52:44 +00004816CGCallee CGCallee::prepareConcreteCallee(CodeGenFunction &CGF) const {
4817 if (isVirtual()) {
4818 const CallExpr *CE = getVirtualCallExpr();
4819 return CGF.CGM.getCXXABI().getVirtualFunctionPointer(
James Y Knightcfe8cd72019-02-07 01:15:41 +00004820 CGF, getVirtualMethodDecl(), getThisAddress(), getVirtualFunctionType(),
Stephen Kellyf2ceec42018-08-09 21:08:08 +00004821 CE ? CE->getBeginLoc() : SourceLocation());
John McCall9831b842018-02-06 18:52:44 +00004822 }
4823
4824 return *this;
4825}
4826
Daniel Dunbar2d0746f2009-02-10 20:44:09 +00004827/* VarArg handling */
4828
Charles Davisc7d5c942015-09-17 20:55:33 +00004829Address CodeGenFunction::EmitVAArg(VAArgExpr *VE, Address &VAListAddr) {
4830 VAListAddr = VE->isMicrosoftABI()
4831 ? EmitMSVAListRef(VE->getSubExpr())
4832 : EmitVAListRef(VE->getSubExpr());
4833 QualType Ty = VE->getType();
4834 if (VE->isMicrosoftABI())
4835 return CGM.getTypes().getABIInfo().EmitMSVAArg(*this, VAListAddr, Ty);
John McCall7f416cc2015-09-08 08:05:57 +00004836 return CGM.getTypes().getABIInfo().EmitVAArg(*this, VAListAddr, Ty);
Daniel Dunbar2d0746f2009-02-10 20:44:09 +00004837}