Add a constructor that got lost
[oota-llvm.git] / lib / Target / TargetSchedInfo.cpp
1 //===-- SchedInfo.cpp - Generic code to support target schedulers ----------==//
2 // 
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
7 // 
8 //===----------------------------------------------------------------------===//
9 //
10 // This file implements the generic part of a Scheduler description for a
11 // target.  This functionality is defined in the llvm/Target/SchedInfo.h file.
12 //
13 //===----------------------------------------------------------------------===//
14
15 #include "llvm/Target/TargetSchedInfo.h"
16 #include "llvm/Target/TargetMachine.h"
17
18 namespace llvm {
19
20 resourceId_t CPUResource::nextId = 0;
21
22 CPUResource::CPUResource(const std::string& resourceName, int maxUsers)
23   : rname(resourceName), rid(nextId++), maxNumUsers(maxUsers) {}
24
25 // Check if fromRVec and toRVec have *any* common entries.
26 // Assume the vectors are sorted in increasing order.
27 // Algorithm copied from function set_intersection() for sorted ranges
28 // (stl_algo.h).
29 //
30 inline static bool
31 RUConflict(const std::vector<resourceId_t>& fromRVec,
32            const std::vector<resourceId_t>& toRVec)
33 {
34   
35   unsigned fN = fromRVec.size(), tN = toRVec.size(); 
36   unsigned fi = 0, ti = 0;
37
38   while (fi < fN && ti < tN) {
39     if (fromRVec[fi] < toRVec[ti])
40       ++fi;
41     else if (toRVec[ti] < fromRVec[fi])
42       ++ti;
43     else
44       return true;
45   }
46   return false;
47 }
48
49
50 static cycles_t
51 ComputeMinGap(const InstrRUsage &fromRU, 
52               const InstrRUsage &toRU)
53 {
54   cycles_t minGap = 0;
55   
56   if (fromRU.numBubbles > 0)
57     minGap = fromRU.numBubbles;
58   
59   if (minGap < fromRU.numCycles) {
60     // only need to check from cycle `minGap' onwards
61     for (cycles_t gap=minGap; gap <= fromRU.numCycles-1; gap++) {
62       // check if instr. #2 can start executing `gap' cycles after #1
63       // by checking for resource conflicts in each overlapping cycle
64       cycles_t numOverlap =std::min(fromRU.numCycles - gap, toRU.numCycles);
65       for (cycles_t c = 0; c <= numOverlap-1; c++)
66         if (RUConflict(fromRU.resourcesByCycle[gap + c],
67                        toRU.resourcesByCycle[c])) {
68           // conflict found so minGap must be more than `gap'
69           minGap = gap+1;
70           break;
71         }
72     }
73   }
74   
75   return minGap;
76 }
77
78
79 //---------------------------------------------------------------------------
80 // class TargetSchedInfo
81 //      Interface to machine description for instruction scheduling
82 //---------------------------------------------------------------------------
83
84 TargetSchedInfo::TargetSchedInfo(const TargetMachine&    tgt,
85                                  int                     NumSchedClasses,
86                                  const InstrClassRUsage* ClassRUsages,
87                                  const InstrRUsageDelta* UsageDeltas,
88                                  const InstrIssueDelta*  IssueDeltas,
89                                  unsigned NumUsageDeltas,
90                                  unsigned NumIssueDeltas)
91   : target(tgt),
92     numSchedClasses(NumSchedClasses), mii(& tgt.getInstrInfo()),
93     classRUsages(ClassRUsages), usageDeltas(UsageDeltas),
94     issueDeltas(IssueDeltas), numUsageDeltas(NumUsageDeltas),
95     numIssueDeltas(NumIssueDeltas)
96 {}
97
98 void
99 TargetSchedInfo::initializeResources()
100 {
101   assert(MAX_NUM_SLOTS >= (int)getMaxNumIssueTotal()
102          && "Insufficient slots for static data! Increase MAX_NUM_SLOTS");
103   
104   // First, compute common resource usage info for each class because
105   // most instructions will probably behave the same as their class.
106   // Cannot allocate a vector of InstrRUsage so new each one.
107   // 
108   std::vector<InstrRUsage> instrRUForClasses;
109   instrRUForClasses.resize(numSchedClasses);
110   for (InstrSchedClass sc = 0; sc < numSchedClasses; sc++) {
111     // instrRUForClasses.push_back(new InstrRUsage);
112     instrRUForClasses[sc].setMaxSlots(getMaxNumIssueTotal());
113     instrRUForClasses[sc].setTo(classRUsages[sc]);
114   }
115   
116   computeInstrResources(instrRUForClasses);
117   computeIssueGaps(instrRUForClasses);
118 }
119
120
121 void
122 TargetSchedInfo::computeInstrResources(const std::vector<InstrRUsage>&
123                                         instrRUForClasses)
124 {
125   int numOpCodes =  mii->getNumOpcodes();
126   instrRUsages.resize(numOpCodes);
127   
128   // First get the resource usage information from the class resource usages.
129   for (MachineOpCode op = 0; op < numOpCodes; ++op) {
130     InstrSchedClass sc = getSchedClass(op);
131     assert(sc < numSchedClasses);
132     instrRUsages[op] = instrRUForClasses[sc];
133   }
134   
135   // Now, modify the resource usages as specified in the deltas.
136   for (unsigned i = 0; i < numUsageDeltas; ++i) {
137     MachineOpCode op = usageDeltas[i].opCode;
138     assert(op < numOpCodes);
139     instrRUsages[op].addUsageDelta(usageDeltas[i]);
140   }
141   
142   // Then modify the issue restrictions as specified in the deltas.
143   for (unsigned i = 0; i < numIssueDeltas; ++i) {
144     MachineOpCode op = issueDeltas[i].opCode;
145     assert(op < numOpCodes);
146     instrRUsages[issueDeltas[i].opCode].addIssueDelta(issueDeltas[i]);
147   }
148 }
149
150
151 void
152 TargetSchedInfo::computeIssueGaps(const std::vector<InstrRUsage>&
153                                    instrRUForClasses)
154 {
155   int numOpCodes =  mii->getNumOpcodes();
156   issueGaps.resize(numOpCodes);
157   conflictLists.resize(numOpCodes);
158
159   assert(numOpCodes < (1 << MAX_OPCODE_SIZE) - 1
160          && "numOpCodes invalid for implementation of class OpCodePair!");
161
162   // First, compute issue gaps between pairs of classes based on common
163   // resources usages for each class, because most instruction pairs will
164   // usually behave the same as their class.
165   // 
166   int classPairGaps[numSchedClasses][numSchedClasses];
167   for (InstrSchedClass fromSC=0; fromSC < numSchedClasses; fromSC++)
168     for (InstrSchedClass toSC=0; toSC < numSchedClasses; toSC++) {
169       int classPairGap = ComputeMinGap(instrRUForClasses[fromSC],
170                                        instrRUForClasses[toSC]);
171       classPairGaps[fromSC][toSC] = classPairGap; 
172     }
173
174   // Now, for each pair of instructions, use the class pair gap if both
175   // instructions have identical resource usage as their respective classes.
176   // If not, recompute the gap for the pair from scratch.
177
178   longestIssueConflict = 0;
179
180   for (MachineOpCode fromOp=0; fromOp < numOpCodes; fromOp++)
181     for (MachineOpCode toOp=0; toOp < numOpCodes; toOp++) {
182       int instrPairGap = 
183         (instrRUsages[fromOp].sameAsClass && instrRUsages[toOp].sameAsClass)
184         ? classPairGaps[getSchedClass(fromOp)][getSchedClass(toOp)]
185         : ComputeMinGap(instrRUsages[fromOp], instrRUsages[toOp]);
186
187       if (instrPairGap > 0) {
188         this->setGap(instrPairGap, fromOp, toOp);
189         conflictLists[fromOp].push_back(toOp);
190         longestIssueConflict=std::max(longestIssueConflict, instrPairGap);
191       }
192     }
193 }
194
195
196 void InstrRUsage::setTo(const InstrClassRUsage& classRU) {
197   sameAsClass   = true;
198   isSingleIssue = classRU.isSingleIssue;
199   breaksGroup   = classRU.breaksGroup; 
200   numBubbles    = classRU.numBubbles;
201   
202   for (unsigned i=0; i < classRU.numSlots; i++) {
203     unsigned slot = classRU.feasibleSlots[i];
204     assert(slot < feasibleSlots.size() && "Invalid slot specified!");
205     this->feasibleSlots[slot] = true;
206   }
207   
208   numCycles   = classRU.totCycles;
209   resourcesByCycle.resize(this->numCycles);
210   
211   for (unsigned i=0; i < classRU.numRUEntries; i++)
212     for (unsigned c=classRU.V[i].startCycle, NC = c + classRU.V[i].numCycles;
213          c < NC; c++)
214       this->resourcesByCycle[c].push_back(classRU.V[i].resourceId);
215   
216   // Sort each resource usage vector by resourceId_t to speed up conflict
217   // checking
218   for (unsigned i=0; i < this->resourcesByCycle.size(); i++)
219     sort(resourcesByCycle[i].begin(), resourcesByCycle[i].end());
220 }
221
222 // Add the extra resource usage requirements specified in the delta.
223 // Note that a negative value of `numCycles' means one entry for that
224 // resource should be deleted for each cycle.
225 // 
226 void InstrRUsage::addUsageDelta(const InstrRUsageDelta &delta) {
227   int NC = delta.numCycles;
228   sameAsClass = false;
229   
230   // resize the resources vector if more cycles are specified
231   unsigned maxCycles = this->numCycles;
232   maxCycles = std::max(maxCycles, delta.startCycle + abs(NC) - 1);
233   if (maxCycles > this->numCycles) {
234     this->resourcesByCycle.resize(maxCycles);
235     this->numCycles = maxCycles;
236   }
237     
238   if (NC >= 0)
239     for (unsigned c=delta.startCycle, last=c+NC-1; c <= last; c++)
240       this->resourcesByCycle[c].push_back(delta.resourceId);
241   else
242     // Remove the resource from all NC cycles.
243     for (unsigned c=delta.startCycle, last=(c-NC)-1; c <= last; c++) {
244       // Look for the resource backwards so we remove the last entry
245       // for that resource in each cycle.
246       std::vector<resourceId_t>& rvec = this->resourcesByCycle[c];
247       int r;
248       for (r = rvec.size() - 1; r >= 0; r--)
249         if (rvec[r] == delta.resourceId) {
250           // found last entry for the resource
251           rvec.erase(rvec.begin() + r);
252           break;
253         }
254       assert(r >= 0 && "Resource to remove was unused in cycle c!");
255     }
256 }
257
258 } // End llvm namespace