[M68k] Factoring out memory operand printer into a separate file

[myhsu]

Summary

In order to support inline asm with memory constraints, AsmPrinter::PrintAsmMemOperand needs to be implemented, which has lots of overlaps with MCInstPrinter especially on the format of complex addressing modes. This patch factors out the common printing logics from MCInstPrinter into a separate class inherited by both AsmPrinter and MCInstPrinter, in which the derived classes only need to provide primitives like printOperand and printDisp.

This change is basically NFC. See D143529 for changes on AsmPrinter

[0x59616e]

LGTM. Thanks

llvm/lib/Target/M68k/MCTargetDesc/M68kInstPrinter.h

 //===-- M68kInstPrinter.h - Convert M68k MCInst to asm ----------*- C++ -*-===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
 ///
 /// \file
 /// This file contains declarations for an M68k MCInst printer.
 ///
 //===----------------------------------------------------------------------===//
 
 #ifndef LLVM_LIB_TARGET_M68K_INSTPRINTER_M68KINSTPRINTER_H
 #define LLVM_LIB_TARGET_M68K_INSTPRINTER_M68KINSTPRINTER_H
 
+#include "M68kMemOperandPrinter.h"
 #include "llvm/MC/MCInstPrinter.h"
 
 namespace llvm {
 
 class TargetMachine;
 
-class M68kInstPrinter : public MCInstPrinter {
+class M68kInstPrinter : public MCInstPrinter,
+                        public M68kMemOperandPrinter<M68kInstPrinter, MCInst> {
+  friend class M68kMemOperandPrinter;
+
 public:
   M68kInstPrinter(const MCAsmInfo &MAI, const MCInstrInfo &MII,
                   const MCRegisterInfo &MRI)
       : MCInstPrinter(MAI, MII, MRI) {}
 
   // Autogenerated by tblgen.
   void printInstruction(const MCInst *MI, uint64_t Address, raw_ostream &O);
   static const char *getRegisterName(MCRegister Reg);

 private:
   void printOperand(const MCInst *MI, unsigned opNum, raw_ostream &O);
   void printImmediate(const MCInst *MI, unsigned opNum, raw_ostream &O);
   /// Print register mask for MOVEM instruction in order D0-D7,A0-A7
   void printMoveMask(const MCInst *MI, unsigned opNum, raw_ostream &O);
   /// Print register mask for MOVEM instruction in order A7-A0,D7-D0
   void printMoveMaskR(const MCInst *MI, unsigned opNum, raw_ostream &O);
   void printDisp(const MCInst *MI, unsigned opNum, raw_ostream &O);
-  void printARIMem(const MCInst *MI, unsigned opNum, raw_ostream &O);
-  void printARIPIMem(const MCInst *MI, unsigned opNum, raw_ostream &O);
-  void printARIPDMem(const MCInst *MI, unsigned opNum, raw_ostream &O);
-  void printARIDMem(const MCInst *MI, unsigned opNum, raw_ostream &O);
-  void printARIIMem(const MCInst *MI, unsigned opNum, raw_ostream &O);
   void printAbsMem(const MCInst *MI, unsigned opNum, raw_ostream &O);
-  void printPCDMem(const MCInst *MI, uint64_t Address, unsigned opNum,
-                   raw_ostream &O);
-  void printPCIMem(const MCInst *MI, uint64_t Address, unsigned opNum,
-                   raw_ostream &O);
 
   //===----------------------------------------------------------------------===//
   // Specializations
   //===----------------------------------------------------------------------===//
   //
   void printPCRelImm(const MCInst *MI, uint64_t Address, unsigned opNum,
                      raw_ostream &O) {
     printAbsMem(MI, opNum, O);

llvm/lib/Target/M68k/MCTargetDesc/M68kInstPrinter.cpp

void M68kInstPrinter::printDisp(const MCInst *MI, unsigned opNum,
   if (Op.isImm()) {
     O << Op.getImm();
     return;
   }
   assert(Op.isExpr() && "Unknown operand kind in printOperand");
   Op.getExpr()->print(O, &MAI);
 }
 
-void M68kInstPrinter::printARIMem(const MCInst *MI, unsigned opNum,
-                                  raw_ostream &O) {
-  O << '(';
-  printOperand(MI, opNum, O);
-  O << ')';
-}
-
-void M68kInstPrinter::printARIPIMem(const MCInst *MI, unsigned opNum,
-                                    raw_ostream &O) {
-  O << "(";
-  printOperand(MI, opNum, O);
-  O << ")+";
-}
-
-void M68kInstPrinter::printARIPDMem(const MCInst *MI, unsigned opNum,
-                                    raw_ostream &O) {
-  O << "-(";
-  printOperand(MI, opNum, O);
-  O << ")";
-}
-
-void M68kInstPrinter::printARIDMem(const MCInst *MI, unsigned opNum,
-                                   raw_ostream &O) {
-  O << '(';
-  printDisp(MI, opNum + M68k::MemDisp, O);
-  O << ',';
-  printOperand(MI, opNum + M68k::MemBase, O);
-  O << ')';
-}
-
-void M68kInstPrinter::printARIIMem(const MCInst *MI, unsigned opNum,
-                                   raw_ostream &O) {
-  O << '(';
-  printDisp(MI, opNum + M68k::MemDisp, O);
-  O << ',';
-  printOperand(MI, opNum + M68k::MemBase, O);
-  O << ',';
-  printOperand(MI, opNum + M68k::MemIndex, O);
-  O << ')';
-}
-
 // NOTE forcing (W,L) size available since M68020 only
 void M68kInstPrinter::printAbsMem(const MCInst *MI, unsigned opNum,
                                   raw_ostream &O) {
   const MCOperand &MO = MI->getOperand(opNum);
 
   if (MO.isExpr()) {
     MO.getExpr()->print(O, &MAI);
     return;
   }
 
   assert(MO.isImm() && "absolute memory addressing needs an immediate");
   O << format("$%0" PRIx64, (uint64_t)MO.getImm());
 }
-
-void M68kInstPrinter::printPCDMem(const MCInst *MI, uint64_t Address,
-                                  unsigned opNum, raw_ostream &O) {
-  O << '(';
-  printDisp(MI, opNum + M68k::PCRelDisp, O);
-  O << ",%pc)";
-}
-
-void M68kInstPrinter::printPCIMem(const MCInst *MI, uint64_t Address,
-                                  unsigned opNum, raw_ostream &O) {
-  O << '(';
-  printDisp(MI, opNum + M68k::PCRelDisp, O);
-  O << ",%pc,";
-  printOperand(MI, opNum + M68k::PCRelIndex, O);
-  O << ')';
-}

llvm/lib/Target/M68k/MCTargetDesc/M68kMemOperandPrinter.h

+//===-- M68kMemOperandPrinter.h - Memory operands printing ------*- C++ -*-===//
+//
+// 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
+//
+//===----------------------------------------------------------------------===//
+///
+/// \file
+/// This file contains memory operand printing logics shared between AsmPrinter
+//  and MCInstPrinter.
+///
+//===----------------------------------------------------------------------===//
+
+#ifndef LLVM_LIB_TARGET_M68K_MEMOPERANDPRINTER_M68KINSTPRINTER_H
+#define LLVM_LIB_TARGET_M68K_MEMOPERANDPRINTER_M68KINSTPRINTER_H
+
+#include "M68kBaseInfo.h"
+
+#include "llvm/Support/raw_ostream.h"
+
+namespace llvm {
+template <class Derived, typename InstTy> class M68kMemOperandPrinter {
+  Derived &impl() { return *static_cast<Derived *>(this); }
+
+protected:
+  void printARIMem(const InstTy *MI, unsigned OpNum, raw_ostream &O) {
+    O << '(';
+    impl().printOperand(MI, OpNum, O);
+    O << ')';
+  }
+
+  void printARIPIMem(const InstTy *MI, unsigned OpNum, raw_ostream &O) {
+    O << "(";
+    impl().printOperand(MI, OpNum, O);
+    O << ")+";
+  }
+
+  void printARIPDMem(const InstTy *MI, unsigned OpNum, raw_ostream &O) {
+    O << "-(";
+    impl().printOperand(MI, OpNum, O);
+    O << ")";
+  }
+
+  void printARIDMem(const InstTy *MI, unsigned OpNum, raw_ostream &O) {
+    O << '(';
+    impl().printDisp(MI, OpNum + M68k::MemDisp, O);
+    O << ',';
+    impl().printOperand(MI, OpNum + M68k::MemBase, O);
+    O << ')';
+  }
+
+  void printARIIMem(const InstTy *MI, unsigned OpNum, raw_ostream &O) {
+    O << '(';
+    impl().printDisp(MI, OpNum + M68k::MemDisp, O);
+    O << ',';
+    impl().printOperand(MI, OpNum + M68k::MemBase, O);
+    O << ',';
+    impl().printOperand(MI, OpNum + M68k::MemIndex, O);
+    O << ')';
+  }
+
+  void printPCDMem(const InstTy *MI, uint64_t Address, unsigned OpNum,
+                   raw_ostream &O) {
+    O << '(';
+    impl().printDisp(MI, OpNum + M68k::PCRelDisp, O);
+    O << ",%pc)";
+  }
+
+  void printPCIMem(const InstTy *MI, uint64_t Address, unsigned OpNum,
+                   raw_ostream &O) {
+    O << '(';
+    impl().printDisp(MI, OpNum + M68k::PCRelDisp, O);
+    O << ",%pc,";
+    impl().printOperand(MI, OpNum + M68k::PCRelIndex, O);
+    O << ')';
+  }
+};
+} // end namespace llvm
+#endif