LLVM  8.0.0svn
WebAssemblyInstPrinter.cpp
Go to the documentation of this file.
1 //=- WebAssemblyInstPrinter.cpp - WebAssembly assembly instruction printing -=//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 ///
10 /// \file
11 /// Print MCInst instructions to wasm format.
12 ///
13 //===----------------------------------------------------------------------===//
14 
17 #include "WebAssembly.h"
19 #include "llvm/ADT/SmallSet.h"
20 #include "llvm/ADT/StringExtras.h"
22 #include "llvm/MC/MCExpr.h"
23 #include "llvm/MC/MCInst.h"
24 #include "llvm/MC/MCInstrInfo.h"
26 #include "llvm/MC/MCSymbol.h"
29 using namespace llvm;
30 
31 #define DEBUG_TYPE "asm-printer"
32 
33 #include "WebAssemblyGenAsmWriter.inc"
34 
36  const MCInstrInfo &MII,
37  const MCRegisterInfo &MRI)
38  : MCInstPrinter(MAI, MII, MRI), ControlFlowCounter(0) {}
39 
41  unsigned RegNo) const {
43  // Note that there's an implicit get_local/set_local here!
44  OS << "$" << RegNo;
45 }
46 
48  StringRef Annot,
49  const MCSubtargetInfo &STI) {
50  // Print the instruction (this uses the AsmStrings from the .td files).
51  printInstruction(MI, OS);
52 
53  // Print any additional variadic operands.
54  const MCInstrDesc &Desc = MII.get(MI->getOpcode());
55  if (Desc.isVariadic())
56  for (auto i = Desc.getNumOperands(), e = MI->getNumOperands(); i < e; ++i) {
57  // FIXME: For CALL_INDIRECT_VOID, don't print a leading comma, because
58  // we have an extra flags operand which is not currently printed, for
59  // compatiblity reasons.
60  if (i != 0 &&
61  (MI->getOpcode() != WebAssembly::CALL_INDIRECT_VOID ||
62  i != Desc.getNumOperands()))
63  OS << ", ";
64  printOperand(MI, i, OS);
65  }
66 
67  // Print any added annotation.
68  printAnnotation(OS, Annot);
69 
70  if (CommentStream) {
71  // Observe any effects on the control flow stack, for use in annotating
72  // control flow label references.
73  switch (MI->getOpcode()) {
74  default:
75  break;
76  case WebAssembly::LOOP:
77  case WebAssembly::LOOP_S: {
78  printAnnotation(OS, "label" + utostr(ControlFlowCounter) + ':');
79  ControlFlowStack.push_back(std::make_pair(ControlFlowCounter++, true));
80  break;
81  }
82  case WebAssembly::BLOCK:
83  case WebAssembly::BLOCK_S:
84  ControlFlowStack.push_back(std::make_pair(ControlFlowCounter++, false));
85  break;
86  case WebAssembly::END_LOOP:
87  case WebAssembly::END_LOOP_S:
88  // Have to guard against an empty stack, in case of mismatched pairs
89  // in assembly parsing.
90  if (!ControlFlowStack.empty()) ControlFlowStack.pop_back();
91  break;
93  case WebAssembly::END_BLOCK_S:
94  if (!ControlFlowStack.empty()) printAnnotation(
95  OS, "label" + utostr(ControlFlowStack.pop_back_val().first) + ':');
96  break;
97  }
98 
99  // Annotate any control flow label references.
100  unsigned NumFixedOperands = Desc.NumOperands;
101  SmallSet<uint64_t, 8> Printed;
102  for (unsigned i = 0, e = MI->getNumOperands(); i < e; ++i) {
103  if (!(i < NumFixedOperands
104  ? (Desc.OpInfo[i].OperandType ==
107  continue;
108  uint64_t Depth = MI->getOperand(i).getImm();
109  if (!Printed.insert(Depth).second)
110  continue;
111  const auto &Pair = ControlFlowStack.rbegin()[Depth];
112  printAnnotation(OS, utostr(Depth) + ": " + (Pair.second ? "up" : "down") +
113  " to label" + utostr(Pair.first));
114  }
115  }
116 }
117 
118 static std::string toString(const APFloat &FP) {
119  // Print NaNs with custom payloads specially.
120  if (FP.isNaN() &&
122  !FP.bitwiseIsEqual(
123  APFloat::getQNaN(FP.getSemantics(), /*Negative=*/true))) {
124  APInt AI = FP.bitcastToAPInt();
125  return
126  std::string(AI.isNegative() ? "-" : "") + "nan:0x" +
127  utohexstr(AI.getZExtValue() &
128  (AI.getBitWidth() == 32 ? INT64_C(0x007fffff) :
129  INT64_C(0x000fffffffffffff)),
130  /*LowerCase=*/true);
131  }
132 
133  // Use C99's hexadecimal floating-point representation.
134  static const size_t BufBytes = 128;
135  char buf[BufBytes];
136  auto Written = FP.convertToHexString(
137  buf, /*hexDigits=*/0, /*upperCase=*/false, APFloat::rmNearestTiesToEven);
138  (void)Written;
139  assert(Written != 0);
140  assert(Written < BufBytes);
141  return buf;
142 }
143 
144 void WebAssemblyInstPrinter::printOperand(const MCInst *MI, unsigned OpNo,
145  raw_ostream &O) {
146  const MCOperand &Op = MI->getOperand(OpNo);
147  if (Op.isReg()) {
148  assert((OpNo < MII.get(MI->getOpcode()).getNumOperands() ||
149  MII.get(MI->getOpcode()).TSFlags == 0) &&
150  "WebAssembly variable_ops register ops don't use TSFlags");
151  unsigned WAReg = Op.getReg();
152  if (int(WAReg) >= 0)
153  printRegName(O, WAReg);
154  else if (OpNo >= MII.get(MI->getOpcode()).getNumDefs())
155  O << "$pop" << WebAssemblyFunctionInfo::getWARegStackId(WAReg);
156  else if (WAReg != WebAssemblyFunctionInfo::UnusedReg)
157  O << "$push" << WebAssemblyFunctionInfo::getWARegStackId(WAReg);
158  else
159  O << "$drop";
160  // Add a '=' suffix if this is a def.
161  if (OpNo < MII.get(MI->getOpcode()).getNumDefs())
162  O << '=';
163  } else if (Op.isImm()) {
164  const MCInstrDesc &Desc = MII.get(MI->getOpcode());
165  assert((OpNo < Desc.getNumOperands() ||
167  "WebAssemblyII::VariableOpIsImmediate should be set for "
168  "variable_ops immediate ops");
169  (void)Desc;
170  // TODO: (MII.get(MI->getOpcode()).TSFlags &
171  // WebAssemblyII::VariableOpImmediateIsLabel)
172  // can tell us whether this is an immediate referencing a label in the
173  // control flow stack, and it may be nice to pretty-print.
174  O << Op.getImm();
175  } else if (Op.isFPImm()) {
176  const MCInstrDesc &Desc = MII.get(MI->getOpcode());
177  assert(OpNo < Desc.getNumOperands() &&
178  "Unexpected floating-point immediate as a non-fixed operand");
179  assert(Desc.TSFlags == 0 &&
180  "WebAssembly variable_ops floating point ops don't use TSFlags");
181  const MCOperandInfo &Info = Desc.OpInfo[OpNo];
183  // TODO: MC converts all floating point immediate operands to double.
184  // This is fine for numeric values, but may cause NaNs to change bits.
185  O << ::toString(APFloat(float(Op.getFPImm())));
186  } else {
188  O << ::toString(APFloat(Op.getFPImm()));
189  }
190  } else {
191  assert((OpNo < MII.get(MI->getOpcode()).getNumOperands() ||
192  (MII.get(MI->getOpcode()).TSFlags &
194  "WebAssemblyII::VariableOpIsImmediate should be set for "
195  "variable_ops expr ops");
196  assert(Op.isExpr() && "unknown operand kind in printOperand");
197  Op.getExpr()->print(O, &MAI);
198  }
199 }
200 
202  const MCInst *MI, unsigned OpNo, raw_ostream &O) {
203  int64_t Imm = MI->getOperand(OpNo).getImm();
204  if (Imm == WebAssembly::GetDefaultP2Align(MI->getOpcode()))
205  return;
206  O << ":p2align=" << Imm;
207 }
208 
210  const MCInst *MI, unsigned OpNo, raw_ostream &O) {
211  int64_t Imm = MI->getOperand(OpNo).getImm();
212  switch (WebAssembly::ExprType(Imm)) {
213  case WebAssembly::ExprType::Void: break;
214  case WebAssembly::ExprType::I32: O << "i32"; break;
215  case WebAssembly::ExprType::I64: O << "i64"; break;
216  case WebAssembly::ExprType::F32: O << "f32"; break;
217  case WebAssembly::ExprType::F64: O << "f64"; break;
218  case WebAssembly::ExprType::V128: O << "v128"; break;
219  case WebAssembly::ExprType::ExceptRef: O << "except_ref"; break;
220  }
221 }
222 
224  switch (Ty.SimpleTy) {
225  case MVT::i32:
226  return "i32";
227  case MVT::i64:
228  return "i64";
229  case MVT::f32:
230  return "f32";
231  case MVT::f64:
232  return "f64";
233  case MVT::v16i8:
234  case MVT::v8i16:
235  case MVT::v4i32:
236  case MVT::v2i64:
237  case MVT::v4f32:
238  case MVT::v2f64:
239  return "v128";
240  case MVT::ExceptRef:
241  return "except_ref";
242  default:
243  llvm_unreachable("unsupported type");
244  }
245 }
246 
248  switch (Type) {
249  case wasm::ValType::I32:
250  return "i32";
251  case wasm::ValType::I64:
252  return "i64";
253  case wasm::ValType::F32:
254  return "f32";
255  case wasm::ValType::F64:
256  return "f64";
258  return "except_ref";
259  }
260  llvm_unreachable("unsupported type");
261 }
32-bit floating-point immediates.
void printWebAssemblySignatureOperand(const MCInst *MI, unsigned OpNo, raw_ostream &O)
void push_back(const T &Elt)
Definition: SmallVector.h:218
bool isImm() const
Definition: MCInst.h:59
uint64_t getZExtValue() const
Get zero extended value.
Definition: APInt.h:1557
void printOperand(const MCInst *MI, unsigned OpNo, raw_ostream &O)
const char * TypeToString(MVT Ty)
Compute iterated dominance frontiers using a linear time algorithm.
Definition: AllocatorList.h:24
This class prints an WebAssembly MCInst to wasm file syntax.
Describe properties that are true of each instruction in the target description file.
Definition: MCInstrDesc.h:162
void printWebAssemblyP2AlignOperand(const MCInst *MI, unsigned OpNo, raw_ostream &O)
bool isReg() const
Definition: MCInst.h:58
void printRegName(raw_ostream &OS, unsigned RegNo) const override
Print the assembler register name.
Basic block label in a branch construct.
const fltSemantics & getSemantics() const
Definition: APFloat.h:1155
This file contains the entry points for global functions defined in the LLVM WebAssembly back-end...
WebAssemblyInstPrinter(const MCAsmInfo &MAI, const MCInstrInfo &MII, const MCRegisterInfo &MRI)
unsigned getBitWidth() const
Return the number of bits in the APInt.
Definition: APInt.h:1503
std::string toString(Error E)
Write all error messages (if any) in E to a string.
Definition: Error.h:960
unsigned getNumOperands() const
Return the number of declared MachineOperands for this MachineInstruction.
Definition: MCInstrDesc.h:209
SimpleValueType SimpleTy
unsigned getReg() const
Returns the register number.
Definition: MCInst.h:65
uint8_t OperandType
Information about the type of the operand.
Definition: MCInstrDesc.h:79
const MCExpr * getExpr() const
Definition: MCInst.h:96
Instances of this class represent a single low-level machine instruction.
Definition: MCInst.h:161
unsigned short NumOperands
Definition: MCInstrDesc.h:165
MCRegisterInfo base class - We assume that the target defines a static array of MCRegisterDesc object...
This class is intended to be used as a base class for asm properties and features specific to the tar...
Definition: MCAsmInfo.h:56
int64_t getImm() const
Definition: MCInst.h:76
bool isNegative() const
Determine sign of this APInt.
Definition: APInt.h:364
void print(raw_ostream &OS, const MCAsmInfo *MAI, bool InParens=false) const
Definition: MCExpr.cpp:42
unsigned const MachineRegisterInfo * MRI
Machine Value Type.
The instances of the Type class are immutable: once they are created, they are never changed...
Definition: Type.h:46
bool isVariadic() const
Return true if this instruction can have a variable number of operands.
Definition: MCInstrDesc.h:233
bool isNaN() const
Definition: APFloat.h:1145
SmallSet - This maintains a set of unique values, optimizing for the case when the set is small (less...
Definition: SmallSet.h:135
bool isFPImm() const
Definition: MCInst.h:60
This file provides WebAssembly-specific target descriptions.
Interface to description of machine instruction set.
Definition: MCInstrInfo.h:24
bool isExpr() const
Definition: MCInst.h:61
unsigned getNumOperands() const
Definition: MCInst.h:184
unsigned GetDefaultP2Align(unsigned Opcode)
Return the default p2align value for a load or store with the given opcode.
std::pair< NoneType, bool > insert(const T &V)
insert - Insert an element into the set if it isn&#39;t already there.
Definition: SmallSet.h:181
#define llvm_unreachable(msg)
Marks that the current location is not supposed to be reachable.
void printInst(const MCInst *MI, raw_ostream &OS, StringRef Annot, const MCSubtargetInfo &STI) override
Print the specified MCInst to the specified raw_ostream.
const MCOperand & getOperand(unsigned i) const
Definition: MCInst.h:182
LLVM_NODISCARD T pop_back_val()
Definition: SmallVector.h:381
ExprType
This is used to indicate block signatures.
raw_ostream * CommentStream
A stream that comments can be emitted to if desired.
Definition: MCInstPrinter.h:45
std::string utostr(uint64_t X, bool isNeg=false)
Definition: StringExtras.h:223
Class for arbitrary precision integers.
Definition: APInt.h:70
64-bit floating-point immediates.
unsigned int convertToHexString(char *DST, unsigned int HexDigits, bool UpperCase, roundingMode RM) const
Definition: APFloat.h:1137
const MCAsmInfo & MAI
Definition: MCInstPrinter.h:46
This is an instance of a target assembly language printer that converts an MCInst to valid target ass...
Definition: MCInstPrinter.h:40
LLVM_NODISCARD bool empty() const
Definition: SmallVector.h:56
const MCInstrDesc & get(unsigned Opcode) const
Return the machine instruction descriptor that corresponds to the specified instruction opcode...
Definition: MCInstrInfo.h:45
This file declares WebAssembly-specific per-machine-function information.
Generic base class for all target subtargets.
const MCInstrInfo & MII
Definition: MCInstPrinter.h:47
void printInstruction(const MCInst *MI, raw_ostream &O)
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
void printAnnotation(raw_ostream &OS, StringRef Annot)
Utility function for printing annotations.
bool bitwiseIsEqual(const APFloat &RHS) const
Definition: APFloat.h:1112
const MCOperandInfo * OpInfo
Definition: MCInstrDesc.h:173
This class implements an extremely fast bulk output stream that can only output to a stream...
Definition: raw_ostream.h:46
IRTranslator LLVM IR MI
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:49
APInt bitcastToAPInt() const
Definition: APFloat.h:1094
This holds information about one operand of a machine instruction, indicating the register class for ...
Definition: MCInstrDesc.h:67
unsigned getOpcode() const
Definition: MCInst.h:174
Instances of this class represent operands of the MCInst class.
Definition: MCInst.h:35
static APFloat getQNaN(const fltSemantics &Sem, bool Negative=false, const APInt *payload=nullptr)
Factory for QNaN values.
Definition: APFloat.h:886
double getFPImm() const
Definition: MCInst.h:86
std::string utohexstr(uint64_t X, bool LowerCase=false)
Definition: StringExtras.h:125
static unsigned getWARegStackId(unsigned Reg)