1 //===-- MachineFunctionPass.cpp -------------------------------------------===//
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 contains the definitions of the MachineFunctionPass members.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #include "llvm/CodeGen/MachineFunctionPass.h"
15 #include "llvm/Analysis/AliasAnalysis.h"
16 #include "llvm/Analysis/BasicAliasAnalysis.h"
17 #include "llvm/Analysis/DominanceFrontier.h"
18 #include "llvm/Analysis/GlobalsModRef.h"
19 #include "llvm/Analysis/IVUsers.h"
20 #include "llvm/Analysis/LoopInfo.h"
21 #include "llvm/Analysis/MemoryDependenceAnalysis.h"
22 #include "llvm/Analysis/ScalarEvolution.h"
23 #include "llvm/Analysis/ScalarEvolutionAliasAnalysis.h"
24 #include "llvm/CodeGen/MachineFunction.h"
25 #include "llvm/CodeGen/MachineFunctionAnalysis.h"
26 #include "llvm/CodeGen/Passes.h"
27 #include "llvm/CodeGen/StackProtector.h"
28 #include "llvm/IR/Dominators.h"
29 #include "llvm/IR/Function.h"
30 
31 using namespace llvm;
32 
createPrinterPass(raw_ostream & O,const std::string & Banner) const33 Pass *MachineFunctionPass::createPrinterPass(raw_ostream &O,
34                                              const std::string &Banner) const {
35   return createMachineFunctionPrinterPass(O, Banner);
36 }
37 
runOnFunction(Function & F)38 bool MachineFunctionPass::runOnFunction(Function &F) {
39   // Do not codegen any 'available_externally' functions at all, they have
40   // definitions outside the translation unit.
41   if (F.hasAvailableExternallyLinkage())
42     return false;
43 
44   MachineFunction &MF = getAnalysis<MachineFunctionAnalysis>().getMF();
45   MachineFunctionProperties &MFProps = MF.getProperties();
46 
47 #ifndef NDEBUG
48   if (!MFProps.verifyRequiredProperties(RequiredProperties)) {
49     errs() << "MachineFunctionProperties required by " << getPassName()
50            << " pass are not met by function " << F.getName() << ".\n"
51            << "Required properties: ";
52     RequiredProperties.print(errs(), /*OnlySet=*/true);
53     errs() << "\nCurrent properties: ";
54     MFProps.print(errs());
55     errs() << "\n";
56     llvm_unreachable("MachineFunctionProperties check failed");
57   }
58 #endif
59 
60   bool RV = runOnMachineFunction(MF);
61 
62   MFProps.set(SetProperties);
63   MFProps.clear(ClearedProperties);
64   return RV;
65 }
66 
getAnalysisUsage(AnalysisUsage & AU) const67 void MachineFunctionPass::getAnalysisUsage(AnalysisUsage &AU) const {
68   AU.addRequired<MachineFunctionAnalysis>();
69   AU.addPreserved<MachineFunctionAnalysis>();
70 
71   // MachineFunctionPass preserves all LLVM IR passes, but there's no
72   // high-level way to express this. Instead, just list a bunch of
73   // passes explicitly. This does not include setPreservesCFG,
74   // because CodeGen overloads that to mean preserving the MachineBasicBlock
75   // CFG in addition to the LLVM IR CFG.
76   AU.addPreserved<BasicAAWrapperPass>();
77   AU.addPreserved<DominanceFrontierWrapperPass>();
78   AU.addPreserved<DominatorTreeWrapperPass>();
79   AU.addPreserved<AAResultsWrapperPass>();
80   AU.addPreserved<GlobalsAAWrapperPass>();
81   AU.addPreserved<IVUsers>();
82   AU.addPreserved<LoopInfoWrapperPass>();
83   AU.addPreserved<MemoryDependenceWrapperPass>();
84   AU.addPreserved<ScalarEvolutionWrapperPass>();
85   AU.addPreserved<SCEVAAWrapperPass>();
86   AU.addPreserved<StackProtector>();
87 
88   FunctionPass::getAnalysisUsage(AU);
89 }
90