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 (TargetDecl && TargetDecl->hasAttr<OpenCLKernelAttr>()) {
1874     if (getLangOpts().OpenCLVersion <= 120) {
1875       // OpenCL v1.2 Work groups are always uniform
1876       FuncAttrs.addAttribute("uniform-work-group-size", "true");
1877     } else {
1878       // OpenCL v2.0 Work groups may be whether uniform or not.
1879       // '-cl-uniform-work-group-size' compile option gets a hint
1880       // to the compiler that the global work-size be a multiple of
1881       // the work-group size specified to clEnqueueNDRangeKernel
1882       // (i.e. work groups are uniform).
1883       FuncAttrs.addAttribute("uniform-work-group-size",
1884                              llvm::toStringRef(CodeGenOpts.UniformWGSize));
1885     }
1886   }
1887 
1888   if (!AttrOnCallSite) {
1889     bool DisableTailCalls =
1890         CodeGenOpts.DisableTailCalls ||
1891         (TargetDecl && (TargetDecl->hasAttr<DisableTailCallsAttr>() ||
1892                         TargetDecl->hasAttr<AnyX86InterruptAttr>()));
1893     FuncAttrs.addAttribute("disable-tail-calls",
1894                            llvm::toStringRef(DisableTailCalls));
1895     GetCPUAndFeaturesAttributes(TargetDecl, FuncAttrs);
1896   }
1897 
1898   ClangToLLVMArgMapping IRFunctionArgs(getContext(), FI);
1899 
1900   QualType RetTy = FI.getReturnType();
1901   const ABIArgInfo &RetAI = FI.getReturnInfo();
1902   switch (RetAI.getKind()) {
1903   case ABIArgInfo::Extend:
1904     if (RetAI.isSignExt())
1905       RetAttrs.addAttribute(llvm::Attribute::SExt);
1906     else
1907       RetAttrs.addAttribute(llvm::Attribute::ZExt);
1908     LLVM_FALLTHROUGH;
1909   case ABIArgInfo::Direct:
1910     if (RetAI.getInReg())
1911       RetAttrs.addAttribute(llvm::Attribute::InReg);
1912     break;
1913   case ABIArgInfo::Ignore:
1914     break;
1915 
1916   case ABIArgInfo::InAlloca:
1917   case ABIArgInfo::Indirect: {
1918     // inalloca and sret disable readnone and readonly
1919     FuncAttrs.removeAttribute(llvm::Attribute::ReadOnly)
1920       .removeAttribute(llvm::Attribute::ReadNone);
1921     break;
1922   }
1923 
1924   case ABIArgInfo::CoerceAndExpand:
1925     break;
1926 
1927   case ABIArgInfo::Expand:
1928     llvm_unreachable("Invalid ABI kind for return argument");
1929   }
1930 
1931   if (const auto *RefTy = RetTy->getAs<ReferenceType>()) {
1932     QualType PTy = RefTy->getPointeeType();
1933     if (!PTy->isIncompleteType() && PTy->isConstantSizeType())
1934       RetAttrs.addDereferenceableAttr(getContext().getTypeSizeInChars(PTy)
1935                                         .getQuantity());
1936     else if (getContext().getTargetAddressSpace(PTy) == 0)
1937       RetAttrs.addAttribute(llvm::Attribute::NonNull);
1938   }
1939 
1940   bool hasUsedSRet = false;
1941   SmallVector<llvm::AttributeSet, 4> ArgAttrs(IRFunctionArgs.totalIRArgs());
1942 
1943   // Attach attributes to sret.
1944   if (IRFunctionArgs.hasSRetArg()) {
1945     llvm::AttrBuilder SRETAttrs;
1946     SRETAttrs.addAttribute(llvm::Attribute::StructRet);
1947     hasUsedSRet = true;
1948     if (RetAI.getInReg())
1949       SRETAttrs.addAttribute(llvm::Attribute::InReg);
1950     ArgAttrs[IRFunctionArgs.getSRetArgNo()] =
1951         llvm::AttributeSet::get(getLLVMContext(), SRETAttrs);
1952   }
1953 
1954   // Attach attributes to inalloca argument.
1955   if (IRFunctionArgs.hasInallocaArg()) {
1956     llvm::AttrBuilder Attrs;
1957     Attrs.addAttribute(llvm::Attribute::InAlloca);
1958     ArgAttrs[IRFunctionArgs.getInallocaArgNo()] =
1959         llvm::AttributeSet::get(getLLVMContext(), Attrs);
1960   }
1961 
1962   unsigned ArgNo = 0;
1963   for (CGFunctionInfo::const_arg_iterator I = FI.arg_begin(),
1964                                           E = FI.arg_end();
1965        I != E; ++I, ++ArgNo) {
1966     QualType ParamType = I->type;
1967     const ABIArgInfo &AI = I->info;
1968     llvm::AttrBuilder Attrs;
1969 
1970     // Add attribute for padding argument, if necessary.
1971     if (IRFunctionArgs.hasPaddingArg(ArgNo)) {
1972       if (AI.getPaddingInReg()) {
1973         ArgAttrs[IRFunctionArgs.getPaddingArgNo(ArgNo)] =
1974             llvm::AttributeSet::get(
1975                 getLLVMContext(),
1976                 llvm::AttrBuilder().addAttribute(llvm::Attribute::InReg));
1977       }
1978     }
1979 
1980     // 'restrict' -> 'noalias' is done in EmitFunctionProlog when we
1981     // have the corresponding parameter variable.  It doesn't make
1982     // sense to do it here because parameters are so messed up.
1983     switch (AI.getKind()) {
1984     case ABIArgInfo::Extend:
1985       if (AI.isSignExt())
1986         Attrs.addAttribute(llvm::Attribute::SExt);
1987       else
1988         Attrs.addAttribute(llvm::Attribute::ZExt);
1989       LLVM_FALLTHROUGH;
1990     case ABIArgInfo::Direct:
1991       if (ArgNo == 0 && FI.isChainCall())
1992         Attrs.addAttribute(llvm::Attribute::Nest);
1993       else if (AI.getInReg())
1994         Attrs.addAttribute(llvm::Attribute::InReg);
1995       break;
1996 
1997     case ABIArgInfo::Indirect: {
1998       if (AI.getInReg())
1999         Attrs.addAttribute(llvm::Attribute::InReg);
2000 
2001       if (AI.getIndirectByVal())
2002         Attrs.addAttribute(llvm::Attribute::ByVal);
2003 
2004       CharUnits Align = AI.getIndirectAlign();
2005 
2006       // In a byval argument, it is important that the required
2007       // alignment of the type is honored, as LLVM might be creating a
2008       // *new* stack object, and needs to know what alignment to give
2009       // it. (Sometimes it can deduce a sensible alignment on its own,
2010       // but not if clang decides it must emit a packed struct, or the
2011       // user specifies increased alignment requirements.)
2012       //
2013       // This is different from indirect *not* byval, where the object
2014       // exists already, and the align attribute is purely
2015       // informative.
2016       assert(!Align.isZero());
2017 
2018       // For now, only add this when we have a byval argument.
2019       // TODO: be less lazy about updating test cases.
2020       if (AI.getIndirectByVal())
2021         Attrs.addAlignmentAttr(Align.getQuantity());
2022 
2023       // byval disables readnone and readonly.
2024       FuncAttrs.removeAttribute(llvm::Attribute::ReadOnly)
2025         .removeAttribute(llvm::Attribute::ReadNone);
2026       break;
2027     }
2028     case ABIArgInfo::Ignore:
2029     case ABIArgInfo::Expand:
2030     case ABIArgInfo::CoerceAndExpand:
2031       break;
2032 
2033     case ABIArgInfo::InAlloca:
2034       // inalloca disables readnone and readonly.
2035       FuncAttrs.removeAttribute(llvm::Attribute::ReadOnly)
2036           .removeAttribute(llvm::Attribute::ReadNone);
2037       continue;
2038     }
2039 
2040     if (const auto *RefTy = ParamType->getAs<ReferenceType>()) {
2041       QualType PTy = RefTy->getPointeeType();
2042       if (!PTy->isIncompleteType() && PTy->isConstantSizeType())
2043         Attrs.addDereferenceableAttr(getContext().getTypeSizeInChars(PTy)
2044                                        .getQuantity());
2045       else if (getContext().getTargetAddressSpace(PTy) == 0)
2046         Attrs.addAttribute(llvm::Attribute::NonNull);
2047     }
2048 
2049     switch (FI.getExtParameterInfo(ArgNo).getABI()) {
2050     case ParameterABI::Ordinary:
2051       break;
2052 
2053     case ParameterABI::SwiftIndirectResult: {
2054       // Add 'sret' if we haven't already used it for something, but
2055       // only if the result is void.
2056       if (!hasUsedSRet && RetTy->isVoidType()) {
2057         Attrs.addAttribute(llvm::Attribute::StructRet);
2058         hasUsedSRet = true;
2059       }
2060 
2061       // Add 'noalias' in either case.
2062       Attrs.addAttribute(llvm::Attribute::NoAlias);
2063 
2064       // Add 'dereferenceable' and 'alignment'.
2065       auto PTy = ParamType->getPointeeType();
2066       if (!PTy->isIncompleteType() && PTy->isConstantSizeType()) {
2067         auto info = getContext().getTypeInfoInChars(PTy);
2068         Attrs.addDereferenceableAttr(info.first.getQuantity());
2069         Attrs.addAttribute(llvm::Attribute::getWithAlignment(getLLVMContext(),
2070                                                  info.second.getQuantity()));
2071       }
2072       break;
2073     }
2074 
2075     case ParameterABI::SwiftErrorResult:
2076       Attrs.addAttribute(llvm::Attribute::SwiftError);
2077       break;
2078 
2079     case ParameterABI::SwiftContext:
2080       Attrs.addAttribute(llvm::Attribute::SwiftSelf);
2081       break;
2082     }
2083 
2084     if (FI.getExtParameterInfo(ArgNo).isNoEscape())
2085       Attrs.addAttribute(llvm::Attribute::NoCapture);
2086 
2087     if (Attrs.hasAttributes()) {
2088       unsigned FirstIRArg, NumIRArgs;
2089       std::tie(FirstIRArg, NumIRArgs) = IRFunctionArgs.getIRArgs(ArgNo);
2090       for (unsigned i = 0; i < NumIRArgs; i++)
2091         ArgAttrs[FirstIRArg + i] =
2092             llvm::AttributeSet::get(getLLVMContext(), Attrs);
2093     }
2094   }
2095   assert(ArgNo == FI.arg_size());
2096 
2097   AttrList = llvm::AttributeList::get(
2098       getLLVMContext(), llvm::AttributeSet::get(getLLVMContext(), FuncAttrs),
2099       llvm::AttributeSet::get(getLLVMContext(), RetAttrs), ArgAttrs);
2100 }
2101 
2102 /// An argument came in as a promoted argument; demote it back to its
2103 /// declared type.
2104 static llvm::Value *emitArgumentDemotion(CodeGenFunction &CGF,
2105                                          const VarDecl *var,
2106                                          llvm::Value *value) {
2107   llvm::Type *varType = CGF.ConvertType(var->getType());
2108 
2109   // This can happen with promotions that actually don't change the
2110   // underlying type, like the enum promotions.
2111   if (value->getType() == varType) return value;
2112 
2113   assert((varType->isIntegerTy() || varType->isFloatingPointTy())
2114          && "unexpected promotion type");
2115 
2116   if (isa<llvm::IntegerType>(varType))
2117     return CGF.Builder.CreateTrunc(value, varType, "arg.unpromote");
2118 
2119   return CGF.Builder.CreateFPCast(value, varType, "arg.unpromote");
2120 }
2121 
2122 /// Returns the attribute (either parameter attribute, or function
2123 /// attribute), which declares argument ArgNo to be non-null.
2124 static const NonNullAttr *getNonNullAttr(const Decl *FD, const ParmVarDecl *PVD,
2125                                          QualType ArgType, unsigned ArgNo) {
2126   // FIXME: __attribute__((nonnull)) can also be applied to:
2127   //   - references to pointers, where the pointee is known to be
2128   //     nonnull (apparently a Clang extension)
2129   //   - transparent unions containing pointers
2130   // In the former case, LLVM IR cannot represent the constraint. In
2131   // the latter case, we have no guarantee that the transparent union
2132   // is in fact passed as a pointer.
2133   if (!ArgType->isAnyPointerType() && !ArgType->isBlockPointerType())
2134     return nullptr;
2135   // First, check attribute on parameter itself.
2136   if (PVD) {
2137     if (auto ParmNNAttr = PVD->getAttr<NonNullAttr>())
2138       return ParmNNAttr;
2139   }
2140   // Check function attributes.
2141   if (!FD)
2142     return nullptr;
2143   for (const auto *NNAttr : FD->specific_attrs<NonNullAttr>()) {
2144     if (NNAttr->isNonNull(ArgNo))
2145       return NNAttr;
2146   }
2147   return nullptr;
2148 }
2149 
2150 namespace {
2151   struct CopyBackSwiftError final : EHScopeStack::Cleanup {
2152     Address Temp;
2153     Address Arg;
2154     CopyBackSwiftError(Address temp, Address arg) : Temp(temp), Arg(arg) {}
2155     void Emit(CodeGenFunction &CGF, Flags flags) override {
2156       llvm::Value *errorValue = CGF.Builder.CreateLoad(Temp);
2157       CGF.Builder.CreateStore(errorValue, Arg);
2158     }
2159   };
2160 }
2161 
2162 void CodeGenFunction::EmitFunctionProlog(const CGFunctionInfo &FI,
2163                                          llvm::Function *Fn,
2164                                          const FunctionArgList &Args) {
2165   if (CurCodeDecl && CurCodeDecl->hasAttr<NakedAttr>())
2166     // Naked functions don't have prologues.
2167     return;
2168 
2169   // If this is an implicit-return-zero function, go ahead and
2170   // initialize the return value.  TODO: it might be nice to have
2171   // a more general mechanism for this that didn't require synthesized
2172   // return statements.
2173   if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(CurCodeDecl)) {
2174     if (FD->hasImplicitReturnZero()) {
2175       QualType RetTy = FD->getReturnType().getUnqualifiedType();
2176       llvm::Type* LLVMTy = CGM.getTypes().ConvertType(RetTy);
2177       llvm::Constant* Zero = llvm::Constant::getNullValue(LLVMTy);
2178       Builder.CreateStore(Zero, ReturnValue);
2179     }
2180   }
2181 
2182   // FIXME: We no longer need the types from FunctionArgList; lift up and
2183   // simplify.
2184 
2185   ClangToLLVMArgMapping IRFunctionArgs(CGM.getContext(), FI);
2186   // Flattened function arguments.
2187   SmallVector<llvm::Value *, 16> FnArgs;
2188   FnArgs.reserve(IRFunctionArgs.totalIRArgs());
2189   for (auto &Arg : Fn->args()) {
2190     FnArgs.push_back(&Arg);
2191   }
2192   assert(FnArgs.size() == IRFunctionArgs.totalIRArgs());
2193 
2194   // If we're using inalloca, all the memory arguments are GEPs off of the last
2195   // parameter, which is a pointer to the complete memory area.
2196   Address ArgStruct = Address::invalid();
2197   const llvm::StructLayout *ArgStructLayout = nullptr;
2198   if (IRFunctionArgs.hasInallocaArg()) {
2199     ArgStructLayout = CGM.getDataLayout().getStructLayout(FI.getArgStruct());
2200     ArgStruct = Address(FnArgs[IRFunctionArgs.getInallocaArgNo()],
2201                         FI.getArgStructAlignment());
2202 
2203     assert(ArgStruct.getType() == FI.getArgStruct()->getPointerTo());
2204   }
2205 
2206   // Name the struct return parameter.
2207   if (IRFunctionArgs.hasSRetArg()) {
2208     auto AI = cast<llvm::Argument>(FnArgs[IRFunctionArgs.getSRetArgNo()]);
2209     AI->setName("agg.result");
2210     AI->addAttr(llvm::Attribute::NoAlias);
2211   }
2212 
2213   // Track if we received the parameter as a pointer (indirect, byval, or
2214   // inalloca).  If already have a pointer, EmitParmDecl doesn't need to copy it
2215   // into a local alloca for us.
2216   SmallVector<ParamValue, 16> ArgVals;
2217   ArgVals.reserve(Args.size());
2218 
2219   // Create a pointer value for every parameter declaration.  This usually
2220   // entails copying one or more LLVM IR arguments into an alloca.  Don't push
2221   // any cleanups or do anything that might unwind.  We do that separately, so
2222   // we can push the cleanups in the correct order for the ABI.
2223   assert(FI.arg_size() == Args.size() &&
2224          "Mismatch between function signature & arguments.");
2225   unsigned ArgNo = 0;
2226   CGFunctionInfo::const_arg_iterator info_it = FI.arg_begin();
2227   for (FunctionArgList::const_iterator i = Args.begin(), e = Args.end();
2228        i != e; ++i, ++info_it, ++ArgNo) {
2229     const VarDecl *Arg = *i;
2230     const ABIArgInfo &ArgI = info_it->info;
2231 
2232     bool isPromoted =
2233       isa<ParmVarDecl>(Arg) && cast<ParmVarDecl>(Arg)->isKNRPromoted();
2234     // We are converting from ABIArgInfo type to VarDecl type directly, unless
2235     // the parameter is promoted. In this case we convert to
2236     // CGFunctionInfo::ArgInfo type with subsequent argument demotion.
2237     QualType Ty = isPromoted ? info_it->type : Arg->getType();
2238     assert(hasScalarEvaluationKind(Ty) ==
2239            hasScalarEvaluationKind(Arg->getType()));
2240 
2241     unsigned FirstIRArg, NumIRArgs;
2242     std::tie(FirstIRArg, NumIRArgs) = IRFunctionArgs.getIRArgs(ArgNo);
2243 
2244     switch (ArgI.getKind()) {
2245     case ABIArgInfo::InAlloca: {
2246       assert(NumIRArgs == 0);
2247       auto FieldIndex = ArgI.getInAllocaFieldIndex();
2248       CharUnits FieldOffset =
2249         CharUnits::fromQuantity(ArgStructLayout->getElementOffset(FieldIndex));
2250       Address V = Builder.CreateStructGEP(ArgStruct, FieldIndex, FieldOffset,
2251                                           Arg->getName());
2252       ArgVals.push_back(ParamValue::forIndirect(V));
2253       break;
2254     }
2255 
2256     case ABIArgInfo::Indirect: {
2257       assert(NumIRArgs == 1);
2258       Address ParamAddr = Address(FnArgs[FirstIRArg], ArgI.getIndirectAlign());
2259 
2260       if (!hasScalarEvaluationKind(Ty)) {
2261         // Aggregates and complex variables are accessed by reference.  All we
2262         // need to do is realign the value, if requested.
2263         Address V = ParamAddr;
2264         if (ArgI.getIndirectRealign()) {
2265           Address AlignedTemp = CreateMemTemp(Ty, "coerce");
2266 
2267           // Copy from the incoming argument pointer to the temporary with the
2268           // appropriate alignment.
2269           //
2270           // FIXME: We should have a common utility for generating an aggregate
2271           // copy.
2272           CharUnits Size = getContext().getTypeSizeInChars(Ty);
2273           auto SizeVal = llvm::ConstantInt::get(IntPtrTy, Size.getQuantity());
2274           Address Dst = Builder.CreateBitCast(AlignedTemp, Int8PtrTy);
2275           Address Src = Builder.CreateBitCast(ParamAddr, Int8PtrTy);
2276           Builder.CreateMemCpy(Dst, Src, SizeVal, false);
2277           V = AlignedTemp;
2278         }
2279         ArgVals.push_back(ParamValue::forIndirect(V));
2280       } else {
2281         // Load scalar value from indirect argument.
2282         llvm::Value *V =
2283           EmitLoadOfScalar(ParamAddr, false, Ty, Arg->getLocStart());
2284 
2285         if (isPromoted)
2286           V = emitArgumentDemotion(*this, Arg, V);
2287         ArgVals.push_back(ParamValue::forDirect(V));
2288       }
2289       break;
2290     }
2291 
2292     case ABIArgInfo::Extend:
2293     case ABIArgInfo::Direct: {
2294 
2295       // If we have the trivial case, handle it with no muss and fuss.
2296       if (!isa<llvm::StructType>(ArgI.getCoerceToType()) &&
2297           ArgI.getCoerceToType() == ConvertType(Ty) &&
2298           ArgI.getDirectOffset() == 0) {
2299         assert(NumIRArgs == 1);
2300         llvm::Value *V = FnArgs[FirstIRArg];
2301         auto AI = cast<llvm::Argument>(V);
2302 
2303         if (const ParmVarDecl *PVD = dyn_cast<ParmVarDecl>(Arg)) {
2304           if (getNonNullAttr(CurCodeDecl, PVD, PVD->getType(),
2305                              PVD->getFunctionScopeIndex()))
2306             AI->addAttr(llvm::Attribute::NonNull);
2307 
2308           QualType OTy = PVD->getOriginalType();
2309           if (const auto *ArrTy =
2310               getContext().getAsConstantArrayType(OTy)) {
2311             // A C99 array parameter declaration with the static keyword also
2312             // indicates dereferenceability, and if the size is constant we can
2313             // use the dereferenceable attribute (which requires the size in
2314             // bytes).
2315             if (ArrTy->getSizeModifier() == ArrayType::Static) {
2316               QualType ETy = ArrTy->getElementType();
2317               uint64_t ArrSize = ArrTy->getSize().getZExtValue();
2318               if (!ETy->isIncompleteType() && ETy->isConstantSizeType() &&
2319                   ArrSize) {
2320                 llvm::AttrBuilder Attrs;
2321                 Attrs.addDereferenceableAttr(
2322                   getContext().getTypeSizeInChars(ETy).getQuantity()*ArrSize);
2323                 AI->addAttrs(Attrs);
2324               } else if (getContext().getTargetAddressSpace(ETy) == 0) {
2325                 AI->addAttr(llvm::Attribute::NonNull);
2326               }
2327             }
2328           } else if (const auto *ArrTy =
2329                      getContext().getAsVariableArrayType(OTy)) {
2330             // For C99 VLAs with the static keyword, we don't know the size so
2331             // we can't use the dereferenceable attribute, but in addrspace(0)
2332             // we know that it must be nonnull.
2333             if (ArrTy->getSizeModifier() == VariableArrayType::Static &&
2334                 !getContext().getTargetAddressSpace(ArrTy->getElementType()))
2335               AI->addAttr(llvm::Attribute::NonNull);
2336           }
2337 
2338           const auto *AVAttr = PVD->getAttr<AlignValueAttr>();
2339           if (!AVAttr)
2340             if (const auto *TOTy = dyn_cast<TypedefType>(OTy))
2341               AVAttr = TOTy->getDecl()->getAttr<AlignValueAttr>();
2342           if (AVAttr) {
2343             llvm::Value *AlignmentValue =
2344               EmitScalarExpr(AVAttr->getAlignment());
2345             llvm::ConstantInt *AlignmentCI =
2346               cast<llvm::ConstantInt>(AlignmentValue);
2347             unsigned Alignment = std::min((unsigned)AlignmentCI->getZExtValue(),
2348                                           +llvm::Value::MaximumAlignment);
2349             AI->addAttrs(llvm::AttrBuilder().addAlignmentAttr(Alignment));
2350           }
2351         }
2352 
2353         if (Arg->getType().isRestrictQualified())
2354           AI->addAttr(llvm::Attribute::NoAlias);
2355 
2356         // LLVM expects swifterror parameters to be used in very restricted
2357         // ways.  Copy the value into a less-restricted temporary.
2358         if (FI.getExtParameterInfo(ArgNo).getABI()
2359               == ParameterABI::SwiftErrorResult) {
2360           QualType pointeeTy = Ty->getPointeeType();
2361           assert(pointeeTy->isPointerType());
2362           Address temp =
2363             CreateMemTemp(pointeeTy, getPointerAlign(), "swifterror.temp");
2364           Address arg = Address(V, getContext().getTypeAlignInChars(pointeeTy));
2365           llvm::Value *incomingErrorValue = Builder.CreateLoad(arg);
2366           Builder.CreateStore(incomingErrorValue, temp);
2367           V = temp.getPointer();
2368 
2369           // Push a cleanup to copy the value back at the end of the function.
2370           // The convention does not guarantee that the value will be written
2371           // back if the function exits with an unwind exception.
2372           EHStack.pushCleanup<CopyBackSwiftError>(NormalCleanup, temp, arg);
2373         }
2374 
2375         // Ensure the argument is the correct type.
2376         if (V->getType() != ArgI.getCoerceToType())
2377           V = Builder.CreateBitCast(V, ArgI.getCoerceToType());
2378 
2379         if (isPromoted)
2380           V = emitArgumentDemotion(*this, Arg, V);
2381 
2382         // Because of merging of function types from multiple decls it is
2383         // possible for the type of an argument to not match the corresponding
2384         // type in the function type. Since we are codegening the callee
2385         // in here, add a cast to the argument type.
2386         llvm::Type *LTy = ConvertType(Arg->getType());
2387         if (V->getType() != LTy)
2388           V = Builder.CreateBitCast(V, LTy);
2389 
2390         ArgVals.push_back(ParamValue::forDirect(V));
2391         break;
2392       }
2393 
2394       Address Alloca = CreateMemTemp(Ty, getContext().getDeclAlign(Arg),
2395                                      Arg->getName());
2396 
2397       // Pointer to store into.
2398       Address Ptr = emitAddressAtOffset(*this, Alloca, ArgI);
2399 
2400       // Fast-isel and the optimizer generally like scalar values better than
2401       // FCAs, so we flatten them if this is safe to do for this argument.
2402       llvm::StructType *STy = dyn_cast<llvm::StructType>(ArgI.getCoerceToType());
2403       if (ArgI.isDirect() && ArgI.getCanBeFlattened() && STy &&
2404           STy->getNumElements() > 1) {
2405         auto SrcLayout = CGM.getDataLayout().getStructLayout(STy);
2406         uint64_t SrcSize = CGM.getDataLayout().getTypeAllocSize(STy);
2407         llvm::Type *DstTy = Ptr.getElementType();
2408         uint64_t DstSize = CGM.getDataLayout().getTypeAllocSize(DstTy);
2409 
2410         Address AddrToStoreInto = Address::invalid();
2411         if (SrcSize <= DstSize) {
2412           AddrToStoreInto = Builder.CreateElementBitCast(Ptr, STy);
2413         } else {
2414           AddrToStoreInto =
2415             CreateTempAlloca(STy, Alloca.getAlignment(), "coerce");
2416         }
2417 
2418         assert(STy->getNumElements() == NumIRArgs);
2419         for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
2420           auto AI = FnArgs[FirstIRArg + i];
2421           AI->setName(Arg->getName() + ".coerce" + Twine(i));
2422           auto Offset = CharUnits::fromQuantity(SrcLayout->getElementOffset(i));
2423           Address EltPtr =
2424             Builder.CreateStructGEP(AddrToStoreInto, i, Offset);
2425           Builder.CreateStore(AI, EltPtr);
2426         }
2427 
2428         if (SrcSize > DstSize) {
2429           Builder.CreateMemCpy(Ptr, AddrToStoreInto, DstSize);
2430         }
2431 
2432       } else {
2433         // Simple case, just do a coerced store of the argument into the alloca.
2434         assert(NumIRArgs == 1);
2435         auto AI = FnArgs[FirstIRArg];
2436         AI->setName(Arg->getName() + ".coerce");
2437         CreateCoercedStore(AI, Ptr, /*DestIsVolatile=*/false, *this);
2438       }
2439 
2440       // Match to what EmitParmDecl is expecting for this type.
2441       if (CodeGenFunction::hasScalarEvaluationKind(Ty)) {
2442         llvm::Value *V =
2443           EmitLoadOfScalar(Alloca, false, Ty, Arg->getLocStart());
2444         if (isPromoted)
2445           V = emitArgumentDemotion(*this, Arg, V);
2446         ArgVals.push_back(ParamValue::forDirect(V));
2447       } else {
2448         ArgVals.push_back(ParamValue::forIndirect(Alloca));
2449       }
2450       break;
2451     }
2452 
2453     case ABIArgInfo::CoerceAndExpand: {
2454       // Reconstruct into a temporary.
2455       Address alloca = CreateMemTemp(Ty, getContext().getDeclAlign(Arg));
2456       ArgVals.push_back(ParamValue::forIndirect(alloca));
2457 
2458       auto coercionType = ArgI.getCoerceAndExpandType();
2459       alloca = Builder.CreateElementBitCast(alloca, coercionType);
2460       auto layout = CGM.getDataLayout().getStructLayout(coercionType);
2461 
2462       unsigned argIndex = FirstIRArg;
2463       for (unsigned i = 0, e = coercionType->getNumElements(); i != e; ++i) {
2464         llvm::Type *eltType = coercionType->getElementType(i);
2465         if (ABIArgInfo::isPaddingForCoerceAndExpand(eltType))
2466           continue;
2467 
2468         auto eltAddr = Builder.CreateStructGEP(alloca, i, layout);
2469         auto elt = FnArgs[argIndex++];
2470         Builder.CreateStore(elt, eltAddr);
2471       }
2472       assert(argIndex == FirstIRArg + NumIRArgs);
2473       break;
2474     }
2475 
2476     case ABIArgInfo::Expand: {
2477       // If this structure was expanded into multiple arguments then
2478       // we need to create a temporary and reconstruct it from the
2479       // arguments.
2480       Address Alloca = CreateMemTemp(Ty, getContext().getDeclAlign(Arg));
2481       LValue LV = MakeAddrLValue(Alloca, Ty);
2482       ArgVals.push_back(ParamValue::forIndirect(Alloca));
2483 
2484       auto FnArgIter = FnArgs.begin() + FirstIRArg;
2485       ExpandTypeFromArgs(Ty, LV, FnArgIter);
2486       assert(FnArgIter == FnArgs.begin() + FirstIRArg + NumIRArgs);
2487       for (unsigned i = 0, e = NumIRArgs; i != e; ++i) {
2488         auto AI = FnArgs[FirstIRArg + i];
2489         AI->setName(Arg->getName() + "." + Twine(i));
2490       }
2491       break;
2492     }
2493 
2494     case ABIArgInfo::Ignore:
2495       assert(NumIRArgs == 0);
2496       // Initialize the local variable appropriately.
2497       if (!hasScalarEvaluationKind(Ty)) {
2498         ArgVals.push_back(ParamValue::forIndirect(CreateMemTemp(Ty)));
2499       } else {
2500         llvm::Value *U = llvm::UndefValue::get(ConvertType(Arg->getType()));
2501         ArgVals.push_back(ParamValue::forDirect(U));
2502       }
2503       break;
2504     }
2505   }
2506 
2507   if (getTarget().getCXXABI().areArgsDestroyedLeftToRightInCallee()) {
2508     for (int I = Args.size() - 1; I >= 0; --I)
2509       EmitParmDecl(*Args[I], ArgVals[I], I + 1);
2510   } else {
2511     for (unsigned I = 0, E = Args.size(); I != E; ++I)
2512       EmitParmDecl(*Args[I], ArgVals[I], I + 1);
2513   }
2514 }
2515 
2516 static void eraseUnusedBitCasts(llvm::Instruction *insn) {
2517   while (insn->use_empty()) {
2518     llvm::BitCastInst *bitcast = dyn_cast<llvm::BitCastInst>(insn);
2519     if (!bitcast) return;
2520 
2521     // This is "safe" because we would have used a ConstantExpr otherwise.
2522     insn = cast<llvm::Instruction>(bitcast->getOperand(0));
2523     bitcast->eraseFromParent();
2524   }
2525 }
2526 
2527 /// Try to emit a fused autorelease of a return result.
2528 static llvm::Value *tryEmitFusedAutoreleaseOfResult(CodeGenFunction &CGF,
2529                                                     llvm::Value *result) {
2530   // We must be immediately followed the cast.
2531   llvm::BasicBlock *BB = CGF.Builder.GetInsertBlock();
2532   if (BB->empty()) return nullptr;
2533   if (&BB->back() != result) return nullptr;
2534 
2535   llvm::Type *resultType = result->getType();
2536 
2537   // result is in a BasicBlock and is therefore an Instruction.
2538   llvm::Instruction *generator = cast<llvm::Instruction>(result);
2539 
2540   SmallVector<llvm::Instruction *, 4> InstsToKill;
2541 
2542   // Look for:
2543   //  %generator = bitcast %type1* %generator2 to %type2*
2544   while (llvm::BitCastInst *bitcast = dyn_cast<llvm::BitCastInst>(generator)) {
2545     // We would have emitted this as a constant if the operand weren't
2546     // an Instruction.
2547     generator = cast<llvm::Instruction>(bitcast->getOperand(0));
2548 
2549     // Require the generator to be immediately followed by the cast.
2550     if (generator->getNextNode() != bitcast)
2551       return nullptr;
2552 
2553     InstsToKill.push_back(bitcast);
2554   }
2555 
2556   // Look for:
2557   //   %generator = call i8* @objc_retain(i8* %originalResult)
2558   // or
2559   //   %generator = call i8* @objc_retainAutoreleasedReturnValue(i8* %originalResult)
2560   llvm::CallInst *call = dyn_cast<llvm::CallInst>(generator);
2561   if (!call) return nullptr;
2562 
2563   bool doRetainAutorelease;
2564 
2565   if (call->getCalledValue() == CGF.CGM.getObjCEntrypoints().objc_retain) {
2566     doRetainAutorelease = true;
2567   } else if (call->getCalledValue() == CGF.CGM.getObjCEntrypoints()
2568                                           .objc_retainAutoreleasedReturnValue) {
2569     doRetainAutorelease = false;
2570 
2571     // If we emitted an assembly marker for this call (and the
2572     // ARCEntrypoints field should have been set if so), go looking
2573     // for that call.  If we can't find it, we can't do this
2574     // optimization.  But it should always be the immediately previous
2575     // instruction, unless we needed bitcasts around the call.
2576     if (CGF.CGM.getObjCEntrypoints().retainAutoreleasedReturnValueMarker) {
2577       llvm::Instruction *prev = call->getPrevNode();
2578       assert(prev);
2579       if (isa<llvm::BitCastInst>(prev)) {
2580         prev = prev->getPrevNode();
2581         assert(prev);
2582       }
2583       assert(isa<llvm::CallInst>(prev));
2584       assert(cast<llvm::CallInst>(prev)->getCalledValue() ==
2585                CGF.CGM.getObjCEntrypoints().retainAutoreleasedReturnValueMarker);
2586       InstsToKill.push_back(prev);
2587     }
2588   } else {
2589     return nullptr;
2590   }
2591 
2592   result = call->getArgOperand(0);
2593   InstsToKill.push_back(call);
2594 
2595   // Keep killing bitcasts, for sanity.  Note that we no longer care
2596   // about precise ordering as long as there's exactly one use.
2597   while (llvm::BitCastInst *bitcast = dyn_cast<llvm::BitCastInst>(result)) {
2598     if (!bitcast->hasOneUse()) break;
2599     InstsToKill.push_back(bitcast);
2600     result = bitcast->getOperand(0);
2601   }
2602 
2603   // Delete all the unnecessary instructions, from latest to earliest.
2604   for (auto *I : InstsToKill)
2605     I->eraseFromParent();
2606 
2607   // Do the fused retain/autorelease if we were asked to.
2608   if (doRetainAutorelease)
2609     result = CGF.EmitARCRetainAutoreleaseReturnValue(result);
2610 
2611   // Cast back to the result type.
2612   return CGF.Builder.CreateBitCast(result, resultType);
2613 }
2614 
2615 /// If this is a +1 of the value of an immutable 'self', remove it.
2616 static llvm::Value *tryRemoveRetainOfSelf(CodeGenFunction &CGF,
2617                                           llvm::Value *result) {
2618   // This is only applicable to a method with an immutable 'self'.
2619   const ObjCMethodDecl *method =
2620     dyn_cast_or_null<ObjCMethodDecl>(CGF.CurCodeDecl);
2621   if (!method) return nullptr;
2622   const VarDecl *self = method->getSelfDecl();
2623   if (!self->getType().isConstQualified()) return nullptr;
2624 
2625   // Look for a retain call.
2626   llvm::CallInst *retainCall =
2627     dyn_cast<llvm::CallInst>(result->stripPointerCasts());
2628   if (!retainCall ||
2629       retainCall->getCalledValue() != CGF.CGM.getObjCEntrypoints().objc_retain)
2630     return nullptr;
2631 
2632   // Look for an ordinary load of 'self'.
2633   llvm::Value *retainedValue = retainCall->getArgOperand(0);
2634   llvm::LoadInst *load =
2635     dyn_cast<llvm::LoadInst>(retainedValue->stripPointerCasts());
2636   if (!load || load->isAtomic() || load->isVolatile() ||
2637       load->getPointerOperand() != CGF.GetAddrOfLocalVar(self).getPointer())
2638     return nullptr;
2639 
2640   // Okay!  Burn it all down.  This relies for correctness on the
2641   // assumption that the retain is emitted as part of the return and
2642   // that thereafter everything is used "linearly".
2643   llvm::Type *resultType = result->getType();
2644   eraseUnusedBitCasts(cast<llvm::Instruction>(result));
2645   assert(retainCall->use_empty());
2646   retainCall->eraseFromParent();
2647   eraseUnusedBitCasts(cast<llvm::Instruction>(retainedValue));
2648 
2649   return CGF.Builder.CreateBitCast(load, resultType);
2650 }
2651 
2652 /// Emit an ARC autorelease of the result of a function.
2653 ///
2654 /// \return the value to actually return from the function
2655 static llvm::Value *emitAutoreleaseOfResult(CodeGenFunction &CGF,
2656                                             llvm::Value *result) {
2657   // If we're returning 'self', kill the initial retain.  This is a
2658   // heuristic attempt to "encourage correctness" in the really unfortunate
2659   // case where we have a return of self during a dealloc and we desperately
2660   // need to avoid the possible autorelease.
2661   if (llvm::Value *self = tryRemoveRetainOfSelf(CGF, result))
2662     return self;
2663 
2664   // At -O0, try to emit a fused retain/autorelease.
2665   if (CGF.shouldUseFusedARCCalls())
2666     if (llvm::Value *fused = tryEmitFusedAutoreleaseOfResult(CGF, result))
2667       return fused;
2668 
2669   return CGF.EmitARCAutoreleaseReturnValue(result);
2670 }
2671 
2672 /// Heuristically search for a dominating store to the return-value slot.
2673 static llvm::StoreInst *findDominatingStoreToReturnValue(CodeGenFunction &CGF) {
2674   // Check if a User is a store which pointerOperand is the ReturnValue.
2675   // We are looking for stores to the ReturnValue, not for stores of the
2676   // ReturnValue to some other location.
2677   auto GetStoreIfValid = [&CGF](llvm::User *U) -> llvm::StoreInst * {
2678     auto *SI = dyn_cast<llvm::StoreInst>(U);
2679     if (!SI || SI->getPointerOperand() != CGF.ReturnValue.getPointer())
2680       return nullptr;
2681     // These aren't actually possible for non-coerced returns, and we
2682     // only care about non-coerced returns on this code path.
2683     assert(!SI->isAtomic() && !SI->isVolatile());
2684     return SI;
2685   };
2686   // If there are multiple uses of the return-value slot, just check
2687   // for something immediately preceding the IP.  Sometimes this can
2688   // happen with how we generate implicit-returns; it can also happen
2689   // with noreturn cleanups.
2690   if (!CGF.ReturnValue.getPointer()->hasOneUse()) {
2691     llvm::BasicBlock *IP = CGF.Builder.GetInsertBlock();
2692     if (IP->empty()) return nullptr;
2693     llvm::Instruction *I = &IP->back();
2694 
2695     // Skip lifetime markers
2696     for (llvm::BasicBlock::reverse_iterator II = IP->rbegin(),
2697                                             IE = IP->rend();
2698          II != IE; ++II) {
2699       if (llvm::IntrinsicInst *Intrinsic =
2700               dyn_cast<llvm::IntrinsicInst>(&*II)) {
2701         if (Intrinsic->getIntrinsicID() == llvm::Intrinsic::lifetime_end) {
2702           const llvm::Value *CastAddr = Intrinsic->getArgOperand(1);
2703           ++II;
2704           if (II == IE)
2705             break;
2706           if (isa<llvm::BitCastInst>(&*II) && (CastAddr == &*II))
2707             continue;
2708         }
2709       }
2710       I = &*II;
2711       break;
2712     }
2713 
2714     return GetStoreIfValid(I);
2715   }
2716 
2717   llvm::StoreInst *store =
2718       GetStoreIfValid(CGF.ReturnValue.getPointer()->user_back());
2719   if (!store) return nullptr;
2720 
2721   // Now do a first-and-dirty dominance check: just walk up the
2722   // single-predecessors chain from the current insertion point.
2723   llvm::BasicBlock *StoreBB = store->getParent();
2724   llvm::BasicBlock *IP = CGF.Builder.GetInsertBlock();
2725   while (IP != StoreBB) {
2726     if (!(IP = IP->getSinglePredecessor()))
2727       return nullptr;
2728   }
2729 
2730   // Okay, the store's basic block dominates the insertion point; we
2731   // can do our thing.
2732   return store;
2733 }
2734 
2735 void CodeGenFunction::EmitFunctionEpilog(const CGFunctionInfo &FI,
2736                                          bool EmitRetDbgLoc,
2737                                          SourceLocation EndLoc) {
2738   if (FI.isNoReturn()) {
2739     // Noreturn functions don't return.
2740     EmitUnreachable(EndLoc);
2741     return;
2742   }
2743 
2744   if (CurCodeDecl && CurCodeDecl->hasAttr<NakedAttr>()) {
2745     // Naked functions don't have epilogues.
2746     Builder.CreateUnreachable();
2747     return;
2748   }
2749 
2750   // Functions with no result always return void.
2751   if (!ReturnValue.isValid()) {
2752     Builder.CreateRetVoid();
2753     return;
2754   }
2755 
2756   llvm::DebugLoc RetDbgLoc;
2757   llvm::Value *RV = nullptr;
2758   QualType RetTy = FI.getReturnType();
2759   const ABIArgInfo &RetAI = FI.getReturnInfo();
2760 
2761   switch (RetAI.getKind()) {
2762   case ABIArgInfo::InAlloca:
2763     // Aggregrates get evaluated directly into the destination.  Sometimes we
2764     // need to return the sret value in a register, though.
2765     assert(hasAggregateEvaluationKind(RetTy));
2766     if (RetAI.getInAllocaSRet()) {
2767       llvm::Function::arg_iterator EI = CurFn->arg_end();
2768       --EI;
2769       llvm::Value *ArgStruct = &*EI;
2770       llvm::Value *SRet = Builder.CreateStructGEP(
2771           nullptr, ArgStruct, RetAI.getInAllocaFieldIndex());
2772       RV = Builder.CreateAlignedLoad(SRet, getPointerAlign(), "sret");
2773     }
2774     break;
2775 
2776   case ABIArgInfo::Indirect: {
2777     auto AI = CurFn->arg_begin();
2778     if (RetAI.isSRetAfterThis())
2779       ++AI;
2780     switch (getEvaluationKind(RetTy)) {
2781     case TEK_Complex: {
2782       ComplexPairTy RT =
2783         EmitLoadOfComplex(MakeAddrLValue(ReturnValue, RetTy), EndLoc);
2784       EmitStoreOfComplex(RT, MakeNaturalAlignAddrLValue(&*AI, RetTy),
2785                          /*isInit*/ true);
2786       break;
2787     }
2788     case TEK_Aggregate:
2789       // Do nothing; aggregrates get evaluated directly into the destination.
2790       break;
2791     case TEK_Scalar:
2792       EmitStoreOfScalar(Builder.CreateLoad(ReturnValue),
2793                         MakeNaturalAlignAddrLValue(&*AI, RetTy),
2794                         /*isInit*/ true);
2795       break;
2796     }
2797     break;
2798   }
2799 
2800   case ABIArgInfo::Extend:
2801   case ABIArgInfo::Direct:
2802     if (RetAI.getCoerceToType() == ConvertType(RetTy) &&
2803         RetAI.getDirectOffset() == 0) {
2804       // The internal return value temp always will have pointer-to-return-type
2805       // type, just do a load.
2806 
2807       // If there is a dominating store to ReturnValue, we can elide
2808       // the load, zap the store, and usually zap the alloca.
2809       if (llvm::StoreInst *SI =
2810               findDominatingStoreToReturnValue(*this)) {
2811         // Reuse the debug location from the store unless there is
2812         // cleanup code to be emitted between the store and return
2813         // instruction.
2814         if (EmitRetDbgLoc && !AutoreleaseResult)
2815           RetDbgLoc = SI->getDebugLoc();
2816         // Get the stored value and nuke the now-dead store.
2817         RV = SI->getValueOperand();
2818         SI->eraseFromParent();
2819 
2820         // If that was the only use of the return value, nuke it as well now.
2821         auto returnValueInst = ReturnValue.getPointer();
2822         if (returnValueInst->use_empty()) {
2823           if (auto alloca = dyn_cast<llvm::AllocaInst>(returnValueInst)) {
2824             alloca->eraseFromParent();
2825             ReturnValue = Address::invalid();
2826           }
2827         }
2828 
2829       // Otherwise, we have to do a simple load.
2830       } else {
2831         RV = Builder.CreateLoad(ReturnValue);
2832       }
2833     } else {
2834       // If the value is offset in memory, apply the offset now.
2835       Address V = emitAddressAtOffset(*this, ReturnValue, RetAI);
2836 
2837       RV = CreateCoercedLoad(V, RetAI.getCoerceToType(), *this);
2838     }
2839 
2840     // In ARC, end functions that return a retainable type with a call
2841     // to objc_autoreleaseReturnValue.
2842     if (AutoreleaseResult) {
2843 #ifndef NDEBUG
2844       // Type::isObjCRetainabletype has to be called on a QualType that hasn't
2845       // been stripped of the typedefs, so we cannot use RetTy here. Get the
2846       // original return type of FunctionDecl, CurCodeDecl, and BlockDecl from
2847       // CurCodeDecl or BlockInfo.
2848       QualType RT;
2849 
2850       if (auto *FD = dyn_cast<FunctionDecl>(CurCodeDecl))
2851         RT = FD->getReturnType();
2852       else if (auto *MD = dyn_cast<ObjCMethodDecl>(CurCodeDecl))
2853         RT = MD->getReturnType();
2854       else if (isa<BlockDecl>(CurCodeDecl))
2855         RT = BlockInfo->BlockExpression->getFunctionType()->getReturnType();
2856       else
2857         llvm_unreachable("Unexpected function/method type");
2858 
2859       assert(getLangOpts().ObjCAutoRefCount &&
2860              !FI.isReturnsRetained() &&
2861              RT->isObjCRetainableType());
2862 #endif
2863       RV = emitAutoreleaseOfResult(*this, RV);
2864     }
2865 
2866     break;
2867 
2868   case ABIArgInfo::Ignore:
2869     break;
2870 
2871   case ABIArgInfo::CoerceAndExpand: {
2872     auto coercionType = RetAI.getCoerceAndExpandType();
2873     auto layout = CGM.getDataLayout().getStructLayout(coercionType);
2874 
2875     // Load all of the coerced elements out into results.
2876     llvm::SmallVector<llvm::Value*, 4> results;
2877     Address addr = Builder.CreateElementBitCast(ReturnValue, coercionType);
2878     for (unsigned i = 0, e = coercionType->getNumElements(); i != e; ++i) {
2879       auto coercedEltType = coercionType->getElementType(i);
2880       if (ABIArgInfo::isPaddingForCoerceAndExpand(coercedEltType))
2881         continue;
2882 
2883       auto eltAddr = Builder.CreateStructGEP(addr, i, layout);
2884       auto elt = Builder.CreateLoad(eltAddr);
2885       results.push_back(elt);
2886     }
2887 
2888     // If we have one result, it's the single direct result type.
2889     if (results.size() == 1) {
2890       RV = results[0];
2891 
2892     // Otherwise, we need to make a first-class aggregate.
2893     } else {
2894       // Construct a return type that lacks padding elements.
2895       llvm::Type *returnType = RetAI.getUnpaddedCoerceAndExpandType();
2896 
2897       RV = llvm::UndefValue::get(returnType);
2898       for (unsigned i = 0, e = results.size(); i != e; ++i) {
2899         RV = Builder.CreateInsertValue(RV, results[i], i);
2900       }
2901     }
2902     break;
2903   }
2904 
2905   case ABIArgInfo::Expand:
2906     llvm_unreachable("Invalid ABI kind for return argument");
2907   }
2908 
2909   llvm::Instruction *Ret;
2910   if (RV) {
2911     EmitReturnValueCheck(RV);
2912     Ret = Builder.CreateRet(RV);
2913   } else {
2914     Ret = Builder.CreateRetVoid();
2915   }
2916 
2917   if (RetDbgLoc)
2918     Ret->setDebugLoc(std::move(RetDbgLoc));
2919 }
2920 
2921 void CodeGenFunction::EmitReturnValueCheck(llvm::Value *RV) {
2922   // A current decl may not be available when emitting vtable thunks.
2923   if (!CurCodeDecl)
2924     return;
2925 
2926   ReturnsNonNullAttr *RetNNAttr = nullptr;
2927   if (SanOpts.has(SanitizerKind::ReturnsNonnullAttribute))
2928     RetNNAttr = CurCodeDecl->getAttr<ReturnsNonNullAttr>();
2929 
2930   if (!RetNNAttr && !requiresReturnValueNullabilityCheck())
2931     return;
2932 
2933   // Prefer the returns_nonnull attribute if it's present.
2934   SourceLocation AttrLoc;
2935   SanitizerMask CheckKind;
2936   SanitizerHandler Handler;
2937   if (RetNNAttr) {
2938     assert(!requiresReturnValueNullabilityCheck() &&
2939            "Cannot check nullability and the nonnull attribute");
2940     AttrLoc = RetNNAttr->getLocation();
2941     CheckKind = SanitizerKind::ReturnsNonnullAttribute;
2942     Handler = SanitizerHandler::NonnullReturn;
2943   } else {
2944     if (auto *DD = dyn_cast<DeclaratorDecl>(CurCodeDecl))
2945       if (auto *TSI = DD->getTypeSourceInfo())
2946         if (auto FTL = TSI->getTypeLoc().castAs<FunctionTypeLoc>())
2947           AttrLoc = FTL.getReturnLoc().findNullabilityLoc();
2948     CheckKind = SanitizerKind::NullabilityReturn;
2949     Handler = SanitizerHandler::NullabilityReturn;
2950   }
2951 
2952   SanitizerScope SanScope(this);
2953 
2954   // Make sure the "return" source location is valid. If we're checking a
2955   // nullability annotation, make sure the preconditions for the check are met.
2956   llvm::BasicBlock *Check = createBasicBlock("nullcheck");
2957   llvm::BasicBlock *NoCheck = createBasicBlock("no.nullcheck");
2958   llvm::Value *SLocPtr = Builder.CreateLoad(ReturnLocation, "return.sloc.load");
2959   llvm::Value *CanNullCheck = Builder.CreateIsNotNull(SLocPtr);
2960   if (requiresReturnValueNullabilityCheck())
2961     CanNullCheck =
2962         Builder.CreateAnd(CanNullCheck, RetValNullabilityPrecondition);
2963   Builder.CreateCondBr(CanNullCheck, Check, NoCheck);
2964   EmitBlock(Check);
2965 
2966   // Now do the null check.
2967   llvm::Value *Cond = Builder.CreateIsNotNull(RV);
2968   llvm::Constant *StaticData[] = {EmitCheckSourceLocation(AttrLoc)};
2969   llvm::Value *DynamicData[] = {SLocPtr};
2970   EmitCheck(std::make_pair(Cond, CheckKind), Handler, StaticData, DynamicData);
2971 
2972   EmitBlock(NoCheck);
2973 
2974 #ifndef NDEBUG
2975   // The return location should not be used after the check has been emitted.
2976   ReturnLocation = Address::invalid();
2977 #endif
2978 }
2979 
2980 static bool isInAllocaArgument(CGCXXABI &ABI, QualType type) {
2981   const CXXRecordDecl *RD = type->getAsCXXRecordDecl();
2982   return RD && ABI.getRecordArgABI(RD) == CGCXXABI::RAA_DirectInMemory;
2983 }
2984 
2985 static AggValueSlot createPlaceholderSlot(CodeGenFunction &CGF,
2986                                           QualType Ty) {
2987   // FIXME: Generate IR in one pass, rather than going back and fixing up these
2988   // placeholders.
2989   llvm::Type *IRTy = CGF.ConvertTypeForMem(Ty);
2990   llvm::Type *IRPtrTy = IRTy->getPointerTo();
2991   llvm::Value *Placeholder = llvm::UndefValue::get(IRPtrTy->getPointerTo());
2992 
2993   // FIXME: When we generate this IR in one pass, we shouldn't need
2994   // this win32-specific alignment hack.
2995   CharUnits Align = CharUnits::fromQuantity(4);
2996   Placeholder = CGF.Builder.CreateAlignedLoad(IRPtrTy, Placeholder, Align);
2997 
2998   return AggValueSlot::forAddr(Address(Placeholder, Align),
2999                                Ty.getQualifiers(),
3000                                AggValueSlot::IsNotDestructed,
3001                                AggValueSlot::DoesNotNeedGCBarriers,
3002                                AggValueSlot::IsNotAliased);
3003 }
3004 
3005 void CodeGenFunction::EmitDelegateCallArg(CallArgList &args,
3006                                           const VarDecl *param,
3007                                           SourceLocation loc) {
3008   // StartFunction converted the ABI-lowered parameter(s) into a
3009   // local alloca.  We need to turn that into an r-value suitable
3010   // for EmitCall.
3011   Address local = GetAddrOfLocalVar(param);
3012 
3013   QualType type = param->getType();
3014 
3015   assert(!isInAllocaArgument(CGM.getCXXABI(), type) &&
3016          "cannot emit delegate call arguments for inalloca arguments!");
3017 
3018   // GetAddrOfLocalVar returns a pointer-to-pointer for references,
3019   // but the argument needs to be the original pointer.
3020   if (type->isReferenceType()) {
3021     args.add(RValue::get(Builder.CreateLoad(local)), type);
3022 
3023   // In ARC, move out of consumed arguments so that the release cleanup
3024   // entered by StartFunction doesn't cause an over-release.  This isn't
3025   // optimal -O0 code generation, but it should get cleaned up when
3026   // optimization is enabled.  This also assumes that delegate calls are
3027   // performed exactly once for a set of arguments, but that should be safe.
3028   } else if (getLangOpts().ObjCAutoRefCount &&
3029              param->hasAttr<NSConsumedAttr>() &&
3030              type->isObjCRetainableType()) {
3031     llvm::Value *ptr = Builder.CreateLoad(local);
3032     auto null =
3033       llvm::ConstantPointerNull::get(cast<llvm::PointerType>(ptr->getType()));
3034     Builder.CreateStore(null, local);
3035     args.add(RValue::get(ptr), type);
3036 
3037   // For the most part, we just need to load the alloca, except that
3038   // aggregate r-values are actually pointers to temporaries.
3039   } else {
3040     args.add(convertTempToRValue(local, type, loc), type);
3041   }
3042 }
3043 
3044 static bool isProvablyNull(llvm::Value *addr) {
3045   return isa<llvm::ConstantPointerNull>(addr);
3046 }
3047 
3048 /// Emit the actual writing-back of a writeback.
3049 static void emitWriteback(CodeGenFunction &CGF,
3050                           const CallArgList::Writeback &writeback) {
3051   const LValue &srcLV = writeback.Source;
3052   Address srcAddr = srcLV.getAddress();
3053   assert(!isProvablyNull(srcAddr.getPointer()) &&
3054          "shouldn't have writeback for provably null argument");
3055 
3056   llvm::BasicBlock *contBB = nullptr;
3057 
3058   // If the argument wasn't provably non-null, we need to null check
3059   // before doing the store.
3060   bool provablyNonNull = llvm::isKnownNonZero(srcAddr.getPointer(),
3061                                               CGF.CGM.getDataLayout());
3062   if (!provablyNonNull) {
3063     llvm::BasicBlock *writebackBB = CGF.createBasicBlock("icr.writeback");
3064     contBB = CGF.createBasicBlock("icr.done");
3065 
3066     llvm::Value *isNull =
3067       CGF.Builder.CreateIsNull(srcAddr.getPointer(), "icr.isnull");
3068     CGF.Builder.CreateCondBr(isNull, contBB, writebackBB);
3069     CGF.EmitBlock(writebackBB);
3070   }
3071 
3072   // Load the value to writeback.
3073   llvm::Value *value = CGF.Builder.CreateLoad(writeback.Temporary);
3074 
3075   // Cast it back, in case we're writing an id to a Foo* or something.
3076   value = CGF.Builder.CreateBitCast(value, srcAddr.getElementType(),
3077                                     "icr.writeback-cast");
3078 
3079   // Perform the writeback.
3080 
3081   // If we have a "to use" value, it's something we need to emit a use
3082   // of.  This has to be carefully threaded in: if it's done after the
3083   // release it's potentially undefined behavior (and the optimizer
3084   // will ignore it), and if it happens before the retain then the
3085   // optimizer could move the release there.
3086   if (writeback.ToUse) {
3087     assert(srcLV.getObjCLifetime() == Qualifiers::OCL_Strong);
3088 
3089     // Retain the new value.  No need to block-copy here:  the block's
3090     // being passed up the stack.
3091     value = CGF.EmitARCRetainNonBlock(value);
3092 
3093     // Emit the intrinsic use here.
3094     CGF.EmitARCIntrinsicUse(writeback.ToUse);
3095 
3096     // Load the old value (primitively).
3097     llvm::Value *oldValue = CGF.EmitLoadOfScalar(srcLV, SourceLocation());
3098 
3099     // Put the new value in place (primitively).
3100     CGF.EmitStoreOfScalar(value, srcLV, /*init*/ false);
3101 
3102     // Release the old value.
3103     CGF.EmitARCRelease(oldValue, srcLV.isARCPreciseLifetime());
3104 
3105   // Otherwise, we can just do a normal lvalue store.
3106   } else {
3107     CGF.EmitStoreThroughLValue(RValue::get(value), srcLV);
3108   }
3109 
3110   // Jump to the continuation block.
3111   if (!provablyNonNull)
3112     CGF.EmitBlock(contBB);
3113 }
3114 
3115 static void emitWritebacks(CodeGenFunction &CGF,
3116                            const CallArgList &args) {
3117   for (const auto &I : args.writebacks())
3118     emitWriteback(CGF, I);
3119 }
3120 
3121 static void deactivateArgCleanupsBeforeCall(CodeGenFunction &CGF,
3122                                             const CallArgList &CallArgs) {
3123   ArrayRef<CallArgList::CallArgCleanup> Cleanups =
3124     CallArgs.getCleanupsToDeactivate();
3125   // Iterate in reverse to increase the likelihood of popping the cleanup.
3126   for (const auto &I : llvm::reverse(Cleanups)) {
3127     CGF.DeactivateCleanupBlock(I.Cleanup, I.IsActiveIP);
3128     I.IsActiveIP->eraseFromParent();
3129   }
3130 }
3131 
3132 static const Expr *maybeGetUnaryAddrOfOperand(const Expr *E) {
3133   if (const UnaryOperator *uop = dyn_cast<UnaryOperator>(E->IgnoreParens()))
3134     if (uop->getOpcode() == UO_AddrOf)
3135       return uop->getSubExpr();
3136   return nullptr;
3137 }
3138 
3139 /// Emit an argument that's being passed call-by-writeback.  That is,
3140 /// we are passing the address of an __autoreleased temporary; it
3141 /// might be copy-initialized with the current value of the given
3142 /// address, but it will definitely be copied out of after the call.
3143 static void emitWritebackArg(CodeGenFunction &CGF, CallArgList &args,
3144                              const ObjCIndirectCopyRestoreExpr *CRE) {
3145   LValue srcLV;
3146 
3147   // Make an optimistic effort to emit the address as an l-value.
3148   // This can fail if the argument expression is more complicated.
3149   if (const Expr *lvExpr = maybeGetUnaryAddrOfOperand(CRE->getSubExpr())) {
3150     srcLV = CGF.EmitLValue(lvExpr);
3151 
3152   // Otherwise, just emit it as a scalar.
3153   } else {
3154     Address srcAddr = CGF.EmitPointerWithAlignment(CRE->getSubExpr());
3155 
3156     QualType srcAddrType =
3157       CRE->getSubExpr()->getType()->castAs<PointerType>()->getPointeeType();
3158     srcLV = CGF.MakeAddrLValue(srcAddr, srcAddrType);
3159   }
3160   Address srcAddr = srcLV.getAddress();
3161 
3162   // The dest and src types don't necessarily match in LLVM terms
3163   // because of the crazy ObjC compatibility rules.
3164 
3165   llvm::PointerType *destType =
3166     cast<llvm::PointerType>(CGF.ConvertType(CRE->getType()));
3167 
3168   // If the address is a constant null, just pass the appropriate null.
3169   if (isProvablyNull(srcAddr.getPointer())) {
3170     args.add(RValue::get(llvm::ConstantPointerNull::get(destType)),
3171              CRE->getType());
3172     return;
3173   }
3174 
3175   // Create the temporary.
3176   Address temp = CGF.CreateTempAlloca(destType->getElementType(),
3177                                       CGF.getPointerAlign(),
3178                                       "icr.temp");
3179   // Loading an l-value can introduce a cleanup if the l-value is __weak,
3180   // and that cleanup will be conditional if we can't prove that the l-value
3181   // isn't null, so we need to register a dominating point so that the cleanups
3182   // system will make valid IR.
3183   CodeGenFunction::ConditionalEvaluation condEval(CGF);
3184 
3185   // Zero-initialize it if we're not doing a copy-initialization.
3186   bool shouldCopy = CRE->shouldCopy();
3187   if (!shouldCopy) {
3188     llvm::Value *null =
3189       llvm::ConstantPointerNull::get(
3190         cast<llvm::PointerType>(destType->getElementType()));
3191     CGF.Builder.CreateStore(null, temp);
3192   }
3193 
3194   llvm::BasicBlock *contBB = nullptr;
3195   llvm::BasicBlock *originBB = nullptr;
3196 
3197   // If the address is *not* known to be non-null, we need to switch.
3198   llvm::Value *finalArgument;
3199 
3200   bool provablyNonNull = llvm::isKnownNonZero(srcAddr.getPointer(),
3201                                               CGF.CGM.getDataLayout());
3202   if (provablyNonNull) {
3203     finalArgument = temp.getPointer();
3204   } else {
3205     llvm::Value *isNull =
3206       CGF.Builder.CreateIsNull(srcAddr.getPointer(), "icr.isnull");
3207 
3208     finalArgument = CGF.Builder.CreateSelect(isNull,
3209                                    llvm::ConstantPointerNull::get(destType),
3210                                              temp.getPointer(), "icr.argument");
3211 
3212     // If we need to copy, then the load has to be conditional, which
3213     // means we need control flow.
3214     if (shouldCopy) {
3215       originBB = CGF.Builder.GetInsertBlock();
3216       contBB = CGF.createBasicBlock("icr.cont");
3217       llvm::BasicBlock *copyBB = CGF.createBasicBlock("icr.copy");
3218       CGF.Builder.CreateCondBr(isNull, contBB, copyBB);
3219       CGF.EmitBlock(copyBB);
3220       condEval.begin(CGF);
3221     }
3222   }
3223 
3224   llvm::Value *valueToUse = nullptr;
3225 
3226   // Perform a copy if necessary.
3227   if (shouldCopy) {
3228     RValue srcRV = CGF.EmitLoadOfLValue(srcLV, SourceLocation());
3229     assert(srcRV.isScalar());
3230 
3231     llvm::Value *src = srcRV.getScalarVal();
3232     src = CGF.Builder.CreateBitCast(src, destType->getElementType(),
3233                                     "icr.cast");
3234 
3235     // Use an ordinary store, not a store-to-lvalue.
3236     CGF.Builder.CreateStore(src, temp);
3237 
3238     // If optimization is enabled, and the value was held in a
3239     // __strong variable, we need to tell the optimizer that this
3240     // value has to stay alive until we're doing the store back.
3241     // This is because the temporary is effectively unretained,
3242     // and so otherwise we can violate the high-level semantics.
3243     if (CGF.CGM.getCodeGenOpts().OptimizationLevel != 0 &&
3244         srcLV.getObjCLifetime() == Qualifiers::OCL_Strong) {
3245       valueToUse = src;
3246     }
3247   }
3248 
3249   // Finish the control flow if we needed it.
3250   if (shouldCopy && !provablyNonNull) {
3251     llvm::BasicBlock *copyBB = CGF.Builder.GetInsertBlock();
3252     CGF.EmitBlock(contBB);
3253 
3254     // Make a phi for the value to intrinsically use.
3255     if (valueToUse) {
3256       llvm::PHINode *phiToUse = CGF.Builder.CreatePHI(valueToUse->getType(), 2,
3257                                                       "icr.to-use");
3258       phiToUse->addIncoming(valueToUse, copyBB);
3259       phiToUse->addIncoming(llvm::UndefValue::get(valueToUse->getType()),
3260                             originBB);
3261       valueToUse = phiToUse;
3262     }
3263 
3264     condEval.end(CGF);
3265   }
3266 
3267   args.addWriteback(srcLV, temp, valueToUse);
3268   args.add(RValue::get(finalArgument), CRE->getType());
3269 }
3270 
3271 void CallArgList::allocateArgumentMemory(CodeGenFunction &CGF) {
3272   assert(!StackBase);
3273 
3274   // Save the stack.
3275   llvm::Function *F = CGF.CGM.getIntrinsic(llvm::Intrinsic::stacksave);
3276   StackBase = CGF.Builder.CreateCall(F, {}, "inalloca.save");
3277 }
3278 
3279 void CallArgList::freeArgumentMemory(CodeGenFunction &CGF) const {
3280   if (StackBase) {
3281     // Restore the stack after the call.
3282     llvm::Value *F = CGF.CGM.getIntrinsic(llvm::Intrinsic::stackrestore);
3283     CGF.Builder.CreateCall(F, StackBase);
3284   }
3285 }
3286 
3287 void CodeGenFunction::EmitNonNullArgCheck(RValue RV, QualType ArgType,
3288                                           SourceLocation ArgLoc,
3289                                           AbstractCallee AC,
3290                                           unsigned ParmNum) {
3291   if (!AC.getDecl() || !(SanOpts.has(SanitizerKind::NonnullAttribute) ||
3292                          SanOpts.has(SanitizerKind::NullabilityArg)))
3293     return;
3294 
3295   // The param decl may be missing in a variadic function.
3296   auto PVD = ParmNum < AC.getNumParams() ? AC.getParamDecl(ParmNum) : nullptr;
3297   unsigned ArgNo = PVD ? PVD->getFunctionScopeIndex() : ParmNum;
3298 
3299   // Prefer the nonnull attribute if it's present.
3300   const NonNullAttr *NNAttr = nullptr;
3301   if (SanOpts.has(SanitizerKind::NonnullAttribute))
3302     NNAttr = getNonNullAttr(AC.getDecl(), PVD, ArgType, ArgNo);
3303 
3304   bool CanCheckNullability = false;
3305   if (SanOpts.has(SanitizerKind::NullabilityArg) && !NNAttr && PVD) {
3306     auto Nullability = PVD->getType()->getNullability(getContext());
3307     CanCheckNullability = Nullability &&
3308                           *Nullability == NullabilityKind::NonNull &&
3309                           PVD->getTypeSourceInfo();
3310   }
3311 
3312   if (!NNAttr && !CanCheckNullability)
3313     return;
3314 
3315   SourceLocation AttrLoc;
3316   SanitizerMask CheckKind;
3317   SanitizerHandler Handler;
3318   if (NNAttr) {
3319     AttrLoc = NNAttr->getLocation();
3320     CheckKind = SanitizerKind::NonnullAttribute;
3321     Handler = SanitizerHandler::NonnullArg;
3322   } else {
3323     AttrLoc = PVD->getTypeSourceInfo()->getTypeLoc().findNullabilityLoc();
3324     CheckKind = SanitizerKind::NullabilityArg;
3325     Handler = SanitizerHandler::NullabilityArg;
3326   }
3327 
3328   SanitizerScope SanScope(this);
3329   assert(RV.isScalar());
3330   llvm::Value *V = RV.getScalarVal();
3331   llvm::Value *Cond =
3332       Builder.CreateICmpNE(V, llvm::Constant::getNullValue(V->getType()));
3333   llvm::Constant *StaticData[] = {
3334       EmitCheckSourceLocation(ArgLoc), EmitCheckSourceLocation(AttrLoc),
3335       llvm::ConstantInt::get(Int32Ty, ArgNo + 1),
3336   };
3337   EmitCheck(std::make_pair(Cond, CheckKind), Handler, StaticData, None);
3338 }
3339 
3340 void CodeGenFunction::EmitCallArgs(
3341     CallArgList &Args, ArrayRef<QualType> ArgTypes,
3342     llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
3343     AbstractCallee AC, unsigned ParamsToSkip, EvaluationOrder Order) {
3344   assert((int)ArgTypes.size() == (ArgRange.end() - ArgRange.begin()));
3345 
3346   // We *have* to evaluate arguments from right to left in the MS C++ ABI,
3347   // because arguments are destroyed left to right in the callee. As a special
3348   // case, there are certain language constructs that require left-to-right
3349   // evaluation, and in those cases we consider the evaluation order requirement
3350   // to trump the "destruction order is reverse construction order" guarantee.
3351   bool LeftToRight =
3352       CGM.getTarget().getCXXABI().areArgsDestroyedLeftToRightInCallee()
3353           ? Order == EvaluationOrder::ForceLeftToRight
3354           : Order != EvaluationOrder::ForceRightToLeft;
3355 
3356   auto MaybeEmitImplicitObjectSize = [&](unsigned I, const Expr *Arg,
3357                                          RValue EmittedArg) {
3358     if (!AC.hasFunctionDecl() || I >= AC.getNumParams())
3359       return;
3360     auto *PS = AC.getParamDecl(I)->getAttr<PassObjectSizeAttr>();
3361     if (PS == nullptr)
3362       return;
3363 
3364     const auto &Context = getContext();
3365     auto SizeTy = Context.getSizeType();
3366     auto T = Builder.getIntNTy(Context.getTypeSize(SizeTy));
3367     assert(EmittedArg.getScalarVal() && "We emitted nothing for the arg?");
3368     llvm::Value *V = evaluateOrEmitBuiltinObjectSize(Arg, PS->getType(), T,
3369                                                      EmittedArg.getScalarVal());
3370     Args.add(RValue::get(V), SizeTy);
3371     // If we're emitting args in reverse, be sure to do so with
3372     // pass_object_size, as well.
3373     if (!LeftToRight)
3374       std::swap(Args.back(), *(&Args.back() - 1));
3375   };
3376 
3377   // Insert a stack save if we're going to need any inalloca args.
3378   bool HasInAllocaArgs = false;
3379   if (CGM.getTarget().getCXXABI().isMicrosoft()) {
3380     for (ArrayRef<QualType>::iterator I = ArgTypes.begin(), E = ArgTypes.end();
3381          I != E && !HasInAllocaArgs; ++I)
3382       HasInAllocaArgs = isInAllocaArgument(CGM.getCXXABI(), *I);
3383     if (HasInAllocaArgs) {
3384       assert(getTarget().getTriple().getArch() == llvm::Triple::x86);
3385       Args.allocateArgumentMemory(*this);
3386     }
3387   }
3388 
3389   // Evaluate each argument in the appropriate order.
3390   size_t CallArgsStart = Args.size();
3391   for (unsigned I = 0, E = ArgTypes.size(); I != E; ++I) {
3392     unsigned Idx = LeftToRight ? I : E - I - 1;
3393     CallExpr::const_arg_iterator Arg = ArgRange.begin() + Idx;
3394     unsigned InitialArgSize = Args.size();
3395     // If *Arg is an ObjCIndirectCopyRestoreExpr, check that either the types of
3396     // the argument and parameter match or the objc method is parameterized.
3397     assert((!isa<ObjCIndirectCopyRestoreExpr>(*Arg) ||
3398             getContext().hasSameUnqualifiedType((*Arg)->getType(),
3399                                                 ArgTypes[Idx]) ||
3400             (isa<ObjCMethodDecl>(AC.getDecl()) &&
3401              isObjCMethodWithTypeParams(cast<ObjCMethodDecl>(AC.getDecl())))) &&
3402            "Argument and parameter types don't match");
3403     EmitCallArg(Args, *Arg, ArgTypes[Idx]);
3404     // In particular, we depend on it being the last arg in Args, and the
3405     // objectsize bits depend on there only being one arg if !LeftToRight.
3406     assert(InitialArgSize + 1 == Args.size() &&
3407            "The code below depends on only adding one arg per EmitCallArg");
3408     (void)InitialArgSize;
3409     RValue RVArg = Args.back().RV;
3410     EmitNonNullArgCheck(RVArg, ArgTypes[Idx], (*Arg)->getExprLoc(), AC,
3411                         ParamsToSkip + Idx);
3412     // @llvm.objectsize should never have side-effects and shouldn't need
3413     // destruction/cleanups, so we can safely "emit" it after its arg,
3414     // regardless of right-to-leftness
3415     MaybeEmitImplicitObjectSize(Idx, *Arg, RVArg);
3416   }
3417 
3418   if (!LeftToRight) {
3419     // Un-reverse the arguments we just evaluated so they match up with the LLVM
3420     // IR function.
3421     std::reverse(Args.begin() + CallArgsStart, Args.end());
3422   }
3423 }
3424 
3425 namespace {
3426 
3427 struct DestroyUnpassedArg final : EHScopeStack::Cleanup {
3428   DestroyUnpassedArg(Address Addr, QualType Ty)
3429       : Addr(Addr), Ty(Ty) {}
3430 
3431   Address Addr;
3432   QualType Ty;
3433 
3434   void Emit(CodeGenFunction &CGF, Flags flags) override {
3435     const CXXDestructorDecl *Dtor = Ty->getAsCXXRecordDecl()->getDestructor();
3436     assert(!Dtor->isTrivial());
3437     CGF.EmitCXXDestructorCall(Dtor, Dtor_Complete, /*for vbase*/ false,
3438                               /*Delegating=*/false, Addr);
3439   }
3440 };
3441 
3442 struct DisableDebugLocationUpdates {
3443   CodeGenFunction &CGF;
3444   bool disabledDebugInfo;
3445   DisableDebugLocationUpdates(CodeGenFunction &CGF, const Expr *E) : CGF(CGF) {
3446     if ((disabledDebugInfo = isa<CXXDefaultArgExpr>(E) && CGF.getDebugInfo()))
3447       CGF.disableDebugInfo();
3448   }
3449   ~DisableDebugLocationUpdates() {
3450     if (disabledDebugInfo)
3451       CGF.enableDebugInfo();
3452   }
3453 };
3454 
3455 } // end anonymous namespace
3456 
3457 void CodeGenFunction::EmitCallArg(CallArgList &args, const Expr *E,
3458                                   QualType type) {
3459   DisableDebugLocationUpdates Dis(*this, E);
3460   if (const ObjCIndirectCopyRestoreExpr *CRE
3461         = dyn_cast<ObjCIndirectCopyRestoreExpr>(E)) {
3462     assert(getLangOpts().ObjCAutoRefCount);
3463     return emitWritebackArg(*this, args, CRE);
3464   }
3465 
3466   assert(type->isReferenceType() == E->isGLValue() &&
3467          "reference binding to unmaterialized r-value!");
3468 
3469   if (E->isGLValue()) {
3470     assert(E->getObjectKind() == OK_Ordinary);
3471     return args.add(EmitReferenceBindingToExpr(E), type);
3472   }
3473 
3474   bool HasAggregateEvalKind = hasAggregateEvaluationKind(type);
3475 
3476   // In the Microsoft C++ ABI, aggregate arguments are destructed by the callee.
3477   // However, we still have to push an EH-only cleanup in case we unwind before
3478   // we make it to the call.
3479   if (HasAggregateEvalKind && getContext().isParamDestroyedInCallee(type)) {
3480     // If we're using inalloca, use the argument memory.  Otherwise, use a
3481     // temporary.
3482     AggValueSlot Slot;
3483     if (args.isUsingInAlloca())
3484       Slot = createPlaceholderSlot(*this, type);
3485     else
3486       Slot = CreateAggTemp(type, "agg.tmp");
3487 
3488     const CXXRecordDecl *RD = type->getAsCXXRecordDecl();
3489     bool DestroyedInCallee =
3490         RD && RD->hasNonTrivialDestructor() &&
3491         (CGM.getCXXABI().getRecordArgABI(RD) != CGCXXABI::RAA_Default ||
3492          RD->hasTrivialABIOverride());
3493     if (DestroyedInCallee)
3494       Slot.setExternallyDestructed();
3495 
3496     EmitAggExpr(E, Slot);
3497     RValue RV = Slot.asRValue();
3498     args.add(RV, type);
3499 
3500     if (DestroyedInCallee) {
3501       // Create a no-op GEP between the placeholder and the cleanup so we can
3502       // RAUW it successfully.  It also serves as a marker of the first
3503       // instruction where the cleanup is active.
3504       pushFullExprCleanup<DestroyUnpassedArg>(EHCleanup, Slot.getAddress(),
3505                                               type);
3506       // This unreachable is a temporary marker which will be removed later.
3507       llvm::Instruction *IsActive = Builder.CreateUnreachable();
3508       args.addArgCleanupDeactivation(EHStack.getInnermostEHScope(), IsActive);
3509     }
3510     return;
3511   }
3512 
3513   if (HasAggregateEvalKind && isa<ImplicitCastExpr>(E) &&
3514       cast<CastExpr>(E)->getCastKind() == CK_LValueToRValue) {
3515     LValue L = EmitLValue(cast<CastExpr>(E)->getSubExpr());
3516     assert(L.isSimple());
3517     if (L.getAlignment() >= getContext().getTypeAlignInChars(type)) {
3518       args.add(L.asAggregateRValue(), type, /*NeedsCopy*/true);
3519     } else {
3520       // We can't represent a misaligned lvalue in the CallArgList, so copy
3521       // to an aligned temporary now.
3522       LValue Dest = MakeAddrLValue(CreateMemTemp(type), type);
3523       EmitAggregateCopy(Dest, L, type, L.isVolatile());
3524       args.add(RValue::getAggregate(Dest.getAddress()), type);
3525     }
3526     return;
3527   }
3528 
3529   args.add(EmitAnyExprToTemp(E), type);
3530 }
3531 
3532 QualType CodeGenFunction::getVarArgType(const Expr *Arg) {
3533   // System headers on Windows define NULL to 0 instead of 0LL on Win64. MSVC
3534   // implicitly widens null pointer constants that are arguments to varargs
3535   // functions to pointer-sized ints.
3536   if (!getTarget().getTriple().isOSWindows())
3537     return Arg->getType();
3538 
3539   if (Arg->getType()->isIntegerType() &&
3540       getContext().getTypeSize(Arg->getType()) <
3541           getContext().getTargetInfo().getPointerWidth(0) &&
3542       Arg->isNullPointerConstant(getContext(),
3543                                  Expr::NPC_ValueDependentIsNotNull)) {
3544     return getContext().getIntPtrType();
3545   }
3546 
3547   return Arg->getType();
3548 }
3549 
3550 // In ObjC ARC mode with no ObjC ARC exception safety, tell the ARC
3551 // optimizer it can aggressively ignore unwind edges.
3552 void
3553 CodeGenFunction::AddObjCARCExceptionMetadata(llvm::Instruction *Inst) {
3554   if (CGM.getCodeGenOpts().OptimizationLevel != 0 &&
3555       !CGM.getCodeGenOpts().ObjCAutoRefCountExceptions)
3556     Inst->setMetadata("clang.arc.no_objc_arc_exceptions",
3557                       CGM.getNoObjCARCExceptionsMetadata());
3558 }
3559 
3560 /// Emits a call to the given no-arguments nounwind runtime function.
3561 llvm::CallInst *
3562 CodeGenFunction::EmitNounwindRuntimeCall(llvm::Value *callee,
3563                                          const llvm::Twine &name) {
3564   return EmitNounwindRuntimeCall(callee, None, name);
3565 }
3566 
3567 /// Emits a call to the given nounwind runtime function.
3568 llvm::CallInst *
3569 CodeGenFunction::EmitNounwindRuntimeCall(llvm::Value *callee,
3570                                          ArrayRef<llvm::Value*> args,
3571                                          const llvm::Twine &name) {
3572   llvm::CallInst *call = EmitRuntimeCall(callee, args, name);
3573   call->setDoesNotThrow();
3574   return call;
3575 }
3576 
3577 /// Emits a simple call (never an invoke) to the given no-arguments
3578 /// runtime function.
3579 llvm::CallInst *
3580 CodeGenFunction::EmitRuntimeCall(llvm::Value *callee,
3581                                  const llvm::Twine &name) {
3582   return EmitRuntimeCall(callee, None, name);
3583 }
3584 
3585 // Calls which may throw must have operand bundles indicating which funclet
3586 // they are nested within.
3587 SmallVector<llvm::OperandBundleDef, 1>
3588 CodeGenFunction::getBundlesForFunclet(llvm::Value *Callee) {
3589   SmallVector<llvm::OperandBundleDef, 1> BundleList;
3590   // There is no need for a funclet operand bundle if we aren't inside a
3591   // funclet.
3592   if (!CurrentFuncletPad)
3593     return BundleList;
3594 
3595   // Skip intrinsics which cannot throw.
3596   auto *CalleeFn = dyn_cast<llvm::Function>(Callee->stripPointerCasts());
3597   if (CalleeFn && CalleeFn->isIntrinsic() && CalleeFn->doesNotThrow())
3598     return BundleList;
3599 
3600   BundleList.emplace_back("funclet", CurrentFuncletPad);
3601   return BundleList;
3602 }
3603 
3604 /// Emits a simple call (never an invoke) to the given runtime function.
3605 llvm::CallInst *
3606 CodeGenFunction::EmitRuntimeCall(llvm::Value *callee,
3607                                  ArrayRef<llvm::Value*> args,
3608                                  const llvm::Twine &name) {
3609   llvm::CallInst *call =
3610       Builder.CreateCall(callee, args, getBundlesForFunclet(callee), name);
3611   call->setCallingConv(getRuntimeCC());
3612   return call;
3613 }
3614 
3615 /// Emits a call or invoke to the given noreturn runtime function.
3616 void CodeGenFunction::EmitNoreturnRuntimeCallOrInvoke(llvm::Value *callee,
3617                                                ArrayRef<llvm::Value*> args) {
3618   SmallVector<llvm::OperandBundleDef, 1> BundleList =
3619       getBundlesForFunclet(callee);
3620 
3621   if (getInvokeDest()) {
3622     llvm::InvokeInst *invoke =
3623       Builder.CreateInvoke(callee,
3624                            getUnreachableBlock(),
3625                            getInvokeDest(),
3626                            args,
3627                            BundleList);
3628     invoke->setDoesNotReturn();
3629     invoke->setCallingConv(getRuntimeCC());
3630   } else {
3631     llvm::CallInst *call = Builder.CreateCall(callee, args, BundleList);
3632     call->setDoesNotReturn();
3633     call->setCallingConv(getRuntimeCC());
3634     Builder.CreateUnreachable();
3635   }
3636 }
3637 
3638 /// Emits a call or invoke instruction to the given nullary runtime function.
3639 llvm::CallSite
3640 CodeGenFunction::EmitRuntimeCallOrInvoke(llvm::Value *callee,
3641                                          const Twine &name) {
3642   return EmitRuntimeCallOrInvoke(callee, None, name);
3643 }
3644 
3645 /// Emits a call or invoke instruction to the given runtime function.
3646 llvm::CallSite
3647 CodeGenFunction::EmitRuntimeCallOrInvoke(llvm::Value *callee,
3648                                          ArrayRef<llvm::Value*> args,
3649                                          const Twine &name) {
3650   llvm::CallSite callSite = EmitCallOrInvoke(callee, args, name);
3651   callSite.setCallingConv(getRuntimeCC());
3652   return callSite;
3653 }
3654 
3655 /// Emits a call or invoke instruction to the given function, depending
3656 /// on the current state of the EH stack.
3657 llvm::CallSite
3658 CodeGenFunction::EmitCallOrInvoke(llvm::Value *Callee,
3659                                   ArrayRef<llvm::Value *> Args,
3660                                   const Twine &Name) {
3661   llvm::BasicBlock *InvokeDest = getInvokeDest();
3662   SmallVector<llvm::OperandBundleDef, 1> BundleList =
3663       getBundlesForFunclet(Callee);
3664 
3665   llvm::Instruction *Inst;
3666   if (!InvokeDest)
3667     Inst = Builder.CreateCall(Callee, Args, BundleList, Name);
3668   else {
3669     llvm::BasicBlock *ContBB = createBasicBlock("invoke.cont");
3670     Inst = Builder.CreateInvoke(Callee, ContBB, InvokeDest, Args, BundleList,
3671                                 Name);
3672     EmitBlock(ContBB);
3673   }
3674 
3675   // In ObjC ARC mode with no ObjC ARC exception safety, tell the ARC
3676   // optimizer it can aggressively ignore unwind edges.
3677   if (CGM.getLangOpts().ObjCAutoRefCount)
3678     AddObjCARCExceptionMetadata(Inst);
3679 
3680   return llvm::CallSite(Inst);
3681 }
3682 
3683 /// \brief Store a non-aggregate value to an address to initialize it.  For
3684 /// initialization, a non-atomic store will be used.
3685 static void EmitInitStoreOfNonAggregate(CodeGenFunction &CGF, RValue Src,
3686                                         LValue Dst) {
3687   if (Src.isScalar())
3688     CGF.EmitStoreOfScalar(Src.getScalarVal(), Dst, /*init=*/true);
3689   else
3690     CGF.EmitStoreOfComplex(Src.getComplexVal(), Dst, /*init=*/true);
3691 }
3692 
3693 void CodeGenFunction::deferPlaceholderReplacement(llvm::Instruction *Old,
3694                                                   llvm::Value *New) {
3695   DeferredReplacements.push_back(std::make_pair(Old, New));
3696 }
3697 
3698 RValue CodeGenFunction::EmitCall(const CGFunctionInfo &CallInfo,
3699                                  const CGCallee &Callee,
3700                                  ReturnValueSlot ReturnValue,
3701                                  const CallArgList &CallArgs,
3702                                  llvm::Instruction **callOrInvoke,
3703                                  SourceLocation Loc) {
3704   // FIXME: We no longer need the types from CallArgs; lift up and simplify.
3705 
3706   assert(Callee.isOrdinary() || Callee.isVirtual());
3707 
3708   // Handle struct-return functions by passing a pointer to the
3709   // location that we would like to return into.
3710   QualType RetTy = CallInfo.getReturnType();
3711   const ABIArgInfo &RetAI = CallInfo.getReturnInfo();
3712 
3713   llvm::FunctionType *IRFuncTy = Callee.getFunctionType();
3714 
3715   // 1. Set up the arguments.
3716 
3717   // If we're using inalloca, insert the allocation after the stack save.
3718   // FIXME: Do this earlier rather than hacking it in here!
3719   Address ArgMemory = Address::invalid();
3720   const llvm::StructLayout *ArgMemoryLayout = nullptr;
3721   if (llvm::StructType *ArgStruct = CallInfo.getArgStruct()) {
3722     const llvm::DataLayout &DL = CGM.getDataLayout();
3723     ArgMemoryLayout = DL.getStructLayout(ArgStruct);
3724     llvm::Instruction *IP = CallArgs.getStackBase();
3725     llvm::AllocaInst *AI;
3726     if (IP) {
3727       IP = IP->getNextNode();
3728       AI = new llvm::AllocaInst(ArgStruct, DL.getAllocaAddrSpace(),
3729                                 "argmem", IP);
3730     } else {
3731       AI = CreateTempAlloca(ArgStruct, "argmem");
3732     }
3733     auto Align = CallInfo.getArgStructAlignment();
3734     AI->setAlignment(Align.getQuantity());
3735     AI->setUsedWithInAlloca(true);
3736     assert(AI->isUsedWithInAlloca() && !AI->isStaticAlloca());
3737     ArgMemory = Address(AI, Align);
3738   }
3739 
3740   // Helper function to drill into the inalloca allocation.
3741   auto createInAllocaStructGEP = [&](unsigned FieldIndex) -> Address {
3742     auto FieldOffset =
3743       CharUnits::fromQuantity(ArgMemoryLayout->getElementOffset(FieldIndex));
3744     return Builder.CreateStructGEP(ArgMemory, FieldIndex, FieldOffset);
3745   };
3746 
3747   ClangToLLVMArgMapping IRFunctionArgs(CGM.getContext(), CallInfo);
3748   SmallVector<llvm::Value *, 16> IRCallArgs(IRFunctionArgs.totalIRArgs());
3749 
3750   // If the call returns a temporary with struct return, create a temporary
3751   // alloca to hold the result, unless one is given to us.
3752   Address SRetPtr = Address::invalid();
3753   size_t UnusedReturnSize = 0;
3754   if (RetAI.isIndirect() || RetAI.isInAlloca() || RetAI.isCoerceAndExpand()) {
3755     if (!ReturnValue.isNull()) {
3756       SRetPtr = ReturnValue.getValue();
3757     } else {
3758       SRetPtr = CreateMemTemp(RetTy);
3759       if (HaveInsertPoint() && ReturnValue.isUnused()) {
3760         uint64_t size =
3761             CGM.getDataLayout().getTypeAllocSize(ConvertTypeForMem(RetTy));
3762         if (EmitLifetimeStart(size, SRetPtr.getPointer()))
3763           UnusedReturnSize = size;
3764       }
3765     }
3766     if (IRFunctionArgs.hasSRetArg()) {
3767       IRCallArgs[IRFunctionArgs.getSRetArgNo()] = SRetPtr.getPointer();
3768     } else if (RetAI.isInAlloca()) {
3769       Address Addr = createInAllocaStructGEP(RetAI.getInAllocaFieldIndex());
3770       Builder.CreateStore(SRetPtr.getPointer(), Addr);
3771     }
3772   }
3773 
3774   Address swiftErrorTemp = Address::invalid();
3775   Address swiftErrorArg = Address::invalid();
3776 
3777   // Translate all of the arguments as necessary to match the IR lowering.
3778   assert(CallInfo.arg_size() == CallArgs.size() &&
3779          "Mismatch between function signature & arguments.");
3780   unsigned ArgNo = 0;
3781   CGFunctionInfo::const_arg_iterator info_it = CallInfo.arg_begin();
3782   for (CallArgList::const_iterator I = CallArgs.begin(), E = CallArgs.end();
3783        I != E; ++I, ++info_it, ++ArgNo) {
3784     const ABIArgInfo &ArgInfo = info_it->info;
3785     RValue RV = I->RV;
3786 
3787     // Insert a padding argument to ensure proper alignment.
3788     if (IRFunctionArgs.hasPaddingArg(ArgNo))
3789       IRCallArgs[IRFunctionArgs.getPaddingArgNo(ArgNo)] =
3790           llvm::UndefValue::get(ArgInfo.getPaddingType());
3791 
3792     unsigned FirstIRArg, NumIRArgs;
3793     std::tie(FirstIRArg, NumIRArgs) = IRFunctionArgs.getIRArgs(ArgNo);
3794 
3795     switch (ArgInfo.getKind()) {
3796     case ABIArgInfo::InAlloca: {
3797       assert(NumIRArgs == 0);
3798       assert(getTarget().getTriple().getArch() == llvm::Triple::x86);
3799       if (RV.isAggregate()) {
3800         // Replace the placeholder with the appropriate argument slot GEP.
3801         llvm::Instruction *Placeholder =
3802             cast<llvm::Instruction>(RV.getAggregatePointer());
3803         CGBuilderTy::InsertPoint IP = Builder.saveIP();
3804         Builder.SetInsertPoint(Placeholder);
3805         Address Addr = createInAllocaStructGEP(ArgInfo.getInAllocaFieldIndex());
3806         Builder.restoreIP(IP);
3807         deferPlaceholderReplacement(Placeholder, Addr.getPointer());
3808       } else {
3809         // Store the RValue into the argument struct.
3810         Address Addr = createInAllocaStructGEP(ArgInfo.getInAllocaFieldIndex());
3811         unsigned AS = Addr.getType()->getPointerAddressSpace();
3812         llvm::Type *MemType = ConvertTypeForMem(I->Ty)->getPointerTo(AS);
3813         // There are some cases where a trivial bitcast is not avoidable.  The
3814         // definition of a type later in a translation unit may change it's type
3815         // from {}* to (%struct.foo*)*.
3816         if (Addr.getType() != MemType)
3817           Addr = Builder.CreateBitCast(Addr, MemType);
3818         LValue argLV = MakeAddrLValue(Addr, I->Ty);
3819         EmitInitStoreOfNonAggregate(*this, RV, argLV);
3820       }
3821       break;
3822     }
3823 
3824     case ABIArgInfo::Indirect: {
3825       assert(NumIRArgs == 1);
3826       if (RV.isScalar() || RV.isComplex()) {
3827         // Make a temporary alloca to pass the argument.
3828         Address Addr = CreateMemTemp(I->Ty, ArgInfo.getIndirectAlign(),
3829                                      "indirect-arg-temp", false);
3830         IRCallArgs[FirstIRArg] = Addr.getPointer();
3831 
3832         LValue argLV = MakeAddrLValue(Addr, I->Ty);
3833         EmitInitStoreOfNonAggregate(*this, RV, argLV);
3834       } else {
3835         // We want to avoid creating an unnecessary temporary+copy here;
3836         // however, we need one in three cases:
3837         // 1. If the argument is not byval, and we are required to copy the
3838         //    source.  (This case doesn't occur on any common architecture.)
3839         // 2. If the argument is byval, RV is not sufficiently aligned, and
3840         //    we cannot force it to be sufficiently aligned.
3841         // 3. If the argument is byval, but RV is located in an address space
3842         //    different than that of the argument (0).
3843         Address Addr = RV.getAggregateAddress();
3844         CharUnits Align = ArgInfo.getIndirectAlign();
3845         const llvm::DataLayout *TD = &CGM.getDataLayout();
3846         const unsigned RVAddrSpace = Addr.getType()->getAddressSpace();
3847         const unsigned ArgAddrSpace =
3848             (FirstIRArg < IRFuncTy->getNumParams()
3849                  ? IRFuncTy->getParamType(FirstIRArg)->getPointerAddressSpace()
3850                  : 0);
3851         if ((!ArgInfo.getIndirectByVal() && I->NeedsCopy) ||
3852             (ArgInfo.getIndirectByVal() && Addr.getAlignment() < Align &&
3853              llvm::getOrEnforceKnownAlignment(Addr.getPointer(),
3854                                               Align.getQuantity(), *TD)
3855                < Align.getQuantity()) ||
3856             (ArgInfo.getIndirectByVal() && (RVAddrSpace != ArgAddrSpace))) {
3857           // Create an aligned temporary, and copy to it.
3858           Address AI = CreateMemTemp(I->Ty, ArgInfo.getIndirectAlign(),
3859                                      "byval-temp", false);
3860           IRCallArgs[FirstIRArg] = AI.getPointer();
3861           LValue Dest = MakeAddrLValue(AI, I->Ty);
3862           LValue Src = MakeAddrLValue(Addr, I->Ty);
3863           EmitAggregateCopy(Dest, Src, I->Ty, RV.isVolatileQualified());
3864         } else {
3865           // Skip the extra memcpy call.
3866           IRCallArgs[FirstIRArg] = Addr.getPointer();
3867         }
3868       }
3869       break;
3870     }
3871 
3872     case ABIArgInfo::Ignore:
3873       assert(NumIRArgs == 0);
3874       break;
3875 
3876     case ABIArgInfo::Extend:
3877     case ABIArgInfo::Direct: {
3878       if (!isa<llvm::StructType>(ArgInfo.getCoerceToType()) &&
3879           ArgInfo.getCoerceToType() == ConvertType(info_it->type) &&
3880           ArgInfo.getDirectOffset() == 0) {
3881         assert(NumIRArgs == 1);
3882         llvm::Value *V;
3883         if (RV.isScalar())
3884           V = RV.getScalarVal();
3885         else
3886           V = Builder.CreateLoad(RV.getAggregateAddress());
3887 
3888         // Implement swifterror by copying into a new swifterror argument.
3889         // We'll write back in the normal path out of the call.
3890         if (CallInfo.getExtParameterInfo(ArgNo).getABI()
3891               == ParameterABI::SwiftErrorResult) {
3892           assert(!swiftErrorTemp.isValid() && "multiple swifterror args");
3893 
3894           QualType pointeeTy = I->Ty->getPointeeType();
3895           swiftErrorArg =
3896             Address(V, getContext().getTypeAlignInChars(pointeeTy));
3897 
3898           swiftErrorTemp =
3899             CreateMemTemp(pointeeTy, getPointerAlign(), "swifterror.temp");
3900           V = swiftErrorTemp.getPointer();
3901           cast<llvm::AllocaInst>(V)->setSwiftError(true);
3902 
3903           llvm::Value *errorValue = Builder.CreateLoad(swiftErrorArg);
3904           Builder.CreateStore(errorValue, swiftErrorTemp);
3905         }
3906 
3907         // We might have to widen integers, but we should never truncate.
3908         if (ArgInfo.getCoerceToType() != V->getType() &&
3909             V->getType()->isIntegerTy())
3910           V = Builder.CreateZExt(V, ArgInfo.getCoerceToType());
3911 
3912         // If the argument doesn't match, perform a bitcast to coerce it.  This
3913         // can happen due to trivial type mismatches.
3914         if (FirstIRArg < IRFuncTy->getNumParams() &&
3915             V->getType() != IRFuncTy->getParamType(FirstIRArg))
3916           V = Builder.CreateBitCast(V, IRFuncTy->getParamType(FirstIRArg));
3917 
3918         IRCallArgs[FirstIRArg] = V;
3919         break;
3920       }
3921 
3922       // FIXME: Avoid the conversion through memory if possible.
3923       Address Src = Address::invalid();
3924       if (RV.isScalar() || RV.isComplex()) {
3925         Src = CreateMemTemp(I->Ty, "coerce");
3926         LValue SrcLV = MakeAddrLValue(Src, I->Ty);
3927         EmitInitStoreOfNonAggregate(*this, RV, SrcLV);
3928       } else {
3929         Src = RV.getAggregateAddress();
3930       }
3931 
3932       // If the value is offset in memory, apply the offset now.
3933       Src = emitAddressAtOffset(*this, Src, ArgInfo);
3934 
3935       // Fast-isel and the optimizer generally like scalar values better than
3936       // FCAs, so we flatten them if this is safe to do for this argument.
3937       llvm::StructType *STy =
3938             dyn_cast<llvm::StructType>(ArgInfo.getCoerceToType());
3939       if (STy && ArgInfo.isDirect() && ArgInfo.getCanBeFlattened()) {
3940         llvm::Type *SrcTy = Src.getType()->getElementType();
3941         uint64_t SrcSize = CGM.getDataLayout().getTypeAllocSize(SrcTy);
3942         uint64_t DstSize = CGM.getDataLayout().getTypeAllocSize(STy);
3943 
3944         // If the source type is smaller than the destination type of the
3945         // coerce-to logic, copy the source value into a temp alloca the size
3946         // of the destination type to allow loading all of it. The bits past
3947         // the source value are left undef.
3948         if (SrcSize < DstSize) {
3949           Address TempAlloca
3950             = CreateTempAlloca(STy, Src.getAlignment(),
3951                                Src.getName() + ".coerce");
3952           Builder.CreateMemCpy(TempAlloca, Src, SrcSize);
3953           Src = TempAlloca;
3954         } else {
3955           Src = Builder.CreateBitCast(Src,
3956                                       STy->getPointerTo(Src.getAddressSpace()));
3957         }
3958 
3959         auto SrcLayout = CGM.getDataLayout().getStructLayout(STy);
3960         assert(NumIRArgs == STy->getNumElements());
3961         for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
3962           auto Offset = CharUnits::fromQuantity(SrcLayout->getElementOffset(i));
3963           Address EltPtr = Builder.CreateStructGEP(Src, i, Offset);
3964           llvm::Value *LI = Builder.CreateLoad(EltPtr);
3965           IRCallArgs[FirstIRArg + i] = LI;
3966         }
3967       } else {
3968         // In the simple case, just pass the coerced loaded value.
3969         assert(NumIRArgs == 1);
3970         IRCallArgs[FirstIRArg] =
3971           CreateCoercedLoad(Src, ArgInfo.getCoerceToType(), *this);
3972       }
3973 
3974       break;
3975     }
3976 
3977     case ABIArgInfo::CoerceAndExpand: {
3978       auto coercionType = ArgInfo.getCoerceAndExpandType();
3979       auto layout = CGM.getDataLayout().getStructLayout(coercionType);
3980 
3981       llvm::Value *tempSize = nullptr;
3982       Address addr = Address::invalid();
3983       if (RV.isAggregate()) {
3984         addr = RV.getAggregateAddress();
3985       } else {
3986         assert(RV.isScalar()); // complex should always just be direct
3987 
3988         llvm::Type *scalarType = RV.getScalarVal()->getType();
3989         auto scalarSize = CGM.getDataLayout().getTypeAllocSize(scalarType);
3990         auto scalarAlign = CGM.getDataLayout().getPrefTypeAlignment(scalarType);
3991 
3992         tempSize = llvm::ConstantInt::get(CGM.Int64Ty, scalarSize);
3993 
3994         // Materialize to a temporary.
3995         addr = CreateTempAlloca(RV.getScalarVal()->getType(),
3996                  CharUnits::fromQuantity(std::max(layout->getAlignment(),
3997                                                   scalarAlign)));
3998         EmitLifetimeStart(scalarSize, addr.getPointer());
3999 
4000         Builder.CreateStore(RV.getScalarVal(), addr);
4001       }
4002 
4003       addr = Builder.CreateElementBitCast(addr, coercionType);
4004 
4005       unsigned IRArgPos = FirstIRArg;
4006       for (unsigned i = 0, e = coercionType->getNumElements(); i != e; ++i) {
4007         llvm::Type *eltType = coercionType->getElementType(i);
4008         if (ABIArgInfo::isPaddingForCoerceAndExpand(eltType)) continue;
4009         Address eltAddr = Builder.CreateStructGEP(addr, i, layout);
4010         llvm::Value *elt = Builder.CreateLoad(eltAddr);
4011         IRCallArgs[IRArgPos++] = elt;
4012       }
4013       assert(IRArgPos == FirstIRArg + NumIRArgs);
4014 
4015       if (tempSize) {
4016         EmitLifetimeEnd(tempSize, addr.getPointer());
4017       }
4018 
4019       break;
4020     }
4021 
4022     case ABIArgInfo::Expand:
4023       unsigned IRArgPos = FirstIRArg;
4024       ExpandTypeToArgs(I->Ty, RV, IRFuncTy, IRCallArgs, IRArgPos);
4025       assert(IRArgPos == FirstIRArg + NumIRArgs);
4026       break;
4027     }
4028   }
4029 
4030   const CGCallee &ConcreteCallee = Callee.prepareConcreteCallee(*this);
4031   llvm::Value *CalleePtr = ConcreteCallee.getFunctionPointer();
4032 
4033   // If we're using inalloca, set up that argument.
4034   if (ArgMemory.isValid()) {
4035     llvm::Value *Arg = ArgMemory.getPointer();
4036     if (CallInfo.isVariadic()) {
4037       // When passing non-POD arguments by value to variadic functions, we will
4038       // end up with a variadic prototype and an inalloca call site.  In such
4039       // cases, we can't do any parameter mismatch checks.  Give up and bitcast
4040       // the callee.
4041       unsigned CalleeAS = CalleePtr->getType()->getPointerAddressSpace();
4042       auto FnTy = getTypes().GetFunctionType(CallInfo)->getPointerTo(CalleeAS);
4043       CalleePtr = Builder.CreateBitCast(CalleePtr, FnTy);
4044     } else {
4045       llvm::Type *LastParamTy =
4046           IRFuncTy->getParamType(IRFuncTy->getNumParams() - 1);
4047       if (Arg->getType() != LastParamTy) {
4048 #ifndef NDEBUG
4049         // Assert that these structs have equivalent element types.
4050         llvm::StructType *FullTy = CallInfo.getArgStruct();
4051         llvm::StructType *DeclaredTy = cast<llvm::StructType>(
4052             cast<llvm::PointerType>(LastParamTy)->getElementType());
4053         assert(DeclaredTy->getNumElements() == FullTy->getNumElements());
4054         for (llvm::StructType::element_iterator DI = DeclaredTy->element_begin(),
4055                                                 DE = DeclaredTy->element_end(),
4056                                                 FI = FullTy->element_begin();
4057              DI != DE; ++DI, ++FI)
4058           assert(*DI == *FI);
4059 #endif
4060         Arg = Builder.CreateBitCast(Arg, LastParamTy);
4061       }
4062     }
4063     assert(IRFunctionArgs.hasInallocaArg());
4064     IRCallArgs[IRFunctionArgs.getInallocaArgNo()] = Arg;
4065   }
4066 
4067   // 2. Prepare the function pointer.
4068 
4069   // If the callee is a bitcast of a non-variadic function to have a
4070   // variadic function pointer type, check to see if we can remove the
4071   // bitcast.  This comes up with unprototyped functions.
4072   //
4073   // This makes the IR nicer, but more importantly it ensures that we
4074   // can inline the function at -O0 if it is marked always_inline.
4075   auto simplifyVariadicCallee = [](llvm::Value *Ptr) -> llvm::Value* {
4076     llvm::FunctionType *CalleeFT =
4077       cast<llvm::FunctionType>(Ptr->getType()->getPointerElementType());
4078     if (!CalleeFT->isVarArg())
4079       return Ptr;
4080 
4081     llvm::ConstantExpr *CE = dyn_cast<llvm::ConstantExpr>(Ptr);
4082     if (!CE || CE->getOpcode() != llvm::Instruction::BitCast)
4083       return Ptr;
4084 
4085     llvm::Function *OrigFn = dyn_cast<llvm::Function>(CE->getOperand(0));
4086     if (!OrigFn)
4087       return Ptr;
4088 
4089     llvm::FunctionType *OrigFT = OrigFn->getFunctionType();
4090 
4091     // If the original type is variadic, or if any of the component types
4092     // disagree, we cannot remove the cast.
4093     if (OrigFT->isVarArg() ||
4094         OrigFT->getNumParams() != CalleeFT->getNumParams() ||
4095         OrigFT->getReturnType() != CalleeFT->getReturnType())
4096       return Ptr;
4097 
4098     for (unsigned i = 0, e = OrigFT->getNumParams(); i != e; ++i)
4099       if (OrigFT->getParamType(i) != CalleeFT->getParamType(i))
4100         return Ptr;
4101 
4102     return OrigFn;
4103   };
4104   CalleePtr = simplifyVariadicCallee(CalleePtr);
4105 
4106   // 3. Perform the actual call.
4107 
4108   // Deactivate any cleanups that we're supposed to do immediately before
4109   // the call.
4110   if (!CallArgs.getCleanupsToDeactivate().empty())
4111     deactivateArgCleanupsBeforeCall(*this, CallArgs);
4112 
4113   // Assert that the arguments we computed match up.  The IR verifier
4114   // will catch this, but this is a common enough source of problems
4115   // during IRGen changes that it's way better for debugging to catch
4116   // it ourselves here.
4117 #ifndef NDEBUG
4118   assert(IRCallArgs.size() == IRFuncTy->getNumParams() || IRFuncTy->isVarArg());
4119   for (unsigned i = 0; i < IRCallArgs.size(); ++i) {
4120     // Inalloca argument can have different type.
4121     if (IRFunctionArgs.hasInallocaArg() &&
4122         i == IRFunctionArgs.getInallocaArgNo())
4123       continue;
4124     if (i < IRFuncTy->getNumParams())
4125       assert(IRCallArgs[i]->getType() == IRFuncTy->getParamType(i));
4126   }
4127 #endif
4128 
4129   // Compute the calling convention and attributes.
4130   unsigned CallingConv;
4131   llvm::AttributeList Attrs;
4132   CGM.ConstructAttributeList(CalleePtr->getName(), CallInfo,
4133                              Callee.getAbstractInfo(), Attrs, CallingConv,
4134                              /*AttrOnCallSite=*/true);
4135 
4136   // Apply some call-site-specific attributes.
4137   // TODO: work this into building the attribute set.
4138 
4139   // Apply always_inline to all calls within flatten functions.
4140   // FIXME: should this really take priority over __try, below?
4141   if (CurCodeDecl && CurCodeDecl->hasAttr<FlattenAttr>() &&
4142       !(Callee.getAbstractInfo().getCalleeDecl() &&
4143         Callee.getAbstractInfo().getCalleeDecl()->hasAttr<NoInlineAttr>())) {
4144     Attrs =
4145         Attrs.addAttribute(getLLVMContext(), llvm::AttributeList::FunctionIndex,
4146                            llvm::Attribute::AlwaysInline);
4147   }
4148 
4149   // Disable inlining inside SEH __try blocks.
4150   if (isSEHTryScope()) {
4151     Attrs =
4152         Attrs.addAttribute(getLLVMContext(), llvm::AttributeList::FunctionIndex,
4153                            llvm::Attribute::NoInline);
4154   }
4155 
4156   // Decide whether to use a call or an invoke.
4157   bool CannotThrow;
4158   if (currentFunctionUsesSEHTry()) {
4159     // SEH cares about asynchronous exceptions, so everything can "throw."
4160     CannotThrow = false;
4161   } else if (isCleanupPadScope() &&
4162              EHPersonality::get(*this).isMSVCXXPersonality()) {
4163     // The MSVC++ personality will implicitly terminate the program if an
4164     // exception is thrown during a cleanup outside of a try/catch.
4165     // We don't need to model anything in IR to get this behavior.
4166     CannotThrow = true;
4167   } else {
4168     // Otherwise, nounwind call sites will never throw.
4169     CannotThrow = Attrs.hasAttribute(llvm::AttributeList::FunctionIndex,
4170                                      llvm::Attribute::NoUnwind);
4171   }
4172   llvm::BasicBlock *InvokeDest = CannotThrow ? nullptr : getInvokeDest();
4173 
4174   SmallVector<llvm::OperandBundleDef, 1> BundleList =
4175       getBundlesForFunclet(CalleePtr);
4176 
4177   // Emit the actual call/invoke instruction.
4178   llvm::CallSite CS;
4179   if (!InvokeDest) {
4180     CS = Builder.CreateCall(CalleePtr, IRCallArgs, BundleList);
4181   } else {
4182     llvm::BasicBlock *Cont = createBasicBlock("invoke.cont");
4183     CS = Builder.CreateInvoke(CalleePtr, Cont, InvokeDest, IRCallArgs,
4184                               BundleList);
4185     EmitBlock(Cont);
4186   }
4187   llvm::Instruction *CI = CS.getInstruction();
4188   if (callOrInvoke)
4189     *callOrInvoke = CI;
4190 
4191   // Apply the attributes and calling convention.
4192   CS.setAttributes(Attrs);
4193   CS.setCallingConv(static_cast<llvm::CallingConv::ID>(CallingConv));
4194 
4195   // Apply various metadata.
4196 
4197   if (!CI->getType()->isVoidTy())
4198     CI->setName("call");
4199 
4200   // Insert instrumentation or attach profile metadata at indirect call sites.
4201   // For more details, see the comment before the definition of
4202   // IPVK_IndirectCallTarget in InstrProfData.inc.
4203   if (!CS.getCalledFunction())
4204     PGO.valueProfile(Builder, llvm::IPVK_IndirectCallTarget,
4205                      CI, CalleePtr);
4206 
4207   // In ObjC ARC mode with no ObjC ARC exception safety, tell the ARC
4208   // optimizer it can aggressively ignore unwind edges.
4209   if (CGM.getLangOpts().ObjCAutoRefCount)
4210     AddObjCARCExceptionMetadata(CI);
4211 
4212   // Suppress tail calls if requested.
4213   if (llvm::CallInst *Call = dyn_cast<llvm::CallInst>(CI)) {
4214     const Decl *TargetDecl = Callee.getAbstractInfo().getCalleeDecl();
4215     if (TargetDecl && TargetDecl->hasAttr<NotTailCalledAttr>())
4216       Call->setTailCallKind(llvm::CallInst::TCK_NoTail);
4217   }
4218 
4219   // 4. Finish the call.
4220 
4221   // If the call doesn't return, finish the basic block and clear the
4222   // insertion point; this allows the rest of IRGen to discard
4223   // unreachable code.
4224   if (CS.doesNotReturn()) {
4225     if (UnusedReturnSize)
4226       EmitLifetimeEnd(llvm::ConstantInt::get(Int64Ty, UnusedReturnSize),
4227                       SRetPtr.getPointer());
4228 
4229     // Strip away the noreturn attribute to better diagnose unreachable UB.
4230     if (SanOpts.has(SanitizerKind::Unreachable)) {
4231       if (auto *F = CS.getCalledFunction())
4232         F->removeFnAttr(llvm::Attribute::NoReturn);
4233       CS.removeAttribute(llvm::AttributeList::FunctionIndex,
4234                          llvm::Attribute::NoReturn);
4235     }
4236 
4237     EmitUnreachable(Loc);
4238     Builder.ClearInsertionPoint();
4239 
4240     // FIXME: For now, emit a dummy basic block because expr emitters in
4241     // generally are not ready to handle emitting expressions at unreachable
4242     // points.
4243     EnsureInsertPoint();
4244 
4245     // Return a reasonable RValue.
4246     return GetUndefRValue(RetTy);
4247   }
4248 
4249   // Perform the swifterror writeback.
4250   if (swiftErrorTemp.isValid()) {
4251     llvm::Value *errorResult = Builder.CreateLoad(swiftErrorTemp);
4252     Builder.CreateStore(errorResult, swiftErrorArg);
4253   }
4254 
4255   // Emit any call-associated writebacks immediately.  Arguably this
4256   // should happen after any return-value munging.
4257   if (CallArgs.hasWritebacks())
4258     emitWritebacks(*this, CallArgs);
4259 
4260   // The stack cleanup for inalloca arguments has to run out of the normal
4261   // lexical order, so deactivate it and run it manually here.
4262   CallArgs.freeArgumentMemory(*this);
4263 
4264   // Extract the return value.
4265   RValue Ret = [&] {
4266     switch (RetAI.getKind()) {
4267     case ABIArgInfo::CoerceAndExpand: {
4268       auto coercionType = RetAI.getCoerceAndExpandType();
4269       auto layout = CGM.getDataLayout().getStructLayout(coercionType);
4270 
4271       Address addr = SRetPtr;
4272       addr = Builder.CreateElementBitCast(addr, coercionType);
4273 
4274       assert(CI->getType() == RetAI.getUnpaddedCoerceAndExpandType());
4275       bool requiresExtract = isa<llvm::StructType>(CI->getType());
4276 
4277       unsigned unpaddedIndex = 0;
4278       for (unsigned i = 0, e = coercionType->getNumElements(); i != e; ++i) {
4279         llvm::Type *eltType = coercionType->getElementType(i);
4280         if (ABIArgInfo::isPaddingForCoerceAndExpand(eltType)) continue;
4281         Address eltAddr = Builder.CreateStructGEP(addr, i, layout);
4282         llvm::Value *elt = CI;
4283         if (requiresExtract)
4284           elt = Builder.CreateExtractValue(elt, unpaddedIndex++);
4285         else
4286           assert(unpaddedIndex == 0);
4287         Builder.CreateStore(elt, eltAddr);
4288       }
4289       // FALLTHROUGH
4290       LLVM_FALLTHROUGH;
4291     }
4292 
4293     case ABIArgInfo::InAlloca:
4294     case ABIArgInfo::Indirect: {
4295       RValue ret = convertTempToRValue(SRetPtr, RetTy, SourceLocation());
4296       if (UnusedReturnSize)
4297         EmitLifetimeEnd(llvm::ConstantInt::get(Int64Ty, UnusedReturnSize),
4298                         SRetPtr.getPointer());
4299       return ret;
4300     }
4301 
4302     case ABIArgInfo::Ignore:
4303       // If we are ignoring an argument that had a result, make sure to
4304       // construct the appropriate return value for our caller.
4305       return GetUndefRValue(RetTy);
4306 
4307     case ABIArgInfo::Extend:
4308     case ABIArgInfo::Direct: {
4309       llvm::Type *RetIRTy = ConvertType(RetTy);
4310       if (RetAI.getCoerceToType() == RetIRTy && RetAI.getDirectOffset() == 0) {
4311         switch (getEvaluationKind(RetTy)) {
4312         case TEK_Complex: {
4313           llvm::Value *Real = Builder.CreateExtractValue(CI, 0);
4314           llvm::Value *Imag = Builder.CreateExtractValue(CI, 1);
4315           return RValue::getComplex(std::make_pair(Real, Imag));
4316         }
4317         case TEK_Aggregate: {
4318           Address DestPtr = ReturnValue.getValue();
4319           bool DestIsVolatile = ReturnValue.isVolatile();
4320 
4321           if (!DestPtr.isValid()) {
4322             DestPtr = CreateMemTemp(RetTy, "agg.tmp");
4323             DestIsVolatile = false;
4324           }
4325           BuildAggStore(*this, CI, DestPtr, DestIsVolatile);
4326           return RValue::getAggregate(DestPtr);
4327         }
4328         case TEK_Scalar: {
4329           // If the argument doesn't match, perform a bitcast to coerce it.  This
4330           // can happen due to trivial type mismatches.
4331           llvm::Value *V = CI;
4332           if (V->getType() != RetIRTy)
4333             V = Builder.CreateBitCast(V, RetIRTy);
4334           return RValue::get(V);
4335         }
4336         }
4337         llvm_unreachable("bad evaluation kind");
4338       }
4339 
4340       Address DestPtr = ReturnValue.getValue();
4341       bool DestIsVolatile = ReturnValue.isVolatile();
4342 
4343       if (!DestPtr.isValid()) {
4344         DestPtr = CreateMemTemp(RetTy, "coerce");
4345         DestIsVolatile = false;
4346       }
4347 
4348       // If the value is offset in memory, apply the offset now.
4349       Address StorePtr = emitAddressAtOffset(*this, DestPtr, RetAI);
4350       CreateCoercedStore(CI, StorePtr, DestIsVolatile, *this);
4351 
4352       return convertTempToRValue(DestPtr, RetTy, SourceLocation());
4353     }
4354 
4355     case ABIArgInfo::Expand:
4356       llvm_unreachable("Invalid ABI kind for return argument");
4357     }
4358 
4359     llvm_unreachable("Unhandled ABIArgInfo::Kind");
4360   } ();
4361 
4362   // Emit the assume_aligned check on the return value.
4363   const Decl *TargetDecl = Callee.getAbstractInfo().getCalleeDecl();
4364   if (Ret.isScalar() && TargetDecl) {
4365     if (const auto *AA = TargetDecl->getAttr<AssumeAlignedAttr>()) {
4366       llvm::Value *OffsetValue = nullptr;
4367       if (const auto *Offset = AA->getOffset())
4368         OffsetValue = EmitScalarExpr(Offset);
4369 
4370       llvm::Value *Alignment = EmitScalarExpr(AA->getAlignment());
4371       llvm::ConstantInt *AlignmentCI = cast<llvm::ConstantInt>(Alignment);
4372       EmitAlignmentAssumption(Ret.getScalarVal(), AlignmentCI->getZExtValue(),
4373                               OffsetValue);
4374     } else if (const auto *AA = TargetDecl->getAttr<AllocAlignAttr>()) {
4375       llvm::Value *ParamVal =
4376           CallArgs[AA->getParamIndex() - 1].RV.getScalarVal();
4377       EmitAlignmentAssumption(Ret.getScalarVal(), ParamVal);
4378     }
4379   }
4380 
4381   return Ret;
4382 }
4383 
4384 CGCallee CGCallee::prepareConcreteCallee(CodeGenFunction &CGF) const {
4385   if (isVirtual()) {
4386     const CallExpr *CE = getVirtualCallExpr();
4387     return CGF.CGM.getCXXABI().getVirtualFunctionPointer(
4388         CGF, getVirtualMethodDecl(), getThisAddress(),
4389         getFunctionType(), CE ? CE->getLocStart() : SourceLocation());
4390   }
4391 
4392   return *this;
4393 }
4394 
4395 /* VarArg handling */
4396 
4397 Address CodeGenFunction::EmitVAArg(VAArgExpr *VE, Address &VAListAddr) {
4398   VAListAddr = VE->isMicrosoftABI()
4399                  ? EmitMSVAListRef(VE->getSubExpr())
4400                  : EmitVAListRef(VE->getSubExpr());
4401   QualType Ty = VE->getType();
4402   if (VE->isMicrosoftABI())
4403     return CGM.getTypes().getABIInfo().EmitMSVAArg(*this, VAListAddr, Ty);
4404   return CGM.getTypes().getABIInfo().EmitVAArg(*this, VAListAddr, Ty);
4405 }
4406