Changed the name of the pass to LowerCommentStringPass

Author: Tony Varghese

clang/test/CodeGen/PowerPC/pragma-comment-copyright-aix-modules.cpp

@@ -7,15 +7,15 @@
 // Verify that module interface emits copyright global when compiled to IR
 // RUN: %clang_cc1 -std=c++20 -triple powerpc-ibm-aix -emit-llvm %t/copymod.cppm -o - \
 // RUN:   | FileCheck %s --check-prefix=CHECK-MOD
-// CHECK-MOD: @__loadtime_copyright_str = internal unnamed_addr constant [10 x i8] c"module me\00", section "__copyright_comment"
-// CHECK-MOD: @llvm.used = appending global {{.*}} @__loadtime_copyright_str
+// CHECK-MOD: @__loadtime_comment_str = internal unnamed_addr constant [10 x i8] c"module me\00", section "__loadtime_comment"
+// CHECK-MOD: @llvm.used = appending global {{.*}} @__loadtime_comment_str
 
 // Compile an importing TU that uses the prebuilt module and verify that it
 // does NOT re-emit the module's copyright global.
 // RUN: %clang_cc1 -std=c++20 -triple powerpc-ibm-aix \
 // RUN:   -fprebuilt-module-path=%t -emit-llvm %t/importmod.cc -o - \
 // RUN:   | FileCheck %s --check-prefix=CHECK-IMPORT
-// CHECK-IMPORT-NOT: @__loadtime_copyright_str
+// CHECK-IMPORT-NOT: @__loadtime_comment_str
 // CHECK-IMPORT-NOT: c"module me\00"
 
 //--- copymod.cppm

clang/test/CodeGen/lto-newpm-pipeline.c

@@ -27,7 +27,7 @@
 
 // CHECK-FULL-O0: Running pass: VerifierPass
 // CHECK-FULL-O0-NEXT: Running analysis: VerifierAnalysis
-// CHECK-FULL-O0-NEXT: Running pass: CopyrightMetadataPass
+// CHECK-FULL-O0-NEXT: Running pass: LowerCommentStringPass
 // CHECK-FULL-O0-NEXT: Running analysis: InnerAnalysisManagerProxy
 // CHECK-FULL-O0-NEXT: Running pass: EntryExitInstrumenterPass
 // CHECK-FULL-O0-NEXT: Running pass: AlwaysInlinerPass
@@ -42,7 +42,7 @@
 
 // CHECK-THIN-O0: Running pass: VerifierPass
 // CHECK-THIN-O0-NEXT: Running analysis: VerifierAnalysis
-// CHECK-THIN-O0-NEXT: Running pass: CopyrightMetadataPass
+// CHECK-THIN-O0-NEXT: Running pass: LowerCommentStringPass
 // CHECK-THIN-O0-NEXT: Running analysis: InnerAnalysisManagerProxy
 // CHECK-THIN-O0-NEXT: Running pass: EntryExitInstrumenterPass
 // CHECK-THIN-O0-NEXT: Running pass: AlwaysInlinerPass

…Transforms/Utils/CopyrightMetadataPass.h …ransforms/Utils/LowerCommentStringPass.hllvm/include/llvm/Transforms/Utils/CopyrightMetadataPass.h renamed to llvm/include/llvm/Transforms/Utils/LowerCommentStringPass.h llvm/include/llvm/Transforms/Utils/CopyrightMetadataPass.h renamed to llvm/include/llvm/Transforms/Utils/LowerCommentStringPass.h

