[New PM] adding helper that manages standard instrumentations

[fedor.sergeev]

Summary

StandardInstrumentations class provides a central place to manage all
the "standard" in-tree pass instrumentations.

[philip.pfaffe]

This looks nice! At this point, I think it makes sense to just move the entire IR Printing implementation here. I don't even think it needs to be mentioned in the header. It doesn't have any other clients, and Analysis is definitely the wrong home.

[fedor.sergeev]

Thats right. Merging this fix with PrintIR (D50923), where printing callbacks will reside in StandardInstrumentations.cpp.

include/llvm/Passes/StandardInstrumentations.h

+//===- StandardInstrumentations.h ------------------------------*- C++ -*--===//
+//
+//                     The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+/// \file
+///
+/// This header defines a class that provides bookkeeping for all standard
+/// (i.e in-tree) pass instrumentations.
+///
+//===----------------------------------------------------------------------===//
+
+#ifndef LLVM_PASSES_STANDARDINSTRUMENTATIONS_H
+#define LLVM_PASSES_STANDARDINSTRUMENTATIONS_H
+
+#include "llvm/IR/PassInstrumentation.h"
+#include "llvm/IR/PassTimingInfo.h"
+
+namespace llvm {
+
+  /// This class provides an interface to register all the standard pass
+  /// instrumentations and manages their state (if any).
+  class StandardInstrumentations {
+    TimePassesHandler TimePasses;
+
+  public:
+    StandardInstrumentations() = default;
+
+    void registerCallbacks(PassInstrumentationCallbacks& PIC);
+  };
+}
+
+#endif

lib/Passes/CMakeLists.txt

 add_llvm_library(LLVMPasses
   PassBuilder.cpp
   PassPlugin.cpp
+  StandardInstrumentations.cpp
 
   ADDITIONAL_HEADER_DIRS
   ${LLVM_MAIN_INCLUDE_DIR}/llvm/Passes
 
   DEPENDS
   intrinsics_gen
   )

lib/Passes/StandardInstrumentations.cpp

+//===- Bookkeeping for standard pass instrumentations ----------*- C++ -*--===//
+//
+//                     The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+/// \file
+///
+/// This file defines StandardInstrumentations class that manages standard
+/// pass instrumentations defined in-tree.
+///
+//===----------------------------------------------------------------------===//
+
+#include "llvm/Passes/StandardInstrumentations.h"
+#include "llvm/Analysis/PrintIR.h"
+#include "llvm/IR/PassTimingInfo.h"
+#include "llvm/IR/IRPrintingPasses.h"
+
+using namespace llvm;
+
+void StandardInstrumentations::registerCallbacks(PassInstrumentationCallbacks& PIC) {
+  if (llvm::shouldPrintBeforePass())
+    PIC.registerBeforePassCallback(PrintIR::printBeforePass);
+  if (llvm::shouldPrintAfterPass())
+    PIC.registerAfterPassCallback(PrintIR::printAfterPass);
+  TimePasses.registerCallbacks(PIC);
+}

tools/opt/NewPMDriver.cpp

 //===----------------------------------------------------------------------===//
 
 #include "NewPMDriver.h"
 #include "Debugify.h"
 #include "PassPrinters.h"
 #include "llvm/ADT/StringRef.h"
 #include "llvm/Analysis/AliasAnalysis.h"
 #include "llvm/Analysis/CGSCCPassManager.h"
-#include "llvm/Analysis/PrintIR.h"
 #include "llvm/Bitcode/BitcodeWriterPass.h"
 #include "llvm/Config/llvm-config.h"
 #include "llvm/IR/Dominators.h"
 #include "llvm/IR/IRPrintingPasses.h"
 #include "llvm/IR/LLVMContext.h"
 #include "llvm/IR/Module.h"
 #include "llvm/IR/PassManager.h"
 #include "llvm/IR/Verifier.h"
 #include "llvm/Passes/PassBuilder.h"
 #include "llvm/Passes/PassPlugin.h"
+#include "llvm/Passes/StandardInstrumentations.h"
 #include "llvm/Support/CommandLine.h"
 #include "llvm/Support/ErrorHandling.h"
 #include "llvm/Support/ToolOutputFile.h"
 #include "llvm/Target/TargetMachine.h"
 #include "llvm/Transforms/IPO/ThinLTOBitcodeWriter.h"
 #include "llvm/Transforms/Scalar/LoopPassManager.h"
 
 using namespace llvm;
case SampleUse:
       break;
     case NoPGO:
       if (DebugInfoForProfiling)
         P = PGOOptions("", "", "", false, true);
       else
         P = None;
   }
   PassInstrumentationCallbacks PIC;
-  if (llvm::shouldPrintBeforePass())
-    PIC.registerBeforePassCallback(PrintIR::printBeforePass);
-  if (llvm::shouldPrintAfterPass())
-    PIC.registerAfterPassCallback(PrintIR::printAfterPass);
-  TimePassesHandler TimePasses;
-  TimePasses.registerCallbacks(PIC);
+  StandardInstrumentations SI;
+  SI.registerCallbacks(PIC);
 
   PassBuilder PB(TM, P, &PIC);
   registerEPCallbacks(PB, VerifyEachPass, DebugPM);
-  PB.registerDefaultInstrumentations();
 
   // Load requested pass plugins and let them register pass builder callbacks
   for (auto &PluginFN : PassPlugins) {
     auto PassPlugin = PassPlugin::Load(PluginFN);
     if (!PassPlugin) {
       errs() << "Failed to load passes from '" << PluginFN
              << "'. Request ignored.\n";
       continue;