MachineFunctionPass.h revision ad2afc2a421a0e41603d5eee412d4d8c77e9bc1c 
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#include "llvm/CodeGen/MachineFunction.h"
24
25namespace llvm {
26
27/// MachineFunctionPass - This class adapts the FunctionPass interface to
28/// allow convenient creation of passes that operate on the MachineFunction
29/// representation. Instead of overriding runOnFunction, subclasses
30/// override runOnMachineFunction.
31class MachineFunctionPass : public FunctionPass {
32protected:
33  explicit MachineFunctionPass(intptr_t ID) : FunctionPass(ID) {}
34  explicit MachineFunctionPass(void *ID) : FunctionPass(ID) {}
35
36  /// runOnMachineFunction - This method must be overloaded to perform the
37  /// desired machine code transformation or analysis.
38  ///
39  virtual bool runOnMachineFunction(MachineFunction &MF) = 0;
40
41  /// getAnalysisUsage - Subclasses that override getAnalysisUsage
42  /// must call this.
43  virtual void getAnalysisUsage(AnalysisUsage &AU) const;
44
45private:
46  bool runOnFunction(Function &F);
47};
48
49} // End llvm namespace
50
51#endif
52