[llvm] [NFC][TableGen] Adopt CodeGenHelpers in GobalISel emitters (PR #180143)

via llvm-commits llvm-commits at lists.llvm.org
Fri Feb 6 07:50:47 PST 2026


llvmbot wrote:


<!--LLVM PR SUMMARY COMMENT-->

@llvm/pr-subscribers-llvm-globalisel

Author: Rahul Joshi (jurahul)

<details>
<summary>Changes</summary>

Add specific emitters for `#ifdef` and `#ifndef` based guards and adopt them and other CodeGenHelpers in Global ISel emitters.

---
Full diff: https://github.com/llvm/llvm-project/pull/180143.diff


5 Files Affected:

- (modified) llvm/include/llvm/TableGen/CodeGenHelpers.h (+33-8) 
- (modified) llvm/test/TableGen/GlobalISelEmitter/GlobalISelEmitter.td (+6-2) 
- (modified) llvm/test/TableGen/GlobalISelEmitter/HwModes.td (+6-2) 
- (modified) llvm/utils/TableGen/Common/GlobalISel/GlobalISelMatchTableExecutorEmitter.cpp (+20-25) 
- (modified) llvm/utils/TableGen/GlobalISelCombinerEmitter.cpp (+8-8) 


``````````diff
diff --git a/llvm/include/llvm/TableGen/CodeGenHelpers.h b/llvm/include/llvm/TableGen/CodeGenHelpers.h
index e8e4886b0eefa..fef22b3a2d043 100644
--- a/llvm/include/llvm/TableGen/CodeGenHelpers.h
+++ b/llvm/include/llvm/TableGen/CodeGenHelpers.h
@@ -46,23 +46,48 @@ class IfDefEmitter {
   bool LateUndef;
 };
 
-// Simple RAII helper for emitting #if guard. It emits:
-// #if <Condition>
-// #endif // <Condition>
-class IfGuardEmitter {
-public:
-  IfGuardEmitter(raw_ostream &OS, StringRef Condition)
+// Base class for RAII helpers for emitting various if guards.
+class IfGuardEmitterBase {
+protected:
+  IfGuardEmitterBase(raw_ostream &OS, StringRef If, StringRef Condition)
       : Condition(Condition.str()), OS(OS) {
-    OS << "#if " << Condition << "\n\n";
+    OS << If << " " << Condition << "\n\n";
   }
 
-  ~IfGuardEmitter() { OS << "\n#endif // " << Condition << "\n\n"; }
+  ~IfGuardEmitterBase() { OS << "\n#endif // " << Condition << "\n\n"; }
 
 private:
   std::string Condition;
   raw_ostream &OS;
 };
 
+// RAII emitter for:
+// #if <Condition>
+// #endif // <Condition>
+class IfGuardEmitter : private IfGuardEmitterBase {
+public:
+  IfGuardEmitter(raw_ostream &OS, StringRef Condition)
+      : IfGuardEmitterBase(OS, "#if", Condition) {}
+};
+
+// RAII emitter for:
+// #ifdef <Condition>
+// #endif // <Condition>
+class IfDefGuardEmitter : private IfGuardEmitterBase {
+public:
+  IfDefGuardEmitter(raw_ostream &OS, StringRef Condition)
+      : IfGuardEmitterBase(OS, "#ifdef", Condition) {}
+};
+
+// RAII emitter for:
+// #ifndef <Condition>
+// #endif // <Condition>
+class IfNDefGuardEmitter : private IfGuardEmitterBase {
+public:
+  IfNDefGuardEmitter(raw_ostream &OS, StringRef Condition)
+      : IfGuardEmitterBase(OS, "#ifndef", Condition) {}
+};
+
 // Simple RAII helper for emitting header include guard (ifndef-define-endif).
 class IncludeGuardEmitter {
 public:
diff --git a/llvm/test/TableGen/GlobalISelEmitter/GlobalISelEmitter.td b/llvm/test/TableGen/GlobalISelEmitter/GlobalISelEmitter.td
index 9b30760c31aa8..9d386cdc8f05b 100644
--- a/llvm/test/TableGen/GlobalISelEmitter/GlobalISelEmitter.td
+++ b/llvm/test/TableGen/GlobalISelEmitter/GlobalISelEmitter.td
@@ -71,6 +71,7 @@ def HasC : Predicate<"Subtarget->hasC()"> { let RecomputePerFunction = 1; }
 // CHECK: using PredicateBitset = llvm::Bitset<MAX_SUBTARGET_PREDICATES>;
 
 // CHECK-LABEL: #ifdef GET_GLOBALISEL_TEMPORARIES_DECL
+// CHECK-EMPTY:
 // CHECK-NEXT:    mutable MatcherState State;
 // CHECK-NEXT:    typedef ComplexRendererFns(MyTargetInstructionSelector::*ComplexMatcherMemFn)(MachineOperand &) const;
 // CHECK-NEXT:    typedef void(MyTargetInstructionSelector::*CustomRendererFn)(MachineInstrBuilder &, const MachineInstr &, int) const;
@@ -85,12 +86,15 @@ def HasC : Predicate<"Subtarget->hasC()"> { let RecomputePerFunction = 1; }
 // CHECK-NEXT:    bool testMOPredicate_MO(unsigned PredicateID, const MachineOperand &MO, const MatcherState &State) const override;
 // CHECK-NEXT:    bool testSimplePredicate(unsigned PredicateID) const override;
 // CHECK-NEXT:    bool runCustomAction(unsigned FnID, const MatcherState &State, NewMIVector &OutMIs) const override;
-// CHECK-NEXT:  #endif // ifdef GET_GLOBALISEL_TEMPORARIES_DECL
+// CHECK-EMPTY:
+// CHECK-NEXT:  #endif // GET_GLOBALISEL_TEMPORARIES_DECL
 
 // CHECK-LABEL: #ifdef GET_GLOBALISEL_TEMPORARIES_INIT
+// CHECK-EMPTY:
 // CHECK-NEXT:    , State(3),
 // CHECK-NEXT:    ExecInfo(TypeObjects, NumTypeObjects, FeatureBitsets, ComplexPredicateFns, CustomRenderers)
-// CHECK-NEXT:  #endif // ifdef GET_GLOBALISEL_TEMPORARIES_INIT
+// CHECK-EMPTY:
+// CHECK-NEXT:  #endif // GET_GLOBALISEL_TEMPORARIES_INIT
 
 // CHECK-LABEL: // LLT Objects.
 // CHECK-NEXT:  enum {
diff --git a/llvm/test/TableGen/GlobalISelEmitter/HwModes.td b/llvm/test/TableGen/GlobalISelEmitter/HwModes.td
index 56d62ca070889..466f637e86ce1 100644
--- a/llvm/test/TableGen/GlobalISelEmitter/HwModes.td
+++ b/llvm/test/TableGen/GlobalISelEmitter/HwModes.td
@@ -43,6 +43,7 @@ class I<dag OOps, dag IOps, list<dag> Pat>
 // CHECK: using PredicateBitset = llvm::Bitset<MAX_SUBTARGET_PREDICATES>;
 
 // CHECK-LABEL: #ifdef GET_GLOBALISEL_TEMPORARIES_DECL
+// CHECK-EMPTY:
 // CHECK-NEXT:    mutable MatcherState State;
 // CHECK-NEXT:    typedef ComplexRendererFns(MyTargetInstructionSelector::*ComplexMatcherMemFn)(MachineOperand &) const;
 // CHECK-NEXT:    typedef void(MyTargetInstructionSelector::*CustomRendererFn)(MachineInstrBuilder &, const MachineInstr &, int) const;
@@ -57,12 +58,15 @@ class I<dag OOps, dag IOps, list<dag> Pat>
 // CHECK-NEXT:    bool testMOPredicate_MO(unsigned PredicateID, const MachineOperand &MO, const MatcherState &State) const override;
 // CHECK-NEXT:    bool testSimplePredicate(unsigned PredicateID) const override;
 // CHECK-NEXT:    bool runCustomAction(unsigned FnID, const MatcherState &State, NewMIVector &OutMIs) const override;
-// CHECK-NEXT:  #endif // ifdef GET_GLOBALISEL_TEMPORARIES_DECL
+// CHECK-EMPTY:
+// CHECK-NEXT:  #endif // GET_GLOBALISEL_TEMPORARIES_DECL
 
 // CHECK-LABEL: #ifdef GET_GLOBALISEL_TEMPORARIES_INIT
+// CHECK-EMPTY:
 // CHECK-NEXT:    , State(0),
 // CHECK-NEXT:    ExecInfo(TypeObjects, NumTypeObjects, FeatureBitsets, ComplexPredicateFns, CustomRenderers)
-// CHECK-NEXT:  #endif // ifdef GET_GLOBALISEL_TEMPORARIES_INIT
+// CHECK-EMPTY:
+// CHECK-NEXT:  #endif // GET_GLOBALISEL_TEMPORARIES_INIT
 
 // CHECK-LABEL: // LLT Objects.
 // CHECK-NEXT:  enum {
diff --git a/llvm/utils/TableGen/Common/GlobalISel/GlobalISelMatchTableExecutorEmitter.cpp b/llvm/utils/TableGen/Common/GlobalISel/GlobalISelMatchTableExecutorEmitter.cpp
index 333d956a4ff3b..a51cbd26fcaf5 100644
--- a/llvm/utils/TableGen/Common/GlobalISel/GlobalISelMatchTableExecutorEmitter.cpp
+++ b/llvm/utils/TableGen/Common/GlobalISel/GlobalISelMatchTableExecutorEmitter.cpp
@@ -8,6 +8,7 @@
 
 #include "GlobalISelMatchTableExecutorEmitter.h"
 #include "GlobalISelMatchTable.h"
+#include "llvm/TableGen/CodeGenHelpers.h"
 
 using namespace llvm;
 using namespace llvm::gi;
@@ -177,7 +178,7 @@ void GlobalISelMatchTableExecutorEmitter::emitExecutorImpl(
     ArrayRef<RuleMatcher> Rules,
     ArrayRef<const Record *> ComplexOperandMatchers,
     ArrayRef<StringRef> CustomOperandRenderers, StringRef IfDefName) {
-  OS << "#ifdef " << IfDefName << "\n";
+  IfDefGuardEmitter If(OS, IfDefName);
   emitTypeObjects(OS, TypeObjects);
   emitSubtargetFeatureBitsetImpl(OS, Rules);
   emitComplexPredicates(OS, ComplexOperandMatchers);
@@ -192,24 +193,21 @@ void GlobalISelMatchTableExecutorEmitter::emitExecutorImpl(
   emitRunCustomAction(OS);
 
   emitMatchTable(OS, Table);
-
-  OS << "#endif // ifdef " << IfDefName << "\n\n";
 }
 
 void GlobalISelMatchTableExecutorEmitter::emitPredicateBitset(
     raw_ostream &OS, StringRef IfDefName) {
   unsigned Size = SubtargetFeatures.size() + HwModes.size();
-  OS << "#ifdef " << IfDefName << "\n"
-     << "const unsigned MAX_SUBTARGET_PREDICATES = " << Size << ";\n"
+  IfDefGuardEmitter IfDef(OS, IfDefName);
+  OS << "const unsigned MAX_SUBTARGET_PREDICATES = " << Size << ";\n"
      << "using PredicateBitset = "
-        "llvm::Bitset<MAX_SUBTARGET_PREDICATES>;\n"
-     << "#endif // ifdef " << IfDefName << "\n\n";
+        "llvm::Bitset<MAX_SUBTARGET_PREDICATES>;\n";
 }
 
 void GlobalISelMatchTableExecutorEmitter::emitTemporariesDecl(
     raw_ostream &OS, StringRef IfDefName) {
-  OS << "#ifdef " << IfDefName << "\n"
-     << "  mutable MatcherState State;\n"
+  IfDefGuardEmitter If(OS, IfDefName);
+  OS << "  mutable MatcherState State;\n"
      << "  typedef "
         "ComplexRendererFns("
      << getClassName() << "::*ComplexMatcherMemFn)(MachineOperand &) const;\n"
@@ -241,25 +239,24 @@ void GlobalISelMatchTableExecutorEmitter::emitTemporariesDecl(
      << "  bool testSimplePredicate(unsigned PredicateID) const override;\n"
      << "  bool runCustomAction(unsigned FnID, const MatcherState &State, "
         "NewMIVector &OutMIs) "
-        "const override;\n"
-     << "#endif // ifdef " << IfDefName << "\n\n";
+        "const override;\n";
 }
 
 void GlobalISelMatchTableExecutorEmitter::emitTemporariesInit(
     raw_ostream &OS, unsigned MaxTemporaries, StringRef IfDefName) {
-  OS << "#ifdef " << IfDefName << "\n"
-     << ", State(" << MaxTemporaries << "),\n"
-     << "ExecInfo(TypeObjects, NumTypeObjects, FeatureBitsets"
-     << ", ComplexPredicateFns, CustomRenderers)\n"
-     << "#endif // ifdef " << IfDefName << "\n\n";
-
+  {
+    IfDefGuardEmitter If(OS, IfDefName);
+    OS << ", State(" << MaxTemporaries << "),\n"
+       << "ExecInfo(TypeObjects, NumTypeObjects, FeatureBitsets"
+       << ", ComplexPredicateFns, CustomRenderers)\n";
+  }
   emitAdditionalTemporariesInit(OS);
 }
 
 void GlobalISelMatchTableExecutorEmitter::emitPredicatesDecl(
     raw_ostream &OS, StringRef IfDefName) {
-  OS << "#ifdef " << IfDefName << "\n"
-     << "PredicateBitset AvailableModuleFeatures;\n"
+  IfDefGuardEmitter If(OS, IfDefName);
+  OS << "PredicateBitset AvailableModuleFeatures;\n"
      << "mutable PredicateBitset AvailableFunctionFeatures;\n"
      << "PredicateBitset getAvailableFeatures() const {\n"
      << "  return AvailableModuleFeatures | AvailableFunctionFeatures;\n"
@@ -271,14 +268,12 @@ void GlobalISelMatchTableExecutorEmitter::emitPredicatesDecl(
      << "computeAvailableFunctionFeatures(const " << getTarget().getName()
      << "Subtarget *Subtarget,\n"
      << "                                 const MachineFunction *MF) const;\n"
-     << "void setupGeneratedPerFunctionState(MachineFunction &MF) override;\n"
-     << "#endif // ifdef " << IfDefName << "\n";
+     << "void setupGeneratedPerFunctionState(MachineFunction &MF) override;\n";
 }
 
 void GlobalISelMatchTableExecutorEmitter::emitPredicatesInit(
     raw_ostream &OS, StringRef IfDefName) {
-  OS << "#ifdef " << IfDefName << "\n"
-     << "AvailableModuleFeatures(computeAvailableModuleFeatures(&STI)),\n"
-     << "AvailableFunctionFeatures()\n"
-     << "#endif // ifdef " << IfDefName << "\n";
+  IfDefGuardEmitter If(OS, IfDefName);
+  OS << "AvailableModuleFeatures(computeAvailableModuleFeatures(&STI)),\n"
+     << "AvailableFunctionFeatures()\n";
 }
diff --git a/llvm/utils/TableGen/GlobalISelCombinerEmitter.cpp b/llvm/utils/TableGen/GlobalISelCombinerEmitter.cpp
index 50e63a4bdc462..56b39fcd1cc9e 100644
--- a/llvm/utils/TableGen/GlobalISelCombinerEmitter.cpp
+++ b/llvm/utils/TableGen/GlobalISelCombinerEmitter.cpp
@@ -48,6 +48,7 @@
 #include "llvm/Support/Debug.h"
 #include "llvm/Support/PrettyStackTrace.h"
 #include "llvm/Support/ScopedPrinter.h"
+#include "llvm/TableGen/CodeGenHelpers.h"
 #include "llvm/TableGen/Error.h"
 #include "llvm/TableGen/Record.h"
 #include "llvm/TableGen/StringMatcher.h"
@@ -2447,6 +2448,7 @@ class GICombinerEmitter final : public GlobalISelMatchTableExecutorEmitter {
 };
 
 void GICombinerEmitter::emitRuleConfigImpl(raw_ostream &OS) {
+  IfDefGuardEmitter If(OS, "GET_GICOMBINER_TYPES");
   OS << "struct " << getRuleConfigClassName() << " {\n"
      << "  SparseBitVector<> DisabledRules;\n\n"
      << "  bool isRuleEnabled(unsigned RuleID) const;\n"
@@ -2795,18 +2797,16 @@ void GICombinerEmitter::run(raw_ostream &OS) {
     TypeObjects.push_back(LLT::scalar(1));
 
   // GET_GICOMBINER_DEPS, which pulls in extra dependencies.
-  OS << "#ifdef GET_GICOMBINER_DEPS\n"
-     << "#include \"llvm/ADT/SparseBitVector.h\"\n"
-     << "namespace llvm {\n"
-     << "extern cl::OptionCategory GICombinerOptionCategory;\n"
-     << "} // end namespace llvm\n"
-     << "#endif // ifdef GET_GICOMBINER_DEPS\n\n";
+  {
+    IfDefGuardEmitter If(OS, "GET_GICOMBINER_DEPS");
+    OS << "#include \"llvm/ADT/SparseBitVector.h\"\n";
+    NamespaceEmitter LlvmNS(OS, "llvm");
+    OS << "extern cl::OptionCategory GICombinerOptionCategory;\n";
+  }
 
   // GET_GICOMBINER_TYPES, which needs to be included before the declaration of
   // the class.
-  OS << "#ifdef GET_GICOMBINER_TYPES\n";
   emitRuleConfigImpl(OS);
-  OS << "#endif // ifdef GET_GICOMBINER_TYPES\n\n";
   emitPredicateBitset(OS, "GET_GICOMBINER_TYPES");
 
   // GET_GICOMBINER_CLASS_MEMBERS, which need to be included inside the class.

``````````

</details>


https://github.com/llvm/llvm-project/pull/180143


More information about the llvm-commits mailing list