blob: 455a25434ffb3bc1584f099257c6949239e667eb [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)
Anastasia Stulovad1986d12019-01-14 11:44:22 +000077 RecTy = Context.getAddrSpaceQualType(RecTy, MD->getTypeQualifiers().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 }
Peter Collingbourne87f477b2019-01-04 19:27:04 +00001819
1820 for (StringRef Attr : CodeGenOpts.DefaultFunctionAttrs) {
1821 StringRef Var, Value;
1822 std::tie(Var, Value) = Attr.split('=');
1823 FuncAttrs.addAttribute(Var, Value);
1824 }
Justin Lebarb080b632017-01-25 21:29:48 +00001825}
1826
1827void CodeGenModule::AddDefaultFnAttrs(llvm::Function &F) {
1828 llvm::AttrBuilder FuncAttrs;
1829 ConstructDefaultFnAttrList(F.getName(),
1830 F.hasFnAttribute(llvm::Attribute::OptimizeNone),
1831 /* AttrOnCallsite = */ false, FuncAttrs);
Reid Kleckneree4930b2017-05-02 22:07:37 +00001832 F.addAttributes(llvm::AttributeList::FunctionIndex, FuncAttrs);
Justin Lebarb080b632017-01-25 21:29:48 +00001833}
1834
Chad Rosier7dbc9cf2016-01-06 14:35:46 +00001835void CodeGenModule::ConstructAttributeList(
1836 StringRef Name, const CGFunctionInfo &FI, CGCalleeInfo CalleeInfo,
Reid Klecknercdd26792017-04-18 23:50:03 +00001837 llvm::AttributeList &AttrList, unsigned &CallingConv, bool AttrOnCallSite) {
Bill Wendlinga514ebc2012-10-15 20:36:26 +00001838 llvm::AttrBuilder FuncAttrs;
1839 llvm::AttrBuilder RetAttrs;
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00001840
Daniel Dunbar0ef34792009-09-12 00:59:20 +00001841 CallingConv = FI.getEffectiveCallingConvention();
John McCallab26cfa2010-02-05 21:31:56 +00001842 if (FI.isNoReturn())
Bill Wendling207f0532012-12-20 19:27:06 +00001843 FuncAttrs.addAttribute(llvm::Attribute::NoReturn);
John McCallab26cfa2010-02-05 21:31:56 +00001844
Samuel Antao798f11c2015-11-23 22:04:44 +00001845 // If we have information about the function prototype, we can learn
Craig Topper13d759f2018-04-30 22:02:48 +00001846 // attributes from there.
Samuel Antao798f11c2015-11-23 22:04:44 +00001847 AddAttributesFromFunctionProtoType(getContext(), FuncAttrs,
1848 CalleeInfo.getCalleeFunctionProtoType());
1849
Erich Keanede6480a32018-11-13 15:48:08 +00001850 const Decl *TargetDecl = CalleeInfo.getCalleeDecl().getDecl();
Samuel Antao798f11c2015-11-23 22:04:44 +00001851
Justin Lebarb080b632017-01-25 21:29:48 +00001852 bool HasOptnone = false;
Anton Korobeynikovc8478242009-04-04 00:49:24 +00001853 // FIXME: handle sseregparm someday...
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00001854 if (TargetDecl) {
Rafael Espindola2d21ab02011-10-12 19:51:18 +00001855 if (TargetDecl->hasAttr<ReturnsTwiceAttr>())
Bill Wendling207f0532012-12-20 19:27:06 +00001856 FuncAttrs.addAttribute(llvm::Attribute::ReturnsTwice);
Argyrios Kyrtzidisb4b64ca2009-06-30 02:34:44 +00001857 if (TargetDecl->hasAttr<NoThrowAttr>())
Bill Wendling207f0532012-12-20 19:27:06 +00001858 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
Richard Smithdebc59d2013-01-30 05:45:05 +00001859 if (TargetDecl->hasAttr<NoReturnAttr>())
1860 FuncAttrs.addAttribute(llvm::Attribute::NoReturn);
Xinliang David Li4ec36062017-06-13 21:14:07 +00001861 if (TargetDecl->hasAttr<ColdAttr>())
1862 FuncAttrs.addAttribute(llvm::Attribute::Cold);
Aaron Ballman7c19ab12014-02-22 16:59:24 +00001863 if (TargetDecl->hasAttr<NoDuplicateAttr>())
1864 FuncAttrs.addAttribute(llvm::Attribute::NoDuplicate);
Yaxun Liu7d07ae72016-11-01 18:45:32 +00001865 if (TargetDecl->hasAttr<ConvergentAttr>())
1866 FuncAttrs.addAttribute(llvm::Attribute::Convergent);
Zola Bridgescbac3ad2018-11-27 19:56:46 +00001867 if (TargetDecl->hasAttr<SpeculativeLoadHardeningAttr>())
1868 FuncAttrs.addAttribute(llvm::Attribute::SpeculativeLoadHardening);
Richard Smithdebc59d2013-01-30 05:45:05 +00001869
Chandler Carruth45bbe012017-03-24 09:11:57 +00001870 if (const FunctionDecl *Fn = dyn_cast<FunctionDecl>(TargetDecl)) {
Samuel Antao798f11c2015-11-23 22:04:44 +00001871 AddAttributesFromFunctionProtoType(
Chandler Carruth45bbe012017-03-24 09:11:57 +00001872 getContext(), FuncAttrs, Fn->getType()->getAs<FunctionProtoType>());
Richard Smith49af6292013-03-05 08:30:04 +00001873 // Don't use [[noreturn]] or _Noreturn for a call to a virtual function.
1874 // These attributes are not inherited by overloads.
Chandler Carruth45bbe012017-03-24 09:11:57 +00001875 const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(Fn);
1876 if (Fn->isNoReturn() && !(AttrOnCallSite && MD && MD->isVirtual()))
Richard Smithdebc59d2013-01-30 05:45:05 +00001877 FuncAttrs.addAttribute(llvm::Attribute::NoReturn);
John McCallbe349de2010-07-08 06:48:12 +00001878 }
1879
David Majnemer1bf0f8e2015-07-20 22:51:52 +00001880 // 'const', 'pure' and 'noalias' attributed functions are also nounwind.
Eric Christopherbf005ec2011-08-15 22:38:22 +00001881 if (TargetDecl->hasAttr<ConstAttr>()) {
Bill Wendling207f0532012-12-20 19:27:06 +00001882 FuncAttrs.addAttribute(llvm::Attribute::ReadNone);
1883 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
Eric Christopherbf005ec2011-08-15 22:38:22 +00001884 } else if (TargetDecl->hasAttr<PureAttr>()) {
Bill Wendling207f0532012-12-20 19:27:06 +00001885 FuncAttrs.addAttribute(llvm::Attribute::ReadOnly);
1886 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
David Majnemer1bf0f8e2015-07-20 22:51:52 +00001887 } else if (TargetDecl->hasAttr<NoAliasAttr>()) {
1888 FuncAttrs.addAttribute(llvm::Attribute::ArgMemOnly);
1889 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
Eric Christopherbf005ec2011-08-15 22:38:22 +00001890 }
David Majnemer631a90b2015-02-04 07:23:21 +00001891 if (TargetDecl->hasAttr<RestrictAttr>())
Bill Wendling207f0532012-12-20 19:27:06 +00001892 RetAttrs.addAttribute(llvm::Attribute::NoAlias);
Manoj Guptada08f6a2018-07-19 00:44:52 +00001893 if (TargetDecl->hasAttr<ReturnsNonNullAttr>() &&
1894 !CodeGenOpts.NullPointerIsValid)
Hal Finkeld8442b12014-07-12 04:51:04 +00001895 RetAttrs.addAttribute(llvm::Attribute::NonNull);
Oren Ben Simhon318a6ea2017-04-27 12:01:00 +00001896 if (TargetDecl->hasAttr<AnyX86NoCallerSavedRegistersAttr>())
1897 FuncAttrs.addAttribute("no_caller_saved_registers");
Oren Ben Simhon220671a2018-03-17 13:31:35 +00001898 if (TargetDecl->hasAttr<AnyX86NoCfCheckAttr>())
1899 FuncAttrs.addAttribute(llvm::Attribute::NoCfCheck);
Paul Robinson08556952014-12-11 20:14:04 +00001900
1901 HasOptnone = TargetDecl->hasAttr<OptimizeNoneAttr>();
George Burgess IVe3763372016-12-22 02:50:20 +00001902 if (auto *AllocSize = TargetDecl->getAttr<AllocSizeAttr>()) {
1903 Optional<unsigned> NumElemsParam;
Joel E. Denny81508102018-03-13 14:51:22 +00001904 if (AllocSize->getNumElemsParam().isValid())
1905 NumElemsParam = AllocSize->getNumElemsParam().getLLVMIndex();
1906 FuncAttrs.addAllocSizeAttr(AllocSize->getElemSizeParam().getLLVMIndex(),
George Burgess IVe3763372016-12-22 02:50:20 +00001907 NumElemsParam);
1908 }
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00001909 }
1910
Justin Lebarb080b632017-01-25 21:29:48 +00001911 ConstructDefaultFnAttrList(Name, HasOptnone, AttrOnCallSite, FuncAttrs);
Paul Robinson08556952014-12-11 20:14:04 +00001912
Peter Collingbourneb4728c12014-05-19 22:14:34 +00001913 if (CodeGenOpts.EnableSegmentedStacks &&
1914 !(TargetDecl && TargetDecl->hasAttr<NoSplitStackAttr>()))
Reid Klecknerfb873af2014-04-10 22:59:13 +00001915 FuncAttrs.addAttribute("split-stack");
Devang Patel6e467b12009-06-04 23:32:02 +00001916
Sriraman Tallam5c651482017-11-07 19:37:51 +00001917 // Add NonLazyBind attribute to function declarations when -fno-plt
1918 // is used.
1919 if (TargetDecl && CodeGenOpts.NoPLT) {
1920 if (auto *Fn = dyn_cast<FunctionDecl>(TargetDecl)) {
1921 if (!Fn->isDefined() && !AttrOnCallSite) {
1922 FuncAttrs.addAttribute(llvm::Attribute::NonLazyBind);
1923 }
1924 }
1925 }
1926
Alexey Sotkin20f65922018-02-22 11:54:14 +00001927 if (TargetDecl && TargetDecl->hasAttr<OpenCLKernelAttr>()) {
1928 if (getLangOpts().OpenCLVersion <= 120) {
1929 // OpenCL v1.2 Work groups are always uniform
1930 FuncAttrs.addAttribute("uniform-work-group-size", "true");
1931 } else {
1932 // OpenCL v2.0 Work groups may be whether uniform or not.
1933 // '-cl-uniform-work-group-size' compile option gets a hint
1934 // to the compiler that the global work-size be a multiple of
1935 // the work-group size specified to clEnqueueNDRangeKernel
1936 // (i.e. work groups are uniform).
1937 FuncAttrs.addAttribute("uniform-work-group-size",
1938 llvm::toStringRef(CodeGenOpts.UniformWGSize));
1939 }
1940 }
1941
Justin Lebarb080b632017-01-25 21:29:48 +00001942 if (!AttrOnCallSite) {
Akira Hatanaka627586b2018-03-02 01:53:15 +00001943 bool DisableTailCalls = false;
1944
1945 if (CodeGenOpts.DisableTailCalls)
1946 DisableTailCalls = true;
1947 else if (TargetDecl) {
1948 if (TargetDecl->hasAttr<DisableTailCallsAttr>() ||
1949 TargetDecl->hasAttr<AnyX86InterruptAttr>())
1950 DisableTailCalls = true;
1951 else if (CodeGenOpts.NoEscapingBlockTailCalls) {
1952 if (const auto *BD = dyn_cast<BlockDecl>(TargetDecl))
1953 if (!BD->doesNotEscape())
1954 DisableTailCalls = true;
1955 }
1956 }
1957
Justin Lebarb080b632017-01-25 21:29:48 +00001958 FuncAttrs.addAttribute("disable-tail-calls",
1959 llvm::toStringRef(DisableTailCalls));
Erich Keanede6480a32018-11-13 15:48:08 +00001960 GetCPUAndFeaturesAttributes(CalleeInfo.getCalleeDecl(), FuncAttrs);
Bill Wendling985d1c52013-02-15 21:30:01 +00001961 }
1962
Alexey Samsonov153004f2014-09-29 22:08:00 +00001963 ClangToLLVMArgMapping IRFunctionArgs(getContext(), FI);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00001964
Daniel Dunbar3668cb22009-02-02 23:43:58 +00001965 QualType RetTy = FI.getReturnType();
Daniel Dunbarb52d0772009-02-03 05:59:18 +00001966 const ABIArgInfo &RetAI = FI.getReturnInfo();
Daniel Dunbar7a95ca32008-09-10 04:01:49 +00001967 switch (RetAI.getKind()) {
Anton Korobeynikov18adbf52009-06-06 09:36:29 +00001968 case ABIArgInfo::Extend:
Alex Bradburye41a5e22018-01-12 20:08:16 +00001969 if (RetAI.isSignExt())
Jakob Stoklund Olesend7bf2932013-05-29 03:57:23 +00001970 RetAttrs.addAttribute(llvm::Attribute::SExt);
Alex Bradburye41a5e22018-01-12 20:08:16 +00001971 else
Jakob Stoklund Olesend7bf2932013-05-29 03:57:23 +00001972 RetAttrs.addAttribute(llvm::Attribute::ZExt);
Adrian Prantlf3b3ccd2017-12-19 22:06:11 +00001973 LLVM_FALLTHROUGH;
Daniel Dunbar67dace892009-02-03 06:17:37 +00001974 case ABIArgInfo::Direct:
Jakob Stoklund Olesena3661142013-06-05 03:00:09 +00001975 if (RetAI.getInReg())
1976 RetAttrs.addAttribute(llvm::Attribute::InReg);
1977 break;
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00001978 case ABIArgInfo::Ignore:
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00001979 break;
1980
Alexey Samsonov91cf4552014-08-22 01:06:06 +00001981 case ABIArgInfo::InAlloca:
Rafael Espindola06b2b4a2012-07-31 02:44:24 +00001982 case ABIArgInfo::Indirect: {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00001983 // inalloca and sret disable readnone and readonly
Bill Wendling207f0532012-12-20 19:27:06 +00001984 FuncAttrs.removeAttribute(llvm::Attribute::ReadOnly)
1985 .removeAttribute(llvm::Attribute::ReadNone);
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00001986 break;
Rafael Espindola06b2b4a2012-07-31 02:44:24 +00001987 }
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00001988
John McCallf26e73d2016-03-11 04:30:43 +00001989 case ABIArgInfo::CoerceAndExpand:
1990 break;
1991
Daniel Dunbard3674e62008-09-11 01:48:57 +00001992 case ABIArgInfo::Expand:
David Blaikie83d382b2011-09-23 05:06:16 +00001993 llvm_unreachable("Invalid ABI kind for return argument");
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00001994 }
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00001995
Hal Finkela2347ba2014-07-18 15:52:10 +00001996 if (const auto *RefTy = RetTy->getAs<ReferenceType>()) {
1997 QualType PTy = RefTy->getPointeeType();
David Majnemer9df56372015-09-10 21:52:00 +00001998 if (!PTy->isIncompleteType() && PTy->isConstantSizeType())
Hal Finkela2347ba2014-07-18 15:52:10 +00001999 RetAttrs.addDereferenceableAttr(getContext().getTypeSizeInChars(PTy)
2000 .getQuantity());
Manoj Guptada08f6a2018-07-19 00:44:52 +00002001 else if (getContext().getTargetAddressSpace(PTy) == 0 &&
2002 !CodeGenOpts.NullPointerIsValid)
Hal Finkela2347ba2014-07-18 15:52:10 +00002003 RetAttrs.addAttribute(llvm::Attribute::NonNull);
2004 }
Nick Lewycky9b46eb82014-05-28 09:56:42 +00002005
John McCall12f23522016-04-04 18:33:08 +00002006 bool hasUsedSRet = false;
Reid Klecknercdd26792017-04-18 23:50:03 +00002007 SmallVector<llvm::AttributeSet, 4> ArgAttrs(IRFunctionArgs.totalIRArgs());
John McCall12f23522016-04-04 18:33:08 +00002008
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002009 // Attach attributes to sret.
2010 if (IRFunctionArgs.hasSRetArg()) {
2011 llvm::AttrBuilder SRETAttrs;
Mandeep Singh Grang2a153102018-07-26 18:07:59 +00002012 if (!RetAI.getSuppressSRet())
2013 SRETAttrs.addAttribute(llvm::Attribute::StructRet);
John McCall12f23522016-04-04 18:33:08 +00002014 hasUsedSRet = true;
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002015 if (RetAI.getInReg())
2016 SRETAttrs.addAttribute(llvm::Attribute::InReg);
Reid Klecknercdd26792017-04-18 23:50:03 +00002017 ArgAttrs[IRFunctionArgs.getSRetArgNo()] =
2018 llvm::AttributeSet::get(getLLVMContext(), SRETAttrs);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002019 }
2020
2021 // Attach attributes to inalloca argument.
2022 if (IRFunctionArgs.hasInallocaArg()) {
2023 llvm::AttrBuilder Attrs;
2024 Attrs.addAttribute(llvm::Attribute::InAlloca);
Reid Klecknercdd26792017-04-18 23:50:03 +00002025 ArgAttrs[IRFunctionArgs.getInallocaArgNo()] =
2026 llvm::AttributeSet::get(getLLVMContext(), Attrs);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002027 }
2028
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002029 unsigned ArgNo = 0;
2030 for (CGFunctionInfo::const_arg_iterator I = FI.arg_begin(),
2031 E = FI.arg_end();
2032 I != E; ++I, ++ArgNo) {
2033 QualType ParamType = I->type;
2034 const ABIArgInfo &AI = I->info;
Bill Wendlinga514ebc2012-10-15 20:36:26 +00002035 llvm::AttrBuilder Attrs;
Anton Korobeynikovc8478242009-04-04 00:49:24 +00002036
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002037 // Add attribute for padding argument, if necessary.
2038 if (IRFunctionArgs.hasPaddingArg(ArgNo)) {
Reid Klecknercdd26792017-04-18 23:50:03 +00002039 if (AI.getPaddingInReg()) {
2040 ArgAttrs[IRFunctionArgs.getPaddingArgNo(ArgNo)] =
2041 llvm::AttributeSet::get(
2042 getLLVMContext(),
2043 llvm::AttrBuilder().addAttribute(llvm::Attribute::InReg));
2044 }
Rafael Espindolafad28de2012-10-24 01:59:00 +00002045 }
2046
John McCall39ec71f2010-03-27 00:47:27 +00002047 // 'restrict' -> 'noalias' is done in EmitFunctionProlog when we
2048 // have the corresponding parameter variable. It doesn't make
Daniel Dunbarcb2b3d02011-02-10 18:10:07 +00002049 // sense to do it here because parameters are so messed up.
Daniel Dunbard3674e62008-09-11 01:48:57 +00002050 switch (AI.getKind()) {
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002051 case ABIArgInfo::Extend:
Alex Bradburye41a5e22018-01-12 20:08:16 +00002052 if (AI.isSignExt())
Bill Wendling207f0532012-12-20 19:27:06 +00002053 Attrs.addAttribute(llvm::Attribute::SExt);
Alex Bradburye41a5e22018-01-12 20:08:16 +00002054 else
2055 Attrs.addAttribute(llvm::Attribute::ZExt);
Adrian Prantlf3b3ccd2017-12-19 22:06:11 +00002056 LLVM_FALLTHROUGH;
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002057 case ABIArgInfo::Direct:
Peter Collingbournef7706832014-12-12 23:41:25 +00002058 if (ArgNo == 0 && FI.isChainCall())
2059 Attrs.addAttribute(llvm::Attribute::Nest);
2060 else if (AI.getInReg())
Bill Wendling207f0532012-12-20 19:27:06 +00002061 Attrs.addAttribute(llvm::Attribute::InReg);
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002062 break;
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002063
James Y Knight71608572015-08-21 18:19:06 +00002064 case ABIArgInfo::Indirect: {
Rafael Espindola703c47f2012-10-19 05:04:37 +00002065 if (AI.getInReg())
Bill Wendling207f0532012-12-20 19:27:06 +00002066 Attrs.addAttribute(llvm::Attribute::InReg);
Rafael Espindola703c47f2012-10-19 05:04:37 +00002067
Anders Carlsson20759ad2009-09-16 15:53:40 +00002068 if (AI.getIndirectByVal())
Bill Wendling207f0532012-12-20 19:27:06 +00002069 Attrs.addAttribute(llvm::Attribute::ByVal);
Anders Carlsson20759ad2009-09-16 15:53:40 +00002070
John McCall7f416cc2015-09-08 08:05:57 +00002071 CharUnits Align = AI.getIndirectAlign();
James Y Knight71608572015-08-21 18:19:06 +00002072
2073 // In a byval argument, it is important that the required
2074 // alignment of the type is honored, as LLVM might be creating a
2075 // *new* stack object, and needs to know what alignment to give
2076 // it. (Sometimes it can deduce a sensible alignment on its own,
2077 // but not if clang decides it must emit a packed struct, or the
2078 // user specifies increased alignment requirements.)
2079 //
2080 // This is different from indirect *not* byval, where the object
2081 // exists already, and the align attribute is purely
2082 // informative.
John McCall7f416cc2015-09-08 08:05:57 +00002083 assert(!Align.isZero());
James Y Knight71608572015-08-21 18:19:06 +00002084
John McCall7f416cc2015-09-08 08:05:57 +00002085 // For now, only add this when we have a byval argument.
2086 // TODO: be less lazy about updating test cases.
2087 if (AI.getIndirectByVal())
2088 Attrs.addAlignmentAttr(Align.getQuantity());
Bill Wendlinga7912f82012-10-10 07:36:56 +00002089
Daniel Dunbarc2304432009-03-18 19:51:01 +00002090 // byval disables readnone and readonly.
Bill Wendling207f0532012-12-20 19:27:06 +00002091 FuncAttrs.removeAttribute(llvm::Attribute::ReadOnly)
2092 .removeAttribute(llvm::Attribute::ReadNone);
Daniel Dunbard3674e62008-09-11 01:48:57 +00002093 break;
James Y Knight71608572015-08-21 18:19:06 +00002094 }
Daniel Dunbar94a6f252009-01-26 21:26:08 +00002095 case ABIArgInfo::Ignore:
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002096 case ABIArgInfo::Expand:
John McCallf26e73d2016-03-11 04:30:43 +00002097 case ABIArgInfo::CoerceAndExpand:
2098 break;
Daniel Dunbar94a6f252009-01-26 21:26:08 +00002099
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002100 case ABIArgInfo::InAlloca:
2101 // inalloca disables readnone and readonly.
2102 FuncAttrs.removeAttribute(llvm::Attribute::ReadOnly)
2103 .removeAttribute(llvm::Attribute::ReadNone);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002104 continue;
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00002105 }
Mike Stump11289f42009-09-09 15:08:12 +00002106
Hal Finkela2347ba2014-07-18 15:52:10 +00002107 if (const auto *RefTy = ParamType->getAs<ReferenceType>()) {
2108 QualType PTy = RefTy->getPointeeType();
David Majnemer9df56372015-09-10 21:52:00 +00002109 if (!PTy->isIncompleteType() && PTy->isConstantSizeType())
Hal Finkela2347ba2014-07-18 15:52:10 +00002110 Attrs.addDereferenceableAttr(getContext().getTypeSizeInChars(PTy)
2111 .getQuantity());
Manoj Guptada08f6a2018-07-19 00:44:52 +00002112 else if (getContext().getTargetAddressSpace(PTy) == 0 &&
2113 !CodeGenOpts.NullPointerIsValid)
Hal Finkela2347ba2014-07-18 15:52:10 +00002114 Attrs.addAttribute(llvm::Attribute::NonNull);
2115 }
Nick Lewycky9b46eb82014-05-28 09:56:42 +00002116
John McCall12f23522016-04-04 18:33:08 +00002117 switch (FI.getExtParameterInfo(ArgNo).getABI()) {
2118 case ParameterABI::Ordinary:
2119 break;
2120
2121 case ParameterABI::SwiftIndirectResult: {
2122 // Add 'sret' if we haven't already used it for something, but
2123 // only if the result is void.
2124 if (!hasUsedSRet && RetTy->isVoidType()) {
2125 Attrs.addAttribute(llvm::Attribute::StructRet);
2126 hasUsedSRet = true;
2127 }
2128
2129 // Add 'noalias' in either case.
2130 Attrs.addAttribute(llvm::Attribute::NoAlias);
2131
2132 // Add 'dereferenceable' and 'alignment'.
2133 auto PTy = ParamType->getPointeeType();
2134 if (!PTy->isIncompleteType() && PTy->isConstantSizeType()) {
2135 auto info = getContext().getTypeInfoInChars(PTy);
2136 Attrs.addDereferenceableAttr(info.first.getQuantity());
2137 Attrs.addAttribute(llvm::Attribute::getWithAlignment(getLLVMContext(),
2138 info.second.getQuantity()));
2139 }
2140 break;
2141 }
2142
2143 case ParameterABI::SwiftErrorResult:
2144 Attrs.addAttribute(llvm::Attribute::SwiftError);
2145 break;
2146
2147 case ParameterABI::SwiftContext:
2148 Attrs.addAttribute(llvm::Attribute::SwiftSelf);
2149 break;
2150 }
2151
Akira Hatanaka98a49332017-09-22 00:41:05 +00002152 if (FI.getExtParameterInfo(ArgNo).isNoEscape())
2153 Attrs.addAttribute(llvm::Attribute::NoCapture);
2154
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002155 if (Attrs.hasAttributes()) {
2156 unsigned FirstIRArg, NumIRArgs;
2157 std::tie(FirstIRArg, NumIRArgs) = IRFunctionArgs.getIRArgs(ArgNo);
2158 for (unsigned i = 0; i < NumIRArgs; i++)
Reid Klecknercdd26792017-04-18 23:50:03 +00002159 ArgAttrs[FirstIRArg + i] =
2160 llvm::AttributeSet::get(getLLVMContext(), Attrs);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002161 }
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00002162 }
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002163 assert(ArgNo == FI.arg_size());
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002164
Reid Klecknercdd26792017-04-18 23:50:03 +00002165 AttrList = llvm::AttributeList::get(
2166 getLLVMContext(), llvm::AttributeSet::get(getLLVMContext(), FuncAttrs),
2167 llvm::AttributeSet::get(getLLVMContext(), RetAttrs), ArgAttrs);
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00002168}
2169
John McCalla738c252011-03-09 04:27:21 +00002170/// An argument came in as a promoted argument; demote it back to its
2171/// declared type.
2172static llvm::Value *emitArgumentDemotion(CodeGenFunction &CGF,
2173 const VarDecl *var,
2174 llvm::Value *value) {
Chris Lattner2192fe52011-07-18 04:24:23 +00002175 llvm::Type *varType = CGF.ConvertType(var->getType());
John McCalla738c252011-03-09 04:27:21 +00002176
2177 // This can happen with promotions that actually don't change the
2178 // underlying type, like the enum promotions.
2179 if (value->getType() == varType) return value;
2180
2181 assert((varType->isIntegerTy() || varType->isFloatingPointTy())
2182 && "unexpected promotion type");
2183
2184 if (isa<llvm::IntegerType>(varType))
2185 return CGF.Builder.CreateTrunc(value, varType, "arg.unpromote");
2186
2187 return CGF.Builder.CreateFPCast(value, varType, "arg.unpromote");
2188}
2189
Chandler Carruth45bbe012017-03-24 09:11:57 +00002190/// Returns the attribute (either parameter attribute, or function
2191/// attribute), which declares argument ArgNo to be non-null.
2192static const NonNullAttr *getNonNullAttr(const Decl *FD, const ParmVarDecl *PVD,
2193 QualType ArgType, unsigned ArgNo) {
2194 // FIXME: __attribute__((nonnull)) can also be applied to:
2195 // - references to pointers, where the pointee is known to be
2196 // nonnull (apparently a Clang extension)
2197 // - transparent unions containing pointers
2198 // In the former case, LLVM IR cannot represent the constraint. In
2199 // the latter case, we have no guarantee that the transparent union
2200 // is in fact passed as a pointer.
2201 if (!ArgType->isAnyPointerType() && !ArgType->isBlockPointerType())
2202 return nullptr;
2203 // First, check attribute on parameter itself.
2204 if (PVD) {
2205 if (auto ParmNNAttr = PVD->getAttr<NonNullAttr>())
2206 return ParmNNAttr;
2207 }
2208 // Check function attributes.
2209 if (!FD)
2210 return nullptr;
2211 for (const auto *NNAttr : FD->specific_attrs<NonNullAttr>()) {
2212 if (NNAttr->isNonNull(ArgNo))
2213 return NNAttr;
2214 }
2215 return nullptr;
2216}
2217
John McCall12f23522016-04-04 18:33:08 +00002218namespace {
2219 struct CopyBackSwiftError final : EHScopeStack::Cleanup {
2220 Address Temp;
2221 Address Arg;
2222 CopyBackSwiftError(Address temp, Address arg) : Temp(temp), Arg(arg) {}
2223 void Emit(CodeGenFunction &CGF, Flags flags) override {
2224 llvm::Value *errorValue = CGF.Builder.CreateLoad(Temp);
2225 CGF.Builder.CreateStore(errorValue, Arg);
2226 }
2227 };
2228}
2229
Daniel Dunbard931a872009-02-02 22:03:45 +00002230void CodeGenFunction::EmitFunctionProlog(const CGFunctionInfo &FI,
2231 llvm::Function *Fn,
Daniel Dunbar613855c2008-09-09 23:27:19 +00002232 const FunctionArgList &Args) {
Hans Wennborgd71907d2014-09-04 22:16:33 +00002233 if (CurCodeDecl && CurCodeDecl->hasAttr<NakedAttr>())
2234 // Naked functions don't have prologues.
2235 return;
2236
John McCallcaa19452009-07-28 01:00:58 +00002237 // If this is an implicit-return-zero function, go ahead and
2238 // initialize the return value. TODO: it might be nice to have
2239 // a more general mechanism for this that didn't require synthesized
2240 // return statements.
John McCalldec348f72013-05-03 07:33:41 +00002241 if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(CurCodeDecl)) {
John McCallcaa19452009-07-28 01:00:58 +00002242 if (FD->hasImplicitReturnZero()) {
Alp Toker314cc812014-01-25 16:55:45 +00002243 QualType RetTy = FD->getReturnType().getUnqualifiedType();
Chris Lattner2192fe52011-07-18 04:24:23 +00002244 llvm::Type* LLVMTy = CGM.getTypes().ConvertType(RetTy);
Owen Anderson0b75f232009-07-31 20:28:54 +00002245 llvm::Constant* Zero = llvm::Constant::getNullValue(LLVMTy);
John McCallcaa19452009-07-28 01:00:58 +00002246 Builder.CreateStore(Zero, ReturnValue);
2247 }
2248 }
2249
Mike Stump18bb9282009-05-16 07:57:57 +00002250 // FIXME: We no longer need the types from FunctionArgList; lift up and
2251 // simplify.
Daniel Dunbar5a0acdc92009-02-03 06:02:10 +00002252
Alexey Samsonov153004f2014-09-29 22:08:00 +00002253 ClangToLLVMArgMapping IRFunctionArgs(CGM.getContext(), FI);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002254 // Flattened function arguments.
John McCall12f23522016-04-04 18:33:08 +00002255 SmallVector<llvm::Value *, 16> FnArgs;
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002256 FnArgs.reserve(IRFunctionArgs.totalIRArgs());
2257 for (auto &Arg : Fn->args()) {
2258 FnArgs.push_back(&Arg);
2259 }
2260 assert(FnArgs.size() == IRFunctionArgs.totalIRArgs());
Mike Stump11289f42009-09-09 15:08:12 +00002261
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002262 // If we're using inalloca, all the memory arguments are GEPs off of the last
2263 // parameter, which is a pointer to the complete memory area.
John McCall7f416cc2015-09-08 08:05:57 +00002264 Address ArgStruct = Address::invalid();
2265 const llvm::StructLayout *ArgStructLayout = nullptr;
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002266 if (IRFunctionArgs.hasInallocaArg()) {
John McCall7f416cc2015-09-08 08:05:57 +00002267 ArgStructLayout = CGM.getDataLayout().getStructLayout(FI.getArgStruct());
2268 ArgStruct = Address(FnArgs[IRFunctionArgs.getInallocaArgNo()],
2269 FI.getArgStructAlignment());
2270
2271 assert(ArgStruct.getType() == FI.getArgStruct()->getPointerTo());
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002272 }
2273
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002274 // Name the struct return parameter.
2275 if (IRFunctionArgs.hasSRetArg()) {
John McCall12f23522016-04-04 18:33:08 +00002276 auto AI = cast<llvm::Argument>(FnArgs[IRFunctionArgs.getSRetArgNo()]);
Daniel Dunbar613855c2008-09-09 23:27:19 +00002277 AI->setName("agg.result");
Reid Klecknercdd26792017-04-18 23:50:03 +00002278 AI->addAttr(llvm::Attribute::NoAlias);
Daniel Dunbar613855c2008-09-09 23:27:19 +00002279 }
Mike Stump11289f42009-09-09 15:08:12 +00002280
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002281 // Track if we received the parameter as a pointer (indirect, byval, or
2282 // inalloca). If already have a pointer, EmitParmDecl doesn't need to copy it
2283 // into a local alloca for us.
John McCall7f416cc2015-09-08 08:05:57 +00002284 SmallVector<ParamValue, 16> ArgVals;
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002285 ArgVals.reserve(Args.size());
2286
Reid Kleckner739756c2013-12-04 19:23:12 +00002287 // Create a pointer value for every parameter declaration. This usually
2288 // entails copying one or more LLVM IR arguments into an alloca. Don't push
2289 // any cleanups or do anything that might unwind. We do that separately, so
2290 // we can push the cleanups in the correct order for the ABI.
Daniel Dunbara45bdbb2009-02-04 21:17:21 +00002291 assert(FI.arg_size() == Args.size() &&
2292 "Mismatch between function signature & arguments.");
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002293 unsigned ArgNo = 0;
Daniel Dunbarb52d0772009-02-03 05:59:18 +00002294 CGFunctionInfo::const_arg_iterator info_it = FI.arg_begin();
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002295 for (FunctionArgList::const_iterator i = Args.begin(), e = Args.end();
Devang Patel68a15252011-03-03 20:13:15 +00002296 i != e; ++i, ++info_it, ++ArgNo) {
John McCalla738c252011-03-09 04:27:21 +00002297 const VarDecl *Arg = *i;
Daniel Dunbarb52d0772009-02-03 05:59:18 +00002298 const ABIArgInfo &ArgI = info_it->info;
Daniel Dunbard3674e62008-09-11 01:48:57 +00002299
John McCalla738c252011-03-09 04:27:21 +00002300 bool isPromoted =
2301 isa<ParmVarDecl>(Arg) && cast<ParmVarDecl>(Arg)->isKNRPromoted();
Volodymyr Sapsai17ebdb22018-01-22 22:29:24 +00002302 // We are converting from ABIArgInfo type to VarDecl type directly, unless
2303 // the parameter is promoted. In this case we convert to
2304 // CGFunctionInfo::ArgInfo type with subsequent argument demotion.
2305 QualType Ty = isPromoted ? info_it->type : Arg->getType();
2306 assert(hasScalarEvaluationKind(Ty) ==
2307 hasScalarEvaluationKind(Arg->getType()));
John McCalla738c252011-03-09 04:27:21 +00002308
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002309 unsigned FirstIRArg, NumIRArgs;
2310 std::tie(FirstIRArg, NumIRArgs) = IRFunctionArgs.getIRArgs(ArgNo);
Rafael Espindolafad28de2012-10-24 01:59:00 +00002311
Daniel Dunbard3674e62008-09-11 01:48:57 +00002312 switch (ArgI.getKind()) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002313 case ABIArgInfo::InAlloca: {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002314 assert(NumIRArgs == 0);
John McCall7f416cc2015-09-08 08:05:57 +00002315 auto FieldIndex = ArgI.getInAllocaFieldIndex();
2316 CharUnits FieldOffset =
2317 CharUnits::fromQuantity(ArgStructLayout->getElementOffset(FieldIndex));
2318 Address V = Builder.CreateStructGEP(ArgStruct, FieldIndex, FieldOffset,
2319 Arg->getName());
2320 ArgVals.push_back(ParamValue::forIndirect(V));
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002321 break;
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002322 }
2323
Daniel Dunbar747865a2009-02-05 09:16:39 +00002324 case ABIArgInfo::Indirect: {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002325 assert(NumIRArgs == 1);
John McCall7f416cc2015-09-08 08:05:57 +00002326 Address ParamAddr = Address(FnArgs[FirstIRArg], ArgI.getIndirectAlign());
Daniel Dunbar7b7c2932010-09-16 20:42:02 +00002327
John McCall47fb9502013-03-07 21:37:08 +00002328 if (!hasScalarEvaluationKind(Ty)) {
Daniel Dunbar7b7c2932010-09-16 20:42:02 +00002329 // Aggregates and complex variables are accessed by reference. All we
John McCall7f416cc2015-09-08 08:05:57 +00002330 // need to do is realign the value, if requested.
2331 Address V = ParamAddr;
Daniel Dunbar7b7c2932010-09-16 20:42:02 +00002332 if (ArgI.getIndirectRealign()) {
John McCall7f416cc2015-09-08 08:05:57 +00002333 Address AlignedTemp = CreateMemTemp(Ty, "coerce");
Daniel Dunbar7b7c2932010-09-16 20:42:02 +00002334
2335 // Copy from the incoming argument pointer to the temporary with the
2336 // appropriate alignment.
2337 //
2338 // FIXME: We should have a common utility for generating an aggregate
2339 // copy.
Ken Dyck705ba072011-01-19 01:58:38 +00002340 CharUnits Size = getContext().getTypeSizeInChars(Ty);
John McCall7f416cc2015-09-08 08:05:57 +00002341 auto SizeVal = llvm::ConstantInt::get(IntPtrTy, Size.getQuantity());
2342 Address Dst = Builder.CreateBitCast(AlignedTemp, Int8PtrTy);
2343 Address Src = Builder.CreateBitCast(ParamAddr, Int8PtrTy);
2344 Builder.CreateMemCpy(Dst, Src, SizeVal, false);
Daniel Dunbar7b7c2932010-09-16 20:42:02 +00002345 V = AlignedTemp;
2346 }
John McCall7f416cc2015-09-08 08:05:57 +00002347 ArgVals.push_back(ParamValue::forIndirect(V));
Daniel Dunbar747865a2009-02-05 09:16:39 +00002348 } else {
2349 // Load scalar value from indirect argument.
John McCall7f416cc2015-09-08 08:05:57 +00002350 llvm::Value *V =
Stephen Kellyf2ceec42018-08-09 21:08:08 +00002351 EmitLoadOfScalar(ParamAddr, false, Ty, Arg->getBeginLoc());
John McCalla738c252011-03-09 04:27:21 +00002352
2353 if (isPromoted)
2354 V = emitArgumentDemotion(*this, Arg, V);
John McCall7f416cc2015-09-08 08:05:57 +00002355 ArgVals.push_back(ParamValue::forDirect(V));
Daniel Dunbar747865a2009-02-05 09:16:39 +00002356 }
Daniel Dunbar747865a2009-02-05 09:16:39 +00002357 break;
2358 }
Anton Korobeynikov18adbf52009-06-06 09:36:29 +00002359
2360 case ABIArgInfo::Extend:
Daniel Dunbar67dace892009-02-03 06:17:37 +00002361 case ABIArgInfo::Direct: {
Akira Hatanaka18334dd2012-01-09 19:08:06 +00002362
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002363 // If we have the trivial case, handle it with no muss and fuss.
2364 if (!isa<llvm::StructType>(ArgI.getCoerceToType()) &&
Volodymyr Sapsai22b00ec2017-12-21 20:52:59 +00002365 ArgI.getCoerceToType() == ConvertType(Ty) &&
Chris Lattner8a2f3c72010-07-30 04:02:24 +00002366 ArgI.getDirectOffset() == 0) {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002367 assert(NumIRArgs == 1);
John McCall12f23522016-04-04 18:33:08 +00002368 llvm::Value *V = FnArgs[FirstIRArg];
2369 auto AI = cast<llvm::Argument>(V);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002370
Hal Finkel48d53e22014-07-19 01:41:07 +00002371 if (const ParmVarDecl *PVD = dyn_cast<ParmVarDecl>(Arg)) {
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00002372 if (getNonNullAttr(CurCodeDecl, PVD, PVD->getType(),
Manoj Guptada08f6a2018-07-19 00:44:52 +00002373 PVD->getFunctionScopeIndex()) &&
2374 !CGM.getCodeGenOpts().NullPointerIsValid)
Reid Klecknercdd26792017-04-18 23:50:03 +00002375 AI->addAttr(llvm::Attribute::NonNull);
Hal Finkel82504f02014-07-11 17:35:21 +00002376
Hal Finkel48d53e22014-07-19 01:41:07 +00002377 QualType OTy = PVD->getOriginalType();
2378 if (const auto *ArrTy =
2379 getContext().getAsConstantArrayType(OTy)) {
2380 // A C99 array parameter declaration with the static keyword also
2381 // indicates dereferenceability, and if the size is constant we can
2382 // use the dereferenceable attribute (which requires the size in
2383 // bytes).
Hal Finkel16e394a2014-07-19 02:13:40 +00002384 if (ArrTy->getSizeModifier() == ArrayType::Static) {
Hal Finkel48d53e22014-07-19 01:41:07 +00002385 QualType ETy = ArrTy->getElementType();
2386 uint64_t ArrSize = ArrTy->getSize().getZExtValue();
2387 if (!ETy->isIncompleteType() && ETy->isConstantSizeType() &&
2388 ArrSize) {
2389 llvm::AttrBuilder Attrs;
2390 Attrs.addDereferenceableAttr(
2391 getContext().getTypeSizeInChars(ETy).getQuantity()*ArrSize);
Reid Kleckner9d16fa02017-04-19 17:28:52 +00002392 AI->addAttrs(Attrs);
Manoj Guptada08f6a2018-07-19 00:44:52 +00002393 } else if (getContext().getTargetAddressSpace(ETy) == 0 &&
2394 !CGM.getCodeGenOpts().NullPointerIsValid) {
Reid Klecknercdd26792017-04-18 23:50:03 +00002395 AI->addAttr(llvm::Attribute::NonNull);
Hal Finkel48d53e22014-07-19 01:41:07 +00002396 }
2397 }
2398 } else if (const auto *ArrTy =
2399 getContext().getAsVariableArrayType(OTy)) {
2400 // For C99 VLAs with the static keyword, we don't know the size so
2401 // we can't use the dereferenceable attribute, but in addrspace(0)
2402 // we know that it must be nonnull.
2403 if (ArrTy->getSizeModifier() == VariableArrayType::Static &&
Manoj Guptada08f6a2018-07-19 00:44:52 +00002404 !getContext().getTargetAddressSpace(ArrTy->getElementType()) &&
2405 !CGM.getCodeGenOpts().NullPointerIsValid)
Reid Klecknercdd26792017-04-18 23:50:03 +00002406 AI->addAttr(llvm::Attribute::NonNull);
Hal Finkel48d53e22014-07-19 01:41:07 +00002407 }
Hal Finkel1b0d24e2014-10-02 21:21:25 +00002408
2409 const auto *AVAttr = PVD->getAttr<AlignValueAttr>();
2410 if (!AVAttr)
2411 if (const auto *TOTy = dyn_cast<TypedefType>(OTy))
2412 AVAttr = TOTy->getDecl()->getAttr<AlignValueAttr>();
Vlad Tsyrklevich86e68fd2019-01-15 03:38:02 +00002413 if (AVAttr) {
Hal Finkel1b0d24e2014-10-02 21:21:25 +00002414 llvm::Value *AlignmentValue =
2415 EmitScalarExpr(AVAttr->getAlignment());
2416 llvm::ConstantInt *AlignmentCI =
2417 cast<llvm::ConstantInt>(AlignmentValue);
Reid Kleckner9d16fa02017-04-19 17:28:52 +00002418 unsigned Alignment = std::min((unsigned)AlignmentCI->getZExtValue(),
2419 +llvm::Value::MaximumAlignment);
2420 AI->addAttrs(llvm::AttrBuilder().addAlignmentAttr(Alignment));
Hal Finkel1b0d24e2014-10-02 21:21:25 +00002421 }
Hal Finkel48d53e22014-07-19 01:41:07 +00002422 }
2423
Bill Wendling507c3512012-10-16 05:23:44 +00002424 if (Arg->getType().isRestrictQualified())
Reid Klecknercdd26792017-04-18 23:50:03 +00002425 AI->addAttr(llvm::Attribute::NoAlias);
John McCall39ec71f2010-03-27 00:47:27 +00002426
John McCall12f23522016-04-04 18:33:08 +00002427 // LLVM expects swifterror parameters to be used in very restricted
2428 // ways. Copy the value into a less-restricted temporary.
2429 if (FI.getExtParameterInfo(ArgNo).getABI()
2430 == ParameterABI::SwiftErrorResult) {
2431 QualType pointeeTy = Ty->getPointeeType();
2432 assert(pointeeTy->isPointerType());
2433 Address temp =
2434 CreateMemTemp(pointeeTy, getPointerAlign(), "swifterror.temp");
2435 Address arg = Address(V, getContext().getTypeAlignInChars(pointeeTy));
2436 llvm::Value *incomingErrorValue = Builder.CreateLoad(arg);
2437 Builder.CreateStore(incomingErrorValue, temp);
2438 V = temp.getPointer();
2439
2440 // Push a cleanup to copy the value back at the end of the function.
2441 // The convention does not guarantee that the value will be written
2442 // back if the function exits with an unwind exception.
2443 EHStack.pushCleanup<CopyBackSwiftError>(NormalCleanup, temp, arg);
2444 }
2445
Chris Lattner7369c142011-07-20 06:29:00 +00002446 // Ensure the argument is the correct type.
2447 if (V->getType() != ArgI.getCoerceToType())
2448 V = Builder.CreateBitCast(V, ArgI.getCoerceToType());
2449
John McCalla738c252011-03-09 04:27:21 +00002450 if (isPromoted)
2451 V = emitArgumentDemotion(*this, Arg, V);
Rafael Espindola8778c282012-11-29 16:09:03 +00002452
2453 // Because of merging of function types from multiple decls it is
2454 // possible for the type of an argument to not match the corresponding
2455 // type in the function type. Since we are codegening the callee
2456 // in here, add a cast to the argument type.
2457 llvm::Type *LTy = ConvertType(Arg->getType());
2458 if (V->getType() != LTy)
2459 V = Builder.CreateBitCast(V, LTy);
2460
John McCall7f416cc2015-09-08 08:05:57 +00002461 ArgVals.push_back(ParamValue::forDirect(V));
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002462 break;
Daniel Dunbard5f1f552009-02-10 00:06:49 +00002463 }
Mike Stump11289f42009-09-09 15:08:12 +00002464
Volodymyr Sapsai22b00ec2017-12-21 20:52:59 +00002465 Address Alloca = CreateMemTemp(Ty, getContext().getDeclAlign(Arg),
2466 Arg->getName());
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002467
John McCall7f416cc2015-09-08 08:05:57 +00002468 // Pointer to store into.
2469 Address Ptr = emitAddressAtOffset(*this, Alloca, ArgI);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002470
Oliver Stannard2bfdc5b2014-08-27 10:43:15 +00002471 // Fast-isel and the optimizer generally like scalar values better than
2472 // FCAs, so we flatten them if this is safe to do for this argument.
Evgeniy Stepanov3fae4ae2012-02-10 09:30:15 +00002473 llvm::StructType *STy = dyn_cast<llvm::StructType>(ArgI.getCoerceToType());
Oliver Stannard2bfdc5b2014-08-27 10:43:15 +00002474 if (ArgI.isDirect() && ArgI.getCanBeFlattened() && STy &&
2475 STy->getNumElements() > 1) {
John McCall7f416cc2015-09-08 08:05:57 +00002476 auto SrcLayout = CGM.getDataLayout().getStructLayout(STy);
Micah Villmowdd31ca12012-10-08 16:25:52 +00002477 uint64_t SrcSize = CGM.getDataLayout().getTypeAllocSize(STy);
John McCall7f416cc2015-09-08 08:05:57 +00002478 llvm::Type *DstTy = Ptr.getElementType();
Micah Villmowdd31ca12012-10-08 16:25:52 +00002479 uint64_t DstSize = CGM.getDataLayout().getTypeAllocSize(DstTy);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002480
John McCall7f416cc2015-09-08 08:05:57 +00002481 Address AddrToStoreInto = Address::invalid();
Evgeniy Stepanov3fae4ae2012-02-10 09:30:15 +00002482 if (SrcSize <= DstSize) {
Yaxun Liue9e5c4f2017-06-29 18:47:45 +00002483 AddrToStoreInto = Builder.CreateElementBitCast(Ptr, STy);
Evgeniy Stepanov3fae4ae2012-02-10 09:30:15 +00002484 } else {
John McCall7f416cc2015-09-08 08:05:57 +00002485 AddrToStoreInto =
2486 CreateTempAlloca(STy, Alloca.getAlignment(), "coerce");
Chris Lattner15ec3612010-06-29 00:06:42 +00002487 }
John McCall7f416cc2015-09-08 08:05:57 +00002488
2489 assert(STy->getNumElements() == NumIRArgs);
2490 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
2491 auto AI = FnArgs[FirstIRArg + i];
2492 AI->setName(Arg->getName() + ".coerce" + Twine(i));
2493 auto Offset = CharUnits::fromQuantity(SrcLayout->getElementOffset(i));
2494 Address EltPtr =
2495 Builder.CreateStructGEP(AddrToStoreInto, i, Offset);
2496 Builder.CreateStore(AI, EltPtr);
2497 }
2498
2499 if (SrcSize > DstSize) {
2500 Builder.CreateMemCpy(Ptr, AddrToStoreInto, DstSize);
2501 }
2502
Chris Lattner15ec3612010-06-29 00:06:42 +00002503 } else {
2504 // Simple case, just do a coerced store of the argument into the alloca.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002505 assert(NumIRArgs == 1);
2506 auto AI = FnArgs[FirstIRArg];
Chris Lattner9e748e92010-06-29 00:14:52 +00002507 AI->setName(Arg->getName() + ".coerce");
John McCall7f416cc2015-09-08 08:05:57 +00002508 CreateCoercedStore(AI, Ptr, /*DestIsVolatile=*/false, *this);
Chris Lattner15ec3612010-06-29 00:06:42 +00002509 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002510
Daniel Dunbar2f219b02009-02-03 19:12:28 +00002511 // Match to what EmitParmDecl is expecting for this type.
Volodymyr Sapsai22b00ec2017-12-21 20:52:59 +00002512 if (CodeGenFunction::hasScalarEvaluationKind(Ty)) {
John McCall7f416cc2015-09-08 08:05:57 +00002513 llvm::Value *V =
Stephen Kellyf2ceec42018-08-09 21:08:08 +00002514 EmitLoadOfScalar(Alloca, false, Ty, Arg->getBeginLoc());
John McCalla738c252011-03-09 04:27:21 +00002515 if (isPromoted)
2516 V = emitArgumentDemotion(*this, Arg, V);
John McCall7f416cc2015-09-08 08:05:57 +00002517 ArgVals.push_back(ParamValue::forDirect(V));
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002518 } else {
John McCall7f416cc2015-09-08 08:05:57 +00002519 ArgVals.push_back(ParamValue::forIndirect(Alloca));
Daniel Dunbar6e3b7df2009-02-04 07:22:24 +00002520 }
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002521 break;
Daniel Dunbar2f219b02009-02-03 19:12:28 +00002522 }
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002523
John McCallf26e73d2016-03-11 04:30:43 +00002524 case ABIArgInfo::CoerceAndExpand: {
2525 // Reconstruct into a temporary.
2526 Address alloca = CreateMemTemp(Ty, getContext().getDeclAlign(Arg));
2527 ArgVals.push_back(ParamValue::forIndirect(alloca));
2528
2529 auto coercionType = ArgI.getCoerceAndExpandType();
2530 alloca = Builder.CreateElementBitCast(alloca, coercionType);
2531 auto layout = CGM.getDataLayout().getStructLayout(coercionType);
2532
2533 unsigned argIndex = FirstIRArg;
2534 for (unsigned i = 0, e = coercionType->getNumElements(); i != e; ++i) {
2535 llvm::Type *eltType = coercionType->getElementType(i);
2536 if (ABIArgInfo::isPaddingForCoerceAndExpand(eltType))
2537 continue;
2538
2539 auto eltAddr = Builder.CreateStructGEP(alloca, i, layout);
2540 auto elt = FnArgs[argIndex++];
2541 Builder.CreateStore(elt, eltAddr);
2542 }
2543 assert(argIndex == FirstIRArg + NumIRArgs);
2544 break;
2545 }
2546
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002547 case ABIArgInfo::Expand: {
2548 // If this structure was expanded into multiple arguments then
2549 // we need to create a temporary and reconstruct it from the
2550 // arguments.
John McCall7f416cc2015-09-08 08:05:57 +00002551 Address Alloca = CreateMemTemp(Ty, getContext().getDeclAlign(Arg));
2552 LValue LV = MakeAddrLValue(Alloca, Ty);
2553 ArgVals.push_back(ParamValue::forIndirect(Alloca));
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002554
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002555 auto FnArgIter = FnArgs.begin() + FirstIRArg;
2556 ExpandTypeFromArgs(Ty, LV, FnArgIter);
2557 assert(FnArgIter == FnArgs.begin() + FirstIRArg + NumIRArgs);
2558 for (unsigned i = 0, e = NumIRArgs; i != e; ++i) {
2559 auto AI = FnArgs[FirstIRArg + i];
2560 AI->setName(Arg->getName() + "." + Twine(i));
2561 }
2562 break;
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002563 }
2564
2565 case ABIArgInfo::Ignore:
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002566 assert(NumIRArgs == 0);
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002567 // Initialize the local variable appropriately.
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002568 if (!hasScalarEvaluationKind(Ty)) {
John McCall7f416cc2015-09-08 08:05:57 +00002569 ArgVals.push_back(ParamValue::forIndirect(CreateMemTemp(Ty)));
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002570 } else {
2571 llvm::Value *U = llvm::UndefValue::get(ConvertType(Arg->getType()));
John McCall7f416cc2015-09-08 08:05:57 +00002572 ArgVals.push_back(ParamValue::forDirect(U));
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002573 }
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002574 break;
Daniel Dunbard3674e62008-09-11 01:48:57 +00002575 }
Daniel Dunbar613855c2008-09-09 23:27:19 +00002576 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002577
Reid Kleckner739756c2013-12-04 19:23:12 +00002578 if (getTarget().getCXXABI().areArgsDestroyedLeftToRightInCallee()) {
2579 for (int I = Args.size() - 1; I >= 0; --I)
John McCall7f416cc2015-09-08 08:05:57 +00002580 EmitParmDecl(*Args[I], ArgVals[I], I + 1);
Reid Kleckner739756c2013-12-04 19:23:12 +00002581 } else {
2582 for (unsigned I = 0, E = Args.size(); I != E; ++I)
John McCall7f416cc2015-09-08 08:05:57 +00002583 EmitParmDecl(*Args[I], ArgVals[I], I + 1);
Reid Kleckner739756c2013-12-04 19:23:12 +00002584 }
Daniel Dunbar613855c2008-09-09 23:27:19 +00002585}
2586
John McCallffa2c1a2012-01-29 07:46:59 +00002587static void eraseUnusedBitCasts(llvm::Instruction *insn) {
2588 while (insn->use_empty()) {
2589 llvm::BitCastInst *bitcast = dyn_cast<llvm::BitCastInst>(insn);
2590 if (!bitcast) return;
2591
2592 // This is "safe" because we would have used a ConstantExpr otherwise.
2593 insn = cast<llvm::Instruction>(bitcast->getOperand(0));
2594 bitcast->eraseFromParent();
2595 }
2596}
2597
John McCall31168b02011-06-15 23:02:42 +00002598/// Try to emit a fused autorelease of a return result.
2599static llvm::Value *tryEmitFusedAutoreleaseOfResult(CodeGenFunction &CGF,
2600 llvm::Value *result) {
2601 // We must be immediately followed the cast.
2602 llvm::BasicBlock *BB = CGF.Builder.GetInsertBlock();
Craig Topper8a13c412014-05-21 05:09:00 +00002603 if (BB->empty()) return nullptr;
2604 if (&BB->back() != result) return nullptr;
John McCall31168b02011-06-15 23:02:42 +00002605
Chris Lattner2192fe52011-07-18 04:24:23 +00002606 llvm::Type *resultType = result->getType();
John McCall31168b02011-06-15 23:02:42 +00002607
2608 // result is in a BasicBlock and is therefore an Instruction.
2609 llvm::Instruction *generator = cast<llvm::Instruction>(result);
2610
Justin Bogner882f8612016-08-18 21:46:54 +00002611 SmallVector<llvm::Instruction *, 4> InstsToKill;
John McCall31168b02011-06-15 23:02:42 +00002612
2613 // Look for:
2614 // %generator = bitcast %type1* %generator2 to %type2*
2615 while (llvm::BitCastInst *bitcast = dyn_cast<llvm::BitCastInst>(generator)) {
2616 // We would have emitted this as a constant if the operand weren't
2617 // an Instruction.
2618 generator = cast<llvm::Instruction>(bitcast->getOperand(0));
2619
2620 // Require the generator to be immediately followed by the cast.
2621 if (generator->getNextNode() != bitcast)
Craig Topper8a13c412014-05-21 05:09:00 +00002622 return nullptr;
John McCall31168b02011-06-15 23:02:42 +00002623
Justin Bogner882f8612016-08-18 21:46:54 +00002624 InstsToKill.push_back(bitcast);
John McCall31168b02011-06-15 23:02:42 +00002625 }
2626
2627 // Look for:
2628 // %generator = call i8* @objc_retain(i8* %originalResult)
2629 // or
2630 // %generator = call i8* @objc_retainAutoreleasedReturnValue(i8* %originalResult)
2631 llvm::CallInst *call = dyn_cast<llvm::CallInst>(generator);
Craig Topper8a13c412014-05-21 05:09:00 +00002632 if (!call) return nullptr;
John McCall31168b02011-06-15 23:02:42 +00002633
2634 bool doRetainAutorelease;
2635
John McCallb04ecb72015-10-21 18:06:43 +00002636 if (call->getCalledValue() == CGF.CGM.getObjCEntrypoints().objc_retain) {
John McCall31168b02011-06-15 23:02:42 +00002637 doRetainAutorelease = true;
John McCallb04ecb72015-10-21 18:06:43 +00002638 } else if (call->getCalledValue() == CGF.CGM.getObjCEntrypoints()
John McCall31168b02011-06-15 23:02:42 +00002639 .objc_retainAutoreleasedReturnValue) {
2640 doRetainAutorelease = false;
2641
John McCallcfa4e9b2012-09-07 23:30:50 +00002642 // If we emitted an assembly marker for this call (and the
2643 // ARCEntrypoints field should have been set if so), go looking
2644 // for that call. If we can't find it, we can't do this
2645 // optimization. But it should always be the immediately previous
2646 // instruction, unless we needed bitcasts around the call.
John McCallb04ecb72015-10-21 18:06:43 +00002647 if (CGF.CGM.getObjCEntrypoints().retainAutoreleasedReturnValueMarker) {
John McCallcfa4e9b2012-09-07 23:30:50 +00002648 llvm::Instruction *prev = call->getPrevNode();
2649 assert(prev);
2650 if (isa<llvm::BitCastInst>(prev)) {
2651 prev = prev->getPrevNode();
2652 assert(prev);
2653 }
2654 assert(isa<llvm::CallInst>(prev));
2655 assert(cast<llvm::CallInst>(prev)->getCalledValue() ==
John McCallb04ecb72015-10-21 18:06:43 +00002656 CGF.CGM.getObjCEntrypoints().retainAutoreleasedReturnValueMarker);
Justin Bogner882f8612016-08-18 21:46:54 +00002657 InstsToKill.push_back(prev);
John McCallcfa4e9b2012-09-07 23:30:50 +00002658 }
John McCall31168b02011-06-15 23:02:42 +00002659 } else {
Craig Topper8a13c412014-05-21 05:09:00 +00002660 return nullptr;
John McCall31168b02011-06-15 23:02:42 +00002661 }
2662
2663 result = call->getArgOperand(0);
Justin Bogner882f8612016-08-18 21:46:54 +00002664 InstsToKill.push_back(call);
John McCall31168b02011-06-15 23:02:42 +00002665
2666 // Keep killing bitcasts, for sanity. Note that we no longer care
2667 // about precise ordering as long as there's exactly one use.
2668 while (llvm::BitCastInst *bitcast = dyn_cast<llvm::BitCastInst>(result)) {
2669 if (!bitcast->hasOneUse()) break;
Justin Bogner882f8612016-08-18 21:46:54 +00002670 InstsToKill.push_back(bitcast);
John McCall31168b02011-06-15 23:02:42 +00002671 result = bitcast->getOperand(0);
2672 }
2673
2674 // Delete all the unnecessary instructions, from latest to earliest.
Justin Bogner882f8612016-08-18 21:46:54 +00002675 for (auto *I : InstsToKill)
Saleem Abdulrasoolbe25c482016-08-18 21:40:06 +00002676 I->eraseFromParent();
John McCall31168b02011-06-15 23:02:42 +00002677
2678 // Do the fused retain/autorelease if we were asked to.
2679 if (doRetainAutorelease)
2680 result = CGF.EmitARCRetainAutoreleaseReturnValue(result);
2681
2682 // Cast back to the result type.
2683 return CGF.Builder.CreateBitCast(result, resultType);
2684}
2685
John McCallffa2c1a2012-01-29 07:46:59 +00002686/// If this is a +1 of the value of an immutable 'self', remove it.
2687static llvm::Value *tryRemoveRetainOfSelf(CodeGenFunction &CGF,
2688 llvm::Value *result) {
2689 // This is only applicable to a method with an immutable 'self'.
John McCallff755cd2012-07-31 00:33:55 +00002690 const ObjCMethodDecl *method =
2691 dyn_cast_or_null<ObjCMethodDecl>(CGF.CurCodeDecl);
Craig Topper8a13c412014-05-21 05:09:00 +00002692 if (!method) return nullptr;
John McCallffa2c1a2012-01-29 07:46:59 +00002693 const VarDecl *self = method->getSelfDecl();
Craig Topper8a13c412014-05-21 05:09:00 +00002694 if (!self->getType().isConstQualified()) return nullptr;
John McCallffa2c1a2012-01-29 07:46:59 +00002695
2696 // Look for a retain call.
2697 llvm::CallInst *retainCall =
2698 dyn_cast<llvm::CallInst>(result->stripPointerCasts());
2699 if (!retainCall ||
John McCallb04ecb72015-10-21 18:06:43 +00002700 retainCall->getCalledValue() != CGF.CGM.getObjCEntrypoints().objc_retain)
Craig Topper8a13c412014-05-21 05:09:00 +00002701 return nullptr;
John McCallffa2c1a2012-01-29 07:46:59 +00002702
2703 // Look for an ordinary load of 'self'.
2704 llvm::Value *retainedValue = retainCall->getArgOperand(0);
2705 llvm::LoadInst *load =
2706 dyn_cast<llvm::LoadInst>(retainedValue->stripPointerCasts());
Fangrui Song6907ce22018-07-30 19:24:48 +00002707 if (!load || load->isAtomic() || load->isVolatile() ||
John McCall7f416cc2015-09-08 08:05:57 +00002708 load->getPointerOperand() != CGF.GetAddrOfLocalVar(self).getPointer())
Craig Topper8a13c412014-05-21 05:09:00 +00002709 return nullptr;
John McCallffa2c1a2012-01-29 07:46:59 +00002710
2711 // Okay! Burn it all down. This relies for correctness on the
2712 // assumption that the retain is emitted as part of the return and
2713 // that thereafter everything is used "linearly".
2714 llvm::Type *resultType = result->getType();
2715 eraseUnusedBitCasts(cast<llvm::Instruction>(result));
2716 assert(retainCall->use_empty());
2717 retainCall->eraseFromParent();
2718 eraseUnusedBitCasts(cast<llvm::Instruction>(retainedValue));
2719
2720 return CGF.Builder.CreateBitCast(load, resultType);
2721}
2722
John McCall31168b02011-06-15 23:02:42 +00002723/// Emit an ARC autorelease of the result of a function.
John McCallffa2c1a2012-01-29 07:46:59 +00002724///
2725/// \return the value to actually return from the function
John McCall31168b02011-06-15 23:02:42 +00002726static llvm::Value *emitAutoreleaseOfResult(CodeGenFunction &CGF,
2727 llvm::Value *result) {
John McCallffa2c1a2012-01-29 07:46:59 +00002728 // If we're returning 'self', kill the initial retain. This is a
2729 // heuristic attempt to "encourage correctness" in the really unfortunate
2730 // case where we have a return of self during a dealloc and we desperately
2731 // need to avoid the possible autorelease.
2732 if (llvm::Value *self = tryRemoveRetainOfSelf(CGF, result))
2733 return self;
2734
John McCall31168b02011-06-15 23:02:42 +00002735 // At -O0, try to emit a fused retain/autorelease.
2736 if (CGF.shouldUseFusedARCCalls())
2737 if (llvm::Value *fused = tryEmitFusedAutoreleaseOfResult(CGF, result))
2738 return fused;
2739
2740 return CGF.EmitARCAutoreleaseReturnValue(result);
2741}
2742
John McCall6e1c0122012-01-29 02:35:02 +00002743/// Heuristically search for a dominating store to the return-value slot.
2744static llvm::StoreInst *findDominatingStoreToReturnValue(CodeGenFunction &CGF) {
Jakub Kuderskif50ab0f2015-09-08 10:36:42 +00002745 // Check if a User is a store which pointerOperand is the ReturnValue.
2746 // We are looking for stores to the ReturnValue, not for stores of the
2747 // ReturnValue to some other location.
2748 auto GetStoreIfValid = [&CGF](llvm::User *U) -> llvm::StoreInst * {
2749 auto *SI = dyn_cast<llvm::StoreInst>(U);
2750 if (!SI || SI->getPointerOperand() != CGF.ReturnValue.getPointer())
2751 return nullptr;
2752 // These aren't actually possible for non-coerced returns, and we
2753 // only care about non-coerced returns on this code path.
2754 assert(!SI->isAtomic() && !SI->isVolatile());
2755 return SI;
2756 };
John McCall6e1c0122012-01-29 02:35:02 +00002757 // If there are multiple uses of the return-value slot, just check
2758 // for something immediately preceding the IP. Sometimes this can
2759 // happen with how we generate implicit-returns; it can also happen
2760 // with noreturn cleanups.
John McCall7f416cc2015-09-08 08:05:57 +00002761 if (!CGF.ReturnValue.getPointer()->hasOneUse()) {
John McCall6e1c0122012-01-29 02:35:02 +00002762 llvm::BasicBlock *IP = CGF.Builder.GetInsertBlock();
Craig Topper8a13c412014-05-21 05:09:00 +00002763 if (IP->empty()) return nullptr;
David Majnemerdc012fa2015-04-22 21:38:15 +00002764 llvm::Instruction *I = &IP->back();
2765
2766 // Skip lifetime markers
2767 for (llvm::BasicBlock::reverse_iterator II = IP->rbegin(),
2768 IE = IP->rend();
2769 II != IE; ++II) {
2770 if (llvm::IntrinsicInst *Intrinsic =
2771 dyn_cast<llvm::IntrinsicInst>(&*II)) {
2772 if (Intrinsic->getIntrinsicID() == llvm::Intrinsic::lifetime_end) {
2773 const llvm::Value *CastAddr = Intrinsic->getArgOperand(1);
2774 ++II;
Alexey Samsonov10544202015-06-12 21:05:32 +00002775 if (II == IE)
2776 break;
2777 if (isa<llvm::BitCastInst>(&*II) && (CastAddr == &*II))
2778 continue;
David Majnemerdc012fa2015-04-22 21:38:15 +00002779 }
2780 }
2781 I = &*II;
2782 break;
2783 }
2784
Jakub Kuderskif50ab0f2015-09-08 10:36:42 +00002785 return GetStoreIfValid(I);
John McCall6e1c0122012-01-29 02:35:02 +00002786 }
2787
2788 llvm::StoreInst *store =
Jakub Kuderskif50ab0f2015-09-08 10:36:42 +00002789 GetStoreIfValid(CGF.ReturnValue.getPointer()->user_back());
Craig Topper8a13c412014-05-21 05:09:00 +00002790 if (!store) return nullptr;
John McCall6e1c0122012-01-29 02:35:02 +00002791
John McCall6e1c0122012-01-29 02:35:02 +00002792 // Now do a first-and-dirty dominance check: just walk up the
2793 // single-predecessors chain from the current insertion point.
2794 llvm::BasicBlock *StoreBB = store->getParent();
2795 llvm::BasicBlock *IP = CGF.Builder.GetInsertBlock();
2796 while (IP != StoreBB) {
2797 if (!(IP = IP->getSinglePredecessor()))
Craig Topper8a13c412014-05-21 05:09:00 +00002798 return nullptr;
John McCall6e1c0122012-01-29 02:35:02 +00002799 }
2800
2801 // Okay, the store's basic block dominates the insertion point; we
2802 // can do our thing.
2803 return store;
2804}
2805
Adrian Prantl3be10542013-05-02 17:30:20 +00002806void CodeGenFunction::EmitFunctionEpilog(const CGFunctionInfo &FI,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002807 bool EmitRetDbgLoc,
2808 SourceLocation EndLoc) {
Vedant Kumar09b5bfd2017-12-21 00:10:25 +00002809 if (FI.isNoReturn()) {
2810 // Noreturn functions don't return.
2811 EmitUnreachable(EndLoc);
2812 return;
2813 }
2814
Hans Wennborgd71907d2014-09-04 22:16:33 +00002815 if (CurCodeDecl && CurCodeDecl->hasAttr<NakedAttr>()) {
2816 // Naked functions don't have epilogues.
2817 Builder.CreateUnreachable();
2818 return;
2819 }
2820
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00002821 // Functions with no result always return void.
John McCall7f416cc2015-09-08 08:05:57 +00002822 if (!ReturnValue.isValid()) {
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00002823 Builder.CreateRetVoid();
Chris Lattner726b3d02010-06-26 23:13:19 +00002824 return;
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00002825 }
Daniel Dunbar6696e222010-06-30 21:27:58 +00002826
Dan Gohman481e40c2010-07-20 20:13:52 +00002827 llvm::DebugLoc RetDbgLoc;
Craig Topper8a13c412014-05-21 05:09:00 +00002828 llvm::Value *RV = nullptr;
Chris Lattner726b3d02010-06-26 23:13:19 +00002829 QualType RetTy = FI.getReturnType();
2830 const ABIArgInfo &RetAI = FI.getReturnInfo();
2831
2832 switch (RetAI.getKind()) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002833 case ABIArgInfo::InAlloca:
Reid Klecknerfab1e892014-02-25 00:59:14 +00002834 // Aggregrates get evaluated directly into the destination. Sometimes we
2835 // need to return the sret value in a register, though.
2836 assert(hasAggregateEvaluationKind(RetTy));
2837 if (RetAI.getInAllocaSRet()) {
2838 llvm::Function::arg_iterator EI = CurFn->arg_end();
2839 --EI;
Duncan P. N. Exon Smith9f5260a2015-11-06 23:00:41 +00002840 llvm::Value *ArgStruct = &*EI;
David Blaikie2e804282015-04-05 22:47:07 +00002841 llvm::Value *SRet = Builder.CreateStructGEP(
2842 nullptr, ArgStruct, RetAI.getInAllocaFieldIndex());
John McCall7f416cc2015-09-08 08:05:57 +00002843 RV = Builder.CreateAlignedLoad(SRet, getPointerAlign(), "sret");
Reid Klecknerfab1e892014-02-25 00:59:14 +00002844 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002845 break;
2846
Daniel Dunbar03816342010-08-21 02:24:36 +00002847 case ABIArgInfo::Indirect: {
Reid Kleckner37abaca2014-05-09 22:46:15 +00002848 auto AI = CurFn->arg_begin();
2849 if (RetAI.isSRetAfterThis())
2850 ++AI;
John McCall47fb9502013-03-07 21:37:08 +00002851 switch (getEvaluationKind(RetTy)) {
2852 case TEK_Complex: {
2853 ComplexPairTy RT =
John McCall7f416cc2015-09-08 08:05:57 +00002854 EmitLoadOfComplex(MakeAddrLValue(ReturnValue, RetTy), EndLoc);
Duncan P. N. Exon Smith9f5260a2015-11-06 23:00:41 +00002855 EmitStoreOfComplex(RT, MakeNaturalAlignAddrLValue(&*AI, RetTy),
John McCall47fb9502013-03-07 21:37:08 +00002856 /*isInit*/ true);
2857 break;
2858 }
2859 case TEK_Aggregate:
Chris Lattner726b3d02010-06-26 23:13:19 +00002860 // Do nothing; aggregrates get evaluated directly into the destination.
John McCall47fb9502013-03-07 21:37:08 +00002861 break;
2862 case TEK_Scalar:
2863 EmitStoreOfScalar(Builder.CreateLoad(ReturnValue),
Duncan P. N. Exon Smith9f5260a2015-11-06 23:00:41 +00002864 MakeNaturalAlignAddrLValue(&*AI, RetTy),
John McCall47fb9502013-03-07 21:37:08 +00002865 /*isInit*/ true);
2866 break;
Chris Lattner726b3d02010-06-26 23:13:19 +00002867 }
2868 break;
Daniel Dunbar03816342010-08-21 02:24:36 +00002869 }
Chris Lattner726b3d02010-06-26 23:13:19 +00002870
2871 case ABIArgInfo::Extend:
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002872 case ABIArgInfo::Direct:
Chris Lattner8a2f3c72010-07-30 04:02:24 +00002873 if (RetAI.getCoerceToType() == ConvertType(RetTy) &&
2874 RetAI.getDirectOffset() == 0) {
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002875 // The internal return value temp always will have pointer-to-return-type
2876 // type, just do a load.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002877
John McCall6e1c0122012-01-29 02:35:02 +00002878 // If there is a dominating store to ReturnValue, we can elide
2879 // the load, zap the store, and usually zap the alloca.
David Majnemerdc012fa2015-04-22 21:38:15 +00002880 if (llvm::StoreInst *SI =
2881 findDominatingStoreToReturnValue(*this)) {
Adrian Prantl4c9a38a2013-05-30 18:12:23 +00002882 // Reuse the debug location from the store unless there is
2883 // cleanup code to be emitted between the store and return
2884 // instruction.
2885 if (EmitRetDbgLoc && !AutoreleaseResult)
Adrian Prantl3be10542013-05-02 17:30:20 +00002886 RetDbgLoc = SI->getDebugLoc();
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002887 // Get the stored value and nuke the now-dead store.
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002888 RV = SI->getValueOperand();
2889 SI->eraseFromParent();
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002890
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002891 // If that was the only use of the return value, nuke it as well now.
John McCall7f416cc2015-09-08 08:05:57 +00002892 auto returnValueInst = ReturnValue.getPointer();
2893 if (returnValueInst->use_empty()) {
2894 if (auto alloca = dyn_cast<llvm::AllocaInst>(returnValueInst)) {
2895 alloca->eraseFromParent();
2896 ReturnValue = Address::invalid();
2897 }
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002898 }
John McCall6e1c0122012-01-29 02:35:02 +00002899
2900 // Otherwise, we have to do a simple load.
2901 } else {
2902 RV = Builder.CreateLoad(ReturnValue);
Chris Lattner3fcc7902010-06-27 01:06:27 +00002903 }
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002904 } else {
Chris Lattner8a2f3c72010-07-30 04:02:24 +00002905 // If the value is offset in memory, apply the offset now.
John McCall7f416cc2015-09-08 08:05:57 +00002906 Address V = emitAddressAtOffset(*this, ReturnValue, RetAI);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002907
John McCall7f416cc2015-09-08 08:05:57 +00002908 RV = CreateCoercedLoad(V, RetAI.getCoerceToType(), *this);
Chris Lattner3fcc7902010-06-27 01:06:27 +00002909 }
John McCall31168b02011-06-15 23:02:42 +00002910
2911 // In ARC, end functions that return a retainable type with a call
2912 // to objc_autoreleaseReturnValue.
2913 if (AutoreleaseResult) {
Akira Hatanaka9d8ac612016-02-17 21:09:50 +00002914#ifndef NDEBUG
2915 // Type::isObjCRetainabletype has to be called on a QualType that hasn't
2916 // been stripped of the typedefs, so we cannot use RetTy here. Get the
2917 // original return type of FunctionDecl, CurCodeDecl, and BlockDecl from
2918 // CurCodeDecl or BlockInfo.
2919 QualType RT;
2920
2921 if (auto *FD = dyn_cast<FunctionDecl>(CurCodeDecl))
2922 RT = FD->getReturnType();
2923 else if (auto *MD = dyn_cast<ObjCMethodDecl>(CurCodeDecl))
2924 RT = MD->getReturnType();
2925 else if (isa<BlockDecl>(CurCodeDecl))
2926 RT = BlockInfo->BlockExpression->getFunctionType()->getReturnType();
2927 else
2928 llvm_unreachable("Unexpected function/method type");
2929
David Blaikiebbafb8a2012-03-11 07:00:24 +00002930 assert(getLangOpts().ObjCAutoRefCount &&
John McCall31168b02011-06-15 23:02:42 +00002931 !FI.isReturnsRetained() &&
Akira Hatanaka9d8ac612016-02-17 21:09:50 +00002932 RT->isObjCRetainableType());
2933#endif
John McCall31168b02011-06-15 23:02:42 +00002934 RV = emitAutoreleaseOfResult(*this, RV);
2935 }
2936
Chris Lattner726b3d02010-06-26 23:13:19 +00002937 break;
Chris Lattner726b3d02010-06-26 23:13:19 +00002938
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002939 case ABIArgInfo::Ignore:
Chris Lattner726b3d02010-06-26 23:13:19 +00002940 break;
2941
John McCallf26e73d2016-03-11 04:30:43 +00002942 case ABIArgInfo::CoerceAndExpand: {
2943 auto coercionType = RetAI.getCoerceAndExpandType();
2944 auto layout = CGM.getDataLayout().getStructLayout(coercionType);
2945
2946 // Load all of the coerced elements out into results.
2947 llvm::SmallVector<llvm::Value*, 4> results;
2948 Address addr = Builder.CreateElementBitCast(ReturnValue, coercionType);
2949 for (unsigned i = 0, e = coercionType->getNumElements(); i != e; ++i) {
2950 auto coercedEltType = coercionType->getElementType(i);
2951 if (ABIArgInfo::isPaddingForCoerceAndExpand(coercedEltType))
2952 continue;
2953
2954 auto eltAddr = Builder.CreateStructGEP(addr, i, layout);
2955 auto elt = Builder.CreateLoad(eltAddr);
2956 results.push_back(elt);
2957 }
2958
2959 // If we have one result, it's the single direct result type.
2960 if (results.size() == 1) {
2961 RV = results[0];
2962
2963 // Otherwise, we need to make a first-class aggregate.
2964 } else {
2965 // Construct a return type that lacks padding elements.
2966 llvm::Type *returnType = RetAI.getUnpaddedCoerceAndExpandType();
2967
2968 RV = llvm::UndefValue::get(returnType);
2969 for (unsigned i = 0, e = results.size(); i != e; ++i) {
2970 RV = Builder.CreateInsertValue(RV, results[i], i);
2971 }
2972 }
2973 break;
2974 }
2975
Chris Lattner726b3d02010-06-26 23:13:19 +00002976 case ABIArgInfo::Expand:
David Blaikie83d382b2011-09-23 05:06:16 +00002977 llvm_unreachable("Invalid ABI kind for return argument");
Chris Lattner726b3d02010-06-26 23:13:19 +00002978 }
2979
Alexey Samsonovde443c52014-08-13 00:26:40 +00002980 llvm::Instruction *Ret;
2981 if (RV) {
Vedant Kumarc34d3432017-06-23 21:32:38 +00002982 EmitReturnValueCheck(RV);
Alexey Samsonovde443c52014-08-13 00:26:40 +00002983 Ret = Builder.CreateRet(RV);
2984 } else {
2985 Ret = Builder.CreateRetVoid();
2986 }
2987
Duncan P. N. Exon Smith2809cc72015-03-30 20:01:41 +00002988 if (RetDbgLoc)
Benjamin Kramer03278662015-02-07 13:15:54 +00002989 Ret->setDebugLoc(std::move(RetDbgLoc));
Daniel Dunbar613855c2008-09-09 23:27:19 +00002990}
2991
Vedant Kumarc34d3432017-06-23 21:32:38 +00002992void CodeGenFunction::EmitReturnValueCheck(llvm::Value *RV) {
Vedant Kumar42c17ec2017-03-14 01:56:34 +00002993 // A current decl may not be available when emitting vtable thunks.
2994 if (!CurCodeDecl)
2995 return;
2996
2997 ReturnsNonNullAttr *RetNNAttr = nullptr;
2998 if (SanOpts.has(SanitizerKind::ReturnsNonnullAttribute))
2999 RetNNAttr = CurCodeDecl->getAttr<ReturnsNonNullAttr>();
3000
3001 if (!RetNNAttr && !requiresReturnValueNullabilityCheck())
3002 return;
3003
3004 // Prefer the returns_nonnull attribute if it's present.
3005 SourceLocation AttrLoc;
3006 SanitizerMask CheckKind;
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00003007 SanitizerHandler Handler;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003008 if (RetNNAttr) {
3009 assert(!requiresReturnValueNullabilityCheck() &&
3010 "Cannot check nullability and the nonnull attribute");
3011 AttrLoc = RetNNAttr->getLocation();
3012 CheckKind = SanitizerKind::ReturnsNonnullAttribute;
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00003013 Handler = SanitizerHandler::NonnullReturn;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003014 } else {
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003015 if (auto *DD = dyn_cast<DeclaratorDecl>(CurCodeDecl))
3016 if (auto *TSI = DD->getTypeSourceInfo())
3017 if (auto FTL = TSI->getTypeLoc().castAs<FunctionTypeLoc>())
3018 AttrLoc = FTL.getReturnLoc().findNullabilityLoc();
3019 CheckKind = SanitizerKind::NullabilityReturn;
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00003020 Handler = SanitizerHandler::NullabilityReturn;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003021 }
3022
3023 SanitizerScope SanScope(this);
3024
Vedant Kumarc34d3432017-06-23 21:32:38 +00003025 // Make sure the "return" source location is valid. If we're checking a
3026 // nullability annotation, make sure the preconditions for the check are met.
3027 llvm::BasicBlock *Check = createBasicBlock("nullcheck");
3028 llvm::BasicBlock *NoCheck = createBasicBlock("no.nullcheck");
3029 llvm::Value *SLocPtr = Builder.CreateLoad(ReturnLocation, "return.sloc.load");
3030 llvm::Value *CanNullCheck = Builder.CreateIsNotNull(SLocPtr);
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003031 if (requiresReturnValueNullabilityCheck())
Vedant Kumarc34d3432017-06-23 21:32:38 +00003032 CanNullCheck =
3033 Builder.CreateAnd(CanNullCheck, RetValNullabilityPrecondition);
3034 Builder.CreateCondBr(CanNullCheck, Check, NoCheck);
3035 EmitBlock(Check);
3036
3037 // Now do the null check.
3038 llvm::Value *Cond = Builder.CreateIsNotNull(RV);
3039 llvm::Constant *StaticData[] = {EmitCheckSourceLocation(AttrLoc)};
3040 llvm::Value *DynamicData[] = {SLocPtr};
3041 EmitCheck(std::make_pair(Cond, CheckKind), Handler, StaticData, DynamicData);
3042
3043 EmitBlock(NoCheck);
3044
3045#ifndef NDEBUG
3046 // The return location should not be used after the check has been emitted.
3047 ReturnLocation = Address::invalid();
3048#endif
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003049}
3050
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003051static bool isInAllocaArgument(CGCXXABI &ABI, QualType type) {
3052 const CXXRecordDecl *RD = type->getAsCXXRecordDecl();
3053 return RD && ABI.getRecordArgABI(RD) == CGCXXABI::RAA_DirectInMemory;
3054}
3055
John McCall7f416cc2015-09-08 08:05:57 +00003056static AggValueSlot createPlaceholderSlot(CodeGenFunction &CGF,
3057 QualType Ty) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003058 // FIXME: Generate IR in one pass, rather than going back and fixing up these
3059 // placeholders.
3060 llvm::Type *IRTy = CGF.ConvertTypeForMem(Ty);
Peter Collingbourneb367c562016-11-28 22:30:21 +00003061 llvm::Type *IRPtrTy = IRTy->getPointerTo();
3062 llvm::Value *Placeholder = llvm::UndefValue::get(IRPtrTy->getPointerTo());
John McCall7f416cc2015-09-08 08:05:57 +00003063
3064 // FIXME: When we generate this IR in one pass, we shouldn't need
3065 // this win32-specific alignment hack.
3066 CharUnits Align = CharUnits::fromQuantity(4);
Peter Collingbourneb367c562016-11-28 22:30:21 +00003067 Placeholder = CGF.Builder.CreateAlignedLoad(IRPtrTy, Placeholder, Align);
John McCall7f416cc2015-09-08 08:05:57 +00003068
3069 return AggValueSlot::forAddr(Address(Placeholder, Align),
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003070 Ty.getQualifiers(),
3071 AggValueSlot::IsNotDestructed,
3072 AggValueSlot::DoesNotNeedGCBarriers,
Richard Smithe78fac52018-04-05 20:52:58 +00003073 AggValueSlot::IsNotAliased,
3074 AggValueSlot::DoesNotOverlap);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003075}
3076
John McCall32ea9692011-03-11 20:59:21 +00003077void CodeGenFunction::EmitDelegateCallArg(CallArgList &args,
Nick Lewycky2d84e842013-10-02 02:29:49 +00003078 const VarDecl *param,
3079 SourceLocation loc) {
John McCall23f66262010-05-26 22:34:26 +00003080 // StartFunction converted the ABI-lowered parameter(s) into a
3081 // local alloca. We need to turn that into an r-value suitable
3082 // for EmitCall.
John McCall7f416cc2015-09-08 08:05:57 +00003083 Address local = GetAddrOfLocalVar(param);
John McCall23f66262010-05-26 22:34:26 +00003084
John McCall32ea9692011-03-11 20:59:21 +00003085 QualType type = param->getType();
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003086
Reid Kleckner25b56022018-12-12 23:46:06 +00003087 if (isInAllocaArgument(CGM.getCXXABI(), type)) {
3088 CGM.ErrorUnsupported(param, "forwarded non-trivially copyable parameter");
3089 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003090
John McCall811b2912016-11-18 01:08:24 +00003091 // GetAddrOfLocalVar returns a pointer-to-pointer for references,
3092 // but the argument needs to be the original pointer.
3093 if (type->isReferenceType()) {
3094 args.add(RValue::get(Builder.CreateLoad(local)), type);
3095
3096 // In ARC, move out of consumed arguments so that the release cleanup
3097 // entered by StartFunction doesn't cause an over-release. This isn't
3098 // optimal -O0 code generation, but it should get cleaned up when
3099 // optimization is enabled. This also assumes that delegate calls are
3100 // performed exactly once for a set of arguments, but that should be safe.
3101 } else if (getLangOpts().ObjCAutoRefCount &&
3102 param->hasAttr<NSConsumedAttr>() &&
3103 type->isObjCRetainableType()) {
3104 llvm::Value *ptr = Builder.CreateLoad(local);
3105 auto null =
3106 llvm::ConstantPointerNull::get(cast<llvm::PointerType>(ptr->getType()));
3107 Builder.CreateStore(null, local);
3108 args.add(RValue::get(ptr), type);
3109
Richard Smithd62d4982016-06-14 01:13:21 +00003110 // For the most part, we just need to load the alloca, except that
3111 // aggregate r-values are actually pointers to temporaries.
John McCall811b2912016-11-18 01:08:24 +00003112 } else {
Richard Smithd62d4982016-06-14 01:13:21 +00003113 args.add(convertTempToRValue(local, type, loc), type);
John McCall811b2912016-11-18 01:08:24 +00003114 }
Akira Hatanakaccda3d22018-04-27 06:57:00 +00003115
3116 // Deactivate the cleanup for the callee-destructed param that was pushed.
3117 if (hasAggregateEvaluationKind(type) && !CurFuncIsThunk &&
Akira Hatanaka85282972018-05-15 21:00:30 +00003118 type->getAs<RecordType>()->getDecl()->isParamDestroyedInCallee() &&
3119 type.isDestructedType()) {
Akira Hatanakaccda3d22018-04-27 06:57:00 +00003120 EHScopeStack::stable_iterator cleanup =
3121 CalleeDestructedParamCleanups.lookup(cast<ParmVarDecl>(param));
3122 assert(cleanup.isValid() &&
3123 "cleanup for callee-destructed param not recorded");
3124 // This unreachable is a temporary marker which will be removed later.
3125 llvm::Instruction *isActive = Builder.CreateUnreachable();
3126 args.addArgCleanupDeactivation(cleanup, isActive);
3127 }
John McCall23f66262010-05-26 22:34:26 +00003128}
3129
John McCall31168b02011-06-15 23:02:42 +00003130static bool isProvablyNull(llvm::Value *addr) {
3131 return isa<llvm::ConstantPointerNull>(addr);
3132}
3133
John McCall31168b02011-06-15 23:02:42 +00003134/// Emit the actual writing-back of a writeback.
3135static void emitWriteback(CodeGenFunction &CGF,
3136 const CallArgList::Writeback &writeback) {
John McCalleff18842013-03-23 02:35:54 +00003137 const LValue &srcLV = writeback.Source;
John McCall7f416cc2015-09-08 08:05:57 +00003138 Address srcAddr = srcLV.getAddress();
3139 assert(!isProvablyNull(srcAddr.getPointer()) &&
John McCall31168b02011-06-15 23:02:42 +00003140 "shouldn't have writeback for provably null argument");
3141
Craig Topper8a13c412014-05-21 05:09:00 +00003142 llvm::BasicBlock *contBB = nullptr;
John McCall31168b02011-06-15 23:02:42 +00003143
3144 // If the argument wasn't provably non-null, we need to null check
3145 // before doing the store.
Nuno Lopes9211cee2017-09-09 18:25:36 +00003146 bool provablyNonNull = llvm::isKnownNonZero(srcAddr.getPointer(),
3147 CGF.CGM.getDataLayout());
John McCall31168b02011-06-15 23:02:42 +00003148 if (!provablyNonNull) {
3149 llvm::BasicBlock *writebackBB = CGF.createBasicBlock("icr.writeback");
3150 contBB = CGF.createBasicBlock("icr.done");
3151
John McCall7f416cc2015-09-08 08:05:57 +00003152 llvm::Value *isNull =
3153 CGF.Builder.CreateIsNull(srcAddr.getPointer(), "icr.isnull");
John McCall31168b02011-06-15 23:02:42 +00003154 CGF.Builder.CreateCondBr(isNull, contBB, writebackBB);
3155 CGF.EmitBlock(writebackBB);
3156 }
3157
3158 // Load the value to writeback.
3159 llvm::Value *value = CGF.Builder.CreateLoad(writeback.Temporary);
3160
3161 // Cast it back, in case we're writing an id to a Foo* or something.
John McCall7f416cc2015-09-08 08:05:57 +00003162 value = CGF.Builder.CreateBitCast(value, srcAddr.getElementType(),
3163 "icr.writeback-cast");
Fangrui Song6907ce22018-07-30 19:24:48 +00003164
John McCall31168b02011-06-15 23:02:42 +00003165 // Perform the writeback.
John McCalleff18842013-03-23 02:35:54 +00003166
3167 // If we have a "to use" value, it's something we need to emit a use
3168 // of. This has to be carefully threaded in: if it's done after the
3169 // release it's potentially undefined behavior (and the optimizer
3170 // will ignore it), and if it happens before the retain then the
3171 // optimizer could move the release there.
3172 if (writeback.ToUse) {
3173 assert(srcLV.getObjCLifetime() == Qualifiers::OCL_Strong);
3174
3175 // Retain the new value. No need to block-copy here: the block's
3176 // being passed up the stack.
3177 value = CGF.EmitARCRetainNonBlock(value);
3178
3179 // Emit the intrinsic use here.
3180 CGF.EmitARCIntrinsicUse(writeback.ToUse);
3181
3182 // Load the old value (primitively).
Nick Lewycky2d84e842013-10-02 02:29:49 +00003183 llvm::Value *oldValue = CGF.EmitLoadOfScalar(srcLV, SourceLocation());
John McCalleff18842013-03-23 02:35:54 +00003184
3185 // Put the new value in place (primitively).
3186 CGF.EmitStoreOfScalar(value, srcLV, /*init*/ false);
3187
3188 // Release the old value.
3189 CGF.EmitARCRelease(oldValue, srcLV.isARCPreciseLifetime());
3190
3191 // Otherwise, we can just do a normal lvalue store.
3192 } else {
3193 CGF.EmitStoreThroughLValue(RValue::get(value), srcLV);
3194 }
John McCall31168b02011-06-15 23:02:42 +00003195
3196 // Jump to the continuation block.
3197 if (!provablyNonNull)
3198 CGF.EmitBlock(contBB);
3199}
3200
3201static void emitWritebacks(CodeGenFunction &CGF,
3202 const CallArgList &args) {
Aaron Ballman36a7fa82014-03-17 17:22:27 +00003203 for (const auto &I : args.writebacks())
3204 emitWriteback(CGF, I);
John McCall31168b02011-06-15 23:02:42 +00003205}
3206
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003207static void deactivateArgCleanupsBeforeCall(CodeGenFunction &CGF,
3208 const CallArgList &CallArgs) {
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003209 ArrayRef<CallArgList::CallArgCleanup> Cleanups =
3210 CallArgs.getCleanupsToDeactivate();
3211 // Iterate in reverse to increase the likelihood of popping the cleanup.
Pete Cooper57d3f142015-07-30 17:22:52 +00003212 for (const auto &I : llvm::reverse(Cleanups)) {
3213 CGF.DeactivateCleanupBlock(I.Cleanup, I.IsActiveIP);
3214 I.IsActiveIP->eraseFromParent();
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003215 }
3216}
3217
John McCalleff18842013-03-23 02:35:54 +00003218static const Expr *maybeGetUnaryAddrOfOperand(const Expr *E) {
3219 if (const UnaryOperator *uop = dyn_cast<UnaryOperator>(E->IgnoreParens()))
3220 if (uop->getOpcode() == UO_AddrOf)
3221 return uop->getSubExpr();
Craig Topper8a13c412014-05-21 05:09:00 +00003222 return nullptr;
John McCalleff18842013-03-23 02:35:54 +00003223}
3224
John McCall31168b02011-06-15 23:02:42 +00003225/// Emit an argument that's being passed call-by-writeback. That is,
John McCall7f416cc2015-09-08 08:05:57 +00003226/// we are passing the address of an __autoreleased temporary; it
3227/// might be copy-initialized with the current value of the given
3228/// address, but it will definitely be copied out of after the call.
John McCall31168b02011-06-15 23:02:42 +00003229static void emitWritebackArg(CodeGenFunction &CGF, CallArgList &args,
3230 const ObjCIndirectCopyRestoreExpr *CRE) {
John McCalleff18842013-03-23 02:35:54 +00003231 LValue srcLV;
3232
3233 // Make an optimistic effort to emit the address as an l-value.
Eric Christopher2c4555a2015-06-19 01:52:53 +00003234 // This can fail if the argument expression is more complicated.
John McCalleff18842013-03-23 02:35:54 +00003235 if (const Expr *lvExpr = maybeGetUnaryAddrOfOperand(CRE->getSubExpr())) {
3236 srcLV = CGF.EmitLValue(lvExpr);
3237
3238 // Otherwise, just emit it as a scalar.
3239 } else {
John McCall7f416cc2015-09-08 08:05:57 +00003240 Address srcAddr = CGF.EmitPointerWithAlignment(CRE->getSubExpr());
John McCalleff18842013-03-23 02:35:54 +00003241
3242 QualType srcAddrType =
3243 CRE->getSubExpr()->getType()->castAs<PointerType>()->getPointeeType();
John McCall7f416cc2015-09-08 08:05:57 +00003244 srcLV = CGF.MakeAddrLValue(srcAddr, srcAddrType);
John McCalleff18842013-03-23 02:35:54 +00003245 }
John McCall7f416cc2015-09-08 08:05:57 +00003246 Address srcAddr = srcLV.getAddress();
John McCall31168b02011-06-15 23:02:42 +00003247
3248 // The dest and src types don't necessarily match in LLVM terms
3249 // because of the crazy ObjC compatibility rules.
3250
Chris Lattner2192fe52011-07-18 04:24:23 +00003251 llvm::PointerType *destType =
John McCall31168b02011-06-15 23:02:42 +00003252 cast<llvm::PointerType>(CGF.ConvertType(CRE->getType()));
3253
3254 // If the address is a constant null, just pass the appropriate null.
John McCall7f416cc2015-09-08 08:05:57 +00003255 if (isProvablyNull(srcAddr.getPointer())) {
John McCall31168b02011-06-15 23:02:42 +00003256 args.add(RValue::get(llvm::ConstantPointerNull::get(destType)),
3257 CRE->getType());
3258 return;
3259 }
3260
John McCall31168b02011-06-15 23:02:42 +00003261 // Create the temporary.
John McCall7f416cc2015-09-08 08:05:57 +00003262 Address temp = CGF.CreateTempAlloca(destType->getElementType(),
3263 CGF.getPointerAlign(),
3264 "icr.temp");
Fariborz Jahanianfbd19742012-11-27 23:02:53 +00003265 // Loading an l-value can introduce a cleanup if the l-value is __weak,
3266 // and that cleanup will be conditional if we can't prove that the l-value
3267 // isn't null, so we need to register a dominating point so that the cleanups
3268 // system will make valid IR.
3269 CodeGenFunction::ConditionalEvaluation condEval(CGF);
Fangrui Song6907ce22018-07-30 19:24:48 +00003270
John McCall31168b02011-06-15 23:02:42 +00003271 // Zero-initialize it if we're not doing a copy-initialization.
3272 bool shouldCopy = CRE->shouldCopy();
3273 if (!shouldCopy) {
3274 llvm::Value *null =
3275 llvm::ConstantPointerNull::get(
3276 cast<llvm::PointerType>(destType->getElementType()));
3277 CGF.Builder.CreateStore(null, temp);
3278 }
Craig Topper8a13c412014-05-21 05:09:00 +00003279
3280 llvm::BasicBlock *contBB = nullptr;
3281 llvm::BasicBlock *originBB = nullptr;
John McCall31168b02011-06-15 23:02:42 +00003282
3283 // If the address is *not* known to be non-null, we need to switch.
3284 llvm::Value *finalArgument;
3285
Nuno Lopes9211cee2017-09-09 18:25:36 +00003286 bool provablyNonNull = llvm::isKnownNonZero(srcAddr.getPointer(),
3287 CGF.CGM.getDataLayout());
John McCall31168b02011-06-15 23:02:42 +00003288 if (provablyNonNull) {
John McCall7f416cc2015-09-08 08:05:57 +00003289 finalArgument = temp.getPointer();
John McCall31168b02011-06-15 23:02:42 +00003290 } else {
John McCall7f416cc2015-09-08 08:05:57 +00003291 llvm::Value *isNull =
3292 CGF.Builder.CreateIsNull(srcAddr.getPointer(), "icr.isnull");
John McCall31168b02011-06-15 23:02:42 +00003293
Fangrui Song6907ce22018-07-30 19:24:48 +00003294 finalArgument = CGF.Builder.CreateSelect(isNull,
John McCall31168b02011-06-15 23:02:42 +00003295 llvm::ConstantPointerNull::get(destType),
John McCall7f416cc2015-09-08 08:05:57 +00003296 temp.getPointer(), "icr.argument");
John McCall31168b02011-06-15 23:02:42 +00003297
3298 // If we need to copy, then the load has to be conditional, which
3299 // means we need control flow.
3300 if (shouldCopy) {
John McCalleff18842013-03-23 02:35:54 +00003301 originBB = CGF.Builder.GetInsertBlock();
John McCall31168b02011-06-15 23:02:42 +00003302 contBB = CGF.createBasicBlock("icr.cont");
3303 llvm::BasicBlock *copyBB = CGF.createBasicBlock("icr.copy");
3304 CGF.Builder.CreateCondBr(isNull, contBB, copyBB);
3305 CGF.EmitBlock(copyBB);
Fariborz Jahanianfbd19742012-11-27 23:02:53 +00003306 condEval.begin(CGF);
John McCall31168b02011-06-15 23:02:42 +00003307 }
3308 }
3309
Craig Topper8a13c412014-05-21 05:09:00 +00003310 llvm::Value *valueToUse = nullptr;
John McCalleff18842013-03-23 02:35:54 +00003311
John McCall31168b02011-06-15 23:02:42 +00003312 // Perform a copy if necessary.
3313 if (shouldCopy) {
Nick Lewycky2d84e842013-10-02 02:29:49 +00003314 RValue srcRV = CGF.EmitLoadOfLValue(srcLV, SourceLocation());
John McCall31168b02011-06-15 23:02:42 +00003315 assert(srcRV.isScalar());
3316
3317 llvm::Value *src = srcRV.getScalarVal();
3318 src = CGF.Builder.CreateBitCast(src, destType->getElementType(),
3319 "icr.cast");
3320
3321 // Use an ordinary store, not a store-to-lvalue.
3322 CGF.Builder.CreateStore(src, temp);
John McCalleff18842013-03-23 02:35:54 +00003323
3324 // If optimization is enabled, and the value was held in a
3325 // __strong variable, we need to tell the optimizer that this
3326 // value has to stay alive until we're doing the store back.
3327 // This is because the temporary is effectively unretained,
3328 // and so otherwise we can violate the high-level semantics.
3329 if (CGF.CGM.getCodeGenOpts().OptimizationLevel != 0 &&
3330 srcLV.getObjCLifetime() == Qualifiers::OCL_Strong) {
3331 valueToUse = src;
3332 }
John McCall31168b02011-06-15 23:02:42 +00003333 }
Fangrui Song6907ce22018-07-30 19:24:48 +00003334
John McCall31168b02011-06-15 23:02:42 +00003335 // Finish the control flow if we needed it.
Fariborz Jahanianfbd19742012-11-27 23:02:53 +00003336 if (shouldCopy && !provablyNonNull) {
John McCalleff18842013-03-23 02:35:54 +00003337 llvm::BasicBlock *copyBB = CGF.Builder.GetInsertBlock();
John McCall31168b02011-06-15 23:02:42 +00003338 CGF.EmitBlock(contBB);
John McCalleff18842013-03-23 02:35:54 +00003339
3340 // Make a phi for the value to intrinsically use.
3341 if (valueToUse) {
3342 llvm::PHINode *phiToUse = CGF.Builder.CreatePHI(valueToUse->getType(), 2,
3343 "icr.to-use");
3344 phiToUse->addIncoming(valueToUse, copyBB);
3345 phiToUse->addIncoming(llvm::UndefValue::get(valueToUse->getType()),
3346 originBB);
3347 valueToUse = phiToUse;
3348 }
3349
Fariborz Jahanianfbd19742012-11-27 23:02:53 +00003350 condEval.end(CGF);
3351 }
John McCall31168b02011-06-15 23:02:42 +00003352
John McCalleff18842013-03-23 02:35:54 +00003353 args.addWriteback(srcLV, temp, valueToUse);
John McCall31168b02011-06-15 23:02:42 +00003354 args.add(RValue::get(finalArgument), CRE->getType());
3355}
3356
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003357void CallArgList::allocateArgumentMemory(CodeGenFunction &CGF) {
Richard Smith762672a2016-09-28 19:09:10 +00003358 assert(!StackBase);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003359
3360 // Save the stack.
3361 llvm::Function *F = CGF.CGM.getIntrinsic(llvm::Intrinsic::stacksave);
David Blaikie43f9bb72015-05-18 22:14:03 +00003362 StackBase = CGF.Builder.CreateCall(F, {}, "inalloca.save");
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003363}
3364
Nico Weber8cdb3f92015-08-25 18:43:32 +00003365void CallArgList::freeArgumentMemory(CodeGenFunction &CGF) const {
3366 if (StackBase) {
Reid Kleckner7c2f9e82015-10-08 00:17:45 +00003367 // Restore the stack after the call.
Nico Weber8cdb3f92015-08-25 18:43:32 +00003368 llvm::Value *F = CGF.CGM.getIntrinsic(llvm::Intrinsic::stackrestore);
Nico Weber8cdb3f92015-08-25 18:43:32 +00003369 CGF.Builder.CreateCall(F, StackBase);
3370 }
3371}
3372
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003373void CodeGenFunction::EmitNonNullArgCheck(RValue RV, QualType ArgType,
3374 SourceLocation ArgLoc,
Vedant Kumared00ea02017-03-06 05:28:22 +00003375 AbstractCallee AC,
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003376 unsigned ParmNum) {
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003377 if (!AC.getDecl() || !(SanOpts.has(SanitizerKind::NonnullAttribute) ||
3378 SanOpts.has(SanitizerKind::NullabilityArg)))
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003379 return;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003380
3381 // The param decl may be missing in a variadic function.
Vedant Kumared00ea02017-03-06 05:28:22 +00003382 auto PVD = ParmNum < AC.getNumParams() ? AC.getParamDecl(ParmNum) : nullptr;
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003383 unsigned ArgNo = PVD ? PVD->getFunctionScopeIndex() : ParmNum;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003384
Fangrui Song6907ce22018-07-30 19:24:48 +00003385 // Prefer the nonnull attribute if it's present.
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003386 const NonNullAttr *NNAttr = nullptr;
3387 if (SanOpts.has(SanitizerKind::NonnullAttribute))
3388 NNAttr = getNonNullAttr(AC.getDecl(), PVD, ArgType, ArgNo);
3389
3390 bool CanCheckNullability = false;
3391 if (SanOpts.has(SanitizerKind::NullabilityArg) && !NNAttr && PVD) {
3392 auto Nullability = PVD->getType()->getNullability(getContext());
3393 CanCheckNullability = Nullability &&
3394 *Nullability == NullabilityKind::NonNull &&
3395 PVD->getTypeSourceInfo();
3396 }
3397
3398 if (!NNAttr && !CanCheckNullability)
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003399 return;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003400
3401 SourceLocation AttrLoc;
3402 SanitizerMask CheckKind;
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00003403 SanitizerHandler Handler;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003404 if (NNAttr) {
3405 AttrLoc = NNAttr->getLocation();
3406 CheckKind = SanitizerKind::NonnullAttribute;
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00003407 Handler = SanitizerHandler::NonnullArg;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003408 } else {
3409 AttrLoc = PVD->getTypeSourceInfo()->getTypeLoc().findNullabilityLoc();
3410 CheckKind = SanitizerKind::NullabilityArg;
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00003411 Handler = SanitizerHandler::NullabilityArg;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003412 }
3413
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003414 SanitizerScope SanScope(this);
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003415 assert(RV.isScalar());
3416 llvm::Value *V = RV.getScalarVal();
3417 llvm::Value *Cond =
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003418 Builder.CreateICmpNE(V, llvm::Constant::getNullValue(V->getType()));
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003419 llvm::Constant *StaticData[] = {
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003420 EmitCheckSourceLocation(ArgLoc), EmitCheckSourceLocation(AttrLoc),
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003421 llvm::ConstantInt::get(Int32Ty, ArgNo + 1),
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003422 };
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00003423 EmitCheck(std::make_pair(Cond, CheckKind), Handler, StaticData, None);
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003424}
3425
David Blaikief05779e2015-07-21 18:37:18 +00003426void CodeGenFunction::EmitCallArgs(
3427 CallArgList &Args, ArrayRef<QualType> ArgTypes,
3428 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Vedant Kumared00ea02017-03-06 05:28:22 +00003429 AbstractCallee AC, unsigned ParamsToSkip, EvaluationOrder Order) {
David Blaikief05779e2015-07-21 18:37:18 +00003430 assert((int)ArgTypes.size() == (ArgRange.end() - ArgRange.begin()));
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003431
Reid Kleckner739756c2013-12-04 19:23:12 +00003432 // We *have* to evaluate arguments from right to left in the MS C++ ABI,
Richard Smitha560ccf2016-09-29 21:30:12 +00003433 // because arguments are destroyed left to right in the callee. As a special
3434 // case, there are certain language constructs that require left-to-right
3435 // evaluation, and in those cases we consider the evaluation order requirement
3436 // to trump the "destruction order is reverse construction order" guarantee.
3437 bool LeftToRight =
3438 CGM.getTarget().getCXXABI().areArgsDestroyedLeftToRightInCallee()
3439 ? Order == EvaluationOrder::ForceLeftToRight
3440 : Order != EvaluationOrder::ForceRightToLeft;
3441
George Burgess IV0d6592a2017-02-23 05:59:56 +00003442 auto MaybeEmitImplicitObjectSize = [&](unsigned I, const Expr *Arg,
3443 RValue EmittedArg) {
Vedant Kumared00ea02017-03-06 05:28:22 +00003444 if (!AC.hasFunctionDecl() || I >= AC.getNumParams())
George Burgess IV0d6592a2017-02-23 05:59:56 +00003445 return;
Vedant Kumared00ea02017-03-06 05:28:22 +00003446 auto *PS = AC.getParamDecl(I)->getAttr<PassObjectSizeAttr>();
George Burgess IV0d6592a2017-02-23 05:59:56 +00003447 if (PS == nullptr)
3448 return;
3449
3450 const auto &Context = getContext();
3451 auto SizeTy = Context.getSizeType();
3452 auto T = Builder.getIntNTy(Context.getTypeSize(SizeTy));
3453 assert(EmittedArg.getScalarVal() && "We emitted nothing for the arg?");
3454 llvm::Value *V = evaluateOrEmitBuiltinObjectSize(Arg, PS->getType(), T,
3455 EmittedArg.getScalarVal());
3456 Args.add(RValue::get(V), SizeTy);
3457 // If we're emitting args in reverse, be sure to do so with
3458 // pass_object_size, as well.
3459 if (!LeftToRight)
3460 std::swap(Args.back(), *(&Args.back() - 1));
3461 };
3462
Richard Smitha560ccf2016-09-29 21:30:12 +00003463 // Insert a stack save if we're going to need any inalloca args.
3464 bool HasInAllocaArgs = false;
3465 if (CGM.getTarget().getCXXABI().isMicrosoft()) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003466 for (ArrayRef<QualType>::iterator I = ArgTypes.begin(), E = ArgTypes.end();
3467 I != E && !HasInAllocaArgs; ++I)
3468 HasInAllocaArgs = isInAllocaArgument(CGM.getCXXABI(), *I);
3469 if (HasInAllocaArgs) {
3470 assert(getTarget().getTriple().getArch() == llvm::Triple::x86);
3471 Args.allocateArgumentMemory(*this);
3472 }
Richard Smitha560ccf2016-09-29 21:30:12 +00003473 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003474
Richard Smitha560ccf2016-09-29 21:30:12 +00003475 // Evaluate each argument in the appropriate order.
3476 size_t CallArgsStart = Args.size();
3477 for (unsigned I = 0, E = ArgTypes.size(); I != E; ++I) {
3478 unsigned Idx = LeftToRight ? I : E - I - 1;
3479 CallExpr::const_arg_iterator Arg = ArgRange.begin() + Idx;
George Burgess IV0d6592a2017-02-23 05:59:56 +00003480 unsigned InitialArgSize = Args.size();
Akira Hatanaka46dd7dbc2017-06-28 00:42:48 +00003481 // If *Arg is an ObjCIndirectCopyRestoreExpr, check that either the types of
3482 // the argument and parameter match or the objc method is parameterized.
3483 assert((!isa<ObjCIndirectCopyRestoreExpr>(*Arg) ||
3484 getContext().hasSameUnqualifiedType((*Arg)->getType(),
3485 ArgTypes[Idx]) ||
3486 (isa<ObjCMethodDecl>(AC.getDecl()) &&
3487 isObjCMethodWithTypeParams(cast<ObjCMethodDecl>(AC.getDecl())))) &&
3488 "Argument and parameter types don't match");
Richard Smitha560ccf2016-09-29 21:30:12 +00003489 EmitCallArg(Args, *Arg, ArgTypes[Idx]);
George Burgess IV0d6592a2017-02-23 05:59:56 +00003490 // In particular, we depend on it being the last arg in Args, and the
3491 // objectsize bits depend on there only being one arg if !LeftToRight.
3492 assert(InitialArgSize + 1 == Args.size() &&
3493 "The code below depends on only adding one arg per EmitCallArg");
3494 (void)InitialArgSize;
Yaxun Liu5b330e82018-03-15 15:25:19 +00003495 // Since pointer argument are never emitted as LValue, it is safe to emit
3496 // non-null argument check for r-value only.
3497 if (!Args.back().hasLValue()) {
3498 RValue RVArg = Args.back().getKnownRValue();
3499 EmitNonNullArgCheck(RVArg, ArgTypes[Idx], (*Arg)->getExprLoc(), AC,
3500 ParamsToSkip + Idx);
3501 // @llvm.objectsize should never have side-effects and shouldn't need
3502 // destruction/cleanups, so we can safely "emit" it after its arg,
3503 // regardless of right-to-leftness
3504 MaybeEmitImplicitObjectSize(Idx, *Arg, RVArg);
3505 }
Richard Smitha560ccf2016-09-29 21:30:12 +00003506 }
Reid Kleckner739756c2013-12-04 19:23:12 +00003507
Richard Smitha560ccf2016-09-29 21:30:12 +00003508 if (!LeftToRight) {
Reid Kleckner739756c2013-12-04 19:23:12 +00003509 // Un-reverse the arguments we just evaluated so they match up with the LLVM
3510 // IR function.
3511 std::reverse(Args.begin() + CallArgsStart, Args.end());
Reid Kleckner739756c2013-12-04 19:23:12 +00003512 }
3513}
3514
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003515namespace {
3516
David Blaikie7e70d682015-08-18 22:40:54 +00003517struct DestroyUnpassedArg final : EHScopeStack::Cleanup {
John McCall7f416cc2015-09-08 08:05:57 +00003518 DestroyUnpassedArg(Address Addr, QualType Ty)
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003519 : Addr(Addr), Ty(Ty) {}
3520
John McCall7f416cc2015-09-08 08:05:57 +00003521 Address Addr;
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003522 QualType Ty;
3523
Craig Topper4f12f102014-03-12 06:41:41 +00003524 void Emit(CodeGenFunction &CGF, Flags flags) override {
Akira Hatanaka7275da02018-02-28 07:15:55 +00003525 QualType::DestructionKind DtorKind = Ty.isDestructedType();
3526 if (DtorKind == QualType::DK_cxx_destructor) {
3527 const CXXDestructorDecl *Dtor = Ty->getAsCXXRecordDecl()->getDestructor();
3528 assert(!Dtor->isTrivial());
3529 CGF.EmitCXXDestructorCall(Dtor, Dtor_Complete, /*for vbase*/ false,
3530 /*Delegating=*/false, Addr);
3531 } else {
3532 CGF.callCStructDestructor(CGF.MakeAddrLValue(Addr, Ty));
3533 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003534 }
3535};
3536
David Blaikie38b25912015-02-09 19:13:51 +00003537struct DisableDebugLocationUpdates {
3538 CodeGenFunction &CGF;
3539 bool disabledDebugInfo;
3540 DisableDebugLocationUpdates(CodeGenFunction &CGF, const Expr *E) : CGF(CGF) {
3541 if ((disabledDebugInfo = isa<CXXDefaultArgExpr>(E) && CGF.getDebugInfo()))
3542 CGF.disableDebugInfo();
3543 }
3544 ~DisableDebugLocationUpdates() {
3545 if (disabledDebugInfo)
3546 CGF.enableDebugInfo();
3547 }
3548};
3549
Benjamin Kramer5b4296a2015-10-28 17:16:26 +00003550} // end anonymous namespace
3551
Yaxun Liu5b330e82018-03-15 15:25:19 +00003552RValue CallArg::getRValue(CodeGenFunction &CGF) const {
3553 if (!HasLV)
3554 return RV;
3555 LValue Copy = CGF.MakeAddrLValue(CGF.CreateMemTemp(Ty), Ty);
Richard Smithe78fac52018-04-05 20:52:58 +00003556 CGF.EmitAggregateCopy(Copy, LV, Ty, AggValueSlot::DoesNotOverlap,
3557 LV.isVolatile());
Yaxun Liu5b330e82018-03-15 15:25:19 +00003558 IsUsed = true;
3559 return RValue::getAggregate(Copy.getAddress());
3560}
3561
3562void CallArg::copyInto(CodeGenFunction &CGF, Address Addr) const {
3563 LValue Dst = CGF.MakeAddrLValue(Addr, Ty);
3564 if (!HasLV && RV.isScalar())
3565 CGF.EmitStoreOfScalar(RV.getScalarVal(), Dst, /*init=*/true);
3566 else if (!HasLV && RV.isComplex())
3567 CGF.EmitStoreOfComplex(RV.getComplexVal(), Dst, /*init=*/true);
3568 else {
3569 auto Addr = HasLV ? LV.getAddress() : RV.getAggregateAddress();
3570 LValue SrcLV = CGF.MakeAddrLValue(Addr, Ty);
Richard Smithe78fac52018-04-05 20:52:58 +00003571 // We assume that call args are never copied into subobjects.
3572 CGF.EmitAggregateCopy(Dst, SrcLV, Ty, AggValueSlot::DoesNotOverlap,
Yaxun Liu5b330e82018-03-15 15:25:19 +00003573 HasLV ? LV.isVolatileQualified()
3574 : RV.isVolatileQualified());
3575 }
3576 IsUsed = true;
3577}
3578
John McCall32ea9692011-03-11 20:59:21 +00003579void CodeGenFunction::EmitCallArg(CallArgList &args, const Expr *E,
3580 QualType type) {
David Blaikie38b25912015-02-09 19:13:51 +00003581 DisableDebugLocationUpdates Dis(*this, E);
John McCall31168b02011-06-15 23:02:42 +00003582 if (const ObjCIndirectCopyRestoreExpr *CRE
3583 = dyn_cast<ObjCIndirectCopyRestoreExpr>(E)) {
Richard Smith9c6890a2012-11-01 22:30:59 +00003584 assert(getLangOpts().ObjCAutoRefCount);
John McCall31168b02011-06-15 23:02:42 +00003585 return emitWritebackArg(*this, args, CRE);
3586 }
3587
John McCall0a76c0c2011-08-26 18:42:59 +00003588 assert(type->isReferenceType() == E->isGLValue() &&
3589 "reference binding to unmaterialized r-value!");
3590
John McCall17054bd62011-08-26 21:08:13 +00003591 if (E->isGLValue()) {
3592 assert(E->getObjectKind() == OK_Ordinary);
Richard Smitha1c9d4d2013-06-12 23:38:09 +00003593 return args.add(EmitReferenceBindingToExpr(E), type);
John McCall17054bd62011-08-26 21:08:13 +00003594 }
Mike Stump11289f42009-09-09 15:08:12 +00003595
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003596 bool HasAggregateEvalKind = hasAggregateEvaluationKind(type);
3597
3598 // In the Microsoft C++ ABI, aggregate arguments are destructed by the callee.
3599 // However, we still have to push an EH-only cleanup in case we unwind before
3600 // we make it to the call.
Akira Hatanaka85282972018-05-15 21:00:30 +00003601 if (HasAggregateEvalKind &&
3602 type->getAs<RecordType>()->getDecl()->isParamDestroyedInCallee()) {
Reid Klecknerac640602014-05-01 03:07:18 +00003603 // If we're using inalloca, use the argument memory. Otherwise, use a
Reid Klecknere39ee212014-05-03 00:33:28 +00003604 // temporary.
Reid Klecknerac640602014-05-01 03:07:18 +00003605 AggValueSlot Slot;
3606 if (args.isUsingInAlloca())
3607 Slot = createPlaceholderSlot(*this, type);
3608 else
3609 Slot = CreateAggTemp(type, "agg.tmp");
Reid Klecknere39ee212014-05-03 00:33:28 +00003610
Akira Hatanaka4ce0e5a2018-04-18 23:33:15 +00003611 bool DestroyedInCallee = true, NeedsEHCleanup = true;
3612 if (const auto *RD = type->getAsCXXRecordDecl())
3613 DestroyedInCallee = RD->hasNonTrivialDestructor();
3614 else
3615 NeedsEHCleanup = needsEHCleanup(type.isDestructedType());
3616
3617 if (DestroyedInCallee)
3618 Slot.setExternallyDestructed();
Reid Klecknere39ee212014-05-03 00:33:28 +00003619
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003620 EmitAggExpr(E, Slot);
3621 RValue RV = Slot.asRValue();
3622 args.add(RV, type);
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003623
Akira Hatanaka4ce0e5a2018-04-18 23:33:15 +00003624 if (DestroyedInCallee && NeedsEHCleanup) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003625 // Create a no-op GEP between the placeholder and the cleanup so we can
3626 // RAUW it successfully. It also serves as a marker of the first
3627 // instruction where the cleanup is active.
John McCall7f416cc2015-09-08 08:05:57 +00003628 pushFullExprCleanup<DestroyUnpassedArg>(EHCleanup, Slot.getAddress(),
3629 type);
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003630 // This unreachable is a temporary marker which will be removed later.
3631 llvm::Instruction *IsActive = Builder.CreateUnreachable();
3632 args.addArgCleanupDeactivation(EHStack.getInnermostEHScope(), IsActive);
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003633 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003634 return;
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003635 }
3636
3637 if (HasAggregateEvalKind && isa<ImplicitCastExpr>(E) &&
Eli Friedmandf968192011-05-26 00:10:27 +00003638 cast<CastExpr>(E)->getCastKind() == CK_LValueToRValue) {
3639 LValue L = EmitLValue(cast<CastExpr>(E)->getSubExpr());
3640 assert(L.isSimple());
Yaxun Liu5b330e82018-03-15 15:25:19 +00003641 args.addUncopiedAggregate(L, type);
Eli Friedmandf968192011-05-26 00:10:27 +00003642 return;
3643 }
3644
John McCall32ea9692011-03-11 20:59:21 +00003645 args.add(EmitAnyExprToTemp(E), type);
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00003646}
3647
Reid Kleckner79b0fd72014-10-10 00:05:45 +00003648QualType CodeGenFunction::getVarArgType(const Expr *Arg) {
3649 // System headers on Windows define NULL to 0 instead of 0LL on Win64. MSVC
3650 // implicitly widens null pointer constants that are arguments to varargs
3651 // functions to pointer-sized ints.
3652 if (!getTarget().getTriple().isOSWindows())
3653 return Arg->getType();
3654
3655 if (Arg->getType()->isIntegerType() &&
3656 getContext().getTypeSize(Arg->getType()) <
3657 getContext().getTargetInfo().getPointerWidth(0) &&
3658 Arg->isNullPointerConstant(getContext(),
3659 Expr::NPC_ValueDependentIsNotNull)) {
3660 return getContext().getIntPtrType();
3661 }
3662
3663 return Arg->getType();
3664}
3665
Dan Gohman515a60d2012-02-16 00:57:37 +00003666// In ObjC ARC mode with no ObjC ARC exception safety, tell the ARC
3667// optimizer it can aggressively ignore unwind edges.
3668void
3669CodeGenFunction::AddObjCARCExceptionMetadata(llvm::Instruction *Inst) {
3670 if (CGM.getCodeGenOpts().OptimizationLevel != 0 &&
3671 !CGM.getCodeGenOpts().ObjCAutoRefCountExceptions)
3672 Inst->setMetadata("clang.arc.no_objc_arc_exceptions",
3673 CGM.getNoObjCARCExceptionsMetadata());
3674}
3675
John McCall882987f2013-02-28 19:01:20 +00003676/// Emits a call to the given no-arguments nounwind runtime function.
3677llvm::CallInst *
3678CodeGenFunction::EmitNounwindRuntimeCall(llvm::Value *callee,
3679 const llvm::Twine &name) {
Craig Topper5fc8fc22014-08-27 06:28:36 +00003680 return EmitNounwindRuntimeCall(callee, None, name);
John McCall882987f2013-02-28 19:01:20 +00003681}
3682
3683/// Emits a call to the given nounwind runtime function.
3684llvm::CallInst *
3685CodeGenFunction::EmitNounwindRuntimeCall(llvm::Value *callee,
3686 ArrayRef<llvm::Value*> args,
3687 const llvm::Twine &name) {
3688 llvm::CallInst *call = EmitRuntimeCall(callee, args, name);
3689 call->setDoesNotThrow();
3690 return call;
3691}
3692
3693/// Emits a simple call (never an invoke) to the given no-arguments
3694/// runtime function.
3695llvm::CallInst *
3696CodeGenFunction::EmitRuntimeCall(llvm::Value *callee,
3697 const llvm::Twine &name) {
Craig Topper5fc8fc22014-08-27 06:28:36 +00003698 return EmitRuntimeCall(callee, None, name);
John McCall882987f2013-02-28 19:01:20 +00003699}
3700
David Majnemer0b17d442015-12-15 21:27:59 +00003701// Calls which may throw must have operand bundles indicating which funclet
3702// they are nested within.
Reid Klecknerb75a3f02018-02-09 00:16:41 +00003703SmallVector<llvm::OperandBundleDef, 1>
3704CodeGenFunction::getBundlesForFunclet(llvm::Value *Callee) {
3705 SmallVector<llvm::OperandBundleDef, 1> BundleList;
Sanjay Patel846b63b2016-01-18 22:15:33 +00003706 // There is no need for a funclet operand bundle if we aren't inside a
3707 // funclet.
David Majnemer0b17d442015-12-15 21:27:59 +00003708 if (!CurrentFuncletPad)
Reid Klecknerb75a3f02018-02-09 00:16:41 +00003709 return BundleList;
David Majnemer0b17d442015-12-15 21:27:59 +00003710
3711 // Skip intrinsics which cannot throw.
3712 auto *CalleeFn = dyn_cast<llvm::Function>(Callee->stripPointerCasts());
3713 if (CalleeFn && CalleeFn->isIntrinsic() && CalleeFn->doesNotThrow())
Reid Klecknerb75a3f02018-02-09 00:16:41 +00003714 return BundleList;
David Majnemer0b17d442015-12-15 21:27:59 +00003715
3716 BundleList.emplace_back("funclet", CurrentFuncletPad);
Reid Klecknerb75a3f02018-02-09 00:16:41 +00003717 return BundleList;
David Majnemer0b17d442015-12-15 21:27:59 +00003718}
3719
David Majnemer971d31b2016-02-24 17:02:45 +00003720/// Emits a simple call (never an invoke) to the given runtime function.
3721llvm::CallInst *
3722CodeGenFunction::EmitRuntimeCall(llvm::Value *callee,
3723 ArrayRef<llvm::Value*> args,
3724 const llvm::Twine &name) {
Reid Klecknerb75a3f02018-02-09 00:16:41 +00003725 llvm::CallInst *call =
3726 Builder.CreateCall(callee, args, getBundlesForFunclet(callee), name);
David Majnemer971d31b2016-02-24 17:02:45 +00003727 call->setCallingConv(getRuntimeCC());
3728 return call;
3729}
3730
John McCall882987f2013-02-28 19:01:20 +00003731/// Emits a call or invoke to the given noreturn runtime function.
3732void CodeGenFunction::EmitNoreturnRuntimeCallOrInvoke(llvm::Value *callee,
3733 ArrayRef<llvm::Value*> args) {
Reid Klecknerb75a3f02018-02-09 00:16:41 +00003734 SmallVector<llvm::OperandBundleDef, 1> BundleList =
3735 getBundlesForFunclet(callee);
David Majnemer0b17d442015-12-15 21:27:59 +00003736
John McCall882987f2013-02-28 19:01:20 +00003737 if (getInvokeDest()) {
Fangrui Song6907ce22018-07-30 19:24:48 +00003738 llvm::InvokeInst *invoke =
John McCall882987f2013-02-28 19:01:20 +00003739 Builder.CreateInvoke(callee,
3740 getUnreachableBlock(),
3741 getInvokeDest(),
David Majnemer0b17d442015-12-15 21:27:59 +00003742 args,
3743 BundleList);
John McCall882987f2013-02-28 19:01:20 +00003744 invoke->setDoesNotReturn();
3745 invoke->setCallingConv(getRuntimeCC());
3746 } else {
David Majnemer0b17d442015-12-15 21:27:59 +00003747 llvm::CallInst *call = Builder.CreateCall(callee, args, BundleList);
John McCall882987f2013-02-28 19:01:20 +00003748 call->setDoesNotReturn();
3749 call->setCallingConv(getRuntimeCC());
3750 Builder.CreateUnreachable();
3751 }
3752}
3753
Sanjay Patel846b63b2016-01-18 22:15:33 +00003754/// Emits a call or invoke instruction to the given nullary runtime function.
John McCall882987f2013-02-28 19:01:20 +00003755llvm::CallSite
3756CodeGenFunction::EmitRuntimeCallOrInvoke(llvm::Value *callee,
3757 const Twine &name) {
Craig Topper5fc8fc22014-08-27 06:28:36 +00003758 return EmitRuntimeCallOrInvoke(callee, None, name);
John McCall882987f2013-02-28 19:01:20 +00003759}
3760
3761/// Emits a call or invoke instruction to the given runtime function.
3762llvm::CallSite
3763CodeGenFunction::EmitRuntimeCallOrInvoke(llvm::Value *callee,
3764 ArrayRef<llvm::Value*> args,
3765 const Twine &name) {
3766 llvm::CallSite callSite = EmitCallOrInvoke(callee, args, name);
3767 callSite.setCallingConv(getRuntimeCC());
3768 return callSite;
3769}
3770
John McCallbd309292010-07-06 01:34:17 +00003771/// Emits a call or invoke instruction to the given function, depending
3772/// on the current state of the EH stack.
3773llvm::CallSite
3774CodeGenFunction::EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner54b16772011-07-23 17:14:25 +00003775 ArrayRef<llvm::Value *> Args,
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003776 const Twine &Name) {
John McCallbd309292010-07-06 01:34:17 +00003777 llvm::BasicBlock *InvokeDest = getInvokeDest();
Reid Klecknerb75a3f02018-02-09 00:16:41 +00003778 SmallVector<llvm::OperandBundleDef, 1> BundleList =
3779 getBundlesForFunclet(Callee);
John McCallbd309292010-07-06 01:34:17 +00003780
Dan Gohman515a60d2012-02-16 00:57:37 +00003781 llvm::Instruction *Inst;
3782 if (!InvokeDest)
David Majnemer3df77bc2016-01-26 23:14:47 +00003783 Inst = Builder.CreateCall(Callee, Args, BundleList, Name);
Dan Gohman515a60d2012-02-16 00:57:37 +00003784 else {
3785 llvm::BasicBlock *ContBB = createBasicBlock("invoke.cont");
David Majnemer3df77bc2016-01-26 23:14:47 +00003786 Inst = Builder.CreateInvoke(Callee, ContBB, InvokeDest, Args, BundleList,
3787 Name);
Dan Gohman515a60d2012-02-16 00:57:37 +00003788 EmitBlock(ContBB);
3789 }
3790
3791 // In ObjC ARC mode with no ObjC ARC exception safety, tell the ARC
3792 // optimizer it can aggressively ignore unwind edges.
David Blaikiebbafb8a2012-03-11 07:00:24 +00003793 if (CGM.getLangOpts().ObjCAutoRefCount)
Dan Gohman515a60d2012-02-16 00:57:37 +00003794 AddObjCARCExceptionMetadata(Inst);
3795
Benjamin Kramerc19cde12015-04-10 14:49:31 +00003796 return llvm::CallSite(Inst);
John McCallbd309292010-07-06 01:34:17 +00003797}
3798
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003799void CodeGenFunction::deferPlaceholderReplacement(llvm::Instruction *Old,
3800 llvm::Value *New) {
3801 DeferredReplacements.push_back(std::make_pair(Old, New));
3802}
Chris Lattnerd59d8672011-07-12 06:29:11 +00003803
Daniel Dunbard931a872009-02-02 22:03:45 +00003804RValue CodeGenFunction::EmitCall(const CGFunctionInfo &CallInfo,
John McCallb92ab1a2016-10-26 23:46:34 +00003805 const CGCallee &Callee,
Anders Carlsson61a401c2009-12-24 19:25:24 +00003806 ReturnValueSlot ReturnValue,
Daniel Dunbarcdbb5e32009-02-20 18:06:48 +00003807 const CallArgList &CallArgs,
Vedant Kumar09b5bfd2017-12-21 00:10:25 +00003808 llvm::Instruction **callOrInvoke,
3809 SourceLocation Loc) {
Mike Stump18bb9282009-05-16 07:57:57 +00003810 // FIXME: We no longer need the types from CallArgs; lift up and simplify.
Daniel Dunbar613855c2008-09-09 23:27:19 +00003811
Peter Collingbourneea211002018-02-05 23:09:13 +00003812 assert(Callee.isOrdinary() || Callee.isVirtual());
John McCallb92ab1a2016-10-26 23:46:34 +00003813
Daniel Dunbar613855c2008-09-09 23:27:19 +00003814 // Handle struct-return functions by passing a pointer to the
3815 // location that we would like to return into.
Daniel Dunbar7633cbf2009-02-02 21:43:58 +00003816 QualType RetTy = CallInfo.getReturnType();
Daniel Dunbarb52d0772009-02-03 05:59:18 +00003817 const ABIArgInfo &RetAI = CallInfo.getReturnInfo();
Mike Stump11289f42009-09-09 15:08:12 +00003818
John McCallb92ab1a2016-10-26 23:46:34 +00003819 llvm::FunctionType *IRFuncTy = Callee.getFunctionType();
3820
3821 // 1. Set up the arguments.
Mike Stump11289f42009-09-09 15:08:12 +00003822
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003823 // If we're using inalloca, insert the allocation after the stack save.
3824 // FIXME: Do this earlier rather than hacking it in here!
John McCall7f416cc2015-09-08 08:05:57 +00003825 Address ArgMemory = Address::invalid();
3826 const llvm::StructLayout *ArgMemoryLayout = nullptr;
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003827 if (llvm::StructType *ArgStruct = CallInfo.getArgStruct()) {
Matt Arsenault502ad602017-04-10 22:28:02 +00003828 const llvm::DataLayout &DL = CGM.getDataLayout();
3829 ArgMemoryLayout = DL.getStructLayout(ArgStruct);
Reid Kleckner9df1d972014-04-10 01:40:15 +00003830 llvm::Instruction *IP = CallArgs.getStackBase();
3831 llvm::AllocaInst *AI;
3832 if (IP) {
3833 IP = IP->getNextNode();
Matt Arsenault502ad602017-04-10 22:28:02 +00003834 AI = new llvm::AllocaInst(ArgStruct, DL.getAllocaAddrSpace(),
3835 "argmem", IP);
Reid Kleckner9df1d972014-04-10 01:40:15 +00003836 } else {
Reid Kleckner966abe72014-05-15 23:01:46 +00003837 AI = CreateTempAlloca(ArgStruct, "argmem");
Reid Kleckner9df1d972014-04-10 01:40:15 +00003838 }
John McCall7f416cc2015-09-08 08:05:57 +00003839 auto Align = CallInfo.getArgStructAlignment();
3840 AI->setAlignment(Align.getQuantity());
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003841 AI->setUsedWithInAlloca(true);
3842 assert(AI->isUsedWithInAlloca() && !AI->isStaticAlloca());
John McCall7f416cc2015-09-08 08:05:57 +00003843 ArgMemory = Address(AI, Align);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003844 }
3845
John McCall7f416cc2015-09-08 08:05:57 +00003846 // Helper function to drill into the inalloca allocation.
3847 auto createInAllocaStructGEP = [&](unsigned FieldIndex) -> Address {
3848 auto FieldOffset =
3849 CharUnits::fromQuantity(ArgMemoryLayout->getElementOffset(FieldIndex));
3850 return Builder.CreateStructGEP(ArgMemory, FieldIndex, FieldOffset);
3851 };
3852
Alexey Samsonov153004f2014-09-29 22:08:00 +00003853 ClangToLLVMArgMapping IRFunctionArgs(CGM.getContext(), CallInfo);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003854 SmallVector<llvm::Value *, 16> IRCallArgs(IRFunctionArgs.totalIRArgs());
3855
Chris Lattner4ca97c32009-06-13 00:26:38 +00003856 // If the call returns a temporary with struct return, create a temporary
Anders Carlsson17490832009-12-24 20:40:36 +00003857 // alloca to hold the result, unless one is given to us.
John McCall7f416cc2015-09-08 08:05:57 +00003858 Address SRetPtr = Address::invalid();
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00003859 Address SRetAlloca = Address::invalid();
George Burgess IV003be7c2018-03-08 05:32:30 +00003860 llvm::Value *UnusedReturnSizePtr = nullptr;
John McCallf26e73d2016-03-11 04:30:43 +00003861 if (RetAI.isIndirect() || RetAI.isInAlloca() || RetAI.isCoerceAndExpand()) {
John McCall7f416cc2015-09-08 08:05:57 +00003862 if (!ReturnValue.isNull()) {
3863 SRetPtr = ReturnValue.getValue();
3864 } else {
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00003865 SRetPtr = CreateMemTemp(RetTy, "tmp", &SRetAlloca);
Leny Kholodov6aab1112015-06-08 10:23:49 +00003866 if (HaveInsertPoint() && ReturnValue.isUnused()) {
3867 uint64_t size =
3868 CGM.getDataLayout().getTypeAllocSize(ConvertTypeForMem(RetTy));
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00003869 UnusedReturnSizePtr = EmitLifetimeStart(size, SRetAlloca.getPointer());
Leny Kholodov6aab1112015-06-08 10:23:49 +00003870 }
3871 }
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003872 if (IRFunctionArgs.hasSRetArg()) {
John McCall7f416cc2015-09-08 08:05:57 +00003873 IRCallArgs[IRFunctionArgs.getSRetArgNo()] = SRetPtr.getPointer();
John McCallf26e73d2016-03-11 04:30:43 +00003874 } else if (RetAI.isInAlloca()) {
John McCall7f416cc2015-09-08 08:05:57 +00003875 Address Addr = createInAllocaStructGEP(RetAI.getInAllocaFieldIndex());
3876 Builder.CreateStore(SRetPtr.getPointer(), Addr);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003877 }
Anders Carlsson17490832009-12-24 20:40:36 +00003878 }
Mike Stump11289f42009-09-09 15:08:12 +00003879
John McCall12f23522016-04-04 18:33:08 +00003880 Address swiftErrorTemp = Address::invalid();
3881 Address swiftErrorArg = Address::invalid();
3882
John McCallb92ab1a2016-10-26 23:46:34 +00003883 // Translate all of the arguments as necessary to match the IR lowering.
Daniel Dunbara45bdbb2009-02-04 21:17:21 +00003884 assert(CallInfo.arg_size() == CallArgs.size() &&
3885 "Mismatch between function signature & arguments.");
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003886 unsigned ArgNo = 0;
Daniel Dunbarb52d0772009-02-03 05:59:18 +00003887 CGFunctionInfo::const_arg_iterator info_it = CallInfo.arg_begin();
Mike Stump11289f42009-09-09 15:08:12 +00003888 for (CallArgList::const_iterator I = CallArgs.begin(), E = CallArgs.end();
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003889 I != E; ++I, ++info_it, ++ArgNo) {
Daniel Dunbarb52d0772009-02-03 05:59:18 +00003890 const ABIArgInfo &ArgInfo = info_it->info;
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00003891
Rafael Espindolafad28de2012-10-24 01:59:00 +00003892 // Insert a padding argument to ensure proper alignment.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003893 if (IRFunctionArgs.hasPaddingArg(ArgNo))
3894 IRCallArgs[IRFunctionArgs.getPaddingArgNo(ArgNo)] =
3895 llvm::UndefValue::get(ArgInfo.getPaddingType());
3896
3897 unsigned FirstIRArg, NumIRArgs;
3898 std::tie(FirstIRArg, NumIRArgs) = IRFunctionArgs.getIRArgs(ArgNo);
Rafael Espindolafad28de2012-10-24 01:59:00 +00003899
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00003900 switch (ArgInfo.getKind()) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003901 case ABIArgInfo::InAlloca: {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003902 assert(NumIRArgs == 0);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003903 assert(getTarget().getTriple().getArch() == llvm::Triple::x86);
Yaxun Liu5b330e82018-03-15 15:25:19 +00003904 if (I->isAggregate()) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003905 // Replace the placeholder with the appropriate argument slot GEP.
Yaxun Liu5b330e82018-03-15 15:25:19 +00003906 Address Addr = I->hasLValue()
3907 ? I->getKnownLValue().getAddress()
3908 : I->getKnownRValue().getAggregateAddress();
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003909 llvm::Instruction *Placeholder =
Yaxun Liu5b330e82018-03-15 15:25:19 +00003910 cast<llvm::Instruction>(Addr.getPointer());
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003911 CGBuilderTy::InsertPoint IP = Builder.saveIP();
3912 Builder.SetInsertPoint(Placeholder);
Yaxun Liu5b330e82018-03-15 15:25:19 +00003913 Addr = createInAllocaStructGEP(ArgInfo.getInAllocaFieldIndex());
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003914 Builder.restoreIP(IP);
John McCall7f416cc2015-09-08 08:05:57 +00003915 deferPlaceholderReplacement(Placeholder, Addr.getPointer());
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003916 } else {
3917 // Store the RValue into the argument struct.
John McCall7f416cc2015-09-08 08:05:57 +00003918 Address Addr = createInAllocaStructGEP(ArgInfo.getInAllocaFieldIndex());
3919 unsigned AS = Addr.getType()->getPointerAddressSpace();
David Majnemer32b57b02014-03-31 16:12:47 +00003920 llvm::Type *MemType = ConvertTypeForMem(I->Ty)->getPointerTo(AS);
3921 // There are some cases where a trivial bitcast is not avoidable. The
3922 // definition of a type later in a translation unit may change it's type
3923 // from {}* to (%struct.foo*)*.
John McCall7f416cc2015-09-08 08:05:57 +00003924 if (Addr.getType() != MemType)
David Majnemer32b57b02014-03-31 16:12:47 +00003925 Addr = Builder.CreateBitCast(Addr, MemType);
Yaxun Liu5b330e82018-03-15 15:25:19 +00003926 I->copyInto(*this, Addr);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003927 }
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003928 break;
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003929 }
3930
Daniel Dunbar03816342010-08-21 02:24:36 +00003931 case ABIArgInfo::Indirect: {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003932 assert(NumIRArgs == 1);
Yaxun Liu5b330e82018-03-15 15:25:19 +00003933 if (!I->isAggregate()) {
Daniel Dunbar747865a2009-02-05 09:16:39 +00003934 // Make a temporary alloca to pass the argument.
Yaxun Liuaefdb8e2018-06-15 15:33:22 +00003935 Address Addr = CreateMemTempWithoutCast(
3936 I->Ty, ArgInfo.getIndirectAlign(), "indirect-arg-temp");
John McCall7f416cc2015-09-08 08:05:57 +00003937 IRCallArgs[FirstIRArg] = Addr.getPointer();
John McCall47fb9502013-03-07 21:37:08 +00003938
Yaxun Liu5b330e82018-03-15 15:25:19 +00003939 I->copyInto(*this, Addr);
Daniel Dunbar747865a2009-02-05 09:16:39 +00003940 } else {
Eli Friedmaneb7fab62011-06-14 01:37:52 +00003941 // We want to avoid creating an unnecessary temporary+copy here;
Guy Benyei3832bfd2013-03-10 12:59:00 +00003942 // however, we need one in three cases:
Eli Friedmaneb7fab62011-06-14 01:37:52 +00003943 // 1. If the argument is not byval, and we are required to copy the
3944 // source. (This case doesn't occur on any common architecture.)
3945 // 2. If the argument is byval, RV is not sufficiently aligned, and
3946 // we cannot force it to be sufficiently aligned.
Yaxun Liu5b330e82018-03-15 15:25:19 +00003947 // 3. If the argument is byval, but RV is not located in default
3948 // or alloca address space.
3949 Address Addr = I->hasLValue()
3950 ? I->getKnownLValue().getAddress()
3951 : I->getKnownRValue().getAggregateAddress();
3952 llvm::Value *V = Addr.getPointer();
John McCall7f416cc2015-09-08 08:05:57 +00003953 CharUnits Align = ArgInfo.getIndirectAlign();
Micah Villmowdd31ca12012-10-08 16:25:52 +00003954 const llvm::DataLayout *TD = &CGM.getDataLayout();
Yaxun Liu5b330e82018-03-15 15:25:19 +00003955
3956 assert((FirstIRArg >= IRFuncTy->getNumParams() ||
3957 IRFuncTy->getParamType(FirstIRArg)->getPointerAddressSpace() ==
3958 TD->getAllocaAddrSpace()) &&
3959 "indirect argument must be in alloca address space");
3960
3961 bool NeedCopy = false;
3962
3963 if (Addr.getAlignment() < Align &&
3964 llvm::getOrEnforceKnownAlignment(V, Align.getQuantity(), *TD) <
3965 Align.getQuantity()) {
3966 NeedCopy = true;
3967 } else if (I->hasLValue()) {
3968 auto LV = I->getKnownLValue();
3969 auto AS = LV.getAddressSpace();
Andrew Savonichev1bf1a152018-12-10 12:03:00 +00003970
Yaxun Liu5b330e82018-03-15 15:25:19 +00003971 if ((!ArgInfo.getIndirectByVal() &&
3972 (LV.getAlignment() >=
Andrew Savonichev1bf1a152018-12-10 12:03:00 +00003973 getContext().getTypeAlignInChars(I->Ty)))) {
3974 NeedCopy = true;
3975 }
3976 if (!getLangOpts().OpenCL) {
3977 if ((ArgInfo.getIndirectByVal() &&
3978 (AS != LangAS::Default &&
3979 AS != CGM.getASTAllocaAddressSpace()))) {
3980 NeedCopy = true;
3981 }
3982 }
3983 // For OpenCL even if RV is located in default or alloca address space
3984 // we don't want to perform address space cast for it.
3985 else if ((ArgInfo.getIndirectByVal() &&
3986 Addr.getType()->getAddressSpace() != IRFuncTy->
3987 getParamType(FirstIRArg)->getPointerAddressSpace())) {
Yaxun Liu5b330e82018-03-15 15:25:19 +00003988 NeedCopy = true;
3989 }
3990 }
Andrew Savonichev1bf1a152018-12-10 12:03:00 +00003991
Yaxun Liu5b330e82018-03-15 15:25:19 +00003992 if (NeedCopy) {
Eli Friedmaneb7fab62011-06-14 01:37:52 +00003993 // Create an aligned temporary, and copy to it.
Yaxun Liuaefdb8e2018-06-15 15:33:22 +00003994 Address AI = CreateMemTempWithoutCast(
3995 I->Ty, ArgInfo.getIndirectAlign(), "byval-temp");
John McCall7f416cc2015-09-08 08:05:57 +00003996 IRCallArgs[FirstIRArg] = AI.getPointer();
Yaxun Liu5b330e82018-03-15 15:25:19 +00003997 I->copyInto(*this, AI);
Eli Friedmaneb7fab62011-06-14 01:37:52 +00003998 } else {
3999 // Skip the extra memcpy call.
Yaxun Liu5b330e82018-03-15 15:25:19 +00004000 auto *T = V->getType()->getPointerElementType()->getPointerTo(
4001 CGM.getDataLayout().getAllocaAddrSpace());
4002 IRCallArgs[FirstIRArg] = getTargetHooks().performAddrSpaceCast(
4003 *this, V, LangAS::Default, CGM.getASTAllocaAddressSpace(), T,
4004 true);
Eli Friedmaneb7fab62011-06-14 01:37:52 +00004005 }
Daniel Dunbar747865a2009-02-05 09:16:39 +00004006 }
4007 break;
Daniel Dunbar03816342010-08-21 02:24:36 +00004008 }
Daniel Dunbar747865a2009-02-05 09:16:39 +00004009
Daniel Dunbar94a6f252009-01-26 21:26:08 +00004010 case ABIArgInfo::Ignore:
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004011 assert(NumIRArgs == 0);
Daniel Dunbar94a6f252009-01-26 21:26:08 +00004012 break;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004013
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00004014 case ABIArgInfo::Extend:
4015 case ABIArgInfo::Direct: {
4016 if (!isa<llvm::StructType>(ArgInfo.getCoerceToType()) &&
Chris Lattner8a2f3c72010-07-30 04:02:24 +00004017 ArgInfo.getCoerceToType() == ConvertType(info_it->type) &&
4018 ArgInfo.getDirectOffset() == 0) {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004019 assert(NumIRArgs == 1);
Chris Lattnerbb1952c2011-07-12 04:46:18 +00004020 llvm::Value *V;
Yaxun Liu5b330e82018-03-15 15:25:19 +00004021 if (!I->isAggregate())
4022 V = I->getKnownRValue().getScalarVal();
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00004023 else
Yaxun Liu5b330e82018-03-15 15:25:19 +00004024 V = Builder.CreateLoad(
4025 I->hasLValue() ? I->getKnownLValue().getAddress()
4026 : I->getKnownRValue().getAggregateAddress());
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004027
John McCall12f23522016-04-04 18:33:08 +00004028 // Implement swifterror by copying into a new swifterror argument.
4029 // We'll write back in the normal path out of the call.
4030 if (CallInfo.getExtParameterInfo(ArgNo).getABI()
4031 == ParameterABI::SwiftErrorResult) {
4032 assert(!swiftErrorTemp.isValid() && "multiple swifterror args");
4033
4034 QualType pointeeTy = I->Ty->getPointeeType();
4035 swiftErrorArg =
4036 Address(V, getContext().getTypeAlignInChars(pointeeTy));
4037
4038 swiftErrorTemp =
4039 CreateMemTemp(pointeeTy, getPointerAlign(), "swifterror.temp");
4040 V = swiftErrorTemp.getPointer();
4041 cast<llvm::AllocaInst>(V)->setSwiftError(true);
4042
4043 llvm::Value *errorValue = Builder.CreateLoad(swiftErrorArg);
4044 Builder.CreateStore(errorValue, swiftErrorTemp);
4045 }
4046
Reid Kleckner79b0fd72014-10-10 00:05:45 +00004047 // We might have to widen integers, but we should never truncate.
4048 if (ArgInfo.getCoerceToType() != V->getType() &&
4049 V->getType()->isIntegerTy())
4050 V = Builder.CreateZExt(V, ArgInfo.getCoerceToType());
4051
Chris Lattner3ce86682011-07-12 04:53:39 +00004052 // If the argument doesn't match, perform a bitcast to coerce it. This
4053 // can happen due to trivial type mismatches.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004054 if (FirstIRArg < IRFuncTy->getNumParams() &&
4055 V->getType() != IRFuncTy->getParamType(FirstIRArg))
4056 V = Builder.CreateBitCast(V, IRFuncTy->getParamType(FirstIRArg));
John McCall12f23522016-04-04 18:33:08 +00004057
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004058 IRCallArgs[FirstIRArg] = V;
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00004059 break;
4060 }
Daniel Dunbar94a6f252009-01-26 21:26:08 +00004061
Daniel Dunbar2f219b02009-02-03 19:12:28 +00004062 // FIXME: Avoid the conversion through memory if possible.
John McCall7f416cc2015-09-08 08:05:57 +00004063 Address Src = Address::invalid();
Yaxun Liu5b330e82018-03-15 15:25:19 +00004064 if (!I->isAggregate()) {
John McCall7f416cc2015-09-08 08:05:57 +00004065 Src = CreateMemTemp(I->Ty, "coerce");
Yaxun Liu5b330e82018-03-15 15:25:19 +00004066 I->copyInto(*this, Src);
Ulrich Weigand6e2cea62015-07-10 11:31:43 +00004067 } else {
Yaxun Liu5b330e82018-03-15 15:25:19 +00004068 Src = I->hasLValue() ? I->getKnownLValue().getAddress()
4069 : I->getKnownRValue().getAggregateAddress();
Ulrich Weigand6e2cea62015-07-10 11:31:43 +00004070 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004071
Chris Lattner8a2f3c72010-07-30 04:02:24 +00004072 // If the value is offset in memory, apply the offset now.
John McCall7f416cc2015-09-08 08:05:57 +00004073 Src = emitAddressAtOffset(*this, Src, ArgInfo);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004074
Oliver Stannard2bfdc5b2014-08-27 10:43:15 +00004075 // Fast-isel and the optimizer generally like scalar values better than
4076 // FCAs, so we flatten them if this is safe to do for this argument.
James Molloy6f244b62014-05-09 16:21:39 +00004077 llvm::StructType *STy =
4078 dyn_cast<llvm::StructType>(ArgInfo.getCoerceToType());
Oliver Stannard2bfdc5b2014-08-27 10:43:15 +00004079 if (STy && ArgInfo.isDirect() && ArgInfo.getCanBeFlattened()) {
John McCall7f416cc2015-09-08 08:05:57 +00004080 llvm::Type *SrcTy = Src.getType()->getElementType();
Chandler Carrutha6399a52012-10-10 11:29:08 +00004081 uint64_t SrcSize = CGM.getDataLayout().getTypeAllocSize(SrcTy);
4082 uint64_t DstSize = CGM.getDataLayout().getTypeAllocSize(STy);
4083
4084 // If the source type is smaller than the destination type of the
4085 // coerce-to logic, copy the source value into a temp alloca the size
4086 // of the destination type to allow loading all of it. The bits past
4087 // the source value are left undef.
4088 if (SrcSize < DstSize) {
John McCall7f416cc2015-09-08 08:05:57 +00004089 Address TempAlloca
4090 = CreateTempAlloca(STy, Src.getAlignment(),
4091 Src.getName() + ".coerce");
4092 Builder.CreateMemCpy(TempAlloca, Src, SrcSize);
4093 Src = TempAlloca;
Chandler Carrutha6399a52012-10-10 11:29:08 +00004094 } else {
Matt Arsenault7a124f32017-08-01 20:36:57 +00004095 Src = Builder.CreateBitCast(Src,
4096 STy->getPointerTo(Src.getAddressSpace()));
Chandler Carrutha6399a52012-10-10 11:29:08 +00004097 }
4098
John McCall7f416cc2015-09-08 08:05:57 +00004099 auto SrcLayout = CGM.getDataLayout().getStructLayout(STy);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004100 assert(NumIRArgs == STy->getNumElements());
Chris Lattnerceddafb2010-07-05 20:41:41 +00004101 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
John McCall7f416cc2015-09-08 08:05:57 +00004102 auto Offset = CharUnits::fromQuantity(SrcLayout->getElementOffset(i));
4103 Address EltPtr = Builder.CreateStructGEP(Src, i, Offset);
4104 llvm::Value *LI = Builder.CreateLoad(EltPtr);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004105 IRCallArgs[FirstIRArg + i] = LI;
Chris Lattner15ec3612010-06-29 00:06:42 +00004106 }
Chris Lattner3dd716c2010-06-28 23:44:11 +00004107 } else {
Chris Lattner15ec3612010-06-29 00:06:42 +00004108 // In the simple case, just pass the coerced loaded value.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004109 assert(NumIRArgs == 1);
4110 IRCallArgs[FirstIRArg] =
John McCall7f416cc2015-09-08 08:05:57 +00004111 CreateCoercedLoad(Src, ArgInfo.getCoerceToType(), *this);
Chris Lattner3dd716c2010-06-28 23:44:11 +00004112 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004113
Daniel Dunbar2f219b02009-02-03 19:12:28 +00004114 break;
4115 }
4116
John McCallf26e73d2016-03-11 04:30:43 +00004117 case ABIArgInfo::CoerceAndExpand: {
John McCallf26e73d2016-03-11 04:30:43 +00004118 auto coercionType = ArgInfo.getCoerceAndExpandType();
4119 auto layout = CGM.getDataLayout().getStructLayout(coercionType);
4120
John McCall12f23522016-04-04 18:33:08 +00004121 llvm::Value *tempSize = nullptr;
4122 Address addr = Address::invalid();
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00004123 Address AllocaAddr = Address::invalid();
Yaxun Liu5b330e82018-03-15 15:25:19 +00004124 if (I->isAggregate()) {
4125 addr = I->hasLValue() ? I->getKnownLValue().getAddress()
4126 : I->getKnownRValue().getAggregateAddress();
4127
John McCall12f23522016-04-04 18:33:08 +00004128 } else {
Yaxun Liu5b330e82018-03-15 15:25:19 +00004129 RValue RV = I->getKnownRValue();
John McCall12f23522016-04-04 18:33:08 +00004130 assert(RV.isScalar()); // complex should always just be direct
4131
4132 llvm::Type *scalarType = RV.getScalarVal()->getType();
4133 auto scalarSize = CGM.getDataLayout().getTypeAllocSize(scalarType);
4134 auto scalarAlign = CGM.getDataLayout().getPrefTypeAlignment(scalarType);
4135
John McCall12f23522016-04-04 18:33:08 +00004136 // Materialize to a temporary.
4137 addr = CreateTempAlloca(RV.getScalarVal()->getType(),
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00004138 CharUnits::fromQuantity(std::max(
4139 layout->getAlignment(), scalarAlign)),
4140 "tmp",
4141 /*ArraySize=*/nullptr, &AllocaAddr);
4142 tempSize = EmitLifetimeStart(scalarSize, AllocaAddr.getPointer());
John McCall12f23522016-04-04 18:33:08 +00004143
4144 Builder.CreateStore(RV.getScalarVal(), addr);
4145 }
4146
John McCallf26e73d2016-03-11 04:30:43 +00004147 addr = Builder.CreateElementBitCast(addr, coercionType);
4148
4149 unsigned IRArgPos = FirstIRArg;
4150 for (unsigned i = 0, e = coercionType->getNumElements(); i != e; ++i) {
4151 llvm::Type *eltType = coercionType->getElementType(i);
4152 if (ABIArgInfo::isPaddingForCoerceAndExpand(eltType)) continue;
4153 Address eltAddr = Builder.CreateStructGEP(addr, i, layout);
4154 llvm::Value *elt = Builder.CreateLoad(eltAddr);
4155 IRCallArgs[IRArgPos++] = elt;
4156 }
4157 assert(IRArgPos == FirstIRArg + NumIRArgs);
4158
John McCall12f23522016-04-04 18:33:08 +00004159 if (tempSize) {
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00004160 EmitLifetimeEnd(tempSize, AllocaAddr.getPointer());
John McCall12f23522016-04-04 18:33:08 +00004161 }
4162
John McCallf26e73d2016-03-11 04:30:43 +00004163 break;
4164 }
4165
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00004166 case ABIArgInfo::Expand:
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004167 unsigned IRArgPos = FirstIRArg;
Yaxun Liu5b330e82018-03-15 15:25:19 +00004168 ExpandTypeToArgs(I->Ty, *I, IRFuncTy, IRCallArgs, IRArgPos);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004169 assert(IRArgPos == FirstIRArg + NumIRArgs);
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00004170 break;
Daniel Dunbar613855c2008-09-09 23:27:19 +00004171 }
4172 }
Mike Stump11289f42009-09-09 15:08:12 +00004173
John McCall9831b842018-02-06 18:52:44 +00004174 const CGCallee &ConcreteCallee = Callee.prepareConcreteCallee(*this);
4175 llvm::Value *CalleePtr = ConcreteCallee.getFunctionPointer();
John McCallb92ab1a2016-10-26 23:46:34 +00004176
4177 // If we're using inalloca, set up that argument.
John McCall7f416cc2015-09-08 08:05:57 +00004178 if (ArgMemory.isValid()) {
4179 llvm::Value *Arg = ArgMemory.getPointer();
Reid Klecknerafba553e2014-07-08 02:24:27 +00004180 if (CallInfo.isVariadic()) {
4181 // When passing non-POD arguments by value to variadic functions, we will
4182 // end up with a variadic prototype and an inalloca call site. In such
4183 // cases, we can't do any parameter mismatch checks. Give up and bitcast
4184 // the callee.
John McCallb92ab1a2016-10-26 23:46:34 +00004185 unsigned CalleeAS = CalleePtr->getType()->getPointerAddressSpace();
4186 auto FnTy = getTypes().GetFunctionType(CallInfo)->getPointerTo(CalleeAS);
4187 CalleePtr = Builder.CreateBitCast(CalleePtr, FnTy);
Reid Klecknerafba553e2014-07-08 02:24:27 +00004188 } else {
4189 llvm::Type *LastParamTy =
4190 IRFuncTy->getParamType(IRFuncTy->getNumParams() - 1);
4191 if (Arg->getType() != LastParamTy) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00004192#ifndef NDEBUG
Reid Klecknerafba553e2014-07-08 02:24:27 +00004193 // Assert that these structs have equivalent element types.
4194 llvm::StructType *FullTy = CallInfo.getArgStruct();
4195 llvm::StructType *DeclaredTy = cast<llvm::StructType>(
4196 cast<llvm::PointerType>(LastParamTy)->getElementType());
4197 assert(DeclaredTy->getNumElements() == FullTy->getNumElements());
4198 for (llvm::StructType::element_iterator DI = DeclaredTy->element_begin(),
4199 DE = DeclaredTy->element_end(),
4200 FI = FullTy->element_begin();
4201 DI != DE; ++DI, ++FI)
4202 assert(*DI == *FI);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00004203#endif
Reid Klecknerafba553e2014-07-08 02:24:27 +00004204 Arg = Builder.CreateBitCast(Arg, LastParamTy);
4205 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00004206 }
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004207 assert(IRFunctionArgs.hasInallocaArg());
4208 IRCallArgs[IRFunctionArgs.getInallocaArgNo()] = Arg;
Reid Kleckner314ef7b2014-02-01 00:04:45 +00004209 }
4210
John McCallb92ab1a2016-10-26 23:46:34 +00004211 // 2. Prepare the function pointer.
4212
4213 // If the callee is a bitcast of a non-variadic function to have a
4214 // variadic function pointer type, check to see if we can remove the
4215 // bitcast. This comes up with unprototyped functions.
4216 //
4217 // This makes the IR nicer, but more importantly it ensures that we
4218 // can inline the function at -O0 if it is marked always_inline.
4219 auto simplifyVariadicCallee = [](llvm::Value *Ptr) -> llvm::Value* {
4220 llvm::FunctionType *CalleeFT =
4221 cast<llvm::FunctionType>(Ptr->getType()->getPointerElementType());
4222 if (!CalleeFT->isVarArg())
4223 return Ptr;
4224
4225 llvm::ConstantExpr *CE = dyn_cast<llvm::ConstantExpr>(Ptr);
4226 if (!CE || CE->getOpcode() != llvm::Instruction::BitCast)
4227 return Ptr;
4228
4229 llvm::Function *OrigFn = dyn_cast<llvm::Function>(CE->getOperand(0));
4230 if (!OrigFn)
4231 return Ptr;
4232
4233 llvm::FunctionType *OrigFT = OrigFn->getFunctionType();
4234
4235 // If the original type is variadic, or if any of the component types
4236 // disagree, we cannot remove the cast.
4237 if (OrigFT->isVarArg() ||
4238 OrigFT->getNumParams() != CalleeFT->getNumParams() ||
4239 OrigFT->getReturnType() != CalleeFT->getReturnType())
4240 return Ptr;
4241
4242 for (unsigned i = 0, e = OrigFT->getNumParams(); i != e; ++i)
4243 if (OrigFT->getParamType(i) != CalleeFT->getParamType(i))
4244 return Ptr;
4245
4246 return OrigFn;
4247 };
4248 CalleePtr = simplifyVariadicCallee(CalleePtr);
4249
4250 // 3. Perform the actual call.
4251
4252 // Deactivate any cleanups that we're supposed to do immediately before
4253 // the call.
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00004254 if (!CallArgs.getCleanupsToDeactivate().empty())
4255 deactivateArgCleanupsBeforeCall(*this, CallArgs);
4256
John McCallb92ab1a2016-10-26 23:46:34 +00004257 // Assert that the arguments we computed match up. The IR verifier
4258 // will catch this, but this is a common enough source of problems
4259 // during IRGen changes that it's way better for debugging to catch
4260 // it ourselves here.
4261#ifndef NDEBUG
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004262 assert(IRCallArgs.size() == IRFuncTy->getNumParams() || IRFuncTy->isVarArg());
4263 for (unsigned i = 0; i < IRCallArgs.size(); ++i) {
4264 // Inalloca argument can have different type.
4265 if (IRFunctionArgs.hasInallocaArg() &&
4266 i == IRFunctionArgs.getInallocaArgNo())
4267 continue;
4268 if (i < IRFuncTy->getNumParams())
4269 assert(IRCallArgs[i]->getType() == IRFuncTy->getParamType(i));
4270 }
John McCallb92ab1a2016-10-26 23:46:34 +00004271#endif
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004272
Craig Topper3113ec32018-10-24 17:42:17 +00004273 // Update the largest vector width if any arguments have vector types.
4274 for (unsigned i = 0; i < IRCallArgs.size(); ++i) {
4275 if (auto *VT = dyn_cast<llvm::VectorType>(IRCallArgs[i]->getType()))
4276 LargestVectorWidth = std::max(LargestVectorWidth,
4277 VT->getPrimitiveSizeInBits());
4278 }
4279
John McCallb92ab1a2016-10-26 23:46:34 +00004280 // Compute the calling convention and attributes.
Daniel Dunbar0ef34792009-09-12 00:59:20 +00004281 unsigned CallingConv;
Reid Klecknercdd26792017-04-18 23:50:03 +00004282 llvm::AttributeList Attrs;
John McCallb92ab1a2016-10-26 23:46:34 +00004283 CGM.ConstructAttributeList(CalleePtr->getName(), CallInfo,
Reid Klecknercdd26792017-04-18 23:50:03 +00004284 Callee.getAbstractInfo(), Attrs, CallingConv,
Chad Rosier7dbc9cf2016-01-06 14:35:46 +00004285 /*AttrOnCallSite=*/true);
Mike Stump11289f42009-09-09 15:08:12 +00004286
John McCallb92ab1a2016-10-26 23:46:34 +00004287 // Apply some call-site-specific attributes.
4288 // TODO: work this into building the attribute set.
4289
4290 // Apply always_inline to all calls within flatten functions.
4291 // FIXME: should this really take priority over __try, below?
4292 if (CurCodeDecl && CurCodeDecl->hasAttr<FlattenAttr>() &&
Erich Keanede6480a32018-11-13 15:48:08 +00004293 !(Callee.getAbstractInfo().getCalleeDecl().getDecl() &&
4294 Callee.getAbstractInfo()
4295 .getCalleeDecl()
4296 .getDecl()
4297 ->hasAttr<NoInlineAttr>())) {
John McCallb92ab1a2016-10-26 23:46:34 +00004298 Attrs =
Reid Klecknerde864822017-03-21 16:57:30 +00004299 Attrs.addAttribute(getLLVMContext(), llvm::AttributeList::FunctionIndex,
John McCallb92ab1a2016-10-26 23:46:34 +00004300 llvm::Attribute::AlwaysInline);
4301 }
4302
4303 // Disable inlining inside SEH __try blocks.
4304 if (isSEHTryScope()) {
4305 Attrs =
Reid Klecknerde864822017-03-21 16:57:30 +00004306 Attrs.addAttribute(getLLVMContext(), llvm::AttributeList::FunctionIndex,
John McCallb92ab1a2016-10-26 23:46:34 +00004307 llvm::Attribute::NoInline);
4308 }
4309
4310 // Decide whether to use a call or an invoke.
David Majnemer4e52d6f2015-12-12 05:39:21 +00004311 bool CannotThrow;
4312 if (currentFunctionUsesSEHTry()) {
John McCallb92ab1a2016-10-26 23:46:34 +00004313 // SEH cares about asynchronous exceptions, so everything can "throw."
David Majnemer4e52d6f2015-12-12 05:39:21 +00004314 CannotThrow = false;
4315 } else if (isCleanupPadScope() &&
4316 EHPersonality::get(*this).isMSVCXXPersonality()) {
4317 // The MSVC++ personality will implicitly terminate the program if an
John McCallb92ab1a2016-10-26 23:46:34 +00004318 // exception is thrown during a cleanup outside of a try/catch.
4319 // We don't need to model anything in IR to get this behavior.
David Majnemer4e52d6f2015-12-12 05:39:21 +00004320 CannotThrow = true;
4321 } else {
John McCallb92ab1a2016-10-26 23:46:34 +00004322 // Otherwise, nounwind call sites will never throw.
Reid Klecknerde864822017-03-21 16:57:30 +00004323 CannotThrow = Attrs.hasAttribute(llvm::AttributeList::FunctionIndex,
David Majnemer4e52d6f2015-12-12 05:39:21 +00004324 llvm::Attribute::NoUnwind);
4325 }
George Burgess IV003be7c2018-03-08 05:32:30 +00004326
4327 // If we made a temporary, be sure to clean up after ourselves. Note that we
4328 // can't depend on being inside of an ExprWithCleanups, so we need to manually
4329 // pop this cleanup later on. Being eager about this is OK, since this
4330 // temporary is 'invisible' outside of the callee.
4331 if (UnusedReturnSizePtr)
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00004332 pushFullExprCleanup<CallLifetimeEnd>(NormalEHLifetimeMarker, SRetAlloca,
George Burgess IV003be7c2018-03-08 05:32:30 +00004333 UnusedReturnSizePtr);
4334
David Majnemer4e52d6f2015-12-12 05:39:21 +00004335 llvm::BasicBlock *InvokeDest = CannotThrow ? nullptr : getInvokeDest();
John McCallbd309292010-07-06 01:34:17 +00004336
Reid Klecknerb75a3f02018-02-09 00:16:41 +00004337 SmallVector<llvm::OperandBundleDef, 1> BundleList =
4338 getBundlesForFunclet(CalleePtr);
David Majnemer0b17d442015-12-15 21:27:59 +00004339
John McCallb92ab1a2016-10-26 23:46:34 +00004340 // Emit the actual call/invoke instruction.
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004341 llvm::CallSite CS;
John McCallbd309292010-07-06 01:34:17 +00004342 if (!InvokeDest) {
John McCallb92ab1a2016-10-26 23:46:34 +00004343 CS = Builder.CreateCall(CalleePtr, IRCallArgs, BundleList);
Daniel Dunbar12347492009-02-23 17:26:39 +00004344 } else {
4345 llvm::BasicBlock *Cont = createBasicBlock("invoke.cont");
John McCallb92ab1a2016-10-26 23:46:34 +00004346 CS = Builder.CreateInvoke(CalleePtr, Cont, InvokeDest, IRCallArgs,
David Majnemer0b17d442015-12-15 21:27:59 +00004347 BundleList);
Daniel Dunbar12347492009-02-23 17:26:39 +00004348 EmitBlock(Cont);
Daniel Dunbar5006f4a2009-02-20 18:54:31 +00004349 }
John McCallb92ab1a2016-10-26 23:46:34 +00004350 llvm::Instruction *CI = CS.getInstruction();
Chris Lattnere70a0072010-06-29 16:40:28 +00004351 if (callOrInvoke)
John McCallb92ab1a2016-10-26 23:46:34 +00004352 *callOrInvoke = CI;
Daniel Dunbar5006f4a2009-02-20 18:54:31 +00004353
John McCallb92ab1a2016-10-26 23:46:34 +00004354 // Apply the attributes and calling convention.
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004355 CS.setAttributes(Attrs);
Daniel Dunbar0ef34792009-09-12 00:59:20 +00004356 CS.setCallingConv(static_cast<llvm::CallingConv::ID>(CallingConv));
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004357
John McCallb92ab1a2016-10-26 23:46:34 +00004358 // Apply various metadata.
4359
4360 if (!CI->getType()->isVoidTy())
4361 CI->setName("call");
4362
Craig Topper3113ec32018-10-24 17:42:17 +00004363 // Update largest vector width from the return type.
4364 if (auto *VT = dyn_cast<llvm::VectorType>(CI->getType()))
4365 LargestVectorWidth = std::max(LargestVectorWidth,
4366 VT->getPrimitiveSizeInBits());
4367
Adam Nemet1e217bc2016-03-28 22:18:53 +00004368 // Insert instrumentation or attach profile metadata at indirect call sites.
4369 // For more details, see the comment before the definition of
4370 // IPVK_IndirectCallTarget in InstrProfData.inc.
Betul Buyukkurt518276a2016-01-23 22:50:44 +00004371 if (!CS.getCalledFunction())
4372 PGO.valueProfile(Builder, llvm::IPVK_IndirectCallTarget,
John McCallb92ab1a2016-10-26 23:46:34 +00004373 CI, CalleePtr);
Betul Buyukkurt518276a2016-01-23 22:50:44 +00004374
Dan Gohman515a60d2012-02-16 00:57:37 +00004375 // In ObjC ARC mode with no ObjC ARC exception safety, tell the ARC
4376 // optimizer it can aggressively ignore unwind edges.
David Blaikiebbafb8a2012-03-11 07:00:24 +00004377 if (CGM.getLangOpts().ObjCAutoRefCount)
John McCallb92ab1a2016-10-26 23:46:34 +00004378 AddObjCARCExceptionMetadata(CI);
4379
4380 // Suppress tail calls if requested.
4381 if (llvm::CallInst *Call = dyn_cast<llvm::CallInst>(CI)) {
Erich Keanede6480a32018-11-13 15:48:08 +00004382 const Decl *TargetDecl = Callee.getAbstractInfo().getCalleeDecl().getDecl();
John McCallb92ab1a2016-10-26 23:46:34 +00004383 if (TargetDecl && TargetDecl->hasAttr<NotTailCalledAttr>())
4384 Call->setTailCallKind(llvm::CallInst::TCK_NoTail);
4385 }
4386
4387 // 4. Finish the call.
Dan Gohman515a60d2012-02-16 00:57:37 +00004388
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004389 // If the call doesn't return, finish the basic block and clear the
John McCallb92ab1a2016-10-26 23:46:34 +00004390 // insertion point; this allows the rest of IRGen to discard
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004391 // unreachable code.
4392 if (CS.doesNotReturn()) {
George Burgess IV003be7c2018-03-08 05:32:30 +00004393 if (UnusedReturnSizePtr)
4394 PopCleanupBlock();
Leny Kholodov6aab1112015-06-08 10:23:49 +00004395
Vedant Kumar09b5bfd2017-12-21 00:10:25 +00004396 // Strip away the noreturn attribute to better diagnose unreachable UB.
4397 if (SanOpts.has(SanitizerKind::Unreachable)) {
4398 if (auto *F = CS.getCalledFunction())
4399 F->removeFnAttr(llvm::Attribute::NoReturn);
4400 CS.removeAttribute(llvm::AttributeList::FunctionIndex,
4401 llvm::Attribute::NoReturn);
4402 }
4403
4404 EmitUnreachable(Loc);
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004405 Builder.ClearInsertionPoint();
Mike Stump11289f42009-09-09 15:08:12 +00004406
Mike Stump18bb9282009-05-16 07:57:57 +00004407 // FIXME: For now, emit a dummy basic block because expr emitters in
4408 // generally are not ready to handle emitting expressions at unreachable
4409 // points.
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004410 EnsureInsertPoint();
Mike Stump11289f42009-09-09 15:08:12 +00004411
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004412 // Return a reasonable RValue.
4413 return GetUndefRValue(RetTy);
Mike Stump11289f42009-09-09 15:08:12 +00004414 }
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004415
John McCall12f23522016-04-04 18:33:08 +00004416 // Perform the swifterror writeback.
4417 if (swiftErrorTemp.isValid()) {
4418 llvm::Value *errorResult = Builder.CreateLoad(swiftErrorTemp);
4419 Builder.CreateStore(errorResult, swiftErrorArg);
4420 }
4421
John McCallb92ab1a2016-10-26 23:46:34 +00004422 // Emit any call-associated writebacks immediately. Arguably this
4423 // should happen after any return-value munging.
John McCall31168b02011-06-15 23:02:42 +00004424 if (CallArgs.hasWritebacks())
4425 emitWritebacks(*this, CallArgs);
4426
Nico Weber8cdb3f92015-08-25 18:43:32 +00004427 // The stack cleanup for inalloca arguments has to run out of the normal
4428 // lexical order, so deactivate it and run it manually here.
4429 CallArgs.freeArgumentMemory(*this);
4430
John McCallb92ab1a2016-10-26 23:46:34 +00004431 // Extract the return value.
Hal Finkelee90a222014-09-26 05:04:30 +00004432 RValue Ret = [&] {
4433 switch (RetAI.getKind()) {
John McCallf26e73d2016-03-11 04:30:43 +00004434 case ABIArgInfo::CoerceAndExpand: {
4435 auto coercionType = RetAI.getCoerceAndExpandType();
4436 auto layout = CGM.getDataLayout().getStructLayout(coercionType);
4437
4438 Address addr = SRetPtr;
4439 addr = Builder.CreateElementBitCast(addr, coercionType);
4440
John McCall12f23522016-04-04 18:33:08 +00004441 assert(CI->getType() == RetAI.getUnpaddedCoerceAndExpandType());
4442 bool requiresExtract = isa<llvm::StructType>(CI->getType());
4443
John McCallf26e73d2016-03-11 04:30:43 +00004444 unsigned unpaddedIndex = 0;
4445 for (unsigned i = 0, e = coercionType->getNumElements(); i != e; ++i) {
4446 llvm::Type *eltType = coercionType->getElementType(i);
4447 if (ABIArgInfo::isPaddingForCoerceAndExpand(eltType)) continue;
4448 Address eltAddr = Builder.CreateStructGEP(addr, i, layout);
John McCall12f23522016-04-04 18:33:08 +00004449 llvm::Value *elt = CI;
4450 if (requiresExtract)
4451 elt = Builder.CreateExtractValue(elt, unpaddedIndex++);
4452 else
4453 assert(unpaddedIndex == 0);
John McCallf26e73d2016-03-11 04:30:43 +00004454 Builder.CreateStore(elt, eltAddr);
4455 }
John McCall12f23522016-04-04 18:33:08 +00004456 // FALLTHROUGH
Galina Kistanova0872d6c2017-06-03 06:30:46 +00004457 LLVM_FALLTHROUGH;
John McCall12f23522016-04-04 18:33:08 +00004458 }
4459
4460 case ABIArgInfo::InAlloca:
4461 case ABIArgInfo::Indirect: {
4462 RValue ret = convertTempToRValue(SRetPtr, RetTy, SourceLocation());
George Burgess IV003be7c2018-03-08 05:32:30 +00004463 if (UnusedReturnSizePtr)
4464 PopCleanupBlock();
John McCall12f23522016-04-04 18:33:08 +00004465 return ret;
John McCallf26e73d2016-03-11 04:30:43 +00004466 }
4467
Hal Finkelee90a222014-09-26 05:04:30 +00004468 case ABIArgInfo::Ignore:
4469 // If we are ignoring an argument that had a result, make sure to
4470 // construct the appropriate return value for our caller.
4471 return GetUndefRValue(RetTy);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004472
Hal Finkelee90a222014-09-26 05:04:30 +00004473 case ABIArgInfo::Extend:
4474 case ABIArgInfo::Direct: {
4475 llvm::Type *RetIRTy = ConvertType(RetTy);
4476 if (RetAI.getCoerceToType() == RetIRTy && RetAI.getDirectOffset() == 0) {
4477 switch (getEvaluationKind(RetTy)) {
4478 case TEK_Complex: {
4479 llvm::Value *Real = Builder.CreateExtractValue(CI, 0);
4480 llvm::Value *Imag = Builder.CreateExtractValue(CI, 1);
4481 return RValue::getComplex(std::make_pair(Real, Imag));
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00004482 }
Hal Finkelee90a222014-09-26 05:04:30 +00004483 case TEK_Aggregate: {
John McCall7f416cc2015-09-08 08:05:57 +00004484 Address DestPtr = ReturnValue.getValue();
Hal Finkelee90a222014-09-26 05:04:30 +00004485 bool DestIsVolatile = ReturnValue.isVolatile();
4486
John McCall7f416cc2015-09-08 08:05:57 +00004487 if (!DestPtr.isValid()) {
Hal Finkelee90a222014-09-26 05:04:30 +00004488 DestPtr = CreateMemTemp(RetTy, "agg.tmp");
4489 DestIsVolatile = false;
4490 }
John McCall7f416cc2015-09-08 08:05:57 +00004491 BuildAggStore(*this, CI, DestPtr, DestIsVolatile);
Hal Finkelee90a222014-09-26 05:04:30 +00004492 return RValue::getAggregate(DestPtr);
4493 }
4494 case TEK_Scalar: {
4495 // If the argument doesn't match, perform a bitcast to coerce it. This
4496 // can happen due to trivial type mismatches.
4497 llvm::Value *V = CI;
4498 if (V->getType() != RetIRTy)
4499 V = Builder.CreateBitCast(V, RetIRTy);
4500 return RValue::get(V);
4501 }
4502 }
4503 llvm_unreachable("bad evaluation kind");
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00004504 }
Hal Finkelee90a222014-09-26 05:04:30 +00004505
John McCall7f416cc2015-09-08 08:05:57 +00004506 Address DestPtr = ReturnValue.getValue();
Hal Finkelee90a222014-09-26 05:04:30 +00004507 bool DestIsVolatile = ReturnValue.isVolatile();
4508
John McCall7f416cc2015-09-08 08:05:57 +00004509 if (!DestPtr.isValid()) {
Hal Finkelee90a222014-09-26 05:04:30 +00004510 DestPtr = CreateMemTemp(RetTy, "coerce");
4511 DestIsVolatile = false;
John McCall47fb9502013-03-07 21:37:08 +00004512 }
Hal Finkelee90a222014-09-26 05:04:30 +00004513
4514 // If the value is offset in memory, apply the offset now.
John McCall7f416cc2015-09-08 08:05:57 +00004515 Address StorePtr = emitAddressAtOffset(*this, DestPtr, RetAI);
4516 CreateCoercedStore(CI, StorePtr, DestIsVolatile, *this);
Hal Finkelee90a222014-09-26 05:04:30 +00004517
4518 return convertTempToRValue(DestPtr, RetTy, SourceLocation());
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00004519 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004520
Hal Finkelee90a222014-09-26 05:04:30 +00004521 case ABIArgInfo::Expand:
4522 llvm_unreachable("Invalid ABI kind for return argument");
Anders Carlsson17490832009-12-24 20:40:36 +00004523 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004524
Hal Finkelee90a222014-09-26 05:04:30 +00004525 llvm_unreachable("Unhandled ABIArgInfo::Kind");
4526 } ();
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004527
John McCallb92ab1a2016-10-26 23:46:34 +00004528 // Emit the assume_aligned check on the return value.
Erich Keanede6480a32018-11-13 15:48:08 +00004529 const Decl *TargetDecl = Callee.getAbstractInfo().getCalleeDecl().getDecl();
Hal Finkelee90a222014-09-26 05:04:30 +00004530 if (Ret.isScalar() && TargetDecl) {
4531 if (const auto *AA = TargetDecl->getAttr<AssumeAlignedAttr>()) {
4532 llvm::Value *OffsetValue = nullptr;
4533 if (const auto *Offset = AA->getOffset())
4534 OffsetValue = EmitScalarExpr(Offset);
4535
4536 llvm::Value *Alignment = EmitScalarExpr(AA->getAlignment());
4537 llvm::ConstantInt *AlignmentCI = cast<llvm::ConstantInt>(Alignment);
Vlad Tsyrklevich86e68fd2019-01-15 03:38:02 +00004538 EmitAlignmentAssumption(Ret.getScalarVal(), AlignmentCI->getZExtValue(),
4539 OffsetValue);
Erich Keane623efd82017-03-30 21:48:55 +00004540 } else if (const auto *AA = TargetDecl->getAttr<AllocAlignAttr>()) {
Vlad Tsyrklevich86e68fd2019-01-15 03:38:02 +00004541 llvm::Value *ParamVal =
4542 CallArgs[AA->getParamIndex().getLLVMIndex()].getRValue(
4543 *this).getScalarVal();
4544 EmitAlignmentAssumption(Ret.getScalarVal(), ParamVal);
Hal Finkelee90a222014-09-26 05:04:30 +00004545 }
Daniel Dunbar573884e2008-09-10 07:04:09 +00004546 }
Daniel Dunbard3674e62008-09-11 01:48:57 +00004547
Hal Finkelee90a222014-09-26 05:04:30 +00004548 return Ret;
Daniel Dunbar613855c2008-09-09 23:27:19 +00004549}
Daniel Dunbar2d0746f2009-02-10 20:44:09 +00004550
John McCall9831b842018-02-06 18:52:44 +00004551CGCallee CGCallee::prepareConcreteCallee(CodeGenFunction &CGF) const {
4552 if (isVirtual()) {
4553 const CallExpr *CE = getVirtualCallExpr();
4554 return CGF.CGM.getCXXABI().getVirtualFunctionPointer(
Stephen Kellyf2ceec42018-08-09 21:08:08 +00004555 CGF, getVirtualMethodDecl(), getThisAddress(), getFunctionType(),
4556 CE ? CE->getBeginLoc() : SourceLocation());
John McCall9831b842018-02-06 18:52:44 +00004557 }
4558
4559 return *this;
4560}
4561
Daniel Dunbar2d0746f2009-02-10 20:44:09 +00004562/* VarArg handling */
4563
Charles Davisc7d5c942015-09-17 20:55:33 +00004564Address CodeGenFunction::EmitVAArg(VAArgExpr *VE, Address &VAListAddr) {
4565 VAListAddr = VE->isMicrosoftABI()
4566 ? EmitMSVAListRef(VE->getSubExpr())
4567 : EmitVAListRef(VE->getSubExpr());
4568 QualType Ty = VE->getType();
4569 if (VE->isMicrosoftABI())
4570 return CGM.getTypes().getABIInfo().EmitMSVAArg(*this, VAListAddr, Ty);
John McCall7f416cc2015-09-08 08:05:57 +00004571 return CGM.getTypes().getABIInfo().EmitVAArg(*this, VAListAddr, Ty);
Daniel Dunbar2d0746f2009-02-10 20:44:09 +00004572}