[Pass] Add hyphen to some pass names #74287

paperchalice · 2023-12-04T07:53:12Z

Here is the list of the renamed passes:

callbrprepare -> callbr-prepare
dwarfehprepare -> dwarf-eh-prepare
flattencfg -> flatten-cfg
loweratomic -> lower-atomic
lowerinvoke -> lower-invoke
lowerswitch -> lower-switch
winehprepare -> win-eh-prepare
targetir -> target-ir
targetlibinfo -> target-lib-info

Legacy passes are not affected.

llvmbot · 2023-12-04T07:53:39Z

@llvm/pr-subscribers-lld-elf
@llvm/pr-subscribers-llvm-transforms
@llvm/pr-subscribers-lto
@llvm/pr-subscribers-backend-x86
@llvm/pr-subscribers-debuginfo

@llvm/pr-subscribers-backend-aarch64

Author: None (paperchalice)

Changes

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

12 Files Affected:

(modified) llvm/include/llvm/CodeGen/MachinePassRegistry.def (+2-2)
(modified) llvm/lib/CodeGen/CallBrPrepare.cpp (+1-1)
(modified) llvm/lib/CodeGen/DwarfEHPrepare.cpp (+1-1)
(modified) llvm/lib/Passes/PassRegistry.def (+2-2)
(modified) llvm/test/CodeGen/AArch64/callbr-asm-outputs-indirect-isel.ll (+1-1)
(modified) llvm/test/CodeGen/AArch64/callbr-prepare.ll (+2-2)
(modified) llvm/test/CodeGen/Generic/opt-codegen-no-target-machine.ll (+1-1)
(modified) llvm/test/CodeGen/Mips/compactbranches/beqc-bnec-register-constraint.ll (+2-2)
(modified) llvm/test/CodeGen/X86/dwarf-eh-prepare-dbg.ll (+2-2)
(modified) llvm/test/CodeGen/X86/dwarf-eh-prepare.ll (+2-2)
(modified) llvm/test/CodeGen/X86/dwarf_eh_resume.ll (+2-2)
(modified) llvm/tools/opt/opt.cpp (+1-1)

