1// WebAssemblyMCInstLower.cpp - Convert WebAssembly MachineInstr to an MCInst //
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
7//===----------------------------------------------------------------------===//
10/// This file contains code to lower WebAssembly MachineInstrs to their
11/// corresponding MCInst records.
13//===----------------------------------------------------------------------===//
41// This disables the removal of registers when lowering into MC, as required
42// by some current tests.
45 cl::desc(
"WebAssembly: output stack registers in"
46 " instruction output for test purposes only."),
52WebAssemblyMCInstLower::GetGlobalAddressSymbol(
const MachineOperand &MO)
const {
56 // If the symbol doesn't have an explicit WasmSymbolType yet and the
57 // GlobalValue is actually a WebAssembly global, then ensure the symbol is a
58 // WASM_SYMBOL_TYPE_GLOBAL.
60 !WasmSym->getType()) {
84 bool InvokeDetected =
false;
85 auto *WasmSym = Printer.getMCSymbolForFunction(
F, Signature, InvokeDetected);
86 WasmSym->setSignature(Signature);
91MCSymbol *WebAssemblyMCInstLower::GetExternalSymbolSymbol(
101 switch (TargetFlags) {
126 const auto *WasmSym =
static_cast<const MCSymbolWasm *
>(Sym);
129 if (WasmSym->isFunction())
131 if (WasmSym->isGlobal())
133 if (WasmSym->isTag())
135 if (WasmSym->isTable())
145MCOperand WebAssemblyMCInstLower::lowerTypeIndexOperand(
148 auto Signature = Ctx.createWasmSignature();
149 Signature->Returns = std::move(Returns);
150 Signature->Params = std::move(Params);
152 static_cast<MCSymbolWasm *
>(Printer.createTempSymbol(
"typeindex"));
153 Sym->setSignature(Signature);
161WebAssemblyMCInstLower::lowerEncodedFunctionSignature(
const APInt &Sig)
const {
162 // For APInt a word is 64 bits on all architectures, see definition in APInt.h
168 auto GetWord = [&Idx, &Sig]() {
172 // Annoying special case: if getSignificantBits() <= 64 then InstrEmitter will
173 // emit an Imm instead of a CImm. It simplifies WebAssemblyMCInstLower if we
174 // always emit a CImm. So xor NParams with 0x7ffffff to ensure
175 // getSignificantBits() > 64
176 // See encodeFunctionSignature in WebAssemblyISelDAGtoDAG.cpp
177 int NReturns = GetWord() ^ 0x7ffffff;
178 for (
int I = 0;
I < NReturns;
I++) {
181 int NParams = GetWord();
182 for (
int I = 0;
I < NParams;
I++) {
185 return lowerTypeIndexOperand(std::move(Returns), std::move(Params));
192 Type *RetTy =
F.getReturnType();
203 unsigned NumVariadicDefs =
MI->getNumExplicitDefs() -
Desc.getNumDefs();
211 for (
unsigned I = 0, E =
MI->getNumOperands();
I != E; ++
I) {
223 // Ignore all implicit register operands.
233 // Lower type index placeholder for ref.test
234 // Currently this is the only way that CImmediates show up so panic if we
236 unsigned DescIndex =
I - NumVariadicDefs;
237 assert(DescIndex <
Desc.NumOperands &&
"unexpected CImmediate operand");
238 auto Operands =
Desc.operands();
241 "unexpected CImmediate operand");
247 unsigned DescIndex =
I - NumVariadicDefs;
248 if (DescIndex <
Desc.NumOperands) {
249 auto Operands =
Desc.operands();
251 // Replace type index placeholder with actual type index. The type index
252 // placeholders are Immediates and have an operand type of
253 // OPERAND_TYPEINDEX or OPERAND_SIGNATURE.
255 // Lower type index placeholder for a CALL_INDIRECT instruction
260 MI->getParent()->getParent()->getRegInfo();
269 // call_indirect instructions have a callee operand at the end which
270 // doesn't count as a param.
274 // return_call_indirect instructions have the return type of the
276 if (
MI->getOpcode() == WebAssembly::RET_CALL_INDIRECT)
279 MCOp = lowerTypeIndexOperand(std::move(Returns), std::move(Params));
283 // Lower type index placeholder for blocks
288 // Multivalue blocks are emitted in two cases:
289 // 1. When the blocks will never be exited and are at the ends of
291 // WebAssemblyCFGStackify::fixEndsAtEndOfFunction). In this case
292 // the exact multivalue signature can always be inferred from the
293 // return type of the parent function.
294 // 2. (catch_ref ...) clause in try_table instruction. Currently all
295 // tags we support (cpp_exception and c_longjmp) throws a single
296 // pointer, so the multivalue signature for this case will be
297 // (ptr, exnref). Having MO_CATCH_BLOCK_SIG target flags means
298 // this is a destination of a catch_ref.
303 MCOp = lowerTypeIndexOperand(std::move(Returns),
315 Imm->getValueAPF().bitcastToAPInt().getZExtValue();
316 if (Imm->getType()->isFloatTy())
318 else if (Imm->getType()->isDoubleTy())
325 MCOp = lowerSymbolOperand(MO, GetGlobalAddressSymbol(MO));
328 MCOp = lowerSymbolOperand(MO, GetExternalSymbolSymbol(MO));
332 "WebAssembly does not use target flags on MCSymbol");
342 else if (
Desc.variadicOpsAreDefs())
347 // Remove all uses of stackified registers to bring the instruction format
348 // into its final stack form used thruout MC, and transition opcodes to
350 // We do this separate from the above code that still may need these
351 // registers for e.g. call_indirect signatures.
352 // See comments in lib/Target/WebAssembly/WebAssemblyInstrFormats.td for
354 // TODO: the code above creates new registers which are then removed here.
355 // That code could be slightly simplified by not doing that, though maybe
356 // it is simpler conceptually to keep the code above in "register mode"
357 // until this transition point.
358 // FIXME: we are not processing inline assembly, which contains register
359 // operands, because it is used by later target generic code.
360 if (
MI->isDebugInstr() ||
MI->isLabel() ||
MI->isInlineAsm())
363 // Transform to _S instruction.
366 assert(StackOpcode != -1 &&
"Failed to stackify instruction");
369 // Remove register operands.
unsigned const MachineRegisterInfo * MRI
assert(UImm &&(UImm !=~static_cast< T >(0)) &&"Invalid immediate!")
This file implements a class to represent arbitrary precision integral constant values and operations...
This file contains the declarations for the subclasses of Constant, which represent the different fla...
dxil pretty DXIL Metadata Pretty Printer
This file defines the SmallVector class.
cl::opt< bool > WasmKeepRegisters
This file contains the declaration of the WebAssemblyMCAsmInfo class.
static void removeRegisterOperands(const MachineInstr *MI, MCInst &OutMI)
static cl::opt< bool > WasmKeepRegisters("wasm-keep-registers", cl::Hidden, cl::desc("WebAssembly: output stack registers in" " instruction output for test purposes only."), cl::init(false))
static void getFunctionReturns(const MachineInstr *MI, SmallVectorImpl< wasm::ValType > &Returns)
This file declares the class to lower WebAssembly MachineInstrs to their corresponding MCInst records...
This file provides WebAssembly-specific target descriptions.
This file contains the declaration of the WebAssembly-specific type parsing utility functions.
This file declares WebAssembly-specific per-machine-function information.
This file registers the WebAssembly target.
This file contains the declaration of the WebAssembly-specific type parsing utility functions.
This file contains the declaration of the WebAssembly-specific utility functions.
Class for arbitrary precision integers.
LLVM_ABI uint64_t extractBitsAsZExtValue(unsigned numBits, unsigned bitPosition) const
unsigned getNumWords() const
Get the number of words.
ConstantFP - Floating Point Values [float, double].
const APInt & getValue() const
Return the constant as an APInt value reference.
static const MCBinaryExpr * createAdd(const MCExpr *LHS, const MCExpr *RHS, MCContext &Ctx, SMLoc Loc=SMLoc())
static LLVM_ABI const MCConstantExpr * create(int64_t Value, MCContext &Ctx, bool PrintInHex=false, unsigned SizeInBytes=0)
Instances of this class represent a single low-level machine instruction.
unsigned getNumOperands() const
unsigned getOpcode() const
iterator insert(iterator I, const MCOperand &Op)
void addOperand(const MCOperand Op)
void setOpcode(unsigned Op)
const MCOperand & getOperand(unsigned i) const
Describe properties that are true of each instruction in the target description file.
This holds information about one operand of a machine instruction, indicating the register class for ...
Instances of this class represent operands of the MCInst class.
static MCOperand createExpr(const MCExpr *Val)
static MCOperand createSFPImm(uint32_t Val)
static MCOperand createReg(MCRegister Reg)
static MCOperand createImm(int64_t Val)
static MCOperand createDFPImm(uint64_t Val)
static const MCSymbolRefExpr * create(const MCSymbol *Symbol, MCContext &Ctx, SMLoc Loc=SMLoc())
MCSymbol - Instances of this class represent a symbol name in the MC file, and MCSymbols are created ...
const MachineFunction * getParent() const
Return the MachineFunction containing this basic block.
const TargetSubtargetInfo & getSubtarget() const
getSubtarget - Return the subtarget for which this machine code is being compiled.
const DataLayout & getDataLayout() const
Return the DataLayout attached to the Module associated to this MF.
Function & getFunction()
Return the LLVM function that this machine code represents.
const TargetMachine & getTarget() const
getTarget - Return the target machine this machine code is compiled with
Representation of each machine instruction.
const MachineBasicBlock * getParent() const
MachineOperand class - Representation of each machine instruction operand.
const GlobalValue * getGlobal() const
const ConstantInt * getCImm() const
bool isReg() const
isReg - Tests if this is a MO_Register operand.
MachineInstr * getParent()
getParent - Return the instruction that this operand belongs to.
unsigned getTargetFlags() const
MachineOperandType getType() const
getType - Returns the MachineOperandType for this operand.
const char * getSymbolName() const
Register getReg() const
getReg - Returns the register number.
const ConstantFP * getFPImm() const
MCSymbol * getMCSymbol() const
@ MO_Immediate
Immediate operand.
@ MO_MCSymbol
MCSymbol reference (for debug/eh info)
@ MO_GlobalAddress
Address of a global value.
@ MO_CImmediate
Immediate >64bit operand.
@ MO_MachineBasicBlock
MachineBasicBlock reference.
@ MO_Register
Register operand.
@ MO_ExternalSymbol
Name of external global symbol.
@ MO_FPImmediate
Floating-point immediate operand.
int64_t getOffset() const
Return the offset from the symbol in this operand.
MachineRegisterInfo - Keep track of information for virtual and physical registers,...
This class consists of common code factored out of the SmallVector class to reduce code duplication b...
void push_back(const T &Elt)
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
Primary interface to the complete machine description for the target machine.
The instances of the Type class are immutable: once they are created, they are never changed.
This class is derived from MachineFunctionInfo and contains private WebAssembly-specific information ...
unsigned getWAReg(Register VReg) const
void lower(const MachineInstr *MI, MCInst &OutMI) const
#define llvm_unreachable(msg)
Marks that the current location is not supposed to be reachable.
bool isCallIndirect(unsigned Opc)
wasm::ValType regClassToValType(unsigned RC)
void wasmSymbolSetType(MCSymbolWasm *Sym, const Type *GlobalVT, ArrayRef< MVT > VTs)
Sets a Wasm Symbol Type.
BlockType
Used as immediate MachineOperands for block signatures.
@ OPERAND_TYPEINDEX
type signature immediate for call_indirect.
@ OPERAND_SIGNATURE
signature immediate for block/loop.
int getStackOpcode(unsigned short Opcode)
bool isWasmVarAddressSpace(unsigned AS)
initializer< Ty > init(const Ty &Val)
@ WASM_SYMBOL_TYPE_FUNCTION
This is an optimization pass for GlobalISel generic memory operations.
void computeSignatureVTs(const FunctionType *Ty, const Function *TargetFunc, const Function &ContextFunc, const TargetMachine &TM, SmallVectorImpl< MVT > &Params, SmallVectorImpl< MVT > &Results)
decltype(auto) dyn_cast(const From &Val)
dyn_cast<X> - Return the argument parameter cast to the specified type.
LLVM_ABI void report_fatal_error(Error Err, bool gen_crash_diag=true)
class LLVM_GSL_OWNER SmallVector
Forward declaration of SmallVector so that calculateSmallVectorDefaultInlinedElements can reference s...
bool isa(const From &Val)
isa<X> - Return true if the parameter to the template is an instance of one of the template type argu...
LLVM_ABI raw_fd_ostream & errs()
This returns a reference to a raw_ostream for standard error.
@ Global
Append to llvm.global_dtors.
void valTypesFromMVTs(ArrayRef< MVT > In, SmallVectorImpl< wasm::ValType > &Out)
decltype(auto) cast(const From &Val)
cast<X> - Return the argument parameter cast to the specified type.
wasm::WasmSignature * signatureFromMVTs(MCContext &Ctx, const SmallVectorImpl< MVT > &Results, const SmallVectorImpl< MVT > &Params)
void computeLegalValueVTs(const WebAssemblyTargetLowering &TLI, LLVMContext &Ctx, const DataLayout &DL, Type *Ty, SmallVectorImpl< MVT > &ValueVTs)