1 //===-- WebAssemblyAsmPrinter.cpp - WebAssembly LLVM assembly writer ------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
11 /// \brief This file contains a printer that converts from our internal
12 /// representation of machine-dependent LLVM code to the WebAssembly assembly
15 //===----------------------------------------------------------------------===//
17 #include "WebAssembly.h"
18 #include "InstPrinter/WebAssemblyInstPrinter.h"
19 #include "MCTargetDesc/WebAssemblyMCTargetDesc.h"
20 #include "WebAssemblyMCInstLower.h"
21 #include "WebAssemblyMachineFunctionInfo.h"
22 #include "WebAssemblyRegisterInfo.h"
23 #include "WebAssemblySubtarget.h"
24 #include "llvm/ADT/SmallString.h"
25 #include "llvm/ADT/StringExtras.h"
26 #include "llvm/CodeGen/Analysis.h"
27 #include "llvm/CodeGen/AsmPrinter.h"
28 #include "llvm/CodeGen/MachineConstantPool.h"
29 #include "llvm/CodeGen/MachineInstr.h"
30 #include "llvm/IR/DataLayout.h"
31 #include "llvm/MC/MCContext.h"
32 #include "llvm/MC/MCStreamer.h"
33 #include "llvm/MC/MCSymbol.h"
34 #include "llvm/Support/Debug.h"
35 #include "llvm/Support/TargetRegistry.h"
36 #include "llvm/Support/raw_ostream.h"
40 #define DEBUG_TYPE "asm-printer"
44 class WebAssemblyAsmPrinter final : public AsmPrinter {
45 const MachineRegisterInfo *MRI;
46 const WebAssemblyFunctionInfo *MFI;
49 WebAssemblyAsmPrinter(TargetMachine &TM, std::unique_ptr<MCStreamer> Streamer)
50 : AsmPrinter(TM, std::move(Streamer)), MRI(nullptr), MFI(nullptr) {}
53 const char *getPassName() const override {
54 return "WebAssembly Assembly Printer";
57 //===------------------------------------------------------------------===//
58 // MachineFunctionPass Implementation.
59 //===------------------------------------------------------------------===//
61 void getAnalysisUsage(AnalysisUsage &AU) const override {
62 AsmPrinter::getAnalysisUsage(AU);
65 bool runOnMachineFunction(MachineFunction &MF) override {
66 MRI = &MF.getRegInfo();
67 MFI = MF.getInfo<WebAssemblyFunctionInfo>();
68 return AsmPrinter::runOnMachineFunction(MF);
71 //===------------------------------------------------------------------===//
72 // AsmPrinter Implementation.
73 //===------------------------------------------------------------------===//
75 void EmitJumpTableInfo() override;
76 void EmitConstantPool() override;
77 void EmitFunctionBodyStart() override;
78 void EmitInstruction(const MachineInstr *MI) override;
79 void EmitEndOfAsmFile(Module &M) override;
80 bool PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
81 unsigned AsmVariant, const char *ExtraCode,
82 raw_ostream &OS) override;
83 bool PrintAsmMemoryOperand(const MachineInstr *MI, unsigned OpNo,
84 unsigned AsmVariant, const char *ExtraCode,
85 raw_ostream &OS) override;
87 std::string getRegTypeName(unsigned RegNo) const;
88 const char *toString(MVT VT) const;
89 std::string regToString(const MachineOperand &MO);
92 } // end anonymous namespace
94 //===----------------------------------------------------------------------===//
96 //===----------------------------------------------------------------------===//
98 std::string WebAssemblyAsmPrinter::getRegTypeName(unsigned RegNo) const {
99 const TargetRegisterClass *TRC = MRI->getRegClass(RegNo);
100 for (MVT T : {MVT::i32, MVT::i64, MVT::f32, MVT::f64})
102 return EVT(T).getEVTString();
103 DEBUG(errs() << "Unknown type for register number: " << RegNo);
104 llvm_unreachable("Unknown register type");
108 std::string WebAssemblyAsmPrinter::regToString(const MachineOperand &MO) {
109 unsigned RegNo = MO.getReg();
110 if (TargetRegisterInfo::isPhysicalRegister(RegNo))
111 return WebAssemblyInstPrinter::getRegisterName(RegNo);
113 assert(!MFI->isVRegStackified(RegNo));
114 unsigned WAReg = MFI->getWAReg(RegNo);
115 assert(WAReg != WebAssemblyFunctionInfo::UnusedReg);
116 return '$' + utostr(WAReg);
119 const char *WebAssemblyAsmPrinter::toString(MVT VT) const {
120 switch (VT.SimpleTy) {
132 DEBUG(dbgs() << "Invalid type " << EVT(VT).getEVTString() << '\n');
133 llvm_unreachable("invalid type");
137 //===----------------------------------------------------------------------===//
138 // WebAssemblyAsmPrinter Implementation.
139 //===----------------------------------------------------------------------===//
141 void WebAssemblyAsmPrinter::EmitConstantPool() {
142 assert(MF->getConstantPool()->getConstants().empty() &&
143 "WebAssembly disables constant pools");
146 void WebAssemblyAsmPrinter::EmitJumpTableInfo() {
147 // Nothing to do; jump tables are incorporated into the instruction stream.
150 static void ComputeLegalValueVTs(const Function &F,
151 const TargetMachine &TM,
153 SmallVectorImpl<MVT> &ValueVTs) {
154 const DataLayout& DL(F.getParent()->getDataLayout());
155 const WebAssemblyTargetLowering &TLI =
156 *TM.getSubtarget<WebAssemblySubtarget>(F).getTargetLowering();
157 SmallVector<EVT, 4> VTs;
158 ComputeValueVTs(TLI, DL, Ty, VTs);
161 unsigned NumRegs = TLI.getNumRegisters(F.getContext(), VT);
162 MVT RegisterVT = TLI.getRegisterType(F.getContext(), VT);
163 for (unsigned i = 0; i != NumRegs; ++i)
164 ValueVTs.push_back(RegisterVT);
168 void WebAssemblyAsmPrinter::EmitFunctionBodyStart() {
169 SmallString<128> Str;
170 raw_svector_ostream OS(Str);
172 for (MVT VT : MFI->getParams())
173 OS << "\t" ".param " << toString(VT) << '\n';
175 SmallVector<MVT, 4> ResultVTs;
176 const Function &F(*MF->getFunction());
177 ComputeLegalValueVTs(F, TM, F.getReturnType(), ResultVTs);
178 // If the return type needs to be legalized it will get converted into
179 // passing a pointer.
180 if (ResultVTs.size() == 1)
181 OS << "\t" ".result " << toString(ResultVTs.front()) << '\n';
183 bool FirstWAReg = true;
184 for (unsigned Idx = 0, IdxE = MRI->getNumVirtRegs(); Idx != IdxE; ++Idx) {
185 unsigned VReg = TargetRegisterInfo::index2VirtReg(Idx);
186 unsigned WAReg = MFI->getWAReg(VReg);
187 // Don't declare unused registers.
188 if (WAReg == WebAssemblyFunctionInfo::UnusedReg)
190 // Don't redeclare parameters.
191 if (WAReg < MFI->getParams().size())
193 // Don't declare stackified registers.
197 OS << "\t" ".local ";
200 OS << getRegTypeName(VReg);
206 // EmitRawText appends a newline, so strip off the last newline.
207 StringRef Text = OS.str();
209 OutStreamer->EmitRawText(Text.substr(0, Text.size() - 1));
210 AsmPrinter::EmitFunctionBodyStart();
213 void WebAssemblyAsmPrinter::EmitInstruction(const MachineInstr *MI) {
214 DEBUG(dbgs() << "EmitInstruction: " << *MI << '\n');
216 switch (MI->getOpcode()) {
217 case WebAssembly::ARGUMENT_I32:
218 case WebAssembly::ARGUMENT_I64:
219 case WebAssembly::ARGUMENT_F32:
220 case WebAssembly::ARGUMENT_F64:
221 // These represent values which are live into the function entry, so there's
222 // no instruction to emit.
225 WebAssemblyMCInstLower MCInstLowering(OutContext, *this);
227 MCInstLowering.Lower(MI, TmpInst);
228 EmitToStreamer(*OutStreamer, TmpInst);
234 void WebAssemblyAsmPrinter::EmitEndOfAsmFile(Module &M) {
235 const DataLayout &DL = M.getDataLayout();
237 SmallString<128> Str;
238 raw_svector_ostream OS(Str);
239 for (const Function &F : M)
240 if (F.isDeclarationForLinker()) {
241 assert(F.hasName() && "imported functions must have a name");
245 OS << "\t.imports\n";
247 MCSymbol *Sym = OutStreamer->getContext().getOrCreateSymbol(F.getName());
248 OS << "\t.import " << *Sym << " \"\" " << *Sym;
250 const WebAssemblyTargetLowering &TLI =
251 *TM.getSubtarget<WebAssemblySubtarget>(F).getTargetLowering();
253 // If we need to legalize the return type, it'll get converted into
254 // passing a pointer.
255 bool SawParam = false;
256 SmallVector<MVT, 4> ResultVTs;
257 ComputeLegalValueVTs(F, TM, F.getReturnType(), ResultVTs);
258 if (ResultVTs.size() > 1) {
260 OS << " (param " << toString(TLI.getPointerTy(DL));
264 for (const Argument &A : F.args()) {
265 SmallVector<MVT, 4> ParamVTs;
266 ComputeLegalValueVTs(F, TM, A.getType(), ParamVTs);
267 for (MVT VT : ParamVTs) {
272 OS << ' ' << toString(VT);
278 for (MVT VT : ResultVTs)
279 OS << " (result " << toString(VT) << ')';
284 StringRef Text = OS.str();
286 OutStreamer->EmitRawText(Text.substr(0, Text.size() - 1));
289 bool WebAssemblyAsmPrinter::PrintAsmOperand(const MachineInstr *MI,
290 unsigned OpNo, unsigned AsmVariant,
291 const char *ExtraCode,
294 report_fatal_error("There are no defined alternate asm variants");
297 const MachineOperand &MO = MI->getOperand(OpNo);
301 OS << regToString(MO);
305 return AsmPrinter::PrintAsmOperand(MI, OpNo, AsmVariant, ExtraCode, OS);
308 bool WebAssemblyAsmPrinter::PrintAsmMemoryOperand(const MachineInstr *MI,
311 const char *ExtraCode,
314 report_fatal_error("There are no defined alternate asm variants");
317 OS << regToString(MI->getOperand(OpNo));
321 return AsmPrinter::PrintAsmMemoryOperand(MI, OpNo, AsmVariant, ExtraCode, OS);
324 // Force static initialization.
325 extern "C" void LLVMInitializeWebAssemblyAsmPrinter() {
326 RegisterAsmPrinter<WebAssemblyAsmPrinter> X(TheWebAssemblyTarget32);
327 RegisterAsmPrinter<WebAssemblyAsmPrinter> Y(TheWebAssemblyTarget64);