[UniformityAnalysis] Fix some file headers and pass names

[foad]

llvm/include/llvm/CodeGen/MachineUniformityAnalysis.h

10

I assume this comment was a cut-n-paste error, unless there is some very subtle distinction between "uniformity info" and "uniform info"?

llvm/lib/Analysis/UniformityAnalysis.cpp

128–129

This just sounds better to me. Any objections?

[sameerds]

Thanks for cleaning this up! It's mildly embarrassing that all this copy-pasta went through!

llvm/include/llvm/Analysis/UniformityAnalysis.h

9–10

Actually this whole description is wrong. There are no convergene intrinsics in LLVM yet! The file description should simply say "LLVM IR instance of the generic uniformity analysis".

llvm/include/llvm/CodeGen/MachineUniformityAnalysis.h

10

I suggest "Machine IR instance of the generic uniformity analysis"

llvm/lib/Analysis/UniformityAnalysis.cpp

127–128

Perhaps this should also be "uniformity"? For example, the loop info analysis and the cycle info analysis are simply called "loops" and "cycles" respectively. This might need changes in the lit tests that invoke this analysis by name.

128–129

Sounds better to me too!

[foad]

Update

[foad]

llvm/lib/Analysis/UniformityAnalysis.cpp

127–128

Yes, that seems consistent with other analyses.

[foad]

llvm/lib/Analysis/UniformityAnalysis.cpp

127–128

This only changed the legacy pass name. The non-legacy pass name was already "uniformity" and that's what the tests use.

llvm/include/llvm/ADT/GenericUniformityImpl.h

-//===- GenericUniformAnalysis.cpp --------------------*- C++ -*------------===//
+//===- GenericUniformityImpl.h -----------------------*- 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
 //
 //===----------------------------------------------------------------------===//
 //
 // This template implementation resides in a separate file so that it

llvm/include/llvm/ADT/GenericUniformityInfo.h

 //===- GenericUniformityInfo.h ---------------------------*- 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
 //
 //===----------------------------------------------------------------------===//
-//
-//
-//===----------------------------------------------------------------------===//
 
 #ifndef LLVM_ADT_GENERICUNIFORMITYINFO_H
 #define LLVM_ADT_GENERICUNIFORMITYINFO_H
 
 // #include "llvm/ADT/DenseSet.h"
 #include "llvm/ADT/GenericCycleInfo.h"
 // #include "llvm/ADT/SmallPtrSet.h"
 // #include "llvm/ADT/Uniformity.h"

llvm/include/llvm/ADT/Uniformity.h

 //===- Uniformity.h --------------------------------------*- 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
 //
 //===----------------------------------------------------------------------===//
-//
-//
-//===----------------------------------------------------------------------===//
 
 #ifndef LLVM_ADT_UNIFORMITY_H
 #define LLVM_ADT_UNIFORMITY_H
 
 namespace llvm {
 
 /// Enum describing how instructions behave with respect to uniformity and
 /// divergence, to answer the question: if the same instruction is executed by

llvm/include/llvm/Analysis/UniformityAnalysis.h

-//===- ConvergenceUtils.h -----------------------*- C++ -*-----------------===//
+//===- UniformityAnalysis.h ---------------------*- 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
-/// \brief Convergence info and convergence-aware uniform info for LLVM IR
-///
-/// This differs from traditional divergence analysis by taking convergence
-/// intrinsics into account.
+/// \brief LLVM IR instance of the generic uniformity analysis
 //
 //===----------------------------------------------------------------------===//
 
 #ifndef LLVM_ANALYSIS_UNIFORMITYANALYSIS_H
 #define LLVM_ANALYSIS_UNIFORMITYANALYSIS_H
 
 #include "llvm/ADT/GenericUniformityInfo.h"
 #include "llvm/Analysis/CycleAnalysis.h"

llvm/include/llvm/CodeGen/MachineUniformityAnalysis.h

 //===- MachineUniformityAnalysis.h ---------------------------*- 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
-/// \brief Uniformity info and uniformity-aware uniform info for Machine IR
+/// \brief Machine IR instance of the generic uniformity analysis
 //
 //===----------------------------------------------------------------------===//
 
 #ifndef LLVM_CODEGEN_MACHINEUNIFORMITYANALYSIS_H
 #define LLVM_CODEGEN_MACHINEUNIFORMITYANALYSIS_H
 
 #include "llvm/ADT/GenericUniformityInfo.h"
 #include "llvm/CodeGen/MachineCycleAnalysis.h"
 #include "llvm/CodeGen/MachineDominators.h"
 #include "llvm/CodeGen/MachineSSAContext.h"
 
 namespace llvm {
 
 extern template class GenericUniformityInfo<MachineSSAContext>;
 using MachineUniformityInfo = GenericUniformityInfo<MachineSSAContext>;
 
-/// \brief Compute the uniform information of a Machine IR function.
+/// \brief Compute uniformity information for a Machine IR function.
 MachineUniformityInfo
 computeMachineUniformityInfo(MachineFunction &F,
                              const MachineCycleInfo &cycleInfo,
                              const MachineDomTree &domTree);
 
 } // namespace llvm
 
 #endif // LLVM_CODEGEN_MACHINEUNIFORMITYANALYSIS_H

llvm/lib/Analysis/UniformityAnalysis.cpp

-//===- ConvergenceUtils.cpp -----------------------------------------------===//
+//===- UniformityAnalysis.cpp ---------------------------------------------===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
 
 #include "llvm/Analysis/UniformityAnalysis.h"

 //  UniformityInfoWrapperPass Implementation
 //===----------------------------------------------------------------------===//
 
 char UniformityInfoWrapperPass::ID = 0;
 
 UniformityInfoWrapperPass::UniformityInfoWrapperPass() : FunctionPass(ID) {
   initializeUniformityInfoWrapperPassPass(*PassRegistry::getPassRegistry());
 }
 
-INITIALIZE_PASS_BEGIN(UniformityInfoWrapperPass, "uniforminfo",
-                      "Uniform Info Analysis", true, true)
+INITIALIZE_PASS_BEGIN(UniformityInfoWrapperPass, "uniformity",
+                      "Uniformity Analysis", true, true)
 INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass)
 INITIALIZE_PASS_DEPENDENCY(TargetTransformInfoWrapperPass)
-INITIALIZE_PASS_END(UniformityInfoWrapperPass, "uniforminfo",
-                    "Uniform Info Analysis", true, true)
+INITIALIZE_PASS_END(UniformityInfoWrapperPass, "uniformity",
+                    "Uniformity Analysis", true, true)
 
 void UniformityInfoWrapperPass::getAnalysisUsage(AnalysisUsage &AU) const {
   AU.setPreservesAll();
   AU.addRequired<DominatorTreeWrapperPass>();
   AU.addRequired<CycleInfoWrapperPass>();
   AU.addRequired<TargetTransformInfoWrapperPass>();
 }