clang  9.0.0svn
CGException.cpp
Go to the documentation of this file.
1 //===--- CGException.cpp - Emit LLVM Code for C++ exceptions ----*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This contains code dealing with C++ exception related code generation.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #include "CodeGenFunction.h"
14 #include "CGCXXABI.h"
15 #include "CGCleanup.h"
16 #include "CGObjCRuntime.h"
17 #include "ConstantEmitter.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"
24 #include "llvm/IR/Intrinsics.h"
25 #include "llvm/IR/IntrinsicInst.h"
26 #include "llvm/Support/SaveAndRestore.h"
27 
28 using namespace clang;
29 using namespace CodeGen;
30 
31 static llvm::FunctionCallee getFreeExceptionFn(CodeGenModule &CGM) {
32  // void __cxa_free_exception(void *thrown_exception);
33 
34  llvm::FunctionType *FTy =
35  llvm::FunctionType::get(CGM.VoidTy, CGM.Int8PtrTy, /*IsVarArgs=*/false);
36 
37  return CGM.CreateRuntimeFunction(FTy, "__cxa_free_exception");
38 }
39 
40 static llvm::FunctionCallee getUnexpectedFn(CodeGenModule &CGM) {
41  // void __cxa_call_unexpected(void *thrown_exception);
42 
43  llvm::FunctionType *FTy =
44  llvm::FunctionType::get(CGM.VoidTy, CGM.Int8PtrTy, /*IsVarArgs=*/false);
45 
46  return CGM.CreateRuntimeFunction(FTy, "__cxa_call_unexpected");
47 }
48 
49 llvm::FunctionCallee CodeGenModule::getTerminateFn() {
50  // void __terminate();
51 
52  llvm::FunctionType *FTy =
53  llvm::FunctionType::get(VoidTy, /*IsVarArgs=*/false);
54 
55  StringRef name;
56 
57  // In C++, use std::terminate().
58  if (getLangOpts().CPlusPlus &&
59  getTarget().getCXXABI().isItaniumFamily()) {
60  name = "_ZSt9terminatev";
61  } else if (getLangOpts().CPlusPlus &&
62  getTarget().getCXXABI().isMicrosoft()) {
63  if (getLangOpts().isCompatibleWithMSVC(LangOptions::MSVC2015))
64  name = "__std_terminate";
65  else
66  name = "?terminate@@YAXXZ";
67  } else if (getLangOpts().ObjC &&
69  name = "objc_terminate";
70  else
71  name = "abort";
72  return CreateRuntimeFunction(FTy, name);
73 }
74 
75 static llvm::FunctionCallee getCatchallRethrowFn(CodeGenModule &CGM,
76  StringRef Name) {
77  llvm::FunctionType *FTy =
78  llvm::FunctionType::get(CGM.VoidTy, CGM.Int8PtrTy, /*IsVarArgs=*/false);
79 
80  return CGM.CreateRuntimeFunction(FTy, Name);
81 }
82 
83 const EHPersonality EHPersonality::GNU_C = { "__gcc_personality_v0", nullptr };
84 const EHPersonality
85 EHPersonality::GNU_C_SJLJ = { "__gcc_personality_sj0", nullptr };
86 const EHPersonality
87 EHPersonality::GNU_C_SEH = { "__gcc_personality_seh0", nullptr };
88 const EHPersonality
89 EHPersonality::NeXT_ObjC = { "__objc_personality_v0", nullptr };
90 const EHPersonality
91 EHPersonality::GNU_CPlusPlus = { "__gxx_personality_v0", nullptr };
92 const EHPersonality
93 EHPersonality::GNU_CPlusPlus_SJLJ = { "__gxx_personality_sj0", nullptr };
94 const EHPersonality
95 EHPersonality::GNU_CPlusPlus_SEH = { "__gxx_personality_seh0", nullptr };
96 const EHPersonality
97 EHPersonality::GNU_ObjC = {"__gnu_objc_personality_v0", "objc_exception_throw"};
98 const EHPersonality
99 EHPersonality::GNU_ObjC_SJLJ = {"__gnu_objc_personality_sj0", "objc_exception_throw"};
100 const EHPersonality
101 EHPersonality::GNU_ObjC_SEH = {"__gnu_objc_personality_seh0", "objc_exception_throw"};
102 const EHPersonality
103 EHPersonality::GNU_ObjCXX = { "__gnustep_objcxx_personality_v0", nullptr };
104 const EHPersonality
105 EHPersonality::GNUstep_ObjC = { "__gnustep_objc_personality_v0", nullptr };
106 const EHPersonality
107 EHPersonality::MSVC_except_handler = { "_except_handler3", nullptr };
108 const EHPersonality
109 EHPersonality::MSVC_C_specific_handler = { "__C_specific_handler", nullptr };
110 const EHPersonality
111 EHPersonality::MSVC_CxxFrameHandler3 = { "__CxxFrameHandler3", nullptr };
112 const EHPersonality
113 EHPersonality::GNU_Wasm_CPlusPlus = { "__gxx_wasm_personality_v0", nullptr };
114 
115 static const EHPersonality &getCPersonality(const TargetInfo &Target,
116  const LangOptions &L) {
117  const llvm::Triple &T = Target.getTriple();
118  if (T.isWindowsMSVCEnvironment())
119  return EHPersonality::MSVC_CxxFrameHandler3;
120  if (L.SjLjExceptions)
122  if (L.DWARFExceptions)
123  return EHPersonality::GNU_C;
124  if (L.SEHExceptions)
126  return EHPersonality::GNU_C;
127 }
128 
129 static const EHPersonality &getObjCPersonality(const TargetInfo &Target,
130  const LangOptions &L) {
131  const llvm::Triple &T = Target.getTriple();
132  if (T.isWindowsMSVCEnvironment())
133  return EHPersonality::MSVC_CxxFrameHandler3;
134 
135  switch (L.ObjCRuntime.getKind()) {
137  return getCPersonality(Target, L);
138  case ObjCRuntime::MacOSX:
139  case ObjCRuntime::iOS:
143  if (L.ObjCRuntime.getVersion() >= VersionTuple(1, 7))
144  return EHPersonality::GNUstep_ObjC;
145  LLVM_FALLTHROUGH;
146  case ObjCRuntime::GCC:
147  case ObjCRuntime::ObjFW:
148  if (L.SjLjExceptions)
150  if (L.SEHExceptions)
153  }
154  llvm_unreachable("bad runtime kind");
155 }
156 
157 static const EHPersonality &getCXXPersonality(const TargetInfo &Target,
158  const LangOptions &L) {
159  const llvm::Triple &T = Target.getTriple();
160  if (T.isWindowsMSVCEnvironment())
161  return EHPersonality::MSVC_CxxFrameHandler3;
162  if (L.SjLjExceptions)
164  if (L.DWARFExceptions)
166  if (L.SEHExceptions)
168  // Wasm EH is a non-MVP feature for now.
169  if (Target.hasFeature("exception-handling") &&
170  (T.getArch() == llvm::Triple::wasm32 ||
171  T.getArch() == llvm::Triple::wasm64))
174 }
175 
176 /// Determines the personality function to use when both C++
177 /// and Objective-C exceptions are being caught.
178 static const EHPersonality &getObjCXXPersonality(const TargetInfo &Target,
179  const LangOptions &L) {
180  if (Target.getTriple().isWindowsMSVCEnvironment())
181  return EHPersonality::MSVC_CxxFrameHandler3;
182 
183  switch (L.ObjCRuntime.getKind()) {
184  // In the fragile ABI, just use C++ exception handling and hope
185  // they're not doing crazy exception mixing.
187  return getCXXPersonality(Target, L);
188 
189  // The ObjC personality defers to the C++ personality for non-ObjC
190  // handlers. Unlike the C++ case, we use the same personality
191  // function on targets using (backend-driven) SJLJ EH.
192  case ObjCRuntime::MacOSX:
193  case ObjCRuntime::iOS:
195  return getObjCPersonality(Target, L);
196 
199 
200  // The GCC runtime's personality function inherently doesn't support
201  // mixed EH. Use the ObjC personality just to avoid returning null.
202  case ObjCRuntime::GCC:
203  case ObjCRuntime::ObjFW:
204  return getObjCPersonality(Target, L);
205  }
206  llvm_unreachable("bad runtime kind");
207 }
208 
209 static const EHPersonality &getSEHPersonalityMSVC(const llvm::Triple &T) {
210  if (T.getArch() == llvm::Triple::x86)
211  return EHPersonality::MSVC_except_handler;
213 }
214 
216  const FunctionDecl *FD) {
217  const llvm::Triple &T = CGM.getTarget().getTriple();
218  const LangOptions &L = CGM.getLangOpts();
219  const TargetInfo &Target = CGM.getTarget();
220 
221  // Functions using SEH get an SEH personality.
222  if (FD && FD->usesSEHTry())
223  return getSEHPersonalityMSVC(T);
224 
225  if (L.ObjC)
226  return L.CPlusPlus ? getObjCXXPersonality(Target, L)
227  : getObjCPersonality(Target, L);
228  return L.CPlusPlus ? getCXXPersonality(Target, L)
229  : getCPersonality(Target, L);
230 }
231 
233  const auto *FD = CGF.CurCodeDecl;
234  // For outlined finallys and filters, use the SEH personality in case they
235  // contain more SEH. This mostly only affects finallys. Filters could
236  // hypothetically use gnu statement expressions to sneak in nested SEH.
237  FD = FD ? FD : CGF.CurSEHParent;
238  return get(CGF.CGM, dyn_cast_or_null<FunctionDecl>(FD));
239 }
240 
241 static llvm::FunctionCallee getPersonalityFn(CodeGenModule &CGM,
242  const EHPersonality &Personality) {
243  return CGM.CreateRuntimeFunction(llvm::FunctionType::get(CGM.Int32Ty, true),
244  Personality.PersonalityFn,
245  llvm::AttributeList(), /*Local=*/true);
246 }
247 
248 static llvm::Constant *getOpaquePersonalityFn(CodeGenModule &CGM,
249  const EHPersonality &Personality) {
250  llvm::FunctionCallee Fn = getPersonalityFn(CGM, Personality);
251  llvm::PointerType* Int8PtrTy = llvm::PointerType::get(
252  llvm::Type::getInt8Ty(CGM.getLLVMContext()),
253  CGM.getDataLayout().getProgramAddressSpace());
254 
255  return llvm::ConstantExpr::getBitCast(cast<llvm::Constant>(Fn.getCallee()),
256  Int8PtrTy);
257 }
258 
259 /// Check whether a landingpad instruction only uses C++ features.
260 static bool LandingPadHasOnlyCXXUses(llvm::LandingPadInst *LPI) {
261  for (unsigned I = 0, E = LPI->getNumClauses(); I != E; ++I) {
262  // Look for something that would've been returned by the ObjC
263  // runtime's GetEHType() method.
264  llvm::Value *Val = LPI->getClause(I)->stripPointerCasts();
265  if (LPI->isCatch(I)) {
266  // Check if the catch value has the ObjC prefix.
267  if (llvm::GlobalVariable *GV = dyn_cast<llvm::GlobalVariable>(Val))
268  // ObjC EH selector entries are always global variables with
269  // names starting like this.
270  if (GV->getName().startswith("OBJC_EHTYPE"))
271  return false;
272  } else {
273  // Check if any of the filter values have the ObjC prefix.
274  llvm::Constant *CVal = cast<llvm::Constant>(Val);
275  for (llvm::User::op_iterator
276  II = CVal->op_begin(), IE = CVal->op_end(); II != IE; ++II) {
277  if (llvm::GlobalVariable *GV =
278  cast<llvm::GlobalVariable>((*II)->stripPointerCasts()))
279  // ObjC EH selector entries are always global variables with
280  // names starting like this.
281  if (GV->getName().startswith("OBJC_EHTYPE"))
282  return false;
283  }
284  }
285  }
286  return true;
287 }
288 
289 /// Check whether a personality function could reasonably be swapped
290 /// for a C++ personality function.
291 static bool PersonalityHasOnlyCXXUses(llvm::Constant *Fn) {
292  for (llvm::User *U : Fn->users()) {
293  // Conditionally white-list bitcasts.
294  if (llvm::ConstantExpr *CE = dyn_cast<llvm::ConstantExpr>(U)) {
295  if (CE->getOpcode() != llvm::Instruction::BitCast) return false;
296  if (!PersonalityHasOnlyCXXUses(CE))
297  return false;
298  continue;
299  }
300 
301  // Otherwise it must be a function.
302  llvm::Function *F = dyn_cast<llvm::Function>(U);
303  if (!F) return false;
304 
305  for (auto BB = F->begin(), E = F->end(); BB != E; ++BB) {
306  if (BB->isLandingPad())
307  if (!LandingPadHasOnlyCXXUses(BB->getLandingPadInst()))
308  return false;
309  }
310  }
311 
312  return true;
313 }
314 
315 /// Try to use the C++ personality function in ObjC++. Not doing this
316 /// can cause some incompatibilities with gcc, which is more
317 /// aggressive about only using the ObjC++ personality in a function
318 /// when it really needs it.
319 void CodeGenModule::SimplifyPersonality() {
320  // If we're not in ObjC++ -fexceptions, there's nothing to do.
321  if (!LangOpts.CPlusPlus || !LangOpts.ObjC || !LangOpts.Exceptions)
322  return;
323 
324  // Both the problem this endeavors to fix and the way the logic
325  // above works is specific to the NeXT runtime.
326  if (!LangOpts.ObjCRuntime.isNeXTFamily())
327  return;
328 
329  const EHPersonality &ObjCXX = EHPersonality::get(*this, /*FD=*/nullptr);
330  const EHPersonality &CXX = getCXXPersonality(getTarget(), LangOpts);
331  if (&ObjCXX == &CXX)
332  return;
333 
334  assert(std::strcmp(ObjCXX.PersonalityFn, CXX.PersonalityFn) != 0 &&
335  "Different EHPersonalities using the same personality function.");
336 
337  llvm::Function *Fn = getModule().getFunction(ObjCXX.PersonalityFn);
338 
339  // Nothing to do if it's unused.
340  if (!Fn || Fn->use_empty()) return;
341 
342  // Can't do the optimization if it has non-C++ uses.
343  if (!PersonalityHasOnlyCXXUses(Fn)) return;
344 
345  // Create the C++ personality function and kill off the old
346  // function.
347  llvm::FunctionCallee CXXFn = getPersonalityFn(*this, CXX);
348 
349  // This can happen if the user is screwing with us.
350  if (Fn->getType() != CXXFn.getCallee()->getType())
351  return;
352 
353  Fn->replaceAllUsesWith(CXXFn.getCallee());
354  Fn->eraseFromParent();
355 }
356 
357 /// Returns the value to inject into a selector to indicate the
358 /// presence of a catch-all.
359 static llvm::Constant *getCatchAllValue(CodeGenFunction &CGF) {
360  // Possibly we should use @llvm.eh.catch.all.value here.
361  return llvm::ConstantPointerNull::get(CGF.Int8PtrTy);
362 }
363 
364 namespace {
365  /// A cleanup to free the exception object if its initialization
366  /// throws.
367  struct FreeException final : EHScopeStack::Cleanup {
368  llvm::Value *exn;
369  FreeException(llvm::Value *exn) : exn(exn) {}
370  void Emit(CodeGenFunction &CGF, Flags flags) override {
372  }
373  };
374 } // end anonymous namespace
375 
376 // Emits an exception expression into the given location. This
377 // differs from EmitAnyExprToMem only in that, if a final copy-ctor
378 // call is required, an exception within that copy ctor causes
379 // std::terminate to be invoked.
381  // Make sure the exception object is cleaned up if there's an
382  // exception during initialization.
383  pushFullExprCleanup<FreeException>(EHCleanup, addr.getPointer());
384  EHScopeStack::stable_iterator cleanup = EHStack.stable_begin();
385 
386  // __cxa_allocate_exception returns a void*; we need to cast this
387  // to the appropriate type for the object.
388  llvm::Type *ty = ConvertTypeForMem(e->getType())->getPointerTo();
389  Address typedAddr = Builder.CreateBitCast(addr, ty);
390 
391  // FIXME: this isn't quite right! If there's a final unelided call
392  // to a copy constructor, then according to [except.terminate]p1 we
393  // must call std::terminate() if that constructor throws, because
394  // technically that copy occurs after the exception expression is
395  // evaluated but before the exception is caught. But the best way
396  // to handle that is to teach EmitAggExpr to do the final copy
397  // differently if it can't be elided.
398  EmitAnyExprToMem(e, typedAddr, e->getType().getQualifiers(),
399  /*IsInit*/ true);
400 
401  // Deactivate the cleanup block.
402  DeactivateCleanupBlock(cleanup,
403  cast<llvm::Instruction>(typedAddr.getPointer()));
404 }
405 
407  if (!ExceptionSlot)
408  ExceptionSlot = CreateTempAlloca(Int8PtrTy, "exn.slot");
409  return Address(ExceptionSlot, getPointerAlign());
410 }
411 
413  if (!EHSelectorSlot)
414  EHSelectorSlot = CreateTempAlloca(Int32Ty, "ehselector.slot");
415  return Address(EHSelectorSlot, CharUnits::fromQuantity(4));
416 }
417 
419  return Builder.CreateLoad(getExceptionSlot(), "exn");
420 }
421 
423  return Builder.CreateLoad(getEHSelectorSlot(), "sel");
424 }
425 
427  bool KeepInsertionPoint) {
428  if (const Expr *SubExpr = E->getSubExpr()) {
429  QualType ThrowType = SubExpr->getType();
430  if (ThrowType->isObjCObjectPointerType()) {
431  const Stmt *ThrowStmt = E->getSubExpr();
432  const ObjCAtThrowStmt S(E->getExprLoc(), const_cast<Stmt *>(ThrowStmt));
433  CGM.getObjCRuntime().EmitThrowStmt(*this, S, false);
434  } else {
435  CGM.getCXXABI().emitThrow(*this, E);
436  }
437  } else {
438  CGM.getCXXABI().emitRethrow(*this, /*isNoReturn=*/true);
439  }
440 
441  // throw is an expression, and the expression emitters expect us
442  // to leave ourselves at a valid insertion point.
443  if (KeepInsertionPoint)
444  EmitBlock(createBasicBlock("throw.cont"));
445 }
446 
448  if (!CGM.getLangOpts().CXXExceptions)
449  return;
450 
451  const FunctionDecl* FD = dyn_cast_or_null<FunctionDecl>(D);
452  if (!FD) {
453  // Check if CapturedDecl is nothrow and create terminate scope for it.
454  if (const CapturedDecl* CD = dyn_cast_or_null<CapturedDecl>(D)) {
455  if (CD->isNothrow())
456  EHStack.pushTerminate();
457  }
458  return;
459  }
460  const FunctionProtoType *Proto = FD->getType()->getAs<FunctionProtoType>();
461  if (!Proto)
462  return;
463 
465  if (isNoexceptExceptionSpec(EST) && Proto->canThrow() == CT_Cannot) {
466  // noexcept functions are simple terminate scopes.
467  EHStack.pushTerminate();
468  } else if (EST == EST_Dynamic || EST == EST_DynamicNone) {
469  // TODO: Revisit exception specifications for the MS ABI. There is a way to
470  // encode these in an object file but MSVC doesn't do anything with it.
471  if (getTarget().getCXXABI().isMicrosoft())
472  return;
473  unsigned NumExceptions = Proto->getNumExceptions();
474  EHFilterScope *Filter = EHStack.pushFilter(NumExceptions);
475 
476  for (unsigned I = 0; I != NumExceptions; ++I) {
477  QualType Ty = Proto->getExceptionType(I);
478  QualType ExceptType = Ty.getNonReferenceType().getUnqualifiedType();
479  llvm::Value *EHType = CGM.GetAddrOfRTTIDescriptor(ExceptType,
480  /*ForEH=*/true);
481  Filter->setFilter(I, EHType);
482  }
483  }
484 }
485 
486 /// Emit the dispatch block for a filter scope if necessary.
488  EHFilterScope &filterScope) {
489  llvm::BasicBlock *dispatchBlock = filterScope.getCachedEHDispatchBlock();
490  if (!dispatchBlock) return;
491  if (dispatchBlock->use_empty()) {
492  delete dispatchBlock;
493  return;
494  }
495 
496  CGF.EmitBlockAfterUses(dispatchBlock);
497 
498  // If this isn't a catch-all filter, we need to check whether we got
499  // here because the filter triggered.
500  if (filterScope.getNumFilters()) {
501  // Load the selector value.
502  llvm::Value *selector = CGF.getSelectorFromSlot();
503  llvm::BasicBlock *unexpectedBB = CGF.createBasicBlock("ehspec.unexpected");
504 
505  llvm::Value *zero = CGF.Builder.getInt32(0);
506  llvm::Value *failsFilter =
507  CGF.Builder.CreateICmpSLT(selector, zero, "ehspec.fails");
508  CGF.Builder.CreateCondBr(failsFilter, unexpectedBB,
509  CGF.getEHResumeBlock(false));
510 
511  CGF.EmitBlock(unexpectedBB);
512  }
513 
514  // Call __cxa_call_unexpected. This doesn't need to be an invoke
515  // because __cxa_call_unexpected magically filters exceptions
516  // according to the last landing pad the exception was thrown
517  // into. Seriously.
518  llvm::Value *exn = CGF.getExceptionFromSlot();
519  CGF.EmitRuntimeCall(getUnexpectedFn(CGF.CGM), exn)
520  ->setDoesNotReturn();
521  CGF.Builder.CreateUnreachable();
522 }
523 
525  if (!CGM.getLangOpts().CXXExceptions)
526  return;
527 
528  const FunctionDecl* FD = dyn_cast_or_null<FunctionDecl>(D);
529  if (!FD) {
530  // Check if CapturedDecl is nothrow and pop terminate scope for it.
531  if (const CapturedDecl* CD = dyn_cast_or_null<CapturedDecl>(D)) {
532  if (CD->isNothrow())
533  EHStack.popTerminate();
534  }
535  return;
536  }
537  const FunctionProtoType *Proto = FD->getType()->getAs<FunctionProtoType>();
538  if (!Proto)
539  return;
540 
542  if (isNoexceptExceptionSpec(EST) && Proto->canThrow() == CT_Cannot) {
543  EHStack.popTerminate();
544  } else if (EST == EST_Dynamic || EST == EST_DynamicNone) {
545  // TODO: Revisit exception specifications for the MS ABI. There is a way to
546  // encode these in an object file but MSVC doesn't do anything with it.
547  if (getTarget().getCXXABI().isMicrosoft())
548  return;
549  EHFilterScope &filterScope = cast<EHFilterScope>(*EHStack.begin());
550  emitFilterDispatchBlock(*this, filterScope);
551  EHStack.popFilter();
552  }
553 }
554 
556  EnterCXXTryStmt(S);
557  EmitStmt(S.getTryBlock());
558  ExitCXXTryStmt(S);
559 }
560 
561 void CodeGenFunction::EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock) {
562  unsigned NumHandlers = S.getNumHandlers();
563  EHCatchScope *CatchScope = EHStack.pushCatch(NumHandlers);
564 
565  for (unsigned I = 0; I != NumHandlers; ++I) {
566  const CXXCatchStmt *C = S.getHandler(I);
567 
568  llvm::BasicBlock *Handler = createBasicBlock("catch");
569  if (C->getExceptionDecl()) {
570  // FIXME: Dropping the reference type on the type into makes it
571  // impossible to correctly implement catch-by-reference
572  // semantics for pointers. Unfortunately, this is what all
573  // existing compilers do, and it's not clear that the standard
574  // personality routine is capable of doing this right. See C++ DR 388:
575  // http://www.open-std.org/jtc1/sc22/wg21/docs/cwg_active.html#388
576  Qualifiers CaughtTypeQuals;
577  QualType CaughtType = CGM.getContext().getUnqualifiedArrayType(
578  C->getCaughtType().getNonReferenceType(), CaughtTypeQuals);
579 
580  CatchTypeInfo TypeInfo{nullptr, 0};
581  if (CaughtType->isObjCObjectPointerType())
582  TypeInfo.RTTI = CGM.getObjCRuntime().GetEHType(CaughtType);
583  else
584  TypeInfo = CGM.getCXXABI().getAddrOfCXXCatchHandlerType(
585  CaughtType, C->getCaughtType());
586  CatchScope->setHandler(I, TypeInfo, Handler);
587  } else {
588  // No exception decl indicates '...', a catch-all.
589  CatchScope->setHandler(I, CGM.getCXXABI().getCatchAllTypeInfo(), Handler);
590  }
591  }
592 }
593 
594 llvm::BasicBlock *
596  if (EHPersonality::get(*this).usesFuncletPads())
597  return getFuncletEHDispatchBlock(si);
598 
599  // The dispatch block for the end of the scope chain is a block that
600  // just resumes unwinding.
601  if (si == EHStack.stable_end())
602  return getEHResumeBlock(true);
603 
604  // Otherwise, we should look at the actual scope.
605  EHScope &scope = *EHStack.find(si);
606 
607  llvm::BasicBlock *dispatchBlock = scope.getCachedEHDispatchBlock();
608  if (!dispatchBlock) {
609  switch (scope.getKind()) {
610  case EHScope::Catch: {
611  // Apply a special case to a single catch-all.
612  EHCatchScope &catchScope = cast<EHCatchScope>(scope);
613  if (catchScope.getNumHandlers() == 1 &&
614  catchScope.getHandler(0).isCatchAll()) {
615  dispatchBlock = catchScope.getHandler(0).Block;
616 
617  // Otherwise, make a dispatch block.
618  } else {
619  dispatchBlock = createBasicBlock("catch.dispatch");
620  }
621  break;
622  }
623 
624  case EHScope::Cleanup:
625  dispatchBlock = createBasicBlock("ehcleanup");
626  break;
627 
628  case EHScope::Filter:
629  dispatchBlock = createBasicBlock("filter.dispatch");
630  break;
631 
632  case EHScope::Terminate:
633  dispatchBlock = getTerminateHandler();
634  break;
635 
636  case EHScope::PadEnd:
637  llvm_unreachable("PadEnd unnecessary for Itanium!");
638  }
639  scope.setCachedEHDispatchBlock(dispatchBlock);
640  }
641  return dispatchBlock;
642 }
643 
644 llvm::BasicBlock *
646  // Returning nullptr indicates that the previous dispatch block should unwind
647  // to caller.
648  if (SI == EHStack.stable_end())
649  return nullptr;
650 
651  // Otherwise, we should look at the actual scope.
652  EHScope &EHS = *EHStack.find(SI);
653 
654  llvm::BasicBlock *DispatchBlock = EHS.getCachedEHDispatchBlock();
655  if (DispatchBlock)
656  return DispatchBlock;
657 
658  if (EHS.getKind() == EHScope::Terminate)
659  DispatchBlock = getTerminateFunclet();
660  else
661  DispatchBlock = createBasicBlock();
662  CGBuilderTy Builder(*this, DispatchBlock);
663 
664  switch (EHS.getKind()) {
665  case EHScope::Catch:
666  DispatchBlock->setName("catch.dispatch");
667  break;
668 
669  case EHScope::Cleanup:
670  DispatchBlock->setName("ehcleanup");
671  break;
672 
673  case EHScope::Filter:
674  llvm_unreachable("exception specifications not handled yet!");
675 
676  case EHScope::Terminate:
677  DispatchBlock->setName("terminate");
678  break;
679 
680  case EHScope::PadEnd:
681  llvm_unreachable("PadEnd dispatch block missing!");
682  }
683  EHS.setCachedEHDispatchBlock(DispatchBlock);
684  return DispatchBlock;
685 }
686 
687 /// Check whether this is a non-EH scope, i.e. a scope which doesn't
688 /// affect exception handling. Currently, the only non-EH scopes are
689 /// normal-only cleanup scopes.
690 static bool isNonEHScope(const EHScope &S) {
691  switch (S.getKind()) {
692  case EHScope::Cleanup:
693  return !cast<EHCleanupScope>(S).isEHCleanup();
694  case EHScope::Filter:
695  case EHScope::Catch:
696  case EHScope::Terminate:
697  case EHScope::PadEnd:
698  return false;
699  }
700 
701  llvm_unreachable("Invalid EHScope Kind!");
702 }
703 
705  assert(EHStack.requiresLandingPad());
706  assert(!EHStack.empty());
707 
708  // If exceptions are disabled and SEH is not in use, then there is no invoke
709  // destination. SEH "works" even if exceptions are off. In practice, this
710  // means that C++ destructors and other EH cleanups don't run, which is
711  // consistent with MSVC's behavior.
712  const LangOptions &LO = CGM.getLangOpts();
713  if (!LO.Exceptions) {
714  if (!LO.Borland && !LO.MicrosoftExt)
715  return nullptr;
716  if (!currentFunctionUsesSEHTry())
717  return nullptr;
718  }
719 
720  // CUDA device code doesn't have exceptions.
721  if (LO.CUDA && LO.CUDAIsDevice)
722  return nullptr;
723 
724  // Check the innermost scope for a cached landing pad. If this is
725  // a non-EH cleanup, we'll check enclosing scopes in EmitLandingPad.
726  llvm::BasicBlock *LP = EHStack.begin()->getCachedLandingPad();
727  if (LP) return LP;
728 
729  const EHPersonality &Personality = EHPersonality::get(*this);
730 
731  if (!CurFn->hasPersonalityFn())
732  CurFn->setPersonalityFn(getOpaquePersonalityFn(CGM, Personality));
733 
734  if (Personality.usesFuncletPads()) {
735  // We don't need separate landing pads in the funclet model.
736  LP = getEHDispatchBlock(EHStack.getInnermostEHScope());
737  } else {
738  // Build the landing pad for this scope.
739  LP = EmitLandingPad();
740  }
741 
742  assert(LP);
743 
744  // Cache the landing pad on the innermost scope. If this is a
745  // non-EH scope, cache the landing pad on the enclosing scope, too.
746  for (EHScopeStack::iterator ir = EHStack.begin(); true; ++ir) {
747  ir->setCachedLandingPad(LP);
748  if (!isNonEHScope(*ir)) break;
749  }
750 
751  return LP;
752 }
753 
754 llvm::BasicBlock *CodeGenFunction::EmitLandingPad() {
755  assert(EHStack.requiresLandingPad());
756 
757  EHScope &innermostEHScope = *EHStack.find(EHStack.getInnermostEHScope());
758  switch (innermostEHScope.getKind()) {
759  case EHScope::Terminate:
760  return getTerminateLandingPad();
761 
762  case EHScope::PadEnd:
763  llvm_unreachable("PadEnd unnecessary for Itanium!");
764 
765  case EHScope::Catch:
766  case EHScope::Cleanup:
767  case EHScope::Filter:
768  if (llvm::BasicBlock *lpad = innermostEHScope.getCachedLandingPad())
769  return lpad;
770  }
771 
772  // Save the current IR generation state.
773  CGBuilderTy::InsertPoint savedIP = Builder.saveAndClearIP();
774  auto DL = ApplyDebugLocation::CreateDefaultArtificial(*this, CurEHLocation);
775 
776  // Create and configure the landing pad.
777  llvm::BasicBlock *lpad = createBasicBlock("lpad");
778  EmitBlock(lpad);
779 
780  llvm::LandingPadInst *LPadInst =
781  Builder.CreateLandingPad(llvm::StructType::get(Int8PtrTy, Int32Ty), 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(); I != E;
800  ++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  case EHScope::PadEnd:
832  llvm_unreachable("PadEnd unnecessary for Itanium!");
833  }
834 
835  EHCatchScope &catchScope = cast<EHCatchScope>(*I);
836  for (unsigned hi = 0, he = catchScope.getNumHandlers(); hi != he; ++hi) {
837  EHCatchScope::Handler handler = catchScope.getHandler(hi);
838  assert(handler.Type.Flags == 0 &&
839  "landingpads do not support catch handler flags");
840 
841  // If this is a catch-all, register that and abort.
842  if (!handler.Type.RTTI) {
843  assert(!hasCatchAll);
844  hasCatchAll = true;
845  goto done;
846  }
847 
848  // Check whether we already have a handler for this type.
849  if (catchTypes.insert(handler.Type.RTTI).second)
850  // If not, add it directly to the landingpad.
851  LPadInst->addClause(handler.Type.RTTI);
852  }
853  }
854 
855  done:
856  // If we have a catch-all, add null to the landingpad.
857  assert(!(hasCatchAll && hasFilter));
858  if (hasCatchAll) {
859  LPadInst->addClause(getCatchAllValue(*this));
860 
861  // If we have an EH filter, we need to add those handlers in the
862  // right place in the landingpad, which is to say, at the end.
863  } else if (hasFilter) {
864  // Create a filter expression: a constant array indicating which filter
865  // types there are. The personality routine only lands here if the filter
866  // doesn't match.
868  llvm::ArrayType *AType =
869  llvm::ArrayType::get(!filterTypes.empty() ?
870  filterTypes[0]->getType() : Int8PtrTy,
871  filterTypes.size());
872 
873  for (unsigned i = 0, e = filterTypes.size(); i != e; ++i)
874  Filters.push_back(cast<llvm::Constant>(filterTypes[i]));
875  llvm::Constant *FilterArray = llvm::ConstantArray::get(AType, Filters);
876  LPadInst->addClause(FilterArray);
877 
878  // Also check whether we need a cleanup.
879  if (hasCleanup)
880  LPadInst->setCleanup(true);
881 
882  // Otherwise, signal that we at least have cleanups.
883  } else if (hasCleanup) {
884  LPadInst->setCleanup(true);
885  }
886 
887  assert((LPadInst->getNumClauses() > 0 || LPadInst->isCleanup()) &&
888  "landingpad instruction has no clauses!");
889 
890  // Tell the backend how to generate the landing pad.
891  Builder.CreateBr(getEHDispatchBlock(EHStack.getInnermostEHScope()));
892 
893  // Restore the old IR generation state.
894  Builder.restoreIP(savedIP);
895 
896  return lpad;
897 }
898 
899 static void emitCatchPadBlock(CodeGenFunction &CGF, EHCatchScope &CatchScope) {
900  llvm::BasicBlock *DispatchBlock = CatchScope.getCachedEHDispatchBlock();
901  assert(DispatchBlock);
902 
903  CGBuilderTy::InsertPoint SavedIP = CGF.Builder.saveIP();
904  CGF.EmitBlockAfterUses(DispatchBlock);
905 
906  llvm::Value *ParentPad = CGF.CurrentFuncletPad;
907  if (!ParentPad)
908  ParentPad = llvm::ConstantTokenNone::get(CGF.getLLVMContext());
909  llvm::BasicBlock *UnwindBB =
910  CGF.getEHDispatchBlock(CatchScope.getEnclosingEHScope());
911 
912  unsigned NumHandlers = CatchScope.getNumHandlers();
913  llvm::CatchSwitchInst *CatchSwitch =
914  CGF.Builder.CreateCatchSwitch(ParentPad, UnwindBB, NumHandlers);
915 
916  // Test against each of the exception types we claim to catch.
917  for (unsigned I = 0; I < NumHandlers; ++I) {
918  const EHCatchScope::Handler &Handler = CatchScope.getHandler(I);
919 
920  CatchTypeInfo TypeInfo = Handler.Type;
921  if (!TypeInfo.RTTI)
922  TypeInfo.RTTI = llvm::Constant::getNullValue(CGF.VoidPtrTy);
923 
924  CGF.Builder.SetInsertPoint(Handler.Block);
925 
926  if (EHPersonality::get(CGF).isMSVCXXPersonality()) {
927  CGF.Builder.CreateCatchPad(
928  CatchSwitch, {TypeInfo.RTTI, CGF.Builder.getInt32(TypeInfo.Flags),
929  llvm::Constant::getNullValue(CGF.VoidPtrTy)});
930  } else {
931  CGF.Builder.CreateCatchPad(CatchSwitch, {TypeInfo.RTTI});
932  }
933 
934  CatchSwitch->addHandler(Handler.Block);
935  }
936  CGF.Builder.restoreIP(SavedIP);
937 }
938 
939 // Wasm uses Windows-style EH instructions, but it merges all catch clauses into
940 // one big catchpad, within which we use Itanium's landingpad-style selector
941 // comparison instructions.
943  EHCatchScope &CatchScope) {
944  llvm::BasicBlock *DispatchBlock = CatchScope.getCachedEHDispatchBlock();
945  assert(DispatchBlock);
946 
947  CGBuilderTy::InsertPoint SavedIP = CGF.Builder.saveIP();
948  CGF.EmitBlockAfterUses(DispatchBlock);
949 
950  llvm::Value *ParentPad = CGF.CurrentFuncletPad;
951  if (!ParentPad)
952  ParentPad = llvm::ConstantTokenNone::get(CGF.getLLVMContext());
953  llvm::BasicBlock *UnwindBB =
954  CGF.getEHDispatchBlock(CatchScope.getEnclosingEHScope());
955 
956  unsigned NumHandlers = CatchScope.getNumHandlers();
957  llvm::CatchSwitchInst *CatchSwitch =
958  CGF.Builder.CreateCatchSwitch(ParentPad, UnwindBB, NumHandlers);
959 
960  // We don't use a landingpad instruction, so generate intrinsic calls to
961  // provide exception and selector values.
962  llvm::BasicBlock *WasmCatchStartBlock = CGF.createBasicBlock("catch.start");
963  CatchSwitch->addHandler(WasmCatchStartBlock);
964  CGF.EmitBlockAfterUses(WasmCatchStartBlock);
965 
966  // Create a catchpad instruction.
968  for (unsigned I = 0, E = NumHandlers; I < E; ++I) {
969  const EHCatchScope::Handler &Handler = CatchScope.getHandler(I);
970  CatchTypeInfo TypeInfo = Handler.Type;
971  if (!TypeInfo.RTTI)
972  TypeInfo.RTTI = llvm::Constant::getNullValue(CGF.VoidPtrTy);
973  CatchTypes.push_back(TypeInfo.RTTI);
974  }
975  auto *CPI = CGF.Builder.CreateCatchPad(CatchSwitch, CatchTypes);
976 
977  // Create calls to wasm.get.exception and wasm.get.ehselector intrinsics.
978  // Before they are lowered appropriately later, they provide values for the
979  // exception and selector.
980  llvm::Function *GetExnFn =
981  CGF.CGM.getIntrinsic(llvm::Intrinsic::wasm_get_exception);
982  llvm::Function *GetSelectorFn =
983  CGF.CGM.getIntrinsic(llvm::Intrinsic::wasm_get_ehselector);
984  llvm::CallInst *Exn = CGF.Builder.CreateCall(GetExnFn, CPI);
985  CGF.Builder.CreateStore(Exn, CGF.getExceptionSlot());
986  llvm::CallInst *Selector = CGF.Builder.CreateCall(GetSelectorFn, CPI);
987 
988  llvm::Function *TypeIDFn = CGF.CGM.getIntrinsic(llvm::Intrinsic::eh_typeid_for);
989 
990  // If there's only a single catch-all, branch directly to its handler.
991  if (CatchScope.getNumHandlers() == 1 &&
992  CatchScope.getHandler(0).isCatchAll()) {
993  CGF.Builder.CreateBr(CatchScope.getHandler(0).Block);
994  CGF.Builder.restoreIP(SavedIP);
995  return;
996  }
997 
998  // Test against each of the exception types we claim to catch.
999  for (unsigned I = 0, E = NumHandlers;; ++I) {
1000  assert(I < E && "ran off end of handlers!");
1001  const EHCatchScope::Handler &Handler = CatchScope.getHandler(I);
1002  CatchTypeInfo TypeInfo = Handler.Type;
1003  if (!TypeInfo.RTTI)
1004  TypeInfo.RTTI = llvm::Constant::getNullValue(CGF.VoidPtrTy);
1005 
1006  // Figure out the next block.
1007  llvm::BasicBlock *NextBlock;
1008 
1009  bool EmitNextBlock = false, NextIsEnd = false;
1010 
1011  // If this is the last handler, we're at the end, and the next block is a
1012  // block that contains a call to the rethrow function, so we can unwind to
1013  // the enclosing EH scope. The call itself will be generated later.
1014  if (I + 1 == E) {
1015  NextBlock = CGF.createBasicBlock("rethrow");
1016  EmitNextBlock = true;
1017  NextIsEnd = true;
1018 
1019  // If the next handler is a catch-all, we're at the end, and the
1020  // next block is that handler.
1021  } else if (CatchScope.getHandler(I + 1).isCatchAll()) {
1022  NextBlock = CatchScope.getHandler(I + 1).Block;
1023  NextIsEnd = true;
1024 
1025  // Otherwise, we're not at the end and we need a new block.
1026  } else {
1027  NextBlock = CGF.createBasicBlock("catch.fallthrough");
1028  EmitNextBlock = true;
1029  }
1030 
1031  // Figure out the catch type's index in the LSDA's type table.
1032  llvm::CallInst *TypeIndex = CGF.Builder.CreateCall(TypeIDFn, TypeInfo.RTTI);
1033  TypeIndex->setDoesNotThrow();
1034 
1035  llvm::Value *MatchesTypeIndex =
1036  CGF.Builder.CreateICmpEQ(Selector, TypeIndex, "matches");
1037  CGF.Builder.CreateCondBr(MatchesTypeIndex, Handler.Block, NextBlock);
1038 
1039  if (EmitNextBlock)
1040  CGF.EmitBlock(NextBlock);
1041  if (NextIsEnd)
1042  break;
1043  }
1044 
1045  CGF.Builder.restoreIP(SavedIP);
1046 }
1047 
1048 /// Emit the structure of the dispatch block for the given catch scope.
1049 /// It is an invariant that the dispatch block already exists.
1051  EHCatchScope &catchScope) {
1052  if (EHPersonality::get(CGF).isWasmPersonality())
1053  return emitWasmCatchPadBlock(CGF, catchScope);
1054  if (EHPersonality::get(CGF).usesFuncletPads())
1055  return emitCatchPadBlock(CGF, catchScope);
1056 
1057  llvm::BasicBlock *dispatchBlock = catchScope.getCachedEHDispatchBlock();
1058  assert(dispatchBlock);
1059 
1060  // If there's only a single catch-all, getEHDispatchBlock returned
1061  // that catch-all as the dispatch block.
1062  if (catchScope.getNumHandlers() == 1 &&
1063  catchScope.getHandler(0).isCatchAll()) {
1064  assert(dispatchBlock == catchScope.getHandler(0).Block);
1065  return;
1066  }
1067 
1068  CGBuilderTy::InsertPoint savedIP = CGF.Builder.saveIP();
1069  CGF.EmitBlockAfterUses(dispatchBlock);
1070 
1071  // Select the right handler.
1072  llvm::Function *llvm_eh_typeid_for =
1073  CGF.CGM.getIntrinsic(llvm::Intrinsic::eh_typeid_for);
1074 
1075  // Load the selector value.
1076  llvm::Value *selector = CGF.getSelectorFromSlot();
1077 
1078  // Test against each of the exception types we claim to catch.
1079  for (unsigned i = 0, e = catchScope.getNumHandlers(); ; ++i) {
1080  assert(i < e && "ran off end of handlers!");
1081  const EHCatchScope::Handler &handler = catchScope.getHandler(i);
1082 
1083  llvm::Value *typeValue = handler.Type.RTTI;
1084  assert(handler.Type.Flags == 0 &&
1085  "landingpads do not support catch handler flags");
1086  assert(typeValue && "fell into catch-all case!");
1087  typeValue = CGF.Builder.CreateBitCast(typeValue, CGF.Int8PtrTy);
1088 
1089  // Figure out the next block.
1090  bool nextIsEnd;
1091  llvm::BasicBlock *nextBlock;
1092 
1093  // If this is the last handler, we're at the end, and the next
1094  // block is the block for the enclosing EH scope.
1095  if (i + 1 == e) {
1096  nextBlock = CGF.getEHDispatchBlock(catchScope.getEnclosingEHScope());
1097  nextIsEnd = true;
1098 
1099  // If the next handler is a catch-all, we're at the end, and the
1100  // next block is that handler.
1101  } else if (catchScope.getHandler(i+1).isCatchAll()) {
1102  nextBlock = catchScope.getHandler(i+1).Block;
1103  nextIsEnd = true;
1104 
1105  // Otherwise, we're not at the end and we need a new block.
1106  } else {
1107  nextBlock = CGF.createBasicBlock("catch.fallthrough");
1108  nextIsEnd = false;
1109  }
1110 
1111  // Figure out the catch type's index in the LSDA's type table.
1112  llvm::CallInst *typeIndex =
1113  CGF.Builder.CreateCall(llvm_eh_typeid_for, typeValue);
1114  typeIndex->setDoesNotThrow();
1115 
1116  llvm::Value *matchesTypeIndex =
1117  CGF.Builder.CreateICmpEQ(selector, typeIndex, "matches");
1118  CGF.Builder.CreateCondBr(matchesTypeIndex, handler.Block, nextBlock);
1119 
1120  // If the next handler is a catch-all, we're completely done.
1121  if (nextIsEnd) {
1122  CGF.Builder.restoreIP(savedIP);
1123  return;
1124  }
1125  // Otherwise we need to emit and continue at that block.
1126  CGF.EmitBlock(nextBlock);
1127  }
1128 }
1129 
1131  EHCatchScope &catchScope = cast<EHCatchScope>(*EHStack.begin());
1132  if (catchScope.hasEHBranches())
1133  emitCatchDispatchBlock(*this, catchScope);
1134  EHStack.popCatch();
1135 }
1136 
1137 void CodeGenFunction::ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock) {
1138  unsigned NumHandlers = S.getNumHandlers();
1139  EHCatchScope &CatchScope = cast<EHCatchScope>(*EHStack.begin());
1140  assert(CatchScope.getNumHandlers() == NumHandlers);
1141  llvm::BasicBlock *DispatchBlock = CatchScope.getCachedEHDispatchBlock();
1142 
1143  // If the catch was not required, bail out now.
1144  if (!CatchScope.hasEHBranches()) {
1145  CatchScope.clearHandlerBlocks();
1146  EHStack.popCatch();
1147  return;
1148  }
1149 
1150  // Emit the structure of the EH dispatch for this catch.
1151  emitCatchDispatchBlock(*this, CatchScope);
1152 
1153  // Copy the handler blocks off before we pop the EH stack. Emitting
1154  // the handlers might scribble on this memory.
1156  CatchScope.begin(), CatchScope.begin() + NumHandlers);
1157 
1158  EHStack.popCatch();
1159 
1160  // The fall-through block.
1161  llvm::BasicBlock *ContBB = createBasicBlock("try.cont");
1162 
1163  // We just emitted the body of the try; jump to the continue block.
1164  if (HaveInsertPoint())
1165  Builder.CreateBr(ContBB);
1166 
1167  // Determine if we need an implicit rethrow for all these catch handlers;
1168  // see the comment below.
1169  bool doImplicitRethrow = false;
1170  if (IsFnTryBlock)
1171  doImplicitRethrow = isa<CXXDestructorDecl>(CurCodeDecl) ||
1172  isa<CXXConstructorDecl>(CurCodeDecl);
1173 
1174  // Wasm uses Windows-style EH instructions, but merges all catch clauses into
1175  // one big catchpad. So we save the old funclet pad here before we traverse
1176  // each catch handler.
1177  SaveAndRestore<llvm::Instruction *> RestoreCurrentFuncletPad(
1178  CurrentFuncletPad);
1179  llvm::BasicBlock *WasmCatchStartBlock = nullptr;
1180  if (EHPersonality::get(*this).isWasmPersonality()) {
1181  auto *CatchSwitch =
1182  cast<llvm::CatchSwitchInst>(DispatchBlock->getFirstNonPHI());
1183  WasmCatchStartBlock = CatchSwitch->hasUnwindDest()
1184  ? CatchSwitch->getSuccessor(1)
1185  : CatchSwitch->getSuccessor(0);
1186  auto *CPI = cast<llvm::CatchPadInst>(WasmCatchStartBlock->getFirstNonPHI());
1187  CurrentFuncletPad = CPI;
1188  }
1189 
1190  // Perversely, we emit the handlers backwards precisely because we
1191  // want them to appear in source order. In all of these cases, the
1192  // catch block will have exactly one predecessor, which will be a
1193  // particular block in the catch dispatch. However, in the case of
1194  // a catch-all, one of the dispatch blocks will branch to two
1195  // different handlers, and EmitBlockAfterUses will cause the second
1196  // handler to be moved before the first.
1197  bool HasCatchAll = false;
1198  for (unsigned I = NumHandlers; I != 0; --I) {
1199  HasCatchAll |= Handlers[I - 1].isCatchAll();
1200  llvm::BasicBlock *CatchBlock = Handlers[I-1].Block;
1201  EmitBlockAfterUses(CatchBlock);
1202 
1203  // Catch the exception if this isn't a catch-all.
1204  const CXXCatchStmt *C = S.getHandler(I-1);
1205 
1206  // Enter a cleanup scope, including the catch variable and the
1207  // end-catch.
1208  RunCleanupsScope CatchScope(*this);
1209 
1210  // Initialize the catch variable and set up the cleanups.
1211  SaveAndRestore<llvm::Instruction *> RestoreCurrentFuncletPad(
1212  CurrentFuncletPad);
1213  CGM.getCXXABI().emitBeginCatch(*this, C);
1214 
1215  // Emit the PGO counter increment.
1216  incrementProfileCounter(C);
1217 
1218  // Perform the body of the catch.
1219  EmitStmt(C->getHandlerBlock());
1220 
1221  // [except.handle]p11:
1222  // The currently handled exception is rethrown if control
1223  // reaches the end of a handler of the function-try-block of a
1224  // constructor or destructor.
1225 
1226  // It is important that we only do this on fallthrough and not on
1227  // return. Note that it's illegal to put a return in a
1228  // constructor function-try-block's catch handler (p14), so this
1229  // really only applies to destructors.
1230  if (doImplicitRethrow && HaveInsertPoint()) {
1231  CGM.getCXXABI().emitRethrow(*this, /*isNoReturn*/false);
1232  Builder.CreateUnreachable();
1233  Builder.ClearInsertionPoint();
1234  }
1235 
1236  // Fall out through the catch cleanups.
1237  CatchScope.ForceCleanup();
1238 
1239  // Branch out of the try.
1240  if (HaveInsertPoint())
1241  Builder.CreateBr(ContBB);
1242  }
1243 
1244  // Because in wasm we merge all catch clauses into one big catchpad, in case
1245  // none of the types in catch handlers matches after we test against each of
1246  // them, we should unwind to the next EH enclosing scope. We generate a call
1247  // to rethrow function here to do that.
1248  if (EHPersonality::get(*this).isWasmPersonality() && !HasCatchAll) {
1249  assert(WasmCatchStartBlock);
1250  // Navigate for the "rethrow" block we created in emitWasmCatchPadBlock().
1251  // Wasm uses landingpad-style conditional branches to compare selectors, so
1252  // we follow the false destination for each of the cond branches to reach
1253  // the rethrow block.
1254  llvm::BasicBlock *RethrowBlock = WasmCatchStartBlock;
1255  while (llvm::Instruction *TI = RethrowBlock->getTerminator()) {
1256  auto *BI = cast<llvm::BranchInst>(TI);
1257  assert(BI->isConditional());
1258  RethrowBlock = BI->getSuccessor(1);
1259  }
1260  assert(RethrowBlock != WasmCatchStartBlock && RethrowBlock->empty());
1261  Builder.SetInsertPoint(RethrowBlock);
1262  CGM.getCXXABI().emitRethrow(*this, /*isNoReturn=*/true);
1263  }
1264 
1265  EmitBlock(ContBB);
1266  incrementProfileCounter(&S);
1267 }
1268 
1269 namespace {
1270  struct CallEndCatchForFinally final : EHScopeStack::Cleanup {
1271  llvm::Value *ForEHVar;
1272  llvm::FunctionCallee EndCatchFn;
1273  CallEndCatchForFinally(llvm::Value *ForEHVar,
1274  llvm::FunctionCallee EndCatchFn)
1275  : ForEHVar(ForEHVar), EndCatchFn(EndCatchFn) {}
1276 
1277  void Emit(CodeGenFunction &CGF, Flags flags) override {
1278  llvm::BasicBlock *EndCatchBB = CGF.createBasicBlock("finally.endcatch");
1279  llvm::BasicBlock *CleanupContBB =
1280  CGF.createBasicBlock("finally.cleanup.cont");
1281 
1282  llvm::Value *ShouldEndCatch =
1283  CGF.Builder.CreateFlagLoad(ForEHVar, "finally.endcatch");
1284  CGF.Builder.CreateCondBr(ShouldEndCatch, EndCatchBB, CleanupContBB);
1285  CGF.EmitBlock(EndCatchBB);
1286  CGF.EmitRuntimeCallOrInvoke(EndCatchFn); // catch-all, so might throw
1287  CGF.EmitBlock(CleanupContBB);
1288  }
1289  };
1290 
1291  struct PerformFinally final : EHScopeStack::Cleanup {
1292  const Stmt *Body;
1293  llvm::Value *ForEHVar;
1294  llvm::FunctionCallee EndCatchFn;
1295  llvm::FunctionCallee RethrowFn;
1296  llvm::Value *SavedExnVar;
1297 
1298  PerformFinally(const Stmt *Body, llvm::Value *ForEHVar,
1299  llvm::FunctionCallee EndCatchFn,
1300  llvm::FunctionCallee RethrowFn, llvm::Value *SavedExnVar)
1301  : Body(Body), ForEHVar(ForEHVar), EndCatchFn(EndCatchFn),
1302  RethrowFn(RethrowFn), SavedExnVar(SavedExnVar) {}
1303 
1304  void Emit(CodeGenFunction &CGF, Flags flags) override {
1305  // Enter a cleanup to call the end-catch function if one was provided.
1306  if (EndCatchFn)
1307  CGF.EHStack.pushCleanup<CallEndCatchForFinally>(NormalAndEHCleanup,
1308  ForEHVar, EndCatchFn);
1309 
1310  // Save the current cleanup destination in case there are
1311  // cleanups in the finally block.
1312  llvm::Value *SavedCleanupDest =
1314  "cleanup.dest.saved");
1315 
1316  // Emit the finally block.
1317  CGF.EmitStmt(Body);
1318 
1319  // If the end of the finally is reachable, check whether this was
1320  // for EH. If so, rethrow.
1321  if (CGF.HaveInsertPoint()) {
1322  llvm::BasicBlock *RethrowBB = CGF.createBasicBlock("finally.rethrow");
1323  llvm::BasicBlock *ContBB = CGF.createBasicBlock("finally.cont");
1324 
1325  llvm::Value *ShouldRethrow =
1326  CGF.Builder.CreateFlagLoad(ForEHVar, "finally.shouldthrow");
1327  CGF.Builder.CreateCondBr(ShouldRethrow, RethrowBB, ContBB);
1328 
1329  CGF.EmitBlock(RethrowBB);
1330  if (SavedExnVar) {
1331  CGF.EmitRuntimeCallOrInvoke(RethrowFn,
1332  CGF.Builder.CreateAlignedLoad(SavedExnVar, CGF.getPointerAlign()));
1333  } else {
1334  CGF.EmitRuntimeCallOrInvoke(RethrowFn);
1335  }
1336  CGF.Builder.CreateUnreachable();
1337 
1338  CGF.EmitBlock(ContBB);
1339 
1340  // Restore the cleanup destination.
1341  CGF.Builder.CreateStore(SavedCleanupDest,
1342  CGF.getNormalCleanupDestSlot());
1343  }
1344 
1345  // Leave the end-catch cleanup. As an optimization, pretend that
1346  // the fallthrough path was inaccessible; we've dynamically proven
1347  // that we're not in the EH case along that path.
1348  if (EndCatchFn) {
1349  CGBuilderTy::InsertPoint SavedIP = CGF.Builder.saveAndClearIP();
1350  CGF.PopCleanupBlock();
1351  CGF.Builder.restoreIP(SavedIP);
1352  }
1353 
1354  // Now make sure we actually have an insertion point or the
1355  // cleanup gods will hate us.
1356  CGF.EnsureInsertPoint();
1357  }
1358  };
1359 } // end anonymous namespace
1360 
1361 /// Enters a finally block for an implementation using zero-cost
1362 /// exceptions. This is mostly general, but hard-codes some
1363 /// language/ABI-specific behavior in the catch-all sections.
1365  llvm::FunctionCallee beginCatchFn,
1366  llvm::FunctionCallee endCatchFn,
1367  llvm::FunctionCallee rethrowFn) {
1368  assert((!!beginCatchFn) == (!!endCatchFn) &&
1369  "begin/end catch functions not paired");
1370  assert(rethrowFn && "rethrow function is required");
1371 
1372  BeginCatchFn = beginCatchFn;
1373 
1374  // The rethrow function has one of the following two types:
1375  // void (*)()
1376  // void (*)(void*)
1377  // In the latter case we need to pass it the exception object.
1378  // But we can't use the exception slot because the @finally might
1379  // have a landing pad (which would overwrite the exception slot).
1380  llvm::FunctionType *rethrowFnTy = rethrowFn.getFunctionType();
1381  SavedExnVar = nullptr;
1382  if (rethrowFnTy->getNumParams())
1383  SavedExnVar = CGF.CreateTempAlloca(CGF.Int8PtrTy, "finally.exn");
1384 
1385  // A finally block is a statement which must be executed on any edge
1386  // out of a given scope. Unlike a cleanup, the finally block may
1387  // contain arbitrary control flow leading out of itself. In
1388  // addition, finally blocks should always be executed, even if there
1389  // are no catch handlers higher on the stack. Therefore, we
1390  // surround the protected scope with a combination of a normal
1391  // cleanup (to catch attempts to break out of the block via normal
1392  // control flow) and an EH catch-all (semantically "outside" any try
1393  // statement to which the finally block might have been attached).
1394  // The finally block itself is generated in the context of a cleanup
1395  // which conditionally leaves the catch-all.
1396 
1397  // Jump destination for performing the finally block on an exception
1398  // edge. We'll never actually reach this block, so unreachable is
1399  // fine.
1400  RethrowDest = CGF.getJumpDestInCurrentScope(CGF.getUnreachableBlock());
1401 
1402  // Whether the finally block is being executed for EH purposes.
1403  ForEHVar = CGF.CreateTempAlloca(CGF.Builder.getInt1Ty(), "finally.for-eh");
1404  CGF.Builder.CreateFlagStore(false, ForEHVar);
1405 
1406  // Enter a normal cleanup which will perform the @finally block.
1407  CGF.EHStack.pushCleanup<PerformFinally>(NormalCleanup, body,
1408  ForEHVar, endCatchFn,
1409  rethrowFn, SavedExnVar);
1410 
1411  // Enter a catch-all scope.
1412  llvm::BasicBlock *catchBB = CGF.createBasicBlock("finally.catchall");
1413  EHCatchScope *catchScope = CGF.EHStack.pushCatch(1);
1414  catchScope->setCatchAllHandler(0, catchBB);
1415 }
1416 
1418  // Leave the finally catch-all.
1419  EHCatchScope &catchScope = cast<EHCatchScope>(*CGF.EHStack.begin());
1420  llvm::BasicBlock *catchBB = catchScope.getHandler(0).Block;
1421 
1422  CGF.popCatchScope();
1423 
1424  // If there are any references to the catch-all block, emit it.
1425  if (catchBB->use_empty()) {
1426  delete catchBB;
1427  } else {
1428  CGBuilderTy::InsertPoint savedIP = CGF.Builder.saveAndClearIP();
1429  CGF.EmitBlock(catchBB);
1430 
1431  llvm::Value *exn = nullptr;
1432 
1433  // If there's a begin-catch function, call it.
1434  if (BeginCatchFn) {
1435  exn = CGF.getExceptionFromSlot();
1436  CGF.EmitNounwindRuntimeCall(BeginCatchFn, exn);
1437  }
1438 
1439  // If we need to remember the exception pointer to rethrow later, do so.
1440  if (SavedExnVar) {
1441  if (!exn) exn = CGF.getExceptionFromSlot();
1442  CGF.Builder.CreateAlignedStore(exn, SavedExnVar, CGF.getPointerAlign());
1443  }
1444 
1445  // Tell the cleanups in the finally block that we're do this for EH.
1446  CGF.Builder.CreateFlagStore(true, ForEHVar);
1447 
1448  // Thread a jump through the finally cleanup.
1449  CGF.EmitBranchThroughCleanup(RethrowDest);
1450 
1451  CGF.Builder.restoreIP(savedIP);
1452  }
1453 
1454  // Finally, leave the @finally cleanup.
1455  CGF.PopCleanupBlock();
1456 }
1457 
1459  if (TerminateLandingPad)
1460  return TerminateLandingPad;
1461 
1462  CGBuilderTy::InsertPoint SavedIP = Builder.saveAndClearIP();
1463 
1464  // This will get inserted at the end of the function.
1465  TerminateLandingPad = createBasicBlock("terminate.lpad");
1466  Builder.SetInsertPoint(TerminateLandingPad);
1467 
1468  // Tell the backend that this is a landing pad.
1469  const EHPersonality &Personality = EHPersonality::get(*this);
1470 
1471  if (!CurFn->hasPersonalityFn())
1472  CurFn->setPersonalityFn(getOpaquePersonalityFn(CGM, Personality));
1473 
1474  llvm::LandingPadInst *LPadInst =
1475  Builder.CreateLandingPad(llvm::StructType::get(Int8PtrTy, Int32Ty), 0);
1476  LPadInst->addClause(getCatchAllValue(*this));
1477 
1478  llvm::Value *Exn = nullptr;
1479  if (getLangOpts().CPlusPlus)
1480  Exn = Builder.CreateExtractValue(LPadInst, 0);
1481  llvm::CallInst *terminateCall =
1482  CGM.getCXXABI().emitTerminateForUnexpectedException(*this, Exn);
1483  terminateCall->setDoesNotReturn();
1484  Builder.CreateUnreachable();
1485 
1486  // Restore the saved insertion state.
1487  Builder.restoreIP(SavedIP);
1488 
1489  return TerminateLandingPad;
1490 }
1491 
1493  if (TerminateHandler)
1494  return TerminateHandler;
1495 
1496  // Set up the terminate handler. This block is inserted at the very
1497  // end of the function by FinishFunction.
1498  TerminateHandler = createBasicBlock("terminate.handler");
1499  CGBuilderTy::InsertPoint SavedIP = Builder.saveAndClearIP();
1500  Builder.SetInsertPoint(TerminateHandler);
1501 
1502  llvm::Value *Exn = nullptr;
1503  if (getLangOpts().CPlusPlus)
1504  Exn = getExceptionFromSlot();
1505  llvm::CallInst *terminateCall =
1506  CGM.getCXXABI().emitTerminateForUnexpectedException(*this, Exn);
1507  terminateCall->setDoesNotReturn();
1508  Builder.CreateUnreachable();
1509 
1510  // Restore the saved insertion state.
1511  Builder.restoreIP(SavedIP);
1512 
1513  return TerminateHandler;
1514 }
1515 
1517  assert(EHPersonality::get(*this).usesFuncletPads() &&
1518  "use getTerminateLandingPad for non-funclet EH");
1519 
1520  llvm::BasicBlock *&TerminateFunclet = TerminateFunclets[CurrentFuncletPad];
1521  if (TerminateFunclet)
1522  return TerminateFunclet;
1523 
1524  CGBuilderTy::InsertPoint SavedIP = Builder.saveAndClearIP();
1525 
1526  // Set up the terminate handler. This block is inserted at the very
1527  // end of the function by FinishFunction.
1528  TerminateFunclet = createBasicBlock("terminate.handler");
1529  Builder.SetInsertPoint(TerminateFunclet);
1530 
1531  // Create the cleanuppad using the current parent pad as its token. Use 'none'
1532  // if this is a top-level terminate scope, which is the common case.
1533  SaveAndRestore<llvm::Instruction *> RestoreCurrentFuncletPad(
1534  CurrentFuncletPad);
1535  llvm::Value *ParentPad = CurrentFuncletPad;
1536  if (!ParentPad)
1537  ParentPad = llvm::ConstantTokenNone::get(CGM.getLLVMContext());
1538  CurrentFuncletPad = Builder.CreateCleanupPad(ParentPad);
1539 
1540  // Emit the __std_terminate call.
1541  llvm::Value *Exn = nullptr;
1542  // In case of wasm personality, we need to pass the exception value to
1543  // __clang_call_terminate function.
1544  if (getLangOpts().CPlusPlus &&
1546  llvm::Function *GetExnFn =
1547  CGM.getIntrinsic(llvm::Intrinsic::wasm_get_exception);
1548  Exn = Builder.CreateCall(GetExnFn, CurrentFuncletPad);
1549  }
1550  llvm::CallInst *terminateCall =
1551  CGM.getCXXABI().emitTerminateForUnexpectedException(*this, Exn);
1552  terminateCall->setDoesNotReturn();
1553  Builder.CreateUnreachable();
1554 
1555  // Restore the saved insertion state.
1556  Builder.restoreIP(SavedIP);
1557 
1558  return TerminateFunclet;
1559 }
1560 
1561 llvm::BasicBlock *CodeGenFunction::getEHResumeBlock(bool isCleanup) {
1562  if (EHResumeBlock) return EHResumeBlock;
1563 
1564  CGBuilderTy::InsertPoint SavedIP = Builder.saveIP();
1565 
1566  // We emit a jump to a notional label at the outermost unwind state.
1567  EHResumeBlock = createBasicBlock("eh.resume");
1568  Builder.SetInsertPoint(EHResumeBlock);
1569 
1570  const EHPersonality &Personality = EHPersonality::get(*this);
1571 
1572  // This can always be a call because we necessarily didn't find
1573  // anything on the EH stack which needs our help.
1574  const char *RethrowName = Personality.CatchallRethrowFn;
1575  if (RethrowName != nullptr && !isCleanup) {
1576  EmitRuntimeCall(getCatchallRethrowFn(CGM, RethrowName),
1577  getExceptionFromSlot())->setDoesNotReturn();
1578  Builder.CreateUnreachable();
1579  Builder.restoreIP(SavedIP);
1580  return EHResumeBlock;
1581  }
1582 
1583  // Recreate the landingpad's return value for the 'resume' instruction.
1584  llvm::Value *Exn = getExceptionFromSlot();
1585  llvm::Value *Sel = getSelectorFromSlot();
1586 
1587  llvm::Type *LPadType = llvm::StructType::get(Exn->getType(), Sel->getType());
1588  llvm::Value *LPadVal = llvm::UndefValue::get(LPadType);
1589  LPadVal = Builder.CreateInsertValue(LPadVal, Exn, 0, "lpad.val");
1590  LPadVal = Builder.CreateInsertValue(LPadVal, Sel, 1, "lpad.val");
1591 
1592  Builder.CreateResume(LPadVal);
1593  Builder.restoreIP(SavedIP);
1594  return EHResumeBlock;
1595 }
1596 
1598  EnterSEHTryStmt(S);
1599  {
1600  JumpDest TryExit = getJumpDestInCurrentScope("__try.__leave");
1601 
1602  SEHTryEpilogueStack.push_back(&TryExit);
1603  EmitStmt(S.getTryBlock());
1604  SEHTryEpilogueStack.pop_back();
1605 
1606  if (!TryExit.getBlock()->use_empty())
1607  EmitBlock(TryExit.getBlock(), /*IsFinished=*/true);
1608  else
1609  delete TryExit.getBlock();
1610  }
1611  ExitSEHTryStmt(S);
1612 }
1613 
1614 namespace {
1615 struct PerformSEHFinally final : EHScopeStack::Cleanup {
1616  llvm::Function *OutlinedFinally;
1617  PerformSEHFinally(llvm::Function *OutlinedFinally)
1618  : OutlinedFinally(OutlinedFinally) {}
1619 
1620  void Emit(CodeGenFunction &CGF, Flags F) override {
1621  ASTContext &Context = CGF.getContext();
1622  CodeGenModule &CGM = CGF.CGM;
1623 
1624  CallArgList Args;
1625 
1626  // Compute the two argument values.
1627  QualType ArgTys[2] = {Context.UnsignedCharTy, Context.VoidPtrTy};
1628  llvm::Value *FP = nullptr;
1629  // If CFG.IsOutlinedSEHHelper is true, then we are within a finally block.
1630  if (CGF.IsOutlinedSEHHelper) {
1631  FP = &CGF.CurFn->arg_begin()[1];
1632  } else {
1633  llvm::Function *LocalAddrFn =
1634  CGM.getIntrinsic(llvm::Intrinsic::localaddress);
1635  FP = CGF.Builder.CreateCall(LocalAddrFn);
1636  }
1637 
1638  llvm::Value *IsForEH =
1639  llvm::ConstantInt::get(CGF.ConvertType(ArgTys[0]), F.isForEHCleanup());
1640  Args.add(RValue::get(IsForEH), ArgTys[0]);
1641  Args.add(RValue::get(FP), ArgTys[1]);
1642 
1643  // Arrange a two-arg function info and type.
1644  const CGFunctionInfo &FnInfo =
1645  CGM.getTypes().arrangeBuiltinFunctionCall(Context.VoidTy, Args);
1646 
1647  auto Callee = CGCallee::forDirect(OutlinedFinally);
1648  CGF.EmitCall(FnInfo, Callee, ReturnValueSlot(), Args);
1649  }
1650 };
1651 } // end anonymous namespace
1652 
1653 namespace {
1654 /// Find all local variable captures in the statement.
1655 struct CaptureFinder : ConstStmtVisitor<CaptureFinder> {
1656  CodeGenFunction &ParentCGF;
1657  const VarDecl *ParentThis;
1659  Address SEHCodeSlot = Address::invalid();
1660  CaptureFinder(CodeGenFunction &ParentCGF, const VarDecl *ParentThis)
1661  : ParentCGF(ParentCGF), ParentThis(ParentThis) {}
1662 
1663  // Return true if we need to do any capturing work.
1664  bool foundCaptures() {
1665  return !Captures.empty() || SEHCodeSlot.isValid();
1666  }
1667 
1668  void Visit(const Stmt *S) {
1669  // See if this is a capture, then recurse.
1671  for (const Stmt *Child : S->children())
1672  if (Child)
1673  Visit(Child);
1674  }
1675 
1676  void VisitDeclRefExpr(const DeclRefExpr *E) {
1677  // If this is already a capture, just make sure we capture 'this'.
1679  Captures.insert(ParentThis);
1680  return;
1681  }
1682 
1683  const auto *D = dyn_cast<VarDecl>(E->getDecl());
1684  if (D && D->isLocalVarDeclOrParm() && D->hasLocalStorage())
1685  Captures.insert(D);
1686  }
1687 
1688  void VisitCXXThisExpr(const CXXThisExpr *E) {
1689  Captures.insert(ParentThis);
1690  }
1691 
1692  void VisitCallExpr(const CallExpr *E) {
1693  // We only need to add parent frame allocations for these builtins in x86.
1694  if (ParentCGF.getTarget().getTriple().getArch() != llvm::Triple::x86)
1695  return;
1696 
1697  unsigned ID = E->getBuiltinCallee();
1698  switch (ID) {
1699  case Builtin::BI__exception_code:
1700  case Builtin::BI_exception_code:
1701  // This is the simple case where we are the outermost finally. All we
1702  // have to do here is make sure we escape this and recover it in the
1703  // outlined handler.
1704  if (!SEHCodeSlot.isValid())
1705  SEHCodeSlot = ParentCGF.SEHCodeSlotStack.back();
1706  break;
1707  }
1708  }
1709 };
1710 } // end anonymous namespace
1711 
1713  Address ParentVar,
1714  llvm::Value *ParentFP) {
1715  llvm::CallInst *RecoverCall = nullptr;
1716  CGBuilderTy Builder(*this, AllocaInsertPt);
1717  if (auto *ParentAlloca = dyn_cast<llvm::AllocaInst>(ParentVar.getPointer())) {
1718  // Mark the variable escaped if nobody else referenced it and compute the
1719  // localescape index.
1720  auto InsertPair = ParentCGF.EscapedLocals.insert(
1721  std::make_pair(ParentAlloca, ParentCGF.EscapedLocals.size()));
1722  int FrameEscapeIdx = InsertPair.first->second;
1723  // call i8* @llvm.localrecover(i8* bitcast(@parentFn), i8* %fp, i32 N)
1724  llvm::Function *FrameRecoverFn = llvm::Intrinsic::getDeclaration(
1725  &CGM.getModule(), llvm::Intrinsic::localrecover);
1726  llvm::Constant *ParentI8Fn =
1727  llvm::ConstantExpr::getBitCast(ParentCGF.CurFn, Int8PtrTy);
1728  RecoverCall = Builder.CreateCall(
1729  FrameRecoverFn, {ParentI8Fn, ParentFP,
1730  llvm::ConstantInt::get(Int32Ty, FrameEscapeIdx)});
1731 
1732  } else {
1733  // If the parent didn't have an alloca, we're doing some nested outlining.
1734  // Just clone the existing localrecover call, but tweak the FP argument to
1735  // use our FP value. All other arguments are constants.
1736  auto *ParentRecover =
1737  cast<llvm::IntrinsicInst>(ParentVar.getPointer()->stripPointerCasts());
1738  assert(ParentRecover->getIntrinsicID() == llvm::Intrinsic::localrecover &&
1739  "expected alloca or localrecover in parent LocalDeclMap");
1740  RecoverCall = cast<llvm::CallInst>(ParentRecover->clone());
1741  RecoverCall->setArgOperand(1, ParentFP);
1742  RecoverCall->insertBefore(AllocaInsertPt);
1743  }
1744 
1745  // Bitcast the variable, rename it, and insert it in the local decl map.
1746  llvm::Value *ChildVar =
1747  Builder.CreateBitCast(RecoverCall, ParentVar.getType());
1748  ChildVar->setName(ParentVar.getName());
1749  return Address(ChildVar, ParentVar.getAlignment());
1750 }
1751 
1753  const Stmt *OutlinedStmt,
1754  bool IsFilter) {
1755  // Find all captures in the Stmt.
1756  CaptureFinder Finder(ParentCGF, ParentCGF.CXXABIThisDecl);
1757  Finder.Visit(OutlinedStmt);
1758 
1759  // We can exit early on x86_64 when there are no captures. We just have to
1760  // save the exception code in filters so that __exception_code() works.
1761  if (!Finder.foundCaptures() &&
1762  CGM.getTarget().getTriple().getArch() != llvm::Triple::x86) {
1763  if (IsFilter)
1764  EmitSEHExceptionCodeSave(ParentCGF, nullptr, nullptr);
1765  return;
1766  }
1767 
1768  llvm::Value *EntryFP = nullptr;
1769  CGBuilderTy Builder(CGM, AllocaInsertPt);
1770  if (IsFilter && CGM.getTarget().getTriple().getArch() == llvm::Triple::x86) {
1771  // 32-bit SEH filters need to be careful about FP recovery. The end of the
1772  // EH registration is passed in as the EBP physical register. We can
1773  // recover that with llvm.frameaddress(1).
1774  EntryFP = Builder.CreateCall(
1775  CGM.getIntrinsic(llvm::Intrinsic::frameaddress), {Builder.getInt32(1)});
1776  } else {
1777  // Otherwise, for x64 and 32-bit finally functions, the parent FP is the
1778  // second parameter.
1779  auto AI = CurFn->arg_begin();
1780  ++AI;
1781  EntryFP = &*AI;
1782  }
1783 
1784  llvm::Value *ParentFP = EntryFP;
1785  if (IsFilter) {
1786  // Given whatever FP the runtime provided us in EntryFP, recover the true
1787  // frame pointer of the parent function. We only need to do this in filters,
1788  // since finally funclets recover the parent FP for us.
1789  llvm::Function *RecoverFPIntrin =
1790  CGM.getIntrinsic(llvm::Intrinsic::eh_recoverfp);
1791  llvm::Constant *ParentI8Fn =
1792  llvm::ConstantExpr::getBitCast(ParentCGF.CurFn, Int8PtrTy);
1793  ParentFP = Builder.CreateCall(RecoverFPIntrin, {ParentI8Fn, EntryFP});
1794  }
1795 
1796  // Create llvm.localrecover calls for all captures.
1797  for (const VarDecl *VD : Finder.Captures) {
1798  if (isa<ImplicitParamDecl>(VD)) {
1799  CGM.ErrorUnsupported(VD, "'this' captured by SEH");
1800  CXXThisValue = llvm::UndefValue::get(ConvertTypeForMem(VD->getType()));
1801  continue;
1802  }
1803  if (VD->getType()->isVariablyModifiedType()) {
1804  CGM.ErrorUnsupported(VD, "VLA captured by SEH");
1805  continue;
1806  }
1807  assert((isa<ImplicitParamDecl>(VD) || VD->isLocalVarDeclOrParm()) &&
1808  "captured non-local variable");
1809 
1810  // If this decl hasn't been declared yet, it will be declared in the
1811  // OutlinedStmt.
1812  auto I = ParentCGF.LocalDeclMap.find(VD);
1813  if (I == ParentCGF.LocalDeclMap.end())
1814  continue;
1815 
1816  Address ParentVar = I->second;
1817  setAddrOfLocalVar(
1818  VD, recoverAddrOfEscapedLocal(ParentCGF, ParentVar, ParentFP));
1819  }
1820 
1821  if (Finder.SEHCodeSlot.isValid()) {
1822  SEHCodeSlotStack.push_back(
1823  recoverAddrOfEscapedLocal(ParentCGF, Finder.SEHCodeSlot, ParentFP));
1824  }
1825 
1826  if (IsFilter)
1827  EmitSEHExceptionCodeSave(ParentCGF, ParentFP, EntryFP);
1828 }
1829 
1830 /// Arrange a function prototype that can be called by Windows exception
1831 /// handling personalities. On Win64, the prototype looks like:
1832 /// RetTy func(void *EHPtrs, void *ParentFP);
1834  bool IsFilter,
1835  const Stmt *OutlinedStmt) {
1836  SourceLocation StartLoc = OutlinedStmt->getBeginLoc();
1837 
1838  // Get the mangled function name.
1839  SmallString<128> Name;
1840  {
1841  llvm::raw_svector_ostream OS(Name);
1842  const NamedDecl *ParentSEHFn = ParentCGF.CurSEHParent;
1843  assert(ParentSEHFn && "No CurSEHParent!");
1844  MangleContext &Mangler = CGM.getCXXABI().getMangleContext();
1845  if (IsFilter)
1846  Mangler.mangleSEHFilterExpression(ParentSEHFn, OS);
1847  else
1848  Mangler.mangleSEHFinallyBlock(ParentSEHFn, OS);
1849  }
1850 
1851  FunctionArgList Args;
1852  if (CGM.getTarget().getTriple().getArch() != llvm::Triple::x86 || !IsFilter) {
1853  // All SEH finally functions take two parameters. Win64 filters take two
1854  // parameters. Win32 filters take no parameters.
1855  if (IsFilter) {
1856  Args.push_back(ImplicitParamDecl::Create(
1857  getContext(), /*DC=*/nullptr, StartLoc,
1858  &getContext().Idents.get("exception_pointers"),
1860  } else {
1861  Args.push_back(ImplicitParamDecl::Create(
1862  getContext(), /*DC=*/nullptr, StartLoc,
1863  &getContext().Idents.get("abnormal_termination"),
1865  }
1866  Args.push_back(ImplicitParamDecl::Create(
1867  getContext(), /*DC=*/nullptr, StartLoc,
1868  &getContext().Idents.get("frame_pointer"), getContext().VoidPtrTy,
1870  }
1871 
1872  QualType RetTy = IsFilter ? getContext().LongTy : getContext().VoidTy;
1873 
1874  const CGFunctionInfo &FnInfo =
1875  CGM.getTypes().arrangeBuiltinFunctionDeclaration(RetTy, Args);
1876 
1877  llvm::FunctionType *FnTy = CGM.getTypes().GetFunctionType(FnInfo);
1878  llvm::Function *Fn = llvm::Function::Create(
1879  FnTy, llvm::GlobalValue::InternalLinkage, Name.str(), &CGM.getModule());
1880 
1881  IsOutlinedSEHHelper = true;
1882 
1883  StartFunction(GlobalDecl(), RetTy, Fn, FnInfo, Args,
1884  OutlinedStmt->getBeginLoc(), OutlinedStmt->getBeginLoc());
1885  CurSEHParent = ParentCGF.CurSEHParent;
1886 
1887  CGM.SetLLVMFunctionAttributes(GlobalDecl(), FnInfo, CurFn);
1888  EmitCapturedLocals(ParentCGF, OutlinedStmt, IsFilter);
1889 }
1890 
1891 /// Create a stub filter function that will ultimately hold the code of the
1892 /// filter expression. The EH preparation passes in LLVM will outline the code
1893 /// from the main function body into this stub.
1894 llvm::Function *
1896  const SEHExceptStmt &Except) {
1897  const Expr *FilterExpr = Except.getFilterExpr();
1898  startOutlinedSEHHelper(ParentCGF, true, FilterExpr);
1899 
1900  // Emit the original filter expression, convert to i32, and return.
1901  llvm::Value *R = EmitScalarExpr(FilterExpr);
1902  R = Builder.CreateIntCast(R, ConvertType(getContext().LongTy),
1903  FilterExpr->getType()->isSignedIntegerType());
1904  Builder.CreateStore(R, ReturnValue);
1905 
1906  FinishFunction(FilterExpr->getEndLoc());
1907 
1908  return CurFn;
1909 }
1910 
1911 llvm::Function *
1913  const SEHFinallyStmt &Finally) {
1914  const Stmt *FinallyBlock = Finally.getBlock();
1915  startOutlinedSEHHelper(ParentCGF, false, FinallyBlock);
1916 
1917  // Emit the original filter expression, convert to i32, and return.
1918  EmitStmt(FinallyBlock);
1919 
1920  FinishFunction(FinallyBlock->getEndLoc());
1921 
1922  return CurFn;
1923 }
1924 
1926  llvm::Value *ParentFP,
1927  llvm::Value *EntryFP) {
1928  // Get the pointer to the EXCEPTION_POINTERS struct. This is returned by the
1929  // __exception_info intrinsic.
1930  if (CGM.getTarget().getTriple().getArch() != llvm::Triple::x86) {
1931  // On Win64, the info is passed as the first parameter to the filter.
1932  SEHInfo = &*CurFn->arg_begin();
1933  SEHCodeSlotStack.push_back(
1934  CreateMemTemp(getContext().IntTy, "__exception_code"));
1935  } else {
1936  // On Win32, the EBP on entry to the filter points to the end of an
1937  // exception registration object. It contains 6 32-bit fields, and the info
1938  // pointer is stored in the second field. So, GEP 20 bytes backwards and
1939  // load the pointer.
1940  SEHInfo = Builder.CreateConstInBoundsGEP1_32(Int8Ty, EntryFP, -20);
1941  SEHInfo = Builder.CreateBitCast(SEHInfo, Int8PtrTy->getPointerTo());
1942  SEHInfo = Builder.CreateAlignedLoad(Int8PtrTy, SEHInfo, getPointerAlign());
1943  SEHCodeSlotStack.push_back(recoverAddrOfEscapedLocal(
1944  ParentCGF, ParentCGF.SEHCodeSlotStack.back(), ParentFP));
1945  }
1946 
1947  // Save the exception code in the exception slot to unify exception access in
1948  // the filter function and the landing pad.
1949  // struct EXCEPTION_POINTERS {
1950  // EXCEPTION_RECORD *ExceptionRecord;
1951  // CONTEXT *ContextRecord;
1952  // };
1953  // int exceptioncode = exception_pointers->ExceptionRecord->ExceptionCode;
1954  llvm::Type *RecordTy = CGM.Int32Ty->getPointerTo();
1955  llvm::Type *PtrsTy = llvm::StructType::get(RecordTy, CGM.VoidPtrTy);
1956  llvm::Value *Ptrs = Builder.CreateBitCast(SEHInfo, PtrsTy->getPointerTo());
1957  llvm::Value *Rec = Builder.CreateStructGEP(PtrsTy, Ptrs, 0);
1958  Rec = Builder.CreateAlignedLoad(Rec, getPointerAlign());
1959  llvm::Value *Code = Builder.CreateAlignedLoad(Rec, getIntAlign());
1960  assert(!SEHCodeSlotStack.empty() && "emitting EH code outside of __except");
1961  Builder.CreateStore(Code, SEHCodeSlotStack.back());
1962 }
1963 
1965  // Sema should diagnose calling this builtin outside of a filter context, but
1966  // don't crash if we screw up.
1967  if (!SEHInfo)
1968  return llvm::UndefValue::get(Int8PtrTy);
1969  assert(SEHInfo->getType() == Int8PtrTy);
1970  return SEHInfo;
1971 }
1972 
1974  assert(!SEHCodeSlotStack.empty() && "emitting EH code outside of __except");
1975  return Builder.CreateLoad(SEHCodeSlotStack.back());
1976 }
1977 
1979  // Abnormal termination is just the first parameter to the outlined finally
1980  // helper.
1981  auto AI = CurFn->arg_begin();
1982  return Builder.CreateZExt(&*AI, Int32Ty);
1983 }
1984 
1986  llvm::Function *FinallyFunc) {
1987  EHStack.pushCleanup<PerformSEHFinally>(Kind, FinallyFunc);
1988 }
1989 
1991  CodeGenFunction HelperCGF(CGM, /*suppressNewContext=*/true);
1992  if (const SEHFinallyStmt *Finally = S.getFinallyHandler()) {
1993  // Outline the finally block.
1994  llvm::Function *FinallyFunc =
1995  HelperCGF.GenerateSEHFinallyFunction(*this, *Finally);
1996 
1997  // Push a cleanup for __finally blocks.
1998  EHStack.pushCleanup<PerformSEHFinally>(NormalAndEHCleanup, FinallyFunc);
1999  return;
2000  }
2001 
2002  // Otherwise, we must have an __except block.
2003  const SEHExceptStmt *Except = S.getExceptHandler();
2004  assert(Except);
2005  EHCatchScope *CatchScope = EHStack.pushCatch(1);
2006  SEHCodeSlotStack.push_back(
2007  CreateMemTemp(getContext().IntTy, "__exception_code"));
2008 
2009  // If the filter is known to evaluate to 1, then we can use the clause
2010  // "catch i8* null". We can't do this on x86 because the filter has to save
2011  // the exception code.
2012  llvm::Constant *C =
2014  getContext().IntTy);
2015  if (CGM.getTarget().getTriple().getArch() != llvm::Triple::x86 && C &&
2016  C->isOneValue()) {
2017  CatchScope->setCatchAllHandler(0, createBasicBlock("__except"));
2018  return;
2019  }
2020 
2021  // In general, we have to emit an outlined filter function. Use the function
2022  // in place of the RTTI typeinfo global that C++ EH uses.
2023  llvm::Function *FilterFunc =
2024  HelperCGF.GenerateSEHFilterFunction(*this, *Except);
2025  llvm::Constant *OpaqueFunc =
2026  llvm::ConstantExpr::getBitCast(FilterFunc, Int8PtrTy);
2027  CatchScope->setHandler(0, OpaqueFunc, createBasicBlock("__except.ret"));
2028 }
2029 
2031  // Just pop the cleanup if it's a __finally block.
2032  if (S.getFinallyHandler()) {
2033  PopCleanupBlock();
2034  return;
2035  }
2036 
2037  // Otherwise, we must have an __except block.
2038  const SEHExceptStmt *Except = S.getExceptHandler();
2039  assert(Except && "__try must have __finally xor __except");
2040  EHCatchScope &CatchScope = cast<EHCatchScope>(*EHStack.begin());
2041 
2042  // Don't emit the __except block if the __try block lacked invokes.
2043  // TODO: Model unwind edges from instructions, either with iload / istore or
2044  // a try body function.
2045  if (!CatchScope.hasEHBranches()) {
2046  CatchScope.clearHandlerBlocks();
2047  EHStack.popCatch();
2048  SEHCodeSlotStack.pop_back();
2049  return;
2050  }
2051 
2052  // The fall-through block.
2053  llvm::BasicBlock *ContBB = createBasicBlock("__try.cont");
2054 
2055  // We just emitted the body of the __try; jump to the continue block.
2056  if (HaveInsertPoint())
2057  Builder.CreateBr(ContBB);
2058 
2059  // Check if our filter function returned true.
2060  emitCatchDispatchBlock(*this, CatchScope);
2061 
2062  // Grab the block before we pop the handler.
2063  llvm::BasicBlock *CatchPadBB = CatchScope.getHandler(0).Block;
2064  EHStack.popCatch();
2065 
2066  EmitBlockAfterUses(CatchPadBB);
2067 
2068  // __except blocks don't get outlined into funclets, so immediately do a
2069  // catchret.
2070  llvm::CatchPadInst *CPI =
2071  cast<llvm::CatchPadInst>(CatchPadBB->getFirstNonPHI());
2072  llvm::BasicBlock *ExceptBB = createBasicBlock("__except");
2073  Builder.CreateCatchRet(CPI, ExceptBB);
2074  EmitBlock(ExceptBB);
2075 
2076  // On Win64, the exception code is returned in EAX. Copy it into the slot.
2077  if (CGM.getTarget().getTriple().getArch() != llvm::Triple::x86) {
2078  llvm::Function *SEHCodeIntrin =
2079  CGM.getIntrinsic(llvm::Intrinsic::eh_exceptioncode);
2080  llvm::Value *Code = Builder.CreateCall(SEHCodeIntrin, {CPI});
2081  Builder.CreateStore(Code, SEHCodeSlotStack.back());
2082  }
2083 
2084  // Emit the __except body.
2085  EmitStmt(Except->getBlock());
2086 
2087  // End the lifetime of the exception code.
2088  SEHCodeSlotStack.pop_back();
2089 
2090  if (HaveInsertPoint())
2091  Builder.CreateBr(ContBB);
2092 
2093  EmitBlock(ContBB);
2094 }
2095 
2097  // If this code is reachable then emit a stop point (if generating
2098  // debug info). We have to do this ourselves because we are on the
2099  // "simple" statement path.
2100  if (HaveInsertPoint())
2101  EmitStopPoint(&S);
2102 
2103  // This must be a __leave from a __finally block, which we warn on and is UB.
2104  // Just emit unreachable.
2105  if (!isSEHTryScope()) {
2106  Builder.CreateUnreachable();
2107  Builder.ClearInsertionPoint();
2108  return;
2109  }
2110 
2111  EmitBranchThroughCleanup(*SEHTryEpilogueStack.back());
2112 }
virtual void mangleSEHFilterExpression(const NamedDecl *EnclosingDecl, raw_ostream &Out)=0
const llvm::DataLayout & getDataLayout() const
ReturnValueSlot - Contains the address where the return value of a function can be stored...
Definition: CGCall.h:363
static llvm::FunctionCallee getFreeExceptionFn(CodeGenModule &CGM)
Definition: CGException.cpp:31
Represents a function declaration or definition.
Definition: Decl.h:1737
llvm::IntegerType * IntTy
int
EHScopeStack::stable_iterator getEnclosingEHScope() const
Definition: CGCleanup.h:137
Other implicit parameter.
Definition: Decl.h:1509
CompoundStmt * getBlock() const
Definition: Stmt.h:3029
Smart pointer class that efficiently represents Objective-C method names.
void setCatchAllHandler(unsigned I, llvm::BasicBlock *Block)
Definition: CGCleanup.h:192
CanQualType VoidPtrTy
Definition: ASTContext.h:1043
A (possibly-)qualified type.
Definition: Type.h:634
void EmitSEHLeaveStmt(const SEHLeaveStmt &S)
bool usesFuncletPads() const
Does this personality use landingpads or the family of pad instructions designed to form funclets...
Definition: CGCleanup.h:633
unsigned getNumExceptions() const
Return the number of types in the exception specification.
Definition: Type.h:3953
const Expr * getSubExpr() const
Definition: ExprCXX.h:1036
ConstStmtVisitor - This class implements a simple visitor for Stmt subclasses.
Definition: StmtVisitor.h:192
llvm::BasicBlock * getCachedEHDispatchBlock() const
Definition: CGCleanup.h:123
bool HaveInsertPoint() const
HaveInsertPoint - True if an insertion point is defined.
llvm::LLVMContext & getLLVMContext()
static const EHPersonality GNU_C_SJLJ
Definition: CGCleanup.h:615
void enter(CodeGenFunction &CGF, const Stmt *Finally, llvm::FunctionCallee beginCatchFn, llvm::FunctionCallee endCatchFn, llvm::FunctionCallee rethrowFn)
Enters a finally block for an implementation using zero-cost exceptions.
void EmitCXXTryStmt(const CXXTryStmt &S)
Stmt - This represents one statement.
Definition: Stmt.h:65
CXXCatchStmt * getHandler(unsigned i)
Definition: StmtCXX.h:103
static const EHPersonality MSVC_C_specific_handler
Definition: CGCleanup.h:627
const llvm::Triple & getTriple() const
Returns the target triple of the primary target.
Definition: TargetInfo.h:962
static const EHPersonality MSVC_CxxFrameHandler3
Definition: CGCleanup.h:628
tooling::Replacements cleanup(const FormatStyle &Style, StringRef Code, ArrayRef< tooling::Range > Ranges, StringRef FileName="<stdin>")
Clean up any erroneous/redundant code in the given Ranges in Code.
Definition: Format.cpp:2227
bool hasEHBranches() const
Definition: CGCleanup.h:131
Decl - This represents one declaration (or definition), e.g.
Definition: DeclBase.h:86
Stmt * getHandlerBlock() const
Definition: StmtCXX.h:51
const Decl * CurCodeDecl
CurCodeDecl - This is the inner-most code context, which includes blocks.
static const EHPersonality GNU_C
Definition: CGCleanup.h:614
virtual void mangleSEHFinallyBlock(const NamedDecl *EnclosingDecl, raw_ostream &Out)=0
QualType getNonReferenceType() const
If Type is a reference type (e.g., const int&), returns the type that the reference refers to ("const...
Definition: Type.h:6250
Represents Objective-C&#39;s @throw statement.
Definition: StmtObjC.h:312
CanQualType LongTy
Definition: ASTContext.h:1024
void EmitSEHExceptionCodeSave(CodeGenFunction &ParentCGF, llvm::Value *ParentFP, llvm::Value *EntryEBP)
bool usesSEHTry() const
Indicates the function uses __try.
Definition: Decl.h:2113
static const EHPersonality & getObjCXXPersonality(const TargetInfo &Target, const LangOptions &L)
Determines the personality function to use when both C++ and Objective-C exceptions are being caught...
unsigned getNumFilters() const
Definition: CGCleanup.h:460
llvm::IntegerType * Int8Ty
i8, i16, i32, and i64
&#39;gcc&#39; is the Objective-C runtime shipped with GCC, implementing a fragile Objective-C ABI ...
Definition: ObjCRuntime.h:52
Represents a variable declaration or definition.
Definition: Decl.h:812
const T * getAs() const
Member-template getAs<specific type>&#39;.
Definition: Type.h:6761
llvm::FunctionCallee getTerminateFn()
Get the declaration of std::terminate for the platform.
Definition: CGException.cpp:49
unsigned getNumHandlers() const
Definition: CGCleanup.h:188
llvm::Value * getPointer() const
Definition: Address.h:37
iterator begin() const
Returns an iterator pointing to the innermost EH scope.
Definition: CGCleanup.h:566
llvm::BasicBlock * EmitLandingPad()
Emits a landing pad for the current EH stack.
A protected scope for zero-cost EH handling.
Definition: CGCleanup.h:43
Defines the Objective-C statement AST node classes.
A C++ throw-expression (C++ [except.throw]).
Definition: ExprCXX.h:1014
static const EHPersonality & getObjCPersonality(const TargetInfo &Target, const LangOptions &L)
A scope which attempts to handle some, possibly all, types of exceptions.
Definition: CGCleanup.h:147
The collection of all-type qualifiers we support.
Definition: Type.h:137
void add(RValue rvalue, QualType type)
Definition: CGCall.h:287
A jump destination is an abstract label, branching to which may require a jump out through normal cle...
bool isNoexceptExceptionSpec(ExceptionSpecificationType ESpecType)
void popCatchScope()
popCatchScope - Pops the catch scope at the top of the EHScope stack, emitting any required code (oth...
const TargetInfo & getTarget() const
llvm::BasicBlock * getTerminateHandler()
getTerminateHandler - Return a handler (not a landing pad, just a catch handler) that just calls term...
&#39;macosx-fragile&#39; is the Apple-provided NeXT-derived runtime on Mac OS X platforms that use the fragil...
Definition: ObjCRuntime.h:39
const char * CatchallRethrowFn
Definition: CGCleanup.h:609
CodeGenFunction - This class organizes the per-function state that is used while generating LLVM code...
Holds long-lived AST nodes (such as types and decls) that can be referred to throughout the semantic ...
Definition: ASTContext.h:154
QualType getCaughtType() const
Definition: StmtCXX.cpp:19
SmallVector< Address, 1 > SEHCodeSlotStack
A stack of exception code slots.
SourceLocation getBeginLoc() const LLVM_READONLY
Definition: Stmt.cpp:263
static const EHPersonality GNU_CPlusPlus_SJLJ
Definition: CGCleanup.h:624
Denotes a cleanup that should run when a scope is exited using exceptional control flow (a throw stat...
Definition: EHScopeStack.h:80
static const EHPersonality & get(CodeGenModule &CGM, const FunctionDecl *FD)
Keeps track of the various options that can be enabled, which controls the dialect of C or C++ that i...
Definition: LangOptions.h:49
Address getExceptionSlot()
Returns a pointer to the function&#39;s exception object and selector slot, which is assigned in every la...
void setFilter(unsigned i, llvm::Value *filterValue)
Definition: CGCleanup.h:462
class EHCatchScope * pushCatch(unsigned NumHandlers)
Push a set of catch handlers on the stack.
Definition: CGCleanup.cpp:244
bool isNeXTFamily() const
Is this runtime basically of the NeXT family of runtimes?
Definition: ObjCRuntime.h:134
static llvm::Constant * getCatchAllValue(CodeGenFunction &CGF)
Returns the value to inject into a selector to indicate the presence of a catch-all.
void ExitSEHTryStmt(const SEHTryStmt &S)
llvm::CallInst * EmitRuntimeCall(llvm::FunctionCallee callee, const Twine &name="")
QualType getExceptionType(unsigned i) const
Return the ith exception type, where 0 <= i < getNumExceptions().
Definition: Type.h:3961
iterator begin() const
Definition: CGCleanup.h:223
CharUnits getAlignment() const
Return the alignment of this pointer.
Definition: Address.h:66
child_range children()
Definition: Stmt.cpp:212
const Handler & getHandler(unsigned I) const
Definition: CGCleanup.h:208
static llvm::FunctionCallee getUnexpectedFn(CodeGenModule &CGM)
Definition: CGException.cpp:40
static const EHPersonality GNUstep_ObjC
Definition: CGCleanup.h:620
bool IsOutlinedSEHHelper
True if the current function is an outlined SEH helper.
llvm::BasicBlock * getInvokeDestImpl()
llvm::Function * GenerateSEHFinallyFunction(CodeGenFunction &ParentCGF, const SEHFinallyStmt &Finally)
llvm::BasicBlock * createBasicBlock(const Twine &name="", llvm::Function *parent=nullptr, llvm::BasicBlock *before=nullptr)
createBasicBlock - Create an LLVM basic block.
Denotes a cleanup that should run when a scope is exited using normal control flow (falling off the e...
Definition: EHScopeStack.h:84
void ForceCleanup(std::initializer_list< llvm::Value **> ValuesToReload={})
Force the emission of cleanups now, instead of waiting until this object is destroyed.
Represents the body of a CapturedStmt, and serves as its DeclContext.
Definition: Decl.h:4043
llvm::AllocaInst * CreateTempAlloca(llvm::Type *Ty, const Twine &Name="tmp", llvm::Value *ArraySize=nullptr)
CreateTempAlloca - This creates an alloca and inserts it into the entry block if ArraySize is nullptr...
Definition: CGExpr.cpp:105
CanQualType UnsignedCharTy
Definition: ASTContext.h:1025
Represents the this expression in C++.
Definition: ExprCXX.h:975
static ImplicitParamDecl * Create(ASTContext &C, DeclContext *DC, SourceLocation IdLoc, IdentifierInfo *Id, QualType T, ImplicitParamKind ParamKind)
Create implicit parameter.
Definition: Decl.cpp:4409
&#39;watchos&#39; is a variant of iOS for Apple&#39;s watchOS.
Definition: ObjCRuntime.h:48
bool isValid() const
Definition: Address.h:35
static const EHPersonality & getCPersonality(const TargetInfo &Target, const LangOptions &L)
Represents a prototype with parameter type info, e.g.
Definition: Type.h:3692
static const EHPersonality MSVC_except_handler
Definition: CGCleanup.h:626
static llvm::Constant * getOpaquePersonalityFn(CodeGenModule &CGM, const EHPersonality &Personality)
Exposes information about the current target.
Definition: TargetInfo.h:161
CatchTypeInfo Type
A type info value, or null (C++ null, not an LLVM null pointer) for a catch-all.
Definition: CGCleanup.h:157
void EmitCapturedLocals(CodeGenFunction &ParentCGF, const Stmt *OutlinedStmt, bool IsFilter)
Scan the outlined statement for captures from the parent function.
This represents one expression.
Definition: Expr.h:108
static bool PersonalityHasOnlyCXXUses(llvm::Constant *Fn)
Check whether a personality function could reasonably be swapped for a C++ personality function...
static llvm::FunctionCallee getPersonalityFn(CodeGenModule &CGM, const EHPersonality &Personality)
&#39;macosx&#39; is the Apple-provided NeXT-derived runtime on Mac OS X platforms that use the non-fragile AB...
Definition: ObjCRuntime.h:34
static Address invalid()
Definition: Address.h:34
Enters a new scope for capturing cleanups, all of which will be executed once the scope is exited...
llvm::Function * GenerateSEHFilterFunction(CodeGenFunction &ParentCGF, const SEHExceptStmt &Except)
Create a stub filter function that will ultimately hold the code of the filter expression.
static CGCallee forDirect(llvm::Constant *functionPtr, const CGCalleeInfo &abstractInfo=CGCalleeInfo())
Definition: CGCall.h:133
VarDecl * getExceptionDecl() const
Definition: StmtCXX.h:49
llvm::PointerType * getType() const
Return the type of the pointer value.
Definition: Address.h:43
void EmitSEHTryStmt(const SEHTryStmt &S)
void pushSEHCleanup(CleanupKind kind, llvm::Function *FinallyFunc)
llvm::BasicBlock * Block
The catch handler for this type.
Definition: CGCleanup.h:160
static CharUnits fromQuantity(QuantityType Quantity)
fromQuantity - Construct a CharUnits quantity from a raw integer type.
Definition: CharUnits.h:62
CXXTryStmt - A C++ try block, including all handlers.
Definition: StmtCXX.h:64
bool refersToEnclosingVariableOrCapture() const
Does this DeclRefExpr refer to an enclosing local or a captured variable?
Definition: Expr.h:1272
llvm::Value * getExceptionFromSlot()
Returns the contents of the function&#39;s exception object and selector slots.
static void emitCatchDispatchBlock(CodeGenFunction &CGF, EHCatchScope &catchScope)
Emit the structure of the dispatch block for the given catch scope.
llvm::LLVMContext & getLLVMContext()
const CGFunctionInfo & arrangeBuiltinFunctionCall(QualType resultType, const CallArgList &args)
Definition: CGCall.cpp:647
bool isSignedIntegerType() const
Return true if this is an integer type that is signed, according to C99 6.2.5p4 [char, signed char, short, int, long..], or an enum decl which has a signed representation.
Definition: Type.cpp:1866
QualType getType() const
Definition: Expr.h:130
static const EHPersonality GNU_ObjCXX
Definition: CGCleanup.h:621
bool hasTerminate() const
Does this runtime provide an objc_terminate function?
Definition: ObjCRuntime.h:347
clang::ObjCRuntime ObjCRuntime
Definition: LangOptions.h:206
static const EHPersonality GNU_ObjC_SEH
Definition: CGCleanup.h:619
const TargetInfo & getTarget() const
ValueDecl * getDecl()
Definition: Expr.h:1147
&#39;gnustep&#39; is the modern non-fragile GNUstep runtime.
Definition: ObjCRuntime.h:55
const LangOptions & getLangOpts() const
ASTContext & getContext() const
llvm::StoreInst * CreateFlagStore(bool Value, llvm::Value *Addr)
Emit a store to an i1 flag variable.
Definition: CGBuilder.h:135
static llvm::FunctionCallee getCatchallRethrowFn(CodeGenModule &CGM, StringRef Name)
Definition: CGException.cpp:75
GlobalDecl - represents a global declaration.
Definition: GlobalDecl.h:34
SourceLocation getEndLoc() const LLVM_READONLY
Definition: Stmt.cpp:276
unsigned getBuiltinCallee() const
getBuiltinCallee - If this is a call to a builtin, return the builtin ID of the callee.
Definition: Expr.cpp:1367
llvm::BasicBlock * getEHDispatchBlock(EHScopeStack::stable_iterator scope)
The l-value was considered opaque, so the alignment was determined from a type.
static void emitFilterDispatchBlock(CodeGenFunction &CGF, EHFilterScope &filterScope)
Emit the dispatch block for a filter scope if necessary.
Address recoverAddrOfEscapedLocal(CodeGenFunction &ParentCGF, Address ParentVar, llvm::Value *ParentFP)
Recovers the address of a local in a parent function.
Enumerates target-specific builtins in their own namespaces within namespace clang.
Address CreateBitCast(Address Addr, llvm::Type *Ty, const llvm::Twine &Name="")
Definition: CGBuilder.h:141
llvm::cl::opt< std::string > Filter
Kind
Encodes a location in the source.
void EnsureInsertPoint()
EnsureInsertPoint - Ensure that an insertion point is defined so that emitted IR has a place to go...
A saved depth on the scope stack.
Definition: EHScopeStack.h:106
unsigned getNumHandlers() const
Definition: StmtCXX.h:102
bool isVariablyModifiedType() const
Whether this type is a variably-modified type (C99 6.7.5).
Definition: Type.h:2097
&#39;objfw&#39; is the Objective-C runtime included in ObjFW
Definition: ObjCRuntime.h:58
llvm::BasicBlock * getUnreachableBlock()
RValue EmitCall(const CGFunctionInfo &CallInfo, const CGCallee &Callee, ReturnValueSlot ReturnValue, const CallArgList &Args, llvm::CallBase **callOrInvoke, SourceLocation Loc)
EmitCall - Generate a call of the given function, expecting the given result type, and using the given argument list which specifies both the LLVM arguments and the types they were derived from.
Definition: CGCall.cpp:3801
Kind getKind() const
Definition: ObjCRuntime.h:76
static const EHPersonality & getCXXPersonality(const TargetInfo &Target, const LangOptions &L)
MangleContext - Context for tracking state which persists across multiple calls to the C++ name mangl...
Definition: Mangle.h:43
void EmitStmt(const Stmt *S, ArrayRef< const Attr *> Attrs=None)
EmitStmt - Emit the code for the statement.
Definition: CGStmt.cpp:44
CanQualType VoidTy
Definition: ASTContext.h:1015
bool isObjCObjectPointerType() const
Definition: Type.h:6398
An aligned address.
Definition: Address.h:24
bool isWasmPersonality() const
Definition: CGCleanup.h:642
llvm::BasicBlock * getEHResumeBlock(bool isCleanup)
void setCachedEHDispatchBlock(llvm::BasicBlock *block)
Definition: CGCleanup.h:127
llvm::Instruction * CurrentFuncletPad
llvm::Value * getFilter(unsigned i) const
Definition: CGCleanup.h:467
JumpDest getJumpDestInCurrentScope(llvm::BasicBlock *Target)
The given basic block lies in the current EH scope, but may be a target of a potentially scope-crossi...
const VersionTuple & getVersion() const
Definition: ObjCRuntime.h:77
void EmitStartEHSpec(const Decl *D)
EmitStartEHSpec - Emit the start of the exception spec.
The MS C++ ABI needs a pointer to RTTI data plus some flags to describe the type of a catch handler...
Definition: CGCleanup.h:37
ExceptionSpecificationType getExceptionSpecType() const
Get the kind of exception specification on this function.
Definition: Type.h:3927
SourceLocation getExprLoc() const LLVM_READONLY
getExprLoc - Return the preferred location for the arrow when diagnosing a problem with a generic exp...
Definition: Expr.cpp:214
static const EHPersonality NeXT_ObjC
Definition: CGCleanup.h:622
llvm::BasicBlock * getFuncletEHDispatchBlock(EHScopeStack::stable_iterator scope)
FunctionArgList - Type for representing both the decl and type of parameters to a function...
Definition: CGCall.h:358
CGFunctionInfo - Class to encapsulate the information about a function definition.
Kind getKind() const
Definition: CGCleanup.h:113
This class organizes the cross-function state that is used while generating LLVM code.
Dataflow Directional Tag Classes.
static ApplyDebugLocation CreateDefaultArtificial(CodeGenFunction &CGF, SourceLocation TemporaryLocation)
Apply TemporaryLocation if it is valid.
Definition: CGDebugInfo.h:724
static bool LandingPadHasOnlyCXXUses(llvm::LandingPadInst *LPI)
Check whether a landingpad instruction only uses C++ features.
static const EHPersonality GNU_CPlusPlus_SEH
Definition: CGCleanup.h:625
The basic abstraction for the target Objective-C runtime.
Definition: ObjCRuntime.h:27
static const EHPersonality GNU_ObjC
Definition: CGCleanup.h:617
static bool isNonEHScope(const EHScope &S)
Check whether this is a non-EH scope, i.e.
void EmitAnyExprToExn(const Expr *E, Address Addr)
llvm::LoadInst * CreateAlignedLoad(llvm::Value *Addr, CharUnits Align, const llvm::Twine &Name="")
Definition: CGBuilder.h:90
llvm::LoadInst * CreateLoad(Address Addr, const llvm::Twine &Name="")
Definition: CGBuilder.h:69
SEHExceptStmt * getExceptHandler() const
Returns 0 if not defined.
Definition: Stmt.cpp:1105
llvm::Function * getIntrinsic(unsigned IID, ArrayRef< llvm::Type *> Tys=None)
llvm::StoreInst * CreateStore(llvm::Value *Val, Address Addr, bool IsVolatile=false)
Definition: CGBuilder.h:107
llvm::Module & getModule() const
virtual bool hasFeature(StringRef Feature) const
Determine whether the given target has the given feature.
Definition: TargetInfo.h:1094
Represents a __leave statement.
Definition: Stmt.h:3089
&#39;ios&#39; is the Apple-provided NeXT-derived runtime on iOS or the iOS simulator; it is always non-fragil...
Definition: ObjCRuntime.h:44
llvm::BasicBlock * getTerminateFunclet()
getTerminateLandingPad - Return a cleanup funclet that just calls terminate.
CanThrowResult canThrow() const
Determine whether this function type has a non-throwing exception specification.
Definition: Type.cpp:3061
static const EHPersonality GNU_CPlusPlus
Definition: CGCleanup.h:623
llvm::LoadInst * CreateFlagLoad(llvm::Value *Addr, const llvm::Twine &Name="")
Emit a load from an i1 flag variable.
Definition: CGBuilder.h:128
llvm::StringRef getName() const
Return the IR name of the pointer value.
Definition: Address.h:61
static const EHPersonality GNU_ObjC_SJLJ
Definition: CGCleanup.h:618
Internal linkage, which indicates that the entity can be referred to from within the translation unit...
Definition: Linkage.h:31
ExceptionSpecificationType
The various types of exception specifications that exist in C++11.
llvm::FunctionCallee CreateRuntimeFunction(llvm::FunctionType *Ty, StringRef Name, llvm::AttributeList ExtraAttrs=llvm::AttributeList(), bool Local=false)
Create or return a runtime function declaration with the specified type and name. ...
void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false)
EmitBlock - Emit the given block.
Definition: CGStmt.cpp:450
void EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock=false)
SEHFinallyStmt * getFinallyHandler() const
Definition: Stmt.cpp:1109
static const EHPersonality & getSEHPersonalityMSVC(const llvm::Triple &T)
QualType getUnqualifiedType() const
Retrieve the unqualified variant of the given type, removing as little sugar as possible.
Definition: Type.h:6157
Expr * getFilterExpr() const
Definition: Stmt.h:2992
llvm::BasicBlock * getTerminateLandingPad()
getTerminateLandingPad - Return a landing pad that just calls terminate.
CXXCatchStmt - This represents a C++ catch block.
Definition: StmtCXX.h:28
llvm::Type * ConvertType(QualType T)
Qualifiers getQualifiers() const
Retrieve the set of qualifiers applied to this type.
Definition: Type.h:6104
static const EHPersonality GNU_C_SEH
Definition: CGCleanup.h:616
The exceptions personality for a function.
Definition: CGCleanup.h:603
llvm::Constant * RTTI
Definition: CGCleanup.h:38
CompoundStmt * getTryBlock()
Definition: StmtCXX.h:95
llvm::Value * EmitSEHAbnormalTermination()
CallExpr - Represents a function call (C99 6.5.2.2, C++ [expr.call]).
Definition: Expr.h:2429
llvm::Constant * tryEmitAbstract(const Expr *E, QualType T)
Try to emit the result of the given expression as an abstract constant.
void EnterSEHTryStmt(const SEHTryStmt &S)
void startOutlinedSEHHelper(CodeGenFunction &ParentCGF, bool IsFilter, const Stmt *OutlinedStmt)
Arrange a function prototype that can be called by Windows exception handling personalities.
CGCXXABI & getCXXABI() const
CanQualType IntTy
Definition: ASTContext.h:1024
An exceptions scope which filters exceptions thrown through it.
Definition: CGCleanup.h:437
A reference to a declared variable, function, enum, etc.
Definition: Expr.h:1074
static RValue get(llvm::Value *V)
Definition: CGValue.h:85
void ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock=false)
void EmitBranchThroughCleanup(JumpDest Dest)
EmitBranchThroughCleanup - Emit a branch from the current insert block through the normal cleanup han...
Definition: CGCleanup.cpp:1043
void EmitEndEHSpec(const Decl *D)
EmitEndEHSpec - Emit the end of the exception spec.
llvm::StoreInst * CreateAlignedStore(llvm::Value *Val, llvm::Value *Addr, CharUnits Align, bool IsVolatile=false)
Definition: CGBuilder.h:114
static const EHPersonality GNU_Wasm_CPlusPlus
Definition: CGCleanup.h:629
QualType getType() const
Definition: Decl.h:647
Information for lazily generating a cleanup.
Definition: EHScopeStack.h:146
This represents a decl that may have a name.
Definition: Decl.h:248
A non-stable pointer into the scope stack.
Definition: CGCleanup.h:502
void EmitBlockAfterUses(llvm::BasicBlock *BB)
EmitBlockAfterUses - Emit the given block somewhere hopefully near its uses, and leave the insertion ...
Definition: CGStmt.cpp:487
static void emitCatchPadBlock(CodeGenFunction &CGF, EHCatchScope &CatchScope)
llvm::CallInst * EmitNounwindRuntimeCall(llvm::FunctionCallee callee, const Twine &name="")
llvm::CallBase * EmitRuntimeCallOrInvoke(llvm::FunctionCallee callee, ArrayRef< llvm::Value *> args, const Twine &name="")
Emits a call or invoke instruction to the given runtime function.
Definition: CGCall.cpp:3761
CallArgList - Type for representing both the value and type of arguments in a call.
Definition: CGCall.h:262
void PopCleanupBlock(bool FallThroughIsBranchThrough=false)
PopCleanupBlock - Will pop the cleanup entry on the stack and process all branch fixups.
Definition: CGCleanup.cpp:644
void setHandler(unsigned I, llvm::Constant *Type, llvm::BasicBlock *Block)
Definition: CGCleanup.h:196
CompoundStmt * getTryBlock() const
Definition: Stmt.h:3069
CompoundStmt * getBlock() const
Definition: Stmt.h:2996
void EmitCXXThrowExpr(const CXXThrowExpr *E, bool KeepInsertionPoint=true)
bool isLocalVarDeclOrParm() const
Similar to isLocalVarDecl but also includes parameters.
Definition: Decl.h:1113
static OMPLinearClause * Create(const ASTContext &C, SourceLocation StartLoc, SourceLocation LParenLoc, OpenMPLinearClauseKind Modifier, SourceLocation ModifierLoc, SourceLocation ColonLoc, SourceLocation EndLoc, ArrayRef< Expr *> VL, ArrayRef< Expr *> PL, ArrayRef< Expr *> IL, Expr *Step, Expr *CalcStep, Stmt *PreInit, Expr *PostUpdate)
Creates clause with a list of variables VL and a linear step Step.
static void emitWasmCatchPadBlock(CodeGenFunction &CGF, EHCatchScope &CatchScope)