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