@@ -1,18 +1,18 @@
-//===-- CopyrightMetadataPass.h - Lower AIX copyright metadata -*- C++ -*-===//
+//===-- LowerCommentStringPass.h - Lower Comment string metadata -*- 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_TRANSFORMS_UTILS_COPYRIGHTMETADATAPASS_H
-#define LLVM_TRANSFORMS_UTILS_COPYRIGHTMETADATAPASS_H
+#ifndef LLVM_TRANSFORMS_UTILS_LOWERCOMMENTSTRINGPASS_H
+#define LLVM_TRANSFORMS_UTILS_LOWERCOMMENTSTRINGPASS_H
 
 #include "llvm/IR/PassManager.h"
 
 namespace llvm {
-class CopyrightMetadataPass : public PassInfoMixin<CopyrightMetadataPass> {
+class LowerCommentStringPass : public PassInfoMixin<LowerCommentStringPass> {
 public:
   PreservedAnalyses run(Module &M, ModuleAnalysisManager &AM);
 
@@ -22,4 +22,4 @@ class CopyrightMetadataPass : public PassInfoMixin<CopyrightMetadataPass> {
 
 } // namespace llvm
 
-#endif // LLVM_TRANSFORMS_UTILS_COPYRIGHTMETADATAPASS_H
+#endif // LLVM_TRANSFORMS_UTILS_LOWERCOMMENTSTRINGPASS_H

llvm/lib/Passes/PassBuilder.cpp

@@ -347,7 +347,7 @@
 #include "llvm/Transforms/Utils/BreakCriticalEdges.h"
 #include "llvm/Transforms/Utils/CanonicalizeAliases.h"
 #include "llvm/Transforms/Utils/CanonicalizeFreezeInLoops.h"
-#include "llvm/Transforms/Utils/CopyrightMetadataPass.h"
+#include "llvm/Transforms/Utils/LowerCommentStringPass.h"
 #include "llvm/Transforms/Utils/CountVisits.h"
 #include "llvm/Transforms/Utils/DXILUpgrade.h"
 #include "llvm/Transforms/Utils/Debugify.h"

llvm/lib/Passes/PassBuilderPipelines.cpp

@@ -135,7 +135,7 @@
 #include "llvm/Transforms/Utils/AddDiscriminators.h"
 #include "llvm/Transforms/Utils/AssumeBundleBuilder.h"
 #include "llvm/Transforms/Utils/CanonicalizeAliases.h"
-#include "llvm/Transforms/Utils/CopyrightMetadataPass.h"
+#include "llvm/Transforms/Utils/LowerCommentStringPass.h"
 #include "llvm/Transforms/Utils/CountVisits.h"
 #include "llvm/Transforms/Utils/EntryExitInstrumenter.h"
 #include "llvm/Transforms/Utils/ExtraPassManager.h"
@@ -1456,7 +1456,7 @@ PassBuilder::buildModuleOptimizationPipeline(OptimizationLevel Level,
   ModulePassManager MPM;
 
   // Process copyright metadata early, before any optimizations
-  MPM.addPass(CopyrightMetadataPass());
+  MPM.addPass(LowerCommentStringPass());
 
   // Run partial inlining pass to partially inline functions that have
   // large bodies.
@@ -2279,7 +2279,7 @@ PassBuilder::buildO0DefaultPipeline(OptimizationLevel Level,
   ModulePassManager MPM;
 
   // Process copyright metadata at O0 before any other transformations
-  MPM.addPass(CopyrightMetadataPass());
+  MPM.addPass(LowerCommentStringPass());
 
   // Perform pseudo probe instrumentation in O0 mode. This is for the
   // consistency between different build modes. For example, a LTO build can be

llvm/lib/Passes/PassRegistry.def

@@ -61,7 +61,7 @@ MODULE_PASS("check-debugify", NewPMCheckDebugifyPass())
 MODULE_PASS("constmerge", ConstantMergePass())
 MODULE_PASS("coro-cleanup", CoroCleanupPass())
 MODULE_PASS("coro-early", CoroEarlyPass())
-MODULE_PASS("copyright-metadata", CopyrightMetadataPass())
+MODULE_PASS("lower-comment-string", LowerCommentStringPass())
 MODULE_PASS("cross-dso-cfi", CrossDSOCFIPass())
 MODULE_PASS("ctx-instr-gen",
             PGOInstrumentationGen(PGOInstrumentationType::CTXPROF))

llvm/lib/Transforms/Utils/CMakeLists.txt

@@ -17,7 +17,7 @@ add_llvm_component_library(LLVMTransformUtils
   CodeLayout.cpp
   CodeMoverUtils.cpp
   ControlFlowUtils.cpp
-  CopyrightMetadataPass.cpp
+  LowerCommentStringPass.cpp
   CtorUtils.cpp
   CountVisits.cpp
   Debugify.cpp

…ansforms/Utils/CopyrightMetadataPass.cpp …nsforms/Utils/LowerCommentStringPass.cppllvm/lib/Transforms/Utils/CopyrightMetadataPass.cpp renamed to llvm/lib/Transforms/Utils/LowerCommentStringPass.cpp llvm/lib/Transforms/Utils/CopyrightMetadataPass.cpp renamed to llvm/lib/Transforms/Utils/LowerCommentStringPass.cpp

@@ -1,13 +1,13 @@
-//===-- CopyrightMetadataPass.cpp - Lower copyright metadata -------------===//
+//===-- LowerCommentStringPass.cpp - Lower Comment string metadata -------===//
 //
 // 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
 //
 //===---------------------------------------------------------------------===//
 //
-// CopyrightMetadataPass pass lowers module-level copyright metadata emitted by
-// Clang:
+// LowerCommentStringPass pass lowers module-level comment string metadata 
+// emitted by Clang:
 //
 //     !comment_string.loadtime = !{!"Copyright ..."}
 //
@@ -16,8 +16,8 @@
 // For each module (translation unit), the pass performs the following:
 //
 //   1. Creates a null-terminated, internal constant string global
-//      (`__loadtime_copyright_str`) containing the copyright text in
-//      `__copyright_comment` section.
+//      (`__loadtime_comment_str`) containing the copyright text in
+//      `__loadtime_comment` section.
 //
 //   2. Marks the string in `llvm.used` so it cannot be dropped by
 //      optimization or LTO.
@@ -31,16 +31,16 @@
 //  Input IR:
 //     !comment_string.loadtime = !{!"Copyright"}
 //  Output IR:
-//     @__loadtime_copyright_str = internal constant [N x i8] c"Copyright\00",
-//                          section "__copyright_comment"
-//     @llvm.used = appending global [1 x ptr] [ptr @__loadtime_copyright_str]
+//     @__loadtime_comment_str = internal constant [N x i8] c"Copyright\00",
+//                          section "__loadtime_comment"
+//     @llvm.used = appending global [1 x ptr] [ptr @__loadtime_comment_str]
 //
 //     define i32 @func() !implicit.ref !5 { ... }
-//     !5 = !{ptr @__loadtime_copyright_str}
+//     !5 = !{ptr @__loadtime_comment_str}
 //
 //===----------------------------------------------------------------------===//
 
-#include "llvm/Transforms/Utils/CopyrightMetadataPass.h"
+#include "llvm/Transforms/Utils/LowerCommentStringPass.h"
 
 #include "llvm/ADT/SmallVector.h"
 #include "llvm/ADT/StringRef.h"
@@ -61,20 +61,20 @@
 #include "llvm/TargetParser/Triple.h"
 #include "llvm/Transforms/Utils/ModuleUtils.h"
 
-#define DEBUG_TYPE "copyright-metadata"
+#define DEBUG_TYPE "lower-comment-string"
 
 using namespace llvm;
 
 static cl::opt<bool>
-    DisableCopyrightMetadata("disable-copyright-metadata", cl::ReallyHidden,
-                             cl::desc("Disable copyright metadata pass."),
+    DisableCopyrightMetadata("disable-lower-comment-string", cl::ReallyHidden,
+                             cl::desc("Disable LowerCommentString pass."),
                              cl::init(false));
 
 static bool isAIXTriple(const Module &M) {
   return Triple(M.getTargetTriple()).isOSAIX();
 }
 
-PreservedAnalyses CopyrightMetadataPass::run(Module &M,
+PreservedAnalyses LowerCommentStringPass::run(Module &M,
                                              ModuleAnalysisManager &AM) {
   if (DisableCopyrightMetadata || !isAIXTriple(M))
     return PreservedAnalyses::all();
@@ -108,21 +108,21 @@ PreservedAnalyses CopyrightMetadataPass::run(Module &M,
   auto *StrGV = new GlobalVariable(M, StrInit->getType(),
                                    /*isConstant=*/true,
                                    GlobalValue::InternalLinkage, StrInit,
-                                   /*Name=*/"__loadtime_copyright_str");
+                                   /*Name=*/"__loadtime_comment_str");
   // Set unnamed_addr to allow the linker to merge identical strings
   StrGV->setUnnamedAddr(GlobalValue::UnnamedAddr::Global);
   StrGV->setAlignment(Align(1));
-  // Place in the "__copyright_comment" section.
+  // Place in the "__loadtime_comment" section.
   // The GV is constant, so we expect a read-only section.
-  StrGV->setSection("__copyright_comment");
+  StrGV->setSection("__loadtime_comment");
 
   // 2. Add the string to llvm.used to prevent LLVM optimization/LTO passes from
   // removing it.
   appendToUsed(M, {StrGV});
 
   // 3. Attach !implicit ref to every defined function
   // Create a metadata node pointing to the copyright string:
-  //   !N = !{ptr @__loadtime_copyright_str}
+  //   !N = !{ptr @__loadtime_comment_str}
   Metadata *Ops[] = {ConstantAsMetadata::get(StrGV)};
   MDNode *ImplicitRefMD = MDNode::get(Ctx, Ops);
 

llvm/test/CodeGen/AArch64/print-pipeline-passes.ll

@@ -2,7 +2,7 @@
 ; RUN: opt -mtriple=aarch64 -S -passes='default<O2>' -print-pipeline-passes < %s | FileCheck %s
 
 ; CHECK: loop-idiom-vectorize
-; O0: {{^}}copyright-metadata,function(ee-instrument<>),always-inline,coro-cond(coro-early,cgscc(coro-split),coro-cleanup,globaldce),alloc-token,function(annotation-remarks),verify,print{{$}}
+; O0: {{^}}lower-comment-string,function(ee-instrument<>),always-inline,coro-cond(coro-early,cgscc(coro-split),coro-cleanup,globaldce),alloc-token,function(annotation-remarks),verify,print{{$}}
 define void @foo() {
 entry:
   ret void

llvm/test/Other/new-pm-defaults.ll

@@ -238,7 +238,7 @@
 ; CHECK-O-NEXT: Running pass: CoroCleanupPass
 ; CHECK-O-NEXT: Running pass: GlobalOptPass
 ; CHECK-O-NEXT: Running pass: GlobalDCEPass
-; CHECK-O-NEXT: Running pass: CopyrightMetadataPass
+; CHECK-O-NEXT: Running pass: LowerCommentStringPass
 ; CHECK-DEFAULT-NEXT: Running pass: EliminateAvailableExternallyPass
 ; CHECK-LTO-NOT: Running pass: EliminateAvailableExternallyPass
 ; CHECK-O-NEXT: Running pass: ReversePostOrderFunctionAttrsPass