Commit 304f2bd2 authored by Markus Lavin's avatar Markus Lavin
Browse files

[NPM] Added opt option -print-pipeline-passes. 

Added opt option -print-pipeline-passes to print a -passes compatible
string describing the built pass pipeline.

As an example:
$ opt -enable-new-pm=1 -adce -licm -simplifycfg -o /dev/null /dev/null -print-pipeline-passes
verify,function(adce),function(loop-mssa(licm)),function(simplifycfg<bonus-inst-threshold=1;no-forward-switch-cond;no-switch-to-lookup;keep-loops;no-hoist-common-insts;no-sink-common-insts>),verify,BitcodeWriterPass

At the moment this is best-effort only and there are some known
limitations:
- Not all passes accepting parameters will print their parameters
  (currently only implemented for simplifycfg).
- Some ClassName to pass-name mappings are not unique.
- Some ClassName to pass-name mappings are missing (e.g.
  BitcodeWriterPass).

Differential Revision: https://reviews.llvm.org/D108298
parent 645af79e

llvm/include/llvm/IR/PassManager.h

+38 −0
Original line number Diff line number Diff line
@@ -381,6 +381,13 @@ template <typename DerivedT> struct PassInfoMixin { 
      Name = Name.drop_front(strlen("llvm::"));

    return Name;

  }



  void printPipeline(raw_ostream &OS,

                     function_ref<StringRef(StringRef)> MapClassName2PassName) {

    auto ClassName = name();

    auto PassName = MapClassName2PassName(ClassName);

    OS << PassName;

  }

};



/// A CRTP mix-in that provides informational APIs needed for analysis passes.
@@ -480,6 +487,16 @@ public: 
    return *this;

  }



  void printPipeline(raw_ostream &OS,

                     function_ref<StringRef(StringRef)> MapClassName2PassName) {

    for (unsigned Idx = 0, Size = Passes.size(); Idx != Size; ++Idx) {

      auto *P = Passes[Idx].get();

      P->printPipeline(OS, MapClassName2PassName);

      if (Idx + 1 < Size)

        OS << ",";

    }

  }



  /// Run all of the passes in this manager over the given unit of IR.

  /// ExtraArgs are passed to each pass.

  PreservedAnalyses run(IRUnitT &IR, AnalysisManagerT &AM,
@@ -1195,6 +1212,8 @@ public: 


  /// Runs the function pass across every function in the module.

  PreservedAnalyses run(Module &M, ModuleAnalysisManager &AM);

  void printPipeline(raw_ostream &OS,

                     function_ref<StringRef(StringRef)> MapClassName2PassName);



  static bool isRequired() { return true; }
@@ -1243,6 +1262,12 @@ struct RequireAnalysisPass 


    return PreservedAnalyses::all();

  }

  void printPipeline(raw_ostream &OS,

                     function_ref<StringRef(StringRef)> MapClassName2PassName) {

    auto ClassName = AnalysisT::name();

    auto PassName = MapClassName2PassName(ClassName);

    OS << "require<" << PassName << ">";

  }

  static bool isRequired() { return true; }

};
@@ -1263,6 +1288,12 @@ struct InvalidateAnalysisPass 
    PA.abandon<AnalysisT>();

    return PA;

  }

  void printPipeline(raw_ostream &OS,

                     function_ref<StringRef(StringRef)> MapClassName2PassName) {

    auto ClassName = AnalysisT::name();

    auto PassName = MapClassName2PassName(ClassName);

    OS << "invalidate<" << PassName << ">";

  }

};



/// A utility pass that does nothing, but preserves no analyses.
@@ -1312,6 +1343,13 @@ public: 
    return PA;

  }



  void printPipeline(raw_ostream &OS,

                     function_ref<StringRef(StringRef)> MapClassName2PassName) {

    OS << "repeat<" << Count << ">(";

    P.printPipeline(OS, MapClassName2PassName);

    OS << ")";

  }



private:

  int Count;

  PassT P;

llvm/include/llvm/IR/PassManagerInternal.h

+9 −0
Original line number Diff line number Diff line
@@ -46,6 +46,9 @@ struct PassConcept { 
  virtual PreservedAnalyses run(IRUnitT &IR, AnalysisManagerT &AM,

                                ExtraArgTs... ExtraArgs) = 0;



  virtual void

  printPipeline(raw_ostream &OS,

                function_ref<StringRef(StringRef)> MapClassName2PassName) = 0;

  /// Polymorphic method to access the name of a pass.

  virtual StringRef name() const = 0;
@@ -85,6 +88,12 @@ struct PassModel : PassConcept<IRUnitT, AnalysisManagerT, ExtraArgTs...> { 
    return Pass.run(IR, AM, ExtraArgs...);

  }



  void printPipeline(

      raw_ostream &OS,

      function_ref<StringRef(StringRef)> MapClassName2PassName) override {

    Pass.printPipeline(OS, MapClassName2PassName);

  }



  StringRef name() const override { return PassT::name(); }



  template <typename T>

llvm/include/llvm/Transforms/Scalar/LoopPassManager.h

+4 −0
Original line number Diff line number Diff line
@@ -94,6 +94,8 @@ public: 
  PreservedAnalyses run(Loop &L, LoopAnalysisManager &AM,

                        LoopStandardAnalysisResults &AR, LPMUpdater &U);



  void printPipeline(raw_ostream &OS,

                     function_ref<StringRef(StringRef)> MapClassName2PassName);

  /// Add either a loop pass or a loop-nest pass to the pass manager. Append \p

  /// Pass to the list of loop passes if it has a dedicated \fn run() method for

  /// loops and to the list of loop-nest passes if the \fn run() method is for
@@ -424,6 +426,8 @@ public: 


  /// Runs the loop passes across every loop in the function.

  PreservedAnalyses run(Function &F, FunctionAnalysisManager &AM);

  void printPipeline(raw_ostream &OS,

                     function_ref<StringRef(StringRef)> MapClassName2PassName);



  static bool isRequired() { return true; }

llvm/include/llvm/Transforms/Scalar/SimplifyCFG.h

+3 −0
Original line number Diff line number Diff line
@@ -41,6 +41,9 @@ public: 


  /// Run the pass over the function.

  PreservedAnalyses run(Function &F, FunctionAnalysisManager &AM);



  void printPipeline(raw_ostream &OS,

                     function_ref<StringRef(StringRef)> MapClassName2PassName);

};



}

llvm/lib/IR/PassManager.cpp

+7 −0
Original line number Diff line number Diff line
@@ -91,6 +91,13 @@ bool FunctionAnalysisManagerModuleProxy::Result::invalidate( 
}

} // namespace llvm



void ModuleToFunctionPassAdaptor::printPipeline(

    raw_ostream &OS, function_ref<StringRef(StringRef)> MapClassName2PassName) {

  OS << "function(";

  Pass->printPipeline(OS, MapClassName2PassName);

  OS << ")";

}



PreservedAnalyses ModuleToFunctionPassAdaptor::run(Module &M,

                                                   ModuleAnalysisManager &AM) {

  FunctionAnalysisManager &FAM =