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 "CGCleanup.h"
16 #include "CGObjCRuntime.h"
17 #include "TargetInfo.h"
18 #include "clang/AST/StmtCXX.h"
19 #include "clang/AST/StmtObjC.h"
20 #include "llvm/IR/Intrinsics.h"
21 #include "llvm/Support/CallSite.h"
22 
23 using namespace clang;
24 using namespace CodeGen;
25 
26 static llvm::Constant *getAllocateExceptionFn(CodeGenModule &CGM) {
27   // void *__cxa_allocate_exception(size_t thrown_size);
28 
29   llvm::FunctionType *FTy =
30     llvm::FunctionType::get(CGM.Int8PtrTy, CGM.SizeTy, /*IsVarArgs=*/false);
31 
32   return CGM.CreateRuntimeFunction(FTy, "__cxa_allocate_exception");
33 }
34 
35 static llvm::Constant *getFreeExceptionFn(CodeGenModule &CGM) {
36   // void __cxa_free_exception(void *thrown_exception);
37 
38   llvm::FunctionType *FTy =
39     llvm::FunctionType::get(CGM.VoidTy, CGM.Int8PtrTy, /*IsVarArgs=*/false);
40 
41   return CGM.CreateRuntimeFunction(FTy, "__cxa_free_exception");
42 }
43 
44 static llvm::Constant *getThrowFn(CodeGenModule &CGM) {
45   // void __cxa_throw(void *thrown_exception, std::type_info *tinfo,
46   //                  void (*dest) (void *));
47 
48   llvm::Type *Args[3] = { CGM.Int8PtrTy, CGM.Int8PtrTy, CGM.Int8PtrTy };
49   llvm::FunctionType *FTy =
50     llvm::FunctionType::get(CGM.VoidTy, Args, /*IsVarArgs=*/false);
51 
52   return CGM.CreateRuntimeFunction(FTy, "__cxa_throw");
53 }
54 
55 static llvm::Constant *getReThrowFn(CodeGenModule &CGM) {
56   // void __cxa_rethrow();
57 
58   llvm::FunctionType *FTy =
59     llvm::FunctionType::get(CGM.VoidTy, /*IsVarArgs=*/false);
60 
61   return CGM.CreateRuntimeFunction(FTy, "__cxa_rethrow");
62 }
63 
64 static llvm::Constant *getGetExceptionPtrFn(CodeGenModule &CGM) {
65   // void *__cxa_get_exception_ptr(void*);
66 
67   llvm::FunctionType *FTy =
68     llvm::FunctionType::get(CGM.Int8PtrTy, CGM.Int8PtrTy, /*IsVarArgs=*/false);
69 
70   return CGM.CreateRuntimeFunction(FTy, "__cxa_get_exception_ptr");
71 }
72 
73 static llvm::Constant *getBeginCatchFn(CodeGenModule &CGM) {
74   // void *__cxa_begin_catch(void*);
75 
76   llvm::FunctionType *FTy =
77     llvm::FunctionType::get(CGM.Int8PtrTy, CGM.Int8PtrTy, /*IsVarArgs=*/false);
78 
79   return CGM.CreateRuntimeFunction(FTy, "__cxa_begin_catch");
80 }
81 
82 static llvm::Constant *getEndCatchFn(CodeGenModule &CGM) {
83   // void __cxa_end_catch();
84 
85   llvm::FunctionType *FTy =
86     llvm::FunctionType::get(CGM.VoidTy, /*IsVarArgs=*/false);
87 
88   return CGM.CreateRuntimeFunction(FTy, "__cxa_end_catch");
89 }
90 
91 static llvm::Constant *getUnexpectedFn(CodeGenModule &CGM) {
92   // void __cxa_call_unexpected(void *thrown_exception);
93 
94   llvm::FunctionType *FTy =
95     llvm::FunctionType::get(CGM.VoidTy, CGM.Int8PtrTy, /*IsVarArgs=*/false);
96 
97   return CGM.CreateRuntimeFunction(FTy, "__cxa_call_unexpected");
98 }
99 
100 llvm::Constant *CodeGenFunction::getUnwindResumeFn() {
101   llvm::FunctionType *FTy =
102     llvm::FunctionType::get(VoidTy, Int8PtrTy, /*IsVarArgs=*/false);
103 
104   if (CGM.getLangOpts().SjLjExceptions)
105     return CGM.CreateRuntimeFunction(FTy, "_Unwind_SjLj_Resume");
106   return CGM.CreateRuntimeFunction(FTy, "_Unwind_Resume");
107 }
108 
109 llvm::Constant *CodeGenFunction::getUnwindResumeOrRethrowFn() {
110   llvm::FunctionType *FTy =
111     llvm::FunctionType::get(VoidTy, Int8PtrTy, /*IsVarArgs=*/false);
112 
113   if (CGM.getLangOpts().SjLjExceptions)
114     return CGM.CreateRuntimeFunction(FTy, "_Unwind_SjLj_Resume_or_Rethrow");
115   return CGM.CreateRuntimeFunction(FTy, "_Unwind_Resume_or_Rethrow");
116 }
117 
118 static llvm::Constant *getTerminateFn(CodeGenModule &CGM) {
119   // void __terminate();
120 
121   llvm::FunctionType *FTy =
122     llvm::FunctionType::get(CGM.VoidTy, /*IsVarArgs=*/false);
123 
124   StringRef name;
125 
126   // In C++, use std::terminate().
127   if (CGM.getLangOpts().CPlusPlus)
128     name = "_ZSt9terminatev"; // FIXME: mangling!
129   else if (CGM.getLangOpts().ObjC1 &&
130            CGM.getLangOpts().ObjCRuntime.hasTerminate())
131     name = "objc_terminate";
132   else
133     name = "abort";
134   return CGM.CreateRuntimeFunction(FTy, name);
135 }
136 
137 static llvm::Constant *getCatchallRethrowFn(CodeGenModule &CGM,
138                                             StringRef Name) {
139   llvm::FunctionType *FTy =
140     llvm::FunctionType::get(CGM.VoidTy, CGM.Int8PtrTy, /*IsVarArgs=*/false);
141 
142   return CGM.CreateRuntimeFunction(FTy, Name);
143 }
144 
145 namespace {
146   /// The exceptions personality for a function.
147   struct EHPersonality {
148     const char *PersonalityFn;
149 
150     // If this is non-null, this personality requires a non-standard
151     // function for rethrowing an exception after a catchall cleanup.
152     // This function must have prototype void(void*).
153     const char *CatchallRethrowFn;
154 
155     static const EHPersonality &get(const LangOptions &Lang);
156     static const EHPersonality GNU_C;
157     static const EHPersonality GNU_C_SJLJ;
158     static const EHPersonality GNU_ObjC;
159     static const EHPersonality GNUstep_ObjC;
160     static const EHPersonality GNU_ObjCXX;
161     static const EHPersonality NeXT_ObjC;
162     static const EHPersonality GNU_CPlusPlus;
163     static const EHPersonality GNU_CPlusPlus_SJLJ;
164   };
165 }
166 
167 const EHPersonality EHPersonality::GNU_C = { "__gcc_personality_v0", 0 };
168 const EHPersonality EHPersonality::GNU_C_SJLJ = { "__gcc_personality_sj0", 0 };
169 const EHPersonality EHPersonality::NeXT_ObjC = { "__objc_personality_v0", 0 };
170 const EHPersonality EHPersonality::GNU_CPlusPlus = { "__gxx_personality_v0", 0};
171 const EHPersonality
172 EHPersonality::GNU_CPlusPlus_SJLJ = { "__gxx_personality_sj0", 0 };
173 const EHPersonality
174 EHPersonality::GNU_ObjC = {"__gnu_objc_personality_v0", "objc_exception_throw"};
175 const EHPersonality
176 EHPersonality::GNU_ObjCXX = { "__gnustep_objcxx_personality_v0", 0 };
177 const EHPersonality
178 EHPersonality::GNUstep_ObjC = { "__gnustep_objc_personality_v0", 0 };
179 
180 static const EHPersonality &getCPersonality(const LangOptions &L) {
181   if (L.SjLjExceptions)
182     return EHPersonality::GNU_C_SJLJ;
183   return EHPersonality::GNU_C;
184 }
185 
186 static const EHPersonality &getObjCPersonality(const LangOptions &L) {
187   switch (L.ObjCRuntime.getKind()) {
188   case ObjCRuntime::FragileMacOSX:
189     return getCPersonality(L);
190   case ObjCRuntime::MacOSX:
191   case ObjCRuntime::iOS:
192     return EHPersonality::NeXT_ObjC;
193   case ObjCRuntime::GNUstep:
194     if (L.ObjCRuntime.getVersion() >= VersionTuple(1, 7))
195       return EHPersonality::GNUstep_ObjC;
196     // fallthrough
197   case ObjCRuntime::GCC:
198   case ObjCRuntime::ObjFW:
199     return EHPersonality::GNU_ObjC;
200   }
201   llvm_unreachable("bad runtime kind");
202 }
203 
204 static const EHPersonality &getCXXPersonality(const LangOptions &L) {
205   if (L.SjLjExceptions)
206     return EHPersonality::GNU_CPlusPlus_SJLJ;
207   else
208     return EHPersonality::GNU_CPlusPlus;
209 }
210 
211 /// Determines the personality function to use when both C++
212 /// and Objective-C exceptions are being caught.
213 static const EHPersonality &getObjCXXPersonality(const LangOptions &L) {
214   switch (L.ObjCRuntime.getKind()) {
215   // The ObjC personality defers to the C++ personality for non-ObjC
216   // handlers.  Unlike the C++ case, we use the same personality
217   // function on targets using (backend-driven) SJLJ EH.
218   case ObjCRuntime::MacOSX:
219   case ObjCRuntime::iOS:
220     return EHPersonality::NeXT_ObjC;
221 
222   // In the fragile ABI, just use C++ exception handling and hope
223   // they're not doing crazy exception mixing.
224   case ObjCRuntime::FragileMacOSX:
225     return getCXXPersonality(L);
226 
227   // The GCC runtime's personality function inherently doesn't support
228   // mixed EH.  Use the C++ personality just to avoid returning null.
229   case ObjCRuntime::GCC:
230   case ObjCRuntime::ObjFW: // XXX: this will change soon
231     return EHPersonality::GNU_ObjC;
232   case ObjCRuntime::GNUstep:
233     return EHPersonality::GNU_ObjCXX;
234   }
235   llvm_unreachable("bad runtime kind");
236 }
237 
238 const EHPersonality &EHPersonality::get(const LangOptions &L) {
239   if (L.CPlusPlus && L.ObjC1)
240     return getObjCXXPersonality(L);
241   else if (L.CPlusPlus)
242     return getCXXPersonality(L);
243   else if (L.ObjC1)
244     return getObjCPersonality(L);
245   else
246     return getCPersonality(L);
247 }
248 
249 static llvm::Constant *getPersonalityFn(CodeGenModule &CGM,
250                                         const EHPersonality &Personality) {
251   llvm::Constant *Fn =
252     CGM.CreateRuntimeFunction(llvm::FunctionType::get(CGM.Int32Ty, true),
253                               Personality.PersonalityFn);
254   return Fn;
255 }
256 
257 static llvm::Constant *getOpaquePersonalityFn(CodeGenModule &CGM,
258                                         const EHPersonality &Personality) {
259   llvm::Constant *Fn = getPersonalityFn(CGM, Personality);
260   return llvm::ConstantExpr::getBitCast(Fn, CGM.Int8PtrTy);
261 }
262 
263 /// Check whether a personality function could reasonably be swapped
264 /// for a C++ personality function.
265 static bool PersonalityHasOnlyCXXUses(llvm::Constant *Fn) {
266   for (llvm::Constant::use_iterator
267          I = Fn->use_begin(), E = Fn->use_end(); I != E; ++I) {
268     llvm::User *User = *I;
269 
270     // Conditionally white-list bitcasts.
271     if (llvm::ConstantExpr *CE = dyn_cast<llvm::ConstantExpr>(User)) {
272       if (CE->getOpcode() != llvm::Instruction::BitCast) return false;
273       if (!PersonalityHasOnlyCXXUses(CE))
274         return false;
275       continue;
276     }
277 
278     // Otherwise, it has to be a landingpad instruction.
279     llvm::LandingPadInst *LPI = dyn_cast<llvm::LandingPadInst>(User);
280     if (!LPI) return false;
281 
282     for (unsigned I = 0, E = LPI->getNumClauses(); I != E; ++I) {
283       // Look for something that would've been returned by the ObjC
284       // runtime's GetEHType() method.
285       llvm::Value *Val = LPI->getClause(I)->stripPointerCasts();
286       if (LPI->isCatch(I)) {
287         // Check if the catch value has the ObjC prefix.
288         if (llvm::GlobalVariable *GV = dyn_cast<llvm::GlobalVariable>(Val))
289           // ObjC EH selector entries are always global variables with
290           // names starting like this.
291           if (GV->getName().startswith("OBJC_EHTYPE"))
292             return false;
293       } else {
294         // Check if any of the filter values have the ObjC prefix.
295         llvm::Constant *CVal = cast<llvm::Constant>(Val);
296         for (llvm::User::op_iterator
297                II = CVal->op_begin(), IE = CVal->op_end(); II != IE; ++II) {
298           if (llvm::GlobalVariable *GV =
299               cast<llvm::GlobalVariable>((*II)->stripPointerCasts()))
300             // ObjC EH selector entries are always global variables with
301             // names starting like this.
302             if (GV->getName().startswith("OBJC_EHTYPE"))
303               return false;
304         }
305       }
306     }
307   }
308 
309   return true;
310 }
311 
312 /// Try to use the C++ personality function in ObjC++.  Not doing this
313 /// can cause some incompatibilities with gcc, which is more
314 /// aggressive about only using the ObjC++ personality in a function
315 /// when it really needs it.
316 void CodeGenModule::SimplifyPersonality() {
317   // If we're not in ObjC++ -fexceptions, there's nothing to do.
318   if (!LangOpts.CPlusPlus || !LangOpts.ObjC1 || !LangOpts.Exceptions)
319     return;
320 
321   // Both the problem this endeavors to fix and the way the logic
322   // above works is specific to the NeXT runtime.
323   if (!LangOpts.ObjCRuntime.isNeXTFamily())
324     return;
325 
326   const EHPersonality &ObjCXX = EHPersonality::get(LangOpts);
327   const EHPersonality &CXX = getCXXPersonality(LangOpts);
328   if (&ObjCXX == &CXX)
329     return;
330 
331   assert(std::strcmp(ObjCXX.PersonalityFn, CXX.PersonalityFn) != 0 &&
332          "Different EHPersonalities using the same personality function.");
333 
334   llvm::Function *Fn = getModule().getFunction(ObjCXX.PersonalityFn);
335 
336   // Nothing to do if it's unused.
337   if (!Fn || Fn->use_empty()) return;
338 
339   // Can't do the optimization if it has non-C++ uses.
340   if (!PersonalityHasOnlyCXXUses(Fn)) return;
341 
342   // Create the C++ personality function and kill off the old
343   // function.
344   llvm::Constant *CXXFn = getPersonalityFn(*this, CXX);
345 
346   // This can happen if the user is screwing with us.
347   if (Fn->getType() != CXXFn->getType()) return;
348 
349   Fn->replaceAllUsesWith(CXXFn);
350   Fn->eraseFromParent();
351 }
352 
353 /// Returns the value to inject into a selector to indicate the
354 /// presence of a catch-all.
355 static llvm::Constant *getCatchAllValue(CodeGenFunction &CGF) {
356   // Possibly we should use @llvm.eh.catch.all.value here.
357   return llvm::ConstantPointerNull::get(CGF.Int8PtrTy);
358 }
359 
360 namespace {
361   /// A cleanup to free the exception object if its initialization
362   /// throws.
363   struct FreeException : EHScopeStack::Cleanup {
364     llvm::Value *exn;
365     FreeException(llvm::Value *exn) : exn(exn) {}
366     void Emit(CodeGenFunction &CGF, Flags flags) {
367       CGF.EmitNounwindRuntimeCall(getFreeExceptionFn(CGF.CGM), exn);
368     }
369   };
370 }
371 
372 // Emits an exception expression into the given location.  This
373 // differs from EmitAnyExprToMem only in that, if a final copy-ctor
374 // call is required, an exception within that copy ctor causes
375 // std::terminate to be invoked.
376 static void EmitAnyExprToExn(CodeGenFunction &CGF, const Expr *e,
377                              llvm::Value *addr) {
378   // Make sure the exception object is cleaned up if there's an
379   // exception during initialization.
380   CGF.pushFullExprCleanup<FreeException>(EHCleanup, addr);
381   EHScopeStack::stable_iterator cleanup = CGF.EHStack.stable_begin();
382 
383   // __cxa_allocate_exception returns a void*;  we need to cast this
384   // to the appropriate type for the object.
385   llvm::Type *ty = CGF.ConvertTypeForMem(e->getType())->getPointerTo();
386   llvm::Value *typedAddr = CGF.Builder.CreateBitCast(addr, ty);
387 
388   // FIXME: this isn't quite right!  If there's a final unelided call
389   // to a copy constructor, then according to [except.terminate]p1 we
390   // must call std::terminate() if that constructor throws, because
391   // technically that copy occurs after the exception expression is
392   // evaluated but before the exception is caught.  But the best way
393   // to handle that is to teach EmitAggExpr to do the final copy
394   // differently if it can't be elided.
395   CGF.EmitAnyExprToMem(e, typedAddr, e->getType().getQualifiers(),
396                        /*IsInit*/ true);
397 
398   // Deactivate the cleanup block.
399   CGF.DeactivateCleanupBlock(cleanup, cast<llvm::Instruction>(typedAddr));
400 }
401 
402 llvm::Value *CodeGenFunction::getExceptionSlot() {
403   if (!ExceptionSlot)
404     ExceptionSlot = CreateTempAlloca(Int8PtrTy, "exn.slot");
405   return ExceptionSlot;
406 }
407 
408 llvm::Value *CodeGenFunction::getEHSelectorSlot() {
409   if (!EHSelectorSlot)
410     EHSelectorSlot = CreateTempAlloca(Int32Ty, "ehselector.slot");
411   return EHSelectorSlot;
412 }
413 
414 llvm::Value *CodeGenFunction::getExceptionFromSlot() {
415   return Builder.CreateLoad(getExceptionSlot(), "exn");
416 }
417 
418 llvm::Value *CodeGenFunction::getSelectorFromSlot() {
419   return Builder.CreateLoad(getEHSelectorSlot(), "sel");
420 }
421 
422 void CodeGenFunction::EmitCXXThrowExpr(const CXXThrowExpr *E,
423                                        bool KeepInsertionPoint) {
424   if (!E->getSubExpr()) {
425     EmitNoreturnRuntimeCallOrInvoke(getReThrowFn(CGM),
426                                     ArrayRef<llvm::Value*>());
427 
428     // throw is an expression, and the expression emitters expect us
429     // to leave ourselves at a valid insertion point.
430     if (KeepInsertionPoint)
431       EmitBlock(createBasicBlock("throw.cont"));
432 
433     return;
434   }
435 
436   QualType ThrowType = E->getSubExpr()->getType();
437 
438   if (ThrowType->isObjCObjectPointerType()) {
439     const Stmt *ThrowStmt = E->getSubExpr();
440     const ObjCAtThrowStmt S(E->getExprLoc(),
441                             const_cast<Stmt *>(ThrowStmt));
442     CGM.getObjCRuntime().EmitThrowStmt(*this, S, false);
443     // This will clear insertion point which was not cleared in
444     // call to EmitThrowStmt.
445     if (KeepInsertionPoint)
446       EmitBlock(createBasicBlock("throw.cont"));
447     return;
448   }
449 
450   // Now allocate the exception object.
451   llvm::Type *SizeTy = ConvertType(getContext().getSizeType());
452   uint64_t TypeSize = getContext().getTypeSizeInChars(ThrowType).getQuantity();
453 
454   llvm::Constant *AllocExceptionFn = getAllocateExceptionFn(CGM);
455   llvm::CallInst *ExceptionPtr =
456     EmitNounwindRuntimeCall(AllocExceptionFn,
457                             llvm::ConstantInt::get(SizeTy, TypeSize),
458                             "exception");
459 
460   EmitAnyExprToExn(*this, E->getSubExpr(), ExceptionPtr);
461 
462   // Now throw the exception.
463   llvm::Constant *TypeInfo = CGM.GetAddrOfRTTIDescriptor(ThrowType,
464                                                          /*ForEH=*/true);
465 
466   // The address of the destructor.  If the exception type has a
467   // trivial destructor (or isn't a record), we just pass null.
468   llvm::Constant *Dtor = 0;
469   if (const RecordType *RecordTy = ThrowType->getAs<RecordType>()) {
470     CXXRecordDecl *Record = cast<CXXRecordDecl>(RecordTy->getDecl());
471     if (!Record->hasTrivialDestructor()) {
472       CXXDestructorDecl *DtorD = Record->getDestructor();
473       Dtor = CGM.GetAddrOfCXXDestructor(DtorD, Dtor_Complete);
474       Dtor = llvm::ConstantExpr::getBitCast(Dtor, Int8PtrTy);
475     }
476   }
477   if (!Dtor) Dtor = llvm::Constant::getNullValue(Int8PtrTy);
478 
479   llvm::Value *args[] = { ExceptionPtr, TypeInfo, Dtor };
480   EmitNoreturnRuntimeCallOrInvoke(getThrowFn(CGM), args);
481 
482   // throw is an expression, and the expression emitters expect us
483   // to leave ourselves at a valid insertion point.
484   if (KeepInsertionPoint)
485     EmitBlock(createBasicBlock("throw.cont"));
486 }
487 
488 void CodeGenFunction::EmitStartEHSpec(const Decl *D) {
489   if (!CGM.getLangOpts().CXXExceptions)
490     return;
491 
492   const FunctionDecl* FD = dyn_cast_or_null<FunctionDecl>(D);
493   if (FD == 0)
494     return;
495   const FunctionProtoType *Proto = FD->getType()->getAs<FunctionProtoType>();
496   if (Proto == 0)
497     return;
498 
499   ExceptionSpecificationType EST = Proto->getExceptionSpecType();
500   if (isNoexceptExceptionSpec(EST)) {
501     if (Proto->getNoexceptSpec(getContext()) == FunctionProtoType::NR_Nothrow) {
502       // noexcept functions are simple terminate scopes.
503       EHStack.pushTerminate();
504     }
505   } else if (EST == EST_Dynamic || EST == EST_DynamicNone) {
506     unsigned NumExceptions = Proto->getNumExceptions();
507     EHFilterScope *Filter = EHStack.pushFilter(NumExceptions);
508 
509     for (unsigned I = 0; I != NumExceptions; ++I) {
510       QualType Ty = Proto->getExceptionType(I);
511       QualType ExceptType = Ty.getNonReferenceType().getUnqualifiedType();
512       llvm::Value *EHType = CGM.GetAddrOfRTTIDescriptor(ExceptType,
513                                                         /*ForEH=*/true);
514       Filter->setFilter(I, EHType);
515     }
516   }
517 }
518 
519 /// Emit the dispatch block for a filter scope if necessary.
520 static void emitFilterDispatchBlock(CodeGenFunction &CGF,
521                                     EHFilterScope &filterScope) {
522   llvm::BasicBlock *dispatchBlock = filterScope.getCachedEHDispatchBlock();
523   if (!dispatchBlock) return;
524   if (dispatchBlock->use_empty()) {
525     delete dispatchBlock;
526     return;
527   }
528 
529   CGF.EmitBlockAfterUses(dispatchBlock);
530 
531   // If this isn't a catch-all filter, we need to check whether we got
532   // here because the filter triggered.
533   if (filterScope.getNumFilters()) {
534     // Load the selector value.
535     llvm::Value *selector = CGF.getSelectorFromSlot();
536     llvm::BasicBlock *unexpectedBB = CGF.createBasicBlock("ehspec.unexpected");
537 
538     llvm::Value *zero = CGF.Builder.getInt32(0);
539     llvm::Value *failsFilter =
540       CGF.Builder.CreateICmpSLT(selector, zero, "ehspec.fails");
541     CGF.Builder.CreateCondBr(failsFilter, unexpectedBB, CGF.getEHResumeBlock(false));
542 
543     CGF.EmitBlock(unexpectedBB);
544   }
545 
546   // Call __cxa_call_unexpected.  This doesn't need to be an invoke
547   // because __cxa_call_unexpected magically filters exceptions
548   // according to the last landing pad the exception was thrown
549   // into.  Seriously.
550   llvm::Value *exn = CGF.getExceptionFromSlot();
551   CGF.EmitRuntimeCall(getUnexpectedFn(CGF.CGM), exn)
552     ->setDoesNotReturn();
553   CGF.Builder.CreateUnreachable();
554 }
555 
556 void CodeGenFunction::EmitEndEHSpec(const Decl *D) {
557   if (!CGM.getLangOpts().CXXExceptions)
558     return;
559 
560   const FunctionDecl* FD = dyn_cast_or_null<FunctionDecl>(D);
561   if (FD == 0)
562     return;
563   const FunctionProtoType *Proto = FD->getType()->getAs<FunctionProtoType>();
564   if (Proto == 0)
565     return;
566 
567   ExceptionSpecificationType EST = Proto->getExceptionSpecType();
568   if (isNoexceptExceptionSpec(EST)) {
569     if (Proto->getNoexceptSpec(getContext()) == FunctionProtoType::NR_Nothrow) {
570       EHStack.popTerminate();
571     }
572   } else if (EST == EST_Dynamic || EST == EST_DynamicNone) {
573     EHFilterScope &filterScope = cast<EHFilterScope>(*EHStack.begin());
574     emitFilterDispatchBlock(*this, filterScope);
575     EHStack.popFilter();
576   }
577 }
578 
579 void CodeGenFunction::EmitCXXTryStmt(const CXXTryStmt &S) {
580   EnterCXXTryStmt(S);
581   EmitStmt(S.getTryBlock());
582   ExitCXXTryStmt(S);
583 }
584 
585 void CodeGenFunction::EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock) {
586   unsigned NumHandlers = S.getNumHandlers();
587   EHCatchScope *CatchScope = EHStack.pushCatch(NumHandlers);
588 
589   for (unsigned I = 0; I != NumHandlers; ++I) {
590     const CXXCatchStmt *C = S.getHandler(I);
591 
592     llvm::BasicBlock *Handler = createBasicBlock("catch");
593     if (C->getExceptionDecl()) {
594       // FIXME: Dropping the reference type on the type into makes it
595       // impossible to correctly implement catch-by-reference
596       // semantics for pointers.  Unfortunately, this is what all
597       // existing compilers do, and it's not clear that the standard
598       // personality routine is capable of doing this right.  See C++ DR 388:
599       //   http://www.open-std.org/jtc1/sc22/wg21/docs/cwg_active.html#388
600       QualType CaughtType = C->getCaughtType();
601       CaughtType = CaughtType.getNonReferenceType().getUnqualifiedType();
602 
603       llvm::Value *TypeInfo = 0;
604       if (CaughtType->isObjCObjectPointerType())
605         TypeInfo = CGM.getObjCRuntime().GetEHType(CaughtType);
606       else
607         TypeInfo = CGM.GetAddrOfRTTIDescriptor(CaughtType, /*ForEH=*/true);
608       CatchScope->setHandler(I, TypeInfo, Handler);
609     } else {
610       // No exception decl indicates '...', a catch-all.
611       CatchScope->setCatchAllHandler(I, Handler);
612     }
613   }
614 }
615 
616 llvm::BasicBlock *
617 CodeGenFunction::getEHDispatchBlock(EHScopeStack::stable_iterator si) {
618   // The dispatch block for the end of the scope chain is a block that
619   // just resumes unwinding.
620   if (si == EHStack.stable_end())
621     return getEHResumeBlock(true);
622 
623   // Otherwise, we should look at the actual scope.
624   EHScope &scope = *EHStack.find(si);
625 
626   llvm::BasicBlock *dispatchBlock = scope.getCachedEHDispatchBlock();
627   if (!dispatchBlock) {
628     switch (scope.getKind()) {
629     case EHScope::Catch: {
630       // Apply a special case to a single catch-all.
631       EHCatchScope &catchScope = cast<EHCatchScope>(scope);
632       if (catchScope.getNumHandlers() == 1 &&
633           catchScope.getHandler(0).isCatchAll()) {
634         dispatchBlock = catchScope.getHandler(0).Block;
635 
636       // Otherwise, make a dispatch block.
637       } else {
638         dispatchBlock = createBasicBlock("catch.dispatch");
639       }
640       break;
641     }
642 
643     case EHScope::Cleanup:
644       dispatchBlock = createBasicBlock("ehcleanup");
645       break;
646 
647     case EHScope::Filter:
648       dispatchBlock = createBasicBlock("filter.dispatch");
649       break;
650 
651     case EHScope::Terminate:
652       dispatchBlock = getTerminateHandler();
653       break;
654     }
655     scope.setCachedEHDispatchBlock(dispatchBlock);
656   }
657   return dispatchBlock;
658 }
659 
660 /// Check whether this is a non-EH scope, i.e. a scope which doesn't
661 /// affect exception handling.  Currently, the only non-EH scopes are
662 /// normal-only cleanup scopes.
663 static bool isNonEHScope(const EHScope &S) {
664   switch (S.getKind()) {
665   case EHScope::Cleanup:
666     return !cast<EHCleanupScope>(S).isEHCleanup();
667   case EHScope::Filter:
668   case EHScope::Catch:
669   case EHScope::Terminate:
670     return false;
671   }
672 
673   llvm_unreachable("Invalid EHScope Kind!");
674 }
675 
676 llvm::BasicBlock *CodeGenFunction::getInvokeDestImpl() {
677   assert(EHStack.requiresLandingPad());
678   assert(!EHStack.empty());
679 
680   if (!CGM.getLangOpts().Exceptions)
681     return 0;
682 
683   // Check the innermost scope for a cached landing pad.  If this is
684   // a non-EH cleanup, we'll check enclosing scopes in EmitLandingPad.
685   llvm::BasicBlock *LP = EHStack.begin()->getCachedLandingPad();
686   if (LP) return LP;
687 
688   // Build the landing pad for this scope.
689   LP = EmitLandingPad();
690   assert(LP);
691 
692   // Cache the landing pad on the innermost scope.  If this is a
693   // non-EH scope, cache the landing pad on the enclosing scope, too.
694   for (EHScopeStack::iterator ir = EHStack.begin(); true; ++ir) {
695     ir->setCachedLandingPad(LP);
696     if (!isNonEHScope(*ir)) break;
697   }
698 
699   return LP;
700 }
701 
702 // This code contains a hack to work around a design flaw in
703 // LLVM's EH IR which breaks semantics after inlining.  This same
704 // hack is implemented in llvm-gcc.
705 //
706 // The LLVM EH abstraction is basically a thin veneer over the
707 // traditional GCC zero-cost design: for each range of instructions
708 // in the function, there is (at most) one "landing pad" with an
709 // associated chain of EH actions.  A language-specific personality
710 // function interprets this chain of actions and (1) decides whether
711 // or not to resume execution at the landing pad and (2) if so,
712 // provides an integer indicating why it's stopping.  In LLVM IR,
713 // the association of a landing pad with a range of instructions is
714 // achieved via an invoke instruction, the chain of actions becomes
715 // the arguments to the @llvm.eh.selector call, and the selector
716 // call returns the integer indicator.  Other than the required
717 // presence of two intrinsic function calls in the landing pad,
718 // the IR exactly describes the layout of the output code.
719 //
720 // A principal advantage of this design is that it is completely
721 // language-agnostic; in theory, the LLVM optimizers can treat
722 // landing pads neutrally, and targets need only know how to lower
723 // the intrinsics to have a functioning exceptions system (assuming
724 // that platform exceptions follow something approximately like the
725 // GCC design).  Unfortunately, landing pads cannot be combined in a
726 // language-agnostic way: given selectors A and B, there is no way
727 // to make a single landing pad which faithfully represents the
728 // semantics of propagating an exception first through A, then
729 // through B, without knowing how the personality will interpret the
730 // (lowered form of the) selectors.  This means that inlining has no
731 // choice but to crudely chain invokes (i.e., to ignore invokes in
732 // the inlined function, but to turn all unwindable calls into
733 // invokes), which is only semantically valid if every unwind stops
734 // at every landing pad.
735 //
736 // Therefore, the invoke-inline hack is to guarantee that every
737 // landing pad has a catch-all.
738 enum CleanupHackLevel_t {
739   /// A level of hack that requires that all landing pads have
740   /// catch-alls.
741   CHL_MandatoryCatchall,
742 
743   /// A level of hack that requires that all landing pads handle
744   /// cleanups.
745   CHL_MandatoryCleanup,
746 
747   /// No hacks at all;  ideal IR generation.
748   CHL_Ideal
749 };
750 const CleanupHackLevel_t CleanupHackLevel = CHL_MandatoryCleanup;
751 
752 llvm::BasicBlock *CodeGenFunction::EmitLandingPad() {
753   assert(EHStack.requiresLandingPad());
754 
755   EHScope &innermostEHScope = *EHStack.find(EHStack.getInnermostEHScope());
756   switch (innermostEHScope.getKind()) {
757   case EHScope::Terminate:
758     return getTerminateLandingPad();
759 
760   case EHScope::Catch:
761   case EHScope::Cleanup:
762   case EHScope::Filter:
763     if (llvm::BasicBlock *lpad = innermostEHScope.getCachedLandingPad())
764       return lpad;
765   }
766 
767   // Save the current IR generation state.
768   CGBuilderTy::InsertPoint savedIP = Builder.saveAndClearIP();
769   SaveAndRestoreLocation AutoRestoreLocation(*this, Builder);
770   if (CGDebugInfo *DI = getDebugInfo())
771     DI->EmitLocation(Builder, CurEHLocation);
772 
773   const EHPersonality &personality = EHPersonality::get(getLangOpts());
774 
775   // Create and configure the landing pad.
776   llvm::BasicBlock *lpad = createBasicBlock("lpad");
777   EmitBlock(lpad);
778 
779   llvm::LandingPadInst *LPadInst =
780     Builder.CreateLandingPad(llvm::StructType::get(Int8PtrTy, Int32Ty, NULL),
781                              getOpaquePersonalityFn(CGM, personality), 0);
782 
783   llvm::Value *LPadExn = Builder.CreateExtractValue(LPadInst, 0);
784   Builder.CreateStore(LPadExn, getExceptionSlot());
785   llvm::Value *LPadSel = Builder.CreateExtractValue(LPadInst, 1);
786   Builder.CreateStore(LPadSel, getEHSelectorSlot());
787 
788   // Save the exception pointer.  It's safe to use a single exception
789   // pointer per function because EH cleanups can never have nested
790   // try/catches.
791   // Build the landingpad instruction.
792 
793   // Accumulate all the handlers in scope.
794   bool hasCatchAll = false;
795   bool hasCleanup = false;
796   bool hasFilter = false;
797   SmallVector<llvm::Value*, 4> filterTypes;
798   llvm::SmallPtrSet<llvm::Value*, 4> catchTypes;
799   for (EHScopeStack::iterator I = EHStack.begin(), E = EHStack.end();
800          I != E; ++I) {
801 
802     switch (I->getKind()) {
803     case EHScope::Cleanup:
804       // If we have a cleanup, remember that.
805       hasCleanup = (hasCleanup || cast<EHCleanupScope>(*I).isEHCleanup());
806       continue;
807 
808     case EHScope::Filter: {
809       assert(I.next() == EHStack.end() && "EH filter is not end of EH stack");
810       assert(!hasCatchAll && "EH filter reached after catch-all");
811 
812       // Filter scopes get added to the landingpad in weird ways.
813       EHFilterScope &filter = cast<EHFilterScope>(*I);
814       hasFilter = true;
815 
816       // Add all the filter values.
817       for (unsigned i = 0, e = filter.getNumFilters(); i != e; ++i)
818         filterTypes.push_back(filter.getFilter(i));
819       goto done;
820     }
821 
822     case EHScope::Terminate:
823       // Terminate scopes are basically catch-alls.
824       assert(!hasCatchAll);
825       hasCatchAll = true;
826       goto done;
827 
828     case EHScope::Catch:
829       break;
830     }
831 
832     EHCatchScope &catchScope = cast<EHCatchScope>(*I);
833     for (unsigned hi = 0, he = catchScope.getNumHandlers(); hi != he; ++hi) {
834       EHCatchScope::Handler handler = catchScope.getHandler(hi);
835 
836       // If this is a catch-all, register that and abort.
837       if (!handler.Type) {
838         assert(!hasCatchAll);
839         hasCatchAll = true;
840         goto done;
841       }
842 
843       // Check whether we already have a handler for this type.
844       if (catchTypes.insert(handler.Type))
845         // If not, add it directly to the landingpad.
846         LPadInst->addClause(handler.Type);
847     }
848   }
849 
850  done:
851   // If we have a catch-all, add null to the landingpad.
852   assert(!(hasCatchAll && hasFilter));
853   if (hasCatchAll) {
854     LPadInst->addClause(getCatchAllValue(*this));
855 
856   // If we have an EH filter, we need to add those handlers in the
857   // right place in the landingpad, which is to say, at the end.
858   } else if (hasFilter) {
859     // Create a filter expression: a constant array indicating which filter
860     // types there are. The personality routine only lands here if the filter
861     // doesn't match.
862     SmallVector<llvm::Constant*, 8> Filters;
863     llvm::ArrayType *AType =
864       llvm::ArrayType::get(!filterTypes.empty() ?
865                              filterTypes[0]->getType() : Int8PtrTy,
866                            filterTypes.size());
867 
868     for (unsigned i = 0, e = filterTypes.size(); i != e; ++i)
869       Filters.push_back(cast<llvm::Constant>(filterTypes[i]));
870     llvm::Constant *FilterArray = llvm::ConstantArray::get(AType, Filters);
871     LPadInst->addClause(FilterArray);
872 
873     // Also check whether we need a cleanup.
874     if (hasCleanup)
875       LPadInst->setCleanup(true);
876 
877   // Otherwise, signal that we at least have cleanups.
878   } else if (CleanupHackLevel == CHL_MandatoryCatchall || hasCleanup) {
879     if (CleanupHackLevel == CHL_MandatoryCatchall)
880       LPadInst->addClause(getCatchAllValue(*this));
881     else
882       LPadInst->setCleanup(true);
883   }
884 
885   assert((LPadInst->getNumClauses() > 0 || LPadInst->isCleanup()) &&
886          "landingpad instruction has no clauses!");
887 
888   // Tell the backend how to generate the landing pad.
889   Builder.CreateBr(getEHDispatchBlock(EHStack.getInnermostEHScope()));
890 
891   // Restore the old IR generation state.
892   Builder.restoreIP(savedIP);
893 
894   return lpad;
895 }
896 
897 namespace {
898   /// A cleanup to call __cxa_end_catch.  In many cases, the caught
899   /// exception type lets us state definitively that the thrown exception
900   /// type does not have a destructor.  In particular:
901   ///   - Catch-alls tell us nothing, so we have to conservatively
902   ///     assume that the thrown exception might have a destructor.
903   ///   - Catches by reference behave according to their base types.
904   ///   - Catches of non-record types will only trigger for exceptions
905   ///     of non-record types, which never have destructors.
906   ///   - Catches of record types can trigger for arbitrary subclasses
907   ///     of the caught type, so we have to assume the actual thrown
908   ///     exception type might have a throwing destructor, even if the
909   ///     caught type's destructor is trivial or nothrow.
910   struct CallEndCatch : EHScopeStack::Cleanup {
911     CallEndCatch(bool MightThrow) : MightThrow(MightThrow) {}
912     bool MightThrow;
913 
914     void Emit(CodeGenFunction &CGF, Flags flags) {
915       if (!MightThrow) {
916         CGF.EmitNounwindRuntimeCall(getEndCatchFn(CGF.CGM));
917         return;
918       }
919 
920       CGF.EmitRuntimeCallOrInvoke(getEndCatchFn(CGF.CGM));
921     }
922   };
923 }
924 
925 /// Emits a call to __cxa_begin_catch and enters a cleanup to call
926 /// __cxa_end_catch.
927 ///
928 /// \param EndMightThrow - true if __cxa_end_catch might throw
929 static llvm::Value *CallBeginCatch(CodeGenFunction &CGF,
930                                    llvm::Value *Exn,
931                                    bool EndMightThrow) {
932   llvm::CallInst *call =
933     CGF.EmitNounwindRuntimeCall(getBeginCatchFn(CGF.CGM), Exn);
934 
935   CGF.EHStack.pushCleanup<CallEndCatch>(NormalAndEHCleanup, EndMightThrow);
936 
937   return call;
938 }
939 
940 /// A "special initializer" callback for initializing a catch
941 /// parameter during catch initialization.
942 static void InitCatchParam(CodeGenFunction &CGF,
943                            const VarDecl &CatchParam,
944                            llvm::Value *ParamAddr,
945                            SourceLocation Loc) {
946   // Load the exception from where the landing pad saved it.
947   llvm::Value *Exn = CGF.getExceptionFromSlot();
948 
949   CanQualType CatchType =
950     CGF.CGM.getContext().getCanonicalType(CatchParam.getType());
951   llvm::Type *LLVMCatchTy = CGF.ConvertTypeForMem(CatchType);
952 
953   // If we're catching by reference, we can just cast the object
954   // pointer to the appropriate pointer.
955   if (isa<ReferenceType>(CatchType)) {
956     QualType CaughtType = cast<ReferenceType>(CatchType)->getPointeeType();
957     bool EndCatchMightThrow = CaughtType->isRecordType();
958 
959     // __cxa_begin_catch returns the adjusted object pointer.
960     llvm::Value *AdjustedExn = CallBeginCatch(CGF, Exn, EndCatchMightThrow);
961 
962     // We have no way to tell the personality function that we're
963     // catching by reference, so if we're catching a pointer,
964     // __cxa_begin_catch will actually return that pointer by value.
965     if (const PointerType *PT = dyn_cast<PointerType>(CaughtType)) {
966       QualType PointeeType = PT->getPointeeType();
967 
968       // When catching by reference, generally we should just ignore
969       // this by-value pointer and use the exception object instead.
970       if (!PointeeType->isRecordType()) {
971 
972         // Exn points to the struct _Unwind_Exception header, which
973         // we have to skip past in order to reach the exception data.
974         unsigned HeaderSize =
975           CGF.CGM.getTargetCodeGenInfo().getSizeOfUnwindException();
976         AdjustedExn = CGF.Builder.CreateConstGEP1_32(Exn, HeaderSize);
977 
978       // However, if we're catching a pointer-to-record type that won't
979       // work, because the personality function might have adjusted
980       // the pointer.  There's actually no way for us to fully satisfy
981       // the language/ABI contract here:  we can't use Exn because it
982       // might have the wrong adjustment, but we can't use the by-value
983       // pointer because it's off by a level of abstraction.
984       //
985       // The current solution is to dump the adjusted pointer into an
986       // alloca, which breaks language semantics (because changing the
987       // pointer doesn't change the exception) but at least works.
988       // The better solution would be to filter out non-exact matches
989       // and rethrow them, but this is tricky because the rethrow
990       // really needs to be catchable by other sites at this landing
991       // pad.  The best solution is to fix the personality function.
992       } else {
993         // Pull the pointer for the reference type off.
994         llvm::Type *PtrTy =
995           cast<llvm::PointerType>(LLVMCatchTy)->getElementType();
996 
997         // Create the temporary and write the adjusted pointer into it.
998         llvm::Value *ExnPtrTmp = CGF.CreateTempAlloca(PtrTy, "exn.byref.tmp");
999         llvm::Value *Casted = CGF.Builder.CreateBitCast(AdjustedExn, PtrTy);
1000         CGF.Builder.CreateStore(Casted, ExnPtrTmp);
1001 
1002         // Bind the reference to the temporary.
1003         AdjustedExn = ExnPtrTmp;
1004       }
1005     }
1006 
1007     llvm::Value *ExnCast =
1008       CGF.Builder.CreateBitCast(AdjustedExn, LLVMCatchTy, "exn.byref");
1009     CGF.Builder.CreateStore(ExnCast, ParamAddr);
1010     return;
1011   }
1012 
1013   // Scalars and complexes.
1014   TypeEvaluationKind TEK = CGF.getEvaluationKind(CatchType);
1015   if (TEK != TEK_Aggregate) {
1016     llvm::Value *AdjustedExn = CallBeginCatch(CGF, Exn, false);
1017 
1018     // If the catch type is a pointer type, __cxa_begin_catch returns
1019     // the pointer by value.
1020     if (CatchType->hasPointerRepresentation()) {
1021       llvm::Value *CastExn =
1022         CGF.Builder.CreateBitCast(AdjustedExn, LLVMCatchTy, "exn.casted");
1023 
1024       switch (CatchType.getQualifiers().getObjCLifetime()) {
1025       case Qualifiers::OCL_Strong:
1026         CastExn = CGF.EmitARCRetainNonBlock(CastExn);
1027         // fallthrough
1028 
1029       case Qualifiers::OCL_None:
1030       case Qualifiers::OCL_ExplicitNone:
1031       case Qualifiers::OCL_Autoreleasing:
1032         CGF.Builder.CreateStore(CastExn, ParamAddr);
1033         return;
1034 
1035       case Qualifiers::OCL_Weak:
1036         CGF.EmitARCInitWeak(ParamAddr, CastExn);
1037         return;
1038       }
1039       llvm_unreachable("bad ownership qualifier!");
1040     }
1041 
1042     // Otherwise, it returns a pointer into the exception object.
1043 
1044     llvm::Type *PtrTy = LLVMCatchTy->getPointerTo(0); // addrspace 0 ok
1045     llvm::Value *Cast = CGF.Builder.CreateBitCast(AdjustedExn, PtrTy);
1046 
1047     LValue srcLV = CGF.MakeNaturalAlignAddrLValue(Cast, CatchType);
1048     LValue destLV = CGF.MakeAddrLValue(ParamAddr, CatchType,
1049                                   CGF.getContext().getDeclAlign(&CatchParam));
1050     switch (TEK) {
1051     case TEK_Complex:
1052       CGF.EmitStoreOfComplex(CGF.EmitLoadOfComplex(srcLV, Loc), destLV,
1053                              /*init*/ true);
1054       return;
1055     case TEK_Scalar: {
1056       llvm::Value *ExnLoad = CGF.EmitLoadOfScalar(srcLV, Loc);
1057       CGF.EmitStoreOfScalar(ExnLoad, destLV, /*init*/ true);
1058       return;
1059     }
1060     case TEK_Aggregate:
1061       llvm_unreachable("evaluation kind filtered out!");
1062     }
1063     llvm_unreachable("bad evaluation kind");
1064   }
1065 
1066   assert(isa<RecordType>(CatchType) && "unexpected catch type!");
1067 
1068   llvm::Type *PtrTy = LLVMCatchTy->getPointerTo(0); // addrspace 0 ok
1069 
1070   // Check for a copy expression.  If we don't have a copy expression,
1071   // that means a trivial copy is okay.
1072   const Expr *copyExpr = CatchParam.getInit();
1073   if (!copyExpr) {
1074     llvm::Value *rawAdjustedExn = CallBeginCatch(CGF, Exn, true);
1075     llvm::Value *adjustedExn = CGF.Builder.CreateBitCast(rawAdjustedExn, PtrTy);
1076     CGF.EmitAggregateCopy(ParamAddr, adjustedExn, CatchType);
1077     return;
1078   }
1079 
1080   // We have to call __cxa_get_exception_ptr to get the adjusted
1081   // pointer before copying.
1082   llvm::CallInst *rawAdjustedExn =
1083     CGF.EmitNounwindRuntimeCall(getGetExceptionPtrFn(CGF.CGM), Exn);
1084 
1085   // Cast that to the appropriate type.
1086   llvm::Value *adjustedExn = CGF.Builder.CreateBitCast(rawAdjustedExn, PtrTy);
1087 
1088   // The copy expression is defined in terms of an OpaqueValueExpr.
1089   // Find it and map it to the adjusted expression.
1090   CodeGenFunction::OpaqueValueMapping
1091     opaque(CGF, OpaqueValueExpr::findInCopyConstruct(copyExpr),
1092            CGF.MakeAddrLValue(adjustedExn, CatchParam.getType()));
1093 
1094   // Call the copy ctor in a terminate scope.
1095   CGF.EHStack.pushTerminate();
1096 
1097   // Perform the copy construction.
1098   CharUnits Alignment = CGF.getContext().getDeclAlign(&CatchParam);
1099   CGF.EmitAggExpr(copyExpr,
1100                   AggValueSlot::forAddr(ParamAddr, Alignment, Qualifiers(),
1101                                         AggValueSlot::IsNotDestructed,
1102                                         AggValueSlot::DoesNotNeedGCBarriers,
1103                                         AggValueSlot::IsNotAliased));
1104 
1105   // Leave the terminate scope.
1106   CGF.EHStack.popTerminate();
1107 
1108   // Undo the opaque value mapping.
1109   opaque.pop();
1110 
1111   // Finally we can call __cxa_begin_catch.
1112   CallBeginCatch(CGF, Exn, true);
1113 }
1114 
1115 /// Begins a catch statement by initializing the catch variable and
1116 /// calling __cxa_begin_catch.
1117 static void BeginCatch(CodeGenFunction &CGF, const CXXCatchStmt *S) {
1118   // We have to be very careful with the ordering of cleanups here:
1119   //   C++ [except.throw]p4:
1120   //     The destruction [of the exception temporary] occurs
1121   //     immediately after the destruction of the object declared in
1122   //     the exception-declaration in the handler.
1123   //
1124   // So the precise ordering is:
1125   //   1.  Construct catch variable.
1126   //   2.  __cxa_begin_catch
1127   //   3.  Enter __cxa_end_catch cleanup
1128   //   4.  Enter dtor cleanup
1129   //
1130   // We do this by using a slightly abnormal initialization process.
1131   // Delegation sequence:
1132   //   - ExitCXXTryStmt opens a RunCleanupsScope
1133   //     - EmitAutoVarAlloca creates the variable and debug info
1134   //       - InitCatchParam initializes the variable from the exception
1135   //       - CallBeginCatch calls __cxa_begin_catch
1136   //       - CallBeginCatch enters the __cxa_end_catch cleanup
1137   //     - EmitAutoVarCleanups enters the variable destructor cleanup
1138   //   - EmitCXXTryStmt emits the code for the catch body
1139   //   - EmitCXXTryStmt close the RunCleanupsScope
1140 
1141   VarDecl *CatchParam = S->getExceptionDecl();
1142   if (!CatchParam) {
1143     llvm::Value *Exn = CGF.getExceptionFromSlot();
1144     CallBeginCatch(CGF, Exn, true);
1145     return;
1146   }
1147 
1148   // Emit the local.
1149   CodeGenFunction::AutoVarEmission var = CGF.EmitAutoVarAlloca(*CatchParam);
1150   InitCatchParam(CGF, *CatchParam, var.getObjectAddress(CGF), S->getLocStart());
1151   CGF.EmitAutoVarCleanups(var);
1152 }
1153 
1154 /// Emit the structure of the dispatch block for the given catch scope.
1155 /// It is an invariant that the dispatch block already exists.
1156 static void emitCatchDispatchBlock(CodeGenFunction &CGF,
1157                                    EHCatchScope &catchScope) {
1158   llvm::BasicBlock *dispatchBlock = catchScope.getCachedEHDispatchBlock();
1159   assert(dispatchBlock);
1160 
1161   // If there's only a single catch-all, getEHDispatchBlock returned
1162   // that catch-all as the dispatch block.
1163   if (catchScope.getNumHandlers() == 1 &&
1164       catchScope.getHandler(0).isCatchAll()) {
1165     assert(dispatchBlock == catchScope.getHandler(0).Block);
1166     return;
1167   }
1168 
1169   CGBuilderTy::InsertPoint savedIP = CGF.Builder.saveIP();
1170   CGF.EmitBlockAfterUses(dispatchBlock);
1171 
1172   // Select the right handler.
1173   llvm::Value *llvm_eh_typeid_for =
1174     CGF.CGM.getIntrinsic(llvm::Intrinsic::eh_typeid_for);
1175 
1176   // Load the selector value.
1177   llvm::Value *selector = CGF.getSelectorFromSlot();
1178 
1179   // Test against each of the exception types we claim to catch.
1180   for (unsigned i = 0, e = catchScope.getNumHandlers(); ; ++i) {
1181     assert(i < e && "ran off end of handlers!");
1182     const EHCatchScope::Handler &handler = catchScope.getHandler(i);
1183 
1184     llvm::Value *typeValue = handler.Type;
1185     assert(typeValue && "fell into catch-all case!");
1186     typeValue = CGF.Builder.CreateBitCast(typeValue, CGF.Int8PtrTy);
1187 
1188     // Figure out the next block.
1189     bool nextIsEnd;
1190     llvm::BasicBlock *nextBlock;
1191 
1192     // If this is the last handler, we're at the end, and the next
1193     // block is the block for the enclosing EH scope.
1194     if (i + 1 == e) {
1195       nextBlock = CGF.getEHDispatchBlock(catchScope.getEnclosingEHScope());
1196       nextIsEnd = true;
1197 
1198     // If the next handler is a catch-all, we're at the end, and the
1199     // next block is that handler.
1200     } else if (catchScope.getHandler(i+1).isCatchAll()) {
1201       nextBlock = catchScope.getHandler(i+1).Block;
1202       nextIsEnd = true;
1203 
1204     // Otherwise, we're not at the end and we need a new block.
1205     } else {
1206       nextBlock = CGF.createBasicBlock("catch.fallthrough");
1207       nextIsEnd = false;
1208     }
1209 
1210     // Figure out the catch type's index in the LSDA's type table.
1211     llvm::CallInst *typeIndex =
1212       CGF.Builder.CreateCall(llvm_eh_typeid_for, typeValue);
1213     typeIndex->setDoesNotThrow();
1214 
1215     llvm::Value *matchesTypeIndex =
1216       CGF.Builder.CreateICmpEQ(selector, typeIndex, "matches");
1217     CGF.Builder.CreateCondBr(matchesTypeIndex, handler.Block, nextBlock);
1218 
1219     // If the next handler is a catch-all, we're completely done.
1220     if (nextIsEnd) {
1221       CGF.Builder.restoreIP(savedIP);
1222       return;
1223     }
1224     // Otherwise we need to emit and continue at that block.
1225     CGF.EmitBlock(nextBlock);
1226   }
1227 }
1228 
1229 void CodeGenFunction::popCatchScope() {
1230   EHCatchScope &catchScope = cast<EHCatchScope>(*EHStack.begin());
1231   if (catchScope.hasEHBranches())
1232     emitCatchDispatchBlock(*this, catchScope);
1233   EHStack.popCatch();
1234 }
1235 
1236 void CodeGenFunction::ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock) {
1237   unsigned NumHandlers = S.getNumHandlers();
1238   EHCatchScope &CatchScope = cast<EHCatchScope>(*EHStack.begin());
1239   assert(CatchScope.getNumHandlers() == NumHandlers);
1240 
1241   // If the catch was not required, bail out now.
1242   if (!CatchScope.hasEHBranches()) {
1243     CatchScope.clearHandlerBlocks();
1244     EHStack.popCatch();
1245     return;
1246   }
1247 
1248   // Emit the structure of the EH dispatch for this catch.
1249   emitCatchDispatchBlock(*this, CatchScope);
1250 
1251   // Copy the handler blocks off before we pop the EH stack.  Emitting
1252   // the handlers might scribble on this memory.
1253   SmallVector<EHCatchScope::Handler, 8> Handlers(NumHandlers);
1254   memcpy(Handlers.data(), CatchScope.begin(),
1255          NumHandlers * sizeof(EHCatchScope::Handler));
1256 
1257   EHStack.popCatch();
1258 
1259   // The fall-through block.
1260   llvm::BasicBlock *ContBB = createBasicBlock("try.cont");
1261 
1262   // We just emitted the body of the try; jump to the continue block.
1263   if (HaveInsertPoint())
1264     Builder.CreateBr(ContBB);
1265 
1266   // Determine if we need an implicit rethrow for all these catch handlers;
1267   // see the comment below.
1268   bool doImplicitRethrow = false;
1269   if (IsFnTryBlock)
1270     doImplicitRethrow = isa<CXXDestructorDecl>(CurCodeDecl) ||
1271                         isa<CXXConstructorDecl>(CurCodeDecl);
1272 
1273   // Perversely, we emit the handlers backwards precisely because we
1274   // want them to appear in source order.  In all of these cases, the
1275   // catch block will have exactly one predecessor, which will be a
1276   // particular block in the catch dispatch.  However, in the case of
1277   // a catch-all, one of the dispatch blocks will branch to two
1278   // different handlers, and EmitBlockAfterUses will cause the second
1279   // handler to be moved before the first.
1280   for (unsigned I = NumHandlers; I != 0; --I) {
1281     llvm::BasicBlock *CatchBlock = Handlers[I-1].Block;
1282     EmitBlockAfterUses(CatchBlock);
1283 
1284     // Catch the exception if this isn't a catch-all.
1285     const CXXCatchStmt *C = S.getHandler(I-1);
1286 
1287     // Enter a cleanup scope, including the catch variable and the
1288     // end-catch.
1289     RunCleanupsScope CatchScope(*this);
1290 
1291     // Initialize the catch variable and set up the cleanups.
1292     BeginCatch(*this, C);
1293 
1294     // Emit the PGO counter increment.
1295     RegionCounter CatchCnt = getPGORegionCounter(C);
1296     CatchCnt.beginRegion(Builder);
1297 
1298     // Perform the body of the catch.
1299     EmitStmt(C->getHandlerBlock());
1300 
1301     // [except.handle]p11:
1302     //   The currently handled exception is rethrown if control
1303     //   reaches the end of a handler of the function-try-block of a
1304     //   constructor or destructor.
1305 
1306     // It is important that we only do this on fallthrough and not on
1307     // return.  Note that it's illegal to put a return in a
1308     // constructor function-try-block's catch handler (p14), so this
1309     // really only applies to destructors.
1310     if (doImplicitRethrow && HaveInsertPoint()) {
1311       EmitRuntimeCallOrInvoke(getReThrowFn(CGM));
1312       Builder.CreateUnreachable();
1313       Builder.ClearInsertionPoint();
1314     }
1315 
1316     // Fall out through the catch cleanups.
1317     CatchScope.ForceCleanup();
1318 
1319     // Branch out of the try.
1320     if (HaveInsertPoint())
1321       Builder.CreateBr(ContBB);
1322   }
1323 
1324   RegionCounter ContCnt = getPGORegionCounter(&S);
1325   EmitBlock(ContBB);
1326   ContCnt.beginRegion(Builder);
1327 }
1328 
1329 namespace {
1330   struct CallEndCatchForFinally : EHScopeStack::Cleanup {
1331     llvm::Value *ForEHVar;
1332     llvm::Value *EndCatchFn;
1333     CallEndCatchForFinally(llvm::Value *ForEHVar, llvm::Value *EndCatchFn)
1334       : ForEHVar(ForEHVar), EndCatchFn(EndCatchFn) {}
1335 
1336     void Emit(CodeGenFunction &CGF, Flags flags) {
1337       llvm::BasicBlock *EndCatchBB = CGF.createBasicBlock("finally.endcatch");
1338       llvm::BasicBlock *CleanupContBB =
1339         CGF.createBasicBlock("finally.cleanup.cont");
1340 
1341       llvm::Value *ShouldEndCatch =
1342         CGF.Builder.CreateLoad(ForEHVar, "finally.endcatch");
1343       CGF.Builder.CreateCondBr(ShouldEndCatch, EndCatchBB, CleanupContBB);
1344       CGF.EmitBlock(EndCatchBB);
1345       CGF.EmitRuntimeCallOrInvoke(EndCatchFn); // catch-all, so might throw
1346       CGF.EmitBlock(CleanupContBB);
1347     }
1348   };
1349 
1350   struct PerformFinally : EHScopeStack::Cleanup {
1351     const Stmt *Body;
1352     llvm::Value *ForEHVar;
1353     llvm::Value *EndCatchFn;
1354     llvm::Value *RethrowFn;
1355     llvm::Value *SavedExnVar;
1356 
1357     PerformFinally(const Stmt *Body, llvm::Value *ForEHVar,
1358                    llvm::Value *EndCatchFn,
1359                    llvm::Value *RethrowFn, llvm::Value *SavedExnVar)
1360       : Body(Body), ForEHVar(ForEHVar), EndCatchFn(EndCatchFn),
1361         RethrowFn(RethrowFn), SavedExnVar(SavedExnVar) {}
1362 
1363     void Emit(CodeGenFunction &CGF, Flags flags) {
1364       // Enter a cleanup to call the end-catch function if one was provided.
1365       if (EndCatchFn)
1366         CGF.EHStack.pushCleanup<CallEndCatchForFinally>(NormalAndEHCleanup,
1367                                                         ForEHVar, EndCatchFn);
1368 
1369       // Save the current cleanup destination in case there are
1370       // cleanups in the finally block.
1371       llvm::Value *SavedCleanupDest =
1372         CGF.Builder.CreateLoad(CGF.getNormalCleanupDestSlot(),
1373                                "cleanup.dest.saved");
1374 
1375       // Emit the finally block.
1376       CGF.EmitStmt(Body);
1377 
1378       // If the end of the finally is reachable, check whether this was
1379       // for EH.  If so, rethrow.
1380       if (CGF.HaveInsertPoint()) {
1381         llvm::BasicBlock *RethrowBB = CGF.createBasicBlock("finally.rethrow");
1382         llvm::BasicBlock *ContBB = CGF.createBasicBlock("finally.cont");
1383 
1384         llvm::Value *ShouldRethrow =
1385           CGF.Builder.CreateLoad(ForEHVar, "finally.shouldthrow");
1386         CGF.Builder.CreateCondBr(ShouldRethrow, RethrowBB, ContBB);
1387 
1388         CGF.EmitBlock(RethrowBB);
1389         if (SavedExnVar) {
1390           CGF.EmitRuntimeCallOrInvoke(RethrowFn,
1391                                       CGF.Builder.CreateLoad(SavedExnVar));
1392         } else {
1393           CGF.EmitRuntimeCallOrInvoke(RethrowFn);
1394         }
1395         CGF.Builder.CreateUnreachable();
1396 
1397         CGF.EmitBlock(ContBB);
1398 
1399         // Restore the cleanup destination.
1400         CGF.Builder.CreateStore(SavedCleanupDest,
1401                                 CGF.getNormalCleanupDestSlot());
1402       }
1403 
1404       // Leave the end-catch cleanup.  As an optimization, pretend that
1405       // the fallthrough path was inaccessible; we've dynamically proven
1406       // that we're not in the EH case along that path.
1407       if (EndCatchFn) {
1408         CGBuilderTy::InsertPoint SavedIP = CGF.Builder.saveAndClearIP();
1409         CGF.PopCleanupBlock();
1410         CGF.Builder.restoreIP(SavedIP);
1411       }
1412 
1413       // Now make sure we actually have an insertion point or the
1414       // cleanup gods will hate us.
1415       CGF.EnsureInsertPoint();
1416     }
1417   };
1418 }
1419 
1420 /// Enters a finally block for an implementation using zero-cost
1421 /// exceptions.  This is mostly general, but hard-codes some
1422 /// language/ABI-specific behavior in the catch-all sections.
1423 void CodeGenFunction::FinallyInfo::enter(CodeGenFunction &CGF,
1424                                          const Stmt *body,
1425                                          llvm::Constant *beginCatchFn,
1426                                          llvm::Constant *endCatchFn,
1427                                          llvm::Constant *rethrowFn) {
1428   assert((beginCatchFn != 0) == (endCatchFn != 0) &&
1429          "begin/end catch functions not paired");
1430   assert(rethrowFn && "rethrow function is required");
1431 
1432   BeginCatchFn = beginCatchFn;
1433 
1434   // The rethrow function has one of the following two types:
1435   //   void (*)()
1436   //   void (*)(void*)
1437   // In the latter case we need to pass it the exception object.
1438   // But we can't use the exception slot because the @finally might
1439   // have a landing pad (which would overwrite the exception slot).
1440   llvm::FunctionType *rethrowFnTy =
1441     cast<llvm::FunctionType>(
1442       cast<llvm::PointerType>(rethrowFn->getType())->getElementType());
1443   SavedExnVar = 0;
1444   if (rethrowFnTy->getNumParams())
1445     SavedExnVar = CGF.CreateTempAlloca(CGF.Int8PtrTy, "finally.exn");
1446 
1447   // A finally block is a statement which must be executed on any edge
1448   // out of a given scope.  Unlike a cleanup, the finally block may
1449   // contain arbitrary control flow leading out of itself.  In
1450   // addition, finally blocks should always be executed, even if there
1451   // are no catch handlers higher on the stack.  Therefore, we
1452   // surround the protected scope with a combination of a normal
1453   // cleanup (to catch attempts to break out of the block via normal
1454   // control flow) and an EH catch-all (semantically "outside" any try
1455   // statement to which the finally block might have been attached).
1456   // The finally block itself is generated in the context of a cleanup
1457   // which conditionally leaves the catch-all.
1458 
1459   // Jump destination for performing the finally block on an exception
1460   // edge.  We'll never actually reach this block, so unreachable is
1461   // fine.
1462   RethrowDest = CGF.getJumpDestInCurrentScope(CGF.getUnreachableBlock());
1463 
1464   // Whether the finally block is being executed for EH purposes.
1465   ForEHVar = CGF.CreateTempAlloca(CGF.Builder.getInt1Ty(), "finally.for-eh");
1466   CGF.Builder.CreateStore(CGF.Builder.getFalse(), ForEHVar);
1467 
1468   // Enter a normal cleanup which will perform the @finally block.
1469   CGF.EHStack.pushCleanup<PerformFinally>(NormalCleanup, body,
1470                                           ForEHVar, endCatchFn,
1471                                           rethrowFn, SavedExnVar);
1472 
1473   // Enter a catch-all scope.
1474   llvm::BasicBlock *catchBB = CGF.createBasicBlock("finally.catchall");
1475   EHCatchScope *catchScope = CGF.EHStack.pushCatch(1);
1476   catchScope->setCatchAllHandler(0, catchBB);
1477 }
1478 
1479 void CodeGenFunction::FinallyInfo::exit(CodeGenFunction &CGF) {
1480   // Leave the finally catch-all.
1481   EHCatchScope &catchScope = cast<EHCatchScope>(*CGF.EHStack.begin());
1482   llvm::BasicBlock *catchBB = catchScope.getHandler(0).Block;
1483 
1484   CGF.popCatchScope();
1485 
1486   // If there are any references to the catch-all block, emit it.
1487   if (catchBB->use_empty()) {
1488     delete catchBB;
1489   } else {
1490     CGBuilderTy::InsertPoint savedIP = CGF.Builder.saveAndClearIP();
1491     CGF.EmitBlock(catchBB);
1492 
1493     llvm::Value *exn = 0;
1494 
1495     // If there's a begin-catch function, call it.
1496     if (BeginCatchFn) {
1497       exn = CGF.getExceptionFromSlot();
1498       CGF.EmitNounwindRuntimeCall(BeginCatchFn, exn);
1499     }
1500 
1501     // If we need to remember the exception pointer to rethrow later, do so.
1502     if (SavedExnVar) {
1503       if (!exn) exn = CGF.getExceptionFromSlot();
1504       CGF.Builder.CreateStore(exn, SavedExnVar);
1505     }
1506 
1507     // Tell the cleanups in the finally block that we're do this for EH.
1508     CGF.Builder.CreateStore(CGF.Builder.getTrue(), ForEHVar);
1509 
1510     // Thread a jump through the finally cleanup.
1511     CGF.EmitBranchThroughCleanup(RethrowDest);
1512 
1513     CGF.Builder.restoreIP(savedIP);
1514   }
1515 
1516   // Finally, leave the @finally cleanup.
1517   CGF.PopCleanupBlock();
1518 }
1519 
1520 /// In a terminate landing pad, should we use __clang__call_terminate
1521 /// or just a naked call to std::terminate?
1522 ///
1523 /// __clang_call_terminate calls __cxa_begin_catch, which then allows
1524 /// std::terminate to usefully report something about the
1525 /// violating exception.
1526 static bool useClangCallTerminate(CodeGenModule &CGM) {
1527   // Only do this for Itanium-family ABIs in C++ mode.
1528   return (CGM.getLangOpts().CPlusPlus &&
1529           CGM.getTarget().getCXXABI().isItaniumFamily());
1530 }
1531 
1532 /// Get or define the following function:
1533 ///   void @__clang_call_terminate(i8* %exn) nounwind noreturn
1534 /// This code is used only in C++.
1535 static llvm::Constant *getClangCallTerminateFn(CodeGenModule &CGM) {
1536   llvm::FunctionType *fnTy =
1537     llvm::FunctionType::get(CGM.VoidTy, CGM.Int8PtrTy, /*IsVarArgs=*/false);
1538   llvm::Constant *fnRef =
1539     CGM.CreateRuntimeFunction(fnTy, "__clang_call_terminate");
1540 
1541   llvm::Function *fn = dyn_cast<llvm::Function>(fnRef);
1542   if (fn && fn->empty()) {
1543     fn->setDoesNotThrow();
1544     fn->setDoesNotReturn();
1545 
1546     // What we really want is to massively penalize inlining without
1547     // forbidding it completely.  The difference between that and
1548     // 'noinline' is negligible.
1549     fn->addFnAttr(llvm::Attribute::NoInline);
1550 
1551     // Allow this function to be shared across translation units, but
1552     // we don't want it to turn into an exported symbol.
1553     fn->setLinkage(llvm::Function::LinkOnceODRLinkage);
1554     fn->setVisibility(llvm::Function::HiddenVisibility);
1555 
1556     // Set up the function.
1557     llvm::BasicBlock *entry =
1558       llvm::BasicBlock::Create(CGM.getLLVMContext(), "", fn);
1559     CGBuilderTy builder(entry);
1560 
1561     // Pull the exception pointer out of the parameter list.
1562     llvm::Value *exn = &*fn->arg_begin();
1563 
1564     // Call __cxa_begin_catch(exn).
1565     llvm::CallInst *catchCall = builder.CreateCall(getBeginCatchFn(CGM), exn);
1566     catchCall->setDoesNotThrow();
1567     catchCall->setCallingConv(CGM.getRuntimeCC());
1568 
1569     // Call std::terminate().
1570     llvm::CallInst *termCall = builder.CreateCall(getTerminateFn(CGM));
1571     termCall->setDoesNotThrow();
1572     termCall->setDoesNotReturn();
1573     termCall->setCallingConv(CGM.getRuntimeCC());
1574 
1575     // std::terminate cannot return.
1576     builder.CreateUnreachable();
1577   }
1578 
1579   return fnRef;
1580 }
1581 
1582 llvm::BasicBlock *CodeGenFunction::getTerminateLandingPad() {
1583   if (TerminateLandingPad)
1584     return TerminateLandingPad;
1585 
1586   CGBuilderTy::InsertPoint SavedIP = Builder.saveAndClearIP();
1587 
1588   // This will get inserted at the end of the function.
1589   TerminateLandingPad = createBasicBlock("terminate.lpad");
1590   Builder.SetInsertPoint(TerminateLandingPad);
1591 
1592   // Tell the backend that this is a landing pad.
1593   const EHPersonality &Personality = EHPersonality::get(CGM.getLangOpts());
1594   llvm::LandingPadInst *LPadInst =
1595     Builder.CreateLandingPad(llvm::StructType::get(Int8PtrTy, Int32Ty, NULL),
1596                              getOpaquePersonalityFn(CGM, Personality), 0);
1597   LPadInst->addClause(getCatchAllValue(*this));
1598 
1599   llvm::CallInst *terminateCall;
1600   if (useClangCallTerminate(CGM)) {
1601     // Extract out the exception pointer.
1602     llvm::Value *exn = Builder.CreateExtractValue(LPadInst, 0);
1603     terminateCall = EmitNounwindRuntimeCall(getClangCallTerminateFn(CGM), exn);
1604   } else {
1605     terminateCall = EmitNounwindRuntimeCall(getTerminateFn(CGM));
1606   }
1607   terminateCall->setDoesNotReturn();
1608   Builder.CreateUnreachable();
1609 
1610   // Restore the saved insertion state.
1611   Builder.restoreIP(SavedIP);
1612 
1613   return TerminateLandingPad;
1614 }
1615 
1616 llvm::BasicBlock *CodeGenFunction::getTerminateHandler() {
1617   if (TerminateHandler)
1618     return TerminateHandler;
1619 
1620   CGBuilderTy::InsertPoint SavedIP = Builder.saveAndClearIP();
1621 
1622   // Set up the terminate handler.  This block is inserted at the very
1623   // end of the function by FinishFunction.
1624   TerminateHandler = createBasicBlock("terminate.handler");
1625   Builder.SetInsertPoint(TerminateHandler);
1626   llvm::CallInst *terminateCall;
1627   if (useClangCallTerminate(CGM)) {
1628     // Load the exception pointer.
1629     llvm::Value *exn = getExceptionFromSlot();
1630     terminateCall = EmitNounwindRuntimeCall(getClangCallTerminateFn(CGM), exn);
1631   } else {
1632     terminateCall = EmitNounwindRuntimeCall(getTerminateFn(CGM));
1633   }
1634   terminateCall->setDoesNotReturn();
1635   Builder.CreateUnreachable();
1636 
1637   // Restore the saved insertion state.
1638   Builder.restoreIP(SavedIP);
1639 
1640   return TerminateHandler;
1641 }
1642 
1643 llvm::BasicBlock *CodeGenFunction::getEHResumeBlock(bool isCleanup) {
1644   if (EHResumeBlock) return EHResumeBlock;
1645 
1646   CGBuilderTy::InsertPoint SavedIP = Builder.saveIP();
1647 
1648   // We emit a jump to a notional label at the outermost unwind state.
1649   EHResumeBlock = createBasicBlock("eh.resume");
1650   Builder.SetInsertPoint(EHResumeBlock);
1651 
1652   const EHPersonality &Personality = EHPersonality::get(CGM.getLangOpts());
1653 
1654   // This can always be a call because we necessarily didn't find
1655   // anything on the EH stack which needs our help.
1656   const char *RethrowName = Personality.CatchallRethrowFn;
1657   if (RethrowName != 0 && !isCleanup) {
1658     EmitRuntimeCall(getCatchallRethrowFn(CGM, RethrowName),
1659                       getExceptionFromSlot())
1660       ->setDoesNotReturn();
1661   } else {
1662     switch (CleanupHackLevel) {
1663     case CHL_MandatoryCatchall:
1664       // In mandatory-catchall mode, we need to use
1665       // _Unwind_Resume_or_Rethrow, or whatever the personality's
1666       // equivalent is.
1667       EmitRuntimeCall(getUnwindResumeOrRethrowFn(),
1668                         getExceptionFromSlot())
1669         ->setDoesNotReturn();
1670       break;
1671     case CHL_MandatoryCleanup: {
1672       // In mandatory-cleanup mode, we should use 'resume'.
1673 
1674       // Recreate the landingpad's return value for the 'resume' instruction.
1675       llvm::Value *Exn = getExceptionFromSlot();
1676       llvm::Value *Sel = getSelectorFromSlot();
1677 
1678       llvm::Type *LPadType = llvm::StructType::get(Exn->getType(),
1679                                                    Sel->getType(), NULL);
1680       llvm::Value *LPadVal = llvm::UndefValue::get(LPadType);
1681       LPadVal = Builder.CreateInsertValue(LPadVal, Exn, 0, "lpad.val");
1682       LPadVal = Builder.CreateInsertValue(LPadVal, Sel, 1, "lpad.val");
1683 
1684       Builder.CreateResume(LPadVal);
1685       Builder.restoreIP(SavedIP);
1686       return EHResumeBlock;
1687     }
1688     case CHL_Ideal:
1689       // In an idealized mode where we don't have to worry about the
1690       // optimizer combining landing pads, we should just use
1691       // _Unwind_Resume (or the personality's equivalent).
1692       EmitRuntimeCall(getUnwindResumeFn(), getExceptionFromSlot())
1693         ->setDoesNotReturn();
1694       break;
1695     }
1696   }
1697 
1698   Builder.CreateUnreachable();
1699 
1700   Builder.restoreIP(SavedIP);
1701 
1702   return EHResumeBlock;
1703 }
1704 
1705 void CodeGenFunction::EmitSEHTryStmt(const SEHTryStmt &S) {
1706   CGM.ErrorUnsupported(&S, "SEH __try");
1707 }
1708