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