1 //===--- CodeGenFunction.cpp - Emit LLVM Code from ASTs for a Function ----===//
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 // This coordinates the per-function state used while generating code.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #include "CodeGenFunction.h"
15 #include "CGCUDARuntime.h"
16 #include "CGCXXABI.h"
17 #include "CGDebugInfo.h"
18 #include "CodeGenModule.h"
19 #include "clang/AST/ASTContext.h"
20 #include "clang/AST/Decl.h"
21 #include "clang/AST/DeclCXX.h"
22 #include "clang/AST/StmtCXX.h"
23 #include "clang/Basic/TargetInfo.h"
24 #include "clang/Frontend/CodeGenOptions.h"
25 #include "llvm/IR/DataLayout.h"
26 #include "llvm/IR/Intrinsics.h"
27 #include "llvm/IR/MDBuilder.h"
28 #include "llvm/IR/Operator.h"
29 using namespace clang;
30 using namespace CodeGen;
31 
32 CodeGenFunction::CodeGenFunction(CodeGenModule &cgm, bool suppressNewContext)
33   : CodeGenTypeCache(cgm), CGM(cgm),
34     Target(CGM.getContext().getTargetInfo()),
35     Builder(cgm.getModule().getContext()),
36     SanitizePerformTypeCheck(CGM.getSanOpts().Null |
37                              CGM.getSanOpts().Alignment |
38                              CGM.getSanOpts().ObjectSize |
39                              CGM.getSanOpts().Vptr),
40     SanOpts(&CGM.getSanOpts()),
41     AutoreleaseResult(false), BlockInfo(0), BlockPointer(0),
42     LambdaThisCaptureField(0), NormalCleanupDest(0), NextCleanupDestIndex(1),
43     FirstBlockInfo(0), EHResumeBlock(0), ExceptionSlot(0), EHSelectorSlot(0),
44     DebugInfo(0), DisableDebugInfo(false), DidCallStackSave(false),
45     IndirectBranch(0), SwitchInsn(0), CaseRangeBlock(0), UnreachableBlock(0),
46     CXXABIThisDecl(0), CXXABIThisValue(0), CXXThisValue(0),
47     CXXStructorImplicitParamDecl(0), CXXStructorImplicitParamValue(0),
48     OutermostConditional(0), TerminateLandingPad(0),
49     TerminateHandler(0), TrapBB(0) {
50   if (!suppressNewContext)
51     CGM.getCXXABI().getMangleContext().startNewFunction();
52 
53   llvm::FastMathFlags FMF;
54   if (CGM.getLangOpts().FastMath)
55     FMF.setUnsafeAlgebra();
56   if (CGM.getLangOpts().FiniteMathOnly) {
57     FMF.setNoNaNs();
58     FMF.setNoInfs();
59   }
60   Builder.SetFastMathFlags(FMF);
61 }
62 
63 CodeGenFunction::~CodeGenFunction() {
64   // If there are any unclaimed block infos, go ahead and destroy them
65   // now.  This can happen if IR-gen gets clever and skips evaluating
66   // something.
67   if (FirstBlockInfo)
68     destroyBlockInfos(FirstBlockInfo);
69 }
70 
71 
72 llvm::Type *CodeGenFunction::ConvertTypeForMem(QualType T) {
73   return CGM.getTypes().ConvertTypeForMem(T);
74 }
75 
76 llvm::Type *CodeGenFunction::ConvertType(QualType T) {
77   return CGM.getTypes().ConvertType(T);
78 }
79 
80 TypeEvaluationKind CodeGenFunction::getEvaluationKind(QualType type) {
81   type = type.getCanonicalType();
82   while (true) {
83     switch (type->getTypeClass()) {
84 #define TYPE(name, parent)
85 #define ABSTRACT_TYPE(name, parent)
86 #define NON_CANONICAL_TYPE(name, parent) case Type::name:
87 #define DEPENDENT_TYPE(name, parent) case Type::name:
88 #define NON_CANONICAL_UNLESS_DEPENDENT_TYPE(name, parent) case Type::name:
89 #include "clang/AST/TypeNodes.def"
90       llvm_unreachable("non-canonical or dependent type in IR-generation");
91 
92     // Various scalar types.
93     case Type::Builtin:
94     case Type::Pointer:
95     case Type::BlockPointer:
96     case Type::LValueReference:
97     case Type::RValueReference:
98     case Type::MemberPointer:
99     case Type::Vector:
100     case Type::ExtVector:
101     case Type::FunctionProto:
102     case Type::FunctionNoProto:
103     case Type::Enum:
104     case Type::ObjCObjectPointer:
105       return TEK_Scalar;
106 
107     // Complexes.
108     case Type::Complex:
109       return TEK_Complex;
110 
111     // Arrays, records, and Objective-C objects.
112     case Type::ConstantArray:
113     case Type::IncompleteArray:
114     case Type::VariableArray:
115     case Type::Record:
116     case Type::ObjCObject:
117     case Type::ObjCInterface:
118       return TEK_Aggregate;
119 
120     // We operate on atomic values according to their underlying type.
121     case Type::Atomic:
122       type = cast<AtomicType>(type)->getValueType();
123       continue;
124     }
125     llvm_unreachable("unknown type kind!");
126   }
127 }
128 
129 void CodeGenFunction::EmitReturnBlock() {
130   // For cleanliness, we try to avoid emitting the return block for
131   // simple cases.
132   llvm::BasicBlock *CurBB = Builder.GetInsertBlock();
133 
134   if (CurBB) {
135     assert(!CurBB->getTerminator() && "Unexpected terminated block.");
136 
137     // We have a valid insert point, reuse it if it is empty or there are no
138     // explicit jumps to the return block.
139     if (CurBB->empty() || ReturnBlock.getBlock()->use_empty()) {
140       ReturnBlock.getBlock()->replaceAllUsesWith(CurBB);
141       delete ReturnBlock.getBlock();
142     } else
143       EmitBlock(ReturnBlock.getBlock());
144     return;
145   }
146 
147   // Otherwise, if the return block is the target of a single direct
148   // branch then we can just put the code in that block instead. This
149   // cleans up functions which started with a unified return block.
150   if (ReturnBlock.getBlock()->hasOneUse()) {
151     llvm::BranchInst *BI =
152       dyn_cast<llvm::BranchInst>(*ReturnBlock.getBlock()->use_begin());
153     if (BI && BI->isUnconditional() &&
154         BI->getSuccessor(0) == ReturnBlock.getBlock()) {
155       // Reset insertion point, including debug location, and delete the
156       // branch.  This is really subtle and only works because the next change
157       // in location will hit the caching in CGDebugInfo::EmitLocation and not
158       // override this.
159       Builder.SetCurrentDebugLocation(BI->getDebugLoc());
160       Builder.SetInsertPoint(BI->getParent());
161       BI->eraseFromParent();
162       delete ReturnBlock.getBlock();
163       return;
164     }
165   }
166 
167   // FIXME: We are at an unreachable point, there is no reason to emit the block
168   // unless it has uses. However, we still need a place to put the debug
169   // region.end for now.
170 
171   EmitBlock(ReturnBlock.getBlock());
172 }
173 
174 static void EmitIfUsed(CodeGenFunction &CGF, llvm::BasicBlock *BB) {
175   if (!BB) return;
176   if (!BB->use_empty())
177     return CGF.CurFn->getBasicBlockList().push_back(BB);
178   delete BB;
179 }
180 
181 void CodeGenFunction::FinishFunction(SourceLocation EndLoc) {
182   assert(BreakContinueStack.empty() &&
183          "mismatched push/pop in break/continue stack!");
184 
185   if (CGDebugInfo *DI = getDebugInfo())
186     DI->EmitLocation(Builder, EndLoc);
187 
188   // Pop any cleanups that might have been associated with the
189   // parameters.  Do this in whatever block we're currently in; it's
190   // important to do this before we enter the return block or return
191   // edges will be *really* confused.
192   if (EHStack.stable_begin() != PrologueCleanupDepth)
193     PopCleanupBlocks(PrologueCleanupDepth);
194 
195   // Emit function epilog (to return).
196   EmitReturnBlock();
197 
198   if (ShouldInstrumentFunction())
199     EmitFunctionInstrumentation("__cyg_profile_func_exit");
200 
201   // Emit debug descriptor for function end.
202   if (CGDebugInfo *DI = getDebugInfo()) {
203     DI->EmitFunctionEnd(Builder);
204   }
205 
206   EmitFunctionEpilog(*CurFnInfo);
207   EmitEndEHSpec(CurCodeDecl);
208 
209   assert(EHStack.empty() &&
210          "did not remove all scopes from cleanup stack!");
211 
212   // If someone did an indirect goto, emit the indirect goto block at the end of
213   // the function.
214   if (IndirectBranch) {
215     EmitBlock(IndirectBranch->getParent());
216     Builder.ClearInsertionPoint();
217   }
218 
219   // Remove the AllocaInsertPt instruction, which is just a convenience for us.
220   llvm::Instruction *Ptr = AllocaInsertPt;
221   AllocaInsertPt = 0;
222   Ptr->eraseFromParent();
223 
224   // If someone took the address of a label but never did an indirect goto, we
225   // made a zero entry PHI node, which is illegal, zap it now.
226   if (IndirectBranch) {
227     llvm::PHINode *PN = cast<llvm::PHINode>(IndirectBranch->getAddress());
228     if (PN->getNumIncomingValues() == 0) {
229       PN->replaceAllUsesWith(llvm::UndefValue::get(PN->getType()));
230       PN->eraseFromParent();
231     }
232   }
233 
234   EmitIfUsed(*this, EHResumeBlock);
235   EmitIfUsed(*this, TerminateLandingPad);
236   EmitIfUsed(*this, TerminateHandler);
237   EmitIfUsed(*this, UnreachableBlock);
238 
239   if (CGM.getCodeGenOpts().EmitDeclMetadata)
240     EmitDeclMetadata();
241 }
242 
243 /// ShouldInstrumentFunction - Return true if the current function should be
244 /// instrumented with __cyg_profile_func_* calls
245 bool CodeGenFunction::ShouldInstrumentFunction() {
246   if (!CGM.getCodeGenOpts().InstrumentFunctions)
247     return false;
248   if (!CurFuncDecl || CurFuncDecl->hasAttr<NoInstrumentFunctionAttr>())
249     return false;
250   return true;
251 }
252 
253 /// EmitFunctionInstrumentation - Emit LLVM code to call the specified
254 /// instrumentation function with the current function and the call site, if
255 /// function instrumentation is enabled.
256 void CodeGenFunction::EmitFunctionInstrumentation(const char *Fn) {
257   // void __cyg_profile_func_{enter,exit} (void *this_fn, void *call_site);
258   llvm::PointerType *PointerTy = Int8PtrTy;
259   llvm::Type *ProfileFuncArgs[] = { PointerTy, PointerTy };
260   llvm::FunctionType *FunctionTy =
261     llvm::FunctionType::get(VoidTy, ProfileFuncArgs, false);
262 
263   llvm::Constant *F = CGM.CreateRuntimeFunction(FunctionTy, Fn);
264   llvm::CallInst *CallSite = Builder.CreateCall(
265     CGM.getIntrinsic(llvm::Intrinsic::returnaddress),
266     llvm::ConstantInt::get(Int32Ty, 0),
267     "callsite");
268 
269   llvm::Value *args[] = {
270     llvm::ConstantExpr::getBitCast(CurFn, PointerTy),
271     CallSite
272   };
273 
274   EmitNounwindRuntimeCall(F, args);
275 }
276 
277 void CodeGenFunction::EmitMCountInstrumentation() {
278   llvm::FunctionType *FTy = llvm::FunctionType::get(VoidTy, false);
279 
280   llvm::Constant *MCountFn = CGM.CreateRuntimeFunction(FTy,
281                                                        Target.getMCountName());
282   EmitNounwindRuntimeCall(MCountFn);
283 }
284 
285 // OpenCL v1.2 s5.6.4.6 allows the compiler to store kernel argument
286 // information in the program executable. The argument information stored
287 // includes the argument name, its type, the address and access qualifiers used.
288 // FIXME: Add type, address, and access qualifiers.
289 static void GenOpenCLArgMetadata(const FunctionDecl *FD, llvm::Function *Fn,
290                                  CodeGenModule &CGM,llvm::LLVMContext &Context,
291                                  SmallVector <llvm::Value*, 5> &kernelMDArgs) {
292 
293   // Create MDNodes that represents the kernel arg metadata.
294   // Each MDNode is a list in the form of "key", N number of values which is
295   // the same number of values as their are kernel arguments.
296 
297   // MDNode for the kernel argument names.
298   SmallVector<llvm::Value*, 8> argNames;
299   argNames.push_back(llvm::MDString::get(Context, "kernel_arg_name"));
300 
301   for (unsigned i = 0, e = FD->getNumParams(); i != e; ++i) {
302     const ParmVarDecl *parm = FD->getParamDecl(i);
303 
304     // Get argument name.
305     argNames.push_back(llvm::MDString::get(Context, parm->getName()));
306 
307   }
308   // Add MDNode to the list of all metadata.
309   kernelMDArgs.push_back(llvm::MDNode::get(Context, argNames));
310 }
311 
312 void CodeGenFunction::EmitOpenCLKernelMetadata(const FunctionDecl *FD,
313                                                llvm::Function *Fn)
314 {
315   if (!FD->hasAttr<OpenCLKernelAttr>())
316     return;
317 
318   llvm::LLVMContext &Context = getLLVMContext();
319 
320   SmallVector <llvm::Value*, 5> kernelMDArgs;
321   kernelMDArgs.push_back(Fn);
322 
323   if (CGM.getCodeGenOpts().EmitOpenCLArgMetadata)
324     GenOpenCLArgMetadata(FD, Fn, CGM, Context, kernelMDArgs);
325 
326   if (FD->hasAttr<VecTypeHintAttr>()) {
327     VecTypeHintAttr *attr = FD->getAttr<VecTypeHintAttr>();
328     QualType hintQTy = attr->getTypeHint();
329     const ExtVectorType *hintEltQTy = hintQTy->getAs<ExtVectorType>();
330     bool isSignedInteger =
331         hintQTy->isSignedIntegerType() ||
332         (hintEltQTy && hintEltQTy->getElementType()->isSignedIntegerType());
333     llvm::Value *attrMDArgs[] = {
334       llvm::MDString::get(Context, "vec_type_hint"),
335       llvm::UndefValue::get(CGM.getTypes().ConvertType(attr->getTypeHint())),
336       llvm::ConstantInt::get(
337           llvm::IntegerType::get(Context, 32),
338           llvm::APInt(32, (uint64_t)(isSignedInteger ? 1 : 0)))
339     };
340     kernelMDArgs.push_back(llvm::MDNode::get(Context, attrMDArgs));
341   }
342 
343   if (FD->hasAttr<WorkGroupSizeHintAttr>()) {
344     WorkGroupSizeHintAttr *attr = FD->getAttr<WorkGroupSizeHintAttr>();
345     llvm::Value *attrMDArgs[] = {
346       llvm::MDString::get(Context, "work_group_size_hint"),
347       Builder.getInt32(attr->getXDim()),
348       Builder.getInt32(attr->getYDim()),
349       Builder.getInt32(attr->getZDim())
350     };
351     kernelMDArgs.push_back(llvm::MDNode::get(Context, attrMDArgs));
352   }
353 
354   if (FD->hasAttr<ReqdWorkGroupSizeAttr>()) {
355     ReqdWorkGroupSizeAttr *attr = FD->getAttr<ReqdWorkGroupSizeAttr>();
356     llvm::Value *attrMDArgs[] = {
357       llvm::MDString::get(Context, "reqd_work_group_size"),
358       Builder.getInt32(attr->getXDim()),
359       Builder.getInt32(attr->getYDim()),
360       Builder.getInt32(attr->getZDim())
361     };
362     kernelMDArgs.push_back(llvm::MDNode::get(Context, attrMDArgs));
363   }
364 
365   llvm::MDNode *kernelMDNode = llvm::MDNode::get(Context, kernelMDArgs);
366   llvm::NamedMDNode *OpenCLKernelMetadata =
367     CGM.getModule().getOrInsertNamedMetadata("opencl.kernels");
368   OpenCLKernelMetadata->addOperand(kernelMDNode);
369 }
370 
371 void CodeGenFunction::StartFunction(GlobalDecl GD, QualType RetTy,
372                                     llvm::Function *Fn,
373                                     const CGFunctionInfo &FnInfo,
374                                     const FunctionArgList &Args,
375                                     SourceLocation StartLoc) {
376   const Decl *D = GD.getDecl();
377 
378   DidCallStackSave = false;
379   CurCodeDecl = CurFuncDecl = D;
380   FnRetTy = RetTy;
381   CurFn = Fn;
382   CurFnInfo = &FnInfo;
383   assert(CurFn->isDeclaration() && "Function already has body?");
384 
385   if (CGM.getSanitizerBlacklist().isIn(*Fn)) {
386     SanOpts = &SanitizerOptions::Disabled;
387     SanitizePerformTypeCheck = false;
388   }
389 
390   // Pass inline keyword to optimizer if it appears explicitly on any
391   // declaration.
392   if (!CGM.getCodeGenOpts().NoInline)
393     if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D))
394       for (FunctionDecl::redecl_iterator RI = FD->redecls_begin(),
395              RE = FD->redecls_end(); RI != RE; ++RI)
396         if (RI->isInlineSpecified()) {
397           Fn->addFnAttr(llvm::Attribute::InlineHint);
398           break;
399         }
400 
401   if (getLangOpts().OpenCL) {
402     // Add metadata for a kernel function.
403     if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D))
404       EmitOpenCLKernelMetadata(FD, Fn);
405   }
406 
407   llvm::BasicBlock *EntryBB = createBasicBlock("entry", CurFn);
408 
409   // Create a marker to make it easy to insert allocas into the entryblock
410   // later.  Don't create this with the builder, because we don't want it
411   // folded.
412   llvm::Value *Undef = llvm::UndefValue::get(Int32Ty);
413   AllocaInsertPt = new llvm::BitCastInst(Undef, Int32Ty, "", EntryBB);
414   if (Builder.isNamePreserving())
415     AllocaInsertPt->setName("allocapt");
416 
417   ReturnBlock = getJumpDestInCurrentScope("return");
418 
419   Builder.SetInsertPoint(EntryBB);
420 
421   // Emit subprogram debug descriptor.
422   if (CGDebugInfo *DI = getDebugInfo()) {
423     SmallVector<QualType, 16> ArgTypes;
424     for (FunctionArgList::const_iterator i = Args.begin(), e = Args.end();
425 	 i != e; ++i) {
426       ArgTypes.push_back((*i)->getType());
427     }
428 
429     QualType FnType =
430       getContext().getFunctionType(RetTy, ArgTypes,
431                                    FunctionProtoType::ExtProtoInfo());
432 
433     DI->setLocation(StartLoc);
434     DI->EmitFunctionStart(GD, FnType, CurFn, Builder);
435   }
436 
437   if (ShouldInstrumentFunction())
438     EmitFunctionInstrumentation("__cyg_profile_func_enter");
439 
440   if (CGM.getCodeGenOpts().InstrumentForProfiling)
441     EmitMCountInstrumentation();
442 
443   if (RetTy->isVoidType()) {
444     // Void type; nothing to return.
445     ReturnValue = 0;
446   } else if (CurFnInfo->getReturnInfo().getKind() == ABIArgInfo::Indirect &&
447              !hasScalarEvaluationKind(CurFnInfo->getReturnType())) {
448     // Indirect aggregate return; emit returned value directly into sret slot.
449     // This reduces code size, and affects correctness in C++.
450     ReturnValue = CurFn->arg_begin();
451   } else {
452     ReturnValue = CreateIRTemp(RetTy, "retval");
453 
454     // Tell the epilog emitter to autorelease the result.  We do this
455     // now so that various specialized functions can suppress it
456     // during their IR-generation.
457     if (getLangOpts().ObjCAutoRefCount &&
458         !CurFnInfo->isReturnsRetained() &&
459         RetTy->isObjCRetainableType())
460       AutoreleaseResult = true;
461   }
462 
463   EmitStartEHSpec(CurCodeDecl);
464 
465   PrologueCleanupDepth = EHStack.stable_begin();
466   EmitFunctionProlog(*CurFnInfo, CurFn, Args);
467 
468   if (D && isa<CXXMethodDecl>(D) && cast<CXXMethodDecl>(D)->isInstance()) {
469     CGM.getCXXABI().EmitInstanceFunctionProlog(*this);
470     const CXXMethodDecl *MD = cast<CXXMethodDecl>(D);
471     if (MD->getParent()->isLambda() &&
472         MD->getOverloadedOperator() == OO_Call) {
473       // We're in a lambda; figure out the captures.
474       MD->getParent()->getCaptureFields(LambdaCaptureFields,
475                                         LambdaThisCaptureField);
476       if (LambdaThisCaptureField) {
477         // If this lambda captures this, load it.
478         QualType LambdaTagType =
479             getContext().getTagDeclType(LambdaThisCaptureField->getParent());
480         LValue LambdaLV = MakeNaturalAlignAddrLValue(CXXABIThisValue,
481                                                      LambdaTagType);
482         LValue ThisLValue = EmitLValueForField(LambdaLV,
483                                                LambdaThisCaptureField);
484         CXXThisValue = EmitLoadOfLValue(ThisLValue).getScalarVal();
485       }
486     } else {
487       // Not in a lambda; just use 'this' from the method.
488       // FIXME: Should we generate a new load for each use of 'this'?  The
489       // fast register allocator would be happier...
490       CXXThisValue = CXXABIThisValue;
491     }
492   }
493 
494   // If any of the arguments have a variably modified type, make sure to
495   // emit the type size.
496   for (FunctionArgList::const_iterator i = Args.begin(), e = Args.end();
497        i != e; ++i) {
498     const VarDecl *VD = *i;
499 
500     // Dig out the type as written from ParmVarDecls; it's unclear whether
501     // the standard (C99 6.9.1p10) requires this, but we're following the
502     // precedent set by gcc.
503     QualType Ty;
504     if (const ParmVarDecl *PVD = dyn_cast<ParmVarDecl>(VD))
505       Ty = PVD->getOriginalType();
506     else
507       Ty = VD->getType();
508 
509     if (Ty->isVariablyModifiedType())
510       EmitVariablyModifiedType(Ty);
511   }
512   // Emit a location at the end of the prologue.
513   if (CGDebugInfo *DI = getDebugInfo())
514     DI->EmitLocation(Builder, StartLoc);
515 }
516 
517 void CodeGenFunction::EmitFunctionBody(FunctionArgList &Args) {
518   const FunctionDecl *FD = cast<FunctionDecl>(CurGD.getDecl());
519   assert(FD->getBody());
520   if (const CompoundStmt *S = dyn_cast<CompoundStmt>(FD->getBody()))
521     EmitCompoundStmtWithoutScope(*S);
522   else
523     EmitStmt(FD->getBody());
524 }
525 
526 /// Tries to mark the given function nounwind based on the
527 /// non-existence of any throwing calls within it.  We believe this is
528 /// lightweight enough to do at -O0.
529 static void TryMarkNoThrow(llvm::Function *F) {
530   // LLVM treats 'nounwind' on a function as part of the type, so we
531   // can't do this on functions that can be overwritten.
532   if (F->mayBeOverridden()) return;
533 
534   for (llvm::Function::iterator FI = F->begin(), FE = F->end(); FI != FE; ++FI)
535     for (llvm::BasicBlock::iterator
536            BI = FI->begin(), BE = FI->end(); BI != BE; ++BI)
537       if (llvm::CallInst *Call = dyn_cast<llvm::CallInst>(&*BI)) {
538         if (!Call->doesNotThrow())
539           return;
540       } else if (isa<llvm::ResumeInst>(&*BI)) {
541         return;
542       }
543   F->setDoesNotThrow();
544 }
545 
546 void CodeGenFunction::GenerateCode(GlobalDecl GD, llvm::Function *Fn,
547                                    const CGFunctionInfo &FnInfo) {
548   const FunctionDecl *FD = cast<FunctionDecl>(GD.getDecl());
549 
550   // Check if we should generate debug info for this function.
551   if (!FD->hasAttr<NoDebugAttr>())
552     maybeInitializeDebugInfo();
553 
554   FunctionArgList Args;
555   QualType ResTy = FD->getResultType();
556 
557   CurGD = GD;
558   if (isa<CXXMethodDecl>(FD) && cast<CXXMethodDecl>(FD)->isInstance())
559     CGM.getCXXABI().BuildInstanceFunctionParams(*this, ResTy, Args);
560 
561   for (unsigned i = 0, e = FD->getNumParams(); i != e; ++i)
562     Args.push_back(FD->getParamDecl(i));
563 
564   SourceRange BodyRange;
565   if (Stmt *Body = FD->getBody()) BodyRange = Body->getSourceRange();
566 
567   // Reset CalleeWithThisReturn.
568   CalleeWithThisReturn = 0;
569 
570   // Emit the standard function prologue.
571   StartFunction(GD, ResTy, Fn, FnInfo, Args, BodyRange.getBegin());
572 
573   // Generate the body of the function.
574   if (isa<CXXDestructorDecl>(FD))
575     EmitDestructorBody(Args);
576   else if (isa<CXXConstructorDecl>(FD))
577     EmitConstructorBody(Args);
578   else if (getLangOpts().CUDA &&
579            !CGM.getCodeGenOpts().CUDAIsDevice &&
580            FD->hasAttr<CUDAGlobalAttr>())
581     CGM.getCUDARuntime().EmitDeviceStubBody(*this, Args);
582   else if (isa<CXXConversionDecl>(FD) &&
583            cast<CXXConversionDecl>(FD)->isLambdaToBlockPointerConversion()) {
584     // The lambda conversion to block pointer is special; the semantics can't be
585     // expressed in the AST, so IRGen needs to special-case it.
586     EmitLambdaToBlockPointerBody(Args);
587   } else if (isa<CXXMethodDecl>(FD) &&
588              cast<CXXMethodDecl>(FD)->isLambdaStaticInvoker()) {
589     // The lambda "__invoke" function is special, because it forwards or
590     // clones the body of the function call operator (but is actually static).
591     EmitLambdaStaticInvokeFunction(cast<CXXMethodDecl>(FD));
592   } else if (FD->isDefaulted() && isa<CXXMethodDecl>(FD) &&
593              cast<CXXMethodDecl>(FD)->isCopyAssignmentOperator()) {
594     // Implicit copy-assignment gets the same special treatment as implicit
595     // copy-constructors.
596     emitImplicitAssignmentOperatorBody(Args);
597   }
598   else
599     EmitFunctionBody(Args);
600 
601   // C++11 [stmt.return]p2:
602   //   Flowing off the end of a function [...] results in undefined behavior in
603   //   a value-returning function.
604   // C11 6.9.1p12:
605   //   If the '}' that terminates a function is reached, and the value of the
606   //   function call is used by the caller, the behavior is undefined.
607   if (getLangOpts().CPlusPlus && !FD->hasImplicitReturnZero() &&
608       !FD->getResultType()->isVoidType() && Builder.GetInsertBlock()) {
609     if (SanOpts->Return)
610       EmitCheck(Builder.getFalse(), "missing_return",
611                 EmitCheckSourceLocation(FD->getLocation()),
612                 ArrayRef<llvm::Value *>(), CRK_Unrecoverable);
613     else if (CGM.getCodeGenOpts().OptimizationLevel == 0)
614       Builder.CreateCall(CGM.getIntrinsic(llvm::Intrinsic::trap));
615     Builder.CreateUnreachable();
616     Builder.ClearInsertionPoint();
617   }
618 
619   // Emit the standard function epilogue.
620   FinishFunction(BodyRange.getEnd());
621   // Reset CalleeWithThisReturn.
622   CalleeWithThisReturn = 0;
623 
624   // If we haven't marked the function nothrow through other means, do
625   // a quick pass now to see if we can.
626   if (!CurFn->doesNotThrow())
627     TryMarkNoThrow(CurFn);
628 }
629 
630 /// ContainsLabel - Return true if the statement contains a label in it.  If
631 /// this statement is not executed normally, it not containing a label means
632 /// that we can just remove the code.
633 bool CodeGenFunction::ContainsLabel(const Stmt *S, bool IgnoreCaseStmts) {
634   // Null statement, not a label!
635   if (S == 0) return false;
636 
637   // If this is a label, we have to emit the code, consider something like:
638   // if (0) {  ...  foo:  bar(); }  goto foo;
639   //
640   // TODO: If anyone cared, we could track __label__'s, since we know that you
641   // can't jump to one from outside their declared region.
642   if (isa<LabelStmt>(S))
643     return true;
644 
645   // If this is a case/default statement, and we haven't seen a switch, we have
646   // to emit the code.
647   if (isa<SwitchCase>(S) && !IgnoreCaseStmts)
648     return true;
649 
650   // If this is a switch statement, we want to ignore cases below it.
651   if (isa<SwitchStmt>(S))
652     IgnoreCaseStmts = true;
653 
654   // Scan subexpressions for verboten labels.
655   for (Stmt::const_child_range I = S->children(); I; ++I)
656     if (ContainsLabel(*I, IgnoreCaseStmts))
657       return true;
658 
659   return false;
660 }
661 
662 /// containsBreak - Return true if the statement contains a break out of it.
663 /// If the statement (recursively) contains a switch or loop with a break
664 /// inside of it, this is fine.
665 bool CodeGenFunction::containsBreak(const Stmt *S) {
666   // Null statement, not a label!
667   if (S == 0) return false;
668 
669   // If this is a switch or loop that defines its own break scope, then we can
670   // include it and anything inside of it.
671   if (isa<SwitchStmt>(S) || isa<WhileStmt>(S) || isa<DoStmt>(S) ||
672       isa<ForStmt>(S))
673     return false;
674 
675   if (isa<BreakStmt>(S))
676     return true;
677 
678   // Scan subexpressions for verboten breaks.
679   for (Stmt::const_child_range I = S->children(); I; ++I)
680     if (containsBreak(*I))
681       return true;
682 
683   return false;
684 }
685 
686 
687 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
688 /// to a constant, or if it does but contains a label, return false.  If it
689 /// constant folds return true and set the boolean result in Result.
690 bool CodeGenFunction::ConstantFoldsToSimpleInteger(const Expr *Cond,
691                                                    bool &ResultBool) {
692   llvm::APSInt ResultInt;
693   if (!ConstantFoldsToSimpleInteger(Cond, ResultInt))
694     return false;
695 
696   ResultBool = ResultInt.getBoolValue();
697   return true;
698 }
699 
700 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
701 /// to a constant, or if it does but contains a label, return false.  If it
702 /// constant folds return true and set the folded value.
703 bool CodeGenFunction::
704 ConstantFoldsToSimpleInteger(const Expr *Cond, llvm::APSInt &ResultInt) {
705   // FIXME: Rename and handle conversion of other evaluatable things
706   // to bool.
707   llvm::APSInt Int;
708   if (!Cond->EvaluateAsInt(Int, getContext()))
709     return false;  // Not foldable, not integer or not fully evaluatable.
710 
711   if (CodeGenFunction::ContainsLabel(Cond))
712     return false;  // Contains a label.
713 
714   ResultInt = Int;
715   return true;
716 }
717 
718 
719 
720 /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an if
721 /// statement) to the specified blocks.  Based on the condition, this might try
722 /// to simplify the codegen of the conditional based on the branch.
723 ///
724 void CodeGenFunction::EmitBranchOnBoolExpr(const Expr *Cond,
725                                            llvm::BasicBlock *TrueBlock,
726                                            llvm::BasicBlock *FalseBlock) {
727   Cond = Cond->IgnoreParens();
728 
729   if (const BinaryOperator *CondBOp = dyn_cast<BinaryOperator>(Cond)) {
730     // Handle X && Y in a condition.
731     if (CondBOp->getOpcode() == BO_LAnd) {
732       // If we have "1 && X", simplify the code.  "0 && X" would have constant
733       // folded if the case was simple enough.
734       bool ConstantBool = false;
735       if (ConstantFoldsToSimpleInteger(CondBOp->getLHS(), ConstantBool) &&
736           ConstantBool) {
737         // br(1 && X) -> br(X).
738         return EmitBranchOnBoolExpr(CondBOp->getRHS(), TrueBlock, FalseBlock);
739       }
740 
741       // If we have "X && 1", simplify the code to use an uncond branch.
742       // "X && 0" would have been constant folded to 0.
743       if (ConstantFoldsToSimpleInteger(CondBOp->getRHS(), ConstantBool) &&
744           ConstantBool) {
745         // br(X && 1) -> br(X).
746         return EmitBranchOnBoolExpr(CondBOp->getLHS(), TrueBlock, FalseBlock);
747       }
748 
749       // Emit the LHS as a conditional.  If the LHS conditional is false, we
750       // want to jump to the FalseBlock.
751       llvm::BasicBlock *LHSTrue = createBasicBlock("land.lhs.true");
752 
753       ConditionalEvaluation eval(*this);
754       EmitBranchOnBoolExpr(CondBOp->getLHS(), LHSTrue, FalseBlock);
755       EmitBlock(LHSTrue);
756 
757       // Any temporaries created here are conditional.
758       eval.begin(*this);
759       EmitBranchOnBoolExpr(CondBOp->getRHS(), TrueBlock, FalseBlock);
760       eval.end(*this);
761 
762       return;
763     }
764 
765     if (CondBOp->getOpcode() == BO_LOr) {
766       // If we have "0 || X", simplify the code.  "1 || X" would have constant
767       // folded if the case was simple enough.
768       bool ConstantBool = false;
769       if (ConstantFoldsToSimpleInteger(CondBOp->getLHS(), ConstantBool) &&
770           !ConstantBool) {
771         // br(0 || X) -> br(X).
772         return EmitBranchOnBoolExpr(CondBOp->getRHS(), TrueBlock, FalseBlock);
773       }
774 
775       // If we have "X || 0", simplify the code to use an uncond branch.
776       // "X || 1" would have been constant folded to 1.
777       if (ConstantFoldsToSimpleInteger(CondBOp->getRHS(), ConstantBool) &&
778           !ConstantBool) {
779         // br(X || 0) -> br(X).
780         return EmitBranchOnBoolExpr(CondBOp->getLHS(), TrueBlock, FalseBlock);
781       }
782 
783       // Emit the LHS as a conditional.  If the LHS conditional is true, we
784       // want to jump to the TrueBlock.
785       llvm::BasicBlock *LHSFalse = createBasicBlock("lor.lhs.false");
786 
787       ConditionalEvaluation eval(*this);
788       EmitBranchOnBoolExpr(CondBOp->getLHS(), TrueBlock, LHSFalse);
789       EmitBlock(LHSFalse);
790 
791       // Any temporaries created here are conditional.
792       eval.begin(*this);
793       EmitBranchOnBoolExpr(CondBOp->getRHS(), TrueBlock, FalseBlock);
794       eval.end(*this);
795 
796       return;
797     }
798   }
799 
800   if (const UnaryOperator *CondUOp = dyn_cast<UnaryOperator>(Cond)) {
801     // br(!x, t, f) -> br(x, f, t)
802     if (CondUOp->getOpcode() == UO_LNot)
803       return EmitBranchOnBoolExpr(CondUOp->getSubExpr(), FalseBlock, TrueBlock);
804   }
805 
806   if (const ConditionalOperator *CondOp = dyn_cast<ConditionalOperator>(Cond)) {
807     // br(c ? x : y, t, f) -> br(c, br(x, t, f), br(y, t, f))
808     llvm::BasicBlock *LHSBlock = createBasicBlock("cond.true");
809     llvm::BasicBlock *RHSBlock = createBasicBlock("cond.false");
810 
811     ConditionalEvaluation cond(*this);
812     EmitBranchOnBoolExpr(CondOp->getCond(), LHSBlock, RHSBlock);
813 
814     cond.begin(*this);
815     EmitBlock(LHSBlock);
816     EmitBranchOnBoolExpr(CondOp->getLHS(), TrueBlock, FalseBlock);
817     cond.end(*this);
818 
819     cond.begin(*this);
820     EmitBlock(RHSBlock);
821     EmitBranchOnBoolExpr(CondOp->getRHS(), TrueBlock, FalseBlock);
822     cond.end(*this);
823 
824     return;
825   }
826 
827   // Emit the code with the fully general case.
828   llvm::Value *CondV = EvaluateExprAsBool(Cond);
829   Builder.CreateCondBr(CondV, TrueBlock, FalseBlock);
830 }
831 
832 /// ErrorUnsupported - Print out an error that codegen doesn't support the
833 /// specified stmt yet.
834 void CodeGenFunction::ErrorUnsupported(const Stmt *S, const char *Type,
835                                        bool OmitOnError) {
836   CGM.ErrorUnsupported(S, Type, OmitOnError);
837 }
838 
839 /// emitNonZeroVLAInit - Emit the "zero" initialization of a
840 /// variable-length array whose elements have a non-zero bit-pattern.
841 ///
842 /// \param baseType the inner-most element type of the array
843 /// \param src - a char* pointing to the bit-pattern for a single
844 /// base element of the array
845 /// \param sizeInChars - the total size of the VLA, in chars
846 static void emitNonZeroVLAInit(CodeGenFunction &CGF, QualType baseType,
847                                llvm::Value *dest, llvm::Value *src,
848                                llvm::Value *sizeInChars) {
849   std::pair<CharUnits,CharUnits> baseSizeAndAlign
850     = CGF.getContext().getTypeInfoInChars(baseType);
851 
852   CGBuilderTy &Builder = CGF.Builder;
853 
854   llvm::Value *baseSizeInChars
855     = llvm::ConstantInt::get(CGF.IntPtrTy, baseSizeAndAlign.first.getQuantity());
856 
857   llvm::Type *i8p = Builder.getInt8PtrTy();
858 
859   llvm::Value *begin = Builder.CreateBitCast(dest, i8p, "vla.begin");
860   llvm::Value *end = Builder.CreateInBoundsGEP(dest, sizeInChars, "vla.end");
861 
862   llvm::BasicBlock *originBB = CGF.Builder.GetInsertBlock();
863   llvm::BasicBlock *loopBB = CGF.createBasicBlock("vla-init.loop");
864   llvm::BasicBlock *contBB = CGF.createBasicBlock("vla-init.cont");
865 
866   // Make a loop over the VLA.  C99 guarantees that the VLA element
867   // count must be nonzero.
868   CGF.EmitBlock(loopBB);
869 
870   llvm::PHINode *cur = Builder.CreatePHI(i8p, 2, "vla.cur");
871   cur->addIncoming(begin, originBB);
872 
873   // memcpy the individual element bit-pattern.
874   Builder.CreateMemCpy(cur, src, baseSizeInChars,
875                        baseSizeAndAlign.second.getQuantity(),
876                        /*volatile*/ false);
877 
878   // Go to the next element.
879   llvm::Value *next = Builder.CreateConstInBoundsGEP1_32(cur, 1, "vla.next");
880 
881   // Leave if that's the end of the VLA.
882   llvm::Value *done = Builder.CreateICmpEQ(next, end, "vla-init.isdone");
883   Builder.CreateCondBr(done, contBB, loopBB);
884   cur->addIncoming(next, loopBB);
885 
886   CGF.EmitBlock(contBB);
887 }
888 
889 void
890 CodeGenFunction::EmitNullInitialization(llvm::Value *DestPtr, QualType Ty) {
891   // Ignore empty classes in C++.
892   if (getLangOpts().CPlusPlus) {
893     if (const RecordType *RT = Ty->getAs<RecordType>()) {
894       if (cast<CXXRecordDecl>(RT->getDecl())->isEmpty())
895         return;
896     }
897   }
898 
899   // Cast the dest ptr to the appropriate i8 pointer type.
900   unsigned DestAS =
901     cast<llvm::PointerType>(DestPtr->getType())->getAddressSpace();
902   llvm::Type *BP = Builder.getInt8PtrTy(DestAS);
903   if (DestPtr->getType() != BP)
904     DestPtr = Builder.CreateBitCast(DestPtr, BP);
905 
906   // Get size and alignment info for this aggregate.
907   std::pair<CharUnits, CharUnits> TypeInfo =
908     getContext().getTypeInfoInChars(Ty);
909   CharUnits Size = TypeInfo.first;
910   CharUnits Align = TypeInfo.second;
911 
912   llvm::Value *SizeVal;
913   const VariableArrayType *vla;
914 
915   // Don't bother emitting a zero-byte memset.
916   if (Size.isZero()) {
917     // But note that getTypeInfo returns 0 for a VLA.
918     if (const VariableArrayType *vlaType =
919           dyn_cast_or_null<VariableArrayType>(
920                                           getContext().getAsArrayType(Ty))) {
921       QualType eltType;
922       llvm::Value *numElts;
923       llvm::tie(numElts, eltType) = getVLASize(vlaType);
924 
925       SizeVal = numElts;
926       CharUnits eltSize = getContext().getTypeSizeInChars(eltType);
927       if (!eltSize.isOne())
928         SizeVal = Builder.CreateNUWMul(SizeVal, CGM.getSize(eltSize));
929       vla = vlaType;
930     } else {
931       return;
932     }
933   } else {
934     SizeVal = CGM.getSize(Size);
935     vla = 0;
936   }
937 
938   // If the type contains a pointer to data member we can't memset it to zero.
939   // Instead, create a null constant and copy it to the destination.
940   // TODO: there are other patterns besides zero that we can usefully memset,
941   // like -1, which happens to be the pattern used by member-pointers.
942   if (!CGM.getTypes().isZeroInitializable(Ty)) {
943     // For a VLA, emit a single element, then splat that over the VLA.
944     if (vla) Ty = getContext().getBaseElementType(vla);
945 
946     llvm::Constant *NullConstant = CGM.EmitNullConstant(Ty);
947 
948     llvm::GlobalVariable *NullVariable =
949       new llvm::GlobalVariable(CGM.getModule(), NullConstant->getType(),
950                                /*isConstant=*/true,
951                                llvm::GlobalVariable::PrivateLinkage,
952                                NullConstant, Twine());
953     llvm::Value *SrcPtr =
954       Builder.CreateBitCast(NullVariable, Builder.getInt8PtrTy());
955 
956     if (vla) return emitNonZeroVLAInit(*this, Ty, DestPtr, SrcPtr, SizeVal);
957 
958     // Get and call the appropriate llvm.memcpy overload.
959     Builder.CreateMemCpy(DestPtr, SrcPtr, SizeVal, Align.getQuantity(), false);
960     return;
961   }
962 
963   // Otherwise, just memset the whole thing to zero.  This is legal
964   // because in LLVM, all default initializers (other than the ones we just
965   // handled above) are guaranteed to have a bit pattern of all zeros.
966   Builder.CreateMemSet(DestPtr, Builder.getInt8(0), SizeVal,
967                        Align.getQuantity(), false);
968 }
969 
970 llvm::BlockAddress *CodeGenFunction::GetAddrOfLabel(const LabelDecl *L) {
971   // Make sure that there is a block for the indirect goto.
972   if (IndirectBranch == 0)
973     GetIndirectGotoBlock();
974 
975   llvm::BasicBlock *BB = getJumpDestForLabel(L).getBlock();
976 
977   // Make sure the indirect branch includes all of the address-taken blocks.
978   IndirectBranch->addDestination(BB);
979   return llvm::BlockAddress::get(CurFn, BB);
980 }
981 
982 llvm::BasicBlock *CodeGenFunction::GetIndirectGotoBlock() {
983   // If we already made the indirect branch for indirect goto, return its block.
984   if (IndirectBranch) return IndirectBranch->getParent();
985 
986   CGBuilderTy TmpBuilder(createBasicBlock("indirectgoto"));
987 
988   // Create the PHI node that indirect gotos will add entries to.
989   llvm::Value *DestVal = TmpBuilder.CreatePHI(Int8PtrTy, 0,
990                                               "indirect.goto.dest");
991 
992   // Create the indirect branch instruction.
993   IndirectBranch = TmpBuilder.CreateIndirectBr(DestVal);
994   return IndirectBranch->getParent();
995 }
996 
997 /// Computes the length of an array in elements, as well as the base
998 /// element type and a properly-typed first element pointer.
999 llvm::Value *CodeGenFunction::emitArrayLength(const ArrayType *origArrayType,
1000                                               QualType &baseType,
1001                                               llvm::Value *&addr) {
1002   const ArrayType *arrayType = origArrayType;
1003 
1004   // If it's a VLA, we have to load the stored size.  Note that
1005   // this is the size of the VLA in bytes, not its size in elements.
1006   llvm::Value *numVLAElements = 0;
1007   if (isa<VariableArrayType>(arrayType)) {
1008     numVLAElements = getVLASize(cast<VariableArrayType>(arrayType)).first;
1009 
1010     // Walk into all VLAs.  This doesn't require changes to addr,
1011     // which has type T* where T is the first non-VLA element type.
1012     do {
1013       QualType elementType = arrayType->getElementType();
1014       arrayType = getContext().getAsArrayType(elementType);
1015 
1016       // If we only have VLA components, 'addr' requires no adjustment.
1017       if (!arrayType) {
1018         baseType = elementType;
1019         return numVLAElements;
1020       }
1021     } while (isa<VariableArrayType>(arrayType));
1022 
1023     // We get out here only if we find a constant array type
1024     // inside the VLA.
1025   }
1026 
1027   // We have some number of constant-length arrays, so addr should
1028   // have LLVM type [M x [N x [...]]]*.  Build a GEP that walks
1029   // down to the first element of addr.
1030   SmallVector<llvm::Value*, 8> gepIndices;
1031 
1032   // GEP down to the array type.
1033   llvm::ConstantInt *zero = Builder.getInt32(0);
1034   gepIndices.push_back(zero);
1035 
1036   uint64_t countFromCLAs = 1;
1037   QualType eltType;
1038 
1039   llvm::ArrayType *llvmArrayType =
1040     dyn_cast<llvm::ArrayType>(
1041       cast<llvm::PointerType>(addr->getType())->getElementType());
1042   while (llvmArrayType) {
1043     assert(isa<ConstantArrayType>(arrayType));
1044     assert(cast<ConstantArrayType>(arrayType)->getSize().getZExtValue()
1045              == llvmArrayType->getNumElements());
1046 
1047     gepIndices.push_back(zero);
1048     countFromCLAs *= llvmArrayType->getNumElements();
1049     eltType = arrayType->getElementType();
1050 
1051     llvmArrayType =
1052       dyn_cast<llvm::ArrayType>(llvmArrayType->getElementType());
1053     arrayType = getContext().getAsArrayType(arrayType->getElementType());
1054     assert((!llvmArrayType || arrayType) &&
1055            "LLVM and Clang types are out-of-synch");
1056   }
1057 
1058   if (arrayType) {
1059     // From this point onwards, the Clang array type has been emitted
1060     // as some other type (probably a packed struct). Compute the array
1061     // size, and just emit the 'begin' expression as a bitcast.
1062     while (arrayType) {
1063       countFromCLAs *=
1064           cast<ConstantArrayType>(arrayType)->getSize().getZExtValue();
1065       eltType = arrayType->getElementType();
1066       arrayType = getContext().getAsArrayType(eltType);
1067     }
1068 
1069     unsigned AddressSpace = addr->getType()->getPointerAddressSpace();
1070     llvm::Type *BaseType = ConvertType(eltType)->getPointerTo(AddressSpace);
1071     addr = Builder.CreateBitCast(addr, BaseType, "array.begin");
1072   } else {
1073     // Create the actual GEP.
1074     addr = Builder.CreateInBoundsGEP(addr, gepIndices, "array.begin");
1075   }
1076 
1077   baseType = eltType;
1078 
1079   llvm::Value *numElements
1080     = llvm::ConstantInt::get(SizeTy, countFromCLAs);
1081 
1082   // If we had any VLA dimensions, factor them in.
1083   if (numVLAElements)
1084     numElements = Builder.CreateNUWMul(numVLAElements, numElements);
1085 
1086   return numElements;
1087 }
1088 
1089 std::pair<llvm::Value*, QualType>
1090 CodeGenFunction::getVLASize(QualType type) {
1091   const VariableArrayType *vla = getContext().getAsVariableArrayType(type);
1092   assert(vla && "type was not a variable array type!");
1093   return getVLASize(vla);
1094 }
1095 
1096 std::pair<llvm::Value*, QualType>
1097 CodeGenFunction::getVLASize(const VariableArrayType *type) {
1098   // The number of elements so far; always size_t.
1099   llvm::Value *numElements = 0;
1100 
1101   QualType elementType;
1102   do {
1103     elementType = type->getElementType();
1104     llvm::Value *vlaSize = VLASizeMap[type->getSizeExpr()];
1105     assert(vlaSize && "no size for VLA!");
1106     assert(vlaSize->getType() == SizeTy);
1107 
1108     if (!numElements) {
1109       numElements = vlaSize;
1110     } else {
1111       // It's undefined behavior if this wraps around, so mark it that way.
1112       // FIXME: Teach -fcatch-undefined-behavior to trap this.
1113       numElements = Builder.CreateNUWMul(numElements, vlaSize);
1114     }
1115   } while ((type = getContext().getAsVariableArrayType(elementType)));
1116 
1117   return std::pair<llvm::Value*,QualType>(numElements, elementType);
1118 }
1119 
1120 void CodeGenFunction::EmitVariablyModifiedType(QualType type) {
1121   assert(type->isVariablyModifiedType() &&
1122          "Must pass variably modified type to EmitVLASizes!");
1123 
1124   EnsureInsertPoint();
1125 
1126   // We're going to walk down into the type and look for VLA
1127   // expressions.
1128   do {
1129     assert(type->isVariablyModifiedType());
1130 
1131     const Type *ty = type.getTypePtr();
1132     switch (ty->getTypeClass()) {
1133 
1134 #define TYPE(Class, Base)
1135 #define ABSTRACT_TYPE(Class, Base)
1136 #define NON_CANONICAL_TYPE(Class, Base)
1137 #define DEPENDENT_TYPE(Class, Base) case Type::Class:
1138 #define NON_CANONICAL_UNLESS_DEPENDENT_TYPE(Class, Base)
1139 #include "clang/AST/TypeNodes.def"
1140       llvm_unreachable("unexpected dependent type!");
1141 
1142     // These types are never variably-modified.
1143     case Type::Builtin:
1144     case Type::Complex:
1145     case Type::Vector:
1146     case Type::ExtVector:
1147     case Type::Record:
1148     case Type::Enum:
1149     case Type::Elaborated:
1150     case Type::TemplateSpecialization:
1151     case Type::ObjCObject:
1152     case Type::ObjCInterface:
1153     case Type::ObjCObjectPointer:
1154       llvm_unreachable("type class is never variably-modified!");
1155 
1156     case Type::Pointer:
1157       type = cast<PointerType>(ty)->getPointeeType();
1158       break;
1159 
1160     case Type::BlockPointer:
1161       type = cast<BlockPointerType>(ty)->getPointeeType();
1162       break;
1163 
1164     case Type::LValueReference:
1165     case Type::RValueReference:
1166       type = cast<ReferenceType>(ty)->getPointeeType();
1167       break;
1168 
1169     case Type::MemberPointer:
1170       type = cast<MemberPointerType>(ty)->getPointeeType();
1171       break;
1172 
1173     case Type::ConstantArray:
1174     case Type::IncompleteArray:
1175       // Losing element qualification here is fine.
1176       type = cast<ArrayType>(ty)->getElementType();
1177       break;
1178 
1179     case Type::VariableArray: {
1180       // Losing element qualification here is fine.
1181       const VariableArrayType *vat = cast<VariableArrayType>(ty);
1182 
1183       // Unknown size indication requires no size computation.
1184       // Otherwise, evaluate and record it.
1185       if (const Expr *size = vat->getSizeExpr()) {
1186         // It's possible that we might have emitted this already,
1187         // e.g. with a typedef and a pointer to it.
1188         llvm::Value *&entry = VLASizeMap[size];
1189         if (!entry) {
1190           llvm::Value *Size = EmitScalarExpr(size);
1191 
1192           // C11 6.7.6.2p5:
1193           //   If the size is an expression that is not an integer constant
1194           //   expression [...] each time it is evaluated it shall have a value
1195           //   greater than zero.
1196           if (SanOpts->VLABound &&
1197               size->getType()->isSignedIntegerType()) {
1198             llvm::Value *Zero = llvm::Constant::getNullValue(Size->getType());
1199             llvm::Constant *StaticArgs[] = {
1200               EmitCheckSourceLocation(size->getLocStart()),
1201               EmitCheckTypeDescriptor(size->getType())
1202             };
1203             EmitCheck(Builder.CreateICmpSGT(Size, Zero),
1204                       "vla_bound_not_positive", StaticArgs, Size,
1205                       CRK_Recoverable);
1206           }
1207 
1208           // Always zexting here would be wrong if it weren't
1209           // undefined behavior to have a negative bound.
1210           entry = Builder.CreateIntCast(Size, SizeTy, /*signed*/ false);
1211         }
1212       }
1213       type = vat->getElementType();
1214       break;
1215     }
1216 
1217     case Type::FunctionProto:
1218     case Type::FunctionNoProto:
1219       type = cast<FunctionType>(ty)->getResultType();
1220       break;
1221 
1222     case Type::Paren:
1223     case Type::TypeOf:
1224     case Type::UnaryTransform:
1225     case Type::Attributed:
1226     case Type::SubstTemplateTypeParm:
1227       // Keep walking after single level desugaring.
1228       type = type.getSingleStepDesugaredType(getContext());
1229       break;
1230 
1231     case Type::Typedef:
1232     case Type::Decltype:
1233     case Type::Auto:
1234       // Stop walking: nothing to do.
1235       return;
1236 
1237     case Type::TypeOfExpr:
1238       // Stop walking: emit typeof expression.
1239       EmitIgnoredExpr(cast<TypeOfExprType>(ty)->getUnderlyingExpr());
1240       return;
1241 
1242     case Type::Atomic:
1243       type = cast<AtomicType>(ty)->getValueType();
1244       break;
1245     }
1246   } while (type->isVariablyModifiedType());
1247 }
1248 
1249 llvm::Value* CodeGenFunction::EmitVAListRef(const Expr* E) {
1250   if (getContext().getBuiltinVaListType()->isArrayType())
1251     return EmitScalarExpr(E);
1252   return EmitLValue(E).getAddress();
1253 }
1254 
1255 void CodeGenFunction::EmitDeclRefExprDbgValue(const DeclRefExpr *E,
1256                                               llvm::Constant *Init) {
1257   assert (Init && "Invalid DeclRefExpr initializer!");
1258   if (CGDebugInfo *Dbg = getDebugInfo())
1259     if (CGM.getCodeGenOpts().getDebugInfo() >= CodeGenOptions::LimitedDebugInfo)
1260       Dbg->EmitGlobalVariable(E->getDecl(), Init);
1261 }
1262 
1263 CodeGenFunction::PeepholeProtection
1264 CodeGenFunction::protectFromPeepholes(RValue rvalue) {
1265   // At the moment, the only aggressive peephole we do in IR gen
1266   // is trunc(zext) folding, but if we add more, we can easily
1267   // extend this protection.
1268 
1269   if (!rvalue.isScalar()) return PeepholeProtection();
1270   llvm::Value *value = rvalue.getScalarVal();
1271   if (!isa<llvm::ZExtInst>(value)) return PeepholeProtection();
1272 
1273   // Just make an extra bitcast.
1274   assert(HaveInsertPoint());
1275   llvm::Instruction *inst = new llvm::BitCastInst(value, value->getType(), "",
1276                                                   Builder.GetInsertBlock());
1277 
1278   PeepholeProtection protection;
1279   protection.Inst = inst;
1280   return protection;
1281 }
1282 
1283 void CodeGenFunction::unprotectFromPeepholes(PeepholeProtection protection) {
1284   if (!protection.Inst) return;
1285 
1286   // In theory, we could try to duplicate the peepholes now, but whatever.
1287   protection.Inst->eraseFromParent();
1288 }
1289 
1290 llvm::Value *CodeGenFunction::EmitAnnotationCall(llvm::Value *AnnotationFn,
1291                                                  llvm::Value *AnnotatedVal,
1292                                                  StringRef AnnotationStr,
1293                                                  SourceLocation Location) {
1294   llvm::Value *Args[4] = {
1295     AnnotatedVal,
1296     Builder.CreateBitCast(CGM.EmitAnnotationString(AnnotationStr), Int8PtrTy),
1297     Builder.CreateBitCast(CGM.EmitAnnotationUnit(Location), Int8PtrTy),
1298     CGM.EmitAnnotationLineNo(Location)
1299   };
1300   return Builder.CreateCall(AnnotationFn, Args);
1301 }
1302 
1303 void CodeGenFunction::EmitVarAnnotations(const VarDecl *D, llvm::Value *V) {
1304   assert(D->hasAttr<AnnotateAttr>() && "no annotate attribute");
1305   // FIXME We create a new bitcast for every annotation because that's what
1306   // llvm-gcc was doing.
1307   for (specific_attr_iterator<AnnotateAttr>
1308        ai = D->specific_attr_begin<AnnotateAttr>(),
1309        ae = D->specific_attr_end<AnnotateAttr>(); ai != ae; ++ai)
1310     EmitAnnotationCall(CGM.getIntrinsic(llvm::Intrinsic::var_annotation),
1311                        Builder.CreateBitCast(V, CGM.Int8PtrTy, V->getName()),
1312                        (*ai)->getAnnotation(), D->getLocation());
1313 }
1314 
1315 llvm::Value *CodeGenFunction::EmitFieldAnnotations(const FieldDecl *D,
1316                                                    llvm::Value *V) {
1317   assert(D->hasAttr<AnnotateAttr>() && "no annotate attribute");
1318   llvm::Type *VTy = V->getType();
1319   llvm::Value *F = CGM.getIntrinsic(llvm::Intrinsic::ptr_annotation,
1320                                     CGM.Int8PtrTy);
1321 
1322   for (specific_attr_iterator<AnnotateAttr>
1323        ai = D->specific_attr_begin<AnnotateAttr>(),
1324        ae = D->specific_attr_end<AnnotateAttr>(); ai != ae; ++ai) {
1325     // FIXME Always emit the cast inst so we can differentiate between
1326     // annotation on the first field of a struct and annotation on the struct
1327     // itself.
1328     if (VTy != CGM.Int8PtrTy)
1329       V = Builder.Insert(new llvm::BitCastInst(V, CGM.Int8PtrTy));
1330     V = EmitAnnotationCall(F, V, (*ai)->getAnnotation(), D->getLocation());
1331     V = Builder.CreateBitCast(V, VTy);
1332   }
1333 
1334   return V;
1335 }
1336