PrologEpilogInserter.h revision c7d2c5396f2876ed2ac8e5c3b65291a769a90767 
1//===-- PrologEpilogInserter.h - Prolog/Epilog code insertion -*- 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 pass is responsible for finalizing the functions frame layout, saving
11// callee saved registers, and for emitting prolog & epilog code for the
12// function.
13//
14// This pass must be run after register allocation.  After this pass is
15// executed, it is illegal to construct MO_FrameIndex operands.
16//
17// This pass also implements a shrink wrapping variant of prolog/epilog
18// insertion.
19//
20//===----------------------------------------------------------------------===//
21
22#ifndef LLVM_CODEGEN_PEI_H
23#define LLVM_CODEGEN_PEI_H
24
25#include "llvm/CodeGen/Passes.h"
26#include "llvm/CodeGen/MachineFunctionPass.h"
27#include "llvm/CodeGen/MachineLoopInfo.h"
28#include "llvm/ADT/SparseBitVector.h"
29#include "llvm/ADT/DenseMap.h"
30#include "llvm/ADT/IndexedMap.h"
31#include "llvm/Target/TargetRegisterInfo.h"
32
33namespace llvm {
34  class RegScavenger;
35  class MachineBasicBlock;
36
37  class PEI : public MachineFunctionPass {
38  public:
39    static char ID;
40    PEI() : MachineFunctionPass(&ID) {}
41
42    const char *getPassName() const {
43      return "Prolog/Epilog Insertion & Frame Finalization";
44    }
45
46    virtual void getAnalysisUsage(AnalysisUsage &AU) const;
47
48    /// runOnMachineFunction - Insert prolog/epilog code and replace abstract
49    /// frame indexes with appropriate references.
50    ///
51    bool runOnMachineFunction(MachineFunction &Fn);
52
53  private:
54    RegScavenger *RS;
55
56    // MinCSFrameIndex, MaxCSFrameIndex - Keeps the range of callee saved
57    // stack frame indexes.
58    unsigned MinCSFrameIndex, MaxCSFrameIndex;
59
60    // Analysis info for spill/restore placement.
61    // "CSR": "callee saved register".
62
63    // CSRegSet contains indices into the Callee Saved Register Info
64    // vector built by calculateCalleeSavedRegisters() and accessed
65    // via MF.getFrameInfo()->getCalleeSavedInfo().
66    typedef SparseBitVector<> CSRegSet;
67
68    // CSRegBlockMap maps MachineBasicBlocks to sets of callee
69    // saved register indices.
70    typedef DenseMap<MachineBasicBlock*, CSRegSet> CSRegBlockMap;
71
72    // Set and maps for computing CSR spill/restore placement:
73    //  used in function (UsedCSRegs)
74    //  used in a basic block (CSRUsed)
75    //  anticipatable in a basic block (Antic{In,Out})
76    //  available in a basic block (Avail{In,Out})
77    //  to be spilled at the entry to a basic block (CSRSave)
78    //  to be restored at the end of a basic block (CSRRestore)
79    CSRegSet UsedCSRegs;
80    CSRegBlockMap CSRUsed;
81    CSRegBlockMap AnticIn, AnticOut;
82    CSRegBlockMap AvailIn, AvailOut;
83    CSRegBlockMap CSRSave;
84    CSRegBlockMap CSRRestore;
85
86    // Entry and return blocks of the current function.
87    MachineBasicBlock* EntryBlock;
88    SmallVector<MachineBasicBlock*, 4> ReturnBlocks;
89
90    // Map of MBBs to top level MachineLoops.
91    DenseMap<MachineBasicBlock*, MachineLoop*> TLLoops;
92
93    // Flag to control shrink wrapping per-function:
94    // may choose to skip shrink wrapping for certain
95    // functions.
96    bool ShrinkWrapThisFunction;
97
98    // When using the scavenger post-pass to resolve frame reference
99    // materialization registers, maintain a map of the registers to
100    // the constant value and SP adjustment associated with it.
101    typedef std::pair<int, int> FrameConstantEntry;
102    IndexedMap<FrameConstantEntry, VirtReg2IndexFunctor> FrameConstantRegMap;
103
104#ifndef NDEBUG
105    // Machine function handle.
106    MachineFunction* MF;
107
108    // Flag indicating that the current function
109    // has at least one "short" path in the machine
110    // CFG from the entry block to an exit block.
111    bool HasFastExitPath;
112#endif
113
114    bool calculateSets(MachineFunction &Fn);
115    bool calcAnticInOut(MachineBasicBlock* MBB);
116    bool calcAvailInOut(MachineBasicBlock* MBB);
117    void calculateAnticAvail(MachineFunction &Fn);
118    bool addUsesForMEMERegion(MachineBasicBlock* MBB,
119                              SmallVector<MachineBasicBlock*, 4>& blks);
120    bool addUsesForTopLevelLoops(SmallVector<MachineBasicBlock*, 4>& blks);
121    bool calcSpillPlacements(MachineBasicBlock* MBB,
122                             SmallVector<MachineBasicBlock*, 4> &blks,
123                             CSRegBlockMap &prevSpills);
124    bool calcRestorePlacements(MachineBasicBlock* MBB,
125                               SmallVector<MachineBasicBlock*, 4> &blks,
126                               CSRegBlockMap &prevRestores);
127    void placeSpillsAndRestores(MachineFunction &Fn);
128    void placeCSRSpillsAndRestores(MachineFunction &Fn);
129    void calculateCallsInformation(MachineFunction &Fn);
130    void calculateCalleeSavedRegisters(MachineFunction &Fn);
131    void insertCSRSpillsAndRestores(MachineFunction &Fn);
132    void calculateFrameObjectOffsets(MachineFunction &Fn);
133    void replaceFrameIndices(MachineFunction &Fn);
134    void scavengeFrameVirtualRegs(MachineFunction &Fn);
135    void insertPrologEpilogCode(MachineFunction &Fn);
136
137    // Initialize DFA sets, called before iterations.
138    void clearAnticAvailSets();
139    // Clear all sets constructed by shrink wrapping.
140    void clearAllSets();
141
142    // Initialize all shrink wrapping data.
143    void initShrinkWrappingInfo();
144
145    // Convienences for dealing with machine loops.
146    MachineBasicBlock* getTopLevelLoopPreheader(MachineLoop* LP);
147    MachineLoop* getTopLevelLoopParent(MachineLoop *LP);
148
149    // Propgate CSRs used in MBB to all MBBs of loop LP.
150    void propagateUsesAroundLoop(MachineBasicBlock* MBB, MachineLoop* LP);
151
152    // Convenience for recognizing return blocks.
153    bool isReturnBlock(MachineBasicBlock* MBB);
154
155#ifndef NDEBUG
156    // Debugging methods.
157
158    // Mark this function as having fast exit paths.
159    void findFastExitPath();
160
161    // Verify placement of spills/restores.
162    void verifySpillRestorePlacement();
163
164    std::string getBasicBlockName(const MachineBasicBlock* MBB);
165    std::string stringifyCSRegSet(const CSRegSet& s);
166    void dumpSet(const CSRegSet& s);
167    void dumpUsed(MachineBasicBlock* MBB);
168    void dumpAllUsed();
169    void dumpSets(MachineBasicBlock* MBB);
170    void dumpSets1(MachineBasicBlock* MBB);
171    void dumpAllSets();
172    void dumpSRSets();
173#endif
174
175  };
176} // End llvm namespace
177#endif
178