blob: b7953bcedc91a52b5f6a2c8931f8b866b61b4a18 [file] [log] [blame]
Anders Carlsson4b08db72009-10-30 01:42:31 +00001//===--- CGException.cpp - Emit LLVM Code for C++ exceptions --------------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This contains code dealing with C++ exception related code generation.
11//
12//===----------------------------------------------------------------------===//
13
14#include "CodeGenFunction.h"
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"
Chandler Carruthc80ceea2014-03-04 11:02:08 +000022#include "llvm/IR/CallSite.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000023#include "llvm/IR/Intrinsics.h"
John McCallbd309292010-07-06 01:34:17 +000024
Anders Carlsson4b08db72009-10-30 01:42:31 +000025using namespace clang;
26using namespace CodeGen;
27
John McCall2c33ba82013-02-12 03:51:38 +000028static llvm::Constant *getAllocateExceptionFn(CodeGenModule &CGM) {
Anders Carlsson32e1b1c2009-10-30 02:27:02 +000029 // void *__cxa_allocate_exception(size_t thrown_size);
Mike Stump75546b82009-12-10 00:06:18 +000030
Chris Lattner2192fe52011-07-18 04:24:23 +000031 llvm::FunctionType *FTy =
John McCall2c33ba82013-02-12 03:51:38 +000032 llvm::FunctionType::get(CGM.Int8PtrTy, CGM.SizeTy, /*IsVarArgs=*/false);
Mike Stump75546b82009-12-10 00:06:18 +000033
John McCall2c33ba82013-02-12 03:51:38 +000034 return CGM.CreateRuntimeFunction(FTy, "__cxa_allocate_exception");
Anders Carlsson32e1b1c2009-10-30 02:27:02 +000035}
36
John McCall2c33ba82013-02-12 03:51:38 +000037static llvm::Constant *getFreeExceptionFn(CodeGenModule &CGM) {
Mike Stump33270212009-12-02 07:41:41 +000038 // void __cxa_free_exception(void *thrown_exception);
Mike Stump75546b82009-12-10 00:06:18 +000039
Chris Lattner2192fe52011-07-18 04:24:23 +000040 llvm::FunctionType *FTy =
John McCall2c33ba82013-02-12 03:51:38 +000041 llvm::FunctionType::get(CGM.VoidTy, CGM.Int8PtrTy, /*IsVarArgs=*/false);
Mike Stump75546b82009-12-10 00:06:18 +000042
John McCall2c33ba82013-02-12 03:51:38 +000043 return CGM.CreateRuntimeFunction(FTy, "__cxa_free_exception");
Mike Stump33270212009-12-02 07:41:41 +000044}
45
John McCall2c33ba82013-02-12 03:51:38 +000046static llvm::Constant *getThrowFn(CodeGenModule &CGM) {
Mike Stump75546b82009-12-10 00:06:18 +000047 // void __cxa_throw(void *thrown_exception, std::type_info *tinfo,
Mike Stump33270212009-12-02 07:41:41 +000048 // void (*dest) (void *));
Anders Carlsson32e1b1c2009-10-30 02:27:02 +000049
John McCall2c33ba82013-02-12 03:51:38 +000050 llvm::Type *Args[3] = { CGM.Int8PtrTy, CGM.Int8PtrTy, CGM.Int8PtrTy };
Chris Lattner2192fe52011-07-18 04:24:23 +000051 llvm::FunctionType *FTy =
John McCall2c33ba82013-02-12 03:51:38 +000052 llvm::FunctionType::get(CGM.VoidTy, Args, /*IsVarArgs=*/false);
Mike Stump75546b82009-12-10 00:06:18 +000053
John McCall2c33ba82013-02-12 03:51:38 +000054 return CGM.CreateRuntimeFunction(FTy, "__cxa_throw");
Anders Carlsson32e1b1c2009-10-30 02:27:02 +000055}
56
John McCall2c33ba82013-02-12 03:51:38 +000057static llvm::Constant *getGetExceptionPtrFn(CodeGenModule &CGM) {
John McCallbd309292010-07-06 01:34:17 +000058 // void *__cxa_get_exception_ptr(void*);
John McCallbd309292010-07-06 01:34:17 +000059
Chris Lattner2192fe52011-07-18 04:24:23 +000060 llvm::FunctionType *FTy =
John McCall2c33ba82013-02-12 03:51:38 +000061 llvm::FunctionType::get(CGM.Int8PtrTy, CGM.Int8PtrTy, /*IsVarArgs=*/false);
John McCallbd309292010-07-06 01:34:17 +000062
John McCall2c33ba82013-02-12 03:51:38 +000063 return CGM.CreateRuntimeFunction(FTy, "__cxa_get_exception_ptr");
John McCallbd309292010-07-06 01:34:17 +000064}
65
John McCall2c33ba82013-02-12 03:51:38 +000066static llvm::Constant *getBeginCatchFn(CodeGenModule &CGM) {
John McCallbd309292010-07-06 01:34:17 +000067 // void *__cxa_begin_catch(void*);
Mike Stump58ef18b2009-11-20 23:44:51 +000068
Chris Lattner2192fe52011-07-18 04:24:23 +000069 llvm::FunctionType *FTy =
John McCall2c33ba82013-02-12 03:51:38 +000070 llvm::FunctionType::get(CGM.Int8PtrTy, CGM.Int8PtrTy, /*IsVarArgs=*/false);
Mike Stump75546b82009-12-10 00:06:18 +000071
John McCall2c33ba82013-02-12 03:51:38 +000072 return CGM.CreateRuntimeFunction(FTy, "__cxa_begin_catch");
Mike Stump58ef18b2009-11-20 23:44:51 +000073}
74
John McCall2c33ba82013-02-12 03:51:38 +000075static llvm::Constant *getEndCatchFn(CodeGenModule &CGM) {
Mike Stump33270212009-12-02 07:41:41 +000076 // void __cxa_end_catch();
Mike Stump58ef18b2009-11-20 23:44:51 +000077
Chris Lattner2192fe52011-07-18 04:24:23 +000078 llvm::FunctionType *FTy =
John McCall2c33ba82013-02-12 03:51:38 +000079 llvm::FunctionType::get(CGM.VoidTy, /*IsVarArgs=*/false);
Mike Stump75546b82009-12-10 00:06:18 +000080
John McCall2c33ba82013-02-12 03:51:38 +000081 return CGM.CreateRuntimeFunction(FTy, "__cxa_end_catch");
Mike Stump58ef18b2009-11-20 23:44:51 +000082}
83
John McCall2c33ba82013-02-12 03:51:38 +000084static llvm::Constant *getUnexpectedFn(CodeGenModule &CGM) {
Richard Smith2f7aa192013-06-20 23:03:35 +000085 // void __cxa_call_unexpected(void *thrown_exception);
Mike Stump1d849212009-12-07 23:38:24 +000086
Chris Lattner2192fe52011-07-18 04:24:23 +000087 llvm::FunctionType *FTy =
John McCall2c33ba82013-02-12 03:51:38 +000088 llvm::FunctionType::get(CGM.VoidTy, CGM.Int8PtrTy, /*IsVarArgs=*/false);
Mike Stump75546b82009-12-10 00:06:18 +000089
John McCall2c33ba82013-02-12 03:51:38 +000090 return CGM.CreateRuntimeFunction(FTy, "__cxa_call_unexpected");
Mike Stump1d849212009-12-07 23:38:24 +000091}
92
John McCall2c33ba82013-02-12 03:51:38 +000093static llvm::Constant *getTerminateFn(CodeGenModule &CGM) {
Mike Stump33270212009-12-02 07:41:41 +000094 // void __terminate();
95
Chris Lattner2192fe52011-07-18 04:24:23 +000096 llvm::FunctionType *FTy =
John McCall2c33ba82013-02-12 03:51:38 +000097 llvm::FunctionType::get(CGM.VoidTy, /*IsVarArgs=*/false);
Mike Stump75546b82009-12-10 00:06:18 +000098
Chris Lattner0e62c1c2011-07-23 10:55:15 +000099 StringRef name;
John McCall9de19782011-07-06 01:22:26 +0000100
101 // In C++, use std::terminate().
Reid Kleckner1d59f992015-01-22 01:36:17 +0000102 if (CGM.getLangOpts().CPlusPlus &&
103 CGM.getTarget().getCXXABI().isItaniumFamily()) {
104 name = "_ZSt9terminatev";
105 } else if (CGM.getLangOpts().ObjC1 &&
John McCall2c33ba82013-02-12 03:51:38 +0000106 CGM.getLangOpts().ObjCRuntime.hasTerminate())
John McCall9de19782011-07-06 01:22:26 +0000107 name = "objc_terminate";
108 else
109 name = "abort";
John McCall2c33ba82013-02-12 03:51:38 +0000110 return CGM.CreateRuntimeFunction(FTy, name);
David Chisnallf9c42252010-05-17 13:49:20 +0000111}
112
John McCall2c33ba82013-02-12 03:51:38 +0000113static llvm::Constant *getCatchallRethrowFn(CodeGenModule &CGM,
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000114 StringRef Name) {
Chris Lattner2192fe52011-07-18 04:24:23 +0000115 llvm::FunctionType *FTy =
John McCall2c33ba82013-02-12 03:51:38 +0000116 llvm::FunctionType::get(CGM.VoidTy, CGM.Int8PtrTy, /*IsVarArgs=*/false);
John McCall36ea3722010-07-17 00:43:08 +0000117
John McCall2c33ba82013-02-12 03:51:38 +0000118 return CGM.CreateRuntimeFunction(FTy, Name);
John McCallbd309292010-07-06 01:34:17 +0000119}
120
Benjamin Kramer793bd552012-02-08 12:41:24 +0000121namespace {
122 /// The exceptions personality for a function.
123 struct EHPersonality {
124 const char *PersonalityFn;
125
126 // If this is non-null, this personality requires a non-standard
127 // function for rethrowing an exception after a catchall cleanup.
128 // This function must have prototype void(void*).
129 const char *CatchallRethrowFn;
130
Reid Klecknerdeeddec2015-02-05 18:56:03 +0000131 static const EHPersonality &get(CodeGenModule &CGM,
132 const FunctionDecl *FD);
133 static const EHPersonality &get(CodeGenFunction &CGF) {
134 return get(CGF.CGM, dyn_cast_or_null<FunctionDecl>(CGF.CurCodeDecl));
135 }
136
Benjamin Kramer793bd552012-02-08 12:41:24 +0000137 static const EHPersonality GNU_C;
138 static const EHPersonality GNU_C_SJLJ;
Reid Kleckner8f45c9c2014-09-15 17:19:16 +0000139 static const EHPersonality GNU_C_SEH;
Benjamin Kramer793bd552012-02-08 12:41:24 +0000140 static const EHPersonality GNU_ObjC;
David Chisnall2ec1b10d2013-01-11 15:33:01 +0000141 static const EHPersonality GNUstep_ObjC;
Benjamin Kramer793bd552012-02-08 12:41:24 +0000142 static const EHPersonality GNU_ObjCXX;
143 static const EHPersonality NeXT_ObjC;
144 static const EHPersonality GNU_CPlusPlus;
145 static const EHPersonality GNU_CPlusPlus_SJLJ;
Reid Kleckner8f45c9c2014-09-15 17:19:16 +0000146 static const EHPersonality GNU_CPlusPlus_SEH;
Reid Kleckner1d59f992015-01-22 01:36:17 +0000147 static const EHPersonality MSVC_except_handler;
148 static const EHPersonality MSVC_C_specific_handler;
Reid Klecknerdeeddec2015-02-05 18:56:03 +0000149 static const EHPersonality MSVC_CxxFrameHandler3;
Benjamin Kramer793bd552012-02-08 12:41:24 +0000150 };
151}
152
Craig Topper8a13c412014-05-21 05:09:00 +0000153const EHPersonality EHPersonality::GNU_C = { "__gcc_personality_v0", nullptr };
Benjamin Kramer793bd552012-02-08 12:41:24 +0000154const EHPersonality
Craig Topper8a13c412014-05-21 05:09:00 +0000155EHPersonality::GNU_C_SJLJ = { "__gcc_personality_sj0", nullptr };
156const EHPersonality
Reid Kleckner8f45c9c2014-09-15 17:19:16 +0000157EHPersonality::GNU_C_SEH = { "__gcc_personality_seh0", nullptr };
158const EHPersonality
Craig Topper8a13c412014-05-21 05:09:00 +0000159EHPersonality::NeXT_ObjC = { "__objc_personality_v0", nullptr };
160const EHPersonality
161EHPersonality::GNU_CPlusPlus = { "__gxx_personality_v0", nullptr };
162const EHPersonality
163EHPersonality::GNU_CPlusPlus_SJLJ = { "__gxx_personality_sj0", nullptr };
Benjamin Kramer793bd552012-02-08 12:41:24 +0000164const EHPersonality
Reid Kleckner8f45c9c2014-09-15 17:19:16 +0000165EHPersonality::GNU_CPlusPlus_SEH = { "__gxx_personality_seh0", nullptr };
166const EHPersonality
Benjamin Kramer793bd552012-02-08 12:41:24 +0000167EHPersonality::GNU_ObjC = {"__gnu_objc_personality_v0", "objc_exception_throw"};
168const EHPersonality
Craig Topper8a13c412014-05-21 05:09:00 +0000169EHPersonality::GNU_ObjCXX = { "__gnustep_objcxx_personality_v0", nullptr };
David Chisnall2ec1b10d2013-01-11 15:33:01 +0000170const EHPersonality
Craig Topper8a13c412014-05-21 05:09:00 +0000171EHPersonality::GNUstep_ObjC = { "__gnustep_objc_personality_v0", nullptr };
Reid Kleckner1d59f992015-01-22 01:36:17 +0000172const EHPersonality
173EHPersonality::MSVC_except_handler = { "_except_handler3", nullptr };
174const EHPersonality
175EHPersonality::MSVC_C_specific_handler = { "__C_specific_handler", nullptr };
Reid Klecknerdeeddec2015-02-05 18:56:03 +0000176const EHPersonality
177EHPersonality::MSVC_CxxFrameHandler3 = { "__CxxFrameHandler3", nullptr };
John McCall36ea3722010-07-17 00:43:08 +0000178
Reid Klecknere070b992014-11-14 02:01:10 +0000179/// On Win64, use libgcc's SEH personality function. We fall back to dwarf on
180/// other platforms, unless the user asked for SjLj exceptions.
181static bool useLibGCCSEHPersonality(const llvm::Triple &T) {
182 return T.isOSWindows() && T.getArch() == llvm::Triple::x86_64;
183}
184
185static const EHPersonality &getCPersonality(const llvm::Triple &T,
186 const LangOptions &L) {
John McCall2faab302010-11-07 02:35:25 +0000187 if (L.SjLjExceptions)
188 return EHPersonality::GNU_C_SJLJ;
Reid Klecknere070b992014-11-14 02:01:10 +0000189 else if (useLibGCCSEHPersonality(T))
Reid Kleckner8f45c9c2014-09-15 17:19:16 +0000190 return EHPersonality::GNU_C_SEH;
John McCall36ea3722010-07-17 00:43:08 +0000191 return EHPersonality::GNU_C;
192}
193
Reid Klecknere070b992014-11-14 02:01:10 +0000194static const EHPersonality &getObjCPersonality(const llvm::Triple &T,
195 const LangOptions &L) {
John McCall5fb5df92012-06-20 06:18:46 +0000196 switch (L.ObjCRuntime.getKind()) {
197 case ObjCRuntime::FragileMacOSX:
Reid Klecknere070b992014-11-14 02:01:10 +0000198 return getCPersonality(T, L);
John McCall5fb5df92012-06-20 06:18:46 +0000199 case ObjCRuntime::MacOSX:
200 case ObjCRuntime::iOS:
201 return EHPersonality::NeXT_ObjC;
David Chisnallb601c962012-07-03 20:49:52 +0000202 case ObjCRuntime::GNUstep:
David Chisnall2ec1b10d2013-01-11 15:33:01 +0000203 if (L.ObjCRuntime.getVersion() >= VersionTuple(1, 7))
204 return EHPersonality::GNUstep_ObjC;
205 // fallthrough
David Chisnallb601c962012-07-03 20:49:52 +0000206 case ObjCRuntime::GCC:
John McCall775086e2012-07-12 02:07:58 +0000207 case ObjCRuntime::ObjFW:
John McCall36ea3722010-07-17 00:43:08 +0000208 return EHPersonality::GNU_ObjC;
John McCallbd309292010-07-06 01:34:17 +0000209 }
John McCall5fb5df92012-06-20 06:18:46 +0000210 llvm_unreachable("bad runtime kind");
John McCallbd309292010-07-06 01:34:17 +0000211}
212
Reid Klecknere070b992014-11-14 02:01:10 +0000213static const EHPersonality &getCXXPersonality(const llvm::Triple &T,
214 const LangOptions &L) {
John McCall36ea3722010-07-17 00:43:08 +0000215 if (L.SjLjExceptions)
216 return EHPersonality::GNU_CPlusPlus_SJLJ;
Reid Klecknere070b992014-11-14 02:01:10 +0000217 else if (useLibGCCSEHPersonality(T))
Reid Kleckner8f45c9c2014-09-15 17:19:16 +0000218 return EHPersonality::GNU_CPlusPlus_SEH;
Reid Klecknere070b992014-11-14 02:01:10 +0000219 return EHPersonality::GNU_CPlusPlus;
John McCallbd309292010-07-06 01:34:17 +0000220}
221
222/// Determines the personality function to use when both C++
223/// and Objective-C exceptions are being caught.
Reid Klecknere070b992014-11-14 02:01:10 +0000224static const EHPersonality &getObjCXXPersonality(const llvm::Triple &T,
225 const LangOptions &L) {
John McCall5fb5df92012-06-20 06:18:46 +0000226 switch (L.ObjCRuntime.getKind()) {
John McCallbd309292010-07-06 01:34:17 +0000227 // The ObjC personality defers to the C++ personality for non-ObjC
228 // handlers. Unlike the C++ case, we use the same personality
229 // function on targets using (backend-driven) SJLJ EH.
John McCall5fb5df92012-06-20 06:18:46 +0000230 case ObjCRuntime::MacOSX:
231 case ObjCRuntime::iOS:
232 return EHPersonality::NeXT_ObjC;
John McCallbd309292010-07-06 01:34:17 +0000233
John McCall5fb5df92012-06-20 06:18:46 +0000234 // In the fragile ABI, just use C++ exception handling and hope
235 // they're not doing crazy exception mixing.
236 case ObjCRuntime::FragileMacOSX:
Reid Klecknere070b992014-11-14 02:01:10 +0000237 return getCXXPersonality(T, L);
David Chisnallf9c42252010-05-17 13:49:20 +0000238
David Chisnallb601c962012-07-03 20:49:52 +0000239 // The GCC runtime's personality function inherently doesn't support
John McCall36ea3722010-07-17 00:43:08 +0000240 // mixed EH. Use the C++ personality just to avoid returning null.
David Chisnallb601c962012-07-03 20:49:52 +0000241 case ObjCRuntime::GCC:
John McCall775086e2012-07-12 02:07:58 +0000242 case ObjCRuntime::ObjFW: // XXX: this will change soon
David Chisnallb601c962012-07-03 20:49:52 +0000243 return EHPersonality::GNU_ObjC;
244 case ObjCRuntime::GNUstep:
John McCall5fb5df92012-06-20 06:18:46 +0000245 return EHPersonality::GNU_ObjCXX;
246 }
247 llvm_unreachable("bad runtime kind");
John McCallbd309292010-07-06 01:34:17 +0000248}
249
Reid Klecknerdeeddec2015-02-05 18:56:03 +0000250static const EHPersonality &getSEHPersonalityMSVC(const llvm::Triple &T) {
Reid Kleckner1d59f992015-01-22 01:36:17 +0000251 if (T.getArch() == llvm::Triple::x86)
252 return EHPersonality::MSVC_except_handler;
253 return EHPersonality::MSVC_C_specific_handler;
254}
255
Reid Klecknerdeeddec2015-02-05 18:56:03 +0000256const EHPersonality &EHPersonality::get(CodeGenModule &CGM,
257 const FunctionDecl *FD) {
Reid Klecknere070b992014-11-14 02:01:10 +0000258 const llvm::Triple &T = CGM.getTarget().getTriple();
259 const LangOptions &L = CGM.getLangOpts();
Reid Klecknerdeeddec2015-02-05 18:56:03 +0000260
Reid Kleckner1d59f992015-01-22 01:36:17 +0000261 // Try to pick a personality function that is compatible with MSVC if we're
262 // not compiling Obj-C. Obj-C users better have an Obj-C runtime that supports
263 // the GCC-style personality function.
264 if (T.isWindowsMSVCEnvironment() && !L.ObjC1) {
Reid Klecknerdeeddec2015-02-05 18:56:03 +0000265 if (L.SjLjExceptions)
266 return EHPersonality::GNU_CPlusPlus_SJLJ;
267 else if (FD && FD->usesSEHTry())
268 return getSEHPersonalityMSVC(T);
Reid Kleckner1d59f992015-01-22 01:36:17 +0000269 else
Reid Klecknerdeeddec2015-02-05 18:56:03 +0000270 return EHPersonality::MSVC_CxxFrameHandler3;
Reid Kleckner1d59f992015-01-22 01:36:17 +0000271 }
272
John McCall36ea3722010-07-17 00:43:08 +0000273 if (L.CPlusPlus && L.ObjC1)
Reid Klecknere070b992014-11-14 02:01:10 +0000274 return getObjCXXPersonality(T, L);
John McCall36ea3722010-07-17 00:43:08 +0000275 else if (L.CPlusPlus)
Reid Klecknere070b992014-11-14 02:01:10 +0000276 return getCXXPersonality(T, L);
John McCall36ea3722010-07-17 00:43:08 +0000277 else if (L.ObjC1)
Reid Klecknere070b992014-11-14 02:01:10 +0000278 return getObjCPersonality(T, L);
John McCallbd309292010-07-06 01:34:17 +0000279 else
Reid Klecknere070b992014-11-14 02:01:10 +0000280 return getCPersonality(T, L);
John McCall36ea3722010-07-17 00:43:08 +0000281}
John McCallbd309292010-07-06 01:34:17 +0000282
John McCall0bdb1fd2010-09-16 06:16:50 +0000283static llvm::Constant *getPersonalityFn(CodeGenModule &CGM,
John McCall36ea3722010-07-17 00:43:08 +0000284 const EHPersonality &Personality) {
John McCall36ea3722010-07-17 00:43:08 +0000285 llvm::Constant *Fn =
Chris Lattnerece04092012-02-07 00:39:47 +0000286 CGM.CreateRuntimeFunction(llvm::FunctionType::get(CGM.Int32Ty, true),
Benjamin Kramer793bd552012-02-08 12:41:24 +0000287 Personality.PersonalityFn);
John McCall0bdb1fd2010-09-16 06:16:50 +0000288 return Fn;
289}
290
291static llvm::Constant *getOpaquePersonalityFn(CodeGenModule &CGM,
292 const EHPersonality &Personality) {
293 llvm::Constant *Fn = getPersonalityFn(CGM, Personality);
John McCallad7c5c12011-02-08 08:22:06 +0000294 return llvm::ConstantExpr::getBitCast(Fn, CGM.Int8PtrTy);
John McCall0bdb1fd2010-09-16 06:16:50 +0000295}
296
297/// Check whether a personality function could reasonably be swapped
298/// for a C++ personality function.
299static bool PersonalityHasOnlyCXXUses(llvm::Constant *Fn) {
Chandler Carruth4d01fff2014-03-09 03:16:50 +0000300 for (llvm::User *U : Fn->users()) {
John McCall0bdb1fd2010-09-16 06:16:50 +0000301 // Conditionally white-list bitcasts.
Chandler Carruth4d01fff2014-03-09 03:16:50 +0000302 if (llvm::ConstantExpr *CE = dyn_cast<llvm::ConstantExpr>(U)) {
John McCall0bdb1fd2010-09-16 06:16:50 +0000303 if (CE->getOpcode() != llvm::Instruction::BitCast) return false;
304 if (!PersonalityHasOnlyCXXUses(CE))
305 return false;
306 continue;
307 }
308
Bill Wendling58e58fe2011-09-19 22:08:36 +0000309 // Otherwise, it has to be a landingpad instruction.
Chandler Carruth4d01fff2014-03-09 03:16:50 +0000310 llvm::LandingPadInst *LPI = dyn_cast<llvm::LandingPadInst>(U);
Bill Wendling58e58fe2011-09-19 22:08:36 +0000311 if (!LPI) return false;
John McCall0bdb1fd2010-09-16 06:16:50 +0000312
Bill Wendling58e58fe2011-09-19 22:08:36 +0000313 for (unsigned I = 0, E = LPI->getNumClauses(); I != E; ++I) {
John McCall0bdb1fd2010-09-16 06:16:50 +0000314 // Look for something that would've been returned by the ObjC
315 // runtime's GetEHType() method.
Bill Wendling58e58fe2011-09-19 22:08:36 +0000316 llvm::Value *Val = LPI->getClause(I)->stripPointerCasts();
317 if (LPI->isCatch(I)) {
318 // Check if the catch value has the ObjC prefix.
Bill Wendling5d7469e2011-09-20 00:40:19 +0000319 if (llvm::GlobalVariable *GV = dyn_cast<llvm::GlobalVariable>(Val))
320 // ObjC EH selector entries are always global variables with
321 // names starting like this.
322 if (GV->getName().startswith("OBJC_EHTYPE"))
323 return false;
Bill Wendling58e58fe2011-09-19 22:08:36 +0000324 } else {
325 // Check if any of the filter values have the ObjC prefix.
326 llvm::Constant *CVal = cast<llvm::Constant>(Val);
327 for (llvm::User::op_iterator
328 II = CVal->op_begin(), IE = CVal->op_end(); II != IE; ++II) {
Bill Wendling5d7469e2011-09-20 00:40:19 +0000329 if (llvm::GlobalVariable *GV =
330 cast<llvm::GlobalVariable>((*II)->stripPointerCasts()))
331 // ObjC EH selector entries are always global variables with
332 // names starting like this.
333 if (GV->getName().startswith("OBJC_EHTYPE"))
334 return false;
Bill Wendling58e58fe2011-09-19 22:08:36 +0000335 }
336 }
John McCall0bdb1fd2010-09-16 06:16:50 +0000337 }
338 }
339
340 return true;
341}
342
343/// Try to use the C++ personality function in ObjC++. Not doing this
344/// can cause some incompatibilities with gcc, which is more
345/// aggressive about only using the ObjC++ personality in a function
346/// when it really needs it.
347void CodeGenModule::SimplifyPersonality() {
John McCall0bdb1fd2010-09-16 06:16:50 +0000348 // If we're not in ObjC++ -fexceptions, there's nothing to do.
David Blaikiebbafb8a2012-03-11 07:00:24 +0000349 if (!LangOpts.CPlusPlus || !LangOpts.ObjC1 || !LangOpts.Exceptions)
John McCall0bdb1fd2010-09-16 06:16:50 +0000350 return;
351
John McCall3c223932012-11-14 17:48:31 +0000352 // Both the problem this endeavors to fix and the way the logic
353 // above works is specific to the NeXT runtime.
354 if (!LangOpts.ObjCRuntime.isNeXTFamily())
355 return;
356
Reid Klecknerdeeddec2015-02-05 18:56:03 +0000357 const EHPersonality &ObjCXX = EHPersonality::get(*this, /*FD=*/nullptr);
Reid Klecknere070b992014-11-14 02:01:10 +0000358 const EHPersonality &CXX =
359 getCXXPersonality(getTarget().getTriple(), LangOpts);
Benjamin Kramer793bd552012-02-08 12:41:24 +0000360 if (&ObjCXX == &CXX)
John McCall0bdb1fd2010-09-16 06:16:50 +0000361 return;
362
Benjamin Kramer793bd552012-02-08 12:41:24 +0000363 assert(std::strcmp(ObjCXX.PersonalityFn, CXX.PersonalityFn) != 0 &&
364 "Different EHPersonalities using the same personality function.");
365
366 llvm::Function *Fn = getModule().getFunction(ObjCXX.PersonalityFn);
John McCall0bdb1fd2010-09-16 06:16:50 +0000367
368 // Nothing to do if it's unused.
369 if (!Fn || Fn->use_empty()) return;
370
371 // Can't do the optimization if it has non-C++ uses.
372 if (!PersonalityHasOnlyCXXUses(Fn)) return;
373
374 // Create the C++ personality function and kill off the old
375 // function.
376 llvm::Constant *CXXFn = getPersonalityFn(*this, CXX);
377
378 // This can happen if the user is screwing with us.
379 if (Fn->getType() != CXXFn->getType()) return;
380
381 Fn->replaceAllUsesWith(CXXFn);
382 Fn->eraseFromParent();
John McCallbd309292010-07-06 01:34:17 +0000383}
384
385/// Returns the value to inject into a selector to indicate the
386/// presence of a catch-all.
387static llvm::Constant *getCatchAllValue(CodeGenFunction &CGF) {
388 // Possibly we should use @llvm.eh.catch.all.value here.
John McCallad7c5c12011-02-08 08:22:06 +0000389 return llvm::ConstantPointerNull::get(CGF.Int8PtrTy);
John McCallbd309292010-07-06 01:34:17 +0000390}
391
John McCallbb026012010-07-13 21:17:51 +0000392namespace {
393 /// A cleanup to free the exception object if its initialization
394 /// throws.
John McCall5fcf8da2011-07-12 00:15:30 +0000395 struct FreeException : EHScopeStack::Cleanup {
396 llvm::Value *exn;
397 FreeException(llvm::Value *exn) : exn(exn) {}
Craig Topper4f12f102014-03-12 06:41:41 +0000398 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall882987f2013-02-28 19:01:20 +0000399 CGF.EmitNounwindRuntimeCall(getFreeExceptionFn(CGF.CGM), exn);
John McCallbb026012010-07-13 21:17:51 +0000400 }
401 };
402}
403
John McCall2e6567a2010-04-22 01:10:34 +0000404// Emits an exception expression into the given location. This
405// differs from EmitAnyExprToMem only in that, if a final copy-ctor
406// call is required, an exception within that copy ctor causes
407// std::terminate to be invoked.
John McCalle4df6c82011-01-28 08:37:24 +0000408static void EmitAnyExprToExn(CodeGenFunction &CGF, const Expr *e,
409 llvm::Value *addr) {
John McCallbd309292010-07-06 01:34:17 +0000410 // Make sure the exception object is cleaned up if there's an
411 // exception during initialization.
John McCalle4df6c82011-01-28 08:37:24 +0000412 CGF.pushFullExprCleanup<FreeException>(EHCleanup, addr);
413 EHScopeStack::stable_iterator cleanup = CGF.EHStack.stable_begin();
John McCall2e6567a2010-04-22 01:10:34 +0000414
415 // __cxa_allocate_exception returns a void*; we need to cast this
416 // to the appropriate type for the object.
Chris Lattner2192fe52011-07-18 04:24:23 +0000417 llvm::Type *ty = CGF.ConvertTypeForMem(e->getType())->getPointerTo();
John McCalle4df6c82011-01-28 08:37:24 +0000418 llvm::Value *typedAddr = CGF.Builder.CreateBitCast(addr, ty);
John McCall2e6567a2010-04-22 01:10:34 +0000419
420 // FIXME: this isn't quite right! If there's a final unelided call
421 // to a copy constructor, then according to [except.terminate]p1 we
422 // must call std::terminate() if that constructor throws, because
423 // technically that copy occurs after the exception expression is
424 // evaluated but before the exception is caught. But the best way
425 // to handle that is to teach EmitAggExpr to do the final copy
426 // differently if it can't be elided.
Chad Rosier615ed1a2012-03-29 17:37:10 +0000427 CGF.EmitAnyExprToMem(e, typedAddr, e->getType().getQualifiers(),
428 /*IsInit*/ true);
John McCall2e6567a2010-04-22 01:10:34 +0000429
John McCalle4df6c82011-01-28 08:37:24 +0000430 // Deactivate the cleanup block.
John McCallf4beacd2011-11-10 10:43:54 +0000431 CGF.DeactivateCleanupBlock(cleanup, cast<llvm::Instruction>(typedAddr));
Mike Stump54066142009-12-01 03:41:18 +0000432}
433
John McCallbd309292010-07-06 01:34:17 +0000434llvm::Value *CodeGenFunction::getExceptionSlot() {
John McCall9b382dd2011-05-28 21:13:02 +0000435 if (!ExceptionSlot)
436 ExceptionSlot = CreateTempAlloca(Int8PtrTy, "exn.slot");
John McCallbd309292010-07-06 01:34:17 +0000437 return ExceptionSlot;
Mike Stump54066142009-12-01 03:41:18 +0000438}
439
John McCall9b382dd2011-05-28 21:13:02 +0000440llvm::Value *CodeGenFunction::getEHSelectorSlot() {
441 if (!EHSelectorSlot)
442 EHSelectorSlot = CreateTempAlloca(Int32Ty, "ehselector.slot");
443 return EHSelectorSlot;
444}
445
Bill Wendling79a70e42011-09-15 18:57:19 +0000446llvm::Value *CodeGenFunction::getExceptionFromSlot() {
447 return Builder.CreateLoad(getExceptionSlot(), "exn");
448}
449
450llvm::Value *CodeGenFunction::getSelectorFromSlot() {
451 return Builder.CreateLoad(getEHSelectorSlot(), "sel");
452}
453
Reid Kleckneraca01db2015-02-04 22:37:07 +0000454llvm::Value *CodeGenFunction::getAbnormalTerminationSlot() {
455 if (!AbnormalTerminationSlot)
Nico Weber1bebad12015-02-11 22:33:32 +0000456 AbnormalTerminationSlot =
457 CreateTempAlloca(Int8Ty, "abnormal.termination.slot");
Reid Kleckneraca01db2015-02-04 22:37:07 +0000458 return AbnormalTerminationSlot;
459}
460
Richard Smithea852322013-05-07 21:53:22 +0000461void CodeGenFunction::EmitCXXThrowExpr(const CXXThrowExpr *E,
462 bool KeepInsertionPoint) {
Anders Carlsson32e1b1c2009-10-30 02:27:02 +0000463 if (!E->getSubExpr()) {
David Majnemer442d0a22014-11-25 07:20:20 +0000464 CGM.getCXXABI().emitRethrow(*this, /*isNoReturn*/true);
Douglas Gregorc278d1b2010-05-16 00:44:00 +0000465
John McCall20f6ab82011-01-12 03:41:02 +0000466 // throw is an expression, and the expression emitters expect us
467 // to leave ourselves at a valid insertion point.
Richard Smithea852322013-05-07 21:53:22 +0000468 if (KeepInsertionPoint)
469 EmitBlock(createBasicBlock("throw.cont"));
John McCall20f6ab82011-01-12 03:41:02 +0000470
Anders Carlsson32e1b1c2009-10-30 02:27:02 +0000471 return;
472 }
Mike Stump75546b82009-12-10 00:06:18 +0000473
David Majnemer442d0a22014-11-25 07:20:20 +0000474 if (CGM.getTarget().getTriple().isKnownWindowsMSVCEnvironment()) {
475 ErrorUnsupported(E, "throw expression");
476 return;
477 }
478
Anders Carlsson32e1b1c2009-10-30 02:27:02 +0000479 QualType ThrowType = E->getSubExpr()->getType();
Mike Stump75546b82009-12-10 00:06:18 +0000480
Fariborz Jahanian1eab0522013-01-10 19:02:56 +0000481 if (ThrowType->isObjCObjectPointerType()) {
482 const Stmt *ThrowStmt = E->getSubExpr();
483 const ObjCAtThrowStmt S(E->getExprLoc(),
484 const_cast<Stmt *>(ThrowStmt));
485 CGM.getObjCRuntime().EmitThrowStmt(*this, S, false);
486 // This will clear insertion point which was not cleared in
487 // call to EmitThrowStmt.
Richard Smithea852322013-05-07 21:53:22 +0000488 if (KeepInsertionPoint)
489 EmitBlock(createBasicBlock("throw.cont"));
Fariborz Jahanian1eab0522013-01-10 19:02:56 +0000490 return;
491 }
492
Anders Carlsson32e1b1c2009-10-30 02:27:02 +0000493 // Now allocate the exception object.
Chris Lattner2192fe52011-07-18 04:24:23 +0000494 llvm::Type *SizeTy = ConvertType(getContext().getSizeType());
John McCall21886962010-04-21 10:05:39 +0000495 uint64_t TypeSize = getContext().getTypeSizeInChars(ThrowType).getQuantity();
Mike Stump75546b82009-12-10 00:06:18 +0000496
John McCall2c33ba82013-02-12 03:51:38 +0000497 llvm::Constant *AllocExceptionFn = getAllocateExceptionFn(CGM);
John McCallbd309292010-07-06 01:34:17 +0000498 llvm::CallInst *ExceptionPtr =
John McCall882987f2013-02-28 19:01:20 +0000499 EmitNounwindRuntimeCall(AllocExceptionFn,
500 llvm::ConstantInt::get(SizeTy, TypeSize),
501 "exception");
Anders Carlssonafd1edb2009-12-11 00:32:37 +0000502
John McCall2e6567a2010-04-22 01:10:34 +0000503 EmitAnyExprToExn(*this, E->getSubExpr(), ExceptionPtr);
Mike Stump75546b82009-12-10 00:06:18 +0000504
Anders Carlsson32e1b1c2009-10-30 02:27:02 +0000505 // Now throw the exception.
Anders Carlssonba840fb2011-01-24 01:59:49 +0000506 llvm::Constant *TypeInfo = CGM.GetAddrOfRTTIDescriptor(ThrowType,
507 /*ForEH=*/true);
John McCall2e6567a2010-04-22 01:10:34 +0000508
509 // The address of the destructor. If the exception type has a
510 // trivial destructor (or isn't a record), we just pass null.
Craig Topper8a13c412014-05-21 05:09:00 +0000511 llvm::Constant *Dtor = nullptr;
John McCall2e6567a2010-04-22 01:10:34 +0000512 if (const RecordType *RecordTy = ThrowType->getAs<RecordType>()) {
513 CXXRecordDecl *Record = cast<CXXRecordDecl>(RecordTy->getDecl());
514 if (!Record->hasTrivialDestructor()) {
Douglas Gregorbac74902010-07-01 14:13:13 +0000515 CXXDestructorDecl *DtorD = Record->getDestructor();
Rafael Espindola1ac0ec82014-09-11 15:42:06 +0000516 Dtor = CGM.getAddrOfCXXStructor(DtorD, StructorType::Complete);
John McCall2e6567a2010-04-22 01:10:34 +0000517 Dtor = llvm::ConstantExpr::getBitCast(Dtor, Int8PtrTy);
518 }
519 }
520 if (!Dtor) Dtor = llvm::Constant::getNullValue(Int8PtrTy);
Mike Stump75546b82009-12-10 00:06:18 +0000521
John McCall882987f2013-02-28 19:01:20 +0000522 llvm::Value *args[] = { ExceptionPtr, TypeInfo, Dtor };
523 EmitNoreturnRuntimeCallOrInvoke(getThrowFn(CGM), args);
Mike Stump75546b82009-12-10 00:06:18 +0000524
John McCall20f6ab82011-01-12 03:41:02 +0000525 // throw is an expression, and the expression emitters expect us
526 // to leave ourselves at a valid insertion point.
Richard Smithea852322013-05-07 21:53:22 +0000527 if (KeepInsertionPoint)
528 EmitBlock(createBasicBlock("throw.cont"));
Anders Carlsson4b08db72009-10-30 01:42:31 +0000529}
Mike Stump58ef18b2009-11-20 23:44:51 +0000530
Mike Stump1d849212009-12-07 23:38:24 +0000531void CodeGenFunction::EmitStartEHSpec(const Decl *D) {
David Blaikiebbafb8a2012-03-11 07:00:24 +0000532 if (!CGM.getLangOpts().CXXExceptions)
Anders Carlsson9878f9f2010-02-06 23:59:05 +0000533 return;
534
Mike Stump1d849212009-12-07 23:38:24 +0000535 const FunctionDecl* FD = dyn_cast_or_null<FunctionDecl>(D);
Craig Topper8a13c412014-05-21 05:09:00 +0000536 if (!FD) {
Alexey Bataev9959db52014-05-06 10:08:46 +0000537 // Check if CapturedDecl is nothrow and create terminate scope for it.
538 if (const CapturedDecl* CD = dyn_cast_or_null<CapturedDecl>(D)) {
539 if (CD->isNothrow())
540 EHStack.pushTerminate();
541 }
Mike Stump1d849212009-12-07 23:38:24 +0000542 return;
Alexey Bataev9959db52014-05-06 10:08:46 +0000543 }
Mike Stump1d849212009-12-07 23:38:24 +0000544 const FunctionProtoType *Proto = FD->getType()->getAs<FunctionProtoType>();
Craig Topper8a13c412014-05-21 05:09:00 +0000545 if (!Proto)
Mike Stump1d849212009-12-07 23:38:24 +0000546 return;
547
Sebastian Redl0b94c9f2011-03-15 18:42:48 +0000548 ExceptionSpecificationType EST = Proto->getExceptionSpecType();
549 if (isNoexceptExceptionSpec(EST)) {
550 if (Proto->getNoexceptSpec(getContext()) == FunctionProtoType::NR_Nothrow) {
551 // noexcept functions are simple terminate scopes.
552 EHStack.pushTerminate();
553 }
554 } else if (EST == EST_Dynamic || EST == EST_DynamicNone) {
555 unsigned NumExceptions = Proto->getNumExceptions();
556 EHFilterScope *Filter = EHStack.pushFilter(NumExceptions);
Mike Stump1d849212009-12-07 23:38:24 +0000557
Sebastian Redl0b94c9f2011-03-15 18:42:48 +0000558 for (unsigned I = 0; I != NumExceptions; ++I) {
559 QualType Ty = Proto->getExceptionType(I);
560 QualType ExceptType = Ty.getNonReferenceType().getUnqualifiedType();
561 llvm::Value *EHType = CGM.GetAddrOfRTTIDescriptor(ExceptType,
562 /*ForEH=*/true);
563 Filter->setFilter(I, EHType);
564 }
Mike Stump1d849212009-12-07 23:38:24 +0000565 }
Mike Stump1d849212009-12-07 23:38:24 +0000566}
567
John McCall8e4c74b2011-08-11 02:22:43 +0000568/// Emit the dispatch block for a filter scope if necessary.
569static void emitFilterDispatchBlock(CodeGenFunction &CGF,
570 EHFilterScope &filterScope) {
571 llvm::BasicBlock *dispatchBlock = filterScope.getCachedEHDispatchBlock();
572 if (!dispatchBlock) return;
573 if (dispatchBlock->use_empty()) {
574 delete dispatchBlock;
575 return;
576 }
577
John McCall8e4c74b2011-08-11 02:22:43 +0000578 CGF.EmitBlockAfterUses(dispatchBlock);
579
580 // If this isn't a catch-all filter, we need to check whether we got
581 // here because the filter triggered.
582 if (filterScope.getNumFilters()) {
583 // Load the selector value.
Bill Wendling79a70e42011-09-15 18:57:19 +0000584 llvm::Value *selector = CGF.getSelectorFromSlot();
John McCall8e4c74b2011-08-11 02:22:43 +0000585 llvm::BasicBlock *unexpectedBB = CGF.createBasicBlock("ehspec.unexpected");
586
587 llvm::Value *zero = CGF.Builder.getInt32(0);
588 llvm::Value *failsFilter =
Nico Weber1bebad12015-02-11 22:33:32 +0000589 CGF.Builder.CreateICmpSLT(selector, zero, "ehspec.fails");
590 CGF.Builder.CreateCondBr(failsFilter, unexpectedBB,
591 CGF.getEHResumeBlock(false));
John McCall8e4c74b2011-08-11 02:22:43 +0000592
593 CGF.EmitBlock(unexpectedBB);
594 }
595
596 // Call __cxa_call_unexpected. This doesn't need to be an invoke
597 // because __cxa_call_unexpected magically filters exceptions
598 // according to the last landing pad the exception was thrown
599 // into. Seriously.
Bill Wendling79a70e42011-09-15 18:57:19 +0000600 llvm::Value *exn = CGF.getExceptionFromSlot();
John McCall882987f2013-02-28 19:01:20 +0000601 CGF.EmitRuntimeCall(getUnexpectedFn(CGF.CGM), exn)
John McCall8e4c74b2011-08-11 02:22:43 +0000602 ->setDoesNotReturn();
603 CGF.Builder.CreateUnreachable();
604}
605
Mike Stump1d849212009-12-07 23:38:24 +0000606void CodeGenFunction::EmitEndEHSpec(const Decl *D) {
David Blaikiebbafb8a2012-03-11 07:00:24 +0000607 if (!CGM.getLangOpts().CXXExceptions)
Anders Carlsson9878f9f2010-02-06 23:59:05 +0000608 return;
609
Mike Stump1d849212009-12-07 23:38:24 +0000610 const FunctionDecl* FD = dyn_cast_or_null<FunctionDecl>(D);
Craig Topper8a13c412014-05-21 05:09:00 +0000611 if (!FD) {
Alexey Bataev9959db52014-05-06 10:08:46 +0000612 // Check if CapturedDecl is nothrow and pop terminate scope for it.
613 if (const CapturedDecl* CD = dyn_cast_or_null<CapturedDecl>(D)) {
614 if (CD->isNothrow())
615 EHStack.popTerminate();
616 }
Mike Stump1d849212009-12-07 23:38:24 +0000617 return;
Alexey Bataev9959db52014-05-06 10:08:46 +0000618 }
Mike Stump1d849212009-12-07 23:38:24 +0000619 const FunctionProtoType *Proto = FD->getType()->getAs<FunctionProtoType>();
Craig Topper8a13c412014-05-21 05:09:00 +0000620 if (!Proto)
Mike Stump1d849212009-12-07 23:38:24 +0000621 return;
622
Sebastian Redl0b94c9f2011-03-15 18:42:48 +0000623 ExceptionSpecificationType EST = Proto->getExceptionSpecType();
624 if (isNoexceptExceptionSpec(EST)) {
625 if (Proto->getNoexceptSpec(getContext()) == FunctionProtoType::NR_Nothrow) {
626 EHStack.popTerminate();
627 }
628 } else if (EST == EST_Dynamic || EST == EST_DynamicNone) {
John McCall8e4c74b2011-08-11 02:22:43 +0000629 EHFilterScope &filterScope = cast<EHFilterScope>(*EHStack.begin());
630 emitFilterDispatchBlock(*this, filterScope);
Sebastian Redl0b94c9f2011-03-15 18:42:48 +0000631 EHStack.popFilter();
632 }
Mike Stump1d849212009-12-07 23:38:24 +0000633}
634
Mike Stump58ef18b2009-11-20 23:44:51 +0000635void CodeGenFunction::EmitCXXTryStmt(const CXXTryStmt &S) {
Saleem Abdulrasoolb7698742014-11-17 22:11:07 +0000636 if (CGM.getTarget().getTriple().isKnownWindowsMSVCEnvironment()) {
Reid Klecknera82b5d82014-05-05 21:12:12 +0000637 ErrorUnsupported(&S, "try statement");
638 return;
639 }
640
John McCallb609d3f2010-07-07 06:56:46 +0000641 EnterCXXTryStmt(S);
John McCallb81884d2010-02-19 09:25:03 +0000642 EmitStmt(S.getTryBlock());
John McCallb609d3f2010-07-07 06:56:46 +0000643 ExitCXXTryStmt(S);
John McCallb81884d2010-02-19 09:25:03 +0000644}
645
John McCallb609d3f2010-07-07 06:56:46 +0000646void CodeGenFunction::EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock) {
John McCallbd309292010-07-06 01:34:17 +0000647 unsigned NumHandlers = S.getNumHandlers();
648 EHCatchScope *CatchScope = EHStack.pushCatch(NumHandlers);
John McCallb81884d2010-02-19 09:25:03 +0000649
John McCallbd309292010-07-06 01:34:17 +0000650 for (unsigned I = 0; I != NumHandlers; ++I) {
651 const CXXCatchStmt *C = S.getHandler(I);
John McCallb81884d2010-02-19 09:25:03 +0000652
John McCallbd309292010-07-06 01:34:17 +0000653 llvm::BasicBlock *Handler = createBasicBlock("catch");
654 if (C->getExceptionDecl()) {
655 // FIXME: Dropping the reference type on the type into makes it
656 // impossible to correctly implement catch-by-reference
657 // semantics for pointers. Unfortunately, this is what all
658 // existing compilers do, and it's not clear that the standard
659 // personality routine is capable of doing this right. See C++ DR 388:
660 // http://www.open-std.org/jtc1/sc22/wg21/docs/cwg_active.html#388
David Majnemer571162a2014-10-12 06:58:22 +0000661 Qualifiers CaughtTypeQuals;
662 QualType CaughtType = CGM.getContext().getUnqualifiedArrayType(
663 C->getCaughtType().getNonReferenceType(), CaughtTypeQuals);
John McCall2ca705e2010-07-24 00:37:23 +0000664
Rafael Espindolabb9e7a32014-06-04 18:51:46 +0000665 llvm::Constant *TypeInfo = nullptr;
John McCall2ca705e2010-07-24 00:37:23 +0000666 if (CaughtType->isObjCObjectPointerType())
Fariborz Jahanian831f0fc2011-06-23 19:00:08 +0000667 TypeInfo = CGM.getObjCRuntime().GetEHType(CaughtType);
John McCall2ca705e2010-07-24 00:37:23 +0000668 else
Anders Carlssonba840fb2011-01-24 01:59:49 +0000669 TypeInfo = CGM.GetAddrOfRTTIDescriptor(CaughtType, /*ForEH=*/true);
John McCallbd309292010-07-06 01:34:17 +0000670 CatchScope->setHandler(I, TypeInfo, Handler);
671 } else {
672 // No exception decl indicates '...', a catch-all.
673 CatchScope->setCatchAllHandler(I, Handler);
674 }
675 }
John McCallbd309292010-07-06 01:34:17 +0000676}
677
John McCall8e4c74b2011-08-11 02:22:43 +0000678llvm::BasicBlock *
679CodeGenFunction::getEHDispatchBlock(EHScopeStack::stable_iterator si) {
680 // The dispatch block for the end of the scope chain is a block that
681 // just resumes unwinding.
682 if (si == EHStack.stable_end())
David Chisnall9a837be2012-11-07 16:50:40 +0000683 return getEHResumeBlock(true);
John McCall8e4c74b2011-08-11 02:22:43 +0000684
685 // Otherwise, we should look at the actual scope.
686 EHScope &scope = *EHStack.find(si);
687
688 llvm::BasicBlock *dispatchBlock = scope.getCachedEHDispatchBlock();
689 if (!dispatchBlock) {
690 switch (scope.getKind()) {
691 case EHScope::Catch: {
692 // Apply a special case to a single catch-all.
693 EHCatchScope &catchScope = cast<EHCatchScope>(scope);
694 if (catchScope.getNumHandlers() == 1 &&
695 catchScope.getHandler(0).isCatchAll()) {
696 dispatchBlock = catchScope.getHandler(0).Block;
697
698 // Otherwise, make a dispatch block.
699 } else {
700 dispatchBlock = createBasicBlock("catch.dispatch");
701 }
702 break;
703 }
704
705 case EHScope::Cleanup:
706 dispatchBlock = createBasicBlock("ehcleanup");
707 break;
708
709 case EHScope::Filter:
710 dispatchBlock = createBasicBlock("filter.dispatch");
711 break;
712
713 case EHScope::Terminate:
714 dispatchBlock = getTerminateHandler();
715 break;
716 }
717 scope.setCachedEHDispatchBlock(dispatchBlock);
718 }
719 return dispatchBlock;
720}
721
John McCallbd309292010-07-06 01:34:17 +0000722/// Check whether this is a non-EH scope, i.e. a scope which doesn't
723/// affect exception handling. Currently, the only non-EH scopes are
724/// normal-only cleanup scopes.
725static bool isNonEHScope(const EHScope &S) {
John McCall2b7fc382010-07-13 20:32:21 +0000726 switch (S.getKind()) {
John McCallcda666c2010-07-21 07:22:38 +0000727 case EHScope::Cleanup:
728 return !cast<EHCleanupScope>(S).isEHCleanup();
John McCall2b7fc382010-07-13 20:32:21 +0000729 case EHScope::Filter:
730 case EHScope::Catch:
731 case EHScope::Terminate:
732 return false;
733 }
734
David Blaikiee4d798f2012-01-20 21:50:17 +0000735 llvm_unreachable("Invalid EHScope Kind!");
John McCallbd309292010-07-06 01:34:17 +0000736}
737
738llvm::BasicBlock *CodeGenFunction::getInvokeDestImpl() {
739 assert(EHStack.requiresLandingPad());
740 assert(!EHStack.empty());
741
Reid Klecknerdeeddec2015-02-05 18:56:03 +0000742 // If exceptions are disabled, there are usually no landingpads. However, when
743 // SEH is enabled, functions using SEH still get landingpads.
744 const LangOptions &LO = CGM.getLangOpts();
745 if (!LO.Exceptions) {
746 if (!LO.Borland && !LO.MicrosoftExt)
747 return nullptr;
Reid Klecknere7b3f7c2015-02-11 00:00:21 +0000748 if (!currentFunctionUsesSEHTry())
Reid Klecknerdeeddec2015-02-05 18:56:03 +0000749 return nullptr;
750 }
John McCall2b7fc382010-07-13 20:32:21 +0000751
John McCallbd309292010-07-06 01:34:17 +0000752 // Check the innermost scope for a cached landing pad. If this is
753 // a non-EH cleanup, we'll check enclosing scopes in EmitLandingPad.
754 llvm::BasicBlock *LP = EHStack.begin()->getCachedLandingPad();
755 if (LP) return LP;
756
757 // Build the landing pad for this scope.
758 LP = EmitLandingPad();
759 assert(LP);
760
761 // Cache the landing pad on the innermost scope. If this is a
762 // non-EH scope, cache the landing pad on the enclosing scope, too.
763 for (EHScopeStack::iterator ir = EHStack.begin(); true; ++ir) {
764 ir->setCachedLandingPad(LP);
765 if (!isNonEHScope(*ir)) break;
766 }
767
768 return LP;
769}
770
771llvm::BasicBlock *CodeGenFunction::EmitLandingPad() {
772 assert(EHStack.requiresLandingPad());
773
John McCall8e4c74b2011-08-11 02:22:43 +0000774 EHScope &innermostEHScope = *EHStack.find(EHStack.getInnermostEHScope());
775 switch (innermostEHScope.getKind()) {
776 case EHScope::Terminate:
777 return getTerminateLandingPad();
John McCallbd309292010-07-06 01:34:17 +0000778
John McCall8e4c74b2011-08-11 02:22:43 +0000779 case EHScope::Catch:
780 case EHScope::Cleanup:
781 case EHScope::Filter:
782 if (llvm::BasicBlock *lpad = innermostEHScope.getCachedLandingPad())
783 return lpad;
John McCallbd309292010-07-06 01:34:17 +0000784 }
785
786 // Save the current IR generation state.
John McCall8e4c74b2011-08-11 02:22:43 +0000787 CGBuilderTy::InsertPoint savedIP = Builder.saveAndClearIP();
Adrian Prantl95b24e92015-02-03 20:00:54 +0000788 auto DL = ApplyDebugLocation::CreateDefaultArtificial(*this, CurEHLocation);
John McCallbd309292010-07-06 01:34:17 +0000789
Reid Klecknerdeeddec2015-02-05 18:56:03 +0000790 const EHPersonality &personality = EHPersonality::get(*this);
John McCall36ea3722010-07-17 00:43:08 +0000791
John McCallbd309292010-07-06 01:34:17 +0000792 // Create and configure the landing pad.
John McCall8e4c74b2011-08-11 02:22:43 +0000793 llvm::BasicBlock *lpad = createBasicBlock("lpad");
794 EmitBlock(lpad);
John McCallbd309292010-07-06 01:34:17 +0000795
Bill Wendlingf0724e82011-09-19 20:31:14 +0000796 llvm::LandingPadInst *LPadInst =
Reid Kleckneree7cf842014-12-01 22:02:27 +0000797 Builder.CreateLandingPad(llvm::StructType::get(Int8PtrTy, Int32Ty, nullptr),
Bill Wendlingf0724e82011-09-19 20:31:14 +0000798 getOpaquePersonalityFn(CGM, personality), 0);
799
800 llvm::Value *LPadExn = Builder.CreateExtractValue(LPadInst, 0);
801 Builder.CreateStore(LPadExn, getExceptionSlot());
802 llvm::Value *LPadSel = Builder.CreateExtractValue(LPadInst, 1);
803 Builder.CreateStore(LPadSel, getEHSelectorSlot());
804
John McCallbd309292010-07-06 01:34:17 +0000805 // Save the exception pointer. It's safe to use a single exception
806 // pointer per function because EH cleanups can never have nested
807 // try/catches.
Bill Wendlingf0724e82011-09-19 20:31:14 +0000808 // Build the landingpad instruction.
John McCallbd309292010-07-06 01:34:17 +0000809
810 // Accumulate all the handlers in scope.
John McCall8e4c74b2011-08-11 02:22:43 +0000811 bool hasCatchAll = false;
812 bool hasCleanup = false;
813 bool hasFilter = false;
814 SmallVector<llvm::Value*, 4> filterTypes;
815 llvm::SmallPtrSet<llvm::Value*, 4> catchTypes;
Nico Webere68b9f32015-02-25 16:25:00 +0000816 for (EHScopeStack::iterator I = EHStack.begin(), E = EHStack.end(); I != E;
817 ++I) {
John McCallbd309292010-07-06 01:34:17 +0000818
819 switch (I->getKind()) {
John McCallcda666c2010-07-21 07:22:38 +0000820 case EHScope::Cleanup:
John McCall8e4c74b2011-08-11 02:22:43 +0000821 // If we have a cleanup, remember that.
822 hasCleanup = (hasCleanup || cast<EHCleanupScope>(*I).isEHCleanup());
John McCall2b7fc382010-07-13 20:32:21 +0000823 continue;
824
John McCallbd309292010-07-06 01:34:17 +0000825 case EHScope::Filter: {
826 assert(I.next() == EHStack.end() && "EH filter is not end of EH stack");
John McCall8e4c74b2011-08-11 02:22:43 +0000827 assert(!hasCatchAll && "EH filter reached after catch-all");
John McCallbd309292010-07-06 01:34:17 +0000828
Bill Wendlingf0724e82011-09-19 20:31:14 +0000829 // Filter scopes get added to the landingpad in weird ways.
John McCall8e4c74b2011-08-11 02:22:43 +0000830 EHFilterScope &filter = cast<EHFilterScope>(*I);
831 hasFilter = true;
John McCallbd309292010-07-06 01:34:17 +0000832
Bill Wendling8c4b7162011-09-22 20:32:54 +0000833 // Add all the filter values.
834 for (unsigned i = 0, e = filter.getNumFilters(); i != e; ++i)
835 filterTypes.push_back(filter.getFilter(i));
John McCallbd309292010-07-06 01:34:17 +0000836 goto done;
837 }
838
839 case EHScope::Terminate:
840 // Terminate scopes are basically catch-alls.
John McCall8e4c74b2011-08-11 02:22:43 +0000841 assert(!hasCatchAll);
842 hasCatchAll = true;
John McCallbd309292010-07-06 01:34:17 +0000843 goto done;
844
845 case EHScope::Catch:
846 break;
847 }
848
John McCall8e4c74b2011-08-11 02:22:43 +0000849 EHCatchScope &catchScope = cast<EHCatchScope>(*I);
850 for (unsigned hi = 0, he = catchScope.getNumHandlers(); hi != he; ++hi) {
851 EHCatchScope::Handler handler = catchScope.getHandler(hi);
John McCallbd309292010-07-06 01:34:17 +0000852
John McCall8e4c74b2011-08-11 02:22:43 +0000853 // If this is a catch-all, register that and abort.
854 if (!handler.Type) {
855 assert(!hasCatchAll);
856 hasCatchAll = true;
857 goto done;
John McCallbd309292010-07-06 01:34:17 +0000858 }
859
860 // Check whether we already have a handler for this type.
David Blaikie82e95a32014-11-19 07:49:47 +0000861 if (catchTypes.insert(handler.Type).second)
Bill Wendlingf0724e82011-09-19 20:31:14 +0000862 // If not, add it directly to the landingpad.
863 LPadInst->addClause(handler.Type);
John McCallbd309292010-07-06 01:34:17 +0000864 }
John McCallbd309292010-07-06 01:34:17 +0000865 }
866
867 done:
Bill Wendlingf0724e82011-09-19 20:31:14 +0000868 // If we have a catch-all, add null to the landingpad.
John McCall8e4c74b2011-08-11 02:22:43 +0000869 assert(!(hasCatchAll && hasFilter));
870 if (hasCatchAll) {
Bill Wendlingf0724e82011-09-19 20:31:14 +0000871 LPadInst->addClause(getCatchAllValue(*this));
John McCallbd309292010-07-06 01:34:17 +0000872
873 // If we have an EH filter, we need to add those handlers in the
Bill Wendlingf0724e82011-09-19 20:31:14 +0000874 // right place in the landingpad, which is to say, at the end.
John McCall8e4c74b2011-08-11 02:22:43 +0000875 } else if (hasFilter) {
Bill Wendling58e58fe2011-09-19 22:08:36 +0000876 // Create a filter expression: a constant array indicating which filter
877 // types there are. The personality routine only lands here if the filter
878 // doesn't match.
Dmitri Gribenkof8579502013-01-12 19:30:44 +0000879 SmallVector<llvm::Constant*, 8> Filters;
Bill Wendlingf0724e82011-09-19 20:31:14 +0000880 llvm::ArrayType *AType =
881 llvm::ArrayType::get(!filterTypes.empty() ?
882 filterTypes[0]->getType() : Int8PtrTy,
883 filterTypes.size());
884
885 for (unsigned i = 0, e = filterTypes.size(); i != e; ++i)
886 Filters.push_back(cast<llvm::Constant>(filterTypes[i]));
887 llvm::Constant *FilterArray = llvm::ConstantArray::get(AType, Filters);
888 LPadInst->addClause(FilterArray);
John McCallbd309292010-07-06 01:34:17 +0000889
890 // Also check whether we need a cleanup.
Bill Wendlingf0724e82011-09-19 20:31:14 +0000891 if (hasCleanup)
892 LPadInst->setCleanup(true);
John McCallbd309292010-07-06 01:34:17 +0000893
894 // Otherwise, signal that we at least have cleanups.
Logan Chiene9c8ccb2014-07-01 11:47:10 +0000895 } else if (hasCleanup) {
896 LPadInst->setCleanup(true);
John McCallbd309292010-07-06 01:34:17 +0000897 }
898
Bill Wendlingf0724e82011-09-19 20:31:14 +0000899 assert((LPadInst->getNumClauses() > 0 || LPadInst->isCleanup()) &&
900 "landingpad instruction has no clauses!");
John McCallbd309292010-07-06 01:34:17 +0000901
902 // Tell the backend how to generate the landing pad.
John McCall8e4c74b2011-08-11 02:22:43 +0000903 Builder.CreateBr(getEHDispatchBlock(EHStack.getInnermostEHScope()));
John McCallbd309292010-07-06 01:34:17 +0000904
905 // Restore the old IR generation state.
John McCall8e4c74b2011-08-11 02:22:43 +0000906 Builder.restoreIP(savedIP);
John McCallbd309292010-07-06 01:34:17 +0000907
John McCall8e4c74b2011-08-11 02:22:43 +0000908 return lpad;
John McCallbd309292010-07-06 01:34:17 +0000909}
910
John McCall5c08ab92010-07-13 22:12:14 +0000911namespace {
912 /// A cleanup to call __cxa_end_catch. In many cases, the caught
913 /// exception type lets us state definitively that the thrown exception
914 /// type does not have a destructor. In particular:
915 /// - Catch-alls tell us nothing, so we have to conservatively
916 /// assume that the thrown exception might have a destructor.
917 /// - Catches by reference behave according to their base types.
918 /// - Catches of non-record types will only trigger for exceptions
919 /// of non-record types, which never have destructors.
920 /// - Catches of record types can trigger for arbitrary subclasses
921 /// of the caught type, so we have to assume the actual thrown
922 /// exception type might have a throwing destructor, even if the
923 /// caught type's destructor is trivial or nothrow.
John McCallcda666c2010-07-21 07:22:38 +0000924 struct CallEndCatch : EHScopeStack::Cleanup {
John McCall5c08ab92010-07-13 22:12:14 +0000925 CallEndCatch(bool MightThrow) : MightThrow(MightThrow) {}
926 bool MightThrow;
927
Craig Topper4f12f102014-03-12 06:41:41 +0000928 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall5c08ab92010-07-13 22:12:14 +0000929 if (!MightThrow) {
John McCall882987f2013-02-28 19:01:20 +0000930 CGF.EmitNounwindRuntimeCall(getEndCatchFn(CGF.CGM));
John McCall5c08ab92010-07-13 22:12:14 +0000931 return;
932 }
933
John McCall882987f2013-02-28 19:01:20 +0000934 CGF.EmitRuntimeCallOrInvoke(getEndCatchFn(CGF.CGM));
John McCall5c08ab92010-07-13 22:12:14 +0000935 }
936 };
937}
938
John McCallbd309292010-07-06 01:34:17 +0000939/// Emits a call to __cxa_begin_catch and enters a cleanup to call
940/// __cxa_end_catch.
John McCall5c08ab92010-07-13 22:12:14 +0000941///
942/// \param EndMightThrow - true if __cxa_end_catch might throw
943static llvm::Value *CallBeginCatch(CodeGenFunction &CGF,
944 llvm::Value *Exn,
945 bool EndMightThrow) {
John McCall882987f2013-02-28 19:01:20 +0000946 llvm::CallInst *call =
947 CGF.EmitNounwindRuntimeCall(getBeginCatchFn(CGF.CGM), Exn);
John McCallbd309292010-07-06 01:34:17 +0000948
John McCallcda666c2010-07-21 07:22:38 +0000949 CGF.EHStack.pushCleanup<CallEndCatch>(NormalAndEHCleanup, EndMightThrow);
John McCallbd309292010-07-06 01:34:17 +0000950
John McCall882987f2013-02-28 19:01:20 +0000951 return call;
John McCallbd309292010-07-06 01:34:17 +0000952}
953
954/// A "special initializer" callback for initializing a catch
955/// parameter during catch initialization.
956static void InitCatchParam(CodeGenFunction &CGF,
957 const VarDecl &CatchParam,
Nick Lewycky2d84e842013-10-02 02:29:49 +0000958 llvm::Value *ParamAddr,
959 SourceLocation Loc) {
John McCallbd309292010-07-06 01:34:17 +0000960 // Load the exception from where the landing pad saved it.
Bill Wendling79a70e42011-09-15 18:57:19 +0000961 llvm::Value *Exn = CGF.getExceptionFromSlot();
John McCallbd309292010-07-06 01:34:17 +0000962
963 CanQualType CatchType =
964 CGF.CGM.getContext().getCanonicalType(CatchParam.getType());
Chris Lattner2192fe52011-07-18 04:24:23 +0000965 llvm::Type *LLVMCatchTy = CGF.ConvertTypeForMem(CatchType);
John McCallbd309292010-07-06 01:34:17 +0000966
967 // If we're catching by reference, we can just cast the object
968 // pointer to the appropriate pointer.
969 if (isa<ReferenceType>(CatchType)) {
John McCall5add20c2010-07-20 22:17:55 +0000970 QualType CaughtType = cast<ReferenceType>(CatchType)->getPointeeType();
971 bool EndCatchMightThrow = CaughtType->isRecordType();
John McCall5c08ab92010-07-13 22:12:14 +0000972
John McCallbd309292010-07-06 01:34:17 +0000973 // __cxa_begin_catch returns the adjusted object pointer.
John McCall5c08ab92010-07-13 22:12:14 +0000974 llvm::Value *AdjustedExn = CallBeginCatch(CGF, Exn, EndCatchMightThrow);
John McCall5add20c2010-07-20 22:17:55 +0000975
976 // We have no way to tell the personality function that we're
977 // catching by reference, so if we're catching a pointer,
978 // __cxa_begin_catch will actually return that pointer by value.
979 if (const PointerType *PT = dyn_cast<PointerType>(CaughtType)) {
980 QualType PointeeType = PT->getPointeeType();
981
982 // When catching by reference, generally we should just ignore
983 // this by-value pointer and use the exception object instead.
984 if (!PointeeType->isRecordType()) {
985
986 // Exn points to the struct _Unwind_Exception header, which
987 // we have to skip past in order to reach the exception data.
988 unsigned HeaderSize =
989 CGF.CGM.getTargetCodeGenInfo().getSizeOfUnwindException();
990 AdjustedExn = CGF.Builder.CreateConstGEP1_32(Exn, HeaderSize);
991
992 // However, if we're catching a pointer-to-record type that won't
993 // work, because the personality function might have adjusted
994 // the pointer. There's actually no way for us to fully satisfy
995 // the language/ABI contract here: we can't use Exn because it
996 // might have the wrong adjustment, but we can't use the by-value
997 // pointer because it's off by a level of abstraction.
998 //
999 // The current solution is to dump the adjusted pointer into an
1000 // alloca, which breaks language semantics (because changing the
1001 // pointer doesn't change the exception) but at least works.
1002 // The better solution would be to filter out non-exact matches
1003 // and rethrow them, but this is tricky because the rethrow
1004 // really needs to be catchable by other sites at this landing
1005 // pad. The best solution is to fix the personality function.
1006 } else {
1007 // Pull the pointer for the reference type off.
Chris Lattner2192fe52011-07-18 04:24:23 +00001008 llvm::Type *PtrTy =
John McCall5add20c2010-07-20 22:17:55 +00001009 cast<llvm::PointerType>(LLVMCatchTy)->getElementType();
1010
1011 // Create the temporary and write the adjusted pointer into it.
1012 llvm::Value *ExnPtrTmp = CGF.CreateTempAlloca(PtrTy, "exn.byref.tmp");
1013 llvm::Value *Casted = CGF.Builder.CreateBitCast(AdjustedExn, PtrTy);
1014 CGF.Builder.CreateStore(Casted, ExnPtrTmp);
1015
1016 // Bind the reference to the temporary.
1017 AdjustedExn = ExnPtrTmp;
1018 }
1019 }
1020
John McCallbd309292010-07-06 01:34:17 +00001021 llvm::Value *ExnCast =
1022 CGF.Builder.CreateBitCast(AdjustedExn, LLVMCatchTy, "exn.byref");
1023 CGF.Builder.CreateStore(ExnCast, ParamAddr);
1024 return;
1025 }
1026
John McCall47fb9502013-03-07 21:37:08 +00001027 // Scalars and complexes.
1028 TypeEvaluationKind TEK = CGF.getEvaluationKind(CatchType);
1029 if (TEK != TEK_Aggregate) {
John McCall5c08ab92010-07-13 22:12:14 +00001030 llvm::Value *AdjustedExn = CallBeginCatch(CGF, Exn, false);
John McCallbd309292010-07-06 01:34:17 +00001031
1032 // If the catch type is a pointer type, __cxa_begin_catch returns
1033 // the pointer by value.
1034 if (CatchType->hasPointerRepresentation()) {
1035 llvm::Value *CastExn =
1036 CGF.Builder.CreateBitCast(AdjustedExn, LLVMCatchTy, "exn.casted");
John McCall97017312012-01-17 20:16:56 +00001037
1038 switch (CatchType.getQualifiers().getObjCLifetime()) {
1039 case Qualifiers::OCL_Strong:
1040 CastExn = CGF.EmitARCRetainNonBlock(CastExn);
1041 // fallthrough
1042
1043 case Qualifiers::OCL_None:
1044 case Qualifiers::OCL_ExplicitNone:
1045 case Qualifiers::OCL_Autoreleasing:
1046 CGF.Builder.CreateStore(CastExn, ParamAddr);
1047 return;
1048
1049 case Qualifiers::OCL_Weak:
1050 CGF.EmitARCInitWeak(ParamAddr, CastExn);
1051 return;
1052 }
1053 llvm_unreachable("bad ownership qualifier!");
John McCallbd309292010-07-06 01:34:17 +00001054 }
1055
1056 // Otherwise, it returns a pointer into the exception object.
1057
Chris Lattner2192fe52011-07-18 04:24:23 +00001058 llvm::Type *PtrTy = LLVMCatchTy->getPointerTo(0); // addrspace 0 ok
John McCallbd309292010-07-06 01:34:17 +00001059 llvm::Value *Cast = CGF.Builder.CreateBitCast(AdjustedExn, PtrTy);
1060
John McCall47fb9502013-03-07 21:37:08 +00001061 LValue srcLV = CGF.MakeNaturalAlignAddrLValue(Cast, CatchType);
1062 LValue destLV = CGF.MakeAddrLValue(ParamAddr, CatchType,
1063 CGF.getContext().getDeclAlign(&CatchParam));
1064 switch (TEK) {
1065 case TEK_Complex:
Nick Lewycky2d84e842013-10-02 02:29:49 +00001066 CGF.EmitStoreOfComplex(CGF.EmitLoadOfComplex(srcLV, Loc), destLV,
John McCall47fb9502013-03-07 21:37:08 +00001067 /*init*/ true);
1068 return;
1069 case TEK_Scalar: {
Nick Lewycky2d84e842013-10-02 02:29:49 +00001070 llvm::Value *ExnLoad = CGF.EmitLoadOfScalar(srcLV, Loc);
John McCall47fb9502013-03-07 21:37:08 +00001071 CGF.EmitStoreOfScalar(ExnLoad, destLV, /*init*/ true);
1072 return;
John McCallbd309292010-07-06 01:34:17 +00001073 }
John McCall47fb9502013-03-07 21:37:08 +00001074 case TEK_Aggregate:
1075 llvm_unreachable("evaluation kind filtered out!");
1076 }
1077 llvm_unreachable("bad evaluation kind");
John McCallbd309292010-07-06 01:34:17 +00001078 }
1079
John McCallb5011ab2011-02-16 08:39:19 +00001080 assert(isa<RecordType>(CatchType) && "unexpected catch type!");
John McCallbd309292010-07-06 01:34:17 +00001081
Chris Lattner2192fe52011-07-18 04:24:23 +00001082 llvm::Type *PtrTy = LLVMCatchTy->getPointerTo(0); // addrspace 0 ok
John McCallbd309292010-07-06 01:34:17 +00001083
John McCallb5011ab2011-02-16 08:39:19 +00001084 // Check for a copy expression. If we don't have a copy expression,
1085 // that means a trivial copy is okay.
John McCall1bf58462011-02-16 08:02:54 +00001086 const Expr *copyExpr = CatchParam.getInit();
1087 if (!copyExpr) {
John McCallb5011ab2011-02-16 08:39:19 +00001088 llvm::Value *rawAdjustedExn = CallBeginCatch(CGF, Exn, true);
1089 llvm::Value *adjustedExn = CGF.Builder.CreateBitCast(rawAdjustedExn, PtrTy);
Chad Rosier615ed1a2012-03-29 17:37:10 +00001090 CGF.EmitAggregateCopy(ParamAddr, adjustedExn, CatchType);
John McCallbd309292010-07-06 01:34:17 +00001091 return;
1092 }
1093
1094 // We have to call __cxa_get_exception_ptr to get the adjusted
1095 // pointer before copying.
John McCall1bf58462011-02-16 08:02:54 +00001096 llvm::CallInst *rawAdjustedExn =
John McCall882987f2013-02-28 19:01:20 +00001097 CGF.EmitNounwindRuntimeCall(getGetExceptionPtrFn(CGF.CGM), Exn);
John McCallbd309292010-07-06 01:34:17 +00001098
John McCall1bf58462011-02-16 08:02:54 +00001099 // Cast that to the appropriate type.
1100 llvm::Value *adjustedExn = CGF.Builder.CreateBitCast(rawAdjustedExn, PtrTy);
John McCallbd309292010-07-06 01:34:17 +00001101
John McCall1bf58462011-02-16 08:02:54 +00001102 // The copy expression is defined in terms of an OpaqueValueExpr.
1103 // Find it and map it to the adjusted expression.
1104 CodeGenFunction::OpaqueValueMapping
John McCallc07a0c72011-02-17 10:25:35 +00001105 opaque(CGF, OpaqueValueExpr::findInCopyConstruct(copyExpr),
1106 CGF.MakeAddrLValue(adjustedExn, CatchParam.getType()));
John McCallbd309292010-07-06 01:34:17 +00001107
1108 // Call the copy ctor in a terminate scope.
1109 CGF.EHStack.pushTerminate();
John McCall1bf58462011-02-16 08:02:54 +00001110
1111 // Perform the copy construction.
Eli Friedman38cd36d2011-12-03 02:13:40 +00001112 CharUnits Alignment = CGF.getContext().getDeclAlign(&CatchParam);
Eli Friedmanc1d85b92011-12-03 00:54:26 +00001113 CGF.EmitAggExpr(copyExpr,
1114 AggValueSlot::forAddr(ParamAddr, Alignment, Qualifiers(),
1115 AggValueSlot::IsNotDestructed,
1116 AggValueSlot::DoesNotNeedGCBarriers,
Chad Rosier615ed1a2012-03-29 17:37:10 +00001117 AggValueSlot::IsNotAliased));
John McCall1bf58462011-02-16 08:02:54 +00001118
1119 // Leave the terminate scope.
John McCallbd309292010-07-06 01:34:17 +00001120 CGF.EHStack.popTerminate();
1121
John McCall1bf58462011-02-16 08:02:54 +00001122 // Undo the opaque value mapping.
1123 opaque.pop();
1124
John McCallbd309292010-07-06 01:34:17 +00001125 // Finally we can call __cxa_begin_catch.
John McCall5c08ab92010-07-13 22:12:14 +00001126 CallBeginCatch(CGF, Exn, true);
John McCallbd309292010-07-06 01:34:17 +00001127}
1128
1129/// Begins a catch statement by initializing the catch variable and
1130/// calling __cxa_begin_catch.
John McCall1bf58462011-02-16 08:02:54 +00001131static void BeginCatch(CodeGenFunction &CGF, const CXXCatchStmt *S) {
John McCallbd309292010-07-06 01:34:17 +00001132 // We have to be very careful with the ordering of cleanups here:
1133 // C++ [except.throw]p4:
1134 // The destruction [of the exception temporary] occurs
1135 // immediately after the destruction of the object declared in
1136 // the exception-declaration in the handler.
1137 //
1138 // So the precise ordering is:
1139 // 1. Construct catch variable.
1140 // 2. __cxa_begin_catch
1141 // 3. Enter __cxa_end_catch cleanup
1142 // 4. Enter dtor cleanup
1143 //
John McCallc533cb72011-02-22 06:44:22 +00001144 // We do this by using a slightly abnormal initialization process.
1145 // Delegation sequence:
John McCallbd309292010-07-06 01:34:17 +00001146 // - ExitCXXTryStmt opens a RunCleanupsScope
John McCallc533cb72011-02-22 06:44:22 +00001147 // - EmitAutoVarAlloca creates the variable and debug info
John McCallbd309292010-07-06 01:34:17 +00001148 // - InitCatchParam initializes the variable from the exception
John McCallc533cb72011-02-22 06:44:22 +00001149 // - CallBeginCatch calls __cxa_begin_catch
1150 // - CallBeginCatch enters the __cxa_end_catch cleanup
1151 // - EmitAutoVarCleanups enters the variable destructor cleanup
John McCallbd309292010-07-06 01:34:17 +00001152 // - EmitCXXTryStmt emits the code for the catch body
1153 // - EmitCXXTryStmt close the RunCleanupsScope
1154
1155 VarDecl *CatchParam = S->getExceptionDecl();
1156 if (!CatchParam) {
Bill Wendling79a70e42011-09-15 18:57:19 +00001157 llvm::Value *Exn = CGF.getExceptionFromSlot();
John McCall5c08ab92010-07-13 22:12:14 +00001158 CallBeginCatch(CGF, Exn, true);
John McCallbd309292010-07-06 01:34:17 +00001159 return;
1160 }
1161
1162 // Emit the local.
John McCallc533cb72011-02-22 06:44:22 +00001163 CodeGenFunction::AutoVarEmission var = CGF.EmitAutoVarAlloca(*CatchParam);
Nick Lewycky2d84e842013-10-02 02:29:49 +00001164 InitCatchParam(CGF, *CatchParam, var.getObjectAddress(CGF), S->getLocStart());
John McCallc533cb72011-02-22 06:44:22 +00001165 CGF.EmitAutoVarCleanups(var);
John McCallb81884d2010-02-19 09:25:03 +00001166}
1167
John McCall8e4c74b2011-08-11 02:22:43 +00001168/// Emit the structure of the dispatch block for the given catch scope.
1169/// It is an invariant that the dispatch block already exists.
1170static void emitCatchDispatchBlock(CodeGenFunction &CGF,
1171 EHCatchScope &catchScope) {
1172 llvm::BasicBlock *dispatchBlock = catchScope.getCachedEHDispatchBlock();
1173 assert(dispatchBlock);
1174
1175 // If there's only a single catch-all, getEHDispatchBlock returned
1176 // that catch-all as the dispatch block.
1177 if (catchScope.getNumHandlers() == 1 &&
1178 catchScope.getHandler(0).isCatchAll()) {
1179 assert(dispatchBlock == catchScope.getHandler(0).Block);
1180 return;
1181 }
1182
1183 CGBuilderTy::InsertPoint savedIP = CGF.Builder.saveIP();
1184 CGF.EmitBlockAfterUses(dispatchBlock);
1185
1186 // Select the right handler.
1187 llvm::Value *llvm_eh_typeid_for =
1188 CGF.CGM.getIntrinsic(llvm::Intrinsic::eh_typeid_for);
1189
1190 // Load the selector value.
Bill Wendling79a70e42011-09-15 18:57:19 +00001191 llvm::Value *selector = CGF.getSelectorFromSlot();
John McCall8e4c74b2011-08-11 02:22:43 +00001192
1193 // Test against each of the exception types we claim to catch.
1194 for (unsigned i = 0, e = catchScope.getNumHandlers(); ; ++i) {
1195 assert(i < e && "ran off end of handlers!");
1196 const EHCatchScope::Handler &handler = catchScope.getHandler(i);
1197
1198 llvm::Value *typeValue = handler.Type;
1199 assert(typeValue && "fell into catch-all case!");
1200 typeValue = CGF.Builder.CreateBitCast(typeValue, CGF.Int8PtrTy);
1201
1202 // Figure out the next block.
1203 bool nextIsEnd;
1204 llvm::BasicBlock *nextBlock;
1205
1206 // If this is the last handler, we're at the end, and the next
1207 // block is the block for the enclosing EH scope.
1208 if (i + 1 == e) {
1209 nextBlock = CGF.getEHDispatchBlock(catchScope.getEnclosingEHScope());
1210 nextIsEnd = true;
1211
1212 // If the next handler is a catch-all, we're at the end, and the
1213 // next block is that handler.
1214 } else if (catchScope.getHandler(i+1).isCatchAll()) {
1215 nextBlock = catchScope.getHandler(i+1).Block;
1216 nextIsEnd = true;
1217
1218 // Otherwise, we're not at the end and we need a new block.
1219 } else {
1220 nextBlock = CGF.createBasicBlock("catch.fallthrough");
1221 nextIsEnd = false;
1222 }
1223
1224 // Figure out the catch type's index in the LSDA's type table.
1225 llvm::CallInst *typeIndex =
1226 CGF.Builder.CreateCall(llvm_eh_typeid_for, typeValue);
1227 typeIndex->setDoesNotThrow();
1228
1229 llvm::Value *matchesTypeIndex =
1230 CGF.Builder.CreateICmpEQ(selector, typeIndex, "matches");
1231 CGF.Builder.CreateCondBr(matchesTypeIndex, handler.Block, nextBlock);
1232
1233 // If the next handler is a catch-all, we're completely done.
1234 if (nextIsEnd) {
1235 CGF.Builder.restoreIP(savedIP);
1236 return;
John McCall8e4c74b2011-08-11 02:22:43 +00001237 }
Ahmed Charles289896d2012-02-19 11:57:29 +00001238 // Otherwise we need to emit and continue at that block.
1239 CGF.EmitBlock(nextBlock);
John McCall8e4c74b2011-08-11 02:22:43 +00001240 }
John McCall8e4c74b2011-08-11 02:22:43 +00001241}
1242
1243void CodeGenFunction::popCatchScope() {
1244 EHCatchScope &catchScope = cast<EHCatchScope>(*EHStack.begin());
1245 if (catchScope.hasEHBranches())
1246 emitCatchDispatchBlock(*this, catchScope);
1247 EHStack.popCatch();
1248}
1249
John McCallb609d3f2010-07-07 06:56:46 +00001250void CodeGenFunction::ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock) {
John McCallbd309292010-07-06 01:34:17 +00001251 unsigned NumHandlers = S.getNumHandlers();
1252 EHCatchScope &CatchScope = cast<EHCatchScope>(*EHStack.begin());
1253 assert(CatchScope.getNumHandlers() == NumHandlers);
Mike Stump58ef18b2009-11-20 23:44:51 +00001254
John McCall8e4c74b2011-08-11 02:22:43 +00001255 // If the catch was not required, bail out now.
1256 if (!CatchScope.hasEHBranches()) {
Kostya Serebryanyba4aced2014-01-09 09:22:32 +00001257 CatchScope.clearHandlerBlocks();
John McCall8e4c74b2011-08-11 02:22:43 +00001258 EHStack.popCatch();
1259 return;
1260 }
1261
1262 // Emit the structure of the EH dispatch for this catch.
1263 emitCatchDispatchBlock(*this, CatchScope);
1264
John McCallbd309292010-07-06 01:34:17 +00001265 // Copy the handler blocks off before we pop the EH stack. Emitting
1266 // the handlers might scribble on this memory.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001267 SmallVector<EHCatchScope::Handler, 8> Handlers(NumHandlers);
John McCallbd309292010-07-06 01:34:17 +00001268 memcpy(Handlers.data(), CatchScope.begin(),
1269 NumHandlers * sizeof(EHCatchScope::Handler));
John McCall8e4c74b2011-08-11 02:22:43 +00001270
John McCallbd309292010-07-06 01:34:17 +00001271 EHStack.popCatch();
Mike Stump58ef18b2009-11-20 23:44:51 +00001272
John McCallbd309292010-07-06 01:34:17 +00001273 // The fall-through block.
1274 llvm::BasicBlock *ContBB = createBasicBlock("try.cont");
Mike Stump58ef18b2009-11-20 23:44:51 +00001275
John McCallbd309292010-07-06 01:34:17 +00001276 // We just emitted the body of the try; jump to the continue block.
1277 if (HaveInsertPoint())
1278 Builder.CreateBr(ContBB);
Mike Stump97329152009-12-02 19:53:57 +00001279
John McCalld8d00be2012-06-15 05:27:05 +00001280 // Determine if we need an implicit rethrow for all these catch handlers;
1281 // see the comment below.
1282 bool doImplicitRethrow = false;
John McCallb609d3f2010-07-07 06:56:46 +00001283 if (IsFnTryBlock)
John McCalld8d00be2012-06-15 05:27:05 +00001284 doImplicitRethrow = isa<CXXDestructorDecl>(CurCodeDecl) ||
1285 isa<CXXConstructorDecl>(CurCodeDecl);
John McCallb609d3f2010-07-07 06:56:46 +00001286
John McCall8e4c74b2011-08-11 02:22:43 +00001287 // Perversely, we emit the handlers backwards precisely because we
1288 // want them to appear in source order. In all of these cases, the
1289 // catch block will have exactly one predecessor, which will be a
1290 // particular block in the catch dispatch. However, in the case of
1291 // a catch-all, one of the dispatch blocks will branch to two
1292 // different handlers, and EmitBlockAfterUses will cause the second
1293 // handler to be moved before the first.
1294 for (unsigned I = NumHandlers; I != 0; --I) {
1295 llvm::BasicBlock *CatchBlock = Handlers[I-1].Block;
1296 EmitBlockAfterUses(CatchBlock);
Mike Stump75546b82009-12-10 00:06:18 +00001297
John McCallbd309292010-07-06 01:34:17 +00001298 // Catch the exception if this isn't a catch-all.
John McCall8e4c74b2011-08-11 02:22:43 +00001299 const CXXCatchStmt *C = S.getHandler(I-1);
Mike Stump58ef18b2009-11-20 23:44:51 +00001300
John McCallbd309292010-07-06 01:34:17 +00001301 // Enter a cleanup scope, including the catch variable and the
1302 // end-catch.
1303 RunCleanupsScope CatchScope(*this);
Mike Stump58ef18b2009-11-20 23:44:51 +00001304
John McCallbd309292010-07-06 01:34:17 +00001305 // Initialize the catch variable and set up the cleanups.
1306 BeginCatch(*this, C);
1307
Justin Bognerea278c32014-01-07 00:20:28 +00001308 // Emit the PGO counter increment.
Justin Bogneref512b92014-01-06 22:27:43 +00001309 RegionCounter CatchCnt = getPGORegionCounter(C);
1310 CatchCnt.beginRegion(Builder);
1311
John McCallbd309292010-07-06 01:34:17 +00001312 // Perform the body of the catch.
1313 EmitStmt(C->getHandlerBlock());
1314
John McCalld8d00be2012-06-15 05:27:05 +00001315 // [except.handle]p11:
1316 // The currently handled exception is rethrown if control
1317 // reaches the end of a handler of the function-try-block of a
1318 // constructor or destructor.
1319
1320 // It is important that we only do this on fallthrough and not on
1321 // return. Note that it's illegal to put a return in a
1322 // constructor function-try-block's catch handler (p14), so this
1323 // really only applies to destructors.
1324 if (doImplicitRethrow && HaveInsertPoint()) {
David Majnemer442d0a22014-11-25 07:20:20 +00001325 CGM.getCXXABI().emitRethrow(*this, /*isNoReturn*/false);
John McCalld8d00be2012-06-15 05:27:05 +00001326 Builder.CreateUnreachable();
1327 Builder.ClearInsertionPoint();
1328 }
1329
John McCallbd309292010-07-06 01:34:17 +00001330 // Fall out through the catch cleanups.
1331 CatchScope.ForceCleanup();
1332
1333 // Branch out of the try.
1334 if (HaveInsertPoint())
1335 Builder.CreateBr(ContBB);
Mike Stump58ef18b2009-11-20 23:44:51 +00001336 }
1337
Justin Bogneref512b92014-01-06 22:27:43 +00001338 RegionCounter ContCnt = getPGORegionCounter(&S);
John McCallbd309292010-07-06 01:34:17 +00001339 EmitBlock(ContBB);
Justin Bogneref512b92014-01-06 22:27:43 +00001340 ContCnt.beginRegion(Builder);
Mike Stump58ef18b2009-11-20 23:44:51 +00001341}
Mike Stumpaff69af2009-12-09 03:35:49 +00001342
John McCall1e670402010-07-21 00:52:03 +00001343namespace {
John McCallcda666c2010-07-21 07:22:38 +00001344 struct CallEndCatchForFinally : EHScopeStack::Cleanup {
John McCall1e670402010-07-21 00:52:03 +00001345 llvm::Value *ForEHVar;
1346 llvm::Value *EndCatchFn;
1347 CallEndCatchForFinally(llvm::Value *ForEHVar, llvm::Value *EndCatchFn)
1348 : ForEHVar(ForEHVar), EndCatchFn(EndCatchFn) {}
1349
Craig Topper4f12f102014-03-12 06:41:41 +00001350 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall1e670402010-07-21 00:52:03 +00001351 llvm::BasicBlock *EndCatchBB = CGF.createBasicBlock("finally.endcatch");
1352 llvm::BasicBlock *CleanupContBB =
1353 CGF.createBasicBlock("finally.cleanup.cont");
1354
1355 llvm::Value *ShouldEndCatch =
1356 CGF.Builder.CreateLoad(ForEHVar, "finally.endcatch");
1357 CGF.Builder.CreateCondBr(ShouldEndCatch, EndCatchBB, CleanupContBB);
1358 CGF.EmitBlock(EndCatchBB);
John McCall882987f2013-02-28 19:01:20 +00001359 CGF.EmitRuntimeCallOrInvoke(EndCatchFn); // catch-all, so might throw
John McCall1e670402010-07-21 00:52:03 +00001360 CGF.EmitBlock(CleanupContBB);
1361 }
1362 };
John McCall906da4b2010-07-21 05:47:49 +00001363
John McCallcda666c2010-07-21 07:22:38 +00001364 struct PerformFinally : EHScopeStack::Cleanup {
John McCall906da4b2010-07-21 05:47:49 +00001365 const Stmt *Body;
1366 llvm::Value *ForEHVar;
1367 llvm::Value *EndCatchFn;
1368 llvm::Value *RethrowFn;
1369 llvm::Value *SavedExnVar;
1370
1371 PerformFinally(const Stmt *Body, llvm::Value *ForEHVar,
1372 llvm::Value *EndCatchFn,
1373 llvm::Value *RethrowFn, llvm::Value *SavedExnVar)
1374 : Body(Body), ForEHVar(ForEHVar), EndCatchFn(EndCatchFn),
1375 RethrowFn(RethrowFn), SavedExnVar(SavedExnVar) {}
1376
Craig Topper4f12f102014-03-12 06:41:41 +00001377 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall906da4b2010-07-21 05:47:49 +00001378 // Enter a cleanup to call the end-catch function if one was provided.
1379 if (EndCatchFn)
John McCallcda666c2010-07-21 07:22:38 +00001380 CGF.EHStack.pushCleanup<CallEndCatchForFinally>(NormalAndEHCleanup,
1381 ForEHVar, EndCatchFn);
John McCall906da4b2010-07-21 05:47:49 +00001382
John McCallcebe0ca2010-08-11 00:16:14 +00001383 // Save the current cleanup destination in case there are
1384 // cleanups in the finally block.
1385 llvm::Value *SavedCleanupDest =
1386 CGF.Builder.CreateLoad(CGF.getNormalCleanupDestSlot(),
1387 "cleanup.dest.saved");
1388
John McCall906da4b2010-07-21 05:47:49 +00001389 // Emit the finally block.
1390 CGF.EmitStmt(Body);
1391
1392 // If the end of the finally is reachable, check whether this was
1393 // for EH. If so, rethrow.
1394 if (CGF.HaveInsertPoint()) {
1395 llvm::BasicBlock *RethrowBB = CGF.createBasicBlock("finally.rethrow");
1396 llvm::BasicBlock *ContBB = CGF.createBasicBlock("finally.cont");
1397
1398 llvm::Value *ShouldRethrow =
1399 CGF.Builder.CreateLoad(ForEHVar, "finally.shouldthrow");
1400 CGF.Builder.CreateCondBr(ShouldRethrow, RethrowBB, ContBB);
1401
1402 CGF.EmitBlock(RethrowBB);
1403 if (SavedExnVar) {
John McCall882987f2013-02-28 19:01:20 +00001404 CGF.EmitRuntimeCallOrInvoke(RethrowFn,
1405 CGF.Builder.CreateLoad(SavedExnVar));
John McCall906da4b2010-07-21 05:47:49 +00001406 } else {
John McCall882987f2013-02-28 19:01:20 +00001407 CGF.EmitRuntimeCallOrInvoke(RethrowFn);
John McCall906da4b2010-07-21 05:47:49 +00001408 }
1409 CGF.Builder.CreateUnreachable();
1410
1411 CGF.EmitBlock(ContBB);
John McCallcebe0ca2010-08-11 00:16:14 +00001412
1413 // Restore the cleanup destination.
1414 CGF.Builder.CreateStore(SavedCleanupDest,
1415 CGF.getNormalCleanupDestSlot());
John McCall906da4b2010-07-21 05:47:49 +00001416 }
1417
1418 // Leave the end-catch cleanup. As an optimization, pretend that
1419 // the fallthrough path was inaccessible; we've dynamically proven
1420 // that we're not in the EH case along that path.
1421 if (EndCatchFn) {
1422 CGBuilderTy::InsertPoint SavedIP = CGF.Builder.saveAndClearIP();
1423 CGF.PopCleanupBlock();
1424 CGF.Builder.restoreIP(SavedIP);
1425 }
1426
1427 // Now make sure we actually have an insertion point or the
1428 // cleanup gods will hate us.
1429 CGF.EnsureInsertPoint();
1430 }
1431 };
John McCall1e670402010-07-21 00:52:03 +00001432}
1433
John McCallbd309292010-07-06 01:34:17 +00001434/// Enters a finally block for an implementation using zero-cost
1435/// exceptions. This is mostly general, but hard-codes some
1436/// language/ABI-specific behavior in the catch-all sections.
John McCall6b0feb72011-06-22 02:32:12 +00001437void CodeGenFunction::FinallyInfo::enter(CodeGenFunction &CGF,
1438 const Stmt *body,
1439 llvm::Constant *beginCatchFn,
1440 llvm::Constant *endCatchFn,
1441 llvm::Constant *rethrowFn) {
Craig Topper8a13c412014-05-21 05:09:00 +00001442 assert((beginCatchFn != nullptr) == (endCatchFn != nullptr) &&
John McCallbd309292010-07-06 01:34:17 +00001443 "begin/end catch functions not paired");
John McCall6b0feb72011-06-22 02:32:12 +00001444 assert(rethrowFn && "rethrow function is required");
1445
1446 BeginCatchFn = beginCatchFn;
Mike Stumpaff69af2009-12-09 03:35:49 +00001447
John McCallbd309292010-07-06 01:34:17 +00001448 // The rethrow function has one of the following two types:
1449 // void (*)()
1450 // void (*)(void*)
1451 // In the latter case we need to pass it the exception object.
1452 // But we can't use the exception slot because the @finally might
1453 // have a landing pad (which would overwrite the exception slot).
Chris Lattner2192fe52011-07-18 04:24:23 +00001454 llvm::FunctionType *rethrowFnTy =
John McCallbd309292010-07-06 01:34:17 +00001455 cast<llvm::FunctionType>(
John McCall6b0feb72011-06-22 02:32:12 +00001456 cast<llvm::PointerType>(rethrowFn->getType())->getElementType());
Craig Topper8a13c412014-05-21 05:09:00 +00001457 SavedExnVar = nullptr;
John McCall6b0feb72011-06-22 02:32:12 +00001458 if (rethrowFnTy->getNumParams())
1459 SavedExnVar = CGF.CreateTempAlloca(CGF.Int8PtrTy, "finally.exn");
Mike Stumpaff69af2009-12-09 03:35:49 +00001460
John McCallbd309292010-07-06 01:34:17 +00001461 // A finally block is a statement which must be executed on any edge
1462 // out of a given scope. Unlike a cleanup, the finally block may
1463 // contain arbitrary control flow leading out of itself. In
1464 // addition, finally blocks should always be executed, even if there
1465 // are no catch handlers higher on the stack. Therefore, we
1466 // surround the protected scope with a combination of a normal
1467 // cleanup (to catch attempts to break out of the block via normal
1468 // control flow) and an EH catch-all (semantically "outside" any try
1469 // statement to which the finally block might have been attached).
1470 // The finally block itself is generated in the context of a cleanup
1471 // which conditionally leaves the catch-all.
John McCall21886962010-04-21 10:05:39 +00001472
John McCallbd309292010-07-06 01:34:17 +00001473 // Jump destination for performing the finally block on an exception
1474 // edge. We'll never actually reach this block, so unreachable is
1475 // fine.
John McCall6b0feb72011-06-22 02:32:12 +00001476 RethrowDest = CGF.getJumpDestInCurrentScope(CGF.getUnreachableBlock());
John McCall21886962010-04-21 10:05:39 +00001477
John McCallbd309292010-07-06 01:34:17 +00001478 // Whether the finally block is being executed for EH purposes.
John McCall6b0feb72011-06-22 02:32:12 +00001479 ForEHVar = CGF.CreateTempAlloca(CGF.Builder.getInt1Ty(), "finally.for-eh");
1480 CGF.Builder.CreateStore(CGF.Builder.getFalse(), ForEHVar);
Mike Stumpaff69af2009-12-09 03:35:49 +00001481
John McCallbd309292010-07-06 01:34:17 +00001482 // Enter a normal cleanup which will perform the @finally block.
John McCall6b0feb72011-06-22 02:32:12 +00001483 CGF.EHStack.pushCleanup<PerformFinally>(NormalCleanup, body,
1484 ForEHVar, endCatchFn,
1485 rethrowFn, SavedExnVar);
John McCallbd309292010-07-06 01:34:17 +00001486
1487 // Enter a catch-all scope.
John McCall6b0feb72011-06-22 02:32:12 +00001488 llvm::BasicBlock *catchBB = CGF.createBasicBlock("finally.catchall");
1489 EHCatchScope *catchScope = CGF.EHStack.pushCatch(1);
1490 catchScope->setCatchAllHandler(0, catchBB);
John McCallbd309292010-07-06 01:34:17 +00001491}
1492
John McCall6b0feb72011-06-22 02:32:12 +00001493void CodeGenFunction::FinallyInfo::exit(CodeGenFunction &CGF) {
John McCallbd309292010-07-06 01:34:17 +00001494 // Leave the finally catch-all.
John McCall6b0feb72011-06-22 02:32:12 +00001495 EHCatchScope &catchScope = cast<EHCatchScope>(*CGF.EHStack.begin());
1496 llvm::BasicBlock *catchBB = catchScope.getHandler(0).Block;
John McCall8e4c74b2011-08-11 02:22:43 +00001497
1498 CGF.popCatchScope();
John McCallbd309292010-07-06 01:34:17 +00001499
John McCall6b0feb72011-06-22 02:32:12 +00001500 // If there are any references to the catch-all block, emit it.
1501 if (catchBB->use_empty()) {
1502 delete catchBB;
1503 } else {
1504 CGBuilderTy::InsertPoint savedIP = CGF.Builder.saveAndClearIP();
1505 CGF.EmitBlock(catchBB);
John McCallbd309292010-07-06 01:34:17 +00001506
Craig Topper8a13c412014-05-21 05:09:00 +00001507 llvm::Value *exn = nullptr;
John McCallbd309292010-07-06 01:34:17 +00001508
John McCall6b0feb72011-06-22 02:32:12 +00001509 // If there's a begin-catch function, call it.
1510 if (BeginCatchFn) {
Bill Wendling79a70e42011-09-15 18:57:19 +00001511 exn = CGF.getExceptionFromSlot();
John McCall882987f2013-02-28 19:01:20 +00001512 CGF.EmitNounwindRuntimeCall(BeginCatchFn, exn);
John McCall6b0feb72011-06-22 02:32:12 +00001513 }
1514
1515 // If we need to remember the exception pointer to rethrow later, do so.
1516 if (SavedExnVar) {
Bill Wendling79a70e42011-09-15 18:57:19 +00001517 if (!exn) exn = CGF.getExceptionFromSlot();
John McCall6b0feb72011-06-22 02:32:12 +00001518 CGF.Builder.CreateStore(exn, SavedExnVar);
1519 }
1520
1521 // Tell the cleanups in the finally block that we're do this for EH.
1522 CGF.Builder.CreateStore(CGF.Builder.getTrue(), ForEHVar);
1523
1524 // Thread a jump through the finally cleanup.
1525 CGF.EmitBranchThroughCleanup(RethrowDest);
1526
1527 CGF.Builder.restoreIP(savedIP);
1528 }
1529
1530 // Finally, leave the @finally cleanup.
1531 CGF.PopCleanupBlock();
John McCallbd309292010-07-06 01:34:17 +00001532}
1533
John McCalle142ad52013-02-12 03:51:46 +00001534/// In a terminate landing pad, should we use __clang__call_terminate
1535/// or just a naked call to std::terminate?
1536///
1537/// __clang_call_terminate calls __cxa_begin_catch, which then allows
1538/// std::terminate to usefully report something about the
1539/// violating exception.
1540static bool useClangCallTerminate(CodeGenModule &CGM) {
1541 // Only do this for Itanium-family ABIs in C++ mode.
1542 return (CGM.getLangOpts().CPlusPlus &&
1543 CGM.getTarget().getCXXABI().isItaniumFamily());
1544}
1545
1546/// Get or define the following function:
1547/// void @__clang_call_terminate(i8* %exn) nounwind noreturn
1548/// This code is used only in C++.
1549static llvm::Constant *getClangCallTerminateFn(CodeGenModule &CGM) {
1550 llvm::FunctionType *fnTy =
1551 llvm::FunctionType::get(CGM.VoidTy, CGM.Int8PtrTy, /*IsVarArgs=*/false);
1552 llvm::Constant *fnRef =
1553 CGM.CreateRuntimeFunction(fnTy, "__clang_call_terminate");
1554
1555 llvm::Function *fn = dyn_cast<llvm::Function>(fnRef);
1556 if (fn && fn->empty()) {
1557 fn->setDoesNotThrow();
1558 fn->setDoesNotReturn();
1559
1560 // What we really want is to massively penalize inlining without
1561 // forbidding it completely. The difference between that and
1562 // 'noinline' is negligible.
1563 fn->addFnAttr(llvm::Attribute::NoInline);
1564
1565 // Allow this function to be shared across translation units, but
1566 // we don't want it to turn into an exported symbol.
1567 fn->setLinkage(llvm::Function::LinkOnceODRLinkage);
1568 fn->setVisibility(llvm::Function::HiddenVisibility);
Reid Kleckner4c209c72015-02-11 18:50:13 +00001569 if (CGM.supportsCOMDAT())
1570 fn->setComdat(CGM.getModule().getOrInsertComdat(fn->getName()));
John McCalle142ad52013-02-12 03:51:46 +00001571
1572 // Set up the function.
1573 llvm::BasicBlock *entry =
1574 llvm::BasicBlock::Create(CGM.getLLVMContext(), "", fn);
1575 CGBuilderTy builder(entry);
1576
1577 // Pull the exception pointer out of the parameter list.
1578 llvm::Value *exn = &*fn->arg_begin();
1579
1580 // Call __cxa_begin_catch(exn).
John McCall882987f2013-02-28 19:01:20 +00001581 llvm::CallInst *catchCall = builder.CreateCall(getBeginCatchFn(CGM), exn);
1582 catchCall->setDoesNotThrow();
1583 catchCall->setCallingConv(CGM.getRuntimeCC());
John McCalle142ad52013-02-12 03:51:46 +00001584
1585 // Call std::terminate().
1586 llvm::CallInst *termCall = builder.CreateCall(getTerminateFn(CGM));
1587 termCall->setDoesNotThrow();
1588 termCall->setDoesNotReturn();
John McCall882987f2013-02-28 19:01:20 +00001589 termCall->setCallingConv(CGM.getRuntimeCC());
John McCalle142ad52013-02-12 03:51:46 +00001590
1591 // std::terminate cannot return.
1592 builder.CreateUnreachable();
1593 }
1594
1595 return fnRef;
1596}
1597
John McCallbd309292010-07-06 01:34:17 +00001598llvm::BasicBlock *CodeGenFunction::getTerminateLandingPad() {
1599 if (TerminateLandingPad)
1600 return TerminateLandingPad;
1601
1602 CGBuilderTy::InsertPoint SavedIP = Builder.saveAndClearIP();
1603
1604 // This will get inserted at the end of the function.
1605 TerminateLandingPad = createBasicBlock("terminate.lpad");
1606 Builder.SetInsertPoint(TerminateLandingPad);
1607
1608 // Tell the backend that this is a landing pad.
Reid Klecknerdeeddec2015-02-05 18:56:03 +00001609 const EHPersonality &Personality = EHPersonality::get(*this);
Bill Wendlingf0724e82011-09-19 20:31:14 +00001610 llvm::LandingPadInst *LPadInst =
Reid Kleckneree7cf842014-12-01 22:02:27 +00001611 Builder.CreateLandingPad(llvm::StructType::get(Int8PtrTy, Int32Ty, nullptr),
Bill Wendlingf0724e82011-09-19 20:31:14 +00001612 getOpaquePersonalityFn(CGM, Personality), 0);
1613 LPadInst->addClause(getCatchAllValue(*this));
John McCallbd309292010-07-06 01:34:17 +00001614
John McCalle142ad52013-02-12 03:51:46 +00001615 llvm::CallInst *terminateCall;
1616 if (useClangCallTerminate(CGM)) {
1617 // Extract out the exception pointer.
1618 llvm::Value *exn = Builder.CreateExtractValue(LPadInst, 0);
John McCall882987f2013-02-28 19:01:20 +00001619 terminateCall = EmitNounwindRuntimeCall(getClangCallTerminateFn(CGM), exn);
John McCalle142ad52013-02-12 03:51:46 +00001620 } else {
John McCall882987f2013-02-28 19:01:20 +00001621 terminateCall = EmitNounwindRuntimeCall(getTerminateFn(CGM));
John McCalle142ad52013-02-12 03:51:46 +00001622 }
1623 terminateCall->setDoesNotReturn();
John McCallad7c5c12011-02-08 08:22:06 +00001624 Builder.CreateUnreachable();
Mike Stumpaff69af2009-12-09 03:35:49 +00001625
John McCallbd309292010-07-06 01:34:17 +00001626 // Restore the saved insertion state.
1627 Builder.restoreIP(SavedIP);
John McCalldac3ea62010-04-30 00:06:43 +00001628
John McCallbd309292010-07-06 01:34:17 +00001629 return TerminateLandingPad;
Mike Stumpaff69af2009-12-09 03:35:49 +00001630}
Mike Stump2b488872009-12-09 22:59:31 +00001631
1632llvm::BasicBlock *CodeGenFunction::getTerminateHandler() {
Mike Stumpf5cbb082009-12-10 00:02:42 +00001633 if (TerminateHandler)
1634 return TerminateHandler;
1635
John McCallbd309292010-07-06 01:34:17 +00001636 CGBuilderTy::InsertPoint SavedIP = Builder.saveAndClearIP();
Mike Stump25b20fc2009-12-09 23:31:35 +00001637
John McCallbd309292010-07-06 01:34:17 +00001638 // Set up the terminate handler. This block is inserted at the very
1639 // end of the function by FinishFunction.
Mike Stumpf5cbb082009-12-10 00:02:42 +00001640 TerminateHandler = createBasicBlock("terminate.handler");
John McCallbd309292010-07-06 01:34:17 +00001641 Builder.SetInsertPoint(TerminateHandler);
John McCallc84e4e92013-06-20 21:37:43 +00001642 llvm::CallInst *terminateCall;
1643 if (useClangCallTerminate(CGM)) {
1644 // Load the exception pointer.
1645 llvm::Value *exn = getExceptionFromSlot();
1646 terminateCall = EmitNounwindRuntimeCall(getClangCallTerminateFn(CGM), exn);
1647 } else {
1648 terminateCall = EmitNounwindRuntimeCall(getTerminateFn(CGM));
1649 }
1650 terminateCall->setDoesNotReturn();
Mike Stump2b488872009-12-09 22:59:31 +00001651 Builder.CreateUnreachable();
1652
John McCall21886962010-04-21 10:05:39 +00001653 // Restore the saved insertion state.
John McCallbd309292010-07-06 01:34:17 +00001654 Builder.restoreIP(SavedIP);
Mike Stump25b20fc2009-12-09 23:31:35 +00001655
Mike Stump2b488872009-12-09 22:59:31 +00001656 return TerminateHandler;
1657}
John McCallbd309292010-07-06 01:34:17 +00001658
David Chisnall9a837be2012-11-07 16:50:40 +00001659llvm::BasicBlock *CodeGenFunction::getEHResumeBlock(bool isCleanup) {
John McCall8e4c74b2011-08-11 02:22:43 +00001660 if (EHResumeBlock) return EHResumeBlock;
John McCallad5d61e2010-07-23 21:56:41 +00001661
1662 CGBuilderTy::InsertPoint SavedIP = Builder.saveIP();
1663
1664 // We emit a jump to a notional label at the outermost unwind state.
John McCall8e4c74b2011-08-11 02:22:43 +00001665 EHResumeBlock = createBasicBlock("eh.resume");
1666 Builder.SetInsertPoint(EHResumeBlock);
John McCallad5d61e2010-07-23 21:56:41 +00001667
Reid Klecknerdeeddec2015-02-05 18:56:03 +00001668 const EHPersonality &Personality = EHPersonality::get(*this);
John McCallad5d61e2010-07-23 21:56:41 +00001669
1670 // This can always be a call because we necessarily didn't find
1671 // anything on the EH stack which needs our help.
Benjamin Kramer793bd552012-02-08 12:41:24 +00001672 const char *RethrowName = Personality.CatchallRethrowFn;
Craig Topper8a13c412014-05-21 05:09:00 +00001673 if (RethrowName != nullptr && !isCleanup) {
John McCall882987f2013-02-28 19:01:20 +00001674 EmitRuntimeCall(getCatchallRethrowFn(CGM, RethrowName),
Logan Chiene9c8ccb2014-07-01 11:47:10 +00001675 getExceptionFromSlot())
John McCall9b382dd2011-05-28 21:13:02 +00001676 ->setDoesNotReturn();
Logan Chiene9c8ccb2014-07-01 11:47:10 +00001677 Builder.CreateUnreachable();
1678 Builder.restoreIP(SavedIP);
1679 return EHResumeBlock;
John McCall9b382dd2011-05-28 21:13:02 +00001680 }
1681
Logan Chiene9c8ccb2014-07-01 11:47:10 +00001682 // Recreate the landingpad's return value for the 'resume' instruction.
1683 llvm::Value *Exn = getExceptionFromSlot();
1684 llvm::Value *Sel = getSelectorFromSlot();
John McCallad5d61e2010-07-23 21:56:41 +00001685
Logan Chiene9c8ccb2014-07-01 11:47:10 +00001686 llvm::Type *LPadType = llvm::StructType::get(Exn->getType(),
Reid Kleckneree7cf842014-12-01 22:02:27 +00001687 Sel->getType(), nullptr);
Logan Chiene9c8ccb2014-07-01 11:47:10 +00001688 llvm::Value *LPadVal = llvm::UndefValue::get(LPadType);
1689 LPadVal = Builder.CreateInsertValue(LPadVal, Exn, 0, "lpad.val");
1690 LPadVal = Builder.CreateInsertValue(LPadVal, Sel, 1, "lpad.val");
1691
1692 Builder.CreateResume(LPadVal);
John McCallad5d61e2010-07-23 21:56:41 +00001693 Builder.restoreIP(SavedIP);
John McCall8e4c74b2011-08-11 02:22:43 +00001694 return EHResumeBlock;
John McCallad5d61e2010-07-23 21:56:41 +00001695}
Reid Kleckner543a16c2013-09-16 21:46:30 +00001696
1697void CodeGenFunction::EmitSEHTryStmt(const SEHTryStmt &S) {
Reid Kleckner1d59f992015-01-22 01:36:17 +00001698 // FIXME: Implement SEH on other architectures.
1699 const llvm::Triple &T = CGM.getTarget().getTriple();
1700 if (T.getArch() != llvm::Triple::x86_64 ||
1701 !T.isKnownWindowsMSVCEnvironment()) {
1702 ErrorUnsupported(&S, "__try statement");
1703 return;
1704 }
1705
Reid Kleckneraca01db2015-02-04 22:37:07 +00001706 SEHFinallyInfo FI;
1707 EnterSEHTryStmt(S, FI);
Reid Klecknera5930002015-02-11 21:40:48 +00001708 {
Nico Weber5779f842015-02-12 23:16:11 +00001709 JumpDest TryExit = getJumpDestInCurrentScope("__try.__leave");
Nico Weber5779f842015-02-12 23:16:11 +00001710
Reid Kleckner11c033e2015-02-12 23:40:45 +00001711 SEHTryEpilogueStack.push_back(&TryExit);
Reid Klecknera5930002015-02-11 21:40:48 +00001712 EmitStmt(S.getTryBlock());
Reid Kleckner11c033e2015-02-12 23:40:45 +00001713 SEHTryEpilogueStack.pop_back();
Nico Weber5779f842015-02-12 23:16:11 +00001714
1715 if (!TryExit.getBlock()->use_empty())
1716 EmitBlock(TryExit.getBlock(), /*IsFinished=*/true);
1717 else
1718 delete TryExit.getBlock();
Reid Klecknera5930002015-02-11 21:40:48 +00001719 }
Reid Kleckneraca01db2015-02-04 22:37:07 +00001720 ExitSEHTryStmt(S, FI);
Reid Kleckner1d59f992015-01-22 01:36:17 +00001721}
1722
1723namespace {
1724struct PerformSEHFinally : EHScopeStack::Cleanup {
Reid Kleckneraca01db2015-02-04 22:37:07 +00001725 CodeGenFunction::SEHFinallyInfo *FI;
1726 PerformSEHFinally(CodeGenFunction::SEHFinallyInfo *FI) : FI(FI) {}
1727
Reid Kleckner1d59f992015-01-22 01:36:17 +00001728 void Emit(CodeGenFunction &CGF, Flags F) override {
Reid Kleckneraca01db2015-02-04 22:37:07 +00001729 // Cleanups are emitted at most twice: once for normal control flow and once
1730 // for exception control flow. Branch into the finally block, and remember
1731 // the continuation block so we can branch out later.
1732 if (!FI->FinallyBB) {
1733 FI->FinallyBB = CGF.createBasicBlock("__finally");
1734 FI->FinallyBB->insertInto(CGF.CurFn);
1735 FI->FinallyBB->moveAfter(CGF.Builder.GetInsertBlock());
1736 }
1737
1738 // Set the termination status and branch in.
1739 CGF.Builder.CreateStore(
1740 llvm::ConstantInt::get(CGF.Int8Ty, F.isForEHCleanup()),
1741 CGF.getAbnormalTerminationSlot());
1742 CGF.Builder.CreateBr(FI->FinallyBB);
1743
1744 // Create a continuation block for normal or exceptional control.
1745 if (F.isForEHCleanup()) {
1746 assert(!FI->ResumeBB && "double emission for EH");
1747 FI->ResumeBB = CGF.createBasicBlock("__finally.resume");
1748 CGF.EmitBlock(FI->ResumeBB);
1749 } else {
1750 assert(F.isForNormalCleanup() && !FI->ContBB && "double normal emission");
1751 FI->ContBB = CGF.createBasicBlock("__finally.cont");
1752 CGF.EmitBlock(FI->ContBB);
1753 // Try to keep source order.
1754 FI->ContBB->moveAfter(FI->FinallyBB);
1755 }
Reid Kleckner1d59f992015-01-22 01:36:17 +00001756 }
1757};
1758}
1759
1760/// Create a stub filter function that will ultimately hold the code of the
1761/// filter expression. The EH preparation passes in LLVM will outline the code
1762/// from the main function body into this stub.
1763llvm::Function *
1764CodeGenFunction::GenerateSEHFilterFunction(CodeGenFunction &ParentCGF,
1765 const SEHExceptStmt &Except) {
1766 const Decl *ParentCodeDecl = ParentCGF.CurCodeDecl;
1767 llvm::Function *ParentFn = ParentCGF.CurFn;
1768
1769 Expr *FilterExpr = Except.getFilterExpr();
1770
1771 // Get the mangled function name.
1772 SmallString<128> Name;
1773 {
1774 llvm::raw_svector_ostream OS(Name);
1775 const NamedDecl *Parent = dyn_cast_or_null<NamedDecl>(ParentCodeDecl);
1776 assert(Parent && "FIXME: handle unnamed decls (lambdas, blocks) with SEH");
1777 CGM.getCXXABI().getMangleContext().mangleSEHFilterExpression(Parent, OS);
1778 }
1779
1780 // Arrange a function with the declaration:
1781 // int filt(EXCEPTION_POINTERS *exception_pointers, void *frame_pointer)
1782 QualType RetTy = getContext().IntTy;
1783 FunctionArgList Args;
1784 SEHPointersDecl = ImplicitParamDecl::Create(
1785 getContext(), nullptr, FilterExpr->getLocStart(),
1786 &getContext().Idents.get("exception_pointers"), getContext().VoidPtrTy);
1787 Args.push_back(SEHPointersDecl);
1788 Args.push_back(ImplicitParamDecl::Create(
1789 getContext(), nullptr, FilterExpr->getLocStart(),
1790 &getContext().Idents.get("frame_pointer"), getContext().VoidPtrTy));
1791 const CGFunctionInfo &FnInfo = CGM.getTypes().arrangeFreeFunctionDeclaration(
1792 RetTy, Args, FunctionType::ExtInfo(), /*isVariadic=*/false);
1793 llvm::FunctionType *FnTy = CGM.getTypes().GetFunctionType(FnInfo);
1794 llvm::Function *Fn = llvm::Function::Create(FnTy, ParentFn->getLinkage(),
1795 Name.str(), &CGM.getModule());
1796 // The filter is either in the same comdat as the function, or it's internal.
1797 if (llvm::Comdat *C = ParentFn->getComdat()) {
1798 Fn->setComdat(C);
1799 } else if (ParentFn->hasWeakLinkage() || ParentFn->hasLinkOnceLinkage()) {
1800 // FIXME: Unreachable with Rafael's changes?
1801 llvm::Comdat *C = CGM.getModule().getOrInsertComdat(ParentFn->getName());
1802 ParentFn->setComdat(C);
1803 Fn->setComdat(C);
1804 } else {
1805 Fn->setLinkage(llvm::GlobalValue::InternalLinkage);
1806 }
1807
1808 StartFunction(GlobalDecl(), RetTy, Fn, FnInfo, Args,
1809 FilterExpr->getLocStart(), FilterExpr->getLocStart());
1810
1811 EmitSEHExceptionCodeSave();
1812
1813 // Insert dummy allocas for every local variable in scope. We'll initialize
1814 // them and prune the unused ones after we find out which ones were
1815 // referenced.
1816 for (const auto &DeclPtrs : ParentCGF.LocalDeclMap) {
1817 const Decl *VD = DeclPtrs.first;
1818 llvm::Value *Ptr = DeclPtrs.second;
1819 auto *ValTy = cast<llvm::PointerType>(Ptr->getType())->getElementType();
1820 LocalDeclMap[VD] = CreateTempAlloca(ValTy, Ptr->getName() + ".filt");
1821 }
1822
1823 // Emit the original filter expression, convert to i32, and return.
1824 llvm::Value *R = EmitScalarExpr(FilterExpr);
1825 R = Builder.CreateIntCast(R, CGM.IntTy,
1826 FilterExpr->getType()->isSignedIntegerType());
1827 Builder.CreateStore(R, ReturnValue);
1828
1829 FinishFunction(FilterExpr->getLocEnd());
1830
1831 for (const auto &DeclPtrs : ParentCGF.LocalDeclMap) {
1832 const Decl *VD = DeclPtrs.first;
1833 auto *Alloca = cast<llvm::AllocaInst>(LocalDeclMap[VD]);
1834 if (Alloca->hasNUses(0)) {
1835 Alloca->eraseFromParent();
1836 continue;
1837 }
1838 ErrorUnsupported(FilterExpr,
1839 "SEH filter expression local variable capture");
1840 }
1841
1842 return Fn;
1843}
1844
1845void CodeGenFunction::EmitSEHExceptionCodeSave() {
1846 // Save the exception code in the exception slot to unify exception access in
1847 // the filter function and the landing pad.
1848 // struct EXCEPTION_POINTERS {
1849 // EXCEPTION_RECORD *ExceptionRecord;
1850 // CONTEXT *ContextRecord;
1851 // };
1852 // void *exn.slot =
1853 // (void *)(uintptr_t)exception_pointers->ExceptionRecord->ExceptionCode;
1854 llvm::Value *Ptrs = Builder.CreateLoad(GetAddrOfLocalVar(SEHPointersDecl));
1855 llvm::Type *RecordTy = CGM.Int32Ty->getPointerTo();
1856 llvm::Type *PtrsTy = llvm::StructType::get(RecordTy, CGM.VoidPtrTy, nullptr);
1857 Ptrs = Builder.CreateBitCast(Ptrs, PtrsTy->getPointerTo());
1858 llvm::Value *Rec = Builder.CreateStructGEP(Ptrs, 0);
1859 Rec = Builder.CreateLoad(Rec);
1860 llvm::Value *Code = Builder.CreateLoad(Rec);
1861 Code = Builder.CreateZExt(Code, CGM.IntPtrTy);
1862 // FIXME: Change landing pads to produce {i32, i32} and make the exception
1863 // slot an i32.
1864 Code = Builder.CreateIntToPtr(Code, CGM.VoidPtrTy);
1865 Builder.CreateStore(Code, getExceptionSlot());
1866}
1867
1868llvm::Value *CodeGenFunction::EmitSEHExceptionInfo() {
1869 // Sema should diagnose calling this builtin outside of a filter context, but
1870 // don't crash if we screw up.
1871 if (!SEHPointersDecl)
1872 return llvm::UndefValue::get(Int8PtrTy);
1873 return Builder.CreateLoad(GetAddrOfLocalVar(SEHPointersDecl));
1874}
1875
1876llvm::Value *CodeGenFunction::EmitSEHExceptionCode() {
1877 // If we're in a landing pad or filter function, the exception slot contains
1878 // the code.
1879 assert(ExceptionSlot);
1880 llvm::Value *Code =
1881 Builder.CreatePtrToInt(getExceptionFromSlot(), CGM.IntPtrTy);
1882 return Builder.CreateTrunc(Code, CGM.Int32Ty);
1883}
1884
Reid Kleckneraca01db2015-02-04 22:37:07 +00001885llvm::Value *CodeGenFunction::EmitSEHAbnormalTermination() {
1886 // Load from the abnormal termination slot. It will be uninitialized outside
1887 // of __finally blocks, which we should warn or error on.
1888 llvm::Value *IsEH = Builder.CreateLoad(getAbnormalTerminationSlot());
1889 return Builder.CreateZExt(IsEH, Int32Ty);
1890}
1891
1892void CodeGenFunction::EnterSEHTryStmt(const SEHTryStmt &S, SEHFinallyInfo &FI) {
Sean Silvab1287ee2015-02-05 01:20:26 +00001893 if (S.getFinallyHandler()) {
Reid Kleckner1d59f992015-01-22 01:36:17 +00001894 // Push a cleanup for __finally blocks.
Reid Kleckneraca01db2015-02-04 22:37:07 +00001895 EHStack.pushCleanup<PerformSEHFinally>(NormalAndEHCleanup, &FI);
Reid Kleckner1d59f992015-01-22 01:36:17 +00001896 return;
1897 }
1898
1899 // Otherwise, we must have an __except block.
1900 SEHExceptStmt *Except = S.getExceptHandler();
1901 assert(Except);
1902 EHCatchScope *CatchScope = EHStack.pushCatch(1);
Reid Kleckner2a2e1562015-01-22 02:25:56 +00001903
1904 // If the filter is known to evaluate to 1, then we can use the clause "catch
1905 // i8* null".
1906 llvm::Constant *C =
1907 CGM.EmitConstantExpr(Except->getFilterExpr(), getContext().IntTy, this);
1908 if (C && C->isOneValue()) {
1909 CatchScope->setCatchAllHandler(0, createBasicBlock("__except"));
1910 return;
1911 }
1912
1913 // In general, we have to emit an outlined filter function. Use the function
1914 // in place of the RTTI typeinfo global that C++ EH uses.
Reid Kleckner1d59f992015-01-22 01:36:17 +00001915 CodeGenFunction FilterCGF(CGM, /*suppressNewContext=*/true);
1916 llvm::Function *FilterFunc =
1917 FilterCGF.GenerateSEHFilterFunction(*this, *Except);
1918 llvm::Constant *OpaqueFunc =
1919 llvm::ConstantExpr::getBitCast(FilterFunc, Int8PtrTy);
1920 CatchScope->setHandler(0, OpaqueFunc, createBasicBlock("__except"));
1921}
1922
Reid Kleckneraca01db2015-02-04 22:37:07 +00001923void CodeGenFunction::ExitSEHTryStmt(const SEHTryStmt &S, SEHFinallyInfo &FI) {
Reid Kleckner1d59f992015-01-22 01:36:17 +00001924 // Just pop the cleanup if it's a __finally block.
Reid Kleckneraca01db2015-02-04 22:37:07 +00001925 if (const SEHFinallyStmt *Finally = S.getFinallyHandler()) {
Reid Kleckner1d59f992015-01-22 01:36:17 +00001926 PopCleanupBlock();
Reid Kleckner16f9a6b2015-02-05 00:58:46 +00001927 assert(FI.ContBB && "did not emit normal cleanup");
Reid Kleckneraca01db2015-02-04 22:37:07 +00001928
1929 // Emit the code into FinallyBB.
Nico Webere68b9f32015-02-25 16:25:00 +00001930 CGBuilderTy::InsertPoint SavedIP = Builder.saveIP();
Reid Kleckneraca01db2015-02-04 22:37:07 +00001931 Builder.SetInsertPoint(FI.FinallyBB);
1932 EmitStmt(Finally->getBlock());
1933
Reid Kleckner16f9a6b2015-02-05 00:58:46 +00001934 // If the finally block doesn't fall through, we don't need these blocks.
1935 if (!HaveInsertPoint()) {
1936 FI.ContBB->eraseFromParent();
1937 if (FI.ResumeBB)
1938 FI.ResumeBB->eraseFromParent();
1939 return;
1940 }
1941
Reid Kleckneraca01db2015-02-04 22:37:07 +00001942 if (FI.ResumeBB) {
1943 llvm::Value *IsEH = Builder.CreateLoad(getAbnormalTerminationSlot(),
1944 "abnormal.termination");
1945 IsEH = Builder.CreateICmpEQ(IsEH, llvm::ConstantInt::get(Int8Ty, 0));
1946 Builder.CreateCondBr(IsEH, FI.ContBB, FI.ResumeBB);
1947 } else {
1948 // There was nothing exceptional in the try body, so we only have normal
1949 // control flow.
1950 Builder.CreateBr(FI.ContBB);
1951 }
1952
Nico Webere68b9f32015-02-25 16:25:00 +00001953 Builder.restoreIP(SavedIP);
Reid Kleckneraca01db2015-02-04 22:37:07 +00001954
Reid Kleckner1d59f992015-01-22 01:36:17 +00001955 return;
1956 }
1957
1958 // Otherwise, we must have an __except block.
Reid Kleckneraca01db2015-02-04 22:37:07 +00001959 const SEHExceptStmt *Except = S.getExceptHandler();
Reid Kleckner1d59f992015-01-22 01:36:17 +00001960 assert(Except && "__try must have __finally xor __except");
1961 EHCatchScope &CatchScope = cast<EHCatchScope>(*EHStack.begin());
1962
1963 // Don't emit the __except block if the __try block lacked invokes.
1964 // TODO: Model unwind edges from instructions, either with iload / istore or
1965 // a try body function.
1966 if (!CatchScope.hasEHBranches()) {
1967 CatchScope.clearHandlerBlocks();
1968 EHStack.popCatch();
1969 return;
1970 }
1971
1972 // The fall-through block.
1973 llvm::BasicBlock *ContBB = createBasicBlock("__try.cont");
1974
1975 // We just emitted the body of the __try; jump to the continue block.
1976 if (HaveInsertPoint())
1977 Builder.CreateBr(ContBB);
1978
1979 // Check if our filter function returned true.
1980 emitCatchDispatchBlock(*this, CatchScope);
1981
1982 // Grab the block before we pop the handler.
1983 llvm::BasicBlock *ExceptBB = CatchScope.getHandler(0).Block;
1984 EHStack.popCatch();
1985
1986 EmitBlockAfterUses(ExceptBB);
1987
1988 // Emit the __except body.
1989 EmitStmt(Except->getBlock());
1990
Reid Kleckner3a417c32015-01-30 22:16:45 +00001991 if (HaveInsertPoint())
1992 Builder.CreateBr(ContBB);
Reid Kleckner1d59f992015-01-22 01:36:17 +00001993
1994 EmitBlock(ContBB);
Reid Kleckner543a16c2013-09-16 21:46:30 +00001995}
Nico Weber9b982072014-07-07 00:12:30 +00001996
1997void CodeGenFunction::EmitSEHLeaveStmt(const SEHLeaveStmt &S) {
Nico Weber5779f842015-02-12 23:16:11 +00001998 // If this code is reachable then emit a stop point (if generating
1999 // debug info). We have to do this ourselves because we are on the
2000 // "simple" statement path.
2001 if (HaveInsertPoint())
2002 EmitStopPoint(&S);
2003
2004 assert(!SEHTryEpilogueStack.empty() &&
2005 "sema should have rejected this __leave");
2006 EmitBranchThroughCleanup(*SEHTryEpilogueStack.back());
Nico Weber9b982072014-07-07 00:12:30 +00002007}