LLVM  14.0.0git
LivePhysRegs.h
Go to the documentation of this file.
1 //===- llvm/CodeGen/LivePhysRegs.h - Live Physical Register Set -*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 /// \file
10 /// This file implements the LivePhysRegs utility for tracking liveness of
11 /// physical registers. This can be used for ad-hoc liveness tracking after
12 /// register allocation. You can start with the live-ins/live-outs at the
13 /// beginning/end of a block and update the information while walking the
14 /// instructions inside the block. This implementation tracks the liveness on a
15 /// sub-register granularity.
16 ///
17 /// We assume that the high bits of a physical super-register are not preserved
18 /// unless the instruction has an implicit-use operand reading the super-
19 /// register.
20 ///
21 /// X86 Example:
22 /// %ymm0 = ...
23 /// %xmm0 = ... (Kills %xmm0, all %xmm0s sub-registers, and %ymm0)
24 ///
25 /// %ymm0 = ...
26 /// %xmm0 = ..., implicit %ymm0 (%ymm0 and all its sub-registers are alive)
27 //===----------------------------------------------------------------------===//
28 
29 #ifndef LLVM_CODEGEN_LIVEPHYSREGS_H
30 #define LLVM_CODEGEN_LIVEPHYSREGS_H
31 
32 #include "llvm/ADT/SparseSet.h"
35 #include "llvm/MC/MCRegisterInfo.h"
36 #include <cassert>
37 #include <utility>
38 
39 namespace llvm {
40 
41 class MachineInstr;
42 class MachineOperand;
43 class MachineRegisterInfo;
44 class raw_ostream;
45 
46 /// A set of physical registers with utility functions to track liveness
47 /// when walking backward/forward through a basic block.
48 class LivePhysRegs {
49  const TargetRegisterInfo *TRI = nullptr;
51  RegisterSet LiveRegs;
52 
53 public:
54  /// Constructs an unitialized set. init() needs to be called to initialize it.
55  LivePhysRegs() = default;
56 
57  /// Constructs and initializes an empty set.
59  LiveRegs.setUniverse(TRI.getNumRegs());
60  }
61 
62  LivePhysRegs(const LivePhysRegs&) = delete;
63  LivePhysRegs &operator=(const LivePhysRegs&) = delete;
64 
65  /// (re-)initializes and clears the set.
66  void init(const TargetRegisterInfo &TRI) {
67  this->TRI = &TRI;
68  LiveRegs.clear();
69  LiveRegs.setUniverse(TRI.getNumRegs());
70  }
71 
72  /// Clears the set.
73  void clear() { LiveRegs.clear(); }
74 
75  /// Returns true if the set is empty.
76  bool empty() const { return LiveRegs.empty(); }
77 
78  /// Adds a physical register and all its sub-registers to the set.
80  assert(TRI && "LivePhysRegs is not initialized.");
81  assert(Reg <= TRI->getNumRegs() && "Expected a physical register.");
82  for (MCSubRegIterator SubRegs(Reg, TRI, /*IncludeSelf=*/true);
83  SubRegs.isValid(); ++SubRegs)
84  LiveRegs.insert(*SubRegs);
85  }
86 
87  /// Removes a physical register, all its sub-registers, and all its
88  /// super-registers from the set.
90  assert(TRI && "LivePhysRegs is not initialized.");
91  assert(Reg <= TRI->getNumRegs() && "Expected a physical register.");
92  for (MCRegAliasIterator R(Reg, TRI, true); R.isValid(); ++R)
93  LiveRegs.erase(*R);
94  }
95 
96  /// Removes physical registers clobbered by the regmask operand \p MO.
97  void removeRegsInMask(const MachineOperand &MO,
98  SmallVectorImpl<std::pair<MCPhysReg, const MachineOperand*>> *Clobbers =
99  nullptr);
100 
101  /// Returns true if register \p Reg is contained in the set. This also
102  /// works if only the super register of \p Reg has been defined, because
103  /// addReg() always adds all sub-registers to the set as well.
104  /// Note: Returns false if just some sub registers are live, use available()
105  /// when searching a free register.
106  bool contains(MCPhysReg Reg) const { return LiveRegs.count(Reg); }
107 
108  /// Returns true if register \p Reg and no aliasing register is in the set.
109  bool available(const MachineRegisterInfo &MRI, MCPhysReg Reg) const;
110 
111  /// Remove defined registers and regmask kills from the set.
112  void removeDefs(const MachineInstr &MI);
113 
114  /// Add uses to the set.
115  void addUses(const MachineInstr &MI);
116 
117  /// Simulates liveness when stepping backwards over an instruction(bundle).
118  /// Remove Defs, add uses. This is the recommended way of calculating
119  /// liveness.
120  void stepBackward(const MachineInstr &MI);
121 
122  /// Simulates liveness when stepping forward over an instruction(bundle).
123  /// Remove killed-uses, add defs. This is the not recommended way, because it
124  /// depends on accurate kill flags. If possible use stepBackward() instead of
125  /// this function. The clobbers set will be the list of registers either
126  /// defined or clobbered by a regmask. The operand will identify whether this
127  /// is a regmask or register operand.
128  void stepForward(const MachineInstr &MI,
129  SmallVectorImpl<std::pair<MCPhysReg, const MachineOperand*>> &Clobbers);
130 
131  /// Adds all live-in registers of basic block \p MBB.
132  /// Live in registers are the registers in the blocks live-in list and the
133  /// pristine registers.
134  void addLiveIns(const MachineBasicBlock &MBB);
135 
136  /// Adds all live-in registers of basic block \p MBB but skips pristine
137  /// registers.
139 
140  /// Adds all live-out registers of basic block \p MBB.
141  /// Live out registers are the union of the live-in registers of the successor
142  /// blocks and pristine registers. Live out registers of the end block are the
143  /// callee saved registers.
144  /// If a register is not added by this method, it is guaranteed to not be
145  /// live out from MBB, although a sub-register may be. This is true
146  /// both before and after regalloc.
147  void addLiveOuts(const MachineBasicBlock &MBB);
148 
149  /// Adds all live-out registers of basic block \p MBB but skips pristine
150  /// registers.
152 
154 
155  const_iterator begin() const { return LiveRegs.begin(); }
156  const_iterator end() const { return LiveRegs.end(); }
157 
158  /// Prints the currently live registers to \p OS.
159  void print(raw_ostream &OS) const;
160 
161  /// Dumps the currently live registers to the debug output.
162  void dump() const;
163 
164 private:
165  /// Adds live-in registers from basic block \p MBB, taking associated
166  /// lane masks into consideration.
167  void addBlockLiveIns(const MachineBasicBlock &MBB);
168 
169  /// Adds pristine registers. Pristine registers are callee saved registers
170  /// that are unused in the function.
171  void addPristines(const MachineFunction &MF);
172 };
173 
175  LR.print(OS);
176  return OS;
177 }
178 
179 /// Computes registers live-in to \p MBB assuming all of its successors
180 /// live-in lists are up-to-date. Puts the result into the given LivePhysReg
181 /// instance \p LiveRegs.
182 void computeLiveIns(LivePhysRegs &LiveRegs, const MachineBasicBlock &MBB);
183 
184 /// Recomputes dead and kill flags in \p MBB.
185 void recomputeLivenessFlags(MachineBasicBlock &MBB);
186 
187 /// Adds registers contained in \p LiveRegs to the block live-in list of \p MBB.
188 /// Does not add reserved registers.
189 void addLiveIns(MachineBasicBlock &MBB, const LivePhysRegs &LiveRegs);
190 
191 /// Convenience function combining computeLiveIns() and addLiveIns().
192 void computeAndAddLiveIns(LivePhysRegs &LiveRegs,
193  MachineBasicBlock &MBB);
194 
195 /// Convenience function for recomputing live-in's for \p MBB.
196 static inline void recomputeLiveIns(MachineBasicBlock &MBB) {
197  LivePhysRegs LPR;
198  MBB.clearLiveIns();
200 }
201 
202 } // end namespace llvm
203 
204 #endif // LLVM_CODEGEN_LIVEPHYSREGS_H
MI
IRTranslator LLVM IR MI
Definition: IRTranslator.cpp:102
llvm::LivePhysRegs::removeDefs
void removeDefs(const MachineInstr &MI)
Remove defined registers and regmask kills from the set.
Definition: LivePhysRegs.cpp:45
llvm::SparseSet< MCPhysReg, identity< MCPhysReg > >::const_iterator
typename DenseT::const_iterator const_iterator
Definition: SparseSet.h:172
llvm::LivePhysRegs::LivePhysRegs
LivePhysRegs()=default
Constructs an unitialized set. init() needs to be called to initialize it.
llvm
---------------------— PointerInfo ------------------------------------—
Definition: AllocatorList.h:23
llvm::LivePhysRegs::removeReg
void removeReg(MCPhysReg Reg)
Removes a physical register, all its sub-registers, and all its super-registers from the set.
Definition: LivePhysRegs.h:89
Reg
unsigned Reg
Definition: MachineSink.cpp:1566
llvm::computeLiveIns
void computeLiveIns(LivePhysRegs &LiveRegs, const MachineBasicBlock &MBB)
Computes registers live-in to MBB assuming all of its successors live-in lists are up-to-date.
Definition: LivePhysRegs.cpp:246
llvm::LivePhysRegs::addReg
void addReg(MCPhysReg Reg)
Adds a physical register and all its sub-registers to the set.
Definition: LivePhysRegs.h:79
llvm::LivePhysRegs::dump
void dump() const
Dumps the currently live registers to the debug output.
Definition: LivePhysRegs.cpp:134
llvm::MachineRegisterInfo
MachineRegisterInfo - Keep track of information for virtual and physical registers,...
Definition: MachineRegisterInfo.h:52
llvm::recomputeLivenessFlags
void recomputeLivenessFlags(MachineBasicBlock &MBB)
Recomputes dead and kill flags in MBB.
Definition: LivePhysRegs.cpp:279
llvm::LivePhysRegs::addLiveInsNoPristines
void addLiveInsNoPristines(const MachineBasicBlock &MBB)
Adds all live-in registers of basic block MBB but skips pristine registers.
Definition: LivePhysRegs.cpp:242
llvm::recomputeLiveIns
static void recomputeLiveIns(MachineBasicBlock &MBB)
Convenience function for recomputing live-in's for MBB.
Definition: LivePhysRegs.h:196
MachineBasicBlock.h
llvm::SparseSet::begin
const_iterator begin() const
Definition: SparseSet.h:174
llvm::LivePhysRegs::removeRegsInMask
void removeRegsInMask(const MachineOperand &MO, SmallVectorImpl< std::pair< MCPhysReg, const MachineOperand * >> *Clobbers=nullptr)
Removes physical registers clobbered by the regmask operand MO.
Definition: LivePhysRegs.cpp:31
llvm::LivePhysRegs
A set of physical registers with utility functions to track liveness when walking backward/forward th...
Definition: LivePhysRegs.h:48
llvm::TargetRegisterInfo
TargetRegisterInfo base class - We assume that the target defines a static array of TargetRegisterDes...
Definition: TargetRegisterInfo.h:231
llvm::LivePhysRegs::contains
bool contains(MCPhysReg Reg) const
Returns true if register Reg is contained in the set.
Definition: LivePhysRegs.h:106
llvm::addLiveIns
void addLiveIns(MachineBasicBlock &MBB, const LivePhysRegs &LiveRegs)
Adds registers contained in LiveRegs to the block live-in list of MBB.
Definition: LivePhysRegs.cpp:257
llvm::LivePhysRegs::empty
bool empty() const
Returns true if the set is empty.
Definition: LivePhysRegs.h:76
TRI
unsigned const TargetRegisterInfo * TRI
Definition: MachineSink.cpp:1567
llvm::LivePhysRegs::begin
const_iterator begin() const
Definition: LivePhysRegs.h:155
llvm::SparseSet::end
const_iterator end() const
Definition: SparseSet.h:175
llvm::LivePhysRegs::addLiveIns
void addLiveIns(const MachineBasicBlock &MBB)
Adds all live-in registers of basic block MBB.
Definition: LivePhysRegs.cpp:236
llvm::LivePhysRegs::addLiveOuts
void addLiveOuts(const MachineBasicBlock &MBB)
Adds all live-out registers of basic block MBB.
Definition: LivePhysRegs.cpp:230
llvm::MachineOperand
MachineOperand class - Representation of each machine instruction operand.
Definition: MachineOperand.h:49
llvm::raw_ostream
This class implements an extremely fast bulk output stream that can only output to a stream.
Definition: raw_ostream.h:53
llvm::operator<<
raw_ostream & operator<<(raw_ostream &OS, const APFixedPoint &FX)
Definition: APFixedPoint.h:230
llvm::computeAndAddLiveIns
void computeAndAddLiveIns(LivePhysRegs &LiveRegs, MachineBasicBlock &MBB)
Convenience function combining computeLiveIns() and addLiveIns().
Definition: LivePhysRegs.cpp:339
llvm::MachineBasicBlock
Definition: MachineBasicBlock.h:95
llvm::LivePhysRegs::stepBackward
void stepBackward(const MachineInstr &MI)
Simulates liveness when stepping backwards over an instruction(bundle).
Definition: LivePhysRegs.cpp:68
llvm::MachineInstr
Representation of each machine instruction.
Definition: MachineInstr.h:64
llvm::SparseSet::clear
void clear()
clear - Clears the set.
Definition: SparseSet.h:194
llvm::LivePhysRegs::addUses
void addUses(const MachineInstr &MI)
Add uses to the set.
Definition: LivePhysRegs.cpp:58
llvm::LivePhysRegs::available
bool available(const MachineRegisterInfo &MRI, MCPhysReg Reg) const
Returns true if register Reg and no aliasing register is in the set.
Definition: LivePhysRegs.cpp:139
MCRegisterInfo.h
llvm::SparseSet::setUniverse
void setUniverse(unsigned U)
setUniverse - Set the universe size which determines the largest key the set can hold.
Definition: SparseSet.h:155
assert
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
llvm::LivePhysRegs::print
void print(raw_ostream &OS) const
Prints the currently live registers to OS.
Definition: LivePhysRegs.cpp:116
llvm::LivePhysRegs::operator=
LivePhysRegs & operator=(const LivePhysRegs &)=delete
llvm::MachineFunction
Definition: MachineFunction.h:230
llvm::LivePhysRegs::init
void init(const TargetRegisterInfo &TRI)
(re-)initializes and clears the set.
Definition: LivePhysRegs.h:66
llvm::SparseSet::empty
bool empty() const
empty - Returns true if the set is empty.
Definition: SparseSet.h:183
llvm::LivePhysRegs::stepForward
void stepForward(const MachineInstr &MI, SmallVectorImpl< std::pair< MCPhysReg, const MachineOperand * >> &Clobbers)
Simulates liveness when stepping forward over an instruction(bundle).
Definition: LivePhysRegs.cpp:80
SparseSet.h
llvm::LivePhysRegs::const_iterator
RegisterSet::const_iterator const_iterator
Definition: LivePhysRegs.h:153
MRI
unsigned const MachineRegisterInfo * MRI
Definition: AArch64AdvSIMDScalarPass.cpp:105
llvm::LivePhysRegs::LivePhysRegs
LivePhysRegs(const TargetRegisterInfo &TRI)
Constructs and initializes an empty set.
Definition: LivePhysRegs.h:58
MBB
MachineBasicBlock & MBB
Definition: AArch64SLSHardening.cpp:74
llvm::LivePhysRegs::addLiveOutsNoPristines
void addLiveOutsNoPristines(const MachineBasicBlock &MBB)
Adds all live-out registers of basic block MBB but skips pristine registers.
Definition: LivePhysRegs.cpp:207
llvm::SparseSet::insert
std::pair< iterator, bool > insert(const ValueT &Val)
insert - Attempts to insert a new element.
Definition: SparseSet.h:252
uint16_t
llvm::SparseSet::count
size_type count(const KeyT &Key) const
count - Returns 1 if this set contains an element identified by Key, 0 otherwise.
Definition: SparseSet.h:240
llvm::SparseSet::erase
iterator erase(iterator I)
erase - Erases an existing element identified by a valid iterator.
Definition: SparseSet.h:288
llvm::MCSubRegIterator
MCSubRegIterator enumerates all sub-registers of Reg.
Definition: MCRegisterInfo.h:594
llvm::LivePhysRegs::clear
void clear()
Clears the set.
Definition: LivePhysRegs.h:73
llvm::MCRegisterInfo::DiffListIterator::isValid
bool isValid() const
isValid - returns true if this iterator is not yet at the end.
Definition: MCRegisterInfo.h:224
llvm::MachineBasicBlock::clearLiveIns
void clearLiveIns()
Clear live in list.
Definition: MachineBasicBlock.cpp:1596
llvm::SmallVectorImpl
This class consists of common code factored out of the SmallVector class to reduce code duplication b...
Definition: APFloat.h:43
llvm::SparseSet< MCPhysReg, identity< MCPhysReg > >
TargetRegisterInfo.h
llvm::LivePhysRegs::end
const_iterator end() const
Definition: LivePhysRegs.h:156
llvm::MCRegAliasIterator
MCRegAliasIterator enumerates all registers aliasing Reg.
Definition: MCRegisterInfo.h:780