blob: b2dda3c20dbae95abb5e0138b9b430d69d21151f [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.
John McCall7f416cc2015-09-08 08:05:57 +00001154 SrcPtr = CGF.Builder.CreateStructGEP(SrcPtr, 0, CharUnits(), "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())) {
Ulrich Weigand6e2cea62015-07-10 11:31:43 +00001282 const llvm::StructLayout *Layout =
1283 CGF.CGM.getDataLayout().getStructLayout(STy);
1284
Eli Friedmanaf9b3252011-05-17 21:08:01 +00001285 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
John McCall7f416cc2015-09-08 08:05:57 +00001286 auto EltOffset = CharUnits::fromQuantity(Layout->getElementOffset(i));
1287 Address EltPtr = CGF.Builder.CreateStructGEP(Dest, i, EltOffset);
Eli Friedmanaf9b3252011-05-17 21:08:01 +00001288 llvm::Value *Elt = CGF.Builder.CreateExtractValue(Val, i);
John McCall7f416cc2015-09-08 08:05:57 +00001289 CGF.Builder.CreateStore(Elt, EltPtr, DestIsVolatile);
Eli Friedmanaf9b3252011-05-17 21:08:01 +00001290 }
1291 } else {
John McCall7f416cc2015-09-08 08:05:57 +00001292 CGF.Builder.CreateStore(Val, Dest, DestIsVolatile);
Eli Friedmanaf9b3252011-05-17 21:08:01 +00001293 }
1294}
1295
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001296/// CreateCoercedStore - Create a store to \arg DstPtr from \arg Src,
Ulrich Weigand6e2cea62015-07-10 11:31:43 +00001297/// where the source and destination may have different types. The
1298/// destination is known to be aligned to \arg DstAlign bytes.
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001299///
1300/// This safely handles the case when the src type is larger than the
1301/// destination type; the upper bits of the src will be lost.
1302static void CreateCoercedStore(llvm::Value *Src,
John McCall7f416cc2015-09-08 08:05:57 +00001303 Address Dst,
Anders Carlsson17490832009-12-24 20:40:36 +00001304 bool DstIsVolatile,
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001305 CodeGenFunction &CGF) {
Chris Lattner2192fe52011-07-18 04:24:23 +00001306 llvm::Type *SrcTy = Src->getType();
John McCall7f416cc2015-09-08 08:05:57 +00001307 llvm::Type *DstTy = Dst.getType()->getElementType();
Chris Lattnerd200eda2010-06-28 22:51:39 +00001308 if (SrcTy == DstTy) {
John McCall7f416cc2015-09-08 08:05:57 +00001309 CGF.Builder.CreateStore(Src, Dst, DstIsVolatile);
Chris Lattnerd200eda2010-06-28 22:51:39 +00001310 return;
1311 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001312
Micah Villmowdd31ca12012-10-08 16:25:52 +00001313 uint64_t SrcSize = CGF.CGM.getDataLayout().getTypeAllocSize(SrcTy);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001314
Chris Lattner2192fe52011-07-18 04:24:23 +00001315 if (llvm::StructType *DstSTy = dyn_cast<llvm::StructType>(DstTy)) {
John McCall7f416cc2015-09-08 08:05:57 +00001316 Dst = EnterStructPointerForCoercedAccess(Dst, DstSTy, SrcSize, CGF);
1317 DstTy = Dst.getType()->getElementType();
Chris Lattner895c52b2010-06-27 06:04:18 +00001318 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001319
Chris Lattner055097f2010-06-27 06:26:04 +00001320 // If the source and destination are integer or pointer types, just do an
1321 // extension or truncation to the desired type.
1322 if ((isa<llvm::IntegerType>(SrcTy) || isa<llvm::PointerType>(SrcTy)) &&
1323 (isa<llvm::IntegerType>(DstTy) || isa<llvm::PointerType>(DstTy))) {
1324 Src = CoerceIntOrPtrToIntOrPtr(Src, DstTy, CGF);
John McCall7f416cc2015-09-08 08:05:57 +00001325 CGF.Builder.CreateStore(Src, Dst, DstIsVolatile);
Chris Lattner055097f2010-06-27 06:26:04 +00001326 return;
1327 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001328
Micah Villmowdd31ca12012-10-08 16:25:52 +00001329 uint64_t DstSize = CGF.CGM.getDataLayout().getTypeAllocSize(DstTy);
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001330
Daniel Dunbar313321e2009-02-03 05:31:23 +00001331 // If store is legal, just bitcast the src pointer.
Daniel Dunbar4be99ff2009-06-05 07:58:54 +00001332 if (SrcSize <= DstSize) {
Yaxun Liue9e5c4f2017-06-29 18:47:45 +00001333 Dst = CGF.Builder.CreateElementBitCast(Dst, SrcTy);
John McCall7f416cc2015-09-08 08:05:57 +00001334 BuildAggStore(CGF, Src, Dst, DstIsVolatile);
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001335 } else {
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001336 // Otherwise do coercion through memory. This is stupid, but
1337 // simple.
Daniel Dunbar4be99ff2009-06-05 07:58:54 +00001338
1339 // Generally SrcSize is never greater than DstSize, since this means we are
1340 // losing bits. However, this can happen in cases where the structure has
1341 // additional padding, for example due to a user specified alignment.
1342 //
1343 // FIXME: Assert that we aren't truncating non-padding bits when have access
1344 // to that information.
John McCall7f416cc2015-09-08 08:05:57 +00001345 Address Tmp = CreateTempAllocaForCoercion(CGF, SrcTy, Dst.getAlignment());
1346 CGF.Builder.CreateStore(Src, Tmp);
Yaxun Liu4bbdebc2018-11-08 16:55:46 +00001347 Address Casted = CGF.Builder.CreateElementBitCast(Tmp,CGF.Int8Ty);
1348 Address DstCasted = CGF.Builder.CreateElementBitCast(Dst,CGF.Int8Ty);
Manman Ren84b921f2012-11-28 22:08:52 +00001349 CGF.Builder.CreateMemCpy(DstCasted, Casted,
1350 llvm::ConstantInt::get(CGF.IntPtrTy, DstSize),
John McCall7f416cc2015-09-08 08:05:57 +00001351 false);
Daniel Dunbarf5589ac2009-02-02 19:06:38 +00001352 }
1353}
1354
John McCall7f416cc2015-09-08 08:05:57 +00001355static Address emitAddressAtOffset(CodeGenFunction &CGF, Address addr,
Fangrui Song6907ce22018-07-30 19:24:48 +00001356 const ABIArgInfo &info) {
John McCall7f416cc2015-09-08 08:05:57 +00001357 if (unsigned offset = info.getDirectOffset()) {
1358 addr = CGF.Builder.CreateElementBitCast(addr, CGF.Int8Ty);
1359 addr = CGF.Builder.CreateConstInBoundsByteGEP(addr,
1360 CharUnits::fromQuantity(offset));
1361 addr = CGF.Builder.CreateElementBitCast(addr, info.getCoerceToType());
1362 }
1363 return addr;
1364}
1365
Alexey Samsonov153004f2014-09-29 22:08:00 +00001366namespace {
1367
1368/// Encapsulates information about the way function arguments from
1369/// CGFunctionInfo should be passed to actual LLVM IR function.
1370class ClangToLLVMArgMapping {
1371 static const unsigned InvalidIndex = ~0U;
1372 unsigned InallocaArgNo;
1373 unsigned SRetArgNo;
1374 unsigned TotalIRArgs;
1375
1376 /// Arguments of LLVM IR function corresponding to single Clang argument.
1377 struct IRArgs {
1378 unsigned PaddingArgIndex;
1379 // Argument is expanded to IR arguments at positions
1380 // [FirstArgIndex, FirstArgIndex + NumberOfArgs).
1381 unsigned FirstArgIndex;
1382 unsigned NumberOfArgs;
1383
1384 IRArgs()
1385 : PaddingArgIndex(InvalidIndex), FirstArgIndex(InvalidIndex),
1386 NumberOfArgs(0) {}
1387 };
1388
1389 SmallVector<IRArgs, 8> ArgInfo;
1390
1391public:
1392 ClangToLLVMArgMapping(const ASTContext &Context, const CGFunctionInfo &FI,
1393 bool OnlyRequiredArgs = false)
1394 : InallocaArgNo(InvalidIndex), SRetArgNo(InvalidIndex), TotalIRArgs(0),
1395 ArgInfo(OnlyRequiredArgs ? FI.getNumRequiredArgs() : FI.arg_size()) {
1396 construct(Context, FI, OnlyRequiredArgs);
1397 }
1398
1399 bool hasInallocaArg() const { return InallocaArgNo != InvalidIndex; }
1400 unsigned getInallocaArgNo() const {
1401 assert(hasInallocaArg());
1402 return InallocaArgNo;
1403 }
1404
1405 bool hasSRetArg() const { return SRetArgNo != InvalidIndex; }
1406 unsigned getSRetArgNo() const {
1407 assert(hasSRetArg());
1408 return SRetArgNo;
1409 }
1410
1411 unsigned totalIRArgs() const { return TotalIRArgs; }
1412
1413 bool hasPaddingArg(unsigned ArgNo) const {
1414 assert(ArgNo < ArgInfo.size());
1415 return ArgInfo[ArgNo].PaddingArgIndex != InvalidIndex;
1416 }
1417 unsigned getPaddingArgNo(unsigned ArgNo) const {
1418 assert(hasPaddingArg(ArgNo));
1419 return ArgInfo[ArgNo].PaddingArgIndex;
1420 }
1421
1422 /// Returns index of first IR argument corresponding to ArgNo, and their
1423 /// quantity.
1424 std::pair<unsigned, unsigned> getIRArgs(unsigned ArgNo) const {
1425 assert(ArgNo < ArgInfo.size());
1426 return std::make_pair(ArgInfo[ArgNo].FirstArgIndex,
1427 ArgInfo[ArgNo].NumberOfArgs);
1428 }
1429
1430private:
1431 void construct(const ASTContext &Context, const CGFunctionInfo &FI,
1432 bool OnlyRequiredArgs);
1433};
1434
1435void ClangToLLVMArgMapping::construct(const ASTContext &Context,
1436 const CGFunctionInfo &FI,
1437 bool OnlyRequiredArgs) {
1438 unsigned IRArgNo = 0;
1439 bool SwapThisWithSRet = false;
1440 const ABIArgInfo &RetAI = FI.getReturnInfo();
1441
1442 if (RetAI.getKind() == ABIArgInfo::Indirect) {
1443 SwapThisWithSRet = RetAI.isSRetAfterThis();
1444 SRetArgNo = SwapThisWithSRet ? 1 : IRArgNo++;
1445 }
1446
1447 unsigned ArgNo = 0;
1448 unsigned NumArgs = OnlyRequiredArgs ? FI.getNumRequiredArgs() : FI.arg_size();
1449 for (CGFunctionInfo::const_arg_iterator I = FI.arg_begin(); ArgNo < NumArgs;
1450 ++I, ++ArgNo) {
1451 assert(I != FI.arg_end());
1452 QualType ArgType = I->type;
1453 const ABIArgInfo &AI = I->info;
1454 // Collect data about IR arguments corresponding to Clang argument ArgNo.
1455 auto &IRArgs = ArgInfo[ArgNo];
1456
1457 if (AI.getPaddingType())
1458 IRArgs.PaddingArgIndex = IRArgNo++;
1459
1460 switch (AI.getKind()) {
1461 case ABIArgInfo::Extend:
1462 case ABIArgInfo::Direct: {
1463 // FIXME: handle sseregparm someday...
1464 llvm::StructType *STy = dyn_cast<llvm::StructType>(AI.getCoerceToType());
1465 if (AI.isDirect() && AI.getCanBeFlattened() && STy) {
1466 IRArgs.NumberOfArgs = STy->getNumElements();
1467 } else {
1468 IRArgs.NumberOfArgs = 1;
1469 }
1470 break;
1471 }
1472 case ABIArgInfo::Indirect:
1473 IRArgs.NumberOfArgs = 1;
1474 break;
1475 case ABIArgInfo::Ignore:
1476 case ABIArgInfo::InAlloca:
1477 // ignore and inalloca doesn't have matching LLVM parameters.
1478 IRArgs.NumberOfArgs = 0;
1479 break;
John McCallf26e73d2016-03-11 04:30:43 +00001480 case ABIArgInfo::CoerceAndExpand:
1481 IRArgs.NumberOfArgs = AI.getCoerceAndExpandTypeSequence().size();
1482 break;
1483 case ABIArgInfo::Expand:
Alexey Samsonov153004f2014-09-29 22:08:00 +00001484 IRArgs.NumberOfArgs = getExpansionSize(ArgType, Context);
1485 break;
1486 }
Alexey Samsonov153004f2014-09-29 22:08:00 +00001487
1488 if (IRArgs.NumberOfArgs > 0) {
1489 IRArgs.FirstArgIndex = IRArgNo;
1490 IRArgNo += IRArgs.NumberOfArgs;
1491 }
1492
1493 // Skip over the sret parameter when it comes second. We already handled it
1494 // above.
1495 if (IRArgNo == 1 && SwapThisWithSRet)
1496 IRArgNo++;
1497 }
1498 assert(ArgNo == ArgInfo.size());
1499
1500 if (FI.usesInAlloca())
1501 InallocaArgNo = IRArgNo++;
1502
1503 TotalIRArgs = IRArgNo;
1504}
1505} // namespace
1506
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00001507/***/
1508
Daniel Dunbar6f2e8392010-07-14 23:39:36 +00001509bool CodeGenModule::ReturnTypeUsesSRet(const CGFunctionInfo &FI) {
Saleem Abdulrasoolf181f1a2018-02-28 20:16:12 +00001510 const auto &RI = FI.getReturnInfo();
1511 return RI.isIndirect() || (RI.isInAlloca() && RI.getInAllocaSRet());
Daniel Dunbar7633cbf2009-02-02 21:43:58 +00001512}
1513
Tim Northovere77cc392014-03-29 13:28:05 +00001514bool CodeGenModule::ReturnSlotInterferesWithArgs(const CGFunctionInfo &FI) {
1515 return ReturnTypeUsesSRet(FI) &&
1516 getTargetCodeGenInfo().doesReturnSlotInterfereWithArgs();
1517}
1518
Daniel Dunbar6f2e8392010-07-14 23:39:36 +00001519bool CodeGenModule::ReturnTypeUsesFPRet(QualType ResultType) {
1520 if (const BuiltinType *BT = ResultType->getAs<BuiltinType>()) {
1521 switch (BT->getKind()) {
1522 default:
1523 return false;
1524 case BuiltinType::Float:
John McCallc8e01702013-04-16 22:48:15 +00001525 return getTarget().useObjCFPRetForRealType(TargetInfo::Float);
Daniel Dunbar6f2e8392010-07-14 23:39:36 +00001526 case BuiltinType::Double:
John McCallc8e01702013-04-16 22:48:15 +00001527 return getTarget().useObjCFPRetForRealType(TargetInfo::Double);
Daniel Dunbar6f2e8392010-07-14 23:39:36 +00001528 case BuiltinType::LongDouble:
John McCallc8e01702013-04-16 22:48:15 +00001529 return getTarget().useObjCFPRetForRealType(TargetInfo::LongDouble);
Daniel Dunbar6f2e8392010-07-14 23:39:36 +00001530 }
1531 }
1532
1533 return false;
1534}
1535
Anders Carlsson2f1a6c32011-10-31 16:27:11 +00001536bool CodeGenModule::ReturnTypeUsesFP2Ret(QualType ResultType) {
1537 if (const ComplexType *CT = ResultType->getAs<ComplexType>()) {
1538 if (const BuiltinType *BT = CT->getElementType()->getAs<BuiltinType>()) {
1539 if (BT->getKind() == BuiltinType::LongDouble)
John McCallc8e01702013-04-16 22:48:15 +00001540 return getTarget().useObjCFP2RetForComplexLongDouble();
Anders Carlsson2f1a6c32011-10-31 16:27:11 +00001541 }
1542 }
1543
1544 return false;
1545}
1546
Chris Lattnera5f58b02011-07-09 17:41:47 +00001547llvm::FunctionType *CodeGenTypes::GetFunctionType(GlobalDecl GD) {
John McCalla729c622012-02-17 03:33:10 +00001548 const CGFunctionInfo &FI = arrangeGlobalDeclaration(GD);
1549 return GetFunctionType(FI);
John McCallf8ff7b92010-02-23 00:48:20 +00001550}
1551
Chris Lattnera5f58b02011-07-09 17:41:47 +00001552llvm::FunctionType *
John McCalla729c622012-02-17 03:33:10 +00001553CodeGenTypes::GetFunctionType(const CGFunctionInfo &FI) {
Alexey Samsonov153004f2014-09-29 22:08:00 +00001554
David Blaikie82e95a32014-11-19 07:49:47 +00001555 bool Inserted = FunctionsBeingProcessed.insert(&FI).second;
1556 (void)Inserted;
Chris Lattner6fb0ccf2011-07-15 05:16:14 +00001557 assert(Inserted && "Recursively being processed?");
Daniel Dunbar7a95ca32008-09-10 04:01:49 +00001558
Alexey Samsonov153004f2014-09-29 22:08:00 +00001559 llvm::Type *resultType = nullptr;
John McCall85dd2c52011-05-15 02:19:42 +00001560 const ABIArgInfo &retAI = FI.getReturnInfo();
1561 switch (retAI.getKind()) {
Daniel Dunbard3674e62008-09-11 01:48:57 +00001562 case ABIArgInfo::Expand:
John McCall85dd2c52011-05-15 02:19:42 +00001563 llvm_unreachable("Invalid ABI kind for return argument");
Daniel Dunbard3674e62008-09-11 01:48:57 +00001564
Anton Korobeynikov18adbf52009-06-06 09:36:29 +00001565 case ABIArgInfo::Extend:
Daniel Dunbar67dace892009-02-03 06:17:37 +00001566 case ABIArgInfo::Direct:
John McCall85dd2c52011-05-15 02:19:42 +00001567 resultType = retAI.getCoerceToType();
Daniel Dunbar67dace892009-02-03 06:17:37 +00001568 break;
1569
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001570 case ABIArgInfo::InAlloca:
Reid Klecknerfab1e892014-02-25 00:59:14 +00001571 if (retAI.getInAllocaSRet()) {
1572 // sret things on win32 aren't void, they return the sret pointer.
1573 QualType ret = FI.getReturnType();
1574 llvm::Type *ty = ConvertType(ret);
1575 unsigned addressSpace = Context.getTargetAddressSpace(ret);
1576 resultType = llvm::PointerType::get(ty, addressSpace);
1577 } else {
1578 resultType = llvm::Type::getVoidTy(getLLVMContext());
1579 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001580 break;
1581
John McCall7f416cc2015-09-08 08:05:57 +00001582 case ABIArgInfo::Indirect:
Daniel Dunbar94a6f252009-01-26 21:26:08 +00001583 case ABIArgInfo::Ignore:
John McCall85dd2c52011-05-15 02:19:42 +00001584 resultType = llvm::Type::getVoidTy(getLLVMContext());
Daniel Dunbar94a6f252009-01-26 21:26:08 +00001585 break;
John McCallf26e73d2016-03-11 04:30:43 +00001586
1587 case ABIArgInfo::CoerceAndExpand:
1588 resultType = retAI.getUnpaddedCoerceAndExpandType();
1589 break;
Daniel Dunbar7a95ca32008-09-10 04:01:49 +00001590 }
Mike Stump11289f42009-09-09 15:08:12 +00001591
Alexey Samsonov153004f2014-09-29 22:08:00 +00001592 ClangToLLVMArgMapping IRFunctionArgs(getContext(), FI, true);
1593 SmallVector<llvm::Type*, 8> ArgTypes(IRFunctionArgs.totalIRArgs());
1594
1595 // Add type for sret argument.
1596 if (IRFunctionArgs.hasSRetArg()) {
1597 QualType Ret = FI.getReturnType();
1598 llvm::Type *Ty = ConvertType(Ret);
1599 unsigned AddressSpace = Context.getTargetAddressSpace(Ret);
1600 ArgTypes[IRFunctionArgs.getSRetArgNo()] =
1601 llvm::PointerType::get(Ty, AddressSpace);
1602 }
1603
1604 // Add type for inalloca argument.
1605 if (IRFunctionArgs.hasInallocaArg()) {
1606 auto ArgStruct = FI.getArgStruct();
1607 assert(ArgStruct);
1608 ArgTypes[IRFunctionArgs.getInallocaArgNo()] = ArgStruct->getPointerTo();
1609 }
1610
John McCallc818bbb2012-12-07 07:03:17 +00001611 // Add in all of the required arguments.
Alexey Samsonov153004f2014-09-29 22:08:00 +00001612 unsigned ArgNo = 0;
Alexey Samsonov34625dd2014-09-29 21:21:48 +00001613 CGFunctionInfo::const_arg_iterator it = FI.arg_begin(),
1614 ie = it + FI.getNumRequiredArgs();
Alexey Samsonov153004f2014-09-29 22:08:00 +00001615 for (; it != ie; ++it, ++ArgNo) {
1616 const ABIArgInfo &ArgInfo = it->info;
Mike Stump11289f42009-09-09 15:08:12 +00001617
Rafael Espindolafad28de2012-10-24 01:59:00 +00001618 // Insert a padding type to ensure proper alignment.
Alexey Samsonov153004f2014-09-29 22:08:00 +00001619 if (IRFunctionArgs.hasPaddingArg(ArgNo))
1620 ArgTypes[IRFunctionArgs.getPaddingArgNo(ArgNo)] =
1621 ArgInfo.getPaddingType();
Rafael Espindolafad28de2012-10-24 01:59:00 +00001622
Alexey Samsonov153004f2014-09-29 22:08:00 +00001623 unsigned FirstIRArg, NumIRArgs;
1624 std::tie(FirstIRArg, NumIRArgs) = IRFunctionArgs.getIRArgs(ArgNo);
1625
1626 switch (ArgInfo.getKind()) {
Daniel Dunbar94a6f252009-01-26 21:26:08 +00001627 case ABIArgInfo::Ignore:
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001628 case ABIArgInfo::InAlloca:
Alexey Samsonov153004f2014-09-29 22:08:00 +00001629 assert(NumIRArgs == 0);
Daniel Dunbar94a6f252009-01-26 21:26:08 +00001630 break;
1631
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00001632 case ABIArgInfo::Indirect: {
Alexey Samsonov153004f2014-09-29 22:08:00 +00001633 assert(NumIRArgs == 1);
Yaxun Liud7523282017-04-17 20:10:44 +00001634 // indirect arguments are always on the stack, which is alloca addr space.
Chris Lattner2192fe52011-07-18 04:24:23 +00001635 llvm::Type *LTy = ConvertTypeForMem(it->type);
Yaxun Liud7523282017-04-17 20:10:44 +00001636 ArgTypes[FirstIRArg] = LTy->getPointerTo(
1637 CGM.getDataLayout().getAllocaAddrSpace());
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00001638 break;
1639 }
1640
1641 case ABIArgInfo::Extend:
Chris Lattner2cdfda42010-07-29 06:44:09 +00001642 case ABIArgInfo::Direct: {
Oliver Stannard2bfdc5b2014-08-27 10:43:15 +00001643 // Fast-isel and the optimizer generally like scalar values better than
1644 // FCAs, so we flatten them if this is safe to do for this argument.
Alexey Samsonov153004f2014-09-29 22:08:00 +00001645 llvm::Type *argType = ArgInfo.getCoerceToType();
James Molloy6f244b62014-05-09 16:21:39 +00001646 llvm::StructType *st = dyn_cast<llvm::StructType>(argType);
Alexey Samsonov153004f2014-09-29 22:08:00 +00001647 if (st && ArgInfo.isDirect() && ArgInfo.getCanBeFlattened()) {
1648 assert(NumIRArgs == st->getNumElements());
John McCall85dd2c52011-05-15 02:19:42 +00001649 for (unsigned i = 0, e = st->getNumElements(); i != e; ++i)
Alexey Samsonov153004f2014-09-29 22:08:00 +00001650 ArgTypes[FirstIRArg + i] = st->getElementType(i);
Chris Lattner3dd716c2010-06-28 23:44:11 +00001651 } else {
Alexey Samsonov153004f2014-09-29 22:08:00 +00001652 assert(NumIRArgs == 1);
1653 ArgTypes[FirstIRArg] = argType;
Chris Lattner3dd716c2010-06-28 23:44:11 +00001654 }
Daniel Dunbar2f219b02009-02-03 19:12:28 +00001655 break;
Chris Lattner2cdfda42010-07-29 06:44:09 +00001656 }
Mike Stump11289f42009-09-09 15:08:12 +00001657
John McCallf26e73d2016-03-11 04:30:43 +00001658 case ABIArgInfo::CoerceAndExpand: {
1659 auto ArgTypesIter = ArgTypes.begin() + FirstIRArg;
1660 for (auto EltTy : ArgInfo.getCoerceAndExpandTypeSequence()) {
1661 *ArgTypesIter++ = EltTy;
1662 }
1663 assert(ArgTypesIter == ArgTypes.begin() + FirstIRArg + NumIRArgs);
1664 break;
1665 }
1666
Daniel Dunbard3674e62008-09-11 01:48:57 +00001667 case ABIArgInfo::Expand:
Alexey Samsonov153004f2014-09-29 22:08:00 +00001668 auto ArgTypesIter = ArgTypes.begin() + FirstIRArg;
1669 getExpandedTypes(it->type, ArgTypesIter);
1670 assert(ArgTypesIter == ArgTypes.begin() + FirstIRArg + NumIRArgs);
Daniel Dunbard3674e62008-09-11 01:48:57 +00001671 break;
1672 }
Daniel Dunbar7a95ca32008-09-10 04:01:49 +00001673 }
1674
Chris Lattner6fb0ccf2011-07-15 05:16:14 +00001675 bool Erased = FunctionsBeingProcessed.erase(&FI); (void)Erased;
1676 assert(Erased && "Not in set?");
Alexey Samsonov153004f2014-09-29 22:08:00 +00001677
1678 return llvm::FunctionType::get(resultType, ArgTypes, FI.isVariadic());
Daniel Dunbar81cf67f2008-09-09 23:48:28 +00001679}
1680
Chris Lattner2192fe52011-07-18 04:24:23 +00001681llvm::Type *CodeGenTypes::GetFunctionTypeForVTable(GlobalDecl GD) {
John McCall5d865c322010-08-31 07:33:07 +00001682 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
Anders Carlsson64457732009-11-24 05:08:52 +00001683 const FunctionProtoType *FPT = MD->getType()->getAs<FunctionProtoType>();
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001684
Chris Lattner8806e322011-07-10 00:18:59 +00001685 if (!isFuncTypeConvertible(FPT))
1686 return llvm::StructType::get(getLLVMContext());
Fangrui Song6907ce22018-07-30 19:24:48 +00001687
Chris Lattner8806e322011-07-10 00:18:59 +00001688 const CGFunctionInfo *Info;
1689 if (isa<CXXDestructorDecl>(MD))
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001690 Info =
1691 &arrangeCXXStructorDeclaration(MD, getFromDtorType(GD.getDtorType()));
Chris Lattner8806e322011-07-10 00:18:59 +00001692 else
John McCalla729c622012-02-17 03:33:10 +00001693 Info = &arrangeCXXMethodDeclaration(MD);
1694 return GetFunctionType(*Info);
Anders Carlsson64457732009-11-24 05:08:52 +00001695}
1696
Samuel Antao798f11c2015-11-23 22:04:44 +00001697static void AddAttributesFromFunctionProtoType(ASTContext &Ctx,
1698 llvm::AttrBuilder &FuncAttrs,
1699 const FunctionProtoType *FPT) {
1700 if (!FPT)
1701 return;
1702
1703 if (!isUnresolvedExceptionSpec(FPT->getExceptionSpecType()) &&
Richard Smitheaf11ad2018-05-03 03:58:32 +00001704 FPT->isNothrow())
Samuel Antao798f11c2015-11-23 22:04:44 +00001705 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
1706}
1707
Justin Lebarb080b632017-01-25 21:29:48 +00001708void CodeGenModule::ConstructDefaultFnAttrList(StringRef Name, bool HasOptnone,
1709 bool AttrOnCallSite,
1710 llvm::AttrBuilder &FuncAttrs) {
1711 // OptimizeNoneAttr takes precedence over -Os or -Oz. No warning needed.
1712 if (!HasOptnone) {
1713 if (CodeGenOpts.OptimizeSize)
1714 FuncAttrs.addAttribute(llvm::Attribute::OptimizeForSize);
1715 if (CodeGenOpts.OptimizeSize == 2)
1716 FuncAttrs.addAttribute(llvm::Attribute::MinSize);
1717 }
1718
1719 if (CodeGenOpts.DisableRedZone)
1720 FuncAttrs.addAttribute(llvm::Attribute::NoRedZone);
Kristina Brooks7f569b72018-10-18 14:07:02 +00001721 if (CodeGenOpts.IndirectTlsSegRefs)
1722 FuncAttrs.addAttribute("indirect-tls-seg-refs");
Justin Lebarb080b632017-01-25 21:29:48 +00001723 if (CodeGenOpts.NoImplicitFloat)
1724 FuncAttrs.addAttribute(llvm::Attribute::NoImplicitFloat);
1725
1726 if (AttrOnCallSite) {
1727 // Attributes that should go on the call site only.
1728 if (!CodeGenOpts.SimplifyLibCalls ||
1729 CodeGenOpts.isNoBuiltinFunc(Name.data()))
1730 FuncAttrs.addAttribute(llvm::Attribute::NoBuiltin);
1731 if (!CodeGenOpts.TrapFuncName.empty())
1732 FuncAttrs.addAttribute("trap-func-name", CodeGenOpts.TrapFuncName);
1733 } else {
1734 // Attributes that should go on the function, but not the call site.
1735 if (!CodeGenOpts.DisableFPElim) {
1736 FuncAttrs.addAttribute("no-frame-pointer-elim", "false");
1737 } else if (CodeGenOpts.OmitLeafFramePointer) {
1738 FuncAttrs.addAttribute("no-frame-pointer-elim", "false");
1739 FuncAttrs.addAttribute("no-frame-pointer-elim-non-leaf");
1740 } else {
1741 FuncAttrs.addAttribute("no-frame-pointer-elim", "true");
1742 FuncAttrs.addAttribute("no-frame-pointer-elim-non-leaf");
1743 }
1744
1745 FuncAttrs.addAttribute("less-precise-fpmad",
1746 llvm::toStringRef(CodeGenOpts.LessPreciseFPMAD));
1747
Manoj Guptada08f6a2018-07-19 00:44:52 +00001748 if (CodeGenOpts.NullPointerIsValid)
1749 FuncAttrs.addAttribute("null-pointer-is-valid", "true");
Justin Lebarb080b632017-01-25 21:29:48 +00001750 if (!CodeGenOpts.FPDenormalMode.empty())
1751 FuncAttrs.addAttribute("denormal-fp-math", CodeGenOpts.FPDenormalMode);
1752
1753 FuncAttrs.addAttribute("no-trapping-math",
1754 llvm::toStringRef(CodeGenOpts.NoTrappingMath));
1755
Sanjay Patelc81450e2018-04-30 18:19:03 +00001756 // Strict (compliant) code is the default, so only add this attribute to
1757 // indicate that we are trying to workaround a problem case.
1758 if (!CodeGenOpts.StrictFloatCastOverflow)
1759 FuncAttrs.addAttribute("strict-float-cast-overflow", "false");
Sanjay Pateld1754762018-04-27 14:22:48 +00001760
Justin Lebarb080b632017-01-25 21:29:48 +00001761 // TODO: Are these all needed?
1762 // unsafe/inf/nan/nsz are handled by instruction-level FastMathFlags.
1763 FuncAttrs.addAttribute("no-infs-fp-math",
1764 llvm::toStringRef(CodeGenOpts.NoInfsFPMath));
1765 FuncAttrs.addAttribute("no-nans-fp-math",
1766 llvm::toStringRef(CodeGenOpts.NoNaNsFPMath));
1767 FuncAttrs.addAttribute("unsafe-fp-math",
1768 llvm::toStringRef(CodeGenOpts.UnsafeFPMath));
1769 FuncAttrs.addAttribute("use-soft-float",
1770 llvm::toStringRef(CodeGenOpts.SoftFloat));
1771 FuncAttrs.addAttribute("stack-protector-buffer-size",
1772 llvm::utostr(CodeGenOpts.SSPBufferSize));
1773 FuncAttrs.addAttribute("no-signed-zeros-fp-math",
1774 llvm::toStringRef(CodeGenOpts.NoSignedZeros));
1775 FuncAttrs.addAttribute(
1776 "correctly-rounded-divide-sqrt-fp-math",
1777 llvm::toStringRef(CodeGenOpts.CorrectlyRoundedDivSqrt));
1778
Alexey Sotkin3858e262018-04-20 08:08:04 +00001779 if (getLangOpts().OpenCL)
1780 FuncAttrs.addAttribute("denorms-are-zero",
1781 llvm::toStringRef(CodeGenOpts.FlushDenorm));
1782
Justin Lebarb080b632017-01-25 21:29:48 +00001783 // TODO: Reciprocal estimate codegen options should apply to instructions?
Craig Topper402b4312017-11-20 17:09:22 +00001784 const std::vector<std::string> &Recips = CodeGenOpts.Reciprocals;
Justin Lebarb080b632017-01-25 21:29:48 +00001785 if (!Recips.empty())
1786 FuncAttrs.addAttribute("reciprocal-estimates",
Erich Keane857ac592017-10-27 18:45:06 +00001787 llvm::join(Recips, ","));
Justin Lebarb080b632017-01-25 21:29:48 +00001788
Craig Topper9a724aa2017-12-11 21:09:19 +00001789 if (!CodeGenOpts.PreferVectorWidth.empty() &&
1790 CodeGenOpts.PreferVectorWidth != "none")
1791 FuncAttrs.addAttribute("prefer-vector-width",
1792 CodeGenOpts.PreferVectorWidth);
1793
Justin Lebarb080b632017-01-25 21:29:48 +00001794 if (CodeGenOpts.StackRealignment)
1795 FuncAttrs.addAttribute("stackrealign");
1796 if (CodeGenOpts.Backchain)
1797 FuncAttrs.addAttribute("backchain");
Chandler Carruth664aa862018-09-04 12:38:00 +00001798
1799 if (CodeGenOpts.SpeculativeLoadHardening)
1800 FuncAttrs.addAttribute(llvm::Attribute::SpeculativeLoadHardening);
Justin Lebarb080b632017-01-25 21:29:48 +00001801 }
1802
Matt Arsenaulta1cf61b2017-10-06 19:34:40 +00001803 if (getLangOpts().assumeFunctionsAreConvergent()) {
1804 // Conservatively, mark all functions and calls in CUDA and OpenCL as
1805 // convergent (meaning, they may call an intrinsically convergent op, such
1806 // as __syncthreads() / barrier(), and so can't have certain optimizations
1807 // applied around them). LLVM will remove this attribute where it safely
1808 // can.
Justin Lebarb080b632017-01-25 21:29:48 +00001809 FuncAttrs.addAttribute(llvm::Attribute::Convergent);
Matt Arsenaulta1cf61b2017-10-06 19:34:40 +00001810 }
Justin Lebarb080b632017-01-25 21:29:48 +00001811
Matt Arsenaulta1cf61b2017-10-06 19:34:40 +00001812 if (getLangOpts().CUDA && getLangOpts().CUDAIsDevice) {
Justin Lebarb080b632017-01-25 21:29:48 +00001813 // Exceptions aren't supported in CUDA device code.
1814 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
1815
1816 // Respect -fcuda-flush-denormals-to-zero.
Yaxun Liue1bfbc52018-07-21 02:02:22 +00001817 if (CodeGenOpts.FlushDenorm)
Justin Lebarb080b632017-01-25 21:29:48 +00001818 FuncAttrs.addAttribute("nvptx-f32ftz", "true");
1819 }
Peter Collingbourne87f477b2019-01-04 19:27:04 +00001820
1821 for (StringRef Attr : CodeGenOpts.DefaultFunctionAttrs) {
1822 StringRef Var, Value;
1823 std::tie(Var, Value) = Attr.split('=');
1824 FuncAttrs.addAttribute(Var, Value);
1825 }
Justin Lebarb080b632017-01-25 21:29:48 +00001826}
1827
1828void CodeGenModule::AddDefaultFnAttrs(llvm::Function &F) {
1829 llvm::AttrBuilder FuncAttrs;
1830 ConstructDefaultFnAttrList(F.getName(),
1831 F.hasFnAttribute(llvm::Attribute::OptimizeNone),
1832 /* AttrOnCallsite = */ false, FuncAttrs);
Reid Kleckneree4930b2017-05-02 22:07:37 +00001833 F.addAttributes(llvm::AttributeList::FunctionIndex, FuncAttrs);
Justin Lebarb080b632017-01-25 21:29:48 +00001834}
1835
Chad Rosier7dbc9cf2016-01-06 14:35:46 +00001836void CodeGenModule::ConstructAttributeList(
1837 StringRef Name, const CGFunctionInfo &FI, CGCalleeInfo CalleeInfo,
Reid Klecknercdd26792017-04-18 23:50:03 +00001838 llvm::AttributeList &AttrList, unsigned &CallingConv, bool AttrOnCallSite) {
Bill Wendlinga514ebc2012-10-15 20:36:26 +00001839 llvm::AttrBuilder FuncAttrs;
1840 llvm::AttrBuilder RetAttrs;
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00001841
Daniel Dunbar0ef34792009-09-12 00:59:20 +00001842 CallingConv = FI.getEffectiveCallingConvention();
John McCallab26cfa2010-02-05 21:31:56 +00001843 if (FI.isNoReturn())
Bill Wendling207f0532012-12-20 19:27:06 +00001844 FuncAttrs.addAttribute(llvm::Attribute::NoReturn);
John McCallab26cfa2010-02-05 21:31:56 +00001845
Samuel Antao798f11c2015-11-23 22:04:44 +00001846 // If we have information about the function prototype, we can learn
Craig Topper13d759f2018-04-30 22:02:48 +00001847 // attributes from there.
Samuel Antao798f11c2015-11-23 22:04:44 +00001848 AddAttributesFromFunctionProtoType(getContext(), FuncAttrs,
1849 CalleeInfo.getCalleeFunctionProtoType());
1850
Erich Keanede6480a32018-11-13 15:48:08 +00001851 const Decl *TargetDecl = CalleeInfo.getCalleeDecl().getDecl();
Samuel Antao798f11c2015-11-23 22:04:44 +00001852
Justin Lebarb080b632017-01-25 21:29:48 +00001853 bool HasOptnone = false;
Anton Korobeynikovc8478242009-04-04 00:49:24 +00001854 // FIXME: handle sseregparm someday...
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00001855 if (TargetDecl) {
Rafael Espindola2d21ab02011-10-12 19:51:18 +00001856 if (TargetDecl->hasAttr<ReturnsTwiceAttr>())
Bill Wendling207f0532012-12-20 19:27:06 +00001857 FuncAttrs.addAttribute(llvm::Attribute::ReturnsTwice);
Argyrios Kyrtzidisb4b64ca2009-06-30 02:34:44 +00001858 if (TargetDecl->hasAttr<NoThrowAttr>())
Bill Wendling207f0532012-12-20 19:27:06 +00001859 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
Richard Smithdebc59d2013-01-30 05:45:05 +00001860 if (TargetDecl->hasAttr<NoReturnAttr>())
1861 FuncAttrs.addAttribute(llvm::Attribute::NoReturn);
Xinliang David Li4ec36062017-06-13 21:14:07 +00001862 if (TargetDecl->hasAttr<ColdAttr>())
1863 FuncAttrs.addAttribute(llvm::Attribute::Cold);
Aaron Ballman7c19ab12014-02-22 16:59:24 +00001864 if (TargetDecl->hasAttr<NoDuplicateAttr>())
1865 FuncAttrs.addAttribute(llvm::Attribute::NoDuplicate);
Yaxun Liu7d07ae72016-11-01 18:45:32 +00001866 if (TargetDecl->hasAttr<ConvergentAttr>())
1867 FuncAttrs.addAttribute(llvm::Attribute::Convergent);
Richard Smithdebc59d2013-01-30 05:45:05 +00001868
Chandler Carruth45bbe012017-03-24 09:11:57 +00001869 if (const FunctionDecl *Fn = dyn_cast<FunctionDecl>(TargetDecl)) {
Samuel Antao798f11c2015-11-23 22:04:44 +00001870 AddAttributesFromFunctionProtoType(
Chandler Carruth45bbe012017-03-24 09:11:57 +00001871 getContext(), FuncAttrs, Fn->getType()->getAs<FunctionProtoType>());
Richard Smith49af6292013-03-05 08:30:04 +00001872 // Don't use [[noreturn]] or _Noreturn for a call to a virtual function.
1873 // These attributes are not inherited by overloads.
Chandler Carruth45bbe012017-03-24 09:11:57 +00001874 const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(Fn);
1875 if (Fn->isNoReturn() && !(AttrOnCallSite && MD && MD->isVirtual()))
Richard Smithdebc59d2013-01-30 05:45:05 +00001876 FuncAttrs.addAttribute(llvm::Attribute::NoReturn);
John McCallbe349de2010-07-08 06:48:12 +00001877 }
1878
David Majnemer1bf0f8e2015-07-20 22:51:52 +00001879 // 'const', 'pure' and 'noalias' attributed functions are also nounwind.
Eric Christopherbf005ec2011-08-15 22:38:22 +00001880 if (TargetDecl->hasAttr<ConstAttr>()) {
Bill Wendling207f0532012-12-20 19:27:06 +00001881 FuncAttrs.addAttribute(llvm::Attribute::ReadNone);
1882 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
Eric Christopherbf005ec2011-08-15 22:38:22 +00001883 } else if (TargetDecl->hasAttr<PureAttr>()) {
Bill Wendling207f0532012-12-20 19:27:06 +00001884 FuncAttrs.addAttribute(llvm::Attribute::ReadOnly);
1885 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
David Majnemer1bf0f8e2015-07-20 22:51:52 +00001886 } else if (TargetDecl->hasAttr<NoAliasAttr>()) {
1887 FuncAttrs.addAttribute(llvm::Attribute::ArgMemOnly);
1888 FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
Eric Christopherbf005ec2011-08-15 22:38:22 +00001889 }
David Majnemer631a90b2015-02-04 07:23:21 +00001890 if (TargetDecl->hasAttr<RestrictAttr>())
Bill Wendling207f0532012-12-20 19:27:06 +00001891 RetAttrs.addAttribute(llvm::Attribute::NoAlias);
Manoj Guptada08f6a2018-07-19 00:44:52 +00001892 if (TargetDecl->hasAttr<ReturnsNonNullAttr>() &&
1893 !CodeGenOpts.NullPointerIsValid)
Hal Finkeld8442b12014-07-12 04:51:04 +00001894 RetAttrs.addAttribute(llvm::Attribute::NonNull);
Oren Ben Simhon318a6ea2017-04-27 12:01:00 +00001895 if (TargetDecl->hasAttr<AnyX86NoCallerSavedRegistersAttr>())
1896 FuncAttrs.addAttribute("no_caller_saved_registers");
Oren Ben Simhon220671a2018-03-17 13:31:35 +00001897 if (TargetDecl->hasAttr<AnyX86NoCfCheckAttr>())
1898 FuncAttrs.addAttribute(llvm::Attribute::NoCfCheck);
Paul Robinson08556952014-12-11 20:14:04 +00001899
1900 HasOptnone = TargetDecl->hasAttr<OptimizeNoneAttr>();
George Burgess IVe3763372016-12-22 02:50:20 +00001901 if (auto *AllocSize = TargetDecl->getAttr<AllocSizeAttr>()) {
1902 Optional<unsigned> NumElemsParam;
Joel E. Denny81508102018-03-13 14:51:22 +00001903 if (AllocSize->getNumElemsParam().isValid())
1904 NumElemsParam = AllocSize->getNumElemsParam().getLLVMIndex();
1905 FuncAttrs.addAllocSizeAttr(AllocSize->getElemSizeParam().getLLVMIndex(),
George Burgess IVe3763372016-12-22 02:50:20 +00001906 NumElemsParam);
1907 }
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00001908 }
1909
Justin Lebarb080b632017-01-25 21:29:48 +00001910 ConstructDefaultFnAttrList(Name, HasOptnone, AttrOnCallSite, FuncAttrs);
Paul Robinson08556952014-12-11 20:14:04 +00001911
Zola Bridges826ef592019-01-18 17:20:46 +00001912 // This must run after constructing the default function attribute list
1913 // to ensure that the speculative load hardening attribute is removed
1914 // in the case where the -mspeculative-load-hardening flag was passed.
1915 if (TargetDecl) {
1916 if (TargetDecl->hasAttr<NoSpeculativeLoadHardeningAttr>())
1917 FuncAttrs.removeAttribute(llvm::Attribute::SpeculativeLoadHardening);
1918 if (TargetDecl->hasAttr<SpeculativeLoadHardeningAttr>())
1919 FuncAttrs.addAttribute(llvm::Attribute::SpeculativeLoadHardening);
1920 }
1921
Peter Collingbourneb4728c12014-05-19 22:14:34 +00001922 if (CodeGenOpts.EnableSegmentedStacks &&
1923 !(TargetDecl && TargetDecl->hasAttr<NoSplitStackAttr>()))
Reid Klecknerfb873af2014-04-10 22:59:13 +00001924 FuncAttrs.addAttribute("split-stack");
Devang Patel6e467b12009-06-04 23:32:02 +00001925
Sriraman Tallam5c651482017-11-07 19:37:51 +00001926 // Add NonLazyBind attribute to function declarations when -fno-plt
1927 // is used.
1928 if (TargetDecl && CodeGenOpts.NoPLT) {
1929 if (auto *Fn = dyn_cast<FunctionDecl>(TargetDecl)) {
1930 if (!Fn->isDefined() && !AttrOnCallSite) {
1931 FuncAttrs.addAttribute(llvm::Attribute::NonLazyBind);
1932 }
1933 }
1934 }
1935
Alexey Sotkin20f65922018-02-22 11:54:14 +00001936 if (TargetDecl && TargetDecl->hasAttr<OpenCLKernelAttr>()) {
1937 if (getLangOpts().OpenCLVersion <= 120) {
1938 // OpenCL v1.2 Work groups are always uniform
1939 FuncAttrs.addAttribute("uniform-work-group-size", "true");
1940 } else {
1941 // OpenCL v2.0 Work groups may be whether uniform or not.
1942 // '-cl-uniform-work-group-size' compile option gets a hint
1943 // to the compiler that the global work-size be a multiple of
1944 // the work-group size specified to clEnqueueNDRangeKernel
1945 // (i.e. work groups are uniform).
1946 FuncAttrs.addAttribute("uniform-work-group-size",
1947 llvm::toStringRef(CodeGenOpts.UniformWGSize));
1948 }
1949 }
1950
Justin Lebarb080b632017-01-25 21:29:48 +00001951 if (!AttrOnCallSite) {
Akira Hatanaka627586b2018-03-02 01:53:15 +00001952 bool DisableTailCalls = false;
1953
1954 if (CodeGenOpts.DisableTailCalls)
1955 DisableTailCalls = true;
1956 else if (TargetDecl) {
1957 if (TargetDecl->hasAttr<DisableTailCallsAttr>() ||
1958 TargetDecl->hasAttr<AnyX86InterruptAttr>())
1959 DisableTailCalls = true;
1960 else if (CodeGenOpts.NoEscapingBlockTailCalls) {
1961 if (const auto *BD = dyn_cast<BlockDecl>(TargetDecl))
1962 if (!BD->doesNotEscape())
1963 DisableTailCalls = true;
1964 }
1965 }
1966
Justin Lebarb080b632017-01-25 21:29:48 +00001967 FuncAttrs.addAttribute("disable-tail-calls",
1968 llvm::toStringRef(DisableTailCalls));
Erich Keanede6480a32018-11-13 15:48:08 +00001969 GetCPUAndFeaturesAttributes(CalleeInfo.getCalleeDecl(), FuncAttrs);
Bill Wendling985d1c52013-02-15 21:30:01 +00001970 }
1971
Alexey Samsonov153004f2014-09-29 22:08:00 +00001972 ClangToLLVMArgMapping IRFunctionArgs(getContext(), FI);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00001973
Daniel Dunbar3668cb22009-02-02 23:43:58 +00001974 QualType RetTy = FI.getReturnType();
Daniel Dunbarb52d0772009-02-03 05:59:18 +00001975 const ABIArgInfo &RetAI = FI.getReturnInfo();
Daniel Dunbar7a95ca32008-09-10 04:01:49 +00001976 switch (RetAI.getKind()) {
Anton Korobeynikov18adbf52009-06-06 09:36:29 +00001977 case ABIArgInfo::Extend:
Alex Bradburye41a5e22018-01-12 20:08:16 +00001978 if (RetAI.isSignExt())
Jakob Stoklund Olesend7bf2932013-05-29 03:57:23 +00001979 RetAttrs.addAttribute(llvm::Attribute::SExt);
Alex Bradburye41a5e22018-01-12 20:08:16 +00001980 else
Jakob Stoklund Olesend7bf2932013-05-29 03:57:23 +00001981 RetAttrs.addAttribute(llvm::Attribute::ZExt);
Adrian Prantlf3b3ccd2017-12-19 22:06:11 +00001982 LLVM_FALLTHROUGH;
Daniel Dunbar67dace892009-02-03 06:17:37 +00001983 case ABIArgInfo::Direct:
Jakob Stoklund Olesena3661142013-06-05 03:00:09 +00001984 if (RetAI.getInReg())
1985 RetAttrs.addAttribute(llvm::Attribute::InReg);
1986 break;
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00001987 case ABIArgInfo::Ignore:
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00001988 break;
1989
Alexey Samsonov91cf4552014-08-22 01:06:06 +00001990 case ABIArgInfo::InAlloca:
Rafael Espindola06b2b4a2012-07-31 02:44:24 +00001991 case ABIArgInfo::Indirect: {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00001992 // inalloca and sret disable readnone and readonly
Bill Wendling207f0532012-12-20 19:27:06 +00001993 FuncAttrs.removeAttribute(llvm::Attribute::ReadOnly)
1994 .removeAttribute(llvm::Attribute::ReadNone);
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00001995 break;
Rafael Espindola06b2b4a2012-07-31 02:44:24 +00001996 }
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00001997
John McCallf26e73d2016-03-11 04:30:43 +00001998 case ABIArgInfo::CoerceAndExpand:
1999 break;
2000
Daniel Dunbard3674e62008-09-11 01:48:57 +00002001 case ABIArgInfo::Expand:
David Blaikie83d382b2011-09-23 05:06:16 +00002002 llvm_unreachable("Invalid ABI kind for return argument");
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00002003 }
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00002004
Hal Finkela2347ba2014-07-18 15:52:10 +00002005 if (const auto *RefTy = RetTy->getAs<ReferenceType>()) {
2006 QualType PTy = RefTy->getPointeeType();
David Majnemer9df56372015-09-10 21:52:00 +00002007 if (!PTy->isIncompleteType() && PTy->isConstantSizeType())
Hal Finkela2347ba2014-07-18 15:52:10 +00002008 RetAttrs.addDereferenceableAttr(getContext().getTypeSizeInChars(PTy)
2009 .getQuantity());
Manoj Guptada08f6a2018-07-19 00:44:52 +00002010 else if (getContext().getTargetAddressSpace(PTy) == 0 &&
2011 !CodeGenOpts.NullPointerIsValid)
Hal Finkela2347ba2014-07-18 15:52:10 +00002012 RetAttrs.addAttribute(llvm::Attribute::NonNull);
2013 }
Nick Lewycky9b46eb82014-05-28 09:56:42 +00002014
John McCall12f23522016-04-04 18:33:08 +00002015 bool hasUsedSRet = false;
Reid Klecknercdd26792017-04-18 23:50:03 +00002016 SmallVector<llvm::AttributeSet, 4> ArgAttrs(IRFunctionArgs.totalIRArgs());
John McCall12f23522016-04-04 18:33:08 +00002017
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002018 // Attach attributes to sret.
2019 if (IRFunctionArgs.hasSRetArg()) {
2020 llvm::AttrBuilder SRETAttrs;
Mandeep Singh Grang2a153102018-07-26 18:07:59 +00002021 if (!RetAI.getSuppressSRet())
2022 SRETAttrs.addAttribute(llvm::Attribute::StructRet);
John McCall12f23522016-04-04 18:33:08 +00002023 hasUsedSRet = true;
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002024 if (RetAI.getInReg())
2025 SRETAttrs.addAttribute(llvm::Attribute::InReg);
Reid Klecknercdd26792017-04-18 23:50:03 +00002026 ArgAttrs[IRFunctionArgs.getSRetArgNo()] =
2027 llvm::AttributeSet::get(getLLVMContext(), SRETAttrs);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002028 }
2029
2030 // Attach attributes to inalloca argument.
2031 if (IRFunctionArgs.hasInallocaArg()) {
2032 llvm::AttrBuilder Attrs;
2033 Attrs.addAttribute(llvm::Attribute::InAlloca);
Reid Klecknercdd26792017-04-18 23:50:03 +00002034 ArgAttrs[IRFunctionArgs.getInallocaArgNo()] =
2035 llvm::AttributeSet::get(getLLVMContext(), Attrs);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002036 }
2037
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002038 unsigned ArgNo = 0;
2039 for (CGFunctionInfo::const_arg_iterator I = FI.arg_begin(),
2040 E = FI.arg_end();
2041 I != E; ++I, ++ArgNo) {
2042 QualType ParamType = I->type;
2043 const ABIArgInfo &AI = I->info;
Bill Wendlinga514ebc2012-10-15 20:36:26 +00002044 llvm::AttrBuilder Attrs;
Anton Korobeynikovc8478242009-04-04 00:49:24 +00002045
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002046 // Add attribute for padding argument, if necessary.
2047 if (IRFunctionArgs.hasPaddingArg(ArgNo)) {
Reid Klecknercdd26792017-04-18 23:50:03 +00002048 if (AI.getPaddingInReg()) {
2049 ArgAttrs[IRFunctionArgs.getPaddingArgNo(ArgNo)] =
2050 llvm::AttributeSet::get(
2051 getLLVMContext(),
2052 llvm::AttrBuilder().addAttribute(llvm::Attribute::InReg));
2053 }
Rafael Espindolafad28de2012-10-24 01:59:00 +00002054 }
2055
John McCall39ec71f2010-03-27 00:47:27 +00002056 // 'restrict' -> 'noalias' is done in EmitFunctionProlog when we
2057 // have the corresponding parameter variable. It doesn't make
Daniel Dunbarcb2b3d02011-02-10 18:10:07 +00002058 // sense to do it here because parameters are so messed up.
Daniel Dunbard3674e62008-09-11 01:48:57 +00002059 switch (AI.getKind()) {
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002060 case ABIArgInfo::Extend:
Alex Bradburye41a5e22018-01-12 20:08:16 +00002061 if (AI.isSignExt())
Bill Wendling207f0532012-12-20 19:27:06 +00002062 Attrs.addAttribute(llvm::Attribute::SExt);
Alex Bradburye41a5e22018-01-12 20:08:16 +00002063 else
2064 Attrs.addAttribute(llvm::Attribute::ZExt);
Adrian Prantlf3b3ccd2017-12-19 22:06:11 +00002065 LLVM_FALLTHROUGH;
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002066 case ABIArgInfo::Direct:
Peter Collingbournef7706832014-12-12 23:41:25 +00002067 if (ArgNo == 0 && FI.isChainCall())
2068 Attrs.addAttribute(llvm::Attribute::Nest);
2069 else if (AI.getInReg())
Bill Wendling207f0532012-12-20 19:27:06 +00002070 Attrs.addAttribute(llvm::Attribute::InReg);
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002071 break;
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002072
James Y Knight71608572015-08-21 18:19:06 +00002073 case ABIArgInfo::Indirect: {
Rafael Espindola703c47f2012-10-19 05:04:37 +00002074 if (AI.getInReg())
Bill Wendling207f0532012-12-20 19:27:06 +00002075 Attrs.addAttribute(llvm::Attribute::InReg);
Rafael Espindola703c47f2012-10-19 05:04:37 +00002076
Anders Carlsson20759ad2009-09-16 15:53:40 +00002077 if (AI.getIndirectByVal())
Bill Wendling207f0532012-12-20 19:27:06 +00002078 Attrs.addAttribute(llvm::Attribute::ByVal);
Anders Carlsson20759ad2009-09-16 15:53:40 +00002079
John McCall7f416cc2015-09-08 08:05:57 +00002080 CharUnits Align = AI.getIndirectAlign();
James Y Knight71608572015-08-21 18:19:06 +00002081
2082 // In a byval argument, it is important that the required
2083 // alignment of the type is honored, as LLVM might be creating a
2084 // *new* stack object, and needs to know what alignment to give
2085 // it. (Sometimes it can deduce a sensible alignment on its own,
2086 // but not if clang decides it must emit a packed struct, or the
2087 // user specifies increased alignment requirements.)
2088 //
2089 // This is different from indirect *not* byval, where the object
2090 // exists already, and the align attribute is purely
2091 // informative.
John McCall7f416cc2015-09-08 08:05:57 +00002092 assert(!Align.isZero());
James Y Knight71608572015-08-21 18:19:06 +00002093
John McCall7f416cc2015-09-08 08:05:57 +00002094 // For now, only add this when we have a byval argument.
2095 // TODO: be less lazy about updating test cases.
2096 if (AI.getIndirectByVal())
2097 Attrs.addAlignmentAttr(Align.getQuantity());
Bill Wendlinga7912f82012-10-10 07:36:56 +00002098
Daniel Dunbarc2304432009-03-18 19:51:01 +00002099 // byval disables readnone and readonly.
Bill Wendling207f0532012-12-20 19:27:06 +00002100 FuncAttrs.removeAttribute(llvm::Attribute::ReadOnly)
2101 .removeAttribute(llvm::Attribute::ReadNone);
Daniel Dunbard3674e62008-09-11 01:48:57 +00002102 break;
James Y Knight71608572015-08-21 18:19:06 +00002103 }
Daniel Dunbar94a6f252009-01-26 21:26:08 +00002104 case ABIArgInfo::Ignore:
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002105 case ABIArgInfo::Expand:
John McCallf26e73d2016-03-11 04:30:43 +00002106 case ABIArgInfo::CoerceAndExpand:
2107 break;
Daniel Dunbar94a6f252009-01-26 21:26:08 +00002108
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002109 case ABIArgInfo::InAlloca:
2110 // inalloca disables readnone and readonly.
2111 FuncAttrs.removeAttribute(llvm::Attribute::ReadOnly)
2112 .removeAttribute(llvm::Attribute::ReadNone);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002113 continue;
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00002114 }
Mike Stump11289f42009-09-09 15:08:12 +00002115
Hal Finkela2347ba2014-07-18 15:52:10 +00002116 if (const auto *RefTy = ParamType->getAs<ReferenceType>()) {
2117 QualType PTy = RefTy->getPointeeType();
David Majnemer9df56372015-09-10 21:52:00 +00002118 if (!PTy->isIncompleteType() && PTy->isConstantSizeType())
Hal Finkela2347ba2014-07-18 15:52:10 +00002119 Attrs.addDereferenceableAttr(getContext().getTypeSizeInChars(PTy)
2120 .getQuantity());
Manoj Guptada08f6a2018-07-19 00:44:52 +00002121 else if (getContext().getTargetAddressSpace(PTy) == 0 &&
2122 !CodeGenOpts.NullPointerIsValid)
Hal Finkela2347ba2014-07-18 15:52:10 +00002123 Attrs.addAttribute(llvm::Attribute::NonNull);
2124 }
Nick Lewycky9b46eb82014-05-28 09:56:42 +00002125
John McCall12f23522016-04-04 18:33:08 +00002126 switch (FI.getExtParameterInfo(ArgNo).getABI()) {
2127 case ParameterABI::Ordinary:
2128 break;
2129
2130 case ParameterABI::SwiftIndirectResult: {
2131 // Add 'sret' if we haven't already used it for something, but
2132 // only if the result is void.
2133 if (!hasUsedSRet && RetTy->isVoidType()) {
2134 Attrs.addAttribute(llvm::Attribute::StructRet);
2135 hasUsedSRet = true;
2136 }
2137
2138 // Add 'noalias' in either case.
2139 Attrs.addAttribute(llvm::Attribute::NoAlias);
2140
2141 // Add 'dereferenceable' and 'alignment'.
2142 auto PTy = ParamType->getPointeeType();
2143 if (!PTy->isIncompleteType() && PTy->isConstantSizeType()) {
2144 auto info = getContext().getTypeInfoInChars(PTy);
2145 Attrs.addDereferenceableAttr(info.first.getQuantity());
2146 Attrs.addAttribute(llvm::Attribute::getWithAlignment(getLLVMContext(),
2147 info.second.getQuantity()));
2148 }
2149 break;
2150 }
2151
2152 case ParameterABI::SwiftErrorResult:
2153 Attrs.addAttribute(llvm::Attribute::SwiftError);
2154 break;
2155
2156 case ParameterABI::SwiftContext:
2157 Attrs.addAttribute(llvm::Attribute::SwiftSelf);
2158 break;
2159 }
2160
Akira Hatanaka98a49332017-09-22 00:41:05 +00002161 if (FI.getExtParameterInfo(ArgNo).isNoEscape())
2162 Attrs.addAttribute(llvm::Attribute::NoCapture);
2163
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002164 if (Attrs.hasAttributes()) {
2165 unsigned FirstIRArg, NumIRArgs;
2166 std::tie(FirstIRArg, NumIRArgs) = IRFunctionArgs.getIRArgs(ArgNo);
2167 for (unsigned i = 0; i < NumIRArgs; i++)
Reid Klecknercdd26792017-04-18 23:50:03 +00002168 ArgAttrs[FirstIRArg + i] =
2169 llvm::AttributeSet::get(getLLVMContext(), Attrs);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002170 }
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00002171 }
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002172 assert(ArgNo == FI.arg_size());
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002173
Reid Klecknercdd26792017-04-18 23:50:03 +00002174 AttrList = llvm::AttributeList::get(
2175 getLLVMContext(), llvm::AttributeSet::get(getLLVMContext(), FuncAttrs),
2176 llvm::AttributeSet::get(getLLVMContext(), RetAttrs), ArgAttrs);
Daniel Dunbar76c8eb72008-09-10 00:32:18 +00002177}
2178
John McCalla738c252011-03-09 04:27:21 +00002179/// An argument came in as a promoted argument; demote it back to its
2180/// declared type.
2181static llvm::Value *emitArgumentDemotion(CodeGenFunction &CGF,
2182 const VarDecl *var,
2183 llvm::Value *value) {
Chris Lattner2192fe52011-07-18 04:24:23 +00002184 llvm::Type *varType = CGF.ConvertType(var->getType());
John McCalla738c252011-03-09 04:27:21 +00002185
2186 // This can happen with promotions that actually don't change the
2187 // underlying type, like the enum promotions.
2188 if (value->getType() == varType) return value;
2189
2190 assert((varType->isIntegerTy() || varType->isFloatingPointTy())
2191 && "unexpected promotion type");
2192
2193 if (isa<llvm::IntegerType>(varType))
2194 return CGF.Builder.CreateTrunc(value, varType, "arg.unpromote");
2195
2196 return CGF.Builder.CreateFPCast(value, varType, "arg.unpromote");
2197}
2198
Chandler Carruth45bbe012017-03-24 09:11:57 +00002199/// Returns the attribute (either parameter attribute, or function
2200/// attribute), which declares argument ArgNo to be non-null.
2201static const NonNullAttr *getNonNullAttr(const Decl *FD, const ParmVarDecl *PVD,
2202 QualType ArgType, unsigned ArgNo) {
2203 // FIXME: __attribute__((nonnull)) can also be applied to:
2204 // - references to pointers, where the pointee is known to be
2205 // nonnull (apparently a Clang extension)
2206 // - transparent unions containing pointers
2207 // In the former case, LLVM IR cannot represent the constraint. In
2208 // the latter case, we have no guarantee that the transparent union
2209 // is in fact passed as a pointer.
2210 if (!ArgType->isAnyPointerType() && !ArgType->isBlockPointerType())
2211 return nullptr;
2212 // First, check attribute on parameter itself.
2213 if (PVD) {
2214 if (auto ParmNNAttr = PVD->getAttr<NonNullAttr>())
2215 return ParmNNAttr;
2216 }
2217 // Check function attributes.
2218 if (!FD)
2219 return nullptr;
2220 for (const auto *NNAttr : FD->specific_attrs<NonNullAttr>()) {
2221 if (NNAttr->isNonNull(ArgNo))
2222 return NNAttr;
2223 }
2224 return nullptr;
2225}
2226
John McCall12f23522016-04-04 18:33:08 +00002227namespace {
2228 struct CopyBackSwiftError final : EHScopeStack::Cleanup {
2229 Address Temp;
2230 Address Arg;
2231 CopyBackSwiftError(Address temp, Address arg) : Temp(temp), Arg(arg) {}
2232 void Emit(CodeGenFunction &CGF, Flags flags) override {
2233 llvm::Value *errorValue = CGF.Builder.CreateLoad(Temp);
2234 CGF.Builder.CreateStore(errorValue, Arg);
2235 }
2236 };
2237}
2238
Daniel Dunbard931a872009-02-02 22:03:45 +00002239void CodeGenFunction::EmitFunctionProlog(const CGFunctionInfo &FI,
2240 llvm::Function *Fn,
Daniel Dunbar613855c2008-09-09 23:27:19 +00002241 const FunctionArgList &Args) {
Hans Wennborgd71907d2014-09-04 22:16:33 +00002242 if (CurCodeDecl && CurCodeDecl->hasAttr<NakedAttr>())
2243 // Naked functions don't have prologues.
2244 return;
2245
John McCallcaa19452009-07-28 01:00:58 +00002246 // If this is an implicit-return-zero function, go ahead and
2247 // initialize the return value. TODO: it might be nice to have
2248 // a more general mechanism for this that didn't require synthesized
2249 // return statements.
John McCalldec348f72013-05-03 07:33:41 +00002250 if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(CurCodeDecl)) {
John McCallcaa19452009-07-28 01:00:58 +00002251 if (FD->hasImplicitReturnZero()) {
Alp Toker314cc812014-01-25 16:55:45 +00002252 QualType RetTy = FD->getReturnType().getUnqualifiedType();
Chris Lattner2192fe52011-07-18 04:24:23 +00002253 llvm::Type* LLVMTy = CGM.getTypes().ConvertType(RetTy);
Owen Anderson0b75f232009-07-31 20:28:54 +00002254 llvm::Constant* Zero = llvm::Constant::getNullValue(LLVMTy);
John McCallcaa19452009-07-28 01:00:58 +00002255 Builder.CreateStore(Zero, ReturnValue);
2256 }
2257 }
2258
Mike Stump18bb9282009-05-16 07:57:57 +00002259 // FIXME: We no longer need the types from FunctionArgList; lift up and
2260 // simplify.
Daniel Dunbar5a0acdc92009-02-03 06:02:10 +00002261
Alexey Samsonov153004f2014-09-29 22:08:00 +00002262 ClangToLLVMArgMapping IRFunctionArgs(CGM.getContext(), FI);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002263 // Flattened function arguments.
John McCall12f23522016-04-04 18:33:08 +00002264 SmallVector<llvm::Value *, 16> FnArgs;
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002265 FnArgs.reserve(IRFunctionArgs.totalIRArgs());
2266 for (auto &Arg : Fn->args()) {
2267 FnArgs.push_back(&Arg);
2268 }
2269 assert(FnArgs.size() == IRFunctionArgs.totalIRArgs());
Mike Stump11289f42009-09-09 15:08:12 +00002270
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002271 // If we're using inalloca, all the memory arguments are GEPs off of the last
2272 // parameter, which is a pointer to the complete memory area.
John McCall7f416cc2015-09-08 08:05:57 +00002273 Address ArgStruct = Address::invalid();
2274 const llvm::StructLayout *ArgStructLayout = nullptr;
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002275 if (IRFunctionArgs.hasInallocaArg()) {
John McCall7f416cc2015-09-08 08:05:57 +00002276 ArgStructLayout = CGM.getDataLayout().getStructLayout(FI.getArgStruct());
2277 ArgStruct = Address(FnArgs[IRFunctionArgs.getInallocaArgNo()],
2278 FI.getArgStructAlignment());
2279
2280 assert(ArgStruct.getType() == FI.getArgStruct()->getPointerTo());
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002281 }
2282
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002283 // Name the struct return parameter.
2284 if (IRFunctionArgs.hasSRetArg()) {
John McCall12f23522016-04-04 18:33:08 +00002285 auto AI = cast<llvm::Argument>(FnArgs[IRFunctionArgs.getSRetArgNo()]);
Daniel Dunbar613855c2008-09-09 23:27:19 +00002286 AI->setName("agg.result");
Reid Klecknercdd26792017-04-18 23:50:03 +00002287 AI->addAttr(llvm::Attribute::NoAlias);
Daniel Dunbar613855c2008-09-09 23:27:19 +00002288 }
Mike Stump11289f42009-09-09 15:08:12 +00002289
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002290 // Track if we received the parameter as a pointer (indirect, byval, or
2291 // inalloca). If already have a pointer, EmitParmDecl doesn't need to copy it
2292 // into a local alloca for us.
John McCall7f416cc2015-09-08 08:05:57 +00002293 SmallVector<ParamValue, 16> ArgVals;
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002294 ArgVals.reserve(Args.size());
2295
Reid Kleckner739756c2013-12-04 19:23:12 +00002296 // Create a pointer value for every parameter declaration. This usually
2297 // entails copying one or more LLVM IR arguments into an alloca. Don't push
2298 // any cleanups or do anything that might unwind. We do that separately, so
2299 // we can push the cleanups in the correct order for the ABI.
Daniel Dunbara45bdbb2009-02-04 21:17:21 +00002300 assert(FI.arg_size() == Args.size() &&
2301 "Mismatch between function signature & arguments.");
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002302 unsigned ArgNo = 0;
Daniel Dunbarb52d0772009-02-03 05:59:18 +00002303 CGFunctionInfo::const_arg_iterator info_it = FI.arg_begin();
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002304 for (FunctionArgList::const_iterator i = Args.begin(), e = Args.end();
Devang Patel68a15252011-03-03 20:13:15 +00002305 i != e; ++i, ++info_it, ++ArgNo) {
John McCalla738c252011-03-09 04:27:21 +00002306 const VarDecl *Arg = *i;
Daniel Dunbarb52d0772009-02-03 05:59:18 +00002307 const ABIArgInfo &ArgI = info_it->info;
Daniel Dunbard3674e62008-09-11 01:48:57 +00002308
John McCalla738c252011-03-09 04:27:21 +00002309 bool isPromoted =
2310 isa<ParmVarDecl>(Arg) && cast<ParmVarDecl>(Arg)->isKNRPromoted();
Volodymyr Sapsai17ebdb22018-01-22 22:29:24 +00002311 // We are converting from ABIArgInfo type to VarDecl type directly, unless
2312 // the parameter is promoted. In this case we convert to
2313 // CGFunctionInfo::ArgInfo type with subsequent argument demotion.
2314 QualType Ty = isPromoted ? info_it->type : Arg->getType();
2315 assert(hasScalarEvaluationKind(Ty) ==
2316 hasScalarEvaluationKind(Arg->getType()));
John McCalla738c252011-03-09 04:27:21 +00002317
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002318 unsigned FirstIRArg, NumIRArgs;
2319 std::tie(FirstIRArg, NumIRArgs) = IRFunctionArgs.getIRArgs(ArgNo);
Rafael Espindolafad28de2012-10-24 01:59:00 +00002320
Daniel Dunbard3674e62008-09-11 01:48:57 +00002321 switch (ArgI.getKind()) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002322 case ABIArgInfo::InAlloca: {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002323 assert(NumIRArgs == 0);
John McCall7f416cc2015-09-08 08:05:57 +00002324 auto FieldIndex = ArgI.getInAllocaFieldIndex();
2325 CharUnits FieldOffset =
2326 CharUnits::fromQuantity(ArgStructLayout->getElementOffset(FieldIndex));
2327 Address V = Builder.CreateStructGEP(ArgStruct, FieldIndex, FieldOffset,
2328 Arg->getName());
2329 ArgVals.push_back(ParamValue::forIndirect(V));
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002330 break;
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002331 }
2332
Daniel Dunbar747865a2009-02-05 09:16:39 +00002333 case ABIArgInfo::Indirect: {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002334 assert(NumIRArgs == 1);
John McCall7f416cc2015-09-08 08:05:57 +00002335 Address ParamAddr = Address(FnArgs[FirstIRArg], ArgI.getIndirectAlign());
Daniel Dunbar7b7c2932010-09-16 20:42:02 +00002336
John McCall47fb9502013-03-07 21:37:08 +00002337 if (!hasScalarEvaluationKind(Ty)) {
Daniel Dunbar7b7c2932010-09-16 20:42:02 +00002338 // Aggregates and complex variables are accessed by reference. All we
John McCall7f416cc2015-09-08 08:05:57 +00002339 // need to do is realign the value, if requested.
2340 Address V = ParamAddr;
Daniel Dunbar7b7c2932010-09-16 20:42:02 +00002341 if (ArgI.getIndirectRealign()) {
John McCall7f416cc2015-09-08 08:05:57 +00002342 Address AlignedTemp = CreateMemTemp(Ty, "coerce");
Daniel Dunbar7b7c2932010-09-16 20:42:02 +00002343
2344 // Copy from the incoming argument pointer to the temporary with the
2345 // appropriate alignment.
2346 //
2347 // FIXME: We should have a common utility for generating an aggregate
2348 // copy.
Ken Dyck705ba072011-01-19 01:58:38 +00002349 CharUnits Size = getContext().getTypeSizeInChars(Ty);
John McCall7f416cc2015-09-08 08:05:57 +00002350 auto SizeVal = llvm::ConstantInt::get(IntPtrTy, Size.getQuantity());
2351 Address Dst = Builder.CreateBitCast(AlignedTemp, Int8PtrTy);
2352 Address Src = Builder.CreateBitCast(ParamAddr, Int8PtrTy);
2353 Builder.CreateMemCpy(Dst, Src, SizeVal, false);
Daniel Dunbar7b7c2932010-09-16 20:42:02 +00002354 V = AlignedTemp;
2355 }
John McCall7f416cc2015-09-08 08:05:57 +00002356 ArgVals.push_back(ParamValue::forIndirect(V));
Daniel Dunbar747865a2009-02-05 09:16:39 +00002357 } else {
2358 // Load scalar value from indirect argument.
John McCall7f416cc2015-09-08 08:05:57 +00002359 llvm::Value *V =
Stephen Kellyf2ceec42018-08-09 21:08:08 +00002360 EmitLoadOfScalar(ParamAddr, false, Ty, Arg->getBeginLoc());
John McCalla738c252011-03-09 04:27:21 +00002361
2362 if (isPromoted)
2363 V = emitArgumentDemotion(*this, Arg, V);
John McCall7f416cc2015-09-08 08:05:57 +00002364 ArgVals.push_back(ParamValue::forDirect(V));
Daniel Dunbar747865a2009-02-05 09:16:39 +00002365 }
Daniel Dunbar747865a2009-02-05 09:16:39 +00002366 break;
2367 }
Anton Korobeynikov18adbf52009-06-06 09:36:29 +00002368
2369 case ABIArgInfo::Extend:
Daniel Dunbar67dace892009-02-03 06:17:37 +00002370 case ABIArgInfo::Direct: {
Akira Hatanaka18334dd2012-01-09 19:08:06 +00002371
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002372 // If we have the trivial case, handle it with no muss and fuss.
2373 if (!isa<llvm::StructType>(ArgI.getCoerceToType()) &&
Volodymyr Sapsai22b00ec2017-12-21 20:52:59 +00002374 ArgI.getCoerceToType() == ConvertType(Ty) &&
Chris Lattner8a2f3c72010-07-30 04:02:24 +00002375 ArgI.getDirectOffset() == 0) {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002376 assert(NumIRArgs == 1);
John McCall12f23522016-04-04 18:33:08 +00002377 llvm::Value *V = FnArgs[FirstIRArg];
2378 auto AI = cast<llvm::Argument>(V);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002379
Hal Finkel48d53e22014-07-19 01:41:07 +00002380 if (const ParmVarDecl *PVD = dyn_cast<ParmVarDecl>(Arg)) {
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00002381 if (getNonNullAttr(CurCodeDecl, PVD, PVD->getType(),
Manoj Guptada08f6a2018-07-19 00:44:52 +00002382 PVD->getFunctionScopeIndex()) &&
2383 !CGM.getCodeGenOpts().NullPointerIsValid)
Reid Klecknercdd26792017-04-18 23:50:03 +00002384 AI->addAttr(llvm::Attribute::NonNull);
Hal Finkel82504f02014-07-11 17:35:21 +00002385
Hal Finkel48d53e22014-07-19 01:41:07 +00002386 QualType OTy = PVD->getOriginalType();
2387 if (const auto *ArrTy =
2388 getContext().getAsConstantArrayType(OTy)) {
2389 // A C99 array parameter declaration with the static keyword also
2390 // indicates dereferenceability, and if the size is constant we can
2391 // use the dereferenceable attribute (which requires the size in
2392 // bytes).
Hal Finkel16e394a2014-07-19 02:13:40 +00002393 if (ArrTy->getSizeModifier() == ArrayType::Static) {
Hal Finkel48d53e22014-07-19 01:41:07 +00002394 QualType ETy = ArrTy->getElementType();
2395 uint64_t ArrSize = ArrTy->getSize().getZExtValue();
2396 if (!ETy->isIncompleteType() && ETy->isConstantSizeType() &&
2397 ArrSize) {
2398 llvm::AttrBuilder Attrs;
2399 Attrs.addDereferenceableAttr(
2400 getContext().getTypeSizeInChars(ETy).getQuantity()*ArrSize);
Reid Kleckner9d16fa02017-04-19 17:28:52 +00002401 AI->addAttrs(Attrs);
Manoj Guptada08f6a2018-07-19 00:44:52 +00002402 } else if (getContext().getTargetAddressSpace(ETy) == 0 &&
2403 !CGM.getCodeGenOpts().NullPointerIsValid) {
Reid Klecknercdd26792017-04-18 23:50:03 +00002404 AI->addAttr(llvm::Attribute::NonNull);
Hal Finkel48d53e22014-07-19 01:41:07 +00002405 }
2406 }
2407 } else if (const auto *ArrTy =
2408 getContext().getAsVariableArrayType(OTy)) {
2409 // For C99 VLAs with the static keyword, we don't know the size so
2410 // we can't use the dereferenceable attribute, but in addrspace(0)
2411 // we know that it must be nonnull.
2412 if (ArrTy->getSizeModifier() == VariableArrayType::Static &&
Manoj Guptada08f6a2018-07-19 00:44:52 +00002413 !getContext().getTargetAddressSpace(ArrTy->getElementType()) &&
2414 !CGM.getCodeGenOpts().NullPointerIsValid)
Reid Klecknercdd26792017-04-18 23:50:03 +00002415 AI->addAttr(llvm::Attribute::NonNull);
Hal Finkel48d53e22014-07-19 01:41:07 +00002416 }
Hal Finkel1b0d24e2014-10-02 21:21:25 +00002417
2418 const auto *AVAttr = PVD->getAttr<AlignValueAttr>();
2419 if (!AVAttr)
2420 if (const auto *TOTy = dyn_cast<TypedefType>(OTy))
2421 AVAttr = TOTy->getDecl()->getAttr<AlignValueAttr>();
Roman Lebedevbd1c0872019-01-15 09:44:25 +00002422 if (AVAttr && !SanOpts.has(SanitizerKind::Alignment)) {
2423 // If alignment-assumption sanitizer is enabled, we do *not* add
2424 // alignment attribute here, but emit normal alignment assumption,
2425 // so the UBSAN check could function.
Hal Finkel1b0d24e2014-10-02 21:21:25 +00002426 llvm::Value *AlignmentValue =
2427 EmitScalarExpr(AVAttr->getAlignment());
2428 llvm::ConstantInt *AlignmentCI =
2429 cast<llvm::ConstantInt>(AlignmentValue);
Reid Kleckner9d16fa02017-04-19 17:28:52 +00002430 unsigned Alignment = std::min((unsigned)AlignmentCI->getZExtValue(),
2431 +llvm::Value::MaximumAlignment);
2432 AI->addAttrs(llvm::AttrBuilder().addAlignmentAttr(Alignment));
Hal Finkel1b0d24e2014-10-02 21:21:25 +00002433 }
Hal Finkel48d53e22014-07-19 01:41:07 +00002434 }
2435
Bill Wendling507c3512012-10-16 05:23:44 +00002436 if (Arg->getType().isRestrictQualified())
Reid Klecknercdd26792017-04-18 23:50:03 +00002437 AI->addAttr(llvm::Attribute::NoAlias);
John McCall39ec71f2010-03-27 00:47:27 +00002438
John McCall12f23522016-04-04 18:33:08 +00002439 // LLVM expects swifterror parameters to be used in very restricted
2440 // ways. Copy the value into a less-restricted temporary.
2441 if (FI.getExtParameterInfo(ArgNo).getABI()
2442 == ParameterABI::SwiftErrorResult) {
2443 QualType pointeeTy = Ty->getPointeeType();
2444 assert(pointeeTy->isPointerType());
2445 Address temp =
2446 CreateMemTemp(pointeeTy, getPointerAlign(), "swifterror.temp");
2447 Address arg = Address(V, getContext().getTypeAlignInChars(pointeeTy));
2448 llvm::Value *incomingErrorValue = Builder.CreateLoad(arg);
2449 Builder.CreateStore(incomingErrorValue, temp);
2450 V = temp.getPointer();
2451
2452 // Push a cleanup to copy the value back at the end of the function.
2453 // The convention does not guarantee that the value will be written
2454 // back if the function exits with an unwind exception.
2455 EHStack.pushCleanup<CopyBackSwiftError>(NormalCleanup, temp, arg);
2456 }
2457
Chris Lattner7369c142011-07-20 06:29:00 +00002458 // Ensure the argument is the correct type.
2459 if (V->getType() != ArgI.getCoerceToType())
2460 V = Builder.CreateBitCast(V, ArgI.getCoerceToType());
2461
John McCalla738c252011-03-09 04:27:21 +00002462 if (isPromoted)
2463 V = emitArgumentDemotion(*this, Arg, V);
Rafael Espindola8778c282012-11-29 16:09:03 +00002464
2465 // Because of merging of function types from multiple decls it is
2466 // possible for the type of an argument to not match the corresponding
2467 // type in the function type. Since we are codegening the callee
2468 // in here, add a cast to the argument type.
2469 llvm::Type *LTy = ConvertType(Arg->getType());
2470 if (V->getType() != LTy)
2471 V = Builder.CreateBitCast(V, LTy);
2472
John McCall7f416cc2015-09-08 08:05:57 +00002473 ArgVals.push_back(ParamValue::forDirect(V));
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002474 break;
Daniel Dunbard5f1f552009-02-10 00:06:49 +00002475 }
Mike Stump11289f42009-09-09 15:08:12 +00002476
Volodymyr Sapsai22b00ec2017-12-21 20:52:59 +00002477 Address Alloca = CreateMemTemp(Ty, getContext().getDeclAlign(Arg),
2478 Arg->getName());
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002479
John McCall7f416cc2015-09-08 08:05:57 +00002480 // Pointer to store into.
2481 Address Ptr = emitAddressAtOffset(*this, Alloca, ArgI);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002482
Oliver Stannard2bfdc5b2014-08-27 10:43:15 +00002483 // Fast-isel and the optimizer generally like scalar values better than
2484 // FCAs, so we flatten them if this is safe to do for this argument.
Evgeniy Stepanov3fae4ae2012-02-10 09:30:15 +00002485 llvm::StructType *STy = dyn_cast<llvm::StructType>(ArgI.getCoerceToType());
Oliver Stannard2bfdc5b2014-08-27 10:43:15 +00002486 if (ArgI.isDirect() && ArgI.getCanBeFlattened() && STy &&
2487 STy->getNumElements() > 1) {
John McCall7f416cc2015-09-08 08:05:57 +00002488 auto SrcLayout = CGM.getDataLayout().getStructLayout(STy);
Micah Villmowdd31ca12012-10-08 16:25:52 +00002489 uint64_t SrcSize = CGM.getDataLayout().getTypeAllocSize(STy);
John McCall7f416cc2015-09-08 08:05:57 +00002490 llvm::Type *DstTy = Ptr.getElementType();
Micah Villmowdd31ca12012-10-08 16:25:52 +00002491 uint64_t DstSize = CGM.getDataLayout().getTypeAllocSize(DstTy);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002492
John McCall7f416cc2015-09-08 08:05:57 +00002493 Address AddrToStoreInto = Address::invalid();
Evgeniy Stepanov3fae4ae2012-02-10 09:30:15 +00002494 if (SrcSize <= DstSize) {
Yaxun Liue9e5c4f2017-06-29 18:47:45 +00002495 AddrToStoreInto = Builder.CreateElementBitCast(Ptr, STy);
Evgeniy Stepanov3fae4ae2012-02-10 09:30:15 +00002496 } else {
John McCall7f416cc2015-09-08 08:05:57 +00002497 AddrToStoreInto =
2498 CreateTempAlloca(STy, Alloca.getAlignment(), "coerce");
Chris Lattner15ec3612010-06-29 00:06:42 +00002499 }
John McCall7f416cc2015-09-08 08:05:57 +00002500
2501 assert(STy->getNumElements() == NumIRArgs);
2502 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
2503 auto AI = FnArgs[FirstIRArg + i];
2504 AI->setName(Arg->getName() + ".coerce" + Twine(i));
2505 auto Offset = CharUnits::fromQuantity(SrcLayout->getElementOffset(i));
2506 Address EltPtr =
2507 Builder.CreateStructGEP(AddrToStoreInto, i, Offset);
2508 Builder.CreateStore(AI, EltPtr);
2509 }
2510
2511 if (SrcSize > DstSize) {
2512 Builder.CreateMemCpy(Ptr, AddrToStoreInto, DstSize);
2513 }
2514
Chris Lattner15ec3612010-06-29 00:06:42 +00002515 } else {
2516 // Simple case, just do a coerced store of the argument into the alloca.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002517 assert(NumIRArgs == 1);
2518 auto AI = FnArgs[FirstIRArg];
Chris Lattner9e748e92010-06-29 00:14:52 +00002519 AI->setName(Arg->getName() + ".coerce");
John McCall7f416cc2015-09-08 08:05:57 +00002520 CreateCoercedStore(AI, Ptr, /*DestIsVolatile=*/false, *this);
Chris Lattner15ec3612010-06-29 00:06:42 +00002521 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002522
Daniel Dunbar2f219b02009-02-03 19:12:28 +00002523 // Match to what EmitParmDecl is expecting for this type.
Volodymyr Sapsai22b00ec2017-12-21 20:52:59 +00002524 if (CodeGenFunction::hasScalarEvaluationKind(Ty)) {
John McCall7f416cc2015-09-08 08:05:57 +00002525 llvm::Value *V =
Stephen Kellyf2ceec42018-08-09 21:08:08 +00002526 EmitLoadOfScalar(Alloca, false, Ty, Arg->getBeginLoc());
John McCalla738c252011-03-09 04:27:21 +00002527 if (isPromoted)
2528 V = emitArgumentDemotion(*this, Arg, V);
John McCall7f416cc2015-09-08 08:05:57 +00002529 ArgVals.push_back(ParamValue::forDirect(V));
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002530 } else {
John McCall7f416cc2015-09-08 08:05:57 +00002531 ArgVals.push_back(ParamValue::forIndirect(Alloca));
Daniel Dunbar6e3b7df2009-02-04 07:22:24 +00002532 }
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002533 break;
Daniel Dunbar2f219b02009-02-03 19:12:28 +00002534 }
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002535
John McCallf26e73d2016-03-11 04:30:43 +00002536 case ABIArgInfo::CoerceAndExpand: {
2537 // Reconstruct into a temporary.
2538 Address alloca = CreateMemTemp(Ty, getContext().getDeclAlign(Arg));
2539 ArgVals.push_back(ParamValue::forIndirect(alloca));
2540
2541 auto coercionType = ArgI.getCoerceAndExpandType();
2542 alloca = Builder.CreateElementBitCast(alloca, coercionType);
2543 auto layout = CGM.getDataLayout().getStructLayout(coercionType);
2544
2545 unsigned argIndex = FirstIRArg;
2546 for (unsigned i = 0, e = coercionType->getNumElements(); i != e; ++i) {
2547 llvm::Type *eltType = coercionType->getElementType(i);
2548 if (ABIArgInfo::isPaddingForCoerceAndExpand(eltType))
2549 continue;
2550
2551 auto eltAddr = Builder.CreateStructGEP(alloca, i, layout);
2552 auto elt = FnArgs[argIndex++];
2553 Builder.CreateStore(elt, eltAddr);
2554 }
2555 assert(argIndex == FirstIRArg + NumIRArgs);
2556 break;
2557 }
2558
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002559 case ABIArgInfo::Expand: {
2560 // If this structure was expanded into multiple arguments then
2561 // we need to create a temporary and reconstruct it from the
2562 // arguments.
John McCall7f416cc2015-09-08 08:05:57 +00002563 Address Alloca = CreateMemTemp(Ty, getContext().getDeclAlign(Arg));
2564 LValue LV = MakeAddrLValue(Alloca, Ty);
2565 ArgVals.push_back(ParamValue::forIndirect(Alloca));
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002566
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002567 auto FnArgIter = FnArgs.begin() + FirstIRArg;
2568 ExpandTypeFromArgs(Ty, LV, FnArgIter);
2569 assert(FnArgIter == FnArgs.begin() + FirstIRArg + NumIRArgs);
2570 for (unsigned i = 0, e = NumIRArgs; i != e; ++i) {
2571 auto AI = FnArgs[FirstIRArg + i];
2572 AI->setName(Arg->getName() + "." + Twine(i));
2573 }
2574 break;
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002575 }
2576
2577 case ABIArgInfo::Ignore:
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002578 assert(NumIRArgs == 0);
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002579 // Initialize the local variable appropriately.
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002580 if (!hasScalarEvaluationKind(Ty)) {
John McCall7f416cc2015-09-08 08:05:57 +00002581 ArgVals.push_back(ParamValue::forIndirect(CreateMemTemp(Ty)));
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002582 } else {
2583 llvm::Value *U = llvm::UndefValue::get(ConvertType(Arg->getType()));
John McCall7f416cc2015-09-08 08:05:57 +00002584 ArgVals.push_back(ParamValue::forDirect(U));
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002585 }
Alexey Samsonov91cf4552014-08-22 01:06:06 +00002586 break;
Daniel Dunbard3674e62008-09-11 01:48:57 +00002587 }
Daniel Dunbar613855c2008-09-09 23:27:19 +00002588 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002589
Reid Kleckner739756c2013-12-04 19:23:12 +00002590 if (getTarget().getCXXABI().areArgsDestroyedLeftToRightInCallee()) {
2591 for (int I = Args.size() - 1; I >= 0; --I)
John McCall7f416cc2015-09-08 08:05:57 +00002592 EmitParmDecl(*Args[I], ArgVals[I], I + 1);
Reid Kleckner739756c2013-12-04 19:23:12 +00002593 } else {
2594 for (unsigned I = 0, E = Args.size(); I != E; ++I)
John McCall7f416cc2015-09-08 08:05:57 +00002595 EmitParmDecl(*Args[I], ArgVals[I], I + 1);
Reid Kleckner739756c2013-12-04 19:23:12 +00002596 }
Daniel Dunbar613855c2008-09-09 23:27:19 +00002597}
2598
John McCallffa2c1a2012-01-29 07:46:59 +00002599static void eraseUnusedBitCasts(llvm::Instruction *insn) {
2600 while (insn->use_empty()) {
2601 llvm::BitCastInst *bitcast = dyn_cast<llvm::BitCastInst>(insn);
2602 if (!bitcast) return;
2603
2604 // This is "safe" because we would have used a ConstantExpr otherwise.
2605 insn = cast<llvm::Instruction>(bitcast->getOperand(0));
2606 bitcast->eraseFromParent();
2607 }
2608}
2609
John McCall31168b02011-06-15 23:02:42 +00002610/// Try to emit a fused autorelease of a return result.
2611static llvm::Value *tryEmitFusedAutoreleaseOfResult(CodeGenFunction &CGF,
2612 llvm::Value *result) {
2613 // We must be immediately followed the cast.
2614 llvm::BasicBlock *BB = CGF.Builder.GetInsertBlock();
Craig Topper8a13c412014-05-21 05:09:00 +00002615 if (BB->empty()) return nullptr;
2616 if (&BB->back() != result) return nullptr;
John McCall31168b02011-06-15 23:02:42 +00002617
Chris Lattner2192fe52011-07-18 04:24:23 +00002618 llvm::Type *resultType = result->getType();
John McCall31168b02011-06-15 23:02:42 +00002619
2620 // result is in a BasicBlock and is therefore an Instruction.
2621 llvm::Instruction *generator = cast<llvm::Instruction>(result);
2622
Justin Bogner882f8612016-08-18 21:46:54 +00002623 SmallVector<llvm::Instruction *, 4> InstsToKill;
John McCall31168b02011-06-15 23:02:42 +00002624
2625 // Look for:
2626 // %generator = bitcast %type1* %generator2 to %type2*
2627 while (llvm::BitCastInst *bitcast = dyn_cast<llvm::BitCastInst>(generator)) {
2628 // We would have emitted this as a constant if the operand weren't
2629 // an Instruction.
2630 generator = cast<llvm::Instruction>(bitcast->getOperand(0));
2631
2632 // Require the generator to be immediately followed by the cast.
2633 if (generator->getNextNode() != bitcast)
Craig Topper8a13c412014-05-21 05:09:00 +00002634 return nullptr;
John McCall31168b02011-06-15 23:02:42 +00002635
Justin Bogner882f8612016-08-18 21:46:54 +00002636 InstsToKill.push_back(bitcast);
John McCall31168b02011-06-15 23:02:42 +00002637 }
2638
2639 // Look for:
2640 // %generator = call i8* @objc_retain(i8* %originalResult)
2641 // or
2642 // %generator = call i8* @objc_retainAutoreleasedReturnValue(i8* %originalResult)
2643 llvm::CallInst *call = dyn_cast<llvm::CallInst>(generator);
Craig Topper8a13c412014-05-21 05:09:00 +00002644 if (!call) return nullptr;
John McCall31168b02011-06-15 23:02:42 +00002645
2646 bool doRetainAutorelease;
2647
John McCallb04ecb72015-10-21 18:06:43 +00002648 if (call->getCalledValue() == CGF.CGM.getObjCEntrypoints().objc_retain) {
John McCall31168b02011-06-15 23:02:42 +00002649 doRetainAutorelease = true;
John McCallb04ecb72015-10-21 18:06:43 +00002650 } else if (call->getCalledValue() == CGF.CGM.getObjCEntrypoints()
John McCall31168b02011-06-15 23:02:42 +00002651 .objc_retainAutoreleasedReturnValue) {
2652 doRetainAutorelease = false;
2653
John McCallcfa4e9b2012-09-07 23:30:50 +00002654 // If we emitted an assembly marker for this call (and the
2655 // ARCEntrypoints field should have been set if so), go looking
2656 // for that call. If we can't find it, we can't do this
2657 // optimization. But it should always be the immediately previous
2658 // instruction, unless we needed bitcasts around the call.
John McCallb04ecb72015-10-21 18:06:43 +00002659 if (CGF.CGM.getObjCEntrypoints().retainAutoreleasedReturnValueMarker) {
John McCallcfa4e9b2012-09-07 23:30:50 +00002660 llvm::Instruction *prev = call->getPrevNode();
2661 assert(prev);
2662 if (isa<llvm::BitCastInst>(prev)) {
2663 prev = prev->getPrevNode();
2664 assert(prev);
2665 }
2666 assert(isa<llvm::CallInst>(prev));
2667 assert(cast<llvm::CallInst>(prev)->getCalledValue() ==
John McCallb04ecb72015-10-21 18:06:43 +00002668 CGF.CGM.getObjCEntrypoints().retainAutoreleasedReturnValueMarker);
Justin Bogner882f8612016-08-18 21:46:54 +00002669 InstsToKill.push_back(prev);
John McCallcfa4e9b2012-09-07 23:30:50 +00002670 }
John McCall31168b02011-06-15 23:02:42 +00002671 } else {
Craig Topper8a13c412014-05-21 05:09:00 +00002672 return nullptr;
John McCall31168b02011-06-15 23:02:42 +00002673 }
2674
2675 result = call->getArgOperand(0);
Justin Bogner882f8612016-08-18 21:46:54 +00002676 InstsToKill.push_back(call);
John McCall31168b02011-06-15 23:02:42 +00002677
2678 // Keep killing bitcasts, for sanity. Note that we no longer care
2679 // about precise ordering as long as there's exactly one use.
2680 while (llvm::BitCastInst *bitcast = dyn_cast<llvm::BitCastInst>(result)) {
2681 if (!bitcast->hasOneUse()) break;
Justin Bogner882f8612016-08-18 21:46:54 +00002682 InstsToKill.push_back(bitcast);
John McCall31168b02011-06-15 23:02:42 +00002683 result = bitcast->getOperand(0);
2684 }
2685
2686 // Delete all the unnecessary instructions, from latest to earliest.
Justin Bogner882f8612016-08-18 21:46:54 +00002687 for (auto *I : InstsToKill)
Saleem Abdulrasoolbe25c482016-08-18 21:40:06 +00002688 I->eraseFromParent();
John McCall31168b02011-06-15 23:02:42 +00002689
2690 // Do the fused retain/autorelease if we were asked to.
2691 if (doRetainAutorelease)
2692 result = CGF.EmitARCRetainAutoreleaseReturnValue(result);
2693
2694 // Cast back to the result type.
2695 return CGF.Builder.CreateBitCast(result, resultType);
2696}
2697
John McCallffa2c1a2012-01-29 07:46:59 +00002698/// If this is a +1 of the value of an immutable 'self', remove it.
2699static llvm::Value *tryRemoveRetainOfSelf(CodeGenFunction &CGF,
2700 llvm::Value *result) {
2701 // This is only applicable to a method with an immutable 'self'.
John McCallff755cd2012-07-31 00:33:55 +00002702 const ObjCMethodDecl *method =
2703 dyn_cast_or_null<ObjCMethodDecl>(CGF.CurCodeDecl);
Craig Topper8a13c412014-05-21 05:09:00 +00002704 if (!method) return nullptr;
John McCallffa2c1a2012-01-29 07:46:59 +00002705 const VarDecl *self = method->getSelfDecl();
Craig Topper8a13c412014-05-21 05:09:00 +00002706 if (!self->getType().isConstQualified()) return nullptr;
John McCallffa2c1a2012-01-29 07:46:59 +00002707
2708 // Look for a retain call.
2709 llvm::CallInst *retainCall =
2710 dyn_cast<llvm::CallInst>(result->stripPointerCasts());
2711 if (!retainCall ||
John McCallb04ecb72015-10-21 18:06:43 +00002712 retainCall->getCalledValue() != CGF.CGM.getObjCEntrypoints().objc_retain)
Craig Topper8a13c412014-05-21 05:09:00 +00002713 return nullptr;
John McCallffa2c1a2012-01-29 07:46:59 +00002714
2715 // Look for an ordinary load of 'self'.
2716 llvm::Value *retainedValue = retainCall->getArgOperand(0);
2717 llvm::LoadInst *load =
2718 dyn_cast<llvm::LoadInst>(retainedValue->stripPointerCasts());
Fangrui Song6907ce22018-07-30 19:24:48 +00002719 if (!load || load->isAtomic() || load->isVolatile() ||
John McCall7f416cc2015-09-08 08:05:57 +00002720 load->getPointerOperand() != CGF.GetAddrOfLocalVar(self).getPointer())
Craig Topper8a13c412014-05-21 05:09:00 +00002721 return nullptr;
John McCallffa2c1a2012-01-29 07:46:59 +00002722
2723 // Okay! Burn it all down. This relies for correctness on the
2724 // assumption that the retain is emitted as part of the return and
2725 // that thereafter everything is used "linearly".
2726 llvm::Type *resultType = result->getType();
2727 eraseUnusedBitCasts(cast<llvm::Instruction>(result));
2728 assert(retainCall->use_empty());
2729 retainCall->eraseFromParent();
2730 eraseUnusedBitCasts(cast<llvm::Instruction>(retainedValue));
2731
2732 return CGF.Builder.CreateBitCast(load, resultType);
2733}
2734
John McCall31168b02011-06-15 23:02:42 +00002735/// Emit an ARC autorelease of the result of a function.
John McCallffa2c1a2012-01-29 07:46:59 +00002736///
2737/// \return the value to actually return from the function
John McCall31168b02011-06-15 23:02:42 +00002738static llvm::Value *emitAutoreleaseOfResult(CodeGenFunction &CGF,
2739 llvm::Value *result) {
John McCallffa2c1a2012-01-29 07:46:59 +00002740 // If we're returning 'self', kill the initial retain. This is a
2741 // heuristic attempt to "encourage correctness" in the really unfortunate
2742 // case where we have a return of self during a dealloc and we desperately
2743 // need to avoid the possible autorelease.
2744 if (llvm::Value *self = tryRemoveRetainOfSelf(CGF, result))
2745 return self;
2746
John McCall31168b02011-06-15 23:02:42 +00002747 // At -O0, try to emit a fused retain/autorelease.
2748 if (CGF.shouldUseFusedARCCalls())
2749 if (llvm::Value *fused = tryEmitFusedAutoreleaseOfResult(CGF, result))
2750 return fused;
2751
2752 return CGF.EmitARCAutoreleaseReturnValue(result);
2753}
2754
John McCall6e1c0122012-01-29 02:35:02 +00002755/// Heuristically search for a dominating store to the return-value slot.
2756static llvm::StoreInst *findDominatingStoreToReturnValue(CodeGenFunction &CGF) {
Jakub Kuderskif50ab0f2015-09-08 10:36:42 +00002757 // Check if a User is a store which pointerOperand is the ReturnValue.
2758 // We are looking for stores to the ReturnValue, not for stores of the
2759 // ReturnValue to some other location.
2760 auto GetStoreIfValid = [&CGF](llvm::User *U) -> llvm::StoreInst * {
2761 auto *SI = dyn_cast<llvm::StoreInst>(U);
2762 if (!SI || SI->getPointerOperand() != CGF.ReturnValue.getPointer())
2763 return nullptr;
2764 // These aren't actually possible for non-coerced returns, and we
2765 // only care about non-coerced returns on this code path.
2766 assert(!SI->isAtomic() && !SI->isVolatile());
2767 return SI;
2768 };
John McCall6e1c0122012-01-29 02:35:02 +00002769 // If there are multiple uses of the return-value slot, just check
2770 // for something immediately preceding the IP. Sometimes this can
2771 // happen with how we generate implicit-returns; it can also happen
2772 // with noreturn cleanups.
John McCall7f416cc2015-09-08 08:05:57 +00002773 if (!CGF.ReturnValue.getPointer()->hasOneUse()) {
John McCall6e1c0122012-01-29 02:35:02 +00002774 llvm::BasicBlock *IP = CGF.Builder.GetInsertBlock();
Craig Topper8a13c412014-05-21 05:09:00 +00002775 if (IP->empty()) return nullptr;
David Majnemerdc012fa2015-04-22 21:38:15 +00002776 llvm::Instruction *I = &IP->back();
2777
2778 // Skip lifetime markers
2779 for (llvm::BasicBlock::reverse_iterator II = IP->rbegin(),
2780 IE = IP->rend();
2781 II != IE; ++II) {
2782 if (llvm::IntrinsicInst *Intrinsic =
2783 dyn_cast<llvm::IntrinsicInst>(&*II)) {
2784 if (Intrinsic->getIntrinsicID() == llvm::Intrinsic::lifetime_end) {
2785 const llvm::Value *CastAddr = Intrinsic->getArgOperand(1);
2786 ++II;
Alexey Samsonov10544202015-06-12 21:05:32 +00002787 if (II == IE)
2788 break;
2789 if (isa<llvm::BitCastInst>(&*II) && (CastAddr == &*II))
2790 continue;
David Majnemerdc012fa2015-04-22 21:38:15 +00002791 }
2792 }
2793 I = &*II;
2794 break;
2795 }
2796
Jakub Kuderskif50ab0f2015-09-08 10:36:42 +00002797 return GetStoreIfValid(I);
John McCall6e1c0122012-01-29 02:35:02 +00002798 }
2799
2800 llvm::StoreInst *store =
Jakub Kuderskif50ab0f2015-09-08 10:36:42 +00002801 GetStoreIfValid(CGF.ReturnValue.getPointer()->user_back());
Craig Topper8a13c412014-05-21 05:09:00 +00002802 if (!store) return nullptr;
John McCall6e1c0122012-01-29 02:35:02 +00002803
John McCall6e1c0122012-01-29 02:35:02 +00002804 // Now do a first-and-dirty dominance check: just walk up the
2805 // single-predecessors chain from the current insertion point.
2806 llvm::BasicBlock *StoreBB = store->getParent();
2807 llvm::BasicBlock *IP = CGF.Builder.GetInsertBlock();
2808 while (IP != StoreBB) {
2809 if (!(IP = IP->getSinglePredecessor()))
Craig Topper8a13c412014-05-21 05:09:00 +00002810 return nullptr;
John McCall6e1c0122012-01-29 02:35:02 +00002811 }
2812
2813 // Okay, the store's basic block dominates the insertion point; we
2814 // can do our thing.
2815 return store;
2816}
2817
Adrian Prantl3be10542013-05-02 17:30:20 +00002818void CodeGenFunction::EmitFunctionEpilog(const CGFunctionInfo &FI,
Nick Lewycky2d84e842013-10-02 02:29:49 +00002819 bool EmitRetDbgLoc,
2820 SourceLocation EndLoc) {
Vedant Kumar09b5bfd2017-12-21 00:10:25 +00002821 if (FI.isNoReturn()) {
2822 // Noreturn functions don't return.
2823 EmitUnreachable(EndLoc);
2824 return;
2825 }
2826
Hans Wennborgd71907d2014-09-04 22:16:33 +00002827 if (CurCodeDecl && CurCodeDecl->hasAttr<NakedAttr>()) {
2828 // Naked functions don't have epilogues.
2829 Builder.CreateUnreachable();
2830 return;
2831 }
2832
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00002833 // Functions with no result always return void.
John McCall7f416cc2015-09-08 08:05:57 +00002834 if (!ReturnValue.isValid()) {
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00002835 Builder.CreateRetVoid();
Chris Lattner726b3d02010-06-26 23:13:19 +00002836 return;
Daniel Dunbara72d4ae2008-09-10 02:41:04 +00002837 }
Daniel Dunbar6696e222010-06-30 21:27:58 +00002838
Dan Gohman481e40c2010-07-20 20:13:52 +00002839 llvm::DebugLoc RetDbgLoc;
Craig Topper8a13c412014-05-21 05:09:00 +00002840 llvm::Value *RV = nullptr;
Chris Lattner726b3d02010-06-26 23:13:19 +00002841 QualType RetTy = FI.getReturnType();
2842 const ABIArgInfo &RetAI = FI.getReturnInfo();
2843
2844 switch (RetAI.getKind()) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002845 case ABIArgInfo::InAlloca:
Reid Klecknerfab1e892014-02-25 00:59:14 +00002846 // Aggregrates get evaluated directly into the destination. Sometimes we
2847 // need to return the sret value in a register, though.
2848 assert(hasAggregateEvaluationKind(RetTy));
2849 if (RetAI.getInAllocaSRet()) {
2850 llvm::Function::arg_iterator EI = CurFn->arg_end();
2851 --EI;
Duncan P. N. Exon Smith9f5260a2015-11-06 23:00:41 +00002852 llvm::Value *ArgStruct = &*EI;
David Blaikie2e804282015-04-05 22:47:07 +00002853 llvm::Value *SRet = Builder.CreateStructGEP(
2854 nullptr, ArgStruct, RetAI.getInAllocaFieldIndex());
John McCall7f416cc2015-09-08 08:05:57 +00002855 RV = Builder.CreateAlignedLoad(SRet, getPointerAlign(), "sret");
Reid Klecknerfab1e892014-02-25 00:59:14 +00002856 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00002857 break;
2858
Daniel Dunbar03816342010-08-21 02:24:36 +00002859 case ABIArgInfo::Indirect: {
Reid Kleckner37abaca2014-05-09 22:46:15 +00002860 auto AI = CurFn->arg_begin();
2861 if (RetAI.isSRetAfterThis())
2862 ++AI;
John McCall47fb9502013-03-07 21:37:08 +00002863 switch (getEvaluationKind(RetTy)) {
2864 case TEK_Complex: {
2865 ComplexPairTy RT =
John McCall7f416cc2015-09-08 08:05:57 +00002866 EmitLoadOfComplex(MakeAddrLValue(ReturnValue, RetTy), EndLoc);
Duncan P. N. Exon Smith9f5260a2015-11-06 23:00:41 +00002867 EmitStoreOfComplex(RT, MakeNaturalAlignAddrLValue(&*AI, RetTy),
John McCall47fb9502013-03-07 21:37:08 +00002868 /*isInit*/ true);
2869 break;
2870 }
2871 case TEK_Aggregate:
Chris Lattner726b3d02010-06-26 23:13:19 +00002872 // Do nothing; aggregrates get evaluated directly into the destination.
John McCall47fb9502013-03-07 21:37:08 +00002873 break;
2874 case TEK_Scalar:
2875 EmitStoreOfScalar(Builder.CreateLoad(ReturnValue),
Duncan P. N. Exon Smith9f5260a2015-11-06 23:00:41 +00002876 MakeNaturalAlignAddrLValue(&*AI, RetTy),
John McCall47fb9502013-03-07 21:37:08 +00002877 /*isInit*/ true);
2878 break;
Chris Lattner726b3d02010-06-26 23:13:19 +00002879 }
2880 break;
Daniel Dunbar03816342010-08-21 02:24:36 +00002881 }
Chris Lattner726b3d02010-06-26 23:13:19 +00002882
2883 case ABIArgInfo::Extend:
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002884 case ABIArgInfo::Direct:
Chris Lattner8a2f3c72010-07-30 04:02:24 +00002885 if (RetAI.getCoerceToType() == ConvertType(RetTy) &&
2886 RetAI.getDirectOffset() == 0) {
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002887 // The internal return value temp always will have pointer-to-return-type
2888 // type, just do a load.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002889
John McCall6e1c0122012-01-29 02:35:02 +00002890 // If there is a dominating store to ReturnValue, we can elide
2891 // the load, zap the store, and usually zap the alloca.
David Majnemerdc012fa2015-04-22 21:38:15 +00002892 if (llvm::StoreInst *SI =
2893 findDominatingStoreToReturnValue(*this)) {
Adrian Prantl4c9a38a2013-05-30 18:12:23 +00002894 // Reuse the debug location from the store unless there is
2895 // cleanup code to be emitted between the store and return
2896 // instruction.
2897 if (EmitRetDbgLoc && !AutoreleaseResult)
Adrian Prantl3be10542013-05-02 17:30:20 +00002898 RetDbgLoc = SI->getDebugLoc();
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002899 // Get the stored value and nuke the now-dead store.
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002900 RV = SI->getValueOperand();
2901 SI->eraseFromParent();
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002902
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002903 // If that was the only use of the return value, nuke it as well now.
John McCall7f416cc2015-09-08 08:05:57 +00002904 auto returnValueInst = ReturnValue.getPointer();
2905 if (returnValueInst->use_empty()) {
2906 if (auto alloca = dyn_cast<llvm::AllocaInst>(returnValueInst)) {
2907 alloca->eraseFromParent();
2908 ReturnValue = Address::invalid();
2909 }
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002910 }
John McCall6e1c0122012-01-29 02:35:02 +00002911
2912 // Otherwise, we have to do a simple load.
2913 } else {
2914 RV = Builder.CreateLoad(ReturnValue);
Chris Lattner3fcc7902010-06-27 01:06:27 +00002915 }
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002916 } else {
Chris Lattner8a2f3c72010-07-30 04:02:24 +00002917 // If the value is offset in memory, apply the offset now.
John McCall7f416cc2015-09-08 08:05:57 +00002918 Address V = emitAddressAtOffset(*this, ReturnValue, RetAI);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00002919
John McCall7f416cc2015-09-08 08:05:57 +00002920 RV = CreateCoercedLoad(V, RetAI.getCoerceToType(), *this);
Chris Lattner3fcc7902010-06-27 01:06:27 +00002921 }
John McCall31168b02011-06-15 23:02:42 +00002922
2923 // In ARC, end functions that return a retainable type with a call
2924 // to objc_autoreleaseReturnValue.
2925 if (AutoreleaseResult) {
Akira Hatanaka9d8ac612016-02-17 21:09:50 +00002926#ifndef NDEBUG
2927 // Type::isObjCRetainabletype has to be called on a QualType that hasn't
2928 // been stripped of the typedefs, so we cannot use RetTy here. Get the
2929 // original return type of FunctionDecl, CurCodeDecl, and BlockDecl from
2930 // CurCodeDecl or BlockInfo.
2931 QualType RT;
2932
2933 if (auto *FD = dyn_cast<FunctionDecl>(CurCodeDecl))
2934 RT = FD->getReturnType();
2935 else if (auto *MD = dyn_cast<ObjCMethodDecl>(CurCodeDecl))
2936 RT = MD->getReturnType();
2937 else if (isa<BlockDecl>(CurCodeDecl))
2938 RT = BlockInfo->BlockExpression->getFunctionType()->getReturnType();
2939 else
2940 llvm_unreachable("Unexpected function/method type");
2941
David Blaikiebbafb8a2012-03-11 07:00:24 +00002942 assert(getLangOpts().ObjCAutoRefCount &&
John McCall31168b02011-06-15 23:02:42 +00002943 !FI.isReturnsRetained() &&
Akira Hatanaka9d8ac612016-02-17 21:09:50 +00002944 RT->isObjCRetainableType());
2945#endif
John McCall31168b02011-06-15 23:02:42 +00002946 RV = emitAutoreleaseOfResult(*this, RV);
2947 }
2948
Chris Lattner726b3d02010-06-26 23:13:19 +00002949 break;
Chris Lattner726b3d02010-06-26 23:13:19 +00002950
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00002951 case ABIArgInfo::Ignore:
Chris Lattner726b3d02010-06-26 23:13:19 +00002952 break;
2953
John McCallf26e73d2016-03-11 04:30:43 +00002954 case ABIArgInfo::CoerceAndExpand: {
2955 auto coercionType = RetAI.getCoerceAndExpandType();
2956 auto layout = CGM.getDataLayout().getStructLayout(coercionType);
2957
2958 // Load all of the coerced elements out into results.
2959 llvm::SmallVector<llvm::Value*, 4> results;
2960 Address addr = Builder.CreateElementBitCast(ReturnValue, coercionType);
2961 for (unsigned i = 0, e = coercionType->getNumElements(); i != e; ++i) {
2962 auto coercedEltType = coercionType->getElementType(i);
2963 if (ABIArgInfo::isPaddingForCoerceAndExpand(coercedEltType))
2964 continue;
2965
2966 auto eltAddr = Builder.CreateStructGEP(addr, i, layout);
2967 auto elt = Builder.CreateLoad(eltAddr);
2968 results.push_back(elt);
2969 }
2970
2971 // If we have one result, it's the single direct result type.
2972 if (results.size() == 1) {
2973 RV = results[0];
2974
2975 // Otherwise, we need to make a first-class aggregate.
2976 } else {
2977 // Construct a return type that lacks padding elements.
2978 llvm::Type *returnType = RetAI.getUnpaddedCoerceAndExpandType();
2979
2980 RV = llvm::UndefValue::get(returnType);
2981 for (unsigned i = 0, e = results.size(); i != e; ++i) {
2982 RV = Builder.CreateInsertValue(RV, results[i], i);
2983 }
2984 }
2985 break;
2986 }
2987
Chris Lattner726b3d02010-06-26 23:13:19 +00002988 case ABIArgInfo::Expand:
David Blaikie83d382b2011-09-23 05:06:16 +00002989 llvm_unreachable("Invalid ABI kind for return argument");
Chris Lattner726b3d02010-06-26 23:13:19 +00002990 }
2991
Alexey Samsonovde443c52014-08-13 00:26:40 +00002992 llvm::Instruction *Ret;
2993 if (RV) {
Vedant Kumarc34d3432017-06-23 21:32:38 +00002994 EmitReturnValueCheck(RV);
Alexey Samsonovde443c52014-08-13 00:26:40 +00002995 Ret = Builder.CreateRet(RV);
2996 } else {
2997 Ret = Builder.CreateRetVoid();
2998 }
2999
Duncan P. N. Exon Smith2809cc72015-03-30 20:01:41 +00003000 if (RetDbgLoc)
Benjamin Kramer03278662015-02-07 13:15:54 +00003001 Ret->setDebugLoc(std::move(RetDbgLoc));
Daniel Dunbar613855c2008-09-09 23:27:19 +00003002}
3003
Vedant Kumarc34d3432017-06-23 21:32:38 +00003004void CodeGenFunction::EmitReturnValueCheck(llvm::Value *RV) {
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003005 // A current decl may not be available when emitting vtable thunks.
3006 if (!CurCodeDecl)
3007 return;
3008
3009 ReturnsNonNullAttr *RetNNAttr = nullptr;
3010 if (SanOpts.has(SanitizerKind::ReturnsNonnullAttribute))
3011 RetNNAttr = CurCodeDecl->getAttr<ReturnsNonNullAttr>();
3012
3013 if (!RetNNAttr && !requiresReturnValueNullabilityCheck())
3014 return;
3015
3016 // Prefer the returns_nonnull attribute if it's present.
3017 SourceLocation AttrLoc;
3018 SanitizerMask CheckKind;
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00003019 SanitizerHandler Handler;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003020 if (RetNNAttr) {
3021 assert(!requiresReturnValueNullabilityCheck() &&
3022 "Cannot check nullability and the nonnull attribute");
3023 AttrLoc = RetNNAttr->getLocation();
3024 CheckKind = SanitizerKind::ReturnsNonnullAttribute;
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00003025 Handler = SanitizerHandler::NonnullReturn;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003026 } else {
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003027 if (auto *DD = dyn_cast<DeclaratorDecl>(CurCodeDecl))
3028 if (auto *TSI = DD->getTypeSourceInfo())
3029 if (auto FTL = TSI->getTypeLoc().castAs<FunctionTypeLoc>())
3030 AttrLoc = FTL.getReturnLoc().findNullabilityLoc();
3031 CheckKind = SanitizerKind::NullabilityReturn;
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00003032 Handler = SanitizerHandler::NullabilityReturn;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003033 }
3034
3035 SanitizerScope SanScope(this);
3036
Vedant Kumarc34d3432017-06-23 21:32:38 +00003037 // Make sure the "return" source location is valid. If we're checking a
3038 // nullability annotation, make sure the preconditions for the check are met.
3039 llvm::BasicBlock *Check = createBasicBlock("nullcheck");
3040 llvm::BasicBlock *NoCheck = createBasicBlock("no.nullcheck");
3041 llvm::Value *SLocPtr = Builder.CreateLoad(ReturnLocation, "return.sloc.load");
3042 llvm::Value *CanNullCheck = Builder.CreateIsNotNull(SLocPtr);
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003043 if (requiresReturnValueNullabilityCheck())
Vedant Kumarc34d3432017-06-23 21:32:38 +00003044 CanNullCheck =
3045 Builder.CreateAnd(CanNullCheck, RetValNullabilityPrecondition);
3046 Builder.CreateCondBr(CanNullCheck, Check, NoCheck);
3047 EmitBlock(Check);
3048
3049 // Now do the null check.
3050 llvm::Value *Cond = Builder.CreateIsNotNull(RV);
3051 llvm::Constant *StaticData[] = {EmitCheckSourceLocation(AttrLoc)};
3052 llvm::Value *DynamicData[] = {SLocPtr};
3053 EmitCheck(std::make_pair(Cond, CheckKind), Handler, StaticData, DynamicData);
3054
3055 EmitBlock(NoCheck);
3056
3057#ifndef NDEBUG
3058 // The return location should not be used after the check has been emitted.
3059 ReturnLocation = Address::invalid();
3060#endif
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003061}
3062
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003063static bool isInAllocaArgument(CGCXXABI &ABI, QualType type) {
3064 const CXXRecordDecl *RD = type->getAsCXXRecordDecl();
3065 return RD && ABI.getRecordArgABI(RD) == CGCXXABI::RAA_DirectInMemory;
3066}
3067
John McCall7f416cc2015-09-08 08:05:57 +00003068static AggValueSlot createPlaceholderSlot(CodeGenFunction &CGF,
3069 QualType Ty) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003070 // FIXME: Generate IR in one pass, rather than going back and fixing up these
3071 // placeholders.
3072 llvm::Type *IRTy = CGF.ConvertTypeForMem(Ty);
Peter Collingbourneb367c562016-11-28 22:30:21 +00003073 llvm::Type *IRPtrTy = IRTy->getPointerTo();
3074 llvm::Value *Placeholder = llvm::UndefValue::get(IRPtrTy->getPointerTo());
John McCall7f416cc2015-09-08 08:05:57 +00003075
3076 // FIXME: When we generate this IR in one pass, we shouldn't need
3077 // this win32-specific alignment hack.
3078 CharUnits Align = CharUnits::fromQuantity(4);
Peter Collingbourneb367c562016-11-28 22:30:21 +00003079 Placeholder = CGF.Builder.CreateAlignedLoad(IRPtrTy, Placeholder, Align);
John McCall7f416cc2015-09-08 08:05:57 +00003080
3081 return AggValueSlot::forAddr(Address(Placeholder, Align),
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003082 Ty.getQualifiers(),
3083 AggValueSlot::IsNotDestructed,
3084 AggValueSlot::DoesNotNeedGCBarriers,
Richard Smithe78fac52018-04-05 20:52:58 +00003085 AggValueSlot::IsNotAliased,
3086 AggValueSlot::DoesNotOverlap);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003087}
3088
John McCall32ea9692011-03-11 20:59:21 +00003089void CodeGenFunction::EmitDelegateCallArg(CallArgList &args,
Nick Lewycky2d84e842013-10-02 02:29:49 +00003090 const VarDecl *param,
3091 SourceLocation loc) {
John McCall23f66262010-05-26 22:34:26 +00003092 // StartFunction converted the ABI-lowered parameter(s) into a
3093 // local alloca. We need to turn that into an r-value suitable
3094 // for EmitCall.
John McCall7f416cc2015-09-08 08:05:57 +00003095 Address local = GetAddrOfLocalVar(param);
John McCall23f66262010-05-26 22:34:26 +00003096
John McCall32ea9692011-03-11 20:59:21 +00003097 QualType type = param->getType();
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00003098
Reid Kleckner25b56022018-12-12 23:46:06 +00003099 if (isInAllocaArgument(CGM.getCXXABI(), type)) {
3100 CGM.ErrorUnsupported(param, "forwarded non-trivially copyable parameter");
3101 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003102
John McCall811b2912016-11-18 01:08:24 +00003103 // GetAddrOfLocalVar returns a pointer-to-pointer for references,
3104 // but the argument needs to be the original pointer.
3105 if (type->isReferenceType()) {
3106 args.add(RValue::get(Builder.CreateLoad(local)), type);
3107
3108 // In ARC, move out of consumed arguments so that the release cleanup
3109 // entered by StartFunction doesn't cause an over-release. This isn't
3110 // optimal -O0 code generation, but it should get cleaned up when
3111 // optimization is enabled. This also assumes that delegate calls are
3112 // performed exactly once for a set of arguments, but that should be safe.
3113 } else if (getLangOpts().ObjCAutoRefCount &&
3114 param->hasAttr<NSConsumedAttr>() &&
3115 type->isObjCRetainableType()) {
3116 llvm::Value *ptr = Builder.CreateLoad(local);
3117 auto null =
3118 llvm::ConstantPointerNull::get(cast<llvm::PointerType>(ptr->getType()));
3119 Builder.CreateStore(null, local);
3120 args.add(RValue::get(ptr), type);
3121
Richard Smithd62d4982016-06-14 01:13:21 +00003122 // For the most part, we just need to load the alloca, except that
3123 // aggregate r-values are actually pointers to temporaries.
John McCall811b2912016-11-18 01:08:24 +00003124 } else {
Richard Smithd62d4982016-06-14 01:13:21 +00003125 args.add(convertTempToRValue(local, type, loc), type);
John McCall811b2912016-11-18 01:08:24 +00003126 }
Akira Hatanakaccda3d22018-04-27 06:57:00 +00003127
3128 // Deactivate the cleanup for the callee-destructed param that was pushed.
3129 if (hasAggregateEvaluationKind(type) && !CurFuncIsThunk &&
Akira Hatanaka85282972018-05-15 21:00:30 +00003130 type->getAs<RecordType>()->getDecl()->isParamDestroyedInCallee() &&
3131 type.isDestructedType()) {
Akira Hatanakaccda3d22018-04-27 06:57:00 +00003132 EHScopeStack::stable_iterator cleanup =
3133 CalleeDestructedParamCleanups.lookup(cast<ParmVarDecl>(param));
3134 assert(cleanup.isValid() &&
3135 "cleanup for callee-destructed param not recorded");
3136 // This unreachable is a temporary marker which will be removed later.
3137 llvm::Instruction *isActive = Builder.CreateUnreachable();
3138 args.addArgCleanupDeactivation(cleanup, isActive);
3139 }
John McCall23f66262010-05-26 22:34:26 +00003140}
3141
John McCall31168b02011-06-15 23:02:42 +00003142static bool isProvablyNull(llvm::Value *addr) {
3143 return isa<llvm::ConstantPointerNull>(addr);
3144}
3145
John McCall31168b02011-06-15 23:02:42 +00003146/// Emit the actual writing-back of a writeback.
3147static void emitWriteback(CodeGenFunction &CGF,
3148 const CallArgList::Writeback &writeback) {
John McCalleff18842013-03-23 02:35:54 +00003149 const LValue &srcLV = writeback.Source;
John McCall7f416cc2015-09-08 08:05:57 +00003150 Address srcAddr = srcLV.getAddress();
3151 assert(!isProvablyNull(srcAddr.getPointer()) &&
John McCall31168b02011-06-15 23:02:42 +00003152 "shouldn't have writeback for provably null argument");
3153
Craig Topper8a13c412014-05-21 05:09:00 +00003154 llvm::BasicBlock *contBB = nullptr;
John McCall31168b02011-06-15 23:02:42 +00003155
3156 // If the argument wasn't provably non-null, we need to null check
3157 // before doing the store.
Nuno Lopes9211cee2017-09-09 18:25:36 +00003158 bool provablyNonNull = llvm::isKnownNonZero(srcAddr.getPointer(),
3159 CGF.CGM.getDataLayout());
John McCall31168b02011-06-15 23:02:42 +00003160 if (!provablyNonNull) {
3161 llvm::BasicBlock *writebackBB = CGF.createBasicBlock("icr.writeback");
3162 contBB = CGF.createBasicBlock("icr.done");
3163
John McCall7f416cc2015-09-08 08:05:57 +00003164 llvm::Value *isNull =
3165 CGF.Builder.CreateIsNull(srcAddr.getPointer(), "icr.isnull");
John McCall31168b02011-06-15 23:02:42 +00003166 CGF.Builder.CreateCondBr(isNull, contBB, writebackBB);
3167 CGF.EmitBlock(writebackBB);
3168 }
3169
3170 // Load the value to writeback.
3171 llvm::Value *value = CGF.Builder.CreateLoad(writeback.Temporary);
3172
3173 // Cast it back, in case we're writing an id to a Foo* or something.
John McCall7f416cc2015-09-08 08:05:57 +00003174 value = CGF.Builder.CreateBitCast(value, srcAddr.getElementType(),
3175 "icr.writeback-cast");
Fangrui Song6907ce22018-07-30 19:24:48 +00003176
John McCall31168b02011-06-15 23:02:42 +00003177 // Perform the writeback.
John McCalleff18842013-03-23 02:35:54 +00003178
3179 // If we have a "to use" value, it's something we need to emit a use
3180 // of. This has to be carefully threaded in: if it's done after the
3181 // release it's potentially undefined behavior (and the optimizer
3182 // will ignore it), and if it happens before the retain then the
3183 // optimizer could move the release there.
3184 if (writeback.ToUse) {
3185 assert(srcLV.getObjCLifetime() == Qualifiers::OCL_Strong);
3186
3187 // Retain the new value. No need to block-copy here: the block's
3188 // being passed up the stack.
3189 value = CGF.EmitARCRetainNonBlock(value);
3190
3191 // Emit the intrinsic use here.
3192 CGF.EmitARCIntrinsicUse(writeback.ToUse);
3193
3194 // Load the old value (primitively).
Nick Lewycky2d84e842013-10-02 02:29:49 +00003195 llvm::Value *oldValue = CGF.EmitLoadOfScalar(srcLV, SourceLocation());
John McCalleff18842013-03-23 02:35:54 +00003196
3197 // Put the new value in place (primitively).
3198 CGF.EmitStoreOfScalar(value, srcLV, /*init*/ false);
3199
3200 // Release the old value.
3201 CGF.EmitARCRelease(oldValue, srcLV.isARCPreciseLifetime());
3202
3203 // Otherwise, we can just do a normal lvalue store.
3204 } else {
3205 CGF.EmitStoreThroughLValue(RValue::get(value), srcLV);
3206 }
John McCall31168b02011-06-15 23:02:42 +00003207
3208 // Jump to the continuation block.
3209 if (!provablyNonNull)
3210 CGF.EmitBlock(contBB);
3211}
3212
3213static void emitWritebacks(CodeGenFunction &CGF,
3214 const CallArgList &args) {
Aaron Ballman36a7fa82014-03-17 17:22:27 +00003215 for (const auto &I : args.writebacks())
3216 emitWriteback(CGF, I);
John McCall31168b02011-06-15 23:02:42 +00003217}
3218
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003219static void deactivateArgCleanupsBeforeCall(CodeGenFunction &CGF,
3220 const CallArgList &CallArgs) {
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003221 ArrayRef<CallArgList::CallArgCleanup> Cleanups =
3222 CallArgs.getCleanupsToDeactivate();
3223 // Iterate in reverse to increase the likelihood of popping the cleanup.
Pete Cooper57d3f142015-07-30 17:22:52 +00003224 for (const auto &I : llvm::reverse(Cleanups)) {
3225 CGF.DeactivateCleanupBlock(I.Cleanup, I.IsActiveIP);
3226 I.IsActiveIP->eraseFromParent();
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003227 }
3228}
3229
John McCalleff18842013-03-23 02:35:54 +00003230static const Expr *maybeGetUnaryAddrOfOperand(const Expr *E) {
3231 if (const UnaryOperator *uop = dyn_cast<UnaryOperator>(E->IgnoreParens()))
3232 if (uop->getOpcode() == UO_AddrOf)
3233 return uop->getSubExpr();
Craig Topper8a13c412014-05-21 05:09:00 +00003234 return nullptr;
John McCalleff18842013-03-23 02:35:54 +00003235}
3236
John McCall31168b02011-06-15 23:02:42 +00003237/// Emit an argument that's being passed call-by-writeback. That is,
John McCall7f416cc2015-09-08 08:05:57 +00003238/// we are passing the address of an __autoreleased temporary; it
3239/// might be copy-initialized with the current value of the given
3240/// address, but it will definitely be copied out of after the call.
John McCall31168b02011-06-15 23:02:42 +00003241static void emitWritebackArg(CodeGenFunction &CGF, CallArgList &args,
3242 const ObjCIndirectCopyRestoreExpr *CRE) {
John McCalleff18842013-03-23 02:35:54 +00003243 LValue srcLV;
3244
3245 // Make an optimistic effort to emit the address as an l-value.
Eric Christopher2c4555a2015-06-19 01:52:53 +00003246 // This can fail if the argument expression is more complicated.
John McCalleff18842013-03-23 02:35:54 +00003247 if (const Expr *lvExpr = maybeGetUnaryAddrOfOperand(CRE->getSubExpr())) {
3248 srcLV = CGF.EmitLValue(lvExpr);
3249
3250 // Otherwise, just emit it as a scalar.
3251 } else {
John McCall7f416cc2015-09-08 08:05:57 +00003252 Address srcAddr = CGF.EmitPointerWithAlignment(CRE->getSubExpr());
John McCalleff18842013-03-23 02:35:54 +00003253
3254 QualType srcAddrType =
3255 CRE->getSubExpr()->getType()->castAs<PointerType>()->getPointeeType();
John McCall7f416cc2015-09-08 08:05:57 +00003256 srcLV = CGF.MakeAddrLValue(srcAddr, srcAddrType);
John McCalleff18842013-03-23 02:35:54 +00003257 }
John McCall7f416cc2015-09-08 08:05:57 +00003258 Address srcAddr = srcLV.getAddress();
John McCall31168b02011-06-15 23:02:42 +00003259
3260 // The dest and src types don't necessarily match in LLVM terms
3261 // because of the crazy ObjC compatibility rules.
3262
Chris Lattner2192fe52011-07-18 04:24:23 +00003263 llvm::PointerType *destType =
John McCall31168b02011-06-15 23:02:42 +00003264 cast<llvm::PointerType>(CGF.ConvertType(CRE->getType()));
3265
3266 // If the address is a constant null, just pass the appropriate null.
John McCall7f416cc2015-09-08 08:05:57 +00003267 if (isProvablyNull(srcAddr.getPointer())) {
John McCall31168b02011-06-15 23:02:42 +00003268 args.add(RValue::get(llvm::ConstantPointerNull::get(destType)),
3269 CRE->getType());
3270 return;
3271 }
3272
John McCall31168b02011-06-15 23:02:42 +00003273 // Create the temporary.
John McCall7f416cc2015-09-08 08:05:57 +00003274 Address temp = CGF.CreateTempAlloca(destType->getElementType(),
3275 CGF.getPointerAlign(),
3276 "icr.temp");
Fariborz Jahanianfbd19742012-11-27 23:02:53 +00003277 // Loading an l-value can introduce a cleanup if the l-value is __weak,
3278 // and that cleanup will be conditional if we can't prove that the l-value
3279 // isn't null, so we need to register a dominating point so that the cleanups
3280 // system will make valid IR.
3281 CodeGenFunction::ConditionalEvaluation condEval(CGF);
Fangrui Song6907ce22018-07-30 19:24:48 +00003282
John McCall31168b02011-06-15 23:02:42 +00003283 // Zero-initialize it if we're not doing a copy-initialization.
3284 bool shouldCopy = CRE->shouldCopy();
3285 if (!shouldCopy) {
3286 llvm::Value *null =
3287 llvm::ConstantPointerNull::get(
3288 cast<llvm::PointerType>(destType->getElementType()));
3289 CGF.Builder.CreateStore(null, temp);
3290 }
Craig Topper8a13c412014-05-21 05:09:00 +00003291
3292 llvm::BasicBlock *contBB = nullptr;
3293 llvm::BasicBlock *originBB = nullptr;
John McCall31168b02011-06-15 23:02:42 +00003294
3295 // If the address is *not* known to be non-null, we need to switch.
3296 llvm::Value *finalArgument;
3297
Nuno Lopes9211cee2017-09-09 18:25:36 +00003298 bool provablyNonNull = llvm::isKnownNonZero(srcAddr.getPointer(),
3299 CGF.CGM.getDataLayout());
John McCall31168b02011-06-15 23:02:42 +00003300 if (provablyNonNull) {
John McCall7f416cc2015-09-08 08:05:57 +00003301 finalArgument = temp.getPointer();
John McCall31168b02011-06-15 23:02:42 +00003302 } else {
John McCall7f416cc2015-09-08 08:05:57 +00003303 llvm::Value *isNull =
3304 CGF.Builder.CreateIsNull(srcAddr.getPointer(), "icr.isnull");
John McCall31168b02011-06-15 23:02:42 +00003305
Fangrui Song6907ce22018-07-30 19:24:48 +00003306 finalArgument = CGF.Builder.CreateSelect(isNull,
John McCall31168b02011-06-15 23:02:42 +00003307 llvm::ConstantPointerNull::get(destType),
John McCall7f416cc2015-09-08 08:05:57 +00003308 temp.getPointer(), "icr.argument");
John McCall31168b02011-06-15 23:02:42 +00003309
3310 // If we need to copy, then the load has to be conditional, which
3311 // means we need control flow.
3312 if (shouldCopy) {
John McCalleff18842013-03-23 02:35:54 +00003313 originBB = CGF.Builder.GetInsertBlock();
John McCall31168b02011-06-15 23:02:42 +00003314 contBB = CGF.createBasicBlock("icr.cont");
3315 llvm::BasicBlock *copyBB = CGF.createBasicBlock("icr.copy");
3316 CGF.Builder.CreateCondBr(isNull, contBB, copyBB);
3317 CGF.EmitBlock(copyBB);
Fariborz Jahanianfbd19742012-11-27 23:02:53 +00003318 condEval.begin(CGF);
John McCall31168b02011-06-15 23:02:42 +00003319 }
3320 }
3321
Craig Topper8a13c412014-05-21 05:09:00 +00003322 llvm::Value *valueToUse = nullptr;
John McCalleff18842013-03-23 02:35:54 +00003323
John McCall31168b02011-06-15 23:02:42 +00003324 // Perform a copy if necessary.
3325 if (shouldCopy) {
Nick Lewycky2d84e842013-10-02 02:29:49 +00003326 RValue srcRV = CGF.EmitLoadOfLValue(srcLV, SourceLocation());
John McCall31168b02011-06-15 23:02:42 +00003327 assert(srcRV.isScalar());
3328
3329 llvm::Value *src = srcRV.getScalarVal();
3330 src = CGF.Builder.CreateBitCast(src, destType->getElementType(),
3331 "icr.cast");
3332
3333 // Use an ordinary store, not a store-to-lvalue.
3334 CGF.Builder.CreateStore(src, temp);
John McCalleff18842013-03-23 02:35:54 +00003335
3336 // If optimization is enabled, and the value was held in a
3337 // __strong variable, we need to tell the optimizer that this
3338 // value has to stay alive until we're doing the store back.
3339 // This is because the temporary is effectively unretained,
3340 // and so otherwise we can violate the high-level semantics.
3341 if (CGF.CGM.getCodeGenOpts().OptimizationLevel != 0 &&
3342 srcLV.getObjCLifetime() == Qualifiers::OCL_Strong) {
3343 valueToUse = src;
3344 }
John McCall31168b02011-06-15 23:02:42 +00003345 }
Fangrui Song6907ce22018-07-30 19:24:48 +00003346
John McCall31168b02011-06-15 23:02:42 +00003347 // Finish the control flow if we needed it.
Fariborz Jahanianfbd19742012-11-27 23:02:53 +00003348 if (shouldCopy && !provablyNonNull) {
John McCalleff18842013-03-23 02:35:54 +00003349 llvm::BasicBlock *copyBB = CGF.Builder.GetInsertBlock();
John McCall31168b02011-06-15 23:02:42 +00003350 CGF.EmitBlock(contBB);
John McCalleff18842013-03-23 02:35:54 +00003351
3352 // Make a phi for the value to intrinsically use.
3353 if (valueToUse) {
3354 llvm::PHINode *phiToUse = CGF.Builder.CreatePHI(valueToUse->getType(), 2,
3355 "icr.to-use");
3356 phiToUse->addIncoming(valueToUse, copyBB);
3357 phiToUse->addIncoming(llvm::UndefValue::get(valueToUse->getType()),
3358 originBB);
3359 valueToUse = phiToUse;
3360 }
3361
Fariborz Jahanianfbd19742012-11-27 23:02:53 +00003362 condEval.end(CGF);
3363 }
John McCall31168b02011-06-15 23:02:42 +00003364
John McCalleff18842013-03-23 02:35:54 +00003365 args.addWriteback(srcLV, temp, valueToUse);
John McCall31168b02011-06-15 23:02:42 +00003366 args.add(RValue::get(finalArgument), CRE->getType());
3367}
3368
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003369void CallArgList::allocateArgumentMemory(CodeGenFunction &CGF) {
Richard Smith762672a2016-09-28 19:09:10 +00003370 assert(!StackBase);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003371
3372 // Save the stack.
3373 llvm::Function *F = CGF.CGM.getIntrinsic(llvm::Intrinsic::stacksave);
David Blaikie43f9bb72015-05-18 22:14:03 +00003374 StackBase = CGF.Builder.CreateCall(F, {}, "inalloca.save");
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003375}
3376
Nico Weber8cdb3f92015-08-25 18:43:32 +00003377void CallArgList::freeArgumentMemory(CodeGenFunction &CGF) const {
3378 if (StackBase) {
Reid Kleckner7c2f9e82015-10-08 00:17:45 +00003379 // Restore the stack after the call.
James Y Knight8799cae2019-02-03 21:53:49 +00003380 llvm::Function *F = CGF.CGM.getIntrinsic(llvm::Intrinsic::stackrestore);
Nico Weber8cdb3f92015-08-25 18:43:32 +00003381 CGF.Builder.CreateCall(F, StackBase);
3382 }
3383}
3384
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003385void CodeGenFunction::EmitNonNullArgCheck(RValue RV, QualType ArgType,
3386 SourceLocation ArgLoc,
Vedant Kumared00ea02017-03-06 05:28:22 +00003387 AbstractCallee AC,
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003388 unsigned ParmNum) {
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003389 if (!AC.getDecl() || !(SanOpts.has(SanitizerKind::NonnullAttribute) ||
3390 SanOpts.has(SanitizerKind::NullabilityArg)))
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003391 return;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003392
3393 // The param decl may be missing in a variadic function.
Vedant Kumared00ea02017-03-06 05:28:22 +00003394 auto PVD = ParmNum < AC.getNumParams() ? AC.getParamDecl(ParmNum) : nullptr;
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003395 unsigned ArgNo = PVD ? PVD->getFunctionScopeIndex() : ParmNum;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003396
Fangrui Song6907ce22018-07-30 19:24:48 +00003397 // Prefer the nonnull attribute if it's present.
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003398 const NonNullAttr *NNAttr = nullptr;
3399 if (SanOpts.has(SanitizerKind::NonnullAttribute))
3400 NNAttr = getNonNullAttr(AC.getDecl(), PVD, ArgType, ArgNo);
3401
3402 bool CanCheckNullability = false;
3403 if (SanOpts.has(SanitizerKind::NullabilityArg) && !NNAttr && PVD) {
3404 auto Nullability = PVD->getType()->getNullability(getContext());
3405 CanCheckNullability = Nullability &&
3406 *Nullability == NullabilityKind::NonNull &&
3407 PVD->getTypeSourceInfo();
3408 }
3409
3410 if (!NNAttr && !CanCheckNullability)
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003411 return;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003412
3413 SourceLocation AttrLoc;
3414 SanitizerMask CheckKind;
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00003415 SanitizerHandler Handler;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003416 if (NNAttr) {
3417 AttrLoc = NNAttr->getLocation();
3418 CheckKind = SanitizerKind::NonnullAttribute;
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00003419 Handler = SanitizerHandler::NonnullArg;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003420 } else {
3421 AttrLoc = PVD->getTypeSourceInfo()->getTypeLoc().findNullabilityLoc();
3422 CheckKind = SanitizerKind::NullabilityArg;
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00003423 Handler = SanitizerHandler::NullabilityArg;
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003424 }
3425
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003426 SanitizerScope SanScope(this);
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003427 assert(RV.isScalar());
3428 llvm::Value *V = RV.getScalarVal();
3429 llvm::Value *Cond =
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003430 Builder.CreateICmpNE(V, llvm::Constant::getNullValue(V->getType()));
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003431 llvm::Constant *StaticData[] = {
Vedant Kumar42c17ec2017-03-14 01:56:34 +00003432 EmitCheckSourceLocation(ArgLoc), EmitCheckSourceLocation(AttrLoc),
Nuno Lopes1ba2d782015-05-30 16:11:40 +00003433 llvm::ConstantInt::get(Int32Ty, ArgNo + 1),
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003434 };
Vedant Kumar2b9f48a2017-03-14 16:48:29 +00003435 EmitCheck(std::make_pair(Cond, CheckKind), Handler, StaticData, None);
Alexey Samsonov8e1162c2014-09-08 17:22:45 +00003436}
3437
David Blaikief05779e2015-07-21 18:37:18 +00003438void CodeGenFunction::EmitCallArgs(
3439 CallArgList &Args, ArrayRef<QualType> ArgTypes,
3440 llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
Vedant Kumared00ea02017-03-06 05:28:22 +00003441 AbstractCallee AC, unsigned ParamsToSkip, EvaluationOrder Order) {
David Blaikief05779e2015-07-21 18:37:18 +00003442 assert((int)ArgTypes.size() == (ArgRange.end() - ArgRange.begin()));
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003443
Reid Kleckner739756c2013-12-04 19:23:12 +00003444 // We *have* to evaluate arguments from right to left in the MS C++ ABI,
Richard Smitha560ccf2016-09-29 21:30:12 +00003445 // because arguments are destroyed left to right in the callee. As a special
3446 // case, there are certain language constructs that require left-to-right
3447 // evaluation, and in those cases we consider the evaluation order requirement
3448 // to trump the "destruction order is reverse construction order" guarantee.
3449 bool LeftToRight =
3450 CGM.getTarget().getCXXABI().areArgsDestroyedLeftToRightInCallee()
3451 ? Order == EvaluationOrder::ForceLeftToRight
3452 : Order != EvaluationOrder::ForceRightToLeft;
3453
George Burgess IV0d6592a2017-02-23 05:59:56 +00003454 auto MaybeEmitImplicitObjectSize = [&](unsigned I, const Expr *Arg,
3455 RValue EmittedArg) {
Vedant Kumared00ea02017-03-06 05:28:22 +00003456 if (!AC.hasFunctionDecl() || I >= AC.getNumParams())
George Burgess IV0d6592a2017-02-23 05:59:56 +00003457 return;
Vedant Kumared00ea02017-03-06 05:28:22 +00003458 auto *PS = AC.getParamDecl(I)->getAttr<PassObjectSizeAttr>();
George Burgess IV0d6592a2017-02-23 05:59:56 +00003459 if (PS == nullptr)
3460 return;
3461
3462 const auto &Context = getContext();
3463 auto SizeTy = Context.getSizeType();
3464 auto T = Builder.getIntNTy(Context.getTypeSize(SizeTy));
3465 assert(EmittedArg.getScalarVal() && "We emitted nothing for the arg?");
3466 llvm::Value *V = evaluateOrEmitBuiltinObjectSize(Arg, PS->getType(), T,
Erik Pilkington9c3b5882019-01-30 20:34:53 +00003467 EmittedArg.getScalarVal(),
3468 /*IsDynamic=*/false);
George Burgess IV0d6592a2017-02-23 05:59:56 +00003469 Args.add(RValue::get(V), SizeTy);
3470 // If we're emitting args in reverse, be sure to do so with
3471 // pass_object_size, as well.
3472 if (!LeftToRight)
3473 std::swap(Args.back(), *(&Args.back() - 1));
3474 };
3475
Richard Smitha560ccf2016-09-29 21:30:12 +00003476 // Insert a stack save if we're going to need any inalloca args.
3477 bool HasInAllocaArgs = false;
3478 if (CGM.getTarget().getCXXABI().isMicrosoft()) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003479 for (ArrayRef<QualType>::iterator I = ArgTypes.begin(), E = ArgTypes.end();
3480 I != E && !HasInAllocaArgs; ++I)
3481 HasInAllocaArgs = isInAllocaArgument(CGM.getCXXABI(), *I);
3482 if (HasInAllocaArgs) {
3483 assert(getTarget().getTriple().getArch() == llvm::Triple::x86);
3484 Args.allocateArgumentMemory(*this);
3485 }
Richard Smitha560ccf2016-09-29 21:30:12 +00003486 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003487
Richard Smitha560ccf2016-09-29 21:30:12 +00003488 // Evaluate each argument in the appropriate order.
3489 size_t CallArgsStart = Args.size();
3490 for (unsigned I = 0, E = ArgTypes.size(); I != E; ++I) {
3491 unsigned Idx = LeftToRight ? I : E - I - 1;
3492 CallExpr::const_arg_iterator Arg = ArgRange.begin() + Idx;
George Burgess IV0d6592a2017-02-23 05:59:56 +00003493 unsigned InitialArgSize = Args.size();
Akira Hatanaka46dd7dbc2017-06-28 00:42:48 +00003494 // If *Arg is an ObjCIndirectCopyRestoreExpr, check that either the types of
3495 // the argument and parameter match or the objc method is parameterized.
3496 assert((!isa<ObjCIndirectCopyRestoreExpr>(*Arg) ||
3497 getContext().hasSameUnqualifiedType((*Arg)->getType(),
3498 ArgTypes[Idx]) ||
3499 (isa<ObjCMethodDecl>(AC.getDecl()) &&
3500 isObjCMethodWithTypeParams(cast<ObjCMethodDecl>(AC.getDecl())))) &&
3501 "Argument and parameter types don't match");
Richard Smitha560ccf2016-09-29 21:30:12 +00003502 EmitCallArg(Args, *Arg, ArgTypes[Idx]);
George Burgess IV0d6592a2017-02-23 05:59:56 +00003503 // In particular, we depend on it being the last arg in Args, and the
3504 // objectsize bits depend on there only being one arg if !LeftToRight.
3505 assert(InitialArgSize + 1 == Args.size() &&
3506 "The code below depends on only adding one arg per EmitCallArg");
3507 (void)InitialArgSize;
Yaxun Liu5b330e82018-03-15 15:25:19 +00003508 // Since pointer argument are never emitted as LValue, it is safe to emit
3509 // non-null argument check for r-value only.
3510 if (!Args.back().hasLValue()) {
3511 RValue RVArg = Args.back().getKnownRValue();
3512 EmitNonNullArgCheck(RVArg, ArgTypes[Idx], (*Arg)->getExprLoc(), AC,
3513 ParamsToSkip + Idx);
3514 // @llvm.objectsize should never have side-effects and shouldn't need
3515 // destruction/cleanups, so we can safely "emit" it after its arg,
3516 // regardless of right-to-leftness
3517 MaybeEmitImplicitObjectSize(Idx, *Arg, RVArg);
3518 }
Richard Smitha560ccf2016-09-29 21:30:12 +00003519 }
Reid Kleckner739756c2013-12-04 19:23:12 +00003520
Richard Smitha560ccf2016-09-29 21:30:12 +00003521 if (!LeftToRight) {
Reid Kleckner739756c2013-12-04 19:23:12 +00003522 // Un-reverse the arguments we just evaluated so they match up with the LLVM
3523 // IR function.
3524 std::reverse(Args.begin() + CallArgsStart, Args.end());
Reid Kleckner739756c2013-12-04 19:23:12 +00003525 }
3526}
3527
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003528namespace {
3529
David Blaikie7e70d682015-08-18 22:40:54 +00003530struct DestroyUnpassedArg final : EHScopeStack::Cleanup {
John McCall7f416cc2015-09-08 08:05:57 +00003531 DestroyUnpassedArg(Address Addr, QualType Ty)
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003532 : Addr(Addr), Ty(Ty) {}
3533
John McCall7f416cc2015-09-08 08:05:57 +00003534 Address Addr;
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003535 QualType Ty;
3536
Craig Topper4f12f102014-03-12 06:41:41 +00003537 void Emit(CodeGenFunction &CGF, Flags flags) override {
Akira Hatanaka7275da02018-02-28 07:15:55 +00003538 QualType::DestructionKind DtorKind = Ty.isDestructedType();
3539 if (DtorKind == QualType::DK_cxx_destructor) {
3540 const CXXDestructorDecl *Dtor = Ty->getAsCXXRecordDecl()->getDestructor();
3541 assert(!Dtor->isTrivial());
3542 CGF.EmitCXXDestructorCall(Dtor, Dtor_Complete, /*for vbase*/ false,
3543 /*Delegating=*/false, Addr);
3544 } else {
3545 CGF.callCStructDestructor(CGF.MakeAddrLValue(Addr, Ty));
3546 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003547 }
3548};
3549
David Blaikie38b25912015-02-09 19:13:51 +00003550struct DisableDebugLocationUpdates {
3551 CodeGenFunction &CGF;
3552 bool disabledDebugInfo;
3553 DisableDebugLocationUpdates(CodeGenFunction &CGF, const Expr *E) : CGF(CGF) {
3554 if ((disabledDebugInfo = isa<CXXDefaultArgExpr>(E) && CGF.getDebugInfo()))
3555 CGF.disableDebugInfo();
3556 }
3557 ~DisableDebugLocationUpdates() {
3558 if (disabledDebugInfo)
3559 CGF.enableDebugInfo();
3560 }
3561};
3562
Benjamin Kramer5b4296a2015-10-28 17:16:26 +00003563} // end anonymous namespace
3564
Yaxun Liu5b330e82018-03-15 15:25:19 +00003565RValue CallArg::getRValue(CodeGenFunction &CGF) const {
3566 if (!HasLV)
3567 return RV;
3568 LValue Copy = CGF.MakeAddrLValue(CGF.CreateMemTemp(Ty), Ty);
Richard Smithe78fac52018-04-05 20:52:58 +00003569 CGF.EmitAggregateCopy(Copy, LV, Ty, AggValueSlot::DoesNotOverlap,
3570 LV.isVolatile());
Yaxun Liu5b330e82018-03-15 15:25:19 +00003571 IsUsed = true;
3572 return RValue::getAggregate(Copy.getAddress());
3573}
3574
3575void CallArg::copyInto(CodeGenFunction &CGF, Address Addr) const {
3576 LValue Dst = CGF.MakeAddrLValue(Addr, Ty);
3577 if (!HasLV && RV.isScalar())
3578 CGF.EmitStoreOfScalar(RV.getScalarVal(), Dst, /*init=*/true);
3579 else if (!HasLV && RV.isComplex())
3580 CGF.EmitStoreOfComplex(RV.getComplexVal(), Dst, /*init=*/true);
3581 else {
3582 auto Addr = HasLV ? LV.getAddress() : RV.getAggregateAddress();
3583 LValue SrcLV = CGF.MakeAddrLValue(Addr, Ty);
Richard Smithe78fac52018-04-05 20:52:58 +00003584 // We assume that call args are never copied into subobjects.
3585 CGF.EmitAggregateCopy(Dst, SrcLV, Ty, AggValueSlot::DoesNotOverlap,
Yaxun Liu5b330e82018-03-15 15:25:19 +00003586 HasLV ? LV.isVolatileQualified()
3587 : RV.isVolatileQualified());
3588 }
3589 IsUsed = true;
3590}
3591
John McCall32ea9692011-03-11 20:59:21 +00003592void CodeGenFunction::EmitCallArg(CallArgList &args, const Expr *E,
3593 QualType type) {
David Blaikie38b25912015-02-09 19:13:51 +00003594 DisableDebugLocationUpdates Dis(*this, E);
John McCall31168b02011-06-15 23:02:42 +00003595 if (const ObjCIndirectCopyRestoreExpr *CRE
3596 = dyn_cast<ObjCIndirectCopyRestoreExpr>(E)) {
Richard Smith9c6890a2012-11-01 22:30:59 +00003597 assert(getLangOpts().ObjCAutoRefCount);
John McCall31168b02011-06-15 23:02:42 +00003598 return emitWritebackArg(*this, args, CRE);
3599 }
3600
John McCall0a76c0c2011-08-26 18:42:59 +00003601 assert(type->isReferenceType() == E->isGLValue() &&
3602 "reference binding to unmaterialized r-value!");
3603
John McCall17054bd62011-08-26 21:08:13 +00003604 if (E->isGLValue()) {
3605 assert(E->getObjectKind() == OK_Ordinary);
Richard Smitha1c9d4d2013-06-12 23:38:09 +00003606 return args.add(EmitReferenceBindingToExpr(E), type);
John McCall17054bd62011-08-26 21:08:13 +00003607 }
Mike Stump11289f42009-09-09 15:08:12 +00003608
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003609 bool HasAggregateEvalKind = hasAggregateEvaluationKind(type);
3610
3611 // In the Microsoft C++ ABI, aggregate arguments are destructed by the callee.
3612 // However, we still have to push an EH-only cleanup in case we unwind before
3613 // we make it to the call.
Akira Hatanaka85282972018-05-15 21:00:30 +00003614 if (HasAggregateEvalKind &&
3615 type->getAs<RecordType>()->getDecl()->isParamDestroyedInCallee()) {
Reid Klecknerac640602014-05-01 03:07:18 +00003616 // If we're using inalloca, use the argument memory. Otherwise, use a
Reid Klecknere39ee212014-05-03 00:33:28 +00003617 // temporary.
Reid Klecknerac640602014-05-01 03:07:18 +00003618 AggValueSlot Slot;
3619 if (args.isUsingInAlloca())
3620 Slot = createPlaceholderSlot(*this, type);
3621 else
3622 Slot = CreateAggTemp(type, "agg.tmp");
Reid Klecknere39ee212014-05-03 00:33:28 +00003623
Akira Hatanaka4ce0e5a2018-04-18 23:33:15 +00003624 bool DestroyedInCallee = true, NeedsEHCleanup = true;
3625 if (const auto *RD = type->getAsCXXRecordDecl())
3626 DestroyedInCallee = RD->hasNonTrivialDestructor();
3627 else
3628 NeedsEHCleanup = needsEHCleanup(type.isDestructedType());
3629
3630 if (DestroyedInCallee)
3631 Slot.setExternallyDestructed();
Reid Klecknere39ee212014-05-03 00:33:28 +00003632
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003633 EmitAggExpr(E, Slot);
3634 RValue RV = Slot.asRValue();
3635 args.add(RV, type);
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003636
Akira Hatanaka4ce0e5a2018-04-18 23:33:15 +00003637 if (DestroyedInCallee && NeedsEHCleanup) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003638 // Create a no-op GEP between the placeholder and the cleanup so we can
3639 // RAUW it successfully. It also serves as a marker of the first
3640 // instruction where the cleanup is active.
John McCall7f416cc2015-09-08 08:05:57 +00003641 pushFullExprCleanup<DestroyUnpassedArg>(EHCleanup, Slot.getAddress(),
3642 type);
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003643 // This unreachable is a temporary marker which will be removed later.
3644 llvm::Instruction *IsActive = Builder.CreateUnreachable();
3645 args.addArgCleanupDeactivation(EHStack.getInnermostEHScope(), IsActive);
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003646 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003647 return;
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00003648 }
3649
3650 if (HasAggregateEvalKind && isa<ImplicitCastExpr>(E) &&
Eli Friedmandf968192011-05-26 00:10:27 +00003651 cast<CastExpr>(E)->getCastKind() == CK_LValueToRValue) {
3652 LValue L = EmitLValue(cast<CastExpr>(E)->getSubExpr());
3653 assert(L.isSimple());
Yaxun Liu5b330e82018-03-15 15:25:19 +00003654 args.addUncopiedAggregate(L, type);
Eli Friedmandf968192011-05-26 00:10:27 +00003655 return;
3656 }
3657
John McCall32ea9692011-03-11 20:59:21 +00003658 args.add(EmitAnyExprToTemp(E), type);
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00003659}
3660
Reid Kleckner79b0fd72014-10-10 00:05:45 +00003661QualType CodeGenFunction::getVarArgType(const Expr *Arg) {
3662 // System headers on Windows define NULL to 0 instead of 0LL on Win64. MSVC
3663 // implicitly widens null pointer constants that are arguments to varargs
3664 // functions to pointer-sized ints.
3665 if (!getTarget().getTriple().isOSWindows())
3666 return Arg->getType();
3667
3668 if (Arg->getType()->isIntegerType() &&
3669 getContext().getTypeSize(Arg->getType()) <
3670 getContext().getTargetInfo().getPointerWidth(0) &&
3671 Arg->isNullPointerConstant(getContext(),
3672 Expr::NPC_ValueDependentIsNotNull)) {
3673 return getContext().getIntPtrType();
3674 }
3675
3676 return Arg->getType();
3677}
3678
Dan Gohman515a60d2012-02-16 00:57:37 +00003679// In ObjC ARC mode with no ObjC ARC exception safety, tell the ARC
3680// optimizer it can aggressively ignore unwind edges.
3681void
3682CodeGenFunction::AddObjCARCExceptionMetadata(llvm::Instruction *Inst) {
3683 if (CGM.getCodeGenOpts().OptimizationLevel != 0 &&
3684 !CGM.getCodeGenOpts().ObjCAutoRefCountExceptions)
3685 Inst->setMetadata("clang.arc.no_objc_arc_exceptions",
3686 CGM.getNoObjCARCExceptionsMetadata());
3687}
3688
John McCall882987f2013-02-28 19:01:20 +00003689/// Emits a call to the given no-arguments nounwind runtime function.
3690llvm::CallInst *
3691CodeGenFunction::EmitNounwindRuntimeCall(llvm::Value *callee,
3692 const llvm::Twine &name) {
Craig Topper5fc8fc22014-08-27 06:28:36 +00003693 return EmitNounwindRuntimeCall(callee, None, name);
John McCall882987f2013-02-28 19:01:20 +00003694}
3695
3696/// Emits a call to the given nounwind runtime function.
3697llvm::CallInst *
3698CodeGenFunction::EmitNounwindRuntimeCall(llvm::Value *callee,
3699 ArrayRef<llvm::Value*> args,
3700 const llvm::Twine &name) {
3701 llvm::CallInst *call = EmitRuntimeCall(callee, args, name);
3702 call->setDoesNotThrow();
3703 return call;
3704}
3705
3706/// Emits a simple call (never an invoke) to the given no-arguments
3707/// runtime function.
3708llvm::CallInst *
3709CodeGenFunction::EmitRuntimeCall(llvm::Value *callee,
3710 const llvm::Twine &name) {
Craig Topper5fc8fc22014-08-27 06:28:36 +00003711 return EmitRuntimeCall(callee, None, name);
John McCall882987f2013-02-28 19:01:20 +00003712}
3713
David Majnemer0b17d442015-12-15 21:27:59 +00003714// Calls which may throw must have operand bundles indicating which funclet
3715// they are nested within.
Reid Klecknerb75a3f02018-02-09 00:16:41 +00003716SmallVector<llvm::OperandBundleDef, 1>
3717CodeGenFunction::getBundlesForFunclet(llvm::Value *Callee) {
3718 SmallVector<llvm::OperandBundleDef, 1> BundleList;
Sanjay Patel846b63b2016-01-18 22:15:33 +00003719 // There is no need for a funclet operand bundle if we aren't inside a
3720 // funclet.
David Majnemer0b17d442015-12-15 21:27:59 +00003721 if (!CurrentFuncletPad)
Reid Klecknerb75a3f02018-02-09 00:16:41 +00003722 return BundleList;
David Majnemer0b17d442015-12-15 21:27:59 +00003723
3724 // Skip intrinsics which cannot throw.
3725 auto *CalleeFn = dyn_cast<llvm::Function>(Callee->stripPointerCasts());
3726 if (CalleeFn && CalleeFn->isIntrinsic() && CalleeFn->doesNotThrow())
Reid Klecknerb75a3f02018-02-09 00:16:41 +00003727 return BundleList;
David Majnemer0b17d442015-12-15 21:27:59 +00003728
3729 BundleList.emplace_back("funclet", CurrentFuncletPad);
Reid Klecknerb75a3f02018-02-09 00:16:41 +00003730 return BundleList;
David Majnemer0b17d442015-12-15 21:27:59 +00003731}
3732
David Majnemer971d31b2016-02-24 17:02:45 +00003733/// Emits a simple call (never an invoke) to the given runtime function.
3734llvm::CallInst *
3735CodeGenFunction::EmitRuntimeCall(llvm::Value *callee,
3736 ArrayRef<llvm::Value*> args,
3737 const llvm::Twine &name) {
Reid Klecknerb75a3f02018-02-09 00:16:41 +00003738 llvm::CallInst *call =
3739 Builder.CreateCall(callee, args, getBundlesForFunclet(callee), name);
David Majnemer971d31b2016-02-24 17:02:45 +00003740 call->setCallingConv(getRuntimeCC());
3741 return call;
3742}
3743
John McCall882987f2013-02-28 19:01:20 +00003744/// Emits a call or invoke to the given noreturn runtime function.
3745void CodeGenFunction::EmitNoreturnRuntimeCallOrInvoke(llvm::Value *callee,
3746 ArrayRef<llvm::Value*> args) {
Reid Klecknerb75a3f02018-02-09 00:16:41 +00003747 SmallVector<llvm::OperandBundleDef, 1> BundleList =
3748 getBundlesForFunclet(callee);
David Majnemer0b17d442015-12-15 21:27:59 +00003749
John McCall882987f2013-02-28 19:01:20 +00003750 if (getInvokeDest()) {
Fangrui Song6907ce22018-07-30 19:24:48 +00003751 llvm::InvokeInst *invoke =
John McCall882987f2013-02-28 19:01:20 +00003752 Builder.CreateInvoke(callee,
3753 getUnreachableBlock(),
3754 getInvokeDest(),
David Majnemer0b17d442015-12-15 21:27:59 +00003755 args,
3756 BundleList);
John McCall882987f2013-02-28 19:01:20 +00003757 invoke->setDoesNotReturn();
3758 invoke->setCallingConv(getRuntimeCC());
3759 } else {
David Majnemer0b17d442015-12-15 21:27:59 +00003760 llvm::CallInst *call = Builder.CreateCall(callee, args, BundleList);
John McCall882987f2013-02-28 19:01:20 +00003761 call->setDoesNotReturn();
3762 call->setCallingConv(getRuntimeCC());
3763 Builder.CreateUnreachable();
3764 }
3765}
3766
Sanjay Patel846b63b2016-01-18 22:15:33 +00003767/// Emits a call or invoke instruction to the given nullary runtime function.
James Y Knight3933add2019-01-30 02:54:28 +00003768llvm::CallBase *CodeGenFunction::EmitRuntimeCallOrInvoke(llvm::Value *callee,
3769 const Twine &name) {
Craig Topper5fc8fc22014-08-27 06:28:36 +00003770 return EmitRuntimeCallOrInvoke(callee, None, name);
John McCall882987f2013-02-28 19:01:20 +00003771}
3772
3773/// Emits a call or invoke instruction to the given runtime function.
James Y Knight3933add2019-01-30 02:54:28 +00003774llvm::CallBase *CodeGenFunction::EmitRuntimeCallOrInvoke(
3775 llvm::Value *callee, ArrayRef<llvm::Value *> args, const Twine &name) {
3776 llvm::CallBase *call = EmitCallOrInvoke(callee, args, name);
3777 call->setCallingConv(getRuntimeCC());
3778 return call;
John McCall882987f2013-02-28 19:01:20 +00003779}
3780
John McCallbd309292010-07-06 01:34:17 +00003781/// Emits a call or invoke instruction to the given function, depending
3782/// on the current state of the EH stack.
James Y Knight3933add2019-01-30 02:54:28 +00003783llvm::CallBase *CodeGenFunction::EmitCallOrInvoke(llvm::Value *Callee,
3784 ArrayRef<llvm::Value *> Args,
3785 const Twine &Name) {
John McCallbd309292010-07-06 01:34:17 +00003786 llvm::BasicBlock *InvokeDest = getInvokeDest();
Reid Klecknerb75a3f02018-02-09 00:16:41 +00003787 SmallVector<llvm::OperandBundleDef, 1> BundleList =
3788 getBundlesForFunclet(Callee);
John McCallbd309292010-07-06 01:34:17 +00003789
James Y Knight3933add2019-01-30 02:54:28 +00003790 llvm::CallBase *Inst;
Dan Gohman515a60d2012-02-16 00:57:37 +00003791 if (!InvokeDest)
David Majnemer3df77bc2016-01-26 23:14:47 +00003792 Inst = Builder.CreateCall(Callee, Args, BundleList, Name);
Dan Gohman515a60d2012-02-16 00:57:37 +00003793 else {
3794 llvm::BasicBlock *ContBB = createBasicBlock("invoke.cont");
David Majnemer3df77bc2016-01-26 23:14:47 +00003795 Inst = Builder.CreateInvoke(Callee, ContBB, InvokeDest, Args, BundleList,
3796 Name);
Dan Gohman515a60d2012-02-16 00:57:37 +00003797 EmitBlock(ContBB);
3798 }
3799
3800 // In ObjC ARC mode with no ObjC ARC exception safety, tell the ARC
3801 // optimizer it can aggressively ignore unwind edges.
David Blaikiebbafb8a2012-03-11 07:00:24 +00003802 if (CGM.getLangOpts().ObjCAutoRefCount)
Dan Gohman515a60d2012-02-16 00:57:37 +00003803 AddObjCARCExceptionMetadata(Inst);
3804
James Y Knight3933add2019-01-30 02:54:28 +00003805 return Inst;
John McCallbd309292010-07-06 01:34:17 +00003806}
3807
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003808void CodeGenFunction::deferPlaceholderReplacement(llvm::Instruction *Old,
3809 llvm::Value *New) {
3810 DeferredReplacements.push_back(std::make_pair(Old, New));
3811}
Chris Lattnerd59d8672011-07-12 06:29:11 +00003812
Daniel Dunbard931a872009-02-02 22:03:45 +00003813RValue CodeGenFunction::EmitCall(const CGFunctionInfo &CallInfo,
John McCallb92ab1a2016-10-26 23:46:34 +00003814 const CGCallee &Callee,
Anders Carlsson61a401c2009-12-24 19:25:24 +00003815 ReturnValueSlot ReturnValue,
Daniel Dunbarcdbb5e32009-02-20 18:06:48 +00003816 const CallArgList &CallArgs,
James Y Knight3933add2019-01-30 02:54:28 +00003817 llvm::CallBase **callOrInvoke,
Vedant Kumar09b5bfd2017-12-21 00:10:25 +00003818 SourceLocation Loc) {
Mike Stump18bb9282009-05-16 07:57:57 +00003819 // FIXME: We no longer need the types from CallArgs; lift up and simplify.
Daniel Dunbar613855c2008-09-09 23:27:19 +00003820
Peter Collingbourneea211002018-02-05 23:09:13 +00003821 assert(Callee.isOrdinary() || Callee.isVirtual());
John McCallb92ab1a2016-10-26 23:46:34 +00003822
Daniel Dunbar613855c2008-09-09 23:27:19 +00003823 // Handle struct-return functions by passing a pointer to the
3824 // location that we would like to return into.
Daniel Dunbar7633cbf2009-02-02 21:43:58 +00003825 QualType RetTy = CallInfo.getReturnType();
Daniel Dunbarb52d0772009-02-03 05:59:18 +00003826 const ABIArgInfo &RetAI = CallInfo.getReturnInfo();
Mike Stump11289f42009-09-09 15:08:12 +00003827
John McCallb92ab1a2016-10-26 23:46:34 +00003828 llvm::FunctionType *IRFuncTy = Callee.getFunctionType();
3829
James Y Knightb92d2902019-02-05 16:05:50 +00003830#ifndef NDEBUG
3831 if (!(CallInfo.isVariadic() && CallInfo.getArgStruct())) {
3832 // For an inalloca varargs function, we don't expect CallInfo to match the
3833 // function pointer's type, because the inalloca struct a will have extra
3834 // fields in it for the varargs parameters. Code later in this function
3835 // bitcasts the function pointer to the type derived from CallInfo.
3836 //
3837 // In other cases, we assert that the types match up (until pointers stop
3838 // having pointee types).
3839 llvm::FunctionType *IRFuncTyFromInfo = getTypes().GetFunctionType(CallInfo);
3840 assert(IRFuncTy == IRFuncTyFromInfo);
3841 }
3842#endif
3843
John McCallb92ab1a2016-10-26 23:46:34 +00003844 // 1. Set up the arguments.
Mike Stump11289f42009-09-09 15:08:12 +00003845
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003846 // If we're using inalloca, insert the allocation after the stack save.
3847 // FIXME: Do this earlier rather than hacking it in here!
John McCall7f416cc2015-09-08 08:05:57 +00003848 Address ArgMemory = Address::invalid();
3849 const llvm::StructLayout *ArgMemoryLayout = nullptr;
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003850 if (llvm::StructType *ArgStruct = CallInfo.getArgStruct()) {
Matt Arsenault502ad602017-04-10 22:28:02 +00003851 const llvm::DataLayout &DL = CGM.getDataLayout();
3852 ArgMemoryLayout = DL.getStructLayout(ArgStruct);
Reid Kleckner9df1d972014-04-10 01:40:15 +00003853 llvm::Instruction *IP = CallArgs.getStackBase();
3854 llvm::AllocaInst *AI;
3855 if (IP) {
3856 IP = IP->getNextNode();
Matt Arsenault502ad602017-04-10 22:28:02 +00003857 AI = new llvm::AllocaInst(ArgStruct, DL.getAllocaAddrSpace(),
3858 "argmem", IP);
Reid Kleckner9df1d972014-04-10 01:40:15 +00003859 } else {
Reid Kleckner966abe72014-05-15 23:01:46 +00003860 AI = CreateTempAlloca(ArgStruct, "argmem");
Reid Kleckner9df1d972014-04-10 01:40:15 +00003861 }
John McCall7f416cc2015-09-08 08:05:57 +00003862 auto Align = CallInfo.getArgStructAlignment();
3863 AI->setAlignment(Align.getQuantity());
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003864 AI->setUsedWithInAlloca(true);
3865 assert(AI->isUsedWithInAlloca() && !AI->isStaticAlloca());
John McCall7f416cc2015-09-08 08:05:57 +00003866 ArgMemory = Address(AI, Align);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003867 }
3868
John McCall7f416cc2015-09-08 08:05:57 +00003869 // Helper function to drill into the inalloca allocation.
3870 auto createInAllocaStructGEP = [&](unsigned FieldIndex) -> Address {
3871 auto FieldOffset =
3872 CharUnits::fromQuantity(ArgMemoryLayout->getElementOffset(FieldIndex));
3873 return Builder.CreateStructGEP(ArgMemory, FieldIndex, FieldOffset);
3874 };
3875
Alexey Samsonov153004f2014-09-29 22:08:00 +00003876 ClangToLLVMArgMapping IRFunctionArgs(CGM.getContext(), CallInfo);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003877 SmallVector<llvm::Value *, 16> IRCallArgs(IRFunctionArgs.totalIRArgs());
3878
Chris Lattner4ca97c32009-06-13 00:26:38 +00003879 // If the call returns a temporary with struct return, create a temporary
Anders Carlsson17490832009-12-24 20:40:36 +00003880 // alloca to hold the result, unless one is given to us.
John McCall7f416cc2015-09-08 08:05:57 +00003881 Address SRetPtr = Address::invalid();
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00003882 Address SRetAlloca = Address::invalid();
George Burgess IV003be7c2018-03-08 05:32:30 +00003883 llvm::Value *UnusedReturnSizePtr = nullptr;
John McCallf26e73d2016-03-11 04:30:43 +00003884 if (RetAI.isIndirect() || RetAI.isInAlloca() || RetAI.isCoerceAndExpand()) {
John McCall7f416cc2015-09-08 08:05:57 +00003885 if (!ReturnValue.isNull()) {
3886 SRetPtr = ReturnValue.getValue();
3887 } else {
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00003888 SRetPtr = CreateMemTemp(RetTy, "tmp", &SRetAlloca);
Leny Kholodov6aab1112015-06-08 10:23:49 +00003889 if (HaveInsertPoint() && ReturnValue.isUnused()) {
3890 uint64_t size =
3891 CGM.getDataLayout().getTypeAllocSize(ConvertTypeForMem(RetTy));
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00003892 UnusedReturnSizePtr = EmitLifetimeStart(size, SRetAlloca.getPointer());
Leny Kholodov6aab1112015-06-08 10:23:49 +00003893 }
3894 }
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003895 if (IRFunctionArgs.hasSRetArg()) {
John McCall7f416cc2015-09-08 08:05:57 +00003896 IRCallArgs[IRFunctionArgs.getSRetArgNo()] = SRetPtr.getPointer();
John McCallf26e73d2016-03-11 04:30:43 +00003897 } else if (RetAI.isInAlloca()) {
John McCall7f416cc2015-09-08 08:05:57 +00003898 Address Addr = createInAllocaStructGEP(RetAI.getInAllocaFieldIndex());
3899 Builder.CreateStore(SRetPtr.getPointer(), Addr);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003900 }
Anders Carlsson17490832009-12-24 20:40:36 +00003901 }
Mike Stump11289f42009-09-09 15:08:12 +00003902
John McCall12f23522016-04-04 18:33:08 +00003903 Address swiftErrorTemp = Address::invalid();
3904 Address swiftErrorArg = Address::invalid();
3905
John McCallb92ab1a2016-10-26 23:46:34 +00003906 // Translate all of the arguments as necessary to match the IR lowering.
Daniel Dunbara45bdbb2009-02-04 21:17:21 +00003907 assert(CallInfo.arg_size() == CallArgs.size() &&
3908 "Mismatch between function signature & arguments.");
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003909 unsigned ArgNo = 0;
Daniel Dunbarb52d0772009-02-03 05:59:18 +00003910 CGFunctionInfo::const_arg_iterator info_it = CallInfo.arg_begin();
Mike Stump11289f42009-09-09 15:08:12 +00003911 for (CallArgList::const_iterator I = CallArgs.begin(), E = CallArgs.end();
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003912 I != E; ++I, ++info_it, ++ArgNo) {
Daniel Dunbarb52d0772009-02-03 05:59:18 +00003913 const ABIArgInfo &ArgInfo = info_it->info;
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00003914
Rafael Espindolafad28de2012-10-24 01:59:00 +00003915 // Insert a padding argument to ensure proper alignment.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003916 if (IRFunctionArgs.hasPaddingArg(ArgNo))
3917 IRCallArgs[IRFunctionArgs.getPaddingArgNo(ArgNo)] =
3918 llvm::UndefValue::get(ArgInfo.getPaddingType());
3919
3920 unsigned FirstIRArg, NumIRArgs;
3921 std::tie(FirstIRArg, NumIRArgs) = IRFunctionArgs.getIRArgs(ArgNo);
Rafael Espindolafad28de2012-10-24 01:59:00 +00003922
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00003923 switch (ArgInfo.getKind()) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003924 case ABIArgInfo::InAlloca: {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003925 assert(NumIRArgs == 0);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003926 assert(getTarget().getTriple().getArch() == llvm::Triple::x86);
Yaxun Liu5b330e82018-03-15 15:25:19 +00003927 if (I->isAggregate()) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003928 // Replace the placeholder with the appropriate argument slot GEP.
Yaxun Liu5b330e82018-03-15 15:25:19 +00003929 Address Addr = I->hasLValue()
3930 ? I->getKnownLValue().getAddress()
3931 : I->getKnownRValue().getAggregateAddress();
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003932 llvm::Instruction *Placeholder =
Yaxun Liu5b330e82018-03-15 15:25:19 +00003933 cast<llvm::Instruction>(Addr.getPointer());
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003934 CGBuilderTy::InsertPoint IP = Builder.saveIP();
3935 Builder.SetInsertPoint(Placeholder);
Yaxun Liu5b330e82018-03-15 15:25:19 +00003936 Addr = createInAllocaStructGEP(ArgInfo.getInAllocaFieldIndex());
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003937 Builder.restoreIP(IP);
John McCall7f416cc2015-09-08 08:05:57 +00003938 deferPlaceholderReplacement(Placeholder, Addr.getPointer());
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003939 } else {
3940 // Store the RValue into the argument struct.
John McCall7f416cc2015-09-08 08:05:57 +00003941 Address Addr = createInAllocaStructGEP(ArgInfo.getInAllocaFieldIndex());
3942 unsigned AS = Addr.getType()->getPointerAddressSpace();
David Majnemer32b57b02014-03-31 16:12:47 +00003943 llvm::Type *MemType = ConvertTypeForMem(I->Ty)->getPointerTo(AS);
3944 // There are some cases where a trivial bitcast is not avoidable. The
3945 // definition of a type later in a translation unit may change it's type
3946 // from {}* to (%struct.foo*)*.
John McCall7f416cc2015-09-08 08:05:57 +00003947 if (Addr.getType() != MemType)
David Majnemer32b57b02014-03-31 16:12:47 +00003948 Addr = Builder.CreateBitCast(Addr, MemType);
Yaxun Liu5b330e82018-03-15 15:25:19 +00003949 I->copyInto(*this, Addr);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003950 }
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003951 break;
Reid Kleckner314ef7b2014-02-01 00:04:45 +00003952 }
3953
Daniel Dunbar03816342010-08-21 02:24:36 +00003954 case ABIArgInfo::Indirect: {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00003955 assert(NumIRArgs == 1);
Yaxun Liu5b330e82018-03-15 15:25:19 +00003956 if (!I->isAggregate()) {
Daniel Dunbar747865a2009-02-05 09:16:39 +00003957 // Make a temporary alloca to pass the argument.
Yaxun Liuaefdb8e2018-06-15 15:33:22 +00003958 Address Addr = CreateMemTempWithoutCast(
3959 I->Ty, ArgInfo.getIndirectAlign(), "indirect-arg-temp");
John McCall7f416cc2015-09-08 08:05:57 +00003960 IRCallArgs[FirstIRArg] = Addr.getPointer();
John McCall47fb9502013-03-07 21:37:08 +00003961
Yaxun Liu5b330e82018-03-15 15:25:19 +00003962 I->copyInto(*this, Addr);
Daniel Dunbar747865a2009-02-05 09:16:39 +00003963 } else {
Eli Friedmaneb7fab62011-06-14 01:37:52 +00003964 // We want to avoid creating an unnecessary temporary+copy here;
Guy Benyei3832bfd2013-03-10 12:59:00 +00003965 // however, we need one in three cases:
Eli Friedmaneb7fab62011-06-14 01:37:52 +00003966 // 1. If the argument is not byval, and we are required to copy the
3967 // source. (This case doesn't occur on any common architecture.)
3968 // 2. If the argument is byval, RV is not sufficiently aligned, and
3969 // we cannot force it to be sufficiently aligned.
Yaxun Liu5b330e82018-03-15 15:25:19 +00003970 // 3. If the argument is byval, but RV is not located in default
3971 // or alloca address space.
3972 Address Addr = I->hasLValue()
3973 ? I->getKnownLValue().getAddress()
3974 : I->getKnownRValue().getAggregateAddress();
3975 llvm::Value *V = Addr.getPointer();
John McCall7f416cc2015-09-08 08:05:57 +00003976 CharUnits Align = ArgInfo.getIndirectAlign();
Micah Villmowdd31ca12012-10-08 16:25:52 +00003977 const llvm::DataLayout *TD = &CGM.getDataLayout();
Yaxun Liu5b330e82018-03-15 15:25:19 +00003978
3979 assert((FirstIRArg >= IRFuncTy->getNumParams() ||
3980 IRFuncTy->getParamType(FirstIRArg)->getPointerAddressSpace() ==
3981 TD->getAllocaAddrSpace()) &&
3982 "indirect argument must be in alloca address space");
3983
3984 bool NeedCopy = false;
3985
3986 if (Addr.getAlignment() < Align &&
3987 llvm::getOrEnforceKnownAlignment(V, Align.getQuantity(), *TD) <
3988 Align.getQuantity()) {
3989 NeedCopy = true;
3990 } else if (I->hasLValue()) {
3991 auto LV = I->getKnownLValue();
3992 auto AS = LV.getAddressSpace();
Andrew Savonichev1bf1a152018-12-10 12:03:00 +00003993
Yaxun Liu5b330e82018-03-15 15:25:19 +00003994 if ((!ArgInfo.getIndirectByVal() &&
3995 (LV.getAlignment() >=
Andrew Savonichev1bf1a152018-12-10 12:03:00 +00003996 getContext().getTypeAlignInChars(I->Ty)))) {
3997 NeedCopy = true;
3998 }
3999 if (!getLangOpts().OpenCL) {
4000 if ((ArgInfo.getIndirectByVal() &&
4001 (AS != LangAS::Default &&
4002 AS != CGM.getASTAllocaAddressSpace()))) {
4003 NeedCopy = true;
4004 }
4005 }
4006 // For OpenCL even if RV is located in default or alloca address space
4007 // we don't want to perform address space cast for it.
4008 else if ((ArgInfo.getIndirectByVal() &&
4009 Addr.getType()->getAddressSpace() != IRFuncTy->
4010 getParamType(FirstIRArg)->getPointerAddressSpace())) {
Yaxun Liu5b330e82018-03-15 15:25:19 +00004011 NeedCopy = true;
4012 }
4013 }
Andrew Savonichev1bf1a152018-12-10 12:03:00 +00004014
Yaxun Liu5b330e82018-03-15 15:25:19 +00004015 if (NeedCopy) {
Eli Friedmaneb7fab62011-06-14 01:37:52 +00004016 // Create an aligned temporary, and copy to it.
Yaxun Liuaefdb8e2018-06-15 15:33:22 +00004017 Address AI = CreateMemTempWithoutCast(
4018 I->Ty, ArgInfo.getIndirectAlign(), "byval-temp");
John McCall7f416cc2015-09-08 08:05:57 +00004019 IRCallArgs[FirstIRArg] = AI.getPointer();
Yaxun Liu5b330e82018-03-15 15:25:19 +00004020 I->copyInto(*this, AI);
Eli Friedmaneb7fab62011-06-14 01:37:52 +00004021 } else {
4022 // Skip the extra memcpy call.
Yaxun Liu5b330e82018-03-15 15:25:19 +00004023 auto *T = V->getType()->getPointerElementType()->getPointerTo(
4024 CGM.getDataLayout().getAllocaAddrSpace());
4025 IRCallArgs[FirstIRArg] = getTargetHooks().performAddrSpaceCast(
4026 *this, V, LangAS::Default, CGM.getASTAllocaAddressSpace(), T,
4027 true);
Eli Friedmaneb7fab62011-06-14 01:37:52 +00004028 }
Daniel Dunbar747865a2009-02-05 09:16:39 +00004029 }
4030 break;
Daniel Dunbar03816342010-08-21 02:24:36 +00004031 }
Daniel Dunbar747865a2009-02-05 09:16:39 +00004032
Daniel Dunbar94a6f252009-01-26 21:26:08 +00004033 case ABIArgInfo::Ignore:
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004034 assert(NumIRArgs == 0);
Daniel Dunbar94a6f252009-01-26 21:26:08 +00004035 break;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004036
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00004037 case ABIArgInfo::Extend:
4038 case ABIArgInfo::Direct: {
4039 if (!isa<llvm::StructType>(ArgInfo.getCoerceToType()) &&
Chris Lattner8a2f3c72010-07-30 04:02:24 +00004040 ArgInfo.getCoerceToType() == ConvertType(info_it->type) &&
4041 ArgInfo.getDirectOffset() == 0) {
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004042 assert(NumIRArgs == 1);
Chris Lattnerbb1952c2011-07-12 04:46:18 +00004043 llvm::Value *V;
Yaxun Liu5b330e82018-03-15 15:25:19 +00004044 if (!I->isAggregate())
4045 V = I->getKnownRValue().getScalarVal();
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00004046 else
Yaxun Liu5b330e82018-03-15 15:25:19 +00004047 V = Builder.CreateLoad(
4048 I->hasLValue() ? I->getKnownLValue().getAddress()
4049 : I->getKnownRValue().getAggregateAddress());
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004050
John McCall12f23522016-04-04 18:33:08 +00004051 // Implement swifterror by copying into a new swifterror argument.
4052 // We'll write back in the normal path out of the call.
4053 if (CallInfo.getExtParameterInfo(ArgNo).getABI()
4054 == ParameterABI::SwiftErrorResult) {
4055 assert(!swiftErrorTemp.isValid() && "multiple swifterror args");
4056
4057 QualType pointeeTy = I->Ty->getPointeeType();
4058 swiftErrorArg =
4059 Address(V, getContext().getTypeAlignInChars(pointeeTy));
4060
4061 swiftErrorTemp =
4062 CreateMemTemp(pointeeTy, getPointerAlign(), "swifterror.temp");
4063 V = swiftErrorTemp.getPointer();
4064 cast<llvm::AllocaInst>(V)->setSwiftError(true);
4065
4066 llvm::Value *errorValue = Builder.CreateLoad(swiftErrorArg);
4067 Builder.CreateStore(errorValue, swiftErrorTemp);
4068 }
4069
Reid Kleckner79b0fd72014-10-10 00:05:45 +00004070 // We might have to widen integers, but we should never truncate.
4071 if (ArgInfo.getCoerceToType() != V->getType() &&
4072 V->getType()->isIntegerTy())
4073 V = Builder.CreateZExt(V, ArgInfo.getCoerceToType());
4074
Chris Lattner3ce86682011-07-12 04:53:39 +00004075 // If the argument doesn't match, perform a bitcast to coerce it. This
4076 // can happen due to trivial type mismatches.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004077 if (FirstIRArg < IRFuncTy->getNumParams() &&
4078 V->getType() != IRFuncTy->getParamType(FirstIRArg))
4079 V = Builder.CreateBitCast(V, IRFuncTy->getParamType(FirstIRArg));
John McCall12f23522016-04-04 18:33:08 +00004080
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004081 IRCallArgs[FirstIRArg] = V;
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00004082 break;
4083 }
Daniel Dunbar94a6f252009-01-26 21:26:08 +00004084
Daniel Dunbar2f219b02009-02-03 19:12:28 +00004085 // FIXME: Avoid the conversion through memory if possible.
John McCall7f416cc2015-09-08 08:05:57 +00004086 Address Src = Address::invalid();
Yaxun Liu5b330e82018-03-15 15:25:19 +00004087 if (!I->isAggregate()) {
John McCall7f416cc2015-09-08 08:05:57 +00004088 Src = CreateMemTemp(I->Ty, "coerce");
Yaxun Liu5b330e82018-03-15 15:25:19 +00004089 I->copyInto(*this, Src);
Ulrich Weigand6e2cea62015-07-10 11:31:43 +00004090 } else {
Yaxun Liu5b330e82018-03-15 15:25:19 +00004091 Src = I->hasLValue() ? I->getKnownLValue().getAddress()
4092 : I->getKnownRValue().getAggregateAddress();
Ulrich Weigand6e2cea62015-07-10 11:31:43 +00004093 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004094
Chris Lattner8a2f3c72010-07-30 04:02:24 +00004095 // If the value is offset in memory, apply the offset now.
John McCall7f416cc2015-09-08 08:05:57 +00004096 Src = emitAddressAtOffset(*this, Src, ArgInfo);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004097
Oliver Stannard2bfdc5b2014-08-27 10:43:15 +00004098 // Fast-isel and the optimizer generally like scalar values better than
4099 // FCAs, so we flatten them if this is safe to do for this argument.
James Molloy6f244b62014-05-09 16:21:39 +00004100 llvm::StructType *STy =
4101 dyn_cast<llvm::StructType>(ArgInfo.getCoerceToType());
Oliver Stannard2bfdc5b2014-08-27 10:43:15 +00004102 if (STy && ArgInfo.isDirect() && ArgInfo.getCanBeFlattened()) {
John McCall7f416cc2015-09-08 08:05:57 +00004103 llvm::Type *SrcTy = Src.getType()->getElementType();
Chandler Carrutha6399a52012-10-10 11:29:08 +00004104 uint64_t SrcSize = CGM.getDataLayout().getTypeAllocSize(SrcTy);
4105 uint64_t DstSize = CGM.getDataLayout().getTypeAllocSize(STy);
4106
4107 // If the source type is smaller than the destination type of the
4108 // coerce-to logic, copy the source value into a temp alloca the size
4109 // of the destination type to allow loading all of it. The bits past
4110 // the source value are left undef.
4111 if (SrcSize < DstSize) {
John McCall7f416cc2015-09-08 08:05:57 +00004112 Address TempAlloca
4113 = CreateTempAlloca(STy, Src.getAlignment(),
4114 Src.getName() + ".coerce");
4115 Builder.CreateMemCpy(TempAlloca, Src, SrcSize);
4116 Src = TempAlloca;
Chandler Carrutha6399a52012-10-10 11:29:08 +00004117 } else {
Matt Arsenault7a124f32017-08-01 20:36:57 +00004118 Src = Builder.CreateBitCast(Src,
4119 STy->getPointerTo(Src.getAddressSpace()));
Chandler Carrutha6399a52012-10-10 11:29:08 +00004120 }
4121
John McCall7f416cc2015-09-08 08:05:57 +00004122 auto SrcLayout = CGM.getDataLayout().getStructLayout(STy);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004123 assert(NumIRArgs == STy->getNumElements());
Chris Lattnerceddafb2010-07-05 20:41:41 +00004124 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
John McCall7f416cc2015-09-08 08:05:57 +00004125 auto Offset = CharUnits::fromQuantity(SrcLayout->getElementOffset(i));
4126 Address EltPtr = Builder.CreateStructGEP(Src, i, Offset);
4127 llvm::Value *LI = Builder.CreateLoad(EltPtr);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004128 IRCallArgs[FirstIRArg + i] = LI;
Chris Lattner15ec3612010-06-29 00:06:42 +00004129 }
Chris Lattner3dd716c2010-06-28 23:44:11 +00004130 } else {
Chris Lattner15ec3612010-06-29 00:06:42 +00004131 // In the simple case, just pass the coerced loaded value.
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004132 assert(NumIRArgs == 1);
4133 IRCallArgs[FirstIRArg] =
John McCall7f416cc2015-09-08 08:05:57 +00004134 CreateCoercedLoad(Src, ArgInfo.getCoerceToType(), *this);
Chris Lattner3dd716c2010-06-28 23:44:11 +00004135 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004136
Daniel Dunbar2f219b02009-02-03 19:12:28 +00004137 break;
4138 }
4139
John McCallf26e73d2016-03-11 04:30:43 +00004140 case ABIArgInfo::CoerceAndExpand: {
John McCallf26e73d2016-03-11 04:30:43 +00004141 auto coercionType = ArgInfo.getCoerceAndExpandType();
4142 auto layout = CGM.getDataLayout().getStructLayout(coercionType);
4143
John McCall12f23522016-04-04 18:33:08 +00004144 llvm::Value *tempSize = nullptr;
4145 Address addr = Address::invalid();
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00004146 Address AllocaAddr = Address::invalid();
Yaxun Liu5b330e82018-03-15 15:25:19 +00004147 if (I->isAggregate()) {
4148 addr = I->hasLValue() ? I->getKnownLValue().getAddress()
4149 : I->getKnownRValue().getAggregateAddress();
4150
John McCall12f23522016-04-04 18:33:08 +00004151 } else {
Yaxun Liu5b330e82018-03-15 15:25:19 +00004152 RValue RV = I->getKnownRValue();
John McCall12f23522016-04-04 18:33:08 +00004153 assert(RV.isScalar()); // complex should always just be direct
4154
4155 llvm::Type *scalarType = RV.getScalarVal()->getType();
4156 auto scalarSize = CGM.getDataLayout().getTypeAllocSize(scalarType);
4157 auto scalarAlign = CGM.getDataLayout().getPrefTypeAlignment(scalarType);
4158
John McCall12f23522016-04-04 18:33:08 +00004159 // Materialize to a temporary.
4160 addr = CreateTempAlloca(RV.getScalarVal()->getType(),
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00004161 CharUnits::fromQuantity(std::max(
4162 layout->getAlignment(), scalarAlign)),
4163 "tmp",
4164 /*ArraySize=*/nullptr, &AllocaAddr);
4165 tempSize = EmitLifetimeStart(scalarSize, AllocaAddr.getPointer());
John McCall12f23522016-04-04 18:33:08 +00004166
4167 Builder.CreateStore(RV.getScalarVal(), addr);
4168 }
4169
John McCallf26e73d2016-03-11 04:30:43 +00004170 addr = Builder.CreateElementBitCast(addr, coercionType);
4171
4172 unsigned IRArgPos = FirstIRArg;
4173 for (unsigned i = 0, e = coercionType->getNumElements(); i != e; ++i) {
4174 llvm::Type *eltType = coercionType->getElementType(i);
4175 if (ABIArgInfo::isPaddingForCoerceAndExpand(eltType)) continue;
4176 Address eltAddr = Builder.CreateStructGEP(addr, i, layout);
4177 llvm::Value *elt = Builder.CreateLoad(eltAddr);
4178 IRCallArgs[IRArgPos++] = elt;
4179 }
4180 assert(IRArgPos == FirstIRArg + NumIRArgs);
4181
John McCall12f23522016-04-04 18:33:08 +00004182 if (tempSize) {
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00004183 EmitLifetimeEnd(tempSize, AllocaAddr.getPointer());
John McCall12f23522016-04-04 18:33:08 +00004184 }
4185
John McCallf26e73d2016-03-11 04:30:43 +00004186 break;
4187 }
4188
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00004189 case ABIArgInfo::Expand:
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004190 unsigned IRArgPos = FirstIRArg;
Yaxun Liu5b330e82018-03-15 15:25:19 +00004191 ExpandTypeToArgs(I->Ty, *I, IRFuncTy, IRCallArgs, IRArgPos);
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004192 assert(IRArgPos == FirstIRArg + NumIRArgs);
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00004193 break;
Daniel Dunbar613855c2008-09-09 23:27:19 +00004194 }
4195 }
Mike Stump11289f42009-09-09 15:08:12 +00004196
John McCall9831b842018-02-06 18:52:44 +00004197 const CGCallee &ConcreteCallee = Callee.prepareConcreteCallee(*this);
4198 llvm::Value *CalleePtr = ConcreteCallee.getFunctionPointer();
John McCallb92ab1a2016-10-26 23:46:34 +00004199
4200 // If we're using inalloca, set up that argument.
John McCall7f416cc2015-09-08 08:05:57 +00004201 if (ArgMemory.isValid()) {
4202 llvm::Value *Arg = ArgMemory.getPointer();
Reid Klecknerafba553e2014-07-08 02:24:27 +00004203 if (CallInfo.isVariadic()) {
4204 // When passing non-POD arguments by value to variadic functions, we will
4205 // end up with a variadic prototype and an inalloca call site. In such
4206 // cases, we can't do any parameter mismatch checks. Give up and bitcast
4207 // the callee.
John McCallb92ab1a2016-10-26 23:46:34 +00004208 unsigned CalleeAS = CalleePtr->getType()->getPointerAddressSpace();
4209 auto FnTy = getTypes().GetFunctionType(CallInfo)->getPointerTo(CalleeAS);
4210 CalleePtr = Builder.CreateBitCast(CalleePtr, FnTy);
Reid Klecknerafba553e2014-07-08 02:24:27 +00004211 } else {
4212 llvm::Type *LastParamTy =
4213 IRFuncTy->getParamType(IRFuncTy->getNumParams() - 1);
4214 if (Arg->getType() != LastParamTy) {
Reid Kleckner314ef7b2014-02-01 00:04:45 +00004215#ifndef NDEBUG
Reid Klecknerafba553e2014-07-08 02:24:27 +00004216 // Assert that these structs have equivalent element types.
4217 llvm::StructType *FullTy = CallInfo.getArgStruct();
4218 llvm::StructType *DeclaredTy = cast<llvm::StructType>(
4219 cast<llvm::PointerType>(LastParamTy)->getElementType());
4220 assert(DeclaredTy->getNumElements() == FullTy->getNumElements());
4221 for (llvm::StructType::element_iterator DI = DeclaredTy->element_begin(),
4222 DE = DeclaredTy->element_end(),
4223 FI = FullTy->element_begin();
4224 DI != DE; ++DI, ++FI)
4225 assert(*DI == *FI);
Reid Kleckner314ef7b2014-02-01 00:04:45 +00004226#endif
Reid Klecknerafba553e2014-07-08 02:24:27 +00004227 Arg = Builder.CreateBitCast(Arg, LastParamTy);
4228 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00004229 }
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004230 assert(IRFunctionArgs.hasInallocaArg());
4231 IRCallArgs[IRFunctionArgs.getInallocaArgNo()] = Arg;
Reid Kleckner314ef7b2014-02-01 00:04:45 +00004232 }
4233
John McCallb92ab1a2016-10-26 23:46:34 +00004234 // 2. Prepare the function pointer.
4235
4236 // If the callee is a bitcast of a non-variadic function to have a
4237 // variadic function pointer type, check to see if we can remove the
4238 // bitcast. This comes up with unprototyped functions.
4239 //
4240 // This makes the IR nicer, but more importantly it ensures that we
4241 // can inline the function at -O0 if it is marked always_inline.
4242 auto simplifyVariadicCallee = [](llvm::Value *Ptr) -> llvm::Value* {
4243 llvm::FunctionType *CalleeFT =
4244 cast<llvm::FunctionType>(Ptr->getType()->getPointerElementType());
4245 if (!CalleeFT->isVarArg())
4246 return Ptr;
4247
4248 llvm::ConstantExpr *CE = dyn_cast<llvm::ConstantExpr>(Ptr);
4249 if (!CE || CE->getOpcode() != llvm::Instruction::BitCast)
4250 return Ptr;
4251
4252 llvm::Function *OrigFn = dyn_cast<llvm::Function>(CE->getOperand(0));
4253 if (!OrigFn)
4254 return Ptr;
4255
4256 llvm::FunctionType *OrigFT = OrigFn->getFunctionType();
4257
4258 // If the original type is variadic, or if any of the component types
4259 // disagree, we cannot remove the cast.
4260 if (OrigFT->isVarArg() ||
4261 OrigFT->getNumParams() != CalleeFT->getNumParams() ||
4262 OrigFT->getReturnType() != CalleeFT->getReturnType())
4263 return Ptr;
4264
4265 for (unsigned i = 0, e = OrigFT->getNumParams(); i != e; ++i)
4266 if (OrigFT->getParamType(i) != CalleeFT->getParamType(i))
4267 return Ptr;
4268
4269 return OrigFn;
4270 };
4271 CalleePtr = simplifyVariadicCallee(CalleePtr);
4272
4273 // 3. Perform the actual call.
4274
4275 // Deactivate any cleanups that we're supposed to do immediately before
4276 // the call.
Reid Kleckner23f4c4b2013-06-21 12:45:15 +00004277 if (!CallArgs.getCleanupsToDeactivate().empty())
4278 deactivateArgCleanupsBeforeCall(*this, CallArgs);
4279
John McCallb92ab1a2016-10-26 23:46:34 +00004280 // Assert that the arguments we computed match up. The IR verifier
4281 // will catch this, but this is a common enough source of problems
4282 // during IRGen changes that it's way better for debugging to catch
4283 // it ourselves here.
4284#ifndef NDEBUG
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004285 assert(IRCallArgs.size() == IRFuncTy->getNumParams() || IRFuncTy->isVarArg());
4286 for (unsigned i = 0; i < IRCallArgs.size(); ++i) {
4287 // Inalloca argument can have different type.
4288 if (IRFunctionArgs.hasInallocaArg() &&
4289 i == IRFunctionArgs.getInallocaArgNo())
4290 continue;
4291 if (i < IRFuncTy->getNumParams())
4292 assert(IRCallArgs[i]->getType() == IRFuncTy->getParamType(i));
4293 }
John McCallb92ab1a2016-10-26 23:46:34 +00004294#endif
Alexey Samsonov91cf4552014-08-22 01:06:06 +00004295
Craig Topper3113ec32018-10-24 17:42:17 +00004296 // Update the largest vector width if any arguments have vector types.
4297 for (unsigned i = 0; i < IRCallArgs.size(); ++i) {
4298 if (auto *VT = dyn_cast<llvm::VectorType>(IRCallArgs[i]->getType()))
4299 LargestVectorWidth = std::max(LargestVectorWidth,
4300 VT->getPrimitiveSizeInBits());
4301 }
4302
John McCallb92ab1a2016-10-26 23:46:34 +00004303 // Compute the calling convention and attributes.
Daniel Dunbar0ef34792009-09-12 00:59:20 +00004304 unsigned CallingConv;
Reid Klecknercdd26792017-04-18 23:50:03 +00004305 llvm::AttributeList Attrs;
John McCallb92ab1a2016-10-26 23:46:34 +00004306 CGM.ConstructAttributeList(CalleePtr->getName(), CallInfo,
Reid Klecknercdd26792017-04-18 23:50:03 +00004307 Callee.getAbstractInfo(), Attrs, CallingConv,
Chad Rosier7dbc9cf2016-01-06 14:35:46 +00004308 /*AttrOnCallSite=*/true);
Mike Stump11289f42009-09-09 15:08:12 +00004309
John McCallb92ab1a2016-10-26 23:46:34 +00004310 // Apply some call-site-specific attributes.
4311 // TODO: work this into building the attribute set.
4312
4313 // Apply always_inline to all calls within flatten functions.
4314 // FIXME: should this really take priority over __try, below?
4315 if (CurCodeDecl && CurCodeDecl->hasAttr<FlattenAttr>() &&
Erich Keanede6480a32018-11-13 15:48:08 +00004316 !(Callee.getAbstractInfo().getCalleeDecl().getDecl() &&
4317 Callee.getAbstractInfo()
4318 .getCalleeDecl()
4319 .getDecl()
4320 ->hasAttr<NoInlineAttr>())) {
John McCallb92ab1a2016-10-26 23:46:34 +00004321 Attrs =
Reid Klecknerde864822017-03-21 16:57:30 +00004322 Attrs.addAttribute(getLLVMContext(), llvm::AttributeList::FunctionIndex,
John McCallb92ab1a2016-10-26 23:46:34 +00004323 llvm::Attribute::AlwaysInline);
4324 }
4325
4326 // Disable inlining inside SEH __try blocks.
4327 if (isSEHTryScope()) {
4328 Attrs =
Reid Klecknerde864822017-03-21 16:57:30 +00004329 Attrs.addAttribute(getLLVMContext(), llvm::AttributeList::FunctionIndex,
John McCallb92ab1a2016-10-26 23:46:34 +00004330 llvm::Attribute::NoInline);
4331 }
4332
4333 // Decide whether to use a call or an invoke.
David Majnemer4e52d6f2015-12-12 05:39:21 +00004334 bool CannotThrow;
4335 if (currentFunctionUsesSEHTry()) {
John McCallb92ab1a2016-10-26 23:46:34 +00004336 // SEH cares about asynchronous exceptions, so everything can "throw."
David Majnemer4e52d6f2015-12-12 05:39:21 +00004337 CannotThrow = false;
4338 } else if (isCleanupPadScope() &&
4339 EHPersonality::get(*this).isMSVCXXPersonality()) {
4340 // The MSVC++ personality will implicitly terminate the program if an
John McCallb92ab1a2016-10-26 23:46:34 +00004341 // exception is thrown during a cleanup outside of a try/catch.
4342 // We don't need to model anything in IR to get this behavior.
David Majnemer4e52d6f2015-12-12 05:39:21 +00004343 CannotThrow = true;
4344 } else {
John McCallb92ab1a2016-10-26 23:46:34 +00004345 // Otherwise, nounwind call sites will never throw.
Reid Klecknerde864822017-03-21 16:57:30 +00004346 CannotThrow = Attrs.hasAttribute(llvm::AttributeList::FunctionIndex,
David Majnemer4e52d6f2015-12-12 05:39:21 +00004347 llvm::Attribute::NoUnwind);
4348 }
George Burgess IV003be7c2018-03-08 05:32:30 +00004349
4350 // If we made a temporary, be sure to clean up after ourselves. Note that we
4351 // can't depend on being inside of an ExprWithCleanups, so we need to manually
4352 // pop this cleanup later on. Being eager about this is OK, since this
4353 // temporary is 'invisible' outside of the callee.
4354 if (UnusedReturnSizePtr)
Yaxun Liua2a9cfa2018-05-17 11:16:35 +00004355 pushFullExprCleanup<CallLifetimeEnd>(NormalEHLifetimeMarker, SRetAlloca,
George Burgess IV003be7c2018-03-08 05:32:30 +00004356 UnusedReturnSizePtr);
4357
David Majnemer4e52d6f2015-12-12 05:39:21 +00004358 llvm::BasicBlock *InvokeDest = CannotThrow ? nullptr : getInvokeDest();
John McCallbd309292010-07-06 01:34:17 +00004359
Reid Klecknerb75a3f02018-02-09 00:16:41 +00004360 SmallVector<llvm::OperandBundleDef, 1> BundleList =
4361 getBundlesForFunclet(CalleePtr);
David Majnemer0b17d442015-12-15 21:27:59 +00004362
John McCallb92ab1a2016-10-26 23:46:34 +00004363 // Emit the actual call/invoke instruction.
James Y Knight3933add2019-01-30 02:54:28 +00004364 llvm::CallBase *CI;
John McCallbd309292010-07-06 01:34:17 +00004365 if (!InvokeDest) {
James Y Knight3933add2019-01-30 02:54:28 +00004366 CI = Builder.CreateCall(CalleePtr, IRCallArgs, BundleList);
Daniel Dunbar12347492009-02-23 17:26:39 +00004367 } else {
4368 llvm::BasicBlock *Cont = createBasicBlock("invoke.cont");
James Y Knight3933add2019-01-30 02:54:28 +00004369 CI = Builder.CreateInvoke(CalleePtr, Cont, InvokeDest, IRCallArgs,
David Majnemer0b17d442015-12-15 21:27:59 +00004370 BundleList);
Daniel Dunbar12347492009-02-23 17:26:39 +00004371 EmitBlock(Cont);
Daniel Dunbar5006f4a2009-02-20 18:54:31 +00004372 }
Chris Lattnere70a0072010-06-29 16:40:28 +00004373 if (callOrInvoke)
John McCallb92ab1a2016-10-26 23:46:34 +00004374 *callOrInvoke = CI;
Daniel Dunbar5006f4a2009-02-20 18:54:31 +00004375
John McCallb92ab1a2016-10-26 23:46:34 +00004376 // Apply the attributes and calling convention.
James Y Knight3933add2019-01-30 02:54:28 +00004377 CI->setAttributes(Attrs);
4378 CI->setCallingConv(static_cast<llvm::CallingConv::ID>(CallingConv));
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004379
John McCallb92ab1a2016-10-26 23:46:34 +00004380 // Apply various metadata.
4381
4382 if (!CI->getType()->isVoidTy())
4383 CI->setName("call");
4384
Craig Topper3113ec32018-10-24 17:42:17 +00004385 // Update largest vector width from the return type.
4386 if (auto *VT = dyn_cast<llvm::VectorType>(CI->getType()))
4387 LargestVectorWidth = std::max(LargestVectorWidth,
4388 VT->getPrimitiveSizeInBits());
4389
Adam Nemet1e217bc2016-03-28 22:18:53 +00004390 // Insert instrumentation or attach profile metadata at indirect call sites.
4391 // For more details, see the comment before the definition of
4392 // IPVK_IndirectCallTarget in InstrProfData.inc.
James Y Knight3933add2019-01-30 02:54:28 +00004393 if (!CI->getCalledFunction())
Betul Buyukkurt518276a2016-01-23 22:50:44 +00004394 PGO.valueProfile(Builder, llvm::IPVK_IndirectCallTarget,
John McCallb92ab1a2016-10-26 23:46:34 +00004395 CI, CalleePtr);
Betul Buyukkurt518276a2016-01-23 22:50:44 +00004396
Dan Gohman515a60d2012-02-16 00:57:37 +00004397 // In ObjC ARC mode with no ObjC ARC exception safety, tell the ARC
4398 // optimizer it can aggressively ignore unwind edges.
David Blaikiebbafb8a2012-03-11 07:00:24 +00004399 if (CGM.getLangOpts().ObjCAutoRefCount)
John McCallb92ab1a2016-10-26 23:46:34 +00004400 AddObjCARCExceptionMetadata(CI);
4401
4402 // Suppress tail calls if requested.
4403 if (llvm::CallInst *Call = dyn_cast<llvm::CallInst>(CI)) {
Erich Keanede6480a32018-11-13 15:48:08 +00004404 const Decl *TargetDecl = Callee.getAbstractInfo().getCalleeDecl().getDecl();
John McCallb92ab1a2016-10-26 23:46:34 +00004405 if (TargetDecl && TargetDecl->hasAttr<NotTailCalledAttr>())
4406 Call->setTailCallKind(llvm::CallInst::TCK_NoTail);
4407 }
4408
4409 // 4. Finish the call.
Dan Gohman515a60d2012-02-16 00:57:37 +00004410
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004411 // If the call doesn't return, finish the basic block and clear the
John McCallb92ab1a2016-10-26 23:46:34 +00004412 // insertion point; this allows the rest of IRGen to discard
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004413 // unreachable code.
James Y Knight3933add2019-01-30 02:54:28 +00004414 if (CI->doesNotReturn()) {
George Burgess IV003be7c2018-03-08 05:32:30 +00004415 if (UnusedReturnSizePtr)
4416 PopCleanupBlock();
Leny Kholodov6aab1112015-06-08 10:23:49 +00004417
Julian Lettnerb62e9dc2019-01-24 18:04:21 +00004418 // Strip away the noreturn attribute to better diagnose unreachable UB.
Vedant Kumar09b5bfd2017-12-21 00:10:25 +00004419 if (SanOpts.has(SanitizerKind::Unreachable)) {
Julian Lettnerf82d8922019-02-02 02:05:16 +00004420 // Also remove from function since CallBase::hasFnAttr additionally checks
4421 // attributes of the called function.
James Y Knight3933add2019-01-30 02:54:28 +00004422 if (auto *F = CI->getCalledFunction())
Vedant Kumar09b5bfd2017-12-21 00:10:25 +00004423 F->removeFnAttr(llvm::Attribute::NoReturn);
James Y Knight3933add2019-01-30 02:54:28 +00004424 CI->removeAttribute(llvm::AttributeList::FunctionIndex,
4425 llvm::Attribute::NoReturn);
Julian Lettnerb6c06dc2019-02-01 02:51:00 +00004426
4427 // Avoid incompatibility with ASan which relies on the `noreturn`
4428 // attribute to insert handler calls.
Julian Lettner98b9f5b2019-02-04 23:37:50 +00004429 if (SanOpts.hasOneOf(SanitizerKind::Address |
4430 SanitizerKind::KernelAddress)) {
Julian Lettnerb6c06dc2019-02-01 02:51:00 +00004431 SanitizerScope SanScope(this);
4432 llvm::IRBuilder<>::InsertPointGuard IPGuard(Builder);
4433 Builder.SetInsertPoint(CI);
4434 auto *FnType = llvm::FunctionType::get(CGM.VoidTy, /*isVarArg=*/false);
4435 auto *Fn = CGM.CreateRuntimeFunction(FnType, "__asan_handle_no_return");
4436 EmitNounwindRuntimeCall(Fn);
4437 }
Vedant Kumar09b5bfd2017-12-21 00:10:25 +00004438 }
4439
4440 EmitUnreachable(Loc);
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004441 Builder.ClearInsertionPoint();
Mike Stump11289f42009-09-09 15:08:12 +00004442
Mike Stump18bb9282009-05-16 07:57:57 +00004443 // FIXME: For now, emit a dummy basic block because expr emitters in
4444 // generally are not ready to handle emitting expressions at unreachable
4445 // points.
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004446 EnsureInsertPoint();
Mike Stump11289f42009-09-09 15:08:12 +00004447
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004448 // Return a reasonable RValue.
4449 return GetUndefRValue(RetTy);
Mike Stump11289f42009-09-09 15:08:12 +00004450 }
Daniel Dunbarb960b7b2009-03-02 04:32:35 +00004451
John McCall12f23522016-04-04 18:33:08 +00004452 // Perform the swifterror writeback.
4453 if (swiftErrorTemp.isValid()) {
4454 llvm::Value *errorResult = Builder.CreateLoad(swiftErrorTemp);
4455 Builder.CreateStore(errorResult, swiftErrorArg);
4456 }
4457
John McCallb92ab1a2016-10-26 23:46:34 +00004458 // Emit any call-associated writebacks immediately. Arguably this
4459 // should happen after any return-value munging.
John McCall31168b02011-06-15 23:02:42 +00004460 if (CallArgs.hasWritebacks())
4461 emitWritebacks(*this, CallArgs);
4462
Nico Weber8cdb3f92015-08-25 18:43:32 +00004463 // The stack cleanup for inalloca arguments has to run out of the normal
4464 // lexical order, so deactivate it and run it manually here.
4465 CallArgs.freeArgumentMemory(*this);
4466
John McCallb92ab1a2016-10-26 23:46:34 +00004467 // Extract the return value.
Hal Finkelee90a222014-09-26 05:04:30 +00004468 RValue Ret = [&] {
4469 switch (RetAI.getKind()) {
John McCallf26e73d2016-03-11 04:30:43 +00004470 case ABIArgInfo::CoerceAndExpand: {
4471 auto coercionType = RetAI.getCoerceAndExpandType();
4472 auto layout = CGM.getDataLayout().getStructLayout(coercionType);
4473
4474 Address addr = SRetPtr;
4475 addr = Builder.CreateElementBitCast(addr, coercionType);
4476
John McCall12f23522016-04-04 18:33:08 +00004477 assert(CI->getType() == RetAI.getUnpaddedCoerceAndExpandType());
4478 bool requiresExtract = isa<llvm::StructType>(CI->getType());
4479
John McCallf26e73d2016-03-11 04:30:43 +00004480 unsigned unpaddedIndex = 0;
4481 for (unsigned i = 0, e = coercionType->getNumElements(); i != e; ++i) {
4482 llvm::Type *eltType = coercionType->getElementType(i);
4483 if (ABIArgInfo::isPaddingForCoerceAndExpand(eltType)) continue;
4484 Address eltAddr = Builder.CreateStructGEP(addr, i, layout);
John McCall12f23522016-04-04 18:33:08 +00004485 llvm::Value *elt = CI;
4486 if (requiresExtract)
4487 elt = Builder.CreateExtractValue(elt, unpaddedIndex++);
4488 else
4489 assert(unpaddedIndex == 0);
John McCallf26e73d2016-03-11 04:30:43 +00004490 Builder.CreateStore(elt, eltAddr);
4491 }
John McCall12f23522016-04-04 18:33:08 +00004492 // FALLTHROUGH
Galina Kistanova0872d6c2017-06-03 06:30:46 +00004493 LLVM_FALLTHROUGH;
John McCall12f23522016-04-04 18:33:08 +00004494 }
4495
4496 case ABIArgInfo::InAlloca:
4497 case ABIArgInfo::Indirect: {
4498 RValue ret = convertTempToRValue(SRetPtr, RetTy, SourceLocation());
George Burgess IV003be7c2018-03-08 05:32:30 +00004499 if (UnusedReturnSizePtr)
4500 PopCleanupBlock();
John McCall12f23522016-04-04 18:33:08 +00004501 return ret;
John McCallf26e73d2016-03-11 04:30:43 +00004502 }
4503
Hal Finkelee90a222014-09-26 05:04:30 +00004504 case ABIArgInfo::Ignore:
4505 // If we are ignoring an argument that had a result, make sure to
4506 // construct the appropriate return value for our caller.
4507 return GetUndefRValue(RetTy);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004508
Hal Finkelee90a222014-09-26 05:04:30 +00004509 case ABIArgInfo::Extend:
4510 case ABIArgInfo::Direct: {
4511 llvm::Type *RetIRTy = ConvertType(RetTy);
4512 if (RetAI.getCoerceToType() == RetIRTy && RetAI.getDirectOffset() == 0) {
4513 switch (getEvaluationKind(RetTy)) {
4514 case TEK_Complex: {
4515 llvm::Value *Real = Builder.CreateExtractValue(CI, 0);
4516 llvm::Value *Imag = Builder.CreateExtractValue(CI, 1);
4517 return RValue::getComplex(std::make_pair(Real, Imag));
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00004518 }
Hal Finkelee90a222014-09-26 05:04:30 +00004519 case TEK_Aggregate: {
John McCall7f416cc2015-09-08 08:05:57 +00004520 Address DestPtr = ReturnValue.getValue();
Hal Finkelee90a222014-09-26 05:04:30 +00004521 bool DestIsVolatile = ReturnValue.isVolatile();
4522
John McCall7f416cc2015-09-08 08:05:57 +00004523 if (!DestPtr.isValid()) {
Hal Finkelee90a222014-09-26 05:04:30 +00004524 DestPtr = CreateMemTemp(RetTy, "agg.tmp");
4525 DestIsVolatile = false;
4526 }
John McCall7f416cc2015-09-08 08:05:57 +00004527 BuildAggStore(*this, CI, DestPtr, DestIsVolatile);
Hal Finkelee90a222014-09-26 05:04:30 +00004528 return RValue::getAggregate(DestPtr);
4529 }
4530 case TEK_Scalar: {
4531 // If the argument doesn't match, perform a bitcast to coerce it. This
4532 // can happen due to trivial type mismatches.
4533 llvm::Value *V = CI;
4534 if (V->getType() != RetIRTy)
4535 V = Builder.CreateBitCast(V, RetIRTy);
4536 return RValue::get(V);
4537 }
4538 }
4539 llvm_unreachable("bad evaluation kind");
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00004540 }
Hal Finkelee90a222014-09-26 05:04:30 +00004541
John McCall7f416cc2015-09-08 08:05:57 +00004542 Address DestPtr = ReturnValue.getValue();
Hal Finkelee90a222014-09-26 05:04:30 +00004543 bool DestIsVolatile = ReturnValue.isVolatile();
4544
John McCall7f416cc2015-09-08 08:05:57 +00004545 if (!DestPtr.isValid()) {
Hal Finkelee90a222014-09-26 05:04:30 +00004546 DestPtr = CreateMemTemp(RetTy, "coerce");
4547 DestIsVolatile = false;
John McCall47fb9502013-03-07 21:37:08 +00004548 }
Hal Finkelee90a222014-09-26 05:04:30 +00004549
4550 // If the value is offset in memory, apply the offset now.
John McCall7f416cc2015-09-08 08:05:57 +00004551 Address StorePtr = emitAddressAtOffset(*this, DestPtr, RetAI);
4552 CreateCoercedStore(CI, StorePtr, DestIsVolatile, *this);
Hal Finkelee90a222014-09-26 05:04:30 +00004553
4554 return convertTempToRValue(DestPtr, RetTy, SourceLocation());
Chris Lattnerfe34c1d2010-07-29 06:26:06 +00004555 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004556
Hal Finkelee90a222014-09-26 05:04:30 +00004557 case ABIArgInfo::Expand:
4558 llvm_unreachable("Invalid ABI kind for return argument");
Anders Carlsson17490832009-12-24 20:40:36 +00004559 }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004560
Hal Finkelee90a222014-09-26 05:04:30 +00004561 llvm_unreachable("Unhandled ABIArgInfo::Kind");
4562 } ();
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00004563
John McCallb92ab1a2016-10-26 23:46:34 +00004564 // Emit the assume_aligned check on the return value.
Erich Keanede6480a32018-11-13 15:48:08 +00004565 const Decl *TargetDecl = Callee.getAbstractInfo().getCalleeDecl().getDecl();
Hal Finkelee90a222014-09-26 05:04:30 +00004566 if (Ret.isScalar() && TargetDecl) {
4567 if (const auto *AA = TargetDecl->getAttr<AssumeAlignedAttr>()) {
4568 llvm::Value *OffsetValue = nullptr;
4569 if (const auto *Offset = AA->getOffset())
4570 OffsetValue = EmitScalarExpr(Offset);
4571
4572 llvm::Value *Alignment = EmitScalarExpr(AA->getAlignment());
4573 llvm::ConstantInt *AlignmentCI = cast<llvm::ConstantInt>(Alignment);
Roman Lebedevbd1c0872019-01-15 09:44:25 +00004574 EmitAlignmentAssumption(Ret.getScalarVal(), RetTy, Loc, AA->getLocation(),
4575 AlignmentCI->getZExtValue(), OffsetValue);
Erich Keane623efd82017-03-30 21:48:55 +00004576 } else if (const auto *AA = TargetDecl->getAttr<AllocAlignAttr>()) {
Roman Lebedevbd1c0872019-01-15 09:44:25 +00004577 llvm::Value *AlignmentVal = CallArgs[AA->getParamIndex().getLLVMIndex()]
4578 .getRValue(*this)
4579 .getScalarVal();
4580 EmitAlignmentAssumption(Ret.getScalarVal(), RetTy, Loc, AA->getLocation(),
4581 AlignmentVal);
Hal Finkelee90a222014-09-26 05:04:30 +00004582 }
Daniel Dunbar573884e2008-09-10 07:04:09 +00004583 }
Daniel Dunbard3674e62008-09-11 01:48:57 +00004584
Hal Finkelee90a222014-09-26 05:04:30 +00004585 return Ret;
Daniel Dunbar613855c2008-09-09 23:27:19 +00004586}
Daniel Dunbar2d0746f2009-02-10 20:44:09 +00004587
John McCall9831b842018-02-06 18:52:44 +00004588CGCallee CGCallee::prepareConcreteCallee(CodeGenFunction &CGF) const {
4589 if (isVirtual()) {
4590 const CallExpr *CE = getVirtualCallExpr();
4591 return CGF.CGM.getCXXABI().getVirtualFunctionPointer(
Stephen Kellyf2ceec42018-08-09 21:08:08 +00004592 CGF, getVirtualMethodDecl(), getThisAddress(), getFunctionType(),
4593 CE ? CE->getBeginLoc() : SourceLocation());
John McCall9831b842018-02-06 18:52:44 +00004594 }
4595
4596 return *this;
4597}
4598
Daniel Dunbar2d0746f2009-02-10 20:44:09 +00004599/* VarArg handling */
4600
Charles Davisc7d5c942015-09-17 20:55:33 +00004601Address CodeGenFunction::EmitVAArg(VAArgExpr *VE, Address &VAListAddr) {
4602 VAListAddr = VE->isMicrosoftABI()
4603 ? EmitMSVAListRef(VE->getSubExpr())
4604 : EmitVAListRef(VE->getSubExpr());
4605 QualType Ty = VE->getType();
4606 if (VE->isMicrosoftABI())
4607 return CGM.getTypes().getABIInfo().EmitMSVAArg(*this, VAListAddr, Ty);
John McCall7f416cc2015-09-08 08:05:57 +00004608 return CGM.getTypes().getABIInfo().EmitVAArg(*this, VAListAddr, Ty);
Daniel Dunbar2d0746f2009-02-10 20:44:09 +00004609}