1 //==- WebAssemblyMCTargetDesc.h - WebAssembly Target Descriptions -*- C++ -*-=// 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 provides WebAssembly-specific target descriptions. 11 /// 12 //===----------------------------------------------------------------------===// 13 14 #ifndef LLVM_LIB_TARGET_WEBASSEMBLY_MCTARGETDESC_WEBASSEMBLYMCTARGETDESC_H 15 #define LLVM_LIB_TARGET_WEBASSEMBLY_MCTARGETDESC_WEBASSEMBLYMCTARGETDESC_H 16 17 #include "../WebAssemblySubtarget.h" 18 #include "llvm/BinaryFormat/Wasm.h" 19 #include "llvm/MC/MCInstrDesc.h" 20 #include "llvm/Support/DataTypes.h" 21 #include <memory> 22 23 namespace llvm { 24 25 class MCAsmBackend; 26 class MCCodeEmitter; 27 class MCInstrInfo; 28 class MCObjectTargetWriter; 29 class MVT; 30 class Triple; 31 32 MCCodeEmitter *createWebAssemblyMCCodeEmitter(const MCInstrInfo &MCII); 33 34 MCAsmBackend *createWebAssemblyAsmBackend(const Triple &TT); 35 36 std::unique_ptr<MCObjectTargetWriter> 37 createWebAssemblyWasmObjectWriter(bool Is64Bit, bool IsEmscripten); 38 39 namespace WebAssembly { 40 enum OperandType { 41 /// Basic block label in a branch construct. 42 OPERAND_BASIC_BLOCK = MCOI::OPERAND_FIRST_TARGET, 43 /// Local index. 44 OPERAND_LOCAL, 45 /// Global index. 46 OPERAND_GLOBAL, 47 /// 32-bit integer immediates. 48 OPERAND_I32IMM, 49 /// 64-bit integer immediates. 50 OPERAND_I64IMM, 51 /// 32-bit floating-point immediates. 52 OPERAND_F32IMM, 53 /// 64-bit floating-point immediates. 54 OPERAND_F64IMM, 55 /// 8-bit vector lane immediate 56 OPERAND_VEC_I8IMM, 57 /// 16-bit vector lane immediate 58 OPERAND_VEC_I16IMM, 59 /// 32-bit vector lane immediate 60 OPERAND_VEC_I32IMM, 61 /// 64-bit vector lane immediate 62 OPERAND_VEC_I64IMM, 63 /// 32-bit unsigned function indices. 64 OPERAND_FUNCTION32, 65 /// 32-bit unsigned memory offsets. 66 OPERAND_OFFSET32, 67 /// 64-bit unsigned memory offsets. 68 OPERAND_OFFSET64, 69 /// p2align immediate for load and store address alignment. 70 OPERAND_P2ALIGN, 71 /// signature immediate for block/loop. 72 OPERAND_SIGNATURE, 73 /// type signature immediate for call_indirect. 74 OPERAND_TYPEINDEX, 75 /// Event index. 76 OPERAND_EVENT, 77 /// A list of branch targets for br_list. 78 OPERAND_BRLIST, 79 /// 32-bit unsigned table number. 80 OPERAND_TABLE, 81 /// heap type immediate for ref.null. 82 OPERAND_HEAPTYPE, 83 }; 84 } // end namespace WebAssembly 85 86 namespace WebAssemblyII { 87 88 /// Target Operand Flag enum. 89 enum TOF { 90 MO_NO_FLAG = 0, 91 92 // On a symbol operand this indicates that the immediate is a wasm global 93 // index. The value of the wasm global will be set to the symbol address at 94 // runtime. This adds a level of indirection similar to the GOT on native 95 // platforms. 96 MO_GOT, 97 98 // On a symbol operand this indicates that the immediate is the symbol 99 // address relative the __memory_base wasm global. 100 // Only applicable to data symbols. 101 MO_MEMORY_BASE_REL, 102 103 // On a symbol operand this indicates that the immediate is the symbol 104 // address relative the __tls_base wasm global. 105 // Only applicable to data symbols. 106 MO_TLS_BASE_REL, 107 108 // On a symbol operand this indicates that the immediate is the symbol 109 // address relative the __table_base wasm global. 110 // Only applicable to function symbols. 111 MO_TABLE_BASE_REL, 112 }; 113 114 } // end namespace WebAssemblyII 115 116 } // end namespace llvm 117 118 // Defines symbolic names for WebAssembly registers. This defines a mapping from 119 // register name to register number. 120 // 121 #define GET_REGINFO_ENUM 122 #include "WebAssemblyGenRegisterInfo.inc" 123 124 // Defines symbolic names for the WebAssembly instructions. 125 // 126 #define GET_INSTRINFO_ENUM 127 #include "WebAssemblyGenInstrInfo.inc" 128 129 namespace llvm { 130 namespace WebAssembly { 131 132 /// Used as immediate MachineOperands for block signatures 133 enum class BlockType : unsigned { 134 Invalid = 0x00, 135 Void = 0x40, 136 I32 = unsigned(wasm::ValType::I32), 137 I64 = unsigned(wasm::ValType::I64), 138 F32 = unsigned(wasm::ValType::F32), 139 F64 = unsigned(wasm::ValType::F64), 140 V128 = unsigned(wasm::ValType::V128), 141 Externref = unsigned(wasm::ValType::EXTERNREF), 142 Funcref = unsigned(wasm::ValType::FUNCREF), 143 // Multivalue blocks (and other non-void blocks) are only emitted when the 144 // blocks will never be exited and are at the ends of functions (see 145 // WebAssemblyCFGStackify::fixEndsAtEndOfFunction). They also are never made 146 // to pop values off the stack, so the exact multivalue signature can always 147 // be inferred from the return type of the parent function in MCInstLower. 148 Multivalue = 0xffff, 149 }; 150 151 /// Used as immediate MachineOperands for heap types, e.g. for ref.null. 152 enum class HeapType : unsigned { 153 Invalid = 0x00, 154 Externref = unsigned(wasm::ValType::EXTERNREF), 155 Funcref = unsigned(wasm::ValType::FUNCREF), 156 }; 157 158 /// Instruction opcodes emitted via means other than CodeGen. 159 static const unsigned Nop = 0x01; 160 static const unsigned End = 0x0b; 161 162 wasm::ValType toValType(const MVT &Ty); 163 164 /// Return the default p2align value for a load or store with the given opcode. 165 inline unsigned GetDefaultP2AlignAny(unsigned Opc) { 166 switch (Opc) { 167 #define WASM_LOAD_STORE(NAME) \ 168 case WebAssembly::NAME##_A32: \ 169 case WebAssembly::NAME##_A64: \ 170 case WebAssembly::NAME##_A32_S: \ 171 case WebAssembly::NAME##_A64_S: 172 WASM_LOAD_STORE(LOAD8_S_I32) 173 WASM_LOAD_STORE(LOAD8_U_I32) 174 WASM_LOAD_STORE(LOAD8_S_I64) 175 WASM_LOAD_STORE(LOAD8_U_I64) 176 WASM_LOAD_STORE(ATOMIC_LOAD8_U_I32) 177 WASM_LOAD_STORE(ATOMIC_LOAD8_U_I64) 178 WASM_LOAD_STORE(STORE8_I32) 179 WASM_LOAD_STORE(STORE8_I64) 180 WASM_LOAD_STORE(ATOMIC_STORE8_I32) 181 WASM_LOAD_STORE(ATOMIC_STORE8_I64) 182 WASM_LOAD_STORE(ATOMIC_RMW8_U_ADD_I32) 183 WASM_LOAD_STORE(ATOMIC_RMW8_U_ADD_I64) 184 WASM_LOAD_STORE(ATOMIC_RMW8_U_SUB_I32) 185 WASM_LOAD_STORE(ATOMIC_RMW8_U_SUB_I64) 186 WASM_LOAD_STORE(ATOMIC_RMW8_U_AND_I32) 187 WASM_LOAD_STORE(ATOMIC_RMW8_U_AND_I64) 188 WASM_LOAD_STORE(ATOMIC_RMW8_U_OR_I32) 189 WASM_LOAD_STORE(ATOMIC_RMW8_U_OR_I64) 190 WASM_LOAD_STORE(ATOMIC_RMW8_U_XOR_I32) 191 WASM_LOAD_STORE(ATOMIC_RMW8_U_XOR_I64) 192 WASM_LOAD_STORE(ATOMIC_RMW8_U_XCHG_I32) 193 WASM_LOAD_STORE(ATOMIC_RMW8_U_XCHG_I64) 194 WASM_LOAD_STORE(ATOMIC_RMW8_U_CMPXCHG_I32) 195 WASM_LOAD_STORE(ATOMIC_RMW8_U_CMPXCHG_I64) 196 WASM_LOAD_STORE(LOAD8_SPLAT) 197 WASM_LOAD_STORE(LOAD_LANE_I8x16) 198 WASM_LOAD_STORE(STORE_LANE_I8x16) 199 return 0; 200 WASM_LOAD_STORE(LOAD16_S_I32) 201 WASM_LOAD_STORE(LOAD16_U_I32) 202 WASM_LOAD_STORE(LOAD16_S_I64) 203 WASM_LOAD_STORE(LOAD16_U_I64) 204 WASM_LOAD_STORE(ATOMIC_LOAD16_U_I32) 205 WASM_LOAD_STORE(ATOMIC_LOAD16_U_I64) 206 WASM_LOAD_STORE(STORE16_I32) 207 WASM_LOAD_STORE(STORE16_I64) 208 WASM_LOAD_STORE(ATOMIC_STORE16_I32) 209 WASM_LOAD_STORE(ATOMIC_STORE16_I64) 210 WASM_LOAD_STORE(ATOMIC_RMW16_U_ADD_I32) 211 WASM_LOAD_STORE(ATOMIC_RMW16_U_ADD_I64) 212 WASM_LOAD_STORE(ATOMIC_RMW16_U_SUB_I32) 213 WASM_LOAD_STORE(ATOMIC_RMW16_U_SUB_I64) 214 WASM_LOAD_STORE(ATOMIC_RMW16_U_AND_I32) 215 WASM_LOAD_STORE(ATOMIC_RMW16_U_AND_I64) 216 WASM_LOAD_STORE(ATOMIC_RMW16_U_OR_I32) 217 WASM_LOAD_STORE(ATOMIC_RMW16_U_OR_I64) 218 WASM_LOAD_STORE(ATOMIC_RMW16_U_XOR_I32) 219 WASM_LOAD_STORE(ATOMIC_RMW16_U_XOR_I64) 220 WASM_LOAD_STORE(ATOMIC_RMW16_U_XCHG_I32) 221 WASM_LOAD_STORE(ATOMIC_RMW16_U_XCHG_I64) 222 WASM_LOAD_STORE(ATOMIC_RMW16_U_CMPXCHG_I32) 223 WASM_LOAD_STORE(ATOMIC_RMW16_U_CMPXCHG_I64) 224 WASM_LOAD_STORE(LOAD16_SPLAT) 225 WASM_LOAD_STORE(LOAD_LANE_I16x8) 226 WASM_LOAD_STORE(STORE_LANE_I16x8) 227 return 1; 228 WASM_LOAD_STORE(LOAD_I32) 229 WASM_LOAD_STORE(LOAD_F32) 230 WASM_LOAD_STORE(STORE_I32) 231 WASM_LOAD_STORE(STORE_F32) 232 WASM_LOAD_STORE(LOAD32_S_I64) 233 WASM_LOAD_STORE(LOAD32_U_I64) 234 WASM_LOAD_STORE(STORE32_I64) 235 WASM_LOAD_STORE(ATOMIC_LOAD_I32) 236 WASM_LOAD_STORE(ATOMIC_LOAD32_U_I64) 237 WASM_LOAD_STORE(ATOMIC_STORE_I32) 238 WASM_LOAD_STORE(ATOMIC_STORE32_I64) 239 WASM_LOAD_STORE(ATOMIC_RMW_ADD_I32) 240 WASM_LOAD_STORE(ATOMIC_RMW32_U_ADD_I64) 241 WASM_LOAD_STORE(ATOMIC_RMW_SUB_I32) 242 WASM_LOAD_STORE(ATOMIC_RMW32_U_SUB_I64) 243 WASM_LOAD_STORE(ATOMIC_RMW_AND_I32) 244 WASM_LOAD_STORE(ATOMIC_RMW32_U_AND_I64) 245 WASM_LOAD_STORE(ATOMIC_RMW_OR_I32) 246 WASM_LOAD_STORE(ATOMIC_RMW32_U_OR_I64) 247 WASM_LOAD_STORE(ATOMIC_RMW_XOR_I32) 248 WASM_LOAD_STORE(ATOMIC_RMW32_U_XOR_I64) 249 WASM_LOAD_STORE(ATOMIC_RMW_XCHG_I32) 250 WASM_LOAD_STORE(ATOMIC_RMW32_U_XCHG_I64) 251 WASM_LOAD_STORE(ATOMIC_RMW_CMPXCHG_I32) 252 WASM_LOAD_STORE(ATOMIC_RMW32_U_CMPXCHG_I64) 253 WASM_LOAD_STORE(MEMORY_ATOMIC_NOTIFY) 254 WASM_LOAD_STORE(MEMORY_ATOMIC_WAIT32) 255 WASM_LOAD_STORE(LOAD32_SPLAT) 256 WASM_LOAD_STORE(LOAD_ZERO_I32x4) 257 WASM_LOAD_STORE(LOAD_LANE_I32x4) 258 WASM_LOAD_STORE(STORE_LANE_I32x4) 259 return 2; 260 WASM_LOAD_STORE(LOAD_I64) 261 WASM_LOAD_STORE(LOAD_F64) 262 WASM_LOAD_STORE(STORE_I64) 263 WASM_LOAD_STORE(STORE_F64) 264 WASM_LOAD_STORE(ATOMIC_LOAD_I64) 265 WASM_LOAD_STORE(ATOMIC_STORE_I64) 266 WASM_LOAD_STORE(ATOMIC_RMW_ADD_I64) 267 WASM_LOAD_STORE(ATOMIC_RMW_SUB_I64) 268 WASM_LOAD_STORE(ATOMIC_RMW_AND_I64) 269 WASM_LOAD_STORE(ATOMIC_RMW_OR_I64) 270 WASM_LOAD_STORE(ATOMIC_RMW_XOR_I64) 271 WASM_LOAD_STORE(ATOMIC_RMW_XCHG_I64) 272 WASM_LOAD_STORE(ATOMIC_RMW_CMPXCHG_I64) 273 WASM_LOAD_STORE(MEMORY_ATOMIC_WAIT64) 274 WASM_LOAD_STORE(LOAD64_SPLAT) 275 WASM_LOAD_STORE(LOAD_EXTEND_S_I16x8) 276 WASM_LOAD_STORE(LOAD_EXTEND_U_I16x8) 277 WASM_LOAD_STORE(LOAD_EXTEND_S_I32x4) 278 WASM_LOAD_STORE(LOAD_EXTEND_U_I32x4) 279 WASM_LOAD_STORE(LOAD_EXTEND_S_I64x2) 280 WASM_LOAD_STORE(LOAD_EXTEND_U_I64x2) 281 WASM_LOAD_STORE(LOAD_ZERO_I64x2) 282 WASM_LOAD_STORE(LOAD_LANE_I64x2) 283 WASM_LOAD_STORE(STORE_LANE_I64x2) 284 return 3; 285 WASM_LOAD_STORE(LOAD_V128) 286 WASM_LOAD_STORE(STORE_V128) 287 return 4; 288 default: 289 return -1; 290 } 291 #undef WASM_LOAD_STORE 292 } 293 294 inline unsigned GetDefaultP2Align(unsigned Opc) { 295 auto Align = GetDefaultP2AlignAny(Opc); 296 if (Align == -1U) { 297 llvm_unreachable("Only loads and stores have p2align values"); 298 } 299 return Align; 300 } 301 302 inline bool isArgument(unsigned Opc) { 303 switch (Opc) { 304 case WebAssembly::ARGUMENT_i32: 305 case WebAssembly::ARGUMENT_i32_S: 306 case WebAssembly::ARGUMENT_i64: 307 case WebAssembly::ARGUMENT_i64_S: 308 case WebAssembly::ARGUMENT_f32: 309 case WebAssembly::ARGUMENT_f32_S: 310 case WebAssembly::ARGUMENT_f64: 311 case WebAssembly::ARGUMENT_f64_S: 312 case WebAssembly::ARGUMENT_v16i8: 313 case WebAssembly::ARGUMENT_v16i8_S: 314 case WebAssembly::ARGUMENT_v8i16: 315 case WebAssembly::ARGUMENT_v8i16_S: 316 case WebAssembly::ARGUMENT_v4i32: 317 case WebAssembly::ARGUMENT_v4i32_S: 318 case WebAssembly::ARGUMENT_v2i64: 319 case WebAssembly::ARGUMENT_v2i64_S: 320 case WebAssembly::ARGUMENT_v4f32: 321 case WebAssembly::ARGUMENT_v4f32_S: 322 case WebAssembly::ARGUMENT_v2f64: 323 case WebAssembly::ARGUMENT_v2f64_S: 324 case WebAssembly::ARGUMENT_funcref: 325 case WebAssembly::ARGUMENT_funcref_S: 326 case WebAssembly::ARGUMENT_externref: 327 case WebAssembly::ARGUMENT_externref_S: 328 return true; 329 default: 330 return false; 331 } 332 } 333 334 inline bool isCopy(unsigned Opc) { 335 switch (Opc) { 336 case WebAssembly::COPY_I32: 337 case WebAssembly::COPY_I32_S: 338 case WebAssembly::COPY_I64: 339 case WebAssembly::COPY_I64_S: 340 case WebAssembly::COPY_F32: 341 case WebAssembly::COPY_F32_S: 342 case WebAssembly::COPY_F64: 343 case WebAssembly::COPY_F64_S: 344 case WebAssembly::COPY_V128: 345 case WebAssembly::COPY_V128_S: 346 case WebAssembly::COPY_FUNCREF: 347 case WebAssembly::COPY_FUNCREF_S: 348 case WebAssembly::COPY_EXTERNREF: 349 case WebAssembly::COPY_EXTERNREF_S: 350 return true; 351 default: 352 return false; 353 } 354 } 355 356 inline bool isTee(unsigned Opc) { 357 switch (Opc) { 358 case WebAssembly::TEE_I32: 359 case WebAssembly::TEE_I32_S: 360 case WebAssembly::TEE_I64: 361 case WebAssembly::TEE_I64_S: 362 case WebAssembly::TEE_F32: 363 case WebAssembly::TEE_F32_S: 364 case WebAssembly::TEE_F64: 365 case WebAssembly::TEE_F64_S: 366 case WebAssembly::TEE_V128: 367 case WebAssembly::TEE_V128_S: 368 case WebAssembly::TEE_FUNCREF: 369 case WebAssembly::TEE_FUNCREF_S: 370 case WebAssembly::TEE_EXTERNREF: 371 case WebAssembly::TEE_EXTERNREF_S: 372 return true; 373 default: 374 return false; 375 } 376 } 377 378 inline bool isCallDirect(unsigned Opc) { 379 switch (Opc) { 380 case WebAssembly::CALL: 381 case WebAssembly::CALL_S: 382 case WebAssembly::RET_CALL: 383 case WebAssembly::RET_CALL_S: 384 return true; 385 default: 386 return false; 387 } 388 } 389 390 inline bool isCallIndirect(unsigned Opc) { 391 switch (Opc) { 392 case WebAssembly::CALL_INDIRECT: 393 case WebAssembly::CALL_INDIRECT_S: 394 case WebAssembly::RET_CALL_INDIRECT: 395 case WebAssembly::RET_CALL_INDIRECT_S: 396 return true; 397 default: 398 return false; 399 } 400 } 401 402 inline bool isBrTable(const MachineInstr &MI) { 403 switch (MI.getOpcode()) { 404 case WebAssembly::BR_TABLE_I32: 405 case WebAssembly::BR_TABLE_I32_S: 406 case WebAssembly::BR_TABLE_I64: 407 case WebAssembly::BR_TABLE_I64_S: 408 return true; 409 default: 410 return false; 411 } 412 } 413 414 inline bool isMarker(unsigned Opc) { 415 switch (Opc) { 416 case WebAssembly::BLOCK: 417 case WebAssembly::BLOCK_S: 418 case WebAssembly::END_BLOCK: 419 case WebAssembly::END_BLOCK_S: 420 case WebAssembly::LOOP: 421 case WebAssembly::LOOP_S: 422 case WebAssembly::END_LOOP: 423 case WebAssembly::END_LOOP_S: 424 case WebAssembly::TRY: 425 case WebAssembly::TRY_S: 426 case WebAssembly::END_TRY: 427 case WebAssembly::END_TRY_S: 428 return true; 429 default: 430 return false; 431 } 432 } 433 434 inline bool isCatch(unsigned Opc) { 435 switch (Opc) { 436 case WebAssembly::CATCH: 437 case WebAssembly::CATCH_S: 438 case WebAssembly::CATCH_ALL: 439 case WebAssembly::CATCH_ALL_S: 440 return true; 441 default: 442 return false; 443 } 444 } 445 446 } // end namespace WebAssembly 447 } // end namespace llvm 448 449 #endif 450