blob: 73a87a4933d06978f83c093ce85256d747a9a137 [file] [log] [blame]
Nick Lewycky5fa40c32013-10-01 21:51:38 +00001//===--- CGCall.cpp - Encapsulate calling convention details --------------===//
Daniel Dunbar3d7c90b2008-09-08 21:33:45 +00002//
Chandler Carruth2946cd72019-01-19 08:50:56 +00003// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
Daniel Dunbar3d7c90b2008-09-08 21:33:45 +00006//
7//===----------------------------------------------------------------------===//
8//
9// These classes wrap the information about a call or function
10// definition used to handle ABI compliancy.
11//
12//===----------------------------------------------------------------------===//
13
14#include "CGCall.h"
Chris Lattnere70a0072010-06-29 16:40:28 +000015#include "ABIInfo.h"
Akira Hatanaka9d8ac612016-02-17 21:09:50 +000016#include "CGBlocks.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000017#include "CGCXXABI.h"
David Majnemer4e52d6f2015-12-12 05:39:21 +000018#include "CGCleanup.h"
Daniel Dunbar3d7c90b2008-09-08 21:33:45 +000019#include "CodeGenFunction.h"
Daniel Dunbarc68897d2008-09-10 00:41:16 +000020#include "CodeGenModule.h"
John McCalla729c622012-02-17 03:33:10 +000021#include "TargetInfo.h"
Daniel Dunbar3d7c90b2008-09-08 21:33:45 +000022#include "clang/AST/Decl.h"
Anders Carlssonb15b55c2009-04-03 22:48:58 +000023#include "clang/AST/DeclCXX.h"
Daniel Dunbar3d7c90b2008-09-08 21:33:45 +000024#include "clang/AST/DeclObjC.h"
Richard Trieu63688182018-12-11 03:18:39 +000025#include "clang/Basic/CodeGenOptions.h"
Eric Christopher15709992015-10-15 23:47:11 +000026#include "clang/Basic/TargetBuiltins.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000027#include "clang/Basic/TargetInfo.h"
Mark Laceya8e7df32013-10-30 21:53:58 +000028#include "clang/CodeGen/CGFunctionInfo.h"
John McCall12f23522016-04-04 18:33:08 +000029#include "clang/CodeGen/SwiftCallingConv.h"
Bill Wendling706469b2013-02-28 22:49:57 +000030#include "llvm/ADT/StringExtras.h"
David Blaikie181a6132018-06-04 21:23:29 +000031#include "llvm/Transforms/Utils/Local.h"
Nick Lewyckyd9bce502016-09-20 15:49:58 +000032#include "llvm/Analysis/ValueTracking.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000033#include "llvm/IR/Attributes.h"
David Blaikief47ca252018-03-21 22:34:27 +000034#include "llvm/IR/CallingConv.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000035#include "llvm/IR/DataLayout.h"
36#include "llvm/IR/InlineAsm.h"
Saleem Abdulrasool10a49722016-04-08 16:52:00 +000037#include "llvm/IR/IntrinsicInst.h"
David Blaikief47ca252018-03-21 22:34:27 +000038#include "llvm/IR/Intrinsics.h"
Daniel Dunbar3d7c90b2008-09-08 21:33:45 +000039using namespace clang;
40using namespace CodeGen;
41
42/***/
43
Nikolay Haustov8c6538b2016-06-30 09:06:33 +000044unsigned CodeGenTypes::ClangCallConvToLLVMCallConv(CallingConv CC) {
John McCallab26cfa2010-02-05 21:31:56 +000045 switch (CC) {
46 default: return llvm::CallingConv::C;
47 case CC_X86StdCall: return llvm::CallingConv::X86_StdCall;
48 case CC_X86FastCall: return llvm::CallingConv::X86_FastCall;
Erich Keane757d3172016-11-02 18:29:35 +000049 case CC_X86RegCall: return llvm::CallingConv::X86_RegCall;
Douglas Gregora941dca2010-05-18 16:57:00 +000050 case CC_X86ThisCall: return llvm::CallingConv::X86_ThisCall;
Martin Storsjo022e7822017-07-17 20:49:45 +000051 case CC_Win64: return llvm::CallingConv::Win64;
Charles Davisb5a214e2013-08-30 04:39:01 +000052 case CC_X86_64SysV: return llvm::CallingConv::X86_64_SysV;
Anton Korobeynikov231e8752011-04-14 20:06:49 +000053 case CC_AAPCS: return llvm::CallingConv::ARM_AAPCS;
54 case CC_AAPCS_VFP: return llvm::CallingConv::ARM_AAPCS_VFP;
Guy Benyeif0a014b2012-12-25 08:53:55 +000055 case CC_IntelOclBicc: return llvm::CallingConv::Intel_OCL_BI;
Reid Klecknerd7857f02014-10-24 17:42:17 +000056 // TODO: Add support for __pascal to LLVM.
57 case CC_X86Pascal: return llvm::CallingConv::C;
58 // TODO: Add support for __vectorcall to LLVM.
Reid Kleckner80944df2014-10-31 22:00:51 +000059 case CC_X86VectorCall: return llvm::CallingConv::X86_VectorCall;
Sander de Smalen44a22532018-11-26 16:38:37 +000060 case CC_AArch64VectorCall: return llvm::CallingConv::AArch64_VectorCall;
Alexander Kornienko21de0ae2015-01-20 11:20:41 +000061 case CC_SpirFunction: return llvm::CallingConv::SPIR_FUNC;
Nikolay Haustov8c6538b2016-06-30 09:06:33 +000062 case CC_OpenCLKernel: return CGM.getTargetCodeGenInfo().getOpenCLKernelCallingConv();
Roman Levenstein35aa5ce2016-03-16 18:00:46 +000063 case CC_PreserveMost: return llvm::CallingConv::PreserveMost;
64 case CC_PreserveAll: return llvm::CallingConv::PreserveAll;
John McCall12f23522016-04-04 18:33:08 +000065 case CC_Swift: return llvm::CallingConv::Swift;
John McCallab26cfa2010-02-05 21:31:56 +000066 }
67}
68
Mikael Nilsson9d2872d2018-12-13 10:15:27 +000069/// Derives the 'this' type for codegen purposes, i.e. ignoring method CVR
James Y Knightb92d2902019-02-05 16:05:50 +000070/// qualification. Either or both of RD and MD may be null. A null RD indicates
71/// that there is no meaningful 'this' type, and a null MD can occur when
72/// calling a method pointer.
73CanQualType CodeGenTypes::DeriveThisType(const CXXRecordDecl *RD,
74 const CXXMethodDecl *MD) {
75 QualType RecTy;
76 if (RD)
77 RecTy = Context.getTagDeclType(RD)->getCanonicalTypeInternal();
78 else
79 RecTy = Context.VoidTy;
80
Mikael Nilsson9d2872d2018-12-13 10:15:27 +000081 if (MD)
Anastasia Stulovac61eaa52019-01-28 11:37:49 +000082 RecTy = Context.getAddrSpaceQualType(RecTy, MD->getMethodQualifiers().getAddressSpace());
John McCall2da83a32010-02-26 00:48:12 +000083 return Context.getPointerType(CanQualType::CreateUnsafe(RecTy));
Daniel Dunbar7a95ca32008-09-10 04:01:49 +000084}
85
John McCall8ee376f2010-02-24 07:14:12 +000086/// Returns the canonical formal type of the given C++ method.
John McCall2da83a32010-02-26 00:48:12 +000087static CanQual<FunctionProtoType> GetFormalType(const CXXMethodDecl *MD) {
88 return MD->getType()->getCanonicalTypeUnqualified()
89 .getAs<FunctionProtoType>();
John McCall8ee376f2010-02-24 07:14:12 +000090}
91
92/// Returns the "extra-canonicalized" return type, which discards
93/// qualifiers on the return type. Codegen doesn't care about them,
94/// and it makes ABI code a little easier to be able to assume that
95/// all parameter and return types are top-level unqualified.
John McCall2da83a32010-02-26 00:48:12 +000096static CanQualType GetReturnType(QualType RetTy) {
97 return RetTy->getCanonicalTypeUnqualified().getUnqualifiedType();
John McCall8ee376f2010-02-24 07:14:12 +000098}
99
John McCall8dda7b22012-07-07 06:41:13 +0000100/// Arrange the argument and result information for a value of the given
101/// unprototyped freestanding function type.
John McCall8ee376f2010-02-24 07:14:12 +0000102const CGFunctionInfo &
John McCall8dda7b22012-07-07 06:41:13 +0000103CodeGenTypes::arrangeFreeFunctionType(CanQual<FunctionNoProtoType> FTNP) {
John McCalla729c622012-02-17 03:33:10 +0000104 // When translating an unprototyped function type, always use a
105 // variadic type.
Alp Toker314cc812014-01-25 16:55:45 +0000106 return arrangeLLVMFunctionInfo(FTNP->getReturnType().getUnqualifiedType(),
Peter Collingbournef7706832014-12-12 23:41:25 +0000107 /*instanceMethod=*/false,
108 /*chainCall=*/false, None,
John McCallc56a8b32016-03-11 04:30:31 +0000109 FTNP->getExtInfo(), {}, RequiredArgs(0));
John McCall8ee376f2010-02-24 07:14:12 +0000110}
111
George Burgess IVb7760212017-02-24 02:49:47 +0000112static void addExtParameterInfosForCall(
113 llvm::SmallVectorImpl<FunctionProtoType::ExtParameterInfo> &paramInfos,
114 const FunctionProtoType *proto,
115 unsigned prefixArgs,
116 unsigned totalArgs) {
117 assert(proto->hasExtParameterInfos());
118 assert(paramInfos.size() <= prefixArgs);
119 assert(proto->getNumParams() + prefixArgs <= totalArgs);
120
121 paramInfos.reserve(totalArgs);
122
123 // Add default infos for any prefix args that don't already have infos.
124 paramInfos.resize(prefixArgs);
125
126 // Add infos for the prototype.
127 for (const auto &ParamInfo : proto->getExtParameterInfos()) {
128 paramInfos.push_back(ParamInfo);
129 // pass_object_size params have no parameter info.
130 if (ParamInfo.hasPassObjectSize())
131 paramInfos.emplace_back();
132 }
133
134 assert(paramInfos.size() <= totalArgs &&
135 "Did we forget to insert pass_object_size args?");
136 // Add default infos for the variadic and/or suffix arguments.
137 paramInfos.resize(totalArgs);
138}
139
Hiroshi Inouec5e54dd2017-07-03 08:49:44 +0000140/// Adds the formal parameters in FPT to the given prefix. If any parameter in
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000141/// FPT has pass_object_size attrs, then we'll add parameters for those, too.
142static void appendParameterTypes(const CodeGenTypes &CGT,
143 SmallVectorImpl<CanQualType> &prefix,
John McCallc56a8b32016-03-11 04:30:31 +0000144 SmallVectorImpl<FunctionProtoType::ExtParameterInfo> &paramInfos,
George Burgess IVb7760212017-02-24 02:49:47 +0000145 CanQual<FunctionProtoType> FPT) {
146 // Fast path: don't touch param info if we don't need to.
147 if (!FPT->hasExtParameterInfos()) {
148 assert(paramInfos.empty() &&
149 "We have paramInfos, but the prototype doesn't?");
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000150 prefix.append(FPT->param_type_begin(), FPT->param_type_end());
151 return;
152 }
153
George Burgess IVb7760212017-02-24 02:49:47 +0000154 unsigned PrefixSize = prefix.size();
155 // In the vast majority of cases, we'll have precisely FPT->getNumParams()
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000156 // parameters; the only thing that can change this is the presence of
157 // pass_object_size. So, we preallocate for the common case.
158 prefix.reserve(prefix.size() + FPT->getNumParams());
159
George Burgess IVb7760212017-02-24 02:49:47 +0000160 auto ExtInfos = FPT->getExtParameterInfos();
161 assert(ExtInfos.size() == FPT->getNumParams());
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000162 for (unsigned I = 0, E = FPT->getNumParams(); I != E; ++I) {
163 prefix.push_back(FPT->getParamType(I));
George Burgess IVb7760212017-02-24 02:49:47 +0000164 if (ExtInfos[I].hasPassObjectSize())
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000165 prefix.push_back(CGT.getContext().getSizeType());
166 }
George Burgess IVb7760212017-02-24 02:49:47 +0000167
168 addExtParameterInfosForCall(paramInfos, FPT.getTypePtr(), PrefixSize,
169 prefix.size());
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000170}
171
John McCall8dda7b22012-07-07 06:41:13 +0000172/// Arrange the LLVM function layout for a value of the given function
Alexey Samsonove5ef3ca2014-08-13 23:55:54 +0000173/// type, on top of any implicit parameters already stored.
174static const CGFunctionInfo &
Peter Collingbournef7706832014-12-12 23:41:25 +0000175arrangeLLVMFunctionInfo(CodeGenTypes &CGT, bool instanceMethod,
Alexey Samsonove5ef3ca2014-08-13 23:55:54 +0000176 SmallVectorImpl<CanQualType> &prefix,
James Y Knight916db652019-02-02 01:48:23 +0000177 CanQual<FunctionProtoType> FTP) {
John McCallc56a8b32016-03-11 04:30:31 +0000178 SmallVector<FunctionProtoType::ExtParameterInfo, 16> paramInfos;
James Y Knight916db652019-02-02 01:48:23 +0000179 RequiredArgs Required = RequiredArgs::forPrototypePlus(FTP, prefix.size());
Daniel Dunbarbf8c24a2009-02-02 23:23:47 +0000180 // FIXME: Kill copy.
George Burgess IVb7760212017-02-24 02:49:47 +0000181 appendParameterTypes(CGT, prefix, paramInfos, FTP);
Alp Toker314cc812014-01-25 16:55:45 +0000182 CanQualType resultType = FTP->getReturnType().getUnqualifiedType();
John McCallc56a8b32016-03-11 04:30:31 +0000183
Peter Collingbournef7706832014-12-12 23:41:25 +0000184 return CGT.arrangeLLVMFunctionInfo(resultType, instanceMethod,
185 /*chainCall=*/false, prefix,
John McCallc56a8b32016-03-11 04:30:31 +0000186 FTP->getExtInfo(), paramInfos,
George Burgess IV419996c2016-06-16 23:06:04 +0000187 Required);
John McCall8ee376f2010-02-24 07:14:12 +0000188}
189
John McCalla729c622012-02-17 03:33:10 +0000190/// Arrange the argument and result information for a value of the
John McCall8dda7b22012-07-07 06:41:13 +0000191/// given freestanding function type.
John McCall8ee376f2010-02-24 07:14:12 +0000192const CGFunctionInfo &
James Y Knight916db652019-02-02 01:48:23 +0000193CodeGenTypes::arrangeFreeFunctionType(CanQual<FunctionProtoType> FTP) {
John McCalla729c622012-02-17 03:33:10 +0000194 SmallVector<CanQualType, 16> argTypes;
Peter Collingbournef7706832014-12-12 23:41:25 +0000195 return ::arrangeLLVMFunctionInfo(*this, /*instanceMethod=*/false, argTypes,
James Y Knight916db652019-02-02 01:48:23 +0000196 FTP);
Daniel Dunbar7feafc72009-09-11 22:24:53 +0000197}
198
Aaron Ballman0362a6d2013-12-18 16:23:37 +0000199static CallingConv getCallingConventionForDecl(const Decl *D, bool IsWindows) {
Daniel Dunbar7feafc72009-09-11 22:24:53 +0000200 // Set the appropriate calling convention for the Function.
201 if (D->hasAttr<StdCallAttr>())
John McCallab26cfa2010-02-05 21:31:56 +0000202 return CC_X86StdCall;
Daniel Dunbar7feafc72009-09-11 22:24:53 +0000203
204 if (D->hasAttr<FastCallAttr>())
John McCallab26cfa2010-02-05 21:31:56 +0000205 return CC_X86FastCall;
Daniel Dunbar7feafc72009-09-11 22:24:53 +0000206
Erich Keane757d3172016-11-02 18:29:35 +0000207 if (D->hasAttr<RegCallAttr>())
208 return CC_X86RegCall;
209
Douglas Gregora941dca2010-05-18 16:57:00 +0000210 if (D->hasAttr<ThisCallAttr>())
211 return CC_X86ThisCall;
212
Reid Klecknerd7857f02014-10-24 17:42:17 +0000213 if (D->hasAttr<VectorCallAttr>())
214 return CC_X86VectorCall;
215
Dawn Perchik335e16b2010-09-03 01:29:35 +0000216 if (D->hasAttr<PascalAttr>())
217 return CC_X86Pascal;
218
Anton Korobeynikov231e8752011-04-14 20:06:49 +0000219 if (PcsAttr *PCS = D->getAttr<PcsAttr>())
220 return (PCS->getPCS() == PcsAttr::AAPCS ? CC_AAPCS : CC_AAPCS_VFP);
221
Sander de Smalen44a22532018-11-26 16:38:37 +0000222 if (D->hasAttr<AArch64VectorPcsAttr>())
223 return CC_AArch64VectorCall;
224
Guy Benyeif0a014b2012-12-25 08:53:55 +0000225 if (D->hasAttr<IntelOclBiccAttr>())
226 return CC_IntelOclBicc;
227
Aaron Ballman0362a6d2013-12-18 16:23:37 +0000228 if (D->hasAttr<MSABIAttr>())
Martin Storsjo022e7822017-07-17 20:49:45 +0000229 return IsWindows ? CC_C : CC_Win64;
Aaron Ballman0362a6d2013-12-18 16:23:37 +0000230
231 if (D->hasAttr<SysVABIAttr>())
232 return IsWindows ? CC_X86_64SysV : CC_C;
233
Roman Levenstein35aa5ce2016-03-16 18:00:46 +0000234 if (D->hasAttr<PreserveMostAttr>())
235 return CC_PreserveMost;
236
237 if (D->hasAttr<PreserveAllAttr>())
238 return CC_PreserveAll;
239
John McCallab26cfa2010-02-05 21:31:56 +0000240 return CC_C;
Daniel Dunbar7a95ca32008-09-10 04:01:49 +0000241}
242
John McCalla729c622012-02-17 03:33:10 +0000243/// Arrange the argument and result information for a call to an
244/// unknown C++ non-static member function of the given abstract type.
James Y Knightb92d2902019-02-05 16:05:50 +0000245/// (A null RD means we don't have any meaningful "this" argument type,
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000246/// so fall back to a generic pointer type).
John McCalla729c622012-02-17 03:33:10 +0000247/// The member function must be an ordinary function, i.e. not a
248/// constructor or destructor.
249const CGFunctionInfo &
250CodeGenTypes::arrangeCXXMethodType(const CXXRecordDecl *RD,
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000251 const FunctionProtoType *FTP,
252 const CXXMethodDecl *MD) {
John McCalla729c622012-02-17 03:33:10 +0000253 SmallVector<CanQualType, 16> argTypes;
John McCall8ee376f2010-02-24 07:14:12 +0000254
Anders Carlsson2ee3c012009-10-03 19:43:08 +0000255 // Add the 'this' pointer.
James Y Knightb92d2902019-02-05 16:05:50 +0000256 argTypes.push_back(DeriveThisType(RD, MD));
John McCall8ee376f2010-02-24 07:14:12 +0000257
Alexey Samsonove5ef3ca2014-08-13 23:55:54 +0000258 return ::arrangeLLVMFunctionInfo(
259 *this, true, argTypes,
James Y Knight916db652019-02-02 01:48:23 +0000260 FTP->getCanonicalTypeUnqualified().getAs<FunctionProtoType>());
Anders Carlsson2ee3c012009-10-03 19:43:08 +0000261}
262
Yaxun Liu6c10a662018-06-12 00:16:33 +0000263/// Set calling convention for CUDA/HIP kernel.
264static void setCUDAKernelCallingConvention(CanQualType &FTy, CodeGenModule &CGM,
265 const FunctionDecl *FD) {
266 if (FD->hasAttr<CUDAGlobalAttr>()) {
267 const FunctionType *FT = FTy->getAs<FunctionType>();
268 CGM.getTargetCodeGenInfo().setCUDAKernelCallingConvention(FT);
269 FTy = FT->getCanonicalTypeUnqualified();
270 }
271}
272
John McCalla729c622012-02-17 03:33:10 +0000273/// Arrange the argument and result information for a declaration or
274/// definition of the given C++ non-static member function. The
275/// member function must be an ordinary function, i.e. not a
276/// constructor or destructor.
277const CGFunctionInfo &
278CodeGenTypes::arrangeCXXMethodDeclaration(const CXXMethodDecl *MD) {
Benjamin Kramer60509af2013-09-09 14:48:42 +0000279 assert(!isa<CXXConstructorDecl>(MD) && "wrong method for constructors!");
John McCall0d635f52010-09-03 01:26:39 +0000280 assert(!isa<CXXDestructorDecl>(MD) && "wrong method for destructors!");
281
Yaxun Liu6c10a662018-06-12 00:16:33 +0000282 CanQualType FT = GetFormalType(MD).getAs<Type>();
283 setCUDAKernelCallingConvention(FT, CGM, MD);
284 auto prototype = FT.getAs<FunctionProtoType>();
Mike Stump11289f42009-09-09 15:08:12 +0000285
John McCalla729c622012-02-17 03:33:10 +0000286 if (MD->isInstance()) {
287 // The abstract case is perfectly fine.
Mark Lacey5ea993b2013-10-02 20:35:23 +0000288 const CXXRecordDecl *ThisType = TheCXXABI.getThisArgumentTypeForMethod(MD);
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000289 return arrangeCXXMethodType(ThisType, prototype.getTypePtr(), MD);
John McCalla729c622012-02-17 03:33:10 +0000290 }
291
James Y Knight916db652019-02-02 01:48:23 +0000292 return arrangeFreeFunctionType(prototype);
Anders Carlssonb15b55c2009-04-03 22:48:58 +0000293}
294
Richard Smith5179eb72016-06-28 19:03:57 +0000295bool CodeGenTypes::inheritingCtorHasParams(
296 const InheritedConstructor &Inherited, CXXCtorType Type) {
297 // Parameters are unnecessary if we're constructing a base class subobject
298 // and the inherited constructor lives in a virtual base.
299 return Type == Ctor_Complete ||
300 !Inherited.getShadowDecl()->constructsVirtualBase() ||
301 !Target.getCXXABI().hasConstructorVariants();
302 }
303
John McCalla729c622012-02-17 03:33:10 +0000304const CGFunctionInfo &
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000305CodeGenTypes::arrangeCXXStructorDeclaration(const CXXMethodDecl *MD,
306 StructorType Type) {
307
John McCalla729c622012-02-17 03:33:10 +0000308 SmallVector<CanQualType, 16> argTypes;
John McCallc56a8b32016-03-11 04:30:31 +0000309 SmallVector<FunctionProtoType::ExtParameterInfo, 16> paramInfos;
James Y Knightb92d2902019-02-05 16:05:50 +0000310 argTypes.push_back(DeriveThisType(MD->getParent(), MD));
Stephen Lin9dc6eef2013-06-30 20:40:16 +0000311
Richard Smith5179eb72016-06-28 19:03:57 +0000312 bool PassParams = true;
313
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000314 GlobalDecl GD;
315 if (auto *CD = dyn_cast<CXXConstructorDecl>(MD)) {
316 GD = GlobalDecl(CD, toCXXCtorType(Type));
Richard Smith5179eb72016-06-28 19:03:57 +0000317
318 // A base class inheriting constructor doesn't get forwarded arguments
319 // needed to construct a virtual base (or base class thereof).
320 if (auto Inherited = CD->getInheritedConstructor())
321 PassParams = inheritingCtorHasParams(Inherited, toCXXCtorType(Type));
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000322 } else {
323 auto *DD = dyn_cast<CXXDestructorDecl>(MD);
324 GD = GlobalDecl(DD, toCXXDtorType(Type));
325 }
Anders Carlsson82ba57c2009-11-25 03:15:49 +0000326
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000327 CanQual<FunctionProtoType> FTP = GetFormalType(MD);
John McCall5d865c322010-08-31 07:33:07 +0000328
329 // Add the formal parameters.
Richard Smith5179eb72016-06-28 19:03:57 +0000330 if (PassParams)
George Burgess IVb7760212017-02-24 02:49:47 +0000331 appendParameterTypes(*this, argTypes, paramInfos, FTP);
John McCall5d865c322010-08-31 07:33:07 +0000332
George Burgess IV75b34a92017-02-22 22:38:25 +0000333 CGCXXABI::AddedStructorArgs AddedArgs =
334 TheCXXABI.buildStructorSignature(MD, Type, argTypes);
335 if (!paramInfos.empty()) {
336 // Note: prefix implies after the first param.
337 if (AddedArgs.Prefix)
338 paramInfos.insert(paramInfos.begin() + 1, AddedArgs.Prefix,
339 FunctionProtoType::ExtParameterInfo{});
340 if (AddedArgs.Suffix)
341 paramInfos.append(AddedArgs.Suffix,
342 FunctionProtoType::ExtParameterInfo{});
343 }
Reid Kleckner89077a12013-12-17 19:46:40 +0000344
345 RequiredArgs required =
Richard Smith5179eb72016-06-28 19:03:57 +0000346 (PassParams && MD->isVariadic() ? RequiredArgs(argTypes.size())
347 : RequiredArgs::All);
Reid Kleckner89077a12013-12-17 19:46:40 +0000348
John McCall8dda7b22012-07-07 06:41:13 +0000349 FunctionType::ExtInfo extInfo = FTP->getExtInfo();
David Majnemer0c0b6d92014-10-31 20:09:12 +0000350 CanQualType resultType = TheCXXABI.HasThisReturn(GD)
351 ? argTypes.front()
352 : TheCXXABI.hasMostDerivedReturn(GD)
353 ? CGM.getContext().VoidPtrTy
354 : Context.VoidTy;
Peter Collingbournef7706832014-12-12 23:41:25 +0000355 return arrangeLLVMFunctionInfo(resultType, /*instanceMethod=*/true,
356 /*chainCall=*/false, argTypes, extInfo,
John McCallc56a8b32016-03-11 04:30:31 +0000357 paramInfos, required);
358}
359
360static SmallVector<CanQualType, 16>
361getArgTypesForCall(ASTContext &ctx, const CallArgList &args) {
362 SmallVector<CanQualType, 16> argTypes;
363 for (auto &arg : args)
364 argTypes.push_back(ctx.getCanonicalParamType(arg.Ty));
365 return argTypes;
366}
367
368static SmallVector<CanQualType, 16>
369getArgTypesForDeclaration(ASTContext &ctx, const FunctionArgList &args) {
370 SmallVector<CanQualType, 16> argTypes;
371 for (auto &arg : args)
372 argTypes.push_back(ctx.getCanonicalParamType(arg->getType()));
373 return argTypes;
374}
375
John McCallc56a8b32016-03-11 04:30:31 +0000376static llvm::SmallVector<FunctionProtoType::ExtParameterInfo, 16>
377getExtParameterInfosForCall(const FunctionProtoType *proto,
378 unsigned prefixArgs, unsigned totalArgs) {
379 llvm::SmallVector<FunctionProtoType::ExtParameterInfo, 16> result;
380 if (proto->hasExtParameterInfos()) {
381 addExtParameterInfosForCall(result, proto, prefixArgs, totalArgs);
382 }
383 return result;
Anders Carlsson82ba57c2009-11-25 03:15:49 +0000384}
385
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000386/// Arrange a call to a C++ method, passing the given arguments.
George Burgess IVd0a9e802017-02-23 22:07:35 +0000387///
388/// ExtraPrefixArgs is the number of ABI-specific args passed after the `this`
389/// parameter.
390/// ExtraSuffixArgs is the number of ABI-specific args passed at the end of
391/// args.
392/// PassProtoArgs indicates whether `args` has args for the parameters in the
393/// given CXXConstructorDecl.
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000394const CGFunctionInfo &
395CodeGenTypes::arrangeCXXConstructorCall(const CallArgList &args,
396 const CXXConstructorDecl *D,
397 CXXCtorType CtorKind,
George Burgess IVd0a9e802017-02-23 22:07:35 +0000398 unsigned ExtraPrefixArgs,
399 unsigned ExtraSuffixArgs,
400 bool PassProtoArgs) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000401 // FIXME: Kill copy.
402 SmallVector<CanQualType, 16> ArgTypes;
Alexey Samsonov3551e312014-08-13 20:06:24 +0000403 for (const auto &Arg : args)
404 ArgTypes.push_back(Context.getCanonicalParamType(Arg.Ty));
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000405
George Burgess IVd0a9e802017-02-23 22:07:35 +0000406 // +1 for implicit this, which should always be args[0].
407 unsigned TotalPrefixArgs = 1 + ExtraPrefixArgs;
408
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000409 CanQual<FunctionProtoType> FPT = GetFormalType(D);
James Y Knightb92d2902019-02-05 16:05:50 +0000410 RequiredArgs Required = PassProtoArgs
411 ? RequiredArgs::forPrototypePlus(
412 FPT, TotalPrefixArgs + ExtraSuffixArgs)
413 : RequiredArgs::All;
414
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000415 GlobalDecl GD(D, CtorKind);
David Majnemer0c0b6d92014-10-31 20:09:12 +0000416 CanQualType ResultType = TheCXXABI.HasThisReturn(GD)
417 ? ArgTypes.front()
418 : TheCXXABI.hasMostDerivedReturn(GD)
419 ? CGM.getContext().VoidPtrTy
420 : Context.VoidTy;
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000421
422 FunctionType::ExtInfo Info = FPT->getExtInfo();
George Burgess IVd0a9e802017-02-23 22:07:35 +0000423 llvm::SmallVector<FunctionProtoType::ExtParameterInfo, 16> ParamInfos;
424 // If the prototype args are elided, we should only have ABI-specific args,
425 // which never have param info.
426 if (PassProtoArgs && FPT->hasExtParameterInfos()) {
427 // ABI-specific suffix arguments are treated the same as variadic arguments.
428 addExtParameterInfosForCall(ParamInfos, FPT.getTypePtr(), TotalPrefixArgs,
429 ArgTypes.size());
430 }
Peter Collingbournef7706832014-12-12 23:41:25 +0000431 return arrangeLLVMFunctionInfo(ResultType, /*instanceMethod=*/true,
432 /*chainCall=*/false, ArgTypes, Info,
John McCallc56a8b32016-03-11 04:30:31 +0000433 ParamInfos, Required);
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000434}
435
John McCalla729c622012-02-17 03:33:10 +0000436/// Arrange the argument and result information for the declaration or
437/// definition of the given function.
438const CGFunctionInfo &
439CodeGenTypes::arrangeFunctionDeclaration(const FunctionDecl *FD) {
Chris Lattnerbea5b622009-05-12 20:27:19 +0000440 if (const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(FD))
Anders Carlssonb15b55c2009-04-03 22:48:58 +0000441 if (MD->isInstance())
John McCalla729c622012-02-17 03:33:10 +0000442 return arrangeCXXMethodDeclaration(MD);
Mike Stump11289f42009-09-09 15:08:12 +0000443
John McCall2da83a32010-02-26 00:48:12 +0000444 CanQualType FTy = FD->getType()->getCanonicalTypeUnqualified();
John McCalla729c622012-02-17 03:33:10 +0000445
John McCall2da83a32010-02-26 00:48:12 +0000446 assert(isa<FunctionType>(FTy));
Yaxun Liu6c10a662018-06-12 00:16:33 +0000447 setCUDAKernelCallingConvention(FTy, CGM, FD);
John McCalla729c622012-02-17 03:33:10 +0000448
449 // When declaring a function without a prototype, always use a
450 // non-variadic type.
George Burgess IV35cfca22017-01-06 19:10:48 +0000451 if (CanQual<FunctionNoProtoType> noProto = FTy.getAs<FunctionNoProtoType>()) {
Peter Collingbournef7706832014-12-12 23:41:25 +0000452 return arrangeLLVMFunctionInfo(
453 noProto->getReturnType(), /*instanceMethod=*/false,
John McCallc56a8b32016-03-11 04:30:31 +0000454 /*chainCall=*/false, None, noProto->getExtInfo(), {},RequiredArgs::All);
John McCalla729c622012-02-17 03:33:10 +0000455 }
456
James Y Knight916db652019-02-02 01:48:23 +0000457 return arrangeFreeFunctionType(FTy.castAs<FunctionProtoType>());
Daniel Dunbar3d7c90b2008-09-08 21:33:45 +0000458}
459
John McCalla729c622012-02-17 03:33:10 +0000460/// Arrange the argument and result information for the declaration or
461/// definition of an Objective-C method.
462const CGFunctionInfo &
463CodeGenTypes::arrangeObjCMethodDeclaration(const ObjCMethodDecl *MD) {
464 // It happens that this is the same as a call with no optional
465 // arguments, except also using the formal 'self' type.
466 return arrangeObjCMessageSendSignature(MD, MD->getSelfDecl()->getType());
467}
468
469/// Arrange the argument and result information for the function type
470/// through which to perform a send to the given Objective-C method,
471/// using the given receiver type. The receiver type is not always
472/// the 'self' type of the method or even an Objective-C pointer type.
473/// This is *not* the right method for actually performing such a
474/// message send, due to the possibility of optional arguments.
475const CGFunctionInfo &
476CodeGenTypes::arrangeObjCMessageSendSignature(const ObjCMethodDecl *MD,
477 QualType receiverType) {
478 SmallVector<CanQualType, 16> argTys;
Akira Hatanaka98a49332017-09-22 00:41:05 +0000479 SmallVector<FunctionProtoType::ExtParameterInfo, 4> extParamInfos(2);
John McCalla729c622012-02-17 03:33:10 +0000480 argTys.push_back(Context.getCanonicalParamType(receiverType));
481 argTys.push_back(Context.getCanonicalParamType(Context.getObjCSelType()));
Daniel Dunbarbf8c24a2009-02-02 23:23:47 +0000482 // FIXME: Kill copy?
David Majnemer59f77922016-06-24 04:05:48 +0000483 for (const auto *I : MD->parameters()) {
Aaron Ballman43b68be2014-03-07 17:50:17 +0000484 argTys.push_back(Context.getCanonicalParamType(I->getType()));
Akira Hatanaka98a49332017-09-22 00:41:05 +0000485 auto extParamInfo = FunctionProtoType::ExtParameterInfo().withIsNoEscape(
486 I->hasAttr<NoEscapeAttr>());
487 extParamInfos.push_back(extParamInfo);
John McCall8ee376f2010-02-24 07:14:12 +0000488 }
John McCall31168b02011-06-15 23:02:42 +0000489
490 FunctionType::ExtInfo einfo;
Aaron Ballman0362a6d2013-12-18 16:23:37 +0000491 bool IsWindows = getContext().getTargetInfo().getTriple().isOSWindows();
492 einfo = einfo.withCallingConv(getCallingConventionForDecl(MD, IsWindows));
John McCall31168b02011-06-15 23:02:42 +0000493
David Blaikiebbafb8a2012-03-11 07:00:24 +0000494 if (getContext().getLangOpts().ObjCAutoRefCount &&
John McCall31168b02011-06-15 23:02:42 +0000495 MD->hasAttr<NSReturnsRetainedAttr>())
496 einfo = einfo.withProducesResult(true);
497
John McCalla729c622012-02-17 03:33:10 +0000498 RequiredArgs required =
499 (MD->isVariadic() ? RequiredArgs(argTys.size()) : RequiredArgs::All);
500
Peter Collingbournef7706832014-12-12 23:41:25 +0000501 return arrangeLLVMFunctionInfo(
502 GetReturnType(MD->getReturnType()), /*instanceMethod=*/false,
Akira Hatanaka98a49332017-09-22 00:41:05 +0000503 /*chainCall=*/false, argTys, einfo, extParamInfos, required);
John McCallc56a8b32016-03-11 04:30:31 +0000504}
505
506const CGFunctionInfo &
507CodeGenTypes::arrangeUnprototypedObjCMessageSend(QualType returnType,
508 const CallArgList &args) {
509 auto argTypes = getArgTypesForCall(Context, args);
510 FunctionType::ExtInfo einfo;
511
512 return arrangeLLVMFunctionInfo(
513 GetReturnType(returnType), /*instanceMethod=*/false,
514 /*chainCall=*/false, argTypes, einfo, {}, RequiredArgs::All);
Daniel Dunbar3d7c90b2008-09-08 21:33:45 +0000515}
516
John McCalla729c622012-02-17 03:33:10 +0000517const CGFunctionInfo &
518CodeGenTypes::arrangeGlobalDeclaration(GlobalDecl GD) {
Anders Carlsson6710c532010-02-06 02:44:09 +0000519 // FIXME: Do we need to handle ObjCMethodDecl?
520 const FunctionDecl *FD = cast<FunctionDecl>(GD.getDecl());
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000521
Anders Carlsson6710c532010-02-06 02:44:09 +0000522 if (const CXXConstructorDecl *CD = dyn_cast<CXXConstructorDecl>(FD))
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000523 return arrangeCXXStructorDeclaration(CD, getFromCtorType(GD.getCtorType()));
Anders Carlsson6710c532010-02-06 02:44:09 +0000524
525 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(FD))
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000526 return arrangeCXXStructorDeclaration(DD, getFromDtorType(GD.getDtorType()));
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000527
John McCalla729c622012-02-17 03:33:10 +0000528 return arrangeFunctionDeclaration(FD);
Anders Carlsson6710c532010-02-06 02:44:09 +0000529}
530
Reid Klecknerc3473512014-08-29 21:43:29 +0000531/// Arrange a thunk that takes 'this' as the first parameter followed by
532/// varargs. Return a void pointer, regardless of the actual return type.
533/// The body of the thunk will end in a musttail call to a function of the
534/// correct type, and the caller will bitcast the function to the correct
535/// prototype.
536const CGFunctionInfo &
Reid Kleckner399d96e2018-04-02 20:20:33 +0000537CodeGenTypes::arrangeUnprototypedMustTailThunk(const CXXMethodDecl *MD) {
538 assert(MD->isVirtual() && "only methods have thunks");
Reid Klecknerc3473512014-08-29 21:43:29 +0000539 CanQual<FunctionProtoType> FTP = GetFormalType(MD);
James Y Knightb92d2902019-02-05 16:05:50 +0000540 CanQualType ArgTys[] = {DeriveThisType(MD->getParent(), MD)};
Peter Collingbournef7706832014-12-12 23:41:25 +0000541 return arrangeLLVMFunctionInfo(Context.VoidTy, /*instanceMethod=*/false,
542 /*chainCall=*/false, ArgTys,
John McCallc56a8b32016-03-11 04:30:31 +0000543 FTP->getExtInfo(), {}, RequiredArgs(1));
Reid Klecknerc3473512014-08-29 21:43:29 +0000544}
545
David Majnemerdfa6d202015-03-11 18:36:39 +0000546const CGFunctionInfo &
David Majnemer37fd66e2015-03-13 22:36:55 +0000547CodeGenTypes::arrangeMSCtorClosure(const CXXConstructorDecl *CD,
548 CXXCtorType CT) {
549 assert(CT == Ctor_CopyingClosure || CT == Ctor_DefaultClosure);
550
David Majnemerdfa6d202015-03-11 18:36:39 +0000551 CanQual<FunctionProtoType> FTP = GetFormalType(CD);
552 SmallVector<CanQualType, 2> ArgTys;
553 const CXXRecordDecl *RD = CD->getParent();
James Y Knightb92d2902019-02-05 16:05:50 +0000554 ArgTys.push_back(DeriveThisType(RD, CD));
David Majnemer37fd66e2015-03-13 22:36:55 +0000555 if (CT == Ctor_CopyingClosure)
556 ArgTys.push_back(*FTP->param_type_begin());
David Majnemerdfa6d202015-03-11 18:36:39 +0000557 if (RD->getNumVBases() > 0)
558 ArgTys.push_back(Context.IntTy);
559 CallingConv CC = Context.getDefaultCallingConvention(
560 /*IsVariadic=*/false, /*IsCXXMethod=*/true);
561 return arrangeLLVMFunctionInfo(Context.VoidTy, /*instanceMethod=*/true,
562 /*chainCall=*/false, ArgTys,
John McCallc56a8b32016-03-11 04:30:31 +0000563 FunctionType::ExtInfo(CC), {},
564 RequiredArgs::All);
David Majnemerdfa6d202015-03-11 18:36:39 +0000565}
566
John McCallc818bbb2012-12-07 07:03:17 +0000567/// Arrange a call as unto a free function, except possibly with an
568/// additional number of formal parameters considered required.
569static const CGFunctionInfo &
570arrangeFreeFunctionLikeCall(CodeGenTypes &CGT,
Mark Lacey23455752013-10-10 20:57:00 +0000571 CodeGenModule &CGM,
John McCallc818bbb2012-12-07 07:03:17 +0000572 const CallArgList &args,
573 const FunctionType *fnType,
Peter Collingbournef7706832014-12-12 23:41:25 +0000574 unsigned numExtraRequiredArgs,
575 bool chainCall) {
John McCallc818bbb2012-12-07 07:03:17 +0000576 assert(args.size() >= numExtraRequiredArgs);
577
John McCallc56a8b32016-03-11 04:30:31 +0000578 llvm::SmallVector<FunctionProtoType::ExtParameterInfo, 16> paramInfos;
579
John McCallc818bbb2012-12-07 07:03:17 +0000580 // In most cases, there are no optional arguments.
581 RequiredArgs required = RequiredArgs::All;
582
583 // If we have a variadic prototype, the required arguments are the
584 // extra prefix plus the arguments in the prototype.
585 if (const FunctionProtoType *proto = dyn_cast<FunctionProtoType>(fnType)) {
586 if (proto->isVariadic())
James Y Knightb92d2902019-02-05 16:05:50 +0000587 required = RequiredArgs::forPrototypePlus(proto, numExtraRequiredArgs);
John McCallc818bbb2012-12-07 07:03:17 +0000588
John McCallc56a8b32016-03-11 04:30:31 +0000589 if (proto->hasExtParameterInfos())
590 addExtParameterInfosForCall(paramInfos, proto, numExtraRequiredArgs,
591 args.size());
592
John McCallc818bbb2012-12-07 07:03:17 +0000593 // If we don't have a prototype at all, but we're supposed to
594 // explicitly use the variadic convention for unprototyped calls,
595 // treat all of the arguments as required but preserve the nominal
596 // possibility of variadics.
Mark Lacey23455752013-10-10 20:57:00 +0000597 } else if (CGM.getTargetCodeGenInfo()
598 .isNoProtoCallVariadic(args,
599 cast<FunctionNoProtoType>(fnType))) {
John McCallc818bbb2012-12-07 07:03:17 +0000600 required = RequiredArgs(args.size());
601 }
602
Peter Collingbournef7706832014-12-12 23:41:25 +0000603 // FIXME: Kill copy.
604 SmallVector<CanQualType, 16> argTypes;
605 for (const auto &arg : args)
606 argTypes.push_back(CGT.getContext().getCanonicalParamType(arg.Ty));
607 return CGT.arrangeLLVMFunctionInfo(GetReturnType(fnType->getReturnType()),
608 /*instanceMethod=*/false, chainCall,
John McCallc56a8b32016-03-11 04:30:31 +0000609 argTypes, fnType->getExtInfo(), paramInfos,
610 required);
John McCallc818bbb2012-12-07 07:03:17 +0000611}
612
John McCalla729c622012-02-17 03:33:10 +0000613/// Figure out the rules for calling a function with the given formal
614/// type using the given arguments. The arguments are necessary
615/// because the function might be unprototyped, in which case it's
616/// target-dependent in crazy ways.
617const CGFunctionInfo &
John McCall8dda7b22012-07-07 06:41:13 +0000618CodeGenTypes::arrangeFreeFunctionCall(const CallArgList &args,
Peter Collingbournef7706832014-12-12 23:41:25 +0000619 const FunctionType *fnType,
620 bool chainCall) {
621 return arrangeFreeFunctionLikeCall(*this, CGM, args, fnType,
622 chainCall ? 1 : 0, chainCall);
John McCallc818bbb2012-12-07 07:03:17 +0000623}
John McCalla729c622012-02-17 03:33:10 +0000624
John McCallc56a8b32016-03-11 04:30:31 +0000625/// A block function is essentially a free function with an
John McCallc818bbb2012-12-07 07:03:17 +0000626/// extra implicit argument.
627const CGFunctionInfo &
628CodeGenTypes::arrangeBlockFunctionCall(const CallArgList &args,
629 const FunctionType *fnType) {
Peter Collingbournef7706832014-12-12 23:41:25 +0000630 return arrangeFreeFunctionLikeCall(*this, CGM, args, fnType, 1,
631 /*chainCall=*/false);
John McCalla729c622012-02-17 03:33:10 +0000632}
633
634const CGFunctionInfo &
John McCallc56a8b32016-03-11 04:30:31 +0000635CodeGenTypes::arrangeBlockFunctionDeclaration(const FunctionProtoType *proto,
636 const FunctionArgList &params) {
637 auto paramInfos = getExtParameterInfosForCall(proto, 1, params.size());
638 auto argTypes = getArgTypesForDeclaration(Context, params);
639
James Y Knight916db652019-02-02 01:48:23 +0000640 return arrangeLLVMFunctionInfo(GetReturnType(proto->getReturnType()),
641 /*instanceMethod*/ false, /*chainCall*/ false,
642 argTypes, proto->getExtInfo(), paramInfos,
643 RequiredArgs::forPrototypePlus(proto, 1));
John McCallc56a8b32016-03-11 04:30:31 +0000644}
645
646const CGFunctionInfo &
647CodeGenTypes::arrangeBuiltinFunctionCall(QualType resultType,
648 const CallArgList &args) {
Daniel Dunbarbf8c24a2009-02-02 23:23:47 +0000649 // FIXME: Kill copy.
John McCalla729c622012-02-17 03:33:10 +0000650 SmallVector<CanQualType, 16> argTypes;
Alexey Samsonov3551e312014-08-13 20:06:24 +0000651 for (const auto &Arg : args)
652 argTypes.push_back(Context.getCanonicalParamType(Arg.Ty));
Peter Collingbournef7706832014-12-12 23:41:25 +0000653 return arrangeLLVMFunctionInfo(
654 GetReturnType(resultType), /*instanceMethod=*/false,
John McCallc56a8b32016-03-11 04:30:31 +0000655 /*chainCall=*/false, argTypes, FunctionType::ExtInfo(),
656 /*paramInfos=*/ {}, RequiredArgs::All);
John McCall8dda7b22012-07-07 06:41:13 +0000657}
658
John McCallc56a8b32016-03-11 04:30:31 +0000659const CGFunctionInfo &
660CodeGenTypes::arrangeBuiltinFunctionDeclaration(QualType resultType,
661 const FunctionArgList &args) {
662 auto argTypes = getArgTypesForDeclaration(Context, args);
663
664 return arrangeLLVMFunctionInfo(
665 GetReturnType(resultType), /*instanceMethod=*/false, /*chainCall=*/false,
666 argTypes, FunctionType::ExtInfo(), {}, RequiredArgs::All);
667}
668
669const CGFunctionInfo &
670CodeGenTypes::arrangeBuiltinFunctionDeclaration(CanQualType resultType,
671 ArrayRef<CanQualType> argTypes) {
672 return arrangeLLVMFunctionInfo(
673 resultType, /*instanceMethod=*/false, /*chainCall=*/false,
674 argTypes, FunctionType::ExtInfo(), {}, RequiredArgs::All);
675}
676
John McCall8dda7b22012-07-07 06:41:13 +0000677/// Arrange a call to a C++ method, passing the given arguments.
George Burgess IVd0a9e802017-02-23 22:07:35 +0000678///
679/// numPrefixArgs is the number of ABI-specific prefix arguments we have. It
680/// does not count `this`.
John McCall8dda7b22012-07-07 06:41:13 +0000681const CGFunctionInfo &
682CodeGenTypes::arrangeCXXMethodCall(const CallArgList &args,
John McCallc56a8b32016-03-11 04:30:31 +0000683 const FunctionProtoType *proto,
George Burgess IVd0a9e802017-02-23 22:07:35 +0000684 RequiredArgs required,
685 unsigned numPrefixArgs) {
686 assert(numPrefixArgs + 1 <= args.size() &&
687 "Emitting a call with less args than the required prefix?");
688 // Add one to account for `this`. It's a bit awkward here, but we don't count
689 // `this` in similar places elsewhere.
John McCallc56a8b32016-03-11 04:30:31 +0000690 auto paramInfos =
George Burgess IVd0a9e802017-02-23 22:07:35 +0000691 getExtParameterInfosForCall(proto, numPrefixArgs + 1, args.size());
John McCallc56a8b32016-03-11 04:30:31 +0000692
John McCall8dda7b22012-07-07 06:41:13 +0000693 // FIXME: Kill copy.
John McCallc56a8b32016-03-11 04:30:31 +0000694 auto argTypes = getArgTypesForCall(Context, args);
John McCall8dda7b22012-07-07 06:41:13 +0000695
John McCallc56a8b32016-03-11 04:30:31 +0000696 FunctionType::ExtInfo info = proto->getExtInfo();
Peter Collingbournef7706832014-12-12 23:41:25 +0000697 return arrangeLLVMFunctionInfo(
John McCallc56a8b32016-03-11 04:30:31 +0000698 GetReturnType(proto->getReturnType()), /*instanceMethod=*/true,
699 /*chainCall=*/false, argTypes, info, paramInfos, required);
Daniel Dunbarbf8c24a2009-02-02 23:23:47 +0000700}
701
John McCalla729c622012-02-17 03:33:10 +0000702const CGFunctionInfo &CodeGenTypes::arrangeNullaryFunction() {
Peter Collingbournef7706832014-12-12 23:41:25 +0000703 return arrangeLLVMFunctionInfo(
704 getContext().VoidTy, /*instanceMethod=*/false, /*chainCall=*/false,
John McCallc56a8b32016-03-11 04:30:31 +0000705 None, FunctionType::ExtInfo(), {}, RequiredArgs::All);
706}
707
708const CGFunctionInfo &
709CodeGenTypes::arrangeCall(const CGFunctionInfo &signature,
710 const CallArgList &args) {
711 assert(signature.arg_size() <= args.size());
712 if (signature.arg_size() == args.size())
713 return signature;
714
715 SmallVector<FunctionProtoType::ExtParameterInfo, 16> paramInfos;
716 auto sigParamInfos = signature.getExtParameterInfos();
717 if (!sigParamInfos.empty()) {
718 paramInfos.append(sigParamInfos.begin(), sigParamInfos.end());
719 paramInfos.resize(args.size());
720 }
721
722 auto argTypes = getArgTypesForCall(Context, args);
723
724 assert(signature.getRequiredArgs().allowsOptionalArgs());
725 return arrangeLLVMFunctionInfo(signature.getReturnType(),
726 signature.isInstanceMethod(),
727 signature.isChainCall(),
728 argTypes,
729 signature.getExtInfo(),
730 paramInfos,
731 signature.getRequiredArgs());
John McCalla738c252011-03-09 04:27:21 +0000732}
733
Pekka Jaaskelainenfc2629a2017-06-01 07:18:49 +0000734namespace clang {
735namespace CodeGen {
736void computeSPIRKernelABIInfo(CodeGenModule &CGM, CGFunctionInfo &FI);
737}
738}
739
John McCalla729c622012-02-17 03:33:10 +0000740/// Arrange the argument and result information for an abstract value
741/// of a given function type. This is the method which all of the
742/// above functions ultimately defer to.
743const CGFunctionInfo &
John McCall8dda7b22012-07-07 06:41:13 +0000744CodeGenTypes::arrangeLLVMFunctionInfo(CanQualType resultType,
Peter Collingbournef7706832014-12-12 23:41:25 +0000745 bool instanceMethod,
746 bool chainCall,
John McCall8dda7b22012-07-07 06:41:13 +0000747 ArrayRef<CanQualType> argTypes,
748 FunctionType::ExtInfo info,
John McCallc56a8b32016-03-11 04:30:31 +0000749 ArrayRef<FunctionProtoType::ExtParameterInfo> paramInfos,
John McCall8dda7b22012-07-07 06:41:13 +0000750 RequiredArgs required) {
Fangrui Song3117b172018-10-20 17:53:42 +0000751 assert(llvm::all_of(argTypes,
752 [](CanQualType T) { return T.isCanonicalAsParam(); }));
John McCall2da83a32010-02-26 00:48:12 +0000753
Daniel Dunbare0be8292009-02-03 00:07:12 +0000754 // Lookup or create unique function info.
755 llvm::FoldingSetNodeID ID;
John McCallc56a8b32016-03-11 04:30:31 +0000756 CGFunctionInfo::Profile(ID, instanceMethod, chainCall, info, paramInfos,
757 required, resultType, argTypes);
Daniel Dunbare0be8292009-02-03 00:07:12 +0000758
Craig Topper8a13c412014-05-21 05:09:00 +0000759 void *insertPos = nullptr;
John McCalla729c622012-02-17 03:33:10 +0000760 CGFunctionInfo *FI = FunctionInfos.FindNodeOrInsertPos(ID, insertPos);
Daniel Dunbare0be8292009-02-03 00:07:12 +0000761 if (FI)
762 return *FI;
763
John McCallc56a8b32016-03-11 04:30:31 +0000764 unsigned CC = ClangCallConvToLLVMCallConv(info.getCC());
765
John McCalla729c622012-02-17 03:33:10 +0000766 // Construct the function info. We co-allocate the ArgInfos.
Peter Collingbournef7706832014-12-12 23:41:25 +0000767 FI = CGFunctionInfo::create(CC, instanceMethod, chainCall, info,
John McCallc56a8b32016-03-11 04:30:31 +0000768 paramInfos, resultType, argTypes, required);
John McCalla729c622012-02-17 03:33:10 +0000769 FunctionInfos.InsertNode(FI, insertPos);
Daniel Dunbar313321e2009-02-03 05:31:23 +0000770
David Blaikie82e95a32014-11-19 07:49:47 +0000771 bool inserted = FunctionsBeingProcessed.insert(FI).second;
772 (void)inserted;
John McCalla729c622012-02-17 03:33:10 +0000773 assert(inserted && "Recursively being processed?");
Pekka Jaaskelainenfc2629a2017-06-01 07:18:49 +0000774
Daniel Dunbar313321e2009-02-03 05:31:23 +0000775 // Compute ABI information.
Pekka Jaaskelainenfc2629a2017-06-01 07:18:49 +0000776 if (CC == llvm::CallingConv::SPIR_KERNEL) {
777 // Force target independent argument handling for the host visible
778 // kernel functions.
779 computeSPIRKernelABIInfo(CGM, *FI);
780 } else if (info.getCC() == CC_Swift) {
John McCall12f23522016-04-04 18:33:08 +0000781 swiftcall::computeABIInfo(CGM, *FI);
Pekka Jaaskelainenfc2629a2017-06-01 07:18:49 +0000782 } else {
783 getABIInfo().computeInfo(*FI);
John McCall12f23522016-04-04 18:33:08 +0000784 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000785
Chris Lattnerfe34c1d2010-07-29 06:26:06 +0000786 // Loop over all of the computed argument and return value info. If any of
787 // them are direct or extend without a specified coerce type, specify the
788 // default now.
John McCalla729c622012-02-17 03:33:10 +0000789 ABIArgInfo &retInfo = FI->getReturnInfo();
Craig Topper8a13c412014-05-21 05:09:00 +0000790 if (retInfo.canHaveCoerceToType() && retInfo.getCoerceToType() == nullptr)
John McCalla729c622012-02-17 03:33:10 +0000791 retInfo.setCoerceToType(ConvertType(FI->getReturnType()));
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000792
Aaron Ballmanec47bc22014-03-17 18:10:01 +0000793 for (auto &I : FI->arguments())
Craig Topper8a13c412014-05-21 05:09:00 +0000794 if (I.info.canHaveCoerceToType() && I.info.getCoerceToType() == nullptr)
Aaron Ballmanec47bc22014-03-17 18:10:01 +0000795 I.info.setCoerceToType(ConvertType(I.type));
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000796
John McCalla729c622012-02-17 03:33:10 +0000797 bool erased = FunctionsBeingProcessed.erase(FI); (void)erased;
798 assert(erased && "Not in set?");
Fangrui Song6907ce22018-07-30 19:24:48 +0000799
Daniel Dunbare0be8292009-02-03 00:07:12 +0000800 return *FI;
Daniel Dunbarbf8c24a2009-02-02 23:23:47 +0000801}
802
John McCalla729c622012-02-17 03:33:10 +0000803CGFunctionInfo *CGFunctionInfo::create(unsigned llvmCC,
Peter Collingbournef7706832014-12-12 23:41:25 +0000804 bool instanceMethod,
805 bool chainCall,
John McCalla729c622012-02-17 03:33:10 +0000806 const FunctionType::ExtInfo &info,
John McCallc56a8b32016-03-11 04:30:31 +0000807 ArrayRef<ExtParameterInfo> paramInfos,
John McCalla729c622012-02-17 03:33:10 +0000808 CanQualType resultType,
809 ArrayRef<CanQualType> argTypes,
810 RequiredArgs required) {
John McCallc56a8b32016-03-11 04:30:31 +0000811 assert(paramInfos.empty() || paramInfos.size() == argTypes.size());
James Y Knightb92d2902019-02-05 16:05:50 +0000812 assert(!required.allowsOptionalArgs() ||
813 required.getNumRequiredArgs() <= argTypes.size());
John McCallc56a8b32016-03-11 04:30:31 +0000814
815 void *buffer =
816 operator new(totalSizeToAlloc<ArgInfo, ExtParameterInfo>(
817 argTypes.size() + 1, paramInfos.size()));
818
John McCalla729c622012-02-17 03:33:10 +0000819 CGFunctionInfo *FI = new(buffer) CGFunctionInfo();
820 FI->CallingConvention = llvmCC;
821 FI->EffectiveCallingConvention = llvmCC;
822 FI->ASTCallingConvention = info.getCC();
Peter Collingbournef7706832014-12-12 23:41:25 +0000823 FI->InstanceMethod = instanceMethod;
824 FI->ChainCall = chainCall;
John McCalla729c622012-02-17 03:33:10 +0000825 FI->NoReturn = info.getNoReturn();
826 FI->ReturnsRetained = info.getProducesResult();
Oren Ben Simhon318a6ea2017-04-27 12:01:00 +0000827 FI->NoCallerSavedRegs = info.getNoCallerSavedRegs();
Oren Ben Simhon220671a2018-03-17 13:31:35 +0000828 FI->NoCfCheck = info.getNoCfCheck();
John McCalla729c622012-02-17 03:33:10 +0000829 FI->Required = required;
830 FI->HasRegParm = info.getHasRegParm();
831 FI->RegParm = info.getRegParm();
Craig Topper8a13c412014-05-21 05:09:00 +0000832 FI->ArgStruct = nullptr;
John McCall7f416cc2015-09-08 08:05:57 +0000833 FI->ArgStructAlign = 0;
John McCalla729c622012-02-17 03:33:10 +0000834 FI->NumArgs = argTypes.size();
John McCallc56a8b32016-03-11 04:30:31 +0000835 FI->HasExtParameterInfos = !paramInfos.empty();
John McCalla729c622012-02-17 03:33:10 +0000836 FI->getArgsBuffer()[0].type = resultType;
837 for (unsigned i = 0, e = argTypes.size(); i != e; ++i)
838 FI->getArgsBuffer()[i + 1].type = argTypes[i];
John McCallc56a8b32016-03-11 04:30:31 +0000839 for (unsigned i = 0, e = paramInfos.size(); i != e; ++i)
840 FI->getExtParameterInfosBuffer()[i] = paramInfos[i];
John McCalla729c622012-02-17 03:33:10 +0000841 return FI;
Daniel Dunbar313321e2009-02-03 05:31:23 +0000842}
843
844/***/
845
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000846namespace {
847// ABIArgInfo::Expand implementation.
848
849// Specifies the way QualType passed as ABIArgInfo::Expand is expanded.
850struct TypeExpansion {
851 enum TypeExpansionKind {
852 // Elements of constant arrays are expanded recursively.
853 TEK_ConstantArray,
854 // Record fields are expanded recursively (but if record is a union, only
855 // the field with the largest size is expanded).
856 TEK_Record,
857 // For complex types, real and imaginary parts are expanded recursively.
858 TEK_Complex,
859 // All other types are not expandable.
860 TEK_None
861 };
862
863 const TypeExpansionKind Kind;
864
865 TypeExpansion(TypeExpansionKind K) : Kind(K) {}
Angel Garcia Gomez637d1e62015-10-20 13:23:58 +0000866 virtual ~TypeExpansion() {}
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000867};
868
869struct ConstantArrayExpansion : TypeExpansion {
870 QualType EltTy;
871 uint64_t NumElts;
872
873 ConstantArrayExpansion(QualType EltTy, uint64_t NumElts)
874 : TypeExpansion(TEK_ConstantArray), EltTy(EltTy), NumElts(NumElts) {}
875 static bool classof(const TypeExpansion *TE) {
876 return TE->Kind == TEK_ConstantArray;
877 }
878};
879
880struct RecordExpansion : TypeExpansion {
Reid Klecknere9f6a712014-10-31 17:10:41 +0000881 SmallVector<const CXXBaseSpecifier *, 1> Bases;
882
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000883 SmallVector<const FieldDecl *, 1> Fields;
884
Reid Klecknere9f6a712014-10-31 17:10:41 +0000885 RecordExpansion(SmallVector<const CXXBaseSpecifier *, 1> &&Bases,
886 SmallVector<const FieldDecl *, 1> &&Fields)
Benjamin Kramer0bb97742016-02-13 16:00:13 +0000887 : TypeExpansion(TEK_Record), Bases(std::move(Bases)),
888 Fields(std::move(Fields)) {}
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000889 static bool classof(const TypeExpansion *TE) {
890 return TE->Kind == TEK_Record;
891 }
892};
893
894struct ComplexExpansion : TypeExpansion {
895 QualType EltTy;
896
897 ComplexExpansion(QualType EltTy) : TypeExpansion(TEK_Complex), EltTy(EltTy) {}
898 static bool classof(const TypeExpansion *TE) {
899 return TE->Kind == TEK_Complex;
900 }
901};
902
903struct NoExpansion : TypeExpansion {
904 NoExpansion() : TypeExpansion(TEK_None) {}
905 static bool classof(const TypeExpansion *TE) {
906 return TE->Kind == TEK_None;
907 }
908};
909} // namespace
910
911static std::unique_ptr<TypeExpansion>
912getTypeExpansion(QualType Ty, const ASTContext &Context) {
913 if (const ConstantArrayType *AT = Context.getAsConstantArrayType(Ty)) {
914 return llvm::make_unique<ConstantArrayExpansion>(
915 AT->getElementType(), AT->getSize().getZExtValue());
916 }
917 if (const RecordType *RT = Ty->getAs<RecordType>()) {
Reid Klecknere9f6a712014-10-31 17:10:41 +0000918 SmallVector<const CXXBaseSpecifier *, 1> Bases;
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000919 SmallVector<const FieldDecl *, 1> Fields;
Bob Wilsone826a2a2011-08-03 05:58:22 +0000920 const RecordDecl *RD = RT->getDecl();
921 assert(!RD->hasFlexibleArrayMember() &&
922 "Cannot expand structure with flexible array.");
Anton Korobeynikov4215ca72012-04-13 11:22:00 +0000923 if (RD->isUnion()) {
924 // Unions can be here only in degenerative cases - all the fields are same
925 // after flattening. Thus we have to use the "largest" field.
Craig Topper8a13c412014-05-21 05:09:00 +0000926 const FieldDecl *LargestFD = nullptr;
Anton Korobeynikov4215ca72012-04-13 11:22:00 +0000927 CharUnits UnionSize = CharUnits::Zero();
928
Aaron Ballmane8a8bae2014-03-08 20:12:42 +0000929 for (const auto *FD : RD->fields()) {
Richard Smith866dee42018-04-02 18:29:43 +0000930 if (FD->isZeroLengthBitField(Context))
Reid Kleckner80944df2014-10-31 22:00:51 +0000931 continue;
Anton Korobeynikov4215ca72012-04-13 11:22:00 +0000932 assert(!FD->isBitField() &&
933 "Cannot expand structure with bit-field members.");
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000934 CharUnits FieldSize = Context.getTypeSizeInChars(FD->getType());
Anton Korobeynikov4215ca72012-04-13 11:22:00 +0000935 if (UnionSize < FieldSize) {
936 UnionSize = FieldSize;
937 LargestFD = FD;
938 }
939 }
940 if (LargestFD)
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000941 Fields.push_back(LargestFD);
Anton Korobeynikov4215ca72012-04-13 11:22:00 +0000942 } else {
Reid Klecknere9f6a712014-10-31 17:10:41 +0000943 if (const auto *CXXRD = dyn_cast<CXXRecordDecl>(RD)) {
944 assert(!CXXRD->isDynamicClass() &&
945 "cannot expand vtable pointers in dynamic classes");
946 for (const CXXBaseSpecifier &BS : CXXRD->bases())
947 Bases.push_back(&BS);
948 }
949
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000950 for (const auto *FD : RD->fields()) {
Richard Smith866dee42018-04-02 18:29:43 +0000951 if (FD->isZeroLengthBitField(Context))
Reid Kleckner80944df2014-10-31 22:00:51 +0000952 continue;
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000953 assert(!FD->isBitField() &&
Anton Korobeynikov4215ca72012-04-13 11:22:00 +0000954 "Cannot expand structure with bit-field members.");
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000955 Fields.push_back(FD);
Anton Korobeynikov4215ca72012-04-13 11:22:00 +0000956 }
Bob Wilsone826a2a2011-08-03 05:58:22 +0000957 }
Reid Klecknere9f6a712014-10-31 17:10:41 +0000958 return llvm::make_unique<RecordExpansion>(std::move(Bases),
959 std::move(Fields));
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000960 }
961 if (const ComplexType *CT = Ty->getAs<ComplexType>()) {
962 return llvm::make_unique<ComplexExpansion>(CT->getElementType());
963 }
964 return llvm::make_unique<NoExpansion>();
965}
966
Alexey Samsonov52c0f6a2014-09-29 20:30:22 +0000967static int getExpansionSize(QualType Ty, const ASTContext &Context) {
968 auto Exp = getTypeExpansion(Ty, Context);
969 if (auto CAExp = dyn_cast<ConstantArrayExpansion>(Exp.get())) {
970 return CAExp->NumElts * getExpansionSize(CAExp->EltTy, Context);
971 }
972 if (auto RExp = dyn_cast<RecordExpansion>(Exp.get())) {
973 int Res = 0;
Reid Klecknere9f6a712014-10-31 17:10:41 +0000974 for (auto BS : RExp->Bases)
975 Res += getExpansionSize(BS->getType(), Context);
Alexey Samsonov52c0f6a2014-09-29 20:30:22 +0000976 for (auto FD : RExp->Fields)
977 Res += getExpansionSize(FD->getType(), Context);
978 return Res;
979 }
980 if (isa<ComplexExpansion>(Exp.get()))
981 return 2;
982 assert(isa<NoExpansion>(Exp.get()));
983 return 1;
984}
985
Alexey Samsonov153004f2014-09-29 22:08:00 +0000986void
987CodeGenTypes::getExpandedTypes(QualType Ty,
988 SmallVectorImpl<llvm::Type *>::iterator &TI) {
989 auto Exp = getTypeExpansion(Ty, Context);
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000990 if (auto CAExp = dyn_cast<ConstantArrayExpansion>(Exp.get())) {
991 for (int i = 0, n = CAExp->NumElts; i < n; i++) {
Alexey Samsonov153004f2014-09-29 22:08:00 +0000992 getExpandedTypes(CAExp->EltTy, TI);
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000993 }
994 } else if (auto RExp = dyn_cast<RecordExpansion>(Exp.get())) {
Reid Klecknere9f6a712014-10-31 17:10:41 +0000995 for (auto BS : RExp->Bases)
996 getExpandedTypes(BS->getType(), TI);
997 for (auto FD : RExp->Fields)
Alexey Samsonov153004f2014-09-29 22:08:00 +0000998 getExpandedTypes(FD->getType(), TI);
Alexey Samsonov8a0bad02014-09-29 18:41:28 +0000999 } else if (auto CExp = dyn_cast<ComplexExpansion>(Exp.get())) {
1000 llvm::Type *EltTy = ConvertType(CExp->EltTy);
Alexey Samsonov153004f2014-09-29 22:08:00 +00001001 *TI++ = EltTy;
1002 *TI++ = EltTy;
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001003 } else {
1004 assert(isa<NoExpansion>(Exp.get()));
Alexey Samsonov153004f2014-09-29 22:08:00 +00001005 *TI++ = ConvertType(Ty);
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001006 }
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00001007}
1008
John McCall7f416cc2015-09-08 08:05:57 +00001009static void forConstantArrayExpansion(CodeGenFunction &CGF,
1010 ConstantArrayExpansion *CAE,
1011 Address BaseAddr,
1012 llvm::function_ref<void(Address)> Fn) {
1013 CharUnits EltSize = CGF.getContext().getTypeSizeInChars(CAE->EltTy);
1014 CharUnits EltAlign =
1015 BaseAddr.getAlignment().alignmentOfArrayElement(EltSize);
1016
1017 for (int i = 0, n = CAE->NumElts; i < n; i++) {
1018 llvm::Value *EltAddr =
1019 CGF.Builder.CreateConstGEP2_32(nullptr, BaseAddr.getPointer(), 0, i);
1020 Fn(Address(EltAddr, EltAlign));
1021 }
1022}
1023
Alexey Samsonov91cf4552014-08-22 01:06:06 +00001024void CodeGenFunction::ExpandTypeFromArgs(
John McCall12f23522016-04-04 18:33:08 +00001025 QualType Ty, LValue LV, SmallVectorImpl<llvm::Value *>::iterator &AI) {
Mike Stump11289f42009-09-09 15:08:12 +00001026 assert(LV.isSimple() &&
1027 "Unexpected non-simple lvalue during struct expansion.");
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00001028
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001029 auto Exp = getTypeExpansion(Ty, getContext());
1030 if (auto CAExp = dyn_cast<ConstantArrayExpansion>(Exp.get())) {
John McCall7f416cc2015-09-08 08:05:57 +00001031 forConstantArrayExpansion(*this, CAExp, LV.getAddress(),
1032 [&](Address EltAddr) {
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001033 LValue LV = MakeAddrLValue(EltAddr, CAExp->EltTy);
1034 ExpandTypeFromArgs(CAExp->EltTy, LV, AI);
John McCall7f416cc2015-09-08 08:05:57 +00001035 });
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001036 } else if (auto RExp = dyn_cast<RecordExpansion>(Exp.get())) {
John McCall7f416cc2015-09-08 08:05:57 +00001037 Address This = LV.getAddress();
Reid Klecknere9f6a712014-10-31 17:10:41 +00001038 for (const CXXBaseSpecifier *BS : RExp->Bases) {
1039 // Perform a single step derived-to-base conversion.
John McCall7f416cc2015-09-08 08:05:57 +00001040 Address Base =
Reid Klecknere9f6a712014-10-31 17:10:41 +00001041 GetAddressOfBaseClass(This, Ty->getAsCXXRecordDecl(), &BS, &BS + 1,
1042 /*NullCheckValue=*/false, SourceLocation());
1043 LValue SubLV = MakeAddrLValue(Base, BS->getType());
1044
1045 // Recurse onto bases.
1046 ExpandTypeFromArgs(BS->getType(), SubLV, AI);
1047 }
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001048 for (auto FD : RExp->Fields) {
1049 // FIXME: What are the right qualifiers here?
Reid Kleckner9d031092016-05-02 22:42:34 +00001050 LValue SubLV = EmitLValueForFieldInitialization(LV, FD);
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001051 ExpandTypeFromArgs(FD->getType(), SubLV, AI);
Bob Wilsone826a2a2011-08-03 05:58:22 +00001052 }
John McCall7f416cc2015-09-08 08:05:57 +00001053 } else if (isa<ComplexExpansion>(Exp.get())) {
1054 auto realValue = *AI++;
1055 auto imagValue = *AI++;
1056 EmitStoreOfComplex(ComplexPairTy(realValue, imagValue), LV, /*init*/ true);
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001057 } else {
1058 assert(isa<NoExpansion>(Exp.get()));
1059 EmitStoreThroughLValue(RValue::get(*AI++), LV);
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00001060 }
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001061}
1062
1063void CodeGenFunction::ExpandTypeToArgs(
Yaxun Liu5b330e82018-03-15 15:25:19 +00001064 QualType Ty, CallArg Arg, llvm::FunctionType *IRFuncTy,
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001065 SmallVectorImpl<llvm::Value *> &IRCallArgs, unsigned &IRCallArgPos) {
1066 auto Exp = getTypeExpansion(Ty, getContext());
1067 if (auto CAExp = dyn_cast<ConstantArrayExpansion>(Exp.get())) {
Yaxun Liu5b330e82018-03-15 15:25:19 +00001068 Address Addr = Arg.hasLValue() ? Arg.getKnownLValue().getAddress()
1069 : Arg.getKnownRValue().getAggregateAddress();
1070 forConstantArrayExpansion(
1071 *this, CAExp, Addr, [&](Address EltAddr) {
1072 CallArg EltArg = CallArg(
1073 convertTempToRValue(EltAddr, CAExp->EltTy, SourceLocation()),
1074 CAExp->EltTy);
1075 ExpandTypeToArgs(CAExp->EltTy, EltArg, IRFuncTy, IRCallArgs,
1076 IRCallArgPos);
1077 });
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001078 } else if (auto RExp = dyn_cast<RecordExpansion>(Exp.get())) {
Yaxun Liu5b330e82018-03-15 15:25:19 +00001079 Address This = Arg.hasLValue() ? Arg.getKnownLValue().getAddress()
1080 : Arg.getKnownRValue().getAggregateAddress();
Reid Klecknere9f6a712014-10-31 17:10:41 +00001081 for (const CXXBaseSpecifier *BS : RExp->Bases) {
1082 // Perform a single step derived-to-base conversion.
John McCall7f416cc2015-09-08 08:05:57 +00001083 Address Base =
Reid Klecknere9f6a712014-10-31 17:10:41 +00001084 GetAddressOfBaseClass(This, Ty->getAsCXXRecordDecl(), &BS, &BS + 1,
1085 /*NullCheckValue=*/false, SourceLocation());
Yaxun Liu5b330e82018-03-15 15:25:19 +00001086 CallArg BaseArg = CallArg(RValue::getAggregate(Base), BS->getType());
Reid Klecknere9f6a712014-10-31 17:10:41 +00001087
1088 // Recurse onto bases.
Yaxun Liu5b330e82018-03-15 15:25:19 +00001089 ExpandTypeToArgs(BS->getType(), BaseArg, IRFuncTy, IRCallArgs,
Reid Klecknere9f6a712014-10-31 17:10:41 +00001090 IRCallArgPos);
1091 }
1092
1093 LValue LV = MakeAddrLValue(This, Ty);
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001094 for (auto FD : RExp->Fields) {
Yaxun Liu5b330e82018-03-15 15:25:19 +00001095 CallArg FldArg =
1096 CallArg(EmitRValueForField(LV, FD, SourceLocation()), FD->getType());
1097 ExpandTypeToArgs(FD->getType(), FldArg, IRFuncTy, IRCallArgs,
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001098 IRCallArgPos);
1099 }
1100 } else if (isa<ComplexExpansion>(Exp.get())) {
Yaxun Liu5b330e82018-03-15 15:25:19 +00001101 ComplexPairTy CV = Arg.getKnownRValue().getComplexVal();
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001102 IRCallArgs[IRCallArgPos++] = CV.first;
1103 IRCallArgs[IRCallArgPos++] = CV.second;
1104 } else {
1105 assert(isa<NoExpansion>(Exp.get()));
Yaxun Liu5b330e82018-03-15 15:25:19 +00001106 auto RV = Arg.getKnownRValue();
Alexey Samsonov8a0bad02014-09-29 18:41:28 +00001107 assert(RV.isScalar() &&
1108 "Unexpected non-scalar rvalue during struct expansion.");
1109
1110 // Insert a bitcast as needed.
1111 llvm::Value *V = RV.getScalarVal();
1112 if (IRCallArgPos < IRFuncTy->getNumParams() &&
1113 V->getType() != IRFuncTy->getParamType(IRCallArgPos))
1114 V = Builder.CreateBitCast(V, IRFuncTy->getParamType(IRCallArgPos));
1115
1116 IRCallArgs[IRCallArgPos++] = V;
1117 }
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00001118}
1119
John McCall7f416cc2015-09-08 08:05:57 +00001120/// Create a temporary allocation for the purposes of coercion.
1121static Address CreateTempAllocaForCoercion(CodeGenFunction &CGF, llvm::Type *Ty,
1122 CharUnits MinAlign) {
1123 // Don't use an alignment that's worse than what LLVM would prefer.
1124 auto PrefAlign = CGF.CGM.getDataLayout().getPrefTypeAlignment(Ty);
1125 CharUnits Align = std::max(MinAlign, CharUnits::fromQuantity(PrefAlign));
1126
1127 return CGF.CreateTempAlloca(Ty, Align);
1128}
1129
Chris Lattner895c52b2010-06-27 06:04:18 +00001130/// EnterStructPointerForCoercedAccess - Given a struct pointer that we are
Chris Lattner1cd66982010-06-27 05:56:15 +00001131/// accessing some number of bytes out of it, try to gep into the struct to get
1132/// at its inner goodness. Dive as deep as possible without entering an element
1133/// with an in-memory size smaller than DstSize.
John McCall7f416cc2015-09-08 08:05:57 +00001134static Address
1135EnterStructPointerForCoercedAccess(Address SrcPtr,
Chris Lattner2192fe52011-07-18 04:24:23 +00001136 llvm::StructType *SrcSTy,
Chris Lattner895c52b2010-06-27 06:04:18 +00001137 uint64_t DstSize, CodeGenFunction &CGF) {
Chris Lattner1cd66982010-06-27 05:56:15 +00001138 // We can't dive into a zero-element struct.
1139 if (SrcSTy->getNumElements() == 0) return SrcPtr;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001140
Chris Lattner2192fe52011-07-18 04:24:23 +00001141 llvm::Type *FirstElt = SrcSTy->getElementType(0);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001142
Chris Lattner1cd66982010-06-27 05:56:15 +00001143 // 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 +00001144 // first element is the same size as the whole struct, we can enter it. The
1145 // comparison must be made on the store size and not the alloca size. Using
1146 // the alloca size may overstate the size of the load.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001147 uint64_t FirstEltSize =
James Molloy90d61012014-08-29 10:17:52 +00001148 CGF.CGM.getDataLayout().getTypeStoreSize(FirstElt);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001149 if (FirstEltSize < DstSize &&
James Molloy90d61012014-08-29 10:17:52 +00001150 FirstEltSize < CGF.CGM.getDataLayout().getTypeStoreSize(SrcSTy))
Chris Lattner1cd66982010-06-27 05:56:15 +00001151 return SrcPtr;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001152
Chris Lattner1cd66982010-06-27 05:56:15 +00001153 // GEP into the first element.
James Y Knight751fe282019-02-09 22:22:28 +00001154 SrcPtr = CGF.Builder.CreateStructGEP(SrcPtr, 0, "coerce.dive");
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001155
Chris Lattner1cd66982010-06-27 05:56:15 +00001156 // If the first element is a struct, recurse.
John McCall7f416cc2015-09-08 08:05:57 +00001157 llvm::Type *SrcTy = SrcPtr.getElementType();
Chris Lattner2192fe52011-07-18 04:24:23 +00001158 if (llvm::StructType *SrcSTy = dyn_cast<llvm::StructType>(SrcTy))
Chris Lattner895c52b2010-06-27 06:04:18 +00001159 return EnterStructPointerForCoercedAccess(SrcPtr, SrcSTy, DstSize, CGF);
Chris Lattner1cd66982010-06-27 05:56:15 +00001160
1161 return SrcPtr;
1162}
1163
Chris Lattner055097f2010-06-27 06:26:04 +00001164/// CoerceIntOrPtrToIntOrPtr - Convert a value Val to the specific Ty where both
1165/// are either integers or pointers. This does a truncation of the value if it
1166/// is too large or a zero extension if it is too small.
Jakob Stoklund Olesen36af2522013-06-05 03:00:13 +00001167///
1168/// This behaves as if the value were coerced through memory, so on big-endian
1169/// targets the high bits are preserved in a truncation, while little-endian
1170/// targets preserve the low bits.
Chris Lattner055097f2010-06-27 06:26:04 +00001171static llvm::Value *CoerceIntOrPtrToIntOrPtr(llvm::Value *Val,
Chris Lattner2192fe52011-07-18 04:24:23 +00001172 llvm::Type *Ty,
Chris Lattner055097f2010-06-27 06:26:04 +00001173 CodeGenFunction &CGF) {
1174 if (Val->getType() == Ty)
1175 return Val;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001176
Chris Lattner055097f2010-06-27 06:26:04 +00001177 if (isa<llvm::PointerType>(Val->getType())) {
1178 // If this is Pointer->Pointer avoid conversion to and from int.
1179 if (isa<llvm::PointerType>(Ty))
1180 return CGF.Builder.CreateBitCast(Val, Ty, "coerce.val");
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001181
Chris Lattner055097f2010-06-27 06:26:04 +00001182 // Convert the pointer to an integer so we can play with its width.
Chris Lattner5e016ae2010-06-27 07:15:29 +00001183 Val = CGF.Builder.CreatePtrToInt(Val, CGF.IntPtrTy, "coerce.val.pi");
Chris Lattner055097f2010-06-27 06:26:04 +00001184 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001185
Chris Lattner2192fe52011-07-18 04:24:23 +00001186 llvm::Type *DestIntTy = Ty;
Chris Lattner055097f2010-06-27 06:26:04 +00001187 if (isa<llvm::PointerType>(DestIntTy))
Chris Lattner5e016ae2010-06-27 07:15:29 +00001188 DestIntTy = CGF.IntPtrTy;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001189
Jakob Stoklund Olesen36af2522013-06-05 03:00:13 +00001190 if (Val->getType() != DestIntTy) {
1191 const llvm::DataLayout &DL = CGF.CGM.getDataLayout();
1192 if (DL.isBigEndian()) {
1193 // Preserve the high bits on big-endian targets.
1194 // That is what memory coercion does.
James Molloy491cefb2014-05-07 17:41:15 +00001195 uint64_t SrcSize = DL.getTypeSizeInBits(Val->getType());
1196 uint64_t DstSize = DL.getTypeSizeInBits(DestIntTy);
1197
Jakob Stoklund Olesen36af2522013-06-05 03:00:13 +00001198 if (SrcSize > DstSize) {
1199 Val = CGF.Builder.CreateLShr(Val, SrcSize - DstSize, "coerce.highbits");
1200 Val = CGF.Builder.CreateTrunc(Val, DestIntTy, "coerce.val.ii");
1201 } else {
1202 Val = CGF.Builder.CreateZExt(Val, DestIntTy, "coerce.val.ii");
1203 Val = CGF.Builder.CreateShl(Val, DstSize - SrcSize, "coerce.highbits");
1204 }
1205 } else {
1206 // Little-endian targets preserve the low bits. No shifts required.
1207 Val = CGF.Builder.CreateIntCast(Val, DestIntTy, false, "coerce.val.ii");
1208 }
1209 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001210
Chris Lattner055097f2010-06-27 06:26:04 +00001211 if (isa<llvm::PointerType>(Ty))
1212 Val = CGF.Builder.CreateIntToPtr(Val, Ty, "coerce.val.ip");
1213 return Val;
1214}
1215
Chris Lattner1cd66982010-06-27 05:56:15 +00001216
1217
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001218/// CreateCoercedLoad - Create a load from \arg SrcPtr interpreted as
Ulrich Weigand6e2cea62015-07-10 11:31:43 +00001219/// a pointer to an object of type \arg Ty, known to be aligned to
1220/// \arg SrcAlign bytes.
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001221///
1222/// This safely handles the case when the src type is smaller than the
1223/// destination type; in this situation the values of bits which not
1224/// present in the src are undefined.
John McCall7f416cc2015-09-08 08:05:57 +00001225static llvm::Value *CreateCoercedLoad(Address Src, llvm::Type *Ty,
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001226 CodeGenFunction &CGF) {
John McCall7f416cc2015-09-08 08:05:57 +00001227 llvm::Type *SrcTy = Src.getElementType();
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001228
Chris Lattnerd200eda2010-06-28 22:51:39 +00001229 // If SrcTy and Ty are the same, just do a load.
1230 if (SrcTy == Ty)
John McCall7f416cc2015-09-08 08:05:57 +00001231 return CGF.Builder.CreateLoad(Src);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001232
Micah Villmowdd31ca12012-10-08 16:25:52 +00001233 uint64_t DstSize = CGF.CGM.getDataLayout().getTypeAllocSize(Ty);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001234
Chris Lattner2192fe52011-07-18 04:24:23 +00001235 if (llvm::StructType *SrcSTy = dyn_cast<llvm::StructType>(SrcTy)) {
John McCall7f416cc2015-09-08 08:05:57 +00001236 Src = EnterStructPointerForCoercedAccess(Src, SrcSTy, DstSize, CGF);
1237 SrcTy = Src.getType()->getElementType();
Chris Lattner1cd66982010-06-27 05:56:15 +00001238 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001239
Micah Villmowdd31ca12012-10-08 16:25:52 +00001240 uint64_t SrcSize = CGF.CGM.getDataLayout().getTypeAllocSize(SrcTy);
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001241
Chris Lattner055097f2010-06-27 06:26:04 +00001242 // If the source and destination are integer or pointer types, just do an
1243 // extension or truncation to the desired type.
1244 if ((isa<llvm::IntegerType>(Ty) || isa<llvm::PointerType>(Ty)) &&
1245 (isa<llvm::IntegerType>(SrcTy) || isa<llvm::PointerType>(SrcTy))) {
John McCall7f416cc2015-09-08 08:05:57 +00001246 llvm::Value *Load = CGF.Builder.CreateLoad(Src);
Chris Lattner055097f2010-06-27 06:26:04 +00001247 return CoerceIntOrPtrToIntOrPtr(Load, Ty, CGF);
1248 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001249
Daniel Dunbarb52d0772009-02-03 05:59:18 +00001250 // If load is legal, just bitcast the src pointer.
Daniel Dunbarffdb8432009-05-13 18:54:26 +00001251 if (SrcSize >= DstSize) {
Mike Stump18bb9282009-05-16 07:57:57 +00001252 // Generally SrcSize is never greater than DstSize, since this means we are
1253 // losing bits. However, this can happen in cases where the structure has
1254 // additional padding, for example due to a user specified alignment.
Daniel Dunbarffdb8432009-05-13 18:54:26 +00001255 //
Mike Stump18bb9282009-05-16 07:57:57 +00001256 // FIXME: Assert that we aren't truncating non-padding bits when have access
1257 // to that information.
Matt Arsenault7a124f32017-08-01 20:36:57 +00001258 Src = CGF.Builder.CreateBitCast(Src,
1259 Ty->getPointerTo(Src.getAddressSpace()));
John McCall7f416cc2015-09-08 08:05:57 +00001260 return CGF.Builder.CreateLoad(Src);
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001261 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001262
John McCall7f416cc2015-09-08 08:05:57 +00001263 // Otherwise do coercion through memory. This is stupid, but simple.
1264 Address Tmp = CreateTempAllocaForCoercion(CGF, Ty, Src.getAlignment());
Yaxun Liu4bbdebc2018-11-08 16:55:46 +00001265 Address Casted = CGF.Builder.CreateElementBitCast(Tmp,CGF.Int8Ty);
1266 Address SrcCasted = CGF.Builder.CreateElementBitCast(Src,CGF.Int8Ty);
Manman Ren84b921f2012-11-28 22:08:52 +00001267 CGF.Builder.CreateMemCpy(Casted, SrcCasted,
1268 llvm::ConstantInt::get(CGF.IntPtrTy, SrcSize),
John McCall7f416cc2015-09-08 08:05:57 +00001269 false);
1270 return CGF.Builder.CreateLoad(Tmp);
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001271}
1272
Eli Friedmanaf9b3252011-05-17 21:08:01 +00001273// Function to store a first-class aggregate into memory. We prefer to
1274// store the elements rather than the aggregate to be more friendly to
1275// fast-isel.
1276// FIXME: Do we need to recurse here?
1277static void BuildAggStore(CodeGenFunction &CGF, llvm::Value *Val,
John McCall7f416cc2015-09-08 08:05:57 +00001278 Address Dest, bool DestIsVolatile) {
Eli Friedmanaf9b3252011-05-17 21:08:01 +00001279 // Prefer scalar stores to first-class aggregate stores.
Chris Lattner2192fe52011-07-18 04:24:23 +00001280 if (llvm::StructType *STy =
Eli Friedmanaf9b3252011-05-17 21:08:01 +00001281 dyn_cast<llvm::StructType>(Val->getType())) {
1282 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
James Y Knight751fe282019-02-09 22:22:28 +00001283 Address EltPtr = CGF.Builder.CreateStructGEP(Dest, i);
Eli Friedmanaf9b3252011-05-17 21:08:01 +00001284 llvm::Value *Elt = CGF.Builder.CreateExtractValue(Val, i);
John McCall7f416cc2015-09-08 08:05:57 +00001285 CGF.Builder.CreateStore(Elt, EltPtr, DestIsVolatile);
Eli Friedmanaf9b3252011-05-17 21:08:01 +00001286 }
1287 } else {
John McCall7f416cc2015-09-08 08:05:57 +00001288 CGF.Builder.CreateStore(Val, Dest, DestIsVolatile);
Eli Friedmanaf9b3252011-05-17 21:08:01 +00001289 }
1290}
1291
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001292/// CreateCoercedStore - Create a store to \arg DstPtr from \arg Src,
Ulrich Weigand6e2cea62015-07-10 11:31:43 +00001293/// where the source and destination may have different types. The
1294/// destination is known to be aligned to \arg DstAlign bytes.
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001295///
1296/// This safely handles the case when the src type is larger than the
1297/// destination type; the upper bits of the src will be lost.
1298static void CreateCoercedStore(llvm::Value *Src,
John McCall7f416cc2015-09-08 08:05:57 +00001299 Address Dst,
Anders Carlsson17490832009-12-24 20:40:36 +00001300 bool DstIsVolatile,
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001301 CodeGenFunction &CGF) {
Chris Lattner2192fe52011-07-18 04:24:23 +00001302 llvm::Type *SrcTy = Src->getType();
John McCall7f416cc2015-09-08 08:05:57 +00001303 llvm::Type *DstTy = Dst.getType()->getElementType();
Chris Lattnerd200eda2010-06-28 22:51:39 +00001304 if (SrcTy == DstTy) {
John McCall7f416cc2015-09-08 08:05:57 +00001305 CGF.Builder.CreateStore(Src, Dst, DstIsVolatile);
Chris Lattnerd200eda2010-06-28 22:51:39 +00001306 return;
1307 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001308
Micah Villmowdd31ca12012-10-08 16:25:52 +00001309 uint64_t SrcSize = CGF.CGM.getDataLayout().getTypeAllocSize(SrcTy);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001310
Chris Lattner2192fe52011-07-18 04:24:23 +00001311 if (llvm::StructType *DstSTy = dyn_cast<llvm::StructType>(DstTy)) {
John McCall7f416cc2015-09-08 08:05:57 +00001312 Dst = EnterStructPointerForCoercedAccess(Dst, DstSTy, SrcSize, CGF);
1313 DstTy = Dst.getType()->getElementType();
Chris Lattner895c52b2010-06-27 06:04:18 +00001314 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001315
Chris Lattner055097f2010-06-27 06:26:04 +00001316 // If the source and destination are integer or pointer types, just do an
1317 // extension or truncation to the desired type.
1318 if ((isa<llvm::IntegerType>(SrcTy) || isa<llvm::PointerType>(SrcTy)) &&
1319 (isa<llvm::IntegerType>(DstTy) || isa<llvm::PointerType>(DstTy))) {
1320 Src = CoerceIntOrPtrToIntOrPtr(Src, DstTy, CGF);
John McCall7f416cc2015-09-08 08:05:57 +00001321 CGF.Builder.CreateStore(Src, Dst, DstIsVolatile);
Chris Lattner055097f2010-06-27 06:26:04 +00001322 return;
1323 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001324
Micah Villmowdd31ca12012-10-08 16:25:52 +00001325 uint64_t DstSize = CGF.CGM.getDataLayout().getTypeAllocSize(DstTy);
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001326
Daniel Dunbar313321e2009-02-03 05:31:23 +00001327 // If store is legal, just bitcast the src pointer.
Daniel Dunbar4be99ff2009-06-05 07:58:54 +00001328 if (SrcSize <= DstSize) {
Yaxun Liue9e5c4f2017-06-29 18:47:45 +00001329 Dst = CGF.Builder.CreateElementBitCast(Dst, SrcTy);
John McCall7f416cc2015-09-08 08:05:57 +00001330 BuildAggStore(CGF, Src, Dst, DstIsVolatile);
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001331 } else {
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001332 // Otherwise do coercion through memory. This is stupid, but
1333 // simple.
Daniel Dunbar4be99ff2009-06-05 07:58:54 +00001334
1335 // Generally SrcSize is never greater than DstSize, since this means we are
1336 // losing bits. However, this can happen in cases where the structure has
1337 // additional padding, for example due to a user specified alignment.
1338 //
1339 // FIXME: Assert that we aren't truncating non-padding bits when have access
1340 // to that information.
John McCall7f416cc2015-09-08 08:05:57 +00001341 Address Tmp = CreateTempAllocaForCoercion(CGF, SrcTy, Dst.getAlignment());
1342 CGF.Builder.CreateStore(Src, Tmp);
Yaxun Liu4bbdebc2018-11-08 16:55:46 +00001343 Address Casted = CGF.Builder.CreateElementBitCast(Tmp,CGF.Int8Ty);
1344 Address DstCasted = CGF.Builder.CreateElementBitCast(Dst,CGF.Int8Ty);
Manman Ren84b921f2012-11-28 22:08:52 +00001345 CGF.Builder.CreateMemCpy(DstCasted, Casted,
1346 llvm::ConstantInt::get(CGF.IntPtrTy, DstSize),
John McCall7f416cc2015-09-08 08:05:57 +00001347 false);
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001348 }
1349}
1350
John McCall7f416cc2015-09-08 08:05:57 +00001351static Address emitAddressAtOffset(CodeGenFunction &CGF, Address addr,
Fangrui Song6907ce22018-07-30 19:24:48 +00001352 const ABIArgInfo &info) {
John McCall7f416cc2015-09-08 08:05:57 +00001353 if (unsigned offset = info.getDirectOffset()) {
1354 addr = CGF.Builder.CreateElementBitCast(addr, CGF.Int8Ty);
1355 addr = CGF.Builder.CreateConstInBoundsByteGEP(addr,
1356 CharUnits::fromQuantity(offset));
1357 addr = CGF.Builder.CreateElementBitCast(addr, info.getCoerceToType());
1358 }
1359 return addr;
1360}
1361
Alexey Samsonov153004f2014-09-29 22:08:00 +00001362namespace {
1363
1364/// Encapsulates information about the way function arguments from
1365/// CGFunctionInfo should be passed to actual LLVM IR function.
1366class ClangToLLVMArgMapping {
1367 static const unsigned InvalidIndex = ~0U;
1368 unsigned InallocaArgNo;
1369 unsigned SRetArgNo;
1370 unsigned TotalIRArgs;
1371
1372 /// Arguments of LLVM IR function corresponding to single Clang argument.
1373 struct IRArgs {
1374 unsigned PaddingArgIndex;
1375 // Argument is expanded to IR arguments at positions
1376 // [FirstArgIndex, FirstArgIndex + NumberOfArgs).
1377 unsigned FirstArgIndex;
1378 unsigned NumberOfArgs;
1379
1380 IRArgs()
1381 : PaddingArgIndex(InvalidIndex), FirstArgIndex(InvalidIndex),
1382 NumberOfArgs(0) {}
1383 };
1384
1385 SmallVector<IRArgs, 8> ArgInfo;
1386
1387public:
1388 ClangToLLVMArgMapping(const ASTContext &Context, const CGFunctionInfo &FI,
1389 bool OnlyRequiredArgs = false)
1390 : InallocaArgNo(InvalidIndex), SRetArgNo(InvalidIndex), TotalIRArgs(0),
1391 ArgInfo(OnlyRequiredArgs ? FI.getNumRequiredArgs() : FI.arg_size()) {
1392 construct(Context, FI, OnlyRequiredArgs);
1393 }
1394
1395 bool hasInallocaArg() const { return InallocaArgNo != InvalidIndex; }
1396 unsigned getInallocaArgNo() const {
1397 assert(hasInallocaArg());
1398 return InallocaArgNo;
1399 }
1400
1401 bool hasSRetArg() const { return SRetArgNo != InvalidIndex; }
1402 unsigned getSRetArgNo() const {
1403 assert(hasSRetArg());
1404 return SRetArgNo;
1405 }
1406
1407 unsigned totalIRArgs() const { return TotalIRArgs; }
1408
1409 bool hasPaddingArg(unsigned ArgNo) const {
1410 assert(ArgNo < ArgInfo.size());
1411 return ArgInfo[ArgNo].PaddingArgIndex != InvalidIndex;
1412 }
1413 unsigned getPaddingArgNo(unsigned ArgNo) const {
1414 assert(hasPaddingArg(ArgNo));
1415 return ArgInfo[ArgNo].PaddingArgIndex;
1416 }
1417
1418 /// Returns index of first IR argument corresponding to ArgNo, and their
1419 /// quantity.
1420 std::pair<unsigned, unsigned> getIRArgs(unsigned ArgNo) const {
1421 assert(ArgNo < ArgInfo.size());
1422 return std::make_pair(ArgInfo[ArgNo].FirstArgIndex,
1423 ArgInfo[ArgNo].NumberOfArgs);
1424 }
1425
1426private:
1427 void construct(const ASTContext &Context, const CGFunctionInfo &FI,
1428 bool OnlyRequiredArgs);
1429};
1430
1431void ClangToLLVMArgMapping::construct(const ASTContext &Context,
1432 const CGFunctionInfo &FI,
1433 bool OnlyRequiredArgs) {
1434 unsigned IRArgNo = 0;
1435 bool SwapThisWithSRet = false;
1436 const ABIArgInfo &RetAI = FI.getReturnInfo();
1437
1438 if (RetAI.getKind() == ABIArgInfo::Indirect) {
1439 SwapThisWithSRet = RetAI.isSRetAfterThis();
1440 SRetArgNo = SwapThisWithSRet ? 1 : IRArgNo++;
1441 }
1442
1443 unsigned ArgNo = 0;
1444 unsigned NumArgs = OnlyRequiredArgs ? FI.getNumRequiredArgs() : FI.arg_size();
1445 for (CGFunctionInfo::const_arg_iterator I = FI.arg_begin(); ArgNo < NumArgs;
1446 ++I, ++ArgNo) {
1447 assert(I != FI.arg_end());
1448 QualType ArgType = I->type;
1449 const ABIArgInfo &AI = I->info;
1450 // Collect data about IR arguments corresponding to Clang argument ArgNo.
1451 auto &IRArgs = ArgInfo[ArgNo];
1452
1453 if (AI.getPaddingType())
1454 IRArgs.PaddingArgIndex = IRArgNo++;
1455
1456 switch (AI.getKind()) {
1457 case ABIArgInfo::Extend:
1458 case ABIArgInfo::Direct: {
1459 // FIXME: handle sseregparm someday...
1460 llvm::StructType *STy = dyn_cast<llvm::StructType>(AI.getCoerceToType());
1461 if (AI.isDirect() && AI.getCanBeFlattened() && STy) {
1462 IRArgs.NumberOfArgs = STy->getNumElements();
1463 } else {
1464 IRArgs.NumberOfArgs = 1;
1465 }
1466 break;
1467 }
1468 case ABIArgInfo::Indirect:
1469 IRArgs.NumberOfArgs = 1;
1470 break;
1471 case ABIArgInfo::Ignore:
1472 case ABIArgInfo::InAlloca:
1473 // ignore and inalloca doesn't have matching LLVM parameters.
1474 IRArgs.NumberOfArgs = 0;
1475 break;
John McCallf26e73d2016-03-11 04:30:43 +00001476 case ABIArgInfo::CoerceAndExpand:
1477 IRArgs.NumberOfArgs = AI.getCoerceAndExpandTypeSequence().size();
1478 break;
1479 case ABIArgInfo::Expand:
Alexey Samsonov153004f2014-09-29 22:08:00 +00001480 IRArgs.NumberOfArgs = getExpansionSize(ArgType, Context);
1481 break;
1482 }
Alexey Samsonov153004f2014-09-29 22:08:00 +00001483
1484 if (IRArgs.NumberOfArgs > 0) {
1485 IRArgs.FirstArgIndex = IRArgNo;
1486 IRArgNo += IRArgs.NumberOfArgs;
1487 }
1488
1489 // Skip over the sret parameter when it comes second. We already handled it
1490 // above.
1491 if (IRArgNo == 1 && SwapThisWithSRet)
1492 IRArgNo++;
1493 }
1494 assert(ArgNo == ArgInfo.size());
1495
1496 if (FI.usesInAlloca())
1497 InallocaArgNo = IRArgNo++;
1498
1499 TotalIRArgs = IRArgNo;
1500}
1501} // namespace
1502
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00001503/***/
1504
Daniel Dunbar6f2e8392010-07-14 23:39:36 +00001505bool CodeGenModule::ReturnTypeUsesSRet(const CGFunctionInfo &FI) {
Saleem Abdulrasoolf181f1a2018-02-28 20:16:12 +00001506 const auto &RI = FI.getReturnInfo();
1507 return RI.isIndirect() || (RI.isInAlloca() && RI.getInAllocaSRet());
Daniel Dunbar7633cbf2009-02-02 21:43:58 +00001508}
1509
Tim Northovere77cc392014-03-29 13:28:05 +00001510bool CodeGenModule::ReturnSlotInterferesWithArgs(const CGFunctionInfo &FI) {
1511 return ReturnTypeUsesSRet(FI) &&
1512 getTargetCodeGenInfo().doesReturnSlotInterfereWithArgs();
1513}
1514
Daniel Dunbar6f2e8392010-07-14 23:39:36 +00001515bool CodeGenModule::ReturnTypeUsesFPRet(QualType ResultType) {
1516 if (const BuiltinType *BT = ResultType->getAs<BuiltinType>()) {
1517 switch (BT->getKind()) {
1518 default:
1519 return false;
1520 case BuiltinType::Float:
John McCallc8e01702013-04-16 22:48:15 +00001521 return getTarget().useObjCFPRetForRealType(TargetInfo::Float);
Daniel Dunbar6f2e8392010-07-14 23:39:36 +00001522 case BuiltinType::Double:
John McCallc8e01702013-04-16 22:48:15 +00001523 return getTarget().useObjCFPRetForRealType(TargetInfo::Double);
Daniel Dunbar6f2e8392010-07-14 23:39:36 +00001524 case BuiltinType::LongDouble:
John McCallc8e01702013-04-16 22:48:15 +00001525 return getTarget().useObjCFPRetForRealType(TargetInfo::LongDouble);
Daniel Dunbar6f2e8392010-07-14 23:39:36 +00001526 }
1527 }
1528
1529 return false;
1530}
1531
Anders Carlsson2f1a6c32011-10-31 16:27:11 +00001532bool CodeGenModule::ReturnTypeUsesFP2Ret(QualType ResultType) {
1533 if (const ComplexType *CT = ResultType->getAs<ComplexType>()) {
1534 if (const BuiltinType *BT = CT->getElementType()->getAs<BuiltinType>()) {
1535 if (BT->getKind() == BuiltinType::LongDouble)
John McCallc8e01702013-04-16 22:48:15 +00001536 return getTarget().useObjCFP2RetForComplexLongDouble();
Anders Carlsson2f1a6c32011-10-31 16:27:11 +00001537 }
1538 }
1539
1540 return false;
1541}
1542
Chris Lattnera5f58b02011-07-09 17:41:47 +00001543llvm::FunctionType *CodeGenTypes::GetFunctionType(GlobalDecl GD) {
John McCalla729c622012-02-17 03:33:10 +00001544 const CGFunctionInfo &FI = arrangeGlobalDeclaration(GD);
1545 return GetFunctionType(FI);
John McCallf8ff7b92010-02-23 00:48:20 +00001546}
1547
Chris Lattnera5f58b02011-07-09 17:41:47 +00001548llvm::FunctionType *
John McCalla729c622012-02-17 03:33:10 +00001549CodeGenTypes::GetFunctionType(const CGFunctionInfo &FI) {
Alexey Samsonov153004f2014-09-29 22:08:00 +00001550
David Blaikie82e95a32014-11-19 07:49:47 +00001551 bool Inserted = FunctionsBeingProcessed.insert(&FI).second;
1552 (void)Inserted;
Chris Lattner6fb0ccf2011-07-15 05:16:14 +00001553 assert(Inserted && "Recursively being processed?");
Daniel Dunbar7a95ca32008-09-10 04:01:49 +00001554
Alexey Samsonov153004f2014-09-29 22:08:00 +00001555 llvm::Type *resultType = nullptr;
John McCall85dd2c52011-05-15 02:19:42 +00001556 const ABIArgInfo &retAI = FI.getReturnInfo();
1557 switch (retAI.getKind()) {
Daniel Dunbard3674e62008-09-11 01:48:57 +00001558 case ABIArgInfo::Expand:
John McCall85dd2c52011-05-15 02:19:42 +00001559 llvm_unreachable("Invalid ABI kind for return argument");
Daniel Dunbard3674e62008-09-11 01:48:57 +00001560
Anton Korobeynikov18adbf52009-06-06 09:36:29 +00001561 case ABIArgInfo::Extend:
Daniel Dunbar67dace892009-02-03 06:17:37 +00001562 case ABIArgInfo::Direct:
John McCall85dd2c52011-05-15 02:19:42 +00001563 resultType = retAI.getCoerceToType();
Daniel Dunbar67dace892009-02-03 06:17:37 +00001564 break;
1565
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001566 case ABIArgInfo::InAlloca:
Reid Klecknerfab1e892014-02-25 00:59:14 +00001567 if (retAI.getInAllocaSRet()) {
1568 // sret things on win32 aren't void, they return the sret pointer.
1569 QualType ret = FI.getReturnType();
1570 llvm::Type *ty = ConvertType(ret);
1571 unsigned addressSpace = Context.getTargetAddressSpace(ret);
1572 resultType = llvm::PointerType::get(ty, addressSpace);
1573 } else {
1574 resultType = llvm::Type::getVoidTy(getLLVMContext());
1575 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001576 break;
1577
John McCall7f416cc2015-09-08 08:05:57 +00001578 case ABIArgInfo::Indirect:
Daniel Dunbar94a6f252009-01-26 21:26:08 +00001579 case ABIArgInfo::Ignore:
John McCall85dd2c52011-05-15 02:19:42 +00001580 resultType = llvm::Type::getVoidTy(getLLVMContext());
Daniel Dunbar94a6f252009-01-26 21:26:08 +00001581 break;
John McCallf26e73d2016-03-11 04:30:43 +00001582
1583 case ABIArgInfo::CoerceAndExpand:
1584 resultType = retAI.getUnpaddedCoerceAndExpandType();
1585 break;
Daniel Dunbar7a95ca32008-09-10 04:01:49 +00001586 }
Mike Stump11289f42009-09-09 15:08:12 +00001587
Alexey Samsonov153004f2014-09-29 22:08:00 +00001588 ClangToLLVMArgMapping IRFunctionArgs(getContext(), FI, true);
1589 SmallVector<llvm::Type*, 8> ArgTypes(IRFunctionArgs.totalIRArgs());
1590
1591 // Add type for sret argument.
1592 if (IRFunctionArgs.hasSRetArg()) {
1593 QualType Ret = FI.getReturnType();
1594 llvm::Type *Ty = ConvertType(Ret);
1595 unsigned AddressSpace = Context.getTargetAddressSpace(Ret);
1596 ArgTypes[IRFunctionArgs.getSRetArgNo()] =
1597 llvm::PointerType::get(Ty, AddressSpace);
1598 }
1599
1600 // Add type for inalloca argument.
1601 if (IRFunctionArgs.hasInallocaArg()) {
1602 auto ArgStruct = FI.getArgStruct();
1603 assert(ArgStruct);
1604 ArgTypes[IRFunctionArgs.getInallocaArgNo()] = ArgStruct->getPointerTo();
1605 }
1606
John McCallc818bbb2012-12-07 07:03:17 +00001607 // Add in all of the required arguments.
Alexey Samsonov153004f2014-09-29 22:08:00 +00001608 unsigned ArgNo = 0;
Alexey Samsonov34625dd2014-09-29 21:21:48 +00001609 CGFunctionInfo::const_arg_iterator it = FI.arg_begin(),
1610 ie = it + FI.getNumRequiredArgs();
Alexey Samsonov153004f2014-09-29 22:08:00 +00001611 for (; it != ie; ++it, ++ArgNo) {
1612 const ABIArgInfo &ArgInfo = it->info;
Mike Stump11289f42009-09-09 15:08:12 +00001613
Rafael Espindolafad28de2012-10-24 01:59:00 +00001614 // Insert a padding type to ensure proper alignment.
Alexey Samsonov153004f2014-09-29 22:08:00 +00001615 if (IRFunctionArgs.hasPaddingArg(ArgNo))
1616 ArgTypes[IRFunctionArgs.getPaddingArgNo(ArgNo)] =
1617 ArgInfo.getPaddingType();
Rafael Espindolafad28de2012-10-24 01:59:00 +00001618
Alexey Samsonov153004f2014-09-29 22:08:00 +00001619 unsigned FirstIRArg, NumIRArgs;
1620 std::tie(FirstIRArg, NumIRArgs) = IRFunctionArgs.getIRArgs(ArgNo);
1621
1622 switch (ArgInfo.getKind()) {
Daniel Dunbar94a6f252009-01-26 21:26:08 +00001623 case ABIArgInfo::Ignore:
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001624 case ABIArgInfo::InAlloca:
Alexey Samsonov153004f2014-09-29 22:08:00 +00001625 assert(NumIRArgs == 0);
Daniel Dunbar94a6f252009-01-26 21:26:08 +00001626 break;
1627
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00001628 case ABIArgInfo::Indirect: {
Alexey Samsonov153004f2014-09-29 22:08:00 +00001629 assert(NumIRArgs == 1);
Yaxun Liud7523282017-04-17 20:10:44 +00001630 // indirect arguments are always on the stack, which is alloca addr space.
Chris Lattner2192fe52011-07-18 04:24:23 +00001631 llvm::Type *LTy = ConvertTypeForMem(it->type);
Yaxun Liud7523282017-04-17 20:10:44 +00001632 ArgTypes[FirstIRArg] = LTy->getPointerTo(
1633 CGM.getDataLayout().getAllocaAddrSpace());
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00001634 break;
1635 }
1636
1637 case ABIArgInfo::Extend:
Chris Lattner2cdfda42010-07-29 06:44:09 +00001638 case ABIArgInfo::Direct: {
Oliver Stannard2bfdc5b2014-08-27 10:43:15 +00001639 // Fast-isel and the optimizer generally like scalar values better than
1640 // FCAs, so we flatten them if this is safe to do for this argument.
Alexey Samsonov153004f2014-09-29 22:08:00 +00001641 llvm::Type *argType = ArgInfo.getCoerceToType();
James Molloy6f244b62014-05-09 16:21:39 +00001642 llvm::StructType *st = dyn_cast<llvm::StructType>(argType);
Alexey Samsonov153004f2014-09-29 22:08:00 +00001643 if (st && ArgInfo.isDirect() && ArgInfo.getCanBeFlattened()) {
1644 assert(NumIRArgs == st->getNumElements());
John McCall85dd2c52011-05-15 02:19:42 +00001645 for (unsigned i = 0, e = st->getNumElements(); i != e; ++i)
Alexey Samsonov153004f2014-09-29 22:08:00 +00001646 ArgTypes[FirstIRArg + i] = st->getElementType(i);
Chris Lattner3dd716c2010-06-28 23:44:11 +00001647 } else {
Alexey Samsonov153004f2014-09-29 22:08:00 +00001648 assert(NumIRArgs == 1);
1649 ArgTypes[FirstIRArg] = argType;
Chris Lattner3dd716c2010-06-28 23:44:11 +00001650 }
Daniel Dunbar2f219b02009-02-03 19:12:28 +00001651 break;
Chris Lattner2cdfda42010-07-29 06:44:09 +00001652 }
Mike Stump11289f42009-09-09 15:08:12 +00001653
John McCallf26e73d2016-03-11 04:30:43 +00001654 case ABIArgInfo::CoerceAndExpand: {
1655 auto ArgTypesIter = ArgTypes.begin() + FirstIRArg;
1656 for (auto EltTy : ArgInfo.getCoerceAndExpandTypeSequence()) {
1657 *ArgTypesIter++ = EltTy;
1658 }
1659 assert(ArgTypesIter == ArgTypes.begin() + FirstIRArg + NumIRArgs);
1660 break;
1661 }
1662
Daniel Dunbard3674e62008-09-11 01:48:57 +00001663 case ABIArgInfo::Expand:
Alexey Samsonov153004f2014-09-29 22:08:00 +00001664 auto ArgTypesIter = ArgTypes.begin() + FirstIRArg;
1665 getExpandedTypes(it->type, ArgTypesIter);
1666 assert(ArgTypesIter == ArgTypes.begin() + FirstIRArg + NumIRArgs);
Daniel Dunbard3674e62008-09-11 01:48:57 +00001667 break;
1668 }
Daniel Dunbar7a95ca32008-09-10 04:01:49 +00001669 }
1670
Chris Lattner6fb0ccf2011-07-15 05:16:14 +00001671 bool Erased = FunctionsBeingProcessed.erase(&FI); (void)Erased;
1672 assert(Erased && "Not in set?");
Alexey Samsonov153004f2014-09-29 22:08:00 +00001673
1674 return llvm::FunctionType::get(resultType, ArgTypes, FI.isVariadic());
Daniel Dunbar81cf67f2008-09-09 23:48:28 +00001675}
1676
Chris Lattner2192fe52011-07-18 04:24:23 +00001677llvm::Type *CodeGenTypes::GetFunctionTypeForVTable(GlobalDecl GD) {
John McCall5d865c322010-08-31 07:33:07 +00001678 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
Anders Carlsson64457732009-11-24 05:08:52 +00001679 const FunctionProtoType *FPT = MD->getType()->getAs<FunctionProtoType>();
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001680
Chris Lattner8806e322011-07-10 00:18:59 +00001681 if (!isFuncTypeConvertible(FPT))
1682 return llvm::StructType::get(getLLVMContext());
Fangrui Song6907ce22018-07-30 19:24:48 +00001683
Chris Lattner8806e322011-07-10 00:18:59 +00001684 const CGFunctionInfo *Info;
1685 if (isa<CXXDestructorDecl>(MD))
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001686 Info =
1687 &arrangeCXXStructorDeclaration(MD, getFromDtorType(GD.getDtorType()));
Chris Lattner8806e322011-07-10 00:18:59 +00001688 else
John McCalla729c622012-02-17 03:33:10 +00001689 Info = &arrangeCXXMethodDeclaration(MD);
1690 return GetFunctionType(*Info);
Anders Carlsson64457732009-11-24 05:08:52 +00001691}
1692
Samuel Antao798f11c2015-11-23 22:04:44 +00001693static void AddAttributesFromFunctionProtoType(ASTContext &Ctx,
1694 llvm::AttrBuilder &FuncAttrs,
1695 const FunctionProtoType *FPT) {
1696 if (!FPT)
1697 return;
1698
1699 if (!isUnresolvedExceptionSpec(FPT->getExceptionSpecType()) &&
Richard Smitheaf11ad2018-05-03 03:58:32 +00001700 FPT->isNothrow())
Samuel Antao798f11c2015-11-23 22:04:44 +00001701 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
1702}
1703
Justin Lebarb080b632017-01-25 21:29:48 +00001704void CodeGenModule::ConstructDefaultFnAttrList(StringRef Name, bool HasOptnone,
1705 bool AttrOnCallSite,
1706 llvm::AttrBuilder &FuncAttrs) {
1707 // OptimizeNoneAttr takes precedence over -Os or -Oz. No warning needed.
1708 if (!HasOptnone) {
1709 if (CodeGenOpts.OptimizeSize)
1710 FuncAttrs.addAttribute(llvm::Attribute::OptimizeForSize);
1711 if (CodeGenOpts.OptimizeSize == 2)
1712 FuncAttrs.addAttribute(llvm::Attribute::MinSize);
1713 }
1714
1715 if (CodeGenOpts.DisableRedZone)
1716 FuncAttrs.addAttribute(llvm::Attribute::NoRedZone);
Kristina Brooks7f569b72018-10-18 14:07:02 +00001717 if (CodeGenOpts.IndirectTlsSegRefs)
1718 FuncAttrs.addAttribute("indirect-tls-seg-refs");
Justin Lebarb080b632017-01-25 21:29:48 +00001719 if (CodeGenOpts.NoImplicitFloat)
1720 FuncAttrs.addAttribute(llvm::Attribute::NoImplicitFloat);
1721
1722 if (AttrOnCallSite) {
1723 // Attributes that should go on the call site only.
1724 if (!CodeGenOpts.SimplifyLibCalls ||
1725 CodeGenOpts.isNoBuiltinFunc(Name.data()))
1726 FuncAttrs.addAttribute(llvm::Attribute::NoBuiltin);
1727 if (!CodeGenOpts.TrapFuncName.empty())
1728 FuncAttrs.addAttribute("trap-func-name", CodeGenOpts.TrapFuncName);
1729 } else {
1730 // Attributes that should go on the function, but not the call site.
1731 if (!CodeGenOpts.DisableFPElim) {
1732 FuncAttrs.addAttribute("no-frame-pointer-elim", "false");
1733 } else if (CodeGenOpts.OmitLeafFramePointer) {
1734 FuncAttrs.addAttribute("no-frame-pointer-elim", "false");
1735 FuncAttrs.addAttribute("no-frame-pointer-elim-non-leaf");
1736 } else {
1737 FuncAttrs.addAttribute("no-frame-pointer-elim", "true");
1738 FuncAttrs.addAttribute("no-frame-pointer-elim-non-leaf");
1739 }
1740
1741 FuncAttrs.addAttribute("less-precise-fpmad",
1742 llvm::toStringRef(CodeGenOpts.LessPreciseFPMAD));
1743
Manoj Guptada08f6a2018-07-19 00:44:52 +00001744 if (CodeGenOpts.NullPointerIsValid)
1745 FuncAttrs.addAttribute("null-pointer-is-valid", "true");
Justin Lebarb080b632017-01-25 21:29:48 +00001746 if (!CodeGenOpts.FPDenormalMode.empty())
1747 FuncAttrs.addAttribute("denormal-fp-math", CodeGenOpts.FPDenormalMode);
1748
1749 FuncAttrs.addAttribute("no-trapping-math",
1750 llvm::toStringRef(CodeGenOpts.NoTrappingMath));
1751
Sanjay Patelc81450e2018-04-30 18:19:03 +00001752 // Strict (compliant) code is the default, so only add this attribute to
1753 // indicate that we are trying to workaround a problem case.
1754 if (!CodeGenOpts.StrictFloatCastOverflow)
1755 FuncAttrs.addAttribute("strict-float-cast-overflow", "false");
Sanjay Pateld1754762018-04-27 14:22:48 +00001756
Justin Lebarb080b632017-01-25 21:29:48 +00001757 // TODO: Are these all needed?
1758 // unsafe/inf/nan/nsz are handled by instruction-level FastMathFlags.
1759 FuncAttrs.addAttribute("no-infs-fp-math",
1760 llvm::toStringRef(CodeGenOpts.NoInfsFPMath));
1761 FuncAttrs.addAttribute("no-nans-fp-math",
1762 llvm::toStringRef(CodeGenOpts.NoNaNsFPMath));
1763 FuncAttrs.addAttribute("unsafe-fp-math",
1764 llvm::toStringRef(CodeGenOpts.UnsafeFPMath));
1765 FuncAttrs.addAttribute("use-soft-float",
1766 llvm::toStringRef(CodeGenOpts.SoftFloat));
1767 FuncAttrs.addAttribute("stack-protector-buffer-size",
1768 llvm::utostr(CodeGenOpts.SSPBufferSize));
1769 FuncAttrs.addAttribute("no-signed-zeros-fp-math",
1770 llvm::toStringRef(CodeGenOpts.NoSignedZeros));
1771 FuncAttrs.addAttribute(
1772 "correctly-rounded-divide-sqrt-fp-math",
1773 llvm::toStringRef(CodeGenOpts.CorrectlyRoundedDivSqrt));
1774
Alexey Sotkin3858e262018-04-20 08:08:04 +00001775 if (getLangOpts().OpenCL)
1776 FuncAttrs.addAttribute("denorms-are-zero",
1777 llvm::toStringRef(CodeGenOpts.FlushDenorm));
1778
Justin Lebarb080b632017-01-25 21:29:48 +00001779 // TODO: Reciprocal estimate codegen options should apply to instructions?
Craig Topper402b4312017-11-20 17:09:22 +00001780 const std::vector<std::string> &Recips = CodeGenOpts.Reciprocals;
Justin Lebarb080b632017-01-25 21:29:48 +00001781 if (!Recips.empty())
1782 FuncAttrs.addAttribute("reciprocal-estimates",
Erich Keane857ac592017-10-27 18:45:06 +00001783 llvm::join(Recips, ","));
Justin Lebarb080b632017-01-25 21:29:48 +00001784
Craig Topper9a724aa2017-12-11 21:09:19 +00001785 if (!CodeGenOpts.PreferVectorWidth.empty() &&
1786 CodeGenOpts.PreferVectorWidth != "none")
1787 FuncAttrs.addAttribute("prefer-vector-width",
1788 CodeGenOpts.PreferVectorWidth);
1789
Justin Lebarb080b632017-01-25 21:29:48 +00001790 if (CodeGenOpts.StackRealignment)
1791 FuncAttrs.addAttribute("stackrealign");
1792 if (CodeGenOpts.Backchain)
1793 FuncAttrs.addAttribute("backchain");
Chandler Carruth664aa862018-09-04 12:38:00 +00001794
1795 if (CodeGenOpts.SpeculativeLoadHardening)
1796 FuncAttrs.addAttribute(llvm::Attribute::SpeculativeLoadHardening);
Justin Lebarb080b632017-01-25 21:29:48 +00001797 }
1798
Matt Arsenaulta1cf61b2017-10-06 19:34:40 +00001799 if (getLangOpts().assumeFunctionsAreConvergent()) {
1800 // Conservatively, mark all functions and calls in CUDA and OpenCL as
1801 // convergent (meaning, they may call an intrinsically convergent op, such
1802 // as __syncthreads() / barrier(), and so can't have certain optimizations
1803 // applied around them). LLVM will remove this attribute where it safely
1804 // can.
Justin Lebarb080b632017-01-25 21:29:48 +00001805 FuncAttrs.addAttribute(llvm::Attribute::Convergent);
Matt Arsenaulta1cf61b2017-10-06 19:34:40 +00001806 }
Justin Lebarb080b632017-01-25 21:29:48 +00001807
Matt Arsenaulta1cf61b2017-10-06 19:34:40 +00001808 if (getLangOpts().CUDA && getLangOpts().CUDAIsDevice) {
Justin Lebarb080b632017-01-25 21:29:48 +00001809 // Exceptions aren't supported in CUDA device code.
1810 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
1811
1812 // Respect -fcuda-flush-denormals-to-zero.
Yaxun Liue1bfbc52018-07-21 02:02:22 +00001813 if (CodeGenOpts.FlushDenorm)
Justin Lebarb080b632017-01-25 21:29:48 +00001814 FuncAttrs.addAttribute("nvptx-f32ftz", "true");
1815 }
Peter Collingbourne87f477b2019-01-04 19:27:04 +00001816
1817 for (StringRef Attr : CodeGenOpts.DefaultFunctionAttrs) {
1818 StringRef Var, Value;
1819 std::tie(Var, Value) = Attr.split('=');
1820 FuncAttrs.addAttribute(Var, Value);
1821 }
Justin Lebarb080b632017-01-25 21:29:48 +00001822}
1823
1824void CodeGenModule::AddDefaultFnAttrs(llvm::Function &F) {
1825 llvm::AttrBuilder FuncAttrs;
1826 ConstructDefaultFnAttrList(F.getName(),
1827 F.hasFnAttribute(llvm::Attribute::OptimizeNone),
1828 /* AttrOnCallsite = */ false, FuncAttrs);
Reid Kleckneree4930b2017-05-02 22:07:37 +00001829 F.addAttributes(llvm::AttributeList::FunctionIndex, FuncAttrs);
Justin Lebarb080b632017-01-25 21:29:48 +00001830}
1831
Chad Rosier7dbc9cf2016-01-06 14:35:46 +00001832void CodeGenModule::ConstructAttributeList(
1833 StringRef Name, const CGFunctionInfo &FI, CGCalleeInfo CalleeInfo,
Reid Klecknercdd26792017-04-18 23:50:03 +00001834 llvm::AttributeList &AttrList, unsigned &CallingConv, bool AttrOnCallSite) {
Bill Wendlinga514ebc2012-10-15 20:36:26 +00001835 llvm::AttrBuilder FuncAttrs;
1836 llvm::AttrBuilder RetAttrs;
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00001837
Daniel Dunbar0ef34792009-09-12 00:59:20 +00001838 CallingConv = FI.getEffectiveCallingConvention();
John McCallab26cfa2010-02-05 21:31:56 +00001839 if (FI.isNoReturn())
Bill Wendling207f0532012-12-20 19:27:06 +00001840 FuncAttrs.addAttribute(llvm::Attribute::NoReturn);
John McCallab26cfa2010-02-05 21:31:56 +00001841
Samuel Antao798f11c2015-11-23 22:04:44 +00001842 // If we have information about the function prototype, we can learn
Craig Topper13d759f2018-04-30 22:02:48 +00001843 // attributes from there.
Samuel Antao798f11c2015-11-23 22:04:44 +00001844 AddAttributesFromFunctionProtoType(getContext(), FuncAttrs,
1845 CalleeInfo.getCalleeFunctionProtoType());
1846
Erich Keanede6480a32018-11-13 15:48:08 +00001847 const Decl *TargetDecl = CalleeInfo.getCalleeDecl().getDecl();
Samuel Antao798f11c2015-11-23 22:04:44 +00001848
Justin Lebarb080b632017-01-25 21:29:48 +00001849 bool HasOptnone = false;
Anton Korobeynikovc8478242009-04-04 00:49:24 +00001850 // FIXME: handle sseregparm someday...
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00001851 if (TargetDecl) {
Rafael Espindola2d21ab02011-10-12 19:51:18 +00001852 if (TargetDecl->hasAttr<ReturnsTwiceAttr>())
Bill Wendling207f0532012-12-20 19:27:06 +00001853 FuncAttrs.addAttribute(llvm::Attribute::ReturnsTwice);
Argyrios Kyrtzidisb4b64ca2009-06-30 02:34:44 +00001854 if (TargetDecl->hasAttr<NoThrowAttr>())
Bill Wendling207f0532012-12-20 19:27:06 +00001855 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
Richard Smithdebc59d2013-01-30 05:45:05 +00001856 if (TargetDecl->hasAttr<NoReturnAttr>())
1857 FuncAttrs.addAttribute(llvm::Attribute::NoReturn);
Xinliang David Li4ec36062017-06-13 21:14:07 +00001858 if (TargetDecl->hasAttr<ColdAttr>())
1859 FuncAttrs.addAttribute(llvm::Attribute::Cold);
Aaron Ballman7c19ab12014-02-22 16:59:24 +00001860 if (TargetDecl->hasAttr<NoDuplicateAttr>())
1861 FuncAttrs.addAttribute(llvm::Attribute::NoDuplicate);
Yaxun Liu7d07ae72016-11-01 18:45:32 +00001862 if (TargetDecl->hasAttr<ConvergentAttr>())
1863 FuncAttrs.addAttribute(llvm::Attribute::Convergent);
Richard Smithdebc59d2013-01-30 05:45:05 +00001864
Chandler Carruth45bbe012017-03-24 09:11:57 +00001865 if (const FunctionDecl *Fn = dyn_cast<FunctionDecl>(TargetDecl)) {
Samuel Antao798f11c2015-11-23 22:04:44 +00001866 AddAttributesFromFunctionProtoType(
Chandler Carruth45bbe012017-03-24 09:11:57 +00001867 getContext(), FuncAttrs, Fn->getType()->getAs<FunctionProtoType>());
Richard Smith49af6292013-03-05 08:30:04 +00001868 // Don't use [[noreturn]] or _Noreturn for a call to a virtual function.
1869 // These attributes are not inherited by overloads.
Chandler Carruth45bbe012017-03-24 09:11:57 +00001870 const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(Fn);
1871 if (Fn->isNoReturn() && !(AttrOnCallSite && MD && MD->isVirtual()))
Richard Smithdebc59d2013-01-30 05:45:05 +00001872 FuncAttrs.addAttribute(llvm::Attribute::NoReturn);
John McCallbe349de2010-07-08 06:48:12 +00001873 }
1874
David Majnemer1bf0f8e2015-07-20 22:51:52 +00001875 // 'const', 'pure' and 'noalias' attributed functions are also nounwind.
Eric Christopherbf005ec2011-08-15 22:38:22 +00001876 if (TargetDecl->hasAttr<ConstAttr>()) {
Bill Wendling207f0532012-12-20 19:27:06 +00001877 FuncAttrs.addAttribute(llvm::Attribute::ReadNone);
1878 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
Eric Christopherbf005ec2011-08-15 22:38:22 +00001879 } else if (TargetDecl->hasAttr<PureAttr>()) {
Bill Wendling207f0532012-12-20 19:27:06 +00001880 FuncAttrs.addAttribute(llvm::Attribute::ReadOnly);
1881 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
David Majnemer1bf0f8e2015-07-20 22:51:52 +00001882 } else if (TargetDecl->hasAttr<NoAliasAttr>()) {
1883 FuncAttrs.addAttribute(llvm::Attribute::ArgMemOnly);
1884 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
Eric Christopherbf005ec2011-08-15 22:38:22 +00001885 }
David Majnemer631a90b2015-02-04 07:23:21 +00001886 if (TargetDecl->hasAttr<RestrictAttr>())
Bill Wendling207f0532012-12-20 19:27:06 +00001887 RetAttrs.addAttribute(llvm::Attribute::NoAlias);
Manoj Guptada08f6a2018-07-19 00:44:52 +00001888 if (TargetDecl->hasAttr<ReturnsNonNullAttr>() &&
1889 !CodeGenOpts.NullPointerIsValid)
Hal Finkeld8442b12014-07-12 04:51:04 +00001890 RetAttrs.addAttribute(llvm::Attribute::NonNull);
Oren Ben Simhon318a6ea2017-04-27 12:01:00 +00001891 if (TargetDecl->hasAttr<AnyX86NoCallerSavedRegistersAttr>())
1892 FuncAttrs.addAttribute("no_caller_saved_registers");
Oren Ben Simhon220671a2018-03-17 13:31:35 +00001893 if (TargetDecl->hasAttr<AnyX86NoCfCheckAttr>())
1894 FuncAttrs.addAttribute(llvm::Attribute::NoCfCheck);
Paul Robinson08556952014-12-11 20:14:04 +00001895
1896 HasOptnone = TargetDecl->hasAttr<OptimizeNoneAttr>();
George Burgess IVe3763372016-12-22 02:50:20 +00001897 if (auto *AllocSize = TargetDecl->getAttr<AllocSizeAttr>()) {
1898 Optional<unsigned> NumElemsParam;
Joel E. Denny81508102018-03-13 14:51:22 +00001899 if (AllocSize->getNumElemsParam().isValid())
1900 NumElemsParam = AllocSize->getNumElemsParam().getLLVMIndex();
1901 FuncAttrs.addAllocSizeAttr(AllocSize->getElemSizeParam().getLLVMIndex(),
George Burgess IVe3763372016-12-22 02:50:20 +00001902 NumElemsParam);
1903 }
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00001904 }
1905
Justin Lebarb080b632017-01-25 21:29:48 +00001906 ConstructDefaultFnAttrList(Name, HasOptnone, AttrOnCallSite, FuncAttrs);
Paul Robinson08556952014-12-11 20:14:04 +00001907
Zola Bridges826ef592019-01-18 17:20:46 +00001908 // This must run after constructing the default function attribute list
1909 // to ensure that the speculative load hardening attribute is removed
1910 // in the case where the -mspeculative-load-hardening flag was passed.
1911 if (TargetDecl) {
1912 if (TargetDecl->hasAttr<NoSpeculativeLoadHardeningAttr>())
1913 FuncAttrs.removeAttribute(llvm::Attribute::SpeculativeLoadHardening);
1914 if (TargetDecl->hasAttr<SpeculativeLoadHardeningAttr>())
1915 FuncAttrs.addAttribute(llvm::Attribute::SpeculativeLoadHardening);
1916 }
1917
Peter Collingbourneb4728c12014-05-19 22:14:34 +00001918 if (CodeGenOpts.EnableSegmentedStacks &&
1919 !(TargetDecl && TargetDecl->hasAttr<NoSplitStackAttr>()))
Reid Klecknerfb873af2014-04-10 22:59:13 +00001920 FuncAttrs.addAttribute("split-stack");
Devang Patel6e467b12009-06-04 23:32:02 +00001921
Sriraman Tallam5c651482017-11-07 19:37:51 +00001922 // Add NonLazyBind attribute to function declarations when -fno-plt
1923 // is used.
1924 if (TargetDecl && CodeGenOpts.NoPLT) {
1925 if (auto *Fn = dyn_cast<FunctionDecl>(TargetDecl)) {
1926 if (!Fn->isDefined() && !AttrOnCallSite) {
1927 FuncAttrs.addAttribute(llvm::Attribute::NonLazyBind);
1928 }
1929 }
1930 }
1931
Alexey Sotkin20f65922018-02-22 11:54:14 +00001932 if (TargetDecl && TargetDecl->hasAttr<OpenCLKernelAttr>()) {
1933 if (getLangOpts().OpenCLVersion <= 120) {
1934 // OpenCL v1.2 Work groups are always uniform
1935 FuncAttrs.addAttribute("uniform-work-group-size", "true");
1936 } else {
1937 // OpenCL v2.0 Work groups may be whether uniform or not.
1938 // '-cl-uniform-work-group-size' compile option gets a hint
1939 // to the compiler that the global work-size be a multiple of
1940 // the work-group size specified to clEnqueueNDRangeKernel
1941 // (i.e. work groups are uniform).
1942 FuncAttrs.addAttribute("uniform-work-group-size",
1943 llvm::toStringRef(CodeGenOpts.UniformWGSize));
1944 }
1945 }
1946
Justin Lebarb080b632017-01-25 21:29:48 +00001947 if (!AttrOnCallSite) {
Akira Hatanaka627586b2018-03-02 01:53:15 +00001948 bool DisableTailCalls = false;
1949
1950 if (CodeGenOpts.DisableTailCalls)
1951 DisableTailCalls = true;
1952 else if (TargetDecl) {
1953 if (TargetDecl->hasAttr<DisableTailCallsAttr>() ||
1954 TargetDecl->hasAttr<AnyX86InterruptAttr>())
1955 DisableTailCalls = true;
1956 else if (CodeGenOpts.NoEscapingBlockTailCalls) {
1957 if (const auto *BD = dyn_cast<BlockDecl>(TargetDecl))
1958 if (!BD->doesNotEscape())
1959 DisableTailCalls = true;
1960 }
1961 }
1962
Justin Lebarb080b632017-01-25 21:29:48 +00001963 FuncAttrs.addAttribute("disable-tail-calls",
1964 llvm::toStringRef(DisableTailCalls));
Erich Keanede6480a32018-11-13 15:48:08 +00001965 GetCPUAndFeaturesAttributes(CalleeInfo.getCalleeDecl(), FuncAttrs);
Bill Wendling985d1c52013-02-15 21:30:01 +00001966 }
1967
Alexey Samsonov153004f2014-09-29 22:08:00 +00001968 ClangToLLVMArgMapping IRFunctionArgs(getContext(), FI);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00001969
Daniel Dunbar3668cb22009-02-02 23:43:58 +00001970 QualType RetTy = FI.getReturnType();
Daniel Dunbarb52d0772009-02-03 05:59:18 +00001971 const ABIArgInfo &RetAI = FI.getReturnInfo();
Daniel Dunbar7a95ca32008-09-10 04:01:49 +00001972 switch (RetAI.getKind()) {
Anton Korobeynikov18adbf52009-06-06 09:36:29 +00001973 case ABIArgInfo::Extend:
Alex Bradburye41a5e22018-01-12 20:08:16 +00001974 if (RetAI.isSignExt())
Jakob Stoklund Olesend7bf2932013-05-29 03:57:23 +00001975 RetAttrs.addAttribute(llvm::Attribute::SExt);
Alex Bradburye41a5e22018-01-12 20:08:16 +00001976 else
Jakob Stoklund Olesend7bf2932013-05-29 03:57:23 +00001977 RetAttrs.addAttribute(llvm::Attribute::ZExt);
Adrian Prantlf3b3ccd2017-12-19 22:06:11 +00001978 LLVM_FALLTHROUGH;
Daniel Dunbar67dace892009-02-03 06:17:37 +00001979 case ABIArgInfo::Direct:
Jakob Stoklund Olesena3661142013-06-05 03:00:09 +00001980 if (RetAI.getInReg())
1981 RetAttrs.addAttribute(llvm::Attribute::InReg);
1982 break;
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00001983 case ABIArgInfo::Ignore:
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00001984 break;
1985
Alexey Samsonov91cf4552014-08-22 01:06:06 +00001986 case ABIArgInfo::InAlloca:
Rafael Espindola06b2b4a2012-07-31 02:44:24 +00001987 case ABIArgInfo::Indirect: {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00001988 // inalloca and sret disable readnone and readonly
Bill Wendling207f0532012-12-20 19:27:06 +00001989 FuncAttrs.removeAttribute(llvm::Attribute::ReadOnly)
1990 .removeAttribute(llvm::Attribute::ReadNone);
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00001991 break;
Rafael Espindola06b2b4a2012-07-31 02:44:24 +00001992 }
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00001993
John McCallf26e73d2016-03-11 04:30:43 +00001994 case ABIArgInfo::CoerceAndExpand:
1995 break;
1996
Daniel Dunbard3674e62008-09-11 01:48:57 +00001997 case ABIArgInfo::Expand:
David Blaikie83d382b2011-09-23 05:06:16 +00001998 llvm_unreachable("Invalid ABI kind for return argument");
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00001999 }
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00002000
Hal Finkela2347ba2014-07-18 15:52:10 +00002001 if (const auto *RefTy = RetTy->getAs<ReferenceType>()) {
2002 QualType PTy = RefTy->getPointeeType();
David Majnemer9df56372015-09-10 21:52:00 +00002003 if (!PTy->isIncompleteType() && PTy->isConstantSizeType())
Hal Finkela2347ba2014-07-18 15:52:10 +00002004 RetAttrs.addDereferenceableAttr(getContext().getTypeSizeInChars(PTy)
2005 .getQuantity());
Manoj Guptada08f6a2018-07-19 00:44:52 +00002006 else if (getContext().getTargetAddressSpace(PTy) == 0 &&
2007 !CodeGenOpts.NullPointerIsValid)
Hal Finkela2347ba2014-07-18 15:52:10 +00002008 RetAttrs.addAttribute(llvm::Attribute::NonNull);
2009 }
Nick Lewycky9b46eb82014-05-28 09:56:42 +00002010
John McCall12f23522016-04-04 18:33:08 +00002011 bool hasUsedSRet = false;
Reid Klecknercdd26792017-04-18 23:50:03 +00002012 SmallVector<llvm::AttributeSet, 4> ArgAttrs(IRFunctionArgs.totalIRArgs());
John McCall12f23522016-04-04 18:33:08 +00002013
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002014 // Attach attributes to sret.
2015 if (IRFunctionArgs.hasSRetArg()) {
2016 llvm::AttrBuilder SRETAttrs;
Mandeep Singh Grang2a153102018-07-26 18:07:59 +00002017 if (!RetAI.getSuppressSRet())
2018 SRETAttrs.addAttribute(llvm::Attribute::StructRet);
John McCall12f23522016-04-04 18:33:08 +00002019 hasUsedSRet = true;
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002020 if (RetAI.getInReg())
2021 SRETAttrs.addAttribute(llvm::Attribute::InReg);
Reid Klecknercdd26792017-04-18 23:50:03 +00002022 ArgAttrs[IRFunctionArgs.getSRetArgNo()] =
2023 llvm::AttributeSet::get(getLLVMContext(), SRETAttrs);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002024 }
2025
2026 // Attach attributes to inalloca argument.
2027 if (IRFunctionArgs.hasInallocaArg()) {
2028 llvm::AttrBuilder Attrs;
2029 Attrs.addAttribute(llvm::Attribute::InAlloca);
Reid Klecknercdd26792017-04-18 23:50:03 +00002030 ArgAttrs[IRFunctionArgs.getInallocaArgNo()] =
2031 llvm::AttributeSet::get(getLLVMContext(), Attrs);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002032 }
2033
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002034 unsigned ArgNo = 0;
2035 for (CGFunctionInfo::const_arg_iterator I = FI.arg_begin(),
2036 E = FI.arg_end();
2037 I != E; ++I, ++ArgNo) {
2038 QualType ParamType = I->type;
2039 const ABIArgInfo &AI = I->info;
Bill Wendlinga514ebc2012-10-15 20:36:26 +00002040 llvm::AttrBuilder Attrs;
Anton Korobeynikovc8478242009-04-04 00:49:24 +00002041
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002042 // Add attribute for padding argument, if necessary.
2043 if (IRFunctionArgs.hasPaddingArg(ArgNo)) {
Reid Klecknercdd26792017-04-18 23:50:03 +00002044 if (AI.getPaddingInReg()) {
2045 ArgAttrs[IRFunctionArgs.getPaddingArgNo(ArgNo)] =
2046 llvm::AttributeSet::get(
2047 getLLVMContext(),
2048 llvm::AttrBuilder().addAttribute(llvm::Attribute::InReg));
2049 }
Rafael Espindolafad28de2012-10-24 01:59:00 +00002050 }
2051
John McCall39ec71f2010-03-27 00:47:27 +00002052 // 'restrict' -> 'noalias' is done in EmitFunctionProlog when we
2053 // have the corresponding parameter variable. It doesn't make
Daniel Dunbarcb2b3d02011-02-10 18:10:07 +00002054 // sense to do it here because parameters are so messed up.
Daniel Dunbard3674e62008-09-11 01:48:57 +00002055 switch (AI.getKind()) {
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002056 case ABIArgInfo::Extend:
Alex Bradburye41a5e22018-01-12 20:08:16 +00002057 if (AI.isSignExt())
Bill Wendling207f0532012-12-20 19:27:06 +00002058 Attrs.addAttribute(llvm::Attribute::SExt);
Alex Bradburye41a5e22018-01-12 20:08:16 +00002059 else
2060 Attrs.addAttribute(llvm::Attribute::ZExt);
Adrian Prantlf3b3ccd2017-12-19 22:06:11 +00002061 LLVM_FALLTHROUGH;
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002062 case ABIArgInfo::Direct:
Peter Collingbournef7706832014-12-12 23:41:25 +00002063 if (ArgNo == 0 && FI.isChainCall())
2064 Attrs.addAttribute(llvm::Attribute::Nest);
2065 else if (AI.getInReg())
Bill Wendling207f0532012-12-20 19:27:06 +00002066 Attrs.addAttribute(llvm::Attribute::InReg);
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002067 break;
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002068
James Y Knight71608572015-08-21 18:19:06 +00002069 case ABIArgInfo::Indirect: {
Rafael Espindola703c47f2012-10-19 05:04:37 +00002070 if (AI.getInReg())
Bill Wendling207f0532012-12-20 19:27:06 +00002071 Attrs.addAttribute(llvm::Attribute::InReg);
Rafael Espindola703c47f2012-10-19 05:04:37 +00002072
Anders Carlsson20759ad2009-09-16 15:53:40 +00002073 if (AI.getIndirectByVal())
Bill Wendling207f0532012-12-20 19:27:06 +00002074 Attrs.addAttribute(llvm::Attribute::ByVal);
Anders Carlsson20759ad2009-09-16 15:53:40 +00002075
John McCall7f416cc2015-09-08 08:05:57 +00002076 CharUnits Align = AI.getIndirectAlign();
James Y Knight71608572015-08-21 18:19:06 +00002077
2078 // In a byval argument, it is important that the required
2079 // alignment of the type is honored, as LLVM might be creating a
2080 // *new* stack object, and needs to know what alignment to give
2081 // it. (Sometimes it can deduce a sensible alignment on its own,
2082 // but not if clang decides it must emit a packed struct, or the
2083 // user specifies increased alignment requirements.)
2084 //
2085 // This is different from indirect *not* byval, where the object
2086 // exists already, and the align attribute is purely
2087 // informative.
John McCall7f416cc2015-09-08 08:05:57 +00002088 assert(!Align.isZero());
James Y Knight71608572015-08-21 18:19:06 +00002089
John McCall7f416cc2015-09-08 08:05:57 +00002090 // For now, only add this when we have a byval argument.
2091 // TODO: be less lazy about updating test cases.
2092 if (AI.getIndirectByVal())
2093 Attrs.addAlignmentAttr(Align.getQuantity());
Bill Wendlinga7912f82012-10-10 07:36:56 +00002094
Daniel Dunbarc2304432009-03-18 19:51:01 +00002095 // byval disables readnone and readonly.
Bill Wendling207f0532012-12-20 19:27:06 +00002096 FuncAttrs.removeAttribute(llvm::Attribute::ReadOnly)
2097 .removeAttribute(llvm::Attribute::ReadNone);
Daniel Dunbard3674e62008-09-11 01:48:57 +00002098 break;
James Y Knight71608572015-08-21 18:19:06 +00002099 }
Daniel Dunbar94a6f252009-01-26 21:26:08 +00002100 case ABIArgInfo::Ignore:
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002101 case ABIArgInfo::Expand:
John McCallf26e73d2016-03-11 04:30:43 +00002102 case ABIArgInfo::CoerceAndExpand:
2103 break;
Daniel Dunbar94a6f252009-01-26 21:26:08 +00002104
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002105 case ABIArgInfo::InAlloca:
2106 // inalloca disables readnone and readonly.
2107 FuncAttrs.removeAttribute(llvm::Attribute::ReadOnly)
2108 .removeAttribute(llvm::Attribute::ReadNone);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002109 continue;
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00002110 }
Mike Stump11289f42009-09-09 15:08:12 +00002111
Hal Finkela2347ba2014-07-18 15:52:10 +00002112 if (const auto *RefTy = ParamType->getAs<ReferenceType>()) {
2113 QualType PTy = RefTy->getPointeeType();
David Majnemer9df56372015-09-10 21:52:00 +00002114 if (!PTy->isIncompleteType() && PTy->isConstantSizeType())
Hal Finkela2347ba2014-07-18 15:52:10 +00002115 Attrs.addDereferenceableAttr(getContext().getTypeSizeInChars(PTy)
2116 .getQuantity());
Manoj Guptada08f6a2018-07-19 00:44:52 +00002117 else if (getContext().getTargetAddressSpace(PTy) == 0 &&
2118 !CodeGenOpts.NullPointerIsValid)
Hal Finkela2347ba2014-07-18 15:52:10 +00002119 Attrs.addAttribute(llvm::Attribute::NonNull);
2120 }
Nick Lewycky9b46eb82014-05-28 09:56:42 +00002121
John McCall12f23522016-04-04 18:33:08 +00002122 switch (FI.getExtParameterInfo(ArgNo).getABI()) {
2123 case ParameterABI::Ordinary:
2124 break;
2125
2126 case ParameterABI::SwiftIndirectResult: {
2127 // Add 'sret' if we haven't already used it for something, but
2128 // only if the result is void.
2129 if (!hasUsedSRet && RetTy->isVoidType()) {
2130 Attrs.addAttribute(llvm::Attribute::StructRet);
2131 hasUsedSRet = true;
2132 }
2133
2134 // Add 'noalias' in either case.
2135 Attrs.addAttribute(llvm::Attribute::NoAlias);
2136
2137 // Add 'dereferenceable' and 'alignment'.
2138 auto PTy = ParamType->getPointeeType();
2139 if (!PTy->isIncompleteType() && PTy->isConstantSizeType()) {
2140 auto info = getContext().getTypeInfoInChars(PTy);
2141 Attrs.addDereferenceableAttr(info.first.getQuantity());
2142 Attrs.addAttribute(llvm::Attribute::getWithAlignment(getLLVMContext(),
2143 info.second.getQuantity()));
2144 }
2145 break;
2146 }
2147
2148 case ParameterABI::SwiftErrorResult:
2149 Attrs.addAttribute(llvm::Attribute::SwiftError);
2150 break;
2151
2152 case ParameterABI::SwiftContext:
2153 Attrs.addAttribute(llvm::Attribute::SwiftSelf);
2154 break;
2155 }
2156
Akira Hatanaka98a49332017-09-22 00:41:05 +00002157 if (FI.getExtParameterInfo(ArgNo).isNoEscape())
2158 Attrs.addAttribute(llvm::Attribute::NoCapture);
2159
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002160 if (Attrs.hasAttributes()) {
2161 unsigned FirstIRArg, NumIRArgs;
2162 std::tie(FirstIRArg, NumIRArgs) = IRFunctionArgs.getIRArgs(ArgNo);
2163 for (unsigned i = 0; i < NumIRArgs; i++)
Reid Klecknercdd26792017-04-18 23:50:03 +00002164 ArgAttrs[FirstIRArg + i] =
2165 llvm::AttributeSet::get(getLLVMContext(), Attrs);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002166 }
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00002167 }
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002168 assert(ArgNo == FI.arg_size());
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002169
Reid Klecknercdd26792017-04-18 23:50:03 +00002170 AttrList = llvm::AttributeList::get(
2171 getLLVMContext(), llvm::AttributeSet::get(getLLVMContext(), FuncAttrs),
2172 llvm::AttributeSet::get(getLLVMContext(), RetAttrs), ArgAttrs);
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00002173}
2174
John McCalla738c252011-03-09 04:27:21 +00002175/// An argument came in as a promoted argument; demote it back to its
2176/// declared type.
2177static llvm::Value *emitArgumentDemotion(CodeGenFunction &CGF,
2178 const VarDecl *var,
2179 llvm::Value *value) {
Chris Lattner2192fe52011-07-18 04:24:23 +00002180 llvm::Type *varType = CGF.ConvertType(var->getType());
John McCalla738c252011-03-09 04:27:21 +00002181
2182 // This can happen with promotions that actually don't change the
2183 // underlying type, like the enum promotions.
2184 if (value->getType() == varType) return value;
2185
2186 assert((varType->isIntegerTy() || varType->isFloatingPointTy())
2187 && "unexpected promotion type");
2188
2189 if (isa<llvm::IntegerType>(varType))
2190 return CGF.Builder.CreateTrunc(value, varType, "arg.unpromote");
2191
2192 return CGF.Builder.CreateFPCast(value, varType, "arg.unpromote");
2193}
2194
Chandler Carruth45bbe012017-03-24 09:11:57 +00002195/// Returns the attribute (either parameter attribute, or function
2196/// attribute), which declares argument ArgNo to be non-null.
2197static const NonNullAttr *getNonNullAttr(const Decl *FD, const ParmVarDecl *PVD,
2198 QualType ArgType, unsigned ArgNo) {
2199 // FIXME: __attribute__((nonnull)) can also be applied to:
2200 // - references to pointers, where the pointee is known to be
2201 // nonnull (apparently a Clang extension)
2202 // - transparent unions containing pointers
2203 // In the former case, LLVM IR cannot represent the constraint. In
2204 // the latter case, we have no guarantee that the transparent union
2205 // is in fact passed as a pointer.
2206 if (!ArgType->isAnyPointerType() && !ArgType->isBlockPointerType())
2207 return nullptr;
2208 // First, check attribute on parameter itself.
2209 if (PVD) {
2210 if (auto ParmNNAttr = PVD->getAttr<NonNullAttr>())
2211 return ParmNNAttr;
2212 }
2213 // Check function attributes.
2214 if (!FD)
2215 return nullptr;
2216 for (const auto *NNAttr : FD->specific_attrs<NonNullAttr>()) {
2217 if (NNAttr->isNonNull(ArgNo))
2218 return NNAttr;
2219 }
2220 return nullptr;
2221}
2222
John McCall12f23522016-04-04 18:33:08 +00002223namespace {
2224 struct CopyBackSwiftError final : EHScopeStack::Cleanup {
2225 Address Temp;
2226 Address Arg;
2227 CopyBackSwiftError(Address temp, Address arg) : Temp(temp), Arg(arg) {}
2228 void Emit(CodeGenFunction &CGF, Flags flags) override {
2229 llvm::Value *errorValue = CGF.Builder.CreateLoad(Temp);
2230 CGF.Builder.CreateStore(errorValue, Arg);
2231 }
2232 };
2233}
2234
Daniel Dunbard931a872009-02-02 22:03:45 +00002235void CodeGenFunction::EmitFunctionProlog(const CGFunctionInfo &FI,
2236 llvm::Function *Fn,
Daniel Dunbar613855c2008-09-09 23:27:19 +00002237 const FunctionArgList &Args) {
Hans Wennborgd71907d2014-09-04 22:16:33 +00002238 if (CurCodeDecl && CurCodeDecl->hasAttr<NakedAttr>())
2239 // Naked functions don't have prologues.
2240 return;
2241
John McCallcaa19452009-07-28 01:00:58 +00002242 // If this is an implicit-return-zero function, go ahead and
2243 // initialize the return value. TODO: it might be nice to have
2244 // a more general mechanism for this that didn't require synthesized
2245 // return statements.
John McCalldec348f72013-05-03 07:33:41 +00002246 if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(CurCodeDecl)) {
John McCallcaa19452009-07-28 01:00:58 +00002247 if (FD->hasImplicitReturnZero()) {
Alp Toker314cc812014-01-25 16:55:45 +00002248 QualType RetTy = FD->getReturnType().getUnqualifiedType();
Chris Lattner2192fe52011-07-18 04:24:23 +00002249 llvm::Type* LLVMTy = CGM.getTypes().ConvertType(RetTy);
Owen Anderson0b75f232009-07-31 20:28:54 +00002250 llvm::Constant* Zero = llvm::Constant::getNullValue(LLVMTy);
John McCallcaa19452009-07-28 01:00:58 +00002251 Builder.CreateStore(Zero, ReturnValue);
2252 }
2253 }
2254
Mike Stump18bb9282009-05-16 07:57:57 +00002255 // FIXME: We no longer need the types from FunctionArgList; lift up and
2256 // simplify.
Daniel Dunbar5a0acdc92009-02-03 06:02:10 +00002257
Alexey Samsonov153004f2014-09-29 22:08:00 +00002258 ClangToLLVMArgMapping IRFunctionArgs(CGM.getContext(), FI);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002259 // Flattened function arguments.
John McCall12f23522016-04-04 18:33:08 +00002260 SmallVector<llvm::Value *, 16> FnArgs;
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002261 FnArgs.reserve(IRFunctionArgs.totalIRArgs());
2262 for (auto &Arg : Fn->args()) {
2263 FnArgs.push_back(&Arg);
2264 }
2265 assert(FnArgs.size() == IRFunctionArgs.totalIRArgs());
Mike Stump11289f42009-09-09 15:08:12 +00002266
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002267 // If we're using inalloca, all the memory arguments are GEPs off of the last
2268 // parameter, which is a pointer to the complete memory area.
John McCall7f416cc2015-09-08 08:05:57 +00002269 Address ArgStruct = Address::invalid();
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002270 if (IRFunctionArgs.hasInallocaArg()) {
John McCall7f416cc2015-09-08 08:05:57 +00002271 ArgStruct = Address(FnArgs[IRFunctionArgs.getInallocaArgNo()],
2272 FI.getArgStructAlignment());
2273
2274 assert(ArgStruct.getType() == FI.getArgStruct()->getPointerTo());
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002275 }
2276
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002277 // Name the struct return parameter.
2278 if (IRFunctionArgs.hasSRetArg()) {
John McCall12f23522016-04-04 18:33:08 +00002279 auto AI = cast<llvm::Argument>(FnArgs[IRFunctionArgs.getSRetArgNo()]);
Daniel Dunbar613855c2008-09-09 23:27:19 +00002280 AI->setName("agg.result");
Reid Klecknercdd26792017-04-18 23:50:03 +00002281 AI->addAttr(llvm::Attribute::NoAlias);
Daniel Dunbar613855c2008-09-09 23:27:19 +00002282 }
Mike Stump11289f42009-09-09 15:08:12 +00002283
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002284 // Track if we received the parameter as a pointer (indirect, byval, or
2285 // inalloca). If already have a pointer, EmitParmDecl doesn't need to copy it
2286 // into a local alloca for us.
John McCall7f416cc2015-09-08 08:05:57 +00002287 SmallVector<ParamValue, 16> ArgVals;
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002288 ArgVals.reserve(Args.size());
2289
Reid Kleckner739756c2013-12-04 19:23:12 +00002290 // Create a pointer value for every parameter declaration. This usually
2291 // entails copying one or more LLVM IR arguments into an alloca. Don't push
2292 // any cleanups or do anything that might unwind. We do that separately, so
2293 // we can push the cleanups in the correct order for the ABI.
Daniel Dunbara45bdbb2009-02-04 21:17:21 +00002294 assert(FI.arg_size() == Args.size() &&
2295 "Mismatch between function signature & arguments.");
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002296 unsigned ArgNo = 0;
Daniel Dunbarb52d0772009-02-03 05:59:18 +00002297 CGFunctionInfo::const_arg_iterator info_it = FI.arg_begin();
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002298 for (FunctionArgList::const_iterator i = Args.begin(), e = Args.end();
Devang Patel68a15252011-03-03 20:13:15 +00002299 i != e; ++i, ++info_it, ++ArgNo) {
John McCalla738c252011-03-09 04:27:21 +00002300 const VarDecl *Arg = *i;
Daniel Dunbarb52d0772009-02-03 05:59:18 +00002301 const ABIArgInfo &ArgI = info_it->info;
Daniel Dunbard3674e62008-09-11 01:48:57 +00002302
John McCalla738c252011-03-09 04:27:21 +00002303 bool isPromoted =
2304 isa<ParmVarDecl>(Arg) && cast<ParmVarDecl>(Arg)->isKNRPromoted();
Volodymyr Sapsai17ebdb22018-01-22 22:29:24 +00002305 // We are converting from ABIArgInfo type to VarDecl type directly, unless
2306 // the parameter is promoted. In this case we convert to
2307 // CGFunctionInfo::ArgInfo type with subsequent argument demotion.
2308 QualType Ty = isPromoted ? info_it->type : Arg->getType();
2309 assert(hasScalarEvaluationKind(Ty) ==
2310 hasScalarEvaluationKind(Arg->getType()));
John McCalla738c252011-03-09 04:27:21 +00002311
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002312 unsigned FirstIRArg, NumIRArgs;
2313 std::tie(FirstIRArg, NumIRArgs) = IRFunctionArgs.getIRArgs(ArgNo);
Rafael Espindolafad28de2012-10-24 01:59:00 +00002314
Daniel Dunbard3674e62008-09-11 01:48:57 +00002315 switch (ArgI.getKind()) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002316 case ABIArgInfo::InAlloca: {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002317 assert(NumIRArgs == 0);
John McCall7f416cc2015-09-08 08:05:57 +00002318 auto FieldIndex = ArgI.getInAllocaFieldIndex();
James Y Knight751fe282019-02-09 22:22:28 +00002319 Address V =
2320 Builder.CreateStructGEP(ArgStruct, FieldIndex, Arg->getName());
John McCall7f416cc2015-09-08 08:05:57 +00002321 ArgVals.push_back(ParamValue::forIndirect(V));
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002322 break;
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002323 }
2324
Daniel Dunbar747865a2009-02-05 09:16:39 +00002325 case ABIArgInfo::Indirect: {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002326 assert(NumIRArgs == 1);
John McCall7f416cc2015-09-08 08:05:57 +00002327 Address ParamAddr = Address(FnArgs[FirstIRArg], ArgI.getIndirectAlign());
Daniel Dunbar7b7c2932010-09-16 20:42:02 +00002328
John McCall47fb9502013-03-07 21:37:08 +00002329 if (!hasScalarEvaluationKind(Ty)) {
Daniel Dunbar7b7c2932010-09-16 20:42:02 +00002330 // Aggregates and complex variables are accessed by reference. All we
John McCall7f416cc2015-09-08 08:05:57 +00002331 // need to do is realign the value, if requested.
2332 Address V = ParamAddr;
Daniel Dunbar7b7c2932010-09-16 20:42:02 +00002333 if (ArgI.getIndirectRealign()) {
John McCall7f416cc2015-09-08 08:05:57 +00002334 Address AlignedTemp = CreateMemTemp(Ty, "coerce");
Daniel Dunbar7b7c2932010-09-16 20:42:02 +00002335
2336 // Copy from the incoming argument pointer to the temporary with the
2337 // appropriate alignment.
2338 //
2339 // FIXME: We should have a common utility for generating an aggregate
2340 // copy.
Ken Dyck705ba072011-01-19 01:58:38 +00002341 CharUnits Size = getContext().getTypeSizeInChars(Ty);
John McCall7f416cc2015-09-08 08:05:57 +00002342 auto SizeVal = llvm::ConstantInt::get(IntPtrTy, Size.getQuantity());
2343 Address Dst = Builder.CreateBitCast(AlignedTemp, Int8PtrTy);
2344 Address Src = Builder.CreateBitCast(ParamAddr, Int8PtrTy);
2345 Builder.CreateMemCpy(Dst, Src, SizeVal, false);
Daniel Dunbar7b7c2932010-09-16 20:42:02 +00002346 V = AlignedTemp;
2347 }
John McCall7f416cc2015-09-08 08:05:57 +00002348 ArgVals.push_back(ParamValue::forIndirect(V));
Daniel Dunbar747865a2009-02-05 09:16:39 +00002349 } else {
2350 // Load scalar value from indirect argument.
John McCall7f416cc2015-09-08 08:05:57 +00002351 llvm::Value *V =
Stephen Kellyf2ceec42018-08-09 21:08:08 +00002352 EmitLoadOfScalar(ParamAddr, false, Ty, Arg->getBeginLoc());
John McCalla738c252011-03-09 04:27:21 +00002353
2354 if (isPromoted)
2355 V = emitArgumentDemotion(*this, Arg, V);
John McCall7f416cc2015-09-08 08:05:57 +00002356 ArgVals.push_back(ParamValue::forDirect(V));
Daniel Dunbar747865a2009-02-05 09:16:39 +00002357 }
Daniel Dunbar747865a2009-02-05 09:16:39 +00002358 break;
2359 }
Anton Korobeynikov18adbf52009-06-06 09:36:29 +00002360
2361 case ABIArgInfo::Extend:
Daniel Dunbar67dace892009-02-03 06:17:37 +00002362 case ABIArgInfo::Direct: {
Akira Hatanaka18334dd2012-01-09 19:08:06 +00002363
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002364 // If we have the trivial case, handle it with no muss and fuss.
2365 if (!isa<llvm::StructType>(ArgI.getCoerceToType()) &&
Volodymyr Sapsai22b00ec2017-12-21 20:52:59 +00002366 ArgI.getCoerceToType() == ConvertType(Ty) &&
Chris Lattner8a2f3c72010-07-30 04:02:24 +00002367 ArgI.getDirectOffset() == 0) {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002368 assert(NumIRArgs == 1);
John McCall12f23522016-04-04 18:33:08 +00002369 llvm::Value *V = FnArgs[FirstIRArg];
2370 auto AI = cast<llvm::Argument>(V);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002371
Hal Finkel48d53e22014-07-19 01:41:07 +00002372 if (const ParmVarDecl *PVD = dyn_cast<ParmVarDecl>(Arg)) {
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00002373 if (getNonNullAttr(CurCodeDecl, PVD, PVD->getType(),
Manoj Guptada08f6a2018-07-19 00:44:52 +00002374 PVD->getFunctionScopeIndex()) &&
2375 !CGM.getCodeGenOpts().NullPointerIsValid)
Reid Klecknercdd26792017-04-18 23:50:03 +00002376 AI->addAttr(llvm::Attribute::NonNull);
Hal Finkel82504f02014-07-11 17:35:21 +00002377
Hal Finkel48d53e22014-07-19 01:41:07 +00002378 QualType OTy = PVD->getOriginalType();
2379 if (const auto *ArrTy =
2380 getContext().getAsConstantArrayType(OTy)) {
2381 // A C99 array parameter declaration with the static keyword also
2382 // indicates dereferenceability, and if the size is constant we can
2383 // use the dereferenceable attribute (which requires the size in
2384 // bytes).
Hal Finkel16e394a2014-07-19 02:13:40 +00002385 if (ArrTy->getSizeModifier() == ArrayType::Static) {
Hal Finkel48d53e22014-07-19 01:41:07 +00002386 QualType ETy = ArrTy->getElementType();
2387 uint64_t ArrSize = ArrTy->getSize().getZExtValue();
2388 if (!ETy->isIncompleteType() && ETy->isConstantSizeType() &&
2389 ArrSize) {
2390 llvm::AttrBuilder Attrs;
2391 Attrs.addDereferenceableAttr(
2392 getContext().getTypeSizeInChars(ETy).getQuantity()*ArrSize);
Reid Kleckner9d16fa02017-04-19 17:28:52 +00002393 AI->addAttrs(Attrs);
Manoj Guptada08f6a2018-07-19 00:44:52 +00002394 } else if (getContext().getTargetAddressSpace(ETy) == 0 &&
2395 !CGM.getCodeGenOpts().NullPointerIsValid) {
Reid Klecknercdd26792017-04-18 23:50:03 +00002396 AI->addAttr(llvm::Attribute::NonNull);
Hal Finkel48d53e22014-07-19 01:41:07 +00002397 }
2398 }
2399 } else if (const auto *ArrTy =
2400 getContext().getAsVariableArrayType(OTy)) {
2401 // For C99 VLAs with the static keyword, we don't know the size so
2402 // we can't use the dereferenceable attribute, but in addrspace(0)
2403 // we know that it must be nonnull.
2404 if (ArrTy->getSizeModifier() == VariableArrayType::Static &&
Manoj Guptada08f6a2018-07-19 00:44:52 +00002405 !getContext().getTargetAddressSpace(ArrTy->getElementType()) &&
2406 !CGM.getCodeGenOpts().NullPointerIsValid)
Reid Klecknercdd26792017-04-18 23:50:03 +00002407 AI->addAttr(llvm::Attribute::NonNull);
Hal Finkel48d53e22014-07-19 01:41:07 +00002408 }
Hal Finkel1b0d24e2014-10-02 21:21:25 +00002409
2410 const auto *AVAttr = PVD->getAttr<AlignValueAttr>();
2411 if (!AVAttr)
2412 if (const auto *TOTy = dyn_cast<TypedefType>(OTy))
2413 AVAttr = TOTy->getDecl()->getAttr<AlignValueAttr>();
Roman Lebedevbd1c0872019-01-15 09:44:25 +00002414 if (AVAttr && !SanOpts.has(SanitizerKind::Alignment)) {
2415 // If alignment-assumption sanitizer is enabled, we do *not* add
2416 // alignment attribute here, but emit normal alignment assumption,
2417 // so the UBSAN check could function.
Hal Finkel1b0d24e2014-10-02 21:21:25 +00002418 llvm::Value *AlignmentValue =
2419 EmitScalarExpr(AVAttr->getAlignment());
2420 llvm::ConstantInt *AlignmentCI =
2421 cast<llvm::ConstantInt>(AlignmentValue);
Reid Kleckner9d16fa02017-04-19 17:28:52 +00002422 unsigned Alignment = std::min((unsigned)AlignmentCI->getZExtValue(),
2423 +llvm::Value::MaximumAlignment);
2424 AI->addAttrs(llvm::AttrBuilder().addAlignmentAttr(Alignment));
Hal Finkel1b0d24e2014-10-02 21:21:25 +00002425 }
Hal Finkel48d53e22014-07-19 01:41:07 +00002426 }
2427
Bill Wendling507c3512012-10-16 05:23:44 +00002428 if (Arg->getType().isRestrictQualified())
Reid Klecknercdd26792017-04-18 23:50:03 +00002429 AI->addAttr(llvm::Attribute::NoAlias);
John McCall39ec71f2010-03-27 00:47:27 +00002430
John McCall12f23522016-04-04 18:33:08 +00002431 // LLVM expects swifterror parameters to be used in very restricted
2432 // ways. Copy the value into a less-restricted temporary.
2433 if (FI.getExtParameterInfo(ArgNo).getABI()
2434 == ParameterABI::SwiftErrorResult) {
2435 QualType pointeeTy = Ty->getPointeeType();
2436 assert(pointeeTy->isPointerType());
2437 Address temp =
2438 CreateMemTemp(pointeeTy, getPointerAlign(), "swifterror.temp");
2439 Address arg = Address(V, getContext().getTypeAlignInChars(pointeeTy));
2440 llvm::Value *incomingErrorValue = Builder.CreateLoad(arg);
2441 Builder.CreateStore(incomingErrorValue, temp);
2442 V = temp.getPointer();
2443
2444 // Push a cleanup to copy the value back at the end of the function.
2445 // The convention does not guarantee that the value will be written
2446 // back if the function exits with an unwind exception.
2447 EHStack.pushCleanup<CopyBackSwiftError>(NormalCleanup, temp, arg);
2448 }
2449
Chris Lattner7369c142011-07-20 06:29:00 +00002450 // Ensure the argument is the correct type.
2451 if (V->getType() != ArgI.getCoerceToType())
2452 V = Builder.CreateBitCast(V, ArgI.getCoerceToType());
2453
John McCalla738c252011-03-09 04:27:21 +00002454 if (isPromoted)
2455 V = emitArgumentDemotion(*this, Arg, V);
Rafael Espindola8778c282012-11-29 16:09:03 +00002456
2457 // Because of merging of function types from multiple decls it is
2458 // possible for the type of an argument to not match the corresponding
2459 // type in the function type. Since we are codegening the callee
2460 // in here, add a cast to the argument type.
2461 llvm::Type *LTy = ConvertType(Arg->getType());
2462 if (V->getType() != LTy)
2463 V = Builder.CreateBitCast(V, LTy);
2464
John McCall7f416cc2015-09-08 08:05:57 +00002465 ArgVals.push_back(ParamValue::forDirect(V));
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002466 break;
Daniel Dunbard5f1f552009-02-10 00:06:49 +00002467 }
Mike Stump11289f42009-09-09 15:08:12 +00002468
Volodymyr Sapsai22b00ec2017-12-21 20:52:59 +00002469 Address Alloca = CreateMemTemp(Ty, getContext().getDeclAlign(Arg),
2470 Arg->getName());
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002471
John McCall7f416cc2015-09-08 08:05:57 +00002472 // Pointer to store into.
2473 Address Ptr = emitAddressAtOffset(*this, Alloca, ArgI);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002474
Oliver Stannard2bfdc5b2014-08-27 10:43:15 +00002475 // Fast-isel and the optimizer generally like scalar values better than
2476 // FCAs, so we flatten them if this is safe to do for this argument.
Evgeniy Stepanov3fae4ae2012-02-10 09:30:15 +00002477 llvm::StructType *STy = dyn_cast<llvm::StructType>(ArgI.getCoerceToType());
Oliver Stannard2bfdc5b2014-08-27 10:43:15 +00002478 if (ArgI.isDirect() && ArgI.getCanBeFlattened() && STy &&
2479 STy->getNumElements() > 1) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00002480 uint64_t SrcSize = CGM.getDataLayout().getTypeAllocSize(STy);
John McCall7f416cc2015-09-08 08:05:57 +00002481 llvm::Type *DstTy = Ptr.getElementType();
Micah Villmowdd31ca12012-10-08 16:25:52 +00002482 uint64_t DstSize = CGM.getDataLayout().getTypeAllocSize(DstTy);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002483
John McCall7f416cc2015-09-08 08:05:57 +00002484 Address AddrToStoreInto = Address::invalid();
Evgeniy Stepanov3fae4ae2012-02-10 09:30:15 +00002485 if (SrcSize <= DstSize) {
Yaxun Liue9e5c4f2017-06-29 18:47:45 +00002486 AddrToStoreInto = Builder.CreateElementBitCast(Ptr, STy);
Evgeniy Stepanov3fae4ae2012-02-10 09:30:15 +00002487 } else {
John McCall7f416cc2015-09-08 08:05:57 +00002488 AddrToStoreInto =
2489 CreateTempAlloca(STy, Alloca.getAlignment(), "coerce");
Chris Lattner15ec3612010-06-29 00:06:42 +00002490 }
John McCall7f416cc2015-09-08 08:05:57 +00002491
2492 assert(STy->getNumElements() == NumIRArgs);
2493 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
2494 auto AI = FnArgs[FirstIRArg + i];
2495 AI->setName(Arg->getName() + ".coerce" + Twine(i));
James Y Knight751fe282019-02-09 22:22:28 +00002496 Address EltPtr = Builder.CreateStructGEP(AddrToStoreInto, i);
John McCall7f416cc2015-09-08 08:05:57 +00002497 Builder.CreateStore(AI, EltPtr);
2498 }
2499
2500 if (SrcSize > DstSize) {
2501 Builder.CreateMemCpy(Ptr, AddrToStoreInto, DstSize);
2502 }
2503
Chris Lattner15ec3612010-06-29 00:06:42 +00002504 } else {
2505 // Simple case, just do a coerced store of the argument into the alloca.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002506 assert(NumIRArgs == 1);
2507 auto AI = FnArgs[FirstIRArg];
Chris Lattner9e748e92010-06-29 00:14:52 +00002508 AI->setName(Arg->getName() + ".coerce");
John McCall7f416cc2015-09-08 08:05:57 +00002509 CreateCoercedStore(AI, Ptr, /*DestIsVolatile=*/false, *this);
Chris Lattner15ec3612010-06-29 00:06:42 +00002510 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002511
Daniel Dunbar2f219b02009-02-03 19:12:28 +00002512 // Match to what EmitParmDecl is expecting for this type.
Volodymyr Sapsai22b00ec2017-12-21 20:52:59 +00002513 if (CodeGenFunction::hasScalarEvaluationKind(Ty)) {
John McCall7f416cc2015-09-08 08:05:57 +00002514 llvm::Value *V =
Stephen Kellyf2ceec42018-08-09 21:08:08 +00002515 EmitLoadOfScalar(Alloca, false, Ty, Arg->getBeginLoc());
John McCalla738c252011-03-09 04:27:21 +00002516 if (isPromoted)
2517 V = emitArgumentDemotion(*this, Arg, V);
John McCall7f416cc2015-09-08 08:05:57 +00002518 ArgVals.push_back(ParamValue::forDirect(V));
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002519 } else {
John McCall7f416cc2015-09-08 08:05:57 +00002520 ArgVals.push_back(ParamValue::forIndirect(Alloca));
Daniel Dunbar6e3b7df2009-02-04 07:22:24 +00002521 }
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002522 break;
Daniel Dunbar2f219b02009-02-03 19:12:28 +00002523 }
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002524
John McCallf26e73d2016-03-11 04:30:43 +00002525 case ABIArgInfo::CoerceAndExpand: {
2526 // Reconstruct into a temporary.
2527 Address alloca = CreateMemTemp(Ty, getContext().getDeclAlign(Arg));
2528 ArgVals.push_back(ParamValue::forIndirect(alloca));
2529
2530 auto coercionType = ArgI.getCoerceAndExpandType();
2531 alloca = Builder.CreateElementBitCast(alloca, coercionType);
John McCallf26e73d2016-03-11 04:30:43 +00002532
2533 unsigned argIndex = FirstIRArg;
2534 for (unsigned i = 0, e = coercionType->getNumElements(); i != e; ++i) {
2535 llvm::Type *eltType = coercionType->getElementType(i);
2536 if (ABIArgInfo::isPaddingForCoerceAndExpand(eltType))
2537 continue;
2538
James Y Knight751fe282019-02-09 22:22:28 +00002539 auto eltAddr = Builder.CreateStructGEP(alloca, i);
John McCallf26e73d2016-03-11 04:30:43 +00002540 auto elt = FnArgs[argIndex++];
2541 Builder.CreateStore(elt, eltAddr);
2542 }
2543 assert(argIndex == FirstIRArg + NumIRArgs);
2544 break;
2545 }
2546
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002547 case ABIArgInfo::Expand: {
2548 // If this structure was expanded into multiple arguments then
2549 // we need to create a temporary and reconstruct it from the
2550 // arguments.
John McCall7f416cc2015-09-08 08:05:57 +00002551 Address Alloca = CreateMemTemp(Ty, getContext().getDeclAlign(Arg));
2552 LValue LV = MakeAddrLValue(Alloca, Ty);
2553 ArgVals.push_back(ParamValue::forIndirect(Alloca));
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002554
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002555 auto FnArgIter = FnArgs.begin() + FirstIRArg;
2556 ExpandTypeFromArgs(Ty, LV, FnArgIter);
2557 assert(FnArgIter == FnArgs.begin() + FirstIRArg + NumIRArgs);
2558 for (unsigned i = 0, e = NumIRArgs; i != e; ++i) {
2559 auto AI = FnArgs[FirstIRArg + i];
2560 AI->setName(Arg->getName() + "." + Twine(i));
2561 }
2562 break;
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002563 }
2564
2565 case ABIArgInfo::Ignore:
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002566 assert(NumIRArgs == 0);
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002567 // Initialize the local variable appropriately.
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002568 if (!hasScalarEvaluationKind(Ty)) {
John McCall7f416cc2015-09-08 08:05:57 +00002569 ArgVals.push_back(ParamValue::forIndirect(CreateMemTemp(Ty)));
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002570 } else {
2571 llvm::Value *U = llvm::UndefValue::get(ConvertType(Arg->getType()));
John McCall7f416cc2015-09-08 08:05:57 +00002572 ArgVals.push_back(ParamValue::forDirect(U));
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002573 }
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002574 break;
Daniel Dunbard3674e62008-09-11 01:48:57 +00002575 }
Daniel Dunbar613855c2008-09-09 23:27:19 +00002576 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002577
Reid Kleckner739756c2013-12-04 19:23:12 +00002578 if (getTarget().getCXXABI().areArgsDestroyedLeftToRightInCallee()) {
2579 for (int I = Args.size() - 1; I >= 0; --I)
John McCall7f416cc2015-09-08 08:05:57 +00002580 EmitParmDecl(*Args[I], ArgVals[I], I + 1);
Reid Kleckner739756c2013-12-04 19:23:12 +00002581 } else {
2582 for (unsigned I = 0, E = Args.size(); I != E; ++I)
John McCall7f416cc2015-09-08 08:05:57 +00002583 EmitParmDecl(*Args[I], ArgVals[I], I + 1);
Reid Kleckner739756c2013-12-04 19:23:12 +00002584 }
Daniel Dunbar613855c2008-09-09 23:27:19 +00002585}
2586
John McCallffa2c1a2012-01-29 07:46:59 +00002587static void eraseUnusedBitCasts(llvm::Instruction *insn) {
2588 while (insn->use_empty()) {
2589 llvm::BitCastInst *bitcast = dyn_cast<llvm::BitCastInst>(insn);
2590 if (!bitcast) return;
2591
2592 // This is "safe" because we would have used a ConstantExpr otherwise.
2593 insn = cast<llvm::Instruction>(bitcast->getOperand(0));
2594 bitcast->eraseFromParent();
2595 }
2596}
2597
John McCall31168b02011-06-15 23:02:42 +00002598/// Try to emit a fused autorelease of a return result.
2599static llvm::Value *tryEmitFusedAutoreleaseOfResult(CodeGenFunction &CGF,
2600 llvm::Value *result) {
2601 // We must be immediately followed the cast.
2602 llvm::BasicBlock *BB = CGF.Builder.GetInsertBlock();
Craig Topper8a13c412014-05-21 05:09:00 +00002603 if (BB->empty()) return nullptr;
2604 if (&BB->back() != result) return nullptr;
John McCall31168b02011-06-15 23:02:42 +00002605
Chris Lattner2192fe52011-07-18 04:24:23 +00002606 llvm::Type *resultType = result->getType();
John McCall31168b02011-06-15 23:02:42 +00002607
2608 // result is in a BasicBlock and is therefore an Instruction.
2609 llvm::Instruction *generator = cast<llvm::Instruction>(result);
2610
Justin Bogner882f8612016-08-18 21:46:54 +00002611 SmallVector<llvm::Instruction *, 4> InstsToKill;
John McCall31168b02011-06-15 23:02:42 +00002612
2613 // Look for:
2614 // %generator = bitcast %type1* %generator2 to %type2*
2615 while (llvm::BitCastInst *bitcast = dyn_cast<llvm::BitCastInst>(generator)) {
2616 // We would have emitted this as a constant if the operand weren't
2617 // an Instruction.
2618 generator = cast<llvm::Instruction>(bitcast->getOperand(0));
2619
2620 // Require the generator to be immediately followed by the cast.
2621 if (generator->getNextNode() != bitcast)
Craig Topper8a13c412014-05-21 05:09:00 +00002622 return nullptr;
John McCall31168b02011-06-15 23:02:42 +00002623
Justin Bogner882f8612016-08-18 21:46:54 +00002624 InstsToKill.push_back(bitcast);
John McCall31168b02011-06-15 23:02:42 +00002625 }
2626
2627 // Look for:
2628 // %generator = call i8* @objc_retain(i8* %originalResult)
2629 // or
2630 // %generator = call i8* @objc_retainAutoreleasedReturnValue(i8* %originalResult)
2631 llvm::CallInst *call = dyn_cast<llvm::CallInst>(generator);
Craig Topper8a13c412014-05-21 05:09:00 +00002632 if (!call) return nullptr;
John McCall31168b02011-06-15 23:02:42 +00002633
2634 bool doRetainAutorelease;
2635
John McCallb04ecb72015-10-21 18:06:43 +00002636 if (call->getCalledValue() == CGF.CGM.getObjCEntrypoints().objc_retain) {
John McCall31168b02011-06-15 23:02:42 +00002637 doRetainAutorelease = true;
John McCallb04ecb72015-10-21 18:06:43 +00002638 } else if (call->getCalledValue() == CGF.CGM.getObjCEntrypoints()
John McCall31168b02011-06-15 23:02:42 +00002639 .objc_retainAutoreleasedReturnValue) {
2640 doRetainAutorelease = false;
2641
John McCallcfa4e9b2012-09-07 23:30:50 +00002642 // If we emitted an assembly marker for this call (and the
2643 // ARCEntrypoints field should have been set if so), go looking
2644 // for that call. If we can't find it, we can't do this
2645 // optimization. But it should always be the immediately previous
2646 // instruction, unless we needed bitcasts around the call.
John McCallb04ecb72015-10-21 18:06:43 +00002647 if (CGF.CGM.getObjCEntrypoints().retainAutoreleasedReturnValueMarker) {
John McCallcfa4e9b2012-09-07 23:30:50 +00002648 llvm::Instruction *prev = call->getPrevNode();
2649 assert(prev);
2650 if (isa<llvm::BitCastInst>(prev)) {
2651 prev = prev->getPrevNode();
2652 assert(prev);
2653 }
2654 assert(isa<llvm::CallInst>(prev));
2655 assert(cast<llvm::CallInst>(prev)->getCalledValue() ==
John McCallb04ecb72015-10-21 18:06:43 +00002656 CGF.CGM.getObjCEntrypoints().retainAutoreleasedReturnValueMarker);
Justin Bogner882f8612016-08-18 21:46:54 +00002657 InstsToKill.push_back(prev);
John McCallcfa4e9b2012-09-07 23:30:50 +00002658 }
John McCall31168b02011-06-15 23:02:42 +00002659 } else {
Craig Topper8a13c412014-05-21 05:09:00 +00002660 return nullptr;
John McCall31168b02011-06-15 23:02:42 +00002661 }
2662
2663 result = call->getArgOperand(0);
Justin Bogner882f8612016-08-18 21:46:54 +00002664 InstsToKill.push_back(call);
John McCall31168b02011-06-15 23:02:42 +00002665
2666 // Keep killing bitcasts, for sanity. Note that we no longer care
2667 // about precise ordering as long as there's exactly one use.
2668 while (llvm::BitCastInst *bitcast = dyn_cast<llvm::BitCastInst>(result)) {
2669 if (!bitcast->hasOneUse()) break;
Justin Bogner882f8612016-08-18 21:46:54 +00002670 InstsToKill.push_back(bitcast);
John McCall31168b02011-06-15 23:02:42 +00002671 result = bitcast->getOperand(0);
2672 }
2673
2674 // Delete all the unnecessary instructions, from latest to earliest.
Justin Bogner882f8612016-08-18 21:46:54 +00002675 for (auto *I : InstsToKill)
Saleem Abdulrasoolbe25c482016-08-18 21:40:06 +00002676 I->eraseFromParent();
John McCall31168b02011-06-15 23:02:42 +00002677
2678 // Do the fused retain/autorelease if we were asked to.
2679 if (doRetainAutorelease)
2680 result = CGF.EmitARCRetainAutoreleaseReturnValue(result);
2681
2682 // Cast back to the result type.
2683 return CGF.Builder.CreateBitCast(result, resultType);
2684}
2685
John McCallffa2c1a2012-01-29 07:46:59 +00002686/// If this is a +1 of the value of an immutable 'self', remove it.
2687static llvm::Value *tryRemoveRetainOfSelf(CodeGenFunction &CGF,
2688 llvm::Value *result) {
2689 // This is only applicable to a method with an immutable 'self'.
John McCallff755cd2012-07-31 00:33:55 +00002690 const ObjCMethodDecl *method =
2691 dyn_cast_or_null<ObjCMethodDecl>(CGF.CurCodeDecl);
Craig Topper8a13c412014-05-21 05:09:00 +00002692 if (!method) return nullptr;
John McCallffa2c1a2012-01-29 07:46:59 +00002693 const VarDecl *self = method->getSelfDecl();
Craig Topper8a13c412014-05-21 05:09:00 +00002694 if (!self->getType().isConstQualified()) return nullptr;
John McCallffa2c1a2012-01-29 07:46:59 +00002695
2696 // Look for a retain call.
2697 llvm::CallInst *retainCall =
2698 dyn_cast<llvm::CallInst>(result->stripPointerCasts());
2699 if (!retainCall ||
John McCallb04ecb72015-10-21 18:06:43 +00002700 retainCall->getCalledValue() != CGF.CGM.getObjCEntrypoints().objc_retain)
Craig Topper8a13c412014-05-21 05:09:00 +00002701 return nullptr;
John McCallffa2c1a2012-01-29 07:46:59 +00002702
2703 // Look for an ordinary load of 'self'.
2704 llvm::Value *retainedValue = retainCall->getArgOperand(0);
2705 llvm::LoadInst *load =
2706 dyn_cast<llvm::LoadInst>(retainedValue->stripPointerCasts());
Fangrui Song6907ce22018-07-30 19:24:48 +00002707 if (!load || load->isAtomic() || load->isVolatile() ||
John McCall7f416cc2015-09-08 08:05:57 +00002708 load->getPointerOperand() != CGF.GetAddrOfLocalVar(self).getPointer())
Craig Topper8a13c412014-05-21 05:09:00 +00002709 return nullptr;
John McCallffa2c1a2012-01-29 07:46:59 +00002710
2711 // Okay! Burn it all down. This relies for correctness on the
2712 // assumption that the retain is emitted as part of the return and
2713 // that thereafter everything is used "linearly".
2714 llvm::Type *resultType = result->getType();
2715 eraseUnusedBitCasts(cast<llvm::Instruction>(result));
2716 assert(retainCall->use_empty());
2717 retainCall->eraseFromParent();
2718 eraseUnusedBitCasts(cast<llvm::Instruction>(retainedValue));
2719
2720 return CGF.Builder.CreateBitCast(load, resultType);
2721}
2722
John McCall31168b02011-06-15 23:02:42 +00002723/// Emit an ARC autorelease of the result of a function.
John McCallffa2c1a2012-01-29 07:46:59 +00002724///
2725/// \return the value to actually return from the function
John McCall31168b02011-06-15 23:02:42 +00002726static llvm::Value *emitAutoreleaseOfResult(CodeGenFunction &CGF,
2727 llvm::Value *result) {
John McCallffa2c1a2012-01-29 07:46:59 +00002728 // If we're returning 'self', kill the initial retain. This is a
2729 // heuristic attempt to "encourage correctness" in the really unfortunate
2730 // case where we have a return of self during a dealloc and we desperately
2731 // need to avoid the possible autorelease.
2732 if (llvm::Value *self = tryRemoveRetainOfSelf(CGF, result))
2733 return self;
2734
John McCall31168b02011-06-15 23:02:42 +00002735 // At -O0, try to emit a fused retain/autorelease.
2736 if (CGF.shouldUseFusedARCCalls())
2737 if (llvm::Value *fused = tryEmitFusedAutoreleaseOfResult(CGF, result))
2738 return fused;
2739
2740 return CGF.EmitARCAutoreleaseReturnValue(result);
2741}
2742
John McCall6e1c0122012-01-29 02:35:02 +00002743/// Heuristically search for a dominating store to the return-value slot.
2744static llvm::StoreInst *findDominatingStoreToReturnValue(CodeGenFunction &CGF) {
Jakub Kuderskif50ab0f2015-09-08 10:36:42 +00002745 // Check if a User is a store which pointerOperand is the ReturnValue.
2746 // We are looking for stores to the ReturnValue, not for stores of the
2747 // ReturnValue to some other location.
2748 auto GetStoreIfValid = [&CGF](llvm::User *U) -> llvm::StoreInst * {
2749 auto *SI = dyn_cast<llvm::StoreInst>(U);
2750 if (!SI || SI->getPointerOperand() != CGF.ReturnValue.getPointer())
2751 return nullptr;
2752 // These aren't actually possible for non-coerced returns, and we
2753 // only care about non-coerced returns on this code path.
2754 assert(!SI->isAtomic() && !SI->isVolatile());
2755 return SI;
2756 };
John McCall6e1c0122012-01-29 02:35:02 +00002757 // If there are multiple uses of the return-value slot, just check
2758 // for something immediately preceding the IP. Sometimes this can
2759 // happen with how we generate implicit-returns; it can also happen
2760 // with noreturn cleanups.
John McCall7f416cc2015-09-08 08:05:57 +00002761 if (!CGF.ReturnValue.getPointer()->hasOneUse()) {
John McCall6e1c0122012-01-29 02:35:02 +00002762 llvm::BasicBlock *IP = CGF.Builder.GetInsertBlock();
Craig Topper8a13c412014-05-21 05:09:00 +00002763 if (IP->empty()) return nullptr;
David Majnemerdc012fa2015-04-22 21:38:15 +00002764 llvm::Instruction *I = &IP->back();
2765
2766 // Skip lifetime markers
2767 for (llvm::BasicBlock::reverse_iterator II = IP->rbegin(),
2768 IE = IP->rend();
2769 II != IE; ++II) {
2770 if (llvm::IntrinsicInst *Intrinsic =
2771 dyn_cast<llvm::IntrinsicInst>(&*II)) {
2772 if (Intrinsic->getIntrinsicID() == llvm::Intrinsic::lifetime_end) {
2773 const llvm::Value *CastAddr = Intrinsic->getArgOperand(1);
2774 ++II;
Alexey Samsonov10544202015-06-12 21:05:32 +00002775 if (II == IE)
2776 break;
2777 if (isa<llvm::BitCastInst>(&*II) && (CastAddr == &*II))
2778 continue;
David Majnemerdc012fa2015-04-22 21:38:15 +00002779 }
2780 }
2781 I = &*II;
2782 break;
2783 }
2784
Jakub Kuderskif50ab0f2015-09-08 10:36:42 +00002785 return GetStoreIfValid(I);
John McCall6e1c0122012-01-29 02:35:02 +00002786 }
2787
2788 llvm::StoreInst *store =
Jakub Kuderskif50ab0f2015-09-08 10:36:42 +00002789 GetStoreIfValid(CGF.ReturnValue.getPointer()->user_back());
Craig Topper8a13c412014-05-21 05:09:00 +00002790 if (!store) return nullptr;
John McCall6e1c0122012-01-29 02:35:02 +00002791
John McCall6e1c0122012-01-29 02:35:02 +00002792 // Now do a first-and-dirty dominance check: just walk up the
2793 // single-predecessors chain from the current insertion point.
2794 llvm::BasicBlock *StoreBB = store->getParent();
2795 llvm::BasicBlock *IP = CGF.Builder.GetInsertBlock();
2796 while (IP != StoreBB) {
2797 if (!(IP = IP->getSinglePredecessor()))
Craig Topper8a13c412014-05-21 05:09:00 +00002798 return nullptr;
John McCall6e1c0122012-01-29 02:35:02 +00002799 }
2800
2801 // Okay, the store's basic block dominates the insertion point; we
2802 // can do our thing.
2803 return store;
2804}
2805
Adrian Prantl3be10542013-05-02 17:30:20 +00002806void CodeGenFunction::EmitFunctionEpilog(const CGFunctionInfo &FI,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002807 bool EmitRetDbgLoc,
2808 SourceLocation EndLoc) {
Vedant Kumar09b5bfd2017-12-21 00:10:25 +00002809 if (FI.isNoReturn()) {
2810 // Noreturn functions don't return.
2811 EmitUnreachable(EndLoc);
2812 return;
2813 }
2814
Hans Wennborgd71907d2014-09-04 22:16:33 +00002815 if (CurCodeDecl && CurCodeDecl->hasAttr<NakedAttr>()) {
2816 // Naked functions don't have epilogues.
2817 Builder.CreateUnreachable();
2818 return;
2819 }
2820
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00002821 // Functions with no result always return void.
John McCall7f416cc2015-09-08 08:05:57 +00002822 if (!ReturnValue.isValid()) {
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00002823 Builder.CreateRetVoid();
Chris Lattner726b3d02010-06-26 23:13:19 +00002824 return;
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00002825 }
Daniel Dunbar6696e222010-06-30 21:27:58 +00002826
Dan Gohman481e40c2010-07-20 20:13:52 +00002827 llvm::DebugLoc RetDbgLoc;
Craig Topper8a13c412014-05-21 05:09:00 +00002828 llvm::Value *RV = nullptr;
Chris Lattner726b3d02010-06-26 23:13:19 +00002829 QualType RetTy = FI.getReturnType();
2830 const ABIArgInfo &RetAI = FI.getReturnInfo();
2831
2832 switch (RetAI.getKind()) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002833 case ABIArgInfo::InAlloca:
Reid Klecknerfab1e892014-02-25 00:59:14 +00002834 // Aggregrates get evaluated directly into the destination. Sometimes we
2835 // need to return the sret value in a register, though.
2836 assert(hasAggregateEvaluationKind(RetTy));
2837 if (RetAI.getInAllocaSRet()) {
2838 llvm::Function::arg_iterator EI = CurFn->arg_end();
2839 --EI;
Duncan P. N. Exon Smith9f5260a2015-11-06 23:00:41 +00002840 llvm::Value *ArgStruct = &*EI;
David Blaikie2e804282015-04-05 22:47:07 +00002841 llvm::Value *SRet = Builder.CreateStructGEP(
2842 nullptr, ArgStruct, RetAI.getInAllocaFieldIndex());
John McCall7f416cc2015-09-08 08:05:57 +00002843 RV = Builder.CreateAlignedLoad(SRet, getPointerAlign(), "sret");
Reid Klecknerfab1e892014-02-25 00:59:14 +00002844 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002845 break;
2846
Daniel Dunbar03816342010-08-21 02:24:36 +00002847 case ABIArgInfo::Indirect: {
Reid Kleckner37abaca2014-05-09 22:46:15 +00002848 auto AI = CurFn->arg_begin();
2849 if (RetAI.isSRetAfterThis())
2850 ++AI;
John McCall47fb9502013-03-07 21:37:08 +00002851 switch (getEvaluationKind(RetTy)) {
2852 case TEK_Complex: {
2853 ComplexPairTy RT =
John McCall7f416cc2015-09-08 08:05:57 +00002854 EmitLoadOfComplex(MakeAddrLValue(ReturnValue, RetTy), EndLoc);
Duncan P. N. Exon Smith9f5260a2015-11-06 23:00:41 +00002855 EmitStoreOfComplex(RT, MakeNaturalAlignAddrLValue(&*AI, RetTy),
John McCall47fb9502013-03-07 21:37:08 +00002856 /*isInit*/ true);
2857 break;
2858 }
2859 case TEK_Aggregate:
Chris Lattner726b3d02010-06-26 23:13:19 +00002860 // Do nothing; aggregrates get evaluated directly into the destination.
John McCall47fb9502013-03-07 21:37:08 +00002861 break;
2862 case TEK_Scalar:
2863 EmitStoreOfScalar(Builder.CreateLoad(ReturnValue),
Duncan P. N. Exon Smith9f5260a2015-11-06 23:00:41 +00002864 MakeNaturalAlignAddrLValue(&*AI, RetTy),
John McCall47fb9502013-03-07 21:37:08 +00002865 /*isInit*/ true);
2866 break;
Chris Lattner726b3d02010-06-26 23:13:19 +00002867 }
2868 break;
Daniel Dunbar03816342010-08-21 02:24:36 +00002869 }
Chris Lattner726b3d02010-06-26 23:13:19 +00002870
2871 case ABIArgInfo::Extend:
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002872 case ABIArgInfo::Direct:
Chris Lattner8a2f3c72010-07-30 04:02:24 +00002873 if (RetAI.getCoerceToType() == ConvertType(RetTy) &&
2874 RetAI.getDirectOffset() == 0) {
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002875 // The internal return value temp always will have pointer-to-return-type
2876 // type, just do a load.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002877
John McCall6e1c0122012-01-29 02:35:02 +00002878 // If there is a dominating store to ReturnValue, we can elide
2879 // the load, zap the store, and usually zap the alloca.
David Majnemerdc012fa2015-04-22 21:38:15 +00002880 if (llvm::StoreInst *SI =
2881 findDominatingStoreToReturnValue(*this)) {
Adrian Prantl4c9a38a2013-05-30 18:12:23 +00002882 // Reuse the debug location from the store unless there is
2883 // cleanup code to be emitted between the store and return
2884 // instruction.
2885 if (EmitRetDbgLoc && !AutoreleaseResult)
Adrian Prantl3be10542013-05-02 17:30:20 +00002886 RetDbgLoc = SI->getDebugLoc();
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002887 // Get the stored value and nuke the now-dead store.
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002888 RV = SI->getValueOperand();
2889 SI->eraseFromParent();
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002890
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002891 // If that was the only use of the return value, nuke it as well now.
John McCall7f416cc2015-09-08 08:05:57 +00002892 auto returnValueInst = ReturnValue.getPointer();
2893 if (returnValueInst->use_empty()) {
2894 if (auto alloca = dyn_cast<llvm::AllocaInst>(returnValueInst)) {
2895 alloca->eraseFromParent();
2896 ReturnValue = Address::invalid();
2897 }
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002898 }
John McCall6e1c0122012-01-29 02:35:02 +00002899
2900 // Otherwise, we have to do a simple load.
2901 } else {
2902 RV = Builder.CreateLoad(ReturnValue);
Chris Lattner3fcc7902010-06-27 01:06:27 +00002903 }
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002904 } else {
Chris Lattner8a2f3c72010-07-30 04:02:24 +00002905 // If the value is offset in memory, apply the offset now.
John McCall7f416cc2015-09-08 08:05:57 +00002906 Address V = emitAddressAtOffset(*this, ReturnValue, RetAI);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002907
John McCall7f416cc2015-09-08 08:05:57 +00002908 RV = CreateCoercedLoad(V, RetAI.getCoerceToType(), *this);
Chris Lattner3fcc7902010-06-27 01:06:27 +00002909 }
John McCall31168b02011-06-15 23:02:42 +00002910
2911 // In ARC, end functions that return a retainable type with a call
2912 // to objc_autoreleaseReturnValue.
2913 if (AutoreleaseResult) {
Akira Hatanaka9d8ac612016-02-17 21:09:50 +00002914#ifndef NDEBUG
2915 // Type::isObjCRetainabletype has to be called on a QualType that hasn't
2916 // been stripped of the typedefs, so we cannot use RetTy here. Get the
2917 // original return type of FunctionDecl, CurCodeDecl, and BlockDecl from
2918 // CurCodeDecl or BlockInfo.
2919 QualType RT;
2920
2921 if (auto *FD = dyn_cast<FunctionDecl>(CurCodeDecl))
2922 RT = FD->getReturnType();
2923 else if (auto *MD = dyn_cast<ObjCMethodDecl>(CurCodeDecl))
2924 RT = MD->getReturnType();
2925 else if (isa<BlockDecl>(CurCodeDecl))
2926 RT = BlockInfo->BlockExpression->getFunctionType()->getReturnType();
2927 else
2928 llvm_unreachable("Unexpected function/method type");
2929
David Blaikiebbafb8a2012-03-11 07:00:24 +00002930 assert(getLangOpts().ObjCAutoRefCount &&
John McCall31168b02011-06-15 23:02:42 +00002931 !FI.isReturnsRetained() &&
Akira Hatanaka9d8ac612016-02-17 21:09:50 +00002932 RT->isObjCRetainableType());
2933#endif
John McCall31168b02011-06-15 23:02:42 +00002934 RV = emitAutoreleaseOfResult(*this, RV);
2935 }
2936
Chris Lattner726b3d02010-06-26 23:13:19 +00002937 break;
Chris Lattner726b3d02010-06-26 23:13:19 +00002938
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002939 case ABIArgInfo::Ignore:
Chris Lattner726b3d02010-06-26 23:13:19 +00002940 break;
2941
John McCallf26e73d2016-03-11 04:30:43 +00002942 case ABIArgInfo::CoerceAndExpand: {
2943 auto coercionType = RetAI.getCoerceAndExpandType();
John McCallf26e73d2016-03-11 04:30:43 +00002944
2945 // Load all of the coerced elements out into results.
2946 llvm::SmallVector<llvm::Value*, 4> results;
2947 Address addr = Builder.CreateElementBitCast(ReturnValue, coercionType);
2948 for (unsigned i = 0, e = coercionType->getNumElements(); i != e; ++i) {
2949 auto coercedEltType = coercionType->getElementType(i);
2950 if (ABIArgInfo::isPaddingForCoerceAndExpand(coercedEltType))
2951 continue;
2952
James Y Knight751fe282019-02-09 22:22:28 +00002953 auto eltAddr = Builder.CreateStructGEP(addr, i);
John McCallf26e73d2016-03-11 04:30:43 +00002954 auto elt = Builder.CreateLoad(eltAddr);
2955 results.push_back(elt);
2956 }
2957
2958 // If we have one result, it's the single direct result type.
2959 if (results.size() == 1) {
2960 RV = results[0];
2961
2962 // Otherwise, we need to make a first-class aggregate.
2963 } else {
2964 // Construct a return type that lacks padding elements.
2965 llvm::Type *returnType = RetAI.getUnpaddedCoerceAndExpandType();
2966
2967 RV = llvm::UndefValue::get(returnType);
2968 for (unsigned i = 0, e = results.size(); i != e; ++i) {
2969 RV = Builder.CreateInsertValue(RV, results[i], i);
2970 }
2971 }
2972 break;
2973 }
2974
Chris Lattner726b3d02010-06-26 23:13:19 +00002975 case ABIArgInfo::Expand:
David Blaikie83d382b2011-09-23 05:06:16 +00002976 llvm_unreachable("Invalid ABI kind for return argument");
Chris Lattner726b3d02010-06-26 23:13:19 +00002977 }
2978
Alexey Samsonovde443c52014-08-13 00:26:40 +00002979 llvm::Instruction *Ret;
2980 if (RV) {
Vedant Kumarc34d3432017-06-23 21:32:38 +00002981 EmitReturnValueCheck(RV);
Alexey Samsonovde443c52014-08-13 00:26:40 +00002982 Ret = Builder.CreateRet(RV);
2983 } else {
2984 Ret = Builder.CreateRetVoid();
2985 }
2986
Duncan P. N. Exon Smith2809cc72015-03-30 20:01:41 +00002987 if (RetDbgLoc)
Benjamin Kramer03278662015-02-07 13:15:54 +00002988 Ret->setDebugLoc(std::move(RetDbgLoc));
Daniel Dunbar613855c2008-09-09 23:27:19 +00002989}
2990
Vedant Kumarc34d3432017-06-23 21:32:38 +00002991void CodeGenFunction::EmitReturnValueCheck(llvm::Value *RV) {
Vedant Kumar42c17ec2017-03-14 01:56:34 +00002992 // A current decl may not be available when emitting vtable thunks.
2993 if (!CurCodeDecl)
2994 return;
2995
2996 ReturnsNonNullAttr *RetNNAttr = nullptr;
2997 if (SanOpts.has(SanitizerKind::ReturnsNonnullAttribute))
2998 RetNNAttr = CurCodeDecl->getAttr<ReturnsNonNullAttr>();
2999
3000 if (!RetNNAttr && !requiresReturnValueNullabilityCheck())
3001 return;
3002
3003 // Prefer the returns_nonnull attribute if it's present.
3004 SourceLocation AttrLoc;
3005 SanitizerMask CheckKind;
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00003006 SanitizerHandler Handler;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003007 if (RetNNAttr) {
3008 assert(!requiresReturnValueNullabilityCheck() &&
3009 "Cannot check nullability and the nonnull attribute");
3010 AttrLoc = RetNNAttr->getLocation();
3011 CheckKind = SanitizerKind::ReturnsNonnullAttribute;
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00003012 Handler = SanitizerHandler::NonnullReturn;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003013 } else {
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003014 if (auto *DD = dyn_cast<DeclaratorDecl>(CurCodeDecl))
3015 if (auto *TSI = DD->getTypeSourceInfo())
3016 if (auto FTL = TSI->getTypeLoc().castAs<FunctionTypeLoc>())
3017 AttrLoc = FTL.getReturnLoc().findNullabilityLoc();
3018 CheckKind = SanitizerKind::NullabilityReturn;
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00003019 Handler = SanitizerHandler::NullabilityReturn;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003020 }
3021
3022 SanitizerScope SanScope(this);
3023
Vedant Kumarc34d3432017-06-23 21:32:38 +00003024 // Make sure the "return" source location is valid. If we're checking a
3025 // nullability annotation, make sure the preconditions for the check are met.
3026 llvm::BasicBlock *Check = createBasicBlock("nullcheck");
3027 llvm::BasicBlock *NoCheck = createBasicBlock("no.nullcheck");
3028 llvm::Value *SLocPtr = Builder.CreateLoad(ReturnLocation, "return.sloc.load");
3029 llvm::Value *CanNullCheck = Builder.CreateIsNotNull(SLocPtr);
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003030 if (requiresReturnValueNullabilityCheck())
Vedant Kumarc34d3432017-06-23 21:32:38 +00003031 CanNullCheck =
3032 Builder.CreateAnd(CanNullCheck, RetValNullabilityPrecondition);
3033 Builder.CreateCondBr(CanNullCheck, Check, NoCheck);
3034 EmitBlock(Check);
3035
3036 // Now do the null check.
3037 llvm::Value *Cond = Builder.CreateIsNotNull(RV);
3038 llvm::Constant *StaticData[] = {EmitCheckSourceLocation(AttrLoc)};
3039 llvm::Value *DynamicData[] = {SLocPtr};
3040 EmitCheck(std::make_pair(Cond, CheckKind), Handler, StaticData, DynamicData);
3041
3042 EmitBlock(NoCheck);
3043
3044#ifndef NDEBUG
3045 // The return location should not be used after the check has been emitted.
3046 ReturnLocation = Address::invalid();
3047#endif
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003048}
3049
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003050static bool isInAllocaArgument(CGCXXABI &ABI, QualType type) {
3051 const CXXRecordDecl *RD = type->getAsCXXRecordDecl();
3052 return RD && ABI.getRecordArgABI(RD) == CGCXXABI::RAA_DirectInMemory;
3053}
3054
John McCall7f416cc2015-09-08 08:05:57 +00003055static AggValueSlot createPlaceholderSlot(CodeGenFunction &CGF,
3056 QualType Ty) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003057 // FIXME: Generate IR in one pass, rather than going back and fixing up these
3058 // placeholders.
3059 llvm::Type *IRTy = CGF.ConvertTypeForMem(Ty);
Peter Collingbourneb367c562016-11-28 22:30:21 +00003060 llvm::Type *IRPtrTy = IRTy->getPointerTo();
3061 llvm::Value *Placeholder = llvm::UndefValue::get(IRPtrTy->getPointerTo());
John McCall7f416cc2015-09-08 08:05:57 +00003062
3063 // FIXME: When we generate this IR in one pass, we shouldn't need
3064 // this win32-specific alignment hack.
3065 CharUnits Align = CharUnits::fromQuantity(4);
Peter Collingbourneb367c562016-11-28 22:30:21 +00003066 Placeholder = CGF.Builder.CreateAlignedLoad(IRPtrTy, Placeholder, Align);
John McCall7f416cc2015-09-08 08:05:57 +00003067
3068 return AggValueSlot::forAddr(Address(Placeholder, Align),
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003069 Ty.getQualifiers(),
3070 AggValueSlot::IsNotDestructed,
3071 AggValueSlot::DoesNotNeedGCBarriers,
Richard Smithe78fac52018-04-05 20:52:58 +00003072 AggValueSlot::IsNotAliased,
3073 AggValueSlot::DoesNotOverlap);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003074}
3075
John McCall32ea9692011-03-11 20:59:21 +00003076void CodeGenFunction::EmitDelegateCallArg(CallArgList &args,
Nick Lewycky2d84e842013-10-02 02:29:49 +00003077 const VarDecl *param,
3078 SourceLocation loc) {
John McCall23f66262010-05-26 22:34:26 +00003079 // StartFunction converted the ABI-lowered parameter(s) into a
3080 // local alloca. We need to turn that into an r-value suitable
3081 // for EmitCall.
John McCall7f416cc2015-09-08 08:05:57 +00003082 Address local = GetAddrOfLocalVar(param);
John McCall23f66262010-05-26 22:34:26 +00003083
John McCall32ea9692011-03-11 20:59:21 +00003084 QualType type = param->getType();
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003085
Reid Kleckner25b56022018-12-12 23:46:06 +00003086 if (isInAllocaArgument(CGM.getCXXABI(), type)) {
3087 CGM.ErrorUnsupported(param, "forwarded non-trivially copyable parameter");
3088 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003089
John McCall811b2912016-11-18 01:08:24 +00003090 // GetAddrOfLocalVar returns a pointer-to-pointer for references,
3091 // but the argument needs to be the original pointer.
3092 if (type->isReferenceType()) {
3093 args.add(RValue::get(Builder.CreateLoad(local)), type);
3094
3095 // In ARC, move out of consumed arguments so that the release cleanup
3096 // entered by StartFunction doesn't cause an over-release. This isn't
3097 // optimal -O0 code generation, but it should get cleaned up when
3098 // optimization is enabled. This also assumes that delegate calls are
3099 // performed exactly once for a set of arguments, but that should be safe.
3100 } else if (getLangOpts().ObjCAutoRefCount &&
3101 param->hasAttr<NSConsumedAttr>() &&
3102 type->isObjCRetainableType()) {
3103 llvm::Value *ptr = Builder.CreateLoad(local);
3104 auto null =
3105 llvm::ConstantPointerNull::get(cast<llvm::PointerType>(ptr->getType()));
3106 Builder.CreateStore(null, local);
3107 args.add(RValue::get(ptr), type);
3108
Richard Smithd62d4982016-06-14 01:13:21 +00003109 // For the most part, we just need to load the alloca, except that
3110 // aggregate r-values are actually pointers to temporaries.
John McCall811b2912016-11-18 01:08:24 +00003111 } else {
Richard Smithd62d4982016-06-14 01:13:21 +00003112 args.add(convertTempToRValue(local, type, loc), type);
John McCall811b2912016-11-18 01:08:24 +00003113 }
Akira Hatanakaccda3d22018-04-27 06:57:00 +00003114
3115 // Deactivate the cleanup for the callee-destructed param that was pushed.
3116 if (hasAggregateEvaluationKind(type) && !CurFuncIsThunk &&
Akira Hatanaka85282972018-05-15 21:00:30 +00003117 type->getAs<RecordType>()->getDecl()->isParamDestroyedInCallee() &&
3118 type.isDestructedType()) {
Akira Hatanakaccda3d22018-04-27 06:57:00 +00003119 EHScopeStack::stable_iterator cleanup =
3120 CalleeDestructedParamCleanups.lookup(cast<ParmVarDecl>(param));
3121 assert(cleanup.isValid() &&
3122 "cleanup for callee-destructed param not recorded");
3123 // This unreachable is a temporary marker which will be removed later.
3124 llvm::Instruction *isActive = Builder.CreateUnreachable();
3125 args.addArgCleanupDeactivation(cleanup, isActive);
3126 }
John McCall23f66262010-05-26 22:34:26 +00003127}
3128
John McCall31168b02011-06-15 23:02:42 +00003129static bool isProvablyNull(llvm::Value *addr) {
3130 return isa<llvm::ConstantPointerNull>(addr);
3131}
3132
John McCall31168b02011-06-15 23:02:42 +00003133/// Emit the actual writing-back of a writeback.
3134static void emitWriteback(CodeGenFunction &CGF,
3135 const CallArgList::Writeback &writeback) {
John McCalleff18842013-03-23 02:35:54 +00003136 const LValue &srcLV = writeback.Source;
John McCall7f416cc2015-09-08 08:05:57 +00003137 Address srcAddr = srcLV.getAddress();
3138 assert(!isProvablyNull(srcAddr.getPointer()) &&
John McCall31168b02011-06-15 23:02:42 +00003139 "shouldn't have writeback for provably null argument");
3140
Craig Topper8a13c412014-05-21 05:09:00 +00003141 llvm::BasicBlock *contBB = nullptr;
John McCall31168b02011-06-15 23:02:42 +00003142
3143 // If the argument wasn't provably non-null, we need to null check
3144 // before doing the store.
Nuno Lopes9211cee2017-09-09 18:25:36 +00003145 bool provablyNonNull = llvm::isKnownNonZero(srcAddr.getPointer(),
3146 CGF.CGM.getDataLayout());
John McCall31168b02011-06-15 23:02:42 +00003147 if (!provablyNonNull) {
3148 llvm::BasicBlock *writebackBB = CGF.createBasicBlock("icr.writeback");
3149 contBB = CGF.createBasicBlock("icr.done");
3150
John McCall7f416cc2015-09-08 08:05:57 +00003151 llvm::Value *isNull =
3152 CGF.Builder.CreateIsNull(srcAddr.getPointer(), "icr.isnull");
John McCall31168b02011-06-15 23:02:42 +00003153 CGF.Builder.CreateCondBr(isNull, contBB, writebackBB);
3154 CGF.EmitBlock(writebackBB);
3155 }
3156
3157 // Load the value to writeback.
3158 llvm::Value *value = CGF.Builder.CreateLoad(writeback.Temporary);
3159
3160 // Cast it back, in case we're writing an id to a Foo* or something.
John McCall7f416cc2015-09-08 08:05:57 +00003161 value = CGF.Builder.CreateBitCast(value, srcAddr.getElementType(),
3162 "icr.writeback-cast");
Fangrui Song6907ce22018-07-30 19:24:48 +00003163
John McCall31168b02011-06-15 23:02:42 +00003164 // Perform the writeback.
John McCalleff18842013-03-23 02:35:54 +00003165
3166 // If we have a "to use" value, it's something we need to emit a use
3167 // of. This has to be carefully threaded in: if it's done after the
3168 // release it's potentially undefined behavior (and the optimizer
3169 // will ignore it), and if it happens before the retain then the
3170 // optimizer could move the release there.
3171 if (writeback.ToUse) {
3172 assert(srcLV.getObjCLifetime() == Qualifiers::OCL_Strong);
3173
3174 // Retain the new value. No need to block-copy here: the block's
3175 // being passed up the stack.
3176 value = CGF.EmitARCRetainNonBlock(value);
3177
3178 // Emit the intrinsic use here.
3179 CGF.EmitARCIntrinsicUse(writeback.ToUse);
3180
3181 // Load the old value (primitively).
Nick Lewycky2d84e842013-10-02 02:29:49 +00003182 llvm::Value *oldValue = CGF.EmitLoadOfScalar(srcLV, SourceLocation());
John McCalleff18842013-03-23 02:35:54 +00003183
3184 // Put the new value in place (primitively).
3185 CGF.EmitStoreOfScalar(value, srcLV, /*init*/ false);
3186
3187 // Release the old value.
3188 CGF.EmitARCRelease(oldValue, srcLV.isARCPreciseLifetime());
3189
3190 // Otherwise, we can just do a normal lvalue store.
3191 } else {
3192 CGF.EmitStoreThroughLValue(RValue::get(value), srcLV);
3193 }
John McCall31168b02011-06-15 23:02:42 +00003194
3195 // Jump to the continuation block.
3196 if (!provablyNonNull)
3197 CGF.EmitBlock(contBB);
3198}
3199
3200static void emitWritebacks(CodeGenFunction &CGF,
3201 const CallArgList &args) {
Aaron Ballman36a7fa82014-03-17 17:22:27 +00003202 for (const auto &I : args.writebacks())
3203 emitWriteback(CGF, I);
John McCall31168b02011-06-15 23:02:42 +00003204}
3205
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003206static void deactivateArgCleanupsBeforeCall(CodeGenFunction &CGF,
3207 const CallArgList &CallArgs) {
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003208 ArrayRef<CallArgList::CallArgCleanup> Cleanups =
3209 CallArgs.getCleanupsToDeactivate();
3210 // Iterate in reverse to increase the likelihood of popping the cleanup.
Pete Cooper57d3f142015-07-30 17:22:52 +00003211 for (const auto &I : llvm::reverse(Cleanups)) {
3212 CGF.DeactivateCleanupBlock(I.Cleanup, I.IsActiveIP);
3213 I.IsActiveIP->eraseFromParent();
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003214 }
3215}
3216
John McCalleff18842013-03-23 02:35:54 +00003217static const Expr *maybeGetUnaryAddrOfOperand(const Expr *E) {
3218 if (const UnaryOperator *uop = dyn_cast<UnaryOperator>(E->IgnoreParens()))
3219 if (uop->getOpcode() == UO_AddrOf)
3220 return uop->getSubExpr();
Craig Topper8a13c412014-05-21 05:09:00 +00003221 return nullptr;
John McCalleff18842013-03-23 02:35:54 +00003222}
3223
John McCall31168b02011-06-15 23:02:42 +00003224/// Emit an argument that's being passed call-by-writeback. That is,
John McCall7f416cc2015-09-08 08:05:57 +00003225/// we are passing the address of an __autoreleased temporary; it
3226/// might be copy-initialized with the current value of the given
3227/// address, but it will definitely be copied out of after the call.
John McCall31168b02011-06-15 23:02:42 +00003228static void emitWritebackArg(CodeGenFunction &CGF, CallArgList &args,
3229 const ObjCIndirectCopyRestoreExpr *CRE) {
John McCalleff18842013-03-23 02:35:54 +00003230 LValue srcLV;
3231
3232 // Make an optimistic effort to emit the address as an l-value.
Eric Christopher2c4555a2015-06-19 01:52:53 +00003233 // This can fail if the argument expression is more complicated.
John McCalleff18842013-03-23 02:35:54 +00003234 if (const Expr *lvExpr = maybeGetUnaryAddrOfOperand(CRE->getSubExpr())) {
3235 srcLV = CGF.EmitLValue(lvExpr);
3236
3237 // Otherwise, just emit it as a scalar.
3238 } else {
John McCall7f416cc2015-09-08 08:05:57 +00003239 Address srcAddr = CGF.EmitPointerWithAlignment(CRE->getSubExpr());
John McCalleff18842013-03-23 02:35:54 +00003240
3241 QualType srcAddrType =
3242 CRE->getSubExpr()->getType()->castAs<PointerType>()->getPointeeType();
John McCall7f416cc2015-09-08 08:05:57 +00003243 srcLV = CGF.MakeAddrLValue(srcAddr, srcAddrType);
John McCalleff18842013-03-23 02:35:54 +00003244 }
John McCall7f416cc2015-09-08 08:05:57 +00003245 Address srcAddr = srcLV.getAddress();
John McCall31168b02011-06-15 23:02:42 +00003246
3247 // The dest and src types don't necessarily match in LLVM terms
3248 // because of the crazy ObjC compatibility rules.
3249
Chris Lattner2192fe52011-07-18 04:24:23 +00003250 llvm::PointerType *destType =
John McCall31168b02011-06-15 23:02:42 +00003251 cast<llvm::PointerType>(CGF.ConvertType(CRE->getType()));
3252
3253 // If the address is a constant null, just pass the appropriate null.
John McCall7f416cc2015-09-08 08:05:57 +00003254 if (isProvablyNull(srcAddr.getPointer())) {
John McCall31168b02011-06-15 23:02:42 +00003255 args.add(RValue::get(llvm::ConstantPointerNull::get(destType)),
3256 CRE->getType());
3257 return;
3258 }
3259
John McCall31168b02011-06-15 23:02:42 +00003260 // Create the temporary.
John McCall7f416cc2015-09-08 08:05:57 +00003261 Address temp = CGF.CreateTempAlloca(destType->getElementType(),
3262 CGF.getPointerAlign(),
3263 "icr.temp");
Fariborz Jahanianfbd19742012-11-27 23:02:53 +00003264 // Loading an l-value can introduce a cleanup if the l-value is __weak,
3265 // and that cleanup will be conditional if we can't prove that the l-value
3266 // isn't null, so we need to register a dominating point so that the cleanups
3267 // system will make valid IR.
3268 CodeGenFunction::ConditionalEvaluation condEval(CGF);
Fangrui Song6907ce22018-07-30 19:24:48 +00003269
John McCall31168b02011-06-15 23:02:42 +00003270 // Zero-initialize it if we're not doing a copy-initialization.
3271 bool shouldCopy = CRE->shouldCopy();
3272 if (!shouldCopy) {
3273 llvm::Value *null =
3274 llvm::ConstantPointerNull::get(
3275 cast<llvm::PointerType>(destType->getElementType()));
3276 CGF.Builder.CreateStore(null, temp);
3277 }
Craig Topper8a13c412014-05-21 05:09:00 +00003278
3279 llvm::BasicBlock *contBB = nullptr;
3280 llvm::BasicBlock *originBB = nullptr;
John McCall31168b02011-06-15 23:02:42 +00003281
3282 // If the address is *not* known to be non-null, we need to switch.
3283 llvm::Value *finalArgument;
3284
Nuno Lopes9211cee2017-09-09 18:25:36 +00003285 bool provablyNonNull = llvm::isKnownNonZero(srcAddr.getPointer(),
3286 CGF.CGM.getDataLayout());
John McCall31168b02011-06-15 23:02:42 +00003287 if (provablyNonNull) {
John McCall7f416cc2015-09-08 08:05:57 +00003288 finalArgument = temp.getPointer();
John McCall31168b02011-06-15 23:02:42 +00003289 } else {
John McCall7f416cc2015-09-08 08:05:57 +00003290 llvm::Value *isNull =
3291 CGF.Builder.CreateIsNull(srcAddr.getPointer(), "icr.isnull");
John McCall31168b02011-06-15 23:02:42 +00003292
Fangrui Song6907ce22018-07-30 19:24:48 +00003293 finalArgument = CGF.Builder.CreateSelect(isNull,
John McCall31168b02011-06-15 23:02:42 +00003294 llvm::ConstantPointerNull::get(destType),
John McCall7f416cc2015-09-08 08:05:57 +00003295 temp.getPointer(), "icr.argument");
John McCall31168b02011-06-15 23:02:42 +00003296
3297 // If we need to copy, then the load has to be conditional, which
3298 // means we need control flow.
3299 if (shouldCopy) {
John McCalleff18842013-03-23 02:35:54 +00003300 originBB = CGF.Builder.GetInsertBlock();
John McCall31168b02011-06-15 23:02:42 +00003301 contBB = CGF.createBasicBlock("icr.cont");
3302 llvm::BasicBlock *copyBB = CGF.createBasicBlock("icr.copy");
3303 CGF.Builder.CreateCondBr(isNull, contBB, copyBB);
3304 CGF.EmitBlock(copyBB);
Fariborz Jahanianfbd19742012-11-27 23:02:53 +00003305 condEval.begin(CGF);
John McCall31168b02011-06-15 23:02:42 +00003306 }
3307 }
3308
Craig Topper8a13c412014-05-21 05:09:00 +00003309 llvm::Value *valueToUse = nullptr;
John McCalleff18842013-03-23 02:35:54 +00003310
John McCall31168b02011-06-15 23:02:42 +00003311 // Perform a copy if necessary.
3312 if (shouldCopy) {
Nick Lewycky2d84e842013-10-02 02:29:49 +00003313 RValue srcRV = CGF.EmitLoadOfLValue(srcLV, SourceLocation());
John McCall31168b02011-06-15 23:02:42 +00003314 assert(srcRV.isScalar());
3315
3316 llvm::Value *src = srcRV.getScalarVal();
3317 src = CGF.Builder.CreateBitCast(src, destType->getElementType(),
3318 "icr.cast");
3319
3320 // Use an ordinary store, not a store-to-lvalue.
3321 CGF.Builder.CreateStore(src, temp);
John McCalleff18842013-03-23 02:35:54 +00003322
3323 // If optimization is enabled, and the value was held in a
3324 // __strong variable, we need to tell the optimizer that this
3325 // value has to stay alive until we're doing the store back.
3326 // This is because the temporary is effectively unretained,
3327 // and so otherwise we can violate the high-level semantics.
3328 if (CGF.CGM.getCodeGenOpts().OptimizationLevel != 0 &&
3329 srcLV.getObjCLifetime() == Qualifiers::OCL_Strong) {
3330 valueToUse = src;
3331 }
John McCall31168b02011-06-15 23:02:42 +00003332 }
Fangrui Song6907ce22018-07-30 19:24:48 +00003333
John McCall31168b02011-06-15 23:02:42 +00003334 // Finish the control flow if we needed it.
Fariborz Jahanianfbd19742012-11-27 23:02:53 +00003335 if (shouldCopy && !provablyNonNull) {
John McCalleff18842013-03-23 02:35:54 +00003336 llvm::BasicBlock *copyBB = CGF.Builder.GetInsertBlock();
John McCall31168b02011-06-15 23:02:42 +00003337 CGF.EmitBlock(contBB);
John McCalleff18842013-03-23 02:35:54 +00003338
3339 // Make a phi for the value to intrinsically use.
3340 if (valueToUse) {
3341 llvm::PHINode *phiToUse = CGF.Builder.CreatePHI(valueToUse->getType(), 2,
3342 "icr.to-use");
3343 phiToUse->addIncoming(valueToUse, copyBB);
3344 phiToUse->addIncoming(llvm::UndefValue::get(valueToUse->getType()),
3345 originBB);
3346 valueToUse = phiToUse;
3347 }
3348
Fariborz Jahanianfbd19742012-11-27 23:02:53 +00003349 condEval.end(CGF);
3350 }
John McCall31168b02011-06-15 23:02:42 +00003351
John McCalleff18842013-03-23 02:35:54 +00003352 args.addWriteback(srcLV, temp, valueToUse);
John McCall31168b02011-06-15 23:02:42 +00003353 args.add(RValue::get(finalArgument), CRE->getType());
3354}
3355
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003356void CallArgList::allocateArgumentMemory(CodeGenFunction &CGF) {
Richard Smith762672a2016-09-28 19:09:10 +00003357 assert(!StackBase);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003358
3359 // Save the stack.
3360 llvm::Function *F = CGF.CGM.getIntrinsic(llvm::Intrinsic::stacksave);
David Blaikie43f9bb72015-05-18 22:14:03 +00003361 StackBase = CGF.Builder.CreateCall(F, {}, "inalloca.save");
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003362}
3363
Nico Weber8cdb3f92015-08-25 18:43:32 +00003364void CallArgList::freeArgumentMemory(CodeGenFunction &CGF) const {
3365 if (StackBase) {
Reid Kleckner7c2f9e82015-10-08 00:17:45 +00003366 // Restore the stack after the call.
James Y Knight8799cae2019-02-03 21:53:49 +00003367 llvm::Function *F = CGF.CGM.getIntrinsic(llvm::Intrinsic::stackrestore);
Nico Weber8cdb3f92015-08-25 18:43:32 +00003368 CGF.Builder.CreateCall(F, StackBase);
3369 }
3370}
3371
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003372void CodeGenFunction::EmitNonNullArgCheck(RValue RV, QualType ArgType,
3373 SourceLocation ArgLoc,
Vedant Kumared00ea02017-03-06 05:28:22 +00003374 AbstractCallee AC,
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003375 unsigned ParmNum) {
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003376 if (!AC.getDecl() || !(SanOpts.has(SanitizerKind::NonnullAttribute) ||
3377 SanOpts.has(SanitizerKind::NullabilityArg)))
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003378 return;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003379
3380 // The param decl may be missing in a variadic function.
Vedant Kumared00ea02017-03-06 05:28:22 +00003381 auto PVD = ParmNum < AC.getNumParams() ? AC.getParamDecl(ParmNum) : nullptr;
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003382 unsigned ArgNo = PVD ? PVD->getFunctionScopeIndex() : ParmNum;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003383
Fangrui Song6907ce22018-07-30 19:24:48 +00003384 // Prefer the nonnull attribute if it's present.
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003385 const NonNullAttr *NNAttr = nullptr;
3386 if (SanOpts.has(SanitizerKind::NonnullAttribute))
3387 NNAttr = getNonNullAttr(AC.getDecl(), PVD, ArgType, ArgNo);
3388
3389 bool CanCheckNullability = false;
3390 if (SanOpts.has(SanitizerKind::NullabilityArg) && !NNAttr && PVD) {
3391 auto Nullability = PVD->getType()->getNullability(getContext());
3392 CanCheckNullability = Nullability &&
3393 *Nullability == NullabilityKind::NonNull &&
3394 PVD->getTypeSourceInfo();
3395 }
3396
3397 if (!NNAttr && !CanCheckNullability)
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003398 return;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003399
3400 SourceLocation AttrLoc;
3401 SanitizerMask CheckKind;
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00003402 SanitizerHandler Handler;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003403 if (NNAttr) {
3404 AttrLoc = NNAttr->getLocation();
3405 CheckKind = SanitizerKind::NonnullAttribute;
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00003406 Handler = SanitizerHandler::NonnullArg;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003407 } else {
3408 AttrLoc = PVD->getTypeSourceInfo()->getTypeLoc().findNullabilityLoc();
3409 CheckKind = SanitizerKind::NullabilityArg;
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00003410 Handler = SanitizerHandler::NullabilityArg;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003411 }
3412
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003413 SanitizerScope SanScope(this);
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003414 assert(RV.isScalar());
3415 llvm::Value *V = RV.getScalarVal();
3416 llvm::Value *Cond =
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003417 Builder.CreateICmpNE(V, llvm::Constant::getNullValue(V->getType()));
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003418 llvm::Constant *StaticData[] = {
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003419 EmitCheckSourceLocation(ArgLoc), EmitCheckSourceLocation(AttrLoc),
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003420 llvm::ConstantInt::get(Int32Ty, ArgNo + 1),
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003421 };
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00003422 EmitCheck(std::make_pair(Cond, CheckKind), Handler, StaticData, None);
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003423}
3424
David Blaikief05779e2015-07-21 18:37:18 +00003425void CodeGenFunction::EmitCallArgs(
3426 CallArgList &Args, ArrayRef<QualType> ArgTypes,
3427 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Vedant Kumared00ea02017-03-06 05:28:22 +00003428 AbstractCallee AC, unsigned ParamsToSkip, EvaluationOrder Order) {
David Blaikief05779e2015-07-21 18:37:18 +00003429 assert((int)ArgTypes.size() == (ArgRange.end() - ArgRange.begin()));
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003430
Reid Kleckner739756c2013-12-04 19:23:12 +00003431 // We *have* to evaluate arguments from right to left in the MS C++ ABI,
Richard Smitha560ccf2016-09-29 21:30:12 +00003432 // because arguments are destroyed left to right in the callee. As a special
3433 // case, there are certain language constructs that require left-to-right
3434 // evaluation, and in those cases we consider the evaluation order requirement
3435 // to trump the "destruction order is reverse construction order" guarantee.
3436 bool LeftToRight =
3437 CGM.getTarget().getCXXABI().areArgsDestroyedLeftToRightInCallee()
3438 ? Order == EvaluationOrder::ForceLeftToRight
3439 : Order != EvaluationOrder::ForceRightToLeft;
3440
George Burgess IV0d6592a2017-02-23 05:59:56 +00003441 auto MaybeEmitImplicitObjectSize = [&](unsigned I, const Expr *Arg,
3442 RValue EmittedArg) {
Vedant Kumared00ea02017-03-06 05:28:22 +00003443 if (!AC.hasFunctionDecl() || I >= AC.getNumParams())
George Burgess IV0d6592a2017-02-23 05:59:56 +00003444 return;
Vedant Kumared00ea02017-03-06 05:28:22 +00003445 auto *PS = AC.getParamDecl(I)->getAttr<PassObjectSizeAttr>();
George Burgess IV0d6592a2017-02-23 05:59:56 +00003446 if (PS == nullptr)
3447 return;
3448
3449 const auto &Context = getContext();
3450 auto SizeTy = Context.getSizeType();
3451 auto T = Builder.getIntNTy(Context.getTypeSize(SizeTy));
3452 assert(EmittedArg.getScalarVal() && "We emitted nothing for the arg?");
3453 llvm::Value *V = evaluateOrEmitBuiltinObjectSize(Arg, PS->getType(), T,
Erik Pilkington9c3b5882019-01-30 20:34:53 +00003454 EmittedArg.getScalarVal(),
Erik Pilkington02d5fb12019-03-19 20:44:18 +00003455 PS->isDynamic());
George Burgess IV0d6592a2017-02-23 05:59:56 +00003456 Args.add(RValue::get(V), SizeTy);
3457 // If we're emitting args in reverse, be sure to do so with
3458 // pass_object_size, as well.
3459 if (!LeftToRight)
3460 std::swap(Args.back(), *(&Args.back() - 1));
3461 };
3462
Richard Smitha560ccf2016-09-29 21:30:12 +00003463 // Insert a stack save if we're going to need any inalloca args.
3464 bool HasInAllocaArgs = false;
3465 if (CGM.getTarget().getCXXABI().isMicrosoft()) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003466 for (ArrayRef<QualType>::iterator I = ArgTypes.begin(), E = ArgTypes.end();
3467 I != E && !HasInAllocaArgs; ++I)
3468 HasInAllocaArgs = isInAllocaArgument(CGM.getCXXABI(), *I);
3469 if (HasInAllocaArgs) {
3470 assert(getTarget().getTriple().getArch() == llvm::Triple::x86);
3471 Args.allocateArgumentMemory(*this);
3472 }
Richard Smitha560ccf2016-09-29 21:30:12 +00003473 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003474
Richard Smitha560ccf2016-09-29 21:30:12 +00003475 // Evaluate each argument in the appropriate order.
3476 size_t CallArgsStart = Args.size();
3477 for (unsigned I = 0, E = ArgTypes.size(); I != E; ++I) {
3478 unsigned Idx = LeftToRight ? I : E - I - 1;
3479 CallExpr::const_arg_iterator Arg = ArgRange.begin() + Idx;
George Burgess IV0d6592a2017-02-23 05:59:56 +00003480 unsigned InitialArgSize = Args.size();
Akira Hatanaka46dd7dbc2017-06-28 00:42:48 +00003481 // If *Arg is an ObjCIndirectCopyRestoreExpr, check that either the types of
3482 // the argument and parameter match or the objc method is parameterized.
3483 assert((!isa<ObjCIndirectCopyRestoreExpr>(*Arg) ||
3484 getContext().hasSameUnqualifiedType((*Arg)->getType(),
3485 ArgTypes[Idx]) ||
3486 (isa<ObjCMethodDecl>(AC.getDecl()) &&
3487 isObjCMethodWithTypeParams(cast<ObjCMethodDecl>(AC.getDecl())))) &&
3488 "Argument and parameter types don't match");
Richard Smitha560ccf2016-09-29 21:30:12 +00003489 EmitCallArg(Args, *Arg, ArgTypes[Idx]);
George Burgess IV0d6592a2017-02-23 05:59:56 +00003490 // In particular, we depend on it being the last arg in Args, and the
3491 // objectsize bits depend on there only being one arg if !LeftToRight.
3492 assert(InitialArgSize + 1 == Args.size() &&
3493 "The code below depends on only adding one arg per EmitCallArg");
3494 (void)InitialArgSize;
Yaxun Liu5b330e82018-03-15 15:25:19 +00003495 // Since pointer argument are never emitted as LValue, it is safe to emit
3496 // non-null argument check for r-value only.
3497 if (!Args.back().hasLValue()) {
3498 RValue RVArg = Args.back().getKnownRValue();
3499 EmitNonNullArgCheck(RVArg, ArgTypes[Idx], (*Arg)->getExprLoc(), AC,
3500 ParamsToSkip + Idx);
3501 // @llvm.objectsize should never have side-effects and shouldn't need
3502 // destruction/cleanups, so we can safely "emit" it after its arg,
3503 // regardless of right-to-leftness
3504 MaybeEmitImplicitObjectSize(Idx, *Arg, RVArg);
3505 }
Richard Smitha560ccf2016-09-29 21:30:12 +00003506 }
Reid Kleckner739756c2013-12-04 19:23:12 +00003507
Richard Smitha560ccf2016-09-29 21:30:12 +00003508 if (!LeftToRight) {
Reid Kleckner739756c2013-12-04 19:23:12 +00003509 // Un-reverse the arguments we just evaluated so they match up with the LLVM
3510 // IR function.
3511 std::reverse(Args.begin() + CallArgsStart, Args.end());
Reid Kleckner739756c2013-12-04 19:23:12 +00003512 }
3513}
3514
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003515namespace {
3516
David Blaikie7e70d682015-08-18 22:40:54 +00003517struct DestroyUnpassedArg final : EHScopeStack::Cleanup {
John McCall7f416cc2015-09-08 08:05:57 +00003518 DestroyUnpassedArg(Address Addr, QualType Ty)
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003519 : Addr(Addr), Ty(Ty) {}
3520
John McCall7f416cc2015-09-08 08:05:57 +00003521 Address Addr;
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003522 QualType Ty;
3523
Craig Topper4f12f102014-03-12 06:41:41 +00003524 void Emit(CodeGenFunction &CGF, Flags flags) override {
Akira Hatanaka7275da02018-02-28 07:15:55 +00003525 QualType::DestructionKind DtorKind = Ty.isDestructedType();
3526 if (DtorKind == QualType::DK_cxx_destructor) {
3527 const CXXDestructorDecl *Dtor = Ty->getAsCXXRecordDecl()->getDestructor();
3528 assert(!Dtor->isTrivial());
3529 CGF.EmitCXXDestructorCall(Dtor, Dtor_Complete, /*for vbase*/ false,
3530 /*Delegating=*/false, Addr);
3531 } else {
3532 CGF.callCStructDestructor(CGF.MakeAddrLValue(Addr, Ty));
3533 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003534 }
3535};
3536
David Blaikie38b25912015-02-09 19:13:51 +00003537struct DisableDebugLocationUpdates {
3538 CodeGenFunction &CGF;
3539 bool disabledDebugInfo;
3540 DisableDebugLocationUpdates(CodeGenFunction &CGF, const Expr *E) : CGF(CGF) {
3541 if ((disabledDebugInfo = isa<CXXDefaultArgExpr>(E) && CGF.getDebugInfo()))
3542 CGF.disableDebugInfo();
3543 }
3544 ~DisableDebugLocationUpdates() {
3545 if (disabledDebugInfo)
3546 CGF.enableDebugInfo();
3547 }
3548};
3549
Benjamin Kramer5b4296a2015-10-28 17:16:26 +00003550} // end anonymous namespace
3551
Yaxun Liu5b330e82018-03-15 15:25:19 +00003552RValue CallArg::getRValue(CodeGenFunction &CGF) const {
3553 if (!HasLV)
3554 return RV;
3555 LValue Copy = CGF.MakeAddrLValue(CGF.CreateMemTemp(Ty), Ty);
Richard Smithe78fac52018-04-05 20:52:58 +00003556 CGF.EmitAggregateCopy(Copy, LV, Ty, AggValueSlot::DoesNotOverlap,
3557 LV.isVolatile());
Yaxun Liu5b330e82018-03-15 15:25:19 +00003558 IsUsed = true;
3559 return RValue::getAggregate(Copy.getAddress());
3560}
3561
3562void CallArg::copyInto(CodeGenFunction &CGF, Address Addr) const {
3563 LValue Dst = CGF.MakeAddrLValue(Addr, Ty);
3564 if (!HasLV && RV.isScalar())
3565 CGF.EmitStoreOfScalar(RV.getScalarVal(), Dst, /*init=*/true);
3566 else if (!HasLV && RV.isComplex())
3567 CGF.EmitStoreOfComplex(RV.getComplexVal(), Dst, /*init=*/true);
3568 else {
3569 auto Addr = HasLV ? LV.getAddress() : RV.getAggregateAddress();
3570 LValue SrcLV = CGF.MakeAddrLValue(Addr, Ty);
Richard Smithe78fac52018-04-05 20:52:58 +00003571 // We assume that call args are never copied into subobjects.
3572 CGF.EmitAggregateCopy(Dst, SrcLV, Ty, AggValueSlot::DoesNotOverlap,
Yaxun Liu5b330e82018-03-15 15:25:19 +00003573 HasLV ? LV.isVolatileQualified()
3574 : RV.isVolatileQualified());
3575 }
3576 IsUsed = true;
3577}
3578
John McCall32ea9692011-03-11 20:59:21 +00003579void CodeGenFunction::EmitCallArg(CallArgList &args, const Expr *E,
3580 QualType type) {
David Blaikie38b25912015-02-09 19:13:51 +00003581 DisableDebugLocationUpdates Dis(*this, E);
John McCall31168b02011-06-15 23:02:42 +00003582 if (const ObjCIndirectCopyRestoreExpr *CRE
3583 = dyn_cast<ObjCIndirectCopyRestoreExpr>(E)) {
Richard Smith9c6890a2012-11-01 22:30:59 +00003584 assert(getLangOpts().ObjCAutoRefCount);
John McCall31168b02011-06-15 23:02:42 +00003585 return emitWritebackArg(*this, args, CRE);
3586 }
3587
John McCall0a76c0c2011-08-26 18:42:59 +00003588 assert(type->isReferenceType() == E->isGLValue() &&
3589 "reference binding to unmaterialized r-value!");
3590
John McCall17054bd62011-08-26 21:08:13 +00003591 if (E->isGLValue()) {
3592 assert(E->getObjectKind() == OK_Ordinary);
Richard Smitha1c9d4d2013-06-12 23:38:09 +00003593 return args.add(EmitReferenceBindingToExpr(E), type);
John McCall17054bd62011-08-26 21:08:13 +00003594 }
Mike Stump11289f42009-09-09 15:08:12 +00003595
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003596 bool HasAggregateEvalKind = hasAggregateEvaluationKind(type);
3597
3598 // In the Microsoft C++ ABI, aggregate arguments are destructed by the callee.
3599 // However, we still have to push an EH-only cleanup in case we unwind before
3600 // we make it to the call.
Akira Hatanaka85282972018-05-15 21:00:30 +00003601 if (HasAggregateEvalKind &&
3602 type->getAs<RecordType>()->getDecl()->isParamDestroyedInCallee()) {
Reid Klecknerac640602014-05-01 03:07:18 +00003603 // If we're using inalloca, use the argument memory. Otherwise, use a
Reid Klecknere39ee212014-05-03 00:33:28 +00003604 // temporary.
Reid Klecknerac640602014-05-01 03:07:18 +00003605 AggValueSlot Slot;
3606 if (args.isUsingInAlloca())
3607 Slot = createPlaceholderSlot(*this, type);
3608 else
3609 Slot = CreateAggTemp(type, "agg.tmp");
Reid Klecknere39ee212014-05-03 00:33:28 +00003610
Akira Hatanaka4ce0e5a2018-04-18 23:33:15 +00003611 bool DestroyedInCallee = true, NeedsEHCleanup = true;
3612 if (const auto *RD = type->getAsCXXRecordDecl())
3613 DestroyedInCallee = RD->hasNonTrivialDestructor();
3614 else
3615 NeedsEHCleanup = needsEHCleanup(type.isDestructedType());
3616
3617 if (DestroyedInCallee)
3618 Slot.setExternallyDestructed();
Reid Klecknere39ee212014-05-03 00:33:28 +00003619
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003620 EmitAggExpr(E, Slot);
3621 RValue RV = Slot.asRValue();
3622 args.add(RV, type);
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003623
Akira Hatanaka4ce0e5a2018-04-18 23:33:15 +00003624 if (DestroyedInCallee && NeedsEHCleanup) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003625 // Create a no-op GEP between the placeholder and the cleanup so we can
3626 // RAUW it successfully. It also serves as a marker of the first
3627 // instruction where the cleanup is active.
John McCall7f416cc2015-09-08 08:05:57 +00003628 pushFullExprCleanup<DestroyUnpassedArg>(EHCleanup, Slot.getAddress(),
3629 type);
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003630 // This unreachable is a temporary marker which will be removed later.
3631 llvm::Instruction *IsActive = Builder.CreateUnreachable();
3632 args.addArgCleanupDeactivation(EHStack.getInnermostEHScope(), IsActive);
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003633 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003634 return;
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003635 }
3636
3637 if (HasAggregateEvalKind && isa<ImplicitCastExpr>(E) &&
Eli Friedmandf968192011-05-26 00:10:27 +00003638 cast<CastExpr>(E)->getCastKind() == CK_LValueToRValue) {
3639 LValue L = EmitLValue(cast<CastExpr>(E)->getSubExpr());
3640 assert(L.isSimple());
Yaxun Liu5b330e82018-03-15 15:25:19 +00003641 args.addUncopiedAggregate(L, type);
Eli Friedmandf968192011-05-26 00:10:27 +00003642 return;
3643 }
3644
John McCall32ea9692011-03-11 20:59:21 +00003645 args.add(EmitAnyExprToTemp(E), type);
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00003646}
3647
Reid Kleckner79b0fd72014-10-10 00:05:45 +00003648QualType CodeGenFunction::getVarArgType(const Expr *Arg) {
3649 // System headers on Windows define NULL to 0 instead of 0LL on Win64. MSVC
3650 // implicitly widens null pointer constants that are arguments to varargs
3651 // functions to pointer-sized ints.
3652 if (!getTarget().getTriple().isOSWindows())
3653 return Arg->getType();
3654
3655 if (Arg->getType()->isIntegerType() &&
3656 getContext().getTypeSize(Arg->getType()) <
3657 getContext().getTargetInfo().getPointerWidth(0) &&
3658 Arg->isNullPointerConstant(getContext(),
3659 Expr::NPC_ValueDependentIsNotNull)) {
3660 return getContext().getIntPtrType();
3661 }
3662
3663 return Arg->getType();
3664}
3665
Dan Gohman515a60d2012-02-16 00:57:37 +00003666// In ObjC ARC mode with no ObjC ARC exception safety, tell the ARC
3667// optimizer it can aggressively ignore unwind edges.
3668void
3669CodeGenFunction::AddObjCARCExceptionMetadata(llvm::Instruction *Inst) {
3670 if (CGM.getCodeGenOpts().OptimizationLevel != 0 &&
3671 !CGM.getCodeGenOpts().ObjCAutoRefCountExceptions)
3672 Inst->setMetadata("clang.arc.no_objc_arc_exceptions",
3673 CGM.getNoObjCARCExceptionsMetadata());
3674}
3675
John McCall882987f2013-02-28 19:01:20 +00003676/// Emits a call to the given no-arguments nounwind runtime function.
3677llvm::CallInst *
James Y Knight9871db02019-02-05 16:42:33 +00003678CodeGenFunction::EmitNounwindRuntimeCall(llvm::FunctionCallee callee,
John McCall882987f2013-02-28 19:01:20 +00003679 const llvm::Twine &name) {
Craig Topper5fc8fc22014-08-27 06:28:36 +00003680 return EmitNounwindRuntimeCall(callee, None, name);
John McCall882987f2013-02-28 19:01:20 +00003681}
3682
3683/// Emits a call to the given nounwind runtime function.
3684llvm::CallInst *
James Y Knight9871db02019-02-05 16:42:33 +00003685CodeGenFunction::EmitNounwindRuntimeCall(llvm::FunctionCallee callee,
3686 ArrayRef<llvm::Value *> args,
John McCall882987f2013-02-28 19:01:20 +00003687 const llvm::Twine &name) {
3688 llvm::CallInst *call = EmitRuntimeCall(callee, args, name);
3689 call->setDoesNotThrow();
3690 return call;
3691}
3692
3693/// Emits a simple call (never an invoke) to the given no-arguments
3694/// runtime function.
James Y Knight9871db02019-02-05 16:42:33 +00003695llvm::CallInst *CodeGenFunction::EmitRuntimeCall(llvm::FunctionCallee callee,
3696 const llvm::Twine &name) {
Craig Topper5fc8fc22014-08-27 06:28:36 +00003697 return EmitRuntimeCall(callee, None, name);
John McCall882987f2013-02-28 19:01:20 +00003698}
3699
David Majnemer0b17d442015-12-15 21:27:59 +00003700// Calls which may throw must have operand bundles indicating which funclet
3701// they are nested within.
Reid Klecknerb75a3f02018-02-09 00:16:41 +00003702SmallVector<llvm::OperandBundleDef, 1>
3703CodeGenFunction::getBundlesForFunclet(llvm::Value *Callee) {
3704 SmallVector<llvm::OperandBundleDef, 1> BundleList;
Sanjay Patel846b63b2016-01-18 22:15:33 +00003705 // There is no need for a funclet operand bundle if we aren't inside a
3706 // funclet.
David Majnemer0b17d442015-12-15 21:27:59 +00003707 if (!CurrentFuncletPad)
Reid Klecknerb75a3f02018-02-09 00:16:41 +00003708 return BundleList;
David Majnemer0b17d442015-12-15 21:27:59 +00003709
3710 // Skip intrinsics which cannot throw.
3711 auto *CalleeFn = dyn_cast<llvm::Function>(Callee->stripPointerCasts());
3712 if (CalleeFn && CalleeFn->isIntrinsic() && CalleeFn->doesNotThrow())
Reid Klecknerb75a3f02018-02-09 00:16:41 +00003713 return BundleList;
David Majnemer0b17d442015-12-15 21:27:59 +00003714
3715 BundleList.emplace_back("funclet", CurrentFuncletPad);
Reid Klecknerb75a3f02018-02-09 00:16:41 +00003716 return BundleList;
David Majnemer0b17d442015-12-15 21:27:59 +00003717}
3718
David Majnemer971d31b2016-02-24 17:02:45 +00003719/// Emits a simple call (never an invoke) to the given runtime function.
James Y Knight9871db02019-02-05 16:42:33 +00003720llvm::CallInst *CodeGenFunction::EmitRuntimeCall(llvm::FunctionCallee callee,
3721 ArrayRef<llvm::Value *> args,
3722 const llvm::Twine &name) {
3723 llvm::CallInst *call = Builder.CreateCall(
3724 callee, args, getBundlesForFunclet(callee.getCallee()), name);
David Majnemer971d31b2016-02-24 17:02:45 +00003725 call->setCallingConv(getRuntimeCC());
3726 return call;
3727}
3728
John McCall882987f2013-02-28 19:01:20 +00003729/// Emits a call or invoke to the given noreturn runtime function.
James Y Knight9871db02019-02-05 16:42:33 +00003730void CodeGenFunction::EmitNoreturnRuntimeCallOrInvoke(
3731 llvm::FunctionCallee callee, ArrayRef<llvm::Value *> args) {
Reid Klecknerb75a3f02018-02-09 00:16:41 +00003732 SmallVector<llvm::OperandBundleDef, 1> BundleList =
James Y Knight9871db02019-02-05 16:42:33 +00003733 getBundlesForFunclet(callee.getCallee());
David Majnemer0b17d442015-12-15 21:27:59 +00003734
John McCall882987f2013-02-28 19:01:20 +00003735 if (getInvokeDest()) {
Fangrui Song6907ce22018-07-30 19:24:48 +00003736 llvm::InvokeInst *invoke =
John McCall882987f2013-02-28 19:01:20 +00003737 Builder.CreateInvoke(callee,
3738 getUnreachableBlock(),
3739 getInvokeDest(),
David Majnemer0b17d442015-12-15 21:27:59 +00003740 args,
3741 BundleList);
John McCall882987f2013-02-28 19:01:20 +00003742 invoke->setDoesNotReturn();
3743 invoke->setCallingConv(getRuntimeCC());
3744 } else {
David Majnemer0b17d442015-12-15 21:27:59 +00003745 llvm::CallInst *call = Builder.CreateCall(callee, args, BundleList);
John McCall882987f2013-02-28 19:01:20 +00003746 call->setDoesNotReturn();
3747 call->setCallingConv(getRuntimeCC());
3748 Builder.CreateUnreachable();
3749 }
3750}
3751
Sanjay Patel846b63b2016-01-18 22:15:33 +00003752/// Emits a call or invoke instruction to the given nullary runtime function.
James Y Knight9871db02019-02-05 16:42:33 +00003753llvm::CallBase *
3754CodeGenFunction::EmitRuntimeCallOrInvoke(llvm::FunctionCallee callee,
3755 const Twine &name) {
Craig Topper5fc8fc22014-08-27 06:28:36 +00003756 return EmitRuntimeCallOrInvoke(callee, None, name);
John McCall882987f2013-02-28 19:01:20 +00003757}
3758
3759/// Emits a call or invoke instruction to the given runtime function.
James Y Knight9871db02019-02-05 16:42:33 +00003760llvm::CallBase *
3761CodeGenFunction::EmitRuntimeCallOrInvoke(llvm::FunctionCallee callee,
3762 ArrayRef<llvm::Value *> args,
3763 const Twine &name) {
James Y Knight3933add2019-01-30 02:54:28 +00003764 llvm::CallBase *call = EmitCallOrInvoke(callee, args, name);
3765 call->setCallingConv(getRuntimeCC());
3766 return call;
John McCall882987f2013-02-28 19:01:20 +00003767}
3768
John McCallbd309292010-07-06 01:34:17 +00003769/// Emits a call or invoke instruction to the given function, depending
3770/// on the current state of the EH stack.
James Y Knight9871db02019-02-05 16:42:33 +00003771llvm::CallBase *CodeGenFunction::EmitCallOrInvoke(llvm::FunctionCallee Callee,
James Y Knight3933add2019-01-30 02:54:28 +00003772 ArrayRef<llvm::Value *> Args,
3773 const Twine &Name) {
John McCallbd309292010-07-06 01:34:17 +00003774 llvm::BasicBlock *InvokeDest = getInvokeDest();
Reid Klecknerb75a3f02018-02-09 00:16:41 +00003775 SmallVector<llvm::OperandBundleDef, 1> BundleList =
James Y Knight9871db02019-02-05 16:42:33 +00003776 getBundlesForFunclet(Callee.getCallee());
John McCallbd309292010-07-06 01:34:17 +00003777
James Y Knight3933add2019-01-30 02:54:28 +00003778 llvm::CallBase *Inst;
Dan Gohman515a60d2012-02-16 00:57:37 +00003779 if (!InvokeDest)
David Majnemer3df77bc2016-01-26 23:14:47 +00003780 Inst = Builder.CreateCall(Callee, Args, BundleList, Name);
Dan Gohman515a60d2012-02-16 00:57:37 +00003781 else {
3782 llvm::BasicBlock *ContBB = createBasicBlock("invoke.cont");
David Majnemer3df77bc2016-01-26 23:14:47 +00003783 Inst = Builder.CreateInvoke(Callee, ContBB, InvokeDest, Args, BundleList,
3784 Name);
Dan Gohman515a60d2012-02-16 00:57:37 +00003785 EmitBlock(ContBB);
3786 }
3787
3788 // In ObjC ARC mode with no ObjC ARC exception safety, tell the ARC
3789 // optimizer it can aggressively ignore unwind edges.
David Blaikiebbafb8a2012-03-11 07:00:24 +00003790 if (CGM.getLangOpts().ObjCAutoRefCount)
Dan Gohman515a60d2012-02-16 00:57:37 +00003791 AddObjCARCExceptionMetadata(Inst);
3792
James Y Knight3933add2019-01-30 02:54:28 +00003793 return Inst;
John McCallbd309292010-07-06 01:34:17 +00003794}
3795
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003796void CodeGenFunction::deferPlaceholderReplacement(llvm::Instruction *Old,
3797 llvm::Value *New) {
3798 DeferredReplacements.push_back(std::make_pair(Old, New));
3799}
Chris Lattnerd59d8672011-07-12 06:29:11 +00003800
Daniel Dunbard931a872009-02-02 22:03:45 +00003801RValue CodeGenFunction::EmitCall(const CGFunctionInfo &CallInfo,
John McCallb92ab1a2016-10-26 23:46:34 +00003802 const CGCallee &Callee,
Anders Carlsson61a401c2009-12-24 19:25:24 +00003803 ReturnValueSlot ReturnValue,
Daniel Dunbarcdbb5e32009-02-20 18:06:48 +00003804 const CallArgList &CallArgs,
James Y Knight3933add2019-01-30 02:54:28 +00003805 llvm::CallBase **callOrInvoke,
Vedant Kumar09b5bfd2017-12-21 00:10:25 +00003806 SourceLocation Loc) {
Mike Stump18bb9282009-05-16 07:57:57 +00003807 // FIXME: We no longer need the types from CallArgs; lift up and simplify.
Daniel Dunbar613855c2008-09-09 23:27:19 +00003808
Peter Collingbourneea211002018-02-05 23:09:13 +00003809 assert(Callee.isOrdinary() || Callee.isVirtual());
John McCallb92ab1a2016-10-26 23:46:34 +00003810
Daniel Dunbar613855c2008-09-09 23:27:19 +00003811 // Handle struct-return functions by passing a pointer to the
3812 // location that we would like to return into.
Daniel Dunbar7633cbf2009-02-02 21:43:58 +00003813 QualType RetTy = CallInfo.getReturnType();
Daniel Dunbarb52d0772009-02-03 05:59:18 +00003814 const ABIArgInfo &RetAI = CallInfo.getReturnInfo();
Mike Stump11289f42009-09-09 15:08:12 +00003815
James Y Knightcfe8cd72019-02-07 01:15:41 +00003816 llvm::FunctionType *IRFuncTy = getTypes().GetFunctionType(CallInfo);
John McCallb92ab1a2016-10-26 23:46:34 +00003817
James Y Knightb92d2902019-02-05 16:05:50 +00003818#ifndef NDEBUG
3819 if (!(CallInfo.isVariadic() && CallInfo.getArgStruct())) {
3820 // For an inalloca varargs function, we don't expect CallInfo to match the
3821 // function pointer's type, because the inalloca struct a will have extra
3822 // fields in it for the varargs parameters. Code later in this function
3823 // bitcasts the function pointer to the type derived from CallInfo.
3824 //
3825 // In other cases, we assert that the types match up (until pointers stop
3826 // having pointee types).
James Y Knightcfe8cd72019-02-07 01:15:41 +00003827 llvm::Type *TypeFromVal;
3828 if (Callee.isVirtual())
3829 TypeFromVal = Callee.getVirtualFunctionType();
3830 else
3831 TypeFromVal =
3832 Callee.getFunctionPointer()->getType()->getPointerElementType();
3833 assert(IRFuncTy == TypeFromVal);
James Y Knightb92d2902019-02-05 16:05:50 +00003834 }
3835#endif
3836
John McCallb92ab1a2016-10-26 23:46:34 +00003837 // 1. Set up the arguments.
Mike Stump11289f42009-09-09 15:08:12 +00003838
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003839 // If we're using inalloca, insert the allocation after the stack save.
3840 // FIXME: Do this earlier rather than hacking it in here!
John McCall7f416cc2015-09-08 08:05:57 +00003841 Address ArgMemory = Address::invalid();
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003842 if (llvm::StructType *ArgStruct = CallInfo.getArgStruct()) {
Matt Arsenault502ad602017-04-10 22:28:02 +00003843 const llvm::DataLayout &DL = CGM.getDataLayout();
Reid Kleckner9df1d972014-04-10 01:40:15 +00003844 llvm::Instruction *IP = CallArgs.getStackBase();
3845 llvm::AllocaInst *AI;
3846 if (IP) {
3847 IP = IP->getNextNode();
Matt Arsenault502ad602017-04-10 22:28:02 +00003848 AI = new llvm::AllocaInst(ArgStruct, DL.getAllocaAddrSpace(),
3849 "argmem", IP);
Reid Kleckner9df1d972014-04-10 01:40:15 +00003850 } else {
Reid Kleckner966abe72014-05-15 23:01:46 +00003851 AI = CreateTempAlloca(ArgStruct, "argmem");
Reid Kleckner9df1d972014-04-10 01:40:15 +00003852 }
John McCall7f416cc2015-09-08 08:05:57 +00003853 auto Align = CallInfo.getArgStructAlignment();
3854 AI->setAlignment(Align.getQuantity());
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003855 AI->setUsedWithInAlloca(true);
3856 assert(AI->isUsedWithInAlloca() && !AI->isStaticAlloca());
John McCall7f416cc2015-09-08 08:05:57 +00003857 ArgMemory = Address(AI, Align);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003858 }
3859
Alexey Samsonov153004f2014-09-29 22:08:00 +00003860 ClangToLLVMArgMapping IRFunctionArgs(CGM.getContext(), CallInfo);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003861 SmallVector<llvm::Value *, 16> IRCallArgs(IRFunctionArgs.totalIRArgs());
3862
Chris Lattner4ca97c32009-06-13 00:26:38 +00003863 // If the call returns a temporary with struct return, create a temporary
Anders Carlsson17490832009-12-24 20:40:36 +00003864 // alloca to hold the result, unless one is given to us.
John McCall7f416cc2015-09-08 08:05:57 +00003865 Address SRetPtr = Address::invalid();
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00003866 Address SRetAlloca = Address::invalid();
George Burgess IV003be7c2018-03-08 05:32:30 +00003867 llvm::Value *UnusedReturnSizePtr = nullptr;
John McCallf26e73d2016-03-11 04:30:43 +00003868 if (RetAI.isIndirect() || RetAI.isInAlloca() || RetAI.isCoerceAndExpand()) {
John McCall7f416cc2015-09-08 08:05:57 +00003869 if (!ReturnValue.isNull()) {
3870 SRetPtr = ReturnValue.getValue();
3871 } else {
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00003872 SRetPtr = CreateMemTemp(RetTy, "tmp", &SRetAlloca);
Leny Kholodov6aab1112015-06-08 10:23:49 +00003873 if (HaveInsertPoint() && ReturnValue.isUnused()) {
3874 uint64_t size =
3875 CGM.getDataLayout().getTypeAllocSize(ConvertTypeForMem(RetTy));
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00003876 UnusedReturnSizePtr = EmitLifetimeStart(size, SRetAlloca.getPointer());
Leny Kholodov6aab1112015-06-08 10:23:49 +00003877 }
3878 }
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003879 if (IRFunctionArgs.hasSRetArg()) {
John McCall7f416cc2015-09-08 08:05:57 +00003880 IRCallArgs[IRFunctionArgs.getSRetArgNo()] = SRetPtr.getPointer();
John McCallf26e73d2016-03-11 04:30:43 +00003881 } else if (RetAI.isInAlloca()) {
James Y Knight751fe282019-02-09 22:22:28 +00003882 Address Addr =
3883 Builder.CreateStructGEP(ArgMemory, RetAI.getInAllocaFieldIndex());
John McCall7f416cc2015-09-08 08:05:57 +00003884 Builder.CreateStore(SRetPtr.getPointer(), Addr);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003885 }
Anders Carlsson17490832009-12-24 20:40:36 +00003886 }
Mike Stump11289f42009-09-09 15:08:12 +00003887
John McCall12f23522016-04-04 18:33:08 +00003888 Address swiftErrorTemp = Address::invalid();
3889 Address swiftErrorArg = Address::invalid();
3890
John McCallb92ab1a2016-10-26 23:46:34 +00003891 // Translate all of the arguments as necessary to match the IR lowering.
Daniel Dunbara45bdbb2009-02-04 21:17:21 +00003892 assert(CallInfo.arg_size() == CallArgs.size() &&
3893 "Mismatch between function signature & arguments.");
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003894 unsigned ArgNo = 0;
Daniel Dunbarb52d0772009-02-03 05:59:18 +00003895 CGFunctionInfo::const_arg_iterator info_it = CallInfo.arg_begin();
Mike Stump11289f42009-09-09 15:08:12 +00003896 for (CallArgList::const_iterator I = CallArgs.begin(), E = CallArgs.end();
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003897 I != E; ++I, ++info_it, ++ArgNo) {
Daniel Dunbarb52d0772009-02-03 05:59:18 +00003898 const ABIArgInfo &ArgInfo = info_it->info;
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00003899
Rafael Espindolafad28de2012-10-24 01:59:00 +00003900 // Insert a padding argument to ensure proper alignment.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003901 if (IRFunctionArgs.hasPaddingArg(ArgNo))
3902 IRCallArgs[IRFunctionArgs.getPaddingArgNo(ArgNo)] =
3903 llvm::UndefValue::get(ArgInfo.getPaddingType());
3904
3905 unsigned FirstIRArg, NumIRArgs;
3906 std::tie(FirstIRArg, NumIRArgs) = IRFunctionArgs.getIRArgs(ArgNo);
Rafael Espindolafad28de2012-10-24 01:59:00 +00003907
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00003908 switch (ArgInfo.getKind()) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003909 case ABIArgInfo::InAlloca: {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003910 assert(NumIRArgs == 0);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003911 assert(getTarget().getTriple().getArch() == llvm::Triple::x86);
Yaxun Liu5b330e82018-03-15 15:25:19 +00003912 if (I->isAggregate()) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003913 // Replace the placeholder with the appropriate argument slot GEP.
Yaxun Liu5b330e82018-03-15 15:25:19 +00003914 Address Addr = I->hasLValue()
3915 ? I->getKnownLValue().getAddress()
3916 : I->getKnownRValue().getAggregateAddress();
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003917 llvm::Instruction *Placeholder =
Yaxun Liu5b330e82018-03-15 15:25:19 +00003918 cast<llvm::Instruction>(Addr.getPointer());
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003919 CGBuilderTy::InsertPoint IP = Builder.saveIP();
3920 Builder.SetInsertPoint(Placeholder);
James Y Knight751fe282019-02-09 22:22:28 +00003921 Addr =
3922 Builder.CreateStructGEP(ArgMemory, ArgInfo.getInAllocaFieldIndex());
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003923 Builder.restoreIP(IP);
John McCall7f416cc2015-09-08 08:05:57 +00003924 deferPlaceholderReplacement(Placeholder, Addr.getPointer());
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003925 } else {
3926 // Store the RValue into the argument struct.
James Y Knight751fe282019-02-09 22:22:28 +00003927 Address Addr =
3928 Builder.CreateStructGEP(ArgMemory, ArgInfo.getInAllocaFieldIndex());
John McCall7f416cc2015-09-08 08:05:57 +00003929 unsigned AS = Addr.getType()->getPointerAddressSpace();
David Majnemer32b57b02014-03-31 16:12:47 +00003930 llvm::Type *MemType = ConvertTypeForMem(I->Ty)->getPointerTo(AS);
3931 // There are some cases where a trivial bitcast is not avoidable. The
3932 // definition of a type later in a translation unit may change it's type
3933 // from {}* to (%struct.foo*)*.
John McCall7f416cc2015-09-08 08:05:57 +00003934 if (Addr.getType() != MemType)
David Majnemer32b57b02014-03-31 16:12:47 +00003935 Addr = Builder.CreateBitCast(Addr, MemType);
Yaxun Liu5b330e82018-03-15 15:25:19 +00003936 I->copyInto(*this, Addr);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003937 }
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003938 break;
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003939 }
3940
Daniel Dunbar03816342010-08-21 02:24:36 +00003941 case ABIArgInfo::Indirect: {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003942 assert(NumIRArgs == 1);
Yaxun Liu5b330e82018-03-15 15:25:19 +00003943 if (!I->isAggregate()) {
Daniel Dunbar747865a2009-02-05 09:16:39 +00003944 // Make a temporary alloca to pass the argument.
Yaxun Liuaefdb8e2018-06-15 15:33:22 +00003945 Address Addr = CreateMemTempWithoutCast(
3946 I->Ty, ArgInfo.getIndirectAlign(), "indirect-arg-temp");
John McCall7f416cc2015-09-08 08:05:57 +00003947 IRCallArgs[FirstIRArg] = Addr.getPointer();
John McCall47fb9502013-03-07 21:37:08 +00003948
Yaxun Liu5b330e82018-03-15 15:25:19 +00003949 I->copyInto(*this, Addr);
Daniel Dunbar747865a2009-02-05 09:16:39 +00003950 } else {
Eli Friedmaneb7fab62011-06-14 01:37:52 +00003951 // We want to avoid creating an unnecessary temporary+copy here;
Guy Benyei3832bfd2013-03-10 12:59:00 +00003952 // however, we need one in three cases:
Eli Friedmaneb7fab62011-06-14 01:37:52 +00003953 // 1. If the argument is not byval, and we are required to copy the
3954 // source. (This case doesn't occur on any common architecture.)
3955 // 2. If the argument is byval, RV is not sufficiently aligned, and
3956 // we cannot force it to be sufficiently aligned.
Yaxun Liu5b330e82018-03-15 15:25:19 +00003957 // 3. If the argument is byval, but RV is not located in default
3958 // or alloca address space.
3959 Address Addr = I->hasLValue()
3960 ? I->getKnownLValue().getAddress()
3961 : I->getKnownRValue().getAggregateAddress();
3962 llvm::Value *V = Addr.getPointer();
John McCall7f416cc2015-09-08 08:05:57 +00003963 CharUnits Align = ArgInfo.getIndirectAlign();
Micah Villmowdd31ca12012-10-08 16:25:52 +00003964 const llvm::DataLayout *TD = &CGM.getDataLayout();
Yaxun Liu5b330e82018-03-15 15:25:19 +00003965
3966 assert((FirstIRArg >= IRFuncTy->getNumParams() ||
3967 IRFuncTy->getParamType(FirstIRArg)->getPointerAddressSpace() ==
3968 TD->getAllocaAddrSpace()) &&
3969 "indirect argument must be in alloca address space");
3970
3971 bool NeedCopy = false;
3972
3973 if (Addr.getAlignment() < Align &&
3974 llvm::getOrEnforceKnownAlignment(V, Align.getQuantity(), *TD) <
3975 Align.getQuantity()) {
3976 NeedCopy = true;
3977 } else if (I->hasLValue()) {
3978 auto LV = I->getKnownLValue();
3979 auto AS = LV.getAddressSpace();
Andrew Savonichev1bf1a152018-12-10 12:03:00 +00003980
Yaxun Liu5b330e82018-03-15 15:25:19 +00003981 if ((!ArgInfo.getIndirectByVal() &&
3982 (LV.getAlignment() >=
Andrew Savonichev1bf1a152018-12-10 12:03:00 +00003983 getContext().getTypeAlignInChars(I->Ty)))) {
3984 NeedCopy = true;
3985 }
3986 if (!getLangOpts().OpenCL) {
3987 if ((ArgInfo.getIndirectByVal() &&
3988 (AS != LangAS::Default &&
3989 AS != CGM.getASTAllocaAddressSpace()))) {
3990 NeedCopy = true;
3991 }
3992 }
3993 // For OpenCL even if RV is located in default or alloca address space
3994 // we don't want to perform address space cast for it.
3995 else if ((ArgInfo.getIndirectByVal() &&
3996 Addr.getType()->getAddressSpace() != IRFuncTy->
3997 getParamType(FirstIRArg)->getPointerAddressSpace())) {
Yaxun Liu5b330e82018-03-15 15:25:19 +00003998 NeedCopy = true;
3999 }
4000 }
Andrew Savonichev1bf1a152018-12-10 12:03:00 +00004001
Yaxun Liu5b330e82018-03-15 15:25:19 +00004002 if (NeedCopy) {
Eli Friedmaneb7fab62011-06-14 01:37:52 +00004003 // Create an aligned temporary, and copy to it.
Yaxun Liuaefdb8e2018-06-15 15:33:22 +00004004 Address AI = CreateMemTempWithoutCast(
4005 I->Ty, ArgInfo.getIndirectAlign(), "byval-temp");
John McCall7f416cc2015-09-08 08:05:57 +00004006 IRCallArgs[FirstIRArg] = AI.getPointer();
Yaxun Liu5b330e82018-03-15 15:25:19 +00004007 I->copyInto(*this, AI);
Eli Friedmaneb7fab62011-06-14 01:37:52 +00004008 } else {
4009 // Skip the extra memcpy call.
Yaxun Liu5b330e82018-03-15 15:25:19 +00004010 auto *T = V->getType()->getPointerElementType()->getPointerTo(
4011 CGM.getDataLayout().getAllocaAddrSpace());
4012 IRCallArgs[FirstIRArg] = getTargetHooks().performAddrSpaceCast(
4013 *this, V, LangAS::Default, CGM.getASTAllocaAddressSpace(), T,
4014 true);
Eli Friedmaneb7fab62011-06-14 01:37:52 +00004015 }
Daniel Dunbar747865a2009-02-05 09:16:39 +00004016 }
4017 break;
Daniel Dunbar03816342010-08-21 02:24:36 +00004018 }
Daniel Dunbar747865a2009-02-05 09:16:39 +00004019
Daniel Dunbar94a6f252009-01-26 21:26:08 +00004020 case ABIArgInfo::Ignore:
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004021 assert(NumIRArgs == 0);
Daniel Dunbar94a6f252009-01-26 21:26:08 +00004022 break;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004023
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00004024 case ABIArgInfo::Extend:
4025 case ABIArgInfo::Direct: {
4026 if (!isa<llvm::StructType>(ArgInfo.getCoerceToType()) &&
Chris Lattner8a2f3c72010-07-30 04:02:24 +00004027 ArgInfo.getCoerceToType() == ConvertType(info_it->type) &&
4028 ArgInfo.getDirectOffset() == 0) {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004029 assert(NumIRArgs == 1);
Chris Lattnerbb1952c2011-07-12 04:46:18 +00004030 llvm::Value *V;
Yaxun Liu5b330e82018-03-15 15:25:19 +00004031 if (!I->isAggregate())
4032 V = I->getKnownRValue().getScalarVal();
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00004033 else
Yaxun Liu5b330e82018-03-15 15:25:19 +00004034 V = Builder.CreateLoad(
4035 I->hasLValue() ? I->getKnownLValue().getAddress()
4036 : I->getKnownRValue().getAggregateAddress());
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004037
John McCall12f23522016-04-04 18:33:08 +00004038 // Implement swifterror by copying into a new swifterror argument.
4039 // We'll write back in the normal path out of the call.
4040 if (CallInfo.getExtParameterInfo(ArgNo).getABI()
4041 == ParameterABI::SwiftErrorResult) {
4042 assert(!swiftErrorTemp.isValid() && "multiple swifterror args");
4043
4044 QualType pointeeTy = I->Ty->getPointeeType();
4045 swiftErrorArg =
4046 Address(V, getContext().getTypeAlignInChars(pointeeTy));
4047
4048 swiftErrorTemp =
4049 CreateMemTemp(pointeeTy, getPointerAlign(), "swifterror.temp");
4050 V = swiftErrorTemp.getPointer();
4051 cast<llvm::AllocaInst>(V)->setSwiftError(true);
4052
4053 llvm::Value *errorValue = Builder.CreateLoad(swiftErrorArg);
4054 Builder.CreateStore(errorValue, swiftErrorTemp);
4055 }
4056
Reid Kleckner79b0fd72014-10-10 00:05:45 +00004057 // We might have to widen integers, but we should never truncate.
4058 if (ArgInfo.getCoerceToType() != V->getType() &&
4059 V->getType()->isIntegerTy())
4060 V = Builder.CreateZExt(V, ArgInfo.getCoerceToType());
4061
Chris Lattner3ce86682011-07-12 04:53:39 +00004062 // If the argument doesn't match, perform a bitcast to coerce it. This
4063 // can happen due to trivial type mismatches.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004064 if (FirstIRArg < IRFuncTy->getNumParams() &&
4065 V->getType() != IRFuncTy->getParamType(FirstIRArg))
4066 V = Builder.CreateBitCast(V, IRFuncTy->getParamType(FirstIRArg));
John McCall12f23522016-04-04 18:33:08 +00004067
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004068 IRCallArgs[FirstIRArg] = V;
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00004069 break;
4070 }
Daniel Dunbar94a6f252009-01-26 21:26:08 +00004071
Daniel Dunbar2f219b02009-02-03 19:12:28 +00004072 // FIXME: Avoid the conversion through memory if possible.
John McCall7f416cc2015-09-08 08:05:57 +00004073 Address Src = Address::invalid();
Yaxun Liu5b330e82018-03-15 15:25:19 +00004074 if (!I->isAggregate()) {
John McCall7f416cc2015-09-08 08:05:57 +00004075 Src = CreateMemTemp(I->Ty, "coerce");
Yaxun Liu5b330e82018-03-15 15:25:19 +00004076 I->copyInto(*this, Src);
Ulrich Weigand6e2cea62015-07-10 11:31:43 +00004077 } else {
Yaxun Liu5b330e82018-03-15 15:25:19 +00004078 Src = I->hasLValue() ? I->getKnownLValue().getAddress()
4079 : I->getKnownRValue().getAggregateAddress();
Ulrich Weigand6e2cea62015-07-10 11:31:43 +00004080 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004081
Chris Lattner8a2f3c72010-07-30 04:02:24 +00004082 // If the value is offset in memory, apply the offset now.
John McCall7f416cc2015-09-08 08:05:57 +00004083 Src = emitAddressAtOffset(*this, Src, ArgInfo);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004084
Oliver Stannard2bfdc5b2014-08-27 10:43:15 +00004085 // Fast-isel and the optimizer generally like scalar values better than
4086 // FCAs, so we flatten them if this is safe to do for this argument.
James Molloy6f244b62014-05-09 16:21:39 +00004087 llvm::StructType *STy =
4088 dyn_cast<llvm::StructType>(ArgInfo.getCoerceToType());
Oliver Stannard2bfdc5b2014-08-27 10:43:15 +00004089 if (STy && ArgInfo.isDirect() && ArgInfo.getCanBeFlattened()) {
John McCall7f416cc2015-09-08 08:05:57 +00004090 llvm::Type *SrcTy = Src.getType()->getElementType();
Chandler Carrutha6399a52012-10-10 11:29:08 +00004091 uint64_t SrcSize = CGM.getDataLayout().getTypeAllocSize(SrcTy);
4092 uint64_t DstSize = CGM.getDataLayout().getTypeAllocSize(STy);
4093
4094 // If the source type is smaller than the destination type of the
4095 // coerce-to logic, copy the source value into a temp alloca the size
4096 // of the destination type to allow loading all of it. The bits past
4097 // the source value are left undef.
4098 if (SrcSize < DstSize) {
John McCall7f416cc2015-09-08 08:05:57 +00004099 Address TempAlloca
4100 = CreateTempAlloca(STy, Src.getAlignment(),
4101 Src.getName() + ".coerce");
4102 Builder.CreateMemCpy(TempAlloca, Src, SrcSize);
4103 Src = TempAlloca;
Chandler Carrutha6399a52012-10-10 11:29:08 +00004104 } else {
Matt Arsenault7a124f32017-08-01 20:36:57 +00004105 Src = Builder.CreateBitCast(Src,
4106 STy->getPointerTo(Src.getAddressSpace()));
Chandler Carrutha6399a52012-10-10 11:29:08 +00004107 }
4108
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004109 assert(NumIRArgs == STy->getNumElements());
Chris Lattnerceddafb2010-07-05 20:41:41 +00004110 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
James Y Knight751fe282019-02-09 22:22:28 +00004111 Address EltPtr = Builder.CreateStructGEP(Src, i);
John McCall7f416cc2015-09-08 08:05:57 +00004112 llvm::Value *LI = Builder.CreateLoad(EltPtr);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004113 IRCallArgs[FirstIRArg + i] = LI;
Chris Lattner15ec3612010-06-29 00:06:42 +00004114 }
Chris Lattner3dd716c2010-06-28 23:44:11 +00004115 } else {
Chris Lattner15ec3612010-06-29 00:06:42 +00004116 // In the simple case, just pass the coerced loaded value.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004117 assert(NumIRArgs == 1);
4118 IRCallArgs[FirstIRArg] =
John McCall7f416cc2015-09-08 08:05:57 +00004119 CreateCoercedLoad(Src, ArgInfo.getCoerceToType(), *this);
Chris Lattner3dd716c2010-06-28 23:44:11 +00004120 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004121
Daniel Dunbar2f219b02009-02-03 19:12:28 +00004122 break;
4123 }
4124
John McCallf26e73d2016-03-11 04:30:43 +00004125 case ABIArgInfo::CoerceAndExpand: {
John McCallf26e73d2016-03-11 04:30:43 +00004126 auto coercionType = ArgInfo.getCoerceAndExpandType();
4127 auto layout = CGM.getDataLayout().getStructLayout(coercionType);
4128
John McCall12f23522016-04-04 18:33:08 +00004129 llvm::Value *tempSize = nullptr;
4130 Address addr = Address::invalid();
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00004131 Address AllocaAddr = Address::invalid();
Yaxun Liu5b330e82018-03-15 15:25:19 +00004132 if (I->isAggregate()) {
4133 addr = I->hasLValue() ? I->getKnownLValue().getAddress()
4134 : I->getKnownRValue().getAggregateAddress();
4135
John McCall12f23522016-04-04 18:33:08 +00004136 } else {
Yaxun Liu5b330e82018-03-15 15:25:19 +00004137 RValue RV = I->getKnownRValue();
John McCall12f23522016-04-04 18:33:08 +00004138 assert(RV.isScalar()); // complex should always just be direct
4139
4140 llvm::Type *scalarType = RV.getScalarVal()->getType();
4141 auto scalarSize = CGM.getDataLayout().getTypeAllocSize(scalarType);
4142 auto scalarAlign = CGM.getDataLayout().getPrefTypeAlignment(scalarType);
4143
John McCall12f23522016-04-04 18:33:08 +00004144 // Materialize to a temporary.
4145 addr = CreateTempAlloca(RV.getScalarVal()->getType(),
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00004146 CharUnits::fromQuantity(std::max(
4147 layout->getAlignment(), scalarAlign)),
4148 "tmp",
4149 /*ArraySize=*/nullptr, &AllocaAddr);
4150 tempSize = EmitLifetimeStart(scalarSize, AllocaAddr.getPointer());
John McCall12f23522016-04-04 18:33:08 +00004151
4152 Builder.CreateStore(RV.getScalarVal(), addr);
4153 }
4154
John McCallf26e73d2016-03-11 04:30:43 +00004155 addr = Builder.CreateElementBitCast(addr, coercionType);
4156
4157 unsigned IRArgPos = FirstIRArg;
4158 for (unsigned i = 0, e = coercionType->getNumElements(); i != e; ++i) {
4159 llvm::Type *eltType = coercionType->getElementType(i);
4160 if (ABIArgInfo::isPaddingForCoerceAndExpand(eltType)) continue;
James Y Knight751fe282019-02-09 22:22:28 +00004161 Address eltAddr = Builder.CreateStructGEP(addr, i);
John McCallf26e73d2016-03-11 04:30:43 +00004162 llvm::Value *elt = Builder.CreateLoad(eltAddr);
4163 IRCallArgs[IRArgPos++] = elt;
4164 }
4165 assert(IRArgPos == FirstIRArg + NumIRArgs);
4166
John McCall12f23522016-04-04 18:33:08 +00004167 if (tempSize) {
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00004168 EmitLifetimeEnd(tempSize, AllocaAddr.getPointer());
John McCall12f23522016-04-04 18:33:08 +00004169 }
4170
John McCallf26e73d2016-03-11 04:30:43 +00004171 break;
4172 }
4173
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00004174 case ABIArgInfo::Expand:
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004175 unsigned IRArgPos = FirstIRArg;
Yaxun Liu5b330e82018-03-15 15:25:19 +00004176 ExpandTypeToArgs(I->Ty, *I, IRFuncTy, IRCallArgs, IRArgPos);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004177 assert(IRArgPos == FirstIRArg + NumIRArgs);
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00004178 break;
Daniel Dunbar613855c2008-09-09 23:27:19 +00004179 }
4180 }
Mike Stump11289f42009-09-09 15:08:12 +00004181
John McCall9831b842018-02-06 18:52:44 +00004182 const CGCallee &ConcreteCallee = Callee.prepareConcreteCallee(*this);
4183 llvm::Value *CalleePtr = ConcreteCallee.getFunctionPointer();
John McCallb92ab1a2016-10-26 23:46:34 +00004184
4185 // If we're using inalloca, set up that argument.
John McCall7f416cc2015-09-08 08:05:57 +00004186 if (ArgMemory.isValid()) {
4187 llvm::Value *Arg = ArgMemory.getPointer();
Reid Klecknerafba553e2014-07-08 02:24:27 +00004188 if (CallInfo.isVariadic()) {
4189 // When passing non-POD arguments by value to variadic functions, we will
4190 // end up with a variadic prototype and an inalloca call site. In such
4191 // cases, we can't do any parameter mismatch checks. Give up and bitcast
4192 // the callee.
John McCallb92ab1a2016-10-26 23:46:34 +00004193 unsigned CalleeAS = CalleePtr->getType()->getPointerAddressSpace();
James Y Knightcfe8cd72019-02-07 01:15:41 +00004194 CalleePtr =
4195 Builder.CreateBitCast(CalleePtr, IRFuncTy->getPointerTo(CalleeAS));
Reid Klecknerafba553e2014-07-08 02:24:27 +00004196 } else {
4197 llvm::Type *LastParamTy =
4198 IRFuncTy->getParamType(IRFuncTy->getNumParams() - 1);
4199 if (Arg->getType() != LastParamTy) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00004200#ifndef NDEBUG
Reid Klecknerafba553e2014-07-08 02:24:27 +00004201 // Assert that these structs have equivalent element types.
4202 llvm::StructType *FullTy = CallInfo.getArgStruct();
4203 llvm::StructType *DeclaredTy = cast<llvm::StructType>(
4204 cast<llvm::PointerType>(LastParamTy)->getElementType());
4205 assert(DeclaredTy->getNumElements() == FullTy->getNumElements());
4206 for (llvm::StructType::element_iterator DI = DeclaredTy->element_begin(),
4207 DE = DeclaredTy->element_end(),
4208 FI = FullTy->element_begin();
4209 DI != DE; ++DI, ++FI)
4210 assert(*DI == *FI);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00004211#endif
Reid Klecknerafba553e2014-07-08 02:24:27 +00004212 Arg = Builder.CreateBitCast(Arg, LastParamTy);
4213 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00004214 }
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004215 assert(IRFunctionArgs.hasInallocaArg());
4216 IRCallArgs[IRFunctionArgs.getInallocaArgNo()] = Arg;
Reid Kleckner314ef7b2014-02-01 00:04:45 +00004217 }
4218
John McCallb92ab1a2016-10-26 23:46:34 +00004219 // 2. Prepare the function pointer.
4220
4221 // If the callee is a bitcast of a non-variadic function to have a
4222 // variadic function pointer type, check to see if we can remove the
4223 // bitcast. This comes up with unprototyped functions.
4224 //
4225 // This makes the IR nicer, but more importantly it ensures that we
4226 // can inline the function at -O0 if it is marked always_inline.
James Y Knightcfe8cd72019-02-07 01:15:41 +00004227 auto simplifyVariadicCallee = [](llvm::FunctionType *CalleeFT,
4228 llvm::Value *Ptr) -> llvm::Function * {
John McCallb92ab1a2016-10-26 23:46:34 +00004229 if (!CalleeFT->isVarArg())
James Y Knightcfe8cd72019-02-07 01:15:41 +00004230 return nullptr;
John McCallb92ab1a2016-10-26 23:46:34 +00004231
James Y Knightcfe8cd72019-02-07 01:15:41 +00004232 // Get underlying value if it's a bitcast
4233 if (llvm::ConstantExpr *CE = dyn_cast<llvm::ConstantExpr>(Ptr)) {
4234 if (CE->getOpcode() == llvm::Instruction::BitCast)
4235 Ptr = CE->getOperand(0);
4236 }
John McCallb92ab1a2016-10-26 23:46:34 +00004237
James Y Knightcfe8cd72019-02-07 01:15:41 +00004238 llvm::Function *OrigFn = dyn_cast<llvm::Function>(Ptr);
John McCallb92ab1a2016-10-26 23:46:34 +00004239 if (!OrigFn)
James Y Knightcfe8cd72019-02-07 01:15:41 +00004240 return nullptr;
John McCallb92ab1a2016-10-26 23:46:34 +00004241
4242 llvm::FunctionType *OrigFT = OrigFn->getFunctionType();
4243
4244 // If the original type is variadic, or if any of the component types
4245 // disagree, we cannot remove the cast.
4246 if (OrigFT->isVarArg() ||
4247 OrigFT->getNumParams() != CalleeFT->getNumParams() ||
4248 OrigFT->getReturnType() != CalleeFT->getReturnType())
James Y Knightcfe8cd72019-02-07 01:15:41 +00004249 return nullptr;
John McCallb92ab1a2016-10-26 23:46:34 +00004250
4251 for (unsigned i = 0, e = OrigFT->getNumParams(); i != e; ++i)
4252 if (OrigFT->getParamType(i) != CalleeFT->getParamType(i))
James Y Knightcfe8cd72019-02-07 01:15:41 +00004253 return nullptr;
John McCallb92ab1a2016-10-26 23:46:34 +00004254
4255 return OrigFn;
4256 };
James Y Knightcfe8cd72019-02-07 01:15:41 +00004257
4258 if (llvm::Function *OrigFn = simplifyVariadicCallee(IRFuncTy, CalleePtr)) {
4259 CalleePtr = OrigFn;
4260 IRFuncTy = OrigFn->getFunctionType();
4261 }
John McCallb92ab1a2016-10-26 23:46:34 +00004262
4263 // 3. Perform the actual call.
4264
4265 // Deactivate any cleanups that we're supposed to do immediately before
4266 // the call.
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00004267 if (!CallArgs.getCleanupsToDeactivate().empty())
4268 deactivateArgCleanupsBeforeCall(*this, CallArgs);
4269
John McCallb92ab1a2016-10-26 23:46:34 +00004270 // Assert that the arguments we computed match up. The IR verifier
4271 // will catch this, but this is a common enough source of problems
4272 // during IRGen changes that it's way better for debugging to catch
4273 // it ourselves here.
4274#ifndef NDEBUG
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004275 assert(IRCallArgs.size() == IRFuncTy->getNumParams() || IRFuncTy->isVarArg());
4276 for (unsigned i = 0; i < IRCallArgs.size(); ++i) {
4277 // Inalloca argument can have different type.
4278 if (IRFunctionArgs.hasInallocaArg() &&
4279 i == IRFunctionArgs.getInallocaArgNo())
4280 continue;
4281 if (i < IRFuncTy->getNumParams())
4282 assert(IRCallArgs[i]->getType() == IRFuncTy->getParamType(i));
4283 }
John McCallb92ab1a2016-10-26 23:46:34 +00004284#endif
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004285
Craig Topper3113ec32018-10-24 17:42:17 +00004286 // Update the largest vector width if any arguments have vector types.
4287 for (unsigned i = 0; i < IRCallArgs.size(); ++i) {
4288 if (auto *VT = dyn_cast<llvm::VectorType>(IRCallArgs[i]->getType()))
4289 LargestVectorWidth = std::max(LargestVectorWidth,
4290 VT->getPrimitiveSizeInBits());
4291 }
4292
John McCallb92ab1a2016-10-26 23:46:34 +00004293 // Compute the calling convention and attributes.
Daniel Dunbar0ef34792009-09-12 00:59:20 +00004294 unsigned CallingConv;
Reid Klecknercdd26792017-04-18 23:50:03 +00004295 llvm::AttributeList Attrs;
John McCallb92ab1a2016-10-26 23:46:34 +00004296 CGM.ConstructAttributeList(CalleePtr->getName(), CallInfo,
Reid Klecknercdd26792017-04-18 23:50:03 +00004297 Callee.getAbstractInfo(), Attrs, CallingConv,
Chad Rosier7dbc9cf2016-01-06 14:35:46 +00004298 /*AttrOnCallSite=*/true);
Mike Stump11289f42009-09-09 15:08:12 +00004299
John McCallb92ab1a2016-10-26 23:46:34 +00004300 // Apply some call-site-specific attributes.
4301 // TODO: work this into building the attribute set.
4302
4303 // Apply always_inline to all calls within flatten functions.
4304 // FIXME: should this really take priority over __try, below?
4305 if (CurCodeDecl && CurCodeDecl->hasAttr<FlattenAttr>() &&
Erich Keanede6480a32018-11-13 15:48:08 +00004306 !(Callee.getAbstractInfo().getCalleeDecl().getDecl() &&
4307 Callee.getAbstractInfo()
4308 .getCalleeDecl()
4309 .getDecl()
4310 ->hasAttr<NoInlineAttr>())) {
John McCallb92ab1a2016-10-26 23:46:34 +00004311 Attrs =
Reid Klecknerde864822017-03-21 16:57:30 +00004312 Attrs.addAttribute(getLLVMContext(), llvm::AttributeList::FunctionIndex,
John McCallb92ab1a2016-10-26 23:46:34 +00004313 llvm::Attribute::AlwaysInline);
4314 }
4315
4316 // Disable inlining inside SEH __try blocks.
4317 if (isSEHTryScope()) {
4318 Attrs =
Reid Klecknerde864822017-03-21 16:57:30 +00004319 Attrs.addAttribute(getLLVMContext(), llvm::AttributeList::FunctionIndex,
John McCallb92ab1a2016-10-26 23:46:34 +00004320 llvm::Attribute::NoInline);
4321 }
4322
4323 // Decide whether to use a call or an invoke.
David Majnemer4e52d6f2015-12-12 05:39:21 +00004324 bool CannotThrow;
4325 if (currentFunctionUsesSEHTry()) {
John McCallb92ab1a2016-10-26 23:46:34 +00004326 // SEH cares about asynchronous exceptions, so everything can "throw."
David Majnemer4e52d6f2015-12-12 05:39:21 +00004327 CannotThrow = false;
4328 } else if (isCleanupPadScope() &&
4329 EHPersonality::get(*this).isMSVCXXPersonality()) {
4330 // The MSVC++ personality will implicitly terminate the program if an
John McCallb92ab1a2016-10-26 23:46:34 +00004331 // exception is thrown during a cleanup outside of a try/catch.
4332 // We don't need to model anything in IR to get this behavior.
David Majnemer4e52d6f2015-12-12 05:39:21 +00004333 CannotThrow = true;
4334 } else {
John McCallb92ab1a2016-10-26 23:46:34 +00004335 // Otherwise, nounwind call sites will never throw.
Reid Klecknerde864822017-03-21 16:57:30 +00004336 CannotThrow = Attrs.hasAttribute(llvm::AttributeList::FunctionIndex,
David Majnemer4e52d6f2015-12-12 05:39:21 +00004337 llvm::Attribute::NoUnwind);
4338 }
George Burgess IV003be7c2018-03-08 05:32:30 +00004339
4340 // If we made a temporary, be sure to clean up after ourselves. Note that we
4341 // can't depend on being inside of an ExprWithCleanups, so we need to manually
4342 // pop this cleanup later on. Being eager about this is OK, since this
4343 // temporary is 'invisible' outside of the callee.
4344 if (UnusedReturnSizePtr)
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00004345 pushFullExprCleanup<CallLifetimeEnd>(NormalEHLifetimeMarker, SRetAlloca,
George Burgess IV003be7c2018-03-08 05:32:30 +00004346 UnusedReturnSizePtr);
4347
David Majnemer4e52d6f2015-12-12 05:39:21 +00004348 llvm::BasicBlock *InvokeDest = CannotThrow ? nullptr : getInvokeDest();
John McCallbd309292010-07-06 01:34:17 +00004349
Reid Klecknerb75a3f02018-02-09 00:16:41 +00004350 SmallVector<llvm::OperandBundleDef, 1> BundleList =
4351 getBundlesForFunclet(CalleePtr);
David Majnemer0b17d442015-12-15 21:27:59 +00004352
John McCallb92ab1a2016-10-26 23:46:34 +00004353 // Emit the actual call/invoke instruction.
James Y Knight3933add2019-01-30 02:54:28 +00004354 llvm::CallBase *CI;
John McCallbd309292010-07-06 01:34:17 +00004355 if (!InvokeDest) {
James Y Knightcfe8cd72019-02-07 01:15:41 +00004356 CI = Builder.CreateCall(IRFuncTy, CalleePtr, IRCallArgs, BundleList);
Daniel Dunbar12347492009-02-23 17:26:39 +00004357 } else {
4358 llvm::BasicBlock *Cont = createBasicBlock("invoke.cont");
James Y Knightcfe8cd72019-02-07 01:15:41 +00004359 CI = Builder.CreateInvoke(IRFuncTy, CalleePtr, Cont, InvokeDest, IRCallArgs,
David Majnemer0b17d442015-12-15 21:27:59 +00004360 BundleList);
Daniel Dunbar12347492009-02-23 17:26:39 +00004361 EmitBlock(Cont);
Daniel Dunbar5006f4a2009-02-20 18:54:31 +00004362 }
Chris Lattnere70a0072010-06-29 16:40:28 +00004363 if (callOrInvoke)
John McCallb92ab1a2016-10-26 23:46:34 +00004364 *callOrInvoke = CI;
Daniel Dunbar5006f4a2009-02-20 18:54:31 +00004365
John McCallb92ab1a2016-10-26 23:46:34 +00004366 // Apply the attributes and calling convention.
James Y Knight3933add2019-01-30 02:54:28 +00004367 CI->setAttributes(Attrs);
4368 CI->setCallingConv(static_cast<llvm::CallingConv::ID>(CallingConv));
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004369
John McCallb92ab1a2016-10-26 23:46:34 +00004370 // Apply various metadata.
4371
4372 if (!CI->getType()->isVoidTy())
4373 CI->setName("call");
4374
Craig Topper3113ec32018-10-24 17:42:17 +00004375 // Update largest vector width from the return type.
4376 if (auto *VT = dyn_cast<llvm::VectorType>(CI->getType()))
4377 LargestVectorWidth = std::max(LargestVectorWidth,
4378 VT->getPrimitiveSizeInBits());
4379
Adam Nemet1e217bc2016-03-28 22:18:53 +00004380 // Insert instrumentation or attach profile metadata at indirect call sites.
4381 // For more details, see the comment before the definition of
4382 // IPVK_IndirectCallTarget in InstrProfData.inc.
James Y Knight3933add2019-01-30 02:54:28 +00004383 if (!CI->getCalledFunction())
Betul Buyukkurt518276a2016-01-23 22:50:44 +00004384 PGO.valueProfile(Builder, llvm::IPVK_IndirectCallTarget,
John McCallb92ab1a2016-10-26 23:46:34 +00004385 CI, CalleePtr);
Betul Buyukkurt518276a2016-01-23 22:50:44 +00004386
Dan Gohman515a60d2012-02-16 00:57:37 +00004387 // In ObjC ARC mode with no ObjC ARC exception safety, tell the ARC
4388 // optimizer it can aggressively ignore unwind edges.
David Blaikiebbafb8a2012-03-11 07:00:24 +00004389 if (CGM.getLangOpts().ObjCAutoRefCount)
John McCallb92ab1a2016-10-26 23:46:34 +00004390 AddObjCARCExceptionMetadata(CI);
4391
4392 // Suppress tail calls if requested.
4393 if (llvm::CallInst *Call = dyn_cast<llvm::CallInst>(CI)) {
Erich Keanede6480a32018-11-13 15:48:08 +00004394 const Decl *TargetDecl = Callee.getAbstractInfo().getCalleeDecl().getDecl();
John McCallb92ab1a2016-10-26 23:46:34 +00004395 if (TargetDecl && TargetDecl->hasAttr<NotTailCalledAttr>())
4396 Call->setTailCallKind(llvm::CallInst::TCK_NoTail);
4397 }
4398
4399 // 4. Finish the call.
Dan Gohman515a60d2012-02-16 00:57:37 +00004400
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004401 // If the call doesn't return, finish the basic block and clear the
John McCallb92ab1a2016-10-26 23:46:34 +00004402 // insertion point; this allows the rest of IRGen to discard
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004403 // unreachable code.
James Y Knight3933add2019-01-30 02:54:28 +00004404 if (CI->doesNotReturn()) {
George Burgess IV003be7c2018-03-08 05:32:30 +00004405 if (UnusedReturnSizePtr)
4406 PopCleanupBlock();
Leny Kholodov6aab1112015-06-08 10:23:49 +00004407
Julian Lettnerb62e9dc2019-01-24 18:04:21 +00004408 // Strip away the noreturn attribute to better diagnose unreachable UB.
Vedant Kumar09b5bfd2017-12-21 00:10:25 +00004409 if (SanOpts.has(SanitizerKind::Unreachable)) {
Julian Lettnerf82d8922019-02-02 02:05:16 +00004410 // Also remove from function since CallBase::hasFnAttr additionally checks
4411 // attributes of the called function.
James Y Knight3933add2019-01-30 02:54:28 +00004412 if (auto *F = CI->getCalledFunction())
Vedant Kumar09b5bfd2017-12-21 00:10:25 +00004413 F->removeFnAttr(llvm::Attribute::NoReturn);
James Y Knight3933add2019-01-30 02:54:28 +00004414 CI->removeAttribute(llvm::AttributeList::FunctionIndex,
4415 llvm::Attribute::NoReturn);
Julian Lettnerb6c06dc2019-02-01 02:51:00 +00004416
4417 // Avoid incompatibility with ASan which relies on the `noreturn`
4418 // attribute to insert handler calls.
Julian Lettner98b9f5b2019-02-04 23:37:50 +00004419 if (SanOpts.hasOneOf(SanitizerKind::Address |
4420 SanitizerKind::KernelAddress)) {
Julian Lettnerb6c06dc2019-02-01 02:51:00 +00004421 SanitizerScope SanScope(this);
4422 llvm::IRBuilder<>::InsertPointGuard IPGuard(Builder);
4423 Builder.SetInsertPoint(CI);
4424 auto *FnType = llvm::FunctionType::get(CGM.VoidTy, /*isVarArg=*/false);
James Y Knight9871db02019-02-05 16:42:33 +00004425 llvm::FunctionCallee Fn =
4426 CGM.CreateRuntimeFunction(FnType, "__asan_handle_no_return");
Julian Lettnerb6c06dc2019-02-01 02:51:00 +00004427 EmitNounwindRuntimeCall(Fn);
4428 }
Vedant Kumar09b5bfd2017-12-21 00:10:25 +00004429 }
4430
4431 EmitUnreachable(Loc);
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004432 Builder.ClearInsertionPoint();
Mike Stump11289f42009-09-09 15:08:12 +00004433
Mike Stump18bb9282009-05-16 07:57:57 +00004434 // FIXME: For now, emit a dummy basic block because expr emitters in
4435 // generally are not ready to handle emitting expressions at unreachable
4436 // points.
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004437 EnsureInsertPoint();
Mike Stump11289f42009-09-09 15:08:12 +00004438
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004439 // Return a reasonable RValue.
4440 return GetUndefRValue(RetTy);
Mike Stump11289f42009-09-09 15:08:12 +00004441 }
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004442
John McCall12f23522016-04-04 18:33:08 +00004443 // Perform the swifterror writeback.
4444 if (swiftErrorTemp.isValid()) {
4445 llvm::Value *errorResult = Builder.CreateLoad(swiftErrorTemp);
4446 Builder.CreateStore(errorResult, swiftErrorArg);
4447 }
4448
John McCallb92ab1a2016-10-26 23:46:34 +00004449 // Emit any call-associated writebacks immediately. Arguably this
4450 // should happen after any return-value munging.
John McCall31168b02011-06-15 23:02:42 +00004451 if (CallArgs.hasWritebacks())
4452 emitWritebacks(*this, CallArgs);
4453
Nico Weber8cdb3f92015-08-25 18:43:32 +00004454 // The stack cleanup for inalloca arguments has to run out of the normal
4455 // lexical order, so deactivate it and run it manually here.
4456 CallArgs.freeArgumentMemory(*this);
4457
John McCallb92ab1a2016-10-26 23:46:34 +00004458 // Extract the return value.
Hal Finkelee90a222014-09-26 05:04:30 +00004459 RValue Ret = [&] {
4460 switch (RetAI.getKind()) {
John McCallf26e73d2016-03-11 04:30:43 +00004461 case ABIArgInfo::CoerceAndExpand: {
4462 auto coercionType = RetAI.getCoerceAndExpandType();
John McCallf26e73d2016-03-11 04:30:43 +00004463
4464 Address addr = SRetPtr;
4465 addr = Builder.CreateElementBitCast(addr, coercionType);
4466
John McCall12f23522016-04-04 18:33:08 +00004467 assert(CI->getType() == RetAI.getUnpaddedCoerceAndExpandType());
4468 bool requiresExtract = isa<llvm::StructType>(CI->getType());
4469
John McCallf26e73d2016-03-11 04:30:43 +00004470 unsigned unpaddedIndex = 0;
4471 for (unsigned i = 0, e = coercionType->getNumElements(); i != e; ++i) {
4472 llvm::Type *eltType = coercionType->getElementType(i);
4473 if (ABIArgInfo::isPaddingForCoerceAndExpand(eltType)) continue;
James Y Knight751fe282019-02-09 22:22:28 +00004474 Address eltAddr = Builder.CreateStructGEP(addr, i);
John McCall12f23522016-04-04 18:33:08 +00004475 llvm::Value *elt = CI;
4476 if (requiresExtract)
4477 elt = Builder.CreateExtractValue(elt, unpaddedIndex++);
4478 else
4479 assert(unpaddedIndex == 0);
John McCallf26e73d2016-03-11 04:30:43 +00004480 Builder.CreateStore(elt, eltAddr);
4481 }
John McCall12f23522016-04-04 18:33:08 +00004482 // FALLTHROUGH
Galina Kistanova0872d6c2017-06-03 06:30:46 +00004483 LLVM_FALLTHROUGH;
John McCall12f23522016-04-04 18:33:08 +00004484 }
4485
4486 case ABIArgInfo::InAlloca:
4487 case ABIArgInfo::Indirect: {
4488 RValue ret = convertTempToRValue(SRetPtr, RetTy, SourceLocation());
George Burgess IV003be7c2018-03-08 05:32:30 +00004489 if (UnusedReturnSizePtr)
4490 PopCleanupBlock();
John McCall12f23522016-04-04 18:33:08 +00004491 return ret;
John McCallf26e73d2016-03-11 04:30:43 +00004492 }
4493
Hal Finkelee90a222014-09-26 05:04:30 +00004494 case ABIArgInfo::Ignore:
4495 // If we are ignoring an argument that had a result, make sure to
4496 // construct the appropriate return value for our caller.
4497 return GetUndefRValue(RetTy);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004498
Hal Finkelee90a222014-09-26 05:04:30 +00004499 case ABIArgInfo::Extend:
4500 case ABIArgInfo::Direct: {
4501 llvm::Type *RetIRTy = ConvertType(RetTy);
4502 if (RetAI.getCoerceToType() == RetIRTy && RetAI.getDirectOffset() == 0) {
4503 switch (getEvaluationKind(RetTy)) {
4504 case TEK_Complex: {
4505 llvm::Value *Real = Builder.CreateExtractValue(CI, 0);
4506 llvm::Value *Imag = Builder.CreateExtractValue(CI, 1);
4507 return RValue::getComplex(std::make_pair(Real, Imag));
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00004508 }
Hal Finkelee90a222014-09-26 05:04:30 +00004509 case TEK_Aggregate: {
John McCall7f416cc2015-09-08 08:05:57 +00004510 Address DestPtr = ReturnValue.getValue();
Hal Finkelee90a222014-09-26 05:04:30 +00004511 bool DestIsVolatile = ReturnValue.isVolatile();
4512
John McCall7f416cc2015-09-08 08:05:57 +00004513 if (!DestPtr.isValid()) {
Hal Finkelee90a222014-09-26 05:04:30 +00004514 DestPtr = CreateMemTemp(RetTy, "agg.tmp");
4515 DestIsVolatile = false;
4516 }
John McCall7f416cc2015-09-08 08:05:57 +00004517 BuildAggStore(*this, CI, DestPtr, DestIsVolatile);
Hal Finkelee90a222014-09-26 05:04:30 +00004518 return RValue::getAggregate(DestPtr);
4519 }
4520 case TEK_Scalar: {
4521 // If the argument doesn't match, perform a bitcast to coerce it. This
4522 // can happen due to trivial type mismatches.
4523 llvm::Value *V = CI;
4524 if (V->getType() != RetIRTy)
4525 V = Builder.CreateBitCast(V, RetIRTy);
4526 return RValue::get(V);
4527 }
4528 }
4529 llvm_unreachable("bad evaluation kind");
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00004530 }
Hal Finkelee90a222014-09-26 05:04:30 +00004531
John McCall7f416cc2015-09-08 08:05:57 +00004532 Address DestPtr = ReturnValue.getValue();
Hal Finkelee90a222014-09-26 05:04:30 +00004533 bool DestIsVolatile = ReturnValue.isVolatile();
4534
John McCall7f416cc2015-09-08 08:05:57 +00004535 if (!DestPtr.isValid()) {
Hal Finkelee90a222014-09-26 05:04:30 +00004536 DestPtr = CreateMemTemp(RetTy, "coerce");
4537 DestIsVolatile = false;
John McCall47fb9502013-03-07 21:37:08 +00004538 }
Hal Finkelee90a222014-09-26 05:04:30 +00004539
4540 // If the value is offset in memory, apply the offset now.
John McCall7f416cc2015-09-08 08:05:57 +00004541 Address StorePtr = emitAddressAtOffset(*this, DestPtr, RetAI);
4542 CreateCoercedStore(CI, StorePtr, DestIsVolatile, *this);
Hal Finkelee90a222014-09-26 05:04:30 +00004543
4544 return convertTempToRValue(DestPtr, RetTy, SourceLocation());
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00004545 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004546
Hal Finkelee90a222014-09-26 05:04:30 +00004547 case ABIArgInfo::Expand:
4548 llvm_unreachable("Invalid ABI kind for return argument");
Anders Carlsson17490832009-12-24 20:40:36 +00004549 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004550
Hal Finkelee90a222014-09-26 05:04:30 +00004551 llvm_unreachable("Unhandled ABIArgInfo::Kind");
4552 } ();
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004553
John McCallb92ab1a2016-10-26 23:46:34 +00004554 // Emit the assume_aligned check on the return value.
Erich Keanede6480a32018-11-13 15:48:08 +00004555 const Decl *TargetDecl = Callee.getAbstractInfo().getCalleeDecl().getDecl();
Hal Finkelee90a222014-09-26 05:04:30 +00004556 if (Ret.isScalar() && TargetDecl) {
4557 if (const auto *AA = TargetDecl->getAttr<AssumeAlignedAttr>()) {
4558 llvm::Value *OffsetValue = nullptr;
4559 if (const auto *Offset = AA->getOffset())
4560 OffsetValue = EmitScalarExpr(Offset);
4561
4562 llvm::Value *Alignment = EmitScalarExpr(AA->getAlignment());
4563 llvm::ConstantInt *AlignmentCI = cast<llvm::ConstantInt>(Alignment);
Roman Lebedevbd1c0872019-01-15 09:44:25 +00004564 EmitAlignmentAssumption(Ret.getScalarVal(), RetTy, Loc, AA->getLocation(),
4565 AlignmentCI->getZExtValue(), OffsetValue);
Erich Keane623efd82017-03-30 21:48:55 +00004566 } else if (const auto *AA = TargetDecl->getAttr<AllocAlignAttr>()) {
Roman Lebedevbd1c0872019-01-15 09:44:25 +00004567 llvm::Value *AlignmentVal = CallArgs[AA->getParamIndex().getLLVMIndex()]
4568 .getRValue(*this)
4569 .getScalarVal();
4570 EmitAlignmentAssumption(Ret.getScalarVal(), RetTy, Loc, AA->getLocation(),
4571 AlignmentVal);
Hal Finkelee90a222014-09-26 05:04:30 +00004572 }
Daniel Dunbar573884e2008-09-10 07:04:09 +00004573 }
Daniel Dunbard3674e62008-09-11 01:48:57 +00004574
Hal Finkelee90a222014-09-26 05:04:30 +00004575 return Ret;
Daniel Dunbar613855c2008-09-09 23:27:19 +00004576}
Daniel Dunbar2d0746f2009-02-10 20:44:09 +00004577
John McCall9831b842018-02-06 18:52:44 +00004578CGCallee CGCallee::prepareConcreteCallee(CodeGenFunction &CGF) const {
4579 if (isVirtual()) {
4580 const CallExpr *CE = getVirtualCallExpr();
4581 return CGF.CGM.getCXXABI().getVirtualFunctionPointer(
James Y Knightcfe8cd72019-02-07 01:15:41 +00004582 CGF, getVirtualMethodDecl(), getThisAddress(), getVirtualFunctionType(),
Stephen Kellyf2ceec42018-08-09 21:08:08 +00004583 CE ? CE->getBeginLoc() : SourceLocation());
John McCall9831b842018-02-06 18:52:44 +00004584 }
4585
4586 return *this;
4587}
4588
Daniel Dunbar2d0746f2009-02-10 20:44:09 +00004589/* VarArg handling */
4590
Charles Davisc7d5c942015-09-17 20:55:33 +00004591Address CodeGenFunction::EmitVAArg(VAArgExpr *VE, Address &VAListAddr) {
4592 VAListAddr = VE->isMicrosoftABI()
4593 ? EmitMSVAListRef(VE->getSubExpr())
4594 : EmitVAListRef(VE->getSubExpr());
4595 QualType Ty = VE->getType();
4596 if (VE->isMicrosoftABI())
4597 return CGM.getTypes().getABIInfo().EmitMSVAArg(*this, VAListAddr, Ty);
John McCall7f416cc2015-09-08 08:05:57 +00004598 return CGM.getTypes().getABIInfo().EmitVAArg(*this, VAListAddr, Ty);
Daniel Dunbar2d0746f2009-02-10 20:44:09 +00004599}