[SystemZ] Implement SystemZOperand::print()

[jonpa]

Summary

I tried compiling a file with "-mllvm -debug", and found that this caused a crash, since there was an unimplemented function in SystemZAsmParser.

I have tried to implement this to make a readable output which basically means trying to print the values of the operands by casting them to the right MCExpr subclass.

I tried to print register names but did not find a trivial way to get the MachineRegisterInfo. Now register integer values are printed instead.

[uweigand]

I tried to print register names but did not find a trivial way to get the MachineRegisterInfo. Now register integer values are printed instead.

You should be using SystemZInstPrinter::getRegisterName, see e.g. how X86Operand::print is implemented.

Also, I think it should be straightforward to also print memory operands correctly.

[jonpa]

OK - now also print registers by name and memory operands.

• Copied the output style from X86, with 'Imm:', 'Reg:', etc.
• Could not think of an instruction with a ImmTLS with a non-null Sym for the test.
• Removed the printing of '?' I tried before and instead print nothing. I found it confusing...

[jonpa]

Fix whitespace errors in test case.

[uweigand]

See inline comment. Otherwise LGTM.

lib/Target/SystemZ/AsmParser/SystemZAsmParser.cpp

680

Index should also be printed *before* the base.

test/MC/SystemZ/asm-match.s

31

Should be r2, r3 ... see above

[jonpa]

Thanks for review.
Committed as r345349.

test/MC/SystemZ/asm-match.s

31

Oops...

lib/Target/SystemZ/AsmParser/SystemZAsmParser.cpp

const MCExpr *getImm() const {
     return Imm;
   }
 
   // Immediate operands with optional TLS symbol.
   bool isImmTLS() const {
     return Kind == KindImmTLS;
   }
 
+  const ImmTLSOp getImmTLS() const {
+    assert(Kind == KindImmTLS && "Not a TLS immediate");
+    return ImmTLS;
+  }
+
   // Memory operands.
   bool isMem() const override {
     return Kind == KindMem;
   }
   bool isMem(MemoryKind MemKind) const {
     return (Kind == KindMem &&
             (Mem.MemKind == MemKind ||
              // A BDMem can be treated as a BDXMem in which the index
static struct InsnMatchEntry InsnMatchTable[] = {
   { "ss", SystemZ::InsnSS, 4,
     { MCK_U48Imm, MCK_BDXAddr64Disp12, MCK_BDAddr64Disp12, MCK_AnyReg } },
   { "sse", SystemZ::InsnSSE, 3,
     { MCK_U48Imm, MCK_BDAddr64Disp12, MCK_BDAddr64Disp12 } },
   { "ssf", SystemZ::InsnSSF, 4,
     { MCK_U48Imm, MCK_BDAddr64Disp12, MCK_BDAddr64Disp12, MCK_AnyReg } }
 };
 
+static void printMCExpr(const MCExpr *E, raw_ostream &OS) {
+  if (!E) {
+    OS << "?";
+    return;
+  }
+  if (auto *CE = dyn_cast<MCConstantExpr>(E))
+    OS << "'" << *CE << "'";
+  else if (auto *UE = dyn_cast<MCUnaryExpr>(E))
+    OS << "'" << *UE << "'";
+  else if (auto *BE = dyn_cast<MCBinaryExpr>(E))
+    OS << "'" << *BE << "'";
+  else if (auto *SRE = dyn_cast<MCSymbolRefExpr>(E))
+    OS << "'" << *SRE << "'";
+  else
+    OS << "'" << *E << "'";
+}
+
 void SystemZOperand::print(raw_ostream &OS) const {
-  llvm_unreachable("Not implemented");
+  switch (Kind) {
+    break;
+  case KindToken:
+    OS << "'" << getToken() << "'";
+    break;
+  case KindReg:
+    OS << "'" << getReg() << "'";
+    break;
+  case KindImm:
+    printMCExpr(getImm(), OS);
+    break;
+  case KindImmTLS:
+    printMCExpr(getImmTLS().Imm, OS);
+    OS << ", ";
+    printMCExpr(getImmTLS().Sym, OS);
+    break;
+  default:
+  case KindMem:
+  case KindInvalid:
+    OS << "?";
+    break;
+  }
 }
 
 // Parse one register of the form %<prefix><number>.
 bool SystemZAsmParser::parseRegister(Register &Reg) {
   Reg.StartLoc = Parser.getTok().getLoc();
 
   // Eat the % prefix.
   if (Parser.getTok().isNot(AsmToken::Percent))
     return Error(Parser.getTok().getLoc(), "register expected");
   Parser.Lex();
 
   // Expect a register name.
   if (Parser.getTok().isNot(AsmToken::Identifier))
     return Error(Reg.StartLoc, "invalid register");
 
   // Check that there's a prefix.
   StringRef Name = Parser.getTok().getString();
   if (Name.size() < 2)

test/MC/SystemZ/asm-match.s

+// REQUIRES: asserts
+// RUN: llvm-mc -triple s390x-linux-gnu -debug-only=asm-matcher %s 2>&1 | FileCheck %s
+//
+// Check that debug output gives some reasonable output.
+
+// CHECK: AsmMatcher:      found 1 encodings with mnemonic 'llill'
+// CHECK:   Trying to match opcode LLILL
+// CHECK:   Matching formal operand class MCK_GR64 against actual operand at index 1 ('138'): match success using generic matcher
+// CHECK:   Matching formal operand class MCK_U16Imm against actual operand at index 2 (0): match success using generic matcher
+// CHECK:   Matching formal operand class InvalidMatchClass against actual operand at index 3: actual operand index out of range Opcode result: complete match, selecting this opcode
+// CHECK: AsmMatcher:      found 1 encodings with mnemonic 'lgr'
+// CHECK:   Trying to match opcode LGR
+// CHECK:   Matching formal operand class MCK_GR64 against actual operand at index 1 ('139'): match success using generic matcher
+// CHECK:   Matching formal operand class MCK_GR64 against actual operand at index 2 ('138'): match success using generic matcher
+// CHECK:   Matching formal operand class InvalidMatchClass against actual operand at index 3: actual operand index out of range Opcode result: complete match, selecting this opcode
+// CHECK: AsmMatcher:      found 1 encodings with mnemonic 'j'
+// CHECK:   Trying to match opcode J
+// CHECK:    Matching formal operand class MCK_PCRel16 against actual operand at index 1 (.Ltmp0+2): match success using generic matcher
+// CHECK:   Matching formal operand class InvalidMatchClass against actual operand at index 2: actual operand index out of range Opcode result: complete match, selecting this opcode
+  
+.Ltmp0:
+  llill %r0, 0
+  lgr %r1, %r0
+  j .Ltmp0+2
+        stmg    %r13, %r15, 104(%r15)
+        brasl   %r14, fun
+