JF Bastien | 600aee9 | 2015-07-31 17:53:38 +0000 | [diff] [blame] | 1 | //===- WebAssemblyInstrControl.td-WebAssembly control-flow ------*- tablegen -*- |
| 2 | // |
Chandler Carruth | 2946cd7 | 2019-01-19 08:50:56 +0000 | [diff] [blame] | 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 |
JF Bastien | 600aee9 | 2015-07-31 17:53:38 +0000 | [diff] [blame] | 6 | // |
| 7 | //===----------------------------------------------------------------------===// |
| 8 | /// |
| 9 | /// \file |
Adrian Prantl | 5f8f34e4 | 2018-05-01 15:54:18 +0000 | [diff] [blame] | 10 | /// WebAssembly control-flow code-gen constructs. |
JF Bastien | 600aee9 | 2015-07-31 17:53:38 +0000 | [diff] [blame] | 11 | /// |
| 12 | //===----------------------------------------------------------------------===// |
| 13 | |
Dan Gohman | 950a13c | 2015-09-16 16:51:30 +0000 | [diff] [blame] | 14 | let isBranch = 1, isTerminator = 1, hasCtrlDep = 1 in { |
Dan Gohman | f0b165a | 2015-12-05 03:03:35 +0000 | [diff] [blame] | 15 | // The condition operand is a boolean value which WebAssembly represents as i32. |
Wouter van Oortmerssen | 48dac31 | 2018-06-18 21:22:44 +0000 | [diff] [blame] | 16 | defm BR_IF : I<(outs), (ins bb_op:$dst, I32:$cond), |
| 17 | (outs), (ins bb_op:$dst), |
| 18 | [(brcond I32:$cond, bb:$dst)], |
| 19 | "br_if \t$dst, $cond", "br_if \t$dst", 0x0d>; |
Dan Gohman | f0b165a | 2015-12-05 03:03:35 +0000 | [diff] [blame] | 20 | let isCodeGenOnly = 1 in |
Wouter van Oortmerssen | 48dac31 | 2018-06-18 21:22:44 +0000 | [diff] [blame] | 21 | defm BR_UNLESS : I<(outs), (ins bb_op:$dst, I32:$cond), |
| 22 | (outs), (ins bb_op:$dst), []>; |
Heejin Ahn | 4367587 | 2019-02-06 00:17:03 +0000 | [diff] [blame] | 23 | let isBarrier = 1 in |
Wouter van Oortmerssen | 48dac31 | 2018-06-18 21:22:44 +0000 | [diff] [blame] | 24 | defm BR : NRI<(outs), (ins bb_op:$dst), |
| 25 | [(br bb:$dst)], |
| 26 | "br \t$dst", 0x0c>; |
Dan Gohman | 950a13c | 2015-09-16 16:51:30 +0000 | [diff] [blame] | 27 | } // isBranch = 1, isTerminator = 1, hasCtrlDep = 1 |
| 28 | |
Dan Gohman | f0b165a | 2015-12-05 03:03:35 +0000 | [diff] [blame] | 29 | def : Pat<(brcond (i32 (setne I32:$cond, 0)), bb:$dst), |
Dan Gohman | 06b4958 | 2016-02-08 21:50:13 +0000 | [diff] [blame] | 30 | (BR_IF bb_op:$dst, I32:$cond)>; |
Dan Gohman | f0b165a | 2015-12-05 03:03:35 +0000 | [diff] [blame] | 31 | def : Pat<(brcond (i32 (seteq I32:$cond, 0)), bb:$dst), |
Dan Gohman | 06b4958 | 2016-02-08 21:50:13 +0000 | [diff] [blame] | 32 | (BR_UNLESS bb_op:$dst, I32:$cond)>; |
Sam Parker | 92e7771 | 2021-03-31 09:25:18 +0100 | [diff] [blame] | 33 | def : Pat<(brcond (i32 (xor bool_node:$cond, (i32 1))), bb:$dst), |
| 34 | (BR_UNLESS bb_op:$dst, I32:$cond)>; |
Dan Gohman | f0b165a | 2015-12-05 03:03:35 +0000 | [diff] [blame] | 35 | |
Wouter van Oortmerssen | d3c544a | 2018-12-17 22:04:44 +0000 | [diff] [blame] | 36 | // A list of branch targets enclosed in {} and separated by comma. |
| 37 | // Used by br_table only. |
| 38 | def BrListAsmOperand : AsmOperandClass { let Name = "BrList"; } |
Heejin Ahn | 4367587 | 2019-02-06 00:17:03 +0000 | [diff] [blame] | 39 | let OperandNamespace = "WebAssembly", OperandType = "OPERAND_BRLIST" in |
Wouter van Oortmerssen | d3c544a | 2018-12-17 22:04:44 +0000 | [diff] [blame] | 40 | def brlist : Operand<i32> { |
| 41 | let ParserMatchClass = BrListAsmOperand; |
| 42 | let PrintMethod = "printBrList"; |
| 43 | } |
Wouter van Oortmerssen | d3c544a | 2018-12-17 22:04:44 +0000 | [diff] [blame] | 44 | |
Thomas Lively | c5d0123 | 2020-06-11 15:11:45 -0700 | [diff] [blame] | 45 | // Duplicating a BR_TABLE is almost never a good idea. In particular, it can |
| 46 | // lead to some nasty irreducibility due to tail merging when the br_table is in |
| 47 | // a loop. |
| 48 | let isTerminator = 1, hasCtrlDep = 1, isBarrier = 1, isNotDuplicable = 1 in { |
| 49 | |
Heejin Ahn | 8e2bac8 | 2019-01-08 01:15:15 +0000 | [diff] [blame] | 50 | defm BR_TABLE_I32 : I<(outs), (ins I32:$index, variable_ops), |
| 51 | (outs), (ins brlist:$brl), |
| 52 | [(WebAssemblybr_table I32:$index)], |
| 53 | "br_table \t$index", "br_table \t$brl", |
| 54 | 0x0e>; |
Thomas Lively | c5d0123 | 2020-06-11 15:11:45 -0700 | [diff] [blame] | 55 | // TODO: SelectionDAG's lowering insists on using a pointer as the index for |
| 56 | // jump tables, so in practice we don't ever use BR_TABLE_I64 in wasm32 mode |
| 57 | // currently. |
Heejin Ahn | 8e2bac8 | 2019-01-08 01:15:15 +0000 | [diff] [blame] | 58 | defm BR_TABLE_I64 : I<(outs), (ins I64:$index, variable_ops), |
| 59 | (outs), (ins brlist:$brl), |
| 60 | [(WebAssemblybr_table I64:$index)], |
| 61 | "br_table \t$index", "br_table \t$brl", |
| 62 | 0x0e>; |
Thomas Lively | c5d0123 | 2020-06-11 15:11:45 -0700 | [diff] [blame] | 63 | } // isTerminator = 1, hasCtrlDep = 1, isBarrier = 1, isNotDuplicable = 1 |
Dan Gohman | 950a13c | 2015-09-16 16:51:30 +0000 | [diff] [blame] | 64 | |
Sam Clegg | 16c1682 | 2018-05-10 22:16:44 +0000 | [diff] [blame] | 65 | // This is technically a control-flow instruction, since all it affects is the |
| 66 | // IP. |
Wouter van Oortmerssen | 48dac31 | 2018-06-18 21:22:44 +0000 | [diff] [blame] | 67 | defm NOP : NRI<(outs), (ins), [], "nop", 0x01>; |
Sam Clegg | 16c1682 | 2018-05-10 22:16:44 +0000 | [diff] [blame] | 68 | |
Heejin Ahn | e4a8dee | 2018-03-02 01:03:40 +0000 | [diff] [blame] | 69 | // Placemarkers to indicate the start or end of a block or loop scope. |
Heejin Ahn | ac62b05 | 2017-06-30 00:43:15 +0000 | [diff] [blame] | 70 | // These use/clobber VALUE_STACK to prevent them from being moved into the |
| 71 | // middle of an expression tree. |
Dan Gohman | e040533 | 2016-10-03 22:43:53 +0000 | [diff] [blame] | 72 | let Uses = [VALUE_STACK], Defs = [VALUE_STACK] in { |
Wouter van Oortmerssen | f227621 | 2018-12-26 22:55:26 +0000 | [diff] [blame] | 73 | defm BLOCK : NRI<(outs), (ins Signature:$sig), [], "block \t$sig", 0x02>; |
| 74 | defm LOOP : NRI<(outs), (ins Signature:$sig), [], "loop \t$sig", 0x03>; |
Dan Gohman | 4becc58 | 2016-10-24 20:32:04 +0000 | [diff] [blame] | 75 | |
Wouter van Oortmerssen | f227621 | 2018-12-26 22:55:26 +0000 | [diff] [blame] | 76 | defm IF : I<(outs), (ins Signature:$sig, I32:$cond), |
| 77 | (outs), (ins Signature:$sig), |
| 78 | [], "if \t$sig, $cond", "if \t$sig", 0x04>; |
| 79 | defm ELSE : NRI<(outs), (ins), [], "else", 0x05>; |
| 80 | |
| 81 | // END_BLOCK, END_LOOP, END_IF and END_FUNCTION are represented with the same |
| 82 | // opcode in wasm. |
Wouter van Oortmerssen | 48dac31 | 2018-06-18 21:22:44 +0000 | [diff] [blame] | 83 | defm END_BLOCK : NRI<(outs), (ins), [], "end_block", 0x0b>; |
| 84 | defm END_LOOP : NRI<(outs), (ins), [], "end_loop", 0x0b>; |
Wouter van Oortmerssen | f227621 | 2018-12-26 22:55:26 +0000 | [diff] [blame] | 85 | defm END_IF : NRI<(outs), (ins), [], "end_if", 0x0b>; |
Wouter van Oortmerssen | 1a91cb0 | 2019-02-05 01:19:45 +0000 | [diff] [blame] | 86 | // Generic instruction, for disassembler. |
Heejin Ahn | 4367587 | 2019-02-06 00:17:03 +0000 | [diff] [blame] | 87 | let IsCanonical = 1 in |
Wouter van Oortmerssen | 1a91cb0 | 2019-02-05 01:19:45 +0000 | [diff] [blame] | 88 | defm END : NRI<(outs), (ins), [], "end", 0x0b>; |
Dan Gohman | d934cb8 | 2017-02-24 23:18:00 +0000 | [diff] [blame] | 89 | let isTerminator = 1, isBarrier = 1 in |
Wouter van Oortmerssen | 48dac31 | 2018-06-18 21:22:44 +0000 | [diff] [blame] | 90 | defm END_FUNCTION : NRI<(outs), (ins), [], "end_function", 0x0b>; |
Dan Gohman | e040533 | 2016-10-03 22:43:53 +0000 | [diff] [blame] | 91 | } // Uses = [VALUE_STACK], Defs = [VALUE_STACK] |
Dan Gohman | 950a13c | 2015-09-16 16:51:30 +0000 | [diff] [blame] | 92 | |
Derek Schuff | 39bf39f | 2016-08-02 23:16:09 +0000 | [diff] [blame] | 93 | |
Thomas Lively | a07c08f | 2020-06-04 13:25:10 -0700 | [diff] [blame] | 94 | let hasCtrlDep = 1, isBarrier = 1 in { |
| 95 | let isTerminator = 1 in { |
Derek Schuff | ffa143c | 2015-11-10 00:30:57 +0000 | [diff] [blame] | 96 | let isReturn = 1 in { |
Derek Schuff | 39bf39f | 2016-08-02 23:16:09 +0000 | [diff] [blame] | 97 | |
Thomas Lively | 00f9e5a | 2019-10-09 21:42:08 +0000 | [diff] [blame] | 98 | defm RETURN : I<(outs), (ins variable_ops), (outs), (ins), |
| 99 | [(WebAssemblyreturn)], |
| 100 | "return", "return", 0x0f>; |
| 101 | // Equivalent to RETURN, for use at the end of a function when wasm |
| 102 | // semantics return by falling off the end of the block. |
| 103 | let isCodeGenOnly = 1 in |
| 104 | defm FALLTHROUGH_RETURN : I<(outs), (ins variable_ops), (outs), (ins), []>; |
Dan Gohman | b7c2400 | 2016-05-21 00:21:56 +0000 | [diff] [blame] | 105 | |
Derek Schuff | ffa143c | 2015-11-10 00:30:57 +0000 | [diff] [blame] | 106 | } // isReturn = 1 |
Dan Gohman | 9850e87 | 2016-10-03 21:33:09 +0000 | [diff] [blame] | 107 | |
Dominic Chen | 4252f30 | 2020-09-10 01:02:13 -0400 | [diff] [blame] | 108 | let IsCanonical = 1, isTrap = 1 in |
Wouter van Oortmerssen | 48dac31 | 2018-06-18 21:22:44 +0000 | [diff] [blame] | 109 | defm UNREACHABLE : NRI<(outs), (ins), [(trap)], "unreachable", 0x00>; |
Thomas Lively | a07c08f | 2020-06-04 13:25:10 -0700 | [diff] [blame] | 110 | |
| 111 | } // isTerminator = 1 |
| 112 | |
| 113 | // debugtrap explicitly returns despite trapping because it is supposed to just |
| 114 | // get the attention of the debugger. Unfortunately, because UNREACHABLE is a |
| 115 | // terminator, lowering debugtrap to UNREACHABLE can create an invalid |
| 116 | // MachineBasicBlock when there is additional code after it. Lower it to this |
| 117 | // non-terminator version instead. |
| 118 | // TODO: Actually execute the debugger statement when running on the Web |
| 119 | let isTrap = 1 in |
| 120 | defm DEBUG_UNREACHABLE : NRI<(outs), (ins), [(debugtrap)], "unreachable", 0x00>; |
| 121 | |
| 122 | } // hasCtrlDep = 1, isBarrier = 1 |
Dan Gohman | 9850e87 | 2016-10-03 21:33:09 +0000 | [diff] [blame] | 123 | |
Heejin Ahn | e4a8dee | 2018-03-02 01:03:40 +0000 | [diff] [blame] | 124 | //===----------------------------------------------------------------------===// |
| 125 | // Exception handling instructions |
| 126 | //===----------------------------------------------------------------------===// |
| 127 | |
Heejin Ahn | 47068a4 | 2018-07-18 21:42:22 +0000 | [diff] [blame] | 128 | let Predicates = [HasExceptionHandling] in { |
| 129 | |
Heejin Ahn | e4a8dee | 2018-03-02 01:03:40 +0000 | [diff] [blame] | 130 | // Throwing an exception: throw / rethrow |
| 131 | let isTerminator = 1, hasCtrlDep = 1, isBarrier = 1 in { |
Heejin Ahn | 1d891d4 | 2021-06-15 01:49:43 -0700 | [diff] [blame^] | 132 | defm THROW : I<(outs), (ins tag_op:$tag, variable_ops), |
| 133 | (outs), (ins tag_op:$tag), |
Heejin Ahn | d6f4878 | 2019-01-30 03:21:57 +0000 | [diff] [blame] | 134 | [(WebAssemblythrow (WebAssemblywrapper texternalsym:$tag))], |
| 135 | "throw \t$tag", "throw \t$tag", 0x08>; |
Heejin Ahn | 9e4eade | 2020-12-26 02:27:44 -0800 | [diff] [blame] | 136 | defm RETHROW : NRI<(outs), (ins i32imm:$depth), [], "rethrow \t$depth", 0x09>; |
Derek Schuff | ffa143c | 2015-11-10 00:30:57 +0000 | [diff] [blame] | 137 | } // isTerminator = 1, hasCtrlDep = 1, isBarrier = 1 |
Heejin Ahn | 35f5f79 | 2021-02-11 11:05:41 -0800 | [diff] [blame] | 138 | // The depth argument will be computed in CFGStackify. We set it to 0 here for |
| 139 | // now. |
Heejin Ahn | 9e4eade | 2020-12-26 02:27:44 -0800 | [diff] [blame] | 140 | def : Pat<(int_wasm_rethrow), (RETHROW 0)>; |
Dan Gohman | fb3e059 | 2015-11-25 19:36:19 +0000 | [diff] [blame] | 141 | |
Heejin Ahn | e4a8dee | 2018-03-02 01:03:40 +0000 | [diff] [blame] | 142 | // Region within which an exception is caught: try / end_try |
| 143 | let Uses = [VALUE_STACK], Defs = [VALUE_STACK] in { |
Wouter van Oortmerssen | 48dac31 | 2018-06-18 21:22:44 +0000 | [diff] [blame] | 144 | defm TRY : NRI<(outs), (ins Signature:$sig), [], "try \t$sig", 0x06>; |
| 145 | defm END_TRY : NRI<(outs), (ins), [], "end_try", 0x0b>; |
Heejin Ahn | e4a8dee | 2018-03-02 01:03:40 +0000 | [diff] [blame] | 146 | } // Uses = [VALUE_STACK], Defs = [VALUE_STACK] |
| 147 | |
Heejin Ahn | 9e4eade | 2020-12-26 02:27:44 -0800 | [diff] [blame] | 148 | // Catching an exception: catch / catch_all |
| 149 | let hasCtrlDep = 1, hasSideEffects = 1 in { |
Heejin Ahn | 52e240a | 2020-12-25 20:23:33 -0800 | [diff] [blame] | 150 | // Currently 'catch' can only extract an i32, which is sufficient for C++ |
Heejin Ahn | 9e4eade | 2020-12-26 02:27:44 -0800 | [diff] [blame] | 151 | // support, but according to the spec 'catch' can extract any number of values |
Heejin Ahn | 1d891d4 | 2021-06-15 01:49:43 -0700 | [diff] [blame^] | 152 | // based on the tag type. |
| 153 | defm CATCH : I<(outs I32:$dst), (ins tag_op:$tag), |
| 154 | (outs), (ins tag_op:$tag), |
Heejin Ahn | 9e4eade | 2020-12-26 02:27:44 -0800 | [diff] [blame] | 155 | [(set I32:$dst, |
| 156 | (WebAssemblycatch (WebAssemblywrapper texternalsym:$tag)))], |
| 157 | "catch \t$dst, $tag", "catch \t$tag", 0x07>; |
Heejin Ahn | 7c594ba | 2021-02-17 05:27:19 -0800 | [diff] [blame] | 158 | defm CATCH_ALL : NRI<(outs), (ins), [], "catch_all", 0x19>; |
Heejin Ahn | 9e4eade | 2020-12-26 02:27:44 -0800 | [diff] [blame] | 159 | } |
Heejin Ahn | d6f4878 | 2019-01-30 03:21:57 +0000 | [diff] [blame] | 160 | |
Heejin Ahn | ed41945 | 2020-12-28 05:10:22 -0800 | [diff] [blame] | 161 | // Delegating an exception: delegate |
| 162 | let isTerminator = 1, hasCtrlDep = 1, hasSideEffects = 1 in |
| 163 | defm DELEGATE : NRI<(outs), (ins bb_op:$dst), [], "delegate \t $dst", 0x18>; |
| 164 | |
Heejin Ahn | 5ef4d5f | 2018-05-31 22:25:54 +0000 | [diff] [blame] | 165 | // Pseudo instructions: cleanupret / catchret |
Heejin Ahn | 5ef4d5f | 2018-05-31 22:25:54 +0000 | [diff] [blame] | 166 | let isTerminator = 1, hasSideEffects = 1, isBarrier = 1, hasCtrlDep = 1, |
Heejin Ahn | d6f4878 | 2019-01-30 03:21:57 +0000 | [diff] [blame] | 167 | isPseudo = 1, isEHScopeReturn = 1 in { |
| 168 | defm CLEANUPRET : NRI<(outs), (ins), [(cleanupret)], "cleanupret", 0>; |
Wouter van Oortmerssen | 48dac31 | 2018-06-18 21:22:44 +0000 | [diff] [blame] | 169 | defm CATCHRET : NRI<(outs), (ins bb_op:$dst, bb_op:$from), |
Heejin Ahn | d6f4878 | 2019-01-30 03:21:57 +0000 | [diff] [blame] | 170 | [(catchret bb:$dst, bb:$from)], "catchret", 0>; |
| 171 | } // isTerminator = 1, hasSideEffects = 1, isBarrier = 1, hasCtrlDep = 1, |
| 172 | // isPseudo = 1, isEHScopeReturn = 1 |
Heejin Ahn | 4367587 | 2019-02-06 00:17:03 +0000 | [diff] [blame] | 173 | } // Predicates = [HasExceptionHandling] |