blob: 64e18e171e01931ef9a45715377743cd2b32bf43 [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"
Richard Trieu63688182018-12-11 03:18:39 +000026#include "clang/Basic/CodeGenOptions.h"
Eric Christopher15709992015-10-15 23:47:11 +000027#include "clang/Basic/TargetBuiltins.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000028#include "clang/Basic/TargetInfo.h"
Mark Laceya8e7df32013-10-30 21:53:58 +000029#include "clang/CodeGen/CGFunctionInfo.h"
John McCall12f23522016-04-04 18:33:08 +000030#include "clang/CodeGen/SwiftCallingConv.h"
Bill Wendling706469b2013-02-28 22:49:57 +000031#include "llvm/ADT/StringExtras.h"
David Blaikie181a6132018-06-04 21:23:29 +000032#include "llvm/Transforms/Utils/Local.h"
Nick Lewyckyd9bce502016-09-20 15:49:58 +000033#include "llvm/Analysis/ValueTracking.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000034#include "llvm/IR/Attributes.h"
Chandler Carruthc80ceea2014-03-04 11:02:08 +000035#include "llvm/IR/CallSite.h"
David Blaikief47ca252018-03-21 22:34:27 +000036#include "llvm/IR/CallingConv.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000037#include "llvm/IR/DataLayout.h"
38#include "llvm/IR/InlineAsm.h"
Saleem Abdulrasool10a49722016-04-08 16:52:00 +000039#include "llvm/IR/IntrinsicInst.h"
David Blaikief47ca252018-03-21 22:34:27 +000040#include "llvm/IR/Intrinsics.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;
Sander de Smalen44a22532018-11-26 16:38:37 +000062 case CC_AArch64VectorCall: return llvm::CallingConv::AArch64_VectorCall;
Alexander Kornienko21de0ae2015-01-20 11:20:41 +000063 case CC_SpirFunction: return llvm::CallingConv::SPIR_FUNC;
Nikolay Haustov8c6538b2016-06-30 09:06:33 +000064 case CC_OpenCLKernel: return CGM.getTargetCodeGenInfo().getOpenCLKernelCallingConv();
Roman Levenstein35aa5ce2016-03-16 18:00:46 +000065 case CC_PreserveMost: return llvm::CallingConv::PreserveMost;
66 case CC_PreserveAll: return llvm::CallingConv::PreserveAll;
John McCall12f23522016-04-04 18:33:08 +000067 case CC_Swift: return llvm::CallingConv::Swift;
John McCallab26cfa2010-02-05 21:31:56 +000068 }
69}
70
Mikael Nilsson9d2872d2018-12-13 10:15:27 +000071/// Derives the 'this' type for codegen purposes, i.e. ignoring method CVR
John McCall8ee376f2010-02-24 07:14:12 +000072/// qualification.
Mikael Nilsson9d2872d2018-12-13 10:15:27 +000073static CanQualType GetThisType(ASTContext &Context, const CXXRecordDecl *RD,
74 const CXXMethodDecl *MD) {
John McCall2da83a32010-02-26 00:48:12 +000075 QualType RecTy = Context.getTagDeclType(RD)->getCanonicalTypeInternal();
Mikael Nilsson9d2872d2018-12-13 10:15:27 +000076 if (MD)
77 RecTy = Context.getAddrSpaceQualType(RecTy, MD->getType().getAddressSpace());
John McCall2da83a32010-02-26 00:48:12 +000078 return Context.getPointerType(CanQualType::CreateUnsafe(RecTy));
Daniel Dunbar7a95ca32008-09-10 04:01:49 +000079}
80
John McCall8ee376f2010-02-24 07:14:12 +000081/// Returns the canonical formal type of the given C++ method.
John McCall2da83a32010-02-26 00:48:12 +000082static CanQual<FunctionProtoType> GetFormalType(const CXXMethodDecl *MD) {
83 return MD->getType()->getCanonicalTypeUnqualified()
84 .getAs<FunctionProtoType>();
John McCall8ee376f2010-02-24 07:14:12 +000085}
86
87/// Returns the "extra-canonicalized" return type, which discards
88/// qualifiers on the return type. Codegen doesn't care about them,
89/// and it makes ABI code a little easier to be able to assume that
90/// all parameter and return types are top-level unqualified.
John McCall2da83a32010-02-26 00:48:12 +000091static CanQualType GetReturnType(QualType RetTy) {
92 return RetTy->getCanonicalTypeUnqualified().getUnqualifiedType();
John McCall8ee376f2010-02-24 07:14:12 +000093}
94
John McCall8dda7b22012-07-07 06:41:13 +000095/// Arrange the argument and result information for a value of the given
96/// unprototyped freestanding function type.
John McCall8ee376f2010-02-24 07:14:12 +000097const CGFunctionInfo &
John McCall8dda7b22012-07-07 06:41:13 +000098CodeGenTypes::arrangeFreeFunctionType(CanQual<FunctionNoProtoType> FTNP) {
John McCalla729c622012-02-17 03:33:10 +000099 // When translating an unprototyped function type, always use a
100 // variadic type.
Alp Toker314cc812014-01-25 16:55:45 +0000101 return arrangeLLVMFunctionInfo(FTNP->getReturnType().getUnqualifiedType(),
Peter Collingbournef7706832014-12-12 23:41:25 +0000102 /*instanceMethod=*/false,
103 /*chainCall=*/false, None,
John McCallc56a8b32016-03-11 04:30:31 +0000104 FTNP->getExtInfo(), {}, RequiredArgs(0));
John McCall8ee376f2010-02-24 07:14:12 +0000105}
106
George Burgess IVb7760212017-02-24 02:49:47 +0000107static void addExtParameterInfosForCall(
108 llvm::SmallVectorImpl<FunctionProtoType::ExtParameterInfo> &paramInfos,
109 const FunctionProtoType *proto,
110 unsigned prefixArgs,
111 unsigned totalArgs) {
112 assert(proto->hasExtParameterInfos());
113 assert(paramInfos.size() <= prefixArgs);
114 assert(proto->getNumParams() + prefixArgs <= totalArgs);
115
116 paramInfos.reserve(totalArgs);
117
118 // Add default infos for any prefix args that don't already have infos.
119 paramInfos.resize(prefixArgs);
120
121 // Add infos for the prototype.
122 for (const auto &ParamInfo : proto->getExtParameterInfos()) {
123 paramInfos.push_back(ParamInfo);
124 // pass_object_size params have no parameter info.
125 if (ParamInfo.hasPassObjectSize())
126 paramInfos.emplace_back();
127 }
128
129 assert(paramInfos.size() <= totalArgs &&
130 "Did we forget to insert pass_object_size args?");
131 // Add default infos for the variadic and/or suffix arguments.
132 paramInfos.resize(totalArgs);
133}
134
Hiroshi Inouec5e54dd2017-07-03 08:49:44 +0000135/// Adds the formal parameters in FPT to the given prefix. If any parameter in
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000136/// FPT has pass_object_size attrs, then we'll add parameters for those, too.
137static void appendParameterTypes(const CodeGenTypes &CGT,
138 SmallVectorImpl<CanQualType> &prefix,
John McCallc56a8b32016-03-11 04:30:31 +0000139 SmallVectorImpl<FunctionProtoType::ExtParameterInfo> &paramInfos,
George Burgess IVb7760212017-02-24 02:49:47 +0000140 CanQual<FunctionProtoType> FPT) {
141 // Fast path: don't touch param info if we don't need to.
142 if (!FPT->hasExtParameterInfos()) {
143 assert(paramInfos.empty() &&
144 "We have paramInfos, but the prototype doesn't?");
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000145 prefix.append(FPT->param_type_begin(), FPT->param_type_end());
146 return;
147 }
148
George Burgess IVb7760212017-02-24 02:49:47 +0000149 unsigned PrefixSize = prefix.size();
150 // In the vast majority of cases, we'll have precisely FPT->getNumParams()
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000151 // parameters; the only thing that can change this is the presence of
152 // pass_object_size. So, we preallocate for the common case.
153 prefix.reserve(prefix.size() + FPT->getNumParams());
154
George Burgess IVb7760212017-02-24 02:49:47 +0000155 auto ExtInfos = FPT->getExtParameterInfos();
156 assert(ExtInfos.size() == FPT->getNumParams());
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000157 for (unsigned I = 0, E = FPT->getNumParams(); I != E; ++I) {
158 prefix.push_back(FPT->getParamType(I));
George Burgess IVb7760212017-02-24 02:49:47 +0000159 if (ExtInfos[I].hasPassObjectSize())
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000160 prefix.push_back(CGT.getContext().getSizeType());
161 }
George Burgess IVb7760212017-02-24 02:49:47 +0000162
163 addExtParameterInfosForCall(paramInfos, FPT.getTypePtr(), PrefixSize,
164 prefix.size());
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000165}
166
John McCall8dda7b22012-07-07 06:41:13 +0000167/// Arrange the LLVM function layout for a value of the given function
Alexey Samsonove5ef3ca2014-08-13 23:55:54 +0000168/// type, on top of any implicit parameters already stored.
169static const CGFunctionInfo &
Peter Collingbournef7706832014-12-12 23:41:25 +0000170arrangeLLVMFunctionInfo(CodeGenTypes &CGT, bool instanceMethod,
Alexey Samsonove5ef3ca2014-08-13 23:55:54 +0000171 SmallVectorImpl<CanQualType> &prefix,
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000172 CanQual<FunctionProtoType> FTP,
173 const FunctionDecl *FD) {
John McCallc56a8b32016-03-11 04:30:31 +0000174 SmallVector<FunctionProtoType::ExtParameterInfo, 16> paramInfos;
George Burgess IV419996c2016-06-16 23:06:04 +0000175 RequiredArgs Required =
176 RequiredArgs::forPrototypePlus(FTP, prefix.size(), FD);
Daniel Dunbarbf8c24a2009-02-02 23:23:47 +0000177 // FIXME: Kill copy.
George Burgess IVb7760212017-02-24 02:49:47 +0000178 appendParameterTypes(CGT, prefix, paramInfos, FTP);
Alp Toker314cc812014-01-25 16:55:45 +0000179 CanQualType resultType = FTP->getReturnType().getUnqualifiedType();
John McCallc56a8b32016-03-11 04:30:31 +0000180
Peter Collingbournef7706832014-12-12 23:41:25 +0000181 return CGT.arrangeLLVMFunctionInfo(resultType, instanceMethod,
182 /*chainCall=*/false, prefix,
John McCallc56a8b32016-03-11 04:30:31 +0000183 FTP->getExtInfo(), paramInfos,
George Burgess IV419996c2016-06-16 23:06:04 +0000184 Required);
John McCall8ee376f2010-02-24 07:14:12 +0000185}
186
John McCalla729c622012-02-17 03:33:10 +0000187/// Arrange the argument and result information for a value of the
John McCall8dda7b22012-07-07 06:41:13 +0000188/// given freestanding function type.
John McCall8ee376f2010-02-24 07:14:12 +0000189const CGFunctionInfo &
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000190CodeGenTypes::arrangeFreeFunctionType(CanQual<FunctionProtoType> FTP,
191 const FunctionDecl *FD) {
John McCalla729c622012-02-17 03:33:10 +0000192 SmallVector<CanQualType, 16> argTypes;
Peter Collingbournef7706832014-12-12 23:41:25 +0000193 return ::arrangeLLVMFunctionInfo(*this, /*instanceMethod=*/false, argTypes,
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000194 FTP, FD);
Daniel Dunbar7feafc72009-09-11 22:24:53 +0000195}
196
Aaron Ballman0362a6d2013-12-18 16:23:37 +0000197static CallingConv getCallingConventionForDecl(const Decl *D, bool IsWindows) {
Daniel Dunbar7feafc72009-09-11 22:24:53 +0000198 // Set the appropriate calling convention for the Function.
199 if (D->hasAttr<StdCallAttr>())
John McCallab26cfa2010-02-05 21:31:56 +0000200 return CC_X86StdCall;
Daniel Dunbar7feafc72009-09-11 22:24:53 +0000201
202 if (D->hasAttr<FastCallAttr>())
John McCallab26cfa2010-02-05 21:31:56 +0000203 return CC_X86FastCall;
Daniel Dunbar7feafc72009-09-11 22:24:53 +0000204
Erich Keane757d3172016-11-02 18:29:35 +0000205 if (D->hasAttr<RegCallAttr>())
206 return CC_X86RegCall;
207
Douglas Gregora941dca2010-05-18 16:57:00 +0000208 if (D->hasAttr<ThisCallAttr>())
209 return CC_X86ThisCall;
210
Reid Klecknerd7857f02014-10-24 17:42:17 +0000211 if (D->hasAttr<VectorCallAttr>())
212 return CC_X86VectorCall;
213
Dawn Perchik335e16b2010-09-03 01:29:35 +0000214 if (D->hasAttr<PascalAttr>())
215 return CC_X86Pascal;
216
Anton Korobeynikov231e8752011-04-14 20:06:49 +0000217 if (PcsAttr *PCS = D->getAttr<PcsAttr>())
218 return (PCS->getPCS() == PcsAttr::AAPCS ? CC_AAPCS : CC_AAPCS_VFP);
219
Sander de Smalen44a22532018-11-26 16:38:37 +0000220 if (D->hasAttr<AArch64VectorPcsAttr>())
221 return CC_AArch64VectorCall;
222
Guy Benyeif0a014b2012-12-25 08:53:55 +0000223 if (D->hasAttr<IntelOclBiccAttr>())
224 return CC_IntelOclBicc;
225
Aaron Ballman0362a6d2013-12-18 16:23:37 +0000226 if (D->hasAttr<MSABIAttr>())
Martin Storsjo022e7822017-07-17 20:49:45 +0000227 return IsWindows ? CC_C : CC_Win64;
Aaron Ballman0362a6d2013-12-18 16:23:37 +0000228
229 if (D->hasAttr<SysVABIAttr>())
230 return IsWindows ? CC_X86_64SysV : CC_C;
231
Roman Levenstein35aa5ce2016-03-16 18:00:46 +0000232 if (D->hasAttr<PreserveMostAttr>())
233 return CC_PreserveMost;
234
235 if (D->hasAttr<PreserveAllAttr>())
236 return CC_PreserveAll;
237
John McCallab26cfa2010-02-05 21:31:56 +0000238 return CC_C;
Daniel Dunbar7a95ca32008-09-10 04:01:49 +0000239}
240
John McCalla729c622012-02-17 03:33:10 +0000241/// Arrange the argument and result information for a call to an
242/// unknown C++ non-static member function of the given abstract type.
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000243/// (Zero value of RD means we don't have any meaningful "this" argument type,
244/// so fall back to a generic pointer type).
John McCalla729c622012-02-17 03:33:10 +0000245/// The member function must be an ordinary function, i.e. not a
246/// constructor or destructor.
247const CGFunctionInfo &
248CodeGenTypes::arrangeCXXMethodType(const CXXRecordDecl *RD,
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000249 const FunctionProtoType *FTP,
250 const CXXMethodDecl *MD) {
John McCalla729c622012-02-17 03:33:10 +0000251 SmallVector<CanQualType, 16> argTypes;
John McCall8ee376f2010-02-24 07:14:12 +0000252
Anders Carlsson2ee3c012009-10-03 19:43:08 +0000253 // Add the 'this' pointer.
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000254 if (RD)
Mikael Nilsson9d2872d2018-12-13 10:15:27 +0000255 argTypes.push_back(GetThisType(Context, RD, MD));
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000256 else
257 argTypes.push_back(Context.VoidPtrTy);
John McCall8ee376f2010-02-24 07:14:12 +0000258
Alexey Samsonove5ef3ca2014-08-13 23:55:54 +0000259 return ::arrangeLLVMFunctionInfo(
260 *this, true, argTypes,
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000261 FTP->getCanonicalTypeUnqualified().getAs<FunctionProtoType>(), MD);
Anders Carlsson2ee3c012009-10-03 19:43:08 +0000262}
263
Yaxun Liu6c10a662018-06-12 00:16:33 +0000264/// Set calling convention for CUDA/HIP kernel.
265static void setCUDAKernelCallingConvention(CanQualType &FTy, CodeGenModule &CGM,
266 const FunctionDecl *FD) {
267 if (FD->hasAttr<CUDAGlobalAttr>()) {
268 const FunctionType *FT = FTy->getAs<FunctionType>();
269 CGM.getTargetCodeGenInfo().setCUDAKernelCallingConvention(FT);
270 FTy = FT->getCanonicalTypeUnqualified();
271 }
272}
273
John McCalla729c622012-02-17 03:33:10 +0000274/// Arrange the argument and result information for a declaration or
275/// definition of the given C++ non-static member function. The
276/// member function must be an ordinary function, i.e. not a
277/// constructor or destructor.
278const CGFunctionInfo &
279CodeGenTypes::arrangeCXXMethodDeclaration(const CXXMethodDecl *MD) {
Benjamin Kramer60509af2013-09-09 14:48:42 +0000280 assert(!isa<CXXConstructorDecl>(MD) && "wrong method for constructors!");
John McCall0d635f52010-09-03 01:26:39 +0000281 assert(!isa<CXXDestructorDecl>(MD) && "wrong method for destructors!");
282
Yaxun Liu6c10a662018-06-12 00:16:33 +0000283 CanQualType FT = GetFormalType(MD).getAs<Type>();
284 setCUDAKernelCallingConvention(FT, CGM, MD);
285 auto prototype = FT.getAs<FunctionProtoType>();
Mike Stump11289f42009-09-09 15:08:12 +0000286
John McCalla729c622012-02-17 03:33:10 +0000287 if (MD->isInstance()) {
288 // The abstract case is perfectly fine.
Mark Lacey5ea993b2013-10-02 20:35:23 +0000289 const CXXRecordDecl *ThisType = TheCXXABI.getThisArgumentTypeForMethod(MD);
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000290 return arrangeCXXMethodType(ThisType, prototype.getTypePtr(), MD);
John McCalla729c622012-02-17 03:33:10 +0000291 }
292
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000293 return arrangeFreeFunctionType(prototype, MD);
Anders Carlssonb15b55c2009-04-03 22:48:58 +0000294}
295
Richard Smith5179eb72016-06-28 19:03:57 +0000296bool CodeGenTypes::inheritingCtorHasParams(
297 const InheritedConstructor &Inherited, CXXCtorType Type) {
298 // Parameters are unnecessary if we're constructing a base class subobject
299 // and the inherited constructor lives in a virtual base.
300 return Type == Ctor_Complete ||
301 !Inherited.getShadowDecl()->constructsVirtualBase() ||
302 !Target.getCXXABI().hasConstructorVariants();
303 }
304
John McCalla729c622012-02-17 03:33:10 +0000305const CGFunctionInfo &
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000306CodeGenTypes::arrangeCXXStructorDeclaration(const CXXMethodDecl *MD,
307 StructorType Type) {
308
John McCalla729c622012-02-17 03:33:10 +0000309 SmallVector<CanQualType, 16> argTypes;
John McCallc56a8b32016-03-11 04:30:31 +0000310 SmallVector<FunctionProtoType::ExtParameterInfo, 16> paramInfos;
Mikael Nilsson9d2872d2018-12-13 10:15:27 +0000311 argTypes.push_back(GetThisType(Context, MD->getParent(), MD));
Stephen Lin9dc6eef2013-06-30 20:40:16 +0000312
Richard Smith5179eb72016-06-28 19:03:57 +0000313 bool PassParams = true;
314
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000315 GlobalDecl GD;
316 if (auto *CD = dyn_cast<CXXConstructorDecl>(MD)) {
317 GD = GlobalDecl(CD, toCXXCtorType(Type));
Richard Smith5179eb72016-06-28 19:03:57 +0000318
319 // A base class inheriting constructor doesn't get forwarded arguments
320 // needed to construct a virtual base (or base class thereof).
321 if (auto Inherited = CD->getInheritedConstructor())
322 PassParams = inheritingCtorHasParams(Inherited, toCXXCtorType(Type));
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000323 } else {
324 auto *DD = dyn_cast<CXXDestructorDecl>(MD);
325 GD = GlobalDecl(DD, toCXXDtorType(Type));
326 }
Anders Carlsson82ba57c2009-11-25 03:15:49 +0000327
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000328 CanQual<FunctionProtoType> FTP = GetFormalType(MD);
John McCall5d865c322010-08-31 07:33:07 +0000329
330 // Add the formal parameters.
Richard Smith5179eb72016-06-28 19:03:57 +0000331 if (PassParams)
George Burgess IVb7760212017-02-24 02:49:47 +0000332 appendParameterTypes(*this, argTypes, paramInfos, FTP);
John McCall5d865c322010-08-31 07:33:07 +0000333
George Burgess IV75b34a92017-02-22 22:38:25 +0000334 CGCXXABI::AddedStructorArgs AddedArgs =
335 TheCXXABI.buildStructorSignature(MD, Type, argTypes);
336 if (!paramInfos.empty()) {
337 // Note: prefix implies after the first param.
338 if (AddedArgs.Prefix)
339 paramInfos.insert(paramInfos.begin() + 1, AddedArgs.Prefix,
340 FunctionProtoType::ExtParameterInfo{});
341 if (AddedArgs.Suffix)
342 paramInfos.append(AddedArgs.Suffix,
343 FunctionProtoType::ExtParameterInfo{});
344 }
Reid Kleckner89077a12013-12-17 19:46:40 +0000345
346 RequiredArgs required =
Richard Smith5179eb72016-06-28 19:03:57 +0000347 (PassParams && MD->isVariadic() ? RequiredArgs(argTypes.size())
348 : RequiredArgs::All);
Reid Kleckner89077a12013-12-17 19:46:40 +0000349
John McCall8dda7b22012-07-07 06:41:13 +0000350 FunctionType::ExtInfo extInfo = FTP->getExtInfo();
David Majnemer0c0b6d92014-10-31 20:09:12 +0000351 CanQualType resultType = TheCXXABI.HasThisReturn(GD)
352 ? argTypes.front()
353 : TheCXXABI.hasMostDerivedReturn(GD)
354 ? CGM.getContext().VoidPtrTy
355 : Context.VoidTy;
Peter Collingbournef7706832014-12-12 23:41:25 +0000356 return arrangeLLVMFunctionInfo(resultType, /*instanceMethod=*/true,
357 /*chainCall=*/false, argTypes, extInfo,
John McCallc56a8b32016-03-11 04:30:31 +0000358 paramInfos, required);
359}
360
361static SmallVector<CanQualType, 16>
362getArgTypesForCall(ASTContext &ctx, const CallArgList &args) {
363 SmallVector<CanQualType, 16> argTypes;
364 for (auto &arg : args)
365 argTypes.push_back(ctx.getCanonicalParamType(arg.Ty));
366 return argTypes;
367}
368
369static SmallVector<CanQualType, 16>
370getArgTypesForDeclaration(ASTContext &ctx, const FunctionArgList &args) {
371 SmallVector<CanQualType, 16> argTypes;
372 for (auto &arg : args)
373 argTypes.push_back(ctx.getCanonicalParamType(arg->getType()));
374 return argTypes;
375}
376
John McCallc56a8b32016-03-11 04:30:31 +0000377static llvm::SmallVector<FunctionProtoType::ExtParameterInfo, 16>
378getExtParameterInfosForCall(const FunctionProtoType *proto,
379 unsigned prefixArgs, unsigned totalArgs) {
380 llvm::SmallVector<FunctionProtoType::ExtParameterInfo, 16> result;
381 if (proto->hasExtParameterInfos()) {
382 addExtParameterInfosForCall(result, proto, prefixArgs, totalArgs);
383 }
384 return result;
Anders Carlsson82ba57c2009-11-25 03:15:49 +0000385}
386
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000387/// Arrange a call to a C++ method, passing the given arguments.
George Burgess IVd0a9e802017-02-23 22:07:35 +0000388///
389/// ExtraPrefixArgs is the number of ABI-specific args passed after the `this`
390/// parameter.
391/// ExtraSuffixArgs is the number of ABI-specific args passed at the end of
392/// args.
393/// PassProtoArgs indicates whether `args` has args for the parameters in the
394/// given CXXConstructorDecl.
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000395const CGFunctionInfo &
396CodeGenTypes::arrangeCXXConstructorCall(const CallArgList &args,
397 const CXXConstructorDecl *D,
398 CXXCtorType CtorKind,
George Burgess IVd0a9e802017-02-23 22:07:35 +0000399 unsigned ExtraPrefixArgs,
400 unsigned ExtraSuffixArgs,
401 bool PassProtoArgs) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000402 // FIXME: Kill copy.
403 SmallVector<CanQualType, 16> ArgTypes;
Alexey Samsonov3551e312014-08-13 20:06:24 +0000404 for (const auto &Arg : args)
405 ArgTypes.push_back(Context.getCanonicalParamType(Arg.Ty));
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000406
George Burgess IVd0a9e802017-02-23 22:07:35 +0000407 // +1 for implicit this, which should always be args[0].
408 unsigned TotalPrefixArgs = 1 + ExtraPrefixArgs;
409
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000410 CanQual<FunctionProtoType> FPT = GetFormalType(D);
George Burgess IVd0a9e802017-02-23 22:07:35 +0000411 RequiredArgs Required =
412 RequiredArgs::forPrototypePlus(FPT, TotalPrefixArgs + ExtraSuffixArgs, D);
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000413 GlobalDecl GD(D, CtorKind);
David Majnemer0c0b6d92014-10-31 20:09:12 +0000414 CanQualType ResultType = TheCXXABI.HasThisReturn(GD)
415 ? ArgTypes.front()
416 : TheCXXABI.hasMostDerivedReturn(GD)
417 ? CGM.getContext().VoidPtrTy
418 : Context.VoidTy;
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000419
420 FunctionType::ExtInfo Info = FPT->getExtInfo();
George Burgess IVd0a9e802017-02-23 22:07:35 +0000421 llvm::SmallVector<FunctionProtoType::ExtParameterInfo, 16> ParamInfos;
422 // If the prototype args are elided, we should only have ABI-specific args,
423 // which never have param info.
424 if (PassProtoArgs && FPT->hasExtParameterInfos()) {
425 // ABI-specific suffix arguments are treated the same as variadic arguments.
426 addExtParameterInfosForCall(ParamInfos, FPT.getTypePtr(), TotalPrefixArgs,
427 ArgTypes.size());
428 }
Peter Collingbournef7706832014-12-12 23:41:25 +0000429 return arrangeLLVMFunctionInfo(ResultType, /*instanceMethod=*/true,
430 /*chainCall=*/false, ArgTypes, Info,
John McCallc56a8b32016-03-11 04:30:31 +0000431 ParamInfos, Required);
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000432}
433
John McCalla729c622012-02-17 03:33:10 +0000434/// Arrange the argument and result information for the declaration or
435/// definition of the given function.
436const CGFunctionInfo &
437CodeGenTypes::arrangeFunctionDeclaration(const FunctionDecl *FD) {
Chris Lattnerbea5b622009-05-12 20:27:19 +0000438 if (const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(FD))
Anders Carlssonb15b55c2009-04-03 22:48:58 +0000439 if (MD->isInstance())
John McCalla729c622012-02-17 03:33:10 +0000440 return arrangeCXXMethodDeclaration(MD);
Mike Stump11289f42009-09-09 15:08:12 +0000441
John McCall2da83a32010-02-26 00:48:12 +0000442 CanQualType FTy = FD->getType()->getCanonicalTypeUnqualified();
John McCalla729c622012-02-17 03:33:10 +0000443
John McCall2da83a32010-02-26 00:48:12 +0000444 assert(isa<FunctionType>(FTy));
Yaxun Liu6c10a662018-06-12 00:16:33 +0000445 setCUDAKernelCallingConvention(FTy, CGM, FD);
John McCalla729c622012-02-17 03:33:10 +0000446
447 // When declaring a function without a prototype, always use a
448 // non-variadic type.
George Burgess IV35cfca22017-01-06 19:10:48 +0000449 if (CanQual<FunctionNoProtoType> noProto = FTy.getAs<FunctionNoProtoType>()) {
Peter Collingbournef7706832014-12-12 23:41:25 +0000450 return arrangeLLVMFunctionInfo(
451 noProto->getReturnType(), /*instanceMethod=*/false,
John McCallc56a8b32016-03-11 04:30:31 +0000452 /*chainCall=*/false, None, noProto->getExtInfo(), {},RequiredArgs::All);
John McCalla729c622012-02-17 03:33:10 +0000453 }
454
George Burgess IV35cfca22017-01-06 19:10:48 +0000455 return arrangeFreeFunctionType(FTy.castAs<FunctionProtoType>(), FD);
Daniel Dunbar3d7c90b2008-09-08 21:33:45 +0000456}
457
John McCalla729c622012-02-17 03:33:10 +0000458/// Arrange the argument and result information for the declaration or
459/// definition of an Objective-C method.
460const CGFunctionInfo &
461CodeGenTypes::arrangeObjCMethodDeclaration(const ObjCMethodDecl *MD) {
462 // It happens that this is the same as a call with no optional
463 // arguments, except also using the formal 'self' type.
464 return arrangeObjCMessageSendSignature(MD, MD->getSelfDecl()->getType());
465}
466
467/// Arrange the argument and result information for the function type
468/// through which to perform a send to the given Objective-C method,
469/// using the given receiver type. The receiver type is not always
470/// the 'self' type of the method or even an Objective-C pointer type.
471/// This is *not* the right method for actually performing such a
472/// message send, due to the possibility of optional arguments.
473const CGFunctionInfo &
474CodeGenTypes::arrangeObjCMessageSendSignature(const ObjCMethodDecl *MD,
475 QualType receiverType) {
476 SmallVector<CanQualType, 16> argTys;
Akira Hatanaka98a49332017-09-22 00:41:05 +0000477 SmallVector<FunctionProtoType::ExtParameterInfo, 4> extParamInfos(2);
John McCalla729c622012-02-17 03:33:10 +0000478 argTys.push_back(Context.getCanonicalParamType(receiverType));
479 argTys.push_back(Context.getCanonicalParamType(Context.getObjCSelType()));
Daniel Dunbarbf8c24a2009-02-02 23:23:47 +0000480 // FIXME: Kill copy?
David Majnemer59f77922016-06-24 04:05:48 +0000481 for (const auto *I : MD->parameters()) {
Aaron Ballman43b68be2014-03-07 17:50:17 +0000482 argTys.push_back(Context.getCanonicalParamType(I->getType()));
Akira Hatanaka98a49332017-09-22 00:41:05 +0000483 auto extParamInfo = FunctionProtoType::ExtParameterInfo().withIsNoEscape(
484 I->hasAttr<NoEscapeAttr>());
485 extParamInfos.push_back(extParamInfo);
John McCall8ee376f2010-02-24 07:14:12 +0000486 }
John McCall31168b02011-06-15 23:02:42 +0000487
488 FunctionType::ExtInfo einfo;
Aaron Ballman0362a6d2013-12-18 16:23:37 +0000489 bool IsWindows = getContext().getTargetInfo().getTriple().isOSWindows();
490 einfo = einfo.withCallingConv(getCallingConventionForDecl(MD, IsWindows));
John McCall31168b02011-06-15 23:02:42 +0000491
David Blaikiebbafb8a2012-03-11 07:00:24 +0000492 if (getContext().getLangOpts().ObjCAutoRefCount &&
John McCall31168b02011-06-15 23:02:42 +0000493 MD->hasAttr<NSReturnsRetainedAttr>())
494 einfo = einfo.withProducesResult(true);
495
John McCalla729c622012-02-17 03:33:10 +0000496 RequiredArgs required =
497 (MD->isVariadic() ? RequiredArgs(argTys.size()) : RequiredArgs::All);
498
Peter Collingbournef7706832014-12-12 23:41:25 +0000499 return arrangeLLVMFunctionInfo(
500 GetReturnType(MD->getReturnType()), /*instanceMethod=*/false,
Akira Hatanaka98a49332017-09-22 00:41:05 +0000501 /*chainCall=*/false, argTys, einfo, extParamInfos, required);
John McCallc56a8b32016-03-11 04:30:31 +0000502}
503
504const CGFunctionInfo &
505CodeGenTypes::arrangeUnprototypedObjCMessageSend(QualType returnType,
506 const CallArgList &args) {
507 auto argTypes = getArgTypesForCall(Context, args);
508 FunctionType::ExtInfo einfo;
509
510 return arrangeLLVMFunctionInfo(
511 GetReturnType(returnType), /*instanceMethod=*/false,
512 /*chainCall=*/false, argTypes, einfo, {}, RequiredArgs::All);
Daniel Dunbar3d7c90b2008-09-08 21:33:45 +0000513}
514
John McCalla729c622012-02-17 03:33:10 +0000515const CGFunctionInfo &
516CodeGenTypes::arrangeGlobalDeclaration(GlobalDecl GD) {
Anders Carlsson6710c532010-02-06 02:44:09 +0000517 // FIXME: Do we need to handle ObjCMethodDecl?
518 const FunctionDecl *FD = cast<FunctionDecl>(GD.getDecl());
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000519
Anders Carlsson6710c532010-02-06 02:44:09 +0000520 if (const CXXConstructorDecl *CD = dyn_cast<CXXConstructorDecl>(FD))
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000521 return arrangeCXXStructorDeclaration(CD, getFromCtorType(GD.getCtorType()));
Anders Carlsson6710c532010-02-06 02:44:09 +0000522
523 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(FD))
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000524 return arrangeCXXStructorDeclaration(DD, getFromDtorType(GD.getDtorType()));
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000525
John McCalla729c622012-02-17 03:33:10 +0000526 return arrangeFunctionDeclaration(FD);
Anders Carlsson6710c532010-02-06 02:44:09 +0000527}
528
Reid Klecknerc3473512014-08-29 21:43:29 +0000529/// Arrange a thunk that takes 'this' as the first parameter followed by
530/// varargs. Return a void pointer, regardless of the actual return type.
531/// The body of the thunk will end in a musttail call to a function of the
532/// correct type, and the caller will bitcast the function to the correct
533/// prototype.
534const CGFunctionInfo &
Reid Kleckner399d96e2018-04-02 20:20:33 +0000535CodeGenTypes::arrangeUnprototypedMustTailThunk(const CXXMethodDecl *MD) {
536 assert(MD->isVirtual() && "only methods have thunks");
Reid Klecknerc3473512014-08-29 21:43:29 +0000537 CanQual<FunctionProtoType> FTP = GetFormalType(MD);
Mikael Nilsson9d2872d2018-12-13 10:15:27 +0000538 CanQualType ArgTys[] = { GetThisType(Context, MD->getParent(), MD) };
Peter Collingbournef7706832014-12-12 23:41:25 +0000539 return arrangeLLVMFunctionInfo(Context.VoidTy, /*instanceMethod=*/false,
540 /*chainCall=*/false, ArgTys,
John McCallc56a8b32016-03-11 04:30:31 +0000541 FTP->getExtInfo(), {}, RequiredArgs(1));
Reid Klecknerc3473512014-08-29 21:43:29 +0000542}
543
David Majnemerdfa6d202015-03-11 18:36:39 +0000544const CGFunctionInfo &
David Majnemer37fd66e2015-03-13 22:36:55 +0000545CodeGenTypes::arrangeMSCtorClosure(const CXXConstructorDecl *CD,
546 CXXCtorType CT) {
547 assert(CT == Ctor_CopyingClosure || CT == Ctor_DefaultClosure);
548
David Majnemerdfa6d202015-03-11 18:36:39 +0000549 CanQual<FunctionProtoType> FTP = GetFormalType(CD);
550 SmallVector<CanQualType, 2> ArgTys;
551 const CXXRecordDecl *RD = CD->getParent();
Mikael Nilsson9d2872d2018-12-13 10:15:27 +0000552 ArgTys.push_back(GetThisType(Context, RD, CD));
David Majnemer37fd66e2015-03-13 22:36:55 +0000553 if (CT == Ctor_CopyingClosure)
554 ArgTys.push_back(*FTP->param_type_begin());
David Majnemerdfa6d202015-03-11 18:36:39 +0000555 if (RD->getNumVBases() > 0)
556 ArgTys.push_back(Context.IntTy);
557 CallingConv CC = Context.getDefaultCallingConvention(
558 /*IsVariadic=*/false, /*IsCXXMethod=*/true);
559 return arrangeLLVMFunctionInfo(Context.VoidTy, /*instanceMethod=*/true,
560 /*chainCall=*/false, ArgTys,
John McCallc56a8b32016-03-11 04:30:31 +0000561 FunctionType::ExtInfo(CC), {},
562 RequiredArgs::All);
David Majnemerdfa6d202015-03-11 18:36:39 +0000563}
564
John McCallc818bbb2012-12-07 07:03:17 +0000565/// Arrange a call as unto a free function, except possibly with an
566/// additional number of formal parameters considered required.
567static const CGFunctionInfo &
568arrangeFreeFunctionLikeCall(CodeGenTypes &CGT,
Mark Lacey23455752013-10-10 20:57:00 +0000569 CodeGenModule &CGM,
John McCallc818bbb2012-12-07 07:03:17 +0000570 const CallArgList &args,
571 const FunctionType *fnType,
Peter Collingbournef7706832014-12-12 23:41:25 +0000572 unsigned numExtraRequiredArgs,
573 bool chainCall) {
John McCallc818bbb2012-12-07 07:03:17 +0000574 assert(args.size() >= numExtraRequiredArgs);
575
John McCallc56a8b32016-03-11 04:30:31 +0000576 llvm::SmallVector<FunctionProtoType::ExtParameterInfo, 16> paramInfos;
577
John McCallc818bbb2012-12-07 07:03:17 +0000578 // In most cases, there are no optional arguments.
579 RequiredArgs required = RequiredArgs::All;
580
581 // If we have a variadic prototype, the required arguments are the
582 // extra prefix plus the arguments in the prototype.
583 if (const FunctionProtoType *proto = dyn_cast<FunctionProtoType>(fnType)) {
584 if (proto->isVariadic())
Alp Toker9cacbab2014-01-20 20:26:09 +0000585 required = RequiredArgs(proto->getNumParams() + numExtraRequiredArgs);
John McCallc818bbb2012-12-07 07:03:17 +0000586
John McCallc56a8b32016-03-11 04:30:31 +0000587 if (proto->hasExtParameterInfos())
588 addExtParameterInfosForCall(paramInfos, proto, numExtraRequiredArgs,
589 args.size());
590
John McCallc818bbb2012-12-07 07:03:17 +0000591 // If we don't have a prototype at all, but we're supposed to
592 // explicitly use the variadic convention for unprototyped calls,
593 // treat all of the arguments as required but preserve the nominal
594 // possibility of variadics.
Mark Lacey23455752013-10-10 20:57:00 +0000595 } else if (CGM.getTargetCodeGenInfo()
596 .isNoProtoCallVariadic(args,
597 cast<FunctionNoProtoType>(fnType))) {
John McCallc818bbb2012-12-07 07:03:17 +0000598 required = RequiredArgs(args.size());
599 }
600
Peter Collingbournef7706832014-12-12 23:41:25 +0000601 // FIXME: Kill copy.
602 SmallVector<CanQualType, 16> argTypes;
603 for (const auto &arg : args)
604 argTypes.push_back(CGT.getContext().getCanonicalParamType(arg.Ty));
605 return CGT.arrangeLLVMFunctionInfo(GetReturnType(fnType->getReturnType()),
606 /*instanceMethod=*/false, chainCall,
John McCallc56a8b32016-03-11 04:30:31 +0000607 argTypes, fnType->getExtInfo(), paramInfos,
608 required);
John McCallc818bbb2012-12-07 07:03:17 +0000609}
610
John McCalla729c622012-02-17 03:33:10 +0000611/// Figure out the rules for calling a function with the given formal
612/// type using the given arguments. The arguments are necessary
613/// because the function might be unprototyped, in which case it's
614/// target-dependent in crazy ways.
615const CGFunctionInfo &
John McCall8dda7b22012-07-07 06:41:13 +0000616CodeGenTypes::arrangeFreeFunctionCall(const CallArgList &args,
Peter Collingbournef7706832014-12-12 23:41:25 +0000617 const FunctionType *fnType,
618 bool chainCall) {
619 return arrangeFreeFunctionLikeCall(*this, CGM, args, fnType,
620 chainCall ? 1 : 0, chainCall);
John McCallc818bbb2012-12-07 07:03:17 +0000621}
John McCalla729c622012-02-17 03:33:10 +0000622
John McCallc56a8b32016-03-11 04:30:31 +0000623/// A block function is essentially a free function with an
John McCallc818bbb2012-12-07 07:03:17 +0000624/// extra implicit argument.
625const CGFunctionInfo &
626CodeGenTypes::arrangeBlockFunctionCall(const CallArgList &args,
627 const FunctionType *fnType) {
Peter Collingbournef7706832014-12-12 23:41:25 +0000628 return arrangeFreeFunctionLikeCall(*this, CGM, args, fnType, 1,
629 /*chainCall=*/false);
John McCalla729c622012-02-17 03:33:10 +0000630}
631
632const CGFunctionInfo &
John McCallc56a8b32016-03-11 04:30:31 +0000633CodeGenTypes::arrangeBlockFunctionDeclaration(const FunctionProtoType *proto,
634 const FunctionArgList &params) {
635 auto paramInfos = getExtParameterInfosForCall(proto, 1, params.size());
636 auto argTypes = getArgTypesForDeclaration(Context, params);
637
George Burgess IV419996c2016-06-16 23:06:04 +0000638 return arrangeLLVMFunctionInfo(
639 GetReturnType(proto->getReturnType()),
640 /*instanceMethod*/ false, /*chainCall*/ false, argTypes,
641 proto->getExtInfo(), paramInfos,
642 RequiredArgs::forPrototypePlus(proto, 1, nullptr));
John McCallc56a8b32016-03-11 04:30:31 +0000643}
644
645const CGFunctionInfo &
646CodeGenTypes::arrangeBuiltinFunctionCall(QualType resultType,
647 const CallArgList &args) {
Daniel Dunbarbf8c24a2009-02-02 23:23:47 +0000648 // FIXME: Kill copy.
John McCalla729c622012-02-17 03:33:10 +0000649 SmallVector<CanQualType, 16> argTypes;
Alexey Samsonov3551e312014-08-13 20:06:24 +0000650 for (const auto &Arg : args)
651 argTypes.push_back(Context.getCanonicalParamType(Arg.Ty));
Peter Collingbournef7706832014-12-12 23:41:25 +0000652 return arrangeLLVMFunctionInfo(
653 GetReturnType(resultType), /*instanceMethod=*/false,
John McCallc56a8b32016-03-11 04:30:31 +0000654 /*chainCall=*/false, argTypes, FunctionType::ExtInfo(),
655 /*paramInfos=*/ {}, RequiredArgs::All);
John McCall8dda7b22012-07-07 06:41:13 +0000656}
657
John McCallc56a8b32016-03-11 04:30:31 +0000658const CGFunctionInfo &
659CodeGenTypes::arrangeBuiltinFunctionDeclaration(QualType resultType,
660 const FunctionArgList &args) {
661 auto argTypes = getArgTypesForDeclaration(Context, args);
662
663 return arrangeLLVMFunctionInfo(
664 GetReturnType(resultType), /*instanceMethod=*/false, /*chainCall=*/false,
665 argTypes, FunctionType::ExtInfo(), {}, RequiredArgs::All);
666}
667
668const CGFunctionInfo &
669CodeGenTypes::arrangeBuiltinFunctionDeclaration(CanQualType resultType,
670 ArrayRef<CanQualType> argTypes) {
671 return arrangeLLVMFunctionInfo(
672 resultType, /*instanceMethod=*/false, /*chainCall=*/false,
673 argTypes, FunctionType::ExtInfo(), {}, RequiredArgs::All);
674}
675
John McCall8dda7b22012-07-07 06:41:13 +0000676/// Arrange a call to a C++ method, passing the given arguments.
George Burgess IVd0a9e802017-02-23 22:07:35 +0000677///
678/// numPrefixArgs is the number of ABI-specific prefix arguments we have. It
679/// does not count `this`.
John McCall8dda7b22012-07-07 06:41:13 +0000680const CGFunctionInfo &
681CodeGenTypes::arrangeCXXMethodCall(const CallArgList &args,
John McCallc56a8b32016-03-11 04:30:31 +0000682 const FunctionProtoType *proto,
George Burgess IVd0a9e802017-02-23 22:07:35 +0000683 RequiredArgs required,
684 unsigned numPrefixArgs) {
685 assert(numPrefixArgs + 1 <= args.size() &&
686 "Emitting a call with less args than the required prefix?");
687 // Add one to account for `this`. It's a bit awkward here, but we don't count
688 // `this` in similar places elsewhere.
John McCallc56a8b32016-03-11 04:30:31 +0000689 auto paramInfos =
George Burgess IVd0a9e802017-02-23 22:07:35 +0000690 getExtParameterInfosForCall(proto, numPrefixArgs + 1, args.size());
John McCallc56a8b32016-03-11 04:30:31 +0000691
John McCall8dda7b22012-07-07 06:41:13 +0000692 // FIXME: Kill copy.
John McCallc56a8b32016-03-11 04:30:31 +0000693 auto argTypes = getArgTypesForCall(Context, args);
John McCall8dda7b22012-07-07 06:41:13 +0000694
John McCallc56a8b32016-03-11 04:30:31 +0000695 FunctionType::ExtInfo info = proto->getExtInfo();
Peter Collingbournef7706832014-12-12 23:41:25 +0000696 return arrangeLLVMFunctionInfo(
John McCallc56a8b32016-03-11 04:30:31 +0000697 GetReturnType(proto->getReturnType()), /*instanceMethod=*/true,
698 /*chainCall=*/false, argTypes, info, paramInfos, required);
Daniel Dunbarbf8c24a2009-02-02 23:23:47 +0000699}
700
John McCalla729c622012-02-17 03:33:10 +0000701const CGFunctionInfo &CodeGenTypes::arrangeNullaryFunction() {
Peter Collingbournef7706832014-12-12 23:41:25 +0000702 return arrangeLLVMFunctionInfo(
703 getContext().VoidTy, /*instanceMethod=*/false, /*chainCall=*/false,
John McCallc56a8b32016-03-11 04:30:31 +0000704 None, FunctionType::ExtInfo(), {}, RequiredArgs::All);
705}
706
707const CGFunctionInfo &
708CodeGenTypes::arrangeCall(const CGFunctionInfo &signature,
709 const CallArgList &args) {
710 assert(signature.arg_size() <= args.size());
711 if (signature.arg_size() == args.size())
712 return signature;
713
714 SmallVector<FunctionProtoType::ExtParameterInfo, 16> paramInfos;
715 auto sigParamInfos = signature.getExtParameterInfos();
716 if (!sigParamInfos.empty()) {
717 paramInfos.append(sigParamInfos.begin(), sigParamInfos.end());
718 paramInfos.resize(args.size());
719 }
720
721 auto argTypes = getArgTypesForCall(Context, args);
722
723 assert(signature.getRequiredArgs().allowsOptionalArgs());
724 return arrangeLLVMFunctionInfo(signature.getReturnType(),
725 signature.isInstanceMethod(),
726 signature.isChainCall(),
727 argTypes,
728 signature.getExtInfo(),
729 paramInfos,
730 signature.getRequiredArgs());
John McCalla738c252011-03-09 04:27:21 +0000731}
732
Pekka Jaaskelainenfc2629a2017-06-01 07:18:49 +0000733namespace clang {
734namespace CodeGen {
735void computeSPIRKernelABIInfo(CodeGenModule &CGM, CGFunctionInfo &FI);
736}
737}
738
John McCalla729c622012-02-17 03:33:10 +0000739/// Arrange the argument and result information for an abstract value
740/// of a given function type. This is the method which all of the
741/// above functions ultimately defer to.
742const CGFunctionInfo &
John McCall8dda7b22012-07-07 06:41:13 +0000743CodeGenTypes::arrangeLLVMFunctionInfo(CanQualType resultType,
Peter Collingbournef7706832014-12-12 23:41:25 +0000744 bool instanceMethod,
745 bool chainCall,
John McCall8dda7b22012-07-07 06:41:13 +0000746 ArrayRef<CanQualType> argTypes,
747 FunctionType::ExtInfo info,
John McCallc56a8b32016-03-11 04:30:31 +0000748 ArrayRef<FunctionProtoType::ExtParameterInfo> paramInfos,
John McCall8dda7b22012-07-07 06:41:13 +0000749 RequiredArgs required) {
Fangrui Song3117b172018-10-20 17:53:42 +0000750 assert(llvm::all_of(argTypes,
751 [](CanQualType T) { return T.isCanonicalAsParam(); }));
John McCall2da83a32010-02-26 00:48:12 +0000752
Daniel Dunbare0be8292009-02-03 00:07:12 +0000753 // Lookup or create unique function info.
754 llvm::FoldingSetNodeID ID;
John McCallc56a8b32016-03-11 04:30:31 +0000755 CGFunctionInfo::Profile(ID, instanceMethod, chainCall, info, paramInfos,
756 required, resultType, argTypes);
Daniel Dunbare0be8292009-02-03 00:07:12 +0000757
Craig Topper8a13c412014-05-21 05:09:00 +0000758 void *insertPos = nullptr;
John McCalla729c622012-02-17 03:33:10 +0000759 CGFunctionInfo *FI = FunctionInfos.FindNodeOrInsertPos(ID, insertPos);
Daniel Dunbare0be8292009-02-03 00:07:12 +0000760 if (FI)
761 return *FI;
762
John McCallc56a8b32016-03-11 04:30:31 +0000763 unsigned CC = ClangCallConvToLLVMCallConv(info.getCC());
764
John McCalla729c622012-02-17 03:33:10 +0000765 // Construct the function info. We co-allocate the ArgInfos.
Peter Collingbournef7706832014-12-12 23:41:25 +0000766 FI = CGFunctionInfo::create(CC, instanceMethod, chainCall, info,
John McCallc56a8b32016-03-11 04:30:31 +0000767 paramInfos, resultType, argTypes, required);
John McCalla729c622012-02-17 03:33:10 +0000768 FunctionInfos.InsertNode(FI, insertPos);
Daniel Dunbar313321e2009-02-03 05:31:23 +0000769
David Blaikie82e95a32014-11-19 07:49:47 +0000770 bool inserted = FunctionsBeingProcessed.insert(FI).second;
771 (void)inserted;
John McCalla729c622012-02-17 03:33:10 +0000772 assert(inserted && "Recursively being processed?");
Pekka Jaaskelainenfc2629a2017-06-01 07:18:49 +0000773
Daniel Dunbar313321e2009-02-03 05:31:23 +0000774 // Compute ABI information.
Pekka Jaaskelainenfc2629a2017-06-01 07:18:49 +0000775 if (CC == llvm::CallingConv::SPIR_KERNEL) {
776 // Force target independent argument handling for the host visible
777 // kernel functions.
778 computeSPIRKernelABIInfo(CGM, *FI);
779 } else if (info.getCC() == CC_Swift) {
John McCall12f23522016-04-04 18:33:08 +0000780 swiftcall::computeABIInfo(CGM, *FI);
Pekka Jaaskelainenfc2629a2017-06-01 07:18:49 +0000781 } else {
782 getABIInfo().computeInfo(*FI);
John McCall12f23522016-04-04 18:33:08 +0000783 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000784
Chris Lattnerfe34c1d2010-07-29 06:26:06 +0000785 // Loop over all of the computed argument and return value info. If any of
786 // them are direct or extend without a specified coerce type, specify the
787 // default now.
John McCalla729c622012-02-17 03:33:10 +0000788 ABIArgInfo &retInfo = FI->getReturnInfo();
Craig Topper8a13c412014-05-21 05:09:00 +0000789 if (retInfo.canHaveCoerceToType() && retInfo.getCoerceToType() == nullptr)
John McCalla729c622012-02-17 03:33:10 +0000790 retInfo.setCoerceToType(ConvertType(FI->getReturnType()));
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000791
Aaron Ballmanec47bc22014-03-17 18:10:01 +0000792 for (auto &I : FI->arguments())
Craig Topper8a13c412014-05-21 05:09:00 +0000793 if (I.info.canHaveCoerceToType() && I.info.getCoerceToType() == nullptr)
Aaron Ballmanec47bc22014-03-17 18:10:01 +0000794 I.info.setCoerceToType(ConvertType(I.type));
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000795
John McCalla729c622012-02-17 03:33:10 +0000796 bool erased = FunctionsBeingProcessed.erase(FI); (void)erased;
797 assert(erased && "Not in set?");
Fangrui Song6907ce22018-07-30 19:24:48 +0000798
Daniel Dunbare0be8292009-02-03 00:07:12 +0000799 return *FI;
Daniel Dunbarbf8c24a2009-02-02 23:23:47 +0000800}
801
John McCalla729c622012-02-17 03:33:10 +0000802CGFunctionInfo *CGFunctionInfo::create(unsigned llvmCC,
Peter Collingbournef7706832014-12-12 23:41:25 +0000803 bool instanceMethod,
804 bool chainCall,
John McCalla729c622012-02-17 03:33:10 +0000805 const FunctionType::ExtInfo &info,
John McCallc56a8b32016-03-11 04:30:31 +0000806 ArrayRef<ExtParameterInfo> paramInfos,
John McCalla729c622012-02-17 03:33:10 +0000807 CanQualType resultType,
808 ArrayRef<CanQualType> argTypes,
809 RequiredArgs required) {
John McCallc56a8b32016-03-11 04:30:31 +0000810 assert(paramInfos.empty() || paramInfos.size() == argTypes.size());
811
812 void *buffer =
813 operator new(totalSizeToAlloc<ArgInfo, ExtParameterInfo>(
814 argTypes.size() + 1, paramInfos.size()));
815
John McCalla729c622012-02-17 03:33:10 +0000816 CGFunctionInfo *FI = new(buffer) CGFunctionInfo();
817 FI->CallingConvention = llvmCC;
818 FI->EffectiveCallingConvention = llvmCC;
819 FI->ASTCallingConvention = info.getCC();
Peter Collingbournef7706832014-12-12 23:41:25 +0000820 FI->InstanceMethod = instanceMethod;
821 FI->ChainCall = chainCall;
John McCalla729c622012-02-17 03:33:10 +0000822 FI->NoReturn = info.getNoReturn();
823 FI->ReturnsRetained = info.getProducesResult();
Oren Ben Simhon318a6ea2017-04-27 12:01:00 +0000824 FI->NoCallerSavedRegs = info.getNoCallerSavedRegs();
Oren Ben Simhon220671a2018-03-17 13:31:35 +0000825 FI->NoCfCheck = info.getNoCfCheck();
John McCalla729c622012-02-17 03:33:10 +0000826 FI->Required = required;
827 FI->HasRegParm = info.getHasRegParm();
828 FI->RegParm = info.getRegParm();
Craig Topper8a13c412014-05-21 05:09:00 +0000829 FI->ArgStruct = nullptr;
John McCall7f416cc2015-09-08 08:05:57 +0000830 FI->ArgStructAlign = 0;
John McCalla729c622012-02-17 03:33:10 +0000831 FI->NumArgs = argTypes.size();
John McCallc56a8b32016-03-11 04:30:31 +0000832 FI->HasExtParameterInfos = !paramInfos.empty();
John McCalla729c622012-02-17 03:33:10 +0000833 FI->getArgsBuffer()[0].type = resultType;
834 for (unsigned i = 0, e = argTypes.size(); i != e; ++i)
835 FI->getArgsBuffer()[i + 1].type = argTypes[i];
John McCallc56a8b32016-03-11 04:30:31 +0000836 for (unsigned i = 0, e = paramInfos.size(); i != e; ++i)
837 FI->getExtParameterInfosBuffer()[i] = paramInfos[i];
John McCalla729c622012-02-17 03:33:10 +0000838 return FI;
Daniel Dunbar313321e2009-02-03 05:31:23 +0000839}
840
841/***/
842
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000843namespace {
844// ABIArgInfo::Expand implementation.
845
846// Specifies the way QualType passed as ABIArgInfo::Expand is expanded.
847struct TypeExpansion {
848 enum TypeExpansionKind {
849 // Elements of constant arrays are expanded recursively.
850 TEK_ConstantArray,
851 // Record fields are expanded recursively (but if record is a union, only
852 // the field with the largest size is expanded).
853 TEK_Record,
854 // For complex types, real and imaginary parts are expanded recursively.
855 TEK_Complex,
856 // All other types are not expandable.
857 TEK_None
858 };
859
860 const TypeExpansionKind Kind;
861
862 TypeExpansion(TypeExpansionKind K) : Kind(K) {}
Angel Garcia Gomez637d1e62015-10-20 13:23:58 +0000863 virtual ~TypeExpansion() {}
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000864};
865
866struct ConstantArrayExpansion : TypeExpansion {
867 QualType EltTy;
868 uint64_t NumElts;
869
870 ConstantArrayExpansion(QualType EltTy, uint64_t NumElts)
871 : TypeExpansion(TEK_ConstantArray), EltTy(EltTy), NumElts(NumElts) {}
872 static bool classof(const TypeExpansion *TE) {
873 return TE->Kind == TEK_ConstantArray;
874 }
875};
876
877struct RecordExpansion : TypeExpansion {
Reid Klecknere9f6a712014-10-31 17:10:41 +0000878 SmallVector<const CXXBaseSpecifier *, 1> Bases;
879
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000880 SmallVector<const FieldDecl *, 1> Fields;
881
Reid Klecknere9f6a712014-10-31 17:10:41 +0000882 RecordExpansion(SmallVector<const CXXBaseSpecifier *, 1> &&Bases,
883 SmallVector<const FieldDecl *, 1> &&Fields)
Benjamin Kramer0bb97742016-02-13 16:00:13 +0000884 : TypeExpansion(TEK_Record), Bases(std::move(Bases)),
885 Fields(std::move(Fields)) {}
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000886 static bool classof(const TypeExpansion *TE) {
887 return TE->Kind == TEK_Record;
888 }
889};
890
891struct ComplexExpansion : TypeExpansion {
892 QualType EltTy;
893
894 ComplexExpansion(QualType EltTy) : TypeExpansion(TEK_Complex), EltTy(EltTy) {}
895 static bool classof(const TypeExpansion *TE) {
896 return TE->Kind == TEK_Complex;
897 }
898};
899
900struct NoExpansion : TypeExpansion {
901 NoExpansion() : TypeExpansion(TEK_None) {}
902 static bool classof(const TypeExpansion *TE) {
903 return TE->Kind == TEK_None;
904 }
905};
906} // namespace
907
908static std::unique_ptr<TypeExpansion>
909getTypeExpansion(QualType Ty, const ASTContext &Context) {
910 if (const ConstantArrayType *AT = Context.getAsConstantArrayType(Ty)) {
911 return llvm::make_unique<ConstantArrayExpansion>(
912 AT->getElementType(), AT->getSize().getZExtValue());
913 }
914 if (const RecordType *RT = Ty->getAs<RecordType>()) {
Reid Klecknere9f6a712014-10-31 17:10:41 +0000915 SmallVector<const CXXBaseSpecifier *, 1> Bases;
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000916 SmallVector<const FieldDecl *, 1> Fields;
Bob Wilsone826a2a2011-08-03 05:58:22 +0000917 const RecordDecl *RD = RT->getDecl();
918 assert(!RD->hasFlexibleArrayMember() &&
919 "Cannot expand structure with flexible array.");
Anton Korobeynikov4215ca72012-04-13 11:22:00 +0000920 if (RD->isUnion()) {
921 // Unions can be here only in degenerative cases - all the fields are same
922 // after flattening. Thus we have to use the "largest" field.
Craig Topper8a13c412014-05-21 05:09:00 +0000923 const FieldDecl *LargestFD = nullptr;
Anton Korobeynikov4215ca72012-04-13 11:22:00 +0000924 CharUnits UnionSize = CharUnits::Zero();
925
Aaron Ballmane8a8bae2014-03-08 20:12:42 +0000926 for (const auto *FD : RD->fields()) {
Richard Smith866dee42018-04-02 18:29:43 +0000927 if (FD->isZeroLengthBitField(Context))
Reid Kleckner80944df2014-10-31 22:00:51 +0000928 continue;
Anton Korobeynikov4215ca72012-04-13 11:22:00 +0000929 assert(!FD->isBitField() &&
930 "Cannot expand structure with bit-field members.");
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000931 CharUnits FieldSize = Context.getTypeSizeInChars(FD->getType());
Anton Korobeynikov4215ca72012-04-13 11:22:00 +0000932 if (UnionSize < FieldSize) {
933 UnionSize = FieldSize;
934 LargestFD = FD;
935 }
936 }
937 if (LargestFD)
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000938 Fields.push_back(LargestFD);
Anton Korobeynikov4215ca72012-04-13 11:22:00 +0000939 } else {
Reid Klecknere9f6a712014-10-31 17:10:41 +0000940 if (const auto *CXXRD = dyn_cast<CXXRecordDecl>(RD)) {
941 assert(!CXXRD->isDynamicClass() &&
942 "cannot expand vtable pointers in dynamic classes");
943 for (const CXXBaseSpecifier &BS : CXXRD->bases())
944 Bases.push_back(&BS);
945 }
946
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000947 for (const auto *FD : RD->fields()) {
Richard Smith866dee42018-04-02 18:29:43 +0000948 if (FD->isZeroLengthBitField(Context))
Reid Kleckner80944df2014-10-31 22:00:51 +0000949 continue;
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000950 assert(!FD->isBitField() &&
Anton Korobeynikov4215ca72012-04-13 11:22:00 +0000951 "Cannot expand structure with bit-field members.");
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000952 Fields.push_back(FD);
Anton Korobeynikov4215ca72012-04-13 11:22:00 +0000953 }
Bob Wilsone826a2a2011-08-03 05:58:22 +0000954 }
Reid Klecknere9f6a712014-10-31 17:10:41 +0000955 return llvm::make_unique<RecordExpansion>(std::move(Bases),
956 std::move(Fields));
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000957 }
958 if (const ComplexType *CT = Ty->getAs<ComplexType>()) {
959 return llvm::make_unique<ComplexExpansion>(CT->getElementType());
960 }
961 return llvm::make_unique<NoExpansion>();
962}
963
Alexey Samsonov52c0f6a2014-09-29 20:30:22 +0000964static int getExpansionSize(QualType Ty, const ASTContext &Context) {
965 auto Exp = getTypeExpansion(Ty, Context);
966 if (auto CAExp = dyn_cast<ConstantArrayExpansion>(Exp.get())) {
967 return CAExp->NumElts * getExpansionSize(CAExp->EltTy, Context);
968 }
969 if (auto RExp = dyn_cast<RecordExpansion>(Exp.get())) {
970 int Res = 0;
Reid Klecknere9f6a712014-10-31 17:10:41 +0000971 for (auto BS : RExp->Bases)
972 Res += getExpansionSize(BS->getType(), Context);
Alexey Samsonov52c0f6a2014-09-29 20:30:22 +0000973 for (auto FD : RExp->Fields)
974 Res += getExpansionSize(FD->getType(), Context);
975 return Res;
976 }
977 if (isa<ComplexExpansion>(Exp.get()))
978 return 2;
979 assert(isa<NoExpansion>(Exp.get()));
980 return 1;
981}
982
Alexey Samsonov153004f2014-09-29 22:08:00 +0000983void
984CodeGenTypes::getExpandedTypes(QualType Ty,
985 SmallVectorImpl<llvm::Type *>::iterator &TI) {
986 auto Exp = getTypeExpansion(Ty, Context);
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000987 if (auto CAExp = dyn_cast<ConstantArrayExpansion>(Exp.get())) {
988 for (int i = 0, n = CAExp->NumElts; i < n; i++) {
Alexey Samsonov153004f2014-09-29 22:08:00 +0000989 getExpandedTypes(CAExp->EltTy, TI);
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000990 }
991 } else if (auto RExp = dyn_cast<RecordExpansion>(Exp.get())) {
Reid Klecknere9f6a712014-10-31 17:10:41 +0000992 for (auto BS : RExp->Bases)
993 getExpandedTypes(BS->getType(), TI);
994 for (auto FD : RExp->Fields)
Alexey Samsonov153004f2014-09-29 22:08:00 +0000995 getExpandedTypes(FD->getType(), TI);
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000996 } else if (auto CExp = dyn_cast<ComplexExpansion>(Exp.get())) {
997 llvm::Type *EltTy = ConvertType(CExp->EltTy);
Alexey Samsonov153004f2014-09-29 22:08:00 +0000998 *TI++ = EltTy;
999 *TI++ = EltTy;
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001000 } else {
1001 assert(isa<NoExpansion>(Exp.get()));
Alexey Samsonov153004f2014-09-29 22:08:00 +00001002 *TI++ = ConvertType(Ty);
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001003 }
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00001004}
1005
John McCall7f416cc2015-09-08 08:05:57 +00001006static void forConstantArrayExpansion(CodeGenFunction &CGF,
1007 ConstantArrayExpansion *CAE,
1008 Address BaseAddr,
1009 llvm::function_ref<void(Address)> Fn) {
1010 CharUnits EltSize = CGF.getContext().getTypeSizeInChars(CAE->EltTy);
1011 CharUnits EltAlign =
1012 BaseAddr.getAlignment().alignmentOfArrayElement(EltSize);
1013
1014 for (int i = 0, n = CAE->NumElts; i < n; i++) {
1015 llvm::Value *EltAddr =
1016 CGF.Builder.CreateConstGEP2_32(nullptr, BaseAddr.getPointer(), 0, i);
1017 Fn(Address(EltAddr, EltAlign));
1018 }
1019}
1020
Alexey Samsonov91cf4552014-08-22 01:06:06 +00001021void CodeGenFunction::ExpandTypeFromArgs(
John McCall12f23522016-04-04 18:33:08 +00001022 QualType Ty, LValue LV, SmallVectorImpl<llvm::Value *>::iterator &AI) {
Mike Stump11289f42009-09-09 15:08:12 +00001023 assert(LV.isSimple() &&
1024 "Unexpected non-simple lvalue during struct expansion.");
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00001025
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001026 auto Exp = getTypeExpansion(Ty, getContext());
1027 if (auto CAExp = dyn_cast<ConstantArrayExpansion>(Exp.get())) {
John McCall7f416cc2015-09-08 08:05:57 +00001028 forConstantArrayExpansion(*this, CAExp, LV.getAddress(),
1029 [&](Address EltAddr) {
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001030 LValue LV = MakeAddrLValue(EltAddr, CAExp->EltTy);
1031 ExpandTypeFromArgs(CAExp->EltTy, LV, AI);
John McCall7f416cc2015-09-08 08:05:57 +00001032 });
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001033 } else if (auto RExp = dyn_cast<RecordExpansion>(Exp.get())) {
John McCall7f416cc2015-09-08 08:05:57 +00001034 Address This = LV.getAddress();
Reid Klecknere9f6a712014-10-31 17:10:41 +00001035 for (const CXXBaseSpecifier *BS : RExp->Bases) {
1036 // Perform a single step derived-to-base conversion.
John McCall7f416cc2015-09-08 08:05:57 +00001037 Address Base =
Reid Klecknere9f6a712014-10-31 17:10:41 +00001038 GetAddressOfBaseClass(This, Ty->getAsCXXRecordDecl(), &BS, &BS + 1,
1039 /*NullCheckValue=*/false, SourceLocation());
1040 LValue SubLV = MakeAddrLValue(Base, BS->getType());
1041
1042 // Recurse onto bases.
1043 ExpandTypeFromArgs(BS->getType(), SubLV, AI);
1044 }
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001045 for (auto FD : RExp->Fields) {
1046 // FIXME: What are the right qualifiers here?
Reid Kleckner9d031092016-05-02 22:42:34 +00001047 LValue SubLV = EmitLValueForFieldInitialization(LV, FD);
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001048 ExpandTypeFromArgs(FD->getType(), SubLV, AI);
Bob Wilsone826a2a2011-08-03 05:58:22 +00001049 }
John McCall7f416cc2015-09-08 08:05:57 +00001050 } else if (isa<ComplexExpansion>(Exp.get())) {
1051 auto realValue = *AI++;
1052 auto imagValue = *AI++;
1053 EmitStoreOfComplex(ComplexPairTy(realValue, imagValue), LV, /*init*/ true);
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001054 } else {
1055 assert(isa<NoExpansion>(Exp.get()));
1056 EmitStoreThroughLValue(RValue::get(*AI++), LV);
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00001057 }
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001058}
1059
1060void CodeGenFunction::ExpandTypeToArgs(
Yaxun Liu5b330e82018-03-15 15:25:19 +00001061 QualType Ty, CallArg Arg, llvm::FunctionType *IRFuncTy,
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001062 SmallVectorImpl<llvm::Value *> &IRCallArgs, unsigned &IRCallArgPos) {
1063 auto Exp = getTypeExpansion(Ty, getContext());
1064 if (auto CAExp = dyn_cast<ConstantArrayExpansion>(Exp.get())) {
Yaxun Liu5b330e82018-03-15 15:25:19 +00001065 Address Addr = Arg.hasLValue() ? Arg.getKnownLValue().getAddress()
1066 : Arg.getKnownRValue().getAggregateAddress();
1067 forConstantArrayExpansion(
1068 *this, CAExp, Addr, [&](Address EltAddr) {
1069 CallArg EltArg = CallArg(
1070 convertTempToRValue(EltAddr, CAExp->EltTy, SourceLocation()),
1071 CAExp->EltTy);
1072 ExpandTypeToArgs(CAExp->EltTy, EltArg, IRFuncTy, IRCallArgs,
1073 IRCallArgPos);
1074 });
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001075 } else if (auto RExp = dyn_cast<RecordExpansion>(Exp.get())) {
Yaxun Liu5b330e82018-03-15 15:25:19 +00001076 Address This = Arg.hasLValue() ? Arg.getKnownLValue().getAddress()
1077 : Arg.getKnownRValue().getAggregateAddress();
Reid Klecknere9f6a712014-10-31 17:10:41 +00001078 for (const CXXBaseSpecifier *BS : RExp->Bases) {
1079 // Perform a single step derived-to-base conversion.
John McCall7f416cc2015-09-08 08:05:57 +00001080 Address Base =
Reid Klecknere9f6a712014-10-31 17:10:41 +00001081 GetAddressOfBaseClass(This, Ty->getAsCXXRecordDecl(), &BS, &BS + 1,
1082 /*NullCheckValue=*/false, SourceLocation());
Yaxun Liu5b330e82018-03-15 15:25:19 +00001083 CallArg BaseArg = CallArg(RValue::getAggregate(Base), BS->getType());
Reid Klecknere9f6a712014-10-31 17:10:41 +00001084
1085 // Recurse onto bases.
Yaxun Liu5b330e82018-03-15 15:25:19 +00001086 ExpandTypeToArgs(BS->getType(), BaseArg, IRFuncTy, IRCallArgs,
Reid Klecknere9f6a712014-10-31 17:10:41 +00001087 IRCallArgPos);
1088 }
1089
1090 LValue LV = MakeAddrLValue(This, Ty);
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001091 for (auto FD : RExp->Fields) {
Yaxun Liu5b330e82018-03-15 15:25:19 +00001092 CallArg FldArg =
1093 CallArg(EmitRValueForField(LV, FD, SourceLocation()), FD->getType());
1094 ExpandTypeToArgs(FD->getType(), FldArg, IRFuncTy, IRCallArgs,
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001095 IRCallArgPos);
1096 }
1097 } else if (isa<ComplexExpansion>(Exp.get())) {
Yaxun Liu5b330e82018-03-15 15:25:19 +00001098 ComplexPairTy CV = Arg.getKnownRValue().getComplexVal();
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001099 IRCallArgs[IRCallArgPos++] = CV.first;
1100 IRCallArgs[IRCallArgPos++] = CV.second;
1101 } else {
1102 assert(isa<NoExpansion>(Exp.get()));
Yaxun Liu5b330e82018-03-15 15:25:19 +00001103 auto RV = Arg.getKnownRValue();
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001104 assert(RV.isScalar() &&
1105 "Unexpected non-scalar rvalue during struct expansion.");
1106
1107 // Insert a bitcast as needed.
1108 llvm::Value *V = RV.getScalarVal();
1109 if (IRCallArgPos < IRFuncTy->getNumParams() &&
1110 V->getType() != IRFuncTy->getParamType(IRCallArgPos))
1111 V = Builder.CreateBitCast(V, IRFuncTy->getParamType(IRCallArgPos));
1112
1113 IRCallArgs[IRCallArgPos++] = V;
1114 }
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00001115}
1116
John McCall7f416cc2015-09-08 08:05:57 +00001117/// Create a temporary allocation for the purposes of coercion.
1118static Address CreateTempAllocaForCoercion(CodeGenFunction &CGF, llvm::Type *Ty,
1119 CharUnits MinAlign) {
1120 // Don't use an alignment that's worse than what LLVM would prefer.
1121 auto PrefAlign = CGF.CGM.getDataLayout().getPrefTypeAlignment(Ty);
1122 CharUnits Align = std::max(MinAlign, CharUnits::fromQuantity(PrefAlign));
1123
1124 return CGF.CreateTempAlloca(Ty, Align);
1125}
1126
Chris Lattner895c52b2010-06-27 06:04:18 +00001127/// EnterStructPointerForCoercedAccess - Given a struct pointer that we are
Chris Lattner1cd66982010-06-27 05:56:15 +00001128/// accessing some number of bytes out of it, try to gep into the struct to get
1129/// at its inner goodness. Dive as deep as possible without entering an element
1130/// with an in-memory size smaller than DstSize.
John McCall7f416cc2015-09-08 08:05:57 +00001131static Address
1132EnterStructPointerForCoercedAccess(Address SrcPtr,
Chris Lattner2192fe52011-07-18 04:24:23 +00001133 llvm::StructType *SrcSTy,
Chris Lattner895c52b2010-06-27 06:04:18 +00001134 uint64_t DstSize, CodeGenFunction &CGF) {
Chris Lattner1cd66982010-06-27 05:56:15 +00001135 // We can't dive into a zero-element struct.
1136 if (SrcSTy->getNumElements() == 0) return SrcPtr;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001137
Chris Lattner2192fe52011-07-18 04:24:23 +00001138 llvm::Type *FirstElt = SrcSTy->getElementType(0);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001139
Chris Lattner1cd66982010-06-27 05:56:15 +00001140 // 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 +00001141 // first element is the same size as the whole struct, we can enter it. The
1142 // comparison must be made on the store size and not the alloca size. Using
1143 // the alloca size may overstate the size of the load.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001144 uint64_t FirstEltSize =
James Molloy90d61012014-08-29 10:17:52 +00001145 CGF.CGM.getDataLayout().getTypeStoreSize(FirstElt);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001146 if (FirstEltSize < DstSize &&
James Molloy90d61012014-08-29 10:17:52 +00001147 FirstEltSize < CGF.CGM.getDataLayout().getTypeStoreSize(SrcSTy))
Chris Lattner1cd66982010-06-27 05:56:15 +00001148 return SrcPtr;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001149
Chris Lattner1cd66982010-06-27 05:56:15 +00001150 // GEP into the first element.
John McCall7f416cc2015-09-08 08:05:57 +00001151 SrcPtr = CGF.Builder.CreateStructGEP(SrcPtr, 0, CharUnits(), "coerce.dive");
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001152
Chris Lattner1cd66982010-06-27 05:56:15 +00001153 // If the first element is a struct, recurse.
John McCall7f416cc2015-09-08 08:05:57 +00001154 llvm::Type *SrcTy = SrcPtr.getElementType();
Chris Lattner2192fe52011-07-18 04:24:23 +00001155 if (llvm::StructType *SrcSTy = dyn_cast<llvm::StructType>(SrcTy))
Chris Lattner895c52b2010-06-27 06:04:18 +00001156 return EnterStructPointerForCoercedAccess(SrcPtr, SrcSTy, DstSize, CGF);
Chris Lattner1cd66982010-06-27 05:56:15 +00001157
1158 return SrcPtr;
1159}
1160
Chris Lattner055097f2010-06-27 06:26:04 +00001161/// CoerceIntOrPtrToIntOrPtr - Convert a value Val to the specific Ty where both
1162/// are either integers or pointers. This does a truncation of the value if it
1163/// is too large or a zero extension if it is too small.
Jakob Stoklund Olesen36af2522013-06-05 03:00:13 +00001164///
1165/// This behaves as if the value were coerced through memory, so on big-endian
1166/// targets the high bits are preserved in a truncation, while little-endian
1167/// targets preserve the low bits.
Chris Lattner055097f2010-06-27 06:26:04 +00001168static llvm::Value *CoerceIntOrPtrToIntOrPtr(llvm::Value *Val,
Chris Lattner2192fe52011-07-18 04:24:23 +00001169 llvm::Type *Ty,
Chris Lattner055097f2010-06-27 06:26:04 +00001170 CodeGenFunction &CGF) {
1171 if (Val->getType() == Ty)
1172 return Val;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001173
Chris Lattner055097f2010-06-27 06:26:04 +00001174 if (isa<llvm::PointerType>(Val->getType())) {
1175 // If this is Pointer->Pointer avoid conversion to and from int.
1176 if (isa<llvm::PointerType>(Ty))
1177 return CGF.Builder.CreateBitCast(Val, Ty, "coerce.val");
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001178
Chris Lattner055097f2010-06-27 06:26:04 +00001179 // Convert the pointer to an integer so we can play with its width.
Chris Lattner5e016ae2010-06-27 07:15:29 +00001180 Val = CGF.Builder.CreatePtrToInt(Val, CGF.IntPtrTy, "coerce.val.pi");
Chris Lattner055097f2010-06-27 06:26:04 +00001181 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001182
Chris Lattner2192fe52011-07-18 04:24:23 +00001183 llvm::Type *DestIntTy = Ty;
Chris Lattner055097f2010-06-27 06:26:04 +00001184 if (isa<llvm::PointerType>(DestIntTy))
Chris Lattner5e016ae2010-06-27 07:15:29 +00001185 DestIntTy = CGF.IntPtrTy;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001186
Jakob Stoklund Olesen36af2522013-06-05 03:00:13 +00001187 if (Val->getType() != DestIntTy) {
1188 const llvm::DataLayout &DL = CGF.CGM.getDataLayout();
1189 if (DL.isBigEndian()) {
1190 // Preserve the high bits on big-endian targets.
1191 // That is what memory coercion does.
James Molloy491cefb2014-05-07 17:41:15 +00001192 uint64_t SrcSize = DL.getTypeSizeInBits(Val->getType());
1193 uint64_t DstSize = DL.getTypeSizeInBits(DestIntTy);
1194
Jakob Stoklund Olesen36af2522013-06-05 03:00:13 +00001195 if (SrcSize > DstSize) {
1196 Val = CGF.Builder.CreateLShr(Val, SrcSize - DstSize, "coerce.highbits");
1197 Val = CGF.Builder.CreateTrunc(Val, DestIntTy, "coerce.val.ii");
1198 } else {
1199 Val = CGF.Builder.CreateZExt(Val, DestIntTy, "coerce.val.ii");
1200 Val = CGF.Builder.CreateShl(Val, DstSize - SrcSize, "coerce.highbits");
1201 }
1202 } else {
1203 // Little-endian targets preserve the low bits. No shifts required.
1204 Val = CGF.Builder.CreateIntCast(Val, DestIntTy, false, "coerce.val.ii");
1205 }
1206 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001207
Chris Lattner055097f2010-06-27 06:26:04 +00001208 if (isa<llvm::PointerType>(Ty))
1209 Val = CGF.Builder.CreateIntToPtr(Val, Ty, "coerce.val.ip");
1210 return Val;
1211}
1212
Chris Lattner1cd66982010-06-27 05:56:15 +00001213
1214
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001215/// CreateCoercedLoad - Create a load from \arg SrcPtr interpreted as
Ulrich Weigand6e2cea62015-07-10 11:31:43 +00001216/// a pointer to an object of type \arg Ty, known to be aligned to
1217/// \arg SrcAlign bytes.
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001218///
1219/// This safely handles the case when the src type is smaller than the
1220/// destination type; in this situation the values of bits which not
1221/// present in the src are undefined.
John McCall7f416cc2015-09-08 08:05:57 +00001222static llvm::Value *CreateCoercedLoad(Address Src, llvm::Type *Ty,
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001223 CodeGenFunction &CGF) {
John McCall7f416cc2015-09-08 08:05:57 +00001224 llvm::Type *SrcTy = Src.getElementType();
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001225
Chris Lattnerd200eda2010-06-28 22:51:39 +00001226 // If SrcTy and Ty are the same, just do a load.
1227 if (SrcTy == Ty)
John McCall7f416cc2015-09-08 08:05:57 +00001228 return CGF.Builder.CreateLoad(Src);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001229
Micah Villmowdd31ca12012-10-08 16:25:52 +00001230 uint64_t DstSize = CGF.CGM.getDataLayout().getTypeAllocSize(Ty);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001231
Chris Lattner2192fe52011-07-18 04:24:23 +00001232 if (llvm::StructType *SrcSTy = dyn_cast<llvm::StructType>(SrcTy)) {
John McCall7f416cc2015-09-08 08:05:57 +00001233 Src = EnterStructPointerForCoercedAccess(Src, SrcSTy, DstSize, CGF);
1234 SrcTy = Src.getType()->getElementType();
Chris Lattner1cd66982010-06-27 05:56:15 +00001235 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001236
Micah Villmowdd31ca12012-10-08 16:25:52 +00001237 uint64_t SrcSize = CGF.CGM.getDataLayout().getTypeAllocSize(SrcTy);
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001238
Chris Lattner055097f2010-06-27 06:26:04 +00001239 // If the source and destination are integer or pointer types, just do an
1240 // extension or truncation to the desired type.
1241 if ((isa<llvm::IntegerType>(Ty) || isa<llvm::PointerType>(Ty)) &&
1242 (isa<llvm::IntegerType>(SrcTy) || isa<llvm::PointerType>(SrcTy))) {
John McCall7f416cc2015-09-08 08:05:57 +00001243 llvm::Value *Load = CGF.Builder.CreateLoad(Src);
Chris Lattner055097f2010-06-27 06:26:04 +00001244 return CoerceIntOrPtrToIntOrPtr(Load, Ty, CGF);
1245 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001246
Daniel Dunbarb52d0772009-02-03 05:59:18 +00001247 // If load is legal, just bitcast the src pointer.
Daniel Dunbarffdb8432009-05-13 18:54:26 +00001248 if (SrcSize >= DstSize) {
Mike Stump18bb9282009-05-16 07:57:57 +00001249 // Generally SrcSize is never greater than DstSize, since this means we are
1250 // losing bits. However, this can happen in cases where the structure has
1251 // additional padding, for example due to a user specified alignment.
Daniel Dunbarffdb8432009-05-13 18:54:26 +00001252 //
Mike Stump18bb9282009-05-16 07:57:57 +00001253 // FIXME: Assert that we aren't truncating non-padding bits when have access
1254 // to that information.
Matt Arsenault7a124f32017-08-01 20:36:57 +00001255 Src = CGF.Builder.CreateBitCast(Src,
1256 Ty->getPointerTo(Src.getAddressSpace()));
John McCall7f416cc2015-09-08 08:05:57 +00001257 return CGF.Builder.CreateLoad(Src);
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001258 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001259
John McCall7f416cc2015-09-08 08:05:57 +00001260 // Otherwise do coercion through memory. This is stupid, but simple.
1261 Address Tmp = CreateTempAllocaForCoercion(CGF, Ty, Src.getAlignment());
Yaxun Liu4bbdebc2018-11-08 16:55:46 +00001262 Address Casted = CGF.Builder.CreateElementBitCast(Tmp,CGF.Int8Ty);
1263 Address SrcCasted = CGF.Builder.CreateElementBitCast(Src,CGF.Int8Ty);
Manman Ren84b921f2012-11-28 22:08:52 +00001264 CGF.Builder.CreateMemCpy(Casted, SrcCasted,
1265 llvm::ConstantInt::get(CGF.IntPtrTy, SrcSize),
John McCall7f416cc2015-09-08 08:05:57 +00001266 false);
1267 return CGF.Builder.CreateLoad(Tmp);
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001268}
1269
Eli Friedmanaf9b3252011-05-17 21:08:01 +00001270// Function to store a first-class aggregate into memory. We prefer to
1271// store the elements rather than the aggregate to be more friendly to
1272// fast-isel.
1273// FIXME: Do we need to recurse here?
1274static void BuildAggStore(CodeGenFunction &CGF, llvm::Value *Val,
John McCall7f416cc2015-09-08 08:05:57 +00001275 Address Dest, bool DestIsVolatile) {
Eli Friedmanaf9b3252011-05-17 21:08:01 +00001276 // Prefer scalar stores to first-class aggregate stores.
Chris Lattner2192fe52011-07-18 04:24:23 +00001277 if (llvm::StructType *STy =
Eli Friedmanaf9b3252011-05-17 21:08:01 +00001278 dyn_cast<llvm::StructType>(Val->getType())) {
Ulrich Weigand6e2cea62015-07-10 11:31:43 +00001279 const llvm::StructLayout *Layout =
1280 CGF.CGM.getDataLayout().getStructLayout(STy);
1281
Eli Friedmanaf9b3252011-05-17 21:08:01 +00001282 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
John McCall7f416cc2015-09-08 08:05:57 +00001283 auto EltOffset = CharUnits::fromQuantity(Layout->getElementOffset(i));
1284 Address EltPtr = CGF.Builder.CreateStructGEP(Dest, i, EltOffset);
Eli Friedmanaf9b3252011-05-17 21:08:01 +00001285 llvm::Value *Elt = CGF.Builder.CreateExtractValue(Val, i);
John McCall7f416cc2015-09-08 08:05:57 +00001286 CGF.Builder.CreateStore(Elt, EltPtr, DestIsVolatile);
Eli Friedmanaf9b3252011-05-17 21:08:01 +00001287 }
1288 } else {
John McCall7f416cc2015-09-08 08:05:57 +00001289 CGF.Builder.CreateStore(Val, Dest, DestIsVolatile);
Eli Friedmanaf9b3252011-05-17 21:08:01 +00001290 }
1291}
1292
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001293/// CreateCoercedStore - Create a store to \arg DstPtr from \arg Src,
Ulrich Weigand6e2cea62015-07-10 11:31:43 +00001294/// where the source and destination may have different types. The
1295/// destination is known to be aligned to \arg DstAlign bytes.
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001296///
1297/// This safely handles the case when the src type is larger than the
1298/// destination type; the upper bits of the src will be lost.
1299static void CreateCoercedStore(llvm::Value *Src,
John McCall7f416cc2015-09-08 08:05:57 +00001300 Address Dst,
Anders Carlsson17490832009-12-24 20:40:36 +00001301 bool DstIsVolatile,
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001302 CodeGenFunction &CGF) {
Chris Lattner2192fe52011-07-18 04:24:23 +00001303 llvm::Type *SrcTy = Src->getType();
John McCall7f416cc2015-09-08 08:05:57 +00001304 llvm::Type *DstTy = Dst.getType()->getElementType();
Chris Lattnerd200eda2010-06-28 22:51:39 +00001305 if (SrcTy == DstTy) {
John McCall7f416cc2015-09-08 08:05:57 +00001306 CGF.Builder.CreateStore(Src, Dst, DstIsVolatile);
Chris Lattnerd200eda2010-06-28 22:51:39 +00001307 return;
1308 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001309
Micah Villmowdd31ca12012-10-08 16:25:52 +00001310 uint64_t SrcSize = CGF.CGM.getDataLayout().getTypeAllocSize(SrcTy);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001311
Chris Lattner2192fe52011-07-18 04:24:23 +00001312 if (llvm::StructType *DstSTy = dyn_cast<llvm::StructType>(DstTy)) {
John McCall7f416cc2015-09-08 08:05:57 +00001313 Dst = EnterStructPointerForCoercedAccess(Dst, DstSTy, SrcSize, CGF);
1314 DstTy = Dst.getType()->getElementType();
Chris Lattner895c52b2010-06-27 06:04:18 +00001315 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001316
Chris Lattner055097f2010-06-27 06:26:04 +00001317 // If the source and destination are integer or pointer types, just do an
1318 // extension or truncation to the desired type.
1319 if ((isa<llvm::IntegerType>(SrcTy) || isa<llvm::PointerType>(SrcTy)) &&
1320 (isa<llvm::IntegerType>(DstTy) || isa<llvm::PointerType>(DstTy))) {
1321 Src = CoerceIntOrPtrToIntOrPtr(Src, DstTy, CGF);
John McCall7f416cc2015-09-08 08:05:57 +00001322 CGF.Builder.CreateStore(Src, Dst, DstIsVolatile);
Chris Lattner055097f2010-06-27 06:26:04 +00001323 return;
1324 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001325
Micah Villmowdd31ca12012-10-08 16:25:52 +00001326 uint64_t DstSize = CGF.CGM.getDataLayout().getTypeAllocSize(DstTy);
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001327
Daniel Dunbar313321e2009-02-03 05:31:23 +00001328 // If store is legal, just bitcast the src pointer.
Daniel Dunbar4be99ff2009-06-05 07:58:54 +00001329 if (SrcSize <= DstSize) {
Yaxun Liue9e5c4f2017-06-29 18:47:45 +00001330 Dst = CGF.Builder.CreateElementBitCast(Dst, SrcTy);
John McCall7f416cc2015-09-08 08:05:57 +00001331 BuildAggStore(CGF, Src, Dst, DstIsVolatile);
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001332 } else {
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001333 // Otherwise do coercion through memory. This is stupid, but
1334 // simple.
Daniel Dunbar4be99ff2009-06-05 07:58:54 +00001335
1336 // Generally SrcSize is never greater than DstSize, since this means we are
1337 // losing bits. However, this can happen in cases where the structure has
1338 // additional padding, for example due to a user specified alignment.
1339 //
1340 // FIXME: Assert that we aren't truncating non-padding bits when have access
1341 // to that information.
John McCall7f416cc2015-09-08 08:05:57 +00001342 Address Tmp = CreateTempAllocaForCoercion(CGF, SrcTy, Dst.getAlignment());
1343 CGF.Builder.CreateStore(Src, Tmp);
Yaxun Liu4bbdebc2018-11-08 16:55:46 +00001344 Address Casted = CGF.Builder.CreateElementBitCast(Tmp,CGF.Int8Ty);
1345 Address DstCasted = CGF.Builder.CreateElementBitCast(Dst,CGF.Int8Ty);
Manman Ren84b921f2012-11-28 22:08:52 +00001346 CGF.Builder.CreateMemCpy(DstCasted, Casted,
1347 llvm::ConstantInt::get(CGF.IntPtrTy, DstSize),
John McCall7f416cc2015-09-08 08:05:57 +00001348 false);
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001349 }
1350}
1351
John McCall7f416cc2015-09-08 08:05:57 +00001352static Address emitAddressAtOffset(CodeGenFunction &CGF, Address addr,
Fangrui Song6907ce22018-07-30 19:24:48 +00001353 const ABIArgInfo &info) {
John McCall7f416cc2015-09-08 08:05:57 +00001354 if (unsigned offset = info.getDirectOffset()) {
1355 addr = CGF.Builder.CreateElementBitCast(addr, CGF.Int8Ty);
1356 addr = CGF.Builder.CreateConstInBoundsByteGEP(addr,
1357 CharUnits::fromQuantity(offset));
1358 addr = CGF.Builder.CreateElementBitCast(addr, info.getCoerceToType());
1359 }
1360 return addr;
1361}
1362
Alexey Samsonov153004f2014-09-29 22:08:00 +00001363namespace {
1364
1365/// Encapsulates information about the way function arguments from
1366/// CGFunctionInfo should be passed to actual LLVM IR function.
1367class ClangToLLVMArgMapping {
1368 static const unsigned InvalidIndex = ~0U;
1369 unsigned InallocaArgNo;
1370 unsigned SRetArgNo;
1371 unsigned TotalIRArgs;
1372
1373 /// Arguments of LLVM IR function corresponding to single Clang argument.
1374 struct IRArgs {
1375 unsigned PaddingArgIndex;
1376 // Argument is expanded to IR arguments at positions
1377 // [FirstArgIndex, FirstArgIndex + NumberOfArgs).
1378 unsigned FirstArgIndex;
1379 unsigned NumberOfArgs;
1380
1381 IRArgs()
1382 : PaddingArgIndex(InvalidIndex), FirstArgIndex(InvalidIndex),
1383 NumberOfArgs(0) {}
1384 };
1385
1386 SmallVector<IRArgs, 8> ArgInfo;
1387
1388public:
1389 ClangToLLVMArgMapping(const ASTContext &Context, const CGFunctionInfo &FI,
1390 bool OnlyRequiredArgs = false)
1391 : InallocaArgNo(InvalidIndex), SRetArgNo(InvalidIndex), TotalIRArgs(0),
1392 ArgInfo(OnlyRequiredArgs ? FI.getNumRequiredArgs() : FI.arg_size()) {
1393 construct(Context, FI, OnlyRequiredArgs);
1394 }
1395
1396 bool hasInallocaArg() const { return InallocaArgNo != InvalidIndex; }
1397 unsigned getInallocaArgNo() const {
1398 assert(hasInallocaArg());
1399 return InallocaArgNo;
1400 }
1401
1402 bool hasSRetArg() const { return SRetArgNo != InvalidIndex; }
1403 unsigned getSRetArgNo() const {
1404 assert(hasSRetArg());
1405 return SRetArgNo;
1406 }
1407
1408 unsigned totalIRArgs() const { return TotalIRArgs; }
1409
1410 bool hasPaddingArg(unsigned ArgNo) const {
1411 assert(ArgNo < ArgInfo.size());
1412 return ArgInfo[ArgNo].PaddingArgIndex != InvalidIndex;
1413 }
1414 unsigned getPaddingArgNo(unsigned ArgNo) const {
1415 assert(hasPaddingArg(ArgNo));
1416 return ArgInfo[ArgNo].PaddingArgIndex;
1417 }
1418
1419 /// Returns index of first IR argument corresponding to ArgNo, and their
1420 /// quantity.
1421 std::pair<unsigned, unsigned> getIRArgs(unsigned ArgNo) const {
1422 assert(ArgNo < ArgInfo.size());
1423 return std::make_pair(ArgInfo[ArgNo].FirstArgIndex,
1424 ArgInfo[ArgNo].NumberOfArgs);
1425 }
1426
1427private:
1428 void construct(const ASTContext &Context, const CGFunctionInfo &FI,
1429 bool OnlyRequiredArgs);
1430};
1431
1432void ClangToLLVMArgMapping::construct(const ASTContext &Context,
1433 const CGFunctionInfo &FI,
1434 bool OnlyRequiredArgs) {
1435 unsigned IRArgNo = 0;
1436 bool SwapThisWithSRet = false;
1437 const ABIArgInfo &RetAI = FI.getReturnInfo();
1438
1439 if (RetAI.getKind() == ABIArgInfo::Indirect) {
1440 SwapThisWithSRet = RetAI.isSRetAfterThis();
1441 SRetArgNo = SwapThisWithSRet ? 1 : IRArgNo++;
1442 }
1443
1444 unsigned ArgNo = 0;
1445 unsigned NumArgs = OnlyRequiredArgs ? FI.getNumRequiredArgs() : FI.arg_size();
1446 for (CGFunctionInfo::const_arg_iterator I = FI.arg_begin(); ArgNo < NumArgs;
1447 ++I, ++ArgNo) {
1448 assert(I != FI.arg_end());
1449 QualType ArgType = I->type;
1450 const ABIArgInfo &AI = I->info;
1451 // Collect data about IR arguments corresponding to Clang argument ArgNo.
1452 auto &IRArgs = ArgInfo[ArgNo];
1453
1454 if (AI.getPaddingType())
1455 IRArgs.PaddingArgIndex = IRArgNo++;
1456
1457 switch (AI.getKind()) {
1458 case ABIArgInfo::Extend:
1459 case ABIArgInfo::Direct: {
1460 // FIXME: handle sseregparm someday...
1461 llvm::StructType *STy = dyn_cast<llvm::StructType>(AI.getCoerceToType());
1462 if (AI.isDirect() && AI.getCanBeFlattened() && STy) {
1463 IRArgs.NumberOfArgs = STy->getNumElements();
1464 } else {
1465 IRArgs.NumberOfArgs = 1;
1466 }
1467 break;
1468 }
1469 case ABIArgInfo::Indirect:
1470 IRArgs.NumberOfArgs = 1;
1471 break;
1472 case ABIArgInfo::Ignore:
1473 case ABIArgInfo::InAlloca:
1474 // ignore and inalloca doesn't have matching LLVM parameters.
1475 IRArgs.NumberOfArgs = 0;
1476 break;
John McCallf26e73d2016-03-11 04:30:43 +00001477 case ABIArgInfo::CoerceAndExpand:
1478 IRArgs.NumberOfArgs = AI.getCoerceAndExpandTypeSequence().size();
1479 break;
1480 case ABIArgInfo::Expand:
Alexey Samsonov153004f2014-09-29 22:08:00 +00001481 IRArgs.NumberOfArgs = getExpansionSize(ArgType, Context);
1482 break;
1483 }
Alexey Samsonov153004f2014-09-29 22:08:00 +00001484
1485 if (IRArgs.NumberOfArgs > 0) {
1486 IRArgs.FirstArgIndex = IRArgNo;
1487 IRArgNo += IRArgs.NumberOfArgs;
1488 }
1489
1490 // Skip over the sret parameter when it comes second. We already handled it
1491 // above.
1492 if (IRArgNo == 1 && SwapThisWithSRet)
1493 IRArgNo++;
1494 }
1495 assert(ArgNo == ArgInfo.size());
1496
1497 if (FI.usesInAlloca())
1498 InallocaArgNo = IRArgNo++;
1499
1500 TotalIRArgs = IRArgNo;
1501}
1502} // namespace
1503
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00001504/***/
1505
Daniel Dunbar6f2e8392010-07-14 23:39:36 +00001506bool CodeGenModule::ReturnTypeUsesSRet(const CGFunctionInfo &FI) {
Saleem Abdulrasoolf181f1a2018-02-28 20:16:12 +00001507 const auto &RI = FI.getReturnInfo();
1508 return RI.isIndirect() || (RI.isInAlloca() && RI.getInAllocaSRet());
Daniel Dunbar7633cbf2009-02-02 21:43:58 +00001509}
1510
Tim Northovere77cc392014-03-29 13:28:05 +00001511bool CodeGenModule::ReturnSlotInterferesWithArgs(const CGFunctionInfo &FI) {
1512 return ReturnTypeUsesSRet(FI) &&
1513 getTargetCodeGenInfo().doesReturnSlotInterfereWithArgs();
1514}
1515
Daniel Dunbar6f2e8392010-07-14 23:39:36 +00001516bool CodeGenModule::ReturnTypeUsesFPRet(QualType ResultType) {
1517 if (const BuiltinType *BT = ResultType->getAs<BuiltinType>()) {
1518 switch (BT->getKind()) {
1519 default:
1520 return false;
1521 case BuiltinType::Float:
John McCallc8e01702013-04-16 22:48:15 +00001522 return getTarget().useObjCFPRetForRealType(TargetInfo::Float);
Daniel Dunbar6f2e8392010-07-14 23:39:36 +00001523 case BuiltinType::Double:
John McCallc8e01702013-04-16 22:48:15 +00001524 return getTarget().useObjCFPRetForRealType(TargetInfo::Double);
Daniel Dunbar6f2e8392010-07-14 23:39:36 +00001525 case BuiltinType::LongDouble:
John McCallc8e01702013-04-16 22:48:15 +00001526 return getTarget().useObjCFPRetForRealType(TargetInfo::LongDouble);
Daniel Dunbar6f2e8392010-07-14 23:39:36 +00001527 }
1528 }
1529
1530 return false;
1531}
1532
Anders Carlsson2f1a6c32011-10-31 16:27:11 +00001533bool CodeGenModule::ReturnTypeUsesFP2Ret(QualType ResultType) {
1534 if (const ComplexType *CT = ResultType->getAs<ComplexType>()) {
1535 if (const BuiltinType *BT = CT->getElementType()->getAs<BuiltinType>()) {
1536 if (BT->getKind() == BuiltinType::LongDouble)
John McCallc8e01702013-04-16 22:48:15 +00001537 return getTarget().useObjCFP2RetForComplexLongDouble();
Anders Carlsson2f1a6c32011-10-31 16:27:11 +00001538 }
1539 }
1540
1541 return false;
1542}
1543
Chris Lattnera5f58b02011-07-09 17:41:47 +00001544llvm::FunctionType *CodeGenTypes::GetFunctionType(GlobalDecl GD) {
John McCalla729c622012-02-17 03:33:10 +00001545 const CGFunctionInfo &FI = arrangeGlobalDeclaration(GD);
1546 return GetFunctionType(FI);
John McCallf8ff7b92010-02-23 00:48:20 +00001547}
1548
Chris Lattnera5f58b02011-07-09 17:41:47 +00001549llvm::FunctionType *
John McCalla729c622012-02-17 03:33:10 +00001550CodeGenTypes::GetFunctionType(const CGFunctionInfo &FI) {
Alexey Samsonov153004f2014-09-29 22:08:00 +00001551
David Blaikie82e95a32014-11-19 07:49:47 +00001552 bool Inserted = FunctionsBeingProcessed.insert(&FI).second;
1553 (void)Inserted;
Chris Lattner6fb0ccf2011-07-15 05:16:14 +00001554 assert(Inserted && "Recursively being processed?");
Daniel Dunbar7a95ca32008-09-10 04:01:49 +00001555
Alexey Samsonov153004f2014-09-29 22:08:00 +00001556 llvm::Type *resultType = nullptr;
John McCall85dd2c52011-05-15 02:19:42 +00001557 const ABIArgInfo &retAI = FI.getReturnInfo();
1558 switch (retAI.getKind()) {
Daniel Dunbard3674e62008-09-11 01:48:57 +00001559 case ABIArgInfo::Expand:
John McCall85dd2c52011-05-15 02:19:42 +00001560 llvm_unreachable("Invalid ABI kind for return argument");
Daniel Dunbard3674e62008-09-11 01:48:57 +00001561
Anton Korobeynikov18adbf52009-06-06 09:36:29 +00001562 case ABIArgInfo::Extend:
Daniel Dunbar67dace892009-02-03 06:17:37 +00001563 case ABIArgInfo::Direct:
John McCall85dd2c52011-05-15 02:19:42 +00001564 resultType = retAI.getCoerceToType();
Daniel Dunbar67dace892009-02-03 06:17:37 +00001565 break;
1566
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001567 case ABIArgInfo::InAlloca:
Reid Klecknerfab1e892014-02-25 00:59:14 +00001568 if (retAI.getInAllocaSRet()) {
1569 // sret things on win32 aren't void, they return the sret pointer.
1570 QualType ret = FI.getReturnType();
1571 llvm::Type *ty = ConvertType(ret);
1572 unsigned addressSpace = Context.getTargetAddressSpace(ret);
1573 resultType = llvm::PointerType::get(ty, addressSpace);
1574 } else {
1575 resultType = llvm::Type::getVoidTy(getLLVMContext());
1576 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001577 break;
1578
John McCall7f416cc2015-09-08 08:05:57 +00001579 case ABIArgInfo::Indirect:
Daniel Dunbar94a6f252009-01-26 21:26:08 +00001580 case ABIArgInfo::Ignore:
John McCall85dd2c52011-05-15 02:19:42 +00001581 resultType = llvm::Type::getVoidTy(getLLVMContext());
Daniel Dunbar94a6f252009-01-26 21:26:08 +00001582 break;
John McCallf26e73d2016-03-11 04:30:43 +00001583
1584 case ABIArgInfo::CoerceAndExpand:
1585 resultType = retAI.getUnpaddedCoerceAndExpandType();
1586 break;
Daniel Dunbar7a95ca32008-09-10 04:01:49 +00001587 }
Mike Stump11289f42009-09-09 15:08:12 +00001588
Alexey Samsonov153004f2014-09-29 22:08:00 +00001589 ClangToLLVMArgMapping IRFunctionArgs(getContext(), FI, true);
1590 SmallVector<llvm::Type*, 8> ArgTypes(IRFunctionArgs.totalIRArgs());
1591
1592 // Add type for sret argument.
1593 if (IRFunctionArgs.hasSRetArg()) {
1594 QualType Ret = FI.getReturnType();
1595 llvm::Type *Ty = ConvertType(Ret);
1596 unsigned AddressSpace = Context.getTargetAddressSpace(Ret);
1597 ArgTypes[IRFunctionArgs.getSRetArgNo()] =
1598 llvm::PointerType::get(Ty, AddressSpace);
1599 }
1600
1601 // Add type for inalloca argument.
1602 if (IRFunctionArgs.hasInallocaArg()) {
1603 auto ArgStruct = FI.getArgStruct();
1604 assert(ArgStruct);
1605 ArgTypes[IRFunctionArgs.getInallocaArgNo()] = ArgStruct->getPointerTo();
1606 }
1607
John McCallc818bbb2012-12-07 07:03:17 +00001608 // Add in all of the required arguments.
Alexey Samsonov153004f2014-09-29 22:08:00 +00001609 unsigned ArgNo = 0;
Alexey Samsonov34625dd2014-09-29 21:21:48 +00001610 CGFunctionInfo::const_arg_iterator it = FI.arg_begin(),
1611 ie = it + FI.getNumRequiredArgs();
Alexey Samsonov153004f2014-09-29 22:08:00 +00001612 for (; it != ie; ++it, ++ArgNo) {
1613 const ABIArgInfo &ArgInfo = it->info;
Mike Stump11289f42009-09-09 15:08:12 +00001614
Rafael Espindolafad28de2012-10-24 01:59:00 +00001615 // Insert a padding type to ensure proper alignment.
Alexey Samsonov153004f2014-09-29 22:08:00 +00001616 if (IRFunctionArgs.hasPaddingArg(ArgNo))
1617 ArgTypes[IRFunctionArgs.getPaddingArgNo(ArgNo)] =
1618 ArgInfo.getPaddingType();
Rafael Espindolafad28de2012-10-24 01:59:00 +00001619
Alexey Samsonov153004f2014-09-29 22:08:00 +00001620 unsigned FirstIRArg, NumIRArgs;
1621 std::tie(FirstIRArg, NumIRArgs) = IRFunctionArgs.getIRArgs(ArgNo);
1622
1623 switch (ArgInfo.getKind()) {
Daniel Dunbar94a6f252009-01-26 21:26:08 +00001624 case ABIArgInfo::Ignore:
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001625 case ABIArgInfo::InAlloca:
Alexey Samsonov153004f2014-09-29 22:08:00 +00001626 assert(NumIRArgs == 0);
Daniel Dunbar94a6f252009-01-26 21:26:08 +00001627 break;
1628
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00001629 case ABIArgInfo::Indirect: {
Alexey Samsonov153004f2014-09-29 22:08:00 +00001630 assert(NumIRArgs == 1);
Yaxun Liud7523282017-04-17 20:10:44 +00001631 // indirect arguments are always on the stack, which is alloca addr space.
Chris Lattner2192fe52011-07-18 04:24:23 +00001632 llvm::Type *LTy = ConvertTypeForMem(it->type);
Yaxun Liud7523282017-04-17 20:10:44 +00001633 ArgTypes[FirstIRArg] = LTy->getPointerTo(
1634 CGM.getDataLayout().getAllocaAddrSpace());
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00001635 break;
1636 }
1637
1638 case ABIArgInfo::Extend:
Chris Lattner2cdfda42010-07-29 06:44:09 +00001639 case ABIArgInfo::Direct: {
Oliver Stannard2bfdc5b2014-08-27 10:43:15 +00001640 // Fast-isel and the optimizer generally like scalar values better than
1641 // FCAs, so we flatten them if this is safe to do for this argument.
Alexey Samsonov153004f2014-09-29 22:08:00 +00001642 llvm::Type *argType = ArgInfo.getCoerceToType();
James Molloy6f244b62014-05-09 16:21:39 +00001643 llvm::StructType *st = dyn_cast<llvm::StructType>(argType);
Alexey Samsonov153004f2014-09-29 22:08:00 +00001644 if (st && ArgInfo.isDirect() && ArgInfo.getCanBeFlattened()) {
1645 assert(NumIRArgs == st->getNumElements());
John McCall85dd2c52011-05-15 02:19:42 +00001646 for (unsigned i = 0, e = st->getNumElements(); i != e; ++i)
Alexey Samsonov153004f2014-09-29 22:08:00 +00001647 ArgTypes[FirstIRArg + i] = st->getElementType(i);
Chris Lattner3dd716c2010-06-28 23:44:11 +00001648 } else {
Alexey Samsonov153004f2014-09-29 22:08:00 +00001649 assert(NumIRArgs == 1);
1650 ArgTypes[FirstIRArg] = argType;
Chris Lattner3dd716c2010-06-28 23:44:11 +00001651 }
Daniel Dunbar2f219b02009-02-03 19:12:28 +00001652 break;
Chris Lattner2cdfda42010-07-29 06:44:09 +00001653 }
Mike Stump11289f42009-09-09 15:08:12 +00001654
John McCallf26e73d2016-03-11 04:30:43 +00001655 case ABIArgInfo::CoerceAndExpand: {
1656 auto ArgTypesIter = ArgTypes.begin() + FirstIRArg;
1657 for (auto EltTy : ArgInfo.getCoerceAndExpandTypeSequence()) {
1658 *ArgTypesIter++ = EltTy;
1659 }
1660 assert(ArgTypesIter == ArgTypes.begin() + FirstIRArg + NumIRArgs);
1661 break;
1662 }
1663
Daniel Dunbard3674e62008-09-11 01:48:57 +00001664 case ABIArgInfo::Expand:
Alexey Samsonov153004f2014-09-29 22:08:00 +00001665 auto ArgTypesIter = ArgTypes.begin() + FirstIRArg;
1666 getExpandedTypes(it->type, ArgTypesIter);
1667 assert(ArgTypesIter == ArgTypes.begin() + FirstIRArg + NumIRArgs);
Daniel Dunbard3674e62008-09-11 01:48:57 +00001668 break;
1669 }
Daniel Dunbar7a95ca32008-09-10 04:01:49 +00001670 }
1671
Chris Lattner6fb0ccf2011-07-15 05:16:14 +00001672 bool Erased = FunctionsBeingProcessed.erase(&FI); (void)Erased;
1673 assert(Erased && "Not in set?");
Alexey Samsonov153004f2014-09-29 22:08:00 +00001674
1675 return llvm::FunctionType::get(resultType, ArgTypes, FI.isVariadic());
Daniel Dunbar81cf67f2008-09-09 23:48:28 +00001676}
1677
Chris Lattner2192fe52011-07-18 04:24:23 +00001678llvm::Type *CodeGenTypes::GetFunctionTypeForVTable(GlobalDecl GD) {
John McCall5d865c322010-08-31 07:33:07 +00001679 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
Anders Carlsson64457732009-11-24 05:08:52 +00001680 const FunctionProtoType *FPT = MD->getType()->getAs<FunctionProtoType>();
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001681
Chris Lattner8806e322011-07-10 00:18:59 +00001682 if (!isFuncTypeConvertible(FPT))
1683 return llvm::StructType::get(getLLVMContext());
Fangrui Song6907ce22018-07-30 19:24:48 +00001684
Chris Lattner8806e322011-07-10 00:18:59 +00001685 const CGFunctionInfo *Info;
1686 if (isa<CXXDestructorDecl>(MD))
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001687 Info =
1688 &arrangeCXXStructorDeclaration(MD, getFromDtorType(GD.getDtorType()));
Chris Lattner8806e322011-07-10 00:18:59 +00001689 else
John McCalla729c622012-02-17 03:33:10 +00001690 Info = &arrangeCXXMethodDeclaration(MD);
1691 return GetFunctionType(*Info);
Anders Carlsson64457732009-11-24 05:08:52 +00001692}
1693
Samuel Antao798f11c2015-11-23 22:04:44 +00001694static void AddAttributesFromFunctionProtoType(ASTContext &Ctx,
1695 llvm::AttrBuilder &FuncAttrs,
1696 const FunctionProtoType *FPT) {
1697 if (!FPT)
1698 return;
1699
1700 if (!isUnresolvedExceptionSpec(FPT->getExceptionSpecType()) &&
Richard Smitheaf11ad2018-05-03 03:58:32 +00001701 FPT->isNothrow())
Samuel Antao798f11c2015-11-23 22:04:44 +00001702 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
1703}
1704
Justin Lebarb080b632017-01-25 21:29:48 +00001705void CodeGenModule::ConstructDefaultFnAttrList(StringRef Name, bool HasOptnone,
1706 bool AttrOnCallSite,
1707 llvm::AttrBuilder &FuncAttrs) {
1708 // OptimizeNoneAttr takes precedence over -Os or -Oz. No warning needed.
1709 if (!HasOptnone) {
1710 if (CodeGenOpts.OptimizeSize)
1711 FuncAttrs.addAttribute(llvm::Attribute::OptimizeForSize);
1712 if (CodeGenOpts.OptimizeSize == 2)
1713 FuncAttrs.addAttribute(llvm::Attribute::MinSize);
1714 }
1715
1716 if (CodeGenOpts.DisableRedZone)
1717 FuncAttrs.addAttribute(llvm::Attribute::NoRedZone);
Kristina Brooks7f569b72018-10-18 14:07:02 +00001718 if (CodeGenOpts.IndirectTlsSegRefs)
1719 FuncAttrs.addAttribute("indirect-tls-seg-refs");
Justin Lebarb080b632017-01-25 21:29:48 +00001720 if (CodeGenOpts.NoImplicitFloat)
1721 FuncAttrs.addAttribute(llvm::Attribute::NoImplicitFloat);
1722
1723 if (AttrOnCallSite) {
1724 // Attributes that should go on the call site only.
1725 if (!CodeGenOpts.SimplifyLibCalls ||
1726 CodeGenOpts.isNoBuiltinFunc(Name.data()))
1727 FuncAttrs.addAttribute(llvm::Attribute::NoBuiltin);
1728 if (!CodeGenOpts.TrapFuncName.empty())
1729 FuncAttrs.addAttribute("trap-func-name", CodeGenOpts.TrapFuncName);
1730 } else {
1731 // Attributes that should go on the function, but not the call site.
1732 if (!CodeGenOpts.DisableFPElim) {
1733 FuncAttrs.addAttribute("no-frame-pointer-elim", "false");
1734 } else if (CodeGenOpts.OmitLeafFramePointer) {
1735 FuncAttrs.addAttribute("no-frame-pointer-elim", "false");
1736 FuncAttrs.addAttribute("no-frame-pointer-elim-non-leaf");
1737 } else {
1738 FuncAttrs.addAttribute("no-frame-pointer-elim", "true");
1739 FuncAttrs.addAttribute("no-frame-pointer-elim-non-leaf");
1740 }
1741
1742 FuncAttrs.addAttribute("less-precise-fpmad",
1743 llvm::toStringRef(CodeGenOpts.LessPreciseFPMAD));
1744
Manoj Guptada08f6a2018-07-19 00:44:52 +00001745 if (CodeGenOpts.NullPointerIsValid)
1746 FuncAttrs.addAttribute("null-pointer-is-valid", "true");
Justin Lebarb080b632017-01-25 21:29:48 +00001747 if (!CodeGenOpts.FPDenormalMode.empty())
1748 FuncAttrs.addAttribute("denormal-fp-math", CodeGenOpts.FPDenormalMode);
1749
1750 FuncAttrs.addAttribute("no-trapping-math",
1751 llvm::toStringRef(CodeGenOpts.NoTrappingMath));
1752
Sanjay Patelc81450e2018-04-30 18:19:03 +00001753 // Strict (compliant) code is the default, so only add this attribute to
1754 // indicate that we are trying to workaround a problem case.
1755 if (!CodeGenOpts.StrictFloatCastOverflow)
1756 FuncAttrs.addAttribute("strict-float-cast-overflow", "false");
Sanjay Pateld1754762018-04-27 14:22:48 +00001757
Justin Lebarb080b632017-01-25 21:29:48 +00001758 // TODO: Are these all needed?
1759 // unsafe/inf/nan/nsz are handled by instruction-level FastMathFlags.
1760 FuncAttrs.addAttribute("no-infs-fp-math",
1761 llvm::toStringRef(CodeGenOpts.NoInfsFPMath));
1762 FuncAttrs.addAttribute("no-nans-fp-math",
1763 llvm::toStringRef(CodeGenOpts.NoNaNsFPMath));
1764 FuncAttrs.addAttribute("unsafe-fp-math",
1765 llvm::toStringRef(CodeGenOpts.UnsafeFPMath));
1766 FuncAttrs.addAttribute("use-soft-float",
1767 llvm::toStringRef(CodeGenOpts.SoftFloat));
1768 FuncAttrs.addAttribute("stack-protector-buffer-size",
1769 llvm::utostr(CodeGenOpts.SSPBufferSize));
1770 FuncAttrs.addAttribute("no-signed-zeros-fp-math",
1771 llvm::toStringRef(CodeGenOpts.NoSignedZeros));
1772 FuncAttrs.addAttribute(
1773 "correctly-rounded-divide-sqrt-fp-math",
1774 llvm::toStringRef(CodeGenOpts.CorrectlyRoundedDivSqrt));
1775
Alexey Sotkin3858e262018-04-20 08:08:04 +00001776 if (getLangOpts().OpenCL)
1777 FuncAttrs.addAttribute("denorms-are-zero",
1778 llvm::toStringRef(CodeGenOpts.FlushDenorm));
1779
Justin Lebarb080b632017-01-25 21:29:48 +00001780 // TODO: Reciprocal estimate codegen options should apply to instructions?
Craig Topper402b4312017-11-20 17:09:22 +00001781 const std::vector<std::string> &Recips = CodeGenOpts.Reciprocals;
Justin Lebarb080b632017-01-25 21:29:48 +00001782 if (!Recips.empty())
1783 FuncAttrs.addAttribute("reciprocal-estimates",
Erich Keane857ac592017-10-27 18:45:06 +00001784 llvm::join(Recips, ","));
Justin Lebarb080b632017-01-25 21:29:48 +00001785
Craig Topper9a724aa2017-12-11 21:09:19 +00001786 if (!CodeGenOpts.PreferVectorWidth.empty() &&
1787 CodeGenOpts.PreferVectorWidth != "none")
1788 FuncAttrs.addAttribute("prefer-vector-width",
1789 CodeGenOpts.PreferVectorWidth);
1790
Justin Lebarb080b632017-01-25 21:29:48 +00001791 if (CodeGenOpts.StackRealignment)
1792 FuncAttrs.addAttribute("stackrealign");
1793 if (CodeGenOpts.Backchain)
1794 FuncAttrs.addAttribute("backchain");
Chandler Carruth664aa862018-09-04 12:38:00 +00001795
Zola Bridgescbac3ad2018-11-27 19:56:46 +00001796 // FIXME: The interaction of this attribute with the SLH command line flag
1797 // has not been determined.
Chandler Carruth664aa862018-09-04 12:38:00 +00001798 if (CodeGenOpts.SpeculativeLoadHardening)
1799 FuncAttrs.addAttribute(llvm::Attribute::SpeculativeLoadHardening);
Justin Lebarb080b632017-01-25 21:29:48 +00001800 }
1801
Matt Arsenaulta1cf61b2017-10-06 19:34:40 +00001802 if (getLangOpts().assumeFunctionsAreConvergent()) {
1803 // Conservatively, mark all functions and calls in CUDA and OpenCL as
1804 // convergent (meaning, they may call an intrinsically convergent op, such
1805 // as __syncthreads() / barrier(), and so can't have certain optimizations
1806 // applied around them). LLVM will remove this attribute where it safely
1807 // can.
Justin Lebarb080b632017-01-25 21:29:48 +00001808 FuncAttrs.addAttribute(llvm::Attribute::Convergent);
Matt Arsenaulta1cf61b2017-10-06 19:34:40 +00001809 }
Justin Lebarb080b632017-01-25 21:29:48 +00001810
Matt Arsenaulta1cf61b2017-10-06 19:34:40 +00001811 if (getLangOpts().CUDA && getLangOpts().CUDAIsDevice) {
Justin Lebarb080b632017-01-25 21:29:48 +00001812 // Exceptions aren't supported in CUDA device code.
1813 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
1814
1815 // Respect -fcuda-flush-denormals-to-zero.
Yaxun Liue1bfbc52018-07-21 02:02:22 +00001816 if (CodeGenOpts.FlushDenorm)
Justin Lebarb080b632017-01-25 21:29:48 +00001817 FuncAttrs.addAttribute("nvptx-f32ftz", "true");
1818 }
1819}
1820
1821void CodeGenModule::AddDefaultFnAttrs(llvm::Function &F) {
1822 llvm::AttrBuilder FuncAttrs;
1823 ConstructDefaultFnAttrList(F.getName(),
1824 F.hasFnAttribute(llvm::Attribute::OptimizeNone),
1825 /* AttrOnCallsite = */ false, FuncAttrs);
Reid Kleckneree4930b2017-05-02 22:07:37 +00001826 F.addAttributes(llvm::AttributeList::FunctionIndex, FuncAttrs);
Justin Lebarb080b632017-01-25 21:29:48 +00001827}
1828
Chad Rosier7dbc9cf2016-01-06 14:35:46 +00001829void CodeGenModule::ConstructAttributeList(
1830 StringRef Name, const CGFunctionInfo &FI, CGCalleeInfo CalleeInfo,
Reid Klecknercdd26792017-04-18 23:50:03 +00001831 llvm::AttributeList &AttrList, unsigned &CallingConv, bool AttrOnCallSite) {
Bill Wendlinga514ebc2012-10-15 20:36:26 +00001832 llvm::AttrBuilder FuncAttrs;
1833 llvm::AttrBuilder RetAttrs;
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00001834
Daniel Dunbar0ef34792009-09-12 00:59:20 +00001835 CallingConv = FI.getEffectiveCallingConvention();
John McCallab26cfa2010-02-05 21:31:56 +00001836 if (FI.isNoReturn())
Bill Wendling207f0532012-12-20 19:27:06 +00001837 FuncAttrs.addAttribute(llvm::Attribute::NoReturn);
John McCallab26cfa2010-02-05 21:31:56 +00001838
Samuel Antao798f11c2015-11-23 22:04:44 +00001839 // If we have information about the function prototype, we can learn
Craig Topper13d759f2018-04-30 22:02:48 +00001840 // attributes from there.
Samuel Antao798f11c2015-11-23 22:04:44 +00001841 AddAttributesFromFunctionProtoType(getContext(), FuncAttrs,
1842 CalleeInfo.getCalleeFunctionProtoType());
1843
Erich Keanede6480a32018-11-13 15:48:08 +00001844 const Decl *TargetDecl = CalleeInfo.getCalleeDecl().getDecl();
Samuel Antao798f11c2015-11-23 22:04:44 +00001845
Justin Lebarb080b632017-01-25 21:29:48 +00001846 bool HasOptnone = false;
Anton Korobeynikovc8478242009-04-04 00:49:24 +00001847 // FIXME: handle sseregparm someday...
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00001848 if (TargetDecl) {
Rafael Espindola2d21ab02011-10-12 19:51:18 +00001849 if (TargetDecl->hasAttr<ReturnsTwiceAttr>())
Bill Wendling207f0532012-12-20 19:27:06 +00001850 FuncAttrs.addAttribute(llvm::Attribute::ReturnsTwice);
Argyrios Kyrtzidisb4b64ca2009-06-30 02:34:44 +00001851 if (TargetDecl->hasAttr<NoThrowAttr>())
Bill Wendling207f0532012-12-20 19:27:06 +00001852 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
Richard Smithdebc59d2013-01-30 05:45:05 +00001853 if (TargetDecl->hasAttr<NoReturnAttr>())
1854 FuncAttrs.addAttribute(llvm::Attribute::NoReturn);
Xinliang David Li4ec36062017-06-13 21:14:07 +00001855 if (TargetDecl->hasAttr<ColdAttr>())
1856 FuncAttrs.addAttribute(llvm::Attribute::Cold);
Aaron Ballman7c19ab12014-02-22 16:59:24 +00001857 if (TargetDecl->hasAttr<NoDuplicateAttr>())
1858 FuncAttrs.addAttribute(llvm::Attribute::NoDuplicate);
Yaxun Liu7d07ae72016-11-01 18:45:32 +00001859 if (TargetDecl->hasAttr<ConvergentAttr>())
1860 FuncAttrs.addAttribute(llvm::Attribute::Convergent);
Zola Bridgescbac3ad2018-11-27 19:56:46 +00001861 if (TargetDecl->hasAttr<SpeculativeLoadHardeningAttr>())
1862 FuncAttrs.addAttribute(llvm::Attribute::SpeculativeLoadHardening);
Richard Smithdebc59d2013-01-30 05:45:05 +00001863
Chandler Carruth45bbe012017-03-24 09:11:57 +00001864 if (const FunctionDecl *Fn = dyn_cast<FunctionDecl>(TargetDecl)) {
Samuel Antao798f11c2015-11-23 22:04:44 +00001865 AddAttributesFromFunctionProtoType(
Chandler Carruth45bbe012017-03-24 09:11:57 +00001866 getContext(), FuncAttrs, Fn->getType()->getAs<FunctionProtoType>());
Richard Smith49af6292013-03-05 08:30:04 +00001867 // Don't use [[noreturn]] or _Noreturn for a call to a virtual function.
1868 // These attributes are not inherited by overloads.
Chandler Carruth45bbe012017-03-24 09:11:57 +00001869 const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(Fn);
1870 if (Fn->isNoReturn() && !(AttrOnCallSite && MD && MD->isVirtual()))
Richard Smithdebc59d2013-01-30 05:45:05 +00001871 FuncAttrs.addAttribute(llvm::Attribute::NoReturn);
John McCallbe349de2010-07-08 06:48:12 +00001872 }
1873
David Majnemer1bf0f8e2015-07-20 22:51:52 +00001874 // 'const', 'pure' and 'noalias' attributed functions are also nounwind.
Eric Christopherbf005ec2011-08-15 22:38:22 +00001875 if (TargetDecl->hasAttr<ConstAttr>()) {
Bill Wendling207f0532012-12-20 19:27:06 +00001876 FuncAttrs.addAttribute(llvm::Attribute::ReadNone);
1877 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
Eric Christopherbf005ec2011-08-15 22:38:22 +00001878 } else if (TargetDecl->hasAttr<PureAttr>()) {
Bill Wendling207f0532012-12-20 19:27:06 +00001879 FuncAttrs.addAttribute(llvm::Attribute::ReadOnly);
1880 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
David Majnemer1bf0f8e2015-07-20 22:51:52 +00001881 } else if (TargetDecl->hasAttr<NoAliasAttr>()) {
1882 FuncAttrs.addAttribute(llvm::Attribute::ArgMemOnly);
1883 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
Eric Christopherbf005ec2011-08-15 22:38:22 +00001884 }
David Majnemer631a90b2015-02-04 07:23:21 +00001885 if (TargetDecl->hasAttr<RestrictAttr>())
Bill Wendling207f0532012-12-20 19:27:06 +00001886 RetAttrs.addAttribute(llvm::Attribute::NoAlias);
Manoj Guptada08f6a2018-07-19 00:44:52 +00001887 if (TargetDecl->hasAttr<ReturnsNonNullAttr>() &&
1888 !CodeGenOpts.NullPointerIsValid)
Hal Finkeld8442b12014-07-12 04:51:04 +00001889 RetAttrs.addAttribute(llvm::Attribute::NonNull);
Oren Ben Simhon318a6ea2017-04-27 12:01:00 +00001890 if (TargetDecl->hasAttr<AnyX86NoCallerSavedRegistersAttr>())
1891 FuncAttrs.addAttribute("no_caller_saved_registers");
Oren Ben Simhon220671a2018-03-17 13:31:35 +00001892 if (TargetDecl->hasAttr<AnyX86NoCfCheckAttr>())
1893 FuncAttrs.addAttribute(llvm::Attribute::NoCfCheck);
Paul Robinson08556952014-12-11 20:14:04 +00001894
1895 HasOptnone = TargetDecl->hasAttr<OptimizeNoneAttr>();
George Burgess IVe3763372016-12-22 02:50:20 +00001896 if (auto *AllocSize = TargetDecl->getAttr<AllocSizeAttr>()) {
1897 Optional<unsigned> NumElemsParam;
Joel E. Denny81508102018-03-13 14:51:22 +00001898 if (AllocSize->getNumElemsParam().isValid())
1899 NumElemsParam = AllocSize->getNumElemsParam().getLLVMIndex();
1900 FuncAttrs.addAllocSizeAttr(AllocSize->getElemSizeParam().getLLVMIndex(),
George Burgess IVe3763372016-12-22 02:50:20 +00001901 NumElemsParam);
1902 }
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00001903 }
1904
Justin Lebarb080b632017-01-25 21:29:48 +00001905 ConstructDefaultFnAttrList(Name, HasOptnone, AttrOnCallSite, FuncAttrs);
Paul Robinson08556952014-12-11 20:14:04 +00001906
Peter Collingbourneb4728c12014-05-19 22:14:34 +00001907 if (CodeGenOpts.EnableSegmentedStacks &&
1908 !(TargetDecl && TargetDecl->hasAttr<NoSplitStackAttr>()))
Reid Klecknerfb873af2014-04-10 22:59:13 +00001909 FuncAttrs.addAttribute("split-stack");
Devang Patel6e467b12009-06-04 23:32:02 +00001910
Sriraman Tallam5c651482017-11-07 19:37:51 +00001911 // Add NonLazyBind attribute to function declarations when -fno-plt
1912 // is used.
1913 if (TargetDecl && CodeGenOpts.NoPLT) {
1914 if (auto *Fn = dyn_cast<FunctionDecl>(TargetDecl)) {
1915 if (!Fn->isDefined() && !AttrOnCallSite) {
1916 FuncAttrs.addAttribute(llvm::Attribute::NonLazyBind);
1917 }
1918 }
1919 }
1920
Alexey Sotkin20f65922018-02-22 11:54:14 +00001921 if (TargetDecl && TargetDecl->hasAttr<OpenCLKernelAttr>()) {
1922 if (getLangOpts().OpenCLVersion <= 120) {
1923 // OpenCL v1.2 Work groups are always uniform
1924 FuncAttrs.addAttribute("uniform-work-group-size", "true");
1925 } else {
1926 // OpenCL v2.0 Work groups may be whether uniform or not.
1927 // '-cl-uniform-work-group-size' compile option gets a hint
1928 // to the compiler that the global work-size be a multiple of
1929 // the work-group size specified to clEnqueueNDRangeKernel
1930 // (i.e. work groups are uniform).
1931 FuncAttrs.addAttribute("uniform-work-group-size",
1932 llvm::toStringRef(CodeGenOpts.UniformWGSize));
1933 }
1934 }
1935
Justin Lebarb080b632017-01-25 21:29:48 +00001936 if (!AttrOnCallSite) {
Akira Hatanaka627586b2018-03-02 01:53:15 +00001937 bool DisableTailCalls = false;
1938
1939 if (CodeGenOpts.DisableTailCalls)
1940 DisableTailCalls = true;
1941 else if (TargetDecl) {
1942 if (TargetDecl->hasAttr<DisableTailCallsAttr>() ||
1943 TargetDecl->hasAttr<AnyX86InterruptAttr>())
1944 DisableTailCalls = true;
1945 else if (CodeGenOpts.NoEscapingBlockTailCalls) {
1946 if (const auto *BD = dyn_cast<BlockDecl>(TargetDecl))
1947 if (!BD->doesNotEscape())
1948 DisableTailCalls = true;
1949 }
1950 }
1951
Justin Lebarb080b632017-01-25 21:29:48 +00001952 FuncAttrs.addAttribute("disable-tail-calls",
1953 llvm::toStringRef(DisableTailCalls));
Erich Keanede6480a32018-11-13 15:48:08 +00001954 GetCPUAndFeaturesAttributes(CalleeInfo.getCalleeDecl(), FuncAttrs);
Bill Wendling985d1c52013-02-15 21:30:01 +00001955 }
1956
Alexey Samsonov153004f2014-09-29 22:08:00 +00001957 ClangToLLVMArgMapping IRFunctionArgs(getContext(), FI);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00001958
Daniel Dunbar3668cb22009-02-02 23:43:58 +00001959 QualType RetTy = FI.getReturnType();
Daniel Dunbarb52d0772009-02-03 05:59:18 +00001960 const ABIArgInfo &RetAI = FI.getReturnInfo();
Daniel Dunbar7a95ca32008-09-10 04:01:49 +00001961 switch (RetAI.getKind()) {
Anton Korobeynikov18adbf52009-06-06 09:36:29 +00001962 case ABIArgInfo::Extend:
Alex Bradburye41a5e22018-01-12 20:08:16 +00001963 if (RetAI.isSignExt())
Jakob Stoklund Olesend7bf2932013-05-29 03:57:23 +00001964 RetAttrs.addAttribute(llvm::Attribute::SExt);
Alex Bradburye41a5e22018-01-12 20:08:16 +00001965 else
Jakob Stoklund Olesend7bf2932013-05-29 03:57:23 +00001966 RetAttrs.addAttribute(llvm::Attribute::ZExt);
Adrian Prantlf3b3ccd2017-12-19 22:06:11 +00001967 LLVM_FALLTHROUGH;
Daniel Dunbar67dace892009-02-03 06:17:37 +00001968 case ABIArgInfo::Direct:
Jakob Stoklund Olesena3661142013-06-05 03:00:09 +00001969 if (RetAI.getInReg())
1970 RetAttrs.addAttribute(llvm::Attribute::InReg);
1971 break;
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00001972 case ABIArgInfo::Ignore:
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00001973 break;
1974
Alexey Samsonov91cf4552014-08-22 01:06:06 +00001975 case ABIArgInfo::InAlloca:
Rafael Espindola06b2b4a2012-07-31 02:44:24 +00001976 case ABIArgInfo::Indirect: {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00001977 // inalloca and sret disable readnone and readonly
Bill Wendling207f0532012-12-20 19:27:06 +00001978 FuncAttrs.removeAttribute(llvm::Attribute::ReadOnly)
1979 .removeAttribute(llvm::Attribute::ReadNone);
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00001980 break;
Rafael Espindola06b2b4a2012-07-31 02:44:24 +00001981 }
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00001982
John McCallf26e73d2016-03-11 04:30:43 +00001983 case ABIArgInfo::CoerceAndExpand:
1984 break;
1985
Daniel Dunbard3674e62008-09-11 01:48:57 +00001986 case ABIArgInfo::Expand:
David Blaikie83d382b2011-09-23 05:06:16 +00001987 llvm_unreachable("Invalid ABI kind for return argument");
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00001988 }
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00001989
Hal Finkela2347ba2014-07-18 15:52:10 +00001990 if (const auto *RefTy = RetTy->getAs<ReferenceType>()) {
1991 QualType PTy = RefTy->getPointeeType();
David Majnemer9df56372015-09-10 21:52:00 +00001992 if (!PTy->isIncompleteType() && PTy->isConstantSizeType())
Hal Finkela2347ba2014-07-18 15:52:10 +00001993 RetAttrs.addDereferenceableAttr(getContext().getTypeSizeInChars(PTy)
1994 .getQuantity());
Manoj Guptada08f6a2018-07-19 00:44:52 +00001995 else if (getContext().getTargetAddressSpace(PTy) == 0 &&
1996 !CodeGenOpts.NullPointerIsValid)
Hal Finkela2347ba2014-07-18 15:52:10 +00001997 RetAttrs.addAttribute(llvm::Attribute::NonNull);
1998 }
Nick Lewycky9b46eb82014-05-28 09:56:42 +00001999
John McCall12f23522016-04-04 18:33:08 +00002000 bool hasUsedSRet = false;
Reid Klecknercdd26792017-04-18 23:50:03 +00002001 SmallVector<llvm::AttributeSet, 4> ArgAttrs(IRFunctionArgs.totalIRArgs());
John McCall12f23522016-04-04 18:33:08 +00002002
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002003 // Attach attributes to sret.
2004 if (IRFunctionArgs.hasSRetArg()) {
2005 llvm::AttrBuilder SRETAttrs;
Mandeep Singh Grang2a153102018-07-26 18:07:59 +00002006 if (!RetAI.getSuppressSRet())
2007 SRETAttrs.addAttribute(llvm::Attribute::StructRet);
John McCall12f23522016-04-04 18:33:08 +00002008 hasUsedSRet = true;
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002009 if (RetAI.getInReg())
2010 SRETAttrs.addAttribute(llvm::Attribute::InReg);
Reid Klecknercdd26792017-04-18 23:50:03 +00002011 ArgAttrs[IRFunctionArgs.getSRetArgNo()] =
2012 llvm::AttributeSet::get(getLLVMContext(), SRETAttrs);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002013 }
2014
2015 // Attach attributes to inalloca argument.
2016 if (IRFunctionArgs.hasInallocaArg()) {
2017 llvm::AttrBuilder Attrs;
2018 Attrs.addAttribute(llvm::Attribute::InAlloca);
Reid Klecknercdd26792017-04-18 23:50:03 +00002019 ArgAttrs[IRFunctionArgs.getInallocaArgNo()] =
2020 llvm::AttributeSet::get(getLLVMContext(), Attrs);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002021 }
2022
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002023 unsigned ArgNo = 0;
2024 for (CGFunctionInfo::const_arg_iterator I = FI.arg_begin(),
2025 E = FI.arg_end();
2026 I != E; ++I, ++ArgNo) {
2027 QualType ParamType = I->type;
2028 const ABIArgInfo &AI = I->info;
Bill Wendlinga514ebc2012-10-15 20:36:26 +00002029 llvm::AttrBuilder Attrs;
Anton Korobeynikovc8478242009-04-04 00:49:24 +00002030
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002031 // Add attribute for padding argument, if necessary.
2032 if (IRFunctionArgs.hasPaddingArg(ArgNo)) {
Reid Klecknercdd26792017-04-18 23:50:03 +00002033 if (AI.getPaddingInReg()) {
2034 ArgAttrs[IRFunctionArgs.getPaddingArgNo(ArgNo)] =
2035 llvm::AttributeSet::get(
2036 getLLVMContext(),
2037 llvm::AttrBuilder().addAttribute(llvm::Attribute::InReg));
2038 }
Rafael Espindolafad28de2012-10-24 01:59:00 +00002039 }
2040
John McCall39ec71f2010-03-27 00:47:27 +00002041 // 'restrict' -> 'noalias' is done in EmitFunctionProlog when we
2042 // have the corresponding parameter variable. It doesn't make
Daniel Dunbarcb2b3d02011-02-10 18:10:07 +00002043 // sense to do it here because parameters are so messed up.
Daniel Dunbard3674e62008-09-11 01:48:57 +00002044 switch (AI.getKind()) {
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002045 case ABIArgInfo::Extend:
Alex Bradburye41a5e22018-01-12 20:08:16 +00002046 if (AI.isSignExt())
Bill Wendling207f0532012-12-20 19:27:06 +00002047 Attrs.addAttribute(llvm::Attribute::SExt);
Alex Bradburye41a5e22018-01-12 20:08:16 +00002048 else
2049 Attrs.addAttribute(llvm::Attribute::ZExt);
Adrian Prantlf3b3ccd2017-12-19 22:06:11 +00002050 LLVM_FALLTHROUGH;
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002051 case ABIArgInfo::Direct:
Peter Collingbournef7706832014-12-12 23:41:25 +00002052 if (ArgNo == 0 && FI.isChainCall())
2053 Attrs.addAttribute(llvm::Attribute::Nest);
2054 else if (AI.getInReg())
Bill Wendling207f0532012-12-20 19:27:06 +00002055 Attrs.addAttribute(llvm::Attribute::InReg);
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002056 break;
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002057
James Y Knight71608572015-08-21 18:19:06 +00002058 case ABIArgInfo::Indirect: {
Rafael Espindola703c47f2012-10-19 05:04:37 +00002059 if (AI.getInReg())
Bill Wendling207f0532012-12-20 19:27:06 +00002060 Attrs.addAttribute(llvm::Attribute::InReg);
Rafael Espindola703c47f2012-10-19 05:04:37 +00002061
Anders Carlsson20759ad2009-09-16 15:53:40 +00002062 if (AI.getIndirectByVal())
Bill Wendling207f0532012-12-20 19:27:06 +00002063 Attrs.addAttribute(llvm::Attribute::ByVal);
Anders Carlsson20759ad2009-09-16 15:53:40 +00002064
John McCall7f416cc2015-09-08 08:05:57 +00002065 CharUnits Align = AI.getIndirectAlign();
James Y Knight71608572015-08-21 18:19:06 +00002066
2067 // In a byval argument, it is important that the required
2068 // alignment of the type is honored, as LLVM might be creating a
2069 // *new* stack object, and needs to know what alignment to give
2070 // it. (Sometimes it can deduce a sensible alignment on its own,
2071 // but not if clang decides it must emit a packed struct, or the
2072 // user specifies increased alignment requirements.)
2073 //
2074 // This is different from indirect *not* byval, where the object
2075 // exists already, and the align attribute is purely
2076 // informative.
John McCall7f416cc2015-09-08 08:05:57 +00002077 assert(!Align.isZero());
James Y Knight71608572015-08-21 18:19:06 +00002078
John McCall7f416cc2015-09-08 08:05:57 +00002079 // For now, only add this when we have a byval argument.
2080 // TODO: be less lazy about updating test cases.
2081 if (AI.getIndirectByVal())
2082 Attrs.addAlignmentAttr(Align.getQuantity());
Bill Wendlinga7912f82012-10-10 07:36:56 +00002083
Daniel Dunbarc2304432009-03-18 19:51:01 +00002084 // byval disables readnone and readonly.
Bill Wendling207f0532012-12-20 19:27:06 +00002085 FuncAttrs.removeAttribute(llvm::Attribute::ReadOnly)
2086 .removeAttribute(llvm::Attribute::ReadNone);
Daniel Dunbard3674e62008-09-11 01:48:57 +00002087 break;
James Y Knight71608572015-08-21 18:19:06 +00002088 }
Daniel Dunbar94a6f252009-01-26 21:26:08 +00002089 case ABIArgInfo::Ignore:
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002090 case ABIArgInfo::Expand:
John McCallf26e73d2016-03-11 04:30:43 +00002091 case ABIArgInfo::CoerceAndExpand:
2092 break;
Daniel Dunbar94a6f252009-01-26 21:26:08 +00002093
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002094 case ABIArgInfo::InAlloca:
2095 // inalloca disables readnone and readonly.
2096 FuncAttrs.removeAttribute(llvm::Attribute::ReadOnly)
2097 .removeAttribute(llvm::Attribute::ReadNone);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002098 continue;
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00002099 }
Mike Stump11289f42009-09-09 15:08:12 +00002100
Hal Finkela2347ba2014-07-18 15:52:10 +00002101 if (const auto *RefTy = ParamType->getAs<ReferenceType>()) {
2102 QualType PTy = RefTy->getPointeeType();
David Majnemer9df56372015-09-10 21:52:00 +00002103 if (!PTy->isIncompleteType() && PTy->isConstantSizeType())
Hal Finkela2347ba2014-07-18 15:52:10 +00002104 Attrs.addDereferenceableAttr(getContext().getTypeSizeInChars(PTy)
2105 .getQuantity());
Manoj Guptada08f6a2018-07-19 00:44:52 +00002106 else if (getContext().getTargetAddressSpace(PTy) == 0 &&
2107 !CodeGenOpts.NullPointerIsValid)
Hal Finkela2347ba2014-07-18 15:52:10 +00002108 Attrs.addAttribute(llvm::Attribute::NonNull);
2109 }
Nick Lewycky9b46eb82014-05-28 09:56:42 +00002110
John McCall12f23522016-04-04 18:33:08 +00002111 switch (FI.getExtParameterInfo(ArgNo).getABI()) {
2112 case ParameterABI::Ordinary:
2113 break;
2114
2115 case ParameterABI::SwiftIndirectResult: {
2116 // Add 'sret' if we haven't already used it for something, but
2117 // only if the result is void.
2118 if (!hasUsedSRet && RetTy->isVoidType()) {
2119 Attrs.addAttribute(llvm::Attribute::StructRet);
2120 hasUsedSRet = true;
2121 }
2122
2123 // Add 'noalias' in either case.
2124 Attrs.addAttribute(llvm::Attribute::NoAlias);
2125
2126 // Add 'dereferenceable' and 'alignment'.
2127 auto PTy = ParamType->getPointeeType();
2128 if (!PTy->isIncompleteType() && PTy->isConstantSizeType()) {
2129 auto info = getContext().getTypeInfoInChars(PTy);
2130 Attrs.addDereferenceableAttr(info.first.getQuantity());
2131 Attrs.addAttribute(llvm::Attribute::getWithAlignment(getLLVMContext(),
2132 info.second.getQuantity()));
2133 }
2134 break;
2135 }
2136
2137 case ParameterABI::SwiftErrorResult:
2138 Attrs.addAttribute(llvm::Attribute::SwiftError);
2139 break;
2140
2141 case ParameterABI::SwiftContext:
2142 Attrs.addAttribute(llvm::Attribute::SwiftSelf);
2143 break;
2144 }
2145
Akira Hatanaka98a49332017-09-22 00:41:05 +00002146 if (FI.getExtParameterInfo(ArgNo).isNoEscape())
2147 Attrs.addAttribute(llvm::Attribute::NoCapture);
2148
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002149 if (Attrs.hasAttributes()) {
2150 unsigned FirstIRArg, NumIRArgs;
2151 std::tie(FirstIRArg, NumIRArgs) = IRFunctionArgs.getIRArgs(ArgNo);
2152 for (unsigned i = 0; i < NumIRArgs; i++)
Reid Klecknercdd26792017-04-18 23:50:03 +00002153 ArgAttrs[FirstIRArg + i] =
2154 llvm::AttributeSet::get(getLLVMContext(), Attrs);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002155 }
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00002156 }
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002157 assert(ArgNo == FI.arg_size());
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002158
Reid Klecknercdd26792017-04-18 23:50:03 +00002159 AttrList = llvm::AttributeList::get(
2160 getLLVMContext(), llvm::AttributeSet::get(getLLVMContext(), FuncAttrs),
2161 llvm::AttributeSet::get(getLLVMContext(), RetAttrs), ArgAttrs);
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00002162}
2163
John McCalla738c252011-03-09 04:27:21 +00002164/// An argument came in as a promoted argument; demote it back to its
2165/// declared type.
2166static llvm::Value *emitArgumentDemotion(CodeGenFunction &CGF,
2167 const VarDecl *var,
2168 llvm::Value *value) {
Chris Lattner2192fe52011-07-18 04:24:23 +00002169 llvm::Type *varType = CGF.ConvertType(var->getType());
John McCalla738c252011-03-09 04:27:21 +00002170
2171 // This can happen with promotions that actually don't change the
2172 // underlying type, like the enum promotions.
2173 if (value->getType() == varType) return value;
2174
2175 assert((varType->isIntegerTy() || varType->isFloatingPointTy())
2176 && "unexpected promotion type");
2177
2178 if (isa<llvm::IntegerType>(varType))
2179 return CGF.Builder.CreateTrunc(value, varType, "arg.unpromote");
2180
2181 return CGF.Builder.CreateFPCast(value, varType, "arg.unpromote");
2182}
2183
Chandler Carruth45bbe012017-03-24 09:11:57 +00002184/// Returns the attribute (either parameter attribute, or function
2185/// attribute), which declares argument ArgNo to be non-null.
2186static const NonNullAttr *getNonNullAttr(const Decl *FD, const ParmVarDecl *PVD,
2187 QualType ArgType, unsigned ArgNo) {
2188 // FIXME: __attribute__((nonnull)) can also be applied to:
2189 // - references to pointers, where the pointee is known to be
2190 // nonnull (apparently a Clang extension)
2191 // - transparent unions containing pointers
2192 // In the former case, LLVM IR cannot represent the constraint. In
2193 // the latter case, we have no guarantee that the transparent union
2194 // is in fact passed as a pointer.
2195 if (!ArgType->isAnyPointerType() && !ArgType->isBlockPointerType())
2196 return nullptr;
2197 // First, check attribute on parameter itself.
2198 if (PVD) {
2199 if (auto ParmNNAttr = PVD->getAttr<NonNullAttr>())
2200 return ParmNNAttr;
2201 }
2202 // Check function attributes.
2203 if (!FD)
2204 return nullptr;
2205 for (const auto *NNAttr : FD->specific_attrs<NonNullAttr>()) {
2206 if (NNAttr->isNonNull(ArgNo))
2207 return NNAttr;
2208 }
2209 return nullptr;
2210}
2211
John McCall12f23522016-04-04 18:33:08 +00002212namespace {
2213 struct CopyBackSwiftError final : EHScopeStack::Cleanup {
2214 Address Temp;
2215 Address Arg;
2216 CopyBackSwiftError(Address temp, Address arg) : Temp(temp), Arg(arg) {}
2217 void Emit(CodeGenFunction &CGF, Flags flags) override {
2218 llvm::Value *errorValue = CGF.Builder.CreateLoad(Temp);
2219 CGF.Builder.CreateStore(errorValue, Arg);
2220 }
2221 };
2222}
2223
Daniel Dunbard931a872009-02-02 22:03:45 +00002224void CodeGenFunction::EmitFunctionProlog(const CGFunctionInfo &FI,
2225 llvm::Function *Fn,
Daniel Dunbar613855c2008-09-09 23:27:19 +00002226 const FunctionArgList &Args) {
Hans Wennborgd71907d2014-09-04 22:16:33 +00002227 if (CurCodeDecl && CurCodeDecl->hasAttr<NakedAttr>())
2228 // Naked functions don't have prologues.
2229 return;
2230
John McCallcaa19452009-07-28 01:00:58 +00002231 // If this is an implicit-return-zero function, go ahead and
2232 // initialize the return value. TODO: it might be nice to have
2233 // a more general mechanism for this that didn't require synthesized
2234 // return statements.
John McCalldec348f72013-05-03 07:33:41 +00002235 if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(CurCodeDecl)) {
John McCallcaa19452009-07-28 01:00:58 +00002236 if (FD->hasImplicitReturnZero()) {
Alp Toker314cc812014-01-25 16:55:45 +00002237 QualType RetTy = FD->getReturnType().getUnqualifiedType();
Chris Lattner2192fe52011-07-18 04:24:23 +00002238 llvm::Type* LLVMTy = CGM.getTypes().ConvertType(RetTy);
Owen Anderson0b75f232009-07-31 20:28:54 +00002239 llvm::Constant* Zero = llvm::Constant::getNullValue(LLVMTy);
John McCallcaa19452009-07-28 01:00:58 +00002240 Builder.CreateStore(Zero, ReturnValue);
2241 }
2242 }
2243
Mike Stump18bb9282009-05-16 07:57:57 +00002244 // FIXME: We no longer need the types from FunctionArgList; lift up and
2245 // simplify.
Daniel Dunbar5a0acdc92009-02-03 06:02:10 +00002246
Alexey Samsonov153004f2014-09-29 22:08:00 +00002247 ClangToLLVMArgMapping IRFunctionArgs(CGM.getContext(), FI);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002248 // Flattened function arguments.
John McCall12f23522016-04-04 18:33:08 +00002249 SmallVector<llvm::Value *, 16> FnArgs;
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002250 FnArgs.reserve(IRFunctionArgs.totalIRArgs());
2251 for (auto &Arg : Fn->args()) {
2252 FnArgs.push_back(&Arg);
2253 }
2254 assert(FnArgs.size() == IRFunctionArgs.totalIRArgs());
Mike Stump11289f42009-09-09 15:08:12 +00002255
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002256 // If we're using inalloca, all the memory arguments are GEPs off of the last
2257 // parameter, which is a pointer to the complete memory area.
John McCall7f416cc2015-09-08 08:05:57 +00002258 Address ArgStruct = Address::invalid();
2259 const llvm::StructLayout *ArgStructLayout = nullptr;
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002260 if (IRFunctionArgs.hasInallocaArg()) {
John McCall7f416cc2015-09-08 08:05:57 +00002261 ArgStructLayout = CGM.getDataLayout().getStructLayout(FI.getArgStruct());
2262 ArgStruct = Address(FnArgs[IRFunctionArgs.getInallocaArgNo()],
2263 FI.getArgStructAlignment());
2264
2265 assert(ArgStruct.getType() == FI.getArgStruct()->getPointerTo());
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002266 }
2267
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002268 // Name the struct return parameter.
2269 if (IRFunctionArgs.hasSRetArg()) {
John McCall12f23522016-04-04 18:33:08 +00002270 auto AI = cast<llvm::Argument>(FnArgs[IRFunctionArgs.getSRetArgNo()]);
Daniel Dunbar613855c2008-09-09 23:27:19 +00002271 AI->setName("agg.result");
Reid Klecknercdd26792017-04-18 23:50:03 +00002272 AI->addAttr(llvm::Attribute::NoAlias);
Daniel Dunbar613855c2008-09-09 23:27:19 +00002273 }
Mike Stump11289f42009-09-09 15:08:12 +00002274
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002275 // Track if we received the parameter as a pointer (indirect, byval, or
2276 // inalloca). If already have a pointer, EmitParmDecl doesn't need to copy it
2277 // into a local alloca for us.
John McCall7f416cc2015-09-08 08:05:57 +00002278 SmallVector<ParamValue, 16> ArgVals;
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002279 ArgVals.reserve(Args.size());
2280
Reid Kleckner739756c2013-12-04 19:23:12 +00002281 // Create a pointer value for every parameter declaration. This usually
2282 // entails copying one or more LLVM IR arguments into an alloca. Don't push
2283 // any cleanups or do anything that might unwind. We do that separately, so
2284 // we can push the cleanups in the correct order for the ABI.
Daniel Dunbara45bdbb2009-02-04 21:17:21 +00002285 assert(FI.arg_size() == Args.size() &&
2286 "Mismatch between function signature & arguments.");
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002287 unsigned ArgNo = 0;
Daniel Dunbarb52d0772009-02-03 05:59:18 +00002288 CGFunctionInfo::const_arg_iterator info_it = FI.arg_begin();
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002289 for (FunctionArgList::const_iterator i = Args.begin(), e = Args.end();
Devang Patel68a15252011-03-03 20:13:15 +00002290 i != e; ++i, ++info_it, ++ArgNo) {
John McCalla738c252011-03-09 04:27:21 +00002291 const VarDecl *Arg = *i;
Daniel Dunbarb52d0772009-02-03 05:59:18 +00002292 const ABIArgInfo &ArgI = info_it->info;
Daniel Dunbard3674e62008-09-11 01:48:57 +00002293
John McCalla738c252011-03-09 04:27:21 +00002294 bool isPromoted =
2295 isa<ParmVarDecl>(Arg) && cast<ParmVarDecl>(Arg)->isKNRPromoted();
Volodymyr Sapsai17ebdb22018-01-22 22:29:24 +00002296 // We are converting from ABIArgInfo type to VarDecl type directly, unless
2297 // the parameter is promoted. In this case we convert to
2298 // CGFunctionInfo::ArgInfo type with subsequent argument demotion.
2299 QualType Ty = isPromoted ? info_it->type : Arg->getType();
2300 assert(hasScalarEvaluationKind(Ty) ==
2301 hasScalarEvaluationKind(Arg->getType()));
John McCalla738c252011-03-09 04:27:21 +00002302
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002303 unsigned FirstIRArg, NumIRArgs;
2304 std::tie(FirstIRArg, NumIRArgs) = IRFunctionArgs.getIRArgs(ArgNo);
Rafael Espindolafad28de2012-10-24 01:59:00 +00002305
Daniel Dunbard3674e62008-09-11 01:48:57 +00002306 switch (ArgI.getKind()) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002307 case ABIArgInfo::InAlloca: {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002308 assert(NumIRArgs == 0);
John McCall7f416cc2015-09-08 08:05:57 +00002309 auto FieldIndex = ArgI.getInAllocaFieldIndex();
2310 CharUnits FieldOffset =
2311 CharUnits::fromQuantity(ArgStructLayout->getElementOffset(FieldIndex));
2312 Address V = Builder.CreateStructGEP(ArgStruct, FieldIndex, FieldOffset,
2313 Arg->getName());
2314 ArgVals.push_back(ParamValue::forIndirect(V));
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002315 break;
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002316 }
2317
Daniel Dunbar747865a2009-02-05 09:16:39 +00002318 case ABIArgInfo::Indirect: {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002319 assert(NumIRArgs == 1);
John McCall7f416cc2015-09-08 08:05:57 +00002320 Address ParamAddr = Address(FnArgs[FirstIRArg], ArgI.getIndirectAlign());
Daniel Dunbar7b7c2932010-09-16 20:42:02 +00002321
John McCall47fb9502013-03-07 21:37:08 +00002322 if (!hasScalarEvaluationKind(Ty)) {
Daniel Dunbar7b7c2932010-09-16 20:42:02 +00002323 // Aggregates and complex variables are accessed by reference. All we
John McCall7f416cc2015-09-08 08:05:57 +00002324 // need to do is realign the value, if requested.
2325 Address V = ParamAddr;
Daniel Dunbar7b7c2932010-09-16 20:42:02 +00002326 if (ArgI.getIndirectRealign()) {
John McCall7f416cc2015-09-08 08:05:57 +00002327 Address AlignedTemp = CreateMemTemp(Ty, "coerce");
Daniel Dunbar7b7c2932010-09-16 20:42:02 +00002328
2329 // Copy from the incoming argument pointer to the temporary with the
2330 // appropriate alignment.
2331 //
2332 // FIXME: We should have a common utility for generating an aggregate
2333 // copy.
Ken Dyck705ba072011-01-19 01:58:38 +00002334 CharUnits Size = getContext().getTypeSizeInChars(Ty);
John McCall7f416cc2015-09-08 08:05:57 +00002335 auto SizeVal = llvm::ConstantInt::get(IntPtrTy, Size.getQuantity());
2336 Address Dst = Builder.CreateBitCast(AlignedTemp, Int8PtrTy);
2337 Address Src = Builder.CreateBitCast(ParamAddr, Int8PtrTy);
2338 Builder.CreateMemCpy(Dst, Src, SizeVal, false);
Daniel Dunbar7b7c2932010-09-16 20:42:02 +00002339 V = AlignedTemp;
2340 }
John McCall7f416cc2015-09-08 08:05:57 +00002341 ArgVals.push_back(ParamValue::forIndirect(V));
Daniel Dunbar747865a2009-02-05 09:16:39 +00002342 } else {
2343 // Load scalar value from indirect argument.
John McCall7f416cc2015-09-08 08:05:57 +00002344 llvm::Value *V =
Stephen Kellyf2ceec42018-08-09 21:08:08 +00002345 EmitLoadOfScalar(ParamAddr, false, Ty, Arg->getBeginLoc());
John McCalla738c252011-03-09 04:27:21 +00002346
2347 if (isPromoted)
2348 V = emitArgumentDemotion(*this, Arg, V);
John McCall7f416cc2015-09-08 08:05:57 +00002349 ArgVals.push_back(ParamValue::forDirect(V));
Daniel Dunbar747865a2009-02-05 09:16:39 +00002350 }
Daniel Dunbar747865a2009-02-05 09:16:39 +00002351 break;
2352 }
Anton Korobeynikov18adbf52009-06-06 09:36:29 +00002353
2354 case ABIArgInfo::Extend:
Daniel Dunbar67dace892009-02-03 06:17:37 +00002355 case ABIArgInfo::Direct: {
Akira Hatanaka18334dd2012-01-09 19:08:06 +00002356
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002357 // If we have the trivial case, handle it with no muss and fuss.
2358 if (!isa<llvm::StructType>(ArgI.getCoerceToType()) &&
Volodymyr Sapsai22b00ec2017-12-21 20:52:59 +00002359 ArgI.getCoerceToType() == ConvertType(Ty) &&
Chris Lattner8a2f3c72010-07-30 04:02:24 +00002360 ArgI.getDirectOffset() == 0) {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002361 assert(NumIRArgs == 1);
John McCall12f23522016-04-04 18:33:08 +00002362 llvm::Value *V = FnArgs[FirstIRArg];
2363 auto AI = cast<llvm::Argument>(V);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002364
Hal Finkel48d53e22014-07-19 01:41:07 +00002365 if (const ParmVarDecl *PVD = dyn_cast<ParmVarDecl>(Arg)) {
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00002366 if (getNonNullAttr(CurCodeDecl, PVD, PVD->getType(),
Manoj Guptada08f6a2018-07-19 00:44:52 +00002367 PVD->getFunctionScopeIndex()) &&
2368 !CGM.getCodeGenOpts().NullPointerIsValid)
Reid Klecknercdd26792017-04-18 23:50:03 +00002369 AI->addAttr(llvm::Attribute::NonNull);
Hal Finkel82504f02014-07-11 17:35:21 +00002370
Hal Finkel48d53e22014-07-19 01:41:07 +00002371 QualType OTy = PVD->getOriginalType();
2372 if (const auto *ArrTy =
2373 getContext().getAsConstantArrayType(OTy)) {
2374 // A C99 array parameter declaration with the static keyword also
2375 // indicates dereferenceability, and if the size is constant we can
2376 // use the dereferenceable attribute (which requires the size in
2377 // bytes).
Hal Finkel16e394a2014-07-19 02:13:40 +00002378 if (ArrTy->getSizeModifier() == ArrayType::Static) {
Hal Finkel48d53e22014-07-19 01:41:07 +00002379 QualType ETy = ArrTy->getElementType();
2380 uint64_t ArrSize = ArrTy->getSize().getZExtValue();
2381 if (!ETy->isIncompleteType() && ETy->isConstantSizeType() &&
2382 ArrSize) {
2383 llvm::AttrBuilder Attrs;
2384 Attrs.addDereferenceableAttr(
2385 getContext().getTypeSizeInChars(ETy).getQuantity()*ArrSize);
Reid Kleckner9d16fa02017-04-19 17:28:52 +00002386 AI->addAttrs(Attrs);
Manoj Guptada08f6a2018-07-19 00:44:52 +00002387 } else if (getContext().getTargetAddressSpace(ETy) == 0 &&
2388 !CGM.getCodeGenOpts().NullPointerIsValid) {
Reid Klecknercdd26792017-04-18 23:50:03 +00002389 AI->addAttr(llvm::Attribute::NonNull);
Hal Finkel48d53e22014-07-19 01:41:07 +00002390 }
2391 }
2392 } else if (const auto *ArrTy =
2393 getContext().getAsVariableArrayType(OTy)) {
2394 // For C99 VLAs with the static keyword, we don't know the size so
2395 // we can't use the dereferenceable attribute, but in addrspace(0)
2396 // we know that it must be nonnull.
2397 if (ArrTy->getSizeModifier() == VariableArrayType::Static &&
Manoj Guptada08f6a2018-07-19 00:44:52 +00002398 !getContext().getTargetAddressSpace(ArrTy->getElementType()) &&
2399 !CGM.getCodeGenOpts().NullPointerIsValid)
Reid Klecknercdd26792017-04-18 23:50:03 +00002400 AI->addAttr(llvm::Attribute::NonNull);
Hal Finkel48d53e22014-07-19 01:41:07 +00002401 }
Hal Finkel1b0d24e2014-10-02 21:21:25 +00002402
2403 const auto *AVAttr = PVD->getAttr<AlignValueAttr>();
2404 if (!AVAttr)
2405 if (const auto *TOTy = dyn_cast<TypedefType>(OTy))
2406 AVAttr = TOTy->getDecl()->getAttr<AlignValueAttr>();
Reid Kleckner9d16fa02017-04-19 17:28:52 +00002407 if (AVAttr) {
Hal Finkel1b0d24e2014-10-02 21:21:25 +00002408 llvm::Value *AlignmentValue =
2409 EmitScalarExpr(AVAttr->getAlignment());
2410 llvm::ConstantInt *AlignmentCI =
2411 cast<llvm::ConstantInt>(AlignmentValue);
Reid Kleckner9d16fa02017-04-19 17:28:52 +00002412 unsigned Alignment = std::min((unsigned)AlignmentCI->getZExtValue(),
2413 +llvm::Value::MaximumAlignment);
2414 AI->addAttrs(llvm::AttrBuilder().addAlignmentAttr(Alignment));
Hal Finkel1b0d24e2014-10-02 21:21:25 +00002415 }
Hal Finkel48d53e22014-07-19 01:41:07 +00002416 }
2417
Bill Wendling507c3512012-10-16 05:23:44 +00002418 if (Arg->getType().isRestrictQualified())
Reid Klecknercdd26792017-04-18 23:50:03 +00002419 AI->addAttr(llvm::Attribute::NoAlias);
John McCall39ec71f2010-03-27 00:47:27 +00002420
John McCall12f23522016-04-04 18:33:08 +00002421 // LLVM expects swifterror parameters to be used in very restricted
2422 // ways. Copy the value into a less-restricted temporary.
2423 if (FI.getExtParameterInfo(ArgNo).getABI()
2424 == ParameterABI::SwiftErrorResult) {
2425 QualType pointeeTy = Ty->getPointeeType();
2426 assert(pointeeTy->isPointerType());
2427 Address temp =
2428 CreateMemTemp(pointeeTy, getPointerAlign(), "swifterror.temp");
2429 Address arg = Address(V, getContext().getTypeAlignInChars(pointeeTy));
2430 llvm::Value *incomingErrorValue = Builder.CreateLoad(arg);
2431 Builder.CreateStore(incomingErrorValue, temp);
2432 V = temp.getPointer();
2433
2434 // Push a cleanup to copy the value back at the end of the function.
2435 // The convention does not guarantee that the value will be written
2436 // back if the function exits with an unwind exception.
2437 EHStack.pushCleanup<CopyBackSwiftError>(NormalCleanup, temp, arg);
2438 }
2439
Chris Lattner7369c142011-07-20 06:29:00 +00002440 // Ensure the argument is the correct type.
2441 if (V->getType() != ArgI.getCoerceToType())
2442 V = Builder.CreateBitCast(V, ArgI.getCoerceToType());
2443
John McCalla738c252011-03-09 04:27:21 +00002444 if (isPromoted)
2445 V = emitArgumentDemotion(*this, Arg, V);
Rafael Espindola8778c282012-11-29 16:09:03 +00002446
2447 // Because of merging of function types from multiple decls it is
2448 // possible for the type of an argument to not match the corresponding
2449 // type in the function type. Since we are codegening the callee
2450 // in here, add a cast to the argument type.
2451 llvm::Type *LTy = ConvertType(Arg->getType());
2452 if (V->getType() != LTy)
2453 V = Builder.CreateBitCast(V, LTy);
2454
John McCall7f416cc2015-09-08 08:05:57 +00002455 ArgVals.push_back(ParamValue::forDirect(V));
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002456 break;
Daniel Dunbard5f1f552009-02-10 00:06:49 +00002457 }
Mike Stump11289f42009-09-09 15:08:12 +00002458
Volodymyr Sapsai22b00ec2017-12-21 20:52:59 +00002459 Address Alloca = CreateMemTemp(Ty, getContext().getDeclAlign(Arg),
2460 Arg->getName());
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002461
John McCall7f416cc2015-09-08 08:05:57 +00002462 // Pointer to store into.
2463 Address Ptr = emitAddressAtOffset(*this, Alloca, ArgI);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002464
Oliver Stannard2bfdc5b2014-08-27 10:43:15 +00002465 // Fast-isel and the optimizer generally like scalar values better than
2466 // FCAs, so we flatten them if this is safe to do for this argument.
Evgeniy Stepanov3fae4ae2012-02-10 09:30:15 +00002467 llvm::StructType *STy = dyn_cast<llvm::StructType>(ArgI.getCoerceToType());
Oliver Stannard2bfdc5b2014-08-27 10:43:15 +00002468 if (ArgI.isDirect() && ArgI.getCanBeFlattened() && STy &&
2469 STy->getNumElements() > 1) {
John McCall7f416cc2015-09-08 08:05:57 +00002470 auto SrcLayout = CGM.getDataLayout().getStructLayout(STy);
Micah Villmowdd31ca12012-10-08 16:25:52 +00002471 uint64_t SrcSize = CGM.getDataLayout().getTypeAllocSize(STy);
John McCall7f416cc2015-09-08 08:05:57 +00002472 llvm::Type *DstTy = Ptr.getElementType();
Micah Villmowdd31ca12012-10-08 16:25:52 +00002473 uint64_t DstSize = CGM.getDataLayout().getTypeAllocSize(DstTy);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002474
John McCall7f416cc2015-09-08 08:05:57 +00002475 Address AddrToStoreInto = Address::invalid();
Evgeniy Stepanov3fae4ae2012-02-10 09:30:15 +00002476 if (SrcSize <= DstSize) {
Yaxun Liue9e5c4f2017-06-29 18:47:45 +00002477 AddrToStoreInto = Builder.CreateElementBitCast(Ptr, STy);
Evgeniy Stepanov3fae4ae2012-02-10 09:30:15 +00002478 } else {
John McCall7f416cc2015-09-08 08:05:57 +00002479 AddrToStoreInto =
2480 CreateTempAlloca(STy, Alloca.getAlignment(), "coerce");
Chris Lattner15ec3612010-06-29 00:06:42 +00002481 }
John McCall7f416cc2015-09-08 08:05:57 +00002482
2483 assert(STy->getNumElements() == NumIRArgs);
2484 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
2485 auto AI = FnArgs[FirstIRArg + i];
2486 AI->setName(Arg->getName() + ".coerce" + Twine(i));
2487 auto Offset = CharUnits::fromQuantity(SrcLayout->getElementOffset(i));
2488 Address EltPtr =
2489 Builder.CreateStructGEP(AddrToStoreInto, i, Offset);
2490 Builder.CreateStore(AI, EltPtr);
2491 }
2492
2493 if (SrcSize > DstSize) {
2494 Builder.CreateMemCpy(Ptr, AddrToStoreInto, DstSize);
2495 }
2496
Chris Lattner15ec3612010-06-29 00:06:42 +00002497 } else {
2498 // Simple case, just do a coerced store of the argument into the alloca.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002499 assert(NumIRArgs == 1);
2500 auto AI = FnArgs[FirstIRArg];
Chris Lattner9e748e92010-06-29 00:14:52 +00002501 AI->setName(Arg->getName() + ".coerce");
John McCall7f416cc2015-09-08 08:05:57 +00002502 CreateCoercedStore(AI, Ptr, /*DestIsVolatile=*/false, *this);
Chris Lattner15ec3612010-06-29 00:06:42 +00002503 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002504
Daniel Dunbar2f219b02009-02-03 19:12:28 +00002505 // Match to what EmitParmDecl is expecting for this type.
Volodymyr Sapsai22b00ec2017-12-21 20:52:59 +00002506 if (CodeGenFunction::hasScalarEvaluationKind(Ty)) {
John McCall7f416cc2015-09-08 08:05:57 +00002507 llvm::Value *V =
Stephen Kellyf2ceec42018-08-09 21:08:08 +00002508 EmitLoadOfScalar(Alloca, false, Ty, Arg->getBeginLoc());
John McCalla738c252011-03-09 04:27:21 +00002509 if (isPromoted)
2510 V = emitArgumentDemotion(*this, Arg, V);
John McCall7f416cc2015-09-08 08:05:57 +00002511 ArgVals.push_back(ParamValue::forDirect(V));
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002512 } else {
John McCall7f416cc2015-09-08 08:05:57 +00002513 ArgVals.push_back(ParamValue::forIndirect(Alloca));
Daniel Dunbar6e3b7df2009-02-04 07:22:24 +00002514 }
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002515 break;
Daniel Dunbar2f219b02009-02-03 19:12:28 +00002516 }
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002517
John McCallf26e73d2016-03-11 04:30:43 +00002518 case ABIArgInfo::CoerceAndExpand: {
2519 // Reconstruct into a temporary.
2520 Address alloca = CreateMemTemp(Ty, getContext().getDeclAlign(Arg));
2521 ArgVals.push_back(ParamValue::forIndirect(alloca));
2522
2523 auto coercionType = ArgI.getCoerceAndExpandType();
2524 alloca = Builder.CreateElementBitCast(alloca, coercionType);
2525 auto layout = CGM.getDataLayout().getStructLayout(coercionType);
2526
2527 unsigned argIndex = FirstIRArg;
2528 for (unsigned i = 0, e = coercionType->getNumElements(); i != e; ++i) {
2529 llvm::Type *eltType = coercionType->getElementType(i);
2530 if (ABIArgInfo::isPaddingForCoerceAndExpand(eltType))
2531 continue;
2532
2533 auto eltAddr = Builder.CreateStructGEP(alloca, i, layout);
2534 auto elt = FnArgs[argIndex++];
2535 Builder.CreateStore(elt, eltAddr);
2536 }
2537 assert(argIndex == FirstIRArg + NumIRArgs);
2538 break;
2539 }
2540
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002541 case ABIArgInfo::Expand: {
2542 // If this structure was expanded into multiple arguments then
2543 // we need to create a temporary and reconstruct it from the
2544 // arguments.
John McCall7f416cc2015-09-08 08:05:57 +00002545 Address Alloca = CreateMemTemp(Ty, getContext().getDeclAlign(Arg));
2546 LValue LV = MakeAddrLValue(Alloca, Ty);
2547 ArgVals.push_back(ParamValue::forIndirect(Alloca));
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002548
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002549 auto FnArgIter = FnArgs.begin() + FirstIRArg;
2550 ExpandTypeFromArgs(Ty, LV, FnArgIter);
2551 assert(FnArgIter == FnArgs.begin() + FirstIRArg + NumIRArgs);
2552 for (unsigned i = 0, e = NumIRArgs; i != e; ++i) {
2553 auto AI = FnArgs[FirstIRArg + i];
2554 AI->setName(Arg->getName() + "." + Twine(i));
2555 }
2556 break;
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002557 }
2558
2559 case ABIArgInfo::Ignore:
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002560 assert(NumIRArgs == 0);
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002561 // Initialize the local variable appropriately.
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002562 if (!hasScalarEvaluationKind(Ty)) {
John McCall7f416cc2015-09-08 08:05:57 +00002563 ArgVals.push_back(ParamValue::forIndirect(CreateMemTemp(Ty)));
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002564 } else {
2565 llvm::Value *U = llvm::UndefValue::get(ConvertType(Arg->getType()));
John McCall7f416cc2015-09-08 08:05:57 +00002566 ArgVals.push_back(ParamValue::forDirect(U));
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002567 }
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002568 break;
Daniel Dunbard3674e62008-09-11 01:48:57 +00002569 }
Daniel Dunbar613855c2008-09-09 23:27:19 +00002570 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002571
Reid Kleckner739756c2013-12-04 19:23:12 +00002572 if (getTarget().getCXXABI().areArgsDestroyedLeftToRightInCallee()) {
2573 for (int I = Args.size() - 1; I >= 0; --I)
John McCall7f416cc2015-09-08 08:05:57 +00002574 EmitParmDecl(*Args[I], ArgVals[I], I + 1);
Reid Kleckner739756c2013-12-04 19:23:12 +00002575 } else {
2576 for (unsigned I = 0, E = Args.size(); I != E; ++I)
John McCall7f416cc2015-09-08 08:05:57 +00002577 EmitParmDecl(*Args[I], ArgVals[I], I + 1);
Reid Kleckner739756c2013-12-04 19:23:12 +00002578 }
Daniel Dunbar613855c2008-09-09 23:27:19 +00002579}
2580
John McCallffa2c1a2012-01-29 07:46:59 +00002581static void eraseUnusedBitCasts(llvm::Instruction *insn) {
2582 while (insn->use_empty()) {
2583 llvm::BitCastInst *bitcast = dyn_cast<llvm::BitCastInst>(insn);
2584 if (!bitcast) return;
2585
2586 // This is "safe" because we would have used a ConstantExpr otherwise.
2587 insn = cast<llvm::Instruction>(bitcast->getOperand(0));
2588 bitcast->eraseFromParent();
2589 }
2590}
2591
John McCall31168b02011-06-15 23:02:42 +00002592/// Try to emit a fused autorelease of a return result.
2593static llvm::Value *tryEmitFusedAutoreleaseOfResult(CodeGenFunction &CGF,
2594 llvm::Value *result) {
2595 // We must be immediately followed the cast.
2596 llvm::BasicBlock *BB = CGF.Builder.GetInsertBlock();
Craig Topper8a13c412014-05-21 05:09:00 +00002597 if (BB->empty()) return nullptr;
2598 if (&BB->back() != result) return nullptr;
John McCall31168b02011-06-15 23:02:42 +00002599
Chris Lattner2192fe52011-07-18 04:24:23 +00002600 llvm::Type *resultType = result->getType();
John McCall31168b02011-06-15 23:02:42 +00002601
2602 // result is in a BasicBlock and is therefore an Instruction.
2603 llvm::Instruction *generator = cast<llvm::Instruction>(result);
2604
Justin Bogner882f8612016-08-18 21:46:54 +00002605 SmallVector<llvm::Instruction *, 4> InstsToKill;
John McCall31168b02011-06-15 23:02:42 +00002606
2607 // Look for:
2608 // %generator = bitcast %type1* %generator2 to %type2*
2609 while (llvm::BitCastInst *bitcast = dyn_cast<llvm::BitCastInst>(generator)) {
2610 // We would have emitted this as a constant if the operand weren't
2611 // an Instruction.
2612 generator = cast<llvm::Instruction>(bitcast->getOperand(0));
2613
2614 // Require the generator to be immediately followed by the cast.
2615 if (generator->getNextNode() != bitcast)
Craig Topper8a13c412014-05-21 05:09:00 +00002616 return nullptr;
John McCall31168b02011-06-15 23:02:42 +00002617
Justin Bogner882f8612016-08-18 21:46:54 +00002618 InstsToKill.push_back(bitcast);
John McCall31168b02011-06-15 23:02:42 +00002619 }
2620
2621 // Look for:
2622 // %generator = call i8* @objc_retain(i8* %originalResult)
2623 // or
2624 // %generator = call i8* @objc_retainAutoreleasedReturnValue(i8* %originalResult)
2625 llvm::CallInst *call = dyn_cast<llvm::CallInst>(generator);
Craig Topper8a13c412014-05-21 05:09:00 +00002626 if (!call) return nullptr;
John McCall31168b02011-06-15 23:02:42 +00002627
2628 bool doRetainAutorelease;
2629
John McCallb04ecb72015-10-21 18:06:43 +00002630 if (call->getCalledValue() == CGF.CGM.getObjCEntrypoints().objc_retain) {
John McCall31168b02011-06-15 23:02:42 +00002631 doRetainAutorelease = true;
John McCallb04ecb72015-10-21 18:06:43 +00002632 } else if (call->getCalledValue() == CGF.CGM.getObjCEntrypoints()
John McCall31168b02011-06-15 23:02:42 +00002633 .objc_retainAutoreleasedReturnValue) {
2634 doRetainAutorelease = false;
2635
John McCallcfa4e9b2012-09-07 23:30:50 +00002636 // If we emitted an assembly marker for this call (and the
2637 // ARCEntrypoints field should have been set if so), go looking
2638 // for that call. If we can't find it, we can't do this
2639 // optimization. But it should always be the immediately previous
2640 // instruction, unless we needed bitcasts around the call.
John McCallb04ecb72015-10-21 18:06:43 +00002641 if (CGF.CGM.getObjCEntrypoints().retainAutoreleasedReturnValueMarker) {
John McCallcfa4e9b2012-09-07 23:30:50 +00002642 llvm::Instruction *prev = call->getPrevNode();
2643 assert(prev);
2644 if (isa<llvm::BitCastInst>(prev)) {
2645 prev = prev->getPrevNode();
2646 assert(prev);
2647 }
2648 assert(isa<llvm::CallInst>(prev));
2649 assert(cast<llvm::CallInst>(prev)->getCalledValue() ==
John McCallb04ecb72015-10-21 18:06:43 +00002650 CGF.CGM.getObjCEntrypoints().retainAutoreleasedReturnValueMarker);
Justin Bogner882f8612016-08-18 21:46:54 +00002651 InstsToKill.push_back(prev);
John McCallcfa4e9b2012-09-07 23:30:50 +00002652 }
John McCall31168b02011-06-15 23:02:42 +00002653 } else {
Craig Topper8a13c412014-05-21 05:09:00 +00002654 return nullptr;
John McCall31168b02011-06-15 23:02:42 +00002655 }
2656
2657 result = call->getArgOperand(0);
Justin Bogner882f8612016-08-18 21:46:54 +00002658 InstsToKill.push_back(call);
John McCall31168b02011-06-15 23:02:42 +00002659
2660 // Keep killing bitcasts, for sanity. Note that we no longer care
2661 // about precise ordering as long as there's exactly one use.
2662 while (llvm::BitCastInst *bitcast = dyn_cast<llvm::BitCastInst>(result)) {
2663 if (!bitcast->hasOneUse()) break;
Justin Bogner882f8612016-08-18 21:46:54 +00002664 InstsToKill.push_back(bitcast);
John McCall31168b02011-06-15 23:02:42 +00002665 result = bitcast->getOperand(0);
2666 }
2667
2668 // Delete all the unnecessary instructions, from latest to earliest.
Justin Bogner882f8612016-08-18 21:46:54 +00002669 for (auto *I : InstsToKill)
Saleem Abdulrasoolbe25c482016-08-18 21:40:06 +00002670 I->eraseFromParent();
John McCall31168b02011-06-15 23:02:42 +00002671
2672 // Do the fused retain/autorelease if we were asked to.
2673 if (doRetainAutorelease)
2674 result = CGF.EmitARCRetainAutoreleaseReturnValue(result);
2675
2676 // Cast back to the result type.
2677 return CGF.Builder.CreateBitCast(result, resultType);
2678}
2679
John McCallffa2c1a2012-01-29 07:46:59 +00002680/// If this is a +1 of the value of an immutable 'self', remove it.
2681static llvm::Value *tryRemoveRetainOfSelf(CodeGenFunction &CGF,
2682 llvm::Value *result) {
2683 // This is only applicable to a method with an immutable 'self'.
John McCallff755cd2012-07-31 00:33:55 +00002684 const ObjCMethodDecl *method =
2685 dyn_cast_or_null<ObjCMethodDecl>(CGF.CurCodeDecl);
Craig Topper8a13c412014-05-21 05:09:00 +00002686 if (!method) return nullptr;
John McCallffa2c1a2012-01-29 07:46:59 +00002687 const VarDecl *self = method->getSelfDecl();
Craig Topper8a13c412014-05-21 05:09:00 +00002688 if (!self->getType().isConstQualified()) return nullptr;
John McCallffa2c1a2012-01-29 07:46:59 +00002689
2690 // Look for a retain call.
2691 llvm::CallInst *retainCall =
2692 dyn_cast<llvm::CallInst>(result->stripPointerCasts());
2693 if (!retainCall ||
John McCallb04ecb72015-10-21 18:06:43 +00002694 retainCall->getCalledValue() != CGF.CGM.getObjCEntrypoints().objc_retain)
Craig Topper8a13c412014-05-21 05:09:00 +00002695 return nullptr;
John McCallffa2c1a2012-01-29 07:46:59 +00002696
2697 // Look for an ordinary load of 'self'.
2698 llvm::Value *retainedValue = retainCall->getArgOperand(0);
2699 llvm::LoadInst *load =
2700 dyn_cast<llvm::LoadInst>(retainedValue->stripPointerCasts());
Fangrui Song6907ce22018-07-30 19:24:48 +00002701 if (!load || load->isAtomic() || load->isVolatile() ||
John McCall7f416cc2015-09-08 08:05:57 +00002702 load->getPointerOperand() != CGF.GetAddrOfLocalVar(self).getPointer())
Craig Topper8a13c412014-05-21 05:09:00 +00002703 return nullptr;
John McCallffa2c1a2012-01-29 07:46:59 +00002704
2705 // Okay! Burn it all down. This relies for correctness on the
2706 // assumption that the retain is emitted as part of the return and
2707 // that thereafter everything is used "linearly".
2708 llvm::Type *resultType = result->getType();
2709 eraseUnusedBitCasts(cast<llvm::Instruction>(result));
2710 assert(retainCall->use_empty());
2711 retainCall->eraseFromParent();
2712 eraseUnusedBitCasts(cast<llvm::Instruction>(retainedValue));
2713
2714 return CGF.Builder.CreateBitCast(load, resultType);
2715}
2716
John McCall31168b02011-06-15 23:02:42 +00002717/// Emit an ARC autorelease of the result of a function.
John McCallffa2c1a2012-01-29 07:46:59 +00002718///
2719/// \return the value to actually return from the function
John McCall31168b02011-06-15 23:02:42 +00002720static llvm::Value *emitAutoreleaseOfResult(CodeGenFunction &CGF,
2721 llvm::Value *result) {
John McCallffa2c1a2012-01-29 07:46:59 +00002722 // If we're returning 'self', kill the initial retain. This is a
2723 // heuristic attempt to "encourage correctness" in the really unfortunate
2724 // case where we have a return of self during a dealloc and we desperately
2725 // need to avoid the possible autorelease.
2726 if (llvm::Value *self = tryRemoveRetainOfSelf(CGF, result))
2727 return self;
2728
John McCall31168b02011-06-15 23:02:42 +00002729 // At -O0, try to emit a fused retain/autorelease.
2730 if (CGF.shouldUseFusedARCCalls())
2731 if (llvm::Value *fused = tryEmitFusedAutoreleaseOfResult(CGF, result))
2732 return fused;
2733
2734 return CGF.EmitARCAutoreleaseReturnValue(result);
2735}
2736
John McCall6e1c0122012-01-29 02:35:02 +00002737/// Heuristically search for a dominating store to the return-value slot.
2738static llvm::StoreInst *findDominatingStoreToReturnValue(CodeGenFunction &CGF) {
Jakub Kuderskif50ab0f2015-09-08 10:36:42 +00002739 // Check if a User is a store which pointerOperand is the ReturnValue.
2740 // We are looking for stores to the ReturnValue, not for stores of the
2741 // ReturnValue to some other location.
2742 auto GetStoreIfValid = [&CGF](llvm::User *U) -> llvm::StoreInst * {
2743 auto *SI = dyn_cast<llvm::StoreInst>(U);
2744 if (!SI || SI->getPointerOperand() != CGF.ReturnValue.getPointer())
2745 return nullptr;
2746 // These aren't actually possible for non-coerced returns, and we
2747 // only care about non-coerced returns on this code path.
2748 assert(!SI->isAtomic() && !SI->isVolatile());
2749 return SI;
2750 };
John McCall6e1c0122012-01-29 02:35:02 +00002751 // If there are multiple uses of the return-value slot, just check
2752 // for something immediately preceding the IP. Sometimes this can
2753 // happen with how we generate implicit-returns; it can also happen
2754 // with noreturn cleanups.
John McCall7f416cc2015-09-08 08:05:57 +00002755 if (!CGF.ReturnValue.getPointer()->hasOneUse()) {
John McCall6e1c0122012-01-29 02:35:02 +00002756 llvm::BasicBlock *IP = CGF.Builder.GetInsertBlock();
Craig Topper8a13c412014-05-21 05:09:00 +00002757 if (IP->empty()) return nullptr;
David Majnemerdc012fa2015-04-22 21:38:15 +00002758 llvm::Instruction *I = &IP->back();
2759
2760 // Skip lifetime markers
2761 for (llvm::BasicBlock::reverse_iterator II = IP->rbegin(),
2762 IE = IP->rend();
2763 II != IE; ++II) {
2764 if (llvm::IntrinsicInst *Intrinsic =
2765 dyn_cast<llvm::IntrinsicInst>(&*II)) {
2766 if (Intrinsic->getIntrinsicID() == llvm::Intrinsic::lifetime_end) {
2767 const llvm::Value *CastAddr = Intrinsic->getArgOperand(1);
2768 ++II;
Alexey Samsonov10544202015-06-12 21:05:32 +00002769 if (II == IE)
2770 break;
2771 if (isa<llvm::BitCastInst>(&*II) && (CastAddr == &*II))
2772 continue;
David Majnemerdc012fa2015-04-22 21:38:15 +00002773 }
2774 }
2775 I = &*II;
2776 break;
2777 }
2778
Jakub Kuderskif50ab0f2015-09-08 10:36:42 +00002779 return GetStoreIfValid(I);
John McCall6e1c0122012-01-29 02:35:02 +00002780 }
2781
2782 llvm::StoreInst *store =
Jakub Kuderskif50ab0f2015-09-08 10:36:42 +00002783 GetStoreIfValid(CGF.ReturnValue.getPointer()->user_back());
Craig Topper8a13c412014-05-21 05:09:00 +00002784 if (!store) return nullptr;
John McCall6e1c0122012-01-29 02:35:02 +00002785
John McCall6e1c0122012-01-29 02:35:02 +00002786 // Now do a first-and-dirty dominance check: just walk up the
2787 // single-predecessors chain from the current insertion point.
2788 llvm::BasicBlock *StoreBB = store->getParent();
2789 llvm::BasicBlock *IP = CGF.Builder.GetInsertBlock();
2790 while (IP != StoreBB) {
2791 if (!(IP = IP->getSinglePredecessor()))
Craig Topper8a13c412014-05-21 05:09:00 +00002792 return nullptr;
John McCall6e1c0122012-01-29 02:35:02 +00002793 }
2794
2795 // Okay, the store's basic block dominates the insertion point; we
2796 // can do our thing.
2797 return store;
2798}
2799
Adrian Prantl3be10542013-05-02 17:30:20 +00002800void CodeGenFunction::EmitFunctionEpilog(const CGFunctionInfo &FI,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002801 bool EmitRetDbgLoc,
2802 SourceLocation EndLoc) {
Vedant Kumar09b5bfd2017-12-21 00:10:25 +00002803 if (FI.isNoReturn()) {
2804 // Noreturn functions don't return.
2805 EmitUnreachable(EndLoc);
2806 return;
2807 }
2808
Hans Wennborgd71907d2014-09-04 22:16:33 +00002809 if (CurCodeDecl && CurCodeDecl->hasAttr<NakedAttr>()) {
2810 // Naked functions don't have epilogues.
2811 Builder.CreateUnreachable();
2812 return;
2813 }
2814
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00002815 // Functions with no result always return void.
John McCall7f416cc2015-09-08 08:05:57 +00002816 if (!ReturnValue.isValid()) {
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00002817 Builder.CreateRetVoid();
Chris Lattner726b3d02010-06-26 23:13:19 +00002818 return;
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00002819 }
Daniel Dunbar6696e222010-06-30 21:27:58 +00002820
Dan Gohman481e40c2010-07-20 20:13:52 +00002821 llvm::DebugLoc RetDbgLoc;
Craig Topper8a13c412014-05-21 05:09:00 +00002822 llvm::Value *RV = nullptr;
Chris Lattner726b3d02010-06-26 23:13:19 +00002823 QualType RetTy = FI.getReturnType();
2824 const ABIArgInfo &RetAI = FI.getReturnInfo();
2825
2826 switch (RetAI.getKind()) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002827 case ABIArgInfo::InAlloca:
Reid Klecknerfab1e892014-02-25 00:59:14 +00002828 // Aggregrates get evaluated directly into the destination. Sometimes we
2829 // need to return the sret value in a register, though.
2830 assert(hasAggregateEvaluationKind(RetTy));
2831 if (RetAI.getInAllocaSRet()) {
2832 llvm::Function::arg_iterator EI = CurFn->arg_end();
2833 --EI;
Duncan P. N. Exon Smith9f5260a2015-11-06 23:00:41 +00002834 llvm::Value *ArgStruct = &*EI;
David Blaikie2e804282015-04-05 22:47:07 +00002835 llvm::Value *SRet = Builder.CreateStructGEP(
2836 nullptr, ArgStruct, RetAI.getInAllocaFieldIndex());
John McCall7f416cc2015-09-08 08:05:57 +00002837 RV = Builder.CreateAlignedLoad(SRet, getPointerAlign(), "sret");
Reid Klecknerfab1e892014-02-25 00:59:14 +00002838 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002839 break;
2840
Daniel Dunbar03816342010-08-21 02:24:36 +00002841 case ABIArgInfo::Indirect: {
Reid Kleckner37abaca2014-05-09 22:46:15 +00002842 auto AI = CurFn->arg_begin();
2843 if (RetAI.isSRetAfterThis())
2844 ++AI;
John McCall47fb9502013-03-07 21:37:08 +00002845 switch (getEvaluationKind(RetTy)) {
2846 case TEK_Complex: {
2847 ComplexPairTy RT =
John McCall7f416cc2015-09-08 08:05:57 +00002848 EmitLoadOfComplex(MakeAddrLValue(ReturnValue, RetTy), EndLoc);
Duncan P. N. Exon Smith9f5260a2015-11-06 23:00:41 +00002849 EmitStoreOfComplex(RT, MakeNaturalAlignAddrLValue(&*AI, RetTy),
John McCall47fb9502013-03-07 21:37:08 +00002850 /*isInit*/ true);
2851 break;
2852 }
2853 case TEK_Aggregate:
Chris Lattner726b3d02010-06-26 23:13:19 +00002854 // Do nothing; aggregrates get evaluated directly into the destination.
John McCall47fb9502013-03-07 21:37:08 +00002855 break;
2856 case TEK_Scalar:
2857 EmitStoreOfScalar(Builder.CreateLoad(ReturnValue),
Duncan P. N. Exon Smith9f5260a2015-11-06 23:00:41 +00002858 MakeNaturalAlignAddrLValue(&*AI, RetTy),
John McCall47fb9502013-03-07 21:37:08 +00002859 /*isInit*/ true);
2860 break;
Chris Lattner726b3d02010-06-26 23:13:19 +00002861 }
2862 break;
Daniel Dunbar03816342010-08-21 02:24:36 +00002863 }
Chris Lattner726b3d02010-06-26 23:13:19 +00002864
2865 case ABIArgInfo::Extend:
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002866 case ABIArgInfo::Direct:
Chris Lattner8a2f3c72010-07-30 04:02:24 +00002867 if (RetAI.getCoerceToType() == ConvertType(RetTy) &&
2868 RetAI.getDirectOffset() == 0) {
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002869 // The internal return value temp always will have pointer-to-return-type
2870 // type, just do a load.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002871
John McCall6e1c0122012-01-29 02:35:02 +00002872 // If there is a dominating store to ReturnValue, we can elide
2873 // the load, zap the store, and usually zap the alloca.
David Majnemerdc012fa2015-04-22 21:38:15 +00002874 if (llvm::StoreInst *SI =
2875 findDominatingStoreToReturnValue(*this)) {
Adrian Prantl4c9a38a2013-05-30 18:12:23 +00002876 // Reuse the debug location from the store unless there is
2877 // cleanup code to be emitted between the store and return
2878 // instruction.
2879 if (EmitRetDbgLoc && !AutoreleaseResult)
Adrian Prantl3be10542013-05-02 17:30:20 +00002880 RetDbgLoc = SI->getDebugLoc();
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002881 // Get the stored value and nuke the now-dead store.
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002882 RV = SI->getValueOperand();
2883 SI->eraseFromParent();
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002884
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002885 // If that was the only use of the return value, nuke it as well now.
John McCall7f416cc2015-09-08 08:05:57 +00002886 auto returnValueInst = ReturnValue.getPointer();
2887 if (returnValueInst->use_empty()) {
2888 if (auto alloca = dyn_cast<llvm::AllocaInst>(returnValueInst)) {
2889 alloca->eraseFromParent();
2890 ReturnValue = Address::invalid();
2891 }
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002892 }
John McCall6e1c0122012-01-29 02:35:02 +00002893
2894 // Otherwise, we have to do a simple load.
2895 } else {
2896 RV = Builder.CreateLoad(ReturnValue);
Chris Lattner3fcc7902010-06-27 01:06:27 +00002897 }
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002898 } else {
Chris Lattner8a2f3c72010-07-30 04:02:24 +00002899 // If the value is offset in memory, apply the offset now.
John McCall7f416cc2015-09-08 08:05:57 +00002900 Address V = emitAddressAtOffset(*this, ReturnValue, RetAI);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002901
John McCall7f416cc2015-09-08 08:05:57 +00002902 RV = CreateCoercedLoad(V, RetAI.getCoerceToType(), *this);
Chris Lattner3fcc7902010-06-27 01:06:27 +00002903 }
John McCall31168b02011-06-15 23:02:42 +00002904
2905 // In ARC, end functions that return a retainable type with a call
2906 // to objc_autoreleaseReturnValue.
2907 if (AutoreleaseResult) {
Akira Hatanaka9d8ac612016-02-17 21:09:50 +00002908#ifndef NDEBUG
2909 // Type::isObjCRetainabletype has to be called on a QualType that hasn't
2910 // been stripped of the typedefs, so we cannot use RetTy here. Get the
2911 // original return type of FunctionDecl, CurCodeDecl, and BlockDecl from
2912 // CurCodeDecl or BlockInfo.
2913 QualType RT;
2914
2915 if (auto *FD = dyn_cast<FunctionDecl>(CurCodeDecl))
2916 RT = FD->getReturnType();
2917 else if (auto *MD = dyn_cast<ObjCMethodDecl>(CurCodeDecl))
2918 RT = MD->getReturnType();
2919 else if (isa<BlockDecl>(CurCodeDecl))
2920 RT = BlockInfo->BlockExpression->getFunctionType()->getReturnType();
2921 else
2922 llvm_unreachable("Unexpected function/method type");
2923
David Blaikiebbafb8a2012-03-11 07:00:24 +00002924 assert(getLangOpts().ObjCAutoRefCount &&
John McCall31168b02011-06-15 23:02:42 +00002925 !FI.isReturnsRetained() &&
Akira Hatanaka9d8ac612016-02-17 21:09:50 +00002926 RT->isObjCRetainableType());
2927#endif
John McCall31168b02011-06-15 23:02:42 +00002928 RV = emitAutoreleaseOfResult(*this, RV);
2929 }
2930
Chris Lattner726b3d02010-06-26 23:13:19 +00002931 break;
Chris Lattner726b3d02010-06-26 23:13:19 +00002932
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002933 case ABIArgInfo::Ignore:
Chris Lattner726b3d02010-06-26 23:13:19 +00002934 break;
2935
John McCallf26e73d2016-03-11 04:30:43 +00002936 case ABIArgInfo::CoerceAndExpand: {
2937 auto coercionType = RetAI.getCoerceAndExpandType();
2938 auto layout = CGM.getDataLayout().getStructLayout(coercionType);
2939
2940 // Load all of the coerced elements out into results.
2941 llvm::SmallVector<llvm::Value*, 4> results;
2942 Address addr = Builder.CreateElementBitCast(ReturnValue, coercionType);
2943 for (unsigned i = 0, e = coercionType->getNumElements(); i != e; ++i) {
2944 auto coercedEltType = coercionType->getElementType(i);
2945 if (ABIArgInfo::isPaddingForCoerceAndExpand(coercedEltType))
2946 continue;
2947
2948 auto eltAddr = Builder.CreateStructGEP(addr, i, layout);
2949 auto elt = Builder.CreateLoad(eltAddr);
2950 results.push_back(elt);
2951 }
2952
2953 // If we have one result, it's the single direct result type.
2954 if (results.size() == 1) {
2955 RV = results[0];
2956
2957 // Otherwise, we need to make a first-class aggregate.
2958 } else {
2959 // Construct a return type that lacks padding elements.
2960 llvm::Type *returnType = RetAI.getUnpaddedCoerceAndExpandType();
2961
2962 RV = llvm::UndefValue::get(returnType);
2963 for (unsigned i = 0, e = results.size(); i != e; ++i) {
2964 RV = Builder.CreateInsertValue(RV, results[i], i);
2965 }
2966 }
2967 break;
2968 }
2969
Chris Lattner726b3d02010-06-26 23:13:19 +00002970 case ABIArgInfo::Expand:
David Blaikie83d382b2011-09-23 05:06:16 +00002971 llvm_unreachable("Invalid ABI kind for return argument");
Chris Lattner726b3d02010-06-26 23:13:19 +00002972 }
2973
Alexey Samsonovde443c52014-08-13 00:26:40 +00002974 llvm::Instruction *Ret;
2975 if (RV) {
Vedant Kumarc34d3432017-06-23 21:32:38 +00002976 EmitReturnValueCheck(RV);
Alexey Samsonovde443c52014-08-13 00:26:40 +00002977 Ret = Builder.CreateRet(RV);
2978 } else {
2979 Ret = Builder.CreateRetVoid();
2980 }
2981
Duncan P. N. Exon Smith2809cc72015-03-30 20:01:41 +00002982 if (RetDbgLoc)
Benjamin Kramer03278662015-02-07 13:15:54 +00002983 Ret->setDebugLoc(std::move(RetDbgLoc));
Daniel Dunbar613855c2008-09-09 23:27:19 +00002984}
2985
Vedant Kumarc34d3432017-06-23 21:32:38 +00002986void CodeGenFunction::EmitReturnValueCheck(llvm::Value *RV) {
Vedant Kumar42c17ec2017-03-14 01:56:34 +00002987 // A current decl may not be available when emitting vtable thunks.
2988 if (!CurCodeDecl)
2989 return;
2990
2991 ReturnsNonNullAttr *RetNNAttr = nullptr;
2992 if (SanOpts.has(SanitizerKind::ReturnsNonnullAttribute))
2993 RetNNAttr = CurCodeDecl->getAttr<ReturnsNonNullAttr>();
2994
2995 if (!RetNNAttr && !requiresReturnValueNullabilityCheck())
2996 return;
2997
2998 // Prefer the returns_nonnull attribute if it's present.
2999 SourceLocation AttrLoc;
3000 SanitizerMask CheckKind;
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00003001 SanitizerHandler Handler;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003002 if (RetNNAttr) {
3003 assert(!requiresReturnValueNullabilityCheck() &&
3004 "Cannot check nullability and the nonnull attribute");
3005 AttrLoc = RetNNAttr->getLocation();
3006 CheckKind = SanitizerKind::ReturnsNonnullAttribute;
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00003007 Handler = SanitizerHandler::NonnullReturn;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003008 } else {
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003009 if (auto *DD = dyn_cast<DeclaratorDecl>(CurCodeDecl))
3010 if (auto *TSI = DD->getTypeSourceInfo())
3011 if (auto FTL = TSI->getTypeLoc().castAs<FunctionTypeLoc>())
3012 AttrLoc = FTL.getReturnLoc().findNullabilityLoc();
3013 CheckKind = SanitizerKind::NullabilityReturn;
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00003014 Handler = SanitizerHandler::NullabilityReturn;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003015 }
3016
3017 SanitizerScope SanScope(this);
3018
Vedant Kumarc34d3432017-06-23 21:32:38 +00003019 // Make sure the "return" source location is valid. If we're checking a
3020 // nullability annotation, make sure the preconditions for the check are met.
3021 llvm::BasicBlock *Check = createBasicBlock("nullcheck");
3022 llvm::BasicBlock *NoCheck = createBasicBlock("no.nullcheck");
3023 llvm::Value *SLocPtr = Builder.CreateLoad(ReturnLocation, "return.sloc.load");
3024 llvm::Value *CanNullCheck = Builder.CreateIsNotNull(SLocPtr);
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003025 if (requiresReturnValueNullabilityCheck())
Vedant Kumarc34d3432017-06-23 21:32:38 +00003026 CanNullCheck =
3027 Builder.CreateAnd(CanNullCheck, RetValNullabilityPrecondition);
3028 Builder.CreateCondBr(CanNullCheck, Check, NoCheck);
3029 EmitBlock(Check);
3030
3031 // Now do the null check.
3032 llvm::Value *Cond = Builder.CreateIsNotNull(RV);
3033 llvm::Constant *StaticData[] = {EmitCheckSourceLocation(AttrLoc)};
3034 llvm::Value *DynamicData[] = {SLocPtr};
3035 EmitCheck(std::make_pair(Cond, CheckKind), Handler, StaticData, DynamicData);
3036
3037 EmitBlock(NoCheck);
3038
3039#ifndef NDEBUG
3040 // The return location should not be used after the check has been emitted.
3041 ReturnLocation = Address::invalid();
3042#endif
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003043}
3044
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003045static bool isInAllocaArgument(CGCXXABI &ABI, QualType type) {
3046 const CXXRecordDecl *RD = type->getAsCXXRecordDecl();
3047 return RD && ABI.getRecordArgABI(RD) == CGCXXABI::RAA_DirectInMemory;
3048}
3049
John McCall7f416cc2015-09-08 08:05:57 +00003050static AggValueSlot createPlaceholderSlot(CodeGenFunction &CGF,
3051 QualType Ty) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003052 // FIXME: Generate IR in one pass, rather than going back and fixing up these
3053 // placeholders.
3054 llvm::Type *IRTy = CGF.ConvertTypeForMem(Ty);
Peter Collingbourneb367c562016-11-28 22:30:21 +00003055 llvm::Type *IRPtrTy = IRTy->getPointerTo();
3056 llvm::Value *Placeholder = llvm::UndefValue::get(IRPtrTy->getPointerTo());
John McCall7f416cc2015-09-08 08:05:57 +00003057
3058 // FIXME: When we generate this IR in one pass, we shouldn't need
3059 // this win32-specific alignment hack.
3060 CharUnits Align = CharUnits::fromQuantity(4);
Peter Collingbourneb367c562016-11-28 22:30:21 +00003061 Placeholder = CGF.Builder.CreateAlignedLoad(IRPtrTy, Placeholder, Align);
John McCall7f416cc2015-09-08 08:05:57 +00003062
3063 return AggValueSlot::forAddr(Address(Placeholder, Align),
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003064 Ty.getQualifiers(),
3065 AggValueSlot::IsNotDestructed,
3066 AggValueSlot::DoesNotNeedGCBarriers,
Richard Smithe78fac52018-04-05 20:52:58 +00003067 AggValueSlot::IsNotAliased,
3068 AggValueSlot::DoesNotOverlap);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003069}
3070
John McCall32ea9692011-03-11 20:59:21 +00003071void CodeGenFunction::EmitDelegateCallArg(CallArgList &args,
Nick Lewycky2d84e842013-10-02 02:29:49 +00003072 const VarDecl *param,
3073 SourceLocation loc) {
John McCall23f66262010-05-26 22:34:26 +00003074 // StartFunction converted the ABI-lowered parameter(s) into a
3075 // local alloca. We need to turn that into an r-value suitable
3076 // for EmitCall.
John McCall7f416cc2015-09-08 08:05:57 +00003077 Address local = GetAddrOfLocalVar(param);
John McCall23f66262010-05-26 22:34:26 +00003078
John McCall32ea9692011-03-11 20:59:21 +00003079 QualType type = param->getType();
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003080
Reid Kleckner25b56022018-12-12 23:46:06 +00003081 if (isInAllocaArgument(CGM.getCXXABI(), type)) {
3082 CGM.ErrorUnsupported(param, "forwarded non-trivially copyable parameter");
3083 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003084
John McCall811b2912016-11-18 01:08:24 +00003085 // GetAddrOfLocalVar returns a pointer-to-pointer for references,
3086 // but the argument needs to be the original pointer.
3087 if (type->isReferenceType()) {
3088 args.add(RValue::get(Builder.CreateLoad(local)), type);
3089
3090 // In ARC, move out of consumed arguments so that the release cleanup
3091 // entered by StartFunction doesn't cause an over-release. This isn't
3092 // optimal -O0 code generation, but it should get cleaned up when
3093 // optimization is enabled. This also assumes that delegate calls are
3094 // performed exactly once for a set of arguments, but that should be safe.
3095 } else if (getLangOpts().ObjCAutoRefCount &&
3096 param->hasAttr<NSConsumedAttr>() &&
3097 type->isObjCRetainableType()) {
3098 llvm::Value *ptr = Builder.CreateLoad(local);
3099 auto null =
3100 llvm::ConstantPointerNull::get(cast<llvm::PointerType>(ptr->getType()));
3101 Builder.CreateStore(null, local);
3102 args.add(RValue::get(ptr), type);
3103
Richard Smithd62d4982016-06-14 01:13:21 +00003104 // For the most part, we just need to load the alloca, except that
3105 // aggregate r-values are actually pointers to temporaries.
John McCall811b2912016-11-18 01:08:24 +00003106 } else {
Richard Smithd62d4982016-06-14 01:13:21 +00003107 args.add(convertTempToRValue(local, type, loc), type);
John McCall811b2912016-11-18 01:08:24 +00003108 }
Akira Hatanakaccda3d22018-04-27 06:57:00 +00003109
3110 // Deactivate the cleanup for the callee-destructed param that was pushed.
3111 if (hasAggregateEvaluationKind(type) && !CurFuncIsThunk &&
Akira Hatanaka85282972018-05-15 21:00:30 +00003112 type->getAs<RecordType>()->getDecl()->isParamDestroyedInCallee() &&
3113 type.isDestructedType()) {
Akira Hatanakaccda3d22018-04-27 06:57:00 +00003114 EHScopeStack::stable_iterator cleanup =
3115 CalleeDestructedParamCleanups.lookup(cast<ParmVarDecl>(param));
3116 assert(cleanup.isValid() &&
3117 "cleanup for callee-destructed param not recorded");
3118 // This unreachable is a temporary marker which will be removed later.
3119 llvm::Instruction *isActive = Builder.CreateUnreachable();
3120 args.addArgCleanupDeactivation(cleanup, isActive);
3121 }
John McCall23f66262010-05-26 22:34:26 +00003122}
3123
John McCall31168b02011-06-15 23:02:42 +00003124static bool isProvablyNull(llvm::Value *addr) {
3125 return isa<llvm::ConstantPointerNull>(addr);
3126}
3127
John McCall31168b02011-06-15 23:02:42 +00003128/// Emit the actual writing-back of a writeback.
3129static void emitWriteback(CodeGenFunction &CGF,
3130 const CallArgList::Writeback &writeback) {
John McCalleff18842013-03-23 02:35:54 +00003131 const LValue &srcLV = writeback.Source;
John McCall7f416cc2015-09-08 08:05:57 +00003132 Address srcAddr = srcLV.getAddress();
3133 assert(!isProvablyNull(srcAddr.getPointer()) &&
John McCall31168b02011-06-15 23:02:42 +00003134 "shouldn't have writeback for provably null argument");
3135
Craig Topper8a13c412014-05-21 05:09:00 +00003136 llvm::BasicBlock *contBB = nullptr;
John McCall31168b02011-06-15 23:02:42 +00003137
3138 // If the argument wasn't provably non-null, we need to null check
3139 // before doing the store.
Nuno Lopes9211cee2017-09-09 18:25:36 +00003140 bool provablyNonNull = llvm::isKnownNonZero(srcAddr.getPointer(),
3141 CGF.CGM.getDataLayout());
John McCall31168b02011-06-15 23:02:42 +00003142 if (!provablyNonNull) {
3143 llvm::BasicBlock *writebackBB = CGF.createBasicBlock("icr.writeback");
3144 contBB = CGF.createBasicBlock("icr.done");
3145
John McCall7f416cc2015-09-08 08:05:57 +00003146 llvm::Value *isNull =
3147 CGF.Builder.CreateIsNull(srcAddr.getPointer(), "icr.isnull");
John McCall31168b02011-06-15 23:02:42 +00003148 CGF.Builder.CreateCondBr(isNull, contBB, writebackBB);
3149 CGF.EmitBlock(writebackBB);
3150 }
3151
3152 // Load the value to writeback.
3153 llvm::Value *value = CGF.Builder.CreateLoad(writeback.Temporary);
3154
3155 // Cast it back, in case we're writing an id to a Foo* or something.
John McCall7f416cc2015-09-08 08:05:57 +00003156 value = CGF.Builder.CreateBitCast(value, srcAddr.getElementType(),
3157 "icr.writeback-cast");
Fangrui Song6907ce22018-07-30 19:24:48 +00003158
John McCall31168b02011-06-15 23:02:42 +00003159 // Perform the writeback.
John McCalleff18842013-03-23 02:35:54 +00003160
3161 // If we have a "to use" value, it's something we need to emit a use
3162 // of. This has to be carefully threaded in: if it's done after the
3163 // release it's potentially undefined behavior (and the optimizer
3164 // will ignore it), and if it happens before the retain then the
3165 // optimizer could move the release there.
3166 if (writeback.ToUse) {
3167 assert(srcLV.getObjCLifetime() == Qualifiers::OCL_Strong);
3168
3169 // Retain the new value. No need to block-copy here: the block's
3170 // being passed up the stack.
3171 value = CGF.EmitARCRetainNonBlock(value);
3172
3173 // Emit the intrinsic use here.
3174 CGF.EmitARCIntrinsicUse(writeback.ToUse);
3175
3176 // Load the old value (primitively).
Nick Lewycky2d84e842013-10-02 02:29:49 +00003177 llvm::Value *oldValue = CGF.EmitLoadOfScalar(srcLV, SourceLocation());
John McCalleff18842013-03-23 02:35:54 +00003178
3179 // Put the new value in place (primitively).
3180 CGF.EmitStoreOfScalar(value, srcLV, /*init*/ false);
3181
3182 // Release the old value.
3183 CGF.EmitARCRelease(oldValue, srcLV.isARCPreciseLifetime());
3184
3185 // Otherwise, we can just do a normal lvalue store.
3186 } else {
3187 CGF.EmitStoreThroughLValue(RValue::get(value), srcLV);
3188 }
John McCall31168b02011-06-15 23:02:42 +00003189
3190 // Jump to the continuation block.
3191 if (!provablyNonNull)
3192 CGF.EmitBlock(contBB);
3193}
3194
3195static void emitWritebacks(CodeGenFunction &CGF,
3196 const CallArgList &args) {
Aaron Ballman36a7fa82014-03-17 17:22:27 +00003197 for (const auto &I : args.writebacks())
3198 emitWriteback(CGF, I);
John McCall31168b02011-06-15 23:02:42 +00003199}
3200
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003201static void deactivateArgCleanupsBeforeCall(CodeGenFunction &CGF,
3202 const CallArgList &CallArgs) {
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003203 ArrayRef<CallArgList::CallArgCleanup> Cleanups =
3204 CallArgs.getCleanupsToDeactivate();
3205 // Iterate in reverse to increase the likelihood of popping the cleanup.
Pete Cooper57d3f142015-07-30 17:22:52 +00003206 for (const auto &I : llvm::reverse(Cleanups)) {
3207 CGF.DeactivateCleanupBlock(I.Cleanup, I.IsActiveIP);
3208 I.IsActiveIP->eraseFromParent();
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003209 }
3210}
3211
John McCalleff18842013-03-23 02:35:54 +00003212static const Expr *maybeGetUnaryAddrOfOperand(const Expr *E) {
3213 if (const UnaryOperator *uop = dyn_cast<UnaryOperator>(E->IgnoreParens()))
3214 if (uop->getOpcode() == UO_AddrOf)
3215 return uop->getSubExpr();
Craig Topper8a13c412014-05-21 05:09:00 +00003216 return nullptr;
John McCalleff18842013-03-23 02:35:54 +00003217}
3218
John McCall31168b02011-06-15 23:02:42 +00003219/// Emit an argument that's being passed call-by-writeback. That is,
John McCall7f416cc2015-09-08 08:05:57 +00003220/// we are passing the address of an __autoreleased temporary; it
3221/// might be copy-initialized with the current value of the given
3222/// address, but it will definitely be copied out of after the call.
John McCall31168b02011-06-15 23:02:42 +00003223static void emitWritebackArg(CodeGenFunction &CGF, CallArgList &args,
3224 const ObjCIndirectCopyRestoreExpr *CRE) {
John McCalleff18842013-03-23 02:35:54 +00003225 LValue srcLV;
3226
3227 // Make an optimistic effort to emit the address as an l-value.
Eric Christopher2c4555a2015-06-19 01:52:53 +00003228 // This can fail if the argument expression is more complicated.
John McCalleff18842013-03-23 02:35:54 +00003229 if (const Expr *lvExpr = maybeGetUnaryAddrOfOperand(CRE->getSubExpr())) {
3230 srcLV = CGF.EmitLValue(lvExpr);
3231
3232 // Otherwise, just emit it as a scalar.
3233 } else {
John McCall7f416cc2015-09-08 08:05:57 +00003234 Address srcAddr = CGF.EmitPointerWithAlignment(CRE->getSubExpr());
John McCalleff18842013-03-23 02:35:54 +00003235
3236 QualType srcAddrType =
3237 CRE->getSubExpr()->getType()->castAs<PointerType>()->getPointeeType();
John McCall7f416cc2015-09-08 08:05:57 +00003238 srcLV = CGF.MakeAddrLValue(srcAddr, srcAddrType);
John McCalleff18842013-03-23 02:35:54 +00003239 }
John McCall7f416cc2015-09-08 08:05:57 +00003240 Address srcAddr = srcLV.getAddress();
John McCall31168b02011-06-15 23:02:42 +00003241
3242 // The dest and src types don't necessarily match in LLVM terms
3243 // because of the crazy ObjC compatibility rules.
3244
Chris Lattner2192fe52011-07-18 04:24:23 +00003245 llvm::PointerType *destType =
John McCall31168b02011-06-15 23:02:42 +00003246 cast<llvm::PointerType>(CGF.ConvertType(CRE->getType()));
3247
3248 // If the address is a constant null, just pass the appropriate null.
John McCall7f416cc2015-09-08 08:05:57 +00003249 if (isProvablyNull(srcAddr.getPointer())) {
John McCall31168b02011-06-15 23:02:42 +00003250 args.add(RValue::get(llvm::ConstantPointerNull::get(destType)),
3251 CRE->getType());
3252 return;
3253 }
3254
John McCall31168b02011-06-15 23:02:42 +00003255 // Create the temporary.
John McCall7f416cc2015-09-08 08:05:57 +00003256 Address temp = CGF.CreateTempAlloca(destType->getElementType(),
3257 CGF.getPointerAlign(),
3258 "icr.temp");
Fariborz Jahanianfbd19742012-11-27 23:02:53 +00003259 // Loading an l-value can introduce a cleanup if the l-value is __weak,
3260 // and that cleanup will be conditional if we can't prove that the l-value
3261 // isn't null, so we need to register a dominating point so that the cleanups
3262 // system will make valid IR.
3263 CodeGenFunction::ConditionalEvaluation condEval(CGF);
Fangrui Song6907ce22018-07-30 19:24:48 +00003264
John McCall31168b02011-06-15 23:02:42 +00003265 // Zero-initialize it if we're not doing a copy-initialization.
3266 bool shouldCopy = CRE->shouldCopy();
3267 if (!shouldCopy) {
3268 llvm::Value *null =
3269 llvm::ConstantPointerNull::get(
3270 cast<llvm::PointerType>(destType->getElementType()));
3271 CGF.Builder.CreateStore(null, temp);
3272 }
Craig Topper8a13c412014-05-21 05:09:00 +00003273
3274 llvm::BasicBlock *contBB = nullptr;
3275 llvm::BasicBlock *originBB = nullptr;
John McCall31168b02011-06-15 23:02:42 +00003276
3277 // If the address is *not* known to be non-null, we need to switch.
3278 llvm::Value *finalArgument;
3279
Nuno Lopes9211cee2017-09-09 18:25:36 +00003280 bool provablyNonNull = llvm::isKnownNonZero(srcAddr.getPointer(),
3281 CGF.CGM.getDataLayout());
John McCall31168b02011-06-15 23:02:42 +00003282 if (provablyNonNull) {
John McCall7f416cc2015-09-08 08:05:57 +00003283 finalArgument = temp.getPointer();
John McCall31168b02011-06-15 23:02:42 +00003284 } else {
John McCall7f416cc2015-09-08 08:05:57 +00003285 llvm::Value *isNull =
3286 CGF.Builder.CreateIsNull(srcAddr.getPointer(), "icr.isnull");
John McCall31168b02011-06-15 23:02:42 +00003287
Fangrui Song6907ce22018-07-30 19:24:48 +00003288 finalArgument = CGF.Builder.CreateSelect(isNull,
John McCall31168b02011-06-15 23:02:42 +00003289 llvm::ConstantPointerNull::get(destType),
John McCall7f416cc2015-09-08 08:05:57 +00003290 temp.getPointer(), "icr.argument");
John McCall31168b02011-06-15 23:02:42 +00003291
3292 // If we need to copy, then the load has to be conditional, which
3293 // means we need control flow.
3294 if (shouldCopy) {
John McCalleff18842013-03-23 02:35:54 +00003295 originBB = CGF.Builder.GetInsertBlock();
John McCall31168b02011-06-15 23:02:42 +00003296 contBB = CGF.createBasicBlock("icr.cont");
3297 llvm::BasicBlock *copyBB = CGF.createBasicBlock("icr.copy");
3298 CGF.Builder.CreateCondBr(isNull, contBB, copyBB);
3299 CGF.EmitBlock(copyBB);
Fariborz Jahanianfbd19742012-11-27 23:02:53 +00003300 condEval.begin(CGF);
John McCall31168b02011-06-15 23:02:42 +00003301 }
3302 }
3303
Craig Topper8a13c412014-05-21 05:09:00 +00003304 llvm::Value *valueToUse = nullptr;
John McCalleff18842013-03-23 02:35:54 +00003305
John McCall31168b02011-06-15 23:02:42 +00003306 // Perform a copy if necessary.
3307 if (shouldCopy) {
Nick Lewycky2d84e842013-10-02 02:29:49 +00003308 RValue srcRV = CGF.EmitLoadOfLValue(srcLV, SourceLocation());
John McCall31168b02011-06-15 23:02:42 +00003309 assert(srcRV.isScalar());
3310
3311 llvm::Value *src = srcRV.getScalarVal();
3312 src = CGF.Builder.CreateBitCast(src, destType->getElementType(),
3313 "icr.cast");
3314
3315 // Use an ordinary store, not a store-to-lvalue.
3316 CGF.Builder.CreateStore(src, temp);
John McCalleff18842013-03-23 02:35:54 +00003317
3318 // If optimization is enabled, and the value was held in a
3319 // __strong variable, we need to tell the optimizer that this
3320 // value has to stay alive until we're doing the store back.
3321 // This is because the temporary is effectively unretained,
3322 // and so otherwise we can violate the high-level semantics.
3323 if (CGF.CGM.getCodeGenOpts().OptimizationLevel != 0 &&
3324 srcLV.getObjCLifetime() == Qualifiers::OCL_Strong) {
3325 valueToUse = src;
3326 }
John McCall31168b02011-06-15 23:02:42 +00003327 }
Fangrui Song6907ce22018-07-30 19:24:48 +00003328
John McCall31168b02011-06-15 23:02:42 +00003329 // Finish the control flow if we needed it.
Fariborz Jahanianfbd19742012-11-27 23:02:53 +00003330 if (shouldCopy && !provablyNonNull) {
John McCalleff18842013-03-23 02:35:54 +00003331 llvm::BasicBlock *copyBB = CGF.Builder.GetInsertBlock();
John McCall31168b02011-06-15 23:02:42 +00003332 CGF.EmitBlock(contBB);
John McCalleff18842013-03-23 02:35:54 +00003333
3334 // Make a phi for the value to intrinsically use.
3335 if (valueToUse) {
3336 llvm::PHINode *phiToUse = CGF.Builder.CreatePHI(valueToUse->getType(), 2,
3337 "icr.to-use");
3338 phiToUse->addIncoming(valueToUse, copyBB);
3339 phiToUse->addIncoming(llvm::UndefValue::get(valueToUse->getType()),
3340 originBB);
3341 valueToUse = phiToUse;
3342 }
3343
Fariborz Jahanianfbd19742012-11-27 23:02:53 +00003344 condEval.end(CGF);
3345 }
John McCall31168b02011-06-15 23:02:42 +00003346
John McCalleff18842013-03-23 02:35:54 +00003347 args.addWriteback(srcLV, temp, valueToUse);
John McCall31168b02011-06-15 23:02:42 +00003348 args.add(RValue::get(finalArgument), CRE->getType());
3349}
3350
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003351void CallArgList::allocateArgumentMemory(CodeGenFunction &CGF) {
Richard Smith762672a2016-09-28 19:09:10 +00003352 assert(!StackBase);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003353
3354 // Save the stack.
3355 llvm::Function *F = CGF.CGM.getIntrinsic(llvm::Intrinsic::stacksave);
David Blaikie43f9bb72015-05-18 22:14:03 +00003356 StackBase = CGF.Builder.CreateCall(F, {}, "inalloca.save");
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003357}
3358
Nico Weber8cdb3f92015-08-25 18:43:32 +00003359void CallArgList::freeArgumentMemory(CodeGenFunction &CGF) const {
3360 if (StackBase) {
Reid Kleckner7c2f9e82015-10-08 00:17:45 +00003361 // Restore the stack after the call.
Nico Weber8cdb3f92015-08-25 18:43:32 +00003362 llvm::Value *F = CGF.CGM.getIntrinsic(llvm::Intrinsic::stackrestore);
Nico Weber8cdb3f92015-08-25 18:43:32 +00003363 CGF.Builder.CreateCall(F, StackBase);
3364 }
3365}
3366
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003367void CodeGenFunction::EmitNonNullArgCheck(RValue RV, QualType ArgType,
3368 SourceLocation ArgLoc,
Vedant Kumared00ea02017-03-06 05:28:22 +00003369 AbstractCallee AC,
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003370 unsigned ParmNum) {
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003371 if (!AC.getDecl() || !(SanOpts.has(SanitizerKind::NonnullAttribute) ||
3372 SanOpts.has(SanitizerKind::NullabilityArg)))
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003373 return;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003374
3375 // The param decl may be missing in a variadic function.
Vedant Kumared00ea02017-03-06 05:28:22 +00003376 auto PVD = ParmNum < AC.getNumParams() ? AC.getParamDecl(ParmNum) : nullptr;
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003377 unsigned ArgNo = PVD ? PVD->getFunctionScopeIndex() : ParmNum;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003378
Fangrui Song6907ce22018-07-30 19:24:48 +00003379 // Prefer the nonnull attribute if it's present.
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003380 const NonNullAttr *NNAttr = nullptr;
3381 if (SanOpts.has(SanitizerKind::NonnullAttribute))
3382 NNAttr = getNonNullAttr(AC.getDecl(), PVD, ArgType, ArgNo);
3383
3384 bool CanCheckNullability = false;
3385 if (SanOpts.has(SanitizerKind::NullabilityArg) && !NNAttr && PVD) {
3386 auto Nullability = PVD->getType()->getNullability(getContext());
3387 CanCheckNullability = Nullability &&
3388 *Nullability == NullabilityKind::NonNull &&
3389 PVD->getTypeSourceInfo();
3390 }
3391
3392 if (!NNAttr && !CanCheckNullability)
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003393 return;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003394
3395 SourceLocation AttrLoc;
3396 SanitizerMask CheckKind;
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00003397 SanitizerHandler Handler;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003398 if (NNAttr) {
3399 AttrLoc = NNAttr->getLocation();
3400 CheckKind = SanitizerKind::NonnullAttribute;
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00003401 Handler = SanitizerHandler::NonnullArg;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003402 } else {
3403 AttrLoc = PVD->getTypeSourceInfo()->getTypeLoc().findNullabilityLoc();
3404 CheckKind = SanitizerKind::NullabilityArg;
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00003405 Handler = SanitizerHandler::NullabilityArg;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003406 }
3407
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003408 SanitizerScope SanScope(this);
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003409 assert(RV.isScalar());
3410 llvm::Value *V = RV.getScalarVal();
3411 llvm::Value *Cond =
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003412 Builder.CreateICmpNE(V, llvm::Constant::getNullValue(V->getType()));
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003413 llvm::Constant *StaticData[] = {
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003414 EmitCheckSourceLocation(ArgLoc), EmitCheckSourceLocation(AttrLoc),
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003415 llvm::ConstantInt::get(Int32Ty, ArgNo + 1),
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003416 };
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00003417 EmitCheck(std::make_pair(Cond, CheckKind), Handler, StaticData, None);
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003418}
3419
David Blaikief05779e2015-07-21 18:37:18 +00003420void CodeGenFunction::EmitCallArgs(
3421 CallArgList &Args, ArrayRef<QualType> ArgTypes,
3422 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Vedant Kumared00ea02017-03-06 05:28:22 +00003423 AbstractCallee AC, unsigned ParamsToSkip, EvaluationOrder Order) {
David Blaikief05779e2015-07-21 18:37:18 +00003424 assert((int)ArgTypes.size() == (ArgRange.end() - ArgRange.begin()));
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003425
Reid Kleckner739756c2013-12-04 19:23:12 +00003426 // We *have* to evaluate arguments from right to left in the MS C++ ABI,
Richard Smitha560ccf2016-09-29 21:30:12 +00003427 // because arguments are destroyed left to right in the callee. As a special
3428 // case, there are certain language constructs that require left-to-right
3429 // evaluation, and in those cases we consider the evaluation order requirement
3430 // to trump the "destruction order is reverse construction order" guarantee.
3431 bool LeftToRight =
3432 CGM.getTarget().getCXXABI().areArgsDestroyedLeftToRightInCallee()
3433 ? Order == EvaluationOrder::ForceLeftToRight
3434 : Order != EvaluationOrder::ForceRightToLeft;
3435
George Burgess IV0d6592a2017-02-23 05:59:56 +00003436 auto MaybeEmitImplicitObjectSize = [&](unsigned I, const Expr *Arg,
3437 RValue EmittedArg) {
Vedant Kumared00ea02017-03-06 05:28:22 +00003438 if (!AC.hasFunctionDecl() || I >= AC.getNumParams())
George Burgess IV0d6592a2017-02-23 05:59:56 +00003439 return;
Vedant Kumared00ea02017-03-06 05:28:22 +00003440 auto *PS = AC.getParamDecl(I)->getAttr<PassObjectSizeAttr>();
George Burgess IV0d6592a2017-02-23 05:59:56 +00003441 if (PS == nullptr)
3442 return;
3443
3444 const auto &Context = getContext();
3445 auto SizeTy = Context.getSizeType();
3446 auto T = Builder.getIntNTy(Context.getTypeSize(SizeTy));
3447 assert(EmittedArg.getScalarVal() && "We emitted nothing for the arg?");
3448 llvm::Value *V = evaluateOrEmitBuiltinObjectSize(Arg, PS->getType(), T,
3449 EmittedArg.getScalarVal());
3450 Args.add(RValue::get(V), SizeTy);
3451 // If we're emitting args in reverse, be sure to do so with
3452 // pass_object_size, as well.
3453 if (!LeftToRight)
3454 std::swap(Args.back(), *(&Args.back() - 1));
3455 };
3456
Richard Smitha560ccf2016-09-29 21:30:12 +00003457 // Insert a stack save if we're going to need any inalloca args.
3458 bool HasInAllocaArgs = false;
3459 if (CGM.getTarget().getCXXABI().isMicrosoft()) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003460 for (ArrayRef<QualType>::iterator I = ArgTypes.begin(), E = ArgTypes.end();
3461 I != E && !HasInAllocaArgs; ++I)
3462 HasInAllocaArgs = isInAllocaArgument(CGM.getCXXABI(), *I);
3463 if (HasInAllocaArgs) {
3464 assert(getTarget().getTriple().getArch() == llvm::Triple::x86);
3465 Args.allocateArgumentMemory(*this);
3466 }
Richard Smitha560ccf2016-09-29 21:30:12 +00003467 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003468
Richard Smitha560ccf2016-09-29 21:30:12 +00003469 // Evaluate each argument in the appropriate order.
3470 size_t CallArgsStart = Args.size();
3471 for (unsigned I = 0, E = ArgTypes.size(); I != E; ++I) {
3472 unsigned Idx = LeftToRight ? I : E - I - 1;
3473 CallExpr::const_arg_iterator Arg = ArgRange.begin() + Idx;
George Burgess IV0d6592a2017-02-23 05:59:56 +00003474 unsigned InitialArgSize = Args.size();
Akira Hatanaka46dd7dbc2017-06-28 00:42:48 +00003475 // If *Arg is an ObjCIndirectCopyRestoreExpr, check that either the types of
3476 // the argument and parameter match or the objc method is parameterized.
3477 assert((!isa<ObjCIndirectCopyRestoreExpr>(*Arg) ||
3478 getContext().hasSameUnqualifiedType((*Arg)->getType(),
3479 ArgTypes[Idx]) ||
3480 (isa<ObjCMethodDecl>(AC.getDecl()) &&
3481 isObjCMethodWithTypeParams(cast<ObjCMethodDecl>(AC.getDecl())))) &&
3482 "Argument and parameter types don't match");
Richard Smitha560ccf2016-09-29 21:30:12 +00003483 EmitCallArg(Args, *Arg, ArgTypes[Idx]);
George Burgess IV0d6592a2017-02-23 05:59:56 +00003484 // In particular, we depend on it being the last arg in Args, and the
3485 // objectsize bits depend on there only being one arg if !LeftToRight.
3486 assert(InitialArgSize + 1 == Args.size() &&
3487 "The code below depends on only adding one arg per EmitCallArg");
3488 (void)InitialArgSize;
Yaxun Liu5b330e82018-03-15 15:25:19 +00003489 // Since pointer argument are never emitted as LValue, it is safe to emit
3490 // non-null argument check for r-value only.
3491 if (!Args.back().hasLValue()) {
3492 RValue RVArg = Args.back().getKnownRValue();
3493 EmitNonNullArgCheck(RVArg, ArgTypes[Idx], (*Arg)->getExprLoc(), AC,
3494 ParamsToSkip + Idx);
3495 // @llvm.objectsize should never have side-effects and shouldn't need
3496 // destruction/cleanups, so we can safely "emit" it after its arg,
3497 // regardless of right-to-leftness
3498 MaybeEmitImplicitObjectSize(Idx, *Arg, RVArg);
3499 }
Richard Smitha560ccf2016-09-29 21:30:12 +00003500 }
Reid Kleckner739756c2013-12-04 19:23:12 +00003501
Richard Smitha560ccf2016-09-29 21:30:12 +00003502 if (!LeftToRight) {
Reid Kleckner739756c2013-12-04 19:23:12 +00003503 // Un-reverse the arguments we just evaluated so they match up with the LLVM
3504 // IR function.
3505 std::reverse(Args.begin() + CallArgsStart, Args.end());
Reid Kleckner739756c2013-12-04 19:23:12 +00003506 }
3507}
3508
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003509namespace {
3510
David Blaikie7e70d682015-08-18 22:40:54 +00003511struct DestroyUnpassedArg final : EHScopeStack::Cleanup {
John McCall7f416cc2015-09-08 08:05:57 +00003512 DestroyUnpassedArg(Address Addr, QualType Ty)
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003513 : Addr(Addr), Ty(Ty) {}
3514
John McCall7f416cc2015-09-08 08:05:57 +00003515 Address Addr;
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003516 QualType Ty;
3517
Craig Topper4f12f102014-03-12 06:41:41 +00003518 void Emit(CodeGenFunction &CGF, Flags flags) override {
Akira Hatanaka7275da02018-02-28 07:15:55 +00003519 QualType::DestructionKind DtorKind = Ty.isDestructedType();
3520 if (DtorKind == QualType::DK_cxx_destructor) {
3521 const CXXDestructorDecl *Dtor = Ty->getAsCXXRecordDecl()->getDestructor();
3522 assert(!Dtor->isTrivial());
3523 CGF.EmitCXXDestructorCall(Dtor, Dtor_Complete, /*for vbase*/ false,
3524 /*Delegating=*/false, Addr);
3525 } else {
3526 CGF.callCStructDestructor(CGF.MakeAddrLValue(Addr, Ty));
3527 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003528 }
3529};
3530
David Blaikie38b25912015-02-09 19:13:51 +00003531struct DisableDebugLocationUpdates {
3532 CodeGenFunction &CGF;
3533 bool disabledDebugInfo;
3534 DisableDebugLocationUpdates(CodeGenFunction &CGF, const Expr *E) : CGF(CGF) {
3535 if ((disabledDebugInfo = isa<CXXDefaultArgExpr>(E) && CGF.getDebugInfo()))
3536 CGF.disableDebugInfo();
3537 }
3538 ~DisableDebugLocationUpdates() {
3539 if (disabledDebugInfo)
3540 CGF.enableDebugInfo();
3541 }
3542};
3543
Benjamin Kramer5b4296a2015-10-28 17:16:26 +00003544} // end anonymous namespace
3545
Yaxun Liu5b330e82018-03-15 15:25:19 +00003546RValue CallArg::getRValue(CodeGenFunction &CGF) const {
3547 if (!HasLV)
3548 return RV;
3549 LValue Copy = CGF.MakeAddrLValue(CGF.CreateMemTemp(Ty), Ty);
Richard Smithe78fac52018-04-05 20:52:58 +00003550 CGF.EmitAggregateCopy(Copy, LV, Ty, AggValueSlot::DoesNotOverlap,
3551 LV.isVolatile());
Yaxun Liu5b330e82018-03-15 15:25:19 +00003552 IsUsed = true;
3553 return RValue::getAggregate(Copy.getAddress());
3554}
3555
3556void CallArg::copyInto(CodeGenFunction &CGF, Address Addr) const {
3557 LValue Dst = CGF.MakeAddrLValue(Addr, Ty);
3558 if (!HasLV && RV.isScalar())
3559 CGF.EmitStoreOfScalar(RV.getScalarVal(), Dst, /*init=*/true);
3560 else if (!HasLV && RV.isComplex())
3561 CGF.EmitStoreOfComplex(RV.getComplexVal(), Dst, /*init=*/true);
3562 else {
3563 auto Addr = HasLV ? LV.getAddress() : RV.getAggregateAddress();
3564 LValue SrcLV = CGF.MakeAddrLValue(Addr, Ty);
Richard Smithe78fac52018-04-05 20:52:58 +00003565 // We assume that call args are never copied into subobjects.
3566 CGF.EmitAggregateCopy(Dst, SrcLV, Ty, AggValueSlot::DoesNotOverlap,
Yaxun Liu5b330e82018-03-15 15:25:19 +00003567 HasLV ? LV.isVolatileQualified()
3568 : RV.isVolatileQualified());
3569 }
3570 IsUsed = true;
3571}
3572
John McCall32ea9692011-03-11 20:59:21 +00003573void CodeGenFunction::EmitCallArg(CallArgList &args, const Expr *E,
3574 QualType type) {
David Blaikie38b25912015-02-09 19:13:51 +00003575 DisableDebugLocationUpdates Dis(*this, E);
John McCall31168b02011-06-15 23:02:42 +00003576 if (const ObjCIndirectCopyRestoreExpr *CRE
3577 = dyn_cast<ObjCIndirectCopyRestoreExpr>(E)) {
Richard Smith9c6890a2012-11-01 22:30:59 +00003578 assert(getLangOpts().ObjCAutoRefCount);
John McCall31168b02011-06-15 23:02:42 +00003579 return emitWritebackArg(*this, args, CRE);
3580 }
3581
John McCall0a76c0c2011-08-26 18:42:59 +00003582 assert(type->isReferenceType() == E->isGLValue() &&
3583 "reference binding to unmaterialized r-value!");
3584
John McCall17054bd62011-08-26 21:08:13 +00003585 if (E->isGLValue()) {
3586 assert(E->getObjectKind() == OK_Ordinary);
Richard Smitha1c9d4d2013-06-12 23:38:09 +00003587 return args.add(EmitReferenceBindingToExpr(E), type);
John McCall17054bd62011-08-26 21:08:13 +00003588 }
Mike Stump11289f42009-09-09 15:08:12 +00003589
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003590 bool HasAggregateEvalKind = hasAggregateEvaluationKind(type);
3591
3592 // In the Microsoft C++ ABI, aggregate arguments are destructed by the callee.
3593 // However, we still have to push an EH-only cleanup in case we unwind before
3594 // we make it to the call.
Akira Hatanaka85282972018-05-15 21:00:30 +00003595 if (HasAggregateEvalKind &&
3596 type->getAs<RecordType>()->getDecl()->isParamDestroyedInCallee()) {
Reid Klecknerac640602014-05-01 03:07:18 +00003597 // If we're using inalloca, use the argument memory. Otherwise, use a
Reid Klecknere39ee212014-05-03 00:33:28 +00003598 // temporary.
Reid Klecknerac640602014-05-01 03:07:18 +00003599 AggValueSlot Slot;
3600 if (args.isUsingInAlloca())
3601 Slot = createPlaceholderSlot(*this, type);
3602 else
3603 Slot = CreateAggTemp(type, "agg.tmp");
Reid Klecknere39ee212014-05-03 00:33:28 +00003604
Akira Hatanaka4ce0e5a2018-04-18 23:33:15 +00003605 bool DestroyedInCallee = true, NeedsEHCleanup = true;
3606 if (const auto *RD = type->getAsCXXRecordDecl())
3607 DestroyedInCallee = RD->hasNonTrivialDestructor();
3608 else
3609 NeedsEHCleanup = needsEHCleanup(type.isDestructedType());
3610
3611 if (DestroyedInCallee)
3612 Slot.setExternallyDestructed();
Reid Klecknere39ee212014-05-03 00:33:28 +00003613
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003614 EmitAggExpr(E, Slot);
3615 RValue RV = Slot.asRValue();
3616 args.add(RV, type);
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003617
Akira Hatanaka4ce0e5a2018-04-18 23:33:15 +00003618 if (DestroyedInCallee && NeedsEHCleanup) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003619 // Create a no-op GEP between the placeholder and the cleanup so we can
3620 // RAUW it successfully. It also serves as a marker of the first
3621 // instruction where the cleanup is active.
John McCall7f416cc2015-09-08 08:05:57 +00003622 pushFullExprCleanup<DestroyUnpassedArg>(EHCleanup, Slot.getAddress(),
3623 type);
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003624 // This unreachable is a temporary marker which will be removed later.
3625 llvm::Instruction *IsActive = Builder.CreateUnreachable();
3626 args.addArgCleanupDeactivation(EHStack.getInnermostEHScope(), IsActive);
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003627 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003628 return;
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003629 }
3630
3631 if (HasAggregateEvalKind && isa<ImplicitCastExpr>(E) &&
Eli Friedmandf968192011-05-26 00:10:27 +00003632 cast<CastExpr>(E)->getCastKind() == CK_LValueToRValue) {
3633 LValue L = EmitLValue(cast<CastExpr>(E)->getSubExpr());
3634 assert(L.isSimple());
Yaxun Liu5b330e82018-03-15 15:25:19 +00003635 args.addUncopiedAggregate(L, type);
Eli Friedmandf968192011-05-26 00:10:27 +00003636 return;
3637 }
3638
John McCall32ea9692011-03-11 20:59:21 +00003639 args.add(EmitAnyExprToTemp(E), type);
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00003640}
3641
Reid Kleckner79b0fd72014-10-10 00:05:45 +00003642QualType CodeGenFunction::getVarArgType(const Expr *Arg) {
3643 // System headers on Windows define NULL to 0 instead of 0LL on Win64. MSVC
3644 // implicitly widens null pointer constants that are arguments to varargs
3645 // functions to pointer-sized ints.
3646 if (!getTarget().getTriple().isOSWindows())
3647 return Arg->getType();
3648
3649 if (Arg->getType()->isIntegerType() &&
3650 getContext().getTypeSize(Arg->getType()) <
3651 getContext().getTargetInfo().getPointerWidth(0) &&
3652 Arg->isNullPointerConstant(getContext(),
3653 Expr::NPC_ValueDependentIsNotNull)) {
3654 return getContext().getIntPtrType();
3655 }
3656
3657 return Arg->getType();
3658}
3659
Dan Gohman515a60d2012-02-16 00:57:37 +00003660// In ObjC ARC mode with no ObjC ARC exception safety, tell the ARC
3661// optimizer it can aggressively ignore unwind edges.
3662void
3663CodeGenFunction::AddObjCARCExceptionMetadata(llvm::Instruction *Inst) {
3664 if (CGM.getCodeGenOpts().OptimizationLevel != 0 &&
3665 !CGM.getCodeGenOpts().ObjCAutoRefCountExceptions)
3666 Inst->setMetadata("clang.arc.no_objc_arc_exceptions",
3667 CGM.getNoObjCARCExceptionsMetadata());
3668}
3669
John McCall882987f2013-02-28 19:01:20 +00003670/// Emits a call to the given no-arguments nounwind runtime function.
3671llvm::CallInst *
3672CodeGenFunction::EmitNounwindRuntimeCall(llvm::Value *callee,
3673 const llvm::Twine &name) {
Craig Topper5fc8fc22014-08-27 06:28:36 +00003674 return EmitNounwindRuntimeCall(callee, None, name);
John McCall882987f2013-02-28 19:01:20 +00003675}
3676
3677/// Emits a call to the given nounwind runtime function.
3678llvm::CallInst *
3679CodeGenFunction::EmitNounwindRuntimeCall(llvm::Value *callee,
3680 ArrayRef<llvm::Value*> args,
3681 const llvm::Twine &name) {
3682 llvm::CallInst *call = EmitRuntimeCall(callee, args, name);
3683 call->setDoesNotThrow();
3684 return call;
3685}
3686
3687/// Emits a simple call (never an invoke) to the given no-arguments
3688/// runtime function.
3689llvm::CallInst *
3690CodeGenFunction::EmitRuntimeCall(llvm::Value *callee,
3691 const llvm::Twine &name) {
Craig Topper5fc8fc22014-08-27 06:28:36 +00003692 return EmitRuntimeCall(callee, None, name);
John McCall882987f2013-02-28 19:01:20 +00003693}
3694
David Majnemer0b17d442015-12-15 21:27:59 +00003695// Calls which may throw must have operand bundles indicating which funclet
3696// they are nested within.
Reid Klecknerb75a3f02018-02-09 00:16:41 +00003697SmallVector<llvm::OperandBundleDef, 1>
3698CodeGenFunction::getBundlesForFunclet(llvm::Value *Callee) {
3699 SmallVector<llvm::OperandBundleDef, 1> BundleList;
Sanjay Patel846b63b2016-01-18 22:15:33 +00003700 // There is no need for a funclet operand bundle if we aren't inside a
3701 // funclet.
David Majnemer0b17d442015-12-15 21:27:59 +00003702 if (!CurrentFuncletPad)
Reid Klecknerb75a3f02018-02-09 00:16:41 +00003703 return BundleList;
David Majnemer0b17d442015-12-15 21:27:59 +00003704
3705 // Skip intrinsics which cannot throw.
3706 auto *CalleeFn = dyn_cast<llvm::Function>(Callee->stripPointerCasts());
3707 if (CalleeFn && CalleeFn->isIntrinsic() && CalleeFn->doesNotThrow())
Reid Klecknerb75a3f02018-02-09 00:16:41 +00003708 return BundleList;
David Majnemer0b17d442015-12-15 21:27:59 +00003709
3710 BundleList.emplace_back("funclet", CurrentFuncletPad);
Reid Klecknerb75a3f02018-02-09 00:16:41 +00003711 return BundleList;
David Majnemer0b17d442015-12-15 21:27:59 +00003712}
3713
David Majnemer971d31b2016-02-24 17:02:45 +00003714/// Emits a simple call (never an invoke) to the given runtime function.
3715llvm::CallInst *
3716CodeGenFunction::EmitRuntimeCall(llvm::Value *callee,
3717 ArrayRef<llvm::Value*> args,
3718 const llvm::Twine &name) {
Reid Klecknerb75a3f02018-02-09 00:16:41 +00003719 llvm::CallInst *call =
3720 Builder.CreateCall(callee, args, getBundlesForFunclet(callee), name);
David Majnemer971d31b2016-02-24 17:02:45 +00003721 call->setCallingConv(getRuntimeCC());
3722 return call;
3723}
3724
John McCall882987f2013-02-28 19:01:20 +00003725/// Emits a call or invoke to the given noreturn runtime function.
3726void CodeGenFunction::EmitNoreturnRuntimeCallOrInvoke(llvm::Value *callee,
3727 ArrayRef<llvm::Value*> args) {
Reid Klecknerb75a3f02018-02-09 00:16:41 +00003728 SmallVector<llvm::OperandBundleDef, 1> BundleList =
3729 getBundlesForFunclet(callee);
David Majnemer0b17d442015-12-15 21:27:59 +00003730
John McCall882987f2013-02-28 19:01:20 +00003731 if (getInvokeDest()) {
Fangrui Song6907ce22018-07-30 19:24:48 +00003732 llvm::InvokeInst *invoke =
John McCall882987f2013-02-28 19:01:20 +00003733 Builder.CreateInvoke(callee,
3734 getUnreachableBlock(),
3735 getInvokeDest(),
David Majnemer0b17d442015-12-15 21:27:59 +00003736 args,
3737 BundleList);
John McCall882987f2013-02-28 19:01:20 +00003738 invoke->setDoesNotReturn();
3739 invoke->setCallingConv(getRuntimeCC());
3740 } else {
David Majnemer0b17d442015-12-15 21:27:59 +00003741 llvm::CallInst *call = Builder.CreateCall(callee, args, BundleList);
John McCall882987f2013-02-28 19:01:20 +00003742 call->setDoesNotReturn();
3743 call->setCallingConv(getRuntimeCC());
3744 Builder.CreateUnreachable();
3745 }
3746}
3747
Sanjay Patel846b63b2016-01-18 22:15:33 +00003748/// Emits a call or invoke instruction to the given nullary runtime function.
John McCall882987f2013-02-28 19:01:20 +00003749llvm::CallSite
3750CodeGenFunction::EmitRuntimeCallOrInvoke(llvm::Value *callee,
3751 const Twine &name) {
Craig Topper5fc8fc22014-08-27 06:28:36 +00003752 return EmitRuntimeCallOrInvoke(callee, None, name);
John McCall882987f2013-02-28 19:01:20 +00003753}
3754
3755/// Emits a call or invoke instruction to the given runtime function.
3756llvm::CallSite
3757CodeGenFunction::EmitRuntimeCallOrInvoke(llvm::Value *callee,
3758 ArrayRef<llvm::Value*> args,
3759 const Twine &name) {
3760 llvm::CallSite callSite = EmitCallOrInvoke(callee, args, name);
3761 callSite.setCallingConv(getRuntimeCC());
3762 return callSite;
3763}
3764
John McCallbd309292010-07-06 01:34:17 +00003765/// Emits a call or invoke instruction to the given function, depending
3766/// on the current state of the EH stack.
3767llvm::CallSite
3768CodeGenFunction::EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner54b16772011-07-23 17:14:25 +00003769 ArrayRef<llvm::Value *> Args,
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003770 const Twine &Name) {
John McCallbd309292010-07-06 01:34:17 +00003771 llvm::BasicBlock *InvokeDest = getInvokeDest();
Reid Klecknerb75a3f02018-02-09 00:16:41 +00003772 SmallVector<llvm::OperandBundleDef, 1> BundleList =
3773 getBundlesForFunclet(Callee);
John McCallbd309292010-07-06 01:34:17 +00003774
Dan Gohman515a60d2012-02-16 00:57:37 +00003775 llvm::Instruction *Inst;
3776 if (!InvokeDest)
David Majnemer3df77bc2016-01-26 23:14:47 +00003777 Inst = Builder.CreateCall(Callee, Args, BundleList, Name);
Dan Gohman515a60d2012-02-16 00:57:37 +00003778 else {
3779 llvm::BasicBlock *ContBB = createBasicBlock("invoke.cont");
David Majnemer3df77bc2016-01-26 23:14:47 +00003780 Inst = Builder.CreateInvoke(Callee, ContBB, InvokeDest, Args, BundleList,
3781 Name);
Dan Gohman515a60d2012-02-16 00:57:37 +00003782 EmitBlock(ContBB);
3783 }
3784
3785 // In ObjC ARC mode with no ObjC ARC exception safety, tell the ARC
3786 // optimizer it can aggressively ignore unwind edges.
David Blaikiebbafb8a2012-03-11 07:00:24 +00003787 if (CGM.getLangOpts().ObjCAutoRefCount)
Dan Gohman515a60d2012-02-16 00:57:37 +00003788 AddObjCARCExceptionMetadata(Inst);
3789
Benjamin Kramerc19cde12015-04-10 14:49:31 +00003790 return llvm::CallSite(Inst);
John McCallbd309292010-07-06 01:34:17 +00003791}
3792
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003793void CodeGenFunction::deferPlaceholderReplacement(llvm::Instruction *Old,
3794 llvm::Value *New) {
3795 DeferredReplacements.push_back(std::make_pair(Old, New));
3796}
Chris Lattnerd59d8672011-07-12 06:29:11 +00003797
Daniel Dunbard931a872009-02-02 22:03:45 +00003798RValue CodeGenFunction::EmitCall(const CGFunctionInfo &CallInfo,
John McCallb92ab1a2016-10-26 23:46:34 +00003799 const CGCallee &Callee,
Anders Carlsson61a401c2009-12-24 19:25:24 +00003800 ReturnValueSlot ReturnValue,
Daniel Dunbarcdbb5e32009-02-20 18:06:48 +00003801 const CallArgList &CallArgs,
Vedant Kumar09b5bfd2017-12-21 00:10:25 +00003802 llvm::Instruction **callOrInvoke,
3803 SourceLocation Loc) {
Mike Stump18bb9282009-05-16 07:57:57 +00003804 // FIXME: We no longer need the types from CallArgs; lift up and simplify.
Daniel Dunbar613855c2008-09-09 23:27:19 +00003805
Peter Collingbourneea211002018-02-05 23:09:13 +00003806 assert(Callee.isOrdinary() || Callee.isVirtual());
John McCallb92ab1a2016-10-26 23:46:34 +00003807
Daniel Dunbar613855c2008-09-09 23:27:19 +00003808 // Handle struct-return functions by passing a pointer to the
3809 // location that we would like to return into.
Daniel Dunbar7633cbf2009-02-02 21:43:58 +00003810 QualType RetTy = CallInfo.getReturnType();
Daniel Dunbarb52d0772009-02-03 05:59:18 +00003811 const ABIArgInfo &RetAI = CallInfo.getReturnInfo();
Mike Stump11289f42009-09-09 15:08:12 +00003812
John McCallb92ab1a2016-10-26 23:46:34 +00003813 llvm::FunctionType *IRFuncTy = Callee.getFunctionType();
3814
3815 // 1. Set up the arguments.
Mike Stump11289f42009-09-09 15:08:12 +00003816
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003817 // If we're using inalloca, insert the allocation after the stack save.
3818 // FIXME: Do this earlier rather than hacking it in here!
John McCall7f416cc2015-09-08 08:05:57 +00003819 Address ArgMemory = Address::invalid();
3820 const llvm::StructLayout *ArgMemoryLayout = nullptr;
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003821 if (llvm::StructType *ArgStruct = CallInfo.getArgStruct()) {
Matt Arsenault502ad602017-04-10 22:28:02 +00003822 const llvm::DataLayout &DL = CGM.getDataLayout();
3823 ArgMemoryLayout = DL.getStructLayout(ArgStruct);
Reid Kleckner9df1d972014-04-10 01:40:15 +00003824 llvm::Instruction *IP = CallArgs.getStackBase();
3825 llvm::AllocaInst *AI;
3826 if (IP) {
3827 IP = IP->getNextNode();
Matt Arsenault502ad602017-04-10 22:28:02 +00003828 AI = new llvm::AllocaInst(ArgStruct, DL.getAllocaAddrSpace(),
3829 "argmem", IP);
Reid Kleckner9df1d972014-04-10 01:40:15 +00003830 } else {
Reid Kleckner966abe72014-05-15 23:01:46 +00003831 AI = CreateTempAlloca(ArgStruct, "argmem");
Reid Kleckner9df1d972014-04-10 01:40:15 +00003832 }
John McCall7f416cc2015-09-08 08:05:57 +00003833 auto Align = CallInfo.getArgStructAlignment();
3834 AI->setAlignment(Align.getQuantity());
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003835 AI->setUsedWithInAlloca(true);
3836 assert(AI->isUsedWithInAlloca() && !AI->isStaticAlloca());
John McCall7f416cc2015-09-08 08:05:57 +00003837 ArgMemory = Address(AI, Align);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003838 }
3839
John McCall7f416cc2015-09-08 08:05:57 +00003840 // Helper function to drill into the inalloca allocation.
3841 auto createInAllocaStructGEP = [&](unsigned FieldIndex) -> Address {
3842 auto FieldOffset =
3843 CharUnits::fromQuantity(ArgMemoryLayout->getElementOffset(FieldIndex));
3844 return Builder.CreateStructGEP(ArgMemory, FieldIndex, FieldOffset);
3845 };
3846
Alexey Samsonov153004f2014-09-29 22:08:00 +00003847 ClangToLLVMArgMapping IRFunctionArgs(CGM.getContext(), CallInfo);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003848 SmallVector<llvm::Value *, 16> IRCallArgs(IRFunctionArgs.totalIRArgs());
3849
Chris Lattner4ca97c32009-06-13 00:26:38 +00003850 // If the call returns a temporary with struct return, create a temporary
Anders Carlsson17490832009-12-24 20:40:36 +00003851 // alloca to hold the result, unless one is given to us.
John McCall7f416cc2015-09-08 08:05:57 +00003852 Address SRetPtr = Address::invalid();
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00003853 Address SRetAlloca = Address::invalid();
George Burgess IV003be7c2018-03-08 05:32:30 +00003854 llvm::Value *UnusedReturnSizePtr = nullptr;
John McCallf26e73d2016-03-11 04:30:43 +00003855 if (RetAI.isIndirect() || RetAI.isInAlloca() || RetAI.isCoerceAndExpand()) {
John McCall7f416cc2015-09-08 08:05:57 +00003856 if (!ReturnValue.isNull()) {
3857 SRetPtr = ReturnValue.getValue();
3858 } else {
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00003859 SRetPtr = CreateMemTemp(RetTy, "tmp", &SRetAlloca);
Leny Kholodov6aab1112015-06-08 10:23:49 +00003860 if (HaveInsertPoint() && ReturnValue.isUnused()) {
3861 uint64_t size =
3862 CGM.getDataLayout().getTypeAllocSize(ConvertTypeForMem(RetTy));
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00003863 UnusedReturnSizePtr = EmitLifetimeStart(size, SRetAlloca.getPointer());
Leny Kholodov6aab1112015-06-08 10:23:49 +00003864 }
3865 }
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003866 if (IRFunctionArgs.hasSRetArg()) {
John McCall7f416cc2015-09-08 08:05:57 +00003867 IRCallArgs[IRFunctionArgs.getSRetArgNo()] = SRetPtr.getPointer();
John McCallf26e73d2016-03-11 04:30:43 +00003868 } else if (RetAI.isInAlloca()) {
John McCall7f416cc2015-09-08 08:05:57 +00003869 Address Addr = createInAllocaStructGEP(RetAI.getInAllocaFieldIndex());
3870 Builder.CreateStore(SRetPtr.getPointer(), Addr);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003871 }
Anders Carlsson17490832009-12-24 20:40:36 +00003872 }
Mike Stump11289f42009-09-09 15:08:12 +00003873
John McCall12f23522016-04-04 18:33:08 +00003874 Address swiftErrorTemp = Address::invalid();
3875 Address swiftErrorArg = Address::invalid();
3876
John McCallb92ab1a2016-10-26 23:46:34 +00003877 // Translate all of the arguments as necessary to match the IR lowering.
Daniel Dunbara45bdbb2009-02-04 21:17:21 +00003878 assert(CallInfo.arg_size() == CallArgs.size() &&
3879 "Mismatch between function signature & arguments.");
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003880 unsigned ArgNo = 0;
Daniel Dunbarb52d0772009-02-03 05:59:18 +00003881 CGFunctionInfo::const_arg_iterator info_it = CallInfo.arg_begin();
Mike Stump11289f42009-09-09 15:08:12 +00003882 for (CallArgList::const_iterator I = CallArgs.begin(), E = CallArgs.end();
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003883 I != E; ++I, ++info_it, ++ArgNo) {
Daniel Dunbarb52d0772009-02-03 05:59:18 +00003884 const ABIArgInfo &ArgInfo = info_it->info;
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00003885
Rafael Espindolafad28de2012-10-24 01:59:00 +00003886 // Insert a padding argument to ensure proper alignment.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003887 if (IRFunctionArgs.hasPaddingArg(ArgNo))
3888 IRCallArgs[IRFunctionArgs.getPaddingArgNo(ArgNo)] =
3889 llvm::UndefValue::get(ArgInfo.getPaddingType());
3890
3891 unsigned FirstIRArg, NumIRArgs;
3892 std::tie(FirstIRArg, NumIRArgs) = IRFunctionArgs.getIRArgs(ArgNo);
Rafael Espindolafad28de2012-10-24 01:59:00 +00003893
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00003894 switch (ArgInfo.getKind()) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003895 case ABIArgInfo::InAlloca: {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003896 assert(NumIRArgs == 0);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003897 assert(getTarget().getTriple().getArch() == llvm::Triple::x86);
Yaxun Liu5b330e82018-03-15 15:25:19 +00003898 if (I->isAggregate()) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003899 // Replace the placeholder with the appropriate argument slot GEP.
Yaxun Liu5b330e82018-03-15 15:25:19 +00003900 Address Addr = I->hasLValue()
3901 ? I->getKnownLValue().getAddress()
3902 : I->getKnownRValue().getAggregateAddress();
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003903 llvm::Instruction *Placeholder =
Yaxun Liu5b330e82018-03-15 15:25:19 +00003904 cast<llvm::Instruction>(Addr.getPointer());
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003905 CGBuilderTy::InsertPoint IP = Builder.saveIP();
3906 Builder.SetInsertPoint(Placeholder);
Yaxun Liu5b330e82018-03-15 15:25:19 +00003907 Addr = createInAllocaStructGEP(ArgInfo.getInAllocaFieldIndex());
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003908 Builder.restoreIP(IP);
John McCall7f416cc2015-09-08 08:05:57 +00003909 deferPlaceholderReplacement(Placeholder, Addr.getPointer());
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003910 } else {
3911 // Store the RValue into the argument struct.
John McCall7f416cc2015-09-08 08:05:57 +00003912 Address Addr = createInAllocaStructGEP(ArgInfo.getInAllocaFieldIndex());
3913 unsigned AS = Addr.getType()->getPointerAddressSpace();
David Majnemer32b57b02014-03-31 16:12:47 +00003914 llvm::Type *MemType = ConvertTypeForMem(I->Ty)->getPointerTo(AS);
3915 // There are some cases where a trivial bitcast is not avoidable. The
3916 // definition of a type later in a translation unit may change it's type
3917 // from {}* to (%struct.foo*)*.
John McCall7f416cc2015-09-08 08:05:57 +00003918 if (Addr.getType() != MemType)
David Majnemer32b57b02014-03-31 16:12:47 +00003919 Addr = Builder.CreateBitCast(Addr, MemType);
Yaxun Liu5b330e82018-03-15 15:25:19 +00003920 I->copyInto(*this, Addr);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003921 }
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003922 break;
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003923 }
3924
Daniel Dunbar03816342010-08-21 02:24:36 +00003925 case ABIArgInfo::Indirect: {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003926 assert(NumIRArgs == 1);
Yaxun Liu5b330e82018-03-15 15:25:19 +00003927 if (!I->isAggregate()) {
Daniel Dunbar747865a2009-02-05 09:16:39 +00003928 // Make a temporary alloca to pass the argument.
Yaxun Liuaefdb8e2018-06-15 15:33:22 +00003929 Address Addr = CreateMemTempWithoutCast(
3930 I->Ty, ArgInfo.getIndirectAlign(), "indirect-arg-temp");
John McCall7f416cc2015-09-08 08:05:57 +00003931 IRCallArgs[FirstIRArg] = Addr.getPointer();
John McCall47fb9502013-03-07 21:37:08 +00003932
Yaxun Liu5b330e82018-03-15 15:25:19 +00003933 I->copyInto(*this, Addr);
Daniel Dunbar747865a2009-02-05 09:16:39 +00003934 } else {
Eli Friedmaneb7fab62011-06-14 01:37:52 +00003935 // We want to avoid creating an unnecessary temporary+copy here;
Guy Benyei3832bfd2013-03-10 12:59:00 +00003936 // however, we need one in three cases:
Eli Friedmaneb7fab62011-06-14 01:37:52 +00003937 // 1. If the argument is not byval, and we are required to copy the
3938 // source. (This case doesn't occur on any common architecture.)
3939 // 2. If the argument is byval, RV is not sufficiently aligned, and
3940 // we cannot force it to be sufficiently aligned.
Yaxun Liu5b330e82018-03-15 15:25:19 +00003941 // 3. If the argument is byval, but RV is not located in default
3942 // or alloca address space.
3943 Address Addr = I->hasLValue()
3944 ? I->getKnownLValue().getAddress()
3945 : I->getKnownRValue().getAggregateAddress();
3946 llvm::Value *V = Addr.getPointer();
John McCall7f416cc2015-09-08 08:05:57 +00003947 CharUnits Align = ArgInfo.getIndirectAlign();
Micah Villmowdd31ca12012-10-08 16:25:52 +00003948 const llvm::DataLayout *TD = &CGM.getDataLayout();
Yaxun Liu5b330e82018-03-15 15:25:19 +00003949
3950 assert((FirstIRArg >= IRFuncTy->getNumParams() ||
3951 IRFuncTy->getParamType(FirstIRArg)->getPointerAddressSpace() ==
3952 TD->getAllocaAddrSpace()) &&
3953 "indirect argument must be in alloca address space");
3954
3955 bool NeedCopy = false;
3956
3957 if (Addr.getAlignment() < Align &&
3958 llvm::getOrEnforceKnownAlignment(V, Align.getQuantity(), *TD) <
3959 Align.getQuantity()) {
3960 NeedCopy = true;
3961 } else if (I->hasLValue()) {
3962 auto LV = I->getKnownLValue();
3963 auto AS = LV.getAddressSpace();
Andrew Savonichev1bf1a152018-12-10 12:03:00 +00003964
Yaxun Liu5b330e82018-03-15 15:25:19 +00003965 if ((!ArgInfo.getIndirectByVal() &&
3966 (LV.getAlignment() >=
Andrew Savonichev1bf1a152018-12-10 12:03:00 +00003967 getContext().getTypeAlignInChars(I->Ty)))) {
3968 NeedCopy = true;
3969 }
3970 if (!getLangOpts().OpenCL) {
3971 if ((ArgInfo.getIndirectByVal() &&
3972 (AS != LangAS::Default &&
3973 AS != CGM.getASTAllocaAddressSpace()))) {
3974 NeedCopy = true;
3975 }
3976 }
3977 // For OpenCL even if RV is located in default or alloca address space
3978 // we don't want to perform address space cast for it.
3979 else if ((ArgInfo.getIndirectByVal() &&
3980 Addr.getType()->getAddressSpace() != IRFuncTy->
3981 getParamType(FirstIRArg)->getPointerAddressSpace())) {
Yaxun Liu5b330e82018-03-15 15:25:19 +00003982 NeedCopy = true;
3983 }
3984 }
Andrew Savonichev1bf1a152018-12-10 12:03:00 +00003985
Yaxun Liu5b330e82018-03-15 15:25:19 +00003986 if (NeedCopy) {
Eli Friedmaneb7fab62011-06-14 01:37:52 +00003987 // Create an aligned temporary, and copy to it.
Yaxun Liuaefdb8e2018-06-15 15:33:22 +00003988 Address AI = CreateMemTempWithoutCast(
3989 I->Ty, ArgInfo.getIndirectAlign(), "byval-temp");
John McCall7f416cc2015-09-08 08:05:57 +00003990 IRCallArgs[FirstIRArg] = AI.getPointer();
Yaxun Liu5b330e82018-03-15 15:25:19 +00003991 I->copyInto(*this, AI);
Eli Friedmaneb7fab62011-06-14 01:37:52 +00003992 } else {
3993 // Skip the extra memcpy call.
Yaxun Liu5b330e82018-03-15 15:25:19 +00003994 auto *T = V->getType()->getPointerElementType()->getPointerTo(
3995 CGM.getDataLayout().getAllocaAddrSpace());
3996 IRCallArgs[FirstIRArg] = getTargetHooks().performAddrSpaceCast(
3997 *this, V, LangAS::Default, CGM.getASTAllocaAddressSpace(), T,
3998 true);
Eli Friedmaneb7fab62011-06-14 01:37:52 +00003999 }
Daniel Dunbar747865a2009-02-05 09:16:39 +00004000 }
4001 break;
Daniel Dunbar03816342010-08-21 02:24:36 +00004002 }
Daniel Dunbar747865a2009-02-05 09:16:39 +00004003
Daniel Dunbar94a6f252009-01-26 21:26:08 +00004004 case ABIArgInfo::Ignore:
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004005 assert(NumIRArgs == 0);
Daniel Dunbar94a6f252009-01-26 21:26:08 +00004006 break;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004007
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00004008 case ABIArgInfo::Extend:
4009 case ABIArgInfo::Direct: {
4010 if (!isa<llvm::StructType>(ArgInfo.getCoerceToType()) &&
Chris Lattner8a2f3c72010-07-30 04:02:24 +00004011 ArgInfo.getCoerceToType() == ConvertType(info_it->type) &&
4012 ArgInfo.getDirectOffset() == 0) {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004013 assert(NumIRArgs == 1);
Chris Lattnerbb1952c2011-07-12 04:46:18 +00004014 llvm::Value *V;
Yaxun Liu5b330e82018-03-15 15:25:19 +00004015 if (!I->isAggregate())
4016 V = I->getKnownRValue().getScalarVal();
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00004017 else
Yaxun Liu5b330e82018-03-15 15:25:19 +00004018 V = Builder.CreateLoad(
4019 I->hasLValue() ? I->getKnownLValue().getAddress()
4020 : I->getKnownRValue().getAggregateAddress());
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004021
John McCall12f23522016-04-04 18:33:08 +00004022 // Implement swifterror by copying into a new swifterror argument.
4023 // We'll write back in the normal path out of the call.
4024 if (CallInfo.getExtParameterInfo(ArgNo).getABI()
4025 == ParameterABI::SwiftErrorResult) {
4026 assert(!swiftErrorTemp.isValid() && "multiple swifterror args");
4027
4028 QualType pointeeTy = I->Ty->getPointeeType();
4029 swiftErrorArg =
4030 Address(V, getContext().getTypeAlignInChars(pointeeTy));
4031
4032 swiftErrorTemp =
4033 CreateMemTemp(pointeeTy, getPointerAlign(), "swifterror.temp");
4034 V = swiftErrorTemp.getPointer();
4035 cast<llvm::AllocaInst>(V)->setSwiftError(true);
4036
4037 llvm::Value *errorValue = Builder.CreateLoad(swiftErrorArg);
4038 Builder.CreateStore(errorValue, swiftErrorTemp);
4039 }
4040
Reid Kleckner79b0fd72014-10-10 00:05:45 +00004041 // We might have to widen integers, but we should never truncate.
4042 if (ArgInfo.getCoerceToType() != V->getType() &&
4043 V->getType()->isIntegerTy())
4044 V = Builder.CreateZExt(V, ArgInfo.getCoerceToType());
4045
Chris Lattner3ce86682011-07-12 04:53:39 +00004046 // If the argument doesn't match, perform a bitcast to coerce it. This
4047 // can happen due to trivial type mismatches.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004048 if (FirstIRArg < IRFuncTy->getNumParams() &&
4049 V->getType() != IRFuncTy->getParamType(FirstIRArg))
4050 V = Builder.CreateBitCast(V, IRFuncTy->getParamType(FirstIRArg));
John McCall12f23522016-04-04 18:33:08 +00004051
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004052 IRCallArgs[FirstIRArg] = V;
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00004053 break;
4054 }
Daniel Dunbar94a6f252009-01-26 21:26:08 +00004055
Daniel Dunbar2f219b02009-02-03 19:12:28 +00004056 // FIXME: Avoid the conversion through memory if possible.
John McCall7f416cc2015-09-08 08:05:57 +00004057 Address Src = Address::invalid();
Yaxun Liu5b330e82018-03-15 15:25:19 +00004058 if (!I->isAggregate()) {
John McCall7f416cc2015-09-08 08:05:57 +00004059 Src = CreateMemTemp(I->Ty, "coerce");
Yaxun Liu5b330e82018-03-15 15:25:19 +00004060 I->copyInto(*this, Src);
Ulrich Weigand6e2cea62015-07-10 11:31:43 +00004061 } else {
Yaxun Liu5b330e82018-03-15 15:25:19 +00004062 Src = I->hasLValue() ? I->getKnownLValue().getAddress()
4063 : I->getKnownRValue().getAggregateAddress();
Ulrich Weigand6e2cea62015-07-10 11:31:43 +00004064 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004065
Chris Lattner8a2f3c72010-07-30 04:02:24 +00004066 // If the value is offset in memory, apply the offset now.
John McCall7f416cc2015-09-08 08:05:57 +00004067 Src = emitAddressAtOffset(*this, Src, ArgInfo);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004068
Oliver Stannard2bfdc5b2014-08-27 10:43:15 +00004069 // Fast-isel and the optimizer generally like scalar values better than
4070 // FCAs, so we flatten them if this is safe to do for this argument.
James Molloy6f244b62014-05-09 16:21:39 +00004071 llvm::StructType *STy =
4072 dyn_cast<llvm::StructType>(ArgInfo.getCoerceToType());
Oliver Stannard2bfdc5b2014-08-27 10:43:15 +00004073 if (STy && ArgInfo.isDirect() && ArgInfo.getCanBeFlattened()) {
John McCall7f416cc2015-09-08 08:05:57 +00004074 llvm::Type *SrcTy = Src.getType()->getElementType();
Chandler Carrutha6399a52012-10-10 11:29:08 +00004075 uint64_t SrcSize = CGM.getDataLayout().getTypeAllocSize(SrcTy);
4076 uint64_t DstSize = CGM.getDataLayout().getTypeAllocSize(STy);
4077
4078 // If the source type is smaller than the destination type of the
4079 // coerce-to logic, copy the source value into a temp alloca the size
4080 // of the destination type to allow loading all of it. The bits past
4081 // the source value are left undef.
4082 if (SrcSize < DstSize) {
John McCall7f416cc2015-09-08 08:05:57 +00004083 Address TempAlloca
4084 = CreateTempAlloca(STy, Src.getAlignment(),
4085 Src.getName() + ".coerce");
4086 Builder.CreateMemCpy(TempAlloca, Src, SrcSize);
4087 Src = TempAlloca;
Chandler Carrutha6399a52012-10-10 11:29:08 +00004088 } else {
Matt Arsenault7a124f32017-08-01 20:36:57 +00004089 Src = Builder.CreateBitCast(Src,
4090 STy->getPointerTo(Src.getAddressSpace()));
Chandler Carrutha6399a52012-10-10 11:29:08 +00004091 }
4092
John McCall7f416cc2015-09-08 08:05:57 +00004093 auto SrcLayout = CGM.getDataLayout().getStructLayout(STy);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004094 assert(NumIRArgs == STy->getNumElements());
Chris Lattnerceddafb2010-07-05 20:41:41 +00004095 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
John McCall7f416cc2015-09-08 08:05:57 +00004096 auto Offset = CharUnits::fromQuantity(SrcLayout->getElementOffset(i));
4097 Address EltPtr = Builder.CreateStructGEP(Src, i, Offset);
4098 llvm::Value *LI = Builder.CreateLoad(EltPtr);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004099 IRCallArgs[FirstIRArg + i] = LI;
Chris Lattner15ec3612010-06-29 00:06:42 +00004100 }
Chris Lattner3dd716c2010-06-28 23:44:11 +00004101 } else {
Chris Lattner15ec3612010-06-29 00:06:42 +00004102 // In the simple case, just pass the coerced loaded value.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004103 assert(NumIRArgs == 1);
4104 IRCallArgs[FirstIRArg] =
John McCall7f416cc2015-09-08 08:05:57 +00004105 CreateCoercedLoad(Src, ArgInfo.getCoerceToType(), *this);
Chris Lattner3dd716c2010-06-28 23:44:11 +00004106 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004107
Daniel Dunbar2f219b02009-02-03 19:12:28 +00004108 break;
4109 }
4110
John McCallf26e73d2016-03-11 04:30:43 +00004111 case ABIArgInfo::CoerceAndExpand: {
John McCallf26e73d2016-03-11 04:30:43 +00004112 auto coercionType = ArgInfo.getCoerceAndExpandType();
4113 auto layout = CGM.getDataLayout().getStructLayout(coercionType);
4114
John McCall12f23522016-04-04 18:33:08 +00004115 llvm::Value *tempSize = nullptr;
4116 Address addr = Address::invalid();
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00004117 Address AllocaAddr = Address::invalid();
Yaxun Liu5b330e82018-03-15 15:25:19 +00004118 if (I->isAggregate()) {
4119 addr = I->hasLValue() ? I->getKnownLValue().getAddress()
4120 : I->getKnownRValue().getAggregateAddress();
4121
John McCall12f23522016-04-04 18:33:08 +00004122 } else {
Yaxun Liu5b330e82018-03-15 15:25:19 +00004123 RValue RV = I->getKnownRValue();
John McCall12f23522016-04-04 18:33:08 +00004124 assert(RV.isScalar()); // complex should always just be direct
4125
4126 llvm::Type *scalarType = RV.getScalarVal()->getType();
4127 auto scalarSize = CGM.getDataLayout().getTypeAllocSize(scalarType);
4128 auto scalarAlign = CGM.getDataLayout().getPrefTypeAlignment(scalarType);
4129
John McCall12f23522016-04-04 18:33:08 +00004130 // Materialize to a temporary.
4131 addr = CreateTempAlloca(RV.getScalarVal()->getType(),
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00004132 CharUnits::fromQuantity(std::max(
4133 layout->getAlignment(), scalarAlign)),
4134 "tmp",
4135 /*ArraySize=*/nullptr, &AllocaAddr);
4136 tempSize = EmitLifetimeStart(scalarSize, AllocaAddr.getPointer());
John McCall12f23522016-04-04 18:33:08 +00004137
4138 Builder.CreateStore(RV.getScalarVal(), addr);
4139 }
4140
John McCallf26e73d2016-03-11 04:30:43 +00004141 addr = Builder.CreateElementBitCast(addr, coercionType);
4142
4143 unsigned IRArgPos = FirstIRArg;
4144 for (unsigned i = 0, e = coercionType->getNumElements(); i != e; ++i) {
4145 llvm::Type *eltType = coercionType->getElementType(i);
4146 if (ABIArgInfo::isPaddingForCoerceAndExpand(eltType)) continue;
4147 Address eltAddr = Builder.CreateStructGEP(addr, i, layout);
4148 llvm::Value *elt = Builder.CreateLoad(eltAddr);
4149 IRCallArgs[IRArgPos++] = elt;
4150 }
4151 assert(IRArgPos == FirstIRArg + NumIRArgs);
4152
John McCall12f23522016-04-04 18:33:08 +00004153 if (tempSize) {
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00004154 EmitLifetimeEnd(tempSize, AllocaAddr.getPointer());
John McCall12f23522016-04-04 18:33:08 +00004155 }
4156
John McCallf26e73d2016-03-11 04:30:43 +00004157 break;
4158 }
4159
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00004160 case ABIArgInfo::Expand:
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004161 unsigned IRArgPos = FirstIRArg;
Yaxun Liu5b330e82018-03-15 15:25:19 +00004162 ExpandTypeToArgs(I->Ty, *I, IRFuncTy, IRCallArgs, IRArgPos);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004163 assert(IRArgPos == FirstIRArg + NumIRArgs);
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00004164 break;
Daniel Dunbar613855c2008-09-09 23:27:19 +00004165 }
4166 }
Mike Stump11289f42009-09-09 15:08:12 +00004167
John McCall9831b842018-02-06 18:52:44 +00004168 const CGCallee &ConcreteCallee = Callee.prepareConcreteCallee(*this);
4169 llvm::Value *CalleePtr = ConcreteCallee.getFunctionPointer();
John McCallb92ab1a2016-10-26 23:46:34 +00004170
4171 // If we're using inalloca, set up that argument.
John McCall7f416cc2015-09-08 08:05:57 +00004172 if (ArgMemory.isValid()) {
4173 llvm::Value *Arg = ArgMemory.getPointer();
Reid Klecknerafba553e2014-07-08 02:24:27 +00004174 if (CallInfo.isVariadic()) {
4175 // When passing non-POD arguments by value to variadic functions, we will
4176 // end up with a variadic prototype and an inalloca call site. In such
4177 // cases, we can't do any parameter mismatch checks. Give up and bitcast
4178 // the callee.
John McCallb92ab1a2016-10-26 23:46:34 +00004179 unsigned CalleeAS = CalleePtr->getType()->getPointerAddressSpace();
4180 auto FnTy = getTypes().GetFunctionType(CallInfo)->getPointerTo(CalleeAS);
4181 CalleePtr = Builder.CreateBitCast(CalleePtr, FnTy);
Reid Klecknerafba553e2014-07-08 02:24:27 +00004182 } else {
4183 llvm::Type *LastParamTy =
4184 IRFuncTy->getParamType(IRFuncTy->getNumParams() - 1);
4185 if (Arg->getType() != LastParamTy) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00004186#ifndef NDEBUG
Reid Klecknerafba553e2014-07-08 02:24:27 +00004187 // Assert that these structs have equivalent element types.
4188 llvm::StructType *FullTy = CallInfo.getArgStruct();
4189 llvm::StructType *DeclaredTy = cast<llvm::StructType>(
4190 cast<llvm::PointerType>(LastParamTy)->getElementType());
4191 assert(DeclaredTy->getNumElements() == FullTy->getNumElements());
4192 for (llvm::StructType::element_iterator DI = DeclaredTy->element_begin(),
4193 DE = DeclaredTy->element_end(),
4194 FI = FullTy->element_begin();
4195 DI != DE; ++DI, ++FI)
4196 assert(*DI == *FI);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00004197#endif
Reid Klecknerafba553e2014-07-08 02:24:27 +00004198 Arg = Builder.CreateBitCast(Arg, LastParamTy);
4199 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00004200 }
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004201 assert(IRFunctionArgs.hasInallocaArg());
4202 IRCallArgs[IRFunctionArgs.getInallocaArgNo()] = Arg;
Reid Kleckner314ef7b2014-02-01 00:04:45 +00004203 }
4204
John McCallb92ab1a2016-10-26 23:46:34 +00004205 // 2. Prepare the function pointer.
4206
4207 // If the callee is a bitcast of a non-variadic function to have a
4208 // variadic function pointer type, check to see if we can remove the
4209 // bitcast. This comes up with unprototyped functions.
4210 //
4211 // This makes the IR nicer, but more importantly it ensures that we
4212 // can inline the function at -O0 if it is marked always_inline.
4213 auto simplifyVariadicCallee = [](llvm::Value *Ptr) -> llvm::Value* {
4214 llvm::FunctionType *CalleeFT =
4215 cast<llvm::FunctionType>(Ptr->getType()->getPointerElementType());
4216 if (!CalleeFT->isVarArg())
4217 return Ptr;
4218
4219 llvm::ConstantExpr *CE = dyn_cast<llvm::ConstantExpr>(Ptr);
4220 if (!CE || CE->getOpcode() != llvm::Instruction::BitCast)
4221 return Ptr;
4222
4223 llvm::Function *OrigFn = dyn_cast<llvm::Function>(CE->getOperand(0));
4224 if (!OrigFn)
4225 return Ptr;
4226
4227 llvm::FunctionType *OrigFT = OrigFn->getFunctionType();
4228
4229 // If the original type is variadic, or if any of the component types
4230 // disagree, we cannot remove the cast.
4231 if (OrigFT->isVarArg() ||
4232 OrigFT->getNumParams() != CalleeFT->getNumParams() ||
4233 OrigFT->getReturnType() != CalleeFT->getReturnType())
4234 return Ptr;
4235
4236 for (unsigned i = 0, e = OrigFT->getNumParams(); i != e; ++i)
4237 if (OrigFT->getParamType(i) != CalleeFT->getParamType(i))
4238 return Ptr;
4239
4240 return OrigFn;
4241 };
4242 CalleePtr = simplifyVariadicCallee(CalleePtr);
4243
4244 // 3. Perform the actual call.
4245
4246 // Deactivate any cleanups that we're supposed to do immediately before
4247 // the call.
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00004248 if (!CallArgs.getCleanupsToDeactivate().empty())
4249 deactivateArgCleanupsBeforeCall(*this, CallArgs);
4250
John McCallb92ab1a2016-10-26 23:46:34 +00004251 // Assert that the arguments we computed match up. The IR verifier
4252 // will catch this, but this is a common enough source of problems
4253 // during IRGen changes that it's way better for debugging to catch
4254 // it ourselves here.
4255#ifndef NDEBUG
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004256 assert(IRCallArgs.size() == IRFuncTy->getNumParams() || IRFuncTy->isVarArg());
4257 for (unsigned i = 0; i < IRCallArgs.size(); ++i) {
4258 // Inalloca argument can have different type.
4259 if (IRFunctionArgs.hasInallocaArg() &&
4260 i == IRFunctionArgs.getInallocaArgNo())
4261 continue;
4262 if (i < IRFuncTy->getNumParams())
4263 assert(IRCallArgs[i]->getType() == IRFuncTy->getParamType(i));
4264 }
John McCallb92ab1a2016-10-26 23:46:34 +00004265#endif
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004266
Craig Topper3113ec32018-10-24 17:42:17 +00004267 // Update the largest vector width if any arguments have vector types.
4268 for (unsigned i = 0; i < IRCallArgs.size(); ++i) {
4269 if (auto *VT = dyn_cast<llvm::VectorType>(IRCallArgs[i]->getType()))
4270 LargestVectorWidth = std::max(LargestVectorWidth,
4271 VT->getPrimitiveSizeInBits());
4272 }
4273
John McCallb92ab1a2016-10-26 23:46:34 +00004274 // Compute the calling convention and attributes.
Daniel Dunbar0ef34792009-09-12 00:59:20 +00004275 unsigned CallingConv;
Reid Klecknercdd26792017-04-18 23:50:03 +00004276 llvm::AttributeList Attrs;
John McCallb92ab1a2016-10-26 23:46:34 +00004277 CGM.ConstructAttributeList(CalleePtr->getName(), CallInfo,
Reid Klecknercdd26792017-04-18 23:50:03 +00004278 Callee.getAbstractInfo(), Attrs, CallingConv,
Chad Rosier7dbc9cf2016-01-06 14:35:46 +00004279 /*AttrOnCallSite=*/true);
Mike Stump11289f42009-09-09 15:08:12 +00004280
John McCallb92ab1a2016-10-26 23:46:34 +00004281 // Apply some call-site-specific attributes.
4282 // TODO: work this into building the attribute set.
4283
4284 // Apply always_inline to all calls within flatten functions.
4285 // FIXME: should this really take priority over __try, below?
4286 if (CurCodeDecl && CurCodeDecl->hasAttr<FlattenAttr>() &&
Erich Keanede6480a32018-11-13 15:48:08 +00004287 !(Callee.getAbstractInfo().getCalleeDecl().getDecl() &&
4288 Callee.getAbstractInfo()
4289 .getCalleeDecl()
4290 .getDecl()
4291 ->hasAttr<NoInlineAttr>())) {
John McCallb92ab1a2016-10-26 23:46:34 +00004292 Attrs =
Reid Klecknerde864822017-03-21 16:57:30 +00004293 Attrs.addAttribute(getLLVMContext(), llvm::AttributeList::FunctionIndex,
John McCallb92ab1a2016-10-26 23:46:34 +00004294 llvm::Attribute::AlwaysInline);
4295 }
4296
4297 // Disable inlining inside SEH __try blocks.
4298 if (isSEHTryScope()) {
4299 Attrs =
Reid Klecknerde864822017-03-21 16:57:30 +00004300 Attrs.addAttribute(getLLVMContext(), llvm::AttributeList::FunctionIndex,
John McCallb92ab1a2016-10-26 23:46:34 +00004301 llvm::Attribute::NoInline);
4302 }
4303
4304 // Decide whether to use a call or an invoke.
David Majnemer4e52d6f2015-12-12 05:39:21 +00004305 bool CannotThrow;
4306 if (currentFunctionUsesSEHTry()) {
John McCallb92ab1a2016-10-26 23:46:34 +00004307 // SEH cares about asynchronous exceptions, so everything can "throw."
David Majnemer4e52d6f2015-12-12 05:39:21 +00004308 CannotThrow = false;
4309 } else if (isCleanupPadScope() &&
4310 EHPersonality::get(*this).isMSVCXXPersonality()) {
4311 // The MSVC++ personality will implicitly terminate the program if an
John McCallb92ab1a2016-10-26 23:46:34 +00004312 // exception is thrown during a cleanup outside of a try/catch.
4313 // We don't need to model anything in IR to get this behavior.
David Majnemer4e52d6f2015-12-12 05:39:21 +00004314 CannotThrow = true;
4315 } else {
John McCallb92ab1a2016-10-26 23:46:34 +00004316 // Otherwise, nounwind call sites will never throw.
Reid Klecknerde864822017-03-21 16:57:30 +00004317 CannotThrow = Attrs.hasAttribute(llvm::AttributeList::FunctionIndex,
David Majnemer4e52d6f2015-12-12 05:39:21 +00004318 llvm::Attribute::NoUnwind);
4319 }
George Burgess IV003be7c2018-03-08 05:32:30 +00004320
4321 // If we made a temporary, be sure to clean up after ourselves. Note that we
4322 // can't depend on being inside of an ExprWithCleanups, so we need to manually
4323 // pop this cleanup later on. Being eager about this is OK, since this
4324 // temporary is 'invisible' outside of the callee.
4325 if (UnusedReturnSizePtr)
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00004326 pushFullExprCleanup<CallLifetimeEnd>(NormalEHLifetimeMarker, SRetAlloca,
George Burgess IV003be7c2018-03-08 05:32:30 +00004327 UnusedReturnSizePtr);
4328
David Majnemer4e52d6f2015-12-12 05:39:21 +00004329 llvm::BasicBlock *InvokeDest = CannotThrow ? nullptr : getInvokeDest();
John McCallbd309292010-07-06 01:34:17 +00004330
Reid Klecknerb75a3f02018-02-09 00:16:41 +00004331 SmallVector<llvm::OperandBundleDef, 1> BundleList =
4332 getBundlesForFunclet(CalleePtr);
David Majnemer0b17d442015-12-15 21:27:59 +00004333
John McCallb92ab1a2016-10-26 23:46:34 +00004334 // Emit the actual call/invoke instruction.
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004335 llvm::CallSite CS;
John McCallbd309292010-07-06 01:34:17 +00004336 if (!InvokeDest) {
John McCallb92ab1a2016-10-26 23:46:34 +00004337 CS = Builder.CreateCall(CalleePtr, IRCallArgs, BundleList);
Daniel Dunbar12347492009-02-23 17:26:39 +00004338 } else {
4339 llvm::BasicBlock *Cont = createBasicBlock("invoke.cont");
John McCallb92ab1a2016-10-26 23:46:34 +00004340 CS = Builder.CreateInvoke(CalleePtr, Cont, InvokeDest, IRCallArgs,
David Majnemer0b17d442015-12-15 21:27:59 +00004341 BundleList);
Daniel Dunbar12347492009-02-23 17:26:39 +00004342 EmitBlock(Cont);
Daniel Dunbar5006f4a2009-02-20 18:54:31 +00004343 }
John McCallb92ab1a2016-10-26 23:46:34 +00004344 llvm::Instruction *CI = CS.getInstruction();
Chris Lattnere70a0072010-06-29 16:40:28 +00004345 if (callOrInvoke)
John McCallb92ab1a2016-10-26 23:46:34 +00004346 *callOrInvoke = CI;
Daniel Dunbar5006f4a2009-02-20 18:54:31 +00004347
John McCallb92ab1a2016-10-26 23:46:34 +00004348 // Apply the attributes and calling convention.
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004349 CS.setAttributes(Attrs);
Daniel Dunbar0ef34792009-09-12 00:59:20 +00004350 CS.setCallingConv(static_cast<llvm::CallingConv::ID>(CallingConv));
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004351
John McCallb92ab1a2016-10-26 23:46:34 +00004352 // Apply various metadata.
4353
4354 if (!CI->getType()->isVoidTy())
4355 CI->setName("call");
4356
Craig Topper3113ec32018-10-24 17:42:17 +00004357 // Update largest vector width from the return type.
4358 if (auto *VT = dyn_cast<llvm::VectorType>(CI->getType()))
4359 LargestVectorWidth = std::max(LargestVectorWidth,
4360 VT->getPrimitiveSizeInBits());
4361
Adam Nemet1e217bc2016-03-28 22:18:53 +00004362 // Insert instrumentation or attach profile metadata at indirect call sites.
4363 // For more details, see the comment before the definition of
4364 // IPVK_IndirectCallTarget in InstrProfData.inc.
Betul Buyukkurt518276a2016-01-23 22:50:44 +00004365 if (!CS.getCalledFunction())
4366 PGO.valueProfile(Builder, llvm::IPVK_IndirectCallTarget,
John McCallb92ab1a2016-10-26 23:46:34 +00004367 CI, CalleePtr);
Betul Buyukkurt518276a2016-01-23 22:50:44 +00004368
Dan Gohman515a60d2012-02-16 00:57:37 +00004369 // In ObjC ARC mode with no ObjC ARC exception safety, tell the ARC
4370 // optimizer it can aggressively ignore unwind edges.
David Blaikiebbafb8a2012-03-11 07:00:24 +00004371 if (CGM.getLangOpts().ObjCAutoRefCount)
John McCallb92ab1a2016-10-26 23:46:34 +00004372 AddObjCARCExceptionMetadata(CI);
4373
4374 // Suppress tail calls if requested.
4375 if (llvm::CallInst *Call = dyn_cast<llvm::CallInst>(CI)) {
Erich Keanede6480a32018-11-13 15:48:08 +00004376 const Decl *TargetDecl = Callee.getAbstractInfo().getCalleeDecl().getDecl();
John McCallb92ab1a2016-10-26 23:46:34 +00004377 if (TargetDecl && TargetDecl->hasAttr<NotTailCalledAttr>())
4378 Call->setTailCallKind(llvm::CallInst::TCK_NoTail);
4379 }
4380
4381 // 4. Finish the call.
Dan Gohman515a60d2012-02-16 00:57:37 +00004382
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004383 // If the call doesn't return, finish the basic block and clear the
John McCallb92ab1a2016-10-26 23:46:34 +00004384 // insertion point; this allows the rest of IRGen to discard
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004385 // unreachable code.
4386 if (CS.doesNotReturn()) {
George Burgess IV003be7c2018-03-08 05:32:30 +00004387 if (UnusedReturnSizePtr)
4388 PopCleanupBlock();
Leny Kholodov6aab1112015-06-08 10:23:49 +00004389
Vedant Kumar09b5bfd2017-12-21 00:10:25 +00004390 // Strip away the noreturn attribute to better diagnose unreachable UB.
4391 if (SanOpts.has(SanitizerKind::Unreachable)) {
4392 if (auto *F = CS.getCalledFunction())
4393 F->removeFnAttr(llvm::Attribute::NoReturn);
4394 CS.removeAttribute(llvm::AttributeList::FunctionIndex,
4395 llvm::Attribute::NoReturn);
4396 }
4397
4398 EmitUnreachable(Loc);
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004399 Builder.ClearInsertionPoint();
Mike Stump11289f42009-09-09 15:08:12 +00004400
Mike Stump18bb9282009-05-16 07:57:57 +00004401 // FIXME: For now, emit a dummy basic block because expr emitters in
4402 // generally are not ready to handle emitting expressions at unreachable
4403 // points.
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004404 EnsureInsertPoint();
Mike Stump11289f42009-09-09 15:08:12 +00004405
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004406 // Return a reasonable RValue.
4407 return GetUndefRValue(RetTy);
Mike Stump11289f42009-09-09 15:08:12 +00004408 }
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004409
John McCall12f23522016-04-04 18:33:08 +00004410 // Perform the swifterror writeback.
4411 if (swiftErrorTemp.isValid()) {
4412 llvm::Value *errorResult = Builder.CreateLoad(swiftErrorTemp);
4413 Builder.CreateStore(errorResult, swiftErrorArg);
4414 }
4415
John McCallb92ab1a2016-10-26 23:46:34 +00004416 // Emit any call-associated writebacks immediately. Arguably this
4417 // should happen after any return-value munging.
John McCall31168b02011-06-15 23:02:42 +00004418 if (CallArgs.hasWritebacks())
4419 emitWritebacks(*this, CallArgs);
4420
Nico Weber8cdb3f92015-08-25 18:43:32 +00004421 // The stack cleanup for inalloca arguments has to run out of the normal
4422 // lexical order, so deactivate it and run it manually here.
4423 CallArgs.freeArgumentMemory(*this);
4424
John McCallb92ab1a2016-10-26 23:46:34 +00004425 // Extract the return value.
Hal Finkelee90a222014-09-26 05:04:30 +00004426 RValue Ret = [&] {
4427 switch (RetAI.getKind()) {
John McCallf26e73d2016-03-11 04:30:43 +00004428 case ABIArgInfo::CoerceAndExpand: {
4429 auto coercionType = RetAI.getCoerceAndExpandType();
4430 auto layout = CGM.getDataLayout().getStructLayout(coercionType);
4431
4432 Address addr = SRetPtr;
4433 addr = Builder.CreateElementBitCast(addr, coercionType);
4434
John McCall12f23522016-04-04 18:33:08 +00004435 assert(CI->getType() == RetAI.getUnpaddedCoerceAndExpandType());
4436 bool requiresExtract = isa<llvm::StructType>(CI->getType());
4437
John McCallf26e73d2016-03-11 04:30:43 +00004438 unsigned unpaddedIndex = 0;
4439 for (unsigned i = 0, e = coercionType->getNumElements(); i != e; ++i) {
4440 llvm::Type *eltType = coercionType->getElementType(i);
4441 if (ABIArgInfo::isPaddingForCoerceAndExpand(eltType)) continue;
4442 Address eltAddr = Builder.CreateStructGEP(addr, i, layout);
John McCall12f23522016-04-04 18:33:08 +00004443 llvm::Value *elt = CI;
4444 if (requiresExtract)
4445 elt = Builder.CreateExtractValue(elt, unpaddedIndex++);
4446 else
4447 assert(unpaddedIndex == 0);
John McCallf26e73d2016-03-11 04:30:43 +00004448 Builder.CreateStore(elt, eltAddr);
4449 }
John McCall12f23522016-04-04 18:33:08 +00004450 // FALLTHROUGH
Galina Kistanova0872d6c2017-06-03 06:30:46 +00004451 LLVM_FALLTHROUGH;
John McCall12f23522016-04-04 18:33:08 +00004452 }
4453
4454 case ABIArgInfo::InAlloca:
4455 case ABIArgInfo::Indirect: {
4456 RValue ret = convertTempToRValue(SRetPtr, RetTy, SourceLocation());
George Burgess IV003be7c2018-03-08 05:32:30 +00004457 if (UnusedReturnSizePtr)
4458 PopCleanupBlock();
John McCall12f23522016-04-04 18:33:08 +00004459 return ret;
John McCallf26e73d2016-03-11 04:30:43 +00004460 }
4461
Hal Finkelee90a222014-09-26 05:04:30 +00004462 case ABIArgInfo::Ignore:
4463 // If we are ignoring an argument that had a result, make sure to
4464 // construct the appropriate return value for our caller.
4465 return GetUndefRValue(RetTy);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004466
Hal Finkelee90a222014-09-26 05:04:30 +00004467 case ABIArgInfo::Extend:
4468 case ABIArgInfo::Direct: {
4469 llvm::Type *RetIRTy = ConvertType(RetTy);
4470 if (RetAI.getCoerceToType() == RetIRTy && RetAI.getDirectOffset() == 0) {
4471 switch (getEvaluationKind(RetTy)) {
4472 case TEK_Complex: {
4473 llvm::Value *Real = Builder.CreateExtractValue(CI, 0);
4474 llvm::Value *Imag = Builder.CreateExtractValue(CI, 1);
4475 return RValue::getComplex(std::make_pair(Real, Imag));
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00004476 }
Hal Finkelee90a222014-09-26 05:04:30 +00004477 case TEK_Aggregate: {
John McCall7f416cc2015-09-08 08:05:57 +00004478 Address DestPtr = ReturnValue.getValue();
Hal Finkelee90a222014-09-26 05:04:30 +00004479 bool DestIsVolatile = ReturnValue.isVolatile();
4480
John McCall7f416cc2015-09-08 08:05:57 +00004481 if (!DestPtr.isValid()) {
Hal Finkelee90a222014-09-26 05:04:30 +00004482 DestPtr = CreateMemTemp(RetTy, "agg.tmp");
4483 DestIsVolatile = false;
4484 }
John McCall7f416cc2015-09-08 08:05:57 +00004485 BuildAggStore(*this, CI, DestPtr, DestIsVolatile);
Hal Finkelee90a222014-09-26 05:04:30 +00004486 return RValue::getAggregate(DestPtr);
4487 }
4488 case TEK_Scalar: {
4489 // If the argument doesn't match, perform a bitcast to coerce it. This
4490 // can happen due to trivial type mismatches.
4491 llvm::Value *V = CI;
4492 if (V->getType() != RetIRTy)
4493 V = Builder.CreateBitCast(V, RetIRTy);
4494 return RValue::get(V);
4495 }
4496 }
4497 llvm_unreachable("bad evaluation kind");
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00004498 }
Hal Finkelee90a222014-09-26 05:04:30 +00004499
John McCall7f416cc2015-09-08 08:05:57 +00004500 Address DestPtr = ReturnValue.getValue();
Hal Finkelee90a222014-09-26 05:04:30 +00004501 bool DestIsVolatile = ReturnValue.isVolatile();
4502
John McCall7f416cc2015-09-08 08:05:57 +00004503 if (!DestPtr.isValid()) {
Hal Finkelee90a222014-09-26 05:04:30 +00004504 DestPtr = CreateMemTemp(RetTy, "coerce");
4505 DestIsVolatile = false;
John McCall47fb9502013-03-07 21:37:08 +00004506 }
Hal Finkelee90a222014-09-26 05:04:30 +00004507
4508 // If the value is offset in memory, apply the offset now.
John McCall7f416cc2015-09-08 08:05:57 +00004509 Address StorePtr = emitAddressAtOffset(*this, DestPtr, RetAI);
4510 CreateCoercedStore(CI, StorePtr, DestIsVolatile, *this);
Hal Finkelee90a222014-09-26 05:04:30 +00004511
4512 return convertTempToRValue(DestPtr, RetTy, SourceLocation());
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00004513 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004514
Hal Finkelee90a222014-09-26 05:04:30 +00004515 case ABIArgInfo::Expand:
4516 llvm_unreachable("Invalid ABI kind for return argument");
Anders Carlsson17490832009-12-24 20:40:36 +00004517 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004518
Hal Finkelee90a222014-09-26 05:04:30 +00004519 llvm_unreachable("Unhandled ABIArgInfo::Kind");
4520 } ();
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004521
John McCallb92ab1a2016-10-26 23:46:34 +00004522 // Emit the assume_aligned check on the return value.
Erich Keanede6480a32018-11-13 15:48:08 +00004523 const Decl *TargetDecl = Callee.getAbstractInfo().getCalleeDecl().getDecl();
Hal Finkelee90a222014-09-26 05:04:30 +00004524 if (Ret.isScalar() && TargetDecl) {
4525 if (const auto *AA = TargetDecl->getAttr<AssumeAlignedAttr>()) {
4526 llvm::Value *OffsetValue = nullptr;
4527 if (const auto *Offset = AA->getOffset())
4528 OffsetValue = EmitScalarExpr(Offset);
4529
4530 llvm::Value *Alignment = EmitScalarExpr(AA->getAlignment());
4531 llvm::ConstantInt *AlignmentCI = cast<llvm::ConstantInt>(Alignment);
4532 EmitAlignmentAssumption(Ret.getScalarVal(), AlignmentCI->getZExtValue(),
4533 OffsetValue);
Erich Keane623efd82017-03-30 21:48:55 +00004534 } else if (const auto *AA = TargetDecl->getAttr<AllocAlignAttr>()) {
4535 llvm::Value *ParamVal =
Yaxun Liu5b330e82018-03-15 15:25:19 +00004536 CallArgs[AA->getParamIndex().getLLVMIndex()].getRValue(
4537 *this).getScalarVal();
Erich Keane623efd82017-03-30 21:48:55 +00004538 EmitAlignmentAssumption(Ret.getScalarVal(), ParamVal);
Hal Finkelee90a222014-09-26 05:04:30 +00004539 }
Daniel Dunbar573884e2008-09-10 07:04:09 +00004540 }
Daniel Dunbard3674e62008-09-11 01:48:57 +00004541
Hal Finkelee90a222014-09-26 05:04:30 +00004542 return Ret;
Daniel Dunbar613855c2008-09-09 23:27:19 +00004543}
Daniel Dunbar2d0746f2009-02-10 20:44:09 +00004544
John McCall9831b842018-02-06 18:52:44 +00004545CGCallee CGCallee::prepareConcreteCallee(CodeGenFunction &CGF) const {
4546 if (isVirtual()) {
4547 const CallExpr *CE = getVirtualCallExpr();
4548 return CGF.CGM.getCXXABI().getVirtualFunctionPointer(
Stephen Kellyf2ceec42018-08-09 21:08:08 +00004549 CGF, getVirtualMethodDecl(), getThisAddress(), getFunctionType(),
4550 CE ? CE->getBeginLoc() : SourceLocation());
John McCall9831b842018-02-06 18:52:44 +00004551 }
4552
4553 return *this;
4554}
4555
Daniel Dunbar2d0746f2009-02-10 20:44:09 +00004556/* VarArg handling */
4557
Charles Davisc7d5c942015-09-17 20:55:33 +00004558Address CodeGenFunction::EmitVAArg(VAArgExpr *VE, Address &VAListAddr) {
4559 VAListAddr = VE->isMicrosoftABI()
4560 ? EmitMSVAListRef(VE->getSubExpr())
4561 : EmitVAListRef(VE->getSubExpr());
4562 QualType Ty = VE->getType();
4563 if (VE->isMicrosoftABI())
4564 return CGM.getTypes().getABIInfo().EmitMSVAArg(*this, VAListAddr, Ty);
John McCall7f416cc2015-09-08 08:05:57 +00004565 return CGM.getTypes().getABIInfo().EmitVAArg(*this, VAListAddr, Ty);
Daniel Dunbar2d0746f2009-02-10 20:44:09 +00004566}