blob: 4757cd2ffae622e22fdab8b4ed0d59aa3dd4df59 [file] [log] [blame]
Nick Lewycky5fa40c32013-10-01 21:51:38 +00001//===--- CGCall.cpp - Encapsulate calling convention details --------------===//
Daniel Dunbar3d7c90b2008-09-08 21:33:45 +00002//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// These classes wrap the information about a call or function
11// definition used to handle ABI compliancy.
12//
13//===----------------------------------------------------------------------===//
14
15#include "CGCall.h"
Chris Lattnere70a0072010-06-29 16:40:28 +000016#include "ABIInfo.h"
Akira Hatanaka9d8ac612016-02-17 21:09:50 +000017#include "CGBlocks.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000018#include "CGCXXABI.h"
David Majnemer4e52d6f2015-12-12 05:39:21 +000019#include "CGCleanup.h"
Daniel Dunbar3d7c90b2008-09-08 21:33:45 +000020#include "CodeGenFunction.h"
Daniel Dunbarc68897d2008-09-10 00:41:16 +000021#include "CodeGenModule.h"
John McCalla729c622012-02-17 03:33:10 +000022#include "TargetInfo.h"
Daniel Dunbar3d7c90b2008-09-08 21:33:45 +000023#include "clang/AST/Decl.h"
Anders Carlssonb15b55c2009-04-03 22:48:58 +000024#include "clang/AST/DeclCXX.h"
Daniel Dunbar3d7c90b2008-09-08 21:33:45 +000025#include "clang/AST/DeclObjC.h"
Richard Trieu63688182018-12-11 03:18:39 +000026#include "clang/Basic/CodeGenOptions.h"
Eric Christopher15709992015-10-15 23:47:11 +000027#include "clang/Basic/TargetBuiltins.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000028#include "clang/Basic/TargetInfo.h"
Mark Laceya8e7df32013-10-30 21:53:58 +000029#include "clang/CodeGen/CGFunctionInfo.h"
John McCall12f23522016-04-04 18:33:08 +000030#include "clang/CodeGen/SwiftCallingConv.h"
Bill Wendling706469b2013-02-28 22:49:57 +000031#include "llvm/ADT/StringExtras.h"
David Blaikie181a6132018-06-04 21:23:29 +000032#include "llvm/Transforms/Utils/Local.h"
Nick Lewyckyd9bce502016-09-20 15:49:58 +000033#include "llvm/Analysis/ValueTracking.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000034#include "llvm/IR/Attributes.h"
Chandler Carruthc80ceea2014-03-04 11:02:08 +000035#include "llvm/IR/CallSite.h"
David Blaikief47ca252018-03-21 22:34:27 +000036#include "llvm/IR/CallingConv.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000037#include "llvm/IR/DataLayout.h"
38#include "llvm/IR/InlineAsm.h"
Saleem Abdulrasool10a49722016-04-08 16:52:00 +000039#include "llvm/IR/IntrinsicInst.h"
David Blaikief47ca252018-03-21 22:34:27 +000040#include "llvm/IR/Intrinsics.h"
Daniel Dunbar3d7c90b2008-09-08 21:33:45 +000041using namespace clang;
42using namespace CodeGen;
43
44/***/
45
Nikolay Haustov8c6538b2016-06-30 09:06:33 +000046unsigned CodeGenTypes::ClangCallConvToLLVMCallConv(CallingConv CC) {
John McCallab26cfa2010-02-05 21:31:56 +000047 switch (CC) {
48 default: return llvm::CallingConv::C;
49 case CC_X86StdCall: return llvm::CallingConv::X86_StdCall;
50 case CC_X86FastCall: return llvm::CallingConv::X86_FastCall;
Erich Keane757d3172016-11-02 18:29:35 +000051 case CC_X86RegCall: return llvm::CallingConv::X86_RegCall;
Douglas Gregora941dca2010-05-18 16:57:00 +000052 case CC_X86ThisCall: return llvm::CallingConv::X86_ThisCall;
Martin Storsjo022e7822017-07-17 20:49:45 +000053 case CC_Win64: return llvm::CallingConv::Win64;
Charles Davisb5a214e2013-08-30 04:39:01 +000054 case CC_X86_64SysV: return llvm::CallingConv::X86_64_SysV;
Anton Korobeynikov231e8752011-04-14 20:06:49 +000055 case CC_AAPCS: return llvm::CallingConv::ARM_AAPCS;
56 case CC_AAPCS_VFP: return llvm::CallingConv::ARM_AAPCS_VFP;
Guy Benyeif0a014b2012-12-25 08:53:55 +000057 case CC_IntelOclBicc: return llvm::CallingConv::Intel_OCL_BI;
Reid Klecknerd7857f02014-10-24 17:42:17 +000058 // TODO: Add support for __pascal to LLVM.
59 case CC_X86Pascal: return llvm::CallingConv::C;
60 // TODO: Add support for __vectorcall to LLVM.
Reid Kleckner80944df2014-10-31 22:00:51 +000061 case CC_X86VectorCall: return llvm::CallingConv::X86_VectorCall;
Sander de Smalen44a22532018-11-26 16:38:37 +000062 case CC_AArch64VectorCall: return llvm::CallingConv::AArch64_VectorCall;
Alexander Kornienko21de0ae2015-01-20 11:20:41 +000063 case CC_SpirFunction: return llvm::CallingConv::SPIR_FUNC;
Nikolay Haustov8c6538b2016-06-30 09:06:33 +000064 case CC_OpenCLKernel: return CGM.getTargetCodeGenInfo().getOpenCLKernelCallingConv();
Roman Levenstein35aa5ce2016-03-16 18:00:46 +000065 case CC_PreserveMost: return llvm::CallingConv::PreserveMost;
66 case CC_PreserveAll: return llvm::CallingConv::PreserveAll;
John McCall12f23522016-04-04 18:33:08 +000067 case CC_Swift: return llvm::CallingConv::Swift;
John McCallab26cfa2010-02-05 21:31:56 +000068 }
69}
70
Mikael Nilsson90646732018-12-12 15:06:16 +000071/// Derives the 'this' type for codegen purposes, i.e. ignoring method
John McCall8ee376f2010-02-24 07:14:12 +000072/// qualification.
Mikael Nilsson90646732018-12-12 15:06:16 +000073/// FIXME: address space qualification?
74static CanQualType GetThisType(ASTContext &Context, const CXXRecordDecl *RD) {
John McCall2da83a32010-02-26 00:48:12 +000075 QualType RecTy = Context.getTagDeclType(RD)->getCanonicalTypeInternal();
76 return Context.getPointerType(CanQualType::CreateUnsafe(RecTy));
Daniel Dunbar7a95ca32008-09-10 04:01:49 +000077}
78
John McCall8ee376f2010-02-24 07:14:12 +000079/// Returns the canonical formal type of the given C++ method.
John McCall2da83a32010-02-26 00:48:12 +000080static CanQual<FunctionProtoType> GetFormalType(const CXXMethodDecl *MD) {
81 return MD->getType()->getCanonicalTypeUnqualified()
82 .getAs<FunctionProtoType>();
John McCall8ee376f2010-02-24 07:14:12 +000083}
84
85/// Returns the "extra-canonicalized" return type, which discards
86/// qualifiers on the return type. Codegen doesn't care about them,
87/// and it makes ABI code a little easier to be able to assume that
88/// all parameter and return types are top-level unqualified.
John McCall2da83a32010-02-26 00:48:12 +000089static CanQualType GetReturnType(QualType RetTy) {
90 return RetTy->getCanonicalTypeUnqualified().getUnqualifiedType();
John McCall8ee376f2010-02-24 07:14:12 +000091}
92
John McCall8dda7b22012-07-07 06:41:13 +000093/// Arrange the argument and result information for a value of the given
94/// unprototyped freestanding function type.
John McCall8ee376f2010-02-24 07:14:12 +000095const CGFunctionInfo &
John McCall8dda7b22012-07-07 06:41:13 +000096CodeGenTypes::arrangeFreeFunctionType(CanQual<FunctionNoProtoType> FTNP) {
John McCalla729c622012-02-17 03:33:10 +000097 // When translating an unprototyped function type, always use a
98 // variadic type.
Alp Toker314cc812014-01-25 16:55:45 +000099 return arrangeLLVMFunctionInfo(FTNP->getReturnType().getUnqualifiedType(),
Peter Collingbournef7706832014-12-12 23:41:25 +0000100 /*instanceMethod=*/false,
101 /*chainCall=*/false, None,
John McCallc56a8b32016-03-11 04:30:31 +0000102 FTNP->getExtInfo(), {}, RequiredArgs(0));
John McCall8ee376f2010-02-24 07:14:12 +0000103}
104
George Burgess IVb7760212017-02-24 02:49:47 +0000105static void addExtParameterInfosForCall(
106 llvm::SmallVectorImpl<FunctionProtoType::ExtParameterInfo> &paramInfos,
107 const FunctionProtoType *proto,
108 unsigned prefixArgs,
109 unsigned totalArgs) {
110 assert(proto->hasExtParameterInfos());
111 assert(paramInfos.size() <= prefixArgs);
112 assert(proto->getNumParams() + prefixArgs <= totalArgs);
113
114 paramInfos.reserve(totalArgs);
115
116 // Add default infos for any prefix args that don't already have infos.
117 paramInfos.resize(prefixArgs);
118
119 // Add infos for the prototype.
120 for (const auto &ParamInfo : proto->getExtParameterInfos()) {
121 paramInfos.push_back(ParamInfo);
122 // pass_object_size params have no parameter info.
123 if (ParamInfo.hasPassObjectSize())
124 paramInfos.emplace_back();
125 }
126
127 assert(paramInfos.size() <= totalArgs &&
128 "Did we forget to insert pass_object_size args?");
129 // Add default infos for the variadic and/or suffix arguments.
130 paramInfos.resize(totalArgs);
131}
132
Hiroshi Inouec5e54dd2017-07-03 08:49:44 +0000133/// Adds the formal parameters in FPT to the given prefix. If any parameter in
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000134/// FPT has pass_object_size attrs, then we'll add parameters for those, too.
135static void appendParameterTypes(const CodeGenTypes &CGT,
136 SmallVectorImpl<CanQualType> &prefix,
John McCallc56a8b32016-03-11 04:30:31 +0000137 SmallVectorImpl<FunctionProtoType::ExtParameterInfo> &paramInfos,
George Burgess IVb7760212017-02-24 02:49:47 +0000138 CanQual<FunctionProtoType> FPT) {
139 // Fast path: don't touch param info if we don't need to.
140 if (!FPT->hasExtParameterInfos()) {
141 assert(paramInfos.empty() &&
142 "We have paramInfos, but the prototype doesn't?");
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000143 prefix.append(FPT->param_type_begin(), FPT->param_type_end());
144 return;
145 }
146
George Burgess IVb7760212017-02-24 02:49:47 +0000147 unsigned PrefixSize = prefix.size();
148 // In the vast majority of cases, we'll have precisely FPT->getNumParams()
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000149 // parameters; the only thing that can change this is the presence of
150 // pass_object_size. So, we preallocate for the common case.
151 prefix.reserve(prefix.size() + FPT->getNumParams());
152
George Burgess IVb7760212017-02-24 02:49:47 +0000153 auto ExtInfos = FPT->getExtParameterInfos();
154 assert(ExtInfos.size() == FPT->getNumParams());
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000155 for (unsigned I = 0, E = FPT->getNumParams(); I != E; ++I) {
156 prefix.push_back(FPT->getParamType(I));
George Burgess IVb7760212017-02-24 02:49:47 +0000157 if (ExtInfos[I].hasPassObjectSize())
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000158 prefix.push_back(CGT.getContext().getSizeType());
159 }
George Burgess IVb7760212017-02-24 02:49:47 +0000160
161 addExtParameterInfosForCall(paramInfos, FPT.getTypePtr(), PrefixSize,
162 prefix.size());
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000163}
164
John McCall8dda7b22012-07-07 06:41:13 +0000165/// Arrange the LLVM function layout for a value of the given function
Alexey Samsonove5ef3ca2014-08-13 23:55:54 +0000166/// type, on top of any implicit parameters already stored.
167static const CGFunctionInfo &
Peter Collingbournef7706832014-12-12 23:41:25 +0000168arrangeLLVMFunctionInfo(CodeGenTypes &CGT, bool instanceMethod,
Alexey Samsonove5ef3ca2014-08-13 23:55:54 +0000169 SmallVectorImpl<CanQualType> &prefix,
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000170 CanQual<FunctionProtoType> FTP,
171 const FunctionDecl *FD) {
John McCallc56a8b32016-03-11 04:30:31 +0000172 SmallVector<FunctionProtoType::ExtParameterInfo, 16> paramInfos;
George Burgess IV419996c2016-06-16 23:06:04 +0000173 RequiredArgs Required =
174 RequiredArgs::forPrototypePlus(FTP, prefix.size(), FD);
Daniel Dunbarbf8c24a2009-02-02 23:23:47 +0000175 // FIXME: Kill copy.
George Burgess IVb7760212017-02-24 02:49:47 +0000176 appendParameterTypes(CGT, prefix, paramInfos, FTP);
Alp Toker314cc812014-01-25 16:55:45 +0000177 CanQualType resultType = FTP->getReturnType().getUnqualifiedType();
John McCallc56a8b32016-03-11 04:30:31 +0000178
Peter Collingbournef7706832014-12-12 23:41:25 +0000179 return CGT.arrangeLLVMFunctionInfo(resultType, instanceMethod,
180 /*chainCall=*/false, prefix,
John McCallc56a8b32016-03-11 04:30:31 +0000181 FTP->getExtInfo(), paramInfos,
George Burgess IV419996c2016-06-16 23:06:04 +0000182 Required);
John McCall8ee376f2010-02-24 07:14:12 +0000183}
184
John McCalla729c622012-02-17 03:33:10 +0000185/// Arrange the argument and result information for a value of the
John McCall8dda7b22012-07-07 06:41:13 +0000186/// given freestanding function type.
John McCall8ee376f2010-02-24 07:14:12 +0000187const CGFunctionInfo &
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000188CodeGenTypes::arrangeFreeFunctionType(CanQual<FunctionProtoType> FTP,
189 const FunctionDecl *FD) {
John McCalla729c622012-02-17 03:33:10 +0000190 SmallVector<CanQualType, 16> argTypes;
Peter Collingbournef7706832014-12-12 23:41:25 +0000191 return ::arrangeLLVMFunctionInfo(*this, /*instanceMethod=*/false, argTypes,
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000192 FTP, FD);
Daniel Dunbar7feafc72009-09-11 22:24:53 +0000193}
194
Aaron Ballman0362a6d2013-12-18 16:23:37 +0000195static CallingConv getCallingConventionForDecl(const Decl *D, bool IsWindows) {
Daniel Dunbar7feafc72009-09-11 22:24:53 +0000196 // Set the appropriate calling convention for the Function.
197 if (D->hasAttr<StdCallAttr>())
John McCallab26cfa2010-02-05 21:31:56 +0000198 return CC_X86StdCall;
Daniel Dunbar7feafc72009-09-11 22:24:53 +0000199
200 if (D->hasAttr<FastCallAttr>())
John McCallab26cfa2010-02-05 21:31:56 +0000201 return CC_X86FastCall;
Daniel Dunbar7feafc72009-09-11 22:24:53 +0000202
Erich Keane757d3172016-11-02 18:29:35 +0000203 if (D->hasAttr<RegCallAttr>())
204 return CC_X86RegCall;
205
Douglas Gregora941dca2010-05-18 16:57:00 +0000206 if (D->hasAttr<ThisCallAttr>())
207 return CC_X86ThisCall;
208
Reid Klecknerd7857f02014-10-24 17:42:17 +0000209 if (D->hasAttr<VectorCallAttr>())
210 return CC_X86VectorCall;
211
Dawn Perchik335e16b2010-09-03 01:29:35 +0000212 if (D->hasAttr<PascalAttr>())
213 return CC_X86Pascal;
214
Anton Korobeynikov231e8752011-04-14 20:06:49 +0000215 if (PcsAttr *PCS = D->getAttr<PcsAttr>())
216 return (PCS->getPCS() == PcsAttr::AAPCS ? CC_AAPCS : CC_AAPCS_VFP);
217
Sander de Smalen44a22532018-11-26 16:38:37 +0000218 if (D->hasAttr<AArch64VectorPcsAttr>())
219 return CC_AArch64VectorCall;
220
Guy Benyeif0a014b2012-12-25 08:53:55 +0000221 if (D->hasAttr<IntelOclBiccAttr>())
222 return CC_IntelOclBicc;
223
Aaron Ballman0362a6d2013-12-18 16:23:37 +0000224 if (D->hasAttr<MSABIAttr>())
Martin Storsjo022e7822017-07-17 20:49:45 +0000225 return IsWindows ? CC_C : CC_Win64;
Aaron Ballman0362a6d2013-12-18 16:23:37 +0000226
227 if (D->hasAttr<SysVABIAttr>())
228 return IsWindows ? CC_X86_64SysV : CC_C;
229
Roman Levenstein35aa5ce2016-03-16 18:00:46 +0000230 if (D->hasAttr<PreserveMostAttr>())
231 return CC_PreserveMost;
232
233 if (D->hasAttr<PreserveAllAttr>())
234 return CC_PreserveAll;
235
John McCallab26cfa2010-02-05 21:31:56 +0000236 return CC_C;
Daniel Dunbar7a95ca32008-09-10 04:01:49 +0000237}
238
John McCalla729c622012-02-17 03:33:10 +0000239/// Arrange the argument and result information for a call to an
240/// unknown C++ non-static member function of the given abstract type.
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000241/// (Zero value of RD means we don't have any meaningful "this" argument type,
242/// so fall back to a generic pointer type).
John McCalla729c622012-02-17 03:33:10 +0000243/// The member function must be an ordinary function, i.e. not a
244/// constructor or destructor.
245const CGFunctionInfo &
246CodeGenTypes::arrangeCXXMethodType(const CXXRecordDecl *RD,
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000247 const FunctionProtoType *FTP,
248 const CXXMethodDecl *MD) {
John McCalla729c622012-02-17 03:33:10 +0000249 SmallVector<CanQualType, 16> argTypes;
John McCall8ee376f2010-02-24 07:14:12 +0000250
Anders Carlsson2ee3c012009-10-03 19:43:08 +0000251 // Add the 'this' pointer.
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000252 if (RD)
Mikael Nilsson90646732018-12-12 15:06:16 +0000253 argTypes.push_back(GetThisType(Context, RD));
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000254 else
255 argTypes.push_back(Context.VoidPtrTy);
John McCall8ee376f2010-02-24 07:14:12 +0000256
Alexey Samsonove5ef3ca2014-08-13 23:55:54 +0000257 return ::arrangeLLVMFunctionInfo(
258 *this, true, argTypes,
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000259 FTP->getCanonicalTypeUnqualified().getAs<FunctionProtoType>(), MD);
Anders Carlsson2ee3c012009-10-03 19:43:08 +0000260}
261
Yaxun Liu6c10a662018-06-12 00:16:33 +0000262/// Set calling convention for CUDA/HIP kernel.
263static void setCUDAKernelCallingConvention(CanQualType &FTy, CodeGenModule &CGM,
264 const FunctionDecl *FD) {
265 if (FD->hasAttr<CUDAGlobalAttr>()) {
266 const FunctionType *FT = FTy->getAs<FunctionType>();
267 CGM.getTargetCodeGenInfo().setCUDAKernelCallingConvention(FT);
268 FTy = FT->getCanonicalTypeUnqualified();
269 }
270}
271
John McCalla729c622012-02-17 03:33:10 +0000272/// Arrange the argument and result information for a declaration or
273/// definition of the given C++ non-static member function. The
274/// member function must be an ordinary function, i.e. not a
275/// constructor or destructor.
276const CGFunctionInfo &
277CodeGenTypes::arrangeCXXMethodDeclaration(const CXXMethodDecl *MD) {
Benjamin Kramer60509af2013-09-09 14:48:42 +0000278 assert(!isa<CXXConstructorDecl>(MD) && "wrong method for constructors!");
John McCall0d635f52010-09-03 01:26:39 +0000279 assert(!isa<CXXDestructorDecl>(MD) && "wrong method for destructors!");
280
Yaxun Liu6c10a662018-06-12 00:16:33 +0000281 CanQualType FT = GetFormalType(MD).getAs<Type>();
282 setCUDAKernelCallingConvention(FT, CGM, MD);
283 auto prototype = FT.getAs<FunctionProtoType>();
Mike Stump11289f42009-09-09 15:08:12 +0000284
John McCalla729c622012-02-17 03:33:10 +0000285 if (MD->isInstance()) {
286 // The abstract case is perfectly fine.
Mark Lacey5ea993b2013-10-02 20:35:23 +0000287 const CXXRecordDecl *ThisType = TheCXXABI.getThisArgumentTypeForMethod(MD);
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000288 return arrangeCXXMethodType(ThisType, prototype.getTypePtr(), MD);
John McCalla729c622012-02-17 03:33:10 +0000289 }
290
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000291 return arrangeFreeFunctionType(prototype, MD);
Anders Carlssonb15b55c2009-04-03 22:48:58 +0000292}
293
Richard Smith5179eb72016-06-28 19:03:57 +0000294bool CodeGenTypes::inheritingCtorHasParams(
295 const InheritedConstructor &Inherited, CXXCtorType Type) {
296 // Parameters are unnecessary if we're constructing a base class subobject
297 // and the inherited constructor lives in a virtual base.
298 return Type == Ctor_Complete ||
299 !Inherited.getShadowDecl()->constructsVirtualBase() ||
300 !Target.getCXXABI().hasConstructorVariants();
301 }
302
John McCalla729c622012-02-17 03:33:10 +0000303const CGFunctionInfo &
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000304CodeGenTypes::arrangeCXXStructorDeclaration(const CXXMethodDecl *MD,
305 StructorType Type) {
306
John McCalla729c622012-02-17 03:33:10 +0000307 SmallVector<CanQualType, 16> argTypes;
John McCallc56a8b32016-03-11 04:30:31 +0000308 SmallVector<FunctionProtoType::ExtParameterInfo, 16> paramInfos;
Mikael Nilsson90646732018-12-12 15:06:16 +0000309 argTypes.push_back(GetThisType(Context, MD->getParent()));
Stephen Lin9dc6eef2013-06-30 20:40:16 +0000310
Richard Smith5179eb72016-06-28 19:03:57 +0000311 bool PassParams = true;
312
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000313 GlobalDecl GD;
314 if (auto *CD = dyn_cast<CXXConstructorDecl>(MD)) {
315 GD = GlobalDecl(CD, toCXXCtorType(Type));
Richard Smith5179eb72016-06-28 19:03:57 +0000316
317 // A base class inheriting constructor doesn't get forwarded arguments
318 // needed to construct a virtual base (or base class thereof).
319 if (auto Inherited = CD->getInheritedConstructor())
320 PassParams = inheritingCtorHasParams(Inherited, toCXXCtorType(Type));
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000321 } else {
322 auto *DD = dyn_cast<CXXDestructorDecl>(MD);
323 GD = GlobalDecl(DD, toCXXDtorType(Type));
324 }
Anders Carlsson82ba57c2009-11-25 03:15:49 +0000325
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000326 CanQual<FunctionProtoType> FTP = GetFormalType(MD);
John McCall5d865c322010-08-31 07:33:07 +0000327
328 // Add the formal parameters.
Richard Smith5179eb72016-06-28 19:03:57 +0000329 if (PassParams)
George Burgess IVb7760212017-02-24 02:49:47 +0000330 appendParameterTypes(*this, argTypes, paramInfos, FTP);
John McCall5d865c322010-08-31 07:33:07 +0000331
George Burgess IV75b34a92017-02-22 22:38:25 +0000332 CGCXXABI::AddedStructorArgs AddedArgs =
333 TheCXXABI.buildStructorSignature(MD, Type, argTypes);
334 if (!paramInfos.empty()) {
335 // Note: prefix implies after the first param.
336 if (AddedArgs.Prefix)
337 paramInfos.insert(paramInfos.begin() + 1, AddedArgs.Prefix,
338 FunctionProtoType::ExtParameterInfo{});
339 if (AddedArgs.Suffix)
340 paramInfos.append(AddedArgs.Suffix,
341 FunctionProtoType::ExtParameterInfo{});
342 }
Reid Kleckner89077a12013-12-17 19:46:40 +0000343
344 RequiredArgs required =
Richard Smith5179eb72016-06-28 19:03:57 +0000345 (PassParams && MD->isVariadic() ? RequiredArgs(argTypes.size())
346 : RequiredArgs::All);
Reid Kleckner89077a12013-12-17 19:46:40 +0000347
John McCall8dda7b22012-07-07 06:41:13 +0000348 FunctionType::ExtInfo extInfo = FTP->getExtInfo();
David Majnemer0c0b6d92014-10-31 20:09:12 +0000349 CanQualType resultType = TheCXXABI.HasThisReturn(GD)
350 ? argTypes.front()
351 : TheCXXABI.hasMostDerivedReturn(GD)
352 ? CGM.getContext().VoidPtrTy
353 : Context.VoidTy;
Peter Collingbournef7706832014-12-12 23:41:25 +0000354 return arrangeLLVMFunctionInfo(resultType, /*instanceMethod=*/true,
355 /*chainCall=*/false, argTypes, extInfo,
John McCallc56a8b32016-03-11 04:30:31 +0000356 paramInfos, required);
357}
358
359static SmallVector<CanQualType, 16>
360getArgTypesForCall(ASTContext &ctx, const CallArgList &args) {
361 SmallVector<CanQualType, 16> argTypes;
362 for (auto &arg : args)
363 argTypes.push_back(ctx.getCanonicalParamType(arg.Ty));
364 return argTypes;
365}
366
367static SmallVector<CanQualType, 16>
368getArgTypesForDeclaration(ASTContext &ctx, const FunctionArgList &args) {
369 SmallVector<CanQualType, 16> argTypes;
370 for (auto &arg : args)
371 argTypes.push_back(ctx.getCanonicalParamType(arg->getType()));
372 return argTypes;
373}
374
John McCallc56a8b32016-03-11 04:30:31 +0000375static llvm::SmallVector<FunctionProtoType::ExtParameterInfo, 16>
376getExtParameterInfosForCall(const FunctionProtoType *proto,
377 unsigned prefixArgs, unsigned totalArgs) {
378 llvm::SmallVector<FunctionProtoType::ExtParameterInfo, 16> result;
379 if (proto->hasExtParameterInfos()) {
380 addExtParameterInfosForCall(result, proto, prefixArgs, totalArgs);
381 }
382 return result;
Anders Carlsson82ba57c2009-11-25 03:15:49 +0000383}
384
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000385/// Arrange a call to a C++ method, passing the given arguments.
George Burgess IVd0a9e802017-02-23 22:07:35 +0000386///
387/// ExtraPrefixArgs is the number of ABI-specific args passed after the `this`
388/// parameter.
389/// ExtraSuffixArgs is the number of ABI-specific args passed at the end of
390/// args.
391/// PassProtoArgs indicates whether `args` has args for the parameters in the
392/// given CXXConstructorDecl.
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000393const CGFunctionInfo &
394CodeGenTypes::arrangeCXXConstructorCall(const CallArgList &args,
395 const CXXConstructorDecl *D,
396 CXXCtorType CtorKind,
George Burgess IVd0a9e802017-02-23 22:07:35 +0000397 unsigned ExtraPrefixArgs,
398 unsigned ExtraSuffixArgs,
399 bool PassProtoArgs) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000400 // FIXME: Kill copy.
401 SmallVector<CanQualType, 16> ArgTypes;
Alexey Samsonov3551e312014-08-13 20:06:24 +0000402 for (const auto &Arg : args)
403 ArgTypes.push_back(Context.getCanonicalParamType(Arg.Ty));
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000404
George Burgess IVd0a9e802017-02-23 22:07:35 +0000405 // +1 for implicit this, which should always be args[0].
406 unsigned TotalPrefixArgs = 1 + ExtraPrefixArgs;
407
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000408 CanQual<FunctionProtoType> FPT = GetFormalType(D);
George Burgess IVd0a9e802017-02-23 22:07:35 +0000409 RequiredArgs Required =
410 RequiredArgs::forPrototypePlus(FPT, TotalPrefixArgs + ExtraSuffixArgs, D);
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000411 GlobalDecl GD(D, CtorKind);
David Majnemer0c0b6d92014-10-31 20:09:12 +0000412 CanQualType ResultType = TheCXXABI.HasThisReturn(GD)
413 ? ArgTypes.front()
414 : TheCXXABI.hasMostDerivedReturn(GD)
415 ? CGM.getContext().VoidPtrTy
416 : Context.VoidTy;
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000417
418 FunctionType::ExtInfo Info = FPT->getExtInfo();
George Burgess IVd0a9e802017-02-23 22:07:35 +0000419 llvm::SmallVector<FunctionProtoType::ExtParameterInfo, 16> ParamInfos;
420 // If the prototype args are elided, we should only have ABI-specific args,
421 // which never have param info.
422 if (PassProtoArgs && FPT->hasExtParameterInfos()) {
423 // ABI-specific suffix arguments are treated the same as variadic arguments.
424 addExtParameterInfosForCall(ParamInfos, FPT.getTypePtr(), TotalPrefixArgs,
425 ArgTypes.size());
426 }
Peter Collingbournef7706832014-12-12 23:41:25 +0000427 return arrangeLLVMFunctionInfo(ResultType, /*instanceMethod=*/true,
428 /*chainCall=*/false, ArgTypes, Info,
John McCallc56a8b32016-03-11 04:30:31 +0000429 ParamInfos, Required);
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000430}
431
John McCalla729c622012-02-17 03:33:10 +0000432/// Arrange the argument and result information for the declaration or
433/// definition of the given function.
434const CGFunctionInfo &
435CodeGenTypes::arrangeFunctionDeclaration(const FunctionDecl *FD) {
Chris Lattnerbea5b622009-05-12 20:27:19 +0000436 if (const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(FD))
Anders Carlssonb15b55c2009-04-03 22:48:58 +0000437 if (MD->isInstance())
John McCalla729c622012-02-17 03:33:10 +0000438 return arrangeCXXMethodDeclaration(MD);
Mike Stump11289f42009-09-09 15:08:12 +0000439
John McCall2da83a32010-02-26 00:48:12 +0000440 CanQualType FTy = FD->getType()->getCanonicalTypeUnqualified();
John McCalla729c622012-02-17 03:33:10 +0000441
John McCall2da83a32010-02-26 00:48:12 +0000442 assert(isa<FunctionType>(FTy));
Yaxun Liu6c10a662018-06-12 00:16:33 +0000443 setCUDAKernelCallingConvention(FTy, CGM, FD);
John McCalla729c622012-02-17 03:33:10 +0000444
445 // When declaring a function without a prototype, always use a
446 // non-variadic type.
George Burgess IV35cfca22017-01-06 19:10:48 +0000447 if (CanQual<FunctionNoProtoType> noProto = FTy.getAs<FunctionNoProtoType>()) {
Peter Collingbournef7706832014-12-12 23:41:25 +0000448 return arrangeLLVMFunctionInfo(
449 noProto->getReturnType(), /*instanceMethod=*/false,
John McCallc56a8b32016-03-11 04:30:31 +0000450 /*chainCall=*/false, None, noProto->getExtInfo(), {},RequiredArgs::All);
John McCalla729c622012-02-17 03:33:10 +0000451 }
452
George Burgess IV35cfca22017-01-06 19:10:48 +0000453 return arrangeFreeFunctionType(FTy.castAs<FunctionProtoType>(), FD);
Daniel Dunbar3d7c90b2008-09-08 21:33:45 +0000454}
455
John McCalla729c622012-02-17 03:33:10 +0000456/// Arrange the argument and result information for the declaration or
457/// definition of an Objective-C method.
458const CGFunctionInfo &
459CodeGenTypes::arrangeObjCMethodDeclaration(const ObjCMethodDecl *MD) {
460 // It happens that this is the same as a call with no optional
461 // arguments, except also using the formal 'self' type.
462 return arrangeObjCMessageSendSignature(MD, MD->getSelfDecl()->getType());
463}
464
465/// Arrange the argument and result information for the function type
466/// through which to perform a send to the given Objective-C method,
467/// using the given receiver type. The receiver type is not always
468/// the 'self' type of the method or even an Objective-C pointer type.
469/// This is *not* the right method for actually performing such a
470/// message send, due to the possibility of optional arguments.
471const CGFunctionInfo &
472CodeGenTypes::arrangeObjCMessageSendSignature(const ObjCMethodDecl *MD,
473 QualType receiverType) {
474 SmallVector<CanQualType, 16> argTys;
Akira Hatanaka98a49332017-09-22 00:41:05 +0000475 SmallVector<FunctionProtoType::ExtParameterInfo, 4> extParamInfos(2);
John McCalla729c622012-02-17 03:33:10 +0000476 argTys.push_back(Context.getCanonicalParamType(receiverType));
477 argTys.push_back(Context.getCanonicalParamType(Context.getObjCSelType()));
Daniel Dunbarbf8c24a2009-02-02 23:23:47 +0000478 // FIXME: Kill copy?
David Majnemer59f77922016-06-24 04:05:48 +0000479 for (const auto *I : MD->parameters()) {
Aaron Ballman43b68be2014-03-07 17:50:17 +0000480 argTys.push_back(Context.getCanonicalParamType(I->getType()));
Akira Hatanaka98a49332017-09-22 00:41:05 +0000481 auto extParamInfo = FunctionProtoType::ExtParameterInfo().withIsNoEscape(
482 I->hasAttr<NoEscapeAttr>());
483 extParamInfos.push_back(extParamInfo);
John McCall8ee376f2010-02-24 07:14:12 +0000484 }
John McCall31168b02011-06-15 23:02:42 +0000485
486 FunctionType::ExtInfo einfo;
Aaron Ballman0362a6d2013-12-18 16:23:37 +0000487 bool IsWindows = getContext().getTargetInfo().getTriple().isOSWindows();
488 einfo = einfo.withCallingConv(getCallingConventionForDecl(MD, IsWindows));
John McCall31168b02011-06-15 23:02:42 +0000489
David Blaikiebbafb8a2012-03-11 07:00:24 +0000490 if (getContext().getLangOpts().ObjCAutoRefCount &&
John McCall31168b02011-06-15 23:02:42 +0000491 MD->hasAttr<NSReturnsRetainedAttr>())
492 einfo = einfo.withProducesResult(true);
493
John McCalla729c622012-02-17 03:33:10 +0000494 RequiredArgs required =
495 (MD->isVariadic() ? RequiredArgs(argTys.size()) : RequiredArgs::All);
496
Peter Collingbournef7706832014-12-12 23:41:25 +0000497 return arrangeLLVMFunctionInfo(
498 GetReturnType(MD->getReturnType()), /*instanceMethod=*/false,
Akira Hatanaka98a49332017-09-22 00:41:05 +0000499 /*chainCall=*/false, argTys, einfo, extParamInfos, required);
John McCallc56a8b32016-03-11 04:30:31 +0000500}
501
502const CGFunctionInfo &
503CodeGenTypes::arrangeUnprototypedObjCMessageSend(QualType returnType,
504 const CallArgList &args) {
505 auto argTypes = getArgTypesForCall(Context, args);
506 FunctionType::ExtInfo einfo;
507
508 return arrangeLLVMFunctionInfo(
509 GetReturnType(returnType), /*instanceMethod=*/false,
510 /*chainCall=*/false, argTypes, einfo, {}, RequiredArgs::All);
Daniel Dunbar3d7c90b2008-09-08 21:33:45 +0000511}
512
John McCalla729c622012-02-17 03:33:10 +0000513const CGFunctionInfo &
514CodeGenTypes::arrangeGlobalDeclaration(GlobalDecl GD) {
Anders Carlsson6710c532010-02-06 02:44:09 +0000515 // FIXME: Do we need to handle ObjCMethodDecl?
516 const FunctionDecl *FD = cast<FunctionDecl>(GD.getDecl());
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000517
Anders Carlsson6710c532010-02-06 02:44:09 +0000518 if (const CXXConstructorDecl *CD = dyn_cast<CXXConstructorDecl>(FD))
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000519 return arrangeCXXStructorDeclaration(CD, getFromCtorType(GD.getCtorType()));
Anders Carlsson6710c532010-02-06 02:44:09 +0000520
521 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(FD))
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000522 return arrangeCXXStructorDeclaration(DD, getFromDtorType(GD.getDtorType()));
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000523
John McCalla729c622012-02-17 03:33:10 +0000524 return arrangeFunctionDeclaration(FD);
Anders Carlsson6710c532010-02-06 02:44:09 +0000525}
526
Reid Klecknerc3473512014-08-29 21:43:29 +0000527/// Arrange a thunk that takes 'this' as the first parameter followed by
528/// varargs. Return a void pointer, regardless of the actual return type.
529/// The body of the thunk will end in a musttail call to a function of the
530/// correct type, and the caller will bitcast the function to the correct
531/// prototype.
532const CGFunctionInfo &
Reid Kleckner399d96e2018-04-02 20:20:33 +0000533CodeGenTypes::arrangeUnprototypedMustTailThunk(const CXXMethodDecl *MD) {
534 assert(MD->isVirtual() && "only methods have thunks");
Reid Klecknerc3473512014-08-29 21:43:29 +0000535 CanQual<FunctionProtoType> FTP = GetFormalType(MD);
Mikael Nilsson90646732018-12-12 15:06:16 +0000536 CanQualType ArgTys[] = { GetThisType(Context, MD->getParent()) };
Peter Collingbournef7706832014-12-12 23:41:25 +0000537 return arrangeLLVMFunctionInfo(Context.VoidTy, /*instanceMethod=*/false,
538 /*chainCall=*/false, ArgTys,
John McCallc56a8b32016-03-11 04:30:31 +0000539 FTP->getExtInfo(), {}, RequiredArgs(1));
Reid Klecknerc3473512014-08-29 21:43:29 +0000540}
541
David Majnemerdfa6d202015-03-11 18:36:39 +0000542const CGFunctionInfo &
David Majnemer37fd66e2015-03-13 22:36:55 +0000543CodeGenTypes::arrangeMSCtorClosure(const CXXConstructorDecl *CD,
544 CXXCtorType CT) {
545 assert(CT == Ctor_CopyingClosure || CT == Ctor_DefaultClosure);
546
David Majnemerdfa6d202015-03-11 18:36:39 +0000547 CanQual<FunctionProtoType> FTP = GetFormalType(CD);
548 SmallVector<CanQualType, 2> ArgTys;
549 const CXXRecordDecl *RD = CD->getParent();
Mikael Nilsson90646732018-12-12 15:06:16 +0000550 ArgTys.push_back(GetThisType(Context, RD));
David Majnemer37fd66e2015-03-13 22:36:55 +0000551 if (CT == Ctor_CopyingClosure)
552 ArgTys.push_back(*FTP->param_type_begin());
David Majnemerdfa6d202015-03-11 18:36:39 +0000553 if (RD->getNumVBases() > 0)
554 ArgTys.push_back(Context.IntTy);
555 CallingConv CC = Context.getDefaultCallingConvention(
556 /*IsVariadic=*/false, /*IsCXXMethod=*/true);
557 return arrangeLLVMFunctionInfo(Context.VoidTy, /*instanceMethod=*/true,
558 /*chainCall=*/false, ArgTys,
John McCallc56a8b32016-03-11 04:30:31 +0000559 FunctionType::ExtInfo(CC), {},
560 RequiredArgs::All);
David Majnemerdfa6d202015-03-11 18:36:39 +0000561}
562
John McCallc818bbb2012-12-07 07:03:17 +0000563/// Arrange a call as unto a free function, except possibly with an
564/// additional number of formal parameters considered required.
565static const CGFunctionInfo &
566arrangeFreeFunctionLikeCall(CodeGenTypes &CGT,
Mark Lacey23455752013-10-10 20:57:00 +0000567 CodeGenModule &CGM,
John McCallc818bbb2012-12-07 07:03:17 +0000568 const CallArgList &args,
569 const FunctionType *fnType,
Peter Collingbournef7706832014-12-12 23:41:25 +0000570 unsigned numExtraRequiredArgs,
571 bool chainCall) {
John McCallc818bbb2012-12-07 07:03:17 +0000572 assert(args.size() >= numExtraRequiredArgs);
573
John McCallc56a8b32016-03-11 04:30:31 +0000574 llvm::SmallVector<FunctionProtoType::ExtParameterInfo, 16> paramInfos;
575
John McCallc818bbb2012-12-07 07:03:17 +0000576 // In most cases, there are no optional arguments.
577 RequiredArgs required = RequiredArgs::All;
578
579 // If we have a variadic prototype, the required arguments are the
580 // extra prefix plus the arguments in the prototype.
581 if (const FunctionProtoType *proto = dyn_cast<FunctionProtoType>(fnType)) {
582 if (proto->isVariadic())
Alp Toker9cacbab2014-01-20 20:26:09 +0000583 required = RequiredArgs(proto->getNumParams() + numExtraRequiredArgs);
John McCallc818bbb2012-12-07 07:03:17 +0000584
John McCallc56a8b32016-03-11 04:30:31 +0000585 if (proto->hasExtParameterInfos())
586 addExtParameterInfosForCall(paramInfos, proto, numExtraRequiredArgs,
587 args.size());
588
John McCallc818bbb2012-12-07 07:03:17 +0000589 // If we don't have a prototype at all, but we're supposed to
590 // explicitly use the variadic convention for unprototyped calls,
591 // treat all of the arguments as required but preserve the nominal
592 // possibility of variadics.
Mark Lacey23455752013-10-10 20:57:00 +0000593 } else if (CGM.getTargetCodeGenInfo()
594 .isNoProtoCallVariadic(args,
595 cast<FunctionNoProtoType>(fnType))) {
John McCallc818bbb2012-12-07 07:03:17 +0000596 required = RequiredArgs(args.size());
597 }
598
Peter Collingbournef7706832014-12-12 23:41:25 +0000599 // FIXME: Kill copy.
600 SmallVector<CanQualType, 16> argTypes;
601 for (const auto &arg : args)
602 argTypes.push_back(CGT.getContext().getCanonicalParamType(arg.Ty));
603 return CGT.arrangeLLVMFunctionInfo(GetReturnType(fnType->getReturnType()),
604 /*instanceMethod=*/false, chainCall,
John McCallc56a8b32016-03-11 04:30:31 +0000605 argTypes, fnType->getExtInfo(), paramInfos,
606 required);
John McCallc818bbb2012-12-07 07:03:17 +0000607}
608
John McCalla729c622012-02-17 03:33:10 +0000609/// Figure out the rules for calling a function with the given formal
610/// type using the given arguments. The arguments are necessary
611/// because the function might be unprototyped, in which case it's
612/// target-dependent in crazy ways.
613const CGFunctionInfo &
John McCall8dda7b22012-07-07 06:41:13 +0000614CodeGenTypes::arrangeFreeFunctionCall(const CallArgList &args,
Peter Collingbournef7706832014-12-12 23:41:25 +0000615 const FunctionType *fnType,
616 bool chainCall) {
617 return arrangeFreeFunctionLikeCall(*this, CGM, args, fnType,
618 chainCall ? 1 : 0, chainCall);
John McCallc818bbb2012-12-07 07:03:17 +0000619}
John McCalla729c622012-02-17 03:33:10 +0000620
John McCallc56a8b32016-03-11 04:30:31 +0000621/// A block function is essentially a free function with an
John McCallc818bbb2012-12-07 07:03:17 +0000622/// extra implicit argument.
623const CGFunctionInfo &
624CodeGenTypes::arrangeBlockFunctionCall(const CallArgList &args,
625 const FunctionType *fnType) {
Peter Collingbournef7706832014-12-12 23:41:25 +0000626 return arrangeFreeFunctionLikeCall(*this, CGM, args, fnType, 1,
627 /*chainCall=*/false);
John McCalla729c622012-02-17 03:33:10 +0000628}
629
630const CGFunctionInfo &
John McCallc56a8b32016-03-11 04:30:31 +0000631CodeGenTypes::arrangeBlockFunctionDeclaration(const FunctionProtoType *proto,
632 const FunctionArgList &params) {
633 auto paramInfos = getExtParameterInfosForCall(proto, 1, params.size());
634 auto argTypes = getArgTypesForDeclaration(Context, params);
635
George Burgess IV419996c2016-06-16 23:06:04 +0000636 return arrangeLLVMFunctionInfo(
637 GetReturnType(proto->getReturnType()),
638 /*instanceMethod*/ false, /*chainCall*/ false, argTypes,
639 proto->getExtInfo(), paramInfos,
640 RequiredArgs::forPrototypePlus(proto, 1, nullptr));
John McCallc56a8b32016-03-11 04:30:31 +0000641}
642
643const CGFunctionInfo &
644CodeGenTypes::arrangeBuiltinFunctionCall(QualType resultType,
645 const CallArgList &args) {
Daniel Dunbarbf8c24a2009-02-02 23:23:47 +0000646 // FIXME: Kill copy.
John McCalla729c622012-02-17 03:33:10 +0000647 SmallVector<CanQualType, 16> argTypes;
Alexey Samsonov3551e312014-08-13 20:06:24 +0000648 for (const auto &Arg : args)
649 argTypes.push_back(Context.getCanonicalParamType(Arg.Ty));
Peter Collingbournef7706832014-12-12 23:41:25 +0000650 return arrangeLLVMFunctionInfo(
651 GetReturnType(resultType), /*instanceMethod=*/false,
John McCallc56a8b32016-03-11 04:30:31 +0000652 /*chainCall=*/false, argTypes, FunctionType::ExtInfo(),
653 /*paramInfos=*/ {}, RequiredArgs::All);
John McCall8dda7b22012-07-07 06:41:13 +0000654}
655
John McCallc56a8b32016-03-11 04:30:31 +0000656const CGFunctionInfo &
657CodeGenTypes::arrangeBuiltinFunctionDeclaration(QualType resultType,
658 const FunctionArgList &args) {
659 auto argTypes = getArgTypesForDeclaration(Context, args);
660
661 return arrangeLLVMFunctionInfo(
662 GetReturnType(resultType), /*instanceMethod=*/false, /*chainCall=*/false,
663 argTypes, FunctionType::ExtInfo(), {}, RequiredArgs::All);
664}
665
666const CGFunctionInfo &
667CodeGenTypes::arrangeBuiltinFunctionDeclaration(CanQualType resultType,
668 ArrayRef<CanQualType> argTypes) {
669 return arrangeLLVMFunctionInfo(
670 resultType, /*instanceMethod=*/false, /*chainCall=*/false,
671 argTypes, FunctionType::ExtInfo(), {}, RequiredArgs::All);
672}
673
John McCall8dda7b22012-07-07 06:41:13 +0000674/// Arrange a call to a C++ method, passing the given arguments.
George Burgess IVd0a9e802017-02-23 22:07:35 +0000675///
676/// numPrefixArgs is the number of ABI-specific prefix arguments we have. It
677/// does not count `this`.
John McCall8dda7b22012-07-07 06:41:13 +0000678const CGFunctionInfo &
679CodeGenTypes::arrangeCXXMethodCall(const CallArgList &args,
John McCallc56a8b32016-03-11 04:30:31 +0000680 const FunctionProtoType *proto,
George Burgess IVd0a9e802017-02-23 22:07:35 +0000681 RequiredArgs required,
682 unsigned numPrefixArgs) {
683 assert(numPrefixArgs + 1 <= args.size() &&
684 "Emitting a call with less args than the required prefix?");
685 // Add one to account for `this`. It's a bit awkward here, but we don't count
686 // `this` in similar places elsewhere.
John McCallc56a8b32016-03-11 04:30:31 +0000687 auto paramInfos =
George Burgess IVd0a9e802017-02-23 22:07:35 +0000688 getExtParameterInfosForCall(proto, numPrefixArgs + 1, args.size());
John McCallc56a8b32016-03-11 04:30:31 +0000689
John McCall8dda7b22012-07-07 06:41:13 +0000690 // FIXME: Kill copy.
John McCallc56a8b32016-03-11 04:30:31 +0000691 auto argTypes = getArgTypesForCall(Context, args);
John McCall8dda7b22012-07-07 06:41:13 +0000692
John McCallc56a8b32016-03-11 04:30:31 +0000693 FunctionType::ExtInfo info = proto->getExtInfo();
Peter Collingbournef7706832014-12-12 23:41:25 +0000694 return arrangeLLVMFunctionInfo(
John McCallc56a8b32016-03-11 04:30:31 +0000695 GetReturnType(proto->getReturnType()), /*instanceMethod=*/true,
696 /*chainCall=*/false, argTypes, info, paramInfos, required);
Daniel Dunbarbf8c24a2009-02-02 23:23:47 +0000697}
698
John McCalla729c622012-02-17 03:33:10 +0000699const CGFunctionInfo &CodeGenTypes::arrangeNullaryFunction() {
Peter Collingbournef7706832014-12-12 23:41:25 +0000700 return arrangeLLVMFunctionInfo(
701 getContext().VoidTy, /*instanceMethod=*/false, /*chainCall=*/false,
John McCallc56a8b32016-03-11 04:30:31 +0000702 None, FunctionType::ExtInfo(), {}, RequiredArgs::All);
703}
704
705const CGFunctionInfo &
706CodeGenTypes::arrangeCall(const CGFunctionInfo &signature,
707 const CallArgList &args) {
708 assert(signature.arg_size() <= args.size());
709 if (signature.arg_size() == args.size())
710 return signature;
711
712 SmallVector<FunctionProtoType::ExtParameterInfo, 16> paramInfos;
713 auto sigParamInfos = signature.getExtParameterInfos();
714 if (!sigParamInfos.empty()) {
715 paramInfos.append(sigParamInfos.begin(), sigParamInfos.end());
716 paramInfos.resize(args.size());
717 }
718
719 auto argTypes = getArgTypesForCall(Context, args);
720
721 assert(signature.getRequiredArgs().allowsOptionalArgs());
722 return arrangeLLVMFunctionInfo(signature.getReturnType(),
723 signature.isInstanceMethod(),
724 signature.isChainCall(),
725 argTypes,
726 signature.getExtInfo(),
727 paramInfos,
728 signature.getRequiredArgs());
John McCalla738c252011-03-09 04:27:21 +0000729}
730
Pekka Jaaskelainenfc2629a2017-06-01 07:18:49 +0000731namespace clang {
732namespace CodeGen {
733void computeSPIRKernelABIInfo(CodeGenModule &CGM, CGFunctionInfo &FI);
734}
735}
736
John McCalla729c622012-02-17 03:33:10 +0000737/// Arrange the argument and result information for an abstract value
738/// of a given function type. This is the method which all of the
739/// above functions ultimately defer to.
740const CGFunctionInfo &
John McCall8dda7b22012-07-07 06:41:13 +0000741CodeGenTypes::arrangeLLVMFunctionInfo(CanQualType resultType,
Peter Collingbournef7706832014-12-12 23:41:25 +0000742 bool instanceMethod,
743 bool chainCall,
John McCall8dda7b22012-07-07 06:41:13 +0000744 ArrayRef<CanQualType> argTypes,
745 FunctionType::ExtInfo info,
John McCallc56a8b32016-03-11 04:30:31 +0000746 ArrayRef<FunctionProtoType::ExtParameterInfo> paramInfos,
John McCall8dda7b22012-07-07 06:41:13 +0000747 RequiredArgs required) {
Fangrui Song3117b172018-10-20 17:53:42 +0000748 assert(llvm::all_of(argTypes,
749 [](CanQualType T) { return T.isCanonicalAsParam(); }));
John McCall2da83a32010-02-26 00:48:12 +0000750
Daniel Dunbare0be8292009-02-03 00:07:12 +0000751 // Lookup or create unique function info.
752 llvm::FoldingSetNodeID ID;
John McCallc56a8b32016-03-11 04:30:31 +0000753 CGFunctionInfo::Profile(ID, instanceMethod, chainCall, info, paramInfos,
754 required, resultType, argTypes);
Daniel Dunbare0be8292009-02-03 00:07:12 +0000755
Craig Topper8a13c412014-05-21 05:09:00 +0000756 void *insertPos = nullptr;
John McCalla729c622012-02-17 03:33:10 +0000757 CGFunctionInfo *FI = FunctionInfos.FindNodeOrInsertPos(ID, insertPos);
Daniel Dunbare0be8292009-02-03 00:07:12 +0000758 if (FI)
759 return *FI;
760
John McCallc56a8b32016-03-11 04:30:31 +0000761 unsigned CC = ClangCallConvToLLVMCallConv(info.getCC());
762
John McCalla729c622012-02-17 03:33:10 +0000763 // Construct the function info. We co-allocate the ArgInfos.
Peter Collingbournef7706832014-12-12 23:41:25 +0000764 FI = CGFunctionInfo::create(CC, instanceMethod, chainCall, info,
John McCallc56a8b32016-03-11 04:30:31 +0000765 paramInfos, resultType, argTypes, required);
John McCalla729c622012-02-17 03:33:10 +0000766 FunctionInfos.InsertNode(FI, insertPos);
Daniel Dunbar313321e2009-02-03 05:31:23 +0000767
David Blaikie82e95a32014-11-19 07:49:47 +0000768 bool inserted = FunctionsBeingProcessed.insert(FI).second;
769 (void)inserted;
John McCalla729c622012-02-17 03:33:10 +0000770 assert(inserted && "Recursively being processed?");
Pekka Jaaskelainenfc2629a2017-06-01 07:18:49 +0000771
Daniel Dunbar313321e2009-02-03 05:31:23 +0000772 // Compute ABI information.
Pekka Jaaskelainenfc2629a2017-06-01 07:18:49 +0000773 if (CC == llvm::CallingConv::SPIR_KERNEL) {
774 // Force target independent argument handling for the host visible
775 // kernel functions.
776 computeSPIRKernelABIInfo(CGM, *FI);
777 } else if (info.getCC() == CC_Swift) {
John McCall12f23522016-04-04 18:33:08 +0000778 swiftcall::computeABIInfo(CGM, *FI);
Pekka Jaaskelainenfc2629a2017-06-01 07:18:49 +0000779 } else {
780 getABIInfo().computeInfo(*FI);
John McCall12f23522016-04-04 18:33:08 +0000781 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000782
Chris Lattnerfe34c1d2010-07-29 06:26:06 +0000783 // Loop over all of the computed argument and return value info. If any of
784 // them are direct or extend without a specified coerce type, specify the
785 // default now.
John McCalla729c622012-02-17 03:33:10 +0000786 ABIArgInfo &retInfo = FI->getReturnInfo();
Craig Topper8a13c412014-05-21 05:09:00 +0000787 if (retInfo.canHaveCoerceToType() && retInfo.getCoerceToType() == nullptr)
John McCalla729c622012-02-17 03:33:10 +0000788 retInfo.setCoerceToType(ConvertType(FI->getReturnType()));
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000789
Aaron Ballmanec47bc22014-03-17 18:10:01 +0000790 for (auto &I : FI->arguments())
Craig Topper8a13c412014-05-21 05:09:00 +0000791 if (I.info.canHaveCoerceToType() && I.info.getCoerceToType() == nullptr)
Aaron Ballmanec47bc22014-03-17 18:10:01 +0000792 I.info.setCoerceToType(ConvertType(I.type));
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000793
John McCalla729c622012-02-17 03:33:10 +0000794 bool erased = FunctionsBeingProcessed.erase(FI); (void)erased;
795 assert(erased && "Not in set?");
Fangrui Song6907ce22018-07-30 19:24:48 +0000796
Daniel Dunbare0be8292009-02-03 00:07:12 +0000797 return *FI;
Daniel Dunbarbf8c24a2009-02-02 23:23:47 +0000798}
799
John McCalla729c622012-02-17 03:33:10 +0000800CGFunctionInfo *CGFunctionInfo::create(unsigned llvmCC,
Peter Collingbournef7706832014-12-12 23:41:25 +0000801 bool instanceMethod,
802 bool chainCall,
John McCalla729c622012-02-17 03:33:10 +0000803 const FunctionType::ExtInfo &info,
John McCallc56a8b32016-03-11 04:30:31 +0000804 ArrayRef<ExtParameterInfo> paramInfos,
John McCalla729c622012-02-17 03:33:10 +0000805 CanQualType resultType,
806 ArrayRef<CanQualType> argTypes,
807 RequiredArgs required) {
John McCallc56a8b32016-03-11 04:30:31 +0000808 assert(paramInfos.empty() || paramInfos.size() == argTypes.size());
809
810 void *buffer =
811 operator new(totalSizeToAlloc<ArgInfo, ExtParameterInfo>(
812 argTypes.size() + 1, paramInfos.size()));
813
John McCalla729c622012-02-17 03:33:10 +0000814 CGFunctionInfo *FI = new(buffer) CGFunctionInfo();
815 FI->CallingConvention = llvmCC;
816 FI->EffectiveCallingConvention = llvmCC;
817 FI->ASTCallingConvention = info.getCC();
Peter Collingbournef7706832014-12-12 23:41:25 +0000818 FI->InstanceMethod = instanceMethod;
819 FI->ChainCall = chainCall;
John McCalla729c622012-02-17 03:33:10 +0000820 FI->NoReturn = info.getNoReturn();
821 FI->ReturnsRetained = info.getProducesResult();
Oren Ben Simhon318a6ea2017-04-27 12:01:00 +0000822 FI->NoCallerSavedRegs = info.getNoCallerSavedRegs();
Oren Ben Simhon220671a2018-03-17 13:31:35 +0000823 FI->NoCfCheck = info.getNoCfCheck();
John McCalla729c622012-02-17 03:33:10 +0000824 FI->Required = required;
825 FI->HasRegParm = info.getHasRegParm();
826 FI->RegParm = info.getRegParm();
Craig Topper8a13c412014-05-21 05:09:00 +0000827 FI->ArgStruct = nullptr;
John McCall7f416cc2015-09-08 08:05:57 +0000828 FI->ArgStructAlign = 0;
John McCalla729c622012-02-17 03:33:10 +0000829 FI->NumArgs = argTypes.size();
John McCallc56a8b32016-03-11 04:30:31 +0000830 FI->HasExtParameterInfos = !paramInfos.empty();
John McCalla729c622012-02-17 03:33:10 +0000831 FI->getArgsBuffer()[0].type = resultType;
832 for (unsigned i = 0, e = argTypes.size(); i != e; ++i)
833 FI->getArgsBuffer()[i + 1].type = argTypes[i];
John McCallc56a8b32016-03-11 04:30:31 +0000834 for (unsigned i = 0, e = paramInfos.size(); i != e; ++i)
835 FI->getExtParameterInfosBuffer()[i] = paramInfos[i];
John McCalla729c622012-02-17 03:33:10 +0000836 return FI;
Daniel Dunbar313321e2009-02-03 05:31:23 +0000837}
838
839/***/
840
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000841namespace {
842// ABIArgInfo::Expand implementation.
843
844// Specifies the way QualType passed as ABIArgInfo::Expand is expanded.
845struct TypeExpansion {
846 enum TypeExpansionKind {
847 // Elements of constant arrays are expanded recursively.
848 TEK_ConstantArray,
849 // Record fields are expanded recursively (but if record is a union, only
850 // the field with the largest size is expanded).
851 TEK_Record,
852 // For complex types, real and imaginary parts are expanded recursively.
853 TEK_Complex,
854 // All other types are not expandable.
855 TEK_None
856 };
857
858 const TypeExpansionKind Kind;
859
860 TypeExpansion(TypeExpansionKind K) : Kind(K) {}
Angel Garcia Gomez637d1e62015-10-20 13:23:58 +0000861 virtual ~TypeExpansion() {}
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000862};
863
864struct ConstantArrayExpansion : TypeExpansion {
865 QualType EltTy;
866 uint64_t NumElts;
867
868 ConstantArrayExpansion(QualType EltTy, uint64_t NumElts)
869 : TypeExpansion(TEK_ConstantArray), EltTy(EltTy), NumElts(NumElts) {}
870 static bool classof(const TypeExpansion *TE) {
871 return TE->Kind == TEK_ConstantArray;
872 }
873};
874
875struct RecordExpansion : TypeExpansion {
Reid Klecknere9f6a712014-10-31 17:10:41 +0000876 SmallVector<const CXXBaseSpecifier *, 1> Bases;
877
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000878 SmallVector<const FieldDecl *, 1> Fields;
879
Reid Klecknere9f6a712014-10-31 17:10:41 +0000880 RecordExpansion(SmallVector<const CXXBaseSpecifier *, 1> &&Bases,
881 SmallVector<const FieldDecl *, 1> &&Fields)
Benjamin Kramer0bb97742016-02-13 16:00:13 +0000882 : TypeExpansion(TEK_Record), Bases(std::move(Bases)),
883 Fields(std::move(Fields)) {}
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000884 static bool classof(const TypeExpansion *TE) {
885 return TE->Kind == TEK_Record;
886 }
887};
888
889struct ComplexExpansion : TypeExpansion {
890 QualType EltTy;
891
892 ComplexExpansion(QualType EltTy) : TypeExpansion(TEK_Complex), EltTy(EltTy) {}
893 static bool classof(const TypeExpansion *TE) {
894 return TE->Kind == TEK_Complex;
895 }
896};
897
898struct NoExpansion : TypeExpansion {
899 NoExpansion() : TypeExpansion(TEK_None) {}
900 static bool classof(const TypeExpansion *TE) {
901 return TE->Kind == TEK_None;
902 }
903};
904} // namespace
905
906static std::unique_ptr<TypeExpansion>
907getTypeExpansion(QualType Ty, const ASTContext &Context) {
908 if (const ConstantArrayType *AT = Context.getAsConstantArrayType(Ty)) {
909 return llvm::make_unique<ConstantArrayExpansion>(
910 AT->getElementType(), AT->getSize().getZExtValue());
911 }
912 if (const RecordType *RT = Ty->getAs<RecordType>()) {
Reid Klecknere9f6a712014-10-31 17:10:41 +0000913 SmallVector<const CXXBaseSpecifier *, 1> Bases;
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000914 SmallVector<const FieldDecl *, 1> Fields;
Bob Wilsone826a2a2011-08-03 05:58:22 +0000915 const RecordDecl *RD = RT->getDecl();
916 assert(!RD->hasFlexibleArrayMember() &&
917 "Cannot expand structure with flexible array.");
Anton Korobeynikov4215ca72012-04-13 11:22:00 +0000918 if (RD->isUnion()) {
919 // Unions can be here only in degenerative cases - all the fields are same
920 // after flattening. Thus we have to use the "largest" field.
Craig Topper8a13c412014-05-21 05:09:00 +0000921 const FieldDecl *LargestFD = nullptr;
Anton Korobeynikov4215ca72012-04-13 11:22:00 +0000922 CharUnits UnionSize = CharUnits::Zero();
923
Aaron Ballmane8a8bae2014-03-08 20:12:42 +0000924 for (const auto *FD : RD->fields()) {
Richard Smith866dee42018-04-02 18:29:43 +0000925 if (FD->isZeroLengthBitField(Context))
Reid Kleckner80944df2014-10-31 22:00:51 +0000926 continue;
Anton Korobeynikov4215ca72012-04-13 11:22:00 +0000927 assert(!FD->isBitField() &&
928 "Cannot expand structure with bit-field members.");
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000929 CharUnits FieldSize = Context.getTypeSizeInChars(FD->getType());
Anton Korobeynikov4215ca72012-04-13 11:22:00 +0000930 if (UnionSize < FieldSize) {
931 UnionSize = FieldSize;
932 LargestFD = FD;
933 }
934 }
935 if (LargestFD)
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000936 Fields.push_back(LargestFD);
Anton Korobeynikov4215ca72012-04-13 11:22:00 +0000937 } else {
Reid Klecknere9f6a712014-10-31 17:10:41 +0000938 if (const auto *CXXRD = dyn_cast<CXXRecordDecl>(RD)) {
939 assert(!CXXRD->isDynamicClass() &&
940 "cannot expand vtable pointers in dynamic classes");
941 for (const CXXBaseSpecifier &BS : CXXRD->bases())
942 Bases.push_back(&BS);
943 }
944
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000945 for (const auto *FD : RD->fields()) {
Richard Smith866dee42018-04-02 18:29:43 +0000946 if (FD->isZeroLengthBitField(Context))
Reid Kleckner80944df2014-10-31 22:00:51 +0000947 continue;
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000948 assert(!FD->isBitField() &&
Anton Korobeynikov4215ca72012-04-13 11:22:00 +0000949 "Cannot expand structure with bit-field members.");
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000950 Fields.push_back(FD);
Anton Korobeynikov4215ca72012-04-13 11:22:00 +0000951 }
Bob Wilsone826a2a2011-08-03 05:58:22 +0000952 }
Reid Klecknere9f6a712014-10-31 17:10:41 +0000953 return llvm::make_unique<RecordExpansion>(std::move(Bases),
954 std::move(Fields));
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000955 }
956 if (const ComplexType *CT = Ty->getAs<ComplexType>()) {
957 return llvm::make_unique<ComplexExpansion>(CT->getElementType());
958 }
959 return llvm::make_unique<NoExpansion>();
960}
961
Alexey Samsonov52c0f6a2014-09-29 20:30:22 +0000962static int getExpansionSize(QualType Ty, const ASTContext &Context) {
963 auto Exp = getTypeExpansion(Ty, Context);
964 if (auto CAExp = dyn_cast<ConstantArrayExpansion>(Exp.get())) {
965 return CAExp->NumElts * getExpansionSize(CAExp->EltTy, Context);
966 }
967 if (auto RExp = dyn_cast<RecordExpansion>(Exp.get())) {
968 int Res = 0;
Reid Klecknere9f6a712014-10-31 17:10:41 +0000969 for (auto BS : RExp->Bases)
970 Res += getExpansionSize(BS->getType(), Context);
Alexey Samsonov52c0f6a2014-09-29 20:30:22 +0000971 for (auto FD : RExp->Fields)
972 Res += getExpansionSize(FD->getType(), Context);
973 return Res;
974 }
975 if (isa<ComplexExpansion>(Exp.get()))
976 return 2;
977 assert(isa<NoExpansion>(Exp.get()));
978 return 1;
979}
980
Alexey Samsonov153004f2014-09-29 22:08:00 +0000981void
982CodeGenTypes::getExpandedTypes(QualType Ty,
983 SmallVectorImpl<llvm::Type *>::iterator &TI) {
984 auto Exp = getTypeExpansion(Ty, Context);
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000985 if (auto CAExp = dyn_cast<ConstantArrayExpansion>(Exp.get())) {
986 for (int i = 0, n = CAExp->NumElts; i < n; i++) {
Alexey Samsonov153004f2014-09-29 22:08:00 +0000987 getExpandedTypes(CAExp->EltTy, TI);
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000988 }
989 } else if (auto RExp = dyn_cast<RecordExpansion>(Exp.get())) {
Reid Klecknere9f6a712014-10-31 17:10:41 +0000990 for (auto BS : RExp->Bases)
991 getExpandedTypes(BS->getType(), TI);
992 for (auto FD : RExp->Fields)
Alexey Samsonov153004f2014-09-29 22:08:00 +0000993 getExpandedTypes(FD->getType(), TI);
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000994 } else if (auto CExp = dyn_cast<ComplexExpansion>(Exp.get())) {
995 llvm::Type *EltTy = ConvertType(CExp->EltTy);
Alexey Samsonov153004f2014-09-29 22:08:00 +0000996 *TI++ = EltTy;
997 *TI++ = EltTy;
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000998 } else {
999 assert(isa<NoExpansion>(Exp.get()));
Alexey Samsonov153004f2014-09-29 22:08:00 +00001000 *TI++ = ConvertType(Ty);
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001001 }
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00001002}
1003
John McCall7f416cc2015-09-08 08:05:57 +00001004static void forConstantArrayExpansion(CodeGenFunction &CGF,
1005 ConstantArrayExpansion *CAE,
1006 Address BaseAddr,
1007 llvm::function_ref<void(Address)> Fn) {
1008 CharUnits EltSize = CGF.getContext().getTypeSizeInChars(CAE->EltTy);
1009 CharUnits EltAlign =
1010 BaseAddr.getAlignment().alignmentOfArrayElement(EltSize);
1011
1012 for (int i = 0, n = CAE->NumElts; i < n; i++) {
1013 llvm::Value *EltAddr =
1014 CGF.Builder.CreateConstGEP2_32(nullptr, BaseAddr.getPointer(), 0, i);
1015 Fn(Address(EltAddr, EltAlign));
1016 }
1017}
1018
Alexey Samsonov91cf4552014-08-22 01:06:06 +00001019void CodeGenFunction::ExpandTypeFromArgs(
John McCall12f23522016-04-04 18:33:08 +00001020 QualType Ty, LValue LV, SmallVectorImpl<llvm::Value *>::iterator &AI) {
Mike Stump11289f42009-09-09 15:08:12 +00001021 assert(LV.isSimple() &&
1022 "Unexpected non-simple lvalue during struct expansion.");
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00001023
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001024 auto Exp = getTypeExpansion(Ty, getContext());
1025 if (auto CAExp = dyn_cast<ConstantArrayExpansion>(Exp.get())) {
John McCall7f416cc2015-09-08 08:05:57 +00001026 forConstantArrayExpansion(*this, CAExp, LV.getAddress(),
1027 [&](Address EltAddr) {
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001028 LValue LV = MakeAddrLValue(EltAddr, CAExp->EltTy);
1029 ExpandTypeFromArgs(CAExp->EltTy, LV, AI);
John McCall7f416cc2015-09-08 08:05:57 +00001030 });
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001031 } else if (auto RExp = dyn_cast<RecordExpansion>(Exp.get())) {
John McCall7f416cc2015-09-08 08:05:57 +00001032 Address This = LV.getAddress();
Reid Klecknere9f6a712014-10-31 17:10:41 +00001033 for (const CXXBaseSpecifier *BS : RExp->Bases) {
1034 // Perform a single step derived-to-base conversion.
John McCall7f416cc2015-09-08 08:05:57 +00001035 Address Base =
Reid Klecknere9f6a712014-10-31 17:10:41 +00001036 GetAddressOfBaseClass(This, Ty->getAsCXXRecordDecl(), &BS, &BS + 1,
1037 /*NullCheckValue=*/false, SourceLocation());
1038 LValue SubLV = MakeAddrLValue(Base, BS->getType());
1039
1040 // Recurse onto bases.
1041 ExpandTypeFromArgs(BS->getType(), SubLV, AI);
1042 }
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001043 for (auto FD : RExp->Fields) {
1044 // FIXME: What are the right qualifiers here?
Reid Kleckner9d031092016-05-02 22:42:34 +00001045 LValue SubLV = EmitLValueForFieldInitialization(LV, FD);
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001046 ExpandTypeFromArgs(FD->getType(), SubLV, AI);
Bob Wilsone826a2a2011-08-03 05:58:22 +00001047 }
John McCall7f416cc2015-09-08 08:05:57 +00001048 } else if (isa<ComplexExpansion>(Exp.get())) {
1049 auto realValue = *AI++;
1050 auto imagValue = *AI++;
1051 EmitStoreOfComplex(ComplexPairTy(realValue, imagValue), LV, /*init*/ true);
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001052 } else {
1053 assert(isa<NoExpansion>(Exp.get()));
1054 EmitStoreThroughLValue(RValue::get(*AI++), LV);
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00001055 }
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001056}
1057
1058void CodeGenFunction::ExpandTypeToArgs(
Yaxun Liu5b330e82018-03-15 15:25:19 +00001059 QualType Ty, CallArg Arg, llvm::FunctionType *IRFuncTy,
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001060 SmallVectorImpl<llvm::Value *> &IRCallArgs, unsigned &IRCallArgPos) {
1061 auto Exp = getTypeExpansion(Ty, getContext());
1062 if (auto CAExp = dyn_cast<ConstantArrayExpansion>(Exp.get())) {
Yaxun Liu5b330e82018-03-15 15:25:19 +00001063 Address Addr = Arg.hasLValue() ? Arg.getKnownLValue().getAddress()
1064 : Arg.getKnownRValue().getAggregateAddress();
1065 forConstantArrayExpansion(
1066 *this, CAExp, Addr, [&](Address EltAddr) {
1067 CallArg EltArg = CallArg(
1068 convertTempToRValue(EltAddr, CAExp->EltTy, SourceLocation()),
1069 CAExp->EltTy);
1070 ExpandTypeToArgs(CAExp->EltTy, EltArg, IRFuncTy, IRCallArgs,
1071 IRCallArgPos);
1072 });
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001073 } else if (auto RExp = dyn_cast<RecordExpansion>(Exp.get())) {
Yaxun Liu5b330e82018-03-15 15:25:19 +00001074 Address This = Arg.hasLValue() ? Arg.getKnownLValue().getAddress()
1075 : Arg.getKnownRValue().getAggregateAddress();
Reid Klecknere9f6a712014-10-31 17:10:41 +00001076 for (const CXXBaseSpecifier *BS : RExp->Bases) {
1077 // Perform a single step derived-to-base conversion.
John McCall7f416cc2015-09-08 08:05:57 +00001078 Address Base =
Reid Klecknere9f6a712014-10-31 17:10:41 +00001079 GetAddressOfBaseClass(This, Ty->getAsCXXRecordDecl(), &BS, &BS + 1,
1080 /*NullCheckValue=*/false, SourceLocation());
Yaxun Liu5b330e82018-03-15 15:25:19 +00001081 CallArg BaseArg = CallArg(RValue::getAggregate(Base), BS->getType());
Reid Klecknere9f6a712014-10-31 17:10:41 +00001082
1083 // Recurse onto bases.
Yaxun Liu5b330e82018-03-15 15:25:19 +00001084 ExpandTypeToArgs(BS->getType(), BaseArg, IRFuncTy, IRCallArgs,
Reid Klecknere9f6a712014-10-31 17:10:41 +00001085 IRCallArgPos);
1086 }
1087
1088 LValue LV = MakeAddrLValue(This, Ty);
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001089 for (auto FD : RExp->Fields) {
Yaxun Liu5b330e82018-03-15 15:25:19 +00001090 CallArg FldArg =
1091 CallArg(EmitRValueForField(LV, FD, SourceLocation()), FD->getType());
1092 ExpandTypeToArgs(FD->getType(), FldArg, IRFuncTy, IRCallArgs,
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001093 IRCallArgPos);
1094 }
1095 } else if (isa<ComplexExpansion>(Exp.get())) {
Yaxun Liu5b330e82018-03-15 15:25:19 +00001096 ComplexPairTy CV = Arg.getKnownRValue().getComplexVal();
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001097 IRCallArgs[IRCallArgPos++] = CV.first;
1098 IRCallArgs[IRCallArgPos++] = CV.second;
1099 } else {
1100 assert(isa<NoExpansion>(Exp.get()));
Yaxun Liu5b330e82018-03-15 15:25:19 +00001101 auto RV = Arg.getKnownRValue();
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001102 assert(RV.isScalar() &&
1103 "Unexpected non-scalar rvalue during struct expansion.");
1104
1105 // Insert a bitcast as needed.
1106 llvm::Value *V = RV.getScalarVal();
1107 if (IRCallArgPos < IRFuncTy->getNumParams() &&
1108 V->getType() != IRFuncTy->getParamType(IRCallArgPos))
1109 V = Builder.CreateBitCast(V, IRFuncTy->getParamType(IRCallArgPos));
1110
1111 IRCallArgs[IRCallArgPos++] = V;
1112 }
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00001113}
1114
John McCall7f416cc2015-09-08 08:05:57 +00001115/// Create a temporary allocation for the purposes of coercion.
1116static Address CreateTempAllocaForCoercion(CodeGenFunction &CGF, llvm::Type *Ty,
1117 CharUnits MinAlign) {
1118 // Don't use an alignment that's worse than what LLVM would prefer.
1119 auto PrefAlign = CGF.CGM.getDataLayout().getPrefTypeAlignment(Ty);
1120 CharUnits Align = std::max(MinAlign, CharUnits::fromQuantity(PrefAlign));
1121
1122 return CGF.CreateTempAlloca(Ty, Align);
1123}
1124
Chris Lattner895c52b2010-06-27 06:04:18 +00001125/// EnterStructPointerForCoercedAccess - Given a struct pointer that we are
Chris Lattner1cd66982010-06-27 05:56:15 +00001126/// accessing some number of bytes out of it, try to gep into the struct to get
1127/// at its inner goodness. Dive as deep as possible without entering an element
1128/// with an in-memory size smaller than DstSize.
John McCall7f416cc2015-09-08 08:05:57 +00001129static Address
1130EnterStructPointerForCoercedAccess(Address SrcPtr,
Chris Lattner2192fe52011-07-18 04:24:23 +00001131 llvm::StructType *SrcSTy,
Chris Lattner895c52b2010-06-27 06:04:18 +00001132 uint64_t DstSize, CodeGenFunction &CGF) {
Chris Lattner1cd66982010-06-27 05:56:15 +00001133 // We can't dive into a zero-element struct.
1134 if (SrcSTy->getNumElements() == 0) return SrcPtr;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001135
Chris Lattner2192fe52011-07-18 04:24:23 +00001136 llvm::Type *FirstElt = SrcSTy->getElementType(0);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001137
Chris Lattner1cd66982010-06-27 05:56:15 +00001138 // 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 +00001139 // first element is the same size as the whole struct, we can enter it. The
1140 // comparison must be made on the store size and not the alloca size. Using
1141 // the alloca size may overstate the size of the load.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001142 uint64_t FirstEltSize =
James Molloy90d61012014-08-29 10:17:52 +00001143 CGF.CGM.getDataLayout().getTypeStoreSize(FirstElt);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001144 if (FirstEltSize < DstSize &&
James Molloy90d61012014-08-29 10:17:52 +00001145 FirstEltSize < CGF.CGM.getDataLayout().getTypeStoreSize(SrcSTy))
Chris Lattner1cd66982010-06-27 05:56:15 +00001146 return SrcPtr;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001147
Chris Lattner1cd66982010-06-27 05:56:15 +00001148 // GEP into the first element.
John McCall7f416cc2015-09-08 08:05:57 +00001149 SrcPtr = CGF.Builder.CreateStructGEP(SrcPtr, 0, CharUnits(), "coerce.dive");
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001150
Chris Lattner1cd66982010-06-27 05:56:15 +00001151 // If the first element is a struct, recurse.
John McCall7f416cc2015-09-08 08:05:57 +00001152 llvm::Type *SrcTy = SrcPtr.getElementType();
Chris Lattner2192fe52011-07-18 04:24:23 +00001153 if (llvm::StructType *SrcSTy = dyn_cast<llvm::StructType>(SrcTy))
Chris Lattner895c52b2010-06-27 06:04:18 +00001154 return EnterStructPointerForCoercedAccess(SrcPtr, SrcSTy, DstSize, CGF);
Chris Lattner1cd66982010-06-27 05:56:15 +00001155
1156 return SrcPtr;
1157}
1158
Chris Lattner055097f2010-06-27 06:26:04 +00001159/// CoerceIntOrPtrToIntOrPtr - Convert a value Val to the specific Ty where both
1160/// are either integers or pointers. This does a truncation of the value if it
1161/// is too large or a zero extension if it is too small.
Jakob Stoklund Olesen36af2522013-06-05 03:00:13 +00001162///
1163/// This behaves as if the value were coerced through memory, so on big-endian
1164/// targets the high bits are preserved in a truncation, while little-endian
1165/// targets preserve the low bits.
Chris Lattner055097f2010-06-27 06:26:04 +00001166static llvm::Value *CoerceIntOrPtrToIntOrPtr(llvm::Value *Val,
Chris Lattner2192fe52011-07-18 04:24:23 +00001167 llvm::Type *Ty,
Chris Lattner055097f2010-06-27 06:26:04 +00001168 CodeGenFunction &CGF) {
1169 if (Val->getType() == Ty)
1170 return Val;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001171
Chris Lattner055097f2010-06-27 06:26:04 +00001172 if (isa<llvm::PointerType>(Val->getType())) {
1173 // If this is Pointer->Pointer avoid conversion to and from int.
1174 if (isa<llvm::PointerType>(Ty))
1175 return CGF.Builder.CreateBitCast(Val, Ty, "coerce.val");
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001176
Chris Lattner055097f2010-06-27 06:26:04 +00001177 // Convert the pointer to an integer so we can play with its width.
Chris Lattner5e016ae2010-06-27 07:15:29 +00001178 Val = CGF.Builder.CreatePtrToInt(Val, CGF.IntPtrTy, "coerce.val.pi");
Chris Lattner055097f2010-06-27 06:26:04 +00001179 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001180
Chris Lattner2192fe52011-07-18 04:24:23 +00001181 llvm::Type *DestIntTy = Ty;
Chris Lattner055097f2010-06-27 06:26:04 +00001182 if (isa<llvm::PointerType>(DestIntTy))
Chris Lattner5e016ae2010-06-27 07:15:29 +00001183 DestIntTy = CGF.IntPtrTy;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001184
Jakob Stoklund Olesen36af2522013-06-05 03:00:13 +00001185 if (Val->getType() != DestIntTy) {
1186 const llvm::DataLayout &DL = CGF.CGM.getDataLayout();
1187 if (DL.isBigEndian()) {
1188 // Preserve the high bits on big-endian targets.
1189 // That is what memory coercion does.
James Molloy491cefb2014-05-07 17:41:15 +00001190 uint64_t SrcSize = DL.getTypeSizeInBits(Val->getType());
1191 uint64_t DstSize = DL.getTypeSizeInBits(DestIntTy);
1192
Jakob Stoklund Olesen36af2522013-06-05 03:00:13 +00001193 if (SrcSize > DstSize) {
1194 Val = CGF.Builder.CreateLShr(Val, SrcSize - DstSize, "coerce.highbits");
1195 Val = CGF.Builder.CreateTrunc(Val, DestIntTy, "coerce.val.ii");
1196 } else {
1197 Val = CGF.Builder.CreateZExt(Val, DestIntTy, "coerce.val.ii");
1198 Val = CGF.Builder.CreateShl(Val, DstSize - SrcSize, "coerce.highbits");
1199 }
1200 } else {
1201 // Little-endian targets preserve the low bits. No shifts required.
1202 Val = CGF.Builder.CreateIntCast(Val, DestIntTy, false, "coerce.val.ii");
1203 }
1204 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001205
Chris Lattner055097f2010-06-27 06:26:04 +00001206 if (isa<llvm::PointerType>(Ty))
1207 Val = CGF.Builder.CreateIntToPtr(Val, Ty, "coerce.val.ip");
1208 return Val;
1209}
1210
Chris Lattner1cd66982010-06-27 05:56:15 +00001211
1212
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001213/// CreateCoercedLoad - Create a load from \arg SrcPtr interpreted as
Ulrich Weigand6e2cea62015-07-10 11:31:43 +00001214/// a pointer to an object of type \arg Ty, known to be aligned to
1215/// \arg SrcAlign bytes.
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001216///
1217/// This safely handles the case when the src type is smaller than the
1218/// destination type; in this situation the values of bits which not
1219/// present in the src are undefined.
John McCall7f416cc2015-09-08 08:05:57 +00001220static llvm::Value *CreateCoercedLoad(Address Src, llvm::Type *Ty,
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001221 CodeGenFunction &CGF) {
John McCall7f416cc2015-09-08 08:05:57 +00001222 llvm::Type *SrcTy = Src.getElementType();
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001223
Chris Lattnerd200eda2010-06-28 22:51:39 +00001224 // If SrcTy and Ty are the same, just do a load.
1225 if (SrcTy == Ty)
John McCall7f416cc2015-09-08 08:05:57 +00001226 return CGF.Builder.CreateLoad(Src);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001227
Micah Villmowdd31ca12012-10-08 16:25:52 +00001228 uint64_t DstSize = CGF.CGM.getDataLayout().getTypeAllocSize(Ty);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001229
Chris Lattner2192fe52011-07-18 04:24:23 +00001230 if (llvm::StructType *SrcSTy = dyn_cast<llvm::StructType>(SrcTy)) {
John McCall7f416cc2015-09-08 08:05:57 +00001231 Src = EnterStructPointerForCoercedAccess(Src, SrcSTy, DstSize, CGF);
1232 SrcTy = Src.getType()->getElementType();
Chris Lattner1cd66982010-06-27 05:56:15 +00001233 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001234
Micah Villmowdd31ca12012-10-08 16:25:52 +00001235 uint64_t SrcSize = CGF.CGM.getDataLayout().getTypeAllocSize(SrcTy);
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001236
Chris Lattner055097f2010-06-27 06:26:04 +00001237 // If the source and destination are integer or pointer types, just do an
1238 // extension or truncation to the desired type.
1239 if ((isa<llvm::IntegerType>(Ty) || isa<llvm::PointerType>(Ty)) &&
1240 (isa<llvm::IntegerType>(SrcTy) || isa<llvm::PointerType>(SrcTy))) {
John McCall7f416cc2015-09-08 08:05:57 +00001241 llvm::Value *Load = CGF.Builder.CreateLoad(Src);
Chris Lattner055097f2010-06-27 06:26:04 +00001242 return CoerceIntOrPtrToIntOrPtr(Load, Ty, CGF);
1243 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001244
Daniel Dunbarb52d0772009-02-03 05:59:18 +00001245 // If load is legal, just bitcast the src pointer.
Daniel Dunbarffdb8432009-05-13 18:54:26 +00001246 if (SrcSize >= DstSize) {
Mike Stump18bb9282009-05-16 07:57:57 +00001247 // Generally SrcSize is never greater than DstSize, since this means we are
1248 // losing bits. However, this can happen in cases where the structure has
1249 // additional padding, for example due to a user specified alignment.
Daniel Dunbarffdb8432009-05-13 18:54:26 +00001250 //
Mike Stump18bb9282009-05-16 07:57:57 +00001251 // FIXME: Assert that we aren't truncating non-padding bits when have access
1252 // to that information.
Matt Arsenault7a124f32017-08-01 20:36:57 +00001253 Src = CGF.Builder.CreateBitCast(Src,
1254 Ty->getPointerTo(Src.getAddressSpace()));
John McCall7f416cc2015-09-08 08:05:57 +00001255 return CGF.Builder.CreateLoad(Src);
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001256 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001257
John McCall7f416cc2015-09-08 08:05:57 +00001258 // Otherwise do coercion through memory. This is stupid, but simple.
1259 Address Tmp = CreateTempAllocaForCoercion(CGF, Ty, Src.getAlignment());
Yaxun Liu4bbdebc2018-11-08 16:55:46 +00001260 Address Casted = CGF.Builder.CreateElementBitCast(Tmp,CGF.Int8Ty);
1261 Address SrcCasted = CGF.Builder.CreateElementBitCast(Src,CGF.Int8Ty);
Manman Ren84b921f2012-11-28 22:08:52 +00001262 CGF.Builder.CreateMemCpy(Casted, SrcCasted,
1263 llvm::ConstantInt::get(CGF.IntPtrTy, SrcSize),
John McCall7f416cc2015-09-08 08:05:57 +00001264 false);
1265 return CGF.Builder.CreateLoad(Tmp);
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001266}
1267
Eli Friedmanaf9b3252011-05-17 21:08:01 +00001268// Function to store a first-class aggregate into memory. We prefer to
1269// store the elements rather than the aggregate to be more friendly to
1270// fast-isel.
1271// FIXME: Do we need to recurse here?
1272static void BuildAggStore(CodeGenFunction &CGF, llvm::Value *Val,
John McCall7f416cc2015-09-08 08:05:57 +00001273 Address Dest, bool DestIsVolatile) {
Eli Friedmanaf9b3252011-05-17 21:08:01 +00001274 // Prefer scalar stores to first-class aggregate stores.
Chris Lattner2192fe52011-07-18 04:24:23 +00001275 if (llvm::StructType *STy =
Eli Friedmanaf9b3252011-05-17 21:08:01 +00001276 dyn_cast<llvm::StructType>(Val->getType())) {
Ulrich Weigand6e2cea62015-07-10 11:31:43 +00001277 const llvm::StructLayout *Layout =
1278 CGF.CGM.getDataLayout().getStructLayout(STy);
1279
Eli Friedmanaf9b3252011-05-17 21:08:01 +00001280 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
John McCall7f416cc2015-09-08 08:05:57 +00001281 auto EltOffset = CharUnits::fromQuantity(Layout->getElementOffset(i));
1282 Address EltPtr = CGF.Builder.CreateStructGEP(Dest, i, EltOffset);
Eli Friedmanaf9b3252011-05-17 21:08:01 +00001283 llvm::Value *Elt = CGF.Builder.CreateExtractValue(Val, i);
John McCall7f416cc2015-09-08 08:05:57 +00001284 CGF.Builder.CreateStore(Elt, EltPtr, DestIsVolatile);
Eli Friedmanaf9b3252011-05-17 21:08:01 +00001285 }
1286 } else {
John McCall7f416cc2015-09-08 08:05:57 +00001287 CGF.Builder.CreateStore(Val, Dest, DestIsVolatile);
Eli Friedmanaf9b3252011-05-17 21:08:01 +00001288 }
1289}
1290
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001291/// CreateCoercedStore - Create a store to \arg DstPtr from \arg Src,
Ulrich Weigand6e2cea62015-07-10 11:31:43 +00001292/// where the source and destination may have different types. The
1293/// destination is known to be aligned to \arg DstAlign bytes.
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001294///
1295/// This safely handles the case when the src type is larger than the
1296/// destination type; the upper bits of the src will be lost.
1297static void CreateCoercedStore(llvm::Value *Src,
John McCall7f416cc2015-09-08 08:05:57 +00001298 Address Dst,
Anders Carlsson17490832009-12-24 20:40:36 +00001299 bool DstIsVolatile,
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001300 CodeGenFunction &CGF) {
Chris Lattner2192fe52011-07-18 04:24:23 +00001301 llvm::Type *SrcTy = Src->getType();
John McCall7f416cc2015-09-08 08:05:57 +00001302 llvm::Type *DstTy = Dst.getType()->getElementType();
Chris Lattnerd200eda2010-06-28 22:51:39 +00001303 if (SrcTy == DstTy) {
John McCall7f416cc2015-09-08 08:05:57 +00001304 CGF.Builder.CreateStore(Src, Dst, DstIsVolatile);
Chris Lattnerd200eda2010-06-28 22:51:39 +00001305 return;
1306 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001307
Micah Villmowdd31ca12012-10-08 16:25:52 +00001308 uint64_t SrcSize = CGF.CGM.getDataLayout().getTypeAllocSize(SrcTy);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001309
Chris Lattner2192fe52011-07-18 04:24:23 +00001310 if (llvm::StructType *DstSTy = dyn_cast<llvm::StructType>(DstTy)) {
John McCall7f416cc2015-09-08 08:05:57 +00001311 Dst = EnterStructPointerForCoercedAccess(Dst, DstSTy, SrcSize, CGF);
1312 DstTy = Dst.getType()->getElementType();
Chris Lattner895c52b2010-06-27 06:04:18 +00001313 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001314
Chris Lattner055097f2010-06-27 06:26:04 +00001315 // If the source and destination are integer or pointer types, just do an
1316 // extension or truncation to the desired type.
1317 if ((isa<llvm::IntegerType>(SrcTy) || isa<llvm::PointerType>(SrcTy)) &&
1318 (isa<llvm::IntegerType>(DstTy) || isa<llvm::PointerType>(DstTy))) {
1319 Src = CoerceIntOrPtrToIntOrPtr(Src, DstTy, CGF);
John McCall7f416cc2015-09-08 08:05:57 +00001320 CGF.Builder.CreateStore(Src, Dst, DstIsVolatile);
Chris Lattner055097f2010-06-27 06:26:04 +00001321 return;
1322 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001323
Micah Villmowdd31ca12012-10-08 16:25:52 +00001324 uint64_t DstSize = CGF.CGM.getDataLayout().getTypeAllocSize(DstTy);
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001325
Daniel Dunbar313321e2009-02-03 05:31:23 +00001326 // If store is legal, just bitcast the src pointer.
Daniel Dunbar4be99ff2009-06-05 07:58:54 +00001327 if (SrcSize <= DstSize) {
Yaxun Liue9e5c4f2017-06-29 18:47:45 +00001328 Dst = CGF.Builder.CreateElementBitCast(Dst, SrcTy);
John McCall7f416cc2015-09-08 08:05:57 +00001329 BuildAggStore(CGF, Src, Dst, DstIsVolatile);
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001330 } else {
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001331 // Otherwise do coercion through memory. This is stupid, but
1332 // simple.
Daniel Dunbar4be99ff2009-06-05 07:58:54 +00001333
1334 // Generally SrcSize is never greater than DstSize, since this means we are
1335 // losing bits. However, this can happen in cases where the structure has
1336 // additional padding, for example due to a user specified alignment.
1337 //
1338 // FIXME: Assert that we aren't truncating non-padding bits when have access
1339 // to that information.
John McCall7f416cc2015-09-08 08:05:57 +00001340 Address Tmp = CreateTempAllocaForCoercion(CGF, SrcTy, Dst.getAlignment());
1341 CGF.Builder.CreateStore(Src, Tmp);
Yaxun Liu4bbdebc2018-11-08 16:55:46 +00001342 Address Casted = CGF.Builder.CreateElementBitCast(Tmp,CGF.Int8Ty);
1343 Address DstCasted = CGF.Builder.CreateElementBitCast(Dst,CGF.Int8Ty);
Manman Ren84b921f2012-11-28 22:08:52 +00001344 CGF.Builder.CreateMemCpy(DstCasted, Casted,
1345 llvm::ConstantInt::get(CGF.IntPtrTy, DstSize),
John McCall7f416cc2015-09-08 08:05:57 +00001346 false);
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001347 }
1348}
1349
John McCall7f416cc2015-09-08 08:05:57 +00001350static Address emitAddressAtOffset(CodeGenFunction &CGF, Address addr,
Fangrui Song6907ce22018-07-30 19:24:48 +00001351 const ABIArgInfo &info) {
John McCall7f416cc2015-09-08 08:05:57 +00001352 if (unsigned offset = info.getDirectOffset()) {
1353 addr = CGF.Builder.CreateElementBitCast(addr, CGF.Int8Ty);
1354 addr = CGF.Builder.CreateConstInBoundsByteGEP(addr,
1355 CharUnits::fromQuantity(offset));
1356 addr = CGF.Builder.CreateElementBitCast(addr, info.getCoerceToType());
1357 }
1358 return addr;
1359}
1360
Alexey Samsonov153004f2014-09-29 22:08:00 +00001361namespace {
1362
1363/// Encapsulates information about the way function arguments from
1364/// CGFunctionInfo should be passed to actual LLVM IR function.
1365class ClangToLLVMArgMapping {
1366 static const unsigned InvalidIndex = ~0U;
1367 unsigned InallocaArgNo;
1368 unsigned SRetArgNo;
1369 unsigned TotalIRArgs;
1370
1371 /// Arguments of LLVM IR function corresponding to single Clang argument.
1372 struct IRArgs {
1373 unsigned PaddingArgIndex;
1374 // Argument is expanded to IR arguments at positions
1375 // [FirstArgIndex, FirstArgIndex + NumberOfArgs).
1376 unsigned FirstArgIndex;
1377 unsigned NumberOfArgs;
1378
1379 IRArgs()
1380 : PaddingArgIndex(InvalidIndex), FirstArgIndex(InvalidIndex),
1381 NumberOfArgs(0) {}
1382 };
1383
1384 SmallVector<IRArgs, 8> ArgInfo;
1385
1386public:
1387 ClangToLLVMArgMapping(const ASTContext &Context, const CGFunctionInfo &FI,
1388 bool OnlyRequiredArgs = false)
1389 : InallocaArgNo(InvalidIndex), SRetArgNo(InvalidIndex), TotalIRArgs(0),
1390 ArgInfo(OnlyRequiredArgs ? FI.getNumRequiredArgs() : FI.arg_size()) {
1391 construct(Context, FI, OnlyRequiredArgs);
1392 }
1393
1394 bool hasInallocaArg() const { return InallocaArgNo != InvalidIndex; }
1395 unsigned getInallocaArgNo() const {
1396 assert(hasInallocaArg());
1397 return InallocaArgNo;
1398 }
1399
1400 bool hasSRetArg() const { return SRetArgNo != InvalidIndex; }
1401 unsigned getSRetArgNo() const {
1402 assert(hasSRetArg());
1403 return SRetArgNo;
1404 }
1405
1406 unsigned totalIRArgs() const { return TotalIRArgs; }
1407
1408 bool hasPaddingArg(unsigned ArgNo) const {
1409 assert(ArgNo < ArgInfo.size());
1410 return ArgInfo[ArgNo].PaddingArgIndex != InvalidIndex;
1411 }
1412 unsigned getPaddingArgNo(unsigned ArgNo) const {
1413 assert(hasPaddingArg(ArgNo));
1414 return ArgInfo[ArgNo].PaddingArgIndex;
1415 }
1416
1417 /// Returns index of first IR argument corresponding to ArgNo, and their
1418 /// quantity.
1419 std::pair<unsigned, unsigned> getIRArgs(unsigned ArgNo) const {
1420 assert(ArgNo < ArgInfo.size());
1421 return std::make_pair(ArgInfo[ArgNo].FirstArgIndex,
1422 ArgInfo[ArgNo].NumberOfArgs);
1423 }
1424
1425private:
1426 void construct(const ASTContext &Context, const CGFunctionInfo &FI,
1427 bool OnlyRequiredArgs);
1428};
1429
1430void ClangToLLVMArgMapping::construct(const ASTContext &Context,
1431 const CGFunctionInfo &FI,
1432 bool OnlyRequiredArgs) {
1433 unsigned IRArgNo = 0;
1434 bool SwapThisWithSRet = false;
1435 const ABIArgInfo &RetAI = FI.getReturnInfo();
1436
1437 if (RetAI.getKind() == ABIArgInfo::Indirect) {
1438 SwapThisWithSRet = RetAI.isSRetAfterThis();
1439 SRetArgNo = SwapThisWithSRet ? 1 : IRArgNo++;
1440 }
1441
1442 unsigned ArgNo = 0;
1443 unsigned NumArgs = OnlyRequiredArgs ? FI.getNumRequiredArgs() : FI.arg_size();
1444 for (CGFunctionInfo::const_arg_iterator I = FI.arg_begin(); ArgNo < NumArgs;
1445 ++I, ++ArgNo) {
1446 assert(I != FI.arg_end());
1447 QualType ArgType = I->type;
1448 const ABIArgInfo &AI = I->info;
1449 // Collect data about IR arguments corresponding to Clang argument ArgNo.
1450 auto &IRArgs = ArgInfo[ArgNo];
1451
1452 if (AI.getPaddingType())
1453 IRArgs.PaddingArgIndex = IRArgNo++;
1454
1455 switch (AI.getKind()) {
1456 case ABIArgInfo::Extend:
1457 case ABIArgInfo::Direct: {
1458 // FIXME: handle sseregparm someday...
1459 llvm::StructType *STy = dyn_cast<llvm::StructType>(AI.getCoerceToType());
1460 if (AI.isDirect() && AI.getCanBeFlattened() && STy) {
1461 IRArgs.NumberOfArgs = STy->getNumElements();
1462 } else {
1463 IRArgs.NumberOfArgs = 1;
1464 }
1465 break;
1466 }
1467 case ABIArgInfo::Indirect:
1468 IRArgs.NumberOfArgs = 1;
1469 break;
1470 case ABIArgInfo::Ignore:
1471 case ABIArgInfo::InAlloca:
1472 // ignore and inalloca doesn't have matching LLVM parameters.
1473 IRArgs.NumberOfArgs = 0;
1474 break;
John McCallf26e73d2016-03-11 04:30:43 +00001475 case ABIArgInfo::CoerceAndExpand:
1476 IRArgs.NumberOfArgs = AI.getCoerceAndExpandTypeSequence().size();
1477 break;
1478 case ABIArgInfo::Expand:
Alexey Samsonov153004f2014-09-29 22:08:00 +00001479 IRArgs.NumberOfArgs = getExpansionSize(ArgType, Context);
1480 break;
1481 }
Alexey Samsonov153004f2014-09-29 22:08:00 +00001482
1483 if (IRArgs.NumberOfArgs > 0) {
1484 IRArgs.FirstArgIndex = IRArgNo;
1485 IRArgNo += IRArgs.NumberOfArgs;
1486 }
1487
1488 // Skip over the sret parameter when it comes second. We already handled it
1489 // above.
1490 if (IRArgNo == 1 && SwapThisWithSRet)
1491 IRArgNo++;
1492 }
1493 assert(ArgNo == ArgInfo.size());
1494
1495 if (FI.usesInAlloca())
1496 InallocaArgNo = IRArgNo++;
1497
1498 TotalIRArgs = IRArgNo;
1499}
1500} // namespace
1501
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00001502/***/
1503
Daniel Dunbar6f2e8392010-07-14 23:39:36 +00001504bool CodeGenModule::ReturnTypeUsesSRet(const CGFunctionInfo &FI) {
Saleem Abdulrasoolf181f1a2018-02-28 20:16:12 +00001505 const auto &RI = FI.getReturnInfo();
1506 return RI.isIndirect() || (RI.isInAlloca() && RI.getInAllocaSRet());
Daniel Dunbar7633cbf2009-02-02 21:43:58 +00001507}
1508
Tim Northovere77cc392014-03-29 13:28:05 +00001509bool CodeGenModule::ReturnSlotInterferesWithArgs(const CGFunctionInfo &FI) {
1510 return ReturnTypeUsesSRet(FI) &&
1511 getTargetCodeGenInfo().doesReturnSlotInterfereWithArgs();
1512}
1513
Daniel Dunbar6f2e8392010-07-14 23:39:36 +00001514bool CodeGenModule::ReturnTypeUsesFPRet(QualType ResultType) {
1515 if (const BuiltinType *BT = ResultType->getAs<BuiltinType>()) {
1516 switch (BT->getKind()) {
1517 default:
1518 return false;
1519 case BuiltinType::Float:
John McCallc8e01702013-04-16 22:48:15 +00001520 return getTarget().useObjCFPRetForRealType(TargetInfo::Float);
Daniel Dunbar6f2e8392010-07-14 23:39:36 +00001521 case BuiltinType::Double:
John McCallc8e01702013-04-16 22:48:15 +00001522 return getTarget().useObjCFPRetForRealType(TargetInfo::Double);
Daniel Dunbar6f2e8392010-07-14 23:39:36 +00001523 case BuiltinType::LongDouble:
John McCallc8e01702013-04-16 22:48:15 +00001524 return getTarget().useObjCFPRetForRealType(TargetInfo::LongDouble);
Daniel Dunbar6f2e8392010-07-14 23:39:36 +00001525 }
1526 }
1527
1528 return false;
1529}
1530
Anders Carlsson2f1a6c32011-10-31 16:27:11 +00001531bool CodeGenModule::ReturnTypeUsesFP2Ret(QualType ResultType) {
1532 if (const ComplexType *CT = ResultType->getAs<ComplexType>()) {
1533 if (const BuiltinType *BT = CT->getElementType()->getAs<BuiltinType>()) {
1534 if (BT->getKind() == BuiltinType::LongDouble)
John McCallc8e01702013-04-16 22:48:15 +00001535 return getTarget().useObjCFP2RetForComplexLongDouble();
Anders Carlsson2f1a6c32011-10-31 16:27:11 +00001536 }
1537 }
1538
1539 return false;
1540}
1541
Chris Lattnera5f58b02011-07-09 17:41:47 +00001542llvm::FunctionType *CodeGenTypes::GetFunctionType(GlobalDecl GD) {
John McCalla729c622012-02-17 03:33:10 +00001543 const CGFunctionInfo &FI = arrangeGlobalDeclaration(GD);
1544 return GetFunctionType(FI);
John McCallf8ff7b92010-02-23 00:48:20 +00001545}
1546
Chris Lattnera5f58b02011-07-09 17:41:47 +00001547llvm::FunctionType *
John McCalla729c622012-02-17 03:33:10 +00001548CodeGenTypes::GetFunctionType(const CGFunctionInfo &FI) {
Alexey Samsonov153004f2014-09-29 22:08:00 +00001549
David Blaikie82e95a32014-11-19 07:49:47 +00001550 bool Inserted = FunctionsBeingProcessed.insert(&FI).second;
1551 (void)Inserted;
Chris Lattner6fb0ccf2011-07-15 05:16:14 +00001552 assert(Inserted && "Recursively being processed?");
Daniel Dunbar7a95ca32008-09-10 04:01:49 +00001553
Alexey Samsonov153004f2014-09-29 22:08:00 +00001554 llvm::Type *resultType = nullptr;
John McCall85dd2c52011-05-15 02:19:42 +00001555 const ABIArgInfo &retAI = FI.getReturnInfo();
1556 switch (retAI.getKind()) {
Daniel Dunbard3674e62008-09-11 01:48:57 +00001557 case ABIArgInfo::Expand:
John McCall85dd2c52011-05-15 02:19:42 +00001558 llvm_unreachable("Invalid ABI kind for return argument");
Daniel Dunbard3674e62008-09-11 01:48:57 +00001559
Anton Korobeynikov18adbf52009-06-06 09:36:29 +00001560 case ABIArgInfo::Extend:
Daniel Dunbar67dace892009-02-03 06:17:37 +00001561 case ABIArgInfo::Direct:
John McCall85dd2c52011-05-15 02:19:42 +00001562 resultType = retAI.getCoerceToType();
Daniel Dunbar67dace892009-02-03 06:17:37 +00001563 break;
1564
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001565 case ABIArgInfo::InAlloca:
Reid Klecknerfab1e892014-02-25 00:59:14 +00001566 if (retAI.getInAllocaSRet()) {
1567 // sret things on win32 aren't void, they return the sret pointer.
1568 QualType ret = FI.getReturnType();
1569 llvm::Type *ty = ConvertType(ret);
1570 unsigned addressSpace = Context.getTargetAddressSpace(ret);
1571 resultType = llvm::PointerType::get(ty, addressSpace);
1572 } else {
1573 resultType = llvm::Type::getVoidTy(getLLVMContext());
1574 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001575 break;
1576
John McCall7f416cc2015-09-08 08:05:57 +00001577 case ABIArgInfo::Indirect:
Daniel Dunbar94a6f252009-01-26 21:26:08 +00001578 case ABIArgInfo::Ignore:
John McCall85dd2c52011-05-15 02:19:42 +00001579 resultType = llvm::Type::getVoidTy(getLLVMContext());
Daniel Dunbar94a6f252009-01-26 21:26:08 +00001580 break;
John McCallf26e73d2016-03-11 04:30:43 +00001581
1582 case ABIArgInfo::CoerceAndExpand:
1583 resultType = retAI.getUnpaddedCoerceAndExpandType();
1584 break;
Daniel Dunbar7a95ca32008-09-10 04:01:49 +00001585 }
Mike Stump11289f42009-09-09 15:08:12 +00001586
Alexey Samsonov153004f2014-09-29 22:08:00 +00001587 ClangToLLVMArgMapping IRFunctionArgs(getContext(), FI, true);
1588 SmallVector<llvm::Type*, 8> ArgTypes(IRFunctionArgs.totalIRArgs());
1589
1590 // Add type for sret argument.
1591 if (IRFunctionArgs.hasSRetArg()) {
1592 QualType Ret = FI.getReturnType();
1593 llvm::Type *Ty = ConvertType(Ret);
1594 unsigned AddressSpace = Context.getTargetAddressSpace(Ret);
1595 ArgTypes[IRFunctionArgs.getSRetArgNo()] =
1596 llvm::PointerType::get(Ty, AddressSpace);
1597 }
1598
1599 // Add type for inalloca argument.
1600 if (IRFunctionArgs.hasInallocaArg()) {
1601 auto ArgStruct = FI.getArgStruct();
1602 assert(ArgStruct);
1603 ArgTypes[IRFunctionArgs.getInallocaArgNo()] = ArgStruct->getPointerTo();
1604 }
1605
John McCallc818bbb2012-12-07 07:03:17 +00001606 // Add in all of the required arguments.
Alexey Samsonov153004f2014-09-29 22:08:00 +00001607 unsigned ArgNo = 0;
Alexey Samsonov34625dd2014-09-29 21:21:48 +00001608 CGFunctionInfo::const_arg_iterator it = FI.arg_begin(),
1609 ie = it + FI.getNumRequiredArgs();
Alexey Samsonov153004f2014-09-29 22:08:00 +00001610 for (; it != ie; ++it, ++ArgNo) {
1611 const ABIArgInfo &ArgInfo = it->info;
Mike Stump11289f42009-09-09 15:08:12 +00001612
Rafael Espindolafad28de2012-10-24 01:59:00 +00001613 // Insert a padding type to ensure proper alignment.
Alexey Samsonov153004f2014-09-29 22:08:00 +00001614 if (IRFunctionArgs.hasPaddingArg(ArgNo))
1615 ArgTypes[IRFunctionArgs.getPaddingArgNo(ArgNo)] =
1616 ArgInfo.getPaddingType();
Rafael Espindolafad28de2012-10-24 01:59:00 +00001617
Alexey Samsonov153004f2014-09-29 22:08:00 +00001618 unsigned FirstIRArg, NumIRArgs;
1619 std::tie(FirstIRArg, NumIRArgs) = IRFunctionArgs.getIRArgs(ArgNo);
1620
1621 switch (ArgInfo.getKind()) {
Daniel Dunbar94a6f252009-01-26 21:26:08 +00001622 case ABIArgInfo::Ignore:
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001623 case ABIArgInfo::InAlloca:
Alexey Samsonov153004f2014-09-29 22:08:00 +00001624 assert(NumIRArgs == 0);
Daniel Dunbar94a6f252009-01-26 21:26:08 +00001625 break;
1626
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00001627 case ABIArgInfo::Indirect: {
Alexey Samsonov153004f2014-09-29 22:08:00 +00001628 assert(NumIRArgs == 1);
Yaxun Liud7523282017-04-17 20:10:44 +00001629 // indirect arguments are always on the stack, which is alloca addr space.
Chris Lattner2192fe52011-07-18 04:24:23 +00001630 llvm::Type *LTy = ConvertTypeForMem(it->type);
Yaxun Liud7523282017-04-17 20:10:44 +00001631 ArgTypes[FirstIRArg] = LTy->getPointerTo(
1632 CGM.getDataLayout().getAllocaAddrSpace());
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00001633 break;
1634 }
1635
1636 case ABIArgInfo::Extend:
Chris Lattner2cdfda42010-07-29 06:44:09 +00001637 case ABIArgInfo::Direct: {
Oliver Stannard2bfdc5b2014-08-27 10:43:15 +00001638 // Fast-isel and the optimizer generally like scalar values better than
1639 // FCAs, so we flatten them if this is safe to do for this argument.
Alexey Samsonov153004f2014-09-29 22:08:00 +00001640 llvm::Type *argType = ArgInfo.getCoerceToType();
James Molloy6f244b62014-05-09 16:21:39 +00001641 llvm::StructType *st = dyn_cast<llvm::StructType>(argType);
Alexey Samsonov153004f2014-09-29 22:08:00 +00001642 if (st && ArgInfo.isDirect() && ArgInfo.getCanBeFlattened()) {
1643 assert(NumIRArgs == st->getNumElements());
John McCall85dd2c52011-05-15 02:19:42 +00001644 for (unsigned i = 0, e = st->getNumElements(); i != e; ++i)
Alexey Samsonov153004f2014-09-29 22:08:00 +00001645 ArgTypes[FirstIRArg + i] = st->getElementType(i);
Chris Lattner3dd716c2010-06-28 23:44:11 +00001646 } else {
Alexey Samsonov153004f2014-09-29 22:08:00 +00001647 assert(NumIRArgs == 1);
1648 ArgTypes[FirstIRArg] = argType;
Chris Lattner3dd716c2010-06-28 23:44:11 +00001649 }
Daniel Dunbar2f219b02009-02-03 19:12:28 +00001650 break;
Chris Lattner2cdfda42010-07-29 06:44:09 +00001651 }
Mike Stump11289f42009-09-09 15:08:12 +00001652
John McCallf26e73d2016-03-11 04:30:43 +00001653 case ABIArgInfo::CoerceAndExpand: {
1654 auto ArgTypesIter = ArgTypes.begin() + FirstIRArg;
1655 for (auto EltTy : ArgInfo.getCoerceAndExpandTypeSequence()) {
1656 *ArgTypesIter++ = EltTy;
1657 }
1658 assert(ArgTypesIter == ArgTypes.begin() + FirstIRArg + NumIRArgs);
1659 break;
1660 }
1661
Daniel Dunbard3674e62008-09-11 01:48:57 +00001662 case ABIArgInfo::Expand:
Alexey Samsonov153004f2014-09-29 22:08:00 +00001663 auto ArgTypesIter = ArgTypes.begin() + FirstIRArg;
1664 getExpandedTypes(it->type, ArgTypesIter);
1665 assert(ArgTypesIter == ArgTypes.begin() + FirstIRArg + NumIRArgs);
Daniel Dunbard3674e62008-09-11 01:48:57 +00001666 break;
1667 }
Daniel Dunbar7a95ca32008-09-10 04:01:49 +00001668 }
1669
Chris Lattner6fb0ccf2011-07-15 05:16:14 +00001670 bool Erased = FunctionsBeingProcessed.erase(&FI); (void)Erased;
1671 assert(Erased && "Not in set?");
Alexey Samsonov153004f2014-09-29 22:08:00 +00001672
1673 return llvm::FunctionType::get(resultType, ArgTypes, FI.isVariadic());
Daniel Dunbar81cf67f2008-09-09 23:48:28 +00001674}
1675
Chris Lattner2192fe52011-07-18 04:24:23 +00001676llvm::Type *CodeGenTypes::GetFunctionTypeForVTable(GlobalDecl GD) {
John McCall5d865c322010-08-31 07:33:07 +00001677 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
Anders Carlsson64457732009-11-24 05:08:52 +00001678 const FunctionProtoType *FPT = MD->getType()->getAs<FunctionProtoType>();
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001679
Chris Lattner8806e322011-07-10 00:18:59 +00001680 if (!isFuncTypeConvertible(FPT))
1681 return llvm::StructType::get(getLLVMContext());
Fangrui Song6907ce22018-07-30 19:24:48 +00001682
Chris Lattner8806e322011-07-10 00:18:59 +00001683 const CGFunctionInfo *Info;
1684 if (isa<CXXDestructorDecl>(MD))
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001685 Info =
1686 &arrangeCXXStructorDeclaration(MD, getFromDtorType(GD.getDtorType()));
Chris Lattner8806e322011-07-10 00:18:59 +00001687 else
John McCalla729c622012-02-17 03:33:10 +00001688 Info = &arrangeCXXMethodDeclaration(MD);
1689 return GetFunctionType(*Info);
Anders Carlsson64457732009-11-24 05:08:52 +00001690}
1691
Samuel Antao798f11c2015-11-23 22:04:44 +00001692static void AddAttributesFromFunctionProtoType(ASTContext &Ctx,
1693 llvm::AttrBuilder &FuncAttrs,
1694 const FunctionProtoType *FPT) {
1695 if (!FPT)
1696 return;
1697
1698 if (!isUnresolvedExceptionSpec(FPT->getExceptionSpecType()) &&
Richard Smitheaf11ad2018-05-03 03:58:32 +00001699 FPT->isNothrow())
Samuel Antao798f11c2015-11-23 22:04:44 +00001700 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
1701}
1702
Justin Lebarb080b632017-01-25 21:29:48 +00001703void CodeGenModule::ConstructDefaultFnAttrList(StringRef Name, bool HasOptnone,
1704 bool AttrOnCallSite,
1705 llvm::AttrBuilder &FuncAttrs) {
1706 // OptimizeNoneAttr takes precedence over -Os or -Oz. No warning needed.
1707 if (!HasOptnone) {
1708 if (CodeGenOpts.OptimizeSize)
1709 FuncAttrs.addAttribute(llvm::Attribute::OptimizeForSize);
1710 if (CodeGenOpts.OptimizeSize == 2)
1711 FuncAttrs.addAttribute(llvm::Attribute::MinSize);
1712 }
1713
1714 if (CodeGenOpts.DisableRedZone)
1715 FuncAttrs.addAttribute(llvm::Attribute::NoRedZone);
Kristina Brooks7f569b72018-10-18 14:07:02 +00001716 if (CodeGenOpts.IndirectTlsSegRefs)
1717 FuncAttrs.addAttribute("indirect-tls-seg-refs");
Justin Lebarb080b632017-01-25 21:29:48 +00001718 if (CodeGenOpts.NoImplicitFloat)
1719 FuncAttrs.addAttribute(llvm::Attribute::NoImplicitFloat);
1720
1721 if (AttrOnCallSite) {
1722 // Attributes that should go on the call site only.
1723 if (!CodeGenOpts.SimplifyLibCalls ||
1724 CodeGenOpts.isNoBuiltinFunc(Name.data()))
1725 FuncAttrs.addAttribute(llvm::Attribute::NoBuiltin);
1726 if (!CodeGenOpts.TrapFuncName.empty())
1727 FuncAttrs.addAttribute("trap-func-name", CodeGenOpts.TrapFuncName);
1728 } else {
1729 // Attributes that should go on the function, but not the call site.
1730 if (!CodeGenOpts.DisableFPElim) {
1731 FuncAttrs.addAttribute("no-frame-pointer-elim", "false");
1732 } else if (CodeGenOpts.OmitLeafFramePointer) {
1733 FuncAttrs.addAttribute("no-frame-pointer-elim", "false");
1734 FuncAttrs.addAttribute("no-frame-pointer-elim-non-leaf");
1735 } else {
1736 FuncAttrs.addAttribute("no-frame-pointer-elim", "true");
1737 FuncAttrs.addAttribute("no-frame-pointer-elim-non-leaf");
1738 }
1739
1740 FuncAttrs.addAttribute("less-precise-fpmad",
1741 llvm::toStringRef(CodeGenOpts.LessPreciseFPMAD));
1742
Manoj Guptada08f6a2018-07-19 00:44:52 +00001743 if (CodeGenOpts.NullPointerIsValid)
1744 FuncAttrs.addAttribute("null-pointer-is-valid", "true");
Justin Lebarb080b632017-01-25 21:29:48 +00001745 if (!CodeGenOpts.FPDenormalMode.empty())
1746 FuncAttrs.addAttribute("denormal-fp-math", CodeGenOpts.FPDenormalMode);
1747
1748 FuncAttrs.addAttribute("no-trapping-math",
1749 llvm::toStringRef(CodeGenOpts.NoTrappingMath));
1750
Sanjay Patelc81450e2018-04-30 18:19:03 +00001751 // Strict (compliant) code is the default, so only add this attribute to
1752 // indicate that we are trying to workaround a problem case.
1753 if (!CodeGenOpts.StrictFloatCastOverflow)
1754 FuncAttrs.addAttribute("strict-float-cast-overflow", "false");
Sanjay Pateld1754762018-04-27 14:22:48 +00001755
Justin Lebarb080b632017-01-25 21:29:48 +00001756 // TODO: Are these all needed?
1757 // unsafe/inf/nan/nsz are handled by instruction-level FastMathFlags.
1758 FuncAttrs.addAttribute("no-infs-fp-math",
1759 llvm::toStringRef(CodeGenOpts.NoInfsFPMath));
1760 FuncAttrs.addAttribute("no-nans-fp-math",
1761 llvm::toStringRef(CodeGenOpts.NoNaNsFPMath));
1762 FuncAttrs.addAttribute("unsafe-fp-math",
1763 llvm::toStringRef(CodeGenOpts.UnsafeFPMath));
1764 FuncAttrs.addAttribute("use-soft-float",
1765 llvm::toStringRef(CodeGenOpts.SoftFloat));
1766 FuncAttrs.addAttribute("stack-protector-buffer-size",
1767 llvm::utostr(CodeGenOpts.SSPBufferSize));
1768 FuncAttrs.addAttribute("no-signed-zeros-fp-math",
1769 llvm::toStringRef(CodeGenOpts.NoSignedZeros));
1770 FuncAttrs.addAttribute(
1771 "correctly-rounded-divide-sqrt-fp-math",
1772 llvm::toStringRef(CodeGenOpts.CorrectlyRoundedDivSqrt));
1773
Alexey Sotkin3858e262018-04-20 08:08:04 +00001774 if (getLangOpts().OpenCL)
1775 FuncAttrs.addAttribute("denorms-are-zero",
1776 llvm::toStringRef(CodeGenOpts.FlushDenorm));
1777
Justin Lebarb080b632017-01-25 21:29:48 +00001778 // TODO: Reciprocal estimate codegen options should apply to instructions?
Craig Topper402b4312017-11-20 17:09:22 +00001779 const std::vector<std::string> &Recips = CodeGenOpts.Reciprocals;
Justin Lebarb080b632017-01-25 21:29:48 +00001780 if (!Recips.empty())
1781 FuncAttrs.addAttribute("reciprocal-estimates",
Erich Keane857ac592017-10-27 18:45:06 +00001782 llvm::join(Recips, ","));
Justin Lebarb080b632017-01-25 21:29:48 +00001783
Craig Topper9a724aa2017-12-11 21:09:19 +00001784 if (!CodeGenOpts.PreferVectorWidth.empty() &&
1785 CodeGenOpts.PreferVectorWidth != "none")
1786 FuncAttrs.addAttribute("prefer-vector-width",
1787 CodeGenOpts.PreferVectorWidth);
1788
Justin Lebarb080b632017-01-25 21:29:48 +00001789 if (CodeGenOpts.StackRealignment)
1790 FuncAttrs.addAttribute("stackrealign");
1791 if (CodeGenOpts.Backchain)
1792 FuncAttrs.addAttribute("backchain");
Chandler Carruth664aa862018-09-04 12:38:00 +00001793
Zola Bridgescbac3ad2018-11-27 19:56:46 +00001794 // FIXME: The interaction of this attribute with the SLH command line flag
1795 // has not been determined.
Chandler Carruth664aa862018-09-04 12:38:00 +00001796 if (CodeGenOpts.SpeculativeLoadHardening)
1797 FuncAttrs.addAttribute(llvm::Attribute::SpeculativeLoadHardening);
Justin Lebarb080b632017-01-25 21:29:48 +00001798 }
1799
Matt Arsenaulta1cf61b2017-10-06 19:34:40 +00001800 if (getLangOpts().assumeFunctionsAreConvergent()) {
1801 // Conservatively, mark all functions and calls in CUDA and OpenCL as
1802 // convergent (meaning, they may call an intrinsically convergent op, such
1803 // as __syncthreads() / barrier(), and so can't have certain optimizations
1804 // applied around them). LLVM will remove this attribute where it safely
1805 // can.
Justin Lebarb080b632017-01-25 21:29:48 +00001806 FuncAttrs.addAttribute(llvm::Attribute::Convergent);
Matt Arsenaulta1cf61b2017-10-06 19:34:40 +00001807 }
Justin Lebarb080b632017-01-25 21:29:48 +00001808
Matt Arsenaulta1cf61b2017-10-06 19:34:40 +00001809 if (getLangOpts().CUDA && getLangOpts().CUDAIsDevice) {
Justin Lebarb080b632017-01-25 21:29:48 +00001810 // Exceptions aren't supported in CUDA device code.
1811 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
1812
1813 // Respect -fcuda-flush-denormals-to-zero.
Yaxun Liue1bfbc52018-07-21 02:02:22 +00001814 if (CodeGenOpts.FlushDenorm)
Justin Lebarb080b632017-01-25 21:29:48 +00001815 FuncAttrs.addAttribute("nvptx-f32ftz", "true");
1816 }
1817}
1818
1819void CodeGenModule::AddDefaultFnAttrs(llvm::Function &F) {
1820 llvm::AttrBuilder FuncAttrs;
1821 ConstructDefaultFnAttrList(F.getName(),
1822 F.hasFnAttribute(llvm::Attribute::OptimizeNone),
1823 /* AttrOnCallsite = */ false, FuncAttrs);
Reid Kleckneree4930b2017-05-02 22:07:37 +00001824 F.addAttributes(llvm::AttributeList::FunctionIndex, FuncAttrs);
Justin Lebarb080b632017-01-25 21:29:48 +00001825}
1826
Chad Rosier7dbc9cf2016-01-06 14:35:46 +00001827void CodeGenModule::ConstructAttributeList(
1828 StringRef Name, const CGFunctionInfo &FI, CGCalleeInfo CalleeInfo,
Reid Klecknercdd26792017-04-18 23:50:03 +00001829 llvm::AttributeList &AttrList, unsigned &CallingConv, bool AttrOnCallSite) {
Bill Wendlinga514ebc2012-10-15 20:36:26 +00001830 llvm::AttrBuilder FuncAttrs;
1831 llvm::AttrBuilder RetAttrs;
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00001832
Daniel Dunbar0ef34792009-09-12 00:59:20 +00001833 CallingConv = FI.getEffectiveCallingConvention();
John McCallab26cfa2010-02-05 21:31:56 +00001834 if (FI.isNoReturn())
Bill Wendling207f0532012-12-20 19:27:06 +00001835 FuncAttrs.addAttribute(llvm::Attribute::NoReturn);
John McCallab26cfa2010-02-05 21:31:56 +00001836
Samuel Antao798f11c2015-11-23 22:04:44 +00001837 // If we have information about the function prototype, we can learn
Craig Topper13d759f2018-04-30 22:02:48 +00001838 // attributes from there.
Samuel Antao798f11c2015-11-23 22:04:44 +00001839 AddAttributesFromFunctionProtoType(getContext(), FuncAttrs,
1840 CalleeInfo.getCalleeFunctionProtoType());
1841
Erich Keanede6480a32018-11-13 15:48:08 +00001842 const Decl *TargetDecl = CalleeInfo.getCalleeDecl().getDecl();
Samuel Antao798f11c2015-11-23 22:04:44 +00001843
Justin Lebarb080b632017-01-25 21:29:48 +00001844 bool HasOptnone = false;
Anton Korobeynikovc8478242009-04-04 00:49:24 +00001845 // FIXME: handle sseregparm someday...
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00001846 if (TargetDecl) {
Rafael Espindola2d21ab02011-10-12 19:51:18 +00001847 if (TargetDecl->hasAttr<ReturnsTwiceAttr>())
Bill Wendling207f0532012-12-20 19:27:06 +00001848 FuncAttrs.addAttribute(llvm::Attribute::ReturnsTwice);
Argyrios Kyrtzidisb4b64ca2009-06-30 02:34:44 +00001849 if (TargetDecl->hasAttr<NoThrowAttr>())
Bill Wendling207f0532012-12-20 19:27:06 +00001850 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
Richard Smithdebc59d2013-01-30 05:45:05 +00001851 if (TargetDecl->hasAttr<NoReturnAttr>())
1852 FuncAttrs.addAttribute(llvm::Attribute::NoReturn);
Xinliang David Li4ec36062017-06-13 21:14:07 +00001853 if (TargetDecl->hasAttr<ColdAttr>())
1854 FuncAttrs.addAttribute(llvm::Attribute::Cold);
Aaron Ballman7c19ab12014-02-22 16:59:24 +00001855 if (TargetDecl->hasAttr<NoDuplicateAttr>())
1856 FuncAttrs.addAttribute(llvm::Attribute::NoDuplicate);
Yaxun Liu7d07ae72016-11-01 18:45:32 +00001857 if (TargetDecl->hasAttr<ConvergentAttr>())
1858 FuncAttrs.addAttribute(llvm::Attribute::Convergent);
Zola Bridgescbac3ad2018-11-27 19:56:46 +00001859 if (TargetDecl->hasAttr<SpeculativeLoadHardeningAttr>())
1860 FuncAttrs.addAttribute(llvm::Attribute::SpeculativeLoadHardening);
Richard Smithdebc59d2013-01-30 05:45:05 +00001861
Chandler Carruth45bbe012017-03-24 09:11:57 +00001862 if (const FunctionDecl *Fn = dyn_cast<FunctionDecl>(TargetDecl)) {
Samuel Antao798f11c2015-11-23 22:04:44 +00001863 AddAttributesFromFunctionProtoType(
Chandler Carruth45bbe012017-03-24 09:11:57 +00001864 getContext(), FuncAttrs, Fn->getType()->getAs<FunctionProtoType>());
Richard Smith49af6292013-03-05 08:30:04 +00001865 // Don't use [[noreturn]] or _Noreturn for a call to a virtual function.
1866 // These attributes are not inherited by overloads.
Chandler Carruth45bbe012017-03-24 09:11:57 +00001867 const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(Fn);
1868 if (Fn->isNoReturn() && !(AttrOnCallSite && MD && MD->isVirtual()))
Richard Smithdebc59d2013-01-30 05:45:05 +00001869 FuncAttrs.addAttribute(llvm::Attribute::NoReturn);
John McCallbe349de2010-07-08 06:48:12 +00001870 }
1871
David Majnemer1bf0f8e2015-07-20 22:51:52 +00001872 // 'const', 'pure' and 'noalias' attributed functions are also nounwind.
Eric Christopherbf005ec2011-08-15 22:38:22 +00001873 if (TargetDecl->hasAttr<ConstAttr>()) {
Bill Wendling207f0532012-12-20 19:27:06 +00001874 FuncAttrs.addAttribute(llvm::Attribute::ReadNone);
1875 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
Eric Christopherbf005ec2011-08-15 22:38:22 +00001876 } else if (TargetDecl->hasAttr<PureAttr>()) {
Bill Wendling207f0532012-12-20 19:27:06 +00001877 FuncAttrs.addAttribute(llvm::Attribute::ReadOnly);
1878 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
David Majnemer1bf0f8e2015-07-20 22:51:52 +00001879 } else if (TargetDecl->hasAttr<NoAliasAttr>()) {
1880 FuncAttrs.addAttribute(llvm::Attribute::ArgMemOnly);
1881 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
Eric Christopherbf005ec2011-08-15 22:38:22 +00001882 }
David Majnemer631a90b2015-02-04 07:23:21 +00001883 if (TargetDecl->hasAttr<RestrictAttr>())
Bill Wendling207f0532012-12-20 19:27:06 +00001884 RetAttrs.addAttribute(llvm::Attribute::NoAlias);
Manoj Guptada08f6a2018-07-19 00:44:52 +00001885 if (TargetDecl->hasAttr<ReturnsNonNullAttr>() &&
1886 !CodeGenOpts.NullPointerIsValid)
Hal Finkeld8442b12014-07-12 04:51:04 +00001887 RetAttrs.addAttribute(llvm::Attribute::NonNull);
Oren Ben Simhon318a6ea2017-04-27 12:01:00 +00001888 if (TargetDecl->hasAttr<AnyX86NoCallerSavedRegistersAttr>())
1889 FuncAttrs.addAttribute("no_caller_saved_registers");
Oren Ben Simhon220671a2018-03-17 13:31:35 +00001890 if (TargetDecl->hasAttr<AnyX86NoCfCheckAttr>())
1891 FuncAttrs.addAttribute(llvm::Attribute::NoCfCheck);
Paul Robinson08556952014-12-11 20:14:04 +00001892
1893 HasOptnone = TargetDecl->hasAttr<OptimizeNoneAttr>();
George Burgess IVe3763372016-12-22 02:50:20 +00001894 if (auto *AllocSize = TargetDecl->getAttr<AllocSizeAttr>()) {
1895 Optional<unsigned> NumElemsParam;
Joel E. Denny81508102018-03-13 14:51:22 +00001896 if (AllocSize->getNumElemsParam().isValid())
1897 NumElemsParam = AllocSize->getNumElemsParam().getLLVMIndex();
1898 FuncAttrs.addAllocSizeAttr(AllocSize->getElemSizeParam().getLLVMIndex(),
George Burgess IVe3763372016-12-22 02:50:20 +00001899 NumElemsParam);
1900 }
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00001901 }
1902
Justin Lebarb080b632017-01-25 21:29:48 +00001903 ConstructDefaultFnAttrList(Name, HasOptnone, AttrOnCallSite, FuncAttrs);
Paul Robinson08556952014-12-11 20:14:04 +00001904
Peter Collingbourneb4728c12014-05-19 22:14:34 +00001905 if (CodeGenOpts.EnableSegmentedStacks &&
1906 !(TargetDecl && TargetDecl->hasAttr<NoSplitStackAttr>()))
Reid Klecknerfb873af2014-04-10 22:59:13 +00001907 FuncAttrs.addAttribute("split-stack");
Devang Patel6e467b12009-06-04 23:32:02 +00001908
Sriraman Tallam5c651482017-11-07 19:37:51 +00001909 // Add NonLazyBind attribute to function declarations when -fno-plt
1910 // is used.
1911 if (TargetDecl && CodeGenOpts.NoPLT) {
1912 if (auto *Fn = dyn_cast<FunctionDecl>(TargetDecl)) {
1913 if (!Fn->isDefined() && !AttrOnCallSite) {
1914 FuncAttrs.addAttribute(llvm::Attribute::NonLazyBind);
1915 }
1916 }
1917 }
1918
Alexey Sotkin20f65922018-02-22 11:54:14 +00001919 if (TargetDecl && TargetDecl->hasAttr<OpenCLKernelAttr>()) {
1920 if (getLangOpts().OpenCLVersion <= 120) {
1921 // OpenCL v1.2 Work groups are always uniform
1922 FuncAttrs.addAttribute("uniform-work-group-size", "true");
1923 } else {
1924 // OpenCL v2.0 Work groups may be whether uniform or not.
1925 // '-cl-uniform-work-group-size' compile option gets a hint
1926 // to the compiler that the global work-size be a multiple of
1927 // the work-group size specified to clEnqueueNDRangeKernel
1928 // (i.e. work groups are uniform).
1929 FuncAttrs.addAttribute("uniform-work-group-size",
1930 llvm::toStringRef(CodeGenOpts.UniformWGSize));
1931 }
1932 }
1933
Justin Lebarb080b632017-01-25 21:29:48 +00001934 if (!AttrOnCallSite) {
Akira Hatanaka627586b2018-03-02 01:53:15 +00001935 bool DisableTailCalls = false;
1936
1937 if (CodeGenOpts.DisableTailCalls)
1938 DisableTailCalls = true;
1939 else if (TargetDecl) {
1940 if (TargetDecl->hasAttr<DisableTailCallsAttr>() ||
1941 TargetDecl->hasAttr<AnyX86InterruptAttr>())
1942 DisableTailCalls = true;
1943 else if (CodeGenOpts.NoEscapingBlockTailCalls) {
1944 if (const auto *BD = dyn_cast<BlockDecl>(TargetDecl))
1945 if (!BD->doesNotEscape())
1946 DisableTailCalls = true;
1947 }
1948 }
1949
Justin Lebarb080b632017-01-25 21:29:48 +00001950 FuncAttrs.addAttribute("disable-tail-calls",
1951 llvm::toStringRef(DisableTailCalls));
Erich Keanede6480a32018-11-13 15:48:08 +00001952 GetCPUAndFeaturesAttributes(CalleeInfo.getCalleeDecl(), FuncAttrs);
Bill Wendling985d1c52013-02-15 21:30:01 +00001953 }
1954
Alexey Samsonov153004f2014-09-29 22:08:00 +00001955 ClangToLLVMArgMapping IRFunctionArgs(getContext(), FI);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00001956
Daniel Dunbar3668cb22009-02-02 23:43:58 +00001957 QualType RetTy = FI.getReturnType();
Daniel Dunbarb52d0772009-02-03 05:59:18 +00001958 const ABIArgInfo &RetAI = FI.getReturnInfo();
Daniel Dunbar7a95ca32008-09-10 04:01:49 +00001959 switch (RetAI.getKind()) {
Anton Korobeynikov18adbf52009-06-06 09:36:29 +00001960 case ABIArgInfo::Extend:
Alex Bradburye41a5e22018-01-12 20:08:16 +00001961 if (RetAI.isSignExt())
Jakob Stoklund Olesend7bf2932013-05-29 03:57:23 +00001962 RetAttrs.addAttribute(llvm::Attribute::SExt);
Alex Bradburye41a5e22018-01-12 20:08:16 +00001963 else
Jakob Stoklund Olesend7bf2932013-05-29 03:57:23 +00001964 RetAttrs.addAttribute(llvm::Attribute::ZExt);
Adrian Prantlf3b3ccd2017-12-19 22:06:11 +00001965 LLVM_FALLTHROUGH;
Daniel Dunbar67dace892009-02-03 06:17:37 +00001966 case ABIArgInfo::Direct:
Jakob Stoklund Olesena3661142013-06-05 03:00:09 +00001967 if (RetAI.getInReg())
1968 RetAttrs.addAttribute(llvm::Attribute::InReg);
1969 break;
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00001970 case ABIArgInfo::Ignore:
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00001971 break;
1972
Alexey Samsonov91cf4552014-08-22 01:06:06 +00001973 case ABIArgInfo::InAlloca:
Rafael Espindola06b2b4a2012-07-31 02:44:24 +00001974 case ABIArgInfo::Indirect: {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00001975 // inalloca and sret disable readnone and readonly
Bill Wendling207f0532012-12-20 19:27:06 +00001976 FuncAttrs.removeAttribute(llvm::Attribute::ReadOnly)
1977 .removeAttribute(llvm::Attribute::ReadNone);
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00001978 break;
Rafael Espindola06b2b4a2012-07-31 02:44:24 +00001979 }
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00001980
John McCallf26e73d2016-03-11 04:30:43 +00001981 case ABIArgInfo::CoerceAndExpand:
1982 break;
1983
Daniel Dunbard3674e62008-09-11 01:48:57 +00001984 case ABIArgInfo::Expand:
David Blaikie83d382b2011-09-23 05:06:16 +00001985 llvm_unreachable("Invalid ABI kind for return argument");
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00001986 }
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00001987
Hal Finkela2347ba2014-07-18 15:52:10 +00001988 if (const auto *RefTy = RetTy->getAs<ReferenceType>()) {
1989 QualType PTy = RefTy->getPointeeType();
David Majnemer9df56372015-09-10 21:52:00 +00001990 if (!PTy->isIncompleteType() && PTy->isConstantSizeType())
Hal Finkela2347ba2014-07-18 15:52:10 +00001991 RetAttrs.addDereferenceableAttr(getContext().getTypeSizeInChars(PTy)
1992 .getQuantity());
Manoj Guptada08f6a2018-07-19 00:44:52 +00001993 else if (getContext().getTargetAddressSpace(PTy) == 0 &&
1994 !CodeGenOpts.NullPointerIsValid)
Hal Finkela2347ba2014-07-18 15:52:10 +00001995 RetAttrs.addAttribute(llvm::Attribute::NonNull);
1996 }
Nick Lewycky9b46eb82014-05-28 09:56:42 +00001997
John McCall12f23522016-04-04 18:33:08 +00001998 bool hasUsedSRet = false;
Reid Klecknercdd26792017-04-18 23:50:03 +00001999 SmallVector<llvm::AttributeSet, 4> ArgAttrs(IRFunctionArgs.totalIRArgs());
John McCall12f23522016-04-04 18:33:08 +00002000
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002001 // Attach attributes to sret.
2002 if (IRFunctionArgs.hasSRetArg()) {
2003 llvm::AttrBuilder SRETAttrs;
Mandeep Singh Grang2a153102018-07-26 18:07:59 +00002004 if (!RetAI.getSuppressSRet())
2005 SRETAttrs.addAttribute(llvm::Attribute::StructRet);
John McCall12f23522016-04-04 18:33:08 +00002006 hasUsedSRet = true;
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002007 if (RetAI.getInReg())
2008 SRETAttrs.addAttribute(llvm::Attribute::InReg);
Reid Klecknercdd26792017-04-18 23:50:03 +00002009 ArgAttrs[IRFunctionArgs.getSRetArgNo()] =
2010 llvm::AttributeSet::get(getLLVMContext(), SRETAttrs);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002011 }
2012
2013 // Attach attributes to inalloca argument.
2014 if (IRFunctionArgs.hasInallocaArg()) {
2015 llvm::AttrBuilder Attrs;
2016 Attrs.addAttribute(llvm::Attribute::InAlloca);
Reid Klecknercdd26792017-04-18 23:50:03 +00002017 ArgAttrs[IRFunctionArgs.getInallocaArgNo()] =
2018 llvm::AttributeSet::get(getLLVMContext(), Attrs);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002019 }
2020
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002021 unsigned ArgNo = 0;
2022 for (CGFunctionInfo::const_arg_iterator I = FI.arg_begin(),
2023 E = FI.arg_end();
2024 I != E; ++I, ++ArgNo) {
2025 QualType ParamType = I->type;
2026 const ABIArgInfo &AI = I->info;
Bill Wendlinga514ebc2012-10-15 20:36:26 +00002027 llvm::AttrBuilder Attrs;
Anton Korobeynikovc8478242009-04-04 00:49:24 +00002028
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002029 // Add attribute for padding argument, if necessary.
2030 if (IRFunctionArgs.hasPaddingArg(ArgNo)) {
Reid Klecknercdd26792017-04-18 23:50:03 +00002031 if (AI.getPaddingInReg()) {
2032 ArgAttrs[IRFunctionArgs.getPaddingArgNo(ArgNo)] =
2033 llvm::AttributeSet::get(
2034 getLLVMContext(),
2035 llvm::AttrBuilder().addAttribute(llvm::Attribute::InReg));
2036 }
Rafael Espindolafad28de2012-10-24 01:59:00 +00002037 }
2038
John McCall39ec71f2010-03-27 00:47:27 +00002039 // 'restrict' -> 'noalias' is done in EmitFunctionProlog when we
2040 // have the corresponding parameter variable. It doesn't make
Daniel Dunbarcb2b3d02011-02-10 18:10:07 +00002041 // sense to do it here because parameters are so messed up.
Daniel Dunbard3674e62008-09-11 01:48:57 +00002042 switch (AI.getKind()) {
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002043 case ABIArgInfo::Extend:
Alex Bradburye41a5e22018-01-12 20:08:16 +00002044 if (AI.isSignExt())
Bill Wendling207f0532012-12-20 19:27:06 +00002045 Attrs.addAttribute(llvm::Attribute::SExt);
Alex Bradburye41a5e22018-01-12 20:08:16 +00002046 else
2047 Attrs.addAttribute(llvm::Attribute::ZExt);
Adrian Prantlf3b3ccd2017-12-19 22:06:11 +00002048 LLVM_FALLTHROUGH;
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002049 case ABIArgInfo::Direct:
Peter Collingbournef7706832014-12-12 23:41:25 +00002050 if (ArgNo == 0 && FI.isChainCall())
2051 Attrs.addAttribute(llvm::Attribute::Nest);
2052 else if (AI.getInReg())
Bill Wendling207f0532012-12-20 19:27:06 +00002053 Attrs.addAttribute(llvm::Attribute::InReg);
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002054 break;
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002055
James Y Knight71608572015-08-21 18:19:06 +00002056 case ABIArgInfo::Indirect: {
Rafael Espindola703c47f2012-10-19 05:04:37 +00002057 if (AI.getInReg())
Bill Wendling207f0532012-12-20 19:27:06 +00002058 Attrs.addAttribute(llvm::Attribute::InReg);
Rafael Espindola703c47f2012-10-19 05:04:37 +00002059
Anders Carlsson20759ad2009-09-16 15:53:40 +00002060 if (AI.getIndirectByVal())
Bill Wendling207f0532012-12-20 19:27:06 +00002061 Attrs.addAttribute(llvm::Attribute::ByVal);
Anders Carlsson20759ad2009-09-16 15:53:40 +00002062
John McCall7f416cc2015-09-08 08:05:57 +00002063 CharUnits Align = AI.getIndirectAlign();
James Y Knight71608572015-08-21 18:19:06 +00002064
2065 // In a byval argument, it is important that the required
2066 // alignment of the type is honored, as LLVM might be creating a
2067 // *new* stack object, and needs to know what alignment to give
2068 // it. (Sometimes it can deduce a sensible alignment on its own,
2069 // but not if clang decides it must emit a packed struct, or the
2070 // user specifies increased alignment requirements.)
2071 //
2072 // This is different from indirect *not* byval, where the object
2073 // exists already, and the align attribute is purely
2074 // informative.
John McCall7f416cc2015-09-08 08:05:57 +00002075 assert(!Align.isZero());
James Y Knight71608572015-08-21 18:19:06 +00002076
John McCall7f416cc2015-09-08 08:05:57 +00002077 // For now, only add this when we have a byval argument.
2078 // TODO: be less lazy about updating test cases.
2079 if (AI.getIndirectByVal())
2080 Attrs.addAlignmentAttr(Align.getQuantity());
Bill Wendlinga7912f82012-10-10 07:36:56 +00002081
Daniel Dunbarc2304432009-03-18 19:51:01 +00002082 // byval disables readnone and readonly.
Bill Wendling207f0532012-12-20 19:27:06 +00002083 FuncAttrs.removeAttribute(llvm::Attribute::ReadOnly)
2084 .removeAttribute(llvm::Attribute::ReadNone);
Daniel Dunbard3674e62008-09-11 01:48:57 +00002085 break;
James Y Knight71608572015-08-21 18:19:06 +00002086 }
Daniel Dunbar94a6f252009-01-26 21:26:08 +00002087 case ABIArgInfo::Ignore:
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002088 case ABIArgInfo::Expand:
John McCallf26e73d2016-03-11 04:30:43 +00002089 case ABIArgInfo::CoerceAndExpand:
2090 break;
Daniel Dunbar94a6f252009-01-26 21:26:08 +00002091
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002092 case ABIArgInfo::InAlloca:
2093 // inalloca disables readnone and readonly.
2094 FuncAttrs.removeAttribute(llvm::Attribute::ReadOnly)
2095 .removeAttribute(llvm::Attribute::ReadNone);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002096 continue;
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00002097 }
Mike Stump11289f42009-09-09 15:08:12 +00002098
Hal Finkela2347ba2014-07-18 15:52:10 +00002099 if (const auto *RefTy = ParamType->getAs<ReferenceType>()) {
2100 QualType PTy = RefTy->getPointeeType();
David Majnemer9df56372015-09-10 21:52:00 +00002101 if (!PTy->isIncompleteType() && PTy->isConstantSizeType())
Hal Finkela2347ba2014-07-18 15:52:10 +00002102 Attrs.addDereferenceableAttr(getContext().getTypeSizeInChars(PTy)
2103 .getQuantity());
Manoj Guptada08f6a2018-07-19 00:44:52 +00002104 else if (getContext().getTargetAddressSpace(PTy) == 0 &&
2105 !CodeGenOpts.NullPointerIsValid)
Hal Finkela2347ba2014-07-18 15:52:10 +00002106 Attrs.addAttribute(llvm::Attribute::NonNull);
2107 }
Nick Lewycky9b46eb82014-05-28 09:56:42 +00002108
John McCall12f23522016-04-04 18:33:08 +00002109 switch (FI.getExtParameterInfo(ArgNo).getABI()) {
2110 case ParameterABI::Ordinary:
2111 break;
2112
2113 case ParameterABI::SwiftIndirectResult: {
2114 // Add 'sret' if we haven't already used it for something, but
2115 // only if the result is void.
2116 if (!hasUsedSRet && RetTy->isVoidType()) {
2117 Attrs.addAttribute(llvm::Attribute::StructRet);
2118 hasUsedSRet = true;
2119 }
2120
2121 // Add 'noalias' in either case.
2122 Attrs.addAttribute(llvm::Attribute::NoAlias);
2123
2124 // Add 'dereferenceable' and 'alignment'.
2125 auto PTy = ParamType->getPointeeType();
2126 if (!PTy->isIncompleteType() && PTy->isConstantSizeType()) {
2127 auto info = getContext().getTypeInfoInChars(PTy);
2128 Attrs.addDereferenceableAttr(info.first.getQuantity());
2129 Attrs.addAttribute(llvm::Attribute::getWithAlignment(getLLVMContext(),
2130 info.second.getQuantity()));
2131 }
2132 break;
2133 }
2134
2135 case ParameterABI::SwiftErrorResult:
2136 Attrs.addAttribute(llvm::Attribute::SwiftError);
2137 break;
2138
2139 case ParameterABI::SwiftContext:
2140 Attrs.addAttribute(llvm::Attribute::SwiftSelf);
2141 break;
2142 }
2143
Akira Hatanaka98a49332017-09-22 00:41:05 +00002144 if (FI.getExtParameterInfo(ArgNo).isNoEscape())
2145 Attrs.addAttribute(llvm::Attribute::NoCapture);
2146
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002147 if (Attrs.hasAttributes()) {
2148 unsigned FirstIRArg, NumIRArgs;
2149 std::tie(FirstIRArg, NumIRArgs) = IRFunctionArgs.getIRArgs(ArgNo);
2150 for (unsigned i = 0; i < NumIRArgs; i++)
Reid Klecknercdd26792017-04-18 23:50:03 +00002151 ArgAttrs[FirstIRArg + i] =
2152 llvm::AttributeSet::get(getLLVMContext(), Attrs);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002153 }
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00002154 }
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002155 assert(ArgNo == FI.arg_size());
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002156
Reid Klecknercdd26792017-04-18 23:50:03 +00002157 AttrList = llvm::AttributeList::get(
2158 getLLVMContext(), llvm::AttributeSet::get(getLLVMContext(), FuncAttrs),
2159 llvm::AttributeSet::get(getLLVMContext(), RetAttrs), ArgAttrs);
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00002160}
2161
John McCalla738c252011-03-09 04:27:21 +00002162/// An argument came in as a promoted argument; demote it back to its
2163/// declared type.
2164static llvm::Value *emitArgumentDemotion(CodeGenFunction &CGF,
2165 const VarDecl *var,
2166 llvm::Value *value) {
Chris Lattner2192fe52011-07-18 04:24:23 +00002167 llvm::Type *varType = CGF.ConvertType(var->getType());
John McCalla738c252011-03-09 04:27:21 +00002168
2169 // This can happen with promotions that actually don't change the
2170 // underlying type, like the enum promotions.
2171 if (value->getType() == varType) return value;
2172
2173 assert((varType->isIntegerTy() || varType->isFloatingPointTy())
2174 && "unexpected promotion type");
2175
2176 if (isa<llvm::IntegerType>(varType))
2177 return CGF.Builder.CreateTrunc(value, varType, "arg.unpromote");
2178
2179 return CGF.Builder.CreateFPCast(value, varType, "arg.unpromote");
2180}
2181
Chandler Carruth45bbe012017-03-24 09:11:57 +00002182/// Returns the attribute (either parameter attribute, or function
2183/// attribute), which declares argument ArgNo to be non-null.
2184static const NonNullAttr *getNonNullAttr(const Decl *FD, const ParmVarDecl *PVD,
2185 QualType ArgType, unsigned ArgNo) {
2186 // FIXME: __attribute__((nonnull)) can also be applied to:
2187 // - references to pointers, where the pointee is known to be
2188 // nonnull (apparently a Clang extension)
2189 // - transparent unions containing pointers
2190 // In the former case, LLVM IR cannot represent the constraint. In
2191 // the latter case, we have no guarantee that the transparent union
2192 // is in fact passed as a pointer.
2193 if (!ArgType->isAnyPointerType() && !ArgType->isBlockPointerType())
2194 return nullptr;
2195 // First, check attribute on parameter itself.
2196 if (PVD) {
2197 if (auto ParmNNAttr = PVD->getAttr<NonNullAttr>())
2198 return ParmNNAttr;
2199 }
2200 // Check function attributes.
2201 if (!FD)
2202 return nullptr;
2203 for (const auto *NNAttr : FD->specific_attrs<NonNullAttr>()) {
2204 if (NNAttr->isNonNull(ArgNo))
2205 return NNAttr;
2206 }
2207 return nullptr;
2208}
2209
John McCall12f23522016-04-04 18:33:08 +00002210namespace {
2211 struct CopyBackSwiftError final : EHScopeStack::Cleanup {
2212 Address Temp;
2213 Address Arg;
2214 CopyBackSwiftError(Address temp, Address arg) : Temp(temp), Arg(arg) {}
2215 void Emit(CodeGenFunction &CGF, Flags flags) override {
2216 llvm::Value *errorValue = CGF.Builder.CreateLoad(Temp);
2217 CGF.Builder.CreateStore(errorValue, Arg);
2218 }
2219 };
2220}
2221
Daniel Dunbard931a872009-02-02 22:03:45 +00002222void CodeGenFunction::EmitFunctionProlog(const CGFunctionInfo &FI,
2223 llvm::Function *Fn,
Daniel Dunbar613855c2008-09-09 23:27:19 +00002224 const FunctionArgList &Args) {
Hans Wennborgd71907d2014-09-04 22:16:33 +00002225 if (CurCodeDecl && CurCodeDecl->hasAttr<NakedAttr>())
2226 // Naked functions don't have prologues.
2227 return;
2228
John McCallcaa19452009-07-28 01:00:58 +00002229 // If this is an implicit-return-zero function, go ahead and
2230 // initialize the return value. TODO: it might be nice to have
2231 // a more general mechanism for this that didn't require synthesized
2232 // return statements.
John McCalldec348f72013-05-03 07:33:41 +00002233 if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(CurCodeDecl)) {
John McCallcaa19452009-07-28 01:00:58 +00002234 if (FD->hasImplicitReturnZero()) {
Alp Toker314cc812014-01-25 16:55:45 +00002235 QualType RetTy = FD->getReturnType().getUnqualifiedType();
Chris Lattner2192fe52011-07-18 04:24:23 +00002236 llvm::Type* LLVMTy = CGM.getTypes().ConvertType(RetTy);
Owen Anderson0b75f232009-07-31 20:28:54 +00002237 llvm::Constant* Zero = llvm::Constant::getNullValue(LLVMTy);
John McCallcaa19452009-07-28 01:00:58 +00002238 Builder.CreateStore(Zero, ReturnValue);
2239 }
2240 }
2241
Mike Stump18bb9282009-05-16 07:57:57 +00002242 // FIXME: We no longer need the types from FunctionArgList; lift up and
2243 // simplify.
Daniel Dunbar5a0acdc92009-02-03 06:02:10 +00002244
Alexey Samsonov153004f2014-09-29 22:08:00 +00002245 ClangToLLVMArgMapping IRFunctionArgs(CGM.getContext(), FI);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002246 // Flattened function arguments.
John McCall12f23522016-04-04 18:33:08 +00002247 SmallVector<llvm::Value *, 16> FnArgs;
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002248 FnArgs.reserve(IRFunctionArgs.totalIRArgs());
2249 for (auto &Arg : Fn->args()) {
2250 FnArgs.push_back(&Arg);
2251 }
2252 assert(FnArgs.size() == IRFunctionArgs.totalIRArgs());
Mike Stump11289f42009-09-09 15:08:12 +00002253
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002254 // If we're using inalloca, all the memory arguments are GEPs off of the last
2255 // parameter, which is a pointer to the complete memory area.
John McCall7f416cc2015-09-08 08:05:57 +00002256 Address ArgStruct = Address::invalid();
2257 const llvm::StructLayout *ArgStructLayout = nullptr;
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002258 if (IRFunctionArgs.hasInallocaArg()) {
John McCall7f416cc2015-09-08 08:05:57 +00002259 ArgStructLayout = CGM.getDataLayout().getStructLayout(FI.getArgStruct());
2260 ArgStruct = Address(FnArgs[IRFunctionArgs.getInallocaArgNo()],
2261 FI.getArgStructAlignment());
2262
2263 assert(ArgStruct.getType() == FI.getArgStruct()->getPointerTo());
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002264 }
2265
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002266 // Name the struct return parameter.
2267 if (IRFunctionArgs.hasSRetArg()) {
John McCall12f23522016-04-04 18:33:08 +00002268 auto AI = cast<llvm::Argument>(FnArgs[IRFunctionArgs.getSRetArgNo()]);
Daniel Dunbar613855c2008-09-09 23:27:19 +00002269 AI->setName("agg.result");
Reid Klecknercdd26792017-04-18 23:50:03 +00002270 AI->addAttr(llvm::Attribute::NoAlias);
Daniel Dunbar613855c2008-09-09 23:27:19 +00002271 }
Mike Stump11289f42009-09-09 15:08:12 +00002272
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002273 // Track if we received the parameter as a pointer (indirect, byval, or
2274 // inalloca). If already have a pointer, EmitParmDecl doesn't need to copy it
2275 // into a local alloca for us.
John McCall7f416cc2015-09-08 08:05:57 +00002276 SmallVector<ParamValue, 16> ArgVals;
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002277 ArgVals.reserve(Args.size());
2278
Reid Kleckner739756c2013-12-04 19:23:12 +00002279 // Create a pointer value for every parameter declaration. This usually
2280 // entails copying one or more LLVM IR arguments into an alloca. Don't push
2281 // any cleanups or do anything that might unwind. We do that separately, so
2282 // we can push the cleanups in the correct order for the ABI.
Daniel Dunbara45bdbb2009-02-04 21:17:21 +00002283 assert(FI.arg_size() == Args.size() &&
2284 "Mismatch between function signature & arguments.");
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002285 unsigned ArgNo = 0;
Daniel Dunbarb52d0772009-02-03 05:59:18 +00002286 CGFunctionInfo::const_arg_iterator info_it = FI.arg_begin();
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002287 for (FunctionArgList::const_iterator i = Args.begin(), e = Args.end();
Devang Patel68a15252011-03-03 20:13:15 +00002288 i != e; ++i, ++info_it, ++ArgNo) {
John McCalla738c252011-03-09 04:27:21 +00002289 const VarDecl *Arg = *i;
Daniel Dunbarb52d0772009-02-03 05:59:18 +00002290 const ABIArgInfo &ArgI = info_it->info;
Daniel Dunbard3674e62008-09-11 01:48:57 +00002291
John McCalla738c252011-03-09 04:27:21 +00002292 bool isPromoted =
2293 isa<ParmVarDecl>(Arg) && cast<ParmVarDecl>(Arg)->isKNRPromoted();
Volodymyr Sapsai17ebdb22018-01-22 22:29:24 +00002294 // We are converting from ABIArgInfo type to VarDecl type directly, unless
2295 // the parameter is promoted. In this case we convert to
2296 // CGFunctionInfo::ArgInfo type with subsequent argument demotion.
2297 QualType Ty = isPromoted ? info_it->type : Arg->getType();
2298 assert(hasScalarEvaluationKind(Ty) ==
2299 hasScalarEvaluationKind(Arg->getType()));
John McCalla738c252011-03-09 04:27:21 +00002300
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002301 unsigned FirstIRArg, NumIRArgs;
2302 std::tie(FirstIRArg, NumIRArgs) = IRFunctionArgs.getIRArgs(ArgNo);
Rafael Espindolafad28de2012-10-24 01:59:00 +00002303
Daniel Dunbard3674e62008-09-11 01:48:57 +00002304 switch (ArgI.getKind()) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002305 case ABIArgInfo::InAlloca: {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002306 assert(NumIRArgs == 0);
John McCall7f416cc2015-09-08 08:05:57 +00002307 auto FieldIndex = ArgI.getInAllocaFieldIndex();
2308 CharUnits FieldOffset =
2309 CharUnits::fromQuantity(ArgStructLayout->getElementOffset(FieldIndex));
2310 Address V = Builder.CreateStructGEP(ArgStruct, FieldIndex, FieldOffset,
2311 Arg->getName());
2312 ArgVals.push_back(ParamValue::forIndirect(V));
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002313 break;
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002314 }
2315
Daniel Dunbar747865a2009-02-05 09:16:39 +00002316 case ABIArgInfo::Indirect: {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002317 assert(NumIRArgs == 1);
John McCall7f416cc2015-09-08 08:05:57 +00002318 Address ParamAddr = Address(FnArgs[FirstIRArg], ArgI.getIndirectAlign());
Daniel Dunbar7b7c2932010-09-16 20:42:02 +00002319
John McCall47fb9502013-03-07 21:37:08 +00002320 if (!hasScalarEvaluationKind(Ty)) {
Daniel Dunbar7b7c2932010-09-16 20:42:02 +00002321 // Aggregates and complex variables are accessed by reference. All we
John McCall7f416cc2015-09-08 08:05:57 +00002322 // need to do is realign the value, if requested.
2323 Address V = ParamAddr;
Daniel Dunbar7b7c2932010-09-16 20:42:02 +00002324 if (ArgI.getIndirectRealign()) {
John McCall7f416cc2015-09-08 08:05:57 +00002325 Address AlignedTemp = CreateMemTemp(Ty, "coerce");
Daniel Dunbar7b7c2932010-09-16 20:42:02 +00002326
2327 // Copy from the incoming argument pointer to the temporary with the
2328 // appropriate alignment.
2329 //
2330 // FIXME: We should have a common utility for generating an aggregate
2331 // copy.
Ken Dyck705ba072011-01-19 01:58:38 +00002332 CharUnits Size = getContext().getTypeSizeInChars(Ty);
John McCall7f416cc2015-09-08 08:05:57 +00002333 auto SizeVal = llvm::ConstantInt::get(IntPtrTy, Size.getQuantity());
2334 Address Dst = Builder.CreateBitCast(AlignedTemp, Int8PtrTy);
2335 Address Src = Builder.CreateBitCast(ParamAddr, Int8PtrTy);
2336 Builder.CreateMemCpy(Dst, Src, SizeVal, false);
Daniel Dunbar7b7c2932010-09-16 20:42:02 +00002337 V = AlignedTemp;
2338 }
John McCall7f416cc2015-09-08 08:05:57 +00002339 ArgVals.push_back(ParamValue::forIndirect(V));
Daniel Dunbar747865a2009-02-05 09:16:39 +00002340 } else {
2341 // Load scalar value from indirect argument.
John McCall7f416cc2015-09-08 08:05:57 +00002342 llvm::Value *V =
Stephen Kellyf2ceec42018-08-09 21:08:08 +00002343 EmitLoadOfScalar(ParamAddr, false, Ty, Arg->getBeginLoc());
John McCalla738c252011-03-09 04:27:21 +00002344
2345 if (isPromoted)
2346 V = emitArgumentDemotion(*this, Arg, V);
John McCall7f416cc2015-09-08 08:05:57 +00002347 ArgVals.push_back(ParamValue::forDirect(V));
Daniel Dunbar747865a2009-02-05 09:16:39 +00002348 }
Daniel Dunbar747865a2009-02-05 09:16:39 +00002349 break;
2350 }
Anton Korobeynikov18adbf52009-06-06 09:36:29 +00002351
2352 case ABIArgInfo::Extend:
Daniel Dunbar67dace892009-02-03 06:17:37 +00002353 case ABIArgInfo::Direct: {
Akira Hatanaka18334dd2012-01-09 19:08:06 +00002354
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002355 // If we have the trivial case, handle it with no muss and fuss.
2356 if (!isa<llvm::StructType>(ArgI.getCoerceToType()) &&
Volodymyr Sapsai22b00ec2017-12-21 20:52:59 +00002357 ArgI.getCoerceToType() == ConvertType(Ty) &&
Chris Lattner8a2f3c72010-07-30 04:02:24 +00002358 ArgI.getDirectOffset() == 0) {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002359 assert(NumIRArgs == 1);
John McCall12f23522016-04-04 18:33:08 +00002360 llvm::Value *V = FnArgs[FirstIRArg];
2361 auto AI = cast<llvm::Argument>(V);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002362
Hal Finkel48d53e22014-07-19 01:41:07 +00002363 if (const ParmVarDecl *PVD = dyn_cast<ParmVarDecl>(Arg)) {
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00002364 if (getNonNullAttr(CurCodeDecl, PVD, PVD->getType(),
Manoj Guptada08f6a2018-07-19 00:44:52 +00002365 PVD->getFunctionScopeIndex()) &&
2366 !CGM.getCodeGenOpts().NullPointerIsValid)
Reid Klecknercdd26792017-04-18 23:50:03 +00002367 AI->addAttr(llvm::Attribute::NonNull);
Hal Finkel82504f02014-07-11 17:35:21 +00002368
Hal Finkel48d53e22014-07-19 01:41:07 +00002369 QualType OTy = PVD->getOriginalType();
2370 if (const auto *ArrTy =
2371 getContext().getAsConstantArrayType(OTy)) {
2372 // A C99 array parameter declaration with the static keyword also
2373 // indicates dereferenceability, and if the size is constant we can
2374 // use the dereferenceable attribute (which requires the size in
2375 // bytes).
Hal Finkel16e394a2014-07-19 02:13:40 +00002376 if (ArrTy->getSizeModifier() == ArrayType::Static) {
Hal Finkel48d53e22014-07-19 01:41:07 +00002377 QualType ETy = ArrTy->getElementType();
2378 uint64_t ArrSize = ArrTy->getSize().getZExtValue();
2379 if (!ETy->isIncompleteType() && ETy->isConstantSizeType() &&
2380 ArrSize) {
2381 llvm::AttrBuilder Attrs;
2382 Attrs.addDereferenceableAttr(
2383 getContext().getTypeSizeInChars(ETy).getQuantity()*ArrSize);
Reid Kleckner9d16fa02017-04-19 17:28:52 +00002384 AI->addAttrs(Attrs);
Manoj Guptada08f6a2018-07-19 00:44:52 +00002385 } else if (getContext().getTargetAddressSpace(ETy) == 0 &&
2386 !CGM.getCodeGenOpts().NullPointerIsValid) {
Reid Klecknercdd26792017-04-18 23:50:03 +00002387 AI->addAttr(llvm::Attribute::NonNull);
Hal Finkel48d53e22014-07-19 01:41:07 +00002388 }
2389 }
2390 } else if (const auto *ArrTy =
2391 getContext().getAsVariableArrayType(OTy)) {
2392 // For C99 VLAs with the static keyword, we don't know the size so
2393 // we can't use the dereferenceable attribute, but in addrspace(0)
2394 // we know that it must be nonnull.
2395 if (ArrTy->getSizeModifier() == VariableArrayType::Static &&
Manoj Guptada08f6a2018-07-19 00:44:52 +00002396 !getContext().getTargetAddressSpace(ArrTy->getElementType()) &&
2397 !CGM.getCodeGenOpts().NullPointerIsValid)
Reid Klecknercdd26792017-04-18 23:50:03 +00002398 AI->addAttr(llvm::Attribute::NonNull);
Hal Finkel48d53e22014-07-19 01:41:07 +00002399 }
Hal Finkel1b0d24e2014-10-02 21:21:25 +00002400
2401 const auto *AVAttr = PVD->getAttr<AlignValueAttr>();
2402 if (!AVAttr)
2403 if (const auto *TOTy = dyn_cast<TypedefType>(OTy))
2404 AVAttr = TOTy->getDecl()->getAttr<AlignValueAttr>();
Reid Kleckner9d16fa02017-04-19 17:28:52 +00002405 if (AVAttr) {
Hal Finkel1b0d24e2014-10-02 21:21:25 +00002406 llvm::Value *AlignmentValue =
2407 EmitScalarExpr(AVAttr->getAlignment());
2408 llvm::ConstantInt *AlignmentCI =
2409 cast<llvm::ConstantInt>(AlignmentValue);
Reid Kleckner9d16fa02017-04-19 17:28:52 +00002410 unsigned Alignment = std::min((unsigned)AlignmentCI->getZExtValue(),
2411 +llvm::Value::MaximumAlignment);
2412 AI->addAttrs(llvm::AttrBuilder().addAlignmentAttr(Alignment));
Hal Finkel1b0d24e2014-10-02 21:21:25 +00002413 }
Hal Finkel48d53e22014-07-19 01:41:07 +00002414 }
2415
Bill Wendling507c3512012-10-16 05:23:44 +00002416 if (Arg->getType().isRestrictQualified())
Reid Klecknercdd26792017-04-18 23:50:03 +00002417 AI->addAttr(llvm::Attribute::NoAlias);
John McCall39ec71f2010-03-27 00:47:27 +00002418
John McCall12f23522016-04-04 18:33:08 +00002419 // LLVM expects swifterror parameters to be used in very restricted
2420 // ways. Copy the value into a less-restricted temporary.
2421 if (FI.getExtParameterInfo(ArgNo).getABI()
2422 == ParameterABI::SwiftErrorResult) {
2423 QualType pointeeTy = Ty->getPointeeType();
2424 assert(pointeeTy->isPointerType());
2425 Address temp =
2426 CreateMemTemp(pointeeTy, getPointerAlign(), "swifterror.temp");
2427 Address arg = Address(V, getContext().getTypeAlignInChars(pointeeTy));
2428 llvm::Value *incomingErrorValue = Builder.CreateLoad(arg);
2429 Builder.CreateStore(incomingErrorValue, temp);
2430 V = temp.getPointer();
2431
2432 // Push a cleanup to copy the value back at the end of the function.
2433 // The convention does not guarantee that the value will be written
2434 // back if the function exits with an unwind exception.
2435 EHStack.pushCleanup<CopyBackSwiftError>(NormalCleanup, temp, arg);
2436 }
2437
Chris Lattner7369c142011-07-20 06:29:00 +00002438 // Ensure the argument is the correct type.
2439 if (V->getType() != ArgI.getCoerceToType())
2440 V = Builder.CreateBitCast(V, ArgI.getCoerceToType());
2441
John McCalla738c252011-03-09 04:27:21 +00002442 if (isPromoted)
2443 V = emitArgumentDemotion(*this, Arg, V);
Rafael Espindola8778c282012-11-29 16:09:03 +00002444
2445 // Because of merging of function types from multiple decls it is
2446 // possible for the type of an argument to not match the corresponding
2447 // type in the function type. Since we are codegening the callee
2448 // in here, add a cast to the argument type.
2449 llvm::Type *LTy = ConvertType(Arg->getType());
2450 if (V->getType() != LTy)
2451 V = Builder.CreateBitCast(V, LTy);
2452
John McCall7f416cc2015-09-08 08:05:57 +00002453 ArgVals.push_back(ParamValue::forDirect(V));
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002454 break;
Daniel Dunbard5f1f552009-02-10 00:06:49 +00002455 }
Mike Stump11289f42009-09-09 15:08:12 +00002456
Volodymyr Sapsai22b00ec2017-12-21 20:52:59 +00002457 Address Alloca = CreateMemTemp(Ty, getContext().getDeclAlign(Arg),
2458 Arg->getName());
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002459
John McCall7f416cc2015-09-08 08:05:57 +00002460 // Pointer to store into.
2461 Address Ptr = emitAddressAtOffset(*this, Alloca, ArgI);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002462
Oliver Stannard2bfdc5b2014-08-27 10:43:15 +00002463 // Fast-isel and the optimizer generally like scalar values better than
2464 // FCAs, so we flatten them if this is safe to do for this argument.
Evgeniy Stepanov3fae4ae2012-02-10 09:30:15 +00002465 llvm::StructType *STy = dyn_cast<llvm::StructType>(ArgI.getCoerceToType());
Oliver Stannard2bfdc5b2014-08-27 10:43:15 +00002466 if (ArgI.isDirect() && ArgI.getCanBeFlattened() && STy &&
2467 STy->getNumElements() > 1) {
John McCall7f416cc2015-09-08 08:05:57 +00002468 auto SrcLayout = CGM.getDataLayout().getStructLayout(STy);
Micah Villmowdd31ca12012-10-08 16:25:52 +00002469 uint64_t SrcSize = CGM.getDataLayout().getTypeAllocSize(STy);
John McCall7f416cc2015-09-08 08:05:57 +00002470 llvm::Type *DstTy = Ptr.getElementType();
Micah Villmowdd31ca12012-10-08 16:25:52 +00002471 uint64_t DstSize = CGM.getDataLayout().getTypeAllocSize(DstTy);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002472
John McCall7f416cc2015-09-08 08:05:57 +00002473 Address AddrToStoreInto = Address::invalid();
Evgeniy Stepanov3fae4ae2012-02-10 09:30:15 +00002474 if (SrcSize <= DstSize) {
Yaxun Liue9e5c4f2017-06-29 18:47:45 +00002475 AddrToStoreInto = Builder.CreateElementBitCast(Ptr, STy);
Evgeniy Stepanov3fae4ae2012-02-10 09:30:15 +00002476 } else {
John McCall7f416cc2015-09-08 08:05:57 +00002477 AddrToStoreInto =
2478 CreateTempAlloca(STy, Alloca.getAlignment(), "coerce");
Chris Lattner15ec3612010-06-29 00:06:42 +00002479 }
John McCall7f416cc2015-09-08 08:05:57 +00002480
2481 assert(STy->getNumElements() == NumIRArgs);
2482 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
2483 auto AI = FnArgs[FirstIRArg + i];
2484 AI->setName(Arg->getName() + ".coerce" + Twine(i));
2485 auto Offset = CharUnits::fromQuantity(SrcLayout->getElementOffset(i));
2486 Address EltPtr =
2487 Builder.CreateStructGEP(AddrToStoreInto, i, Offset);
2488 Builder.CreateStore(AI, EltPtr);
2489 }
2490
2491 if (SrcSize > DstSize) {
2492 Builder.CreateMemCpy(Ptr, AddrToStoreInto, DstSize);
2493 }
2494
Chris Lattner15ec3612010-06-29 00:06:42 +00002495 } else {
2496 // Simple case, just do a coerced store of the argument into the alloca.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002497 assert(NumIRArgs == 1);
2498 auto AI = FnArgs[FirstIRArg];
Chris Lattner9e748e92010-06-29 00:14:52 +00002499 AI->setName(Arg->getName() + ".coerce");
John McCall7f416cc2015-09-08 08:05:57 +00002500 CreateCoercedStore(AI, Ptr, /*DestIsVolatile=*/false, *this);
Chris Lattner15ec3612010-06-29 00:06:42 +00002501 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002502
Daniel Dunbar2f219b02009-02-03 19:12:28 +00002503 // Match to what EmitParmDecl is expecting for this type.
Volodymyr Sapsai22b00ec2017-12-21 20:52:59 +00002504 if (CodeGenFunction::hasScalarEvaluationKind(Ty)) {
John McCall7f416cc2015-09-08 08:05:57 +00002505 llvm::Value *V =
Stephen Kellyf2ceec42018-08-09 21:08:08 +00002506 EmitLoadOfScalar(Alloca, false, Ty, Arg->getBeginLoc());
John McCalla738c252011-03-09 04:27:21 +00002507 if (isPromoted)
2508 V = emitArgumentDemotion(*this, Arg, V);
John McCall7f416cc2015-09-08 08:05:57 +00002509 ArgVals.push_back(ParamValue::forDirect(V));
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002510 } else {
John McCall7f416cc2015-09-08 08:05:57 +00002511 ArgVals.push_back(ParamValue::forIndirect(Alloca));
Daniel Dunbar6e3b7df2009-02-04 07:22:24 +00002512 }
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002513 break;
Daniel Dunbar2f219b02009-02-03 19:12:28 +00002514 }
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002515
John McCallf26e73d2016-03-11 04:30:43 +00002516 case ABIArgInfo::CoerceAndExpand: {
2517 // Reconstruct into a temporary.
2518 Address alloca = CreateMemTemp(Ty, getContext().getDeclAlign(Arg));
2519 ArgVals.push_back(ParamValue::forIndirect(alloca));
2520
2521 auto coercionType = ArgI.getCoerceAndExpandType();
2522 alloca = Builder.CreateElementBitCast(alloca, coercionType);
2523 auto layout = CGM.getDataLayout().getStructLayout(coercionType);
2524
2525 unsigned argIndex = FirstIRArg;
2526 for (unsigned i = 0, e = coercionType->getNumElements(); i != e; ++i) {
2527 llvm::Type *eltType = coercionType->getElementType(i);
2528 if (ABIArgInfo::isPaddingForCoerceAndExpand(eltType))
2529 continue;
2530
2531 auto eltAddr = Builder.CreateStructGEP(alloca, i, layout);
2532 auto elt = FnArgs[argIndex++];
2533 Builder.CreateStore(elt, eltAddr);
2534 }
2535 assert(argIndex == FirstIRArg + NumIRArgs);
2536 break;
2537 }
2538
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002539 case ABIArgInfo::Expand: {
2540 // If this structure was expanded into multiple arguments then
2541 // we need to create a temporary and reconstruct it from the
2542 // arguments.
John McCall7f416cc2015-09-08 08:05:57 +00002543 Address Alloca = CreateMemTemp(Ty, getContext().getDeclAlign(Arg));
2544 LValue LV = MakeAddrLValue(Alloca, Ty);
2545 ArgVals.push_back(ParamValue::forIndirect(Alloca));
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002546
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002547 auto FnArgIter = FnArgs.begin() + FirstIRArg;
2548 ExpandTypeFromArgs(Ty, LV, FnArgIter);
2549 assert(FnArgIter == FnArgs.begin() + FirstIRArg + NumIRArgs);
2550 for (unsigned i = 0, e = NumIRArgs; i != e; ++i) {
2551 auto AI = FnArgs[FirstIRArg + i];
2552 AI->setName(Arg->getName() + "." + Twine(i));
2553 }
2554 break;
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002555 }
2556
2557 case ABIArgInfo::Ignore:
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002558 assert(NumIRArgs == 0);
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002559 // Initialize the local variable appropriately.
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002560 if (!hasScalarEvaluationKind(Ty)) {
John McCall7f416cc2015-09-08 08:05:57 +00002561 ArgVals.push_back(ParamValue::forIndirect(CreateMemTemp(Ty)));
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002562 } else {
2563 llvm::Value *U = llvm::UndefValue::get(ConvertType(Arg->getType()));
John McCall7f416cc2015-09-08 08:05:57 +00002564 ArgVals.push_back(ParamValue::forDirect(U));
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002565 }
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002566 break;
Daniel Dunbard3674e62008-09-11 01:48:57 +00002567 }
Daniel Dunbar613855c2008-09-09 23:27:19 +00002568 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002569
Reid Kleckner739756c2013-12-04 19:23:12 +00002570 if (getTarget().getCXXABI().areArgsDestroyedLeftToRightInCallee()) {
2571 for (int I = Args.size() - 1; I >= 0; --I)
John McCall7f416cc2015-09-08 08:05:57 +00002572 EmitParmDecl(*Args[I], ArgVals[I], I + 1);
Reid Kleckner739756c2013-12-04 19:23:12 +00002573 } else {
2574 for (unsigned I = 0, E = Args.size(); I != E; ++I)
John McCall7f416cc2015-09-08 08:05:57 +00002575 EmitParmDecl(*Args[I], ArgVals[I], I + 1);
Reid Kleckner739756c2013-12-04 19:23:12 +00002576 }
Daniel Dunbar613855c2008-09-09 23:27:19 +00002577}
2578
John McCallffa2c1a2012-01-29 07:46:59 +00002579static void eraseUnusedBitCasts(llvm::Instruction *insn) {
2580 while (insn->use_empty()) {
2581 llvm::BitCastInst *bitcast = dyn_cast<llvm::BitCastInst>(insn);
2582 if (!bitcast) return;
2583
2584 // This is "safe" because we would have used a ConstantExpr otherwise.
2585 insn = cast<llvm::Instruction>(bitcast->getOperand(0));
2586 bitcast->eraseFromParent();
2587 }
2588}
2589
John McCall31168b02011-06-15 23:02:42 +00002590/// Try to emit a fused autorelease of a return result.
2591static llvm::Value *tryEmitFusedAutoreleaseOfResult(CodeGenFunction &CGF,
2592 llvm::Value *result) {
2593 // We must be immediately followed the cast.
2594 llvm::BasicBlock *BB = CGF.Builder.GetInsertBlock();
Craig Topper8a13c412014-05-21 05:09:00 +00002595 if (BB->empty()) return nullptr;
2596 if (&BB->back() != result) return nullptr;
John McCall31168b02011-06-15 23:02:42 +00002597
Chris Lattner2192fe52011-07-18 04:24:23 +00002598 llvm::Type *resultType = result->getType();
John McCall31168b02011-06-15 23:02:42 +00002599
2600 // result is in a BasicBlock and is therefore an Instruction.
2601 llvm::Instruction *generator = cast<llvm::Instruction>(result);
2602
Justin Bogner882f8612016-08-18 21:46:54 +00002603 SmallVector<llvm::Instruction *, 4> InstsToKill;
John McCall31168b02011-06-15 23:02:42 +00002604
2605 // Look for:
2606 // %generator = bitcast %type1* %generator2 to %type2*
2607 while (llvm::BitCastInst *bitcast = dyn_cast<llvm::BitCastInst>(generator)) {
2608 // We would have emitted this as a constant if the operand weren't
2609 // an Instruction.
2610 generator = cast<llvm::Instruction>(bitcast->getOperand(0));
2611
2612 // Require the generator to be immediately followed by the cast.
2613 if (generator->getNextNode() != bitcast)
Craig Topper8a13c412014-05-21 05:09:00 +00002614 return nullptr;
John McCall31168b02011-06-15 23:02:42 +00002615
Justin Bogner882f8612016-08-18 21:46:54 +00002616 InstsToKill.push_back(bitcast);
John McCall31168b02011-06-15 23:02:42 +00002617 }
2618
2619 // Look for:
2620 // %generator = call i8* @objc_retain(i8* %originalResult)
2621 // or
2622 // %generator = call i8* @objc_retainAutoreleasedReturnValue(i8* %originalResult)
2623 llvm::CallInst *call = dyn_cast<llvm::CallInst>(generator);
Craig Topper8a13c412014-05-21 05:09:00 +00002624 if (!call) return nullptr;
John McCall31168b02011-06-15 23:02:42 +00002625
2626 bool doRetainAutorelease;
2627
John McCallb04ecb72015-10-21 18:06:43 +00002628 if (call->getCalledValue() == CGF.CGM.getObjCEntrypoints().objc_retain) {
John McCall31168b02011-06-15 23:02:42 +00002629 doRetainAutorelease = true;
John McCallb04ecb72015-10-21 18:06:43 +00002630 } else if (call->getCalledValue() == CGF.CGM.getObjCEntrypoints()
John McCall31168b02011-06-15 23:02:42 +00002631 .objc_retainAutoreleasedReturnValue) {
2632 doRetainAutorelease = false;
2633
John McCallcfa4e9b2012-09-07 23:30:50 +00002634 // If we emitted an assembly marker for this call (and the
2635 // ARCEntrypoints field should have been set if so), go looking
2636 // for that call. If we can't find it, we can't do this
2637 // optimization. But it should always be the immediately previous
2638 // instruction, unless we needed bitcasts around the call.
John McCallb04ecb72015-10-21 18:06:43 +00002639 if (CGF.CGM.getObjCEntrypoints().retainAutoreleasedReturnValueMarker) {
John McCallcfa4e9b2012-09-07 23:30:50 +00002640 llvm::Instruction *prev = call->getPrevNode();
2641 assert(prev);
2642 if (isa<llvm::BitCastInst>(prev)) {
2643 prev = prev->getPrevNode();
2644 assert(prev);
2645 }
2646 assert(isa<llvm::CallInst>(prev));
2647 assert(cast<llvm::CallInst>(prev)->getCalledValue() ==
John McCallb04ecb72015-10-21 18:06:43 +00002648 CGF.CGM.getObjCEntrypoints().retainAutoreleasedReturnValueMarker);
Justin Bogner882f8612016-08-18 21:46:54 +00002649 InstsToKill.push_back(prev);
John McCallcfa4e9b2012-09-07 23:30:50 +00002650 }
John McCall31168b02011-06-15 23:02:42 +00002651 } else {
Craig Topper8a13c412014-05-21 05:09:00 +00002652 return nullptr;
John McCall31168b02011-06-15 23:02:42 +00002653 }
2654
2655 result = call->getArgOperand(0);
Justin Bogner882f8612016-08-18 21:46:54 +00002656 InstsToKill.push_back(call);
John McCall31168b02011-06-15 23:02:42 +00002657
2658 // Keep killing bitcasts, for sanity. Note that we no longer care
2659 // about precise ordering as long as there's exactly one use.
2660 while (llvm::BitCastInst *bitcast = dyn_cast<llvm::BitCastInst>(result)) {
2661 if (!bitcast->hasOneUse()) break;
Justin Bogner882f8612016-08-18 21:46:54 +00002662 InstsToKill.push_back(bitcast);
John McCall31168b02011-06-15 23:02:42 +00002663 result = bitcast->getOperand(0);
2664 }
2665
2666 // Delete all the unnecessary instructions, from latest to earliest.
Justin Bogner882f8612016-08-18 21:46:54 +00002667 for (auto *I : InstsToKill)
Saleem Abdulrasoolbe25c482016-08-18 21:40:06 +00002668 I->eraseFromParent();
John McCall31168b02011-06-15 23:02:42 +00002669
2670 // Do the fused retain/autorelease if we were asked to.
2671 if (doRetainAutorelease)
2672 result = CGF.EmitARCRetainAutoreleaseReturnValue(result);
2673
2674 // Cast back to the result type.
2675 return CGF.Builder.CreateBitCast(result, resultType);
2676}
2677
John McCallffa2c1a2012-01-29 07:46:59 +00002678/// If this is a +1 of the value of an immutable 'self', remove it.
2679static llvm::Value *tryRemoveRetainOfSelf(CodeGenFunction &CGF,
2680 llvm::Value *result) {
2681 // This is only applicable to a method with an immutable 'self'.
John McCallff755cd2012-07-31 00:33:55 +00002682 const ObjCMethodDecl *method =
2683 dyn_cast_or_null<ObjCMethodDecl>(CGF.CurCodeDecl);
Craig Topper8a13c412014-05-21 05:09:00 +00002684 if (!method) return nullptr;
John McCallffa2c1a2012-01-29 07:46:59 +00002685 const VarDecl *self = method->getSelfDecl();
Craig Topper8a13c412014-05-21 05:09:00 +00002686 if (!self->getType().isConstQualified()) return nullptr;
John McCallffa2c1a2012-01-29 07:46:59 +00002687
2688 // Look for a retain call.
2689 llvm::CallInst *retainCall =
2690 dyn_cast<llvm::CallInst>(result->stripPointerCasts());
2691 if (!retainCall ||
John McCallb04ecb72015-10-21 18:06:43 +00002692 retainCall->getCalledValue() != CGF.CGM.getObjCEntrypoints().objc_retain)
Craig Topper8a13c412014-05-21 05:09:00 +00002693 return nullptr;
John McCallffa2c1a2012-01-29 07:46:59 +00002694
2695 // Look for an ordinary load of 'self'.
2696 llvm::Value *retainedValue = retainCall->getArgOperand(0);
2697 llvm::LoadInst *load =
2698 dyn_cast<llvm::LoadInst>(retainedValue->stripPointerCasts());
Fangrui Song6907ce22018-07-30 19:24:48 +00002699 if (!load || load->isAtomic() || load->isVolatile() ||
John McCall7f416cc2015-09-08 08:05:57 +00002700 load->getPointerOperand() != CGF.GetAddrOfLocalVar(self).getPointer())
Craig Topper8a13c412014-05-21 05:09:00 +00002701 return nullptr;
John McCallffa2c1a2012-01-29 07:46:59 +00002702
2703 // Okay! Burn it all down. This relies for correctness on the
2704 // assumption that the retain is emitted as part of the return and
2705 // that thereafter everything is used "linearly".
2706 llvm::Type *resultType = result->getType();
2707 eraseUnusedBitCasts(cast<llvm::Instruction>(result));
2708 assert(retainCall->use_empty());
2709 retainCall->eraseFromParent();
2710 eraseUnusedBitCasts(cast<llvm::Instruction>(retainedValue));
2711
2712 return CGF.Builder.CreateBitCast(load, resultType);
2713}
2714
John McCall31168b02011-06-15 23:02:42 +00002715/// Emit an ARC autorelease of the result of a function.
John McCallffa2c1a2012-01-29 07:46:59 +00002716///
2717/// \return the value to actually return from the function
John McCall31168b02011-06-15 23:02:42 +00002718static llvm::Value *emitAutoreleaseOfResult(CodeGenFunction &CGF,
2719 llvm::Value *result) {
John McCallffa2c1a2012-01-29 07:46:59 +00002720 // If we're returning 'self', kill the initial retain. This is a
2721 // heuristic attempt to "encourage correctness" in the really unfortunate
2722 // case where we have a return of self during a dealloc and we desperately
2723 // need to avoid the possible autorelease.
2724 if (llvm::Value *self = tryRemoveRetainOfSelf(CGF, result))
2725 return self;
2726
John McCall31168b02011-06-15 23:02:42 +00002727 // At -O0, try to emit a fused retain/autorelease.
2728 if (CGF.shouldUseFusedARCCalls())
2729 if (llvm::Value *fused = tryEmitFusedAutoreleaseOfResult(CGF, result))
2730 return fused;
2731
2732 return CGF.EmitARCAutoreleaseReturnValue(result);
2733}
2734
John McCall6e1c0122012-01-29 02:35:02 +00002735/// Heuristically search for a dominating store to the return-value slot.
2736static llvm::StoreInst *findDominatingStoreToReturnValue(CodeGenFunction &CGF) {
Jakub Kuderskif50ab0f2015-09-08 10:36:42 +00002737 // Check if a User is a store which pointerOperand is the ReturnValue.
2738 // We are looking for stores to the ReturnValue, not for stores of the
2739 // ReturnValue to some other location.
2740 auto GetStoreIfValid = [&CGF](llvm::User *U) -> llvm::StoreInst * {
2741 auto *SI = dyn_cast<llvm::StoreInst>(U);
2742 if (!SI || SI->getPointerOperand() != CGF.ReturnValue.getPointer())
2743 return nullptr;
2744 // These aren't actually possible for non-coerced returns, and we
2745 // only care about non-coerced returns on this code path.
2746 assert(!SI->isAtomic() && !SI->isVolatile());
2747 return SI;
2748 };
John McCall6e1c0122012-01-29 02:35:02 +00002749 // If there are multiple uses of the return-value slot, just check
2750 // for something immediately preceding the IP. Sometimes this can
2751 // happen with how we generate implicit-returns; it can also happen
2752 // with noreturn cleanups.
John McCall7f416cc2015-09-08 08:05:57 +00002753 if (!CGF.ReturnValue.getPointer()->hasOneUse()) {
John McCall6e1c0122012-01-29 02:35:02 +00002754 llvm::BasicBlock *IP = CGF.Builder.GetInsertBlock();
Craig Topper8a13c412014-05-21 05:09:00 +00002755 if (IP->empty()) return nullptr;
David Majnemerdc012fa2015-04-22 21:38:15 +00002756 llvm::Instruction *I = &IP->back();
2757
2758 // Skip lifetime markers
2759 for (llvm::BasicBlock::reverse_iterator II = IP->rbegin(),
2760 IE = IP->rend();
2761 II != IE; ++II) {
2762 if (llvm::IntrinsicInst *Intrinsic =
2763 dyn_cast<llvm::IntrinsicInst>(&*II)) {
2764 if (Intrinsic->getIntrinsicID() == llvm::Intrinsic::lifetime_end) {
2765 const llvm::Value *CastAddr = Intrinsic->getArgOperand(1);
2766 ++II;
Alexey Samsonov10544202015-06-12 21:05:32 +00002767 if (II == IE)
2768 break;
2769 if (isa<llvm::BitCastInst>(&*II) && (CastAddr == &*II))
2770 continue;
David Majnemerdc012fa2015-04-22 21:38:15 +00002771 }
2772 }
2773 I = &*II;
2774 break;
2775 }
2776
Jakub Kuderskif50ab0f2015-09-08 10:36:42 +00002777 return GetStoreIfValid(I);
John McCall6e1c0122012-01-29 02:35:02 +00002778 }
2779
2780 llvm::StoreInst *store =
Jakub Kuderskif50ab0f2015-09-08 10:36:42 +00002781 GetStoreIfValid(CGF.ReturnValue.getPointer()->user_back());
Craig Topper8a13c412014-05-21 05:09:00 +00002782 if (!store) return nullptr;
John McCall6e1c0122012-01-29 02:35:02 +00002783
John McCall6e1c0122012-01-29 02:35:02 +00002784 // Now do a first-and-dirty dominance check: just walk up the
2785 // single-predecessors chain from the current insertion point.
2786 llvm::BasicBlock *StoreBB = store->getParent();
2787 llvm::BasicBlock *IP = CGF.Builder.GetInsertBlock();
2788 while (IP != StoreBB) {
2789 if (!(IP = IP->getSinglePredecessor()))
Craig Topper8a13c412014-05-21 05:09:00 +00002790 return nullptr;
John McCall6e1c0122012-01-29 02:35:02 +00002791 }
2792
2793 // Okay, the store's basic block dominates the insertion point; we
2794 // can do our thing.
2795 return store;
2796}
2797
Adrian Prantl3be10542013-05-02 17:30:20 +00002798void CodeGenFunction::EmitFunctionEpilog(const CGFunctionInfo &FI,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002799 bool EmitRetDbgLoc,
2800 SourceLocation EndLoc) {
Vedant Kumar09b5bfd2017-12-21 00:10:25 +00002801 if (FI.isNoReturn()) {
2802 // Noreturn functions don't return.
2803 EmitUnreachable(EndLoc);
2804 return;
2805 }
2806
Hans Wennborgd71907d2014-09-04 22:16:33 +00002807 if (CurCodeDecl && CurCodeDecl->hasAttr<NakedAttr>()) {
2808 // Naked functions don't have epilogues.
2809 Builder.CreateUnreachable();
2810 return;
2811 }
2812
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00002813 // Functions with no result always return void.
John McCall7f416cc2015-09-08 08:05:57 +00002814 if (!ReturnValue.isValid()) {
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00002815 Builder.CreateRetVoid();
Chris Lattner726b3d02010-06-26 23:13:19 +00002816 return;
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00002817 }
Daniel Dunbar6696e222010-06-30 21:27:58 +00002818
Dan Gohman481e40c2010-07-20 20:13:52 +00002819 llvm::DebugLoc RetDbgLoc;
Craig Topper8a13c412014-05-21 05:09:00 +00002820 llvm::Value *RV = nullptr;
Chris Lattner726b3d02010-06-26 23:13:19 +00002821 QualType RetTy = FI.getReturnType();
2822 const ABIArgInfo &RetAI = FI.getReturnInfo();
2823
2824 switch (RetAI.getKind()) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002825 case ABIArgInfo::InAlloca:
Reid Klecknerfab1e892014-02-25 00:59:14 +00002826 // Aggregrates get evaluated directly into the destination. Sometimes we
2827 // need to return the sret value in a register, though.
2828 assert(hasAggregateEvaluationKind(RetTy));
2829 if (RetAI.getInAllocaSRet()) {
2830 llvm::Function::arg_iterator EI = CurFn->arg_end();
2831 --EI;
Duncan P. N. Exon Smith9f5260a2015-11-06 23:00:41 +00002832 llvm::Value *ArgStruct = &*EI;
David Blaikie2e804282015-04-05 22:47:07 +00002833 llvm::Value *SRet = Builder.CreateStructGEP(
2834 nullptr, ArgStruct, RetAI.getInAllocaFieldIndex());
John McCall7f416cc2015-09-08 08:05:57 +00002835 RV = Builder.CreateAlignedLoad(SRet, getPointerAlign(), "sret");
Reid Klecknerfab1e892014-02-25 00:59:14 +00002836 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002837 break;
2838
Daniel Dunbar03816342010-08-21 02:24:36 +00002839 case ABIArgInfo::Indirect: {
Reid Kleckner37abaca2014-05-09 22:46:15 +00002840 auto AI = CurFn->arg_begin();
2841 if (RetAI.isSRetAfterThis())
2842 ++AI;
John McCall47fb9502013-03-07 21:37:08 +00002843 switch (getEvaluationKind(RetTy)) {
2844 case TEK_Complex: {
2845 ComplexPairTy RT =
John McCall7f416cc2015-09-08 08:05:57 +00002846 EmitLoadOfComplex(MakeAddrLValue(ReturnValue, RetTy), EndLoc);
Duncan P. N. Exon Smith9f5260a2015-11-06 23:00:41 +00002847 EmitStoreOfComplex(RT, MakeNaturalAlignAddrLValue(&*AI, RetTy),
John McCall47fb9502013-03-07 21:37:08 +00002848 /*isInit*/ true);
2849 break;
2850 }
2851 case TEK_Aggregate:
Chris Lattner726b3d02010-06-26 23:13:19 +00002852 // Do nothing; aggregrates get evaluated directly into the destination.
John McCall47fb9502013-03-07 21:37:08 +00002853 break;
2854 case TEK_Scalar:
2855 EmitStoreOfScalar(Builder.CreateLoad(ReturnValue),
Duncan P. N. Exon Smith9f5260a2015-11-06 23:00:41 +00002856 MakeNaturalAlignAddrLValue(&*AI, RetTy),
John McCall47fb9502013-03-07 21:37:08 +00002857 /*isInit*/ true);
2858 break;
Chris Lattner726b3d02010-06-26 23:13:19 +00002859 }
2860 break;
Daniel Dunbar03816342010-08-21 02:24:36 +00002861 }
Chris Lattner726b3d02010-06-26 23:13:19 +00002862
2863 case ABIArgInfo::Extend:
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002864 case ABIArgInfo::Direct:
Chris Lattner8a2f3c72010-07-30 04:02:24 +00002865 if (RetAI.getCoerceToType() == ConvertType(RetTy) &&
2866 RetAI.getDirectOffset() == 0) {
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002867 // The internal return value temp always will have pointer-to-return-type
2868 // type, just do a load.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002869
John McCall6e1c0122012-01-29 02:35:02 +00002870 // If there is a dominating store to ReturnValue, we can elide
2871 // the load, zap the store, and usually zap the alloca.
David Majnemerdc012fa2015-04-22 21:38:15 +00002872 if (llvm::StoreInst *SI =
2873 findDominatingStoreToReturnValue(*this)) {
Adrian Prantl4c9a38a2013-05-30 18:12:23 +00002874 // Reuse the debug location from the store unless there is
2875 // cleanup code to be emitted between the store and return
2876 // instruction.
2877 if (EmitRetDbgLoc && !AutoreleaseResult)
Adrian Prantl3be10542013-05-02 17:30:20 +00002878 RetDbgLoc = SI->getDebugLoc();
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002879 // Get the stored value and nuke the now-dead store.
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002880 RV = SI->getValueOperand();
2881 SI->eraseFromParent();
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002882
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002883 // If that was the only use of the return value, nuke it as well now.
John McCall7f416cc2015-09-08 08:05:57 +00002884 auto returnValueInst = ReturnValue.getPointer();
2885 if (returnValueInst->use_empty()) {
2886 if (auto alloca = dyn_cast<llvm::AllocaInst>(returnValueInst)) {
2887 alloca->eraseFromParent();
2888 ReturnValue = Address::invalid();
2889 }
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002890 }
John McCall6e1c0122012-01-29 02:35:02 +00002891
2892 // Otherwise, we have to do a simple load.
2893 } else {
2894 RV = Builder.CreateLoad(ReturnValue);
Chris Lattner3fcc7902010-06-27 01:06:27 +00002895 }
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002896 } else {
Chris Lattner8a2f3c72010-07-30 04:02:24 +00002897 // If the value is offset in memory, apply the offset now.
John McCall7f416cc2015-09-08 08:05:57 +00002898 Address V = emitAddressAtOffset(*this, ReturnValue, RetAI);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002899
John McCall7f416cc2015-09-08 08:05:57 +00002900 RV = CreateCoercedLoad(V, RetAI.getCoerceToType(), *this);
Chris Lattner3fcc7902010-06-27 01:06:27 +00002901 }
John McCall31168b02011-06-15 23:02:42 +00002902
2903 // In ARC, end functions that return a retainable type with a call
2904 // to objc_autoreleaseReturnValue.
2905 if (AutoreleaseResult) {
Akira Hatanaka9d8ac612016-02-17 21:09:50 +00002906#ifndef NDEBUG
2907 // Type::isObjCRetainabletype has to be called on a QualType that hasn't
2908 // been stripped of the typedefs, so we cannot use RetTy here. Get the
2909 // original return type of FunctionDecl, CurCodeDecl, and BlockDecl from
2910 // CurCodeDecl or BlockInfo.
2911 QualType RT;
2912
2913 if (auto *FD = dyn_cast<FunctionDecl>(CurCodeDecl))
2914 RT = FD->getReturnType();
2915 else if (auto *MD = dyn_cast<ObjCMethodDecl>(CurCodeDecl))
2916 RT = MD->getReturnType();
2917 else if (isa<BlockDecl>(CurCodeDecl))
2918 RT = BlockInfo->BlockExpression->getFunctionType()->getReturnType();
2919 else
2920 llvm_unreachable("Unexpected function/method type");
2921
David Blaikiebbafb8a2012-03-11 07:00:24 +00002922 assert(getLangOpts().ObjCAutoRefCount &&
John McCall31168b02011-06-15 23:02:42 +00002923 !FI.isReturnsRetained() &&
Akira Hatanaka9d8ac612016-02-17 21:09:50 +00002924 RT->isObjCRetainableType());
2925#endif
John McCall31168b02011-06-15 23:02:42 +00002926 RV = emitAutoreleaseOfResult(*this, RV);
2927 }
2928
Chris Lattner726b3d02010-06-26 23:13:19 +00002929 break;
Chris Lattner726b3d02010-06-26 23:13:19 +00002930
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002931 case ABIArgInfo::Ignore:
Chris Lattner726b3d02010-06-26 23:13:19 +00002932 break;
2933
John McCallf26e73d2016-03-11 04:30:43 +00002934 case ABIArgInfo::CoerceAndExpand: {
2935 auto coercionType = RetAI.getCoerceAndExpandType();
2936 auto layout = CGM.getDataLayout().getStructLayout(coercionType);
2937
2938 // Load all of the coerced elements out into results.
2939 llvm::SmallVector<llvm::Value*, 4> results;
2940 Address addr = Builder.CreateElementBitCast(ReturnValue, coercionType);
2941 for (unsigned i = 0, e = coercionType->getNumElements(); i != e; ++i) {
2942 auto coercedEltType = coercionType->getElementType(i);
2943 if (ABIArgInfo::isPaddingForCoerceAndExpand(coercedEltType))
2944 continue;
2945
2946 auto eltAddr = Builder.CreateStructGEP(addr, i, layout);
2947 auto elt = Builder.CreateLoad(eltAddr);
2948 results.push_back(elt);
2949 }
2950
2951 // If we have one result, it's the single direct result type.
2952 if (results.size() == 1) {
2953 RV = results[0];
2954
2955 // Otherwise, we need to make a first-class aggregate.
2956 } else {
2957 // Construct a return type that lacks padding elements.
2958 llvm::Type *returnType = RetAI.getUnpaddedCoerceAndExpandType();
2959
2960 RV = llvm::UndefValue::get(returnType);
2961 for (unsigned i = 0, e = results.size(); i != e; ++i) {
2962 RV = Builder.CreateInsertValue(RV, results[i], i);
2963 }
2964 }
2965 break;
2966 }
2967
Chris Lattner726b3d02010-06-26 23:13:19 +00002968 case ABIArgInfo::Expand:
David Blaikie83d382b2011-09-23 05:06:16 +00002969 llvm_unreachable("Invalid ABI kind for return argument");
Chris Lattner726b3d02010-06-26 23:13:19 +00002970 }
2971
Alexey Samsonovde443c52014-08-13 00:26:40 +00002972 llvm::Instruction *Ret;
2973 if (RV) {
Vedant Kumarc34d3432017-06-23 21:32:38 +00002974 EmitReturnValueCheck(RV);
Alexey Samsonovde443c52014-08-13 00:26:40 +00002975 Ret = Builder.CreateRet(RV);
2976 } else {
2977 Ret = Builder.CreateRetVoid();
2978 }
2979
Duncan P. N. Exon Smith2809cc72015-03-30 20:01:41 +00002980 if (RetDbgLoc)
Benjamin Kramer03278662015-02-07 13:15:54 +00002981 Ret->setDebugLoc(std::move(RetDbgLoc));
Daniel Dunbar613855c2008-09-09 23:27:19 +00002982}
2983
Vedant Kumarc34d3432017-06-23 21:32:38 +00002984void CodeGenFunction::EmitReturnValueCheck(llvm::Value *RV) {
Vedant Kumar42c17ec2017-03-14 01:56:34 +00002985 // A current decl may not be available when emitting vtable thunks.
2986 if (!CurCodeDecl)
2987 return;
2988
2989 ReturnsNonNullAttr *RetNNAttr = nullptr;
2990 if (SanOpts.has(SanitizerKind::ReturnsNonnullAttribute))
2991 RetNNAttr = CurCodeDecl->getAttr<ReturnsNonNullAttr>();
2992
2993 if (!RetNNAttr && !requiresReturnValueNullabilityCheck())
2994 return;
2995
2996 // Prefer the returns_nonnull attribute if it's present.
2997 SourceLocation AttrLoc;
2998 SanitizerMask CheckKind;
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00002999 SanitizerHandler Handler;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003000 if (RetNNAttr) {
3001 assert(!requiresReturnValueNullabilityCheck() &&
3002 "Cannot check nullability and the nonnull attribute");
3003 AttrLoc = RetNNAttr->getLocation();
3004 CheckKind = SanitizerKind::ReturnsNonnullAttribute;
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00003005 Handler = SanitizerHandler::NonnullReturn;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003006 } else {
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003007 if (auto *DD = dyn_cast<DeclaratorDecl>(CurCodeDecl))
3008 if (auto *TSI = DD->getTypeSourceInfo())
3009 if (auto FTL = TSI->getTypeLoc().castAs<FunctionTypeLoc>())
3010 AttrLoc = FTL.getReturnLoc().findNullabilityLoc();
3011 CheckKind = SanitizerKind::NullabilityReturn;
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00003012 Handler = SanitizerHandler::NullabilityReturn;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003013 }
3014
3015 SanitizerScope SanScope(this);
3016
Vedant Kumarc34d3432017-06-23 21:32:38 +00003017 // Make sure the "return" source location is valid. If we're checking a
3018 // nullability annotation, make sure the preconditions for the check are met.
3019 llvm::BasicBlock *Check = createBasicBlock("nullcheck");
3020 llvm::BasicBlock *NoCheck = createBasicBlock("no.nullcheck");
3021 llvm::Value *SLocPtr = Builder.CreateLoad(ReturnLocation, "return.sloc.load");
3022 llvm::Value *CanNullCheck = Builder.CreateIsNotNull(SLocPtr);
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003023 if (requiresReturnValueNullabilityCheck())
Vedant Kumarc34d3432017-06-23 21:32:38 +00003024 CanNullCheck =
3025 Builder.CreateAnd(CanNullCheck, RetValNullabilityPrecondition);
3026 Builder.CreateCondBr(CanNullCheck, Check, NoCheck);
3027 EmitBlock(Check);
3028
3029 // Now do the null check.
3030 llvm::Value *Cond = Builder.CreateIsNotNull(RV);
3031 llvm::Constant *StaticData[] = {EmitCheckSourceLocation(AttrLoc)};
3032 llvm::Value *DynamicData[] = {SLocPtr};
3033 EmitCheck(std::make_pair(Cond, CheckKind), Handler, StaticData, DynamicData);
3034
3035 EmitBlock(NoCheck);
3036
3037#ifndef NDEBUG
3038 // The return location should not be used after the check has been emitted.
3039 ReturnLocation = Address::invalid();
3040#endif
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003041}
3042
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003043static bool isInAllocaArgument(CGCXXABI &ABI, QualType type) {
3044 const CXXRecordDecl *RD = type->getAsCXXRecordDecl();
3045 return RD && ABI.getRecordArgABI(RD) == CGCXXABI::RAA_DirectInMemory;
3046}
3047
John McCall7f416cc2015-09-08 08:05:57 +00003048static AggValueSlot createPlaceholderSlot(CodeGenFunction &CGF,
3049 QualType Ty) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003050 // FIXME: Generate IR in one pass, rather than going back and fixing up these
3051 // placeholders.
3052 llvm::Type *IRTy = CGF.ConvertTypeForMem(Ty);
Peter Collingbourneb367c562016-11-28 22:30:21 +00003053 llvm::Type *IRPtrTy = IRTy->getPointerTo();
3054 llvm::Value *Placeholder = llvm::UndefValue::get(IRPtrTy->getPointerTo());
John McCall7f416cc2015-09-08 08:05:57 +00003055
3056 // FIXME: When we generate this IR in one pass, we shouldn't need
3057 // this win32-specific alignment hack.
3058 CharUnits Align = CharUnits::fromQuantity(4);
Peter Collingbourneb367c562016-11-28 22:30:21 +00003059 Placeholder = CGF.Builder.CreateAlignedLoad(IRPtrTy, Placeholder, Align);
John McCall7f416cc2015-09-08 08:05:57 +00003060
3061 return AggValueSlot::forAddr(Address(Placeholder, Align),
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003062 Ty.getQualifiers(),
3063 AggValueSlot::IsNotDestructed,
3064 AggValueSlot::DoesNotNeedGCBarriers,
Richard Smithe78fac52018-04-05 20:52:58 +00003065 AggValueSlot::IsNotAliased,
3066 AggValueSlot::DoesNotOverlap);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003067}
3068
John McCall32ea9692011-03-11 20:59:21 +00003069void CodeGenFunction::EmitDelegateCallArg(CallArgList &args,
Nick Lewycky2d84e842013-10-02 02:29:49 +00003070 const VarDecl *param,
3071 SourceLocation loc) {
John McCall23f66262010-05-26 22:34:26 +00003072 // StartFunction converted the ABI-lowered parameter(s) into a
3073 // local alloca. We need to turn that into an r-value suitable
3074 // for EmitCall.
John McCall7f416cc2015-09-08 08:05:57 +00003075 Address local = GetAddrOfLocalVar(param);
John McCall23f66262010-05-26 22:34:26 +00003076
John McCall32ea9692011-03-11 20:59:21 +00003077 QualType type = param->getType();
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003078
Reid Klecknerab2090d2014-07-26 01:34:32 +00003079 assert(!isInAllocaArgument(CGM.getCXXABI(), type) &&
3080 "cannot emit delegate call arguments for inalloca arguments!");
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003081
John McCall811b2912016-11-18 01:08:24 +00003082 // GetAddrOfLocalVar returns a pointer-to-pointer for references,
3083 // but the argument needs to be the original pointer.
3084 if (type->isReferenceType()) {
3085 args.add(RValue::get(Builder.CreateLoad(local)), type);
3086
3087 // In ARC, move out of consumed arguments so that the release cleanup
3088 // entered by StartFunction doesn't cause an over-release. This isn't
3089 // optimal -O0 code generation, but it should get cleaned up when
3090 // optimization is enabled. This also assumes that delegate calls are
3091 // performed exactly once for a set of arguments, but that should be safe.
3092 } else if (getLangOpts().ObjCAutoRefCount &&
3093 param->hasAttr<NSConsumedAttr>() &&
3094 type->isObjCRetainableType()) {
3095 llvm::Value *ptr = Builder.CreateLoad(local);
3096 auto null =
3097 llvm::ConstantPointerNull::get(cast<llvm::PointerType>(ptr->getType()));
3098 Builder.CreateStore(null, local);
3099 args.add(RValue::get(ptr), type);
3100
Richard Smithd62d4982016-06-14 01:13:21 +00003101 // For the most part, we just need to load the alloca, except that
3102 // aggregate r-values are actually pointers to temporaries.
John McCall811b2912016-11-18 01:08:24 +00003103 } else {
Richard Smithd62d4982016-06-14 01:13:21 +00003104 args.add(convertTempToRValue(local, type, loc), type);
John McCall811b2912016-11-18 01:08:24 +00003105 }
Akira Hatanakaccda3d22018-04-27 06:57:00 +00003106
3107 // Deactivate the cleanup for the callee-destructed param that was pushed.
3108 if (hasAggregateEvaluationKind(type) && !CurFuncIsThunk &&
Akira Hatanaka85282972018-05-15 21:00:30 +00003109 type->getAs<RecordType>()->getDecl()->isParamDestroyedInCallee() &&
3110 type.isDestructedType()) {
Akira Hatanakaccda3d22018-04-27 06:57:00 +00003111 EHScopeStack::stable_iterator cleanup =
3112 CalleeDestructedParamCleanups.lookup(cast<ParmVarDecl>(param));
3113 assert(cleanup.isValid() &&
3114 "cleanup for callee-destructed param not recorded");
3115 // This unreachable is a temporary marker which will be removed later.
3116 llvm::Instruction *isActive = Builder.CreateUnreachable();
3117 args.addArgCleanupDeactivation(cleanup, isActive);
3118 }
John McCall23f66262010-05-26 22:34:26 +00003119}
3120
John McCall31168b02011-06-15 23:02:42 +00003121static bool isProvablyNull(llvm::Value *addr) {
3122 return isa<llvm::ConstantPointerNull>(addr);
3123}
3124
John McCall31168b02011-06-15 23:02:42 +00003125/// Emit the actual writing-back of a writeback.
3126static void emitWriteback(CodeGenFunction &CGF,
3127 const CallArgList::Writeback &writeback) {
John McCalleff18842013-03-23 02:35:54 +00003128 const LValue &srcLV = writeback.Source;
John McCall7f416cc2015-09-08 08:05:57 +00003129 Address srcAddr = srcLV.getAddress();
3130 assert(!isProvablyNull(srcAddr.getPointer()) &&
John McCall31168b02011-06-15 23:02:42 +00003131 "shouldn't have writeback for provably null argument");
3132
Craig Topper8a13c412014-05-21 05:09:00 +00003133 llvm::BasicBlock *contBB = nullptr;
John McCall31168b02011-06-15 23:02:42 +00003134
3135 // If the argument wasn't provably non-null, we need to null check
3136 // before doing the store.
Nuno Lopes9211cee2017-09-09 18:25:36 +00003137 bool provablyNonNull = llvm::isKnownNonZero(srcAddr.getPointer(),
3138 CGF.CGM.getDataLayout());
John McCall31168b02011-06-15 23:02:42 +00003139 if (!provablyNonNull) {
3140 llvm::BasicBlock *writebackBB = CGF.createBasicBlock("icr.writeback");
3141 contBB = CGF.createBasicBlock("icr.done");
3142
John McCall7f416cc2015-09-08 08:05:57 +00003143 llvm::Value *isNull =
3144 CGF.Builder.CreateIsNull(srcAddr.getPointer(), "icr.isnull");
John McCall31168b02011-06-15 23:02:42 +00003145 CGF.Builder.CreateCondBr(isNull, contBB, writebackBB);
3146 CGF.EmitBlock(writebackBB);
3147 }
3148
3149 // Load the value to writeback.
3150 llvm::Value *value = CGF.Builder.CreateLoad(writeback.Temporary);
3151
3152 // Cast it back, in case we're writing an id to a Foo* or something.
John McCall7f416cc2015-09-08 08:05:57 +00003153 value = CGF.Builder.CreateBitCast(value, srcAddr.getElementType(),
3154 "icr.writeback-cast");
Fangrui Song6907ce22018-07-30 19:24:48 +00003155
John McCall31168b02011-06-15 23:02:42 +00003156 // Perform the writeback.
John McCalleff18842013-03-23 02:35:54 +00003157
3158 // If we have a "to use" value, it's something we need to emit a use
3159 // of. This has to be carefully threaded in: if it's done after the
3160 // release it's potentially undefined behavior (and the optimizer
3161 // will ignore it), and if it happens before the retain then the
3162 // optimizer could move the release there.
3163 if (writeback.ToUse) {
3164 assert(srcLV.getObjCLifetime() == Qualifiers::OCL_Strong);
3165
3166 // Retain the new value. No need to block-copy here: the block's
3167 // being passed up the stack.
3168 value = CGF.EmitARCRetainNonBlock(value);
3169
3170 // Emit the intrinsic use here.
3171 CGF.EmitARCIntrinsicUse(writeback.ToUse);
3172
3173 // Load the old value (primitively).
Nick Lewycky2d84e842013-10-02 02:29:49 +00003174 llvm::Value *oldValue = CGF.EmitLoadOfScalar(srcLV, SourceLocation());
John McCalleff18842013-03-23 02:35:54 +00003175
3176 // Put the new value in place (primitively).
3177 CGF.EmitStoreOfScalar(value, srcLV, /*init*/ false);
3178
3179 // Release the old value.
3180 CGF.EmitARCRelease(oldValue, srcLV.isARCPreciseLifetime());
3181
3182 // Otherwise, we can just do a normal lvalue store.
3183 } else {
3184 CGF.EmitStoreThroughLValue(RValue::get(value), srcLV);
3185 }
John McCall31168b02011-06-15 23:02:42 +00003186
3187 // Jump to the continuation block.
3188 if (!provablyNonNull)
3189 CGF.EmitBlock(contBB);
3190}
3191
3192static void emitWritebacks(CodeGenFunction &CGF,
3193 const CallArgList &args) {
Aaron Ballman36a7fa82014-03-17 17:22:27 +00003194 for (const auto &I : args.writebacks())
3195 emitWriteback(CGF, I);
John McCall31168b02011-06-15 23:02:42 +00003196}
3197
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003198static void deactivateArgCleanupsBeforeCall(CodeGenFunction &CGF,
3199 const CallArgList &CallArgs) {
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003200 ArrayRef<CallArgList::CallArgCleanup> Cleanups =
3201 CallArgs.getCleanupsToDeactivate();
3202 // Iterate in reverse to increase the likelihood of popping the cleanup.
Pete Cooper57d3f142015-07-30 17:22:52 +00003203 for (const auto &I : llvm::reverse(Cleanups)) {
3204 CGF.DeactivateCleanupBlock(I.Cleanup, I.IsActiveIP);
3205 I.IsActiveIP->eraseFromParent();
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003206 }
3207}
3208
John McCalleff18842013-03-23 02:35:54 +00003209static const Expr *maybeGetUnaryAddrOfOperand(const Expr *E) {
3210 if (const UnaryOperator *uop = dyn_cast<UnaryOperator>(E->IgnoreParens()))
3211 if (uop->getOpcode() == UO_AddrOf)
3212 return uop->getSubExpr();
Craig Topper8a13c412014-05-21 05:09:00 +00003213 return nullptr;
John McCalleff18842013-03-23 02:35:54 +00003214}
3215
John McCall31168b02011-06-15 23:02:42 +00003216/// Emit an argument that's being passed call-by-writeback. That is,
John McCall7f416cc2015-09-08 08:05:57 +00003217/// we are passing the address of an __autoreleased temporary; it
3218/// might be copy-initialized with the current value of the given
3219/// address, but it will definitely be copied out of after the call.
John McCall31168b02011-06-15 23:02:42 +00003220static void emitWritebackArg(CodeGenFunction &CGF, CallArgList &args,
3221 const ObjCIndirectCopyRestoreExpr *CRE) {
John McCalleff18842013-03-23 02:35:54 +00003222 LValue srcLV;
3223
3224 // Make an optimistic effort to emit the address as an l-value.
Eric Christopher2c4555a2015-06-19 01:52:53 +00003225 // This can fail if the argument expression is more complicated.
John McCalleff18842013-03-23 02:35:54 +00003226 if (const Expr *lvExpr = maybeGetUnaryAddrOfOperand(CRE->getSubExpr())) {
3227 srcLV = CGF.EmitLValue(lvExpr);
3228
3229 // Otherwise, just emit it as a scalar.
3230 } else {
John McCall7f416cc2015-09-08 08:05:57 +00003231 Address srcAddr = CGF.EmitPointerWithAlignment(CRE->getSubExpr());
John McCalleff18842013-03-23 02:35:54 +00003232
3233 QualType srcAddrType =
3234 CRE->getSubExpr()->getType()->castAs<PointerType>()->getPointeeType();
John McCall7f416cc2015-09-08 08:05:57 +00003235 srcLV = CGF.MakeAddrLValue(srcAddr, srcAddrType);
John McCalleff18842013-03-23 02:35:54 +00003236 }
John McCall7f416cc2015-09-08 08:05:57 +00003237 Address srcAddr = srcLV.getAddress();
John McCall31168b02011-06-15 23:02:42 +00003238
3239 // The dest and src types don't necessarily match in LLVM terms
3240 // because of the crazy ObjC compatibility rules.
3241
Chris Lattner2192fe52011-07-18 04:24:23 +00003242 llvm::PointerType *destType =
John McCall31168b02011-06-15 23:02:42 +00003243 cast<llvm::PointerType>(CGF.ConvertType(CRE->getType()));
3244
3245 // If the address is a constant null, just pass the appropriate null.
John McCall7f416cc2015-09-08 08:05:57 +00003246 if (isProvablyNull(srcAddr.getPointer())) {
John McCall31168b02011-06-15 23:02:42 +00003247 args.add(RValue::get(llvm::ConstantPointerNull::get(destType)),
3248 CRE->getType());
3249 return;
3250 }
3251
John McCall31168b02011-06-15 23:02:42 +00003252 // Create the temporary.
John McCall7f416cc2015-09-08 08:05:57 +00003253 Address temp = CGF.CreateTempAlloca(destType->getElementType(),
3254 CGF.getPointerAlign(),
3255 "icr.temp");
Fariborz Jahanianfbd19742012-11-27 23:02:53 +00003256 // Loading an l-value can introduce a cleanup if the l-value is __weak,
3257 // and that cleanup will be conditional if we can't prove that the l-value
3258 // isn't null, so we need to register a dominating point so that the cleanups
3259 // system will make valid IR.
3260 CodeGenFunction::ConditionalEvaluation condEval(CGF);
Fangrui Song6907ce22018-07-30 19:24:48 +00003261
John McCall31168b02011-06-15 23:02:42 +00003262 // Zero-initialize it if we're not doing a copy-initialization.
3263 bool shouldCopy = CRE->shouldCopy();
3264 if (!shouldCopy) {
3265 llvm::Value *null =
3266 llvm::ConstantPointerNull::get(
3267 cast<llvm::PointerType>(destType->getElementType()));
3268 CGF.Builder.CreateStore(null, temp);
3269 }
Craig Topper8a13c412014-05-21 05:09:00 +00003270
3271 llvm::BasicBlock *contBB = nullptr;
3272 llvm::BasicBlock *originBB = nullptr;
John McCall31168b02011-06-15 23:02:42 +00003273
3274 // If the address is *not* known to be non-null, we need to switch.
3275 llvm::Value *finalArgument;
3276
Nuno Lopes9211cee2017-09-09 18:25:36 +00003277 bool provablyNonNull = llvm::isKnownNonZero(srcAddr.getPointer(),
3278 CGF.CGM.getDataLayout());
John McCall31168b02011-06-15 23:02:42 +00003279 if (provablyNonNull) {
John McCall7f416cc2015-09-08 08:05:57 +00003280 finalArgument = temp.getPointer();
John McCall31168b02011-06-15 23:02:42 +00003281 } else {
John McCall7f416cc2015-09-08 08:05:57 +00003282 llvm::Value *isNull =
3283 CGF.Builder.CreateIsNull(srcAddr.getPointer(), "icr.isnull");
John McCall31168b02011-06-15 23:02:42 +00003284
Fangrui Song6907ce22018-07-30 19:24:48 +00003285 finalArgument = CGF.Builder.CreateSelect(isNull,
John McCall31168b02011-06-15 23:02:42 +00003286 llvm::ConstantPointerNull::get(destType),
John McCall7f416cc2015-09-08 08:05:57 +00003287 temp.getPointer(), "icr.argument");
John McCall31168b02011-06-15 23:02:42 +00003288
3289 // If we need to copy, then the load has to be conditional, which
3290 // means we need control flow.
3291 if (shouldCopy) {
John McCalleff18842013-03-23 02:35:54 +00003292 originBB = CGF.Builder.GetInsertBlock();
John McCall31168b02011-06-15 23:02:42 +00003293 contBB = CGF.createBasicBlock("icr.cont");
3294 llvm::BasicBlock *copyBB = CGF.createBasicBlock("icr.copy");
3295 CGF.Builder.CreateCondBr(isNull, contBB, copyBB);
3296 CGF.EmitBlock(copyBB);
Fariborz Jahanianfbd19742012-11-27 23:02:53 +00003297 condEval.begin(CGF);
John McCall31168b02011-06-15 23:02:42 +00003298 }
3299 }
3300
Craig Topper8a13c412014-05-21 05:09:00 +00003301 llvm::Value *valueToUse = nullptr;
John McCalleff18842013-03-23 02:35:54 +00003302
John McCall31168b02011-06-15 23:02:42 +00003303 // Perform a copy if necessary.
3304 if (shouldCopy) {
Nick Lewycky2d84e842013-10-02 02:29:49 +00003305 RValue srcRV = CGF.EmitLoadOfLValue(srcLV, SourceLocation());
John McCall31168b02011-06-15 23:02:42 +00003306 assert(srcRV.isScalar());
3307
3308 llvm::Value *src = srcRV.getScalarVal();
3309 src = CGF.Builder.CreateBitCast(src, destType->getElementType(),
3310 "icr.cast");
3311
3312 // Use an ordinary store, not a store-to-lvalue.
3313 CGF.Builder.CreateStore(src, temp);
John McCalleff18842013-03-23 02:35:54 +00003314
3315 // If optimization is enabled, and the value was held in a
3316 // __strong variable, we need to tell the optimizer that this
3317 // value has to stay alive until we're doing the store back.
3318 // This is because the temporary is effectively unretained,
3319 // and so otherwise we can violate the high-level semantics.
3320 if (CGF.CGM.getCodeGenOpts().OptimizationLevel != 0 &&
3321 srcLV.getObjCLifetime() == Qualifiers::OCL_Strong) {
3322 valueToUse = src;
3323 }
John McCall31168b02011-06-15 23:02:42 +00003324 }
Fangrui Song6907ce22018-07-30 19:24:48 +00003325
John McCall31168b02011-06-15 23:02:42 +00003326 // Finish the control flow if we needed it.
Fariborz Jahanianfbd19742012-11-27 23:02:53 +00003327 if (shouldCopy && !provablyNonNull) {
John McCalleff18842013-03-23 02:35:54 +00003328 llvm::BasicBlock *copyBB = CGF.Builder.GetInsertBlock();
John McCall31168b02011-06-15 23:02:42 +00003329 CGF.EmitBlock(contBB);
John McCalleff18842013-03-23 02:35:54 +00003330
3331 // Make a phi for the value to intrinsically use.
3332 if (valueToUse) {
3333 llvm::PHINode *phiToUse = CGF.Builder.CreatePHI(valueToUse->getType(), 2,
3334 "icr.to-use");
3335 phiToUse->addIncoming(valueToUse, copyBB);
3336 phiToUse->addIncoming(llvm::UndefValue::get(valueToUse->getType()),
3337 originBB);
3338 valueToUse = phiToUse;
3339 }
3340
Fariborz Jahanianfbd19742012-11-27 23:02:53 +00003341 condEval.end(CGF);
3342 }
John McCall31168b02011-06-15 23:02:42 +00003343
John McCalleff18842013-03-23 02:35:54 +00003344 args.addWriteback(srcLV, temp, valueToUse);
John McCall31168b02011-06-15 23:02:42 +00003345 args.add(RValue::get(finalArgument), CRE->getType());
3346}
3347
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003348void CallArgList::allocateArgumentMemory(CodeGenFunction &CGF) {
Richard Smith762672a2016-09-28 19:09:10 +00003349 assert(!StackBase);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003350
3351 // Save the stack.
3352 llvm::Function *F = CGF.CGM.getIntrinsic(llvm::Intrinsic::stacksave);
David Blaikie43f9bb72015-05-18 22:14:03 +00003353 StackBase = CGF.Builder.CreateCall(F, {}, "inalloca.save");
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003354}
3355
Nico Weber8cdb3f92015-08-25 18:43:32 +00003356void CallArgList::freeArgumentMemory(CodeGenFunction &CGF) const {
3357 if (StackBase) {
Reid Kleckner7c2f9e82015-10-08 00:17:45 +00003358 // Restore the stack after the call.
Nico Weber8cdb3f92015-08-25 18:43:32 +00003359 llvm::Value *F = CGF.CGM.getIntrinsic(llvm::Intrinsic::stackrestore);
Nico Weber8cdb3f92015-08-25 18:43:32 +00003360 CGF.Builder.CreateCall(F, StackBase);
3361 }
3362}
3363
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003364void CodeGenFunction::EmitNonNullArgCheck(RValue RV, QualType ArgType,
3365 SourceLocation ArgLoc,
Vedant Kumared00ea02017-03-06 05:28:22 +00003366 AbstractCallee AC,
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003367 unsigned ParmNum) {
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003368 if (!AC.getDecl() || !(SanOpts.has(SanitizerKind::NonnullAttribute) ||
3369 SanOpts.has(SanitizerKind::NullabilityArg)))
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003370 return;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003371
3372 // The param decl may be missing in a variadic function.
Vedant Kumared00ea02017-03-06 05:28:22 +00003373 auto PVD = ParmNum < AC.getNumParams() ? AC.getParamDecl(ParmNum) : nullptr;
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003374 unsigned ArgNo = PVD ? PVD->getFunctionScopeIndex() : ParmNum;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003375
Fangrui Song6907ce22018-07-30 19:24:48 +00003376 // Prefer the nonnull attribute if it's present.
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003377 const NonNullAttr *NNAttr = nullptr;
3378 if (SanOpts.has(SanitizerKind::NonnullAttribute))
3379 NNAttr = getNonNullAttr(AC.getDecl(), PVD, ArgType, ArgNo);
3380
3381 bool CanCheckNullability = false;
3382 if (SanOpts.has(SanitizerKind::NullabilityArg) && !NNAttr && PVD) {
3383 auto Nullability = PVD->getType()->getNullability(getContext());
3384 CanCheckNullability = Nullability &&
3385 *Nullability == NullabilityKind::NonNull &&
3386 PVD->getTypeSourceInfo();
3387 }
3388
3389 if (!NNAttr && !CanCheckNullability)
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003390 return;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003391
3392 SourceLocation AttrLoc;
3393 SanitizerMask CheckKind;
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00003394 SanitizerHandler Handler;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003395 if (NNAttr) {
3396 AttrLoc = NNAttr->getLocation();
3397 CheckKind = SanitizerKind::NonnullAttribute;
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00003398 Handler = SanitizerHandler::NonnullArg;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003399 } else {
3400 AttrLoc = PVD->getTypeSourceInfo()->getTypeLoc().findNullabilityLoc();
3401 CheckKind = SanitizerKind::NullabilityArg;
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00003402 Handler = SanitizerHandler::NullabilityArg;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003403 }
3404
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003405 SanitizerScope SanScope(this);
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003406 assert(RV.isScalar());
3407 llvm::Value *V = RV.getScalarVal();
3408 llvm::Value *Cond =
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003409 Builder.CreateICmpNE(V, llvm::Constant::getNullValue(V->getType()));
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003410 llvm::Constant *StaticData[] = {
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003411 EmitCheckSourceLocation(ArgLoc), EmitCheckSourceLocation(AttrLoc),
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003412 llvm::ConstantInt::get(Int32Ty, ArgNo + 1),
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003413 };
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00003414 EmitCheck(std::make_pair(Cond, CheckKind), Handler, StaticData, None);
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003415}
3416
David Blaikief05779e2015-07-21 18:37:18 +00003417void CodeGenFunction::EmitCallArgs(
3418 CallArgList &Args, ArrayRef<QualType> ArgTypes,
3419 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Vedant Kumared00ea02017-03-06 05:28:22 +00003420 AbstractCallee AC, unsigned ParamsToSkip, EvaluationOrder Order) {
David Blaikief05779e2015-07-21 18:37:18 +00003421 assert((int)ArgTypes.size() == (ArgRange.end() - ArgRange.begin()));
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003422
Reid Kleckner739756c2013-12-04 19:23:12 +00003423 // We *have* to evaluate arguments from right to left in the MS C++ ABI,
Richard Smitha560ccf2016-09-29 21:30:12 +00003424 // because arguments are destroyed left to right in the callee. As a special
3425 // case, there are certain language constructs that require left-to-right
3426 // evaluation, and in those cases we consider the evaluation order requirement
3427 // to trump the "destruction order is reverse construction order" guarantee.
3428 bool LeftToRight =
3429 CGM.getTarget().getCXXABI().areArgsDestroyedLeftToRightInCallee()
3430 ? Order == EvaluationOrder::ForceLeftToRight
3431 : Order != EvaluationOrder::ForceRightToLeft;
3432
George Burgess IV0d6592a2017-02-23 05:59:56 +00003433 auto MaybeEmitImplicitObjectSize = [&](unsigned I, const Expr *Arg,
3434 RValue EmittedArg) {
Vedant Kumared00ea02017-03-06 05:28:22 +00003435 if (!AC.hasFunctionDecl() || I >= AC.getNumParams())
George Burgess IV0d6592a2017-02-23 05:59:56 +00003436 return;
Vedant Kumared00ea02017-03-06 05:28:22 +00003437 auto *PS = AC.getParamDecl(I)->getAttr<PassObjectSizeAttr>();
George Burgess IV0d6592a2017-02-23 05:59:56 +00003438 if (PS == nullptr)
3439 return;
3440
3441 const auto &Context = getContext();
3442 auto SizeTy = Context.getSizeType();
3443 auto T = Builder.getIntNTy(Context.getTypeSize(SizeTy));
3444 assert(EmittedArg.getScalarVal() && "We emitted nothing for the arg?");
3445 llvm::Value *V = evaluateOrEmitBuiltinObjectSize(Arg, PS->getType(), T,
3446 EmittedArg.getScalarVal());
3447 Args.add(RValue::get(V), SizeTy);
3448 // If we're emitting args in reverse, be sure to do so with
3449 // pass_object_size, as well.
3450 if (!LeftToRight)
3451 std::swap(Args.back(), *(&Args.back() - 1));
3452 };
3453
Richard Smitha560ccf2016-09-29 21:30:12 +00003454 // Insert a stack save if we're going to need any inalloca args.
3455 bool HasInAllocaArgs = false;
3456 if (CGM.getTarget().getCXXABI().isMicrosoft()) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003457 for (ArrayRef<QualType>::iterator I = ArgTypes.begin(), E = ArgTypes.end();
3458 I != E && !HasInAllocaArgs; ++I)
3459 HasInAllocaArgs = isInAllocaArgument(CGM.getCXXABI(), *I);
3460 if (HasInAllocaArgs) {
3461 assert(getTarget().getTriple().getArch() == llvm::Triple::x86);
3462 Args.allocateArgumentMemory(*this);
3463 }
Richard Smitha560ccf2016-09-29 21:30:12 +00003464 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003465
Richard Smitha560ccf2016-09-29 21:30:12 +00003466 // Evaluate each argument in the appropriate order.
3467 size_t CallArgsStart = Args.size();
3468 for (unsigned I = 0, E = ArgTypes.size(); I != E; ++I) {
3469 unsigned Idx = LeftToRight ? I : E - I - 1;
3470 CallExpr::const_arg_iterator Arg = ArgRange.begin() + Idx;
George Burgess IV0d6592a2017-02-23 05:59:56 +00003471 unsigned InitialArgSize = Args.size();
Akira Hatanaka46dd7dbc2017-06-28 00:42:48 +00003472 // If *Arg is an ObjCIndirectCopyRestoreExpr, check that either the types of
3473 // the argument and parameter match or the objc method is parameterized.
3474 assert((!isa<ObjCIndirectCopyRestoreExpr>(*Arg) ||
3475 getContext().hasSameUnqualifiedType((*Arg)->getType(),
3476 ArgTypes[Idx]) ||
3477 (isa<ObjCMethodDecl>(AC.getDecl()) &&
3478 isObjCMethodWithTypeParams(cast<ObjCMethodDecl>(AC.getDecl())))) &&
3479 "Argument and parameter types don't match");
Richard Smitha560ccf2016-09-29 21:30:12 +00003480 EmitCallArg(Args, *Arg, ArgTypes[Idx]);
George Burgess IV0d6592a2017-02-23 05:59:56 +00003481 // In particular, we depend on it being the last arg in Args, and the
3482 // objectsize bits depend on there only being one arg if !LeftToRight.
3483 assert(InitialArgSize + 1 == Args.size() &&
3484 "The code below depends on only adding one arg per EmitCallArg");
3485 (void)InitialArgSize;
Yaxun Liu5b330e82018-03-15 15:25:19 +00003486 // Since pointer argument are never emitted as LValue, it is safe to emit
3487 // non-null argument check for r-value only.
3488 if (!Args.back().hasLValue()) {
3489 RValue RVArg = Args.back().getKnownRValue();
3490 EmitNonNullArgCheck(RVArg, ArgTypes[Idx], (*Arg)->getExprLoc(), AC,
3491 ParamsToSkip + Idx);
3492 // @llvm.objectsize should never have side-effects and shouldn't need
3493 // destruction/cleanups, so we can safely "emit" it after its arg,
3494 // regardless of right-to-leftness
3495 MaybeEmitImplicitObjectSize(Idx, *Arg, RVArg);
3496 }
Richard Smitha560ccf2016-09-29 21:30:12 +00003497 }
Reid Kleckner739756c2013-12-04 19:23:12 +00003498
Richard Smitha560ccf2016-09-29 21:30:12 +00003499 if (!LeftToRight) {
Reid Kleckner739756c2013-12-04 19:23:12 +00003500 // Un-reverse the arguments we just evaluated so they match up with the LLVM
3501 // IR function.
3502 std::reverse(Args.begin() + CallArgsStart, Args.end());
Reid Kleckner739756c2013-12-04 19:23:12 +00003503 }
3504}
3505
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003506namespace {
3507
David Blaikie7e70d682015-08-18 22:40:54 +00003508struct DestroyUnpassedArg final : EHScopeStack::Cleanup {
John McCall7f416cc2015-09-08 08:05:57 +00003509 DestroyUnpassedArg(Address Addr, QualType Ty)
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003510 : Addr(Addr), Ty(Ty) {}
3511
John McCall7f416cc2015-09-08 08:05:57 +00003512 Address Addr;
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003513 QualType Ty;
3514
Craig Topper4f12f102014-03-12 06:41:41 +00003515 void Emit(CodeGenFunction &CGF, Flags flags) override {
Akira Hatanaka7275da02018-02-28 07:15:55 +00003516 QualType::DestructionKind DtorKind = Ty.isDestructedType();
3517 if (DtorKind == QualType::DK_cxx_destructor) {
3518 const CXXDestructorDecl *Dtor = Ty->getAsCXXRecordDecl()->getDestructor();
3519 assert(!Dtor->isTrivial());
3520 CGF.EmitCXXDestructorCall(Dtor, Dtor_Complete, /*for vbase*/ false,
3521 /*Delegating=*/false, Addr);
3522 } else {
3523 CGF.callCStructDestructor(CGF.MakeAddrLValue(Addr, Ty));
3524 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003525 }
3526};
3527
David Blaikie38b25912015-02-09 19:13:51 +00003528struct DisableDebugLocationUpdates {
3529 CodeGenFunction &CGF;
3530 bool disabledDebugInfo;
3531 DisableDebugLocationUpdates(CodeGenFunction &CGF, const Expr *E) : CGF(CGF) {
3532 if ((disabledDebugInfo = isa<CXXDefaultArgExpr>(E) && CGF.getDebugInfo()))
3533 CGF.disableDebugInfo();
3534 }
3535 ~DisableDebugLocationUpdates() {
3536 if (disabledDebugInfo)
3537 CGF.enableDebugInfo();
3538 }
3539};
3540
Benjamin Kramer5b4296a2015-10-28 17:16:26 +00003541} // end anonymous namespace
3542
Yaxun Liu5b330e82018-03-15 15:25:19 +00003543RValue CallArg::getRValue(CodeGenFunction &CGF) const {
3544 if (!HasLV)
3545 return RV;
3546 LValue Copy = CGF.MakeAddrLValue(CGF.CreateMemTemp(Ty), Ty);
Richard Smithe78fac52018-04-05 20:52:58 +00003547 CGF.EmitAggregateCopy(Copy, LV, Ty, AggValueSlot::DoesNotOverlap,
3548 LV.isVolatile());
Yaxun Liu5b330e82018-03-15 15:25:19 +00003549 IsUsed = true;
3550 return RValue::getAggregate(Copy.getAddress());
3551}
3552
3553void CallArg::copyInto(CodeGenFunction &CGF, Address Addr) const {
3554 LValue Dst = CGF.MakeAddrLValue(Addr, Ty);
3555 if (!HasLV && RV.isScalar())
3556 CGF.EmitStoreOfScalar(RV.getScalarVal(), Dst, /*init=*/true);
3557 else if (!HasLV && RV.isComplex())
3558 CGF.EmitStoreOfComplex(RV.getComplexVal(), Dst, /*init=*/true);
3559 else {
3560 auto Addr = HasLV ? LV.getAddress() : RV.getAggregateAddress();
3561 LValue SrcLV = CGF.MakeAddrLValue(Addr, Ty);
Richard Smithe78fac52018-04-05 20:52:58 +00003562 // We assume that call args are never copied into subobjects.
3563 CGF.EmitAggregateCopy(Dst, SrcLV, Ty, AggValueSlot::DoesNotOverlap,
Yaxun Liu5b330e82018-03-15 15:25:19 +00003564 HasLV ? LV.isVolatileQualified()
3565 : RV.isVolatileQualified());
3566 }
3567 IsUsed = true;
3568}
3569
John McCall32ea9692011-03-11 20:59:21 +00003570void CodeGenFunction::EmitCallArg(CallArgList &args, const Expr *E,
3571 QualType type) {
David Blaikie38b25912015-02-09 19:13:51 +00003572 DisableDebugLocationUpdates Dis(*this, E);
John McCall31168b02011-06-15 23:02:42 +00003573 if (const ObjCIndirectCopyRestoreExpr *CRE
3574 = dyn_cast<ObjCIndirectCopyRestoreExpr>(E)) {
Richard Smith9c6890a2012-11-01 22:30:59 +00003575 assert(getLangOpts().ObjCAutoRefCount);
John McCall31168b02011-06-15 23:02:42 +00003576 return emitWritebackArg(*this, args, CRE);
3577 }
3578
John McCall0a76c0c2011-08-26 18:42:59 +00003579 assert(type->isReferenceType() == E->isGLValue() &&
3580 "reference binding to unmaterialized r-value!");
3581
John McCall17054bd62011-08-26 21:08:13 +00003582 if (E->isGLValue()) {
3583 assert(E->getObjectKind() == OK_Ordinary);
Richard Smitha1c9d4d2013-06-12 23:38:09 +00003584 return args.add(EmitReferenceBindingToExpr(E), type);
John McCall17054bd62011-08-26 21:08:13 +00003585 }
Mike Stump11289f42009-09-09 15:08:12 +00003586
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003587 bool HasAggregateEvalKind = hasAggregateEvaluationKind(type);
3588
3589 // In the Microsoft C++ ABI, aggregate arguments are destructed by the callee.
3590 // However, we still have to push an EH-only cleanup in case we unwind before
3591 // we make it to the call.
Akira Hatanaka85282972018-05-15 21:00:30 +00003592 if (HasAggregateEvalKind &&
3593 type->getAs<RecordType>()->getDecl()->isParamDestroyedInCallee()) {
Reid Klecknerac640602014-05-01 03:07:18 +00003594 // If we're using inalloca, use the argument memory. Otherwise, use a
Reid Klecknere39ee212014-05-03 00:33:28 +00003595 // temporary.
Reid Klecknerac640602014-05-01 03:07:18 +00003596 AggValueSlot Slot;
3597 if (args.isUsingInAlloca())
3598 Slot = createPlaceholderSlot(*this, type);
3599 else
3600 Slot = CreateAggTemp(type, "agg.tmp");
Reid Klecknere39ee212014-05-03 00:33:28 +00003601
Akira Hatanaka4ce0e5a2018-04-18 23:33:15 +00003602 bool DestroyedInCallee = true, NeedsEHCleanup = true;
3603 if (const auto *RD = type->getAsCXXRecordDecl())
3604 DestroyedInCallee = RD->hasNonTrivialDestructor();
3605 else
3606 NeedsEHCleanup = needsEHCleanup(type.isDestructedType());
3607
3608 if (DestroyedInCallee)
3609 Slot.setExternallyDestructed();
Reid Klecknere39ee212014-05-03 00:33:28 +00003610
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003611 EmitAggExpr(E, Slot);
3612 RValue RV = Slot.asRValue();
3613 args.add(RV, type);
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003614
Akira Hatanaka4ce0e5a2018-04-18 23:33:15 +00003615 if (DestroyedInCallee && NeedsEHCleanup) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003616 // Create a no-op GEP between the placeholder and the cleanup so we can
3617 // RAUW it successfully. It also serves as a marker of the first
3618 // instruction where the cleanup is active.
John McCall7f416cc2015-09-08 08:05:57 +00003619 pushFullExprCleanup<DestroyUnpassedArg>(EHCleanup, Slot.getAddress(),
3620 type);
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003621 // This unreachable is a temporary marker which will be removed later.
3622 llvm::Instruction *IsActive = Builder.CreateUnreachable();
3623 args.addArgCleanupDeactivation(EHStack.getInnermostEHScope(), IsActive);
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003624 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003625 return;
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003626 }
3627
3628 if (HasAggregateEvalKind && isa<ImplicitCastExpr>(E) &&
Eli Friedmandf968192011-05-26 00:10:27 +00003629 cast<CastExpr>(E)->getCastKind() == CK_LValueToRValue) {
3630 LValue L = EmitLValue(cast<CastExpr>(E)->getSubExpr());
3631 assert(L.isSimple());
Yaxun Liu5b330e82018-03-15 15:25:19 +00003632 args.addUncopiedAggregate(L, type);
Eli Friedmandf968192011-05-26 00:10:27 +00003633 return;
3634 }
3635
John McCall32ea9692011-03-11 20:59:21 +00003636 args.add(EmitAnyExprToTemp(E), type);
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00003637}
3638
Reid Kleckner79b0fd72014-10-10 00:05:45 +00003639QualType CodeGenFunction::getVarArgType(const Expr *Arg) {
3640 // System headers on Windows define NULL to 0 instead of 0LL on Win64. MSVC
3641 // implicitly widens null pointer constants that are arguments to varargs
3642 // functions to pointer-sized ints.
3643 if (!getTarget().getTriple().isOSWindows())
3644 return Arg->getType();
3645
3646 if (Arg->getType()->isIntegerType() &&
3647 getContext().getTypeSize(Arg->getType()) <
3648 getContext().getTargetInfo().getPointerWidth(0) &&
3649 Arg->isNullPointerConstant(getContext(),
3650 Expr::NPC_ValueDependentIsNotNull)) {
3651 return getContext().getIntPtrType();
3652 }
3653
3654 return Arg->getType();
3655}
3656
Dan Gohman515a60d2012-02-16 00:57:37 +00003657// In ObjC ARC mode with no ObjC ARC exception safety, tell the ARC
3658// optimizer it can aggressively ignore unwind edges.
3659void
3660CodeGenFunction::AddObjCARCExceptionMetadata(llvm::Instruction *Inst) {
3661 if (CGM.getCodeGenOpts().OptimizationLevel != 0 &&
3662 !CGM.getCodeGenOpts().ObjCAutoRefCountExceptions)
3663 Inst->setMetadata("clang.arc.no_objc_arc_exceptions",
3664 CGM.getNoObjCARCExceptionsMetadata());
3665}
3666
John McCall882987f2013-02-28 19:01:20 +00003667/// Emits a call to the given no-arguments nounwind runtime function.
3668llvm::CallInst *
3669CodeGenFunction::EmitNounwindRuntimeCall(llvm::Value *callee,
3670 const llvm::Twine &name) {
Craig Topper5fc8fc22014-08-27 06:28:36 +00003671 return EmitNounwindRuntimeCall(callee, None, name);
John McCall882987f2013-02-28 19:01:20 +00003672}
3673
3674/// Emits a call to the given nounwind runtime function.
3675llvm::CallInst *
3676CodeGenFunction::EmitNounwindRuntimeCall(llvm::Value *callee,
3677 ArrayRef<llvm::Value*> args,
3678 const llvm::Twine &name) {
3679 llvm::CallInst *call = EmitRuntimeCall(callee, args, name);
3680 call->setDoesNotThrow();
3681 return call;
3682}
3683
3684/// Emits a simple call (never an invoke) to the given no-arguments
3685/// runtime function.
3686llvm::CallInst *
3687CodeGenFunction::EmitRuntimeCall(llvm::Value *callee,
3688 const llvm::Twine &name) {
Craig Topper5fc8fc22014-08-27 06:28:36 +00003689 return EmitRuntimeCall(callee, None, name);
John McCall882987f2013-02-28 19:01:20 +00003690}
3691
David Majnemer0b17d442015-12-15 21:27:59 +00003692// Calls which may throw must have operand bundles indicating which funclet
3693// they are nested within.
Reid Klecknerb75a3f02018-02-09 00:16:41 +00003694SmallVector<llvm::OperandBundleDef, 1>
3695CodeGenFunction::getBundlesForFunclet(llvm::Value *Callee) {
3696 SmallVector<llvm::OperandBundleDef, 1> BundleList;
Sanjay Patel846b63b2016-01-18 22:15:33 +00003697 // There is no need for a funclet operand bundle if we aren't inside a
3698 // funclet.
David Majnemer0b17d442015-12-15 21:27:59 +00003699 if (!CurrentFuncletPad)
Reid Klecknerb75a3f02018-02-09 00:16:41 +00003700 return BundleList;
David Majnemer0b17d442015-12-15 21:27:59 +00003701
3702 // Skip intrinsics which cannot throw.
3703 auto *CalleeFn = dyn_cast<llvm::Function>(Callee->stripPointerCasts());
3704 if (CalleeFn && CalleeFn->isIntrinsic() && CalleeFn->doesNotThrow())
Reid Klecknerb75a3f02018-02-09 00:16:41 +00003705 return BundleList;
David Majnemer0b17d442015-12-15 21:27:59 +00003706
3707 BundleList.emplace_back("funclet", CurrentFuncletPad);
Reid Klecknerb75a3f02018-02-09 00:16:41 +00003708 return BundleList;
David Majnemer0b17d442015-12-15 21:27:59 +00003709}
3710
David Majnemer971d31b2016-02-24 17:02:45 +00003711/// Emits a simple call (never an invoke) to the given runtime function.
3712llvm::CallInst *
3713CodeGenFunction::EmitRuntimeCall(llvm::Value *callee,
3714 ArrayRef<llvm::Value*> args,
3715 const llvm::Twine &name) {
Reid Klecknerb75a3f02018-02-09 00:16:41 +00003716 llvm::CallInst *call =
3717 Builder.CreateCall(callee, args, getBundlesForFunclet(callee), name);
David Majnemer971d31b2016-02-24 17:02:45 +00003718 call->setCallingConv(getRuntimeCC());
3719 return call;
3720}
3721
John McCall882987f2013-02-28 19:01:20 +00003722/// Emits a call or invoke to the given noreturn runtime function.
3723void CodeGenFunction::EmitNoreturnRuntimeCallOrInvoke(llvm::Value *callee,
3724 ArrayRef<llvm::Value*> args) {
Reid Klecknerb75a3f02018-02-09 00:16:41 +00003725 SmallVector<llvm::OperandBundleDef, 1> BundleList =
3726 getBundlesForFunclet(callee);
David Majnemer0b17d442015-12-15 21:27:59 +00003727
John McCall882987f2013-02-28 19:01:20 +00003728 if (getInvokeDest()) {
Fangrui Song6907ce22018-07-30 19:24:48 +00003729 llvm::InvokeInst *invoke =
John McCall882987f2013-02-28 19:01:20 +00003730 Builder.CreateInvoke(callee,
3731 getUnreachableBlock(),
3732 getInvokeDest(),
David Majnemer0b17d442015-12-15 21:27:59 +00003733 args,
3734 BundleList);
John McCall882987f2013-02-28 19:01:20 +00003735 invoke->setDoesNotReturn();
3736 invoke->setCallingConv(getRuntimeCC());
3737 } else {
David Majnemer0b17d442015-12-15 21:27:59 +00003738 llvm::CallInst *call = Builder.CreateCall(callee, args, BundleList);
John McCall882987f2013-02-28 19:01:20 +00003739 call->setDoesNotReturn();
3740 call->setCallingConv(getRuntimeCC());
3741 Builder.CreateUnreachable();
3742 }
3743}
3744
Sanjay Patel846b63b2016-01-18 22:15:33 +00003745/// Emits a call or invoke instruction to the given nullary runtime function.
John McCall882987f2013-02-28 19:01:20 +00003746llvm::CallSite
3747CodeGenFunction::EmitRuntimeCallOrInvoke(llvm::Value *callee,
3748 const Twine &name) {
Craig Topper5fc8fc22014-08-27 06:28:36 +00003749 return EmitRuntimeCallOrInvoke(callee, None, name);
John McCall882987f2013-02-28 19:01:20 +00003750}
3751
3752/// Emits a call or invoke instruction to the given runtime function.
3753llvm::CallSite
3754CodeGenFunction::EmitRuntimeCallOrInvoke(llvm::Value *callee,
3755 ArrayRef<llvm::Value*> args,
3756 const Twine &name) {
3757 llvm::CallSite callSite = EmitCallOrInvoke(callee, args, name);
3758 callSite.setCallingConv(getRuntimeCC());
3759 return callSite;
3760}
3761
John McCallbd309292010-07-06 01:34:17 +00003762/// Emits a call or invoke instruction to the given function, depending
3763/// on the current state of the EH stack.
3764llvm::CallSite
3765CodeGenFunction::EmitCallOrInvoke(llvm::Value *Callee,
Chris Lattner54b16772011-07-23 17:14:25 +00003766 ArrayRef<llvm::Value *> Args,
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003767 const Twine &Name) {
John McCallbd309292010-07-06 01:34:17 +00003768 llvm::BasicBlock *InvokeDest = getInvokeDest();
Reid Klecknerb75a3f02018-02-09 00:16:41 +00003769 SmallVector<llvm::OperandBundleDef, 1> BundleList =
3770 getBundlesForFunclet(Callee);
John McCallbd309292010-07-06 01:34:17 +00003771
Dan Gohman515a60d2012-02-16 00:57:37 +00003772 llvm::Instruction *Inst;
3773 if (!InvokeDest)
David Majnemer3df77bc2016-01-26 23:14:47 +00003774 Inst = Builder.CreateCall(Callee, Args, BundleList, Name);
Dan Gohman515a60d2012-02-16 00:57:37 +00003775 else {
3776 llvm::BasicBlock *ContBB = createBasicBlock("invoke.cont");
David Majnemer3df77bc2016-01-26 23:14:47 +00003777 Inst = Builder.CreateInvoke(Callee, ContBB, InvokeDest, Args, BundleList,
3778 Name);
Dan Gohman515a60d2012-02-16 00:57:37 +00003779 EmitBlock(ContBB);
3780 }
3781
3782 // In ObjC ARC mode with no ObjC ARC exception safety, tell the ARC
3783 // optimizer it can aggressively ignore unwind edges.
David Blaikiebbafb8a2012-03-11 07:00:24 +00003784 if (CGM.getLangOpts().ObjCAutoRefCount)
Dan Gohman515a60d2012-02-16 00:57:37 +00003785 AddObjCARCExceptionMetadata(Inst);
3786
Benjamin Kramerc19cde12015-04-10 14:49:31 +00003787 return llvm::CallSite(Inst);
John McCallbd309292010-07-06 01:34:17 +00003788}
3789
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003790void CodeGenFunction::deferPlaceholderReplacement(llvm::Instruction *Old,
3791 llvm::Value *New) {
3792 DeferredReplacements.push_back(std::make_pair(Old, New));
3793}
Chris Lattnerd59d8672011-07-12 06:29:11 +00003794
Daniel Dunbard931a872009-02-02 22:03:45 +00003795RValue CodeGenFunction::EmitCall(const CGFunctionInfo &CallInfo,
John McCallb92ab1a2016-10-26 23:46:34 +00003796 const CGCallee &Callee,
Anders Carlsson61a401c2009-12-24 19:25:24 +00003797 ReturnValueSlot ReturnValue,
Daniel Dunbarcdbb5e32009-02-20 18:06:48 +00003798 const CallArgList &CallArgs,
Vedant Kumar09b5bfd2017-12-21 00:10:25 +00003799 llvm::Instruction **callOrInvoke,
3800 SourceLocation Loc) {
Mike Stump18bb9282009-05-16 07:57:57 +00003801 // FIXME: We no longer need the types from CallArgs; lift up and simplify.
Daniel Dunbar613855c2008-09-09 23:27:19 +00003802
Peter Collingbourneea211002018-02-05 23:09:13 +00003803 assert(Callee.isOrdinary() || Callee.isVirtual());
John McCallb92ab1a2016-10-26 23:46:34 +00003804
Daniel Dunbar613855c2008-09-09 23:27:19 +00003805 // Handle struct-return functions by passing a pointer to the
3806 // location that we would like to return into.
Daniel Dunbar7633cbf2009-02-02 21:43:58 +00003807 QualType RetTy = CallInfo.getReturnType();
Daniel Dunbarb52d0772009-02-03 05:59:18 +00003808 const ABIArgInfo &RetAI = CallInfo.getReturnInfo();
Mike Stump11289f42009-09-09 15:08:12 +00003809
John McCallb92ab1a2016-10-26 23:46:34 +00003810 llvm::FunctionType *IRFuncTy = Callee.getFunctionType();
3811
3812 // 1. Set up the arguments.
Mike Stump11289f42009-09-09 15:08:12 +00003813
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003814 // If we're using inalloca, insert the allocation after the stack save.
3815 // FIXME: Do this earlier rather than hacking it in here!
John McCall7f416cc2015-09-08 08:05:57 +00003816 Address ArgMemory = Address::invalid();
3817 const llvm::StructLayout *ArgMemoryLayout = nullptr;
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003818 if (llvm::StructType *ArgStruct = CallInfo.getArgStruct()) {
Matt Arsenault502ad602017-04-10 22:28:02 +00003819 const llvm::DataLayout &DL = CGM.getDataLayout();
3820 ArgMemoryLayout = DL.getStructLayout(ArgStruct);
Reid Kleckner9df1d972014-04-10 01:40:15 +00003821 llvm::Instruction *IP = CallArgs.getStackBase();
3822 llvm::AllocaInst *AI;
3823 if (IP) {
3824 IP = IP->getNextNode();
Matt Arsenault502ad602017-04-10 22:28:02 +00003825 AI = new llvm::AllocaInst(ArgStruct, DL.getAllocaAddrSpace(),
3826 "argmem", IP);
Reid Kleckner9df1d972014-04-10 01:40:15 +00003827 } else {
Reid Kleckner966abe72014-05-15 23:01:46 +00003828 AI = CreateTempAlloca(ArgStruct, "argmem");
Reid Kleckner9df1d972014-04-10 01:40:15 +00003829 }
John McCall7f416cc2015-09-08 08:05:57 +00003830 auto Align = CallInfo.getArgStructAlignment();
3831 AI->setAlignment(Align.getQuantity());
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003832 AI->setUsedWithInAlloca(true);
3833 assert(AI->isUsedWithInAlloca() && !AI->isStaticAlloca());
John McCall7f416cc2015-09-08 08:05:57 +00003834 ArgMemory = Address(AI, Align);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003835 }
3836
John McCall7f416cc2015-09-08 08:05:57 +00003837 // Helper function to drill into the inalloca allocation.
3838 auto createInAllocaStructGEP = [&](unsigned FieldIndex) -> Address {
3839 auto FieldOffset =
3840 CharUnits::fromQuantity(ArgMemoryLayout->getElementOffset(FieldIndex));
3841 return Builder.CreateStructGEP(ArgMemory, FieldIndex, FieldOffset);
3842 };
3843
Alexey Samsonov153004f2014-09-29 22:08:00 +00003844 ClangToLLVMArgMapping IRFunctionArgs(CGM.getContext(), CallInfo);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003845 SmallVector<llvm::Value *, 16> IRCallArgs(IRFunctionArgs.totalIRArgs());
3846
Chris Lattner4ca97c32009-06-13 00:26:38 +00003847 // If the call returns a temporary with struct return, create a temporary
Anders Carlsson17490832009-12-24 20:40:36 +00003848 // alloca to hold the result, unless one is given to us.
John McCall7f416cc2015-09-08 08:05:57 +00003849 Address SRetPtr = Address::invalid();
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00003850 Address SRetAlloca = Address::invalid();
George Burgess IV003be7c2018-03-08 05:32:30 +00003851 llvm::Value *UnusedReturnSizePtr = nullptr;
John McCallf26e73d2016-03-11 04:30:43 +00003852 if (RetAI.isIndirect() || RetAI.isInAlloca() || RetAI.isCoerceAndExpand()) {
John McCall7f416cc2015-09-08 08:05:57 +00003853 if (!ReturnValue.isNull()) {
3854 SRetPtr = ReturnValue.getValue();
3855 } else {
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00003856 SRetPtr = CreateMemTemp(RetTy, "tmp", &SRetAlloca);
Leny Kholodov6aab1112015-06-08 10:23:49 +00003857 if (HaveInsertPoint() && ReturnValue.isUnused()) {
3858 uint64_t size =
3859 CGM.getDataLayout().getTypeAllocSize(ConvertTypeForMem(RetTy));
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00003860 UnusedReturnSizePtr = EmitLifetimeStart(size, SRetAlloca.getPointer());
Leny Kholodov6aab1112015-06-08 10:23:49 +00003861 }
3862 }
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003863 if (IRFunctionArgs.hasSRetArg()) {
John McCall7f416cc2015-09-08 08:05:57 +00003864 IRCallArgs[IRFunctionArgs.getSRetArgNo()] = SRetPtr.getPointer();
John McCallf26e73d2016-03-11 04:30:43 +00003865 } else if (RetAI.isInAlloca()) {
John McCall7f416cc2015-09-08 08:05:57 +00003866 Address Addr = createInAllocaStructGEP(RetAI.getInAllocaFieldIndex());
3867 Builder.CreateStore(SRetPtr.getPointer(), Addr);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003868 }
Anders Carlsson17490832009-12-24 20:40:36 +00003869 }
Mike Stump11289f42009-09-09 15:08:12 +00003870
John McCall12f23522016-04-04 18:33:08 +00003871 Address swiftErrorTemp = Address::invalid();
3872 Address swiftErrorArg = Address::invalid();
3873
John McCallb92ab1a2016-10-26 23:46:34 +00003874 // Translate all of the arguments as necessary to match the IR lowering.
Daniel Dunbara45bdbb2009-02-04 21:17:21 +00003875 assert(CallInfo.arg_size() == CallArgs.size() &&
3876 "Mismatch between function signature & arguments.");
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003877 unsigned ArgNo = 0;
Daniel Dunbarb52d0772009-02-03 05:59:18 +00003878 CGFunctionInfo::const_arg_iterator info_it = CallInfo.arg_begin();
Mike Stump11289f42009-09-09 15:08:12 +00003879 for (CallArgList::const_iterator I = CallArgs.begin(), E = CallArgs.end();
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003880 I != E; ++I, ++info_it, ++ArgNo) {
Daniel Dunbarb52d0772009-02-03 05:59:18 +00003881 const ABIArgInfo &ArgInfo = info_it->info;
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00003882
Rafael Espindolafad28de2012-10-24 01:59:00 +00003883 // Insert a padding argument to ensure proper alignment.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003884 if (IRFunctionArgs.hasPaddingArg(ArgNo))
3885 IRCallArgs[IRFunctionArgs.getPaddingArgNo(ArgNo)] =
3886 llvm::UndefValue::get(ArgInfo.getPaddingType());
3887
3888 unsigned FirstIRArg, NumIRArgs;
3889 std::tie(FirstIRArg, NumIRArgs) = IRFunctionArgs.getIRArgs(ArgNo);
Rafael Espindolafad28de2012-10-24 01:59:00 +00003890
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00003891 switch (ArgInfo.getKind()) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003892 case ABIArgInfo::InAlloca: {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003893 assert(NumIRArgs == 0);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003894 assert(getTarget().getTriple().getArch() == llvm::Triple::x86);
Yaxun Liu5b330e82018-03-15 15:25:19 +00003895 if (I->isAggregate()) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003896 // Replace the placeholder with the appropriate argument slot GEP.
Yaxun Liu5b330e82018-03-15 15:25:19 +00003897 Address Addr = I->hasLValue()
3898 ? I->getKnownLValue().getAddress()
3899 : I->getKnownRValue().getAggregateAddress();
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003900 llvm::Instruction *Placeholder =
Yaxun Liu5b330e82018-03-15 15:25:19 +00003901 cast<llvm::Instruction>(Addr.getPointer());
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003902 CGBuilderTy::InsertPoint IP = Builder.saveIP();
3903 Builder.SetInsertPoint(Placeholder);
Yaxun Liu5b330e82018-03-15 15:25:19 +00003904 Addr = createInAllocaStructGEP(ArgInfo.getInAllocaFieldIndex());
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003905 Builder.restoreIP(IP);
John McCall7f416cc2015-09-08 08:05:57 +00003906 deferPlaceholderReplacement(Placeholder, Addr.getPointer());
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003907 } else {
3908 // Store the RValue into the argument struct.
John McCall7f416cc2015-09-08 08:05:57 +00003909 Address Addr = createInAllocaStructGEP(ArgInfo.getInAllocaFieldIndex());
3910 unsigned AS = Addr.getType()->getPointerAddressSpace();
David Majnemer32b57b02014-03-31 16:12:47 +00003911 llvm::Type *MemType = ConvertTypeForMem(I->Ty)->getPointerTo(AS);
3912 // There are some cases where a trivial bitcast is not avoidable. The
3913 // definition of a type later in a translation unit may change it's type
3914 // from {}* to (%struct.foo*)*.
John McCall7f416cc2015-09-08 08:05:57 +00003915 if (Addr.getType() != MemType)
David Majnemer32b57b02014-03-31 16:12:47 +00003916 Addr = Builder.CreateBitCast(Addr, MemType);
Yaxun Liu5b330e82018-03-15 15:25:19 +00003917 I->copyInto(*this, Addr);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003918 }
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003919 break;
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003920 }
3921
Daniel Dunbar03816342010-08-21 02:24:36 +00003922 case ABIArgInfo::Indirect: {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003923 assert(NumIRArgs == 1);
Yaxun Liu5b330e82018-03-15 15:25:19 +00003924 if (!I->isAggregate()) {
Daniel Dunbar747865a2009-02-05 09:16:39 +00003925 // Make a temporary alloca to pass the argument.
Yaxun Liuaefdb8e2018-06-15 15:33:22 +00003926 Address Addr = CreateMemTempWithoutCast(
3927 I->Ty, ArgInfo.getIndirectAlign(), "indirect-arg-temp");
John McCall7f416cc2015-09-08 08:05:57 +00003928 IRCallArgs[FirstIRArg] = Addr.getPointer();
John McCall47fb9502013-03-07 21:37:08 +00003929
Yaxun Liu5b330e82018-03-15 15:25:19 +00003930 I->copyInto(*this, Addr);
Daniel Dunbar747865a2009-02-05 09:16:39 +00003931 } else {
Eli Friedmaneb7fab62011-06-14 01:37:52 +00003932 // We want to avoid creating an unnecessary temporary+copy here;
Guy Benyei3832bfd2013-03-10 12:59:00 +00003933 // however, we need one in three cases:
Eli Friedmaneb7fab62011-06-14 01:37:52 +00003934 // 1. If the argument is not byval, and we are required to copy the
3935 // source. (This case doesn't occur on any common architecture.)
3936 // 2. If the argument is byval, RV is not sufficiently aligned, and
3937 // we cannot force it to be sufficiently aligned.
Yaxun Liu5b330e82018-03-15 15:25:19 +00003938 // 3. If the argument is byval, but RV is not located in default
3939 // or alloca address space.
3940 Address Addr = I->hasLValue()
3941 ? I->getKnownLValue().getAddress()
3942 : I->getKnownRValue().getAggregateAddress();
3943 llvm::Value *V = Addr.getPointer();
John McCall7f416cc2015-09-08 08:05:57 +00003944 CharUnits Align = ArgInfo.getIndirectAlign();
Micah Villmowdd31ca12012-10-08 16:25:52 +00003945 const llvm::DataLayout *TD = &CGM.getDataLayout();
Yaxun Liu5b330e82018-03-15 15:25:19 +00003946
3947 assert((FirstIRArg >= IRFuncTy->getNumParams() ||
3948 IRFuncTy->getParamType(FirstIRArg)->getPointerAddressSpace() ==
3949 TD->getAllocaAddrSpace()) &&
3950 "indirect argument must be in alloca address space");
3951
3952 bool NeedCopy = false;
3953
3954 if (Addr.getAlignment() < Align &&
3955 llvm::getOrEnforceKnownAlignment(V, Align.getQuantity(), *TD) <
3956 Align.getQuantity()) {
3957 NeedCopy = true;
3958 } else if (I->hasLValue()) {
3959 auto LV = I->getKnownLValue();
3960 auto AS = LV.getAddressSpace();
Andrew Savonichev1bf1a152018-12-10 12:03:00 +00003961
Yaxun Liu5b330e82018-03-15 15:25:19 +00003962 if ((!ArgInfo.getIndirectByVal() &&
3963 (LV.getAlignment() >=
Andrew Savonichev1bf1a152018-12-10 12:03:00 +00003964 getContext().getTypeAlignInChars(I->Ty)))) {
3965 NeedCopy = true;
3966 }
3967 if (!getLangOpts().OpenCL) {
3968 if ((ArgInfo.getIndirectByVal() &&
3969 (AS != LangAS::Default &&
3970 AS != CGM.getASTAllocaAddressSpace()))) {
3971 NeedCopy = true;
3972 }
3973 }
3974 // For OpenCL even if RV is located in default or alloca address space
3975 // we don't want to perform address space cast for it.
3976 else if ((ArgInfo.getIndirectByVal() &&
3977 Addr.getType()->getAddressSpace() != IRFuncTy->
3978 getParamType(FirstIRArg)->getPointerAddressSpace())) {
Yaxun Liu5b330e82018-03-15 15:25:19 +00003979 NeedCopy = true;
3980 }
3981 }
Andrew Savonichev1bf1a152018-12-10 12:03:00 +00003982
Yaxun Liu5b330e82018-03-15 15:25:19 +00003983 if (NeedCopy) {
Eli Friedmaneb7fab62011-06-14 01:37:52 +00003984 // Create an aligned temporary, and copy to it.
Yaxun Liuaefdb8e2018-06-15 15:33:22 +00003985 Address AI = CreateMemTempWithoutCast(
3986 I->Ty, ArgInfo.getIndirectAlign(), "byval-temp");
John McCall7f416cc2015-09-08 08:05:57 +00003987 IRCallArgs[FirstIRArg] = AI.getPointer();
Yaxun Liu5b330e82018-03-15 15:25:19 +00003988 I->copyInto(*this, AI);
Eli Friedmaneb7fab62011-06-14 01:37:52 +00003989 } else {
3990 // Skip the extra memcpy call.
Yaxun Liu5b330e82018-03-15 15:25:19 +00003991 auto *T = V->getType()->getPointerElementType()->getPointerTo(
3992 CGM.getDataLayout().getAllocaAddrSpace());
3993 IRCallArgs[FirstIRArg] = getTargetHooks().performAddrSpaceCast(
3994 *this, V, LangAS::Default, CGM.getASTAllocaAddressSpace(), T,
3995 true);
Eli Friedmaneb7fab62011-06-14 01:37:52 +00003996 }
Daniel Dunbar747865a2009-02-05 09:16:39 +00003997 }
3998 break;
Daniel Dunbar03816342010-08-21 02:24:36 +00003999 }
Daniel Dunbar747865a2009-02-05 09:16:39 +00004000
Daniel Dunbar94a6f252009-01-26 21:26:08 +00004001 case ABIArgInfo::Ignore:
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004002 assert(NumIRArgs == 0);
Daniel Dunbar94a6f252009-01-26 21:26:08 +00004003 break;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004004
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00004005 case ABIArgInfo::Extend:
4006 case ABIArgInfo::Direct: {
4007 if (!isa<llvm::StructType>(ArgInfo.getCoerceToType()) &&
Chris Lattner8a2f3c72010-07-30 04:02:24 +00004008 ArgInfo.getCoerceToType() == ConvertType(info_it->type) &&
4009 ArgInfo.getDirectOffset() == 0) {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004010 assert(NumIRArgs == 1);
Chris Lattnerbb1952c2011-07-12 04:46:18 +00004011 llvm::Value *V;
Yaxun Liu5b330e82018-03-15 15:25:19 +00004012 if (!I->isAggregate())
4013 V = I->getKnownRValue().getScalarVal();
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00004014 else
Yaxun Liu5b330e82018-03-15 15:25:19 +00004015 V = Builder.CreateLoad(
4016 I->hasLValue() ? I->getKnownLValue().getAddress()
4017 : I->getKnownRValue().getAggregateAddress());
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004018
John McCall12f23522016-04-04 18:33:08 +00004019 // Implement swifterror by copying into a new swifterror argument.
4020 // We'll write back in the normal path out of the call.
4021 if (CallInfo.getExtParameterInfo(ArgNo).getABI()
4022 == ParameterABI::SwiftErrorResult) {
4023 assert(!swiftErrorTemp.isValid() && "multiple swifterror args");
4024
4025 QualType pointeeTy = I->Ty->getPointeeType();
4026 swiftErrorArg =
4027 Address(V, getContext().getTypeAlignInChars(pointeeTy));
4028
4029 swiftErrorTemp =
4030 CreateMemTemp(pointeeTy, getPointerAlign(), "swifterror.temp");
4031 V = swiftErrorTemp.getPointer();
4032 cast<llvm::AllocaInst>(V)->setSwiftError(true);
4033
4034 llvm::Value *errorValue = Builder.CreateLoad(swiftErrorArg);
4035 Builder.CreateStore(errorValue, swiftErrorTemp);
4036 }
4037
Reid Kleckner79b0fd72014-10-10 00:05:45 +00004038 // We might have to widen integers, but we should never truncate.
4039 if (ArgInfo.getCoerceToType() != V->getType() &&
4040 V->getType()->isIntegerTy())
4041 V = Builder.CreateZExt(V, ArgInfo.getCoerceToType());
4042
Chris Lattner3ce86682011-07-12 04:53:39 +00004043 // If the argument doesn't match, perform a bitcast to coerce it. This
4044 // can happen due to trivial type mismatches.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004045 if (FirstIRArg < IRFuncTy->getNumParams() &&
4046 V->getType() != IRFuncTy->getParamType(FirstIRArg))
4047 V = Builder.CreateBitCast(V, IRFuncTy->getParamType(FirstIRArg));
John McCall12f23522016-04-04 18:33:08 +00004048
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004049 IRCallArgs[FirstIRArg] = V;
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00004050 break;
4051 }
Daniel Dunbar94a6f252009-01-26 21:26:08 +00004052
Daniel Dunbar2f219b02009-02-03 19:12:28 +00004053 // FIXME: Avoid the conversion through memory if possible.
John McCall7f416cc2015-09-08 08:05:57 +00004054 Address Src = Address::invalid();
Yaxun Liu5b330e82018-03-15 15:25:19 +00004055 if (!I->isAggregate()) {
John McCall7f416cc2015-09-08 08:05:57 +00004056 Src = CreateMemTemp(I->Ty, "coerce");
Yaxun Liu5b330e82018-03-15 15:25:19 +00004057 I->copyInto(*this, Src);
Ulrich Weigand6e2cea62015-07-10 11:31:43 +00004058 } else {
Yaxun Liu5b330e82018-03-15 15:25:19 +00004059 Src = I->hasLValue() ? I->getKnownLValue().getAddress()
4060 : I->getKnownRValue().getAggregateAddress();
Ulrich Weigand6e2cea62015-07-10 11:31:43 +00004061 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004062
Chris Lattner8a2f3c72010-07-30 04:02:24 +00004063 // If the value is offset in memory, apply the offset now.
John McCall7f416cc2015-09-08 08:05:57 +00004064 Src = emitAddressAtOffset(*this, Src, ArgInfo);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004065
Oliver Stannard2bfdc5b2014-08-27 10:43:15 +00004066 // Fast-isel and the optimizer generally like scalar values better than
4067 // FCAs, so we flatten them if this is safe to do for this argument.
James Molloy6f244b62014-05-09 16:21:39 +00004068 llvm::StructType *STy =
4069 dyn_cast<llvm::StructType>(ArgInfo.getCoerceToType());
Oliver Stannard2bfdc5b2014-08-27 10:43:15 +00004070 if (STy && ArgInfo.isDirect() && ArgInfo.getCanBeFlattened()) {
John McCall7f416cc2015-09-08 08:05:57 +00004071 llvm::Type *SrcTy = Src.getType()->getElementType();
Chandler Carrutha6399a52012-10-10 11:29:08 +00004072 uint64_t SrcSize = CGM.getDataLayout().getTypeAllocSize(SrcTy);
4073 uint64_t DstSize = CGM.getDataLayout().getTypeAllocSize(STy);
4074
4075 // If the source type is smaller than the destination type of the
4076 // coerce-to logic, copy the source value into a temp alloca the size
4077 // of the destination type to allow loading all of it. The bits past
4078 // the source value are left undef.
4079 if (SrcSize < DstSize) {
John McCall7f416cc2015-09-08 08:05:57 +00004080 Address TempAlloca
4081 = CreateTempAlloca(STy, Src.getAlignment(),
4082 Src.getName() + ".coerce");
4083 Builder.CreateMemCpy(TempAlloca, Src, SrcSize);
4084 Src = TempAlloca;
Chandler Carrutha6399a52012-10-10 11:29:08 +00004085 } else {
Matt Arsenault7a124f32017-08-01 20:36:57 +00004086 Src = Builder.CreateBitCast(Src,
4087 STy->getPointerTo(Src.getAddressSpace()));
Chandler Carrutha6399a52012-10-10 11:29:08 +00004088 }
4089
John McCall7f416cc2015-09-08 08:05:57 +00004090 auto SrcLayout = CGM.getDataLayout().getStructLayout(STy);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004091 assert(NumIRArgs == STy->getNumElements());
Chris Lattnerceddafb2010-07-05 20:41:41 +00004092 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
John McCall7f416cc2015-09-08 08:05:57 +00004093 auto Offset = CharUnits::fromQuantity(SrcLayout->getElementOffset(i));
4094 Address EltPtr = Builder.CreateStructGEP(Src, i, Offset);
4095 llvm::Value *LI = Builder.CreateLoad(EltPtr);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004096 IRCallArgs[FirstIRArg + i] = LI;
Chris Lattner15ec3612010-06-29 00:06:42 +00004097 }
Chris Lattner3dd716c2010-06-28 23:44:11 +00004098 } else {
Chris Lattner15ec3612010-06-29 00:06:42 +00004099 // In the simple case, just pass the coerced loaded value.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004100 assert(NumIRArgs == 1);
4101 IRCallArgs[FirstIRArg] =
John McCall7f416cc2015-09-08 08:05:57 +00004102 CreateCoercedLoad(Src, ArgInfo.getCoerceToType(), *this);
Chris Lattner3dd716c2010-06-28 23:44:11 +00004103 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004104
Daniel Dunbar2f219b02009-02-03 19:12:28 +00004105 break;
4106 }
4107
John McCallf26e73d2016-03-11 04:30:43 +00004108 case ABIArgInfo::CoerceAndExpand: {
John McCallf26e73d2016-03-11 04:30:43 +00004109 auto coercionType = ArgInfo.getCoerceAndExpandType();
4110 auto layout = CGM.getDataLayout().getStructLayout(coercionType);
4111
John McCall12f23522016-04-04 18:33:08 +00004112 llvm::Value *tempSize = nullptr;
4113 Address addr = Address::invalid();
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00004114 Address AllocaAddr = Address::invalid();
Yaxun Liu5b330e82018-03-15 15:25:19 +00004115 if (I->isAggregate()) {
4116 addr = I->hasLValue() ? I->getKnownLValue().getAddress()
4117 : I->getKnownRValue().getAggregateAddress();
4118
John McCall12f23522016-04-04 18:33:08 +00004119 } else {
Yaxun Liu5b330e82018-03-15 15:25:19 +00004120 RValue RV = I->getKnownRValue();
John McCall12f23522016-04-04 18:33:08 +00004121 assert(RV.isScalar()); // complex should always just be direct
4122
4123 llvm::Type *scalarType = RV.getScalarVal()->getType();
4124 auto scalarSize = CGM.getDataLayout().getTypeAllocSize(scalarType);
4125 auto scalarAlign = CGM.getDataLayout().getPrefTypeAlignment(scalarType);
4126
John McCall12f23522016-04-04 18:33:08 +00004127 // Materialize to a temporary.
4128 addr = CreateTempAlloca(RV.getScalarVal()->getType(),
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00004129 CharUnits::fromQuantity(std::max(
4130 layout->getAlignment(), scalarAlign)),
4131 "tmp",
4132 /*ArraySize=*/nullptr, &AllocaAddr);
4133 tempSize = EmitLifetimeStart(scalarSize, AllocaAddr.getPointer());
John McCall12f23522016-04-04 18:33:08 +00004134
4135 Builder.CreateStore(RV.getScalarVal(), addr);
4136 }
4137
John McCallf26e73d2016-03-11 04:30:43 +00004138 addr = Builder.CreateElementBitCast(addr, coercionType);
4139
4140 unsigned IRArgPos = FirstIRArg;
4141 for (unsigned i = 0, e = coercionType->getNumElements(); i != e; ++i) {
4142 llvm::Type *eltType = coercionType->getElementType(i);
4143 if (ABIArgInfo::isPaddingForCoerceAndExpand(eltType)) continue;
4144 Address eltAddr = Builder.CreateStructGEP(addr, i, layout);
4145 llvm::Value *elt = Builder.CreateLoad(eltAddr);
4146 IRCallArgs[IRArgPos++] = elt;
4147 }
4148 assert(IRArgPos == FirstIRArg + NumIRArgs);
4149
John McCall12f23522016-04-04 18:33:08 +00004150 if (tempSize) {
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00004151 EmitLifetimeEnd(tempSize, AllocaAddr.getPointer());
John McCall12f23522016-04-04 18:33:08 +00004152 }
4153
John McCallf26e73d2016-03-11 04:30:43 +00004154 break;
4155 }
4156
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00004157 case ABIArgInfo::Expand:
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004158 unsigned IRArgPos = FirstIRArg;
Yaxun Liu5b330e82018-03-15 15:25:19 +00004159 ExpandTypeToArgs(I->Ty, *I, IRFuncTy, IRCallArgs, IRArgPos);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004160 assert(IRArgPos == FirstIRArg + NumIRArgs);
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00004161 break;
Daniel Dunbar613855c2008-09-09 23:27:19 +00004162 }
4163 }
Mike Stump11289f42009-09-09 15:08:12 +00004164
John McCall9831b842018-02-06 18:52:44 +00004165 const CGCallee &ConcreteCallee = Callee.prepareConcreteCallee(*this);
4166 llvm::Value *CalleePtr = ConcreteCallee.getFunctionPointer();
John McCallb92ab1a2016-10-26 23:46:34 +00004167
4168 // If we're using inalloca, set up that argument.
John McCall7f416cc2015-09-08 08:05:57 +00004169 if (ArgMemory.isValid()) {
4170 llvm::Value *Arg = ArgMemory.getPointer();
Reid Klecknerafba553e2014-07-08 02:24:27 +00004171 if (CallInfo.isVariadic()) {
4172 // When passing non-POD arguments by value to variadic functions, we will
4173 // end up with a variadic prototype and an inalloca call site. In such
4174 // cases, we can't do any parameter mismatch checks. Give up and bitcast
4175 // the callee.
John McCallb92ab1a2016-10-26 23:46:34 +00004176 unsigned CalleeAS = CalleePtr->getType()->getPointerAddressSpace();
4177 auto FnTy = getTypes().GetFunctionType(CallInfo)->getPointerTo(CalleeAS);
4178 CalleePtr = Builder.CreateBitCast(CalleePtr, FnTy);
Reid Klecknerafba553e2014-07-08 02:24:27 +00004179 } else {
4180 llvm::Type *LastParamTy =
4181 IRFuncTy->getParamType(IRFuncTy->getNumParams() - 1);
4182 if (Arg->getType() != LastParamTy) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00004183#ifndef NDEBUG
Reid Klecknerafba553e2014-07-08 02:24:27 +00004184 // Assert that these structs have equivalent element types.
4185 llvm::StructType *FullTy = CallInfo.getArgStruct();
4186 llvm::StructType *DeclaredTy = cast<llvm::StructType>(
4187 cast<llvm::PointerType>(LastParamTy)->getElementType());
4188 assert(DeclaredTy->getNumElements() == FullTy->getNumElements());
4189 for (llvm::StructType::element_iterator DI = DeclaredTy->element_begin(),
4190 DE = DeclaredTy->element_end(),
4191 FI = FullTy->element_begin();
4192 DI != DE; ++DI, ++FI)
4193 assert(*DI == *FI);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00004194#endif
Reid Klecknerafba553e2014-07-08 02:24:27 +00004195 Arg = Builder.CreateBitCast(Arg, LastParamTy);
4196 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00004197 }
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004198 assert(IRFunctionArgs.hasInallocaArg());
4199 IRCallArgs[IRFunctionArgs.getInallocaArgNo()] = Arg;
Reid Kleckner314ef7b2014-02-01 00:04:45 +00004200 }
4201
John McCallb92ab1a2016-10-26 23:46:34 +00004202 // 2. Prepare the function pointer.
4203
4204 // If the callee is a bitcast of a non-variadic function to have a
4205 // variadic function pointer type, check to see if we can remove the
4206 // bitcast. This comes up with unprototyped functions.
4207 //
4208 // This makes the IR nicer, but more importantly it ensures that we
4209 // can inline the function at -O0 if it is marked always_inline.
4210 auto simplifyVariadicCallee = [](llvm::Value *Ptr) -> llvm::Value* {
4211 llvm::FunctionType *CalleeFT =
4212 cast<llvm::FunctionType>(Ptr->getType()->getPointerElementType());
4213 if (!CalleeFT->isVarArg())
4214 return Ptr;
4215
4216 llvm::ConstantExpr *CE = dyn_cast<llvm::ConstantExpr>(Ptr);
4217 if (!CE || CE->getOpcode() != llvm::Instruction::BitCast)
4218 return Ptr;
4219
4220 llvm::Function *OrigFn = dyn_cast<llvm::Function>(CE->getOperand(0));
4221 if (!OrigFn)
4222 return Ptr;
4223
4224 llvm::FunctionType *OrigFT = OrigFn->getFunctionType();
4225
4226 // If the original type is variadic, or if any of the component types
4227 // disagree, we cannot remove the cast.
4228 if (OrigFT->isVarArg() ||
4229 OrigFT->getNumParams() != CalleeFT->getNumParams() ||
4230 OrigFT->getReturnType() != CalleeFT->getReturnType())
4231 return Ptr;
4232
4233 for (unsigned i = 0, e = OrigFT->getNumParams(); i != e; ++i)
4234 if (OrigFT->getParamType(i) != CalleeFT->getParamType(i))
4235 return Ptr;
4236
4237 return OrigFn;
4238 };
4239 CalleePtr = simplifyVariadicCallee(CalleePtr);
4240
4241 // 3. Perform the actual call.
4242
4243 // Deactivate any cleanups that we're supposed to do immediately before
4244 // the call.
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00004245 if (!CallArgs.getCleanupsToDeactivate().empty())
4246 deactivateArgCleanupsBeforeCall(*this, CallArgs);
4247
John McCallb92ab1a2016-10-26 23:46:34 +00004248 // Assert that the arguments we computed match up. The IR verifier
4249 // will catch this, but this is a common enough source of problems
4250 // during IRGen changes that it's way better for debugging to catch
4251 // it ourselves here.
4252#ifndef NDEBUG
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004253 assert(IRCallArgs.size() == IRFuncTy->getNumParams() || IRFuncTy->isVarArg());
4254 for (unsigned i = 0; i < IRCallArgs.size(); ++i) {
4255 // Inalloca argument can have different type.
4256 if (IRFunctionArgs.hasInallocaArg() &&
4257 i == IRFunctionArgs.getInallocaArgNo())
4258 continue;
4259 if (i < IRFuncTy->getNumParams())
4260 assert(IRCallArgs[i]->getType() == IRFuncTy->getParamType(i));
4261 }
John McCallb92ab1a2016-10-26 23:46:34 +00004262#endif
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004263
Craig Topper3113ec32018-10-24 17:42:17 +00004264 // Update the largest vector width if any arguments have vector types.
4265 for (unsigned i = 0; i < IRCallArgs.size(); ++i) {
4266 if (auto *VT = dyn_cast<llvm::VectorType>(IRCallArgs[i]->getType()))
4267 LargestVectorWidth = std::max(LargestVectorWidth,
4268 VT->getPrimitiveSizeInBits());
4269 }
4270
John McCallb92ab1a2016-10-26 23:46:34 +00004271 // Compute the calling convention and attributes.
Daniel Dunbar0ef34792009-09-12 00:59:20 +00004272 unsigned CallingConv;
Reid Klecknercdd26792017-04-18 23:50:03 +00004273 llvm::AttributeList Attrs;
John McCallb92ab1a2016-10-26 23:46:34 +00004274 CGM.ConstructAttributeList(CalleePtr->getName(), CallInfo,
Reid Klecknercdd26792017-04-18 23:50:03 +00004275 Callee.getAbstractInfo(), Attrs, CallingConv,
Chad Rosier7dbc9cf2016-01-06 14:35:46 +00004276 /*AttrOnCallSite=*/true);
Mike Stump11289f42009-09-09 15:08:12 +00004277
John McCallb92ab1a2016-10-26 23:46:34 +00004278 // Apply some call-site-specific attributes.
4279 // TODO: work this into building the attribute set.
4280
4281 // Apply always_inline to all calls within flatten functions.
4282 // FIXME: should this really take priority over __try, below?
4283 if (CurCodeDecl && CurCodeDecl->hasAttr<FlattenAttr>() &&
Erich Keanede6480a32018-11-13 15:48:08 +00004284 !(Callee.getAbstractInfo().getCalleeDecl().getDecl() &&
4285 Callee.getAbstractInfo()
4286 .getCalleeDecl()
4287 .getDecl()
4288 ->hasAttr<NoInlineAttr>())) {
John McCallb92ab1a2016-10-26 23:46:34 +00004289 Attrs =
Reid Klecknerde864822017-03-21 16:57:30 +00004290 Attrs.addAttribute(getLLVMContext(), llvm::AttributeList::FunctionIndex,
John McCallb92ab1a2016-10-26 23:46:34 +00004291 llvm::Attribute::AlwaysInline);
4292 }
4293
4294 // Disable inlining inside SEH __try blocks.
4295 if (isSEHTryScope()) {
4296 Attrs =
Reid Klecknerde864822017-03-21 16:57:30 +00004297 Attrs.addAttribute(getLLVMContext(), llvm::AttributeList::FunctionIndex,
John McCallb92ab1a2016-10-26 23:46:34 +00004298 llvm::Attribute::NoInline);
4299 }
4300
4301 // Decide whether to use a call or an invoke.
David Majnemer4e52d6f2015-12-12 05:39:21 +00004302 bool CannotThrow;
4303 if (currentFunctionUsesSEHTry()) {
John McCallb92ab1a2016-10-26 23:46:34 +00004304 // SEH cares about asynchronous exceptions, so everything can "throw."
David Majnemer4e52d6f2015-12-12 05:39:21 +00004305 CannotThrow = false;
4306 } else if (isCleanupPadScope() &&
4307 EHPersonality::get(*this).isMSVCXXPersonality()) {
4308 // The MSVC++ personality will implicitly terminate the program if an
John McCallb92ab1a2016-10-26 23:46:34 +00004309 // exception is thrown during a cleanup outside of a try/catch.
4310 // We don't need to model anything in IR to get this behavior.
David Majnemer4e52d6f2015-12-12 05:39:21 +00004311 CannotThrow = true;
4312 } else {
John McCallb92ab1a2016-10-26 23:46:34 +00004313 // Otherwise, nounwind call sites will never throw.
Reid Klecknerde864822017-03-21 16:57:30 +00004314 CannotThrow = Attrs.hasAttribute(llvm::AttributeList::FunctionIndex,
David Majnemer4e52d6f2015-12-12 05:39:21 +00004315 llvm::Attribute::NoUnwind);
4316 }
George Burgess IV003be7c2018-03-08 05:32:30 +00004317
4318 // If we made a temporary, be sure to clean up after ourselves. Note that we
4319 // can't depend on being inside of an ExprWithCleanups, so we need to manually
4320 // pop this cleanup later on. Being eager about this is OK, since this
4321 // temporary is 'invisible' outside of the callee.
4322 if (UnusedReturnSizePtr)
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00004323 pushFullExprCleanup<CallLifetimeEnd>(NormalEHLifetimeMarker, SRetAlloca,
George Burgess IV003be7c2018-03-08 05:32:30 +00004324 UnusedReturnSizePtr);
4325
David Majnemer4e52d6f2015-12-12 05:39:21 +00004326 llvm::BasicBlock *InvokeDest = CannotThrow ? nullptr : getInvokeDest();
John McCallbd309292010-07-06 01:34:17 +00004327
Reid Klecknerb75a3f02018-02-09 00:16:41 +00004328 SmallVector<llvm::OperandBundleDef, 1> BundleList =
4329 getBundlesForFunclet(CalleePtr);
David Majnemer0b17d442015-12-15 21:27:59 +00004330
John McCallb92ab1a2016-10-26 23:46:34 +00004331 // Emit the actual call/invoke instruction.
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004332 llvm::CallSite CS;
John McCallbd309292010-07-06 01:34:17 +00004333 if (!InvokeDest) {
John McCallb92ab1a2016-10-26 23:46:34 +00004334 CS = Builder.CreateCall(CalleePtr, IRCallArgs, BundleList);
Daniel Dunbar12347492009-02-23 17:26:39 +00004335 } else {
4336 llvm::BasicBlock *Cont = createBasicBlock("invoke.cont");
John McCallb92ab1a2016-10-26 23:46:34 +00004337 CS = Builder.CreateInvoke(CalleePtr, Cont, InvokeDest, IRCallArgs,
David Majnemer0b17d442015-12-15 21:27:59 +00004338 BundleList);
Daniel Dunbar12347492009-02-23 17:26:39 +00004339 EmitBlock(Cont);
Daniel Dunbar5006f4a2009-02-20 18:54:31 +00004340 }
John McCallb92ab1a2016-10-26 23:46:34 +00004341 llvm::Instruction *CI = CS.getInstruction();
Chris Lattnere70a0072010-06-29 16:40:28 +00004342 if (callOrInvoke)
John McCallb92ab1a2016-10-26 23:46:34 +00004343 *callOrInvoke = CI;
Daniel Dunbar5006f4a2009-02-20 18:54:31 +00004344
John McCallb92ab1a2016-10-26 23:46:34 +00004345 // Apply the attributes and calling convention.
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004346 CS.setAttributes(Attrs);
Daniel Dunbar0ef34792009-09-12 00:59:20 +00004347 CS.setCallingConv(static_cast<llvm::CallingConv::ID>(CallingConv));
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004348
John McCallb92ab1a2016-10-26 23:46:34 +00004349 // Apply various metadata.
4350
4351 if (!CI->getType()->isVoidTy())
4352 CI->setName("call");
4353
Craig Topper3113ec32018-10-24 17:42:17 +00004354 // Update largest vector width from the return type.
4355 if (auto *VT = dyn_cast<llvm::VectorType>(CI->getType()))
4356 LargestVectorWidth = std::max(LargestVectorWidth,
4357 VT->getPrimitiveSizeInBits());
4358
Adam Nemet1e217bc2016-03-28 22:18:53 +00004359 // Insert instrumentation or attach profile metadata at indirect call sites.
4360 // For more details, see the comment before the definition of
4361 // IPVK_IndirectCallTarget in InstrProfData.inc.
Betul Buyukkurt518276a2016-01-23 22:50:44 +00004362 if (!CS.getCalledFunction())
4363 PGO.valueProfile(Builder, llvm::IPVK_IndirectCallTarget,
John McCallb92ab1a2016-10-26 23:46:34 +00004364 CI, CalleePtr);
Betul Buyukkurt518276a2016-01-23 22:50:44 +00004365
Dan Gohman515a60d2012-02-16 00:57:37 +00004366 // In ObjC ARC mode with no ObjC ARC exception safety, tell the ARC
4367 // optimizer it can aggressively ignore unwind edges.
David Blaikiebbafb8a2012-03-11 07:00:24 +00004368 if (CGM.getLangOpts().ObjCAutoRefCount)
John McCallb92ab1a2016-10-26 23:46:34 +00004369 AddObjCARCExceptionMetadata(CI);
4370
4371 // Suppress tail calls if requested.
4372 if (llvm::CallInst *Call = dyn_cast<llvm::CallInst>(CI)) {
Erich Keanede6480a32018-11-13 15:48:08 +00004373 const Decl *TargetDecl = Callee.getAbstractInfo().getCalleeDecl().getDecl();
John McCallb92ab1a2016-10-26 23:46:34 +00004374 if (TargetDecl && TargetDecl->hasAttr<NotTailCalledAttr>())
4375 Call->setTailCallKind(llvm::CallInst::TCK_NoTail);
4376 }
4377
4378 // 4. Finish the call.
Dan Gohman515a60d2012-02-16 00:57:37 +00004379
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004380 // If the call doesn't return, finish the basic block and clear the
John McCallb92ab1a2016-10-26 23:46:34 +00004381 // insertion point; this allows the rest of IRGen to discard
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004382 // unreachable code.
4383 if (CS.doesNotReturn()) {
George Burgess IV003be7c2018-03-08 05:32:30 +00004384 if (UnusedReturnSizePtr)
4385 PopCleanupBlock();
Leny Kholodov6aab1112015-06-08 10:23:49 +00004386
Vedant Kumar09b5bfd2017-12-21 00:10:25 +00004387 // Strip away the noreturn attribute to better diagnose unreachable UB.
4388 if (SanOpts.has(SanitizerKind::Unreachable)) {
4389 if (auto *F = CS.getCalledFunction())
4390 F->removeFnAttr(llvm::Attribute::NoReturn);
4391 CS.removeAttribute(llvm::AttributeList::FunctionIndex,
4392 llvm::Attribute::NoReturn);
4393 }
4394
4395 EmitUnreachable(Loc);
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004396 Builder.ClearInsertionPoint();
Mike Stump11289f42009-09-09 15:08:12 +00004397
Mike Stump18bb9282009-05-16 07:57:57 +00004398 // FIXME: For now, emit a dummy basic block because expr emitters in
4399 // generally are not ready to handle emitting expressions at unreachable
4400 // points.
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004401 EnsureInsertPoint();
Mike Stump11289f42009-09-09 15:08:12 +00004402
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004403 // Return a reasonable RValue.
4404 return GetUndefRValue(RetTy);
Mike Stump11289f42009-09-09 15:08:12 +00004405 }
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004406
John McCall12f23522016-04-04 18:33:08 +00004407 // Perform the swifterror writeback.
4408 if (swiftErrorTemp.isValid()) {
4409 llvm::Value *errorResult = Builder.CreateLoad(swiftErrorTemp);
4410 Builder.CreateStore(errorResult, swiftErrorArg);
4411 }
4412
John McCallb92ab1a2016-10-26 23:46:34 +00004413 // Emit any call-associated writebacks immediately. Arguably this
4414 // should happen after any return-value munging.
John McCall31168b02011-06-15 23:02:42 +00004415 if (CallArgs.hasWritebacks())
4416 emitWritebacks(*this, CallArgs);
4417
Nico Weber8cdb3f92015-08-25 18:43:32 +00004418 // The stack cleanup for inalloca arguments has to run out of the normal
4419 // lexical order, so deactivate it and run it manually here.
4420 CallArgs.freeArgumentMemory(*this);
4421
John McCallb92ab1a2016-10-26 23:46:34 +00004422 // Extract the return value.
Hal Finkelee90a222014-09-26 05:04:30 +00004423 RValue Ret = [&] {
4424 switch (RetAI.getKind()) {
John McCallf26e73d2016-03-11 04:30:43 +00004425 case ABIArgInfo::CoerceAndExpand: {
4426 auto coercionType = RetAI.getCoerceAndExpandType();
4427 auto layout = CGM.getDataLayout().getStructLayout(coercionType);
4428
4429 Address addr = SRetPtr;
4430 addr = Builder.CreateElementBitCast(addr, coercionType);
4431
John McCall12f23522016-04-04 18:33:08 +00004432 assert(CI->getType() == RetAI.getUnpaddedCoerceAndExpandType());
4433 bool requiresExtract = isa<llvm::StructType>(CI->getType());
4434
John McCallf26e73d2016-03-11 04:30:43 +00004435 unsigned unpaddedIndex = 0;
4436 for (unsigned i = 0, e = coercionType->getNumElements(); i != e; ++i) {
4437 llvm::Type *eltType = coercionType->getElementType(i);
4438 if (ABIArgInfo::isPaddingForCoerceAndExpand(eltType)) continue;
4439 Address eltAddr = Builder.CreateStructGEP(addr, i, layout);
John McCall12f23522016-04-04 18:33:08 +00004440 llvm::Value *elt = CI;
4441 if (requiresExtract)
4442 elt = Builder.CreateExtractValue(elt, unpaddedIndex++);
4443 else
4444 assert(unpaddedIndex == 0);
John McCallf26e73d2016-03-11 04:30:43 +00004445 Builder.CreateStore(elt, eltAddr);
4446 }
John McCall12f23522016-04-04 18:33:08 +00004447 // FALLTHROUGH
Galina Kistanova0872d6c2017-06-03 06:30:46 +00004448 LLVM_FALLTHROUGH;
John McCall12f23522016-04-04 18:33:08 +00004449 }
4450
4451 case ABIArgInfo::InAlloca:
4452 case ABIArgInfo::Indirect: {
4453 RValue ret = convertTempToRValue(SRetPtr, RetTy, SourceLocation());
George Burgess IV003be7c2018-03-08 05:32:30 +00004454 if (UnusedReturnSizePtr)
4455 PopCleanupBlock();
John McCall12f23522016-04-04 18:33:08 +00004456 return ret;
John McCallf26e73d2016-03-11 04:30:43 +00004457 }
4458
Hal Finkelee90a222014-09-26 05:04:30 +00004459 case ABIArgInfo::Ignore:
4460 // If we are ignoring an argument that had a result, make sure to
4461 // construct the appropriate return value for our caller.
4462 return GetUndefRValue(RetTy);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004463
Hal Finkelee90a222014-09-26 05:04:30 +00004464 case ABIArgInfo::Extend:
4465 case ABIArgInfo::Direct: {
4466 llvm::Type *RetIRTy = ConvertType(RetTy);
4467 if (RetAI.getCoerceToType() == RetIRTy && RetAI.getDirectOffset() == 0) {
4468 switch (getEvaluationKind(RetTy)) {
4469 case TEK_Complex: {
4470 llvm::Value *Real = Builder.CreateExtractValue(CI, 0);
4471 llvm::Value *Imag = Builder.CreateExtractValue(CI, 1);
4472 return RValue::getComplex(std::make_pair(Real, Imag));
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00004473 }
Hal Finkelee90a222014-09-26 05:04:30 +00004474 case TEK_Aggregate: {
John McCall7f416cc2015-09-08 08:05:57 +00004475 Address DestPtr = ReturnValue.getValue();
Hal Finkelee90a222014-09-26 05:04:30 +00004476 bool DestIsVolatile = ReturnValue.isVolatile();
4477
John McCall7f416cc2015-09-08 08:05:57 +00004478 if (!DestPtr.isValid()) {
Hal Finkelee90a222014-09-26 05:04:30 +00004479 DestPtr = CreateMemTemp(RetTy, "agg.tmp");
4480 DestIsVolatile = false;
4481 }
John McCall7f416cc2015-09-08 08:05:57 +00004482 BuildAggStore(*this, CI, DestPtr, DestIsVolatile);
Hal Finkelee90a222014-09-26 05:04:30 +00004483 return RValue::getAggregate(DestPtr);
4484 }
4485 case TEK_Scalar: {
4486 // If the argument doesn't match, perform a bitcast to coerce it. This
4487 // can happen due to trivial type mismatches.
4488 llvm::Value *V = CI;
4489 if (V->getType() != RetIRTy)
4490 V = Builder.CreateBitCast(V, RetIRTy);
4491 return RValue::get(V);
4492 }
4493 }
4494 llvm_unreachable("bad evaluation kind");
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00004495 }
Hal Finkelee90a222014-09-26 05:04:30 +00004496
John McCall7f416cc2015-09-08 08:05:57 +00004497 Address DestPtr = ReturnValue.getValue();
Hal Finkelee90a222014-09-26 05:04:30 +00004498 bool DestIsVolatile = ReturnValue.isVolatile();
4499
John McCall7f416cc2015-09-08 08:05:57 +00004500 if (!DestPtr.isValid()) {
Hal Finkelee90a222014-09-26 05:04:30 +00004501 DestPtr = CreateMemTemp(RetTy, "coerce");
4502 DestIsVolatile = false;
John McCall47fb9502013-03-07 21:37:08 +00004503 }
Hal Finkelee90a222014-09-26 05:04:30 +00004504
4505 // If the value is offset in memory, apply the offset now.
John McCall7f416cc2015-09-08 08:05:57 +00004506 Address StorePtr = emitAddressAtOffset(*this, DestPtr, RetAI);
4507 CreateCoercedStore(CI, StorePtr, DestIsVolatile, *this);
Hal Finkelee90a222014-09-26 05:04:30 +00004508
4509 return convertTempToRValue(DestPtr, RetTy, SourceLocation());
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00004510 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004511
Hal Finkelee90a222014-09-26 05:04:30 +00004512 case ABIArgInfo::Expand:
4513 llvm_unreachable("Invalid ABI kind for return argument");
Anders Carlsson17490832009-12-24 20:40:36 +00004514 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004515
Hal Finkelee90a222014-09-26 05:04:30 +00004516 llvm_unreachable("Unhandled ABIArgInfo::Kind");
4517 } ();
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004518
John McCallb92ab1a2016-10-26 23:46:34 +00004519 // Emit the assume_aligned check on the return value.
Erich Keanede6480a32018-11-13 15:48:08 +00004520 const Decl *TargetDecl = Callee.getAbstractInfo().getCalleeDecl().getDecl();
Hal Finkelee90a222014-09-26 05:04:30 +00004521 if (Ret.isScalar() && TargetDecl) {
4522 if (const auto *AA = TargetDecl->getAttr<AssumeAlignedAttr>()) {
4523 llvm::Value *OffsetValue = nullptr;
4524 if (const auto *Offset = AA->getOffset())
4525 OffsetValue = EmitScalarExpr(Offset);
4526
4527 llvm::Value *Alignment = EmitScalarExpr(AA->getAlignment());
4528 llvm::ConstantInt *AlignmentCI = cast<llvm::ConstantInt>(Alignment);
4529 EmitAlignmentAssumption(Ret.getScalarVal(), AlignmentCI->getZExtValue(),
4530 OffsetValue);
Erich Keane623efd82017-03-30 21:48:55 +00004531 } else if (const auto *AA = TargetDecl->getAttr<AllocAlignAttr>()) {
4532 llvm::Value *ParamVal =
Yaxun Liu5b330e82018-03-15 15:25:19 +00004533 CallArgs[AA->getParamIndex().getLLVMIndex()].getRValue(
4534 *this).getScalarVal();
Erich Keane623efd82017-03-30 21:48:55 +00004535 EmitAlignmentAssumption(Ret.getScalarVal(), ParamVal);
Hal Finkelee90a222014-09-26 05:04:30 +00004536 }
Daniel Dunbar573884e2008-09-10 07:04:09 +00004537 }
Daniel Dunbard3674e62008-09-11 01:48:57 +00004538
Hal Finkelee90a222014-09-26 05:04:30 +00004539 return Ret;
Daniel Dunbar613855c2008-09-09 23:27:19 +00004540}
Daniel Dunbar2d0746f2009-02-10 20:44:09 +00004541
John McCall9831b842018-02-06 18:52:44 +00004542CGCallee CGCallee::prepareConcreteCallee(CodeGenFunction &CGF) const {
4543 if (isVirtual()) {
4544 const CallExpr *CE = getVirtualCallExpr();
4545 return CGF.CGM.getCXXABI().getVirtualFunctionPointer(
Stephen Kellyf2ceec42018-08-09 21:08:08 +00004546 CGF, getVirtualMethodDecl(), getThisAddress(), getFunctionType(),
4547 CE ? CE->getBeginLoc() : SourceLocation());
John McCall9831b842018-02-06 18:52:44 +00004548 }
4549
4550 return *this;
4551}
4552
Daniel Dunbar2d0746f2009-02-10 20:44:09 +00004553/* VarArg handling */
4554
Charles Davisc7d5c942015-09-17 20:55:33 +00004555Address CodeGenFunction::EmitVAArg(VAArgExpr *VE, Address &VAListAddr) {
4556 VAListAddr = VE->isMicrosoftABI()
4557 ? EmitMSVAListRef(VE->getSubExpr())
4558 : EmitVAListRef(VE->getSubExpr());
4559 QualType Ty = VE->getType();
4560 if (VE->isMicrosoftABI())
4561 return CGM.getTypes().getABIInfo().EmitMSVAArg(*this, VAListAddr, Ty);
John McCall7f416cc2015-09-08 08:05:57 +00004562 return CGM.getTypes().getABIInfo().EmitVAArg(*this, VAListAddr, Ty);
Daniel Dunbar2d0746f2009-02-10 20:44:09 +00004563}