LLVM 19.0.0git
WasmEHPrepare.cpp
Go to the documentation of this file.
1//===-- WasmEHPrepare - Prepare excepton handling for WebAssembly --------===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9// This transformation is designed for use by code generators which use
10// WebAssembly exception handling scheme. This currently supports C++
11// exceptions.
12//
13// WebAssembly exception handling uses Windows exception IR for the middle level
14// representation. This pass does the following transformation for every
15// catchpad block:
16// (In C-style pseudocode)
17//
18// - Before:
19// catchpad ...
20// exn = wasm.get.exception();
21// selector = wasm.get.selector();
22// ...
23//
24// - After:
25// catchpad ...
26// exn = wasm.catch(WebAssembly::CPP_EXCEPTION);
27// // Only add below in case it's not a single catch (...)
28// wasm.landingpad.index(index);
29// __wasm_lpad_context.lpad_index = index;
30// __wasm_lpad_context.lsda = wasm.lsda();
31// _Unwind_CallPersonality(exn);
32// selector = __wasm_lpad_context.selector;
33// ...
34//
35//
36// * Background: Direct personality function call
37// In WebAssembly EH, the VM is responsible for unwinding the stack once an
38// exception is thrown. After the stack is unwound, the control flow is
39// transfered to WebAssembly 'catch' instruction.
40//
41// Unwinding the stack is not done by libunwind but the VM, so the personality
42// function in libcxxabi cannot be called from libunwind during the unwinding
43// process. So after a catch instruction, we insert a call to a wrapper function
44// in libunwind that in turn calls the real personality function.
45//
46// In Itanium EH, if the personality function decides there is no matching catch
47// clause in a call frame and no cleanup action to perform, the unwinder doesn't
48// stop there and continues unwinding. But in Wasm EH, the unwinder stops at
49// every call frame with a catch intruction, after which the personality
50// function is called from the compiler-generated user code here.
51//
52// In libunwind, we have this struct that serves as a communincation channel
53// between the compiler-generated user code and the personality function in
54// libcxxabi.
55//
56// struct _Unwind_LandingPadContext {
57// uintptr_t lpad_index;
58// uintptr_t lsda;
59// uintptr_t selector;
60// };
61// struct _Unwind_LandingPadContext __wasm_lpad_context = ...;
62//
63// And this wrapper in libunwind calls the personality function.
64//
65// _Unwind_Reason_Code _Unwind_CallPersonality(void *exception_ptr) {
66// struct _Unwind_Exception *exception_obj =
67// (struct _Unwind_Exception *)exception_ptr;
68// _Unwind_Reason_Code ret = __gxx_personality_v0(
69// 1, _UA_CLEANUP_PHASE, exception_obj->exception_class, exception_obj,
70// (struct _Unwind_Context *)__wasm_lpad_context);
71// return ret;
72// }
73//
74// We pass a landing pad index, and the address of LSDA for the current function
75// to the wrapper function _Unwind_CallPersonality in libunwind, and we retrieve
76// the selector after it returns.
77//
78//===----------------------------------------------------------------------===//
79
82#include "llvm/CodeGen/Passes.h"
85#include "llvm/IR/IRBuilder.h"
86#include "llvm/IR/IntrinsicsWebAssembly.h"
87#include "llvm/IR/Module.h"
90
91using namespace llvm;
92
93#define DEBUG_TYPE "wasm-eh-prepare"
94
95namespace {
96class WasmEHPrepareImpl {
97 friend class WasmEHPrepare;
98
99 Type *LPadContextTy = nullptr; // type of 'struct _Unwind_LandingPadContext'
100 GlobalVariable *LPadContextGV = nullptr; // __wasm_lpad_context
101
102 // Field addresses of struct _Unwind_LandingPadContext
103 Value *LPadIndexField = nullptr; // lpad_index field
104 Value *LSDAField = nullptr; // lsda field
105 Value *SelectorField = nullptr; // selector
106
107 Function *ThrowF = nullptr; // wasm.throw() intrinsic
108 Function *LPadIndexF = nullptr; // wasm.landingpad.index() intrinsic
109 Function *LSDAF = nullptr; // wasm.lsda() intrinsic
110 Function *GetExnF = nullptr; // wasm.get.exception() intrinsic
111 Function *CatchF = nullptr; // wasm.catch() intrinsic
112 Function *GetSelectorF = nullptr; // wasm.get.ehselector() intrinsic
113 FunctionCallee CallPersonalityF =
114 nullptr; // _Unwind_CallPersonality() wrapper
115
116 bool prepareThrows(Function &F);
117 bool prepareEHPads(Function &F);
118 void prepareEHPad(BasicBlock *BB, bool NeedPersonality, unsigned Index = 0);
119
120public:
121 WasmEHPrepareImpl() = default;
122 WasmEHPrepareImpl(Type *LPadContextTy_) : LPadContextTy(LPadContextTy_) {}
123 bool runOnFunction(Function &F);
124};
125
126class WasmEHPrepare : public FunctionPass {
127 WasmEHPrepareImpl P;
128
129public:
130 static char ID; // Pass identification, replacement for typeid
131
132 WasmEHPrepare() : FunctionPass(ID) {}
133 bool doInitialization(Module &M) override;
134 bool runOnFunction(Function &F) override { return P.runOnFunction(F); }
135
136 StringRef getPassName() const override {
137 return "WebAssembly Exception handling preparation";
138 }
139};
140
141} // end anonymous namespace
142
145 auto &Context = F.getContext();
146 auto *I32Ty = Type::getInt32Ty(Context);
147 auto *PtrTy = PointerType::get(Context, 0);
148 auto *LPadContextTy =
149 StructType::get(I32Ty /*lpad_index*/, PtrTy /*lsda*/, I32Ty /*selector*/);
150 WasmEHPrepareImpl P(LPadContextTy);
151 bool Changed = P.runOnFunction(F);
152 return Changed ? PreservedAnalyses::none() : PreservedAnalyses ::all();
153}
154
155char WasmEHPrepare::ID = 0;
157 "Prepare WebAssembly exceptions", false, false)
158INITIALIZE_PASS_END(WasmEHPrepare, DEBUG_TYPE, "Prepare WebAssembly exceptions",
160
161FunctionPass *llvm::createWasmEHPass() { return new WasmEHPrepare(); }
162
163bool WasmEHPrepare::doInitialization(Module &M) {
164 IRBuilder<> IRB(M.getContext());
165 P.LPadContextTy = StructType::get(IRB.getInt32Ty(), // lpad_index
166 IRB.getPtrTy(), // lsda
167 IRB.getInt32Ty() // selector
168 );
169 return false;
170}
171
172// Erase the specified BBs if the BB does not have any remaining predecessors,
173// and also all its dead children.
174template <typename Container>
175static void eraseDeadBBsAndChildren(const Container &BBs) {
176 SmallVector<BasicBlock *, 8> WL(BBs.begin(), BBs.end());
177 while (!WL.empty()) {
178 auto *BB = WL.pop_back_val();
179 if (!pred_empty(BB))
180 continue;
181 WL.append(succ_begin(BB), succ_end(BB));
182 DeleteDeadBlock(BB);
183 }
184}
185
186bool WasmEHPrepareImpl::runOnFunction(Function &F) {
187 bool Changed = false;
188 Changed |= prepareThrows(F);
189 Changed |= prepareEHPads(F);
190 return Changed;
191}
192
193bool WasmEHPrepareImpl::prepareThrows(Function &F) {
194 Module &M = *F.getParent();
195 IRBuilder<> IRB(F.getContext());
196 bool Changed = false;
197
198 // wasm.throw() intinsic, which will be lowered to wasm 'throw' instruction.
199 ThrowF = Intrinsic::getDeclaration(&M, Intrinsic::wasm_throw);
200 // Insert an unreachable instruction after a call to @llvm.wasm.throw and
201 // delete all following instructions within the BB, and delete all the dead
202 // children of the BB as well.
203 for (User *U : ThrowF->users()) {
204 // A call to @llvm.wasm.throw() is only generated from __cxa_throw()
205 // builtin call within libcxxabi, and cannot be an InvokeInst.
206 auto *ThrowI = cast<CallInst>(U);
207 if (ThrowI->getFunction() != &F)
208 continue;
209 Changed = true;
210 auto *BB = ThrowI->getParent();
212 BB->erase(std::next(BasicBlock::iterator(ThrowI)), BB->end());
213 IRB.SetInsertPoint(BB);
214 IRB.CreateUnreachable();
216 }
217
218 return Changed;
219}
220
221bool WasmEHPrepareImpl::prepareEHPads(Function &F) {
222 Module &M = *F.getParent();
223 IRBuilder<> IRB(F.getContext());
224
227 for (BasicBlock &BB : F) {
228 if (!BB.isEHPad())
229 continue;
230 auto *Pad = BB.getFirstNonPHI();
231 if (isa<CatchPadInst>(Pad))
232 CatchPads.push_back(&BB);
233 else if (isa<CleanupPadInst>(Pad))
234 CleanupPads.push_back(&BB);
235 }
236 if (CatchPads.empty() && CleanupPads.empty())
237 return false;
238
239 if (!F.hasPersonalityFn() ||
240 !isScopedEHPersonality(classifyEHPersonality(F.getPersonalityFn()))) {
241 report_fatal_error("Function '" + F.getName() +
242 "' does not have a correct Wasm personality function "
243 "'__gxx_wasm_personality_v0'");
244 }
245 assert(F.hasPersonalityFn() && "Personality function not found");
246
247 // __wasm_lpad_context global variable.
248 // This variable should be thread local. If the target does not support TLS,
249 // we depend on CoalesceFeaturesAndStripAtomics to downgrade it to
250 // non-thread-local ones, in which case we don't allow this object to be
251 // linked with other objects using shared memory.
252 LPadContextGV = cast<GlobalVariable>(
253 M.getOrInsertGlobal("__wasm_lpad_context", LPadContextTy));
254 LPadContextGV->setThreadLocalMode(GlobalValue::GeneralDynamicTLSModel);
255
256 LPadIndexField = LPadContextGV;
257 LSDAField = IRB.CreateConstInBoundsGEP2_32(LPadContextTy, LPadContextGV, 0, 1,
258 "lsda_gep");
259 SelectorField = IRB.CreateConstInBoundsGEP2_32(LPadContextTy, LPadContextGV,
260 0, 2, "selector_gep");
261
262 // wasm.landingpad.index() intrinsic, which is to specify landingpad index
263 LPadIndexF = Intrinsic::getDeclaration(&M, Intrinsic::wasm_landingpad_index);
264 // wasm.lsda() intrinsic. Returns the address of LSDA table for the current
265 // function.
266 LSDAF = Intrinsic::getDeclaration(&M, Intrinsic::wasm_lsda);
267 // wasm.get.exception() and wasm.get.ehselector() intrinsics. Calls to these
268 // are generated in clang.
269 GetExnF = Intrinsic::getDeclaration(&M, Intrinsic::wasm_get_exception);
270 GetSelectorF = Intrinsic::getDeclaration(&M, Intrinsic::wasm_get_ehselector);
271
272 // wasm.catch() will be lowered down to wasm 'catch' instruction in
273 // instruction selection.
274 CatchF = Intrinsic::getDeclaration(&M, Intrinsic::wasm_catch);
275
276 // _Unwind_CallPersonality() wrapper function, which calls the personality
277 CallPersonalityF = M.getOrInsertFunction("_Unwind_CallPersonality",
278 IRB.getInt32Ty(), IRB.getPtrTy());
279 if (Function *F = dyn_cast<Function>(CallPersonalityF.getCallee()))
280 F->setDoesNotThrow();
281
282 unsigned Index = 0;
283 for (auto *BB : CatchPads) {
284 auto *CPI = cast<CatchPadInst>(BB->getFirstNonPHI());
285 // In case of a single catch (...), we don't need to emit a personalify
286 // function call
287 if (CPI->arg_size() == 1 &&
288 cast<Constant>(CPI->getArgOperand(0))->isNullValue())
289 prepareEHPad(BB, false);
290 else
291 prepareEHPad(BB, true, Index++);
292 }
293
294 // Cleanup pads don't need a personality function call.
295 for (auto *BB : CleanupPads)
296 prepareEHPad(BB, false);
297
298 return true;
299}
300
301// Prepare an EH pad for Wasm EH handling. If NeedPersonality is false, Index is
302// ignored.
303void WasmEHPrepareImpl::prepareEHPad(BasicBlock *BB, bool NeedPersonality,
304 unsigned Index) {
305 assert(BB->isEHPad() && "BB is not an EHPad!");
306 IRBuilder<> IRB(BB->getContext());
307 IRB.SetInsertPoint(BB, BB->getFirstInsertionPt());
308
309 auto *FPI = cast<FuncletPadInst>(BB->getFirstNonPHI());
310 Instruction *GetExnCI = nullptr, *GetSelectorCI = nullptr;
311 for (auto &U : FPI->uses()) {
312 if (auto *CI = dyn_cast<CallInst>(U.getUser())) {
313 if (CI->getCalledOperand() == GetExnF)
314 GetExnCI = CI;
315 if (CI->getCalledOperand() == GetSelectorF)
316 GetSelectorCI = CI;
317 }
318 }
319
320 // Cleanup pads do not have any of wasm.get.exception() or
321 // wasm.get.ehselector() calls. We need to do nothing.
322 if (!GetExnCI) {
323 assert(!GetSelectorCI &&
324 "wasm.get.ehselector() cannot exist w/o wasm.get.exception()");
325 return;
326 }
327
328 // Replace wasm.get.exception intrinsic with wasm.catch intrinsic, which will
329 // be lowered to wasm 'catch' instruction. We do this mainly because
330 // instruction selection cannot handle wasm.get.exception intrinsic's token
331 // argument.
332 Instruction *CatchCI =
333 IRB.CreateCall(CatchF, {IRB.getInt32(WebAssembly::CPP_EXCEPTION)}, "exn");
334 GetExnCI->replaceAllUsesWith(CatchCI);
335 GetExnCI->eraseFromParent();
336
337 // In case it is a catchpad with single catch (...) or a cleanuppad, we don't
338 // need to call personality function because we don't need a selector.
339 if (!NeedPersonality) {
340 if (GetSelectorCI) {
341 assert(GetSelectorCI->use_empty() &&
342 "wasm.get.ehselector() still has uses!");
343 GetSelectorCI->eraseFromParent();
344 }
345 return;
346 }
347 IRB.SetInsertPoint(CatchCI->getNextNode());
348
349 // This is to create a map of <landingpad EH label, landingpad index> in
350 // SelectionDAGISel, which is to be used in EHStreamer to emit LSDA tables.
351 // Pseudocode: wasm.landingpad.index(Index);
352 IRB.CreateCall(LPadIndexF, {FPI, IRB.getInt32(Index)});
353
354 // Pseudocode: __wasm_lpad_context.lpad_index = index;
355 IRB.CreateStore(IRB.getInt32(Index), LPadIndexField);
356
357 auto *CPI = cast<CatchPadInst>(FPI);
358 // TODO Sometimes storing the LSDA address every time is not necessary, in
359 // case it is already set in a dominating EH pad and there is no function call
360 // between from that EH pad to here. Consider optimizing those cases.
361 // Pseudocode: __wasm_lpad_context.lsda = wasm.lsda();
362 IRB.CreateStore(IRB.CreateCall(LSDAF), LSDAField);
363
364 // Pseudocode: _Unwind_CallPersonality(exn);
365 CallInst *PersCI = IRB.CreateCall(CallPersonalityF, CatchCI,
366 OperandBundleDef("funclet", CPI));
367 PersCI->setDoesNotThrow();
368
369 // Pseudocode: int selector = __wasm_lpad_context.selector;
370 Instruction *Selector =
371 IRB.CreateLoad(IRB.getInt32Ty(), SelectorField, "selector");
372
373 // Replace the return value from wasm.get.ehselector() with the selector value
374 // loaded from __wasm_lpad_context.selector.
375 assert(GetSelectorCI && "wasm.get.ehselector() call does not exist");
376 GetSelectorCI->replaceAllUsesWith(Selector);
377 GetSelectorCI->eraseFromParent();
378}
379
381 // If an exception is not caught by a catchpad (i.e., it is a foreign
382 // exception), it will unwind to its parent catchswitch's unwind destination.
383 // We don't record an unwind destination for cleanuppads because every
384 // exception should be caught by it.
385 for (const auto &BB : *F) {
386 if (!BB.isEHPad())
387 continue;
388 const Instruction *Pad = BB.getFirstNonPHI();
389
390 if (const auto *CatchPad = dyn_cast<CatchPadInst>(Pad)) {
391 const auto *UnwindBB = CatchPad->getCatchSwitch()->getUnwindDest();
392 if (!UnwindBB)
393 continue;
394 const Instruction *UnwindPad = UnwindBB->getFirstNonPHI();
395 if (const auto *CatchSwitch = dyn_cast<CatchSwitchInst>(UnwindPad))
396 // Currently there should be only one handler per a catchswitch.
397 EHInfo.setUnwindDest(&BB, *CatchSwitch->handlers().begin());
398 else // cleanuppad
399 EHInfo.setUnwindDest(&BB, UnwindBB);
400 }
401 }
402}
Prepare DWARF exceptions
static bool runOnFunction(Function &F, bool PostInlining)
#define DEBUG_TYPE
#define F(x, y, z)
Definition: MD5.cpp:55
Module.h This file contains the declarations for the Module class.
#define P(N)
#define INITIALIZE_PASS_END(passName, arg, name, cfg, analysis)
Definition: PassSupport.h:59
#define INITIALIZE_PASS_BEGIN(passName, arg, name, cfg, analysis)
Definition: PassSupport.h:52
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
static void eraseDeadBBsAndChildren(const Container &BBs)
A container for analyses that lazily runs them and caches their results.
Definition: PassManager.h:253
LLVM Basic Block Representation.
Definition: BasicBlock.h:61
iterator begin()
Instruction iterator methods.
Definition: BasicBlock.h:438
const_iterator getFirstInsertionPt() const
Returns an iterator to the first instruction in this block that is suitable for inserting a non-PHI i...
Definition: BasicBlock.cpp:414
const Instruction * getFirstNonPHI() const
Returns a pointer to the first instruction in this block that is not a PHINode instruction.
Definition: BasicBlock.cpp:365
InstListType::iterator iterator
Instruction iterators...
Definition: BasicBlock.h:167
LLVMContext & getContext() const
Get the context in which this basic block lives.
Definition: BasicBlock.cpp:168
bool isEHPad() const
Return true if this basic block is an exception handling block.
Definition: BasicBlock.h:665
void setDoesNotThrow()
Definition: InstrTypes.h:2016
This class represents a function call, abstracting a target machine's calling convention.
A handy container for a FunctionType+Callee-pointer pair, which can be passed around as a single enti...
Definition: DerivedTypes.h:168
FunctionPass class - This class is used to implement most global optimizations.
Definition: Pass.h:311
virtual bool runOnFunction(Function &F)=0
runOnFunction - Virtual method overriden by subclasses to do the per-function processing of the pass.
This provides a uniform API for creating instructions and inserting them into a basic block: either a...
Definition: IRBuilder.h:2671
InstListType::iterator eraseFromParent()
This method unlinks 'this' from the containing basic block and deletes it.
Definition: Instruction.cpp:92
A Module instance is used to store all the information related to an LLVM module.
Definition: Module.h:65
virtual bool doInitialization(Module &)
doInitialization - Virtual method overridden by subclasses to do any necessary initialization before ...
Definition: Pass.h:119
virtual StringRef getPassName() const
getPassName - Return a nice clean name for a pass.
Definition: Pass.cpp:81
static PointerType * get(Type *ElementType, unsigned AddressSpace)
This constructs a pointer to an object of the specified type in a numbered address space.
A set of analyses that are preserved following a run of a transformation pass.
Definition: Analysis.h:111
static PreservedAnalyses none()
Convenience factory function for the empty preserved set.
Definition: Analysis.h:114
bool empty() const
Definition: SmallVector.h:94
void append(ItTy in_start, ItTy in_end)
Add the specified range to the end of the SmallVector.
Definition: SmallVector.h:696
void push_back(const T &Elt)
Definition: SmallVector.h:426
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
Definition: SmallVector.h:1209
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:50
static StructType * get(LLVMContext &Context, ArrayRef< Type * > Elements, bool isPacked=false)
This static method is the primary way to create a literal StructType.
Definition: Type.cpp:373
The instances of the Type class are immutable: once they are created, they are never changed.
Definition: Type.h:45
static IntegerType * getInt32Ty(LLVMContext &C)
LLVM Value Representation.
Definition: Value.h:74
void replaceAllUsesWith(Value *V)
Change all uses of this to point to a new Value.
Definition: Value.cpp:534
iterator_range< user_iterator > users()
Definition: Value.h:421
PreservedAnalyses run(Function &F, FunctionAnalysisManager &FAM)
NodeTy * getNextNode()
Get the next node, or nullptr for the list tail.
Definition: ilist_node.h:353
unsigned ID
LLVM IR allows to use arbitrary numbers as calling convention identifiers.
Definition: CallingConv.h:24
Function * getDeclaration(Module *M, ID id, ArrayRef< Type * > Tys=std::nullopt)
Create or insert an LLVM Function declaration for an intrinsic, and return it.
Definition: Function.cpp:1513
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
auto successors(const MachineBasicBlock *BB)
FunctionPass * createWasmEHPass()
createWasmEHPass - This pass adapts exception handling code to use WebAssembly's exception handling s...
void DeleteDeadBlock(BasicBlock *BB, DomTreeUpdater *DTU=nullptr, bool KeepOneInputPHIs=false)
Delete the specified block, which must have no predecessors.
bool isScopedEHPersonality(EHPersonality Pers)
Returns true if this personality uses scope-style EH IR instructions: catchswitch,...
OperandBundleDefT< Value * > OperandBundleDef
Definition: AutoUpgrade.h:33
void report_fatal_error(Error Err, bool gen_crash_diag=true)
Report a serious error, calling any installed error handler.
Definition: Error.cpp:167
EHPersonality classifyEHPersonality(const Value *Pers)
See if the given exception handling personality function is one that we understand.
RNSuccIterator< NodeRef, BlockT, RegionT > succ_begin(NodeRef Node)
RNSuccIterator< NodeRef, BlockT, RegionT > succ_end(NodeRef Node)
void calculateWasmEHInfo(const Function *F, WasmEHFuncInfo &EHInfo)
bool pred_empty(const BasicBlock *BB)
Definition: CFG.h:118
void setUnwindDest(const BasicBlock *BB, const BasicBlock *Dest)