1 //===--- CGCall.cpp - Encapsulate calling convention details --------------===//
2 //
3 // 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
6 //
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"
15 #include "ABIInfo.h"
16 #include "CGBlocks.h"
17 #include "CGCXXABI.h"
18 #include "CGCleanup.h"
19 #include "CodeGenFunction.h"
20 #include "CodeGenModule.h"
21 #include "TargetInfo.h"
22 #include "clang/AST/Attr.h"
23 #include "clang/AST/Decl.h"
24 #include "clang/AST/DeclCXX.h"
25 #include "clang/AST/DeclObjC.h"
26 #include "clang/Basic/CodeGenOptions.h"
27 #include "clang/Basic/TargetBuiltins.h"
28 #include "clang/Basic/TargetInfo.h"
29 #include "clang/CodeGen/CGFunctionInfo.h"
30 #include "clang/CodeGen/SwiftCallingConv.h"
31 #include "llvm/ADT/StringExtras.h"
32 #include "llvm/Analysis/ValueTracking.h"
33 #include "llvm/IR/Attributes.h"
34 #include "llvm/IR/CallingConv.h"
35 #include "llvm/IR/DataLayout.h"
36 #include "llvm/IR/InlineAsm.h"
37 #include "llvm/IR/IntrinsicInst.h"
38 #include "llvm/IR/Intrinsics.h"
39 #include "llvm/Transforms/Utils/Local.h"
40 using namespace clang;
41 using namespace CodeGen;
42 
43 /***/
44 
45 unsigned CodeGenTypes::ClangCallConvToLLVMCallConv(CallingConv CC) {
46   switch (CC) {
47   default: return llvm::CallingConv::C;
48   case CC_X86StdCall: return llvm::CallingConv::X86_StdCall;
49   case CC_X86FastCall: return llvm::CallingConv::X86_FastCall;
50   case CC_X86RegCall: return llvm::CallingConv::X86_RegCall;
51   case CC_X86ThisCall: return llvm::CallingConv::X86_ThisCall;
52   case CC_Win64: return llvm::CallingConv::Win64;
53   case CC_X86_64SysV: return llvm::CallingConv::X86_64_SysV;
54   case CC_AAPCS: return llvm::CallingConv::ARM_AAPCS;
55   case CC_AAPCS_VFP: return llvm::CallingConv::ARM_AAPCS_VFP;
56   case CC_IntelOclBicc: return llvm::CallingConv::Intel_OCL_BI;
57   // TODO: Add support for __pascal to LLVM.
58   case CC_X86Pascal: return llvm::CallingConv::C;
59   // TODO: Add support for __vectorcall to LLVM.
60   case CC_X86VectorCall: return llvm::CallingConv::X86_VectorCall;
61   case CC_AArch64VectorCall: return llvm::CallingConv::AArch64_VectorCall;
62   case CC_SpirFunction: return llvm::CallingConv::SPIR_FUNC;
63   case CC_OpenCLKernel: return CGM.getTargetCodeGenInfo().getOpenCLKernelCallingConv();
64   case CC_PreserveMost: return llvm::CallingConv::PreserveMost;
65   case CC_PreserveAll: return llvm::CallingConv::PreserveAll;
66   case CC_Swift: return llvm::CallingConv::Swift;
67   }
68 }
69 
70 /// Derives the 'this' type for codegen purposes, i.e. ignoring method CVR
71 /// qualification. Either or both of RD and MD may be null. A null RD indicates
72 /// that there is no meaningful 'this' type, and a null MD can occur when
73 /// calling a method pointer.
74 CanQualType CodeGenTypes::DeriveThisType(const CXXRecordDecl *RD,
75                                          const CXXMethodDecl *MD) {
76   QualType RecTy;
77   if (RD)
78     RecTy = Context.getTagDeclType(RD)->getCanonicalTypeInternal();
79   else
80     RecTy = Context.VoidTy;
81 
82   if (MD)
83     RecTy = Context.getAddrSpaceQualType(RecTy, MD->getMethodQualifiers().getAddressSpace());
84   return Context.getPointerType(CanQualType::CreateUnsafe(RecTy));
85 }
86 
87 /// Returns the canonical formal type of the given C++ method.
88 static CanQual<FunctionProtoType> GetFormalType(const CXXMethodDecl *MD) {
89   return MD->getType()->getCanonicalTypeUnqualified()
90            .getAs<FunctionProtoType>();
91 }
92 
93 /// Returns the "extra-canonicalized" return type, which discards
94 /// qualifiers on the return type.  Codegen doesn't care about them,
95 /// and it makes ABI code a little easier to be able to assume that
96 /// all parameter and return types are top-level unqualified.
97 static CanQualType GetReturnType(QualType RetTy) {
98   return RetTy->getCanonicalTypeUnqualified().getUnqualifiedType();
99 }
100 
101 /// Arrange the argument and result information for a value of the given
102 /// unprototyped freestanding function type.
103 const CGFunctionInfo &
104 CodeGenTypes::arrangeFreeFunctionType(CanQual<FunctionNoProtoType> FTNP) {
105   // When translating an unprototyped function type, always use a
106   // variadic type.
107   return arrangeLLVMFunctionInfo(FTNP->getReturnType().getUnqualifiedType(),
108                                  /*instanceMethod=*/false,
109                                  /*chainCall=*/false, None,
110                                  FTNP->getExtInfo(), {}, RequiredArgs(0));
111 }
112 
113 static void addExtParameterInfosForCall(
114          llvm::SmallVectorImpl<FunctionProtoType::ExtParameterInfo> &paramInfos,
115                                         const FunctionProtoType *proto,
116                                         unsigned prefixArgs,
117                                         unsigned totalArgs) {
118   assert(proto->hasExtParameterInfos());
119   assert(paramInfos.size() <= prefixArgs);
120   assert(proto->getNumParams() + prefixArgs <= totalArgs);
121 
122   paramInfos.reserve(totalArgs);
123 
124   // Add default infos for any prefix args that don't already have infos.
125   paramInfos.resize(prefixArgs);
126 
127   // Add infos for the prototype.
128   for (const auto &ParamInfo : proto->getExtParameterInfos()) {
129     paramInfos.push_back(ParamInfo);
130     // pass_object_size params have no parameter info.
131     if (ParamInfo.hasPassObjectSize())
132       paramInfos.emplace_back();
133   }
134 
135   assert(paramInfos.size() <= totalArgs &&
136          "Did we forget to insert pass_object_size args?");
137   // Add default infos for the variadic and/or suffix arguments.
138   paramInfos.resize(totalArgs);
139 }
140 
141 /// Adds the formal parameters in FPT to the given prefix. If any parameter in
142 /// FPT has pass_object_size attrs, then we'll add parameters for those, too.
143 static void appendParameterTypes(const CodeGenTypes &CGT,
144                                  SmallVectorImpl<CanQualType> &prefix,
145               SmallVectorImpl<FunctionProtoType::ExtParameterInfo> &paramInfos,
146                                  CanQual<FunctionProtoType> FPT) {
147   // Fast path: don't touch param info if we don't need to.
148   if (!FPT->hasExtParameterInfos()) {
149     assert(paramInfos.empty() &&
150            "We have paramInfos, but the prototype doesn't?");
151     prefix.append(FPT->param_type_begin(), FPT->param_type_end());
152     return;
153   }
154 
155   unsigned PrefixSize = prefix.size();
156   // In the vast majority of cases, we'll have precisely FPT->getNumParams()
157   // parameters; the only thing that can change this is the presence of
158   // pass_object_size. So, we preallocate for the common case.
159   prefix.reserve(prefix.size() + FPT->getNumParams());
160 
161   auto ExtInfos = FPT->getExtParameterInfos();
162   assert(ExtInfos.size() == FPT->getNumParams());
163   for (unsigned I = 0, E = FPT->getNumParams(); I != E; ++I) {
164     prefix.push_back(FPT->getParamType(I));
165     if (ExtInfos[I].hasPassObjectSize())
166       prefix.push_back(CGT.getContext().getSizeType());
167   }
168 
169   addExtParameterInfosForCall(paramInfos, FPT.getTypePtr(), PrefixSize,
170                               prefix.size());
171 }
172 
173 /// Arrange the LLVM function layout for a value of the given function
174 /// type, on top of any implicit parameters already stored.
175 static const CGFunctionInfo &
176 arrangeLLVMFunctionInfo(CodeGenTypes &CGT, bool instanceMethod,
177                         SmallVectorImpl<CanQualType> &prefix,
178                         CanQual<FunctionProtoType> FTP) {
179   SmallVector<FunctionProtoType::ExtParameterInfo, 16> paramInfos;
180   RequiredArgs Required = RequiredArgs::forPrototypePlus(FTP, prefix.size());
181   // FIXME: Kill copy.
182   appendParameterTypes(CGT, prefix, paramInfos, FTP);
183   CanQualType resultType = FTP->getReturnType().getUnqualifiedType();
184 
185   return CGT.arrangeLLVMFunctionInfo(resultType, instanceMethod,
186                                      /*chainCall=*/false, prefix,
187                                      FTP->getExtInfo(), paramInfos,
188                                      Required);
189 }
190 
191 /// Arrange the argument and result information for a value of the
192 /// given freestanding function type.
193 const CGFunctionInfo &
194 CodeGenTypes::arrangeFreeFunctionType(CanQual<FunctionProtoType> FTP) {
195   SmallVector<CanQualType, 16> argTypes;
196   return ::arrangeLLVMFunctionInfo(*this, /*instanceMethod=*/false, argTypes,
197                                    FTP);
198 }
199 
200 static CallingConv getCallingConventionForDecl(const Decl *D, bool IsWindows) {
201   // Set the appropriate calling convention for the Function.
202   if (D->hasAttr<StdCallAttr>())
203     return CC_X86StdCall;
204 
205   if (D->hasAttr<FastCallAttr>())
206     return CC_X86FastCall;
207 
208   if (D->hasAttr<RegCallAttr>())
209     return CC_X86RegCall;
210 
211   if (D->hasAttr<ThisCallAttr>())
212     return CC_X86ThisCall;
213 
214   if (D->hasAttr<VectorCallAttr>())
215     return CC_X86VectorCall;
216 
217   if (D->hasAttr<PascalAttr>())
218     return CC_X86Pascal;
219 
220   if (PcsAttr *PCS = D->getAttr<PcsAttr>())
221     return (PCS->getPCS() == PcsAttr::AAPCS ? CC_AAPCS : CC_AAPCS_VFP);
222 
223   if (D->hasAttr<AArch64VectorPcsAttr>())
224     return CC_AArch64VectorCall;
225 
226   if (D->hasAttr<IntelOclBiccAttr>())
227     return CC_IntelOclBicc;
228 
229   if (D->hasAttr<MSABIAttr>())
230     return IsWindows ? CC_C : CC_Win64;
231 
232   if (D->hasAttr<SysVABIAttr>())
233     return IsWindows ? CC_X86_64SysV : CC_C;
234 
235   if (D->hasAttr<PreserveMostAttr>())
236     return CC_PreserveMost;
237 
238   if (D->hasAttr<PreserveAllAttr>())
239     return CC_PreserveAll;
240 
241   return CC_C;
242 }
243 
244 /// Arrange the argument and result information for a call to an
245 /// unknown C++ non-static member function of the given abstract type.
246 /// (A null RD means we don't have any meaningful "this" argument type,
247 ///  so fall back to a generic pointer type).
248 /// The member function must be an ordinary function, i.e. not a
249 /// constructor or destructor.
250 const CGFunctionInfo &
251 CodeGenTypes::arrangeCXXMethodType(const CXXRecordDecl *RD,
252                                    const FunctionProtoType *FTP,
253                                    const CXXMethodDecl *MD) {
254   SmallVector<CanQualType, 16> argTypes;
255 
256   // Add the 'this' pointer.
257   argTypes.push_back(DeriveThisType(RD, MD));
258 
259   return ::arrangeLLVMFunctionInfo(
260       *this, true, argTypes,
261       FTP->getCanonicalTypeUnqualified().getAs<FunctionProtoType>());
262 }
263 
264 /// Set calling convention for CUDA/HIP kernel.
265 static void setCUDAKernelCallingConvention(CanQualType &FTy, CodeGenModule &CGM,
266                                            const FunctionDecl *FD) {
267   if (FD->hasAttr<CUDAGlobalAttr>()) {
268     const FunctionType *FT = FTy->getAs<FunctionType>();
269     CGM.getTargetCodeGenInfo().setCUDAKernelCallingConvention(FT);
270     FTy = FT->getCanonicalTypeUnqualified();
271   }
272 }
273 
274 /// Arrange the argument and result information for a declaration or
275 /// definition of the given C++ non-static member function.  The
276 /// member function must be an ordinary function, i.e. not a
277 /// constructor or destructor.
278 const CGFunctionInfo &
279 CodeGenTypes::arrangeCXXMethodDeclaration(const CXXMethodDecl *MD) {
280   assert(!isa<CXXConstructorDecl>(MD) && "wrong method for constructors!");
281   assert(!isa<CXXDestructorDecl>(MD) && "wrong method for destructors!");
282 
283   CanQualType FT = GetFormalType(MD).getAs<Type>();
284   setCUDAKernelCallingConvention(FT, CGM, MD);
285   auto prototype = FT.getAs<FunctionProtoType>();
286 
287   if (MD->isInstance()) {
288     // The abstract case is perfectly fine.
289     const CXXRecordDecl *ThisType = TheCXXABI.getThisArgumentTypeForMethod(MD);
290     return arrangeCXXMethodType(ThisType, prototype.getTypePtr(), MD);
291   }
292 
293   return arrangeFreeFunctionType(prototype);
294 }
295 
296 bool CodeGenTypes::inheritingCtorHasParams(
297     const InheritedConstructor &Inherited, CXXCtorType Type) {
298   // Parameters are unnecessary if we're constructing a base class subobject
299   // and the inherited constructor lives in a virtual base.
300   return Type == Ctor_Complete ||
301          !Inherited.getShadowDecl()->constructsVirtualBase() ||
302          !Target.getCXXABI().hasConstructorVariants();
303 }
304 
305 const CGFunctionInfo &
306 CodeGenTypes::arrangeCXXStructorDeclaration(GlobalDecl GD) {
307   auto *MD = cast<CXXMethodDecl>(GD.getDecl());
308 
309   SmallVector<CanQualType, 16> argTypes;
310   SmallVector<FunctionProtoType::ExtParameterInfo, 16> paramInfos;
311   argTypes.push_back(DeriveThisType(MD->getParent(), MD));
312 
313   bool PassParams = true;
314 
315   if (auto *CD = dyn_cast<CXXConstructorDecl>(MD)) {
316     // A base class inheriting constructor doesn't get forwarded arguments
317     // needed to construct a virtual base (or base class thereof).
318     if (auto Inherited = CD->getInheritedConstructor())
319       PassParams = inheritingCtorHasParams(Inherited, GD.getCtorType());
320   }
321 
322   CanQual<FunctionProtoType> FTP = GetFormalType(MD);
323 
324   // Add the formal parameters.
325   if (PassParams)
326     appendParameterTypes(*this, argTypes, paramInfos, FTP);
327 
328   CGCXXABI::AddedStructorArgs AddedArgs =
329       TheCXXABI.buildStructorSignature(GD, argTypes);
330   if (!paramInfos.empty()) {
331     // Note: prefix implies after the first param.
332     if (AddedArgs.Prefix)
333       paramInfos.insert(paramInfos.begin() + 1, AddedArgs.Prefix,
334                         FunctionProtoType::ExtParameterInfo{});
335     if (AddedArgs.Suffix)
336       paramInfos.append(AddedArgs.Suffix,
337                         FunctionProtoType::ExtParameterInfo{});
338   }
339 
340   RequiredArgs required =
341       (PassParams && MD->isVariadic() ? RequiredArgs(argTypes.size())
342                                       : RequiredArgs::All);
343 
344   FunctionType::ExtInfo extInfo = FTP->getExtInfo();
345   CanQualType resultType = TheCXXABI.HasThisReturn(GD)
346                                ? argTypes.front()
347                                : TheCXXABI.hasMostDerivedReturn(GD)
348                                      ? CGM.getContext().VoidPtrTy
349                                      : Context.VoidTy;
350   return arrangeLLVMFunctionInfo(resultType, /*instanceMethod=*/true,
351                                  /*chainCall=*/false, argTypes, extInfo,
352                                  paramInfos, required);
353 }
354 
355 static SmallVector<CanQualType, 16>
356 getArgTypesForCall(ASTContext &ctx, const CallArgList &args) {
357   SmallVector<CanQualType, 16> argTypes;
358   for (auto &arg : args)
359     argTypes.push_back(ctx.getCanonicalParamType(arg.Ty));
360   return argTypes;
361 }
362 
363 static SmallVector<CanQualType, 16>
364 getArgTypesForDeclaration(ASTContext &ctx, const FunctionArgList &args) {
365   SmallVector<CanQualType, 16> argTypes;
366   for (auto &arg : args)
367     argTypes.push_back(ctx.getCanonicalParamType(arg->getType()));
368   return argTypes;
369 }
370 
371 static llvm::SmallVector<FunctionProtoType::ExtParameterInfo, 16>
372 getExtParameterInfosForCall(const FunctionProtoType *proto,
373                             unsigned prefixArgs, unsigned totalArgs) {
374   llvm::SmallVector<FunctionProtoType::ExtParameterInfo, 16> result;
375   if (proto->hasExtParameterInfos()) {
376     addExtParameterInfosForCall(result, proto, prefixArgs, totalArgs);
377   }
378   return result;
379 }
380 
381 /// Arrange a call to a C++ method, passing the given arguments.
382 ///
383 /// ExtraPrefixArgs is the number of ABI-specific args passed after the `this`
384 /// parameter.
385 /// ExtraSuffixArgs is the number of ABI-specific args passed at the end of
386 /// args.
387 /// PassProtoArgs indicates whether `args` has args for the parameters in the
388 /// given CXXConstructorDecl.
389 const CGFunctionInfo &
390 CodeGenTypes::arrangeCXXConstructorCall(const CallArgList &args,
391                                         const CXXConstructorDecl *D,
392                                         CXXCtorType CtorKind,
393                                         unsigned ExtraPrefixArgs,
394                                         unsigned ExtraSuffixArgs,
395                                         bool PassProtoArgs) {
396   // FIXME: Kill copy.
397   SmallVector<CanQualType, 16> ArgTypes;
398   for (const auto &Arg : args)
399     ArgTypes.push_back(Context.getCanonicalParamType(Arg.Ty));
400 
401   // +1 for implicit this, which should always be args[0].
402   unsigned TotalPrefixArgs = 1 + ExtraPrefixArgs;
403 
404   CanQual<FunctionProtoType> FPT = GetFormalType(D);
405   RequiredArgs Required = PassProtoArgs
406                               ? RequiredArgs::forPrototypePlus(
407                                     FPT, TotalPrefixArgs + ExtraSuffixArgs)
408                               : RequiredArgs::All;
409 
410   GlobalDecl GD(D, CtorKind);
411   CanQualType ResultType = TheCXXABI.HasThisReturn(GD)
412                                ? ArgTypes.front()
413                                : TheCXXABI.hasMostDerivedReturn(GD)
414                                      ? CGM.getContext().VoidPtrTy
415                                      : Context.VoidTy;
416 
417   FunctionType::ExtInfo Info = FPT->getExtInfo();
418   llvm::SmallVector<FunctionProtoType::ExtParameterInfo, 16> ParamInfos;
419   // If the prototype args are elided, we should only have ABI-specific args,
420   // which never have param info.
421   if (PassProtoArgs && FPT->hasExtParameterInfos()) {
422     // ABI-specific suffix arguments are treated the same as variadic arguments.
423     addExtParameterInfosForCall(ParamInfos, FPT.getTypePtr(), TotalPrefixArgs,
424                                 ArgTypes.size());
425   }
426   return arrangeLLVMFunctionInfo(ResultType, /*instanceMethod=*/true,
427                                  /*chainCall=*/false, ArgTypes, Info,
428                                  ParamInfos, Required);
429 }
430 
431 /// Arrange the argument and result information for the declaration or
432 /// definition of the given function.
433 const CGFunctionInfo &
434 CodeGenTypes::arrangeFunctionDeclaration(const FunctionDecl *FD) {
435   if (const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(FD))
436     if (MD->isInstance())
437       return arrangeCXXMethodDeclaration(MD);
438 
439   CanQualType FTy = FD->getType()->getCanonicalTypeUnqualified();
440 
441   assert(isa<FunctionType>(FTy));
442   setCUDAKernelCallingConvention(FTy, CGM, FD);
443 
444   // When declaring a function without a prototype, always use a
445   // non-variadic type.
446   if (CanQual<FunctionNoProtoType> noProto = FTy.getAs<FunctionNoProtoType>()) {
447     return arrangeLLVMFunctionInfo(
448         noProto->getReturnType(), /*instanceMethod=*/false,
449         /*chainCall=*/false, None, noProto->getExtInfo(), {},RequiredArgs::All);
450   }
451 
452   return arrangeFreeFunctionType(FTy.castAs<FunctionProtoType>());
453 }
454 
455 /// Arrange the argument and result information for the declaration or
456 /// definition of an Objective-C method.
457 const CGFunctionInfo &
458 CodeGenTypes::arrangeObjCMethodDeclaration(const ObjCMethodDecl *MD) {
459   // It happens that this is the same as a call with no optional
460   // arguments, except also using the formal 'self' type.
461   return arrangeObjCMessageSendSignature(MD, MD->getSelfDecl()->getType());
462 }
463 
464 /// Arrange the argument and result information for the function type
465 /// through which to perform a send to the given Objective-C method,
466 /// using the given receiver type.  The receiver type is not always
467 /// the 'self' type of the method or even an Objective-C pointer type.
468 /// This is *not* the right method for actually performing such a
469 /// message send, due to the possibility of optional arguments.
470 const CGFunctionInfo &
471 CodeGenTypes::arrangeObjCMessageSendSignature(const ObjCMethodDecl *MD,
472                                               QualType receiverType) {
473   SmallVector<CanQualType, 16> argTys;
474   SmallVector<FunctionProtoType::ExtParameterInfo, 4> extParamInfos(2);
475   argTys.push_back(Context.getCanonicalParamType(receiverType));
476   argTys.push_back(Context.getCanonicalParamType(Context.getObjCSelType()));
477   // FIXME: Kill copy?
478   for (const auto *I : MD->parameters()) {
479     argTys.push_back(Context.getCanonicalParamType(I->getType()));
480     auto extParamInfo = FunctionProtoType::ExtParameterInfo().withIsNoEscape(
481         I->hasAttr<NoEscapeAttr>());
482     extParamInfos.push_back(extParamInfo);
483   }
484 
485   FunctionType::ExtInfo einfo;
486   bool IsWindows = getContext().getTargetInfo().getTriple().isOSWindows();
487   einfo = einfo.withCallingConv(getCallingConventionForDecl(MD, IsWindows));
488 
489   if (getContext().getLangOpts().ObjCAutoRefCount &&
490       MD->hasAttr<NSReturnsRetainedAttr>())
491     einfo = einfo.withProducesResult(true);
492 
493   RequiredArgs required =
494     (MD->isVariadic() ? RequiredArgs(argTys.size()) : RequiredArgs::All);
495 
496   return arrangeLLVMFunctionInfo(
497       GetReturnType(MD->getReturnType()), /*instanceMethod=*/false,
498       /*chainCall=*/false, argTys, einfo, extParamInfos, required);
499 }
500 
501 const CGFunctionInfo &
502 CodeGenTypes::arrangeUnprototypedObjCMessageSend(QualType returnType,
503                                                  const CallArgList &args) {
504   auto argTypes = getArgTypesForCall(Context, args);
505   FunctionType::ExtInfo einfo;
506 
507   return arrangeLLVMFunctionInfo(
508       GetReturnType(returnType), /*instanceMethod=*/false,
509       /*chainCall=*/false, argTypes, einfo, {}, RequiredArgs::All);
510 }
511 
512 const CGFunctionInfo &
513 CodeGenTypes::arrangeGlobalDeclaration(GlobalDecl GD) {
514   // FIXME: Do we need to handle ObjCMethodDecl?
515   const FunctionDecl *FD = cast<FunctionDecl>(GD.getDecl());
516 
517   if (isa<CXXConstructorDecl>(GD.getDecl()) ||
518       isa<CXXDestructorDecl>(GD.getDecl()))
519     return arrangeCXXStructorDeclaration(GD);
520 
521   return arrangeFunctionDeclaration(FD);
522 }
523 
524 /// Arrange a thunk that takes 'this' as the first parameter followed by
525 /// varargs.  Return a void pointer, regardless of the actual return type.
526 /// The body of the thunk will end in a musttail call to a function of the
527 /// correct type, and the caller will bitcast the function to the correct
528 /// prototype.
529 const CGFunctionInfo &
530 CodeGenTypes::arrangeUnprototypedMustTailThunk(const CXXMethodDecl *MD) {
531   assert(MD->isVirtual() && "only methods have thunks");
532   CanQual<FunctionProtoType> FTP = GetFormalType(MD);
533   CanQualType ArgTys[] = {DeriveThisType(MD->getParent(), MD)};
534   return arrangeLLVMFunctionInfo(Context.VoidTy, /*instanceMethod=*/false,
535                                  /*chainCall=*/false, ArgTys,
536                                  FTP->getExtInfo(), {}, RequiredArgs(1));
537 }
538 
539 const CGFunctionInfo &
540 CodeGenTypes::arrangeMSCtorClosure(const CXXConstructorDecl *CD,
541                                    CXXCtorType CT) {
542   assert(CT == Ctor_CopyingClosure || CT == Ctor_DefaultClosure);
543 
544   CanQual<FunctionProtoType> FTP = GetFormalType(CD);
545   SmallVector<CanQualType, 2> ArgTys;
546   const CXXRecordDecl *RD = CD->getParent();
547   ArgTys.push_back(DeriveThisType(RD, CD));
548   if (CT == Ctor_CopyingClosure)
549     ArgTys.push_back(*FTP->param_type_begin());
550   if (RD->getNumVBases() > 0)
551     ArgTys.push_back(Context.IntTy);
552   CallingConv CC = Context.getDefaultCallingConvention(
553       /*IsVariadic=*/false, /*IsCXXMethod=*/true);
554   return arrangeLLVMFunctionInfo(Context.VoidTy, /*instanceMethod=*/true,
555                                  /*chainCall=*/false, ArgTys,
556                                  FunctionType::ExtInfo(CC), {},
557                                  RequiredArgs::All);
558 }
559 
560 /// Arrange a call as unto a free function, except possibly with an
561 /// additional number of formal parameters considered required.
562 static const CGFunctionInfo &
563 arrangeFreeFunctionLikeCall(CodeGenTypes &CGT,
564                             CodeGenModule &CGM,
565                             const CallArgList &args,
566                             const FunctionType *fnType,
567                             unsigned numExtraRequiredArgs,
568                             bool chainCall) {
569   assert(args.size() >= numExtraRequiredArgs);
570 
571   llvm::SmallVector<FunctionProtoType::ExtParameterInfo, 16> paramInfos;
572 
573   // In most cases, there are no optional arguments.
574   RequiredArgs required = RequiredArgs::All;
575 
576   // If we have a variadic prototype, the required arguments are the
577   // extra prefix plus the arguments in the prototype.
578   if (const FunctionProtoType *proto = dyn_cast<FunctionProtoType>(fnType)) {
579     if (proto->isVariadic())
580       required = RequiredArgs::forPrototypePlus(proto, numExtraRequiredArgs);
581 
582     if (proto->hasExtParameterInfos())
583       addExtParameterInfosForCall(paramInfos, proto, numExtraRequiredArgs,
584                                   args.size());
585 
586   // If we don't have a prototype at all, but we're supposed to
587   // explicitly use the variadic convention for unprototyped calls,
588   // treat all of the arguments as required but preserve the nominal
589   // possibility of variadics.
590   } else if (CGM.getTargetCodeGenInfo()
591                 .isNoProtoCallVariadic(args,
592                                        cast<FunctionNoProtoType>(fnType))) {
593     required = RequiredArgs(args.size());
594   }
595 
596   // FIXME: Kill copy.
597   SmallVector<CanQualType, 16> argTypes;
598   for (const auto &arg : args)
599     argTypes.push_back(CGT.getContext().getCanonicalParamType(arg.Ty));
600   return CGT.arrangeLLVMFunctionInfo(GetReturnType(fnType->getReturnType()),
601                                      /*instanceMethod=*/false, chainCall,
602                                      argTypes, fnType->getExtInfo(), paramInfos,
603                                      required);
604 }
605 
606 /// Figure out the rules for calling a function with the given formal
607 /// type using the given arguments.  The arguments are necessary
608 /// because the function might be unprototyped, in which case it's
609 /// target-dependent in crazy ways.
610 const CGFunctionInfo &
611 CodeGenTypes::arrangeFreeFunctionCall(const CallArgList &args,
612                                       const FunctionType *fnType,
613                                       bool chainCall) {
614   return arrangeFreeFunctionLikeCall(*this, CGM, args, fnType,
615                                      chainCall ? 1 : 0, chainCall);
616 }
617 
618 /// A block function is essentially a free function with an
619 /// extra implicit argument.
620 const CGFunctionInfo &
621 CodeGenTypes::arrangeBlockFunctionCall(const CallArgList &args,
622                                        const FunctionType *fnType) {
623   return arrangeFreeFunctionLikeCall(*this, CGM, args, fnType, 1,
624                                      /*chainCall=*/false);
625 }
626 
627 const CGFunctionInfo &
628 CodeGenTypes::arrangeBlockFunctionDeclaration(const FunctionProtoType *proto,
629                                               const FunctionArgList &params) {
630   auto paramInfos = getExtParameterInfosForCall(proto, 1, params.size());
631   auto argTypes = getArgTypesForDeclaration(Context, params);
632 
633   return arrangeLLVMFunctionInfo(GetReturnType(proto->getReturnType()),
634                                  /*instanceMethod*/ false, /*chainCall*/ false,
635                                  argTypes, proto->getExtInfo(), paramInfos,
636                                  RequiredArgs::forPrototypePlus(proto, 1));
637 }
638 
639 const CGFunctionInfo &
640 CodeGenTypes::arrangeBuiltinFunctionCall(QualType resultType,
641                                          const CallArgList &args) {
642   // FIXME: Kill copy.
643   SmallVector<CanQualType, 16> argTypes;
644   for (const auto &Arg : args)
645     argTypes.push_back(Context.getCanonicalParamType(Arg.Ty));
646   return arrangeLLVMFunctionInfo(
647       GetReturnType(resultType), /*instanceMethod=*/false,
648       /*chainCall=*/false, argTypes, FunctionType::ExtInfo(),
649       /*paramInfos=*/ {}, RequiredArgs::All);
650 }
651 
652 const CGFunctionInfo &
653 CodeGenTypes::arrangeBuiltinFunctionDeclaration(QualType resultType,
654                                                 const FunctionArgList &args) {
655   auto argTypes = getArgTypesForDeclaration(Context, args);
656 
657   return arrangeLLVMFunctionInfo(
658       GetReturnType(resultType), /*instanceMethod=*/false, /*chainCall=*/false,
659       argTypes, FunctionType::ExtInfo(), {}, RequiredArgs::All);
660 }
661 
662 const CGFunctionInfo &
663 CodeGenTypes::arrangeBuiltinFunctionDeclaration(CanQualType resultType,
664                                               ArrayRef<CanQualType> argTypes) {
665   return arrangeLLVMFunctionInfo(
666       resultType, /*instanceMethod=*/false, /*chainCall=*/false,
667       argTypes, FunctionType::ExtInfo(), {}, RequiredArgs::All);
668 }
669 
670 /// Arrange a call to a C++ method, passing the given arguments.
671 ///
672 /// numPrefixArgs is the number of ABI-specific prefix arguments we have. It
673 /// does not count `this`.
674 const CGFunctionInfo &
675 CodeGenTypes::arrangeCXXMethodCall(const CallArgList &args,
676                                    const FunctionProtoType *proto,
677                                    RequiredArgs required,
678                                    unsigned numPrefixArgs) {
679   assert(numPrefixArgs + 1 <= args.size() &&
680          "Emitting a call with less args than the required prefix?");
681   // Add one to account for `this`. It's a bit awkward here, but we don't count
682   // `this` in similar places elsewhere.
683   auto paramInfos =
684     getExtParameterInfosForCall(proto, numPrefixArgs + 1, args.size());
685 
686   // FIXME: Kill copy.
687   auto argTypes = getArgTypesForCall(Context, args);
688 
689   FunctionType::ExtInfo info = proto->getExtInfo();
690   return arrangeLLVMFunctionInfo(
691       GetReturnType(proto->getReturnType()), /*instanceMethod=*/true,
692       /*chainCall=*/false, argTypes, info, paramInfos, required);
693 }
694 
695 const CGFunctionInfo &CodeGenTypes::arrangeNullaryFunction() {
696   return arrangeLLVMFunctionInfo(
697       getContext().VoidTy, /*instanceMethod=*/false, /*chainCall=*/false,
698       None, FunctionType::ExtInfo(), {}, RequiredArgs::All);
699 }
700 
701 const CGFunctionInfo &
702 CodeGenTypes::arrangeCall(const CGFunctionInfo &signature,
703                           const CallArgList &args) {
704   assert(signature.arg_size() <= args.size());
705   if (signature.arg_size() == args.size())
706     return signature;
707 
708   SmallVector<FunctionProtoType::ExtParameterInfo, 16> paramInfos;
709   auto sigParamInfos = signature.getExtParameterInfos();
710   if (!sigParamInfos.empty()) {
711     paramInfos.append(sigParamInfos.begin(), sigParamInfos.end());
712     paramInfos.resize(args.size());
713   }
714 
715   auto argTypes = getArgTypesForCall(Context, args);
716 
717   assert(signature.getRequiredArgs().allowsOptionalArgs());
718   return arrangeLLVMFunctionInfo(signature.getReturnType(),
719                                  signature.isInstanceMethod(),
720                                  signature.isChainCall(),
721                                  argTypes,
722                                  signature.getExtInfo(),
723                                  paramInfos,
724                                  signature.getRequiredArgs());
725 }
726 
727 namespace clang {
728 namespace CodeGen {
729 void computeSPIRKernelABIInfo(CodeGenModule &CGM, CGFunctionInfo &FI);
730 }
731 }
732 
733 /// Arrange the argument and result information for an abstract value
734 /// of a given function type.  This is the method which all of the
735 /// above functions ultimately defer to.
736 const CGFunctionInfo &
737 CodeGenTypes::arrangeLLVMFunctionInfo(CanQualType resultType,
738                                       bool instanceMethod,
739                                       bool chainCall,
740                                       ArrayRef<CanQualType> argTypes,
741                                       FunctionType::ExtInfo info,
742                      ArrayRef<FunctionProtoType::ExtParameterInfo> paramInfos,
743                                       RequiredArgs required) {
744   assert(llvm::all_of(argTypes,
745                       [](CanQualType T) { return T.isCanonicalAsParam(); }));
746 
747   // Lookup or create unique function info.
748   llvm::FoldingSetNodeID ID;
749   CGFunctionInfo::Profile(ID, instanceMethod, chainCall, info, paramInfos,
750                           required, resultType, argTypes);
751 
752   void *insertPos = nullptr;
753   CGFunctionInfo *FI = FunctionInfos.FindNodeOrInsertPos(ID, insertPos);
754   if (FI)
755     return *FI;
756 
757   unsigned CC = ClangCallConvToLLVMCallConv(info.getCC());
758 
759   // Construct the function info.  We co-allocate the ArgInfos.
760   FI = CGFunctionInfo::create(CC, instanceMethod, chainCall, info,
761                               paramInfos, resultType, argTypes, required);
762   FunctionInfos.InsertNode(FI, insertPos);
763 
764   bool inserted = FunctionsBeingProcessed.insert(FI).second;
765   (void)inserted;
766   assert(inserted && "Recursively being processed?");
767 
768   // Compute ABI information.
769   if (CC == llvm::CallingConv::SPIR_KERNEL) {
770     // Force target independent argument handling for the host visible
771     // kernel functions.
772     computeSPIRKernelABIInfo(CGM, *FI);
773   } else if (info.getCC() == CC_Swift) {
774     swiftcall::computeABIInfo(CGM, *FI);
775   } else {
776     getABIInfo().computeInfo(*FI);
777   }
778 
779   // Loop over all of the computed argument and return value info.  If any of
780   // them are direct or extend without a specified coerce type, specify the
781   // default now.
782   ABIArgInfo &retInfo = FI->getReturnInfo();
783   if (retInfo.canHaveCoerceToType() && retInfo.getCoerceToType() == nullptr)
784     retInfo.setCoerceToType(ConvertType(FI->getReturnType()));
785 
786   for (auto &I : FI->arguments())
787     if (I.info.canHaveCoerceToType() && I.info.getCoerceToType() == nullptr)
788       I.info.setCoerceToType(ConvertType(I.type));
789 
790   bool erased = FunctionsBeingProcessed.erase(FI); (void)erased;
791   assert(erased && "Not in set?");
792 
793   return *FI;
794 }
795 
796 CGFunctionInfo *CGFunctionInfo::create(unsigned llvmCC,
797                                        bool instanceMethod,
798                                        bool chainCall,
799                                        const FunctionType::ExtInfo &info,
800                                        ArrayRef<ExtParameterInfo> paramInfos,
801                                        CanQualType resultType,
802                                        ArrayRef<CanQualType> argTypes,
803                                        RequiredArgs required) {
804   assert(paramInfos.empty() || paramInfos.size() == argTypes.size());
805   assert(!required.allowsOptionalArgs() ||
806          required.getNumRequiredArgs() <= argTypes.size());
807 
808   void *buffer =
809     operator new(totalSizeToAlloc<ArgInfo,             ExtParameterInfo>(
810                                   argTypes.size() + 1, paramInfos.size()));
811 
812   CGFunctionInfo *FI = new(buffer) CGFunctionInfo();
813   FI->CallingConvention = llvmCC;
814   FI->EffectiveCallingConvention = llvmCC;
815   FI->ASTCallingConvention = info.getCC();
816   FI->InstanceMethod = instanceMethod;
817   FI->ChainCall = chainCall;
818   FI->NoReturn = info.getNoReturn();
819   FI->ReturnsRetained = info.getProducesResult();
820   FI->NoCallerSavedRegs = info.getNoCallerSavedRegs();
821   FI->NoCfCheck = info.getNoCfCheck();
822   FI->Required = required;
823   FI->HasRegParm = info.getHasRegParm();
824   FI->RegParm = info.getRegParm();
825   FI->ArgStruct = nullptr;
826   FI->ArgStructAlign = 0;
827   FI->NumArgs = argTypes.size();
828   FI->HasExtParameterInfos = !paramInfos.empty();
829   FI->getArgsBuffer()[0].type = resultType;
830   for (unsigned i = 0, e = argTypes.size(); i != e; ++i)
831     FI->getArgsBuffer()[i + 1].type = argTypes[i];
832   for (unsigned i = 0, e = paramInfos.size(); i != e; ++i)
833     FI->getExtParameterInfosBuffer()[i] = paramInfos[i];
834   return FI;
835 }
836 
837 /***/
838 
839 namespace {
840 // ABIArgInfo::Expand implementation.
841 
842 // Specifies the way QualType passed as ABIArgInfo::Expand is expanded.
843 struct TypeExpansion {
844   enum TypeExpansionKind {
845     // Elements of constant arrays are expanded recursively.
846     TEK_ConstantArray,
847     // Record fields are expanded recursively (but if record is a union, only
848     // the field with the largest size is expanded).
849     TEK_Record,
850     // For complex types, real and imaginary parts are expanded recursively.
851     TEK_Complex,
852     // All other types are not expandable.
853     TEK_None
854   };
855 
856   const TypeExpansionKind Kind;
857 
858   TypeExpansion(TypeExpansionKind K) : Kind(K) {}
859   virtual ~TypeExpansion() {}
860 };
861 
862 struct ConstantArrayExpansion : TypeExpansion {
863   QualType EltTy;
864   uint64_t NumElts;
865 
866   ConstantArrayExpansion(QualType EltTy, uint64_t NumElts)
867       : TypeExpansion(TEK_ConstantArray), EltTy(EltTy), NumElts(NumElts) {}
868   static bool classof(const TypeExpansion *TE) {
869     return TE->Kind == TEK_ConstantArray;
870   }
871 };
872 
873 struct RecordExpansion : TypeExpansion {
874   SmallVector<const CXXBaseSpecifier *, 1> Bases;
875 
876   SmallVector<const FieldDecl *, 1> Fields;
877 
878   RecordExpansion(SmallVector<const CXXBaseSpecifier *, 1> &&Bases,
879                   SmallVector<const FieldDecl *, 1> &&Fields)
880       : TypeExpansion(TEK_Record), Bases(std::move(Bases)),
881         Fields(std::move(Fields)) {}
882   static bool classof(const TypeExpansion *TE) {
883     return TE->Kind == TEK_Record;
884   }
885 };
886 
887 struct ComplexExpansion : TypeExpansion {
888   QualType EltTy;
889 
890   ComplexExpansion(QualType EltTy) : TypeExpansion(TEK_Complex), EltTy(EltTy) {}
891   static bool classof(const TypeExpansion *TE) {
892     return TE->Kind == TEK_Complex;
893   }
894 };
895 
896 struct NoExpansion : TypeExpansion {
897   NoExpansion() : TypeExpansion(TEK_None) {}
898   static bool classof(const TypeExpansion *TE) {
899     return TE->Kind == TEK_None;
900   }
901 };
902 }  // namespace
903 
904 static std::unique_ptr<TypeExpansion>
905 getTypeExpansion(QualType Ty, const ASTContext &Context) {
906   if (const ConstantArrayType *AT = Context.getAsConstantArrayType(Ty)) {
907     return std::make_unique<ConstantArrayExpansion>(
908         AT->getElementType(), AT->getSize().getZExtValue());
909   }
910   if (const RecordType *RT = Ty->getAs<RecordType>()) {
911     SmallVector<const CXXBaseSpecifier *, 1> Bases;
912     SmallVector<const FieldDecl *, 1> Fields;
913     const RecordDecl *RD = RT->getDecl();
914     assert(!RD->hasFlexibleArrayMember() &&
915            "Cannot expand structure with flexible array.");
916     if (RD->isUnion()) {
917       // Unions can be here only in degenerative cases - all the fields are same
918       // after flattening. Thus we have to use the "largest" field.
919       const FieldDecl *LargestFD = nullptr;
920       CharUnits UnionSize = CharUnits::Zero();
921 
922       for (const auto *FD : RD->fields()) {
923         if (FD->isZeroLengthBitField(Context))
924           continue;
925         assert(!FD->isBitField() &&
926                "Cannot expand structure with bit-field members.");
927         CharUnits FieldSize = Context.getTypeSizeInChars(FD->getType());
928         if (UnionSize < FieldSize) {
929           UnionSize = FieldSize;
930           LargestFD = FD;
931         }
932       }
933       if (LargestFD)
934         Fields.push_back(LargestFD);
935     } else {
936       if (const auto *CXXRD = dyn_cast<CXXRecordDecl>(RD)) {
937         assert(!CXXRD->isDynamicClass() &&
938                "cannot expand vtable pointers in dynamic classes");
939         for (const CXXBaseSpecifier &BS : CXXRD->bases())
940           Bases.push_back(&BS);
941       }
942 
943       for (const auto *FD : RD->fields()) {
944         if (FD->isZeroLengthBitField(Context))
945           continue;
946         assert(!FD->isBitField() &&
947                "Cannot expand structure with bit-field members.");
948         Fields.push_back(FD);
949       }
950     }
951     return std::make_unique<RecordExpansion>(std::move(Bases),
952                                               std::move(Fields));
953   }
954   if (const ComplexType *CT = Ty->getAs<ComplexType>()) {
955     return std::make_unique<ComplexExpansion>(CT->getElementType());
956   }
957   return std::make_unique<NoExpansion>();
958 }
959 
960 static int getExpansionSize(QualType Ty, const ASTContext &Context) {
961   auto Exp = getTypeExpansion(Ty, Context);
962   if (auto CAExp = dyn_cast<ConstantArrayExpansion>(Exp.get())) {
963     return CAExp->NumElts * getExpansionSize(CAExp->EltTy, Context);
964   }
965   if (auto RExp = dyn_cast<RecordExpansion>(Exp.get())) {
966     int Res = 0;
967     for (auto BS : RExp->Bases)
968       Res += getExpansionSize(BS->getType(), Context);
969     for (auto FD : RExp->Fields)
970       Res += getExpansionSize(FD->getType(), Context);
971     return Res;
972   }
973   if (isa<ComplexExpansion>(Exp.get()))
974     return 2;
975   assert(isa<NoExpansion>(Exp.get()));
976   return 1;
977 }
978 
979 void
980 CodeGenTypes::getExpandedTypes(QualType Ty,
981                                SmallVectorImpl<llvm::Type *>::iterator &TI) {
982   auto Exp = getTypeExpansion(Ty, Context);
983   if (auto CAExp = dyn_cast<ConstantArrayExpansion>(Exp.get())) {
984     for (int i = 0, n = CAExp->NumElts; i < n; i++) {
985       getExpandedTypes(CAExp->EltTy, TI);
986     }
987   } else if (auto RExp = dyn_cast<RecordExpansion>(Exp.get())) {
988     for (auto BS : RExp->Bases)
989       getExpandedTypes(BS->getType(), TI);
990     for (auto FD : RExp->Fields)
991       getExpandedTypes(FD->getType(), TI);
992   } else if (auto CExp = dyn_cast<ComplexExpansion>(Exp.get())) {
993     llvm::Type *EltTy = ConvertType(CExp->EltTy);
994     *TI++ = EltTy;
995     *TI++ = EltTy;
996   } else {
997     assert(isa<NoExpansion>(Exp.get()));
998     *TI++ = ConvertType(Ty);
999   }
1000 }
1001 
1002 static void forConstantArrayExpansion(CodeGenFunction &CGF,
1003                                       ConstantArrayExpansion *CAE,
1004                                       Address BaseAddr,
1005                                       llvm::function_ref<void(Address)> Fn) {
1006   CharUnits EltSize = CGF.getContext().getTypeSizeInChars(CAE->EltTy);
1007   CharUnits EltAlign =
1008     BaseAddr.getAlignment().alignmentOfArrayElement(EltSize);
1009 
1010   for (int i = 0, n = CAE->NumElts; i < n; i++) {
1011     llvm::Value *EltAddr =
1012       CGF.Builder.CreateConstGEP2_32(nullptr, BaseAddr.getPointer(), 0, i);
1013     Fn(Address(EltAddr, EltAlign));
1014   }
1015 }
1016 
1017 void CodeGenFunction::ExpandTypeFromArgs(
1018     QualType Ty, LValue LV, SmallVectorImpl<llvm::Value *>::iterator &AI) {
1019   assert(LV.isSimple() &&
1020          "Unexpected non-simple lvalue during struct expansion.");
1021 
1022   auto Exp = getTypeExpansion(Ty, getContext());
1023   if (auto CAExp = dyn_cast<ConstantArrayExpansion>(Exp.get())) {
1024     forConstantArrayExpansion(
1025         *this, CAExp, LV.getAddress(*this), [&](Address EltAddr) {
1026           LValue LV = MakeAddrLValue(EltAddr, CAExp->EltTy);
1027           ExpandTypeFromArgs(CAExp->EltTy, LV, AI);
1028         });
1029   } else if (auto RExp = dyn_cast<RecordExpansion>(Exp.get())) {
1030     Address This = LV.getAddress(*this);
1031     for (const CXXBaseSpecifier *BS : RExp->Bases) {
1032       // Perform a single step derived-to-base conversion.
1033       Address Base =
1034           GetAddressOfBaseClass(This, Ty->getAsCXXRecordDecl(), &BS, &BS + 1,
1035                                 /*NullCheckValue=*/false, SourceLocation());
1036       LValue SubLV = MakeAddrLValue(Base, BS->getType());
1037 
1038       // Recurse onto bases.
1039       ExpandTypeFromArgs(BS->getType(), SubLV, AI);
1040     }
1041     for (auto FD : RExp->Fields) {
1042       // FIXME: What are the right qualifiers here?
1043       LValue SubLV = EmitLValueForFieldInitialization(LV, FD);
1044       ExpandTypeFromArgs(FD->getType(), SubLV, AI);
1045     }
1046   } else if (isa<ComplexExpansion>(Exp.get())) {
1047     auto realValue = *AI++;
1048     auto imagValue = *AI++;
1049     EmitStoreOfComplex(ComplexPairTy(realValue, imagValue), LV, /*init*/ true);
1050   } else {
1051     // Call EmitStoreOfScalar except when the lvalue is a bitfield to emit a
1052     // primitive store.
1053     assert(isa<NoExpansion>(Exp.get()));
1054     if (LV.isBitField())
1055       EmitStoreThroughLValue(RValue::get(*AI++), LV);
1056     else
1057       EmitStoreOfScalar(*AI++, LV);
1058   }
1059 }
1060 
1061 void CodeGenFunction::ExpandTypeToArgs(
1062     QualType Ty, CallArg Arg, llvm::FunctionType *IRFuncTy,
1063     SmallVectorImpl<llvm::Value *> &IRCallArgs, unsigned &IRCallArgPos) {
1064   auto Exp = getTypeExpansion(Ty, getContext());
1065   if (auto CAExp = dyn_cast<ConstantArrayExpansion>(Exp.get())) {
1066     Address Addr = Arg.hasLValue() ? Arg.getKnownLValue().getAddress(*this)
1067                                    : Arg.getKnownRValue().getAggregateAddress();
1068     forConstantArrayExpansion(
1069         *this, CAExp, Addr, [&](Address EltAddr) {
1070           CallArg EltArg = CallArg(
1071               convertTempToRValue(EltAddr, CAExp->EltTy, SourceLocation()),
1072               CAExp->EltTy);
1073           ExpandTypeToArgs(CAExp->EltTy, EltArg, IRFuncTy, IRCallArgs,
1074                            IRCallArgPos);
1075         });
1076   } else if (auto RExp = dyn_cast<RecordExpansion>(Exp.get())) {
1077     Address This = Arg.hasLValue() ? Arg.getKnownLValue().getAddress(*this)
1078                                    : Arg.getKnownRValue().getAggregateAddress();
1079     for (const CXXBaseSpecifier *BS : RExp->Bases) {
1080       // Perform a single step derived-to-base conversion.
1081       Address Base =
1082           GetAddressOfBaseClass(This, Ty->getAsCXXRecordDecl(), &BS, &BS + 1,
1083                                 /*NullCheckValue=*/false, SourceLocation());
1084       CallArg BaseArg = CallArg(RValue::getAggregate(Base), BS->getType());
1085 
1086       // Recurse onto bases.
1087       ExpandTypeToArgs(BS->getType(), BaseArg, IRFuncTy, IRCallArgs,
1088                        IRCallArgPos);
1089     }
1090 
1091     LValue LV = MakeAddrLValue(This, Ty);
1092     for (auto FD : RExp->Fields) {
1093       CallArg FldArg =
1094           CallArg(EmitRValueForField(LV, FD, SourceLocation()), FD->getType());
1095       ExpandTypeToArgs(FD->getType(), FldArg, IRFuncTy, IRCallArgs,
1096                        IRCallArgPos);
1097     }
1098   } else if (isa<ComplexExpansion>(Exp.get())) {
1099     ComplexPairTy CV = Arg.getKnownRValue().getComplexVal();
1100     IRCallArgs[IRCallArgPos++] = CV.first;
1101     IRCallArgs[IRCallArgPos++] = CV.second;
1102   } else {
1103     assert(isa<NoExpansion>(Exp.get()));
1104     auto RV = Arg.getKnownRValue();
1105     assert(RV.isScalar() &&
1106            "Unexpected non-scalar rvalue during struct expansion.");
1107 
1108     // Insert a bitcast as needed.
1109     llvm::Value *V = RV.getScalarVal();
1110     if (IRCallArgPos < IRFuncTy->getNumParams() &&
1111         V->getType() != IRFuncTy->getParamType(IRCallArgPos))
1112       V = Builder.CreateBitCast(V, IRFuncTy->getParamType(IRCallArgPos));
1113 
1114     IRCallArgs[IRCallArgPos++] = V;
1115   }
1116 }
1117 
1118 /// Create a temporary allocation for the purposes of coercion.
1119 static Address CreateTempAllocaForCoercion(CodeGenFunction &CGF, llvm::Type *Ty,
1120                                            CharUnits MinAlign) {
1121   // Don't use an alignment that's worse than what LLVM would prefer.
1122   auto PrefAlign = CGF.CGM.getDataLayout().getPrefTypeAlignment(Ty);
1123   CharUnits Align = std::max(MinAlign, CharUnits::fromQuantity(PrefAlign));
1124 
1125   return CGF.CreateTempAlloca(Ty, Align);
1126 }
1127 
1128 /// EnterStructPointerForCoercedAccess - Given a struct pointer that we are
1129 /// accessing some number of bytes out of it, try to gep into the struct to get
1130 /// at its inner goodness.  Dive as deep as possible without entering an element
1131 /// with an in-memory size smaller than DstSize.
1132 static Address
1133 EnterStructPointerForCoercedAccess(Address SrcPtr,
1134                                    llvm::StructType *SrcSTy,
1135                                    uint64_t DstSize, CodeGenFunction &CGF) {
1136   // We can't dive into a zero-element struct.
1137   if (SrcSTy->getNumElements() == 0) return SrcPtr;
1138 
1139   llvm::Type *FirstElt = SrcSTy->getElementType(0);
1140 
1141   // If the first elt is at least as large as what we're looking for, or if the
1142   // first element is the same size as the whole struct, we can enter it. The
1143   // comparison must be made on the store size and not the alloca size. Using
1144   // the alloca size may overstate the size of the load.
1145   uint64_t FirstEltSize =
1146     CGF.CGM.getDataLayout().getTypeStoreSize(FirstElt);
1147   if (FirstEltSize < DstSize &&
1148       FirstEltSize < CGF.CGM.getDataLayout().getTypeStoreSize(SrcSTy))
1149     return SrcPtr;
1150 
1151   // GEP into the first element.
1152   SrcPtr = CGF.Builder.CreateStructGEP(SrcPtr, 0, "coerce.dive");
1153 
1154   // If the first element is a struct, recurse.
1155   llvm::Type *SrcTy = SrcPtr.getElementType();
1156   if (llvm::StructType *SrcSTy = dyn_cast<llvm::StructType>(SrcTy))
1157     return EnterStructPointerForCoercedAccess(SrcPtr, SrcSTy, DstSize, CGF);
1158 
1159   return SrcPtr;
1160 }
1161 
1162 /// CoerceIntOrPtrToIntOrPtr - Convert a value Val to the specific Ty where both
1163 /// are either integers or pointers.  This does a truncation of the value if it
1164 /// is too large or a zero extension if it is too small.
1165 ///
1166 /// This behaves as if the value were coerced through memory, so on big-endian
1167 /// targets the high bits are preserved in a truncation, while little-endian
1168 /// targets preserve the low bits.
1169 static llvm::Value *CoerceIntOrPtrToIntOrPtr(llvm::Value *Val,
1170                                              llvm::Type *Ty,
1171                                              CodeGenFunction &CGF) {
1172   if (Val->getType() == Ty)
1173     return Val;
1174 
1175   if (isa<llvm::PointerType>(Val->getType())) {
1176     // If this is Pointer->Pointer avoid conversion to and from int.
1177     if (isa<llvm::PointerType>(Ty))
1178       return CGF.Builder.CreateBitCast(Val, Ty, "coerce.val");
1179 
1180     // Convert the pointer to an integer so we can play with its width.
1181     Val = CGF.Builder.CreatePtrToInt(Val, CGF.IntPtrTy, "coerce.val.pi");
1182   }
1183 
1184   llvm::Type *DestIntTy = Ty;
1185   if (isa<llvm::PointerType>(DestIntTy))
1186     DestIntTy = CGF.IntPtrTy;
1187 
1188   if (Val->getType() != DestIntTy) {
1189     const llvm::DataLayout &DL = CGF.CGM.getDataLayout();
1190     if (DL.isBigEndian()) {
1191       // Preserve the high bits on big-endian targets.
1192       // That is what memory coercion does.
1193       uint64_t SrcSize = DL.getTypeSizeInBits(Val->getType());
1194       uint64_t DstSize = DL.getTypeSizeInBits(DestIntTy);
1195 
1196       if (SrcSize > DstSize) {
1197         Val = CGF.Builder.CreateLShr(Val, SrcSize - DstSize, "coerce.highbits");
1198         Val = CGF.Builder.CreateTrunc(Val, DestIntTy, "coerce.val.ii");
1199       } else {
1200         Val = CGF.Builder.CreateZExt(Val, DestIntTy, "coerce.val.ii");
1201         Val = CGF.Builder.CreateShl(Val, DstSize - SrcSize, "coerce.highbits");
1202       }
1203     } else {
1204       // Little-endian targets preserve the low bits. No shifts required.
1205       Val = CGF.Builder.CreateIntCast(Val, DestIntTy, false, "coerce.val.ii");
1206     }
1207   }
1208 
1209   if (isa<llvm::PointerType>(Ty))
1210     Val = CGF.Builder.CreateIntToPtr(Val, Ty, "coerce.val.ip");
1211   return Val;
1212 }
1213 
1214 
1215 
1216 /// CreateCoercedLoad - Create a load from \arg SrcPtr interpreted as
1217 /// a pointer to an object of type \arg Ty, known to be aligned to
1218 /// \arg SrcAlign bytes.
1219 ///
1220 /// This safely handles the case when the src type is smaller than the
1221 /// destination type; in this situation the values of bits which not
1222 /// present in the src are undefined.
1223 static llvm::Value *CreateCoercedLoad(Address Src, llvm::Type *Ty,
1224                                       CodeGenFunction &CGF) {
1225   llvm::Type *SrcTy = Src.getElementType();
1226 
1227   // If SrcTy and Ty are the same, just do a load.
1228   if (SrcTy == Ty)
1229     return CGF.Builder.CreateLoad(Src);
1230 
1231   uint64_t DstSize = CGF.CGM.getDataLayout().getTypeAllocSize(Ty);
1232 
1233   if (llvm::StructType *SrcSTy = dyn_cast<llvm::StructType>(SrcTy)) {
1234     Src = EnterStructPointerForCoercedAccess(Src, SrcSTy, DstSize, CGF);
1235     SrcTy = Src.getType()->getElementType();
1236   }
1237 
1238   uint64_t SrcSize = CGF.CGM.getDataLayout().getTypeAllocSize(SrcTy);
1239 
1240   // If the source and destination are integer or pointer types, just do an
1241   // extension or truncation to the desired type.
1242   if ((isa<llvm::IntegerType>(Ty) || isa<llvm::PointerType>(Ty)) &&
1243       (isa<llvm::IntegerType>(SrcTy) || isa<llvm::PointerType>(SrcTy))) {
1244     llvm::Value *Load = CGF.Builder.CreateLoad(Src);
1245     return CoerceIntOrPtrToIntOrPtr(Load, Ty, CGF);
1246   }
1247 
1248   // If load is legal, just bitcast the src pointer.
1249   if (SrcSize >= DstSize) {
1250     // Generally SrcSize is never greater than DstSize, since this means we are
1251     // losing bits. However, this can happen in cases where the structure has
1252     // additional padding, for example due to a user specified alignment.
1253     //
1254     // FIXME: Assert that we aren't truncating non-padding bits when have access
1255     // to that information.
1256     Src = CGF.Builder.CreateBitCast(Src,
1257                                     Ty->getPointerTo(Src.getAddressSpace()));
1258     return CGF.Builder.CreateLoad(Src);
1259   }
1260 
1261   // Otherwise do coercion through memory. This is stupid, but simple.
1262   Address Tmp = CreateTempAllocaForCoercion(CGF, Ty, Src.getAlignment());
1263   Address Casted = CGF.Builder.CreateElementBitCast(Tmp,CGF.Int8Ty);
1264   Address SrcCasted = CGF.Builder.CreateElementBitCast(Src,CGF.Int8Ty);
1265   CGF.Builder.CreateMemCpy(Casted, SrcCasted,
1266       llvm::ConstantInt::get(CGF.IntPtrTy, SrcSize),
1267       false);
1268   return CGF.Builder.CreateLoad(Tmp);
1269 }
1270 
1271 // Function to store a first-class aggregate into memory.  We prefer to
1272 // store the elements rather than the aggregate to be more friendly to
1273 // fast-isel.
1274 // FIXME: Do we need to recurse here?
1275 static void BuildAggStore(CodeGenFunction &CGF, llvm::Value *Val,
1276                           Address Dest, bool DestIsVolatile) {
1277   // Prefer scalar stores to first-class aggregate stores.
1278   if (llvm::StructType *STy =
1279         dyn_cast<llvm::StructType>(Val->getType())) {
1280     for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
1281       Address EltPtr = CGF.Builder.CreateStructGEP(Dest, i);
1282       llvm::Value *Elt = CGF.Builder.CreateExtractValue(Val, i);
1283       CGF.Builder.CreateStore(Elt, EltPtr, DestIsVolatile);
1284     }
1285   } else {
1286     CGF.Builder.CreateStore(Val, Dest, DestIsVolatile);
1287   }
1288 }
1289 
1290 /// CreateCoercedStore - Create a store to \arg DstPtr from \arg Src,
1291 /// where the source and destination may have different types.  The
1292 /// destination is known to be aligned to \arg DstAlign bytes.
1293 ///
1294 /// This safely handles the case when the src type is larger than the
1295 /// destination type; the upper bits of the src will be lost.
1296 static void CreateCoercedStore(llvm::Value *Src,
1297                                Address Dst,
1298                                bool DstIsVolatile,
1299                                CodeGenFunction &CGF) {
1300   llvm::Type *SrcTy = Src->getType();
1301   llvm::Type *DstTy = Dst.getType()->getElementType();
1302   if (SrcTy == DstTy) {
1303     CGF.Builder.CreateStore(Src, Dst, DstIsVolatile);
1304     return;
1305   }
1306 
1307   uint64_t SrcSize = CGF.CGM.getDataLayout().getTypeAllocSize(SrcTy);
1308 
1309   if (llvm::StructType *DstSTy = dyn_cast<llvm::StructType>(DstTy)) {
1310     Dst = EnterStructPointerForCoercedAccess(Dst, DstSTy, SrcSize, CGF);
1311     DstTy = Dst.getType()->getElementType();
1312   }
1313 
1314   llvm::PointerType *SrcPtrTy = llvm::dyn_cast<llvm::PointerType>(SrcTy);
1315   llvm::PointerType *DstPtrTy = llvm::dyn_cast<llvm::PointerType>(DstTy);
1316   if (SrcPtrTy && DstPtrTy &&
1317       SrcPtrTy->getAddressSpace() != DstPtrTy->getAddressSpace()) {
1318     Src = CGF.Builder.CreatePointerBitCastOrAddrSpaceCast(Src, DstTy);
1319     CGF.Builder.CreateStore(Src, Dst, DstIsVolatile);
1320     return;
1321   }
1322 
1323   // If the source and destination are integer or pointer types, just do an
1324   // extension or truncation to the desired type.
1325   if ((isa<llvm::IntegerType>(SrcTy) || isa<llvm::PointerType>(SrcTy)) &&
1326       (isa<llvm::IntegerType>(DstTy) || isa<llvm::PointerType>(DstTy))) {
1327     Src = CoerceIntOrPtrToIntOrPtr(Src, DstTy, CGF);
1328     CGF.Builder.CreateStore(Src, Dst, DstIsVolatile);
1329     return;
1330   }
1331 
1332   uint64_t DstSize = CGF.CGM.getDataLayout().getTypeAllocSize(DstTy);
1333 
1334   // If store is legal, just bitcast the src pointer.
1335   if (SrcSize <= DstSize) {
1336     Dst = CGF.Builder.CreateElementBitCast(Dst, SrcTy);
1337     BuildAggStore(CGF, Src, Dst, DstIsVolatile);
1338   } else {
1339     // Otherwise do coercion through memory. This is stupid, but
1340     // simple.
1341 
1342     // Generally SrcSize is never greater than DstSize, since this means we are
1343     // losing bits. However, this can happen in cases where the structure has
1344     // additional padding, for example due to a user specified alignment.
1345     //
1346     // FIXME: Assert that we aren't truncating non-padding bits when have access
1347     // to that information.
1348     Address Tmp = CreateTempAllocaForCoercion(CGF, SrcTy, Dst.getAlignment());
1349     CGF.Builder.CreateStore(Src, Tmp);
1350     Address Casted = CGF.Builder.CreateElementBitCast(Tmp,CGF.Int8Ty);
1351     Address DstCasted = CGF.Builder.CreateElementBitCast(Dst,CGF.Int8Ty);
1352     CGF.Builder.CreateMemCpy(DstCasted, Casted,
1353         llvm::ConstantInt::get(CGF.IntPtrTy, DstSize),
1354         false);
1355   }
1356 }
1357 
1358 static Address emitAddressAtOffset(CodeGenFunction &CGF, Address addr,
1359                                    const ABIArgInfo &info) {
1360   if (unsigned offset = info.getDirectOffset()) {
1361     addr = CGF.Builder.CreateElementBitCast(addr, CGF.Int8Ty);
1362     addr = CGF.Builder.CreateConstInBoundsByteGEP(addr,
1363                                              CharUnits::fromQuantity(offset));
1364     addr = CGF.Builder.CreateElementBitCast(addr, info.getCoerceToType());
1365   }
1366   return addr;
1367 }
1368 
1369 namespace {
1370 
1371 /// Encapsulates information about the way function arguments from
1372 /// CGFunctionInfo should be passed to actual LLVM IR function.
1373 class ClangToLLVMArgMapping {
1374   static const unsigned InvalidIndex = ~0U;
1375   unsigned InallocaArgNo;
1376   unsigned SRetArgNo;
1377   unsigned TotalIRArgs;
1378 
1379   /// Arguments of LLVM IR function corresponding to single Clang argument.
1380   struct IRArgs {
1381     unsigned PaddingArgIndex;
1382     // Argument is expanded to IR arguments at positions
1383     // [FirstArgIndex, FirstArgIndex + NumberOfArgs).
1384     unsigned FirstArgIndex;
1385     unsigned NumberOfArgs;
1386 
1387     IRArgs()
1388         : PaddingArgIndex(InvalidIndex), FirstArgIndex(InvalidIndex),
1389           NumberOfArgs(0) {}
1390   };
1391 
1392   SmallVector<IRArgs, 8> ArgInfo;
1393 
1394 public:
1395   ClangToLLVMArgMapping(const ASTContext &Context, const CGFunctionInfo &FI,
1396                         bool OnlyRequiredArgs = false)
1397       : InallocaArgNo(InvalidIndex), SRetArgNo(InvalidIndex), TotalIRArgs(0),
1398         ArgInfo(OnlyRequiredArgs ? FI.getNumRequiredArgs() : FI.arg_size()) {
1399     construct(Context, FI, OnlyRequiredArgs);
1400   }
1401 
1402   bool hasInallocaArg() const { return InallocaArgNo != InvalidIndex; }
1403   unsigned getInallocaArgNo() const {
1404     assert(hasInallocaArg());
1405     return InallocaArgNo;
1406   }
1407 
1408   bool hasSRetArg() const { return SRetArgNo != InvalidIndex; }
1409   unsigned getSRetArgNo() const {
1410     assert(hasSRetArg());
1411     return SRetArgNo;
1412   }
1413 
1414   unsigned totalIRArgs() const { return TotalIRArgs; }
1415 
1416   bool hasPaddingArg(unsigned ArgNo) const {
1417     assert(ArgNo < ArgInfo.size());
1418     return ArgInfo[ArgNo].PaddingArgIndex != InvalidIndex;
1419   }
1420   unsigned getPaddingArgNo(unsigned ArgNo) const {
1421     assert(hasPaddingArg(ArgNo));
1422     return ArgInfo[ArgNo].PaddingArgIndex;
1423   }
1424 
1425   /// Returns index of first IR argument corresponding to ArgNo, and their
1426   /// quantity.
1427   std::pair<unsigned, unsigned> getIRArgs(unsigned ArgNo) const {
1428     assert(ArgNo < ArgInfo.size());
1429     return std::make_pair(ArgInfo[ArgNo].FirstArgIndex,
1430                           ArgInfo[ArgNo].NumberOfArgs);
1431   }
1432 
1433 private:
1434   void construct(const ASTContext &Context, const CGFunctionInfo &FI,
1435                  bool OnlyRequiredArgs);
1436 };
1437 
1438 void ClangToLLVMArgMapping::construct(const ASTContext &Context,
1439                                       const CGFunctionInfo &FI,
1440                                       bool OnlyRequiredArgs) {
1441   unsigned IRArgNo = 0;
1442   bool SwapThisWithSRet = false;
1443   const ABIArgInfo &RetAI = FI.getReturnInfo();
1444 
1445   if (RetAI.getKind() == ABIArgInfo::Indirect) {
1446     SwapThisWithSRet = RetAI.isSRetAfterThis();
1447     SRetArgNo = SwapThisWithSRet ? 1 : IRArgNo++;
1448   }
1449 
1450   unsigned ArgNo = 0;
1451   unsigned NumArgs = OnlyRequiredArgs ? FI.getNumRequiredArgs() : FI.arg_size();
1452   for (CGFunctionInfo::const_arg_iterator I = FI.arg_begin(); ArgNo < NumArgs;
1453        ++I, ++ArgNo) {
1454     assert(I != FI.arg_end());
1455     QualType ArgType = I->type;
1456     const ABIArgInfo &AI = I->info;
1457     // Collect data about IR arguments corresponding to Clang argument ArgNo.
1458     auto &IRArgs = ArgInfo[ArgNo];
1459 
1460     if (AI.getPaddingType())
1461       IRArgs.PaddingArgIndex = IRArgNo++;
1462 
1463     switch (AI.getKind()) {
1464     case ABIArgInfo::Extend:
1465     case ABIArgInfo::Direct: {
1466       // FIXME: handle sseregparm someday...
1467       llvm::StructType *STy = dyn_cast<llvm::StructType>(AI.getCoerceToType());
1468       if (AI.isDirect() && AI.getCanBeFlattened() && STy) {
1469         IRArgs.NumberOfArgs = STy->getNumElements();
1470       } else {
1471         IRArgs.NumberOfArgs = 1;
1472       }
1473       break;
1474     }
1475     case ABIArgInfo::Indirect:
1476       IRArgs.NumberOfArgs = 1;
1477       break;
1478     case ABIArgInfo::Ignore:
1479     case ABIArgInfo::InAlloca:
1480       // ignore and inalloca doesn't have matching LLVM parameters.
1481       IRArgs.NumberOfArgs = 0;
1482       break;
1483     case ABIArgInfo::CoerceAndExpand:
1484       IRArgs.NumberOfArgs = AI.getCoerceAndExpandTypeSequence().size();
1485       break;
1486     case ABIArgInfo::Expand:
1487       IRArgs.NumberOfArgs = getExpansionSize(ArgType, Context);
1488       break;
1489     }
1490 
1491     if (IRArgs.NumberOfArgs > 0) {
1492       IRArgs.FirstArgIndex = IRArgNo;
1493       IRArgNo += IRArgs.NumberOfArgs;
1494     }
1495 
1496     // Skip over the sret parameter when it comes second.  We already handled it
1497     // above.
1498     if (IRArgNo == 1 && SwapThisWithSRet)
1499       IRArgNo++;
1500   }
1501   assert(ArgNo == ArgInfo.size());
1502 
1503   if (FI.usesInAlloca())
1504     InallocaArgNo = IRArgNo++;
1505 
1506   TotalIRArgs = IRArgNo;
1507 }
1508 }  // namespace
1509 
1510 /***/
1511 
1512 bool CodeGenModule::ReturnTypeUsesSRet(const CGFunctionInfo &FI) {
1513   const auto &RI = FI.getReturnInfo();
1514   return RI.isIndirect() || (RI.isInAlloca() && RI.getInAllocaSRet());
1515 }
1516 
1517 bool CodeGenModule::ReturnSlotInterferesWithArgs(const CGFunctionInfo &FI) {
1518   return ReturnTypeUsesSRet(FI) &&
1519          getTargetCodeGenInfo().doesReturnSlotInterfereWithArgs();
1520 }
1521 
1522 bool CodeGenModule::ReturnTypeUsesFPRet(QualType ResultType) {
1523   if (const BuiltinType *BT = ResultType->getAs<BuiltinType>()) {
1524     switch (BT->getKind()) {
1525     default:
1526       return false;
1527     case BuiltinType::Float:
1528       return getTarget().useObjCFPRetForRealType(TargetInfo::Float);
1529     case BuiltinType::Double:
1530       return getTarget().useObjCFPRetForRealType(TargetInfo::Double);
1531     case BuiltinType::LongDouble:
1532       return getTarget().useObjCFPRetForRealType(TargetInfo::LongDouble);
1533     }
1534   }
1535 
1536   return false;
1537 }
1538 
1539 bool CodeGenModule::ReturnTypeUsesFP2Ret(QualType ResultType) {
1540   if (const ComplexType *CT = ResultType->getAs<ComplexType>()) {
1541     if (const BuiltinType *BT = CT->getElementType()->getAs<BuiltinType>()) {
1542       if (BT->getKind() == BuiltinType::LongDouble)
1543         return getTarget().useObjCFP2RetForComplexLongDouble();
1544     }
1545   }
1546 
1547   return false;
1548 }
1549 
1550 llvm::FunctionType *CodeGenTypes::GetFunctionType(GlobalDecl GD) {
1551   const CGFunctionInfo &FI = arrangeGlobalDeclaration(GD);
1552   return GetFunctionType(FI);
1553 }
1554 
1555 llvm::FunctionType *
1556 CodeGenTypes::GetFunctionType(const CGFunctionInfo &FI) {
1557 
1558   bool Inserted = FunctionsBeingProcessed.insert(&FI).second;
1559   (void)Inserted;
1560   assert(Inserted && "Recursively being processed?");
1561 
1562   llvm::Type *resultType = nullptr;
1563   const ABIArgInfo &retAI = FI.getReturnInfo();
1564   switch (retAI.getKind()) {
1565   case ABIArgInfo::Expand:
1566     llvm_unreachable("Invalid ABI kind for return argument");
1567 
1568   case ABIArgInfo::Extend:
1569   case ABIArgInfo::Direct:
1570     resultType = retAI.getCoerceToType();
1571     break;
1572 
1573   case ABIArgInfo::InAlloca:
1574     if (retAI.getInAllocaSRet()) {
1575       // sret things on win32 aren't void, they return the sret pointer.
1576       QualType ret = FI.getReturnType();
1577       llvm::Type *ty = ConvertType(ret);
1578       unsigned addressSpace = Context.getTargetAddressSpace(ret);
1579       resultType = llvm::PointerType::get(ty, addressSpace);
1580     } else {
1581       resultType = llvm::Type::getVoidTy(getLLVMContext());
1582     }
1583     break;
1584 
1585   case ABIArgInfo::Indirect:
1586   case ABIArgInfo::Ignore:
1587     resultType = llvm::Type::getVoidTy(getLLVMContext());
1588     break;
1589 
1590   case ABIArgInfo::CoerceAndExpand:
1591     resultType = retAI.getUnpaddedCoerceAndExpandType();
1592     break;
1593   }
1594 
1595   ClangToLLVMArgMapping IRFunctionArgs(getContext(), FI, true);
1596   SmallVector<llvm::Type*, 8> ArgTypes(IRFunctionArgs.totalIRArgs());
1597 
1598   // Add type for sret argument.
1599   if (IRFunctionArgs.hasSRetArg()) {
1600     QualType Ret = FI.getReturnType();
1601     llvm::Type *Ty = ConvertType(Ret);
1602     unsigned AddressSpace = Context.getTargetAddressSpace(Ret);
1603     ArgTypes[IRFunctionArgs.getSRetArgNo()] =
1604         llvm::PointerType::get(Ty, AddressSpace);
1605   }
1606 
1607   // Add type for inalloca argument.
1608   if (IRFunctionArgs.hasInallocaArg()) {
1609     auto ArgStruct = FI.getArgStruct();
1610     assert(ArgStruct);
1611     ArgTypes[IRFunctionArgs.getInallocaArgNo()] = ArgStruct->getPointerTo();
1612   }
1613 
1614   // Add in all of the required arguments.
1615   unsigned ArgNo = 0;
1616   CGFunctionInfo::const_arg_iterator it = FI.arg_begin(),
1617                                      ie = it + FI.getNumRequiredArgs();
1618   for (; it != ie; ++it, ++ArgNo) {
1619     const ABIArgInfo &ArgInfo = it->info;
1620 
1621     // Insert a padding type to ensure proper alignment.
1622     if (IRFunctionArgs.hasPaddingArg(ArgNo))
1623       ArgTypes[IRFunctionArgs.getPaddingArgNo(ArgNo)] =
1624           ArgInfo.getPaddingType();
1625 
1626     unsigned FirstIRArg, NumIRArgs;
1627     std::tie(FirstIRArg, NumIRArgs) = IRFunctionArgs.getIRArgs(ArgNo);
1628 
1629     switch (ArgInfo.getKind()) {
1630     case ABIArgInfo::Ignore:
1631     case ABIArgInfo::InAlloca:
1632       assert(NumIRArgs == 0);
1633       break;
1634 
1635     case ABIArgInfo::Indirect: {
1636       assert(NumIRArgs == 1);
1637       // indirect arguments are always on the stack, which is alloca addr space.
1638       llvm::Type *LTy = ConvertTypeForMem(it->type);
1639       ArgTypes[FirstIRArg] = LTy->getPointerTo(
1640           CGM.getDataLayout().getAllocaAddrSpace());
1641       break;
1642     }
1643 
1644     case ABIArgInfo::Extend:
1645     case ABIArgInfo::Direct: {
1646       // Fast-isel and the optimizer generally like scalar values better than
1647       // FCAs, so we flatten them if this is safe to do for this argument.
1648       llvm::Type *argType = ArgInfo.getCoerceToType();
1649       llvm::StructType *st = dyn_cast<llvm::StructType>(argType);
1650       if (st && ArgInfo.isDirect() && ArgInfo.getCanBeFlattened()) {
1651         assert(NumIRArgs == st->getNumElements());
1652         for (unsigned i = 0, e = st->getNumElements(); i != e; ++i)
1653           ArgTypes[FirstIRArg + i] = st->getElementType(i);
1654       } else {
1655         assert(NumIRArgs == 1);
1656         ArgTypes[FirstIRArg] = argType;
1657       }
1658       break;
1659     }
1660 
1661     case ABIArgInfo::CoerceAndExpand: {
1662       auto ArgTypesIter = ArgTypes.begin() + FirstIRArg;
1663       for (auto EltTy : ArgInfo.getCoerceAndExpandTypeSequence()) {
1664         *ArgTypesIter++ = EltTy;
1665       }
1666       assert(ArgTypesIter == ArgTypes.begin() + FirstIRArg + NumIRArgs);
1667       break;
1668     }
1669 
1670     case ABIArgInfo::Expand:
1671       auto ArgTypesIter = ArgTypes.begin() + FirstIRArg;
1672       getExpandedTypes(it->type, ArgTypesIter);
1673       assert(ArgTypesIter == ArgTypes.begin() + FirstIRArg + NumIRArgs);
1674       break;
1675     }
1676   }
1677 
1678   bool Erased = FunctionsBeingProcessed.erase(&FI); (void)Erased;
1679   assert(Erased && "Not in set?");
1680 
1681   return llvm::FunctionType::get(resultType, ArgTypes, FI.isVariadic());
1682 }
1683 
1684 llvm::Type *CodeGenTypes::GetFunctionTypeForVTable(GlobalDecl GD) {
1685   const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
1686   const FunctionProtoType *FPT = MD->getType()->getAs<FunctionProtoType>();
1687 
1688   if (!isFuncTypeConvertible(FPT))
1689     return llvm::StructType::get(getLLVMContext());
1690 
1691   return GetFunctionType(GD);
1692 }
1693 
1694 static void AddAttributesFromFunctionProtoType(ASTContext &Ctx,
1695                                                llvm::AttrBuilder &FuncAttrs,
1696                                                const FunctionProtoType *FPT) {
1697   if (!FPT)
1698     return;
1699 
1700   if (!isUnresolvedExceptionSpec(FPT->getExceptionSpecType()) &&
1701       FPT->isNothrow())
1702     FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
1703 }
1704 
1705 void CodeGenModule::ConstructDefaultFnAttrList(StringRef Name, bool HasOptnone,
1706                                                bool AttrOnCallSite,
1707                                                llvm::AttrBuilder &FuncAttrs) {
1708   // OptimizeNoneAttr takes precedence over -Os or -Oz. No warning needed.
1709   if (!HasOptnone) {
1710     if (CodeGenOpts.OptimizeSize)
1711       FuncAttrs.addAttribute(llvm::Attribute::OptimizeForSize);
1712     if (CodeGenOpts.OptimizeSize == 2)
1713       FuncAttrs.addAttribute(llvm::Attribute::MinSize);
1714   }
1715 
1716   if (CodeGenOpts.DisableRedZone)
1717     FuncAttrs.addAttribute(llvm::Attribute::NoRedZone);
1718   if (CodeGenOpts.IndirectTlsSegRefs)
1719     FuncAttrs.addAttribute("indirect-tls-seg-refs");
1720   if (CodeGenOpts.NoImplicitFloat)
1721     FuncAttrs.addAttribute(llvm::Attribute::NoImplicitFloat);
1722 
1723   if (AttrOnCallSite) {
1724     // Attributes that should go on the call site only.
1725     if (!CodeGenOpts.SimplifyLibCalls ||
1726         CodeGenOpts.isNoBuiltinFunc(Name.data()))
1727       FuncAttrs.addAttribute(llvm::Attribute::NoBuiltin);
1728     if (!CodeGenOpts.TrapFuncName.empty())
1729       FuncAttrs.addAttribute("trap-func-name", CodeGenOpts.TrapFuncName);
1730   } else {
1731     StringRef FpKind;
1732     switch (CodeGenOpts.getFramePointer()) {
1733     case CodeGenOptions::FramePointerKind::None:
1734       FpKind = "none";
1735       break;
1736     case CodeGenOptions::FramePointerKind::NonLeaf:
1737       FpKind = "non-leaf";
1738       break;
1739     case CodeGenOptions::FramePointerKind::All:
1740       FpKind = "all";
1741       break;
1742     }
1743     FuncAttrs.addAttribute("frame-pointer", FpKind);
1744 
1745     FuncAttrs.addAttribute("less-precise-fpmad",
1746                            llvm::toStringRef(CodeGenOpts.LessPreciseFPMAD));
1747 
1748     if (CodeGenOpts.NullPointerIsValid)
1749       FuncAttrs.addAttribute("null-pointer-is-valid", "true");
1750 
1751     // TODO: Omit attribute when the default is IEEE.
1752     if (CodeGenOpts.FPDenormalMode != llvm::DenormalMode::Invalid)
1753       FuncAttrs.addAttribute("denormal-fp-math",
1754                              llvm::denormalModeName(CodeGenOpts.FPDenormalMode));
1755 
1756     if (CodeGenOpts.FP32DenormalMode != llvm::DenormalMode::Invalid)
1757       FuncAttrs.addAttribute(
1758           "denormal-fp-math-f32",
1759           llvm::denormalModeName(CodeGenOpts.FP32DenormalMode));
1760 
1761     FuncAttrs.addAttribute("no-trapping-math",
1762                            llvm::toStringRef(CodeGenOpts.NoTrappingMath));
1763 
1764     // Strict (compliant) code is the default, so only add this attribute to
1765     // indicate that we are trying to workaround a problem case.
1766     if (!CodeGenOpts.StrictFloatCastOverflow)
1767       FuncAttrs.addAttribute("strict-float-cast-overflow", "false");
1768 
1769     // TODO: Are these all needed?
1770     // unsafe/inf/nan/nsz are handled by instruction-level FastMathFlags.
1771     FuncAttrs.addAttribute("no-infs-fp-math",
1772                            llvm::toStringRef(CodeGenOpts.NoInfsFPMath));
1773     FuncAttrs.addAttribute("no-nans-fp-math",
1774                            llvm::toStringRef(CodeGenOpts.NoNaNsFPMath));
1775     FuncAttrs.addAttribute("unsafe-fp-math",
1776                            llvm::toStringRef(CodeGenOpts.UnsafeFPMath));
1777     FuncAttrs.addAttribute("use-soft-float",
1778                            llvm::toStringRef(CodeGenOpts.SoftFloat));
1779     FuncAttrs.addAttribute("stack-protector-buffer-size",
1780                            llvm::utostr(CodeGenOpts.SSPBufferSize));
1781     FuncAttrs.addAttribute("no-signed-zeros-fp-math",
1782                            llvm::toStringRef(CodeGenOpts.NoSignedZeros));
1783     FuncAttrs.addAttribute(
1784         "correctly-rounded-divide-sqrt-fp-math",
1785         llvm::toStringRef(CodeGenOpts.CorrectlyRoundedDivSqrt));
1786 
1787     // TODO: Reciprocal estimate codegen options should apply to instructions?
1788     const std::vector<std::string> &Recips = CodeGenOpts.Reciprocals;
1789     if (!Recips.empty())
1790       FuncAttrs.addAttribute("reciprocal-estimates",
1791                              llvm::join(Recips, ","));
1792 
1793     if (!CodeGenOpts.PreferVectorWidth.empty() &&
1794         CodeGenOpts.PreferVectorWidth != "none")
1795       FuncAttrs.addAttribute("prefer-vector-width",
1796                              CodeGenOpts.PreferVectorWidth);
1797 
1798     if (CodeGenOpts.StackRealignment)
1799       FuncAttrs.addAttribute("stackrealign");
1800     if (CodeGenOpts.Backchain)
1801       FuncAttrs.addAttribute("backchain");
1802 
1803     if (CodeGenOpts.SpeculativeLoadHardening)
1804       FuncAttrs.addAttribute(llvm::Attribute::SpeculativeLoadHardening);
1805   }
1806 
1807   if (getLangOpts().assumeFunctionsAreConvergent()) {
1808     // Conservatively, mark all functions and calls in CUDA and OpenCL as
1809     // convergent (meaning, they may call an intrinsically convergent op, such
1810     // as __syncthreads() / barrier(), and so can't have certain optimizations
1811     // applied around them).  LLVM will remove this attribute where it safely
1812     // can.
1813     FuncAttrs.addAttribute(llvm::Attribute::Convergent);
1814   }
1815 
1816   if (getLangOpts().CUDA && getLangOpts().CUDAIsDevice) {
1817     // Exceptions aren't supported in CUDA device code.
1818     FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
1819   }
1820 
1821   for (StringRef Attr : CodeGenOpts.DefaultFunctionAttrs) {
1822     StringRef Var, Value;
1823     std::tie(Var, Value) = Attr.split('=');
1824     FuncAttrs.addAttribute(Var, Value);
1825   }
1826 }
1827 
1828 void CodeGenModule::AddDefaultFnAttrs(llvm::Function &F) {
1829   llvm::AttrBuilder FuncAttrs;
1830   ConstructDefaultFnAttrList(F.getName(), F.hasOptNone(),
1831                              /* AttrOnCallSite = */ false, FuncAttrs);
1832   F.addAttributes(llvm::AttributeList::FunctionIndex, FuncAttrs);
1833 }
1834 
1835 void CodeGenModule::ConstructAttributeList(
1836     StringRef Name, const CGFunctionInfo &FI, CGCalleeInfo CalleeInfo,
1837     llvm::AttributeList &AttrList, unsigned &CallingConv, bool AttrOnCallSite) {
1838   llvm::AttrBuilder FuncAttrs;
1839   llvm::AttrBuilder RetAttrs;
1840 
1841   CallingConv = FI.getEffectiveCallingConvention();
1842   if (FI.isNoReturn())
1843     FuncAttrs.addAttribute(llvm::Attribute::NoReturn);
1844 
1845   // If we have information about the function prototype, we can learn
1846   // attributes from there.
1847   AddAttributesFromFunctionProtoType(getContext(), FuncAttrs,
1848                                      CalleeInfo.getCalleeFunctionProtoType());
1849 
1850   const Decl *TargetDecl = CalleeInfo.getCalleeDecl().getDecl();
1851 
1852   bool HasOptnone = false;
1853   // FIXME: handle sseregparm someday...
1854   if (TargetDecl) {
1855     if (TargetDecl->hasAttr<ReturnsTwiceAttr>())
1856       FuncAttrs.addAttribute(llvm::Attribute::ReturnsTwice);
1857     if (TargetDecl->hasAttr<NoThrowAttr>())
1858       FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
1859     if (TargetDecl->hasAttr<NoReturnAttr>())
1860       FuncAttrs.addAttribute(llvm::Attribute::NoReturn);
1861     if (TargetDecl->hasAttr<ColdAttr>())
1862       FuncAttrs.addAttribute(llvm::Attribute::Cold);
1863     if (TargetDecl->hasAttr<NoDuplicateAttr>())
1864       FuncAttrs.addAttribute(llvm::Attribute::NoDuplicate);
1865     if (TargetDecl->hasAttr<ConvergentAttr>())
1866       FuncAttrs.addAttribute(llvm::Attribute::Convergent);
1867 
1868     if (const FunctionDecl *Fn = dyn_cast<FunctionDecl>(TargetDecl)) {
1869       AddAttributesFromFunctionProtoType(
1870           getContext(), FuncAttrs, Fn->getType()->getAs<FunctionProtoType>());
1871       const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(Fn);
1872       const bool IsVirtualCall = MD && MD->isVirtual();
1873       // Don't use [[noreturn]], _Noreturn or [[no_builtin]] for a call to a
1874       // virtual function. These attributes are not inherited by overloads.
1875       if (!(AttrOnCallSite && IsVirtualCall)) {
1876         if (Fn->isNoReturn())
1877           FuncAttrs.addAttribute(llvm::Attribute::NoReturn);
1878 
1879         const auto *NBA = Fn->getAttr<NoBuiltinAttr>();
1880         bool HasWildcard = NBA && llvm::is_contained(NBA->builtinNames(), "*");
1881         if (getLangOpts().NoBuiltin || HasWildcard)
1882           FuncAttrs.addAttribute("no-builtins");
1883         else {
1884           auto AddNoBuiltinAttr = [&FuncAttrs](StringRef BuiltinName) {
1885             SmallString<32> AttributeName;
1886             AttributeName += "no-builtin-";
1887             AttributeName += BuiltinName;
1888             FuncAttrs.addAttribute(AttributeName);
1889           };
1890           llvm::for_each(getLangOpts().NoBuiltinFuncs, AddNoBuiltinAttr);
1891           if (NBA)
1892             llvm::for_each(NBA->builtinNames(), AddNoBuiltinAttr);
1893         }
1894       }
1895     }
1896 
1897     // 'const', 'pure' and 'noalias' attributed functions are also nounwind.
1898     if (TargetDecl->hasAttr<ConstAttr>()) {
1899       FuncAttrs.addAttribute(llvm::Attribute::ReadNone);
1900       FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
1901     } else if (TargetDecl->hasAttr<PureAttr>()) {
1902       FuncAttrs.addAttribute(llvm::Attribute::ReadOnly);
1903       FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
1904     } else if (TargetDecl->hasAttr<NoAliasAttr>()) {
1905       FuncAttrs.addAttribute(llvm::Attribute::ArgMemOnly);
1906       FuncAttrs.addAttribute(llvm::Attribute::NoUnwind);
1907     }
1908     if (TargetDecl->hasAttr<RestrictAttr>())
1909       RetAttrs.addAttribute(llvm::Attribute::NoAlias);
1910     if (TargetDecl->hasAttr<ReturnsNonNullAttr>() &&
1911         !CodeGenOpts.NullPointerIsValid)
1912       RetAttrs.addAttribute(llvm::Attribute::NonNull);
1913     if (TargetDecl->hasAttr<AnyX86NoCallerSavedRegistersAttr>())
1914       FuncAttrs.addAttribute("no_caller_saved_registers");
1915     if (TargetDecl->hasAttr<AnyX86NoCfCheckAttr>())
1916       FuncAttrs.addAttribute(llvm::Attribute::NoCfCheck);
1917 
1918     HasOptnone = TargetDecl->hasAttr<OptimizeNoneAttr>();
1919     if (auto *AllocSize = TargetDecl->getAttr<AllocSizeAttr>()) {
1920       Optional<unsigned> NumElemsParam;
1921       if (AllocSize->getNumElemsParam().isValid())
1922         NumElemsParam = AllocSize->getNumElemsParam().getLLVMIndex();
1923       FuncAttrs.addAllocSizeAttr(AllocSize->getElemSizeParam().getLLVMIndex(),
1924                                  NumElemsParam);
1925     }
1926   }
1927 
1928   ConstructDefaultFnAttrList(Name, HasOptnone, AttrOnCallSite, FuncAttrs);
1929 
1930   // This must run after constructing the default function attribute list
1931   // to ensure that the speculative load hardening attribute is removed
1932   // in the case where the -mspeculative-load-hardening flag was passed.
1933   if (TargetDecl) {
1934     if (TargetDecl->hasAttr<NoSpeculativeLoadHardeningAttr>())
1935       FuncAttrs.removeAttribute(llvm::Attribute::SpeculativeLoadHardening);
1936     if (TargetDecl->hasAttr<SpeculativeLoadHardeningAttr>())
1937       FuncAttrs.addAttribute(llvm::Attribute::SpeculativeLoadHardening);
1938   }
1939 
1940   if (CodeGenOpts.EnableSegmentedStacks &&
1941       !(TargetDecl && TargetDecl->hasAttr<NoSplitStackAttr>()))
1942     FuncAttrs.addAttribute("split-stack");
1943 
1944   // Add NonLazyBind attribute to function declarations when -fno-plt
1945   // is used.
1946   if (TargetDecl && CodeGenOpts.NoPLT) {
1947     if (auto *Fn = dyn_cast<FunctionDecl>(TargetDecl)) {
1948       if (!Fn->isDefined() && !AttrOnCallSite) {
1949         FuncAttrs.addAttribute(llvm::Attribute::NonLazyBind);
1950       }
1951     }
1952   }
1953 
1954   if (TargetDecl && TargetDecl->hasAttr<OpenCLKernelAttr>()) {
1955     if (getLangOpts().OpenCLVersion <= 120) {
1956       // OpenCL v1.2 Work groups are always uniform
1957       FuncAttrs.addAttribute("uniform-work-group-size", "true");
1958     } else {
1959       // OpenCL v2.0 Work groups may be whether uniform or not.
1960       // '-cl-uniform-work-group-size' compile option gets a hint
1961       // to the compiler that the global work-size be a multiple of
1962       // the work-group size specified to clEnqueueNDRangeKernel
1963       // (i.e. work groups are uniform).
1964       FuncAttrs.addAttribute("uniform-work-group-size",
1965                              llvm::toStringRef(CodeGenOpts.UniformWGSize));
1966     }
1967   }
1968 
1969   if (!AttrOnCallSite) {
1970     bool DisableTailCalls = false;
1971 
1972     if (CodeGenOpts.DisableTailCalls)
1973       DisableTailCalls = true;
1974     else if (TargetDecl) {
1975       if (TargetDecl->hasAttr<DisableTailCallsAttr>() ||
1976           TargetDecl->hasAttr<AnyX86InterruptAttr>())
1977         DisableTailCalls = true;
1978       else if (CodeGenOpts.NoEscapingBlockTailCalls) {
1979         if (const auto *BD = dyn_cast<BlockDecl>(TargetDecl))
1980           if (!BD->doesNotEscape())
1981             DisableTailCalls = true;
1982       }
1983     }
1984 
1985     FuncAttrs.addAttribute("disable-tail-calls",
1986                            llvm::toStringRef(DisableTailCalls));
1987     GetCPUAndFeaturesAttributes(CalleeInfo.getCalleeDecl(), FuncAttrs);
1988   }
1989 
1990   ClangToLLVMArgMapping IRFunctionArgs(getContext(), FI);
1991 
1992   QualType RetTy = FI.getReturnType();
1993   const ABIArgInfo &RetAI = FI.getReturnInfo();
1994   switch (RetAI.getKind()) {
1995   case ABIArgInfo::Extend:
1996     if (RetAI.isSignExt())
1997       RetAttrs.addAttribute(llvm::Attribute::SExt);
1998     else
1999       RetAttrs.addAttribute(llvm::Attribute::ZExt);
2000     LLVM_FALLTHROUGH;
2001   case ABIArgInfo::Direct:
2002     if (RetAI.getInReg())
2003       RetAttrs.addAttribute(llvm::Attribute::InReg);
2004     break;
2005   case ABIArgInfo::Ignore:
2006     break;
2007 
2008   case ABIArgInfo::InAlloca:
2009   case ABIArgInfo::Indirect: {
2010     // inalloca and sret disable readnone and readonly
2011     FuncAttrs.removeAttribute(llvm::Attribute::ReadOnly)
2012       .removeAttribute(llvm::Attribute::ReadNone);
2013     break;
2014   }
2015 
2016   case ABIArgInfo::CoerceAndExpand:
2017     break;
2018 
2019   case ABIArgInfo::Expand:
2020     llvm_unreachable("Invalid ABI kind for return argument");
2021   }
2022 
2023   if (const auto *RefTy = RetTy->getAs<ReferenceType>()) {
2024     QualType PTy = RefTy->getPointeeType();
2025     if (!PTy->isIncompleteType() && PTy->isConstantSizeType())
2026       RetAttrs.addDereferenceableAttr(getContext().getTypeSizeInChars(PTy)
2027                                         .getQuantity());
2028     else if (getContext().getTargetAddressSpace(PTy) == 0 &&
2029              !CodeGenOpts.NullPointerIsValid)
2030       RetAttrs.addAttribute(llvm::Attribute::NonNull);
2031   }
2032 
2033   bool hasUsedSRet = false;
2034   SmallVector<llvm::AttributeSet, 4> ArgAttrs(IRFunctionArgs.totalIRArgs());
2035 
2036   // Attach attributes to sret.
2037   if (IRFunctionArgs.hasSRetArg()) {
2038     llvm::AttrBuilder SRETAttrs;
2039     SRETAttrs.addAttribute(llvm::Attribute::StructRet);
2040     hasUsedSRet = true;
2041     if (RetAI.getInReg())
2042       SRETAttrs.addAttribute(llvm::Attribute::InReg);
2043     ArgAttrs[IRFunctionArgs.getSRetArgNo()] =
2044         llvm::AttributeSet::get(getLLVMContext(), SRETAttrs);
2045   }
2046 
2047   // Attach attributes to inalloca argument.
2048   if (IRFunctionArgs.hasInallocaArg()) {
2049     llvm::AttrBuilder Attrs;
2050     Attrs.addAttribute(llvm::Attribute::InAlloca);
2051     ArgAttrs[IRFunctionArgs.getInallocaArgNo()] =
2052         llvm::AttributeSet::get(getLLVMContext(), Attrs);
2053   }
2054 
2055   unsigned ArgNo = 0;
2056   for (CGFunctionInfo::const_arg_iterator I = FI.arg_begin(),
2057                                           E = FI.arg_end();
2058        I != E; ++I, ++ArgNo) {
2059     QualType ParamType = I->type;
2060     const ABIArgInfo &AI = I->info;
2061     llvm::AttrBuilder Attrs;
2062 
2063     // Add attribute for padding argument, if necessary.
2064     if (IRFunctionArgs.hasPaddingArg(ArgNo)) {
2065       if (AI.getPaddingInReg()) {
2066         ArgAttrs[IRFunctionArgs.getPaddingArgNo(ArgNo)] =
2067             llvm::AttributeSet::get(
2068                 getLLVMContext(),
2069                 llvm::AttrBuilder().addAttribute(llvm::Attribute::InReg));
2070       }
2071     }
2072 
2073     // 'restrict' -> 'noalias' is done in EmitFunctionProlog when we
2074     // have the corresponding parameter variable.  It doesn't make
2075     // sense to do it here because parameters are so messed up.
2076     switch (AI.getKind()) {
2077     case ABIArgInfo::Extend:
2078       if (AI.isSignExt())
2079         Attrs.addAttribute(llvm::Attribute::SExt);
2080       else
2081         Attrs.addAttribute(llvm::Attribute::ZExt);
2082       LLVM_FALLTHROUGH;
2083     case ABIArgInfo::Direct:
2084       if (ArgNo == 0 && FI.isChainCall())
2085         Attrs.addAttribute(llvm::Attribute::Nest);
2086       else if (AI.getInReg())
2087         Attrs.addAttribute(llvm::Attribute::InReg);
2088       break;
2089 
2090     case ABIArgInfo::Indirect: {
2091       if (AI.getInReg())
2092         Attrs.addAttribute(llvm::Attribute::InReg);
2093 
2094       if (AI.getIndirectByVal())
2095         Attrs.addByValAttr(getTypes().ConvertTypeForMem(ParamType));
2096 
2097       CharUnits Align = AI.getIndirectAlign();
2098 
2099       // In a byval argument, it is important that the required
2100       // alignment of the type is honored, as LLVM might be creating a
2101       // *new* stack object, and needs to know what alignment to give
2102       // it. (Sometimes it can deduce a sensible alignment on its own,
2103       // but not if clang decides it must emit a packed struct, or the
2104       // user specifies increased alignment requirements.)
2105       //
2106       // This is different from indirect *not* byval, where the object
2107       // exists already, and the align attribute is purely
2108       // informative.
2109       assert(!Align.isZero());
2110 
2111       // For now, only add this when we have a byval argument.
2112       // TODO: be less lazy about updating test cases.
2113       if (AI.getIndirectByVal())
2114         Attrs.addAlignmentAttr(Align.getQuantity());
2115 
2116       // byval disables readnone and readonly.
2117       FuncAttrs.removeAttribute(llvm::Attribute::ReadOnly)
2118         .removeAttribute(llvm::Attribute::ReadNone);
2119       break;
2120     }
2121     case ABIArgInfo::Ignore:
2122     case ABIArgInfo::Expand:
2123     case ABIArgInfo::CoerceAndExpand:
2124       break;
2125 
2126     case ABIArgInfo::InAlloca:
2127       // inalloca disables readnone and readonly.
2128       FuncAttrs.removeAttribute(llvm::Attribute::ReadOnly)
2129           .removeAttribute(llvm::Attribute::ReadNone);
2130       continue;
2131     }
2132 
2133     if (const auto *RefTy = ParamType->getAs<ReferenceType>()) {
2134       QualType PTy = RefTy->getPointeeType();
2135       if (!PTy->isIncompleteType() && PTy->isConstantSizeType())
2136         Attrs.addDereferenceableAttr(getContext().getTypeSizeInChars(PTy)
2137                                        .getQuantity());
2138       else if (getContext().getTargetAddressSpace(PTy) == 0 &&
2139                !CodeGenOpts.NullPointerIsValid)
2140         Attrs.addAttribute(llvm::Attribute::NonNull);
2141     }
2142 
2143     switch (FI.getExtParameterInfo(ArgNo).getABI()) {
2144     case ParameterABI::Ordinary:
2145       break;
2146 
2147     case ParameterABI::SwiftIndirectResult: {
2148       // Add 'sret' if we haven't already used it for something, but
2149       // only if the result is void.
2150       if (!hasUsedSRet && RetTy->isVoidType()) {
2151         Attrs.addAttribute(llvm::Attribute::StructRet);
2152         hasUsedSRet = true;
2153       }
2154 
2155       // Add 'noalias' in either case.
2156       Attrs.addAttribute(llvm::Attribute::NoAlias);
2157 
2158       // Add 'dereferenceable' and 'alignment'.
2159       auto PTy = ParamType->getPointeeType();
2160       if (!PTy->isIncompleteType() && PTy->isConstantSizeType()) {
2161         auto info = getContext().getTypeInfoInChars(PTy);
2162         Attrs.addDereferenceableAttr(info.first.getQuantity());
2163         Attrs.addAttribute(llvm::Attribute::getWithAlignment(
2164             getLLVMContext(), info.second.getAsAlign()));
2165       }
2166       break;
2167     }
2168 
2169     case ParameterABI::SwiftErrorResult:
2170       Attrs.addAttribute(llvm::Attribute::SwiftError);
2171       break;
2172 
2173     case ParameterABI::SwiftContext:
2174       Attrs.addAttribute(llvm::Attribute::SwiftSelf);
2175       break;
2176     }
2177 
2178     if (FI.getExtParameterInfo(ArgNo).isNoEscape())
2179       Attrs.addAttribute(llvm::Attribute::NoCapture);
2180 
2181     if (Attrs.hasAttributes()) {
2182       unsigned FirstIRArg, NumIRArgs;
2183       std::tie(FirstIRArg, NumIRArgs) = IRFunctionArgs.getIRArgs(ArgNo);
2184       for (unsigned i = 0; i < NumIRArgs; i++)
2185         ArgAttrs[FirstIRArg + i] =
2186             llvm::AttributeSet::get(getLLVMContext(), Attrs);
2187     }
2188   }
2189   assert(ArgNo == FI.arg_size());
2190 
2191   AttrList = llvm::AttributeList::get(
2192       getLLVMContext(), llvm::AttributeSet::get(getLLVMContext(), FuncAttrs),
2193       llvm::AttributeSet::get(getLLVMContext(), RetAttrs), ArgAttrs);
2194 }
2195 
2196 /// An argument came in as a promoted argument; demote it back to its
2197 /// declared type.
2198 static llvm::Value *emitArgumentDemotion(CodeGenFunction &CGF,
2199                                          const VarDecl *var,
2200                                          llvm::Value *value) {
2201   llvm::Type *varType = CGF.ConvertType(var->getType());
2202 
2203   // This can happen with promotions that actually don't change the
2204   // underlying type, like the enum promotions.
2205   if (value->getType() == varType) return value;
2206 
2207   assert((varType->isIntegerTy() || varType->isFloatingPointTy())
2208          && "unexpected promotion type");
2209 
2210   if (isa<llvm::IntegerType>(varType))
2211     return CGF.Builder.CreateTrunc(value, varType, "arg.unpromote");
2212 
2213   return CGF.Builder.CreateFPCast(value, varType, "arg.unpromote");
2214 }
2215 
2216 /// Returns the attribute (either parameter attribute, or function
2217 /// attribute), which declares argument ArgNo to be non-null.
2218 static const NonNullAttr *getNonNullAttr(const Decl *FD, const ParmVarDecl *PVD,
2219                                          QualType ArgType, unsigned ArgNo) {
2220   // FIXME: __attribute__((nonnull)) can also be applied to:
2221   //   - references to pointers, where the pointee is known to be
2222   //     nonnull (apparently a Clang extension)
2223   //   - transparent unions containing pointers
2224   // In the former case, LLVM IR cannot represent the constraint. In
2225   // the latter case, we have no guarantee that the transparent union
2226   // is in fact passed as a pointer.
2227   if (!ArgType->isAnyPointerType() && !ArgType->isBlockPointerType())
2228     return nullptr;
2229   // First, check attribute on parameter itself.
2230   if (PVD) {
2231     if (auto ParmNNAttr = PVD->getAttr<NonNullAttr>())
2232       return ParmNNAttr;
2233   }
2234   // Check function attributes.
2235   if (!FD)
2236     return nullptr;
2237   for (const auto *NNAttr : FD->specific_attrs<NonNullAttr>()) {
2238     if (NNAttr->isNonNull(ArgNo))
2239       return NNAttr;
2240   }
2241   return nullptr;
2242 }
2243 
2244 namespace {
2245   struct CopyBackSwiftError final : EHScopeStack::Cleanup {
2246     Address Temp;
2247     Address Arg;
2248     CopyBackSwiftError(Address temp, Address arg) : Temp(temp), Arg(arg) {}
2249     void Emit(CodeGenFunction &CGF, Flags flags) override {
2250       llvm::Value *errorValue = CGF.Builder.CreateLoad(Temp);
2251       CGF.Builder.CreateStore(errorValue, Arg);
2252     }
2253   };
2254 }
2255 
2256 void CodeGenFunction::EmitFunctionProlog(const CGFunctionInfo &FI,
2257                                          llvm::Function *Fn,
2258                                          const FunctionArgList &Args) {
2259   if (CurCodeDecl && CurCodeDecl->hasAttr<NakedAttr>())
2260     // Naked functions don't have prologues.
2261     return;
2262 
2263   // If this is an implicit-return-zero function, go ahead and
2264   // initialize the return value.  TODO: it might be nice to have
2265   // a more general mechanism for this that didn't require synthesized
2266   // return statements.
2267   if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(CurCodeDecl)) {
2268     if (FD->hasImplicitReturnZero()) {
2269       QualType RetTy = FD->getReturnType().getUnqualifiedType();
2270       llvm::Type* LLVMTy = CGM.getTypes().ConvertType(RetTy);
2271       llvm::Constant* Zero = llvm::Constant::getNullValue(LLVMTy);
2272       Builder.CreateStore(Zero, ReturnValue);
2273     }
2274   }
2275 
2276   // FIXME: We no longer need the types from FunctionArgList; lift up and
2277   // simplify.
2278 
2279   ClangToLLVMArgMapping IRFunctionArgs(CGM.getContext(), FI);
2280   // Flattened function arguments.
2281   SmallVector<llvm::Value *, 16> FnArgs;
2282   FnArgs.reserve(IRFunctionArgs.totalIRArgs());
2283   for (auto &Arg : Fn->args()) {
2284     FnArgs.push_back(&Arg);
2285   }
2286   assert(FnArgs.size() == IRFunctionArgs.totalIRArgs());
2287 
2288   // If we're using inalloca, all the memory arguments are GEPs off of the last
2289   // parameter, which is a pointer to the complete memory area.
2290   Address ArgStruct = Address::invalid();
2291   if (IRFunctionArgs.hasInallocaArg()) {
2292     ArgStruct = Address(FnArgs[IRFunctionArgs.getInallocaArgNo()],
2293                         FI.getArgStructAlignment());
2294 
2295     assert(ArgStruct.getType() == FI.getArgStruct()->getPointerTo());
2296   }
2297 
2298   // Name the struct return parameter.
2299   if (IRFunctionArgs.hasSRetArg()) {
2300     auto AI = cast<llvm::Argument>(FnArgs[IRFunctionArgs.getSRetArgNo()]);
2301     AI->setName("agg.result");
2302     AI->addAttr(llvm::Attribute::NoAlias);
2303   }
2304 
2305   // Track if we received the parameter as a pointer (indirect, byval, or
2306   // inalloca).  If already have a pointer, EmitParmDecl doesn't need to copy it
2307   // into a local alloca for us.
2308   SmallVector<ParamValue, 16> ArgVals;
2309   ArgVals.reserve(Args.size());
2310 
2311   // Create a pointer value for every parameter declaration.  This usually
2312   // entails copying one or more LLVM IR arguments into an alloca.  Don't push
2313   // any cleanups or do anything that might unwind.  We do that separately, so
2314   // we can push the cleanups in the correct order for the ABI.
2315   assert(FI.arg_size() == Args.size() &&
2316          "Mismatch between function signature & arguments.");
2317   unsigned ArgNo = 0;
2318   CGFunctionInfo::const_arg_iterator info_it = FI.arg_begin();
2319   for (FunctionArgList::const_iterator i = Args.begin(), e = Args.end();
2320        i != e; ++i, ++info_it, ++ArgNo) {
2321     const VarDecl *Arg = *i;
2322     const ABIArgInfo &ArgI = info_it->info;
2323 
2324     bool isPromoted =
2325       isa<ParmVarDecl>(Arg) && cast<ParmVarDecl>(Arg)->isKNRPromoted();
2326     // We are converting from ABIArgInfo type to VarDecl type directly, unless
2327     // the parameter is promoted. In this case we convert to
2328     // CGFunctionInfo::ArgInfo type with subsequent argument demotion.
2329     QualType Ty = isPromoted ? info_it->type : Arg->getType();
2330     assert(hasScalarEvaluationKind(Ty) ==
2331            hasScalarEvaluationKind(Arg->getType()));
2332 
2333     unsigned FirstIRArg, NumIRArgs;
2334     std::tie(FirstIRArg, NumIRArgs) = IRFunctionArgs.getIRArgs(ArgNo);
2335 
2336     switch (ArgI.getKind()) {
2337     case ABIArgInfo::InAlloca: {
2338       assert(NumIRArgs == 0);
2339       auto FieldIndex = ArgI.getInAllocaFieldIndex();
2340       Address V =
2341           Builder.CreateStructGEP(ArgStruct, FieldIndex, Arg->getName());
2342       if (ArgI.getInAllocaIndirect())
2343         V = Address(Builder.CreateLoad(V),
2344                     getContext().getTypeAlignInChars(Ty));
2345       ArgVals.push_back(ParamValue::forIndirect(V));
2346       break;
2347     }
2348 
2349     case ABIArgInfo::Indirect: {
2350       assert(NumIRArgs == 1);
2351       Address ParamAddr = Address(FnArgs[FirstIRArg], ArgI.getIndirectAlign());
2352 
2353       if (!hasScalarEvaluationKind(Ty)) {
2354         // Aggregates and complex variables are accessed by reference.  All we
2355         // need to do is realign the value, if requested.
2356         Address V = ParamAddr;
2357         if (ArgI.getIndirectRealign()) {
2358           Address AlignedTemp = CreateMemTemp(Ty, "coerce");
2359 
2360           // Copy from the incoming argument pointer to the temporary with the
2361           // appropriate alignment.
2362           //
2363           // FIXME: We should have a common utility for generating an aggregate
2364           // copy.
2365           CharUnits Size = getContext().getTypeSizeInChars(Ty);
2366           auto SizeVal = llvm::ConstantInt::get(IntPtrTy, Size.getQuantity());
2367           Address Dst = Builder.CreateBitCast(AlignedTemp, Int8PtrTy);
2368           Address Src = Builder.CreateBitCast(ParamAddr, Int8PtrTy);
2369           Builder.CreateMemCpy(Dst, Src, SizeVal, false);
2370           V = AlignedTemp;
2371         }
2372         ArgVals.push_back(ParamValue::forIndirect(V));
2373       } else {
2374         // Load scalar value from indirect argument.
2375         llvm::Value *V =
2376             EmitLoadOfScalar(ParamAddr, false, Ty, Arg->getBeginLoc());
2377 
2378         if (isPromoted)
2379           V = emitArgumentDemotion(*this, Arg, V);
2380         ArgVals.push_back(ParamValue::forDirect(V));
2381       }
2382       break;
2383     }
2384 
2385     case ABIArgInfo::Extend:
2386     case ABIArgInfo::Direct: {
2387 
2388       // If we have the trivial case, handle it with no muss and fuss.
2389       if (!isa<llvm::StructType>(ArgI.getCoerceToType()) &&
2390           ArgI.getCoerceToType() == ConvertType(Ty) &&
2391           ArgI.getDirectOffset() == 0) {
2392         assert(NumIRArgs == 1);
2393         llvm::Value *V = FnArgs[FirstIRArg];
2394         auto AI = cast<llvm::Argument>(V);
2395 
2396         if (const ParmVarDecl *PVD = dyn_cast<ParmVarDecl>(Arg)) {
2397           if (getNonNullAttr(CurCodeDecl, PVD, PVD->getType(),
2398                              PVD->getFunctionScopeIndex()) &&
2399               !CGM.getCodeGenOpts().NullPointerIsValid)
2400             AI->addAttr(llvm::Attribute::NonNull);
2401 
2402           QualType OTy = PVD->getOriginalType();
2403           if (const auto *ArrTy =
2404               getContext().getAsConstantArrayType(OTy)) {
2405             // A C99 array parameter declaration with the static keyword also
2406             // indicates dereferenceability, and if the size is constant we can
2407             // use the dereferenceable attribute (which requires the size in
2408             // bytes).
2409             if (ArrTy->getSizeModifier() == ArrayType::Static) {
2410               QualType ETy = ArrTy->getElementType();
2411               uint64_t ArrSize = ArrTy->getSize().getZExtValue();
2412               if (!ETy->isIncompleteType() && ETy->isConstantSizeType() &&
2413                   ArrSize) {
2414                 llvm::AttrBuilder Attrs;
2415                 Attrs.addDereferenceableAttr(
2416                   getContext().getTypeSizeInChars(ETy).getQuantity()*ArrSize);
2417                 AI->addAttrs(Attrs);
2418               } else if (getContext().getTargetAddressSpace(ETy) == 0 &&
2419                          !CGM.getCodeGenOpts().NullPointerIsValid) {
2420                 AI->addAttr(llvm::Attribute::NonNull);
2421               }
2422             }
2423           } else if (const auto *ArrTy =
2424                      getContext().getAsVariableArrayType(OTy)) {
2425             // For C99 VLAs with the static keyword, we don't know the size so
2426             // we can't use the dereferenceable attribute, but in addrspace(0)
2427             // we know that it must be nonnull.
2428             if (ArrTy->getSizeModifier() == VariableArrayType::Static &&
2429                 !getContext().getTargetAddressSpace(ArrTy->getElementType()) &&
2430                 !CGM.getCodeGenOpts().NullPointerIsValid)
2431               AI->addAttr(llvm::Attribute::NonNull);
2432           }
2433 
2434           const auto *AVAttr = PVD->getAttr<AlignValueAttr>();
2435           if (!AVAttr)
2436             if (const auto *TOTy = dyn_cast<TypedefType>(OTy))
2437               AVAttr = TOTy->getDecl()->getAttr<AlignValueAttr>();
2438           if (AVAttr && !SanOpts.has(SanitizerKind::Alignment)) {
2439             // If alignment-assumption sanitizer is enabled, we do *not* add
2440             // alignment attribute here, but emit normal alignment assumption,
2441             // so the UBSAN check could function.
2442             llvm::Value *AlignmentValue =
2443               EmitScalarExpr(AVAttr->getAlignment());
2444             llvm::ConstantInt *AlignmentCI =
2445               cast<llvm::ConstantInt>(AlignmentValue);
2446             AI->addAttrs(llvm::AttrBuilder().addAlignmentAttr(llvm::MaybeAlign(
2447                 AlignmentCI->getLimitedValue(llvm::Value::MaximumAlignment))));
2448           }
2449         }
2450 
2451         if (Arg->getType().isRestrictQualified())
2452           AI->addAttr(llvm::Attribute::NoAlias);
2453 
2454         // LLVM expects swifterror parameters to be used in very restricted
2455         // ways.  Copy the value into a less-restricted temporary.
2456         if (FI.getExtParameterInfo(ArgNo).getABI()
2457               == ParameterABI::SwiftErrorResult) {
2458           QualType pointeeTy = Ty->getPointeeType();
2459           assert(pointeeTy->isPointerType());
2460           Address temp =
2461             CreateMemTemp(pointeeTy, getPointerAlign(), "swifterror.temp");
2462           Address arg = Address(V, getContext().getTypeAlignInChars(pointeeTy));
2463           llvm::Value *incomingErrorValue = Builder.CreateLoad(arg);
2464           Builder.CreateStore(incomingErrorValue, temp);
2465           V = temp.getPointer();
2466 
2467           // Push a cleanup to copy the value back at the end of the function.
2468           // The convention does not guarantee that the value will be written
2469           // back if the function exits with an unwind exception.
2470           EHStack.pushCleanup<CopyBackSwiftError>(NormalCleanup, temp, arg);
2471         }
2472 
2473         // Ensure the argument is the correct type.
2474         if (V->getType() != ArgI.getCoerceToType())
2475           V = Builder.CreateBitCast(V, ArgI.getCoerceToType());
2476 
2477         if (isPromoted)
2478           V = emitArgumentDemotion(*this, Arg, V);
2479 
2480         // Because of merging of function types from multiple decls it is
2481         // possible for the type of an argument to not match the corresponding
2482         // type in the function type. Since we are codegening the callee
2483         // in here, add a cast to the argument type.
2484         llvm::Type *LTy = ConvertType(Arg->getType());
2485         if (V->getType() != LTy)
2486           V = Builder.CreateBitCast(V, LTy);
2487 
2488         ArgVals.push_back(ParamValue::forDirect(V));
2489         break;
2490       }
2491 
2492       Address Alloca = CreateMemTemp(Ty, getContext().getDeclAlign(Arg),
2493                                      Arg->getName());
2494 
2495       // Pointer to store into.
2496       Address Ptr = emitAddressAtOffset(*this, Alloca, ArgI);
2497 
2498       // Fast-isel and the optimizer generally like scalar values better than
2499       // FCAs, so we flatten them if this is safe to do for this argument.
2500       llvm::StructType *STy = dyn_cast<llvm::StructType>(ArgI.getCoerceToType());
2501       if (ArgI.isDirect() && ArgI.getCanBeFlattened() && STy &&
2502           STy->getNumElements() > 1) {
2503         uint64_t SrcSize = CGM.getDataLayout().getTypeAllocSize(STy);
2504         llvm::Type *DstTy = Ptr.getElementType();
2505         uint64_t DstSize = CGM.getDataLayout().getTypeAllocSize(DstTy);
2506 
2507         Address AddrToStoreInto = Address::invalid();
2508         if (SrcSize <= DstSize) {
2509           AddrToStoreInto = Builder.CreateElementBitCast(Ptr, STy);
2510         } else {
2511           AddrToStoreInto =
2512             CreateTempAlloca(STy, Alloca.getAlignment(), "coerce");
2513         }
2514 
2515         assert(STy->getNumElements() == NumIRArgs);
2516         for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
2517           auto AI = FnArgs[FirstIRArg + i];
2518           AI->setName(Arg->getName() + ".coerce" + Twine(i));
2519           Address EltPtr = Builder.CreateStructGEP(AddrToStoreInto, i);
2520           Builder.CreateStore(AI, EltPtr);
2521         }
2522 
2523         if (SrcSize > DstSize) {
2524           Builder.CreateMemCpy(Ptr, AddrToStoreInto, DstSize);
2525         }
2526 
2527       } else {
2528         // Simple case, just do a coerced store of the argument into the alloca.
2529         assert(NumIRArgs == 1);
2530         auto AI = FnArgs[FirstIRArg];
2531         AI->setName(Arg->getName() + ".coerce");
2532         CreateCoercedStore(AI, Ptr, /*DstIsVolatile=*/false, *this);
2533       }
2534 
2535       // Match to what EmitParmDecl is expecting for this type.
2536       if (CodeGenFunction::hasScalarEvaluationKind(Ty)) {
2537         llvm::Value *V =
2538             EmitLoadOfScalar(Alloca, false, Ty, Arg->getBeginLoc());
2539         if (isPromoted)
2540           V = emitArgumentDemotion(*this, Arg, V);
2541         ArgVals.push_back(ParamValue::forDirect(V));
2542       } else {
2543         ArgVals.push_back(ParamValue::forIndirect(Alloca));
2544       }
2545       break;
2546     }
2547 
2548     case ABIArgInfo::CoerceAndExpand: {
2549       // Reconstruct into a temporary.
2550       Address alloca = CreateMemTemp(Ty, getContext().getDeclAlign(Arg));
2551       ArgVals.push_back(ParamValue::forIndirect(alloca));
2552 
2553       auto coercionType = ArgI.getCoerceAndExpandType();
2554       alloca = Builder.CreateElementBitCast(alloca, coercionType);
2555 
2556       unsigned argIndex = FirstIRArg;
2557       for (unsigned i = 0, e = coercionType->getNumElements(); i != e; ++i) {
2558         llvm::Type *eltType = coercionType->getElementType(i);
2559         if (ABIArgInfo::isPaddingForCoerceAndExpand(eltType))
2560           continue;
2561 
2562         auto eltAddr = Builder.CreateStructGEP(alloca, i);
2563         auto elt = FnArgs[argIndex++];
2564         Builder.CreateStore(elt, eltAddr);
2565       }
2566       assert(argIndex == FirstIRArg + NumIRArgs);
2567       break;
2568     }
2569 
2570     case ABIArgInfo::Expand: {
2571       // If this structure was expanded into multiple arguments then
2572       // we need to create a temporary and reconstruct it from the
2573       // arguments.
2574       Address Alloca = CreateMemTemp(Ty, getContext().getDeclAlign(Arg));
2575       LValue LV = MakeAddrLValue(Alloca, Ty);
2576       ArgVals.push_back(ParamValue::forIndirect(Alloca));
2577 
2578       auto FnArgIter = FnArgs.begin() + FirstIRArg;
2579       ExpandTypeFromArgs(Ty, LV, FnArgIter);
2580       assert(FnArgIter == FnArgs.begin() + FirstIRArg + NumIRArgs);
2581       for (unsigned i = 0, e = NumIRArgs; i != e; ++i) {
2582         auto AI = FnArgs[FirstIRArg + i];
2583         AI->setName(Arg->getName() + "." + Twine(i));
2584       }
2585       break;
2586     }
2587 
2588     case ABIArgInfo::Ignore:
2589       assert(NumIRArgs == 0);
2590       // Initialize the local variable appropriately.
2591       if (!hasScalarEvaluationKind(Ty)) {
2592         ArgVals.push_back(ParamValue::forIndirect(CreateMemTemp(Ty)));
2593       } else {
2594         llvm::Value *U = llvm::UndefValue::get(ConvertType(Arg->getType()));
2595         ArgVals.push_back(ParamValue::forDirect(U));
2596       }
2597       break;
2598     }
2599   }
2600 
2601   if (getTarget().getCXXABI().areArgsDestroyedLeftToRightInCallee()) {
2602     for (int I = Args.size() - 1; I >= 0; --I)
2603       EmitParmDecl(*Args[I], ArgVals[I], I + 1);
2604   } else {
2605     for (unsigned I = 0, E = Args.size(); I != E; ++I)
2606       EmitParmDecl(*Args[I], ArgVals[I], I + 1);
2607   }
2608 }
2609 
2610 static void eraseUnusedBitCasts(llvm::Instruction *insn) {
2611   while (insn->use_empty()) {
2612     llvm::BitCastInst *bitcast = dyn_cast<llvm::BitCastInst>(insn);
2613     if (!bitcast) return;
2614 
2615     // This is "safe" because we would have used a ConstantExpr otherwise.
2616     insn = cast<llvm::Instruction>(bitcast->getOperand(0));
2617     bitcast->eraseFromParent();
2618   }
2619 }
2620 
2621 /// Try to emit a fused autorelease of a return result.
2622 static llvm::Value *tryEmitFusedAutoreleaseOfResult(CodeGenFunction &CGF,
2623                                                     llvm::Value *result) {
2624   // We must be immediately followed the cast.
2625   llvm::BasicBlock *BB = CGF.Builder.GetInsertBlock();
2626   if (BB->empty()) return nullptr;
2627   if (&BB->back() != result) return nullptr;
2628 
2629   llvm::Type *resultType = result->getType();
2630 
2631   // result is in a BasicBlock and is therefore an Instruction.
2632   llvm::Instruction *generator = cast<llvm::Instruction>(result);
2633 
2634   SmallVector<llvm::Instruction *, 4> InstsToKill;
2635 
2636   // Look for:
2637   //  %generator = bitcast %type1* %generator2 to %type2*
2638   while (llvm::BitCastInst *bitcast = dyn_cast<llvm::BitCastInst>(generator)) {
2639     // We would have emitted this as a constant if the operand weren't
2640     // an Instruction.
2641     generator = cast<llvm::Instruction>(bitcast->getOperand(0));
2642 
2643     // Require the generator to be immediately followed by the cast.
2644     if (generator->getNextNode() != bitcast)
2645       return nullptr;
2646 
2647     InstsToKill.push_back(bitcast);
2648   }
2649 
2650   // Look for:
2651   //   %generator = call i8* @objc_retain(i8* %originalResult)
2652   // or
2653   //   %generator = call i8* @objc_retainAutoreleasedReturnValue(i8* %originalResult)
2654   llvm::CallInst *call = dyn_cast<llvm::CallInst>(generator);
2655   if (!call) return nullptr;
2656 
2657   bool doRetainAutorelease;
2658 
2659   if (call->getCalledValue() == CGF.CGM.getObjCEntrypoints().objc_retain) {
2660     doRetainAutorelease = true;
2661   } else if (call->getCalledValue() == CGF.CGM.getObjCEntrypoints()
2662                                           .objc_retainAutoreleasedReturnValue) {
2663     doRetainAutorelease = false;
2664 
2665     // If we emitted an assembly marker for this call (and the
2666     // ARCEntrypoints field should have been set if so), go looking
2667     // for that call.  If we can't find it, we can't do this
2668     // optimization.  But it should always be the immediately previous
2669     // instruction, unless we needed bitcasts around the call.
2670     if (CGF.CGM.getObjCEntrypoints().retainAutoreleasedReturnValueMarker) {
2671       llvm::Instruction *prev = call->getPrevNode();
2672       assert(prev);
2673       if (isa<llvm::BitCastInst>(prev)) {
2674         prev = prev->getPrevNode();
2675         assert(prev);
2676       }
2677       assert(isa<llvm::CallInst>(prev));
2678       assert(cast<llvm::CallInst>(prev)->getCalledValue() ==
2679                CGF.CGM.getObjCEntrypoints().retainAutoreleasedReturnValueMarker);
2680       InstsToKill.push_back(prev);
2681     }
2682   } else {
2683     return nullptr;
2684   }
2685 
2686   result = call->getArgOperand(0);
2687   InstsToKill.push_back(call);
2688 
2689   // Keep killing bitcasts, for sanity.  Note that we no longer care
2690   // about precise ordering as long as there's exactly one use.
2691   while (llvm::BitCastInst *bitcast = dyn_cast<llvm::BitCastInst>(result)) {
2692     if (!bitcast->hasOneUse()) break;
2693     InstsToKill.push_back(bitcast);
2694     result = bitcast->getOperand(0);
2695   }
2696 
2697   // Delete all the unnecessary instructions, from latest to earliest.
2698   for (auto *I : InstsToKill)
2699     I->eraseFromParent();
2700 
2701   // Do the fused retain/autorelease if we were asked to.
2702   if (doRetainAutorelease)
2703     result = CGF.EmitARCRetainAutoreleaseReturnValue(result);
2704 
2705   // Cast back to the result type.
2706   return CGF.Builder.CreateBitCast(result, resultType);
2707 }
2708 
2709 /// If this is a +1 of the value of an immutable 'self', remove it.
2710 static llvm::Value *tryRemoveRetainOfSelf(CodeGenFunction &CGF,
2711                                           llvm::Value *result) {
2712   // This is only applicable to a method with an immutable 'self'.
2713   const ObjCMethodDecl *method =
2714     dyn_cast_or_null<ObjCMethodDecl>(CGF.CurCodeDecl);
2715   if (!method) return nullptr;
2716   const VarDecl *self = method->getSelfDecl();
2717   if (!self->getType().isConstQualified()) return nullptr;
2718 
2719   // Look for a retain call.
2720   llvm::CallInst *retainCall =
2721     dyn_cast<llvm::CallInst>(result->stripPointerCasts());
2722   if (!retainCall ||
2723       retainCall->getCalledValue() != CGF.CGM.getObjCEntrypoints().objc_retain)
2724     return nullptr;
2725 
2726   // Look for an ordinary load of 'self'.
2727   llvm::Value *retainedValue = retainCall->getArgOperand(0);
2728   llvm::LoadInst *load =
2729     dyn_cast<llvm::LoadInst>(retainedValue->stripPointerCasts());
2730   if (!load || load->isAtomic() || load->isVolatile() ||
2731       load->getPointerOperand() != CGF.GetAddrOfLocalVar(self).getPointer())
2732     return nullptr;
2733 
2734   // Okay!  Burn it all down.  This relies for correctness on the
2735   // assumption that the retain is emitted as part of the return and
2736   // that thereafter everything is used "linearly".
2737   llvm::Type *resultType = result->getType();
2738   eraseUnusedBitCasts(cast<llvm::Instruction>(result));
2739   assert(retainCall->use_empty());
2740   retainCall->eraseFromParent();
2741   eraseUnusedBitCasts(cast<llvm::Instruction>(retainedValue));
2742 
2743   return CGF.Builder.CreateBitCast(load, resultType);
2744 }
2745 
2746 /// Emit an ARC autorelease of the result of a function.
2747 ///
2748 /// \return the value to actually return from the function
2749 static llvm::Value *emitAutoreleaseOfResult(CodeGenFunction &CGF,
2750                                             llvm::Value *result) {
2751   // If we're returning 'self', kill the initial retain.  This is a
2752   // heuristic attempt to "encourage correctness" in the really unfortunate
2753   // case where we have a return of self during a dealloc and we desperately
2754   // need to avoid the possible autorelease.
2755   if (llvm::Value *self = tryRemoveRetainOfSelf(CGF, result))
2756     return self;
2757 
2758   // At -O0, try to emit a fused retain/autorelease.
2759   if (CGF.shouldUseFusedARCCalls())
2760     if (llvm::Value *fused = tryEmitFusedAutoreleaseOfResult(CGF, result))
2761       return fused;
2762 
2763   return CGF.EmitARCAutoreleaseReturnValue(result);
2764 }
2765 
2766 /// Heuristically search for a dominating store to the return-value slot.
2767 static llvm::StoreInst *findDominatingStoreToReturnValue(CodeGenFunction &CGF) {
2768   // Check if a User is a store which pointerOperand is the ReturnValue.
2769   // We are looking for stores to the ReturnValue, not for stores of the
2770   // ReturnValue to some other location.
2771   auto GetStoreIfValid = [&CGF](llvm::User *U) -> llvm::StoreInst * {
2772     auto *SI = dyn_cast<llvm::StoreInst>(U);
2773     if (!SI || SI->getPointerOperand() != CGF.ReturnValue.getPointer())
2774       return nullptr;
2775     // These aren't actually possible for non-coerced returns, and we
2776     // only care about non-coerced returns on this code path.
2777     assert(!SI->isAtomic() && !SI->isVolatile());
2778     return SI;
2779   };
2780   // If there are multiple uses of the return-value slot, just check
2781   // for something immediately preceding the IP.  Sometimes this can
2782   // happen with how we generate implicit-returns; it can also happen
2783   // with noreturn cleanups.
2784   if (!CGF.ReturnValue.getPointer()->hasOneUse()) {
2785     llvm::BasicBlock *IP = CGF.Builder.GetInsertBlock();
2786     if (IP->empty()) return nullptr;
2787     llvm::Instruction *I = &IP->back();
2788 
2789     // Skip lifetime markers
2790     for (llvm::BasicBlock::reverse_iterator II = IP->rbegin(),
2791                                             IE = IP->rend();
2792          II != IE; ++II) {
2793       if (llvm::IntrinsicInst *Intrinsic =
2794               dyn_cast<llvm::IntrinsicInst>(&*II)) {
2795         if (Intrinsic->getIntrinsicID() == llvm::Intrinsic::lifetime_end) {
2796           const llvm::Value *CastAddr = Intrinsic->getArgOperand(1);
2797           ++II;
2798           if (II == IE)
2799             break;
2800           if (isa<llvm::BitCastInst>(&*II) && (CastAddr == &*II))
2801             continue;
2802         }
2803       }
2804       I = &*II;
2805       break;
2806     }
2807 
2808     return GetStoreIfValid(I);
2809   }
2810 
2811   llvm::StoreInst *store =
2812       GetStoreIfValid(CGF.ReturnValue.getPointer()->user_back());
2813   if (!store) return nullptr;
2814 
2815   // Now do a first-and-dirty dominance check: just walk up the
2816   // single-predecessors chain from the current insertion point.
2817   llvm::BasicBlock *StoreBB = store->getParent();
2818   llvm::BasicBlock *IP = CGF.Builder.GetInsertBlock();
2819   while (IP != StoreBB) {
2820     if (!(IP = IP->getSinglePredecessor()))
2821       return nullptr;
2822   }
2823 
2824   // Okay, the store's basic block dominates the insertion point; we
2825   // can do our thing.
2826   return store;
2827 }
2828 
2829 void CodeGenFunction::EmitFunctionEpilog(const CGFunctionInfo &FI,
2830                                          bool EmitRetDbgLoc,
2831                                          SourceLocation EndLoc) {
2832   if (FI.isNoReturn()) {
2833     // Noreturn functions don't return.
2834     EmitUnreachable(EndLoc);
2835     return;
2836   }
2837 
2838   if (CurCodeDecl && CurCodeDecl->hasAttr<NakedAttr>()) {
2839     // Naked functions don't have epilogues.
2840     Builder.CreateUnreachable();
2841     return;
2842   }
2843 
2844   // Functions with no result always return void.
2845   if (!ReturnValue.isValid()) {
2846     Builder.CreateRetVoid();
2847     return;
2848   }
2849 
2850   llvm::DebugLoc RetDbgLoc;
2851   llvm::Value *RV = nullptr;
2852   QualType RetTy = FI.getReturnType();
2853   const ABIArgInfo &RetAI = FI.getReturnInfo();
2854 
2855   switch (RetAI.getKind()) {
2856   case ABIArgInfo::InAlloca:
2857     // Aggregrates get evaluated directly into the destination.  Sometimes we
2858     // need to return the sret value in a register, though.
2859     assert(hasAggregateEvaluationKind(RetTy));
2860     if (RetAI.getInAllocaSRet()) {
2861       llvm::Function::arg_iterator EI = CurFn->arg_end();
2862       --EI;
2863       llvm::Value *ArgStruct = &*EI;
2864       llvm::Value *SRet = Builder.CreateStructGEP(
2865           nullptr, ArgStruct, RetAI.getInAllocaFieldIndex());
2866       RV = Builder.CreateAlignedLoad(SRet, getPointerAlign(), "sret");
2867     }
2868     break;
2869 
2870   case ABIArgInfo::Indirect: {
2871     auto AI = CurFn->arg_begin();
2872     if (RetAI.isSRetAfterThis())
2873       ++AI;
2874     switch (getEvaluationKind(RetTy)) {
2875     case TEK_Complex: {
2876       ComplexPairTy RT =
2877         EmitLoadOfComplex(MakeAddrLValue(ReturnValue, RetTy), EndLoc);
2878       EmitStoreOfComplex(RT, MakeNaturalAlignAddrLValue(&*AI, RetTy),
2879                          /*isInit*/ true);
2880       break;
2881     }
2882     case TEK_Aggregate:
2883       // Do nothing; aggregrates get evaluated directly into the destination.
2884       break;
2885     case TEK_Scalar:
2886       EmitStoreOfScalar(Builder.CreateLoad(ReturnValue),
2887                         MakeNaturalAlignAddrLValue(&*AI, RetTy),
2888                         /*isInit*/ true);
2889       break;
2890     }
2891     break;
2892   }
2893 
2894   case ABIArgInfo::Extend:
2895   case ABIArgInfo::Direct:
2896     if (RetAI.getCoerceToType() == ConvertType(RetTy) &&
2897         RetAI.getDirectOffset() == 0) {
2898       // The internal return value temp always will have pointer-to-return-type
2899       // type, just do a load.
2900 
2901       // If there is a dominating store to ReturnValue, we can elide
2902       // the load, zap the store, and usually zap the alloca.
2903       if (llvm::StoreInst *SI =
2904               findDominatingStoreToReturnValue(*this)) {
2905         // Reuse the debug location from the store unless there is
2906         // cleanup code to be emitted between the store and return
2907         // instruction.
2908         if (EmitRetDbgLoc && !AutoreleaseResult)
2909           RetDbgLoc = SI->getDebugLoc();
2910         // Get the stored value and nuke the now-dead store.
2911         RV = SI->getValueOperand();
2912         SI->eraseFromParent();
2913 
2914       // Otherwise, we have to do a simple load.
2915       } else {
2916         RV = Builder.CreateLoad(ReturnValue);
2917       }
2918     } else {
2919       // If the value is offset in memory, apply the offset now.
2920       Address V = emitAddressAtOffset(*this, ReturnValue, RetAI);
2921 
2922       RV = CreateCoercedLoad(V, RetAI.getCoerceToType(), *this);
2923     }
2924 
2925     // In ARC, end functions that return a retainable type with a call
2926     // to objc_autoreleaseReturnValue.
2927     if (AutoreleaseResult) {
2928 #ifndef NDEBUG
2929       // Type::isObjCRetainabletype has to be called on a QualType that hasn't
2930       // been stripped of the typedefs, so we cannot use RetTy here. Get the
2931       // original return type of FunctionDecl, CurCodeDecl, and BlockDecl from
2932       // CurCodeDecl or BlockInfo.
2933       QualType RT;
2934 
2935       if (auto *FD = dyn_cast<FunctionDecl>(CurCodeDecl))
2936         RT = FD->getReturnType();
2937       else if (auto *MD = dyn_cast<ObjCMethodDecl>(CurCodeDecl))
2938         RT = MD->getReturnType();
2939       else if (isa<BlockDecl>(CurCodeDecl))
2940         RT = BlockInfo->BlockExpression->getFunctionType()->getReturnType();
2941       else
2942         llvm_unreachable("Unexpected function/method type");
2943 
2944       assert(getLangOpts().ObjCAutoRefCount &&
2945              !FI.isReturnsRetained() &&
2946              RT->isObjCRetainableType());
2947 #endif
2948       RV = emitAutoreleaseOfResult(*this, RV);
2949     }
2950 
2951     break;
2952 
2953   case ABIArgInfo::Ignore:
2954     break;
2955 
2956   case ABIArgInfo::CoerceAndExpand: {
2957     auto coercionType = RetAI.getCoerceAndExpandType();
2958 
2959     // Load all of the coerced elements out into results.
2960     llvm::SmallVector<llvm::Value*, 4> results;
2961     Address addr = Builder.CreateElementBitCast(ReturnValue, coercionType);
2962     for (unsigned i = 0, e = coercionType->getNumElements(); i != e; ++i) {
2963       auto coercedEltType = coercionType->getElementType(i);
2964       if (ABIArgInfo::isPaddingForCoerceAndExpand(coercedEltType))
2965         continue;
2966 
2967       auto eltAddr = Builder.CreateStructGEP(addr, i);
2968       auto elt = Builder.CreateLoad(eltAddr);
2969       results.push_back(elt);
2970     }
2971 
2972     // If we have one result, it's the single direct result type.
2973     if (results.size() == 1) {
2974       RV = results[0];
2975 
2976     // Otherwise, we need to make a first-class aggregate.
2977     } else {
2978       // Construct a return type that lacks padding elements.
2979       llvm::Type *returnType = RetAI.getUnpaddedCoerceAndExpandType();
2980 
2981       RV = llvm::UndefValue::get(returnType);
2982       for (unsigned i = 0, e = results.size(); i != e; ++i) {
2983         RV = Builder.CreateInsertValue(RV, results[i], i);
2984       }
2985     }
2986     break;
2987   }
2988 
2989   case ABIArgInfo::Expand:
2990     llvm_unreachable("Invalid ABI kind for return argument");
2991   }
2992 
2993   llvm::Instruction *Ret;
2994   if (RV) {
2995     EmitReturnValueCheck(RV);
2996     Ret = Builder.CreateRet(RV);
2997   } else {
2998     Ret = Builder.CreateRetVoid();
2999   }
3000 
3001   if (RetDbgLoc)
3002     Ret->setDebugLoc(std::move(RetDbgLoc));
3003 }
3004 
3005 void CodeGenFunction::EmitReturnValueCheck(llvm::Value *RV) {
3006   // A current decl may not be available when emitting vtable thunks.
3007   if (!CurCodeDecl)
3008     return;
3009 
3010   ReturnsNonNullAttr *RetNNAttr = nullptr;
3011   if (SanOpts.has(SanitizerKind::ReturnsNonnullAttribute))
3012     RetNNAttr = CurCodeDecl->getAttr<ReturnsNonNullAttr>();
3013 
3014   if (!RetNNAttr && !requiresReturnValueNullabilityCheck())
3015     return;
3016 
3017   // Prefer the returns_nonnull attribute if it's present.
3018   SourceLocation AttrLoc;
3019   SanitizerMask CheckKind;
3020   SanitizerHandler Handler;
3021   if (RetNNAttr) {
3022     assert(!requiresReturnValueNullabilityCheck() &&
3023            "Cannot check nullability and the nonnull attribute");
3024     AttrLoc = RetNNAttr->getLocation();
3025     CheckKind = SanitizerKind::ReturnsNonnullAttribute;
3026     Handler = SanitizerHandler::NonnullReturn;
3027   } else {
3028     if (auto *DD = dyn_cast<DeclaratorDecl>(CurCodeDecl))
3029       if (auto *TSI = DD->getTypeSourceInfo())
3030         if (auto FTL = TSI->getTypeLoc().castAs<FunctionTypeLoc>())
3031           AttrLoc = FTL.getReturnLoc().findNullabilityLoc();
3032     CheckKind = SanitizerKind::NullabilityReturn;
3033     Handler = SanitizerHandler::NullabilityReturn;
3034   }
3035 
3036   SanitizerScope SanScope(this);
3037 
3038   // Make sure the "return" source location is valid. If we're checking a
3039   // nullability annotation, make sure the preconditions for the check are met.
3040   llvm::BasicBlock *Check = createBasicBlock("nullcheck");
3041   llvm::BasicBlock *NoCheck = createBasicBlock("no.nullcheck");
3042   llvm::Value *SLocPtr = Builder.CreateLoad(ReturnLocation, "return.sloc.load");
3043   llvm::Value *CanNullCheck = Builder.CreateIsNotNull(SLocPtr);
3044   if (requiresReturnValueNullabilityCheck())
3045     CanNullCheck =
3046         Builder.CreateAnd(CanNullCheck, RetValNullabilityPrecondition);
3047   Builder.CreateCondBr(CanNullCheck, Check, NoCheck);
3048   EmitBlock(Check);
3049 
3050   // Now do the null check.
3051   llvm::Value *Cond = Builder.CreateIsNotNull(RV);
3052   llvm::Constant *StaticData[] = {EmitCheckSourceLocation(AttrLoc)};
3053   llvm::Value *DynamicData[] = {SLocPtr};
3054   EmitCheck(std::make_pair(Cond, CheckKind), Handler, StaticData, DynamicData);
3055 
3056   EmitBlock(NoCheck);
3057 
3058 #ifndef NDEBUG
3059   // The return location should not be used after the check has been emitted.
3060   ReturnLocation = Address::invalid();
3061 #endif
3062 }
3063 
3064 static bool isInAllocaArgument(CGCXXABI &ABI, QualType type) {
3065   const CXXRecordDecl *RD = type->getAsCXXRecordDecl();
3066   return RD && ABI.getRecordArgABI(RD) == CGCXXABI::RAA_DirectInMemory;
3067 }
3068 
3069 static AggValueSlot createPlaceholderSlot(CodeGenFunction &CGF,
3070                                           QualType Ty) {
3071   // FIXME: Generate IR in one pass, rather than going back and fixing up these
3072   // placeholders.
3073   llvm::Type *IRTy = CGF.ConvertTypeForMem(Ty);
3074   llvm::Type *IRPtrTy = IRTy->getPointerTo();
3075   llvm::Value *Placeholder = llvm::UndefValue::get(IRPtrTy->getPointerTo());
3076 
3077   // FIXME: When we generate this IR in one pass, we shouldn't need
3078   // this win32-specific alignment hack.
3079   CharUnits Align = CharUnits::fromQuantity(4);
3080   Placeholder = CGF.Builder.CreateAlignedLoad(IRPtrTy, Placeholder, Align);
3081 
3082   return AggValueSlot::forAddr(Address(Placeholder, Align),
3083                                Ty.getQualifiers(),
3084                                AggValueSlot::IsNotDestructed,
3085                                AggValueSlot::DoesNotNeedGCBarriers,
3086                                AggValueSlot::IsNotAliased,
3087                                AggValueSlot::DoesNotOverlap);
3088 }
3089 
3090 void CodeGenFunction::EmitDelegateCallArg(CallArgList &args,
3091                                           const VarDecl *param,
3092                                           SourceLocation loc) {
3093   // StartFunction converted the ABI-lowered parameter(s) into a
3094   // local alloca.  We need to turn that into an r-value suitable
3095   // for EmitCall.
3096   Address local = GetAddrOfLocalVar(param);
3097 
3098   QualType type = param->getType();
3099 
3100   if (isInAllocaArgument(CGM.getCXXABI(), type)) {
3101     CGM.ErrorUnsupported(param, "forwarded non-trivially copyable parameter");
3102   }
3103 
3104   // GetAddrOfLocalVar returns a pointer-to-pointer for references,
3105   // but the argument needs to be the original pointer.
3106   if (type->isReferenceType()) {
3107     args.add(RValue::get(Builder.CreateLoad(local)), type);
3108 
3109   // In ARC, move out of consumed arguments so that the release cleanup
3110   // entered by StartFunction doesn't cause an over-release.  This isn't
3111   // optimal -O0 code generation, but it should get cleaned up when
3112   // optimization is enabled.  This also assumes that delegate calls are
3113   // performed exactly once for a set of arguments, but that should be safe.
3114   } else if (getLangOpts().ObjCAutoRefCount &&
3115              param->hasAttr<NSConsumedAttr>() &&
3116              type->isObjCRetainableType()) {
3117     llvm::Value *ptr = Builder.CreateLoad(local);
3118     auto null =
3119       llvm::ConstantPointerNull::get(cast<llvm::PointerType>(ptr->getType()));
3120     Builder.CreateStore(null, local);
3121     args.add(RValue::get(ptr), type);
3122 
3123   // For the most part, we just need to load the alloca, except that
3124   // aggregate r-values are actually pointers to temporaries.
3125   } else {
3126     args.add(convertTempToRValue(local, type, loc), type);
3127   }
3128 
3129   // Deactivate the cleanup for the callee-destructed param that was pushed.
3130   if (hasAggregateEvaluationKind(type) && !CurFuncIsThunk &&
3131       type->castAs<RecordType>()->getDecl()->isParamDestroyedInCallee() &&
3132       param->needsDestruction(getContext())) {
3133     EHScopeStack::stable_iterator cleanup =
3134         CalleeDestructedParamCleanups.lookup(cast<ParmVarDecl>(param));
3135     assert(cleanup.isValid() &&
3136            "cleanup for callee-destructed param not recorded");
3137     // This unreachable is a temporary marker which will be removed later.
3138     llvm::Instruction *isActive = Builder.CreateUnreachable();
3139     args.addArgCleanupDeactivation(cleanup, isActive);
3140   }
3141 }
3142 
3143 static bool isProvablyNull(llvm::Value *addr) {
3144   return isa<llvm::ConstantPointerNull>(addr);
3145 }
3146 
3147 /// Emit the actual writing-back of a writeback.
3148 static void emitWriteback(CodeGenFunction &CGF,
3149                           const CallArgList::Writeback &writeback) {
3150   const LValue &srcLV = writeback.Source;
3151   Address srcAddr = srcLV.getAddress(CGF);
3152   assert(!isProvablyNull(srcAddr.getPointer()) &&
3153          "shouldn't have writeback for provably null argument");
3154 
3155   llvm::BasicBlock *contBB = nullptr;
3156 
3157   // If the argument wasn't provably non-null, we need to null check
3158   // before doing the store.
3159   bool provablyNonNull = llvm::isKnownNonZero(srcAddr.getPointer(),
3160                                               CGF.CGM.getDataLayout());
3161   if (!provablyNonNull) {
3162     llvm::BasicBlock *writebackBB = CGF.createBasicBlock("icr.writeback");
3163     contBB = CGF.createBasicBlock("icr.done");
3164 
3165     llvm::Value *isNull =
3166       CGF.Builder.CreateIsNull(srcAddr.getPointer(), "icr.isnull");
3167     CGF.Builder.CreateCondBr(isNull, contBB, writebackBB);
3168     CGF.EmitBlock(writebackBB);
3169   }
3170 
3171   // Load the value to writeback.
3172   llvm::Value *value = CGF.Builder.CreateLoad(writeback.Temporary);
3173 
3174   // Cast it back, in case we're writing an id to a Foo* or something.
3175   value = CGF.Builder.CreateBitCast(value, srcAddr.getElementType(),
3176                                     "icr.writeback-cast");
3177 
3178   // Perform the writeback.
3179 
3180   // If we have a "to use" value, it's something we need to emit a use
3181   // of.  This has to be carefully threaded in: if it's done after the
3182   // release it's potentially undefined behavior (and the optimizer
3183   // will ignore it), and if it happens before the retain then the
3184   // optimizer could move the release there.
3185   if (writeback.ToUse) {
3186     assert(srcLV.getObjCLifetime() == Qualifiers::OCL_Strong);
3187 
3188     // Retain the new value.  No need to block-copy here:  the block's
3189     // being passed up the stack.
3190     value = CGF.EmitARCRetainNonBlock(value);
3191 
3192     // Emit the intrinsic use here.
3193     CGF.EmitARCIntrinsicUse(writeback.ToUse);
3194 
3195     // Load the old value (primitively).
3196     llvm::Value *oldValue = CGF.EmitLoadOfScalar(srcLV, SourceLocation());
3197 
3198     // Put the new value in place (primitively).
3199     CGF.EmitStoreOfScalar(value, srcLV, /*init*/ false);
3200 
3201     // Release the old value.
3202     CGF.EmitARCRelease(oldValue, srcLV.isARCPreciseLifetime());
3203 
3204   // Otherwise, we can just do a normal lvalue store.
3205   } else {
3206     CGF.EmitStoreThroughLValue(RValue::get(value), srcLV);
3207   }
3208 
3209   // Jump to the continuation block.
3210   if (!provablyNonNull)
3211     CGF.EmitBlock(contBB);
3212 }
3213 
3214 static void emitWritebacks(CodeGenFunction &CGF,
3215                            const CallArgList &args) {
3216   for (const auto &I : args.writebacks())
3217     emitWriteback(CGF, I);
3218 }
3219 
3220 static void deactivateArgCleanupsBeforeCall(CodeGenFunction &CGF,
3221                                             const CallArgList &CallArgs) {
3222   ArrayRef<CallArgList::CallArgCleanup> Cleanups =
3223     CallArgs.getCleanupsToDeactivate();
3224   // Iterate in reverse to increase the likelihood of popping the cleanup.
3225   for (const auto &I : llvm::reverse(Cleanups)) {
3226     CGF.DeactivateCleanupBlock(I.Cleanup, I.IsActiveIP);
3227     I.IsActiveIP->eraseFromParent();
3228   }
3229 }
3230 
3231 static const Expr *maybeGetUnaryAddrOfOperand(const Expr *E) {
3232   if (const UnaryOperator *uop = dyn_cast<UnaryOperator>(E->IgnoreParens()))
3233     if (uop->getOpcode() == UO_AddrOf)
3234       return uop->getSubExpr();
3235   return nullptr;
3236 }
3237 
3238 /// Emit an argument that's being passed call-by-writeback.  That is,
3239 /// we are passing the address of an __autoreleased temporary; it
3240 /// might be copy-initialized with the current value of the given
3241 /// address, but it will definitely be copied out of after the call.
3242 static void emitWritebackArg(CodeGenFunction &CGF, CallArgList &args,
3243                              const ObjCIndirectCopyRestoreExpr *CRE) {
3244   LValue srcLV;
3245 
3246   // Make an optimistic effort to emit the address as an l-value.
3247   // This can fail if the argument expression is more complicated.
3248   if (const Expr *lvExpr = maybeGetUnaryAddrOfOperand(CRE->getSubExpr())) {
3249     srcLV = CGF.EmitLValue(lvExpr);
3250 
3251   // Otherwise, just emit it as a scalar.
3252   } else {
3253     Address srcAddr = CGF.EmitPointerWithAlignment(CRE->getSubExpr());
3254 
3255     QualType srcAddrType =
3256       CRE->getSubExpr()->getType()->castAs<PointerType>()->getPointeeType();
3257     srcLV = CGF.MakeAddrLValue(srcAddr, srcAddrType);
3258   }
3259   Address srcAddr = srcLV.getAddress(CGF);
3260 
3261   // The dest and src types don't necessarily match in LLVM terms
3262   // because of the crazy ObjC compatibility rules.
3263 
3264   llvm::PointerType *destType =
3265     cast<llvm::PointerType>(CGF.ConvertType(CRE->getType()));
3266 
3267   // If the address is a constant null, just pass the appropriate null.
3268   if (isProvablyNull(srcAddr.getPointer())) {
3269     args.add(RValue::get(llvm::ConstantPointerNull::get(destType)),
3270              CRE->getType());
3271     return;
3272   }
3273 
3274   // Create the temporary.
3275   Address temp = CGF.CreateTempAlloca(destType->getElementType(),
3276                                       CGF.getPointerAlign(),
3277                                       "icr.temp");
3278   // Loading an l-value can introduce a cleanup if the l-value is __weak,
3279   // and that cleanup will be conditional if we can't prove that the l-value
3280   // isn't null, so we need to register a dominating point so that the cleanups
3281   // system will make valid IR.
3282   CodeGenFunction::ConditionalEvaluation condEval(CGF);
3283 
3284   // Zero-initialize it if we're not doing a copy-initialization.
3285   bool shouldCopy = CRE->shouldCopy();
3286   if (!shouldCopy) {
3287     llvm::Value *null =
3288       llvm::ConstantPointerNull::get(
3289         cast<llvm::PointerType>(destType->getElementType()));
3290     CGF.Builder.CreateStore(null, temp);
3291   }
3292 
3293   llvm::BasicBlock *contBB = nullptr;
3294   llvm::BasicBlock *originBB = nullptr;
3295 
3296   // If the address is *not* known to be non-null, we need to switch.
3297   llvm::Value *finalArgument;
3298 
3299   bool provablyNonNull = llvm::isKnownNonZero(srcAddr.getPointer(),
3300                                               CGF.CGM.getDataLayout());
3301   if (provablyNonNull) {
3302     finalArgument = temp.getPointer();
3303   } else {
3304     llvm::Value *isNull =
3305       CGF.Builder.CreateIsNull(srcAddr.getPointer(), "icr.isnull");
3306 
3307     finalArgument = CGF.Builder.CreateSelect(isNull,
3308                                    llvm::ConstantPointerNull::get(destType),
3309                                              temp.getPointer(), "icr.argument");
3310 
3311     // If we need to copy, then the load has to be conditional, which
3312     // means we need control flow.
3313     if (shouldCopy) {
3314       originBB = CGF.Builder.GetInsertBlock();
3315       contBB = CGF.createBasicBlock("icr.cont");
3316       llvm::BasicBlock *copyBB = CGF.createBasicBlock("icr.copy");
3317       CGF.Builder.CreateCondBr(isNull, contBB, copyBB);
3318       CGF.EmitBlock(copyBB);
3319       condEval.begin(CGF);
3320     }
3321   }
3322 
3323   llvm::Value *valueToUse = nullptr;
3324 
3325   // Perform a copy if necessary.
3326   if (shouldCopy) {
3327     RValue srcRV = CGF.EmitLoadOfLValue(srcLV, SourceLocation());
3328     assert(srcRV.isScalar());
3329 
3330     llvm::Value *src = srcRV.getScalarVal();
3331     src = CGF.Builder.CreateBitCast(src, destType->getElementType(),
3332                                     "icr.cast");
3333 
3334     // Use an ordinary store, not a store-to-lvalue.
3335     CGF.Builder.CreateStore(src, temp);
3336 
3337     // If optimization is enabled, and the value was held in a
3338     // __strong variable, we need to tell the optimizer that this
3339     // value has to stay alive until we're doing the store back.
3340     // This is because the temporary is effectively unretained,
3341     // and so otherwise we can violate the high-level semantics.
3342     if (CGF.CGM.getCodeGenOpts().OptimizationLevel != 0 &&
3343         srcLV.getObjCLifetime() == Qualifiers::OCL_Strong) {
3344       valueToUse = src;
3345     }
3346   }
3347 
3348   // Finish the control flow if we needed it.
3349   if (shouldCopy && !provablyNonNull) {
3350     llvm::BasicBlock *copyBB = CGF.Builder.GetInsertBlock();
3351     CGF.EmitBlock(contBB);
3352 
3353     // Make a phi for the value to intrinsically use.
3354     if (valueToUse) {
3355       llvm::PHINode *phiToUse = CGF.Builder.CreatePHI(valueToUse->getType(), 2,
3356                                                       "icr.to-use");
3357       phiToUse->addIncoming(valueToUse, copyBB);
3358       phiToUse->addIncoming(llvm::UndefValue::get(valueToUse->getType()),
3359                             originBB);
3360       valueToUse = phiToUse;
3361     }
3362 
3363     condEval.end(CGF);
3364   }
3365 
3366   args.addWriteback(srcLV, temp, valueToUse);
3367   args.add(RValue::get(finalArgument), CRE->getType());
3368 }
3369 
3370 void CallArgList::allocateArgumentMemory(CodeGenFunction &CGF) {
3371   assert(!StackBase);
3372 
3373   // Save the stack.
3374   llvm::Function *F = CGF.CGM.getIntrinsic(llvm::Intrinsic::stacksave);
3375   StackBase = CGF.Builder.CreateCall(F, {}, "inalloca.save");
3376 }
3377 
3378 void CallArgList::freeArgumentMemory(CodeGenFunction &CGF) const {
3379   if (StackBase) {
3380     // Restore the stack after the call.
3381     llvm::Function *F = CGF.CGM.getIntrinsic(llvm::Intrinsic::stackrestore);
3382     CGF.Builder.CreateCall(F, StackBase);
3383   }
3384 }
3385 
3386 void CodeGenFunction::EmitNonNullArgCheck(RValue RV, QualType ArgType,
3387                                           SourceLocation ArgLoc,
3388                                           AbstractCallee AC,
3389                                           unsigned ParmNum) {
3390   if (!AC.getDecl() || !(SanOpts.has(SanitizerKind::NonnullAttribute) ||
3391                          SanOpts.has(SanitizerKind::NullabilityArg)))
3392     return;
3393 
3394   // The param decl may be missing in a variadic function.
3395   auto PVD = ParmNum < AC.getNumParams() ? AC.getParamDecl(ParmNum) : nullptr;
3396   unsigned ArgNo = PVD ? PVD->getFunctionScopeIndex() : ParmNum;
3397 
3398   // Prefer the nonnull attribute if it's present.
3399   const NonNullAttr *NNAttr = nullptr;
3400   if (SanOpts.has(SanitizerKind::NonnullAttribute))
3401     NNAttr = getNonNullAttr(AC.getDecl(), PVD, ArgType, ArgNo);
3402 
3403   bool CanCheckNullability = false;
3404   if (SanOpts.has(SanitizerKind::NullabilityArg) && !NNAttr && PVD) {
3405     auto Nullability = PVD->getType()->getNullability(getContext());
3406     CanCheckNullability = Nullability &&
3407                           *Nullability == NullabilityKind::NonNull &&
3408                           PVD->getTypeSourceInfo();
3409   }
3410 
3411   if (!NNAttr && !CanCheckNullability)
3412     return;
3413 
3414   SourceLocation AttrLoc;
3415   SanitizerMask CheckKind;
3416   SanitizerHandler Handler;
3417   if (NNAttr) {
3418     AttrLoc = NNAttr->getLocation();
3419     CheckKind = SanitizerKind::NonnullAttribute;
3420     Handler = SanitizerHandler::NonnullArg;
3421   } else {
3422     AttrLoc = PVD->getTypeSourceInfo()->getTypeLoc().findNullabilityLoc();
3423     CheckKind = SanitizerKind::NullabilityArg;
3424     Handler = SanitizerHandler::NullabilityArg;
3425   }
3426 
3427   SanitizerScope SanScope(this);
3428   assert(RV.isScalar());
3429   llvm::Value *V = RV.getScalarVal();
3430   llvm::Value *Cond =
3431       Builder.CreateICmpNE(V, llvm::Constant::getNullValue(V->getType()));
3432   llvm::Constant *StaticData[] = {
3433       EmitCheckSourceLocation(ArgLoc), EmitCheckSourceLocation(AttrLoc),
3434       llvm::ConstantInt::get(Int32Ty, ArgNo + 1),
3435   };
3436   EmitCheck(std::make_pair(Cond, CheckKind), Handler, StaticData, None);
3437 }
3438 
3439 void CodeGenFunction::EmitCallArgs(
3440     CallArgList &Args, ArrayRef<QualType> ArgTypes,
3441     llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
3442     AbstractCallee AC, unsigned ParamsToSkip, EvaluationOrder Order) {
3443   assert((int)ArgTypes.size() == (ArgRange.end() - ArgRange.begin()));
3444 
3445   // We *have* to evaluate arguments from right to left in the MS C++ ABI,
3446   // because arguments are destroyed left to right in the callee. As a special
3447   // case, there are certain language constructs that require left-to-right
3448   // evaluation, and in those cases we consider the evaluation order requirement
3449   // to trump the "destruction order is reverse construction order" guarantee.
3450   bool LeftToRight =
3451       CGM.getTarget().getCXXABI().areArgsDestroyedLeftToRightInCallee()
3452           ? Order == EvaluationOrder::ForceLeftToRight
3453           : Order != EvaluationOrder::ForceRightToLeft;
3454 
3455   auto MaybeEmitImplicitObjectSize = [&](unsigned I, const Expr *Arg,
3456                                          RValue EmittedArg) {
3457     if (!AC.hasFunctionDecl() || I >= AC.getNumParams())
3458       return;
3459     auto *PS = AC.getParamDecl(I)->getAttr<PassObjectSizeAttr>();
3460     if (PS == nullptr)
3461       return;
3462 
3463     const auto &Context = getContext();
3464     auto SizeTy = Context.getSizeType();
3465     auto T = Builder.getIntNTy(Context.getTypeSize(SizeTy));
3466     assert(EmittedArg.getScalarVal() && "We emitted nothing for the arg?");
3467     llvm::Value *V = evaluateOrEmitBuiltinObjectSize(Arg, PS->getType(), T,
3468                                                      EmittedArg.getScalarVal(),
3469                                                      PS->isDynamic());
3470     Args.add(RValue::get(V), SizeTy);
3471     // If we're emitting args in reverse, be sure to do so with
3472     // pass_object_size, as well.
3473     if (!LeftToRight)
3474       std::swap(Args.back(), *(&Args.back() - 1));
3475   };
3476 
3477   // Insert a stack save if we're going to need any inalloca args.
3478   bool HasInAllocaArgs = false;
3479   if (CGM.getTarget().getCXXABI().isMicrosoft()) {
3480     for (ArrayRef<QualType>::iterator I = ArgTypes.begin(), E = ArgTypes.end();
3481          I != E && !HasInAllocaArgs; ++I)
3482       HasInAllocaArgs = isInAllocaArgument(CGM.getCXXABI(), *I);
3483     if (HasInAllocaArgs) {
3484       assert(getTarget().getTriple().getArch() == llvm::Triple::x86);
3485       Args.allocateArgumentMemory(*this);
3486     }
3487   }
3488 
3489   // Evaluate each argument in the appropriate order.
3490   size_t CallArgsStart = Args.size();
3491   for (unsigned I = 0, E = ArgTypes.size(); I != E; ++I) {
3492     unsigned Idx = LeftToRight ? I : E - I - 1;
3493     CallExpr::const_arg_iterator Arg = ArgRange.begin() + Idx;
3494     unsigned InitialArgSize = Args.size();
3495     // If *Arg is an ObjCIndirectCopyRestoreExpr, check that either the types of
3496     // the argument and parameter match or the objc method is parameterized.
3497     assert((!isa<ObjCIndirectCopyRestoreExpr>(*Arg) ||
3498             getContext().hasSameUnqualifiedType((*Arg)->getType(),
3499                                                 ArgTypes[Idx]) ||
3500             (isa<ObjCMethodDecl>(AC.getDecl()) &&
3501              isObjCMethodWithTypeParams(cast<ObjCMethodDecl>(AC.getDecl())))) &&
3502            "Argument and parameter types don't match");
3503     EmitCallArg(Args, *Arg, ArgTypes[Idx]);
3504     // In particular, we depend on it being the last arg in Args, and the
3505     // objectsize bits depend on there only being one arg if !LeftToRight.
3506     assert(InitialArgSize + 1 == Args.size() &&
3507            "The code below depends on only adding one arg per EmitCallArg");
3508     (void)InitialArgSize;
3509     // Since pointer argument are never emitted as LValue, it is safe to emit
3510     // non-null argument check for r-value only.
3511     if (!Args.back().hasLValue()) {
3512       RValue RVArg = Args.back().getKnownRValue();
3513       EmitNonNullArgCheck(RVArg, ArgTypes[Idx], (*Arg)->getExprLoc(), AC,
3514                           ParamsToSkip + Idx);
3515       // @llvm.objectsize should never have side-effects and shouldn't need
3516       // destruction/cleanups, so we can safely "emit" it after its arg,
3517       // regardless of right-to-leftness
3518       MaybeEmitImplicitObjectSize(Idx, *Arg, RVArg);
3519     }
3520   }
3521 
3522   if (!LeftToRight) {
3523     // Un-reverse the arguments we just evaluated so they match up with the LLVM
3524     // IR function.
3525     std::reverse(Args.begin() + CallArgsStart, Args.end());
3526   }
3527 }
3528 
3529 namespace {
3530 
3531 struct DestroyUnpassedArg final : EHScopeStack::Cleanup {
3532   DestroyUnpassedArg(Address Addr, QualType Ty)
3533       : Addr(Addr), Ty(Ty) {}
3534 
3535   Address Addr;
3536   QualType Ty;
3537 
3538   void Emit(CodeGenFunction &CGF, Flags flags) override {
3539     QualType::DestructionKind DtorKind = Ty.isDestructedType();
3540     if (DtorKind == QualType::DK_cxx_destructor) {
3541       const CXXDestructorDecl *Dtor = Ty->getAsCXXRecordDecl()->getDestructor();
3542       assert(!Dtor->isTrivial());
3543       CGF.EmitCXXDestructorCall(Dtor, Dtor_Complete, /*for vbase*/ false,
3544                                 /*Delegating=*/false, Addr, Ty);
3545     } else {
3546       CGF.callCStructDestructor(CGF.MakeAddrLValue(Addr, Ty));
3547     }
3548   }
3549 };
3550 
3551 struct DisableDebugLocationUpdates {
3552   CodeGenFunction &CGF;
3553   bool disabledDebugInfo;
3554   DisableDebugLocationUpdates(CodeGenFunction &CGF, const Expr *E) : CGF(CGF) {
3555     if ((disabledDebugInfo = isa<CXXDefaultArgExpr>(E) && CGF.getDebugInfo()))
3556       CGF.disableDebugInfo();
3557   }
3558   ~DisableDebugLocationUpdates() {
3559     if (disabledDebugInfo)
3560       CGF.enableDebugInfo();
3561   }
3562 };
3563 
3564 } // end anonymous namespace
3565 
3566 RValue CallArg::getRValue(CodeGenFunction &CGF) const {
3567   if (!HasLV)
3568     return RV;
3569   LValue Copy = CGF.MakeAddrLValue(CGF.CreateMemTemp(Ty), Ty);
3570   CGF.EmitAggregateCopy(Copy, LV, Ty, AggValueSlot::DoesNotOverlap,
3571                         LV.isVolatile());
3572   IsUsed = true;
3573   return RValue::getAggregate(Copy.getAddress(CGF));
3574 }
3575 
3576 void CallArg::copyInto(CodeGenFunction &CGF, Address Addr) const {
3577   LValue Dst = CGF.MakeAddrLValue(Addr, Ty);
3578   if (!HasLV && RV.isScalar())
3579     CGF.EmitStoreOfScalar(RV.getScalarVal(), Dst, /*isInit=*/true);
3580   else if (!HasLV && RV.isComplex())
3581     CGF.EmitStoreOfComplex(RV.getComplexVal(), Dst, /*init=*/true);
3582   else {
3583     auto Addr = HasLV ? LV.getAddress(CGF) : RV.getAggregateAddress();
3584     LValue SrcLV = CGF.MakeAddrLValue(Addr, Ty);
3585     // We assume that call args are never copied into subobjects.
3586     CGF.EmitAggregateCopy(Dst, SrcLV, Ty, AggValueSlot::DoesNotOverlap,
3587                           HasLV ? LV.isVolatileQualified()
3588                                 : RV.isVolatileQualified());
3589   }
3590   IsUsed = true;
3591 }
3592 
3593 void CodeGenFunction::EmitCallArg(CallArgList &args, const Expr *E,
3594                                   QualType type) {
3595   DisableDebugLocationUpdates Dis(*this, E);
3596   if (const ObjCIndirectCopyRestoreExpr *CRE
3597         = dyn_cast<ObjCIndirectCopyRestoreExpr>(E)) {
3598     assert(getLangOpts().ObjCAutoRefCount);
3599     return emitWritebackArg(*this, args, CRE);
3600   }
3601 
3602   assert(type->isReferenceType() == E->isGLValue() &&
3603          "reference binding to unmaterialized r-value!");
3604 
3605   if (E->isGLValue()) {
3606     assert(E->getObjectKind() == OK_Ordinary);
3607     return args.add(EmitReferenceBindingToExpr(E), type);
3608   }
3609 
3610   bool HasAggregateEvalKind = hasAggregateEvaluationKind(type);
3611 
3612   // In the Microsoft C++ ABI, aggregate arguments are destructed by the callee.
3613   // However, we still have to push an EH-only cleanup in case we unwind before
3614   // we make it to the call.
3615   if (HasAggregateEvalKind &&
3616       type->castAs<RecordType>()->getDecl()->isParamDestroyedInCallee()) {
3617     // If we're using inalloca, use the argument memory.  Otherwise, use a
3618     // temporary.
3619     AggValueSlot Slot;
3620     if (args.isUsingInAlloca())
3621       Slot = createPlaceholderSlot(*this, type);
3622     else
3623       Slot = CreateAggTemp(type, "agg.tmp");
3624 
3625     bool DestroyedInCallee = true, NeedsEHCleanup = true;
3626     if (const auto *RD = type->getAsCXXRecordDecl())
3627       DestroyedInCallee = RD->hasNonTrivialDestructor();
3628     else
3629       NeedsEHCleanup = needsEHCleanup(type.isDestructedType());
3630 
3631     if (DestroyedInCallee)
3632       Slot.setExternallyDestructed();
3633 
3634     EmitAggExpr(E, Slot);
3635     RValue RV = Slot.asRValue();
3636     args.add(RV, type);
3637 
3638     if (DestroyedInCallee && NeedsEHCleanup) {
3639       // Create a no-op GEP between the placeholder and the cleanup so we can
3640       // RAUW it successfully.  It also serves as a marker of the first
3641       // instruction where the cleanup is active.
3642       pushFullExprCleanup<DestroyUnpassedArg>(EHCleanup, Slot.getAddress(),
3643                                               type);
3644       // This unreachable is a temporary marker which will be removed later.
3645       llvm::Instruction *IsActive = Builder.CreateUnreachable();
3646       args.addArgCleanupDeactivation(EHStack.getInnermostEHScope(), IsActive);
3647     }
3648     return;
3649   }
3650 
3651   if (HasAggregateEvalKind && isa<ImplicitCastExpr>(E) &&
3652       cast<CastExpr>(E)->getCastKind() == CK_LValueToRValue) {
3653     LValue L = EmitLValue(cast<CastExpr>(E)->getSubExpr());
3654     assert(L.isSimple());
3655     args.addUncopiedAggregate(L, type);
3656     return;
3657   }
3658 
3659   args.add(EmitAnyExprToTemp(E), type);
3660 }
3661 
3662 QualType CodeGenFunction::getVarArgType(const Expr *Arg) {
3663   // System headers on Windows define NULL to 0 instead of 0LL on Win64. MSVC
3664   // implicitly widens null pointer constants that are arguments to varargs
3665   // functions to pointer-sized ints.
3666   if (!getTarget().getTriple().isOSWindows())
3667     return Arg->getType();
3668 
3669   if (Arg->getType()->isIntegerType() &&
3670       getContext().getTypeSize(Arg->getType()) <
3671           getContext().getTargetInfo().getPointerWidth(0) &&
3672       Arg->isNullPointerConstant(getContext(),
3673                                  Expr::NPC_ValueDependentIsNotNull)) {
3674     return getContext().getIntPtrType();
3675   }
3676 
3677   return Arg->getType();
3678 }
3679 
3680 // In ObjC ARC mode with no ObjC ARC exception safety, tell the ARC
3681 // optimizer it can aggressively ignore unwind edges.
3682 void
3683 CodeGenFunction::AddObjCARCExceptionMetadata(llvm::Instruction *Inst) {
3684   if (CGM.getCodeGenOpts().OptimizationLevel != 0 &&
3685       !CGM.getCodeGenOpts().ObjCAutoRefCountExceptions)
3686     Inst->setMetadata("clang.arc.no_objc_arc_exceptions",
3687                       CGM.getNoObjCARCExceptionsMetadata());
3688 }
3689 
3690 /// Emits a call to the given no-arguments nounwind runtime function.
3691 llvm::CallInst *
3692 CodeGenFunction::EmitNounwindRuntimeCall(llvm::FunctionCallee callee,
3693                                          const llvm::Twine &name) {
3694   return EmitNounwindRuntimeCall(callee, None, name);
3695 }
3696 
3697 /// Emits a call to the given nounwind runtime function.
3698 llvm::CallInst *
3699 CodeGenFunction::EmitNounwindRuntimeCall(llvm::FunctionCallee callee,
3700                                          ArrayRef<llvm::Value *> args,
3701                                          const llvm::Twine &name) {
3702   llvm::CallInst *call = EmitRuntimeCall(callee, args, name);
3703   call->setDoesNotThrow();
3704   return call;
3705 }
3706 
3707 /// Emits a simple call (never an invoke) to the given no-arguments
3708 /// runtime function.
3709 llvm::CallInst *CodeGenFunction::EmitRuntimeCall(llvm::FunctionCallee callee,
3710                                                  const llvm::Twine &name) {
3711   return EmitRuntimeCall(callee, None, name);
3712 }
3713 
3714 // Calls which may throw must have operand bundles indicating which funclet
3715 // they are nested within.
3716 SmallVector<llvm::OperandBundleDef, 1>
3717 CodeGenFunction::getBundlesForFunclet(llvm::Value *Callee) {
3718   SmallVector<llvm::OperandBundleDef, 1> BundleList;
3719   // There is no need for a funclet operand bundle if we aren't inside a
3720   // funclet.
3721   if (!CurrentFuncletPad)
3722     return BundleList;
3723 
3724   // Skip intrinsics which cannot throw.
3725   auto *CalleeFn = dyn_cast<llvm::Function>(Callee->stripPointerCasts());
3726   if (CalleeFn && CalleeFn->isIntrinsic() && CalleeFn->doesNotThrow())
3727     return BundleList;
3728 
3729   BundleList.emplace_back("funclet", CurrentFuncletPad);
3730   return BundleList;
3731 }
3732 
3733 /// Emits a simple call (never an invoke) to the given runtime function.
3734 llvm::CallInst *CodeGenFunction::EmitRuntimeCall(llvm::FunctionCallee callee,
3735                                                  ArrayRef<llvm::Value *> args,
3736                                                  const llvm::Twine &name) {
3737   llvm::CallInst *call = Builder.CreateCall(
3738       callee, args, getBundlesForFunclet(callee.getCallee()), name);
3739   call->setCallingConv(getRuntimeCC());
3740   return call;
3741 }
3742 
3743 /// Emits a call or invoke to the given noreturn runtime function.
3744 void CodeGenFunction::EmitNoreturnRuntimeCallOrInvoke(
3745     llvm::FunctionCallee callee, ArrayRef<llvm::Value *> args) {
3746   SmallVector<llvm::OperandBundleDef, 1> BundleList =
3747       getBundlesForFunclet(callee.getCallee());
3748 
3749   if (getInvokeDest()) {
3750     llvm::InvokeInst *invoke =
3751       Builder.CreateInvoke(callee,
3752                            getUnreachableBlock(),
3753                            getInvokeDest(),
3754                            args,
3755                            BundleList);
3756     invoke->setDoesNotReturn();
3757     invoke->setCallingConv(getRuntimeCC());
3758   } else {
3759     llvm::CallInst *call = Builder.CreateCall(callee, args, BundleList);
3760     call->setDoesNotReturn();
3761     call->setCallingConv(getRuntimeCC());
3762     Builder.CreateUnreachable();
3763   }
3764 }
3765 
3766 /// Emits a call or invoke instruction to the given nullary runtime function.
3767 llvm::CallBase *
3768 CodeGenFunction::EmitRuntimeCallOrInvoke(llvm::FunctionCallee callee,
3769                                          const Twine &name) {
3770   return EmitRuntimeCallOrInvoke(callee, None, name);
3771 }
3772 
3773 /// Emits a call or invoke instruction to the given runtime function.
3774 llvm::CallBase *
3775 CodeGenFunction::EmitRuntimeCallOrInvoke(llvm::FunctionCallee callee,
3776                                          ArrayRef<llvm::Value *> args,
3777                                          const Twine &name) {
3778   llvm::CallBase *call = EmitCallOrInvoke(callee, args, name);
3779   call->setCallingConv(getRuntimeCC());
3780   return call;
3781 }
3782 
3783 /// Emits a call or invoke instruction to the given function, depending
3784 /// on the current state of the EH stack.
3785 llvm::CallBase *CodeGenFunction::EmitCallOrInvoke(llvm::FunctionCallee Callee,
3786                                                   ArrayRef<llvm::Value *> Args,
3787                                                   const Twine &Name) {
3788   llvm::BasicBlock *InvokeDest = getInvokeDest();
3789   SmallVector<llvm::OperandBundleDef, 1> BundleList =
3790       getBundlesForFunclet(Callee.getCallee());
3791 
3792   llvm::CallBase *Inst;
3793   if (!InvokeDest)
3794     Inst = Builder.CreateCall(Callee, Args, BundleList, Name);
3795   else {
3796     llvm::BasicBlock *ContBB = createBasicBlock("invoke.cont");
3797     Inst = Builder.CreateInvoke(Callee, ContBB, InvokeDest, Args, BundleList,
3798                                 Name);
3799     EmitBlock(ContBB);
3800   }
3801 
3802   // In ObjC ARC mode with no ObjC ARC exception safety, tell the ARC
3803   // optimizer it can aggressively ignore unwind edges.
3804   if (CGM.getLangOpts().ObjCAutoRefCount)
3805     AddObjCARCExceptionMetadata(Inst);
3806 
3807   return Inst;
3808 }
3809 
3810 void CodeGenFunction::deferPlaceholderReplacement(llvm::Instruction *Old,
3811                                                   llvm::Value *New) {
3812   DeferredReplacements.push_back(std::make_pair(Old, New));
3813 }
3814 
3815 namespace {
3816 
3817 /// Specify given \p NewAlign as the alignment of return value attribute. If
3818 /// such attribute already exists, re-set it to the maximal one of two options.
3819 LLVM_NODISCARD llvm::AttributeList
3820 maybeRaiseRetAlignmentAttribute(llvm::LLVMContext &Ctx,
3821                                 const llvm::AttributeList &Attrs,
3822                                 llvm::Align NewAlign) {
3823   llvm::Align CurAlign = Attrs.getRetAlignment().valueOrOne();
3824   if (CurAlign >= NewAlign)
3825     return Attrs;
3826   llvm::Attribute AlignAttr = llvm::Attribute::getWithAlignment(Ctx, NewAlign);
3827   return Attrs
3828       .removeAttribute(Ctx, llvm::AttributeList::ReturnIndex,
3829                        llvm::Attribute::AttrKind::Alignment)
3830       .addAttribute(Ctx, llvm::AttributeList::ReturnIndex, AlignAttr);
3831 }
3832 
3833 template <typename AlignedAttrTy> class AbstractAssumeAlignedAttrEmitter {
3834 protected:
3835   CodeGenFunction &CGF;
3836 
3837   /// We do nothing if this is, or becomes, nullptr.
3838   const AlignedAttrTy *AA = nullptr;
3839 
3840   llvm::Value *Alignment = nullptr;      // May or may not be a constant.
3841   llvm::ConstantInt *OffsetCI = nullptr; // Constant, hopefully zero.
3842 
3843   AbstractAssumeAlignedAttrEmitter(CodeGenFunction &CGF_, const Decl *FuncDecl)
3844       : CGF(CGF_) {
3845     if (!FuncDecl)
3846       return;
3847     AA = FuncDecl->getAttr<AlignedAttrTy>();
3848   }
3849 
3850 public:
3851   /// If we can, materialize the alignment as an attribute on return value.
3852   LLVM_NODISCARD llvm::AttributeList
3853   TryEmitAsCallSiteAttribute(const llvm::AttributeList &Attrs) {
3854     if (!AA || OffsetCI || CGF.SanOpts.has(SanitizerKind::Alignment))
3855       return Attrs;
3856     const auto *AlignmentCI = dyn_cast<llvm::ConstantInt>(Alignment);
3857     if (!AlignmentCI)
3858       return Attrs;
3859     llvm::AttributeList NewAttrs = maybeRaiseRetAlignmentAttribute(
3860         CGF.getLLVMContext(), Attrs,
3861         llvm::Align(
3862             AlignmentCI->getLimitedValue(llvm::Value::MaximumAlignment)));
3863     AA = nullptr; // We're done. Disallow doing anything else.
3864     return NewAttrs;
3865   }
3866 
3867   /// Emit alignment assumption.
3868   /// This is a general fallback that we take if either there is an offset,
3869   /// or the alignment is variable or we are sanitizing for alignment.
3870   void EmitAsAnAssumption(SourceLocation Loc, QualType RetTy, RValue &Ret) {
3871     if (!AA)
3872       return;
3873     CGF.EmitAlignmentAssumption(Ret.getScalarVal(), RetTy, Loc,
3874                                 AA->getLocation(), Alignment, OffsetCI);
3875     AA = nullptr; // We're done. Disallow doing anything else.
3876   }
3877 };
3878 
3879 /// Helper data structure to emit `AssumeAlignedAttr`.
3880 class AssumeAlignedAttrEmitter final
3881     : public AbstractAssumeAlignedAttrEmitter<AssumeAlignedAttr> {
3882 public:
3883   AssumeAlignedAttrEmitter(CodeGenFunction &CGF_, const Decl *FuncDecl)
3884       : AbstractAssumeAlignedAttrEmitter(CGF_, FuncDecl) {
3885     if (!AA)
3886       return;
3887     // It is guaranteed that the alignment/offset are constants.
3888     Alignment = cast<llvm::ConstantInt>(CGF.EmitScalarExpr(AA->getAlignment()));
3889     if (Expr *Offset = AA->getOffset()) {
3890       OffsetCI = cast<llvm::ConstantInt>(CGF.EmitScalarExpr(Offset));
3891       if (OffsetCI->isNullValue()) // Canonicalize zero offset to no offset.
3892         OffsetCI = nullptr;
3893     }
3894   }
3895 };
3896 
3897 /// Helper data structure to emit `AllocAlignAttr`.
3898 class AllocAlignAttrEmitter final
3899     : public AbstractAssumeAlignedAttrEmitter<AllocAlignAttr> {
3900 public:
3901   AllocAlignAttrEmitter(CodeGenFunction &CGF_, const Decl *FuncDecl,
3902                         const CallArgList &CallArgs)
3903       : AbstractAssumeAlignedAttrEmitter(CGF_, FuncDecl) {
3904     if (!AA)
3905       return;
3906     // Alignment may or may not be a constant, and that is okay.
3907     Alignment = CallArgs[AA->getParamIndex().getLLVMIndex()]
3908                     .getRValue(CGF)
3909                     .getScalarVal();
3910   }
3911 };
3912 
3913 } // namespace
3914 
3915 RValue CodeGenFunction::EmitCall(const CGFunctionInfo &CallInfo,
3916                                  const CGCallee &Callee,
3917                                  ReturnValueSlot ReturnValue,
3918                                  const CallArgList &CallArgs,
3919                                  llvm::CallBase **callOrInvoke,
3920                                  SourceLocation Loc) {
3921   // FIXME: We no longer need the types from CallArgs; lift up and simplify.
3922 
3923   assert(Callee.isOrdinary() || Callee.isVirtual());
3924 
3925   // Handle struct-return functions by passing a pointer to the
3926   // location that we would like to return into.
3927   QualType RetTy = CallInfo.getReturnType();
3928   const ABIArgInfo &RetAI = CallInfo.getReturnInfo();
3929 
3930   llvm::FunctionType *IRFuncTy = getTypes().GetFunctionType(CallInfo);
3931 
3932   const Decl *TargetDecl = Callee.getAbstractInfo().getCalleeDecl().getDecl();
3933   if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(TargetDecl))
3934     // We can only guarantee that a function is called from the correct
3935     // context/function based on the appropriate target attributes,
3936     // so only check in the case where we have both always_inline and target
3937     // since otherwise we could be making a conditional call after a check for
3938     // the proper cpu features (and it won't cause code generation issues due to
3939     // function based code generation).
3940     if (TargetDecl->hasAttr<AlwaysInlineAttr>() &&
3941         TargetDecl->hasAttr<TargetAttr>())
3942       checkTargetFeatures(Loc, FD);
3943 
3944 #ifndef NDEBUG
3945   if (!(CallInfo.isVariadic() && CallInfo.getArgStruct())) {
3946     // For an inalloca varargs function, we don't expect CallInfo to match the
3947     // function pointer's type, because the inalloca struct a will have extra
3948     // fields in it for the varargs parameters.  Code later in this function
3949     // bitcasts the function pointer to the type derived from CallInfo.
3950     //
3951     // In other cases, we assert that the types match up (until pointers stop
3952     // having pointee types).
3953     llvm::Type *TypeFromVal;
3954     if (Callee.isVirtual())
3955       TypeFromVal = Callee.getVirtualFunctionType();
3956     else
3957       TypeFromVal =
3958           Callee.getFunctionPointer()->getType()->getPointerElementType();
3959     assert(IRFuncTy == TypeFromVal);
3960   }
3961 #endif
3962 
3963   // 1. Set up the arguments.
3964 
3965   // If we're using inalloca, insert the allocation after the stack save.
3966   // FIXME: Do this earlier rather than hacking it in here!
3967   Address ArgMemory = Address::invalid();
3968   if (llvm::StructType *ArgStruct = CallInfo.getArgStruct()) {
3969     const llvm::DataLayout &DL = CGM.getDataLayout();
3970     llvm::Instruction *IP = CallArgs.getStackBase();
3971     llvm::AllocaInst *AI;
3972     if (IP) {
3973       IP = IP->getNextNode();
3974       AI = new llvm::AllocaInst(ArgStruct, DL.getAllocaAddrSpace(),
3975                                 "argmem", IP);
3976     } else {
3977       AI = CreateTempAlloca(ArgStruct, "argmem");
3978     }
3979     auto Align = CallInfo.getArgStructAlignment();
3980     AI->setAlignment(Align.getAsAlign());
3981     AI->setUsedWithInAlloca(true);
3982     assert(AI->isUsedWithInAlloca() && !AI->isStaticAlloca());
3983     ArgMemory = Address(AI, Align);
3984   }
3985 
3986   ClangToLLVMArgMapping IRFunctionArgs(CGM.getContext(), CallInfo);
3987   SmallVector<llvm::Value *, 16> IRCallArgs(IRFunctionArgs.totalIRArgs());
3988 
3989   // If the call returns a temporary with struct return, create a temporary
3990   // alloca to hold the result, unless one is given to us.
3991   Address SRetPtr = Address::invalid();
3992   Address SRetAlloca = Address::invalid();
3993   llvm::Value *UnusedReturnSizePtr = nullptr;
3994   if (RetAI.isIndirect() || RetAI.isInAlloca() || RetAI.isCoerceAndExpand()) {
3995     if (!ReturnValue.isNull()) {
3996       SRetPtr = ReturnValue.getValue();
3997     } else {
3998       SRetPtr = CreateMemTemp(RetTy, "tmp", &SRetAlloca);
3999       if (HaveInsertPoint() && ReturnValue.isUnused()) {
4000         uint64_t size =
4001             CGM.getDataLayout().getTypeAllocSize(ConvertTypeForMem(RetTy));
4002         UnusedReturnSizePtr = EmitLifetimeStart(size, SRetAlloca.getPointer());
4003       }
4004     }
4005     if (IRFunctionArgs.hasSRetArg()) {
4006       IRCallArgs[IRFunctionArgs.getSRetArgNo()] = SRetPtr.getPointer();
4007     } else if (RetAI.isInAlloca()) {
4008       Address Addr =
4009           Builder.CreateStructGEP(ArgMemory, RetAI.getInAllocaFieldIndex());
4010       Builder.CreateStore(SRetPtr.getPointer(), Addr);
4011     }
4012   }
4013 
4014   Address swiftErrorTemp = Address::invalid();
4015   Address swiftErrorArg = Address::invalid();
4016 
4017   // When passing arguments using temporary allocas, we need to add the
4018   // appropriate lifetime markers. This vector keeps track of all the lifetime
4019   // markers that need to be ended right after the call.
4020   SmallVector<CallLifetimeEnd, 2> CallLifetimeEndAfterCall;
4021 
4022   // Translate all of the arguments as necessary to match the IR lowering.
4023   assert(CallInfo.arg_size() == CallArgs.size() &&
4024          "Mismatch between function signature & arguments.");
4025   unsigned ArgNo = 0;
4026   CGFunctionInfo::const_arg_iterator info_it = CallInfo.arg_begin();
4027   for (CallArgList::const_iterator I = CallArgs.begin(), E = CallArgs.end();
4028        I != E; ++I, ++info_it, ++ArgNo) {
4029     const ABIArgInfo &ArgInfo = info_it->info;
4030 
4031     // Insert a padding argument to ensure proper alignment.
4032     if (IRFunctionArgs.hasPaddingArg(ArgNo))
4033       IRCallArgs[IRFunctionArgs.getPaddingArgNo(ArgNo)] =
4034           llvm::UndefValue::get(ArgInfo.getPaddingType());
4035 
4036     unsigned FirstIRArg, NumIRArgs;
4037     std::tie(FirstIRArg, NumIRArgs) = IRFunctionArgs.getIRArgs(ArgNo);
4038 
4039     switch (ArgInfo.getKind()) {
4040     case ABIArgInfo::InAlloca: {
4041       assert(NumIRArgs == 0);
4042       assert(getTarget().getTriple().getArch() == llvm::Triple::x86);
4043       if (I->isAggregate()) {
4044         Address Addr = I->hasLValue()
4045                            ? I->getKnownLValue().getAddress(*this)
4046                            : I->getKnownRValue().getAggregateAddress();
4047         llvm::Instruction *Placeholder =
4048             cast<llvm::Instruction>(Addr.getPointer());
4049 
4050         if (!ArgInfo.getInAllocaIndirect()) {
4051           // Replace the placeholder with the appropriate argument slot GEP.
4052           CGBuilderTy::InsertPoint IP = Builder.saveIP();
4053           Builder.SetInsertPoint(Placeholder);
4054           Addr = Builder.CreateStructGEP(ArgMemory,
4055                                          ArgInfo.getInAllocaFieldIndex());
4056           Builder.restoreIP(IP);
4057         } else {
4058           // For indirect things such as overaligned structs, replace the
4059           // placeholder with a regular aggregate temporary alloca. Store the
4060           // address of this alloca into the struct.
4061           Addr = CreateMemTemp(info_it->type, "inalloca.indirect.tmp");
4062           Address ArgSlot = Builder.CreateStructGEP(
4063               ArgMemory, ArgInfo.getInAllocaFieldIndex());
4064           Builder.CreateStore(Addr.getPointer(), ArgSlot);
4065         }
4066         deferPlaceholderReplacement(Placeholder, Addr.getPointer());
4067       } else if (ArgInfo.getInAllocaIndirect()) {
4068         // Make a temporary alloca and store the address of it into the argument
4069         // struct.
4070         Address Addr = CreateMemTempWithoutCast(
4071             I->Ty, getContext().getTypeAlignInChars(I->Ty),
4072             "indirect-arg-temp");
4073         I->copyInto(*this, Addr);
4074         Address ArgSlot =
4075             Builder.CreateStructGEP(ArgMemory, ArgInfo.getInAllocaFieldIndex());
4076         Builder.CreateStore(Addr.getPointer(), ArgSlot);
4077       } else {
4078         // Store the RValue into the argument struct.
4079         Address Addr =
4080             Builder.CreateStructGEP(ArgMemory, ArgInfo.getInAllocaFieldIndex());
4081         unsigned AS = Addr.getType()->getPointerAddressSpace();
4082         llvm::Type *MemType = ConvertTypeForMem(I->Ty)->getPointerTo(AS);
4083         // There are some cases where a trivial bitcast is not avoidable.  The
4084         // definition of a type later in a translation unit may change it's type
4085         // from {}* to (%struct.foo*)*.
4086         if (Addr.getType() != MemType)
4087           Addr = Builder.CreateBitCast(Addr, MemType);
4088         I->copyInto(*this, Addr);
4089       }
4090       break;
4091     }
4092 
4093     case ABIArgInfo::Indirect: {
4094       assert(NumIRArgs == 1);
4095       if (!I->isAggregate()) {
4096         // Make a temporary alloca to pass the argument.
4097         Address Addr = CreateMemTempWithoutCast(
4098             I->Ty, ArgInfo.getIndirectAlign(), "indirect-arg-temp");
4099         IRCallArgs[FirstIRArg] = Addr.getPointer();
4100 
4101         I->copyInto(*this, Addr);
4102       } else {
4103         // We want to avoid creating an unnecessary temporary+copy here;
4104         // however, we need one in three cases:
4105         // 1. If the argument is not byval, and we are required to copy the
4106         //    source.  (This case doesn't occur on any common architecture.)
4107         // 2. If the argument is byval, RV is not sufficiently aligned, and
4108         //    we cannot force it to be sufficiently aligned.
4109         // 3. If the argument is byval, but RV is not located in default
4110         //    or alloca address space.
4111         Address Addr = I->hasLValue()
4112                            ? I->getKnownLValue().getAddress(*this)
4113                            : I->getKnownRValue().getAggregateAddress();
4114         llvm::Value *V = Addr.getPointer();
4115         CharUnits Align = ArgInfo.getIndirectAlign();
4116         const llvm::DataLayout *TD = &CGM.getDataLayout();
4117 
4118         assert((FirstIRArg >= IRFuncTy->getNumParams() ||
4119                 IRFuncTy->getParamType(FirstIRArg)->getPointerAddressSpace() ==
4120                     TD->getAllocaAddrSpace()) &&
4121                "indirect argument must be in alloca address space");
4122 
4123         bool NeedCopy = false;
4124 
4125         if (Addr.getAlignment() < Align &&
4126             llvm::getOrEnforceKnownAlignment(V, Align.getQuantity(), *TD) <
4127                 Align.getQuantity()) {
4128           NeedCopy = true;
4129         } else if (I->hasLValue()) {
4130           auto LV = I->getKnownLValue();
4131           auto AS = LV.getAddressSpace();
4132 
4133           if (!ArgInfo.getIndirectByVal() ||
4134               (LV.getAlignment() < getContext().getTypeAlignInChars(I->Ty))) {
4135             NeedCopy = true;
4136           }
4137           if (!getLangOpts().OpenCL) {
4138             if ((ArgInfo.getIndirectByVal() &&
4139                 (AS != LangAS::Default &&
4140                  AS != CGM.getASTAllocaAddressSpace()))) {
4141               NeedCopy = true;
4142             }
4143           }
4144           // For OpenCL even if RV is located in default or alloca address space
4145           // we don't want to perform address space cast for it.
4146           else if ((ArgInfo.getIndirectByVal() &&
4147                     Addr.getType()->getAddressSpace() != IRFuncTy->
4148                       getParamType(FirstIRArg)->getPointerAddressSpace())) {
4149             NeedCopy = true;
4150           }
4151         }
4152 
4153         if (NeedCopy) {
4154           // Create an aligned temporary, and copy to it.
4155           Address AI = CreateMemTempWithoutCast(
4156               I->Ty, ArgInfo.getIndirectAlign(), "byval-temp");
4157           IRCallArgs[FirstIRArg] = AI.getPointer();
4158 
4159           // Emit lifetime markers for the temporary alloca.
4160           uint64_t ByvalTempElementSize =
4161               CGM.getDataLayout().getTypeAllocSize(AI.getElementType());
4162           llvm::Value *LifetimeSize =
4163               EmitLifetimeStart(ByvalTempElementSize, AI.getPointer());
4164 
4165           // Add cleanup code to emit the end lifetime marker after the call.
4166           if (LifetimeSize) // In case we disabled lifetime markers.
4167             CallLifetimeEndAfterCall.emplace_back(AI, LifetimeSize);
4168 
4169           // Generate the copy.
4170           I->copyInto(*this, AI);
4171         } else {
4172           // Skip the extra memcpy call.
4173           auto *T = V->getType()->getPointerElementType()->getPointerTo(
4174               CGM.getDataLayout().getAllocaAddrSpace());
4175           IRCallArgs[FirstIRArg] = getTargetHooks().performAddrSpaceCast(
4176               *this, V, LangAS::Default, CGM.getASTAllocaAddressSpace(), T,
4177               true);
4178         }
4179       }
4180       break;
4181     }
4182 
4183     case ABIArgInfo::Ignore:
4184       assert(NumIRArgs == 0);
4185       break;
4186 
4187     case ABIArgInfo::Extend:
4188     case ABIArgInfo::Direct: {
4189       if (!isa<llvm::StructType>(ArgInfo.getCoerceToType()) &&
4190           ArgInfo.getCoerceToType() == ConvertType(info_it->type) &&
4191           ArgInfo.getDirectOffset() == 0) {
4192         assert(NumIRArgs == 1);
4193         llvm::Value *V;
4194         if (!I->isAggregate())
4195           V = I->getKnownRValue().getScalarVal();
4196         else
4197           V = Builder.CreateLoad(
4198               I->hasLValue() ? I->getKnownLValue().getAddress(*this)
4199                              : I->getKnownRValue().getAggregateAddress());
4200 
4201         // Implement swifterror by copying into a new swifterror argument.
4202         // We'll write back in the normal path out of the call.
4203         if (CallInfo.getExtParameterInfo(ArgNo).getABI()
4204               == ParameterABI::SwiftErrorResult) {
4205           assert(!swiftErrorTemp.isValid() && "multiple swifterror args");
4206 
4207           QualType pointeeTy = I->Ty->getPointeeType();
4208           swiftErrorArg =
4209             Address(V, getContext().getTypeAlignInChars(pointeeTy));
4210 
4211           swiftErrorTemp =
4212             CreateMemTemp(pointeeTy, getPointerAlign(), "swifterror.temp");
4213           V = swiftErrorTemp.getPointer();
4214           cast<llvm::AllocaInst>(V)->setSwiftError(true);
4215 
4216           llvm::Value *errorValue = Builder.CreateLoad(swiftErrorArg);
4217           Builder.CreateStore(errorValue, swiftErrorTemp);
4218         }
4219 
4220         // We might have to widen integers, but we should never truncate.
4221         if (ArgInfo.getCoerceToType() != V->getType() &&
4222             V->getType()->isIntegerTy())
4223           V = Builder.CreateZExt(V, ArgInfo.getCoerceToType());
4224 
4225         // If the argument doesn't match, perform a bitcast to coerce it.  This
4226         // can happen due to trivial type mismatches.
4227         if (FirstIRArg < IRFuncTy->getNumParams() &&
4228             V->getType() != IRFuncTy->getParamType(FirstIRArg))
4229           V = Builder.CreateBitCast(V, IRFuncTy->getParamType(FirstIRArg));
4230 
4231         IRCallArgs[FirstIRArg] = V;
4232         break;
4233       }
4234 
4235       // FIXME: Avoid the conversion through memory if possible.
4236       Address Src = Address::invalid();
4237       if (!I->isAggregate()) {
4238         Src = CreateMemTemp(I->Ty, "coerce");
4239         I->copyInto(*this, Src);
4240       } else {
4241         Src = I->hasLValue() ? I->getKnownLValue().getAddress(*this)
4242                              : I->getKnownRValue().getAggregateAddress();
4243       }
4244 
4245       // If the value is offset in memory, apply the offset now.
4246       Src = emitAddressAtOffset(*this, Src, ArgInfo);
4247 
4248       // Fast-isel and the optimizer generally like scalar values better than
4249       // FCAs, so we flatten them if this is safe to do for this argument.
4250       llvm::StructType *STy =
4251             dyn_cast<llvm::StructType>(ArgInfo.getCoerceToType());
4252       if (STy && ArgInfo.isDirect() && ArgInfo.getCanBeFlattened()) {
4253         llvm::Type *SrcTy = Src.getType()->getElementType();
4254         uint64_t SrcSize = CGM.getDataLayout().getTypeAllocSize(SrcTy);
4255         uint64_t DstSize = CGM.getDataLayout().getTypeAllocSize(STy);
4256 
4257         // If the source type is smaller than the destination type of the
4258         // coerce-to logic, copy the source value into a temp alloca the size
4259         // of the destination type to allow loading all of it. The bits past
4260         // the source value are left undef.
4261         if (SrcSize < DstSize) {
4262           Address TempAlloca
4263             = CreateTempAlloca(STy, Src.getAlignment(),
4264                                Src.getName() + ".coerce");
4265           Builder.CreateMemCpy(TempAlloca, Src, SrcSize);
4266           Src = TempAlloca;
4267         } else {
4268           Src = Builder.CreateBitCast(Src,
4269                                       STy->getPointerTo(Src.getAddressSpace()));
4270         }
4271 
4272         assert(NumIRArgs == STy->getNumElements());
4273         for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
4274           Address EltPtr = Builder.CreateStructGEP(Src, i);
4275           llvm::Value *LI = Builder.CreateLoad(EltPtr);
4276           IRCallArgs[FirstIRArg + i] = LI;
4277         }
4278       } else {
4279         // In the simple case, just pass the coerced loaded value.
4280         assert(NumIRArgs == 1);
4281         IRCallArgs[FirstIRArg] =
4282           CreateCoercedLoad(Src, ArgInfo.getCoerceToType(), *this);
4283       }
4284 
4285       break;
4286     }
4287 
4288     case ABIArgInfo::CoerceAndExpand: {
4289       auto coercionType = ArgInfo.getCoerceAndExpandType();
4290       auto layout = CGM.getDataLayout().getStructLayout(coercionType);
4291 
4292       llvm::Value *tempSize = nullptr;
4293       Address addr = Address::invalid();
4294       Address AllocaAddr = Address::invalid();
4295       if (I->isAggregate()) {
4296         addr = I->hasLValue() ? I->getKnownLValue().getAddress(*this)
4297                               : I->getKnownRValue().getAggregateAddress();
4298 
4299       } else {
4300         RValue RV = I->getKnownRValue();
4301         assert(RV.isScalar()); // complex should always just be direct
4302 
4303         llvm::Type *scalarType = RV.getScalarVal()->getType();
4304         auto scalarSize = CGM.getDataLayout().getTypeAllocSize(scalarType);
4305         auto scalarAlign = CGM.getDataLayout().getPrefTypeAlignment(scalarType);
4306 
4307         // Materialize to a temporary.
4308         addr = CreateTempAlloca(
4309             RV.getScalarVal()->getType(),
4310             CharUnits::fromQuantity(std::max(
4311                 (unsigned)layout->getAlignment().value(), scalarAlign)),
4312             "tmp",
4313             /*ArraySize=*/nullptr, &AllocaAddr);
4314         tempSize = EmitLifetimeStart(scalarSize, AllocaAddr.getPointer());
4315 
4316         Builder.CreateStore(RV.getScalarVal(), addr);
4317       }
4318 
4319       addr = Builder.CreateElementBitCast(addr, coercionType);
4320 
4321       unsigned IRArgPos = FirstIRArg;
4322       for (unsigned i = 0, e = coercionType->getNumElements(); i != e; ++i) {
4323         llvm::Type *eltType = coercionType->getElementType(i);
4324         if (ABIArgInfo::isPaddingForCoerceAndExpand(eltType)) continue;
4325         Address eltAddr = Builder.CreateStructGEP(addr, i);
4326         llvm::Value *elt = Builder.CreateLoad(eltAddr);
4327         IRCallArgs[IRArgPos++] = elt;
4328       }
4329       assert(IRArgPos == FirstIRArg + NumIRArgs);
4330 
4331       if (tempSize) {
4332         EmitLifetimeEnd(tempSize, AllocaAddr.getPointer());
4333       }
4334 
4335       break;
4336     }
4337 
4338     case ABIArgInfo::Expand:
4339       unsigned IRArgPos = FirstIRArg;
4340       ExpandTypeToArgs(I->Ty, *I, IRFuncTy, IRCallArgs, IRArgPos);
4341       assert(IRArgPos == FirstIRArg + NumIRArgs);
4342       break;
4343     }
4344   }
4345 
4346   const CGCallee &ConcreteCallee = Callee.prepareConcreteCallee(*this);
4347   llvm::Value *CalleePtr = ConcreteCallee.getFunctionPointer();
4348 
4349   // If we're using inalloca, set up that argument.
4350   if (ArgMemory.isValid()) {
4351     llvm::Value *Arg = ArgMemory.getPointer();
4352     if (CallInfo.isVariadic()) {
4353       // When passing non-POD arguments by value to variadic functions, we will
4354       // end up with a variadic prototype and an inalloca call site.  In such
4355       // cases, we can't do any parameter mismatch checks.  Give up and bitcast
4356       // the callee.
4357       unsigned CalleeAS = CalleePtr->getType()->getPointerAddressSpace();
4358       CalleePtr =
4359           Builder.CreateBitCast(CalleePtr, IRFuncTy->getPointerTo(CalleeAS));
4360     } else {
4361       llvm::Type *LastParamTy =
4362           IRFuncTy->getParamType(IRFuncTy->getNumParams() - 1);
4363       if (Arg->getType() != LastParamTy) {
4364 #ifndef NDEBUG
4365         // Assert that these structs have equivalent element types.
4366         llvm::StructType *FullTy = CallInfo.getArgStruct();
4367         llvm::StructType *DeclaredTy = cast<llvm::StructType>(
4368             cast<llvm::PointerType>(LastParamTy)->getElementType());
4369         assert(DeclaredTy->getNumElements() == FullTy->getNumElements());
4370         for (llvm::StructType::element_iterator DI = DeclaredTy->element_begin(),
4371                                                 DE = DeclaredTy->element_end(),
4372                                                 FI = FullTy->element_begin();
4373              DI != DE; ++DI, ++FI)
4374           assert(*DI == *FI);
4375 #endif
4376         Arg = Builder.CreateBitCast(Arg, LastParamTy);
4377       }
4378     }
4379     assert(IRFunctionArgs.hasInallocaArg());
4380     IRCallArgs[IRFunctionArgs.getInallocaArgNo()] = Arg;
4381   }
4382 
4383   // 2. Prepare the function pointer.
4384 
4385   // If the callee is a bitcast of a non-variadic function to have a
4386   // variadic function pointer type, check to see if we can remove the
4387   // bitcast.  This comes up with unprototyped functions.
4388   //
4389   // This makes the IR nicer, but more importantly it ensures that we
4390   // can inline the function at -O0 if it is marked always_inline.
4391   auto simplifyVariadicCallee = [](llvm::FunctionType *CalleeFT,
4392                                    llvm::Value *Ptr) -> llvm::Function * {
4393     if (!CalleeFT->isVarArg())
4394       return nullptr;
4395 
4396     // Get underlying value if it's a bitcast
4397     if (llvm::ConstantExpr *CE = dyn_cast<llvm::ConstantExpr>(Ptr)) {
4398       if (CE->getOpcode() == llvm::Instruction::BitCast)
4399         Ptr = CE->getOperand(0);
4400     }
4401 
4402     llvm::Function *OrigFn = dyn_cast<llvm::Function>(Ptr);
4403     if (!OrigFn)
4404       return nullptr;
4405 
4406     llvm::FunctionType *OrigFT = OrigFn->getFunctionType();
4407 
4408     // If the original type is variadic, or if any of the component types
4409     // disagree, we cannot remove the cast.
4410     if (OrigFT->isVarArg() ||
4411         OrigFT->getNumParams() != CalleeFT->getNumParams() ||
4412         OrigFT->getReturnType() != CalleeFT->getReturnType())
4413       return nullptr;
4414 
4415     for (unsigned i = 0, e = OrigFT->getNumParams(); i != e; ++i)
4416       if (OrigFT->getParamType(i) != CalleeFT->getParamType(i))
4417         return nullptr;
4418 
4419     return OrigFn;
4420   };
4421 
4422   if (llvm::Function *OrigFn = simplifyVariadicCallee(IRFuncTy, CalleePtr)) {
4423     CalleePtr = OrigFn;
4424     IRFuncTy = OrigFn->getFunctionType();
4425   }
4426 
4427   // 3. Perform the actual call.
4428 
4429   // Deactivate any cleanups that we're supposed to do immediately before
4430   // the call.
4431   if (!CallArgs.getCleanupsToDeactivate().empty())
4432     deactivateArgCleanupsBeforeCall(*this, CallArgs);
4433 
4434   // Assert that the arguments we computed match up.  The IR verifier
4435   // will catch this, but this is a common enough source of problems
4436   // during IRGen changes that it's way better for debugging to catch
4437   // it ourselves here.
4438 #ifndef NDEBUG
4439   assert(IRCallArgs.size() == IRFuncTy->getNumParams() || IRFuncTy->isVarArg());
4440   for (unsigned i = 0; i < IRCallArgs.size(); ++i) {
4441     // Inalloca argument can have different type.
4442     if (IRFunctionArgs.hasInallocaArg() &&
4443         i == IRFunctionArgs.getInallocaArgNo())
4444       continue;
4445     if (i < IRFuncTy->getNumParams())
4446       assert(IRCallArgs[i]->getType() == IRFuncTy->getParamType(i));
4447   }
4448 #endif
4449 
4450   // Update the largest vector width if any arguments have vector types.
4451   for (unsigned i = 0; i < IRCallArgs.size(); ++i) {
4452     if (auto *VT = dyn_cast<llvm::VectorType>(IRCallArgs[i]->getType()))
4453       LargestVectorWidth = std::max((uint64_t)LargestVectorWidth,
4454                                    VT->getPrimitiveSizeInBits().getFixedSize());
4455   }
4456 
4457   // Compute the calling convention and attributes.
4458   unsigned CallingConv;
4459   llvm::AttributeList Attrs;
4460   CGM.ConstructAttributeList(CalleePtr->getName(), CallInfo,
4461                              Callee.getAbstractInfo(), Attrs, CallingConv,
4462                              /*AttrOnCallSite=*/true);
4463 
4464   if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(CurFuncDecl))
4465     if (FD->usesFPIntrin())
4466       // All calls within a strictfp function are marked strictfp
4467       Attrs =
4468         Attrs.addAttribute(getLLVMContext(), llvm::AttributeList::FunctionIndex,
4469                            llvm::Attribute::StrictFP);
4470 
4471   // Apply some call-site-specific attributes.
4472   // TODO: work this into building the attribute set.
4473 
4474   // Apply always_inline to all calls within flatten functions.
4475   // FIXME: should this really take priority over __try, below?
4476   if (CurCodeDecl && CurCodeDecl->hasAttr<FlattenAttr>() &&
4477       !(TargetDecl && TargetDecl->hasAttr<NoInlineAttr>())) {
4478     Attrs =
4479         Attrs.addAttribute(getLLVMContext(), llvm::AttributeList::FunctionIndex,
4480                            llvm::Attribute::AlwaysInline);
4481   }
4482 
4483   // Disable inlining inside SEH __try blocks.
4484   if (isSEHTryScope()) {
4485     Attrs =
4486         Attrs.addAttribute(getLLVMContext(), llvm::AttributeList::FunctionIndex,
4487                            llvm::Attribute::NoInline);
4488   }
4489 
4490   // Decide whether to use a call or an invoke.
4491   bool CannotThrow;
4492   if (currentFunctionUsesSEHTry()) {
4493     // SEH cares about asynchronous exceptions, so everything can "throw."
4494     CannotThrow = false;
4495   } else if (isCleanupPadScope() &&
4496              EHPersonality::get(*this).isMSVCXXPersonality()) {
4497     // The MSVC++ personality will implicitly terminate the program if an
4498     // exception is thrown during a cleanup outside of a try/catch.
4499     // We don't need to model anything in IR to get this behavior.
4500     CannotThrow = true;
4501   } else {
4502     // Otherwise, nounwind call sites will never throw.
4503     CannotThrow = Attrs.hasAttribute(llvm::AttributeList::FunctionIndex,
4504                                      llvm::Attribute::NoUnwind);
4505   }
4506 
4507   // If we made a temporary, be sure to clean up after ourselves. Note that we
4508   // can't depend on being inside of an ExprWithCleanups, so we need to manually
4509   // pop this cleanup later on. Being eager about this is OK, since this
4510   // temporary is 'invisible' outside of the callee.
4511   if (UnusedReturnSizePtr)
4512     pushFullExprCleanup<CallLifetimeEnd>(NormalEHLifetimeMarker, SRetAlloca,
4513                                          UnusedReturnSizePtr);
4514 
4515   llvm::BasicBlock *InvokeDest = CannotThrow ? nullptr : getInvokeDest();
4516 
4517   SmallVector<llvm::OperandBundleDef, 1> BundleList =
4518       getBundlesForFunclet(CalleePtr);
4519 
4520   if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(CurFuncDecl))
4521     if (FD->usesFPIntrin())
4522       // All calls within a strictfp function are marked strictfp
4523       Attrs =
4524         Attrs.addAttribute(getLLVMContext(), llvm::AttributeList::FunctionIndex,
4525                            llvm::Attribute::StrictFP);
4526 
4527   AssumeAlignedAttrEmitter AssumeAlignedAttrEmitter(*this, TargetDecl);
4528   Attrs = AssumeAlignedAttrEmitter.TryEmitAsCallSiteAttribute(Attrs);
4529 
4530   AllocAlignAttrEmitter AllocAlignAttrEmitter(*this, TargetDecl, CallArgs);
4531   Attrs = AllocAlignAttrEmitter.TryEmitAsCallSiteAttribute(Attrs);
4532 
4533   // Emit the actual call/invoke instruction.
4534   llvm::CallBase *CI;
4535   if (!InvokeDest) {
4536     CI = Builder.CreateCall(IRFuncTy, CalleePtr, IRCallArgs, BundleList);
4537   } else {
4538     llvm::BasicBlock *Cont = createBasicBlock("invoke.cont");
4539     CI = Builder.CreateInvoke(IRFuncTy, CalleePtr, Cont, InvokeDest, IRCallArgs,
4540                               BundleList);
4541     EmitBlock(Cont);
4542   }
4543   if (callOrInvoke)
4544     *callOrInvoke = CI;
4545 
4546   // If this is within a function that has the guard(nocf) attribute and is an
4547   // indirect call, add the "guard_nocf" attribute to this call to indicate that
4548   // Control Flow Guard checks should not be added, even if the call is inlined.
4549   if (const auto *FD = dyn_cast_or_null<FunctionDecl>(CurFuncDecl)) {
4550     if (const auto *A = FD->getAttr<CFGuardAttr>()) {
4551       if (A->getGuard() == CFGuardAttr::GuardArg::nocf && !CI->getCalledFunction())
4552         Attrs = Attrs.addAttribute(
4553             getLLVMContext(), llvm::AttributeList::FunctionIndex, "guard_nocf");
4554     }
4555   }
4556 
4557   // Apply the attributes and calling convention.
4558   CI->setAttributes(Attrs);
4559   CI->setCallingConv(static_cast<llvm::CallingConv::ID>(CallingConv));
4560 
4561   // Apply various metadata.
4562 
4563   if (!CI->getType()->isVoidTy())
4564     CI->setName("call");
4565 
4566   // Update largest vector width from the return type.
4567   if (auto *VT = dyn_cast<llvm::VectorType>(CI->getType()))
4568     LargestVectorWidth = std::max((uint64_t)LargestVectorWidth,
4569                                   VT->getPrimitiveSizeInBits().getFixedSize());
4570 
4571   // Insert instrumentation or attach profile metadata at indirect call sites.
4572   // For more details, see the comment before the definition of
4573   // IPVK_IndirectCallTarget in InstrProfData.inc.
4574   if (!CI->getCalledFunction())
4575     PGO.valueProfile(Builder, llvm::IPVK_IndirectCallTarget,
4576                      CI, CalleePtr);
4577 
4578   // In ObjC ARC mode with no ObjC ARC exception safety, tell the ARC
4579   // optimizer it can aggressively ignore unwind edges.
4580   if (CGM.getLangOpts().ObjCAutoRefCount)
4581     AddObjCARCExceptionMetadata(CI);
4582 
4583   // Suppress tail calls if requested.
4584   if (llvm::CallInst *Call = dyn_cast<llvm::CallInst>(CI)) {
4585     if (TargetDecl && TargetDecl->hasAttr<NotTailCalledAttr>())
4586       Call->setTailCallKind(llvm::CallInst::TCK_NoTail);
4587   }
4588 
4589   // Add metadata for calls to MSAllocator functions
4590   if (getDebugInfo() && TargetDecl &&
4591       TargetDecl->hasAttr<MSAllocatorAttr>())
4592     getDebugInfo()->addHeapAllocSiteMetadata(CI, RetTy, Loc);
4593 
4594   // 4. Finish the call.
4595 
4596   // If the call doesn't return, finish the basic block and clear the
4597   // insertion point; this allows the rest of IRGen to discard
4598   // unreachable code.
4599   if (CI->doesNotReturn()) {
4600     if (UnusedReturnSizePtr)
4601       PopCleanupBlock();
4602 
4603     // Strip away the noreturn attribute to better diagnose unreachable UB.
4604     if (SanOpts.has(SanitizerKind::Unreachable)) {
4605       // Also remove from function since CallBase::hasFnAttr additionally checks
4606       // attributes of the called function.
4607       if (auto *F = CI->getCalledFunction())
4608         F->removeFnAttr(llvm::Attribute::NoReturn);
4609       CI->removeAttribute(llvm::AttributeList::FunctionIndex,
4610                           llvm::Attribute::NoReturn);
4611 
4612       // Avoid incompatibility with ASan which relies on the `noreturn`
4613       // attribute to insert handler calls.
4614       if (SanOpts.hasOneOf(SanitizerKind::Address |
4615                            SanitizerKind::KernelAddress)) {
4616         SanitizerScope SanScope(this);
4617         llvm::IRBuilder<>::InsertPointGuard IPGuard(Builder);
4618         Builder.SetInsertPoint(CI);
4619         auto *FnType = llvm::FunctionType::get(CGM.VoidTy, /*isVarArg=*/false);
4620         llvm::FunctionCallee Fn =
4621             CGM.CreateRuntimeFunction(FnType, "__asan_handle_no_return");
4622         EmitNounwindRuntimeCall(Fn);
4623       }
4624     }
4625 
4626     EmitUnreachable(Loc);
4627     Builder.ClearInsertionPoint();
4628 
4629     // FIXME: For now, emit a dummy basic block because expr emitters in
4630     // generally are not ready to handle emitting expressions at unreachable
4631     // points.
4632     EnsureInsertPoint();
4633 
4634     // Return a reasonable RValue.
4635     return GetUndefRValue(RetTy);
4636   }
4637 
4638   // Perform the swifterror writeback.
4639   if (swiftErrorTemp.isValid()) {
4640     llvm::Value *errorResult = Builder.CreateLoad(swiftErrorTemp);
4641     Builder.CreateStore(errorResult, swiftErrorArg);
4642   }
4643 
4644   // Emit any call-associated writebacks immediately.  Arguably this
4645   // should happen after any return-value munging.
4646   if (CallArgs.hasWritebacks())
4647     emitWritebacks(*this, CallArgs);
4648 
4649   // The stack cleanup for inalloca arguments has to run out of the normal
4650   // lexical order, so deactivate it and run it manually here.
4651   CallArgs.freeArgumentMemory(*this);
4652 
4653   // Extract the return value.
4654   RValue Ret = [&] {
4655     switch (RetAI.getKind()) {
4656     case ABIArgInfo::CoerceAndExpand: {
4657       auto coercionType = RetAI.getCoerceAndExpandType();
4658 
4659       Address addr = SRetPtr;
4660       addr = Builder.CreateElementBitCast(addr, coercionType);
4661 
4662       assert(CI->getType() == RetAI.getUnpaddedCoerceAndExpandType());
4663       bool requiresExtract = isa<llvm::StructType>(CI->getType());
4664 
4665       unsigned unpaddedIndex = 0;
4666       for (unsigned i = 0, e = coercionType->getNumElements(); i != e; ++i) {
4667         llvm::Type *eltType = coercionType->getElementType(i);
4668         if (ABIArgInfo::isPaddingForCoerceAndExpand(eltType)) continue;
4669         Address eltAddr = Builder.CreateStructGEP(addr, i);
4670         llvm::Value *elt = CI;
4671         if (requiresExtract)
4672           elt = Builder.CreateExtractValue(elt, unpaddedIndex++);
4673         else
4674           assert(unpaddedIndex == 0);
4675         Builder.CreateStore(elt, eltAddr);
4676       }
4677       // FALLTHROUGH
4678       LLVM_FALLTHROUGH;
4679     }
4680 
4681     case ABIArgInfo::InAlloca:
4682     case ABIArgInfo::Indirect: {
4683       RValue ret = convertTempToRValue(SRetPtr, RetTy, SourceLocation());
4684       if (UnusedReturnSizePtr)
4685         PopCleanupBlock();
4686       return ret;
4687     }
4688 
4689     case ABIArgInfo::Ignore:
4690       // If we are ignoring an argument that had a result, make sure to
4691       // construct the appropriate return value for our caller.
4692       return GetUndefRValue(RetTy);
4693 
4694     case ABIArgInfo::Extend:
4695     case ABIArgInfo::Direct: {
4696       llvm::Type *RetIRTy = ConvertType(RetTy);
4697       if (RetAI.getCoerceToType() == RetIRTy && RetAI.getDirectOffset() == 0) {
4698         switch (getEvaluationKind(RetTy)) {
4699         case TEK_Complex: {
4700           llvm::Value *Real = Builder.CreateExtractValue(CI, 0);
4701           llvm::Value *Imag = Builder.CreateExtractValue(CI, 1);
4702           return RValue::getComplex(std::make_pair(Real, Imag));
4703         }
4704         case TEK_Aggregate: {
4705           Address DestPtr = ReturnValue.getValue();
4706           bool DestIsVolatile = ReturnValue.isVolatile();
4707 
4708           if (!DestPtr.isValid()) {
4709             DestPtr = CreateMemTemp(RetTy, "agg.tmp");
4710             DestIsVolatile = false;
4711           }
4712           BuildAggStore(*this, CI, DestPtr, DestIsVolatile);
4713           return RValue::getAggregate(DestPtr);
4714         }
4715         case TEK_Scalar: {
4716           // If the argument doesn't match, perform a bitcast to coerce it.  This
4717           // can happen due to trivial type mismatches.
4718           llvm::Value *V = CI;
4719           if (V->getType() != RetIRTy)
4720             V = Builder.CreateBitCast(V, RetIRTy);
4721           return RValue::get(V);
4722         }
4723         }
4724         llvm_unreachable("bad evaluation kind");
4725       }
4726 
4727       Address DestPtr = ReturnValue.getValue();
4728       bool DestIsVolatile = ReturnValue.isVolatile();
4729 
4730       if (!DestPtr.isValid()) {
4731         DestPtr = CreateMemTemp(RetTy, "coerce");
4732         DestIsVolatile = false;
4733       }
4734 
4735       // If the value is offset in memory, apply the offset now.
4736       Address StorePtr = emitAddressAtOffset(*this, DestPtr, RetAI);
4737       CreateCoercedStore(CI, StorePtr, DestIsVolatile, *this);
4738 
4739       return convertTempToRValue(DestPtr, RetTy, SourceLocation());
4740     }
4741 
4742     case ABIArgInfo::Expand:
4743       llvm_unreachable("Invalid ABI kind for return argument");
4744     }
4745 
4746     llvm_unreachable("Unhandled ABIArgInfo::Kind");
4747   } ();
4748 
4749   // Emit the assume_aligned check on the return value.
4750   if (Ret.isScalar() && TargetDecl) {
4751     AssumeAlignedAttrEmitter.EmitAsAnAssumption(Loc, RetTy, Ret);
4752     AllocAlignAttrEmitter.EmitAsAnAssumption(Loc, RetTy, Ret);
4753   }
4754 
4755   // Explicitly call CallLifetimeEnd::Emit just to re-use the code even though
4756   // we can't use the full cleanup mechanism.
4757   for (CallLifetimeEnd &LifetimeEnd : CallLifetimeEndAfterCall)
4758     LifetimeEnd.Emit(*this, /*Flags=*/{});
4759 
4760   return Ret;
4761 }
4762 
4763 CGCallee CGCallee::prepareConcreteCallee(CodeGenFunction &CGF) const {
4764   if (isVirtual()) {
4765     const CallExpr *CE = getVirtualCallExpr();
4766     return CGF.CGM.getCXXABI().getVirtualFunctionPointer(
4767         CGF, getVirtualMethodDecl(), getThisAddress(), getVirtualFunctionType(),
4768         CE ? CE->getBeginLoc() : SourceLocation());
4769   }
4770 
4771   return *this;
4772 }
4773 
4774 /* VarArg handling */
4775 
4776 Address CodeGenFunction::EmitVAArg(VAArgExpr *VE, Address &VAListAddr) {
4777   VAListAddr = VE->isMicrosoftABI()
4778                  ? EmitMSVAListRef(VE->getSubExpr())
4779                  : EmitVAListRef(VE->getSubExpr());
4780   QualType Ty = VE->getType();
4781   if (VE->isMicrosoftABI())
4782     return CGM.getTypes().getABIInfo().EmitMSVAArg(*this, VAListAddr, Ty);
4783   return CGM.getTypes().getABIInfo().EmitVAArg(*this, VAListAddr, Ty);
4784 }
4785