1 //==- WebAssemblyAsmParser.cpp - Assembler for WebAssembly -*- 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 is part of the WebAssembly Assembler.
11 ///
12 /// It contains code to translate a parsed .s file into MCInsts.
13 ///
14 //===----------------------------------------------------------------------===//
15 
16 #include "MCTargetDesc/WebAssemblyMCTargetDesc.h"
17 #include "MCTargetDesc/WebAssemblyTargetStreamer.h"
18 #include "TargetInfo/WebAssemblyTargetInfo.h"
19 #include "WebAssembly.h"
20 #include "llvm/MC/MCContext.h"
21 #include "llvm/MC/MCExpr.h"
22 #include "llvm/MC/MCInst.h"
23 #include "llvm/MC/MCInstrInfo.h"
24 #include "llvm/MC/MCParser/MCParsedAsmOperand.h"
25 #include "llvm/MC/MCParser/MCTargetAsmParser.h"
26 #include "llvm/MC/MCSectionWasm.h"
27 #include "llvm/MC/MCStreamer.h"
28 #include "llvm/MC/MCSubtargetInfo.h"
29 #include "llvm/MC/MCSymbol.h"
30 #include "llvm/MC/MCSymbolWasm.h"
31 #include "llvm/Support/Endian.h"
32 #include "llvm/Support/TargetRegistry.h"
33 
34 using namespace llvm;
35 
36 #define DEBUG_TYPE "wasm-asm-parser"
37 
38 namespace {
39 
40 /// WebAssemblyOperand - Instances of this class represent the operands in a
41 /// parsed WASM machine instruction.
42 struct WebAssemblyOperand : public MCParsedAsmOperand {
43   enum KindTy { Token, Integer, Float, Symbol, BrList } Kind;
44 
45   SMLoc StartLoc, EndLoc;
46 
47   struct TokOp {
48     StringRef Tok;
49   };
50 
51   struct IntOp {
52     int64_t Val;
53   };
54 
55   struct FltOp {
56     double Val;
57   };
58 
59   struct SymOp {
60     const MCExpr *Exp;
61   };
62 
63   struct BrLOp {
64     std::vector<unsigned> List;
65   };
66 
67   union {
68     struct TokOp Tok;
69     struct IntOp Int;
70     struct FltOp Flt;
71     struct SymOp Sym;
72     struct BrLOp BrL;
73   };
74 
75   WebAssemblyOperand(KindTy K, SMLoc Start, SMLoc End, TokOp T)
76       : Kind(K), StartLoc(Start), EndLoc(End), Tok(T) {}
77   WebAssemblyOperand(KindTy K, SMLoc Start, SMLoc End, IntOp I)
78       : Kind(K), StartLoc(Start), EndLoc(End), Int(I) {}
79   WebAssemblyOperand(KindTy K, SMLoc Start, SMLoc End, FltOp F)
80       : Kind(K), StartLoc(Start), EndLoc(End), Flt(F) {}
81   WebAssemblyOperand(KindTy K, SMLoc Start, SMLoc End, SymOp S)
82       : Kind(K), StartLoc(Start), EndLoc(End), Sym(S) {}
83   WebAssemblyOperand(KindTy K, SMLoc Start, SMLoc End)
84       : Kind(K), StartLoc(Start), EndLoc(End), BrL() {}
85 
86   ~WebAssemblyOperand() {
87     if (isBrList())
88       BrL.~BrLOp();
89   }
90 
91   bool isToken() const override { return Kind == Token; }
92   bool isImm() const override { return Kind == Integer || Kind == Symbol; }
93   bool isFPImm() const { return Kind == Float; }
94   bool isMem() const override { return false; }
95   bool isReg() const override { return false; }
96   bool isBrList() const { return Kind == BrList; }
97 
98   unsigned getReg() const override {
99     llvm_unreachable("Assembly inspects a register operand");
100     return 0;
101   }
102 
103   StringRef getToken() const {
104     assert(isToken());
105     return Tok.Tok;
106   }
107 
108   SMLoc getStartLoc() const override { return StartLoc; }
109   SMLoc getEndLoc() const override { return EndLoc; }
110 
111   void addRegOperands(MCInst &, unsigned) const {
112     // Required by the assembly matcher.
113     llvm_unreachable("Assembly matcher creates register operands");
114   }
115 
116   void addImmOperands(MCInst &Inst, unsigned N) const {
117     assert(N == 1 && "Invalid number of operands!");
118     if (Kind == Integer)
119       Inst.addOperand(MCOperand::createImm(Int.Val));
120     else if (Kind == Symbol)
121       Inst.addOperand(MCOperand::createExpr(Sym.Exp));
122     else
123       llvm_unreachable("Should be integer immediate or symbol!");
124   }
125 
126   void addFPImmOperands(MCInst &Inst, unsigned N) const {
127     assert(N == 1 && "Invalid number of operands!");
128     if (Kind == Float)
129       Inst.addOperand(MCOperand::createFPImm(Flt.Val));
130     else
131       llvm_unreachable("Should be float immediate!");
132   }
133 
134   void addBrListOperands(MCInst &Inst, unsigned N) const {
135     assert(N == 1 && isBrList() && "Invalid BrList!");
136     for (auto Br : BrL.List)
137       Inst.addOperand(MCOperand::createImm(Br));
138   }
139 
140   void print(raw_ostream &OS) const override {
141     switch (Kind) {
142     case Token:
143       OS << "Tok:" << Tok.Tok;
144       break;
145     case Integer:
146       OS << "Int:" << Int.Val;
147       break;
148     case Float:
149       OS << "Flt:" << Flt.Val;
150       break;
151     case Symbol:
152       OS << "Sym:" << Sym.Exp;
153       break;
154     case BrList:
155       OS << "BrList:" << BrL.List.size();
156       break;
157     }
158   }
159 };
160 
161 class WebAssemblyAsmParser final : public MCTargetAsmParser {
162   MCAsmParser &Parser;
163   MCAsmLexer &Lexer;
164 
165   // Much like WebAssemblyAsmPrinter in the backend, we have to own these.
166   std::vector<std::unique_ptr<wasm::WasmSignature>> Signatures;
167 
168   // Order of labels, directives and instructions in a .s file have no
169   // syntactical enforcement. This class is a callback from the actual parser,
170   // and yet we have to be feeding data to the streamer in a very particular
171   // order to ensure a correct binary encoding that matches the regular backend
172   // (the streamer does not enforce this). This "state machine" enum helps
173   // guarantee that correct order.
174   enum ParserState {
175     FileStart,
176     Label,
177     FunctionStart,
178     FunctionLocals,
179     Instructions,
180     EndFunction,
181     DataSection,
182   } CurrentState = FileStart;
183 
184   // For ensuring blocks are properly nested.
185   enum NestingType {
186     Function,
187     Block,
188     Loop,
189     Try,
190     If,
191     Else,
192     Undefined,
193   };
194   std::vector<NestingType> NestingStack;
195 
196   // We track this to see if a .functype following a label is the same,
197   // as this is how we recognize the start of a function.
198   MCSymbol *LastLabel = nullptr;
199   MCSymbol *LastFunctionLabel = nullptr;
200 
201 public:
202   WebAssemblyAsmParser(const MCSubtargetInfo &STI, MCAsmParser &Parser,
203                        const MCInstrInfo &MII, const MCTargetOptions &Options)
204       : MCTargetAsmParser(Options, STI, MII), Parser(Parser),
205         Lexer(Parser.getLexer()) {
206     setAvailableFeatures(ComputeAvailableFeatures(STI.getFeatureBits()));
207   }
208 
209 #define GET_ASSEMBLER_HEADER
210 #include "WebAssemblyGenAsmMatcher.inc"
211 
212   // TODO: This is required to be implemented, but appears unused.
213   bool ParseRegister(unsigned & /*RegNo*/, SMLoc & /*StartLoc*/,
214                      SMLoc & /*EndLoc*/) override {
215     llvm_unreachable("ParseRegister is not implemented.");
216   }
217 
218   bool error(const Twine &Msg, const AsmToken &Tok) {
219     return Parser.Error(Tok.getLoc(), Msg + Tok.getString());
220   }
221 
222   bool error(const Twine &Msg) {
223     return Parser.Error(Lexer.getTok().getLoc(), Msg);
224   }
225 
226   void addSignature(std::unique_ptr<wasm::WasmSignature> &&Sig) {
227     Signatures.push_back(std::move(Sig));
228   }
229 
230   std::pair<StringRef, StringRef> nestingString(NestingType NT) {
231     switch (NT) {
232     case Function:
233       return {"function", "end_function"};
234     case Block:
235       return {"block", "end_block"};
236     case Loop:
237       return {"loop", "end_loop"};
238     case Try:
239       return {"try", "end_try"};
240     case If:
241       return {"if", "end_if"};
242     case Else:
243       return {"else", "end_if"};
244     default:
245       llvm_unreachable("unknown NestingType");
246     }
247   }
248 
249   void push(NestingType NT) { NestingStack.push_back(NT); }
250 
251   bool pop(StringRef Ins, NestingType NT1, NestingType NT2 = Undefined) {
252     if (NestingStack.empty())
253       return error(Twine("End of block construct with no start: ") + Ins);
254     auto Top = NestingStack.back();
255     if (Top != NT1 && Top != NT2)
256       return error(Twine("Block construct type mismatch, expected: ") +
257                    nestingString(Top).second + ", instead got: " + Ins);
258     NestingStack.pop_back();
259     return false;
260   }
261 
262   bool ensureEmptyNestingStack() {
263     auto Err = !NestingStack.empty();
264     while (!NestingStack.empty()) {
265       error(Twine("Unmatched block construct(s) at function end: ") +
266             nestingString(NestingStack.back()).first);
267       NestingStack.pop_back();
268     }
269     return Err;
270   }
271 
272   bool isNext(AsmToken::TokenKind Kind) {
273     auto Ok = Lexer.is(Kind);
274     if (Ok)
275       Parser.Lex();
276     return Ok;
277   }
278 
279   bool expect(AsmToken::TokenKind Kind, const char *KindName) {
280     if (!isNext(Kind))
281       return error(std::string("Expected ") + KindName + ", instead got: ",
282                    Lexer.getTok());
283     return false;
284   }
285 
286   StringRef expectIdent() {
287     if (!Lexer.is(AsmToken::Identifier)) {
288       error("Expected identifier, got: ", Lexer.getTok());
289       return StringRef();
290     }
291     auto Name = Lexer.getTok().getString();
292     Parser.Lex();
293     return Name;
294   }
295 
296   Optional<wasm::ValType> parseType(const StringRef &Type) {
297     // FIXME: can't use StringSwitch because wasm::ValType doesn't have a
298     // "invalid" value.
299     if (Type == "i32")
300       return wasm::ValType::I32;
301     if (Type == "i64")
302       return wasm::ValType::I64;
303     if (Type == "f32")
304       return wasm::ValType::F32;
305     if (Type == "f64")
306       return wasm::ValType::F64;
307     if (Type == "v128" || Type == "i8x16" || Type == "i16x8" ||
308         Type == "i32x4" || Type == "i64x2" || Type == "f32x4" ||
309         Type == "f64x2")
310       return wasm::ValType::V128;
311     if (Type == "exnref")
312       return wasm::ValType::EXNREF;
313     return Optional<wasm::ValType>();
314   }
315 
316   WebAssembly::ExprType parseBlockType(StringRef ID) {
317     return StringSwitch<WebAssembly::ExprType>(ID)
318         .Case("i32", WebAssembly::ExprType::I32)
319         .Case("i64", WebAssembly::ExprType::I64)
320         .Case("f32", WebAssembly::ExprType::F32)
321         .Case("f64", WebAssembly::ExprType::F64)
322         .Case("v128", WebAssembly::ExprType::V128)
323         .Case("exnref", WebAssembly::ExprType::Exnref)
324         .Case("void", WebAssembly::ExprType::Void)
325         .Default(WebAssembly::ExprType::Invalid);
326   }
327 
328   bool parseRegTypeList(SmallVectorImpl<wasm::ValType> &Types) {
329     while (Lexer.is(AsmToken::Identifier)) {
330       auto Type = parseType(Lexer.getTok().getString());
331       if (!Type)
332         return error("unknown type: ", Lexer.getTok());
333       Types.push_back(Type.getValue());
334       Parser.Lex();
335       if (!isNext(AsmToken::Comma))
336         break;
337     }
338     return false;
339   }
340 
341   void parseSingleInteger(bool IsNegative, OperandVector &Operands) {
342     auto &Int = Lexer.getTok();
343     int64_t Val = Int.getIntVal();
344     if (IsNegative)
345       Val = -Val;
346     Operands.push_back(make_unique<WebAssemblyOperand>(
347         WebAssemblyOperand::Integer, Int.getLoc(), Int.getEndLoc(),
348         WebAssemblyOperand::IntOp{Val}));
349     Parser.Lex();
350   }
351 
352   bool parseSingleFloat(bool IsNegative, OperandVector &Operands) {
353     auto &Flt = Lexer.getTok();
354     double Val;
355     if (Flt.getString().getAsDouble(Val, false))
356       return error("Cannot parse real: ", Flt);
357     if (IsNegative)
358       Val = -Val;
359     Operands.push_back(make_unique<WebAssemblyOperand>(
360         WebAssemblyOperand::Float, Flt.getLoc(), Flt.getEndLoc(),
361         WebAssemblyOperand::FltOp{Val}));
362     Parser.Lex();
363     return false;
364   }
365 
366   bool parseSpecialFloatMaybe(bool IsNegative, OperandVector &Operands) {
367     if (Lexer.isNot(AsmToken::Identifier))
368       return true;
369     auto &Flt = Lexer.getTok();
370     auto S = Flt.getString();
371     double Val;
372     if (S.compare_lower("infinity") == 0) {
373       Val = std::numeric_limits<double>::infinity();
374     } else if (S.compare_lower("nan") == 0) {
375       Val = std::numeric_limits<double>::quiet_NaN();
376     } else {
377       return true;
378     }
379     if (IsNegative)
380       Val = -Val;
381     Operands.push_back(make_unique<WebAssemblyOperand>(
382         WebAssemblyOperand::Float, Flt.getLoc(), Flt.getEndLoc(),
383         WebAssemblyOperand::FltOp{Val}));
384     Parser.Lex();
385     return false;
386   }
387 
388   bool checkForP2AlignIfLoadStore(OperandVector &Operands, StringRef InstName) {
389     // FIXME: there is probably a cleaner way to do this.
390     auto IsLoadStore = InstName.find(".load") != StringRef::npos ||
391                        InstName.find(".store") != StringRef::npos;
392     auto IsAtomic = InstName.find("atomic.") != StringRef::npos;
393     if (IsLoadStore || IsAtomic) {
394       // Parse load/store operands of the form: offset:p2align=align
395       if (IsLoadStore && isNext(AsmToken::Colon)) {
396         auto Id = expectIdent();
397         if (Id != "p2align")
398           return error("Expected p2align, instead got: " + Id);
399         if (expect(AsmToken::Equal, "="))
400           return true;
401         if (!Lexer.is(AsmToken::Integer))
402           return error("Expected integer constant");
403         parseSingleInteger(false, Operands);
404       } else {
405         // Alignment not specified (or atomics, must use default alignment).
406         // We can't just call WebAssembly::GetDefaultP2Align since we don't have
407         // an opcode until after the assembly matcher, so set a default to fix
408         // up later.
409         auto Tok = Lexer.getTok();
410         Operands.push_back(make_unique<WebAssemblyOperand>(
411             WebAssemblyOperand::Integer, Tok.getLoc(), Tok.getEndLoc(),
412             WebAssemblyOperand::IntOp{-1}));
413       }
414     }
415     return false;
416   }
417 
418   void addBlockTypeOperand(OperandVector &Operands, SMLoc NameLoc,
419                            WebAssembly::ExprType BT) {
420     Operands.push_back(make_unique<WebAssemblyOperand>(
421         WebAssemblyOperand::Integer, NameLoc, NameLoc,
422         WebAssemblyOperand::IntOp{static_cast<int64_t>(BT)}));
423   }
424 
425   bool ParseInstruction(ParseInstructionInfo & /*Info*/, StringRef Name,
426                         SMLoc NameLoc, OperandVector &Operands) override {
427     // Note: Name does NOT point into the sourcecode, but to a local, so
428     // use NameLoc instead.
429     Name = StringRef(NameLoc.getPointer(), Name.size());
430 
431     // WebAssembly has instructions with / in them, which AsmLexer parses
432     // as seperate tokens, so if we find such tokens immediately adjacent (no
433     // whitespace), expand the name to include them:
434     for (;;) {
435       auto &Sep = Lexer.getTok();
436       if (Sep.getLoc().getPointer() != Name.end() ||
437           Sep.getKind() != AsmToken::Slash)
438         break;
439       // Extend name with /
440       Name = StringRef(Name.begin(), Name.size() + Sep.getString().size());
441       Parser.Lex();
442       // We must now find another identifier, or error.
443       auto &Id = Lexer.getTok();
444       if (Id.getKind() != AsmToken::Identifier ||
445           Id.getLoc().getPointer() != Name.end())
446         return error("Incomplete instruction name: ", Id);
447       Name = StringRef(Name.begin(), Name.size() + Id.getString().size());
448       Parser.Lex();
449     }
450 
451     // Now construct the name as first operand.
452     Operands.push_back(make_unique<WebAssemblyOperand>(
453         WebAssemblyOperand::Token, NameLoc, SMLoc::getFromPointer(Name.end()),
454         WebAssemblyOperand::TokOp{Name}));
455 
456     // If this instruction is part of a control flow structure, ensure
457     // proper nesting.
458     bool ExpectBlockType = false;
459     if (Name == "block") {
460       push(Block);
461       ExpectBlockType = true;
462     } else if (Name == "loop") {
463       push(Loop);
464       ExpectBlockType = true;
465     } else if (Name == "try") {
466       push(Try);
467       ExpectBlockType = true;
468     } else if (Name == "if") {
469       push(If);
470       ExpectBlockType = true;
471     } else if (Name == "else") {
472       if (pop(Name, If))
473         return true;
474       push(Else);
475     } else if (Name == "catch") {
476       if (pop(Name, Try))
477         return true;
478       push(Try);
479     } else if (Name == "end_if") {
480       if (pop(Name, If, Else))
481         return true;
482     } else if (Name == "end_try") {
483       if (pop(Name, Try))
484         return true;
485     } else if (Name == "end_loop") {
486       if (pop(Name, Loop))
487         return true;
488     } else if (Name == "end_block") {
489       if (pop(Name, Block))
490         return true;
491     } else if (Name == "end_function") {
492       CurrentState = EndFunction;
493       if (pop(Name, Function) || ensureEmptyNestingStack())
494         return true;
495     } else if (Name == "call_indirect" || Name == "return_call_indirect") {
496       // This has a special TYPEINDEX operand which in text we
497       // represent as a signature, such that we can re-build this signature,
498       // attach it to an anonymous symbol, which is what WasmObjectWriter
499       // expects to be able to recreate the actual unique-ified type indices.
500       auto Loc = Parser.getTok();
501       auto Signature = make_unique<wasm::WasmSignature>();
502       if (parseSignature(Signature.get()))
503         return true;
504       auto &Ctx = getStreamer().getContext();
505       // The "true" here will cause this to be a nameless symbol.
506       MCSymbol *Sym = Ctx.createTempSymbol("typeindex", true);
507       auto *WasmSym = cast<MCSymbolWasm>(Sym);
508       WasmSym->setSignature(Signature.get());
509       addSignature(std::move(Signature));
510       WasmSym->setType(wasm::WASM_SYMBOL_TYPE_FUNCTION);
511       const MCExpr *Expr = MCSymbolRefExpr::create(
512           WasmSym, MCSymbolRefExpr::VK_WASM_TYPEINDEX, Ctx);
513       Operands.push_back(make_unique<WebAssemblyOperand>(
514           WebAssemblyOperand::Symbol, Loc.getLoc(), Loc.getEndLoc(),
515           WebAssemblyOperand::SymOp{Expr}));
516     }
517 
518     while (Lexer.isNot(AsmToken::EndOfStatement)) {
519       auto &Tok = Lexer.getTok();
520       switch (Tok.getKind()) {
521       case AsmToken::Identifier: {
522         if (!parseSpecialFloatMaybe(false, Operands))
523           break;
524         auto &Id = Lexer.getTok();
525         if (ExpectBlockType) {
526           // Assume this identifier is a block_type.
527           auto BT = parseBlockType(Id.getString());
528           if (BT == WebAssembly::ExprType::Invalid)
529             return error("Unknown block type: ", Id);
530           addBlockTypeOperand(Operands, NameLoc, BT);
531           Parser.Lex();
532         } else {
533           // Assume this identifier is a label.
534           const MCExpr *Val;
535           SMLoc End;
536           if (Parser.parseExpression(Val, End))
537             return error("Cannot parse symbol: ", Lexer.getTok());
538           Operands.push_back(make_unique<WebAssemblyOperand>(
539               WebAssemblyOperand::Symbol, Id.getLoc(), Id.getEndLoc(),
540               WebAssemblyOperand::SymOp{Val}));
541           if (checkForP2AlignIfLoadStore(Operands, Name))
542             return true;
543         }
544         break;
545       }
546       case AsmToken::Minus:
547         Parser.Lex();
548         if (Lexer.is(AsmToken::Integer)) {
549           parseSingleInteger(true, Operands);
550           if (checkForP2AlignIfLoadStore(Operands, Name))
551             return true;
552         } else if(Lexer.is(AsmToken::Real)) {
553           if (parseSingleFloat(true, Operands))
554             return true;
555         } else if (!parseSpecialFloatMaybe(true, Operands)) {
556         } else {
557           return error("Expected numeric constant instead got: ",
558                        Lexer.getTok());
559         }
560         break;
561       case AsmToken::Integer:
562         parseSingleInteger(false, Operands);
563         if (checkForP2AlignIfLoadStore(Operands, Name))
564           return true;
565         break;
566       case AsmToken::Real: {
567         if (parseSingleFloat(false, Operands))
568           return true;
569         break;
570       }
571       case AsmToken::LCurly: {
572         Parser.Lex();
573         auto Op = make_unique<WebAssemblyOperand>(
574             WebAssemblyOperand::BrList, Tok.getLoc(), Tok.getEndLoc());
575         if (!Lexer.is(AsmToken::RCurly))
576           for (;;) {
577             Op->BrL.List.push_back(Lexer.getTok().getIntVal());
578             expect(AsmToken::Integer, "integer");
579             if (!isNext(AsmToken::Comma))
580               break;
581           }
582         expect(AsmToken::RCurly, "}");
583         Operands.push_back(std::move(Op));
584         break;
585       }
586       default:
587         return error("Unexpected token in operand: ", Tok);
588       }
589       if (Lexer.isNot(AsmToken::EndOfStatement)) {
590         if (expect(AsmToken::Comma, ","))
591           return true;
592       }
593     }
594     if (ExpectBlockType && Operands.size() == 1) {
595       // Support blocks with no operands as default to void.
596       addBlockTypeOperand(Operands, NameLoc, WebAssembly::ExprType::Void);
597     }
598     Parser.Lex();
599     return false;
600   }
601 
602   void onLabelParsed(MCSymbol *Symbol) override {
603     LastLabel = Symbol;
604     CurrentState = Label;
605   }
606 
607   bool parseSignature(wasm::WasmSignature *Signature) {
608     if (expect(AsmToken::LParen, "("))
609       return true;
610     if (parseRegTypeList(Signature->Params))
611       return true;
612     if (expect(AsmToken::RParen, ")"))
613       return true;
614     if (expect(AsmToken::MinusGreater, "->"))
615       return true;
616     if (expect(AsmToken::LParen, "("))
617       return true;
618     if (parseRegTypeList(Signature->Returns))
619       return true;
620     if (expect(AsmToken::RParen, ")"))
621       return true;
622     return false;
623   }
624 
625   bool CheckDataSection() {
626     if (CurrentState != DataSection) {
627       auto WS = cast<MCSectionWasm>(getStreamer().getCurrentSection().first);
628       if (WS && WS->getKind().isText())
629         return error("data directive must occur in a data segment: ",
630                      Lexer.getTok());
631     }
632     CurrentState = DataSection;
633     return false;
634   }
635 
636   // This function processes wasm-specific directives streamed to
637   // WebAssemblyTargetStreamer, all others go to the generic parser
638   // (see WasmAsmParser).
639   bool ParseDirective(AsmToken DirectiveID) override {
640     // This function has a really weird return value behavior that is different
641     // from all the other parsing functions:
642     // - return true && no tokens consumed -> don't know this directive / let
643     //   the generic parser handle it.
644     // - return true && tokens consumed -> a parsing error occurred.
645     // - return false -> processed this directive successfully.
646     assert(DirectiveID.getKind() == AsmToken::Identifier);
647     auto &Out = getStreamer();
648     auto &TOut =
649         reinterpret_cast<WebAssemblyTargetStreamer &>(*Out.getTargetStreamer());
650     auto &Ctx = Out.getContext();
651 
652     // TODO: any time we return an error, at least one token must have been
653     // consumed, otherwise this will not signal an error to the caller.
654     if (DirectiveID.getString() == ".globaltype") {
655       auto SymName = expectIdent();
656       if (SymName.empty())
657         return true;
658       if (expect(AsmToken::Comma, ","))
659         return true;
660       auto TypeTok = Lexer.getTok();
661       auto TypeName = expectIdent();
662       if (TypeName.empty())
663         return true;
664       auto Type = parseType(TypeName);
665       if (!Type)
666         return error("Unknown type in .globaltype directive: ", TypeTok);
667       // Now set this symbol with the correct type.
668       auto WasmSym = cast<MCSymbolWasm>(Ctx.getOrCreateSymbol(SymName));
669       WasmSym->setType(wasm::WASM_SYMBOL_TYPE_GLOBAL);
670       WasmSym->setGlobalType(
671           wasm::WasmGlobalType{uint8_t(Type.getValue()), true});
672       // And emit the directive again.
673       TOut.emitGlobalType(WasmSym);
674       return expect(AsmToken::EndOfStatement, "EOL");
675     }
676 
677     if (DirectiveID.getString() == ".functype") {
678       // This code has to send things to the streamer similar to
679       // WebAssemblyAsmPrinter::EmitFunctionBodyStart.
680       // TODO: would be good to factor this into a common function, but the
681       // assembler and backend really don't share any common code, and this code
682       // parses the locals seperately.
683       auto SymName = expectIdent();
684       if (SymName.empty())
685         return true;
686       auto WasmSym = cast<MCSymbolWasm>(Ctx.getOrCreateSymbol(SymName));
687       if (CurrentState == Label && WasmSym == LastLabel) {
688         // This .functype indicates a start of a function.
689         if (ensureEmptyNestingStack())
690           return true;
691         CurrentState = FunctionStart;
692         LastFunctionLabel = LastLabel;
693         push(Function);
694       }
695       auto Signature = make_unique<wasm::WasmSignature>();
696       if (parseSignature(Signature.get()))
697         return true;
698       WasmSym->setSignature(Signature.get());
699       addSignature(std::move(Signature));
700       WasmSym->setType(wasm::WASM_SYMBOL_TYPE_FUNCTION);
701       TOut.emitFunctionType(WasmSym);
702       // TODO: backend also calls TOut.emitIndIdx, but that is not implemented.
703       return expect(AsmToken::EndOfStatement, "EOL");
704     }
705 
706     if (DirectiveID.getString() == ".eventtype") {
707       auto SymName = expectIdent();
708       if (SymName.empty())
709         return true;
710       auto WasmSym = cast<MCSymbolWasm>(Ctx.getOrCreateSymbol(SymName));
711       auto Signature = make_unique<wasm::WasmSignature>();
712       if (parseRegTypeList(Signature->Params))
713         return true;
714       WasmSym->setSignature(Signature.get());
715       addSignature(std::move(Signature));
716       WasmSym->setType(wasm::WASM_SYMBOL_TYPE_EVENT);
717       TOut.emitEventType(WasmSym);
718       // TODO: backend also calls TOut.emitIndIdx, but that is not implemented.
719       return expect(AsmToken::EndOfStatement, "EOL");
720     }
721 
722     if (DirectiveID.getString() == ".local") {
723       if (CurrentState != FunctionStart)
724         return error(".local directive should follow the start of a function",
725                      Lexer.getTok());
726       SmallVector<wasm::ValType, 4> Locals;
727       if (parseRegTypeList(Locals))
728         return true;
729       TOut.emitLocal(Locals);
730       CurrentState = FunctionLocals;
731       return expect(AsmToken::EndOfStatement, "EOL");
732     }
733 
734     if (DirectiveID.getString() == ".int8" ||
735         DirectiveID.getString() == ".int16" ||
736         DirectiveID.getString() == ".int32" ||
737         DirectiveID.getString() == ".int64") {
738       if (CheckDataSection()) return true;
739       const MCExpr *Val;
740       SMLoc End;
741       if (Parser.parseExpression(Val, End))
742         return error("Cannot parse .int expression: ", Lexer.getTok());
743       size_t NumBits = 0;
744       DirectiveID.getString().drop_front(4).getAsInteger(10, NumBits);
745       Out.EmitValue(Val, NumBits / 8, End);
746       return expect(AsmToken::EndOfStatement, "EOL");
747     }
748 
749     if (DirectiveID.getString() == ".asciz") {
750       if (CheckDataSection()) return true;
751       std::string S;
752       if (Parser.parseEscapedString(S))
753         return error("Cannot parse string constant: ", Lexer.getTok());
754       Out.EmitBytes(StringRef(S.c_str(), S.length() + 1));
755       return expect(AsmToken::EndOfStatement, "EOL");
756     }
757 
758     return true; // We didn't process this directive.
759   }
760 
761   bool MatchAndEmitInstruction(SMLoc IDLoc, unsigned & /*Opcode*/,
762                                OperandVector &Operands, MCStreamer &Out,
763                                uint64_t &ErrorInfo,
764                                bool MatchingInlineAsm) override {
765     MCInst Inst;
766     Inst.setLoc(IDLoc);
767     unsigned MatchResult =
768         MatchInstructionImpl(Operands, Inst, ErrorInfo, MatchingInlineAsm);
769     switch (MatchResult) {
770     case Match_Success: {
771       if (CurrentState == FunctionStart) {
772         // This is the first instruction in a function, but we haven't seen
773         // a .local directive yet. The streamer requires locals to be encoded
774         // as a prelude to the instructions, so emit an empty list of locals
775         // here.
776         auto &TOut = reinterpret_cast<WebAssemblyTargetStreamer &>(
777             *Out.getTargetStreamer());
778         TOut.emitLocal(SmallVector<wasm::ValType, 0>());
779       }
780       // Fix unknown p2align operands.
781       auto Align = WebAssembly::GetDefaultP2AlignAny(Inst.getOpcode());
782       if (Align != -1U) {
783         auto &Op0 = Inst.getOperand(0);
784         if (Op0.getImm() == -1)
785           Op0.setImm(Align);
786       }
787       Out.EmitInstruction(Inst, getSTI());
788       if (CurrentState == EndFunction) {
789         onEndOfFunction();
790       } else {
791         CurrentState = Instructions;
792       }
793       return false;
794     }
795     case Match_MissingFeature:
796       return Parser.Error(
797           IDLoc, "instruction requires a WASM feature not currently enabled");
798     case Match_MnemonicFail:
799       return Parser.Error(IDLoc, "invalid instruction");
800     case Match_NearMisses:
801       return Parser.Error(IDLoc, "ambiguous instruction");
802     case Match_InvalidTiedOperand:
803     case Match_InvalidOperand: {
804       SMLoc ErrorLoc = IDLoc;
805       if (ErrorInfo != ~0ULL) {
806         if (ErrorInfo >= Operands.size())
807           return Parser.Error(IDLoc, "too few operands for instruction");
808         ErrorLoc = Operands[ErrorInfo]->getStartLoc();
809         if (ErrorLoc == SMLoc())
810           ErrorLoc = IDLoc;
811       }
812       return Parser.Error(ErrorLoc, "invalid operand for instruction");
813     }
814     }
815     llvm_unreachable("Implement any new match types added!");
816   }
817 
818   void doBeforeLabelEmit(MCSymbol *Symbol) override {
819     // Start a new section for the next function automatically, since our
820     // object writer expects each function to have its own section. This way
821     // The user can't forget this "convention".
822     auto SymName = Symbol->getName();
823     if (SymName.startswith(".L"))
824       return; // Local Symbol.
825     // Only create a new text section if we're already in one.
826     auto CWS = cast<MCSectionWasm>(getStreamer().getCurrentSection().first);
827     if (!CWS || !CWS->getKind().isText())
828       return;
829     auto SecName = ".text." + SymName;
830     auto WS = getContext().getWasmSection(SecName, SectionKind::getText());
831     getStreamer().SwitchSection(WS);
832   }
833 
834   void onEndOfFunction() {
835     // Automatically output a .size directive, so it becomes optional for the
836     // user.
837     if (!LastFunctionLabel) return;
838     auto TempSym = getContext().createLinkerPrivateTempSymbol();
839     getStreamer().EmitLabel(TempSym);
840     auto Start = MCSymbolRefExpr::create(LastFunctionLabel, getContext());
841     auto End = MCSymbolRefExpr::create(TempSym, getContext());
842     auto Expr =
843         MCBinaryExpr::create(MCBinaryExpr::Sub, End, Start, getContext());
844     getStreamer().emitELFSize(LastFunctionLabel, Expr);
845   }
846 
847   void onEndOfFile() override { ensureEmptyNestingStack(); }
848 };
849 } // end anonymous namespace
850 
851 // Force static initialization.
852 extern "C" void LLVMInitializeWebAssemblyAsmParser() {
853   RegisterMCAsmParser<WebAssemblyAsmParser> X(getTheWebAssemblyTarget32());
854   RegisterMCAsmParser<WebAssemblyAsmParser> Y(getTheWebAssemblyTarget64());
855 }
856 
857 #define GET_REGISTER_MATCHER
858 #define GET_MATCHER_IMPLEMENTATION
859 #include "WebAssemblyGenAsmMatcher.inc"
860