MachineFunctionPass.h revision d0fde30ce850b78371fd1386338350591f9ff494 
1//===-- MachineFunctionPass.h - Pass for MachineFunctions --------*-C++ -*-===//
2//
3//                     The LLVM Compiler Infrastructure
4//
5// This file was developed by the LLVM research group and is distributed under
6// the University of Illinois Open Source 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
27struct MachineFunctionPass : public FunctionPass {
28
29  /// runOnMachineFunction - This method must be overloaded to perform the
30  /// desired machine code transformation or analysis.
31  ///
32  virtual bool runOnMachineFunction(MachineFunction &MF) = 0;
33
34  // FIXME: This pass should declare that the pass does not invalidate any LLVM
35  // passes.
36
37  virtual bool runOnFunction(Function &F) {
38    return runOnMachineFunction(MachineFunction::get(&F));
39  }
40};
41
42} // End llvm namespace
43
44#endif
45