MachineFunctionPass.h revision 8613b18a5aa80b13bb8c7f470528146f009bed74 
1//===-- MachineFunctionPass.h - Pass for MachineFunctions --------*-C++ -*-===//
2//
3//                     The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file defines the MachineFunctionPass class.  MachineFunctionPass's are
11// just FunctionPass's, except they operate on machine code as part of a code
12// generator.  Because they operate on machine code, not the LLVM
13// representation, MachineFunctionPass's are not allowed to modify the LLVM
14// representation.  Due to this limitation, the MachineFunctionPass class takes
15// care of declaring that no LLVM passes are invalidated.
16//
17//===----------------------------------------------------------------------===//
18
19#ifndef LLVM_CODEGEN_MACHINE_FUNCTION_PASS_H
20#define LLVM_CODEGEN_MACHINE_FUNCTION_PASS_H
21
22#include "llvm/Pass.h"
23
24namespace llvm {
25
26class MachineFunction;
27
28/// MachineFunctionPass - This class adapts the FunctionPass interface to
29/// allow convenient creation of passes that operate on the MachineFunction
30/// representation. Instead of overriding runOnFunction, subclasses
31/// override runOnMachineFunction.
32class MachineFunctionPass : public FunctionPass {
33protected:
34  explicit MachineFunctionPass(intptr_t ID) : FunctionPass(ID) {}
35  explicit MachineFunctionPass(void *ID) : FunctionPass(ID) {}
36
37  /// runOnMachineFunction - This method must be overloaded to perform the
38  /// desired machine code transformation or analysis.
39  ///
40  virtual bool runOnMachineFunction(MachineFunction &MF) = 0;
41
42  /// getAnalysisUsage - Subclasses that override getAnalysisUsage
43  /// must call this.
44  ///
45  /// For MachineFunctionPasses, calling AU.preservesCFG() indicates that
46  /// the pass does not modify the MachineBasicBlock CFG.
47  ///
48  virtual void getAnalysisUsage(AnalysisUsage &AU) const;
49
50private:
51  /// createPrinterPass - Get a machine function printer pass.
52  virtual Pass *createPrinterPass(raw_ostream &O,
53                                  const std::string &Banner) const;
54
55  virtual bool runOnFunction(Function &F);
56};
57
58} // End llvm namespace
59
60#endif
61