LegacyPassManager.h

Go to the documentation of this file.

//===- LegacyPassManager.h - Legacy Container for Passes --------*- 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 file defines the legacy PassManager class.  This class is used to hold,
// maintain, and optimize execution of Passes.  The PassManager class ensures
// that analysis results are available before a pass runs, and that Pass's are
// destroyed when the PassManager is destroyed.
//
//===----------------------------------------------------------------------===//
 
#ifndef LLVM_IR_LEGACYPASSMANAGER_H
#define LLVM_IR_LEGACYPASSMANAGER_H
 
#include "llvm/Support/CBindingWrapping.h"
#include "llvm/Support/Compiler.h"
 
namespace llvm {
 
class Function;
class Pass;
class Module;
 
namespace legacy {
 
// Whether or not -debug-pass has been specified. For use to check if it's
// specified alongside the new PM.
LLVM_ABI bool debugPassSpecified();
 
class PassManagerImpl;
class FunctionPassManagerImpl;
 
/// PassManagerBase - An abstract interface to allow code to add passes to
/// a pass manager without having to hard-code what kind of pass manager
/// it is.
class LLVM_ABI PassManagerBase {
public:
  virtual ~PassManagerBase();
 
  /// Add a pass to the queue of passes to run.  This passes ownership of
  /// the Pass to the PassManager.  When the PassManager is destroyed, the pass
  /// will be destroyed as well, so there is no need to delete the pass.  This
  /// may even destroy the pass right away if it is found to be redundant. This
  /// implies that all passes MUST be allocated with 'new'.
  virtual void add(Pass *P) = 0;
};
 
/// PassManager manages ModulePassManagers
class LLVM_ABI PassManager : public PassManagerBase {
public:
 
  PassManager();
  ~PassManager() override;
 
  void add(Pass *P) override;
 
  /// run - Execute all of the passes scheduled for execution.  Keep track of
  /// whether any of the passes modifies the module, and if so, return true.
  bool run(Module &M);
 
private:
  /// PassManagerImpl_New is the actual class. PassManager is just the
  /// wraper to publish simple pass manager interface
  PassManagerImpl *PM;
};
 
/// FunctionPassManager manages FunctionPasses.
class LLVM_ABI FunctionPassManager : public PassManagerBase {
public:
  /// FunctionPassManager ctor - This initializes the pass manager.  It needs,
  /// but does not take ownership of, the specified Module.
  explicit FunctionPassManager(Module *M);
  ~FunctionPassManager() override;
 
  void add(Pass *P) override;
 
  /// run - Execute all of the passes scheduled for execution.  Keep
  /// track of whether any of the passes modifies the function, and if
  /// so, return true.
  ///
  bool run(Function &F);
 
  /// doInitialization - Run all of the initializers for the function passes.
  ///
  bool doInitialization();
 
  /// doFinalization - Run all of the finalizers for the function passes.
  ///
  bool doFinalization();
 
private:
  FunctionPassManagerImpl *FPM;
  Module *M;
};
 
} // End legacy namespace
 
// Create wrappers for C Binding types (see CBindingWrapping.h).
DEFINE_STDCXX_CONVERSION_FUNCTIONS(legacy::PassManagerBase, LLVMPassManagerRef)
 
} // End llvm namespace
 
#endif