1 //=== WebAssemblyLowerEmscriptenEHSjLj.cpp - Lower exceptions for Emscripten =//
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 /// \file
10 /// This file lowers exception-related instructions and setjmp/longjmp function
11 /// calls to use Emscripten's library functions. The pass uses JavaScript's try
12 /// and catch mechanism in case of Emscripten EH/SjLj and Wasm EH intrinsics in
13 /// case of Emscripten SjLJ.
14 ///
15 /// * Emscripten exception handling
16 /// This pass lowers invokes and landingpads into library functions in JS glue
17 /// code. Invokes are lowered into function wrappers called invoke wrappers that
18 /// exist in JS side, which wraps the original function call with JS try-catch.
19 /// If an exception occurred, cxa_throw() function in JS side sets some
20 /// variables (see below) so we can check whether an exception occurred from
21 /// wasm code and handle it appropriately.
22 ///
23 /// * Emscripten setjmp-longjmp handling
24 /// This pass lowers setjmp to a reasonably-performant approach for emscripten.
25 /// The idea is that each block with a setjmp is broken up into two parts: the
26 /// part containing setjmp and the part right after the setjmp. The latter part
27 /// is either reached from the setjmp, or later from a longjmp. To handle the
28 /// longjmp, all calls that might longjmp are also called using invoke wrappers
29 /// and thus JS / try-catch. JS longjmp() function also sets some variables so
30 /// we can check / whether a longjmp occurred from wasm code. Each block with a
31 /// function call that might longjmp is also split up after the longjmp call.
32 /// After the longjmp call, we check whether a longjmp occurred, and if it did,
33 /// which setjmp it corresponds to, and jump to the right post-setjmp block.
34 /// We assume setjmp-longjmp handling always run after EH handling, which means
35 /// we don't expect any exception-related instructions when SjLj runs.
36 /// FIXME Currently this scheme does not support indirect call of setjmp,
37 /// because of the limitation of the scheme itself. fastcomp does not support it
38 /// either.
39 ///
40 /// In detail, this pass does following things:
41 ///
42 /// 1) Assumes the existence of global variables: __THREW__, __threwValue
43 ///    __THREW__ and __threwValue are defined in compiler-rt in Emscripten.
44 ///    These variables are used for both exceptions and setjmp/longjmps.
45 ///    __THREW__ indicates whether an exception or a longjmp occurred or not. 0
46 ///    means nothing occurred, 1 means an exception occurred, and other numbers
47 ///    mean a longjmp occurred. In the case of longjmp, __THREW__ variable
48 ///    indicates the corresponding setjmp buffer the longjmp corresponds to.
49 ///    __threwValue is 0 for exceptions, and the argument to longjmp in case of
50 ///    longjmp.
51 ///
52 /// * Emscripten exception handling
53 ///
54 /// 2) We assume the existence of setThrew and setTempRet0/getTempRet0 functions
55 ///    at link time. setThrew exists in Emscripten's compiler-rt:
56 ///
57 ///    void setThrew(uintptr_t threw, int value) {
58 ///      if (__THREW__ == 0) {
59 ///        __THREW__ = threw;
60 ///        __threwValue = value;
61 ///      }
62 ///    }
63 //
64 ///    setTempRet0 is called from __cxa_find_matching_catch() in JS glue code.
65 ///    In exception handling, getTempRet0 indicates the type of an exception
66 ///    caught, and in setjmp/longjmp, it means the second argument to longjmp
67 ///    function.
68 ///
69 /// 3) Lower
70 ///      invoke @func(arg1, arg2) to label %invoke.cont unwind label %lpad
71 ///    into
72 ///      __THREW__ = 0;
73 ///      call @__invoke_SIG(func, arg1, arg2)
74 ///      %__THREW__.val = __THREW__;
75 ///      __THREW__ = 0;
76 ///      if (%__THREW__.val == 1)
77 ///        goto %lpad
78 ///      else
79 ///         goto %invoke.cont
80 ///    SIG is a mangled string generated based on the LLVM IR-level function
81 ///    signature. After LLVM IR types are lowered to the target wasm types,
82 ///    the names for these wrappers will change based on wasm types as well,
83 ///    as in invoke_vi (function takes an int and returns void). The bodies of
84 ///    these wrappers will be generated in JS glue code, and inside those
85 ///    wrappers we use JS try-catch to generate actual exception effects. It
86 ///    also calls the original callee function. An example wrapper in JS code
87 ///    would look like this:
88 ///      function invoke_vi(index,a1) {
89 ///        try {
90 ///          Module["dynCall_vi"](index,a1); // This calls original callee
91 ///        } catch(e) {
92 ///          if (typeof e !== 'number' && e !== 'longjmp') throw e;
93 ///          _setThrew(1, 0); // setThrew is called here
94 ///        }
95 ///      }
96 ///    If an exception is thrown, __THREW__ will be set to true in a wrapper,
97 ///    so we can jump to the right BB based on this value.
98 ///
99 /// 4) Lower
100 ///      %val = landingpad catch c1 catch c2 catch c3 ...
101 ///      ... use %val ...
102 ///    into
103 ///      %fmc = call @__cxa_find_matching_catch_N(c1, c2, c3, ...)
104 ///      %val = {%fmc, getTempRet0()}
105 ///      ... use %val ...
106 ///    Here N is a number calculated based on the number of clauses.
107 ///    setTempRet0 is called from __cxa_find_matching_catch() in JS glue code.
108 ///
109 /// 5) Lower
110 ///      resume {%a, %b}
111 ///    into
112 ///      call @__resumeException(%a)
113 ///    where __resumeException() is a function in JS glue code.
114 ///
115 /// 6) Lower
116 ///      call @llvm.eh.typeid.for(type) (intrinsic)
117 ///    into
118 ///      call @llvm_eh_typeid_for(type)
119 ///    llvm_eh_typeid_for function will be generated in JS glue code.
120 ///
121 /// * Emscripten setjmp / longjmp handling
122 ///
123 /// If there are calls to longjmp()
124 ///
125 /// 1) Lower
126 ///      longjmp(env, val)
127 ///    into
128 ///      emscripten_longjmp(env, val)
129 ///
130 /// If there are calls to setjmp()
131 ///
132 /// 2) In the function entry that calls setjmp, initialize setjmpTable and
133 ///    sejmpTableSize as follows:
134 ///      setjmpTableSize = 4;
135 ///      setjmpTable = (int *) malloc(40);
136 ///      setjmpTable[0] = 0;
137 ///    setjmpTable and setjmpTableSize are used to call saveSetjmp() function in
138 ///    Emscripten compiler-rt.
139 ///
140 /// 3) Lower
141 ///      setjmp(env)
142 ///    into
143 ///      setjmpTable = saveSetjmp(env, label, setjmpTable, setjmpTableSize);
144 ///      setjmpTableSize = getTempRet0();
145 ///    For each dynamic setjmp call, setjmpTable stores its ID (a number which
146 ///    is incrementally assigned from 0) and its label (a unique number that
147 ///    represents each callsite of setjmp). When we need more entries in
148 ///    setjmpTable, it is reallocated in saveSetjmp() in Emscripten's
149 ///    compiler-rt and it will return the new table address, and assign the new
150 ///    table size in setTempRet0(). saveSetjmp also stores the setjmp's ID into
151 ///    the buffer 'env'. A BB with setjmp is split into two after setjmp call in
152 ///    order to make the post-setjmp BB the possible destination of longjmp BB.
153 ///
154 /// 4) Lower every call that might longjmp into
155 ///      __THREW__ = 0;
156 ///      call @__invoke_SIG(func, arg1, arg2)
157 ///      %__THREW__.val = __THREW__;
158 ///      __THREW__ = 0;
159 ///      %__threwValue.val = __threwValue;
160 ///      if (%__THREW__.val != 0 & %__threwValue.val != 0) {
161 ///        %label = testSetjmp(mem[%__THREW__.val], setjmpTable,
162 ///                            setjmpTableSize);
163 ///        if (%label == 0)
164 ///          emscripten_longjmp(%__THREW__.val, %__threwValue.val);
165 ///        setTempRet0(%__threwValue.val);
166 ///      } else {
167 ///        %label = -1;
168 ///      }
169 ///      longjmp_result = getTempRet0();
170 ///      switch %label {
171 ///        label 1: goto post-setjmp BB 1
172 ///        label 2: goto post-setjmp BB 2
173 ///        ...
174 ///        default: goto splitted next BB
175 ///      }
176 ///    testSetjmp examines setjmpTable to see if there is a matching setjmp
177 ///    call. After calling an invoke wrapper, if a longjmp occurred, __THREW__
178 ///    will be the address of matching jmp_buf buffer and __threwValue be the
179 ///    second argument to longjmp. mem[%__THREW__.val] is a setjmp ID that is
180 ///    stored in saveSetjmp. testSetjmp returns a setjmp label, a unique ID to
181 ///    each setjmp callsite. Label 0 means this longjmp buffer does not
182 ///    correspond to one of the setjmp callsites in this function, so in this
183 ///    case we just chain the longjmp to the caller. Label -1 means no longjmp
184 ///    occurred. Otherwise we jump to the right post-setjmp BB based on the
185 ///    label.
186 ///
187 /// * Wasm setjmp / longjmp handling
188 /// This mode still uses some Emscripten library functions but not JavaScript's
189 /// try-catch mechanism. It instead uses Wasm exception handling intrinsics,
190 /// which will be lowered to exception handling instructions.
191 ///
192 /// If there are calls to longjmp()
193 ///
194 /// 1) Lower
195 ///      longjmp(env, val)
196 ///    into
197 ///      __wasm_longjmp(env, val)
198 ///
199 /// If there are calls to setjmp()
200 ///
201 /// 2) and 3): The same as 2) and 3) in Emscripten SjLj.
202 /// (setjmpTable/setjmpTableSize initialization + setjmp callsite
203 /// transformation)
204 ///
205 /// 4) Create a catchpad with a wasm.catch() intrinsic, which returns the value
206 /// thrown by __wasm_longjmp function. In Emscripten library, we have this
207 /// struct:
208 ///
209 /// struct __WasmLongjmpArgs {
210 ///   void *env;
211 ///   int val;
212 /// };
213 /// struct __WasmLongjmpArgs __wasm_longjmp_args;
214 ///
215 /// The thrown value here is a pointer to __wasm_longjmp_args struct object. We
216 /// use this struct to transfer two values by throwing a single value. Wasm
217 /// throw and catch instructions are capable of throwing and catching multiple
218 /// values, but it also requires multivalue support that is currently not very
219 /// reliable.
220 /// TODO Switch to throwing and catching two values without using the struct
221 ///
222 /// All longjmpable function calls will be converted to an invoke that will
223 /// unwind to this catchpad in case a longjmp occurs. Within the catchpad, we
224 /// test the thrown values using testSetjmp function as we do for Emscripten
225 /// SjLj. The main difference is, in Emscripten SjLj, we need to transform every
226 /// longjmpable callsite into a sequence of code including testSetjmp() call; in
227 /// Wasm SjLj we do the testing in only one place, in this catchpad.
228 ///
229 /// After testing calling testSetjmp(), if the longjmp does not correspond to
230 /// one of the setjmps within the current function, it rethrows the longjmp
231 /// by calling __wasm_longjmp(). If it corresponds to one of setjmps in the
232 /// function, we jump to the beginning of the function, which contains a switch
233 /// to each post-setjmp BB. Again, in Emscripten SjLj, this switch is added for
234 /// every longjmpable callsite; in Wasm SjLj we do this only once at the top of
235 /// the function. (after setjmpTable/setjmpTableSize initialization)
236 ///
237 /// The below is the pseudocode for what we have described
238 ///
239 /// entry:
240 ///   Initialize setjmpTable and setjmpTableSize
241 ///
242 /// setjmp.dispatch:
243 ///    switch %label {
244 ///      label 1: goto post-setjmp BB 1
245 ///      label 2: goto post-setjmp BB 2
246 ///      ...
247 ///      default: goto splitted next BB
248 ///    }
249 /// ...
250 ///
251 /// bb:
252 ///   invoke void @foo() ;; foo is a longjmpable function
253 ///     to label %next unwind label %catch.dispatch.longjmp
254 /// ...
255 ///
256 /// catch.dispatch.longjmp:
257 ///   %0 = catchswitch within none [label %catch.longjmp] unwind to caller
258 ///
259 /// catch.longjmp:
260 ///   %longjmp.args = wasm.catch() ;; struct __WasmLongjmpArgs
261 ///   %env = load 'env' field from __WasmLongjmpArgs
262 ///   %val = load 'val' field from __WasmLongjmpArgs
263 ///   %label = testSetjmp(mem[%env], setjmpTable, setjmpTableSize);
264 ///   if (%label == 0)
265 ///     __wasm_longjmp(%env, %val)
266 ///   catchret to %setjmp.dispatch
267 ///
268 ///===----------------------------------------------------------------------===//
269 
270 #include "WebAssembly.h"
271 #include "WebAssemblyTargetMachine.h"
272 #include "llvm/ADT/StringExtras.h"
273 #include "llvm/CodeGen/TargetPassConfig.h"
274 #include "llvm/CodeGen/WasmEHFuncInfo.h"
275 #include "llvm/IR/DebugInfoMetadata.h"
276 #include "llvm/IR/Dominators.h"
277 #include "llvm/IR/IRBuilder.h"
278 #include "llvm/IR/IntrinsicsWebAssembly.h"
279 #include "llvm/Support/CommandLine.h"
280 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
281 #include "llvm/Transforms/Utils/SSAUpdater.h"
282 #include "llvm/Transforms/Utils/SSAUpdaterBulk.h"
283 
284 using namespace llvm;
285 
286 #define DEBUG_TYPE "wasm-lower-em-ehsjlj"
287 
288 // Emscripten's asm.js-style exception handling
289 extern cl::opt<bool> WasmEnableEmEH;
290 // Emscripten's asm.js-style setjmp/longjmp handling
291 extern cl::opt<bool> WasmEnableEmSjLj;
292 // Wasm setjmp/longjmp handling using wasm EH instructions
293 extern cl::opt<bool> WasmEnableSjLj;
294 
295 static cl::list<std::string>
296     EHAllowlist("emscripten-cxx-exceptions-allowed",
297                 cl::desc("The list of function names in which Emscripten-style "
298                          "exception handling is enabled (see emscripten "
299                          "EMSCRIPTEN_CATCHING_ALLOWED options)"),
300                 cl::CommaSeparated);
301 
302 namespace {
303 class WebAssemblyLowerEmscriptenEHSjLj final : public ModulePass {
304   bool EnableEmEH;     // Enable Emscripten exception handling
305   bool EnableEmSjLj;   // Enable Emscripten setjmp/longjmp handling
306   bool EnableWasmSjLj; // Enable Wasm setjmp/longjmp handling
307   bool DoSjLj;         // Whether we actually perform setjmp/longjmp handling
308 
309   GlobalVariable *ThrewGV = nullptr;      // __THREW__ (Emscripten)
310   GlobalVariable *ThrewValueGV = nullptr; // __threwValue (Emscripten)
311   Function *GetTempRet0F = nullptr;       // getTempRet0() (Emscripten)
312   Function *SetTempRet0F = nullptr;       // setTempRet0() (Emscripten)
313   Function *ResumeF = nullptr;            // __resumeException() (Emscripten)
314   Function *EHTypeIDF = nullptr;          // llvm.eh.typeid.for() (intrinsic)
315   Function *EmLongjmpF = nullptr;         // emscripten_longjmp() (Emscripten)
316   Function *SaveSetjmpF = nullptr;        // saveSetjmp() (Emscripten)
317   Function *TestSetjmpF = nullptr;        // testSetjmp() (Emscripten)
318   Function *WasmLongjmpF = nullptr;       // __wasm_longjmp() (Emscripten)
319   Function *CatchF = nullptr;             // wasm.catch() (intrinsic)
320 
321   // type of 'struct __WasmLongjmpArgs' defined in emscripten
322   Type *LongjmpArgsTy = nullptr;
323 
324   // __cxa_find_matching_catch_N functions.
325   // Indexed by the number of clauses in an original landingpad instruction.
326   DenseMap<int, Function *> FindMatchingCatches;
327   // Map of <function signature string, invoke_ wrappers>
328   StringMap<Function *> InvokeWrappers;
329   // Set of allowed function names for exception handling
330   std::set<std::string> EHAllowlistSet;
331   // Functions that contains calls to setjmp
332   SmallPtrSet<Function *, 8> SetjmpUsers;
333 
334   StringRef getPassName() const override {
335     return "WebAssembly Lower Emscripten Exceptions";
336   }
337 
338   using InstVector = SmallVectorImpl<Instruction *>;
339   bool runEHOnFunction(Function &F);
340   bool runSjLjOnFunction(Function &F);
341   void handleLongjmpableCallsForEmscriptenSjLj(
342       Function &F, InstVector &SetjmpTableInsts,
343       InstVector &SetjmpTableSizeInsts,
344       SmallVectorImpl<PHINode *> &SetjmpRetPHIs);
345   void
346   handleLongjmpableCallsForWasmSjLj(Function &F, InstVector &SetjmpTableInsts,
347                                     InstVector &SetjmpTableSizeInsts,
348                                     SmallVectorImpl<PHINode *> &SetjmpRetPHIs);
349   Function *getFindMatchingCatch(Module &M, unsigned NumClauses);
350 
351   Value *wrapInvoke(CallBase *CI);
352   void wrapTestSetjmp(BasicBlock *BB, DebugLoc DL, Value *Threw,
353                       Value *SetjmpTable, Value *SetjmpTableSize, Value *&Label,
354                       Value *&LongjmpResult, BasicBlock *&CallEmLongjmpBB,
355                       PHINode *&CallEmLongjmpBBThrewPHI,
356                       PHINode *&CallEmLongjmpBBThrewValuePHI,
357                       BasicBlock *&EndBB);
358   Function *getInvokeWrapper(CallBase *CI);
359 
360   bool areAllExceptionsAllowed() const { return EHAllowlistSet.empty(); }
361   bool supportsException(const Function *F) const {
362     return EnableEmEH && (areAllExceptionsAllowed() ||
363                           EHAllowlistSet.count(std::string(F->getName())));
364   }
365   void replaceLongjmpWith(Function *LongjmpF, Function *NewF);
366 
367   void rebuildSSA(Function &F);
368 
369 public:
370   static char ID;
371 
372   WebAssemblyLowerEmscriptenEHSjLj()
373       : ModulePass(ID), EnableEmEH(WasmEnableEmEH),
374         EnableEmSjLj(WasmEnableEmSjLj), EnableWasmSjLj(WasmEnableSjLj) {
375     assert(!(EnableEmSjLj && EnableWasmSjLj) &&
376            "Two SjLj modes cannot be turned on at the same time");
377     assert(!(EnableEmEH && EnableWasmSjLj) &&
378            "Wasm SjLj should be only used with Wasm EH");
379     EHAllowlistSet.insert(EHAllowlist.begin(), EHAllowlist.end());
380   }
381   bool runOnModule(Module &M) override;
382 
383   void getAnalysisUsage(AnalysisUsage &AU) const override {
384     AU.addRequired<DominatorTreeWrapperPass>();
385   }
386 };
387 } // End anonymous namespace
388 
389 char WebAssemblyLowerEmscriptenEHSjLj::ID = 0;
390 INITIALIZE_PASS(WebAssemblyLowerEmscriptenEHSjLj, DEBUG_TYPE,
391                 "WebAssembly Lower Emscripten Exceptions / Setjmp / Longjmp",
392                 false, false)
393 
394 ModulePass *llvm::createWebAssemblyLowerEmscriptenEHSjLj() {
395   return new WebAssemblyLowerEmscriptenEHSjLj();
396 }
397 
398 static bool canThrow(const Value *V) {
399   if (const auto *F = dyn_cast<const Function>(V)) {
400     // Intrinsics cannot throw
401     if (F->isIntrinsic())
402       return false;
403     StringRef Name = F->getName();
404     // leave setjmp and longjmp (mostly) alone, we process them properly later
405     if (Name == "setjmp" || Name == "longjmp" || Name == "emscripten_longjmp")
406       return false;
407     return !F->doesNotThrow();
408   }
409   // not a function, so an indirect call - can throw, we can't tell
410   return true;
411 }
412 
413 // Get a global variable with the given name. If it doesn't exist declare it,
414 // which will generate an import and assume that it will exist at link time.
415 static GlobalVariable *getGlobalVariable(Module &M, Type *Ty,
416                                          WebAssemblyTargetMachine &TM,
417                                          const char *Name) {
418   auto *GV = dyn_cast<GlobalVariable>(M.getOrInsertGlobal(Name, Ty));
419   if (!GV)
420     report_fatal_error(Twine("unable to create global: ") + Name);
421 
422   // If the target supports TLS, make this variable thread-local. We can't just
423   // unconditionally make it thread-local and depend on
424   // CoalesceFeaturesAndStripAtomics to downgrade it, because stripping TLS has
425   // the side effect of disallowing the object from being linked into a
426   // shared-memory module, which we don't want to be responsible for.
427   auto *Subtarget = TM.getSubtargetImpl();
428   auto TLS = Subtarget->hasAtomics() && Subtarget->hasBulkMemory()
429                  ? GlobalValue::LocalExecTLSModel
430                  : GlobalValue::NotThreadLocal;
431   GV->setThreadLocalMode(TLS);
432   return GV;
433 }
434 
435 // Simple function name mangler.
436 // This function simply takes LLVM's string representation of parameter types
437 // and concatenate them with '_'. There are non-alphanumeric characters but llc
438 // is ok with it, and we need to postprocess these names after the lowering
439 // phase anyway.
440 static std::string getSignature(FunctionType *FTy) {
441   std::string Sig;
442   raw_string_ostream OS(Sig);
443   OS << *FTy->getReturnType();
444   for (Type *ParamTy : FTy->params())
445     OS << "_" << *ParamTy;
446   if (FTy->isVarArg())
447     OS << "_...";
448   Sig = OS.str();
449   erase_if(Sig, isSpace);
450   // When s2wasm parses .s file, a comma means the end of an argument. So a
451   // mangled function name can contain any character but a comma.
452   std::replace(Sig.begin(), Sig.end(), ',', '.');
453   return Sig;
454 }
455 
456 static Function *getEmscriptenFunction(FunctionType *Ty, const Twine &Name,
457                                        Module *M) {
458   Function* F = Function::Create(Ty, GlobalValue::ExternalLinkage, Name, M);
459   // Tell the linker that this function is expected to be imported from the
460   // 'env' module.
461   if (!F->hasFnAttribute("wasm-import-module")) {
462     llvm::AttrBuilder B;
463     B.addAttribute("wasm-import-module", "env");
464     F->addFnAttrs(B);
465   }
466   if (!F->hasFnAttribute("wasm-import-name")) {
467     llvm::AttrBuilder B;
468     B.addAttribute("wasm-import-name", F->getName());
469     F->addFnAttrs(B);
470   }
471   return F;
472 }
473 
474 // Returns an integer type for the target architecture's address space.
475 // i32 for wasm32 and i64 for wasm64.
476 static Type *getAddrIntType(Module *M) {
477   IRBuilder<> IRB(M->getContext());
478   return IRB.getIntNTy(M->getDataLayout().getPointerSizeInBits());
479 }
480 
481 // Returns an integer pointer type for the target architecture's address space.
482 // i32* for wasm32 and i64* for wasm64.
483 static Type *getAddrPtrType(Module *M) {
484   return Type::getIntNPtrTy(M->getContext(),
485                             M->getDataLayout().getPointerSizeInBits());
486 }
487 
488 // Returns an integer whose type is the integer type for the target's address
489 // space. Returns (i32 C) for wasm32 and (i64 C) for wasm64, when C is the
490 // integer.
491 static Value *getAddrSizeInt(Module *M, uint64_t C) {
492   IRBuilder<> IRB(M->getContext());
493   return IRB.getIntN(M->getDataLayout().getPointerSizeInBits(), C);
494 }
495 
496 // Returns __cxa_find_matching_catch_N function, where N = NumClauses + 2.
497 // This is because a landingpad instruction contains two more arguments, a
498 // personality function and a cleanup bit, and __cxa_find_matching_catch_N
499 // functions are named after the number of arguments in the original landingpad
500 // instruction.
501 Function *
502 WebAssemblyLowerEmscriptenEHSjLj::getFindMatchingCatch(Module &M,
503                                                        unsigned NumClauses) {
504   if (FindMatchingCatches.count(NumClauses))
505     return FindMatchingCatches[NumClauses];
506   PointerType *Int8PtrTy = Type::getInt8PtrTy(M.getContext());
507   SmallVector<Type *, 16> Args(NumClauses, Int8PtrTy);
508   FunctionType *FTy = FunctionType::get(Int8PtrTy, Args, false);
509   Function *F = getEmscriptenFunction(
510       FTy, "__cxa_find_matching_catch_" + Twine(NumClauses + 2), &M);
511   FindMatchingCatches[NumClauses] = F;
512   return F;
513 }
514 
515 // Generate invoke wrapper seqence with preamble and postamble
516 // Preamble:
517 // __THREW__ = 0;
518 // Postamble:
519 // %__THREW__.val = __THREW__; __THREW__ = 0;
520 // Returns %__THREW__.val, which indicates whether an exception is thrown (or
521 // whether longjmp occurred), for future use.
522 Value *WebAssemblyLowerEmscriptenEHSjLj::wrapInvoke(CallBase *CI) {
523   Module *M = CI->getModule();
524   LLVMContext &C = M->getContext();
525 
526   IRBuilder<> IRB(C);
527   IRB.SetInsertPoint(CI);
528 
529   // Pre-invoke
530   // __THREW__ = 0;
531   IRB.CreateStore(getAddrSizeInt(M, 0), ThrewGV);
532 
533   // Invoke function wrapper in JavaScript
534   SmallVector<Value *, 16> Args;
535   // Put the pointer to the callee as first argument, so it can be called
536   // within the invoke wrapper later
537   Args.push_back(CI->getCalledOperand());
538   Args.append(CI->arg_begin(), CI->arg_end());
539   CallInst *NewCall = IRB.CreateCall(getInvokeWrapper(CI), Args);
540   NewCall->takeName(CI);
541   NewCall->setCallingConv(CallingConv::WASM_EmscriptenInvoke);
542   NewCall->setDebugLoc(CI->getDebugLoc());
543 
544   // Because we added the pointer to the callee as first argument, all
545   // argument attribute indices have to be incremented by one.
546   SmallVector<AttributeSet, 8> ArgAttributes;
547   const AttributeList &InvokeAL = CI->getAttributes();
548 
549   // No attributes for the callee pointer.
550   ArgAttributes.push_back(AttributeSet());
551   // Copy the argument attributes from the original
552   for (unsigned I = 0, E = CI->getNumArgOperands(); I < E; ++I)
553     ArgAttributes.push_back(InvokeAL.getParamAttrs(I));
554 
555   AttrBuilder FnAttrs(InvokeAL.getFnAttrs());
556   if (FnAttrs.contains(Attribute::AllocSize)) {
557     // The allocsize attribute (if any) referes to parameters by index and needs
558     // to be adjusted.
559     unsigned SizeArg;
560     Optional<unsigned> NEltArg;
561     std::tie(SizeArg, NEltArg) = FnAttrs.getAllocSizeArgs();
562     SizeArg += 1;
563     if (NEltArg.hasValue())
564       NEltArg = NEltArg.getValue() + 1;
565     FnAttrs.addAllocSizeAttr(SizeArg, NEltArg);
566   }
567 
568   // Reconstruct the AttributesList based on the vector we constructed.
569   AttributeList NewCallAL = AttributeList::get(
570       C, AttributeSet::get(C, FnAttrs), InvokeAL.getRetAttrs(), ArgAttributes);
571   NewCall->setAttributes(NewCallAL);
572 
573   CI->replaceAllUsesWith(NewCall);
574 
575   // Post-invoke
576   // %__THREW__.val = __THREW__; __THREW__ = 0;
577   Value *Threw =
578       IRB.CreateLoad(getAddrIntType(M), ThrewGV, ThrewGV->getName() + ".val");
579   IRB.CreateStore(getAddrSizeInt(M, 0), ThrewGV);
580   return Threw;
581 }
582 
583 // Get matching invoke wrapper based on callee signature
584 Function *WebAssemblyLowerEmscriptenEHSjLj::getInvokeWrapper(CallBase *CI) {
585   Module *M = CI->getModule();
586   SmallVector<Type *, 16> ArgTys;
587   FunctionType *CalleeFTy = CI->getFunctionType();
588 
589   std::string Sig = getSignature(CalleeFTy);
590   if (InvokeWrappers.find(Sig) != InvokeWrappers.end())
591     return InvokeWrappers[Sig];
592 
593   // Put the pointer to the callee as first argument
594   ArgTys.push_back(PointerType::getUnqual(CalleeFTy));
595   // Add argument types
596   ArgTys.append(CalleeFTy->param_begin(), CalleeFTy->param_end());
597 
598   FunctionType *FTy = FunctionType::get(CalleeFTy->getReturnType(), ArgTys,
599                                         CalleeFTy->isVarArg());
600   Function *F = getEmscriptenFunction(FTy, "__invoke_" + Sig, M);
601   InvokeWrappers[Sig] = F;
602   return F;
603 }
604 
605 static bool canLongjmp(const Value *Callee) {
606   if (auto *CalleeF = dyn_cast<Function>(Callee))
607     if (CalleeF->isIntrinsic())
608       return false;
609 
610   // Attempting to transform inline assembly will result in something like:
611   //     call void @__invoke_void(void ()* asm ...)
612   // which is invalid because inline assembly blocks do not have addresses
613   // and can't be passed by pointer. The result is a crash with illegal IR.
614   if (isa<InlineAsm>(Callee))
615     return false;
616   StringRef CalleeName = Callee->getName();
617 
618   // The reason we include malloc/free here is to exclude the malloc/free
619   // calls generated in setjmp prep / cleanup routines.
620   if (CalleeName == "setjmp" || CalleeName == "malloc" || CalleeName == "free")
621     return false;
622 
623   // There are functions in Emscripten's JS glue code or compiler-rt
624   if (CalleeName == "__resumeException" || CalleeName == "llvm_eh_typeid_for" ||
625       CalleeName == "saveSetjmp" || CalleeName == "testSetjmp" ||
626       CalleeName == "getTempRet0" || CalleeName == "setTempRet0")
627     return false;
628 
629   // __cxa_find_matching_catch_N functions cannot longjmp
630   if (Callee->getName().startswith("__cxa_find_matching_catch_"))
631     return false;
632 
633   // Exception-catching related functions
634   if (CalleeName == "__cxa_begin_catch" || CalleeName == "__cxa_end_catch" ||
635       CalleeName == "__cxa_allocate_exception" || CalleeName == "__cxa_throw" ||
636       CalleeName == "__clang_call_terminate")
637     return false;
638 
639   // Otherwise we don't know
640   return true;
641 }
642 
643 static bool isEmAsmCall(const Value *Callee) {
644   StringRef CalleeName = Callee->getName();
645   // This is an exhaustive list from Emscripten's <emscripten/em_asm.h>.
646   return CalleeName == "emscripten_asm_const_int" ||
647          CalleeName == "emscripten_asm_const_double" ||
648          CalleeName == "emscripten_asm_const_int_sync_on_main_thread" ||
649          CalleeName == "emscripten_asm_const_double_sync_on_main_thread" ||
650          CalleeName == "emscripten_asm_const_async_on_main_thread";
651 }
652 
653 // Generate testSetjmp function call seqence with preamble and postamble.
654 // The code this generates is equivalent to the following JavaScript code:
655 // %__threwValue.val = __threwValue;
656 // if (%__THREW__.val != 0 & %__threwValue.val != 0) {
657 //   %label = testSetjmp(mem[%__THREW__.val], setjmpTable, setjmpTableSize);
658 //   if (%label == 0)
659 //     emscripten_longjmp(%__THREW__.val, %__threwValue.val);
660 //   setTempRet0(%__threwValue.val);
661 // } else {
662 //   %label = -1;
663 // }
664 // %longjmp_result = getTempRet0();
665 //
666 // As output parameters. returns %label, %longjmp_result, and the BB the last
667 // instruction (%longjmp_result = ...) is in.
668 void WebAssemblyLowerEmscriptenEHSjLj::wrapTestSetjmp(
669     BasicBlock *BB, DebugLoc DL, Value *Threw, Value *SetjmpTable,
670     Value *SetjmpTableSize, Value *&Label, Value *&LongjmpResult,
671     BasicBlock *&CallEmLongjmpBB, PHINode *&CallEmLongjmpBBThrewPHI,
672     PHINode *&CallEmLongjmpBBThrewValuePHI, BasicBlock *&EndBB) {
673   Function *F = BB->getParent();
674   Module *M = F->getParent();
675   LLVMContext &C = M->getContext();
676   IRBuilder<> IRB(C);
677   IRB.SetCurrentDebugLocation(DL);
678 
679   // if (%__THREW__.val != 0 & %__threwValue.val != 0)
680   IRB.SetInsertPoint(BB);
681   BasicBlock *ThenBB1 = BasicBlock::Create(C, "if.then1", F);
682   BasicBlock *ElseBB1 = BasicBlock::Create(C, "if.else1", F);
683   BasicBlock *EndBB1 = BasicBlock::Create(C, "if.end", F);
684   Value *ThrewCmp = IRB.CreateICmpNE(Threw, getAddrSizeInt(M, 0));
685   Value *ThrewValue = IRB.CreateLoad(IRB.getInt32Ty(), ThrewValueGV,
686                                      ThrewValueGV->getName() + ".val");
687   Value *ThrewValueCmp = IRB.CreateICmpNE(ThrewValue, IRB.getInt32(0));
688   Value *Cmp1 = IRB.CreateAnd(ThrewCmp, ThrewValueCmp, "cmp1");
689   IRB.CreateCondBr(Cmp1, ThenBB1, ElseBB1);
690 
691   // Generate call.em.longjmp BB once and share it within the function
692   if (!CallEmLongjmpBB) {
693     // emscripten_longjmp(%__THREW__.val, %__threwValue.val);
694     CallEmLongjmpBB = BasicBlock::Create(C, "call.em.longjmp", F);
695     IRB.SetInsertPoint(CallEmLongjmpBB);
696     CallEmLongjmpBBThrewPHI = IRB.CreatePHI(getAddrIntType(M), 4, "threw.phi");
697     CallEmLongjmpBBThrewValuePHI =
698         IRB.CreatePHI(IRB.getInt32Ty(), 4, "threwvalue.phi");
699     CallEmLongjmpBBThrewPHI->addIncoming(Threw, ThenBB1);
700     CallEmLongjmpBBThrewValuePHI->addIncoming(ThrewValue, ThenBB1);
701     IRB.CreateCall(EmLongjmpF,
702                    {CallEmLongjmpBBThrewPHI, CallEmLongjmpBBThrewValuePHI});
703     IRB.CreateUnreachable();
704   } else {
705     CallEmLongjmpBBThrewPHI->addIncoming(Threw, ThenBB1);
706     CallEmLongjmpBBThrewValuePHI->addIncoming(ThrewValue, ThenBB1);
707   }
708 
709   // %label = testSetjmp(mem[%__THREW__.val], setjmpTable, setjmpTableSize);
710   // if (%label == 0)
711   IRB.SetInsertPoint(ThenBB1);
712   BasicBlock *EndBB2 = BasicBlock::Create(C, "if.end2", F);
713   Value *ThrewPtr =
714       IRB.CreateIntToPtr(Threw, getAddrPtrType(M), Threw->getName() + ".p");
715   Value *LoadedThrew = IRB.CreateLoad(getAddrIntType(M), ThrewPtr,
716                                       ThrewPtr->getName() + ".loaded");
717   Value *ThenLabel = IRB.CreateCall(
718       TestSetjmpF, {LoadedThrew, SetjmpTable, SetjmpTableSize}, "label");
719   Value *Cmp2 = IRB.CreateICmpEQ(ThenLabel, IRB.getInt32(0));
720   IRB.CreateCondBr(Cmp2, CallEmLongjmpBB, EndBB2);
721 
722   // setTempRet0(%__threwValue.val);
723   IRB.SetInsertPoint(EndBB2);
724   IRB.CreateCall(SetTempRet0F, ThrewValue);
725   IRB.CreateBr(EndBB1);
726 
727   IRB.SetInsertPoint(ElseBB1);
728   IRB.CreateBr(EndBB1);
729 
730   // longjmp_result = getTempRet0();
731   IRB.SetInsertPoint(EndBB1);
732   PHINode *LabelPHI = IRB.CreatePHI(IRB.getInt32Ty(), 2, "label");
733   LabelPHI->addIncoming(ThenLabel, EndBB2);
734 
735   LabelPHI->addIncoming(IRB.getInt32(-1), ElseBB1);
736 
737   // Output parameter assignment
738   Label = LabelPHI;
739   EndBB = EndBB1;
740   LongjmpResult = IRB.CreateCall(GetTempRet0F, None, "longjmp_result");
741 }
742 
743 void WebAssemblyLowerEmscriptenEHSjLj::rebuildSSA(Function &F) {
744   DominatorTree &DT = getAnalysis<DominatorTreeWrapperPass>(F).getDomTree();
745   DT.recalculate(F); // CFG has been changed
746 
747   SSAUpdaterBulk SSA;
748   for (BasicBlock &BB : F) {
749     for (Instruction &I : BB) {
750       unsigned VarID = SSA.AddVariable(I.getName(), I.getType());
751       // If a value is defined by an invoke instruction, it is only available in
752       // its normal destination and not in its unwind destination.
753       if (auto *II = dyn_cast<InvokeInst>(&I))
754         SSA.AddAvailableValue(VarID, II->getNormalDest(), II);
755       else
756         SSA.AddAvailableValue(VarID, &BB, &I);
757       for (auto &U : I.uses()) {
758         auto *User = cast<Instruction>(U.getUser());
759         if (auto *UserPN = dyn_cast<PHINode>(User))
760           if (UserPN->getIncomingBlock(U) == &BB)
761             continue;
762         if (DT.dominates(&I, User))
763           continue;
764         SSA.AddUse(VarID, &U);
765       }
766     }
767   }
768   SSA.RewriteAllUses(&DT);
769 }
770 
771 // Replace uses of longjmp with a new longjmp function in Emscripten library.
772 // In Emscripten SjLj, the new function is
773 //   void emscripten_longjmp(uintptr_t, i32)
774 // In Wasm SjLj, the new function is
775 //   void __wasm_longjmp(i8*, i32)
776 // Because the original libc longjmp function takes (jmp_buf*, i32), we need a
777 // ptrtoint/bitcast instruction here to make the type match. jmp_buf* will
778 // eventually be lowered to i32/i64 in the wasm backend.
779 void WebAssemblyLowerEmscriptenEHSjLj::replaceLongjmpWith(Function *LongjmpF,
780                                                           Function *NewF) {
781   assert(NewF == EmLongjmpF || NewF == WasmLongjmpF);
782   Module *M = LongjmpF->getParent();
783   SmallVector<CallInst *, 8> ToErase;
784   LLVMContext &C = LongjmpF->getParent()->getContext();
785   IRBuilder<> IRB(C);
786 
787   // For calls to longjmp, replace it with emscripten_longjmp/__wasm_longjmp and
788   // cast its first argument (jmp_buf*) appropriately
789   for (User *U : LongjmpF->users()) {
790     auto *CI = dyn_cast<CallInst>(U);
791     if (CI && CI->getCalledFunction() == LongjmpF) {
792       IRB.SetInsertPoint(CI);
793       Value *Env = nullptr;
794       if (NewF == EmLongjmpF)
795         Env =
796             IRB.CreatePtrToInt(CI->getArgOperand(0), getAddrIntType(M), "env");
797       else // WasmLongjmpF
798         Env =
799             IRB.CreateBitCast(CI->getArgOperand(0), IRB.getInt8PtrTy(), "env");
800       IRB.CreateCall(NewF, {Env, CI->getArgOperand(1)});
801       ToErase.push_back(CI);
802     }
803   }
804   for (auto *I : ToErase)
805     I->eraseFromParent();
806 
807   // If we have any remaining uses of longjmp's function pointer, replace it
808   // with (void(*)(jmp_buf*, int))emscripten_longjmp / __wasm_longjmp.
809   if (!LongjmpF->uses().empty()) {
810     Value *NewLongjmp =
811         IRB.CreateBitCast(NewF, LongjmpF->getType(), "longjmp.cast");
812     LongjmpF->replaceAllUsesWith(NewLongjmp);
813   }
814 }
815 
816 static bool containsLongjmpableCalls(const Function *F) {
817   for (const auto &BB : *F)
818     for (const auto &I : BB)
819       if (const auto *CB = dyn_cast<CallBase>(&I))
820         if (canLongjmp(CB->getCalledOperand()))
821           return true;
822   return false;
823 }
824 
825 bool WebAssemblyLowerEmscriptenEHSjLj::runOnModule(Module &M) {
826   LLVM_DEBUG(dbgs() << "********** Lower Emscripten EH & SjLj **********\n");
827 
828   LLVMContext &C = M.getContext();
829   IRBuilder<> IRB(C);
830 
831   Function *SetjmpF = M.getFunction("setjmp");
832   Function *LongjmpF = M.getFunction("longjmp");
833 
834   auto *TPC = getAnalysisIfAvailable<TargetPassConfig>();
835   assert(TPC && "Expected a TargetPassConfig");
836   auto &TM = TPC->getTM<WebAssemblyTargetMachine>();
837 
838   // Declare (or get) global variables __THREW__, __threwValue, and
839   // getTempRet0/setTempRet0 function which are used in common for both
840   // exception handling and setjmp/longjmp handling
841   ThrewGV = getGlobalVariable(M, getAddrIntType(&M), TM, "__THREW__");
842   ThrewValueGV = getGlobalVariable(M, IRB.getInt32Ty(), TM, "__threwValue");
843   GetTempRet0F = getEmscriptenFunction(
844       FunctionType::get(IRB.getInt32Ty(), false), "getTempRet0", &M);
845   SetTempRet0F = getEmscriptenFunction(
846       FunctionType::get(IRB.getVoidTy(), IRB.getInt32Ty(), false),
847       "setTempRet0", &M);
848   GetTempRet0F->setDoesNotThrow();
849   SetTempRet0F->setDoesNotThrow();
850 
851   bool Changed = false;
852 
853   // Function registration for exception handling
854   if (EnableEmEH) {
855     // Register __resumeException function
856     FunctionType *ResumeFTy =
857         FunctionType::get(IRB.getVoidTy(), IRB.getInt8PtrTy(), false);
858     ResumeF = getEmscriptenFunction(ResumeFTy, "__resumeException", &M);
859     ResumeF->addFnAttr(Attribute::NoReturn);
860 
861     // Register llvm_eh_typeid_for function
862     FunctionType *EHTypeIDTy =
863         FunctionType::get(IRB.getInt32Ty(), IRB.getInt8PtrTy(), false);
864     EHTypeIDF = getEmscriptenFunction(EHTypeIDTy, "llvm_eh_typeid_for", &M);
865   }
866 
867   if ((EnableEmSjLj || EnableWasmSjLj) && SetjmpF) {
868     // Precompute setjmp users
869     for (User *U : SetjmpF->users()) {
870       if (auto *CB = dyn_cast<CallBase>(U)) {
871         auto *UserF = CB->getFunction();
872         // If a function that calls setjmp does not contain any other calls that
873         // can longjmp, we don't need to do any transformation on that function,
874         // so can ignore it
875         if (containsLongjmpableCalls(UserF))
876           SetjmpUsers.insert(UserF);
877       } else {
878         std::string S;
879         raw_string_ostream SS(S);
880         SS << *U;
881         report_fatal_error(Twine("Indirect use of setjmp is not supported: ") +
882                            SS.str());
883       }
884     }
885   }
886 
887   bool SetjmpUsed = SetjmpF && !SetjmpUsers.empty();
888   bool LongjmpUsed = LongjmpF && !LongjmpF->use_empty();
889   DoSjLj = (EnableEmSjLj | EnableWasmSjLj) && (SetjmpUsed || LongjmpUsed);
890 
891   // Function registration and data pre-gathering for setjmp/longjmp handling
892   if (DoSjLj) {
893     assert(EnableEmSjLj || EnableWasmSjLj);
894     if (EnableEmSjLj) {
895       // Register emscripten_longjmp function
896       FunctionType *FTy = FunctionType::get(
897           IRB.getVoidTy(), {getAddrIntType(&M), IRB.getInt32Ty()}, false);
898       EmLongjmpF = getEmscriptenFunction(FTy, "emscripten_longjmp", &M);
899       EmLongjmpF->addFnAttr(Attribute::NoReturn);
900     } else { // EnableWasmSjLj
901       // Register __wasm_longjmp function, which calls __builtin_wasm_longjmp.
902       FunctionType *FTy = FunctionType::get(
903           IRB.getVoidTy(), {IRB.getInt8PtrTy(), IRB.getInt32Ty()}, false);
904       WasmLongjmpF = getEmscriptenFunction(FTy, "__wasm_longjmp", &M);
905       WasmLongjmpF->addFnAttr(Attribute::NoReturn);
906     }
907 
908     if (SetjmpF) {
909       // Register saveSetjmp function
910       FunctionType *SetjmpFTy = SetjmpF->getFunctionType();
911       FunctionType *FTy =
912           FunctionType::get(Type::getInt32PtrTy(C),
913                             {SetjmpFTy->getParamType(0), IRB.getInt32Ty(),
914                              Type::getInt32PtrTy(C), IRB.getInt32Ty()},
915                             false);
916       SaveSetjmpF = getEmscriptenFunction(FTy, "saveSetjmp", &M);
917 
918       // Register testSetjmp function
919       FTy = FunctionType::get(
920           IRB.getInt32Ty(),
921           {getAddrIntType(&M), Type::getInt32PtrTy(C), IRB.getInt32Ty()},
922           false);
923       TestSetjmpF = getEmscriptenFunction(FTy, "testSetjmp", &M);
924 
925       // wasm.catch() will be lowered down to wasm 'catch' instruction in
926       // instruction selection.
927       CatchF = Intrinsic::getDeclaration(&M, Intrinsic::wasm_catch);
928       // Type for struct __WasmLongjmpArgs
929       LongjmpArgsTy = StructType::get(IRB.getInt8PtrTy(), // env
930                                       IRB.getInt32Ty()    // val
931       );
932     }
933   }
934 
935   // Exception handling transformation
936   if (EnableEmEH) {
937     for (Function &F : M) {
938       if (F.isDeclaration())
939         continue;
940       Changed |= runEHOnFunction(F);
941     }
942   }
943 
944   // Setjmp/longjmp handling transformation
945   if (DoSjLj) {
946     Changed = true; // We have setjmp or longjmp somewhere
947     if (LongjmpF)
948       replaceLongjmpWith(LongjmpF, EnableEmSjLj ? EmLongjmpF : WasmLongjmpF);
949     // Only traverse functions that uses setjmp in order not to insert
950     // unnecessary prep / cleanup code in every function
951     if (SetjmpF)
952       for (Function *F : SetjmpUsers)
953         runSjLjOnFunction(*F);
954   }
955 
956   if (!Changed) {
957     // Delete unused global variables and functions
958     if (ResumeF)
959       ResumeF->eraseFromParent();
960     if (EHTypeIDF)
961       EHTypeIDF->eraseFromParent();
962     if (EmLongjmpF)
963       EmLongjmpF->eraseFromParent();
964     if (SaveSetjmpF)
965       SaveSetjmpF->eraseFromParent();
966     if (TestSetjmpF)
967       TestSetjmpF->eraseFromParent();
968     return false;
969   }
970 
971   return true;
972 }
973 
974 bool WebAssemblyLowerEmscriptenEHSjLj::runEHOnFunction(Function &F) {
975   Module &M = *F.getParent();
976   LLVMContext &C = F.getContext();
977   IRBuilder<> IRB(C);
978   bool Changed = false;
979   SmallVector<Instruction *, 64> ToErase;
980   SmallPtrSet<LandingPadInst *, 32> LandingPads;
981 
982   // rethrow.longjmp BB that will be shared within the function.
983   BasicBlock *RethrowLongjmpBB = nullptr;
984   // PHI node for the loaded value of __THREW__ global variable in
985   // rethrow.longjmp BB
986   PHINode *RethrowLongjmpBBThrewPHI = nullptr;
987 
988   for (BasicBlock &BB : F) {
989     auto *II = dyn_cast<InvokeInst>(BB.getTerminator());
990     if (!II)
991       continue;
992     Changed = true;
993     LandingPads.insert(II->getLandingPadInst());
994     IRB.SetInsertPoint(II);
995 
996     const Value *Callee = II->getCalledOperand();
997     bool NeedInvoke = supportsException(&F) && canThrow(Callee);
998     if (NeedInvoke) {
999       // Wrap invoke with invoke wrapper and generate preamble/postamble
1000       Value *Threw = wrapInvoke(II);
1001       ToErase.push_back(II);
1002 
1003       // If setjmp/longjmp handling is enabled, the thrown value can be not an
1004       // exception but a longjmp. If the current function contains calls to
1005       // setjmp, it will be appropriately handled in runSjLjOnFunction. But even
1006       // if the function does not contain setjmp calls, we shouldn't silently
1007       // ignore longjmps; we should rethrow them so they can be correctly
1008       // handled in somewhere up the call chain where setjmp is. __THREW__'s
1009       // value is 0 when nothing happened, 1 when an exception is thrown, and
1010       // other values when longjmp is thrown.
1011       //
1012       // if (%__THREW__.val == 0 || %__THREW__.val == 1)
1013       //   goto %tail
1014       // else
1015       //   goto %longjmp.rethrow
1016       //
1017       // rethrow.longjmp: ;; This is longjmp. Rethrow it
1018       //   %__threwValue.val = __threwValue
1019       //   emscripten_longjmp(%__THREW__.val, %__threwValue.val);
1020       //
1021       // tail: ;; Nothing happened or an exception is thrown
1022       //   ... Continue exception handling ...
1023       if (DoSjLj && EnableEmSjLj && !SetjmpUsers.count(&F) &&
1024           canLongjmp(Callee)) {
1025         // Create longjmp.rethrow BB once and share it within the function
1026         if (!RethrowLongjmpBB) {
1027           RethrowLongjmpBB = BasicBlock::Create(C, "rethrow.longjmp", &F);
1028           IRB.SetInsertPoint(RethrowLongjmpBB);
1029           RethrowLongjmpBBThrewPHI =
1030               IRB.CreatePHI(getAddrIntType(&M), 4, "threw.phi");
1031           RethrowLongjmpBBThrewPHI->addIncoming(Threw, &BB);
1032           Value *ThrewValue = IRB.CreateLoad(IRB.getInt32Ty(), ThrewValueGV,
1033                                              ThrewValueGV->getName() + ".val");
1034           IRB.CreateCall(EmLongjmpF, {RethrowLongjmpBBThrewPHI, ThrewValue});
1035           IRB.CreateUnreachable();
1036         } else {
1037           RethrowLongjmpBBThrewPHI->addIncoming(Threw, &BB);
1038         }
1039 
1040         IRB.SetInsertPoint(II); // Restore the insert point back
1041         BasicBlock *Tail = BasicBlock::Create(C, "tail", &F);
1042         Value *CmpEqOne =
1043             IRB.CreateICmpEQ(Threw, getAddrSizeInt(&M, 1), "cmp.eq.one");
1044         Value *CmpEqZero =
1045             IRB.CreateICmpEQ(Threw, getAddrSizeInt(&M, 0), "cmp.eq.zero");
1046         Value *Or = IRB.CreateOr(CmpEqZero, CmpEqOne, "or");
1047         IRB.CreateCondBr(Or, Tail, RethrowLongjmpBB);
1048         IRB.SetInsertPoint(Tail);
1049         BB.replaceSuccessorsPhiUsesWith(&BB, Tail);
1050       }
1051 
1052       // Insert a branch based on __THREW__ variable
1053       Value *Cmp = IRB.CreateICmpEQ(Threw, getAddrSizeInt(&M, 1), "cmp");
1054       IRB.CreateCondBr(Cmp, II->getUnwindDest(), II->getNormalDest());
1055 
1056     } else {
1057       // This can't throw, and we don't need this invoke, just replace it with a
1058       // call+branch
1059       SmallVector<Value *, 16> Args(II->args());
1060       CallInst *NewCall =
1061           IRB.CreateCall(II->getFunctionType(), II->getCalledOperand(), Args);
1062       NewCall->takeName(II);
1063       NewCall->setCallingConv(II->getCallingConv());
1064       NewCall->setDebugLoc(II->getDebugLoc());
1065       NewCall->setAttributes(II->getAttributes());
1066       II->replaceAllUsesWith(NewCall);
1067       ToErase.push_back(II);
1068 
1069       IRB.CreateBr(II->getNormalDest());
1070 
1071       // Remove any PHI node entries from the exception destination
1072       II->getUnwindDest()->removePredecessor(&BB);
1073     }
1074   }
1075 
1076   // Process resume instructions
1077   for (BasicBlock &BB : F) {
1078     // Scan the body of the basic block for resumes
1079     for (Instruction &I : BB) {
1080       auto *RI = dyn_cast<ResumeInst>(&I);
1081       if (!RI)
1082         continue;
1083       Changed = true;
1084 
1085       // Split the input into legal values
1086       Value *Input = RI->getValue();
1087       IRB.SetInsertPoint(RI);
1088       Value *Low = IRB.CreateExtractValue(Input, 0, "low");
1089       // Create a call to __resumeException function
1090       IRB.CreateCall(ResumeF, {Low});
1091       // Add a terminator to the block
1092       IRB.CreateUnreachable();
1093       ToErase.push_back(RI);
1094     }
1095   }
1096 
1097   // Process llvm.eh.typeid.for intrinsics
1098   for (BasicBlock &BB : F) {
1099     for (Instruction &I : BB) {
1100       auto *CI = dyn_cast<CallInst>(&I);
1101       if (!CI)
1102         continue;
1103       const Function *Callee = CI->getCalledFunction();
1104       if (!Callee)
1105         continue;
1106       if (Callee->getIntrinsicID() != Intrinsic::eh_typeid_for)
1107         continue;
1108       Changed = true;
1109 
1110       IRB.SetInsertPoint(CI);
1111       CallInst *NewCI =
1112           IRB.CreateCall(EHTypeIDF, CI->getArgOperand(0), "typeid");
1113       CI->replaceAllUsesWith(NewCI);
1114       ToErase.push_back(CI);
1115     }
1116   }
1117 
1118   // Look for orphan landingpads, can occur in blocks with no predecessors
1119   for (BasicBlock &BB : F) {
1120     Instruction *I = BB.getFirstNonPHI();
1121     if (auto *LPI = dyn_cast<LandingPadInst>(I))
1122       LandingPads.insert(LPI);
1123   }
1124   Changed |= !LandingPads.empty();
1125 
1126   // Handle all the landingpad for this function together, as multiple invokes
1127   // may share a single lp
1128   for (LandingPadInst *LPI : LandingPads) {
1129     IRB.SetInsertPoint(LPI);
1130     SmallVector<Value *, 16> FMCArgs;
1131     for (unsigned I = 0, E = LPI->getNumClauses(); I < E; ++I) {
1132       Constant *Clause = LPI->getClause(I);
1133       // TODO Handle filters (= exception specifications).
1134       // https://bugs.llvm.org/show_bug.cgi?id=50396
1135       if (LPI->isCatch(I))
1136         FMCArgs.push_back(Clause);
1137     }
1138 
1139     // Create a call to __cxa_find_matching_catch_N function
1140     Function *FMCF = getFindMatchingCatch(M, FMCArgs.size());
1141     CallInst *FMCI = IRB.CreateCall(FMCF, FMCArgs, "fmc");
1142     Value *Undef = UndefValue::get(LPI->getType());
1143     Value *Pair0 = IRB.CreateInsertValue(Undef, FMCI, 0, "pair0");
1144     Value *TempRet0 = IRB.CreateCall(GetTempRet0F, None, "tempret0");
1145     Value *Pair1 = IRB.CreateInsertValue(Pair0, TempRet0, 1, "pair1");
1146 
1147     LPI->replaceAllUsesWith(Pair1);
1148     ToErase.push_back(LPI);
1149   }
1150 
1151   // Erase everything we no longer need in this function
1152   for (Instruction *I : ToErase)
1153     I->eraseFromParent();
1154 
1155   return Changed;
1156 }
1157 
1158 // This tries to get debug info from the instruction before which a new
1159 // instruction will be inserted, and if there's no debug info in that
1160 // instruction, tries to get the info instead from the previous instruction (if
1161 // any). If none of these has debug info and a DISubprogram is provided, it
1162 // creates a dummy debug info with the first line of the function, because IR
1163 // verifier requires all inlinable callsites should have debug info when both a
1164 // caller and callee have DISubprogram. If none of these conditions are met,
1165 // returns empty info.
1166 static DebugLoc getOrCreateDebugLoc(const Instruction *InsertBefore,
1167                                     DISubprogram *SP) {
1168   assert(InsertBefore);
1169   if (InsertBefore->getDebugLoc())
1170     return InsertBefore->getDebugLoc();
1171   const Instruction *Prev = InsertBefore->getPrevNode();
1172   if (Prev && Prev->getDebugLoc())
1173     return Prev->getDebugLoc();
1174   if (SP)
1175     return DILocation::get(SP->getContext(), SP->getLine(), 1, SP);
1176   return DebugLoc();
1177 }
1178 
1179 bool WebAssemblyLowerEmscriptenEHSjLj::runSjLjOnFunction(Function &F) {
1180   assert(EnableEmSjLj || EnableWasmSjLj);
1181   Module &M = *F.getParent();
1182   LLVMContext &C = F.getContext();
1183   IRBuilder<> IRB(C);
1184   SmallVector<Instruction *, 64> ToErase;
1185   // Vector of %setjmpTable values
1186   SmallVector<Instruction *, 4> SetjmpTableInsts;
1187   // Vector of %setjmpTableSize values
1188   SmallVector<Instruction *, 4> SetjmpTableSizeInsts;
1189 
1190   // Setjmp preparation
1191 
1192   // This instruction effectively means %setjmpTableSize = 4.
1193   // We create this as an instruction intentionally, and we don't want to fold
1194   // this instruction to a constant 4, because this value will be used in
1195   // SSAUpdater.AddAvailableValue(...) later.
1196   BasicBlock *Entry = &F.getEntryBlock();
1197   DebugLoc FirstDL = getOrCreateDebugLoc(&*Entry->begin(), F.getSubprogram());
1198   SplitBlock(Entry, &*Entry->getFirstInsertionPt());
1199 
1200   BinaryOperator *SetjmpTableSize =
1201       BinaryOperator::Create(Instruction::Add, IRB.getInt32(4), IRB.getInt32(0),
1202                              "setjmpTableSize", Entry->getTerminator());
1203   SetjmpTableSize->setDebugLoc(FirstDL);
1204   // setjmpTable = (int *) malloc(40);
1205   Instruction *SetjmpTable = CallInst::CreateMalloc(
1206       SetjmpTableSize, IRB.getInt32Ty(), IRB.getInt32Ty(), IRB.getInt32(40),
1207       nullptr, nullptr, "setjmpTable");
1208   SetjmpTable->setDebugLoc(FirstDL);
1209   // CallInst::CreateMalloc may return a bitcast instruction if the result types
1210   // mismatch. We need to set the debug loc for the original call too.
1211   auto *MallocCall = SetjmpTable->stripPointerCasts();
1212   if (auto *MallocCallI = dyn_cast<Instruction>(MallocCall)) {
1213     MallocCallI->setDebugLoc(FirstDL);
1214   }
1215   // setjmpTable[0] = 0;
1216   IRB.SetInsertPoint(SetjmpTableSize);
1217   IRB.CreateStore(IRB.getInt32(0), SetjmpTable);
1218   SetjmpTableInsts.push_back(SetjmpTable);
1219   SetjmpTableSizeInsts.push_back(SetjmpTableSize);
1220 
1221   // Setjmp transformation
1222   SmallVector<PHINode *, 4> SetjmpRetPHIs;
1223   Function *SetjmpF = M.getFunction("setjmp");
1224   for (User *U : SetjmpF->users()) {
1225     auto *CI = dyn_cast<CallInst>(U);
1226     // FIXME 'invoke' to setjmp can happen when we use Wasm EH + Wasm SjLj, but
1227     // we don't support two being used together yet.
1228     if (!CI)
1229       report_fatal_error("Wasm EH + Wasm SjLj is not fully supported yet");
1230     BasicBlock *BB = CI->getParent();
1231     if (BB->getParent() != &F) // in other function
1232       continue;
1233 
1234     // The tail is everything right after the call, and will be reached once
1235     // when setjmp is called, and later when longjmp returns to the setjmp
1236     BasicBlock *Tail = SplitBlock(BB, CI->getNextNode());
1237     // Add a phi to the tail, which will be the output of setjmp, which
1238     // indicates if this is the first call or a longjmp back. The phi directly
1239     // uses the right value based on where we arrive from
1240     IRB.SetInsertPoint(Tail->getFirstNonPHI());
1241     PHINode *SetjmpRet = IRB.CreatePHI(IRB.getInt32Ty(), 2, "setjmp.ret");
1242 
1243     // setjmp initial call returns 0
1244     SetjmpRet->addIncoming(IRB.getInt32(0), BB);
1245     // The proper output is now this, not the setjmp call itself
1246     CI->replaceAllUsesWith(SetjmpRet);
1247     // longjmp returns to the setjmp will add themselves to this phi
1248     SetjmpRetPHIs.push_back(SetjmpRet);
1249 
1250     // Fix call target
1251     // Our index in the function is our place in the array + 1 to avoid index
1252     // 0, because index 0 means the longjmp is not ours to handle.
1253     IRB.SetInsertPoint(CI);
1254     Value *Args[] = {CI->getArgOperand(0), IRB.getInt32(SetjmpRetPHIs.size()),
1255                      SetjmpTable, SetjmpTableSize};
1256     Instruction *NewSetjmpTable =
1257         IRB.CreateCall(SaveSetjmpF, Args, "setjmpTable");
1258     Instruction *NewSetjmpTableSize =
1259         IRB.CreateCall(GetTempRet0F, None, "setjmpTableSize");
1260     SetjmpTableInsts.push_back(NewSetjmpTable);
1261     SetjmpTableSizeInsts.push_back(NewSetjmpTableSize);
1262     ToErase.push_back(CI);
1263   }
1264 
1265   // Handle longjmpable calls.
1266   if (EnableEmSjLj)
1267     handleLongjmpableCallsForEmscriptenSjLj(
1268         F, SetjmpTableInsts, SetjmpTableSizeInsts, SetjmpRetPHIs);
1269   else // EnableWasmSjLj
1270     handleLongjmpableCallsForWasmSjLj(F, SetjmpTableInsts, SetjmpTableSizeInsts,
1271                                       SetjmpRetPHIs);
1272 
1273   // Erase everything we no longer need in this function
1274   for (Instruction *I : ToErase)
1275     I->eraseFromParent();
1276 
1277   // Free setjmpTable buffer before each return instruction + function-exiting
1278   // call
1279   SmallVector<Instruction *, 16> ExitingInsts;
1280   for (BasicBlock &BB : F) {
1281     Instruction *TI = BB.getTerminator();
1282     if (isa<ReturnInst>(TI))
1283       ExitingInsts.push_back(TI);
1284     // Any 'call' instruction with 'noreturn' attribute exits the function at
1285     // this point. If this throws but unwinds to another EH pad within this
1286     // function instead of exiting, this would have been an 'invoke', which
1287     // happens if we use Wasm EH or Wasm SjLJ.
1288     for (auto &I : BB) {
1289       if (auto *CI = dyn_cast<CallInst>(&I)) {
1290         bool IsNoReturn = CI->hasFnAttr(Attribute::NoReturn);
1291         if (Function *CalleeF = CI->getCalledFunction())
1292           IsNoReturn |= CalleeF->hasFnAttribute(Attribute::NoReturn);
1293         if (IsNoReturn)
1294           ExitingInsts.push_back(&I);
1295       }
1296     }
1297   }
1298   for (auto *I : ExitingInsts) {
1299     DebugLoc DL = getOrCreateDebugLoc(I, F.getSubprogram());
1300     // If this existing instruction is a call within a catchpad, we should add
1301     // it as "funclet" to the operand bundle of 'free' call
1302     SmallVector<OperandBundleDef, 1> Bundles;
1303     if (auto *CB = dyn_cast<CallBase>(I))
1304       if (auto Bundle = CB->getOperandBundle(LLVMContext::OB_funclet))
1305         Bundles.push_back(OperandBundleDef(*Bundle));
1306     auto *Free = CallInst::CreateFree(SetjmpTable, Bundles, I);
1307     Free->setDebugLoc(DL);
1308     // CallInst::CreateFree may create a bitcast instruction if its argument
1309     // types mismatch. We need to set the debug loc for the bitcast too.
1310     if (auto *FreeCallI = dyn_cast<CallInst>(Free)) {
1311       if (auto *BitCastI = dyn_cast<BitCastInst>(FreeCallI->getArgOperand(0)))
1312         BitCastI->setDebugLoc(DL);
1313     }
1314   }
1315 
1316   // Every call to saveSetjmp can change setjmpTable and setjmpTableSize
1317   // (when buffer reallocation occurs)
1318   // entry:
1319   //   setjmpTableSize = 4;
1320   //   setjmpTable = (int *) malloc(40);
1321   //   setjmpTable[0] = 0;
1322   // ...
1323   // somebb:
1324   //   setjmpTable = saveSetjmp(env, label, setjmpTable, setjmpTableSize);
1325   //   setjmpTableSize = getTempRet0();
1326   // So we need to make sure the SSA for these variables is valid so that every
1327   // saveSetjmp and testSetjmp calls have the correct arguments.
1328   SSAUpdater SetjmpTableSSA;
1329   SSAUpdater SetjmpTableSizeSSA;
1330   SetjmpTableSSA.Initialize(Type::getInt32PtrTy(C), "setjmpTable");
1331   SetjmpTableSizeSSA.Initialize(Type::getInt32Ty(C), "setjmpTableSize");
1332   for (Instruction *I : SetjmpTableInsts)
1333     SetjmpTableSSA.AddAvailableValue(I->getParent(), I);
1334   for (Instruction *I : SetjmpTableSizeInsts)
1335     SetjmpTableSizeSSA.AddAvailableValue(I->getParent(), I);
1336 
1337   for (auto &U : make_early_inc_range(SetjmpTable->uses()))
1338     if (auto *I = dyn_cast<Instruction>(U.getUser()))
1339       if (I->getParent() != Entry)
1340         SetjmpTableSSA.RewriteUse(U);
1341   for (auto &U : make_early_inc_range(SetjmpTableSize->uses()))
1342     if (auto *I = dyn_cast<Instruction>(U.getUser()))
1343       if (I->getParent() != Entry)
1344         SetjmpTableSizeSSA.RewriteUse(U);
1345 
1346   // Finally, our modifications to the cfg can break dominance of SSA variables.
1347   // For example, in this code,
1348   // if (x()) { .. setjmp() .. }
1349   // if (y()) { .. longjmp() .. }
1350   // We must split the longjmp block, and it can jump into the block splitted
1351   // from setjmp one. But that means that when we split the setjmp block, it's
1352   // first part no longer dominates its second part - there is a theoretically
1353   // possible control flow path where x() is false, then y() is true and we
1354   // reach the second part of the setjmp block, without ever reaching the first
1355   // part. So, we rebuild SSA form here.
1356   rebuildSSA(F);
1357   return true;
1358 }
1359 
1360 // Update each call that can longjmp so it can return to the corresponding
1361 // setjmp. Refer to 4) of "Emscripten setjmp/longjmp handling" section in the
1362 // comments at top of the file for details.
1363 void WebAssemblyLowerEmscriptenEHSjLj::handleLongjmpableCallsForEmscriptenSjLj(
1364     Function &F, InstVector &SetjmpTableInsts, InstVector &SetjmpTableSizeInsts,
1365     SmallVectorImpl<PHINode *> &SetjmpRetPHIs) {
1366   Module &M = *F.getParent();
1367   LLVMContext &C = F.getContext();
1368   IRBuilder<> IRB(C);
1369   SmallVector<Instruction *, 64> ToErase;
1370 
1371   // We need to pass setjmpTable and setjmpTableSize to testSetjmp function.
1372   // These values are defined in the beginning of the function and also in each
1373   // setjmp callsite, but we don't know which values we should use at this
1374   // point. So here we arbitraily use the ones defined in the beginning of the
1375   // function, and SSAUpdater will later update them to the correct values.
1376   Instruction *SetjmpTable = *SetjmpTableInsts.begin();
1377   Instruction *SetjmpTableSize = *SetjmpTableSizeInsts.begin();
1378 
1379   // call.em.longjmp BB that will be shared within the function.
1380   BasicBlock *CallEmLongjmpBB = nullptr;
1381   // PHI node for the loaded value of __THREW__ global variable in
1382   // call.em.longjmp BB
1383   PHINode *CallEmLongjmpBBThrewPHI = nullptr;
1384   // PHI node for the loaded value of __threwValue global variable in
1385   // call.em.longjmp BB
1386   PHINode *CallEmLongjmpBBThrewValuePHI = nullptr;
1387   // rethrow.exn BB that will be shared within the function.
1388   BasicBlock *RethrowExnBB = nullptr;
1389 
1390   // Because we are creating new BBs while processing and don't want to make
1391   // all these newly created BBs candidates again for longjmp processing, we
1392   // first make the vector of candidate BBs.
1393   std::vector<BasicBlock *> BBs;
1394   for (BasicBlock &BB : F)
1395     BBs.push_back(&BB);
1396 
1397   // BBs.size() will change within the loop, so we query it every time
1398   for (unsigned I = 0; I < BBs.size(); I++) {
1399     BasicBlock *BB = BBs[I];
1400     for (Instruction &I : *BB) {
1401       if (isa<InvokeInst>(&I))
1402         report_fatal_error("When using Wasm EH with Emscripten SjLj, there is "
1403                            "a restriction that `setjmp` function call and "
1404                            "exception cannot be used within the same function");
1405       auto *CI = dyn_cast<CallInst>(&I);
1406       if (!CI)
1407         continue;
1408 
1409       const Value *Callee = CI->getCalledOperand();
1410       if (!canLongjmp(Callee))
1411         continue;
1412       if (isEmAsmCall(Callee))
1413         report_fatal_error("Cannot use EM_ASM* alongside setjmp/longjmp in " +
1414                                F.getName() +
1415                                ". Please consider using EM_JS, or move the "
1416                                "EM_ASM into another function.",
1417                            false);
1418 
1419       Value *Threw = nullptr;
1420       BasicBlock *Tail;
1421       if (Callee->getName().startswith("__invoke_")) {
1422         // If invoke wrapper has already been generated for this call in
1423         // previous EH phase, search for the load instruction
1424         // %__THREW__.val = __THREW__;
1425         // in postamble after the invoke wrapper call
1426         LoadInst *ThrewLI = nullptr;
1427         StoreInst *ThrewResetSI = nullptr;
1428         for (auto I = std::next(BasicBlock::iterator(CI)), IE = BB->end();
1429              I != IE; ++I) {
1430           if (auto *LI = dyn_cast<LoadInst>(I))
1431             if (auto *GV = dyn_cast<GlobalVariable>(LI->getPointerOperand()))
1432               if (GV == ThrewGV) {
1433                 Threw = ThrewLI = LI;
1434                 break;
1435               }
1436         }
1437         // Search for the store instruction after the load above
1438         // __THREW__ = 0;
1439         for (auto I = std::next(BasicBlock::iterator(ThrewLI)), IE = BB->end();
1440              I != IE; ++I) {
1441           if (auto *SI = dyn_cast<StoreInst>(I)) {
1442             if (auto *GV = dyn_cast<GlobalVariable>(SI->getPointerOperand())) {
1443               if (GV == ThrewGV &&
1444                   SI->getValueOperand() == getAddrSizeInt(&M, 0)) {
1445                 ThrewResetSI = SI;
1446                 break;
1447               }
1448             }
1449           }
1450         }
1451         assert(Threw && ThrewLI && "Cannot find __THREW__ load after invoke");
1452         assert(ThrewResetSI && "Cannot find __THREW__ store after invoke");
1453         Tail = SplitBlock(BB, ThrewResetSI->getNextNode());
1454 
1455       } else {
1456         // Wrap call with invoke wrapper and generate preamble/postamble
1457         Threw = wrapInvoke(CI);
1458         ToErase.push_back(CI);
1459         Tail = SplitBlock(BB, CI->getNextNode());
1460 
1461         // If exception handling is enabled, the thrown value can be not a
1462         // longjmp but an exception, in which case we shouldn't silently ignore
1463         // exceptions; we should rethrow them.
1464         // __THREW__'s value is 0 when nothing happened, 1 when an exception is
1465         // thrown, other values when longjmp is thrown.
1466         //
1467         // if (%__THREW__.val == 1)
1468         //   goto %eh.rethrow
1469         // else
1470         //   goto %normal
1471         //
1472         // eh.rethrow: ;; Rethrow exception
1473         //   %exn = call @__cxa_find_matching_catch_2() ;; Retrieve thrown ptr
1474         //   __resumeException(%exn)
1475         //
1476         // normal:
1477         //   <-- Insertion point. Will insert sjlj handling code from here
1478         //   goto %tail
1479         //
1480         // tail:
1481         //   ...
1482         if (supportsException(&F) && canThrow(Callee)) {
1483           // We will add a new conditional branch. So remove the branch created
1484           // when we split the BB
1485           ToErase.push_back(BB->getTerminator());
1486 
1487           // Generate rethrow.exn BB once and share it within the function
1488           if (!RethrowExnBB) {
1489             RethrowExnBB = BasicBlock::Create(C, "rethrow.exn", &F);
1490             IRB.SetInsertPoint(RethrowExnBB);
1491             CallInst *Exn =
1492                 IRB.CreateCall(getFindMatchingCatch(M, 0), {}, "exn");
1493             IRB.CreateCall(ResumeF, {Exn});
1494             IRB.CreateUnreachable();
1495           }
1496 
1497           IRB.SetInsertPoint(CI);
1498           BasicBlock *NormalBB = BasicBlock::Create(C, "normal", &F);
1499           Value *CmpEqOne =
1500               IRB.CreateICmpEQ(Threw, getAddrSizeInt(&M, 1), "cmp.eq.one");
1501           IRB.CreateCondBr(CmpEqOne, RethrowExnBB, NormalBB);
1502 
1503           IRB.SetInsertPoint(NormalBB);
1504           IRB.CreateBr(Tail);
1505           BB = NormalBB; // New insertion point to insert testSetjmp()
1506         }
1507       }
1508 
1509       // We need to replace the terminator in Tail - SplitBlock makes BB go
1510       // straight to Tail, we need to check if a longjmp occurred, and go to the
1511       // right setjmp-tail if so
1512       ToErase.push_back(BB->getTerminator());
1513 
1514       // Generate a function call to testSetjmp function and preamble/postamble
1515       // code to figure out (1) whether longjmp occurred (2) if longjmp
1516       // occurred, which setjmp it corresponds to
1517       Value *Label = nullptr;
1518       Value *LongjmpResult = nullptr;
1519       BasicBlock *EndBB = nullptr;
1520       wrapTestSetjmp(BB, CI->getDebugLoc(), Threw, SetjmpTable, SetjmpTableSize,
1521                      Label, LongjmpResult, CallEmLongjmpBB,
1522                      CallEmLongjmpBBThrewPHI, CallEmLongjmpBBThrewValuePHI,
1523                      EndBB);
1524       assert(Label && LongjmpResult && EndBB);
1525 
1526       // Create switch instruction
1527       IRB.SetInsertPoint(EndBB);
1528       IRB.SetCurrentDebugLocation(EndBB->getInstList().back().getDebugLoc());
1529       SwitchInst *SI = IRB.CreateSwitch(Label, Tail, SetjmpRetPHIs.size());
1530       // -1 means no longjmp happened, continue normally (will hit the default
1531       // switch case). 0 means a longjmp that is not ours to handle, needs a
1532       // rethrow. Otherwise the index is the same as the index in P+1 (to avoid
1533       // 0).
1534       for (unsigned I = 0; I < SetjmpRetPHIs.size(); I++) {
1535         SI->addCase(IRB.getInt32(I + 1), SetjmpRetPHIs[I]->getParent());
1536         SetjmpRetPHIs[I]->addIncoming(LongjmpResult, EndBB);
1537       }
1538 
1539       // We are splitting the block here, and must continue to find other calls
1540       // in the block - which is now split. so continue to traverse in the Tail
1541       BBs.push_back(Tail);
1542     }
1543   }
1544 
1545   for (Instruction *I : ToErase)
1546     I->eraseFromParent();
1547 }
1548 
1549 // Create a catchpad in which we catch a longjmp's env and val arguments, test
1550 // if the longjmp corresponds to one of setjmps in the current function, and if
1551 // so, jump to the setjmp dispatch BB from which we go to one of post-setjmp
1552 // BBs. Refer to 4) of "Wasm setjmp/longjmp handling" section in the comments at
1553 // top of the file for details.
1554 void WebAssemblyLowerEmscriptenEHSjLj::handleLongjmpableCallsForWasmSjLj(
1555     Function &F, InstVector &SetjmpTableInsts, InstVector &SetjmpTableSizeInsts,
1556     SmallVectorImpl<PHINode *> &SetjmpRetPHIs) {
1557   Module &M = *F.getParent();
1558   LLVMContext &C = F.getContext();
1559   IRBuilder<> IRB(C);
1560 
1561   // A function with catchswitch/catchpad instruction should have a personality
1562   // function attached to it. Search for the wasm personality function, and if
1563   // it exists, use it, and if it doesn't, create a dummy personality function.
1564   // (SjLj is not going to call it anyway.)
1565   if (!F.hasPersonalityFn()) {
1566     StringRef PersName = getEHPersonalityName(EHPersonality::Wasm_CXX);
1567     FunctionType *PersType =
1568         FunctionType::get(IRB.getInt32Ty(), /* isVarArg */ true);
1569     Value *PersF = M.getOrInsertFunction(PersName, PersType).getCallee();
1570     F.setPersonalityFn(
1571         cast<Constant>(IRB.CreateBitCast(PersF, IRB.getInt8PtrTy())));
1572   }
1573 
1574   // Use the entry BB's debugloc as a fallback
1575   BasicBlock *Entry = &F.getEntryBlock();
1576   DebugLoc FirstDL = getOrCreateDebugLoc(&*Entry->begin(), F.getSubprogram());
1577   IRB.SetCurrentDebugLocation(FirstDL);
1578 
1579   // Arbitrarily use the ones defined in the beginning of the function.
1580   // SSAUpdater will later update them to the correct values.
1581   Instruction *SetjmpTable = *SetjmpTableInsts.begin();
1582   Instruction *SetjmpTableSize = *SetjmpTableSizeInsts.begin();
1583 
1584   // Add setjmp.dispatch BB right after the entry block. Because we have
1585   // initialized setjmpTable/setjmpTableSize in the entry block and split the
1586   // rest into another BB, here 'OrigEntry' is the function's original entry
1587   // block before the transformation.
1588   //
1589   // entry:
1590   //   setjmpTable / setjmpTableSize initialization
1591   // setjmp.dispatch:
1592   //   switch will be inserted here later
1593   // entry.split: (OrigEntry)
1594   //   the original function starts here
1595   BasicBlock *OrigEntry = Entry->getNextNode();
1596   BasicBlock *SetjmpDispatchBB =
1597       BasicBlock::Create(C, "setjmp.dispatch", &F, OrigEntry);
1598   cast<BranchInst>(Entry->getTerminator())->setSuccessor(0, SetjmpDispatchBB);
1599 
1600   // Create catch.dispatch.longjmp BB a catchswitch instruction
1601   BasicBlock *CatchSwitchBB =
1602       BasicBlock::Create(C, "catch.dispatch.longjmp", &F);
1603   IRB.SetInsertPoint(CatchSwitchBB);
1604   CatchSwitchInst *CatchSwitch =
1605       IRB.CreateCatchSwitch(ConstantTokenNone::get(C), nullptr, 1);
1606 
1607   // Create catch.longjmp BB and a catchpad instruction
1608   BasicBlock *CatchLongjmpBB = BasicBlock::Create(C, "catch.longjmp", &F);
1609   CatchSwitch->addHandler(CatchLongjmpBB);
1610   IRB.SetInsertPoint(CatchLongjmpBB);
1611   CatchPadInst *CatchPad = IRB.CreateCatchPad(CatchSwitch, {});
1612 
1613   // Wasm throw and catch instructions can throw and catch multiple values, but
1614   // that requires multivalue support in the toolchain, which is currently not
1615   // very reliable. We instead throw and catch a pointer to a struct value of
1616   // type 'struct __WasmLongjmpArgs', which is defined in Emscripten.
1617   Instruction *CatchCI =
1618       IRB.CreateCall(CatchF, {IRB.getInt32(WebAssembly::C_LONGJMP)}, "thrown");
1619   Value *LongjmpArgs =
1620       IRB.CreateBitCast(CatchCI, LongjmpArgsTy->getPointerTo(), "longjmp.args");
1621   Value *EnvField =
1622       IRB.CreateConstGEP2_32(LongjmpArgsTy, LongjmpArgs, 0, 0, "env_gep");
1623   Value *ValField =
1624       IRB.CreateConstGEP2_32(LongjmpArgsTy, LongjmpArgs, 0, 1, "val_gep");
1625   // void *env = __wasm_longjmp_args.env;
1626   Instruction *Env = IRB.CreateLoad(IRB.getInt8PtrTy(), EnvField, "env");
1627   // int val = __wasm_longjmp_args.val;
1628   Instruction *Val = IRB.CreateLoad(IRB.getInt32Ty(), ValField, "val");
1629 
1630   // %label = testSetjmp(mem[%env], setjmpTable, setjmpTableSize);
1631   // if (%label == 0)
1632   //   __wasm_longjmp(%env, %val)
1633   // catchret to %setjmp.dispatch
1634   BasicBlock *ThenBB = BasicBlock::Create(C, "if.then", &F);
1635   BasicBlock *EndBB = BasicBlock::Create(C, "if.end", &F);
1636   Value *EnvP = IRB.CreateBitCast(Env, getAddrPtrType(&M), "env.p");
1637   Value *SetjmpID = IRB.CreateLoad(getAddrIntType(&M), EnvP, "setjmp.id");
1638   Value *Label =
1639       IRB.CreateCall(TestSetjmpF, {SetjmpID, SetjmpTable, SetjmpTableSize},
1640                      OperandBundleDef("funclet", CatchPad), "label");
1641   Value *Cmp = IRB.CreateICmpEQ(Label, IRB.getInt32(0));
1642   IRB.CreateCondBr(Cmp, ThenBB, EndBB);
1643 
1644   IRB.SetInsertPoint(ThenBB);
1645   CallInst *WasmLongjmpCI = IRB.CreateCall(
1646       WasmLongjmpF, {Env, Val}, OperandBundleDef("funclet", CatchPad));
1647   IRB.CreateUnreachable();
1648 
1649   IRB.SetInsertPoint(EndBB);
1650   // Jump to setjmp.dispatch block
1651   IRB.CreateCatchRet(CatchPad, SetjmpDispatchBB);
1652 
1653   // Go back to setjmp.dispatch BB
1654   // setjmp.dispatch:
1655   //   switch %label {
1656   //     label 1: goto post-setjmp BB 1
1657   //     label 2: goto post-setjmp BB 2
1658   //     ...
1659   //     default: goto splitted next BB
1660   //   }
1661   IRB.SetInsertPoint(SetjmpDispatchBB);
1662   PHINode *LabelPHI = IRB.CreatePHI(IRB.getInt32Ty(), 2, "label.phi");
1663   LabelPHI->addIncoming(Label, EndBB);
1664   LabelPHI->addIncoming(IRB.getInt32(-1), Entry);
1665   SwitchInst *SI = IRB.CreateSwitch(LabelPHI, OrigEntry, SetjmpRetPHIs.size());
1666   // -1 means no longjmp happened, continue normally (will hit the default
1667   // switch case). 0 means a longjmp that is not ours to handle, needs a
1668   // rethrow. Otherwise the index is the same as the index in P+1 (to avoid
1669   // 0).
1670   for (unsigned I = 0; I < SetjmpRetPHIs.size(); I++) {
1671     SI->addCase(IRB.getInt32(I + 1), SetjmpRetPHIs[I]->getParent());
1672     SetjmpRetPHIs[I]->addIncoming(Val, SetjmpDispatchBB);
1673   }
1674 
1675   // Convert all longjmpable call instructions to invokes that unwind to the
1676   // newly created catch.dispatch.longjmp BB.
1677   SmallVector<Instruction *, 64> ToErase;
1678   for (auto *BB = &*F.begin(); BB; BB = BB->getNextNode()) {
1679     for (Instruction &I : *BB) {
1680       auto *CI = dyn_cast<CallInst>(&I);
1681       if (!CI)
1682         continue;
1683       const Value *Callee = CI->getCalledOperand();
1684       if (!canLongjmp(Callee))
1685         continue;
1686       if (isEmAsmCall(Callee))
1687         report_fatal_error("Cannot use EM_ASM* alongside setjmp/longjmp in " +
1688                                F.getName() +
1689                                ". Please consider using EM_JS, or move the "
1690                                "EM_ASM into another function.",
1691                            false);
1692       // This is __wasm_longjmp() call we inserted in this function, which
1693       // rethrows the longjmp when the longjmp does not correspond to one of
1694       // setjmps in this function. We should not convert this call to an invoke.
1695       if (CI == WasmLongjmpCI)
1696         continue;
1697       ToErase.push_back(CI);
1698 
1699       // Even if the callee function has attribute 'nounwind', which is true for
1700       // all C functions, it can longjmp, which means it can throw a Wasm
1701       // exception now.
1702       CI->removeFnAttr(Attribute::NoUnwind);
1703       if (Function *CalleeF = CI->getCalledFunction()) {
1704         CalleeF->removeFnAttr(Attribute::NoUnwind);
1705       }
1706 
1707       IRB.SetInsertPoint(CI);
1708       BasicBlock *Tail = SplitBlock(BB, CI->getNextNode());
1709       // We will add a new invoke. So remove the branch created when we split
1710       // the BB
1711       ToErase.push_back(BB->getTerminator());
1712       SmallVector<Value *, 8> Args(CI->args());
1713       InvokeInst *II =
1714           IRB.CreateInvoke(CI->getFunctionType(), CI->getCalledOperand(), Tail,
1715                            CatchSwitchBB, Args);
1716       II->takeName(CI);
1717       II->setDebugLoc(CI->getDebugLoc());
1718       II->setAttributes(CI->getAttributes());
1719       CI->replaceAllUsesWith(II);
1720     }
1721   }
1722 
1723   for (Instruction *I : ToErase)
1724     I->eraseFromParent();
1725 }
1726