blob: 8c547cdcff334f76f690926b6742c5a04770a23e [file] [log] [blame]
Jakob Stoklund Olesend4900a62010-11-30 02:17:10 +00001//===- LiveDebugVariables.cpp - Tracking debug info variables -------------===//
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 implements the LiveDebugVariables analysis.
11//
12// Remove all DBG_VALUE instructions referencing virtual registers and replace
13// them with a data structure tracking where live user variables are kept - in a
14// virtual register or in a stack slot.
15//
16// Allow the data structure to be updated during register allocation when values
17// are moved between registers and stack slots. Finally emit new DBG_VALUE
18// instructions after register allocation is complete.
19//
20//===----------------------------------------------------------------------===//
21
22#include "LiveDebugVariables.h"
Eugene Zelenko5df3d892017-08-24 21:21:39 +000023#include "llvm/ADT/ArrayRef.h"
24#include "llvm/ADT/DenseMap.h"
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +000025#include "llvm/ADT/IntervalMap.h"
Eugene Zelenko5df3d892017-08-24 21:21:39 +000026#include "llvm/ADT/STLExtras.h"
Robert Lougher10f740d2017-08-03 11:54:02 +000027#include "llvm/ADT/SmallSet.h"
Eugene Zelenko5df3d892017-08-24 21:21:39 +000028#include "llvm/ADT/SmallVector.h"
Devang Patelb4568662011-08-04 18:45:38 +000029#include "llvm/ADT/Statistic.h"
Eugene Zelenko5df3d892017-08-24 21:21:39 +000030#include "llvm/ADT/StringRef.h"
Robert Lougher10f740d2017-08-03 11:54:02 +000031#include "llvm/CodeGen/LexicalScopes.h"
Eugene Zelenko5df3d892017-08-24 21:21:39 +000032#include "llvm/CodeGen/LiveInterval.h"
Matthias Braunf8422972017-12-13 02:51:04 +000033#include "llvm/CodeGen/LiveIntervals.h"
Eugene Zelenko5df3d892017-08-24 21:21:39 +000034#include "llvm/CodeGen/MachineBasicBlock.h"
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +000035#include "llvm/CodeGen/MachineDominators.h"
Jakob Stoklund Olesenafc2bc22010-12-03 21:47:10 +000036#include "llvm/CodeGen/MachineFunction.h"
Eugene Zelenko5df3d892017-08-24 21:21:39 +000037#include "llvm/CodeGen/MachineInstr.h"
Jakob Stoklund Olesenafc2bc22010-12-03 21:47:10 +000038#include "llvm/CodeGen/MachineInstrBuilder.h"
Eugene Zelenko5df3d892017-08-24 21:21:39 +000039#include "llvm/CodeGen/MachineOperand.h"
Jakob Stoklund Olesen816f5f42011-03-18 21:42:19 +000040#include "llvm/CodeGen/MachineRegisterInfo.h"
Eugene Zelenko5df3d892017-08-24 21:21:39 +000041#include "llvm/CodeGen/SlotIndexes.h"
David Blaikie3f833ed2017-11-08 01:01:31 +000042#include "llvm/CodeGen/TargetInstrInfo.h"
David Blaikieb3bde2e2017-11-17 01:07:10 +000043#include "llvm/CodeGen/TargetOpcodes.h"
44#include "llvm/CodeGen/TargetRegisterInfo.h"
45#include "llvm/CodeGen/TargetSubtargetInfo.h"
Jakob Stoklund Olesen26c9d702012-11-28 19:13:06 +000046#include "llvm/CodeGen/VirtRegMap.h"
Eugene Zelenko5df3d892017-08-24 21:21:39 +000047#include "llvm/IR/DebugInfoMetadata.h"
48#include "llvm/IR/DebugLoc.h"
49#include "llvm/IR/Function.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000050#include "llvm/IR/Metadata.h"
Eugene Zelenko5df3d892017-08-24 21:21:39 +000051#include "llvm/MC/MCRegisterInfo.h"
52#include "llvm/Pass.h"
53#include "llvm/Support/Casting.h"
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +000054#include "llvm/Support/CommandLine.h"
Eugene Zelenko5df3d892017-08-24 21:21:39 +000055#include "llvm/Support/Compiler.h"
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +000056#include "llvm/Support/Debug.h"
Benjamin Kramer799003b2015-03-23 19:32:43 +000057#include "llvm/Support/raw_ostream.h"
Eugene Zelenko5df3d892017-08-24 21:21:39 +000058#include <algorithm>
59#include <cassert>
60#include <iterator>
David Blaikie2b1dfa72014-04-21 20:37:07 +000061#include <memory>
Benjamin Kramer82de7d32016-05-27 14:27:24 +000062#include <utility>
David Blaikie2b1dfa72014-04-21 20:37:07 +000063
Jakob Stoklund Olesend4900a62010-11-30 02:17:10 +000064using namespace llvm;
65
Matthias Braun1527baa2017-05-25 21:26:32 +000066#define DEBUG_TYPE "livedebugvars"
Chandler Carruth1b9dde02014-04-22 02:02:50 +000067
Devang Patelacbee0b2011-01-07 22:33:41 +000068static cl::opt<bool>
Jakob Stoklund Olesen74ded572011-01-12 23:36:21 +000069EnableLDV("live-debug-variables", cl::init(true),
Devang Patelacbee0b2011-01-07 22:33:41 +000070 cl::desc("Enable the live debug variables pass"), cl::Hidden);
71
Devang Patelb4568662011-08-04 18:45:38 +000072STATISTIC(NumInsertedDebugValues, "Number of DBG_VALUEs inserted");
Eugene Zelenko5df3d892017-08-24 21:21:39 +000073
Jakob Stoklund Olesend4900a62010-11-30 02:17:10 +000074char LiveDebugVariables::ID = 0;
75
Matthias Braun1527baa2017-05-25 21:26:32 +000076INITIALIZE_PASS_BEGIN(LiveDebugVariables, DEBUG_TYPE,
Jakob Stoklund Olesend4900a62010-11-30 02:17:10 +000077 "Debug Variable Analysis", false, false)
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +000078INITIALIZE_PASS_DEPENDENCY(MachineDominatorTree)
Jakob Stoklund Olesend4900a62010-11-30 02:17:10 +000079INITIALIZE_PASS_DEPENDENCY(LiveIntervals)
Matthias Braun1527baa2017-05-25 21:26:32 +000080INITIALIZE_PASS_END(LiveDebugVariables, DEBUG_TYPE,
Jakob Stoklund Olesend4900a62010-11-30 02:17:10 +000081 "Debug Variable Analysis", false, false)
82
83void LiveDebugVariables::getAnalysisUsage(AnalysisUsage &AU) const {
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +000084 AU.addRequired<MachineDominatorTree>();
Jakob Stoklund Olesend4900a62010-11-30 02:17:10 +000085 AU.addRequiredTransitive<LiveIntervals>();
86 AU.setPreservesAll();
87 MachineFunctionPass::getAnalysisUsage(AU);
88}
89
Eugene Zelenko5df3d892017-08-24 21:21:39 +000090LiveDebugVariables::LiveDebugVariables() : MachineFunctionPass(ID) {
Jakob Stoklund Olesend4900a62010-11-30 02:17:10 +000091 initializeLiveDebugVariablesPass(*PassRegistry::getPassRegistry());
92}
93
Reid Kleckner04e25e02017-10-03 17:59:02 +000094enum : unsigned { UndefLocNo = ~0U };
95
96/// Describes a location by number along with some flags about the original
97/// usage of the location.
98class DbgValueLocation {
99public:
100 DbgValueLocation(unsigned LocNo, bool WasIndirect)
101 : LocNo(LocNo), WasIndirect(WasIndirect) {
102 static_assert(sizeof(*this) == sizeof(unsigned), "bad bitfield packing");
103 assert(locNo() == LocNo && "location truncation");
104 }
105
106 DbgValueLocation() : LocNo(0), WasIndirect(0) {}
107
108 unsigned locNo() const {
109 // Fix up the undef location number, which gets truncated.
110 return LocNo == INT_MAX ? UndefLocNo : LocNo;
111 }
112 bool wasIndirect() const { return WasIndirect; }
113 bool isUndef() const { return locNo() == UndefLocNo; }
114
115 DbgValueLocation changeLocNo(unsigned NewLocNo) const {
116 return DbgValueLocation(NewLocNo, WasIndirect);
117 }
118
Reid Klecknerb4569de72017-10-03 18:30:11 +0000119 friend inline bool operator==(const DbgValueLocation &LHS,
120 const DbgValueLocation &RHS) {
121 return LHS.LocNo == RHS.LocNo && LHS.WasIndirect == RHS.WasIndirect;
Reid Kleckner04e25e02017-10-03 17:59:02 +0000122 }
Reid Klecknerb4569de72017-10-03 18:30:11 +0000123
124 friend inline bool operator!=(const DbgValueLocation &LHS,
125 const DbgValueLocation &RHS) {
126 return !(LHS == RHS);
127 }
Reid Kleckner04e25e02017-10-03 17:59:02 +0000128
129private:
130 unsigned LocNo : 31;
131 unsigned WasIndirect : 1;
132};
133
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000134/// LocMap - Map of where a user value is live, and its location.
Reid Kleckner04e25e02017-10-03 17:59:02 +0000135using LocMap = IntervalMap<SlotIndex, DbgValueLocation, 4>;
Eugene Zelenko5df3d892017-08-24 21:21:39 +0000136
137namespace {
138
139class LDVImpl;
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000140
141/// UserValue - A user value is a part of a debug info user variable.
142///
143/// A DBG_VALUE instruction notes that (a sub-register of) a virtual register
144/// holds part of a user variable. The part is identified by a byte offset.
145///
146/// UserValues are grouped into equivalence classes for easier searching. Two
147/// user values are related if they refer to the same variable, or if they are
148/// held by the same virtual register. The equivalence class is the transitive
149/// closure of that relation.
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000150class UserValue {
Reid Kleckner4e040282017-09-20 18:19:08 +0000151 const DILocalVariable *Variable; ///< The debug info variable we are part of.
152 const DIExpression *Expression; ///< Any complex address expression.
Devang Patel26ffa012011-02-04 01:43:25 +0000153 DebugLoc dl; ///< The debug location for the variable. This is
154 ///< used by dwarf writer to find lexical scope.
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000155 UserValue *leader; ///< Equivalence class leader.
Eugene Zelenko5df3d892017-08-24 21:21:39 +0000156 UserValue *next = nullptr; ///< Next value in equivalence class, or null.
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000157
158 /// Numbered locations referenced by locmap.
Jakob Stoklund Olesen9adf5e02011-01-09 05:33:21 +0000159 SmallVector<MachineOperand, 4> locations;
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000160
161 /// Map of slot indices where this value is live.
162 LocMap locInts;
163
Robert Lougher10f740d2017-08-03 11:54:02 +0000164 /// Set of interval start indexes that have been trimmed to the
165 /// lexical scope.
166 SmallSet<SlotIndex, 2> trimmedDefs;
167
Jakob Stoklund Olesenafc2bc22010-12-03 21:47:10 +0000168 /// insertDebugValue - Insert a DBG_VALUE into MBB at Idx for LocNo.
Karl-Johan Karlsson8d8d2012017-10-05 08:37:31 +0000169 void insertDebugValue(MachineBasicBlock *MBB, SlotIndex StartIdx,
170 SlotIndex StopIdx,
Reid Kleckner04e25e02017-10-03 17:59:02 +0000171 DbgValueLocation Loc, bool Spilled, LiveIntervals &LIS,
Karl-Johan Karlsson8d8d2012017-10-05 08:37:31 +0000172 const TargetInstrInfo &TII,
173 const TargetRegisterInfo &TRI);
Jakob Stoklund Olesenafc2bc22010-12-03 21:47:10 +0000174
Jakob Stoklund Olesenf8da0282011-05-06 18:00:02 +0000175 /// splitLocation - Replace OldLocNo ranges with NewRegs ranges where NewRegs
176 /// is live. Returns true if any changes were made.
Mark Laceyf9ea8852013-08-14 23:50:04 +0000177 bool splitLocation(unsigned OldLocNo, ArrayRef<unsigned> NewRegs,
178 LiveIntervals &LIS);
Jakob Stoklund Olesenf8da0282011-05-06 18:00:02 +0000179
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000180public:
181 /// UserValue - Create a new UserValue.
Reid Kleckner04e25e02017-10-03 17:59:02 +0000182 UserValue(const DILocalVariable *var, const DIExpression *expr, DebugLoc L,
183 LocMap::Allocator &alloc)
184 : Variable(var), Expression(expr), dl(std::move(L)), leader(this),
185 locInts(alloc) {}
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000186
187 /// getLeader - Get the leader of this value's equivalence class.
188 UserValue *getLeader() {
189 UserValue *l = leader;
190 while (l != l->leader)
191 l = l->leader;
192 return leader = l;
193 }
194
195 /// getNext - Return the next UserValue in the equivalence class.
196 UserValue *getNext() const { return next; }
197
Devang Patel338e4322011-07-06 23:09:51 +0000198 /// match - Does this UserValue match the parameters?
Reid Kleckner4e040282017-09-20 18:19:08 +0000199 bool match(const DILocalVariable *Var, const DIExpression *Expr,
Reid Kleckner04e25e02017-10-03 17:59:02 +0000200 const DILocation *IA) const {
201 // FIXME: The fragment should be part of the equivalence class, but not
202 // other things in the expression like stack values.
203 return Var == Variable && Expr == Expression && dl->getInlinedAt() == IA;
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000204 }
205
206 /// merge - Merge equivalence classes.
207 static UserValue *merge(UserValue *L1, UserValue *L2) {
208 L2 = L2->getLeader();
209 if (!L1)
210 return L2;
211 L1 = L1->getLeader();
212 if (L1 == L2)
213 return L1;
214 // Splice L2 before L1's members.
215 UserValue *End = L2;
Richard Trieu7a083812016-02-18 22:09:30 +0000216 while (End->next) {
217 End->leader = L1;
218 End = End->next;
219 }
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000220 End->leader = L1;
221 End->next = L1->next;
222 L1->next = L2;
223 return L1;
224 }
225
226 /// getLocationNo - Return the location number that matches Loc.
Jakob Stoklund Olesen9adf5e02011-01-09 05:33:21 +0000227 unsigned getLocationNo(const MachineOperand &LocMO) {
Jakob Stoklund Olesen816f5f42011-03-18 21:42:19 +0000228 if (LocMO.isReg()) {
229 if (LocMO.getReg() == 0)
Reid Klecknereed09732017-09-15 22:08:50 +0000230 return UndefLocNo;
Jakob Stoklund Olesen816f5f42011-03-18 21:42:19 +0000231 // For register locations we dont care about use/def and other flags.
232 for (unsigned i = 0, e = locations.size(); i != e; ++i)
233 if (locations[i].isReg() &&
234 locations[i].getReg() == LocMO.getReg() &&
235 locations[i].getSubReg() == LocMO.getSubReg())
236 return i;
237 } else
238 for (unsigned i = 0, e = locations.size(); i != e; ++i)
239 if (LocMO.isIdenticalTo(locations[i]))
240 return i;
Jakob Stoklund Olesen9adf5e02011-01-09 05:33:21 +0000241 locations.push_back(LocMO);
242 // We are storing a MachineOperand outside a MachineInstr.
243 locations.back().clearParent();
Jakob Stoklund Olesen816f5f42011-03-18 21:42:19 +0000244 // Don't store def operands.
Geoff Berryb3d126d2017-12-29 21:01:09 +0000245 if (locations.back().isReg()) {
246 if (locations.back().isDef())
247 locations.back().setIsDead(false);
Jakob Stoklund Olesen816f5f42011-03-18 21:42:19 +0000248 locations.back().setIsUse();
Geoff Berryb3d126d2017-12-29 21:01:09 +0000249 }
Jakob Stoklund Olesen9adf5e02011-01-09 05:33:21 +0000250 return locations.size() - 1;
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000251 }
252
Jakob Stoklund Olesen816f5f42011-03-18 21:42:19 +0000253 /// mapVirtRegs - Ensure that all virtual register locations are mapped.
254 void mapVirtRegs(LDVImpl *LDV);
255
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000256 /// addDef - Add a definition point to this value.
Reid Kleckner04e25e02017-10-03 17:59:02 +0000257 void addDef(SlotIndex Idx, const MachineOperand &LocMO, bool IsIndirect) {
258 DbgValueLocation Loc(getLocationNo(LocMO), IsIndirect);
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000259 // Add a singular (Idx,Idx) -> Loc mapping.
260 LocMap::iterator I = locInts.find(Idx);
261 if (!I.valid() || I.start() != Idx)
Reid Kleckner04e25e02017-10-03 17:59:02 +0000262 I.insert(Idx, Idx.getNextSlot(), Loc);
Jakob Stoklund Olesen2539af62011-08-03 23:44:31 +0000263 else
264 // A later DBG_VALUE at the same SlotIndex overrides the old location.
Reid Kleckner04e25e02017-10-03 17:59:02 +0000265 I.setValue(Loc);
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000266 }
267
Adrian Prantlf8d10ce2016-09-28 21:34:23 +0000268 /// extendDef - Extend the current definition as far as possible down.
269 /// Stop when meeting an existing def or when leaving the live
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000270 /// range of VNI.
Jakob Stoklund Olesen816f5f42011-03-18 21:42:19 +0000271 /// End points where VNI is no longer live are added to Kills.
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000272 /// @param Idx Starting point for the definition.
Reid Kleckner04e25e02017-10-03 17:59:02 +0000273 /// @param Loc Location number to propagate.
Matthias Braun34e1be92013-10-10 21:29:02 +0000274 /// @param LR Restrict liveness to where LR has the value VNI. May be null.
275 /// @param VNI When LR is not null, this is the value to restrict to.
Jakob Stoklund Olesen816f5f42011-03-18 21:42:19 +0000276 /// @param Kills Append end points of VNI's live range to Kills.
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000277 /// @param LIS Live intervals analysis.
Reid Kleckner04e25e02017-10-03 17:59:02 +0000278 void extendDef(SlotIndex Idx, DbgValueLocation Loc,
Matthias Braun34e1be92013-10-10 21:29:02 +0000279 LiveRange *LR, const VNInfo *VNI,
Jakob Stoklund Olesen816f5f42011-03-18 21:42:19 +0000280 SmallVectorImpl<SlotIndex> *Kills,
Adrian Prantlf8d10ce2016-09-28 21:34:23 +0000281 LiveIntervals &LIS);
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000282
Jakob Stoklund Olesen816f5f42011-03-18 21:42:19 +0000283 /// addDefsFromCopies - The value in LI/LocNo may be copies to other
284 /// registers. Determine if any of the copies are available at the kill
285 /// points, and add defs if possible.
286 /// @param LI Scan for copies of the value in LI->reg.
287 /// @param LocNo Location number of LI->reg.
Reid Kleckner04e25e02017-10-03 17:59:02 +0000288 /// @param WasIndirect Indicates if the original use of LI->reg was indirect
Jakob Stoklund Olesen816f5f42011-03-18 21:42:19 +0000289 /// @param Kills Points where the range of LocNo could be extended.
290 /// @param NewDefs Append (Idx, LocNo) of inserted defs here.
Reid Kleckner04e25e02017-10-03 17:59:02 +0000291 void addDefsFromCopies(
292 LiveInterval *LI, unsigned LocNo, bool WasIndirect,
293 const SmallVectorImpl<SlotIndex> &Kills,
294 SmallVectorImpl<std::pair<SlotIndex, DbgValueLocation>> &NewDefs,
295 MachineRegisterInfo &MRI, LiveIntervals &LIS);
Jakob Stoklund Olesen816f5f42011-03-18 21:42:19 +0000296
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000297 /// computeIntervals - Compute the live intervals of all locations after
298 /// collecting all their def points.
Jakob Stoklund Olesen32449632012-06-22 17:15:32 +0000299 void computeIntervals(MachineRegisterInfo &MRI, const TargetRegisterInfo &TRI,
Robert Lougher10f740d2017-08-03 11:54:02 +0000300 LiveIntervals &LIS, LexicalScopes &LS);
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000301
Jakob Stoklund Olesenf8da0282011-05-06 18:00:02 +0000302 /// splitRegister - Replace OldReg ranges with NewRegs ranges where NewRegs is
303 /// live. Returns true if any changes were made.
Mark Laceyf9ea8852013-08-14 23:50:04 +0000304 bool splitRegister(unsigned OldLocNo, ArrayRef<unsigned> NewRegs,
305 LiveIntervals &LIS);
Jakob Stoklund Olesenf8da0282011-05-06 18:00:02 +0000306
Jakob Stoklund Olesenafc2bc22010-12-03 21:47:10 +0000307 /// rewriteLocations - Rewrite virtual register locations according to the
Reid Kleckner4e040282017-09-20 18:19:08 +0000308 /// provided virtual register map. Record which locations were spilled.
309 void rewriteLocations(VirtRegMap &VRM, const TargetRegisterInfo &TRI,
310 BitVector &SpilledLocations);
Jakob Stoklund Olesenafc2bc22010-12-03 21:47:10 +0000311
Eric Christopherbc671702013-02-13 02:29:18 +0000312 /// emitDebugValues - Recreate DBG_VALUE instruction from data structures.
Reid Kleckner4e040282017-09-20 18:19:08 +0000313 void emitDebugValues(VirtRegMap *VRM, LiveIntervals &LIS,
Karl-Johan Karlsson8d8d2012017-10-05 08:37:31 +0000314 const TargetInstrInfo &TII,
315 const TargetRegisterInfo &TRI,
Reid Kleckner4e040282017-09-20 18:19:08 +0000316 const BitVector &SpilledLocations);
Jakob Stoklund Olesenafc2bc22010-12-03 21:47:10 +0000317
Devang Patelf9e2ae92011-09-13 18:40:53 +0000318 /// getDebugLoc - Return DebugLoc of this UserValue.
319 DebugLoc getDebugLoc() { return dl;}
Eugene Zelenko5df3d892017-08-24 21:21:39 +0000320
Eric Christopher1cdefae2015-02-27 00:11:34 +0000321 void print(raw_ostream &, const TargetRegisterInfo *);
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000322};
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000323
324/// LDVImpl - Implementation of the LiveDebugVariables pass.
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000325class LDVImpl {
326 LiveDebugVariables &pass;
327 LocMap::Allocator allocator;
Eugene Zelenko5df3d892017-08-24 21:21:39 +0000328 MachineFunction *MF = nullptr;
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000329 LiveIntervals *LIS;
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000330 const TargetRegisterInfo *TRI;
331
Manman Ren7a4c8a72013-02-13 20:23:48 +0000332 /// Whether emitDebugValues is called.
Eugene Zelenko5df3d892017-08-24 21:21:39 +0000333 bool EmitDone = false;
334
Manman Ren7a4c8a72013-02-13 20:23:48 +0000335 /// Whether the machine function is modified during the pass.
Eugene Zelenko5df3d892017-08-24 21:21:39 +0000336 bool ModifiedMF = false;
Manman Ren7a4c8a72013-02-13 20:23:48 +0000337
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000338 /// userValues - All allocated UserValue instances.
David Blaikie2b1dfa72014-04-21 20:37:07 +0000339 SmallVector<std::unique_ptr<UserValue>, 8> userValues;
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000340
341 /// Map virtual register to eq class leader.
Eugene Zelenko5df3d892017-08-24 21:21:39 +0000342 using VRMap = DenseMap<unsigned, UserValue *>;
Jakob Stoklund Olesen922e1fa2010-12-03 22:25:09 +0000343 VRMap virtRegToEqClass;
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000344
345 /// Map user variable to eq class leader.
Reid Kleckner4e040282017-09-20 18:19:08 +0000346 using UVMap = DenseMap<const DILocalVariable *, UserValue *>;
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000347 UVMap userVarMap;
348
349 /// getUserValue - Find or create a UserValue.
Reid Kleckner4e040282017-09-20 18:19:08 +0000350 UserValue *getUserValue(const DILocalVariable *Var, const DIExpression *Expr,
Reid Kleckner04e25e02017-10-03 17:59:02 +0000351 const DebugLoc &DL);
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000352
Jakob Stoklund Olesen9ec20112010-12-02 18:15:44 +0000353 /// lookupVirtReg - Find the EC leader for VirtReg or null.
354 UserValue *lookupVirtReg(unsigned VirtReg);
355
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000356 /// handleDebugValue - Add DBG_VALUE instruction to our maps.
357 /// @param MI DBG_VALUE instruction
358 /// @param Idx Last valid SLotIndex before instruction.
359 /// @return True if the DBG_VALUE instruction should be deleted.
Duncan P. N. Exon Smithfb612ac2016-06-30 23:13:38 +0000360 bool handleDebugValue(MachineInstr &MI, SlotIndex Idx);
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000361
362 /// collectDebugValues - Collect and erase all DBG_VALUE instructions, adding
363 /// a UserValue def for each instruction.
364 /// @param mf MachineFunction to be scanned.
365 /// @return True if any debug values were found.
366 bool collectDebugValues(MachineFunction &mf);
367
368 /// computeIntervals - Compute the live intervals of all user values after
369 /// collecting all their def points.
370 void computeIntervals();
371
372public:
Eugene Zelenko5df3d892017-08-24 21:21:39 +0000373 LDVImpl(LiveDebugVariables *ps) : pass(*ps) {}
374
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000375 bool runOnMachineFunction(MachineFunction &mf);
376
Manman Ren7a4c8a72013-02-13 20:23:48 +0000377 /// clear - Release all memory.
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000378 void clear() {
David Blaikie2f040112014-07-25 16:10:16 +0000379 MF = nullptr;
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000380 userValues.clear();
Jakob Stoklund Olesen922e1fa2010-12-03 22:25:09 +0000381 virtRegToEqClass.clear();
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000382 userVarMap.clear();
Manman Ren7a4c8a72013-02-13 20:23:48 +0000383 // Make sure we call emitDebugValues if the machine function was modified.
384 assert((!ModifiedMF || EmitDone) &&
385 "Dbg values are not emitted in LDV");
386 EmitDone = false;
387 ModifiedMF = false;
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000388 }
389
Jakob Stoklund Olesen816f5f42011-03-18 21:42:19 +0000390 /// mapVirtReg - Map virtual register to an equivalence class.
391 void mapVirtReg(unsigned VirtReg, UserValue *EC);
392
Jakob Stoklund Olesenf8da0282011-05-06 18:00:02 +0000393 /// splitRegister - Replace all references to OldReg with NewRegs.
Mark Laceyf9ea8852013-08-14 23:50:04 +0000394 void splitRegister(unsigned OldReg, ArrayRef<unsigned> NewRegs);
Jakob Stoklund Olesenf8da0282011-05-06 18:00:02 +0000395
Eric Christopherbc671702013-02-13 02:29:18 +0000396 /// emitDebugValues - Recreate DBG_VALUE instruction from data structures.
Jakob Stoklund Olesenafc2bc22010-12-03 21:47:10 +0000397 void emitDebugValues(VirtRegMap *VRM);
398
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000399 void print(raw_ostream&);
400};
Eugene Zelenko5df3d892017-08-24 21:21:39 +0000401
402} // end anonymous namespace
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000403
Aaron Ballman615eb472017-10-15 14:32:27 +0000404#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
Benjamin Kramerbdc49562016-06-12 15:39:02 +0000405static void printDebugLoc(const DebugLoc &DL, raw_ostream &CommentOS,
Duncan P. N. Exon Smith32e7f282015-04-14 02:09:32 +0000406 const LLVMContext &Ctx) {
407 if (!DL)
408 return;
409
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000410 auto *Scope = cast<DIScope>(DL.getScope());
Duncan P. N. Exon Smith32e7f282015-04-14 02:09:32 +0000411 // Omit the directory, because it's likely to be long and uninteresting.
Duncan P. N. Exon Smithb273d062015-04-16 01:37:00 +0000412 CommentOS << Scope->getFilename();
Duncan P. N. Exon Smith32e7f282015-04-14 02:09:32 +0000413 CommentOS << ':' << DL.getLine();
414 if (DL.getCol() != 0)
415 CommentOS << ':' << DL.getCol();
416
417 DebugLoc InlinedAtDL = DL.getInlinedAt();
418 if (!InlinedAtDL)
419 return;
420
421 CommentOS << " @[ ";
422 printDebugLoc(InlinedAtDL, CommentOS, Ctx);
423 CommentOS << " ]";
424}
425
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000426static void printExtendedName(raw_ostream &OS, const DILocalVariable *V,
427 const DILocation *DL) {
Duncan P. N. Exon Smith32e7f282015-04-14 02:09:32 +0000428 const LLVMContext &Ctx = V->getContext();
429 StringRef Res = V->getName();
430 if (!Res.empty())
431 OS << Res << "," << V->getLine();
Duncan P. N. Exon Smith62e0f452015-04-15 22:29:27 +0000432 if (auto *InlinedAt = DL->getInlinedAt()) {
Duncan P. N. Exon Smith32e7f282015-04-14 02:09:32 +0000433 if (DebugLoc InlinedAtDL = InlinedAt) {
434 OS << " @[";
435 printDebugLoc(InlinedAtDL, OS, Ctx);
436 OS << "]";
437 }
438 }
439}
440
Eric Christopher1cdefae2015-02-27 00:11:34 +0000441void UserValue::print(raw_ostream &OS, const TargetRegisterInfo *TRI) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000442 auto *DV = cast<DILocalVariable>(Variable);
Frederic Risse6bb1872014-08-07 20:04:00 +0000443 OS << "!\"";
Duncan P. N. Exon Smith62e0f452015-04-15 22:29:27 +0000444 printExtendedName(OS, DV, dl);
Duncan P. N. Exon Smith32e7f282015-04-14 02:09:32 +0000445
Devang Patel6c1ed312011-08-09 01:03:35 +0000446 OS << "\"\t";
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000447 for (LocMap::const_iterator I = locInts.begin(); I.valid(); ++I) {
448 OS << " [" << I.start() << ';' << I.stop() << "):";
Reid Kleckner04e25e02017-10-03 17:59:02 +0000449 if (I.value().isUndef())
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000450 OS << "undef";
Reid Kleckner04e25e02017-10-03 17:59:02 +0000451 else {
452 OS << I.value().locNo();
453 if (I.value().wasIndirect())
454 OS << " ind";
455 }
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000456 }
Jakob Stoklund Olesenc86fe052011-05-06 17:59:59 +0000457 for (unsigned i = 0, e = locations.size(); i != e; ++i) {
458 OS << " Loc" << i << '=';
Eric Christopher1cdefae2015-02-27 00:11:34 +0000459 locations[i].print(OS, TRI);
Jakob Stoklund Olesenc86fe052011-05-06 17:59:59 +0000460 }
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000461 OS << '\n';
462}
463
464void LDVImpl::print(raw_ostream &OS) {
465 OS << "********** DEBUG VARIABLES **********\n";
466 for (unsigned i = 0, e = userValues.size(); i != e; ++i)
Eric Christopher1cdefae2015-02-27 00:11:34 +0000467 userValues[i]->print(OS, TRI);
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000468}
Florian Hahn6b3216a2017-07-31 10:07:49 +0000469#endif
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000470
Jakob Stoklund Olesen816f5f42011-03-18 21:42:19 +0000471void UserValue::mapVirtRegs(LDVImpl *LDV) {
472 for (unsigned i = 0, e = locations.size(); i != e; ++i)
473 if (locations[i].isReg() &&
474 TargetRegisterInfo::isVirtualRegister(locations[i].getReg()))
475 LDV->mapVirtReg(locations[i].getReg(), this);
476}
477
Reid Kleckner4e040282017-09-20 18:19:08 +0000478UserValue *LDVImpl::getUserValue(const DILocalVariable *Var,
Reid Kleckner04e25e02017-10-03 17:59:02 +0000479 const DIExpression *Expr, const DebugLoc &DL) {
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000480 UserValue *&Leader = userVarMap[Var];
481 if (Leader) {
482 UserValue *UV = Leader->getLeader();
483 Leader = UV;
484 for (; UV; UV = UV->getNext())
Reid Kleckner04e25e02017-10-03 17:59:02 +0000485 if (UV->match(Var, Expr, DL->getInlinedAt()))
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000486 return UV;
487 }
488
David Blaikie2b1dfa72014-04-21 20:37:07 +0000489 userValues.push_back(
Reid Kleckner04e25e02017-10-03 17:59:02 +0000490 llvm::make_unique<UserValue>(Var, Expr, DL, allocator));
David Blaikie2b1dfa72014-04-21 20:37:07 +0000491 UserValue *UV = userValues.back().get();
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000492 Leader = UserValue::merge(Leader, UV);
493 return UV;
494}
495
496void LDVImpl::mapVirtReg(unsigned VirtReg, UserValue *EC) {
497 assert(TargetRegisterInfo::isVirtualRegister(VirtReg) && "Only map VirtRegs");
Jakob Stoklund Olesen922e1fa2010-12-03 22:25:09 +0000498 UserValue *&Leader = virtRegToEqClass[VirtReg];
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000499 Leader = UserValue::merge(Leader, EC);
500}
501
Jakob Stoklund Olesen9ec20112010-12-02 18:15:44 +0000502UserValue *LDVImpl::lookupVirtReg(unsigned VirtReg) {
Jakob Stoklund Olesen922e1fa2010-12-03 22:25:09 +0000503 if (UserValue *UV = virtRegToEqClass.lookup(VirtReg))
Jakob Stoklund Olesen9ec20112010-12-02 18:15:44 +0000504 return UV->getLeader();
Craig Topperc0196b12014-04-14 00:51:57 +0000505 return nullptr;
Jakob Stoklund Olesen9ec20112010-12-02 18:15:44 +0000506}
507
Duncan P. N. Exon Smithfb612ac2016-06-30 23:13:38 +0000508bool LDVImpl::handleDebugValue(MachineInstr &MI, SlotIndex Idx) {
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000509 // DBG_VALUE loc, offset, variable
Duncan P. N. Exon Smithfb612ac2016-06-30 23:13:38 +0000510 if (MI.getNumOperands() != 4 ||
511 !(MI.getOperand(1).isReg() || MI.getOperand(1).isImm()) ||
512 !MI.getOperand(2).isMetadata()) {
513 DEBUG(dbgs() << "Can't handle " << MI);
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000514 return false;
515 }
516
Bjorn Petterssonbdf0c002018-03-06 08:47:07 +0000517 // Detect invalid DBG_VALUE instructions, with a debug-use of a virtual
518 // register that hasn't been defined yet. If we do not remove those here, then
519 // the re-insertion of the DBG_VALUE instruction after register allocation
520 // will be incorrect.
521 // TODO: If earlier passes are corrected to generate sane debug information
522 // (and if the machine verifier is improved to catch this), then these checks
523 // could be removed or replaced by asserts.
524 bool Discard = false;
525 if (MI.getOperand(0).isReg() &&
526 TargetRegisterInfo::isVirtualRegister(MI.getOperand(0).getReg())) {
527 const unsigned Reg = MI.getOperand(0).getReg();
528 if (!LIS->hasInterval(Reg)) {
529 // The DBG_VALUE is described by a virtual register that does not have a
530 // live interval. Discard the DBG_VALUE.
531 Discard = true;
532 DEBUG(dbgs() << "Discarding debug info (no LIS interval): "
533 << Idx << " " << MI);
534 } else {
535 // The DBG_VALUE is only valid if either Reg is live out from Idx, or Reg
536 // is defined dead at Idx (where Idx is the slot index for the instruction
537 // preceeding the DBG_VALUE).
538 const LiveInterval &LI = LIS->getInterval(Reg);
539 LiveQueryResult LRQ = LI.Query(Idx);
540 if (!LRQ.valueOutOrDead()) {
541 // We have found a DBG_VALUE with the value in a virtual register that
542 // is not live. Discard the DBG_VALUE.
543 Discard = true;
544 DEBUG(dbgs() << "Discarding debug info (reg not live): "
545 << Idx << " " << MI);
546 }
547 }
548 }
549
Reid Kleckner04e25e02017-10-03 17:59:02 +0000550 // Get or create the UserValue for (variable,offset) here.
Reid Kleckner4e040282017-09-20 18:19:08 +0000551 bool IsIndirect = MI.getOperand(1).isImm();
Adrian Prantlb2811e52017-07-28 23:06:50 +0000552 if (IsIndirect)
553 assert(MI.getOperand(1).getImm() == 0 && "DBG_VALUE with nonzero offset");
Reid Kleckner4e040282017-09-20 18:19:08 +0000554 const DILocalVariable *Var = MI.getDebugVariable();
555 const DIExpression *Expr = MI.getDebugExpression();
Reid Kleckner04e25e02017-10-03 17:59:02 +0000556 UserValue *UV =
557 getUserValue(Var, Expr, MI.getDebugLoc());
Bjorn Petterssonbdf0c002018-03-06 08:47:07 +0000558 if (!Discard)
559 UV->addDef(Idx, MI.getOperand(0), IsIndirect);
Bjorn Petterssone0050d72018-03-06 13:23:28 +0000560 else {
561 MachineOperand MO = MachineOperand::CreateReg(0U, false);
562 MO.setIsDebug();
563 UV->addDef(Idx, MO, false);
564 }
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000565 return true;
566}
567
568bool LDVImpl::collectDebugValues(MachineFunction &mf) {
569 bool Changed = false;
570 for (MachineFunction::iterator MFI = mf.begin(), MFE = mf.end(); MFI != MFE;
571 ++MFI) {
Duncan P. N. Exon Smith5ae59392015-10-09 19:13:58 +0000572 MachineBasicBlock *MBB = &*MFI;
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000573 for (MachineBasicBlock::iterator MBBI = MBB->begin(), MBBE = MBB->end();
574 MBBI != MBBE;) {
575 if (!MBBI->isDebugValue()) {
576 ++MBBI;
577 continue;
578 }
579 // DBG_VALUE has no slot index, use the previous instruction instead.
Duncan P. N. Exon Smith3ac9cc62016-02-27 06:40:41 +0000580 SlotIndex Idx =
581 MBBI == MBB->begin()
582 ? LIS->getMBBStartIdx(MBB)
583 : LIS->getInstructionIndex(*std::prev(MBBI)).getRegSlot();
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000584 // Handle consecutive DBG_VALUE instructions with the same slot index.
585 do {
Duncan P. N. Exon Smithfb612ac2016-06-30 23:13:38 +0000586 if (handleDebugValue(*MBBI, Idx)) {
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000587 MBBI = MBB->erase(MBBI);
588 Changed = true;
589 } else
590 ++MBBI;
591 } while (MBBI != MBBE && MBBI->isDebugValue());
592 }
593 }
594 return Changed;
595}
596
Adrian Prantlce858132015-12-21 20:03:00 +0000597/// We only propagate DBG_VALUES locally here. LiveDebugValues performs a
598/// data-flow analysis to propagate them beyond basic block boundaries.
Reid Kleckner04e25e02017-10-03 17:59:02 +0000599void UserValue::extendDef(SlotIndex Idx, DbgValueLocation Loc, LiveRange *LR,
Adrian Prantlce858132015-12-21 20:03:00 +0000600 const VNInfo *VNI, SmallVectorImpl<SlotIndex> *Kills,
Adrian Prantlf8d10ce2016-09-28 21:34:23 +0000601 LiveIntervals &LIS) {
Adrian Prantlce858132015-12-21 20:03:00 +0000602 SlotIndex Start = Idx;
603 MachineBasicBlock *MBB = LIS.getMBBFromIndex(Start);
604 SlotIndex Stop = LIS.getMBBEndIdx(MBB);
605 LocMap::iterator I = locInts.find(Start);
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000606
Adrian Prantlce858132015-12-21 20:03:00 +0000607 // Limit to VNI's live range.
608 bool ToEnd = true;
609 if (LR && VNI) {
610 LiveInterval::Segment *Segment = LR->getSegmentContaining(Start);
611 if (!Segment || Segment->valno != VNI) {
612 if (Kills)
613 Kills->push_back(Start);
614 return;
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000615 }
Richard Trieu7a083812016-02-18 22:09:30 +0000616 if (Segment->end < Stop) {
617 Stop = Segment->end;
618 ToEnd = false;
619 }
Adrian Prantlce858132015-12-21 20:03:00 +0000620 }
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000621
Adrian Prantlce858132015-12-21 20:03:00 +0000622 // There could already be a short def at Start.
623 if (I.valid() && I.start() <= Start) {
624 // Stop when meeting a different location or an already extended interval.
625 Start = Start.getNextSlot();
Reid Kleckner04e25e02017-10-03 17:59:02 +0000626 if (I.value() != Loc || I.stop() != Start)
Adrian Prantlce858132015-12-21 20:03:00 +0000627 return;
628 // This is a one-slot placeholder. Just skip it.
629 ++I;
630 }
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000631
Adrian Prantlce858132015-12-21 20:03:00 +0000632 // Limited by the next def.
Richard Trieu7a083812016-02-18 22:09:30 +0000633 if (I.valid() && I.start() < Stop) {
634 Stop = I.start();
635 ToEnd = false;
636 }
Adrian Prantlce858132015-12-21 20:03:00 +0000637 // Limited by VNI's live range.
638 else if (!ToEnd && Kills)
639 Kills->push_back(Stop);
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000640
Adrian Prantlce858132015-12-21 20:03:00 +0000641 if (Start < Stop)
Reid Kleckner04e25e02017-10-03 17:59:02 +0000642 I.insert(Start, Stop, Loc);
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000643}
644
Reid Kleckner04e25e02017-10-03 17:59:02 +0000645void UserValue::addDefsFromCopies(
646 LiveInterval *LI, unsigned LocNo, bool WasIndirect,
647 const SmallVectorImpl<SlotIndex> &Kills,
648 SmallVectorImpl<std::pair<SlotIndex, DbgValueLocation>> &NewDefs,
649 MachineRegisterInfo &MRI, LiveIntervals &LIS) {
Jakob Stoklund Olesen816f5f42011-03-18 21:42:19 +0000650 if (Kills.empty())
651 return;
652 // Don't track copies from physregs, there are too many uses.
653 if (!TargetRegisterInfo::isVirtualRegister(LI->reg))
654 return;
655
656 // Collect all the (vreg, valno) pairs that are copies of LI.
657 SmallVector<std::pair<LiveInterval*, const VNInfo*>, 8> CopyValues;
Owen Andersonb36376e2014-03-17 19:36:09 +0000658 for (MachineOperand &MO : MRI.use_nodbg_operands(LI->reg)) {
659 MachineInstr *MI = MO.getParent();
Jakob Stoklund Olesen816f5f42011-03-18 21:42:19 +0000660 // Copies of the full value.
Owen Andersonb36376e2014-03-17 19:36:09 +0000661 if (MO.getSubReg() || !MI->isCopy())
Jakob Stoklund Olesen816f5f42011-03-18 21:42:19 +0000662 continue;
Jakob Stoklund Olesen816f5f42011-03-18 21:42:19 +0000663 unsigned DstReg = MI->getOperand(0).getReg();
664
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +0000665 // Don't follow copies to physregs. These are usually setting up call
666 // arguments, and the argument registers are always call clobbered. We are
667 // better off in the source register which could be a callee-saved register,
668 // or it could be spilled.
669 if (!TargetRegisterInfo::isVirtualRegister(DstReg))
670 continue;
671
Jakob Stoklund Olesen816f5f42011-03-18 21:42:19 +0000672 // Is LocNo extended to reach this copy? If not, another def may be blocking
673 // it, or we are looking at a wrong value of LI.
Duncan P. N. Exon Smith3ac9cc62016-02-27 06:40:41 +0000674 SlotIndex Idx = LIS.getInstructionIndex(*MI);
Jakob Stoklund Olesen90b5e562011-11-13 20:45:27 +0000675 LocMap::iterator I = locInts.find(Idx.getRegSlot(true));
Reid Kleckner04e25e02017-10-03 17:59:02 +0000676 if (!I.valid() || I.value().locNo() != LocNo)
Jakob Stoklund Olesen816f5f42011-03-18 21:42:19 +0000677 continue;
678
679 if (!LIS.hasInterval(DstReg))
680 continue;
681 LiveInterval *DstLI = &LIS.getInterval(DstReg);
Jakob Stoklund Olesen90b5e562011-11-13 20:45:27 +0000682 const VNInfo *DstVNI = DstLI->getVNInfoAt(Idx.getRegSlot());
683 assert(DstVNI && DstVNI->def == Idx.getRegSlot() && "Bad copy value");
Jakob Stoklund Olesen816f5f42011-03-18 21:42:19 +0000684 CopyValues.push_back(std::make_pair(DstLI, DstVNI));
685 }
686
687 if (CopyValues.empty())
688 return;
689
690 DEBUG(dbgs() << "Got " << CopyValues.size() << " copies of " << *LI << '\n');
691
692 // Try to add defs of the copied values for each kill point.
693 for (unsigned i = 0, e = Kills.size(); i != e; ++i) {
694 SlotIndex Idx = Kills[i];
695 for (unsigned j = 0, e = CopyValues.size(); j != e; ++j) {
696 LiveInterval *DstLI = CopyValues[j].first;
697 const VNInfo *DstVNI = CopyValues[j].second;
698 if (DstLI->getVNInfoAt(Idx) != DstVNI)
699 continue;
700 // Check that there isn't already a def at Idx
701 LocMap::iterator I = locInts.find(Idx);
702 if (I.valid() && I.start() <= Idx)
703 continue;
704 DEBUG(dbgs() << "Kill at " << Idx << " covered by valno #"
705 << DstVNI->id << " in " << *DstLI << '\n');
706 MachineInstr *CopyMI = LIS.getInstructionFromIndex(DstVNI->def);
707 assert(CopyMI && CopyMI->isCopy() && "Bad copy value");
708 unsigned LocNo = getLocationNo(CopyMI->getOperand(0));
Reid Kleckner04e25e02017-10-03 17:59:02 +0000709 DbgValueLocation NewLoc(LocNo, WasIndirect);
710 I.insert(Idx, Idx.getNextSlot(), NewLoc);
711 NewDefs.push_back(std::make_pair(Idx, NewLoc));
Jakob Stoklund Olesen816f5f42011-03-18 21:42:19 +0000712 break;
713 }
714 }
715}
716
Robert Lougher10f740d2017-08-03 11:54:02 +0000717void UserValue::computeIntervals(MachineRegisterInfo &MRI,
718 const TargetRegisterInfo &TRI,
719 LiveIntervals &LIS, LexicalScopes &LS) {
Reid Kleckner04e25e02017-10-03 17:59:02 +0000720 SmallVector<std::pair<SlotIndex, DbgValueLocation>, 16> Defs;
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000721
722 // Collect all defs to be extended (Skipping undefs).
723 for (LocMap::const_iterator I = locInts.begin(); I.valid(); ++I)
Reid Kleckner04e25e02017-10-03 17:59:02 +0000724 if (!I.value().isUndef())
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000725 Defs.push_back(std::make_pair(I.start(), I.value()));
726
Jakob Stoklund Olesen816f5f42011-03-18 21:42:19 +0000727 // Extend all defs, and possibly add new ones along the way.
728 for (unsigned i = 0; i != Defs.size(); ++i) {
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000729 SlotIndex Idx = Defs[i].first;
Reid Kleckner04e25e02017-10-03 17:59:02 +0000730 DbgValueLocation Loc = Defs[i].second;
731 const MachineOperand &LocMO = locations[Loc.locNo()];
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000732
Reid Kleckner04e25e02017-10-03 17:59:02 +0000733 if (!LocMO.isReg()) {
734 extendDef(Idx, Loc, nullptr, nullptr, nullptr, LIS);
Jakob Stoklund Olesen32449632012-06-22 17:15:32 +0000735 continue;
736 }
737
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000738 // Register locations are constrained to where the register value is live.
Reid Kleckner04e25e02017-10-03 17:59:02 +0000739 if (TargetRegisterInfo::isVirtualRegister(LocMO.getReg())) {
Craig Topperc0196b12014-04-14 00:51:57 +0000740 LiveInterval *LI = nullptr;
741 const VNInfo *VNI = nullptr;
Reid Kleckner04e25e02017-10-03 17:59:02 +0000742 if (LIS.hasInterval(LocMO.getReg())) {
743 LI = &LIS.getInterval(LocMO.getReg());
Jakob Stoklund Olesen48a16472012-06-22 18:51:35 +0000744 VNI = LI->getVNInfoAt(Idx);
745 }
Jakob Stoklund Olesen816f5f42011-03-18 21:42:19 +0000746 SmallVector<SlotIndex, 16> Kills;
Reid Kleckner04e25e02017-10-03 17:59:02 +0000747 extendDef(Idx, Loc, LI, VNI, &Kills, LIS);
Jakob Stoklund Olesen48a16472012-06-22 18:51:35 +0000748 if (LI)
Reid Kleckner04e25e02017-10-03 17:59:02 +0000749 addDefsFromCopies(LI, Loc.locNo(), Loc.wasIndirect(), Kills, Defs, MRI,
750 LIS);
Jakob Stoklund Olesen32449632012-06-22 17:15:32 +0000751 continue;
752 }
753
Bjorn Pettersson715a5ef2017-09-28 13:10:06 +0000754 // For physregs, we only mark the start slot idx. DwarfDebug will see it
755 // as if the DBG_VALUE is valid up until the end of the basic block, or
756 // the next def of the physical register. So we do not need to extend the
757 // range. It might actually happen that the DBG_VALUE is the last use of
758 // the physical register (e.g. if this is an unused input argument to a
759 // function).
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000760 }
761
Robert Lougher10f740d2017-08-03 11:54:02 +0000762 // Erase all the undefs.
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000763 for (LocMap::iterator I = locInts.begin(); I.valid();)
Reid Kleckner04e25e02017-10-03 17:59:02 +0000764 if (I.value().isUndef())
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000765 I.erase();
766 else
767 ++I;
Robert Lougher10f740d2017-08-03 11:54:02 +0000768
769 // The computed intervals may extend beyond the range of the debug
770 // location's lexical scope. In this case, splitting of an interval
771 // can result in an interval outside of the scope being created,
772 // causing extra unnecessary DBG_VALUEs to be emitted. To prevent
773 // this, trim the intervals to the lexical scope.
774
775 LexicalScope *Scope = LS.findLexicalScope(dl);
776 if (!Scope)
777 return;
778
779 SlotIndex PrevEnd;
780 LocMap::iterator I = locInts.begin();
781
782 // Iterate over the lexical scope ranges. Each time round the loop
783 // we check the intervals for overlap with the end of the previous
784 // range and the start of the next. The first range is handled as
785 // a special case where there is no PrevEnd.
786 for (const InsnRange &Range : Scope->getRanges()) {
787 SlotIndex RStart = LIS.getInstructionIndex(*Range.first);
788 SlotIndex REnd = LIS.getInstructionIndex(*Range.second);
789
790 // At the start of each iteration I has been advanced so that
791 // I.stop() >= PrevEnd. Check for overlap.
792 if (PrevEnd && I.start() < PrevEnd) {
793 SlotIndex IStop = I.stop();
Reid Kleckner04e25e02017-10-03 17:59:02 +0000794 DbgValueLocation Loc = I.value();
Robert Lougher10f740d2017-08-03 11:54:02 +0000795
796 // Stop overlaps previous end - trim the end of the interval to
797 // the scope range.
798 I.setStopUnchecked(PrevEnd);
799 ++I;
800
801 // If the interval also overlaps the start of the "next" (i.e.
802 // current) range create a new interval for the remainder (which
803 // may be further trimmed).
804 if (RStart < IStop)
Reid Kleckner04e25e02017-10-03 17:59:02 +0000805 I.insert(RStart, IStop, Loc);
Robert Lougher10f740d2017-08-03 11:54:02 +0000806 }
807
808 // Advance I so that I.stop() >= RStart, and check for overlap.
809 I.advanceTo(RStart);
810 if (!I.valid())
811 return;
812
813 if (I.start() < RStart) {
814 // Interval start overlaps range - trim to the scope range.
815 I.setStartUnchecked(RStart);
816 // Remember that this interval was trimmed.
817 trimmedDefs.insert(RStart);
818 }
819
820 // The end of a lexical scope range is the last instruction in the
821 // range. To convert to an interval we need the index of the
822 // instruction after it.
823 REnd = REnd.getNextIndex();
824
825 // Advance I to first interval outside current range.
826 I.advanceTo(REnd);
827 if (!I.valid())
828 return;
829
830 PrevEnd = REnd;
831 }
832
833 // Check for overlap with end of final range.
834 if (PrevEnd && I.start() < PrevEnd)
835 I.setStopUnchecked(PrevEnd);
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000836}
837
838void LDVImpl::computeIntervals() {
Robert Lougher10f740d2017-08-03 11:54:02 +0000839 LexicalScopes LS;
840 LS.initialize(*MF);
841
Jakob Stoklund Olesen816f5f42011-03-18 21:42:19 +0000842 for (unsigned i = 0, e = userValues.size(); i != e; ++i) {
Robert Lougher10f740d2017-08-03 11:54:02 +0000843 userValues[i]->computeIntervals(MF->getRegInfo(), *TRI, *LIS, LS);
Jakob Stoklund Olesen816f5f42011-03-18 21:42:19 +0000844 userValues[i]->mapVirtRegs(this);
845 }
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000846}
847
848bool LDVImpl::runOnMachineFunction(MachineFunction &mf) {
David Blaikie2f040112014-07-25 16:10:16 +0000849 clear();
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000850 MF = &mf;
851 LIS = &pass.getAnalysis<LiveIntervals>();
Eric Christopherfc6de422014-08-05 02:39:49 +0000852 TRI = mf.getSubtarget().getRegisterInfo();
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000853 DEBUG(dbgs() << "********** COMPUTING LIVE DEBUG VARIABLES: "
David Blaikiec8c29202012-08-22 17:18:53 +0000854 << mf.getName() << " **********\n");
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000855
856 bool Changed = collectDebugValues(mf);
857 computeIntervals();
858 DEBUG(print(dbgs()));
Manman Ren7a4c8a72013-02-13 20:23:48 +0000859 ModifiedMF = Changed;
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000860 return Changed;
861}
862
David Blaikie2f040112014-07-25 16:10:16 +0000863static void removeDebugValues(MachineFunction &mf) {
864 for (MachineBasicBlock &MBB : mf) {
865 for (auto MBBI = MBB.begin(), MBBE = MBB.end(); MBBI != MBBE; ) {
866 if (!MBBI->isDebugValue()) {
867 ++MBBI;
868 continue;
869 }
870 MBBI = MBB.erase(MBBI);
871 }
872 }
873}
874
Jakob Stoklund Olesend4900a62010-11-30 02:17:10 +0000875bool LiveDebugVariables::runOnMachineFunction(MachineFunction &mf) {
Devang Patelacbee0b2011-01-07 22:33:41 +0000876 if (!EnableLDV)
877 return false;
Matthias Braunf1caa282017-12-15 22:22:58 +0000878 if (!mf.getFunction().getSubprogram()) {
David Blaikie2f040112014-07-25 16:10:16 +0000879 removeDebugValues(mf);
880 return false;
881 }
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000882 if (!pImpl)
883 pImpl = new LDVImpl(this);
Manman Ren7a4c8a72013-02-13 20:23:48 +0000884 return static_cast<LDVImpl*>(pImpl)->runOnMachineFunction(mf);
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000885}
886
887void LiveDebugVariables::releaseMemory() {
Manman Ren7a4c8a72013-02-13 20:23:48 +0000888 if (pImpl)
Jakob Stoklund Olesen4be0bd72010-12-02 00:37:37 +0000889 static_cast<LDVImpl*>(pImpl)->clear();
890}
891
892LiveDebugVariables::~LiveDebugVariables() {
893 if (pImpl)
894 delete static_cast<LDVImpl*>(pImpl);
Jakob Stoklund Olesend4900a62010-11-30 02:17:10 +0000895}
Jakob Stoklund Olesen9ec20112010-12-02 18:15:44 +0000896
Jakob Stoklund Olesenf8da0282011-05-06 18:00:02 +0000897//===----------------------------------------------------------------------===//
898// Live Range Splitting
899//===----------------------------------------------------------------------===//
900
901bool
Mark Laceyf9ea8852013-08-14 23:50:04 +0000902UserValue::splitLocation(unsigned OldLocNo, ArrayRef<unsigned> NewRegs,
903 LiveIntervals& LIS) {
Jakob Stoklund Olesenf8da0282011-05-06 18:00:02 +0000904 DEBUG({
905 dbgs() << "Splitting Loc" << OldLocNo << '\t';
Craig Topperc0196b12014-04-14 00:51:57 +0000906 print(dbgs(), nullptr);
Jakob Stoklund Olesenf8da0282011-05-06 18:00:02 +0000907 });
908 bool DidChange = false;
909 LocMap::iterator LocMapI;
910 LocMapI.setMap(locInts);
911 for (unsigned i = 0; i != NewRegs.size(); ++i) {
Mark Laceyf9ea8852013-08-14 23:50:04 +0000912 LiveInterval *LI = &LIS.getInterval(NewRegs[i]);
Jakob Stoklund Olesenf8da0282011-05-06 18:00:02 +0000913 if (LI->empty())
914 continue;
915
916 // Don't allocate the new LocNo until it is needed.
Reid Klecknereed09732017-09-15 22:08:50 +0000917 unsigned NewLocNo = UndefLocNo;
Jakob Stoklund Olesenf8da0282011-05-06 18:00:02 +0000918
919 // Iterate over the overlaps between locInts and LI.
920 LocMapI.find(LI->beginIndex());
921 if (!LocMapI.valid())
922 continue;
923 LiveInterval::iterator LII = LI->advanceTo(LI->begin(), LocMapI.start());
924 LiveInterval::iterator LIE = LI->end();
925 while (LocMapI.valid() && LII != LIE) {
926 // At this point, we know that LocMapI.stop() > LII->start.
927 LII = LI->advanceTo(LII, LocMapI.start());
928 if (LII == LIE)
929 break;
930
931 // Now LII->end > LocMapI.start(). Do we have an overlap?
Reid Kleckner04e25e02017-10-03 17:59:02 +0000932 if (LocMapI.value().locNo() == OldLocNo && LII->start < LocMapI.stop()) {
Jakob Stoklund Olesenf8da0282011-05-06 18:00:02 +0000933 // Overlapping correct location. Allocate NewLocNo now.
Reid Klecknereed09732017-09-15 22:08:50 +0000934 if (NewLocNo == UndefLocNo) {
Jakob Stoklund Olesenf8da0282011-05-06 18:00:02 +0000935 MachineOperand MO = MachineOperand::CreateReg(LI->reg, false);
936 MO.setSubReg(locations[OldLocNo].getSubReg());
937 NewLocNo = getLocationNo(MO);
938 DidChange = true;
939 }
940
941 SlotIndex LStart = LocMapI.start();
942 SlotIndex LStop = LocMapI.stop();
Reid Kleckner04e25e02017-10-03 17:59:02 +0000943 DbgValueLocation OldLoc = LocMapI.value();
Jakob Stoklund Olesenf8da0282011-05-06 18:00:02 +0000944
945 // Trim LocMapI down to the LII overlap.
946 if (LStart < LII->start)
947 LocMapI.setStartUnchecked(LII->start);
948 if (LStop > LII->end)
949 LocMapI.setStopUnchecked(LII->end);
950
951 // Change the value in the overlap. This may trigger coalescing.
Reid Kleckner04e25e02017-10-03 17:59:02 +0000952 LocMapI.setValue(OldLoc.changeLocNo(NewLocNo));
Jakob Stoklund Olesenf8da0282011-05-06 18:00:02 +0000953
954 // Re-insert any removed OldLocNo ranges.
955 if (LStart < LocMapI.start()) {
Reid Kleckner04e25e02017-10-03 17:59:02 +0000956 LocMapI.insert(LStart, LocMapI.start(), OldLoc);
Jakob Stoklund Olesenf8da0282011-05-06 18:00:02 +0000957 ++LocMapI;
958 assert(LocMapI.valid() && "Unexpected coalescing");
959 }
960 if (LStop > LocMapI.stop()) {
961 ++LocMapI;
Reid Kleckner04e25e02017-10-03 17:59:02 +0000962 LocMapI.insert(LII->end, LStop, OldLoc);
Jakob Stoklund Olesenf8da0282011-05-06 18:00:02 +0000963 --LocMapI;
964 }
965 }
966
967 // Advance to the next overlap.
968 if (LII->end < LocMapI.stop()) {
969 if (++LII == LIE)
970 break;
971 LocMapI.advanceTo(LII->start);
972 } else {
973 ++LocMapI;
974 if (!LocMapI.valid())
975 break;
976 LII = LI->advanceTo(LII, LocMapI.start());
977 }
978 }
979 }
980
981 // Finally, remove any remaining OldLocNo intervals and OldLocNo itself.
982 locations.erase(locations.begin() + OldLocNo);
983 LocMapI.goToBegin();
984 while (LocMapI.valid()) {
Reid Kleckner04e25e02017-10-03 17:59:02 +0000985 DbgValueLocation v = LocMapI.value();
986 if (v.locNo() == OldLocNo) {
Jakob Stoklund Olesenf8da0282011-05-06 18:00:02 +0000987 DEBUG(dbgs() << "Erasing [" << LocMapI.start() << ';'
988 << LocMapI.stop() << ")\n");
989 LocMapI.erase();
990 } else {
Reid Kleckner04e25e02017-10-03 17:59:02 +0000991 if (v.locNo() > OldLocNo)
992 LocMapI.setValueUnchecked(v.changeLocNo(v.locNo() - 1));
Jakob Stoklund Olesenf8da0282011-05-06 18:00:02 +0000993 ++LocMapI;
994 }
995 }
996
Craig Topperc0196b12014-04-14 00:51:57 +0000997 DEBUG({dbgs() << "Split result: \t"; print(dbgs(), nullptr);});
Jakob Stoklund Olesenf8da0282011-05-06 18:00:02 +0000998 return DidChange;
999}
1000
1001bool
Mark Laceyf9ea8852013-08-14 23:50:04 +00001002UserValue::splitRegister(unsigned OldReg, ArrayRef<unsigned> NewRegs,
1003 LiveIntervals &LIS) {
Jakob Stoklund Olesenf8da0282011-05-06 18:00:02 +00001004 bool DidChange = false;
Jakob Stoklund Olesen57c8f582011-05-06 19:31:19 +00001005 // Split locations referring to OldReg. Iterate backwards so splitLocation can
Eric Christopherbe153e62012-03-15 21:33:35 +00001006 // safely erase unused locations.
Jakob Stoklund Olesen57c8f582011-05-06 19:31:19 +00001007 for (unsigned i = locations.size(); i ; --i) {
1008 unsigned LocNo = i-1;
Jakob Stoklund Olesenf8da0282011-05-06 18:00:02 +00001009 const MachineOperand *Loc = &locations[LocNo];
1010 if (!Loc->isReg() || Loc->getReg() != OldReg)
1011 continue;
Mark Laceyf9ea8852013-08-14 23:50:04 +00001012 DidChange |= splitLocation(LocNo, NewRegs, LIS);
Jakob Stoklund Olesenf8da0282011-05-06 18:00:02 +00001013 }
1014 return DidChange;
1015}
1016
Mark Laceyf9ea8852013-08-14 23:50:04 +00001017void LDVImpl::splitRegister(unsigned OldReg, ArrayRef<unsigned> NewRegs) {
Jakob Stoklund Olesenf8da0282011-05-06 18:00:02 +00001018 bool DidChange = false;
1019 for (UserValue *UV = lookupVirtReg(OldReg); UV; UV = UV->getNext())
Mark Laceyf9ea8852013-08-14 23:50:04 +00001020 DidChange |= UV->splitRegister(OldReg, NewRegs, *LIS);
Jakob Stoklund Olesenf8da0282011-05-06 18:00:02 +00001021
1022 if (!DidChange)
1023 return;
1024
1025 // Map all of the new virtual registers.
1026 UserValue *UV = lookupVirtReg(OldReg);
1027 for (unsigned i = 0; i != NewRegs.size(); ++i)
Mark Laceyf9ea8852013-08-14 23:50:04 +00001028 mapVirtReg(NewRegs[i], UV);
Jakob Stoklund Olesenf8da0282011-05-06 18:00:02 +00001029}
1030
1031void LiveDebugVariables::
Mark Laceyf9ea8852013-08-14 23:50:04 +00001032splitRegister(unsigned OldReg, ArrayRef<unsigned> NewRegs, LiveIntervals &LIS) {
Jakob Stoklund Olesenf8da0282011-05-06 18:00:02 +00001033 if (pImpl)
1034 static_cast<LDVImpl*>(pImpl)->splitRegister(OldReg, NewRegs);
1035}
1036
Reid Kleckner4e040282017-09-20 18:19:08 +00001037void UserValue::rewriteLocations(VirtRegMap &VRM, const TargetRegisterInfo &TRI,
1038 BitVector &SpilledLocations) {
Reid Kleckner92687d42017-09-20 17:32:54 +00001039 // Build a set of new locations with new numbers so we can coalesce our
1040 // IntervalMap if two vreg intervals collapse to the same physical location.
1041 // Use MapVector instead of SetVector because MapVector::insert returns the
Reid Kleckner4e040282017-09-20 18:19:08 +00001042 // position of the previously or newly inserted element. The boolean value
1043 // tracks if the location was produced by a spill.
1044 // FIXME: This will be problematic if we ever support direct and indirect
1045 // frame index locations, i.e. expressing both variables in memory and
1046 // 'int x, *px = &x'. The "spilled" bit must become part of the location.
Reid Kleckner92687d42017-09-20 17:32:54 +00001047 MapVector<MachineOperand, bool> NewLocations;
1048 SmallVector<unsigned, 4> LocNoMap(locations.size());
1049 for (unsigned I = 0, E = locations.size(); I != E; ++I) {
Reid Kleckner4e040282017-09-20 18:19:08 +00001050 bool Spilled = false;
Reid Kleckner92687d42017-09-20 17:32:54 +00001051 MachineOperand Loc = locations[I];
Jakob Stoklund Olesenafc2bc22010-12-03 21:47:10 +00001052 // Only virtual registers are rewritten.
Reid Kleckner92687d42017-09-20 17:32:54 +00001053 if (Loc.isReg() && Loc.getReg() &&
1054 TargetRegisterInfo::isVirtualRegister(Loc.getReg())) {
1055 unsigned VirtReg = Loc.getReg();
1056 if (VRM.isAssignedReg(VirtReg) &&
1057 TargetRegisterInfo::isPhysicalRegister(VRM.getPhys(VirtReg))) {
1058 // This can create a %noreg operand in rare cases when the sub-register
1059 // index is no longer available. That means the user value is in a
1060 // non-existent sub-register, and %noreg is exactly what we want.
1061 Loc.substPhysReg(VRM.getPhys(VirtReg), TRI);
1062 } else if (VRM.getStackSlot(VirtReg) != VirtRegMap::NO_STACK_SLOT) {
1063 // FIXME: Translate SubIdx to a stackslot offset.
1064 Loc = MachineOperand::CreateFI(VRM.getStackSlot(VirtReg));
Reid Kleckner4e040282017-09-20 18:19:08 +00001065 Spilled = true;
Reid Kleckner92687d42017-09-20 17:32:54 +00001066 } else {
1067 Loc.setReg(0);
1068 Loc.setSubReg(0);
1069 }
Jakob Stoklund Olesenafc2bc22010-12-03 21:47:10 +00001070 }
Reid Kleckner92687d42017-09-20 17:32:54 +00001071
1072 // Insert this location if it doesn't already exist and record a mapping
1073 // from the old number to the new number.
Reid Kleckner4e040282017-09-20 18:19:08 +00001074 auto InsertResult = NewLocations.insert({Loc, Spilled});
1075 unsigned NewLocNo = std::distance(NewLocations.begin(), InsertResult.first);
1076 LocNoMap[I] = NewLocNo;
Reid Kleckner92687d42017-09-20 17:32:54 +00001077 }
1078
Reid Kleckner4e040282017-09-20 18:19:08 +00001079 // Rewrite the locations and record which ones were spill slots.
Reid Kleckner92687d42017-09-20 17:32:54 +00001080 locations.clear();
Reid Kleckner4e040282017-09-20 18:19:08 +00001081 SpilledLocations.clear();
1082 SpilledLocations.resize(NewLocations.size());
1083 for (auto &Pair : NewLocations) {
Reid Kleckner92687d42017-09-20 17:32:54 +00001084 locations.push_back(Pair.first);
Reid Kleckner4e040282017-09-20 18:19:08 +00001085 if (Pair.second) {
1086 unsigned NewLocNo = std::distance(&*NewLocations.begin(), &Pair);
1087 SpilledLocations.set(NewLocNo);
1088 }
1089 }
Reid Kleckner92687d42017-09-20 17:32:54 +00001090
1091 // Update the interval map, but only coalesce left, since intervals to the
1092 // right use the old location numbers. This should merge two contiguous
1093 // DBG_VALUE intervals with different vregs that were allocated to the same
1094 // physical register.
1095 for (LocMap::iterator I = locInts.begin(); I.valid(); ++I) {
Reid Kleckner04e25e02017-10-03 17:59:02 +00001096 DbgValueLocation Loc = I.value();
1097 unsigned NewLocNo = LocNoMap[Loc.locNo()];
1098 I.setValueUnchecked(Loc.changeLocNo(NewLocNo));
Reid Kleckner92687d42017-09-20 17:32:54 +00001099 I.setStart(I.start());
Jakob Stoklund Olesenafc2bc22010-12-03 21:47:10 +00001100 }
Jakob Stoklund Olesenafc2bc22010-12-03 21:47:10 +00001101}
1102
Karl-Johan Karlsson8d8d2012017-10-05 08:37:31 +00001103/// Find an iterator for inserting a DBG_VALUE instruction.
Jakob Stoklund Olesenafc2bc22010-12-03 21:47:10 +00001104static MachineBasicBlock::iterator
Devang Patel26ffa012011-02-04 01:43:25 +00001105findInsertLocation(MachineBasicBlock *MBB, SlotIndex Idx,
Jakob Stoklund Olesenafc2bc22010-12-03 21:47:10 +00001106 LiveIntervals &LIS) {
1107 SlotIndex Start = LIS.getMBBStartIdx(MBB);
1108 Idx = Idx.getBaseIndex();
1109
1110 // Try to find an insert location by going backwards from Idx.
1111 MachineInstr *MI;
1112 while (!(MI = LIS.getInstructionFromIndex(Idx))) {
1113 // We've reached the beginning of MBB.
1114 if (Idx == Start) {
Keith Walker830a8c12016-09-16 14:07:29 +00001115 MachineBasicBlock::iterator I = MBB->SkipPHIsLabelsAndDebug(MBB->begin());
Jakob Stoklund Olesenafc2bc22010-12-03 21:47:10 +00001116 return I;
1117 }
1118 Idx = Idx.getPrevIndex();
1119 }
Devang Patel26ffa012011-02-04 01:43:25 +00001120
Jakob Stoklund Olesen088b30a2011-01-13 23:35:53 +00001121 // Don't insert anything after the first terminator, though.
Evan Cheng7f8e5632011-12-07 07:15:52 +00001122 return MI->isTerminator() ? MBB->getFirstTerminator() :
Benjamin Kramerb6d0bd42014-03-02 12:27:27 +00001123 std::next(MachineBasicBlock::iterator(MI));
Jakob Stoklund Olesenafc2bc22010-12-03 21:47:10 +00001124}
1125
Karl-Johan Karlsson8d8d2012017-10-05 08:37:31 +00001126/// Find an iterator for inserting the next DBG_VALUE instruction
1127/// (or end if no more insert locations found).
1128static MachineBasicBlock::iterator
1129findNextInsertLocation(MachineBasicBlock *MBB,
1130 MachineBasicBlock::iterator I,
1131 SlotIndex StopIdx, MachineOperand &LocMO,
1132 LiveIntervals &LIS,
1133 const TargetRegisterInfo &TRI) {
1134 if (!LocMO.isReg())
1135 return MBB->instr_end();
1136 unsigned Reg = LocMO.getReg();
1137
1138 // Find the next instruction in the MBB that define the register Reg.
Stefan Maksimovic991af7a2018-02-09 14:03:26 +00001139 while (I != MBB->end() && !I->isTerminator()) {
Karl-Johan Karlsson8d8d2012017-10-05 08:37:31 +00001140 if (!LIS.isNotInMIMap(*I) &&
1141 SlotIndex::isEarlierEqualInstr(StopIdx, LIS.getInstructionIndex(*I)))
1142 break;
1143 if (I->definesRegister(Reg, &TRI))
1144 // The insert location is directly after the instruction/bundle.
1145 return std::next(I);
1146 ++I;
1147 }
1148 return MBB->end();
1149}
1150
1151void UserValue::insertDebugValue(MachineBasicBlock *MBB, SlotIndex StartIdx,
1152 SlotIndex StopIdx,
Reid Kleckner04e25e02017-10-03 17:59:02 +00001153 DbgValueLocation Loc, bool Spilled,
Jakob Stoklund Olesenafc2bc22010-12-03 21:47:10 +00001154 LiveIntervals &LIS,
Karl-Johan Karlsson8d8d2012017-10-05 08:37:31 +00001155 const TargetInstrInfo &TII,
1156 const TargetRegisterInfo &TRI) {
1157 SlotIndex MBBEndIdx = LIS.getMBBEndIdx(&*MBB);
1158 // Only search within the current MBB.
1159 StopIdx = (MBBEndIdx < StopIdx) ? MBBEndIdx : StopIdx;
1160 MachineBasicBlock::iterator I = findInsertLocation(MBB, StartIdx, LIS);
Reid Kleckner04e25e02017-10-03 17:59:02 +00001161 MachineOperand &MO = locations[Loc.locNo()];
Devang Pateleabc3cea2011-08-04 20:42:11 +00001162 ++NumInsertedDebugValues;
Jakob Stoklund Olesenafc2bc22010-12-03 21:47:10 +00001163
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001164 assert(cast<DILocalVariable>(Variable)
Duncan P. N. Exon Smithe686f152015-04-06 23:27:40 +00001165 ->isValidLocationForIntrinsic(getDebugLoc()) &&
Duncan P. N. Exon Smith3bef6a32015-04-03 19:20:26 +00001166 "Expected inlined-at fields to agree");
Reid Kleckner4e040282017-09-20 18:19:08 +00001167
1168 // If the location was spilled, the new DBG_VALUE will be indirect. If the
1169 // original DBG_VALUE was indirect, we need to add DW_OP_deref to indicate
1170 // that the original virtual register was a pointer.
Reid Kleckner4e040282017-09-20 18:19:08 +00001171 const DIExpression *Expr = Expression;
Reid Kleckner04e25e02017-10-03 17:59:02 +00001172 bool IsIndirect = Loc.wasIndirect();
1173 if (Spilled) {
1174 if (IsIndirect)
1175 Expr = DIExpression::prepend(Expr, DIExpression::WithDeref);
1176 IsIndirect = true;
1177 }
Reid Kleckner4e040282017-09-20 18:19:08 +00001178
Reid Kleckner04e25e02017-10-03 17:59:02 +00001179 assert((!Spilled || MO.isFI()) && "a spilled location must be a frame index");
Reid Kleckner4e040282017-09-20 18:19:08 +00001180
Karl-Johan Karlsson8d8d2012017-10-05 08:37:31 +00001181 do {
1182 MachineInstrBuilder MIB =
Reid Kleckner4e040282017-09-20 18:19:08 +00001183 BuildMI(*MBB, I, getDebugLoc(), TII.get(TargetOpcode::DBG_VALUE))
Reid Kleckner04e25e02017-10-03 17:59:02 +00001184 .add(MO);
Karl-Johan Karlsson8d8d2012017-10-05 08:37:31 +00001185 if (IsIndirect)
1186 MIB.addImm(0U);
1187 else
1188 MIB.addReg(0U, RegState::Debug);
1189 MIB.addMetadata(Variable).addMetadata(Expr);
1190
1191 // Continue and insert DBG_VALUES after every redefinition of register
1192 // associated with the debug value within the range
1193 I = findNextInsertLocation(MBB, I, StopIdx, MO, LIS, TRI);
1194 } while (I != MBB->end());
Jakob Stoklund Olesenafc2bc22010-12-03 21:47:10 +00001195}
1196
Jakob Stoklund Olesenafc2bc22010-12-03 21:47:10 +00001197void UserValue::emitDebugValues(VirtRegMap *VRM, LiveIntervals &LIS,
Reid Kleckner4e040282017-09-20 18:19:08 +00001198 const TargetInstrInfo &TII,
Karl-Johan Karlsson8d8d2012017-10-05 08:37:31 +00001199 const TargetRegisterInfo &TRI,
Reid Kleckner4e040282017-09-20 18:19:08 +00001200 const BitVector &SpilledLocations) {
Jakob Stoklund Olesenafc2bc22010-12-03 21:47:10 +00001201 MachineFunction::iterator MFEnd = VRM->getMachineFunction().end();
1202
1203 for (LocMap::const_iterator I = locInts.begin(); I.valid();) {
1204 SlotIndex Start = I.start();
1205 SlotIndex Stop = I.stop();
Reid Kleckner04e25e02017-10-03 17:59:02 +00001206 DbgValueLocation Loc = I.value();
1207 bool Spilled = !Loc.isUndef() ? SpilledLocations.test(Loc.locNo()) : false;
Robert Lougher10f740d2017-08-03 11:54:02 +00001208
1209 // If the interval start was trimmed to the lexical scope insert the
1210 // DBG_VALUE at the previous index (otherwise it appears after the
1211 // first instruction in the range).
1212 if (trimmedDefs.count(Start))
1213 Start = Start.getPrevIndex();
1214
Reid Kleckner04e25e02017-10-03 17:59:02 +00001215 DEBUG(dbgs() << "\t[" << Start << ';' << Stop << "):" << Loc.locNo());
Duncan P. N. Exon Smith5ae59392015-10-09 19:13:58 +00001216 MachineFunction::iterator MBB = LIS.getMBBFromIndex(Start)->getIterator();
1217 SlotIndex MBBEnd = LIS.getMBBEndIdx(&*MBB);
Jakob Stoklund Olesenafc2bc22010-12-03 21:47:10 +00001218
Francis Visoiu Mistrih25528d62017-12-04 17:18:51 +00001219 DEBUG(dbgs() << ' ' << printMBBReference(*MBB) << '-' << MBBEnd);
Karl-Johan Karlsson8d8d2012017-10-05 08:37:31 +00001220 insertDebugValue(&*MBB, Start, Stop, Loc, Spilled, LIS, TII, TRI);
Jakob Stoklund Olesenafc2bc22010-12-03 21:47:10 +00001221 // This interval may span multiple basic blocks.
1222 // Insert a DBG_VALUE into each one.
Karl-Johan Karlsson8d8d2012017-10-05 08:37:31 +00001223 while (Stop > MBBEnd) {
Jakob Stoklund Olesenafc2bc22010-12-03 21:47:10 +00001224 // Move to the next block.
1225 Start = MBBEnd;
1226 if (++MBB == MFEnd)
1227 break;
Duncan P. N. Exon Smith5ae59392015-10-09 19:13:58 +00001228 MBBEnd = LIS.getMBBEndIdx(&*MBB);
Francis Visoiu Mistrih25528d62017-12-04 17:18:51 +00001229 DEBUG(dbgs() << ' ' << printMBBReference(*MBB) << '-' << MBBEnd);
Karl-Johan Karlsson8d8d2012017-10-05 08:37:31 +00001230 insertDebugValue(&*MBB, Start, Stop, Loc, Spilled, LIS, TII, TRI);
Jakob Stoklund Olesenafc2bc22010-12-03 21:47:10 +00001231 }
1232 DEBUG(dbgs() << '\n');
1233 if (MBB == MFEnd)
1234 break;
1235
1236 ++I;
Jakob Stoklund Olesenafc2bc22010-12-03 21:47:10 +00001237 }
1238}
1239
1240void LDVImpl::emitDebugValues(VirtRegMap *VRM) {
1241 DEBUG(dbgs() << "********** EMITTING LIVE DEBUG VARIABLES **********\n");
David Blaikie2f040112014-07-25 16:10:16 +00001242 if (!MF)
1243 return;
Eric Christopherfc6de422014-08-05 02:39:49 +00001244 const TargetInstrInfo *TII = MF->getSubtarget().getInstrInfo();
Reid Kleckner4e040282017-09-20 18:19:08 +00001245 BitVector SpilledLocations;
Jakob Stoklund Olesenafc2bc22010-12-03 21:47:10 +00001246 for (unsigned i = 0, e = userValues.size(); i != e; ++i) {
Eric Christopher1cdefae2015-02-27 00:11:34 +00001247 DEBUG(userValues[i]->print(dbgs(), TRI));
Reid Kleckner4e040282017-09-20 18:19:08 +00001248 userValues[i]->rewriteLocations(*VRM, *TRI, SpilledLocations);
Karl-Johan Karlsson8d8d2012017-10-05 08:37:31 +00001249 userValues[i]->emitDebugValues(VRM, *LIS, *TII, *TRI, SpilledLocations);
Jakob Stoklund Olesenafc2bc22010-12-03 21:47:10 +00001250 }
Manman Ren7a4c8a72013-02-13 20:23:48 +00001251 EmitDone = true;
Jakob Stoklund Olesenafc2bc22010-12-03 21:47:10 +00001252}
1253
1254void LiveDebugVariables::emitDebugValues(VirtRegMap *VRM) {
Manman Ren7a4c8a72013-02-13 20:23:48 +00001255 if (pImpl)
Jakob Stoklund Olesenafc2bc22010-12-03 21:47:10 +00001256 static_cast<LDVImpl*>(pImpl)->emitDebugValues(VRM);
1257}
1258
David Blaikie2f040112014-07-25 16:10:16 +00001259bool LiveDebugVariables::doInitialization(Module &M) {
David Blaikie2f040112014-07-25 16:10:16 +00001260 return Pass::doInitialization(M);
1261}
Jakob Stoklund Olesenafc2bc22010-12-03 21:47:10 +00001262
Aaron Ballman615eb472017-10-15 14:32:27 +00001263#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
Sam Clegg705f7982017-06-21 22:19:17 +00001264LLVM_DUMP_METHOD void LiveDebugVariables::dump() const {
Jakob Stoklund Olesen9ec20112010-12-02 18:15:44 +00001265 if (pImpl)
1266 static_cast<LDVImpl*>(pImpl)->print(dbgs());
1267}
1268#endif