summaryrefslogtreecommitdiff
path: root/lib/Target/SparcV9/RegAlloc/LiveRange.h
blob: 7a37596af00a235378656476c670efe1b4aa5672 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
//===-- LiveRange.h - Store info about a live range -------------*- C++ -*-===//
// 
//                     The LLVM Compiler Infrastructure
//
// This file was developed by the LLVM research group and is distributed under
// the University of Illinois Open Source License. See LICENSE.TXT for details.
// 
//===----------------------------------------------------------------------===//
//
// Implements a live range using a SetVector of Value *s.  We keep only
// defs in a LiveRange.
//
//===----------------------------------------------------------------------===//

#ifndef LIVERANGE_H
#define LIVERANGE_H

#include "llvm/Value.h"
#include "Support/SetVector.h"
#include <iostream>

namespace llvm {

class RegClass;
class IGNode;

class LiveRange {
public:
  typedef SetVector<const Value *> ValueContainerType;
  typedef ValueContainerType::iterator iterator;
  typedef ValueContainerType::const_iterator const_iterator;

private:
  ValueContainerType MyValues; // Values in this LiveRange
  RegClass *MyRegClass;        // register class (e.g., int, FP) for this LR

  /// doesSpanAcrossCalls - Does this live range span across calls? 
  /// This information is used by graph coloring algo to avoid allocating
  /// volatile colors to live ranges that span across calls (since they have to
  /// be saved/restored)
  ///
  bool doesSpanAcrossCalls;

  IGNode *UserIGNode;         // IGNode which uses this LR
  int Color;                  // color assigned to this live range
  bool mustSpill;             // whether this LR must be spilt

  /// SuggestedColor - if this LR has a suggested color, can it
  /// really be allocated?  A suggested color cannot be allocated when the
  /// suggested color is volatile and when there are call
  /// interferences.
  ///
  int SuggestedColor;        // The suggested color for this LR

  /// CanUseSuggestedCol - It is possible that a suggested color for
  /// this live range is not available before graph coloring (e.g., it
  /// can be allocated to another live range which interferes with
  /// this)
  /// 
  bool CanUseSuggestedCol;

  /// SpilledStackOffsetFromFP - If this LR is spilled, its stack
  /// offset from *FP*. The spilled offsets must always be relative to
  /// the FP.
  ///
  int SpilledStackOffsetFromFP;

  /// HasSpillOffset - True iff this live range has a spill offset.
  ///
  bool HasSpillOffset;

  /// SpillCost - The spill cost of this live range. Calculated using loop depth
  /// of each reference to each Value in the live range.
  ///
  unsigned SpillCost;

public:
  iterator        begin()       { return MyValues.begin();    }
  const_iterator  begin() const { return MyValues.begin();    }
  iterator          end()       { return MyValues.end();      }
  const_iterator    end() const { return MyValues.end();      }
  bool insert(const Value *&X)  { return MyValues.insert (X); }
  void insert(iterator b, iterator e) { MyValues.insert (b, e); }

  LiveRange() {
    Color = SuggestedColor = -1;        // not yet colored 
    mustSpill = false;
    MyRegClass = 0;
    UserIGNode = 0;
    doesSpanAcrossCalls = false;
    CanUseSuggestedCol = true;
    HasSpillOffset = false;
    SpillCost = 0;
  }

  void setRegClass(RegClass *RC) { MyRegClass = RC; }

  RegClass *getRegClass() const { assert(MyRegClass); return MyRegClass; }
  unsigned getRegClassID() const;

  bool hasColor() const { return Color != -1; }
  
  unsigned getColor() const { assert(Color != -1); return (unsigned)Color; }

  void setColor(unsigned Col) { Color = (int)Col; }

  inline void setCallInterference() { 
    doesSpanAcrossCalls = 1;
  }
  inline void clearCallInterference() { 
    doesSpanAcrossCalls = 0;
  }

  inline bool isCallInterference() const { 
    return doesSpanAcrossCalls == 1; 
  } 

  inline void markForSpill() { mustSpill = true; }

  inline bool isMarkedForSpill() const { return mustSpill; }

  inline void setSpillOffFromFP(int StackOffset) {
    assert(mustSpill && "This LR is not spilled");
    SpilledStackOffsetFromFP = StackOffset;
    HasSpillOffset = true;
  }

  inline void modifySpillOffFromFP(int StackOffset) {
    assert(mustSpill && "This LR is not spilled");
    SpilledStackOffsetFromFP = StackOffset;
    HasSpillOffset = true;
  }

  inline bool hasSpillOffset() const {
    return HasSpillOffset;
  }

  inline int getSpillOffFromFP() const {
    assert(HasSpillOffset && "This LR is not spilled");
    return SpilledStackOffsetFromFP;
  }

  inline void setUserIGNode(IGNode *IGN) {
    assert(!UserIGNode); UserIGNode = IGN;
  }

  // getUserIGNode - NULL if the user is not allocated
  inline IGNode *getUserIGNode() const { return UserIGNode; }

  inline const Type *getType() const {
    return (*begin())->getType();  // set's don't have a front
  }
  
  inline void setSuggestedColor(int Col) {
    if (SuggestedColor == -1)
      SuggestedColor = Col;
  }

  inline unsigned getSuggestedColor() const {
    assert(SuggestedColor != -1);      // only a valid color is obtained
    return (unsigned)SuggestedColor;
  }

  inline bool hasSuggestedColor() const {
    return SuggestedColor != -1;
  }

  inline bool isSuggestedColorUsable() const {
    assert(hasSuggestedColor() && "No suggested color");
    return CanUseSuggestedCol;
  }

  inline void setSuggestedColorUsable(bool val) {
    assert(hasSuggestedColor() && "No suggested color");
    CanUseSuggestedCol = val;
  }

  inline void addSpillCost(unsigned cost) {
    SpillCost += cost;
  }

  inline unsigned getSpillCost() const {
    return SpillCost;
  }
};

static inline std::ostream &operator << (std::ostream &os, const LiveRange &lr) {
  os << "LiveRange@" << (void *)(&lr);
  return os;
};

} // End llvm namespace

#endif