[WebAssembly][NFC] Document stackifier tablegen backend

[tlively]

Summary

Add comments to help readers avoid having to read tablegen backends to
understand the code. Also remove unecessary breaks from the output.

[dschuff]

otherwise LGTM

utils/TableGen/WebAssemblyStackifierEmitter.cpp

23 ↗

(On Diff #162911)

one concrete example would probably still be useful.

[tlively]

• Add concrete example

llvm/trunk/lib/Target/WebAssembly/WebAssemblyMCInstLower.cpp

if (MO.isReg()) {
       OutMI.erase(&MO);
     }
   }
 }
 
 static unsigned regInstructionToStackInstruction(unsigned OpCode) {
   // For most opcodes, this function could have been implemented as "return
   // OpCode + 1", but since table-gen alphabetically sorts them, this cannot be
-  // guaranteed (see e.g. BR and BR_IF), so we table-gen a giant switch
-  // statement instead.
+  // guaranteed (see e.g. BR and BR_IF). Instead we use a giant switch statement
+  // generated by a custom TableGen backend (WebAssemblyStackifierEmitter.cpp)
+  // that emits switch cases of the form
+  //
+  //   case WebAssembly::RegisterInstr: return WebAssembly::StackInstr;
+  //
+  // for every pair of equivalent register and stack instructions.
   switch (OpCode) {
   default:
     llvm_unreachable(
           "unknown WebAssembly instruction in Explicit Locals pass");
 #include "WebAssemblyGenStackifier.inc"
   }
 }

llvm/trunk/utils/TableGen/WebAssemblyStackifierEmitter.cpp

 //
 //===----------------------------------------------------------------------===//
 
 #include "WebAssemblyDisassemblerEmitter.h"
 #include "llvm/TableGen/Record.h"
 
 namespace llvm {
 
+// Find all register WebAssembly instructions and their corresponding stack
+// instructions. For each pair, emit a switch case of the form
+//
+//   case WebAssembly::RegisterInstr: return WebAssembly::StackInstr;
+//
+// For example,
+//
+//   case WebAssembly::ADD_I32: return WebAssembly::ADD_I32_S;
+//
+// This is useful for converting instructions from their register form to their
+// equivalent stack form.
 void EmitWebAssemblyStackifier(RecordKeeper &RK, raw_ostream &OS) {
   Record *InstrClass = RK.getClass("WebAssemblyInst");
   for (auto &RecordPair : RK.getDefs()) {
     if (!RecordPair.second->isSubClassOf(InstrClass))
       continue;
     bool IsStackBased = RecordPair.second->getValueAsBit("StackBased");
     if (IsStackBased)
       continue;
     OS << "  case WebAssembly::" << RecordPair.first << ": return "
-       << "WebAssembly::" << RecordPair.first << "_S; break;\n";
+       << "WebAssembly::" << RecordPair.first << "_S;\n";
   }
 }
 
 } // namespace llvm