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