include/llvm/CodeGen/MachineFunctionPass.h

   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
  25 namespace llvm {
  26
  27 struct MachineFunctionPass : public FunctionPass {
  28
  29   explicit MachineFunctionPass(intptr_t ID) : FunctionPass(ID) {}
  30
  31 protected:
  32   /// runOnMachineFunction - This method must be overloaded to perform the
  33   /// desired machine code transformation or analysis.
  34   ///
  35   virtual bool runOnMachineFunction(MachineFunction &MF) = 0;
  36
  37 public:
  38   // FIXME: This pass should declare that the pass does not invalidate any LLVM
  39   // passes.
  40   bool runOnFunction(Function &F) {
  41     return runOnMachineFunction(MachineFunction::get(&F));
  42   }
  43
  44 private:
  45   virtual void virtfn();  // out of line virtual fn to give class a home.
  46 };
  47
  48 } // End llvm namespace
  49
  50 #endif