blob: a650493c5ba4dd0ad2b2df5e4e94e6b5afc7859c [file] [log] [blame]
Nick Lewycky5fa40c32013-10-01 21:51:38 +00001//===--- CGCall.cpp - Encapsulate calling convention details --------------===//
Daniel Dunbar3d7c90b2008-09-08 21:33:45 +00002//
Chandler Carruth2946cd72019-01-19 08:50:56 +00003// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
Daniel Dunbar3d7c90b2008-09-08 21:33:45 +00006//
7//===----------------------------------------------------------------------===//
8//
9// These classes wrap the information about a call or function
10// definition used to handle ABI compliancy.
11//
12//===----------------------------------------------------------------------===//
13
14#include "CGCall.h"
Chris Lattnere70a0072010-06-29 16:40:28 +000015#include "ABIInfo.h"
Akira Hatanaka9d8ac612016-02-17 21:09:50 +000016#include "CGBlocks.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000017#include "CGCXXABI.h"
David Majnemer4e52d6f2015-12-12 05:39:21 +000018#include "CGCleanup.h"
Daniel Dunbar3d7c90b2008-09-08 21:33:45 +000019#include "CodeGenFunction.h"
Daniel Dunbarc68897d2008-09-10 00:41:16 +000020#include "CodeGenModule.h"
John McCalla729c622012-02-17 03:33:10 +000021#include "TargetInfo.h"
Daniel Dunbar3d7c90b2008-09-08 21:33:45 +000022#include "clang/AST/Decl.h"
Anders Carlssonb15b55c2009-04-03 22:48:58 +000023#include "clang/AST/DeclCXX.h"
Daniel Dunbar3d7c90b2008-09-08 21:33:45 +000024#include "clang/AST/DeclObjC.h"
Richard Trieu63688182018-12-11 03:18:39 +000025#include "clang/Basic/CodeGenOptions.h"
Eric Christopher15709992015-10-15 23:47:11 +000026#include "clang/Basic/TargetBuiltins.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000027#include "clang/Basic/TargetInfo.h"
Mark Laceya8e7df32013-10-30 21:53:58 +000028#include "clang/CodeGen/CGFunctionInfo.h"
John McCall12f23522016-04-04 18:33:08 +000029#include "clang/CodeGen/SwiftCallingConv.h"
Bill Wendling706469b2013-02-28 22:49:57 +000030#include "llvm/ADT/StringExtras.h"
David Blaikie181a6132018-06-04 21:23:29 +000031#include "llvm/Transforms/Utils/Local.h"
Nick Lewyckyd9bce502016-09-20 15:49:58 +000032#include "llvm/Analysis/ValueTracking.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000033#include "llvm/IR/Attributes.h"
Chandler Carruthc80ceea2014-03-04 11:02:08 +000034#include "llvm/IR/CallSite.h"
David Blaikief47ca252018-03-21 22:34:27 +000035#include "llvm/IR/CallingConv.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000036#include "llvm/IR/DataLayout.h"
37#include "llvm/IR/InlineAsm.h"
Saleem Abdulrasool10a49722016-04-08 16:52:00 +000038#include "llvm/IR/IntrinsicInst.h"
David Blaikief47ca252018-03-21 22:34:27 +000039#include "llvm/IR/Intrinsics.h"
Daniel Dunbar3d7c90b2008-09-08 21:33:45 +000040using namespace clang;
41using namespace CodeGen;
42
43/***/
44
Nikolay Haustov8c6538b2016-06-30 09:06:33 +000045unsigned CodeGenTypes::ClangCallConvToLLVMCallConv(CallingConv CC) {
John McCallab26cfa2010-02-05 21:31:56 +000046 switch (CC) {
47 default: return llvm::CallingConv::C;
48 case CC_X86StdCall: return llvm::CallingConv::X86_StdCall;
49 case CC_X86FastCall: return llvm::CallingConv::X86_FastCall;
Erich Keane757d3172016-11-02 18:29:35 +000050 case CC_X86RegCall: return llvm::CallingConv::X86_RegCall;
Douglas Gregora941dca2010-05-18 16:57:00 +000051 case CC_X86ThisCall: return llvm::CallingConv::X86_ThisCall;
Martin Storsjo022e7822017-07-17 20:49:45 +000052 case CC_Win64: return llvm::CallingConv::Win64;
Charles Davisb5a214e2013-08-30 04:39:01 +000053 case CC_X86_64SysV: return llvm::CallingConv::X86_64_SysV;
Anton Korobeynikov231e8752011-04-14 20:06:49 +000054 case CC_AAPCS: return llvm::CallingConv::ARM_AAPCS;
55 case CC_AAPCS_VFP: return llvm::CallingConv::ARM_AAPCS_VFP;
Guy Benyeif0a014b2012-12-25 08:53:55 +000056 case CC_IntelOclBicc: return llvm::CallingConv::Intel_OCL_BI;
Reid Klecknerd7857f02014-10-24 17:42:17 +000057 // TODO: Add support for __pascal to LLVM.
58 case CC_X86Pascal: return llvm::CallingConv::C;
59 // TODO: Add support for __vectorcall to LLVM.
Reid Kleckner80944df2014-10-31 22:00:51 +000060 case CC_X86VectorCall: return llvm::CallingConv::X86_VectorCall;
Sander de Smalen44a22532018-11-26 16:38:37 +000061 case CC_AArch64VectorCall: return llvm::CallingConv::AArch64_VectorCall;
Alexander Kornienko21de0ae2015-01-20 11:20:41 +000062 case CC_SpirFunction: return llvm::CallingConv::SPIR_FUNC;
Nikolay Haustov8c6538b2016-06-30 09:06:33 +000063 case CC_OpenCLKernel: return CGM.getTargetCodeGenInfo().getOpenCLKernelCallingConv();
Roman Levenstein35aa5ce2016-03-16 18:00:46 +000064 case CC_PreserveMost: return llvm::CallingConv::PreserveMost;
65 case CC_PreserveAll: return llvm::CallingConv::PreserveAll;
John McCall12f23522016-04-04 18:33:08 +000066 case CC_Swift: return llvm::CallingConv::Swift;
John McCallab26cfa2010-02-05 21:31:56 +000067 }
68}
69
Mikael Nilsson9d2872d2018-12-13 10:15:27 +000070/// Derives the 'this' type for codegen purposes, i.e. ignoring method CVR
John McCall8ee376f2010-02-24 07:14:12 +000071/// qualification.
Mikael Nilsson9d2872d2018-12-13 10:15:27 +000072static CanQualType GetThisType(ASTContext &Context, const CXXRecordDecl *RD,
73 const CXXMethodDecl *MD) {
John McCall2da83a32010-02-26 00:48:12 +000074 QualType RecTy = Context.getTagDeclType(RD)->getCanonicalTypeInternal();
Mikael Nilsson9d2872d2018-12-13 10:15:27 +000075 if (MD)
Anastasia Stulovad1986d12019-01-14 11:44:22 +000076 RecTy = Context.getAddrSpaceQualType(RecTy, MD->getTypeQualifiers().getAddressSpace());
John McCall2da83a32010-02-26 00:48:12 +000077 return Context.getPointerType(CanQualType::CreateUnsafe(RecTy));
Daniel Dunbar7a95ca32008-09-10 04:01:49 +000078}
79
John McCall8ee376f2010-02-24 07:14:12 +000080/// Returns the canonical formal type of the given C++ method.
John McCall2da83a32010-02-26 00:48:12 +000081static CanQual<FunctionProtoType> GetFormalType(const CXXMethodDecl *MD) {
82 return MD->getType()->getCanonicalTypeUnqualified()
83 .getAs<FunctionProtoType>();
John McCall8ee376f2010-02-24 07:14:12 +000084}
85
86/// Returns the "extra-canonicalized" return type, which discards
87/// qualifiers on the return type. Codegen doesn't care about them,
88/// and it makes ABI code a little easier to be able to assume that
89/// all parameter and return types are top-level unqualified.
John McCall2da83a32010-02-26 00:48:12 +000090static CanQualType GetReturnType(QualType RetTy) {
91 return RetTy->getCanonicalTypeUnqualified().getUnqualifiedType();
John McCall8ee376f2010-02-24 07:14:12 +000092}
93
John McCall8dda7b22012-07-07 06:41:13 +000094/// Arrange the argument and result information for a value of the given
95/// unprototyped freestanding function type.
John McCall8ee376f2010-02-24 07:14:12 +000096const CGFunctionInfo &
John McCall8dda7b22012-07-07 06:41:13 +000097CodeGenTypes::arrangeFreeFunctionType(CanQual<FunctionNoProtoType> FTNP) {
John McCalla729c622012-02-17 03:33:10 +000098 // When translating an unprototyped function type, always use a
99 // variadic type.
Alp Toker314cc812014-01-25 16:55:45 +0000100 return arrangeLLVMFunctionInfo(FTNP->getReturnType().getUnqualifiedType(),
Peter Collingbournef7706832014-12-12 23:41:25 +0000101 /*instanceMethod=*/false,
102 /*chainCall=*/false, None,
John McCallc56a8b32016-03-11 04:30:31 +0000103 FTNP->getExtInfo(), {}, RequiredArgs(0));
John McCall8ee376f2010-02-24 07:14:12 +0000104}
105
George Burgess IVb7760212017-02-24 02:49:47 +0000106static void addExtParameterInfosForCall(
107 llvm::SmallVectorImpl<FunctionProtoType::ExtParameterInfo> &paramInfos,
108 const FunctionProtoType *proto,
109 unsigned prefixArgs,
110 unsigned totalArgs) {
111 assert(proto->hasExtParameterInfos());
112 assert(paramInfos.size() <= prefixArgs);
113 assert(proto->getNumParams() + prefixArgs <= totalArgs);
114
115 paramInfos.reserve(totalArgs);
116
117 // Add default infos for any prefix args that don't already have infos.
118 paramInfos.resize(prefixArgs);
119
120 // Add infos for the prototype.
121 for (const auto &ParamInfo : proto->getExtParameterInfos()) {
122 paramInfos.push_back(ParamInfo);
123 // pass_object_size params have no parameter info.
124 if (ParamInfo.hasPassObjectSize())
125 paramInfos.emplace_back();
126 }
127
128 assert(paramInfos.size() <= totalArgs &&
129 "Did we forget to insert pass_object_size args?");
130 // Add default infos for the variadic and/or suffix arguments.
131 paramInfos.resize(totalArgs);
132}
133
Hiroshi Inouec5e54dd2017-07-03 08:49:44 +0000134/// Adds the formal parameters in FPT to the given prefix. If any parameter in
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000135/// FPT has pass_object_size attrs, then we'll add parameters for those, too.
136static void appendParameterTypes(const CodeGenTypes &CGT,
137 SmallVectorImpl<CanQualType> &prefix,
John McCallc56a8b32016-03-11 04:30:31 +0000138 SmallVectorImpl<FunctionProtoType::ExtParameterInfo> &paramInfos,
George Burgess IVb7760212017-02-24 02:49:47 +0000139 CanQual<FunctionProtoType> FPT) {
140 // Fast path: don't touch param info if we don't need to.
141 if (!FPT->hasExtParameterInfos()) {
142 assert(paramInfos.empty() &&
143 "We have paramInfos, but the prototype doesn't?");
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000144 prefix.append(FPT->param_type_begin(), FPT->param_type_end());
145 return;
146 }
147
George Burgess IVb7760212017-02-24 02:49:47 +0000148 unsigned PrefixSize = prefix.size();
149 // In the vast majority of cases, we'll have precisely FPT->getNumParams()
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000150 // parameters; the only thing that can change this is the presence of
151 // pass_object_size. So, we preallocate for the common case.
152 prefix.reserve(prefix.size() + FPT->getNumParams());
153
George Burgess IVb7760212017-02-24 02:49:47 +0000154 auto ExtInfos = FPT->getExtParameterInfos();
155 assert(ExtInfos.size() == FPT->getNumParams());
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000156 for (unsigned I = 0, E = FPT->getNumParams(); I != E; ++I) {
157 prefix.push_back(FPT->getParamType(I));
George Burgess IVb7760212017-02-24 02:49:47 +0000158 if (ExtInfos[I].hasPassObjectSize())
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000159 prefix.push_back(CGT.getContext().getSizeType());
160 }
George Burgess IVb7760212017-02-24 02:49:47 +0000161
162 addExtParameterInfosForCall(paramInfos, FPT.getTypePtr(), PrefixSize,
163 prefix.size());
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000164}
165
John McCall8dda7b22012-07-07 06:41:13 +0000166/// Arrange the LLVM function layout for a value of the given function
Alexey Samsonove5ef3ca2014-08-13 23:55:54 +0000167/// type, on top of any implicit parameters already stored.
168static const CGFunctionInfo &
Peter Collingbournef7706832014-12-12 23:41:25 +0000169arrangeLLVMFunctionInfo(CodeGenTypes &CGT, bool instanceMethod,
Alexey Samsonove5ef3ca2014-08-13 23:55:54 +0000170 SmallVectorImpl<CanQualType> &prefix,
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000171 CanQual<FunctionProtoType> FTP,
172 const FunctionDecl *FD) {
John McCallc56a8b32016-03-11 04:30:31 +0000173 SmallVector<FunctionProtoType::ExtParameterInfo, 16> paramInfos;
George Burgess IV419996c2016-06-16 23:06:04 +0000174 RequiredArgs Required =
175 RequiredArgs::forPrototypePlus(FTP, prefix.size(), FD);
Daniel Dunbarbf8c24a2009-02-02 23:23:47 +0000176 // FIXME: Kill copy.
George Burgess IVb7760212017-02-24 02:49:47 +0000177 appendParameterTypes(CGT, prefix, paramInfos, FTP);
Alp Toker314cc812014-01-25 16:55:45 +0000178 CanQualType resultType = FTP->getReturnType().getUnqualifiedType();
John McCallc56a8b32016-03-11 04:30:31 +0000179
Peter Collingbournef7706832014-12-12 23:41:25 +0000180 return CGT.arrangeLLVMFunctionInfo(resultType, instanceMethod,
181 /*chainCall=*/false, prefix,
John McCallc56a8b32016-03-11 04:30:31 +0000182 FTP->getExtInfo(), paramInfos,
George Burgess IV419996c2016-06-16 23:06:04 +0000183 Required);
John McCall8ee376f2010-02-24 07:14:12 +0000184}
185
John McCalla729c622012-02-17 03:33:10 +0000186/// Arrange the argument and result information for a value of the
John McCall8dda7b22012-07-07 06:41:13 +0000187/// given freestanding function type.
John McCall8ee376f2010-02-24 07:14:12 +0000188const CGFunctionInfo &
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000189CodeGenTypes::arrangeFreeFunctionType(CanQual<FunctionProtoType> FTP,
190 const FunctionDecl *FD) {
John McCalla729c622012-02-17 03:33:10 +0000191 SmallVector<CanQualType, 16> argTypes;
Peter Collingbournef7706832014-12-12 23:41:25 +0000192 return ::arrangeLLVMFunctionInfo(*this, /*instanceMethod=*/false, argTypes,
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000193 FTP, FD);
Daniel Dunbar7feafc72009-09-11 22:24:53 +0000194}
195
Aaron Ballman0362a6d2013-12-18 16:23:37 +0000196static CallingConv getCallingConventionForDecl(const Decl *D, bool IsWindows) {
Daniel Dunbar7feafc72009-09-11 22:24:53 +0000197 // Set the appropriate calling convention for the Function.
198 if (D->hasAttr<StdCallAttr>())
John McCallab26cfa2010-02-05 21:31:56 +0000199 return CC_X86StdCall;
Daniel Dunbar7feafc72009-09-11 22:24:53 +0000200
201 if (D->hasAttr<FastCallAttr>())
John McCallab26cfa2010-02-05 21:31:56 +0000202 return CC_X86FastCall;
Daniel Dunbar7feafc72009-09-11 22:24:53 +0000203
Erich Keane757d3172016-11-02 18:29:35 +0000204 if (D->hasAttr<RegCallAttr>())
205 return CC_X86RegCall;
206
Douglas Gregora941dca2010-05-18 16:57:00 +0000207 if (D->hasAttr<ThisCallAttr>())
208 return CC_X86ThisCall;
209
Reid Klecknerd7857f02014-10-24 17:42:17 +0000210 if (D->hasAttr<VectorCallAttr>())
211 return CC_X86VectorCall;
212
Dawn Perchik335e16b2010-09-03 01:29:35 +0000213 if (D->hasAttr<PascalAttr>())
214 return CC_X86Pascal;
215
Anton Korobeynikov231e8752011-04-14 20:06:49 +0000216 if (PcsAttr *PCS = D->getAttr<PcsAttr>())
217 return (PCS->getPCS() == PcsAttr::AAPCS ? CC_AAPCS : CC_AAPCS_VFP);
218
Sander de Smalen44a22532018-11-26 16:38:37 +0000219 if (D->hasAttr<AArch64VectorPcsAttr>())
220 return CC_AArch64VectorCall;
221
Guy Benyeif0a014b2012-12-25 08:53:55 +0000222 if (D->hasAttr<IntelOclBiccAttr>())
223 return CC_IntelOclBicc;
224
Aaron Ballman0362a6d2013-12-18 16:23:37 +0000225 if (D->hasAttr<MSABIAttr>())
Martin Storsjo022e7822017-07-17 20:49:45 +0000226 return IsWindows ? CC_C : CC_Win64;
Aaron Ballman0362a6d2013-12-18 16:23:37 +0000227
228 if (D->hasAttr<SysVABIAttr>())
229 return IsWindows ? CC_X86_64SysV : CC_C;
230
Roman Levenstein35aa5ce2016-03-16 18:00:46 +0000231 if (D->hasAttr<PreserveMostAttr>())
232 return CC_PreserveMost;
233
234 if (D->hasAttr<PreserveAllAttr>())
235 return CC_PreserveAll;
236
John McCallab26cfa2010-02-05 21:31:56 +0000237 return CC_C;
Daniel Dunbar7a95ca32008-09-10 04:01:49 +0000238}
239
John McCalla729c622012-02-17 03:33:10 +0000240/// Arrange the argument and result information for a call to an
241/// unknown C++ non-static member function of the given abstract type.
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000242/// (Zero value of RD means we don't have any meaningful "this" argument type,
243/// so fall back to a generic pointer type).
John McCalla729c622012-02-17 03:33:10 +0000244/// The member function must be an ordinary function, i.e. not a
245/// constructor or destructor.
246const CGFunctionInfo &
247CodeGenTypes::arrangeCXXMethodType(const CXXRecordDecl *RD,
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000248 const FunctionProtoType *FTP,
249 const CXXMethodDecl *MD) {
John McCalla729c622012-02-17 03:33:10 +0000250 SmallVector<CanQualType, 16> argTypes;
John McCall8ee376f2010-02-24 07:14:12 +0000251
Anders Carlsson2ee3c012009-10-03 19:43:08 +0000252 // Add the 'this' pointer.
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000253 if (RD)
Mikael Nilsson9d2872d2018-12-13 10:15:27 +0000254 argTypes.push_back(GetThisType(Context, RD, MD));
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000255 else
256 argTypes.push_back(Context.VoidPtrTy);
John McCall8ee376f2010-02-24 07:14:12 +0000257
Alexey Samsonove5ef3ca2014-08-13 23:55:54 +0000258 return ::arrangeLLVMFunctionInfo(
259 *this, true, argTypes,
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000260 FTP->getCanonicalTypeUnqualified().getAs<FunctionProtoType>(), MD);
Anders Carlsson2ee3c012009-10-03 19:43:08 +0000261}
262
Yaxun Liu6c10a662018-06-12 00:16:33 +0000263/// Set calling convention for CUDA/HIP kernel.
264static void setCUDAKernelCallingConvention(CanQualType &FTy, CodeGenModule &CGM,
265 const FunctionDecl *FD) {
266 if (FD->hasAttr<CUDAGlobalAttr>()) {
267 const FunctionType *FT = FTy->getAs<FunctionType>();
268 CGM.getTargetCodeGenInfo().setCUDAKernelCallingConvention(FT);
269 FTy = FT->getCanonicalTypeUnqualified();
270 }
271}
272
John McCalla729c622012-02-17 03:33:10 +0000273/// Arrange the argument and result information for a declaration or
274/// definition of the given C++ non-static member function. The
275/// member function must be an ordinary function, i.e. not a
276/// constructor or destructor.
277const CGFunctionInfo &
278CodeGenTypes::arrangeCXXMethodDeclaration(const CXXMethodDecl *MD) {
Benjamin Kramer60509af2013-09-09 14:48:42 +0000279 assert(!isa<CXXConstructorDecl>(MD) && "wrong method for constructors!");
John McCall0d635f52010-09-03 01:26:39 +0000280 assert(!isa<CXXDestructorDecl>(MD) && "wrong method for destructors!");
281
Yaxun Liu6c10a662018-06-12 00:16:33 +0000282 CanQualType FT = GetFormalType(MD).getAs<Type>();
283 setCUDAKernelCallingConvention(FT, CGM, MD);
284 auto prototype = FT.getAs<FunctionProtoType>();
Mike Stump11289f42009-09-09 15:08:12 +0000285
John McCalla729c622012-02-17 03:33:10 +0000286 if (MD->isInstance()) {
287 // The abstract case is perfectly fine.
Mark Lacey5ea993b2013-10-02 20:35:23 +0000288 const CXXRecordDecl *ThisType = TheCXXABI.getThisArgumentTypeForMethod(MD);
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000289 return arrangeCXXMethodType(ThisType, prototype.getTypePtr(), MD);
John McCalla729c622012-02-17 03:33:10 +0000290 }
291
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000292 return arrangeFreeFunctionType(prototype, MD);
Anders Carlssonb15b55c2009-04-03 22:48:58 +0000293}
294
Richard Smith5179eb72016-06-28 19:03:57 +0000295bool CodeGenTypes::inheritingCtorHasParams(
296 const InheritedConstructor &Inherited, CXXCtorType Type) {
297 // Parameters are unnecessary if we're constructing a base class subobject
298 // and the inherited constructor lives in a virtual base.
299 return Type == Ctor_Complete ||
300 !Inherited.getShadowDecl()->constructsVirtualBase() ||
301 !Target.getCXXABI().hasConstructorVariants();
302 }
303
John McCalla729c622012-02-17 03:33:10 +0000304const CGFunctionInfo &
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000305CodeGenTypes::arrangeCXXStructorDeclaration(const CXXMethodDecl *MD,
306 StructorType Type) {
307
John McCalla729c622012-02-17 03:33:10 +0000308 SmallVector<CanQualType, 16> argTypes;
John McCallc56a8b32016-03-11 04:30:31 +0000309 SmallVector<FunctionProtoType::ExtParameterInfo, 16> paramInfos;
Mikael Nilsson9d2872d2018-12-13 10:15:27 +0000310 argTypes.push_back(GetThisType(Context, MD->getParent(), MD));
Stephen Lin9dc6eef2013-06-30 20:40:16 +0000311
Richard Smith5179eb72016-06-28 19:03:57 +0000312 bool PassParams = true;
313
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000314 GlobalDecl GD;
315 if (auto *CD = dyn_cast<CXXConstructorDecl>(MD)) {
316 GD = GlobalDecl(CD, toCXXCtorType(Type));
Richard Smith5179eb72016-06-28 19:03:57 +0000317
318 // A base class inheriting constructor doesn't get forwarded arguments
319 // needed to construct a virtual base (or base class thereof).
320 if (auto Inherited = CD->getInheritedConstructor())
321 PassParams = inheritingCtorHasParams(Inherited, toCXXCtorType(Type));
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000322 } else {
323 auto *DD = dyn_cast<CXXDestructorDecl>(MD);
324 GD = GlobalDecl(DD, toCXXDtorType(Type));
325 }
Anders Carlsson82ba57c2009-11-25 03:15:49 +0000326
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000327 CanQual<FunctionProtoType> FTP = GetFormalType(MD);
John McCall5d865c322010-08-31 07:33:07 +0000328
329 // Add the formal parameters.
Richard Smith5179eb72016-06-28 19:03:57 +0000330 if (PassParams)
George Burgess IVb7760212017-02-24 02:49:47 +0000331 appendParameterTypes(*this, argTypes, paramInfos, FTP);
John McCall5d865c322010-08-31 07:33:07 +0000332
George Burgess IV75b34a92017-02-22 22:38:25 +0000333 CGCXXABI::AddedStructorArgs AddedArgs =
334 TheCXXABI.buildStructorSignature(MD, Type, argTypes);
335 if (!paramInfos.empty()) {
336 // Note: prefix implies after the first param.
337 if (AddedArgs.Prefix)
338 paramInfos.insert(paramInfos.begin() + 1, AddedArgs.Prefix,
339 FunctionProtoType::ExtParameterInfo{});
340 if (AddedArgs.Suffix)
341 paramInfos.append(AddedArgs.Suffix,
342 FunctionProtoType::ExtParameterInfo{});
343 }
Reid Kleckner89077a12013-12-17 19:46:40 +0000344
345 RequiredArgs required =
Richard Smith5179eb72016-06-28 19:03:57 +0000346 (PassParams && MD->isVariadic() ? RequiredArgs(argTypes.size())
347 : RequiredArgs::All);
Reid Kleckner89077a12013-12-17 19:46:40 +0000348
John McCall8dda7b22012-07-07 06:41:13 +0000349 FunctionType::ExtInfo extInfo = FTP->getExtInfo();
David Majnemer0c0b6d92014-10-31 20:09:12 +0000350 CanQualType resultType = TheCXXABI.HasThisReturn(GD)
351 ? argTypes.front()
352 : TheCXXABI.hasMostDerivedReturn(GD)
353 ? CGM.getContext().VoidPtrTy
354 : Context.VoidTy;
Peter Collingbournef7706832014-12-12 23:41:25 +0000355 return arrangeLLVMFunctionInfo(resultType, /*instanceMethod=*/true,
356 /*chainCall=*/false, argTypes, extInfo,
John McCallc56a8b32016-03-11 04:30:31 +0000357 paramInfos, required);
358}
359
360static SmallVector<CanQualType, 16>
361getArgTypesForCall(ASTContext &ctx, const CallArgList &args) {
362 SmallVector<CanQualType, 16> argTypes;
363 for (auto &arg : args)
364 argTypes.push_back(ctx.getCanonicalParamType(arg.Ty));
365 return argTypes;
366}
367
368static SmallVector<CanQualType, 16>
369getArgTypesForDeclaration(ASTContext &ctx, const FunctionArgList &args) {
370 SmallVector<CanQualType, 16> argTypes;
371 for (auto &arg : args)
372 argTypes.push_back(ctx.getCanonicalParamType(arg->getType()));
373 return argTypes;
374}
375
John McCallc56a8b32016-03-11 04:30:31 +0000376static llvm::SmallVector<FunctionProtoType::ExtParameterInfo, 16>
377getExtParameterInfosForCall(const FunctionProtoType *proto,
378 unsigned prefixArgs, unsigned totalArgs) {
379 llvm::SmallVector<FunctionProtoType::ExtParameterInfo, 16> result;
380 if (proto->hasExtParameterInfos()) {
381 addExtParameterInfosForCall(result, proto, prefixArgs, totalArgs);
382 }
383 return result;
Anders Carlsson82ba57c2009-11-25 03:15:49 +0000384}
385
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000386/// Arrange a call to a C++ method, passing the given arguments.
George Burgess IVd0a9e802017-02-23 22:07:35 +0000387///
388/// ExtraPrefixArgs is the number of ABI-specific args passed after the `this`
389/// parameter.
390/// ExtraSuffixArgs is the number of ABI-specific args passed at the end of
391/// args.
392/// PassProtoArgs indicates whether `args` has args for the parameters in the
393/// given CXXConstructorDecl.
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000394const CGFunctionInfo &
395CodeGenTypes::arrangeCXXConstructorCall(const CallArgList &args,
396 const CXXConstructorDecl *D,
397 CXXCtorType CtorKind,
George Burgess IVd0a9e802017-02-23 22:07:35 +0000398 unsigned ExtraPrefixArgs,
399 unsigned ExtraSuffixArgs,
400 bool PassProtoArgs) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000401 // FIXME: Kill copy.
402 SmallVector<CanQualType, 16> ArgTypes;
Alexey Samsonov3551e312014-08-13 20:06:24 +0000403 for (const auto &Arg : args)
404 ArgTypes.push_back(Context.getCanonicalParamType(Arg.Ty));
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000405
George Burgess IVd0a9e802017-02-23 22:07:35 +0000406 // +1 for implicit this, which should always be args[0].
407 unsigned TotalPrefixArgs = 1 + ExtraPrefixArgs;
408
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000409 CanQual<FunctionProtoType> FPT = GetFormalType(D);
George Burgess IVd0a9e802017-02-23 22:07:35 +0000410 RequiredArgs Required =
411 RequiredArgs::forPrototypePlus(FPT, TotalPrefixArgs + ExtraSuffixArgs, D);
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000412 GlobalDecl GD(D, CtorKind);
David Majnemer0c0b6d92014-10-31 20:09:12 +0000413 CanQualType ResultType = TheCXXABI.HasThisReturn(GD)
414 ? ArgTypes.front()
415 : TheCXXABI.hasMostDerivedReturn(GD)
416 ? CGM.getContext().VoidPtrTy
417 : Context.VoidTy;
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000418
419 FunctionType::ExtInfo Info = FPT->getExtInfo();
George Burgess IVd0a9e802017-02-23 22:07:35 +0000420 llvm::SmallVector<FunctionProtoType::ExtParameterInfo, 16> ParamInfos;
421 // If the prototype args are elided, we should only have ABI-specific args,
422 // which never have param info.
423 if (PassProtoArgs && FPT->hasExtParameterInfos()) {
424 // ABI-specific suffix arguments are treated the same as variadic arguments.
425 addExtParameterInfosForCall(ParamInfos, FPT.getTypePtr(), TotalPrefixArgs,
426 ArgTypes.size());
427 }
Peter Collingbournef7706832014-12-12 23:41:25 +0000428 return arrangeLLVMFunctionInfo(ResultType, /*instanceMethod=*/true,
429 /*chainCall=*/false, ArgTypes, Info,
John McCallc56a8b32016-03-11 04:30:31 +0000430 ParamInfos, Required);
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000431}
432
John McCalla729c622012-02-17 03:33:10 +0000433/// Arrange the argument and result information for the declaration or
434/// definition of the given function.
435const CGFunctionInfo &
436CodeGenTypes::arrangeFunctionDeclaration(const FunctionDecl *FD) {
Chris Lattnerbea5b622009-05-12 20:27:19 +0000437 if (const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(FD))
Anders Carlssonb15b55c2009-04-03 22:48:58 +0000438 if (MD->isInstance())
John McCalla729c622012-02-17 03:33:10 +0000439 return arrangeCXXMethodDeclaration(MD);
Mike Stump11289f42009-09-09 15:08:12 +0000440
John McCall2da83a32010-02-26 00:48:12 +0000441 CanQualType FTy = FD->getType()->getCanonicalTypeUnqualified();
John McCalla729c622012-02-17 03:33:10 +0000442
John McCall2da83a32010-02-26 00:48:12 +0000443 assert(isa<FunctionType>(FTy));
Yaxun Liu6c10a662018-06-12 00:16:33 +0000444 setCUDAKernelCallingConvention(FTy, CGM, FD);
John McCalla729c622012-02-17 03:33:10 +0000445
446 // When declaring a function without a prototype, always use a
447 // non-variadic type.
George Burgess IV35cfca22017-01-06 19:10:48 +0000448 if (CanQual<FunctionNoProtoType> noProto = FTy.getAs<FunctionNoProtoType>()) {
Peter Collingbournef7706832014-12-12 23:41:25 +0000449 return arrangeLLVMFunctionInfo(
450 noProto->getReturnType(), /*instanceMethod=*/false,
John McCallc56a8b32016-03-11 04:30:31 +0000451 /*chainCall=*/false, None, noProto->getExtInfo(), {},RequiredArgs::All);
John McCalla729c622012-02-17 03:33:10 +0000452 }
453
George Burgess IV35cfca22017-01-06 19:10:48 +0000454 return arrangeFreeFunctionType(FTy.castAs<FunctionProtoType>(), FD);
Daniel Dunbar3d7c90b2008-09-08 21:33:45 +0000455}
456
John McCalla729c622012-02-17 03:33:10 +0000457/// Arrange the argument and result information for the declaration or
458/// definition of an Objective-C method.
459const CGFunctionInfo &
460CodeGenTypes::arrangeObjCMethodDeclaration(const ObjCMethodDecl *MD) {
461 // It happens that this is the same as a call with no optional
462 // arguments, except also using the formal 'self' type.
463 return arrangeObjCMessageSendSignature(MD, MD->getSelfDecl()->getType());
464}
465
466/// Arrange the argument and result information for the function type
467/// through which to perform a send to the given Objective-C method,
468/// using the given receiver type. The receiver type is not always
469/// the 'self' type of the method or even an Objective-C pointer type.
470/// This is *not* the right method for actually performing such a
471/// message send, due to the possibility of optional arguments.
472const CGFunctionInfo &
473CodeGenTypes::arrangeObjCMessageSendSignature(const ObjCMethodDecl *MD,
474 QualType receiverType) {
475 SmallVector<CanQualType, 16> argTys;
Akira Hatanaka98a49332017-09-22 00:41:05 +0000476 SmallVector<FunctionProtoType::ExtParameterInfo, 4> extParamInfos(2);
John McCalla729c622012-02-17 03:33:10 +0000477 argTys.push_back(Context.getCanonicalParamType(receiverType));
478 argTys.push_back(Context.getCanonicalParamType(Context.getObjCSelType()));
Daniel Dunbarbf8c24a2009-02-02 23:23:47 +0000479 // FIXME: Kill copy?
David Majnemer59f77922016-06-24 04:05:48 +0000480 for (const auto *I : MD->parameters()) {
Aaron Ballman43b68be2014-03-07 17:50:17 +0000481 argTys.push_back(Context.getCanonicalParamType(I->getType()));
Akira Hatanaka98a49332017-09-22 00:41:05 +0000482 auto extParamInfo = FunctionProtoType::ExtParameterInfo().withIsNoEscape(
483 I->hasAttr<NoEscapeAttr>());
484 extParamInfos.push_back(extParamInfo);
John McCall8ee376f2010-02-24 07:14:12 +0000485 }
John McCall31168b02011-06-15 23:02:42 +0000486
487 FunctionType::ExtInfo einfo;
Aaron Ballman0362a6d2013-12-18 16:23:37 +0000488 bool IsWindows = getContext().getTargetInfo().getTriple().isOSWindows();
489 einfo = einfo.withCallingConv(getCallingConventionForDecl(MD, IsWindows));
John McCall31168b02011-06-15 23:02:42 +0000490
David Blaikiebbafb8a2012-03-11 07:00:24 +0000491 if (getContext().getLangOpts().ObjCAutoRefCount &&
John McCall31168b02011-06-15 23:02:42 +0000492 MD->hasAttr<NSReturnsRetainedAttr>())
493 einfo = einfo.withProducesResult(true);
494
John McCalla729c622012-02-17 03:33:10 +0000495 RequiredArgs required =
496 (MD->isVariadic() ? RequiredArgs(argTys.size()) : RequiredArgs::All);
497
Peter Collingbournef7706832014-12-12 23:41:25 +0000498 return arrangeLLVMFunctionInfo(
499 GetReturnType(MD->getReturnType()), /*instanceMethod=*/false,
Akira Hatanaka98a49332017-09-22 00:41:05 +0000500 /*chainCall=*/false, argTys, einfo, extParamInfos, required);
John McCallc56a8b32016-03-11 04:30:31 +0000501}
502
503const CGFunctionInfo &
504CodeGenTypes::arrangeUnprototypedObjCMessageSend(QualType returnType,
505 const CallArgList &args) {
506 auto argTypes = getArgTypesForCall(Context, args);
507 FunctionType::ExtInfo einfo;
508
509 return arrangeLLVMFunctionInfo(
510 GetReturnType(returnType), /*instanceMethod=*/false,
511 /*chainCall=*/false, argTypes, einfo, {}, RequiredArgs::All);
Daniel Dunbar3d7c90b2008-09-08 21:33:45 +0000512}
513
John McCalla729c622012-02-17 03:33:10 +0000514const CGFunctionInfo &
515CodeGenTypes::arrangeGlobalDeclaration(GlobalDecl GD) {
Anders Carlsson6710c532010-02-06 02:44:09 +0000516 // FIXME: Do we need to handle ObjCMethodDecl?
517 const FunctionDecl *FD = cast<FunctionDecl>(GD.getDecl());
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000518
Anders Carlsson6710c532010-02-06 02:44:09 +0000519 if (const CXXConstructorDecl *CD = dyn_cast<CXXConstructorDecl>(FD))
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000520 return arrangeCXXStructorDeclaration(CD, getFromCtorType(GD.getCtorType()));
Anders Carlsson6710c532010-02-06 02:44:09 +0000521
522 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(FD))
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000523 return arrangeCXXStructorDeclaration(DD, getFromDtorType(GD.getDtorType()));
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000524
John McCalla729c622012-02-17 03:33:10 +0000525 return arrangeFunctionDeclaration(FD);
Anders Carlsson6710c532010-02-06 02:44:09 +0000526}
527
Reid Klecknerc3473512014-08-29 21:43:29 +0000528/// Arrange a thunk that takes 'this' as the first parameter followed by
529/// varargs. Return a void pointer, regardless of the actual return type.
530/// The body of the thunk will end in a musttail call to a function of the
531/// correct type, and the caller will bitcast the function to the correct
532/// prototype.
533const CGFunctionInfo &
Reid Kleckner399d96e2018-04-02 20:20:33 +0000534CodeGenTypes::arrangeUnprototypedMustTailThunk(const CXXMethodDecl *MD) {
535 assert(MD->isVirtual() && "only methods have thunks");
Reid Klecknerc3473512014-08-29 21:43:29 +0000536 CanQual<FunctionProtoType> FTP = GetFormalType(MD);
Mikael Nilsson9d2872d2018-12-13 10:15:27 +0000537 CanQualType ArgTys[] = { GetThisType(Context, MD->getParent(), MD) };
Peter Collingbournef7706832014-12-12 23:41:25 +0000538 return arrangeLLVMFunctionInfo(Context.VoidTy, /*instanceMethod=*/false,
539 /*chainCall=*/false, ArgTys,
John McCallc56a8b32016-03-11 04:30:31 +0000540 FTP->getExtInfo(), {}, RequiredArgs(1));
Reid Klecknerc3473512014-08-29 21:43:29 +0000541}
542
David Majnemerdfa6d202015-03-11 18:36:39 +0000543const CGFunctionInfo &
David Majnemer37fd66e2015-03-13 22:36:55 +0000544CodeGenTypes::arrangeMSCtorClosure(const CXXConstructorDecl *CD,
545 CXXCtorType CT) {
546 assert(CT == Ctor_CopyingClosure || CT == Ctor_DefaultClosure);
547
David Majnemerdfa6d202015-03-11 18:36:39 +0000548 CanQual<FunctionProtoType> FTP = GetFormalType(CD);
549 SmallVector<CanQualType, 2> ArgTys;
550 const CXXRecordDecl *RD = CD->getParent();
Mikael Nilsson9d2872d2018-12-13 10:15:27 +0000551 ArgTys.push_back(GetThisType(Context, RD, CD));
David Majnemer37fd66e2015-03-13 22:36:55 +0000552 if (CT == Ctor_CopyingClosure)
553 ArgTys.push_back(*FTP->param_type_begin());
David Majnemerdfa6d202015-03-11 18:36:39 +0000554 if (RD->getNumVBases() > 0)
555 ArgTys.push_back(Context.IntTy);
556 CallingConv CC = Context.getDefaultCallingConvention(
557 /*IsVariadic=*/false, /*IsCXXMethod=*/true);
558 return arrangeLLVMFunctionInfo(Context.VoidTy, /*instanceMethod=*/true,
559 /*chainCall=*/false, ArgTys,
John McCallc56a8b32016-03-11 04:30:31 +0000560 FunctionType::ExtInfo(CC), {},
561 RequiredArgs::All);
David Majnemerdfa6d202015-03-11 18:36:39 +0000562}
563
John McCallc818bbb2012-12-07 07:03:17 +0000564/// Arrange a call as unto a free function, except possibly with an
565/// additional number of formal parameters considered required.
566static const CGFunctionInfo &
567arrangeFreeFunctionLikeCall(CodeGenTypes &CGT,
Mark Lacey23455752013-10-10 20:57:00 +0000568 CodeGenModule &CGM,
John McCallc818bbb2012-12-07 07:03:17 +0000569 const CallArgList &args,
570 const FunctionType *fnType,
Peter Collingbournef7706832014-12-12 23:41:25 +0000571 unsigned numExtraRequiredArgs,
572 bool chainCall) {
John McCallc818bbb2012-12-07 07:03:17 +0000573 assert(args.size() >= numExtraRequiredArgs);
574
John McCallc56a8b32016-03-11 04:30:31 +0000575 llvm::SmallVector<FunctionProtoType::ExtParameterInfo, 16> paramInfos;
576
John McCallc818bbb2012-12-07 07:03:17 +0000577 // In most cases, there are no optional arguments.
578 RequiredArgs required = RequiredArgs::All;
579
580 // If we have a variadic prototype, the required arguments are the
581 // extra prefix plus the arguments in the prototype.
582 if (const FunctionProtoType *proto = dyn_cast<FunctionProtoType>(fnType)) {
583 if (proto->isVariadic())
Alp Toker9cacbab2014-01-20 20:26:09 +0000584 required = RequiredArgs(proto->getNumParams() + numExtraRequiredArgs);
John McCallc818bbb2012-12-07 07:03:17 +0000585
John McCallc56a8b32016-03-11 04:30:31 +0000586 if (proto->hasExtParameterInfos())
587 addExtParameterInfosForCall(paramInfos, proto, numExtraRequiredArgs,
588 args.size());
589
John McCallc818bbb2012-12-07 07:03:17 +0000590 // If we don't have a prototype at all, but we're supposed to
591 // explicitly use the variadic convention for unprototyped calls,
592 // treat all of the arguments as required but preserve the nominal
593 // possibility of variadics.
Mark Lacey23455752013-10-10 20:57:00 +0000594 } else if (CGM.getTargetCodeGenInfo()
595 .isNoProtoCallVariadic(args,
596 cast<FunctionNoProtoType>(fnType))) {
John McCallc818bbb2012-12-07 07:03:17 +0000597 required = RequiredArgs(args.size());
598 }
599
Peter Collingbournef7706832014-12-12 23:41:25 +0000600 // FIXME: Kill copy.
601 SmallVector<CanQualType, 16> argTypes;
602 for (const auto &arg : args)
603 argTypes.push_back(CGT.getContext().getCanonicalParamType(arg.Ty));
604 return CGT.arrangeLLVMFunctionInfo(GetReturnType(fnType->getReturnType()),
605 /*instanceMethod=*/false, chainCall,
John McCallc56a8b32016-03-11 04:30:31 +0000606 argTypes, fnType->getExtInfo(), paramInfos,
607 required);
John McCallc818bbb2012-12-07 07:03:17 +0000608}
609
John McCalla729c622012-02-17 03:33:10 +0000610/// Figure out the rules for calling a function with the given formal
611/// type using the given arguments. The arguments are necessary
612/// because the function might be unprototyped, in which case it's
613/// target-dependent in crazy ways.
614const CGFunctionInfo &
John McCall8dda7b22012-07-07 06:41:13 +0000615CodeGenTypes::arrangeFreeFunctionCall(const CallArgList &args,
Peter Collingbournef7706832014-12-12 23:41:25 +0000616 const FunctionType *fnType,
617 bool chainCall) {
618 return arrangeFreeFunctionLikeCall(*this, CGM, args, fnType,
619 chainCall ? 1 : 0, chainCall);
John McCallc818bbb2012-12-07 07:03:17 +0000620}
John McCalla729c622012-02-17 03:33:10 +0000621
John McCallc56a8b32016-03-11 04:30:31 +0000622/// A block function is essentially a free function with an
John McCallc818bbb2012-12-07 07:03:17 +0000623/// extra implicit argument.
624const CGFunctionInfo &
625CodeGenTypes::arrangeBlockFunctionCall(const CallArgList &args,
626 const FunctionType *fnType) {
Peter Collingbournef7706832014-12-12 23:41:25 +0000627 return arrangeFreeFunctionLikeCall(*this, CGM, args, fnType, 1,
628 /*chainCall=*/false);
John McCalla729c622012-02-17 03:33:10 +0000629}
630
631const CGFunctionInfo &
John McCallc56a8b32016-03-11 04:30:31 +0000632CodeGenTypes::arrangeBlockFunctionDeclaration(const FunctionProtoType *proto,
633 const FunctionArgList &params) {
634 auto paramInfos = getExtParameterInfosForCall(proto, 1, params.size());
635 auto argTypes = getArgTypesForDeclaration(Context, params);
636
George Burgess IV419996c2016-06-16 23:06:04 +0000637 return arrangeLLVMFunctionInfo(
638 GetReturnType(proto->getReturnType()),
639 /*instanceMethod*/ false, /*chainCall*/ false, argTypes,
640 proto->getExtInfo(), paramInfos,
641 RequiredArgs::forPrototypePlus(proto, 1, nullptr));
John McCallc56a8b32016-03-11 04:30:31 +0000642}
643
644const CGFunctionInfo &
645CodeGenTypes::arrangeBuiltinFunctionCall(QualType resultType,
646 const CallArgList &args) {
Daniel Dunbarbf8c24a2009-02-02 23:23:47 +0000647 // FIXME: Kill copy.
John McCalla729c622012-02-17 03:33:10 +0000648 SmallVector<CanQualType, 16> argTypes;
Alexey Samsonov3551e312014-08-13 20:06:24 +0000649 for (const auto &Arg : args)
650 argTypes.push_back(Context.getCanonicalParamType(Arg.Ty));
Peter Collingbournef7706832014-12-12 23:41:25 +0000651 return arrangeLLVMFunctionInfo(
652 GetReturnType(resultType), /*instanceMethod=*/false,
John McCallc56a8b32016-03-11 04:30:31 +0000653 /*chainCall=*/false, argTypes, FunctionType::ExtInfo(),
654 /*paramInfos=*/ {}, RequiredArgs::All);
John McCall8dda7b22012-07-07 06:41:13 +0000655}
656
John McCallc56a8b32016-03-11 04:30:31 +0000657const CGFunctionInfo &
658CodeGenTypes::arrangeBuiltinFunctionDeclaration(QualType resultType,
659 const FunctionArgList &args) {
660 auto argTypes = getArgTypesForDeclaration(Context, args);
661
662 return arrangeLLVMFunctionInfo(
663 GetReturnType(resultType), /*instanceMethod=*/false, /*chainCall=*/false,
664 argTypes, FunctionType::ExtInfo(), {}, RequiredArgs::All);
665}
666
667const CGFunctionInfo &
668CodeGenTypes::arrangeBuiltinFunctionDeclaration(CanQualType resultType,
669 ArrayRef<CanQualType> argTypes) {
670 return arrangeLLVMFunctionInfo(
671 resultType, /*instanceMethod=*/false, /*chainCall=*/false,
672 argTypes, FunctionType::ExtInfo(), {}, RequiredArgs::All);
673}
674
John McCall8dda7b22012-07-07 06:41:13 +0000675/// Arrange a call to a C++ method, passing the given arguments.
George Burgess IVd0a9e802017-02-23 22:07:35 +0000676///
677/// numPrefixArgs is the number of ABI-specific prefix arguments we have. It
678/// does not count `this`.
John McCall8dda7b22012-07-07 06:41:13 +0000679const CGFunctionInfo &
680CodeGenTypes::arrangeCXXMethodCall(const CallArgList &args,
John McCallc56a8b32016-03-11 04:30:31 +0000681 const FunctionProtoType *proto,
George Burgess IVd0a9e802017-02-23 22:07:35 +0000682 RequiredArgs required,
683 unsigned numPrefixArgs) {
684 assert(numPrefixArgs + 1 <= args.size() &&
685 "Emitting a call with less args than the required prefix?");
686 // Add one to account for `this`. It's a bit awkward here, but we don't count
687 // `this` in similar places elsewhere.
John McCallc56a8b32016-03-11 04:30:31 +0000688 auto paramInfos =
George Burgess IVd0a9e802017-02-23 22:07:35 +0000689 getExtParameterInfosForCall(proto, numPrefixArgs + 1, args.size());
John McCallc56a8b32016-03-11 04:30:31 +0000690
John McCall8dda7b22012-07-07 06:41:13 +0000691 // FIXME: Kill copy.
John McCallc56a8b32016-03-11 04:30:31 +0000692 auto argTypes = getArgTypesForCall(Context, args);
John McCall8dda7b22012-07-07 06:41:13 +0000693
John McCallc56a8b32016-03-11 04:30:31 +0000694 FunctionType::ExtInfo info = proto->getExtInfo();
Peter Collingbournef7706832014-12-12 23:41:25 +0000695 return arrangeLLVMFunctionInfo(
John McCallc56a8b32016-03-11 04:30:31 +0000696 GetReturnType(proto->getReturnType()), /*instanceMethod=*/true,
697 /*chainCall=*/false, argTypes, info, paramInfos, required);
Daniel Dunbarbf8c24a2009-02-02 23:23:47 +0000698}
699
John McCalla729c622012-02-17 03:33:10 +0000700const CGFunctionInfo &CodeGenTypes::arrangeNullaryFunction() {
Peter Collingbournef7706832014-12-12 23:41:25 +0000701 return arrangeLLVMFunctionInfo(
702 getContext().VoidTy, /*instanceMethod=*/false, /*chainCall=*/false,
John McCallc56a8b32016-03-11 04:30:31 +0000703 None, FunctionType::ExtInfo(), {}, RequiredArgs::All);
704}
705
706const CGFunctionInfo &
707CodeGenTypes::arrangeCall(const CGFunctionInfo &signature,
708 const CallArgList &args) {
709 assert(signature.arg_size() <= args.size());
710 if (signature.arg_size() == args.size())
711 return signature;
712
713 SmallVector<FunctionProtoType::ExtParameterInfo, 16> paramInfos;
714 auto sigParamInfos = signature.getExtParameterInfos();
715 if (!sigParamInfos.empty()) {
716 paramInfos.append(sigParamInfos.begin(), sigParamInfos.end());
717 paramInfos.resize(args.size());
718 }
719
720 auto argTypes = getArgTypesForCall(Context, args);
721
722 assert(signature.getRequiredArgs().allowsOptionalArgs());
723 return arrangeLLVMFunctionInfo(signature.getReturnType(),
724 signature.isInstanceMethod(),
725 signature.isChainCall(),
726 argTypes,
727 signature.getExtInfo(),
728 paramInfos,
729 signature.getRequiredArgs());
John McCalla738c252011-03-09 04:27:21 +0000730}
731
Pekka Jaaskelainenfc2629a2017-06-01 07:18:49 +0000732namespace clang {
733namespace CodeGen {
734void computeSPIRKernelABIInfo(CodeGenModule &CGM, CGFunctionInfo &FI);
735}
736}
737
John McCalla729c622012-02-17 03:33:10 +0000738/// Arrange the argument and result information for an abstract value
739/// of a given function type. This is the method which all of the
740/// above functions ultimately defer to.
741const CGFunctionInfo &
John McCall8dda7b22012-07-07 06:41:13 +0000742CodeGenTypes::arrangeLLVMFunctionInfo(CanQualType resultType,
Peter Collingbournef7706832014-12-12 23:41:25 +0000743 bool instanceMethod,
744 bool chainCall,
John McCall8dda7b22012-07-07 06:41:13 +0000745 ArrayRef<CanQualType> argTypes,
746 FunctionType::ExtInfo info,
John McCallc56a8b32016-03-11 04:30:31 +0000747 ArrayRef<FunctionProtoType::ExtParameterInfo> paramInfos,
John McCall8dda7b22012-07-07 06:41:13 +0000748 RequiredArgs required) {
Fangrui Song3117b172018-10-20 17:53:42 +0000749 assert(llvm::all_of(argTypes,
750 [](CanQualType T) { return T.isCanonicalAsParam(); }));
John McCall2da83a32010-02-26 00:48:12 +0000751
Daniel Dunbare0be8292009-02-03 00:07:12 +0000752 // Lookup or create unique function info.
753 llvm::FoldingSetNodeID ID;
John McCallc56a8b32016-03-11 04:30:31 +0000754 CGFunctionInfo::Profile(ID, instanceMethod, chainCall, info, paramInfos,
755 required, resultType, argTypes);
Daniel Dunbare0be8292009-02-03 00:07:12 +0000756
Craig Topper8a13c412014-05-21 05:09:00 +0000757 void *insertPos = nullptr;
John McCalla729c622012-02-17 03:33:10 +0000758 CGFunctionInfo *FI = FunctionInfos.FindNodeOrInsertPos(ID, insertPos);
Daniel Dunbare0be8292009-02-03 00:07:12 +0000759 if (FI)
760 return *FI;
761
John McCallc56a8b32016-03-11 04:30:31 +0000762 unsigned CC = ClangCallConvToLLVMCallConv(info.getCC());
763
John McCalla729c622012-02-17 03:33:10 +0000764 // Construct the function info. We co-allocate the ArgInfos.
Peter Collingbournef7706832014-12-12 23:41:25 +0000765 FI = CGFunctionInfo::create(CC, instanceMethod, chainCall, info,
John McCallc56a8b32016-03-11 04:30:31 +0000766 paramInfos, resultType, argTypes, required);
John McCalla729c622012-02-17 03:33:10 +0000767 FunctionInfos.InsertNode(FI, insertPos);
Daniel Dunbar313321e2009-02-03 05:31:23 +0000768
David Blaikie82e95a32014-11-19 07:49:47 +0000769 bool inserted = FunctionsBeingProcessed.insert(FI).second;
770 (void)inserted;
John McCalla729c622012-02-17 03:33:10 +0000771 assert(inserted && "Recursively being processed?");
Pekka Jaaskelainenfc2629a2017-06-01 07:18:49 +0000772
Daniel Dunbar313321e2009-02-03 05:31:23 +0000773 // Compute ABI information.
Pekka Jaaskelainenfc2629a2017-06-01 07:18:49 +0000774 if (CC == llvm::CallingConv::SPIR_KERNEL) {
775 // Force target independent argument handling for the host visible
776 // kernel functions.
777 computeSPIRKernelABIInfo(CGM, *FI);
778 } else if (info.getCC() == CC_Swift) {
John McCall12f23522016-04-04 18:33:08 +0000779 swiftcall::computeABIInfo(CGM, *FI);
Pekka Jaaskelainenfc2629a2017-06-01 07:18:49 +0000780 } else {
781 getABIInfo().computeInfo(*FI);
John McCall12f23522016-04-04 18:33:08 +0000782 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000783
Chris Lattnerfe34c1d2010-07-29 06:26:06 +0000784 // Loop over all of the computed argument and return value info. If any of
785 // them are direct or extend without a specified coerce type, specify the
786 // default now.
John McCalla729c622012-02-17 03:33:10 +0000787 ABIArgInfo &retInfo = FI->getReturnInfo();
Craig Topper8a13c412014-05-21 05:09:00 +0000788 if (retInfo.canHaveCoerceToType() && retInfo.getCoerceToType() == nullptr)
John McCalla729c622012-02-17 03:33:10 +0000789 retInfo.setCoerceToType(ConvertType(FI->getReturnType()));
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000790
Aaron Ballmanec47bc22014-03-17 18:10:01 +0000791 for (auto &I : FI->arguments())
Craig Topper8a13c412014-05-21 05:09:00 +0000792 if (I.info.canHaveCoerceToType() && I.info.getCoerceToType() == nullptr)
Aaron Ballmanec47bc22014-03-17 18:10:01 +0000793 I.info.setCoerceToType(ConvertType(I.type));
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000794
John McCalla729c622012-02-17 03:33:10 +0000795 bool erased = FunctionsBeingProcessed.erase(FI); (void)erased;
796 assert(erased && "Not in set?");
Fangrui Song6907ce22018-07-30 19:24:48 +0000797
Daniel Dunbare0be8292009-02-03 00:07:12 +0000798 return *FI;
Daniel Dunbarbf8c24a2009-02-02 23:23:47 +0000799}
800
John McCalla729c622012-02-17 03:33:10 +0000801CGFunctionInfo *CGFunctionInfo::create(unsigned llvmCC,
Peter Collingbournef7706832014-12-12 23:41:25 +0000802 bool instanceMethod,
803 bool chainCall,
John McCalla729c622012-02-17 03:33:10 +0000804 const FunctionType::ExtInfo &info,
John McCallc56a8b32016-03-11 04:30:31 +0000805 ArrayRef<ExtParameterInfo> paramInfos,
John McCalla729c622012-02-17 03:33:10 +0000806 CanQualType resultType,
807 ArrayRef<CanQualType> argTypes,
808 RequiredArgs required) {
John McCallc56a8b32016-03-11 04:30:31 +0000809 assert(paramInfos.empty() || paramInfos.size() == argTypes.size());
810
811 void *buffer =
812 operator new(totalSizeToAlloc<ArgInfo, ExtParameterInfo>(
813 argTypes.size() + 1, paramInfos.size()));
814
John McCalla729c622012-02-17 03:33:10 +0000815 CGFunctionInfo *FI = new(buffer) CGFunctionInfo();
816 FI->CallingConvention = llvmCC;
817 FI->EffectiveCallingConvention = llvmCC;
818 FI->ASTCallingConvention = info.getCC();
Peter Collingbournef7706832014-12-12 23:41:25 +0000819 FI->InstanceMethod = instanceMethod;
820 FI->ChainCall = chainCall;
John McCalla729c622012-02-17 03:33:10 +0000821 FI->NoReturn = info.getNoReturn();
822 FI->ReturnsRetained = info.getProducesResult();
Oren Ben Simhon318a6ea2017-04-27 12:01:00 +0000823 FI->NoCallerSavedRegs = info.getNoCallerSavedRegs();
Oren Ben Simhon220671a2018-03-17 13:31:35 +0000824 FI->NoCfCheck = info.getNoCfCheck();
John McCalla729c622012-02-17 03:33:10 +0000825 FI->Required = required;
826 FI->HasRegParm = info.getHasRegParm();
827 FI->RegParm = info.getRegParm();
Craig Topper8a13c412014-05-21 05:09:00 +0000828 FI->ArgStruct = nullptr;
John McCall7f416cc2015-09-08 08:05:57 +0000829 FI->ArgStructAlign = 0;
John McCalla729c622012-02-17 03:33:10 +0000830 FI->NumArgs = argTypes.size();
John McCallc56a8b32016-03-11 04:30:31 +0000831 FI->HasExtParameterInfos = !paramInfos.empty();
John McCalla729c622012-02-17 03:33:10 +0000832 FI->getArgsBuffer()[0].type = resultType;
833 for (unsigned i = 0, e = argTypes.size(); i != e; ++i)
834 FI->getArgsBuffer()[i + 1].type = argTypes[i];
John McCallc56a8b32016-03-11 04:30:31 +0000835 for (unsigned i = 0, e = paramInfos.size(); i != e; ++i)
836 FI->getExtParameterInfosBuffer()[i] = paramInfos[i];
John McCalla729c622012-02-17 03:33:10 +0000837 return FI;
Daniel Dunbar313321e2009-02-03 05:31:23 +0000838}
839
840/***/
841
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000842namespace {
843// ABIArgInfo::Expand implementation.
844
845// Specifies the way QualType passed as ABIArgInfo::Expand is expanded.
846struct TypeExpansion {
847 enum TypeExpansionKind {
848 // Elements of constant arrays are expanded recursively.
849 TEK_ConstantArray,
850 // Record fields are expanded recursively (but if record is a union, only
851 // the field with the largest size is expanded).
852 TEK_Record,
853 // For complex types, real and imaginary parts are expanded recursively.
854 TEK_Complex,
855 // All other types are not expandable.
856 TEK_None
857 };
858
859 const TypeExpansionKind Kind;
860
861 TypeExpansion(TypeExpansionKind K) : Kind(K) {}
Angel Garcia Gomez637d1e62015-10-20 13:23:58 +0000862 virtual ~TypeExpansion() {}
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000863};
864
865struct ConstantArrayExpansion : TypeExpansion {
866 QualType EltTy;
867 uint64_t NumElts;
868
869 ConstantArrayExpansion(QualType EltTy, uint64_t NumElts)
870 : TypeExpansion(TEK_ConstantArray), EltTy(EltTy), NumElts(NumElts) {}
871 static bool classof(const TypeExpansion *TE) {
872 return TE->Kind == TEK_ConstantArray;
873 }
874};
875
876struct RecordExpansion : TypeExpansion {
Reid Klecknere9f6a712014-10-31 17:10:41 +0000877 SmallVector<const CXXBaseSpecifier *, 1> Bases;
878
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000879 SmallVector<const FieldDecl *, 1> Fields;
880
Reid Klecknere9f6a712014-10-31 17:10:41 +0000881 RecordExpansion(SmallVector<const CXXBaseSpecifier *, 1> &&Bases,
882 SmallVector<const FieldDecl *, 1> &&Fields)
Benjamin Kramer0bb97742016-02-13 16:00:13 +0000883 : TypeExpansion(TEK_Record), Bases(std::move(Bases)),
884 Fields(std::move(Fields)) {}
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000885 static bool classof(const TypeExpansion *TE) {
886 return TE->Kind == TEK_Record;
887 }
888};
889
890struct ComplexExpansion : TypeExpansion {
891 QualType EltTy;
892
893 ComplexExpansion(QualType EltTy) : TypeExpansion(TEK_Complex), EltTy(EltTy) {}
894 static bool classof(const TypeExpansion *TE) {
895 return TE->Kind == TEK_Complex;
896 }
897};
898
899struct NoExpansion : TypeExpansion {
900 NoExpansion() : TypeExpansion(TEK_None) {}
901 static bool classof(const TypeExpansion *TE) {
902 return TE->Kind == TEK_None;
903 }
904};
905} // namespace
906
907static std::unique_ptr<TypeExpansion>
908getTypeExpansion(QualType Ty, const ASTContext &Context) {
909 if (const ConstantArrayType *AT = Context.getAsConstantArrayType(Ty)) {
910 return llvm::make_unique<ConstantArrayExpansion>(
911 AT->getElementType(), AT->getSize().getZExtValue());
912 }
913 if (const RecordType *RT = Ty->getAs<RecordType>()) {
Reid Klecknere9f6a712014-10-31 17:10:41 +0000914 SmallVector<const CXXBaseSpecifier *, 1> Bases;
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000915 SmallVector<const FieldDecl *, 1> Fields;
Bob Wilsone826a2a2011-08-03 05:58:22 +0000916 const RecordDecl *RD = RT->getDecl();
917 assert(!RD->hasFlexibleArrayMember() &&
918 "Cannot expand structure with flexible array.");
Anton Korobeynikov4215ca72012-04-13 11:22:00 +0000919 if (RD->isUnion()) {
920 // Unions can be here only in degenerative cases - all the fields are same
921 // after flattening. Thus we have to use the "largest" field.
Craig Topper8a13c412014-05-21 05:09:00 +0000922 const FieldDecl *LargestFD = nullptr;
Anton Korobeynikov4215ca72012-04-13 11:22:00 +0000923 CharUnits UnionSize = CharUnits::Zero();
924
Aaron Ballmane8a8bae2014-03-08 20:12:42 +0000925 for (const auto *FD : RD->fields()) {
Richard Smith866dee42018-04-02 18:29:43 +0000926 if (FD->isZeroLengthBitField(Context))
Reid Kleckner80944df2014-10-31 22:00:51 +0000927 continue;
Anton Korobeynikov4215ca72012-04-13 11:22:00 +0000928 assert(!FD->isBitField() &&
929 "Cannot expand structure with bit-field members.");
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000930 CharUnits FieldSize = Context.getTypeSizeInChars(FD->getType());
Anton Korobeynikov4215ca72012-04-13 11:22:00 +0000931 if (UnionSize < FieldSize) {
932 UnionSize = FieldSize;
933 LargestFD = FD;
934 }
935 }
936 if (LargestFD)
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000937 Fields.push_back(LargestFD);
Anton Korobeynikov4215ca72012-04-13 11:22:00 +0000938 } else {
Reid Klecknere9f6a712014-10-31 17:10:41 +0000939 if (const auto *CXXRD = dyn_cast<CXXRecordDecl>(RD)) {
940 assert(!CXXRD->isDynamicClass() &&
941 "cannot expand vtable pointers in dynamic classes");
942 for (const CXXBaseSpecifier &BS : CXXRD->bases())
943 Bases.push_back(&BS);
944 }
945
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000946 for (const auto *FD : RD->fields()) {
Richard Smith866dee42018-04-02 18:29:43 +0000947 if (FD->isZeroLengthBitField(Context))
Reid Kleckner80944df2014-10-31 22:00:51 +0000948 continue;
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000949 assert(!FD->isBitField() &&
Anton Korobeynikov4215ca72012-04-13 11:22:00 +0000950 "Cannot expand structure with bit-field members.");
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000951 Fields.push_back(FD);
Anton Korobeynikov4215ca72012-04-13 11:22:00 +0000952 }
Bob Wilsone826a2a2011-08-03 05:58:22 +0000953 }
Reid Klecknere9f6a712014-10-31 17:10:41 +0000954 return llvm::make_unique<RecordExpansion>(std::move(Bases),
955 std::move(Fields));
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000956 }
957 if (const ComplexType *CT = Ty->getAs<ComplexType>()) {
958 return llvm::make_unique<ComplexExpansion>(CT->getElementType());
959 }
960 return llvm::make_unique<NoExpansion>();
961}
962
Alexey Samsonov52c0f6a2014-09-29 20:30:22 +0000963static int getExpansionSize(QualType Ty, const ASTContext &Context) {
964 auto Exp = getTypeExpansion(Ty, Context);
965 if (auto CAExp = dyn_cast<ConstantArrayExpansion>(Exp.get())) {
966 return CAExp->NumElts * getExpansionSize(CAExp->EltTy, Context);
967 }
968 if (auto RExp = dyn_cast<RecordExpansion>(Exp.get())) {
969 int Res = 0;
Reid Klecknere9f6a712014-10-31 17:10:41 +0000970 for (auto BS : RExp->Bases)
971 Res += getExpansionSize(BS->getType(), Context);
Alexey Samsonov52c0f6a2014-09-29 20:30:22 +0000972 for (auto FD : RExp->Fields)
973 Res += getExpansionSize(FD->getType(), Context);
974 return Res;
975 }
976 if (isa<ComplexExpansion>(Exp.get()))
977 return 2;
978 assert(isa<NoExpansion>(Exp.get()));
979 return 1;
980}
981
Alexey Samsonov153004f2014-09-29 22:08:00 +0000982void
983CodeGenTypes::getExpandedTypes(QualType Ty,
984 SmallVectorImpl<llvm::Type *>::iterator &TI) {
985 auto Exp = getTypeExpansion(Ty, Context);
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000986 if (auto CAExp = dyn_cast<ConstantArrayExpansion>(Exp.get())) {
987 for (int i = 0, n = CAExp->NumElts; i < n; i++) {
Alexey Samsonov153004f2014-09-29 22:08:00 +0000988 getExpandedTypes(CAExp->EltTy, TI);
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000989 }
990 } else if (auto RExp = dyn_cast<RecordExpansion>(Exp.get())) {
Reid Klecknere9f6a712014-10-31 17:10:41 +0000991 for (auto BS : RExp->Bases)
992 getExpandedTypes(BS->getType(), TI);
993 for (auto FD : RExp->Fields)
Alexey Samsonov153004f2014-09-29 22:08:00 +0000994 getExpandedTypes(FD->getType(), TI);
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000995 } else if (auto CExp = dyn_cast<ComplexExpansion>(Exp.get())) {
996 llvm::Type *EltTy = ConvertType(CExp->EltTy);
Alexey Samsonov153004f2014-09-29 22:08:00 +0000997 *TI++ = EltTy;
998 *TI++ = EltTy;
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000999 } else {
1000 assert(isa<NoExpansion>(Exp.get()));
Alexey Samsonov153004f2014-09-29 22:08:00 +00001001 *TI++ = ConvertType(Ty);
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001002 }
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00001003}
1004
John McCall7f416cc2015-09-08 08:05:57 +00001005static void forConstantArrayExpansion(CodeGenFunction &CGF,
1006 ConstantArrayExpansion *CAE,
1007 Address BaseAddr,
1008 llvm::function_ref<void(Address)> Fn) {
1009 CharUnits EltSize = CGF.getContext().getTypeSizeInChars(CAE->EltTy);
1010 CharUnits EltAlign =
1011 BaseAddr.getAlignment().alignmentOfArrayElement(EltSize);
1012
1013 for (int i = 0, n = CAE->NumElts; i < n; i++) {
1014 llvm::Value *EltAddr =
1015 CGF.Builder.CreateConstGEP2_32(nullptr, BaseAddr.getPointer(), 0, i);
1016 Fn(Address(EltAddr, EltAlign));
1017 }
1018}
1019
Alexey Samsonov91cf4552014-08-22 01:06:06 +00001020void CodeGenFunction::ExpandTypeFromArgs(
John McCall12f23522016-04-04 18:33:08 +00001021 QualType Ty, LValue LV, SmallVectorImpl<llvm::Value *>::iterator &AI) {
Mike Stump11289f42009-09-09 15:08:12 +00001022 assert(LV.isSimple() &&
1023 "Unexpected non-simple lvalue during struct expansion.");
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00001024
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001025 auto Exp = getTypeExpansion(Ty, getContext());
1026 if (auto CAExp = dyn_cast<ConstantArrayExpansion>(Exp.get())) {
John McCall7f416cc2015-09-08 08:05:57 +00001027 forConstantArrayExpansion(*this, CAExp, LV.getAddress(),
1028 [&](Address EltAddr) {
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001029 LValue LV = MakeAddrLValue(EltAddr, CAExp->EltTy);
1030 ExpandTypeFromArgs(CAExp->EltTy, LV, AI);
John McCall7f416cc2015-09-08 08:05:57 +00001031 });
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001032 } else if (auto RExp = dyn_cast<RecordExpansion>(Exp.get())) {
John McCall7f416cc2015-09-08 08:05:57 +00001033 Address This = LV.getAddress();
Reid Klecknere9f6a712014-10-31 17:10:41 +00001034 for (const CXXBaseSpecifier *BS : RExp->Bases) {
1035 // Perform a single step derived-to-base conversion.
John McCall7f416cc2015-09-08 08:05:57 +00001036 Address Base =
Reid Klecknere9f6a712014-10-31 17:10:41 +00001037 GetAddressOfBaseClass(This, Ty->getAsCXXRecordDecl(), &BS, &BS + 1,
1038 /*NullCheckValue=*/false, SourceLocation());
1039 LValue SubLV = MakeAddrLValue(Base, BS->getType());
1040
1041 // Recurse onto bases.
1042 ExpandTypeFromArgs(BS->getType(), SubLV, AI);
1043 }
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001044 for (auto FD : RExp->Fields) {
1045 // FIXME: What are the right qualifiers here?
Reid Kleckner9d031092016-05-02 22:42:34 +00001046 LValue SubLV = EmitLValueForFieldInitialization(LV, FD);
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001047 ExpandTypeFromArgs(FD->getType(), SubLV, AI);
Bob Wilsone826a2a2011-08-03 05:58:22 +00001048 }
John McCall7f416cc2015-09-08 08:05:57 +00001049 } else if (isa<ComplexExpansion>(Exp.get())) {
1050 auto realValue = *AI++;
1051 auto imagValue = *AI++;
1052 EmitStoreOfComplex(ComplexPairTy(realValue, imagValue), LV, /*init*/ true);
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001053 } else {
1054 assert(isa<NoExpansion>(Exp.get()));
1055 EmitStoreThroughLValue(RValue::get(*AI++), LV);
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00001056 }
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001057}
1058
1059void CodeGenFunction::ExpandTypeToArgs(
Yaxun Liu5b330e82018-03-15 15:25:19 +00001060 QualType Ty, CallArg Arg, llvm::FunctionType *IRFuncTy,
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001061 SmallVectorImpl<llvm::Value *> &IRCallArgs, unsigned &IRCallArgPos) {
1062 auto Exp = getTypeExpansion(Ty, getContext());
1063 if (auto CAExp = dyn_cast<ConstantArrayExpansion>(Exp.get())) {
Yaxun Liu5b330e82018-03-15 15:25:19 +00001064 Address Addr = Arg.hasLValue() ? Arg.getKnownLValue().getAddress()
1065 : Arg.getKnownRValue().getAggregateAddress();
1066 forConstantArrayExpansion(
1067 *this, CAExp, Addr, [&](Address EltAddr) {
1068 CallArg EltArg = CallArg(
1069 convertTempToRValue(EltAddr, CAExp->EltTy, SourceLocation()),
1070 CAExp->EltTy);
1071 ExpandTypeToArgs(CAExp->EltTy, EltArg, IRFuncTy, IRCallArgs,
1072 IRCallArgPos);
1073 });
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001074 } else if (auto RExp = dyn_cast<RecordExpansion>(Exp.get())) {
Yaxun Liu5b330e82018-03-15 15:25:19 +00001075 Address This = Arg.hasLValue() ? Arg.getKnownLValue().getAddress()
1076 : Arg.getKnownRValue().getAggregateAddress();
Reid Klecknere9f6a712014-10-31 17:10:41 +00001077 for (const CXXBaseSpecifier *BS : RExp->Bases) {
1078 // Perform a single step derived-to-base conversion.
John McCall7f416cc2015-09-08 08:05:57 +00001079 Address Base =
Reid Klecknere9f6a712014-10-31 17:10:41 +00001080 GetAddressOfBaseClass(This, Ty->getAsCXXRecordDecl(), &BS, &BS + 1,
1081 /*NullCheckValue=*/false, SourceLocation());
Yaxun Liu5b330e82018-03-15 15:25:19 +00001082 CallArg BaseArg = CallArg(RValue::getAggregate(Base), BS->getType());
Reid Klecknere9f6a712014-10-31 17:10:41 +00001083
1084 // Recurse onto bases.
Yaxun Liu5b330e82018-03-15 15:25:19 +00001085 ExpandTypeToArgs(BS->getType(), BaseArg, IRFuncTy, IRCallArgs,
Reid Klecknere9f6a712014-10-31 17:10:41 +00001086 IRCallArgPos);
1087 }
1088
1089 LValue LV = MakeAddrLValue(This, Ty);
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001090 for (auto FD : RExp->Fields) {
Yaxun Liu5b330e82018-03-15 15:25:19 +00001091 CallArg FldArg =
1092 CallArg(EmitRValueForField(LV, FD, SourceLocation()), FD->getType());
1093 ExpandTypeToArgs(FD->getType(), FldArg, IRFuncTy, IRCallArgs,
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001094 IRCallArgPos);
1095 }
1096 } else if (isa<ComplexExpansion>(Exp.get())) {
Yaxun Liu5b330e82018-03-15 15:25:19 +00001097 ComplexPairTy CV = Arg.getKnownRValue().getComplexVal();
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001098 IRCallArgs[IRCallArgPos++] = CV.first;
1099 IRCallArgs[IRCallArgPos++] = CV.second;
1100 } else {
1101 assert(isa<NoExpansion>(Exp.get()));
Yaxun Liu5b330e82018-03-15 15:25:19 +00001102 auto RV = Arg.getKnownRValue();
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001103 assert(RV.isScalar() &&
1104 "Unexpected non-scalar rvalue during struct expansion.");
1105
1106 // Insert a bitcast as needed.
1107 llvm::Value *V = RV.getScalarVal();
1108 if (IRCallArgPos < IRFuncTy->getNumParams() &&
1109 V->getType() != IRFuncTy->getParamType(IRCallArgPos))
1110 V = Builder.CreateBitCast(V, IRFuncTy->getParamType(IRCallArgPos));
1111
1112 IRCallArgs[IRCallArgPos++] = V;
1113 }
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00001114}
1115
John McCall7f416cc2015-09-08 08:05:57 +00001116/// Create a temporary allocation for the purposes of coercion.
1117static Address CreateTempAllocaForCoercion(CodeGenFunction &CGF, llvm::Type *Ty,
1118 CharUnits MinAlign) {
1119 // Don't use an alignment that's worse than what LLVM would prefer.
1120 auto PrefAlign = CGF.CGM.getDataLayout().getPrefTypeAlignment(Ty);
1121 CharUnits Align = std::max(MinAlign, CharUnits::fromQuantity(PrefAlign));
1122
1123 return CGF.CreateTempAlloca(Ty, Align);
1124}
1125
Chris Lattner895c52b2010-06-27 06:04:18 +00001126/// EnterStructPointerForCoercedAccess - Given a struct pointer that we are
Chris Lattner1cd66982010-06-27 05:56:15 +00001127/// accessing some number of bytes out of it, try to gep into the struct to get
1128/// at its inner goodness. Dive as deep as possible without entering an element
1129/// with an in-memory size smaller than DstSize.
John McCall7f416cc2015-09-08 08:05:57 +00001130static Address
1131EnterStructPointerForCoercedAccess(Address SrcPtr,
Chris Lattner2192fe52011-07-18 04:24:23 +00001132 llvm::StructType *SrcSTy,
Chris Lattner895c52b2010-06-27 06:04:18 +00001133 uint64_t DstSize, CodeGenFunction &CGF) {
Chris Lattner1cd66982010-06-27 05:56:15 +00001134 // We can't dive into a zero-element struct.
1135 if (SrcSTy->getNumElements() == 0) return SrcPtr;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001136
Chris Lattner2192fe52011-07-18 04:24:23 +00001137 llvm::Type *FirstElt = SrcSTy->getElementType(0);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001138
Chris Lattner1cd66982010-06-27 05:56:15 +00001139 // 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 +00001140 // first element is the same size as the whole struct, we can enter it. The
1141 // comparison must be made on the store size and not the alloca size. Using
1142 // the alloca size may overstate the size of the load.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001143 uint64_t FirstEltSize =
James Molloy90d61012014-08-29 10:17:52 +00001144 CGF.CGM.getDataLayout().getTypeStoreSize(FirstElt);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001145 if (FirstEltSize < DstSize &&
James Molloy90d61012014-08-29 10:17:52 +00001146 FirstEltSize < CGF.CGM.getDataLayout().getTypeStoreSize(SrcSTy))
Chris Lattner1cd66982010-06-27 05:56:15 +00001147 return SrcPtr;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001148
Chris Lattner1cd66982010-06-27 05:56:15 +00001149 // GEP into the first element.
John McCall7f416cc2015-09-08 08:05:57 +00001150 SrcPtr = CGF.Builder.CreateStructGEP(SrcPtr, 0, CharUnits(), "coerce.dive");
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001151
Chris Lattner1cd66982010-06-27 05:56:15 +00001152 // If the first element is a struct, recurse.
John McCall7f416cc2015-09-08 08:05:57 +00001153 llvm::Type *SrcTy = SrcPtr.getElementType();
Chris Lattner2192fe52011-07-18 04:24:23 +00001154 if (llvm::StructType *SrcSTy = dyn_cast<llvm::StructType>(SrcTy))
Chris Lattner895c52b2010-06-27 06:04:18 +00001155 return EnterStructPointerForCoercedAccess(SrcPtr, SrcSTy, DstSize, CGF);
Chris Lattner1cd66982010-06-27 05:56:15 +00001156
1157 return SrcPtr;
1158}
1159
Chris Lattner055097f2010-06-27 06:26:04 +00001160/// CoerceIntOrPtrToIntOrPtr - Convert a value Val to the specific Ty where both
1161/// are either integers or pointers. This does a truncation of the value if it
1162/// is too large or a zero extension if it is too small.
Jakob Stoklund Olesen36af2522013-06-05 03:00:13 +00001163///
1164/// This behaves as if the value were coerced through memory, so on big-endian
1165/// targets the high bits are preserved in a truncation, while little-endian
1166/// targets preserve the low bits.
Chris Lattner055097f2010-06-27 06:26:04 +00001167static llvm::Value *CoerceIntOrPtrToIntOrPtr(llvm::Value *Val,
Chris Lattner2192fe52011-07-18 04:24:23 +00001168 llvm::Type *Ty,
Chris Lattner055097f2010-06-27 06:26:04 +00001169 CodeGenFunction &CGF) {
1170 if (Val->getType() == Ty)
1171 return Val;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001172
Chris Lattner055097f2010-06-27 06:26:04 +00001173 if (isa<llvm::PointerType>(Val->getType())) {
1174 // If this is Pointer->Pointer avoid conversion to and from int.
1175 if (isa<llvm::PointerType>(Ty))
1176 return CGF.Builder.CreateBitCast(Val, Ty, "coerce.val");
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001177
Chris Lattner055097f2010-06-27 06:26:04 +00001178 // Convert the pointer to an integer so we can play with its width.
Chris Lattner5e016ae2010-06-27 07:15:29 +00001179 Val = CGF.Builder.CreatePtrToInt(Val, CGF.IntPtrTy, "coerce.val.pi");
Chris Lattner055097f2010-06-27 06:26:04 +00001180 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001181
Chris Lattner2192fe52011-07-18 04:24:23 +00001182 llvm::Type *DestIntTy = Ty;
Chris Lattner055097f2010-06-27 06:26:04 +00001183 if (isa<llvm::PointerType>(DestIntTy))
Chris Lattner5e016ae2010-06-27 07:15:29 +00001184 DestIntTy = CGF.IntPtrTy;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001185
Jakob Stoklund Olesen36af2522013-06-05 03:00:13 +00001186 if (Val->getType() != DestIntTy) {
1187 const llvm::DataLayout &DL = CGF.CGM.getDataLayout();
1188 if (DL.isBigEndian()) {
1189 // Preserve the high bits on big-endian targets.
1190 // That is what memory coercion does.
James Molloy491cefb2014-05-07 17:41:15 +00001191 uint64_t SrcSize = DL.getTypeSizeInBits(Val->getType());
1192 uint64_t DstSize = DL.getTypeSizeInBits(DestIntTy);
1193
Jakob Stoklund Olesen36af2522013-06-05 03:00:13 +00001194 if (SrcSize > DstSize) {
1195 Val = CGF.Builder.CreateLShr(Val, SrcSize - DstSize, "coerce.highbits");
1196 Val = CGF.Builder.CreateTrunc(Val, DestIntTy, "coerce.val.ii");
1197 } else {
1198 Val = CGF.Builder.CreateZExt(Val, DestIntTy, "coerce.val.ii");
1199 Val = CGF.Builder.CreateShl(Val, DstSize - SrcSize, "coerce.highbits");
1200 }
1201 } else {
1202 // Little-endian targets preserve the low bits. No shifts required.
1203 Val = CGF.Builder.CreateIntCast(Val, DestIntTy, false, "coerce.val.ii");
1204 }
1205 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001206
Chris Lattner055097f2010-06-27 06:26:04 +00001207 if (isa<llvm::PointerType>(Ty))
1208 Val = CGF.Builder.CreateIntToPtr(Val, Ty, "coerce.val.ip");
1209 return Val;
1210}
1211
Chris Lattner1cd66982010-06-27 05:56:15 +00001212
1213
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001214/// CreateCoercedLoad - Create a load from \arg SrcPtr interpreted as
Ulrich Weigand6e2cea62015-07-10 11:31:43 +00001215/// a pointer to an object of type \arg Ty, known to be aligned to
1216/// \arg SrcAlign bytes.
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001217///
1218/// This safely handles the case when the src type is smaller than the
1219/// destination type; in this situation the values of bits which not
1220/// present in the src are undefined.
John McCall7f416cc2015-09-08 08:05:57 +00001221static llvm::Value *CreateCoercedLoad(Address Src, llvm::Type *Ty,
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001222 CodeGenFunction &CGF) {
John McCall7f416cc2015-09-08 08:05:57 +00001223 llvm::Type *SrcTy = Src.getElementType();
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001224
Chris Lattnerd200eda2010-06-28 22:51:39 +00001225 // If SrcTy and Ty are the same, just do a load.
1226 if (SrcTy == Ty)
John McCall7f416cc2015-09-08 08:05:57 +00001227 return CGF.Builder.CreateLoad(Src);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001228
Micah Villmowdd31ca12012-10-08 16:25:52 +00001229 uint64_t DstSize = CGF.CGM.getDataLayout().getTypeAllocSize(Ty);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001230
Chris Lattner2192fe52011-07-18 04:24:23 +00001231 if (llvm::StructType *SrcSTy = dyn_cast<llvm::StructType>(SrcTy)) {
John McCall7f416cc2015-09-08 08:05:57 +00001232 Src = EnterStructPointerForCoercedAccess(Src, SrcSTy, DstSize, CGF);
1233 SrcTy = Src.getType()->getElementType();
Chris Lattner1cd66982010-06-27 05:56:15 +00001234 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001235
Micah Villmowdd31ca12012-10-08 16:25:52 +00001236 uint64_t SrcSize = CGF.CGM.getDataLayout().getTypeAllocSize(SrcTy);
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001237
Chris Lattner055097f2010-06-27 06:26:04 +00001238 // If the source and destination are integer or pointer types, just do an
1239 // extension or truncation to the desired type.
1240 if ((isa<llvm::IntegerType>(Ty) || isa<llvm::PointerType>(Ty)) &&
1241 (isa<llvm::IntegerType>(SrcTy) || isa<llvm::PointerType>(SrcTy))) {
John McCall7f416cc2015-09-08 08:05:57 +00001242 llvm::Value *Load = CGF.Builder.CreateLoad(Src);
Chris Lattner055097f2010-06-27 06:26:04 +00001243 return CoerceIntOrPtrToIntOrPtr(Load, Ty, CGF);
1244 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001245
Daniel Dunbarb52d0772009-02-03 05:59:18 +00001246 // If load is legal, just bitcast the src pointer.
Daniel Dunbarffdb8432009-05-13 18:54:26 +00001247 if (SrcSize >= DstSize) {
Mike Stump18bb9282009-05-16 07:57:57 +00001248 // Generally SrcSize is never greater than DstSize, since this means we are
1249 // losing bits. However, this can happen in cases where the structure has
1250 // additional padding, for example due to a user specified alignment.
Daniel Dunbarffdb8432009-05-13 18:54:26 +00001251 //
Mike Stump18bb9282009-05-16 07:57:57 +00001252 // FIXME: Assert that we aren't truncating non-padding bits when have access
1253 // to that information.
Matt Arsenault7a124f32017-08-01 20:36:57 +00001254 Src = CGF.Builder.CreateBitCast(Src,
1255 Ty->getPointerTo(Src.getAddressSpace()));
John McCall7f416cc2015-09-08 08:05:57 +00001256 return CGF.Builder.CreateLoad(Src);
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001257 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001258
John McCall7f416cc2015-09-08 08:05:57 +00001259 // Otherwise do coercion through memory. This is stupid, but simple.
1260 Address Tmp = CreateTempAllocaForCoercion(CGF, Ty, Src.getAlignment());
Yaxun Liu4bbdebc2018-11-08 16:55:46 +00001261 Address Casted = CGF.Builder.CreateElementBitCast(Tmp,CGF.Int8Ty);
1262 Address SrcCasted = CGF.Builder.CreateElementBitCast(Src,CGF.Int8Ty);
Manman Ren84b921f2012-11-28 22:08:52 +00001263 CGF.Builder.CreateMemCpy(Casted, SrcCasted,
1264 llvm::ConstantInt::get(CGF.IntPtrTy, SrcSize),
John McCall7f416cc2015-09-08 08:05:57 +00001265 false);
1266 return CGF.Builder.CreateLoad(Tmp);
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001267}
1268
Eli Friedmanaf9b3252011-05-17 21:08:01 +00001269// Function to store a first-class aggregate into memory. We prefer to
1270// store the elements rather than the aggregate to be more friendly to
1271// fast-isel.
1272// FIXME: Do we need to recurse here?
1273static void BuildAggStore(CodeGenFunction &CGF, llvm::Value *Val,
John McCall7f416cc2015-09-08 08:05:57 +00001274 Address Dest, bool DestIsVolatile) {
Eli Friedmanaf9b3252011-05-17 21:08:01 +00001275 // Prefer scalar stores to first-class aggregate stores.
Chris Lattner2192fe52011-07-18 04:24:23 +00001276 if (llvm::StructType *STy =
Eli Friedmanaf9b3252011-05-17 21:08:01 +00001277 dyn_cast<llvm::StructType>(Val->getType())) {
Ulrich Weigand6e2cea62015-07-10 11:31:43 +00001278 const llvm::StructLayout *Layout =
1279 CGF.CGM.getDataLayout().getStructLayout(STy);
1280
Eli Friedmanaf9b3252011-05-17 21:08:01 +00001281 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
John McCall7f416cc2015-09-08 08:05:57 +00001282 auto EltOffset = CharUnits::fromQuantity(Layout->getElementOffset(i));
1283 Address EltPtr = CGF.Builder.CreateStructGEP(Dest, i, EltOffset);
Eli Friedmanaf9b3252011-05-17 21:08:01 +00001284 llvm::Value *Elt = CGF.Builder.CreateExtractValue(Val, i);
John McCall7f416cc2015-09-08 08:05:57 +00001285 CGF.Builder.CreateStore(Elt, EltPtr, DestIsVolatile);
Eli Friedmanaf9b3252011-05-17 21:08:01 +00001286 }
1287 } else {
John McCall7f416cc2015-09-08 08:05:57 +00001288 CGF.Builder.CreateStore(Val, Dest, DestIsVolatile);
Eli Friedmanaf9b3252011-05-17 21:08:01 +00001289 }
1290}
1291
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001292/// CreateCoercedStore - Create a store to \arg DstPtr from \arg Src,
Ulrich Weigand6e2cea62015-07-10 11:31:43 +00001293/// where the source and destination may have different types. The
1294/// destination is known to be aligned to \arg DstAlign bytes.
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001295///
1296/// This safely handles the case when the src type is larger than the
1297/// destination type; the upper bits of the src will be lost.
1298static void CreateCoercedStore(llvm::Value *Src,
John McCall7f416cc2015-09-08 08:05:57 +00001299 Address Dst,
Anders Carlsson17490832009-12-24 20:40:36 +00001300 bool DstIsVolatile,
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001301 CodeGenFunction &CGF) {
Chris Lattner2192fe52011-07-18 04:24:23 +00001302 llvm::Type *SrcTy = Src->getType();
John McCall7f416cc2015-09-08 08:05:57 +00001303 llvm::Type *DstTy = Dst.getType()->getElementType();
Chris Lattnerd200eda2010-06-28 22:51:39 +00001304 if (SrcTy == DstTy) {
John McCall7f416cc2015-09-08 08:05:57 +00001305 CGF.Builder.CreateStore(Src, Dst, DstIsVolatile);
Chris Lattnerd200eda2010-06-28 22:51:39 +00001306 return;
1307 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001308
Micah Villmowdd31ca12012-10-08 16:25:52 +00001309 uint64_t SrcSize = CGF.CGM.getDataLayout().getTypeAllocSize(SrcTy);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001310
Chris Lattner2192fe52011-07-18 04:24:23 +00001311 if (llvm::StructType *DstSTy = dyn_cast<llvm::StructType>(DstTy)) {
John McCall7f416cc2015-09-08 08:05:57 +00001312 Dst = EnterStructPointerForCoercedAccess(Dst, DstSTy, SrcSize, CGF);
1313 DstTy = Dst.getType()->getElementType();
Chris Lattner895c52b2010-06-27 06:04:18 +00001314 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001315
Chris Lattner055097f2010-06-27 06:26:04 +00001316 // If the source and destination are integer or pointer types, just do an
1317 // extension or truncation to the desired type.
1318 if ((isa<llvm::IntegerType>(SrcTy) || isa<llvm::PointerType>(SrcTy)) &&
1319 (isa<llvm::IntegerType>(DstTy) || isa<llvm::PointerType>(DstTy))) {
1320 Src = CoerceIntOrPtrToIntOrPtr(Src, DstTy, CGF);
John McCall7f416cc2015-09-08 08:05:57 +00001321 CGF.Builder.CreateStore(Src, Dst, DstIsVolatile);
Chris Lattner055097f2010-06-27 06:26:04 +00001322 return;
1323 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001324
Micah Villmowdd31ca12012-10-08 16:25:52 +00001325 uint64_t DstSize = CGF.CGM.getDataLayout().getTypeAllocSize(DstTy);
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001326
Daniel Dunbar313321e2009-02-03 05:31:23 +00001327 // If store is legal, just bitcast the src pointer.
Daniel Dunbar4be99ff2009-06-05 07:58:54 +00001328 if (SrcSize <= DstSize) {
Yaxun Liue9e5c4f2017-06-29 18:47:45 +00001329 Dst = CGF.Builder.CreateElementBitCast(Dst, SrcTy);
John McCall7f416cc2015-09-08 08:05:57 +00001330 BuildAggStore(CGF, Src, Dst, DstIsVolatile);
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001331 } else {
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001332 // Otherwise do coercion through memory. This is stupid, but
1333 // simple.
Daniel Dunbar4be99ff2009-06-05 07:58:54 +00001334
1335 // Generally SrcSize is never greater than DstSize, since this means we are
1336 // losing bits. However, this can happen in cases where the structure has
1337 // additional padding, for example due to a user specified alignment.
1338 //
1339 // FIXME: Assert that we aren't truncating non-padding bits when have access
1340 // to that information.
John McCall7f416cc2015-09-08 08:05:57 +00001341 Address Tmp = CreateTempAllocaForCoercion(CGF, SrcTy, Dst.getAlignment());
1342 CGF.Builder.CreateStore(Src, Tmp);
Yaxun Liu4bbdebc2018-11-08 16:55:46 +00001343 Address Casted = CGF.Builder.CreateElementBitCast(Tmp,CGF.Int8Ty);
1344 Address DstCasted = CGF.Builder.CreateElementBitCast(Dst,CGF.Int8Ty);
Manman Ren84b921f2012-11-28 22:08:52 +00001345 CGF.Builder.CreateMemCpy(DstCasted, Casted,
1346 llvm::ConstantInt::get(CGF.IntPtrTy, DstSize),
John McCall7f416cc2015-09-08 08:05:57 +00001347 false);
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001348 }
1349}
1350
John McCall7f416cc2015-09-08 08:05:57 +00001351static Address emitAddressAtOffset(CodeGenFunction &CGF, Address addr,
Fangrui Song6907ce22018-07-30 19:24:48 +00001352 const ABIArgInfo &info) {
John McCall7f416cc2015-09-08 08:05:57 +00001353 if (unsigned offset = info.getDirectOffset()) {
1354 addr = CGF.Builder.CreateElementBitCast(addr, CGF.Int8Ty);
1355 addr = CGF.Builder.CreateConstInBoundsByteGEP(addr,
1356 CharUnits::fromQuantity(offset));
1357 addr = CGF.Builder.CreateElementBitCast(addr, info.getCoerceToType());
1358 }
1359 return addr;
1360}
1361
Alexey Samsonov153004f2014-09-29 22:08:00 +00001362namespace {
1363
1364/// Encapsulates information about the way function arguments from
1365/// CGFunctionInfo should be passed to actual LLVM IR function.
1366class ClangToLLVMArgMapping {
1367 static const unsigned InvalidIndex = ~0U;
1368 unsigned InallocaArgNo;
1369 unsigned SRetArgNo;
1370 unsigned TotalIRArgs;
1371
1372 /// Arguments of LLVM IR function corresponding to single Clang argument.
1373 struct IRArgs {
1374 unsigned PaddingArgIndex;
1375 // Argument is expanded to IR arguments at positions
1376 // [FirstArgIndex, FirstArgIndex + NumberOfArgs).
1377 unsigned FirstArgIndex;
1378 unsigned NumberOfArgs;
1379
1380 IRArgs()
1381 : PaddingArgIndex(InvalidIndex), FirstArgIndex(InvalidIndex),
1382 NumberOfArgs(0) {}
1383 };
1384
1385 SmallVector<IRArgs, 8> ArgInfo;
1386
1387public:
1388 ClangToLLVMArgMapping(const ASTContext &Context, const CGFunctionInfo &FI,
1389 bool OnlyRequiredArgs = false)
1390 : InallocaArgNo(InvalidIndex), SRetArgNo(InvalidIndex), TotalIRArgs(0),
1391 ArgInfo(OnlyRequiredArgs ? FI.getNumRequiredArgs() : FI.arg_size()) {
1392 construct(Context, FI, OnlyRequiredArgs);
1393 }
1394
1395 bool hasInallocaArg() const { return InallocaArgNo != InvalidIndex; }
1396 unsigned getInallocaArgNo() const {
1397 assert(hasInallocaArg());
1398 return InallocaArgNo;
1399 }
1400
1401 bool hasSRetArg() const { return SRetArgNo != InvalidIndex; }
1402 unsigned getSRetArgNo() const {
1403 assert(hasSRetArg());
1404 return SRetArgNo;
1405 }
1406
1407 unsigned totalIRArgs() const { return TotalIRArgs; }
1408
1409 bool hasPaddingArg(unsigned ArgNo) const {
1410 assert(ArgNo < ArgInfo.size());
1411 return ArgInfo[ArgNo].PaddingArgIndex != InvalidIndex;
1412 }
1413 unsigned getPaddingArgNo(unsigned ArgNo) const {
1414 assert(hasPaddingArg(ArgNo));
1415 return ArgInfo[ArgNo].PaddingArgIndex;
1416 }
1417
1418 /// Returns index of first IR argument corresponding to ArgNo, and their
1419 /// quantity.
1420 std::pair<unsigned, unsigned> getIRArgs(unsigned ArgNo) const {
1421 assert(ArgNo < ArgInfo.size());
1422 return std::make_pair(ArgInfo[ArgNo].FirstArgIndex,
1423 ArgInfo[ArgNo].NumberOfArgs);
1424 }
1425
1426private:
1427 void construct(const ASTContext &Context, const CGFunctionInfo &FI,
1428 bool OnlyRequiredArgs);
1429};
1430
1431void ClangToLLVMArgMapping::construct(const ASTContext &Context,
1432 const CGFunctionInfo &FI,
1433 bool OnlyRequiredArgs) {
1434 unsigned IRArgNo = 0;
1435 bool SwapThisWithSRet = false;
1436 const ABIArgInfo &RetAI = FI.getReturnInfo();
1437
1438 if (RetAI.getKind() == ABIArgInfo::Indirect) {
1439 SwapThisWithSRet = RetAI.isSRetAfterThis();
1440 SRetArgNo = SwapThisWithSRet ? 1 : IRArgNo++;
1441 }
1442
1443 unsigned ArgNo = 0;
1444 unsigned NumArgs = OnlyRequiredArgs ? FI.getNumRequiredArgs() : FI.arg_size();
1445 for (CGFunctionInfo::const_arg_iterator I = FI.arg_begin(); ArgNo < NumArgs;
1446 ++I, ++ArgNo) {
1447 assert(I != FI.arg_end());
1448 QualType ArgType = I->type;
1449 const ABIArgInfo &AI = I->info;
1450 // Collect data about IR arguments corresponding to Clang argument ArgNo.
1451 auto &IRArgs = ArgInfo[ArgNo];
1452
1453 if (AI.getPaddingType())
1454 IRArgs.PaddingArgIndex = IRArgNo++;
1455
1456 switch (AI.getKind()) {
1457 case ABIArgInfo::Extend:
1458 case ABIArgInfo::Direct: {
1459 // FIXME: handle sseregparm someday...
1460 llvm::StructType *STy = dyn_cast<llvm::StructType>(AI.getCoerceToType());
1461 if (AI.isDirect() && AI.getCanBeFlattened() && STy) {
1462 IRArgs.NumberOfArgs = STy->getNumElements();
1463 } else {
1464 IRArgs.NumberOfArgs = 1;
1465 }
1466 break;
1467 }
1468 case ABIArgInfo::Indirect:
1469 IRArgs.NumberOfArgs = 1;
1470 break;
1471 case ABIArgInfo::Ignore:
1472 case ABIArgInfo::InAlloca:
1473 // ignore and inalloca doesn't have matching LLVM parameters.
1474 IRArgs.NumberOfArgs = 0;
1475 break;
John McCallf26e73d2016-03-11 04:30:43 +00001476 case ABIArgInfo::CoerceAndExpand:
1477 IRArgs.NumberOfArgs = AI.getCoerceAndExpandTypeSequence().size();
1478 break;
1479 case ABIArgInfo::Expand:
Alexey Samsonov153004f2014-09-29 22:08:00 +00001480 IRArgs.NumberOfArgs = getExpansionSize(ArgType, Context);
1481 break;
1482 }
Alexey Samsonov153004f2014-09-29 22:08:00 +00001483
1484 if (IRArgs.NumberOfArgs > 0) {
1485 IRArgs.FirstArgIndex = IRArgNo;
1486 IRArgNo += IRArgs.NumberOfArgs;
1487 }
1488
1489 // Skip over the sret parameter when it comes second. We already handled it
1490 // above.
1491 if (IRArgNo == 1 && SwapThisWithSRet)
1492 IRArgNo++;
1493 }
1494 assert(ArgNo == ArgInfo.size());
1495
1496 if (FI.usesInAlloca())
1497 InallocaArgNo = IRArgNo++;
1498
1499 TotalIRArgs = IRArgNo;
1500}
1501} // namespace
1502
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00001503/***/
1504
Daniel Dunbar6f2e8392010-07-14 23:39:36 +00001505bool CodeGenModule::ReturnTypeUsesSRet(const CGFunctionInfo &FI) {
Saleem Abdulrasoolf181f1a2018-02-28 20:16:12 +00001506 const auto &RI = FI.getReturnInfo();
1507 return RI.isIndirect() || (RI.isInAlloca() && RI.getInAllocaSRet());
Daniel Dunbar7633cbf2009-02-02 21:43:58 +00001508}
1509
Tim Northovere77cc392014-03-29 13:28:05 +00001510bool CodeGenModule::ReturnSlotInterferesWithArgs(const CGFunctionInfo &FI) {
1511 return ReturnTypeUsesSRet(FI) &&
1512 getTargetCodeGenInfo().doesReturnSlotInterfereWithArgs();
1513}
1514
Daniel Dunbar6f2e8392010-07-14 23:39:36 +00001515bool CodeGenModule::ReturnTypeUsesFPRet(QualType ResultType) {
1516 if (const BuiltinType *BT = ResultType->getAs<BuiltinType>()) {
1517 switch (BT->getKind()) {
1518 default:
1519 return false;
1520 case BuiltinType::Float:
John McCallc8e01702013-04-16 22:48:15 +00001521 return getTarget().useObjCFPRetForRealType(TargetInfo::Float);
Daniel Dunbar6f2e8392010-07-14 23:39:36 +00001522 case BuiltinType::Double:
John McCallc8e01702013-04-16 22:48:15 +00001523 return getTarget().useObjCFPRetForRealType(TargetInfo::Double);
Daniel Dunbar6f2e8392010-07-14 23:39:36 +00001524 case BuiltinType::LongDouble:
John McCallc8e01702013-04-16 22:48:15 +00001525 return getTarget().useObjCFPRetForRealType(TargetInfo::LongDouble);
Daniel Dunbar6f2e8392010-07-14 23:39:36 +00001526 }
1527 }
1528
1529 return false;
1530}
1531
Anders Carlsson2f1a6c32011-10-31 16:27:11 +00001532bool CodeGenModule::ReturnTypeUsesFP2Ret(QualType ResultType) {
1533 if (const ComplexType *CT = ResultType->getAs<ComplexType>()) {
1534 if (const BuiltinType *BT = CT->getElementType()->getAs<BuiltinType>()) {
1535 if (BT->getKind() == BuiltinType::LongDouble)
John McCallc8e01702013-04-16 22:48:15 +00001536 return getTarget().useObjCFP2RetForComplexLongDouble();
Anders Carlsson2f1a6c32011-10-31 16:27:11 +00001537 }
1538 }
1539
1540 return false;
1541}
1542
Chris Lattnera5f58b02011-07-09 17:41:47 +00001543llvm::FunctionType *CodeGenTypes::GetFunctionType(GlobalDecl GD) {
John McCalla729c622012-02-17 03:33:10 +00001544 const CGFunctionInfo &FI = arrangeGlobalDeclaration(GD);
1545 return GetFunctionType(FI);
John McCallf8ff7b92010-02-23 00:48:20 +00001546}
1547
Chris Lattnera5f58b02011-07-09 17:41:47 +00001548llvm::FunctionType *
John McCalla729c622012-02-17 03:33:10 +00001549CodeGenTypes::GetFunctionType(const CGFunctionInfo &FI) {
Alexey Samsonov153004f2014-09-29 22:08:00 +00001550
David Blaikie82e95a32014-11-19 07:49:47 +00001551 bool Inserted = FunctionsBeingProcessed.insert(&FI).second;
1552 (void)Inserted;
Chris Lattner6fb0ccf2011-07-15 05:16:14 +00001553 assert(Inserted && "Recursively being processed?");
Daniel Dunbar7a95ca32008-09-10 04:01:49 +00001554
Alexey Samsonov153004f2014-09-29 22:08:00 +00001555 llvm::Type *resultType = nullptr;
John McCall85dd2c52011-05-15 02:19:42 +00001556 const ABIArgInfo &retAI = FI.getReturnInfo();
1557 switch (retAI.getKind()) {
Daniel Dunbard3674e62008-09-11 01:48:57 +00001558 case ABIArgInfo::Expand:
John McCall85dd2c52011-05-15 02:19:42 +00001559 llvm_unreachable("Invalid ABI kind for return argument");
Daniel Dunbard3674e62008-09-11 01:48:57 +00001560
Anton Korobeynikov18adbf52009-06-06 09:36:29 +00001561 case ABIArgInfo::Extend:
Daniel Dunbar67dace892009-02-03 06:17:37 +00001562 case ABIArgInfo::Direct:
John McCall85dd2c52011-05-15 02:19:42 +00001563 resultType = retAI.getCoerceToType();
Daniel Dunbar67dace892009-02-03 06:17:37 +00001564 break;
1565
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001566 case ABIArgInfo::InAlloca:
Reid Klecknerfab1e892014-02-25 00:59:14 +00001567 if (retAI.getInAllocaSRet()) {
1568 // sret things on win32 aren't void, they return the sret pointer.
1569 QualType ret = FI.getReturnType();
1570 llvm::Type *ty = ConvertType(ret);
1571 unsigned addressSpace = Context.getTargetAddressSpace(ret);
1572 resultType = llvm::PointerType::get(ty, addressSpace);
1573 } else {
1574 resultType = llvm::Type::getVoidTy(getLLVMContext());
1575 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001576 break;
1577
John McCall7f416cc2015-09-08 08:05:57 +00001578 case ABIArgInfo::Indirect:
Daniel Dunbar94a6f252009-01-26 21:26:08 +00001579 case ABIArgInfo::Ignore:
John McCall85dd2c52011-05-15 02:19:42 +00001580 resultType = llvm::Type::getVoidTy(getLLVMContext());
Daniel Dunbar94a6f252009-01-26 21:26:08 +00001581 break;
John McCallf26e73d2016-03-11 04:30:43 +00001582
1583 case ABIArgInfo::CoerceAndExpand:
1584 resultType = retAI.getUnpaddedCoerceAndExpandType();
1585 break;
Daniel Dunbar7a95ca32008-09-10 04:01:49 +00001586 }
Mike Stump11289f42009-09-09 15:08:12 +00001587
Alexey Samsonov153004f2014-09-29 22:08:00 +00001588 ClangToLLVMArgMapping IRFunctionArgs(getContext(), FI, true);
1589 SmallVector<llvm::Type*, 8> ArgTypes(IRFunctionArgs.totalIRArgs());
1590
1591 // Add type for sret argument.
1592 if (IRFunctionArgs.hasSRetArg()) {
1593 QualType Ret = FI.getReturnType();
1594 llvm::Type *Ty = ConvertType(Ret);
1595 unsigned AddressSpace = Context.getTargetAddressSpace(Ret);
1596 ArgTypes[IRFunctionArgs.getSRetArgNo()] =
1597 llvm::PointerType::get(Ty, AddressSpace);
1598 }
1599
1600 // Add type for inalloca argument.
1601 if (IRFunctionArgs.hasInallocaArg()) {
1602 auto ArgStruct = FI.getArgStruct();
1603 assert(ArgStruct);
1604 ArgTypes[IRFunctionArgs.getInallocaArgNo()] = ArgStruct->getPointerTo();
1605 }
1606
John McCallc818bbb2012-12-07 07:03:17 +00001607 // Add in all of the required arguments.
Alexey Samsonov153004f2014-09-29 22:08:00 +00001608 unsigned ArgNo = 0;
Alexey Samsonov34625dd2014-09-29 21:21:48 +00001609 CGFunctionInfo::const_arg_iterator it = FI.arg_begin(),
1610 ie = it + FI.getNumRequiredArgs();
Alexey Samsonov153004f2014-09-29 22:08:00 +00001611 for (; it != ie; ++it, ++ArgNo) {
1612 const ABIArgInfo &ArgInfo = it->info;
Mike Stump11289f42009-09-09 15:08:12 +00001613
Rafael Espindolafad28de2012-10-24 01:59:00 +00001614 // Insert a padding type to ensure proper alignment.
Alexey Samsonov153004f2014-09-29 22:08:00 +00001615 if (IRFunctionArgs.hasPaddingArg(ArgNo))
1616 ArgTypes[IRFunctionArgs.getPaddingArgNo(ArgNo)] =
1617 ArgInfo.getPaddingType();
Rafael Espindolafad28de2012-10-24 01:59:00 +00001618
Alexey Samsonov153004f2014-09-29 22:08:00 +00001619 unsigned FirstIRArg, NumIRArgs;
1620 std::tie(FirstIRArg, NumIRArgs) = IRFunctionArgs.getIRArgs(ArgNo);
1621
1622 switch (ArgInfo.getKind()) {
Daniel Dunbar94a6f252009-01-26 21:26:08 +00001623 case ABIArgInfo::Ignore:
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001624 case ABIArgInfo::InAlloca:
Alexey Samsonov153004f2014-09-29 22:08:00 +00001625 assert(NumIRArgs == 0);
Daniel Dunbar94a6f252009-01-26 21:26:08 +00001626 break;
1627
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00001628 case ABIArgInfo::Indirect: {
Alexey Samsonov153004f2014-09-29 22:08:00 +00001629 assert(NumIRArgs == 1);
Yaxun Liud7523282017-04-17 20:10:44 +00001630 // indirect arguments are always on the stack, which is alloca addr space.
Chris Lattner2192fe52011-07-18 04:24:23 +00001631 llvm::Type *LTy = ConvertTypeForMem(it->type);
Yaxun Liud7523282017-04-17 20:10:44 +00001632 ArgTypes[FirstIRArg] = LTy->getPointerTo(
1633 CGM.getDataLayout().getAllocaAddrSpace());
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00001634 break;
1635 }
1636
1637 case ABIArgInfo::Extend:
Chris Lattner2cdfda42010-07-29 06:44:09 +00001638 case ABIArgInfo::Direct: {
Oliver Stannard2bfdc5b2014-08-27 10:43:15 +00001639 // Fast-isel and the optimizer generally like scalar values better than
1640 // FCAs, so we flatten them if this is safe to do for this argument.
Alexey Samsonov153004f2014-09-29 22:08:00 +00001641 llvm::Type *argType = ArgInfo.getCoerceToType();
James Molloy6f244b62014-05-09 16:21:39 +00001642 llvm::StructType *st = dyn_cast<llvm::StructType>(argType);
Alexey Samsonov153004f2014-09-29 22:08:00 +00001643 if (st && ArgInfo.isDirect() && ArgInfo.getCanBeFlattened()) {
1644 assert(NumIRArgs == st->getNumElements());
John McCall85dd2c52011-05-15 02:19:42 +00001645 for (unsigned i = 0, e = st->getNumElements(); i != e; ++i)
Alexey Samsonov153004f2014-09-29 22:08:00 +00001646 ArgTypes[FirstIRArg + i] = st->getElementType(i);
Chris Lattner3dd716c2010-06-28 23:44:11 +00001647 } else {
Alexey Samsonov153004f2014-09-29 22:08:00 +00001648 assert(NumIRArgs == 1);
1649 ArgTypes[FirstIRArg] = argType;
Chris Lattner3dd716c2010-06-28 23:44:11 +00001650 }
Daniel Dunbar2f219b02009-02-03 19:12:28 +00001651 break;
Chris Lattner2cdfda42010-07-29 06:44:09 +00001652 }
Mike Stump11289f42009-09-09 15:08:12 +00001653
John McCallf26e73d2016-03-11 04:30:43 +00001654 case ABIArgInfo::CoerceAndExpand: {
1655 auto ArgTypesIter = ArgTypes.begin() + FirstIRArg;
1656 for (auto EltTy : ArgInfo.getCoerceAndExpandTypeSequence()) {
1657 *ArgTypesIter++ = EltTy;
1658 }
1659 assert(ArgTypesIter == ArgTypes.begin() + FirstIRArg + NumIRArgs);
1660 break;
1661 }
1662
Daniel Dunbard3674e62008-09-11 01:48:57 +00001663 case ABIArgInfo::Expand:
Alexey Samsonov153004f2014-09-29 22:08:00 +00001664 auto ArgTypesIter = ArgTypes.begin() + FirstIRArg;
1665 getExpandedTypes(it->type, ArgTypesIter);
1666 assert(ArgTypesIter == ArgTypes.begin() + FirstIRArg + NumIRArgs);
Daniel Dunbard3674e62008-09-11 01:48:57 +00001667 break;
1668 }
Daniel Dunbar7a95ca32008-09-10 04:01:49 +00001669 }
1670
Chris Lattner6fb0ccf2011-07-15 05:16:14 +00001671 bool Erased = FunctionsBeingProcessed.erase(&FI); (void)Erased;
1672 assert(Erased && "Not in set?");
Alexey Samsonov153004f2014-09-29 22:08:00 +00001673
1674 return llvm::FunctionType::get(resultType, ArgTypes, FI.isVariadic());
Daniel Dunbar81cf67f2008-09-09 23:48:28 +00001675}
1676
Chris Lattner2192fe52011-07-18 04:24:23 +00001677llvm::Type *CodeGenTypes::GetFunctionTypeForVTable(GlobalDecl GD) {
John McCall5d865c322010-08-31 07:33:07 +00001678 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
Anders Carlsson64457732009-11-24 05:08:52 +00001679 const FunctionProtoType *FPT = MD->getType()->getAs<FunctionProtoType>();
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001680
Chris Lattner8806e322011-07-10 00:18:59 +00001681 if (!isFuncTypeConvertible(FPT))
1682 return llvm::StructType::get(getLLVMContext());
Fangrui Song6907ce22018-07-30 19:24:48 +00001683
Chris Lattner8806e322011-07-10 00:18:59 +00001684 const CGFunctionInfo *Info;
1685 if (isa<CXXDestructorDecl>(MD))
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001686 Info =
1687 &arrangeCXXStructorDeclaration(MD, getFromDtorType(GD.getDtorType()));
Chris Lattner8806e322011-07-10 00:18:59 +00001688 else
John McCalla729c622012-02-17 03:33:10 +00001689 Info = &arrangeCXXMethodDeclaration(MD);
1690 return GetFunctionType(*Info);
Anders Carlsson64457732009-11-24 05:08:52 +00001691}
1692
Samuel Antao798f11c2015-11-23 22:04:44 +00001693static void AddAttributesFromFunctionProtoType(ASTContext &Ctx,
1694 llvm::AttrBuilder &FuncAttrs,
1695 const FunctionProtoType *FPT) {
1696 if (!FPT)
1697 return;
1698
1699 if (!isUnresolvedExceptionSpec(FPT->getExceptionSpecType()) &&
Richard Smitheaf11ad2018-05-03 03:58:32 +00001700 FPT->isNothrow())
Samuel Antao798f11c2015-11-23 22:04:44 +00001701 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
1702}
1703
Justin Lebarb080b632017-01-25 21:29:48 +00001704void CodeGenModule::ConstructDefaultFnAttrList(StringRef Name, bool HasOptnone,
1705 bool AttrOnCallSite,
1706 llvm::AttrBuilder &FuncAttrs) {
1707 // OptimizeNoneAttr takes precedence over -Os or -Oz. No warning needed.
1708 if (!HasOptnone) {
1709 if (CodeGenOpts.OptimizeSize)
1710 FuncAttrs.addAttribute(llvm::Attribute::OptimizeForSize);
1711 if (CodeGenOpts.OptimizeSize == 2)
1712 FuncAttrs.addAttribute(llvm::Attribute::MinSize);
1713 }
1714
1715 if (CodeGenOpts.DisableRedZone)
1716 FuncAttrs.addAttribute(llvm::Attribute::NoRedZone);
Kristina Brooks7f569b72018-10-18 14:07:02 +00001717 if (CodeGenOpts.IndirectTlsSegRefs)
1718 FuncAttrs.addAttribute("indirect-tls-seg-refs");
Justin Lebarb080b632017-01-25 21:29:48 +00001719 if (CodeGenOpts.NoImplicitFloat)
1720 FuncAttrs.addAttribute(llvm::Attribute::NoImplicitFloat);
1721
1722 if (AttrOnCallSite) {
1723 // Attributes that should go on the call site only.
1724 if (!CodeGenOpts.SimplifyLibCalls ||
1725 CodeGenOpts.isNoBuiltinFunc(Name.data()))
1726 FuncAttrs.addAttribute(llvm::Attribute::NoBuiltin);
1727 if (!CodeGenOpts.TrapFuncName.empty())
1728 FuncAttrs.addAttribute("trap-func-name", CodeGenOpts.TrapFuncName);
1729 } else {
1730 // Attributes that should go on the function, but not the call site.
1731 if (!CodeGenOpts.DisableFPElim) {
1732 FuncAttrs.addAttribute("no-frame-pointer-elim", "false");
1733 } else if (CodeGenOpts.OmitLeafFramePointer) {
1734 FuncAttrs.addAttribute("no-frame-pointer-elim", "false");
1735 FuncAttrs.addAttribute("no-frame-pointer-elim-non-leaf");
1736 } else {
1737 FuncAttrs.addAttribute("no-frame-pointer-elim", "true");
1738 FuncAttrs.addAttribute("no-frame-pointer-elim-non-leaf");
1739 }
1740
1741 FuncAttrs.addAttribute("less-precise-fpmad",
1742 llvm::toStringRef(CodeGenOpts.LessPreciseFPMAD));
1743
Manoj Guptada08f6a2018-07-19 00:44:52 +00001744 if (CodeGenOpts.NullPointerIsValid)
1745 FuncAttrs.addAttribute("null-pointer-is-valid", "true");
Justin Lebarb080b632017-01-25 21:29:48 +00001746 if (!CodeGenOpts.FPDenormalMode.empty())
1747 FuncAttrs.addAttribute("denormal-fp-math", CodeGenOpts.FPDenormalMode);
1748
1749 FuncAttrs.addAttribute("no-trapping-math",
1750 llvm::toStringRef(CodeGenOpts.NoTrappingMath));
1751
Sanjay Patelc81450e2018-04-30 18:19:03 +00001752 // Strict (compliant) code is the default, so only add this attribute to
1753 // indicate that we are trying to workaround a problem case.
1754 if (!CodeGenOpts.StrictFloatCastOverflow)
1755 FuncAttrs.addAttribute("strict-float-cast-overflow", "false");
Sanjay Pateld1754762018-04-27 14:22:48 +00001756
Justin Lebarb080b632017-01-25 21:29:48 +00001757 // TODO: Are these all needed?
1758 // unsafe/inf/nan/nsz are handled by instruction-level FastMathFlags.
1759 FuncAttrs.addAttribute("no-infs-fp-math",
1760 llvm::toStringRef(CodeGenOpts.NoInfsFPMath));
1761 FuncAttrs.addAttribute("no-nans-fp-math",
1762 llvm::toStringRef(CodeGenOpts.NoNaNsFPMath));
1763 FuncAttrs.addAttribute("unsafe-fp-math",
1764 llvm::toStringRef(CodeGenOpts.UnsafeFPMath));
1765 FuncAttrs.addAttribute("use-soft-float",
1766 llvm::toStringRef(CodeGenOpts.SoftFloat));
1767 FuncAttrs.addAttribute("stack-protector-buffer-size",
1768 llvm::utostr(CodeGenOpts.SSPBufferSize));
1769 FuncAttrs.addAttribute("no-signed-zeros-fp-math",
1770 llvm::toStringRef(CodeGenOpts.NoSignedZeros));
1771 FuncAttrs.addAttribute(
1772 "correctly-rounded-divide-sqrt-fp-math",
1773 llvm::toStringRef(CodeGenOpts.CorrectlyRoundedDivSqrt));
1774
Alexey Sotkin3858e262018-04-20 08:08:04 +00001775 if (getLangOpts().OpenCL)
1776 FuncAttrs.addAttribute("denorms-are-zero",
1777 llvm::toStringRef(CodeGenOpts.FlushDenorm));
1778
Justin Lebarb080b632017-01-25 21:29:48 +00001779 // TODO: Reciprocal estimate codegen options should apply to instructions?
Craig Topper402b4312017-11-20 17:09:22 +00001780 const std::vector<std::string> &Recips = CodeGenOpts.Reciprocals;
Justin Lebarb080b632017-01-25 21:29:48 +00001781 if (!Recips.empty())
1782 FuncAttrs.addAttribute("reciprocal-estimates",
Erich Keane857ac592017-10-27 18:45:06 +00001783 llvm::join(Recips, ","));
Justin Lebarb080b632017-01-25 21:29:48 +00001784
Craig Topper9a724aa2017-12-11 21:09:19 +00001785 if (!CodeGenOpts.PreferVectorWidth.empty() &&
1786 CodeGenOpts.PreferVectorWidth != "none")
1787 FuncAttrs.addAttribute("prefer-vector-width",
1788 CodeGenOpts.PreferVectorWidth);
1789
Justin Lebarb080b632017-01-25 21:29:48 +00001790 if (CodeGenOpts.StackRealignment)
1791 FuncAttrs.addAttribute("stackrealign");
1792 if (CodeGenOpts.Backchain)
1793 FuncAttrs.addAttribute("backchain");
Chandler Carruth664aa862018-09-04 12:38:00 +00001794
1795 if (CodeGenOpts.SpeculativeLoadHardening)
1796 FuncAttrs.addAttribute(llvm::Attribute::SpeculativeLoadHardening);
Justin Lebarb080b632017-01-25 21:29:48 +00001797 }
1798
Matt Arsenaulta1cf61b2017-10-06 19:34:40 +00001799 if (getLangOpts().assumeFunctionsAreConvergent()) {
1800 // Conservatively, mark all functions and calls in CUDA and OpenCL as
1801 // convergent (meaning, they may call an intrinsically convergent op, such
1802 // as __syncthreads() / barrier(), and so can't have certain optimizations
1803 // applied around them). LLVM will remove this attribute where it safely
1804 // can.
Justin Lebarb080b632017-01-25 21:29:48 +00001805 FuncAttrs.addAttribute(llvm::Attribute::Convergent);
Matt Arsenaulta1cf61b2017-10-06 19:34:40 +00001806 }
Justin Lebarb080b632017-01-25 21:29:48 +00001807
Matt Arsenaulta1cf61b2017-10-06 19:34:40 +00001808 if (getLangOpts().CUDA && getLangOpts().CUDAIsDevice) {
Justin Lebarb080b632017-01-25 21:29:48 +00001809 // Exceptions aren't supported in CUDA device code.
1810 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
1811
1812 // Respect -fcuda-flush-denormals-to-zero.
Yaxun Liue1bfbc52018-07-21 02:02:22 +00001813 if (CodeGenOpts.FlushDenorm)
Justin Lebarb080b632017-01-25 21:29:48 +00001814 FuncAttrs.addAttribute("nvptx-f32ftz", "true");
1815 }
Peter Collingbourne87f477b2019-01-04 19:27:04 +00001816
1817 for (StringRef Attr : CodeGenOpts.DefaultFunctionAttrs) {
1818 StringRef Var, Value;
1819 std::tie(Var, Value) = Attr.split('=');
1820 FuncAttrs.addAttribute(Var, Value);
1821 }
Justin Lebarb080b632017-01-25 21:29:48 +00001822}
1823
1824void CodeGenModule::AddDefaultFnAttrs(llvm::Function &F) {
1825 llvm::AttrBuilder FuncAttrs;
1826 ConstructDefaultFnAttrList(F.getName(),
1827 F.hasFnAttribute(llvm::Attribute::OptimizeNone),
1828 /* AttrOnCallsite = */ false, FuncAttrs);
Reid Kleckneree4930b2017-05-02 22:07:37 +00001829 F.addAttributes(llvm::AttributeList::FunctionIndex, FuncAttrs);
Justin Lebarb080b632017-01-25 21:29:48 +00001830}
1831
Chad Rosier7dbc9cf2016-01-06 14:35:46 +00001832void CodeGenModule::ConstructAttributeList(
1833 StringRef Name, const CGFunctionInfo &FI, CGCalleeInfo CalleeInfo,
Reid Klecknercdd26792017-04-18 23:50:03 +00001834 llvm::AttributeList &AttrList, unsigned &CallingConv, bool AttrOnCallSite) {
Bill Wendlinga514ebc2012-10-15 20:36:26 +00001835 llvm::AttrBuilder FuncAttrs;
1836 llvm::AttrBuilder RetAttrs;
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00001837
Daniel Dunbar0ef34792009-09-12 00:59:20 +00001838 CallingConv = FI.getEffectiveCallingConvention();
John McCallab26cfa2010-02-05 21:31:56 +00001839 if (FI.isNoReturn())
Bill Wendling207f0532012-12-20 19:27:06 +00001840 FuncAttrs.addAttribute(llvm::Attribute::NoReturn);
John McCallab26cfa2010-02-05 21:31:56 +00001841
Samuel Antao798f11c2015-11-23 22:04:44 +00001842 // If we have information about the function prototype, we can learn
Craig Topper13d759f2018-04-30 22:02:48 +00001843 // attributes from there.
Samuel Antao798f11c2015-11-23 22:04:44 +00001844 AddAttributesFromFunctionProtoType(getContext(), FuncAttrs,
1845 CalleeInfo.getCalleeFunctionProtoType());
1846
Erich Keanede6480a32018-11-13 15:48:08 +00001847 const Decl *TargetDecl = CalleeInfo.getCalleeDecl().getDecl();
Samuel Antao798f11c2015-11-23 22:04:44 +00001848
Justin Lebarb080b632017-01-25 21:29:48 +00001849 bool HasOptnone = false;
Anton Korobeynikovc8478242009-04-04 00:49:24 +00001850 // FIXME: handle sseregparm someday...
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00001851 if (TargetDecl) {
Rafael Espindola2d21ab02011-10-12 19:51:18 +00001852 if (TargetDecl->hasAttr<ReturnsTwiceAttr>())
Bill Wendling207f0532012-12-20 19:27:06 +00001853 FuncAttrs.addAttribute(llvm::Attribute::ReturnsTwice);
Argyrios Kyrtzidisb4b64ca2009-06-30 02:34:44 +00001854 if (TargetDecl->hasAttr<NoThrowAttr>())
Bill Wendling207f0532012-12-20 19:27:06 +00001855 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
Richard Smithdebc59d2013-01-30 05:45:05 +00001856 if (TargetDecl->hasAttr<NoReturnAttr>())
1857 FuncAttrs.addAttribute(llvm::Attribute::NoReturn);
Xinliang David Li4ec36062017-06-13 21:14:07 +00001858 if (TargetDecl->hasAttr<ColdAttr>())
1859 FuncAttrs.addAttribute(llvm::Attribute::Cold);
Aaron Ballman7c19ab12014-02-22 16:59:24 +00001860 if (TargetDecl->hasAttr<NoDuplicateAttr>())
1861 FuncAttrs.addAttribute(llvm::Attribute::NoDuplicate);
Yaxun Liu7d07ae72016-11-01 18:45:32 +00001862 if (TargetDecl->hasAttr<ConvergentAttr>())
1863 FuncAttrs.addAttribute(llvm::Attribute::Convergent);
Richard Smithdebc59d2013-01-30 05:45:05 +00001864
Chandler Carruth45bbe012017-03-24 09:11:57 +00001865 if (const FunctionDecl *Fn = dyn_cast<FunctionDecl>(TargetDecl)) {
Samuel Antao798f11c2015-11-23 22:04:44 +00001866 AddAttributesFromFunctionProtoType(
Chandler Carruth45bbe012017-03-24 09:11:57 +00001867 getContext(), FuncAttrs, Fn->getType()->getAs<FunctionProtoType>());
Richard Smith49af6292013-03-05 08:30:04 +00001868 // Don't use [[noreturn]] or _Noreturn for a call to a virtual function.
1869 // These attributes are not inherited by overloads.
Chandler Carruth45bbe012017-03-24 09:11:57 +00001870 const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(Fn);
1871 if (Fn->isNoReturn() && !(AttrOnCallSite && MD && MD->isVirtual()))
Richard Smithdebc59d2013-01-30 05:45:05 +00001872 FuncAttrs.addAttribute(llvm::Attribute::NoReturn);
John McCallbe349de2010-07-08 06:48:12 +00001873 }
1874
David Majnemer1bf0f8e2015-07-20 22:51:52 +00001875 // 'const', 'pure' and 'noalias' attributed functions are also nounwind.
Eric Christopherbf005ec2011-08-15 22:38:22 +00001876 if (TargetDecl->hasAttr<ConstAttr>()) {
Bill Wendling207f0532012-12-20 19:27:06 +00001877 FuncAttrs.addAttribute(llvm::Attribute::ReadNone);
1878 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
Eric Christopherbf005ec2011-08-15 22:38:22 +00001879 } else if (TargetDecl->hasAttr<PureAttr>()) {
Bill Wendling207f0532012-12-20 19:27:06 +00001880 FuncAttrs.addAttribute(llvm::Attribute::ReadOnly);
1881 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
David Majnemer1bf0f8e2015-07-20 22:51:52 +00001882 } else if (TargetDecl->hasAttr<NoAliasAttr>()) {
1883 FuncAttrs.addAttribute(llvm::Attribute::ArgMemOnly);
1884 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
Eric Christopherbf005ec2011-08-15 22:38:22 +00001885 }
David Majnemer631a90b2015-02-04 07:23:21 +00001886 if (TargetDecl->hasAttr<RestrictAttr>())
Bill Wendling207f0532012-12-20 19:27:06 +00001887 RetAttrs.addAttribute(llvm::Attribute::NoAlias);
Manoj Guptada08f6a2018-07-19 00:44:52 +00001888 if (TargetDecl->hasAttr<ReturnsNonNullAttr>() &&
1889 !CodeGenOpts.NullPointerIsValid)
Hal Finkeld8442b12014-07-12 04:51:04 +00001890 RetAttrs.addAttribute(llvm::Attribute::NonNull);
Oren Ben Simhon318a6ea2017-04-27 12:01:00 +00001891 if (TargetDecl->hasAttr<AnyX86NoCallerSavedRegistersAttr>())
1892 FuncAttrs.addAttribute("no_caller_saved_registers");
Oren Ben Simhon220671a2018-03-17 13:31:35 +00001893 if (TargetDecl->hasAttr<AnyX86NoCfCheckAttr>())
1894 FuncAttrs.addAttribute(llvm::Attribute::NoCfCheck);
Paul Robinson08556952014-12-11 20:14:04 +00001895
1896 HasOptnone = TargetDecl->hasAttr<OptimizeNoneAttr>();
George Burgess IVe3763372016-12-22 02:50:20 +00001897 if (auto *AllocSize = TargetDecl->getAttr<AllocSizeAttr>()) {
1898 Optional<unsigned> NumElemsParam;
Joel E. Denny81508102018-03-13 14:51:22 +00001899 if (AllocSize->getNumElemsParam().isValid())
1900 NumElemsParam = AllocSize->getNumElemsParam().getLLVMIndex();
1901 FuncAttrs.addAllocSizeAttr(AllocSize->getElemSizeParam().getLLVMIndex(),
George Burgess IVe3763372016-12-22 02:50:20 +00001902 NumElemsParam);
1903 }
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00001904 }
1905
Justin Lebarb080b632017-01-25 21:29:48 +00001906 ConstructDefaultFnAttrList(Name, HasOptnone, AttrOnCallSite, FuncAttrs);
Paul Robinson08556952014-12-11 20:14:04 +00001907
Zola Bridges826ef592019-01-18 17:20:46 +00001908 // This must run after constructing the default function attribute list
1909 // to ensure that the speculative load hardening attribute is removed
1910 // in the case where the -mspeculative-load-hardening flag was passed.
1911 if (TargetDecl) {
1912 if (TargetDecl->hasAttr<NoSpeculativeLoadHardeningAttr>())
1913 FuncAttrs.removeAttribute(llvm::Attribute::SpeculativeLoadHardening);
1914 if (TargetDecl->hasAttr<SpeculativeLoadHardeningAttr>())
1915 FuncAttrs.addAttribute(llvm::Attribute::SpeculativeLoadHardening);
1916 }
1917
Peter Collingbourneb4728c12014-05-19 22:14:34 +00001918 if (CodeGenOpts.EnableSegmentedStacks &&
1919 !(TargetDecl && TargetDecl->hasAttr<NoSplitStackAttr>()))
Reid Klecknerfb873af2014-04-10 22:59:13 +00001920 FuncAttrs.addAttribute("split-stack");
Devang Patel6e467b12009-06-04 23:32:02 +00001921
Sriraman Tallam5c651482017-11-07 19:37:51 +00001922 // Add NonLazyBind attribute to function declarations when -fno-plt
1923 // is used.
1924 if (TargetDecl && CodeGenOpts.NoPLT) {
1925 if (auto *Fn = dyn_cast<FunctionDecl>(TargetDecl)) {
1926 if (!Fn->isDefined() && !AttrOnCallSite) {
1927 FuncAttrs.addAttribute(llvm::Attribute::NonLazyBind);
1928 }
1929 }
1930 }
1931
Alexey Sotkin20f65922018-02-22 11:54:14 +00001932 if (TargetDecl && TargetDecl->hasAttr<OpenCLKernelAttr>()) {
1933 if (getLangOpts().OpenCLVersion <= 120) {
1934 // OpenCL v1.2 Work groups are always uniform
1935 FuncAttrs.addAttribute("uniform-work-group-size", "true");
1936 } else {
1937 // OpenCL v2.0 Work groups may be whether uniform or not.
1938 // '-cl-uniform-work-group-size' compile option gets a hint
1939 // to the compiler that the global work-size be a multiple of
1940 // the work-group size specified to clEnqueueNDRangeKernel
1941 // (i.e. work groups are uniform).
1942 FuncAttrs.addAttribute("uniform-work-group-size",
1943 llvm::toStringRef(CodeGenOpts.UniformWGSize));
1944 }
1945 }
1946
Justin Lebarb080b632017-01-25 21:29:48 +00001947 if (!AttrOnCallSite) {
Akira Hatanaka627586b2018-03-02 01:53:15 +00001948 bool DisableTailCalls = false;
1949
1950 if (CodeGenOpts.DisableTailCalls)
1951 DisableTailCalls = true;
1952 else if (TargetDecl) {
1953 if (TargetDecl->hasAttr<DisableTailCallsAttr>() ||
1954 TargetDecl->hasAttr<AnyX86InterruptAttr>())
1955 DisableTailCalls = true;
1956 else if (CodeGenOpts.NoEscapingBlockTailCalls) {
1957 if (const auto *BD = dyn_cast<BlockDecl>(TargetDecl))
1958 if (!BD->doesNotEscape())
1959 DisableTailCalls = true;
1960 }
1961 }
1962
Justin Lebarb080b632017-01-25 21:29:48 +00001963 FuncAttrs.addAttribute("disable-tail-calls",
1964 llvm::toStringRef(DisableTailCalls));
Erich Keanede6480a32018-11-13 15:48:08 +00001965 GetCPUAndFeaturesAttributes(CalleeInfo.getCalleeDecl(), FuncAttrs);
Bill Wendling985d1c52013-02-15 21:30:01 +00001966 }
1967
Alexey Samsonov153004f2014-09-29 22:08:00 +00001968 ClangToLLVMArgMapping IRFunctionArgs(getContext(), FI);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00001969
Daniel Dunbar3668cb22009-02-02 23:43:58 +00001970 QualType RetTy = FI.getReturnType();
Daniel Dunbarb52d0772009-02-03 05:59:18 +00001971 const ABIArgInfo &RetAI = FI.getReturnInfo();
Daniel Dunbar7a95ca32008-09-10 04:01:49 +00001972 switch (RetAI.getKind()) {
Anton Korobeynikov18adbf52009-06-06 09:36:29 +00001973 case ABIArgInfo::Extend:
Alex Bradburye41a5e22018-01-12 20:08:16 +00001974 if (RetAI.isSignExt())
Jakob Stoklund Olesend7bf2932013-05-29 03:57:23 +00001975 RetAttrs.addAttribute(llvm::Attribute::SExt);
Alex Bradburye41a5e22018-01-12 20:08:16 +00001976 else
Jakob Stoklund Olesend7bf2932013-05-29 03:57:23 +00001977 RetAttrs.addAttribute(llvm::Attribute::ZExt);
Adrian Prantlf3b3ccd2017-12-19 22:06:11 +00001978 LLVM_FALLTHROUGH;
Daniel Dunbar67dace892009-02-03 06:17:37 +00001979 case ABIArgInfo::Direct:
Jakob Stoklund Olesena3661142013-06-05 03:00:09 +00001980 if (RetAI.getInReg())
1981 RetAttrs.addAttribute(llvm::Attribute::InReg);
1982 break;
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00001983 case ABIArgInfo::Ignore:
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00001984 break;
1985
Alexey Samsonov91cf4552014-08-22 01:06:06 +00001986 case ABIArgInfo::InAlloca:
Rafael Espindola06b2b4a2012-07-31 02:44:24 +00001987 case ABIArgInfo::Indirect: {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00001988 // inalloca and sret disable readnone and readonly
Bill Wendling207f0532012-12-20 19:27:06 +00001989 FuncAttrs.removeAttribute(llvm::Attribute::ReadOnly)
1990 .removeAttribute(llvm::Attribute::ReadNone);
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00001991 break;
Rafael Espindola06b2b4a2012-07-31 02:44:24 +00001992 }
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00001993
John McCallf26e73d2016-03-11 04:30:43 +00001994 case ABIArgInfo::CoerceAndExpand:
1995 break;
1996
Daniel Dunbard3674e62008-09-11 01:48:57 +00001997 case ABIArgInfo::Expand:
David Blaikie83d382b2011-09-23 05:06:16 +00001998 llvm_unreachable("Invalid ABI kind for return argument");
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00001999 }
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00002000
Hal Finkela2347ba2014-07-18 15:52:10 +00002001 if (const auto *RefTy = RetTy->getAs<ReferenceType>()) {
2002 QualType PTy = RefTy->getPointeeType();
David Majnemer9df56372015-09-10 21:52:00 +00002003 if (!PTy->isIncompleteType() && PTy->isConstantSizeType())
Hal Finkela2347ba2014-07-18 15:52:10 +00002004 RetAttrs.addDereferenceableAttr(getContext().getTypeSizeInChars(PTy)
2005 .getQuantity());
Manoj Guptada08f6a2018-07-19 00:44:52 +00002006 else if (getContext().getTargetAddressSpace(PTy) == 0 &&
2007 !CodeGenOpts.NullPointerIsValid)
Hal Finkela2347ba2014-07-18 15:52:10 +00002008 RetAttrs.addAttribute(llvm::Attribute::NonNull);
2009 }
Nick Lewycky9b46eb82014-05-28 09:56:42 +00002010
John McCall12f23522016-04-04 18:33:08 +00002011 bool hasUsedSRet = false;
Reid Klecknercdd26792017-04-18 23:50:03 +00002012 SmallVector<llvm::AttributeSet, 4> ArgAttrs(IRFunctionArgs.totalIRArgs());
John McCall12f23522016-04-04 18:33:08 +00002013
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002014 // Attach attributes to sret.
2015 if (IRFunctionArgs.hasSRetArg()) {
2016 llvm::AttrBuilder SRETAttrs;
Mandeep Singh Grang2a153102018-07-26 18:07:59 +00002017 if (!RetAI.getSuppressSRet())
2018 SRETAttrs.addAttribute(llvm::Attribute::StructRet);
John McCall12f23522016-04-04 18:33:08 +00002019 hasUsedSRet = true;
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002020 if (RetAI.getInReg())
2021 SRETAttrs.addAttribute(llvm::Attribute::InReg);
Reid Klecknercdd26792017-04-18 23:50:03 +00002022 ArgAttrs[IRFunctionArgs.getSRetArgNo()] =
2023 llvm::AttributeSet::get(getLLVMContext(), SRETAttrs);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002024 }
2025
2026 // Attach attributes to inalloca argument.
2027 if (IRFunctionArgs.hasInallocaArg()) {
2028 llvm::AttrBuilder Attrs;
2029 Attrs.addAttribute(llvm::Attribute::InAlloca);
Reid Klecknercdd26792017-04-18 23:50:03 +00002030 ArgAttrs[IRFunctionArgs.getInallocaArgNo()] =
2031 llvm::AttributeSet::get(getLLVMContext(), Attrs);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002032 }
2033
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002034 unsigned ArgNo = 0;
2035 for (CGFunctionInfo::const_arg_iterator I = FI.arg_begin(),
2036 E = FI.arg_end();
2037 I != E; ++I, ++ArgNo) {
2038 QualType ParamType = I->type;
2039 const ABIArgInfo &AI = I->info;
Bill Wendlinga514ebc2012-10-15 20:36:26 +00002040 llvm::AttrBuilder Attrs;
Anton Korobeynikovc8478242009-04-04 00:49:24 +00002041
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002042 // Add attribute for padding argument, if necessary.
2043 if (IRFunctionArgs.hasPaddingArg(ArgNo)) {
Reid Klecknercdd26792017-04-18 23:50:03 +00002044 if (AI.getPaddingInReg()) {
2045 ArgAttrs[IRFunctionArgs.getPaddingArgNo(ArgNo)] =
2046 llvm::AttributeSet::get(
2047 getLLVMContext(),
2048 llvm::AttrBuilder().addAttribute(llvm::Attribute::InReg));
2049 }
Rafael Espindolafad28de2012-10-24 01:59:00 +00002050 }
2051
John McCall39ec71f2010-03-27 00:47:27 +00002052 // 'restrict' -> 'noalias' is done in EmitFunctionProlog when we
2053 // have the corresponding parameter variable. It doesn't make
Daniel Dunbarcb2b3d02011-02-10 18:10:07 +00002054 // sense to do it here because parameters are so messed up.
Daniel Dunbard3674e62008-09-11 01:48:57 +00002055 switch (AI.getKind()) {
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002056 case ABIArgInfo::Extend:
Alex Bradburye41a5e22018-01-12 20:08:16 +00002057 if (AI.isSignExt())
Bill Wendling207f0532012-12-20 19:27:06 +00002058 Attrs.addAttribute(llvm::Attribute::SExt);
Alex Bradburye41a5e22018-01-12 20:08:16 +00002059 else
2060 Attrs.addAttribute(llvm::Attribute::ZExt);
Adrian Prantlf3b3ccd2017-12-19 22:06:11 +00002061 LLVM_FALLTHROUGH;
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002062 case ABIArgInfo::Direct:
Peter Collingbournef7706832014-12-12 23:41:25 +00002063 if (ArgNo == 0 && FI.isChainCall())
2064 Attrs.addAttribute(llvm::Attribute::Nest);
2065 else if (AI.getInReg())
Bill Wendling207f0532012-12-20 19:27:06 +00002066 Attrs.addAttribute(llvm::Attribute::InReg);
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002067 break;
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002068
James Y Knight71608572015-08-21 18:19:06 +00002069 case ABIArgInfo::Indirect: {
Rafael Espindola703c47f2012-10-19 05:04:37 +00002070 if (AI.getInReg())
Bill Wendling207f0532012-12-20 19:27:06 +00002071 Attrs.addAttribute(llvm::Attribute::InReg);
Rafael Espindola703c47f2012-10-19 05:04:37 +00002072
Anders Carlsson20759ad2009-09-16 15:53:40 +00002073 if (AI.getIndirectByVal())
Bill Wendling207f0532012-12-20 19:27:06 +00002074 Attrs.addAttribute(llvm::Attribute::ByVal);
Anders Carlsson20759ad2009-09-16 15:53:40 +00002075
John McCall7f416cc2015-09-08 08:05:57 +00002076 CharUnits Align = AI.getIndirectAlign();
James Y Knight71608572015-08-21 18:19:06 +00002077
2078 // In a byval argument, it is important that the required
2079 // alignment of the type is honored, as LLVM might be creating a
2080 // *new* stack object, and needs to know what alignment to give
2081 // it. (Sometimes it can deduce a sensible alignment on its own,
2082 // but not if clang decides it must emit a packed struct, or the
2083 // user specifies increased alignment requirements.)
2084 //
2085 // This is different from indirect *not* byval, where the object
2086 // exists already, and the align attribute is purely
2087 // informative.
John McCall7f416cc2015-09-08 08:05:57 +00002088 assert(!Align.isZero());
James Y Knight71608572015-08-21 18:19:06 +00002089
John McCall7f416cc2015-09-08 08:05:57 +00002090 // For now, only add this when we have a byval argument.
2091 // TODO: be less lazy about updating test cases.
2092 if (AI.getIndirectByVal())
2093 Attrs.addAlignmentAttr(Align.getQuantity());
Bill Wendlinga7912f82012-10-10 07:36:56 +00002094
Daniel Dunbarc2304432009-03-18 19:51:01 +00002095 // byval disables readnone and readonly.
Bill Wendling207f0532012-12-20 19:27:06 +00002096 FuncAttrs.removeAttribute(llvm::Attribute::ReadOnly)
2097 .removeAttribute(llvm::Attribute::ReadNone);
Daniel Dunbard3674e62008-09-11 01:48:57 +00002098 break;
James Y Knight71608572015-08-21 18:19:06 +00002099 }
Daniel Dunbar94a6f252009-01-26 21:26:08 +00002100 case ABIArgInfo::Ignore:
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002101 case ABIArgInfo::Expand:
John McCallf26e73d2016-03-11 04:30:43 +00002102 case ABIArgInfo::CoerceAndExpand:
2103 break;
Daniel Dunbar94a6f252009-01-26 21:26:08 +00002104
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002105 case ABIArgInfo::InAlloca:
2106 // inalloca disables readnone and readonly.
2107 FuncAttrs.removeAttribute(llvm::Attribute::ReadOnly)
2108 .removeAttribute(llvm::Attribute::ReadNone);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002109 continue;
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00002110 }
Mike Stump11289f42009-09-09 15:08:12 +00002111
Hal Finkela2347ba2014-07-18 15:52:10 +00002112 if (const auto *RefTy = ParamType->getAs<ReferenceType>()) {
2113 QualType PTy = RefTy->getPointeeType();
David Majnemer9df56372015-09-10 21:52:00 +00002114 if (!PTy->isIncompleteType() && PTy->isConstantSizeType())
Hal Finkela2347ba2014-07-18 15:52:10 +00002115 Attrs.addDereferenceableAttr(getContext().getTypeSizeInChars(PTy)
2116 .getQuantity());
Manoj Guptada08f6a2018-07-19 00:44:52 +00002117 else if (getContext().getTargetAddressSpace(PTy) == 0 &&
2118 !CodeGenOpts.NullPointerIsValid)
Hal Finkela2347ba2014-07-18 15:52:10 +00002119 Attrs.addAttribute(llvm::Attribute::NonNull);
2120 }
Nick Lewycky9b46eb82014-05-28 09:56:42 +00002121
John McCall12f23522016-04-04 18:33:08 +00002122 switch (FI.getExtParameterInfo(ArgNo).getABI()) {
2123 case ParameterABI::Ordinary:
2124 break;
2125
2126 case ParameterABI::SwiftIndirectResult: {
2127 // Add 'sret' if we haven't already used it for something, but
2128 // only if the result is void.
2129 if (!hasUsedSRet && RetTy->isVoidType()) {
2130 Attrs.addAttribute(llvm::Attribute::StructRet);
2131 hasUsedSRet = true;
2132 }
2133
2134 // Add 'noalias' in either case.
2135 Attrs.addAttribute(llvm::Attribute::NoAlias);
2136
2137 // Add 'dereferenceable' and 'alignment'.
2138 auto PTy = ParamType->getPointeeType();
2139 if (!PTy->isIncompleteType() && PTy->isConstantSizeType()) {
2140 auto info = getContext().getTypeInfoInChars(PTy);
2141 Attrs.addDereferenceableAttr(info.first.getQuantity());
2142 Attrs.addAttribute(llvm::Attribute::getWithAlignment(getLLVMContext(),
2143 info.second.getQuantity()));
2144 }
2145 break;
2146 }
2147
2148 case ParameterABI::SwiftErrorResult:
2149 Attrs.addAttribute(llvm::Attribute::SwiftError);
2150 break;
2151
2152 case ParameterABI::SwiftContext:
2153 Attrs.addAttribute(llvm::Attribute::SwiftSelf);
2154 break;
2155 }
2156
Akira Hatanaka98a49332017-09-22 00:41:05 +00002157 if (FI.getExtParameterInfo(ArgNo).isNoEscape())
2158 Attrs.addAttribute(llvm::Attribute::NoCapture);
2159
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002160 if (Attrs.hasAttributes()) {
2161 unsigned FirstIRArg, NumIRArgs;
2162 std::tie(FirstIRArg, NumIRArgs) = IRFunctionArgs.getIRArgs(ArgNo);
2163 for (unsigned i = 0; i < NumIRArgs; i++)
Reid Klecknercdd26792017-04-18 23:50:03 +00002164 ArgAttrs[FirstIRArg + i] =
2165 llvm::AttributeSet::get(getLLVMContext(), Attrs);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002166 }
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00002167 }
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002168 assert(ArgNo == FI.arg_size());
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002169
Reid Klecknercdd26792017-04-18 23:50:03 +00002170 AttrList = llvm::AttributeList::get(
2171 getLLVMContext(), llvm::AttributeSet::get(getLLVMContext(), FuncAttrs),
2172 llvm::AttributeSet::get(getLLVMContext(), RetAttrs), ArgAttrs);
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00002173}
2174
John McCalla738c252011-03-09 04:27:21 +00002175/// An argument came in as a promoted argument; demote it back to its
2176/// declared type.
2177static llvm::Value *emitArgumentDemotion(CodeGenFunction &CGF,
2178 const VarDecl *var,
2179 llvm::Value *value) {
Chris Lattner2192fe52011-07-18 04:24:23 +00002180 llvm::Type *varType = CGF.ConvertType(var->getType());
John McCalla738c252011-03-09 04:27:21 +00002181
2182 // This can happen with promotions that actually don't change the
2183 // underlying type, like the enum promotions.
2184 if (value->getType() == varType) return value;
2185
2186 assert((varType->isIntegerTy() || varType->isFloatingPointTy())
2187 && "unexpected promotion type");
2188
2189 if (isa<llvm::IntegerType>(varType))
2190 return CGF.Builder.CreateTrunc(value, varType, "arg.unpromote");
2191
2192 return CGF.Builder.CreateFPCast(value, varType, "arg.unpromote");
2193}
2194
Chandler Carruth45bbe012017-03-24 09:11:57 +00002195/// Returns the attribute (either parameter attribute, or function
2196/// attribute), which declares argument ArgNo to be non-null.
2197static const NonNullAttr *getNonNullAttr(const Decl *FD, const ParmVarDecl *PVD,
2198 QualType ArgType, unsigned ArgNo) {
2199 // FIXME: __attribute__((nonnull)) can also be applied to:
2200 // - references to pointers, where the pointee is known to be
2201 // nonnull (apparently a Clang extension)
2202 // - transparent unions containing pointers
2203 // In the former case, LLVM IR cannot represent the constraint. In
2204 // the latter case, we have no guarantee that the transparent union
2205 // is in fact passed as a pointer.
2206 if (!ArgType->isAnyPointerType() && !ArgType->isBlockPointerType())
2207 return nullptr;
2208 // First, check attribute on parameter itself.
2209 if (PVD) {
2210 if (auto ParmNNAttr = PVD->getAttr<NonNullAttr>())
2211 return ParmNNAttr;
2212 }
2213 // Check function attributes.
2214 if (!FD)
2215 return nullptr;
2216 for (const auto *NNAttr : FD->specific_attrs<NonNullAttr>()) {
2217 if (NNAttr->isNonNull(ArgNo))
2218 return NNAttr;
2219 }
2220 return nullptr;
2221}
2222
John McCall12f23522016-04-04 18:33:08 +00002223namespace {
2224 struct CopyBackSwiftError final : EHScopeStack::Cleanup {
2225 Address Temp;
2226 Address Arg;
2227 CopyBackSwiftError(Address temp, Address arg) : Temp(temp), Arg(arg) {}
2228 void Emit(CodeGenFunction &CGF, Flags flags) override {
2229 llvm::Value *errorValue = CGF.Builder.CreateLoad(Temp);
2230 CGF.Builder.CreateStore(errorValue, Arg);
2231 }
2232 };
2233}
2234
Daniel Dunbard931a872009-02-02 22:03:45 +00002235void CodeGenFunction::EmitFunctionProlog(const CGFunctionInfo &FI,
2236 llvm::Function *Fn,
Daniel Dunbar613855c2008-09-09 23:27:19 +00002237 const FunctionArgList &Args) {
Hans Wennborgd71907d2014-09-04 22:16:33 +00002238 if (CurCodeDecl && CurCodeDecl->hasAttr<NakedAttr>())
2239 // Naked functions don't have prologues.
2240 return;
2241
John McCallcaa19452009-07-28 01:00:58 +00002242 // If this is an implicit-return-zero function, go ahead and
2243 // initialize the return value. TODO: it might be nice to have
2244 // a more general mechanism for this that didn't require synthesized
2245 // return statements.
John McCalldec348f72013-05-03 07:33:41 +00002246 if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(CurCodeDecl)) {
John McCallcaa19452009-07-28 01:00:58 +00002247 if (FD->hasImplicitReturnZero()) {
Alp Toker314cc812014-01-25 16:55:45 +00002248 QualType RetTy = FD->getReturnType().getUnqualifiedType();
Chris Lattner2192fe52011-07-18 04:24:23 +00002249 llvm::Type* LLVMTy = CGM.getTypes().ConvertType(RetTy);
Owen Anderson0b75f232009-07-31 20:28:54 +00002250 llvm::Constant* Zero = llvm::Constant::getNullValue(LLVMTy);
John McCallcaa19452009-07-28 01:00:58 +00002251 Builder.CreateStore(Zero, ReturnValue);
2252 }
2253 }
2254
Mike Stump18bb9282009-05-16 07:57:57 +00002255 // FIXME: We no longer need the types from FunctionArgList; lift up and
2256 // simplify.
Daniel Dunbar5a0acdc92009-02-03 06:02:10 +00002257
Alexey Samsonov153004f2014-09-29 22:08:00 +00002258 ClangToLLVMArgMapping IRFunctionArgs(CGM.getContext(), FI);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002259 // Flattened function arguments.
John McCall12f23522016-04-04 18:33:08 +00002260 SmallVector<llvm::Value *, 16> FnArgs;
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002261 FnArgs.reserve(IRFunctionArgs.totalIRArgs());
2262 for (auto &Arg : Fn->args()) {
2263 FnArgs.push_back(&Arg);
2264 }
2265 assert(FnArgs.size() == IRFunctionArgs.totalIRArgs());
Mike Stump11289f42009-09-09 15:08:12 +00002266
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002267 // If we're using inalloca, all the memory arguments are GEPs off of the last
2268 // parameter, which is a pointer to the complete memory area.
John McCall7f416cc2015-09-08 08:05:57 +00002269 Address ArgStruct = Address::invalid();
2270 const llvm::StructLayout *ArgStructLayout = nullptr;
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002271 if (IRFunctionArgs.hasInallocaArg()) {
John McCall7f416cc2015-09-08 08:05:57 +00002272 ArgStructLayout = CGM.getDataLayout().getStructLayout(FI.getArgStruct());
2273 ArgStruct = Address(FnArgs[IRFunctionArgs.getInallocaArgNo()],
2274 FI.getArgStructAlignment());
2275
2276 assert(ArgStruct.getType() == FI.getArgStruct()->getPointerTo());
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002277 }
2278
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002279 // Name the struct return parameter.
2280 if (IRFunctionArgs.hasSRetArg()) {
John McCall12f23522016-04-04 18:33:08 +00002281 auto AI = cast<llvm::Argument>(FnArgs[IRFunctionArgs.getSRetArgNo()]);
Daniel Dunbar613855c2008-09-09 23:27:19 +00002282 AI->setName("agg.result");
Reid Klecknercdd26792017-04-18 23:50:03 +00002283 AI->addAttr(llvm::Attribute::NoAlias);
Daniel Dunbar613855c2008-09-09 23:27:19 +00002284 }
Mike Stump11289f42009-09-09 15:08:12 +00002285
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002286 // Track if we received the parameter as a pointer (indirect, byval, or
2287 // inalloca). If already have a pointer, EmitParmDecl doesn't need to copy it
2288 // into a local alloca for us.
John McCall7f416cc2015-09-08 08:05:57 +00002289 SmallVector<ParamValue, 16> ArgVals;
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002290 ArgVals.reserve(Args.size());
2291
Reid Kleckner739756c2013-12-04 19:23:12 +00002292 // Create a pointer value for every parameter declaration. This usually
2293 // entails copying one or more LLVM IR arguments into an alloca. Don't push
2294 // any cleanups or do anything that might unwind. We do that separately, so
2295 // we can push the cleanups in the correct order for the ABI.
Daniel Dunbara45bdbb2009-02-04 21:17:21 +00002296 assert(FI.arg_size() == Args.size() &&
2297 "Mismatch between function signature & arguments.");
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002298 unsigned ArgNo = 0;
Daniel Dunbarb52d0772009-02-03 05:59:18 +00002299 CGFunctionInfo::const_arg_iterator info_it = FI.arg_begin();
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002300 for (FunctionArgList::const_iterator i = Args.begin(), e = Args.end();
Devang Patel68a15252011-03-03 20:13:15 +00002301 i != e; ++i, ++info_it, ++ArgNo) {
John McCalla738c252011-03-09 04:27:21 +00002302 const VarDecl *Arg = *i;
Daniel Dunbarb52d0772009-02-03 05:59:18 +00002303 const ABIArgInfo &ArgI = info_it->info;
Daniel Dunbard3674e62008-09-11 01:48:57 +00002304
John McCalla738c252011-03-09 04:27:21 +00002305 bool isPromoted =
2306 isa<ParmVarDecl>(Arg) && cast<ParmVarDecl>(Arg)->isKNRPromoted();
Volodymyr Sapsai17ebdb22018-01-22 22:29:24 +00002307 // We are converting from ABIArgInfo type to VarDecl type directly, unless
2308 // the parameter is promoted. In this case we convert to
2309 // CGFunctionInfo::ArgInfo type with subsequent argument demotion.
2310 QualType Ty = isPromoted ? info_it->type : Arg->getType();
2311 assert(hasScalarEvaluationKind(Ty) ==
2312 hasScalarEvaluationKind(Arg->getType()));
John McCalla738c252011-03-09 04:27:21 +00002313
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002314 unsigned FirstIRArg, NumIRArgs;
2315 std::tie(FirstIRArg, NumIRArgs) = IRFunctionArgs.getIRArgs(ArgNo);
Rafael Espindolafad28de2012-10-24 01:59:00 +00002316
Daniel Dunbard3674e62008-09-11 01:48:57 +00002317 switch (ArgI.getKind()) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002318 case ABIArgInfo::InAlloca: {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002319 assert(NumIRArgs == 0);
John McCall7f416cc2015-09-08 08:05:57 +00002320 auto FieldIndex = ArgI.getInAllocaFieldIndex();
2321 CharUnits FieldOffset =
2322 CharUnits::fromQuantity(ArgStructLayout->getElementOffset(FieldIndex));
2323 Address V = Builder.CreateStructGEP(ArgStruct, FieldIndex, FieldOffset,
2324 Arg->getName());
2325 ArgVals.push_back(ParamValue::forIndirect(V));
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002326 break;
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002327 }
2328
Daniel Dunbar747865a2009-02-05 09:16:39 +00002329 case ABIArgInfo::Indirect: {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002330 assert(NumIRArgs == 1);
John McCall7f416cc2015-09-08 08:05:57 +00002331 Address ParamAddr = Address(FnArgs[FirstIRArg], ArgI.getIndirectAlign());
Daniel Dunbar7b7c2932010-09-16 20:42:02 +00002332
John McCall47fb9502013-03-07 21:37:08 +00002333 if (!hasScalarEvaluationKind(Ty)) {
Daniel Dunbar7b7c2932010-09-16 20:42:02 +00002334 // Aggregates and complex variables are accessed by reference. All we
John McCall7f416cc2015-09-08 08:05:57 +00002335 // need to do is realign the value, if requested.
2336 Address V = ParamAddr;
Daniel Dunbar7b7c2932010-09-16 20:42:02 +00002337 if (ArgI.getIndirectRealign()) {
John McCall7f416cc2015-09-08 08:05:57 +00002338 Address AlignedTemp = CreateMemTemp(Ty, "coerce");
Daniel Dunbar7b7c2932010-09-16 20:42:02 +00002339
2340 // Copy from the incoming argument pointer to the temporary with the
2341 // appropriate alignment.
2342 //
2343 // FIXME: We should have a common utility for generating an aggregate
2344 // copy.
Ken Dyck705ba072011-01-19 01:58:38 +00002345 CharUnits Size = getContext().getTypeSizeInChars(Ty);
John McCall7f416cc2015-09-08 08:05:57 +00002346 auto SizeVal = llvm::ConstantInt::get(IntPtrTy, Size.getQuantity());
2347 Address Dst = Builder.CreateBitCast(AlignedTemp, Int8PtrTy);
2348 Address Src = Builder.CreateBitCast(ParamAddr, Int8PtrTy);
2349 Builder.CreateMemCpy(Dst, Src, SizeVal, false);
Daniel Dunbar7b7c2932010-09-16 20:42:02 +00002350 V = AlignedTemp;
2351 }
John McCall7f416cc2015-09-08 08:05:57 +00002352 ArgVals.push_back(ParamValue::forIndirect(V));
Daniel Dunbar747865a2009-02-05 09:16:39 +00002353 } else {
2354 // Load scalar value from indirect argument.
John McCall7f416cc2015-09-08 08:05:57 +00002355 llvm::Value *V =
Stephen Kellyf2ceec42018-08-09 21:08:08 +00002356 EmitLoadOfScalar(ParamAddr, false, Ty, Arg->getBeginLoc());
John McCalla738c252011-03-09 04:27:21 +00002357
2358 if (isPromoted)
2359 V = emitArgumentDemotion(*this, Arg, V);
John McCall7f416cc2015-09-08 08:05:57 +00002360 ArgVals.push_back(ParamValue::forDirect(V));
Daniel Dunbar747865a2009-02-05 09:16:39 +00002361 }
Daniel Dunbar747865a2009-02-05 09:16:39 +00002362 break;
2363 }
Anton Korobeynikov18adbf52009-06-06 09:36:29 +00002364
2365 case ABIArgInfo::Extend:
Daniel Dunbar67dace892009-02-03 06:17:37 +00002366 case ABIArgInfo::Direct: {
Akira Hatanaka18334dd2012-01-09 19:08:06 +00002367
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002368 // If we have the trivial case, handle it with no muss and fuss.
2369 if (!isa<llvm::StructType>(ArgI.getCoerceToType()) &&
Volodymyr Sapsai22b00ec2017-12-21 20:52:59 +00002370 ArgI.getCoerceToType() == ConvertType(Ty) &&
Chris Lattner8a2f3c72010-07-30 04:02:24 +00002371 ArgI.getDirectOffset() == 0) {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002372 assert(NumIRArgs == 1);
John McCall12f23522016-04-04 18:33:08 +00002373 llvm::Value *V = FnArgs[FirstIRArg];
2374 auto AI = cast<llvm::Argument>(V);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002375
Hal Finkel48d53e22014-07-19 01:41:07 +00002376 if (const ParmVarDecl *PVD = dyn_cast<ParmVarDecl>(Arg)) {
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00002377 if (getNonNullAttr(CurCodeDecl, PVD, PVD->getType(),
Manoj Guptada08f6a2018-07-19 00:44:52 +00002378 PVD->getFunctionScopeIndex()) &&
2379 !CGM.getCodeGenOpts().NullPointerIsValid)
Reid Klecknercdd26792017-04-18 23:50:03 +00002380 AI->addAttr(llvm::Attribute::NonNull);
Hal Finkel82504f02014-07-11 17:35:21 +00002381
Hal Finkel48d53e22014-07-19 01:41:07 +00002382 QualType OTy = PVD->getOriginalType();
2383 if (const auto *ArrTy =
2384 getContext().getAsConstantArrayType(OTy)) {
2385 // A C99 array parameter declaration with the static keyword also
2386 // indicates dereferenceability, and if the size is constant we can
2387 // use the dereferenceable attribute (which requires the size in
2388 // bytes).
Hal Finkel16e394a2014-07-19 02:13:40 +00002389 if (ArrTy->getSizeModifier() == ArrayType::Static) {
Hal Finkel48d53e22014-07-19 01:41:07 +00002390 QualType ETy = ArrTy->getElementType();
2391 uint64_t ArrSize = ArrTy->getSize().getZExtValue();
2392 if (!ETy->isIncompleteType() && ETy->isConstantSizeType() &&
2393 ArrSize) {
2394 llvm::AttrBuilder Attrs;
2395 Attrs.addDereferenceableAttr(
2396 getContext().getTypeSizeInChars(ETy).getQuantity()*ArrSize);
Reid Kleckner9d16fa02017-04-19 17:28:52 +00002397 AI->addAttrs(Attrs);
Manoj Guptada08f6a2018-07-19 00:44:52 +00002398 } else if (getContext().getTargetAddressSpace(ETy) == 0 &&
2399 !CGM.getCodeGenOpts().NullPointerIsValid) {
Reid Klecknercdd26792017-04-18 23:50:03 +00002400 AI->addAttr(llvm::Attribute::NonNull);
Hal Finkel48d53e22014-07-19 01:41:07 +00002401 }
2402 }
2403 } else if (const auto *ArrTy =
2404 getContext().getAsVariableArrayType(OTy)) {
2405 // For C99 VLAs with the static keyword, we don't know the size so
2406 // we can't use the dereferenceable attribute, but in addrspace(0)
2407 // we know that it must be nonnull.
2408 if (ArrTy->getSizeModifier() == VariableArrayType::Static &&
Manoj Guptada08f6a2018-07-19 00:44:52 +00002409 !getContext().getTargetAddressSpace(ArrTy->getElementType()) &&
2410 !CGM.getCodeGenOpts().NullPointerIsValid)
Reid Klecknercdd26792017-04-18 23:50:03 +00002411 AI->addAttr(llvm::Attribute::NonNull);
Hal Finkel48d53e22014-07-19 01:41:07 +00002412 }
Hal Finkel1b0d24e2014-10-02 21:21:25 +00002413
2414 const auto *AVAttr = PVD->getAttr<AlignValueAttr>();
2415 if (!AVAttr)
2416 if (const auto *TOTy = dyn_cast<TypedefType>(OTy))
2417 AVAttr = TOTy->getDecl()->getAttr<AlignValueAttr>();
Roman Lebedevbd1c0872019-01-15 09:44:25 +00002418 if (AVAttr && !SanOpts.has(SanitizerKind::Alignment)) {
2419 // If alignment-assumption sanitizer is enabled, we do *not* add
2420 // alignment attribute here, but emit normal alignment assumption,
2421 // so the UBSAN check could function.
Hal Finkel1b0d24e2014-10-02 21:21:25 +00002422 llvm::Value *AlignmentValue =
2423 EmitScalarExpr(AVAttr->getAlignment());
2424 llvm::ConstantInt *AlignmentCI =
2425 cast<llvm::ConstantInt>(AlignmentValue);
Reid Kleckner9d16fa02017-04-19 17:28:52 +00002426 unsigned Alignment = std::min((unsigned)AlignmentCI->getZExtValue(),
2427 +llvm::Value::MaximumAlignment);
2428 AI->addAttrs(llvm::AttrBuilder().addAlignmentAttr(Alignment));
Hal Finkel1b0d24e2014-10-02 21:21:25 +00002429 }
Hal Finkel48d53e22014-07-19 01:41:07 +00002430 }
2431
Bill Wendling507c3512012-10-16 05:23:44 +00002432 if (Arg->getType().isRestrictQualified())
Reid Klecknercdd26792017-04-18 23:50:03 +00002433 AI->addAttr(llvm::Attribute::NoAlias);
John McCall39ec71f2010-03-27 00:47:27 +00002434
John McCall12f23522016-04-04 18:33:08 +00002435 // LLVM expects swifterror parameters to be used in very restricted
2436 // ways. Copy the value into a less-restricted temporary.
2437 if (FI.getExtParameterInfo(ArgNo).getABI()
2438 == ParameterABI::SwiftErrorResult) {
2439 QualType pointeeTy = Ty->getPointeeType();
2440 assert(pointeeTy->isPointerType());
2441 Address temp =
2442 CreateMemTemp(pointeeTy, getPointerAlign(), "swifterror.temp");
2443 Address arg = Address(V, getContext().getTypeAlignInChars(pointeeTy));
2444 llvm::Value *incomingErrorValue = Builder.CreateLoad(arg);
2445 Builder.CreateStore(incomingErrorValue, temp);
2446 V = temp.getPointer();
2447
2448 // Push a cleanup to copy the value back at the end of the function.
2449 // The convention does not guarantee that the value will be written
2450 // back if the function exits with an unwind exception.
2451 EHStack.pushCleanup<CopyBackSwiftError>(NormalCleanup, temp, arg);
2452 }
2453
Chris Lattner7369c142011-07-20 06:29:00 +00002454 // Ensure the argument is the correct type.
2455 if (V->getType() != ArgI.getCoerceToType())
2456 V = Builder.CreateBitCast(V, ArgI.getCoerceToType());
2457
John McCalla738c252011-03-09 04:27:21 +00002458 if (isPromoted)
2459 V = emitArgumentDemotion(*this, Arg, V);
Rafael Espindola8778c282012-11-29 16:09:03 +00002460
2461 // Because of merging of function types from multiple decls it is
2462 // possible for the type of an argument to not match the corresponding
2463 // type in the function type. Since we are codegening the callee
2464 // in here, add a cast to the argument type.
2465 llvm::Type *LTy = ConvertType(Arg->getType());
2466 if (V->getType() != LTy)
2467 V = Builder.CreateBitCast(V, LTy);
2468
John McCall7f416cc2015-09-08 08:05:57 +00002469 ArgVals.push_back(ParamValue::forDirect(V));
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002470 break;
Daniel Dunbard5f1f552009-02-10 00:06:49 +00002471 }
Mike Stump11289f42009-09-09 15:08:12 +00002472
Volodymyr Sapsai22b00ec2017-12-21 20:52:59 +00002473 Address Alloca = CreateMemTemp(Ty, getContext().getDeclAlign(Arg),
2474 Arg->getName());
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002475
John McCall7f416cc2015-09-08 08:05:57 +00002476 // Pointer to store into.
2477 Address Ptr = emitAddressAtOffset(*this, Alloca, ArgI);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002478
Oliver Stannard2bfdc5b2014-08-27 10:43:15 +00002479 // Fast-isel and the optimizer generally like scalar values better than
2480 // FCAs, so we flatten them if this is safe to do for this argument.
Evgeniy Stepanov3fae4ae2012-02-10 09:30:15 +00002481 llvm::StructType *STy = dyn_cast<llvm::StructType>(ArgI.getCoerceToType());
Oliver Stannard2bfdc5b2014-08-27 10:43:15 +00002482 if (ArgI.isDirect() && ArgI.getCanBeFlattened() && STy &&
2483 STy->getNumElements() > 1) {
John McCall7f416cc2015-09-08 08:05:57 +00002484 auto SrcLayout = CGM.getDataLayout().getStructLayout(STy);
Micah Villmowdd31ca12012-10-08 16:25:52 +00002485 uint64_t SrcSize = CGM.getDataLayout().getTypeAllocSize(STy);
John McCall7f416cc2015-09-08 08:05:57 +00002486 llvm::Type *DstTy = Ptr.getElementType();
Micah Villmowdd31ca12012-10-08 16:25:52 +00002487 uint64_t DstSize = CGM.getDataLayout().getTypeAllocSize(DstTy);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002488
John McCall7f416cc2015-09-08 08:05:57 +00002489 Address AddrToStoreInto = Address::invalid();
Evgeniy Stepanov3fae4ae2012-02-10 09:30:15 +00002490 if (SrcSize <= DstSize) {
Yaxun Liue9e5c4f2017-06-29 18:47:45 +00002491 AddrToStoreInto = Builder.CreateElementBitCast(Ptr, STy);
Evgeniy Stepanov3fae4ae2012-02-10 09:30:15 +00002492 } else {
John McCall7f416cc2015-09-08 08:05:57 +00002493 AddrToStoreInto =
2494 CreateTempAlloca(STy, Alloca.getAlignment(), "coerce");
Chris Lattner15ec3612010-06-29 00:06:42 +00002495 }
John McCall7f416cc2015-09-08 08:05:57 +00002496
2497 assert(STy->getNumElements() == NumIRArgs);
2498 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
2499 auto AI = FnArgs[FirstIRArg + i];
2500 AI->setName(Arg->getName() + ".coerce" + Twine(i));
2501 auto Offset = CharUnits::fromQuantity(SrcLayout->getElementOffset(i));
2502 Address EltPtr =
2503 Builder.CreateStructGEP(AddrToStoreInto, i, Offset);
2504 Builder.CreateStore(AI, EltPtr);
2505 }
2506
2507 if (SrcSize > DstSize) {
2508 Builder.CreateMemCpy(Ptr, AddrToStoreInto, DstSize);
2509 }
2510
Chris Lattner15ec3612010-06-29 00:06:42 +00002511 } else {
2512 // Simple case, just do a coerced store of the argument into the alloca.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002513 assert(NumIRArgs == 1);
2514 auto AI = FnArgs[FirstIRArg];
Chris Lattner9e748e92010-06-29 00:14:52 +00002515 AI->setName(Arg->getName() + ".coerce");
John McCall7f416cc2015-09-08 08:05:57 +00002516 CreateCoercedStore(AI, Ptr, /*DestIsVolatile=*/false, *this);
Chris Lattner15ec3612010-06-29 00:06:42 +00002517 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002518
Daniel Dunbar2f219b02009-02-03 19:12:28 +00002519 // Match to what EmitParmDecl is expecting for this type.
Volodymyr Sapsai22b00ec2017-12-21 20:52:59 +00002520 if (CodeGenFunction::hasScalarEvaluationKind(Ty)) {
John McCall7f416cc2015-09-08 08:05:57 +00002521 llvm::Value *V =
Stephen Kellyf2ceec42018-08-09 21:08:08 +00002522 EmitLoadOfScalar(Alloca, false, Ty, Arg->getBeginLoc());
John McCalla738c252011-03-09 04:27:21 +00002523 if (isPromoted)
2524 V = emitArgumentDemotion(*this, Arg, V);
John McCall7f416cc2015-09-08 08:05:57 +00002525 ArgVals.push_back(ParamValue::forDirect(V));
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002526 } else {
John McCall7f416cc2015-09-08 08:05:57 +00002527 ArgVals.push_back(ParamValue::forIndirect(Alloca));
Daniel Dunbar6e3b7df2009-02-04 07:22:24 +00002528 }
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002529 break;
Daniel Dunbar2f219b02009-02-03 19:12:28 +00002530 }
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002531
John McCallf26e73d2016-03-11 04:30:43 +00002532 case ABIArgInfo::CoerceAndExpand: {
2533 // Reconstruct into a temporary.
2534 Address alloca = CreateMemTemp(Ty, getContext().getDeclAlign(Arg));
2535 ArgVals.push_back(ParamValue::forIndirect(alloca));
2536
2537 auto coercionType = ArgI.getCoerceAndExpandType();
2538 alloca = Builder.CreateElementBitCast(alloca, coercionType);
2539 auto layout = CGM.getDataLayout().getStructLayout(coercionType);
2540
2541 unsigned argIndex = FirstIRArg;
2542 for (unsigned i = 0, e = coercionType->getNumElements(); i != e; ++i) {
2543 llvm::Type *eltType = coercionType->getElementType(i);
2544 if (ABIArgInfo::isPaddingForCoerceAndExpand(eltType))
2545 continue;
2546
2547 auto eltAddr = Builder.CreateStructGEP(alloca, i, layout);
2548 auto elt = FnArgs[argIndex++];
2549 Builder.CreateStore(elt, eltAddr);
2550 }
2551 assert(argIndex == FirstIRArg + NumIRArgs);
2552 break;
2553 }
2554
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002555 case ABIArgInfo::Expand: {
2556 // If this structure was expanded into multiple arguments then
2557 // we need to create a temporary and reconstruct it from the
2558 // arguments.
John McCall7f416cc2015-09-08 08:05:57 +00002559 Address Alloca = CreateMemTemp(Ty, getContext().getDeclAlign(Arg));
2560 LValue LV = MakeAddrLValue(Alloca, Ty);
2561 ArgVals.push_back(ParamValue::forIndirect(Alloca));
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002562
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002563 auto FnArgIter = FnArgs.begin() + FirstIRArg;
2564 ExpandTypeFromArgs(Ty, LV, FnArgIter);
2565 assert(FnArgIter == FnArgs.begin() + FirstIRArg + NumIRArgs);
2566 for (unsigned i = 0, e = NumIRArgs; i != e; ++i) {
2567 auto AI = FnArgs[FirstIRArg + i];
2568 AI->setName(Arg->getName() + "." + Twine(i));
2569 }
2570 break;
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002571 }
2572
2573 case ABIArgInfo::Ignore:
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002574 assert(NumIRArgs == 0);
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002575 // Initialize the local variable appropriately.
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002576 if (!hasScalarEvaluationKind(Ty)) {
John McCall7f416cc2015-09-08 08:05:57 +00002577 ArgVals.push_back(ParamValue::forIndirect(CreateMemTemp(Ty)));
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002578 } else {
2579 llvm::Value *U = llvm::UndefValue::get(ConvertType(Arg->getType()));
John McCall7f416cc2015-09-08 08:05:57 +00002580 ArgVals.push_back(ParamValue::forDirect(U));
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002581 }
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002582 break;
Daniel Dunbard3674e62008-09-11 01:48:57 +00002583 }
Daniel Dunbar613855c2008-09-09 23:27:19 +00002584 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002585
Reid Kleckner739756c2013-12-04 19:23:12 +00002586 if (getTarget().getCXXABI().areArgsDestroyedLeftToRightInCallee()) {
2587 for (int I = Args.size() - 1; I >= 0; --I)
John McCall7f416cc2015-09-08 08:05:57 +00002588 EmitParmDecl(*Args[I], ArgVals[I], I + 1);
Reid Kleckner739756c2013-12-04 19:23:12 +00002589 } else {
2590 for (unsigned I = 0, E = Args.size(); I != E; ++I)
John McCall7f416cc2015-09-08 08:05:57 +00002591 EmitParmDecl(*Args[I], ArgVals[I], I + 1);
Reid Kleckner739756c2013-12-04 19:23:12 +00002592 }
Daniel Dunbar613855c2008-09-09 23:27:19 +00002593}
2594
John McCallffa2c1a2012-01-29 07:46:59 +00002595static void eraseUnusedBitCasts(llvm::Instruction *insn) {
2596 while (insn->use_empty()) {
2597 llvm::BitCastInst *bitcast = dyn_cast<llvm::BitCastInst>(insn);
2598 if (!bitcast) return;
2599
2600 // This is "safe" because we would have used a ConstantExpr otherwise.
2601 insn = cast<llvm::Instruction>(bitcast->getOperand(0));
2602 bitcast->eraseFromParent();
2603 }
2604}
2605
John McCall31168b02011-06-15 23:02:42 +00002606/// Try to emit a fused autorelease of a return result.
2607static llvm::Value *tryEmitFusedAutoreleaseOfResult(CodeGenFunction &CGF,
2608 llvm::Value *result) {
2609 // We must be immediately followed the cast.
2610 llvm::BasicBlock *BB = CGF.Builder.GetInsertBlock();
Craig Topper8a13c412014-05-21 05:09:00 +00002611 if (BB->empty()) return nullptr;
2612 if (&BB->back() != result) return nullptr;
John McCall31168b02011-06-15 23:02:42 +00002613
Chris Lattner2192fe52011-07-18 04:24:23 +00002614 llvm::Type *resultType = result->getType();
John McCall31168b02011-06-15 23:02:42 +00002615
2616 // result is in a BasicBlock and is therefore an Instruction.
2617 llvm::Instruction *generator = cast<llvm::Instruction>(result);
2618
Justin Bogner882f8612016-08-18 21:46:54 +00002619 SmallVector<llvm::Instruction *, 4> InstsToKill;
John McCall31168b02011-06-15 23:02:42 +00002620
2621 // Look for:
2622 // %generator = bitcast %type1* %generator2 to %type2*
2623 while (llvm::BitCastInst *bitcast = dyn_cast<llvm::BitCastInst>(generator)) {
2624 // We would have emitted this as a constant if the operand weren't
2625 // an Instruction.
2626 generator = cast<llvm::Instruction>(bitcast->getOperand(0));
2627
2628 // Require the generator to be immediately followed by the cast.
2629 if (generator->getNextNode() != bitcast)
Craig Topper8a13c412014-05-21 05:09:00 +00002630 return nullptr;
John McCall31168b02011-06-15 23:02:42 +00002631
Justin Bogner882f8612016-08-18 21:46:54 +00002632 InstsToKill.push_back(bitcast);
John McCall31168b02011-06-15 23:02:42 +00002633 }
2634
2635 // Look for:
2636 // %generator = call i8* @objc_retain(i8* %originalResult)
2637 // or
2638 // %generator = call i8* @objc_retainAutoreleasedReturnValue(i8* %originalResult)
2639 llvm::CallInst *call = dyn_cast<llvm::CallInst>(generator);
Craig Topper8a13c412014-05-21 05:09:00 +00002640 if (!call) return nullptr;
John McCall31168b02011-06-15 23:02:42 +00002641
2642 bool doRetainAutorelease;
2643
John McCallb04ecb72015-10-21 18:06:43 +00002644 if (call->getCalledValue() == CGF.CGM.getObjCEntrypoints().objc_retain) {
John McCall31168b02011-06-15 23:02:42 +00002645 doRetainAutorelease = true;
John McCallb04ecb72015-10-21 18:06:43 +00002646 } else if (call->getCalledValue() == CGF.CGM.getObjCEntrypoints()
John McCall31168b02011-06-15 23:02:42 +00002647 .objc_retainAutoreleasedReturnValue) {
2648 doRetainAutorelease = false;
2649
John McCallcfa4e9b2012-09-07 23:30:50 +00002650 // If we emitted an assembly marker for this call (and the
2651 // ARCEntrypoints field should have been set if so), go looking
2652 // for that call. If we can't find it, we can't do this
2653 // optimization. But it should always be the immediately previous
2654 // instruction, unless we needed bitcasts around the call.
John McCallb04ecb72015-10-21 18:06:43 +00002655 if (CGF.CGM.getObjCEntrypoints().retainAutoreleasedReturnValueMarker) {
John McCallcfa4e9b2012-09-07 23:30:50 +00002656 llvm::Instruction *prev = call->getPrevNode();
2657 assert(prev);
2658 if (isa<llvm::BitCastInst>(prev)) {
2659 prev = prev->getPrevNode();
2660 assert(prev);
2661 }
2662 assert(isa<llvm::CallInst>(prev));
2663 assert(cast<llvm::CallInst>(prev)->getCalledValue() ==
John McCallb04ecb72015-10-21 18:06:43 +00002664 CGF.CGM.getObjCEntrypoints().retainAutoreleasedReturnValueMarker);
Justin Bogner882f8612016-08-18 21:46:54 +00002665 InstsToKill.push_back(prev);
John McCallcfa4e9b2012-09-07 23:30:50 +00002666 }
John McCall31168b02011-06-15 23:02:42 +00002667 } else {
Craig Topper8a13c412014-05-21 05:09:00 +00002668 return nullptr;
John McCall31168b02011-06-15 23:02:42 +00002669 }
2670
2671 result = call->getArgOperand(0);
Justin Bogner882f8612016-08-18 21:46:54 +00002672 InstsToKill.push_back(call);
John McCall31168b02011-06-15 23:02:42 +00002673
2674 // Keep killing bitcasts, for sanity. Note that we no longer care
2675 // about precise ordering as long as there's exactly one use.
2676 while (llvm::BitCastInst *bitcast = dyn_cast<llvm::BitCastInst>(result)) {
2677 if (!bitcast->hasOneUse()) break;
Justin Bogner882f8612016-08-18 21:46:54 +00002678 InstsToKill.push_back(bitcast);
John McCall31168b02011-06-15 23:02:42 +00002679 result = bitcast->getOperand(0);
2680 }
2681
2682 // Delete all the unnecessary instructions, from latest to earliest.
Justin Bogner882f8612016-08-18 21:46:54 +00002683 for (auto *I : InstsToKill)
Saleem Abdulrasoolbe25c482016-08-18 21:40:06 +00002684 I->eraseFromParent();
John McCall31168b02011-06-15 23:02:42 +00002685
2686 // Do the fused retain/autorelease if we were asked to.
2687 if (doRetainAutorelease)
2688 result = CGF.EmitARCRetainAutoreleaseReturnValue(result);
2689
2690 // Cast back to the result type.
2691 return CGF.Builder.CreateBitCast(result, resultType);
2692}
2693
John McCallffa2c1a2012-01-29 07:46:59 +00002694/// If this is a +1 of the value of an immutable 'self', remove it.
2695static llvm::Value *tryRemoveRetainOfSelf(CodeGenFunction &CGF,
2696 llvm::Value *result) {
2697 // This is only applicable to a method with an immutable 'self'.
John McCallff755cd2012-07-31 00:33:55 +00002698 const ObjCMethodDecl *method =
2699 dyn_cast_or_null<ObjCMethodDecl>(CGF.CurCodeDecl);
Craig Topper8a13c412014-05-21 05:09:00 +00002700 if (!method) return nullptr;
John McCallffa2c1a2012-01-29 07:46:59 +00002701 const VarDecl *self = method->getSelfDecl();
Craig Topper8a13c412014-05-21 05:09:00 +00002702 if (!self->getType().isConstQualified()) return nullptr;
John McCallffa2c1a2012-01-29 07:46:59 +00002703
2704 // Look for a retain call.
2705 llvm::CallInst *retainCall =
2706 dyn_cast<llvm::CallInst>(result->stripPointerCasts());
2707 if (!retainCall ||
John McCallb04ecb72015-10-21 18:06:43 +00002708 retainCall->getCalledValue() != CGF.CGM.getObjCEntrypoints().objc_retain)
Craig Topper8a13c412014-05-21 05:09:00 +00002709 return nullptr;
John McCallffa2c1a2012-01-29 07:46:59 +00002710
2711 // Look for an ordinary load of 'self'.
2712 llvm::Value *retainedValue = retainCall->getArgOperand(0);
2713 llvm::LoadInst *load =
2714 dyn_cast<llvm::LoadInst>(retainedValue->stripPointerCasts());
Fangrui Song6907ce22018-07-30 19:24:48 +00002715 if (!load || load->isAtomic() || load->isVolatile() ||
John McCall7f416cc2015-09-08 08:05:57 +00002716 load->getPointerOperand() != CGF.GetAddrOfLocalVar(self).getPointer())
Craig Topper8a13c412014-05-21 05:09:00 +00002717 return nullptr;
John McCallffa2c1a2012-01-29 07:46:59 +00002718
2719 // Okay! Burn it all down. This relies for correctness on the
2720 // assumption that the retain is emitted as part of the return and
2721 // that thereafter everything is used "linearly".
2722 llvm::Type *resultType = result->getType();
2723 eraseUnusedBitCasts(cast<llvm::Instruction>(result));
2724 assert(retainCall->use_empty());
2725 retainCall->eraseFromParent();
2726 eraseUnusedBitCasts(cast<llvm::Instruction>(retainedValue));
2727
2728 return CGF.Builder.CreateBitCast(load, resultType);
2729}
2730
John McCall31168b02011-06-15 23:02:42 +00002731/// Emit an ARC autorelease of the result of a function.
John McCallffa2c1a2012-01-29 07:46:59 +00002732///
2733/// \return the value to actually return from the function
John McCall31168b02011-06-15 23:02:42 +00002734static llvm::Value *emitAutoreleaseOfResult(CodeGenFunction &CGF,
2735 llvm::Value *result) {
John McCallffa2c1a2012-01-29 07:46:59 +00002736 // If we're returning 'self', kill the initial retain. This is a
2737 // heuristic attempt to "encourage correctness" in the really unfortunate
2738 // case where we have a return of self during a dealloc and we desperately
2739 // need to avoid the possible autorelease.
2740 if (llvm::Value *self = tryRemoveRetainOfSelf(CGF, result))
2741 return self;
2742
John McCall31168b02011-06-15 23:02:42 +00002743 // At -O0, try to emit a fused retain/autorelease.
2744 if (CGF.shouldUseFusedARCCalls())
2745 if (llvm::Value *fused = tryEmitFusedAutoreleaseOfResult(CGF, result))
2746 return fused;
2747
2748 return CGF.EmitARCAutoreleaseReturnValue(result);
2749}
2750
John McCall6e1c0122012-01-29 02:35:02 +00002751/// Heuristically search for a dominating store to the return-value slot.
2752static llvm::StoreInst *findDominatingStoreToReturnValue(CodeGenFunction &CGF) {
Jakub Kuderskif50ab0f2015-09-08 10:36:42 +00002753 // Check if a User is a store which pointerOperand is the ReturnValue.
2754 // We are looking for stores to the ReturnValue, not for stores of the
2755 // ReturnValue to some other location.
2756 auto GetStoreIfValid = [&CGF](llvm::User *U) -> llvm::StoreInst * {
2757 auto *SI = dyn_cast<llvm::StoreInst>(U);
2758 if (!SI || SI->getPointerOperand() != CGF.ReturnValue.getPointer())
2759 return nullptr;
2760 // These aren't actually possible for non-coerced returns, and we
2761 // only care about non-coerced returns on this code path.
2762 assert(!SI->isAtomic() && !SI->isVolatile());
2763 return SI;
2764 };
John McCall6e1c0122012-01-29 02:35:02 +00002765 // If there are multiple uses of the return-value slot, just check
2766 // for something immediately preceding the IP. Sometimes this can
2767 // happen with how we generate implicit-returns; it can also happen
2768 // with noreturn cleanups.
John McCall7f416cc2015-09-08 08:05:57 +00002769 if (!CGF.ReturnValue.getPointer()->hasOneUse()) {
John McCall6e1c0122012-01-29 02:35:02 +00002770 llvm::BasicBlock *IP = CGF.Builder.GetInsertBlock();
Craig Topper8a13c412014-05-21 05:09:00 +00002771 if (IP->empty()) return nullptr;
David Majnemerdc012fa2015-04-22 21:38:15 +00002772 llvm::Instruction *I = &IP->back();
2773
2774 // Skip lifetime markers
2775 for (llvm::BasicBlock::reverse_iterator II = IP->rbegin(),
2776 IE = IP->rend();
2777 II != IE; ++II) {
2778 if (llvm::IntrinsicInst *Intrinsic =
2779 dyn_cast<llvm::IntrinsicInst>(&*II)) {
2780 if (Intrinsic->getIntrinsicID() == llvm::Intrinsic::lifetime_end) {
2781 const llvm::Value *CastAddr = Intrinsic->getArgOperand(1);
2782 ++II;
Alexey Samsonov10544202015-06-12 21:05:32 +00002783 if (II == IE)
2784 break;
2785 if (isa<llvm::BitCastInst>(&*II) && (CastAddr == &*II))
2786 continue;
David Majnemerdc012fa2015-04-22 21:38:15 +00002787 }
2788 }
2789 I = &*II;
2790 break;
2791 }
2792
Jakub Kuderskif50ab0f2015-09-08 10:36:42 +00002793 return GetStoreIfValid(I);
John McCall6e1c0122012-01-29 02:35:02 +00002794 }
2795
2796 llvm::StoreInst *store =
Jakub Kuderskif50ab0f2015-09-08 10:36:42 +00002797 GetStoreIfValid(CGF.ReturnValue.getPointer()->user_back());
Craig Topper8a13c412014-05-21 05:09:00 +00002798 if (!store) return nullptr;
John McCall6e1c0122012-01-29 02:35:02 +00002799
John McCall6e1c0122012-01-29 02:35:02 +00002800 // Now do a first-and-dirty dominance check: just walk up the
2801 // single-predecessors chain from the current insertion point.
2802 llvm::BasicBlock *StoreBB = store->getParent();
2803 llvm::BasicBlock *IP = CGF.Builder.GetInsertBlock();
2804 while (IP != StoreBB) {
2805 if (!(IP = IP->getSinglePredecessor()))
Craig Topper8a13c412014-05-21 05:09:00 +00002806 return nullptr;
John McCall6e1c0122012-01-29 02:35:02 +00002807 }
2808
2809 // Okay, the store's basic block dominates the insertion point; we
2810 // can do our thing.
2811 return store;
2812}
2813
Adrian Prantl3be10542013-05-02 17:30:20 +00002814void CodeGenFunction::EmitFunctionEpilog(const CGFunctionInfo &FI,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002815 bool EmitRetDbgLoc,
2816 SourceLocation EndLoc) {
Vedant Kumar09b5bfd2017-12-21 00:10:25 +00002817 if (FI.isNoReturn()) {
2818 // Noreturn functions don't return.
2819 EmitUnreachable(EndLoc);
2820 return;
2821 }
2822
Hans Wennborgd71907d2014-09-04 22:16:33 +00002823 if (CurCodeDecl && CurCodeDecl->hasAttr<NakedAttr>()) {
2824 // Naked functions don't have epilogues.
2825 Builder.CreateUnreachable();
2826 return;
2827 }
2828
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00002829 // Functions with no result always return void.
John McCall7f416cc2015-09-08 08:05:57 +00002830 if (!ReturnValue.isValid()) {
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00002831 Builder.CreateRetVoid();
Chris Lattner726b3d02010-06-26 23:13:19 +00002832 return;
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00002833 }
Daniel Dunbar6696e222010-06-30 21:27:58 +00002834
Dan Gohman481e40c2010-07-20 20:13:52 +00002835 llvm::DebugLoc RetDbgLoc;
Craig Topper8a13c412014-05-21 05:09:00 +00002836 llvm::Value *RV = nullptr;
Chris Lattner726b3d02010-06-26 23:13:19 +00002837 QualType RetTy = FI.getReturnType();
2838 const ABIArgInfo &RetAI = FI.getReturnInfo();
2839
2840 switch (RetAI.getKind()) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002841 case ABIArgInfo::InAlloca:
Reid Klecknerfab1e892014-02-25 00:59:14 +00002842 // Aggregrates get evaluated directly into the destination. Sometimes we
2843 // need to return the sret value in a register, though.
2844 assert(hasAggregateEvaluationKind(RetTy));
2845 if (RetAI.getInAllocaSRet()) {
2846 llvm::Function::arg_iterator EI = CurFn->arg_end();
2847 --EI;
Duncan P. N. Exon Smith9f5260a2015-11-06 23:00:41 +00002848 llvm::Value *ArgStruct = &*EI;
David Blaikie2e804282015-04-05 22:47:07 +00002849 llvm::Value *SRet = Builder.CreateStructGEP(
2850 nullptr, ArgStruct, RetAI.getInAllocaFieldIndex());
John McCall7f416cc2015-09-08 08:05:57 +00002851 RV = Builder.CreateAlignedLoad(SRet, getPointerAlign(), "sret");
Reid Klecknerfab1e892014-02-25 00:59:14 +00002852 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002853 break;
2854
Daniel Dunbar03816342010-08-21 02:24:36 +00002855 case ABIArgInfo::Indirect: {
Reid Kleckner37abaca2014-05-09 22:46:15 +00002856 auto AI = CurFn->arg_begin();
2857 if (RetAI.isSRetAfterThis())
2858 ++AI;
John McCall47fb9502013-03-07 21:37:08 +00002859 switch (getEvaluationKind(RetTy)) {
2860 case TEK_Complex: {
2861 ComplexPairTy RT =
John McCall7f416cc2015-09-08 08:05:57 +00002862 EmitLoadOfComplex(MakeAddrLValue(ReturnValue, RetTy), EndLoc);
Duncan P. N. Exon Smith9f5260a2015-11-06 23:00:41 +00002863 EmitStoreOfComplex(RT, MakeNaturalAlignAddrLValue(&*AI, RetTy),
John McCall47fb9502013-03-07 21:37:08 +00002864 /*isInit*/ true);
2865 break;
2866 }
2867 case TEK_Aggregate:
Chris Lattner726b3d02010-06-26 23:13:19 +00002868 // Do nothing; aggregrates get evaluated directly into the destination.
John McCall47fb9502013-03-07 21:37:08 +00002869 break;
2870 case TEK_Scalar:
2871 EmitStoreOfScalar(Builder.CreateLoad(ReturnValue),
Duncan P. N. Exon Smith9f5260a2015-11-06 23:00:41 +00002872 MakeNaturalAlignAddrLValue(&*AI, RetTy),
John McCall47fb9502013-03-07 21:37:08 +00002873 /*isInit*/ true);
2874 break;
Chris Lattner726b3d02010-06-26 23:13:19 +00002875 }
2876 break;
Daniel Dunbar03816342010-08-21 02:24:36 +00002877 }
Chris Lattner726b3d02010-06-26 23:13:19 +00002878
2879 case ABIArgInfo::Extend:
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002880 case ABIArgInfo::Direct:
Chris Lattner8a2f3c72010-07-30 04:02:24 +00002881 if (RetAI.getCoerceToType() == ConvertType(RetTy) &&
2882 RetAI.getDirectOffset() == 0) {
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002883 // The internal return value temp always will have pointer-to-return-type
2884 // type, just do a load.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002885
John McCall6e1c0122012-01-29 02:35:02 +00002886 // If there is a dominating store to ReturnValue, we can elide
2887 // the load, zap the store, and usually zap the alloca.
David Majnemerdc012fa2015-04-22 21:38:15 +00002888 if (llvm::StoreInst *SI =
2889 findDominatingStoreToReturnValue(*this)) {
Adrian Prantl4c9a38a2013-05-30 18:12:23 +00002890 // Reuse the debug location from the store unless there is
2891 // cleanup code to be emitted between the store and return
2892 // instruction.
2893 if (EmitRetDbgLoc && !AutoreleaseResult)
Adrian Prantl3be10542013-05-02 17:30:20 +00002894 RetDbgLoc = SI->getDebugLoc();
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002895 // Get the stored value and nuke the now-dead store.
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002896 RV = SI->getValueOperand();
2897 SI->eraseFromParent();
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002898
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002899 // If that was the only use of the return value, nuke it as well now.
John McCall7f416cc2015-09-08 08:05:57 +00002900 auto returnValueInst = ReturnValue.getPointer();
2901 if (returnValueInst->use_empty()) {
2902 if (auto alloca = dyn_cast<llvm::AllocaInst>(returnValueInst)) {
2903 alloca->eraseFromParent();
2904 ReturnValue = Address::invalid();
2905 }
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002906 }
John McCall6e1c0122012-01-29 02:35:02 +00002907
2908 // Otherwise, we have to do a simple load.
2909 } else {
2910 RV = Builder.CreateLoad(ReturnValue);
Chris Lattner3fcc7902010-06-27 01:06:27 +00002911 }
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002912 } else {
Chris Lattner8a2f3c72010-07-30 04:02:24 +00002913 // If the value is offset in memory, apply the offset now.
John McCall7f416cc2015-09-08 08:05:57 +00002914 Address V = emitAddressAtOffset(*this, ReturnValue, RetAI);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002915
John McCall7f416cc2015-09-08 08:05:57 +00002916 RV = CreateCoercedLoad(V, RetAI.getCoerceToType(), *this);
Chris Lattner3fcc7902010-06-27 01:06:27 +00002917 }
John McCall31168b02011-06-15 23:02:42 +00002918
2919 // In ARC, end functions that return a retainable type with a call
2920 // to objc_autoreleaseReturnValue.
2921 if (AutoreleaseResult) {
Akira Hatanaka9d8ac612016-02-17 21:09:50 +00002922#ifndef NDEBUG
2923 // Type::isObjCRetainabletype has to be called on a QualType that hasn't
2924 // been stripped of the typedefs, so we cannot use RetTy here. Get the
2925 // original return type of FunctionDecl, CurCodeDecl, and BlockDecl from
2926 // CurCodeDecl or BlockInfo.
2927 QualType RT;
2928
2929 if (auto *FD = dyn_cast<FunctionDecl>(CurCodeDecl))
2930 RT = FD->getReturnType();
2931 else if (auto *MD = dyn_cast<ObjCMethodDecl>(CurCodeDecl))
2932 RT = MD->getReturnType();
2933 else if (isa<BlockDecl>(CurCodeDecl))
2934 RT = BlockInfo->BlockExpression->getFunctionType()->getReturnType();
2935 else
2936 llvm_unreachable("Unexpected function/method type");
2937
David Blaikiebbafb8a2012-03-11 07:00:24 +00002938 assert(getLangOpts().ObjCAutoRefCount &&
John McCall31168b02011-06-15 23:02:42 +00002939 !FI.isReturnsRetained() &&
Akira Hatanaka9d8ac612016-02-17 21:09:50 +00002940 RT->isObjCRetainableType());
2941#endif
John McCall31168b02011-06-15 23:02:42 +00002942 RV = emitAutoreleaseOfResult(*this, RV);
2943 }
2944
Chris Lattner726b3d02010-06-26 23:13:19 +00002945 break;
Chris Lattner726b3d02010-06-26 23:13:19 +00002946
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002947 case ABIArgInfo::Ignore:
Chris Lattner726b3d02010-06-26 23:13:19 +00002948 break;
2949
John McCallf26e73d2016-03-11 04:30:43 +00002950 case ABIArgInfo::CoerceAndExpand: {
2951 auto coercionType = RetAI.getCoerceAndExpandType();
2952 auto layout = CGM.getDataLayout().getStructLayout(coercionType);
2953
2954 // Load all of the coerced elements out into results.
2955 llvm::SmallVector<llvm::Value*, 4> results;
2956 Address addr = Builder.CreateElementBitCast(ReturnValue, coercionType);
2957 for (unsigned i = 0, e = coercionType->getNumElements(); i != e; ++i) {
2958 auto coercedEltType = coercionType->getElementType(i);
2959 if (ABIArgInfo::isPaddingForCoerceAndExpand(coercedEltType))
2960 continue;
2961
2962 auto eltAddr = Builder.CreateStructGEP(addr, i, layout);
2963 auto elt = Builder.CreateLoad(eltAddr);
2964 results.push_back(elt);
2965 }
2966
2967 // If we have one result, it's the single direct result type.
2968 if (results.size() == 1) {
2969 RV = results[0];
2970
2971 // Otherwise, we need to make a first-class aggregate.
2972 } else {
2973 // Construct a return type that lacks padding elements.
2974 llvm::Type *returnType = RetAI.getUnpaddedCoerceAndExpandType();
2975
2976 RV = llvm::UndefValue::get(returnType);
2977 for (unsigned i = 0, e = results.size(); i != e; ++i) {
2978 RV = Builder.CreateInsertValue(RV, results[i], i);
2979 }
2980 }
2981 break;
2982 }
2983
Chris Lattner726b3d02010-06-26 23:13:19 +00002984 case ABIArgInfo::Expand:
David Blaikie83d382b2011-09-23 05:06:16 +00002985 llvm_unreachable("Invalid ABI kind for return argument");
Chris Lattner726b3d02010-06-26 23:13:19 +00002986 }
2987
Alexey Samsonovde443c52014-08-13 00:26:40 +00002988 llvm::Instruction *Ret;
2989 if (RV) {
Vedant Kumarc34d3432017-06-23 21:32:38 +00002990 EmitReturnValueCheck(RV);
Alexey Samsonovde443c52014-08-13 00:26:40 +00002991 Ret = Builder.CreateRet(RV);
2992 } else {
2993 Ret = Builder.CreateRetVoid();
2994 }
2995
Duncan P. N. Exon Smith2809cc72015-03-30 20:01:41 +00002996 if (RetDbgLoc)
Benjamin Kramer03278662015-02-07 13:15:54 +00002997 Ret->setDebugLoc(std::move(RetDbgLoc));
Daniel Dunbar613855c2008-09-09 23:27:19 +00002998}
2999
Vedant Kumarc34d3432017-06-23 21:32:38 +00003000void CodeGenFunction::EmitReturnValueCheck(llvm::Value *RV) {
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003001 // A current decl may not be available when emitting vtable thunks.
3002 if (!CurCodeDecl)
3003 return;
3004
3005 ReturnsNonNullAttr *RetNNAttr = nullptr;
3006 if (SanOpts.has(SanitizerKind::ReturnsNonnullAttribute))
3007 RetNNAttr = CurCodeDecl->getAttr<ReturnsNonNullAttr>();
3008
3009 if (!RetNNAttr && !requiresReturnValueNullabilityCheck())
3010 return;
3011
3012 // Prefer the returns_nonnull attribute if it's present.
3013 SourceLocation AttrLoc;
3014 SanitizerMask CheckKind;
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00003015 SanitizerHandler Handler;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003016 if (RetNNAttr) {
3017 assert(!requiresReturnValueNullabilityCheck() &&
3018 "Cannot check nullability and the nonnull attribute");
3019 AttrLoc = RetNNAttr->getLocation();
3020 CheckKind = SanitizerKind::ReturnsNonnullAttribute;
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00003021 Handler = SanitizerHandler::NonnullReturn;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003022 } else {
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003023 if (auto *DD = dyn_cast<DeclaratorDecl>(CurCodeDecl))
3024 if (auto *TSI = DD->getTypeSourceInfo())
3025 if (auto FTL = TSI->getTypeLoc().castAs<FunctionTypeLoc>())
3026 AttrLoc = FTL.getReturnLoc().findNullabilityLoc();
3027 CheckKind = SanitizerKind::NullabilityReturn;
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00003028 Handler = SanitizerHandler::NullabilityReturn;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003029 }
3030
3031 SanitizerScope SanScope(this);
3032
Vedant Kumarc34d3432017-06-23 21:32:38 +00003033 // Make sure the "return" source location is valid. If we're checking a
3034 // nullability annotation, make sure the preconditions for the check are met.
3035 llvm::BasicBlock *Check = createBasicBlock("nullcheck");
3036 llvm::BasicBlock *NoCheck = createBasicBlock("no.nullcheck");
3037 llvm::Value *SLocPtr = Builder.CreateLoad(ReturnLocation, "return.sloc.load");
3038 llvm::Value *CanNullCheck = Builder.CreateIsNotNull(SLocPtr);
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003039 if (requiresReturnValueNullabilityCheck())
Vedant Kumarc34d3432017-06-23 21:32:38 +00003040 CanNullCheck =
3041 Builder.CreateAnd(CanNullCheck, RetValNullabilityPrecondition);
3042 Builder.CreateCondBr(CanNullCheck, Check, NoCheck);
3043 EmitBlock(Check);
3044
3045 // Now do the null check.
3046 llvm::Value *Cond = Builder.CreateIsNotNull(RV);
3047 llvm::Constant *StaticData[] = {EmitCheckSourceLocation(AttrLoc)};
3048 llvm::Value *DynamicData[] = {SLocPtr};
3049 EmitCheck(std::make_pair(Cond, CheckKind), Handler, StaticData, DynamicData);
3050
3051 EmitBlock(NoCheck);
3052
3053#ifndef NDEBUG
3054 // The return location should not be used after the check has been emitted.
3055 ReturnLocation = Address::invalid();
3056#endif
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003057}
3058
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003059static bool isInAllocaArgument(CGCXXABI &ABI, QualType type) {
3060 const CXXRecordDecl *RD = type->getAsCXXRecordDecl();
3061 return RD && ABI.getRecordArgABI(RD) == CGCXXABI::RAA_DirectInMemory;
3062}
3063
John McCall7f416cc2015-09-08 08:05:57 +00003064static AggValueSlot createPlaceholderSlot(CodeGenFunction &CGF,
3065 QualType Ty) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003066 // FIXME: Generate IR in one pass, rather than going back and fixing up these
3067 // placeholders.
3068 llvm::Type *IRTy = CGF.ConvertTypeForMem(Ty);
Peter Collingbourneb367c562016-11-28 22:30:21 +00003069 llvm::Type *IRPtrTy = IRTy->getPointerTo();
3070 llvm::Value *Placeholder = llvm::UndefValue::get(IRPtrTy->getPointerTo());
John McCall7f416cc2015-09-08 08:05:57 +00003071
3072 // FIXME: When we generate this IR in one pass, we shouldn't need
3073 // this win32-specific alignment hack.
3074 CharUnits Align = CharUnits::fromQuantity(4);
Peter Collingbourneb367c562016-11-28 22:30:21 +00003075 Placeholder = CGF.Builder.CreateAlignedLoad(IRPtrTy, Placeholder, Align);
John McCall7f416cc2015-09-08 08:05:57 +00003076
3077 return AggValueSlot::forAddr(Address(Placeholder, Align),
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003078 Ty.getQualifiers(),
3079 AggValueSlot::IsNotDestructed,
3080 AggValueSlot::DoesNotNeedGCBarriers,
Richard Smithe78fac52018-04-05 20:52:58 +00003081 AggValueSlot::IsNotAliased,
3082 AggValueSlot::DoesNotOverlap);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003083}
3084
John McCall32ea9692011-03-11 20:59:21 +00003085void CodeGenFunction::EmitDelegateCallArg(CallArgList &args,
Nick Lewycky2d84e842013-10-02 02:29:49 +00003086 const VarDecl *param,
3087 SourceLocation loc) {
John McCall23f66262010-05-26 22:34:26 +00003088 // StartFunction converted the ABI-lowered parameter(s) into a
3089 // local alloca. We need to turn that into an r-value suitable
3090 // for EmitCall.
John McCall7f416cc2015-09-08 08:05:57 +00003091 Address local = GetAddrOfLocalVar(param);
John McCall23f66262010-05-26 22:34:26 +00003092
John McCall32ea9692011-03-11 20:59:21 +00003093 QualType type = param->getType();
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003094
Reid Kleckner25b56022018-12-12 23:46:06 +00003095 if (isInAllocaArgument(CGM.getCXXABI(), type)) {
3096 CGM.ErrorUnsupported(param, "forwarded non-trivially copyable parameter");
3097 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003098
John McCall811b2912016-11-18 01:08:24 +00003099 // GetAddrOfLocalVar returns a pointer-to-pointer for references,
3100 // but the argument needs to be the original pointer.
3101 if (type->isReferenceType()) {
3102 args.add(RValue::get(Builder.CreateLoad(local)), type);
3103
3104 // In ARC, move out of consumed arguments so that the release cleanup
3105 // entered by StartFunction doesn't cause an over-release. This isn't
3106 // optimal -O0 code generation, but it should get cleaned up when
3107 // optimization is enabled. This also assumes that delegate calls are
3108 // performed exactly once for a set of arguments, but that should be safe.
3109 } else if (getLangOpts().ObjCAutoRefCount &&
3110 param->hasAttr<NSConsumedAttr>() &&
3111 type->isObjCRetainableType()) {
3112 llvm::Value *ptr = Builder.CreateLoad(local);
3113 auto null =
3114 llvm::ConstantPointerNull::get(cast<llvm::PointerType>(ptr->getType()));
3115 Builder.CreateStore(null, local);
3116 args.add(RValue::get(ptr), type);
3117
Richard Smithd62d4982016-06-14 01:13:21 +00003118 // For the most part, we just need to load the alloca, except that
3119 // aggregate r-values are actually pointers to temporaries.
John McCall811b2912016-11-18 01:08:24 +00003120 } else {
Richard Smithd62d4982016-06-14 01:13:21 +00003121 args.add(convertTempToRValue(local, type, loc), type);
John McCall811b2912016-11-18 01:08:24 +00003122 }
Akira Hatanakaccda3d22018-04-27 06:57:00 +00003123
3124 // Deactivate the cleanup for the callee-destructed param that was pushed.
3125 if (hasAggregateEvaluationKind(type) && !CurFuncIsThunk &&
Akira Hatanaka85282972018-05-15 21:00:30 +00003126 type->getAs<RecordType>()->getDecl()->isParamDestroyedInCallee() &&
3127 type.isDestructedType()) {
Akira Hatanakaccda3d22018-04-27 06:57:00 +00003128 EHScopeStack::stable_iterator cleanup =
3129 CalleeDestructedParamCleanups.lookup(cast<ParmVarDecl>(param));
3130 assert(cleanup.isValid() &&
3131 "cleanup for callee-destructed param not recorded");
3132 // This unreachable is a temporary marker which will be removed later.
3133 llvm::Instruction *isActive = Builder.CreateUnreachable();
3134 args.addArgCleanupDeactivation(cleanup, isActive);
3135 }
John McCall23f66262010-05-26 22:34:26 +00003136}
3137
John McCall31168b02011-06-15 23:02:42 +00003138static bool isProvablyNull(llvm::Value *addr) {
3139 return isa<llvm::ConstantPointerNull>(addr);
3140}
3141
John McCall31168b02011-06-15 23:02:42 +00003142/// Emit the actual writing-back of a writeback.
3143static void emitWriteback(CodeGenFunction &CGF,
3144 const CallArgList::Writeback &writeback) {
John McCalleff18842013-03-23 02:35:54 +00003145 const LValue &srcLV = writeback.Source;
John McCall7f416cc2015-09-08 08:05:57 +00003146 Address srcAddr = srcLV.getAddress();
3147 assert(!isProvablyNull(srcAddr.getPointer()) &&
John McCall31168b02011-06-15 23:02:42 +00003148 "shouldn't have writeback for provably null argument");
3149
Craig Topper8a13c412014-05-21 05:09:00 +00003150 llvm::BasicBlock *contBB = nullptr;
John McCall31168b02011-06-15 23:02:42 +00003151
3152 // If the argument wasn't provably non-null, we need to null check
3153 // before doing the store.
Nuno Lopes9211cee2017-09-09 18:25:36 +00003154 bool provablyNonNull = llvm::isKnownNonZero(srcAddr.getPointer(),
3155 CGF.CGM.getDataLayout());
John McCall31168b02011-06-15 23:02:42 +00003156 if (!provablyNonNull) {
3157 llvm::BasicBlock *writebackBB = CGF.createBasicBlock("icr.writeback");
3158 contBB = CGF.createBasicBlock("icr.done");
3159
John McCall7f416cc2015-09-08 08:05:57 +00003160 llvm::Value *isNull =
3161 CGF.Builder.CreateIsNull(srcAddr.getPointer(), "icr.isnull");
John McCall31168b02011-06-15 23:02:42 +00003162 CGF.Builder.CreateCondBr(isNull, contBB, writebackBB);
3163 CGF.EmitBlock(writebackBB);
3164 }
3165
3166 // Load the value to writeback.
3167 llvm::Value *value = CGF.Builder.CreateLoad(writeback.Temporary);
3168
3169 // Cast it back, in case we're writing an id to a Foo* or something.
John McCall7f416cc2015-09-08 08:05:57 +00003170 value = CGF.Builder.CreateBitCast(value, srcAddr.getElementType(),
3171 "icr.writeback-cast");
Fangrui Song6907ce22018-07-30 19:24:48 +00003172
John McCall31168b02011-06-15 23:02:42 +00003173 // Perform the writeback.
John McCalleff18842013-03-23 02:35:54 +00003174
3175 // If we have a "to use" value, it's something we need to emit a use
3176 // of. This has to be carefully threaded in: if it's done after the
3177 // release it's potentially undefined behavior (and the optimizer
3178 // will ignore it), and if it happens before the retain then the
3179 // optimizer could move the release there.
3180 if (writeback.ToUse) {
3181 assert(srcLV.getObjCLifetime() == Qualifiers::OCL_Strong);
3182
3183 // Retain the new value. No need to block-copy here: the block's
3184 // being passed up the stack.
3185 value = CGF.EmitARCRetainNonBlock(value);
3186
3187 // Emit the intrinsic use here.
3188 CGF.EmitARCIntrinsicUse(writeback.ToUse);
3189
3190 // Load the old value (primitively).
Nick Lewycky2d84e842013-10-02 02:29:49 +00003191 llvm::Value *oldValue = CGF.EmitLoadOfScalar(srcLV, SourceLocation());
John McCalleff18842013-03-23 02:35:54 +00003192
3193 // Put the new value in place (primitively).
3194 CGF.EmitStoreOfScalar(value, srcLV, /*init*/ false);
3195
3196 // Release the old value.
3197 CGF.EmitARCRelease(oldValue, srcLV.isARCPreciseLifetime());
3198
3199 // Otherwise, we can just do a normal lvalue store.
3200 } else {
3201 CGF.EmitStoreThroughLValue(RValue::get(value), srcLV);
3202 }
John McCall31168b02011-06-15 23:02:42 +00003203
3204 // Jump to the continuation block.
3205 if (!provablyNonNull)
3206 CGF.EmitBlock(contBB);
3207}
3208
3209static void emitWritebacks(CodeGenFunction &CGF,
3210 const CallArgList &args) {
Aaron Ballman36a7fa82014-03-17 17:22:27 +00003211 for (const auto &I : args.writebacks())
3212 emitWriteback(CGF, I);
John McCall31168b02011-06-15 23:02:42 +00003213}
3214
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003215static void deactivateArgCleanupsBeforeCall(CodeGenFunction &CGF,
3216 const CallArgList &CallArgs) {
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003217 ArrayRef<CallArgList::CallArgCleanup> Cleanups =
3218 CallArgs.getCleanupsToDeactivate();
3219 // Iterate in reverse to increase the likelihood of popping the cleanup.
Pete Cooper57d3f142015-07-30 17:22:52 +00003220 for (const auto &I : llvm::reverse(Cleanups)) {
3221 CGF.DeactivateCleanupBlock(I.Cleanup, I.IsActiveIP);
3222 I.IsActiveIP->eraseFromParent();
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003223 }
3224}
3225
John McCalleff18842013-03-23 02:35:54 +00003226static const Expr *maybeGetUnaryAddrOfOperand(const Expr *E) {
3227 if (const UnaryOperator *uop = dyn_cast<UnaryOperator>(E->IgnoreParens()))
3228 if (uop->getOpcode() == UO_AddrOf)
3229 return uop->getSubExpr();
Craig Topper8a13c412014-05-21 05:09:00 +00003230 return nullptr;
John McCalleff18842013-03-23 02:35:54 +00003231}
3232
John McCall31168b02011-06-15 23:02:42 +00003233/// Emit an argument that's being passed call-by-writeback. That is,
John McCall7f416cc2015-09-08 08:05:57 +00003234/// we are passing the address of an __autoreleased temporary; it
3235/// might be copy-initialized with the current value of the given
3236/// address, but it will definitely be copied out of after the call.
John McCall31168b02011-06-15 23:02:42 +00003237static void emitWritebackArg(CodeGenFunction &CGF, CallArgList &args,
3238 const ObjCIndirectCopyRestoreExpr *CRE) {
John McCalleff18842013-03-23 02:35:54 +00003239 LValue srcLV;
3240
3241 // Make an optimistic effort to emit the address as an l-value.
Eric Christopher2c4555a2015-06-19 01:52:53 +00003242 // This can fail if the argument expression is more complicated.
John McCalleff18842013-03-23 02:35:54 +00003243 if (const Expr *lvExpr = maybeGetUnaryAddrOfOperand(CRE->getSubExpr())) {
3244 srcLV = CGF.EmitLValue(lvExpr);
3245
3246 // Otherwise, just emit it as a scalar.
3247 } else {
John McCall7f416cc2015-09-08 08:05:57 +00003248 Address srcAddr = CGF.EmitPointerWithAlignment(CRE->getSubExpr());
John McCalleff18842013-03-23 02:35:54 +00003249
3250 QualType srcAddrType =
3251 CRE->getSubExpr()->getType()->castAs<PointerType>()->getPointeeType();
John McCall7f416cc2015-09-08 08:05:57 +00003252 srcLV = CGF.MakeAddrLValue(srcAddr, srcAddrType);
John McCalleff18842013-03-23 02:35:54 +00003253 }
John McCall7f416cc2015-09-08 08:05:57 +00003254 Address srcAddr = srcLV.getAddress();
John McCall31168b02011-06-15 23:02:42 +00003255
3256 // The dest and src types don't necessarily match in LLVM terms
3257 // because of the crazy ObjC compatibility rules.
3258
Chris Lattner2192fe52011-07-18 04:24:23 +00003259 llvm::PointerType *destType =
John McCall31168b02011-06-15 23:02:42 +00003260 cast<llvm::PointerType>(CGF.ConvertType(CRE->getType()));
3261
3262 // If the address is a constant null, just pass the appropriate null.
John McCall7f416cc2015-09-08 08:05:57 +00003263 if (isProvablyNull(srcAddr.getPointer())) {
John McCall31168b02011-06-15 23:02:42 +00003264 args.add(RValue::get(llvm::ConstantPointerNull::get(destType)),
3265 CRE->getType());
3266 return;
3267 }
3268
John McCall31168b02011-06-15 23:02:42 +00003269 // Create the temporary.
John McCall7f416cc2015-09-08 08:05:57 +00003270 Address temp = CGF.CreateTempAlloca(destType->getElementType(),
3271 CGF.getPointerAlign(),
3272 "icr.temp");
Fariborz Jahanianfbd19742012-11-27 23:02:53 +00003273 // Loading an l-value can introduce a cleanup if the l-value is __weak,
3274 // and that cleanup will be conditional if we can't prove that the l-value
3275 // isn't null, so we need to register a dominating point so that the cleanups
3276 // system will make valid IR.
3277 CodeGenFunction::ConditionalEvaluation condEval(CGF);
Fangrui Song6907ce22018-07-30 19:24:48 +00003278
John McCall31168b02011-06-15 23:02:42 +00003279 // Zero-initialize it if we're not doing a copy-initialization.
3280 bool shouldCopy = CRE->shouldCopy();
3281 if (!shouldCopy) {
3282 llvm::Value *null =
3283 llvm::ConstantPointerNull::get(
3284 cast<llvm::PointerType>(destType->getElementType()));
3285 CGF.Builder.CreateStore(null, temp);
3286 }
Craig Topper8a13c412014-05-21 05:09:00 +00003287
3288 llvm::BasicBlock *contBB = nullptr;
3289 llvm::BasicBlock *originBB = nullptr;
John McCall31168b02011-06-15 23:02:42 +00003290
3291 // If the address is *not* known to be non-null, we need to switch.
3292 llvm::Value *finalArgument;
3293
Nuno Lopes9211cee2017-09-09 18:25:36 +00003294 bool provablyNonNull = llvm::isKnownNonZero(srcAddr.getPointer(),
3295 CGF.CGM.getDataLayout());
John McCall31168b02011-06-15 23:02:42 +00003296 if (provablyNonNull) {
John McCall7f416cc2015-09-08 08:05:57 +00003297 finalArgument = temp.getPointer();
John McCall31168b02011-06-15 23:02:42 +00003298 } else {
John McCall7f416cc2015-09-08 08:05:57 +00003299 llvm::Value *isNull =
3300 CGF.Builder.CreateIsNull(srcAddr.getPointer(), "icr.isnull");
John McCall31168b02011-06-15 23:02:42 +00003301
Fangrui Song6907ce22018-07-30 19:24:48 +00003302 finalArgument = CGF.Builder.CreateSelect(isNull,
John McCall31168b02011-06-15 23:02:42 +00003303 llvm::ConstantPointerNull::get(destType),
John McCall7f416cc2015-09-08 08:05:57 +00003304 temp.getPointer(), "icr.argument");
John McCall31168b02011-06-15 23:02:42 +00003305
3306 // If we need to copy, then the load has to be conditional, which
3307 // means we need control flow.
3308 if (shouldCopy) {
John McCalleff18842013-03-23 02:35:54 +00003309 originBB = CGF.Builder.GetInsertBlock();
John McCall31168b02011-06-15 23:02:42 +00003310 contBB = CGF.createBasicBlock("icr.cont");
3311 llvm::BasicBlock *copyBB = CGF.createBasicBlock("icr.copy");
3312 CGF.Builder.CreateCondBr(isNull, contBB, copyBB);
3313 CGF.EmitBlock(copyBB);
Fariborz Jahanianfbd19742012-11-27 23:02:53 +00003314 condEval.begin(CGF);
John McCall31168b02011-06-15 23:02:42 +00003315 }
3316 }
3317
Craig Topper8a13c412014-05-21 05:09:00 +00003318 llvm::Value *valueToUse = nullptr;
John McCalleff18842013-03-23 02:35:54 +00003319
John McCall31168b02011-06-15 23:02:42 +00003320 // Perform a copy if necessary.
3321 if (shouldCopy) {
Nick Lewycky2d84e842013-10-02 02:29:49 +00003322 RValue srcRV = CGF.EmitLoadOfLValue(srcLV, SourceLocation());
John McCall31168b02011-06-15 23:02:42 +00003323 assert(srcRV.isScalar());
3324
3325 llvm::Value *src = srcRV.getScalarVal();
3326 src = CGF.Builder.CreateBitCast(src, destType->getElementType(),
3327 "icr.cast");
3328
3329 // Use an ordinary store, not a store-to-lvalue.
3330 CGF.Builder.CreateStore(src, temp);
John McCalleff18842013-03-23 02:35:54 +00003331
3332 // If optimization is enabled, and the value was held in a
3333 // __strong variable, we need to tell the optimizer that this
3334 // value has to stay alive until we're doing the store back.
3335 // This is because the temporary is effectively unretained,
3336 // and so otherwise we can violate the high-level semantics.
3337 if (CGF.CGM.getCodeGenOpts().OptimizationLevel != 0 &&
3338 srcLV.getObjCLifetime() == Qualifiers::OCL_Strong) {
3339 valueToUse = src;
3340 }
John McCall31168b02011-06-15 23:02:42 +00003341 }
Fangrui Song6907ce22018-07-30 19:24:48 +00003342
John McCall31168b02011-06-15 23:02:42 +00003343 // Finish the control flow if we needed it.
Fariborz Jahanianfbd19742012-11-27 23:02:53 +00003344 if (shouldCopy && !provablyNonNull) {
John McCalleff18842013-03-23 02:35:54 +00003345 llvm::BasicBlock *copyBB = CGF.Builder.GetInsertBlock();
John McCall31168b02011-06-15 23:02:42 +00003346 CGF.EmitBlock(contBB);
John McCalleff18842013-03-23 02:35:54 +00003347
3348 // Make a phi for the value to intrinsically use.
3349 if (valueToUse) {
3350 llvm::PHINode *phiToUse = CGF.Builder.CreatePHI(valueToUse->getType(), 2,
3351 "icr.to-use");
3352 phiToUse->addIncoming(valueToUse, copyBB);
3353 phiToUse->addIncoming(llvm::UndefValue::get(valueToUse->getType()),
3354 originBB);
3355 valueToUse = phiToUse;
3356 }
3357
Fariborz Jahanianfbd19742012-11-27 23:02:53 +00003358 condEval.end(CGF);
3359 }
John McCall31168b02011-06-15 23:02:42 +00003360
John McCalleff18842013-03-23 02:35:54 +00003361 args.addWriteback(srcLV, temp, valueToUse);
John McCall31168b02011-06-15 23:02:42 +00003362 args.add(RValue::get(finalArgument), CRE->getType());
3363}
3364
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003365void CallArgList::allocateArgumentMemory(CodeGenFunction &CGF) {
Richard Smith762672a2016-09-28 19:09:10 +00003366 assert(!StackBase);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003367
3368 // Save the stack.
3369 llvm::Function *F = CGF.CGM.getIntrinsic(llvm::Intrinsic::stacksave);
David Blaikie43f9bb72015-05-18 22:14:03 +00003370 StackBase = CGF.Builder.CreateCall(F, {}, "inalloca.save");
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003371}
3372
Nico Weber8cdb3f92015-08-25 18:43:32 +00003373void CallArgList::freeArgumentMemory(CodeGenFunction &CGF) const {
3374 if (StackBase) {
Reid Kleckner7c2f9e82015-10-08 00:17:45 +00003375 // Restore the stack after the call.
Nico Weber8cdb3f92015-08-25 18:43:32 +00003376 llvm::Value *F = CGF.CGM.getIntrinsic(llvm::Intrinsic::stackrestore);
Nico Weber8cdb3f92015-08-25 18:43:32 +00003377 CGF.Builder.CreateCall(F, StackBase);
3378 }
3379}
3380
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003381void CodeGenFunction::EmitNonNullArgCheck(RValue RV, QualType ArgType,
3382 SourceLocation ArgLoc,
Vedant Kumared00ea02017-03-06 05:28:22 +00003383 AbstractCallee AC,
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003384 unsigned ParmNum) {
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003385 if (!AC.getDecl() || !(SanOpts.has(SanitizerKind::NonnullAttribute) ||
3386 SanOpts.has(SanitizerKind::NullabilityArg)))
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003387 return;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003388
3389 // The param decl may be missing in a variadic function.
Vedant Kumared00ea02017-03-06 05:28:22 +00003390 auto PVD = ParmNum < AC.getNumParams() ? AC.getParamDecl(ParmNum) : nullptr;
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003391 unsigned ArgNo = PVD ? PVD->getFunctionScopeIndex() : ParmNum;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003392
Fangrui Song6907ce22018-07-30 19:24:48 +00003393 // Prefer the nonnull attribute if it's present.
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003394 const NonNullAttr *NNAttr = nullptr;
3395 if (SanOpts.has(SanitizerKind::NonnullAttribute))
3396 NNAttr = getNonNullAttr(AC.getDecl(), PVD, ArgType, ArgNo);
3397
3398 bool CanCheckNullability = false;
3399 if (SanOpts.has(SanitizerKind::NullabilityArg) && !NNAttr && PVD) {
3400 auto Nullability = PVD->getType()->getNullability(getContext());
3401 CanCheckNullability = Nullability &&
3402 *Nullability == NullabilityKind::NonNull &&
3403 PVD->getTypeSourceInfo();
3404 }
3405
3406 if (!NNAttr && !CanCheckNullability)
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003407 return;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003408
3409 SourceLocation AttrLoc;
3410 SanitizerMask CheckKind;
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00003411 SanitizerHandler Handler;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003412 if (NNAttr) {
3413 AttrLoc = NNAttr->getLocation();
3414 CheckKind = SanitizerKind::NonnullAttribute;
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00003415 Handler = SanitizerHandler::NonnullArg;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003416 } else {
3417 AttrLoc = PVD->getTypeSourceInfo()->getTypeLoc().findNullabilityLoc();
3418 CheckKind = SanitizerKind::NullabilityArg;
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00003419 Handler = SanitizerHandler::NullabilityArg;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003420 }
3421
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003422 SanitizerScope SanScope(this);
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003423 assert(RV.isScalar());
3424 llvm::Value *V = RV.getScalarVal();
3425 llvm::Value *Cond =
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003426 Builder.CreateICmpNE(V, llvm::Constant::getNullValue(V->getType()));
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003427 llvm::Constant *StaticData[] = {
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003428 EmitCheckSourceLocation(ArgLoc), EmitCheckSourceLocation(AttrLoc),
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003429 llvm::ConstantInt::get(Int32Ty, ArgNo + 1),
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003430 };
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00003431 EmitCheck(std::make_pair(Cond, CheckKind), Handler, StaticData, None);
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003432}
3433
David Blaikief05779e2015-07-21 18:37:18 +00003434void CodeGenFunction::EmitCallArgs(
3435 CallArgList &Args, ArrayRef<QualType> ArgTypes,
3436 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Vedant Kumared00ea02017-03-06 05:28:22 +00003437 AbstractCallee AC, unsigned ParamsToSkip, EvaluationOrder Order) {
David Blaikief05779e2015-07-21 18:37:18 +00003438 assert((int)ArgTypes.size() == (ArgRange.end() - ArgRange.begin()));
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003439
Reid Kleckner739756c2013-12-04 19:23:12 +00003440 // We *have* to evaluate arguments from right to left in the MS C++ ABI,
Richard Smitha560ccf2016-09-29 21:30:12 +00003441 // because arguments are destroyed left to right in the callee. As a special
3442 // case, there are certain language constructs that require left-to-right
3443 // evaluation, and in those cases we consider the evaluation order requirement
3444 // to trump the "destruction order is reverse construction order" guarantee.
3445 bool LeftToRight =
3446 CGM.getTarget().getCXXABI().areArgsDestroyedLeftToRightInCallee()
3447 ? Order == EvaluationOrder::ForceLeftToRight
3448 : Order != EvaluationOrder::ForceRightToLeft;
3449
George Burgess IV0d6592a2017-02-23 05:59:56 +00003450 auto MaybeEmitImplicitObjectSize = [&](unsigned I, const Expr *Arg,
3451 RValue EmittedArg) {
Vedant Kumared00ea02017-03-06 05:28:22 +00003452 if (!AC.hasFunctionDecl() || I >= AC.getNumParams())
George Burgess IV0d6592a2017-02-23 05:59:56 +00003453 return;
Vedant Kumared00ea02017-03-06 05:28:22 +00003454 auto *PS = AC.getParamDecl(I)->getAttr<PassObjectSizeAttr>();
George Burgess IV0d6592a2017-02-23 05:59:56 +00003455 if (PS == nullptr)
3456 return;
3457
3458 const auto &Context = getContext();
3459 auto SizeTy = Context.getSizeType();
3460 auto T = Builder.getIntNTy(Context.getTypeSize(SizeTy));
3461 assert(EmittedArg.getScalarVal() && "We emitted nothing for the arg?");
3462 llvm::Value *V = evaluateOrEmitBuiltinObjectSize(Arg, PS->getType(), T,
3463 EmittedArg.getScalarVal());
3464 Args.add(RValue::get(V), SizeTy);
3465 // If we're emitting args in reverse, be sure to do so with
3466 // pass_object_size, as well.
3467 if (!LeftToRight)
3468 std::swap(Args.back(), *(&Args.back() - 1));
3469 };
3470
Richard Smitha560ccf2016-09-29 21:30:12 +00003471 // Insert a stack save if we're going to need any inalloca args.
3472 bool HasInAllocaArgs = false;
3473 if (CGM.getTarget().getCXXABI().isMicrosoft()) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003474 for (ArrayRef<QualType>::iterator I = ArgTypes.begin(), E = ArgTypes.end();
3475 I != E && !HasInAllocaArgs; ++I)
3476 HasInAllocaArgs = isInAllocaArgument(CGM.getCXXABI(), *I);
3477 if (HasInAllocaArgs) {
3478 assert(getTarget().getTriple().getArch() == llvm::Triple::x86);
3479 Args.allocateArgumentMemory(*this);
3480 }
Richard Smitha560ccf2016-09-29 21:30:12 +00003481 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003482
Richard Smitha560ccf2016-09-29 21:30:12 +00003483 // Evaluate each argument in the appropriate order.
3484 size_t CallArgsStart = Args.size();
3485 for (unsigned I = 0, E = ArgTypes.size(); I != E; ++I) {
3486 unsigned Idx = LeftToRight ? I : E - I - 1;
3487 CallExpr::const_arg_iterator Arg = ArgRange.begin() + Idx;
George Burgess IV0d6592a2017-02-23 05:59:56 +00003488 unsigned InitialArgSize = Args.size();
Akira Hatanaka46dd7dbc2017-06-28 00:42:48 +00003489 // If *Arg is an ObjCIndirectCopyRestoreExpr, check that either the types of
3490 // the argument and parameter match or the objc method is parameterized.
3491 assert((!isa<ObjCIndirectCopyRestoreExpr>(*Arg) ||
3492 getContext().hasSameUnqualifiedType((*Arg)->getType(),
3493 ArgTypes[Idx]) ||
3494 (isa<ObjCMethodDecl>(AC.getDecl()) &&
3495 isObjCMethodWithTypeParams(cast<ObjCMethodDecl>(AC.getDecl())))) &&
3496 "Argument and parameter types don't match");
Richard Smitha560ccf2016-09-29 21:30:12 +00003497 EmitCallArg(Args, *Arg, ArgTypes[Idx]);
George Burgess IV0d6592a2017-02-23 05:59:56 +00003498 // In particular, we depend on it being the last arg in Args, and the
3499 // objectsize bits depend on there only being one arg if !LeftToRight.
3500 assert(InitialArgSize + 1 == Args.size() &&
3501 "The code below depends on only adding one arg per EmitCallArg");
3502 (void)InitialArgSize;
Yaxun Liu5b330e82018-03-15 15:25:19 +00003503 // Since pointer argument are never emitted as LValue, it is safe to emit
3504 // non-null argument check for r-value only.
3505 if (!Args.back().hasLValue()) {
3506 RValue RVArg = Args.back().getKnownRValue();
3507 EmitNonNullArgCheck(RVArg, ArgTypes[Idx], (*Arg)->getExprLoc(), AC,
3508 ParamsToSkip + Idx);
3509 // @llvm.objectsize should never have side-effects and shouldn't need
3510 // destruction/cleanups, so we can safely "emit" it after its arg,
3511 // regardless of right-to-leftness
3512 MaybeEmitImplicitObjectSize(Idx, *Arg, RVArg);
3513 }
Richard Smitha560ccf2016-09-29 21:30:12 +00003514 }
Reid Kleckner739756c2013-12-04 19:23:12 +00003515
Richard Smitha560ccf2016-09-29 21:30:12 +00003516 if (!LeftToRight) {
Reid Kleckner739756c2013-12-04 19:23:12 +00003517 // Un-reverse the arguments we just evaluated so they match up with the LLVM
3518 // IR function.
3519 std::reverse(Args.begin() + CallArgsStart, Args.end());
Reid Kleckner739756c2013-12-04 19:23:12 +00003520 }
3521}
3522
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003523namespace {
3524
David Blaikie7e70d682015-08-18 22:40:54 +00003525struct DestroyUnpassedArg final : EHScopeStack::Cleanup {
John McCall7f416cc2015-09-08 08:05:57 +00003526 DestroyUnpassedArg(Address Addr, QualType Ty)
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003527 : Addr(Addr), Ty(Ty) {}
3528
John McCall7f416cc2015-09-08 08:05:57 +00003529 Address Addr;
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003530 QualType Ty;
3531
Craig Topper4f12f102014-03-12 06:41:41 +00003532 void Emit(CodeGenFunction &CGF, Flags flags) override {
Akira Hatanaka7275da02018-02-28 07:15:55 +00003533 QualType::DestructionKind DtorKind = Ty.isDestructedType();
3534 if (DtorKind == QualType::DK_cxx_destructor) {
3535 const CXXDestructorDecl *Dtor = Ty->getAsCXXRecordDecl()->getDestructor();
3536 assert(!Dtor->isTrivial());
3537 CGF.EmitCXXDestructorCall(Dtor, Dtor_Complete, /*for vbase*/ false,
3538 /*Delegating=*/false, Addr);
3539 } else {
3540 CGF.callCStructDestructor(CGF.MakeAddrLValue(Addr, Ty));
3541 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003542 }
3543};
3544
David Blaikie38b25912015-02-09 19:13:51 +00003545struct DisableDebugLocationUpdates {
3546 CodeGenFunction &CGF;
3547 bool disabledDebugInfo;
3548 DisableDebugLocationUpdates(CodeGenFunction &CGF, const Expr *E) : CGF(CGF) {
3549 if ((disabledDebugInfo = isa<CXXDefaultArgExpr>(E) && CGF.getDebugInfo()))
3550 CGF.disableDebugInfo();
3551 }
3552 ~DisableDebugLocationUpdates() {
3553 if (disabledDebugInfo)
3554 CGF.enableDebugInfo();
3555 }
3556};
3557
Benjamin Kramer5b4296a2015-10-28 17:16:26 +00003558} // end anonymous namespace
3559
Yaxun Liu5b330e82018-03-15 15:25:19 +00003560RValue CallArg::getRValue(CodeGenFunction &CGF) const {
3561 if (!HasLV)
3562 return RV;
3563 LValue Copy = CGF.MakeAddrLValue(CGF.CreateMemTemp(Ty), Ty);
Richard Smithe78fac52018-04-05 20:52:58 +00003564 CGF.EmitAggregateCopy(Copy, LV, Ty, AggValueSlot::DoesNotOverlap,
3565 LV.isVolatile());
Yaxun Liu5b330e82018-03-15 15:25:19 +00003566 IsUsed = true;
3567 return RValue::getAggregate(Copy.getAddress());
3568}
3569
3570void CallArg::copyInto(CodeGenFunction &CGF, Address Addr) const {
3571 LValue Dst = CGF.MakeAddrLValue(Addr, Ty);
3572 if (!HasLV && RV.isScalar())
3573 CGF.EmitStoreOfScalar(RV.getScalarVal(), Dst, /*init=*/true);
3574 else if (!HasLV && RV.isComplex())
3575 CGF.EmitStoreOfComplex(RV.getComplexVal(), Dst, /*init=*/true);
3576 else {
3577 auto Addr = HasLV ? LV.getAddress() : RV.getAggregateAddress();
3578 LValue SrcLV = CGF.MakeAddrLValue(Addr, Ty);
Richard Smithe78fac52018-04-05 20:52:58 +00003579 // We assume that call args are never copied into subobjects.
3580 CGF.EmitAggregateCopy(Dst, SrcLV, Ty, AggValueSlot::DoesNotOverlap,
Yaxun Liu5b330e82018-03-15 15:25:19 +00003581 HasLV ? LV.isVolatileQualified()
3582 : RV.isVolatileQualified());
3583 }
3584 IsUsed = true;
3585}
3586
John McCall32ea9692011-03-11 20:59:21 +00003587void CodeGenFunction::EmitCallArg(CallArgList &args, const Expr *E,
3588 QualType type) {
David Blaikie38b25912015-02-09 19:13:51 +00003589 DisableDebugLocationUpdates Dis(*this, E);
John McCall31168b02011-06-15 23:02:42 +00003590 if (const ObjCIndirectCopyRestoreExpr *CRE
3591 = dyn_cast<ObjCIndirectCopyRestoreExpr>(E)) {
Richard Smith9c6890a2012-11-01 22:30:59 +00003592 assert(getLangOpts().ObjCAutoRefCount);
John McCall31168b02011-06-15 23:02:42 +00003593 return emitWritebackArg(*this, args, CRE);
3594 }
3595
John McCall0a76c0c2011-08-26 18:42:59 +00003596 assert(type->isReferenceType() == E->isGLValue() &&
3597 "reference binding to unmaterialized r-value!");
3598
John McCall17054bd62011-08-26 21:08:13 +00003599 if (E->isGLValue()) {
3600 assert(E->getObjectKind() == OK_Ordinary);
Richard Smitha1c9d4d2013-06-12 23:38:09 +00003601 return args.add(EmitReferenceBindingToExpr(E), type);
John McCall17054bd62011-08-26 21:08:13 +00003602 }
Mike Stump11289f42009-09-09 15:08:12 +00003603
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003604 bool HasAggregateEvalKind = hasAggregateEvaluationKind(type);
3605
3606 // In the Microsoft C++ ABI, aggregate arguments are destructed by the callee.
3607 // However, we still have to push an EH-only cleanup in case we unwind before
3608 // we make it to the call.
Akira Hatanaka85282972018-05-15 21:00:30 +00003609 if (HasAggregateEvalKind &&
3610 type->getAs<RecordType>()->getDecl()->isParamDestroyedInCallee()) {
Reid Klecknerac640602014-05-01 03:07:18 +00003611 // If we're using inalloca, use the argument memory. Otherwise, use a
Reid Klecknere39ee212014-05-03 00:33:28 +00003612 // temporary.
Reid Klecknerac640602014-05-01 03:07:18 +00003613 AggValueSlot Slot;
3614 if (args.isUsingInAlloca())
3615 Slot = createPlaceholderSlot(*this, type);
3616 else
3617 Slot = CreateAggTemp(type, "agg.tmp");
Reid Klecknere39ee212014-05-03 00:33:28 +00003618
Akira Hatanaka4ce0e5a2018-04-18 23:33:15 +00003619 bool DestroyedInCallee = true, NeedsEHCleanup = true;
3620 if (const auto *RD = type->getAsCXXRecordDecl())
3621 DestroyedInCallee = RD->hasNonTrivialDestructor();
3622 else
3623 NeedsEHCleanup = needsEHCleanup(type.isDestructedType());
3624
3625 if (DestroyedInCallee)
3626 Slot.setExternallyDestructed();
Reid Klecknere39ee212014-05-03 00:33:28 +00003627
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003628 EmitAggExpr(E, Slot);
3629 RValue RV = Slot.asRValue();
3630 args.add(RV, type);
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003631
Akira Hatanaka4ce0e5a2018-04-18 23:33:15 +00003632 if (DestroyedInCallee && NeedsEHCleanup) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003633 // Create a no-op GEP between the placeholder and the cleanup so we can
3634 // RAUW it successfully. It also serves as a marker of the first
3635 // instruction where the cleanup is active.
John McCall7f416cc2015-09-08 08:05:57 +00003636 pushFullExprCleanup<DestroyUnpassedArg>(EHCleanup, Slot.getAddress(),
3637 type);
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003638 // This unreachable is a temporary marker which will be removed later.
3639 llvm::Instruction *IsActive = Builder.CreateUnreachable();
3640 args.addArgCleanupDeactivation(EHStack.getInnermostEHScope(), IsActive);
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003641 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003642 return;
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003643 }
3644
3645 if (HasAggregateEvalKind && isa<ImplicitCastExpr>(E) &&
Eli Friedmandf968192011-05-26 00:10:27 +00003646 cast<CastExpr>(E)->getCastKind() == CK_LValueToRValue) {
3647 LValue L = EmitLValue(cast<CastExpr>(E)->getSubExpr());
3648 assert(L.isSimple());
Yaxun Liu5b330e82018-03-15 15:25:19 +00003649 args.addUncopiedAggregate(L, type);
Eli Friedmandf968192011-05-26 00:10:27 +00003650 return;
3651 }
3652
John McCall32ea9692011-03-11 20:59:21 +00003653 args.add(EmitAnyExprToTemp(E), type);
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00003654}
3655
Reid Kleckner79b0fd72014-10-10 00:05:45 +00003656QualType CodeGenFunction::getVarArgType(const Expr *Arg) {
3657 // System headers on Windows define NULL to 0 instead of 0LL on Win64. MSVC
3658 // implicitly widens null pointer constants that are arguments to varargs
3659 // functions to pointer-sized ints.
3660 if (!getTarget().getTriple().isOSWindows())
3661 return Arg->getType();
3662
3663 if (Arg->getType()->isIntegerType() &&
3664 getContext().getTypeSize(Arg->getType()) <
3665 getContext().getTargetInfo().getPointerWidth(0) &&
3666 Arg->isNullPointerConstant(getContext(),
3667 Expr::NPC_ValueDependentIsNotNull)) {
3668 return getContext().getIntPtrType();
3669 }
3670
3671 return Arg->getType();
3672}
3673
Dan Gohman515a60d2012-02-16 00:57:37 +00003674// In ObjC ARC mode with no ObjC ARC exception safety, tell the ARC
3675// optimizer it can aggressively ignore unwind edges.
3676void
3677CodeGenFunction::AddObjCARCExceptionMetadata(llvm::Instruction *Inst) {
3678 if (CGM.getCodeGenOpts().OptimizationLevel != 0 &&
3679 !CGM.getCodeGenOpts().ObjCAutoRefCountExceptions)
3680 Inst->setMetadata("clang.arc.no_objc_arc_exceptions",
3681 CGM.getNoObjCARCExceptionsMetadata());
3682}
3683
John McCall882987f2013-02-28 19:01:20 +00003684/// Emits a call to the given no-arguments nounwind runtime function.
3685llvm::CallInst *
3686CodeGenFunction::EmitNounwindRuntimeCall(llvm::Value *callee,
3687 const llvm::Twine &name) {
Craig Topper5fc8fc22014-08-27 06:28:36 +00003688 return EmitNounwindRuntimeCall(callee, None, name);
John McCall882987f2013-02-28 19:01:20 +00003689}
3690
3691/// Emits a call to the given nounwind runtime function.
3692llvm::CallInst *
3693CodeGenFunction::EmitNounwindRuntimeCall(llvm::Value *callee,
3694 ArrayRef<llvm::Value*> args,
3695 const llvm::Twine &name) {
3696 llvm::CallInst *call = EmitRuntimeCall(callee, args, name);
3697 call->setDoesNotThrow();
3698 return call;
3699}
3700
3701/// Emits a simple call (never an invoke) to the given no-arguments
3702/// runtime function.
3703llvm::CallInst *
3704CodeGenFunction::EmitRuntimeCall(llvm::Value *callee,
3705 const llvm::Twine &name) {
Craig Topper5fc8fc22014-08-27 06:28:36 +00003706 return EmitRuntimeCall(callee, None, name);
John McCall882987f2013-02-28 19:01:20 +00003707}
3708
David Majnemer0b17d442015-12-15 21:27:59 +00003709// Calls which may throw must have operand bundles indicating which funclet
3710// they are nested within.
Reid Klecknerb75a3f02018-02-09 00:16:41 +00003711SmallVector<llvm::OperandBundleDef, 1>
3712CodeGenFunction::getBundlesForFunclet(llvm::Value *Callee) {
3713 SmallVector<llvm::OperandBundleDef, 1> BundleList;
Sanjay Patel846b63b2016-01-18 22:15:33 +00003714 // There is no need for a funclet operand bundle if we aren't inside a
3715 // funclet.
David Majnemer0b17d442015-12-15 21:27:59 +00003716 if (!CurrentFuncletPad)
Reid Klecknerb75a3f02018-02-09 00:16:41 +00003717 return BundleList;
David Majnemer0b17d442015-12-15 21:27:59 +00003718
3719 // Skip intrinsics which cannot throw.
3720 auto *CalleeFn = dyn_cast<llvm::Function>(Callee->stripPointerCasts());
3721 if (CalleeFn && CalleeFn->isIntrinsic() && CalleeFn->doesNotThrow())
Reid Klecknerb75a3f02018-02-09 00:16:41 +00003722 return BundleList;
David Majnemer0b17d442015-12-15 21:27:59 +00003723
3724 BundleList.emplace_back("funclet", CurrentFuncletPad);
Reid Klecknerb75a3f02018-02-09 00:16:41 +00003725 return BundleList;
David Majnemer0b17d442015-12-15 21:27:59 +00003726}
3727
David Majnemer971d31b2016-02-24 17:02:45 +00003728/// Emits a simple call (never an invoke) to the given runtime function.
3729llvm::CallInst *
3730CodeGenFunction::EmitRuntimeCall(llvm::Value *callee,
3731 ArrayRef<llvm::Value*> args,
3732 const llvm::Twine &name) {
Reid Klecknerb75a3f02018-02-09 00:16:41 +00003733 llvm::CallInst *call =
3734 Builder.CreateCall(callee, args, getBundlesForFunclet(callee), name);
David Majnemer971d31b2016-02-24 17:02:45 +00003735 call->setCallingConv(getRuntimeCC());
3736 return call;
3737}
3738
John McCall882987f2013-02-28 19:01:20 +00003739/// Emits a call or invoke to the given noreturn runtime function.
3740void CodeGenFunction::EmitNoreturnRuntimeCallOrInvoke(llvm::Value *callee,
3741 ArrayRef<llvm::Value*> args) {
Reid Klecknerb75a3f02018-02-09 00:16:41 +00003742 SmallVector<llvm::OperandBundleDef, 1> BundleList =
3743 getBundlesForFunclet(callee);
David Majnemer0b17d442015-12-15 21:27:59 +00003744
John McCall882987f2013-02-28 19:01:20 +00003745 if (getInvokeDest()) {
Fangrui Song6907ce22018-07-30 19:24:48 +00003746 llvm::InvokeInst *invoke =
John McCall882987f2013-02-28 19:01:20 +00003747 Builder.CreateInvoke(callee,
3748 getUnreachableBlock(),
3749 getInvokeDest(),
David Majnemer0b17d442015-12-15 21:27:59 +00003750 args,
3751 BundleList);
John McCall882987f2013-02-28 19:01:20 +00003752 invoke->setDoesNotReturn();
3753 invoke->setCallingConv(getRuntimeCC());
3754 } else {
David Majnemer0b17d442015-12-15 21:27:59 +00003755 llvm::CallInst *call = Builder.CreateCall(callee, args, BundleList);
John McCall882987f2013-02-28 19:01:20 +00003756 call->setDoesNotReturn();
3757 call->setCallingConv(getRuntimeCC());
3758 Builder.CreateUnreachable();
3759 }
3760}
3761
Sanjay Patel846b63b2016-01-18 22:15:33 +00003762/// Emits a call or invoke instruction to the given nullary runtime function.
John McCall882987f2013-02-28 19:01:20 +00003763llvm::CallSite
3764CodeGenFunction::EmitRuntimeCallOrInvoke(llvm::Value *callee,
3765 const Twine &name) {
Craig Topper5fc8fc22014-08-27 06:28:36 +00003766 return EmitRuntimeCallOrInvoke(callee, None, name);
John McCall882987f2013-02-28 19:01:20 +00003767}
3768
3769/// Emits a call or invoke instruction to the given runtime function.
3770llvm::CallSite
3771CodeGenFunction::EmitRuntimeCallOrInvoke(llvm::Value *callee,
3772 ArrayRef<llvm::Value*> args,
3773 const Twine &name) {
3774 llvm::CallSite callSite = EmitCallOrInvoke(callee, args, name);
3775 callSite.setCallingConv(getRuntimeCC());
3776 return callSite;
3777}
3778
John McCallbd309292010-07-06 01:34:17 +00003779/// Emits a call or invoke instruction to the given function, depending
3780/// on the current state of the EH stack.
3781llvm::CallSite
3782CodeGenFunction::EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner54b16772011-07-23 17:14:25 +00003783 ArrayRef<llvm::Value *> Args,
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003784 const Twine &Name) {
John McCallbd309292010-07-06 01:34:17 +00003785 llvm::BasicBlock *InvokeDest = getInvokeDest();
Reid Klecknerb75a3f02018-02-09 00:16:41 +00003786 SmallVector<llvm::OperandBundleDef, 1> BundleList =
3787 getBundlesForFunclet(Callee);
John McCallbd309292010-07-06 01:34:17 +00003788
Dan Gohman515a60d2012-02-16 00:57:37 +00003789 llvm::Instruction *Inst;
3790 if (!InvokeDest)
David Majnemer3df77bc2016-01-26 23:14:47 +00003791 Inst = Builder.CreateCall(Callee, Args, BundleList, Name);
Dan Gohman515a60d2012-02-16 00:57:37 +00003792 else {
3793 llvm::BasicBlock *ContBB = createBasicBlock("invoke.cont");
David Majnemer3df77bc2016-01-26 23:14:47 +00003794 Inst = Builder.CreateInvoke(Callee, ContBB, InvokeDest, Args, BundleList,
3795 Name);
Dan Gohman515a60d2012-02-16 00:57:37 +00003796 EmitBlock(ContBB);
3797 }
3798
3799 // In ObjC ARC mode with no ObjC ARC exception safety, tell the ARC
3800 // optimizer it can aggressively ignore unwind edges.
David Blaikiebbafb8a2012-03-11 07:00:24 +00003801 if (CGM.getLangOpts().ObjCAutoRefCount)
Dan Gohman515a60d2012-02-16 00:57:37 +00003802 AddObjCARCExceptionMetadata(Inst);
3803
Benjamin Kramerc19cde12015-04-10 14:49:31 +00003804 return llvm::CallSite(Inst);
John McCallbd309292010-07-06 01:34:17 +00003805}
3806
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003807void CodeGenFunction::deferPlaceholderReplacement(llvm::Instruction *Old,
3808 llvm::Value *New) {
3809 DeferredReplacements.push_back(std::make_pair(Old, New));
3810}
Chris Lattnerd59d8672011-07-12 06:29:11 +00003811
Daniel Dunbard931a872009-02-02 22:03:45 +00003812RValue CodeGenFunction::EmitCall(const CGFunctionInfo &CallInfo,
John McCallb92ab1a2016-10-26 23:46:34 +00003813 const CGCallee &Callee,
Anders Carlsson61a401c2009-12-24 19:25:24 +00003814 ReturnValueSlot ReturnValue,
Daniel Dunbarcdbb5e32009-02-20 18:06:48 +00003815 const CallArgList &CallArgs,
Vedant Kumar09b5bfd2017-12-21 00:10:25 +00003816 llvm::Instruction **callOrInvoke,
3817 SourceLocation Loc) {
Mike Stump18bb9282009-05-16 07:57:57 +00003818 // FIXME: We no longer need the types from CallArgs; lift up and simplify.
Daniel Dunbar613855c2008-09-09 23:27:19 +00003819
Peter Collingbourneea211002018-02-05 23:09:13 +00003820 assert(Callee.isOrdinary() || Callee.isVirtual());
John McCallb92ab1a2016-10-26 23:46:34 +00003821
Daniel Dunbar613855c2008-09-09 23:27:19 +00003822 // Handle struct-return functions by passing a pointer to the
3823 // location that we would like to return into.
Daniel Dunbar7633cbf2009-02-02 21:43:58 +00003824 QualType RetTy = CallInfo.getReturnType();
Daniel Dunbarb52d0772009-02-03 05:59:18 +00003825 const ABIArgInfo &RetAI = CallInfo.getReturnInfo();
Mike Stump11289f42009-09-09 15:08:12 +00003826
John McCallb92ab1a2016-10-26 23:46:34 +00003827 llvm::FunctionType *IRFuncTy = Callee.getFunctionType();
3828
3829 // 1. Set up the arguments.
Mike Stump11289f42009-09-09 15:08:12 +00003830
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003831 // If we're using inalloca, insert the allocation after the stack save.
3832 // FIXME: Do this earlier rather than hacking it in here!
John McCall7f416cc2015-09-08 08:05:57 +00003833 Address ArgMemory = Address::invalid();
3834 const llvm::StructLayout *ArgMemoryLayout = nullptr;
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003835 if (llvm::StructType *ArgStruct = CallInfo.getArgStruct()) {
Matt Arsenault502ad602017-04-10 22:28:02 +00003836 const llvm::DataLayout &DL = CGM.getDataLayout();
3837 ArgMemoryLayout = DL.getStructLayout(ArgStruct);
Reid Kleckner9df1d972014-04-10 01:40:15 +00003838 llvm::Instruction *IP = CallArgs.getStackBase();
3839 llvm::AllocaInst *AI;
3840 if (IP) {
3841 IP = IP->getNextNode();
Matt Arsenault502ad602017-04-10 22:28:02 +00003842 AI = new llvm::AllocaInst(ArgStruct, DL.getAllocaAddrSpace(),
3843 "argmem", IP);
Reid Kleckner9df1d972014-04-10 01:40:15 +00003844 } else {
Reid Kleckner966abe72014-05-15 23:01:46 +00003845 AI = CreateTempAlloca(ArgStruct, "argmem");
Reid Kleckner9df1d972014-04-10 01:40:15 +00003846 }
John McCall7f416cc2015-09-08 08:05:57 +00003847 auto Align = CallInfo.getArgStructAlignment();
3848 AI->setAlignment(Align.getQuantity());
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003849 AI->setUsedWithInAlloca(true);
3850 assert(AI->isUsedWithInAlloca() && !AI->isStaticAlloca());
John McCall7f416cc2015-09-08 08:05:57 +00003851 ArgMemory = Address(AI, Align);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003852 }
3853
John McCall7f416cc2015-09-08 08:05:57 +00003854 // Helper function to drill into the inalloca allocation.
3855 auto createInAllocaStructGEP = [&](unsigned FieldIndex) -> Address {
3856 auto FieldOffset =
3857 CharUnits::fromQuantity(ArgMemoryLayout->getElementOffset(FieldIndex));
3858 return Builder.CreateStructGEP(ArgMemory, FieldIndex, FieldOffset);
3859 };
3860
Alexey Samsonov153004f2014-09-29 22:08:00 +00003861 ClangToLLVMArgMapping IRFunctionArgs(CGM.getContext(), CallInfo);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003862 SmallVector<llvm::Value *, 16> IRCallArgs(IRFunctionArgs.totalIRArgs());
3863
Chris Lattner4ca97c32009-06-13 00:26:38 +00003864 // If the call returns a temporary with struct return, create a temporary
Anders Carlsson17490832009-12-24 20:40:36 +00003865 // alloca to hold the result, unless one is given to us.
John McCall7f416cc2015-09-08 08:05:57 +00003866 Address SRetPtr = Address::invalid();
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00003867 Address SRetAlloca = Address::invalid();
George Burgess IV003be7c2018-03-08 05:32:30 +00003868 llvm::Value *UnusedReturnSizePtr = nullptr;
John McCallf26e73d2016-03-11 04:30:43 +00003869 if (RetAI.isIndirect() || RetAI.isInAlloca() || RetAI.isCoerceAndExpand()) {
John McCall7f416cc2015-09-08 08:05:57 +00003870 if (!ReturnValue.isNull()) {
3871 SRetPtr = ReturnValue.getValue();
3872 } else {
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00003873 SRetPtr = CreateMemTemp(RetTy, "tmp", &SRetAlloca);
Leny Kholodov6aab1112015-06-08 10:23:49 +00003874 if (HaveInsertPoint() && ReturnValue.isUnused()) {
3875 uint64_t size =
3876 CGM.getDataLayout().getTypeAllocSize(ConvertTypeForMem(RetTy));
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00003877 UnusedReturnSizePtr = EmitLifetimeStart(size, SRetAlloca.getPointer());
Leny Kholodov6aab1112015-06-08 10:23:49 +00003878 }
3879 }
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003880 if (IRFunctionArgs.hasSRetArg()) {
John McCall7f416cc2015-09-08 08:05:57 +00003881 IRCallArgs[IRFunctionArgs.getSRetArgNo()] = SRetPtr.getPointer();
John McCallf26e73d2016-03-11 04:30:43 +00003882 } else if (RetAI.isInAlloca()) {
John McCall7f416cc2015-09-08 08:05:57 +00003883 Address Addr = createInAllocaStructGEP(RetAI.getInAllocaFieldIndex());
3884 Builder.CreateStore(SRetPtr.getPointer(), Addr);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003885 }
Anders Carlsson17490832009-12-24 20:40:36 +00003886 }
Mike Stump11289f42009-09-09 15:08:12 +00003887
John McCall12f23522016-04-04 18:33:08 +00003888 Address swiftErrorTemp = Address::invalid();
3889 Address swiftErrorArg = Address::invalid();
3890
John McCallb92ab1a2016-10-26 23:46:34 +00003891 // Translate all of the arguments as necessary to match the IR lowering.
Daniel Dunbara45bdbb2009-02-04 21:17:21 +00003892 assert(CallInfo.arg_size() == CallArgs.size() &&
3893 "Mismatch between function signature & arguments.");
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003894 unsigned ArgNo = 0;
Daniel Dunbarb52d0772009-02-03 05:59:18 +00003895 CGFunctionInfo::const_arg_iterator info_it = CallInfo.arg_begin();
Mike Stump11289f42009-09-09 15:08:12 +00003896 for (CallArgList::const_iterator I = CallArgs.begin(), E = CallArgs.end();
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003897 I != E; ++I, ++info_it, ++ArgNo) {
Daniel Dunbarb52d0772009-02-03 05:59:18 +00003898 const ABIArgInfo &ArgInfo = info_it->info;
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00003899
Rafael Espindolafad28de2012-10-24 01:59:00 +00003900 // Insert a padding argument to ensure proper alignment.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003901 if (IRFunctionArgs.hasPaddingArg(ArgNo))
3902 IRCallArgs[IRFunctionArgs.getPaddingArgNo(ArgNo)] =
3903 llvm::UndefValue::get(ArgInfo.getPaddingType());
3904
3905 unsigned FirstIRArg, NumIRArgs;
3906 std::tie(FirstIRArg, NumIRArgs) = IRFunctionArgs.getIRArgs(ArgNo);
Rafael Espindolafad28de2012-10-24 01:59:00 +00003907
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00003908 switch (ArgInfo.getKind()) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003909 case ABIArgInfo::InAlloca: {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003910 assert(NumIRArgs == 0);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003911 assert(getTarget().getTriple().getArch() == llvm::Triple::x86);
Yaxun Liu5b330e82018-03-15 15:25:19 +00003912 if (I->isAggregate()) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003913 // Replace the placeholder with the appropriate argument slot GEP.
Yaxun Liu5b330e82018-03-15 15:25:19 +00003914 Address Addr = I->hasLValue()
3915 ? I->getKnownLValue().getAddress()
3916 : I->getKnownRValue().getAggregateAddress();
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003917 llvm::Instruction *Placeholder =
Yaxun Liu5b330e82018-03-15 15:25:19 +00003918 cast<llvm::Instruction>(Addr.getPointer());
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003919 CGBuilderTy::InsertPoint IP = Builder.saveIP();
3920 Builder.SetInsertPoint(Placeholder);
Yaxun Liu5b330e82018-03-15 15:25:19 +00003921 Addr = createInAllocaStructGEP(ArgInfo.getInAllocaFieldIndex());
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003922 Builder.restoreIP(IP);
John McCall7f416cc2015-09-08 08:05:57 +00003923 deferPlaceholderReplacement(Placeholder, Addr.getPointer());
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003924 } else {
3925 // Store the RValue into the argument struct.
John McCall7f416cc2015-09-08 08:05:57 +00003926 Address Addr = createInAllocaStructGEP(ArgInfo.getInAllocaFieldIndex());
3927 unsigned AS = Addr.getType()->getPointerAddressSpace();
David Majnemer32b57b02014-03-31 16:12:47 +00003928 llvm::Type *MemType = ConvertTypeForMem(I->Ty)->getPointerTo(AS);
3929 // There are some cases where a trivial bitcast is not avoidable. The
3930 // definition of a type later in a translation unit may change it's type
3931 // from {}* to (%struct.foo*)*.
John McCall7f416cc2015-09-08 08:05:57 +00003932 if (Addr.getType() != MemType)
David Majnemer32b57b02014-03-31 16:12:47 +00003933 Addr = Builder.CreateBitCast(Addr, MemType);
Yaxun Liu5b330e82018-03-15 15:25:19 +00003934 I->copyInto(*this, Addr);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003935 }
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003936 break;
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003937 }
3938
Daniel Dunbar03816342010-08-21 02:24:36 +00003939 case ABIArgInfo::Indirect: {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003940 assert(NumIRArgs == 1);
Yaxun Liu5b330e82018-03-15 15:25:19 +00003941 if (!I->isAggregate()) {
Daniel Dunbar747865a2009-02-05 09:16:39 +00003942 // Make a temporary alloca to pass the argument.
Yaxun Liuaefdb8e2018-06-15 15:33:22 +00003943 Address Addr = CreateMemTempWithoutCast(
3944 I->Ty, ArgInfo.getIndirectAlign(), "indirect-arg-temp");
John McCall7f416cc2015-09-08 08:05:57 +00003945 IRCallArgs[FirstIRArg] = Addr.getPointer();
John McCall47fb9502013-03-07 21:37:08 +00003946
Yaxun Liu5b330e82018-03-15 15:25:19 +00003947 I->copyInto(*this, Addr);
Daniel Dunbar747865a2009-02-05 09:16:39 +00003948 } else {
Eli Friedmaneb7fab62011-06-14 01:37:52 +00003949 // We want to avoid creating an unnecessary temporary+copy here;
Guy Benyei3832bfd2013-03-10 12:59:00 +00003950 // however, we need one in three cases:
Eli Friedmaneb7fab62011-06-14 01:37:52 +00003951 // 1. If the argument is not byval, and we are required to copy the
3952 // source. (This case doesn't occur on any common architecture.)
3953 // 2. If the argument is byval, RV is not sufficiently aligned, and
3954 // we cannot force it to be sufficiently aligned.
Yaxun Liu5b330e82018-03-15 15:25:19 +00003955 // 3. If the argument is byval, but RV is not located in default
3956 // or alloca address space.
3957 Address Addr = I->hasLValue()
3958 ? I->getKnownLValue().getAddress()
3959 : I->getKnownRValue().getAggregateAddress();
3960 llvm::Value *V = Addr.getPointer();
John McCall7f416cc2015-09-08 08:05:57 +00003961 CharUnits Align = ArgInfo.getIndirectAlign();
Micah Villmowdd31ca12012-10-08 16:25:52 +00003962 const llvm::DataLayout *TD = &CGM.getDataLayout();
Yaxun Liu5b330e82018-03-15 15:25:19 +00003963
3964 assert((FirstIRArg >= IRFuncTy->getNumParams() ||
3965 IRFuncTy->getParamType(FirstIRArg)->getPointerAddressSpace() ==
3966 TD->getAllocaAddrSpace()) &&
3967 "indirect argument must be in alloca address space");
3968
3969 bool NeedCopy = false;
3970
3971 if (Addr.getAlignment() < Align &&
3972 llvm::getOrEnforceKnownAlignment(V, Align.getQuantity(), *TD) <
3973 Align.getQuantity()) {
3974 NeedCopy = true;
3975 } else if (I->hasLValue()) {
3976 auto LV = I->getKnownLValue();
3977 auto AS = LV.getAddressSpace();
Andrew Savonichev1bf1a152018-12-10 12:03:00 +00003978
Yaxun Liu5b330e82018-03-15 15:25:19 +00003979 if ((!ArgInfo.getIndirectByVal() &&
3980 (LV.getAlignment() >=
Andrew Savonichev1bf1a152018-12-10 12:03:00 +00003981 getContext().getTypeAlignInChars(I->Ty)))) {
3982 NeedCopy = true;
3983 }
3984 if (!getLangOpts().OpenCL) {
3985 if ((ArgInfo.getIndirectByVal() &&
3986 (AS != LangAS::Default &&
3987 AS != CGM.getASTAllocaAddressSpace()))) {
3988 NeedCopy = true;
3989 }
3990 }
3991 // For OpenCL even if RV is located in default or alloca address space
3992 // we don't want to perform address space cast for it.
3993 else if ((ArgInfo.getIndirectByVal() &&
3994 Addr.getType()->getAddressSpace() != IRFuncTy->
3995 getParamType(FirstIRArg)->getPointerAddressSpace())) {
Yaxun Liu5b330e82018-03-15 15:25:19 +00003996 NeedCopy = true;
3997 }
3998 }
Andrew Savonichev1bf1a152018-12-10 12:03:00 +00003999
Yaxun Liu5b330e82018-03-15 15:25:19 +00004000 if (NeedCopy) {
Eli Friedmaneb7fab62011-06-14 01:37:52 +00004001 // Create an aligned temporary, and copy to it.
Yaxun Liuaefdb8e2018-06-15 15:33:22 +00004002 Address AI = CreateMemTempWithoutCast(
4003 I->Ty, ArgInfo.getIndirectAlign(), "byval-temp");
John McCall7f416cc2015-09-08 08:05:57 +00004004 IRCallArgs[FirstIRArg] = AI.getPointer();
Yaxun Liu5b330e82018-03-15 15:25:19 +00004005 I->copyInto(*this, AI);
Eli Friedmaneb7fab62011-06-14 01:37:52 +00004006 } else {
4007 // Skip the extra memcpy call.
Yaxun Liu5b330e82018-03-15 15:25:19 +00004008 auto *T = V->getType()->getPointerElementType()->getPointerTo(
4009 CGM.getDataLayout().getAllocaAddrSpace());
4010 IRCallArgs[FirstIRArg] = getTargetHooks().performAddrSpaceCast(
4011 *this, V, LangAS::Default, CGM.getASTAllocaAddressSpace(), T,
4012 true);
Eli Friedmaneb7fab62011-06-14 01:37:52 +00004013 }
Daniel Dunbar747865a2009-02-05 09:16:39 +00004014 }
4015 break;
Daniel Dunbar03816342010-08-21 02:24:36 +00004016 }
Daniel Dunbar747865a2009-02-05 09:16:39 +00004017
Daniel Dunbar94a6f252009-01-26 21:26:08 +00004018 case ABIArgInfo::Ignore:
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004019 assert(NumIRArgs == 0);
Daniel Dunbar94a6f252009-01-26 21:26:08 +00004020 break;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004021
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00004022 case ABIArgInfo::Extend:
4023 case ABIArgInfo::Direct: {
4024 if (!isa<llvm::StructType>(ArgInfo.getCoerceToType()) &&
Chris Lattner8a2f3c72010-07-30 04:02:24 +00004025 ArgInfo.getCoerceToType() == ConvertType(info_it->type) &&
4026 ArgInfo.getDirectOffset() == 0) {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004027 assert(NumIRArgs == 1);
Chris Lattnerbb1952c2011-07-12 04:46:18 +00004028 llvm::Value *V;
Yaxun Liu5b330e82018-03-15 15:25:19 +00004029 if (!I->isAggregate())
4030 V = I->getKnownRValue().getScalarVal();
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00004031 else
Yaxun Liu5b330e82018-03-15 15:25:19 +00004032 V = Builder.CreateLoad(
4033 I->hasLValue() ? I->getKnownLValue().getAddress()
4034 : I->getKnownRValue().getAggregateAddress());
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004035
John McCall12f23522016-04-04 18:33:08 +00004036 // Implement swifterror by copying into a new swifterror argument.
4037 // We'll write back in the normal path out of the call.
4038 if (CallInfo.getExtParameterInfo(ArgNo).getABI()
4039 == ParameterABI::SwiftErrorResult) {
4040 assert(!swiftErrorTemp.isValid() && "multiple swifterror args");
4041
4042 QualType pointeeTy = I->Ty->getPointeeType();
4043 swiftErrorArg =
4044 Address(V, getContext().getTypeAlignInChars(pointeeTy));
4045
4046 swiftErrorTemp =
4047 CreateMemTemp(pointeeTy, getPointerAlign(), "swifterror.temp");
4048 V = swiftErrorTemp.getPointer();
4049 cast<llvm::AllocaInst>(V)->setSwiftError(true);
4050
4051 llvm::Value *errorValue = Builder.CreateLoad(swiftErrorArg);
4052 Builder.CreateStore(errorValue, swiftErrorTemp);
4053 }
4054
Reid Kleckner79b0fd72014-10-10 00:05:45 +00004055 // We might have to widen integers, but we should never truncate.
4056 if (ArgInfo.getCoerceToType() != V->getType() &&
4057 V->getType()->isIntegerTy())
4058 V = Builder.CreateZExt(V, ArgInfo.getCoerceToType());
4059
Chris Lattner3ce86682011-07-12 04:53:39 +00004060 // If the argument doesn't match, perform a bitcast to coerce it. This
4061 // can happen due to trivial type mismatches.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004062 if (FirstIRArg < IRFuncTy->getNumParams() &&
4063 V->getType() != IRFuncTy->getParamType(FirstIRArg))
4064 V = Builder.CreateBitCast(V, IRFuncTy->getParamType(FirstIRArg));
John McCall12f23522016-04-04 18:33:08 +00004065
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004066 IRCallArgs[FirstIRArg] = V;
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00004067 break;
4068 }
Daniel Dunbar94a6f252009-01-26 21:26:08 +00004069
Daniel Dunbar2f219b02009-02-03 19:12:28 +00004070 // FIXME: Avoid the conversion through memory if possible.
John McCall7f416cc2015-09-08 08:05:57 +00004071 Address Src = Address::invalid();
Yaxun Liu5b330e82018-03-15 15:25:19 +00004072 if (!I->isAggregate()) {
John McCall7f416cc2015-09-08 08:05:57 +00004073 Src = CreateMemTemp(I->Ty, "coerce");
Yaxun Liu5b330e82018-03-15 15:25:19 +00004074 I->copyInto(*this, Src);
Ulrich Weigand6e2cea62015-07-10 11:31:43 +00004075 } else {
Yaxun Liu5b330e82018-03-15 15:25:19 +00004076 Src = I->hasLValue() ? I->getKnownLValue().getAddress()
4077 : I->getKnownRValue().getAggregateAddress();
Ulrich Weigand6e2cea62015-07-10 11:31:43 +00004078 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004079
Chris Lattner8a2f3c72010-07-30 04:02:24 +00004080 // If the value is offset in memory, apply the offset now.
John McCall7f416cc2015-09-08 08:05:57 +00004081 Src = emitAddressAtOffset(*this, Src, ArgInfo);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004082
Oliver Stannard2bfdc5b2014-08-27 10:43:15 +00004083 // Fast-isel and the optimizer generally like scalar values better than
4084 // FCAs, so we flatten them if this is safe to do for this argument.
James Molloy6f244b62014-05-09 16:21:39 +00004085 llvm::StructType *STy =
4086 dyn_cast<llvm::StructType>(ArgInfo.getCoerceToType());
Oliver Stannard2bfdc5b2014-08-27 10:43:15 +00004087 if (STy && ArgInfo.isDirect() && ArgInfo.getCanBeFlattened()) {
John McCall7f416cc2015-09-08 08:05:57 +00004088 llvm::Type *SrcTy = Src.getType()->getElementType();
Chandler Carrutha6399a52012-10-10 11:29:08 +00004089 uint64_t SrcSize = CGM.getDataLayout().getTypeAllocSize(SrcTy);
4090 uint64_t DstSize = CGM.getDataLayout().getTypeAllocSize(STy);
4091
4092 // If the source type is smaller than the destination type of the
4093 // coerce-to logic, copy the source value into a temp alloca the size
4094 // of the destination type to allow loading all of it. The bits past
4095 // the source value are left undef.
4096 if (SrcSize < DstSize) {
John McCall7f416cc2015-09-08 08:05:57 +00004097 Address TempAlloca
4098 = CreateTempAlloca(STy, Src.getAlignment(),
4099 Src.getName() + ".coerce");
4100 Builder.CreateMemCpy(TempAlloca, Src, SrcSize);
4101 Src = TempAlloca;
Chandler Carrutha6399a52012-10-10 11:29:08 +00004102 } else {
Matt Arsenault7a124f32017-08-01 20:36:57 +00004103 Src = Builder.CreateBitCast(Src,
4104 STy->getPointerTo(Src.getAddressSpace()));
Chandler Carrutha6399a52012-10-10 11:29:08 +00004105 }
4106
John McCall7f416cc2015-09-08 08:05:57 +00004107 auto SrcLayout = CGM.getDataLayout().getStructLayout(STy);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004108 assert(NumIRArgs == STy->getNumElements());
Chris Lattnerceddafb2010-07-05 20:41:41 +00004109 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
John McCall7f416cc2015-09-08 08:05:57 +00004110 auto Offset = CharUnits::fromQuantity(SrcLayout->getElementOffset(i));
4111 Address EltPtr = Builder.CreateStructGEP(Src, i, Offset);
4112 llvm::Value *LI = Builder.CreateLoad(EltPtr);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004113 IRCallArgs[FirstIRArg + i] = LI;
Chris Lattner15ec3612010-06-29 00:06:42 +00004114 }
Chris Lattner3dd716c2010-06-28 23:44:11 +00004115 } else {
Chris Lattner15ec3612010-06-29 00:06:42 +00004116 // In the simple case, just pass the coerced loaded value.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004117 assert(NumIRArgs == 1);
4118 IRCallArgs[FirstIRArg] =
John McCall7f416cc2015-09-08 08:05:57 +00004119 CreateCoercedLoad(Src, ArgInfo.getCoerceToType(), *this);
Chris Lattner3dd716c2010-06-28 23:44:11 +00004120 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004121
Daniel Dunbar2f219b02009-02-03 19:12:28 +00004122 break;
4123 }
4124
John McCallf26e73d2016-03-11 04:30:43 +00004125 case ABIArgInfo::CoerceAndExpand: {
John McCallf26e73d2016-03-11 04:30:43 +00004126 auto coercionType = ArgInfo.getCoerceAndExpandType();
4127 auto layout = CGM.getDataLayout().getStructLayout(coercionType);
4128
John McCall12f23522016-04-04 18:33:08 +00004129 llvm::Value *tempSize = nullptr;
4130 Address addr = Address::invalid();
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00004131 Address AllocaAddr = Address::invalid();
Yaxun Liu5b330e82018-03-15 15:25:19 +00004132 if (I->isAggregate()) {
4133 addr = I->hasLValue() ? I->getKnownLValue().getAddress()
4134 : I->getKnownRValue().getAggregateAddress();
4135
John McCall12f23522016-04-04 18:33:08 +00004136 } else {
Yaxun Liu5b330e82018-03-15 15:25:19 +00004137 RValue RV = I->getKnownRValue();
John McCall12f23522016-04-04 18:33:08 +00004138 assert(RV.isScalar()); // complex should always just be direct
4139
4140 llvm::Type *scalarType = RV.getScalarVal()->getType();
4141 auto scalarSize = CGM.getDataLayout().getTypeAllocSize(scalarType);
4142 auto scalarAlign = CGM.getDataLayout().getPrefTypeAlignment(scalarType);
4143
John McCall12f23522016-04-04 18:33:08 +00004144 // Materialize to a temporary.
4145 addr = CreateTempAlloca(RV.getScalarVal()->getType(),
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00004146 CharUnits::fromQuantity(std::max(
4147 layout->getAlignment(), scalarAlign)),
4148 "tmp",
4149 /*ArraySize=*/nullptr, &AllocaAddr);
4150 tempSize = EmitLifetimeStart(scalarSize, AllocaAddr.getPointer());
John McCall12f23522016-04-04 18:33:08 +00004151
4152 Builder.CreateStore(RV.getScalarVal(), addr);
4153 }
4154
John McCallf26e73d2016-03-11 04:30:43 +00004155 addr = Builder.CreateElementBitCast(addr, coercionType);
4156
4157 unsigned IRArgPos = FirstIRArg;
4158 for (unsigned i = 0, e = coercionType->getNumElements(); i != e; ++i) {
4159 llvm::Type *eltType = coercionType->getElementType(i);
4160 if (ABIArgInfo::isPaddingForCoerceAndExpand(eltType)) continue;
4161 Address eltAddr = Builder.CreateStructGEP(addr, i, layout);
4162 llvm::Value *elt = Builder.CreateLoad(eltAddr);
4163 IRCallArgs[IRArgPos++] = elt;
4164 }
4165 assert(IRArgPos == FirstIRArg + NumIRArgs);
4166
John McCall12f23522016-04-04 18:33:08 +00004167 if (tempSize) {
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00004168 EmitLifetimeEnd(tempSize, AllocaAddr.getPointer());
John McCall12f23522016-04-04 18:33:08 +00004169 }
4170
John McCallf26e73d2016-03-11 04:30:43 +00004171 break;
4172 }
4173
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00004174 case ABIArgInfo::Expand:
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004175 unsigned IRArgPos = FirstIRArg;
Yaxun Liu5b330e82018-03-15 15:25:19 +00004176 ExpandTypeToArgs(I->Ty, *I, IRFuncTy, IRCallArgs, IRArgPos);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004177 assert(IRArgPos == FirstIRArg + NumIRArgs);
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00004178 break;
Daniel Dunbar613855c2008-09-09 23:27:19 +00004179 }
4180 }
Mike Stump11289f42009-09-09 15:08:12 +00004181
John McCall9831b842018-02-06 18:52:44 +00004182 const CGCallee &ConcreteCallee = Callee.prepareConcreteCallee(*this);
4183 llvm::Value *CalleePtr = ConcreteCallee.getFunctionPointer();
John McCallb92ab1a2016-10-26 23:46:34 +00004184
4185 // If we're using inalloca, set up that argument.
John McCall7f416cc2015-09-08 08:05:57 +00004186 if (ArgMemory.isValid()) {
4187 llvm::Value *Arg = ArgMemory.getPointer();
Reid Klecknerafba553e2014-07-08 02:24:27 +00004188 if (CallInfo.isVariadic()) {
4189 // When passing non-POD arguments by value to variadic functions, we will
4190 // end up with a variadic prototype and an inalloca call site. In such
4191 // cases, we can't do any parameter mismatch checks. Give up and bitcast
4192 // the callee.
John McCallb92ab1a2016-10-26 23:46:34 +00004193 unsigned CalleeAS = CalleePtr->getType()->getPointerAddressSpace();
4194 auto FnTy = getTypes().GetFunctionType(CallInfo)->getPointerTo(CalleeAS);
4195 CalleePtr = Builder.CreateBitCast(CalleePtr, FnTy);
Reid Klecknerafba553e2014-07-08 02:24:27 +00004196 } else {
4197 llvm::Type *LastParamTy =
4198 IRFuncTy->getParamType(IRFuncTy->getNumParams() - 1);
4199 if (Arg->getType() != LastParamTy) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00004200#ifndef NDEBUG
Reid Klecknerafba553e2014-07-08 02:24:27 +00004201 // Assert that these structs have equivalent element types.
4202 llvm::StructType *FullTy = CallInfo.getArgStruct();
4203 llvm::StructType *DeclaredTy = cast<llvm::StructType>(
4204 cast<llvm::PointerType>(LastParamTy)->getElementType());
4205 assert(DeclaredTy->getNumElements() == FullTy->getNumElements());
4206 for (llvm::StructType::element_iterator DI = DeclaredTy->element_begin(),
4207 DE = DeclaredTy->element_end(),
4208 FI = FullTy->element_begin();
4209 DI != DE; ++DI, ++FI)
4210 assert(*DI == *FI);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00004211#endif
Reid Klecknerafba553e2014-07-08 02:24:27 +00004212 Arg = Builder.CreateBitCast(Arg, LastParamTy);
4213 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00004214 }
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004215 assert(IRFunctionArgs.hasInallocaArg());
4216 IRCallArgs[IRFunctionArgs.getInallocaArgNo()] = Arg;
Reid Kleckner314ef7b2014-02-01 00:04:45 +00004217 }
4218
John McCallb92ab1a2016-10-26 23:46:34 +00004219 // 2. Prepare the function pointer.
4220
4221 // If the callee is a bitcast of a non-variadic function to have a
4222 // variadic function pointer type, check to see if we can remove the
4223 // bitcast. This comes up with unprototyped functions.
4224 //
4225 // This makes the IR nicer, but more importantly it ensures that we
4226 // can inline the function at -O0 if it is marked always_inline.
4227 auto simplifyVariadicCallee = [](llvm::Value *Ptr) -> llvm::Value* {
4228 llvm::FunctionType *CalleeFT =
4229 cast<llvm::FunctionType>(Ptr->getType()->getPointerElementType());
4230 if (!CalleeFT->isVarArg())
4231 return Ptr;
4232
4233 llvm::ConstantExpr *CE = dyn_cast<llvm::ConstantExpr>(Ptr);
4234 if (!CE || CE->getOpcode() != llvm::Instruction::BitCast)
4235 return Ptr;
4236
4237 llvm::Function *OrigFn = dyn_cast<llvm::Function>(CE->getOperand(0));
4238 if (!OrigFn)
4239 return Ptr;
4240
4241 llvm::FunctionType *OrigFT = OrigFn->getFunctionType();
4242
4243 // If the original type is variadic, or if any of the component types
4244 // disagree, we cannot remove the cast.
4245 if (OrigFT->isVarArg() ||
4246 OrigFT->getNumParams() != CalleeFT->getNumParams() ||
4247 OrigFT->getReturnType() != CalleeFT->getReturnType())
4248 return Ptr;
4249
4250 for (unsigned i = 0, e = OrigFT->getNumParams(); i != e; ++i)
4251 if (OrigFT->getParamType(i) != CalleeFT->getParamType(i))
4252 return Ptr;
4253
4254 return OrigFn;
4255 };
4256 CalleePtr = simplifyVariadicCallee(CalleePtr);
4257
4258 // 3. Perform the actual call.
4259
4260 // Deactivate any cleanups that we're supposed to do immediately before
4261 // the call.
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00004262 if (!CallArgs.getCleanupsToDeactivate().empty())
4263 deactivateArgCleanupsBeforeCall(*this, CallArgs);
4264
John McCallb92ab1a2016-10-26 23:46:34 +00004265 // Assert that the arguments we computed match up. The IR verifier
4266 // will catch this, but this is a common enough source of problems
4267 // during IRGen changes that it's way better for debugging to catch
4268 // it ourselves here.
4269#ifndef NDEBUG
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004270 assert(IRCallArgs.size() == IRFuncTy->getNumParams() || IRFuncTy->isVarArg());
4271 for (unsigned i = 0; i < IRCallArgs.size(); ++i) {
4272 // Inalloca argument can have different type.
4273 if (IRFunctionArgs.hasInallocaArg() &&
4274 i == IRFunctionArgs.getInallocaArgNo())
4275 continue;
4276 if (i < IRFuncTy->getNumParams())
4277 assert(IRCallArgs[i]->getType() == IRFuncTy->getParamType(i));
4278 }
John McCallb92ab1a2016-10-26 23:46:34 +00004279#endif
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004280
Craig Topper3113ec32018-10-24 17:42:17 +00004281 // Update the largest vector width if any arguments have vector types.
4282 for (unsigned i = 0; i < IRCallArgs.size(); ++i) {
4283 if (auto *VT = dyn_cast<llvm::VectorType>(IRCallArgs[i]->getType()))
4284 LargestVectorWidth = std::max(LargestVectorWidth,
4285 VT->getPrimitiveSizeInBits());
4286 }
4287
John McCallb92ab1a2016-10-26 23:46:34 +00004288 // Compute the calling convention and attributes.
Daniel Dunbar0ef34792009-09-12 00:59:20 +00004289 unsigned CallingConv;
Reid Klecknercdd26792017-04-18 23:50:03 +00004290 llvm::AttributeList Attrs;
John McCallb92ab1a2016-10-26 23:46:34 +00004291 CGM.ConstructAttributeList(CalleePtr->getName(), CallInfo,
Reid Klecknercdd26792017-04-18 23:50:03 +00004292 Callee.getAbstractInfo(), Attrs, CallingConv,
Chad Rosier7dbc9cf2016-01-06 14:35:46 +00004293 /*AttrOnCallSite=*/true);
Mike Stump11289f42009-09-09 15:08:12 +00004294
John McCallb92ab1a2016-10-26 23:46:34 +00004295 // Apply some call-site-specific attributes.
4296 // TODO: work this into building the attribute set.
4297
4298 // Apply always_inline to all calls within flatten functions.
4299 // FIXME: should this really take priority over __try, below?
4300 if (CurCodeDecl && CurCodeDecl->hasAttr<FlattenAttr>() &&
Erich Keanede6480a32018-11-13 15:48:08 +00004301 !(Callee.getAbstractInfo().getCalleeDecl().getDecl() &&
4302 Callee.getAbstractInfo()
4303 .getCalleeDecl()
4304 .getDecl()
4305 ->hasAttr<NoInlineAttr>())) {
John McCallb92ab1a2016-10-26 23:46:34 +00004306 Attrs =
Reid Klecknerde864822017-03-21 16:57:30 +00004307 Attrs.addAttribute(getLLVMContext(), llvm::AttributeList::FunctionIndex,
John McCallb92ab1a2016-10-26 23:46:34 +00004308 llvm::Attribute::AlwaysInline);
4309 }
4310
4311 // Disable inlining inside SEH __try blocks.
4312 if (isSEHTryScope()) {
4313 Attrs =
Reid Klecknerde864822017-03-21 16:57:30 +00004314 Attrs.addAttribute(getLLVMContext(), llvm::AttributeList::FunctionIndex,
John McCallb92ab1a2016-10-26 23:46:34 +00004315 llvm::Attribute::NoInline);
4316 }
4317
4318 // Decide whether to use a call or an invoke.
David Majnemer4e52d6f2015-12-12 05:39:21 +00004319 bool CannotThrow;
4320 if (currentFunctionUsesSEHTry()) {
John McCallb92ab1a2016-10-26 23:46:34 +00004321 // SEH cares about asynchronous exceptions, so everything can "throw."
David Majnemer4e52d6f2015-12-12 05:39:21 +00004322 CannotThrow = false;
4323 } else if (isCleanupPadScope() &&
4324 EHPersonality::get(*this).isMSVCXXPersonality()) {
4325 // The MSVC++ personality will implicitly terminate the program if an
John McCallb92ab1a2016-10-26 23:46:34 +00004326 // exception is thrown during a cleanup outside of a try/catch.
4327 // We don't need to model anything in IR to get this behavior.
David Majnemer4e52d6f2015-12-12 05:39:21 +00004328 CannotThrow = true;
4329 } else {
John McCallb92ab1a2016-10-26 23:46:34 +00004330 // Otherwise, nounwind call sites will never throw.
Reid Klecknerde864822017-03-21 16:57:30 +00004331 CannotThrow = Attrs.hasAttribute(llvm::AttributeList::FunctionIndex,
David Majnemer4e52d6f2015-12-12 05:39:21 +00004332 llvm::Attribute::NoUnwind);
4333 }
George Burgess IV003be7c2018-03-08 05:32:30 +00004334
4335 // If we made a temporary, be sure to clean up after ourselves. Note that we
4336 // can't depend on being inside of an ExprWithCleanups, so we need to manually
4337 // pop this cleanup later on. Being eager about this is OK, since this
4338 // temporary is 'invisible' outside of the callee.
4339 if (UnusedReturnSizePtr)
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00004340 pushFullExprCleanup<CallLifetimeEnd>(NormalEHLifetimeMarker, SRetAlloca,
George Burgess IV003be7c2018-03-08 05:32:30 +00004341 UnusedReturnSizePtr);
4342
David Majnemer4e52d6f2015-12-12 05:39:21 +00004343 llvm::BasicBlock *InvokeDest = CannotThrow ? nullptr : getInvokeDest();
John McCallbd309292010-07-06 01:34:17 +00004344
Reid Klecknerb75a3f02018-02-09 00:16:41 +00004345 SmallVector<llvm::OperandBundleDef, 1> BundleList =
4346 getBundlesForFunclet(CalleePtr);
David Majnemer0b17d442015-12-15 21:27:59 +00004347
John McCallb92ab1a2016-10-26 23:46:34 +00004348 // Emit the actual call/invoke instruction.
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004349 llvm::CallSite CS;
John McCallbd309292010-07-06 01:34:17 +00004350 if (!InvokeDest) {
John McCallb92ab1a2016-10-26 23:46:34 +00004351 CS = Builder.CreateCall(CalleePtr, IRCallArgs, BundleList);
Daniel Dunbar12347492009-02-23 17:26:39 +00004352 } else {
4353 llvm::BasicBlock *Cont = createBasicBlock("invoke.cont");
John McCallb92ab1a2016-10-26 23:46:34 +00004354 CS = Builder.CreateInvoke(CalleePtr, Cont, InvokeDest, IRCallArgs,
David Majnemer0b17d442015-12-15 21:27:59 +00004355 BundleList);
Daniel Dunbar12347492009-02-23 17:26:39 +00004356 EmitBlock(Cont);
Daniel Dunbar5006f4a2009-02-20 18:54:31 +00004357 }
John McCallb92ab1a2016-10-26 23:46:34 +00004358 llvm::Instruction *CI = CS.getInstruction();
Chris Lattnere70a0072010-06-29 16:40:28 +00004359 if (callOrInvoke)
John McCallb92ab1a2016-10-26 23:46:34 +00004360 *callOrInvoke = CI;
Daniel Dunbar5006f4a2009-02-20 18:54:31 +00004361
John McCallb92ab1a2016-10-26 23:46:34 +00004362 // Apply the attributes and calling convention.
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004363 CS.setAttributes(Attrs);
Daniel Dunbar0ef34792009-09-12 00:59:20 +00004364 CS.setCallingConv(static_cast<llvm::CallingConv::ID>(CallingConv));
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004365
John McCallb92ab1a2016-10-26 23:46:34 +00004366 // Apply various metadata.
4367
4368 if (!CI->getType()->isVoidTy())
4369 CI->setName("call");
4370
Craig Topper3113ec32018-10-24 17:42:17 +00004371 // Update largest vector width from the return type.
4372 if (auto *VT = dyn_cast<llvm::VectorType>(CI->getType()))
4373 LargestVectorWidth = std::max(LargestVectorWidth,
4374 VT->getPrimitiveSizeInBits());
4375
Adam Nemet1e217bc2016-03-28 22:18:53 +00004376 // Insert instrumentation or attach profile metadata at indirect call sites.
4377 // For more details, see the comment before the definition of
4378 // IPVK_IndirectCallTarget in InstrProfData.inc.
Betul Buyukkurt518276a2016-01-23 22:50:44 +00004379 if (!CS.getCalledFunction())
4380 PGO.valueProfile(Builder, llvm::IPVK_IndirectCallTarget,
John McCallb92ab1a2016-10-26 23:46:34 +00004381 CI, CalleePtr);
Betul Buyukkurt518276a2016-01-23 22:50:44 +00004382
Dan Gohman515a60d2012-02-16 00:57:37 +00004383 // In ObjC ARC mode with no ObjC ARC exception safety, tell the ARC
4384 // optimizer it can aggressively ignore unwind edges.
David Blaikiebbafb8a2012-03-11 07:00:24 +00004385 if (CGM.getLangOpts().ObjCAutoRefCount)
John McCallb92ab1a2016-10-26 23:46:34 +00004386 AddObjCARCExceptionMetadata(CI);
4387
4388 // Suppress tail calls if requested.
4389 if (llvm::CallInst *Call = dyn_cast<llvm::CallInst>(CI)) {
Erich Keanede6480a32018-11-13 15:48:08 +00004390 const Decl *TargetDecl = Callee.getAbstractInfo().getCalleeDecl().getDecl();
John McCallb92ab1a2016-10-26 23:46:34 +00004391 if (TargetDecl && TargetDecl->hasAttr<NotTailCalledAttr>())
4392 Call->setTailCallKind(llvm::CallInst::TCK_NoTail);
4393 }
4394
4395 // 4. Finish the call.
Dan Gohman515a60d2012-02-16 00:57:37 +00004396
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004397 // If the call doesn't return, finish the basic block and clear the
John McCallb92ab1a2016-10-26 23:46:34 +00004398 // insertion point; this allows the rest of IRGen to discard
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004399 // unreachable code.
4400 if (CS.doesNotReturn()) {
George Burgess IV003be7c2018-03-08 05:32:30 +00004401 if (UnusedReturnSizePtr)
4402 PopCleanupBlock();
Leny Kholodov6aab1112015-06-08 10:23:49 +00004403
Vedant Kumar09b5bfd2017-12-21 00:10:25 +00004404 // Strip away the noreturn attribute to better diagnose unreachable UB.
4405 if (SanOpts.has(SanitizerKind::Unreachable)) {
4406 if (auto *F = CS.getCalledFunction())
4407 F->removeFnAttr(llvm::Attribute::NoReturn);
4408 CS.removeAttribute(llvm::AttributeList::FunctionIndex,
4409 llvm::Attribute::NoReturn);
4410 }
4411
4412 EmitUnreachable(Loc);
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004413 Builder.ClearInsertionPoint();
Mike Stump11289f42009-09-09 15:08:12 +00004414
Mike Stump18bb9282009-05-16 07:57:57 +00004415 // FIXME: For now, emit a dummy basic block because expr emitters in
4416 // generally are not ready to handle emitting expressions at unreachable
4417 // points.
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004418 EnsureInsertPoint();
Mike Stump11289f42009-09-09 15:08:12 +00004419
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004420 // Return a reasonable RValue.
4421 return GetUndefRValue(RetTy);
Mike Stump11289f42009-09-09 15:08:12 +00004422 }
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004423
John McCall12f23522016-04-04 18:33:08 +00004424 // Perform the swifterror writeback.
4425 if (swiftErrorTemp.isValid()) {
4426 llvm::Value *errorResult = Builder.CreateLoad(swiftErrorTemp);
4427 Builder.CreateStore(errorResult, swiftErrorArg);
4428 }
4429
John McCallb92ab1a2016-10-26 23:46:34 +00004430 // Emit any call-associated writebacks immediately. Arguably this
4431 // should happen after any return-value munging.
John McCall31168b02011-06-15 23:02:42 +00004432 if (CallArgs.hasWritebacks())
4433 emitWritebacks(*this, CallArgs);
4434
Nico Weber8cdb3f92015-08-25 18:43:32 +00004435 // The stack cleanup for inalloca arguments has to run out of the normal
4436 // lexical order, so deactivate it and run it manually here.
4437 CallArgs.freeArgumentMemory(*this);
4438
John McCallb92ab1a2016-10-26 23:46:34 +00004439 // Extract the return value.
Hal Finkelee90a222014-09-26 05:04:30 +00004440 RValue Ret = [&] {
4441 switch (RetAI.getKind()) {
John McCallf26e73d2016-03-11 04:30:43 +00004442 case ABIArgInfo::CoerceAndExpand: {
4443 auto coercionType = RetAI.getCoerceAndExpandType();
4444 auto layout = CGM.getDataLayout().getStructLayout(coercionType);
4445
4446 Address addr = SRetPtr;
4447 addr = Builder.CreateElementBitCast(addr, coercionType);
4448
John McCall12f23522016-04-04 18:33:08 +00004449 assert(CI->getType() == RetAI.getUnpaddedCoerceAndExpandType());
4450 bool requiresExtract = isa<llvm::StructType>(CI->getType());
4451
John McCallf26e73d2016-03-11 04:30:43 +00004452 unsigned unpaddedIndex = 0;
4453 for (unsigned i = 0, e = coercionType->getNumElements(); i != e; ++i) {
4454 llvm::Type *eltType = coercionType->getElementType(i);
4455 if (ABIArgInfo::isPaddingForCoerceAndExpand(eltType)) continue;
4456 Address eltAddr = Builder.CreateStructGEP(addr, i, layout);
John McCall12f23522016-04-04 18:33:08 +00004457 llvm::Value *elt = CI;
4458 if (requiresExtract)
4459 elt = Builder.CreateExtractValue(elt, unpaddedIndex++);
4460 else
4461 assert(unpaddedIndex == 0);
John McCallf26e73d2016-03-11 04:30:43 +00004462 Builder.CreateStore(elt, eltAddr);
4463 }
John McCall12f23522016-04-04 18:33:08 +00004464 // FALLTHROUGH
Galina Kistanova0872d6c2017-06-03 06:30:46 +00004465 LLVM_FALLTHROUGH;
John McCall12f23522016-04-04 18:33:08 +00004466 }
4467
4468 case ABIArgInfo::InAlloca:
4469 case ABIArgInfo::Indirect: {
4470 RValue ret = convertTempToRValue(SRetPtr, RetTy, SourceLocation());
George Burgess IV003be7c2018-03-08 05:32:30 +00004471 if (UnusedReturnSizePtr)
4472 PopCleanupBlock();
John McCall12f23522016-04-04 18:33:08 +00004473 return ret;
John McCallf26e73d2016-03-11 04:30:43 +00004474 }
4475
Hal Finkelee90a222014-09-26 05:04:30 +00004476 case ABIArgInfo::Ignore:
4477 // If we are ignoring an argument that had a result, make sure to
4478 // construct the appropriate return value for our caller.
4479 return GetUndefRValue(RetTy);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004480
Hal Finkelee90a222014-09-26 05:04:30 +00004481 case ABIArgInfo::Extend:
4482 case ABIArgInfo::Direct: {
4483 llvm::Type *RetIRTy = ConvertType(RetTy);
4484 if (RetAI.getCoerceToType() == RetIRTy && RetAI.getDirectOffset() == 0) {
4485 switch (getEvaluationKind(RetTy)) {
4486 case TEK_Complex: {
4487 llvm::Value *Real = Builder.CreateExtractValue(CI, 0);
4488 llvm::Value *Imag = Builder.CreateExtractValue(CI, 1);
4489 return RValue::getComplex(std::make_pair(Real, Imag));
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00004490 }
Hal Finkelee90a222014-09-26 05:04:30 +00004491 case TEK_Aggregate: {
John McCall7f416cc2015-09-08 08:05:57 +00004492 Address DestPtr = ReturnValue.getValue();
Hal Finkelee90a222014-09-26 05:04:30 +00004493 bool DestIsVolatile = ReturnValue.isVolatile();
4494
John McCall7f416cc2015-09-08 08:05:57 +00004495 if (!DestPtr.isValid()) {
Hal Finkelee90a222014-09-26 05:04:30 +00004496 DestPtr = CreateMemTemp(RetTy, "agg.tmp");
4497 DestIsVolatile = false;
4498 }
John McCall7f416cc2015-09-08 08:05:57 +00004499 BuildAggStore(*this, CI, DestPtr, DestIsVolatile);
Hal Finkelee90a222014-09-26 05:04:30 +00004500 return RValue::getAggregate(DestPtr);
4501 }
4502 case TEK_Scalar: {
4503 // If the argument doesn't match, perform a bitcast to coerce it. This
4504 // can happen due to trivial type mismatches.
4505 llvm::Value *V = CI;
4506 if (V->getType() != RetIRTy)
4507 V = Builder.CreateBitCast(V, RetIRTy);
4508 return RValue::get(V);
4509 }
4510 }
4511 llvm_unreachable("bad evaluation kind");
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00004512 }
Hal Finkelee90a222014-09-26 05:04:30 +00004513
John McCall7f416cc2015-09-08 08:05:57 +00004514 Address DestPtr = ReturnValue.getValue();
Hal Finkelee90a222014-09-26 05:04:30 +00004515 bool DestIsVolatile = ReturnValue.isVolatile();
4516
John McCall7f416cc2015-09-08 08:05:57 +00004517 if (!DestPtr.isValid()) {
Hal Finkelee90a222014-09-26 05:04:30 +00004518 DestPtr = CreateMemTemp(RetTy, "coerce");
4519 DestIsVolatile = false;
John McCall47fb9502013-03-07 21:37:08 +00004520 }
Hal Finkelee90a222014-09-26 05:04:30 +00004521
4522 // If the value is offset in memory, apply the offset now.
John McCall7f416cc2015-09-08 08:05:57 +00004523 Address StorePtr = emitAddressAtOffset(*this, DestPtr, RetAI);
4524 CreateCoercedStore(CI, StorePtr, DestIsVolatile, *this);
Hal Finkelee90a222014-09-26 05:04:30 +00004525
4526 return convertTempToRValue(DestPtr, RetTy, SourceLocation());
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00004527 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004528
Hal Finkelee90a222014-09-26 05:04:30 +00004529 case ABIArgInfo::Expand:
4530 llvm_unreachable("Invalid ABI kind for return argument");
Anders Carlsson17490832009-12-24 20:40:36 +00004531 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004532
Hal Finkelee90a222014-09-26 05:04:30 +00004533 llvm_unreachable("Unhandled ABIArgInfo::Kind");
4534 } ();
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004535
John McCallb92ab1a2016-10-26 23:46:34 +00004536 // Emit the assume_aligned check on the return value.
Erich Keanede6480a32018-11-13 15:48:08 +00004537 const Decl *TargetDecl = Callee.getAbstractInfo().getCalleeDecl().getDecl();
Hal Finkelee90a222014-09-26 05:04:30 +00004538 if (Ret.isScalar() && TargetDecl) {
4539 if (const auto *AA = TargetDecl->getAttr<AssumeAlignedAttr>()) {
4540 llvm::Value *OffsetValue = nullptr;
4541 if (const auto *Offset = AA->getOffset())
4542 OffsetValue = EmitScalarExpr(Offset);
4543
4544 llvm::Value *Alignment = EmitScalarExpr(AA->getAlignment());
4545 llvm::ConstantInt *AlignmentCI = cast<llvm::ConstantInt>(Alignment);
Roman Lebedevbd1c0872019-01-15 09:44:25 +00004546 EmitAlignmentAssumption(Ret.getScalarVal(), RetTy, Loc, AA->getLocation(),
4547 AlignmentCI->getZExtValue(), OffsetValue);
Erich Keane623efd82017-03-30 21:48:55 +00004548 } else if (const auto *AA = TargetDecl->getAttr<AllocAlignAttr>()) {
Roman Lebedevbd1c0872019-01-15 09:44:25 +00004549 llvm::Value *AlignmentVal = CallArgs[AA->getParamIndex().getLLVMIndex()]
4550 .getRValue(*this)
4551 .getScalarVal();
4552 EmitAlignmentAssumption(Ret.getScalarVal(), RetTy, Loc, AA->getLocation(),
4553 AlignmentVal);
Hal Finkelee90a222014-09-26 05:04:30 +00004554 }
Daniel Dunbar573884e2008-09-10 07:04:09 +00004555 }
Daniel Dunbard3674e62008-09-11 01:48:57 +00004556
Hal Finkelee90a222014-09-26 05:04:30 +00004557 return Ret;
Daniel Dunbar613855c2008-09-09 23:27:19 +00004558}
Daniel Dunbar2d0746f2009-02-10 20:44:09 +00004559
John McCall9831b842018-02-06 18:52:44 +00004560CGCallee CGCallee::prepareConcreteCallee(CodeGenFunction &CGF) const {
4561 if (isVirtual()) {
4562 const CallExpr *CE = getVirtualCallExpr();
4563 return CGF.CGM.getCXXABI().getVirtualFunctionPointer(
Stephen Kellyf2ceec42018-08-09 21:08:08 +00004564 CGF, getVirtualMethodDecl(), getThisAddress(), getFunctionType(),
4565 CE ? CE->getBeginLoc() : SourceLocation());
John McCall9831b842018-02-06 18:52:44 +00004566 }
4567
4568 return *this;
4569}
4570
Daniel Dunbar2d0746f2009-02-10 20:44:09 +00004571/* VarArg handling */
4572
Charles Davisc7d5c942015-09-17 20:55:33 +00004573Address CodeGenFunction::EmitVAArg(VAArgExpr *VE, Address &VAListAddr) {
4574 VAListAddr = VE->isMicrosoftABI()
4575 ? EmitMSVAListRef(VE->getSubExpr())
4576 : EmitVAListRef(VE->getSubExpr());
4577 QualType Ty = VE->getType();
4578 if (VE->isMicrosoftABI())
4579 return CGM.getTypes().getABIInfo().EmitMSVAArg(*this, VAListAddr, Ty);
John McCall7f416cc2015-09-08 08:05:57 +00004580 return CGM.getTypes().getABIInfo().EmitVAArg(*this, VAListAddr, Ty);
Daniel Dunbar2d0746f2009-02-10 20:44:09 +00004581}