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