diff --git a/llvm/include/llvm/CodeGen/MachinePassRegistry.def b/llvm/include/llvm/CodeGen/MachinePassRegistry.def
index fc2d07fd6616f..40b84e910fa64 100644
--- a/llvm/include/llvm/CodeGen/MachinePassRegistry.def
+++ b/llvm/include/llvm/CodeGen/MachinePassRegistry.def
@@ -36,7 +36,7 @@ FUNCTION_ANALYSIS("targetir", TargetIRAnalysis,
 #ifndef FUNCTION_PASS
 #define FUNCTION_PASS(NAME, PASS_NAME, CONSTRUCTOR)
 #endif
-FUNCTION_PASS("callbrprepare", CallBrPreparePass, ())
+FUNCTION_PASS("callbr-prepare", CallBrPreparePass, ())
 FUNCTION_PASS("consthoist", ConstantHoistingPass, ())
 FUNCTION_PASS("ee-instrument", EntryExitInstrumenterPass, (false))
 FUNCTION_PASS("expand-large-div-rem", ExpandLargeDivRemPass, ())
@@ -120,7 +120,7 @@ DUMMY_FUNCTION_PASS("atomic-expand", AtomicExpandPass, ())
 DUMMY_FUNCTION_PASS("cfguard-check", CFGuardCheckPass, ())
 DUMMY_FUNCTION_PASS("cfguard-dispatch", CFGuardDispatchPass, ())
 DUMMY_FUNCTION_PASS("codegenprepare", CodeGenPreparePass, ())
-DUMMY_FUNCTION_PASS("dwarfehprepare", DwarfEHPass, ())
+DUMMY_FUNCTION_PASS("dwarf-eh-prepare", DwarfEHPass, ())
 DUMMY_FUNCTION_PASS("expandmemcmp", ExpandMemCmpPass, ())
 DUMMY_FUNCTION_PASS("gc-info-printer", GCInfoPrinterPass, ())
 DUMMY_FUNCTION_PASS("gc-lowering", GCLoweringPass, ())
diff --git a/llvm/lib/CodeGen/CallBrPrepare.cpp b/llvm/lib/CodeGen/CallBrPrepare.cpp
index fddc4d74b2da9..ab896329f9131 100644
--- a/llvm/lib/CodeGen/CallBrPrepare.cpp
+++ b/llvm/lib/CodeGen/CallBrPrepare.cpp
@@ -52,7 +52,7 @@
 
 using namespace llvm;
 
-#define DEBUG_TYPE "callbrprepare"
+#define DEBUG_TYPE "callbr-prepare"
 
 static bool SplitCriticalEdges(ArrayRef<CallBrInst *> CBRs, DominatorTree &DT);
 static bool InsertIntrinsicCalls(ArrayRef<CallBrInst *> CBRs,
diff --git a/llvm/lib/CodeGen/DwarfEHPrepare.cpp b/llvm/lib/CodeGen/DwarfEHPrepare.cpp
index a44aaf33c6a49..e7eb34d8e6518 100644
--- a/llvm/lib/CodeGen/DwarfEHPrepare.cpp
+++ b/llvm/lib/CodeGen/DwarfEHPrepare.cpp
@@ -42,7 +42,7 @@
 
 using namespace llvm;
 
-#define DEBUG_TYPE "dwarfehprepare"
+#define DEBUG_TYPE "dwarf-eh-prepare"
 
 STATISTIC(NumResumesLowered, "Number of resume calls lowered");
 STATISTIC(NumCleanupLandingPadsUnreachable,
diff --git a/llvm/lib/Passes/PassRegistry.def b/llvm/lib/Passes/PassRegistry.def
index e23863a235a16..e70bba931f820 100644
--- a/llvm/lib/Passes/PassRegistry.def
+++ b/llvm/lib/Passes/PassRegistry.def
@@ -282,7 +282,7 @@ FUNCTION_PASS("assume-simplify", AssumeSimplifyPass())
 FUNCTION_PASS("bdce", BDCEPass())
 FUNCTION_PASS("bounds-checking", BoundsCheckingPass())
 FUNCTION_PASS("break-crit-edges", BreakCriticalEdgesPass())
-FUNCTION_PASS("callbrprepare", CallBrPreparePass())
+FUNCTION_PASS("callbr-prepare", CallBrPreparePass())
 FUNCTION_PASS("callsite-splitting", CallSiteSplittingPass())
 FUNCTION_PASS("chr", ControlHeightReductionPass())
 FUNCTION_PASS("consthoist", ConstantHoistingPass())
@@ -301,7 +301,7 @@ FUNCTION_PASS("dot-dom-only", DomOnlyPrinter())
 FUNCTION_PASS("dot-post-dom", PostDomPrinter())
 FUNCTION_PASS("dot-post-dom-only", PostDomOnlyPrinter())
 FUNCTION_PASS("dse", DSEPass())
-FUNCTION_PASS("dwarfehprepare", DwarfEHPreparePass(TM))
+FUNCTION_PASS("dwarf-eh-prepare", DwarfEHPreparePass(TM))
 FUNCTION_PASS("expand-large-div-rem", ExpandLargeDivRemPass(TM))
 FUNCTION_PASS("expand-large-fp-convert", ExpandLargeFpConvertPass(TM))
 FUNCTION_PASS("fix-irreducible", FixIrreduciblePass())
diff --git a/llvm/test/CodeGen/AArch64/callbr-asm-outputs-indirect-isel.ll b/llvm/test/CodeGen/AArch64/callbr-asm-outputs-indirect-isel.ll
index 89745f4df4cde..087f2fcaa6787 100644
--- a/llvm/test/CodeGen/AArch64/callbr-asm-outputs-indirect-isel.ll
+++ b/llvm/test/CodeGen/AArch64/callbr-asm-outputs-indirect-isel.ll
@@ -5,7 +5,7 @@
 ; RUN:   -global-isel=0 -fast-isel=0 | FileCheck %s
 
 ; This file was initially generated via:
-; $ opt -S -callbrprepare llvm/test/CodeGen/AArch64/callbr-prepare.ll -o \
+; $ opt -S -callbr-prepare llvm/test/CodeGen/AArch64/callbr-prepare.ll -o \
 ;   llvm/test/CodeGen/AArch64/callbr-asm-outputs-indirect-isel.ll
 
 ; TODO: should we remove test cases that don't use landingpad intrinsic?
diff --git a/llvm/test/CodeGen/AArch64/callbr-prepare.ll b/llvm/test/CodeGen/AArch64/callbr-prepare.ll
index 701355793d1ca..a4ecf48b74133 100644
--- a/llvm/test/CodeGen/AArch64/callbr-prepare.ll
+++ b/llvm/test/CodeGen/AArch64/callbr-prepare.ll
@@ -1,6 +1,6 @@
 ; NOTE: Assertions have been autogenerated by utils/update_test_checks.py
-; RUN: opt %s -callbrprepare -S -o - | FileCheck %s
-; RUN: opt %s -passes=callbrprepare -S -o - | FileCheck %s
+; RUN: opt %s -callbr-prepare -S -o - | FileCheck %s
+; RUN: opt %s -passes=callbr-prepare -S -o - | FileCheck %s
 
 define i32 @test0() {
 ; CHECK-LABEL: @test0(
diff --git a/llvm/test/CodeGen/Generic/opt-codegen-no-target-machine.ll b/llvm/test/CodeGen/Generic/opt-codegen-no-target-machine.ll
index 413f09ba55ddb..b7f0e7d02a21b 100644
--- a/llvm/test/CodeGen/Generic/opt-codegen-no-target-machine.ll
+++ b/llvm/test/CodeGen/Generic/opt-codegen-no-target-machine.ll
@@ -1,3 +1,3 @@
-; RUN: not --crash opt %s -dwarfehprepare -o - 2>&1 | FileCheck %s
+; RUN: not --crash opt %s -dwarf-eh-prepare -o - 2>&1 | FileCheck %s
 
 ; CHECK: Trying to construct TargetPassConfig without a target machine. Scheduling a CodeGen pass without a target triple set?
diff --git a/llvm/test/CodeGen/Mips/compactbranches/beqc-bnec-register-constraint.ll b/llvm/test/CodeGen/Mips/compactbranches/beqc-bnec-register-constraint.ll
index 4c8674d46e291..13e30676aa6fb 100644
--- a/llvm/test/CodeGen/Mips/compactbranches/beqc-bnec-register-constraint.ll
+++ b/llvm/test/CodeGen/Mips/compactbranches/beqc-bnec-register-constraint.ll
@@ -1,5 +1,5 @@
-; RUN: llc -march=mips -mcpu=mips32r6 -O1 -start-after=dwarfehprepare < %s | FileCheck %s
-; RUN: llc -march=mips64 -mcpu=mips64r6 -O1 -start-after=dwarfehprepare < %s | FileCheck %s
+; RUN: llc -march=mips -mcpu=mips32r6 -O1 -start-after=dwarf-eh-prepare < %s | FileCheck %s
+; RUN: llc -march=mips64 -mcpu=mips64r6 -O1 -start-after=dwarf-eh-prepare < %s | FileCheck %s
 
 
 ; beqc/bnec have the constraint that $rs < $rt && $rs != 0 && $rt != 0
diff --git a/llvm/test/CodeGen/X86/dwarf-eh-prepare-dbg.ll b/llvm/test/CodeGen/X86/dwarf-eh-prepare-dbg.ll
index 651e196a4ed76..0345b736e9e60 100644
--- a/llvm/test/CodeGen/X86/dwarf-eh-prepare-dbg.ll
+++ b/llvm/test/CodeGen/X86/dwarf-eh-prepare-dbg.ll
@@ -1,6 +1,6 @@
 ; NOTE: Assertions have been autogenerated by utils/update_test_checks.py
-; RUN: opt -S -mtriple=x86_64-linux-gnu -dwarfehprepare < %s | FileCheck %s
-; RUN: opt -S -mtriple=x86_64-linux-gnu -passes=dwarfehprepare < %s | FileCheck %s
+; RUN: opt -S -mtriple=x86_64-linux-gnu -dwarf-eh-prepare < %s | FileCheck %s
+; RUN: opt -S -mtriple=x86_64-linux-gnu -passes=dwarf-eh-prepare < %s | FileCheck %s
 
 ; PR57469: If _Unwind_Resume is defined in the same module and we have debug
 ; info, then the inserted _Unwind_Resume calls also need to have a dummy debug
diff --git a/llvm/test/CodeGen/X86/dwarf-eh-prepare.ll b/llvm/test/CodeGen/X86/dwarf-eh-prepare.ll
index 6778601cfbf6d..dd27e7fe14117 100644
--- a/llvm/test/CodeGen/X86/dwarf-eh-prepare.ll
+++ b/llvm/test/CodeGen/X86/dwarf-eh-prepare.ll
@@ -1,5 +1,5 @@
-; RUN: opt -mtriple=x86_64-linux-gnu -dwarfehprepare -simplifycfg-require-and-preserve-domtree=1 -run-twice < %s -S | FileCheck %s
-; RUN: opt -mtriple=x86_64-linux-gnu -passes=dwarfehprepare -codegen-opt-level=2 -simplifycfg-require-and-preserve-domtree=1 -run-twice < %s -S | FileCheck %s
+; RUN: opt -mtriple=x86_64-linux-gnu -dwarf-eh-prepare -simplifycfg-require-and-preserve-domtree=1 -run-twice < %s -S | FileCheck %s
+; RUN: opt -mtriple=x86_64-linux-gnu -passes=dwarf-eh-prepare -codegen-opt-level=2 -simplifycfg-require-and-preserve-domtree=1 -run-twice < %s -S | FileCheck %s
 
 ; Check basic functionality of IR-to-IR DWARF EH preparation. This should
 ; eliminate resumes. This pass requires a TargetMachine, so we put it under X86
diff --git a/llvm/test/CodeGen/X86/dwarf_eh_resume.ll b/llvm/test/CodeGen/X86/dwarf_eh_resume.ll
index 90fad00b68bd8..d66d89d16a394 100644
--- a/llvm/test/CodeGen/X86/dwarf_eh_resume.ll
+++ b/llvm/test/CodeGen/X86/dwarf_eh_resume.ll
@@ -1,5 +1,5 @@
-; RUN: opt -mtriple=x86_64-linux-gnu -dwarfehprepare -S %s | FileCheck %s
-; RUN: opt -mtriple=x86_64-linux-gnu -passes=dwarfehprepare -S %s | FileCheck %s
+; RUN: opt -mtriple=x86_64-linux-gnu -dwarf-eh-prepare -S %s | FileCheck %s
+; RUN: opt -mtriple=x86_64-linux-gnu -passes=dwarf-eh-prepare -S %s | FileCheck %s
 
 declare i32 @hoge(...)
 
diff --git a/llvm/tools/opt/opt.cpp b/llvm/tools/opt/opt.cpp
index 5e5e5ce233f31..3388165eed1bf 100644
--- a/llvm/tools/opt/opt.cpp
+++ b/llvm/tools/opt/opt.cpp
@@ -373,7 +373,7 @@ static bool shouldPinPassToLegacyPM(StringRef Pass) {
       "structurizecfg",
       "fix-irreducible",
       "expand-large-fp-convert",
-      "callbrprepare",
+      "callbr-prepare",
   };
   for (const auto &P : PassNamePrefix)
     if (Pass.startswith(P))

paperchalice · 2023-12-04T08:07:26Z

CC @arsenm. Should I also rename other passes such as below also?

llvm-project/llvm/lib/Passes/PassRegistry.def

Lines 338 to 342 in d49e9d8

    
           FUNCTION_PASS("lower-guard-intrinsic", LowerGuardIntrinsicPass()) 
        
           FUNCTION_PASS("lower-widenable-condition", LowerWidenableConditionPass()) 
        
           FUNCTION_PASS("loweratomic", LowerAtomicPass()) 
        
           FUNCTION_PASS("lowerinvoke", LowerInvokePass()) 
        
           FUNCTION_PASS("lowerswitch", LowerSwitchPass())

Well, I'm not a native speaker, so some rules may confuse me. 😓

arsenm · 2023-12-04T08:52:55Z

CC @arsenm. Should I also rename other passes such as below also?

llvm-project/llvm/lib/Passes/PassRegistry.def

Lines 338 to 342 in d49e9d8

FUNCTION_PASS("lower-guard-intrinsic", LowerGuardIntrinsicPass())

FUNCTION_PASS("lower-widenable-condition", LowerWidenableConditionPass())

FUNCTION_PASS("loweratomic", LowerAtomicPass())

FUNCTION_PASS("lowerinvoke", LowerInvokePass())

FUNCTION_PASS("lowerswitch", LowerSwitchPass())

Well, I'm not a native speaker, so some rules may confuse me. 😓

Yes, the lower-* ones get me every time

github-actions · 2023-12-04T10:14:24Z

✅ With the latest revision this PR passed the C/C++ code formatter.

paperchalice · 2023-12-04T11:17:45Z

Just rename some of them, some of them are combined with llc or legacy passes, which are not ready for testing.

arsenm · 2023-12-04T11:44:48Z

llvm/docs/Bugpoint.rst

@@ -159,7 +159,7 @@ non-obvious ways.  Here are some hints and tips:

 * ``bugpoint`` can produce IR which contains long names. Run ``opt
  -passes=metarenamer`` over the IR to rename everything using easy-to-read,
-  metasyntactic names. Alternatively, run ``opt -passes=strip,instnamer`` to


I think this one will be disruptive, I'd drop this one

Keep instnamer?

dwblaikie · 2023-12-04T19:03:40Z

Some more words to describe/justify the change might be helpful. (and/or a link to a discourse thread where this has been more broadly discussed) given the churn this would produce, I guess? (& the renamings look sufficiently independent maybe they should be committed separately - though I guess reviewing the overall concept in one place is probably good)

nikic · 2023-12-04T19:40:22Z

llvm/lib/Passes/PassRegistry.def

@@ -242,17 +242,17 @@ FUNCTION_ANALYSIS("no-op-function", NoOpFunctionAnalysis())
 FUNCTION_ANALYSIS("opt-remark-emit", OptimizationRemarkEmitterAnalysis())
 FUNCTION_ANALYSIS("pass-instrumentation", PassInstrumentationAnalysis(PIC))
 FUNCTION_ANALYSIS("phi-values", PhiValuesAnalysis())
-FUNCTION_ANALYSIS("postdomtree", PostDominatorTreeAnalysis())
+FUNCTION_ANALYSIS("post-domtree", PostDominatorTreeAnalysis())


This hyphenation doesn't make sense to me. It should be either postdomtree or post-dom-tree, but not something in the middle.

paperchalice · 2023-12-05T02:09:24Z

Post a topic to discourse: https://discourse.llvm.org/t/rfc-add-hyphens-to-pass-name/75439

llvm/lib/Passes/PassBuilder.cpp

arsenm · 2024-01-17T09:02:51Z

What was the consensus here? I think we are free to just break any names in the codegen pipeline. I would start with just those without aliases

nikic

These renames look ok to me.

paperchalice · 2024-01-25T08:05:46Z

Rebased to resolve conflict.

llvmbot added backend:AArch64 backend:X86 debuginfo labels Dec 4, 2023

paperchalice force-pushed the rename branch from 2d78994 to 12c0655 Compare December 4, 2023 10:11

paperchalice force-pushed the rename branch 6 times, most recently from 5bfbf63 to 1695812 Compare December 4, 2023 11:10

arsenm reviewed Dec 4, 2023

View reviewed changes

nikic reviewed Dec 4, 2023

View reviewed changes

paperchalice force-pushed the rename branch 5 times, most recently from 7c9b903 to 0095056 Compare December 6, 2023 06:54

arsenm reviewed Dec 6, 2023

View reviewed changes

llvm/lib/Passes/PassBuilder.cpp Outdated Show resolved Hide resolved

paperchalice force-pushed the rename branch from 0095056 to 438d03e Compare December 6, 2023 08:31

paperchalice mentioned this pull request Dec 11, 2023

[CodeGen] Update DwarfEHPreparePass references in CodeGenPassBuilder.h #74068

Merged

paperchalice force-pushed the rename branch from 438d03e to 859b479 Compare January 18, 2024 02:31

llvmbot added the LTO Link time optimization (regular/full LTO or ThinLTO) label Jan 18, 2024

llvmbot added the llvm:transforms label Jan 18, 2024

paperchalice force-pushed the rename branch 3 times, most recently from 6d14d80 to 7e05f0f Compare January 18, 2024 06:23

llvmbot added lld lld:ELF labels Jan 18, 2024

arsenm approved these changes Jan 18, 2024

View reviewed changes

nikic approved these changes Jan 18, 2024

View reviewed changes

[Pass] Rename some passes

d343f14

paperchalice force-pushed the rename branch from 7e05f0f to d343f14 Compare January 25, 2024 07:43

paperchalice merged commit e390c22 into llvm:main Jan 25, 2024
4 of 5 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Pass] Add hyphen to some pass names #74287

[Pass] Add hyphen to some pass names #74287

paperchalice commented Dec 4, 2023 •

edited

llvmbot commented Dec 4, 2023 •

edited

paperchalice commented Dec 4, 2023

arsenm commented Dec 4, 2023

github-actions bot commented Dec 4, 2023 •

edited

paperchalice commented Dec 4, 2023

arsenm Dec 4, 2023

paperchalice Dec 4, 2023

dwblaikie commented Dec 4, 2023

nikic Dec 4, 2023

paperchalice commented Dec 5, 2023

arsenm commented Jan 17, 2024

nikic left a comment

paperchalice commented Jan 25, 2024

[Pass] Add hyphen to some pass names #74287

[Pass] Add hyphen to some pass names #74287

Conversation

paperchalice commented Dec 4, 2023 • edited

llvmbot commented Dec 4, 2023 • edited

paperchalice commented Dec 4, 2023

arsenm commented Dec 4, 2023

github-actions bot commented Dec 4, 2023 • edited

paperchalice commented Dec 4, 2023

arsenm Dec 4, 2023

Choose a reason for hiding this comment

paperchalice Dec 4, 2023

Choose a reason for hiding this comment

dwblaikie commented Dec 4, 2023

nikic Dec 4, 2023

Choose a reason for hiding this comment

paperchalice commented Dec 5, 2023

arsenm commented Jan 17, 2024

nikic left a comment

Choose a reason for hiding this comment

paperchalice commented Jan 25, 2024

paperchalice commented Dec 4, 2023 •

edited

llvmbot commented Dec 4, 2023 •

edited

github-actions bot commented Dec 4, 2023 •

edited