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