1 //===--- CGException.cpp - Emit LLVM Code for C++ exceptions --------------===//
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 contains code dealing with C++ exception related code generation.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #include "CodeGenFunction.h"
15 #include "CGCXXABI.h"
16 #include "CGCleanup.h"
17 #include "CGObjCRuntime.h"
18 #include "TargetInfo.h"
19 #include "clang/AST/Mangle.h"
20 #include "clang/AST/StmtCXX.h"
21 #include "clang/AST/StmtObjC.h"
22 #include "clang/AST/StmtVisitor.h"
23 #include "clang/Basic/TargetBuiltins.h"
24 #include "llvm/IR/CallSite.h"
25 #include "llvm/IR/Intrinsics.h"
26 #include "llvm/IR/IntrinsicInst.h"
27 #include "llvm/Support/SaveAndRestore.h"
28 
29 using namespace clang;
30 using namespace CodeGen;
31 
32 static llvm::Constant *getFreeExceptionFn(CodeGenModule &CGM) {
33   // void __cxa_free_exception(void *thrown_exception);
34 
35   llvm::FunctionType *FTy =
36     llvm::FunctionType::get(CGM.VoidTy, CGM.Int8PtrTy, /*IsVarArgs=*/false);
37 
38   return CGM.CreateRuntimeFunction(FTy, "__cxa_free_exception");
39 }
40 
41 static llvm::Constant *getUnexpectedFn(CodeGenModule &CGM) {
42   // void __cxa_call_unexpected(void *thrown_exception);
43 
44   llvm::FunctionType *FTy =
45     llvm::FunctionType::get(CGM.VoidTy, CGM.Int8PtrTy, /*IsVarArgs=*/false);
46 
47   return CGM.CreateRuntimeFunction(FTy, "__cxa_call_unexpected");
48 }
49 
50 llvm::Constant *CodeGenModule::getTerminateFn() {
51   // void __terminate();
52 
53   llvm::FunctionType *FTy =
54     llvm::FunctionType::get(VoidTy, /*IsVarArgs=*/false);
55 
56   StringRef name;
57 
58   // In C++, use std::terminate().
59   if (getLangOpts().CPlusPlus &&
60       getTarget().getCXXABI().isItaniumFamily()) {
61     name = "_ZSt9terminatev";
62   } else if (getLangOpts().CPlusPlus &&
63              getTarget().getCXXABI().isMicrosoft()) {
64     if (getLangOpts().isCompatibleWithMSVC(LangOptions::MSVC2015))
65       name = "__std_terminate";
66     else
67       name = "\01?terminate@@YAXXZ";
68   } else if (getLangOpts().ObjC1 &&
69              getLangOpts().ObjCRuntime.hasTerminate())
70     name = "objc_terminate";
71   else
72     name = "abort";
73   return CreateRuntimeFunction(FTy, name);
74 }
75 
76 static llvm::Constant *getCatchallRethrowFn(CodeGenModule &CGM,
77                                             StringRef Name) {
78   llvm::FunctionType *FTy =
79     llvm::FunctionType::get(CGM.VoidTy, CGM.Int8PtrTy, /*IsVarArgs=*/false);
80 
81   return CGM.CreateRuntimeFunction(FTy, Name);
82 }
83 
84 const EHPersonality EHPersonality::GNU_C = { "__gcc_personality_v0", nullptr };
85 const EHPersonality
86 EHPersonality::GNU_C_SJLJ = { "__gcc_personality_sj0", nullptr };
87 const EHPersonality
88 EHPersonality::GNU_C_SEH = { "__gcc_personality_seh0", nullptr };
89 const EHPersonality
90 EHPersonality::NeXT_ObjC = { "__objc_personality_v0", nullptr };
91 const EHPersonality
92 EHPersonality::GNU_CPlusPlus = { "__gxx_personality_v0", nullptr };
93 const EHPersonality
94 EHPersonality::GNU_CPlusPlus_SJLJ = { "__gxx_personality_sj0", nullptr };
95 const EHPersonality
96 EHPersonality::GNU_CPlusPlus_SEH = { "__gxx_personality_seh0", nullptr };
97 const EHPersonality
98 EHPersonality::GNU_ObjC = {"__gnu_objc_personality_v0", "objc_exception_throw"};
99 const EHPersonality
100 EHPersonality::GNU_ObjCXX = { "__gnustep_objcxx_personality_v0", nullptr };
101 const EHPersonality
102 EHPersonality::GNUstep_ObjC = { "__gnustep_objc_personality_v0", nullptr };
103 const EHPersonality
104 EHPersonality::MSVC_except_handler = { "_except_handler3", nullptr };
105 const EHPersonality
106 EHPersonality::MSVC_C_specific_handler = { "__C_specific_handler", nullptr };
107 const EHPersonality
108 EHPersonality::MSVC_CxxFrameHandler3 = { "__CxxFrameHandler3", nullptr };
109 
110 /// On Win64, use libgcc's SEH personality function. We fall back to dwarf on
111 /// other platforms, unless the user asked for SjLj exceptions.
112 static bool useLibGCCSEHPersonality(const llvm::Triple &T) {
113   return T.isOSWindows() && T.getArch() == llvm::Triple::x86_64;
114 }
115 
116 static const EHPersonality &getCPersonality(const llvm::Triple &T,
117                                             const LangOptions &L) {
118   if (L.SjLjExceptions)
119     return EHPersonality::GNU_C_SJLJ;
120   else if (useLibGCCSEHPersonality(T))
121     return EHPersonality::GNU_C_SEH;
122   return EHPersonality::GNU_C;
123 }
124 
125 static const EHPersonality &getObjCPersonality(const llvm::Triple &T,
126                                                const LangOptions &L) {
127   switch (L.ObjCRuntime.getKind()) {
128   case ObjCRuntime::FragileMacOSX:
129     return getCPersonality(T, L);
130   case ObjCRuntime::MacOSX:
131   case ObjCRuntime::iOS:
132     return EHPersonality::NeXT_ObjC;
133   case ObjCRuntime::GNUstep:
134     if (L.ObjCRuntime.getVersion() >= VersionTuple(1, 7))
135       return EHPersonality::GNUstep_ObjC;
136     // fallthrough
137   case ObjCRuntime::GCC:
138   case ObjCRuntime::ObjFW:
139     return EHPersonality::GNU_ObjC;
140   }
141   llvm_unreachable("bad runtime kind");
142 }
143 
144 static const EHPersonality &getCXXPersonality(const llvm::Triple &T,
145                                               const LangOptions &L) {
146   if (L.SjLjExceptions)
147     return EHPersonality::GNU_CPlusPlus_SJLJ;
148   else if (useLibGCCSEHPersonality(T))
149     return EHPersonality::GNU_CPlusPlus_SEH;
150   return EHPersonality::GNU_CPlusPlus;
151 }
152 
153 /// Determines the personality function to use when both C++
154 /// and Objective-C exceptions are being caught.
155 static const EHPersonality &getObjCXXPersonality(const llvm::Triple &T,
156                                                  const LangOptions &L) {
157   switch (L.ObjCRuntime.getKind()) {
158   // The ObjC personality defers to the C++ personality for non-ObjC
159   // handlers.  Unlike the C++ case, we use the same personality
160   // function on targets using (backend-driven) SJLJ EH.
161   case ObjCRuntime::MacOSX:
162   case ObjCRuntime::iOS:
163     return EHPersonality::NeXT_ObjC;
164 
165   // In the fragile ABI, just use C++ exception handling and hope
166   // they're not doing crazy exception mixing.
167   case ObjCRuntime::FragileMacOSX:
168     return getCXXPersonality(T, L);
169 
170   // The GCC runtime's personality function inherently doesn't support
171   // mixed EH.  Use the C++ personality just to avoid returning null.
172   case ObjCRuntime::GCC:
173   case ObjCRuntime::ObjFW: // XXX: this will change soon
174     return EHPersonality::GNU_ObjC;
175   case ObjCRuntime::GNUstep:
176     return EHPersonality::GNU_ObjCXX;
177   }
178   llvm_unreachable("bad runtime kind");
179 }
180 
181 static const EHPersonality &getSEHPersonalityMSVC(const llvm::Triple &T) {
182   if (T.getArch() == llvm::Triple::x86)
183     return EHPersonality::MSVC_except_handler;
184   return EHPersonality::MSVC_C_specific_handler;
185 }
186 
187 const EHPersonality &EHPersonality::get(CodeGenModule &CGM,
188                                         const FunctionDecl *FD) {
189   const llvm::Triple &T = CGM.getTarget().getTriple();
190   const LangOptions &L = CGM.getLangOpts();
191 
192   // Functions using SEH get an SEH personality.
193   if (FD && FD->usesSEHTry())
194     return getSEHPersonalityMSVC(T);
195 
196   // Try to pick a personality function that is compatible with MSVC if we're
197   // not compiling Obj-C. Obj-C users better have an Obj-C runtime that supports
198   // the GCC-style personality function.
199   if (T.isWindowsMSVCEnvironment() && !L.ObjC1) {
200     if (L.SjLjExceptions)
201       return EHPersonality::GNU_CPlusPlus_SJLJ;
202     else
203       return EHPersonality::MSVC_CxxFrameHandler3;
204   }
205 
206   if (L.CPlusPlus && L.ObjC1)
207     return getObjCXXPersonality(T, L);
208   else if (L.CPlusPlus)
209     return getCXXPersonality(T, L);
210   else if (L.ObjC1)
211     return getObjCPersonality(T, L);
212   else
213     return getCPersonality(T, L);
214 }
215 
216 const EHPersonality &EHPersonality::get(CodeGenFunction &CGF) {
217   return get(CGF.CGM, dyn_cast_or_null<FunctionDecl>(CGF.CurCodeDecl));
218 }
219 
220 static llvm::Constant *getPersonalityFn(CodeGenModule &CGM,
221                                         const EHPersonality &Personality) {
222   llvm::Constant *Fn =
223     CGM.CreateRuntimeFunction(llvm::FunctionType::get(CGM.Int32Ty, true),
224                               Personality.PersonalityFn);
225   return Fn;
226 }
227 
228 static llvm::Constant *getOpaquePersonalityFn(CodeGenModule &CGM,
229                                         const EHPersonality &Personality) {
230   llvm::Constant *Fn = getPersonalityFn(CGM, Personality);
231   return llvm::ConstantExpr::getBitCast(Fn, CGM.Int8PtrTy);
232 }
233 
234 /// Check whether a landingpad instruction only uses C++ features.
235 static bool LandingPadHasOnlyCXXUses(llvm::LandingPadInst *LPI) {
236   for (unsigned I = 0, E = LPI->getNumClauses(); I != E; ++I) {
237     // Look for something that would've been returned by the ObjC
238     // runtime's GetEHType() method.
239     llvm::Value *Val = LPI->getClause(I)->stripPointerCasts();
240     if (LPI->isCatch(I)) {
241       // Check if the catch value has the ObjC prefix.
242       if (llvm::GlobalVariable *GV = dyn_cast<llvm::GlobalVariable>(Val))
243         // ObjC EH selector entries are always global variables with
244         // names starting like this.
245         if (GV->getName().startswith("OBJC_EHTYPE"))
246           return false;
247     } else {
248       // Check if any of the filter values have the ObjC prefix.
249       llvm::Constant *CVal = cast<llvm::Constant>(Val);
250       for (llvm::User::op_iterator
251               II = CVal->op_begin(), IE = CVal->op_end(); II != IE; ++II) {
252         if (llvm::GlobalVariable *GV =
253             cast<llvm::GlobalVariable>((*II)->stripPointerCasts()))
254           // ObjC EH selector entries are always global variables with
255           // names starting like this.
256           if (GV->getName().startswith("OBJC_EHTYPE"))
257             return false;
258       }
259     }
260   }
261   return true;
262 }
263 
264 /// Check whether a personality function could reasonably be swapped
265 /// for a C++ personality function.
266 static bool PersonalityHasOnlyCXXUses(llvm::Constant *Fn) {
267   for (llvm::User *U : Fn->users()) {
268     // Conditionally white-list bitcasts.
269     if (llvm::ConstantExpr *CE = dyn_cast<llvm::ConstantExpr>(U)) {
270       if (CE->getOpcode() != llvm::Instruction::BitCast) return false;
271       if (!PersonalityHasOnlyCXXUses(CE))
272         return false;
273       continue;
274     }
275 
276     // Otherwise it must be a function.
277     llvm::Function *F = dyn_cast<llvm::Function>(U);
278     if (!F) return false;
279 
280     for (auto BB = F->begin(), E = F->end(); BB != E; ++BB) {
281       if (BB->isLandingPad())
282         if (!LandingPadHasOnlyCXXUses(BB->getLandingPadInst()))
283           return false;
284     }
285   }
286 
287   return true;
288 }
289 
290 /// Try to use the C++ personality function in ObjC++.  Not doing this
291 /// can cause some incompatibilities with gcc, which is more
292 /// aggressive about only using the ObjC++ personality in a function
293 /// when it really needs it.
294 void CodeGenModule::SimplifyPersonality() {
295   // If we're not in ObjC++ -fexceptions, there's nothing to do.
296   if (!LangOpts.CPlusPlus || !LangOpts.ObjC1 || !LangOpts.Exceptions)
297     return;
298 
299   // Both the problem this endeavors to fix and the way the logic
300   // above works is specific to the NeXT runtime.
301   if (!LangOpts.ObjCRuntime.isNeXTFamily())
302     return;
303 
304   const EHPersonality &ObjCXX = EHPersonality::get(*this, /*FD=*/nullptr);
305   const EHPersonality &CXX =
306       getCXXPersonality(getTarget().getTriple(), LangOpts);
307   if (&ObjCXX == &CXX)
308     return;
309 
310   assert(std::strcmp(ObjCXX.PersonalityFn, CXX.PersonalityFn) != 0 &&
311          "Different EHPersonalities using the same personality function.");
312 
313   llvm::Function *Fn = getModule().getFunction(ObjCXX.PersonalityFn);
314 
315   // Nothing to do if it's unused.
316   if (!Fn || Fn->use_empty()) return;
317 
318   // Can't do the optimization if it has non-C++ uses.
319   if (!PersonalityHasOnlyCXXUses(Fn)) return;
320 
321   // Create the C++ personality function and kill off the old
322   // function.
323   llvm::Constant *CXXFn = getPersonalityFn(*this, CXX);
324 
325   // This can happen if the user is screwing with us.
326   if (Fn->getType() != CXXFn->getType()) return;
327 
328   Fn->replaceAllUsesWith(CXXFn);
329   Fn->eraseFromParent();
330 }
331 
332 /// Returns the value to inject into a selector to indicate the
333 /// presence of a catch-all.
334 static llvm::Constant *getCatchAllValue(CodeGenFunction &CGF) {
335   // Possibly we should use @llvm.eh.catch.all.value here.
336   return llvm::ConstantPointerNull::get(CGF.Int8PtrTy);
337 }
338 
339 namespace {
340   /// A cleanup to free the exception object if its initialization
341   /// throws.
342   struct FreeException final : EHScopeStack::Cleanup {
343     llvm::Value *exn;
344     FreeException(llvm::Value *exn) : exn(exn) {}
345     void Emit(CodeGenFunction &CGF, Flags flags) override {
346       CGF.EmitNounwindRuntimeCall(getFreeExceptionFn(CGF.CGM), exn);
347     }
348   };
349 }
350 
351 // Emits an exception expression into the given location.  This
352 // differs from EmitAnyExprToMem only in that, if a final copy-ctor
353 // call is required, an exception within that copy ctor causes
354 // std::terminate to be invoked.
355 void CodeGenFunction::EmitAnyExprToExn(const Expr *e, Address addr) {
356   // Make sure the exception object is cleaned up if there's an
357   // exception during initialization.
358   pushFullExprCleanup<FreeException>(EHCleanup, addr.getPointer());
359   EHScopeStack::stable_iterator cleanup = EHStack.stable_begin();
360 
361   // __cxa_allocate_exception returns a void*;  we need to cast this
362   // to the appropriate type for the object.
363   llvm::Type *ty = ConvertTypeForMem(e->getType())->getPointerTo();
364   Address typedAddr = Builder.CreateBitCast(addr, ty);
365 
366   // FIXME: this isn't quite right!  If there's a final unelided call
367   // to a copy constructor, then according to [except.terminate]p1 we
368   // must call std::terminate() if that constructor throws, because
369   // technically that copy occurs after the exception expression is
370   // evaluated but before the exception is caught.  But the best way
371   // to handle that is to teach EmitAggExpr to do the final copy
372   // differently if it can't be elided.
373   EmitAnyExprToMem(e, typedAddr, e->getType().getQualifiers(),
374                    /*IsInit*/ true);
375 
376   // Deactivate the cleanup block.
377   DeactivateCleanupBlock(cleanup,
378                          cast<llvm::Instruction>(typedAddr.getPointer()));
379 }
380 
381 Address CodeGenFunction::getExceptionSlot() {
382   if (!ExceptionSlot)
383     ExceptionSlot = CreateTempAlloca(Int8PtrTy, "exn.slot");
384   return Address(ExceptionSlot, getPointerAlign());
385 }
386 
387 Address CodeGenFunction::getEHSelectorSlot() {
388   if (!EHSelectorSlot)
389     EHSelectorSlot = CreateTempAlloca(Int32Ty, "ehselector.slot");
390   return Address(EHSelectorSlot, CharUnits::fromQuantity(4));
391 }
392 
393 llvm::Value *CodeGenFunction::getExceptionFromSlot() {
394   return Builder.CreateLoad(getExceptionSlot(), "exn");
395 }
396 
397 llvm::Value *CodeGenFunction::getSelectorFromSlot() {
398   return Builder.CreateLoad(getEHSelectorSlot(), "sel");
399 }
400 
401 void CodeGenFunction::EmitCXXThrowExpr(const CXXThrowExpr *E,
402                                        bool KeepInsertionPoint) {
403   if (const Expr *SubExpr = E->getSubExpr()) {
404     QualType ThrowType = SubExpr->getType();
405     if (ThrowType->isObjCObjectPointerType()) {
406       const Stmt *ThrowStmt = E->getSubExpr();
407       const ObjCAtThrowStmt S(E->getExprLoc(), const_cast<Stmt *>(ThrowStmt));
408       CGM.getObjCRuntime().EmitThrowStmt(*this, S, false);
409     } else {
410       CGM.getCXXABI().emitThrow(*this, E);
411     }
412   } else {
413     CGM.getCXXABI().emitRethrow(*this, /*isNoReturn=*/true);
414   }
415 
416   // throw is an expression, and the expression emitters expect us
417   // to leave ourselves at a valid insertion point.
418   if (KeepInsertionPoint)
419     EmitBlock(createBasicBlock("throw.cont"));
420 }
421 
422 void CodeGenFunction::EmitStartEHSpec(const Decl *D) {
423   if (!CGM.getLangOpts().CXXExceptions)
424     return;
425 
426   const FunctionDecl* FD = dyn_cast_or_null<FunctionDecl>(D);
427   if (!FD) {
428     // Check if CapturedDecl is nothrow and create terminate scope for it.
429     if (const CapturedDecl* CD = dyn_cast_or_null<CapturedDecl>(D)) {
430       if (CD->isNothrow())
431         EHStack.pushTerminate();
432     }
433     return;
434   }
435   const FunctionProtoType *Proto = FD->getType()->getAs<FunctionProtoType>();
436   if (!Proto)
437     return;
438 
439   ExceptionSpecificationType EST = Proto->getExceptionSpecType();
440   if (isNoexceptExceptionSpec(EST)) {
441     if (Proto->getNoexceptSpec(getContext()) == FunctionProtoType::NR_Nothrow) {
442       // noexcept functions are simple terminate scopes.
443       EHStack.pushTerminate();
444     }
445   } else if (EST == EST_Dynamic || EST == EST_DynamicNone) {
446     // TODO: Revisit exception specifications for the MS ABI.  There is a way to
447     // encode these in an object file but MSVC doesn't do anything with it.
448     if (getTarget().getCXXABI().isMicrosoft())
449       return;
450     unsigned NumExceptions = Proto->getNumExceptions();
451     EHFilterScope *Filter = EHStack.pushFilter(NumExceptions);
452 
453     for (unsigned I = 0; I != NumExceptions; ++I) {
454       QualType Ty = Proto->getExceptionType(I);
455       QualType ExceptType = Ty.getNonReferenceType().getUnqualifiedType();
456       llvm::Value *EHType = CGM.GetAddrOfRTTIDescriptor(ExceptType,
457                                                         /*ForEH=*/true);
458       Filter->setFilter(I, EHType);
459     }
460   }
461 }
462 
463 /// Emit the dispatch block for a filter scope if necessary.
464 static void emitFilterDispatchBlock(CodeGenFunction &CGF,
465                                     EHFilterScope &filterScope) {
466   llvm::BasicBlock *dispatchBlock = filterScope.getCachedEHDispatchBlock();
467   if (!dispatchBlock) return;
468   if (dispatchBlock->use_empty()) {
469     delete dispatchBlock;
470     return;
471   }
472 
473   CGF.EmitBlockAfterUses(dispatchBlock);
474 
475   // If this isn't a catch-all filter, we need to check whether we got
476   // here because the filter triggered.
477   if (filterScope.getNumFilters()) {
478     // Load the selector value.
479     llvm::Value *selector = CGF.getSelectorFromSlot();
480     llvm::BasicBlock *unexpectedBB = CGF.createBasicBlock("ehspec.unexpected");
481 
482     llvm::Value *zero = CGF.Builder.getInt32(0);
483     llvm::Value *failsFilter =
484         CGF.Builder.CreateICmpSLT(selector, zero, "ehspec.fails");
485     CGF.Builder.CreateCondBr(failsFilter, unexpectedBB,
486                              CGF.getEHResumeBlock(false));
487 
488     CGF.EmitBlock(unexpectedBB);
489   }
490 
491   // Call __cxa_call_unexpected.  This doesn't need to be an invoke
492   // because __cxa_call_unexpected magically filters exceptions
493   // according to the last landing pad the exception was thrown
494   // into.  Seriously.
495   llvm::Value *exn = CGF.getExceptionFromSlot();
496   CGF.EmitRuntimeCall(getUnexpectedFn(CGF.CGM), exn)
497     ->setDoesNotReturn();
498   CGF.Builder.CreateUnreachable();
499 }
500 
501 void CodeGenFunction::EmitEndEHSpec(const Decl *D) {
502   if (!CGM.getLangOpts().CXXExceptions)
503     return;
504 
505   const FunctionDecl* FD = dyn_cast_or_null<FunctionDecl>(D);
506   if (!FD) {
507     // Check if CapturedDecl is nothrow and pop terminate scope for it.
508     if (const CapturedDecl* CD = dyn_cast_or_null<CapturedDecl>(D)) {
509       if (CD->isNothrow())
510         EHStack.popTerminate();
511     }
512     return;
513   }
514   const FunctionProtoType *Proto = FD->getType()->getAs<FunctionProtoType>();
515   if (!Proto)
516     return;
517 
518   ExceptionSpecificationType EST = Proto->getExceptionSpecType();
519   if (isNoexceptExceptionSpec(EST)) {
520     if (Proto->getNoexceptSpec(getContext()) == FunctionProtoType::NR_Nothrow) {
521       EHStack.popTerminate();
522     }
523   } else if (EST == EST_Dynamic || EST == EST_DynamicNone) {
524     // TODO: Revisit exception specifications for the MS ABI.  There is a way to
525     // encode these in an object file but MSVC doesn't do anything with it.
526     if (getTarget().getCXXABI().isMicrosoft())
527       return;
528     EHFilterScope &filterScope = cast<EHFilterScope>(*EHStack.begin());
529     emitFilterDispatchBlock(*this, filterScope);
530     EHStack.popFilter();
531   }
532 }
533 
534 void CodeGenFunction::EmitCXXTryStmt(const CXXTryStmt &S) {
535   EnterCXXTryStmt(S);
536   EmitStmt(S.getTryBlock());
537   ExitCXXTryStmt(S);
538 }
539 
540 void CodeGenFunction::EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock) {
541   unsigned NumHandlers = S.getNumHandlers();
542   EHCatchScope *CatchScope = EHStack.pushCatch(NumHandlers);
543 
544   for (unsigned I = 0; I != NumHandlers; ++I) {
545     const CXXCatchStmt *C = S.getHandler(I);
546 
547     llvm::BasicBlock *Handler = createBasicBlock("catch");
548     if (C->getExceptionDecl()) {
549       // FIXME: Dropping the reference type on the type into makes it
550       // impossible to correctly implement catch-by-reference
551       // semantics for pointers.  Unfortunately, this is what all
552       // existing compilers do, and it's not clear that the standard
553       // personality routine is capable of doing this right.  See C++ DR 388:
554       //   http://www.open-std.org/jtc1/sc22/wg21/docs/cwg_active.html#388
555       Qualifiers CaughtTypeQuals;
556       QualType CaughtType = CGM.getContext().getUnqualifiedArrayType(
557           C->getCaughtType().getNonReferenceType(), CaughtTypeQuals);
558 
559       CatchTypeInfo TypeInfo{nullptr, 0};
560       if (CaughtType->isObjCObjectPointerType())
561         TypeInfo.RTTI = CGM.getObjCRuntime().GetEHType(CaughtType);
562       else
563         TypeInfo = CGM.getCXXABI().getAddrOfCXXCatchHandlerType(
564             CaughtType, C->getCaughtType());
565       CatchScope->setHandler(I, TypeInfo, Handler);
566     } else {
567       // No exception decl indicates '...', a catch-all.
568       CatchScope->setHandler(I, CGM.getCXXABI().getCatchAllTypeInfo(), Handler);
569     }
570   }
571 }
572 
573 llvm::BasicBlock *
574 CodeGenFunction::getEHDispatchBlock(EHScopeStack::stable_iterator si) {
575   if (CGM.getCodeGenOpts().NewMSEH &&
576       EHPersonality::get(*this).isMSVCPersonality())
577     return getMSVCDispatchBlock(si);
578 
579   // The dispatch block for the end of the scope chain is a block that
580   // just resumes unwinding.
581   if (si == EHStack.stable_end())
582     return getEHResumeBlock(true);
583 
584   // Otherwise, we should look at the actual scope.
585   EHScope &scope = *EHStack.find(si);
586 
587   llvm::BasicBlock *dispatchBlock = scope.getCachedEHDispatchBlock();
588   if (!dispatchBlock) {
589     switch (scope.getKind()) {
590     case EHScope::Catch: {
591       // Apply a special case to a single catch-all.
592       EHCatchScope &catchScope = cast<EHCatchScope>(scope);
593       if (catchScope.getNumHandlers() == 1 &&
594           catchScope.getHandler(0).isCatchAll()) {
595         dispatchBlock = catchScope.getHandler(0).Block;
596 
597       // Otherwise, make a dispatch block.
598       } else {
599         dispatchBlock = createBasicBlock("catch.dispatch");
600       }
601       break;
602     }
603 
604     case EHScope::Cleanup:
605       dispatchBlock = createBasicBlock("ehcleanup");
606       break;
607 
608     case EHScope::Filter:
609       dispatchBlock = createBasicBlock("filter.dispatch");
610       break;
611 
612     case EHScope::Terminate:
613       dispatchBlock = getTerminateHandler();
614       break;
615 
616     case EHScope::PadEnd:
617       llvm_unreachable("PadEnd unnecessary for Itanium!");
618     }
619     scope.setCachedEHDispatchBlock(dispatchBlock);
620   }
621   return dispatchBlock;
622 }
623 
624 llvm::BasicBlock *
625 CodeGenFunction::getMSVCDispatchBlock(EHScopeStack::stable_iterator SI) {
626   // Returning nullptr indicates that the previous dispatch block should unwind
627   // to caller.
628   if (SI == EHStack.stable_end())
629     return nullptr;
630 
631   // Otherwise, we should look at the actual scope.
632   EHScope &EHS = *EHStack.find(SI);
633 
634   llvm::BasicBlock *DispatchBlock = EHS.getCachedEHDispatchBlock();
635   if (DispatchBlock)
636     return DispatchBlock;
637 
638   if (EHS.getKind() == EHScope::Terminate)
639     DispatchBlock = getTerminateHandler();
640   else
641     DispatchBlock = createBasicBlock();
642   CGBuilderTy Builder(*this, DispatchBlock);
643 
644   switch (EHS.getKind()) {
645   case EHScope::Catch:
646     DispatchBlock->setName("catch.dispatch");
647     break;
648 
649   case EHScope::Cleanup:
650     DispatchBlock->setName("ehcleanup");
651     break;
652 
653   case EHScope::Filter:
654     llvm_unreachable("exception specifications not handled yet!");
655 
656   case EHScope::Terminate:
657     DispatchBlock->setName("terminate");
658     break;
659 
660   case EHScope::PadEnd:
661     llvm_unreachable("PadEnd dispatch block missing!");
662   }
663   EHS.setCachedEHDispatchBlock(DispatchBlock);
664   return DispatchBlock;
665 }
666 
667 /// Check whether this is a non-EH scope, i.e. a scope which doesn't
668 /// affect exception handling.  Currently, the only non-EH scopes are
669 /// normal-only cleanup scopes.
670 static bool isNonEHScope(const EHScope &S) {
671   switch (S.getKind()) {
672   case EHScope::Cleanup:
673     return !cast<EHCleanupScope>(S).isEHCleanup();
674   case EHScope::Filter:
675   case EHScope::Catch:
676   case EHScope::Terminate:
677   case EHScope::PadEnd:
678     return false;
679   }
680 
681   llvm_unreachable("Invalid EHScope Kind!");
682 }
683 
684 llvm::BasicBlock *CodeGenFunction::getInvokeDestImpl() {
685   assert(EHStack.requiresLandingPad());
686   assert(!EHStack.empty());
687 
688   // If exceptions are disabled, there are usually no landingpads. However, when
689   // SEH is enabled, functions using SEH still get landingpads.
690   const LangOptions &LO = CGM.getLangOpts();
691   if (!LO.Exceptions) {
692     if (!LO.Borland && !LO.MicrosoftExt)
693       return nullptr;
694     if (!currentFunctionUsesSEHTry())
695       return nullptr;
696   }
697 
698   // Check the innermost scope for a cached landing pad.  If this is
699   // a non-EH cleanup, we'll check enclosing scopes in EmitLandingPad.
700   llvm::BasicBlock *LP = EHStack.begin()->getCachedLandingPad();
701   if (LP) return LP;
702 
703   const EHPersonality &Personality = EHPersonality::get(*this);
704 
705   if (!CurFn->hasPersonalityFn())
706     CurFn->setPersonalityFn(getOpaquePersonalityFn(CGM, Personality));
707 
708   if (CGM.getCodeGenOpts().NewMSEH && Personality.isMSVCPersonality()) {
709     // We don't need separate landing pads in the MSVC model.
710     LP = getEHDispatchBlock(EHStack.getInnermostEHScope());
711   } else {
712     // Build the landing pad for this scope.
713     LP = EmitLandingPad();
714   }
715 
716   assert(LP);
717 
718   // Cache the landing pad on the innermost scope.  If this is a
719   // non-EH scope, cache the landing pad on the enclosing scope, too.
720   for (EHScopeStack::iterator ir = EHStack.begin(); true; ++ir) {
721     ir->setCachedLandingPad(LP);
722     if (!isNonEHScope(*ir)) break;
723   }
724 
725   return LP;
726 }
727 
728 llvm::BasicBlock *CodeGenFunction::EmitLandingPad() {
729   assert(EHStack.requiresLandingPad());
730 
731   EHScope &innermostEHScope = *EHStack.find(EHStack.getInnermostEHScope());
732   switch (innermostEHScope.getKind()) {
733   case EHScope::Terminate:
734     return getTerminateLandingPad();
735 
736   case EHScope::PadEnd:
737     llvm_unreachable("PadEnd unnecessary for Itanium!");
738 
739   case EHScope::Catch:
740   case EHScope::Cleanup:
741   case EHScope::Filter:
742     if (llvm::BasicBlock *lpad = innermostEHScope.getCachedLandingPad())
743       return lpad;
744   }
745 
746   // Save the current IR generation state.
747   CGBuilderTy::InsertPoint savedIP = Builder.saveAndClearIP();
748   auto DL = ApplyDebugLocation::CreateDefaultArtificial(*this, CurEHLocation);
749 
750   // Create and configure the landing pad.
751   llvm::BasicBlock *lpad = createBasicBlock("lpad");
752   EmitBlock(lpad);
753 
754   llvm::LandingPadInst *LPadInst = Builder.CreateLandingPad(
755       llvm::StructType::get(Int8PtrTy, Int32Ty, nullptr), 0);
756 
757   llvm::Value *LPadExn = Builder.CreateExtractValue(LPadInst, 0);
758   Builder.CreateStore(LPadExn, getExceptionSlot());
759   llvm::Value *LPadSel = Builder.CreateExtractValue(LPadInst, 1);
760   Builder.CreateStore(LPadSel, getEHSelectorSlot());
761 
762   // Save the exception pointer.  It's safe to use a single exception
763   // pointer per function because EH cleanups can never have nested
764   // try/catches.
765   // Build the landingpad instruction.
766 
767   // Accumulate all the handlers in scope.
768   bool hasCatchAll = false;
769   bool hasCleanup = false;
770   bool hasFilter = false;
771   SmallVector<llvm::Value*, 4> filterTypes;
772   llvm::SmallPtrSet<llvm::Value*, 4> catchTypes;
773   for (EHScopeStack::iterator I = EHStack.begin(), E = EHStack.end(); I != E;
774        ++I) {
775 
776     switch (I->getKind()) {
777     case EHScope::Cleanup:
778       // If we have a cleanup, remember that.
779       hasCleanup = (hasCleanup || cast<EHCleanupScope>(*I).isEHCleanup());
780       continue;
781 
782     case EHScope::Filter: {
783       assert(I.next() == EHStack.end() && "EH filter is not end of EH stack");
784       assert(!hasCatchAll && "EH filter reached after catch-all");
785 
786       // Filter scopes get added to the landingpad in weird ways.
787       EHFilterScope &filter = cast<EHFilterScope>(*I);
788       hasFilter = true;
789 
790       // Add all the filter values.
791       for (unsigned i = 0, e = filter.getNumFilters(); i != e; ++i)
792         filterTypes.push_back(filter.getFilter(i));
793       goto done;
794     }
795 
796     case EHScope::Terminate:
797       // Terminate scopes are basically catch-alls.
798       assert(!hasCatchAll);
799       hasCatchAll = true;
800       goto done;
801 
802     case EHScope::Catch:
803       break;
804 
805     case EHScope::PadEnd:
806       llvm_unreachable("PadEnd unnecessary for Itanium!");
807     }
808 
809     EHCatchScope &catchScope = cast<EHCatchScope>(*I);
810     for (unsigned hi = 0, he = catchScope.getNumHandlers(); hi != he; ++hi) {
811       EHCatchScope::Handler handler = catchScope.getHandler(hi);
812       assert(handler.Type.Flags == 0 &&
813              "landingpads do not support catch handler flags");
814 
815       // If this is a catch-all, register that and abort.
816       if (!handler.Type.RTTI) {
817         assert(!hasCatchAll);
818         hasCatchAll = true;
819         goto done;
820       }
821 
822       // Check whether we already have a handler for this type.
823       if (catchTypes.insert(handler.Type.RTTI).second)
824         // If not, add it directly to the landingpad.
825         LPadInst->addClause(handler.Type.RTTI);
826     }
827   }
828 
829  done:
830   // If we have a catch-all, add null to the landingpad.
831   assert(!(hasCatchAll && hasFilter));
832   if (hasCatchAll) {
833     LPadInst->addClause(getCatchAllValue(*this));
834 
835   // If we have an EH filter, we need to add those handlers in the
836   // right place in the landingpad, which is to say, at the end.
837   } else if (hasFilter) {
838     // Create a filter expression: a constant array indicating which filter
839     // types there are. The personality routine only lands here if the filter
840     // doesn't match.
841     SmallVector<llvm::Constant*, 8> Filters;
842     llvm::ArrayType *AType =
843       llvm::ArrayType::get(!filterTypes.empty() ?
844                              filterTypes[0]->getType() : Int8PtrTy,
845                            filterTypes.size());
846 
847     for (unsigned i = 0, e = filterTypes.size(); i != e; ++i)
848       Filters.push_back(cast<llvm::Constant>(filterTypes[i]));
849     llvm::Constant *FilterArray = llvm::ConstantArray::get(AType, Filters);
850     LPadInst->addClause(FilterArray);
851 
852     // Also check whether we need a cleanup.
853     if (hasCleanup)
854       LPadInst->setCleanup(true);
855 
856   // Otherwise, signal that we at least have cleanups.
857   } else if (hasCleanup) {
858     LPadInst->setCleanup(true);
859   }
860 
861   assert((LPadInst->getNumClauses() > 0 || LPadInst->isCleanup()) &&
862          "landingpad instruction has no clauses!");
863 
864   // Tell the backend how to generate the landing pad.
865   Builder.CreateBr(getEHDispatchBlock(EHStack.getInnermostEHScope()));
866 
867   // Restore the old IR generation state.
868   Builder.restoreIP(savedIP);
869 
870   return lpad;
871 }
872 
873 static llvm::BasicBlock *emitMSVCCatchDispatchBlock(CodeGenFunction &CGF,
874                                                     EHCatchScope &CatchScope) {
875   llvm::BasicBlock *DispatchBlock = CatchScope.getCachedEHDispatchBlock();
876   assert(DispatchBlock);
877 
878   CGBuilderTy::InsertPoint SavedIP = CGF.Builder.saveIP();
879   CGF.EmitBlockAfterUses(DispatchBlock);
880 
881   // Figure out the next block.
882   llvm::BasicBlock *NextBlock = nullptr;
883 
884   // Test against each of the exception types we claim to catch.
885   for (unsigned I = 0, E = CatchScope.getNumHandlers(); I < E; ++I) {
886     const EHCatchScope::Handler &Handler = CatchScope.getHandler(I);
887 
888     CatchTypeInfo TypeInfo = Handler.Type;
889     if (!TypeInfo.RTTI)
890       TypeInfo.RTTI = llvm::Constant::getNullValue(CGF.VoidPtrTy);
891 
892     // If this is the last handler, we're at the end, and the next
893     // block is the block for the enclosing EH scope.
894     if (I + 1 == E) {
895       NextBlock = CGF.createBasicBlock("catchendblock");
896       CGBuilderTy(CGF, NextBlock).CreateCatchEndPad(
897           CGF.getEHDispatchBlock(CatchScope.getEnclosingEHScope()));
898     } else {
899       NextBlock = CGF.createBasicBlock("catch.dispatch");
900     }
901 
902     if (EHPersonality::get(CGF).isMSVCXXPersonality()) {
903       CGF.Builder.CreateCatchPad(Handler.Block, NextBlock,
904                                  {TypeInfo.RTTI,
905                                   CGF.Builder.getInt32(TypeInfo.Flags),
906                                   llvm::Constant::getNullValue(CGF.VoidPtrTy)});
907     } else {
908       CGF.Builder.CreateCatchPad(Handler.Block, NextBlock, {TypeInfo.RTTI});
909     }
910 
911     // Otherwise we need to emit and continue at that block.
912     CGF.EmitBlock(NextBlock);
913   }
914   CGF.Builder.restoreIP(SavedIP);
915 
916   return NextBlock;
917 }
918 
919 /// Emit the structure of the dispatch block for the given catch scope.
920 /// It is an invariant that the dispatch block already exists.
921 /// If the catchblock instructions are used for EH dispatch, then the basic
922 /// block holding the final catchendblock instruction is returned.
923 static llvm::BasicBlock *emitCatchDispatchBlock(CodeGenFunction &CGF,
924                                                 EHCatchScope &catchScope) {
925   if (CGF.CGM.getCodeGenOpts().NewMSEH &&
926       EHPersonality::get(CGF).isMSVCPersonality())
927     return emitMSVCCatchDispatchBlock(CGF, catchScope);
928 
929   llvm::BasicBlock *dispatchBlock = catchScope.getCachedEHDispatchBlock();
930   assert(dispatchBlock);
931 
932   // If there's only a single catch-all, getEHDispatchBlock returned
933   // that catch-all as the dispatch block.
934   if (catchScope.getNumHandlers() == 1 &&
935       catchScope.getHandler(0).isCatchAll()) {
936     assert(dispatchBlock == catchScope.getHandler(0).Block);
937     return nullptr;
938   }
939 
940   CGBuilderTy::InsertPoint savedIP = CGF.Builder.saveIP();
941   CGF.EmitBlockAfterUses(dispatchBlock);
942 
943   // Select the right handler.
944   llvm::Value *llvm_eh_typeid_for =
945     CGF.CGM.getIntrinsic(llvm::Intrinsic::eh_typeid_for);
946 
947   // Load the selector value.
948   llvm::Value *selector = CGF.getSelectorFromSlot();
949 
950   // Test against each of the exception types we claim to catch.
951   for (unsigned i = 0, e = catchScope.getNumHandlers(); ; ++i) {
952     assert(i < e && "ran off end of handlers!");
953     const EHCatchScope::Handler &handler = catchScope.getHandler(i);
954 
955     llvm::Value *typeValue = handler.Type.RTTI;
956     assert(handler.Type.Flags == 0 &&
957            "landingpads do not support catch handler flags");
958     assert(typeValue && "fell into catch-all case!");
959     typeValue = CGF.Builder.CreateBitCast(typeValue, CGF.Int8PtrTy);
960 
961     // Figure out the next block.
962     bool nextIsEnd;
963     llvm::BasicBlock *nextBlock;
964 
965     // If this is the last handler, we're at the end, and the next
966     // block is the block for the enclosing EH scope.
967     if (i + 1 == e) {
968       nextBlock = CGF.getEHDispatchBlock(catchScope.getEnclosingEHScope());
969       nextIsEnd = true;
970 
971     // If the next handler is a catch-all, we're at the end, and the
972     // next block is that handler.
973     } else if (catchScope.getHandler(i+1).isCatchAll()) {
974       nextBlock = catchScope.getHandler(i+1).Block;
975       nextIsEnd = true;
976 
977     // Otherwise, we're not at the end and we need a new block.
978     } else {
979       nextBlock = CGF.createBasicBlock("catch.fallthrough");
980       nextIsEnd = false;
981     }
982 
983     // Figure out the catch type's index in the LSDA's type table.
984     llvm::CallInst *typeIndex =
985       CGF.Builder.CreateCall(llvm_eh_typeid_for, typeValue);
986     typeIndex->setDoesNotThrow();
987 
988     llvm::Value *matchesTypeIndex =
989       CGF.Builder.CreateICmpEQ(selector, typeIndex, "matches");
990     CGF.Builder.CreateCondBr(matchesTypeIndex, handler.Block, nextBlock);
991 
992     // If the next handler is a catch-all, we're completely done.
993     if (nextIsEnd) {
994       CGF.Builder.restoreIP(savedIP);
995       return nullptr;
996     }
997     // Otherwise we need to emit and continue at that block.
998     CGF.EmitBlock(nextBlock);
999   }
1000   return nullptr;
1001 }
1002 
1003 void CodeGenFunction::popCatchScope() {
1004   EHCatchScope &catchScope = cast<EHCatchScope>(*EHStack.begin());
1005   if (catchScope.hasEHBranches())
1006     emitCatchDispatchBlock(*this, catchScope);
1007   EHStack.popCatch();
1008 }
1009 
1010 void CodeGenFunction::ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock) {
1011   unsigned NumHandlers = S.getNumHandlers();
1012   EHCatchScope &CatchScope = cast<EHCatchScope>(*EHStack.begin());
1013   assert(CatchScope.getNumHandlers() == NumHandlers);
1014 
1015   // If the catch was not required, bail out now.
1016   if (!CatchScope.hasEHBranches()) {
1017     CatchScope.clearHandlerBlocks();
1018     EHStack.popCatch();
1019     return;
1020   }
1021 
1022   // Emit the structure of the EH dispatch for this catch.
1023   llvm::BasicBlock *CatchEndBlockBB = emitCatchDispatchBlock(*this, CatchScope);
1024 
1025   // Copy the handler blocks off before we pop the EH stack.  Emitting
1026   // the handlers might scribble on this memory.
1027   SmallVector<EHCatchScope::Handler, 8> Handlers(
1028       CatchScope.begin(), CatchScope.begin() + NumHandlers);
1029 
1030   EHStack.popCatch();
1031 
1032   // The fall-through block.
1033   llvm::BasicBlock *ContBB = createBasicBlock("try.cont");
1034 
1035   // We just emitted the body of the try; jump to the continue block.
1036   if (HaveInsertPoint())
1037     Builder.CreateBr(ContBB);
1038 
1039   // Determine if we need an implicit rethrow for all these catch handlers;
1040   // see the comment below.
1041   bool doImplicitRethrow = false;
1042   if (IsFnTryBlock)
1043     doImplicitRethrow = isa<CXXDestructorDecl>(CurCodeDecl) ||
1044                         isa<CXXConstructorDecl>(CurCodeDecl);
1045 
1046   if (CatchEndBlockBB)
1047     EHStack.pushPadEnd(CatchEndBlockBB);
1048 
1049   // Perversely, we emit the handlers backwards precisely because we
1050   // want them to appear in source order.  In all of these cases, the
1051   // catch block will have exactly one predecessor, which will be a
1052   // particular block in the catch dispatch.  However, in the case of
1053   // a catch-all, one of the dispatch blocks will branch to two
1054   // different handlers, and EmitBlockAfterUses will cause the second
1055   // handler to be moved before the first.
1056   for (unsigned I = NumHandlers; I != 0; --I) {
1057     llvm::BasicBlock *CatchBlock = Handlers[I-1].Block;
1058     EmitBlockAfterUses(CatchBlock);
1059 
1060     // Catch the exception if this isn't a catch-all.
1061     const CXXCatchStmt *C = S.getHandler(I-1);
1062 
1063     // Enter a cleanup scope, including the catch variable and the
1064     // end-catch.
1065     RunCleanupsScope CatchScope(*this);
1066 
1067     // Initialize the catch variable and set up the cleanups.
1068     CGM.getCXXABI().emitBeginCatch(*this, C);
1069 
1070     // Emit the PGO counter increment.
1071     incrementProfileCounter(C);
1072 
1073     // Perform the body of the catch.
1074     EmitStmt(C->getHandlerBlock());
1075 
1076     // [except.handle]p11:
1077     //   The currently handled exception is rethrown if control
1078     //   reaches the end of a handler of the function-try-block of a
1079     //   constructor or destructor.
1080 
1081     // It is important that we only do this on fallthrough and not on
1082     // return.  Note that it's illegal to put a return in a
1083     // constructor function-try-block's catch handler (p14), so this
1084     // really only applies to destructors.
1085     if (doImplicitRethrow && HaveInsertPoint()) {
1086       CGM.getCXXABI().emitRethrow(*this, /*isNoReturn*/false);
1087       Builder.CreateUnreachable();
1088       Builder.ClearInsertionPoint();
1089     }
1090 
1091     // Fall out through the catch cleanups.
1092     CatchScope.ForceCleanup();
1093 
1094     // Branch out of the try.
1095     if (HaveInsertPoint())
1096       Builder.CreateBr(ContBB);
1097   }
1098 
1099   EmitBlock(ContBB);
1100   incrementProfileCounter(&S);
1101   if (CatchEndBlockBB)
1102     EHStack.popPadEnd();
1103 }
1104 
1105 namespace {
1106   struct CallEndCatchForFinally final : EHScopeStack::Cleanup {
1107     llvm::Value *ForEHVar;
1108     llvm::Value *EndCatchFn;
1109     CallEndCatchForFinally(llvm::Value *ForEHVar, llvm::Value *EndCatchFn)
1110       : ForEHVar(ForEHVar), EndCatchFn(EndCatchFn) {}
1111 
1112     void Emit(CodeGenFunction &CGF, Flags flags) override {
1113       llvm::BasicBlock *EndCatchBB = CGF.createBasicBlock("finally.endcatch");
1114       llvm::BasicBlock *CleanupContBB =
1115         CGF.createBasicBlock("finally.cleanup.cont");
1116 
1117       llvm::Value *ShouldEndCatch =
1118         CGF.Builder.CreateFlagLoad(ForEHVar, "finally.endcatch");
1119       CGF.Builder.CreateCondBr(ShouldEndCatch, EndCatchBB, CleanupContBB);
1120       CGF.EmitBlock(EndCatchBB);
1121       CGF.EmitRuntimeCallOrInvoke(EndCatchFn); // catch-all, so might throw
1122       CGF.EmitBlock(CleanupContBB);
1123     }
1124   };
1125 
1126   struct PerformFinally final : EHScopeStack::Cleanup {
1127     const Stmt *Body;
1128     llvm::Value *ForEHVar;
1129     llvm::Value *EndCatchFn;
1130     llvm::Value *RethrowFn;
1131     llvm::Value *SavedExnVar;
1132 
1133     PerformFinally(const Stmt *Body, llvm::Value *ForEHVar,
1134                    llvm::Value *EndCatchFn,
1135                    llvm::Value *RethrowFn, llvm::Value *SavedExnVar)
1136       : Body(Body), ForEHVar(ForEHVar), EndCatchFn(EndCatchFn),
1137         RethrowFn(RethrowFn), SavedExnVar(SavedExnVar) {}
1138 
1139     void Emit(CodeGenFunction &CGF, Flags flags) override {
1140       // Enter a cleanup to call the end-catch function if one was provided.
1141       if (EndCatchFn)
1142         CGF.EHStack.pushCleanup<CallEndCatchForFinally>(NormalAndEHCleanup,
1143                                                         ForEHVar, EndCatchFn);
1144 
1145       // Save the current cleanup destination in case there are
1146       // cleanups in the finally block.
1147       llvm::Value *SavedCleanupDest =
1148         CGF.Builder.CreateLoad(CGF.getNormalCleanupDestSlot(),
1149                                "cleanup.dest.saved");
1150 
1151       // Emit the finally block.
1152       CGF.EmitStmt(Body);
1153 
1154       // If the end of the finally is reachable, check whether this was
1155       // for EH.  If so, rethrow.
1156       if (CGF.HaveInsertPoint()) {
1157         llvm::BasicBlock *RethrowBB = CGF.createBasicBlock("finally.rethrow");
1158         llvm::BasicBlock *ContBB = CGF.createBasicBlock("finally.cont");
1159 
1160         llvm::Value *ShouldRethrow =
1161           CGF.Builder.CreateFlagLoad(ForEHVar, "finally.shouldthrow");
1162         CGF.Builder.CreateCondBr(ShouldRethrow, RethrowBB, ContBB);
1163 
1164         CGF.EmitBlock(RethrowBB);
1165         if (SavedExnVar) {
1166           CGF.EmitRuntimeCallOrInvoke(RethrowFn,
1167             CGF.Builder.CreateAlignedLoad(SavedExnVar, CGF.getPointerAlign()));
1168         } else {
1169           CGF.EmitRuntimeCallOrInvoke(RethrowFn);
1170         }
1171         CGF.Builder.CreateUnreachable();
1172 
1173         CGF.EmitBlock(ContBB);
1174 
1175         // Restore the cleanup destination.
1176         CGF.Builder.CreateStore(SavedCleanupDest,
1177                                 CGF.getNormalCleanupDestSlot());
1178       }
1179 
1180       // Leave the end-catch cleanup.  As an optimization, pretend that
1181       // the fallthrough path was inaccessible; we've dynamically proven
1182       // that we're not in the EH case along that path.
1183       if (EndCatchFn) {
1184         CGBuilderTy::InsertPoint SavedIP = CGF.Builder.saveAndClearIP();
1185         CGF.PopCleanupBlock();
1186         CGF.Builder.restoreIP(SavedIP);
1187       }
1188 
1189       // Now make sure we actually have an insertion point or the
1190       // cleanup gods will hate us.
1191       CGF.EnsureInsertPoint();
1192     }
1193   };
1194 }
1195 
1196 /// Enters a finally block for an implementation using zero-cost
1197 /// exceptions.  This is mostly general, but hard-codes some
1198 /// language/ABI-specific behavior in the catch-all sections.
1199 void CodeGenFunction::FinallyInfo::enter(CodeGenFunction &CGF,
1200                                          const Stmt *body,
1201                                          llvm::Constant *beginCatchFn,
1202                                          llvm::Constant *endCatchFn,
1203                                          llvm::Constant *rethrowFn) {
1204   assert((beginCatchFn != nullptr) == (endCatchFn != nullptr) &&
1205          "begin/end catch functions not paired");
1206   assert(rethrowFn && "rethrow function is required");
1207 
1208   BeginCatchFn = beginCatchFn;
1209 
1210   // The rethrow function has one of the following two types:
1211   //   void (*)()
1212   //   void (*)(void*)
1213   // In the latter case we need to pass it the exception object.
1214   // But we can't use the exception slot because the @finally might
1215   // have a landing pad (which would overwrite the exception slot).
1216   llvm::FunctionType *rethrowFnTy =
1217     cast<llvm::FunctionType>(
1218       cast<llvm::PointerType>(rethrowFn->getType())->getElementType());
1219   SavedExnVar = nullptr;
1220   if (rethrowFnTy->getNumParams())
1221     SavedExnVar = CGF.CreateTempAlloca(CGF.Int8PtrTy, "finally.exn");
1222 
1223   // A finally block is a statement which must be executed on any edge
1224   // out of a given scope.  Unlike a cleanup, the finally block may
1225   // contain arbitrary control flow leading out of itself.  In
1226   // addition, finally blocks should always be executed, even if there
1227   // are no catch handlers higher on the stack.  Therefore, we
1228   // surround the protected scope with a combination of a normal
1229   // cleanup (to catch attempts to break out of the block via normal
1230   // control flow) and an EH catch-all (semantically "outside" any try
1231   // statement to which the finally block might have been attached).
1232   // The finally block itself is generated in the context of a cleanup
1233   // which conditionally leaves the catch-all.
1234 
1235   // Jump destination for performing the finally block on an exception
1236   // edge.  We'll never actually reach this block, so unreachable is
1237   // fine.
1238   RethrowDest = CGF.getJumpDestInCurrentScope(CGF.getUnreachableBlock());
1239 
1240   // Whether the finally block is being executed for EH purposes.
1241   ForEHVar = CGF.CreateTempAlloca(CGF.Builder.getInt1Ty(), "finally.for-eh");
1242   CGF.Builder.CreateFlagStore(false, ForEHVar);
1243 
1244   // Enter a normal cleanup which will perform the @finally block.
1245   CGF.EHStack.pushCleanup<PerformFinally>(NormalCleanup, body,
1246                                           ForEHVar, endCatchFn,
1247                                           rethrowFn, SavedExnVar);
1248 
1249   // Enter a catch-all scope.
1250   llvm::BasicBlock *catchBB = CGF.createBasicBlock("finally.catchall");
1251   EHCatchScope *catchScope = CGF.EHStack.pushCatch(1);
1252   catchScope->setCatchAllHandler(0, catchBB);
1253 }
1254 
1255 void CodeGenFunction::FinallyInfo::exit(CodeGenFunction &CGF) {
1256   // Leave the finally catch-all.
1257   EHCatchScope &catchScope = cast<EHCatchScope>(*CGF.EHStack.begin());
1258   llvm::BasicBlock *catchBB = catchScope.getHandler(0).Block;
1259 
1260   CGF.popCatchScope();
1261 
1262   // If there are any references to the catch-all block, emit it.
1263   if (catchBB->use_empty()) {
1264     delete catchBB;
1265   } else {
1266     CGBuilderTy::InsertPoint savedIP = CGF.Builder.saveAndClearIP();
1267     CGF.EmitBlock(catchBB);
1268 
1269     llvm::Value *exn = nullptr;
1270 
1271     // If there's a begin-catch function, call it.
1272     if (BeginCatchFn) {
1273       exn = CGF.getExceptionFromSlot();
1274       CGF.EmitNounwindRuntimeCall(BeginCatchFn, exn);
1275     }
1276 
1277     // If we need to remember the exception pointer to rethrow later, do so.
1278     if (SavedExnVar) {
1279       if (!exn) exn = CGF.getExceptionFromSlot();
1280       CGF.Builder.CreateAlignedStore(exn, SavedExnVar, CGF.getPointerAlign());
1281     }
1282 
1283     // Tell the cleanups in the finally block that we're do this for EH.
1284     CGF.Builder.CreateFlagStore(true, ForEHVar);
1285 
1286     // Thread a jump through the finally cleanup.
1287     CGF.EmitBranchThroughCleanup(RethrowDest);
1288 
1289     CGF.Builder.restoreIP(savedIP);
1290   }
1291 
1292   // Finally, leave the @finally cleanup.
1293   CGF.PopCleanupBlock();
1294 }
1295 
1296 llvm::BasicBlock *CodeGenFunction::getTerminateLandingPad() {
1297   if (TerminateLandingPad)
1298     return TerminateLandingPad;
1299 
1300   CGBuilderTy::InsertPoint SavedIP = Builder.saveAndClearIP();
1301 
1302   // This will get inserted at the end of the function.
1303   TerminateLandingPad = createBasicBlock("terminate.lpad");
1304   Builder.SetInsertPoint(TerminateLandingPad);
1305 
1306   // Tell the backend that this is a landing pad.
1307   const EHPersonality &Personality = EHPersonality::get(*this);
1308 
1309   if (!CurFn->hasPersonalityFn())
1310     CurFn->setPersonalityFn(getOpaquePersonalityFn(CGM, Personality));
1311 
1312   llvm::LandingPadInst *LPadInst = Builder.CreateLandingPad(
1313       llvm::StructType::get(Int8PtrTy, Int32Ty, nullptr), 0);
1314   LPadInst->addClause(getCatchAllValue(*this));
1315 
1316   llvm::Value *Exn = 0;
1317   if (getLangOpts().CPlusPlus)
1318     Exn = Builder.CreateExtractValue(LPadInst, 0);
1319   llvm::CallInst *terminateCall =
1320       CGM.getCXXABI().emitTerminateForUnexpectedException(*this, Exn);
1321   terminateCall->setDoesNotReturn();
1322   Builder.CreateUnreachable();
1323 
1324   // Restore the saved insertion state.
1325   Builder.restoreIP(SavedIP);
1326 
1327   return TerminateLandingPad;
1328 }
1329 
1330 llvm::BasicBlock *CodeGenFunction::getTerminateHandler() {
1331   if (TerminateHandler)
1332     return TerminateHandler;
1333 
1334   CGBuilderTy::InsertPoint SavedIP = Builder.saveAndClearIP();
1335 
1336   // Set up the terminate handler.  This block is inserted at the very
1337   // end of the function by FinishFunction.
1338   TerminateHandler = createBasicBlock("terminate.handler");
1339   Builder.SetInsertPoint(TerminateHandler);
1340   if (CGM.getCodeGenOpts().NewMSEH &&
1341       EHPersonality::get(*this).isMSVCPersonality()) {
1342     Builder.CreateTerminatePad(/*UnwindBB=*/nullptr, CGM.getTerminateFn());
1343   } else {
1344     llvm::Value *Exn = 0;
1345     if (getLangOpts().CPlusPlus)
1346       Exn = getExceptionFromSlot();
1347     llvm::CallInst *terminateCall =
1348         CGM.getCXXABI().emitTerminateForUnexpectedException(*this, Exn);
1349     terminateCall->setDoesNotReturn();
1350     Builder.CreateUnreachable();
1351   }
1352 
1353   // Restore the saved insertion state.
1354   Builder.restoreIP(SavedIP);
1355 
1356   return TerminateHandler;
1357 }
1358 
1359 llvm::BasicBlock *CodeGenFunction::getEHResumeBlock(bool isCleanup) {
1360   if (EHResumeBlock) return EHResumeBlock;
1361 
1362   CGBuilderTy::InsertPoint SavedIP = Builder.saveIP();
1363 
1364   // We emit a jump to a notional label at the outermost unwind state.
1365   EHResumeBlock = createBasicBlock("eh.resume");
1366   Builder.SetInsertPoint(EHResumeBlock);
1367 
1368   const EHPersonality &Personality = EHPersonality::get(*this);
1369 
1370   // This can always be a call because we necessarily didn't find
1371   // anything on the EH stack which needs our help.
1372   const char *RethrowName = Personality.CatchallRethrowFn;
1373   if (RethrowName != nullptr && !isCleanup) {
1374     EmitRuntimeCall(getCatchallRethrowFn(CGM, RethrowName),
1375                     getExceptionFromSlot())->setDoesNotReturn();
1376     Builder.CreateUnreachable();
1377     Builder.restoreIP(SavedIP);
1378     return EHResumeBlock;
1379   }
1380 
1381   // Recreate the landingpad's return value for the 'resume' instruction.
1382   llvm::Value *Exn = getExceptionFromSlot();
1383   llvm::Value *Sel = getSelectorFromSlot();
1384 
1385   llvm::Type *LPadType = llvm::StructType::get(Exn->getType(),
1386                                                Sel->getType(), nullptr);
1387   llvm::Value *LPadVal = llvm::UndefValue::get(LPadType);
1388   LPadVal = Builder.CreateInsertValue(LPadVal, Exn, 0, "lpad.val");
1389   LPadVal = Builder.CreateInsertValue(LPadVal, Sel, 1, "lpad.val");
1390 
1391   Builder.CreateResume(LPadVal);
1392   Builder.restoreIP(SavedIP);
1393   return EHResumeBlock;
1394 }
1395 
1396 void CodeGenFunction::EmitSEHTryStmt(const SEHTryStmt &S) {
1397   EnterSEHTryStmt(S);
1398   {
1399     JumpDest TryExit = getJumpDestInCurrentScope("__try.__leave");
1400 
1401     SEHTryEpilogueStack.push_back(&TryExit);
1402     EmitStmt(S.getTryBlock());
1403     SEHTryEpilogueStack.pop_back();
1404 
1405     if (!TryExit.getBlock()->use_empty())
1406       EmitBlock(TryExit.getBlock(), /*IsFinished=*/true);
1407     else
1408       delete TryExit.getBlock();
1409   }
1410   ExitSEHTryStmt(S);
1411 }
1412 
1413 namespace {
1414 struct PerformSEHFinally final : EHScopeStack::Cleanup {
1415   llvm::Function *OutlinedFinally;
1416   EHScopeStack::stable_iterator EnclosingScope;
1417   PerformSEHFinally(llvm::Function *OutlinedFinally,
1418                     EHScopeStack::stable_iterator EnclosingScope)
1419       : OutlinedFinally(OutlinedFinally), EnclosingScope(EnclosingScope) {}
1420 
1421   void Emit(CodeGenFunction &CGF, Flags F) override {
1422     ASTContext &Context = CGF.getContext();
1423     CodeGenModule &CGM = CGF.CGM;
1424 
1425     CallArgList Args;
1426 
1427     // Compute the two argument values.
1428     QualType ArgTys[2] = {Context.UnsignedCharTy, Context.VoidPtrTy};
1429     llvm::Value *LocalAddrFn = CGM.getIntrinsic(llvm::Intrinsic::localaddress);
1430     llvm::Value *FP = CGF.Builder.CreateCall(LocalAddrFn);
1431     llvm::Value *IsForEH =
1432         llvm::ConstantInt::get(CGF.ConvertType(ArgTys[0]), F.isForEHCleanup());
1433     Args.add(RValue::get(IsForEH), ArgTys[0]);
1434     Args.add(RValue::get(FP), ArgTys[1]);
1435 
1436     // Arrange a two-arg function info and type.
1437     FunctionProtoType::ExtProtoInfo EPI;
1438     const auto *FPT = cast<FunctionProtoType>(
1439         Context.getFunctionType(Context.VoidTy, ArgTys, EPI));
1440     const CGFunctionInfo &FnInfo =
1441         CGM.getTypes().arrangeFreeFunctionCall(Args, FPT,
1442                                                /*chainCall=*/false);
1443 
1444     // If this is the normal cleanup or using the old EH IR, just emit the call.
1445     if (!F.isForEHCleanup() || !CGM.getCodeGenOpts().NewMSEH) {
1446       CGF.EmitCall(FnInfo, OutlinedFinally, ReturnValueSlot(), Args);
1447       return;
1448     }
1449 
1450     // Build a cleanupendpad to unwind through.
1451     llvm::BasicBlock *CleanupBB = CGF.Builder.GetInsertBlock();
1452     llvm::BasicBlock *CleanupEndBB = CGF.createBasicBlock("ehcleanup.end");
1453     llvm::Instruction *PadInst = CleanupBB->getFirstNonPHI();
1454     auto *CPI = cast<llvm::CleanupPadInst>(PadInst);
1455     CGBuilderTy(CGF, CleanupEndBB)
1456         .CreateCleanupEndPad(CPI, CGF.getEHDispatchBlock(EnclosingScope));
1457 
1458     // Push and pop the cleanupendpad around the call.
1459     CGF.EHStack.pushPadEnd(CleanupEndBB);
1460     CGF.EmitCall(FnInfo, OutlinedFinally, ReturnValueSlot(), Args);
1461     CGF.EHStack.popPadEnd();
1462 
1463     // Insert the catchendpad block here.
1464     CGF.CurFn->getBasicBlockList().insertAfter(CGF.Builder.GetInsertBlock(),
1465                                                CleanupEndBB);
1466   }
1467 };
1468 }
1469 
1470 namespace {
1471 /// Find all local variable captures in the statement.
1472 struct CaptureFinder : ConstStmtVisitor<CaptureFinder> {
1473   CodeGenFunction &ParentCGF;
1474   const VarDecl *ParentThis;
1475   llvm::SmallSetVector<const VarDecl *, 4> Captures;
1476   Address SEHCodeSlot = Address::invalid();
1477   CaptureFinder(CodeGenFunction &ParentCGF, const VarDecl *ParentThis)
1478       : ParentCGF(ParentCGF), ParentThis(ParentThis) {}
1479 
1480   // Return true if we need to do any capturing work.
1481   bool foundCaptures() {
1482     return !Captures.empty() || SEHCodeSlot.isValid();
1483   }
1484 
1485   void Visit(const Stmt *S) {
1486     // See if this is a capture, then recurse.
1487     ConstStmtVisitor<CaptureFinder>::Visit(S);
1488     for (const Stmt *Child : S->children())
1489       if (Child)
1490         Visit(Child);
1491   }
1492 
1493   void VisitDeclRefExpr(const DeclRefExpr *E) {
1494     // If this is already a capture, just make sure we capture 'this'.
1495     if (E->refersToEnclosingVariableOrCapture()) {
1496       Captures.insert(ParentThis);
1497       return;
1498     }
1499 
1500     const auto *D = dyn_cast<VarDecl>(E->getDecl());
1501     if (D && D->isLocalVarDeclOrParm() && D->hasLocalStorage())
1502       Captures.insert(D);
1503   }
1504 
1505   void VisitCXXThisExpr(const CXXThisExpr *E) {
1506     Captures.insert(ParentThis);
1507   }
1508 
1509   void VisitCallExpr(const CallExpr *E) {
1510     // We only need to add parent frame allocations for these builtins in x86.
1511     if (ParentCGF.getTarget().getTriple().getArch() != llvm::Triple::x86)
1512       return;
1513 
1514     unsigned ID = E->getBuiltinCallee();
1515     switch (ID) {
1516     case Builtin::BI__exception_code:
1517     case Builtin::BI_exception_code:
1518       // This is the simple case where we are the outermost finally. All we
1519       // have to do here is make sure we escape this and recover it in the
1520       // outlined handler.
1521       if (!SEHCodeSlot.isValid())
1522         SEHCodeSlot = ParentCGF.SEHCodeSlotStack.back();
1523       break;
1524     }
1525   }
1526 };
1527 }
1528 
1529 Address CodeGenFunction::recoverAddrOfEscapedLocal(
1530     CodeGenFunction &ParentCGF, Address ParentVar, llvm::Value *ParentFP) {
1531   llvm::CallInst *RecoverCall = nullptr;
1532   CGBuilderTy Builder(*this, AllocaInsertPt);
1533   if (auto *ParentAlloca = dyn_cast<llvm::AllocaInst>(ParentVar.getPointer())) {
1534     // Mark the variable escaped if nobody else referenced it and compute the
1535     // localescape index.
1536     auto InsertPair = ParentCGF.EscapedLocals.insert(
1537         std::make_pair(ParentAlloca, ParentCGF.EscapedLocals.size()));
1538     int FrameEscapeIdx = InsertPair.first->second;
1539     // call i8* @llvm.localrecover(i8* bitcast(@parentFn), i8* %fp, i32 N)
1540     llvm::Function *FrameRecoverFn = llvm::Intrinsic::getDeclaration(
1541         &CGM.getModule(), llvm::Intrinsic::localrecover);
1542     llvm::Constant *ParentI8Fn =
1543         llvm::ConstantExpr::getBitCast(ParentCGF.CurFn, Int8PtrTy);
1544     RecoverCall = Builder.CreateCall(
1545         FrameRecoverFn, {ParentI8Fn, ParentFP,
1546                          llvm::ConstantInt::get(Int32Ty, FrameEscapeIdx)});
1547 
1548   } else {
1549     // If the parent didn't have an alloca, we're doing some nested outlining.
1550     // Just clone the existing localrecover call, but tweak the FP argument to
1551     // use our FP value. All other arguments are constants.
1552     auto *ParentRecover =
1553         cast<llvm::IntrinsicInst>(ParentVar.getPointer()->stripPointerCasts());
1554     assert(ParentRecover->getIntrinsicID() == llvm::Intrinsic::localrecover &&
1555            "expected alloca or localrecover in parent LocalDeclMap");
1556     RecoverCall = cast<llvm::CallInst>(ParentRecover->clone());
1557     RecoverCall->setArgOperand(1, ParentFP);
1558     RecoverCall->insertBefore(AllocaInsertPt);
1559   }
1560 
1561   // Bitcast the variable, rename it, and insert it in the local decl map.
1562   llvm::Value *ChildVar =
1563       Builder.CreateBitCast(RecoverCall, ParentVar.getType());
1564   ChildVar->setName(ParentVar.getName());
1565   return Address(ChildVar, ParentVar.getAlignment());
1566 }
1567 
1568 void CodeGenFunction::EmitCapturedLocals(CodeGenFunction &ParentCGF,
1569                                          const Stmt *OutlinedStmt,
1570                                          bool IsFilter) {
1571   // Find all captures in the Stmt.
1572   CaptureFinder Finder(ParentCGF, ParentCGF.CXXABIThisDecl);
1573   Finder.Visit(OutlinedStmt);
1574 
1575   // We can exit early on x86_64 when there are no captures. We just have to
1576   // save the exception code in filters so that __exception_code() works.
1577   if (!Finder.foundCaptures() &&
1578       CGM.getTarget().getTriple().getArch() != llvm::Triple::x86) {
1579     if (IsFilter)
1580       EmitSEHExceptionCodeSave(ParentCGF, nullptr, nullptr);
1581     return;
1582   }
1583 
1584   llvm::Value *EntryEBP = nullptr;
1585   llvm::Value *ParentFP;
1586   if (IsFilter && CGM.getTarget().getTriple().getArch() == llvm::Triple::x86) {
1587     // 32-bit SEH filters need to be careful about FP recovery.  The end of the
1588     // EH registration is passed in as the EBP physical register.  We can
1589     // recover that with llvm.frameaddress(1), and adjust that to recover the
1590     // parent's true frame pointer.
1591     CGBuilderTy Builder(CGM, AllocaInsertPt);
1592     EntryEBP = Builder.CreateCall(
1593         CGM.getIntrinsic(llvm::Intrinsic::frameaddress), {Builder.getInt32(1)});
1594     llvm::Function *RecoverFPIntrin =
1595         CGM.getIntrinsic(llvm::Intrinsic::x86_seh_recoverfp);
1596     llvm::Constant *ParentI8Fn =
1597         llvm::ConstantExpr::getBitCast(ParentCGF.CurFn, Int8PtrTy);
1598     ParentFP = Builder.CreateCall(RecoverFPIntrin, {ParentI8Fn, EntryEBP});
1599   } else {
1600     // Otherwise, for x64 and 32-bit finally functions, the parent FP is the
1601     // second parameter.
1602     auto AI = CurFn->arg_begin();
1603     ++AI;
1604     ParentFP = AI;
1605   }
1606 
1607   // Create llvm.localrecover calls for all captures.
1608   for (const VarDecl *VD : Finder.Captures) {
1609     if (isa<ImplicitParamDecl>(VD)) {
1610       CGM.ErrorUnsupported(VD, "'this' captured by SEH");
1611       CXXThisValue = llvm::UndefValue::get(ConvertTypeForMem(VD->getType()));
1612       continue;
1613     }
1614     if (VD->getType()->isVariablyModifiedType()) {
1615       CGM.ErrorUnsupported(VD, "VLA captured by SEH");
1616       continue;
1617     }
1618     assert((isa<ImplicitParamDecl>(VD) || VD->isLocalVarDeclOrParm()) &&
1619            "captured non-local variable");
1620 
1621     // If this decl hasn't been declared yet, it will be declared in the
1622     // OutlinedStmt.
1623     auto I = ParentCGF.LocalDeclMap.find(VD);
1624     if (I == ParentCGF.LocalDeclMap.end())
1625       continue;
1626 
1627     Address ParentVar = I->second;
1628     setAddrOfLocalVar(VD,
1629                   recoverAddrOfEscapedLocal(ParentCGF, ParentVar, ParentFP));
1630   }
1631 
1632   if (Finder.SEHCodeSlot.isValid()) {
1633     SEHCodeSlotStack.push_back(
1634         recoverAddrOfEscapedLocal(ParentCGF, Finder.SEHCodeSlot, ParentFP));
1635   }
1636 
1637   if (IsFilter)
1638     EmitSEHExceptionCodeSave(ParentCGF, ParentFP, EntryEBP);
1639 }
1640 
1641 /// Arrange a function prototype that can be called by Windows exception
1642 /// handling personalities. On Win64, the prototype looks like:
1643 /// RetTy func(void *EHPtrs, void *ParentFP);
1644 void CodeGenFunction::startOutlinedSEHHelper(CodeGenFunction &ParentCGF,
1645                                              bool IsFilter,
1646                                              const Stmt *OutlinedStmt) {
1647   SourceLocation StartLoc = OutlinedStmt->getLocStart();
1648 
1649   // Get the mangled function name.
1650   SmallString<128> Name;
1651   {
1652     llvm::raw_svector_ostream OS(Name);
1653     const Decl *ParentCodeDecl = ParentCGF.CurCodeDecl;
1654     const NamedDecl *Parent = dyn_cast_or_null<NamedDecl>(ParentCodeDecl);
1655     assert(Parent && "FIXME: handle unnamed decls (lambdas, blocks) with SEH");
1656     MangleContext &Mangler = CGM.getCXXABI().getMangleContext();
1657     if (IsFilter)
1658       Mangler.mangleSEHFilterExpression(Parent, OS);
1659     else
1660       Mangler.mangleSEHFinallyBlock(Parent, OS);
1661   }
1662 
1663   FunctionArgList Args;
1664   if (CGM.getTarget().getTriple().getArch() != llvm::Triple::x86 || !IsFilter) {
1665     // All SEH finally functions take two parameters. Win64 filters take two
1666     // parameters. Win32 filters take no parameters.
1667     if (IsFilter) {
1668       Args.push_back(ImplicitParamDecl::Create(
1669           getContext(), nullptr, StartLoc,
1670           &getContext().Idents.get("exception_pointers"),
1671           getContext().VoidPtrTy));
1672     } else {
1673       Args.push_back(ImplicitParamDecl::Create(
1674           getContext(), nullptr, StartLoc,
1675           &getContext().Idents.get("abnormal_termination"),
1676           getContext().UnsignedCharTy));
1677     }
1678     Args.push_back(ImplicitParamDecl::Create(
1679         getContext(), nullptr, StartLoc,
1680         &getContext().Idents.get("frame_pointer"), getContext().VoidPtrTy));
1681   }
1682 
1683   QualType RetTy = IsFilter ? getContext().LongTy : getContext().VoidTy;
1684 
1685   llvm::Function *ParentFn = ParentCGF.CurFn;
1686   const CGFunctionInfo &FnInfo = CGM.getTypes().arrangeFreeFunctionDeclaration(
1687       RetTy, Args, FunctionType::ExtInfo(), /*isVariadic=*/false);
1688 
1689   llvm::FunctionType *FnTy = CGM.getTypes().GetFunctionType(FnInfo);
1690   llvm::Function *Fn = llvm::Function::Create(
1691       FnTy, llvm::GlobalValue::InternalLinkage, Name.str(), &CGM.getModule());
1692   // The filter is either in the same comdat as the function, or it's internal.
1693   if (llvm::Comdat *C = ParentFn->getComdat()) {
1694     Fn->setComdat(C);
1695   } else if (ParentFn->hasWeakLinkage() || ParentFn->hasLinkOnceLinkage()) {
1696     llvm::Comdat *C = CGM.getModule().getOrInsertComdat(ParentFn->getName());
1697     ParentFn->setComdat(C);
1698     Fn->setComdat(C);
1699   } else {
1700     Fn->setLinkage(llvm::GlobalValue::InternalLinkage);
1701   }
1702 
1703   IsOutlinedSEHHelper = true;
1704 
1705   StartFunction(GlobalDecl(), RetTy, Fn, FnInfo, Args,
1706                 OutlinedStmt->getLocStart(), OutlinedStmt->getLocStart());
1707 
1708   CGM.SetLLVMFunctionAttributes(nullptr, FnInfo, CurFn);
1709   EmitCapturedLocals(ParentCGF, OutlinedStmt, IsFilter);
1710 }
1711 
1712 /// Create a stub filter function that will ultimately hold the code of the
1713 /// filter expression. The EH preparation passes in LLVM will outline the code
1714 /// from the main function body into this stub.
1715 llvm::Function *
1716 CodeGenFunction::GenerateSEHFilterFunction(CodeGenFunction &ParentCGF,
1717                                            const SEHExceptStmt &Except) {
1718   const Expr *FilterExpr = Except.getFilterExpr();
1719   startOutlinedSEHHelper(ParentCGF, true, FilterExpr);
1720 
1721   // Emit the original filter expression, convert to i32, and return.
1722   llvm::Value *R = EmitScalarExpr(FilterExpr);
1723   R = Builder.CreateIntCast(R, ConvertType(getContext().LongTy),
1724                             FilterExpr->getType()->isSignedIntegerType());
1725   Builder.CreateStore(R, ReturnValue);
1726 
1727   FinishFunction(FilterExpr->getLocEnd());
1728 
1729   return CurFn;
1730 }
1731 
1732 llvm::Function *
1733 CodeGenFunction::GenerateSEHFinallyFunction(CodeGenFunction &ParentCGF,
1734                                             const SEHFinallyStmt &Finally) {
1735   const Stmt *FinallyBlock = Finally.getBlock();
1736   startOutlinedSEHHelper(ParentCGF, false, FinallyBlock);
1737 
1738   // Mark finally block calls as nounwind and noinline to make LLVM's job a
1739   // little easier.
1740   // FIXME: Remove these restrictions in the future.
1741   CurFn->addFnAttr(llvm::Attribute::NoUnwind);
1742   CurFn->addFnAttr(llvm::Attribute::NoInline);
1743 
1744   // Emit the original filter expression, convert to i32, and return.
1745   EmitStmt(FinallyBlock);
1746 
1747   FinishFunction(FinallyBlock->getLocEnd());
1748 
1749   return CurFn;
1750 }
1751 
1752 void CodeGenFunction::EmitSEHExceptionCodeSave(CodeGenFunction &ParentCGF,
1753                                                llvm::Value *ParentFP,
1754                                                llvm::Value *EntryEBP) {
1755   // Get the pointer to the EXCEPTION_POINTERS struct. This is returned by the
1756   // __exception_info intrinsic.
1757   if (CGM.getTarget().getTriple().getArch() != llvm::Triple::x86) {
1758     // On Win64, the info is passed as the first parameter to the filter.
1759     auto AI = CurFn->arg_begin();
1760     SEHInfo = AI;
1761     SEHCodeSlotStack.push_back(
1762         CreateMemTemp(getContext().IntTy, "__exception_code"));
1763   } else {
1764     // On Win32, the EBP on entry to the filter points to the end of an
1765     // exception registration object. It contains 6 32-bit fields, and the info
1766     // pointer is stored in the second field. So, GEP 20 bytes backwards and
1767     // load the pointer.
1768     SEHInfo = Builder.CreateConstInBoundsGEP1_32(Int8Ty, EntryEBP, -20);
1769     SEHInfo = Builder.CreateBitCast(SEHInfo, Int8PtrTy->getPointerTo());
1770     SEHInfo = Builder.CreateAlignedLoad(Int8PtrTy, SEHInfo, getPointerAlign());
1771     SEHCodeSlotStack.push_back(recoverAddrOfEscapedLocal(
1772         ParentCGF, ParentCGF.SEHCodeSlotStack.back(), ParentFP));
1773   }
1774 
1775   // Save the exception code in the exception slot to unify exception access in
1776   // the filter function and the landing pad.
1777   // struct EXCEPTION_POINTERS {
1778   //   EXCEPTION_RECORD *ExceptionRecord;
1779   //   CONTEXT *ContextRecord;
1780   // };
1781   // int exceptioncode = exception_pointers->ExceptionRecord->ExceptionCode;
1782   llvm::Type *RecordTy = CGM.Int32Ty->getPointerTo();
1783   llvm::Type *PtrsTy = llvm::StructType::get(RecordTy, CGM.VoidPtrTy, nullptr);
1784   llvm::Value *Ptrs = Builder.CreateBitCast(SEHInfo, PtrsTy->getPointerTo());
1785   llvm::Value *Rec = Builder.CreateStructGEP(PtrsTy, Ptrs, 0);
1786   Rec = Builder.CreateAlignedLoad(Rec, getPointerAlign());
1787   llvm::Value *Code = Builder.CreateAlignedLoad(Rec, getIntAlign());
1788   assert(!SEHCodeSlotStack.empty() && "emitting EH code outside of __except");
1789   Builder.CreateStore(Code, SEHCodeSlotStack.back());
1790 }
1791 
1792 llvm::Value *CodeGenFunction::EmitSEHExceptionInfo() {
1793   // Sema should diagnose calling this builtin outside of a filter context, but
1794   // don't crash if we screw up.
1795   if (!SEHInfo)
1796     return llvm::UndefValue::get(Int8PtrTy);
1797   assert(SEHInfo->getType() == Int8PtrTy);
1798   return SEHInfo;
1799 }
1800 
1801 llvm::Value *CodeGenFunction::EmitSEHExceptionCode() {
1802   assert(!SEHCodeSlotStack.empty() && "emitting EH code outside of __except");
1803   return Builder.CreateLoad(SEHCodeSlotStack.back());
1804 }
1805 
1806 llvm::Value *CodeGenFunction::EmitSEHAbnormalTermination() {
1807   // Abnormal termination is just the first parameter to the outlined finally
1808   // helper.
1809   auto AI = CurFn->arg_begin();
1810   return Builder.CreateZExt(&*AI, Int32Ty);
1811 }
1812 
1813 void CodeGenFunction::EnterSEHTryStmt(const SEHTryStmt &S) {
1814   CodeGenFunction HelperCGF(CGM, /*suppressNewContext=*/true);
1815   if (const SEHFinallyStmt *Finally = S.getFinallyHandler()) {
1816     // Outline the finally block.
1817     llvm::Function *FinallyFunc =
1818         HelperCGF.GenerateSEHFinallyFunction(*this, *Finally);
1819 
1820     // Push a cleanup for __finally blocks.
1821     EHStack.pushCleanup<PerformSEHFinally>(NormalAndEHCleanup, FinallyFunc,
1822                                            EHStack.getInnermostEHScope());
1823     return;
1824   }
1825 
1826   // Otherwise, we must have an __except block.
1827   const SEHExceptStmt *Except = S.getExceptHandler();
1828   assert(Except);
1829   EHCatchScope *CatchScope = EHStack.pushCatch(1);
1830   SEHCodeSlotStack.push_back(
1831       CreateMemTemp(getContext().IntTy, "__exception_code"));
1832 
1833   // If the filter is known to evaluate to 1, then we can use the clause
1834   // "catch i8* null". We can't do this on x86 because the filter has to save
1835   // the exception code.
1836   llvm::Constant *C =
1837       CGM.EmitConstantExpr(Except->getFilterExpr(), getContext().IntTy, this);
1838   if (CGM.getTarget().getTriple().getArch() != llvm::Triple::x86 && C &&
1839       C->isOneValue()) {
1840     CatchScope->setCatchAllHandler(0, createBasicBlock("__except"));
1841     return;
1842   }
1843 
1844   // In general, we have to emit an outlined filter function. Use the function
1845   // in place of the RTTI typeinfo global that C++ EH uses.
1846   llvm::Function *FilterFunc =
1847       HelperCGF.GenerateSEHFilterFunction(*this, *Except);
1848   llvm::Constant *OpaqueFunc =
1849       llvm::ConstantExpr::getBitCast(FilterFunc, Int8PtrTy);
1850   CatchScope->setHandler(0, OpaqueFunc, createBasicBlock("__except.ret"));
1851 }
1852 
1853 void CodeGenFunction::ExitSEHTryStmt(const SEHTryStmt &S) {
1854   // Just pop the cleanup if it's a __finally block.
1855   if (S.getFinallyHandler()) {
1856     PopCleanupBlock();
1857     return;
1858   }
1859 
1860   // Otherwise, we must have an __except block.
1861   const SEHExceptStmt *Except = S.getExceptHandler();
1862   assert(Except && "__try must have __finally xor __except");
1863   EHCatchScope &CatchScope = cast<EHCatchScope>(*EHStack.begin());
1864 
1865   // Don't emit the __except block if the __try block lacked invokes.
1866   // TODO: Model unwind edges from instructions, either with iload / istore or
1867   // a try body function.
1868   if (!CatchScope.hasEHBranches()) {
1869     CatchScope.clearHandlerBlocks();
1870     EHStack.popCatch();
1871     SEHCodeSlotStack.pop_back();
1872     return;
1873   }
1874 
1875   // The fall-through block.
1876   llvm::BasicBlock *ContBB = createBasicBlock("__try.cont");
1877 
1878   // We just emitted the body of the __try; jump to the continue block.
1879   if (HaveInsertPoint())
1880     Builder.CreateBr(ContBB);
1881 
1882   // Check if our filter function returned true.
1883   emitCatchDispatchBlock(*this, CatchScope);
1884 
1885   // Grab the block before we pop the handler.
1886   llvm::BasicBlock *ExceptBB = CatchScope.getHandler(0).Block;
1887   EHStack.popCatch();
1888 
1889   EmitBlockAfterUses(ExceptBB);
1890 
1891   if (CGM.getCodeGenOpts().NewMSEH) {
1892     // __except blocks don't get outlined into funclets, so immediately do a
1893     // catchret.
1894     llvm::BasicBlock *CatchPadBB = ExceptBB->getSinglePredecessor();
1895     assert(CatchPadBB && "only ExceptBB pred should be catchpad");
1896     llvm::CatchPadInst *CPI =
1897         cast<llvm::CatchPadInst>(CatchPadBB->getFirstNonPHI());
1898     ExceptBB = createBasicBlock("__except");
1899     Builder.CreateCatchRet(CPI, ExceptBB);
1900     EmitBlock(ExceptBB);
1901   }
1902 
1903   // On Win64, the exception pointer is the exception code. Copy it to the slot.
1904   if (CGM.getTarget().getTriple().getArch() != llvm::Triple::x86) {
1905     llvm::Value *Code =
1906         Builder.CreatePtrToInt(getExceptionFromSlot(), IntPtrTy);
1907     Code = Builder.CreateTrunc(Code, Int32Ty);
1908     Builder.CreateStore(Code, SEHCodeSlotStack.back());
1909   }
1910 
1911   // Emit the __except body.
1912   EmitStmt(Except->getBlock());
1913 
1914   // End the lifetime of the exception code.
1915   SEHCodeSlotStack.pop_back();
1916 
1917   if (HaveInsertPoint())
1918     Builder.CreateBr(ContBB);
1919 
1920   EmitBlock(ContBB);
1921 }
1922 
1923 void CodeGenFunction::EmitSEHLeaveStmt(const SEHLeaveStmt &S) {
1924   // If this code is reachable then emit a stop point (if generating
1925   // debug info). We have to do this ourselves because we are on the
1926   // "simple" statement path.
1927   if (HaveInsertPoint())
1928     EmitStopPoint(&S);
1929 
1930   // This must be a __leave from a __finally block, which we warn on and is UB.
1931   // Just emit unreachable.
1932   if (!isSEHTryScope()) {
1933     Builder.CreateUnreachable();
1934     Builder.ClearInsertionPoint();
1935     return;
1936   }
1937 
1938   EmitBranchThroughCleanup(*SEHTryEpilogueStack.back());
1939 }
1940