blob: afad3f930daf3cdcfb9307b9a2d59a0cd26e6538 [file] [log] [blame]
Reid Kleckner0738a9c2015-05-05 17:44:16 +00001//===-- X86WinEHState - Insert EH state updates for win32 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// All functions using an MSVC EH personality use an explicitly updated state
11// number stored in an exception registration stack object. The registration
12// object is linked into a thread-local chain of registrations stored at fs:00.
13// This pass adds the registration object and EH state updates.
14//
15//===----------------------------------------------------------------------===//
16
17#include "X86.h"
18#include "llvm/Analysis/LibCallSemantics.h"
Reid Klecknerfe4d4912015-05-28 22:00:24 +000019#include "llvm/CodeGen/MachineModuleInfo.h"
Reid Kleckner0738a9c2015-05-05 17:44:16 +000020#include "llvm/CodeGen/Passes.h"
21#include "llvm/CodeGen/WinEHFuncInfo.h"
22#include "llvm/IR/Dominators.h"
23#include "llvm/IR/Function.h"
24#include "llvm/IR/IRBuilder.h"
25#include "llvm/IR/Instructions.h"
26#include "llvm/IR/IntrinsicInst.h"
27#include "llvm/IR/Module.h"
28#include "llvm/IR/PatternMatch.h"
29#include "llvm/Pass.h"
30#include "llvm/Support/Debug.h"
31#include "llvm/Support/raw_ostream.h"
32#include "llvm/Transforms/Utils/BasicBlockUtils.h"
33#include "llvm/Transforms/Utils/Cloning.h"
34#include "llvm/Transforms/Utils/Local.h"
35
36using namespace llvm;
37using namespace llvm::PatternMatch;
38
39#define DEBUG_TYPE "winehstate"
40
41namespace {
42class WinEHStatePass : public FunctionPass {
43public:
44 static char ID; // Pass identification, replacement for typeid.
45
46 WinEHStatePass() : FunctionPass(ID) {}
47
48 bool runOnFunction(Function &Fn) override;
49
50 bool doInitialization(Module &M) override;
51
52 bool doFinalization(Module &M) override;
53
54 void getAnalysisUsage(AnalysisUsage &AU) const override;
55
56 const char *getPassName() const override {
57 return "Windows 32-bit x86 EH state insertion";
58 }
59
60private:
61 void emitExceptionRegistrationRecord(Function *F);
62
Reid Kleckner2bc93ca2015-06-10 01:02:30 +000063 void linkExceptionRegistration(IRBuilder<> &Builder, Function *Handler);
Reid Klecknerfe4d4912015-05-28 22:00:24 +000064 void unlinkExceptionRegistration(IRBuilder<> &Builder);
65 void addCXXStateStores(Function &F, MachineModuleInfo &MMI);
Reid Klecknerf12c0302015-06-09 21:42:19 +000066 void addSEHStateStores(Function &F, MachineModuleInfo &MMI);
Reid Klecknerfe4d4912015-05-28 22:00:24 +000067 void addCXXStateStoresToFunclet(Value *ParentRegNode, WinEHFuncInfo &FuncInfo,
68 Function &F, int BaseState);
69 void insertStateNumberStore(Value *ParentRegNode, Instruction *IP, int State);
Reid Klecknerf12c0302015-06-09 21:42:19 +000070 iplist<Instruction>::iterator
71 rewriteExceptionInfoIntrinsics(IntrinsicInst *Intrin);
Reid Kleckner0738a9c2015-05-05 17:44:16 +000072
Reid Kleckner2632f0d2015-05-20 23:08:04 +000073 Value *emitEHLSDA(IRBuilder<> &Builder, Function *F);
74
75 Function *generateLSDAInEAXThunk(Function *ParentFunc);
76
Reid Klecknerfe4d4912015-05-28 22:00:24 +000077 int escapeRegNode(Function &F);
78
Reid Kleckner0738a9c2015-05-05 17:44:16 +000079 // Module-level type getters.
Reid Klecknere6531a552015-05-29 22:57:46 +000080 Type *getEHLinkRegistrationType();
81 Type *getSEHRegistrationType();
82 Type *getCXXEHRegistrationType();
Reid Kleckner0738a9c2015-05-05 17:44:16 +000083
84 // Per-module data.
85 Module *TheModule = nullptr;
Reid Klecknere6531a552015-05-29 22:57:46 +000086 StructType *EHLinkRegistrationTy = nullptr;
87 StructType *CXXEHRegistrationTy = nullptr;
88 StructType *SEHRegistrationTy = nullptr;
Reid Klecknerb7403332015-06-08 22:43:32 +000089 Function *FrameRecover = nullptr;
90 Function *FrameAddress = nullptr;
91 Function *FrameEscape = nullptr;
Reid Kleckner0738a9c2015-05-05 17:44:16 +000092
93 // Per-function state
94 EHPersonality Personality = EHPersonality::Unknown;
95 Function *PersonalityFn = nullptr;
Reid Klecknerfe4d4912015-05-28 22:00:24 +000096
97 /// The stack allocation containing all EH data, including the link in the
98 /// fs:00 chain and the current state.
99 AllocaInst *RegNode = nullptr;
100
101 /// Struct type of RegNode. Used for GEPing.
102 Type *RegNodeTy = nullptr;
103
104 /// The index of the state field of RegNode.
105 int StateFieldIndex = ~0U;
106
107 /// The linked list node subobject inside of RegNode.
108 Value *Link = nullptr;
Reid Kleckner0738a9c2015-05-05 17:44:16 +0000109};
110}
111
112FunctionPass *llvm::createX86WinEHStatePass() { return new WinEHStatePass(); }
113
114char WinEHStatePass::ID = 0;
115
116bool WinEHStatePass::doInitialization(Module &M) {
117 TheModule = &M;
Reid Klecknerb7403332015-06-08 22:43:32 +0000118 FrameEscape = Intrinsic::getDeclaration(TheModule, Intrinsic::frameescape);
119 FrameRecover = Intrinsic::getDeclaration(TheModule, Intrinsic::framerecover);
120 FrameAddress = Intrinsic::getDeclaration(TheModule, Intrinsic::frameaddress);
Reid Kleckner0738a9c2015-05-05 17:44:16 +0000121 return false;
122}
123
124bool WinEHStatePass::doFinalization(Module &M) {
125 assert(TheModule == &M);
126 TheModule = nullptr;
Reid Klecknere6531a552015-05-29 22:57:46 +0000127 EHLinkRegistrationTy = nullptr;
128 CXXEHRegistrationTy = nullptr;
129 SEHRegistrationTy = nullptr;
Reid Klecknerb7403332015-06-08 22:43:32 +0000130 FrameEscape = nullptr;
131 FrameRecover = nullptr;
132 FrameAddress = nullptr;
Reid Kleckner0738a9c2015-05-05 17:44:16 +0000133 return false;
134}
135
136void WinEHStatePass::getAnalysisUsage(AnalysisUsage &AU) const {
137 // This pass should only insert a stack allocation, memory accesses, and
138 // framerecovers.
139 AU.setPreservesCFG();
140}
141
142bool WinEHStatePass::runOnFunction(Function &F) {
Reid Kleckner2632f0d2015-05-20 23:08:04 +0000143 // If this is an outlined handler, don't do anything. We'll do state insertion
144 // for it in the parent.
145 StringRef WinEHParentName =
146 F.getFnAttribute("wineh-parent").getValueAsString();
147 if (WinEHParentName != F.getName() && !WinEHParentName.empty())
148 return false;
149
Reid Kleckner0738a9c2015-05-05 17:44:16 +0000150 // Check the personality. Do nothing if this is not an MSVC personality.
151 LandingPadInst *LP = nullptr;
152 for (BasicBlock &BB : F) {
153 LP = BB.getLandingPadInst();
154 if (LP)
155 break;
156 }
157 if (!LP)
158 return false;
159 PersonalityFn =
160 dyn_cast<Function>(LP->getPersonalityFn()->stripPointerCasts());
161 if (!PersonalityFn)
162 return false;
163 Personality = classifyEHPersonality(PersonalityFn);
164 if (!isMSVCEHPersonality(Personality))
165 return false;
166
Reid Kleckner173a7252015-05-29 21:58:11 +0000167 // Disable frame pointer elimination in this function.
168 // FIXME: Do the nested handlers need to keep the parent ebp in ebp, or can we
169 // use an arbitrary register?
170 F.addFnAttr("no-frame-pointer-elim", "true");
171
Reid Kleckner0738a9c2015-05-05 17:44:16 +0000172 emitExceptionRegistrationRecord(&F);
Reid Klecknerfe4d4912015-05-28 22:00:24 +0000173
174 auto *MMIPtr = getAnalysisIfAvailable<MachineModuleInfo>();
175 assert(MMIPtr && "MachineModuleInfo should always be available");
176 MachineModuleInfo &MMI = *MMIPtr;
Reid Klecknerf12c0302015-06-09 21:42:19 +0000177 switch (Personality) {
178 default: llvm_unreachable("unexpected personality function");
179 case EHPersonality::MSVC_CXX: addCXXStateStores(F, MMI); break;
180 case EHPersonality::MSVC_X86SEH: addSEHStateStores(F, MMI); break;
Reid Klecknerfe4d4912015-05-28 22:00:24 +0000181 }
Reid Kleckner0738a9c2015-05-05 17:44:16 +0000182
183 // Reset per-function state.
184 PersonalityFn = nullptr;
185 Personality = EHPersonality::Unknown;
186 return true;
187}
188
189/// Get the common EH registration subobject:
Reid Kleckner2632f0d2015-05-20 23:08:04 +0000190/// typedef _EXCEPTION_DISPOSITION (*PEXCEPTION_ROUTINE)(
191/// _EXCEPTION_RECORD *, void *, _CONTEXT *, void *);
Reid Kleckner0738a9c2015-05-05 17:44:16 +0000192/// struct EHRegistrationNode {
193/// EHRegistrationNode *Next;
Reid Kleckner2632f0d2015-05-20 23:08:04 +0000194/// PEXCEPTION_ROUTINE Handler;
Reid Kleckner0738a9c2015-05-05 17:44:16 +0000195/// };
Reid Klecknere6531a552015-05-29 22:57:46 +0000196Type *WinEHStatePass::getEHLinkRegistrationType() {
197 if (EHLinkRegistrationTy)
198 return EHLinkRegistrationTy;
Reid Kleckner0738a9c2015-05-05 17:44:16 +0000199 LLVMContext &Context = TheModule->getContext();
Reid Klecknere6531a552015-05-29 22:57:46 +0000200 EHLinkRegistrationTy = StructType::create(Context, "EHRegistrationNode");
Reid Kleckner0738a9c2015-05-05 17:44:16 +0000201 Type *FieldTys[] = {
Reid Klecknere6531a552015-05-29 22:57:46 +0000202 EHLinkRegistrationTy->getPointerTo(0), // EHRegistrationNode *Next
Reid Kleckner0738a9c2015-05-05 17:44:16 +0000203 Type::getInt8PtrTy(Context) // EXCEPTION_DISPOSITION (*Handler)(...)
204 };
Reid Klecknere6531a552015-05-29 22:57:46 +0000205 EHLinkRegistrationTy->setBody(FieldTys, false);
206 return EHLinkRegistrationTy;
Reid Kleckner0738a9c2015-05-05 17:44:16 +0000207}
208
209/// The __CxxFrameHandler3 registration node:
210/// struct CXXExceptionRegistration {
211/// void *SavedESP;
212/// EHRegistrationNode SubRecord;
213/// int32_t TryLevel;
214/// };
Reid Klecknere6531a552015-05-29 22:57:46 +0000215Type *WinEHStatePass::getCXXEHRegistrationType() {
216 if (CXXEHRegistrationTy)
217 return CXXEHRegistrationTy;
Reid Kleckner0738a9c2015-05-05 17:44:16 +0000218 LLVMContext &Context = TheModule->getContext();
219 Type *FieldTys[] = {
220 Type::getInt8PtrTy(Context), // void *SavedESP
Reid Klecknere6531a552015-05-29 22:57:46 +0000221 getEHLinkRegistrationType(), // EHRegistrationNode SubRecord
Reid Kleckner0738a9c2015-05-05 17:44:16 +0000222 Type::getInt32Ty(Context) // int32_t TryLevel
223 };
Reid Klecknere6531a552015-05-29 22:57:46 +0000224 CXXEHRegistrationTy =
Reid Kleckner0738a9c2015-05-05 17:44:16 +0000225 StructType::create(FieldTys, "CXXExceptionRegistration");
Reid Klecknere6531a552015-05-29 22:57:46 +0000226 return CXXEHRegistrationTy;
Reid Kleckner0738a9c2015-05-05 17:44:16 +0000227}
228
Reid Klecknere6531a552015-05-29 22:57:46 +0000229/// The _except_handler3/4 registration node:
Reid Kleckner0738a9c2015-05-05 17:44:16 +0000230/// struct EH4ExceptionRegistration {
231/// void *SavedESP;
232/// _EXCEPTION_POINTERS *ExceptionPointers;
233/// EHRegistrationNode SubRecord;
234/// int32_t EncodedScopeTable;
235/// int32_t TryLevel;
236/// };
Reid Klecknere6531a552015-05-29 22:57:46 +0000237Type *WinEHStatePass::getSEHRegistrationType() {
238 if (SEHRegistrationTy)
239 return SEHRegistrationTy;
Reid Kleckner0738a9c2015-05-05 17:44:16 +0000240 LLVMContext &Context = TheModule->getContext();
241 Type *FieldTys[] = {
242 Type::getInt8PtrTy(Context), // void *SavedESP
243 Type::getInt8PtrTy(Context), // void *ExceptionPointers
Reid Klecknere6531a552015-05-29 22:57:46 +0000244 getEHLinkRegistrationType(), // EHRegistrationNode SubRecord
Reid Kleckner0738a9c2015-05-05 17:44:16 +0000245 Type::getInt32Ty(Context), // int32_t EncodedScopeTable
246 Type::getInt32Ty(Context) // int32_t TryLevel
247 };
Reid Klecknere6531a552015-05-29 22:57:46 +0000248 SEHRegistrationTy = StructType::create(FieldTys, "SEHExceptionRegistration");
249 return SEHRegistrationTy;
Reid Kleckner0738a9c2015-05-05 17:44:16 +0000250}
251
252// Emit an exception registration record. These are stack allocations with the
253// common subobject of two pointers: the previous registration record (the old
254// fs:00) and the personality function for the current frame. The data before
255// and after that is personality function specific.
256void WinEHStatePass::emitExceptionRegistrationRecord(Function *F) {
257 assert(Personality == EHPersonality::MSVC_CXX ||
258 Personality == EHPersonality::MSVC_X86SEH);
259
260 StringRef PersonalityName = PersonalityFn->getName();
261 IRBuilder<> Builder(&F->getEntryBlock(), F->getEntryBlock().begin());
262 Type *Int8PtrType = Builder.getInt8PtrTy();
Reid Klecknere6531a552015-05-29 22:57:46 +0000263 if (Personality == EHPersonality::MSVC_CXX) {
264 RegNodeTy = getCXXEHRegistrationType();
Reid Klecknerfe4d4912015-05-28 22:00:24 +0000265 RegNode = Builder.CreateAlloca(RegNodeTy);
Reid Kleckner0738a9c2015-05-05 17:44:16 +0000266 // SavedESP = llvm.stacksave()
267 Value *SP = Builder.CreateCall(
David Blaikieff6409d2015-05-18 22:13:54 +0000268 Intrinsic::getDeclaration(TheModule, Intrinsic::stacksave), {});
Reid Kleckner0738a9c2015-05-05 17:44:16 +0000269 Builder.CreateStore(SP, Builder.CreateStructGEP(RegNodeTy, RegNode, 0));
270 // TryLevel = -1
Reid Klecknerfe4d4912015-05-28 22:00:24 +0000271 StateFieldIndex = 2;
272 insertStateNumberStore(RegNode, Builder.GetInsertPoint(), -1);
Reid Kleckner2632f0d2015-05-20 23:08:04 +0000273 // Handler = __ehhandler$F
274 Function *Trampoline = generateLSDAInEAXThunk(F);
Reid Klecknerfe4d4912015-05-28 22:00:24 +0000275 Link = Builder.CreateStructGEP(RegNodeTy, RegNode, 1);
276 linkExceptionRegistration(Builder, Trampoline);
Reid Klecknere6531a552015-05-29 22:57:46 +0000277 } else if (Personality == EHPersonality::MSVC_X86SEH) {
278 // If _except_handler4 is in use, some additional guard checks and prologue
279 // stuff is required.
280 bool UseStackGuard = (PersonalityName == "_except_handler4");
281 RegNodeTy = getSEHRegistrationType();
Reid Klecknerfe4d4912015-05-28 22:00:24 +0000282 RegNode = Builder.CreateAlloca(RegNodeTy);
Reid Kleckner0738a9c2015-05-05 17:44:16 +0000283 // SavedESP = llvm.stacksave()
284 Value *SP = Builder.CreateCall(
David Blaikieff6409d2015-05-18 22:13:54 +0000285 Intrinsic::getDeclaration(TheModule, Intrinsic::stacksave), {});
Reid Kleckner0738a9c2015-05-05 17:44:16 +0000286 Builder.CreateStore(SP, Builder.CreateStructGEP(RegNodeTy, RegNode, 0));
Reid Klecknere6531a552015-05-29 22:57:46 +0000287 // TryLevel = -2 / -1
Reid Klecknerfe4d4912015-05-28 22:00:24 +0000288 StateFieldIndex = 4;
Reid Klecknere6531a552015-05-29 22:57:46 +0000289 insertStateNumberStore(RegNode, Builder.GetInsertPoint(),
290 UseStackGuard ? -2 : -1);
Reid Kleckner2632f0d2015-05-20 23:08:04 +0000291 // ScopeTable = llvm.x86.seh.lsda(F)
292 Value *FI8 = Builder.CreateBitCast(F, Int8PtrType);
293 Value *LSDA = Builder.CreateCall(
294 Intrinsic::getDeclaration(TheModule, Intrinsic::x86_seh_lsda), FI8);
Reid Klecknere6531a552015-05-29 22:57:46 +0000295 Type *Int32Ty = Type::getInt32Ty(TheModule->getContext());
296 LSDA = Builder.CreatePtrToInt(LSDA, Int32Ty);
297 // If using _except_handler4, xor the address of the table with
298 // __security_cookie.
299 if (UseStackGuard) {
300 Value *Cookie =
301 TheModule->getOrInsertGlobal("__security_cookie", Int32Ty);
302 Value *Val = Builder.CreateLoad(Int32Ty, Cookie);
303 LSDA = Builder.CreateXor(LSDA, Val);
304 }
305 Builder.CreateStore(LSDA, Builder.CreateStructGEP(RegNodeTy, RegNode, 3));
Reid Klecknerfe4d4912015-05-28 22:00:24 +0000306 Link = Builder.CreateStructGEP(RegNodeTy, RegNode, 2);
307 linkExceptionRegistration(Builder, PersonalityFn);
Reid Kleckner0738a9c2015-05-05 17:44:16 +0000308 } else {
309 llvm_unreachable("unexpected personality function");
310 }
311
Reid Klecknerfe4d4912015-05-28 22:00:24 +0000312 // Insert an unlink before all returns.
Reid Kleckner0738a9c2015-05-05 17:44:16 +0000313 for (BasicBlock &BB : *F) {
314 TerminatorInst *T = BB.getTerminator();
315 if (!isa<ReturnInst>(T))
316 continue;
317 Builder.SetInsertPoint(T);
Reid Klecknerfe4d4912015-05-28 22:00:24 +0000318 unlinkExceptionRegistration(Builder);
Reid Kleckner0738a9c2015-05-05 17:44:16 +0000319 }
320}
321
Reid Kleckner2632f0d2015-05-20 23:08:04 +0000322Value *WinEHStatePass::emitEHLSDA(IRBuilder<> &Builder, Function *F) {
323 Value *FI8 = Builder.CreateBitCast(F, Type::getInt8PtrTy(F->getContext()));
324 return Builder.CreateCall(
325 Intrinsic::getDeclaration(TheModule, Intrinsic::x86_seh_lsda), FI8);
326}
327
328/// Generate a thunk that puts the LSDA of ParentFunc in EAX and then calls
329/// PersonalityFn, forwarding the parameters passed to PEXCEPTION_ROUTINE:
330/// typedef _EXCEPTION_DISPOSITION (*PEXCEPTION_ROUTINE)(
331/// _EXCEPTION_RECORD *, void *, _CONTEXT *, void *);
332/// We essentially want this code:
333/// movl $lsda, %eax
334/// jmpl ___CxxFrameHandler3
335Function *WinEHStatePass::generateLSDAInEAXThunk(Function *ParentFunc) {
336 LLVMContext &Context = ParentFunc->getContext();
337 Type *Int32Ty = Type::getInt32Ty(Context);
338 Type *Int8PtrType = Type::getInt8PtrTy(Context);
339 Type *ArgTys[5] = {Int8PtrType, Int8PtrType, Int8PtrType, Int8PtrType,
340 Int8PtrType};
341 FunctionType *TrampolineTy =
342 FunctionType::get(Int32Ty, makeArrayRef(&ArgTys[0], 4),
343 /*isVarArg=*/false);
344 FunctionType *TargetFuncTy =
345 FunctionType::get(Int32Ty, makeArrayRef(&ArgTys[0], 5),
346 /*isVarArg=*/false);
347 Function *Trampoline = Function::Create(
348 TrampolineTy, GlobalValue::InternalLinkage,
349 Twine("__ehhandler$") + ParentFunc->getName(), TheModule);
350 BasicBlock *EntryBB = BasicBlock::Create(Context, "entry", Trampoline);
351 IRBuilder<> Builder(EntryBB);
352 Value *LSDA = emitEHLSDA(Builder, ParentFunc);
353 Value *CastPersonality =
354 Builder.CreateBitCast(PersonalityFn, TargetFuncTy->getPointerTo());
355 auto AI = Trampoline->arg_begin();
356 Value *Args[5] = {LSDA, AI++, AI++, AI++, AI++};
357 CallInst *Call = Builder.CreateCall(CastPersonality, Args);
358 // Can't use musttail due to prototype mismatch, but we can use tail.
359 Call->setTailCall(true);
360 // Set inreg so we pass it in EAX.
361 Call->addAttribute(1, Attribute::InReg);
362 Builder.CreateRet(Call);
363 return Trampoline;
364}
365
Reid Kleckner0738a9c2015-05-05 17:44:16 +0000366void WinEHStatePass::linkExceptionRegistration(IRBuilder<> &Builder,
Reid Kleckner2bc93ca2015-06-10 01:02:30 +0000367 Function *Handler) {
368 // Emit the .safeseh directive for this function.
369 Handler->addFnAttr("safeseh");
370
Reid Klecknere6531a552015-05-29 22:57:46 +0000371 Type *LinkTy = getEHLinkRegistrationType();
Reid Kleckner0738a9c2015-05-05 17:44:16 +0000372 // Handler = Handler
Reid Kleckner2bc93ca2015-06-10 01:02:30 +0000373 Value *HandlerI8 = Builder.CreateBitCast(Handler, Builder.getInt8PtrTy());
374 Builder.CreateStore(HandlerI8, Builder.CreateStructGEP(LinkTy, Link, 1));
Reid Kleckner0738a9c2015-05-05 17:44:16 +0000375 // Next = [fs:00]
376 Constant *FSZero =
Reid Klecknerfe4d4912015-05-28 22:00:24 +0000377 Constant::getNullValue(LinkTy->getPointerTo()->getPointerTo(257));
Reid Kleckner0738a9c2015-05-05 17:44:16 +0000378 Value *Next = Builder.CreateLoad(FSZero);
Reid Klecknerfe4d4912015-05-28 22:00:24 +0000379 Builder.CreateStore(Next, Builder.CreateStructGEP(LinkTy, Link, 0));
380 // [fs:00] = Link
381 Builder.CreateStore(Link, FSZero);
Reid Kleckner0738a9c2015-05-05 17:44:16 +0000382}
383
Reid Klecknerfe4d4912015-05-28 22:00:24 +0000384void WinEHStatePass::unlinkExceptionRegistration(IRBuilder<> &Builder) {
385 // Clone Link into the current BB for better address mode folding.
386 if (auto *GEP = dyn_cast<GetElementPtrInst>(Link)) {
Reid Kleckner0738a9c2015-05-05 17:44:16 +0000387 GEP = cast<GetElementPtrInst>(GEP->clone());
388 Builder.Insert(GEP);
Reid Klecknerfe4d4912015-05-28 22:00:24 +0000389 Link = GEP;
Reid Kleckner0738a9c2015-05-05 17:44:16 +0000390 }
Reid Klecknere6531a552015-05-29 22:57:46 +0000391 Type *LinkTy = getEHLinkRegistrationType();
Reid Klecknerfe4d4912015-05-28 22:00:24 +0000392 // [fs:00] = Link->Next
Reid Kleckner0738a9c2015-05-05 17:44:16 +0000393 Value *Next =
Reid Klecknerfe4d4912015-05-28 22:00:24 +0000394 Builder.CreateLoad(Builder.CreateStructGEP(LinkTy, Link, 0));
Reid Kleckner0738a9c2015-05-05 17:44:16 +0000395 Constant *FSZero =
Reid Klecknerfe4d4912015-05-28 22:00:24 +0000396 Constant::getNullValue(LinkTy->getPointerTo()->getPointerTo(257));
Reid Kleckner0738a9c2015-05-05 17:44:16 +0000397 Builder.CreateStore(Next, FSZero);
398}
Reid Klecknerfe4d4912015-05-28 22:00:24 +0000399
400void WinEHStatePass::addCXXStateStores(Function &F, MachineModuleInfo &MMI) {
401 WinEHFuncInfo &FuncInfo = MMI.getWinEHFuncInfo(&F);
402 calculateWinCXXEHStateNumbers(&F, FuncInfo);
403
404 // The base state for the parent is -1.
405 addCXXStateStoresToFunclet(RegNode, FuncInfo, F, -1);
406
407 // Set up RegNodeEscapeIndex
408 int RegNodeEscapeIndex = escapeRegNode(F);
409
410 // Only insert stores in catch handlers.
Reid Klecknerfe4d4912015-05-28 22:00:24 +0000411 Constant *FI8 =
412 ConstantExpr::getBitCast(&F, Type::getInt8PtrTy(TheModule->getContext()));
413 for (auto P : FuncInfo.HandlerBaseState) {
414 Function *Handler = const_cast<Function *>(P.first);
415 int BaseState = P.second;
416 IRBuilder<> Builder(&Handler->getEntryBlock(),
417 Handler->getEntryBlock().begin());
418 // FIXME: Find and reuse such a call if present.
419 Value *ParentFP = Builder.CreateCall(FrameAddress, {Builder.getInt32(1)});
420 Value *RecoveredRegNode = Builder.CreateCall(
421 FrameRecover, {FI8, ParentFP, Builder.getInt32(RegNodeEscapeIndex)});
422 RecoveredRegNode =
423 Builder.CreateBitCast(RecoveredRegNode, RegNodeTy->getPointerTo(0));
424 addCXXStateStoresToFunclet(RecoveredRegNode, FuncInfo, *Handler, BaseState);
425 }
426}
427
428/// Escape RegNode so that we can access it from child handlers. Find the call
429/// to frameescape, if any, in the entry block and append RegNode to the list
430/// of arguments.
431int WinEHStatePass::escapeRegNode(Function &F) {
432 // Find the call to frameescape and extract its arguments.
433 IntrinsicInst *EscapeCall = nullptr;
434 for (Instruction &I : F.getEntryBlock()) {
435 IntrinsicInst *II = dyn_cast<IntrinsicInst>(&I);
436 if (II && II->getIntrinsicID() == Intrinsic::frameescape) {
437 EscapeCall = II;
438 break;
439 }
440 }
441 SmallVector<Value *, 8> Args;
442 if (EscapeCall) {
443 auto Ops = EscapeCall->arg_operands();
444 Args.append(Ops.begin(), Ops.end());
445 }
446 Args.push_back(RegNode);
447
448 // Replace the call (if it exists) with new one. Otherwise, insert at the end
449 // of the entry block.
450 IRBuilder<> Builder(&F.getEntryBlock(),
451 EscapeCall ? EscapeCall : F.getEntryBlock().end());
Reid Klecknerb7403332015-06-08 22:43:32 +0000452 Builder.CreateCall(FrameEscape, Args);
Reid Klecknerfe4d4912015-05-28 22:00:24 +0000453 if (EscapeCall)
454 EscapeCall->eraseFromParent();
455 return Args.size() - 1;
456}
457
458void WinEHStatePass::addCXXStateStoresToFunclet(Value *ParentRegNode,
459 WinEHFuncInfo &FuncInfo,
460 Function &F, int BaseState) {
461 // Iterate all the instructions and emit state number stores.
462 for (BasicBlock &BB : F) {
463 for (Instruction &I : BB) {
464 if (auto *CI = dyn_cast<CallInst>(&I)) {
465 // Possibly throwing call instructions have no actions to take after
466 // an unwind. Ensure they are in the -1 state.
467 if (CI->doesNotThrow())
468 continue;
469 insertStateNumberStore(ParentRegNode, CI, BaseState);
470 } else if (auto *II = dyn_cast<InvokeInst>(&I)) {
471 // Look up the state number of the landingpad this unwinds to.
472 LandingPadInst *LPI = II->getUnwindDest()->getLandingPadInst();
473 // FIXME: Why does this assertion fail?
474 //assert(FuncInfo.LandingPadStateMap.count(LPI) && "LP has no state!");
475 int State = FuncInfo.LandingPadStateMap[LPI];
476 insertStateNumberStore(ParentRegNode, II, State);
477 }
478 }
479 }
480}
481
Reid Klecknerf12c0302015-06-09 21:42:19 +0000482/// Assign every distinct landingpad a unique state number for SEH. Unlike C++
483/// EH, we can use this very simple algorithm while C++ EH cannot because catch
484/// handlers aren't outlined and the runtime doesn't have to figure out which
485/// catch handler frame to unwind to.
486/// FIXME: __finally blocks are outlined, so this approach may break down there.
487void WinEHStatePass::addSEHStateStores(Function &F, MachineModuleInfo &MMI) {
488 WinEHFuncInfo &FuncInfo = MMI.getWinEHFuncInfo(&F);
489
490 // Iterate all the instructions and emit state number stores.
491 int CurState = 0;
Reid Kleckner673de152015-06-10 01:34:54 +0000492 SmallPtrSet<BasicBlock *, 4> ExceptBlocks;
Reid Klecknerf12c0302015-06-09 21:42:19 +0000493 for (BasicBlock &BB : F) {
494 for (auto I = BB.begin(), E = BB.end(); I != E; ++I) {
495 if (auto *CI = dyn_cast<CallInst>(I)) {
496 auto *Intrin = dyn_cast<IntrinsicInst>(CI);
497 if (Intrin) {
498 I = rewriteExceptionInfoIntrinsics(Intrin);
499 // Calls that "don't throw" are considered to be able to throw asynch
500 // exceptions, but intrinsics cannot.
501 continue;
502 }
503 insertStateNumberStore(RegNode, CI, -1);
504 } else if (auto *II = dyn_cast<InvokeInst>(I)) {
505 // Look up the state number of the landingpad this unwinds to.
506 LandingPadInst *LPI = II->getUnwindDest()->getLandingPadInst();
507 auto InsertionPair =
508 FuncInfo.LandingPadStateMap.insert(std::make_pair(LPI, 0));
509 auto Iter = InsertionPair.first;
510 int &State = Iter->second;
511 bool Inserted = InsertionPair.second;
512 if (Inserted) {
513 // Each action consumes a state number.
514 auto *EHActions = cast<IntrinsicInst>(LPI->getNextNode());
515 SmallVector<std::unique_ptr<ActionHandler>, 4> ActionList;
516 parseEHActions(EHActions, ActionList);
517 assert(!ActionList.empty());
518 CurState += ActionList.size();
519 State += ActionList.size() - 1;
Reid Kleckner673de152015-06-10 01:34:54 +0000520
521 // Remember all the __except block targets.
522 for (auto &Handler : ActionList) {
523 if (auto *CH = dyn_cast<CatchHandler>(Handler.get())) {
524 auto *BA = cast<BlockAddress>(CH->getHandlerBlockOrFunc());
525 ExceptBlocks.insert(BA->getBasicBlock());
526 }
527 }
Reid Klecknerf12c0302015-06-09 21:42:19 +0000528 }
529 insertStateNumberStore(RegNode, II, State);
530 }
531 }
532 }
Reid Kleckner673de152015-06-10 01:34:54 +0000533
534 // Insert llvm.stackrestore into each __except block.
535 Function *StackRestore =
536 Intrinsic::getDeclaration(TheModule, Intrinsic::stackrestore);
537 for (BasicBlock *ExceptBB : ExceptBlocks) {
538 IRBuilder<> Builder(ExceptBB->begin());
539 Value *SP =
540 Builder.CreateLoad(Builder.CreateStructGEP(RegNodeTy, RegNode, 0));
541 Builder.CreateCall(StackRestore, {SP});
542 }
Reid Klecknerf12c0302015-06-09 21:42:19 +0000543}
544
545/// Rewrite llvm.eh.exceptioncode and llvm.eh.exceptioninfo to memory loads in
546/// IR.
547iplist<Instruction>::iterator
548WinEHStatePass::rewriteExceptionInfoIntrinsics(IntrinsicInst *Intrin) {
549 Intrinsic::ID ID = Intrin->getIntrinsicID();
550 if (ID != Intrinsic::eh_exceptioncode && ID != Intrinsic::eh_exceptioninfo)
551 return Intrin;
552
553 // RegNode->ExceptionPointers
554 IRBuilder<> Builder(Intrin);
555 Value *Ptrs =
556 Builder.CreateLoad(Builder.CreateStructGEP(RegNodeTy, RegNode, 1));
557 Value *Res;
558 if (ID == Intrinsic::eh_exceptioncode) {
559 // Ptrs->ExceptionRecord->Code
560 Ptrs = Builder.CreateBitCast(
561 Ptrs, Builder.getInt32Ty()->getPointerTo()->getPointerTo());
562 Value *Rec = Builder.CreateLoad(Ptrs);
563 Res = Builder.CreateLoad(Rec);
564 } else {
565 Res = Ptrs;
566 }
567 Intrin->replaceAllUsesWith(Res);
568 return Intrin->eraseFromParent();
569}
570
Reid Klecknerfe4d4912015-05-28 22:00:24 +0000571void WinEHStatePass::insertStateNumberStore(Value *ParentRegNode,
572 Instruction *IP, int State) {
573 IRBuilder<> Builder(IP);
574 Value *StateField =
575 Builder.CreateStructGEP(RegNodeTy, ParentRegNode, StateFieldIndex);
576 Builder.CreateStore(Builder.getInt32(State), StateField);
577}