blob: d022c99711549e20569e7b17e09a8be295dca0d9 [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//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// These classes wrap the information about a call or function
11// definition used to handle ABI compliancy.
12//
13//===----------------------------------------------------------------------===//
14
15#include "CGCall.h"
Chris Lattnere70a0072010-06-29 16:40:28 +000016#include "ABIInfo.h"
Akira Hatanaka9d8ac612016-02-17 21:09:50 +000017#include "CGBlocks.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000018#include "CGCXXABI.h"
David Majnemer4e52d6f2015-12-12 05:39:21 +000019#include "CGCleanup.h"
Daniel Dunbar3d7c90b2008-09-08 21:33:45 +000020#include "CodeGenFunction.h"
Daniel Dunbarc68897d2008-09-10 00:41:16 +000021#include "CodeGenModule.h"
John McCalla729c622012-02-17 03:33:10 +000022#include "TargetInfo.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"
Eric Christopher15709992015-10-15 23:47:11 +000026#include "clang/Basic/TargetBuiltins.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000027#include "clang/Basic/TargetInfo.h"
Mark Laceya8e7df32013-10-30 21:53:58 +000028#include "clang/CodeGen/CGFunctionInfo.h"
John McCall12f23522016-04-04 18:33:08 +000029#include "clang/CodeGen/SwiftCallingConv.h"
Saleem Abdulrasool10a49722016-04-08 16:52:00 +000030#include "clang/Frontend/CodeGenOptions.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"
Nikolay Haustov8c6538b2016-06-30 09:06:33 +000034#include "llvm/IR/CallingConv.h"
Chandler Carruthc80ceea2014-03-04 11:02:08 +000035#include "llvm/IR/CallSite.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000036#include "llvm/IR/DataLayout.h"
37#include "llvm/IR/InlineAsm.h"
Saleem Abdulrasool94cfc602016-04-07 17:49:44 +000038#include "llvm/IR/Intrinsics.h"
Saleem Abdulrasool10a49722016-04-08 16:52:00 +000039#include "llvm/IR/IntrinsicInst.h"
Eli Friedmanf7456192011-06-15 22:09:18 +000040#include "llvm/Transforms/Utils/Local.h"
Daniel Dunbar3d7c90b2008-09-08 21:33:45 +000041using namespace clang;
42using namespace CodeGen;
43
44/***/
45
Nikolay Haustov8c6538b2016-06-30 09:06:33 +000046unsigned CodeGenTypes::ClangCallConvToLLVMCallConv(CallingConv CC) {
John McCallab26cfa2010-02-05 21:31:56 +000047 switch (CC) {
48 default: return llvm::CallingConv::C;
49 case CC_X86StdCall: return llvm::CallingConv::X86_StdCall;
50 case CC_X86FastCall: return llvm::CallingConv::X86_FastCall;
Erich Keane757d3172016-11-02 18:29:35 +000051 case CC_X86RegCall: return llvm::CallingConv::X86_RegCall;
Douglas Gregora941dca2010-05-18 16:57:00 +000052 case CC_X86ThisCall: return llvm::CallingConv::X86_ThisCall;
Martin Storsjo022e7822017-07-17 20:49:45 +000053 case CC_Win64: return llvm::CallingConv::Win64;
Charles Davisb5a214e2013-08-30 04:39:01 +000054 case CC_X86_64SysV: return llvm::CallingConv::X86_64_SysV;
Anton Korobeynikov231e8752011-04-14 20:06:49 +000055 case CC_AAPCS: return llvm::CallingConv::ARM_AAPCS;
56 case CC_AAPCS_VFP: return llvm::CallingConv::ARM_AAPCS_VFP;
Guy Benyeif0a014b2012-12-25 08:53:55 +000057 case CC_IntelOclBicc: return llvm::CallingConv::Intel_OCL_BI;
Reid Klecknerd7857f02014-10-24 17:42:17 +000058 // TODO: Add support for __pascal to LLVM.
59 case CC_X86Pascal: return llvm::CallingConv::C;
60 // TODO: Add support for __vectorcall to LLVM.
Reid Kleckner80944df2014-10-31 22:00:51 +000061 case CC_X86VectorCall: return llvm::CallingConv::X86_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
John McCall8ee376f2010-02-24 07:14:12 +000070/// Derives the 'this' type for codegen purposes, i.e. ignoring method
71/// qualification.
72/// FIXME: address space qualification?
John McCall2da83a32010-02-26 00:48:12 +000073static CanQualType GetThisType(ASTContext &Context, const CXXRecordDecl *RD) {
74 QualType RecTy = Context.getTagDeclType(RD)->getCanonicalTypeInternal();
75 return Context.getPointerType(CanQualType::CreateUnsafe(RecTy));
Daniel Dunbar7a95ca32008-09-10 04:01:49 +000076}
77
John McCall8ee376f2010-02-24 07:14:12 +000078/// Returns the canonical formal type of the given C++ method.
John McCall2da83a32010-02-26 00:48:12 +000079static CanQual<FunctionProtoType> GetFormalType(const CXXMethodDecl *MD) {
80 return MD->getType()->getCanonicalTypeUnqualified()
81 .getAs<FunctionProtoType>();
John McCall8ee376f2010-02-24 07:14:12 +000082}
83
84/// Returns the "extra-canonicalized" return type, which discards
85/// qualifiers on the return type. Codegen doesn't care about them,
86/// and it makes ABI code a little easier to be able to assume that
87/// all parameter and return types are top-level unqualified.
John McCall2da83a32010-02-26 00:48:12 +000088static CanQualType GetReturnType(QualType RetTy) {
89 return RetTy->getCanonicalTypeUnqualified().getUnqualifiedType();
John McCall8ee376f2010-02-24 07:14:12 +000090}
91
John McCall8dda7b22012-07-07 06:41:13 +000092/// Arrange the argument and result information for a value of the given
93/// unprototyped freestanding function type.
John McCall8ee376f2010-02-24 07:14:12 +000094const CGFunctionInfo &
John McCall8dda7b22012-07-07 06:41:13 +000095CodeGenTypes::arrangeFreeFunctionType(CanQual<FunctionNoProtoType> FTNP) {
John McCalla729c622012-02-17 03:33:10 +000096 // When translating an unprototyped function type, always use a
97 // variadic type.
Alp Toker314cc812014-01-25 16:55:45 +000098 return arrangeLLVMFunctionInfo(FTNP->getReturnType().getUnqualifiedType(),
Peter Collingbournef7706832014-12-12 23:41:25 +000099 /*instanceMethod=*/false,
100 /*chainCall=*/false, None,
John McCallc56a8b32016-03-11 04:30:31 +0000101 FTNP->getExtInfo(), {}, RequiredArgs(0));
John McCall8ee376f2010-02-24 07:14:12 +0000102}
103
George Burgess IVb7760212017-02-24 02:49:47 +0000104static void addExtParameterInfosForCall(
105 llvm::SmallVectorImpl<FunctionProtoType::ExtParameterInfo> &paramInfos,
106 const FunctionProtoType *proto,
107 unsigned prefixArgs,
108 unsigned totalArgs) {
109 assert(proto->hasExtParameterInfos());
110 assert(paramInfos.size() <= prefixArgs);
111 assert(proto->getNumParams() + prefixArgs <= totalArgs);
112
113 paramInfos.reserve(totalArgs);
114
115 // Add default infos for any prefix args that don't already have infos.
116 paramInfos.resize(prefixArgs);
117
118 // Add infos for the prototype.
119 for (const auto &ParamInfo : proto->getExtParameterInfos()) {
120 paramInfos.push_back(ParamInfo);
121 // pass_object_size params have no parameter info.
122 if (ParamInfo.hasPassObjectSize())
123 paramInfos.emplace_back();
124 }
125
126 assert(paramInfos.size() <= totalArgs &&
127 "Did we forget to insert pass_object_size args?");
128 // Add default infos for the variadic and/or suffix arguments.
129 paramInfos.resize(totalArgs);
130}
131
Hiroshi Inouec5e54dd2017-07-03 08:49:44 +0000132/// Adds the formal parameters in FPT to the given prefix. If any parameter in
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000133/// FPT has pass_object_size attrs, then we'll add parameters for those, too.
134static void appendParameterTypes(const CodeGenTypes &CGT,
135 SmallVectorImpl<CanQualType> &prefix,
John McCallc56a8b32016-03-11 04:30:31 +0000136 SmallVectorImpl<FunctionProtoType::ExtParameterInfo> &paramInfos,
George Burgess IVb7760212017-02-24 02:49:47 +0000137 CanQual<FunctionProtoType> FPT) {
138 // Fast path: don't touch param info if we don't need to.
139 if (!FPT->hasExtParameterInfos()) {
140 assert(paramInfos.empty() &&
141 "We have paramInfos, but the prototype doesn't?");
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000142 prefix.append(FPT->param_type_begin(), FPT->param_type_end());
143 return;
144 }
145
George Burgess IVb7760212017-02-24 02:49:47 +0000146 unsigned PrefixSize = prefix.size();
147 // In the vast majority of cases, we'll have precisely FPT->getNumParams()
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000148 // parameters; the only thing that can change this is the presence of
149 // pass_object_size. So, we preallocate for the common case.
150 prefix.reserve(prefix.size() + FPT->getNumParams());
151
George Burgess IVb7760212017-02-24 02:49:47 +0000152 auto ExtInfos = FPT->getExtParameterInfos();
153 assert(ExtInfos.size() == FPT->getNumParams());
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000154 for (unsigned I = 0, E = FPT->getNumParams(); I != E; ++I) {
155 prefix.push_back(FPT->getParamType(I));
George Burgess IVb7760212017-02-24 02:49:47 +0000156 if (ExtInfos[I].hasPassObjectSize())
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000157 prefix.push_back(CGT.getContext().getSizeType());
158 }
George Burgess IVb7760212017-02-24 02:49:47 +0000159
160 addExtParameterInfosForCall(paramInfos, FPT.getTypePtr(), PrefixSize,
161 prefix.size());
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000162}
163
John McCall8dda7b22012-07-07 06:41:13 +0000164/// Arrange the LLVM function layout for a value of the given function
Alexey Samsonove5ef3ca2014-08-13 23:55:54 +0000165/// type, on top of any implicit parameters already stored.
166static const CGFunctionInfo &
Peter Collingbournef7706832014-12-12 23:41:25 +0000167arrangeLLVMFunctionInfo(CodeGenTypes &CGT, bool instanceMethod,
Alexey Samsonove5ef3ca2014-08-13 23:55:54 +0000168 SmallVectorImpl<CanQualType> &prefix,
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000169 CanQual<FunctionProtoType> FTP,
170 const FunctionDecl *FD) {
John McCallc56a8b32016-03-11 04:30:31 +0000171 SmallVector<FunctionProtoType::ExtParameterInfo, 16> paramInfos;
George Burgess IV419996c2016-06-16 23:06:04 +0000172 RequiredArgs Required =
173 RequiredArgs::forPrototypePlus(FTP, prefix.size(), FD);
Daniel Dunbarbf8c24a2009-02-02 23:23:47 +0000174 // FIXME: Kill copy.
George Burgess IVb7760212017-02-24 02:49:47 +0000175 appendParameterTypes(CGT, prefix, paramInfos, FTP);
Alp Toker314cc812014-01-25 16:55:45 +0000176 CanQualType resultType = FTP->getReturnType().getUnqualifiedType();
John McCallc56a8b32016-03-11 04:30:31 +0000177
Peter Collingbournef7706832014-12-12 23:41:25 +0000178 return CGT.arrangeLLVMFunctionInfo(resultType, instanceMethod,
179 /*chainCall=*/false, prefix,
John McCallc56a8b32016-03-11 04:30:31 +0000180 FTP->getExtInfo(), paramInfos,
George Burgess IV419996c2016-06-16 23:06:04 +0000181 Required);
John McCall8ee376f2010-02-24 07:14:12 +0000182}
183
John McCalla729c622012-02-17 03:33:10 +0000184/// Arrange the argument and result information for a value of the
John McCall8dda7b22012-07-07 06:41:13 +0000185/// given freestanding function type.
John McCall8ee376f2010-02-24 07:14:12 +0000186const CGFunctionInfo &
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000187CodeGenTypes::arrangeFreeFunctionType(CanQual<FunctionProtoType> FTP,
188 const FunctionDecl *FD) {
John McCalla729c622012-02-17 03:33:10 +0000189 SmallVector<CanQualType, 16> argTypes;
Peter Collingbournef7706832014-12-12 23:41:25 +0000190 return ::arrangeLLVMFunctionInfo(*this, /*instanceMethod=*/false, argTypes,
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000191 FTP, FD);
Daniel Dunbar7feafc72009-09-11 22:24:53 +0000192}
193
Aaron Ballman0362a6d2013-12-18 16:23:37 +0000194static CallingConv getCallingConventionForDecl(const Decl *D, bool IsWindows) {
Daniel Dunbar7feafc72009-09-11 22:24:53 +0000195 // Set the appropriate calling convention for the Function.
196 if (D->hasAttr<StdCallAttr>())
John McCallab26cfa2010-02-05 21:31:56 +0000197 return CC_X86StdCall;
Daniel Dunbar7feafc72009-09-11 22:24:53 +0000198
199 if (D->hasAttr<FastCallAttr>())
John McCallab26cfa2010-02-05 21:31:56 +0000200 return CC_X86FastCall;
Daniel Dunbar7feafc72009-09-11 22:24:53 +0000201
Erich Keane757d3172016-11-02 18:29:35 +0000202 if (D->hasAttr<RegCallAttr>())
203 return CC_X86RegCall;
204
Douglas Gregora941dca2010-05-18 16:57:00 +0000205 if (D->hasAttr<ThisCallAttr>())
206 return CC_X86ThisCall;
207
Reid Klecknerd7857f02014-10-24 17:42:17 +0000208 if (D->hasAttr<VectorCallAttr>())
209 return CC_X86VectorCall;
210
Dawn Perchik335e16b2010-09-03 01:29:35 +0000211 if (D->hasAttr<PascalAttr>())
212 return CC_X86Pascal;
213
Anton Korobeynikov231e8752011-04-14 20:06:49 +0000214 if (PcsAttr *PCS = D->getAttr<PcsAttr>())
215 return (PCS->getPCS() == PcsAttr::AAPCS ? CC_AAPCS : CC_AAPCS_VFP);
216
Guy Benyeif0a014b2012-12-25 08:53:55 +0000217 if (D->hasAttr<IntelOclBiccAttr>())
218 return CC_IntelOclBicc;
219
Aaron Ballman0362a6d2013-12-18 16:23:37 +0000220 if (D->hasAttr<MSABIAttr>())
Martin Storsjo022e7822017-07-17 20:49:45 +0000221 return IsWindows ? CC_C : CC_Win64;
Aaron Ballman0362a6d2013-12-18 16:23:37 +0000222
223 if (D->hasAttr<SysVABIAttr>())
224 return IsWindows ? CC_X86_64SysV : CC_C;
225
Roman Levenstein35aa5ce2016-03-16 18:00:46 +0000226 if (D->hasAttr<PreserveMostAttr>())
227 return CC_PreserveMost;
228
229 if (D->hasAttr<PreserveAllAttr>())
230 return CC_PreserveAll;
231
John McCallab26cfa2010-02-05 21:31:56 +0000232 return CC_C;
Daniel Dunbar7a95ca32008-09-10 04:01:49 +0000233}
234
John McCalla729c622012-02-17 03:33:10 +0000235/// Arrange the argument and result information for a call to an
236/// unknown C++ non-static member function of the given abstract type.
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000237/// (Zero value of RD means we don't have any meaningful "this" argument type,
238/// so fall back to a generic pointer type).
John McCalla729c622012-02-17 03:33:10 +0000239/// The member function must be an ordinary function, i.e. not a
240/// constructor or destructor.
241const CGFunctionInfo &
242CodeGenTypes::arrangeCXXMethodType(const CXXRecordDecl *RD,
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000243 const FunctionProtoType *FTP,
244 const CXXMethodDecl *MD) {
John McCalla729c622012-02-17 03:33:10 +0000245 SmallVector<CanQualType, 16> argTypes;
John McCall8ee376f2010-02-24 07:14:12 +0000246
Anders Carlsson2ee3c012009-10-03 19:43:08 +0000247 // Add the 'this' pointer.
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000248 if (RD)
249 argTypes.push_back(GetThisType(Context, RD));
250 else
251 argTypes.push_back(Context.VoidPtrTy);
John McCall8ee376f2010-02-24 07:14:12 +0000252
Alexey Samsonove5ef3ca2014-08-13 23:55:54 +0000253 return ::arrangeLLVMFunctionInfo(
254 *this, true, argTypes,
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000255 FTP->getCanonicalTypeUnqualified().getAs<FunctionProtoType>(), MD);
Anders Carlsson2ee3c012009-10-03 19:43:08 +0000256}
257
John McCalla729c622012-02-17 03:33:10 +0000258/// Arrange the argument and result information for a declaration or
259/// definition of the given C++ non-static member function. The
260/// member function must be an ordinary function, i.e. not a
261/// constructor or destructor.
262const CGFunctionInfo &
263CodeGenTypes::arrangeCXXMethodDeclaration(const CXXMethodDecl *MD) {
Benjamin Kramer60509af2013-09-09 14:48:42 +0000264 assert(!isa<CXXConstructorDecl>(MD) && "wrong method for constructors!");
John McCall0d635f52010-09-03 01:26:39 +0000265 assert(!isa<CXXDestructorDecl>(MD) && "wrong method for destructors!");
266
John McCalla729c622012-02-17 03:33:10 +0000267 CanQual<FunctionProtoType> prototype = GetFormalType(MD);
Mike Stump11289f42009-09-09 15:08:12 +0000268
John McCalla729c622012-02-17 03:33:10 +0000269 if (MD->isInstance()) {
270 // The abstract case is perfectly fine.
Mark Lacey5ea993b2013-10-02 20:35:23 +0000271 const CXXRecordDecl *ThisType = TheCXXABI.getThisArgumentTypeForMethod(MD);
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000272 return arrangeCXXMethodType(ThisType, prototype.getTypePtr(), MD);
John McCalla729c622012-02-17 03:33:10 +0000273 }
274
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000275 return arrangeFreeFunctionType(prototype, MD);
Anders Carlssonb15b55c2009-04-03 22:48:58 +0000276}
277
Richard Smith5179eb72016-06-28 19:03:57 +0000278bool CodeGenTypes::inheritingCtorHasParams(
279 const InheritedConstructor &Inherited, CXXCtorType Type) {
280 // Parameters are unnecessary if we're constructing a base class subobject
281 // and the inherited constructor lives in a virtual base.
282 return Type == Ctor_Complete ||
283 !Inherited.getShadowDecl()->constructsVirtualBase() ||
284 !Target.getCXXABI().hasConstructorVariants();
285 }
286
John McCalla729c622012-02-17 03:33:10 +0000287const CGFunctionInfo &
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000288CodeGenTypes::arrangeCXXStructorDeclaration(const CXXMethodDecl *MD,
289 StructorType Type) {
290
John McCalla729c622012-02-17 03:33:10 +0000291 SmallVector<CanQualType, 16> argTypes;
John McCallc56a8b32016-03-11 04:30:31 +0000292 SmallVector<FunctionProtoType::ExtParameterInfo, 16> paramInfos;
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000293 argTypes.push_back(GetThisType(Context, MD->getParent()));
Stephen Lin9dc6eef2013-06-30 20:40:16 +0000294
Richard Smith5179eb72016-06-28 19:03:57 +0000295 bool PassParams = true;
296
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000297 GlobalDecl GD;
298 if (auto *CD = dyn_cast<CXXConstructorDecl>(MD)) {
299 GD = GlobalDecl(CD, toCXXCtorType(Type));
Richard Smith5179eb72016-06-28 19:03:57 +0000300
301 // A base class inheriting constructor doesn't get forwarded arguments
302 // needed to construct a virtual base (or base class thereof).
303 if (auto Inherited = CD->getInheritedConstructor())
304 PassParams = inheritingCtorHasParams(Inherited, toCXXCtorType(Type));
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000305 } else {
306 auto *DD = dyn_cast<CXXDestructorDecl>(MD);
307 GD = GlobalDecl(DD, toCXXDtorType(Type));
308 }
Anders Carlsson82ba57c2009-11-25 03:15:49 +0000309
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000310 CanQual<FunctionProtoType> FTP = GetFormalType(MD);
John McCall5d865c322010-08-31 07:33:07 +0000311
312 // Add the formal parameters.
Richard Smith5179eb72016-06-28 19:03:57 +0000313 if (PassParams)
George Burgess IVb7760212017-02-24 02:49:47 +0000314 appendParameterTypes(*this, argTypes, paramInfos, FTP);
John McCall5d865c322010-08-31 07:33:07 +0000315
George Burgess IV75b34a92017-02-22 22:38:25 +0000316 CGCXXABI::AddedStructorArgs AddedArgs =
317 TheCXXABI.buildStructorSignature(MD, Type, argTypes);
318 if (!paramInfos.empty()) {
319 // Note: prefix implies after the first param.
320 if (AddedArgs.Prefix)
321 paramInfos.insert(paramInfos.begin() + 1, AddedArgs.Prefix,
322 FunctionProtoType::ExtParameterInfo{});
323 if (AddedArgs.Suffix)
324 paramInfos.append(AddedArgs.Suffix,
325 FunctionProtoType::ExtParameterInfo{});
326 }
Reid Kleckner89077a12013-12-17 19:46:40 +0000327
328 RequiredArgs required =
Richard Smith5179eb72016-06-28 19:03:57 +0000329 (PassParams && MD->isVariadic() ? RequiredArgs(argTypes.size())
330 : RequiredArgs::All);
Reid Kleckner89077a12013-12-17 19:46:40 +0000331
John McCall8dda7b22012-07-07 06:41:13 +0000332 FunctionType::ExtInfo extInfo = FTP->getExtInfo();
David Majnemer0c0b6d92014-10-31 20:09:12 +0000333 CanQualType resultType = TheCXXABI.HasThisReturn(GD)
334 ? argTypes.front()
335 : TheCXXABI.hasMostDerivedReturn(GD)
336 ? CGM.getContext().VoidPtrTy
337 : Context.VoidTy;
Peter Collingbournef7706832014-12-12 23:41:25 +0000338 return arrangeLLVMFunctionInfo(resultType, /*instanceMethod=*/true,
339 /*chainCall=*/false, argTypes, extInfo,
John McCallc56a8b32016-03-11 04:30:31 +0000340 paramInfos, required);
341}
342
343static SmallVector<CanQualType, 16>
344getArgTypesForCall(ASTContext &ctx, const CallArgList &args) {
345 SmallVector<CanQualType, 16> argTypes;
346 for (auto &arg : args)
347 argTypes.push_back(ctx.getCanonicalParamType(arg.Ty));
348 return argTypes;
349}
350
351static SmallVector<CanQualType, 16>
352getArgTypesForDeclaration(ASTContext &ctx, const FunctionArgList &args) {
353 SmallVector<CanQualType, 16> argTypes;
354 for (auto &arg : args)
355 argTypes.push_back(ctx.getCanonicalParamType(arg->getType()));
356 return argTypes;
357}
358
John McCallc56a8b32016-03-11 04:30:31 +0000359static llvm::SmallVector<FunctionProtoType::ExtParameterInfo, 16>
360getExtParameterInfosForCall(const FunctionProtoType *proto,
361 unsigned prefixArgs, unsigned totalArgs) {
362 llvm::SmallVector<FunctionProtoType::ExtParameterInfo, 16> result;
363 if (proto->hasExtParameterInfos()) {
364 addExtParameterInfosForCall(result, proto, prefixArgs, totalArgs);
365 }
366 return result;
Anders Carlsson82ba57c2009-11-25 03:15:49 +0000367}
368
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000369/// Arrange a call to a C++ method, passing the given arguments.
George Burgess IVd0a9e802017-02-23 22:07:35 +0000370///
371/// ExtraPrefixArgs is the number of ABI-specific args passed after the `this`
372/// parameter.
373/// ExtraSuffixArgs is the number of ABI-specific args passed at the end of
374/// args.
375/// PassProtoArgs indicates whether `args` has args for the parameters in the
376/// given CXXConstructorDecl.
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000377const CGFunctionInfo &
378CodeGenTypes::arrangeCXXConstructorCall(const CallArgList &args,
379 const CXXConstructorDecl *D,
380 CXXCtorType CtorKind,
George Burgess IVd0a9e802017-02-23 22:07:35 +0000381 unsigned ExtraPrefixArgs,
382 unsigned ExtraSuffixArgs,
383 bool PassProtoArgs) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000384 // FIXME: Kill copy.
385 SmallVector<CanQualType, 16> ArgTypes;
Alexey Samsonov3551e312014-08-13 20:06:24 +0000386 for (const auto &Arg : args)
387 ArgTypes.push_back(Context.getCanonicalParamType(Arg.Ty));
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000388
George Burgess IVd0a9e802017-02-23 22:07:35 +0000389 // +1 for implicit this, which should always be args[0].
390 unsigned TotalPrefixArgs = 1 + ExtraPrefixArgs;
391
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000392 CanQual<FunctionProtoType> FPT = GetFormalType(D);
George Burgess IVd0a9e802017-02-23 22:07:35 +0000393 RequiredArgs Required =
394 RequiredArgs::forPrototypePlus(FPT, TotalPrefixArgs + ExtraSuffixArgs, D);
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000395 GlobalDecl GD(D, CtorKind);
David Majnemer0c0b6d92014-10-31 20:09:12 +0000396 CanQualType ResultType = TheCXXABI.HasThisReturn(GD)
397 ? ArgTypes.front()
398 : TheCXXABI.hasMostDerivedReturn(GD)
399 ? CGM.getContext().VoidPtrTy
400 : Context.VoidTy;
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000401
402 FunctionType::ExtInfo Info = FPT->getExtInfo();
George Burgess IVd0a9e802017-02-23 22:07:35 +0000403 llvm::SmallVector<FunctionProtoType::ExtParameterInfo, 16> ParamInfos;
404 // If the prototype args are elided, we should only have ABI-specific args,
405 // which never have param info.
406 if (PassProtoArgs && FPT->hasExtParameterInfos()) {
407 // ABI-specific suffix arguments are treated the same as variadic arguments.
408 addExtParameterInfosForCall(ParamInfos, FPT.getTypePtr(), TotalPrefixArgs,
409 ArgTypes.size());
410 }
Peter Collingbournef7706832014-12-12 23:41:25 +0000411 return arrangeLLVMFunctionInfo(ResultType, /*instanceMethod=*/true,
412 /*chainCall=*/false, ArgTypes, Info,
John McCallc56a8b32016-03-11 04:30:31 +0000413 ParamInfos, Required);
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000414}
415
John McCalla729c622012-02-17 03:33:10 +0000416/// Arrange the argument and result information for the declaration or
417/// definition of the given function.
418const CGFunctionInfo &
419CodeGenTypes::arrangeFunctionDeclaration(const FunctionDecl *FD) {
Chris Lattnerbea5b622009-05-12 20:27:19 +0000420 if (const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(FD))
Anders Carlssonb15b55c2009-04-03 22:48:58 +0000421 if (MD->isInstance())
John McCalla729c622012-02-17 03:33:10 +0000422 return arrangeCXXMethodDeclaration(MD);
Mike Stump11289f42009-09-09 15:08:12 +0000423
John McCall2da83a32010-02-26 00:48:12 +0000424 CanQualType FTy = FD->getType()->getCanonicalTypeUnqualified();
John McCalla729c622012-02-17 03:33:10 +0000425
John McCall2da83a32010-02-26 00:48:12 +0000426 assert(isa<FunctionType>(FTy));
John McCalla729c622012-02-17 03:33:10 +0000427
428 // When declaring a function without a prototype, always use a
429 // non-variadic type.
George Burgess IV35cfca22017-01-06 19:10:48 +0000430 if (CanQual<FunctionNoProtoType> noProto = FTy.getAs<FunctionNoProtoType>()) {
Peter Collingbournef7706832014-12-12 23:41:25 +0000431 return arrangeLLVMFunctionInfo(
432 noProto->getReturnType(), /*instanceMethod=*/false,
John McCallc56a8b32016-03-11 04:30:31 +0000433 /*chainCall=*/false, None, noProto->getExtInfo(), {},RequiredArgs::All);
John McCalla729c622012-02-17 03:33:10 +0000434 }
435
George Burgess IV35cfca22017-01-06 19:10:48 +0000436 return arrangeFreeFunctionType(FTy.castAs<FunctionProtoType>(), FD);
Daniel Dunbar3d7c90b2008-09-08 21:33:45 +0000437}
438
John McCalla729c622012-02-17 03:33:10 +0000439/// Arrange the argument and result information for the declaration or
440/// definition of an Objective-C method.
441const CGFunctionInfo &
442CodeGenTypes::arrangeObjCMethodDeclaration(const ObjCMethodDecl *MD) {
443 // It happens that this is the same as a call with no optional
444 // arguments, except also using the formal 'self' type.
445 return arrangeObjCMessageSendSignature(MD, MD->getSelfDecl()->getType());
446}
447
448/// Arrange the argument and result information for the function type
449/// through which to perform a send to the given Objective-C method,
450/// using the given receiver type. The receiver type is not always
451/// the 'self' type of the method or even an Objective-C pointer type.
452/// This is *not* the right method for actually performing such a
453/// message send, due to the possibility of optional arguments.
454const CGFunctionInfo &
455CodeGenTypes::arrangeObjCMessageSendSignature(const ObjCMethodDecl *MD,
456 QualType receiverType) {
457 SmallVector<CanQualType, 16> argTys;
Akira Hatanaka98a49332017-09-22 00:41:05 +0000458 SmallVector<FunctionProtoType::ExtParameterInfo, 4> extParamInfos(2);
John McCalla729c622012-02-17 03:33:10 +0000459 argTys.push_back(Context.getCanonicalParamType(receiverType));
460 argTys.push_back(Context.getCanonicalParamType(Context.getObjCSelType()));
Daniel Dunbarbf8c24a2009-02-02 23:23:47 +0000461 // FIXME: Kill copy?
David Majnemer59f77922016-06-24 04:05:48 +0000462 for (const auto *I : MD->parameters()) {
Aaron Ballman43b68be2014-03-07 17:50:17 +0000463 argTys.push_back(Context.getCanonicalParamType(I->getType()));
Akira Hatanaka98a49332017-09-22 00:41:05 +0000464 auto extParamInfo = FunctionProtoType::ExtParameterInfo().withIsNoEscape(
465 I->hasAttr<NoEscapeAttr>());
466 extParamInfos.push_back(extParamInfo);
John McCall8ee376f2010-02-24 07:14:12 +0000467 }
John McCall31168b02011-06-15 23:02:42 +0000468
469 FunctionType::ExtInfo einfo;
Aaron Ballman0362a6d2013-12-18 16:23:37 +0000470 bool IsWindows = getContext().getTargetInfo().getTriple().isOSWindows();
471 einfo = einfo.withCallingConv(getCallingConventionForDecl(MD, IsWindows));
John McCall31168b02011-06-15 23:02:42 +0000472
David Blaikiebbafb8a2012-03-11 07:00:24 +0000473 if (getContext().getLangOpts().ObjCAutoRefCount &&
John McCall31168b02011-06-15 23:02:42 +0000474 MD->hasAttr<NSReturnsRetainedAttr>())
475 einfo = einfo.withProducesResult(true);
476
John McCalla729c622012-02-17 03:33:10 +0000477 RequiredArgs required =
478 (MD->isVariadic() ? RequiredArgs(argTys.size()) : RequiredArgs::All);
479
Peter Collingbournef7706832014-12-12 23:41:25 +0000480 return arrangeLLVMFunctionInfo(
481 GetReturnType(MD->getReturnType()), /*instanceMethod=*/false,
Akira Hatanaka98a49332017-09-22 00:41:05 +0000482 /*chainCall=*/false, argTys, einfo, extParamInfos, required);
John McCallc56a8b32016-03-11 04:30:31 +0000483}
484
485const CGFunctionInfo &
486CodeGenTypes::arrangeUnprototypedObjCMessageSend(QualType returnType,
487 const CallArgList &args) {
488 auto argTypes = getArgTypesForCall(Context, args);
489 FunctionType::ExtInfo einfo;
490
491 return arrangeLLVMFunctionInfo(
492 GetReturnType(returnType), /*instanceMethod=*/false,
493 /*chainCall=*/false, argTypes, einfo, {}, RequiredArgs::All);
Daniel Dunbar3d7c90b2008-09-08 21:33:45 +0000494}
495
John McCalla729c622012-02-17 03:33:10 +0000496const CGFunctionInfo &
497CodeGenTypes::arrangeGlobalDeclaration(GlobalDecl GD) {
Anders Carlsson6710c532010-02-06 02:44:09 +0000498 // FIXME: Do we need to handle ObjCMethodDecl?
499 const FunctionDecl *FD = cast<FunctionDecl>(GD.getDecl());
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000500
Anders Carlsson6710c532010-02-06 02:44:09 +0000501 if (const CXXConstructorDecl *CD = dyn_cast<CXXConstructorDecl>(FD))
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000502 return arrangeCXXStructorDeclaration(CD, getFromCtorType(GD.getCtorType()));
Anders Carlsson6710c532010-02-06 02:44:09 +0000503
504 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(FD))
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000505 return arrangeCXXStructorDeclaration(DD, getFromDtorType(GD.getDtorType()));
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000506
John McCalla729c622012-02-17 03:33:10 +0000507 return arrangeFunctionDeclaration(FD);
Anders Carlsson6710c532010-02-06 02:44:09 +0000508}
509
Reid Klecknerc3473512014-08-29 21:43:29 +0000510/// Arrange a thunk that takes 'this' as the first parameter followed by
511/// varargs. Return a void pointer, regardless of the actual return type.
512/// The body of the thunk will end in a musttail call to a function of the
513/// correct type, and the caller will bitcast the function to the correct
514/// prototype.
515const CGFunctionInfo &
516CodeGenTypes::arrangeMSMemberPointerThunk(const CXXMethodDecl *MD) {
517 assert(MD->isVirtual() && "only virtual memptrs have thunks");
518 CanQual<FunctionProtoType> FTP = GetFormalType(MD);
519 CanQualType ArgTys[] = { GetThisType(Context, MD->getParent()) };
Peter Collingbournef7706832014-12-12 23:41:25 +0000520 return arrangeLLVMFunctionInfo(Context.VoidTy, /*instanceMethod=*/false,
521 /*chainCall=*/false, ArgTys,
John McCallc56a8b32016-03-11 04:30:31 +0000522 FTP->getExtInfo(), {}, RequiredArgs(1));
Reid Klecknerc3473512014-08-29 21:43:29 +0000523}
524
David Majnemerdfa6d202015-03-11 18:36:39 +0000525const CGFunctionInfo &
David Majnemer37fd66e2015-03-13 22:36:55 +0000526CodeGenTypes::arrangeMSCtorClosure(const CXXConstructorDecl *CD,
527 CXXCtorType CT) {
528 assert(CT == Ctor_CopyingClosure || CT == Ctor_DefaultClosure);
529
David Majnemerdfa6d202015-03-11 18:36:39 +0000530 CanQual<FunctionProtoType> FTP = GetFormalType(CD);
531 SmallVector<CanQualType, 2> ArgTys;
532 const CXXRecordDecl *RD = CD->getParent();
533 ArgTys.push_back(GetThisType(Context, RD));
David Majnemer37fd66e2015-03-13 22:36:55 +0000534 if (CT == Ctor_CopyingClosure)
535 ArgTys.push_back(*FTP->param_type_begin());
David Majnemerdfa6d202015-03-11 18:36:39 +0000536 if (RD->getNumVBases() > 0)
537 ArgTys.push_back(Context.IntTy);
538 CallingConv CC = Context.getDefaultCallingConvention(
539 /*IsVariadic=*/false, /*IsCXXMethod=*/true);
540 return arrangeLLVMFunctionInfo(Context.VoidTy, /*instanceMethod=*/true,
541 /*chainCall=*/false, ArgTys,
John McCallc56a8b32016-03-11 04:30:31 +0000542 FunctionType::ExtInfo(CC), {},
543 RequiredArgs::All);
David Majnemerdfa6d202015-03-11 18:36:39 +0000544}
545
John McCallc818bbb2012-12-07 07:03:17 +0000546/// Arrange a call as unto a free function, except possibly with an
547/// additional number of formal parameters considered required.
548static const CGFunctionInfo &
549arrangeFreeFunctionLikeCall(CodeGenTypes &CGT,
Mark Lacey23455752013-10-10 20:57:00 +0000550 CodeGenModule &CGM,
John McCallc818bbb2012-12-07 07:03:17 +0000551 const CallArgList &args,
552 const FunctionType *fnType,
Peter Collingbournef7706832014-12-12 23:41:25 +0000553 unsigned numExtraRequiredArgs,
554 bool chainCall) {
John McCallc818bbb2012-12-07 07:03:17 +0000555 assert(args.size() >= numExtraRequiredArgs);
556
John McCallc56a8b32016-03-11 04:30:31 +0000557 llvm::SmallVector<FunctionProtoType::ExtParameterInfo, 16> paramInfos;
558
John McCallc818bbb2012-12-07 07:03:17 +0000559 // In most cases, there are no optional arguments.
560 RequiredArgs required = RequiredArgs::All;
561
562 // If we have a variadic prototype, the required arguments are the
563 // extra prefix plus the arguments in the prototype.
564 if (const FunctionProtoType *proto = dyn_cast<FunctionProtoType>(fnType)) {
565 if (proto->isVariadic())
Alp Toker9cacbab2014-01-20 20:26:09 +0000566 required = RequiredArgs(proto->getNumParams() + numExtraRequiredArgs);
John McCallc818bbb2012-12-07 07:03:17 +0000567
John McCallc56a8b32016-03-11 04:30:31 +0000568 if (proto->hasExtParameterInfos())
569 addExtParameterInfosForCall(paramInfos, proto, numExtraRequiredArgs,
570 args.size());
571
John McCallc818bbb2012-12-07 07:03:17 +0000572 // If we don't have a prototype at all, but we're supposed to
573 // explicitly use the variadic convention for unprototyped calls,
574 // treat all of the arguments as required but preserve the nominal
575 // possibility of variadics.
Mark Lacey23455752013-10-10 20:57:00 +0000576 } else if (CGM.getTargetCodeGenInfo()
577 .isNoProtoCallVariadic(args,
578 cast<FunctionNoProtoType>(fnType))) {
John McCallc818bbb2012-12-07 07:03:17 +0000579 required = RequiredArgs(args.size());
580 }
581
Peter Collingbournef7706832014-12-12 23:41:25 +0000582 // FIXME: Kill copy.
583 SmallVector<CanQualType, 16> argTypes;
584 for (const auto &arg : args)
585 argTypes.push_back(CGT.getContext().getCanonicalParamType(arg.Ty));
586 return CGT.arrangeLLVMFunctionInfo(GetReturnType(fnType->getReturnType()),
587 /*instanceMethod=*/false, chainCall,
John McCallc56a8b32016-03-11 04:30:31 +0000588 argTypes, fnType->getExtInfo(), paramInfos,
589 required);
John McCallc818bbb2012-12-07 07:03:17 +0000590}
591
John McCalla729c622012-02-17 03:33:10 +0000592/// Figure out the rules for calling a function with the given formal
593/// type using the given arguments. The arguments are necessary
594/// because the function might be unprototyped, in which case it's
595/// target-dependent in crazy ways.
596const CGFunctionInfo &
John McCall8dda7b22012-07-07 06:41:13 +0000597CodeGenTypes::arrangeFreeFunctionCall(const CallArgList &args,
Peter Collingbournef7706832014-12-12 23:41:25 +0000598 const FunctionType *fnType,
599 bool chainCall) {
600 return arrangeFreeFunctionLikeCall(*this, CGM, args, fnType,
601 chainCall ? 1 : 0, chainCall);
John McCallc818bbb2012-12-07 07:03:17 +0000602}
John McCalla729c622012-02-17 03:33:10 +0000603
John McCallc56a8b32016-03-11 04:30:31 +0000604/// A block function is essentially a free function with an
John McCallc818bbb2012-12-07 07:03:17 +0000605/// extra implicit argument.
606const CGFunctionInfo &
607CodeGenTypes::arrangeBlockFunctionCall(const CallArgList &args,
608 const FunctionType *fnType) {
Peter Collingbournef7706832014-12-12 23:41:25 +0000609 return arrangeFreeFunctionLikeCall(*this, CGM, args, fnType, 1,
610 /*chainCall=*/false);
John McCalla729c622012-02-17 03:33:10 +0000611}
612
613const CGFunctionInfo &
John McCallc56a8b32016-03-11 04:30:31 +0000614CodeGenTypes::arrangeBlockFunctionDeclaration(const FunctionProtoType *proto,
615 const FunctionArgList &params) {
616 auto paramInfos = getExtParameterInfosForCall(proto, 1, params.size());
617 auto argTypes = getArgTypesForDeclaration(Context, params);
618
George Burgess IV419996c2016-06-16 23:06:04 +0000619 return arrangeLLVMFunctionInfo(
620 GetReturnType(proto->getReturnType()),
621 /*instanceMethod*/ false, /*chainCall*/ false, argTypes,
622 proto->getExtInfo(), paramInfos,
623 RequiredArgs::forPrototypePlus(proto, 1, nullptr));
John McCallc56a8b32016-03-11 04:30:31 +0000624}
625
626const CGFunctionInfo &
627CodeGenTypes::arrangeBuiltinFunctionCall(QualType resultType,
628 const CallArgList &args) {
Daniel Dunbarbf8c24a2009-02-02 23:23:47 +0000629 // FIXME: Kill copy.
John McCalla729c622012-02-17 03:33:10 +0000630 SmallVector<CanQualType, 16> argTypes;
Alexey Samsonov3551e312014-08-13 20:06:24 +0000631 for (const auto &Arg : args)
632 argTypes.push_back(Context.getCanonicalParamType(Arg.Ty));
Peter Collingbournef7706832014-12-12 23:41:25 +0000633 return arrangeLLVMFunctionInfo(
634 GetReturnType(resultType), /*instanceMethod=*/false,
John McCallc56a8b32016-03-11 04:30:31 +0000635 /*chainCall=*/false, argTypes, FunctionType::ExtInfo(),
636 /*paramInfos=*/ {}, RequiredArgs::All);
John McCall8dda7b22012-07-07 06:41:13 +0000637}
638
John McCallc56a8b32016-03-11 04:30:31 +0000639const CGFunctionInfo &
640CodeGenTypes::arrangeBuiltinFunctionDeclaration(QualType resultType,
641 const FunctionArgList &args) {
642 auto argTypes = getArgTypesForDeclaration(Context, args);
643
644 return arrangeLLVMFunctionInfo(
645 GetReturnType(resultType), /*instanceMethod=*/false, /*chainCall=*/false,
646 argTypes, FunctionType::ExtInfo(), {}, RequiredArgs::All);
647}
648
649const CGFunctionInfo &
650CodeGenTypes::arrangeBuiltinFunctionDeclaration(CanQualType resultType,
651 ArrayRef<CanQualType> argTypes) {
652 return arrangeLLVMFunctionInfo(
653 resultType, /*instanceMethod=*/false, /*chainCall=*/false,
654 argTypes, FunctionType::ExtInfo(), {}, RequiredArgs::All);
655}
656
John McCall8dda7b22012-07-07 06:41:13 +0000657/// Arrange a call to a C++ method, passing the given arguments.
George Burgess IVd0a9e802017-02-23 22:07:35 +0000658///
659/// numPrefixArgs is the number of ABI-specific prefix arguments we have. It
660/// does not count `this`.
John McCall8dda7b22012-07-07 06:41:13 +0000661const CGFunctionInfo &
662CodeGenTypes::arrangeCXXMethodCall(const CallArgList &args,
John McCallc56a8b32016-03-11 04:30:31 +0000663 const FunctionProtoType *proto,
George Burgess IVd0a9e802017-02-23 22:07:35 +0000664 RequiredArgs required,
665 unsigned numPrefixArgs) {
666 assert(numPrefixArgs + 1 <= args.size() &&
667 "Emitting a call with less args than the required prefix?");
668 // Add one to account for `this`. It's a bit awkward here, but we don't count
669 // `this` in similar places elsewhere.
John McCallc56a8b32016-03-11 04:30:31 +0000670 auto paramInfos =
George Burgess IVd0a9e802017-02-23 22:07:35 +0000671 getExtParameterInfosForCall(proto, numPrefixArgs + 1, args.size());
John McCallc56a8b32016-03-11 04:30:31 +0000672
John McCall8dda7b22012-07-07 06:41:13 +0000673 // FIXME: Kill copy.
John McCallc56a8b32016-03-11 04:30:31 +0000674 auto argTypes = getArgTypesForCall(Context, args);
John McCall8dda7b22012-07-07 06:41:13 +0000675
John McCallc56a8b32016-03-11 04:30:31 +0000676 FunctionType::ExtInfo info = proto->getExtInfo();
Peter Collingbournef7706832014-12-12 23:41:25 +0000677 return arrangeLLVMFunctionInfo(
John McCallc56a8b32016-03-11 04:30:31 +0000678 GetReturnType(proto->getReturnType()), /*instanceMethod=*/true,
679 /*chainCall=*/false, argTypes, info, paramInfos, required);
Daniel Dunbarbf8c24a2009-02-02 23:23:47 +0000680}
681
John McCalla729c622012-02-17 03:33:10 +0000682const CGFunctionInfo &CodeGenTypes::arrangeNullaryFunction() {
Peter Collingbournef7706832014-12-12 23:41:25 +0000683 return arrangeLLVMFunctionInfo(
684 getContext().VoidTy, /*instanceMethod=*/false, /*chainCall=*/false,
John McCallc56a8b32016-03-11 04:30:31 +0000685 None, FunctionType::ExtInfo(), {}, RequiredArgs::All);
686}
687
688const CGFunctionInfo &
689CodeGenTypes::arrangeCall(const CGFunctionInfo &signature,
690 const CallArgList &args) {
691 assert(signature.arg_size() <= args.size());
692 if (signature.arg_size() == args.size())
693 return signature;
694
695 SmallVector<FunctionProtoType::ExtParameterInfo, 16> paramInfos;
696 auto sigParamInfos = signature.getExtParameterInfos();
697 if (!sigParamInfos.empty()) {
698 paramInfos.append(sigParamInfos.begin(), sigParamInfos.end());
699 paramInfos.resize(args.size());
700 }
701
702 auto argTypes = getArgTypesForCall(Context, args);
703
704 assert(signature.getRequiredArgs().allowsOptionalArgs());
705 return arrangeLLVMFunctionInfo(signature.getReturnType(),
706 signature.isInstanceMethod(),
707 signature.isChainCall(),
708 argTypes,
709 signature.getExtInfo(),
710 paramInfos,
711 signature.getRequiredArgs());
John McCalla738c252011-03-09 04:27:21 +0000712}
713
Pekka Jaaskelainenfc2629a2017-06-01 07:18:49 +0000714namespace clang {
715namespace CodeGen {
716void computeSPIRKernelABIInfo(CodeGenModule &CGM, CGFunctionInfo &FI);
717}
718}
719
John McCalla729c622012-02-17 03:33:10 +0000720/// Arrange the argument and result information for an abstract value
721/// of a given function type. This is the method which all of the
722/// above functions ultimately defer to.
723const CGFunctionInfo &
John McCall8dda7b22012-07-07 06:41:13 +0000724CodeGenTypes::arrangeLLVMFunctionInfo(CanQualType resultType,
Peter Collingbournef7706832014-12-12 23:41:25 +0000725 bool instanceMethod,
726 bool chainCall,
John McCall8dda7b22012-07-07 06:41:13 +0000727 ArrayRef<CanQualType> argTypes,
728 FunctionType::ExtInfo info,
John McCallc56a8b32016-03-11 04:30:31 +0000729 ArrayRef<FunctionProtoType::ExtParameterInfo> paramInfos,
John McCall8dda7b22012-07-07 06:41:13 +0000730 RequiredArgs required) {
Saleem Abdulrasool32d1a962014-11-25 03:49:50 +0000731 assert(std::all_of(argTypes.begin(), argTypes.end(),
Richard Smith2c27df72017-03-23 23:17:58 +0000732 [](CanQualType T) { return T.isCanonicalAsParam(); }));
John McCall2da83a32010-02-26 00:48:12 +0000733
Daniel Dunbare0be8292009-02-03 00:07:12 +0000734 // Lookup or create unique function info.
735 llvm::FoldingSetNodeID ID;
John McCallc56a8b32016-03-11 04:30:31 +0000736 CGFunctionInfo::Profile(ID, instanceMethod, chainCall, info, paramInfos,
737 required, resultType, argTypes);
Daniel Dunbare0be8292009-02-03 00:07:12 +0000738
Craig Topper8a13c412014-05-21 05:09:00 +0000739 void *insertPos = nullptr;
John McCalla729c622012-02-17 03:33:10 +0000740 CGFunctionInfo *FI = FunctionInfos.FindNodeOrInsertPos(ID, insertPos);
Daniel Dunbare0be8292009-02-03 00:07:12 +0000741 if (FI)
742 return *FI;
743
John McCallc56a8b32016-03-11 04:30:31 +0000744 unsigned CC = ClangCallConvToLLVMCallConv(info.getCC());
745
John McCalla729c622012-02-17 03:33:10 +0000746 // Construct the function info. We co-allocate the ArgInfos.
Peter Collingbournef7706832014-12-12 23:41:25 +0000747 FI = CGFunctionInfo::create(CC, instanceMethod, chainCall, info,
John McCallc56a8b32016-03-11 04:30:31 +0000748 paramInfos, resultType, argTypes, required);
John McCalla729c622012-02-17 03:33:10 +0000749 FunctionInfos.InsertNode(FI, insertPos);
Daniel Dunbar313321e2009-02-03 05:31:23 +0000750
David Blaikie82e95a32014-11-19 07:49:47 +0000751 bool inserted = FunctionsBeingProcessed.insert(FI).second;
752 (void)inserted;
John McCalla729c622012-02-17 03:33:10 +0000753 assert(inserted && "Recursively being processed?");
Pekka Jaaskelainenfc2629a2017-06-01 07:18:49 +0000754
Daniel Dunbar313321e2009-02-03 05:31:23 +0000755 // Compute ABI information.
Pekka Jaaskelainenfc2629a2017-06-01 07:18:49 +0000756 if (CC == llvm::CallingConv::SPIR_KERNEL) {
757 // Force target independent argument handling for the host visible
758 // kernel functions.
759 computeSPIRKernelABIInfo(CGM, *FI);
760 } else if (info.getCC() == CC_Swift) {
John McCall12f23522016-04-04 18:33:08 +0000761 swiftcall::computeABIInfo(CGM, *FI);
Pekka Jaaskelainenfc2629a2017-06-01 07:18:49 +0000762 } else {
763 getABIInfo().computeInfo(*FI);
John McCall12f23522016-04-04 18:33:08 +0000764 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000765
Chris Lattnerfe34c1d2010-07-29 06:26:06 +0000766 // Loop over all of the computed argument and return value info. If any of
767 // them are direct or extend without a specified coerce type, specify the
768 // default now.
John McCalla729c622012-02-17 03:33:10 +0000769 ABIArgInfo &retInfo = FI->getReturnInfo();
Craig Topper8a13c412014-05-21 05:09:00 +0000770 if (retInfo.canHaveCoerceToType() && retInfo.getCoerceToType() == nullptr)
John McCalla729c622012-02-17 03:33:10 +0000771 retInfo.setCoerceToType(ConvertType(FI->getReturnType()));
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000772
Aaron Ballmanec47bc22014-03-17 18:10:01 +0000773 for (auto &I : FI->arguments())
Craig Topper8a13c412014-05-21 05:09:00 +0000774 if (I.info.canHaveCoerceToType() && I.info.getCoerceToType() == nullptr)
Aaron Ballmanec47bc22014-03-17 18:10:01 +0000775 I.info.setCoerceToType(ConvertType(I.type));
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000776
John McCalla729c622012-02-17 03:33:10 +0000777 bool erased = FunctionsBeingProcessed.erase(FI); (void)erased;
778 assert(erased && "Not in set?");
Chris Lattner1a651332011-07-15 06:41:05 +0000779
Daniel Dunbare0be8292009-02-03 00:07:12 +0000780 return *FI;
Daniel Dunbarbf8c24a2009-02-02 23:23:47 +0000781}
782
John McCalla729c622012-02-17 03:33:10 +0000783CGFunctionInfo *CGFunctionInfo::create(unsigned llvmCC,
Peter Collingbournef7706832014-12-12 23:41:25 +0000784 bool instanceMethod,
785 bool chainCall,
John McCalla729c622012-02-17 03:33:10 +0000786 const FunctionType::ExtInfo &info,
John McCallc56a8b32016-03-11 04:30:31 +0000787 ArrayRef<ExtParameterInfo> paramInfos,
John McCalla729c622012-02-17 03:33:10 +0000788 CanQualType resultType,
789 ArrayRef<CanQualType> argTypes,
790 RequiredArgs required) {
John McCallc56a8b32016-03-11 04:30:31 +0000791 assert(paramInfos.empty() || paramInfos.size() == argTypes.size());
792
793 void *buffer =
794 operator new(totalSizeToAlloc<ArgInfo, ExtParameterInfo>(
795 argTypes.size() + 1, paramInfos.size()));
796
John McCalla729c622012-02-17 03:33:10 +0000797 CGFunctionInfo *FI = new(buffer) CGFunctionInfo();
798 FI->CallingConvention = llvmCC;
799 FI->EffectiveCallingConvention = llvmCC;
800 FI->ASTCallingConvention = info.getCC();
Peter Collingbournef7706832014-12-12 23:41:25 +0000801 FI->InstanceMethod = instanceMethod;
802 FI->ChainCall = chainCall;
John McCalla729c622012-02-17 03:33:10 +0000803 FI->NoReturn = info.getNoReturn();
804 FI->ReturnsRetained = info.getProducesResult();
Oren Ben Simhon318a6ea2017-04-27 12:01:00 +0000805 FI->NoCallerSavedRegs = info.getNoCallerSavedRegs();
John McCalla729c622012-02-17 03:33:10 +0000806 FI->Required = required;
807 FI->HasRegParm = info.getHasRegParm();
808 FI->RegParm = info.getRegParm();
Craig Topper8a13c412014-05-21 05:09:00 +0000809 FI->ArgStruct = nullptr;
John McCall7f416cc2015-09-08 08:05:57 +0000810 FI->ArgStructAlign = 0;
John McCalla729c622012-02-17 03:33:10 +0000811 FI->NumArgs = argTypes.size();
John McCallc56a8b32016-03-11 04:30:31 +0000812 FI->HasExtParameterInfos = !paramInfos.empty();
John McCalla729c622012-02-17 03:33:10 +0000813 FI->getArgsBuffer()[0].type = resultType;
814 for (unsigned i = 0, e = argTypes.size(); i != e; ++i)
815 FI->getArgsBuffer()[i + 1].type = argTypes[i];
John McCallc56a8b32016-03-11 04:30:31 +0000816 for (unsigned i = 0, e = paramInfos.size(); i != e; ++i)
817 FI->getExtParameterInfosBuffer()[i] = paramInfos[i];
John McCalla729c622012-02-17 03:33:10 +0000818 return FI;
Daniel Dunbar313321e2009-02-03 05:31:23 +0000819}
820
821/***/
822
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000823namespace {
824// ABIArgInfo::Expand implementation.
825
826// Specifies the way QualType passed as ABIArgInfo::Expand is expanded.
827struct TypeExpansion {
828 enum TypeExpansionKind {
829 // Elements of constant arrays are expanded recursively.
830 TEK_ConstantArray,
831 // Record fields are expanded recursively (but if record is a union, only
832 // the field with the largest size is expanded).
833 TEK_Record,
834 // For complex types, real and imaginary parts are expanded recursively.
835 TEK_Complex,
836 // All other types are not expandable.
837 TEK_None
838 };
839
840 const TypeExpansionKind Kind;
841
842 TypeExpansion(TypeExpansionKind K) : Kind(K) {}
Angel Garcia Gomez637d1e62015-10-20 13:23:58 +0000843 virtual ~TypeExpansion() {}
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000844};
845
846struct ConstantArrayExpansion : TypeExpansion {
847 QualType EltTy;
848 uint64_t NumElts;
849
850 ConstantArrayExpansion(QualType EltTy, uint64_t NumElts)
851 : TypeExpansion(TEK_ConstantArray), EltTy(EltTy), NumElts(NumElts) {}
852 static bool classof(const TypeExpansion *TE) {
853 return TE->Kind == TEK_ConstantArray;
854 }
855};
856
857struct RecordExpansion : TypeExpansion {
Reid Klecknere9f6a712014-10-31 17:10:41 +0000858 SmallVector<const CXXBaseSpecifier *, 1> Bases;
859
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000860 SmallVector<const FieldDecl *, 1> Fields;
861
Reid Klecknere9f6a712014-10-31 17:10:41 +0000862 RecordExpansion(SmallVector<const CXXBaseSpecifier *, 1> &&Bases,
863 SmallVector<const FieldDecl *, 1> &&Fields)
Benjamin Kramer0bb97742016-02-13 16:00:13 +0000864 : TypeExpansion(TEK_Record), Bases(std::move(Bases)),
865 Fields(std::move(Fields)) {}
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000866 static bool classof(const TypeExpansion *TE) {
867 return TE->Kind == TEK_Record;
868 }
869};
870
871struct ComplexExpansion : TypeExpansion {
872 QualType EltTy;
873
874 ComplexExpansion(QualType EltTy) : TypeExpansion(TEK_Complex), EltTy(EltTy) {}
875 static bool classof(const TypeExpansion *TE) {
876 return TE->Kind == TEK_Complex;
877 }
878};
879
880struct NoExpansion : TypeExpansion {
881 NoExpansion() : TypeExpansion(TEK_None) {}
882 static bool classof(const TypeExpansion *TE) {
883 return TE->Kind == TEK_None;
884 }
885};
886} // namespace
887
888static std::unique_ptr<TypeExpansion>
889getTypeExpansion(QualType Ty, const ASTContext &Context) {
890 if (const ConstantArrayType *AT = Context.getAsConstantArrayType(Ty)) {
891 return llvm::make_unique<ConstantArrayExpansion>(
892 AT->getElementType(), AT->getSize().getZExtValue());
893 }
894 if (const RecordType *RT = Ty->getAs<RecordType>()) {
Reid Klecknere9f6a712014-10-31 17:10:41 +0000895 SmallVector<const CXXBaseSpecifier *, 1> Bases;
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000896 SmallVector<const FieldDecl *, 1> Fields;
Bob Wilsone826a2a2011-08-03 05:58:22 +0000897 const RecordDecl *RD = RT->getDecl();
898 assert(!RD->hasFlexibleArrayMember() &&
899 "Cannot expand structure with flexible array.");
Anton Korobeynikov4215ca72012-04-13 11:22:00 +0000900 if (RD->isUnion()) {
901 // Unions can be here only in degenerative cases - all the fields are same
902 // after flattening. Thus we have to use the "largest" field.
Craig Topper8a13c412014-05-21 05:09:00 +0000903 const FieldDecl *LargestFD = nullptr;
Anton Korobeynikov4215ca72012-04-13 11:22:00 +0000904 CharUnits UnionSize = CharUnits::Zero();
905
Aaron Ballmane8a8bae2014-03-08 20:12:42 +0000906 for (const auto *FD : RD->fields()) {
Reid Kleckner80944df2014-10-31 22:00:51 +0000907 // Skip zero length bitfields.
908 if (FD->isBitField() && FD->getBitWidthValue(Context) == 0)
909 continue;
Anton Korobeynikov4215ca72012-04-13 11:22:00 +0000910 assert(!FD->isBitField() &&
911 "Cannot expand structure with bit-field members.");
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000912 CharUnits FieldSize = Context.getTypeSizeInChars(FD->getType());
Anton Korobeynikov4215ca72012-04-13 11:22:00 +0000913 if (UnionSize < FieldSize) {
914 UnionSize = FieldSize;
915 LargestFD = FD;
916 }
917 }
918 if (LargestFD)
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000919 Fields.push_back(LargestFD);
Anton Korobeynikov4215ca72012-04-13 11:22:00 +0000920 } else {
Reid Klecknere9f6a712014-10-31 17:10:41 +0000921 if (const auto *CXXRD = dyn_cast<CXXRecordDecl>(RD)) {
922 assert(!CXXRD->isDynamicClass() &&
923 "cannot expand vtable pointers in dynamic classes");
924 for (const CXXBaseSpecifier &BS : CXXRD->bases())
925 Bases.push_back(&BS);
926 }
927
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000928 for (const auto *FD : RD->fields()) {
Reid Kleckner80944df2014-10-31 22:00:51 +0000929 // Skip zero length bitfields.
930 if (FD->isBitField() && FD->getBitWidthValue(Context) == 0)
931 continue;
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000932 assert(!FD->isBitField() &&
Anton Korobeynikov4215ca72012-04-13 11:22:00 +0000933 "Cannot expand structure with bit-field members.");
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000934 Fields.push_back(FD);
Anton Korobeynikov4215ca72012-04-13 11:22:00 +0000935 }
Bob Wilsone826a2a2011-08-03 05:58:22 +0000936 }
Reid Klecknere9f6a712014-10-31 17:10:41 +0000937 return llvm::make_unique<RecordExpansion>(std::move(Bases),
938 std::move(Fields));
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000939 }
940 if (const ComplexType *CT = Ty->getAs<ComplexType>()) {
941 return llvm::make_unique<ComplexExpansion>(CT->getElementType());
942 }
943 return llvm::make_unique<NoExpansion>();
944}
945
Alexey Samsonov52c0f6a2014-09-29 20:30:22 +0000946static int getExpansionSize(QualType Ty, const ASTContext &Context) {
947 auto Exp = getTypeExpansion(Ty, Context);
948 if (auto CAExp = dyn_cast<ConstantArrayExpansion>(Exp.get())) {
949 return CAExp->NumElts * getExpansionSize(CAExp->EltTy, Context);
950 }
951 if (auto RExp = dyn_cast<RecordExpansion>(Exp.get())) {
952 int Res = 0;
Reid Klecknere9f6a712014-10-31 17:10:41 +0000953 for (auto BS : RExp->Bases)
954 Res += getExpansionSize(BS->getType(), Context);
Alexey Samsonov52c0f6a2014-09-29 20:30:22 +0000955 for (auto FD : RExp->Fields)
956 Res += getExpansionSize(FD->getType(), Context);
957 return Res;
958 }
959 if (isa<ComplexExpansion>(Exp.get()))
960 return 2;
961 assert(isa<NoExpansion>(Exp.get()));
962 return 1;
963}
964
Alexey Samsonov153004f2014-09-29 22:08:00 +0000965void
966CodeGenTypes::getExpandedTypes(QualType Ty,
967 SmallVectorImpl<llvm::Type *>::iterator &TI) {
968 auto Exp = getTypeExpansion(Ty, Context);
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000969 if (auto CAExp = dyn_cast<ConstantArrayExpansion>(Exp.get())) {
970 for (int i = 0, n = CAExp->NumElts; i < n; i++) {
Alexey Samsonov153004f2014-09-29 22:08:00 +0000971 getExpandedTypes(CAExp->EltTy, TI);
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000972 }
973 } else if (auto RExp = dyn_cast<RecordExpansion>(Exp.get())) {
Reid Klecknere9f6a712014-10-31 17:10:41 +0000974 for (auto BS : RExp->Bases)
975 getExpandedTypes(BS->getType(), TI);
976 for (auto FD : RExp->Fields)
Alexey Samsonov153004f2014-09-29 22:08:00 +0000977 getExpandedTypes(FD->getType(), TI);
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000978 } else if (auto CExp = dyn_cast<ComplexExpansion>(Exp.get())) {
979 llvm::Type *EltTy = ConvertType(CExp->EltTy);
Alexey Samsonov153004f2014-09-29 22:08:00 +0000980 *TI++ = EltTy;
981 *TI++ = EltTy;
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000982 } else {
983 assert(isa<NoExpansion>(Exp.get()));
Alexey Samsonov153004f2014-09-29 22:08:00 +0000984 *TI++ = ConvertType(Ty);
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000985 }
Daniel Dunbar8fc81b02008-09-17 00:51:38 +0000986}
987
John McCall7f416cc2015-09-08 08:05:57 +0000988static void forConstantArrayExpansion(CodeGenFunction &CGF,
989 ConstantArrayExpansion *CAE,
990 Address BaseAddr,
991 llvm::function_ref<void(Address)> Fn) {
992 CharUnits EltSize = CGF.getContext().getTypeSizeInChars(CAE->EltTy);
993 CharUnits EltAlign =
994 BaseAddr.getAlignment().alignmentOfArrayElement(EltSize);
995
996 for (int i = 0, n = CAE->NumElts; i < n; i++) {
997 llvm::Value *EltAddr =
998 CGF.Builder.CreateConstGEP2_32(nullptr, BaseAddr.getPointer(), 0, i);
999 Fn(Address(EltAddr, EltAlign));
1000 }
1001}
1002
Alexey Samsonov91cf4552014-08-22 01:06:06 +00001003void CodeGenFunction::ExpandTypeFromArgs(
John McCall12f23522016-04-04 18:33:08 +00001004 QualType Ty, LValue LV, SmallVectorImpl<llvm::Value *>::iterator &AI) {
Mike Stump11289f42009-09-09 15:08:12 +00001005 assert(LV.isSimple() &&
1006 "Unexpected non-simple lvalue during struct expansion.");
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00001007
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001008 auto Exp = getTypeExpansion(Ty, getContext());
1009 if (auto CAExp = dyn_cast<ConstantArrayExpansion>(Exp.get())) {
John McCall7f416cc2015-09-08 08:05:57 +00001010 forConstantArrayExpansion(*this, CAExp, LV.getAddress(),
1011 [&](Address EltAddr) {
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001012 LValue LV = MakeAddrLValue(EltAddr, CAExp->EltTy);
1013 ExpandTypeFromArgs(CAExp->EltTy, LV, AI);
John McCall7f416cc2015-09-08 08:05:57 +00001014 });
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001015 } else if (auto RExp = dyn_cast<RecordExpansion>(Exp.get())) {
John McCall7f416cc2015-09-08 08:05:57 +00001016 Address This = LV.getAddress();
Reid Klecknere9f6a712014-10-31 17:10:41 +00001017 for (const CXXBaseSpecifier *BS : RExp->Bases) {
1018 // Perform a single step derived-to-base conversion.
John McCall7f416cc2015-09-08 08:05:57 +00001019 Address Base =
Reid Klecknere9f6a712014-10-31 17:10:41 +00001020 GetAddressOfBaseClass(This, Ty->getAsCXXRecordDecl(), &BS, &BS + 1,
1021 /*NullCheckValue=*/false, SourceLocation());
1022 LValue SubLV = MakeAddrLValue(Base, BS->getType());
1023
1024 // Recurse onto bases.
1025 ExpandTypeFromArgs(BS->getType(), SubLV, AI);
1026 }
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001027 for (auto FD : RExp->Fields) {
1028 // FIXME: What are the right qualifiers here?
Reid Kleckner9d031092016-05-02 22:42:34 +00001029 LValue SubLV = EmitLValueForFieldInitialization(LV, FD);
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001030 ExpandTypeFromArgs(FD->getType(), SubLV, AI);
Bob Wilsone826a2a2011-08-03 05:58:22 +00001031 }
John McCall7f416cc2015-09-08 08:05:57 +00001032 } else if (isa<ComplexExpansion>(Exp.get())) {
1033 auto realValue = *AI++;
1034 auto imagValue = *AI++;
1035 EmitStoreOfComplex(ComplexPairTy(realValue, imagValue), LV, /*init*/ true);
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001036 } else {
1037 assert(isa<NoExpansion>(Exp.get()));
1038 EmitStoreThroughLValue(RValue::get(*AI++), LV);
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00001039 }
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001040}
1041
1042void CodeGenFunction::ExpandTypeToArgs(
1043 QualType Ty, RValue RV, llvm::FunctionType *IRFuncTy,
1044 SmallVectorImpl<llvm::Value *> &IRCallArgs, unsigned &IRCallArgPos) {
1045 auto Exp = getTypeExpansion(Ty, getContext());
1046 if (auto CAExp = dyn_cast<ConstantArrayExpansion>(Exp.get())) {
John McCall7f416cc2015-09-08 08:05:57 +00001047 forConstantArrayExpansion(*this, CAExp, RV.getAggregateAddress(),
1048 [&](Address EltAddr) {
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001049 RValue EltRV =
1050 convertTempToRValue(EltAddr, CAExp->EltTy, SourceLocation());
1051 ExpandTypeToArgs(CAExp->EltTy, EltRV, IRFuncTy, IRCallArgs, IRCallArgPos);
John McCall7f416cc2015-09-08 08:05:57 +00001052 });
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001053 } else if (auto RExp = dyn_cast<RecordExpansion>(Exp.get())) {
John McCall7f416cc2015-09-08 08:05:57 +00001054 Address This = RV.getAggregateAddress();
Reid Klecknere9f6a712014-10-31 17:10:41 +00001055 for (const CXXBaseSpecifier *BS : RExp->Bases) {
1056 // Perform a single step derived-to-base conversion.
John McCall7f416cc2015-09-08 08:05:57 +00001057 Address Base =
Reid Klecknere9f6a712014-10-31 17:10:41 +00001058 GetAddressOfBaseClass(This, Ty->getAsCXXRecordDecl(), &BS, &BS + 1,
1059 /*NullCheckValue=*/false, SourceLocation());
1060 RValue BaseRV = RValue::getAggregate(Base);
1061
1062 // Recurse onto bases.
1063 ExpandTypeToArgs(BS->getType(), BaseRV, IRFuncTy, IRCallArgs,
1064 IRCallArgPos);
1065 }
1066
1067 LValue LV = MakeAddrLValue(This, Ty);
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001068 for (auto FD : RExp->Fields) {
1069 RValue FldRV = EmitRValueForField(LV, FD, SourceLocation());
1070 ExpandTypeToArgs(FD->getType(), FldRV, IRFuncTy, IRCallArgs,
1071 IRCallArgPos);
1072 }
1073 } else if (isa<ComplexExpansion>(Exp.get())) {
1074 ComplexPairTy CV = RV.getComplexVal();
1075 IRCallArgs[IRCallArgPos++] = CV.first;
1076 IRCallArgs[IRCallArgPos++] = CV.second;
1077 } else {
1078 assert(isa<NoExpansion>(Exp.get()));
1079 assert(RV.isScalar() &&
1080 "Unexpected non-scalar rvalue during struct expansion.");
1081
1082 // Insert a bitcast as needed.
1083 llvm::Value *V = RV.getScalarVal();
1084 if (IRCallArgPos < IRFuncTy->getNumParams() &&
1085 V->getType() != IRFuncTy->getParamType(IRCallArgPos))
1086 V = Builder.CreateBitCast(V, IRFuncTy->getParamType(IRCallArgPos));
1087
1088 IRCallArgs[IRCallArgPos++] = V;
1089 }
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00001090}
1091
John McCall7f416cc2015-09-08 08:05:57 +00001092/// Create a temporary allocation for the purposes of coercion.
1093static Address CreateTempAllocaForCoercion(CodeGenFunction &CGF, llvm::Type *Ty,
1094 CharUnits MinAlign) {
1095 // Don't use an alignment that's worse than what LLVM would prefer.
1096 auto PrefAlign = CGF.CGM.getDataLayout().getPrefTypeAlignment(Ty);
1097 CharUnits Align = std::max(MinAlign, CharUnits::fromQuantity(PrefAlign));
1098
1099 return CGF.CreateTempAlloca(Ty, Align);
1100}
1101
Chris Lattner895c52b2010-06-27 06:04:18 +00001102/// EnterStructPointerForCoercedAccess - Given a struct pointer that we are
Chris Lattner1cd66982010-06-27 05:56:15 +00001103/// accessing some number of bytes out of it, try to gep into the struct to get
1104/// at its inner goodness. Dive as deep as possible without entering an element
1105/// with an in-memory size smaller than DstSize.
John McCall7f416cc2015-09-08 08:05:57 +00001106static Address
1107EnterStructPointerForCoercedAccess(Address SrcPtr,
Chris Lattner2192fe52011-07-18 04:24:23 +00001108 llvm::StructType *SrcSTy,
Chris Lattner895c52b2010-06-27 06:04:18 +00001109 uint64_t DstSize, CodeGenFunction &CGF) {
Chris Lattner1cd66982010-06-27 05:56:15 +00001110 // We can't dive into a zero-element struct.
1111 if (SrcSTy->getNumElements() == 0) return SrcPtr;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001112
Chris Lattner2192fe52011-07-18 04:24:23 +00001113 llvm::Type *FirstElt = SrcSTy->getElementType(0);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001114
Chris Lattner1cd66982010-06-27 05:56:15 +00001115 // 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 +00001116 // first element is the same size as the whole struct, we can enter it. The
1117 // comparison must be made on the store size and not the alloca size. Using
1118 // the alloca size may overstate the size of the load.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001119 uint64_t FirstEltSize =
James Molloy90d61012014-08-29 10:17:52 +00001120 CGF.CGM.getDataLayout().getTypeStoreSize(FirstElt);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001121 if (FirstEltSize < DstSize &&
James Molloy90d61012014-08-29 10:17:52 +00001122 FirstEltSize < CGF.CGM.getDataLayout().getTypeStoreSize(SrcSTy))
Chris Lattner1cd66982010-06-27 05:56:15 +00001123 return SrcPtr;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001124
Chris Lattner1cd66982010-06-27 05:56:15 +00001125 // GEP into the first element.
John McCall7f416cc2015-09-08 08:05:57 +00001126 SrcPtr = CGF.Builder.CreateStructGEP(SrcPtr, 0, CharUnits(), "coerce.dive");
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001127
Chris Lattner1cd66982010-06-27 05:56:15 +00001128 // If the first element is a struct, recurse.
John McCall7f416cc2015-09-08 08:05:57 +00001129 llvm::Type *SrcTy = SrcPtr.getElementType();
Chris Lattner2192fe52011-07-18 04:24:23 +00001130 if (llvm::StructType *SrcSTy = dyn_cast<llvm::StructType>(SrcTy))
Chris Lattner895c52b2010-06-27 06:04:18 +00001131 return EnterStructPointerForCoercedAccess(SrcPtr, SrcSTy, DstSize, CGF);
Chris Lattner1cd66982010-06-27 05:56:15 +00001132
1133 return SrcPtr;
1134}
1135
Chris Lattner055097f2010-06-27 06:26:04 +00001136/// CoerceIntOrPtrToIntOrPtr - Convert a value Val to the specific Ty where both
1137/// are either integers or pointers. This does a truncation of the value if it
1138/// is too large or a zero extension if it is too small.
Jakob Stoklund Olesen36af2522013-06-05 03:00:13 +00001139///
1140/// This behaves as if the value were coerced through memory, so on big-endian
1141/// targets the high bits are preserved in a truncation, while little-endian
1142/// targets preserve the low bits.
Chris Lattner055097f2010-06-27 06:26:04 +00001143static llvm::Value *CoerceIntOrPtrToIntOrPtr(llvm::Value *Val,
Chris Lattner2192fe52011-07-18 04:24:23 +00001144 llvm::Type *Ty,
Chris Lattner055097f2010-06-27 06:26:04 +00001145 CodeGenFunction &CGF) {
1146 if (Val->getType() == Ty)
1147 return Val;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001148
Chris Lattner055097f2010-06-27 06:26:04 +00001149 if (isa<llvm::PointerType>(Val->getType())) {
1150 // If this is Pointer->Pointer avoid conversion to and from int.
1151 if (isa<llvm::PointerType>(Ty))
1152 return CGF.Builder.CreateBitCast(Val, Ty, "coerce.val");
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001153
Chris Lattner055097f2010-06-27 06:26:04 +00001154 // Convert the pointer to an integer so we can play with its width.
Chris Lattner5e016ae2010-06-27 07:15:29 +00001155 Val = CGF.Builder.CreatePtrToInt(Val, CGF.IntPtrTy, "coerce.val.pi");
Chris Lattner055097f2010-06-27 06:26:04 +00001156 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001157
Chris Lattner2192fe52011-07-18 04:24:23 +00001158 llvm::Type *DestIntTy = Ty;
Chris Lattner055097f2010-06-27 06:26:04 +00001159 if (isa<llvm::PointerType>(DestIntTy))
Chris Lattner5e016ae2010-06-27 07:15:29 +00001160 DestIntTy = CGF.IntPtrTy;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001161
Jakob Stoklund Olesen36af2522013-06-05 03:00:13 +00001162 if (Val->getType() != DestIntTy) {
1163 const llvm::DataLayout &DL = CGF.CGM.getDataLayout();
1164 if (DL.isBigEndian()) {
1165 // Preserve the high bits on big-endian targets.
1166 // That is what memory coercion does.
James Molloy491cefb2014-05-07 17:41:15 +00001167 uint64_t SrcSize = DL.getTypeSizeInBits(Val->getType());
1168 uint64_t DstSize = DL.getTypeSizeInBits(DestIntTy);
1169
Jakob Stoklund Olesen36af2522013-06-05 03:00:13 +00001170 if (SrcSize > DstSize) {
1171 Val = CGF.Builder.CreateLShr(Val, SrcSize - DstSize, "coerce.highbits");
1172 Val = CGF.Builder.CreateTrunc(Val, DestIntTy, "coerce.val.ii");
1173 } else {
1174 Val = CGF.Builder.CreateZExt(Val, DestIntTy, "coerce.val.ii");
1175 Val = CGF.Builder.CreateShl(Val, DstSize - SrcSize, "coerce.highbits");
1176 }
1177 } else {
1178 // Little-endian targets preserve the low bits. No shifts required.
1179 Val = CGF.Builder.CreateIntCast(Val, DestIntTy, false, "coerce.val.ii");
1180 }
1181 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001182
Chris Lattner055097f2010-06-27 06:26:04 +00001183 if (isa<llvm::PointerType>(Ty))
1184 Val = CGF.Builder.CreateIntToPtr(Val, Ty, "coerce.val.ip");
1185 return Val;
1186}
1187
Chris Lattner1cd66982010-06-27 05:56:15 +00001188
1189
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001190/// CreateCoercedLoad - Create a load from \arg SrcPtr interpreted as
Ulrich Weigand6e2cea62015-07-10 11:31:43 +00001191/// a pointer to an object of type \arg Ty, known to be aligned to
1192/// \arg SrcAlign bytes.
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001193///
1194/// This safely handles the case when the src type is smaller than the
1195/// destination type; in this situation the values of bits which not
1196/// present in the src are undefined.
John McCall7f416cc2015-09-08 08:05:57 +00001197static llvm::Value *CreateCoercedLoad(Address Src, llvm::Type *Ty,
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001198 CodeGenFunction &CGF) {
John McCall7f416cc2015-09-08 08:05:57 +00001199 llvm::Type *SrcTy = Src.getElementType();
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001200
Chris Lattnerd200eda2010-06-28 22:51:39 +00001201 // If SrcTy and Ty are the same, just do a load.
1202 if (SrcTy == Ty)
John McCall7f416cc2015-09-08 08:05:57 +00001203 return CGF.Builder.CreateLoad(Src);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001204
Micah Villmowdd31ca12012-10-08 16:25:52 +00001205 uint64_t DstSize = CGF.CGM.getDataLayout().getTypeAllocSize(Ty);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001206
Chris Lattner2192fe52011-07-18 04:24:23 +00001207 if (llvm::StructType *SrcSTy = dyn_cast<llvm::StructType>(SrcTy)) {
John McCall7f416cc2015-09-08 08:05:57 +00001208 Src = EnterStructPointerForCoercedAccess(Src, SrcSTy, DstSize, CGF);
1209 SrcTy = Src.getType()->getElementType();
Chris Lattner1cd66982010-06-27 05:56:15 +00001210 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001211
Micah Villmowdd31ca12012-10-08 16:25:52 +00001212 uint64_t SrcSize = CGF.CGM.getDataLayout().getTypeAllocSize(SrcTy);
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001213
Chris Lattner055097f2010-06-27 06:26:04 +00001214 // If the source and destination are integer or pointer types, just do an
1215 // extension or truncation to the desired type.
1216 if ((isa<llvm::IntegerType>(Ty) || isa<llvm::PointerType>(Ty)) &&
1217 (isa<llvm::IntegerType>(SrcTy) || isa<llvm::PointerType>(SrcTy))) {
John McCall7f416cc2015-09-08 08:05:57 +00001218 llvm::Value *Load = CGF.Builder.CreateLoad(Src);
Chris Lattner055097f2010-06-27 06:26:04 +00001219 return CoerceIntOrPtrToIntOrPtr(Load, Ty, CGF);
1220 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001221
Daniel Dunbarb52d0772009-02-03 05:59:18 +00001222 // If load is legal, just bitcast the src pointer.
Daniel Dunbarffdb8432009-05-13 18:54:26 +00001223 if (SrcSize >= DstSize) {
Mike Stump18bb9282009-05-16 07:57:57 +00001224 // Generally SrcSize is never greater than DstSize, since this means we are
1225 // losing bits. However, this can happen in cases where the structure has
1226 // additional padding, for example due to a user specified alignment.
Daniel Dunbarffdb8432009-05-13 18:54:26 +00001227 //
Mike Stump18bb9282009-05-16 07:57:57 +00001228 // FIXME: Assert that we aren't truncating non-padding bits when have access
1229 // to that information.
Matt Arsenault7a124f32017-08-01 20:36:57 +00001230 Src = CGF.Builder.CreateBitCast(Src,
1231 Ty->getPointerTo(Src.getAddressSpace()));
John McCall7f416cc2015-09-08 08:05:57 +00001232 return CGF.Builder.CreateLoad(Src);
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001233 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001234
John McCall7f416cc2015-09-08 08:05:57 +00001235 // Otherwise do coercion through memory. This is stupid, but simple.
1236 Address Tmp = CreateTempAllocaForCoercion(CGF, Ty, Src.getAlignment());
1237 Address Casted = CGF.Builder.CreateBitCast(Tmp, CGF.Int8PtrTy);
1238 Address SrcCasted = CGF.Builder.CreateBitCast(Src, CGF.Int8PtrTy);
Manman Ren84b921f2012-11-28 22:08:52 +00001239 CGF.Builder.CreateMemCpy(Casted, SrcCasted,
1240 llvm::ConstantInt::get(CGF.IntPtrTy, SrcSize),
John McCall7f416cc2015-09-08 08:05:57 +00001241 false);
1242 return CGF.Builder.CreateLoad(Tmp);
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001243}
1244
Eli Friedmanaf9b3252011-05-17 21:08:01 +00001245// Function to store a first-class aggregate into memory. We prefer to
1246// store the elements rather than the aggregate to be more friendly to
1247// fast-isel.
1248// FIXME: Do we need to recurse here?
1249static void BuildAggStore(CodeGenFunction &CGF, llvm::Value *Val,
John McCall7f416cc2015-09-08 08:05:57 +00001250 Address Dest, bool DestIsVolatile) {
Eli Friedmanaf9b3252011-05-17 21:08:01 +00001251 // Prefer scalar stores to first-class aggregate stores.
Chris Lattner2192fe52011-07-18 04:24:23 +00001252 if (llvm::StructType *STy =
Eli Friedmanaf9b3252011-05-17 21:08:01 +00001253 dyn_cast<llvm::StructType>(Val->getType())) {
Ulrich Weigand6e2cea62015-07-10 11:31:43 +00001254 const llvm::StructLayout *Layout =
1255 CGF.CGM.getDataLayout().getStructLayout(STy);
1256
Eli Friedmanaf9b3252011-05-17 21:08:01 +00001257 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
John McCall7f416cc2015-09-08 08:05:57 +00001258 auto EltOffset = CharUnits::fromQuantity(Layout->getElementOffset(i));
1259 Address EltPtr = CGF.Builder.CreateStructGEP(Dest, i, EltOffset);
Eli Friedmanaf9b3252011-05-17 21:08:01 +00001260 llvm::Value *Elt = CGF.Builder.CreateExtractValue(Val, i);
John McCall7f416cc2015-09-08 08:05:57 +00001261 CGF.Builder.CreateStore(Elt, EltPtr, DestIsVolatile);
Eli Friedmanaf9b3252011-05-17 21:08:01 +00001262 }
1263 } else {
John McCall7f416cc2015-09-08 08:05:57 +00001264 CGF.Builder.CreateStore(Val, Dest, DestIsVolatile);
Eli Friedmanaf9b3252011-05-17 21:08:01 +00001265 }
1266}
1267
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001268/// CreateCoercedStore - Create a store to \arg DstPtr from \arg Src,
Ulrich Weigand6e2cea62015-07-10 11:31:43 +00001269/// where the source and destination may have different types. The
1270/// destination is known to be aligned to \arg DstAlign bytes.
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001271///
1272/// This safely handles the case when the src type is larger than the
1273/// destination type; the upper bits of the src will be lost.
1274static void CreateCoercedStore(llvm::Value *Src,
John McCall7f416cc2015-09-08 08:05:57 +00001275 Address Dst,
Anders Carlsson17490832009-12-24 20:40:36 +00001276 bool DstIsVolatile,
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001277 CodeGenFunction &CGF) {
Chris Lattner2192fe52011-07-18 04:24:23 +00001278 llvm::Type *SrcTy = Src->getType();
John McCall7f416cc2015-09-08 08:05:57 +00001279 llvm::Type *DstTy = Dst.getType()->getElementType();
Chris Lattnerd200eda2010-06-28 22:51:39 +00001280 if (SrcTy == DstTy) {
John McCall7f416cc2015-09-08 08:05:57 +00001281 CGF.Builder.CreateStore(Src, Dst, DstIsVolatile);
Chris Lattnerd200eda2010-06-28 22:51:39 +00001282 return;
1283 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001284
Micah Villmowdd31ca12012-10-08 16:25:52 +00001285 uint64_t SrcSize = CGF.CGM.getDataLayout().getTypeAllocSize(SrcTy);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001286
Chris Lattner2192fe52011-07-18 04:24:23 +00001287 if (llvm::StructType *DstSTy = dyn_cast<llvm::StructType>(DstTy)) {
John McCall7f416cc2015-09-08 08:05:57 +00001288 Dst = EnterStructPointerForCoercedAccess(Dst, DstSTy, SrcSize, CGF);
1289 DstTy = Dst.getType()->getElementType();
Chris Lattner895c52b2010-06-27 06:04:18 +00001290 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001291
Chris Lattner055097f2010-06-27 06:26:04 +00001292 // If the source and destination are integer or pointer types, just do an
1293 // extension or truncation to the desired type.
1294 if ((isa<llvm::IntegerType>(SrcTy) || isa<llvm::PointerType>(SrcTy)) &&
1295 (isa<llvm::IntegerType>(DstTy) || isa<llvm::PointerType>(DstTy))) {
1296 Src = CoerceIntOrPtrToIntOrPtr(Src, DstTy, CGF);
John McCall7f416cc2015-09-08 08:05:57 +00001297 CGF.Builder.CreateStore(Src, Dst, DstIsVolatile);
Chris Lattner055097f2010-06-27 06:26:04 +00001298 return;
1299 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001300
Micah Villmowdd31ca12012-10-08 16:25:52 +00001301 uint64_t DstSize = CGF.CGM.getDataLayout().getTypeAllocSize(DstTy);
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001302
Daniel Dunbar313321e2009-02-03 05:31:23 +00001303 // If store is legal, just bitcast the src pointer.
Daniel Dunbar4be99ff2009-06-05 07:58:54 +00001304 if (SrcSize <= DstSize) {
Yaxun Liue9e5c4f2017-06-29 18:47:45 +00001305 Dst = CGF.Builder.CreateElementBitCast(Dst, SrcTy);
John McCall7f416cc2015-09-08 08:05:57 +00001306 BuildAggStore(CGF, Src, Dst, DstIsVolatile);
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001307 } else {
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001308 // Otherwise do coercion through memory. This is stupid, but
1309 // simple.
Daniel Dunbar4be99ff2009-06-05 07:58:54 +00001310
1311 // Generally SrcSize is never greater than DstSize, since this means we are
1312 // losing bits. However, this can happen in cases where the structure has
1313 // additional padding, for example due to a user specified alignment.
1314 //
1315 // FIXME: Assert that we aren't truncating non-padding bits when have access
1316 // to that information.
John McCall7f416cc2015-09-08 08:05:57 +00001317 Address Tmp = CreateTempAllocaForCoercion(CGF, SrcTy, Dst.getAlignment());
1318 CGF.Builder.CreateStore(Src, Tmp);
1319 Address Casted = CGF.Builder.CreateBitCast(Tmp, CGF.Int8PtrTy);
1320 Address DstCasted = CGF.Builder.CreateBitCast(Dst, CGF.Int8PtrTy);
Manman Ren84b921f2012-11-28 22:08:52 +00001321 CGF.Builder.CreateMemCpy(DstCasted, Casted,
1322 llvm::ConstantInt::get(CGF.IntPtrTy, DstSize),
John McCall7f416cc2015-09-08 08:05:57 +00001323 false);
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001324 }
1325}
1326
John McCall7f416cc2015-09-08 08:05:57 +00001327static Address emitAddressAtOffset(CodeGenFunction &CGF, Address addr,
1328 const ABIArgInfo &info) {
1329 if (unsigned offset = info.getDirectOffset()) {
1330 addr = CGF.Builder.CreateElementBitCast(addr, CGF.Int8Ty);
1331 addr = CGF.Builder.CreateConstInBoundsByteGEP(addr,
1332 CharUnits::fromQuantity(offset));
1333 addr = CGF.Builder.CreateElementBitCast(addr, info.getCoerceToType());
1334 }
1335 return addr;
1336}
1337
Alexey Samsonov153004f2014-09-29 22:08:00 +00001338namespace {
1339
1340/// Encapsulates information about the way function arguments from
1341/// CGFunctionInfo should be passed to actual LLVM IR function.
1342class ClangToLLVMArgMapping {
1343 static const unsigned InvalidIndex = ~0U;
1344 unsigned InallocaArgNo;
1345 unsigned SRetArgNo;
1346 unsigned TotalIRArgs;
1347
1348 /// Arguments of LLVM IR function corresponding to single Clang argument.
1349 struct IRArgs {
1350 unsigned PaddingArgIndex;
1351 // Argument is expanded to IR arguments at positions
1352 // [FirstArgIndex, FirstArgIndex + NumberOfArgs).
1353 unsigned FirstArgIndex;
1354 unsigned NumberOfArgs;
1355
1356 IRArgs()
1357 : PaddingArgIndex(InvalidIndex), FirstArgIndex(InvalidIndex),
1358 NumberOfArgs(0) {}
1359 };
1360
1361 SmallVector<IRArgs, 8> ArgInfo;
1362
1363public:
1364 ClangToLLVMArgMapping(const ASTContext &Context, const CGFunctionInfo &FI,
1365 bool OnlyRequiredArgs = false)
1366 : InallocaArgNo(InvalidIndex), SRetArgNo(InvalidIndex), TotalIRArgs(0),
1367 ArgInfo(OnlyRequiredArgs ? FI.getNumRequiredArgs() : FI.arg_size()) {
1368 construct(Context, FI, OnlyRequiredArgs);
1369 }
1370
1371 bool hasInallocaArg() const { return InallocaArgNo != InvalidIndex; }
1372 unsigned getInallocaArgNo() const {
1373 assert(hasInallocaArg());
1374 return InallocaArgNo;
1375 }
1376
1377 bool hasSRetArg() const { return SRetArgNo != InvalidIndex; }
1378 unsigned getSRetArgNo() const {
1379 assert(hasSRetArg());
1380 return SRetArgNo;
1381 }
1382
1383 unsigned totalIRArgs() const { return TotalIRArgs; }
1384
1385 bool hasPaddingArg(unsigned ArgNo) const {
1386 assert(ArgNo < ArgInfo.size());
1387 return ArgInfo[ArgNo].PaddingArgIndex != InvalidIndex;
1388 }
1389 unsigned getPaddingArgNo(unsigned ArgNo) const {
1390 assert(hasPaddingArg(ArgNo));
1391 return ArgInfo[ArgNo].PaddingArgIndex;
1392 }
1393
1394 /// Returns index of first IR argument corresponding to ArgNo, and their
1395 /// quantity.
1396 std::pair<unsigned, unsigned> getIRArgs(unsigned ArgNo) const {
1397 assert(ArgNo < ArgInfo.size());
1398 return std::make_pair(ArgInfo[ArgNo].FirstArgIndex,
1399 ArgInfo[ArgNo].NumberOfArgs);
1400 }
1401
1402private:
1403 void construct(const ASTContext &Context, const CGFunctionInfo &FI,
1404 bool OnlyRequiredArgs);
1405};
1406
1407void ClangToLLVMArgMapping::construct(const ASTContext &Context,
1408 const CGFunctionInfo &FI,
1409 bool OnlyRequiredArgs) {
1410 unsigned IRArgNo = 0;
1411 bool SwapThisWithSRet = false;
1412 const ABIArgInfo &RetAI = FI.getReturnInfo();
1413
1414 if (RetAI.getKind() == ABIArgInfo::Indirect) {
1415 SwapThisWithSRet = RetAI.isSRetAfterThis();
1416 SRetArgNo = SwapThisWithSRet ? 1 : IRArgNo++;
1417 }
1418
1419 unsigned ArgNo = 0;
1420 unsigned NumArgs = OnlyRequiredArgs ? FI.getNumRequiredArgs() : FI.arg_size();
1421 for (CGFunctionInfo::const_arg_iterator I = FI.arg_begin(); ArgNo < NumArgs;
1422 ++I, ++ArgNo) {
1423 assert(I != FI.arg_end());
1424 QualType ArgType = I->type;
1425 const ABIArgInfo &AI = I->info;
1426 // Collect data about IR arguments corresponding to Clang argument ArgNo.
1427 auto &IRArgs = ArgInfo[ArgNo];
1428
1429 if (AI.getPaddingType())
1430 IRArgs.PaddingArgIndex = IRArgNo++;
1431
1432 switch (AI.getKind()) {
1433 case ABIArgInfo::Extend:
1434 case ABIArgInfo::Direct: {
1435 // FIXME: handle sseregparm someday...
1436 llvm::StructType *STy = dyn_cast<llvm::StructType>(AI.getCoerceToType());
1437 if (AI.isDirect() && AI.getCanBeFlattened() && STy) {
1438 IRArgs.NumberOfArgs = STy->getNumElements();
1439 } else {
1440 IRArgs.NumberOfArgs = 1;
1441 }
1442 break;
1443 }
1444 case ABIArgInfo::Indirect:
1445 IRArgs.NumberOfArgs = 1;
1446 break;
1447 case ABIArgInfo::Ignore:
1448 case ABIArgInfo::InAlloca:
1449 // ignore and inalloca doesn't have matching LLVM parameters.
1450 IRArgs.NumberOfArgs = 0;
1451 break;
John McCallf26e73d2016-03-11 04:30:43 +00001452 case ABIArgInfo::CoerceAndExpand:
1453 IRArgs.NumberOfArgs = AI.getCoerceAndExpandTypeSequence().size();
1454 break;
1455 case ABIArgInfo::Expand:
Alexey Samsonov153004f2014-09-29 22:08:00 +00001456 IRArgs.NumberOfArgs = getExpansionSize(ArgType, Context);
1457 break;
1458 }
Alexey Samsonov153004f2014-09-29 22:08:00 +00001459
1460 if (IRArgs.NumberOfArgs > 0) {
1461 IRArgs.FirstArgIndex = IRArgNo;
1462 IRArgNo += IRArgs.NumberOfArgs;
1463 }
1464
1465 // Skip over the sret parameter when it comes second. We already handled it
1466 // above.
1467 if (IRArgNo == 1 && SwapThisWithSRet)
1468 IRArgNo++;
1469 }
1470 assert(ArgNo == ArgInfo.size());
1471
1472 if (FI.usesInAlloca())
1473 InallocaArgNo = IRArgNo++;
1474
1475 TotalIRArgs = IRArgNo;
1476}
1477} // namespace
1478
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00001479/***/
1480
Daniel Dunbar6f2e8392010-07-14 23:39:36 +00001481bool CodeGenModule::ReturnTypeUsesSRet(const CGFunctionInfo &FI) {
Daniel Dunbarb8b1c672009-02-05 08:00:50 +00001482 return FI.getReturnInfo().isIndirect();
Daniel Dunbar7633cbf2009-02-02 21:43:58 +00001483}
1484
Tim Northovere77cc392014-03-29 13:28:05 +00001485bool CodeGenModule::ReturnSlotInterferesWithArgs(const CGFunctionInfo &FI) {
1486 return ReturnTypeUsesSRet(FI) &&
1487 getTargetCodeGenInfo().doesReturnSlotInterfereWithArgs();
1488}
1489
Daniel Dunbar6f2e8392010-07-14 23:39:36 +00001490bool CodeGenModule::ReturnTypeUsesFPRet(QualType ResultType) {
1491 if (const BuiltinType *BT = ResultType->getAs<BuiltinType>()) {
1492 switch (BT->getKind()) {
1493 default:
1494 return false;
1495 case BuiltinType::Float:
John McCallc8e01702013-04-16 22:48:15 +00001496 return getTarget().useObjCFPRetForRealType(TargetInfo::Float);
Daniel Dunbar6f2e8392010-07-14 23:39:36 +00001497 case BuiltinType::Double:
John McCallc8e01702013-04-16 22:48:15 +00001498 return getTarget().useObjCFPRetForRealType(TargetInfo::Double);
Daniel Dunbar6f2e8392010-07-14 23:39:36 +00001499 case BuiltinType::LongDouble:
John McCallc8e01702013-04-16 22:48:15 +00001500 return getTarget().useObjCFPRetForRealType(TargetInfo::LongDouble);
Daniel Dunbar6f2e8392010-07-14 23:39:36 +00001501 }
1502 }
1503
1504 return false;
1505}
1506
Anders Carlsson2f1a6c32011-10-31 16:27:11 +00001507bool CodeGenModule::ReturnTypeUsesFP2Ret(QualType ResultType) {
1508 if (const ComplexType *CT = ResultType->getAs<ComplexType>()) {
1509 if (const BuiltinType *BT = CT->getElementType()->getAs<BuiltinType>()) {
1510 if (BT->getKind() == BuiltinType::LongDouble)
John McCallc8e01702013-04-16 22:48:15 +00001511 return getTarget().useObjCFP2RetForComplexLongDouble();
Anders Carlsson2f1a6c32011-10-31 16:27:11 +00001512 }
1513 }
1514
1515 return false;
1516}
1517
Chris Lattnera5f58b02011-07-09 17:41:47 +00001518llvm::FunctionType *CodeGenTypes::GetFunctionType(GlobalDecl GD) {
John McCalla729c622012-02-17 03:33:10 +00001519 const CGFunctionInfo &FI = arrangeGlobalDeclaration(GD);
1520 return GetFunctionType(FI);
John McCallf8ff7b92010-02-23 00:48:20 +00001521}
1522
Chris Lattnera5f58b02011-07-09 17:41:47 +00001523llvm::FunctionType *
John McCalla729c622012-02-17 03:33:10 +00001524CodeGenTypes::GetFunctionType(const CGFunctionInfo &FI) {
Alexey Samsonov153004f2014-09-29 22:08:00 +00001525
David Blaikie82e95a32014-11-19 07:49:47 +00001526 bool Inserted = FunctionsBeingProcessed.insert(&FI).second;
1527 (void)Inserted;
Chris Lattner6fb0ccf2011-07-15 05:16:14 +00001528 assert(Inserted && "Recursively being processed?");
Daniel Dunbar7a95ca32008-09-10 04:01:49 +00001529
Alexey Samsonov153004f2014-09-29 22:08:00 +00001530 llvm::Type *resultType = nullptr;
John McCall85dd2c52011-05-15 02:19:42 +00001531 const ABIArgInfo &retAI = FI.getReturnInfo();
1532 switch (retAI.getKind()) {
Daniel Dunbard3674e62008-09-11 01:48:57 +00001533 case ABIArgInfo::Expand:
John McCall85dd2c52011-05-15 02:19:42 +00001534 llvm_unreachable("Invalid ABI kind for return argument");
Daniel Dunbard3674e62008-09-11 01:48:57 +00001535
Anton Korobeynikov18adbf52009-06-06 09:36:29 +00001536 case ABIArgInfo::Extend:
Daniel Dunbar67dace892009-02-03 06:17:37 +00001537 case ABIArgInfo::Direct:
John McCall85dd2c52011-05-15 02:19:42 +00001538 resultType = retAI.getCoerceToType();
Daniel Dunbar67dace892009-02-03 06:17:37 +00001539 break;
1540
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001541 case ABIArgInfo::InAlloca:
Reid Klecknerfab1e892014-02-25 00:59:14 +00001542 if (retAI.getInAllocaSRet()) {
1543 // sret things on win32 aren't void, they return the sret pointer.
1544 QualType ret = FI.getReturnType();
1545 llvm::Type *ty = ConvertType(ret);
1546 unsigned addressSpace = Context.getTargetAddressSpace(ret);
1547 resultType = llvm::PointerType::get(ty, addressSpace);
1548 } else {
1549 resultType = llvm::Type::getVoidTy(getLLVMContext());
1550 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001551 break;
1552
John McCall7f416cc2015-09-08 08:05:57 +00001553 case ABIArgInfo::Indirect:
Daniel Dunbar94a6f252009-01-26 21:26:08 +00001554 case ABIArgInfo::Ignore:
John McCall85dd2c52011-05-15 02:19:42 +00001555 resultType = llvm::Type::getVoidTy(getLLVMContext());
Daniel Dunbar94a6f252009-01-26 21:26:08 +00001556 break;
John McCallf26e73d2016-03-11 04:30:43 +00001557
1558 case ABIArgInfo::CoerceAndExpand:
1559 resultType = retAI.getUnpaddedCoerceAndExpandType();
1560 break;
Daniel Dunbar7a95ca32008-09-10 04:01:49 +00001561 }
Mike Stump11289f42009-09-09 15:08:12 +00001562
Alexey Samsonov153004f2014-09-29 22:08:00 +00001563 ClangToLLVMArgMapping IRFunctionArgs(getContext(), FI, true);
1564 SmallVector<llvm::Type*, 8> ArgTypes(IRFunctionArgs.totalIRArgs());
1565
1566 // Add type for sret argument.
1567 if (IRFunctionArgs.hasSRetArg()) {
1568 QualType Ret = FI.getReturnType();
1569 llvm::Type *Ty = ConvertType(Ret);
1570 unsigned AddressSpace = Context.getTargetAddressSpace(Ret);
1571 ArgTypes[IRFunctionArgs.getSRetArgNo()] =
1572 llvm::PointerType::get(Ty, AddressSpace);
1573 }
1574
1575 // Add type for inalloca argument.
1576 if (IRFunctionArgs.hasInallocaArg()) {
1577 auto ArgStruct = FI.getArgStruct();
1578 assert(ArgStruct);
1579 ArgTypes[IRFunctionArgs.getInallocaArgNo()] = ArgStruct->getPointerTo();
1580 }
1581
John McCallc818bbb2012-12-07 07:03:17 +00001582 // Add in all of the required arguments.
Alexey Samsonov153004f2014-09-29 22:08:00 +00001583 unsigned ArgNo = 0;
Alexey Samsonov34625dd2014-09-29 21:21:48 +00001584 CGFunctionInfo::const_arg_iterator it = FI.arg_begin(),
1585 ie = it + FI.getNumRequiredArgs();
Alexey Samsonov153004f2014-09-29 22:08:00 +00001586 for (; it != ie; ++it, ++ArgNo) {
1587 const ABIArgInfo &ArgInfo = it->info;
Mike Stump11289f42009-09-09 15:08:12 +00001588
Rafael Espindolafad28de2012-10-24 01:59:00 +00001589 // Insert a padding type to ensure proper alignment.
Alexey Samsonov153004f2014-09-29 22:08:00 +00001590 if (IRFunctionArgs.hasPaddingArg(ArgNo))
1591 ArgTypes[IRFunctionArgs.getPaddingArgNo(ArgNo)] =
1592 ArgInfo.getPaddingType();
Rafael Espindolafad28de2012-10-24 01:59:00 +00001593
Alexey Samsonov153004f2014-09-29 22:08:00 +00001594 unsigned FirstIRArg, NumIRArgs;
1595 std::tie(FirstIRArg, NumIRArgs) = IRFunctionArgs.getIRArgs(ArgNo);
1596
1597 switch (ArgInfo.getKind()) {
Daniel Dunbar94a6f252009-01-26 21:26:08 +00001598 case ABIArgInfo::Ignore:
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001599 case ABIArgInfo::InAlloca:
Alexey Samsonov153004f2014-09-29 22:08:00 +00001600 assert(NumIRArgs == 0);
Daniel Dunbar94a6f252009-01-26 21:26:08 +00001601 break;
1602
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00001603 case ABIArgInfo::Indirect: {
Alexey Samsonov153004f2014-09-29 22:08:00 +00001604 assert(NumIRArgs == 1);
Yaxun Liud7523282017-04-17 20:10:44 +00001605 // indirect arguments are always on the stack, which is alloca addr space.
Chris Lattner2192fe52011-07-18 04:24:23 +00001606 llvm::Type *LTy = ConvertTypeForMem(it->type);
Yaxun Liud7523282017-04-17 20:10:44 +00001607 ArgTypes[FirstIRArg] = LTy->getPointerTo(
1608 CGM.getDataLayout().getAllocaAddrSpace());
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00001609 break;
1610 }
1611
1612 case ABIArgInfo::Extend:
Chris Lattner2cdfda42010-07-29 06:44:09 +00001613 case ABIArgInfo::Direct: {
Oliver Stannard2bfdc5b2014-08-27 10:43:15 +00001614 // Fast-isel and the optimizer generally like scalar values better than
1615 // FCAs, so we flatten them if this is safe to do for this argument.
Alexey Samsonov153004f2014-09-29 22:08:00 +00001616 llvm::Type *argType = ArgInfo.getCoerceToType();
James Molloy6f244b62014-05-09 16:21:39 +00001617 llvm::StructType *st = dyn_cast<llvm::StructType>(argType);
Alexey Samsonov153004f2014-09-29 22:08:00 +00001618 if (st && ArgInfo.isDirect() && ArgInfo.getCanBeFlattened()) {
1619 assert(NumIRArgs == st->getNumElements());
John McCall85dd2c52011-05-15 02:19:42 +00001620 for (unsigned i = 0, e = st->getNumElements(); i != e; ++i)
Alexey Samsonov153004f2014-09-29 22:08:00 +00001621 ArgTypes[FirstIRArg + i] = st->getElementType(i);
Chris Lattner3dd716c2010-06-28 23:44:11 +00001622 } else {
Alexey Samsonov153004f2014-09-29 22:08:00 +00001623 assert(NumIRArgs == 1);
1624 ArgTypes[FirstIRArg] = argType;
Chris Lattner3dd716c2010-06-28 23:44:11 +00001625 }
Daniel Dunbar2f219b02009-02-03 19:12:28 +00001626 break;
Chris Lattner2cdfda42010-07-29 06:44:09 +00001627 }
Mike Stump11289f42009-09-09 15:08:12 +00001628
John McCallf26e73d2016-03-11 04:30:43 +00001629 case ABIArgInfo::CoerceAndExpand: {
1630 auto ArgTypesIter = ArgTypes.begin() + FirstIRArg;
1631 for (auto EltTy : ArgInfo.getCoerceAndExpandTypeSequence()) {
1632 *ArgTypesIter++ = EltTy;
1633 }
1634 assert(ArgTypesIter == ArgTypes.begin() + FirstIRArg + NumIRArgs);
1635 break;
1636 }
1637
Daniel Dunbard3674e62008-09-11 01:48:57 +00001638 case ABIArgInfo::Expand:
Alexey Samsonov153004f2014-09-29 22:08:00 +00001639 auto ArgTypesIter = ArgTypes.begin() + FirstIRArg;
1640 getExpandedTypes(it->type, ArgTypesIter);
1641 assert(ArgTypesIter == ArgTypes.begin() + FirstIRArg + NumIRArgs);
Daniel Dunbard3674e62008-09-11 01:48:57 +00001642 break;
1643 }
Daniel Dunbar7a95ca32008-09-10 04:01:49 +00001644 }
1645
Chris Lattner6fb0ccf2011-07-15 05:16:14 +00001646 bool Erased = FunctionsBeingProcessed.erase(&FI); (void)Erased;
1647 assert(Erased && "Not in set?");
Alexey Samsonov153004f2014-09-29 22:08:00 +00001648
1649 return llvm::FunctionType::get(resultType, ArgTypes, FI.isVariadic());
Daniel Dunbar81cf67f2008-09-09 23:48:28 +00001650}
1651
Chris Lattner2192fe52011-07-18 04:24:23 +00001652llvm::Type *CodeGenTypes::GetFunctionTypeForVTable(GlobalDecl GD) {
John McCall5d865c322010-08-31 07:33:07 +00001653 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
Anders Carlsson64457732009-11-24 05:08:52 +00001654 const FunctionProtoType *FPT = MD->getType()->getAs<FunctionProtoType>();
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001655
Chris Lattner8806e322011-07-10 00:18:59 +00001656 if (!isFuncTypeConvertible(FPT))
1657 return llvm::StructType::get(getLLVMContext());
1658
1659 const CGFunctionInfo *Info;
1660 if (isa<CXXDestructorDecl>(MD))
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001661 Info =
1662 &arrangeCXXStructorDeclaration(MD, getFromDtorType(GD.getDtorType()));
Chris Lattner8806e322011-07-10 00:18:59 +00001663 else
John McCalla729c622012-02-17 03:33:10 +00001664 Info = &arrangeCXXMethodDeclaration(MD);
1665 return GetFunctionType(*Info);
Anders Carlsson64457732009-11-24 05:08:52 +00001666}
1667
Samuel Antao798f11c2015-11-23 22:04:44 +00001668static void AddAttributesFromFunctionProtoType(ASTContext &Ctx,
1669 llvm::AttrBuilder &FuncAttrs,
1670 const FunctionProtoType *FPT) {
1671 if (!FPT)
1672 return;
1673
1674 if (!isUnresolvedExceptionSpec(FPT->getExceptionSpecType()) &&
1675 FPT->isNothrow(Ctx))
1676 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
1677}
1678
Justin Lebarb080b632017-01-25 21:29:48 +00001679void CodeGenModule::ConstructDefaultFnAttrList(StringRef Name, bool HasOptnone,
1680 bool AttrOnCallSite,
1681 llvm::AttrBuilder &FuncAttrs) {
1682 // OptimizeNoneAttr takes precedence over -Os or -Oz. No warning needed.
1683 if (!HasOptnone) {
1684 if (CodeGenOpts.OptimizeSize)
1685 FuncAttrs.addAttribute(llvm::Attribute::OptimizeForSize);
1686 if (CodeGenOpts.OptimizeSize == 2)
1687 FuncAttrs.addAttribute(llvm::Attribute::MinSize);
1688 }
1689
1690 if (CodeGenOpts.DisableRedZone)
1691 FuncAttrs.addAttribute(llvm::Attribute::NoRedZone);
1692 if (CodeGenOpts.NoImplicitFloat)
1693 FuncAttrs.addAttribute(llvm::Attribute::NoImplicitFloat);
1694
1695 if (AttrOnCallSite) {
1696 // Attributes that should go on the call site only.
1697 if (!CodeGenOpts.SimplifyLibCalls ||
1698 CodeGenOpts.isNoBuiltinFunc(Name.data()))
1699 FuncAttrs.addAttribute(llvm::Attribute::NoBuiltin);
1700 if (!CodeGenOpts.TrapFuncName.empty())
1701 FuncAttrs.addAttribute("trap-func-name", CodeGenOpts.TrapFuncName);
1702 } else {
1703 // Attributes that should go on the function, but not the call site.
1704 if (!CodeGenOpts.DisableFPElim) {
1705 FuncAttrs.addAttribute("no-frame-pointer-elim", "false");
1706 } else if (CodeGenOpts.OmitLeafFramePointer) {
1707 FuncAttrs.addAttribute("no-frame-pointer-elim", "false");
1708 FuncAttrs.addAttribute("no-frame-pointer-elim-non-leaf");
1709 } else {
1710 FuncAttrs.addAttribute("no-frame-pointer-elim", "true");
1711 FuncAttrs.addAttribute("no-frame-pointer-elim-non-leaf");
1712 }
1713
1714 FuncAttrs.addAttribute("less-precise-fpmad",
1715 llvm::toStringRef(CodeGenOpts.LessPreciseFPMAD));
1716
1717 if (!CodeGenOpts.FPDenormalMode.empty())
1718 FuncAttrs.addAttribute("denormal-fp-math", CodeGenOpts.FPDenormalMode);
1719
1720 FuncAttrs.addAttribute("no-trapping-math",
1721 llvm::toStringRef(CodeGenOpts.NoTrappingMath));
1722
1723 // TODO: Are these all needed?
1724 // unsafe/inf/nan/nsz are handled by instruction-level FastMathFlags.
1725 FuncAttrs.addAttribute("no-infs-fp-math",
1726 llvm::toStringRef(CodeGenOpts.NoInfsFPMath));
1727 FuncAttrs.addAttribute("no-nans-fp-math",
1728 llvm::toStringRef(CodeGenOpts.NoNaNsFPMath));
1729 FuncAttrs.addAttribute("unsafe-fp-math",
1730 llvm::toStringRef(CodeGenOpts.UnsafeFPMath));
1731 FuncAttrs.addAttribute("use-soft-float",
1732 llvm::toStringRef(CodeGenOpts.SoftFloat));
1733 FuncAttrs.addAttribute("stack-protector-buffer-size",
1734 llvm::utostr(CodeGenOpts.SSPBufferSize));
1735 FuncAttrs.addAttribute("no-signed-zeros-fp-math",
1736 llvm::toStringRef(CodeGenOpts.NoSignedZeros));
1737 FuncAttrs.addAttribute(
1738 "correctly-rounded-divide-sqrt-fp-math",
1739 llvm::toStringRef(CodeGenOpts.CorrectlyRoundedDivSqrt));
1740
1741 // TODO: Reciprocal estimate codegen options should apply to instructions?
1742 std::vector<std::string> &Recips = getTarget().getTargetOpts().Reciprocals;
1743 if (!Recips.empty())
1744 FuncAttrs.addAttribute("reciprocal-estimates",
1745 llvm::join(Recips.begin(), Recips.end(), ","));
1746
1747 if (CodeGenOpts.StackRealignment)
1748 FuncAttrs.addAttribute("stackrealign");
1749 if (CodeGenOpts.Backchain)
1750 FuncAttrs.addAttribute("backchain");
1751 }
1752
Matt Arsenaulta1cf61b2017-10-06 19:34:40 +00001753 if (getLangOpts().assumeFunctionsAreConvergent()) {
1754 // Conservatively, mark all functions and calls in CUDA and OpenCL as
1755 // convergent (meaning, they may call an intrinsically convergent op, such
1756 // as __syncthreads() / barrier(), and so can't have certain optimizations
1757 // applied around them). LLVM will remove this attribute where it safely
1758 // can.
Justin Lebarb080b632017-01-25 21:29:48 +00001759 FuncAttrs.addAttribute(llvm::Attribute::Convergent);
Matt Arsenaulta1cf61b2017-10-06 19:34:40 +00001760 }
Justin Lebarb080b632017-01-25 21:29:48 +00001761
Matt Arsenaulta1cf61b2017-10-06 19:34:40 +00001762 if (getLangOpts().CUDA && getLangOpts().CUDAIsDevice) {
Justin Lebarb080b632017-01-25 21:29:48 +00001763 // Exceptions aren't supported in CUDA device code.
1764 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
1765
1766 // Respect -fcuda-flush-denormals-to-zero.
1767 if (getLangOpts().CUDADeviceFlushDenormalsToZero)
1768 FuncAttrs.addAttribute("nvptx-f32ftz", "true");
1769 }
1770}
1771
1772void CodeGenModule::AddDefaultFnAttrs(llvm::Function &F) {
1773 llvm::AttrBuilder FuncAttrs;
1774 ConstructDefaultFnAttrList(F.getName(),
1775 F.hasFnAttribute(llvm::Attribute::OptimizeNone),
1776 /* AttrOnCallsite = */ false, FuncAttrs);
Reid Kleckneree4930b2017-05-02 22:07:37 +00001777 F.addAttributes(llvm::AttributeList::FunctionIndex, FuncAttrs);
Justin Lebarb080b632017-01-25 21:29:48 +00001778}
1779
Chad Rosier7dbc9cf2016-01-06 14:35:46 +00001780void CodeGenModule::ConstructAttributeList(
1781 StringRef Name, const CGFunctionInfo &FI, CGCalleeInfo CalleeInfo,
Reid Klecknercdd26792017-04-18 23:50:03 +00001782 llvm::AttributeList &AttrList, unsigned &CallingConv, bool AttrOnCallSite) {
Bill Wendlinga514ebc2012-10-15 20:36:26 +00001783 llvm::AttrBuilder FuncAttrs;
1784 llvm::AttrBuilder RetAttrs;
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00001785
Daniel Dunbar0ef34792009-09-12 00:59:20 +00001786 CallingConv = FI.getEffectiveCallingConvention();
John McCallab26cfa2010-02-05 21:31:56 +00001787 if (FI.isNoReturn())
Bill Wendling207f0532012-12-20 19:27:06 +00001788 FuncAttrs.addAttribute(llvm::Attribute::NoReturn);
John McCallab26cfa2010-02-05 21:31:56 +00001789
Samuel Antao798f11c2015-11-23 22:04:44 +00001790 // If we have information about the function prototype, we can learn
1791 // attributes form there.
1792 AddAttributesFromFunctionProtoType(getContext(), FuncAttrs,
1793 CalleeInfo.getCalleeFunctionProtoType());
1794
1795 const Decl *TargetDecl = CalleeInfo.getCalleeDecl();
1796
Justin Lebarb080b632017-01-25 21:29:48 +00001797 bool HasOptnone = false;
Anton Korobeynikovc8478242009-04-04 00:49:24 +00001798 // FIXME: handle sseregparm someday...
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00001799 if (TargetDecl) {
Rafael Espindola2d21ab02011-10-12 19:51:18 +00001800 if (TargetDecl->hasAttr<ReturnsTwiceAttr>())
Bill Wendling207f0532012-12-20 19:27:06 +00001801 FuncAttrs.addAttribute(llvm::Attribute::ReturnsTwice);
Argyrios Kyrtzidisb4b64ca2009-06-30 02:34:44 +00001802 if (TargetDecl->hasAttr<NoThrowAttr>())
Bill Wendling207f0532012-12-20 19:27:06 +00001803 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
Richard Smithdebc59d2013-01-30 05:45:05 +00001804 if (TargetDecl->hasAttr<NoReturnAttr>())
1805 FuncAttrs.addAttribute(llvm::Attribute::NoReturn);
Xinliang David Li4ec36062017-06-13 21:14:07 +00001806 if (TargetDecl->hasAttr<ColdAttr>())
1807 FuncAttrs.addAttribute(llvm::Attribute::Cold);
Aaron Ballman7c19ab12014-02-22 16:59:24 +00001808 if (TargetDecl->hasAttr<NoDuplicateAttr>())
1809 FuncAttrs.addAttribute(llvm::Attribute::NoDuplicate);
Yaxun Liu7d07ae72016-11-01 18:45:32 +00001810 if (TargetDecl->hasAttr<ConvergentAttr>())
1811 FuncAttrs.addAttribute(llvm::Attribute::Convergent);
Richard Smithdebc59d2013-01-30 05:45:05 +00001812
Chandler Carruth45bbe012017-03-24 09:11:57 +00001813 if (const FunctionDecl *Fn = dyn_cast<FunctionDecl>(TargetDecl)) {
Samuel Antao798f11c2015-11-23 22:04:44 +00001814 AddAttributesFromFunctionProtoType(
Chandler Carruth45bbe012017-03-24 09:11:57 +00001815 getContext(), FuncAttrs, Fn->getType()->getAs<FunctionProtoType>());
Richard Smith49af6292013-03-05 08:30:04 +00001816 // Don't use [[noreturn]] or _Noreturn for a call to a virtual function.
1817 // These attributes are not inherited by overloads.
Chandler Carruth45bbe012017-03-24 09:11:57 +00001818 const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(Fn);
1819 if (Fn->isNoReturn() && !(AttrOnCallSite && MD && MD->isVirtual()))
Richard Smithdebc59d2013-01-30 05:45:05 +00001820 FuncAttrs.addAttribute(llvm::Attribute::NoReturn);
John McCallbe349de2010-07-08 06:48:12 +00001821 }
1822
David Majnemer1bf0f8e2015-07-20 22:51:52 +00001823 // 'const', 'pure' and 'noalias' attributed functions are also nounwind.
Eric Christopherbf005ec2011-08-15 22:38:22 +00001824 if (TargetDecl->hasAttr<ConstAttr>()) {
Bill Wendling207f0532012-12-20 19:27:06 +00001825 FuncAttrs.addAttribute(llvm::Attribute::ReadNone);
1826 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
Eric Christopherbf005ec2011-08-15 22:38:22 +00001827 } else if (TargetDecl->hasAttr<PureAttr>()) {
Bill Wendling207f0532012-12-20 19:27:06 +00001828 FuncAttrs.addAttribute(llvm::Attribute::ReadOnly);
1829 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
David Majnemer1bf0f8e2015-07-20 22:51:52 +00001830 } else if (TargetDecl->hasAttr<NoAliasAttr>()) {
1831 FuncAttrs.addAttribute(llvm::Attribute::ArgMemOnly);
1832 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
Eric Christopherbf005ec2011-08-15 22:38:22 +00001833 }
David Majnemer631a90b2015-02-04 07:23:21 +00001834 if (TargetDecl->hasAttr<RestrictAttr>())
Bill Wendling207f0532012-12-20 19:27:06 +00001835 RetAttrs.addAttribute(llvm::Attribute::NoAlias);
Chandler Carruth45bbe012017-03-24 09:11:57 +00001836 if (TargetDecl->hasAttr<ReturnsNonNullAttr>())
Hal Finkeld8442b12014-07-12 04:51:04 +00001837 RetAttrs.addAttribute(llvm::Attribute::NonNull);
Oren Ben Simhon318a6ea2017-04-27 12:01:00 +00001838 if (TargetDecl->hasAttr<AnyX86NoCallerSavedRegistersAttr>())
1839 FuncAttrs.addAttribute("no_caller_saved_registers");
Paul Robinson08556952014-12-11 20:14:04 +00001840
1841 HasOptnone = TargetDecl->hasAttr<OptimizeNoneAttr>();
George Burgess IVe3763372016-12-22 02:50:20 +00001842 if (auto *AllocSize = TargetDecl->getAttr<AllocSizeAttr>()) {
1843 Optional<unsigned> NumElemsParam;
1844 // alloc_size args are base-1, 0 means not present.
1845 if (unsigned N = AllocSize->getNumElemsParam())
1846 NumElemsParam = N - 1;
1847 FuncAttrs.addAllocSizeAttr(AllocSize->getElemSizeParam() - 1,
1848 NumElemsParam);
1849 }
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00001850 }
1851
Justin Lebarb080b632017-01-25 21:29:48 +00001852 ConstructDefaultFnAttrList(Name, HasOptnone, AttrOnCallSite, FuncAttrs);
Paul Robinson08556952014-12-11 20:14:04 +00001853
Peter Collingbourneb4728c12014-05-19 22:14:34 +00001854 if (CodeGenOpts.EnableSegmentedStacks &&
1855 !(TargetDecl && TargetDecl->hasAttr<NoSplitStackAttr>()))
Reid Klecknerfb873af2014-04-10 22:59:13 +00001856 FuncAttrs.addAttribute("split-stack");
Devang Patel6e467b12009-06-04 23:32:02 +00001857
Justin Lebarb080b632017-01-25 21:29:48 +00001858 if (!AttrOnCallSite) {
Akira Hatanaka7828b1e2015-11-13 00:42:21 +00001859 bool DisableTailCalls =
Justin Lebarb080b632017-01-25 21:29:48 +00001860 CodeGenOpts.DisableTailCalls ||
1861 (TargetDecl && (TargetDecl->hasAttr<DisableTailCallsAttr>() ||
1862 TargetDecl->hasAttr<AnyX86InterruptAttr>()));
1863 FuncAttrs.addAttribute("disable-tail-calls",
1864 llvm::toStringRef(DisableTailCalls));
Eric Christopher70c16652015-03-25 23:14:47 +00001865
Eric Christopher11acf732015-06-12 01:35:52 +00001866 // Add target-cpu and target-features attributes to functions. If
1867 // we have a decl for the function and it has a target attribute then
1868 // parse that and add it to the feature set.
1869 StringRef TargetCPU = getTarget().getTargetOpts().CPU;
Chandler Carruth45bbe012017-03-24 09:11:57 +00001870 const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(TargetDecl);
Eric Christopherb57804a2015-09-01 22:03:56 +00001871 if (FD && FD->hasAttr<TargetAttr>()) {
Eric Christopher3a98b3c2015-08-27 19:59:34 +00001872 llvm::StringMap<bool> FeatureMap;
Eric Christopher2b90a642015-11-11 23:05:08 +00001873 getFunctionFeatureMap(FeatureMap, FD);
Eric Christopher11acf732015-06-12 01:35:52 +00001874
Eric Christopher3a98b3c2015-08-27 19:59:34 +00001875 // Produce the canonical string for this set of features.
1876 std::vector<std::string> Features;
1877 for (llvm::StringMap<bool>::const_iterator it = FeatureMap.begin(),
1878 ie = FeatureMap.end();
1879 it != ie; ++it)
1880 Features.push_back((it->second ? "+" : "-") + it->first().str());
Eric Christopher2249b812015-07-01 00:08:29 +00001881
Eric Christopher3a98b3c2015-08-27 19:59:34 +00001882 // Now add the target-cpu and target-features to the function.
Eric Christopher2b90a642015-11-11 23:05:08 +00001883 // While we populated the feature map above, we still need to
1884 // get and parse the target attribute so we can get the cpu for
1885 // the function.
1886 const auto *TD = FD->getAttr<TargetAttr>();
1887 TargetAttr::ParsedTargetAttr ParsedAttr = TD->parse();
Erich Keaneb0d44232017-07-18 20:41:02 +00001888 if (ParsedAttr.Architecture != "")
1889 TargetCPU = ParsedAttr.Architecture;
Eric Christopher3a98b3c2015-08-27 19:59:34 +00001890 if (TargetCPU != "")
1891 FuncAttrs.addAttribute("target-cpu", TargetCPU);
1892 if (!Features.empty()) {
1893 std::sort(Features.begin(), Features.end());
1894 FuncAttrs.addAttribute(
1895 "target-features",
1896 llvm::join(Features.begin(), Features.end(), ","));
1897 }
1898 } else {
1899 // Otherwise just add the existing target cpu and target features to the
1900 // function.
1901 std::vector<std::string> &Features = getTarget().getTargetOpts().Features;
1902 if (TargetCPU != "")
1903 FuncAttrs.addAttribute("target-cpu", TargetCPU);
1904 if (!Features.empty()) {
1905 std::sort(Features.begin(), Features.end());
1906 FuncAttrs.addAttribute(
1907 "target-features",
1908 llvm::join(Features.begin(), Features.end(), ","));
1909 }
Eric Christopher70c16652015-03-25 23:14:47 +00001910 }
Bill Wendling985d1c52013-02-15 21:30:01 +00001911 }
1912
Alexey Samsonov153004f2014-09-29 22:08:00 +00001913 ClangToLLVMArgMapping IRFunctionArgs(getContext(), FI);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00001914
Daniel Dunbar3668cb22009-02-02 23:43:58 +00001915 QualType RetTy = FI.getReturnType();
Daniel Dunbarb52d0772009-02-03 05:59:18 +00001916 const ABIArgInfo &RetAI = FI.getReturnInfo();
Daniel Dunbar7a95ca32008-09-10 04:01:49 +00001917 switch (RetAI.getKind()) {
Anton Korobeynikov18adbf52009-06-06 09:36:29 +00001918 case ABIArgInfo::Extend:
Jakob Stoklund Olesend7bf2932013-05-29 03:57:23 +00001919 if (RetTy->hasSignedIntegerRepresentation())
1920 RetAttrs.addAttribute(llvm::Attribute::SExt);
1921 else if (RetTy->hasUnsignedIntegerRepresentation())
1922 RetAttrs.addAttribute(llvm::Attribute::ZExt);
Jakob Stoklund Olesena3661142013-06-05 03:00:09 +00001923 // FALL THROUGH
Daniel Dunbar67dace892009-02-03 06:17:37 +00001924 case ABIArgInfo::Direct:
Jakob Stoklund Olesena3661142013-06-05 03:00:09 +00001925 if (RetAI.getInReg())
1926 RetAttrs.addAttribute(llvm::Attribute::InReg);
1927 break;
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00001928 case ABIArgInfo::Ignore:
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00001929 break;
1930
Alexey Samsonov91cf4552014-08-22 01:06:06 +00001931 case ABIArgInfo::InAlloca:
Rafael Espindola06b2b4a2012-07-31 02:44:24 +00001932 case ABIArgInfo::Indirect: {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00001933 // inalloca and sret disable readnone and readonly
Bill Wendling207f0532012-12-20 19:27:06 +00001934 FuncAttrs.removeAttribute(llvm::Attribute::ReadOnly)
1935 .removeAttribute(llvm::Attribute::ReadNone);
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00001936 break;
Rafael Espindola06b2b4a2012-07-31 02:44:24 +00001937 }
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00001938
John McCallf26e73d2016-03-11 04:30:43 +00001939 case ABIArgInfo::CoerceAndExpand:
1940 break;
1941
Daniel Dunbard3674e62008-09-11 01:48:57 +00001942 case ABIArgInfo::Expand:
David Blaikie83d382b2011-09-23 05:06:16 +00001943 llvm_unreachable("Invalid ABI kind for return argument");
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00001944 }
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00001945
Hal Finkela2347ba2014-07-18 15:52:10 +00001946 if (const auto *RefTy = RetTy->getAs<ReferenceType>()) {
1947 QualType PTy = RefTy->getPointeeType();
David Majnemer9df56372015-09-10 21:52:00 +00001948 if (!PTy->isIncompleteType() && PTy->isConstantSizeType())
Hal Finkela2347ba2014-07-18 15:52:10 +00001949 RetAttrs.addDereferenceableAttr(getContext().getTypeSizeInChars(PTy)
1950 .getQuantity());
1951 else if (getContext().getTargetAddressSpace(PTy) == 0)
1952 RetAttrs.addAttribute(llvm::Attribute::NonNull);
1953 }
Nick Lewycky9b46eb82014-05-28 09:56:42 +00001954
John McCall12f23522016-04-04 18:33:08 +00001955 bool hasUsedSRet = false;
Reid Klecknercdd26792017-04-18 23:50:03 +00001956 SmallVector<llvm::AttributeSet, 4> ArgAttrs(IRFunctionArgs.totalIRArgs());
John McCall12f23522016-04-04 18:33:08 +00001957
Alexey Samsonov91cf4552014-08-22 01:06:06 +00001958 // Attach attributes to sret.
1959 if (IRFunctionArgs.hasSRetArg()) {
1960 llvm::AttrBuilder SRETAttrs;
1961 SRETAttrs.addAttribute(llvm::Attribute::StructRet);
John McCall12f23522016-04-04 18:33:08 +00001962 hasUsedSRet = true;
Alexey Samsonov91cf4552014-08-22 01:06:06 +00001963 if (RetAI.getInReg())
1964 SRETAttrs.addAttribute(llvm::Attribute::InReg);
Reid Klecknercdd26792017-04-18 23:50:03 +00001965 ArgAttrs[IRFunctionArgs.getSRetArgNo()] =
1966 llvm::AttributeSet::get(getLLVMContext(), SRETAttrs);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00001967 }
1968
1969 // Attach attributes to inalloca argument.
1970 if (IRFunctionArgs.hasInallocaArg()) {
1971 llvm::AttrBuilder Attrs;
1972 Attrs.addAttribute(llvm::Attribute::InAlloca);
Reid Klecknercdd26792017-04-18 23:50:03 +00001973 ArgAttrs[IRFunctionArgs.getInallocaArgNo()] =
1974 llvm::AttributeSet::get(getLLVMContext(), Attrs);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00001975 }
1976
Alexey Samsonov91cf4552014-08-22 01:06:06 +00001977 unsigned ArgNo = 0;
1978 for (CGFunctionInfo::const_arg_iterator I = FI.arg_begin(),
1979 E = FI.arg_end();
1980 I != E; ++I, ++ArgNo) {
1981 QualType ParamType = I->type;
1982 const ABIArgInfo &AI = I->info;
Bill Wendlinga514ebc2012-10-15 20:36:26 +00001983 llvm::AttrBuilder Attrs;
Anton Korobeynikovc8478242009-04-04 00:49:24 +00001984
Alexey Samsonov91cf4552014-08-22 01:06:06 +00001985 // Add attribute for padding argument, if necessary.
1986 if (IRFunctionArgs.hasPaddingArg(ArgNo)) {
Reid Klecknercdd26792017-04-18 23:50:03 +00001987 if (AI.getPaddingInReg()) {
1988 ArgAttrs[IRFunctionArgs.getPaddingArgNo(ArgNo)] =
1989 llvm::AttributeSet::get(
1990 getLLVMContext(),
1991 llvm::AttrBuilder().addAttribute(llvm::Attribute::InReg));
1992 }
Rafael Espindolafad28de2012-10-24 01:59:00 +00001993 }
1994
John McCall39ec71f2010-03-27 00:47:27 +00001995 // 'restrict' -> 'noalias' is done in EmitFunctionProlog when we
1996 // have the corresponding parameter variable. It doesn't make
Daniel Dunbarcb2b3d02011-02-10 18:10:07 +00001997 // sense to do it here because parameters are so messed up.
Daniel Dunbard3674e62008-09-11 01:48:57 +00001998 switch (AI.getKind()) {
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00001999 case ABIArgInfo::Extend:
Douglas Gregor6ab2fa82011-05-20 16:38:50 +00002000 if (ParamType->isSignedIntegerOrEnumerationType())
Bill Wendling207f0532012-12-20 19:27:06 +00002001 Attrs.addAttribute(llvm::Attribute::SExt);
Petar Jovanovic1a3f9652015-05-26 21:07:19 +00002002 else if (ParamType->isUnsignedIntegerOrEnumerationType()) {
2003 if (getTypes().getABIInfo().shouldSignExtUnsignedType(ParamType))
2004 Attrs.addAttribute(llvm::Attribute::SExt);
2005 else
2006 Attrs.addAttribute(llvm::Attribute::ZExt);
2007 }
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002008 // FALL THROUGH
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002009 case ABIArgInfo::Direct:
Peter Collingbournef7706832014-12-12 23:41:25 +00002010 if (ArgNo == 0 && FI.isChainCall())
2011 Attrs.addAttribute(llvm::Attribute::Nest);
2012 else if (AI.getInReg())
Bill Wendling207f0532012-12-20 19:27:06 +00002013 Attrs.addAttribute(llvm::Attribute::InReg);
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002014 break;
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002015
James Y Knight71608572015-08-21 18:19:06 +00002016 case ABIArgInfo::Indirect: {
Rafael Espindola703c47f2012-10-19 05:04:37 +00002017 if (AI.getInReg())
Bill Wendling207f0532012-12-20 19:27:06 +00002018 Attrs.addAttribute(llvm::Attribute::InReg);
Rafael Espindola703c47f2012-10-19 05:04:37 +00002019
Anders Carlsson20759ad2009-09-16 15:53:40 +00002020 if (AI.getIndirectByVal())
Bill Wendling207f0532012-12-20 19:27:06 +00002021 Attrs.addAttribute(llvm::Attribute::ByVal);
Anders Carlsson20759ad2009-09-16 15:53:40 +00002022
John McCall7f416cc2015-09-08 08:05:57 +00002023 CharUnits Align = AI.getIndirectAlign();
James Y Knight71608572015-08-21 18:19:06 +00002024
2025 // In a byval argument, it is important that the required
2026 // alignment of the type is honored, as LLVM might be creating a
2027 // *new* stack object, and needs to know what alignment to give
2028 // it. (Sometimes it can deduce a sensible alignment on its own,
2029 // but not if clang decides it must emit a packed struct, or the
2030 // user specifies increased alignment requirements.)
2031 //
2032 // This is different from indirect *not* byval, where the object
2033 // exists already, and the align attribute is purely
2034 // informative.
John McCall7f416cc2015-09-08 08:05:57 +00002035 assert(!Align.isZero());
James Y Knight71608572015-08-21 18:19:06 +00002036
John McCall7f416cc2015-09-08 08:05:57 +00002037 // For now, only add this when we have a byval argument.
2038 // TODO: be less lazy about updating test cases.
2039 if (AI.getIndirectByVal())
2040 Attrs.addAlignmentAttr(Align.getQuantity());
Bill Wendlinga7912f82012-10-10 07:36:56 +00002041
Daniel Dunbarc2304432009-03-18 19:51:01 +00002042 // byval disables readnone and readonly.
Bill Wendling207f0532012-12-20 19:27:06 +00002043 FuncAttrs.removeAttribute(llvm::Attribute::ReadOnly)
2044 .removeAttribute(llvm::Attribute::ReadNone);
Daniel Dunbard3674e62008-09-11 01:48:57 +00002045 break;
James Y Knight71608572015-08-21 18:19:06 +00002046 }
Daniel Dunbar94a6f252009-01-26 21:26:08 +00002047 case ABIArgInfo::Ignore:
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002048 case ABIArgInfo::Expand:
John McCallf26e73d2016-03-11 04:30:43 +00002049 case ABIArgInfo::CoerceAndExpand:
2050 break;
Daniel Dunbar94a6f252009-01-26 21:26:08 +00002051
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002052 case ABIArgInfo::InAlloca:
2053 // inalloca disables readnone and readonly.
2054 FuncAttrs.removeAttribute(llvm::Attribute::ReadOnly)
2055 .removeAttribute(llvm::Attribute::ReadNone);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002056 continue;
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00002057 }
Mike Stump11289f42009-09-09 15:08:12 +00002058
Hal Finkela2347ba2014-07-18 15:52:10 +00002059 if (const auto *RefTy = ParamType->getAs<ReferenceType>()) {
2060 QualType PTy = RefTy->getPointeeType();
David Majnemer9df56372015-09-10 21:52:00 +00002061 if (!PTy->isIncompleteType() && PTy->isConstantSizeType())
Hal Finkela2347ba2014-07-18 15:52:10 +00002062 Attrs.addDereferenceableAttr(getContext().getTypeSizeInChars(PTy)
2063 .getQuantity());
2064 else if (getContext().getTargetAddressSpace(PTy) == 0)
2065 Attrs.addAttribute(llvm::Attribute::NonNull);
2066 }
Nick Lewycky9b46eb82014-05-28 09:56:42 +00002067
John McCall12f23522016-04-04 18:33:08 +00002068 switch (FI.getExtParameterInfo(ArgNo).getABI()) {
2069 case ParameterABI::Ordinary:
2070 break;
2071
2072 case ParameterABI::SwiftIndirectResult: {
2073 // Add 'sret' if we haven't already used it for something, but
2074 // only if the result is void.
2075 if (!hasUsedSRet && RetTy->isVoidType()) {
2076 Attrs.addAttribute(llvm::Attribute::StructRet);
2077 hasUsedSRet = true;
2078 }
2079
2080 // Add 'noalias' in either case.
2081 Attrs.addAttribute(llvm::Attribute::NoAlias);
2082
2083 // Add 'dereferenceable' and 'alignment'.
2084 auto PTy = ParamType->getPointeeType();
2085 if (!PTy->isIncompleteType() && PTy->isConstantSizeType()) {
2086 auto info = getContext().getTypeInfoInChars(PTy);
2087 Attrs.addDereferenceableAttr(info.first.getQuantity());
2088 Attrs.addAttribute(llvm::Attribute::getWithAlignment(getLLVMContext(),
2089 info.second.getQuantity()));
2090 }
2091 break;
2092 }
2093
2094 case ParameterABI::SwiftErrorResult:
2095 Attrs.addAttribute(llvm::Attribute::SwiftError);
2096 break;
2097
2098 case ParameterABI::SwiftContext:
2099 Attrs.addAttribute(llvm::Attribute::SwiftSelf);
2100 break;
2101 }
2102
Akira Hatanaka98a49332017-09-22 00:41:05 +00002103 if (FI.getExtParameterInfo(ArgNo).isNoEscape())
2104 Attrs.addAttribute(llvm::Attribute::NoCapture);
2105
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002106 if (Attrs.hasAttributes()) {
2107 unsigned FirstIRArg, NumIRArgs;
2108 std::tie(FirstIRArg, NumIRArgs) = IRFunctionArgs.getIRArgs(ArgNo);
2109 for (unsigned i = 0; i < NumIRArgs; i++)
Reid Klecknercdd26792017-04-18 23:50:03 +00002110 ArgAttrs[FirstIRArg + i] =
2111 llvm::AttributeSet::get(getLLVMContext(), Attrs);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002112 }
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00002113 }
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002114 assert(ArgNo == FI.arg_size());
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002115
Reid Klecknercdd26792017-04-18 23:50:03 +00002116 AttrList = llvm::AttributeList::get(
2117 getLLVMContext(), llvm::AttributeSet::get(getLLVMContext(), FuncAttrs),
2118 llvm::AttributeSet::get(getLLVMContext(), RetAttrs), ArgAttrs);
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00002119}
2120
John McCalla738c252011-03-09 04:27:21 +00002121/// An argument came in as a promoted argument; demote it back to its
2122/// declared type.
2123static llvm::Value *emitArgumentDemotion(CodeGenFunction &CGF,
2124 const VarDecl *var,
2125 llvm::Value *value) {
Chris Lattner2192fe52011-07-18 04:24:23 +00002126 llvm::Type *varType = CGF.ConvertType(var->getType());
John McCalla738c252011-03-09 04:27:21 +00002127
2128 // This can happen with promotions that actually don't change the
2129 // underlying type, like the enum promotions.
2130 if (value->getType() == varType) return value;
2131
2132 assert((varType->isIntegerTy() || varType->isFloatingPointTy())
2133 && "unexpected promotion type");
2134
2135 if (isa<llvm::IntegerType>(varType))
2136 return CGF.Builder.CreateTrunc(value, varType, "arg.unpromote");
2137
2138 return CGF.Builder.CreateFPCast(value, varType, "arg.unpromote");
2139}
2140
Chandler Carruth45bbe012017-03-24 09:11:57 +00002141/// Returns the attribute (either parameter attribute, or function
2142/// attribute), which declares argument ArgNo to be non-null.
2143static const NonNullAttr *getNonNullAttr(const Decl *FD, const ParmVarDecl *PVD,
2144 QualType ArgType, unsigned ArgNo) {
2145 // FIXME: __attribute__((nonnull)) can also be applied to:
2146 // - references to pointers, where the pointee is known to be
2147 // nonnull (apparently a Clang extension)
2148 // - transparent unions containing pointers
2149 // In the former case, LLVM IR cannot represent the constraint. In
2150 // the latter case, we have no guarantee that the transparent union
2151 // is in fact passed as a pointer.
2152 if (!ArgType->isAnyPointerType() && !ArgType->isBlockPointerType())
2153 return nullptr;
2154 // First, check attribute on parameter itself.
2155 if (PVD) {
2156 if (auto ParmNNAttr = PVD->getAttr<NonNullAttr>())
2157 return ParmNNAttr;
2158 }
2159 // Check function attributes.
2160 if (!FD)
2161 return nullptr;
2162 for (const auto *NNAttr : FD->specific_attrs<NonNullAttr>()) {
2163 if (NNAttr->isNonNull(ArgNo))
2164 return NNAttr;
2165 }
2166 return nullptr;
2167}
2168
John McCall12f23522016-04-04 18:33:08 +00002169namespace {
2170 struct CopyBackSwiftError final : EHScopeStack::Cleanup {
2171 Address Temp;
2172 Address Arg;
2173 CopyBackSwiftError(Address temp, Address arg) : Temp(temp), Arg(arg) {}
2174 void Emit(CodeGenFunction &CGF, Flags flags) override {
2175 llvm::Value *errorValue = CGF.Builder.CreateLoad(Temp);
2176 CGF.Builder.CreateStore(errorValue, Arg);
2177 }
2178 };
2179}
2180
Daniel Dunbard931a872009-02-02 22:03:45 +00002181void CodeGenFunction::EmitFunctionProlog(const CGFunctionInfo &FI,
2182 llvm::Function *Fn,
Daniel Dunbar613855c2008-09-09 23:27:19 +00002183 const FunctionArgList &Args) {
Hans Wennborgd71907d2014-09-04 22:16:33 +00002184 if (CurCodeDecl && CurCodeDecl->hasAttr<NakedAttr>())
2185 // Naked functions don't have prologues.
2186 return;
2187
John McCallcaa19452009-07-28 01:00:58 +00002188 // If this is an implicit-return-zero function, go ahead and
2189 // initialize the return value. TODO: it might be nice to have
2190 // a more general mechanism for this that didn't require synthesized
2191 // return statements.
John McCalldec348f72013-05-03 07:33:41 +00002192 if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(CurCodeDecl)) {
John McCallcaa19452009-07-28 01:00:58 +00002193 if (FD->hasImplicitReturnZero()) {
Alp Toker314cc812014-01-25 16:55:45 +00002194 QualType RetTy = FD->getReturnType().getUnqualifiedType();
Chris Lattner2192fe52011-07-18 04:24:23 +00002195 llvm::Type* LLVMTy = CGM.getTypes().ConvertType(RetTy);
Owen Anderson0b75f232009-07-31 20:28:54 +00002196 llvm::Constant* Zero = llvm::Constant::getNullValue(LLVMTy);
John McCallcaa19452009-07-28 01:00:58 +00002197 Builder.CreateStore(Zero, ReturnValue);
2198 }
2199 }
2200
Mike Stump18bb9282009-05-16 07:57:57 +00002201 // FIXME: We no longer need the types from FunctionArgList; lift up and
2202 // simplify.
Daniel Dunbar5a0acdc92009-02-03 06:02:10 +00002203
Alexey Samsonov153004f2014-09-29 22:08:00 +00002204 ClangToLLVMArgMapping IRFunctionArgs(CGM.getContext(), FI);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002205 // Flattened function arguments.
John McCall12f23522016-04-04 18:33:08 +00002206 SmallVector<llvm::Value *, 16> FnArgs;
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002207 FnArgs.reserve(IRFunctionArgs.totalIRArgs());
2208 for (auto &Arg : Fn->args()) {
2209 FnArgs.push_back(&Arg);
2210 }
2211 assert(FnArgs.size() == IRFunctionArgs.totalIRArgs());
Mike Stump11289f42009-09-09 15:08:12 +00002212
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002213 // If we're using inalloca, all the memory arguments are GEPs off of the last
2214 // parameter, which is a pointer to the complete memory area.
John McCall7f416cc2015-09-08 08:05:57 +00002215 Address ArgStruct = Address::invalid();
2216 const llvm::StructLayout *ArgStructLayout = nullptr;
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002217 if (IRFunctionArgs.hasInallocaArg()) {
John McCall7f416cc2015-09-08 08:05:57 +00002218 ArgStructLayout = CGM.getDataLayout().getStructLayout(FI.getArgStruct());
2219 ArgStruct = Address(FnArgs[IRFunctionArgs.getInallocaArgNo()],
2220 FI.getArgStructAlignment());
2221
2222 assert(ArgStruct.getType() == FI.getArgStruct()->getPointerTo());
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002223 }
2224
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002225 // Name the struct return parameter.
2226 if (IRFunctionArgs.hasSRetArg()) {
John McCall12f23522016-04-04 18:33:08 +00002227 auto AI = cast<llvm::Argument>(FnArgs[IRFunctionArgs.getSRetArgNo()]);
Daniel Dunbar613855c2008-09-09 23:27:19 +00002228 AI->setName("agg.result");
Reid Klecknercdd26792017-04-18 23:50:03 +00002229 AI->addAttr(llvm::Attribute::NoAlias);
Daniel Dunbar613855c2008-09-09 23:27:19 +00002230 }
Mike Stump11289f42009-09-09 15:08:12 +00002231
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002232 // Track if we received the parameter as a pointer (indirect, byval, or
2233 // inalloca). If already have a pointer, EmitParmDecl doesn't need to copy it
2234 // into a local alloca for us.
John McCall7f416cc2015-09-08 08:05:57 +00002235 SmallVector<ParamValue, 16> ArgVals;
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002236 ArgVals.reserve(Args.size());
2237
Reid Kleckner739756c2013-12-04 19:23:12 +00002238 // Create a pointer value for every parameter declaration. This usually
2239 // entails copying one or more LLVM IR arguments into an alloca. Don't push
2240 // any cleanups or do anything that might unwind. We do that separately, so
2241 // we can push the cleanups in the correct order for the ABI.
Daniel Dunbara45bdbb2009-02-04 21:17:21 +00002242 assert(FI.arg_size() == Args.size() &&
2243 "Mismatch between function signature & arguments.");
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002244 unsigned ArgNo = 0;
Daniel Dunbarb52d0772009-02-03 05:59:18 +00002245 CGFunctionInfo::const_arg_iterator info_it = FI.arg_begin();
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002246 for (FunctionArgList::const_iterator i = Args.begin(), e = Args.end();
Devang Patel68a15252011-03-03 20:13:15 +00002247 i != e; ++i, ++info_it, ++ArgNo) {
John McCalla738c252011-03-09 04:27:21 +00002248 const VarDecl *Arg = *i;
Daniel Dunbarb52d0772009-02-03 05:59:18 +00002249 QualType Ty = info_it->type;
2250 const ABIArgInfo &ArgI = info_it->info;
Daniel Dunbard3674e62008-09-11 01:48:57 +00002251
John McCalla738c252011-03-09 04:27:21 +00002252 bool isPromoted =
2253 isa<ParmVarDecl>(Arg) && cast<ParmVarDecl>(Arg)->isKNRPromoted();
2254
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002255 unsigned FirstIRArg, NumIRArgs;
2256 std::tie(FirstIRArg, NumIRArgs) = IRFunctionArgs.getIRArgs(ArgNo);
Rafael Espindolafad28de2012-10-24 01:59:00 +00002257
Daniel Dunbard3674e62008-09-11 01:48:57 +00002258 switch (ArgI.getKind()) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002259 case ABIArgInfo::InAlloca: {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002260 assert(NumIRArgs == 0);
John McCall7f416cc2015-09-08 08:05:57 +00002261 auto FieldIndex = ArgI.getInAllocaFieldIndex();
2262 CharUnits FieldOffset =
2263 CharUnits::fromQuantity(ArgStructLayout->getElementOffset(FieldIndex));
2264 Address V = Builder.CreateStructGEP(ArgStruct, FieldIndex, FieldOffset,
2265 Arg->getName());
2266 ArgVals.push_back(ParamValue::forIndirect(V));
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002267 break;
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002268 }
2269
Daniel Dunbar747865a2009-02-05 09:16:39 +00002270 case ABIArgInfo::Indirect: {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002271 assert(NumIRArgs == 1);
John McCall7f416cc2015-09-08 08:05:57 +00002272 Address ParamAddr = Address(FnArgs[FirstIRArg], ArgI.getIndirectAlign());
Daniel Dunbar7b7c2932010-09-16 20:42:02 +00002273
John McCall47fb9502013-03-07 21:37:08 +00002274 if (!hasScalarEvaluationKind(Ty)) {
Daniel Dunbar7b7c2932010-09-16 20:42:02 +00002275 // Aggregates and complex variables are accessed by reference. All we
John McCall7f416cc2015-09-08 08:05:57 +00002276 // need to do is realign the value, if requested.
2277 Address V = ParamAddr;
Daniel Dunbar7b7c2932010-09-16 20:42:02 +00002278 if (ArgI.getIndirectRealign()) {
John McCall7f416cc2015-09-08 08:05:57 +00002279 Address AlignedTemp = CreateMemTemp(Ty, "coerce");
Daniel Dunbar7b7c2932010-09-16 20:42:02 +00002280
2281 // Copy from the incoming argument pointer to the temporary with the
2282 // appropriate alignment.
2283 //
2284 // FIXME: We should have a common utility for generating an aggregate
2285 // copy.
Ken Dyck705ba072011-01-19 01:58:38 +00002286 CharUnits Size = getContext().getTypeSizeInChars(Ty);
John McCall7f416cc2015-09-08 08:05:57 +00002287 auto SizeVal = llvm::ConstantInt::get(IntPtrTy, Size.getQuantity());
2288 Address Dst = Builder.CreateBitCast(AlignedTemp, Int8PtrTy);
2289 Address Src = Builder.CreateBitCast(ParamAddr, Int8PtrTy);
2290 Builder.CreateMemCpy(Dst, Src, SizeVal, false);
Daniel Dunbar7b7c2932010-09-16 20:42:02 +00002291 V = AlignedTemp;
2292 }
John McCall7f416cc2015-09-08 08:05:57 +00002293 ArgVals.push_back(ParamValue::forIndirect(V));
Daniel Dunbar747865a2009-02-05 09:16:39 +00002294 } else {
2295 // Load scalar value from indirect argument.
John McCall7f416cc2015-09-08 08:05:57 +00002296 llvm::Value *V =
2297 EmitLoadOfScalar(ParamAddr, false, Ty, Arg->getLocStart());
John McCalla738c252011-03-09 04:27:21 +00002298
2299 if (isPromoted)
2300 V = emitArgumentDemotion(*this, Arg, V);
John McCall7f416cc2015-09-08 08:05:57 +00002301 ArgVals.push_back(ParamValue::forDirect(V));
Daniel Dunbar747865a2009-02-05 09:16:39 +00002302 }
Daniel Dunbar747865a2009-02-05 09:16:39 +00002303 break;
2304 }
Anton Korobeynikov18adbf52009-06-06 09:36:29 +00002305
2306 case ABIArgInfo::Extend:
Daniel Dunbar67dace892009-02-03 06:17:37 +00002307 case ABIArgInfo::Direct: {
Akira Hatanaka18334dd2012-01-09 19:08:06 +00002308
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002309 // If we have the trivial case, handle it with no muss and fuss.
2310 if (!isa<llvm::StructType>(ArgI.getCoerceToType()) &&
Chris Lattner8a2f3c72010-07-30 04:02:24 +00002311 ArgI.getCoerceToType() == ConvertType(Ty) &&
2312 ArgI.getDirectOffset() == 0) {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002313 assert(NumIRArgs == 1);
John McCall12f23522016-04-04 18:33:08 +00002314 llvm::Value *V = FnArgs[FirstIRArg];
2315 auto AI = cast<llvm::Argument>(V);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002316
Hal Finkel48d53e22014-07-19 01:41:07 +00002317 if (const ParmVarDecl *PVD = dyn_cast<ParmVarDecl>(Arg)) {
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00002318 if (getNonNullAttr(CurCodeDecl, PVD, PVD->getType(),
2319 PVD->getFunctionScopeIndex()))
Reid Klecknercdd26792017-04-18 23:50:03 +00002320 AI->addAttr(llvm::Attribute::NonNull);
Hal Finkel82504f02014-07-11 17:35:21 +00002321
Hal Finkel48d53e22014-07-19 01:41:07 +00002322 QualType OTy = PVD->getOriginalType();
2323 if (const auto *ArrTy =
2324 getContext().getAsConstantArrayType(OTy)) {
2325 // A C99 array parameter declaration with the static keyword also
2326 // indicates dereferenceability, and if the size is constant we can
2327 // use the dereferenceable attribute (which requires the size in
2328 // bytes).
Hal Finkel16e394a2014-07-19 02:13:40 +00002329 if (ArrTy->getSizeModifier() == ArrayType::Static) {
Hal Finkel48d53e22014-07-19 01:41:07 +00002330 QualType ETy = ArrTy->getElementType();
2331 uint64_t ArrSize = ArrTy->getSize().getZExtValue();
2332 if (!ETy->isIncompleteType() && ETy->isConstantSizeType() &&
2333 ArrSize) {
2334 llvm::AttrBuilder Attrs;
2335 Attrs.addDereferenceableAttr(
2336 getContext().getTypeSizeInChars(ETy).getQuantity()*ArrSize);
Reid Kleckner9d16fa02017-04-19 17:28:52 +00002337 AI->addAttrs(Attrs);
Hal Finkel48d53e22014-07-19 01:41:07 +00002338 } else if (getContext().getTargetAddressSpace(ETy) == 0) {
Reid Klecknercdd26792017-04-18 23:50:03 +00002339 AI->addAttr(llvm::Attribute::NonNull);
Hal Finkel48d53e22014-07-19 01:41:07 +00002340 }
2341 }
2342 } else if (const auto *ArrTy =
2343 getContext().getAsVariableArrayType(OTy)) {
2344 // For C99 VLAs with the static keyword, we don't know the size so
2345 // we can't use the dereferenceable attribute, but in addrspace(0)
2346 // we know that it must be nonnull.
2347 if (ArrTy->getSizeModifier() == VariableArrayType::Static &&
2348 !getContext().getTargetAddressSpace(ArrTy->getElementType()))
Reid Klecknercdd26792017-04-18 23:50:03 +00002349 AI->addAttr(llvm::Attribute::NonNull);
Hal Finkel48d53e22014-07-19 01:41:07 +00002350 }
Hal Finkel1b0d24e2014-10-02 21:21:25 +00002351
2352 const auto *AVAttr = PVD->getAttr<AlignValueAttr>();
2353 if (!AVAttr)
2354 if (const auto *TOTy = dyn_cast<TypedefType>(OTy))
2355 AVAttr = TOTy->getDecl()->getAttr<AlignValueAttr>();
Reid Kleckner9d16fa02017-04-19 17:28:52 +00002356 if (AVAttr) {
Hal Finkel1b0d24e2014-10-02 21:21:25 +00002357 llvm::Value *AlignmentValue =
2358 EmitScalarExpr(AVAttr->getAlignment());
2359 llvm::ConstantInt *AlignmentCI =
2360 cast<llvm::ConstantInt>(AlignmentValue);
Reid Kleckner9d16fa02017-04-19 17:28:52 +00002361 unsigned Alignment = std::min((unsigned)AlignmentCI->getZExtValue(),
2362 +llvm::Value::MaximumAlignment);
2363 AI->addAttrs(llvm::AttrBuilder().addAlignmentAttr(Alignment));
Hal Finkel1b0d24e2014-10-02 21:21:25 +00002364 }
Hal Finkel48d53e22014-07-19 01:41:07 +00002365 }
2366
Bill Wendling507c3512012-10-16 05:23:44 +00002367 if (Arg->getType().isRestrictQualified())
Reid Klecknercdd26792017-04-18 23:50:03 +00002368 AI->addAttr(llvm::Attribute::NoAlias);
John McCall39ec71f2010-03-27 00:47:27 +00002369
John McCall12f23522016-04-04 18:33:08 +00002370 // LLVM expects swifterror parameters to be used in very restricted
2371 // ways. Copy the value into a less-restricted temporary.
2372 if (FI.getExtParameterInfo(ArgNo).getABI()
2373 == ParameterABI::SwiftErrorResult) {
2374 QualType pointeeTy = Ty->getPointeeType();
2375 assert(pointeeTy->isPointerType());
2376 Address temp =
2377 CreateMemTemp(pointeeTy, getPointerAlign(), "swifterror.temp");
2378 Address arg = Address(V, getContext().getTypeAlignInChars(pointeeTy));
2379 llvm::Value *incomingErrorValue = Builder.CreateLoad(arg);
2380 Builder.CreateStore(incomingErrorValue, temp);
2381 V = temp.getPointer();
2382
2383 // Push a cleanup to copy the value back at the end of the function.
2384 // The convention does not guarantee that the value will be written
2385 // back if the function exits with an unwind exception.
2386 EHStack.pushCleanup<CopyBackSwiftError>(NormalCleanup, temp, arg);
2387 }
2388
Chris Lattner7369c142011-07-20 06:29:00 +00002389 // Ensure the argument is the correct type.
2390 if (V->getType() != ArgI.getCoerceToType())
2391 V = Builder.CreateBitCast(V, ArgI.getCoerceToType());
2392
John McCalla738c252011-03-09 04:27:21 +00002393 if (isPromoted)
2394 V = emitArgumentDemotion(*this, Arg, V);
Rafael Espindola8778c282012-11-29 16:09:03 +00002395
2396 // Because of merging of function types from multiple decls it is
2397 // possible for the type of an argument to not match the corresponding
2398 // type in the function type. Since we are codegening the callee
2399 // in here, add a cast to the argument type.
2400 llvm::Type *LTy = ConvertType(Arg->getType());
2401 if (V->getType() != LTy)
2402 V = Builder.CreateBitCast(V, LTy);
2403
John McCall7f416cc2015-09-08 08:05:57 +00002404 ArgVals.push_back(ParamValue::forDirect(V));
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002405 break;
Daniel Dunbard5f1f552009-02-10 00:06:49 +00002406 }
Mike Stump11289f42009-09-09 15:08:12 +00002407
John McCall7f416cc2015-09-08 08:05:57 +00002408 Address Alloca = CreateMemTemp(Ty, getContext().getDeclAlign(Arg),
2409 Arg->getName());
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002410
John McCall7f416cc2015-09-08 08:05:57 +00002411 // Pointer to store into.
2412 Address Ptr = emitAddressAtOffset(*this, Alloca, ArgI);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002413
Oliver Stannard2bfdc5b2014-08-27 10:43:15 +00002414 // Fast-isel and the optimizer generally like scalar values better than
2415 // FCAs, so we flatten them if this is safe to do for this argument.
Evgeniy Stepanov3fae4ae2012-02-10 09:30:15 +00002416 llvm::StructType *STy = dyn_cast<llvm::StructType>(ArgI.getCoerceToType());
Oliver Stannard2bfdc5b2014-08-27 10:43:15 +00002417 if (ArgI.isDirect() && ArgI.getCanBeFlattened() && STy &&
2418 STy->getNumElements() > 1) {
John McCall7f416cc2015-09-08 08:05:57 +00002419 auto SrcLayout = CGM.getDataLayout().getStructLayout(STy);
Micah Villmowdd31ca12012-10-08 16:25:52 +00002420 uint64_t SrcSize = CGM.getDataLayout().getTypeAllocSize(STy);
John McCall7f416cc2015-09-08 08:05:57 +00002421 llvm::Type *DstTy = Ptr.getElementType();
Micah Villmowdd31ca12012-10-08 16:25:52 +00002422 uint64_t DstSize = CGM.getDataLayout().getTypeAllocSize(DstTy);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002423
John McCall7f416cc2015-09-08 08:05:57 +00002424 Address AddrToStoreInto = Address::invalid();
Evgeniy Stepanov3fae4ae2012-02-10 09:30:15 +00002425 if (SrcSize <= DstSize) {
Yaxun Liue9e5c4f2017-06-29 18:47:45 +00002426 AddrToStoreInto = Builder.CreateElementBitCast(Ptr, STy);
Evgeniy Stepanov3fae4ae2012-02-10 09:30:15 +00002427 } else {
John McCall7f416cc2015-09-08 08:05:57 +00002428 AddrToStoreInto =
2429 CreateTempAlloca(STy, Alloca.getAlignment(), "coerce");
Chris Lattner15ec3612010-06-29 00:06:42 +00002430 }
John McCall7f416cc2015-09-08 08:05:57 +00002431
2432 assert(STy->getNumElements() == NumIRArgs);
2433 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
2434 auto AI = FnArgs[FirstIRArg + i];
2435 AI->setName(Arg->getName() + ".coerce" + Twine(i));
2436 auto Offset = CharUnits::fromQuantity(SrcLayout->getElementOffset(i));
2437 Address EltPtr =
2438 Builder.CreateStructGEP(AddrToStoreInto, i, Offset);
2439 Builder.CreateStore(AI, EltPtr);
2440 }
2441
2442 if (SrcSize > DstSize) {
2443 Builder.CreateMemCpy(Ptr, AddrToStoreInto, DstSize);
2444 }
2445
Chris Lattner15ec3612010-06-29 00:06:42 +00002446 } else {
2447 // Simple case, just do a coerced store of the argument into the alloca.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002448 assert(NumIRArgs == 1);
2449 auto AI = FnArgs[FirstIRArg];
Chris Lattner9e748e92010-06-29 00:14:52 +00002450 AI->setName(Arg->getName() + ".coerce");
John McCall7f416cc2015-09-08 08:05:57 +00002451 CreateCoercedStore(AI, Ptr, /*DestIsVolatile=*/false, *this);
Chris Lattner15ec3612010-06-29 00:06:42 +00002452 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002453
Daniel Dunbar2f219b02009-02-03 19:12:28 +00002454 // Match to what EmitParmDecl is expecting for this type.
John McCall47fb9502013-03-07 21:37:08 +00002455 if (CodeGenFunction::hasScalarEvaluationKind(Ty)) {
John McCall7f416cc2015-09-08 08:05:57 +00002456 llvm::Value *V =
2457 EmitLoadOfScalar(Alloca, false, Ty, Arg->getLocStart());
John McCalla738c252011-03-09 04:27:21 +00002458 if (isPromoted)
2459 V = emitArgumentDemotion(*this, Arg, V);
John McCall7f416cc2015-09-08 08:05:57 +00002460 ArgVals.push_back(ParamValue::forDirect(V));
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002461 } else {
John McCall7f416cc2015-09-08 08:05:57 +00002462 ArgVals.push_back(ParamValue::forIndirect(Alloca));
Daniel Dunbar6e3b7df2009-02-04 07:22:24 +00002463 }
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002464 break;
Daniel Dunbar2f219b02009-02-03 19:12:28 +00002465 }
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002466
John McCallf26e73d2016-03-11 04:30:43 +00002467 case ABIArgInfo::CoerceAndExpand: {
2468 // Reconstruct into a temporary.
2469 Address alloca = CreateMemTemp(Ty, getContext().getDeclAlign(Arg));
2470 ArgVals.push_back(ParamValue::forIndirect(alloca));
2471
2472 auto coercionType = ArgI.getCoerceAndExpandType();
2473 alloca = Builder.CreateElementBitCast(alloca, coercionType);
2474 auto layout = CGM.getDataLayout().getStructLayout(coercionType);
2475
2476 unsigned argIndex = FirstIRArg;
2477 for (unsigned i = 0, e = coercionType->getNumElements(); i != e; ++i) {
2478 llvm::Type *eltType = coercionType->getElementType(i);
2479 if (ABIArgInfo::isPaddingForCoerceAndExpand(eltType))
2480 continue;
2481
2482 auto eltAddr = Builder.CreateStructGEP(alloca, i, layout);
2483 auto elt = FnArgs[argIndex++];
2484 Builder.CreateStore(elt, eltAddr);
2485 }
2486 assert(argIndex == FirstIRArg + NumIRArgs);
2487 break;
2488 }
2489
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002490 case ABIArgInfo::Expand: {
2491 // If this structure was expanded into multiple arguments then
2492 // we need to create a temporary and reconstruct it from the
2493 // arguments.
John McCall7f416cc2015-09-08 08:05:57 +00002494 Address Alloca = CreateMemTemp(Ty, getContext().getDeclAlign(Arg));
2495 LValue LV = MakeAddrLValue(Alloca, Ty);
2496 ArgVals.push_back(ParamValue::forIndirect(Alloca));
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002497
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002498 auto FnArgIter = FnArgs.begin() + FirstIRArg;
2499 ExpandTypeFromArgs(Ty, LV, FnArgIter);
2500 assert(FnArgIter == FnArgs.begin() + FirstIRArg + NumIRArgs);
2501 for (unsigned i = 0, e = NumIRArgs; i != e; ++i) {
2502 auto AI = FnArgs[FirstIRArg + i];
2503 AI->setName(Arg->getName() + "." + Twine(i));
2504 }
2505 break;
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002506 }
2507
2508 case ABIArgInfo::Ignore:
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002509 assert(NumIRArgs == 0);
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002510 // Initialize the local variable appropriately.
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002511 if (!hasScalarEvaluationKind(Ty)) {
John McCall7f416cc2015-09-08 08:05:57 +00002512 ArgVals.push_back(ParamValue::forIndirect(CreateMemTemp(Ty)));
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002513 } else {
2514 llvm::Value *U = llvm::UndefValue::get(ConvertType(Arg->getType()));
John McCall7f416cc2015-09-08 08:05:57 +00002515 ArgVals.push_back(ParamValue::forDirect(U));
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002516 }
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002517 break;
Daniel Dunbard3674e62008-09-11 01:48:57 +00002518 }
Daniel Dunbar613855c2008-09-09 23:27:19 +00002519 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002520
Reid Kleckner739756c2013-12-04 19:23:12 +00002521 if (getTarget().getCXXABI().areArgsDestroyedLeftToRightInCallee()) {
2522 for (int I = Args.size() - 1; I >= 0; --I)
John McCall7f416cc2015-09-08 08:05:57 +00002523 EmitParmDecl(*Args[I], ArgVals[I], I + 1);
Reid Kleckner739756c2013-12-04 19:23:12 +00002524 } else {
2525 for (unsigned I = 0, E = Args.size(); I != E; ++I)
John McCall7f416cc2015-09-08 08:05:57 +00002526 EmitParmDecl(*Args[I], ArgVals[I], I + 1);
Reid Kleckner739756c2013-12-04 19:23:12 +00002527 }
Daniel Dunbar613855c2008-09-09 23:27:19 +00002528}
2529
John McCallffa2c1a2012-01-29 07:46:59 +00002530static void eraseUnusedBitCasts(llvm::Instruction *insn) {
2531 while (insn->use_empty()) {
2532 llvm::BitCastInst *bitcast = dyn_cast<llvm::BitCastInst>(insn);
2533 if (!bitcast) return;
2534
2535 // This is "safe" because we would have used a ConstantExpr otherwise.
2536 insn = cast<llvm::Instruction>(bitcast->getOperand(0));
2537 bitcast->eraseFromParent();
2538 }
2539}
2540
John McCall31168b02011-06-15 23:02:42 +00002541/// Try to emit a fused autorelease of a return result.
2542static llvm::Value *tryEmitFusedAutoreleaseOfResult(CodeGenFunction &CGF,
2543 llvm::Value *result) {
2544 // We must be immediately followed the cast.
2545 llvm::BasicBlock *BB = CGF.Builder.GetInsertBlock();
Craig Topper8a13c412014-05-21 05:09:00 +00002546 if (BB->empty()) return nullptr;
2547 if (&BB->back() != result) return nullptr;
John McCall31168b02011-06-15 23:02:42 +00002548
Chris Lattner2192fe52011-07-18 04:24:23 +00002549 llvm::Type *resultType = result->getType();
John McCall31168b02011-06-15 23:02:42 +00002550
2551 // result is in a BasicBlock and is therefore an Instruction.
2552 llvm::Instruction *generator = cast<llvm::Instruction>(result);
2553
Justin Bogner882f8612016-08-18 21:46:54 +00002554 SmallVector<llvm::Instruction *, 4> InstsToKill;
John McCall31168b02011-06-15 23:02:42 +00002555
2556 // Look for:
2557 // %generator = bitcast %type1* %generator2 to %type2*
2558 while (llvm::BitCastInst *bitcast = dyn_cast<llvm::BitCastInst>(generator)) {
2559 // We would have emitted this as a constant if the operand weren't
2560 // an Instruction.
2561 generator = cast<llvm::Instruction>(bitcast->getOperand(0));
2562
2563 // Require the generator to be immediately followed by the cast.
2564 if (generator->getNextNode() != bitcast)
Craig Topper8a13c412014-05-21 05:09:00 +00002565 return nullptr;
John McCall31168b02011-06-15 23:02:42 +00002566
Justin Bogner882f8612016-08-18 21:46:54 +00002567 InstsToKill.push_back(bitcast);
John McCall31168b02011-06-15 23:02:42 +00002568 }
2569
2570 // Look for:
2571 // %generator = call i8* @objc_retain(i8* %originalResult)
2572 // or
2573 // %generator = call i8* @objc_retainAutoreleasedReturnValue(i8* %originalResult)
2574 llvm::CallInst *call = dyn_cast<llvm::CallInst>(generator);
Craig Topper8a13c412014-05-21 05:09:00 +00002575 if (!call) return nullptr;
John McCall31168b02011-06-15 23:02:42 +00002576
2577 bool doRetainAutorelease;
2578
John McCallb04ecb72015-10-21 18:06:43 +00002579 if (call->getCalledValue() == CGF.CGM.getObjCEntrypoints().objc_retain) {
John McCall31168b02011-06-15 23:02:42 +00002580 doRetainAutorelease = true;
John McCallb04ecb72015-10-21 18:06:43 +00002581 } else if (call->getCalledValue() == CGF.CGM.getObjCEntrypoints()
John McCall31168b02011-06-15 23:02:42 +00002582 .objc_retainAutoreleasedReturnValue) {
2583 doRetainAutorelease = false;
2584
John McCallcfa4e9b2012-09-07 23:30:50 +00002585 // If we emitted an assembly marker for this call (and the
2586 // ARCEntrypoints field should have been set if so), go looking
2587 // for that call. If we can't find it, we can't do this
2588 // optimization. But it should always be the immediately previous
2589 // instruction, unless we needed bitcasts around the call.
John McCallb04ecb72015-10-21 18:06:43 +00002590 if (CGF.CGM.getObjCEntrypoints().retainAutoreleasedReturnValueMarker) {
John McCallcfa4e9b2012-09-07 23:30:50 +00002591 llvm::Instruction *prev = call->getPrevNode();
2592 assert(prev);
2593 if (isa<llvm::BitCastInst>(prev)) {
2594 prev = prev->getPrevNode();
2595 assert(prev);
2596 }
2597 assert(isa<llvm::CallInst>(prev));
2598 assert(cast<llvm::CallInst>(prev)->getCalledValue() ==
John McCallb04ecb72015-10-21 18:06:43 +00002599 CGF.CGM.getObjCEntrypoints().retainAutoreleasedReturnValueMarker);
Justin Bogner882f8612016-08-18 21:46:54 +00002600 InstsToKill.push_back(prev);
John McCallcfa4e9b2012-09-07 23:30:50 +00002601 }
John McCall31168b02011-06-15 23:02:42 +00002602 } else {
Craig Topper8a13c412014-05-21 05:09:00 +00002603 return nullptr;
John McCall31168b02011-06-15 23:02:42 +00002604 }
2605
2606 result = call->getArgOperand(0);
Justin Bogner882f8612016-08-18 21:46:54 +00002607 InstsToKill.push_back(call);
John McCall31168b02011-06-15 23:02:42 +00002608
2609 // Keep killing bitcasts, for sanity. Note that we no longer care
2610 // about precise ordering as long as there's exactly one use.
2611 while (llvm::BitCastInst *bitcast = dyn_cast<llvm::BitCastInst>(result)) {
2612 if (!bitcast->hasOneUse()) break;
Justin Bogner882f8612016-08-18 21:46:54 +00002613 InstsToKill.push_back(bitcast);
John McCall31168b02011-06-15 23:02:42 +00002614 result = bitcast->getOperand(0);
2615 }
2616
2617 // Delete all the unnecessary instructions, from latest to earliest.
Justin Bogner882f8612016-08-18 21:46:54 +00002618 for (auto *I : InstsToKill)
Saleem Abdulrasoolbe25c482016-08-18 21:40:06 +00002619 I->eraseFromParent();
John McCall31168b02011-06-15 23:02:42 +00002620
2621 // Do the fused retain/autorelease if we were asked to.
2622 if (doRetainAutorelease)
2623 result = CGF.EmitARCRetainAutoreleaseReturnValue(result);
2624
2625 // Cast back to the result type.
2626 return CGF.Builder.CreateBitCast(result, resultType);
2627}
2628
John McCallffa2c1a2012-01-29 07:46:59 +00002629/// If this is a +1 of the value of an immutable 'self', remove it.
2630static llvm::Value *tryRemoveRetainOfSelf(CodeGenFunction &CGF,
2631 llvm::Value *result) {
2632 // This is only applicable to a method with an immutable 'self'.
John McCallff755cd2012-07-31 00:33:55 +00002633 const ObjCMethodDecl *method =
2634 dyn_cast_or_null<ObjCMethodDecl>(CGF.CurCodeDecl);
Craig Topper8a13c412014-05-21 05:09:00 +00002635 if (!method) return nullptr;
John McCallffa2c1a2012-01-29 07:46:59 +00002636 const VarDecl *self = method->getSelfDecl();
Craig Topper8a13c412014-05-21 05:09:00 +00002637 if (!self->getType().isConstQualified()) return nullptr;
John McCallffa2c1a2012-01-29 07:46:59 +00002638
2639 // Look for a retain call.
2640 llvm::CallInst *retainCall =
2641 dyn_cast<llvm::CallInst>(result->stripPointerCasts());
2642 if (!retainCall ||
John McCallb04ecb72015-10-21 18:06:43 +00002643 retainCall->getCalledValue() != CGF.CGM.getObjCEntrypoints().objc_retain)
Craig Topper8a13c412014-05-21 05:09:00 +00002644 return nullptr;
John McCallffa2c1a2012-01-29 07:46:59 +00002645
2646 // Look for an ordinary load of 'self'.
2647 llvm::Value *retainedValue = retainCall->getArgOperand(0);
2648 llvm::LoadInst *load =
2649 dyn_cast<llvm::LoadInst>(retainedValue->stripPointerCasts());
2650 if (!load || load->isAtomic() || load->isVolatile() ||
John McCall7f416cc2015-09-08 08:05:57 +00002651 load->getPointerOperand() != CGF.GetAddrOfLocalVar(self).getPointer())
Craig Topper8a13c412014-05-21 05:09:00 +00002652 return nullptr;
John McCallffa2c1a2012-01-29 07:46:59 +00002653
2654 // Okay! Burn it all down. This relies for correctness on the
2655 // assumption that the retain is emitted as part of the return and
2656 // that thereafter everything is used "linearly".
2657 llvm::Type *resultType = result->getType();
2658 eraseUnusedBitCasts(cast<llvm::Instruction>(result));
2659 assert(retainCall->use_empty());
2660 retainCall->eraseFromParent();
2661 eraseUnusedBitCasts(cast<llvm::Instruction>(retainedValue));
2662
2663 return CGF.Builder.CreateBitCast(load, resultType);
2664}
2665
John McCall31168b02011-06-15 23:02:42 +00002666/// Emit an ARC autorelease of the result of a function.
John McCallffa2c1a2012-01-29 07:46:59 +00002667///
2668/// \return the value to actually return from the function
John McCall31168b02011-06-15 23:02:42 +00002669static llvm::Value *emitAutoreleaseOfResult(CodeGenFunction &CGF,
2670 llvm::Value *result) {
John McCallffa2c1a2012-01-29 07:46:59 +00002671 // If we're returning 'self', kill the initial retain. This is a
2672 // heuristic attempt to "encourage correctness" in the really unfortunate
2673 // case where we have a return of self during a dealloc and we desperately
2674 // need to avoid the possible autorelease.
2675 if (llvm::Value *self = tryRemoveRetainOfSelf(CGF, result))
2676 return self;
2677
John McCall31168b02011-06-15 23:02:42 +00002678 // At -O0, try to emit a fused retain/autorelease.
2679 if (CGF.shouldUseFusedARCCalls())
2680 if (llvm::Value *fused = tryEmitFusedAutoreleaseOfResult(CGF, result))
2681 return fused;
2682
2683 return CGF.EmitARCAutoreleaseReturnValue(result);
2684}
2685
John McCall6e1c0122012-01-29 02:35:02 +00002686/// Heuristically search for a dominating store to the return-value slot.
2687static llvm::StoreInst *findDominatingStoreToReturnValue(CodeGenFunction &CGF) {
Jakub Kuderskif50ab0f2015-09-08 10:36:42 +00002688 // Check if a User is a store which pointerOperand is the ReturnValue.
2689 // We are looking for stores to the ReturnValue, not for stores of the
2690 // ReturnValue to some other location.
2691 auto GetStoreIfValid = [&CGF](llvm::User *U) -> llvm::StoreInst * {
2692 auto *SI = dyn_cast<llvm::StoreInst>(U);
2693 if (!SI || SI->getPointerOperand() != CGF.ReturnValue.getPointer())
2694 return nullptr;
2695 // These aren't actually possible for non-coerced returns, and we
2696 // only care about non-coerced returns on this code path.
2697 assert(!SI->isAtomic() && !SI->isVolatile());
2698 return SI;
2699 };
John McCall6e1c0122012-01-29 02:35:02 +00002700 // If there are multiple uses of the return-value slot, just check
2701 // for something immediately preceding the IP. Sometimes this can
2702 // happen with how we generate implicit-returns; it can also happen
2703 // with noreturn cleanups.
John McCall7f416cc2015-09-08 08:05:57 +00002704 if (!CGF.ReturnValue.getPointer()->hasOneUse()) {
John McCall6e1c0122012-01-29 02:35:02 +00002705 llvm::BasicBlock *IP = CGF.Builder.GetInsertBlock();
Craig Topper8a13c412014-05-21 05:09:00 +00002706 if (IP->empty()) return nullptr;
David Majnemerdc012fa2015-04-22 21:38:15 +00002707 llvm::Instruction *I = &IP->back();
2708
2709 // Skip lifetime markers
2710 for (llvm::BasicBlock::reverse_iterator II = IP->rbegin(),
2711 IE = IP->rend();
2712 II != IE; ++II) {
2713 if (llvm::IntrinsicInst *Intrinsic =
2714 dyn_cast<llvm::IntrinsicInst>(&*II)) {
2715 if (Intrinsic->getIntrinsicID() == llvm::Intrinsic::lifetime_end) {
2716 const llvm::Value *CastAddr = Intrinsic->getArgOperand(1);
2717 ++II;
Alexey Samsonov10544202015-06-12 21:05:32 +00002718 if (II == IE)
2719 break;
2720 if (isa<llvm::BitCastInst>(&*II) && (CastAddr == &*II))
2721 continue;
David Majnemerdc012fa2015-04-22 21:38:15 +00002722 }
2723 }
2724 I = &*II;
2725 break;
2726 }
2727
Jakub Kuderskif50ab0f2015-09-08 10:36:42 +00002728 return GetStoreIfValid(I);
John McCall6e1c0122012-01-29 02:35:02 +00002729 }
2730
2731 llvm::StoreInst *store =
Jakub Kuderskif50ab0f2015-09-08 10:36:42 +00002732 GetStoreIfValid(CGF.ReturnValue.getPointer()->user_back());
Craig Topper8a13c412014-05-21 05:09:00 +00002733 if (!store) return nullptr;
John McCall6e1c0122012-01-29 02:35:02 +00002734
John McCall6e1c0122012-01-29 02:35:02 +00002735 // Now do a first-and-dirty dominance check: just walk up the
2736 // single-predecessors chain from the current insertion point.
2737 llvm::BasicBlock *StoreBB = store->getParent();
2738 llvm::BasicBlock *IP = CGF.Builder.GetInsertBlock();
2739 while (IP != StoreBB) {
2740 if (!(IP = IP->getSinglePredecessor()))
Craig Topper8a13c412014-05-21 05:09:00 +00002741 return nullptr;
John McCall6e1c0122012-01-29 02:35:02 +00002742 }
2743
2744 // Okay, the store's basic block dominates the insertion point; we
2745 // can do our thing.
2746 return store;
2747}
2748
Adrian Prantl3be10542013-05-02 17:30:20 +00002749void CodeGenFunction::EmitFunctionEpilog(const CGFunctionInfo &FI,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002750 bool EmitRetDbgLoc,
2751 SourceLocation EndLoc) {
Hans Wennborgd71907d2014-09-04 22:16:33 +00002752 if (CurCodeDecl && CurCodeDecl->hasAttr<NakedAttr>()) {
2753 // Naked functions don't have epilogues.
2754 Builder.CreateUnreachable();
2755 return;
2756 }
2757
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00002758 // Functions with no result always return void.
John McCall7f416cc2015-09-08 08:05:57 +00002759 if (!ReturnValue.isValid()) {
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00002760 Builder.CreateRetVoid();
Chris Lattner726b3d02010-06-26 23:13:19 +00002761 return;
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00002762 }
Daniel Dunbar6696e222010-06-30 21:27:58 +00002763
Dan Gohman481e40c2010-07-20 20:13:52 +00002764 llvm::DebugLoc RetDbgLoc;
Craig Topper8a13c412014-05-21 05:09:00 +00002765 llvm::Value *RV = nullptr;
Chris Lattner726b3d02010-06-26 23:13:19 +00002766 QualType RetTy = FI.getReturnType();
2767 const ABIArgInfo &RetAI = FI.getReturnInfo();
2768
2769 switch (RetAI.getKind()) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002770 case ABIArgInfo::InAlloca:
Reid Klecknerfab1e892014-02-25 00:59:14 +00002771 // Aggregrates get evaluated directly into the destination. Sometimes we
2772 // need to return the sret value in a register, though.
2773 assert(hasAggregateEvaluationKind(RetTy));
2774 if (RetAI.getInAllocaSRet()) {
2775 llvm::Function::arg_iterator EI = CurFn->arg_end();
2776 --EI;
Duncan P. N. Exon Smith9f5260a2015-11-06 23:00:41 +00002777 llvm::Value *ArgStruct = &*EI;
David Blaikie2e804282015-04-05 22:47:07 +00002778 llvm::Value *SRet = Builder.CreateStructGEP(
2779 nullptr, ArgStruct, RetAI.getInAllocaFieldIndex());
John McCall7f416cc2015-09-08 08:05:57 +00002780 RV = Builder.CreateAlignedLoad(SRet, getPointerAlign(), "sret");
Reid Klecknerfab1e892014-02-25 00:59:14 +00002781 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002782 break;
2783
Daniel Dunbar03816342010-08-21 02:24:36 +00002784 case ABIArgInfo::Indirect: {
Reid Kleckner37abaca2014-05-09 22:46:15 +00002785 auto AI = CurFn->arg_begin();
2786 if (RetAI.isSRetAfterThis())
2787 ++AI;
John McCall47fb9502013-03-07 21:37:08 +00002788 switch (getEvaluationKind(RetTy)) {
2789 case TEK_Complex: {
2790 ComplexPairTy RT =
John McCall7f416cc2015-09-08 08:05:57 +00002791 EmitLoadOfComplex(MakeAddrLValue(ReturnValue, RetTy), EndLoc);
Duncan P. N. Exon Smith9f5260a2015-11-06 23:00:41 +00002792 EmitStoreOfComplex(RT, MakeNaturalAlignAddrLValue(&*AI, RetTy),
John McCall47fb9502013-03-07 21:37:08 +00002793 /*isInit*/ true);
2794 break;
2795 }
2796 case TEK_Aggregate:
Chris Lattner726b3d02010-06-26 23:13:19 +00002797 // Do nothing; aggregrates get evaluated directly into the destination.
John McCall47fb9502013-03-07 21:37:08 +00002798 break;
2799 case TEK_Scalar:
2800 EmitStoreOfScalar(Builder.CreateLoad(ReturnValue),
Duncan P. N. Exon Smith9f5260a2015-11-06 23:00:41 +00002801 MakeNaturalAlignAddrLValue(&*AI, RetTy),
John McCall47fb9502013-03-07 21:37:08 +00002802 /*isInit*/ true);
2803 break;
Chris Lattner726b3d02010-06-26 23:13:19 +00002804 }
2805 break;
Daniel Dunbar03816342010-08-21 02:24:36 +00002806 }
Chris Lattner726b3d02010-06-26 23:13:19 +00002807
2808 case ABIArgInfo::Extend:
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002809 case ABIArgInfo::Direct:
Chris Lattner8a2f3c72010-07-30 04:02:24 +00002810 if (RetAI.getCoerceToType() == ConvertType(RetTy) &&
2811 RetAI.getDirectOffset() == 0) {
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002812 // The internal return value temp always will have pointer-to-return-type
2813 // type, just do a load.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002814
John McCall6e1c0122012-01-29 02:35:02 +00002815 // If there is a dominating store to ReturnValue, we can elide
2816 // the load, zap the store, and usually zap the alloca.
David Majnemerdc012fa2015-04-22 21:38:15 +00002817 if (llvm::StoreInst *SI =
2818 findDominatingStoreToReturnValue(*this)) {
Adrian Prantl4c9a38a2013-05-30 18:12:23 +00002819 // Reuse the debug location from the store unless there is
2820 // cleanup code to be emitted between the store and return
2821 // instruction.
2822 if (EmitRetDbgLoc && !AutoreleaseResult)
Adrian Prantl3be10542013-05-02 17:30:20 +00002823 RetDbgLoc = SI->getDebugLoc();
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002824 // Get the stored value and nuke the now-dead store.
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002825 RV = SI->getValueOperand();
2826 SI->eraseFromParent();
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002827
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002828 // If that was the only use of the return value, nuke it as well now.
John McCall7f416cc2015-09-08 08:05:57 +00002829 auto returnValueInst = ReturnValue.getPointer();
2830 if (returnValueInst->use_empty()) {
2831 if (auto alloca = dyn_cast<llvm::AllocaInst>(returnValueInst)) {
2832 alloca->eraseFromParent();
2833 ReturnValue = Address::invalid();
2834 }
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002835 }
John McCall6e1c0122012-01-29 02:35:02 +00002836
2837 // Otherwise, we have to do a simple load.
2838 } else {
2839 RV = Builder.CreateLoad(ReturnValue);
Chris Lattner3fcc7902010-06-27 01:06:27 +00002840 }
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002841 } else {
Chris Lattner8a2f3c72010-07-30 04:02:24 +00002842 // If the value is offset in memory, apply the offset now.
John McCall7f416cc2015-09-08 08:05:57 +00002843 Address V = emitAddressAtOffset(*this, ReturnValue, RetAI);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002844
John McCall7f416cc2015-09-08 08:05:57 +00002845 RV = CreateCoercedLoad(V, RetAI.getCoerceToType(), *this);
Chris Lattner3fcc7902010-06-27 01:06:27 +00002846 }
John McCall31168b02011-06-15 23:02:42 +00002847
2848 // In ARC, end functions that return a retainable type with a call
2849 // to objc_autoreleaseReturnValue.
2850 if (AutoreleaseResult) {
Akira Hatanaka9d8ac612016-02-17 21:09:50 +00002851#ifndef NDEBUG
2852 // Type::isObjCRetainabletype has to be called on a QualType that hasn't
2853 // been stripped of the typedefs, so we cannot use RetTy here. Get the
2854 // original return type of FunctionDecl, CurCodeDecl, and BlockDecl from
2855 // CurCodeDecl or BlockInfo.
2856 QualType RT;
2857
2858 if (auto *FD = dyn_cast<FunctionDecl>(CurCodeDecl))
2859 RT = FD->getReturnType();
2860 else if (auto *MD = dyn_cast<ObjCMethodDecl>(CurCodeDecl))
2861 RT = MD->getReturnType();
2862 else if (isa<BlockDecl>(CurCodeDecl))
2863 RT = BlockInfo->BlockExpression->getFunctionType()->getReturnType();
2864 else
2865 llvm_unreachable("Unexpected function/method type");
2866
David Blaikiebbafb8a2012-03-11 07:00:24 +00002867 assert(getLangOpts().ObjCAutoRefCount &&
John McCall31168b02011-06-15 23:02:42 +00002868 !FI.isReturnsRetained() &&
Akira Hatanaka9d8ac612016-02-17 21:09:50 +00002869 RT->isObjCRetainableType());
2870#endif
John McCall31168b02011-06-15 23:02:42 +00002871 RV = emitAutoreleaseOfResult(*this, RV);
2872 }
2873
Chris Lattner726b3d02010-06-26 23:13:19 +00002874 break;
Chris Lattner726b3d02010-06-26 23:13:19 +00002875
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002876 case ABIArgInfo::Ignore:
Chris Lattner726b3d02010-06-26 23:13:19 +00002877 break;
2878
John McCallf26e73d2016-03-11 04:30:43 +00002879 case ABIArgInfo::CoerceAndExpand: {
2880 auto coercionType = RetAI.getCoerceAndExpandType();
2881 auto layout = CGM.getDataLayout().getStructLayout(coercionType);
2882
2883 // Load all of the coerced elements out into results.
2884 llvm::SmallVector<llvm::Value*, 4> results;
2885 Address addr = Builder.CreateElementBitCast(ReturnValue, coercionType);
2886 for (unsigned i = 0, e = coercionType->getNumElements(); i != e; ++i) {
2887 auto coercedEltType = coercionType->getElementType(i);
2888 if (ABIArgInfo::isPaddingForCoerceAndExpand(coercedEltType))
2889 continue;
2890
2891 auto eltAddr = Builder.CreateStructGEP(addr, i, layout);
2892 auto elt = Builder.CreateLoad(eltAddr);
2893 results.push_back(elt);
2894 }
2895
2896 // If we have one result, it's the single direct result type.
2897 if (results.size() == 1) {
2898 RV = results[0];
2899
2900 // Otherwise, we need to make a first-class aggregate.
2901 } else {
2902 // Construct a return type that lacks padding elements.
2903 llvm::Type *returnType = RetAI.getUnpaddedCoerceAndExpandType();
2904
2905 RV = llvm::UndefValue::get(returnType);
2906 for (unsigned i = 0, e = results.size(); i != e; ++i) {
2907 RV = Builder.CreateInsertValue(RV, results[i], i);
2908 }
2909 }
2910 break;
2911 }
2912
Chris Lattner726b3d02010-06-26 23:13:19 +00002913 case ABIArgInfo::Expand:
David Blaikie83d382b2011-09-23 05:06:16 +00002914 llvm_unreachable("Invalid ABI kind for return argument");
Chris Lattner726b3d02010-06-26 23:13:19 +00002915 }
2916
Alexey Samsonovde443c52014-08-13 00:26:40 +00002917 llvm::Instruction *Ret;
2918 if (RV) {
Vedant Kumarc34d3432017-06-23 21:32:38 +00002919 EmitReturnValueCheck(RV);
Alexey Samsonovde443c52014-08-13 00:26:40 +00002920 Ret = Builder.CreateRet(RV);
2921 } else {
2922 Ret = Builder.CreateRetVoid();
2923 }
2924
Duncan P. N. Exon Smith2809cc72015-03-30 20:01:41 +00002925 if (RetDbgLoc)
Benjamin Kramer03278662015-02-07 13:15:54 +00002926 Ret->setDebugLoc(std::move(RetDbgLoc));
Daniel Dunbar613855c2008-09-09 23:27:19 +00002927}
2928
Vedant Kumarc34d3432017-06-23 21:32:38 +00002929void CodeGenFunction::EmitReturnValueCheck(llvm::Value *RV) {
Vedant Kumar42c17ec2017-03-14 01:56:34 +00002930 // A current decl may not be available when emitting vtable thunks.
2931 if (!CurCodeDecl)
2932 return;
2933
2934 ReturnsNonNullAttr *RetNNAttr = nullptr;
2935 if (SanOpts.has(SanitizerKind::ReturnsNonnullAttribute))
2936 RetNNAttr = CurCodeDecl->getAttr<ReturnsNonNullAttr>();
2937
2938 if (!RetNNAttr && !requiresReturnValueNullabilityCheck())
2939 return;
2940
2941 // Prefer the returns_nonnull attribute if it's present.
2942 SourceLocation AttrLoc;
2943 SanitizerMask CheckKind;
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00002944 SanitizerHandler Handler;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00002945 if (RetNNAttr) {
2946 assert(!requiresReturnValueNullabilityCheck() &&
2947 "Cannot check nullability and the nonnull attribute");
2948 AttrLoc = RetNNAttr->getLocation();
2949 CheckKind = SanitizerKind::ReturnsNonnullAttribute;
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00002950 Handler = SanitizerHandler::NonnullReturn;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00002951 } else {
Vedant Kumar42c17ec2017-03-14 01:56:34 +00002952 if (auto *DD = dyn_cast<DeclaratorDecl>(CurCodeDecl))
2953 if (auto *TSI = DD->getTypeSourceInfo())
2954 if (auto FTL = TSI->getTypeLoc().castAs<FunctionTypeLoc>())
2955 AttrLoc = FTL.getReturnLoc().findNullabilityLoc();
2956 CheckKind = SanitizerKind::NullabilityReturn;
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00002957 Handler = SanitizerHandler::NullabilityReturn;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00002958 }
2959
2960 SanitizerScope SanScope(this);
2961
Vedant Kumarc34d3432017-06-23 21:32:38 +00002962 // Make sure the "return" source location is valid. If we're checking a
2963 // nullability annotation, make sure the preconditions for the check are met.
2964 llvm::BasicBlock *Check = createBasicBlock("nullcheck");
2965 llvm::BasicBlock *NoCheck = createBasicBlock("no.nullcheck");
2966 llvm::Value *SLocPtr = Builder.CreateLoad(ReturnLocation, "return.sloc.load");
2967 llvm::Value *CanNullCheck = Builder.CreateIsNotNull(SLocPtr);
Vedant Kumar42c17ec2017-03-14 01:56:34 +00002968 if (requiresReturnValueNullabilityCheck())
Vedant Kumarc34d3432017-06-23 21:32:38 +00002969 CanNullCheck =
2970 Builder.CreateAnd(CanNullCheck, RetValNullabilityPrecondition);
2971 Builder.CreateCondBr(CanNullCheck, Check, NoCheck);
2972 EmitBlock(Check);
2973
2974 // Now do the null check.
2975 llvm::Value *Cond = Builder.CreateIsNotNull(RV);
2976 llvm::Constant *StaticData[] = {EmitCheckSourceLocation(AttrLoc)};
2977 llvm::Value *DynamicData[] = {SLocPtr};
2978 EmitCheck(std::make_pair(Cond, CheckKind), Handler, StaticData, DynamicData);
2979
2980 EmitBlock(NoCheck);
2981
2982#ifndef NDEBUG
2983 // The return location should not be used after the check has been emitted.
2984 ReturnLocation = Address::invalid();
2985#endif
Vedant Kumar42c17ec2017-03-14 01:56:34 +00002986}
2987
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002988static bool isInAllocaArgument(CGCXXABI &ABI, QualType type) {
2989 const CXXRecordDecl *RD = type->getAsCXXRecordDecl();
2990 return RD && ABI.getRecordArgABI(RD) == CGCXXABI::RAA_DirectInMemory;
2991}
2992
John McCall7f416cc2015-09-08 08:05:57 +00002993static AggValueSlot createPlaceholderSlot(CodeGenFunction &CGF,
2994 QualType Ty) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002995 // FIXME: Generate IR in one pass, rather than going back and fixing up these
2996 // placeholders.
2997 llvm::Type *IRTy = CGF.ConvertTypeForMem(Ty);
Peter Collingbourneb367c562016-11-28 22:30:21 +00002998 llvm::Type *IRPtrTy = IRTy->getPointerTo();
2999 llvm::Value *Placeholder = llvm::UndefValue::get(IRPtrTy->getPointerTo());
John McCall7f416cc2015-09-08 08:05:57 +00003000
3001 // FIXME: When we generate this IR in one pass, we shouldn't need
3002 // this win32-specific alignment hack.
3003 CharUnits Align = CharUnits::fromQuantity(4);
Peter Collingbourneb367c562016-11-28 22:30:21 +00003004 Placeholder = CGF.Builder.CreateAlignedLoad(IRPtrTy, Placeholder, Align);
John McCall7f416cc2015-09-08 08:05:57 +00003005
3006 return AggValueSlot::forAddr(Address(Placeholder, Align),
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003007 Ty.getQualifiers(),
3008 AggValueSlot::IsNotDestructed,
3009 AggValueSlot::DoesNotNeedGCBarriers,
3010 AggValueSlot::IsNotAliased);
3011}
3012
John McCall32ea9692011-03-11 20:59:21 +00003013void CodeGenFunction::EmitDelegateCallArg(CallArgList &args,
Nick Lewycky2d84e842013-10-02 02:29:49 +00003014 const VarDecl *param,
3015 SourceLocation loc) {
John McCall23f66262010-05-26 22:34:26 +00003016 // StartFunction converted the ABI-lowered parameter(s) into a
3017 // local alloca. We need to turn that into an r-value suitable
3018 // for EmitCall.
John McCall7f416cc2015-09-08 08:05:57 +00003019 Address local = GetAddrOfLocalVar(param);
John McCall23f66262010-05-26 22:34:26 +00003020
John McCall32ea9692011-03-11 20:59:21 +00003021 QualType type = param->getType();
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003022
Reid Klecknerab2090d2014-07-26 01:34:32 +00003023 assert(!isInAllocaArgument(CGM.getCXXABI(), type) &&
3024 "cannot emit delegate call arguments for inalloca arguments!");
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003025
John McCall811b2912016-11-18 01:08:24 +00003026 // GetAddrOfLocalVar returns a pointer-to-pointer for references,
3027 // but the argument needs to be the original pointer.
3028 if (type->isReferenceType()) {
3029 args.add(RValue::get(Builder.CreateLoad(local)), type);
3030
3031 // In ARC, move out of consumed arguments so that the release cleanup
3032 // entered by StartFunction doesn't cause an over-release. This isn't
3033 // optimal -O0 code generation, but it should get cleaned up when
3034 // optimization is enabled. This also assumes that delegate calls are
3035 // performed exactly once for a set of arguments, but that should be safe.
3036 } else if (getLangOpts().ObjCAutoRefCount &&
3037 param->hasAttr<NSConsumedAttr>() &&
3038 type->isObjCRetainableType()) {
3039 llvm::Value *ptr = Builder.CreateLoad(local);
3040 auto null =
3041 llvm::ConstantPointerNull::get(cast<llvm::PointerType>(ptr->getType()));
3042 Builder.CreateStore(null, local);
3043 args.add(RValue::get(ptr), type);
3044
Richard Smithd62d4982016-06-14 01:13:21 +00003045 // For the most part, we just need to load the alloca, except that
3046 // aggregate r-values are actually pointers to temporaries.
John McCall811b2912016-11-18 01:08:24 +00003047 } else {
Richard Smithd62d4982016-06-14 01:13:21 +00003048 args.add(convertTempToRValue(local, type, loc), type);
John McCall811b2912016-11-18 01:08:24 +00003049 }
John McCall23f66262010-05-26 22:34:26 +00003050}
3051
John McCall31168b02011-06-15 23:02:42 +00003052static bool isProvablyNull(llvm::Value *addr) {
3053 return isa<llvm::ConstantPointerNull>(addr);
3054}
3055
John McCall31168b02011-06-15 23:02:42 +00003056/// Emit the actual writing-back of a writeback.
3057static void emitWriteback(CodeGenFunction &CGF,
3058 const CallArgList::Writeback &writeback) {
John McCalleff18842013-03-23 02:35:54 +00003059 const LValue &srcLV = writeback.Source;
John McCall7f416cc2015-09-08 08:05:57 +00003060 Address srcAddr = srcLV.getAddress();
3061 assert(!isProvablyNull(srcAddr.getPointer()) &&
John McCall31168b02011-06-15 23:02:42 +00003062 "shouldn't have writeback for provably null argument");
3063
Craig Topper8a13c412014-05-21 05:09:00 +00003064 llvm::BasicBlock *contBB = nullptr;
John McCall31168b02011-06-15 23:02:42 +00003065
3066 // If the argument wasn't provably non-null, we need to null check
3067 // before doing the store.
Nuno Lopes9211cee2017-09-09 18:25:36 +00003068 bool provablyNonNull = llvm::isKnownNonZero(srcAddr.getPointer(),
3069 CGF.CGM.getDataLayout());
John McCall31168b02011-06-15 23:02:42 +00003070 if (!provablyNonNull) {
3071 llvm::BasicBlock *writebackBB = CGF.createBasicBlock("icr.writeback");
3072 contBB = CGF.createBasicBlock("icr.done");
3073
John McCall7f416cc2015-09-08 08:05:57 +00003074 llvm::Value *isNull =
3075 CGF.Builder.CreateIsNull(srcAddr.getPointer(), "icr.isnull");
John McCall31168b02011-06-15 23:02:42 +00003076 CGF.Builder.CreateCondBr(isNull, contBB, writebackBB);
3077 CGF.EmitBlock(writebackBB);
3078 }
3079
3080 // Load the value to writeback.
3081 llvm::Value *value = CGF.Builder.CreateLoad(writeback.Temporary);
3082
3083 // Cast it back, in case we're writing an id to a Foo* or something.
John McCall7f416cc2015-09-08 08:05:57 +00003084 value = CGF.Builder.CreateBitCast(value, srcAddr.getElementType(),
3085 "icr.writeback-cast");
John McCall31168b02011-06-15 23:02:42 +00003086
3087 // Perform the writeback.
John McCalleff18842013-03-23 02:35:54 +00003088
3089 // If we have a "to use" value, it's something we need to emit a use
3090 // of. This has to be carefully threaded in: if it's done after the
3091 // release it's potentially undefined behavior (and the optimizer
3092 // will ignore it), and if it happens before the retain then the
3093 // optimizer could move the release there.
3094 if (writeback.ToUse) {
3095 assert(srcLV.getObjCLifetime() == Qualifiers::OCL_Strong);
3096
3097 // Retain the new value. No need to block-copy here: the block's
3098 // being passed up the stack.
3099 value = CGF.EmitARCRetainNonBlock(value);
3100
3101 // Emit the intrinsic use here.
3102 CGF.EmitARCIntrinsicUse(writeback.ToUse);
3103
3104 // Load the old value (primitively).
Nick Lewycky2d84e842013-10-02 02:29:49 +00003105 llvm::Value *oldValue = CGF.EmitLoadOfScalar(srcLV, SourceLocation());
John McCalleff18842013-03-23 02:35:54 +00003106
3107 // Put the new value in place (primitively).
3108 CGF.EmitStoreOfScalar(value, srcLV, /*init*/ false);
3109
3110 // Release the old value.
3111 CGF.EmitARCRelease(oldValue, srcLV.isARCPreciseLifetime());
3112
3113 // Otherwise, we can just do a normal lvalue store.
3114 } else {
3115 CGF.EmitStoreThroughLValue(RValue::get(value), srcLV);
3116 }
John McCall31168b02011-06-15 23:02:42 +00003117
3118 // Jump to the continuation block.
3119 if (!provablyNonNull)
3120 CGF.EmitBlock(contBB);
3121}
3122
3123static void emitWritebacks(CodeGenFunction &CGF,
3124 const CallArgList &args) {
Aaron Ballman36a7fa82014-03-17 17:22:27 +00003125 for (const auto &I : args.writebacks())
3126 emitWriteback(CGF, I);
John McCall31168b02011-06-15 23:02:42 +00003127}
3128
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003129static void deactivateArgCleanupsBeforeCall(CodeGenFunction &CGF,
3130 const CallArgList &CallArgs) {
Reid Kleckner739756c2013-12-04 19:23:12 +00003131 assert(CGF.getTarget().getCXXABI().areArgsDestroyedLeftToRightInCallee());
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003132 ArrayRef<CallArgList::CallArgCleanup> Cleanups =
3133 CallArgs.getCleanupsToDeactivate();
3134 // Iterate in reverse to increase the likelihood of popping the cleanup.
Pete Cooper57d3f142015-07-30 17:22:52 +00003135 for (const auto &I : llvm::reverse(Cleanups)) {
3136 CGF.DeactivateCleanupBlock(I.Cleanup, I.IsActiveIP);
3137 I.IsActiveIP->eraseFromParent();
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003138 }
3139}
3140
John McCalleff18842013-03-23 02:35:54 +00003141static const Expr *maybeGetUnaryAddrOfOperand(const Expr *E) {
3142 if (const UnaryOperator *uop = dyn_cast<UnaryOperator>(E->IgnoreParens()))
3143 if (uop->getOpcode() == UO_AddrOf)
3144 return uop->getSubExpr();
Craig Topper8a13c412014-05-21 05:09:00 +00003145 return nullptr;
John McCalleff18842013-03-23 02:35:54 +00003146}
3147
John McCall31168b02011-06-15 23:02:42 +00003148/// Emit an argument that's being passed call-by-writeback. That is,
John McCall7f416cc2015-09-08 08:05:57 +00003149/// we are passing the address of an __autoreleased temporary; it
3150/// might be copy-initialized with the current value of the given
3151/// address, but it will definitely be copied out of after the call.
John McCall31168b02011-06-15 23:02:42 +00003152static void emitWritebackArg(CodeGenFunction &CGF, CallArgList &args,
3153 const ObjCIndirectCopyRestoreExpr *CRE) {
John McCalleff18842013-03-23 02:35:54 +00003154 LValue srcLV;
3155
3156 // Make an optimistic effort to emit the address as an l-value.
Eric Christopher2c4555a2015-06-19 01:52:53 +00003157 // This can fail if the argument expression is more complicated.
John McCalleff18842013-03-23 02:35:54 +00003158 if (const Expr *lvExpr = maybeGetUnaryAddrOfOperand(CRE->getSubExpr())) {
3159 srcLV = CGF.EmitLValue(lvExpr);
3160
3161 // Otherwise, just emit it as a scalar.
3162 } else {
John McCall7f416cc2015-09-08 08:05:57 +00003163 Address srcAddr = CGF.EmitPointerWithAlignment(CRE->getSubExpr());
John McCalleff18842013-03-23 02:35:54 +00003164
3165 QualType srcAddrType =
3166 CRE->getSubExpr()->getType()->castAs<PointerType>()->getPointeeType();
John McCall7f416cc2015-09-08 08:05:57 +00003167 srcLV = CGF.MakeAddrLValue(srcAddr, srcAddrType);
John McCalleff18842013-03-23 02:35:54 +00003168 }
John McCall7f416cc2015-09-08 08:05:57 +00003169 Address srcAddr = srcLV.getAddress();
John McCall31168b02011-06-15 23:02:42 +00003170
3171 // The dest and src types don't necessarily match in LLVM terms
3172 // because of the crazy ObjC compatibility rules.
3173
Chris Lattner2192fe52011-07-18 04:24:23 +00003174 llvm::PointerType *destType =
John McCall31168b02011-06-15 23:02:42 +00003175 cast<llvm::PointerType>(CGF.ConvertType(CRE->getType()));
3176
3177 // If the address is a constant null, just pass the appropriate null.
John McCall7f416cc2015-09-08 08:05:57 +00003178 if (isProvablyNull(srcAddr.getPointer())) {
John McCall31168b02011-06-15 23:02:42 +00003179 args.add(RValue::get(llvm::ConstantPointerNull::get(destType)),
3180 CRE->getType());
3181 return;
3182 }
3183
John McCall31168b02011-06-15 23:02:42 +00003184 // Create the temporary.
John McCall7f416cc2015-09-08 08:05:57 +00003185 Address temp = CGF.CreateTempAlloca(destType->getElementType(),
3186 CGF.getPointerAlign(),
3187 "icr.temp");
Fariborz Jahanianfbd19742012-11-27 23:02:53 +00003188 // Loading an l-value can introduce a cleanup if the l-value is __weak,
3189 // and that cleanup will be conditional if we can't prove that the l-value
3190 // isn't null, so we need to register a dominating point so that the cleanups
3191 // system will make valid IR.
3192 CodeGenFunction::ConditionalEvaluation condEval(CGF);
3193
John McCall31168b02011-06-15 23:02:42 +00003194 // Zero-initialize it if we're not doing a copy-initialization.
3195 bool shouldCopy = CRE->shouldCopy();
3196 if (!shouldCopy) {
3197 llvm::Value *null =
3198 llvm::ConstantPointerNull::get(
3199 cast<llvm::PointerType>(destType->getElementType()));
3200 CGF.Builder.CreateStore(null, temp);
3201 }
Craig Topper8a13c412014-05-21 05:09:00 +00003202
3203 llvm::BasicBlock *contBB = nullptr;
3204 llvm::BasicBlock *originBB = nullptr;
John McCall31168b02011-06-15 23:02:42 +00003205
3206 // If the address is *not* known to be non-null, we need to switch.
3207 llvm::Value *finalArgument;
3208
Nuno Lopes9211cee2017-09-09 18:25:36 +00003209 bool provablyNonNull = llvm::isKnownNonZero(srcAddr.getPointer(),
3210 CGF.CGM.getDataLayout());
John McCall31168b02011-06-15 23:02:42 +00003211 if (provablyNonNull) {
John McCall7f416cc2015-09-08 08:05:57 +00003212 finalArgument = temp.getPointer();
John McCall31168b02011-06-15 23:02:42 +00003213 } else {
John McCall7f416cc2015-09-08 08:05:57 +00003214 llvm::Value *isNull =
3215 CGF.Builder.CreateIsNull(srcAddr.getPointer(), "icr.isnull");
John McCall31168b02011-06-15 23:02:42 +00003216
3217 finalArgument = CGF.Builder.CreateSelect(isNull,
3218 llvm::ConstantPointerNull::get(destType),
John McCall7f416cc2015-09-08 08:05:57 +00003219 temp.getPointer(), "icr.argument");
John McCall31168b02011-06-15 23:02:42 +00003220
3221 // If we need to copy, then the load has to be conditional, which
3222 // means we need control flow.
3223 if (shouldCopy) {
John McCalleff18842013-03-23 02:35:54 +00003224 originBB = CGF.Builder.GetInsertBlock();
John McCall31168b02011-06-15 23:02:42 +00003225 contBB = CGF.createBasicBlock("icr.cont");
3226 llvm::BasicBlock *copyBB = CGF.createBasicBlock("icr.copy");
3227 CGF.Builder.CreateCondBr(isNull, contBB, copyBB);
3228 CGF.EmitBlock(copyBB);
Fariborz Jahanianfbd19742012-11-27 23:02:53 +00003229 condEval.begin(CGF);
John McCall31168b02011-06-15 23:02:42 +00003230 }
3231 }
3232
Craig Topper8a13c412014-05-21 05:09:00 +00003233 llvm::Value *valueToUse = nullptr;
John McCalleff18842013-03-23 02:35:54 +00003234
John McCall31168b02011-06-15 23:02:42 +00003235 // Perform a copy if necessary.
3236 if (shouldCopy) {
Nick Lewycky2d84e842013-10-02 02:29:49 +00003237 RValue srcRV = CGF.EmitLoadOfLValue(srcLV, SourceLocation());
John McCall31168b02011-06-15 23:02:42 +00003238 assert(srcRV.isScalar());
3239
3240 llvm::Value *src = srcRV.getScalarVal();
3241 src = CGF.Builder.CreateBitCast(src, destType->getElementType(),
3242 "icr.cast");
3243
3244 // Use an ordinary store, not a store-to-lvalue.
3245 CGF.Builder.CreateStore(src, temp);
John McCalleff18842013-03-23 02:35:54 +00003246
3247 // If optimization is enabled, and the value was held in a
3248 // __strong variable, we need to tell the optimizer that this
3249 // value has to stay alive until we're doing the store back.
3250 // This is because the temporary is effectively unretained,
3251 // and so otherwise we can violate the high-level semantics.
3252 if (CGF.CGM.getCodeGenOpts().OptimizationLevel != 0 &&
3253 srcLV.getObjCLifetime() == Qualifiers::OCL_Strong) {
3254 valueToUse = src;
3255 }
John McCall31168b02011-06-15 23:02:42 +00003256 }
Fariborz Jahanianfbd19742012-11-27 23:02:53 +00003257
John McCall31168b02011-06-15 23:02:42 +00003258 // Finish the control flow if we needed it.
Fariborz Jahanianfbd19742012-11-27 23:02:53 +00003259 if (shouldCopy && !provablyNonNull) {
John McCalleff18842013-03-23 02:35:54 +00003260 llvm::BasicBlock *copyBB = CGF.Builder.GetInsertBlock();
John McCall31168b02011-06-15 23:02:42 +00003261 CGF.EmitBlock(contBB);
John McCalleff18842013-03-23 02:35:54 +00003262
3263 // Make a phi for the value to intrinsically use.
3264 if (valueToUse) {
3265 llvm::PHINode *phiToUse = CGF.Builder.CreatePHI(valueToUse->getType(), 2,
3266 "icr.to-use");
3267 phiToUse->addIncoming(valueToUse, copyBB);
3268 phiToUse->addIncoming(llvm::UndefValue::get(valueToUse->getType()),
3269 originBB);
3270 valueToUse = phiToUse;
3271 }
3272
Fariborz Jahanianfbd19742012-11-27 23:02:53 +00003273 condEval.end(CGF);
3274 }
John McCall31168b02011-06-15 23:02:42 +00003275
John McCalleff18842013-03-23 02:35:54 +00003276 args.addWriteback(srcLV, temp, valueToUse);
John McCall31168b02011-06-15 23:02:42 +00003277 args.add(RValue::get(finalArgument), CRE->getType());
3278}
3279
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003280void CallArgList::allocateArgumentMemory(CodeGenFunction &CGF) {
Richard Smith762672a2016-09-28 19:09:10 +00003281 assert(!StackBase);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003282
3283 // Save the stack.
3284 llvm::Function *F = CGF.CGM.getIntrinsic(llvm::Intrinsic::stacksave);
David Blaikie43f9bb72015-05-18 22:14:03 +00003285 StackBase = CGF.Builder.CreateCall(F, {}, "inalloca.save");
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003286}
3287
Nico Weber8cdb3f92015-08-25 18:43:32 +00003288void CallArgList::freeArgumentMemory(CodeGenFunction &CGF) const {
3289 if (StackBase) {
Reid Kleckner7c2f9e82015-10-08 00:17:45 +00003290 // Restore the stack after the call.
Nico Weber8cdb3f92015-08-25 18:43:32 +00003291 llvm::Value *F = CGF.CGM.getIntrinsic(llvm::Intrinsic::stackrestore);
Nico Weber8cdb3f92015-08-25 18:43:32 +00003292 CGF.Builder.CreateCall(F, StackBase);
3293 }
3294}
3295
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003296void CodeGenFunction::EmitNonNullArgCheck(RValue RV, QualType ArgType,
3297 SourceLocation ArgLoc,
Vedant Kumared00ea02017-03-06 05:28:22 +00003298 AbstractCallee AC,
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003299 unsigned ParmNum) {
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003300 if (!AC.getDecl() || !(SanOpts.has(SanitizerKind::NonnullAttribute) ||
3301 SanOpts.has(SanitizerKind::NullabilityArg)))
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003302 return;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003303
3304 // The param decl may be missing in a variadic function.
Vedant Kumared00ea02017-03-06 05:28:22 +00003305 auto PVD = ParmNum < AC.getNumParams() ? AC.getParamDecl(ParmNum) : nullptr;
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003306 unsigned ArgNo = PVD ? PVD->getFunctionScopeIndex() : ParmNum;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003307
3308 // Prefer the nonnull attribute if it's present.
3309 const NonNullAttr *NNAttr = nullptr;
3310 if (SanOpts.has(SanitizerKind::NonnullAttribute))
3311 NNAttr = getNonNullAttr(AC.getDecl(), PVD, ArgType, ArgNo);
3312
3313 bool CanCheckNullability = false;
3314 if (SanOpts.has(SanitizerKind::NullabilityArg) && !NNAttr && PVD) {
3315 auto Nullability = PVD->getType()->getNullability(getContext());
3316 CanCheckNullability = Nullability &&
3317 *Nullability == NullabilityKind::NonNull &&
3318 PVD->getTypeSourceInfo();
3319 }
3320
3321 if (!NNAttr && !CanCheckNullability)
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003322 return;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003323
3324 SourceLocation AttrLoc;
3325 SanitizerMask CheckKind;
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00003326 SanitizerHandler Handler;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003327 if (NNAttr) {
3328 AttrLoc = NNAttr->getLocation();
3329 CheckKind = SanitizerKind::NonnullAttribute;
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00003330 Handler = SanitizerHandler::NonnullArg;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003331 } else {
3332 AttrLoc = PVD->getTypeSourceInfo()->getTypeLoc().findNullabilityLoc();
3333 CheckKind = SanitizerKind::NullabilityArg;
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00003334 Handler = SanitizerHandler::NullabilityArg;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003335 }
3336
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003337 SanitizerScope SanScope(this);
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003338 assert(RV.isScalar());
3339 llvm::Value *V = RV.getScalarVal();
3340 llvm::Value *Cond =
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003341 Builder.CreateICmpNE(V, llvm::Constant::getNullValue(V->getType()));
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003342 llvm::Constant *StaticData[] = {
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003343 EmitCheckSourceLocation(ArgLoc), EmitCheckSourceLocation(AttrLoc),
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003344 llvm::ConstantInt::get(Int32Ty, ArgNo + 1),
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003345 };
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00003346 EmitCheck(std::make_pair(Cond, CheckKind), Handler, StaticData, None);
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003347}
3348
David Blaikief05779e2015-07-21 18:37:18 +00003349void CodeGenFunction::EmitCallArgs(
3350 CallArgList &Args, ArrayRef<QualType> ArgTypes,
3351 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Vedant Kumared00ea02017-03-06 05:28:22 +00003352 AbstractCallee AC, unsigned ParamsToSkip, EvaluationOrder Order) {
David Blaikief05779e2015-07-21 18:37:18 +00003353 assert((int)ArgTypes.size() == (ArgRange.end() - ArgRange.begin()));
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003354
Reid Kleckner739756c2013-12-04 19:23:12 +00003355 // We *have* to evaluate arguments from right to left in the MS C++ ABI,
Richard Smitha560ccf2016-09-29 21:30:12 +00003356 // because arguments are destroyed left to right in the callee. As a special
3357 // case, there are certain language constructs that require left-to-right
3358 // evaluation, and in those cases we consider the evaluation order requirement
3359 // to trump the "destruction order is reverse construction order" guarantee.
3360 bool LeftToRight =
3361 CGM.getTarget().getCXXABI().areArgsDestroyedLeftToRightInCallee()
3362 ? Order == EvaluationOrder::ForceLeftToRight
3363 : Order != EvaluationOrder::ForceRightToLeft;
3364
George Burgess IV0d6592a2017-02-23 05:59:56 +00003365 auto MaybeEmitImplicitObjectSize = [&](unsigned I, const Expr *Arg,
3366 RValue EmittedArg) {
Vedant Kumared00ea02017-03-06 05:28:22 +00003367 if (!AC.hasFunctionDecl() || I >= AC.getNumParams())
George Burgess IV0d6592a2017-02-23 05:59:56 +00003368 return;
Vedant Kumared00ea02017-03-06 05:28:22 +00003369 auto *PS = AC.getParamDecl(I)->getAttr<PassObjectSizeAttr>();
George Burgess IV0d6592a2017-02-23 05:59:56 +00003370 if (PS == nullptr)
3371 return;
3372
3373 const auto &Context = getContext();
3374 auto SizeTy = Context.getSizeType();
3375 auto T = Builder.getIntNTy(Context.getTypeSize(SizeTy));
3376 assert(EmittedArg.getScalarVal() && "We emitted nothing for the arg?");
3377 llvm::Value *V = evaluateOrEmitBuiltinObjectSize(Arg, PS->getType(), T,
3378 EmittedArg.getScalarVal());
3379 Args.add(RValue::get(V), SizeTy);
3380 // If we're emitting args in reverse, be sure to do so with
3381 // pass_object_size, as well.
3382 if (!LeftToRight)
3383 std::swap(Args.back(), *(&Args.back() - 1));
3384 };
3385
Richard Smitha560ccf2016-09-29 21:30:12 +00003386 // Insert a stack save if we're going to need any inalloca args.
3387 bool HasInAllocaArgs = false;
3388 if (CGM.getTarget().getCXXABI().isMicrosoft()) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003389 for (ArrayRef<QualType>::iterator I = ArgTypes.begin(), E = ArgTypes.end();
3390 I != E && !HasInAllocaArgs; ++I)
3391 HasInAllocaArgs = isInAllocaArgument(CGM.getCXXABI(), *I);
3392 if (HasInAllocaArgs) {
3393 assert(getTarget().getTriple().getArch() == llvm::Triple::x86);
3394 Args.allocateArgumentMemory(*this);
3395 }
Richard Smitha560ccf2016-09-29 21:30:12 +00003396 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003397
Richard Smitha560ccf2016-09-29 21:30:12 +00003398 // Evaluate each argument in the appropriate order.
3399 size_t CallArgsStart = Args.size();
3400 for (unsigned I = 0, E = ArgTypes.size(); I != E; ++I) {
3401 unsigned Idx = LeftToRight ? I : E - I - 1;
3402 CallExpr::const_arg_iterator Arg = ArgRange.begin() + Idx;
George Burgess IV0d6592a2017-02-23 05:59:56 +00003403 unsigned InitialArgSize = Args.size();
Akira Hatanaka46dd7dbc2017-06-28 00:42:48 +00003404 // If *Arg is an ObjCIndirectCopyRestoreExpr, check that either the types of
3405 // the argument and parameter match or the objc method is parameterized.
3406 assert((!isa<ObjCIndirectCopyRestoreExpr>(*Arg) ||
3407 getContext().hasSameUnqualifiedType((*Arg)->getType(),
3408 ArgTypes[Idx]) ||
3409 (isa<ObjCMethodDecl>(AC.getDecl()) &&
3410 isObjCMethodWithTypeParams(cast<ObjCMethodDecl>(AC.getDecl())))) &&
3411 "Argument and parameter types don't match");
Richard Smitha560ccf2016-09-29 21:30:12 +00003412 EmitCallArg(Args, *Arg, ArgTypes[Idx]);
George Burgess IV0d6592a2017-02-23 05:59:56 +00003413 // In particular, we depend on it being the last arg in Args, and the
3414 // objectsize bits depend on there only being one arg if !LeftToRight.
3415 assert(InitialArgSize + 1 == Args.size() &&
3416 "The code below depends on only adding one arg per EmitCallArg");
3417 (void)InitialArgSize;
3418 RValue RVArg = Args.back().RV;
Vedant Kumared00ea02017-03-06 05:28:22 +00003419 EmitNonNullArgCheck(RVArg, ArgTypes[Idx], (*Arg)->getExprLoc(), AC,
George Burgess IV0d6592a2017-02-23 05:59:56 +00003420 ParamsToSkip + Idx);
3421 // @llvm.objectsize should never have side-effects and shouldn't need
3422 // destruction/cleanups, so we can safely "emit" it after its arg,
3423 // regardless of right-to-leftness
3424 MaybeEmitImplicitObjectSize(Idx, *Arg, RVArg);
Richard Smitha560ccf2016-09-29 21:30:12 +00003425 }
Reid Kleckner739756c2013-12-04 19:23:12 +00003426
Richard Smitha560ccf2016-09-29 21:30:12 +00003427 if (!LeftToRight) {
Reid Kleckner739756c2013-12-04 19:23:12 +00003428 // Un-reverse the arguments we just evaluated so they match up with the LLVM
3429 // IR function.
3430 std::reverse(Args.begin() + CallArgsStart, Args.end());
Reid Kleckner739756c2013-12-04 19:23:12 +00003431 }
3432}
3433
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003434namespace {
3435
David Blaikie7e70d682015-08-18 22:40:54 +00003436struct DestroyUnpassedArg final : EHScopeStack::Cleanup {
John McCall7f416cc2015-09-08 08:05:57 +00003437 DestroyUnpassedArg(Address Addr, QualType Ty)
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003438 : Addr(Addr), Ty(Ty) {}
3439
John McCall7f416cc2015-09-08 08:05:57 +00003440 Address Addr;
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003441 QualType Ty;
3442
Craig Topper4f12f102014-03-12 06:41:41 +00003443 void Emit(CodeGenFunction &CGF, Flags flags) override {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003444 const CXXDestructorDecl *Dtor = Ty->getAsCXXRecordDecl()->getDestructor();
3445 assert(!Dtor->isTrivial());
3446 CGF.EmitCXXDestructorCall(Dtor, Dtor_Complete, /*for vbase*/ false,
3447 /*Delegating=*/false, Addr);
3448 }
3449};
3450
David Blaikie38b25912015-02-09 19:13:51 +00003451struct DisableDebugLocationUpdates {
3452 CodeGenFunction &CGF;
3453 bool disabledDebugInfo;
3454 DisableDebugLocationUpdates(CodeGenFunction &CGF, const Expr *E) : CGF(CGF) {
3455 if ((disabledDebugInfo = isa<CXXDefaultArgExpr>(E) && CGF.getDebugInfo()))
3456 CGF.disableDebugInfo();
3457 }
3458 ~DisableDebugLocationUpdates() {
3459 if (disabledDebugInfo)
3460 CGF.enableDebugInfo();
3461 }
3462};
3463
Benjamin Kramer5b4296a2015-10-28 17:16:26 +00003464} // end anonymous namespace
3465
John McCall32ea9692011-03-11 20:59:21 +00003466void CodeGenFunction::EmitCallArg(CallArgList &args, const Expr *E,
3467 QualType type) {
David Blaikie38b25912015-02-09 19:13:51 +00003468 DisableDebugLocationUpdates Dis(*this, E);
John McCall31168b02011-06-15 23:02:42 +00003469 if (const ObjCIndirectCopyRestoreExpr *CRE
3470 = dyn_cast<ObjCIndirectCopyRestoreExpr>(E)) {
Richard Smith9c6890a2012-11-01 22:30:59 +00003471 assert(getLangOpts().ObjCAutoRefCount);
John McCall31168b02011-06-15 23:02:42 +00003472 return emitWritebackArg(*this, args, CRE);
3473 }
3474
John McCall0a76c0c2011-08-26 18:42:59 +00003475 assert(type->isReferenceType() == E->isGLValue() &&
3476 "reference binding to unmaterialized r-value!");
3477
John McCall17054bd62011-08-26 21:08:13 +00003478 if (E->isGLValue()) {
3479 assert(E->getObjectKind() == OK_Ordinary);
Richard Smitha1c9d4d2013-06-12 23:38:09 +00003480 return args.add(EmitReferenceBindingToExpr(E), type);
John McCall17054bd62011-08-26 21:08:13 +00003481 }
Mike Stump11289f42009-09-09 15:08:12 +00003482
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003483 bool HasAggregateEvalKind = hasAggregateEvaluationKind(type);
3484
3485 // In the Microsoft C++ ABI, aggregate arguments are destructed by the callee.
3486 // However, we still have to push an EH-only cleanup in case we unwind before
3487 // we make it to the call.
Reid Klecknerac640602014-05-01 03:07:18 +00003488 if (HasAggregateEvalKind &&
3489 CGM.getTarget().getCXXABI().areArgsDestroyedLeftToRightInCallee()) {
3490 // If we're using inalloca, use the argument memory. Otherwise, use a
Reid Klecknere39ee212014-05-03 00:33:28 +00003491 // temporary.
Reid Klecknerac640602014-05-01 03:07:18 +00003492 AggValueSlot Slot;
3493 if (args.isUsingInAlloca())
3494 Slot = createPlaceholderSlot(*this, type);
3495 else
3496 Slot = CreateAggTemp(type, "agg.tmp");
Reid Klecknere39ee212014-05-03 00:33:28 +00003497
3498 const CXXRecordDecl *RD = type->getAsCXXRecordDecl();
3499 bool DestroyedInCallee =
3500 RD && RD->hasNonTrivialDestructor() &&
3501 CGM.getCXXABI().getRecordArgABI(RD) != CGCXXABI::RAA_Default;
3502 if (DestroyedInCallee)
3503 Slot.setExternallyDestructed();
3504
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003505 EmitAggExpr(E, Slot);
3506 RValue RV = Slot.asRValue();
3507 args.add(RV, type);
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003508
Reid Klecknere39ee212014-05-03 00:33:28 +00003509 if (DestroyedInCallee) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003510 // Create a no-op GEP between the placeholder and the cleanup so we can
3511 // RAUW it successfully. It also serves as a marker of the first
3512 // instruction where the cleanup is active.
John McCall7f416cc2015-09-08 08:05:57 +00003513 pushFullExprCleanup<DestroyUnpassedArg>(EHCleanup, Slot.getAddress(),
3514 type);
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003515 // This unreachable is a temporary marker which will be removed later.
3516 llvm::Instruction *IsActive = Builder.CreateUnreachable();
3517 args.addArgCleanupDeactivation(EHStack.getInnermostEHScope(), IsActive);
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003518 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003519 return;
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003520 }
3521
3522 if (HasAggregateEvalKind && isa<ImplicitCastExpr>(E) &&
Eli Friedmandf968192011-05-26 00:10:27 +00003523 cast<CastExpr>(E)->getCastKind() == CK_LValueToRValue) {
3524 LValue L = EmitLValue(cast<CastExpr>(E)->getSubExpr());
3525 assert(L.isSimple());
Eli Friedman61f615a2013-06-11 01:08:22 +00003526 if (L.getAlignment() >= getContext().getTypeAlignInChars(type)) {
3527 args.add(L.asAggregateRValue(), type, /*NeedsCopy*/true);
3528 } else {
3529 // We can't represent a misaligned lvalue in the CallArgList, so copy
3530 // to an aligned temporary now.
John McCall7f416cc2015-09-08 08:05:57 +00003531 Address tmp = CreateMemTemp(type);
3532 EmitAggregateCopy(tmp, L.getAddress(), type, L.isVolatile());
Eli Friedman61f615a2013-06-11 01:08:22 +00003533 args.add(RValue::getAggregate(tmp), type);
3534 }
Eli Friedmandf968192011-05-26 00:10:27 +00003535 return;
3536 }
3537
John McCall32ea9692011-03-11 20:59:21 +00003538 args.add(EmitAnyExprToTemp(E), type);
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00003539}
3540
Reid Kleckner79b0fd72014-10-10 00:05:45 +00003541QualType CodeGenFunction::getVarArgType(const Expr *Arg) {
3542 // System headers on Windows define NULL to 0 instead of 0LL on Win64. MSVC
3543 // implicitly widens null pointer constants that are arguments to varargs
3544 // functions to pointer-sized ints.
3545 if (!getTarget().getTriple().isOSWindows())
3546 return Arg->getType();
3547
3548 if (Arg->getType()->isIntegerType() &&
3549 getContext().getTypeSize(Arg->getType()) <
3550 getContext().getTargetInfo().getPointerWidth(0) &&
3551 Arg->isNullPointerConstant(getContext(),
3552 Expr::NPC_ValueDependentIsNotNull)) {
3553 return getContext().getIntPtrType();
3554 }
3555
3556 return Arg->getType();
3557}
3558
Dan Gohman515a60d2012-02-16 00:57:37 +00003559// In ObjC ARC mode with no ObjC ARC exception safety, tell the ARC
3560// optimizer it can aggressively ignore unwind edges.
3561void
3562CodeGenFunction::AddObjCARCExceptionMetadata(llvm::Instruction *Inst) {
3563 if (CGM.getCodeGenOpts().OptimizationLevel != 0 &&
3564 !CGM.getCodeGenOpts().ObjCAutoRefCountExceptions)
3565 Inst->setMetadata("clang.arc.no_objc_arc_exceptions",
3566 CGM.getNoObjCARCExceptionsMetadata());
3567}
3568
John McCall882987f2013-02-28 19:01:20 +00003569/// Emits a call to the given no-arguments nounwind runtime function.
3570llvm::CallInst *
3571CodeGenFunction::EmitNounwindRuntimeCall(llvm::Value *callee,
3572 const llvm::Twine &name) {
Craig Topper5fc8fc22014-08-27 06:28:36 +00003573 return EmitNounwindRuntimeCall(callee, None, name);
John McCall882987f2013-02-28 19:01:20 +00003574}
3575
3576/// Emits a call to the given nounwind runtime function.
3577llvm::CallInst *
3578CodeGenFunction::EmitNounwindRuntimeCall(llvm::Value *callee,
3579 ArrayRef<llvm::Value*> args,
3580 const llvm::Twine &name) {
3581 llvm::CallInst *call = EmitRuntimeCall(callee, args, name);
3582 call->setDoesNotThrow();
3583 return call;
3584}
3585
3586/// Emits a simple call (never an invoke) to the given no-arguments
3587/// runtime function.
3588llvm::CallInst *
3589CodeGenFunction::EmitRuntimeCall(llvm::Value *callee,
3590 const llvm::Twine &name) {
Craig Topper5fc8fc22014-08-27 06:28:36 +00003591 return EmitRuntimeCall(callee, None, name);
John McCall882987f2013-02-28 19:01:20 +00003592}
3593
David Majnemer0b17d442015-12-15 21:27:59 +00003594// Calls which may throw must have operand bundles indicating which funclet
3595// they are nested within.
3596static void
Sanjay Patel846b63b2016-01-18 22:15:33 +00003597getBundlesForFunclet(llvm::Value *Callee, llvm::Instruction *CurrentFuncletPad,
David Majnemer0b17d442015-12-15 21:27:59 +00003598 SmallVectorImpl<llvm::OperandBundleDef> &BundleList) {
Sanjay Patel846b63b2016-01-18 22:15:33 +00003599 // There is no need for a funclet operand bundle if we aren't inside a
3600 // funclet.
David Majnemer0b17d442015-12-15 21:27:59 +00003601 if (!CurrentFuncletPad)
3602 return;
3603
3604 // Skip intrinsics which cannot throw.
3605 auto *CalleeFn = dyn_cast<llvm::Function>(Callee->stripPointerCasts());
3606 if (CalleeFn && CalleeFn->isIntrinsic() && CalleeFn->doesNotThrow())
3607 return;
3608
3609 BundleList.emplace_back("funclet", CurrentFuncletPad);
3610}
3611
David Majnemer971d31b2016-02-24 17:02:45 +00003612/// Emits a simple call (never an invoke) to the given runtime function.
3613llvm::CallInst *
3614CodeGenFunction::EmitRuntimeCall(llvm::Value *callee,
3615 ArrayRef<llvm::Value*> args,
3616 const llvm::Twine &name) {
3617 SmallVector<llvm::OperandBundleDef, 1> BundleList;
3618 getBundlesForFunclet(callee, CurrentFuncletPad, BundleList);
3619
3620 llvm::CallInst *call = Builder.CreateCall(callee, args, BundleList, name);
3621 call->setCallingConv(getRuntimeCC());
3622 return call;
3623}
3624
John McCall882987f2013-02-28 19:01:20 +00003625/// Emits a call or invoke to the given noreturn runtime function.
3626void CodeGenFunction::EmitNoreturnRuntimeCallOrInvoke(llvm::Value *callee,
3627 ArrayRef<llvm::Value*> args) {
David Majnemer0b17d442015-12-15 21:27:59 +00003628 SmallVector<llvm::OperandBundleDef, 1> BundleList;
3629 getBundlesForFunclet(callee, CurrentFuncletPad, BundleList);
3630
John McCall882987f2013-02-28 19:01:20 +00003631 if (getInvokeDest()) {
3632 llvm::InvokeInst *invoke =
3633 Builder.CreateInvoke(callee,
3634 getUnreachableBlock(),
3635 getInvokeDest(),
David Majnemer0b17d442015-12-15 21:27:59 +00003636 args,
3637 BundleList);
John McCall882987f2013-02-28 19:01:20 +00003638 invoke->setDoesNotReturn();
3639 invoke->setCallingConv(getRuntimeCC());
3640 } else {
David Majnemer0b17d442015-12-15 21:27:59 +00003641 llvm::CallInst *call = Builder.CreateCall(callee, args, BundleList);
John McCall882987f2013-02-28 19:01:20 +00003642 call->setDoesNotReturn();
3643 call->setCallingConv(getRuntimeCC());
3644 Builder.CreateUnreachable();
3645 }
3646}
3647
Sanjay Patel846b63b2016-01-18 22:15:33 +00003648/// Emits a call or invoke instruction to the given nullary runtime function.
John McCall882987f2013-02-28 19:01:20 +00003649llvm::CallSite
3650CodeGenFunction::EmitRuntimeCallOrInvoke(llvm::Value *callee,
3651 const Twine &name) {
Craig Topper5fc8fc22014-08-27 06:28:36 +00003652 return EmitRuntimeCallOrInvoke(callee, None, name);
John McCall882987f2013-02-28 19:01:20 +00003653}
3654
3655/// Emits a call or invoke instruction to the given runtime function.
3656llvm::CallSite
3657CodeGenFunction::EmitRuntimeCallOrInvoke(llvm::Value *callee,
3658 ArrayRef<llvm::Value*> args,
3659 const Twine &name) {
3660 llvm::CallSite callSite = EmitCallOrInvoke(callee, args, name);
3661 callSite.setCallingConv(getRuntimeCC());
3662 return callSite;
3663}
3664
John McCallbd309292010-07-06 01:34:17 +00003665/// Emits a call or invoke instruction to the given function, depending
3666/// on the current state of the EH stack.
3667llvm::CallSite
3668CodeGenFunction::EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner54b16772011-07-23 17:14:25 +00003669 ArrayRef<llvm::Value *> Args,
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003670 const Twine &Name) {
John McCallbd309292010-07-06 01:34:17 +00003671 llvm::BasicBlock *InvokeDest = getInvokeDest();
David Majnemer3df77bc2016-01-26 23:14:47 +00003672 SmallVector<llvm::OperandBundleDef, 1> BundleList;
3673 getBundlesForFunclet(Callee, CurrentFuncletPad, BundleList);
John McCallbd309292010-07-06 01:34:17 +00003674
Dan Gohman515a60d2012-02-16 00:57:37 +00003675 llvm::Instruction *Inst;
3676 if (!InvokeDest)
David Majnemer3df77bc2016-01-26 23:14:47 +00003677 Inst = Builder.CreateCall(Callee, Args, BundleList, Name);
Dan Gohman515a60d2012-02-16 00:57:37 +00003678 else {
3679 llvm::BasicBlock *ContBB = createBasicBlock("invoke.cont");
David Majnemer3df77bc2016-01-26 23:14:47 +00003680 Inst = Builder.CreateInvoke(Callee, ContBB, InvokeDest, Args, BundleList,
3681 Name);
Dan Gohman515a60d2012-02-16 00:57:37 +00003682 EmitBlock(ContBB);
3683 }
3684
3685 // In ObjC ARC mode with no ObjC ARC exception safety, tell the ARC
3686 // optimizer it can aggressively ignore unwind edges.
David Blaikiebbafb8a2012-03-11 07:00:24 +00003687 if (CGM.getLangOpts().ObjCAutoRefCount)
Dan Gohman515a60d2012-02-16 00:57:37 +00003688 AddObjCARCExceptionMetadata(Inst);
3689
Benjamin Kramerc19cde12015-04-10 14:49:31 +00003690 return llvm::CallSite(Inst);
John McCallbd309292010-07-06 01:34:17 +00003691}
3692
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003693/// \brief Store a non-aggregate value to an address to initialize it. For
3694/// initialization, a non-atomic store will be used.
3695static void EmitInitStoreOfNonAggregate(CodeGenFunction &CGF, RValue Src,
3696 LValue Dst) {
3697 if (Src.isScalar())
3698 CGF.EmitStoreOfScalar(Src.getScalarVal(), Dst, /*init=*/true);
3699 else
3700 CGF.EmitStoreOfComplex(Src.getComplexVal(), Dst, /*init=*/true);
3701}
3702
3703void CodeGenFunction::deferPlaceholderReplacement(llvm::Instruction *Old,
3704 llvm::Value *New) {
3705 DeferredReplacements.push_back(std::make_pair(Old, New));
3706}
Chris Lattnerd59d8672011-07-12 06:29:11 +00003707
Daniel Dunbard931a872009-02-02 22:03:45 +00003708RValue CodeGenFunction::EmitCall(const CGFunctionInfo &CallInfo,
John McCallb92ab1a2016-10-26 23:46:34 +00003709 const CGCallee &Callee,
Anders Carlsson61a401c2009-12-24 19:25:24 +00003710 ReturnValueSlot ReturnValue,
Daniel Dunbarcdbb5e32009-02-20 18:06:48 +00003711 const CallArgList &CallArgs,
David Chisnallff5f88c2010-05-02 13:41:58 +00003712 llvm::Instruction **callOrInvoke) {
Mike Stump18bb9282009-05-16 07:57:57 +00003713 // FIXME: We no longer need the types from CallArgs; lift up and simplify.
Daniel Dunbar613855c2008-09-09 23:27:19 +00003714
John McCallb92ab1a2016-10-26 23:46:34 +00003715 assert(Callee.isOrdinary());
3716
Daniel Dunbar613855c2008-09-09 23:27:19 +00003717 // Handle struct-return functions by passing a pointer to the
3718 // location that we would like to return into.
Daniel Dunbar7633cbf2009-02-02 21:43:58 +00003719 QualType RetTy = CallInfo.getReturnType();
Daniel Dunbarb52d0772009-02-03 05:59:18 +00003720 const ABIArgInfo &RetAI = CallInfo.getReturnInfo();
Mike Stump11289f42009-09-09 15:08:12 +00003721
John McCallb92ab1a2016-10-26 23:46:34 +00003722 llvm::FunctionType *IRFuncTy = Callee.getFunctionType();
3723
3724 // 1. Set up the arguments.
Mike Stump11289f42009-09-09 15:08:12 +00003725
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003726 // If we're using inalloca, insert the allocation after the stack save.
3727 // FIXME: Do this earlier rather than hacking it in here!
John McCall7f416cc2015-09-08 08:05:57 +00003728 Address ArgMemory = Address::invalid();
3729 const llvm::StructLayout *ArgMemoryLayout = nullptr;
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003730 if (llvm::StructType *ArgStruct = CallInfo.getArgStruct()) {
Matt Arsenault502ad602017-04-10 22:28:02 +00003731 const llvm::DataLayout &DL = CGM.getDataLayout();
3732 ArgMemoryLayout = DL.getStructLayout(ArgStruct);
Reid Kleckner9df1d972014-04-10 01:40:15 +00003733 llvm::Instruction *IP = CallArgs.getStackBase();
3734 llvm::AllocaInst *AI;
3735 if (IP) {
3736 IP = IP->getNextNode();
Matt Arsenault502ad602017-04-10 22:28:02 +00003737 AI = new llvm::AllocaInst(ArgStruct, DL.getAllocaAddrSpace(),
3738 "argmem", IP);
Reid Kleckner9df1d972014-04-10 01:40:15 +00003739 } else {
Reid Kleckner966abe72014-05-15 23:01:46 +00003740 AI = CreateTempAlloca(ArgStruct, "argmem");
Reid Kleckner9df1d972014-04-10 01:40:15 +00003741 }
John McCall7f416cc2015-09-08 08:05:57 +00003742 auto Align = CallInfo.getArgStructAlignment();
3743 AI->setAlignment(Align.getQuantity());
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003744 AI->setUsedWithInAlloca(true);
3745 assert(AI->isUsedWithInAlloca() && !AI->isStaticAlloca());
John McCall7f416cc2015-09-08 08:05:57 +00003746 ArgMemory = Address(AI, Align);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003747 }
3748
John McCall7f416cc2015-09-08 08:05:57 +00003749 // Helper function to drill into the inalloca allocation.
3750 auto createInAllocaStructGEP = [&](unsigned FieldIndex) -> Address {
3751 auto FieldOffset =
3752 CharUnits::fromQuantity(ArgMemoryLayout->getElementOffset(FieldIndex));
3753 return Builder.CreateStructGEP(ArgMemory, FieldIndex, FieldOffset);
3754 };
3755
Alexey Samsonov153004f2014-09-29 22:08:00 +00003756 ClangToLLVMArgMapping IRFunctionArgs(CGM.getContext(), CallInfo);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003757 SmallVector<llvm::Value *, 16> IRCallArgs(IRFunctionArgs.totalIRArgs());
3758
Chris Lattner4ca97c32009-06-13 00:26:38 +00003759 // If the call returns a temporary with struct return, create a temporary
Anders Carlsson17490832009-12-24 20:40:36 +00003760 // alloca to hold the result, unless one is given to us.
John McCall7f416cc2015-09-08 08:05:57 +00003761 Address SRetPtr = Address::invalid();
Leny Kholodov6aab1112015-06-08 10:23:49 +00003762 size_t UnusedReturnSize = 0;
John McCallf26e73d2016-03-11 04:30:43 +00003763 if (RetAI.isIndirect() || RetAI.isInAlloca() || RetAI.isCoerceAndExpand()) {
John McCall7f416cc2015-09-08 08:05:57 +00003764 if (!ReturnValue.isNull()) {
3765 SRetPtr = ReturnValue.getValue();
3766 } else {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003767 SRetPtr = CreateMemTemp(RetTy);
Leny Kholodov6aab1112015-06-08 10:23:49 +00003768 if (HaveInsertPoint() && ReturnValue.isUnused()) {
3769 uint64_t size =
3770 CGM.getDataLayout().getTypeAllocSize(ConvertTypeForMem(RetTy));
John McCall7f416cc2015-09-08 08:05:57 +00003771 if (EmitLifetimeStart(size, SRetPtr.getPointer()))
Leny Kholodov6aab1112015-06-08 10:23:49 +00003772 UnusedReturnSize = size;
3773 }
3774 }
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003775 if (IRFunctionArgs.hasSRetArg()) {
John McCall7f416cc2015-09-08 08:05:57 +00003776 IRCallArgs[IRFunctionArgs.getSRetArgNo()] = SRetPtr.getPointer();
John McCallf26e73d2016-03-11 04:30:43 +00003777 } else if (RetAI.isInAlloca()) {
John McCall7f416cc2015-09-08 08:05:57 +00003778 Address Addr = createInAllocaStructGEP(RetAI.getInAllocaFieldIndex());
3779 Builder.CreateStore(SRetPtr.getPointer(), Addr);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003780 }
Anders Carlsson17490832009-12-24 20:40:36 +00003781 }
Mike Stump11289f42009-09-09 15:08:12 +00003782
John McCall12f23522016-04-04 18:33:08 +00003783 Address swiftErrorTemp = Address::invalid();
3784 Address swiftErrorArg = Address::invalid();
3785
John McCallb92ab1a2016-10-26 23:46:34 +00003786 // Translate all of the arguments as necessary to match the IR lowering.
Daniel Dunbara45bdbb2009-02-04 21:17:21 +00003787 assert(CallInfo.arg_size() == CallArgs.size() &&
3788 "Mismatch between function signature & arguments.");
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003789 unsigned ArgNo = 0;
Daniel Dunbarb52d0772009-02-03 05:59:18 +00003790 CGFunctionInfo::const_arg_iterator info_it = CallInfo.arg_begin();
Mike Stump11289f42009-09-09 15:08:12 +00003791 for (CallArgList::const_iterator I = CallArgs.begin(), E = CallArgs.end();
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003792 I != E; ++I, ++info_it, ++ArgNo) {
Daniel Dunbarb52d0772009-02-03 05:59:18 +00003793 const ABIArgInfo &ArgInfo = info_it->info;
Eli Friedmanf4258eb2011-05-02 18:05:27 +00003794 RValue RV = I->RV;
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00003795
Rafael Espindolafad28de2012-10-24 01:59:00 +00003796 // Insert a padding argument to ensure proper alignment.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003797 if (IRFunctionArgs.hasPaddingArg(ArgNo))
3798 IRCallArgs[IRFunctionArgs.getPaddingArgNo(ArgNo)] =
3799 llvm::UndefValue::get(ArgInfo.getPaddingType());
3800
3801 unsigned FirstIRArg, NumIRArgs;
3802 std::tie(FirstIRArg, NumIRArgs) = IRFunctionArgs.getIRArgs(ArgNo);
Rafael Espindolafad28de2012-10-24 01:59:00 +00003803
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00003804 switch (ArgInfo.getKind()) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003805 case ABIArgInfo::InAlloca: {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003806 assert(NumIRArgs == 0);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003807 assert(getTarget().getTriple().getArch() == llvm::Triple::x86);
3808 if (RV.isAggregate()) {
3809 // Replace the placeholder with the appropriate argument slot GEP.
3810 llvm::Instruction *Placeholder =
John McCall7f416cc2015-09-08 08:05:57 +00003811 cast<llvm::Instruction>(RV.getAggregatePointer());
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003812 CGBuilderTy::InsertPoint IP = Builder.saveIP();
3813 Builder.SetInsertPoint(Placeholder);
John McCall7f416cc2015-09-08 08:05:57 +00003814 Address Addr = createInAllocaStructGEP(ArgInfo.getInAllocaFieldIndex());
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003815 Builder.restoreIP(IP);
John McCall7f416cc2015-09-08 08:05:57 +00003816 deferPlaceholderReplacement(Placeholder, Addr.getPointer());
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003817 } else {
3818 // Store the RValue into the argument struct.
John McCall7f416cc2015-09-08 08:05:57 +00003819 Address Addr = createInAllocaStructGEP(ArgInfo.getInAllocaFieldIndex());
3820 unsigned AS = Addr.getType()->getPointerAddressSpace();
David Majnemer32b57b02014-03-31 16:12:47 +00003821 llvm::Type *MemType = ConvertTypeForMem(I->Ty)->getPointerTo(AS);
3822 // There are some cases where a trivial bitcast is not avoidable. The
3823 // definition of a type later in a translation unit may change it's type
3824 // from {}* to (%struct.foo*)*.
John McCall7f416cc2015-09-08 08:05:57 +00003825 if (Addr.getType() != MemType)
David Majnemer32b57b02014-03-31 16:12:47 +00003826 Addr = Builder.CreateBitCast(Addr, MemType);
John McCall7f416cc2015-09-08 08:05:57 +00003827 LValue argLV = MakeAddrLValue(Addr, I->Ty);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003828 EmitInitStoreOfNonAggregate(*this, RV, argLV);
3829 }
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003830 break;
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003831 }
3832
Daniel Dunbar03816342010-08-21 02:24:36 +00003833 case ABIArgInfo::Indirect: {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003834 assert(NumIRArgs == 1);
Daniel Dunbar747865a2009-02-05 09:16:39 +00003835 if (RV.isScalar() || RV.isComplex()) {
3836 // Make a temporary alloca to pass the argument.
Yaxun Liu84744c12017-06-19 17:03:41 +00003837 Address Addr = CreateMemTemp(I->Ty, ArgInfo.getIndirectAlign(),
3838 "indirect-arg-temp", false);
John McCall7f416cc2015-09-08 08:05:57 +00003839 IRCallArgs[FirstIRArg] = Addr.getPointer();
John McCall47fb9502013-03-07 21:37:08 +00003840
John McCall7f416cc2015-09-08 08:05:57 +00003841 LValue argLV = MakeAddrLValue(Addr, I->Ty);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003842 EmitInitStoreOfNonAggregate(*this, RV, argLV);
Daniel Dunbar747865a2009-02-05 09:16:39 +00003843 } else {
Eli Friedmaneb7fab62011-06-14 01:37:52 +00003844 // We want to avoid creating an unnecessary temporary+copy here;
Guy Benyei3832bfd2013-03-10 12:59:00 +00003845 // however, we need one in three cases:
Eli Friedmaneb7fab62011-06-14 01:37:52 +00003846 // 1. If the argument is not byval, and we are required to copy the
3847 // source. (This case doesn't occur on any common architecture.)
3848 // 2. If the argument is byval, RV is not sufficiently aligned, and
3849 // we cannot force it to be sufficiently aligned.
Guy Benyei3832bfd2013-03-10 12:59:00 +00003850 // 3. If the argument is byval, but RV is located in an address space
3851 // different than that of the argument (0).
John McCall7f416cc2015-09-08 08:05:57 +00003852 Address Addr = RV.getAggregateAddress();
3853 CharUnits Align = ArgInfo.getIndirectAlign();
Micah Villmowdd31ca12012-10-08 16:25:52 +00003854 const llvm::DataLayout *TD = &CGM.getDataLayout();
John McCall7f416cc2015-09-08 08:05:57 +00003855 const unsigned RVAddrSpace = Addr.getType()->getAddressSpace();
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003856 const unsigned ArgAddrSpace =
3857 (FirstIRArg < IRFuncTy->getNumParams()
3858 ? IRFuncTy->getParamType(FirstIRArg)->getPointerAddressSpace()
3859 : 0);
Eli Friedmanf7456192011-06-15 22:09:18 +00003860 if ((!ArgInfo.getIndirectByVal() && I->NeedsCopy) ||
John McCall7f416cc2015-09-08 08:05:57 +00003861 (ArgInfo.getIndirectByVal() && Addr.getAlignment() < Align &&
3862 llvm::getOrEnforceKnownAlignment(Addr.getPointer(),
3863 Align.getQuantity(), *TD)
3864 < Align.getQuantity()) ||
Mehdi Aminib3d52092015-03-10 02:36:43 +00003865 (ArgInfo.getIndirectByVal() && (RVAddrSpace != ArgAddrSpace))) {
Eli Friedmaneb7fab62011-06-14 01:37:52 +00003866 // Create an aligned temporary, and copy to it.
Yaxun Liu84744c12017-06-19 17:03:41 +00003867 Address AI = CreateMemTemp(I->Ty, ArgInfo.getIndirectAlign(),
3868 "byval-temp", false);
John McCall7f416cc2015-09-08 08:05:57 +00003869 IRCallArgs[FirstIRArg] = AI.getPointer();
Chad Rosier615ed1a2012-03-29 17:37:10 +00003870 EmitAggregateCopy(AI, Addr, I->Ty, RV.isVolatileQualified());
Eli Friedmaneb7fab62011-06-14 01:37:52 +00003871 } else {
3872 // Skip the extra memcpy call.
John McCall7f416cc2015-09-08 08:05:57 +00003873 IRCallArgs[FirstIRArg] = Addr.getPointer();
Eli Friedmaneb7fab62011-06-14 01:37:52 +00003874 }
Daniel Dunbar747865a2009-02-05 09:16:39 +00003875 }
3876 break;
Daniel Dunbar03816342010-08-21 02:24:36 +00003877 }
Daniel Dunbar747865a2009-02-05 09:16:39 +00003878
Daniel Dunbar94a6f252009-01-26 21:26:08 +00003879 case ABIArgInfo::Ignore:
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003880 assert(NumIRArgs == 0);
Daniel Dunbar94a6f252009-01-26 21:26:08 +00003881 break;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003882
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00003883 case ABIArgInfo::Extend:
3884 case ABIArgInfo::Direct: {
3885 if (!isa<llvm::StructType>(ArgInfo.getCoerceToType()) &&
Chris Lattner8a2f3c72010-07-30 04:02:24 +00003886 ArgInfo.getCoerceToType() == ConvertType(info_it->type) &&
3887 ArgInfo.getDirectOffset() == 0) {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003888 assert(NumIRArgs == 1);
Chris Lattnerbb1952c2011-07-12 04:46:18 +00003889 llvm::Value *V;
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00003890 if (RV.isScalar())
Chris Lattnerbb1952c2011-07-12 04:46:18 +00003891 V = RV.getScalarVal();
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00003892 else
John McCall7f416cc2015-09-08 08:05:57 +00003893 V = Builder.CreateLoad(RV.getAggregateAddress());
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003894
John McCall12f23522016-04-04 18:33:08 +00003895 // Implement swifterror by copying into a new swifterror argument.
3896 // We'll write back in the normal path out of the call.
3897 if (CallInfo.getExtParameterInfo(ArgNo).getABI()
3898 == ParameterABI::SwiftErrorResult) {
3899 assert(!swiftErrorTemp.isValid() && "multiple swifterror args");
3900
3901 QualType pointeeTy = I->Ty->getPointeeType();
3902 swiftErrorArg =
3903 Address(V, getContext().getTypeAlignInChars(pointeeTy));
3904
3905 swiftErrorTemp =
3906 CreateMemTemp(pointeeTy, getPointerAlign(), "swifterror.temp");
3907 V = swiftErrorTemp.getPointer();
3908 cast<llvm::AllocaInst>(V)->setSwiftError(true);
3909
3910 llvm::Value *errorValue = Builder.CreateLoad(swiftErrorArg);
3911 Builder.CreateStore(errorValue, swiftErrorTemp);
3912 }
3913
Reid Kleckner79b0fd72014-10-10 00:05:45 +00003914 // We might have to widen integers, but we should never truncate.
3915 if (ArgInfo.getCoerceToType() != V->getType() &&
3916 V->getType()->isIntegerTy())
3917 V = Builder.CreateZExt(V, ArgInfo.getCoerceToType());
3918
Chris Lattner3ce86682011-07-12 04:53:39 +00003919 // If the argument doesn't match, perform a bitcast to coerce it. This
3920 // can happen due to trivial type mismatches.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003921 if (FirstIRArg < IRFuncTy->getNumParams() &&
3922 V->getType() != IRFuncTy->getParamType(FirstIRArg))
3923 V = Builder.CreateBitCast(V, IRFuncTy->getParamType(FirstIRArg));
John McCall12f23522016-04-04 18:33:08 +00003924
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003925 IRCallArgs[FirstIRArg] = V;
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00003926 break;
3927 }
Daniel Dunbar94a6f252009-01-26 21:26:08 +00003928
Daniel Dunbar2f219b02009-02-03 19:12:28 +00003929 // FIXME: Avoid the conversion through memory if possible.
John McCall7f416cc2015-09-08 08:05:57 +00003930 Address Src = Address::invalid();
John McCall47fb9502013-03-07 21:37:08 +00003931 if (RV.isScalar() || RV.isComplex()) {
John McCall7f416cc2015-09-08 08:05:57 +00003932 Src = CreateMemTemp(I->Ty, "coerce");
3933 LValue SrcLV = MakeAddrLValue(Src, I->Ty);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003934 EmitInitStoreOfNonAggregate(*this, RV, SrcLV);
Ulrich Weigand6e2cea62015-07-10 11:31:43 +00003935 } else {
John McCall7f416cc2015-09-08 08:05:57 +00003936 Src = RV.getAggregateAddress();
Ulrich Weigand6e2cea62015-07-10 11:31:43 +00003937 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003938
Chris Lattner8a2f3c72010-07-30 04:02:24 +00003939 // If the value is offset in memory, apply the offset now.
John McCall7f416cc2015-09-08 08:05:57 +00003940 Src = emitAddressAtOffset(*this, Src, ArgInfo);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003941
Oliver Stannard2bfdc5b2014-08-27 10:43:15 +00003942 // Fast-isel and the optimizer generally like scalar values better than
3943 // FCAs, so we flatten them if this is safe to do for this argument.
James Molloy6f244b62014-05-09 16:21:39 +00003944 llvm::StructType *STy =
3945 dyn_cast<llvm::StructType>(ArgInfo.getCoerceToType());
Oliver Stannard2bfdc5b2014-08-27 10:43:15 +00003946 if (STy && ArgInfo.isDirect() && ArgInfo.getCanBeFlattened()) {
John McCall7f416cc2015-09-08 08:05:57 +00003947 llvm::Type *SrcTy = Src.getType()->getElementType();
Chandler Carrutha6399a52012-10-10 11:29:08 +00003948 uint64_t SrcSize = CGM.getDataLayout().getTypeAllocSize(SrcTy);
3949 uint64_t DstSize = CGM.getDataLayout().getTypeAllocSize(STy);
3950
3951 // If the source type is smaller than the destination type of the
3952 // coerce-to logic, copy the source value into a temp alloca the size
3953 // of the destination type to allow loading all of it. The bits past
3954 // the source value are left undef.
3955 if (SrcSize < DstSize) {
John McCall7f416cc2015-09-08 08:05:57 +00003956 Address TempAlloca
3957 = CreateTempAlloca(STy, Src.getAlignment(),
3958 Src.getName() + ".coerce");
3959 Builder.CreateMemCpy(TempAlloca, Src, SrcSize);
3960 Src = TempAlloca;
Chandler Carrutha6399a52012-10-10 11:29:08 +00003961 } else {
Matt Arsenault7a124f32017-08-01 20:36:57 +00003962 Src = Builder.CreateBitCast(Src,
3963 STy->getPointerTo(Src.getAddressSpace()));
Chandler Carrutha6399a52012-10-10 11:29:08 +00003964 }
3965
John McCall7f416cc2015-09-08 08:05:57 +00003966 auto SrcLayout = CGM.getDataLayout().getStructLayout(STy);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003967 assert(NumIRArgs == STy->getNumElements());
Chris Lattnerceddafb2010-07-05 20:41:41 +00003968 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
John McCall7f416cc2015-09-08 08:05:57 +00003969 auto Offset = CharUnits::fromQuantity(SrcLayout->getElementOffset(i));
3970 Address EltPtr = Builder.CreateStructGEP(Src, i, Offset);
3971 llvm::Value *LI = Builder.CreateLoad(EltPtr);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003972 IRCallArgs[FirstIRArg + i] = LI;
Chris Lattner15ec3612010-06-29 00:06:42 +00003973 }
Chris Lattner3dd716c2010-06-28 23:44:11 +00003974 } else {
Chris Lattner15ec3612010-06-29 00:06:42 +00003975 // In the simple case, just pass the coerced loaded value.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003976 assert(NumIRArgs == 1);
3977 IRCallArgs[FirstIRArg] =
John McCall7f416cc2015-09-08 08:05:57 +00003978 CreateCoercedLoad(Src, ArgInfo.getCoerceToType(), *this);
Chris Lattner3dd716c2010-06-28 23:44:11 +00003979 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003980
Daniel Dunbar2f219b02009-02-03 19:12:28 +00003981 break;
3982 }
3983
John McCallf26e73d2016-03-11 04:30:43 +00003984 case ABIArgInfo::CoerceAndExpand: {
John McCallf26e73d2016-03-11 04:30:43 +00003985 auto coercionType = ArgInfo.getCoerceAndExpandType();
3986 auto layout = CGM.getDataLayout().getStructLayout(coercionType);
3987
John McCall12f23522016-04-04 18:33:08 +00003988 llvm::Value *tempSize = nullptr;
3989 Address addr = Address::invalid();
3990 if (RV.isAggregate()) {
3991 addr = RV.getAggregateAddress();
3992 } else {
3993 assert(RV.isScalar()); // complex should always just be direct
3994
3995 llvm::Type *scalarType = RV.getScalarVal()->getType();
3996 auto scalarSize = CGM.getDataLayout().getTypeAllocSize(scalarType);
3997 auto scalarAlign = CGM.getDataLayout().getPrefTypeAlignment(scalarType);
3998
3999 tempSize = llvm::ConstantInt::get(CGM.Int64Ty, scalarSize);
4000
4001 // Materialize to a temporary.
4002 addr = CreateTempAlloca(RV.getScalarVal()->getType(),
4003 CharUnits::fromQuantity(std::max(layout->getAlignment(),
4004 scalarAlign)));
4005 EmitLifetimeStart(scalarSize, addr.getPointer());
4006
4007 Builder.CreateStore(RV.getScalarVal(), addr);
4008 }
4009
John McCallf26e73d2016-03-11 04:30:43 +00004010 addr = Builder.CreateElementBitCast(addr, coercionType);
4011
4012 unsigned IRArgPos = FirstIRArg;
4013 for (unsigned i = 0, e = coercionType->getNumElements(); i != e; ++i) {
4014 llvm::Type *eltType = coercionType->getElementType(i);
4015 if (ABIArgInfo::isPaddingForCoerceAndExpand(eltType)) continue;
4016 Address eltAddr = Builder.CreateStructGEP(addr, i, layout);
4017 llvm::Value *elt = Builder.CreateLoad(eltAddr);
4018 IRCallArgs[IRArgPos++] = elt;
4019 }
4020 assert(IRArgPos == FirstIRArg + NumIRArgs);
4021
John McCall12f23522016-04-04 18:33:08 +00004022 if (tempSize) {
4023 EmitLifetimeEnd(tempSize, addr.getPointer());
4024 }
4025
John McCallf26e73d2016-03-11 04:30:43 +00004026 break;
4027 }
4028
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00004029 case ABIArgInfo::Expand:
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004030 unsigned IRArgPos = FirstIRArg;
4031 ExpandTypeToArgs(I->Ty, RV, IRFuncTy, IRCallArgs, IRArgPos);
4032 assert(IRArgPos == FirstIRArg + NumIRArgs);
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00004033 break;
Daniel Dunbar613855c2008-09-09 23:27:19 +00004034 }
4035 }
Mike Stump11289f42009-09-09 15:08:12 +00004036
John McCallb92ab1a2016-10-26 23:46:34 +00004037 llvm::Value *CalleePtr = Callee.getFunctionPointer();
4038
4039 // If we're using inalloca, set up that argument.
John McCall7f416cc2015-09-08 08:05:57 +00004040 if (ArgMemory.isValid()) {
4041 llvm::Value *Arg = ArgMemory.getPointer();
Reid Klecknerafba553e2014-07-08 02:24:27 +00004042 if (CallInfo.isVariadic()) {
4043 // When passing non-POD arguments by value to variadic functions, we will
4044 // end up with a variadic prototype and an inalloca call site. In such
4045 // cases, we can't do any parameter mismatch checks. Give up and bitcast
4046 // the callee.
John McCallb92ab1a2016-10-26 23:46:34 +00004047 unsigned CalleeAS = CalleePtr->getType()->getPointerAddressSpace();
4048 auto FnTy = getTypes().GetFunctionType(CallInfo)->getPointerTo(CalleeAS);
4049 CalleePtr = Builder.CreateBitCast(CalleePtr, FnTy);
Reid Klecknerafba553e2014-07-08 02:24:27 +00004050 } else {
4051 llvm::Type *LastParamTy =
4052 IRFuncTy->getParamType(IRFuncTy->getNumParams() - 1);
4053 if (Arg->getType() != LastParamTy) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00004054#ifndef NDEBUG
Reid Klecknerafba553e2014-07-08 02:24:27 +00004055 // Assert that these structs have equivalent element types.
4056 llvm::StructType *FullTy = CallInfo.getArgStruct();
4057 llvm::StructType *DeclaredTy = cast<llvm::StructType>(
4058 cast<llvm::PointerType>(LastParamTy)->getElementType());
4059 assert(DeclaredTy->getNumElements() == FullTy->getNumElements());
4060 for (llvm::StructType::element_iterator DI = DeclaredTy->element_begin(),
4061 DE = DeclaredTy->element_end(),
4062 FI = FullTy->element_begin();
4063 DI != DE; ++DI, ++FI)
4064 assert(*DI == *FI);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00004065#endif
Reid Klecknerafba553e2014-07-08 02:24:27 +00004066 Arg = Builder.CreateBitCast(Arg, LastParamTy);
4067 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00004068 }
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004069 assert(IRFunctionArgs.hasInallocaArg());
4070 IRCallArgs[IRFunctionArgs.getInallocaArgNo()] = Arg;
Reid Kleckner314ef7b2014-02-01 00:04:45 +00004071 }
4072
John McCallb92ab1a2016-10-26 23:46:34 +00004073 // 2. Prepare the function pointer.
4074
4075 // If the callee is a bitcast of a non-variadic function to have a
4076 // variadic function pointer type, check to see if we can remove the
4077 // bitcast. This comes up with unprototyped functions.
4078 //
4079 // This makes the IR nicer, but more importantly it ensures that we
4080 // can inline the function at -O0 if it is marked always_inline.
4081 auto simplifyVariadicCallee = [](llvm::Value *Ptr) -> llvm::Value* {
4082 llvm::FunctionType *CalleeFT =
4083 cast<llvm::FunctionType>(Ptr->getType()->getPointerElementType());
4084 if (!CalleeFT->isVarArg())
4085 return Ptr;
4086
4087 llvm::ConstantExpr *CE = dyn_cast<llvm::ConstantExpr>(Ptr);
4088 if (!CE || CE->getOpcode() != llvm::Instruction::BitCast)
4089 return Ptr;
4090
4091 llvm::Function *OrigFn = dyn_cast<llvm::Function>(CE->getOperand(0));
4092 if (!OrigFn)
4093 return Ptr;
4094
4095 llvm::FunctionType *OrigFT = OrigFn->getFunctionType();
4096
4097 // If the original type is variadic, or if any of the component types
4098 // disagree, we cannot remove the cast.
4099 if (OrigFT->isVarArg() ||
4100 OrigFT->getNumParams() != CalleeFT->getNumParams() ||
4101 OrigFT->getReturnType() != CalleeFT->getReturnType())
4102 return Ptr;
4103
4104 for (unsigned i = 0, e = OrigFT->getNumParams(); i != e; ++i)
4105 if (OrigFT->getParamType(i) != CalleeFT->getParamType(i))
4106 return Ptr;
4107
4108 return OrigFn;
4109 };
4110 CalleePtr = simplifyVariadicCallee(CalleePtr);
4111
4112 // 3. Perform the actual call.
4113
4114 // Deactivate any cleanups that we're supposed to do immediately before
4115 // the call.
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00004116 if (!CallArgs.getCleanupsToDeactivate().empty())
4117 deactivateArgCleanupsBeforeCall(*this, CallArgs);
4118
John McCallb92ab1a2016-10-26 23:46:34 +00004119 // Assert that the arguments we computed match up. The IR verifier
4120 // will catch this, but this is a common enough source of problems
4121 // during IRGen changes that it's way better for debugging to catch
4122 // it ourselves here.
4123#ifndef NDEBUG
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004124 assert(IRCallArgs.size() == IRFuncTy->getNumParams() || IRFuncTy->isVarArg());
4125 for (unsigned i = 0; i < IRCallArgs.size(); ++i) {
4126 // Inalloca argument can have different type.
4127 if (IRFunctionArgs.hasInallocaArg() &&
4128 i == IRFunctionArgs.getInallocaArgNo())
4129 continue;
4130 if (i < IRFuncTy->getNumParams())
4131 assert(IRCallArgs[i]->getType() == IRFuncTy->getParamType(i));
4132 }
John McCallb92ab1a2016-10-26 23:46:34 +00004133#endif
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004134
John McCallb92ab1a2016-10-26 23:46:34 +00004135 // Compute the calling convention and attributes.
Daniel Dunbar0ef34792009-09-12 00:59:20 +00004136 unsigned CallingConv;
Reid Klecknercdd26792017-04-18 23:50:03 +00004137 llvm::AttributeList Attrs;
John McCallb92ab1a2016-10-26 23:46:34 +00004138 CGM.ConstructAttributeList(CalleePtr->getName(), CallInfo,
Reid Klecknercdd26792017-04-18 23:50:03 +00004139 Callee.getAbstractInfo(), Attrs, CallingConv,
Chad Rosier7dbc9cf2016-01-06 14:35:46 +00004140 /*AttrOnCallSite=*/true);
Mike Stump11289f42009-09-09 15:08:12 +00004141
John McCallb92ab1a2016-10-26 23:46:34 +00004142 // Apply some call-site-specific attributes.
4143 // TODO: work this into building the attribute set.
4144
4145 // Apply always_inline to all calls within flatten functions.
4146 // FIXME: should this really take priority over __try, below?
4147 if (CurCodeDecl && CurCodeDecl->hasAttr<FlattenAttr>() &&
4148 !(Callee.getAbstractInfo().getCalleeDecl() &&
4149 Callee.getAbstractInfo().getCalleeDecl()->hasAttr<NoInlineAttr>())) {
4150 Attrs =
Reid Klecknerde864822017-03-21 16:57:30 +00004151 Attrs.addAttribute(getLLVMContext(), llvm::AttributeList::FunctionIndex,
John McCallb92ab1a2016-10-26 23:46:34 +00004152 llvm::Attribute::AlwaysInline);
4153 }
4154
4155 // Disable inlining inside SEH __try blocks.
4156 if (isSEHTryScope()) {
4157 Attrs =
Reid Klecknerde864822017-03-21 16:57:30 +00004158 Attrs.addAttribute(getLLVMContext(), llvm::AttributeList::FunctionIndex,
John McCallb92ab1a2016-10-26 23:46:34 +00004159 llvm::Attribute::NoInline);
4160 }
4161
4162 // Decide whether to use a call or an invoke.
David Majnemer4e52d6f2015-12-12 05:39:21 +00004163 bool CannotThrow;
4164 if (currentFunctionUsesSEHTry()) {
John McCallb92ab1a2016-10-26 23:46:34 +00004165 // SEH cares about asynchronous exceptions, so everything can "throw."
David Majnemer4e52d6f2015-12-12 05:39:21 +00004166 CannotThrow = false;
4167 } else if (isCleanupPadScope() &&
4168 EHPersonality::get(*this).isMSVCXXPersonality()) {
4169 // The MSVC++ personality will implicitly terminate the program if an
John McCallb92ab1a2016-10-26 23:46:34 +00004170 // exception is thrown during a cleanup outside of a try/catch.
4171 // We don't need to model anything in IR to get this behavior.
David Majnemer4e52d6f2015-12-12 05:39:21 +00004172 CannotThrow = true;
4173 } else {
John McCallb92ab1a2016-10-26 23:46:34 +00004174 // Otherwise, nounwind call sites will never throw.
Reid Klecknerde864822017-03-21 16:57:30 +00004175 CannotThrow = Attrs.hasAttribute(llvm::AttributeList::FunctionIndex,
David Majnemer4e52d6f2015-12-12 05:39:21 +00004176 llvm::Attribute::NoUnwind);
4177 }
4178 llvm::BasicBlock *InvokeDest = CannotThrow ? nullptr : getInvokeDest();
John McCallbd309292010-07-06 01:34:17 +00004179
David Majnemer0b17d442015-12-15 21:27:59 +00004180 SmallVector<llvm::OperandBundleDef, 1> BundleList;
John McCallb92ab1a2016-10-26 23:46:34 +00004181 getBundlesForFunclet(CalleePtr, CurrentFuncletPad, BundleList);
David Majnemer0b17d442015-12-15 21:27:59 +00004182
John McCallb92ab1a2016-10-26 23:46:34 +00004183 // Emit the actual call/invoke instruction.
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004184 llvm::CallSite CS;
John McCallbd309292010-07-06 01:34:17 +00004185 if (!InvokeDest) {
John McCallb92ab1a2016-10-26 23:46:34 +00004186 CS = Builder.CreateCall(CalleePtr, IRCallArgs, BundleList);
Daniel Dunbar12347492009-02-23 17:26:39 +00004187 } else {
4188 llvm::BasicBlock *Cont = createBasicBlock("invoke.cont");
John McCallb92ab1a2016-10-26 23:46:34 +00004189 CS = Builder.CreateInvoke(CalleePtr, Cont, InvokeDest, IRCallArgs,
David Majnemer0b17d442015-12-15 21:27:59 +00004190 BundleList);
Daniel Dunbar12347492009-02-23 17:26:39 +00004191 EmitBlock(Cont);
Daniel Dunbar5006f4a2009-02-20 18:54:31 +00004192 }
John McCallb92ab1a2016-10-26 23:46:34 +00004193 llvm::Instruction *CI = CS.getInstruction();
Chris Lattnere70a0072010-06-29 16:40:28 +00004194 if (callOrInvoke)
John McCallb92ab1a2016-10-26 23:46:34 +00004195 *callOrInvoke = CI;
Daniel Dunbar5006f4a2009-02-20 18:54:31 +00004196
John McCallb92ab1a2016-10-26 23:46:34 +00004197 // Apply the attributes and calling convention.
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004198 CS.setAttributes(Attrs);
Daniel Dunbar0ef34792009-09-12 00:59:20 +00004199 CS.setCallingConv(static_cast<llvm::CallingConv::ID>(CallingConv));
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004200
John McCallb92ab1a2016-10-26 23:46:34 +00004201 // Apply various metadata.
4202
4203 if (!CI->getType()->isVoidTy())
4204 CI->setName("call");
4205
Adam Nemet1e217bc2016-03-28 22:18:53 +00004206 // Insert instrumentation or attach profile metadata at indirect call sites.
4207 // For more details, see the comment before the definition of
4208 // IPVK_IndirectCallTarget in InstrProfData.inc.
Betul Buyukkurt518276a2016-01-23 22:50:44 +00004209 if (!CS.getCalledFunction())
4210 PGO.valueProfile(Builder, llvm::IPVK_IndirectCallTarget,
John McCallb92ab1a2016-10-26 23:46:34 +00004211 CI, CalleePtr);
Betul Buyukkurt518276a2016-01-23 22:50:44 +00004212
Dan Gohman515a60d2012-02-16 00:57:37 +00004213 // In ObjC ARC mode with no ObjC ARC exception safety, tell the ARC
4214 // optimizer it can aggressively ignore unwind edges.
David Blaikiebbafb8a2012-03-11 07:00:24 +00004215 if (CGM.getLangOpts().ObjCAutoRefCount)
John McCallb92ab1a2016-10-26 23:46:34 +00004216 AddObjCARCExceptionMetadata(CI);
4217
4218 // Suppress tail calls if requested.
4219 if (llvm::CallInst *Call = dyn_cast<llvm::CallInst>(CI)) {
4220 const Decl *TargetDecl = Callee.getAbstractInfo().getCalleeDecl();
4221 if (TargetDecl && TargetDecl->hasAttr<NotTailCalledAttr>())
4222 Call->setTailCallKind(llvm::CallInst::TCK_NoTail);
4223 }
4224
4225 // 4. Finish the call.
Dan Gohman515a60d2012-02-16 00:57:37 +00004226
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004227 // If the call doesn't return, finish the basic block and clear the
John McCallb92ab1a2016-10-26 23:46:34 +00004228 // insertion point; this allows the rest of IRGen to discard
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004229 // unreachable code.
4230 if (CS.doesNotReturn()) {
Leny Kholodov6aab1112015-06-08 10:23:49 +00004231 if (UnusedReturnSize)
4232 EmitLifetimeEnd(llvm::ConstantInt::get(Int64Ty, UnusedReturnSize),
John McCall7f416cc2015-09-08 08:05:57 +00004233 SRetPtr.getPointer());
Leny Kholodov6aab1112015-06-08 10:23:49 +00004234
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004235 Builder.CreateUnreachable();
4236 Builder.ClearInsertionPoint();
Mike Stump11289f42009-09-09 15:08:12 +00004237
Mike Stump18bb9282009-05-16 07:57:57 +00004238 // FIXME: For now, emit a dummy basic block because expr emitters in
4239 // generally are not ready to handle emitting expressions at unreachable
4240 // points.
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004241 EnsureInsertPoint();
Mike Stump11289f42009-09-09 15:08:12 +00004242
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004243 // Return a reasonable RValue.
4244 return GetUndefRValue(RetTy);
Mike Stump11289f42009-09-09 15:08:12 +00004245 }
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004246
John McCall12f23522016-04-04 18:33:08 +00004247 // Perform the swifterror writeback.
4248 if (swiftErrorTemp.isValid()) {
4249 llvm::Value *errorResult = Builder.CreateLoad(swiftErrorTemp);
4250 Builder.CreateStore(errorResult, swiftErrorArg);
4251 }
4252
John McCallb92ab1a2016-10-26 23:46:34 +00004253 // Emit any call-associated writebacks immediately. Arguably this
4254 // should happen after any return-value munging.
John McCall31168b02011-06-15 23:02:42 +00004255 if (CallArgs.hasWritebacks())
4256 emitWritebacks(*this, CallArgs);
4257
Nico Weber8cdb3f92015-08-25 18:43:32 +00004258 // The stack cleanup for inalloca arguments has to run out of the normal
4259 // lexical order, so deactivate it and run it manually here.
4260 CallArgs.freeArgumentMemory(*this);
4261
John McCallb92ab1a2016-10-26 23:46:34 +00004262 // Extract the return value.
Hal Finkelee90a222014-09-26 05:04:30 +00004263 RValue Ret = [&] {
4264 switch (RetAI.getKind()) {
John McCallf26e73d2016-03-11 04:30:43 +00004265 case ABIArgInfo::CoerceAndExpand: {
4266 auto coercionType = RetAI.getCoerceAndExpandType();
4267 auto layout = CGM.getDataLayout().getStructLayout(coercionType);
4268
4269 Address addr = SRetPtr;
4270 addr = Builder.CreateElementBitCast(addr, coercionType);
4271
John McCall12f23522016-04-04 18:33:08 +00004272 assert(CI->getType() == RetAI.getUnpaddedCoerceAndExpandType());
4273 bool requiresExtract = isa<llvm::StructType>(CI->getType());
4274
John McCallf26e73d2016-03-11 04:30:43 +00004275 unsigned unpaddedIndex = 0;
4276 for (unsigned i = 0, e = coercionType->getNumElements(); i != e; ++i) {
4277 llvm::Type *eltType = coercionType->getElementType(i);
4278 if (ABIArgInfo::isPaddingForCoerceAndExpand(eltType)) continue;
4279 Address eltAddr = Builder.CreateStructGEP(addr, i, layout);
John McCall12f23522016-04-04 18:33:08 +00004280 llvm::Value *elt = CI;
4281 if (requiresExtract)
4282 elt = Builder.CreateExtractValue(elt, unpaddedIndex++);
4283 else
4284 assert(unpaddedIndex == 0);
John McCallf26e73d2016-03-11 04:30:43 +00004285 Builder.CreateStore(elt, eltAddr);
4286 }
John McCall12f23522016-04-04 18:33:08 +00004287 // FALLTHROUGH
Galina Kistanova0872d6c2017-06-03 06:30:46 +00004288 LLVM_FALLTHROUGH;
John McCall12f23522016-04-04 18:33:08 +00004289 }
4290
4291 case ABIArgInfo::InAlloca:
4292 case ABIArgInfo::Indirect: {
4293 RValue ret = convertTempToRValue(SRetPtr, RetTy, SourceLocation());
4294 if (UnusedReturnSize)
4295 EmitLifetimeEnd(llvm::ConstantInt::get(Int64Ty, UnusedReturnSize),
4296 SRetPtr.getPointer());
4297 return ret;
John McCallf26e73d2016-03-11 04:30:43 +00004298 }
4299
Hal Finkelee90a222014-09-26 05:04:30 +00004300 case ABIArgInfo::Ignore:
4301 // If we are ignoring an argument that had a result, make sure to
4302 // construct the appropriate return value for our caller.
4303 return GetUndefRValue(RetTy);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004304
Hal Finkelee90a222014-09-26 05:04:30 +00004305 case ABIArgInfo::Extend:
4306 case ABIArgInfo::Direct: {
4307 llvm::Type *RetIRTy = ConvertType(RetTy);
4308 if (RetAI.getCoerceToType() == RetIRTy && RetAI.getDirectOffset() == 0) {
4309 switch (getEvaluationKind(RetTy)) {
4310 case TEK_Complex: {
4311 llvm::Value *Real = Builder.CreateExtractValue(CI, 0);
4312 llvm::Value *Imag = Builder.CreateExtractValue(CI, 1);
4313 return RValue::getComplex(std::make_pair(Real, Imag));
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00004314 }
Hal Finkelee90a222014-09-26 05:04:30 +00004315 case TEK_Aggregate: {
John McCall7f416cc2015-09-08 08:05:57 +00004316 Address DestPtr = ReturnValue.getValue();
Hal Finkelee90a222014-09-26 05:04:30 +00004317 bool DestIsVolatile = ReturnValue.isVolatile();
4318
John McCall7f416cc2015-09-08 08:05:57 +00004319 if (!DestPtr.isValid()) {
Hal Finkelee90a222014-09-26 05:04:30 +00004320 DestPtr = CreateMemTemp(RetTy, "agg.tmp");
4321 DestIsVolatile = false;
4322 }
John McCall7f416cc2015-09-08 08:05:57 +00004323 BuildAggStore(*this, CI, DestPtr, DestIsVolatile);
Hal Finkelee90a222014-09-26 05:04:30 +00004324 return RValue::getAggregate(DestPtr);
4325 }
4326 case TEK_Scalar: {
4327 // If the argument doesn't match, perform a bitcast to coerce it. This
4328 // can happen due to trivial type mismatches.
4329 llvm::Value *V = CI;
4330 if (V->getType() != RetIRTy)
4331 V = Builder.CreateBitCast(V, RetIRTy);
4332 return RValue::get(V);
4333 }
4334 }
4335 llvm_unreachable("bad evaluation kind");
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00004336 }
Hal Finkelee90a222014-09-26 05:04:30 +00004337
John McCall7f416cc2015-09-08 08:05:57 +00004338 Address DestPtr = ReturnValue.getValue();
Hal Finkelee90a222014-09-26 05:04:30 +00004339 bool DestIsVolatile = ReturnValue.isVolatile();
4340
John McCall7f416cc2015-09-08 08:05:57 +00004341 if (!DestPtr.isValid()) {
Hal Finkelee90a222014-09-26 05:04:30 +00004342 DestPtr = CreateMemTemp(RetTy, "coerce");
4343 DestIsVolatile = false;
John McCall47fb9502013-03-07 21:37:08 +00004344 }
Hal Finkelee90a222014-09-26 05:04:30 +00004345
4346 // If the value is offset in memory, apply the offset now.
John McCall7f416cc2015-09-08 08:05:57 +00004347 Address StorePtr = emitAddressAtOffset(*this, DestPtr, RetAI);
4348 CreateCoercedStore(CI, StorePtr, DestIsVolatile, *this);
Hal Finkelee90a222014-09-26 05:04:30 +00004349
4350 return convertTempToRValue(DestPtr, RetTy, SourceLocation());
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00004351 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004352
Hal Finkelee90a222014-09-26 05:04:30 +00004353 case ABIArgInfo::Expand:
4354 llvm_unreachable("Invalid ABI kind for return argument");
Anders Carlsson17490832009-12-24 20:40:36 +00004355 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004356
Hal Finkelee90a222014-09-26 05:04:30 +00004357 llvm_unreachable("Unhandled ABIArgInfo::Kind");
4358 } ();
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004359
John McCallb92ab1a2016-10-26 23:46:34 +00004360 // Emit the assume_aligned check on the return value.
4361 const Decl *TargetDecl = Callee.getAbstractInfo().getCalleeDecl();
Hal Finkelee90a222014-09-26 05:04:30 +00004362 if (Ret.isScalar() && TargetDecl) {
4363 if (const auto *AA = TargetDecl->getAttr<AssumeAlignedAttr>()) {
4364 llvm::Value *OffsetValue = nullptr;
4365 if (const auto *Offset = AA->getOffset())
4366 OffsetValue = EmitScalarExpr(Offset);
4367
4368 llvm::Value *Alignment = EmitScalarExpr(AA->getAlignment());
4369 llvm::ConstantInt *AlignmentCI = cast<llvm::ConstantInt>(Alignment);
4370 EmitAlignmentAssumption(Ret.getScalarVal(), AlignmentCI->getZExtValue(),
4371 OffsetValue);
Erich Keane623efd82017-03-30 21:48:55 +00004372 } else if (const auto *AA = TargetDecl->getAttr<AllocAlignAttr>()) {
4373 llvm::Value *ParamVal =
4374 CallArgs[AA->getParamIndex() - 1].RV.getScalarVal();
4375 EmitAlignmentAssumption(Ret.getScalarVal(), ParamVal);
Hal Finkelee90a222014-09-26 05:04:30 +00004376 }
Daniel Dunbar573884e2008-09-10 07:04:09 +00004377 }
Daniel Dunbard3674e62008-09-11 01:48:57 +00004378
Hal Finkelee90a222014-09-26 05:04:30 +00004379 return Ret;
Daniel Dunbar613855c2008-09-09 23:27:19 +00004380}
Daniel Dunbar2d0746f2009-02-10 20:44:09 +00004381
4382/* VarArg handling */
4383
Charles Davisc7d5c942015-09-17 20:55:33 +00004384Address CodeGenFunction::EmitVAArg(VAArgExpr *VE, Address &VAListAddr) {
4385 VAListAddr = VE->isMicrosoftABI()
4386 ? EmitMSVAListRef(VE->getSubExpr())
4387 : EmitVAListRef(VE->getSubExpr());
4388 QualType Ty = VE->getType();
4389 if (VE->isMicrosoftABI())
4390 return CGM.getTypes().getABIInfo().EmitMSVAArg(*this, VAListAddr, Ty);
John McCall7f416cc2015-09-08 08:05:57 +00004391 return CGM.getTypes().getABIInfo().EmitVAArg(*this, VAListAddr, Ty);
Daniel Dunbar2d0746f2009-02-10 20:44:09 +00004392}