[MC] Add the ability to pass MCRegisterInfo to dump_pretty

[hgreving]

Summary

Adds the ability to pass MCRegisterInfo to dump_pretty and to the print functions,
so that if present, target specific enum names are printed instead of enum values.

[majnemer]

LGTM

llvm/include/llvm/MC/MCInst.h

 #include <cstddef>
 #include <cstdint>
 
 namespace llvm {
 
 class MCExpr;
 class MCInst;
 class MCInstPrinter;
+class MCRegisterInfo;
 class raw_ostream;
 
 /// Instances of this class represent operands of the MCInst class.
 /// This is a simple discriminated union.
 class MCOperand {
   enum MachineOperandType : unsigned char {
     kInvalid,      ///< Uninitialized.
     kRegister,     ///< Register operand.
public:
 
   static MCOperand createInst(const MCInst *Val) {
     MCOperand Op;
     Op.Kind = kInst;
     Op.InstVal = Val;
     return Op;
   }
 
-  void print(raw_ostream &OS) const;
+  void print(raw_ostream &OS, const MCRegisterInfo *RegInfo = nullptr) const;
   void dump() const;
   bool isBareSymbolRef() const;
   bool evaluateAsConstantImm(int64_t &Imm) const;
 };
 
 /// Instances of this class represent a single low-level machine
 /// instruction.
 class MCInst {
public:
   const_iterator begin() const { return Operands.begin(); }
   iterator end() { return Operands.end(); }
   const_iterator end() const { return Operands.end(); }
 
   iterator insert(iterator I, const MCOperand &Op) {
     return Operands.insert(I, Op);
   }
 
-  void print(raw_ostream &OS) const;
+  void print(raw_ostream &OS, const MCRegisterInfo *RegInfo = nullptr) const;
   void dump() const;
 
   /// Dump the MCInst as prettily as possible using the additional MC
   /// structures, if given. Operators are separated by the \p Separator
   /// string.
   void dump_pretty(raw_ostream &OS, const MCInstPrinter *Printer = nullptr,
-                   StringRef Separator = " ") const;
-  void dump_pretty(raw_ostream &OS, StringRef Name,
-                   StringRef Separator = " ") const;
+                   StringRef Separator = " ",
+                   const MCRegisterInfo *RegInfo = nullptr) const;
+  void dump_pretty(raw_ostream &OS, StringRef Name, StringRef Separator = " ",
+                   const MCRegisterInfo *RegInfo = nullptr) const;
 };
 
 inline raw_ostream& operator<<(raw_ostream &OS, const MCOperand &MO) {
   MO.print(OS);
   return OS;
 }
 
 inline raw_ostream& operator<<(raw_ostream &OS, const MCInst &MI) {
   MI.print(OS);
   return OS;
 }
 
 } // end namespace llvm
 
 #endif // LLVM_MC_MCINST_H

llvm/lib/MC/MCInst.cpp

 //===- lib/MC/MCInst.cpp - MCInst implementation --------------------------===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
 
 #include "llvm/MC/MCInst.h"
 #include "llvm/Config/llvm-config.h"
 #include "llvm/MC/MCExpr.h"
 #include "llvm/MC/MCInstPrinter.h"
+#include "llvm/MC/MCRegisterInfo.h"
 #include "llvm/Support/Casting.h"
 #include "llvm/Support/Compiler.h"
 #include "llvm/Support/Debug.h"
 #include "llvm/Support/raw_ostream.h"
 
 using namespace llvm;
 
-void MCOperand::print(raw_ostream &OS) const {
+void MCOperand::print(raw_ostream &OS, const MCRegisterInfo *RegInfo) const {
   OS << "<MCOperand ";
   if (!isValid())
     OS << "INVALID";
-  else if (isReg())
-    OS << "Reg:" << getReg();
-  else if (isImm())
+  else if (isReg()) {
+    OS << "Reg:";
+    if (RegInfo)
+      OS << RegInfo->getName(getReg());
+    else
+      OS << getReg();
+  } else if (isImm())
     OS << "Imm:" << getImm();
   else if (isSFPImm())
     OS << "SFPImm:" << bit_cast<float>(getSFPImm());
   else if (isDFPImm())
     OS << "DFPImm:" << bit_cast<double>(getDFPImm());
   else if (isExpr()) {
     OS << "Expr:(" << *getExpr() << ")";
   } else if (isInst()) {
-    OS << "Inst:(" << *getInst() << ")";
+    OS << "Inst:(";
+    getInst()->print(OS, RegInfo);
+    OS << ")";
   } else
     OS << "UNDEFINED";
   OS << ">";
 }
 
 bool MCOperand::evaluateAsConstantImm(int64_t &Imm) const {
   if (isImm()) {
     Imm = getImm();

 
 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
 LLVM_DUMP_METHOD void MCOperand::dump() const {
   print(dbgs());
   dbgs() << "\n";
 }
 #endif
 
-void MCInst::print(raw_ostream &OS) const {
+void MCInst::print(raw_ostream &OS, const MCRegisterInfo *RegInfo) const {
   OS << "<MCInst " << getOpcode();
   for (unsigned i = 0, e = getNumOperands(); i != e; ++i) {
     OS << " ";
-    getOperand(i).print(OS);
+    getOperand(i).print(OS, RegInfo);
   }
   OS << ">";
 }
 
 void MCInst::dump_pretty(raw_ostream &OS, const MCInstPrinter *Printer,
-                         StringRef Separator) const {
+                         StringRef Separator,
+                         const MCRegisterInfo *RegInfo) const {
   StringRef InstName = Printer ? Printer->getOpcodeName(getOpcode()) : "";
-  dump_pretty(OS, InstName, Separator);
+  dump_pretty(OS, InstName, Separator, RegInfo);
 }
 
-void MCInst::dump_pretty(raw_ostream &OS, StringRef Name,
-                         StringRef Separator) const {
+void MCInst::dump_pretty(raw_ostream &OS, StringRef Name, StringRef Separator,
+                         const MCRegisterInfo *RegInfo) const {
   OS << "<MCInst #" << getOpcode();
 
   // Show the instruction opcode name if we have it.
   if (!Name.empty())
     OS << ' ' << Name;
 
   for (unsigned i = 0, e = getNumOperands(); i != e; ++i) {
     OS << Separator;
-    getOperand(i).print(OS);
+    getOperand(i).print(OS, RegInfo);
   }
   OS << ">";
 }
 
 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
 LLVM_DUMP_METHOD void MCInst::dump() const {
   print(dbgs());
   dbgs() << "\n";
 }
 #endif