blob: c6988b5a9f31b4b3dbfc50f16a166507d7732af0 [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;
458 argTys.push_back(Context.getCanonicalParamType(receiverType));
459 argTys.push_back(Context.getCanonicalParamType(Context.getObjCSelType()));
Daniel Dunbarbf8c24a2009-02-02 23:23:47 +0000460 // FIXME: Kill copy?
David Majnemer59f77922016-06-24 04:05:48 +0000461 for (const auto *I : MD->parameters()) {
Aaron Ballman43b68be2014-03-07 17:50:17 +0000462 argTys.push_back(Context.getCanonicalParamType(I->getType()));
John McCall8ee376f2010-02-24 07:14:12 +0000463 }
John McCall31168b02011-06-15 23:02:42 +0000464
465 FunctionType::ExtInfo einfo;
Aaron Ballman0362a6d2013-12-18 16:23:37 +0000466 bool IsWindows = getContext().getTargetInfo().getTriple().isOSWindows();
467 einfo = einfo.withCallingConv(getCallingConventionForDecl(MD, IsWindows));
John McCall31168b02011-06-15 23:02:42 +0000468
David Blaikiebbafb8a2012-03-11 07:00:24 +0000469 if (getContext().getLangOpts().ObjCAutoRefCount &&
John McCall31168b02011-06-15 23:02:42 +0000470 MD->hasAttr<NSReturnsRetainedAttr>())
471 einfo = einfo.withProducesResult(true);
472
John McCalla729c622012-02-17 03:33:10 +0000473 RequiredArgs required =
474 (MD->isVariadic() ? RequiredArgs(argTys.size()) : RequiredArgs::All);
475
Peter Collingbournef7706832014-12-12 23:41:25 +0000476 return arrangeLLVMFunctionInfo(
477 GetReturnType(MD->getReturnType()), /*instanceMethod=*/false,
Akira Hatanaka30c93db2017-09-20 06:55:43 +0000478 /*chainCall=*/false, argTys, einfo, {}, required);
John McCallc56a8b32016-03-11 04:30:31 +0000479}
480
481const CGFunctionInfo &
482CodeGenTypes::arrangeUnprototypedObjCMessageSend(QualType returnType,
483 const CallArgList &args) {
484 auto argTypes = getArgTypesForCall(Context, args);
485 FunctionType::ExtInfo einfo;
486
487 return arrangeLLVMFunctionInfo(
488 GetReturnType(returnType), /*instanceMethod=*/false,
489 /*chainCall=*/false, argTypes, einfo, {}, RequiredArgs::All);
Daniel Dunbar3d7c90b2008-09-08 21:33:45 +0000490}
491
John McCalla729c622012-02-17 03:33:10 +0000492const CGFunctionInfo &
493CodeGenTypes::arrangeGlobalDeclaration(GlobalDecl GD) {
Anders Carlsson6710c532010-02-06 02:44:09 +0000494 // FIXME: Do we need to handle ObjCMethodDecl?
495 const FunctionDecl *FD = cast<FunctionDecl>(GD.getDecl());
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000496
Anders Carlsson6710c532010-02-06 02:44:09 +0000497 if (const CXXConstructorDecl *CD = dyn_cast<CXXConstructorDecl>(FD))
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000498 return arrangeCXXStructorDeclaration(CD, getFromCtorType(GD.getCtorType()));
Anders Carlsson6710c532010-02-06 02:44:09 +0000499
500 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(FD))
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000501 return arrangeCXXStructorDeclaration(DD, getFromDtorType(GD.getDtorType()));
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000502
John McCalla729c622012-02-17 03:33:10 +0000503 return arrangeFunctionDeclaration(FD);
Anders Carlsson6710c532010-02-06 02:44:09 +0000504}
505
Reid Klecknerc3473512014-08-29 21:43:29 +0000506/// Arrange a thunk that takes 'this' as the first parameter followed by
507/// varargs. Return a void pointer, regardless of the actual return type.
508/// The body of the thunk will end in a musttail call to a function of the
509/// correct type, and the caller will bitcast the function to the correct
510/// prototype.
511const CGFunctionInfo &
512CodeGenTypes::arrangeMSMemberPointerThunk(const CXXMethodDecl *MD) {
513 assert(MD->isVirtual() && "only virtual memptrs have thunks");
514 CanQual<FunctionProtoType> FTP = GetFormalType(MD);
515 CanQualType ArgTys[] = { GetThisType(Context, MD->getParent()) };
Peter Collingbournef7706832014-12-12 23:41:25 +0000516 return arrangeLLVMFunctionInfo(Context.VoidTy, /*instanceMethod=*/false,
517 /*chainCall=*/false, ArgTys,
John McCallc56a8b32016-03-11 04:30:31 +0000518 FTP->getExtInfo(), {}, RequiredArgs(1));
Reid Klecknerc3473512014-08-29 21:43:29 +0000519}
520
David Majnemerdfa6d202015-03-11 18:36:39 +0000521const CGFunctionInfo &
David Majnemer37fd66e2015-03-13 22:36:55 +0000522CodeGenTypes::arrangeMSCtorClosure(const CXXConstructorDecl *CD,
523 CXXCtorType CT) {
524 assert(CT == Ctor_CopyingClosure || CT == Ctor_DefaultClosure);
525
David Majnemerdfa6d202015-03-11 18:36:39 +0000526 CanQual<FunctionProtoType> FTP = GetFormalType(CD);
527 SmallVector<CanQualType, 2> ArgTys;
528 const CXXRecordDecl *RD = CD->getParent();
529 ArgTys.push_back(GetThisType(Context, RD));
David Majnemer37fd66e2015-03-13 22:36:55 +0000530 if (CT == Ctor_CopyingClosure)
531 ArgTys.push_back(*FTP->param_type_begin());
David Majnemerdfa6d202015-03-11 18:36:39 +0000532 if (RD->getNumVBases() > 0)
533 ArgTys.push_back(Context.IntTy);
534 CallingConv CC = Context.getDefaultCallingConvention(
535 /*IsVariadic=*/false, /*IsCXXMethod=*/true);
536 return arrangeLLVMFunctionInfo(Context.VoidTy, /*instanceMethod=*/true,
537 /*chainCall=*/false, ArgTys,
John McCallc56a8b32016-03-11 04:30:31 +0000538 FunctionType::ExtInfo(CC), {},
539 RequiredArgs::All);
David Majnemerdfa6d202015-03-11 18:36:39 +0000540}
541
John McCallc818bbb2012-12-07 07:03:17 +0000542/// Arrange a call as unto a free function, except possibly with an
543/// additional number of formal parameters considered required.
544static const CGFunctionInfo &
545arrangeFreeFunctionLikeCall(CodeGenTypes &CGT,
Mark Lacey23455752013-10-10 20:57:00 +0000546 CodeGenModule &CGM,
John McCallc818bbb2012-12-07 07:03:17 +0000547 const CallArgList &args,
548 const FunctionType *fnType,
Peter Collingbournef7706832014-12-12 23:41:25 +0000549 unsigned numExtraRequiredArgs,
550 bool chainCall) {
John McCallc818bbb2012-12-07 07:03:17 +0000551 assert(args.size() >= numExtraRequiredArgs);
552
John McCallc56a8b32016-03-11 04:30:31 +0000553 llvm::SmallVector<FunctionProtoType::ExtParameterInfo, 16> paramInfos;
554
John McCallc818bbb2012-12-07 07:03:17 +0000555 // In most cases, there are no optional arguments.
556 RequiredArgs required = RequiredArgs::All;
557
558 // If we have a variadic prototype, the required arguments are the
559 // extra prefix plus the arguments in the prototype.
560 if (const FunctionProtoType *proto = dyn_cast<FunctionProtoType>(fnType)) {
561 if (proto->isVariadic())
Alp Toker9cacbab2014-01-20 20:26:09 +0000562 required = RequiredArgs(proto->getNumParams() + numExtraRequiredArgs);
John McCallc818bbb2012-12-07 07:03:17 +0000563
John McCallc56a8b32016-03-11 04:30:31 +0000564 if (proto->hasExtParameterInfos())
565 addExtParameterInfosForCall(paramInfos, proto, numExtraRequiredArgs,
566 args.size());
567
John McCallc818bbb2012-12-07 07:03:17 +0000568 // If we don't have a prototype at all, but we're supposed to
569 // explicitly use the variadic convention for unprototyped calls,
570 // treat all of the arguments as required but preserve the nominal
571 // possibility of variadics.
Mark Lacey23455752013-10-10 20:57:00 +0000572 } else if (CGM.getTargetCodeGenInfo()
573 .isNoProtoCallVariadic(args,
574 cast<FunctionNoProtoType>(fnType))) {
John McCallc818bbb2012-12-07 07:03:17 +0000575 required = RequiredArgs(args.size());
576 }
577
Peter Collingbournef7706832014-12-12 23:41:25 +0000578 // FIXME: Kill copy.
579 SmallVector<CanQualType, 16> argTypes;
580 for (const auto &arg : args)
581 argTypes.push_back(CGT.getContext().getCanonicalParamType(arg.Ty));
582 return CGT.arrangeLLVMFunctionInfo(GetReturnType(fnType->getReturnType()),
583 /*instanceMethod=*/false, chainCall,
John McCallc56a8b32016-03-11 04:30:31 +0000584 argTypes, fnType->getExtInfo(), paramInfos,
585 required);
John McCallc818bbb2012-12-07 07:03:17 +0000586}
587
John McCalla729c622012-02-17 03:33:10 +0000588/// Figure out the rules for calling a function with the given formal
589/// type using the given arguments. The arguments are necessary
590/// because the function might be unprototyped, in which case it's
591/// target-dependent in crazy ways.
592const CGFunctionInfo &
John McCall8dda7b22012-07-07 06:41:13 +0000593CodeGenTypes::arrangeFreeFunctionCall(const CallArgList &args,
Peter Collingbournef7706832014-12-12 23:41:25 +0000594 const FunctionType *fnType,
595 bool chainCall) {
596 return arrangeFreeFunctionLikeCall(*this, CGM, args, fnType,
597 chainCall ? 1 : 0, chainCall);
John McCallc818bbb2012-12-07 07:03:17 +0000598}
John McCalla729c622012-02-17 03:33:10 +0000599
John McCallc56a8b32016-03-11 04:30:31 +0000600/// A block function is essentially a free function with an
John McCallc818bbb2012-12-07 07:03:17 +0000601/// extra implicit argument.
602const CGFunctionInfo &
603CodeGenTypes::arrangeBlockFunctionCall(const CallArgList &args,
604 const FunctionType *fnType) {
Peter Collingbournef7706832014-12-12 23:41:25 +0000605 return arrangeFreeFunctionLikeCall(*this, CGM, args, fnType, 1,
606 /*chainCall=*/false);
John McCalla729c622012-02-17 03:33:10 +0000607}
608
609const CGFunctionInfo &
John McCallc56a8b32016-03-11 04:30:31 +0000610CodeGenTypes::arrangeBlockFunctionDeclaration(const FunctionProtoType *proto,
611 const FunctionArgList &params) {
612 auto paramInfos = getExtParameterInfosForCall(proto, 1, params.size());
613 auto argTypes = getArgTypesForDeclaration(Context, params);
614
George Burgess IV419996c2016-06-16 23:06:04 +0000615 return arrangeLLVMFunctionInfo(
616 GetReturnType(proto->getReturnType()),
617 /*instanceMethod*/ false, /*chainCall*/ false, argTypes,
618 proto->getExtInfo(), paramInfos,
619 RequiredArgs::forPrototypePlus(proto, 1, nullptr));
John McCallc56a8b32016-03-11 04:30:31 +0000620}
621
622const CGFunctionInfo &
623CodeGenTypes::arrangeBuiltinFunctionCall(QualType resultType,
624 const CallArgList &args) {
Daniel Dunbarbf8c24a2009-02-02 23:23:47 +0000625 // FIXME: Kill copy.
John McCalla729c622012-02-17 03:33:10 +0000626 SmallVector<CanQualType, 16> argTypes;
Alexey Samsonov3551e312014-08-13 20:06:24 +0000627 for (const auto &Arg : args)
628 argTypes.push_back(Context.getCanonicalParamType(Arg.Ty));
Peter Collingbournef7706832014-12-12 23:41:25 +0000629 return arrangeLLVMFunctionInfo(
630 GetReturnType(resultType), /*instanceMethod=*/false,
John McCallc56a8b32016-03-11 04:30:31 +0000631 /*chainCall=*/false, argTypes, FunctionType::ExtInfo(),
632 /*paramInfos=*/ {}, RequiredArgs::All);
John McCall8dda7b22012-07-07 06:41:13 +0000633}
634
John McCallc56a8b32016-03-11 04:30:31 +0000635const CGFunctionInfo &
636CodeGenTypes::arrangeBuiltinFunctionDeclaration(QualType resultType,
637 const FunctionArgList &args) {
638 auto argTypes = getArgTypesForDeclaration(Context, args);
639
640 return arrangeLLVMFunctionInfo(
641 GetReturnType(resultType), /*instanceMethod=*/false, /*chainCall=*/false,
642 argTypes, FunctionType::ExtInfo(), {}, RequiredArgs::All);
643}
644
645const CGFunctionInfo &
646CodeGenTypes::arrangeBuiltinFunctionDeclaration(CanQualType resultType,
647 ArrayRef<CanQualType> argTypes) {
648 return arrangeLLVMFunctionInfo(
649 resultType, /*instanceMethod=*/false, /*chainCall=*/false,
650 argTypes, FunctionType::ExtInfo(), {}, RequiredArgs::All);
651}
652
John McCall8dda7b22012-07-07 06:41:13 +0000653/// Arrange a call to a C++ method, passing the given arguments.
George Burgess IVd0a9e802017-02-23 22:07:35 +0000654///
655/// numPrefixArgs is the number of ABI-specific prefix arguments we have. It
656/// does not count `this`.
John McCall8dda7b22012-07-07 06:41:13 +0000657const CGFunctionInfo &
658CodeGenTypes::arrangeCXXMethodCall(const CallArgList &args,
John McCallc56a8b32016-03-11 04:30:31 +0000659 const FunctionProtoType *proto,
George Burgess IVd0a9e802017-02-23 22:07:35 +0000660 RequiredArgs required,
661 unsigned numPrefixArgs) {
662 assert(numPrefixArgs + 1 <= args.size() &&
663 "Emitting a call with less args than the required prefix?");
664 // Add one to account for `this`. It's a bit awkward here, but we don't count
665 // `this` in similar places elsewhere.
John McCallc56a8b32016-03-11 04:30:31 +0000666 auto paramInfos =
George Burgess IVd0a9e802017-02-23 22:07:35 +0000667 getExtParameterInfosForCall(proto, numPrefixArgs + 1, args.size());
John McCallc56a8b32016-03-11 04:30:31 +0000668
John McCall8dda7b22012-07-07 06:41:13 +0000669 // FIXME: Kill copy.
John McCallc56a8b32016-03-11 04:30:31 +0000670 auto argTypes = getArgTypesForCall(Context, args);
John McCall8dda7b22012-07-07 06:41:13 +0000671
John McCallc56a8b32016-03-11 04:30:31 +0000672 FunctionType::ExtInfo info = proto->getExtInfo();
Peter Collingbournef7706832014-12-12 23:41:25 +0000673 return arrangeLLVMFunctionInfo(
John McCallc56a8b32016-03-11 04:30:31 +0000674 GetReturnType(proto->getReturnType()), /*instanceMethod=*/true,
675 /*chainCall=*/false, argTypes, info, paramInfos, required);
Daniel Dunbarbf8c24a2009-02-02 23:23:47 +0000676}
677
John McCalla729c622012-02-17 03:33:10 +0000678const CGFunctionInfo &CodeGenTypes::arrangeNullaryFunction() {
Peter Collingbournef7706832014-12-12 23:41:25 +0000679 return arrangeLLVMFunctionInfo(
680 getContext().VoidTy, /*instanceMethod=*/false, /*chainCall=*/false,
John McCallc56a8b32016-03-11 04:30:31 +0000681 None, FunctionType::ExtInfo(), {}, RequiredArgs::All);
682}
683
684const CGFunctionInfo &
685CodeGenTypes::arrangeCall(const CGFunctionInfo &signature,
686 const CallArgList &args) {
687 assert(signature.arg_size() <= args.size());
688 if (signature.arg_size() == args.size())
689 return signature;
690
691 SmallVector<FunctionProtoType::ExtParameterInfo, 16> paramInfos;
692 auto sigParamInfos = signature.getExtParameterInfos();
693 if (!sigParamInfos.empty()) {
694 paramInfos.append(sigParamInfos.begin(), sigParamInfos.end());
695 paramInfos.resize(args.size());
696 }
697
698 auto argTypes = getArgTypesForCall(Context, args);
699
700 assert(signature.getRequiredArgs().allowsOptionalArgs());
701 return arrangeLLVMFunctionInfo(signature.getReturnType(),
702 signature.isInstanceMethod(),
703 signature.isChainCall(),
704 argTypes,
705 signature.getExtInfo(),
706 paramInfos,
707 signature.getRequiredArgs());
John McCalla738c252011-03-09 04:27:21 +0000708}
709
Pekka Jaaskelainenfc2629a2017-06-01 07:18:49 +0000710namespace clang {
711namespace CodeGen {
712void computeSPIRKernelABIInfo(CodeGenModule &CGM, CGFunctionInfo &FI);
713}
714}
715
John McCalla729c622012-02-17 03:33:10 +0000716/// Arrange the argument and result information for an abstract value
717/// of a given function type. This is the method which all of the
718/// above functions ultimately defer to.
719const CGFunctionInfo &
John McCall8dda7b22012-07-07 06:41:13 +0000720CodeGenTypes::arrangeLLVMFunctionInfo(CanQualType resultType,
Peter Collingbournef7706832014-12-12 23:41:25 +0000721 bool instanceMethod,
722 bool chainCall,
John McCall8dda7b22012-07-07 06:41:13 +0000723 ArrayRef<CanQualType> argTypes,
724 FunctionType::ExtInfo info,
John McCallc56a8b32016-03-11 04:30:31 +0000725 ArrayRef<FunctionProtoType::ExtParameterInfo> paramInfos,
John McCall8dda7b22012-07-07 06:41:13 +0000726 RequiredArgs required) {
Saleem Abdulrasool32d1a962014-11-25 03:49:50 +0000727 assert(std::all_of(argTypes.begin(), argTypes.end(),
Richard Smith2c27df72017-03-23 23:17:58 +0000728 [](CanQualType T) { return T.isCanonicalAsParam(); }));
John McCall2da83a32010-02-26 00:48:12 +0000729
Daniel Dunbare0be8292009-02-03 00:07:12 +0000730 // Lookup or create unique function info.
731 llvm::FoldingSetNodeID ID;
John McCallc56a8b32016-03-11 04:30:31 +0000732 CGFunctionInfo::Profile(ID, instanceMethod, chainCall, info, paramInfos,
733 required, resultType, argTypes);
Daniel Dunbare0be8292009-02-03 00:07:12 +0000734
Craig Topper8a13c412014-05-21 05:09:00 +0000735 void *insertPos = nullptr;
John McCalla729c622012-02-17 03:33:10 +0000736 CGFunctionInfo *FI = FunctionInfos.FindNodeOrInsertPos(ID, insertPos);
Daniel Dunbare0be8292009-02-03 00:07:12 +0000737 if (FI)
738 return *FI;
739
John McCallc56a8b32016-03-11 04:30:31 +0000740 unsigned CC = ClangCallConvToLLVMCallConv(info.getCC());
741
John McCalla729c622012-02-17 03:33:10 +0000742 // Construct the function info. We co-allocate the ArgInfos.
Peter Collingbournef7706832014-12-12 23:41:25 +0000743 FI = CGFunctionInfo::create(CC, instanceMethod, chainCall, info,
John McCallc56a8b32016-03-11 04:30:31 +0000744 paramInfos, resultType, argTypes, required);
John McCalla729c622012-02-17 03:33:10 +0000745 FunctionInfos.InsertNode(FI, insertPos);
Daniel Dunbar313321e2009-02-03 05:31:23 +0000746
David Blaikie82e95a32014-11-19 07:49:47 +0000747 bool inserted = FunctionsBeingProcessed.insert(FI).second;
748 (void)inserted;
John McCalla729c622012-02-17 03:33:10 +0000749 assert(inserted && "Recursively being processed?");
Pekka Jaaskelainenfc2629a2017-06-01 07:18:49 +0000750
Daniel Dunbar313321e2009-02-03 05:31:23 +0000751 // Compute ABI information.
Pekka Jaaskelainenfc2629a2017-06-01 07:18:49 +0000752 if (CC == llvm::CallingConv::SPIR_KERNEL) {
753 // Force target independent argument handling for the host visible
754 // kernel functions.
755 computeSPIRKernelABIInfo(CGM, *FI);
756 } else if (info.getCC() == CC_Swift) {
John McCall12f23522016-04-04 18:33:08 +0000757 swiftcall::computeABIInfo(CGM, *FI);
Pekka Jaaskelainenfc2629a2017-06-01 07:18:49 +0000758 } else {
759 getABIInfo().computeInfo(*FI);
John McCall12f23522016-04-04 18:33:08 +0000760 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000761
Chris Lattnerfe34c1d2010-07-29 06:26:06 +0000762 // Loop over all of the computed argument and return value info. If any of
763 // them are direct or extend without a specified coerce type, specify the
764 // default now.
John McCalla729c622012-02-17 03:33:10 +0000765 ABIArgInfo &retInfo = FI->getReturnInfo();
Craig Topper8a13c412014-05-21 05:09:00 +0000766 if (retInfo.canHaveCoerceToType() && retInfo.getCoerceToType() == nullptr)
John McCalla729c622012-02-17 03:33:10 +0000767 retInfo.setCoerceToType(ConvertType(FI->getReturnType()));
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000768
Aaron Ballmanec47bc22014-03-17 18:10:01 +0000769 for (auto &I : FI->arguments())
Craig Topper8a13c412014-05-21 05:09:00 +0000770 if (I.info.canHaveCoerceToType() && I.info.getCoerceToType() == nullptr)
Aaron Ballmanec47bc22014-03-17 18:10:01 +0000771 I.info.setCoerceToType(ConvertType(I.type));
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000772
John McCalla729c622012-02-17 03:33:10 +0000773 bool erased = FunctionsBeingProcessed.erase(FI); (void)erased;
774 assert(erased && "Not in set?");
Chris Lattner1a651332011-07-15 06:41:05 +0000775
Daniel Dunbare0be8292009-02-03 00:07:12 +0000776 return *FI;
Daniel Dunbarbf8c24a2009-02-02 23:23:47 +0000777}
778
John McCalla729c622012-02-17 03:33:10 +0000779CGFunctionInfo *CGFunctionInfo::create(unsigned llvmCC,
Peter Collingbournef7706832014-12-12 23:41:25 +0000780 bool instanceMethod,
781 bool chainCall,
John McCalla729c622012-02-17 03:33:10 +0000782 const FunctionType::ExtInfo &info,
John McCallc56a8b32016-03-11 04:30:31 +0000783 ArrayRef<ExtParameterInfo> paramInfos,
John McCalla729c622012-02-17 03:33:10 +0000784 CanQualType resultType,
785 ArrayRef<CanQualType> argTypes,
786 RequiredArgs required) {
John McCallc56a8b32016-03-11 04:30:31 +0000787 assert(paramInfos.empty() || paramInfos.size() == argTypes.size());
788
789 void *buffer =
790 operator new(totalSizeToAlloc<ArgInfo, ExtParameterInfo>(
791 argTypes.size() + 1, paramInfos.size()));
792
John McCalla729c622012-02-17 03:33:10 +0000793 CGFunctionInfo *FI = new(buffer) CGFunctionInfo();
794 FI->CallingConvention = llvmCC;
795 FI->EffectiveCallingConvention = llvmCC;
796 FI->ASTCallingConvention = info.getCC();
Peter Collingbournef7706832014-12-12 23:41:25 +0000797 FI->InstanceMethod = instanceMethod;
798 FI->ChainCall = chainCall;
John McCalla729c622012-02-17 03:33:10 +0000799 FI->NoReturn = info.getNoReturn();
800 FI->ReturnsRetained = info.getProducesResult();
Oren Ben Simhon318a6ea2017-04-27 12:01:00 +0000801 FI->NoCallerSavedRegs = info.getNoCallerSavedRegs();
John McCalla729c622012-02-17 03:33:10 +0000802 FI->Required = required;
803 FI->HasRegParm = info.getHasRegParm();
804 FI->RegParm = info.getRegParm();
Craig Topper8a13c412014-05-21 05:09:00 +0000805 FI->ArgStruct = nullptr;
John McCall7f416cc2015-09-08 08:05:57 +0000806 FI->ArgStructAlign = 0;
John McCalla729c622012-02-17 03:33:10 +0000807 FI->NumArgs = argTypes.size();
John McCallc56a8b32016-03-11 04:30:31 +0000808 FI->HasExtParameterInfos = !paramInfos.empty();
John McCalla729c622012-02-17 03:33:10 +0000809 FI->getArgsBuffer()[0].type = resultType;
810 for (unsigned i = 0, e = argTypes.size(); i != e; ++i)
811 FI->getArgsBuffer()[i + 1].type = argTypes[i];
John McCallc56a8b32016-03-11 04:30:31 +0000812 for (unsigned i = 0, e = paramInfos.size(); i != e; ++i)
813 FI->getExtParameterInfosBuffer()[i] = paramInfos[i];
John McCalla729c622012-02-17 03:33:10 +0000814 return FI;
Daniel Dunbar313321e2009-02-03 05:31:23 +0000815}
816
817/***/
818
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000819namespace {
820// ABIArgInfo::Expand implementation.
821
822// Specifies the way QualType passed as ABIArgInfo::Expand is expanded.
823struct TypeExpansion {
824 enum TypeExpansionKind {
825 // Elements of constant arrays are expanded recursively.
826 TEK_ConstantArray,
827 // Record fields are expanded recursively (but if record is a union, only
828 // the field with the largest size is expanded).
829 TEK_Record,
830 // For complex types, real and imaginary parts are expanded recursively.
831 TEK_Complex,
832 // All other types are not expandable.
833 TEK_None
834 };
835
836 const TypeExpansionKind Kind;
837
838 TypeExpansion(TypeExpansionKind K) : Kind(K) {}
Angel Garcia Gomez637d1e62015-10-20 13:23:58 +0000839 virtual ~TypeExpansion() {}
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000840};
841
842struct ConstantArrayExpansion : TypeExpansion {
843 QualType EltTy;
844 uint64_t NumElts;
845
846 ConstantArrayExpansion(QualType EltTy, uint64_t NumElts)
847 : TypeExpansion(TEK_ConstantArray), EltTy(EltTy), NumElts(NumElts) {}
848 static bool classof(const TypeExpansion *TE) {
849 return TE->Kind == TEK_ConstantArray;
850 }
851};
852
853struct RecordExpansion : TypeExpansion {
Reid Klecknere9f6a712014-10-31 17:10:41 +0000854 SmallVector<const CXXBaseSpecifier *, 1> Bases;
855
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000856 SmallVector<const FieldDecl *, 1> Fields;
857
Reid Klecknere9f6a712014-10-31 17:10:41 +0000858 RecordExpansion(SmallVector<const CXXBaseSpecifier *, 1> &&Bases,
859 SmallVector<const FieldDecl *, 1> &&Fields)
Benjamin Kramer0bb97742016-02-13 16:00:13 +0000860 : TypeExpansion(TEK_Record), Bases(std::move(Bases)),
861 Fields(std::move(Fields)) {}
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000862 static bool classof(const TypeExpansion *TE) {
863 return TE->Kind == TEK_Record;
864 }
865};
866
867struct ComplexExpansion : TypeExpansion {
868 QualType EltTy;
869
870 ComplexExpansion(QualType EltTy) : TypeExpansion(TEK_Complex), EltTy(EltTy) {}
871 static bool classof(const TypeExpansion *TE) {
872 return TE->Kind == TEK_Complex;
873 }
874};
875
876struct NoExpansion : TypeExpansion {
877 NoExpansion() : TypeExpansion(TEK_None) {}
878 static bool classof(const TypeExpansion *TE) {
879 return TE->Kind == TEK_None;
880 }
881};
882} // namespace
883
884static std::unique_ptr<TypeExpansion>
885getTypeExpansion(QualType Ty, const ASTContext &Context) {
886 if (const ConstantArrayType *AT = Context.getAsConstantArrayType(Ty)) {
887 return llvm::make_unique<ConstantArrayExpansion>(
888 AT->getElementType(), AT->getSize().getZExtValue());
889 }
890 if (const RecordType *RT = Ty->getAs<RecordType>()) {
Reid Klecknere9f6a712014-10-31 17:10:41 +0000891 SmallVector<const CXXBaseSpecifier *, 1> Bases;
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000892 SmallVector<const FieldDecl *, 1> Fields;
Bob Wilsone826a2a2011-08-03 05:58:22 +0000893 const RecordDecl *RD = RT->getDecl();
894 assert(!RD->hasFlexibleArrayMember() &&
895 "Cannot expand structure with flexible array.");
Anton Korobeynikov4215ca72012-04-13 11:22:00 +0000896 if (RD->isUnion()) {
897 // Unions can be here only in degenerative cases - all the fields are same
898 // after flattening. Thus we have to use the "largest" field.
Craig Topper8a13c412014-05-21 05:09:00 +0000899 const FieldDecl *LargestFD = nullptr;
Anton Korobeynikov4215ca72012-04-13 11:22:00 +0000900 CharUnits UnionSize = CharUnits::Zero();
901
Aaron Ballmane8a8bae2014-03-08 20:12:42 +0000902 for (const auto *FD : RD->fields()) {
Reid Kleckner80944df2014-10-31 22:00:51 +0000903 // Skip zero length bitfields.
904 if (FD->isBitField() && FD->getBitWidthValue(Context) == 0)
905 continue;
Anton Korobeynikov4215ca72012-04-13 11:22:00 +0000906 assert(!FD->isBitField() &&
907 "Cannot expand structure with bit-field members.");
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000908 CharUnits FieldSize = Context.getTypeSizeInChars(FD->getType());
Anton Korobeynikov4215ca72012-04-13 11:22:00 +0000909 if (UnionSize < FieldSize) {
910 UnionSize = FieldSize;
911 LargestFD = FD;
912 }
913 }
914 if (LargestFD)
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000915 Fields.push_back(LargestFD);
Anton Korobeynikov4215ca72012-04-13 11:22:00 +0000916 } else {
Reid Klecknere9f6a712014-10-31 17:10:41 +0000917 if (const auto *CXXRD = dyn_cast<CXXRecordDecl>(RD)) {
918 assert(!CXXRD->isDynamicClass() &&
919 "cannot expand vtable pointers in dynamic classes");
920 for (const CXXBaseSpecifier &BS : CXXRD->bases())
921 Bases.push_back(&BS);
922 }
923
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000924 for (const auto *FD : RD->fields()) {
Reid Kleckner80944df2014-10-31 22:00:51 +0000925 // Skip zero length bitfields.
926 if (FD->isBitField() && FD->getBitWidthValue(Context) == 0)
927 continue;
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000928 assert(!FD->isBitField() &&
Anton Korobeynikov4215ca72012-04-13 11:22:00 +0000929 "Cannot expand structure with bit-field members.");
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000930 Fields.push_back(FD);
Anton Korobeynikov4215ca72012-04-13 11:22:00 +0000931 }
Bob Wilsone826a2a2011-08-03 05:58:22 +0000932 }
Reid Klecknere9f6a712014-10-31 17:10:41 +0000933 return llvm::make_unique<RecordExpansion>(std::move(Bases),
934 std::move(Fields));
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000935 }
936 if (const ComplexType *CT = Ty->getAs<ComplexType>()) {
937 return llvm::make_unique<ComplexExpansion>(CT->getElementType());
938 }
939 return llvm::make_unique<NoExpansion>();
940}
941
Alexey Samsonov52c0f6a2014-09-29 20:30:22 +0000942static int getExpansionSize(QualType Ty, const ASTContext &Context) {
943 auto Exp = getTypeExpansion(Ty, Context);
944 if (auto CAExp = dyn_cast<ConstantArrayExpansion>(Exp.get())) {
945 return CAExp->NumElts * getExpansionSize(CAExp->EltTy, Context);
946 }
947 if (auto RExp = dyn_cast<RecordExpansion>(Exp.get())) {
948 int Res = 0;
Reid Klecknere9f6a712014-10-31 17:10:41 +0000949 for (auto BS : RExp->Bases)
950 Res += getExpansionSize(BS->getType(), Context);
Alexey Samsonov52c0f6a2014-09-29 20:30:22 +0000951 for (auto FD : RExp->Fields)
952 Res += getExpansionSize(FD->getType(), Context);
953 return Res;
954 }
955 if (isa<ComplexExpansion>(Exp.get()))
956 return 2;
957 assert(isa<NoExpansion>(Exp.get()));
958 return 1;
959}
960
Alexey Samsonov153004f2014-09-29 22:08:00 +0000961void
962CodeGenTypes::getExpandedTypes(QualType Ty,
963 SmallVectorImpl<llvm::Type *>::iterator &TI) {
964 auto Exp = getTypeExpansion(Ty, Context);
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000965 if (auto CAExp = dyn_cast<ConstantArrayExpansion>(Exp.get())) {
966 for (int i = 0, n = CAExp->NumElts; i < n; i++) {
Alexey Samsonov153004f2014-09-29 22:08:00 +0000967 getExpandedTypes(CAExp->EltTy, TI);
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000968 }
969 } else if (auto RExp = dyn_cast<RecordExpansion>(Exp.get())) {
Reid Klecknere9f6a712014-10-31 17:10:41 +0000970 for (auto BS : RExp->Bases)
971 getExpandedTypes(BS->getType(), TI);
972 for (auto FD : RExp->Fields)
Alexey Samsonov153004f2014-09-29 22:08:00 +0000973 getExpandedTypes(FD->getType(), TI);
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000974 } else if (auto CExp = dyn_cast<ComplexExpansion>(Exp.get())) {
975 llvm::Type *EltTy = ConvertType(CExp->EltTy);
Alexey Samsonov153004f2014-09-29 22:08:00 +0000976 *TI++ = EltTy;
977 *TI++ = EltTy;
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000978 } else {
979 assert(isa<NoExpansion>(Exp.get()));
Alexey Samsonov153004f2014-09-29 22:08:00 +0000980 *TI++ = ConvertType(Ty);
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000981 }
Daniel Dunbar8fc81b02008-09-17 00:51:38 +0000982}
983
John McCall7f416cc2015-09-08 08:05:57 +0000984static void forConstantArrayExpansion(CodeGenFunction &CGF,
985 ConstantArrayExpansion *CAE,
986 Address BaseAddr,
987 llvm::function_ref<void(Address)> Fn) {
988 CharUnits EltSize = CGF.getContext().getTypeSizeInChars(CAE->EltTy);
989 CharUnits EltAlign =
990 BaseAddr.getAlignment().alignmentOfArrayElement(EltSize);
991
992 for (int i = 0, n = CAE->NumElts; i < n; i++) {
993 llvm::Value *EltAddr =
994 CGF.Builder.CreateConstGEP2_32(nullptr, BaseAddr.getPointer(), 0, i);
995 Fn(Address(EltAddr, EltAlign));
996 }
997}
998
Alexey Samsonov91cf4552014-08-22 01:06:06 +0000999void CodeGenFunction::ExpandTypeFromArgs(
John McCall12f23522016-04-04 18:33:08 +00001000 QualType Ty, LValue LV, SmallVectorImpl<llvm::Value *>::iterator &AI) {
Mike Stump11289f42009-09-09 15:08:12 +00001001 assert(LV.isSimple() &&
1002 "Unexpected non-simple lvalue during struct expansion.");
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00001003
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001004 auto Exp = getTypeExpansion(Ty, getContext());
1005 if (auto CAExp = dyn_cast<ConstantArrayExpansion>(Exp.get())) {
John McCall7f416cc2015-09-08 08:05:57 +00001006 forConstantArrayExpansion(*this, CAExp, LV.getAddress(),
1007 [&](Address EltAddr) {
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001008 LValue LV = MakeAddrLValue(EltAddr, CAExp->EltTy);
1009 ExpandTypeFromArgs(CAExp->EltTy, LV, AI);
John McCall7f416cc2015-09-08 08:05:57 +00001010 });
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001011 } else if (auto RExp = dyn_cast<RecordExpansion>(Exp.get())) {
John McCall7f416cc2015-09-08 08:05:57 +00001012 Address This = LV.getAddress();
Reid Klecknere9f6a712014-10-31 17:10:41 +00001013 for (const CXXBaseSpecifier *BS : RExp->Bases) {
1014 // Perform a single step derived-to-base conversion.
John McCall7f416cc2015-09-08 08:05:57 +00001015 Address Base =
Reid Klecknere9f6a712014-10-31 17:10:41 +00001016 GetAddressOfBaseClass(This, Ty->getAsCXXRecordDecl(), &BS, &BS + 1,
1017 /*NullCheckValue=*/false, SourceLocation());
1018 LValue SubLV = MakeAddrLValue(Base, BS->getType());
1019
1020 // Recurse onto bases.
1021 ExpandTypeFromArgs(BS->getType(), SubLV, AI);
1022 }
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001023 for (auto FD : RExp->Fields) {
1024 // FIXME: What are the right qualifiers here?
Reid Kleckner9d031092016-05-02 22:42:34 +00001025 LValue SubLV = EmitLValueForFieldInitialization(LV, FD);
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001026 ExpandTypeFromArgs(FD->getType(), SubLV, AI);
Bob Wilsone826a2a2011-08-03 05:58:22 +00001027 }
John McCall7f416cc2015-09-08 08:05:57 +00001028 } else if (isa<ComplexExpansion>(Exp.get())) {
1029 auto realValue = *AI++;
1030 auto imagValue = *AI++;
1031 EmitStoreOfComplex(ComplexPairTy(realValue, imagValue), LV, /*init*/ true);
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001032 } else {
1033 assert(isa<NoExpansion>(Exp.get()));
1034 EmitStoreThroughLValue(RValue::get(*AI++), LV);
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00001035 }
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001036}
1037
1038void CodeGenFunction::ExpandTypeToArgs(
1039 QualType Ty, RValue RV, llvm::FunctionType *IRFuncTy,
1040 SmallVectorImpl<llvm::Value *> &IRCallArgs, unsigned &IRCallArgPos) {
1041 auto Exp = getTypeExpansion(Ty, getContext());
1042 if (auto CAExp = dyn_cast<ConstantArrayExpansion>(Exp.get())) {
John McCall7f416cc2015-09-08 08:05:57 +00001043 forConstantArrayExpansion(*this, CAExp, RV.getAggregateAddress(),
1044 [&](Address EltAddr) {
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001045 RValue EltRV =
1046 convertTempToRValue(EltAddr, CAExp->EltTy, SourceLocation());
1047 ExpandTypeToArgs(CAExp->EltTy, EltRV, IRFuncTy, IRCallArgs, IRCallArgPos);
John McCall7f416cc2015-09-08 08:05:57 +00001048 });
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001049 } else if (auto RExp = dyn_cast<RecordExpansion>(Exp.get())) {
John McCall7f416cc2015-09-08 08:05:57 +00001050 Address This = RV.getAggregateAddress();
Reid Klecknere9f6a712014-10-31 17:10:41 +00001051 for (const CXXBaseSpecifier *BS : RExp->Bases) {
1052 // Perform a single step derived-to-base conversion.
John McCall7f416cc2015-09-08 08:05:57 +00001053 Address Base =
Reid Klecknere9f6a712014-10-31 17:10:41 +00001054 GetAddressOfBaseClass(This, Ty->getAsCXXRecordDecl(), &BS, &BS + 1,
1055 /*NullCheckValue=*/false, SourceLocation());
1056 RValue BaseRV = RValue::getAggregate(Base);
1057
1058 // Recurse onto bases.
1059 ExpandTypeToArgs(BS->getType(), BaseRV, IRFuncTy, IRCallArgs,
1060 IRCallArgPos);
1061 }
1062
1063 LValue LV = MakeAddrLValue(This, Ty);
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001064 for (auto FD : RExp->Fields) {
1065 RValue FldRV = EmitRValueForField(LV, FD, SourceLocation());
1066 ExpandTypeToArgs(FD->getType(), FldRV, IRFuncTy, IRCallArgs,
1067 IRCallArgPos);
1068 }
1069 } else if (isa<ComplexExpansion>(Exp.get())) {
1070 ComplexPairTy CV = RV.getComplexVal();
1071 IRCallArgs[IRCallArgPos++] = CV.first;
1072 IRCallArgs[IRCallArgPos++] = CV.second;
1073 } else {
1074 assert(isa<NoExpansion>(Exp.get()));
1075 assert(RV.isScalar() &&
1076 "Unexpected non-scalar rvalue during struct expansion.");
1077
1078 // Insert a bitcast as needed.
1079 llvm::Value *V = RV.getScalarVal();
1080 if (IRCallArgPos < IRFuncTy->getNumParams() &&
1081 V->getType() != IRFuncTy->getParamType(IRCallArgPos))
1082 V = Builder.CreateBitCast(V, IRFuncTy->getParamType(IRCallArgPos));
1083
1084 IRCallArgs[IRCallArgPos++] = V;
1085 }
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00001086}
1087
John McCall7f416cc2015-09-08 08:05:57 +00001088/// Create a temporary allocation for the purposes of coercion.
1089static Address CreateTempAllocaForCoercion(CodeGenFunction &CGF, llvm::Type *Ty,
1090 CharUnits MinAlign) {
1091 // Don't use an alignment that's worse than what LLVM would prefer.
1092 auto PrefAlign = CGF.CGM.getDataLayout().getPrefTypeAlignment(Ty);
1093 CharUnits Align = std::max(MinAlign, CharUnits::fromQuantity(PrefAlign));
1094
1095 return CGF.CreateTempAlloca(Ty, Align);
1096}
1097
Chris Lattner895c52b2010-06-27 06:04:18 +00001098/// EnterStructPointerForCoercedAccess - Given a struct pointer that we are
Chris Lattner1cd66982010-06-27 05:56:15 +00001099/// accessing some number of bytes out of it, try to gep into the struct to get
1100/// at its inner goodness. Dive as deep as possible without entering an element
1101/// with an in-memory size smaller than DstSize.
John McCall7f416cc2015-09-08 08:05:57 +00001102static Address
1103EnterStructPointerForCoercedAccess(Address SrcPtr,
Chris Lattner2192fe52011-07-18 04:24:23 +00001104 llvm::StructType *SrcSTy,
Chris Lattner895c52b2010-06-27 06:04:18 +00001105 uint64_t DstSize, CodeGenFunction &CGF) {
Chris Lattner1cd66982010-06-27 05:56:15 +00001106 // We can't dive into a zero-element struct.
1107 if (SrcSTy->getNumElements() == 0) return SrcPtr;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001108
Chris Lattner2192fe52011-07-18 04:24:23 +00001109 llvm::Type *FirstElt = SrcSTy->getElementType(0);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001110
Chris Lattner1cd66982010-06-27 05:56:15 +00001111 // 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 +00001112 // first element is the same size as the whole struct, we can enter it. The
1113 // comparison must be made on the store size and not the alloca size. Using
1114 // the alloca size may overstate the size of the load.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001115 uint64_t FirstEltSize =
James Molloy90d61012014-08-29 10:17:52 +00001116 CGF.CGM.getDataLayout().getTypeStoreSize(FirstElt);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001117 if (FirstEltSize < DstSize &&
James Molloy90d61012014-08-29 10:17:52 +00001118 FirstEltSize < CGF.CGM.getDataLayout().getTypeStoreSize(SrcSTy))
Chris Lattner1cd66982010-06-27 05:56:15 +00001119 return SrcPtr;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001120
Chris Lattner1cd66982010-06-27 05:56:15 +00001121 // GEP into the first element.
John McCall7f416cc2015-09-08 08:05:57 +00001122 SrcPtr = CGF.Builder.CreateStructGEP(SrcPtr, 0, CharUnits(), "coerce.dive");
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001123
Chris Lattner1cd66982010-06-27 05:56:15 +00001124 // If the first element is a struct, recurse.
John McCall7f416cc2015-09-08 08:05:57 +00001125 llvm::Type *SrcTy = SrcPtr.getElementType();
Chris Lattner2192fe52011-07-18 04:24:23 +00001126 if (llvm::StructType *SrcSTy = dyn_cast<llvm::StructType>(SrcTy))
Chris Lattner895c52b2010-06-27 06:04:18 +00001127 return EnterStructPointerForCoercedAccess(SrcPtr, SrcSTy, DstSize, CGF);
Chris Lattner1cd66982010-06-27 05:56:15 +00001128
1129 return SrcPtr;
1130}
1131
Chris Lattner055097f2010-06-27 06:26:04 +00001132/// CoerceIntOrPtrToIntOrPtr - Convert a value Val to the specific Ty where both
1133/// are either integers or pointers. This does a truncation of the value if it
1134/// is too large or a zero extension if it is too small.
Jakob Stoklund Olesen36af2522013-06-05 03:00:13 +00001135///
1136/// This behaves as if the value were coerced through memory, so on big-endian
1137/// targets the high bits are preserved in a truncation, while little-endian
1138/// targets preserve the low bits.
Chris Lattner055097f2010-06-27 06:26:04 +00001139static llvm::Value *CoerceIntOrPtrToIntOrPtr(llvm::Value *Val,
Chris Lattner2192fe52011-07-18 04:24:23 +00001140 llvm::Type *Ty,
Chris Lattner055097f2010-06-27 06:26:04 +00001141 CodeGenFunction &CGF) {
1142 if (Val->getType() == Ty)
1143 return Val;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001144
Chris Lattner055097f2010-06-27 06:26:04 +00001145 if (isa<llvm::PointerType>(Val->getType())) {
1146 // If this is Pointer->Pointer avoid conversion to and from int.
1147 if (isa<llvm::PointerType>(Ty))
1148 return CGF.Builder.CreateBitCast(Val, Ty, "coerce.val");
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001149
Chris Lattner055097f2010-06-27 06:26:04 +00001150 // Convert the pointer to an integer so we can play with its width.
Chris Lattner5e016ae2010-06-27 07:15:29 +00001151 Val = CGF.Builder.CreatePtrToInt(Val, CGF.IntPtrTy, "coerce.val.pi");
Chris Lattner055097f2010-06-27 06:26:04 +00001152 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001153
Chris Lattner2192fe52011-07-18 04:24:23 +00001154 llvm::Type *DestIntTy = Ty;
Chris Lattner055097f2010-06-27 06:26:04 +00001155 if (isa<llvm::PointerType>(DestIntTy))
Chris Lattner5e016ae2010-06-27 07:15:29 +00001156 DestIntTy = CGF.IntPtrTy;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001157
Jakob Stoklund Olesen36af2522013-06-05 03:00:13 +00001158 if (Val->getType() != DestIntTy) {
1159 const llvm::DataLayout &DL = CGF.CGM.getDataLayout();
1160 if (DL.isBigEndian()) {
1161 // Preserve the high bits on big-endian targets.
1162 // That is what memory coercion does.
James Molloy491cefb2014-05-07 17:41:15 +00001163 uint64_t SrcSize = DL.getTypeSizeInBits(Val->getType());
1164 uint64_t DstSize = DL.getTypeSizeInBits(DestIntTy);
1165
Jakob Stoklund Olesen36af2522013-06-05 03:00:13 +00001166 if (SrcSize > DstSize) {
1167 Val = CGF.Builder.CreateLShr(Val, SrcSize - DstSize, "coerce.highbits");
1168 Val = CGF.Builder.CreateTrunc(Val, DestIntTy, "coerce.val.ii");
1169 } else {
1170 Val = CGF.Builder.CreateZExt(Val, DestIntTy, "coerce.val.ii");
1171 Val = CGF.Builder.CreateShl(Val, DstSize - SrcSize, "coerce.highbits");
1172 }
1173 } else {
1174 // Little-endian targets preserve the low bits. No shifts required.
1175 Val = CGF.Builder.CreateIntCast(Val, DestIntTy, false, "coerce.val.ii");
1176 }
1177 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001178
Chris Lattner055097f2010-06-27 06:26:04 +00001179 if (isa<llvm::PointerType>(Ty))
1180 Val = CGF.Builder.CreateIntToPtr(Val, Ty, "coerce.val.ip");
1181 return Val;
1182}
1183
Chris Lattner1cd66982010-06-27 05:56:15 +00001184
1185
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001186/// CreateCoercedLoad - Create a load from \arg SrcPtr interpreted as
Ulrich Weigand6e2cea62015-07-10 11:31:43 +00001187/// a pointer to an object of type \arg Ty, known to be aligned to
1188/// \arg SrcAlign bytes.
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001189///
1190/// This safely handles the case when the src type is smaller than the
1191/// destination type; in this situation the values of bits which not
1192/// present in the src are undefined.
John McCall7f416cc2015-09-08 08:05:57 +00001193static llvm::Value *CreateCoercedLoad(Address Src, llvm::Type *Ty,
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001194 CodeGenFunction &CGF) {
John McCall7f416cc2015-09-08 08:05:57 +00001195 llvm::Type *SrcTy = Src.getElementType();
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001196
Chris Lattnerd200eda2010-06-28 22:51:39 +00001197 // If SrcTy and Ty are the same, just do a load.
1198 if (SrcTy == Ty)
John McCall7f416cc2015-09-08 08:05:57 +00001199 return CGF.Builder.CreateLoad(Src);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001200
Micah Villmowdd31ca12012-10-08 16:25:52 +00001201 uint64_t DstSize = CGF.CGM.getDataLayout().getTypeAllocSize(Ty);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001202
Chris Lattner2192fe52011-07-18 04:24:23 +00001203 if (llvm::StructType *SrcSTy = dyn_cast<llvm::StructType>(SrcTy)) {
John McCall7f416cc2015-09-08 08:05:57 +00001204 Src = EnterStructPointerForCoercedAccess(Src, SrcSTy, DstSize, CGF);
1205 SrcTy = Src.getType()->getElementType();
Chris Lattner1cd66982010-06-27 05:56:15 +00001206 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001207
Micah Villmowdd31ca12012-10-08 16:25:52 +00001208 uint64_t SrcSize = CGF.CGM.getDataLayout().getTypeAllocSize(SrcTy);
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001209
Chris Lattner055097f2010-06-27 06:26:04 +00001210 // If the source and destination are integer or pointer types, just do an
1211 // extension or truncation to the desired type.
1212 if ((isa<llvm::IntegerType>(Ty) || isa<llvm::PointerType>(Ty)) &&
1213 (isa<llvm::IntegerType>(SrcTy) || isa<llvm::PointerType>(SrcTy))) {
John McCall7f416cc2015-09-08 08:05:57 +00001214 llvm::Value *Load = CGF.Builder.CreateLoad(Src);
Chris Lattner055097f2010-06-27 06:26:04 +00001215 return CoerceIntOrPtrToIntOrPtr(Load, Ty, CGF);
1216 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001217
Daniel Dunbarb52d0772009-02-03 05:59:18 +00001218 // If load is legal, just bitcast the src pointer.
Daniel Dunbarffdb8432009-05-13 18:54:26 +00001219 if (SrcSize >= DstSize) {
Mike Stump18bb9282009-05-16 07:57:57 +00001220 // Generally SrcSize is never greater than DstSize, since this means we are
1221 // losing bits. However, this can happen in cases where the structure has
1222 // additional padding, for example due to a user specified alignment.
Daniel Dunbarffdb8432009-05-13 18:54:26 +00001223 //
Mike Stump18bb9282009-05-16 07:57:57 +00001224 // FIXME: Assert that we aren't truncating non-padding bits when have access
1225 // to that information.
Matt Arsenault7a124f32017-08-01 20:36:57 +00001226 Src = CGF.Builder.CreateBitCast(Src,
1227 Ty->getPointerTo(Src.getAddressSpace()));
John McCall7f416cc2015-09-08 08:05:57 +00001228 return CGF.Builder.CreateLoad(Src);
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001229 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001230
John McCall7f416cc2015-09-08 08:05:57 +00001231 // Otherwise do coercion through memory. This is stupid, but simple.
1232 Address Tmp = CreateTempAllocaForCoercion(CGF, Ty, Src.getAlignment());
1233 Address Casted = CGF.Builder.CreateBitCast(Tmp, CGF.Int8PtrTy);
1234 Address SrcCasted = CGF.Builder.CreateBitCast(Src, CGF.Int8PtrTy);
Manman Ren84b921f2012-11-28 22:08:52 +00001235 CGF.Builder.CreateMemCpy(Casted, SrcCasted,
1236 llvm::ConstantInt::get(CGF.IntPtrTy, SrcSize),
John McCall7f416cc2015-09-08 08:05:57 +00001237 false);
1238 return CGF.Builder.CreateLoad(Tmp);
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001239}
1240
Eli Friedmanaf9b3252011-05-17 21:08:01 +00001241// Function to store a first-class aggregate into memory. We prefer to
1242// store the elements rather than the aggregate to be more friendly to
1243// fast-isel.
1244// FIXME: Do we need to recurse here?
1245static void BuildAggStore(CodeGenFunction &CGF, llvm::Value *Val,
John McCall7f416cc2015-09-08 08:05:57 +00001246 Address Dest, bool DestIsVolatile) {
Eli Friedmanaf9b3252011-05-17 21:08:01 +00001247 // Prefer scalar stores to first-class aggregate stores.
Chris Lattner2192fe52011-07-18 04:24:23 +00001248 if (llvm::StructType *STy =
Eli Friedmanaf9b3252011-05-17 21:08:01 +00001249 dyn_cast<llvm::StructType>(Val->getType())) {
Ulrich Weigand6e2cea62015-07-10 11:31:43 +00001250 const llvm::StructLayout *Layout =
1251 CGF.CGM.getDataLayout().getStructLayout(STy);
1252
Eli Friedmanaf9b3252011-05-17 21:08:01 +00001253 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
John McCall7f416cc2015-09-08 08:05:57 +00001254 auto EltOffset = CharUnits::fromQuantity(Layout->getElementOffset(i));
1255 Address EltPtr = CGF.Builder.CreateStructGEP(Dest, i, EltOffset);
Eli Friedmanaf9b3252011-05-17 21:08:01 +00001256 llvm::Value *Elt = CGF.Builder.CreateExtractValue(Val, i);
John McCall7f416cc2015-09-08 08:05:57 +00001257 CGF.Builder.CreateStore(Elt, EltPtr, DestIsVolatile);
Eli Friedmanaf9b3252011-05-17 21:08:01 +00001258 }
1259 } else {
John McCall7f416cc2015-09-08 08:05:57 +00001260 CGF.Builder.CreateStore(Val, Dest, DestIsVolatile);
Eli Friedmanaf9b3252011-05-17 21:08:01 +00001261 }
1262}
1263
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001264/// CreateCoercedStore - Create a store to \arg DstPtr from \arg Src,
Ulrich Weigand6e2cea62015-07-10 11:31:43 +00001265/// where the source and destination may have different types. The
1266/// destination is known to be aligned to \arg DstAlign bytes.
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001267///
1268/// This safely handles the case when the src type is larger than the
1269/// destination type; the upper bits of the src will be lost.
1270static void CreateCoercedStore(llvm::Value *Src,
John McCall7f416cc2015-09-08 08:05:57 +00001271 Address Dst,
Anders Carlsson17490832009-12-24 20:40:36 +00001272 bool DstIsVolatile,
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001273 CodeGenFunction &CGF) {
Chris Lattner2192fe52011-07-18 04:24:23 +00001274 llvm::Type *SrcTy = Src->getType();
John McCall7f416cc2015-09-08 08:05:57 +00001275 llvm::Type *DstTy = Dst.getType()->getElementType();
Chris Lattnerd200eda2010-06-28 22:51:39 +00001276 if (SrcTy == DstTy) {
John McCall7f416cc2015-09-08 08:05:57 +00001277 CGF.Builder.CreateStore(Src, Dst, DstIsVolatile);
Chris Lattnerd200eda2010-06-28 22:51:39 +00001278 return;
1279 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001280
Micah Villmowdd31ca12012-10-08 16:25:52 +00001281 uint64_t SrcSize = CGF.CGM.getDataLayout().getTypeAllocSize(SrcTy);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001282
Chris Lattner2192fe52011-07-18 04:24:23 +00001283 if (llvm::StructType *DstSTy = dyn_cast<llvm::StructType>(DstTy)) {
John McCall7f416cc2015-09-08 08:05:57 +00001284 Dst = EnterStructPointerForCoercedAccess(Dst, DstSTy, SrcSize, CGF);
1285 DstTy = Dst.getType()->getElementType();
Chris Lattner895c52b2010-06-27 06:04:18 +00001286 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001287
Chris Lattner055097f2010-06-27 06:26:04 +00001288 // If the source and destination are integer or pointer types, just do an
1289 // extension or truncation to the desired type.
1290 if ((isa<llvm::IntegerType>(SrcTy) || isa<llvm::PointerType>(SrcTy)) &&
1291 (isa<llvm::IntegerType>(DstTy) || isa<llvm::PointerType>(DstTy))) {
1292 Src = CoerceIntOrPtrToIntOrPtr(Src, DstTy, CGF);
John McCall7f416cc2015-09-08 08:05:57 +00001293 CGF.Builder.CreateStore(Src, Dst, DstIsVolatile);
Chris Lattner055097f2010-06-27 06:26:04 +00001294 return;
1295 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001296
Micah Villmowdd31ca12012-10-08 16:25:52 +00001297 uint64_t DstSize = CGF.CGM.getDataLayout().getTypeAllocSize(DstTy);
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001298
Daniel Dunbar313321e2009-02-03 05:31:23 +00001299 // If store is legal, just bitcast the src pointer.
Daniel Dunbar4be99ff2009-06-05 07:58:54 +00001300 if (SrcSize <= DstSize) {
Yaxun Liue9e5c4f2017-06-29 18:47:45 +00001301 Dst = CGF.Builder.CreateElementBitCast(Dst, SrcTy);
John McCall7f416cc2015-09-08 08:05:57 +00001302 BuildAggStore(CGF, Src, Dst, DstIsVolatile);
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001303 } else {
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001304 // Otherwise do coercion through memory. This is stupid, but
1305 // simple.
Daniel Dunbar4be99ff2009-06-05 07:58:54 +00001306
1307 // Generally SrcSize is never greater than DstSize, since this means we are
1308 // losing bits. However, this can happen in cases where the structure has
1309 // additional padding, for example due to a user specified alignment.
1310 //
1311 // FIXME: Assert that we aren't truncating non-padding bits when have access
1312 // to that information.
John McCall7f416cc2015-09-08 08:05:57 +00001313 Address Tmp = CreateTempAllocaForCoercion(CGF, SrcTy, Dst.getAlignment());
1314 CGF.Builder.CreateStore(Src, Tmp);
1315 Address Casted = CGF.Builder.CreateBitCast(Tmp, CGF.Int8PtrTy);
1316 Address DstCasted = CGF.Builder.CreateBitCast(Dst, CGF.Int8PtrTy);
Manman Ren84b921f2012-11-28 22:08:52 +00001317 CGF.Builder.CreateMemCpy(DstCasted, Casted,
1318 llvm::ConstantInt::get(CGF.IntPtrTy, DstSize),
John McCall7f416cc2015-09-08 08:05:57 +00001319 false);
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001320 }
1321}
1322
John McCall7f416cc2015-09-08 08:05:57 +00001323static Address emitAddressAtOffset(CodeGenFunction &CGF, Address addr,
1324 const ABIArgInfo &info) {
1325 if (unsigned offset = info.getDirectOffset()) {
1326 addr = CGF.Builder.CreateElementBitCast(addr, CGF.Int8Ty);
1327 addr = CGF.Builder.CreateConstInBoundsByteGEP(addr,
1328 CharUnits::fromQuantity(offset));
1329 addr = CGF.Builder.CreateElementBitCast(addr, info.getCoerceToType());
1330 }
1331 return addr;
1332}
1333
Alexey Samsonov153004f2014-09-29 22:08:00 +00001334namespace {
1335
1336/// Encapsulates information about the way function arguments from
1337/// CGFunctionInfo should be passed to actual LLVM IR function.
1338class ClangToLLVMArgMapping {
1339 static const unsigned InvalidIndex = ~0U;
1340 unsigned InallocaArgNo;
1341 unsigned SRetArgNo;
1342 unsigned TotalIRArgs;
1343
1344 /// Arguments of LLVM IR function corresponding to single Clang argument.
1345 struct IRArgs {
1346 unsigned PaddingArgIndex;
1347 // Argument is expanded to IR arguments at positions
1348 // [FirstArgIndex, FirstArgIndex + NumberOfArgs).
1349 unsigned FirstArgIndex;
1350 unsigned NumberOfArgs;
1351
1352 IRArgs()
1353 : PaddingArgIndex(InvalidIndex), FirstArgIndex(InvalidIndex),
1354 NumberOfArgs(0) {}
1355 };
1356
1357 SmallVector<IRArgs, 8> ArgInfo;
1358
1359public:
1360 ClangToLLVMArgMapping(const ASTContext &Context, const CGFunctionInfo &FI,
1361 bool OnlyRequiredArgs = false)
1362 : InallocaArgNo(InvalidIndex), SRetArgNo(InvalidIndex), TotalIRArgs(0),
1363 ArgInfo(OnlyRequiredArgs ? FI.getNumRequiredArgs() : FI.arg_size()) {
1364 construct(Context, FI, OnlyRequiredArgs);
1365 }
1366
1367 bool hasInallocaArg() const { return InallocaArgNo != InvalidIndex; }
1368 unsigned getInallocaArgNo() const {
1369 assert(hasInallocaArg());
1370 return InallocaArgNo;
1371 }
1372
1373 bool hasSRetArg() const { return SRetArgNo != InvalidIndex; }
1374 unsigned getSRetArgNo() const {
1375 assert(hasSRetArg());
1376 return SRetArgNo;
1377 }
1378
1379 unsigned totalIRArgs() const { return TotalIRArgs; }
1380
1381 bool hasPaddingArg(unsigned ArgNo) const {
1382 assert(ArgNo < ArgInfo.size());
1383 return ArgInfo[ArgNo].PaddingArgIndex != InvalidIndex;
1384 }
1385 unsigned getPaddingArgNo(unsigned ArgNo) const {
1386 assert(hasPaddingArg(ArgNo));
1387 return ArgInfo[ArgNo].PaddingArgIndex;
1388 }
1389
1390 /// Returns index of first IR argument corresponding to ArgNo, and their
1391 /// quantity.
1392 std::pair<unsigned, unsigned> getIRArgs(unsigned ArgNo) const {
1393 assert(ArgNo < ArgInfo.size());
1394 return std::make_pair(ArgInfo[ArgNo].FirstArgIndex,
1395 ArgInfo[ArgNo].NumberOfArgs);
1396 }
1397
1398private:
1399 void construct(const ASTContext &Context, const CGFunctionInfo &FI,
1400 bool OnlyRequiredArgs);
1401};
1402
1403void ClangToLLVMArgMapping::construct(const ASTContext &Context,
1404 const CGFunctionInfo &FI,
1405 bool OnlyRequiredArgs) {
1406 unsigned IRArgNo = 0;
1407 bool SwapThisWithSRet = false;
1408 const ABIArgInfo &RetAI = FI.getReturnInfo();
1409
1410 if (RetAI.getKind() == ABIArgInfo::Indirect) {
1411 SwapThisWithSRet = RetAI.isSRetAfterThis();
1412 SRetArgNo = SwapThisWithSRet ? 1 : IRArgNo++;
1413 }
1414
1415 unsigned ArgNo = 0;
1416 unsigned NumArgs = OnlyRequiredArgs ? FI.getNumRequiredArgs() : FI.arg_size();
1417 for (CGFunctionInfo::const_arg_iterator I = FI.arg_begin(); ArgNo < NumArgs;
1418 ++I, ++ArgNo) {
1419 assert(I != FI.arg_end());
1420 QualType ArgType = I->type;
1421 const ABIArgInfo &AI = I->info;
1422 // Collect data about IR arguments corresponding to Clang argument ArgNo.
1423 auto &IRArgs = ArgInfo[ArgNo];
1424
1425 if (AI.getPaddingType())
1426 IRArgs.PaddingArgIndex = IRArgNo++;
1427
1428 switch (AI.getKind()) {
1429 case ABIArgInfo::Extend:
1430 case ABIArgInfo::Direct: {
1431 // FIXME: handle sseregparm someday...
1432 llvm::StructType *STy = dyn_cast<llvm::StructType>(AI.getCoerceToType());
1433 if (AI.isDirect() && AI.getCanBeFlattened() && STy) {
1434 IRArgs.NumberOfArgs = STy->getNumElements();
1435 } else {
1436 IRArgs.NumberOfArgs = 1;
1437 }
1438 break;
1439 }
1440 case ABIArgInfo::Indirect:
1441 IRArgs.NumberOfArgs = 1;
1442 break;
1443 case ABIArgInfo::Ignore:
1444 case ABIArgInfo::InAlloca:
1445 // ignore and inalloca doesn't have matching LLVM parameters.
1446 IRArgs.NumberOfArgs = 0;
1447 break;
John McCallf26e73d2016-03-11 04:30:43 +00001448 case ABIArgInfo::CoerceAndExpand:
1449 IRArgs.NumberOfArgs = AI.getCoerceAndExpandTypeSequence().size();
1450 break;
1451 case ABIArgInfo::Expand:
Alexey Samsonov153004f2014-09-29 22:08:00 +00001452 IRArgs.NumberOfArgs = getExpansionSize(ArgType, Context);
1453 break;
1454 }
Alexey Samsonov153004f2014-09-29 22:08:00 +00001455
1456 if (IRArgs.NumberOfArgs > 0) {
1457 IRArgs.FirstArgIndex = IRArgNo;
1458 IRArgNo += IRArgs.NumberOfArgs;
1459 }
1460
1461 // Skip over the sret parameter when it comes second. We already handled it
1462 // above.
1463 if (IRArgNo == 1 && SwapThisWithSRet)
1464 IRArgNo++;
1465 }
1466 assert(ArgNo == ArgInfo.size());
1467
1468 if (FI.usesInAlloca())
1469 InallocaArgNo = IRArgNo++;
1470
1471 TotalIRArgs = IRArgNo;
1472}
1473} // namespace
1474
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00001475/***/
1476
Daniel Dunbar6f2e8392010-07-14 23:39:36 +00001477bool CodeGenModule::ReturnTypeUsesSRet(const CGFunctionInfo &FI) {
Daniel Dunbarb8b1c672009-02-05 08:00:50 +00001478 return FI.getReturnInfo().isIndirect();
Daniel Dunbar7633cbf2009-02-02 21:43:58 +00001479}
1480
Tim Northovere77cc392014-03-29 13:28:05 +00001481bool CodeGenModule::ReturnSlotInterferesWithArgs(const CGFunctionInfo &FI) {
1482 return ReturnTypeUsesSRet(FI) &&
1483 getTargetCodeGenInfo().doesReturnSlotInterfereWithArgs();
1484}
1485
Daniel Dunbar6f2e8392010-07-14 23:39:36 +00001486bool CodeGenModule::ReturnTypeUsesFPRet(QualType ResultType) {
1487 if (const BuiltinType *BT = ResultType->getAs<BuiltinType>()) {
1488 switch (BT->getKind()) {
1489 default:
1490 return false;
1491 case BuiltinType::Float:
John McCallc8e01702013-04-16 22:48:15 +00001492 return getTarget().useObjCFPRetForRealType(TargetInfo::Float);
Daniel Dunbar6f2e8392010-07-14 23:39:36 +00001493 case BuiltinType::Double:
John McCallc8e01702013-04-16 22:48:15 +00001494 return getTarget().useObjCFPRetForRealType(TargetInfo::Double);
Daniel Dunbar6f2e8392010-07-14 23:39:36 +00001495 case BuiltinType::LongDouble:
John McCallc8e01702013-04-16 22:48:15 +00001496 return getTarget().useObjCFPRetForRealType(TargetInfo::LongDouble);
Daniel Dunbar6f2e8392010-07-14 23:39:36 +00001497 }
1498 }
1499
1500 return false;
1501}
1502
Anders Carlsson2f1a6c32011-10-31 16:27:11 +00001503bool CodeGenModule::ReturnTypeUsesFP2Ret(QualType ResultType) {
1504 if (const ComplexType *CT = ResultType->getAs<ComplexType>()) {
1505 if (const BuiltinType *BT = CT->getElementType()->getAs<BuiltinType>()) {
1506 if (BT->getKind() == BuiltinType::LongDouble)
John McCallc8e01702013-04-16 22:48:15 +00001507 return getTarget().useObjCFP2RetForComplexLongDouble();
Anders Carlsson2f1a6c32011-10-31 16:27:11 +00001508 }
1509 }
1510
1511 return false;
1512}
1513
Chris Lattnera5f58b02011-07-09 17:41:47 +00001514llvm::FunctionType *CodeGenTypes::GetFunctionType(GlobalDecl GD) {
John McCalla729c622012-02-17 03:33:10 +00001515 const CGFunctionInfo &FI = arrangeGlobalDeclaration(GD);
1516 return GetFunctionType(FI);
John McCallf8ff7b92010-02-23 00:48:20 +00001517}
1518
Chris Lattnera5f58b02011-07-09 17:41:47 +00001519llvm::FunctionType *
John McCalla729c622012-02-17 03:33:10 +00001520CodeGenTypes::GetFunctionType(const CGFunctionInfo &FI) {
Alexey Samsonov153004f2014-09-29 22:08:00 +00001521
David Blaikie82e95a32014-11-19 07:49:47 +00001522 bool Inserted = FunctionsBeingProcessed.insert(&FI).second;
1523 (void)Inserted;
Chris Lattner6fb0ccf2011-07-15 05:16:14 +00001524 assert(Inserted && "Recursively being processed?");
Daniel Dunbar7a95ca32008-09-10 04:01:49 +00001525
Alexey Samsonov153004f2014-09-29 22:08:00 +00001526 llvm::Type *resultType = nullptr;
John McCall85dd2c52011-05-15 02:19:42 +00001527 const ABIArgInfo &retAI = FI.getReturnInfo();
1528 switch (retAI.getKind()) {
Daniel Dunbard3674e62008-09-11 01:48:57 +00001529 case ABIArgInfo::Expand:
John McCall85dd2c52011-05-15 02:19:42 +00001530 llvm_unreachable("Invalid ABI kind for return argument");
Daniel Dunbard3674e62008-09-11 01:48:57 +00001531
Anton Korobeynikov18adbf52009-06-06 09:36:29 +00001532 case ABIArgInfo::Extend:
Daniel Dunbar67dace892009-02-03 06:17:37 +00001533 case ABIArgInfo::Direct:
John McCall85dd2c52011-05-15 02:19:42 +00001534 resultType = retAI.getCoerceToType();
Daniel Dunbar67dace892009-02-03 06:17:37 +00001535 break;
1536
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001537 case ABIArgInfo::InAlloca:
Reid Klecknerfab1e892014-02-25 00:59:14 +00001538 if (retAI.getInAllocaSRet()) {
1539 // sret things on win32 aren't void, they return the sret pointer.
1540 QualType ret = FI.getReturnType();
1541 llvm::Type *ty = ConvertType(ret);
1542 unsigned addressSpace = Context.getTargetAddressSpace(ret);
1543 resultType = llvm::PointerType::get(ty, addressSpace);
1544 } else {
1545 resultType = llvm::Type::getVoidTy(getLLVMContext());
1546 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001547 break;
1548
John McCall7f416cc2015-09-08 08:05:57 +00001549 case ABIArgInfo::Indirect:
Daniel Dunbar94a6f252009-01-26 21:26:08 +00001550 case ABIArgInfo::Ignore:
John McCall85dd2c52011-05-15 02:19:42 +00001551 resultType = llvm::Type::getVoidTy(getLLVMContext());
Daniel Dunbar94a6f252009-01-26 21:26:08 +00001552 break;
John McCallf26e73d2016-03-11 04:30:43 +00001553
1554 case ABIArgInfo::CoerceAndExpand:
1555 resultType = retAI.getUnpaddedCoerceAndExpandType();
1556 break;
Daniel Dunbar7a95ca32008-09-10 04:01:49 +00001557 }
Mike Stump11289f42009-09-09 15:08:12 +00001558
Alexey Samsonov153004f2014-09-29 22:08:00 +00001559 ClangToLLVMArgMapping IRFunctionArgs(getContext(), FI, true);
1560 SmallVector<llvm::Type*, 8> ArgTypes(IRFunctionArgs.totalIRArgs());
1561
1562 // Add type for sret argument.
1563 if (IRFunctionArgs.hasSRetArg()) {
1564 QualType Ret = FI.getReturnType();
1565 llvm::Type *Ty = ConvertType(Ret);
1566 unsigned AddressSpace = Context.getTargetAddressSpace(Ret);
1567 ArgTypes[IRFunctionArgs.getSRetArgNo()] =
1568 llvm::PointerType::get(Ty, AddressSpace);
1569 }
1570
1571 // Add type for inalloca argument.
1572 if (IRFunctionArgs.hasInallocaArg()) {
1573 auto ArgStruct = FI.getArgStruct();
1574 assert(ArgStruct);
1575 ArgTypes[IRFunctionArgs.getInallocaArgNo()] = ArgStruct->getPointerTo();
1576 }
1577
John McCallc818bbb2012-12-07 07:03:17 +00001578 // Add in all of the required arguments.
Alexey Samsonov153004f2014-09-29 22:08:00 +00001579 unsigned ArgNo = 0;
Alexey Samsonov34625dd2014-09-29 21:21:48 +00001580 CGFunctionInfo::const_arg_iterator it = FI.arg_begin(),
1581 ie = it + FI.getNumRequiredArgs();
Alexey Samsonov153004f2014-09-29 22:08:00 +00001582 for (; it != ie; ++it, ++ArgNo) {
1583 const ABIArgInfo &ArgInfo = it->info;
Mike Stump11289f42009-09-09 15:08:12 +00001584
Rafael Espindolafad28de2012-10-24 01:59:00 +00001585 // Insert a padding type to ensure proper alignment.
Alexey Samsonov153004f2014-09-29 22:08:00 +00001586 if (IRFunctionArgs.hasPaddingArg(ArgNo))
1587 ArgTypes[IRFunctionArgs.getPaddingArgNo(ArgNo)] =
1588 ArgInfo.getPaddingType();
Rafael Espindolafad28de2012-10-24 01:59:00 +00001589
Alexey Samsonov153004f2014-09-29 22:08:00 +00001590 unsigned FirstIRArg, NumIRArgs;
1591 std::tie(FirstIRArg, NumIRArgs) = IRFunctionArgs.getIRArgs(ArgNo);
1592
1593 switch (ArgInfo.getKind()) {
Daniel Dunbar94a6f252009-01-26 21:26:08 +00001594 case ABIArgInfo::Ignore:
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001595 case ABIArgInfo::InAlloca:
Alexey Samsonov153004f2014-09-29 22:08:00 +00001596 assert(NumIRArgs == 0);
Daniel Dunbar94a6f252009-01-26 21:26:08 +00001597 break;
1598
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00001599 case ABIArgInfo::Indirect: {
Alexey Samsonov153004f2014-09-29 22:08:00 +00001600 assert(NumIRArgs == 1);
Yaxun Liud7523282017-04-17 20:10:44 +00001601 // indirect arguments are always on the stack, which is alloca addr space.
Chris Lattner2192fe52011-07-18 04:24:23 +00001602 llvm::Type *LTy = ConvertTypeForMem(it->type);
Yaxun Liud7523282017-04-17 20:10:44 +00001603 ArgTypes[FirstIRArg] = LTy->getPointerTo(
1604 CGM.getDataLayout().getAllocaAddrSpace());
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00001605 break;
1606 }
1607
1608 case ABIArgInfo::Extend:
Chris Lattner2cdfda42010-07-29 06:44:09 +00001609 case ABIArgInfo::Direct: {
Oliver Stannard2bfdc5b2014-08-27 10:43:15 +00001610 // Fast-isel and the optimizer generally like scalar values better than
1611 // FCAs, so we flatten them if this is safe to do for this argument.
Alexey Samsonov153004f2014-09-29 22:08:00 +00001612 llvm::Type *argType = ArgInfo.getCoerceToType();
James Molloy6f244b62014-05-09 16:21:39 +00001613 llvm::StructType *st = dyn_cast<llvm::StructType>(argType);
Alexey Samsonov153004f2014-09-29 22:08:00 +00001614 if (st && ArgInfo.isDirect() && ArgInfo.getCanBeFlattened()) {
1615 assert(NumIRArgs == st->getNumElements());
John McCall85dd2c52011-05-15 02:19:42 +00001616 for (unsigned i = 0, e = st->getNumElements(); i != e; ++i)
Alexey Samsonov153004f2014-09-29 22:08:00 +00001617 ArgTypes[FirstIRArg + i] = st->getElementType(i);
Chris Lattner3dd716c2010-06-28 23:44:11 +00001618 } else {
Alexey Samsonov153004f2014-09-29 22:08:00 +00001619 assert(NumIRArgs == 1);
1620 ArgTypes[FirstIRArg] = argType;
Chris Lattner3dd716c2010-06-28 23:44:11 +00001621 }
Daniel Dunbar2f219b02009-02-03 19:12:28 +00001622 break;
Chris Lattner2cdfda42010-07-29 06:44:09 +00001623 }
Mike Stump11289f42009-09-09 15:08:12 +00001624
John McCallf26e73d2016-03-11 04:30:43 +00001625 case ABIArgInfo::CoerceAndExpand: {
1626 auto ArgTypesIter = ArgTypes.begin() + FirstIRArg;
1627 for (auto EltTy : ArgInfo.getCoerceAndExpandTypeSequence()) {
1628 *ArgTypesIter++ = EltTy;
1629 }
1630 assert(ArgTypesIter == ArgTypes.begin() + FirstIRArg + NumIRArgs);
1631 break;
1632 }
1633
Daniel Dunbard3674e62008-09-11 01:48:57 +00001634 case ABIArgInfo::Expand:
Alexey Samsonov153004f2014-09-29 22:08:00 +00001635 auto ArgTypesIter = ArgTypes.begin() + FirstIRArg;
1636 getExpandedTypes(it->type, ArgTypesIter);
1637 assert(ArgTypesIter == ArgTypes.begin() + FirstIRArg + NumIRArgs);
Daniel Dunbard3674e62008-09-11 01:48:57 +00001638 break;
1639 }
Daniel Dunbar7a95ca32008-09-10 04:01:49 +00001640 }
1641
Chris Lattner6fb0ccf2011-07-15 05:16:14 +00001642 bool Erased = FunctionsBeingProcessed.erase(&FI); (void)Erased;
1643 assert(Erased && "Not in set?");
Alexey Samsonov153004f2014-09-29 22:08:00 +00001644
1645 return llvm::FunctionType::get(resultType, ArgTypes, FI.isVariadic());
Daniel Dunbar81cf67f2008-09-09 23:48:28 +00001646}
1647
Chris Lattner2192fe52011-07-18 04:24:23 +00001648llvm::Type *CodeGenTypes::GetFunctionTypeForVTable(GlobalDecl GD) {
John McCall5d865c322010-08-31 07:33:07 +00001649 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
Anders Carlsson64457732009-11-24 05:08:52 +00001650 const FunctionProtoType *FPT = MD->getType()->getAs<FunctionProtoType>();
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001651
Chris Lattner8806e322011-07-10 00:18:59 +00001652 if (!isFuncTypeConvertible(FPT))
1653 return llvm::StructType::get(getLLVMContext());
1654
1655 const CGFunctionInfo *Info;
1656 if (isa<CXXDestructorDecl>(MD))
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001657 Info =
1658 &arrangeCXXStructorDeclaration(MD, getFromDtorType(GD.getDtorType()));
Chris Lattner8806e322011-07-10 00:18:59 +00001659 else
John McCalla729c622012-02-17 03:33:10 +00001660 Info = &arrangeCXXMethodDeclaration(MD);
1661 return GetFunctionType(*Info);
Anders Carlsson64457732009-11-24 05:08:52 +00001662}
1663
Samuel Antao798f11c2015-11-23 22:04:44 +00001664static void AddAttributesFromFunctionProtoType(ASTContext &Ctx,
1665 llvm::AttrBuilder &FuncAttrs,
1666 const FunctionProtoType *FPT) {
1667 if (!FPT)
1668 return;
1669
1670 if (!isUnresolvedExceptionSpec(FPT->getExceptionSpecType()) &&
1671 FPT->isNothrow(Ctx))
1672 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
1673}
1674
Justin Lebarb080b632017-01-25 21:29:48 +00001675void CodeGenModule::ConstructDefaultFnAttrList(StringRef Name, bool HasOptnone,
1676 bool AttrOnCallSite,
1677 llvm::AttrBuilder &FuncAttrs) {
1678 // OptimizeNoneAttr takes precedence over -Os or -Oz. No warning needed.
1679 if (!HasOptnone) {
1680 if (CodeGenOpts.OptimizeSize)
1681 FuncAttrs.addAttribute(llvm::Attribute::OptimizeForSize);
1682 if (CodeGenOpts.OptimizeSize == 2)
1683 FuncAttrs.addAttribute(llvm::Attribute::MinSize);
1684 }
1685
1686 if (CodeGenOpts.DisableRedZone)
1687 FuncAttrs.addAttribute(llvm::Attribute::NoRedZone);
1688 if (CodeGenOpts.NoImplicitFloat)
1689 FuncAttrs.addAttribute(llvm::Attribute::NoImplicitFloat);
1690
1691 if (AttrOnCallSite) {
1692 // Attributes that should go on the call site only.
1693 if (!CodeGenOpts.SimplifyLibCalls ||
1694 CodeGenOpts.isNoBuiltinFunc(Name.data()))
1695 FuncAttrs.addAttribute(llvm::Attribute::NoBuiltin);
1696 if (!CodeGenOpts.TrapFuncName.empty())
1697 FuncAttrs.addAttribute("trap-func-name", CodeGenOpts.TrapFuncName);
1698 } else {
1699 // Attributes that should go on the function, but not the call site.
1700 if (!CodeGenOpts.DisableFPElim) {
1701 FuncAttrs.addAttribute("no-frame-pointer-elim", "false");
1702 } else if (CodeGenOpts.OmitLeafFramePointer) {
1703 FuncAttrs.addAttribute("no-frame-pointer-elim", "false");
1704 FuncAttrs.addAttribute("no-frame-pointer-elim-non-leaf");
1705 } else {
1706 FuncAttrs.addAttribute("no-frame-pointer-elim", "true");
1707 FuncAttrs.addAttribute("no-frame-pointer-elim-non-leaf");
1708 }
1709
1710 FuncAttrs.addAttribute("less-precise-fpmad",
1711 llvm::toStringRef(CodeGenOpts.LessPreciseFPMAD));
1712
1713 if (!CodeGenOpts.FPDenormalMode.empty())
1714 FuncAttrs.addAttribute("denormal-fp-math", CodeGenOpts.FPDenormalMode);
1715
1716 FuncAttrs.addAttribute("no-trapping-math",
1717 llvm::toStringRef(CodeGenOpts.NoTrappingMath));
1718
1719 // TODO: Are these all needed?
1720 // unsafe/inf/nan/nsz are handled by instruction-level FastMathFlags.
1721 FuncAttrs.addAttribute("no-infs-fp-math",
1722 llvm::toStringRef(CodeGenOpts.NoInfsFPMath));
1723 FuncAttrs.addAttribute("no-nans-fp-math",
1724 llvm::toStringRef(CodeGenOpts.NoNaNsFPMath));
1725 FuncAttrs.addAttribute("unsafe-fp-math",
1726 llvm::toStringRef(CodeGenOpts.UnsafeFPMath));
1727 FuncAttrs.addAttribute("use-soft-float",
1728 llvm::toStringRef(CodeGenOpts.SoftFloat));
1729 FuncAttrs.addAttribute("stack-protector-buffer-size",
1730 llvm::utostr(CodeGenOpts.SSPBufferSize));
1731 FuncAttrs.addAttribute("no-signed-zeros-fp-math",
1732 llvm::toStringRef(CodeGenOpts.NoSignedZeros));
1733 FuncAttrs.addAttribute(
1734 "correctly-rounded-divide-sqrt-fp-math",
1735 llvm::toStringRef(CodeGenOpts.CorrectlyRoundedDivSqrt));
1736
1737 // TODO: Reciprocal estimate codegen options should apply to instructions?
1738 std::vector<std::string> &Recips = getTarget().getTargetOpts().Reciprocals;
1739 if (!Recips.empty())
1740 FuncAttrs.addAttribute("reciprocal-estimates",
1741 llvm::join(Recips.begin(), Recips.end(), ","));
1742
1743 if (CodeGenOpts.StackRealignment)
1744 FuncAttrs.addAttribute("stackrealign");
1745 if (CodeGenOpts.Backchain)
1746 FuncAttrs.addAttribute("backchain");
1747 }
1748
1749 if (getLangOpts().CUDA && getLangOpts().CUDAIsDevice) {
1750 // Conservatively, mark all functions and calls in CUDA as convergent
1751 // (meaning, they may call an intrinsically convergent op, such as
1752 // __syncthreads(), and so can't have certain optimizations applied around
1753 // them). LLVM will remove this attribute where it safely can.
1754 FuncAttrs.addAttribute(llvm::Attribute::Convergent);
1755
1756 // Exceptions aren't supported in CUDA device code.
1757 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
1758
1759 // Respect -fcuda-flush-denormals-to-zero.
1760 if (getLangOpts().CUDADeviceFlushDenormalsToZero)
1761 FuncAttrs.addAttribute("nvptx-f32ftz", "true");
1762 }
1763}
1764
1765void CodeGenModule::AddDefaultFnAttrs(llvm::Function &F) {
1766 llvm::AttrBuilder FuncAttrs;
1767 ConstructDefaultFnAttrList(F.getName(),
1768 F.hasFnAttribute(llvm::Attribute::OptimizeNone),
1769 /* AttrOnCallsite = */ false, FuncAttrs);
Reid Kleckneree4930b2017-05-02 22:07:37 +00001770 F.addAttributes(llvm::AttributeList::FunctionIndex, FuncAttrs);
Justin Lebarb080b632017-01-25 21:29:48 +00001771}
1772
Chad Rosier7dbc9cf2016-01-06 14:35:46 +00001773void CodeGenModule::ConstructAttributeList(
1774 StringRef Name, const CGFunctionInfo &FI, CGCalleeInfo CalleeInfo,
Reid Klecknercdd26792017-04-18 23:50:03 +00001775 llvm::AttributeList &AttrList, unsigned &CallingConv, bool AttrOnCallSite) {
Bill Wendlinga514ebc2012-10-15 20:36:26 +00001776 llvm::AttrBuilder FuncAttrs;
1777 llvm::AttrBuilder RetAttrs;
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00001778
Daniel Dunbar0ef34792009-09-12 00:59:20 +00001779 CallingConv = FI.getEffectiveCallingConvention();
John McCallab26cfa2010-02-05 21:31:56 +00001780 if (FI.isNoReturn())
Bill Wendling207f0532012-12-20 19:27:06 +00001781 FuncAttrs.addAttribute(llvm::Attribute::NoReturn);
John McCallab26cfa2010-02-05 21:31:56 +00001782
Samuel Antao798f11c2015-11-23 22:04:44 +00001783 // If we have information about the function prototype, we can learn
1784 // attributes form there.
1785 AddAttributesFromFunctionProtoType(getContext(), FuncAttrs,
1786 CalleeInfo.getCalleeFunctionProtoType());
1787
1788 const Decl *TargetDecl = CalleeInfo.getCalleeDecl();
1789
Justin Lebarb080b632017-01-25 21:29:48 +00001790 bool HasOptnone = false;
Anton Korobeynikovc8478242009-04-04 00:49:24 +00001791 // FIXME: handle sseregparm someday...
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00001792 if (TargetDecl) {
Rafael Espindola2d21ab02011-10-12 19:51:18 +00001793 if (TargetDecl->hasAttr<ReturnsTwiceAttr>())
Bill Wendling207f0532012-12-20 19:27:06 +00001794 FuncAttrs.addAttribute(llvm::Attribute::ReturnsTwice);
Argyrios Kyrtzidisb4b64ca2009-06-30 02:34:44 +00001795 if (TargetDecl->hasAttr<NoThrowAttr>())
Bill Wendling207f0532012-12-20 19:27:06 +00001796 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
Richard Smithdebc59d2013-01-30 05:45:05 +00001797 if (TargetDecl->hasAttr<NoReturnAttr>())
1798 FuncAttrs.addAttribute(llvm::Attribute::NoReturn);
Xinliang David Li4ec36062017-06-13 21:14:07 +00001799 if (TargetDecl->hasAttr<ColdAttr>())
1800 FuncAttrs.addAttribute(llvm::Attribute::Cold);
Aaron Ballman7c19ab12014-02-22 16:59:24 +00001801 if (TargetDecl->hasAttr<NoDuplicateAttr>())
1802 FuncAttrs.addAttribute(llvm::Attribute::NoDuplicate);
Yaxun Liu7d07ae72016-11-01 18:45:32 +00001803 if (TargetDecl->hasAttr<ConvergentAttr>())
1804 FuncAttrs.addAttribute(llvm::Attribute::Convergent);
Richard Smithdebc59d2013-01-30 05:45:05 +00001805
Chandler Carruth45bbe012017-03-24 09:11:57 +00001806 if (const FunctionDecl *Fn = dyn_cast<FunctionDecl>(TargetDecl)) {
Samuel Antao798f11c2015-11-23 22:04:44 +00001807 AddAttributesFromFunctionProtoType(
Chandler Carruth45bbe012017-03-24 09:11:57 +00001808 getContext(), FuncAttrs, Fn->getType()->getAs<FunctionProtoType>());
Richard Smith49af6292013-03-05 08:30:04 +00001809 // Don't use [[noreturn]] or _Noreturn for a call to a virtual function.
1810 // These attributes are not inherited by overloads.
Chandler Carruth45bbe012017-03-24 09:11:57 +00001811 const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(Fn);
1812 if (Fn->isNoReturn() && !(AttrOnCallSite && MD && MD->isVirtual()))
Richard Smithdebc59d2013-01-30 05:45:05 +00001813 FuncAttrs.addAttribute(llvm::Attribute::NoReturn);
John McCallbe349de2010-07-08 06:48:12 +00001814 }
1815
David Majnemer1bf0f8e2015-07-20 22:51:52 +00001816 // 'const', 'pure' and 'noalias' attributed functions are also nounwind.
Eric Christopherbf005ec2011-08-15 22:38:22 +00001817 if (TargetDecl->hasAttr<ConstAttr>()) {
Bill Wendling207f0532012-12-20 19:27:06 +00001818 FuncAttrs.addAttribute(llvm::Attribute::ReadNone);
1819 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
Eric Christopherbf005ec2011-08-15 22:38:22 +00001820 } else if (TargetDecl->hasAttr<PureAttr>()) {
Bill Wendling207f0532012-12-20 19:27:06 +00001821 FuncAttrs.addAttribute(llvm::Attribute::ReadOnly);
1822 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
David Majnemer1bf0f8e2015-07-20 22:51:52 +00001823 } else if (TargetDecl->hasAttr<NoAliasAttr>()) {
1824 FuncAttrs.addAttribute(llvm::Attribute::ArgMemOnly);
1825 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
Eric Christopherbf005ec2011-08-15 22:38:22 +00001826 }
David Majnemer631a90b2015-02-04 07:23:21 +00001827 if (TargetDecl->hasAttr<RestrictAttr>())
Bill Wendling207f0532012-12-20 19:27:06 +00001828 RetAttrs.addAttribute(llvm::Attribute::NoAlias);
Chandler Carruth45bbe012017-03-24 09:11:57 +00001829 if (TargetDecl->hasAttr<ReturnsNonNullAttr>())
Hal Finkeld8442b12014-07-12 04:51:04 +00001830 RetAttrs.addAttribute(llvm::Attribute::NonNull);
Oren Ben Simhon318a6ea2017-04-27 12:01:00 +00001831 if (TargetDecl->hasAttr<AnyX86NoCallerSavedRegistersAttr>())
1832 FuncAttrs.addAttribute("no_caller_saved_registers");
Paul Robinson08556952014-12-11 20:14:04 +00001833
1834 HasOptnone = TargetDecl->hasAttr<OptimizeNoneAttr>();
George Burgess IVe3763372016-12-22 02:50:20 +00001835 if (auto *AllocSize = TargetDecl->getAttr<AllocSizeAttr>()) {
1836 Optional<unsigned> NumElemsParam;
1837 // alloc_size args are base-1, 0 means not present.
1838 if (unsigned N = AllocSize->getNumElemsParam())
1839 NumElemsParam = N - 1;
1840 FuncAttrs.addAllocSizeAttr(AllocSize->getElemSizeParam() - 1,
1841 NumElemsParam);
1842 }
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00001843 }
1844
Justin Lebarb080b632017-01-25 21:29:48 +00001845 ConstructDefaultFnAttrList(Name, HasOptnone, AttrOnCallSite, FuncAttrs);
Paul Robinson08556952014-12-11 20:14:04 +00001846
Peter Collingbourneb4728c12014-05-19 22:14:34 +00001847 if (CodeGenOpts.EnableSegmentedStacks &&
1848 !(TargetDecl && TargetDecl->hasAttr<NoSplitStackAttr>()))
Reid Klecknerfb873af2014-04-10 22:59:13 +00001849 FuncAttrs.addAttribute("split-stack");
Devang Patel6e467b12009-06-04 23:32:02 +00001850
Justin Lebarb080b632017-01-25 21:29:48 +00001851 if (!AttrOnCallSite) {
Akira Hatanaka7828b1e2015-11-13 00:42:21 +00001852 bool DisableTailCalls =
Justin Lebarb080b632017-01-25 21:29:48 +00001853 CodeGenOpts.DisableTailCalls ||
1854 (TargetDecl && (TargetDecl->hasAttr<DisableTailCallsAttr>() ||
1855 TargetDecl->hasAttr<AnyX86InterruptAttr>()));
1856 FuncAttrs.addAttribute("disable-tail-calls",
1857 llvm::toStringRef(DisableTailCalls));
Eric Christopher70c16652015-03-25 23:14:47 +00001858
Eric Christopher11acf732015-06-12 01:35:52 +00001859 // Add target-cpu and target-features attributes to functions. If
1860 // we have a decl for the function and it has a target attribute then
1861 // parse that and add it to the feature set.
1862 StringRef TargetCPU = getTarget().getTargetOpts().CPU;
Chandler Carruth45bbe012017-03-24 09:11:57 +00001863 const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(TargetDecl);
Eric Christopherb57804a2015-09-01 22:03:56 +00001864 if (FD && FD->hasAttr<TargetAttr>()) {
Eric Christopher3a98b3c2015-08-27 19:59:34 +00001865 llvm::StringMap<bool> FeatureMap;
Eric Christopher2b90a642015-11-11 23:05:08 +00001866 getFunctionFeatureMap(FeatureMap, FD);
Eric Christopher11acf732015-06-12 01:35:52 +00001867
Eric Christopher3a98b3c2015-08-27 19:59:34 +00001868 // Produce the canonical string for this set of features.
1869 std::vector<std::string> Features;
1870 for (llvm::StringMap<bool>::const_iterator it = FeatureMap.begin(),
1871 ie = FeatureMap.end();
1872 it != ie; ++it)
1873 Features.push_back((it->second ? "+" : "-") + it->first().str());
Eric Christopher2249b812015-07-01 00:08:29 +00001874
Eric Christopher3a98b3c2015-08-27 19:59:34 +00001875 // Now add the target-cpu and target-features to the function.
Eric Christopher2b90a642015-11-11 23:05:08 +00001876 // While we populated the feature map above, we still need to
1877 // get and parse the target attribute so we can get the cpu for
1878 // the function.
1879 const auto *TD = FD->getAttr<TargetAttr>();
1880 TargetAttr::ParsedTargetAttr ParsedAttr = TD->parse();
Erich Keaneb0d44232017-07-18 20:41:02 +00001881 if (ParsedAttr.Architecture != "")
1882 TargetCPU = ParsedAttr.Architecture;
Eric Christopher3a98b3c2015-08-27 19:59:34 +00001883 if (TargetCPU != "")
1884 FuncAttrs.addAttribute("target-cpu", TargetCPU);
1885 if (!Features.empty()) {
1886 std::sort(Features.begin(), Features.end());
1887 FuncAttrs.addAttribute(
1888 "target-features",
1889 llvm::join(Features.begin(), Features.end(), ","));
1890 }
1891 } else {
1892 // Otherwise just add the existing target cpu and target features to the
1893 // function.
1894 std::vector<std::string> &Features = getTarget().getTargetOpts().Features;
1895 if (TargetCPU != "")
1896 FuncAttrs.addAttribute("target-cpu", TargetCPU);
1897 if (!Features.empty()) {
1898 std::sort(Features.begin(), Features.end());
1899 FuncAttrs.addAttribute(
1900 "target-features",
1901 llvm::join(Features.begin(), Features.end(), ","));
1902 }
Eric Christopher70c16652015-03-25 23:14:47 +00001903 }
Bill Wendling985d1c52013-02-15 21:30:01 +00001904 }
1905
Alexey Samsonov153004f2014-09-29 22:08:00 +00001906 ClangToLLVMArgMapping IRFunctionArgs(getContext(), FI);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00001907
Daniel Dunbar3668cb22009-02-02 23:43:58 +00001908 QualType RetTy = FI.getReturnType();
Daniel Dunbarb52d0772009-02-03 05:59:18 +00001909 const ABIArgInfo &RetAI = FI.getReturnInfo();
Daniel Dunbar7a95ca32008-09-10 04:01:49 +00001910 switch (RetAI.getKind()) {
Anton Korobeynikov18adbf52009-06-06 09:36:29 +00001911 case ABIArgInfo::Extend:
Jakob Stoklund Olesend7bf2932013-05-29 03:57:23 +00001912 if (RetTy->hasSignedIntegerRepresentation())
1913 RetAttrs.addAttribute(llvm::Attribute::SExt);
1914 else if (RetTy->hasUnsignedIntegerRepresentation())
1915 RetAttrs.addAttribute(llvm::Attribute::ZExt);
Jakob Stoklund Olesena3661142013-06-05 03:00:09 +00001916 // FALL THROUGH
Daniel Dunbar67dace892009-02-03 06:17:37 +00001917 case ABIArgInfo::Direct:
Jakob Stoklund Olesena3661142013-06-05 03:00:09 +00001918 if (RetAI.getInReg())
1919 RetAttrs.addAttribute(llvm::Attribute::InReg);
1920 break;
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00001921 case ABIArgInfo::Ignore:
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00001922 break;
1923
Alexey Samsonov91cf4552014-08-22 01:06:06 +00001924 case ABIArgInfo::InAlloca:
Rafael Espindola06b2b4a2012-07-31 02:44:24 +00001925 case ABIArgInfo::Indirect: {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00001926 // inalloca and sret disable readnone and readonly
Bill Wendling207f0532012-12-20 19:27:06 +00001927 FuncAttrs.removeAttribute(llvm::Attribute::ReadOnly)
1928 .removeAttribute(llvm::Attribute::ReadNone);
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00001929 break;
Rafael Espindola06b2b4a2012-07-31 02:44:24 +00001930 }
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00001931
John McCallf26e73d2016-03-11 04:30:43 +00001932 case ABIArgInfo::CoerceAndExpand:
1933 break;
1934
Daniel Dunbard3674e62008-09-11 01:48:57 +00001935 case ABIArgInfo::Expand:
David Blaikie83d382b2011-09-23 05:06:16 +00001936 llvm_unreachable("Invalid ABI kind for return argument");
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00001937 }
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00001938
Hal Finkela2347ba2014-07-18 15:52:10 +00001939 if (const auto *RefTy = RetTy->getAs<ReferenceType>()) {
1940 QualType PTy = RefTy->getPointeeType();
David Majnemer9df56372015-09-10 21:52:00 +00001941 if (!PTy->isIncompleteType() && PTy->isConstantSizeType())
Hal Finkela2347ba2014-07-18 15:52:10 +00001942 RetAttrs.addDereferenceableAttr(getContext().getTypeSizeInChars(PTy)
1943 .getQuantity());
1944 else if (getContext().getTargetAddressSpace(PTy) == 0)
1945 RetAttrs.addAttribute(llvm::Attribute::NonNull);
1946 }
Nick Lewycky9b46eb82014-05-28 09:56:42 +00001947
John McCall12f23522016-04-04 18:33:08 +00001948 bool hasUsedSRet = false;
Reid Klecknercdd26792017-04-18 23:50:03 +00001949 SmallVector<llvm::AttributeSet, 4> ArgAttrs(IRFunctionArgs.totalIRArgs());
John McCall12f23522016-04-04 18:33:08 +00001950
Alexey Samsonov91cf4552014-08-22 01:06:06 +00001951 // Attach attributes to sret.
1952 if (IRFunctionArgs.hasSRetArg()) {
1953 llvm::AttrBuilder SRETAttrs;
1954 SRETAttrs.addAttribute(llvm::Attribute::StructRet);
John McCall12f23522016-04-04 18:33:08 +00001955 hasUsedSRet = true;
Alexey Samsonov91cf4552014-08-22 01:06:06 +00001956 if (RetAI.getInReg())
1957 SRETAttrs.addAttribute(llvm::Attribute::InReg);
Reid Klecknercdd26792017-04-18 23:50:03 +00001958 ArgAttrs[IRFunctionArgs.getSRetArgNo()] =
1959 llvm::AttributeSet::get(getLLVMContext(), SRETAttrs);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00001960 }
1961
1962 // Attach attributes to inalloca argument.
1963 if (IRFunctionArgs.hasInallocaArg()) {
1964 llvm::AttrBuilder Attrs;
1965 Attrs.addAttribute(llvm::Attribute::InAlloca);
Reid Klecknercdd26792017-04-18 23:50:03 +00001966 ArgAttrs[IRFunctionArgs.getInallocaArgNo()] =
1967 llvm::AttributeSet::get(getLLVMContext(), Attrs);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00001968 }
1969
Alexey Samsonov91cf4552014-08-22 01:06:06 +00001970 unsigned ArgNo = 0;
1971 for (CGFunctionInfo::const_arg_iterator I = FI.arg_begin(),
1972 E = FI.arg_end();
1973 I != E; ++I, ++ArgNo) {
1974 QualType ParamType = I->type;
1975 const ABIArgInfo &AI = I->info;
Bill Wendlinga514ebc2012-10-15 20:36:26 +00001976 llvm::AttrBuilder Attrs;
Anton Korobeynikovc8478242009-04-04 00:49:24 +00001977
Alexey Samsonov91cf4552014-08-22 01:06:06 +00001978 // Add attribute for padding argument, if necessary.
1979 if (IRFunctionArgs.hasPaddingArg(ArgNo)) {
Reid Klecknercdd26792017-04-18 23:50:03 +00001980 if (AI.getPaddingInReg()) {
1981 ArgAttrs[IRFunctionArgs.getPaddingArgNo(ArgNo)] =
1982 llvm::AttributeSet::get(
1983 getLLVMContext(),
1984 llvm::AttrBuilder().addAttribute(llvm::Attribute::InReg));
1985 }
Rafael Espindolafad28de2012-10-24 01:59:00 +00001986 }
1987
John McCall39ec71f2010-03-27 00:47:27 +00001988 // 'restrict' -> 'noalias' is done in EmitFunctionProlog when we
1989 // have the corresponding parameter variable. It doesn't make
Daniel Dunbarcb2b3d02011-02-10 18:10:07 +00001990 // sense to do it here because parameters are so messed up.
Daniel Dunbard3674e62008-09-11 01:48:57 +00001991 switch (AI.getKind()) {
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00001992 case ABIArgInfo::Extend:
Douglas Gregor6ab2fa82011-05-20 16:38:50 +00001993 if (ParamType->isSignedIntegerOrEnumerationType())
Bill Wendling207f0532012-12-20 19:27:06 +00001994 Attrs.addAttribute(llvm::Attribute::SExt);
Petar Jovanovic1a3f9652015-05-26 21:07:19 +00001995 else if (ParamType->isUnsignedIntegerOrEnumerationType()) {
1996 if (getTypes().getABIInfo().shouldSignExtUnsignedType(ParamType))
1997 Attrs.addAttribute(llvm::Attribute::SExt);
1998 else
1999 Attrs.addAttribute(llvm::Attribute::ZExt);
2000 }
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002001 // FALL THROUGH
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002002 case ABIArgInfo::Direct:
Peter Collingbournef7706832014-12-12 23:41:25 +00002003 if (ArgNo == 0 && FI.isChainCall())
2004 Attrs.addAttribute(llvm::Attribute::Nest);
2005 else if (AI.getInReg())
Bill Wendling207f0532012-12-20 19:27:06 +00002006 Attrs.addAttribute(llvm::Attribute::InReg);
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002007 break;
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002008
James Y Knight71608572015-08-21 18:19:06 +00002009 case ABIArgInfo::Indirect: {
Rafael Espindola703c47f2012-10-19 05:04:37 +00002010 if (AI.getInReg())
Bill Wendling207f0532012-12-20 19:27:06 +00002011 Attrs.addAttribute(llvm::Attribute::InReg);
Rafael Espindola703c47f2012-10-19 05:04:37 +00002012
Anders Carlsson20759ad2009-09-16 15:53:40 +00002013 if (AI.getIndirectByVal())
Bill Wendling207f0532012-12-20 19:27:06 +00002014 Attrs.addAttribute(llvm::Attribute::ByVal);
Anders Carlsson20759ad2009-09-16 15:53:40 +00002015
John McCall7f416cc2015-09-08 08:05:57 +00002016 CharUnits Align = AI.getIndirectAlign();
James Y Knight71608572015-08-21 18:19:06 +00002017
2018 // In a byval argument, it is important that the required
2019 // alignment of the type is honored, as LLVM might be creating a
2020 // *new* stack object, and needs to know what alignment to give
2021 // it. (Sometimes it can deduce a sensible alignment on its own,
2022 // but not if clang decides it must emit a packed struct, or the
2023 // user specifies increased alignment requirements.)
2024 //
2025 // This is different from indirect *not* byval, where the object
2026 // exists already, and the align attribute is purely
2027 // informative.
John McCall7f416cc2015-09-08 08:05:57 +00002028 assert(!Align.isZero());
James Y Knight71608572015-08-21 18:19:06 +00002029
John McCall7f416cc2015-09-08 08:05:57 +00002030 // For now, only add this when we have a byval argument.
2031 // TODO: be less lazy about updating test cases.
2032 if (AI.getIndirectByVal())
2033 Attrs.addAlignmentAttr(Align.getQuantity());
Bill Wendlinga7912f82012-10-10 07:36:56 +00002034
Daniel Dunbarc2304432009-03-18 19:51:01 +00002035 // byval disables readnone and readonly.
Bill Wendling207f0532012-12-20 19:27:06 +00002036 FuncAttrs.removeAttribute(llvm::Attribute::ReadOnly)
2037 .removeAttribute(llvm::Attribute::ReadNone);
Daniel Dunbard3674e62008-09-11 01:48:57 +00002038 break;
James Y Knight71608572015-08-21 18:19:06 +00002039 }
Daniel Dunbar94a6f252009-01-26 21:26:08 +00002040 case ABIArgInfo::Ignore:
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002041 case ABIArgInfo::Expand:
John McCallf26e73d2016-03-11 04:30:43 +00002042 case ABIArgInfo::CoerceAndExpand:
2043 break;
Daniel Dunbar94a6f252009-01-26 21:26:08 +00002044
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002045 case ABIArgInfo::InAlloca:
2046 // inalloca disables readnone and readonly.
2047 FuncAttrs.removeAttribute(llvm::Attribute::ReadOnly)
2048 .removeAttribute(llvm::Attribute::ReadNone);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002049 continue;
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00002050 }
Mike Stump11289f42009-09-09 15:08:12 +00002051
Hal Finkela2347ba2014-07-18 15:52:10 +00002052 if (const auto *RefTy = ParamType->getAs<ReferenceType>()) {
2053 QualType PTy = RefTy->getPointeeType();
David Majnemer9df56372015-09-10 21:52:00 +00002054 if (!PTy->isIncompleteType() && PTy->isConstantSizeType())
Hal Finkela2347ba2014-07-18 15:52:10 +00002055 Attrs.addDereferenceableAttr(getContext().getTypeSizeInChars(PTy)
2056 .getQuantity());
2057 else if (getContext().getTargetAddressSpace(PTy) == 0)
2058 Attrs.addAttribute(llvm::Attribute::NonNull);
2059 }
Nick Lewycky9b46eb82014-05-28 09:56:42 +00002060
John McCall12f23522016-04-04 18:33:08 +00002061 switch (FI.getExtParameterInfo(ArgNo).getABI()) {
2062 case ParameterABI::Ordinary:
2063 break;
2064
2065 case ParameterABI::SwiftIndirectResult: {
2066 // Add 'sret' if we haven't already used it for something, but
2067 // only if the result is void.
2068 if (!hasUsedSRet && RetTy->isVoidType()) {
2069 Attrs.addAttribute(llvm::Attribute::StructRet);
2070 hasUsedSRet = true;
2071 }
2072
2073 // Add 'noalias' in either case.
2074 Attrs.addAttribute(llvm::Attribute::NoAlias);
2075
2076 // Add 'dereferenceable' and 'alignment'.
2077 auto PTy = ParamType->getPointeeType();
2078 if (!PTy->isIncompleteType() && PTy->isConstantSizeType()) {
2079 auto info = getContext().getTypeInfoInChars(PTy);
2080 Attrs.addDereferenceableAttr(info.first.getQuantity());
2081 Attrs.addAttribute(llvm::Attribute::getWithAlignment(getLLVMContext(),
2082 info.second.getQuantity()));
2083 }
2084 break;
2085 }
2086
2087 case ParameterABI::SwiftErrorResult:
2088 Attrs.addAttribute(llvm::Attribute::SwiftError);
2089 break;
2090
2091 case ParameterABI::SwiftContext:
2092 Attrs.addAttribute(llvm::Attribute::SwiftSelf);
2093 break;
2094 }
2095
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002096 if (Attrs.hasAttributes()) {
2097 unsigned FirstIRArg, NumIRArgs;
2098 std::tie(FirstIRArg, NumIRArgs) = IRFunctionArgs.getIRArgs(ArgNo);
2099 for (unsigned i = 0; i < NumIRArgs; i++)
Reid Klecknercdd26792017-04-18 23:50:03 +00002100 ArgAttrs[FirstIRArg + i] =
2101 llvm::AttributeSet::get(getLLVMContext(), Attrs);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002102 }
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00002103 }
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002104 assert(ArgNo == FI.arg_size());
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002105
Reid Klecknercdd26792017-04-18 23:50:03 +00002106 AttrList = llvm::AttributeList::get(
2107 getLLVMContext(), llvm::AttributeSet::get(getLLVMContext(), FuncAttrs),
2108 llvm::AttributeSet::get(getLLVMContext(), RetAttrs), ArgAttrs);
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00002109}
2110
John McCalla738c252011-03-09 04:27:21 +00002111/// An argument came in as a promoted argument; demote it back to its
2112/// declared type.
2113static llvm::Value *emitArgumentDemotion(CodeGenFunction &CGF,
2114 const VarDecl *var,
2115 llvm::Value *value) {
Chris Lattner2192fe52011-07-18 04:24:23 +00002116 llvm::Type *varType = CGF.ConvertType(var->getType());
John McCalla738c252011-03-09 04:27:21 +00002117
2118 // This can happen with promotions that actually don't change the
2119 // underlying type, like the enum promotions.
2120 if (value->getType() == varType) return value;
2121
2122 assert((varType->isIntegerTy() || varType->isFloatingPointTy())
2123 && "unexpected promotion type");
2124
2125 if (isa<llvm::IntegerType>(varType))
2126 return CGF.Builder.CreateTrunc(value, varType, "arg.unpromote");
2127
2128 return CGF.Builder.CreateFPCast(value, varType, "arg.unpromote");
2129}
2130
Chandler Carruth45bbe012017-03-24 09:11:57 +00002131/// Returns the attribute (either parameter attribute, or function
2132/// attribute), which declares argument ArgNo to be non-null.
2133static const NonNullAttr *getNonNullAttr(const Decl *FD, const ParmVarDecl *PVD,
2134 QualType ArgType, unsigned ArgNo) {
2135 // FIXME: __attribute__((nonnull)) can also be applied to:
2136 // - references to pointers, where the pointee is known to be
2137 // nonnull (apparently a Clang extension)
2138 // - transparent unions containing pointers
2139 // In the former case, LLVM IR cannot represent the constraint. In
2140 // the latter case, we have no guarantee that the transparent union
2141 // is in fact passed as a pointer.
2142 if (!ArgType->isAnyPointerType() && !ArgType->isBlockPointerType())
2143 return nullptr;
2144 // First, check attribute on parameter itself.
2145 if (PVD) {
2146 if (auto ParmNNAttr = PVD->getAttr<NonNullAttr>())
2147 return ParmNNAttr;
2148 }
2149 // Check function attributes.
2150 if (!FD)
2151 return nullptr;
2152 for (const auto *NNAttr : FD->specific_attrs<NonNullAttr>()) {
2153 if (NNAttr->isNonNull(ArgNo))
2154 return NNAttr;
2155 }
2156 return nullptr;
2157}
2158
John McCall12f23522016-04-04 18:33:08 +00002159namespace {
2160 struct CopyBackSwiftError final : EHScopeStack::Cleanup {
2161 Address Temp;
2162 Address Arg;
2163 CopyBackSwiftError(Address temp, Address arg) : Temp(temp), Arg(arg) {}
2164 void Emit(CodeGenFunction &CGF, Flags flags) override {
2165 llvm::Value *errorValue = CGF.Builder.CreateLoad(Temp);
2166 CGF.Builder.CreateStore(errorValue, Arg);
2167 }
2168 };
2169}
2170
Daniel Dunbard931a872009-02-02 22:03:45 +00002171void CodeGenFunction::EmitFunctionProlog(const CGFunctionInfo &FI,
2172 llvm::Function *Fn,
Daniel Dunbar613855c2008-09-09 23:27:19 +00002173 const FunctionArgList &Args) {
Hans Wennborgd71907d2014-09-04 22:16:33 +00002174 if (CurCodeDecl && CurCodeDecl->hasAttr<NakedAttr>())
2175 // Naked functions don't have prologues.
2176 return;
2177
John McCallcaa19452009-07-28 01:00:58 +00002178 // If this is an implicit-return-zero function, go ahead and
2179 // initialize the return value. TODO: it might be nice to have
2180 // a more general mechanism for this that didn't require synthesized
2181 // return statements.
John McCalldec348f72013-05-03 07:33:41 +00002182 if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(CurCodeDecl)) {
John McCallcaa19452009-07-28 01:00:58 +00002183 if (FD->hasImplicitReturnZero()) {
Alp Toker314cc812014-01-25 16:55:45 +00002184 QualType RetTy = FD->getReturnType().getUnqualifiedType();
Chris Lattner2192fe52011-07-18 04:24:23 +00002185 llvm::Type* LLVMTy = CGM.getTypes().ConvertType(RetTy);
Owen Anderson0b75f232009-07-31 20:28:54 +00002186 llvm::Constant* Zero = llvm::Constant::getNullValue(LLVMTy);
John McCallcaa19452009-07-28 01:00:58 +00002187 Builder.CreateStore(Zero, ReturnValue);
2188 }
2189 }
2190
Mike Stump18bb9282009-05-16 07:57:57 +00002191 // FIXME: We no longer need the types from FunctionArgList; lift up and
2192 // simplify.
Daniel Dunbar5a0acdc92009-02-03 06:02:10 +00002193
Alexey Samsonov153004f2014-09-29 22:08:00 +00002194 ClangToLLVMArgMapping IRFunctionArgs(CGM.getContext(), FI);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002195 // Flattened function arguments.
John McCall12f23522016-04-04 18:33:08 +00002196 SmallVector<llvm::Value *, 16> FnArgs;
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002197 FnArgs.reserve(IRFunctionArgs.totalIRArgs());
2198 for (auto &Arg : Fn->args()) {
2199 FnArgs.push_back(&Arg);
2200 }
2201 assert(FnArgs.size() == IRFunctionArgs.totalIRArgs());
Mike Stump11289f42009-09-09 15:08:12 +00002202
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002203 // If we're using inalloca, all the memory arguments are GEPs off of the last
2204 // parameter, which is a pointer to the complete memory area.
John McCall7f416cc2015-09-08 08:05:57 +00002205 Address ArgStruct = Address::invalid();
2206 const llvm::StructLayout *ArgStructLayout = nullptr;
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002207 if (IRFunctionArgs.hasInallocaArg()) {
John McCall7f416cc2015-09-08 08:05:57 +00002208 ArgStructLayout = CGM.getDataLayout().getStructLayout(FI.getArgStruct());
2209 ArgStruct = Address(FnArgs[IRFunctionArgs.getInallocaArgNo()],
2210 FI.getArgStructAlignment());
2211
2212 assert(ArgStruct.getType() == FI.getArgStruct()->getPointerTo());
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002213 }
2214
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002215 // Name the struct return parameter.
2216 if (IRFunctionArgs.hasSRetArg()) {
John McCall12f23522016-04-04 18:33:08 +00002217 auto AI = cast<llvm::Argument>(FnArgs[IRFunctionArgs.getSRetArgNo()]);
Daniel Dunbar613855c2008-09-09 23:27:19 +00002218 AI->setName("agg.result");
Reid Klecknercdd26792017-04-18 23:50:03 +00002219 AI->addAttr(llvm::Attribute::NoAlias);
Daniel Dunbar613855c2008-09-09 23:27:19 +00002220 }
Mike Stump11289f42009-09-09 15:08:12 +00002221
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002222 // Track if we received the parameter as a pointer (indirect, byval, or
2223 // inalloca). If already have a pointer, EmitParmDecl doesn't need to copy it
2224 // into a local alloca for us.
John McCall7f416cc2015-09-08 08:05:57 +00002225 SmallVector<ParamValue, 16> ArgVals;
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002226 ArgVals.reserve(Args.size());
2227
Reid Kleckner739756c2013-12-04 19:23:12 +00002228 // Create a pointer value for every parameter declaration. This usually
2229 // entails copying one or more LLVM IR arguments into an alloca. Don't push
2230 // any cleanups or do anything that might unwind. We do that separately, so
2231 // we can push the cleanups in the correct order for the ABI.
Daniel Dunbara45bdbb2009-02-04 21:17:21 +00002232 assert(FI.arg_size() == Args.size() &&
2233 "Mismatch between function signature & arguments.");
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002234 unsigned ArgNo = 0;
Daniel Dunbarb52d0772009-02-03 05:59:18 +00002235 CGFunctionInfo::const_arg_iterator info_it = FI.arg_begin();
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002236 for (FunctionArgList::const_iterator i = Args.begin(), e = Args.end();
Devang Patel68a15252011-03-03 20:13:15 +00002237 i != e; ++i, ++info_it, ++ArgNo) {
John McCalla738c252011-03-09 04:27:21 +00002238 const VarDecl *Arg = *i;
Daniel Dunbarb52d0772009-02-03 05:59:18 +00002239 QualType Ty = info_it->type;
2240 const ABIArgInfo &ArgI = info_it->info;
Daniel Dunbard3674e62008-09-11 01:48:57 +00002241
John McCalla738c252011-03-09 04:27:21 +00002242 bool isPromoted =
2243 isa<ParmVarDecl>(Arg) && cast<ParmVarDecl>(Arg)->isKNRPromoted();
2244
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002245 unsigned FirstIRArg, NumIRArgs;
2246 std::tie(FirstIRArg, NumIRArgs) = IRFunctionArgs.getIRArgs(ArgNo);
Rafael Espindolafad28de2012-10-24 01:59:00 +00002247
Daniel Dunbard3674e62008-09-11 01:48:57 +00002248 switch (ArgI.getKind()) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002249 case ABIArgInfo::InAlloca: {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002250 assert(NumIRArgs == 0);
John McCall7f416cc2015-09-08 08:05:57 +00002251 auto FieldIndex = ArgI.getInAllocaFieldIndex();
2252 CharUnits FieldOffset =
2253 CharUnits::fromQuantity(ArgStructLayout->getElementOffset(FieldIndex));
2254 Address V = Builder.CreateStructGEP(ArgStruct, FieldIndex, FieldOffset,
2255 Arg->getName());
2256 ArgVals.push_back(ParamValue::forIndirect(V));
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002257 break;
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002258 }
2259
Daniel Dunbar747865a2009-02-05 09:16:39 +00002260 case ABIArgInfo::Indirect: {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002261 assert(NumIRArgs == 1);
John McCall7f416cc2015-09-08 08:05:57 +00002262 Address ParamAddr = Address(FnArgs[FirstIRArg], ArgI.getIndirectAlign());
Daniel Dunbar7b7c2932010-09-16 20:42:02 +00002263
John McCall47fb9502013-03-07 21:37:08 +00002264 if (!hasScalarEvaluationKind(Ty)) {
Daniel Dunbar7b7c2932010-09-16 20:42:02 +00002265 // Aggregates and complex variables are accessed by reference. All we
John McCall7f416cc2015-09-08 08:05:57 +00002266 // need to do is realign the value, if requested.
2267 Address V = ParamAddr;
Daniel Dunbar7b7c2932010-09-16 20:42:02 +00002268 if (ArgI.getIndirectRealign()) {
John McCall7f416cc2015-09-08 08:05:57 +00002269 Address AlignedTemp = CreateMemTemp(Ty, "coerce");
Daniel Dunbar7b7c2932010-09-16 20:42:02 +00002270
2271 // Copy from the incoming argument pointer to the temporary with the
2272 // appropriate alignment.
2273 //
2274 // FIXME: We should have a common utility for generating an aggregate
2275 // copy.
Ken Dyck705ba072011-01-19 01:58:38 +00002276 CharUnits Size = getContext().getTypeSizeInChars(Ty);
John McCall7f416cc2015-09-08 08:05:57 +00002277 auto SizeVal = llvm::ConstantInt::get(IntPtrTy, Size.getQuantity());
2278 Address Dst = Builder.CreateBitCast(AlignedTemp, Int8PtrTy);
2279 Address Src = Builder.CreateBitCast(ParamAddr, Int8PtrTy);
2280 Builder.CreateMemCpy(Dst, Src, SizeVal, false);
Daniel Dunbar7b7c2932010-09-16 20:42:02 +00002281 V = AlignedTemp;
2282 }
John McCall7f416cc2015-09-08 08:05:57 +00002283 ArgVals.push_back(ParamValue::forIndirect(V));
Daniel Dunbar747865a2009-02-05 09:16:39 +00002284 } else {
2285 // Load scalar value from indirect argument.
John McCall7f416cc2015-09-08 08:05:57 +00002286 llvm::Value *V =
2287 EmitLoadOfScalar(ParamAddr, false, Ty, Arg->getLocStart());
John McCalla738c252011-03-09 04:27:21 +00002288
2289 if (isPromoted)
2290 V = emitArgumentDemotion(*this, Arg, V);
John McCall7f416cc2015-09-08 08:05:57 +00002291 ArgVals.push_back(ParamValue::forDirect(V));
Daniel Dunbar747865a2009-02-05 09:16:39 +00002292 }
Daniel Dunbar747865a2009-02-05 09:16:39 +00002293 break;
2294 }
Anton Korobeynikov18adbf52009-06-06 09:36:29 +00002295
2296 case ABIArgInfo::Extend:
Daniel Dunbar67dace892009-02-03 06:17:37 +00002297 case ABIArgInfo::Direct: {
Akira Hatanaka18334dd2012-01-09 19:08:06 +00002298
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002299 // If we have the trivial case, handle it with no muss and fuss.
2300 if (!isa<llvm::StructType>(ArgI.getCoerceToType()) &&
Chris Lattner8a2f3c72010-07-30 04:02:24 +00002301 ArgI.getCoerceToType() == ConvertType(Ty) &&
2302 ArgI.getDirectOffset() == 0) {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002303 assert(NumIRArgs == 1);
John McCall12f23522016-04-04 18:33:08 +00002304 llvm::Value *V = FnArgs[FirstIRArg];
2305 auto AI = cast<llvm::Argument>(V);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002306
Hal Finkel48d53e22014-07-19 01:41:07 +00002307 if (const ParmVarDecl *PVD = dyn_cast<ParmVarDecl>(Arg)) {
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00002308 if (getNonNullAttr(CurCodeDecl, PVD, PVD->getType(),
2309 PVD->getFunctionScopeIndex()))
Reid Klecknercdd26792017-04-18 23:50:03 +00002310 AI->addAttr(llvm::Attribute::NonNull);
Hal Finkel82504f02014-07-11 17:35:21 +00002311
Hal Finkel48d53e22014-07-19 01:41:07 +00002312 QualType OTy = PVD->getOriginalType();
2313 if (const auto *ArrTy =
2314 getContext().getAsConstantArrayType(OTy)) {
2315 // A C99 array parameter declaration with the static keyword also
2316 // indicates dereferenceability, and if the size is constant we can
2317 // use the dereferenceable attribute (which requires the size in
2318 // bytes).
Hal Finkel16e394a2014-07-19 02:13:40 +00002319 if (ArrTy->getSizeModifier() == ArrayType::Static) {
Hal Finkel48d53e22014-07-19 01:41:07 +00002320 QualType ETy = ArrTy->getElementType();
2321 uint64_t ArrSize = ArrTy->getSize().getZExtValue();
2322 if (!ETy->isIncompleteType() && ETy->isConstantSizeType() &&
2323 ArrSize) {
2324 llvm::AttrBuilder Attrs;
2325 Attrs.addDereferenceableAttr(
2326 getContext().getTypeSizeInChars(ETy).getQuantity()*ArrSize);
Reid Kleckner9d16fa02017-04-19 17:28:52 +00002327 AI->addAttrs(Attrs);
Hal Finkel48d53e22014-07-19 01:41:07 +00002328 } else if (getContext().getTargetAddressSpace(ETy) == 0) {
Reid Klecknercdd26792017-04-18 23:50:03 +00002329 AI->addAttr(llvm::Attribute::NonNull);
Hal Finkel48d53e22014-07-19 01:41:07 +00002330 }
2331 }
2332 } else if (const auto *ArrTy =
2333 getContext().getAsVariableArrayType(OTy)) {
2334 // For C99 VLAs with the static keyword, we don't know the size so
2335 // we can't use the dereferenceable attribute, but in addrspace(0)
2336 // we know that it must be nonnull.
2337 if (ArrTy->getSizeModifier() == VariableArrayType::Static &&
2338 !getContext().getTargetAddressSpace(ArrTy->getElementType()))
Reid Klecknercdd26792017-04-18 23:50:03 +00002339 AI->addAttr(llvm::Attribute::NonNull);
Hal Finkel48d53e22014-07-19 01:41:07 +00002340 }
Hal Finkel1b0d24e2014-10-02 21:21:25 +00002341
2342 const auto *AVAttr = PVD->getAttr<AlignValueAttr>();
2343 if (!AVAttr)
2344 if (const auto *TOTy = dyn_cast<TypedefType>(OTy))
2345 AVAttr = TOTy->getDecl()->getAttr<AlignValueAttr>();
Reid Kleckner9d16fa02017-04-19 17:28:52 +00002346 if (AVAttr) {
Hal Finkel1b0d24e2014-10-02 21:21:25 +00002347 llvm::Value *AlignmentValue =
2348 EmitScalarExpr(AVAttr->getAlignment());
2349 llvm::ConstantInt *AlignmentCI =
2350 cast<llvm::ConstantInt>(AlignmentValue);
Reid Kleckner9d16fa02017-04-19 17:28:52 +00002351 unsigned Alignment = std::min((unsigned)AlignmentCI->getZExtValue(),
2352 +llvm::Value::MaximumAlignment);
2353 AI->addAttrs(llvm::AttrBuilder().addAlignmentAttr(Alignment));
Hal Finkel1b0d24e2014-10-02 21:21:25 +00002354 }
Hal Finkel48d53e22014-07-19 01:41:07 +00002355 }
2356
Bill Wendling507c3512012-10-16 05:23:44 +00002357 if (Arg->getType().isRestrictQualified())
Reid Klecknercdd26792017-04-18 23:50:03 +00002358 AI->addAttr(llvm::Attribute::NoAlias);
John McCall39ec71f2010-03-27 00:47:27 +00002359
John McCall12f23522016-04-04 18:33:08 +00002360 // LLVM expects swifterror parameters to be used in very restricted
2361 // ways. Copy the value into a less-restricted temporary.
2362 if (FI.getExtParameterInfo(ArgNo).getABI()
2363 == ParameterABI::SwiftErrorResult) {
2364 QualType pointeeTy = Ty->getPointeeType();
2365 assert(pointeeTy->isPointerType());
2366 Address temp =
2367 CreateMemTemp(pointeeTy, getPointerAlign(), "swifterror.temp");
2368 Address arg = Address(V, getContext().getTypeAlignInChars(pointeeTy));
2369 llvm::Value *incomingErrorValue = Builder.CreateLoad(arg);
2370 Builder.CreateStore(incomingErrorValue, temp);
2371 V = temp.getPointer();
2372
2373 // Push a cleanup to copy the value back at the end of the function.
2374 // The convention does not guarantee that the value will be written
2375 // back if the function exits with an unwind exception.
2376 EHStack.pushCleanup<CopyBackSwiftError>(NormalCleanup, temp, arg);
2377 }
2378
Chris Lattner7369c142011-07-20 06:29:00 +00002379 // Ensure the argument is the correct type.
2380 if (V->getType() != ArgI.getCoerceToType())
2381 V = Builder.CreateBitCast(V, ArgI.getCoerceToType());
2382
John McCalla738c252011-03-09 04:27:21 +00002383 if (isPromoted)
2384 V = emitArgumentDemotion(*this, Arg, V);
Rafael Espindola8778c282012-11-29 16:09:03 +00002385
2386 // Because of merging of function types from multiple decls it is
2387 // possible for the type of an argument to not match the corresponding
2388 // type in the function type. Since we are codegening the callee
2389 // in here, add a cast to the argument type.
2390 llvm::Type *LTy = ConvertType(Arg->getType());
2391 if (V->getType() != LTy)
2392 V = Builder.CreateBitCast(V, LTy);
2393
John McCall7f416cc2015-09-08 08:05:57 +00002394 ArgVals.push_back(ParamValue::forDirect(V));
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002395 break;
Daniel Dunbard5f1f552009-02-10 00:06:49 +00002396 }
Mike Stump11289f42009-09-09 15:08:12 +00002397
John McCall7f416cc2015-09-08 08:05:57 +00002398 Address Alloca = CreateMemTemp(Ty, getContext().getDeclAlign(Arg),
2399 Arg->getName());
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002400
John McCall7f416cc2015-09-08 08:05:57 +00002401 // Pointer to store into.
2402 Address Ptr = emitAddressAtOffset(*this, Alloca, ArgI);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002403
Oliver Stannard2bfdc5b2014-08-27 10:43:15 +00002404 // Fast-isel and the optimizer generally like scalar values better than
2405 // FCAs, so we flatten them if this is safe to do for this argument.
Evgeniy Stepanov3fae4ae2012-02-10 09:30:15 +00002406 llvm::StructType *STy = dyn_cast<llvm::StructType>(ArgI.getCoerceToType());
Oliver Stannard2bfdc5b2014-08-27 10:43:15 +00002407 if (ArgI.isDirect() && ArgI.getCanBeFlattened() && STy &&
2408 STy->getNumElements() > 1) {
John McCall7f416cc2015-09-08 08:05:57 +00002409 auto SrcLayout = CGM.getDataLayout().getStructLayout(STy);
Micah Villmowdd31ca12012-10-08 16:25:52 +00002410 uint64_t SrcSize = CGM.getDataLayout().getTypeAllocSize(STy);
John McCall7f416cc2015-09-08 08:05:57 +00002411 llvm::Type *DstTy = Ptr.getElementType();
Micah Villmowdd31ca12012-10-08 16:25:52 +00002412 uint64_t DstSize = CGM.getDataLayout().getTypeAllocSize(DstTy);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002413
John McCall7f416cc2015-09-08 08:05:57 +00002414 Address AddrToStoreInto = Address::invalid();
Evgeniy Stepanov3fae4ae2012-02-10 09:30:15 +00002415 if (SrcSize <= DstSize) {
Yaxun Liue9e5c4f2017-06-29 18:47:45 +00002416 AddrToStoreInto = Builder.CreateElementBitCast(Ptr, STy);
Evgeniy Stepanov3fae4ae2012-02-10 09:30:15 +00002417 } else {
John McCall7f416cc2015-09-08 08:05:57 +00002418 AddrToStoreInto =
2419 CreateTempAlloca(STy, Alloca.getAlignment(), "coerce");
Chris Lattner15ec3612010-06-29 00:06:42 +00002420 }
John McCall7f416cc2015-09-08 08:05:57 +00002421
2422 assert(STy->getNumElements() == NumIRArgs);
2423 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
2424 auto AI = FnArgs[FirstIRArg + i];
2425 AI->setName(Arg->getName() + ".coerce" + Twine(i));
2426 auto Offset = CharUnits::fromQuantity(SrcLayout->getElementOffset(i));
2427 Address EltPtr =
2428 Builder.CreateStructGEP(AddrToStoreInto, i, Offset);
2429 Builder.CreateStore(AI, EltPtr);
2430 }
2431
2432 if (SrcSize > DstSize) {
2433 Builder.CreateMemCpy(Ptr, AddrToStoreInto, DstSize);
2434 }
2435
Chris Lattner15ec3612010-06-29 00:06:42 +00002436 } else {
2437 // Simple case, just do a coerced store of the argument into the alloca.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002438 assert(NumIRArgs == 1);
2439 auto AI = FnArgs[FirstIRArg];
Chris Lattner9e748e92010-06-29 00:14:52 +00002440 AI->setName(Arg->getName() + ".coerce");
John McCall7f416cc2015-09-08 08:05:57 +00002441 CreateCoercedStore(AI, Ptr, /*DestIsVolatile=*/false, *this);
Chris Lattner15ec3612010-06-29 00:06:42 +00002442 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002443
Daniel Dunbar2f219b02009-02-03 19:12:28 +00002444 // Match to what EmitParmDecl is expecting for this type.
John McCall47fb9502013-03-07 21:37:08 +00002445 if (CodeGenFunction::hasScalarEvaluationKind(Ty)) {
John McCall7f416cc2015-09-08 08:05:57 +00002446 llvm::Value *V =
2447 EmitLoadOfScalar(Alloca, false, Ty, Arg->getLocStart());
John McCalla738c252011-03-09 04:27:21 +00002448 if (isPromoted)
2449 V = emitArgumentDemotion(*this, Arg, V);
John McCall7f416cc2015-09-08 08:05:57 +00002450 ArgVals.push_back(ParamValue::forDirect(V));
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002451 } else {
John McCall7f416cc2015-09-08 08:05:57 +00002452 ArgVals.push_back(ParamValue::forIndirect(Alloca));
Daniel Dunbar6e3b7df2009-02-04 07:22:24 +00002453 }
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002454 break;
Daniel Dunbar2f219b02009-02-03 19:12:28 +00002455 }
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002456
John McCallf26e73d2016-03-11 04:30:43 +00002457 case ABIArgInfo::CoerceAndExpand: {
2458 // Reconstruct into a temporary.
2459 Address alloca = CreateMemTemp(Ty, getContext().getDeclAlign(Arg));
2460 ArgVals.push_back(ParamValue::forIndirect(alloca));
2461
2462 auto coercionType = ArgI.getCoerceAndExpandType();
2463 alloca = Builder.CreateElementBitCast(alloca, coercionType);
2464 auto layout = CGM.getDataLayout().getStructLayout(coercionType);
2465
2466 unsigned argIndex = FirstIRArg;
2467 for (unsigned i = 0, e = coercionType->getNumElements(); i != e; ++i) {
2468 llvm::Type *eltType = coercionType->getElementType(i);
2469 if (ABIArgInfo::isPaddingForCoerceAndExpand(eltType))
2470 continue;
2471
2472 auto eltAddr = Builder.CreateStructGEP(alloca, i, layout);
2473 auto elt = FnArgs[argIndex++];
2474 Builder.CreateStore(elt, eltAddr);
2475 }
2476 assert(argIndex == FirstIRArg + NumIRArgs);
2477 break;
2478 }
2479
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002480 case ABIArgInfo::Expand: {
2481 // If this structure was expanded into multiple arguments then
2482 // we need to create a temporary and reconstruct it from the
2483 // arguments.
John McCall7f416cc2015-09-08 08:05:57 +00002484 Address Alloca = CreateMemTemp(Ty, getContext().getDeclAlign(Arg));
2485 LValue LV = MakeAddrLValue(Alloca, Ty);
2486 ArgVals.push_back(ParamValue::forIndirect(Alloca));
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002487
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002488 auto FnArgIter = FnArgs.begin() + FirstIRArg;
2489 ExpandTypeFromArgs(Ty, LV, FnArgIter);
2490 assert(FnArgIter == FnArgs.begin() + FirstIRArg + NumIRArgs);
2491 for (unsigned i = 0, e = NumIRArgs; i != e; ++i) {
2492 auto AI = FnArgs[FirstIRArg + i];
2493 AI->setName(Arg->getName() + "." + Twine(i));
2494 }
2495 break;
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002496 }
2497
2498 case ABIArgInfo::Ignore:
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002499 assert(NumIRArgs == 0);
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002500 // Initialize the local variable appropriately.
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002501 if (!hasScalarEvaluationKind(Ty)) {
John McCall7f416cc2015-09-08 08:05:57 +00002502 ArgVals.push_back(ParamValue::forIndirect(CreateMemTemp(Ty)));
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002503 } else {
2504 llvm::Value *U = llvm::UndefValue::get(ConvertType(Arg->getType()));
John McCall7f416cc2015-09-08 08:05:57 +00002505 ArgVals.push_back(ParamValue::forDirect(U));
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002506 }
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002507 break;
Daniel Dunbard3674e62008-09-11 01:48:57 +00002508 }
Daniel Dunbar613855c2008-09-09 23:27:19 +00002509 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002510
Reid Kleckner739756c2013-12-04 19:23:12 +00002511 if (getTarget().getCXXABI().areArgsDestroyedLeftToRightInCallee()) {
2512 for (int I = Args.size() - 1; I >= 0; --I)
John McCall7f416cc2015-09-08 08:05:57 +00002513 EmitParmDecl(*Args[I], ArgVals[I], I + 1);
Reid Kleckner739756c2013-12-04 19:23:12 +00002514 } else {
2515 for (unsigned I = 0, E = Args.size(); I != E; ++I)
John McCall7f416cc2015-09-08 08:05:57 +00002516 EmitParmDecl(*Args[I], ArgVals[I], I + 1);
Reid Kleckner739756c2013-12-04 19:23:12 +00002517 }
Daniel Dunbar613855c2008-09-09 23:27:19 +00002518}
2519
John McCallffa2c1a2012-01-29 07:46:59 +00002520static void eraseUnusedBitCasts(llvm::Instruction *insn) {
2521 while (insn->use_empty()) {
2522 llvm::BitCastInst *bitcast = dyn_cast<llvm::BitCastInst>(insn);
2523 if (!bitcast) return;
2524
2525 // This is "safe" because we would have used a ConstantExpr otherwise.
2526 insn = cast<llvm::Instruction>(bitcast->getOperand(0));
2527 bitcast->eraseFromParent();
2528 }
2529}
2530
John McCall31168b02011-06-15 23:02:42 +00002531/// Try to emit a fused autorelease of a return result.
2532static llvm::Value *tryEmitFusedAutoreleaseOfResult(CodeGenFunction &CGF,
2533 llvm::Value *result) {
2534 // We must be immediately followed the cast.
2535 llvm::BasicBlock *BB = CGF.Builder.GetInsertBlock();
Craig Topper8a13c412014-05-21 05:09:00 +00002536 if (BB->empty()) return nullptr;
2537 if (&BB->back() != result) return nullptr;
John McCall31168b02011-06-15 23:02:42 +00002538
Chris Lattner2192fe52011-07-18 04:24:23 +00002539 llvm::Type *resultType = result->getType();
John McCall31168b02011-06-15 23:02:42 +00002540
2541 // result is in a BasicBlock and is therefore an Instruction.
2542 llvm::Instruction *generator = cast<llvm::Instruction>(result);
2543
Justin Bogner882f8612016-08-18 21:46:54 +00002544 SmallVector<llvm::Instruction *, 4> InstsToKill;
John McCall31168b02011-06-15 23:02:42 +00002545
2546 // Look for:
2547 // %generator = bitcast %type1* %generator2 to %type2*
2548 while (llvm::BitCastInst *bitcast = dyn_cast<llvm::BitCastInst>(generator)) {
2549 // We would have emitted this as a constant if the operand weren't
2550 // an Instruction.
2551 generator = cast<llvm::Instruction>(bitcast->getOperand(0));
2552
2553 // Require the generator to be immediately followed by the cast.
2554 if (generator->getNextNode() != bitcast)
Craig Topper8a13c412014-05-21 05:09:00 +00002555 return nullptr;
John McCall31168b02011-06-15 23:02:42 +00002556
Justin Bogner882f8612016-08-18 21:46:54 +00002557 InstsToKill.push_back(bitcast);
John McCall31168b02011-06-15 23:02:42 +00002558 }
2559
2560 // Look for:
2561 // %generator = call i8* @objc_retain(i8* %originalResult)
2562 // or
2563 // %generator = call i8* @objc_retainAutoreleasedReturnValue(i8* %originalResult)
2564 llvm::CallInst *call = dyn_cast<llvm::CallInst>(generator);
Craig Topper8a13c412014-05-21 05:09:00 +00002565 if (!call) return nullptr;
John McCall31168b02011-06-15 23:02:42 +00002566
2567 bool doRetainAutorelease;
2568
John McCallb04ecb72015-10-21 18:06:43 +00002569 if (call->getCalledValue() == CGF.CGM.getObjCEntrypoints().objc_retain) {
John McCall31168b02011-06-15 23:02:42 +00002570 doRetainAutorelease = true;
John McCallb04ecb72015-10-21 18:06:43 +00002571 } else if (call->getCalledValue() == CGF.CGM.getObjCEntrypoints()
John McCall31168b02011-06-15 23:02:42 +00002572 .objc_retainAutoreleasedReturnValue) {
2573 doRetainAutorelease = false;
2574
John McCallcfa4e9b2012-09-07 23:30:50 +00002575 // If we emitted an assembly marker for this call (and the
2576 // ARCEntrypoints field should have been set if so), go looking
2577 // for that call. If we can't find it, we can't do this
2578 // optimization. But it should always be the immediately previous
2579 // instruction, unless we needed bitcasts around the call.
John McCallb04ecb72015-10-21 18:06:43 +00002580 if (CGF.CGM.getObjCEntrypoints().retainAutoreleasedReturnValueMarker) {
John McCallcfa4e9b2012-09-07 23:30:50 +00002581 llvm::Instruction *prev = call->getPrevNode();
2582 assert(prev);
2583 if (isa<llvm::BitCastInst>(prev)) {
2584 prev = prev->getPrevNode();
2585 assert(prev);
2586 }
2587 assert(isa<llvm::CallInst>(prev));
2588 assert(cast<llvm::CallInst>(prev)->getCalledValue() ==
John McCallb04ecb72015-10-21 18:06:43 +00002589 CGF.CGM.getObjCEntrypoints().retainAutoreleasedReturnValueMarker);
Justin Bogner882f8612016-08-18 21:46:54 +00002590 InstsToKill.push_back(prev);
John McCallcfa4e9b2012-09-07 23:30:50 +00002591 }
John McCall31168b02011-06-15 23:02:42 +00002592 } else {
Craig Topper8a13c412014-05-21 05:09:00 +00002593 return nullptr;
John McCall31168b02011-06-15 23:02:42 +00002594 }
2595
2596 result = call->getArgOperand(0);
Justin Bogner882f8612016-08-18 21:46:54 +00002597 InstsToKill.push_back(call);
John McCall31168b02011-06-15 23:02:42 +00002598
2599 // Keep killing bitcasts, for sanity. Note that we no longer care
2600 // about precise ordering as long as there's exactly one use.
2601 while (llvm::BitCastInst *bitcast = dyn_cast<llvm::BitCastInst>(result)) {
2602 if (!bitcast->hasOneUse()) break;
Justin Bogner882f8612016-08-18 21:46:54 +00002603 InstsToKill.push_back(bitcast);
John McCall31168b02011-06-15 23:02:42 +00002604 result = bitcast->getOperand(0);
2605 }
2606
2607 // Delete all the unnecessary instructions, from latest to earliest.
Justin Bogner882f8612016-08-18 21:46:54 +00002608 for (auto *I : InstsToKill)
Saleem Abdulrasoolbe25c482016-08-18 21:40:06 +00002609 I->eraseFromParent();
John McCall31168b02011-06-15 23:02:42 +00002610
2611 // Do the fused retain/autorelease if we were asked to.
2612 if (doRetainAutorelease)
2613 result = CGF.EmitARCRetainAutoreleaseReturnValue(result);
2614
2615 // Cast back to the result type.
2616 return CGF.Builder.CreateBitCast(result, resultType);
2617}
2618
John McCallffa2c1a2012-01-29 07:46:59 +00002619/// If this is a +1 of the value of an immutable 'self', remove it.
2620static llvm::Value *tryRemoveRetainOfSelf(CodeGenFunction &CGF,
2621 llvm::Value *result) {
2622 // This is only applicable to a method with an immutable 'self'.
John McCallff755cd2012-07-31 00:33:55 +00002623 const ObjCMethodDecl *method =
2624 dyn_cast_or_null<ObjCMethodDecl>(CGF.CurCodeDecl);
Craig Topper8a13c412014-05-21 05:09:00 +00002625 if (!method) return nullptr;
John McCallffa2c1a2012-01-29 07:46:59 +00002626 const VarDecl *self = method->getSelfDecl();
Craig Topper8a13c412014-05-21 05:09:00 +00002627 if (!self->getType().isConstQualified()) return nullptr;
John McCallffa2c1a2012-01-29 07:46:59 +00002628
2629 // Look for a retain call.
2630 llvm::CallInst *retainCall =
2631 dyn_cast<llvm::CallInst>(result->stripPointerCasts());
2632 if (!retainCall ||
John McCallb04ecb72015-10-21 18:06:43 +00002633 retainCall->getCalledValue() != CGF.CGM.getObjCEntrypoints().objc_retain)
Craig Topper8a13c412014-05-21 05:09:00 +00002634 return nullptr;
John McCallffa2c1a2012-01-29 07:46:59 +00002635
2636 // Look for an ordinary load of 'self'.
2637 llvm::Value *retainedValue = retainCall->getArgOperand(0);
2638 llvm::LoadInst *load =
2639 dyn_cast<llvm::LoadInst>(retainedValue->stripPointerCasts());
2640 if (!load || load->isAtomic() || load->isVolatile() ||
John McCall7f416cc2015-09-08 08:05:57 +00002641 load->getPointerOperand() != CGF.GetAddrOfLocalVar(self).getPointer())
Craig Topper8a13c412014-05-21 05:09:00 +00002642 return nullptr;
John McCallffa2c1a2012-01-29 07:46:59 +00002643
2644 // Okay! Burn it all down. This relies for correctness on the
2645 // assumption that the retain is emitted as part of the return and
2646 // that thereafter everything is used "linearly".
2647 llvm::Type *resultType = result->getType();
2648 eraseUnusedBitCasts(cast<llvm::Instruction>(result));
2649 assert(retainCall->use_empty());
2650 retainCall->eraseFromParent();
2651 eraseUnusedBitCasts(cast<llvm::Instruction>(retainedValue));
2652
2653 return CGF.Builder.CreateBitCast(load, resultType);
2654}
2655
John McCall31168b02011-06-15 23:02:42 +00002656/// Emit an ARC autorelease of the result of a function.
John McCallffa2c1a2012-01-29 07:46:59 +00002657///
2658/// \return the value to actually return from the function
John McCall31168b02011-06-15 23:02:42 +00002659static llvm::Value *emitAutoreleaseOfResult(CodeGenFunction &CGF,
2660 llvm::Value *result) {
John McCallffa2c1a2012-01-29 07:46:59 +00002661 // If we're returning 'self', kill the initial retain. This is a
2662 // heuristic attempt to "encourage correctness" in the really unfortunate
2663 // case where we have a return of self during a dealloc and we desperately
2664 // need to avoid the possible autorelease.
2665 if (llvm::Value *self = tryRemoveRetainOfSelf(CGF, result))
2666 return self;
2667
John McCall31168b02011-06-15 23:02:42 +00002668 // At -O0, try to emit a fused retain/autorelease.
2669 if (CGF.shouldUseFusedARCCalls())
2670 if (llvm::Value *fused = tryEmitFusedAutoreleaseOfResult(CGF, result))
2671 return fused;
2672
2673 return CGF.EmitARCAutoreleaseReturnValue(result);
2674}
2675
John McCall6e1c0122012-01-29 02:35:02 +00002676/// Heuristically search for a dominating store to the return-value slot.
2677static llvm::StoreInst *findDominatingStoreToReturnValue(CodeGenFunction &CGF) {
Jakub Kuderskif50ab0f2015-09-08 10:36:42 +00002678 // Check if a User is a store which pointerOperand is the ReturnValue.
2679 // We are looking for stores to the ReturnValue, not for stores of the
2680 // ReturnValue to some other location.
2681 auto GetStoreIfValid = [&CGF](llvm::User *U) -> llvm::StoreInst * {
2682 auto *SI = dyn_cast<llvm::StoreInst>(U);
2683 if (!SI || SI->getPointerOperand() != CGF.ReturnValue.getPointer())
2684 return nullptr;
2685 // These aren't actually possible for non-coerced returns, and we
2686 // only care about non-coerced returns on this code path.
2687 assert(!SI->isAtomic() && !SI->isVolatile());
2688 return SI;
2689 };
John McCall6e1c0122012-01-29 02:35:02 +00002690 // If there are multiple uses of the return-value slot, just check
2691 // for something immediately preceding the IP. Sometimes this can
2692 // happen with how we generate implicit-returns; it can also happen
2693 // with noreturn cleanups.
John McCall7f416cc2015-09-08 08:05:57 +00002694 if (!CGF.ReturnValue.getPointer()->hasOneUse()) {
John McCall6e1c0122012-01-29 02:35:02 +00002695 llvm::BasicBlock *IP = CGF.Builder.GetInsertBlock();
Craig Topper8a13c412014-05-21 05:09:00 +00002696 if (IP->empty()) return nullptr;
David Majnemerdc012fa2015-04-22 21:38:15 +00002697 llvm::Instruction *I = &IP->back();
2698
2699 // Skip lifetime markers
2700 for (llvm::BasicBlock::reverse_iterator II = IP->rbegin(),
2701 IE = IP->rend();
2702 II != IE; ++II) {
2703 if (llvm::IntrinsicInst *Intrinsic =
2704 dyn_cast<llvm::IntrinsicInst>(&*II)) {
2705 if (Intrinsic->getIntrinsicID() == llvm::Intrinsic::lifetime_end) {
2706 const llvm::Value *CastAddr = Intrinsic->getArgOperand(1);
2707 ++II;
Alexey Samsonov10544202015-06-12 21:05:32 +00002708 if (II == IE)
2709 break;
2710 if (isa<llvm::BitCastInst>(&*II) && (CastAddr == &*II))
2711 continue;
David Majnemerdc012fa2015-04-22 21:38:15 +00002712 }
2713 }
2714 I = &*II;
2715 break;
2716 }
2717
Jakub Kuderskif50ab0f2015-09-08 10:36:42 +00002718 return GetStoreIfValid(I);
John McCall6e1c0122012-01-29 02:35:02 +00002719 }
2720
2721 llvm::StoreInst *store =
Jakub Kuderskif50ab0f2015-09-08 10:36:42 +00002722 GetStoreIfValid(CGF.ReturnValue.getPointer()->user_back());
Craig Topper8a13c412014-05-21 05:09:00 +00002723 if (!store) return nullptr;
John McCall6e1c0122012-01-29 02:35:02 +00002724
John McCall6e1c0122012-01-29 02:35:02 +00002725 // Now do a first-and-dirty dominance check: just walk up the
2726 // single-predecessors chain from the current insertion point.
2727 llvm::BasicBlock *StoreBB = store->getParent();
2728 llvm::BasicBlock *IP = CGF.Builder.GetInsertBlock();
2729 while (IP != StoreBB) {
2730 if (!(IP = IP->getSinglePredecessor()))
Craig Topper8a13c412014-05-21 05:09:00 +00002731 return nullptr;
John McCall6e1c0122012-01-29 02:35:02 +00002732 }
2733
2734 // Okay, the store's basic block dominates the insertion point; we
2735 // can do our thing.
2736 return store;
2737}
2738
Adrian Prantl3be10542013-05-02 17:30:20 +00002739void CodeGenFunction::EmitFunctionEpilog(const CGFunctionInfo &FI,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002740 bool EmitRetDbgLoc,
2741 SourceLocation EndLoc) {
Hans Wennborgd71907d2014-09-04 22:16:33 +00002742 if (CurCodeDecl && CurCodeDecl->hasAttr<NakedAttr>()) {
2743 // Naked functions don't have epilogues.
2744 Builder.CreateUnreachable();
2745 return;
2746 }
2747
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00002748 // Functions with no result always return void.
John McCall7f416cc2015-09-08 08:05:57 +00002749 if (!ReturnValue.isValid()) {
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00002750 Builder.CreateRetVoid();
Chris Lattner726b3d02010-06-26 23:13:19 +00002751 return;
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00002752 }
Daniel Dunbar6696e222010-06-30 21:27:58 +00002753
Dan Gohman481e40c2010-07-20 20:13:52 +00002754 llvm::DebugLoc RetDbgLoc;
Craig Topper8a13c412014-05-21 05:09:00 +00002755 llvm::Value *RV = nullptr;
Chris Lattner726b3d02010-06-26 23:13:19 +00002756 QualType RetTy = FI.getReturnType();
2757 const ABIArgInfo &RetAI = FI.getReturnInfo();
2758
2759 switch (RetAI.getKind()) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002760 case ABIArgInfo::InAlloca:
Reid Klecknerfab1e892014-02-25 00:59:14 +00002761 // Aggregrates get evaluated directly into the destination. Sometimes we
2762 // need to return the sret value in a register, though.
2763 assert(hasAggregateEvaluationKind(RetTy));
2764 if (RetAI.getInAllocaSRet()) {
2765 llvm::Function::arg_iterator EI = CurFn->arg_end();
2766 --EI;
Duncan P. N. Exon Smith9f5260a2015-11-06 23:00:41 +00002767 llvm::Value *ArgStruct = &*EI;
David Blaikie2e804282015-04-05 22:47:07 +00002768 llvm::Value *SRet = Builder.CreateStructGEP(
2769 nullptr, ArgStruct, RetAI.getInAllocaFieldIndex());
John McCall7f416cc2015-09-08 08:05:57 +00002770 RV = Builder.CreateAlignedLoad(SRet, getPointerAlign(), "sret");
Reid Klecknerfab1e892014-02-25 00:59:14 +00002771 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002772 break;
2773
Daniel Dunbar03816342010-08-21 02:24:36 +00002774 case ABIArgInfo::Indirect: {
Reid Kleckner37abaca2014-05-09 22:46:15 +00002775 auto AI = CurFn->arg_begin();
2776 if (RetAI.isSRetAfterThis())
2777 ++AI;
John McCall47fb9502013-03-07 21:37:08 +00002778 switch (getEvaluationKind(RetTy)) {
2779 case TEK_Complex: {
2780 ComplexPairTy RT =
John McCall7f416cc2015-09-08 08:05:57 +00002781 EmitLoadOfComplex(MakeAddrLValue(ReturnValue, RetTy), EndLoc);
Duncan P. N. Exon Smith9f5260a2015-11-06 23:00:41 +00002782 EmitStoreOfComplex(RT, MakeNaturalAlignAddrLValue(&*AI, RetTy),
John McCall47fb9502013-03-07 21:37:08 +00002783 /*isInit*/ true);
2784 break;
2785 }
2786 case TEK_Aggregate:
Chris Lattner726b3d02010-06-26 23:13:19 +00002787 // Do nothing; aggregrates get evaluated directly into the destination.
John McCall47fb9502013-03-07 21:37:08 +00002788 break;
2789 case TEK_Scalar:
2790 EmitStoreOfScalar(Builder.CreateLoad(ReturnValue),
Duncan P. N. Exon Smith9f5260a2015-11-06 23:00:41 +00002791 MakeNaturalAlignAddrLValue(&*AI, RetTy),
John McCall47fb9502013-03-07 21:37:08 +00002792 /*isInit*/ true);
2793 break;
Chris Lattner726b3d02010-06-26 23:13:19 +00002794 }
2795 break;
Daniel Dunbar03816342010-08-21 02:24:36 +00002796 }
Chris Lattner726b3d02010-06-26 23:13:19 +00002797
2798 case ABIArgInfo::Extend:
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002799 case ABIArgInfo::Direct:
Chris Lattner8a2f3c72010-07-30 04:02:24 +00002800 if (RetAI.getCoerceToType() == ConvertType(RetTy) &&
2801 RetAI.getDirectOffset() == 0) {
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002802 // The internal return value temp always will have pointer-to-return-type
2803 // type, just do a load.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002804
John McCall6e1c0122012-01-29 02:35:02 +00002805 // If there is a dominating store to ReturnValue, we can elide
2806 // the load, zap the store, and usually zap the alloca.
David Majnemerdc012fa2015-04-22 21:38:15 +00002807 if (llvm::StoreInst *SI =
2808 findDominatingStoreToReturnValue(*this)) {
Adrian Prantl4c9a38a2013-05-30 18:12:23 +00002809 // Reuse the debug location from the store unless there is
2810 // cleanup code to be emitted between the store and return
2811 // instruction.
2812 if (EmitRetDbgLoc && !AutoreleaseResult)
Adrian Prantl3be10542013-05-02 17:30:20 +00002813 RetDbgLoc = SI->getDebugLoc();
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002814 // Get the stored value and nuke the now-dead store.
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002815 RV = SI->getValueOperand();
2816 SI->eraseFromParent();
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002817
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002818 // If that was the only use of the return value, nuke it as well now.
John McCall7f416cc2015-09-08 08:05:57 +00002819 auto returnValueInst = ReturnValue.getPointer();
2820 if (returnValueInst->use_empty()) {
2821 if (auto alloca = dyn_cast<llvm::AllocaInst>(returnValueInst)) {
2822 alloca->eraseFromParent();
2823 ReturnValue = Address::invalid();
2824 }
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002825 }
John McCall6e1c0122012-01-29 02:35:02 +00002826
2827 // Otherwise, we have to do a simple load.
2828 } else {
2829 RV = Builder.CreateLoad(ReturnValue);
Chris Lattner3fcc7902010-06-27 01:06:27 +00002830 }
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002831 } else {
Chris Lattner8a2f3c72010-07-30 04:02:24 +00002832 // If the value is offset in memory, apply the offset now.
John McCall7f416cc2015-09-08 08:05:57 +00002833 Address V = emitAddressAtOffset(*this, ReturnValue, RetAI);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002834
John McCall7f416cc2015-09-08 08:05:57 +00002835 RV = CreateCoercedLoad(V, RetAI.getCoerceToType(), *this);
Chris Lattner3fcc7902010-06-27 01:06:27 +00002836 }
John McCall31168b02011-06-15 23:02:42 +00002837
2838 // In ARC, end functions that return a retainable type with a call
2839 // to objc_autoreleaseReturnValue.
2840 if (AutoreleaseResult) {
Akira Hatanaka9d8ac612016-02-17 21:09:50 +00002841#ifndef NDEBUG
2842 // Type::isObjCRetainabletype has to be called on a QualType that hasn't
2843 // been stripped of the typedefs, so we cannot use RetTy here. Get the
2844 // original return type of FunctionDecl, CurCodeDecl, and BlockDecl from
2845 // CurCodeDecl or BlockInfo.
2846 QualType RT;
2847
2848 if (auto *FD = dyn_cast<FunctionDecl>(CurCodeDecl))
2849 RT = FD->getReturnType();
2850 else if (auto *MD = dyn_cast<ObjCMethodDecl>(CurCodeDecl))
2851 RT = MD->getReturnType();
2852 else if (isa<BlockDecl>(CurCodeDecl))
2853 RT = BlockInfo->BlockExpression->getFunctionType()->getReturnType();
2854 else
2855 llvm_unreachable("Unexpected function/method type");
2856
David Blaikiebbafb8a2012-03-11 07:00:24 +00002857 assert(getLangOpts().ObjCAutoRefCount &&
John McCall31168b02011-06-15 23:02:42 +00002858 !FI.isReturnsRetained() &&
Akira Hatanaka9d8ac612016-02-17 21:09:50 +00002859 RT->isObjCRetainableType());
2860#endif
John McCall31168b02011-06-15 23:02:42 +00002861 RV = emitAutoreleaseOfResult(*this, RV);
2862 }
2863
Chris Lattner726b3d02010-06-26 23:13:19 +00002864 break;
Chris Lattner726b3d02010-06-26 23:13:19 +00002865
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002866 case ABIArgInfo::Ignore:
Chris Lattner726b3d02010-06-26 23:13:19 +00002867 break;
2868
John McCallf26e73d2016-03-11 04:30:43 +00002869 case ABIArgInfo::CoerceAndExpand: {
2870 auto coercionType = RetAI.getCoerceAndExpandType();
2871 auto layout = CGM.getDataLayout().getStructLayout(coercionType);
2872
2873 // Load all of the coerced elements out into results.
2874 llvm::SmallVector<llvm::Value*, 4> results;
2875 Address addr = Builder.CreateElementBitCast(ReturnValue, coercionType);
2876 for (unsigned i = 0, e = coercionType->getNumElements(); i != e; ++i) {
2877 auto coercedEltType = coercionType->getElementType(i);
2878 if (ABIArgInfo::isPaddingForCoerceAndExpand(coercedEltType))
2879 continue;
2880
2881 auto eltAddr = Builder.CreateStructGEP(addr, i, layout);
2882 auto elt = Builder.CreateLoad(eltAddr);
2883 results.push_back(elt);
2884 }
2885
2886 // If we have one result, it's the single direct result type.
2887 if (results.size() == 1) {
2888 RV = results[0];
2889
2890 // Otherwise, we need to make a first-class aggregate.
2891 } else {
2892 // Construct a return type that lacks padding elements.
2893 llvm::Type *returnType = RetAI.getUnpaddedCoerceAndExpandType();
2894
2895 RV = llvm::UndefValue::get(returnType);
2896 for (unsigned i = 0, e = results.size(); i != e; ++i) {
2897 RV = Builder.CreateInsertValue(RV, results[i], i);
2898 }
2899 }
2900 break;
2901 }
2902
Chris Lattner726b3d02010-06-26 23:13:19 +00002903 case ABIArgInfo::Expand:
David Blaikie83d382b2011-09-23 05:06:16 +00002904 llvm_unreachable("Invalid ABI kind for return argument");
Chris Lattner726b3d02010-06-26 23:13:19 +00002905 }
2906
Alexey Samsonovde443c52014-08-13 00:26:40 +00002907 llvm::Instruction *Ret;
2908 if (RV) {
Vedant Kumarc34d3432017-06-23 21:32:38 +00002909 EmitReturnValueCheck(RV);
Alexey Samsonovde443c52014-08-13 00:26:40 +00002910 Ret = Builder.CreateRet(RV);
2911 } else {
2912 Ret = Builder.CreateRetVoid();
2913 }
2914
Duncan P. N. Exon Smith2809cc72015-03-30 20:01:41 +00002915 if (RetDbgLoc)
Benjamin Kramer03278662015-02-07 13:15:54 +00002916 Ret->setDebugLoc(std::move(RetDbgLoc));
Daniel Dunbar613855c2008-09-09 23:27:19 +00002917}
2918
Vedant Kumarc34d3432017-06-23 21:32:38 +00002919void CodeGenFunction::EmitReturnValueCheck(llvm::Value *RV) {
Vedant Kumar42c17ec2017-03-14 01:56:34 +00002920 // A current decl may not be available when emitting vtable thunks.
2921 if (!CurCodeDecl)
2922 return;
2923
2924 ReturnsNonNullAttr *RetNNAttr = nullptr;
2925 if (SanOpts.has(SanitizerKind::ReturnsNonnullAttribute))
2926 RetNNAttr = CurCodeDecl->getAttr<ReturnsNonNullAttr>();
2927
2928 if (!RetNNAttr && !requiresReturnValueNullabilityCheck())
2929 return;
2930
2931 // Prefer the returns_nonnull attribute if it's present.
2932 SourceLocation AttrLoc;
2933 SanitizerMask CheckKind;
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00002934 SanitizerHandler Handler;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00002935 if (RetNNAttr) {
2936 assert(!requiresReturnValueNullabilityCheck() &&
2937 "Cannot check nullability and the nonnull attribute");
2938 AttrLoc = RetNNAttr->getLocation();
2939 CheckKind = SanitizerKind::ReturnsNonnullAttribute;
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00002940 Handler = SanitizerHandler::NonnullReturn;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00002941 } else {
Vedant Kumar42c17ec2017-03-14 01:56:34 +00002942 if (auto *DD = dyn_cast<DeclaratorDecl>(CurCodeDecl))
2943 if (auto *TSI = DD->getTypeSourceInfo())
2944 if (auto FTL = TSI->getTypeLoc().castAs<FunctionTypeLoc>())
2945 AttrLoc = FTL.getReturnLoc().findNullabilityLoc();
2946 CheckKind = SanitizerKind::NullabilityReturn;
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00002947 Handler = SanitizerHandler::NullabilityReturn;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00002948 }
2949
2950 SanitizerScope SanScope(this);
2951
Vedant Kumarc34d3432017-06-23 21:32:38 +00002952 // Make sure the "return" source location is valid. If we're checking a
2953 // nullability annotation, make sure the preconditions for the check are met.
2954 llvm::BasicBlock *Check = createBasicBlock("nullcheck");
2955 llvm::BasicBlock *NoCheck = createBasicBlock("no.nullcheck");
2956 llvm::Value *SLocPtr = Builder.CreateLoad(ReturnLocation, "return.sloc.load");
2957 llvm::Value *CanNullCheck = Builder.CreateIsNotNull(SLocPtr);
Vedant Kumar42c17ec2017-03-14 01:56:34 +00002958 if (requiresReturnValueNullabilityCheck())
Vedant Kumarc34d3432017-06-23 21:32:38 +00002959 CanNullCheck =
2960 Builder.CreateAnd(CanNullCheck, RetValNullabilityPrecondition);
2961 Builder.CreateCondBr(CanNullCheck, Check, NoCheck);
2962 EmitBlock(Check);
2963
2964 // Now do the null check.
2965 llvm::Value *Cond = Builder.CreateIsNotNull(RV);
2966 llvm::Constant *StaticData[] = {EmitCheckSourceLocation(AttrLoc)};
2967 llvm::Value *DynamicData[] = {SLocPtr};
2968 EmitCheck(std::make_pair(Cond, CheckKind), Handler, StaticData, DynamicData);
2969
2970 EmitBlock(NoCheck);
2971
2972#ifndef NDEBUG
2973 // The return location should not be used after the check has been emitted.
2974 ReturnLocation = Address::invalid();
2975#endif
Vedant Kumar42c17ec2017-03-14 01:56:34 +00002976}
2977
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002978static bool isInAllocaArgument(CGCXXABI &ABI, QualType type) {
2979 const CXXRecordDecl *RD = type->getAsCXXRecordDecl();
2980 return RD && ABI.getRecordArgABI(RD) == CGCXXABI::RAA_DirectInMemory;
2981}
2982
John McCall7f416cc2015-09-08 08:05:57 +00002983static AggValueSlot createPlaceholderSlot(CodeGenFunction &CGF,
2984 QualType Ty) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002985 // FIXME: Generate IR in one pass, rather than going back and fixing up these
2986 // placeholders.
2987 llvm::Type *IRTy = CGF.ConvertTypeForMem(Ty);
Peter Collingbourneb367c562016-11-28 22:30:21 +00002988 llvm::Type *IRPtrTy = IRTy->getPointerTo();
2989 llvm::Value *Placeholder = llvm::UndefValue::get(IRPtrTy->getPointerTo());
John McCall7f416cc2015-09-08 08:05:57 +00002990
2991 // FIXME: When we generate this IR in one pass, we shouldn't need
2992 // this win32-specific alignment hack.
2993 CharUnits Align = CharUnits::fromQuantity(4);
Peter Collingbourneb367c562016-11-28 22:30:21 +00002994 Placeholder = CGF.Builder.CreateAlignedLoad(IRPtrTy, Placeholder, Align);
John McCall7f416cc2015-09-08 08:05:57 +00002995
2996 return AggValueSlot::forAddr(Address(Placeholder, Align),
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002997 Ty.getQualifiers(),
2998 AggValueSlot::IsNotDestructed,
2999 AggValueSlot::DoesNotNeedGCBarriers,
3000 AggValueSlot::IsNotAliased);
3001}
3002
John McCall32ea9692011-03-11 20:59:21 +00003003void CodeGenFunction::EmitDelegateCallArg(CallArgList &args,
Nick Lewycky2d84e842013-10-02 02:29:49 +00003004 const VarDecl *param,
3005 SourceLocation loc) {
John McCall23f66262010-05-26 22:34:26 +00003006 // StartFunction converted the ABI-lowered parameter(s) into a
3007 // local alloca. We need to turn that into an r-value suitable
3008 // for EmitCall.
John McCall7f416cc2015-09-08 08:05:57 +00003009 Address local = GetAddrOfLocalVar(param);
John McCall23f66262010-05-26 22:34:26 +00003010
John McCall32ea9692011-03-11 20:59:21 +00003011 QualType type = param->getType();
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003012
Reid Klecknerab2090d2014-07-26 01:34:32 +00003013 assert(!isInAllocaArgument(CGM.getCXXABI(), type) &&
3014 "cannot emit delegate call arguments for inalloca arguments!");
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003015
John McCall811b2912016-11-18 01:08:24 +00003016 // GetAddrOfLocalVar returns a pointer-to-pointer for references,
3017 // but the argument needs to be the original pointer.
3018 if (type->isReferenceType()) {
3019 args.add(RValue::get(Builder.CreateLoad(local)), type);
3020
3021 // In ARC, move out of consumed arguments so that the release cleanup
3022 // entered by StartFunction doesn't cause an over-release. This isn't
3023 // optimal -O0 code generation, but it should get cleaned up when
3024 // optimization is enabled. This also assumes that delegate calls are
3025 // performed exactly once for a set of arguments, but that should be safe.
3026 } else if (getLangOpts().ObjCAutoRefCount &&
3027 param->hasAttr<NSConsumedAttr>() &&
3028 type->isObjCRetainableType()) {
3029 llvm::Value *ptr = Builder.CreateLoad(local);
3030 auto null =
3031 llvm::ConstantPointerNull::get(cast<llvm::PointerType>(ptr->getType()));
3032 Builder.CreateStore(null, local);
3033 args.add(RValue::get(ptr), type);
3034
Richard Smithd62d4982016-06-14 01:13:21 +00003035 // For the most part, we just need to load the alloca, except that
3036 // aggregate r-values are actually pointers to temporaries.
John McCall811b2912016-11-18 01:08:24 +00003037 } else {
Richard Smithd62d4982016-06-14 01:13:21 +00003038 args.add(convertTempToRValue(local, type, loc), type);
John McCall811b2912016-11-18 01:08:24 +00003039 }
John McCall23f66262010-05-26 22:34:26 +00003040}
3041
John McCall31168b02011-06-15 23:02:42 +00003042static bool isProvablyNull(llvm::Value *addr) {
3043 return isa<llvm::ConstantPointerNull>(addr);
3044}
3045
John McCall31168b02011-06-15 23:02:42 +00003046/// Emit the actual writing-back of a writeback.
3047static void emitWriteback(CodeGenFunction &CGF,
3048 const CallArgList::Writeback &writeback) {
John McCalleff18842013-03-23 02:35:54 +00003049 const LValue &srcLV = writeback.Source;
John McCall7f416cc2015-09-08 08:05:57 +00003050 Address srcAddr = srcLV.getAddress();
3051 assert(!isProvablyNull(srcAddr.getPointer()) &&
John McCall31168b02011-06-15 23:02:42 +00003052 "shouldn't have writeback for provably null argument");
3053
Craig Topper8a13c412014-05-21 05:09:00 +00003054 llvm::BasicBlock *contBB = nullptr;
John McCall31168b02011-06-15 23:02:42 +00003055
3056 // If the argument wasn't provably non-null, we need to null check
3057 // before doing the store.
Nuno Lopes9211cee2017-09-09 18:25:36 +00003058 bool provablyNonNull = llvm::isKnownNonZero(srcAddr.getPointer(),
3059 CGF.CGM.getDataLayout());
John McCall31168b02011-06-15 23:02:42 +00003060 if (!provablyNonNull) {
3061 llvm::BasicBlock *writebackBB = CGF.createBasicBlock("icr.writeback");
3062 contBB = CGF.createBasicBlock("icr.done");
3063
John McCall7f416cc2015-09-08 08:05:57 +00003064 llvm::Value *isNull =
3065 CGF.Builder.CreateIsNull(srcAddr.getPointer(), "icr.isnull");
John McCall31168b02011-06-15 23:02:42 +00003066 CGF.Builder.CreateCondBr(isNull, contBB, writebackBB);
3067 CGF.EmitBlock(writebackBB);
3068 }
3069
3070 // Load the value to writeback.
3071 llvm::Value *value = CGF.Builder.CreateLoad(writeback.Temporary);
3072
3073 // Cast it back, in case we're writing an id to a Foo* or something.
John McCall7f416cc2015-09-08 08:05:57 +00003074 value = CGF.Builder.CreateBitCast(value, srcAddr.getElementType(),
3075 "icr.writeback-cast");
John McCall31168b02011-06-15 23:02:42 +00003076
3077 // Perform the writeback.
John McCalleff18842013-03-23 02:35:54 +00003078
3079 // If we have a "to use" value, it's something we need to emit a use
3080 // of. This has to be carefully threaded in: if it's done after the
3081 // release it's potentially undefined behavior (and the optimizer
3082 // will ignore it), and if it happens before the retain then the
3083 // optimizer could move the release there.
3084 if (writeback.ToUse) {
3085 assert(srcLV.getObjCLifetime() == Qualifiers::OCL_Strong);
3086
3087 // Retain the new value. No need to block-copy here: the block's
3088 // being passed up the stack.
3089 value = CGF.EmitARCRetainNonBlock(value);
3090
3091 // Emit the intrinsic use here.
3092 CGF.EmitARCIntrinsicUse(writeback.ToUse);
3093
3094 // Load the old value (primitively).
Nick Lewycky2d84e842013-10-02 02:29:49 +00003095 llvm::Value *oldValue = CGF.EmitLoadOfScalar(srcLV, SourceLocation());
John McCalleff18842013-03-23 02:35:54 +00003096
3097 // Put the new value in place (primitively).
3098 CGF.EmitStoreOfScalar(value, srcLV, /*init*/ false);
3099
3100 // Release the old value.
3101 CGF.EmitARCRelease(oldValue, srcLV.isARCPreciseLifetime());
3102
3103 // Otherwise, we can just do a normal lvalue store.
3104 } else {
3105 CGF.EmitStoreThroughLValue(RValue::get(value), srcLV);
3106 }
John McCall31168b02011-06-15 23:02:42 +00003107
3108 // Jump to the continuation block.
3109 if (!provablyNonNull)
3110 CGF.EmitBlock(contBB);
3111}
3112
3113static void emitWritebacks(CodeGenFunction &CGF,
3114 const CallArgList &args) {
Aaron Ballman36a7fa82014-03-17 17:22:27 +00003115 for (const auto &I : args.writebacks())
3116 emitWriteback(CGF, I);
John McCall31168b02011-06-15 23:02:42 +00003117}
3118
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003119static void deactivateArgCleanupsBeforeCall(CodeGenFunction &CGF,
3120 const CallArgList &CallArgs) {
Reid Kleckner739756c2013-12-04 19:23:12 +00003121 assert(CGF.getTarget().getCXXABI().areArgsDestroyedLeftToRightInCallee());
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003122 ArrayRef<CallArgList::CallArgCleanup> Cleanups =
3123 CallArgs.getCleanupsToDeactivate();
3124 // Iterate in reverse to increase the likelihood of popping the cleanup.
Pete Cooper57d3f142015-07-30 17:22:52 +00003125 for (const auto &I : llvm::reverse(Cleanups)) {
3126 CGF.DeactivateCleanupBlock(I.Cleanup, I.IsActiveIP);
3127 I.IsActiveIP->eraseFromParent();
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003128 }
3129}
3130
John McCalleff18842013-03-23 02:35:54 +00003131static const Expr *maybeGetUnaryAddrOfOperand(const Expr *E) {
3132 if (const UnaryOperator *uop = dyn_cast<UnaryOperator>(E->IgnoreParens()))
3133 if (uop->getOpcode() == UO_AddrOf)
3134 return uop->getSubExpr();
Craig Topper8a13c412014-05-21 05:09:00 +00003135 return nullptr;
John McCalleff18842013-03-23 02:35:54 +00003136}
3137
John McCall31168b02011-06-15 23:02:42 +00003138/// Emit an argument that's being passed call-by-writeback. That is,
John McCall7f416cc2015-09-08 08:05:57 +00003139/// we are passing the address of an __autoreleased temporary; it
3140/// might be copy-initialized with the current value of the given
3141/// address, but it will definitely be copied out of after the call.
John McCall31168b02011-06-15 23:02:42 +00003142static void emitWritebackArg(CodeGenFunction &CGF, CallArgList &args,
3143 const ObjCIndirectCopyRestoreExpr *CRE) {
John McCalleff18842013-03-23 02:35:54 +00003144 LValue srcLV;
3145
3146 // Make an optimistic effort to emit the address as an l-value.
Eric Christopher2c4555a2015-06-19 01:52:53 +00003147 // This can fail if the argument expression is more complicated.
John McCalleff18842013-03-23 02:35:54 +00003148 if (const Expr *lvExpr = maybeGetUnaryAddrOfOperand(CRE->getSubExpr())) {
3149 srcLV = CGF.EmitLValue(lvExpr);
3150
3151 // Otherwise, just emit it as a scalar.
3152 } else {
John McCall7f416cc2015-09-08 08:05:57 +00003153 Address srcAddr = CGF.EmitPointerWithAlignment(CRE->getSubExpr());
John McCalleff18842013-03-23 02:35:54 +00003154
3155 QualType srcAddrType =
3156 CRE->getSubExpr()->getType()->castAs<PointerType>()->getPointeeType();
John McCall7f416cc2015-09-08 08:05:57 +00003157 srcLV = CGF.MakeAddrLValue(srcAddr, srcAddrType);
John McCalleff18842013-03-23 02:35:54 +00003158 }
John McCall7f416cc2015-09-08 08:05:57 +00003159 Address srcAddr = srcLV.getAddress();
John McCall31168b02011-06-15 23:02:42 +00003160
3161 // The dest and src types don't necessarily match in LLVM terms
3162 // because of the crazy ObjC compatibility rules.
3163
Chris Lattner2192fe52011-07-18 04:24:23 +00003164 llvm::PointerType *destType =
John McCall31168b02011-06-15 23:02:42 +00003165 cast<llvm::PointerType>(CGF.ConvertType(CRE->getType()));
3166
3167 // If the address is a constant null, just pass the appropriate null.
John McCall7f416cc2015-09-08 08:05:57 +00003168 if (isProvablyNull(srcAddr.getPointer())) {
John McCall31168b02011-06-15 23:02:42 +00003169 args.add(RValue::get(llvm::ConstantPointerNull::get(destType)),
3170 CRE->getType());
3171 return;
3172 }
3173
John McCall31168b02011-06-15 23:02:42 +00003174 // Create the temporary.
John McCall7f416cc2015-09-08 08:05:57 +00003175 Address temp = CGF.CreateTempAlloca(destType->getElementType(),
3176 CGF.getPointerAlign(),
3177 "icr.temp");
Fariborz Jahanianfbd19742012-11-27 23:02:53 +00003178 // Loading an l-value can introduce a cleanup if the l-value is __weak,
3179 // and that cleanup will be conditional if we can't prove that the l-value
3180 // isn't null, so we need to register a dominating point so that the cleanups
3181 // system will make valid IR.
3182 CodeGenFunction::ConditionalEvaluation condEval(CGF);
3183
John McCall31168b02011-06-15 23:02:42 +00003184 // Zero-initialize it if we're not doing a copy-initialization.
3185 bool shouldCopy = CRE->shouldCopy();
3186 if (!shouldCopy) {
3187 llvm::Value *null =
3188 llvm::ConstantPointerNull::get(
3189 cast<llvm::PointerType>(destType->getElementType()));
3190 CGF.Builder.CreateStore(null, temp);
3191 }
Craig Topper8a13c412014-05-21 05:09:00 +00003192
3193 llvm::BasicBlock *contBB = nullptr;
3194 llvm::BasicBlock *originBB = nullptr;
John McCall31168b02011-06-15 23:02:42 +00003195
3196 // If the address is *not* known to be non-null, we need to switch.
3197 llvm::Value *finalArgument;
3198
Nuno Lopes9211cee2017-09-09 18:25:36 +00003199 bool provablyNonNull = llvm::isKnownNonZero(srcAddr.getPointer(),
3200 CGF.CGM.getDataLayout());
John McCall31168b02011-06-15 23:02:42 +00003201 if (provablyNonNull) {
John McCall7f416cc2015-09-08 08:05:57 +00003202 finalArgument = temp.getPointer();
John McCall31168b02011-06-15 23:02:42 +00003203 } else {
John McCall7f416cc2015-09-08 08:05:57 +00003204 llvm::Value *isNull =
3205 CGF.Builder.CreateIsNull(srcAddr.getPointer(), "icr.isnull");
John McCall31168b02011-06-15 23:02:42 +00003206
3207 finalArgument = CGF.Builder.CreateSelect(isNull,
3208 llvm::ConstantPointerNull::get(destType),
John McCall7f416cc2015-09-08 08:05:57 +00003209 temp.getPointer(), "icr.argument");
John McCall31168b02011-06-15 23:02:42 +00003210
3211 // If we need to copy, then the load has to be conditional, which
3212 // means we need control flow.
3213 if (shouldCopy) {
John McCalleff18842013-03-23 02:35:54 +00003214 originBB = CGF.Builder.GetInsertBlock();
John McCall31168b02011-06-15 23:02:42 +00003215 contBB = CGF.createBasicBlock("icr.cont");
3216 llvm::BasicBlock *copyBB = CGF.createBasicBlock("icr.copy");
3217 CGF.Builder.CreateCondBr(isNull, contBB, copyBB);
3218 CGF.EmitBlock(copyBB);
Fariborz Jahanianfbd19742012-11-27 23:02:53 +00003219 condEval.begin(CGF);
John McCall31168b02011-06-15 23:02:42 +00003220 }
3221 }
3222
Craig Topper8a13c412014-05-21 05:09:00 +00003223 llvm::Value *valueToUse = nullptr;
John McCalleff18842013-03-23 02:35:54 +00003224
John McCall31168b02011-06-15 23:02:42 +00003225 // Perform a copy if necessary.
3226 if (shouldCopy) {
Nick Lewycky2d84e842013-10-02 02:29:49 +00003227 RValue srcRV = CGF.EmitLoadOfLValue(srcLV, SourceLocation());
John McCall31168b02011-06-15 23:02:42 +00003228 assert(srcRV.isScalar());
3229
3230 llvm::Value *src = srcRV.getScalarVal();
3231 src = CGF.Builder.CreateBitCast(src, destType->getElementType(),
3232 "icr.cast");
3233
3234 // Use an ordinary store, not a store-to-lvalue.
3235 CGF.Builder.CreateStore(src, temp);
John McCalleff18842013-03-23 02:35:54 +00003236
3237 // If optimization is enabled, and the value was held in a
3238 // __strong variable, we need to tell the optimizer that this
3239 // value has to stay alive until we're doing the store back.
3240 // This is because the temporary is effectively unretained,
3241 // and so otherwise we can violate the high-level semantics.
3242 if (CGF.CGM.getCodeGenOpts().OptimizationLevel != 0 &&
3243 srcLV.getObjCLifetime() == Qualifiers::OCL_Strong) {
3244 valueToUse = src;
3245 }
John McCall31168b02011-06-15 23:02:42 +00003246 }
Fariborz Jahanianfbd19742012-11-27 23:02:53 +00003247
John McCall31168b02011-06-15 23:02:42 +00003248 // Finish the control flow if we needed it.
Fariborz Jahanianfbd19742012-11-27 23:02:53 +00003249 if (shouldCopy && !provablyNonNull) {
John McCalleff18842013-03-23 02:35:54 +00003250 llvm::BasicBlock *copyBB = CGF.Builder.GetInsertBlock();
John McCall31168b02011-06-15 23:02:42 +00003251 CGF.EmitBlock(contBB);
John McCalleff18842013-03-23 02:35:54 +00003252
3253 // Make a phi for the value to intrinsically use.
3254 if (valueToUse) {
3255 llvm::PHINode *phiToUse = CGF.Builder.CreatePHI(valueToUse->getType(), 2,
3256 "icr.to-use");
3257 phiToUse->addIncoming(valueToUse, copyBB);
3258 phiToUse->addIncoming(llvm::UndefValue::get(valueToUse->getType()),
3259 originBB);
3260 valueToUse = phiToUse;
3261 }
3262
Fariborz Jahanianfbd19742012-11-27 23:02:53 +00003263 condEval.end(CGF);
3264 }
John McCall31168b02011-06-15 23:02:42 +00003265
John McCalleff18842013-03-23 02:35:54 +00003266 args.addWriteback(srcLV, temp, valueToUse);
John McCall31168b02011-06-15 23:02:42 +00003267 args.add(RValue::get(finalArgument), CRE->getType());
3268}
3269
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003270void CallArgList::allocateArgumentMemory(CodeGenFunction &CGF) {
Richard Smith762672a2016-09-28 19:09:10 +00003271 assert(!StackBase);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003272
3273 // Save the stack.
3274 llvm::Function *F = CGF.CGM.getIntrinsic(llvm::Intrinsic::stacksave);
David Blaikie43f9bb72015-05-18 22:14:03 +00003275 StackBase = CGF.Builder.CreateCall(F, {}, "inalloca.save");
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003276}
3277
Nico Weber8cdb3f92015-08-25 18:43:32 +00003278void CallArgList::freeArgumentMemory(CodeGenFunction &CGF) const {
3279 if (StackBase) {
Reid Kleckner7c2f9e82015-10-08 00:17:45 +00003280 // Restore the stack after the call.
Nico Weber8cdb3f92015-08-25 18:43:32 +00003281 llvm::Value *F = CGF.CGM.getIntrinsic(llvm::Intrinsic::stackrestore);
Nico Weber8cdb3f92015-08-25 18:43:32 +00003282 CGF.Builder.CreateCall(F, StackBase);
3283 }
3284}
3285
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003286void CodeGenFunction::EmitNonNullArgCheck(RValue RV, QualType ArgType,
3287 SourceLocation ArgLoc,
Vedant Kumared00ea02017-03-06 05:28:22 +00003288 AbstractCallee AC,
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003289 unsigned ParmNum) {
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003290 if (!AC.getDecl() || !(SanOpts.has(SanitizerKind::NonnullAttribute) ||
3291 SanOpts.has(SanitizerKind::NullabilityArg)))
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003292 return;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003293
3294 // The param decl may be missing in a variadic function.
Vedant Kumared00ea02017-03-06 05:28:22 +00003295 auto PVD = ParmNum < AC.getNumParams() ? AC.getParamDecl(ParmNum) : nullptr;
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003296 unsigned ArgNo = PVD ? PVD->getFunctionScopeIndex() : ParmNum;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003297
3298 // Prefer the nonnull attribute if it's present.
3299 const NonNullAttr *NNAttr = nullptr;
3300 if (SanOpts.has(SanitizerKind::NonnullAttribute))
3301 NNAttr = getNonNullAttr(AC.getDecl(), PVD, ArgType, ArgNo);
3302
3303 bool CanCheckNullability = false;
3304 if (SanOpts.has(SanitizerKind::NullabilityArg) && !NNAttr && PVD) {
3305 auto Nullability = PVD->getType()->getNullability(getContext());
3306 CanCheckNullability = Nullability &&
3307 *Nullability == NullabilityKind::NonNull &&
3308 PVD->getTypeSourceInfo();
3309 }
3310
3311 if (!NNAttr && !CanCheckNullability)
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003312 return;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003313
3314 SourceLocation AttrLoc;
3315 SanitizerMask CheckKind;
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00003316 SanitizerHandler Handler;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003317 if (NNAttr) {
3318 AttrLoc = NNAttr->getLocation();
3319 CheckKind = SanitizerKind::NonnullAttribute;
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00003320 Handler = SanitizerHandler::NonnullArg;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003321 } else {
3322 AttrLoc = PVD->getTypeSourceInfo()->getTypeLoc().findNullabilityLoc();
3323 CheckKind = SanitizerKind::NullabilityArg;
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00003324 Handler = SanitizerHandler::NullabilityArg;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003325 }
3326
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003327 SanitizerScope SanScope(this);
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003328 assert(RV.isScalar());
3329 llvm::Value *V = RV.getScalarVal();
3330 llvm::Value *Cond =
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003331 Builder.CreateICmpNE(V, llvm::Constant::getNullValue(V->getType()));
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003332 llvm::Constant *StaticData[] = {
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003333 EmitCheckSourceLocation(ArgLoc), EmitCheckSourceLocation(AttrLoc),
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003334 llvm::ConstantInt::get(Int32Ty, ArgNo + 1),
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003335 };
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00003336 EmitCheck(std::make_pair(Cond, CheckKind), Handler, StaticData, None);
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003337}
3338
David Blaikief05779e2015-07-21 18:37:18 +00003339void CodeGenFunction::EmitCallArgs(
3340 CallArgList &Args, ArrayRef<QualType> ArgTypes,
3341 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Vedant Kumared00ea02017-03-06 05:28:22 +00003342 AbstractCallee AC, unsigned ParamsToSkip, EvaluationOrder Order) {
David Blaikief05779e2015-07-21 18:37:18 +00003343 assert((int)ArgTypes.size() == (ArgRange.end() - ArgRange.begin()));
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003344
Reid Kleckner739756c2013-12-04 19:23:12 +00003345 // We *have* to evaluate arguments from right to left in the MS C++ ABI,
Richard Smitha560ccf2016-09-29 21:30:12 +00003346 // because arguments are destroyed left to right in the callee. As a special
3347 // case, there are certain language constructs that require left-to-right
3348 // evaluation, and in those cases we consider the evaluation order requirement
3349 // to trump the "destruction order is reverse construction order" guarantee.
3350 bool LeftToRight =
3351 CGM.getTarget().getCXXABI().areArgsDestroyedLeftToRightInCallee()
3352 ? Order == EvaluationOrder::ForceLeftToRight
3353 : Order != EvaluationOrder::ForceRightToLeft;
3354
George Burgess IV0d6592a2017-02-23 05:59:56 +00003355 auto MaybeEmitImplicitObjectSize = [&](unsigned I, const Expr *Arg,
3356 RValue EmittedArg) {
Vedant Kumared00ea02017-03-06 05:28:22 +00003357 if (!AC.hasFunctionDecl() || I >= AC.getNumParams())
George Burgess IV0d6592a2017-02-23 05:59:56 +00003358 return;
Vedant Kumared00ea02017-03-06 05:28:22 +00003359 auto *PS = AC.getParamDecl(I)->getAttr<PassObjectSizeAttr>();
George Burgess IV0d6592a2017-02-23 05:59:56 +00003360 if (PS == nullptr)
3361 return;
3362
3363 const auto &Context = getContext();
3364 auto SizeTy = Context.getSizeType();
3365 auto T = Builder.getIntNTy(Context.getTypeSize(SizeTy));
3366 assert(EmittedArg.getScalarVal() && "We emitted nothing for the arg?");
3367 llvm::Value *V = evaluateOrEmitBuiltinObjectSize(Arg, PS->getType(), T,
3368 EmittedArg.getScalarVal());
3369 Args.add(RValue::get(V), SizeTy);
3370 // If we're emitting args in reverse, be sure to do so with
3371 // pass_object_size, as well.
3372 if (!LeftToRight)
3373 std::swap(Args.back(), *(&Args.back() - 1));
3374 };
3375
Richard Smitha560ccf2016-09-29 21:30:12 +00003376 // Insert a stack save if we're going to need any inalloca args.
3377 bool HasInAllocaArgs = false;
3378 if (CGM.getTarget().getCXXABI().isMicrosoft()) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003379 for (ArrayRef<QualType>::iterator I = ArgTypes.begin(), E = ArgTypes.end();
3380 I != E && !HasInAllocaArgs; ++I)
3381 HasInAllocaArgs = isInAllocaArgument(CGM.getCXXABI(), *I);
3382 if (HasInAllocaArgs) {
3383 assert(getTarget().getTriple().getArch() == llvm::Triple::x86);
3384 Args.allocateArgumentMemory(*this);
3385 }
Richard Smitha560ccf2016-09-29 21:30:12 +00003386 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003387
Richard Smitha560ccf2016-09-29 21:30:12 +00003388 // Evaluate each argument in the appropriate order.
3389 size_t CallArgsStart = Args.size();
3390 for (unsigned I = 0, E = ArgTypes.size(); I != E; ++I) {
3391 unsigned Idx = LeftToRight ? I : E - I - 1;
3392 CallExpr::const_arg_iterator Arg = ArgRange.begin() + Idx;
George Burgess IV0d6592a2017-02-23 05:59:56 +00003393 unsigned InitialArgSize = Args.size();
Akira Hatanaka46dd7dbc2017-06-28 00:42:48 +00003394 // If *Arg is an ObjCIndirectCopyRestoreExpr, check that either the types of
3395 // the argument and parameter match or the objc method is parameterized.
3396 assert((!isa<ObjCIndirectCopyRestoreExpr>(*Arg) ||
3397 getContext().hasSameUnqualifiedType((*Arg)->getType(),
3398 ArgTypes[Idx]) ||
3399 (isa<ObjCMethodDecl>(AC.getDecl()) &&
3400 isObjCMethodWithTypeParams(cast<ObjCMethodDecl>(AC.getDecl())))) &&
3401 "Argument and parameter types don't match");
Richard Smitha560ccf2016-09-29 21:30:12 +00003402 EmitCallArg(Args, *Arg, ArgTypes[Idx]);
George Burgess IV0d6592a2017-02-23 05:59:56 +00003403 // In particular, we depend on it being the last arg in Args, and the
3404 // objectsize bits depend on there only being one arg if !LeftToRight.
3405 assert(InitialArgSize + 1 == Args.size() &&
3406 "The code below depends on only adding one arg per EmitCallArg");
3407 (void)InitialArgSize;
3408 RValue RVArg = Args.back().RV;
Vedant Kumared00ea02017-03-06 05:28:22 +00003409 EmitNonNullArgCheck(RVArg, ArgTypes[Idx], (*Arg)->getExprLoc(), AC,
George Burgess IV0d6592a2017-02-23 05:59:56 +00003410 ParamsToSkip + Idx);
3411 // @llvm.objectsize should never have side-effects and shouldn't need
3412 // destruction/cleanups, so we can safely "emit" it after its arg,
3413 // regardless of right-to-leftness
3414 MaybeEmitImplicitObjectSize(Idx, *Arg, RVArg);
Richard Smitha560ccf2016-09-29 21:30:12 +00003415 }
Reid Kleckner739756c2013-12-04 19:23:12 +00003416
Richard Smitha560ccf2016-09-29 21:30:12 +00003417 if (!LeftToRight) {
Reid Kleckner739756c2013-12-04 19:23:12 +00003418 // Un-reverse the arguments we just evaluated so they match up with the LLVM
3419 // IR function.
3420 std::reverse(Args.begin() + CallArgsStart, Args.end());
Reid Kleckner739756c2013-12-04 19:23:12 +00003421 }
3422}
3423
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003424namespace {
3425
David Blaikie7e70d682015-08-18 22:40:54 +00003426struct DestroyUnpassedArg final : EHScopeStack::Cleanup {
John McCall7f416cc2015-09-08 08:05:57 +00003427 DestroyUnpassedArg(Address Addr, QualType Ty)
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003428 : Addr(Addr), Ty(Ty) {}
3429
John McCall7f416cc2015-09-08 08:05:57 +00003430 Address Addr;
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003431 QualType Ty;
3432
Craig Topper4f12f102014-03-12 06:41:41 +00003433 void Emit(CodeGenFunction &CGF, Flags flags) override {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003434 const CXXDestructorDecl *Dtor = Ty->getAsCXXRecordDecl()->getDestructor();
3435 assert(!Dtor->isTrivial());
3436 CGF.EmitCXXDestructorCall(Dtor, Dtor_Complete, /*for vbase*/ false,
3437 /*Delegating=*/false, Addr);
3438 }
3439};
3440
David Blaikie38b25912015-02-09 19:13:51 +00003441struct DisableDebugLocationUpdates {
3442 CodeGenFunction &CGF;
3443 bool disabledDebugInfo;
3444 DisableDebugLocationUpdates(CodeGenFunction &CGF, const Expr *E) : CGF(CGF) {
3445 if ((disabledDebugInfo = isa<CXXDefaultArgExpr>(E) && CGF.getDebugInfo()))
3446 CGF.disableDebugInfo();
3447 }
3448 ~DisableDebugLocationUpdates() {
3449 if (disabledDebugInfo)
3450 CGF.enableDebugInfo();
3451 }
3452};
3453
Benjamin Kramer5b4296a2015-10-28 17:16:26 +00003454} // end anonymous namespace
3455
John McCall32ea9692011-03-11 20:59:21 +00003456void CodeGenFunction::EmitCallArg(CallArgList &args, const Expr *E,
3457 QualType type) {
David Blaikie38b25912015-02-09 19:13:51 +00003458 DisableDebugLocationUpdates Dis(*this, E);
John McCall31168b02011-06-15 23:02:42 +00003459 if (const ObjCIndirectCopyRestoreExpr *CRE
3460 = dyn_cast<ObjCIndirectCopyRestoreExpr>(E)) {
Richard Smith9c6890a2012-11-01 22:30:59 +00003461 assert(getLangOpts().ObjCAutoRefCount);
John McCall31168b02011-06-15 23:02:42 +00003462 return emitWritebackArg(*this, args, CRE);
3463 }
3464
John McCall0a76c0c2011-08-26 18:42:59 +00003465 assert(type->isReferenceType() == E->isGLValue() &&
3466 "reference binding to unmaterialized r-value!");
3467
John McCall17054bd62011-08-26 21:08:13 +00003468 if (E->isGLValue()) {
3469 assert(E->getObjectKind() == OK_Ordinary);
Richard Smitha1c9d4d2013-06-12 23:38:09 +00003470 return args.add(EmitReferenceBindingToExpr(E), type);
John McCall17054bd62011-08-26 21:08:13 +00003471 }
Mike Stump11289f42009-09-09 15:08:12 +00003472
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003473 bool HasAggregateEvalKind = hasAggregateEvaluationKind(type);
3474
3475 // In the Microsoft C++ ABI, aggregate arguments are destructed by the callee.
3476 // However, we still have to push an EH-only cleanup in case we unwind before
3477 // we make it to the call.
Reid Klecknerac640602014-05-01 03:07:18 +00003478 if (HasAggregateEvalKind &&
3479 CGM.getTarget().getCXXABI().areArgsDestroyedLeftToRightInCallee()) {
3480 // If we're using inalloca, use the argument memory. Otherwise, use a
Reid Klecknere39ee212014-05-03 00:33:28 +00003481 // temporary.
Reid Klecknerac640602014-05-01 03:07:18 +00003482 AggValueSlot Slot;
3483 if (args.isUsingInAlloca())
3484 Slot = createPlaceholderSlot(*this, type);
3485 else
3486 Slot = CreateAggTemp(type, "agg.tmp");
Reid Klecknere39ee212014-05-03 00:33:28 +00003487
3488 const CXXRecordDecl *RD = type->getAsCXXRecordDecl();
3489 bool DestroyedInCallee =
3490 RD && RD->hasNonTrivialDestructor() &&
3491 CGM.getCXXABI().getRecordArgABI(RD) != CGCXXABI::RAA_Default;
3492 if (DestroyedInCallee)
3493 Slot.setExternallyDestructed();
3494
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003495 EmitAggExpr(E, Slot);
3496 RValue RV = Slot.asRValue();
3497 args.add(RV, type);
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003498
Reid Klecknere39ee212014-05-03 00:33:28 +00003499 if (DestroyedInCallee) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003500 // Create a no-op GEP between the placeholder and the cleanup so we can
3501 // RAUW it successfully. It also serves as a marker of the first
3502 // instruction where the cleanup is active.
John McCall7f416cc2015-09-08 08:05:57 +00003503 pushFullExprCleanup<DestroyUnpassedArg>(EHCleanup, Slot.getAddress(),
3504 type);
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003505 // This unreachable is a temporary marker which will be removed later.
3506 llvm::Instruction *IsActive = Builder.CreateUnreachable();
3507 args.addArgCleanupDeactivation(EHStack.getInnermostEHScope(), IsActive);
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003508 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003509 return;
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003510 }
3511
3512 if (HasAggregateEvalKind && isa<ImplicitCastExpr>(E) &&
Eli Friedmandf968192011-05-26 00:10:27 +00003513 cast<CastExpr>(E)->getCastKind() == CK_LValueToRValue) {
3514 LValue L = EmitLValue(cast<CastExpr>(E)->getSubExpr());
3515 assert(L.isSimple());
Eli Friedman61f615a2013-06-11 01:08:22 +00003516 if (L.getAlignment() >= getContext().getTypeAlignInChars(type)) {
3517 args.add(L.asAggregateRValue(), type, /*NeedsCopy*/true);
3518 } else {
3519 // We can't represent a misaligned lvalue in the CallArgList, so copy
3520 // to an aligned temporary now.
John McCall7f416cc2015-09-08 08:05:57 +00003521 Address tmp = CreateMemTemp(type);
3522 EmitAggregateCopy(tmp, L.getAddress(), type, L.isVolatile());
Eli Friedman61f615a2013-06-11 01:08:22 +00003523 args.add(RValue::getAggregate(tmp), type);
3524 }
Eli Friedmandf968192011-05-26 00:10:27 +00003525 return;
3526 }
3527
John McCall32ea9692011-03-11 20:59:21 +00003528 args.add(EmitAnyExprToTemp(E), type);
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00003529}
3530
Reid Kleckner79b0fd72014-10-10 00:05:45 +00003531QualType CodeGenFunction::getVarArgType(const Expr *Arg) {
3532 // System headers on Windows define NULL to 0 instead of 0LL on Win64. MSVC
3533 // implicitly widens null pointer constants that are arguments to varargs
3534 // functions to pointer-sized ints.
3535 if (!getTarget().getTriple().isOSWindows())
3536 return Arg->getType();
3537
3538 if (Arg->getType()->isIntegerType() &&
3539 getContext().getTypeSize(Arg->getType()) <
3540 getContext().getTargetInfo().getPointerWidth(0) &&
3541 Arg->isNullPointerConstant(getContext(),
3542 Expr::NPC_ValueDependentIsNotNull)) {
3543 return getContext().getIntPtrType();
3544 }
3545
3546 return Arg->getType();
3547}
3548
Dan Gohman515a60d2012-02-16 00:57:37 +00003549// In ObjC ARC mode with no ObjC ARC exception safety, tell the ARC
3550// optimizer it can aggressively ignore unwind edges.
3551void
3552CodeGenFunction::AddObjCARCExceptionMetadata(llvm::Instruction *Inst) {
3553 if (CGM.getCodeGenOpts().OptimizationLevel != 0 &&
3554 !CGM.getCodeGenOpts().ObjCAutoRefCountExceptions)
3555 Inst->setMetadata("clang.arc.no_objc_arc_exceptions",
3556 CGM.getNoObjCARCExceptionsMetadata());
3557}
3558
John McCall882987f2013-02-28 19:01:20 +00003559/// Emits a call to the given no-arguments nounwind runtime function.
3560llvm::CallInst *
3561CodeGenFunction::EmitNounwindRuntimeCall(llvm::Value *callee,
3562 const llvm::Twine &name) {
Craig Topper5fc8fc22014-08-27 06:28:36 +00003563 return EmitNounwindRuntimeCall(callee, None, name);
John McCall882987f2013-02-28 19:01:20 +00003564}
3565
3566/// Emits a call to the given nounwind runtime function.
3567llvm::CallInst *
3568CodeGenFunction::EmitNounwindRuntimeCall(llvm::Value *callee,
3569 ArrayRef<llvm::Value*> args,
3570 const llvm::Twine &name) {
3571 llvm::CallInst *call = EmitRuntimeCall(callee, args, name);
3572 call->setDoesNotThrow();
3573 return call;
3574}
3575
3576/// Emits a simple call (never an invoke) to the given no-arguments
3577/// runtime function.
3578llvm::CallInst *
3579CodeGenFunction::EmitRuntimeCall(llvm::Value *callee,
3580 const llvm::Twine &name) {
Craig Topper5fc8fc22014-08-27 06:28:36 +00003581 return EmitRuntimeCall(callee, None, name);
John McCall882987f2013-02-28 19:01:20 +00003582}
3583
David Majnemer0b17d442015-12-15 21:27:59 +00003584// Calls which may throw must have operand bundles indicating which funclet
3585// they are nested within.
3586static void
Sanjay Patel846b63b2016-01-18 22:15:33 +00003587getBundlesForFunclet(llvm::Value *Callee, llvm::Instruction *CurrentFuncletPad,
David Majnemer0b17d442015-12-15 21:27:59 +00003588 SmallVectorImpl<llvm::OperandBundleDef> &BundleList) {
Sanjay Patel846b63b2016-01-18 22:15:33 +00003589 // There is no need for a funclet operand bundle if we aren't inside a
3590 // funclet.
David Majnemer0b17d442015-12-15 21:27:59 +00003591 if (!CurrentFuncletPad)
3592 return;
3593
3594 // Skip intrinsics which cannot throw.
3595 auto *CalleeFn = dyn_cast<llvm::Function>(Callee->stripPointerCasts());
3596 if (CalleeFn && CalleeFn->isIntrinsic() && CalleeFn->doesNotThrow())
3597 return;
3598
3599 BundleList.emplace_back("funclet", CurrentFuncletPad);
3600}
3601
David Majnemer971d31b2016-02-24 17:02:45 +00003602/// Emits a simple call (never an invoke) to the given runtime function.
3603llvm::CallInst *
3604CodeGenFunction::EmitRuntimeCall(llvm::Value *callee,
3605 ArrayRef<llvm::Value*> args,
3606 const llvm::Twine &name) {
3607 SmallVector<llvm::OperandBundleDef, 1> BundleList;
3608 getBundlesForFunclet(callee, CurrentFuncletPad, BundleList);
3609
3610 llvm::CallInst *call = Builder.CreateCall(callee, args, BundleList, name);
3611 call->setCallingConv(getRuntimeCC());
3612 return call;
3613}
3614
John McCall882987f2013-02-28 19:01:20 +00003615/// Emits a call or invoke to the given noreturn runtime function.
3616void CodeGenFunction::EmitNoreturnRuntimeCallOrInvoke(llvm::Value *callee,
3617 ArrayRef<llvm::Value*> args) {
David Majnemer0b17d442015-12-15 21:27:59 +00003618 SmallVector<llvm::OperandBundleDef, 1> BundleList;
3619 getBundlesForFunclet(callee, CurrentFuncletPad, BundleList);
3620
John McCall882987f2013-02-28 19:01:20 +00003621 if (getInvokeDest()) {
3622 llvm::InvokeInst *invoke =
3623 Builder.CreateInvoke(callee,
3624 getUnreachableBlock(),
3625 getInvokeDest(),
David Majnemer0b17d442015-12-15 21:27:59 +00003626 args,
3627 BundleList);
John McCall882987f2013-02-28 19:01:20 +00003628 invoke->setDoesNotReturn();
3629 invoke->setCallingConv(getRuntimeCC());
3630 } else {
David Majnemer0b17d442015-12-15 21:27:59 +00003631 llvm::CallInst *call = Builder.CreateCall(callee, args, BundleList);
John McCall882987f2013-02-28 19:01:20 +00003632 call->setDoesNotReturn();
3633 call->setCallingConv(getRuntimeCC());
3634 Builder.CreateUnreachable();
3635 }
3636}
3637
Sanjay Patel846b63b2016-01-18 22:15:33 +00003638/// Emits a call or invoke instruction to the given nullary runtime function.
John McCall882987f2013-02-28 19:01:20 +00003639llvm::CallSite
3640CodeGenFunction::EmitRuntimeCallOrInvoke(llvm::Value *callee,
3641 const Twine &name) {
Craig Topper5fc8fc22014-08-27 06:28:36 +00003642 return EmitRuntimeCallOrInvoke(callee, None, name);
John McCall882987f2013-02-28 19:01:20 +00003643}
3644
3645/// Emits a call or invoke instruction to the given runtime function.
3646llvm::CallSite
3647CodeGenFunction::EmitRuntimeCallOrInvoke(llvm::Value *callee,
3648 ArrayRef<llvm::Value*> args,
3649 const Twine &name) {
3650 llvm::CallSite callSite = EmitCallOrInvoke(callee, args, name);
3651 callSite.setCallingConv(getRuntimeCC());
3652 return callSite;
3653}
3654
John McCallbd309292010-07-06 01:34:17 +00003655/// Emits a call or invoke instruction to the given function, depending
3656/// on the current state of the EH stack.
3657llvm::CallSite
3658CodeGenFunction::EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner54b16772011-07-23 17:14:25 +00003659 ArrayRef<llvm::Value *> Args,
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003660 const Twine &Name) {
John McCallbd309292010-07-06 01:34:17 +00003661 llvm::BasicBlock *InvokeDest = getInvokeDest();
David Majnemer3df77bc2016-01-26 23:14:47 +00003662 SmallVector<llvm::OperandBundleDef, 1> BundleList;
3663 getBundlesForFunclet(Callee, CurrentFuncletPad, BundleList);
John McCallbd309292010-07-06 01:34:17 +00003664
Dan Gohman515a60d2012-02-16 00:57:37 +00003665 llvm::Instruction *Inst;
3666 if (!InvokeDest)
David Majnemer3df77bc2016-01-26 23:14:47 +00003667 Inst = Builder.CreateCall(Callee, Args, BundleList, Name);
Dan Gohman515a60d2012-02-16 00:57:37 +00003668 else {
3669 llvm::BasicBlock *ContBB = createBasicBlock("invoke.cont");
David Majnemer3df77bc2016-01-26 23:14:47 +00003670 Inst = Builder.CreateInvoke(Callee, ContBB, InvokeDest, Args, BundleList,
3671 Name);
Dan Gohman515a60d2012-02-16 00:57:37 +00003672 EmitBlock(ContBB);
3673 }
3674
3675 // In ObjC ARC mode with no ObjC ARC exception safety, tell the ARC
3676 // optimizer it can aggressively ignore unwind edges.
David Blaikiebbafb8a2012-03-11 07:00:24 +00003677 if (CGM.getLangOpts().ObjCAutoRefCount)
Dan Gohman515a60d2012-02-16 00:57:37 +00003678 AddObjCARCExceptionMetadata(Inst);
3679
Benjamin Kramerc19cde12015-04-10 14:49:31 +00003680 return llvm::CallSite(Inst);
John McCallbd309292010-07-06 01:34:17 +00003681}
3682
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003683/// \brief Store a non-aggregate value to an address to initialize it. For
3684/// initialization, a non-atomic store will be used.
3685static void EmitInitStoreOfNonAggregate(CodeGenFunction &CGF, RValue Src,
3686 LValue Dst) {
3687 if (Src.isScalar())
3688 CGF.EmitStoreOfScalar(Src.getScalarVal(), Dst, /*init=*/true);
3689 else
3690 CGF.EmitStoreOfComplex(Src.getComplexVal(), Dst, /*init=*/true);
3691}
3692
3693void CodeGenFunction::deferPlaceholderReplacement(llvm::Instruction *Old,
3694 llvm::Value *New) {
3695 DeferredReplacements.push_back(std::make_pair(Old, New));
3696}
Chris Lattnerd59d8672011-07-12 06:29:11 +00003697
Daniel Dunbard931a872009-02-02 22:03:45 +00003698RValue CodeGenFunction::EmitCall(const CGFunctionInfo &CallInfo,
John McCallb92ab1a2016-10-26 23:46:34 +00003699 const CGCallee &Callee,
Anders Carlsson61a401c2009-12-24 19:25:24 +00003700 ReturnValueSlot ReturnValue,
Daniel Dunbarcdbb5e32009-02-20 18:06:48 +00003701 const CallArgList &CallArgs,
David Chisnallff5f88c2010-05-02 13:41:58 +00003702 llvm::Instruction **callOrInvoke) {
Mike Stump18bb9282009-05-16 07:57:57 +00003703 // FIXME: We no longer need the types from CallArgs; lift up and simplify.
Daniel Dunbar613855c2008-09-09 23:27:19 +00003704
John McCallb92ab1a2016-10-26 23:46:34 +00003705 assert(Callee.isOrdinary());
3706
Daniel Dunbar613855c2008-09-09 23:27:19 +00003707 // Handle struct-return functions by passing a pointer to the
3708 // location that we would like to return into.
Daniel Dunbar7633cbf2009-02-02 21:43:58 +00003709 QualType RetTy = CallInfo.getReturnType();
Daniel Dunbarb52d0772009-02-03 05:59:18 +00003710 const ABIArgInfo &RetAI = CallInfo.getReturnInfo();
Mike Stump11289f42009-09-09 15:08:12 +00003711
John McCallb92ab1a2016-10-26 23:46:34 +00003712 llvm::FunctionType *IRFuncTy = Callee.getFunctionType();
3713
3714 // 1. Set up the arguments.
Mike Stump11289f42009-09-09 15:08:12 +00003715
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003716 // If we're using inalloca, insert the allocation after the stack save.
3717 // FIXME: Do this earlier rather than hacking it in here!
John McCall7f416cc2015-09-08 08:05:57 +00003718 Address ArgMemory = Address::invalid();
3719 const llvm::StructLayout *ArgMemoryLayout = nullptr;
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003720 if (llvm::StructType *ArgStruct = CallInfo.getArgStruct()) {
Matt Arsenault502ad602017-04-10 22:28:02 +00003721 const llvm::DataLayout &DL = CGM.getDataLayout();
3722 ArgMemoryLayout = DL.getStructLayout(ArgStruct);
Reid Kleckner9df1d972014-04-10 01:40:15 +00003723 llvm::Instruction *IP = CallArgs.getStackBase();
3724 llvm::AllocaInst *AI;
3725 if (IP) {
3726 IP = IP->getNextNode();
Matt Arsenault502ad602017-04-10 22:28:02 +00003727 AI = new llvm::AllocaInst(ArgStruct, DL.getAllocaAddrSpace(),
3728 "argmem", IP);
Reid Kleckner9df1d972014-04-10 01:40:15 +00003729 } else {
Reid Kleckner966abe72014-05-15 23:01:46 +00003730 AI = CreateTempAlloca(ArgStruct, "argmem");
Reid Kleckner9df1d972014-04-10 01:40:15 +00003731 }
John McCall7f416cc2015-09-08 08:05:57 +00003732 auto Align = CallInfo.getArgStructAlignment();
3733 AI->setAlignment(Align.getQuantity());
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003734 AI->setUsedWithInAlloca(true);
3735 assert(AI->isUsedWithInAlloca() && !AI->isStaticAlloca());
John McCall7f416cc2015-09-08 08:05:57 +00003736 ArgMemory = Address(AI, Align);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003737 }
3738
John McCall7f416cc2015-09-08 08:05:57 +00003739 // Helper function to drill into the inalloca allocation.
3740 auto createInAllocaStructGEP = [&](unsigned FieldIndex) -> Address {
3741 auto FieldOffset =
3742 CharUnits::fromQuantity(ArgMemoryLayout->getElementOffset(FieldIndex));
3743 return Builder.CreateStructGEP(ArgMemory, FieldIndex, FieldOffset);
3744 };
3745
Alexey Samsonov153004f2014-09-29 22:08:00 +00003746 ClangToLLVMArgMapping IRFunctionArgs(CGM.getContext(), CallInfo);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003747 SmallVector<llvm::Value *, 16> IRCallArgs(IRFunctionArgs.totalIRArgs());
3748
Chris Lattner4ca97c32009-06-13 00:26:38 +00003749 // If the call returns a temporary with struct return, create a temporary
Anders Carlsson17490832009-12-24 20:40:36 +00003750 // alloca to hold the result, unless one is given to us.
John McCall7f416cc2015-09-08 08:05:57 +00003751 Address SRetPtr = Address::invalid();
Leny Kholodov6aab1112015-06-08 10:23:49 +00003752 size_t UnusedReturnSize = 0;
John McCallf26e73d2016-03-11 04:30:43 +00003753 if (RetAI.isIndirect() || RetAI.isInAlloca() || RetAI.isCoerceAndExpand()) {
John McCall7f416cc2015-09-08 08:05:57 +00003754 if (!ReturnValue.isNull()) {
3755 SRetPtr = ReturnValue.getValue();
3756 } else {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003757 SRetPtr = CreateMemTemp(RetTy);
Leny Kholodov6aab1112015-06-08 10:23:49 +00003758 if (HaveInsertPoint() && ReturnValue.isUnused()) {
3759 uint64_t size =
3760 CGM.getDataLayout().getTypeAllocSize(ConvertTypeForMem(RetTy));
John McCall7f416cc2015-09-08 08:05:57 +00003761 if (EmitLifetimeStart(size, SRetPtr.getPointer()))
Leny Kholodov6aab1112015-06-08 10:23:49 +00003762 UnusedReturnSize = size;
3763 }
3764 }
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003765 if (IRFunctionArgs.hasSRetArg()) {
John McCall7f416cc2015-09-08 08:05:57 +00003766 IRCallArgs[IRFunctionArgs.getSRetArgNo()] = SRetPtr.getPointer();
John McCallf26e73d2016-03-11 04:30:43 +00003767 } else if (RetAI.isInAlloca()) {
John McCall7f416cc2015-09-08 08:05:57 +00003768 Address Addr = createInAllocaStructGEP(RetAI.getInAllocaFieldIndex());
3769 Builder.CreateStore(SRetPtr.getPointer(), Addr);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003770 }
Anders Carlsson17490832009-12-24 20:40:36 +00003771 }
Mike Stump11289f42009-09-09 15:08:12 +00003772
John McCall12f23522016-04-04 18:33:08 +00003773 Address swiftErrorTemp = Address::invalid();
3774 Address swiftErrorArg = Address::invalid();
3775
John McCallb92ab1a2016-10-26 23:46:34 +00003776 // Translate all of the arguments as necessary to match the IR lowering.
Daniel Dunbara45bdbb2009-02-04 21:17:21 +00003777 assert(CallInfo.arg_size() == CallArgs.size() &&
3778 "Mismatch between function signature & arguments.");
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003779 unsigned ArgNo = 0;
Daniel Dunbarb52d0772009-02-03 05:59:18 +00003780 CGFunctionInfo::const_arg_iterator info_it = CallInfo.arg_begin();
Mike Stump11289f42009-09-09 15:08:12 +00003781 for (CallArgList::const_iterator I = CallArgs.begin(), E = CallArgs.end();
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003782 I != E; ++I, ++info_it, ++ArgNo) {
Daniel Dunbarb52d0772009-02-03 05:59:18 +00003783 const ABIArgInfo &ArgInfo = info_it->info;
Eli Friedmanf4258eb2011-05-02 18:05:27 +00003784 RValue RV = I->RV;
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00003785
Rafael Espindolafad28de2012-10-24 01:59:00 +00003786 // Insert a padding argument to ensure proper alignment.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003787 if (IRFunctionArgs.hasPaddingArg(ArgNo))
3788 IRCallArgs[IRFunctionArgs.getPaddingArgNo(ArgNo)] =
3789 llvm::UndefValue::get(ArgInfo.getPaddingType());
3790
3791 unsigned FirstIRArg, NumIRArgs;
3792 std::tie(FirstIRArg, NumIRArgs) = IRFunctionArgs.getIRArgs(ArgNo);
Rafael Espindolafad28de2012-10-24 01:59:00 +00003793
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00003794 switch (ArgInfo.getKind()) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003795 case ABIArgInfo::InAlloca: {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003796 assert(NumIRArgs == 0);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003797 assert(getTarget().getTriple().getArch() == llvm::Triple::x86);
3798 if (RV.isAggregate()) {
3799 // Replace the placeholder with the appropriate argument slot GEP.
3800 llvm::Instruction *Placeholder =
John McCall7f416cc2015-09-08 08:05:57 +00003801 cast<llvm::Instruction>(RV.getAggregatePointer());
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003802 CGBuilderTy::InsertPoint IP = Builder.saveIP();
3803 Builder.SetInsertPoint(Placeholder);
John McCall7f416cc2015-09-08 08:05:57 +00003804 Address Addr = createInAllocaStructGEP(ArgInfo.getInAllocaFieldIndex());
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003805 Builder.restoreIP(IP);
John McCall7f416cc2015-09-08 08:05:57 +00003806 deferPlaceholderReplacement(Placeholder, Addr.getPointer());
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003807 } else {
3808 // Store the RValue into the argument struct.
John McCall7f416cc2015-09-08 08:05:57 +00003809 Address Addr = createInAllocaStructGEP(ArgInfo.getInAllocaFieldIndex());
3810 unsigned AS = Addr.getType()->getPointerAddressSpace();
David Majnemer32b57b02014-03-31 16:12:47 +00003811 llvm::Type *MemType = ConvertTypeForMem(I->Ty)->getPointerTo(AS);
3812 // There are some cases where a trivial bitcast is not avoidable. The
3813 // definition of a type later in a translation unit may change it's type
3814 // from {}* to (%struct.foo*)*.
John McCall7f416cc2015-09-08 08:05:57 +00003815 if (Addr.getType() != MemType)
David Majnemer32b57b02014-03-31 16:12:47 +00003816 Addr = Builder.CreateBitCast(Addr, MemType);
John McCall7f416cc2015-09-08 08:05:57 +00003817 LValue argLV = MakeAddrLValue(Addr, I->Ty);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003818 EmitInitStoreOfNonAggregate(*this, RV, argLV);
3819 }
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003820 break;
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003821 }
3822
Daniel Dunbar03816342010-08-21 02:24:36 +00003823 case ABIArgInfo::Indirect: {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003824 assert(NumIRArgs == 1);
Daniel Dunbar747865a2009-02-05 09:16:39 +00003825 if (RV.isScalar() || RV.isComplex()) {
3826 // Make a temporary alloca to pass the argument.
Yaxun Liu84744c12017-06-19 17:03:41 +00003827 Address Addr = CreateMemTemp(I->Ty, ArgInfo.getIndirectAlign(),
3828 "indirect-arg-temp", false);
John McCall7f416cc2015-09-08 08:05:57 +00003829 IRCallArgs[FirstIRArg] = Addr.getPointer();
John McCall47fb9502013-03-07 21:37:08 +00003830
John McCall7f416cc2015-09-08 08:05:57 +00003831 LValue argLV = MakeAddrLValue(Addr, I->Ty);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003832 EmitInitStoreOfNonAggregate(*this, RV, argLV);
Daniel Dunbar747865a2009-02-05 09:16:39 +00003833 } else {
Eli Friedmaneb7fab62011-06-14 01:37:52 +00003834 // We want to avoid creating an unnecessary temporary+copy here;
Guy Benyei3832bfd2013-03-10 12:59:00 +00003835 // however, we need one in three cases:
Eli Friedmaneb7fab62011-06-14 01:37:52 +00003836 // 1. If the argument is not byval, and we are required to copy the
3837 // source. (This case doesn't occur on any common architecture.)
3838 // 2. If the argument is byval, RV is not sufficiently aligned, and
3839 // we cannot force it to be sufficiently aligned.
Guy Benyei3832bfd2013-03-10 12:59:00 +00003840 // 3. If the argument is byval, but RV is located in an address space
3841 // different than that of the argument (0).
John McCall7f416cc2015-09-08 08:05:57 +00003842 Address Addr = RV.getAggregateAddress();
3843 CharUnits Align = ArgInfo.getIndirectAlign();
Micah Villmowdd31ca12012-10-08 16:25:52 +00003844 const llvm::DataLayout *TD = &CGM.getDataLayout();
John McCall7f416cc2015-09-08 08:05:57 +00003845 const unsigned RVAddrSpace = Addr.getType()->getAddressSpace();
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003846 const unsigned ArgAddrSpace =
3847 (FirstIRArg < IRFuncTy->getNumParams()
3848 ? IRFuncTy->getParamType(FirstIRArg)->getPointerAddressSpace()
3849 : 0);
Eli Friedmanf7456192011-06-15 22:09:18 +00003850 if ((!ArgInfo.getIndirectByVal() && I->NeedsCopy) ||
John McCall7f416cc2015-09-08 08:05:57 +00003851 (ArgInfo.getIndirectByVal() && Addr.getAlignment() < Align &&
3852 llvm::getOrEnforceKnownAlignment(Addr.getPointer(),
3853 Align.getQuantity(), *TD)
3854 < Align.getQuantity()) ||
Mehdi Aminib3d52092015-03-10 02:36:43 +00003855 (ArgInfo.getIndirectByVal() && (RVAddrSpace != ArgAddrSpace))) {
Eli Friedmaneb7fab62011-06-14 01:37:52 +00003856 // Create an aligned temporary, and copy to it.
Yaxun Liu84744c12017-06-19 17:03:41 +00003857 Address AI = CreateMemTemp(I->Ty, ArgInfo.getIndirectAlign(),
3858 "byval-temp", false);
John McCall7f416cc2015-09-08 08:05:57 +00003859 IRCallArgs[FirstIRArg] = AI.getPointer();
Chad Rosier615ed1a2012-03-29 17:37:10 +00003860 EmitAggregateCopy(AI, Addr, I->Ty, RV.isVolatileQualified());
Eli Friedmaneb7fab62011-06-14 01:37:52 +00003861 } else {
3862 // Skip the extra memcpy call.
John McCall7f416cc2015-09-08 08:05:57 +00003863 IRCallArgs[FirstIRArg] = Addr.getPointer();
Eli Friedmaneb7fab62011-06-14 01:37:52 +00003864 }
Daniel Dunbar747865a2009-02-05 09:16:39 +00003865 }
3866 break;
Daniel Dunbar03816342010-08-21 02:24:36 +00003867 }
Daniel Dunbar747865a2009-02-05 09:16:39 +00003868
Daniel Dunbar94a6f252009-01-26 21:26:08 +00003869 case ABIArgInfo::Ignore:
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003870 assert(NumIRArgs == 0);
Daniel Dunbar94a6f252009-01-26 21:26:08 +00003871 break;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003872
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00003873 case ABIArgInfo::Extend:
3874 case ABIArgInfo::Direct: {
3875 if (!isa<llvm::StructType>(ArgInfo.getCoerceToType()) &&
Chris Lattner8a2f3c72010-07-30 04:02:24 +00003876 ArgInfo.getCoerceToType() == ConvertType(info_it->type) &&
3877 ArgInfo.getDirectOffset() == 0) {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003878 assert(NumIRArgs == 1);
Chris Lattnerbb1952c2011-07-12 04:46:18 +00003879 llvm::Value *V;
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00003880 if (RV.isScalar())
Chris Lattnerbb1952c2011-07-12 04:46:18 +00003881 V = RV.getScalarVal();
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00003882 else
John McCall7f416cc2015-09-08 08:05:57 +00003883 V = Builder.CreateLoad(RV.getAggregateAddress());
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003884
John McCall12f23522016-04-04 18:33:08 +00003885 // Implement swifterror by copying into a new swifterror argument.
3886 // We'll write back in the normal path out of the call.
3887 if (CallInfo.getExtParameterInfo(ArgNo).getABI()
3888 == ParameterABI::SwiftErrorResult) {
3889 assert(!swiftErrorTemp.isValid() && "multiple swifterror args");
3890
3891 QualType pointeeTy = I->Ty->getPointeeType();
3892 swiftErrorArg =
3893 Address(V, getContext().getTypeAlignInChars(pointeeTy));
3894
3895 swiftErrorTemp =
3896 CreateMemTemp(pointeeTy, getPointerAlign(), "swifterror.temp");
3897 V = swiftErrorTemp.getPointer();
3898 cast<llvm::AllocaInst>(V)->setSwiftError(true);
3899
3900 llvm::Value *errorValue = Builder.CreateLoad(swiftErrorArg);
3901 Builder.CreateStore(errorValue, swiftErrorTemp);
3902 }
3903
Reid Kleckner79b0fd72014-10-10 00:05:45 +00003904 // We might have to widen integers, but we should never truncate.
3905 if (ArgInfo.getCoerceToType() != V->getType() &&
3906 V->getType()->isIntegerTy())
3907 V = Builder.CreateZExt(V, ArgInfo.getCoerceToType());
3908
Chris Lattner3ce86682011-07-12 04:53:39 +00003909 // If the argument doesn't match, perform a bitcast to coerce it. This
3910 // can happen due to trivial type mismatches.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003911 if (FirstIRArg < IRFuncTy->getNumParams() &&
3912 V->getType() != IRFuncTy->getParamType(FirstIRArg))
3913 V = Builder.CreateBitCast(V, IRFuncTy->getParamType(FirstIRArg));
John McCall12f23522016-04-04 18:33:08 +00003914
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003915 IRCallArgs[FirstIRArg] = V;
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00003916 break;
3917 }
Daniel Dunbar94a6f252009-01-26 21:26:08 +00003918
Daniel Dunbar2f219b02009-02-03 19:12:28 +00003919 // FIXME: Avoid the conversion through memory if possible.
John McCall7f416cc2015-09-08 08:05:57 +00003920 Address Src = Address::invalid();
John McCall47fb9502013-03-07 21:37:08 +00003921 if (RV.isScalar() || RV.isComplex()) {
John McCall7f416cc2015-09-08 08:05:57 +00003922 Src = CreateMemTemp(I->Ty, "coerce");
3923 LValue SrcLV = MakeAddrLValue(Src, I->Ty);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003924 EmitInitStoreOfNonAggregate(*this, RV, SrcLV);
Ulrich Weigand6e2cea62015-07-10 11:31:43 +00003925 } else {
John McCall7f416cc2015-09-08 08:05:57 +00003926 Src = RV.getAggregateAddress();
Ulrich Weigand6e2cea62015-07-10 11:31:43 +00003927 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003928
Chris Lattner8a2f3c72010-07-30 04:02:24 +00003929 // If the value is offset in memory, apply the offset now.
John McCall7f416cc2015-09-08 08:05:57 +00003930 Src = emitAddressAtOffset(*this, Src, ArgInfo);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003931
Oliver Stannard2bfdc5b2014-08-27 10:43:15 +00003932 // Fast-isel and the optimizer generally like scalar values better than
3933 // FCAs, so we flatten them if this is safe to do for this argument.
James Molloy6f244b62014-05-09 16:21:39 +00003934 llvm::StructType *STy =
3935 dyn_cast<llvm::StructType>(ArgInfo.getCoerceToType());
Oliver Stannard2bfdc5b2014-08-27 10:43:15 +00003936 if (STy && ArgInfo.isDirect() && ArgInfo.getCanBeFlattened()) {
John McCall7f416cc2015-09-08 08:05:57 +00003937 llvm::Type *SrcTy = Src.getType()->getElementType();
Chandler Carrutha6399a52012-10-10 11:29:08 +00003938 uint64_t SrcSize = CGM.getDataLayout().getTypeAllocSize(SrcTy);
3939 uint64_t DstSize = CGM.getDataLayout().getTypeAllocSize(STy);
3940
3941 // If the source type is smaller than the destination type of the
3942 // coerce-to logic, copy the source value into a temp alloca the size
3943 // of the destination type to allow loading all of it. The bits past
3944 // the source value are left undef.
3945 if (SrcSize < DstSize) {
John McCall7f416cc2015-09-08 08:05:57 +00003946 Address TempAlloca
3947 = CreateTempAlloca(STy, Src.getAlignment(),
3948 Src.getName() + ".coerce");
3949 Builder.CreateMemCpy(TempAlloca, Src, SrcSize);
3950 Src = TempAlloca;
Chandler Carrutha6399a52012-10-10 11:29:08 +00003951 } else {
Matt Arsenault7a124f32017-08-01 20:36:57 +00003952 Src = Builder.CreateBitCast(Src,
3953 STy->getPointerTo(Src.getAddressSpace()));
Chandler Carrutha6399a52012-10-10 11:29:08 +00003954 }
3955
John McCall7f416cc2015-09-08 08:05:57 +00003956 auto SrcLayout = CGM.getDataLayout().getStructLayout(STy);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003957 assert(NumIRArgs == STy->getNumElements());
Chris Lattnerceddafb2010-07-05 20:41:41 +00003958 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
John McCall7f416cc2015-09-08 08:05:57 +00003959 auto Offset = CharUnits::fromQuantity(SrcLayout->getElementOffset(i));
3960 Address EltPtr = Builder.CreateStructGEP(Src, i, Offset);
3961 llvm::Value *LI = Builder.CreateLoad(EltPtr);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003962 IRCallArgs[FirstIRArg + i] = LI;
Chris Lattner15ec3612010-06-29 00:06:42 +00003963 }
Chris Lattner3dd716c2010-06-28 23:44:11 +00003964 } else {
Chris Lattner15ec3612010-06-29 00:06:42 +00003965 // In the simple case, just pass the coerced loaded value.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003966 assert(NumIRArgs == 1);
3967 IRCallArgs[FirstIRArg] =
John McCall7f416cc2015-09-08 08:05:57 +00003968 CreateCoercedLoad(Src, ArgInfo.getCoerceToType(), *this);
Chris Lattner3dd716c2010-06-28 23:44:11 +00003969 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003970
Daniel Dunbar2f219b02009-02-03 19:12:28 +00003971 break;
3972 }
3973
John McCallf26e73d2016-03-11 04:30:43 +00003974 case ABIArgInfo::CoerceAndExpand: {
John McCallf26e73d2016-03-11 04:30:43 +00003975 auto coercionType = ArgInfo.getCoerceAndExpandType();
3976 auto layout = CGM.getDataLayout().getStructLayout(coercionType);
3977
John McCall12f23522016-04-04 18:33:08 +00003978 llvm::Value *tempSize = nullptr;
3979 Address addr = Address::invalid();
3980 if (RV.isAggregate()) {
3981 addr = RV.getAggregateAddress();
3982 } else {
3983 assert(RV.isScalar()); // complex should always just be direct
3984
3985 llvm::Type *scalarType = RV.getScalarVal()->getType();
3986 auto scalarSize = CGM.getDataLayout().getTypeAllocSize(scalarType);
3987 auto scalarAlign = CGM.getDataLayout().getPrefTypeAlignment(scalarType);
3988
3989 tempSize = llvm::ConstantInt::get(CGM.Int64Ty, scalarSize);
3990
3991 // Materialize to a temporary.
3992 addr = CreateTempAlloca(RV.getScalarVal()->getType(),
3993 CharUnits::fromQuantity(std::max(layout->getAlignment(),
3994 scalarAlign)));
3995 EmitLifetimeStart(scalarSize, addr.getPointer());
3996
3997 Builder.CreateStore(RV.getScalarVal(), addr);
3998 }
3999
John McCallf26e73d2016-03-11 04:30:43 +00004000 addr = Builder.CreateElementBitCast(addr, coercionType);
4001
4002 unsigned IRArgPos = FirstIRArg;
4003 for (unsigned i = 0, e = coercionType->getNumElements(); i != e; ++i) {
4004 llvm::Type *eltType = coercionType->getElementType(i);
4005 if (ABIArgInfo::isPaddingForCoerceAndExpand(eltType)) continue;
4006 Address eltAddr = Builder.CreateStructGEP(addr, i, layout);
4007 llvm::Value *elt = Builder.CreateLoad(eltAddr);
4008 IRCallArgs[IRArgPos++] = elt;
4009 }
4010 assert(IRArgPos == FirstIRArg + NumIRArgs);
4011
John McCall12f23522016-04-04 18:33:08 +00004012 if (tempSize) {
4013 EmitLifetimeEnd(tempSize, addr.getPointer());
4014 }
4015
John McCallf26e73d2016-03-11 04:30:43 +00004016 break;
4017 }
4018
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00004019 case ABIArgInfo::Expand:
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004020 unsigned IRArgPos = FirstIRArg;
4021 ExpandTypeToArgs(I->Ty, RV, IRFuncTy, IRCallArgs, IRArgPos);
4022 assert(IRArgPos == FirstIRArg + NumIRArgs);
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00004023 break;
Daniel Dunbar613855c2008-09-09 23:27:19 +00004024 }
4025 }
Mike Stump11289f42009-09-09 15:08:12 +00004026
John McCallb92ab1a2016-10-26 23:46:34 +00004027 llvm::Value *CalleePtr = Callee.getFunctionPointer();
4028
4029 // If we're using inalloca, set up that argument.
John McCall7f416cc2015-09-08 08:05:57 +00004030 if (ArgMemory.isValid()) {
4031 llvm::Value *Arg = ArgMemory.getPointer();
Reid Klecknerafba553e2014-07-08 02:24:27 +00004032 if (CallInfo.isVariadic()) {
4033 // When passing non-POD arguments by value to variadic functions, we will
4034 // end up with a variadic prototype and an inalloca call site. In such
4035 // cases, we can't do any parameter mismatch checks. Give up and bitcast
4036 // the callee.
John McCallb92ab1a2016-10-26 23:46:34 +00004037 unsigned CalleeAS = CalleePtr->getType()->getPointerAddressSpace();
4038 auto FnTy = getTypes().GetFunctionType(CallInfo)->getPointerTo(CalleeAS);
4039 CalleePtr = Builder.CreateBitCast(CalleePtr, FnTy);
Reid Klecknerafba553e2014-07-08 02:24:27 +00004040 } else {
4041 llvm::Type *LastParamTy =
4042 IRFuncTy->getParamType(IRFuncTy->getNumParams() - 1);
4043 if (Arg->getType() != LastParamTy) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00004044#ifndef NDEBUG
Reid Klecknerafba553e2014-07-08 02:24:27 +00004045 // Assert that these structs have equivalent element types.
4046 llvm::StructType *FullTy = CallInfo.getArgStruct();
4047 llvm::StructType *DeclaredTy = cast<llvm::StructType>(
4048 cast<llvm::PointerType>(LastParamTy)->getElementType());
4049 assert(DeclaredTy->getNumElements() == FullTy->getNumElements());
4050 for (llvm::StructType::element_iterator DI = DeclaredTy->element_begin(),
4051 DE = DeclaredTy->element_end(),
4052 FI = FullTy->element_begin();
4053 DI != DE; ++DI, ++FI)
4054 assert(*DI == *FI);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00004055#endif
Reid Klecknerafba553e2014-07-08 02:24:27 +00004056 Arg = Builder.CreateBitCast(Arg, LastParamTy);
4057 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00004058 }
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004059 assert(IRFunctionArgs.hasInallocaArg());
4060 IRCallArgs[IRFunctionArgs.getInallocaArgNo()] = Arg;
Reid Kleckner314ef7b2014-02-01 00:04:45 +00004061 }
4062
John McCallb92ab1a2016-10-26 23:46:34 +00004063 // 2. Prepare the function pointer.
4064
4065 // If the callee is a bitcast of a non-variadic function to have a
4066 // variadic function pointer type, check to see if we can remove the
4067 // bitcast. This comes up with unprototyped functions.
4068 //
4069 // This makes the IR nicer, but more importantly it ensures that we
4070 // can inline the function at -O0 if it is marked always_inline.
4071 auto simplifyVariadicCallee = [](llvm::Value *Ptr) -> llvm::Value* {
4072 llvm::FunctionType *CalleeFT =
4073 cast<llvm::FunctionType>(Ptr->getType()->getPointerElementType());
4074 if (!CalleeFT->isVarArg())
4075 return Ptr;
4076
4077 llvm::ConstantExpr *CE = dyn_cast<llvm::ConstantExpr>(Ptr);
4078 if (!CE || CE->getOpcode() != llvm::Instruction::BitCast)
4079 return Ptr;
4080
4081 llvm::Function *OrigFn = dyn_cast<llvm::Function>(CE->getOperand(0));
4082 if (!OrigFn)
4083 return Ptr;
4084
4085 llvm::FunctionType *OrigFT = OrigFn->getFunctionType();
4086
4087 // If the original type is variadic, or if any of the component types
4088 // disagree, we cannot remove the cast.
4089 if (OrigFT->isVarArg() ||
4090 OrigFT->getNumParams() != CalleeFT->getNumParams() ||
4091 OrigFT->getReturnType() != CalleeFT->getReturnType())
4092 return Ptr;
4093
4094 for (unsigned i = 0, e = OrigFT->getNumParams(); i != e; ++i)
4095 if (OrigFT->getParamType(i) != CalleeFT->getParamType(i))
4096 return Ptr;
4097
4098 return OrigFn;
4099 };
4100 CalleePtr = simplifyVariadicCallee(CalleePtr);
4101
4102 // 3. Perform the actual call.
4103
4104 // Deactivate any cleanups that we're supposed to do immediately before
4105 // the call.
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00004106 if (!CallArgs.getCleanupsToDeactivate().empty())
4107 deactivateArgCleanupsBeforeCall(*this, CallArgs);
4108
John McCallb92ab1a2016-10-26 23:46:34 +00004109 // Assert that the arguments we computed match up. The IR verifier
4110 // will catch this, but this is a common enough source of problems
4111 // during IRGen changes that it's way better for debugging to catch
4112 // it ourselves here.
4113#ifndef NDEBUG
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004114 assert(IRCallArgs.size() == IRFuncTy->getNumParams() || IRFuncTy->isVarArg());
4115 for (unsigned i = 0; i < IRCallArgs.size(); ++i) {
4116 // Inalloca argument can have different type.
4117 if (IRFunctionArgs.hasInallocaArg() &&
4118 i == IRFunctionArgs.getInallocaArgNo())
4119 continue;
4120 if (i < IRFuncTy->getNumParams())
4121 assert(IRCallArgs[i]->getType() == IRFuncTy->getParamType(i));
4122 }
John McCallb92ab1a2016-10-26 23:46:34 +00004123#endif
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004124
John McCallb92ab1a2016-10-26 23:46:34 +00004125 // Compute the calling convention and attributes.
Daniel Dunbar0ef34792009-09-12 00:59:20 +00004126 unsigned CallingConv;
Reid Klecknercdd26792017-04-18 23:50:03 +00004127 llvm::AttributeList Attrs;
John McCallb92ab1a2016-10-26 23:46:34 +00004128 CGM.ConstructAttributeList(CalleePtr->getName(), CallInfo,
Reid Klecknercdd26792017-04-18 23:50:03 +00004129 Callee.getAbstractInfo(), Attrs, CallingConv,
Chad Rosier7dbc9cf2016-01-06 14:35:46 +00004130 /*AttrOnCallSite=*/true);
Mike Stump11289f42009-09-09 15:08:12 +00004131
John McCallb92ab1a2016-10-26 23:46:34 +00004132 // Apply some call-site-specific attributes.
4133 // TODO: work this into building the attribute set.
4134
4135 // Apply always_inline to all calls within flatten functions.
4136 // FIXME: should this really take priority over __try, below?
4137 if (CurCodeDecl && CurCodeDecl->hasAttr<FlattenAttr>() &&
4138 !(Callee.getAbstractInfo().getCalleeDecl() &&
4139 Callee.getAbstractInfo().getCalleeDecl()->hasAttr<NoInlineAttr>())) {
4140 Attrs =
Reid Klecknerde864822017-03-21 16:57:30 +00004141 Attrs.addAttribute(getLLVMContext(), llvm::AttributeList::FunctionIndex,
John McCallb92ab1a2016-10-26 23:46:34 +00004142 llvm::Attribute::AlwaysInline);
4143 }
4144
4145 // Disable inlining inside SEH __try blocks.
4146 if (isSEHTryScope()) {
4147 Attrs =
Reid Klecknerde864822017-03-21 16:57:30 +00004148 Attrs.addAttribute(getLLVMContext(), llvm::AttributeList::FunctionIndex,
John McCallb92ab1a2016-10-26 23:46:34 +00004149 llvm::Attribute::NoInline);
4150 }
4151
4152 // Decide whether to use a call or an invoke.
David Majnemer4e52d6f2015-12-12 05:39:21 +00004153 bool CannotThrow;
4154 if (currentFunctionUsesSEHTry()) {
John McCallb92ab1a2016-10-26 23:46:34 +00004155 // SEH cares about asynchronous exceptions, so everything can "throw."
David Majnemer4e52d6f2015-12-12 05:39:21 +00004156 CannotThrow = false;
4157 } else if (isCleanupPadScope() &&
4158 EHPersonality::get(*this).isMSVCXXPersonality()) {
4159 // The MSVC++ personality will implicitly terminate the program if an
John McCallb92ab1a2016-10-26 23:46:34 +00004160 // exception is thrown during a cleanup outside of a try/catch.
4161 // We don't need to model anything in IR to get this behavior.
David Majnemer4e52d6f2015-12-12 05:39:21 +00004162 CannotThrow = true;
4163 } else {
John McCallb92ab1a2016-10-26 23:46:34 +00004164 // Otherwise, nounwind call sites will never throw.
Reid Klecknerde864822017-03-21 16:57:30 +00004165 CannotThrow = Attrs.hasAttribute(llvm::AttributeList::FunctionIndex,
David Majnemer4e52d6f2015-12-12 05:39:21 +00004166 llvm::Attribute::NoUnwind);
4167 }
4168 llvm::BasicBlock *InvokeDest = CannotThrow ? nullptr : getInvokeDest();
John McCallbd309292010-07-06 01:34:17 +00004169
David Majnemer0b17d442015-12-15 21:27:59 +00004170 SmallVector<llvm::OperandBundleDef, 1> BundleList;
John McCallb92ab1a2016-10-26 23:46:34 +00004171 getBundlesForFunclet(CalleePtr, CurrentFuncletPad, BundleList);
David Majnemer0b17d442015-12-15 21:27:59 +00004172
John McCallb92ab1a2016-10-26 23:46:34 +00004173 // Emit the actual call/invoke instruction.
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004174 llvm::CallSite CS;
John McCallbd309292010-07-06 01:34:17 +00004175 if (!InvokeDest) {
John McCallb92ab1a2016-10-26 23:46:34 +00004176 CS = Builder.CreateCall(CalleePtr, IRCallArgs, BundleList);
Daniel Dunbar12347492009-02-23 17:26:39 +00004177 } else {
4178 llvm::BasicBlock *Cont = createBasicBlock("invoke.cont");
John McCallb92ab1a2016-10-26 23:46:34 +00004179 CS = Builder.CreateInvoke(CalleePtr, Cont, InvokeDest, IRCallArgs,
David Majnemer0b17d442015-12-15 21:27:59 +00004180 BundleList);
Daniel Dunbar12347492009-02-23 17:26:39 +00004181 EmitBlock(Cont);
Daniel Dunbar5006f4a2009-02-20 18:54:31 +00004182 }
John McCallb92ab1a2016-10-26 23:46:34 +00004183 llvm::Instruction *CI = CS.getInstruction();
Chris Lattnere70a0072010-06-29 16:40:28 +00004184 if (callOrInvoke)
John McCallb92ab1a2016-10-26 23:46:34 +00004185 *callOrInvoke = CI;
Daniel Dunbar5006f4a2009-02-20 18:54:31 +00004186
John McCallb92ab1a2016-10-26 23:46:34 +00004187 // Apply the attributes and calling convention.
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004188 CS.setAttributes(Attrs);
Daniel Dunbar0ef34792009-09-12 00:59:20 +00004189 CS.setCallingConv(static_cast<llvm::CallingConv::ID>(CallingConv));
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004190
John McCallb92ab1a2016-10-26 23:46:34 +00004191 // Apply various metadata.
4192
4193 if (!CI->getType()->isVoidTy())
4194 CI->setName("call");
4195
Adam Nemet1e217bc2016-03-28 22:18:53 +00004196 // Insert instrumentation or attach profile metadata at indirect call sites.
4197 // For more details, see the comment before the definition of
4198 // IPVK_IndirectCallTarget in InstrProfData.inc.
Betul Buyukkurt518276a2016-01-23 22:50:44 +00004199 if (!CS.getCalledFunction())
4200 PGO.valueProfile(Builder, llvm::IPVK_IndirectCallTarget,
John McCallb92ab1a2016-10-26 23:46:34 +00004201 CI, CalleePtr);
Betul Buyukkurt518276a2016-01-23 22:50:44 +00004202
Dan Gohman515a60d2012-02-16 00:57:37 +00004203 // In ObjC ARC mode with no ObjC ARC exception safety, tell the ARC
4204 // optimizer it can aggressively ignore unwind edges.
David Blaikiebbafb8a2012-03-11 07:00:24 +00004205 if (CGM.getLangOpts().ObjCAutoRefCount)
John McCallb92ab1a2016-10-26 23:46:34 +00004206 AddObjCARCExceptionMetadata(CI);
4207
4208 // Suppress tail calls if requested.
4209 if (llvm::CallInst *Call = dyn_cast<llvm::CallInst>(CI)) {
4210 const Decl *TargetDecl = Callee.getAbstractInfo().getCalleeDecl();
4211 if (TargetDecl && TargetDecl->hasAttr<NotTailCalledAttr>())
4212 Call->setTailCallKind(llvm::CallInst::TCK_NoTail);
4213 }
4214
4215 // 4. Finish the call.
Dan Gohman515a60d2012-02-16 00:57:37 +00004216
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004217 // If the call doesn't return, finish the basic block and clear the
John McCallb92ab1a2016-10-26 23:46:34 +00004218 // insertion point; this allows the rest of IRGen to discard
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004219 // unreachable code.
4220 if (CS.doesNotReturn()) {
Leny Kholodov6aab1112015-06-08 10:23:49 +00004221 if (UnusedReturnSize)
4222 EmitLifetimeEnd(llvm::ConstantInt::get(Int64Ty, UnusedReturnSize),
John McCall7f416cc2015-09-08 08:05:57 +00004223 SRetPtr.getPointer());
Leny Kholodov6aab1112015-06-08 10:23:49 +00004224
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004225 Builder.CreateUnreachable();
4226 Builder.ClearInsertionPoint();
Mike Stump11289f42009-09-09 15:08:12 +00004227
Mike Stump18bb9282009-05-16 07:57:57 +00004228 // FIXME: For now, emit a dummy basic block because expr emitters in
4229 // generally are not ready to handle emitting expressions at unreachable
4230 // points.
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004231 EnsureInsertPoint();
Mike Stump11289f42009-09-09 15:08:12 +00004232
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004233 // Return a reasonable RValue.
4234 return GetUndefRValue(RetTy);
Mike Stump11289f42009-09-09 15:08:12 +00004235 }
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004236
John McCall12f23522016-04-04 18:33:08 +00004237 // Perform the swifterror writeback.
4238 if (swiftErrorTemp.isValid()) {
4239 llvm::Value *errorResult = Builder.CreateLoad(swiftErrorTemp);
4240 Builder.CreateStore(errorResult, swiftErrorArg);
4241 }
4242
John McCallb92ab1a2016-10-26 23:46:34 +00004243 // Emit any call-associated writebacks immediately. Arguably this
4244 // should happen after any return-value munging.
John McCall31168b02011-06-15 23:02:42 +00004245 if (CallArgs.hasWritebacks())
4246 emitWritebacks(*this, CallArgs);
4247
Nico Weber8cdb3f92015-08-25 18:43:32 +00004248 // The stack cleanup for inalloca arguments has to run out of the normal
4249 // lexical order, so deactivate it and run it manually here.
4250 CallArgs.freeArgumentMemory(*this);
4251
John McCallb92ab1a2016-10-26 23:46:34 +00004252 // Extract the return value.
Hal Finkelee90a222014-09-26 05:04:30 +00004253 RValue Ret = [&] {
4254 switch (RetAI.getKind()) {
John McCallf26e73d2016-03-11 04:30:43 +00004255 case ABIArgInfo::CoerceAndExpand: {
4256 auto coercionType = RetAI.getCoerceAndExpandType();
4257 auto layout = CGM.getDataLayout().getStructLayout(coercionType);
4258
4259 Address addr = SRetPtr;
4260 addr = Builder.CreateElementBitCast(addr, coercionType);
4261
John McCall12f23522016-04-04 18:33:08 +00004262 assert(CI->getType() == RetAI.getUnpaddedCoerceAndExpandType());
4263 bool requiresExtract = isa<llvm::StructType>(CI->getType());
4264
John McCallf26e73d2016-03-11 04:30:43 +00004265 unsigned unpaddedIndex = 0;
4266 for (unsigned i = 0, e = coercionType->getNumElements(); i != e; ++i) {
4267 llvm::Type *eltType = coercionType->getElementType(i);
4268 if (ABIArgInfo::isPaddingForCoerceAndExpand(eltType)) continue;
4269 Address eltAddr = Builder.CreateStructGEP(addr, i, layout);
John McCall12f23522016-04-04 18:33:08 +00004270 llvm::Value *elt = CI;
4271 if (requiresExtract)
4272 elt = Builder.CreateExtractValue(elt, unpaddedIndex++);
4273 else
4274 assert(unpaddedIndex == 0);
John McCallf26e73d2016-03-11 04:30:43 +00004275 Builder.CreateStore(elt, eltAddr);
4276 }
John McCall12f23522016-04-04 18:33:08 +00004277 // FALLTHROUGH
Galina Kistanova0872d6c2017-06-03 06:30:46 +00004278 LLVM_FALLTHROUGH;
John McCall12f23522016-04-04 18:33:08 +00004279 }
4280
4281 case ABIArgInfo::InAlloca:
4282 case ABIArgInfo::Indirect: {
4283 RValue ret = convertTempToRValue(SRetPtr, RetTy, SourceLocation());
4284 if (UnusedReturnSize)
4285 EmitLifetimeEnd(llvm::ConstantInt::get(Int64Ty, UnusedReturnSize),
4286 SRetPtr.getPointer());
4287 return ret;
John McCallf26e73d2016-03-11 04:30:43 +00004288 }
4289
Hal Finkelee90a222014-09-26 05:04:30 +00004290 case ABIArgInfo::Ignore:
4291 // If we are ignoring an argument that had a result, make sure to
4292 // construct the appropriate return value for our caller.
4293 return GetUndefRValue(RetTy);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004294
Hal Finkelee90a222014-09-26 05:04:30 +00004295 case ABIArgInfo::Extend:
4296 case ABIArgInfo::Direct: {
4297 llvm::Type *RetIRTy = ConvertType(RetTy);
4298 if (RetAI.getCoerceToType() == RetIRTy && RetAI.getDirectOffset() == 0) {
4299 switch (getEvaluationKind(RetTy)) {
4300 case TEK_Complex: {
4301 llvm::Value *Real = Builder.CreateExtractValue(CI, 0);
4302 llvm::Value *Imag = Builder.CreateExtractValue(CI, 1);
4303 return RValue::getComplex(std::make_pair(Real, Imag));
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00004304 }
Hal Finkelee90a222014-09-26 05:04:30 +00004305 case TEK_Aggregate: {
John McCall7f416cc2015-09-08 08:05:57 +00004306 Address DestPtr = ReturnValue.getValue();
Hal Finkelee90a222014-09-26 05:04:30 +00004307 bool DestIsVolatile = ReturnValue.isVolatile();
4308
John McCall7f416cc2015-09-08 08:05:57 +00004309 if (!DestPtr.isValid()) {
Hal Finkelee90a222014-09-26 05:04:30 +00004310 DestPtr = CreateMemTemp(RetTy, "agg.tmp");
4311 DestIsVolatile = false;
4312 }
John McCall7f416cc2015-09-08 08:05:57 +00004313 BuildAggStore(*this, CI, DestPtr, DestIsVolatile);
Hal Finkelee90a222014-09-26 05:04:30 +00004314 return RValue::getAggregate(DestPtr);
4315 }
4316 case TEK_Scalar: {
4317 // If the argument doesn't match, perform a bitcast to coerce it. This
4318 // can happen due to trivial type mismatches.
4319 llvm::Value *V = CI;
4320 if (V->getType() != RetIRTy)
4321 V = Builder.CreateBitCast(V, RetIRTy);
4322 return RValue::get(V);
4323 }
4324 }
4325 llvm_unreachable("bad evaluation kind");
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00004326 }
Hal Finkelee90a222014-09-26 05:04:30 +00004327
John McCall7f416cc2015-09-08 08:05:57 +00004328 Address DestPtr = ReturnValue.getValue();
Hal Finkelee90a222014-09-26 05:04:30 +00004329 bool DestIsVolatile = ReturnValue.isVolatile();
4330
John McCall7f416cc2015-09-08 08:05:57 +00004331 if (!DestPtr.isValid()) {
Hal Finkelee90a222014-09-26 05:04:30 +00004332 DestPtr = CreateMemTemp(RetTy, "coerce");
4333 DestIsVolatile = false;
John McCall47fb9502013-03-07 21:37:08 +00004334 }
Hal Finkelee90a222014-09-26 05:04:30 +00004335
4336 // If the value is offset in memory, apply the offset now.
John McCall7f416cc2015-09-08 08:05:57 +00004337 Address StorePtr = emitAddressAtOffset(*this, DestPtr, RetAI);
4338 CreateCoercedStore(CI, StorePtr, DestIsVolatile, *this);
Hal Finkelee90a222014-09-26 05:04:30 +00004339
4340 return convertTempToRValue(DestPtr, RetTy, SourceLocation());
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00004341 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004342
Hal Finkelee90a222014-09-26 05:04:30 +00004343 case ABIArgInfo::Expand:
4344 llvm_unreachable("Invalid ABI kind for return argument");
Anders Carlsson17490832009-12-24 20:40:36 +00004345 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004346
Hal Finkelee90a222014-09-26 05:04:30 +00004347 llvm_unreachable("Unhandled ABIArgInfo::Kind");
4348 } ();
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004349
John McCallb92ab1a2016-10-26 23:46:34 +00004350 // Emit the assume_aligned check on the return value.
4351 const Decl *TargetDecl = Callee.getAbstractInfo().getCalleeDecl();
Hal Finkelee90a222014-09-26 05:04:30 +00004352 if (Ret.isScalar() && TargetDecl) {
4353 if (const auto *AA = TargetDecl->getAttr<AssumeAlignedAttr>()) {
4354 llvm::Value *OffsetValue = nullptr;
4355 if (const auto *Offset = AA->getOffset())
4356 OffsetValue = EmitScalarExpr(Offset);
4357
4358 llvm::Value *Alignment = EmitScalarExpr(AA->getAlignment());
4359 llvm::ConstantInt *AlignmentCI = cast<llvm::ConstantInt>(Alignment);
4360 EmitAlignmentAssumption(Ret.getScalarVal(), AlignmentCI->getZExtValue(),
4361 OffsetValue);
Erich Keane623efd82017-03-30 21:48:55 +00004362 } else if (const auto *AA = TargetDecl->getAttr<AllocAlignAttr>()) {
4363 llvm::Value *ParamVal =
4364 CallArgs[AA->getParamIndex() - 1].RV.getScalarVal();
4365 EmitAlignmentAssumption(Ret.getScalarVal(), ParamVal);
Hal Finkelee90a222014-09-26 05:04:30 +00004366 }
Daniel Dunbar573884e2008-09-10 07:04:09 +00004367 }
Daniel Dunbard3674e62008-09-11 01:48:57 +00004368
Hal Finkelee90a222014-09-26 05:04:30 +00004369 return Ret;
Daniel Dunbar613855c2008-09-09 23:27:19 +00004370}
Daniel Dunbar2d0746f2009-02-10 20:44:09 +00004371
4372/* VarArg handling */
4373
Charles Davisc7d5c942015-09-17 20:55:33 +00004374Address CodeGenFunction::EmitVAArg(VAArgExpr *VE, Address &VAListAddr) {
4375 VAListAddr = VE->isMicrosoftABI()
4376 ? EmitMSVAListRef(VE->getSubExpr())
4377 : EmitVAListRef(VE->getSubExpr());
4378 QualType Ty = VE->getType();
4379 if (VE->isMicrosoftABI())
4380 return CGM.getTypes().getABIInfo().EmitMSVAArg(*this, VAListAddr, Ty);
John McCall7f416cc2015-09-08 08:05:57 +00004381 return CGM.getTypes().getABIInfo().EmitVAArg(*this, VAListAddr, Ty);
Daniel Dunbar2d0746f2009-02-10 20:44:09 +00004382}