blob: 645d7a878e3b13db71dbd868f65161cf0350b4d7 [file] [log] [blame]
Hans Wennborgdcfba332015-10-06 23:40:43 +00001//===--- CGException.cpp - Emit LLVM Code for C++ exceptions ----*- C++ -*-===//
Anders Carlsson4b08db72009-10-30 01:42:31 +00002//
Chandler Carruth2946cd72019-01-19 08:50:56 +00003// 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
Anders Carlsson4b08db72009-10-30 01:42:31 +00006//
7//===----------------------------------------------------------------------===//
8//
9// This contains code dealing with C++ exception related code generation.
10//
11//===----------------------------------------------------------------------===//
12
13#include "CodeGenFunction.h"
David Majnemer442d0a22014-11-25 07:20:20 +000014#include "CGCXXABI.h"
Chandler Carruth0d9593d2015-01-14 11:29:14 +000015#include "CGCleanup.h"
Benjamin Kramer793bd552012-02-08 12:41:24 +000016#include "CGObjCRuntime.h"
John McCallde0fe072017-08-15 21:42:52 +000017#include "ConstantEmitter.h"
John McCall5add20c2010-07-20 22:17:55 +000018#include "TargetInfo.h"
Reid Kleckner1d59f992015-01-22 01:36:17 +000019#include "clang/AST/Mangle.h"
Benjamin Kramer793bd552012-02-08 12:41:24 +000020#include "clang/AST/StmtCXX.h"
Chandler Carruth4b417452013-01-19 08:09:44 +000021#include "clang/AST/StmtObjC.h"
Reid Kleckner31a1bb02015-04-08 22:23:48 +000022#include "clang/AST/StmtVisitor.h"
Reid Kleckner9fe7f232015-07-07 00:36:30 +000023#include "clang/Basic/TargetBuiltins.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000024#include "llvm/IR/Intrinsics.h"
Reid Kleckner31a1bb02015-04-08 22:23:48 +000025#include "llvm/IR/IntrinsicInst.h"
Reid Klecknerebaf28d2015-04-14 20:59:00 +000026#include "llvm/Support/SaveAndRestore.h"
John McCallbd309292010-07-06 01:34:17 +000027
Anders Carlsson4b08db72009-10-30 01:42:31 +000028using namespace clang;
29using namespace CodeGen;
30
James Y Knight9871db02019-02-05 16:42:33 +000031static llvm::FunctionCallee getFreeExceptionFn(CodeGenModule &CGM) {
Mike Stump33270212009-12-02 07:41:41 +000032 // void __cxa_free_exception(void *thrown_exception);
Mike Stump75546b82009-12-10 00:06:18 +000033
Chris Lattner2192fe52011-07-18 04:24:23 +000034 llvm::FunctionType *FTy =
Rui Ueyama49a3ad22019-07-16 04:46:31 +000035 llvm::FunctionType::get(CGM.VoidTy, CGM.Int8PtrTy, /*isVarArg=*/false);
Mike Stump75546b82009-12-10 00:06:18 +000036
John McCall2c33ba82013-02-12 03:51:38 +000037 return CGM.CreateRuntimeFunction(FTy, "__cxa_free_exception");
Mike Stump33270212009-12-02 07:41:41 +000038}
39
James Y Knight9871db02019-02-05 16:42:33 +000040static llvm::FunctionCallee getUnexpectedFn(CodeGenModule &CGM) {
Richard Smith2f7aa192013-06-20 23:03:35 +000041 // void __cxa_call_unexpected(void *thrown_exception);
Mike Stump1d849212009-12-07 23:38:24 +000042
Chris Lattner2192fe52011-07-18 04:24:23 +000043 llvm::FunctionType *FTy =
Rui Ueyama49a3ad22019-07-16 04:46:31 +000044 llvm::FunctionType::get(CGM.VoidTy, CGM.Int8PtrTy, /*isVarArg=*/false);
Mike Stump75546b82009-12-10 00:06:18 +000045
John McCall2c33ba82013-02-12 03:51:38 +000046 return CGM.CreateRuntimeFunction(FTy, "__cxa_call_unexpected");
Mike Stump1d849212009-12-07 23:38:24 +000047}
48
James Y Knight9871db02019-02-05 16:42:33 +000049llvm::FunctionCallee CodeGenModule::getTerminateFn() {
Mike Stump33270212009-12-02 07:41:41 +000050 // void __terminate();
51
Chris Lattner2192fe52011-07-18 04:24:23 +000052 llvm::FunctionType *FTy =
Rui Ueyama49a3ad22019-07-16 04:46:31 +000053 llvm::FunctionType::get(VoidTy, /*isVarArg=*/false);
Mike Stump75546b82009-12-10 00:06:18 +000054
Chris Lattner0e62c1c2011-07-23 10:55:15 +000055 StringRef name;
John McCall9de19782011-07-06 01:22:26 +000056
57 // In C++, use std::terminate().
Reid Klecknerfff8e7f2015-03-03 19:21:04 +000058 if (getLangOpts().CPlusPlus &&
59 getTarget().getCXXABI().isItaniumFamily()) {
Reid Kleckner1d59f992015-01-22 01:36:17 +000060 name = "_ZSt9terminatev";
Reid Klecknerfff8e7f2015-03-03 19:21:04 +000061 } else if (getLangOpts().CPlusPlus &&
62 getTarget().getCXXABI().isMicrosoft()) {
David Majnemerb710a932015-05-11 03:57:49 +000063 if (getLangOpts().isCompatibleWithMSVC(LangOptions::MSVC2015))
David Majnemerfb6ffca2015-05-10 21:38:26 +000064 name = "__std_terminate";
65 else
Reid Klecknerfb931542018-03-16 20:36:49 +000066 name = "?terminate@@YAXXZ";
Erik Pilkingtonfa983902018-10-30 20:31:30 +000067 } else if (getLangOpts().ObjC &&
Reid Klecknerfff8e7f2015-03-03 19:21:04 +000068 getLangOpts().ObjCRuntime.hasTerminate())
John McCall9de19782011-07-06 01:22:26 +000069 name = "objc_terminate";
70 else
71 name = "abort";
Reid Klecknerfff8e7f2015-03-03 19:21:04 +000072 return CreateRuntimeFunction(FTy, name);
David Chisnallf9c42252010-05-17 13:49:20 +000073}
74
James Y Knight9871db02019-02-05 16:42:33 +000075static llvm::FunctionCallee getCatchallRethrowFn(CodeGenModule &CGM,
76 StringRef Name) {
Chris Lattner2192fe52011-07-18 04:24:23 +000077 llvm::FunctionType *FTy =
Rui Ueyama49a3ad22019-07-16 04:46:31 +000078 llvm::FunctionType::get(CGM.VoidTy, CGM.Int8PtrTy, /*isVarArg=*/false);
John McCall36ea3722010-07-17 00:43:08 +000079
John McCall2c33ba82013-02-12 03:51:38 +000080 return CGM.CreateRuntimeFunction(FTy, Name);
John McCallbd309292010-07-06 01:34:17 +000081}
82
Craig Topper8a13c412014-05-21 05:09:00 +000083const EHPersonality EHPersonality::GNU_C = { "__gcc_personality_v0", nullptr };
Benjamin Kramer793bd552012-02-08 12:41:24 +000084const EHPersonality
Craig Topper8a13c412014-05-21 05:09:00 +000085EHPersonality::GNU_C_SJLJ = { "__gcc_personality_sj0", nullptr };
86const EHPersonality
Reid Kleckner8f45c9c2014-09-15 17:19:16 +000087EHPersonality::GNU_C_SEH = { "__gcc_personality_seh0", nullptr };
88const EHPersonality
Craig Topper8a13c412014-05-21 05:09:00 +000089EHPersonality::NeXT_ObjC = { "__objc_personality_v0", nullptr };
90const EHPersonality
91EHPersonality::GNU_CPlusPlus = { "__gxx_personality_v0", nullptr };
92const EHPersonality
93EHPersonality::GNU_CPlusPlus_SJLJ = { "__gxx_personality_sj0", nullptr };
Benjamin Kramer793bd552012-02-08 12:41:24 +000094const EHPersonality
Reid Kleckner8f45c9c2014-09-15 17:19:16 +000095EHPersonality::GNU_CPlusPlus_SEH = { "__gxx_personality_seh0", nullptr };
96const EHPersonality
Benjamin Kramer793bd552012-02-08 12:41:24 +000097EHPersonality::GNU_ObjC = {"__gnu_objc_personality_v0", "objc_exception_throw"};
98const EHPersonality
Benjamin Kramer796c1d92017-01-08 22:58:07 +000099EHPersonality::GNU_ObjC_SJLJ = {"__gnu_objc_personality_sj0", "objc_exception_throw"};
100const EHPersonality
101EHPersonality::GNU_ObjC_SEH = {"__gnu_objc_personality_seh0", "objc_exception_throw"};
102const EHPersonality
Craig Topper8a13c412014-05-21 05:09:00 +0000103EHPersonality::GNU_ObjCXX = { "__gnustep_objcxx_personality_v0", nullptr };
David Chisnall2ec1b10d2013-01-11 15:33:01 +0000104const EHPersonality
Craig Topper8a13c412014-05-21 05:09:00 +0000105EHPersonality::GNUstep_ObjC = { "__gnustep_objc_personality_v0", nullptr };
Reid Kleckner1d59f992015-01-22 01:36:17 +0000106const EHPersonality
107EHPersonality::MSVC_except_handler = { "_except_handler3", nullptr };
108const EHPersonality
109EHPersonality::MSVC_C_specific_handler = { "__C_specific_handler", nullptr };
Reid Klecknerdeeddec2015-02-05 18:56:03 +0000110const EHPersonality
111EHPersonality::MSVC_CxxFrameHandler3 = { "__CxxFrameHandler3", nullptr };
Heejin Ahnc6479192018-05-31 22:18:13 +0000112const EHPersonality
113EHPersonality::GNU_Wasm_CPlusPlus = { "__gxx_wasm_personality_v0", nullptr };
John McCall36ea3722010-07-17 00:43:08 +0000114
Heejin Ahn00831792018-06-04 18:23:00 +0000115static const EHPersonality &getCPersonality(const TargetInfo &Target,
Reid Klecknere070b992014-11-14 02:01:10 +0000116 const LangOptions &L) {
Heejin Ahn00831792018-06-04 18:23:00 +0000117 const llvm::Triple &T = Target.getTriple();
Shoaib Meenaia5fc6032018-06-08 00:41:01 +0000118 if (T.isWindowsMSVCEnvironment())
119 return EHPersonality::MSVC_CxxFrameHandler3;
John McCall2faab302010-11-07 02:35:25 +0000120 if (L.SjLjExceptions)
121 return EHPersonality::GNU_C_SJLJ;
Saleem Abdulrasool3e701322018-03-09 07:06:42 +0000122 if (L.DWARFExceptions)
123 return EHPersonality::GNU_C;
Martell Malonec950c652017-11-29 07:25:12 +0000124 if (L.SEHExceptions)
Reid Kleckner8f45c9c2014-09-15 17:19:16 +0000125 return EHPersonality::GNU_C_SEH;
John McCall36ea3722010-07-17 00:43:08 +0000126 return EHPersonality::GNU_C;
127}
128
Heejin Ahn00831792018-06-04 18:23:00 +0000129static const EHPersonality &getObjCPersonality(const TargetInfo &Target,
Reid Klecknere070b992014-11-14 02:01:10 +0000130 const LangOptions &L) {
Heejin Ahn00831792018-06-04 18:23:00 +0000131 const llvm::Triple &T = Target.getTriple();
Shoaib Meenaia5fc6032018-06-08 00:41:01 +0000132 if (T.isWindowsMSVCEnvironment())
133 return EHPersonality::MSVC_CxxFrameHandler3;
134
John McCall5fb5df92012-06-20 06:18:46 +0000135 switch (L.ObjCRuntime.getKind()) {
136 case ObjCRuntime::FragileMacOSX:
Heejin Ahn00831792018-06-04 18:23:00 +0000137 return getCPersonality(Target, L);
John McCall5fb5df92012-06-20 06:18:46 +0000138 case ObjCRuntime::MacOSX:
139 case ObjCRuntime::iOS:
Tim Northover756447a2015-10-30 16:30:36 +0000140 case ObjCRuntime::WatchOS:
John McCall5fb5df92012-06-20 06:18:46 +0000141 return EHPersonality::NeXT_ObjC;
David Chisnallb601c962012-07-03 20:49:52 +0000142 case ObjCRuntime::GNUstep:
David Chisnall2ec1b10d2013-01-11 15:33:01 +0000143 if (L.ObjCRuntime.getVersion() >= VersionTuple(1, 7))
144 return EHPersonality::GNUstep_ObjC;
Adrian Prantlf3b3ccd2017-12-19 22:06:11 +0000145 LLVM_FALLTHROUGH;
David Chisnallb601c962012-07-03 20:49:52 +0000146 case ObjCRuntime::GCC:
John McCall775086e2012-07-12 02:07:58 +0000147 case ObjCRuntime::ObjFW:
Benjamin Kramer796c1d92017-01-08 22:58:07 +0000148 if (L.SjLjExceptions)
149 return EHPersonality::GNU_ObjC_SJLJ;
Martell Malonec950c652017-11-29 07:25:12 +0000150 if (L.SEHExceptions)
Benjamin Kramer796c1d92017-01-08 22:58:07 +0000151 return EHPersonality::GNU_ObjC_SEH;
John McCall36ea3722010-07-17 00:43:08 +0000152 return EHPersonality::GNU_ObjC;
John McCallbd309292010-07-06 01:34:17 +0000153 }
John McCall5fb5df92012-06-20 06:18:46 +0000154 llvm_unreachable("bad runtime kind");
John McCallbd309292010-07-06 01:34:17 +0000155}
156
Heejin Ahn00831792018-06-04 18:23:00 +0000157static const EHPersonality &getCXXPersonality(const TargetInfo &Target,
158 const LangOptions &L) {
159 const llvm::Triple &T = Target.getTriple();
Shoaib Meenaia5fc6032018-06-08 00:41:01 +0000160 if (T.isWindowsMSVCEnvironment())
161 return EHPersonality::MSVC_CxxFrameHandler3;
John McCall36ea3722010-07-17 00:43:08 +0000162 if (L.SjLjExceptions)
163 return EHPersonality::GNU_CPlusPlus_SJLJ;
Saleem Abdulrasool3e701322018-03-09 07:06:42 +0000164 if (L.DWARFExceptions)
165 return EHPersonality::GNU_CPlusPlus;
Martell Malonec950c652017-11-29 07:25:12 +0000166 if (L.SEHExceptions)
Reid Kleckner8f45c9c2014-09-15 17:19:16 +0000167 return EHPersonality::GNU_CPlusPlus_SEH;
Heejin Ahne8b2b882019-09-12 04:01:37 +0000168 if (L.WasmExceptions)
Heejin Ahnc6479192018-05-31 22:18:13 +0000169 return EHPersonality::GNU_Wasm_CPlusPlus;
Reid Klecknere070b992014-11-14 02:01:10 +0000170 return EHPersonality::GNU_CPlusPlus;
John McCallbd309292010-07-06 01:34:17 +0000171}
172
173/// Determines the personality function to use when both C++
174/// and Objective-C exceptions are being caught.
Heejin Ahn00831792018-06-04 18:23:00 +0000175static const EHPersonality &getObjCXXPersonality(const TargetInfo &Target,
176 const LangOptions &L) {
Shoaib Meenaia5fc6032018-06-08 00:41:01 +0000177 if (Target.getTriple().isWindowsMSVCEnvironment())
178 return EHPersonality::MSVC_CxxFrameHandler3;
179
John McCall5fb5df92012-06-20 06:18:46 +0000180 switch (L.ObjCRuntime.getKind()) {
Saleem Abdulrasool8f6d9442017-11-02 00:25:40 +0000181 // In the fragile ABI, just use C++ exception handling and hope
182 // they're not doing crazy exception mixing.
183 case ObjCRuntime::FragileMacOSX:
Heejin Ahn00831792018-06-04 18:23:00 +0000184 return getCXXPersonality(Target, L);
Saleem Abdulrasool8f6d9442017-11-02 00:25:40 +0000185
John McCallbd309292010-07-06 01:34:17 +0000186 // The ObjC personality defers to the C++ personality for non-ObjC
187 // handlers. Unlike the C++ case, we use the same personality
188 // function on targets using (backend-driven) SJLJ EH.
John McCall5fb5df92012-06-20 06:18:46 +0000189 case ObjCRuntime::MacOSX:
190 case ObjCRuntime::iOS:
Tim Northover756447a2015-10-30 16:30:36 +0000191 case ObjCRuntime::WatchOS:
Heejin Ahn00831792018-06-04 18:23:00 +0000192 return getObjCPersonality(Target, L);
John McCallbd309292010-07-06 01:34:17 +0000193
Saleem Abdulrasool8f6d9442017-11-02 00:25:40 +0000194 case ObjCRuntime::GNUstep:
195 return EHPersonality::GNU_ObjCXX;
David Chisnallf9c42252010-05-17 13:49:20 +0000196
David Chisnallb601c962012-07-03 20:49:52 +0000197 // The GCC runtime's personality function inherently doesn't support
Saleem Abdulrasool8f6d9442017-11-02 00:25:40 +0000198 // mixed EH. Use the ObjC personality just to avoid returning null.
David Chisnallb601c962012-07-03 20:49:52 +0000199 case ObjCRuntime::GCC:
Benjamin Kramer9851cb72017-04-01 17:59:01 +0000200 case ObjCRuntime::ObjFW:
Heejin Ahn00831792018-06-04 18:23:00 +0000201 return getObjCPersonality(Target, L);
John McCall5fb5df92012-06-20 06:18:46 +0000202 }
203 llvm_unreachable("bad runtime kind");
John McCallbd309292010-07-06 01:34:17 +0000204}
205
Reid Klecknerdeeddec2015-02-05 18:56:03 +0000206static const EHPersonality &getSEHPersonalityMSVC(const llvm::Triple &T) {
Reid Kleckner1d59f992015-01-22 01:36:17 +0000207 if (T.getArch() == llvm::Triple::x86)
208 return EHPersonality::MSVC_except_handler;
209 return EHPersonality::MSVC_C_specific_handler;
210}
211
Reid Klecknerdeeddec2015-02-05 18:56:03 +0000212const EHPersonality &EHPersonality::get(CodeGenModule &CGM,
213 const FunctionDecl *FD) {
Reid Klecknere070b992014-11-14 02:01:10 +0000214 const llvm::Triple &T = CGM.getTarget().getTriple();
215 const LangOptions &L = CGM.getLangOpts();
Heejin Ahn1eb074d2018-06-01 01:01:37 +0000216 const TargetInfo &Target = CGM.getTarget();
Reid Klecknerdeeddec2015-02-05 18:56:03 +0000217
Reid Kleckner01485652015-09-17 17:04:13 +0000218 // Functions using SEH get an SEH personality.
219 if (FD && FD->usesSEHTry())
220 return getSEHPersonalityMSVC(T);
221
Erik Pilkingtonfa983902018-10-30 20:31:30 +0000222 if (L.ObjC)
Heejin Ahn00831792018-06-04 18:23:00 +0000223 return L.CPlusPlus ? getObjCXXPersonality(Target, L)
224 : getObjCPersonality(Target, L);
225 return L.CPlusPlus ? getCXXPersonality(Target, L)
226 : getCPersonality(Target, L);
John McCall36ea3722010-07-17 00:43:08 +0000227}
John McCallbd309292010-07-06 01:34:17 +0000228
David Majnemerc28d46e2015-07-22 23:46:21 +0000229const EHPersonality &EHPersonality::get(CodeGenFunction &CGF) {
Reid Kleckner65fa8692017-10-13 16:55:14 +0000230 const auto *FD = CGF.CurCodeDecl;
231 // For outlined finallys and filters, use the SEH personality in case they
232 // contain more SEH. This mostly only affects finallys. Filters could
233 // hypothetically use gnu statement expressions to sneak in nested SEH.
234 FD = FD ? FD : CGF.CurSEHParent;
235 return get(CGF.CGM, dyn_cast_or_null<FunctionDecl>(FD));
David Majnemerc28d46e2015-07-22 23:46:21 +0000236}
237
James Y Knight9871db02019-02-05 16:42:33 +0000238static llvm::FunctionCallee getPersonalityFn(CodeGenModule &CGM,
239 const EHPersonality &Personality) {
Saleem Abdulrasool6cb07442016-12-15 06:59:05 +0000240 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(CGM.Int32Ty, true),
241 Personality.PersonalityFn,
Reid Klecknerde864822017-03-21 16:57:30 +0000242 llvm::AttributeList(), /*Local=*/true);
John McCall0bdb1fd2010-09-16 06:16:50 +0000243}
244
245static llvm::Constant *getOpaquePersonalityFn(CodeGenModule &CGM,
246 const EHPersonality &Personality) {
James Y Knight9871db02019-02-05 16:42:33 +0000247 llvm::FunctionCallee Fn = getPersonalityFn(CGM, Personality);
Dylan McKay02bbe412018-11-09 19:42:05 +0000248 llvm::PointerType* Int8PtrTy = llvm::PointerType::get(
249 llvm::Type::getInt8Ty(CGM.getLLVMContext()),
250 CGM.getDataLayout().getProgramAddressSpace());
251
James Y Knight9871db02019-02-05 16:42:33 +0000252 return llvm::ConstantExpr::getBitCast(cast<llvm::Constant>(Fn.getCallee()),
253 Int8PtrTy);
John McCall0bdb1fd2010-09-16 06:16:50 +0000254}
255
Vedant Kumardb609472015-09-11 15:40:05 +0000256/// Check whether a landingpad instruction only uses C++ features.
257static bool LandingPadHasOnlyCXXUses(llvm::LandingPadInst *LPI) {
258 for (unsigned I = 0, E = LPI->getNumClauses(); I != E; ++I) {
259 // Look for something that would've been returned by the ObjC
260 // runtime's GetEHType() method.
261 llvm::Value *Val = LPI->getClause(I)->stripPointerCasts();
262 if (LPI->isCatch(I)) {
263 // Check if the catch value has the ObjC prefix.
264 if (llvm::GlobalVariable *GV = dyn_cast<llvm::GlobalVariable>(Val))
265 // ObjC EH selector entries are always global variables with
266 // names starting like this.
267 if (GV->getName().startswith("OBJC_EHTYPE"))
268 return false;
269 } else {
270 // Check if any of the filter values have the ObjC prefix.
271 llvm::Constant *CVal = cast<llvm::Constant>(Val);
272 for (llvm::User::op_iterator
273 II = CVal->op_begin(), IE = CVal->op_end(); II != IE; ++II) {
274 if (llvm::GlobalVariable *GV =
275 cast<llvm::GlobalVariable>((*II)->stripPointerCasts()))
276 // ObjC EH selector entries are always global variables with
277 // names starting like this.
278 if (GV->getName().startswith("OBJC_EHTYPE"))
279 return false;
280 }
281 }
282 }
283 return true;
284}
285
John McCall0bdb1fd2010-09-16 06:16:50 +0000286/// Check whether a personality function could reasonably be swapped
287/// for a C++ personality function.
288static bool PersonalityHasOnlyCXXUses(llvm::Constant *Fn) {
Chandler Carruth4d01fff2014-03-09 03:16:50 +0000289 for (llvm::User *U : Fn->users()) {
John McCall0bdb1fd2010-09-16 06:16:50 +0000290 // Conditionally white-list bitcasts.
Chandler Carruth4d01fff2014-03-09 03:16:50 +0000291 if (llvm::ConstantExpr *CE = dyn_cast<llvm::ConstantExpr>(U)) {
John McCall0bdb1fd2010-09-16 06:16:50 +0000292 if (CE->getOpcode() != llvm::Instruction::BitCast) return false;
293 if (!PersonalityHasOnlyCXXUses(CE))
294 return false;
295 continue;
296 }
297
Vedant Kumardb609472015-09-11 15:40:05 +0000298 // Otherwise it must be a function.
299 llvm::Function *F = dyn_cast<llvm::Function>(U);
300 if (!F) return false;
John McCall0bdb1fd2010-09-16 06:16:50 +0000301
Vedant Kumardb609472015-09-11 15:40:05 +0000302 for (auto BB = F->begin(), E = F->end(); BB != E; ++BB) {
303 if (BB->isLandingPad())
304 if (!LandingPadHasOnlyCXXUses(BB->getLandingPadInst()))
305 return false;
John McCall0bdb1fd2010-09-16 06:16:50 +0000306 }
307 }
308
309 return true;
310}
311
312/// Try to use the C++ personality function in ObjC++. Not doing this
313/// can cause some incompatibilities with gcc, which is more
314/// aggressive about only using the ObjC++ personality in a function
315/// when it really needs it.
316void CodeGenModule::SimplifyPersonality() {
John McCall0bdb1fd2010-09-16 06:16:50 +0000317 // If we're not in ObjC++ -fexceptions, there's nothing to do.
Erik Pilkingtonfa983902018-10-30 20:31:30 +0000318 if (!LangOpts.CPlusPlus || !LangOpts.ObjC || !LangOpts.Exceptions)
John McCall0bdb1fd2010-09-16 06:16:50 +0000319 return;
320
John McCall3c223932012-11-14 17:48:31 +0000321 // Both the problem this endeavors to fix and the way the logic
322 // above works is specific to the NeXT runtime.
323 if (!LangOpts.ObjCRuntime.isNeXTFamily())
324 return;
325
Reid Klecknerdeeddec2015-02-05 18:56:03 +0000326 const EHPersonality &ObjCXX = EHPersonality::get(*this, /*FD=*/nullptr);
Heejin Ahn00831792018-06-04 18:23:00 +0000327 const EHPersonality &CXX = getCXXPersonality(getTarget(), LangOpts);
Benjamin Kramer793bd552012-02-08 12:41:24 +0000328 if (&ObjCXX == &CXX)
John McCall0bdb1fd2010-09-16 06:16:50 +0000329 return;
330
Benjamin Kramer793bd552012-02-08 12:41:24 +0000331 assert(std::strcmp(ObjCXX.PersonalityFn, CXX.PersonalityFn) != 0 &&
332 "Different EHPersonalities using the same personality function.");
333
334 llvm::Function *Fn = getModule().getFunction(ObjCXX.PersonalityFn);
John McCall0bdb1fd2010-09-16 06:16:50 +0000335
336 // Nothing to do if it's unused.
337 if (!Fn || Fn->use_empty()) return;
Fangrui Song6907ce22018-07-30 19:24:48 +0000338
John McCall0bdb1fd2010-09-16 06:16:50 +0000339 // Can't do the optimization if it has non-C++ uses.
340 if (!PersonalityHasOnlyCXXUses(Fn)) return;
341
342 // Create the C++ personality function and kill off the old
343 // function.
James Y Knight9871db02019-02-05 16:42:33 +0000344 llvm::FunctionCallee CXXFn = getPersonalityFn(*this, CXX);
John McCall0bdb1fd2010-09-16 06:16:50 +0000345
346 // This can happen if the user is screwing with us.
James Y Knight9871db02019-02-05 16:42:33 +0000347 if (Fn->getType() != CXXFn.getCallee()->getType())
348 return;
John McCall0bdb1fd2010-09-16 06:16:50 +0000349
James Y Knight9871db02019-02-05 16:42:33 +0000350 Fn->replaceAllUsesWith(CXXFn.getCallee());
John McCall0bdb1fd2010-09-16 06:16:50 +0000351 Fn->eraseFromParent();
John McCallbd309292010-07-06 01:34:17 +0000352}
353
354/// Returns the value to inject into a selector to indicate the
355/// presence of a catch-all.
356static llvm::Constant *getCatchAllValue(CodeGenFunction &CGF) {
357 // Possibly we should use @llvm.eh.catch.all.value here.
John McCallad7c5c12011-02-08 08:22:06 +0000358 return llvm::ConstantPointerNull::get(CGF.Int8PtrTy);
John McCallbd309292010-07-06 01:34:17 +0000359}
360
John McCallbb026012010-07-13 21:17:51 +0000361namespace {
362 /// A cleanup to free the exception object if its initialization
363 /// throws.
David Blaikie7e70d682015-08-18 22:40:54 +0000364 struct FreeException final : EHScopeStack::Cleanup {
John McCall5fcf8da2011-07-12 00:15:30 +0000365 llvm::Value *exn;
366 FreeException(llvm::Value *exn) : exn(exn) {}
Craig Topper4f12f102014-03-12 06:41:41 +0000367 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall882987f2013-02-28 19:01:20 +0000368 CGF.EmitNounwindRuntimeCall(getFreeExceptionFn(CGF.CGM), exn);
John McCallbb026012010-07-13 21:17:51 +0000369 }
370 };
Hans Wennborgdcfba332015-10-06 23:40:43 +0000371} // end anonymous namespace
John McCallbb026012010-07-13 21:17:51 +0000372
John McCall2e6567a2010-04-22 01:10:34 +0000373// Emits an exception expression into the given location. This
374// differs from EmitAnyExprToMem only in that, if a final copy-ctor
375// call is required, an exception within that copy ctor causes
376// std::terminate to be invoked.
John McCall7f416cc2015-09-08 08:05:57 +0000377void CodeGenFunction::EmitAnyExprToExn(const Expr *e, Address addr) {
John McCallbd309292010-07-06 01:34:17 +0000378 // Make sure the exception object is cleaned up if there's an
379 // exception during initialization.
John McCall7f416cc2015-09-08 08:05:57 +0000380 pushFullExprCleanup<FreeException>(EHCleanup, addr.getPointer());
David Majnemer7c237072015-03-05 00:46:22 +0000381 EHScopeStack::stable_iterator cleanup = EHStack.stable_begin();
John McCall2e6567a2010-04-22 01:10:34 +0000382
383 // __cxa_allocate_exception returns a void*; we need to cast this
384 // to the appropriate type for the object.
David Majnemer7c237072015-03-05 00:46:22 +0000385 llvm::Type *ty = ConvertTypeForMem(e->getType())->getPointerTo();
John McCall7f416cc2015-09-08 08:05:57 +0000386 Address typedAddr = Builder.CreateBitCast(addr, ty);
John McCall2e6567a2010-04-22 01:10:34 +0000387
388 // FIXME: this isn't quite right! If there's a final unelided call
389 // to a copy constructor, then according to [except.terminate]p1 we
390 // must call std::terminate() if that constructor throws, because
391 // technically that copy occurs after the exception expression is
392 // evaluated but before the exception is caught. But the best way
393 // to handle that is to teach EmitAggExpr to do the final copy
394 // differently if it can't be elided.
David Majnemer7c237072015-03-05 00:46:22 +0000395 EmitAnyExprToMem(e, typedAddr, e->getType().getQualifiers(),
396 /*IsInit*/ true);
John McCall2e6567a2010-04-22 01:10:34 +0000397
John McCalle4df6c82011-01-28 08:37:24 +0000398 // Deactivate the cleanup block.
John McCall7f416cc2015-09-08 08:05:57 +0000399 DeactivateCleanupBlock(cleanup,
400 cast<llvm::Instruction>(typedAddr.getPointer()));
Mike Stump54066142009-12-01 03:41:18 +0000401}
402
John McCall7f416cc2015-09-08 08:05:57 +0000403Address CodeGenFunction::getExceptionSlot() {
John McCall9b382dd2011-05-28 21:13:02 +0000404 if (!ExceptionSlot)
405 ExceptionSlot = CreateTempAlloca(Int8PtrTy, "exn.slot");
John McCall7f416cc2015-09-08 08:05:57 +0000406 return Address(ExceptionSlot, getPointerAlign());
Mike Stump54066142009-12-01 03:41:18 +0000407}
408
John McCall7f416cc2015-09-08 08:05:57 +0000409Address CodeGenFunction::getEHSelectorSlot() {
John McCall9b382dd2011-05-28 21:13:02 +0000410 if (!EHSelectorSlot)
411 EHSelectorSlot = CreateTempAlloca(Int32Ty, "ehselector.slot");
John McCall7f416cc2015-09-08 08:05:57 +0000412 return Address(EHSelectorSlot, CharUnits::fromQuantity(4));
John McCall9b382dd2011-05-28 21:13:02 +0000413}
414
Bill Wendling79a70e42011-09-15 18:57:19 +0000415llvm::Value *CodeGenFunction::getExceptionFromSlot() {
416 return Builder.CreateLoad(getExceptionSlot(), "exn");
417}
418
419llvm::Value *CodeGenFunction::getSelectorFromSlot() {
420 return Builder.CreateLoad(getEHSelectorSlot(), "sel");
421}
422
Richard Smithea852322013-05-07 21:53:22 +0000423void CodeGenFunction::EmitCXXThrowExpr(const CXXThrowExpr *E,
424 bool KeepInsertionPoint) {
David Majnemer7c237072015-03-05 00:46:22 +0000425 if (const Expr *SubExpr = E->getSubExpr()) {
426 QualType ThrowType = SubExpr->getType();
427 if (ThrowType->isObjCObjectPointerType()) {
428 const Stmt *ThrowStmt = E->getSubExpr();
429 const ObjCAtThrowStmt S(E->getExprLoc(), const_cast<Stmt *>(ThrowStmt));
430 CGM.getObjCRuntime().EmitThrowStmt(*this, S, false);
431 } else {
432 CGM.getCXXABI().emitThrow(*this, E);
John McCall2e6567a2010-04-22 01:10:34 +0000433 }
David Majnemer7c237072015-03-05 00:46:22 +0000434 } else {
435 CGM.getCXXABI().emitRethrow(*this, /*isNoReturn=*/true);
John McCall2e6567a2010-04-22 01:10:34 +0000436 }
Mike Stump75546b82009-12-10 00:06:18 +0000437
John McCall20f6ab82011-01-12 03:41:02 +0000438 // throw is an expression, and the expression emitters expect us
439 // to leave ourselves at a valid insertion point.
Richard Smithea852322013-05-07 21:53:22 +0000440 if (KeepInsertionPoint)
441 EmitBlock(createBasicBlock("throw.cont"));
Anders Carlsson4b08db72009-10-30 01:42:31 +0000442}
Mike Stump58ef18b2009-11-20 23:44:51 +0000443
Mike Stump1d849212009-12-07 23:38:24 +0000444void CodeGenFunction::EmitStartEHSpec(const Decl *D) {
David Blaikiebbafb8a2012-03-11 07:00:24 +0000445 if (!CGM.getLangOpts().CXXExceptions)
Anders Carlsson9878f9f2010-02-06 23:59:05 +0000446 return;
Fangrui Song6907ce22018-07-30 19:24:48 +0000447
Mike Stump1d849212009-12-07 23:38:24 +0000448 const FunctionDecl* FD = dyn_cast_or_null<FunctionDecl>(D);
Craig Topper8a13c412014-05-21 05:09:00 +0000449 if (!FD) {
Alexey Bataev9959db52014-05-06 10:08:46 +0000450 // Check if CapturedDecl is nothrow and create terminate scope for it.
451 if (const CapturedDecl* CD = dyn_cast_or_null<CapturedDecl>(D)) {
452 if (CD->isNothrow())
453 EHStack.pushTerminate();
454 }
Mike Stump1d849212009-12-07 23:38:24 +0000455 return;
Alexey Bataev9959db52014-05-06 10:08:46 +0000456 }
Mike Stump1d849212009-12-07 23:38:24 +0000457 const FunctionProtoType *Proto = FD->getType()->getAs<FunctionProtoType>();
Craig Topper8a13c412014-05-21 05:09:00 +0000458 if (!Proto)
Mike Stump1d849212009-12-07 23:38:24 +0000459 return;
460
Sebastian Redl0b94c9f2011-03-15 18:42:48 +0000461 ExceptionSpecificationType EST = Proto->getExceptionSpecType();
Richard Smitheaf11ad2018-05-03 03:58:32 +0000462 if (isNoexceptExceptionSpec(EST) && Proto->canThrow() == CT_Cannot) {
463 // noexcept functions are simple terminate scopes.
464 EHStack.pushTerminate();
Sebastian Redl0b94c9f2011-03-15 18:42:48 +0000465 } else if (EST == EST_Dynamic || EST == EST_DynamicNone) {
David Majnemer1f192e22015-04-01 04:45:52 +0000466 // TODO: Revisit exception specifications for the MS ABI. There is a way to
467 // encode these in an object file but MSVC doesn't do anything with it.
468 if (getTarget().getCXXABI().isMicrosoft())
469 return;
Sebastian Redl0b94c9f2011-03-15 18:42:48 +0000470 unsigned NumExceptions = Proto->getNumExceptions();
471 EHFilterScope *Filter = EHStack.pushFilter(NumExceptions);
Mike Stump1d849212009-12-07 23:38:24 +0000472
Sebastian Redl0b94c9f2011-03-15 18:42:48 +0000473 for (unsigned I = 0; I != NumExceptions; ++I) {
474 QualType Ty = Proto->getExceptionType(I);
475 QualType ExceptType = Ty.getNonReferenceType().getUnqualifiedType();
476 llvm::Value *EHType = CGM.GetAddrOfRTTIDescriptor(ExceptType,
477 /*ForEH=*/true);
478 Filter->setFilter(I, EHType);
479 }
Mike Stump1d849212009-12-07 23:38:24 +0000480 }
Mike Stump1d849212009-12-07 23:38:24 +0000481}
482
John McCall8e4c74b2011-08-11 02:22:43 +0000483/// Emit the dispatch block for a filter scope if necessary.
484static void emitFilterDispatchBlock(CodeGenFunction &CGF,
485 EHFilterScope &filterScope) {
486 llvm::BasicBlock *dispatchBlock = filterScope.getCachedEHDispatchBlock();
487 if (!dispatchBlock) return;
488 if (dispatchBlock->use_empty()) {
489 delete dispatchBlock;
490 return;
491 }
492
John McCall8e4c74b2011-08-11 02:22:43 +0000493 CGF.EmitBlockAfterUses(dispatchBlock);
494
495 // If this isn't a catch-all filter, we need to check whether we got
496 // here because the filter triggered.
497 if (filterScope.getNumFilters()) {
498 // Load the selector value.
Bill Wendling79a70e42011-09-15 18:57:19 +0000499 llvm::Value *selector = CGF.getSelectorFromSlot();
John McCall8e4c74b2011-08-11 02:22:43 +0000500 llvm::BasicBlock *unexpectedBB = CGF.createBasicBlock("ehspec.unexpected");
501
502 llvm::Value *zero = CGF.Builder.getInt32(0);
503 llvm::Value *failsFilter =
Nico Weber1bebad12015-02-11 22:33:32 +0000504 CGF.Builder.CreateICmpSLT(selector, zero, "ehspec.fails");
505 CGF.Builder.CreateCondBr(failsFilter, unexpectedBB,
506 CGF.getEHResumeBlock(false));
John McCall8e4c74b2011-08-11 02:22:43 +0000507
508 CGF.EmitBlock(unexpectedBB);
509 }
510
511 // Call __cxa_call_unexpected. This doesn't need to be an invoke
512 // because __cxa_call_unexpected magically filters exceptions
513 // according to the last landing pad the exception was thrown
514 // into. Seriously.
Bill Wendling79a70e42011-09-15 18:57:19 +0000515 llvm::Value *exn = CGF.getExceptionFromSlot();
John McCall882987f2013-02-28 19:01:20 +0000516 CGF.EmitRuntimeCall(getUnexpectedFn(CGF.CGM), exn)
John McCall8e4c74b2011-08-11 02:22:43 +0000517 ->setDoesNotReturn();
518 CGF.Builder.CreateUnreachable();
519}
520
Mike Stump1d849212009-12-07 23:38:24 +0000521void CodeGenFunction::EmitEndEHSpec(const Decl *D) {
David Blaikiebbafb8a2012-03-11 07:00:24 +0000522 if (!CGM.getLangOpts().CXXExceptions)
Anders Carlsson9878f9f2010-02-06 23:59:05 +0000523 return;
Fangrui Song6907ce22018-07-30 19:24:48 +0000524
Mike Stump1d849212009-12-07 23:38:24 +0000525 const FunctionDecl* FD = dyn_cast_or_null<FunctionDecl>(D);
Craig Topper8a13c412014-05-21 05:09:00 +0000526 if (!FD) {
Alexey Bataev9959db52014-05-06 10:08:46 +0000527 // Check if CapturedDecl is nothrow and pop terminate scope for it.
528 if (const CapturedDecl* CD = dyn_cast_or_null<CapturedDecl>(D)) {
529 if (CD->isNothrow())
530 EHStack.popTerminate();
531 }
Mike Stump1d849212009-12-07 23:38:24 +0000532 return;
Alexey Bataev9959db52014-05-06 10:08:46 +0000533 }
Mike Stump1d849212009-12-07 23:38:24 +0000534 const FunctionProtoType *Proto = FD->getType()->getAs<FunctionProtoType>();
Craig Topper8a13c412014-05-21 05:09:00 +0000535 if (!Proto)
Mike Stump1d849212009-12-07 23:38:24 +0000536 return;
537
Sebastian Redl0b94c9f2011-03-15 18:42:48 +0000538 ExceptionSpecificationType EST = Proto->getExceptionSpecType();
Richard Smitheaf11ad2018-05-03 03:58:32 +0000539 if (isNoexceptExceptionSpec(EST) && Proto->canThrow() == CT_Cannot) {
540 EHStack.popTerminate();
Sebastian Redl0b94c9f2011-03-15 18:42:48 +0000541 } else if (EST == EST_Dynamic || EST == EST_DynamicNone) {
David Majnemer1f192e22015-04-01 04:45:52 +0000542 // TODO: Revisit exception specifications for the MS ABI. There is a way to
543 // encode these in an object file but MSVC doesn't do anything with it.
544 if (getTarget().getCXXABI().isMicrosoft())
545 return;
John McCall8e4c74b2011-08-11 02:22:43 +0000546 EHFilterScope &filterScope = cast<EHFilterScope>(*EHStack.begin());
547 emitFilterDispatchBlock(*this, filterScope);
Sebastian Redl0b94c9f2011-03-15 18:42:48 +0000548 EHStack.popFilter();
549 }
Mike Stump1d849212009-12-07 23:38:24 +0000550}
551
Mike Stump58ef18b2009-11-20 23:44:51 +0000552void CodeGenFunction::EmitCXXTryStmt(const CXXTryStmt &S) {
John McCallb609d3f2010-07-07 06:56:46 +0000553 EnterCXXTryStmt(S);
John McCallb81884d2010-02-19 09:25:03 +0000554 EmitStmt(S.getTryBlock());
John McCallb609d3f2010-07-07 06:56:46 +0000555 ExitCXXTryStmt(S);
John McCallb81884d2010-02-19 09:25:03 +0000556}
557
John McCallb609d3f2010-07-07 06:56:46 +0000558void CodeGenFunction::EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock) {
John McCallbd309292010-07-06 01:34:17 +0000559 unsigned NumHandlers = S.getNumHandlers();
560 EHCatchScope *CatchScope = EHStack.pushCatch(NumHandlers);
John McCallb81884d2010-02-19 09:25:03 +0000561
John McCallbd309292010-07-06 01:34:17 +0000562 for (unsigned I = 0; I != NumHandlers; ++I) {
563 const CXXCatchStmt *C = S.getHandler(I);
John McCallb81884d2010-02-19 09:25:03 +0000564
John McCallbd309292010-07-06 01:34:17 +0000565 llvm::BasicBlock *Handler = createBasicBlock("catch");
566 if (C->getExceptionDecl()) {
567 // FIXME: Dropping the reference type on the type into makes it
568 // impossible to correctly implement catch-by-reference
569 // semantics for pointers. Unfortunately, this is what all
570 // existing compilers do, and it's not clear that the standard
571 // personality routine is capable of doing this right. See C++ DR 388:
572 // http://www.open-std.org/jtc1/sc22/wg21/docs/cwg_active.html#388
David Majnemer571162a2014-10-12 06:58:22 +0000573 Qualifiers CaughtTypeQuals;
574 QualType CaughtType = CGM.getContext().getUnqualifiedArrayType(
575 C->getCaughtType().getNonReferenceType(), CaughtTypeQuals);
John McCall2ca705e2010-07-24 00:37:23 +0000576
Reid Kleckner10aa7702015-09-16 20:15:55 +0000577 CatchTypeInfo TypeInfo{nullptr, 0};
John McCall2ca705e2010-07-24 00:37:23 +0000578 if (CaughtType->isObjCObjectPointerType())
Reid Kleckner10aa7702015-09-16 20:15:55 +0000579 TypeInfo.RTTI = CGM.getObjCRuntime().GetEHType(CaughtType);
John McCall2ca705e2010-07-24 00:37:23 +0000580 else
Reid Kleckner10aa7702015-09-16 20:15:55 +0000581 TypeInfo = CGM.getCXXABI().getAddrOfCXXCatchHandlerType(
582 CaughtType, C->getCaughtType());
John McCallbd309292010-07-06 01:34:17 +0000583 CatchScope->setHandler(I, TypeInfo, Handler);
584 } else {
585 // No exception decl indicates '...', a catch-all.
Reid Kleckner10aa7702015-09-16 20:15:55 +0000586 CatchScope->setHandler(I, CGM.getCXXABI().getCatchAllTypeInfo(), Handler);
John McCallbd309292010-07-06 01:34:17 +0000587 }
588 }
John McCallbd309292010-07-06 01:34:17 +0000589}
590
John McCall8e4c74b2011-08-11 02:22:43 +0000591llvm::BasicBlock *
592CodeGenFunction::getEHDispatchBlock(EHScopeStack::stable_iterator si) {
Reid Kleckner129552b2015-10-08 01:13:52 +0000593 if (EHPersonality::get(*this).usesFuncletPads())
Heejin Ahnc6479192018-05-31 22:18:13 +0000594 return getFuncletEHDispatchBlock(si);
David Majnemerdbf10452015-07-31 17:58:45 +0000595
John McCall8e4c74b2011-08-11 02:22:43 +0000596 // The dispatch block for the end of the scope chain is a block that
597 // just resumes unwinding.
598 if (si == EHStack.stable_end())
David Chisnall9a837be2012-11-07 16:50:40 +0000599 return getEHResumeBlock(true);
John McCall8e4c74b2011-08-11 02:22:43 +0000600
601 // Otherwise, we should look at the actual scope.
602 EHScope &scope = *EHStack.find(si);
603
604 llvm::BasicBlock *dispatchBlock = scope.getCachedEHDispatchBlock();
605 if (!dispatchBlock) {
606 switch (scope.getKind()) {
607 case EHScope::Catch: {
608 // Apply a special case to a single catch-all.
609 EHCatchScope &catchScope = cast<EHCatchScope>(scope);
610 if (catchScope.getNumHandlers() == 1 &&
611 catchScope.getHandler(0).isCatchAll()) {
612 dispatchBlock = catchScope.getHandler(0).Block;
613
614 // Otherwise, make a dispatch block.
615 } else {
616 dispatchBlock = createBasicBlock("catch.dispatch");
617 }
618 break;
619 }
620
621 case EHScope::Cleanup:
622 dispatchBlock = createBasicBlock("ehcleanup");
623 break;
624
625 case EHScope::Filter:
626 dispatchBlock = createBasicBlock("filter.dispatch");
627 break;
628
629 case EHScope::Terminate:
630 dispatchBlock = getTerminateHandler();
631 break;
David Majnemerdbf10452015-07-31 17:58:45 +0000632
Reid Kleckner2586aac2015-09-10 22:11:13 +0000633 case EHScope::PadEnd:
634 llvm_unreachable("PadEnd unnecessary for Itanium!");
John McCall8e4c74b2011-08-11 02:22:43 +0000635 }
636 scope.setCachedEHDispatchBlock(dispatchBlock);
637 }
638 return dispatchBlock;
639}
640
David Majnemerdbf10452015-07-31 17:58:45 +0000641llvm::BasicBlock *
Heejin Ahnc6479192018-05-31 22:18:13 +0000642CodeGenFunction::getFuncletEHDispatchBlock(EHScopeStack::stable_iterator SI) {
David Majnemerdbf10452015-07-31 17:58:45 +0000643 // Returning nullptr indicates that the previous dispatch block should unwind
644 // to caller.
645 if (SI == EHStack.stable_end())
646 return nullptr;
647
648 // Otherwise, we should look at the actual scope.
649 EHScope &EHS = *EHStack.find(SI);
650
651 llvm::BasicBlock *DispatchBlock = EHS.getCachedEHDispatchBlock();
652 if (DispatchBlock)
653 return DispatchBlock;
654
655 if (EHS.getKind() == EHScope::Terminate)
Reid Kleckner06f19a02018-01-02 21:34:16 +0000656 DispatchBlock = getTerminateFunclet();
David Majnemerdbf10452015-07-31 17:58:45 +0000657 else
658 DispatchBlock = createBasicBlock();
John McCall7f416cc2015-09-08 08:05:57 +0000659 CGBuilderTy Builder(*this, DispatchBlock);
David Majnemerdbf10452015-07-31 17:58:45 +0000660
661 switch (EHS.getKind()) {
662 case EHScope::Catch:
663 DispatchBlock->setName("catch.dispatch");
664 break;
665
666 case EHScope::Cleanup:
667 DispatchBlock->setName("ehcleanup");
668 break;
669
670 case EHScope::Filter:
671 llvm_unreachable("exception specifications not handled yet!");
672
673 case EHScope::Terminate:
674 DispatchBlock->setName("terminate");
675 break;
676
Reid Kleckner2586aac2015-09-10 22:11:13 +0000677 case EHScope::PadEnd:
678 llvm_unreachable("PadEnd dispatch block missing!");
David Majnemerdbf10452015-07-31 17:58:45 +0000679 }
680 EHS.setCachedEHDispatchBlock(DispatchBlock);
681 return DispatchBlock;
682}
683
John McCallbd309292010-07-06 01:34:17 +0000684/// Check whether this is a non-EH scope, i.e. a scope which doesn't
685/// affect exception handling. Currently, the only non-EH scopes are
686/// normal-only cleanup scopes.
687static bool isNonEHScope(const EHScope &S) {
John McCall2b7fc382010-07-13 20:32:21 +0000688 switch (S.getKind()) {
John McCallcda666c2010-07-21 07:22:38 +0000689 case EHScope::Cleanup:
690 return !cast<EHCleanupScope>(S).isEHCleanup();
John McCall2b7fc382010-07-13 20:32:21 +0000691 case EHScope::Filter:
692 case EHScope::Catch:
693 case EHScope::Terminate:
Reid Kleckner2586aac2015-09-10 22:11:13 +0000694 case EHScope::PadEnd:
John McCall2b7fc382010-07-13 20:32:21 +0000695 return false;
696 }
697
David Blaikiee4d798f2012-01-20 21:50:17 +0000698 llvm_unreachable("Invalid EHScope Kind!");
John McCallbd309292010-07-06 01:34:17 +0000699}
700
701llvm::BasicBlock *CodeGenFunction::getInvokeDestImpl() {
702 assert(EHStack.requiresLandingPad());
703 assert(!EHStack.empty());
704
Reid Kleckner8f1b1f52016-03-01 19:51:48 +0000705 // If exceptions are disabled and SEH is not in use, then there is no invoke
706 // destination. SEH "works" even if exceptions are off. In practice, this
707 // means that C++ destructors and other EH cleanups don't run, which is
708 // consistent with MSVC's behavior.
Reid Klecknerdeeddec2015-02-05 18:56:03 +0000709 const LangOptions &LO = CGM.getLangOpts();
710 if (!LO.Exceptions) {
711 if (!LO.Borland && !LO.MicrosoftExt)
712 return nullptr;
Reid Klecknere7b3f7c2015-02-11 00:00:21 +0000713 if (!currentFunctionUsesSEHTry())
Reid Klecknerdeeddec2015-02-05 18:56:03 +0000714 return nullptr;
715 }
John McCall2b7fc382010-07-13 20:32:21 +0000716
Justin Lebar3e6449b2016-10-04 23:41:49 +0000717 // CUDA device code doesn't have exceptions.
718 if (LO.CUDA && LO.CUDAIsDevice)
719 return nullptr;
720
John McCallbd309292010-07-06 01:34:17 +0000721 // Check the innermost scope for a cached landing pad. If this is
722 // a non-EH cleanup, we'll check enclosing scopes in EmitLandingPad.
723 llvm::BasicBlock *LP = EHStack.begin()->getCachedLandingPad();
724 if (LP) return LP;
725
David Majnemerdbf10452015-07-31 17:58:45 +0000726 const EHPersonality &Personality = EHPersonality::get(*this);
727
728 if (!CurFn->hasPersonalityFn())
729 CurFn->setPersonalityFn(getOpaquePersonalityFn(CGM, Personality));
730
Reid Kleckner129552b2015-10-08 01:13:52 +0000731 if (Personality.usesFuncletPads()) {
732 // We don't need separate landing pads in the funclet model.
David Majnemerdbf10452015-07-31 17:58:45 +0000733 LP = getEHDispatchBlock(EHStack.getInnermostEHScope());
734 } else {
735 // Build the landing pad for this scope.
736 LP = EmitLandingPad();
737 }
738
John McCallbd309292010-07-06 01:34:17 +0000739 assert(LP);
740
741 // Cache the landing pad on the innermost scope. If this is a
742 // non-EH scope, cache the landing pad on the enclosing scope, too.
743 for (EHScopeStack::iterator ir = EHStack.begin(); true; ++ir) {
744 ir->setCachedLandingPad(LP);
745 if (!isNonEHScope(*ir)) break;
746 }
747
748 return LP;
749}
750
751llvm::BasicBlock *CodeGenFunction::EmitLandingPad() {
752 assert(EHStack.requiresLandingPad());
753
John McCall8e4c74b2011-08-11 02:22:43 +0000754 EHScope &innermostEHScope = *EHStack.find(EHStack.getInnermostEHScope());
755 switch (innermostEHScope.getKind()) {
756 case EHScope::Terminate:
757 return getTerminateLandingPad();
John McCallbd309292010-07-06 01:34:17 +0000758
Reid Kleckner2586aac2015-09-10 22:11:13 +0000759 case EHScope::PadEnd:
760 llvm_unreachable("PadEnd unnecessary for Itanium!");
David Majnemerdbf10452015-07-31 17:58:45 +0000761
John McCall8e4c74b2011-08-11 02:22:43 +0000762 case EHScope::Catch:
763 case EHScope::Cleanup:
764 case EHScope::Filter:
765 if (llvm::BasicBlock *lpad = innermostEHScope.getCachedLandingPad())
766 return lpad;
John McCallbd309292010-07-06 01:34:17 +0000767 }
768
769 // Save the current IR generation state.
John McCall8e4c74b2011-08-11 02:22:43 +0000770 CGBuilderTy::InsertPoint savedIP = Builder.saveAndClearIP();
Calixte Denizetfcd661d2018-09-24 18:24:18 +0000771 auto DL = ApplyDebugLocation::CreateDefaultArtificial(*this, CurEHLocation);
John McCallbd309292010-07-06 01:34:17 +0000772
773 // Create and configure the landing pad.
John McCall8e4c74b2011-08-11 02:22:43 +0000774 llvm::BasicBlock *lpad = createBasicBlock("lpad");
775 EmitBlock(lpad);
John McCallbd309292010-07-06 01:34:17 +0000776
Serge Guelton1d993272017-05-09 19:31:30 +0000777 llvm::LandingPadInst *LPadInst =
778 Builder.CreateLandingPad(llvm::StructType::get(Int8PtrTy, Int32Ty), 0);
Bill Wendlingf0724e82011-09-19 20:31:14 +0000779
780 llvm::Value *LPadExn = Builder.CreateExtractValue(LPadInst, 0);
781 Builder.CreateStore(LPadExn, getExceptionSlot());
782 llvm::Value *LPadSel = Builder.CreateExtractValue(LPadInst, 1);
783 Builder.CreateStore(LPadSel, getEHSelectorSlot());
784
John McCallbd309292010-07-06 01:34:17 +0000785 // Save the exception pointer. It's safe to use a single exception
786 // pointer per function because EH cleanups can never have nested
787 // try/catches.
Bill Wendlingf0724e82011-09-19 20:31:14 +0000788 // Build the landingpad instruction.
John McCallbd309292010-07-06 01:34:17 +0000789
790 // Accumulate all the handlers in scope.
John McCall8e4c74b2011-08-11 02:22:43 +0000791 bool hasCatchAll = false;
792 bool hasCleanup = false;
793 bool hasFilter = false;
794 SmallVector<llvm::Value*, 4> filterTypes;
795 llvm::SmallPtrSet<llvm::Value*, 4> catchTypes;
Nico Webere68b9f32015-02-25 16:25:00 +0000796 for (EHScopeStack::iterator I = EHStack.begin(), E = EHStack.end(); I != E;
797 ++I) {
John McCallbd309292010-07-06 01:34:17 +0000798
799 switch (I->getKind()) {
John McCallcda666c2010-07-21 07:22:38 +0000800 case EHScope::Cleanup:
John McCall8e4c74b2011-08-11 02:22:43 +0000801 // If we have a cleanup, remember that.
802 hasCleanup = (hasCleanup || cast<EHCleanupScope>(*I).isEHCleanup());
John McCall2b7fc382010-07-13 20:32:21 +0000803 continue;
804
John McCallbd309292010-07-06 01:34:17 +0000805 case EHScope::Filter: {
806 assert(I.next() == EHStack.end() && "EH filter is not end of EH stack");
John McCall8e4c74b2011-08-11 02:22:43 +0000807 assert(!hasCatchAll && "EH filter reached after catch-all");
John McCallbd309292010-07-06 01:34:17 +0000808
Bill Wendlingf0724e82011-09-19 20:31:14 +0000809 // Filter scopes get added to the landingpad in weird ways.
John McCall8e4c74b2011-08-11 02:22:43 +0000810 EHFilterScope &filter = cast<EHFilterScope>(*I);
811 hasFilter = true;
John McCallbd309292010-07-06 01:34:17 +0000812
Bill Wendling8c4b7162011-09-22 20:32:54 +0000813 // Add all the filter values.
814 for (unsigned i = 0, e = filter.getNumFilters(); i != e; ++i)
815 filterTypes.push_back(filter.getFilter(i));
John McCallbd309292010-07-06 01:34:17 +0000816 goto done;
817 }
818
819 case EHScope::Terminate:
820 // Terminate scopes are basically catch-alls.
John McCall8e4c74b2011-08-11 02:22:43 +0000821 assert(!hasCatchAll);
822 hasCatchAll = true;
John McCallbd309292010-07-06 01:34:17 +0000823 goto done;
824
825 case EHScope::Catch:
826 break;
David Majnemerdbf10452015-07-31 17:58:45 +0000827
Reid Kleckner2586aac2015-09-10 22:11:13 +0000828 case EHScope::PadEnd:
829 llvm_unreachable("PadEnd unnecessary for Itanium!");
John McCallbd309292010-07-06 01:34:17 +0000830 }
831
John McCall8e4c74b2011-08-11 02:22:43 +0000832 EHCatchScope &catchScope = cast<EHCatchScope>(*I);
833 for (unsigned hi = 0, he = catchScope.getNumHandlers(); hi != he; ++hi) {
834 EHCatchScope::Handler handler = catchScope.getHandler(hi);
Reid Kleckner10aa7702015-09-16 20:15:55 +0000835 assert(handler.Type.Flags == 0 &&
836 "landingpads do not support catch handler flags");
John McCallbd309292010-07-06 01:34:17 +0000837
John McCall8e4c74b2011-08-11 02:22:43 +0000838 // If this is a catch-all, register that and abort.
Reid Kleckner10aa7702015-09-16 20:15:55 +0000839 if (!handler.Type.RTTI) {
John McCall8e4c74b2011-08-11 02:22:43 +0000840 assert(!hasCatchAll);
841 hasCatchAll = true;
842 goto done;
John McCallbd309292010-07-06 01:34:17 +0000843 }
844
845 // Check whether we already have a handler for this type.
Reid Kleckner10aa7702015-09-16 20:15:55 +0000846 if (catchTypes.insert(handler.Type.RTTI).second)
Bill Wendlingf0724e82011-09-19 20:31:14 +0000847 // If not, add it directly to the landingpad.
Reid Kleckner10aa7702015-09-16 20:15:55 +0000848 LPadInst->addClause(handler.Type.RTTI);
John McCallbd309292010-07-06 01:34:17 +0000849 }
John McCallbd309292010-07-06 01:34:17 +0000850 }
851
852 done:
Bill Wendlingf0724e82011-09-19 20:31:14 +0000853 // If we have a catch-all, add null to the landingpad.
John McCall8e4c74b2011-08-11 02:22:43 +0000854 assert(!(hasCatchAll && hasFilter));
855 if (hasCatchAll) {
Bill Wendlingf0724e82011-09-19 20:31:14 +0000856 LPadInst->addClause(getCatchAllValue(*this));
John McCallbd309292010-07-06 01:34:17 +0000857
858 // If we have an EH filter, we need to add those handlers in the
Bill Wendlingf0724e82011-09-19 20:31:14 +0000859 // right place in the landingpad, which is to say, at the end.
John McCall8e4c74b2011-08-11 02:22:43 +0000860 } else if (hasFilter) {
Bill Wendling58e58fe2011-09-19 22:08:36 +0000861 // Create a filter expression: a constant array indicating which filter
862 // types there are. The personality routine only lands here if the filter
863 // doesn't match.
Dmitri Gribenkof8579502013-01-12 19:30:44 +0000864 SmallVector<llvm::Constant*, 8> Filters;
Bill Wendlingf0724e82011-09-19 20:31:14 +0000865 llvm::ArrayType *AType =
866 llvm::ArrayType::get(!filterTypes.empty() ?
867 filterTypes[0]->getType() : Int8PtrTy,
868 filterTypes.size());
869
870 for (unsigned i = 0, e = filterTypes.size(); i != e; ++i)
871 Filters.push_back(cast<llvm::Constant>(filterTypes[i]));
872 llvm::Constant *FilterArray = llvm::ConstantArray::get(AType, Filters);
873 LPadInst->addClause(FilterArray);
John McCallbd309292010-07-06 01:34:17 +0000874
875 // Also check whether we need a cleanup.
Bill Wendlingf0724e82011-09-19 20:31:14 +0000876 if (hasCleanup)
877 LPadInst->setCleanup(true);
John McCallbd309292010-07-06 01:34:17 +0000878
879 // Otherwise, signal that we at least have cleanups.
Logan Chiene9c8ccb2014-07-01 11:47:10 +0000880 } else if (hasCleanup) {
881 LPadInst->setCleanup(true);
John McCallbd309292010-07-06 01:34:17 +0000882 }
883
Bill Wendlingf0724e82011-09-19 20:31:14 +0000884 assert((LPadInst->getNumClauses() > 0 || LPadInst->isCleanup()) &&
885 "landingpad instruction has no clauses!");
John McCallbd309292010-07-06 01:34:17 +0000886
887 // Tell the backend how to generate the landing pad.
John McCall8e4c74b2011-08-11 02:22:43 +0000888 Builder.CreateBr(getEHDispatchBlock(EHStack.getInnermostEHScope()));
John McCallbd309292010-07-06 01:34:17 +0000889
890 // Restore the old IR generation state.
John McCall8e4c74b2011-08-11 02:22:43 +0000891 Builder.restoreIP(savedIP);
John McCallbd309292010-07-06 01:34:17 +0000892
John McCall8e4c74b2011-08-11 02:22:43 +0000893 return lpad;
John McCallbd309292010-07-06 01:34:17 +0000894}
895
David Majnemer4e52d6f2015-12-12 05:39:21 +0000896static void emitCatchPadBlock(CodeGenFunction &CGF, EHCatchScope &CatchScope) {
David Majnemerdbf10452015-07-31 17:58:45 +0000897 llvm::BasicBlock *DispatchBlock = CatchScope.getCachedEHDispatchBlock();
898 assert(DispatchBlock);
899
900 CGBuilderTy::InsertPoint SavedIP = CGF.Builder.saveIP();
901 CGF.EmitBlockAfterUses(DispatchBlock);
902
David Majnemer4e52d6f2015-12-12 05:39:21 +0000903 llvm::Value *ParentPad = CGF.CurrentFuncletPad;
904 if (!ParentPad)
905 ParentPad = llvm::ConstantTokenNone::get(CGF.getLLVMContext());
906 llvm::BasicBlock *UnwindBB =
907 CGF.getEHDispatchBlock(CatchScope.getEnclosingEHScope());
908
909 unsigned NumHandlers = CatchScope.getNumHandlers();
910 llvm::CatchSwitchInst *CatchSwitch =
911 CGF.Builder.CreateCatchSwitch(ParentPad, UnwindBB, NumHandlers);
David Majnemerdbf10452015-07-31 17:58:45 +0000912
913 // Test against each of the exception types we claim to catch.
David Majnemer4e52d6f2015-12-12 05:39:21 +0000914 for (unsigned I = 0; I < NumHandlers; ++I) {
David Majnemerdbf10452015-07-31 17:58:45 +0000915 const EHCatchScope::Handler &Handler = CatchScope.getHandler(I);
916
Reid Kleckner10aa7702015-09-16 20:15:55 +0000917 CatchTypeInfo TypeInfo = Handler.Type;
918 if (!TypeInfo.RTTI)
919 TypeInfo.RTTI = llvm::Constant::getNullValue(CGF.VoidPtrTy);
David Majnemerdbf10452015-07-31 17:58:45 +0000920
David Majnemer4e52d6f2015-12-12 05:39:21 +0000921 CGF.Builder.SetInsertPoint(Handler.Block);
David Majnemerdbf10452015-07-31 17:58:45 +0000922
923 if (EHPersonality::get(CGF).isMSVCXXPersonality()) {
David Majnemer4e52d6f2015-12-12 05:39:21 +0000924 CGF.Builder.CreateCatchPad(
925 CatchSwitch, {TypeInfo.RTTI, CGF.Builder.getInt32(TypeInfo.Flags),
926 llvm::Constant::getNullValue(CGF.VoidPtrTy)});
David Majnemerdbf10452015-07-31 17:58:45 +0000927 } else {
David Majnemer4e52d6f2015-12-12 05:39:21 +0000928 CGF.Builder.CreateCatchPad(CatchSwitch, {TypeInfo.RTTI});
David Majnemerdbf10452015-07-31 17:58:45 +0000929 }
930
David Majnemer4e52d6f2015-12-12 05:39:21 +0000931 CatchSwitch->addHandler(Handler.Block);
David Majnemerdbf10452015-07-31 17:58:45 +0000932 }
933 CGF.Builder.restoreIP(SavedIP);
David Majnemerdbf10452015-07-31 17:58:45 +0000934}
935
Heejin Ahnc6479192018-05-31 22:18:13 +0000936// Wasm uses Windows-style EH instructions, but it merges all catch clauses into
937// one big catchpad, within which we use Itanium's landingpad-style selector
938// comparison instructions.
939static void emitWasmCatchPadBlock(CodeGenFunction &CGF,
940 EHCatchScope &CatchScope) {
941 llvm::BasicBlock *DispatchBlock = CatchScope.getCachedEHDispatchBlock();
942 assert(DispatchBlock);
943
944 CGBuilderTy::InsertPoint SavedIP = CGF.Builder.saveIP();
945 CGF.EmitBlockAfterUses(DispatchBlock);
946
947 llvm::Value *ParentPad = CGF.CurrentFuncletPad;
948 if (!ParentPad)
949 ParentPad = llvm::ConstantTokenNone::get(CGF.getLLVMContext());
950 llvm::BasicBlock *UnwindBB =
951 CGF.getEHDispatchBlock(CatchScope.getEnclosingEHScope());
952
953 unsigned NumHandlers = CatchScope.getNumHandlers();
954 llvm::CatchSwitchInst *CatchSwitch =
955 CGF.Builder.CreateCatchSwitch(ParentPad, UnwindBB, NumHandlers);
956
957 // We don't use a landingpad instruction, so generate intrinsic calls to
958 // provide exception and selector values.
959 llvm::BasicBlock *WasmCatchStartBlock = CGF.createBasicBlock("catch.start");
960 CatchSwitch->addHandler(WasmCatchStartBlock);
961 CGF.EmitBlockAfterUses(WasmCatchStartBlock);
962
963 // Create a catchpad instruction.
964 SmallVector<llvm::Value *, 4> CatchTypes;
965 for (unsigned I = 0, E = NumHandlers; I < E; ++I) {
966 const EHCatchScope::Handler &Handler = CatchScope.getHandler(I);
967 CatchTypeInfo TypeInfo = Handler.Type;
968 if (!TypeInfo.RTTI)
969 TypeInfo.RTTI = llvm::Constant::getNullValue(CGF.VoidPtrTy);
970 CatchTypes.push_back(TypeInfo.RTTI);
971 }
972 auto *CPI = CGF.Builder.CreateCatchPad(CatchSwitch, CatchTypes);
973
974 // Create calls to wasm.get.exception and wasm.get.ehselector intrinsics.
975 // Before they are lowered appropriately later, they provide values for the
976 // exception and selector.
James Y Knight8799cae2019-02-03 21:53:49 +0000977 llvm::Function *GetExnFn =
Heejin Ahnc6479192018-05-31 22:18:13 +0000978 CGF.CGM.getIntrinsic(llvm::Intrinsic::wasm_get_exception);
James Y Knight8799cae2019-02-03 21:53:49 +0000979 llvm::Function *GetSelectorFn =
Heejin Ahnc6479192018-05-31 22:18:13 +0000980 CGF.CGM.getIntrinsic(llvm::Intrinsic::wasm_get_ehselector);
981 llvm::CallInst *Exn = CGF.Builder.CreateCall(GetExnFn, CPI);
982 CGF.Builder.CreateStore(Exn, CGF.getExceptionSlot());
983 llvm::CallInst *Selector = CGF.Builder.CreateCall(GetSelectorFn, CPI);
984
James Y Knight8799cae2019-02-03 21:53:49 +0000985 llvm::Function *TypeIDFn = CGF.CGM.getIntrinsic(llvm::Intrinsic::eh_typeid_for);
Heejin Ahnc6479192018-05-31 22:18:13 +0000986
987 // If there's only a single catch-all, branch directly to its handler.
988 if (CatchScope.getNumHandlers() == 1 &&
989 CatchScope.getHandler(0).isCatchAll()) {
990 CGF.Builder.CreateBr(CatchScope.getHandler(0).Block);
991 CGF.Builder.restoreIP(SavedIP);
992 return;
993 }
994
995 // Test against each of the exception types we claim to catch.
996 for (unsigned I = 0, E = NumHandlers;; ++I) {
997 assert(I < E && "ran off end of handlers!");
998 const EHCatchScope::Handler &Handler = CatchScope.getHandler(I);
999 CatchTypeInfo TypeInfo = Handler.Type;
1000 if (!TypeInfo.RTTI)
1001 TypeInfo.RTTI = llvm::Constant::getNullValue(CGF.VoidPtrTy);
1002
1003 // Figure out the next block.
1004 llvm::BasicBlock *NextBlock;
1005
1006 bool EmitNextBlock = false, NextIsEnd = false;
1007
1008 // If this is the last handler, we're at the end, and the next block is a
1009 // block that contains a call to the rethrow function, so we can unwind to
1010 // the enclosing EH scope. The call itself will be generated later.
1011 if (I + 1 == E) {
1012 NextBlock = CGF.createBasicBlock("rethrow");
1013 EmitNextBlock = true;
1014 NextIsEnd = true;
1015
1016 // If the next handler is a catch-all, we're at the end, and the
1017 // next block is that handler.
1018 } else if (CatchScope.getHandler(I + 1).isCatchAll()) {
1019 NextBlock = CatchScope.getHandler(I + 1).Block;
1020 NextIsEnd = true;
1021
1022 // Otherwise, we're not at the end and we need a new block.
1023 } else {
1024 NextBlock = CGF.createBasicBlock("catch.fallthrough");
1025 EmitNextBlock = true;
1026 }
1027
1028 // Figure out the catch type's index in the LSDA's type table.
1029 llvm::CallInst *TypeIndex = CGF.Builder.CreateCall(TypeIDFn, TypeInfo.RTTI);
1030 TypeIndex->setDoesNotThrow();
1031
1032 llvm::Value *MatchesTypeIndex =
1033 CGF.Builder.CreateICmpEQ(Selector, TypeIndex, "matches");
1034 CGF.Builder.CreateCondBr(MatchesTypeIndex, Handler.Block, NextBlock);
1035
1036 if (EmitNextBlock)
1037 CGF.EmitBlock(NextBlock);
1038 if (NextIsEnd)
1039 break;
1040 }
1041
1042 CGF.Builder.restoreIP(SavedIP);
1043}
1044
John McCall8e4c74b2011-08-11 02:22:43 +00001045/// Emit the structure of the dispatch block for the given catch scope.
1046/// It is an invariant that the dispatch block already exists.
David Majnemer4e52d6f2015-12-12 05:39:21 +00001047static void emitCatchDispatchBlock(CodeGenFunction &CGF,
1048 EHCatchScope &catchScope) {
Heejin Ahnc6479192018-05-31 22:18:13 +00001049 if (EHPersonality::get(CGF).isWasmPersonality())
1050 return emitWasmCatchPadBlock(CGF, catchScope);
Reid Kleckner129552b2015-10-08 01:13:52 +00001051 if (EHPersonality::get(CGF).usesFuncletPads())
1052 return emitCatchPadBlock(CGF, catchScope);
David Majnemerdbf10452015-07-31 17:58:45 +00001053
John McCall8e4c74b2011-08-11 02:22:43 +00001054 llvm::BasicBlock *dispatchBlock = catchScope.getCachedEHDispatchBlock();
1055 assert(dispatchBlock);
1056
1057 // If there's only a single catch-all, getEHDispatchBlock returned
1058 // that catch-all as the dispatch block.
1059 if (catchScope.getNumHandlers() == 1 &&
1060 catchScope.getHandler(0).isCatchAll()) {
1061 assert(dispatchBlock == catchScope.getHandler(0).Block);
David Majnemer4e52d6f2015-12-12 05:39:21 +00001062 return;
John McCall8e4c74b2011-08-11 02:22:43 +00001063 }
1064
1065 CGBuilderTy::InsertPoint savedIP = CGF.Builder.saveIP();
1066 CGF.EmitBlockAfterUses(dispatchBlock);
1067
1068 // Select the right handler.
James Y Knight8799cae2019-02-03 21:53:49 +00001069 llvm::Function *llvm_eh_typeid_for =
John McCall8e4c74b2011-08-11 02:22:43 +00001070 CGF.CGM.getIntrinsic(llvm::Intrinsic::eh_typeid_for);
1071
1072 // Load the selector value.
Bill Wendling79a70e42011-09-15 18:57:19 +00001073 llvm::Value *selector = CGF.getSelectorFromSlot();
John McCall8e4c74b2011-08-11 02:22:43 +00001074
1075 // Test against each of the exception types we claim to catch.
1076 for (unsigned i = 0, e = catchScope.getNumHandlers(); ; ++i) {
1077 assert(i < e && "ran off end of handlers!");
1078 const EHCatchScope::Handler &handler = catchScope.getHandler(i);
1079
Reid Kleckner10aa7702015-09-16 20:15:55 +00001080 llvm::Value *typeValue = handler.Type.RTTI;
1081 assert(handler.Type.Flags == 0 &&
1082 "landingpads do not support catch handler flags");
John McCall8e4c74b2011-08-11 02:22:43 +00001083 assert(typeValue && "fell into catch-all case!");
1084 typeValue = CGF.Builder.CreateBitCast(typeValue, CGF.Int8PtrTy);
1085
1086 // Figure out the next block.
1087 bool nextIsEnd;
1088 llvm::BasicBlock *nextBlock;
1089
1090 // If this is the last handler, we're at the end, and the next
1091 // block is the block for the enclosing EH scope.
1092 if (i + 1 == e) {
1093 nextBlock = CGF.getEHDispatchBlock(catchScope.getEnclosingEHScope());
1094 nextIsEnd = true;
1095
1096 // If the next handler is a catch-all, we're at the end, and the
1097 // next block is that handler.
1098 } else if (catchScope.getHandler(i+1).isCatchAll()) {
1099 nextBlock = catchScope.getHandler(i+1).Block;
1100 nextIsEnd = true;
1101
1102 // Otherwise, we're not at the end and we need a new block.
1103 } else {
1104 nextBlock = CGF.createBasicBlock("catch.fallthrough");
1105 nextIsEnd = false;
1106 }
1107
1108 // Figure out the catch type's index in the LSDA's type table.
1109 llvm::CallInst *typeIndex =
1110 CGF.Builder.CreateCall(llvm_eh_typeid_for, typeValue);
1111 typeIndex->setDoesNotThrow();
1112
1113 llvm::Value *matchesTypeIndex =
1114 CGF.Builder.CreateICmpEQ(selector, typeIndex, "matches");
1115 CGF.Builder.CreateCondBr(matchesTypeIndex, handler.Block, nextBlock);
1116
1117 // If the next handler is a catch-all, we're completely done.
1118 if (nextIsEnd) {
1119 CGF.Builder.restoreIP(savedIP);
David Majnemer4e52d6f2015-12-12 05:39:21 +00001120 return;
John McCall8e4c74b2011-08-11 02:22:43 +00001121 }
Ahmed Charles289896d2012-02-19 11:57:29 +00001122 // Otherwise we need to emit and continue at that block.
1123 CGF.EmitBlock(nextBlock);
John McCall8e4c74b2011-08-11 02:22:43 +00001124 }
John McCall8e4c74b2011-08-11 02:22:43 +00001125}
1126
1127void CodeGenFunction::popCatchScope() {
1128 EHCatchScope &catchScope = cast<EHCatchScope>(*EHStack.begin());
1129 if (catchScope.hasEHBranches())
1130 emitCatchDispatchBlock(*this, catchScope);
1131 EHStack.popCatch();
1132}
1133
John McCallb609d3f2010-07-07 06:56:46 +00001134void CodeGenFunction::ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock) {
John McCallbd309292010-07-06 01:34:17 +00001135 unsigned NumHandlers = S.getNumHandlers();
1136 EHCatchScope &CatchScope = cast<EHCatchScope>(*EHStack.begin());
1137 assert(CatchScope.getNumHandlers() == NumHandlers);
Heejin Ahnc6479192018-05-31 22:18:13 +00001138 llvm::BasicBlock *DispatchBlock = CatchScope.getCachedEHDispatchBlock();
Mike Stump58ef18b2009-11-20 23:44:51 +00001139
John McCall8e4c74b2011-08-11 02:22:43 +00001140 // If the catch was not required, bail out now.
1141 if (!CatchScope.hasEHBranches()) {
Kostya Serebryanyba4aced2014-01-09 09:22:32 +00001142 CatchScope.clearHandlerBlocks();
John McCall8e4c74b2011-08-11 02:22:43 +00001143 EHStack.popCatch();
1144 return;
1145 }
1146
1147 // Emit the structure of the EH dispatch for this catch.
David Majnemer4e52d6f2015-12-12 05:39:21 +00001148 emitCatchDispatchBlock(*this, CatchScope);
John McCall8e4c74b2011-08-11 02:22:43 +00001149
John McCallbd309292010-07-06 01:34:17 +00001150 // Copy the handler blocks off before we pop the EH stack. Emitting
1151 // the handlers might scribble on this memory.
Benjamin Kramerda32cf82015-08-04 15:38:49 +00001152 SmallVector<EHCatchScope::Handler, 8> Handlers(
1153 CatchScope.begin(), CatchScope.begin() + NumHandlers);
John McCall8e4c74b2011-08-11 02:22:43 +00001154
John McCallbd309292010-07-06 01:34:17 +00001155 EHStack.popCatch();
Mike Stump58ef18b2009-11-20 23:44:51 +00001156
John McCallbd309292010-07-06 01:34:17 +00001157 // The fall-through block.
1158 llvm::BasicBlock *ContBB = createBasicBlock("try.cont");
Mike Stump58ef18b2009-11-20 23:44:51 +00001159
John McCallbd309292010-07-06 01:34:17 +00001160 // We just emitted the body of the try; jump to the continue block.
1161 if (HaveInsertPoint())
1162 Builder.CreateBr(ContBB);
Mike Stump97329152009-12-02 19:53:57 +00001163
John McCalld8d00be2012-06-15 05:27:05 +00001164 // Determine if we need an implicit rethrow for all these catch handlers;
1165 // see the comment below.
1166 bool doImplicitRethrow = false;
John McCallb609d3f2010-07-07 06:56:46 +00001167 if (IsFnTryBlock)
John McCalld8d00be2012-06-15 05:27:05 +00001168 doImplicitRethrow = isa<CXXDestructorDecl>(CurCodeDecl) ||
1169 isa<CXXConstructorDecl>(CurCodeDecl);
John McCallb609d3f2010-07-07 06:56:46 +00001170
Heejin Ahnc6479192018-05-31 22:18:13 +00001171 // Wasm uses Windows-style EH instructions, but merges all catch clauses into
1172 // one big catchpad. So we save the old funclet pad here before we traverse
1173 // each catch handler.
1174 SaveAndRestore<llvm::Instruction *> RestoreCurrentFuncletPad(
1175 CurrentFuncletPad);
1176 llvm::BasicBlock *WasmCatchStartBlock = nullptr;
1177 if (EHPersonality::get(*this).isWasmPersonality()) {
1178 auto *CatchSwitch =
1179 cast<llvm::CatchSwitchInst>(DispatchBlock->getFirstNonPHI());
1180 WasmCatchStartBlock = CatchSwitch->hasUnwindDest()
1181 ? CatchSwitch->getSuccessor(1)
1182 : CatchSwitch->getSuccessor(0);
1183 auto *CPI = cast<llvm::CatchPadInst>(WasmCatchStartBlock->getFirstNonPHI());
1184 CurrentFuncletPad = CPI;
1185 }
1186
John McCall8e4c74b2011-08-11 02:22:43 +00001187 // Perversely, we emit the handlers backwards precisely because we
1188 // want them to appear in source order. In all of these cases, the
1189 // catch block will have exactly one predecessor, which will be a
1190 // particular block in the catch dispatch. However, in the case of
1191 // a catch-all, one of the dispatch blocks will branch to two
1192 // different handlers, and EmitBlockAfterUses will cause the second
1193 // handler to be moved before the first.
Heejin Ahnc6479192018-05-31 22:18:13 +00001194 bool HasCatchAll = false;
John McCall8e4c74b2011-08-11 02:22:43 +00001195 for (unsigned I = NumHandlers; I != 0; --I) {
Heejin Ahnc6479192018-05-31 22:18:13 +00001196 HasCatchAll |= Handlers[I - 1].isCatchAll();
John McCall8e4c74b2011-08-11 02:22:43 +00001197 llvm::BasicBlock *CatchBlock = Handlers[I-1].Block;
1198 EmitBlockAfterUses(CatchBlock);
Mike Stump75546b82009-12-10 00:06:18 +00001199
John McCallbd309292010-07-06 01:34:17 +00001200 // Catch the exception if this isn't a catch-all.
John McCall8e4c74b2011-08-11 02:22:43 +00001201 const CXXCatchStmt *C = S.getHandler(I-1);
Mike Stump58ef18b2009-11-20 23:44:51 +00001202
John McCallbd309292010-07-06 01:34:17 +00001203 // Enter a cleanup scope, including the catch variable and the
1204 // end-catch.
1205 RunCleanupsScope CatchScope(*this);
Mike Stump58ef18b2009-11-20 23:44:51 +00001206
John McCallbd309292010-07-06 01:34:17 +00001207 // Initialize the catch variable and set up the cleanups.
David Majnemer4e52d6f2015-12-12 05:39:21 +00001208 SaveAndRestore<llvm::Instruction *> RestoreCurrentFuncletPad(
1209 CurrentFuncletPad);
Reid Klecknerfff8e7f2015-03-03 19:21:04 +00001210 CGM.getCXXABI().emitBeginCatch(*this, C);
John McCallbd309292010-07-06 01:34:17 +00001211
Justin Bognerea278c32014-01-07 00:20:28 +00001212 // Emit the PGO counter increment.
Justin Bogner66242d62015-04-23 23:06:47 +00001213 incrementProfileCounter(C);
Justin Bogneref512b92014-01-06 22:27:43 +00001214
John McCallbd309292010-07-06 01:34:17 +00001215 // Perform the body of the catch.
1216 EmitStmt(C->getHandlerBlock());
1217
John McCalld8d00be2012-06-15 05:27:05 +00001218 // [except.handle]p11:
1219 // The currently handled exception is rethrown if control
1220 // reaches the end of a handler of the function-try-block of a
1221 // constructor or destructor.
1222
1223 // It is important that we only do this on fallthrough and not on
1224 // return. Note that it's illegal to put a return in a
1225 // constructor function-try-block's catch handler (p14), so this
1226 // really only applies to destructors.
1227 if (doImplicitRethrow && HaveInsertPoint()) {
David Majnemer442d0a22014-11-25 07:20:20 +00001228 CGM.getCXXABI().emitRethrow(*this, /*isNoReturn*/false);
John McCalld8d00be2012-06-15 05:27:05 +00001229 Builder.CreateUnreachable();
1230 Builder.ClearInsertionPoint();
1231 }
1232
John McCallbd309292010-07-06 01:34:17 +00001233 // Fall out through the catch cleanups.
1234 CatchScope.ForceCleanup();
1235
1236 // Branch out of the try.
1237 if (HaveInsertPoint())
1238 Builder.CreateBr(ContBB);
Mike Stump58ef18b2009-11-20 23:44:51 +00001239 }
1240
Heejin Ahnc6479192018-05-31 22:18:13 +00001241 // Because in wasm we merge all catch clauses into one big catchpad, in case
1242 // none of the types in catch handlers matches after we test against each of
1243 // them, we should unwind to the next EH enclosing scope. We generate a call
1244 // to rethrow function here to do that.
1245 if (EHPersonality::get(*this).isWasmPersonality() && !HasCatchAll) {
1246 assert(WasmCatchStartBlock);
1247 // Navigate for the "rethrow" block we created in emitWasmCatchPadBlock().
1248 // Wasm uses landingpad-style conditional branches to compare selectors, so
1249 // we follow the false destination for each of the cond branches to reach
1250 // the rethrow block.
1251 llvm::BasicBlock *RethrowBlock = WasmCatchStartBlock;
Chandler Carruthe303c872018-10-15 10:42:50 +00001252 while (llvm::Instruction *TI = RethrowBlock->getTerminator()) {
Heejin Ahnc6479192018-05-31 22:18:13 +00001253 auto *BI = cast<llvm::BranchInst>(TI);
1254 assert(BI->isConditional());
1255 RethrowBlock = BI->getSuccessor(1);
1256 }
1257 assert(RethrowBlock != WasmCatchStartBlock && RethrowBlock->empty());
1258 Builder.SetInsertPoint(RethrowBlock);
Heejin Ahn7e66a502019-03-16 05:39:12 +00001259 llvm::Function *RethrowInCatchFn =
1260 CGM.getIntrinsic(llvm::Intrinsic::wasm_rethrow_in_catch);
1261 EmitNoreturnRuntimeCallOrInvoke(RethrowInCatchFn, {});
Heejin Ahnc6479192018-05-31 22:18:13 +00001262 }
1263
John McCallbd309292010-07-06 01:34:17 +00001264 EmitBlock(ContBB);
Justin Bogner66242d62015-04-23 23:06:47 +00001265 incrementProfileCounter(&S);
Mike Stump58ef18b2009-11-20 23:44:51 +00001266}
Mike Stumpaff69af2009-12-09 03:35:49 +00001267
John McCall1e670402010-07-21 00:52:03 +00001268namespace {
David Blaikie7e70d682015-08-18 22:40:54 +00001269 struct CallEndCatchForFinally final : EHScopeStack::Cleanup {
John McCall1e670402010-07-21 00:52:03 +00001270 llvm::Value *ForEHVar;
James Y Knight9871db02019-02-05 16:42:33 +00001271 llvm::FunctionCallee EndCatchFn;
1272 CallEndCatchForFinally(llvm::Value *ForEHVar,
1273 llvm::FunctionCallee EndCatchFn)
1274 : ForEHVar(ForEHVar), EndCatchFn(EndCatchFn) {}
John McCall1e670402010-07-21 00:52:03 +00001275
Craig Topper4f12f102014-03-12 06:41:41 +00001276 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall1e670402010-07-21 00:52:03 +00001277 llvm::BasicBlock *EndCatchBB = CGF.createBasicBlock("finally.endcatch");
1278 llvm::BasicBlock *CleanupContBB =
1279 CGF.createBasicBlock("finally.cleanup.cont");
1280
1281 llvm::Value *ShouldEndCatch =
John McCall7f416cc2015-09-08 08:05:57 +00001282 CGF.Builder.CreateFlagLoad(ForEHVar, "finally.endcatch");
John McCall1e670402010-07-21 00:52:03 +00001283 CGF.Builder.CreateCondBr(ShouldEndCatch, EndCatchBB, CleanupContBB);
1284 CGF.EmitBlock(EndCatchBB);
John McCall882987f2013-02-28 19:01:20 +00001285 CGF.EmitRuntimeCallOrInvoke(EndCatchFn); // catch-all, so might throw
John McCall1e670402010-07-21 00:52:03 +00001286 CGF.EmitBlock(CleanupContBB);
1287 }
1288 };
John McCall906da4b2010-07-21 05:47:49 +00001289
David Blaikie7e70d682015-08-18 22:40:54 +00001290 struct PerformFinally final : EHScopeStack::Cleanup {
John McCall906da4b2010-07-21 05:47:49 +00001291 const Stmt *Body;
1292 llvm::Value *ForEHVar;
James Y Knight9871db02019-02-05 16:42:33 +00001293 llvm::FunctionCallee EndCatchFn;
1294 llvm::FunctionCallee RethrowFn;
John McCall906da4b2010-07-21 05:47:49 +00001295 llvm::Value *SavedExnVar;
1296
1297 PerformFinally(const Stmt *Body, llvm::Value *ForEHVar,
James Y Knight9871db02019-02-05 16:42:33 +00001298 llvm::FunctionCallee EndCatchFn,
1299 llvm::FunctionCallee RethrowFn, llvm::Value *SavedExnVar)
1300 : Body(Body), ForEHVar(ForEHVar), EndCatchFn(EndCatchFn),
1301 RethrowFn(RethrowFn), SavedExnVar(SavedExnVar) {}
John McCall906da4b2010-07-21 05:47:49 +00001302
Craig Topper4f12f102014-03-12 06:41:41 +00001303 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall906da4b2010-07-21 05:47:49 +00001304 // Enter a cleanup to call the end-catch function if one was provided.
1305 if (EndCatchFn)
John McCallcda666c2010-07-21 07:22:38 +00001306 CGF.EHStack.pushCleanup<CallEndCatchForFinally>(NormalAndEHCleanup,
1307 ForEHVar, EndCatchFn);
John McCall906da4b2010-07-21 05:47:49 +00001308
John McCallcebe0ca2010-08-11 00:16:14 +00001309 // Save the current cleanup destination in case there are
1310 // cleanups in the finally block.
1311 llvm::Value *SavedCleanupDest =
1312 CGF.Builder.CreateLoad(CGF.getNormalCleanupDestSlot(),
1313 "cleanup.dest.saved");
1314
John McCall906da4b2010-07-21 05:47:49 +00001315 // Emit the finally block.
1316 CGF.EmitStmt(Body);
1317
1318 // If the end of the finally is reachable, check whether this was
1319 // for EH. If so, rethrow.
1320 if (CGF.HaveInsertPoint()) {
1321 llvm::BasicBlock *RethrowBB = CGF.createBasicBlock("finally.rethrow");
1322 llvm::BasicBlock *ContBB = CGF.createBasicBlock("finally.cont");
1323
1324 llvm::Value *ShouldRethrow =
John McCall7f416cc2015-09-08 08:05:57 +00001325 CGF.Builder.CreateFlagLoad(ForEHVar, "finally.shouldthrow");
John McCall906da4b2010-07-21 05:47:49 +00001326 CGF.Builder.CreateCondBr(ShouldRethrow, RethrowBB, ContBB);
1327
1328 CGF.EmitBlock(RethrowBB);
1329 if (SavedExnVar) {
John McCall882987f2013-02-28 19:01:20 +00001330 CGF.EmitRuntimeCallOrInvoke(RethrowFn,
John McCall7f416cc2015-09-08 08:05:57 +00001331 CGF.Builder.CreateAlignedLoad(SavedExnVar, CGF.getPointerAlign()));
John McCall906da4b2010-07-21 05:47:49 +00001332 } else {
John McCall882987f2013-02-28 19:01:20 +00001333 CGF.EmitRuntimeCallOrInvoke(RethrowFn);
John McCall906da4b2010-07-21 05:47:49 +00001334 }
1335 CGF.Builder.CreateUnreachable();
1336
1337 CGF.EmitBlock(ContBB);
John McCallcebe0ca2010-08-11 00:16:14 +00001338
1339 // Restore the cleanup destination.
1340 CGF.Builder.CreateStore(SavedCleanupDest,
1341 CGF.getNormalCleanupDestSlot());
John McCall906da4b2010-07-21 05:47:49 +00001342 }
1343
1344 // Leave the end-catch cleanup. As an optimization, pretend that
1345 // the fallthrough path was inaccessible; we've dynamically proven
1346 // that we're not in the EH case along that path.
1347 if (EndCatchFn) {
1348 CGBuilderTy::InsertPoint SavedIP = CGF.Builder.saveAndClearIP();
1349 CGF.PopCleanupBlock();
1350 CGF.Builder.restoreIP(SavedIP);
1351 }
Fangrui Song6907ce22018-07-30 19:24:48 +00001352
John McCall906da4b2010-07-21 05:47:49 +00001353 // Now make sure we actually have an insertion point or the
1354 // cleanup gods will hate us.
1355 CGF.EnsureInsertPoint();
1356 }
1357 };
Hans Wennborgdcfba332015-10-06 23:40:43 +00001358} // end anonymous namespace
John McCall1e670402010-07-21 00:52:03 +00001359
John McCallbd309292010-07-06 01:34:17 +00001360/// Enters a finally block for an implementation using zero-cost
1361/// exceptions. This is mostly general, but hard-codes some
1362/// language/ABI-specific behavior in the catch-all sections.
James Y Knight9871db02019-02-05 16:42:33 +00001363void CodeGenFunction::FinallyInfo::enter(CodeGenFunction &CGF, const Stmt *body,
1364 llvm::FunctionCallee beginCatchFn,
1365 llvm::FunctionCallee endCatchFn,
1366 llvm::FunctionCallee rethrowFn) {
1367 assert((!!beginCatchFn) == (!!endCatchFn) &&
John McCallbd309292010-07-06 01:34:17 +00001368 "begin/end catch functions not paired");
John McCall6b0feb72011-06-22 02:32:12 +00001369 assert(rethrowFn && "rethrow function is required");
1370
1371 BeginCatchFn = beginCatchFn;
Mike Stumpaff69af2009-12-09 03:35:49 +00001372
John McCallbd309292010-07-06 01:34:17 +00001373 // The rethrow function has one of the following two types:
1374 // void (*)()
1375 // void (*)(void*)
1376 // In the latter case we need to pass it the exception object.
1377 // But we can't use the exception slot because the @finally might
1378 // have a landing pad (which would overwrite the exception slot).
James Y Knight9871db02019-02-05 16:42:33 +00001379 llvm::FunctionType *rethrowFnTy = rethrowFn.getFunctionType();
Craig Topper8a13c412014-05-21 05:09:00 +00001380 SavedExnVar = nullptr;
John McCall6b0feb72011-06-22 02:32:12 +00001381 if (rethrowFnTy->getNumParams())
1382 SavedExnVar = CGF.CreateTempAlloca(CGF.Int8PtrTy, "finally.exn");
Mike Stumpaff69af2009-12-09 03:35:49 +00001383
John McCallbd309292010-07-06 01:34:17 +00001384 // A finally block is a statement which must be executed on any edge
1385 // out of a given scope. Unlike a cleanup, the finally block may
1386 // contain arbitrary control flow leading out of itself. In
1387 // addition, finally blocks should always be executed, even if there
1388 // are no catch handlers higher on the stack. Therefore, we
1389 // surround the protected scope with a combination of a normal
1390 // cleanup (to catch attempts to break out of the block via normal
1391 // control flow) and an EH catch-all (semantically "outside" any try
1392 // statement to which the finally block might have been attached).
1393 // The finally block itself is generated in the context of a cleanup
1394 // which conditionally leaves the catch-all.
John McCall21886962010-04-21 10:05:39 +00001395
John McCallbd309292010-07-06 01:34:17 +00001396 // Jump destination for performing the finally block on an exception
1397 // edge. We'll never actually reach this block, so unreachable is
1398 // fine.
John McCall6b0feb72011-06-22 02:32:12 +00001399 RethrowDest = CGF.getJumpDestInCurrentScope(CGF.getUnreachableBlock());
John McCall21886962010-04-21 10:05:39 +00001400
John McCallbd309292010-07-06 01:34:17 +00001401 // Whether the finally block is being executed for EH purposes.
John McCall6b0feb72011-06-22 02:32:12 +00001402 ForEHVar = CGF.CreateTempAlloca(CGF.Builder.getInt1Ty(), "finally.for-eh");
John McCall7f416cc2015-09-08 08:05:57 +00001403 CGF.Builder.CreateFlagStore(false, ForEHVar);
Mike Stumpaff69af2009-12-09 03:35:49 +00001404
John McCallbd309292010-07-06 01:34:17 +00001405 // Enter a normal cleanup which will perform the @finally block.
John McCall6b0feb72011-06-22 02:32:12 +00001406 CGF.EHStack.pushCleanup<PerformFinally>(NormalCleanup, body,
1407 ForEHVar, endCatchFn,
1408 rethrowFn, SavedExnVar);
John McCallbd309292010-07-06 01:34:17 +00001409
1410 // Enter a catch-all scope.
John McCall6b0feb72011-06-22 02:32:12 +00001411 llvm::BasicBlock *catchBB = CGF.createBasicBlock("finally.catchall");
1412 EHCatchScope *catchScope = CGF.EHStack.pushCatch(1);
1413 catchScope->setCatchAllHandler(0, catchBB);
John McCallbd309292010-07-06 01:34:17 +00001414}
1415
John McCall6b0feb72011-06-22 02:32:12 +00001416void CodeGenFunction::FinallyInfo::exit(CodeGenFunction &CGF) {
John McCallbd309292010-07-06 01:34:17 +00001417 // Leave the finally catch-all.
John McCall6b0feb72011-06-22 02:32:12 +00001418 EHCatchScope &catchScope = cast<EHCatchScope>(*CGF.EHStack.begin());
1419 llvm::BasicBlock *catchBB = catchScope.getHandler(0).Block;
John McCall8e4c74b2011-08-11 02:22:43 +00001420
1421 CGF.popCatchScope();
John McCallbd309292010-07-06 01:34:17 +00001422
John McCall6b0feb72011-06-22 02:32:12 +00001423 // If there are any references to the catch-all block, emit it.
1424 if (catchBB->use_empty()) {
1425 delete catchBB;
1426 } else {
1427 CGBuilderTy::InsertPoint savedIP = CGF.Builder.saveAndClearIP();
1428 CGF.EmitBlock(catchBB);
John McCallbd309292010-07-06 01:34:17 +00001429
Craig Topper8a13c412014-05-21 05:09:00 +00001430 llvm::Value *exn = nullptr;
John McCallbd309292010-07-06 01:34:17 +00001431
John McCall6b0feb72011-06-22 02:32:12 +00001432 // If there's a begin-catch function, call it.
1433 if (BeginCatchFn) {
Bill Wendling79a70e42011-09-15 18:57:19 +00001434 exn = CGF.getExceptionFromSlot();
John McCall882987f2013-02-28 19:01:20 +00001435 CGF.EmitNounwindRuntimeCall(BeginCatchFn, exn);
John McCall6b0feb72011-06-22 02:32:12 +00001436 }
1437
1438 // If we need to remember the exception pointer to rethrow later, do so.
1439 if (SavedExnVar) {
Bill Wendling79a70e42011-09-15 18:57:19 +00001440 if (!exn) exn = CGF.getExceptionFromSlot();
John McCall7f416cc2015-09-08 08:05:57 +00001441 CGF.Builder.CreateAlignedStore(exn, SavedExnVar, CGF.getPointerAlign());
John McCall6b0feb72011-06-22 02:32:12 +00001442 }
1443
1444 // Tell the cleanups in the finally block that we're do this for EH.
John McCall7f416cc2015-09-08 08:05:57 +00001445 CGF.Builder.CreateFlagStore(true, ForEHVar);
John McCall6b0feb72011-06-22 02:32:12 +00001446
1447 // Thread a jump through the finally cleanup.
1448 CGF.EmitBranchThroughCleanup(RethrowDest);
1449
1450 CGF.Builder.restoreIP(savedIP);
1451 }
1452
1453 // Finally, leave the @finally cleanup.
1454 CGF.PopCleanupBlock();
John McCallbd309292010-07-06 01:34:17 +00001455}
1456
1457llvm::BasicBlock *CodeGenFunction::getTerminateLandingPad() {
1458 if (TerminateLandingPad)
1459 return TerminateLandingPad;
1460
1461 CGBuilderTy::InsertPoint SavedIP = Builder.saveAndClearIP();
1462
1463 // This will get inserted at the end of the function.
1464 TerminateLandingPad = createBasicBlock("terminate.lpad");
1465 Builder.SetInsertPoint(TerminateLandingPad);
1466
1467 // Tell the backend that this is a landing pad.
Reid Klecknerdeeddec2015-02-05 18:56:03 +00001468 const EHPersonality &Personality = EHPersonality::get(*this);
David Majnemerfcbdb6e2015-06-17 20:53:19 +00001469
1470 if (!CurFn->hasPersonalityFn())
1471 CurFn->setPersonalityFn(getOpaquePersonalityFn(CGM, Personality));
1472
Serge Guelton1d993272017-05-09 19:31:30 +00001473 llvm::LandingPadInst *LPadInst =
1474 Builder.CreateLandingPad(llvm::StructType::get(Int8PtrTy, Int32Ty), 0);
Bill Wendlingf0724e82011-09-19 20:31:14 +00001475 LPadInst->addClause(getCatchAllValue(*this));
John McCallbd309292010-07-06 01:34:17 +00001476
Hans Wennborgdcfba332015-10-06 23:40:43 +00001477 llvm::Value *Exn = nullptr;
Reid Klecknerfff8e7f2015-03-03 19:21:04 +00001478 if (getLangOpts().CPlusPlus)
1479 Exn = Builder.CreateExtractValue(LPadInst, 0);
1480 llvm::CallInst *terminateCall =
1481 CGM.getCXXABI().emitTerminateForUnexpectedException(*this, Exn);
John McCalle142ad52013-02-12 03:51:46 +00001482 terminateCall->setDoesNotReturn();
John McCallad7c5c12011-02-08 08:22:06 +00001483 Builder.CreateUnreachable();
Mike Stumpaff69af2009-12-09 03:35:49 +00001484
John McCallbd309292010-07-06 01:34:17 +00001485 // Restore the saved insertion state.
1486 Builder.restoreIP(SavedIP);
John McCalldac3ea62010-04-30 00:06:43 +00001487
John McCallbd309292010-07-06 01:34:17 +00001488 return TerminateLandingPad;
Mike Stumpaff69af2009-12-09 03:35:49 +00001489}
Mike Stump2b488872009-12-09 22:59:31 +00001490
1491llvm::BasicBlock *CodeGenFunction::getTerminateHandler() {
Mike Stumpf5cbb082009-12-10 00:02:42 +00001492 if (TerminateHandler)
1493 return TerminateHandler;
1494
John McCallbd309292010-07-06 01:34:17 +00001495 // Set up the terminate handler. This block is inserted at the very
1496 // end of the function by FinishFunction.
Mike Stumpf5cbb082009-12-10 00:02:42 +00001497 TerminateHandler = createBasicBlock("terminate.handler");
Reid Kleckner06f19a02018-01-02 21:34:16 +00001498 CGBuilderTy::InsertPoint SavedIP = Builder.saveAndClearIP();
John McCallbd309292010-07-06 01:34:17 +00001499 Builder.SetInsertPoint(TerminateHandler);
Reid Kleckner06f19a02018-01-02 21:34:16 +00001500
David Majnemerfeeefb22015-12-14 18:34:18 +00001501 llvm::Value *Exn = nullptr;
Reid Kleckner06f19a02018-01-02 21:34:16 +00001502 if (getLangOpts().CPlusPlus)
1503 Exn = getExceptionFromSlot();
David Majnemerfeeefb22015-12-14 18:34:18 +00001504 llvm::CallInst *terminateCall =
1505 CGM.getCXXABI().emitTerminateForUnexpectedException(*this, Exn);
1506 terminateCall->setDoesNotReturn();
1507 Builder.CreateUnreachable();
Mike Stump2b488872009-12-09 22:59:31 +00001508
John McCall21886962010-04-21 10:05:39 +00001509 // Restore the saved insertion state.
John McCallbd309292010-07-06 01:34:17 +00001510 Builder.restoreIP(SavedIP);
Mike Stump25b20fc2009-12-09 23:31:35 +00001511
Mike Stump2b488872009-12-09 22:59:31 +00001512 return TerminateHandler;
1513}
John McCallbd309292010-07-06 01:34:17 +00001514
Reid Kleckner06f19a02018-01-02 21:34:16 +00001515llvm::BasicBlock *CodeGenFunction::getTerminateFunclet() {
1516 assert(EHPersonality::get(*this).usesFuncletPads() &&
1517 "use getTerminateLandingPad for non-funclet EH");
1518
1519 llvm::BasicBlock *&TerminateFunclet = TerminateFunclets[CurrentFuncletPad];
1520 if (TerminateFunclet)
1521 return TerminateFunclet;
1522
1523 CGBuilderTy::InsertPoint SavedIP = Builder.saveAndClearIP();
1524
1525 // Set up the terminate handler. This block is inserted at the very
1526 // end of the function by FinishFunction.
1527 TerminateFunclet = createBasicBlock("terminate.handler");
1528 Builder.SetInsertPoint(TerminateFunclet);
1529
1530 // Create the cleanuppad using the current parent pad as its token. Use 'none'
1531 // if this is a top-level terminate scope, which is the common case.
1532 SaveAndRestore<llvm::Instruction *> RestoreCurrentFuncletPad(
1533 CurrentFuncletPad);
1534 llvm::Value *ParentPad = CurrentFuncletPad;
1535 if (!ParentPad)
1536 ParentPad = llvm::ConstantTokenNone::get(CGM.getLLVMContext());
1537 CurrentFuncletPad = Builder.CreateCleanupPad(ParentPad);
1538
1539 // Emit the __std_terminate call.
Heejin Ahnc6479192018-05-31 22:18:13 +00001540 llvm::Value *Exn = nullptr;
1541 // In case of wasm personality, we need to pass the exception value to
1542 // __clang_call_terminate function.
1543 if (getLangOpts().CPlusPlus &&
1544 EHPersonality::get(*this).isWasmPersonality()) {
James Y Knight8799cae2019-02-03 21:53:49 +00001545 llvm::Function *GetExnFn =
Heejin Ahnc6479192018-05-31 22:18:13 +00001546 CGM.getIntrinsic(llvm::Intrinsic::wasm_get_exception);
1547 Exn = Builder.CreateCall(GetExnFn, CurrentFuncletPad);
1548 }
Reid Kleckner06f19a02018-01-02 21:34:16 +00001549 llvm::CallInst *terminateCall =
Heejin Ahnc6479192018-05-31 22:18:13 +00001550 CGM.getCXXABI().emitTerminateForUnexpectedException(*this, Exn);
Reid Kleckner06f19a02018-01-02 21:34:16 +00001551 terminateCall->setDoesNotReturn();
1552 Builder.CreateUnreachable();
1553
1554 // Restore the saved insertion state.
1555 Builder.restoreIP(SavedIP);
1556
1557 return TerminateFunclet;
1558}
1559
David Chisnall9a837be2012-11-07 16:50:40 +00001560llvm::BasicBlock *CodeGenFunction::getEHResumeBlock(bool isCleanup) {
John McCall8e4c74b2011-08-11 02:22:43 +00001561 if (EHResumeBlock) return EHResumeBlock;
John McCallad5d61e2010-07-23 21:56:41 +00001562
1563 CGBuilderTy::InsertPoint SavedIP = Builder.saveIP();
1564
1565 // We emit a jump to a notional label at the outermost unwind state.
John McCall8e4c74b2011-08-11 02:22:43 +00001566 EHResumeBlock = createBasicBlock("eh.resume");
1567 Builder.SetInsertPoint(EHResumeBlock);
John McCallad5d61e2010-07-23 21:56:41 +00001568
Reid Klecknerdeeddec2015-02-05 18:56:03 +00001569 const EHPersonality &Personality = EHPersonality::get(*this);
John McCallad5d61e2010-07-23 21:56:41 +00001570
1571 // This can always be a call because we necessarily didn't find
1572 // anything on the EH stack which needs our help.
Benjamin Kramer793bd552012-02-08 12:41:24 +00001573 const char *RethrowName = Personality.CatchallRethrowFn;
Craig Topper8a13c412014-05-21 05:09:00 +00001574 if (RethrowName != nullptr && !isCleanup) {
John McCall882987f2013-02-28 19:01:20 +00001575 EmitRuntimeCall(getCatchallRethrowFn(CGM, RethrowName),
Nico Weberff62a6a2015-02-26 22:34:33 +00001576 getExceptionFromSlot())->setDoesNotReturn();
Logan Chiene9c8ccb2014-07-01 11:47:10 +00001577 Builder.CreateUnreachable();
1578 Builder.restoreIP(SavedIP);
1579 return EHResumeBlock;
John McCall9b382dd2011-05-28 21:13:02 +00001580 }
1581
Logan Chiene9c8ccb2014-07-01 11:47:10 +00001582 // Recreate the landingpad's return value for the 'resume' instruction.
1583 llvm::Value *Exn = getExceptionFromSlot();
1584 llvm::Value *Sel = getSelectorFromSlot();
John McCallad5d61e2010-07-23 21:56:41 +00001585
Serge Guelton1d993272017-05-09 19:31:30 +00001586 llvm::Type *LPadType = llvm::StructType::get(Exn->getType(), Sel->getType());
Logan Chiene9c8ccb2014-07-01 11:47:10 +00001587 llvm::Value *LPadVal = llvm::UndefValue::get(LPadType);
1588 LPadVal = Builder.CreateInsertValue(LPadVal, Exn, 0, "lpad.val");
1589 LPadVal = Builder.CreateInsertValue(LPadVal, Sel, 1, "lpad.val");
1590
1591 Builder.CreateResume(LPadVal);
John McCallad5d61e2010-07-23 21:56:41 +00001592 Builder.restoreIP(SavedIP);
John McCall8e4c74b2011-08-11 02:22:43 +00001593 return EHResumeBlock;
John McCallad5d61e2010-07-23 21:56:41 +00001594}
Reid Kleckner543a16c2013-09-16 21:46:30 +00001595
1596void CodeGenFunction::EmitSEHTryStmt(const SEHTryStmt &S) {
Reid Klecknerebaf28d2015-04-14 20:59:00 +00001597 EnterSEHTryStmt(S);
Reid Klecknera5930002015-02-11 21:40:48 +00001598 {
Nico Weber5779f842015-02-12 23:16:11 +00001599 JumpDest TryExit = getJumpDestInCurrentScope("__try.__leave");
Nico Weber5779f842015-02-12 23:16:11 +00001600
Reid Kleckner11c033e2015-02-12 23:40:45 +00001601 SEHTryEpilogueStack.push_back(&TryExit);
Reid Klecknera5930002015-02-11 21:40:48 +00001602 EmitStmt(S.getTryBlock());
Reid Kleckner11c033e2015-02-12 23:40:45 +00001603 SEHTryEpilogueStack.pop_back();
Nico Weber5779f842015-02-12 23:16:11 +00001604
1605 if (!TryExit.getBlock()->use_empty())
1606 EmitBlock(TryExit.getBlock(), /*IsFinished=*/true);
1607 else
1608 delete TryExit.getBlock();
Reid Klecknera5930002015-02-11 21:40:48 +00001609 }
Reid Klecknerebaf28d2015-04-14 20:59:00 +00001610 ExitSEHTryStmt(S);
Reid Kleckner1d59f992015-01-22 01:36:17 +00001611}
1612
1613namespace {
David Blaikie7e70d682015-08-18 22:40:54 +00001614struct PerformSEHFinally final : EHScopeStack::Cleanup {
Reid Klecknerebaf28d2015-04-14 20:59:00 +00001615 llvm::Function *OutlinedFinally;
Reid Kleckner55391522015-10-08 21:14:56 +00001616 PerformSEHFinally(llvm::Function *OutlinedFinally)
1617 : OutlinedFinally(OutlinedFinally) {}
Reid Kleckneraca01db2015-02-04 22:37:07 +00001618
Reid Kleckner1d59f992015-01-22 01:36:17 +00001619 void Emit(CodeGenFunction &CGF, Flags F) override {
Reid Klecknerebaf28d2015-04-14 20:59:00 +00001620 ASTContext &Context = CGF.getContext();
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001621 CodeGenModule &CGM = CGF.CGM;
Reid Kleckner65870442015-06-09 17:47:50 +00001622
Reid Klecknerd0d9a1f2015-07-01 17:10:10 +00001623 CallArgList Args;
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001624
1625 // Compute the two argument values.
1626 QualType ArgTys[2] = {Context.UnsignedCharTy, Context.VoidPtrTy};
Sanjin Sijariccfa2a2a2019-01-16 07:39:44 +00001627 llvm::Value *FP = nullptr;
1628 // If CFG.IsOutlinedSEHHelper is true, then we are within a finally block.
1629 if (CGF.IsOutlinedSEHHelper) {
1630 FP = &CGF.CurFn->arg_begin()[1];
1631 } else {
James Y Knight8799cae2019-02-03 21:53:49 +00001632 llvm::Function *LocalAddrFn =
Sanjin Sijariccfa2a2a2019-01-16 07:39:44 +00001633 CGM.getIntrinsic(llvm::Intrinsic::localaddress);
1634 FP = CGF.Builder.CreateCall(LocalAddrFn);
1635 }
1636
Reid Klecknereb11c412015-07-01 21:00:00 +00001637 llvm::Value *IsForEH =
1638 llvm::ConstantInt::get(CGF.ConvertType(ArgTys[0]), F.isForEHCleanup());
1639 Args.add(RValue::get(IsForEH), ArgTys[0]);
1640 Args.add(RValue::get(FP), ArgTys[1]);
Reid Klecknerd0d9a1f2015-07-01 17:10:10 +00001641
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001642 // Arrange a two-arg function info and type.
Reid Klecknereb11c412015-07-01 21:00:00 +00001643 const CGFunctionInfo &FnInfo =
John McCallc56a8b32016-03-11 04:30:31 +00001644 CGM.getTypes().arrangeBuiltinFunctionCall(Context.VoidTy, Args);
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001645
John McCallb92ab1a2016-10-26 23:46:34 +00001646 auto Callee = CGCallee::forDirect(OutlinedFinally);
1647 CGF.EmitCall(FnInfo, Callee, ReturnValueSlot(), Args);
Reid Kleckner1d59f992015-01-22 01:36:17 +00001648 }
1649};
Hans Wennborgdcfba332015-10-06 23:40:43 +00001650} // end anonymous namespace
Reid Kleckner1d59f992015-01-22 01:36:17 +00001651
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001652namespace {
1653/// Find all local variable captures in the statement.
1654struct CaptureFinder : ConstStmtVisitor<CaptureFinder> {
1655 CodeGenFunction &ParentCGF;
1656 const VarDecl *ParentThis;
John McCall0a490152015-09-08 21:15:22 +00001657 llvm::SmallSetVector<const VarDecl *, 4> Captures;
John McCall7f416cc2015-09-08 08:05:57 +00001658 Address SEHCodeSlot = Address::invalid();
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001659 CaptureFinder(CodeGenFunction &ParentCGF, const VarDecl *ParentThis)
1660 : ParentCGF(ParentCGF), ParentThis(ParentThis) {}
1661
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001662 // Return true if we need to do any capturing work.
1663 bool foundCaptures() {
John McCall7f416cc2015-09-08 08:05:57 +00001664 return !Captures.empty() || SEHCodeSlot.isValid();
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001665 }
1666
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001667 void Visit(const Stmt *S) {
1668 // See if this is a capture, then recurse.
1669 ConstStmtVisitor<CaptureFinder>::Visit(S);
1670 for (const Stmt *Child : S->children())
Reid Klecknerebaf28d2015-04-14 20:59:00 +00001671 if (Child)
1672 Visit(Child);
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001673 }
1674
1675 void VisitDeclRefExpr(const DeclRefExpr *E) {
1676 // If this is already a capture, just make sure we capture 'this'.
1677 if (E->refersToEnclosingVariableOrCapture()) {
John McCall0a490152015-09-08 21:15:22 +00001678 Captures.insert(ParentThis);
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001679 return;
1680 }
1681
1682 const auto *D = dyn_cast<VarDecl>(E->getDecl());
1683 if (D && D->isLocalVarDeclOrParm() && D->hasLocalStorage())
John McCall0a490152015-09-08 21:15:22 +00001684 Captures.insert(D);
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001685 }
1686
1687 void VisitCXXThisExpr(const CXXThisExpr *E) {
John McCall0a490152015-09-08 21:15:22 +00001688 Captures.insert(ParentThis);
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001689 }
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001690
1691 void VisitCallExpr(const CallExpr *E) {
1692 // We only need to add parent frame allocations for these builtins in x86.
1693 if (ParentCGF.getTarget().getTriple().getArch() != llvm::Triple::x86)
1694 return;
1695
1696 unsigned ID = E->getBuiltinCallee();
1697 switch (ID) {
1698 case Builtin::BI__exception_code:
1699 case Builtin::BI_exception_code:
1700 // This is the simple case where we are the outermost finally. All we
1701 // have to do here is make sure we escape this and recover it in the
1702 // outlined handler.
John McCall7f416cc2015-09-08 08:05:57 +00001703 if (!SEHCodeSlot.isValid())
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001704 SEHCodeSlot = ParentCGF.SEHCodeSlotStack.back();
1705 break;
1706 }
1707 }
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001708};
Hans Wennborgdcfba332015-10-06 23:40:43 +00001709} // end anonymous namespace
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001710
Reid Kleckner39329d57b2015-12-16 00:26:37 +00001711Address CodeGenFunction::recoverAddrOfEscapedLocal(CodeGenFunction &ParentCGF,
1712 Address ParentVar,
1713 llvm::Value *ParentFP) {
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001714 llvm::CallInst *RecoverCall = nullptr;
John McCall7f416cc2015-09-08 08:05:57 +00001715 CGBuilderTy Builder(*this, AllocaInsertPt);
1716 if (auto *ParentAlloca = dyn_cast<llvm::AllocaInst>(ParentVar.getPointer())) {
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001717 // Mark the variable escaped if nobody else referenced it and compute the
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00001718 // localescape index.
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001719 auto InsertPair = ParentCGF.EscapedLocals.insert(
1720 std::make_pair(ParentAlloca, ParentCGF.EscapedLocals.size()));
1721 int FrameEscapeIdx = InsertPair.first->second;
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00001722 // call i8* @llvm.localrecover(i8* bitcast(@parentFn), i8* %fp, i32 N)
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001723 llvm::Function *FrameRecoverFn = llvm::Intrinsic::getDeclaration(
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00001724 &CGM.getModule(), llvm::Intrinsic::localrecover);
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001725 llvm::Constant *ParentI8Fn =
1726 llvm::ConstantExpr::getBitCast(ParentCGF.CurFn, Int8PtrTy);
1727 RecoverCall = Builder.CreateCall(
1728 FrameRecoverFn, {ParentI8Fn, ParentFP,
1729 llvm::ConstantInt::get(Int32Ty, FrameEscapeIdx)});
1730
1731 } else {
1732 // If the parent didn't have an alloca, we're doing some nested outlining.
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00001733 // Just clone the existing localrecover call, but tweak the FP argument to
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001734 // use our FP value. All other arguments are constants.
1735 auto *ParentRecover =
John McCall7f416cc2015-09-08 08:05:57 +00001736 cast<llvm::IntrinsicInst>(ParentVar.getPointer()->stripPointerCasts());
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00001737 assert(ParentRecover->getIntrinsicID() == llvm::Intrinsic::localrecover &&
1738 "expected alloca or localrecover in parent LocalDeclMap");
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001739 RecoverCall = cast<llvm::CallInst>(ParentRecover->clone());
1740 RecoverCall->setArgOperand(1, ParentFP);
1741 RecoverCall->insertBefore(AllocaInsertPt);
1742 }
1743
1744 // Bitcast the variable, rename it, and insert it in the local decl map.
1745 llvm::Value *ChildVar =
John McCall7f416cc2015-09-08 08:05:57 +00001746 Builder.CreateBitCast(RecoverCall, ParentVar.getType());
1747 ChildVar->setName(ParentVar.getName());
1748 return Address(ChildVar, ParentVar.getAlignment());
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001749}
1750
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001751void CodeGenFunction::EmitCapturedLocals(CodeGenFunction &ParentCGF,
Reid Kleckner0b9bbbf2015-06-09 17:49:42 +00001752 const Stmt *OutlinedStmt,
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001753 bool IsFilter) {
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001754 // Find all captures in the Stmt.
1755 CaptureFinder Finder(ParentCGF, ParentCGF.CXXABIThisDecl);
1756 Finder.Visit(OutlinedStmt);
1757
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001758 // We can exit early on x86_64 when there are no captures. We just have to
1759 // save the exception code in filters so that __exception_code() works.
1760 if (!Finder.foundCaptures() &&
1761 CGM.getTarget().getTriple().getArch() != llvm::Triple::x86) {
1762 if (IsFilter)
1763 EmitSEHExceptionCodeSave(ParentCGF, nullptr, nullptr);
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001764 return;
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001765 }
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001766
Reid Kleckner39329d57b2015-12-16 00:26:37 +00001767 llvm::Value *EntryFP = nullptr;
1768 CGBuilderTy Builder(CGM, AllocaInsertPt);
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001769 if (IsFilter && CGM.getTarget().getTriple().getArch() == llvm::Triple::x86) {
1770 // 32-bit SEH filters need to be careful about FP recovery. The end of the
1771 // EH registration is passed in as the EBP physical register. We can
Reid Kleckner39329d57b2015-12-16 00:26:37 +00001772 // recover that with llvm.frameaddress(1).
1773 EntryFP = Builder.CreateCall(
Christudasan Devadasan8c5e6fa2019-07-22 12:50:30 +00001774 CGM.getIntrinsic(llvm::Intrinsic::frameaddress, AllocaInt8PtrTy),
1775 {Builder.getInt32(1)});
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001776 } 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;
Reid Kleckner39329d57b2015-12-16 00:26:37 +00001781 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 =
Eli Friedmanc4c43b22019-01-16 00:50:44 +00001790 CGM.getIntrinsic(llvm::Intrinsic::eh_recoverfp);
Reid Kleckner39329d57b2015-12-16 00:26:37 +00001791 llvm::Constant *ParentI8Fn =
1792 llvm::ConstantExpr::getBitCast(ParentCGF.CurFn, Int8PtrTy);
1793 ParentFP = Builder.CreateCall(RecoverFPIntrin, {ParentI8Fn, EntryFP});
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001794 }
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001795
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00001796 // Create llvm.localrecover calls for all captures.
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001797 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 }
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001807 assert((isa<ImplicitParamDecl>(VD) || VD->isLocalVarDeclOrParm()) &&
1808 "captured non-local variable");
1809
Reid Klecknerebaf28d2015-04-14 20:59:00 +00001810 // 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;
Reid Klecknerebaf28d2015-04-14 20:59:00 +00001815
John McCall7f416cc2015-09-08 08:05:57 +00001816 Address ParentVar = I->second;
Reid Kleckner39329d57b2015-12-16 00:26:37 +00001817 setAddrOfLocalVar(
1818 VD, recoverAddrOfEscapedLocal(ParentCGF, ParentVar, ParentFP));
Nico Webere4f974c2015-07-02 06:10:53 +00001819 }
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001820
John McCall7f416cc2015-09-08 08:05:57 +00001821 if (Finder.SEHCodeSlot.isValid()) {
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001822 SEHCodeSlotStack.push_back(
1823 recoverAddrOfEscapedLocal(ParentCGF, Finder.SEHCodeSlot, ParentFP));
1824 }
1825
1826 if (IsFilter)
Reid Kleckner39329d57b2015-12-16 00:26:37 +00001827 EmitSEHExceptionCodeSave(ParentCGF, ParentFP, EntryFP);
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001828}
1829
Reid Klecknerebaf28d2015-04-14 20:59:00 +00001830/// 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);
1833void CodeGenFunction::startOutlinedSEHHelper(CodeGenFunction &ParentCGF,
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001834 bool IsFilter,
Reid Klecknerebaf28d2015-04-14 20:59:00 +00001835 const Stmt *OutlinedStmt) {
Stephen Kellyf2ceec42018-08-09 21:08:08 +00001836 SourceLocation StartLoc = OutlinedStmt->getBeginLoc();
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001837
1838 // Get the mangled function name.
1839 SmallString<128> Name;
1840 {
1841 llvm::raw_svector_ostream OS(Name);
David Chisnall93ce0182018-08-10 12:53:13 +00001842 const NamedDecl *ParentSEHFn = ParentCGF.CurSEHParent;
David Majnemer25eb1652016-03-01 19:42:53 +00001843 assert(ParentSEHFn && "No CurSEHParent!");
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001844 MangleContext &Mangler = CGM.getCXXABI().getMangleContext();
1845 if (IsFilter)
David Majnemer25eb1652016-03-01 19:42:53 +00001846 Mangler.mangleSEHFilterExpression(ParentSEHFn, OS);
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001847 else
David Majnemer25eb1652016-03-01 19:42:53 +00001848 Mangler.mangleSEHFinallyBlock(ParentSEHFn, OS);
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001849 }
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(
Alexey Bataev56223232017-06-09 13:40:18 +00001857 getContext(), /*DC=*/nullptr, StartLoc,
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001858 &getContext().Idents.get("exception_pointers"),
Alexey Bataev56223232017-06-09 13:40:18 +00001859 getContext().VoidPtrTy, ImplicitParamDecl::Other));
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001860 } else {
1861 Args.push_back(ImplicitParamDecl::Create(
Alexey Bataev56223232017-06-09 13:40:18 +00001862 getContext(), /*DC=*/nullptr, StartLoc,
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001863 &getContext().Idents.get("abnormal_termination"),
Alexey Bataev56223232017-06-09 13:40:18 +00001864 getContext().UnsignedCharTy, ImplicitParamDecl::Other));
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001865 }
1866 Args.push_back(ImplicitParamDecl::Create(
Alexey Bataev56223232017-06-09 13:40:18 +00001867 getContext(), /*DC=*/nullptr, StartLoc,
1868 &getContext().Idents.get("frame_pointer"), getContext().VoidPtrTy,
1869 ImplicitParamDecl::Other));
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001870 }
1871
1872 QualType RetTy = IsFilter ? getContext().LongTy : getContext().VoidTy;
1873
John McCallc56a8b32016-03-11 04:30:31 +00001874 const CGFunctionInfo &FnInfo =
1875 CGM.getTypes().arrangeBuiltinFunctionDeclaration(RetTy, Args);
Reid Klecknerebaf28d2015-04-14 20:59:00 +00001876
Reid Kleckner1d59f992015-01-22 01:36:17 +00001877 llvm::FunctionType *FnTy = CGM.getTypes().GetFunctionType(FnInfo);
Reid Klecknerebaf28d2015-04-14 20:59:00 +00001878 llvm::Function *Fn = llvm::Function::Create(
1879 FnTy, llvm::GlobalValue::InternalLinkage, Name.str(), &CGM.getModule());
Reid Kleckner1d59f992015-01-22 01:36:17 +00001880
Reid Klecknerebaf28d2015-04-14 20:59:00 +00001881 IsOutlinedSEHHelper = true;
Nico Weberf2a39a72015-04-13 20:03:03 +00001882
Reid Klecknerebaf28d2015-04-14 20:59:00 +00001883 StartFunction(GlobalDecl(), RetTy, Fn, FnInfo, Args,
Stephen Kellyf2ceec42018-08-09 21:08:08 +00001884 OutlinedStmt->getBeginLoc(), OutlinedStmt->getBeginLoc());
David Majnemer25eb1652016-03-01 19:42:53 +00001885 CurSEHParent = ParentCGF.CurSEHParent;
Reid Klecknerebaf28d2015-04-14 20:59:00 +00001886
Erich Keanede6480a32018-11-13 15:48:08 +00001887 CGM.SetLLVMFunctionAttributes(GlobalDecl(), FnInfo, CurFn);
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001888 EmitCapturedLocals(ParentCGF, OutlinedStmt, IsFilter);
Reid Klecknerebaf28d2015-04-14 20:59:00 +00001889}
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.
1894llvm::Function *
1895CodeGenFunction::GenerateSEHFilterFunction(CodeGenFunction &ParentCGF,
1896 const SEHExceptStmt &Except) {
1897 const Expr *FilterExpr = Except.getFilterExpr();
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001898 startOutlinedSEHHelper(ParentCGF, true, FilterExpr);
Reid Kleckner1d59f992015-01-22 01:36:17 +00001899
1900 // Emit the original filter expression, convert to i32, and return.
1901 llvm::Value *R = EmitScalarExpr(FilterExpr);
David Majnemer2ccba832015-04-17 06:57:25 +00001902 R = Builder.CreateIntCast(R, ConvertType(getContext().LongTy),
Reid Kleckner1d59f992015-01-22 01:36:17 +00001903 FilterExpr->getType()->isSignedIntegerType());
1904 Builder.CreateStore(R, ReturnValue);
1905
Stephen Kelly1c301dc2018-08-09 21:09:38 +00001906 FinishFunction(FilterExpr->getEndLoc());
Reid Kleckner1d59f992015-01-22 01:36:17 +00001907
Reid Klecknerebaf28d2015-04-14 20:59:00 +00001908 return CurFn;
1909}
1910
1911llvm::Function *
1912CodeGenFunction::GenerateSEHFinallyFunction(CodeGenFunction &ParentCGF,
1913 const SEHFinallyStmt &Finally) {
1914 const Stmt *FinallyBlock = Finally.getBlock();
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001915 startOutlinedSEHHelper(ParentCGF, false, FinallyBlock);
Reid Klecknerebaf28d2015-04-14 20:59:00 +00001916
Reid Klecknerebaf28d2015-04-14 20:59:00 +00001917 // Emit the original filter expression, convert to i32, and return.
1918 EmitStmt(FinallyBlock);
1919
Stephen Kelly1c301dc2018-08-09 21:09:38 +00001920 FinishFunction(FinallyBlock->getEndLoc());
Reid Klecknerebaf28d2015-04-14 20:59:00 +00001921
1922 return CurFn;
Reid Kleckner1d59f992015-01-22 01:36:17 +00001923}
1924
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001925void CodeGenFunction::EmitSEHExceptionCodeSave(CodeGenFunction &ParentCGF,
1926 llvm::Value *ParentFP,
Reid Kleckner39329d57b2015-12-16 00:26:37 +00001927 llvm::Value *EntryFP) {
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001928 // 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.
Duncan P. N. Exon Smith9f5260a2015-11-06 23:00:41 +00001932 SEHInfo = &*CurFn->arg_begin();
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001933 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.
Reid Kleckner39329d57b2015-12-16 00:26:37 +00001940 SEHInfo = Builder.CreateConstInBoundsGEP1_32(Int8Ty, EntryFP, -20);
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001941 SEHInfo = Builder.CreateBitCast(SEHInfo, Int8PtrTy->getPointerTo());
John McCall7f416cc2015-09-08 08:05:57 +00001942 SEHInfo = Builder.CreateAlignedLoad(Int8PtrTy, SEHInfo, getPointerAlign());
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001943 SEHCodeSlotStack.push_back(recoverAddrOfEscapedLocal(
1944 ParentCGF, ParentCGF.SEHCodeSlotStack.back(), ParentFP));
1945 }
1946
Reid Kleckner1d59f992015-01-22 01:36:17 +00001947 // 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 // };
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001953 // int exceptioncode = exception_pointers->ExceptionRecord->ExceptionCode;
Reid Kleckner1d59f992015-01-22 01:36:17 +00001954 llvm::Type *RecordTy = CGM.Int32Ty->getPointerTo();
Serge Guelton1d993272017-05-09 19:31:30 +00001955 llvm::Type *PtrsTy = llvm::StructType::get(RecordTy, CGM.VoidPtrTy);
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001956 llvm::Value *Ptrs = Builder.CreateBitCast(SEHInfo, PtrsTy->getPointerTo());
David Blaikie1ed728c2015-04-05 22:45:47 +00001957 llvm::Value *Rec = Builder.CreateStructGEP(PtrsTy, Ptrs, 0);
John McCall7f416cc2015-09-08 08:05:57 +00001958 Rec = Builder.CreateAlignedLoad(Rec, getPointerAlign());
1959 llvm::Value *Code = Builder.CreateAlignedLoad(Rec, getIntAlign());
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001960 assert(!SEHCodeSlotStack.empty() && "emitting EH code outside of __except");
1961 Builder.CreateStore(Code, SEHCodeSlotStack.back());
Reid Kleckner1d59f992015-01-22 01:36:17 +00001962}
1963
1964llvm::Value *CodeGenFunction::EmitSEHExceptionInfo() {
1965 // Sema should diagnose calling this builtin outside of a filter context, but
1966 // don't crash if we screw up.
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001967 if (!SEHInfo)
Reid Kleckner1d59f992015-01-22 01:36:17 +00001968 return llvm::UndefValue::get(Int8PtrTy);
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001969 assert(SEHInfo->getType() == Int8PtrTy);
1970 return SEHInfo;
Reid Kleckner1d59f992015-01-22 01:36:17 +00001971}
1972
1973llvm::Value *CodeGenFunction::EmitSEHExceptionCode() {
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001974 assert(!SEHCodeSlotStack.empty() && "emitting EH code outside of __except");
John McCall7f416cc2015-09-08 08:05:57 +00001975 return Builder.CreateLoad(SEHCodeSlotStack.back());
Reid Kleckner1d59f992015-01-22 01:36:17 +00001976}
1977
Reid Kleckneraca01db2015-02-04 22:37:07 +00001978llvm::Value *CodeGenFunction::EmitSEHAbnormalTermination() {
Reid Klecknerebaf28d2015-04-14 20:59:00 +00001979 // 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);
Reid Kleckneraca01db2015-02-04 22:37:07 +00001983}
1984
David Chisnall93ce0182018-08-10 12:53:13 +00001985void CodeGenFunction::pushSEHCleanup(CleanupKind Kind,
1986 llvm::Function *FinallyFunc) {
1987 EHStack.pushCleanup<PerformSEHFinally>(Kind, FinallyFunc);
1988}
1989
Reid Klecknerebaf28d2015-04-14 20:59:00 +00001990void CodeGenFunction::EnterSEHTryStmt(const SEHTryStmt &S) {
1991 CodeGenFunction HelperCGF(CGM, /*suppressNewContext=*/true);
1992 if (const SEHFinallyStmt *Finally = S.getFinallyHandler()) {
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001993 // Outline the finally block.
Reid Klecknerebaf28d2015-04-14 20:59:00 +00001994 llvm::Function *FinallyFunc =
1995 HelperCGF.GenerateSEHFinallyFunction(*this, *Finally);
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001996
1997 // Push a cleanup for __finally blocks.
Reid Kleckner55391522015-10-08 21:14:56 +00001998 EHStack.pushCleanup<PerformSEHFinally>(NormalAndEHCleanup, FinallyFunc);
Reid Kleckner1d59f992015-01-22 01:36:17 +00001999 return;
2000 }
2001
2002 // Otherwise, we must have an __except block.
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002003 const SEHExceptStmt *Except = S.getExceptHandler();
Reid Kleckner1d59f992015-01-22 01:36:17 +00002004 assert(Except);
2005 EHCatchScope *CatchScope = EHStack.pushCatch(1);
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002006 SEHCodeSlotStack.push_back(
2007 CreateMemTemp(getContext().IntTy, "__exception_code"));
Reid Kleckner2a2e1562015-01-22 02:25:56 +00002008
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002009 // 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.
Reid Kleckner2a2e1562015-01-22 02:25:56 +00002012 llvm::Constant *C =
John McCallde0fe072017-08-15 21:42:52 +00002013 ConstantEmitter(*this).tryEmitAbstract(Except->getFilterExpr(),
2014 getContext().IntTy);
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002015 if (CGM.getTarget().getTriple().getArch() != llvm::Triple::x86 && C &&
2016 C->isOneValue()) {
Reid Kleckner2a2e1562015-01-22 02:25:56 +00002017 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.
Reid Kleckner1d59f992015-01-22 01:36:17 +00002023 llvm::Function *FilterFunc =
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002024 HelperCGF.GenerateSEHFilterFunction(*this, *Except);
Reid Kleckner1d59f992015-01-22 01:36:17 +00002025 llvm::Constant *OpaqueFunc =
2026 llvm::ConstantExpr::getBitCast(FilterFunc, Int8PtrTy);
Reid Kleckner8be18472015-09-16 21:06:09 +00002027 CatchScope->setHandler(0, OpaqueFunc, createBasicBlock("__except.ret"));
Reid Kleckner1d59f992015-01-22 01:36:17 +00002028}
2029
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002030void CodeGenFunction::ExitSEHTryStmt(const SEHTryStmt &S) {
Reid Kleckner1d59f992015-01-22 01:36:17 +00002031 // Just pop the cleanup if it's a __finally block.
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002032 if (S.getFinallyHandler()) {
Reid Kleckner1d59f992015-01-22 01:36:17 +00002033 PopCleanupBlock();
2034 return;
2035 }
2036
2037 // Otherwise, we must have an __except block.
Reid Kleckneraca01db2015-02-04 22:37:07 +00002038 const SEHExceptStmt *Except = S.getExceptHandler();
Reid Kleckner1d59f992015-01-22 01:36:17 +00002039 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();
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002048 SEHCodeSlotStack.pop_back();
Reid Kleckner1d59f992015-01-22 01:36:17 +00002049 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.
David Majnemer4e52d6f2015-12-12 05:39:21 +00002063 llvm::BasicBlock *CatchPadBB = CatchScope.getHandler(0).Block;
Reid Kleckner1d59f992015-01-22 01:36:17 +00002064 EHStack.popCatch();
2065
David Majnemer4e52d6f2015-12-12 05:39:21 +00002066 EmitBlockAfterUses(CatchPadBB);
Reid Kleckner1d59f992015-01-22 01:36:17 +00002067
Reid Kleckner129552b2015-10-08 01:13:52 +00002068 // __except blocks don't get outlined into funclets, so immediately do a
2069 // catchret.
Reid Kleckner129552b2015-10-08 01:13:52 +00002070 llvm::CatchPadInst *CPI =
2071 cast<llvm::CatchPadInst>(CatchPadBB->getFirstNonPHI());
David Majnemer4e52d6f2015-12-12 05:39:21 +00002072 llvm::BasicBlock *ExceptBB = createBasicBlock("__except");
Reid Kleckner129552b2015-10-08 01:13:52 +00002073 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());
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002082 }
2083
Reid Kleckner1d59f992015-01-22 01:36:17 +00002084 // Emit the __except body.
2085 EmitStmt(Except->getBlock());
2086
Reid Kleckner9fe7f232015-07-07 00:36:30 +00002087 // End the lifetime of the exception code.
2088 SEHCodeSlotStack.pop_back();
2089
Reid Kleckner3a417c32015-01-30 22:16:45 +00002090 if (HaveInsertPoint())
2091 Builder.CreateBr(ContBB);
Reid Kleckner1d59f992015-01-22 01:36:17 +00002092
2093 EmitBlock(ContBB);
Reid Kleckner543a16c2013-09-16 21:46:30 +00002094}
Nico Weber9b982072014-07-07 00:12:30 +00002095
2096void CodeGenFunction::EmitSEHLeaveStmt(const SEHLeaveStmt &S) {
Nico Weber5779f842015-02-12 23:16:11 +00002097 // 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
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002103 // 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
Nico Weber5779f842015-02-12 23:16:11 +00002111 EmitBranchThroughCleanup(*SEHTryEpilogueStack.back());
Nico Weber9b982072014-07-07 00:12:30 +00002112}