[Asm] Add debug printing for assembler macros

[olista01]

Summary

This adds some debug printing (gated behind the "asm-macros" debug flag) which can help tracing complicated assembly macros.

[SjoerdMeijer]

LGTM

include/llvm/MC/MCAsmMacro.h

 //===- MCAsmMacro.h - Assembly Macros ---------------------------*- C++ -*-===//
 //
 //                     The LLVM Compiler Infrastructure
 //
 // This file is distributed under the University of Illinois Open Source
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 
 #ifndef LLVM_MC_MCASMMACRO_H
 #define LLVM_MC_MCASMMACRO_H
 
 #include "llvm/MC/MCParser/MCAsmLexer.h"
+#include "llvm/Support/Debug.h"
 
 namespace llvm {
 
 struct MCAsmMacroParameter {
   StringRef Name;
   std::vector<AsmToken> Value;
   bool Required = false;
   bool Vararg = false;
 
   MCAsmMacroParameter() = default;
+
+  void dump() const { dump(dbgs()); }
+  void dump(raw_ostream &OS) const;
 };
 
 typedef std::vector<MCAsmMacroParameter> MCAsmMacroParameters;
 struct MCAsmMacro {
   StringRef Name;
   StringRef Body;
   MCAsmMacroParameters Parameters;
 
 public:
   MCAsmMacro(StringRef N, StringRef B, MCAsmMacroParameters P)
       : Name(N), Body(B), Parameters(std::move(P)) {}
+
+  void dump() const { dump(dbgs()); }
+  void dump(raw_ostream &OS) const;
 };
 } // namespace llvm
 
 #endif

include/llvm/MC/MCContext.h

LLVM_ATTRIBUTE_NORETURN void reportFatalError(SMLoc L,
                                                   const Twine &Msg);
 
     const MCAsmMacro *lookupMacro(StringRef Name) {
       StringMap<MCAsmMacro>::iterator I = MacroMap.find(Name);
       return (I == MacroMap.end()) ? nullptr : &I->getValue();
     }
 
     void defineMacro(StringRef Name, MCAsmMacro Macro) {
+      DEBUG_WITH_TYPE("asm-macros", dbgs() << "Defining new macro:\n";
+                      Macro.dump());
       MacroMap.insert(std::make_pair(Name, std::move(Macro)));
     }
 
-    void undefineMacro(StringRef Name) { MacroMap.erase(Name); }
+    void undefineMacro(StringRef Name) {
+      if (MacroMap.erase(Name)) {
+        DEBUG_WITH_TYPE("asm-macros",
+                        dbgs() << "Un-defining macro: " << Name << "\n");
+      }
+    }
   };
 
 } // end namespace llvm
 
 // operator new and delete aren't allowed inside namespaces.
 // The throw specifications are mandated by the standard.
 /// \brief Placement new for using the MCContext's allocator.
 ///

lib/MC/CMakeLists.txt

 add_llvm_library(LLVMMC
   ConstantPools.cpp
   ELFObjectWriter.cpp
   MCAsmBackend.cpp
   MCAsmInfo.cpp
   MCAsmInfoCOFF.cpp
   MCAsmInfoDarwin.cpp
   MCAsmInfoELF.cpp
   MCAsmInfoWasm.cpp
+  MCAsmMacro.cpp
   MCAsmStreamer.cpp
   MCAssembler.cpp
   MCCodeEmitter.cpp
   MCCodePadder.cpp
   MCCodeView.cpp
   MCContext.cpp
   MCDwarf.cpp
   MCELFObjectTargetWriter.cpp

lib/MC/MCAsmMacro.cpp

+//===- MCAsmMacro.h - Assembly Macros ---------------------------*- C++ -*-===//
+//
+//                     The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+
+#include "llvm/MC/MCAsmMacro.h"
+#include "llvm/Support/raw_ostream.h"
+
+using namespace llvm;
+
+void MCAsmMacroParameter::dump(raw_ostream &OS) const {
+  OS << "\"" << Name << "\"";
+  if (Required)
+    OS << ":req";
+  if (Vararg)
+    OS << ":vararg";
+  if (!Value.empty()) {
+    OS << " = ";
+    bool first = true;
+    for (const AsmToken &T : Value) {
+      if (!first)
+        OS << ", ";
+      first = false;
+      T.dump();
+    }
+  }
+  OS << "\n";
+}
+
+void MCAsmMacro::dump(raw_ostream &OS) const {
+  OS << "Macro " << Name << ":\n";
+  OS << "  Parameters:\n";
+  for (const MCAsmMacroParameter &P : Parameters) {
+    OS << "    ";
+    P.dump();
+  }
+  OS << "  (BEGIN BODY)" << Body << "(END BODY)\n";
+}