blob: eaa76109be1e8deff3b7295fa7d8184daa14257e [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//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This contains code dealing with C++ exception related code generation.
11//
12//===----------------------------------------------------------------------===//
13
14#include "CodeGenFunction.h"
David Majnemer442d0a22014-11-25 07:20:20 +000015#include "CGCXXABI.h"
Chandler Carruth0d9593d2015-01-14 11:29:14 +000016#include "CGCleanup.h"
Benjamin Kramer793bd552012-02-08 12:41:24 +000017#include "CGObjCRuntime.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 Carruthc80ceea2014-03-04 11:02:08 +000024#include "llvm/IR/CallSite.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000025#include "llvm/IR/Intrinsics.h"
Reid Kleckner31a1bb02015-04-08 22:23:48 +000026#include "llvm/IR/IntrinsicInst.h"
Reid Klecknerebaf28d2015-04-14 20:59:00 +000027#include "llvm/Support/SaveAndRestore.h"
John McCallbd309292010-07-06 01:34:17 +000028
Anders Carlsson4b08db72009-10-30 01:42:31 +000029using namespace clang;
30using namespace CodeGen;
31
John McCall2c33ba82013-02-12 03:51:38 +000032static llvm::Constant *getFreeExceptionFn(CodeGenModule &CGM) {
Mike Stump33270212009-12-02 07:41:41 +000033 // void __cxa_free_exception(void *thrown_exception);
Mike Stump75546b82009-12-10 00:06:18 +000034
Chris Lattner2192fe52011-07-18 04:24:23 +000035 llvm::FunctionType *FTy =
John McCall2c33ba82013-02-12 03:51:38 +000036 llvm::FunctionType::get(CGM.VoidTy, CGM.Int8PtrTy, /*IsVarArgs=*/false);
Mike Stump75546b82009-12-10 00:06:18 +000037
John McCall2c33ba82013-02-12 03:51:38 +000038 return CGM.CreateRuntimeFunction(FTy, "__cxa_free_exception");
Mike Stump33270212009-12-02 07:41:41 +000039}
40
John McCall2c33ba82013-02-12 03:51:38 +000041static llvm::Constant *getUnexpectedFn(CodeGenModule &CGM) {
Richard Smith2f7aa192013-06-20 23:03:35 +000042 // void __cxa_call_unexpected(void *thrown_exception);
Mike Stump1d849212009-12-07 23:38:24 +000043
Chris Lattner2192fe52011-07-18 04:24:23 +000044 llvm::FunctionType *FTy =
John McCall2c33ba82013-02-12 03:51:38 +000045 llvm::FunctionType::get(CGM.VoidTy, CGM.Int8PtrTy, /*IsVarArgs=*/false);
Mike Stump75546b82009-12-10 00:06:18 +000046
John McCall2c33ba82013-02-12 03:51:38 +000047 return CGM.CreateRuntimeFunction(FTy, "__cxa_call_unexpected");
Mike Stump1d849212009-12-07 23:38:24 +000048}
49
Reid Klecknerfff8e7f2015-03-03 19:21:04 +000050llvm::Constant *CodeGenModule::getTerminateFn() {
Mike Stump33270212009-12-02 07:41:41 +000051 // void __terminate();
52
Chris Lattner2192fe52011-07-18 04:24:23 +000053 llvm::FunctionType *FTy =
Reid Klecknerfff8e7f2015-03-03 19:21:04 +000054 llvm::FunctionType::get(VoidTy, /*IsVarArgs=*/false);
Mike Stump75546b82009-12-10 00:06:18 +000055
Chris Lattner0e62c1c2011-07-23 10:55:15 +000056 StringRef name;
John McCall9de19782011-07-06 01:22:26 +000057
58 // In C++, use std::terminate().
Reid Klecknerfff8e7f2015-03-03 19:21:04 +000059 if (getLangOpts().CPlusPlus &&
60 getTarget().getCXXABI().isItaniumFamily()) {
Reid Kleckner1d59f992015-01-22 01:36:17 +000061 name = "_ZSt9terminatev";
Reid Klecknerfff8e7f2015-03-03 19:21:04 +000062 } else if (getLangOpts().CPlusPlus &&
63 getTarget().getCXXABI().isMicrosoft()) {
David Majnemerb710a932015-05-11 03:57:49 +000064 if (getLangOpts().isCompatibleWithMSVC(LangOptions::MSVC2015))
David Majnemerfb6ffca2015-05-10 21:38:26 +000065 name = "__std_terminate";
66 else
67 name = "\01?terminate@@YAXXZ";
Reid Klecknerfff8e7f2015-03-03 19:21:04 +000068 } else if (getLangOpts().ObjC1 &&
69 getLangOpts().ObjCRuntime.hasTerminate())
John McCall9de19782011-07-06 01:22:26 +000070 name = "objc_terminate";
71 else
72 name = "abort";
Reid Klecknerfff8e7f2015-03-03 19:21:04 +000073 return CreateRuntimeFunction(FTy, name);
David Chisnallf9c42252010-05-17 13:49:20 +000074}
75
John McCall2c33ba82013-02-12 03:51:38 +000076static llvm::Constant *getCatchallRethrowFn(CodeGenModule &CGM,
Chris Lattner0e62c1c2011-07-23 10:55:15 +000077 StringRef Name) {
Chris Lattner2192fe52011-07-18 04:24:23 +000078 llvm::FunctionType *FTy =
John McCall2c33ba82013-02-12 03:51:38 +000079 llvm::FunctionType::get(CGM.VoidTy, CGM.Int8PtrTy, /*IsVarArgs=*/false);
John McCall36ea3722010-07-17 00:43:08 +000080
John McCall2c33ba82013-02-12 03:51:38 +000081 return CGM.CreateRuntimeFunction(FTy, Name);
John McCallbd309292010-07-06 01:34:17 +000082}
83
Craig Topper8a13c412014-05-21 05:09:00 +000084const EHPersonality EHPersonality::GNU_C = { "__gcc_personality_v0", nullptr };
Benjamin Kramer793bd552012-02-08 12:41:24 +000085const EHPersonality
Craig Topper8a13c412014-05-21 05:09:00 +000086EHPersonality::GNU_C_SJLJ = { "__gcc_personality_sj0", nullptr };
87const EHPersonality
Reid Kleckner8f45c9c2014-09-15 17:19:16 +000088EHPersonality::GNU_C_SEH = { "__gcc_personality_seh0", nullptr };
89const EHPersonality
Craig Topper8a13c412014-05-21 05:09:00 +000090EHPersonality::NeXT_ObjC = { "__objc_personality_v0", nullptr };
91const EHPersonality
92EHPersonality::GNU_CPlusPlus = { "__gxx_personality_v0", nullptr };
93const EHPersonality
94EHPersonality::GNU_CPlusPlus_SJLJ = { "__gxx_personality_sj0", nullptr };
Benjamin Kramer793bd552012-02-08 12:41:24 +000095const EHPersonality
Reid Kleckner8f45c9c2014-09-15 17:19:16 +000096EHPersonality::GNU_CPlusPlus_SEH = { "__gxx_personality_seh0", nullptr };
97const EHPersonality
Benjamin Kramer793bd552012-02-08 12:41:24 +000098EHPersonality::GNU_ObjC = {"__gnu_objc_personality_v0", "objc_exception_throw"};
99const EHPersonality
Craig Topper8a13c412014-05-21 05:09:00 +0000100EHPersonality::GNU_ObjCXX = { "__gnustep_objcxx_personality_v0", nullptr };
David Chisnall2ec1b10d2013-01-11 15:33:01 +0000101const EHPersonality
Craig Topper8a13c412014-05-21 05:09:00 +0000102EHPersonality::GNUstep_ObjC = { "__gnustep_objc_personality_v0", nullptr };
Reid Kleckner1d59f992015-01-22 01:36:17 +0000103const EHPersonality
104EHPersonality::MSVC_except_handler = { "_except_handler3", nullptr };
105const EHPersonality
106EHPersonality::MSVC_C_specific_handler = { "__C_specific_handler", nullptr };
Reid Klecknerdeeddec2015-02-05 18:56:03 +0000107const EHPersonality
108EHPersonality::MSVC_CxxFrameHandler3 = { "__CxxFrameHandler3", nullptr };
John McCall36ea3722010-07-17 00:43:08 +0000109
Reid Klecknere070b992014-11-14 02:01:10 +0000110/// On Win64, use libgcc's SEH personality function. We fall back to dwarf on
111/// other platforms, unless the user asked for SjLj exceptions.
112static bool useLibGCCSEHPersonality(const llvm::Triple &T) {
113 return T.isOSWindows() && T.getArch() == llvm::Triple::x86_64;
114}
115
116static const EHPersonality &getCPersonality(const llvm::Triple &T,
117 const LangOptions &L) {
John McCall2faab302010-11-07 02:35:25 +0000118 if (L.SjLjExceptions)
119 return EHPersonality::GNU_C_SJLJ;
Reid Klecknere070b992014-11-14 02:01:10 +0000120 else if (useLibGCCSEHPersonality(T))
Reid Kleckner8f45c9c2014-09-15 17:19:16 +0000121 return EHPersonality::GNU_C_SEH;
John McCall36ea3722010-07-17 00:43:08 +0000122 return EHPersonality::GNU_C;
123}
124
Reid Klecknere070b992014-11-14 02:01:10 +0000125static const EHPersonality &getObjCPersonality(const llvm::Triple &T,
126 const LangOptions &L) {
John McCall5fb5df92012-06-20 06:18:46 +0000127 switch (L.ObjCRuntime.getKind()) {
128 case ObjCRuntime::FragileMacOSX:
Reid Klecknere070b992014-11-14 02:01:10 +0000129 return getCPersonality(T, L);
John McCall5fb5df92012-06-20 06:18:46 +0000130 case ObjCRuntime::MacOSX:
131 case ObjCRuntime::iOS:
Tim Northover756447a2015-10-30 16:30:36 +0000132 case ObjCRuntime::WatchOS:
John McCall5fb5df92012-06-20 06:18:46 +0000133 return EHPersonality::NeXT_ObjC;
David Chisnallb601c962012-07-03 20:49:52 +0000134 case ObjCRuntime::GNUstep:
David Chisnall2ec1b10d2013-01-11 15:33:01 +0000135 if (L.ObjCRuntime.getVersion() >= VersionTuple(1, 7))
136 return EHPersonality::GNUstep_ObjC;
137 // fallthrough
David Chisnallb601c962012-07-03 20:49:52 +0000138 case ObjCRuntime::GCC:
John McCall775086e2012-07-12 02:07:58 +0000139 case ObjCRuntime::ObjFW:
John McCall36ea3722010-07-17 00:43:08 +0000140 return EHPersonality::GNU_ObjC;
John McCallbd309292010-07-06 01:34:17 +0000141 }
John McCall5fb5df92012-06-20 06:18:46 +0000142 llvm_unreachable("bad runtime kind");
John McCallbd309292010-07-06 01:34:17 +0000143}
144
Reid Klecknere070b992014-11-14 02:01:10 +0000145static const EHPersonality &getCXXPersonality(const llvm::Triple &T,
146 const LangOptions &L) {
John McCall36ea3722010-07-17 00:43:08 +0000147 if (L.SjLjExceptions)
148 return EHPersonality::GNU_CPlusPlus_SJLJ;
Reid Klecknere070b992014-11-14 02:01:10 +0000149 else if (useLibGCCSEHPersonality(T))
Reid Kleckner8f45c9c2014-09-15 17:19:16 +0000150 return EHPersonality::GNU_CPlusPlus_SEH;
Reid Klecknere070b992014-11-14 02:01:10 +0000151 return EHPersonality::GNU_CPlusPlus;
John McCallbd309292010-07-06 01:34:17 +0000152}
153
154/// Determines the personality function to use when both C++
155/// and Objective-C exceptions are being caught.
Reid Klecknere070b992014-11-14 02:01:10 +0000156static const EHPersonality &getObjCXXPersonality(const llvm::Triple &T,
157 const LangOptions &L) {
John McCall5fb5df92012-06-20 06:18:46 +0000158 switch (L.ObjCRuntime.getKind()) {
John McCallbd309292010-07-06 01:34:17 +0000159 // The ObjC personality defers to the C++ personality for non-ObjC
160 // handlers. Unlike the C++ case, we use the same personality
161 // function on targets using (backend-driven) SJLJ EH.
John McCall5fb5df92012-06-20 06:18:46 +0000162 case ObjCRuntime::MacOSX:
163 case ObjCRuntime::iOS:
Tim Northover756447a2015-10-30 16:30:36 +0000164 case ObjCRuntime::WatchOS:
John McCall5fb5df92012-06-20 06:18:46 +0000165 return EHPersonality::NeXT_ObjC;
John McCallbd309292010-07-06 01:34:17 +0000166
John McCall5fb5df92012-06-20 06:18:46 +0000167 // In the fragile ABI, just use C++ exception handling and hope
168 // they're not doing crazy exception mixing.
169 case ObjCRuntime::FragileMacOSX:
Reid Klecknere070b992014-11-14 02:01:10 +0000170 return getCXXPersonality(T, L);
David Chisnallf9c42252010-05-17 13:49:20 +0000171
David Chisnallb601c962012-07-03 20:49:52 +0000172 // The GCC runtime's personality function inherently doesn't support
John McCall36ea3722010-07-17 00:43:08 +0000173 // mixed EH. Use the C++ personality just to avoid returning null.
David Chisnallb601c962012-07-03 20:49:52 +0000174 case ObjCRuntime::GCC:
John McCall775086e2012-07-12 02:07:58 +0000175 case ObjCRuntime::ObjFW: // XXX: this will change soon
David Chisnallb601c962012-07-03 20:49:52 +0000176 return EHPersonality::GNU_ObjC;
177 case ObjCRuntime::GNUstep:
John McCall5fb5df92012-06-20 06:18:46 +0000178 return EHPersonality::GNU_ObjCXX;
179 }
180 llvm_unreachable("bad runtime kind");
John McCallbd309292010-07-06 01:34:17 +0000181}
182
Reid Klecknerdeeddec2015-02-05 18:56:03 +0000183static const EHPersonality &getSEHPersonalityMSVC(const llvm::Triple &T) {
Reid Kleckner1d59f992015-01-22 01:36:17 +0000184 if (T.getArch() == llvm::Triple::x86)
185 return EHPersonality::MSVC_except_handler;
186 return EHPersonality::MSVC_C_specific_handler;
187}
188
Reid Klecknerdeeddec2015-02-05 18:56:03 +0000189const EHPersonality &EHPersonality::get(CodeGenModule &CGM,
190 const FunctionDecl *FD) {
Reid Klecknere070b992014-11-14 02:01:10 +0000191 const llvm::Triple &T = CGM.getTarget().getTriple();
192 const LangOptions &L = CGM.getLangOpts();
Reid Klecknerdeeddec2015-02-05 18:56:03 +0000193
Reid Kleckner01485652015-09-17 17:04:13 +0000194 // Functions using SEH get an SEH personality.
195 if (FD && FD->usesSEHTry())
196 return getSEHPersonalityMSVC(T);
197
Reid Kleckner1d59f992015-01-22 01:36:17 +0000198 // Try to pick a personality function that is compatible with MSVC if we're
199 // not compiling Obj-C. Obj-C users better have an Obj-C runtime that supports
200 // the GCC-style personality function.
201 if (T.isWindowsMSVCEnvironment() && !L.ObjC1) {
Reid Klecknerdeeddec2015-02-05 18:56:03 +0000202 if (L.SjLjExceptions)
203 return EHPersonality::GNU_CPlusPlus_SJLJ;
Reid Kleckner1d59f992015-01-22 01:36:17 +0000204 else
Reid Klecknerdeeddec2015-02-05 18:56:03 +0000205 return EHPersonality::MSVC_CxxFrameHandler3;
Reid Kleckner1d59f992015-01-22 01:36:17 +0000206 }
207
John McCall36ea3722010-07-17 00:43:08 +0000208 if (L.CPlusPlus && L.ObjC1)
Reid Klecknere070b992014-11-14 02:01:10 +0000209 return getObjCXXPersonality(T, L);
John McCall36ea3722010-07-17 00:43:08 +0000210 else if (L.CPlusPlus)
Reid Klecknere070b992014-11-14 02:01:10 +0000211 return getCXXPersonality(T, L);
John McCall36ea3722010-07-17 00:43:08 +0000212 else if (L.ObjC1)
Reid Klecknere070b992014-11-14 02:01:10 +0000213 return getObjCPersonality(T, L);
John McCallbd309292010-07-06 01:34:17 +0000214 else
Reid Klecknere070b992014-11-14 02:01:10 +0000215 return getCPersonality(T, L);
John McCall36ea3722010-07-17 00:43:08 +0000216}
John McCallbd309292010-07-06 01:34:17 +0000217
David Majnemerc28d46e2015-07-22 23:46:21 +0000218const EHPersonality &EHPersonality::get(CodeGenFunction &CGF) {
219 return get(CGF.CGM, dyn_cast_or_null<FunctionDecl>(CGF.CurCodeDecl));
220}
221
John McCall0bdb1fd2010-09-16 06:16:50 +0000222static llvm::Constant *getPersonalityFn(CodeGenModule &CGM,
John McCall36ea3722010-07-17 00:43:08 +0000223 const EHPersonality &Personality) {
John McCall36ea3722010-07-17 00:43:08 +0000224 llvm::Constant *Fn =
Chris Lattnerece04092012-02-07 00:39:47 +0000225 CGM.CreateRuntimeFunction(llvm::FunctionType::get(CGM.Int32Ty, true),
Benjamin Kramer793bd552012-02-08 12:41:24 +0000226 Personality.PersonalityFn);
John McCall0bdb1fd2010-09-16 06:16:50 +0000227 return Fn;
228}
229
230static llvm::Constant *getOpaquePersonalityFn(CodeGenModule &CGM,
231 const EHPersonality &Personality) {
232 llvm::Constant *Fn = getPersonalityFn(CGM, Personality);
John McCallad7c5c12011-02-08 08:22:06 +0000233 return llvm::ConstantExpr::getBitCast(Fn, CGM.Int8PtrTy);
John McCall0bdb1fd2010-09-16 06:16:50 +0000234}
235
Vedant Kumardb609472015-09-11 15:40:05 +0000236/// Check whether a landingpad instruction only uses C++ features.
237static bool LandingPadHasOnlyCXXUses(llvm::LandingPadInst *LPI) {
238 for (unsigned I = 0, E = LPI->getNumClauses(); I != E; ++I) {
239 // Look for something that would've been returned by the ObjC
240 // runtime's GetEHType() method.
241 llvm::Value *Val = LPI->getClause(I)->stripPointerCasts();
242 if (LPI->isCatch(I)) {
243 // Check if the catch value has the ObjC prefix.
244 if (llvm::GlobalVariable *GV = dyn_cast<llvm::GlobalVariable>(Val))
245 // ObjC EH selector entries are always global variables with
246 // names starting like this.
247 if (GV->getName().startswith("OBJC_EHTYPE"))
248 return false;
249 } else {
250 // Check if any of the filter values have the ObjC prefix.
251 llvm::Constant *CVal = cast<llvm::Constant>(Val);
252 for (llvm::User::op_iterator
253 II = CVal->op_begin(), IE = CVal->op_end(); II != IE; ++II) {
254 if (llvm::GlobalVariable *GV =
255 cast<llvm::GlobalVariable>((*II)->stripPointerCasts()))
256 // ObjC EH selector entries are always global variables with
257 // names starting like this.
258 if (GV->getName().startswith("OBJC_EHTYPE"))
259 return false;
260 }
261 }
262 }
263 return true;
264}
265
John McCall0bdb1fd2010-09-16 06:16:50 +0000266/// Check whether a personality function could reasonably be swapped
267/// for a C++ personality function.
268static bool PersonalityHasOnlyCXXUses(llvm::Constant *Fn) {
Chandler Carruth4d01fff2014-03-09 03:16:50 +0000269 for (llvm::User *U : Fn->users()) {
John McCall0bdb1fd2010-09-16 06:16:50 +0000270 // Conditionally white-list bitcasts.
Chandler Carruth4d01fff2014-03-09 03:16:50 +0000271 if (llvm::ConstantExpr *CE = dyn_cast<llvm::ConstantExpr>(U)) {
John McCall0bdb1fd2010-09-16 06:16:50 +0000272 if (CE->getOpcode() != llvm::Instruction::BitCast) return false;
273 if (!PersonalityHasOnlyCXXUses(CE))
274 return false;
275 continue;
276 }
277
Vedant Kumardb609472015-09-11 15:40:05 +0000278 // Otherwise it must be a function.
279 llvm::Function *F = dyn_cast<llvm::Function>(U);
280 if (!F) return false;
John McCall0bdb1fd2010-09-16 06:16:50 +0000281
Vedant Kumardb609472015-09-11 15:40:05 +0000282 for (auto BB = F->begin(), E = F->end(); BB != E; ++BB) {
283 if (BB->isLandingPad())
284 if (!LandingPadHasOnlyCXXUses(BB->getLandingPadInst()))
285 return false;
John McCall0bdb1fd2010-09-16 06:16:50 +0000286 }
287 }
288
289 return true;
290}
291
292/// Try to use the C++ personality function in ObjC++. Not doing this
293/// can cause some incompatibilities with gcc, which is more
294/// aggressive about only using the ObjC++ personality in a function
295/// when it really needs it.
296void CodeGenModule::SimplifyPersonality() {
John McCall0bdb1fd2010-09-16 06:16:50 +0000297 // If we're not in ObjC++ -fexceptions, there's nothing to do.
David Blaikiebbafb8a2012-03-11 07:00:24 +0000298 if (!LangOpts.CPlusPlus || !LangOpts.ObjC1 || !LangOpts.Exceptions)
John McCall0bdb1fd2010-09-16 06:16:50 +0000299 return;
300
John McCall3c223932012-11-14 17:48:31 +0000301 // Both the problem this endeavors to fix and the way the logic
302 // above works is specific to the NeXT runtime.
303 if (!LangOpts.ObjCRuntime.isNeXTFamily())
304 return;
305
Reid Klecknerdeeddec2015-02-05 18:56:03 +0000306 const EHPersonality &ObjCXX = EHPersonality::get(*this, /*FD=*/nullptr);
Reid Klecknere070b992014-11-14 02:01:10 +0000307 const EHPersonality &CXX =
308 getCXXPersonality(getTarget().getTriple(), LangOpts);
Benjamin Kramer793bd552012-02-08 12:41:24 +0000309 if (&ObjCXX == &CXX)
John McCall0bdb1fd2010-09-16 06:16:50 +0000310 return;
311
Benjamin Kramer793bd552012-02-08 12:41:24 +0000312 assert(std::strcmp(ObjCXX.PersonalityFn, CXX.PersonalityFn) != 0 &&
313 "Different EHPersonalities using the same personality function.");
314
315 llvm::Function *Fn = getModule().getFunction(ObjCXX.PersonalityFn);
John McCall0bdb1fd2010-09-16 06:16:50 +0000316
317 // Nothing to do if it's unused.
318 if (!Fn || Fn->use_empty()) return;
319
320 // Can't do the optimization if it has non-C++ uses.
321 if (!PersonalityHasOnlyCXXUses(Fn)) return;
322
323 // Create the C++ personality function and kill off the old
324 // function.
325 llvm::Constant *CXXFn = getPersonalityFn(*this, CXX);
326
327 // This can happen if the user is screwing with us.
328 if (Fn->getType() != CXXFn->getType()) return;
329
330 Fn->replaceAllUsesWith(CXXFn);
331 Fn->eraseFromParent();
John McCallbd309292010-07-06 01:34:17 +0000332}
333
334/// Returns the value to inject into a selector to indicate the
335/// presence of a catch-all.
336static llvm::Constant *getCatchAllValue(CodeGenFunction &CGF) {
337 // Possibly we should use @llvm.eh.catch.all.value here.
John McCallad7c5c12011-02-08 08:22:06 +0000338 return llvm::ConstantPointerNull::get(CGF.Int8PtrTy);
John McCallbd309292010-07-06 01:34:17 +0000339}
340
John McCallbb026012010-07-13 21:17:51 +0000341namespace {
342 /// A cleanup to free the exception object if its initialization
343 /// throws.
David Blaikie7e70d682015-08-18 22:40:54 +0000344 struct FreeException final : EHScopeStack::Cleanup {
John McCall5fcf8da2011-07-12 00:15:30 +0000345 llvm::Value *exn;
346 FreeException(llvm::Value *exn) : exn(exn) {}
Craig Topper4f12f102014-03-12 06:41:41 +0000347 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall882987f2013-02-28 19:01:20 +0000348 CGF.EmitNounwindRuntimeCall(getFreeExceptionFn(CGF.CGM), exn);
John McCallbb026012010-07-13 21:17:51 +0000349 }
350 };
Hans Wennborgdcfba332015-10-06 23:40:43 +0000351} // end anonymous namespace
John McCallbb026012010-07-13 21:17:51 +0000352
John McCall2e6567a2010-04-22 01:10:34 +0000353// Emits an exception expression into the given location. This
354// differs from EmitAnyExprToMem only in that, if a final copy-ctor
355// call is required, an exception within that copy ctor causes
356// std::terminate to be invoked.
John McCall7f416cc2015-09-08 08:05:57 +0000357void CodeGenFunction::EmitAnyExprToExn(const Expr *e, Address addr) {
John McCallbd309292010-07-06 01:34:17 +0000358 // Make sure the exception object is cleaned up if there's an
359 // exception during initialization.
John McCall7f416cc2015-09-08 08:05:57 +0000360 pushFullExprCleanup<FreeException>(EHCleanup, addr.getPointer());
David Majnemer7c237072015-03-05 00:46:22 +0000361 EHScopeStack::stable_iterator cleanup = EHStack.stable_begin();
John McCall2e6567a2010-04-22 01:10:34 +0000362
363 // __cxa_allocate_exception returns a void*; we need to cast this
364 // to the appropriate type for the object.
David Majnemer7c237072015-03-05 00:46:22 +0000365 llvm::Type *ty = ConvertTypeForMem(e->getType())->getPointerTo();
John McCall7f416cc2015-09-08 08:05:57 +0000366 Address typedAddr = Builder.CreateBitCast(addr, ty);
John McCall2e6567a2010-04-22 01:10:34 +0000367
368 // FIXME: this isn't quite right! If there's a final unelided call
369 // to a copy constructor, then according to [except.terminate]p1 we
370 // must call std::terminate() if that constructor throws, because
371 // technically that copy occurs after the exception expression is
372 // evaluated but before the exception is caught. But the best way
373 // to handle that is to teach EmitAggExpr to do the final copy
374 // differently if it can't be elided.
David Majnemer7c237072015-03-05 00:46:22 +0000375 EmitAnyExprToMem(e, typedAddr, e->getType().getQualifiers(),
376 /*IsInit*/ true);
John McCall2e6567a2010-04-22 01:10:34 +0000377
John McCalle4df6c82011-01-28 08:37:24 +0000378 // Deactivate the cleanup block.
John McCall7f416cc2015-09-08 08:05:57 +0000379 DeactivateCleanupBlock(cleanup,
380 cast<llvm::Instruction>(typedAddr.getPointer()));
Mike Stump54066142009-12-01 03:41:18 +0000381}
382
John McCall7f416cc2015-09-08 08:05:57 +0000383Address CodeGenFunction::getExceptionSlot() {
John McCall9b382dd2011-05-28 21:13:02 +0000384 if (!ExceptionSlot)
385 ExceptionSlot = CreateTempAlloca(Int8PtrTy, "exn.slot");
John McCall7f416cc2015-09-08 08:05:57 +0000386 return Address(ExceptionSlot, getPointerAlign());
Mike Stump54066142009-12-01 03:41:18 +0000387}
388
John McCall7f416cc2015-09-08 08:05:57 +0000389Address CodeGenFunction::getEHSelectorSlot() {
John McCall9b382dd2011-05-28 21:13:02 +0000390 if (!EHSelectorSlot)
391 EHSelectorSlot = CreateTempAlloca(Int32Ty, "ehselector.slot");
John McCall7f416cc2015-09-08 08:05:57 +0000392 return Address(EHSelectorSlot, CharUnits::fromQuantity(4));
John McCall9b382dd2011-05-28 21:13:02 +0000393}
394
Bill Wendling79a70e42011-09-15 18:57:19 +0000395llvm::Value *CodeGenFunction::getExceptionFromSlot() {
396 return Builder.CreateLoad(getExceptionSlot(), "exn");
397}
398
399llvm::Value *CodeGenFunction::getSelectorFromSlot() {
400 return Builder.CreateLoad(getEHSelectorSlot(), "sel");
401}
402
Richard Smithea852322013-05-07 21:53:22 +0000403void CodeGenFunction::EmitCXXThrowExpr(const CXXThrowExpr *E,
404 bool KeepInsertionPoint) {
David Majnemer7c237072015-03-05 00:46:22 +0000405 if (const Expr *SubExpr = E->getSubExpr()) {
406 QualType ThrowType = SubExpr->getType();
407 if (ThrowType->isObjCObjectPointerType()) {
408 const Stmt *ThrowStmt = E->getSubExpr();
409 const ObjCAtThrowStmt S(E->getExprLoc(), const_cast<Stmt *>(ThrowStmt));
410 CGM.getObjCRuntime().EmitThrowStmt(*this, S, false);
411 } else {
412 CGM.getCXXABI().emitThrow(*this, E);
John McCall2e6567a2010-04-22 01:10:34 +0000413 }
David Majnemer7c237072015-03-05 00:46:22 +0000414 } else {
415 CGM.getCXXABI().emitRethrow(*this, /*isNoReturn=*/true);
John McCall2e6567a2010-04-22 01:10:34 +0000416 }
Mike Stump75546b82009-12-10 00:06:18 +0000417
John McCall20f6ab82011-01-12 03:41:02 +0000418 // throw is an expression, and the expression emitters expect us
419 // to leave ourselves at a valid insertion point.
Richard Smithea852322013-05-07 21:53:22 +0000420 if (KeepInsertionPoint)
421 EmitBlock(createBasicBlock("throw.cont"));
Anders Carlsson4b08db72009-10-30 01:42:31 +0000422}
Mike Stump58ef18b2009-11-20 23:44:51 +0000423
Mike Stump1d849212009-12-07 23:38:24 +0000424void CodeGenFunction::EmitStartEHSpec(const Decl *D) {
David Blaikiebbafb8a2012-03-11 07:00:24 +0000425 if (!CGM.getLangOpts().CXXExceptions)
Anders Carlsson9878f9f2010-02-06 23:59:05 +0000426 return;
427
Mike Stump1d849212009-12-07 23:38:24 +0000428 const FunctionDecl* FD = dyn_cast_or_null<FunctionDecl>(D);
Craig Topper8a13c412014-05-21 05:09:00 +0000429 if (!FD) {
Alexey Bataev9959db52014-05-06 10:08:46 +0000430 // Check if CapturedDecl is nothrow and create terminate scope for it.
431 if (const CapturedDecl* CD = dyn_cast_or_null<CapturedDecl>(D)) {
432 if (CD->isNothrow())
433 EHStack.pushTerminate();
434 }
Mike Stump1d849212009-12-07 23:38:24 +0000435 return;
Alexey Bataev9959db52014-05-06 10:08:46 +0000436 }
Mike Stump1d849212009-12-07 23:38:24 +0000437 const FunctionProtoType *Proto = FD->getType()->getAs<FunctionProtoType>();
Craig Topper8a13c412014-05-21 05:09:00 +0000438 if (!Proto)
Mike Stump1d849212009-12-07 23:38:24 +0000439 return;
440
Sebastian Redl0b94c9f2011-03-15 18:42:48 +0000441 ExceptionSpecificationType EST = Proto->getExceptionSpecType();
442 if (isNoexceptExceptionSpec(EST)) {
443 if (Proto->getNoexceptSpec(getContext()) == FunctionProtoType::NR_Nothrow) {
444 // noexcept functions are simple terminate scopes.
445 EHStack.pushTerminate();
446 }
447 } else if (EST == EST_Dynamic || EST == EST_DynamicNone) {
David Majnemer1f192e22015-04-01 04:45:52 +0000448 // TODO: Revisit exception specifications for the MS ABI. There is a way to
449 // encode these in an object file but MSVC doesn't do anything with it.
450 if (getTarget().getCXXABI().isMicrosoft())
451 return;
Sebastian Redl0b94c9f2011-03-15 18:42:48 +0000452 unsigned NumExceptions = Proto->getNumExceptions();
453 EHFilterScope *Filter = EHStack.pushFilter(NumExceptions);
Mike Stump1d849212009-12-07 23:38:24 +0000454
Sebastian Redl0b94c9f2011-03-15 18:42:48 +0000455 for (unsigned I = 0; I != NumExceptions; ++I) {
456 QualType Ty = Proto->getExceptionType(I);
457 QualType ExceptType = Ty.getNonReferenceType().getUnqualifiedType();
458 llvm::Value *EHType = CGM.GetAddrOfRTTIDescriptor(ExceptType,
459 /*ForEH=*/true);
460 Filter->setFilter(I, EHType);
461 }
Mike Stump1d849212009-12-07 23:38:24 +0000462 }
Mike Stump1d849212009-12-07 23:38:24 +0000463}
464
John McCall8e4c74b2011-08-11 02:22:43 +0000465/// Emit the dispatch block for a filter scope if necessary.
466static void emitFilterDispatchBlock(CodeGenFunction &CGF,
467 EHFilterScope &filterScope) {
468 llvm::BasicBlock *dispatchBlock = filterScope.getCachedEHDispatchBlock();
469 if (!dispatchBlock) return;
470 if (dispatchBlock->use_empty()) {
471 delete dispatchBlock;
472 return;
473 }
474
John McCall8e4c74b2011-08-11 02:22:43 +0000475 CGF.EmitBlockAfterUses(dispatchBlock);
476
477 // If this isn't a catch-all filter, we need to check whether we got
478 // here because the filter triggered.
479 if (filterScope.getNumFilters()) {
480 // Load the selector value.
Bill Wendling79a70e42011-09-15 18:57:19 +0000481 llvm::Value *selector = CGF.getSelectorFromSlot();
John McCall8e4c74b2011-08-11 02:22:43 +0000482 llvm::BasicBlock *unexpectedBB = CGF.createBasicBlock("ehspec.unexpected");
483
484 llvm::Value *zero = CGF.Builder.getInt32(0);
485 llvm::Value *failsFilter =
Nico Weber1bebad12015-02-11 22:33:32 +0000486 CGF.Builder.CreateICmpSLT(selector, zero, "ehspec.fails");
487 CGF.Builder.CreateCondBr(failsFilter, unexpectedBB,
488 CGF.getEHResumeBlock(false));
John McCall8e4c74b2011-08-11 02:22:43 +0000489
490 CGF.EmitBlock(unexpectedBB);
491 }
492
493 // Call __cxa_call_unexpected. This doesn't need to be an invoke
494 // because __cxa_call_unexpected magically filters exceptions
495 // according to the last landing pad the exception was thrown
496 // into. Seriously.
Bill Wendling79a70e42011-09-15 18:57:19 +0000497 llvm::Value *exn = CGF.getExceptionFromSlot();
John McCall882987f2013-02-28 19:01:20 +0000498 CGF.EmitRuntimeCall(getUnexpectedFn(CGF.CGM), exn)
John McCall8e4c74b2011-08-11 02:22:43 +0000499 ->setDoesNotReturn();
500 CGF.Builder.CreateUnreachable();
501}
502
Mike Stump1d849212009-12-07 23:38:24 +0000503void CodeGenFunction::EmitEndEHSpec(const Decl *D) {
David Blaikiebbafb8a2012-03-11 07:00:24 +0000504 if (!CGM.getLangOpts().CXXExceptions)
Anders Carlsson9878f9f2010-02-06 23:59:05 +0000505 return;
506
Mike Stump1d849212009-12-07 23:38:24 +0000507 const FunctionDecl* FD = dyn_cast_or_null<FunctionDecl>(D);
Craig Topper8a13c412014-05-21 05:09:00 +0000508 if (!FD) {
Alexey Bataev9959db52014-05-06 10:08:46 +0000509 // Check if CapturedDecl is nothrow and pop terminate scope for it.
510 if (const CapturedDecl* CD = dyn_cast_or_null<CapturedDecl>(D)) {
511 if (CD->isNothrow())
512 EHStack.popTerminate();
513 }
Mike Stump1d849212009-12-07 23:38:24 +0000514 return;
Alexey Bataev9959db52014-05-06 10:08:46 +0000515 }
Mike Stump1d849212009-12-07 23:38:24 +0000516 const FunctionProtoType *Proto = FD->getType()->getAs<FunctionProtoType>();
Craig Topper8a13c412014-05-21 05:09:00 +0000517 if (!Proto)
Mike Stump1d849212009-12-07 23:38:24 +0000518 return;
519
Sebastian Redl0b94c9f2011-03-15 18:42:48 +0000520 ExceptionSpecificationType EST = Proto->getExceptionSpecType();
521 if (isNoexceptExceptionSpec(EST)) {
522 if (Proto->getNoexceptSpec(getContext()) == FunctionProtoType::NR_Nothrow) {
523 EHStack.popTerminate();
524 }
525 } else if (EST == EST_Dynamic || EST == EST_DynamicNone) {
David Majnemer1f192e22015-04-01 04:45:52 +0000526 // TODO: Revisit exception specifications for the MS ABI. There is a way to
527 // encode these in an object file but MSVC doesn't do anything with it.
528 if (getTarget().getCXXABI().isMicrosoft())
529 return;
John McCall8e4c74b2011-08-11 02:22:43 +0000530 EHFilterScope &filterScope = cast<EHFilterScope>(*EHStack.begin());
531 emitFilterDispatchBlock(*this, filterScope);
Sebastian Redl0b94c9f2011-03-15 18:42:48 +0000532 EHStack.popFilter();
533 }
Mike Stump1d849212009-12-07 23:38:24 +0000534}
535
Mike Stump58ef18b2009-11-20 23:44:51 +0000536void CodeGenFunction::EmitCXXTryStmt(const CXXTryStmt &S) {
John McCallb609d3f2010-07-07 06:56:46 +0000537 EnterCXXTryStmt(S);
John McCallb81884d2010-02-19 09:25:03 +0000538 EmitStmt(S.getTryBlock());
John McCallb609d3f2010-07-07 06:56:46 +0000539 ExitCXXTryStmt(S);
John McCallb81884d2010-02-19 09:25:03 +0000540}
541
John McCallb609d3f2010-07-07 06:56:46 +0000542void CodeGenFunction::EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock) {
John McCallbd309292010-07-06 01:34:17 +0000543 unsigned NumHandlers = S.getNumHandlers();
544 EHCatchScope *CatchScope = EHStack.pushCatch(NumHandlers);
John McCallb81884d2010-02-19 09:25:03 +0000545
John McCallbd309292010-07-06 01:34:17 +0000546 for (unsigned I = 0; I != NumHandlers; ++I) {
547 const CXXCatchStmt *C = S.getHandler(I);
John McCallb81884d2010-02-19 09:25:03 +0000548
John McCallbd309292010-07-06 01:34:17 +0000549 llvm::BasicBlock *Handler = createBasicBlock("catch");
550 if (C->getExceptionDecl()) {
551 // FIXME: Dropping the reference type on the type into makes it
552 // impossible to correctly implement catch-by-reference
553 // semantics for pointers. Unfortunately, this is what all
554 // existing compilers do, and it's not clear that the standard
555 // personality routine is capable of doing this right. See C++ DR 388:
556 // http://www.open-std.org/jtc1/sc22/wg21/docs/cwg_active.html#388
David Majnemer571162a2014-10-12 06:58:22 +0000557 Qualifiers CaughtTypeQuals;
558 QualType CaughtType = CGM.getContext().getUnqualifiedArrayType(
559 C->getCaughtType().getNonReferenceType(), CaughtTypeQuals);
John McCall2ca705e2010-07-24 00:37:23 +0000560
Reid Kleckner10aa7702015-09-16 20:15:55 +0000561 CatchTypeInfo TypeInfo{nullptr, 0};
John McCall2ca705e2010-07-24 00:37:23 +0000562 if (CaughtType->isObjCObjectPointerType())
Reid Kleckner10aa7702015-09-16 20:15:55 +0000563 TypeInfo.RTTI = CGM.getObjCRuntime().GetEHType(CaughtType);
John McCall2ca705e2010-07-24 00:37:23 +0000564 else
Reid Kleckner10aa7702015-09-16 20:15:55 +0000565 TypeInfo = CGM.getCXXABI().getAddrOfCXXCatchHandlerType(
566 CaughtType, C->getCaughtType());
John McCallbd309292010-07-06 01:34:17 +0000567 CatchScope->setHandler(I, TypeInfo, Handler);
568 } else {
569 // No exception decl indicates '...', a catch-all.
Reid Kleckner10aa7702015-09-16 20:15:55 +0000570 CatchScope->setHandler(I, CGM.getCXXABI().getCatchAllTypeInfo(), Handler);
John McCallbd309292010-07-06 01:34:17 +0000571 }
572 }
John McCallbd309292010-07-06 01:34:17 +0000573}
574
John McCall8e4c74b2011-08-11 02:22:43 +0000575llvm::BasicBlock *
576CodeGenFunction::getEHDispatchBlock(EHScopeStack::stable_iterator si) {
Reid Kleckner129552b2015-10-08 01:13:52 +0000577 if (EHPersonality::get(*this).usesFuncletPads())
David Majnemerdbf10452015-07-31 17:58:45 +0000578 return getMSVCDispatchBlock(si);
579
John McCall8e4c74b2011-08-11 02:22:43 +0000580 // The dispatch block for the end of the scope chain is a block that
581 // just resumes unwinding.
582 if (si == EHStack.stable_end())
David Chisnall9a837be2012-11-07 16:50:40 +0000583 return getEHResumeBlock(true);
John McCall8e4c74b2011-08-11 02:22:43 +0000584
585 // Otherwise, we should look at the actual scope.
586 EHScope &scope = *EHStack.find(si);
587
588 llvm::BasicBlock *dispatchBlock = scope.getCachedEHDispatchBlock();
589 if (!dispatchBlock) {
590 switch (scope.getKind()) {
591 case EHScope::Catch: {
592 // Apply a special case to a single catch-all.
593 EHCatchScope &catchScope = cast<EHCatchScope>(scope);
594 if (catchScope.getNumHandlers() == 1 &&
595 catchScope.getHandler(0).isCatchAll()) {
596 dispatchBlock = catchScope.getHandler(0).Block;
597
598 // Otherwise, make a dispatch block.
599 } else {
600 dispatchBlock = createBasicBlock("catch.dispatch");
601 }
602 break;
603 }
604
605 case EHScope::Cleanup:
606 dispatchBlock = createBasicBlock("ehcleanup");
607 break;
608
609 case EHScope::Filter:
610 dispatchBlock = createBasicBlock("filter.dispatch");
611 break;
612
613 case EHScope::Terminate:
614 dispatchBlock = getTerminateHandler();
615 break;
David Majnemerdbf10452015-07-31 17:58:45 +0000616
Reid Kleckner2586aac2015-09-10 22:11:13 +0000617 case EHScope::PadEnd:
618 llvm_unreachable("PadEnd unnecessary for Itanium!");
John McCall8e4c74b2011-08-11 02:22:43 +0000619 }
620 scope.setCachedEHDispatchBlock(dispatchBlock);
621 }
622 return dispatchBlock;
623}
624
David Majnemerdbf10452015-07-31 17:58:45 +0000625llvm::BasicBlock *
626CodeGenFunction::getMSVCDispatchBlock(EHScopeStack::stable_iterator SI) {
627 // Returning nullptr indicates that the previous dispatch block should unwind
628 // to caller.
629 if (SI == EHStack.stable_end())
630 return nullptr;
631
632 // Otherwise, we should look at the actual scope.
633 EHScope &EHS = *EHStack.find(SI);
634
635 llvm::BasicBlock *DispatchBlock = EHS.getCachedEHDispatchBlock();
636 if (DispatchBlock)
637 return DispatchBlock;
638
639 if (EHS.getKind() == EHScope::Terminate)
640 DispatchBlock = getTerminateHandler();
641 else
642 DispatchBlock = createBasicBlock();
John McCall7f416cc2015-09-08 08:05:57 +0000643 CGBuilderTy Builder(*this, DispatchBlock);
David Majnemerdbf10452015-07-31 17:58:45 +0000644
645 switch (EHS.getKind()) {
646 case EHScope::Catch:
647 DispatchBlock->setName("catch.dispatch");
648 break;
649
650 case EHScope::Cleanup:
651 DispatchBlock->setName("ehcleanup");
652 break;
653
654 case EHScope::Filter:
655 llvm_unreachable("exception specifications not handled yet!");
656
657 case EHScope::Terminate:
658 DispatchBlock->setName("terminate");
659 break;
660
Reid Kleckner2586aac2015-09-10 22:11:13 +0000661 case EHScope::PadEnd:
662 llvm_unreachable("PadEnd dispatch block missing!");
David Majnemerdbf10452015-07-31 17:58:45 +0000663 }
664 EHS.setCachedEHDispatchBlock(DispatchBlock);
665 return DispatchBlock;
666}
667
John McCallbd309292010-07-06 01:34:17 +0000668/// Check whether this is a non-EH scope, i.e. a scope which doesn't
669/// affect exception handling. Currently, the only non-EH scopes are
670/// normal-only cleanup scopes.
671static bool isNonEHScope(const EHScope &S) {
John McCall2b7fc382010-07-13 20:32:21 +0000672 switch (S.getKind()) {
John McCallcda666c2010-07-21 07:22:38 +0000673 case EHScope::Cleanup:
674 return !cast<EHCleanupScope>(S).isEHCleanup();
John McCall2b7fc382010-07-13 20:32:21 +0000675 case EHScope::Filter:
676 case EHScope::Catch:
677 case EHScope::Terminate:
Reid Kleckner2586aac2015-09-10 22:11:13 +0000678 case EHScope::PadEnd:
John McCall2b7fc382010-07-13 20:32:21 +0000679 return false;
680 }
681
David Blaikiee4d798f2012-01-20 21:50:17 +0000682 llvm_unreachable("Invalid EHScope Kind!");
John McCallbd309292010-07-06 01:34:17 +0000683}
684
685llvm::BasicBlock *CodeGenFunction::getInvokeDestImpl() {
686 assert(EHStack.requiresLandingPad());
687 assert(!EHStack.empty());
688
Reid Klecknerdeeddec2015-02-05 18:56:03 +0000689 // If exceptions are disabled, there are usually no landingpads. However, when
690 // SEH is enabled, functions using SEH still get landingpads.
691 const LangOptions &LO = CGM.getLangOpts();
692 if (!LO.Exceptions) {
693 if (!LO.Borland && !LO.MicrosoftExt)
694 return nullptr;
Reid Klecknere7b3f7c2015-02-11 00:00:21 +0000695 if (!currentFunctionUsesSEHTry())
Reid Klecknerdeeddec2015-02-05 18:56:03 +0000696 return nullptr;
697 }
John McCall2b7fc382010-07-13 20:32:21 +0000698
John McCallbd309292010-07-06 01:34:17 +0000699 // Check the innermost scope for a cached landing pad. If this is
700 // a non-EH cleanup, we'll check enclosing scopes in EmitLandingPad.
701 llvm::BasicBlock *LP = EHStack.begin()->getCachedLandingPad();
702 if (LP) return LP;
703
David Majnemerdbf10452015-07-31 17:58:45 +0000704 const EHPersonality &Personality = EHPersonality::get(*this);
705
706 if (!CurFn->hasPersonalityFn())
707 CurFn->setPersonalityFn(getOpaquePersonalityFn(CGM, Personality));
708
Reid Kleckner129552b2015-10-08 01:13:52 +0000709 if (Personality.usesFuncletPads()) {
710 // We don't need separate landing pads in the funclet model.
David Majnemerdbf10452015-07-31 17:58:45 +0000711 LP = getEHDispatchBlock(EHStack.getInnermostEHScope());
712 } else {
713 // Build the landing pad for this scope.
714 LP = EmitLandingPad();
715 }
716
John McCallbd309292010-07-06 01:34:17 +0000717 assert(LP);
718
719 // Cache the landing pad on the innermost scope. If this is a
720 // non-EH scope, cache the landing pad on the enclosing scope, too.
721 for (EHScopeStack::iterator ir = EHStack.begin(); true; ++ir) {
722 ir->setCachedLandingPad(LP);
723 if (!isNonEHScope(*ir)) break;
724 }
725
726 return LP;
727}
728
729llvm::BasicBlock *CodeGenFunction::EmitLandingPad() {
730 assert(EHStack.requiresLandingPad());
731
John McCall8e4c74b2011-08-11 02:22:43 +0000732 EHScope &innermostEHScope = *EHStack.find(EHStack.getInnermostEHScope());
733 switch (innermostEHScope.getKind()) {
734 case EHScope::Terminate:
735 return getTerminateLandingPad();
John McCallbd309292010-07-06 01:34:17 +0000736
Reid Kleckner2586aac2015-09-10 22:11:13 +0000737 case EHScope::PadEnd:
738 llvm_unreachable("PadEnd unnecessary for Itanium!");
David Majnemerdbf10452015-07-31 17:58:45 +0000739
John McCall8e4c74b2011-08-11 02:22:43 +0000740 case EHScope::Catch:
741 case EHScope::Cleanup:
742 case EHScope::Filter:
743 if (llvm::BasicBlock *lpad = innermostEHScope.getCachedLandingPad())
744 return lpad;
John McCallbd309292010-07-06 01:34:17 +0000745 }
746
747 // Save the current IR generation state.
John McCall8e4c74b2011-08-11 02:22:43 +0000748 CGBuilderTy::InsertPoint savedIP = Builder.saveAndClearIP();
Adrian Prantl95b24e92015-02-03 20:00:54 +0000749 auto DL = ApplyDebugLocation::CreateDefaultArtificial(*this, CurEHLocation);
John McCallbd309292010-07-06 01:34:17 +0000750
751 // Create and configure the landing pad.
John McCall8e4c74b2011-08-11 02:22:43 +0000752 llvm::BasicBlock *lpad = createBasicBlock("lpad");
753 EmitBlock(lpad);
John McCallbd309292010-07-06 01:34:17 +0000754
David Majnemerfcbdb6e2015-06-17 20:53:19 +0000755 llvm::LandingPadInst *LPadInst = Builder.CreateLandingPad(
756 llvm::StructType::get(Int8PtrTy, Int32Ty, nullptr), 0);
Bill Wendlingf0724e82011-09-19 20:31:14 +0000757
758 llvm::Value *LPadExn = Builder.CreateExtractValue(LPadInst, 0);
759 Builder.CreateStore(LPadExn, getExceptionSlot());
760 llvm::Value *LPadSel = Builder.CreateExtractValue(LPadInst, 1);
761 Builder.CreateStore(LPadSel, getEHSelectorSlot());
762
John McCallbd309292010-07-06 01:34:17 +0000763 // Save the exception pointer. It's safe to use a single exception
764 // pointer per function because EH cleanups can never have nested
765 // try/catches.
Bill Wendlingf0724e82011-09-19 20:31:14 +0000766 // Build the landingpad instruction.
John McCallbd309292010-07-06 01:34:17 +0000767
768 // Accumulate all the handlers in scope.
John McCall8e4c74b2011-08-11 02:22:43 +0000769 bool hasCatchAll = false;
770 bool hasCleanup = false;
771 bool hasFilter = false;
772 SmallVector<llvm::Value*, 4> filterTypes;
773 llvm::SmallPtrSet<llvm::Value*, 4> catchTypes;
Nico Webere68b9f32015-02-25 16:25:00 +0000774 for (EHScopeStack::iterator I = EHStack.begin(), E = EHStack.end(); I != E;
775 ++I) {
John McCallbd309292010-07-06 01:34:17 +0000776
777 switch (I->getKind()) {
John McCallcda666c2010-07-21 07:22:38 +0000778 case EHScope::Cleanup:
John McCall8e4c74b2011-08-11 02:22:43 +0000779 // If we have a cleanup, remember that.
780 hasCleanup = (hasCleanup || cast<EHCleanupScope>(*I).isEHCleanup());
John McCall2b7fc382010-07-13 20:32:21 +0000781 continue;
782
John McCallbd309292010-07-06 01:34:17 +0000783 case EHScope::Filter: {
784 assert(I.next() == EHStack.end() && "EH filter is not end of EH stack");
John McCall8e4c74b2011-08-11 02:22:43 +0000785 assert(!hasCatchAll && "EH filter reached after catch-all");
John McCallbd309292010-07-06 01:34:17 +0000786
Bill Wendlingf0724e82011-09-19 20:31:14 +0000787 // Filter scopes get added to the landingpad in weird ways.
John McCall8e4c74b2011-08-11 02:22:43 +0000788 EHFilterScope &filter = cast<EHFilterScope>(*I);
789 hasFilter = true;
John McCallbd309292010-07-06 01:34:17 +0000790
Bill Wendling8c4b7162011-09-22 20:32:54 +0000791 // Add all the filter values.
792 for (unsigned i = 0, e = filter.getNumFilters(); i != e; ++i)
793 filterTypes.push_back(filter.getFilter(i));
John McCallbd309292010-07-06 01:34:17 +0000794 goto done;
795 }
796
797 case EHScope::Terminate:
798 // Terminate scopes are basically catch-alls.
John McCall8e4c74b2011-08-11 02:22:43 +0000799 assert(!hasCatchAll);
800 hasCatchAll = true;
John McCallbd309292010-07-06 01:34:17 +0000801 goto done;
802
803 case EHScope::Catch:
804 break;
David Majnemerdbf10452015-07-31 17:58:45 +0000805
Reid Kleckner2586aac2015-09-10 22:11:13 +0000806 case EHScope::PadEnd:
807 llvm_unreachable("PadEnd unnecessary for Itanium!");
John McCallbd309292010-07-06 01:34:17 +0000808 }
809
John McCall8e4c74b2011-08-11 02:22:43 +0000810 EHCatchScope &catchScope = cast<EHCatchScope>(*I);
811 for (unsigned hi = 0, he = catchScope.getNumHandlers(); hi != he; ++hi) {
812 EHCatchScope::Handler handler = catchScope.getHandler(hi);
Reid Kleckner10aa7702015-09-16 20:15:55 +0000813 assert(handler.Type.Flags == 0 &&
814 "landingpads do not support catch handler flags");
John McCallbd309292010-07-06 01:34:17 +0000815
John McCall8e4c74b2011-08-11 02:22:43 +0000816 // If this is a catch-all, register that and abort.
Reid Kleckner10aa7702015-09-16 20:15:55 +0000817 if (!handler.Type.RTTI) {
John McCall8e4c74b2011-08-11 02:22:43 +0000818 assert(!hasCatchAll);
819 hasCatchAll = true;
820 goto done;
John McCallbd309292010-07-06 01:34:17 +0000821 }
822
823 // Check whether we already have a handler for this type.
Reid Kleckner10aa7702015-09-16 20:15:55 +0000824 if (catchTypes.insert(handler.Type.RTTI).second)
Bill Wendlingf0724e82011-09-19 20:31:14 +0000825 // If not, add it directly to the landingpad.
Reid Kleckner10aa7702015-09-16 20:15:55 +0000826 LPadInst->addClause(handler.Type.RTTI);
John McCallbd309292010-07-06 01:34:17 +0000827 }
John McCallbd309292010-07-06 01:34:17 +0000828 }
829
830 done:
Bill Wendlingf0724e82011-09-19 20:31:14 +0000831 // If we have a catch-all, add null to the landingpad.
John McCall8e4c74b2011-08-11 02:22:43 +0000832 assert(!(hasCatchAll && hasFilter));
833 if (hasCatchAll) {
Bill Wendlingf0724e82011-09-19 20:31:14 +0000834 LPadInst->addClause(getCatchAllValue(*this));
John McCallbd309292010-07-06 01:34:17 +0000835
836 // If we have an EH filter, we need to add those handlers in the
Bill Wendlingf0724e82011-09-19 20:31:14 +0000837 // right place in the landingpad, which is to say, at the end.
John McCall8e4c74b2011-08-11 02:22:43 +0000838 } else if (hasFilter) {
Bill Wendling58e58fe2011-09-19 22:08:36 +0000839 // Create a filter expression: a constant array indicating which filter
840 // types there are. The personality routine only lands here if the filter
841 // doesn't match.
Dmitri Gribenkof8579502013-01-12 19:30:44 +0000842 SmallVector<llvm::Constant*, 8> Filters;
Bill Wendlingf0724e82011-09-19 20:31:14 +0000843 llvm::ArrayType *AType =
844 llvm::ArrayType::get(!filterTypes.empty() ?
845 filterTypes[0]->getType() : Int8PtrTy,
846 filterTypes.size());
847
848 for (unsigned i = 0, e = filterTypes.size(); i != e; ++i)
849 Filters.push_back(cast<llvm::Constant>(filterTypes[i]));
850 llvm::Constant *FilterArray = llvm::ConstantArray::get(AType, Filters);
851 LPadInst->addClause(FilterArray);
John McCallbd309292010-07-06 01:34:17 +0000852
853 // Also check whether we need a cleanup.
Bill Wendlingf0724e82011-09-19 20:31:14 +0000854 if (hasCleanup)
855 LPadInst->setCleanup(true);
John McCallbd309292010-07-06 01:34:17 +0000856
857 // Otherwise, signal that we at least have cleanups.
Logan Chiene9c8ccb2014-07-01 11:47:10 +0000858 } else if (hasCleanup) {
859 LPadInst->setCleanup(true);
John McCallbd309292010-07-06 01:34:17 +0000860 }
861
Bill Wendlingf0724e82011-09-19 20:31:14 +0000862 assert((LPadInst->getNumClauses() > 0 || LPadInst->isCleanup()) &&
863 "landingpad instruction has no clauses!");
John McCallbd309292010-07-06 01:34:17 +0000864
865 // Tell the backend how to generate the landing pad.
John McCall8e4c74b2011-08-11 02:22:43 +0000866 Builder.CreateBr(getEHDispatchBlock(EHStack.getInnermostEHScope()));
John McCallbd309292010-07-06 01:34:17 +0000867
868 // Restore the old IR generation state.
John McCall8e4c74b2011-08-11 02:22:43 +0000869 Builder.restoreIP(savedIP);
John McCallbd309292010-07-06 01:34:17 +0000870
John McCall8e4c74b2011-08-11 02:22:43 +0000871 return lpad;
John McCallbd309292010-07-06 01:34:17 +0000872}
873
Reid Kleckner129552b2015-10-08 01:13:52 +0000874static llvm::BasicBlock *emitCatchPadBlock(CodeGenFunction &CGF,
875 EHCatchScope &CatchScope) {
David Majnemerdbf10452015-07-31 17:58:45 +0000876 llvm::BasicBlock *DispatchBlock = CatchScope.getCachedEHDispatchBlock();
877 assert(DispatchBlock);
878
879 CGBuilderTy::InsertPoint SavedIP = CGF.Builder.saveIP();
880 CGF.EmitBlockAfterUses(DispatchBlock);
881
882 // Figure out the next block.
883 llvm::BasicBlock *NextBlock = nullptr;
884
885 // Test against each of the exception types we claim to catch.
886 for (unsigned I = 0, E = CatchScope.getNumHandlers(); I < E; ++I) {
887 const EHCatchScope::Handler &Handler = CatchScope.getHandler(I);
888
Reid Kleckner10aa7702015-09-16 20:15:55 +0000889 CatchTypeInfo TypeInfo = Handler.Type;
890 if (!TypeInfo.RTTI)
891 TypeInfo.RTTI = llvm::Constant::getNullValue(CGF.VoidPtrTy);
David Majnemerdbf10452015-07-31 17:58:45 +0000892
893 // If this is the last handler, we're at the end, and the next
894 // block is the block for the enclosing EH scope.
895 if (I + 1 == E) {
896 NextBlock = CGF.createBasicBlock("catchendblock");
John McCall7f416cc2015-09-08 08:05:57 +0000897 CGBuilderTy(CGF, NextBlock).CreateCatchEndPad(
David Majnemerdbf10452015-07-31 17:58:45 +0000898 CGF.getEHDispatchBlock(CatchScope.getEnclosingEHScope()));
899 } else {
900 NextBlock = CGF.createBasicBlock("catch.dispatch");
901 }
902
903 if (EHPersonality::get(CGF).isMSVCXXPersonality()) {
Reid Kleckner10aa7702015-09-16 20:15:55 +0000904 CGF.Builder.CreateCatchPad(Handler.Block, NextBlock,
905 {TypeInfo.RTTI,
906 CGF.Builder.getInt32(TypeInfo.Flags),
907 llvm::Constant::getNullValue(CGF.VoidPtrTy)});
David Majnemerdbf10452015-07-31 17:58:45 +0000908 } else {
Reid Kleckner10aa7702015-09-16 20:15:55 +0000909 CGF.Builder.CreateCatchPad(Handler.Block, NextBlock, {TypeInfo.RTTI});
David Majnemerdbf10452015-07-31 17:58:45 +0000910 }
911
912 // Otherwise we need to emit and continue at that block.
913 CGF.EmitBlock(NextBlock);
914 }
915 CGF.Builder.restoreIP(SavedIP);
916
917 return NextBlock;
918}
919
John McCall8e4c74b2011-08-11 02:22:43 +0000920/// Emit the structure of the dispatch block for the given catch scope.
921/// It is an invariant that the dispatch block already exists.
David Majnemerdbf10452015-07-31 17:58:45 +0000922/// If the catchblock instructions are used for EH dispatch, then the basic
923/// block holding the final catchendblock instruction is returned.
924static llvm::BasicBlock *emitCatchDispatchBlock(CodeGenFunction &CGF,
925 EHCatchScope &catchScope) {
Reid Kleckner129552b2015-10-08 01:13:52 +0000926 if (EHPersonality::get(CGF).usesFuncletPads())
927 return emitCatchPadBlock(CGF, catchScope);
David Majnemerdbf10452015-07-31 17:58:45 +0000928
John McCall8e4c74b2011-08-11 02:22:43 +0000929 llvm::BasicBlock *dispatchBlock = catchScope.getCachedEHDispatchBlock();
930 assert(dispatchBlock);
931
932 // If there's only a single catch-all, getEHDispatchBlock returned
933 // that catch-all as the dispatch block.
934 if (catchScope.getNumHandlers() == 1 &&
935 catchScope.getHandler(0).isCatchAll()) {
936 assert(dispatchBlock == catchScope.getHandler(0).Block);
David Majnemerdbf10452015-07-31 17:58:45 +0000937 return nullptr;
John McCall8e4c74b2011-08-11 02:22:43 +0000938 }
939
940 CGBuilderTy::InsertPoint savedIP = CGF.Builder.saveIP();
941 CGF.EmitBlockAfterUses(dispatchBlock);
942
943 // Select the right handler.
944 llvm::Value *llvm_eh_typeid_for =
945 CGF.CGM.getIntrinsic(llvm::Intrinsic::eh_typeid_for);
946
947 // Load the selector value.
Bill Wendling79a70e42011-09-15 18:57:19 +0000948 llvm::Value *selector = CGF.getSelectorFromSlot();
John McCall8e4c74b2011-08-11 02:22:43 +0000949
950 // Test against each of the exception types we claim to catch.
951 for (unsigned i = 0, e = catchScope.getNumHandlers(); ; ++i) {
952 assert(i < e && "ran off end of handlers!");
953 const EHCatchScope::Handler &handler = catchScope.getHandler(i);
954
Reid Kleckner10aa7702015-09-16 20:15:55 +0000955 llvm::Value *typeValue = handler.Type.RTTI;
956 assert(handler.Type.Flags == 0 &&
957 "landingpads do not support catch handler flags");
John McCall8e4c74b2011-08-11 02:22:43 +0000958 assert(typeValue && "fell into catch-all case!");
959 typeValue = CGF.Builder.CreateBitCast(typeValue, CGF.Int8PtrTy);
960
961 // Figure out the next block.
962 bool nextIsEnd;
963 llvm::BasicBlock *nextBlock;
964
965 // If this is the last handler, we're at the end, and the next
966 // block is the block for the enclosing EH scope.
967 if (i + 1 == e) {
968 nextBlock = CGF.getEHDispatchBlock(catchScope.getEnclosingEHScope());
969 nextIsEnd = true;
970
971 // If the next handler is a catch-all, we're at the end, and the
972 // next block is that handler.
973 } else if (catchScope.getHandler(i+1).isCatchAll()) {
974 nextBlock = catchScope.getHandler(i+1).Block;
975 nextIsEnd = true;
976
977 // Otherwise, we're not at the end and we need a new block.
978 } else {
979 nextBlock = CGF.createBasicBlock("catch.fallthrough");
980 nextIsEnd = false;
981 }
982
983 // Figure out the catch type's index in the LSDA's type table.
984 llvm::CallInst *typeIndex =
985 CGF.Builder.CreateCall(llvm_eh_typeid_for, typeValue);
986 typeIndex->setDoesNotThrow();
987
988 llvm::Value *matchesTypeIndex =
989 CGF.Builder.CreateICmpEQ(selector, typeIndex, "matches");
990 CGF.Builder.CreateCondBr(matchesTypeIndex, handler.Block, nextBlock);
991
992 // If the next handler is a catch-all, we're completely done.
993 if (nextIsEnd) {
994 CGF.Builder.restoreIP(savedIP);
David Majnemerdbf10452015-07-31 17:58:45 +0000995 return nullptr;
John McCall8e4c74b2011-08-11 02:22:43 +0000996 }
Ahmed Charles289896d2012-02-19 11:57:29 +0000997 // Otherwise we need to emit and continue at that block.
998 CGF.EmitBlock(nextBlock);
John McCall8e4c74b2011-08-11 02:22:43 +0000999 }
David Majnemerdbf10452015-07-31 17:58:45 +00001000 return nullptr;
John McCall8e4c74b2011-08-11 02:22:43 +00001001}
1002
1003void CodeGenFunction::popCatchScope() {
1004 EHCatchScope &catchScope = cast<EHCatchScope>(*EHStack.begin());
1005 if (catchScope.hasEHBranches())
1006 emitCatchDispatchBlock(*this, catchScope);
1007 EHStack.popCatch();
1008}
1009
John McCallb609d3f2010-07-07 06:56:46 +00001010void CodeGenFunction::ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock) {
John McCallbd309292010-07-06 01:34:17 +00001011 unsigned NumHandlers = S.getNumHandlers();
1012 EHCatchScope &CatchScope = cast<EHCatchScope>(*EHStack.begin());
1013 assert(CatchScope.getNumHandlers() == NumHandlers);
Mike Stump58ef18b2009-11-20 23:44:51 +00001014
John McCall8e4c74b2011-08-11 02:22:43 +00001015 // If the catch was not required, bail out now.
1016 if (!CatchScope.hasEHBranches()) {
Kostya Serebryanyba4aced2014-01-09 09:22:32 +00001017 CatchScope.clearHandlerBlocks();
John McCall8e4c74b2011-08-11 02:22:43 +00001018 EHStack.popCatch();
1019 return;
1020 }
1021
1022 // Emit the structure of the EH dispatch for this catch.
David Majnemerdbf10452015-07-31 17:58:45 +00001023 llvm::BasicBlock *CatchEndBlockBB = emitCatchDispatchBlock(*this, CatchScope);
John McCall8e4c74b2011-08-11 02:22:43 +00001024
John McCallbd309292010-07-06 01:34:17 +00001025 // Copy the handler blocks off before we pop the EH stack. Emitting
1026 // the handlers might scribble on this memory.
Benjamin Kramerda32cf82015-08-04 15:38:49 +00001027 SmallVector<EHCatchScope::Handler, 8> Handlers(
1028 CatchScope.begin(), CatchScope.begin() + NumHandlers);
John McCall8e4c74b2011-08-11 02:22:43 +00001029
John McCallbd309292010-07-06 01:34:17 +00001030 EHStack.popCatch();
Mike Stump58ef18b2009-11-20 23:44:51 +00001031
John McCallbd309292010-07-06 01:34:17 +00001032 // The fall-through block.
1033 llvm::BasicBlock *ContBB = createBasicBlock("try.cont");
Mike Stump58ef18b2009-11-20 23:44:51 +00001034
John McCallbd309292010-07-06 01:34:17 +00001035 // We just emitted the body of the try; jump to the continue block.
1036 if (HaveInsertPoint())
1037 Builder.CreateBr(ContBB);
Mike Stump97329152009-12-02 19:53:57 +00001038
John McCalld8d00be2012-06-15 05:27:05 +00001039 // Determine if we need an implicit rethrow for all these catch handlers;
1040 // see the comment below.
1041 bool doImplicitRethrow = false;
John McCallb609d3f2010-07-07 06:56:46 +00001042 if (IsFnTryBlock)
John McCalld8d00be2012-06-15 05:27:05 +00001043 doImplicitRethrow = isa<CXXDestructorDecl>(CurCodeDecl) ||
1044 isa<CXXConstructorDecl>(CurCodeDecl);
John McCallb609d3f2010-07-07 06:56:46 +00001045
David Majnemerdbf10452015-07-31 17:58:45 +00001046 if (CatchEndBlockBB)
Reid Kleckner2586aac2015-09-10 22:11:13 +00001047 EHStack.pushPadEnd(CatchEndBlockBB);
David Majnemerdbf10452015-07-31 17:58:45 +00001048
John McCall8e4c74b2011-08-11 02:22:43 +00001049 // Perversely, we emit the handlers backwards precisely because we
1050 // want them to appear in source order. In all of these cases, the
1051 // catch block will have exactly one predecessor, which will be a
1052 // particular block in the catch dispatch. However, in the case of
1053 // a catch-all, one of the dispatch blocks will branch to two
1054 // different handlers, and EmitBlockAfterUses will cause the second
1055 // handler to be moved before the first.
1056 for (unsigned I = NumHandlers; I != 0; --I) {
1057 llvm::BasicBlock *CatchBlock = Handlers[I-1].Block;
1058 EmitBlockAfterUses(CatchBlock);
Mike Stump75546b82009-12-10 00:06:18 +00001059
John McCallbd309292010-07-06 01:34:17 +00001060 // Catch the exception if this isn't a catch-all.
John McCall8e4c74b2011-08-11 02:22:43 +00001061 const CXXCatchStmt *C = S.getHandler(I-1);
Mike Stump58ef18b2009-11-20 23:44:51 +00001062
John McCallbd309292010-07-06 01:34:17 +00001063 // Enter a cleanup scope, including the catch variable and the
1064 // end-catch.
1065 RunCleanupsScope CatchScope(*this);
Mike Stump58ef18b2009-11-20 23:44:51 +00001066
John McCallbd309292010-07-06 01:34:17 +00001067 // Initialize the catch variable and set up the cleanups.
Reid Klecknerfff8e7f2015-03-03 19:21:04 +00001068 CGM.getCXXABI().emitBeginCatch(*this, C);
John McCallbd309292010-07-06 01:34:17 +00001069
Justin Bognerea278c32014-01-07 00:20:28 +00001070 // Emit the PGO counter increment.
Justin Bogner66242d62015-04-23 23:06:47 +00001071 incrementProfileCounter(C);
Justin Bogneref512b92014-01-06 22:27:43 +00001072
John McCallbd309292010-07-06 01:34:17 +00001073 // Perform the body of the catch.
1074 EmitStmt(C->getHandlerBlock());
1075
John McCalld8d00be2012-06-15 05:27:05 +00001076 // [except.handle]p11:
1077 // The currently handled exception is rethrown if control
1078 // reaches the end of a handler of the function-try-block of a
1079 // constructor or destructor.
1080
1081 // It is important that we only do this on fallthrough and not on
1082 // return. Note that it's illegal to put a return in a
1083 // constructor function-try-block's catch handler (p14), so this
1084 // really only applies to destructors.
1085 if (doImplicitRethrow && HaveInsertPoint()) {
David Majnemer442d0a22014-11-25 07:20:20 +00001086 CGM.getCXXABI().emitRethrow(*this, /*isNoReturn*/false);
John McCalld8d00be2012-06-15 05:27:05 +00001087 Builder.CreateUnreachable();
1088 Builder.ClearInsertionPoint();
1089 }
1090
John McCallbd309292010-07-06 01:34:17 +00001091 // Fall out through the catch cleanups.
1092 CatchScope.ForceCleanup();
1093
1094 // Branch out of the try.
1095 if (HaveInsertPoint())
1096 Builder.CreateBr(ContBB);
Mike Stump58ef18b2009-11-20 23:44:51 +00001097 }
1098
John McCallbd309292010-07-06 01:34:17 +00001099 EmitBlock(ContBB);
Justin Bogner66242d62015-04-23 23:06:47 +00001100 incrementProfileCounter(&S);
David Majnemerdbf10452015-07-31 17:58:45 +00001101 if (CatchEndBlockBB)
Reid Kleckner2586aac2015-09-10 22:11:13 +00001102 EHStack.popPadEnd();
Mike Stump58ef18b2009-11-20 23:44:51 +00001103}
Mike Stumpaff69af2009-12-09 03:35:49 +00001104
John McCall1e670402010-07-21 00:52:03 +00001105namespace {
David Blaikie7e70d682015-08-18 22:40:54 +00001106 struct CallEndCatchForFinally final : EHScopeStack::Cleanup {
John McCall1e670402010-07-21 00:52:03 +00001107 llvm::Value *ForEHVar;
1108 llvm::Value *EndCatchFn;
1109 CallEndCatchForFinally(llvm::Value *ForEHVar, llvm::Value *EndCatchFn)
1110 : ForEHVar(ForEHVar), EndCatchFn(EndCatchFn) {}
1111
Craig Topper4f12f102014-03-12 06:41:41 +00001112 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall1e670402010-07-21 00:52:03 +00001113 llvm::BasicBlock *EndCatchBB = CGF.createBasicBlock("finally.endcatch");
1114 llvm::BasicBlock *CleanupContBB =
1115 CGF.createBasicBlock("finally.cleanup.cont");
1116
1117 llvm::Value *ShouldEndCatch =
John McCall7f416cc2015-09-08 08:05:57 +00001118 CGF.Builder.CreateFlagLoad(ForEHVar, "finally.endcatch");
John McCall1e670402010-07-21 00:52:03 +00001119 CGF.Builder.CreateCondBr(ShouldEndCatch, EndCatchBB, CleanupContBB);
1120 CGF.EmitBlock(EndCatchBB);
John McCall882987f2013-02-28 19:01:20 +00001121 CGF.EmitRuntimeCallOrInvoke(EndCatchFn); // catch-all, so might throw
John McCall1e670402010-07-21 00:52:03 +00001122 CGF.EmitBlock(CleanupContBB);
1123 }
1124 };
John McCall906da4b2010-07-21 05:47:49 +00001125
David Blaikie7e70d682015-08-18 22:40:54 +00001126 struct PerformFinally final : EHScopeStack::Cleanup {
John McCall906da4b2010-07-21 05:47:49 +00001127 const Stmt *Body;
1128 llvm::Value *ForEHVar;
1129 llvm::Value *EndCatchFn;
1130 llvm::Value *RethrowFn;
1131 llvm::Value *SavedExnVar;
1132
1133 PerformFinally(const Stmt *Body, llvm::Value *ForEHVar,
1134 llvm::Value *EndCatchFn,
1135 llvm::Value *RethrowFn, llvm::Value *SavedExnVar)
1136 : Body(Body), ForEHVar(ForEHVar), EndCatchFn(EndCatchFn),
1137 RethrowFn(RethrowFn), SavedExnVar(SavedExnVar) {}
1138
Craig Topper4f12f102014-03-12 06:41:41 +00001139 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall906da4b2010-07-21 05:47:49 +00001140 // Enter a cleanup to call the end-catch function if one was provided.
1141 if (EndCatchFn)
John McCallcda666c2010-07-21 07:22:38 +00001142 CGF.EHStack.pushCleanup<CallEndCatchForFinally>(NormalAndEHCleanup,
1143 ForEHVar, EndCatchFn);
John McCall906da4b2010-07-21 05:47:49 +00001144
John McCallcebe0ca2010-08-11 00:16:14 +00001145 // Save the current cleanup destination in case there are
1146 // cleanups in the finally block.
1147 llvm::Value *SavedCleanupDest =
1148 CGF.Builder.CreateLoad(CGF.getNormalCleanupDestSlot(),
1149 "cleanup.dest.saved");
1150
John McCall906da4b2010-07-21 05:47:49 +00001151 // Emit the finally block.
1152 CGF.EmitStmt(Body);
1153
1154 // If the end of the finally is reachable, check whether this was
1155 // for EH. If so, rethrow.
1156 if (CGF.HaveInsertPoint()) {
1157 llvm::BasicBlock *RethrowBB = CGF.createBasicBlock("finally.rethrow");
1158 llvm::BasicBlock *ContBB = CGF.createBasicBlock("finally.cont");
1159
1160 llvm::Value *ShouldRethrow =
John McCall7f416cc2015-09-08 08:05:57 +00001161 CGF.Builder.CreateFlagLoad(ForEHVar, "finally.shouldthrow");
John McCall906da4b2010-07-21 05:47:49 +00001162 CGF.Builder.CreateCondBr(ShouldRethrow, RethrowBB, ContBB);
1163
1164 CGF.EmitBlock(RethrowBB);
1165 if (SavedExnVar) {
John McCall882987f2013-02-28 19:01:20 +00001166 CGF.EmitRuntimeCallOrInvoke(RethrowFn,
John McCall7f416cc2015-09-08 08:05:57 +00001167 CGF.Builder.CreateAlignedLoad(SavedExnVar, CGF.getPointerAlign()));
John McCall906da4b2010-07-21 05:47:49 +00001168 } else {
John McCall882987f2013-02-28 19:01:20 +00001169 CGF.EmitRuntimeCallOrInvoke(RethrowFn);
John McCall906da4b2010-07-21 05:47:49 +00001170 }
1171 CGF.Builder.CreateUnreachable();
1172
1173 CGF.EmitBlock(ContBB);
John McCallcebe0ca2010-08-11 00:16:14 +00001174
1175 // Restore the cleanup destination.
1176 CGF.Builder.CreateStore(SavedCleanupDest,
1177 CGF.getNormalCleanupDestSlot());
John McCall906da4b2010-07-21 05:47:49 +00001178 }
1179
1180 // Leave the end-catch cleanup. As an optimization, pretend that
1181 // the fallthrough path was inaccessible; we've dynamically proven
1182 // that we're not in the EH case along that path.
1183 if (EndCatchFn) {
1184 CGBuilderTy::InsertPoint SavedIP = CGF.Builder.saveAndClearIP();
1185 CGF.PopCleanupBlock();
1186 CGF.Builder.restoreIP(SavedIP);
1187 }
1188
1189 // Now make sure we actually have an insertion point or the
1190 // cleanup gods will hate us.
1191 CGF.EnsureInsertPoint();
1192 }
1193 };
Hans Wennborgdcfba332015-10-06 23:40:43 +00001194} // end anonymous namespace
John McCall1e670402010-07-21 00:52:03 +00001195
John McCallbd309292010-07-06 01:34:17 +00001196/// Enters a finally block for an implementation using zero-cost
1197/// exceptions. This is mostly general, but hard-codes some
1198/// language/ABI-specific behavior in the catch-all sections.
John McCall6b0feb72011-06-22 02:32:12 +00001199void CodeGenFunction::FinallyInfo::enter(CodeGenFunction &CGF,
1200 const Stmt *body,
1201 llvm::Constant *beginCatchFn,
1202 llvm::Constant *endCatchFn,
1203 llvm::Constant *rethrowFn) {
Craig Topper8a13c412014-05-21 05:09:00 +00001204 assert((beginCatchFn != nullptr) == (endCatchFn != nullptr) &&
John McCallbd309292010-07-06 01:34:17 +00001205 "begin/end catch functions not paired");
John McCall6b0feb72011-06-22 02:32:12 +00001206 assert(rethrowFn && "rethrow function is required");
1207
1208 BeginCatchFn = beginCatchFn;
Mike Stumpaff69af2009-12-09 03:35:49 +00001209
John McCallbd309292010-07-06 01:34:17 +00001210 // The rethrow function has one of the following two types:
1211 // void (*)()
1212 // void (*)(void*)
1213 // In the latter case we need to pass it the exception object.
1214 // But we can't use the exception slot because the @finally might
1215 // have a landing pad (which would overwrite the exception slot).
Chris Lattner2192fe52011-07-18 04:24:23 +00001216 llvm::FunctionType *rethrowFnTy =
John McCallbd309292010-07-06 01:34:17 +00001217 cast<llvm::FunctionType>(
John McCall6b0feb72011-06-22 02:32:12 +00001218 cast<llvm::PointerType>(rethrowFn->getType())->getElementType());
Craig Topper8a13c412014-05-21 05:09:00 +00001219 SavedExnVar = nullptr;
John McCall6b0feb72011-06-22 02:32:12 +00001220 if (rethrowFnTy->getNumParams())
1221 SavedExnVar = CGF.CreateTempAlloca(CGF.Int8PtrTy, "finally.exn");
Mike Stumpaff69af2009-12-09 03:35:49 +00001222
John McCallbd309292010-07-06 01:34:17 +00001223 // A finally block is a statement which must be executed on any edge
1224 // out of a given scope. Unlike a cleanup, the finally block may
1225 // contain arbitrary control flow leading out of itself. In
1226 // addition, finally blocks should always be executed, even if there
1227 // are no catch handlers higher on the stack. Therefore, we
1228 // surround the protected scope with a combination of a normal
1229 // cleanup (to catch attempts to break out of the block via normal
1230 // control flow) and an EH catch-all (semantically "outside" any try
1231 // statement to which the finally block might have been attached).
1232 // The finally block itself is generated in the context of a cleanup
1233 // which conditionally leaves the catch-all.
John McCall21886962010-04-21 10:05:39 +00001234
John McCallbd309292010-07-06 01:34:17 +00001235 // Jump destination for performing the finally block on an exception
1236 // edge. We'll never actually reach this block, so unreachable is
1237 // fine.
John McCall6b0feb72011-06-22 02:32:12 +00001238 RethrowDest = CGF.getJumpDestInCurrentScope(CGF.getUnreachableBlock());
John McCall21886962010-04-21 10:05:39 +00001239
John McCallbd309292010-07-06 01:34:17 +00001240 // Whether the finally block is being executed for EH purposes.
John McCall6b0feb72011-06-22 02:32:12 +00001241 ForEHVar = CGF.CreateTempAlloca(CGF.Builder.getInt1Ty(), "finally.for-eh");
John McCall7f416cc2015-09-08 08:05:57 +00001242 CGF.Builder.CreateFlagStore(false, ForEHVar);
Mike Stumpaff69af2009-12-09 03:35:49 +00001243
John McCallbd309292010-07-06 01:34:17 +00001244 // Enter a normal cleanup which will perform the @finally block.
John McCall6b0feb72011-06-22 02:32:12 +00001245 CGF.EHStack.pushCleanup<PerformFinally>(NormalCleanup, body,
1246 ForEHVar, endCatchFn,
1247 rethrowFn, SavedExnVar);
John McCallbd309292010-07-06 01:34:17 +00001248
1249 // Enter a catch-all scope.
John McCall6b0feb72011-06-22 02:32:12 +00001250 llvm::BasicBlock *catchBB = CGF.createBasicBlock("finally.catchall");
1251 EHCatchScope *catchScope = CGF.EHStack.pushCatch(1);
1252 catchScope->setCatchAllHandler(0, catchBB);
John McCallbd309292010-07-06 01:34:17 +00001253}
1254
John McCall6b0feb72011-06-22 02:32:12 +00001255void CodeGenFunction::FinallyInfo::exit(CodeGenFunction &CGF) {
John McCallbd309292010-07-06 01:34:17 +00001256 // Leave the finally catch-all.
John McCall6b0feb72011-06-22 02:32:12 +00001257 EHCatchScope &catchScope = cast<EHCatchScope>(*CGF.EHStack.begin());
1258 llvm::BasicBlock *catchBB = catchScope.getHandler(0).Block;
John McCall8e4c74b2011-08-11 02:22:43 +00001259
1260 CGF.popCatchScope();
John McCallbd309292010-07-06 01:34:17 +00001261
John McCall6b0feb72011-06-22 02:32:12 +00001262 // If there are any references to the catch-all block, emit it.
1263 if (catchBB->use_empty()) {
1264 delete catchBB;
1265 } else {
1266 CGBuilderTy::InsertPoint savedIP = CGF.Builder.saveAndClearIP();
1267 CGF.EmitBlock(catchBB);
John McCallbd309292010-07-06 01:34:17 +00001268
Craig Topper8a13c412014-05-21 05:09:00 +00001269 llvm::Value *exn = nullptr;
John McCallbd309292010-07-06 01:34:17 +00001270
John McCall6b0feb72011-06-22 02:32:12 +00001271 // If there's a begin-catch function, call it.
1272 if (BeginCatchFn) {
Bill Wendling79a70e42011-09-15 18:57:19 +00001273 exn = CGF.getExceptionFromSlot();
John McCall882987f2013-02-28 19:01:20 +00001274 CGF.EmitNounwindRuntimeCall(BeginCatchFn, exn);
John McCall6b0feb72011-06-22 02:32:12 +00001275 }
1276
1277 // If we need to remember the exception pointer to rethrow later, do so.
1278 if (SavedExnVar) {
Bill Wendling79a70e42011-09-15 18:57:19 +00001279 if (!exn) exn = CGF.getExceptionFromSlot();
John McCall7f416cc2015-09-08 08:05:57 +00001280 CGF.Builder.CreateAlignedStore(exn, SavedExnVar, CGF.getPointerAlign());
John McCall6b0feb72011-06-22 02:32:12 +00001281 }
1282
1283 // Tell the cleanups in the finally block that we're do this for EH.
John McCall7f416cc2015-09-08 08:05:57 +00001284 CGF.Builder.CreateFlagStore(true, ForEHVar);
John McCall6b0feb72011-06-22 02:32:12 +00001285
1286 // Thread a jump through the finally cleanup.
1287 CGF.EmitBranchThroughCleanup(RethrowDest);
1288
1289 CGF.Builder.restoreIP(savedIP);
1290 }
1291
1292 // Finally, leave the @finally cleanup.
1293 CGF.PopCleanupBlock();
John McCallbd309292010-07-06 01:34:17 +00001294}
1295
1296llvm::BasicBlock *CodeGenFunction::getTerminateLandingPad() {
1297 if (TerminateLandingPad)
1298 return TerminateLandingPad;
1299
1300 CGBuilderTy::InsertPoint SavedIP = Builder.saveAndClearIP();
1301
1302 // This will get inserted at the end of the function.
1303 TerminateLandingPad = createBasicBlock("terminate.lpad");
1304 Builder.SetInsertPoint(TerminateLandingPad);
1305
1306 // Tell the backend that this is a landing pad.
Reid Klecknerdeeddec2015-02-05 18:56:03 +00001307 const EHPersonality &Personality = EHPersonality::get(*this);
David Majnemerfcbdb6e2015-06-17 20:53:19 +00001308
1309 if (!CurFn->hasPersonalityFn())
1310 CurFn->setPersonalityFn(getOpaquePersonalityFn(CGM, Personality));
1311
1312 llvm::LandingPadInst *LPadInst = Builder.CreateLandingPad(
1313 llvm::StructType::get(Int8PtrTy, Int32Ty, nullptr), 0);
Bill Wendlingf0724e82011-09-19 20:31:14 +00001314 LPadInst->addClause(getCatchAllValue(*this));
John McCallbd309292010-07-06 01:34:17 +00001315
Hans Wennborgdcfba332015-10-06 23:40:43 +00001316 llvm::Value *Exn = nullptr;
Reid Klecknerfff8e7f2015-03-03 19:21:04 +00001317 if (getLangOpts().CPlusPlus)
1318 Exn = Builder.CreateExtractValue(LPadInst, 0);
1319 llvm::CallInst *terminateCall =
1320 CGM.getCXXABI().emitTerminateForUnexpectedException(*this, Exn);
John McCalle142ad52013-02-12 03:51:46 +00001321 terminateCall->setDoesNotReturn();
John McCallad7c5c12011-02-08 08:22:06 +00001322 Builder.CreateUnreachable();
Mike Stumpaff69af2009-12-09 03:35:49 +00001323
John McCallbd309292010-07-06 01:34:17 +00001324 // Restore the saved insertion state.
1325 Builder.restoreIP(SavedIP);
John McCalldac3ea62010-04-30 00:06:43 +00001326
John McCallbd309292010-07-06 01:34:17 +00001327 return TerminateLandingPad;
Mike Stumpaff69af2009-12-09 03:35:49 +00001328}
Mike Stump2b488872009-12-09 22:59:31 +00001329
1330llvm::BasicBlock *CodeGenFunction::getTerminateHandler() {
Mike Stumpf5cbb082009-12-10 00:02:42 +00001331 if (TerminateHandler)
1332 return TerminateHandler;
1333
John McCallbd309292010-07-06 01:34:17 +00001334 CGBuilderTy::InsertPoint SavedIP = Builder.saveAndClearIP();
Mike Stump25b20fc2009-12-09 23:31:35 +00001335
John McCallbd309292010-07-06 01:34:17 +00001336 // Set up the terminate handler. This block is inserted at the very
1337 // end of the function by FinishFunction.
Mike Stumpf5cbb082009-12-10 00:02:42 +00001338 TerminateHandler = createBasicBlock("terminate.handler");
John McCallbd309292010-07-06 01:34:17 +00001339 Builder.SetInsertPoint(TerminateHandler);
Reid Kleckner129552b2015-10-08 01:13:52 +00001340 if (EHPersonality::get(*this).usesFuncletPads()) {
David Majnemerdbf10452015-07-31 17:58:45 +00001341 Builder.CreateTerminatePad(/*UnwindBB=*/nullptr, CGM.getTerminateFn());
1342 } else {
Hans Wennborgdcfba332015-10-06 23:40:43 +00001343 llvm::Value *Exn = nullptr;
David Majnemerdbf10452015-07-31 17:58:45 +00001344 if (getLangOpts().CPlusPlus)
1345 Exn = getExceptionFromSlot();
1346 llvm::CallInst *terminateCall =
1347 CGM.getCXXABI().emitTerminateForUnexpectedException(*this, Exn);
1348 terminateCall->setDoesNotReturn();
1349 Builder.CreateUnreachable();
1350 }
Mike Stump2b488872009-12-09 22:59:31 +00001351
John McCall21886962010-04-21 10:05:39 +00001352 // Restore the saved insertion state.
John McCallbd309292010-07-06 01:34:17 +00001353 Builder.restoreIP(SavedIP);
Mike Stump25b20fc2009-12-09 23:31:35 +00001354
Mike Stump2b488872009-12-09 22:59:31 +00001355 return TerminateHandler;
1356}
John McCallbd309292010-07-06 01:34:17 +00001357
David Chisnall9a837be2012-11-07 16:50:40 +00001358llvm::BasicBlock *CodeGenFunction::getEHResumeBlock(bool isCleanup) {
John McCall8e4c74b2011-08-11 02:22:43 +00001359 if (EHResumeBlock) return EHResumeBlock;
John McCallad5d61e2010-07-23 21:56:41 +00001360
1361 CGBuilderTy::InsertPoint SavedIP = Builder.saveIP();
1362
1363 // We emit a jump to a notional label at the outermost unwind state.
John McCall8e4c74b2011-08-11 02:22:43 +00001364 EHResumeBlock = createBasicBlock("eh.resume");
1365 Builder.SetInsertPoint(EHResumeBlock);
John McCallad5d61e2010-07-23 21:56:41 +00001366
Reid Klecknerdeeddec2015-02-05 18:56:03 +00001367 const EHPersonality &Personality = EHPersonality::get(*this);
John McCallad5d61e2010-07-23 21:56:41 +00001368
1369 // This can always be a call because we necessarily didn't find
1370 // anything on the EH stack which needs our help.
Benjamin Kramer793bd552012-02-08 12:41:24 +00001371 const char *RethrowName = Personality.CatchallRethrowFn;
Craig Topper8a13c412014-05-21 05:09:00 +00001372 if (RethrowName != nullptr && !isCleanup) {
John McCall882987f2013-02-28 19:01:20 +00001373 EmitRuntimeCall(getCatchallRethrowFn(CGM, RethrowName),
Nico Weberff62a6a2015-02-26 22:34:33 +00001374 getExceptionFromSlot())->setDoesNotReturn();
Logan Chiene9c8ccb2014-07-01 11:47:10 +00001375 Builder.CreateUnreachable();
1376 Builder.restoreIP(SavedIP);
1377 return EHResumeBlock;
John McCall9b382dd2011-05-28 21:13:02 +00001378 }
1379
Logan Chiene9c8ccb2014-07-01 11:47:10 +00001380 // Recreate the landingpad's return value for the 'resume' instruction.
1381 llvm::Value *Exn = getExceptionFromSlot();
1382 llvm::Value *Sel = getSelectorFromSlot();
John McCallad5d61e2010-07-23 21:56:41 +00001383
Logan Chiene9c8ccb2014-07-01 11:47:10 +00001384 llvm::Type *LPadType = llvm::StructType::get(Exn->getType(),
Reid Kleckneree7cf842014-12-01 22:02:27 +00001385 Sel->getType(), nullptr);
Logan Chiene9c8ccb2014-07-01 11:47:10 +00001386 llvm::Value *LPadVal = llvm::UndefValue::get(LPadType);
1387 LPadVal = Builder.CreateInsertValue(LPadVal, Exn, 0, "lpad.val");
1388 LPadVal = Builder.CreateInsertValue(LPadVal, Sel, 1, "lpad.val");
1389
1390 Builder.CreateResume(LPadVal);
John McCallad5d61e2010-07-23 21:56:41 +00001391 Builder.restoreIP(SavedIP);
John McCall8e4c74b2011-08-11 02:22:43 +00001392 return EHResumeBlock;
John McCallad5d61e2010-07-23 21:56:41 +00001393}
Reid Kleckner543a16c2013-09-16 21:46:30 +00001394
1395void CodeGenFunction::EmitSEHTryStmt(const SEHTryStmt &S) {
Reid Klecknerebaf28d2015-04-14 20:59:00 +00001396 EnterSEHTryStmt(S);
Reid Klecknera5930002015-02-11 21:40:48 +00001397 {
Nico Weber5779f842015-02-12 23:16:11 +00001398 JumpDest TryExit = getJumpDestInCurrentScope("__try.__leave");
Nico Weber5779f842015-02-12 23:16:11 +00001399
Reid Kleckner11c033e2015-02-12 23:40:45 +00001400 SEHTryEpilogueStack.push_back(&TryExit);
Reid Klecknera5930002015-02-11 21:40:48 +00001401 EmitStmt(S.getTryBlock());
Reid Kleckner11c033e2015-02-12 23:40:45 +00001402 SEHTryEpilogueStack.pop_back();
Nico Weber5779f842015-02-12 23:16:11 +00001403
1404 if (!TryExit.getBlock()->use_empty())
1405 EmitBlock(TryExit.getBlock(), /*IsFinished=*/true);
1406 else
1407 delete TryExit.getBlock();
Reid Klecknera5930002015-02-11 21:40:48 +00001408 }
Reid Klecknerebaf28d2015-04-14 20:59:00 +00001409 ExitSEHTryStmt(S);
Reid Kleckner1d59f992015-01-22 01:36:17 +00001410}
1411
1412namespace {
David Blaikie7e70d682015-08-18 22:40:54 +00001413struct PerformSEHFinally final : EHScopeStack::Cleanup {
Reid Klecknerebaf28d2015-04-14 20:59:00 +00001414 llvm::Function *OutlinedFinally;
Reid Kleckner55391522015-10-08 21:14:56 +00001415 PerformSEHFinally(llvm::Function *OutlinedFinally)
1416 : OutlinedFinally(OutlinedFinally) {}
Reid Kleckneraca01db2015-02-04 22:37:07 +00001417
Reid Kleckner1d59f992015-01-22 01:36:17 +00001418 void Emit(CodeGenFunction &CGF, Flags F) override {
Reid Klecknerebaf28d2015-04-14 20:59:00 +00001419 ASTContext &Context = CGF.getContext();
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001420 CodeGenModule &CGM = CGF.CGM;
Reid Kleckner65870442015-06-09 17:47:50 +00001421
Reid Klecknerd0d9a1f2015-07-01 17:10:10 +00001422 CallArgList Args;
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001423
1424 // Compute the two argument values.
1425 QualType ArgTys[2] = {Context.UnsignedCharTy, Context.VoidPtrTy};
Reid Kleckner15d152d2015-07-07 23:23:31 +00001426 llvm::Value *LocalAddrFn = CGM.getIntrinsic(llvm::Intrinsic::localaddress);
David Blaikie4ba525b2015-07-14 17:27:39 +00001427 llvm::Value *FP = CGF.Builder.CreateCall(LocalAddrFn);
Reid Klecknereb11c412015-07-01 21:00:00 +00001428 llvm::Value *IsForEH =
1429 llvm::ConstantInt::get(CGF.ConvertType(ArgTys[0]), F.isForEHCleanup());
1430 Args.add(RValue::get(IsForEH), ArgTys[0]);
1431 Args.add(RValue::get(FP), ArgTys[1]);
Reid Klecknerd0d9a1f2015-07-01 17:10:10 +00001432
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001433 // Arrange a two-arg function info and type.
1434 FunctionProtoType::ExtProtoInfo EPI;
1435 const auto *FPT = cast<FunctionProtoType>(
1436 Context.getFunctionType(Context.VoidTy, ArgTys, EPI));
Reid Klecknereb11c412015-07-01 21:00:00 +00001437 const CGFunctionInfo &FnInfo =
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001438 CGM.getTypes().arrangeFreeFunctionCall(Args, FPT,
1439 /*chainCall=*/false);
1440
Reid Klecknereb11c412015-07-01 21:00:00 +00001441 CGF.EmitCall(FnInfo, OutlinedFinally, ReturnValueSlot(), Args);
Reid Kleckner1d59f992015-01-22 01:36:17 +00001442 }
1443};
Hans Wennborgdcfba332015-10-06 23:40:43 +00001444} // end anonymous namespace
Reid Kleckner1d59f992015-01-22 01:36:17 +00001445
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001446namespace {
1447/// Find all local variable captures in the statement.
1448struct CaptureFinder : ConstStmtVisitor<CaptureFinder> {
1449 CodeGenFunction &ParentCGF;
1450 const VarDecl *ParentThis;
John McCall0a490152015-09-08 21:15:22 +00001451 llvm::SmallSetVector<const VarDecl *, 4> Captures;
John McCall7f416cc2015-09-08 08:05:57 +00001452 Address SEHCodeSlot = Address::invalid();
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001453 CaptureFinder(CodeGenFunction &ParentCGF, const VarDecl *ParentThis)
1454 : ParentCGF(ParentCGF), ParentThis(ParentThis) {}
1455
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001456 // Return true if we need to do any capturing work.
1457 bool foundCaptures() {
John McCall7f416cc2015-09-08 08:05:57 +00001458 return !Captures.empty() || SEHCodeSlot.isValid();
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001459 }
1460
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001461 void Visit(const Stmt *S) {
1462 // See if this is a capture, then recurse.
1463 ConstStmtVisitor<CaptureFinder>::Visit(S);
1464 for (const Stmt *Child : S->children())
Reid Klecknerebaf28d2015-04-14 20:59:00 +00001465 if (Child)
1466 Visit(Child);
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001467 }
1468
1469 void VisitDeclRefExpr(const DeclRefExpr *E) {
1470 // If this is already a capture, just make sure we capture 'this'.
1471 if (E->refersToEnclosingVariableOrCapture()) {
John McCall0a490152015-09-08 21:15:22 +00001472 Captures.insert(ParentThis);
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001473 return;
1474 }
1475
1476 const auto *D = dyn_cast<VarDecl>(E->getDecl());
1477 if (D && D->isLocalVarDeclOrParm() && D->hasLocalStorage())
John McCall0a490152015-09-08 21:15:22 +00001478 Captures.insert(D);
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001479 }
1480
1481 void VisitCXXThisExpr(const CXXThisExpr *E) {
John McCall0a490152015-09-08 21:15:22 +00001482 Captures.insert(ParentThis);
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001483 }
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001484
1485 void VisitCallExpr(const CallExpr *E) {
1486 // We only need to add parent frame allocations for these builtins in x86.
1487 if (ParentCGF.getTarget().getTriple().getArch() != llvm::Triple::x86)
1488 return;
1489
1490 unsigned ID = E->getBuiltinCallee();
1491 switch (ID) {
1492 case Builtin::BI__exception_code:
1493 case Builtin::BI_exception_code:
1494 // This is the simple case where we are the outermost finally. All we
1495 // have to do here is make sure we escape this and recover it in the
1496 // outlined handler.
John McCall7f416cc2015-09-08 08:05:57 +00001497 if (!SEHCodeSlot.isValid())
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001498 SEHCodeSlot = ParentCGF.SEHCodeSlotStack.back();
1499 break;
1500 }
1501 }
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001502};
Hans Wennborgdcfba332015-10-06 23:40:43 +00001503} // end anonymous namespace
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001504
John McCall7f416cc2015-09-08 08:05:57 +00001505Address CodeGenFunction::recoverAddrOfEscapedLocal(
1506 CodeGenFunction &ParentCGF, Address ParentVar, llvm::Value *ParentFP) {
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001507 llvm::CallInst *RecoverCall = nullptr;
John McCall7f416cc2015-09-08 08:05:57 +00001508 CGBuilderTy Builder(*this, AllocaInsertPt);
1509 if (auto *ParentAlloca = dyn_cast<llvm::AllocaInst>(ParentVar.getPointer())) {
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001510 // Mark the variable escaped if nobody else referenced it and compute the
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00001511 // localescape index.
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001512 auto InsertPair = ParentCGF.EscapedLocals.insert(
1513 std::make_pair(ParentAlloca, ParentCGF.EscapedLocals.size()));
1514 int FrameEscapeIdx = InsertPair.first->second;
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00001515 // call i8* @llvm.localrecover(i8* bitcast(@parentFn), i8* %fp, i32 N)
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001516 llvm::Function *FrameRecoverFn = llvm::Intrinsic::getDeclaration(
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00001517 &CGM.getModule(), llvm::Intrinsic::localrecover);
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001518 llvm::Constant *ParentI8Fn =
1519 llvm::ConstantExpr::getBitCast(ParentCGF.CurFn, Int8PtrTy);
1520 RecoverCall = Builder.CreateCall(
1521 FrameRecoverFn, {ParentI8Fn, ParentFP,
1522 llvm::ConstantInt::get(Int32Ty, FrameEscapeIdx)});
1523
1524 } else {
1525 // If the parent didn't have an alloca, we're doing some nested outlining.
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00001526 // Just clone the existing localrecover call, but tweak the FP argument to
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001527 // use our FP value. All other arguments are constants.
1528 auto *ParentRecover =
John McCall7f416cc2015-09-08 08:05:57 +00001529 cast<llvm::IntrinsicInst>(ParentVar.getPointer()->stripPointerCasts());
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00001530 assert(ParentRecover->getIntrinsicID() == llvm::Intrinsic::localrecover &&
1531 "expected alloca or localrecover in parent LocalDeclMap");
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001532 RecoverCall = cast<llvm::CallInst>(ParentRecover->clone());
1533 RecoverCall->setArgOperand(1, ParentFP);
1534 RecoverCall->insertBefore(AllocaInsertPt);
1535 }
1536
1537 // Bitcast the variable, rename it, and insert it in the local decl map.
1538 llvm::Value *ChildVar =
John McCall7f416cc2015-09-08 08:05:57 +00001539 Builder.CreateBitCast(RecoverCall, ParentVar.getType());
1540 ChildVar->setName(ParentVar.getName());
1541 return Address(ChildVar, ParentVar.getAlignment());
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001542}
1543
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001544void CodeGenFunction::EmitCapturedLocals(CodeGenFunction &ParentCGF,
Reid Kleckner0b9bbbf2015-06-09 17:49:42 +00001545 const Stmt *OutlinedStmt,
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001546 bool IsFilter) {
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001547 // Find all captures in the Stmt.
1548 CaptureFinder Finder(ParentCGF, ParentCGF.CXXABIThisDecl);
1549 Finder.Visit(OutlinedStmt);
1550
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001551 // We can exit early on x86_64 when there are no captures. We just have to
1552 // save the exception code in filters so that __exception_code() works.
1553 if (!Finder.foundCaptures() &&
1554 CGM.getTarget().getTriple().getArch() != llvm::Triple::x86) {
1555 if (IsFilter)
1556 EmitSEHExceptionCodeSave(ParentCGF, nullptr, nullptr);
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001557 return;
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001558 }
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001559
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001560 llvm::Value *EntryEBP = nullptr;
1561 llvm::Value *ParentFP;
1562 if (IsFilter && CGM.getTarget().getTriple().getArch() == llvm::Triple::x86) {
1563 // 32-bit SEH filters need to be careful about FP recovery. The end of the
1564 // EH registration is passed in as the EBP physical register. We can
1565 // recover that with llvm.frameaddress(1), and adjust that to recover the
1566 // parent's true frame pointer.
John McCall7f416cc2015-09-08 08:05:57 +00001567 CGBuilderTy Builder(CGM, AllocaInsertPt);
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001568 EntryEBP = Builder.CreateCall(
1569 CGM.getIntrinsic(llvm::Intrinsic::frameaddress), {Builder.getInt32(1)});
1570 llvm::Function *RecoverFPIntrin =
1571 CGM.getIntrinsic(llvm::Intrinsic::x86_seh_recoverfp);
1572 llvm::Constant *ParentI8Fn =
1573 llvm::ConstantExpr::getBitCast(ParentCGF.CurFn, Int8PtrTy);
1574 ParentFP = Builder.CreateCall(RecoverFPIntrin, {ParentI8Fn, EntryEBP});
1575 } else {
1576 // Otherwise, for x64 and 32-bit finally functions, the parent FP is the
1577 // second parameter.
1578 auto AI = CurFn->arg_begin();
1579 ++AI;
Duncan P. N. Exon Smith9f5260a2015-11-06 23:00:41 +00001580 ParentFP = &*AI;
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001581 }
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001582
Reid Kleckner98cb8ba2015-07-07 22:26:07 +00001583 // Create llvm.localrecover calls for all captures.
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001584 for (const VarDecl *VD : Finder.Captures) {
1585 if (isa<ImplicitParamDecl>(VD)) {
1586 CGM.ErrorUnsupported(VD, "'this' captured by SEH");
1587 CXXThisValue = llvm::UndefValue::get(ConvertTypeForMem(VD->getType()));
1588 continue;
1589 }
1590 if (VD->getType()->isVariablyModifiedType()) {
1591 CGM.ErrorUnsupported(VD, "VLA captured by SEH");
1592 continue;
1593 }
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001594 assert((isa<ImplicitParamDecl>(VD) || VD->isLocalVarDeclOrParm()) &&
1595 "captured non-local variable");
1596
Reid Klecknerebaf28d2015-04-14 20:59:00 +00001597 // If this decl hasn't been declared yet, it will be declared in the
1598 // OutlinedStmt.
1599 auto I = ParentCGF.LocalDeclMap.find(VD);
1600 if (I == ParentCGF.LocalDeclMap.end())
1601 continue;
Reid Klecknerebaf28d2015-04-14 20:59:00 +00001602
John McCall7f416cc2015-09-08 08:05:57 +00001603 Address ParentVar = I->second;
1604 setAddrOfLocalVar(VD,
1605 recoverAddrOfEscapedLocal(ParentCGF, ParentVar, ParentFP));
Nico Webere4f974c2015-07-02 06:10:53 +00001606 }
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001607
John McCall7f416cc2015-09-08 08:05:57 +00001608 if (Finder.SEHCodeSlot.isValid()) {
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001609 SEHCodeSlotStack.push_back(
1610 recoverAddrOfEscapedLocal(ParentCGF, Finder.SEHCodeSlot, ParentFP));
1611 }
1612
1613 if (IsFilter)
1614 EmitSEHExceptionCodeSave(ParentCGF, ParentFP, EntryEBP);
Reid Kleckner31a1bb02015-04-08 22:23:48 +00001615}
1616
Reid Klecknerebaf28d2015-04-14 20:59:00 +00001617/// Arrange a function prototype that can be called by Windows exception
1618/// handling personalities. On Win64, the prototype looks like:
1619/// RetTy func(void *EHPtrs, void *ParentFP);
1620void CodeGenFunction::startOutlinedSEHHelper(CodeGenFunction &ParentCGF,
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001621 bool IsFilter,
Reid Klecknerebaf28d2015-04-14 20:59:00 +00001622 const Stmt *OutlinedStmt) {
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001623 SourceLocation StartLoc = OutlinedStmt->getLocStart();
1624
1625 // Get the mangled function name.
1626 SmallString<128> Name;
1627 {
1628 llvm::raw_svector_ostream OS(Name);
1629 const Decl *ParentCodeDecl = ParentCGF.CurCodeDecl;
1630 const NamedDecl *Parent = dyn_cast_or_null<NamedDecl>(ParentCodeDecl);
1631 assert(Parent && "FIXME: handle unnamed decls (lambdas, blocks) with SEH");
1632 MangleContext &Mangler = CGM.getCXXABI().getMangleContext();
1633 if (IsFilter)
1634 Mangler.mangleSEHFilterExpression(Parent, OS);
1635 else
1636 Mangler.mangleSEHFinallyBlock(Parent, OS);
1637 }
1638
1639 FunctionArgList Args;
1640 if (CGM.getTarget().getTriple().getArch() != llvm::Triple::x86 || !IsFilter) {
1641 // All SEH finally functions take two parameters. Win64 filters take two
1642 // parameters. Win32 filters take no parameters.
1643 if (IsFilter) {
1644 Args.push_back(ImplicitParamDecl::Create(
1645 getContext(), nullptr, StartLoc,
1646 &getContext().Idents.get("exception_pointers"),
1647 getContext().VoidPtrTy));
1648 } else {
1649 Args.push_back(ImplicitParamDecl::Create(
1650 getContext(), nullptr, StartLoc,
1651 &getContext().Idents.get("abnormal_termination"),
1652 getContext().UnsignedCharTy));
1653 }
1654 Args.push_back(ImplicitParamDecl::Create(
1655 getContext(), nullptr, StartLoc,
1656 &getContext().Idents.get("frame_pointer"), getContext().VoidPtrTy));
1657 }
1658
1659 QualType RetTy = IsFilter ? getContext().LongTy : getContext().VoidTy;
1660
Reid Kleckner1d59f992015-01-22 01:36:17 +00001661 llvm::Function *ParentFn = ParentCGF.CurFn;
Reid Kleckner1d59f992015-01-22 01:36:17 +00001662 const CGFunctionInfo &FnInfo = CGM.getTypes().arrangeFreeFunctionDeclaration(
1663 RetTy, Args, FunctionType::ExtInfo(), /*isVariadic=*/false);
Reid Klecknerebaf28d2015-04-14 20:59:00 +00001664
Reid Kleckner1d59f992015-01-22 01:36:17 +00001665 llvm::FunctionType *FnTy = CGM.getTypes().GetFunctionType(FnInfo);
Reid Klecknerebaf28d2015-04-14 20:59:00 +00001666 llvm::Function *Fn = llvm::Function::Create(
1667 FnTy, llvm::GlobalValue::InternalLinkage, Name.str(), &CGM.getModule());
Reid Kleckner1d59f992015-01-22 01:36:17 +00001668 // The filter is either in the same comdat as the function, or it's internal.
1669 if (llvm::Comdat *C = ParentFn->getComdat()) {
1670 Fn->setComdat(C);
1671 } else if (ParentFn->hasWeakLinkage() || ParentFn->hasLinkOnceLinkage()) {
Reid Kleckner1d59f992015-01-22 01:36:17 +00001672 llvm::Comdat *C = CGM.getModule().getOrInsertComdat(ParentFn->getName());
1673 ParentFn->setComdat(C);
1674 Fn->setComdat(C);
1675 } else {
1676 Fn->setLinkage(llvm::GlobalValue::InternalLinkage);
1677 }
1678
Reid Klecknerebaf28d2015-04-14 20:59:00 +00001679 IsOutlinedSEHHelper = true;
Nico Weberf2a39a72015-04-13 20:03:03 +00001680
Reid Klecknerebaf28d2015-04-14 20:59:00 +00001681 StartFunction(GlobalDecl(), RetTy, Fn, FnInfo, Args,
1682 OutlinedStmt->getLocStart(), OutlinedStmt->getLocStart());
1683
1684 CGM.SetLLVMFunctionAttributes(nullptr, FnInfo, CurFn);
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001685 EmitCapturedLocals(ParentCGF, OutlinedStmt, IsFilter);
Reid Klecknerebaf28d2015-04-14 20:59:00 +00001686}
1687
1688/// Create a stub filter function that will ultimately hold the code of the
1689/// filter expression. The EH preparation passes in LLVM will outline the code
1690/// from the main function body into this stub.
1691llvm::Function *
1692CodeGenFunction::GenerateSEHFilterFunction(CodeGenFunction &ParentCGF,
1693 const SEHExceptStmt &Except) {
1694 const Expr *FilterExpr = Except.getFilterExpr();
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001695 startOutlinedSEHHelper(ParentCGF, true, FilterExpr);
Reid Kleckner1d59f992015-01-22 01:36:17 +00001696
1697 // Emit the original filter expression, convert to i32, and return.
1698 llvm::Value *R = EmitScalarExpr(FilterExpr);
David Majnemer2ccba832015-04-17 06:57:25 +00001699 R = Builder.CreateIntCast(R, ConvertType(getContext().LongTy),
Reid Kleckner1d59f992015-01-22 01:36:17 +00001700 FilterExpr->getType()->isSignedIntegerType());
1701 Builder.CreateStore(R, ReturnValue);
1702
1703 FinishFunction(FilterExpr->getLocEnd());
1704
Reid Klecknerebaf28d2015-04-14 20:59:00 +00001705 return CurFn;
1706}
1707
1708llvm::Function *
1709CodeGenFunction::GenerateSEHFinallyFunction(CodeGenFunction &ParentCGF,
1710 const SEHFinallyStmt &Finally) {
1711 const Stmt *FinallyBlock = Finally.getBlock();
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001712 startOutlinedSEHHelper(ParentCGF, false, FinallyBlock);
Reid Klecknerebaf28d2015-04-14 20:59:00 +00001713
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001714 // Mark finally block calls as nounwind and noinline to make LLVM's job a
1715 // little easier.
1716 // FIXME: Remove these restrictions in the future.
1717 CurFn->addFnAttr(llvm::Attribute::NoUnwind);
1718 CurFn->addFnAttr(llvm::Attribute::NoInline);
Reid Klecknerebaf28d2015-04-14 20:59:00 +00001719
1720 // Emit the original filter expression, convert to i32, and return.
1721 EmitStmt(FinallyBlock);
1722
1723 FinishFunction(FinallyBlock->getLocEnd());
1724
1725 return CurFn;
Reid Kleckner1d59f992015-01-22 01:36:17 +00001726}
1727
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001728void CodeGenFunction::EmitSEHExceptionCodeSave(CodeGenFunction &ParentCGF,
1729 llvm::Value *ParentFP,
1730 llvm::Value *EntryEBP) {
1731 // Get the pointer to the EXCEPTION_POINTERS struct. This is returned by the
1732 // __exception_info intrinsic.
1733 if (CGM.getTarget().getTriple().getArch() != llvm::Triple::x86) {
1734 // On Win64, the info is passed as the first parameter to the filter.
Duncan P. N. Exon Smith9f5260a2015-11-06 23:00:41 +00001735 SEHInfo = &*CurFn->arg_begin();
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001736 SEHCodeSlotStack.push_back(
1737 CreateMemTemp(getContext().IntTy, "__exception_code"));
1738 } else {
1739 // On Win32, the EBP on entry to the filter points to the end of an
1740 // exception registration object. It contains 6 32-bit fields, and the info
1741 // pointer is stored in the second field. So, GEP 20 bytes backwards and
1742 // load the pointer.
1743 SEHInfo = Builder.CreateConstInBoundsGEP1_32(Int8Ty, EntryEBP, -20);
1744 SEHInfo = Builder.CreateBitCast(SEHInfo, Int8PtrTy->getPointerTo());
John McCall7f416cc2015-09-08 08:05:57 +00001745 SEHInfo = Builder.CreateAlignedLoad(Int8PtrTy, SEHInfo, getPointerAlign());
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001746 SEHCodeSlotStack.push_back(recoverAddrOfEscapedLocal(
1747 ParentCGF, ParentCGF.SEHCodeSlotStack.back(), ParentFP));
1748 }
1749
Reid Kleckner1d59f992015-01-22 01:36:17 +00001750 // Save the exception code in the exception slot to unify exception access in
1751 // the filter function and the landing pad.
1752 // struct EXCEPTION_POINTERS {
1753 // EXCEPTION_RECORD *ExceptionRecord;
1754 // CONTEXT *ContextRecord;
1755 // };
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001756 // int exceptioncode = exception_pointers->ExceptionRecord->ExceptionCode;
Reid Kleckner1d59f992015-01-22 01:36:17 +00001757 llvm::Type *RecordTy = CGM.Int32Ty->getPointerTo();
1758 llvm::Type *PtrsTy = llvm::StructType::get(RecordTy, CGM.VoidPtrTy, nullptr);
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001759 llvm::Value *Ptrs = Builder.CreateBitCast(SEHInfo, PtrsTy->getPointerTo());
David Blaikie1ed728c2015-04-05 22:45:47 +00001760 llvm::Value *Rec = Builder.CreateStructGEP(PtrsTy, Ptrs, 0);
John McCall7f416cc2015-09-08 08:05:57 +00001761 Rec = Builder.CreateAlignedLoad(Rec, getPointerAlign());
1762 llvm::Value *Code = Builder.CreateAlignedLoad(Rec, getIntAlign());
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001763 assert(!SEHCodeSlotStack.empty() && "emitting EH code outside of __except");
1764 Builder.CreateStore(Code, SEHCodeSlotStack.back());
Reid Kleckner1d59f992015-01-22 01:36:17 +00001765}
1766
1767llvm::Value *CodeGenFunction::EmitSEHExceptionInfo() {
1768 // Sema should diagnose calling this builtin outside of a filter context, but
1769 // don't crash if we screw up.
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001770 if (!SEHInfo)
Reid Kleckner1d59f992015-01-22 01:36:17 +00001771 return llvm::UndefValue::get(Int8PtrTy);
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001772 assert(SEHInfo->getType() == Int8PtrTy);
1773 return SEHInfo;
Reid Kleckner1d59f992015-01-22 01:36:17 +00001774}
1775
1776llvm::Value *CodeGenFunction::EmitSEHExceptionCode() {
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001777 assert(!SEHCodeSlotStack.empty() && "emitting EH code outside of __except");
John McCall7f416cc2015-09-08 08:05:57 +00001778 return Builder.CreateLoad(SEHCodeSlotStack.back());
Reid Kleckner1d59f992015-01-22 01:36:17 +00001779}
1780
Reid Kleckneraca01db2015-02-04 22:37:07 +00001781llvm::Value *CodeGenFunction::EmitSEHAbnormalTermination() {
Reid Klecknerebaf28d2015-04-14 20:59:00 +00001782 // Abnormal termination is just the first parameter to the outlined finally
1783 // helper.
1784 auto AI = CurFn->arg_begin();
1785 return Builder.CreateZExt(&*AI, Int32Ty);
Reid Kleckneraca01db2015-02-04 22:37:07 +00001786}
1787
Reid Klecknerebaf28d2015-04-14 20:59:00 +00001788void CodeGenFunction::EnterSEHTryStmt(const SEHTryStmt &S) {
1789 CodeGenFunction HelperCGF(CGM, /*suppressNewContext=*/true);
1790 if (const SEHFinallyStmt *Finally = S.getFinallyHandler()) {
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001791 // Outline the finally block.
Reid Klecknerebaf28d2015-04-14 20:59:00 +00001792 llvm::Function *FinallyFunc =
1793 HelperCGF.GenerateSEHFinallyFunction(*this, *Finally);
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001794
1795 // Push a cleanup for __finally blocks.
Reid Kleckner55391522015-10-08 21:14:56 +00001796 EHStack.pushCleanup<PerformSEHFinally>(NormalAndEHCleanup, FinallyFunc);
Reid Kleckner1d59f992015-01-22 01:36:17 +00001797 return;
1798 }
1799
1800 // Otherwise, we must have an __except block.
Reid Klecknerebaf28d2015-04-14 20:59:00 +00001801 const SEHExceptStmt *Except = S.getExceptHandler();
Reid Kleckner1d59f992015-01-22 01:36:17 +00001802 assert(Except);
1803 EHCatchScope *CatchScope = EHStack.pushCatch(1);
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001804 SEHCodeSlotStack.push_back(
1805 CreateMemTemp(getContext().IntTy, "__exception_code"));
Reid Kleckner2a2e1562015-01-22 02:25:56 +00001806
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001807 // If the filter is known to evaluate to 1, then we can use the clause
1808 // "catch i8* null". We can't do this on x86 because the filter has to save
1809 // the exception code.
Reid Kleckner2a2e1562015-01-22 02:25:56 +00001810 llvm::Constant *C =
1811 CGM.EmitConstantExpr(Except->getFilterExpr(), getContext().IntTy, this);
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001812 if (CGM.getTarget().getTriple().getArch() != llvm::Triple::x86 && C &&
1813 C->isOneValue()) {
Reid Kleckner2a2e1562015-01-22 02:25:56 +00001814 CatchScope->setCatchAllHandler(0, createBasicBlock("__except"));
1815 return;
1816 }
1817
1818 // In general, we have to emit an outlined filter function. Use the function
1819 // in place of the RTTI typeinfo global that C++ EH uses.
Reid Kleckner1d59f992015-01-22 01:36:17 +00001820 llvm::Function *FilterFunc =
Reid Klecknerebaf28d2015-04-14 20:59:00 +00001821 HelperCGF.GenerateSEHFilterFunction(*this, *Except);
Reid Kleckner1d59f992015-01-22 01:36:17 +00001822 llvm::Constant *OpaqueFunc =
1823 llvm::ConstantExpr::getBitCast(FilterFunc, Int8PtrTy);
Reid Kleckner8be18472015-09-16 21:06:09 +00001824 CatchScope->setHandler(0, OpaqueFunc, createBasicBlock("__except.ret"));
Reid Kleckner1d59f992015-01-22 01:36:17 +00001825}
1826
Reid Klecknerebaf28d2015-04-14 20:59:00 +00001827void CodeGenFunction::ExitSEHTryStmt(const SEHTryStmt &S) {
Reid Kleckner1d59f992015-01-22 01:36:17 +00001828 // Just pop the cleanup if it's a __finally block.
Reid Klecknerebaf28d2015-04-14 20:59:00 +00001829 if (S.getFinallyHandler()) {
Reid Kleckner1d59f992015-01-22 01:36:17 +00001830 PopCleanupBlock();
1831 return;
1832 }
1833
1834 // Otherwise, we must have an __except block.
Reid Kleckneraca01db2015-02-04 22:37:07 +00001835 const SEHExceptStmt *Except = S.getExceptHandler();
Reid Kleckner1d59f992015-01-22 01:36:17 +00001836 assert(Except && "__try must have __finally xor __except");
1837 EHCatchScope &CatchScope = cast<EHCatchScope>(*EHStack.begin());
1838
1839 // Don't emit the __except block if the __try block lacked invokes.
1840 // TODO: Model unwind edges from instructions, either with iload / istore or
1841 // a try body function.
1842 if (!CatchScope.hasEHBranches()) {
1843 CatchScope.clearHandlerBlocks();
1844 EHStack.popCatch();
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001845 SEHCodeSlotStack.pop_back();
Reid Kleckner1d59f992015-01-22 01:36:17 +00001846 return;
1847 }
1848
1849 // The fall-through block.
1850 llvm::BasicBlock *ContBB = createBasicBlock("__try.cont");
1851
1852 // We just emitted the body of the __try; jump to the continue block.
1853 if (HaveInsertPoint())
1854 Builder.CreateBr(ContBB);
1855
1856 // Check if our filter function returned true.
1857 emitCatchDispatchBlock(*this, CatchScope);
1858
1859 // Grab the block before we pop the handler.
1860 llvm::BasicBlock *ExceptBB = CatchScope.getHandler(0).Block;
1861 EHStack.popCatch();
1862
1863 EmitBlockAfterUses(ExceptBB);
1864
Reid Kleckner129552b2015-10-08 01:13:52 +00001865 // __except blocks don't get outlined into funclets, so immediately do a
1866 // catchret.
1867 llvm::BasicBlock *CatchPadBB = ExceptBB->getSinglePredecessor();
1868 assert(CatchPadBB && "only ExceptBB pred should be catchpad");
1869 llvm::CatchPadInst *CPI =
1870 cast<llvm::CatchPadInst>(CatchPadBB->getFirstNonPHI());
1871 ExceptBB = createBasicBlock("__except");
1872 Builder.CreateCatchRet(CPI, ExceptBB);
1873 EmitBlock(ExceptBB);
1874
1875 // On Win64, the exception code is returned in EAX. Copy it into the slot.
1876 if (CGM.getTarget().getTriple().getArch() != llvm::Triple::x86) {
1877 llvm::Function *SEHCodeIntrin =
1878 CGM.getIntrinsic(llvm::Intrinsic::eh_exceptioncode);
1879 llvm::Value *Code = Builder.CreateCall(SEHCodeIntrin, {CPI});
1880 Builder.CreateStore(Code, SEHCodeSlotStack.back());
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001881 }
1882
Reid Kleckner1d59f992015-01-22 01:36:17 +00001883 // Emit the __except body.
1884 EmitStmt(Except->getBlock());
1885
Reid Kleckner9fe7f232015-07-07 00:36:30 +00001886 // End the lifetime of the exception code.
1887 SEHCodeSlotStack.pop_back();
1888
Reid Kleckner3a417c32015-01-30 22:16:45 +00001889 if (HaveInsertPoint())
1890 Builder.CreateBr(ContBB);
Reid Kleckner1d59f992015-01-22 01:36:17 +00001891
1892 EmitBlock(ContBB);
Reid Kleckner543a16c2013-09-16 21:46:30 +00001893}
Nico Weber9b982072014-07-07 00:12:30 +00001894
1895void CodeGenFunction::EmitSEHLeaveStmt(const SEHLeaveStmt &S) {
Nico Weber5779f842015-02-12 23:16:11 +00001896 // If this code is reachable then emit a stop point (if generating
1897 // debug info). We have to do this ourselves because we are on the
1898 // "simple" statement path.
1899 if (HaveInsertPoint())
1900 EmitStopPoint(&S);
1901
Reid Klecknerebaf28d2015-04-14 20:59:00 +00001902 // This must be a __leave from a __finally block, which we warn on and is UB.
1903 // Just emit unreachable.
1904 if (!isSEHTryScope()) {
1905 Builder.CreateUnreachable();
1906 Builder.ClearInsertionPoint();
1907 return;
1908 }
1909
Nico Weber5779f842015-02-12 23:16:11 +00001910 EmitBranchThroughCleanup(*SEHTryEpilogueStack.back());
Nico Weber9b982072014-07-07 00:12:30 +00001911}