2 * Copyright (c) 2006-2009 The Regents of The University of Michigan
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met: redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer;
9 * redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution;
12 * neither the name of the copyright holders nor the names of its
13 * contributors may be used to endorse or promote products derived from
14 * this software without specific prior written permission.
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 #ifndef __BASE__CP_ANNOTATE_HH__
32 #define __BASE__CP_ANNOTATE_HH__
34 #include "base/loader/symtab.hh"
35 #include "config/cp_annotate.hh"
36 #include "sim/host.hh"
37 #include "sim/serialize.hh"
38 #include "sim/startup.hh"
39 #include "sim/system.hh"
45 #include "base/hashmap.hh"
46 #include "base/trace.hh"
48 #include "params/CPA.hh"
69 static CPA *cpa() { return NULL; }
70 static bool available() { return false; }
71 bool enabled() { return false; }
72 void swSmBegin(ThreadContext *tc) { return; }
73 void swSmEnd(ThreadContext *tc) { return; }
74 void swExplictBegin(ThreadContext *tc) { return; }
75 void swAutoBegin(ThreadContext *tc, Addr next_pc) { return; }
76 void swEnd(ThreadContext *tc) { return; }
77 void swQ(ThreadContext *tc) { return; }
78 void swDq(ThreadContext *tc) { return; }
79 void swPq(ThreadContext *tc) { return; }
80 void swRq(ThreadContext *tc) { return; }
81 void swWf(ThreadContext *tc) { return; }
82 void swWe(ThreadContext *tc) { return; }
83 void swSq(ThreadContext *tc) { return; }
84 void swAq(ThreadContext *tc) { return; }
85 void swLink(ThreadContext *tc) { return; }
86 void swIdentify(ThreadContext *tc) { return; }
87 uint64_t swGetId(ThreadContext *tc) { return 0; }
88 void swSyscallLink(ThreadContext *tc) { return; }
89 void hwBegin(flags f, System *sys, uint64_t frame, std::string sm,
90 std::string st) { return; }
91 void hwQ(flags f, System *sys, uint64_t frame, std::string sm,
92 std::string q, uint64_t qid, System *q_sys = NULL,
93 int32_t count = 1) { return; }
94 void hwDq(flags f, System *sys, uint64_t frame, std::string sm,
95 std::string q, uint64_t qid, System *q_sys = NULL,
96 int32_t count = 1) { return; }
97 void hwPq(flags f, System *sys, uint64_t frame, std::string sm,
98 std::string q, uint64_t qid, System *q_sys = NULL,
99 int32_t count = 1) { return; }
100 void hwRq(flags f, System *sys, uint64_t frame, std::string sm,
101 std::string q, uint64_t qid, System *q_sys = NULL,
102 int32_t count = 1) { return; }
103 void hwWf(flags f, System *sys, uint64_t frame, std::string sm,
104 std::string q, uint64_t qid, System *q_sys = NULL,
105 int32_t count = 1) { return; }
106 void hwWe(flags f, System *sys, uint64_t frame, std::string sm,
107 std::string q, uint64_t qid, System *q_sys = NULL,
108 int32_t count = 1) { return; }
111 class CPA : SimObject
114 typedef CPAParams Params;
116 /** The known operations that are written to the annotation output file. */
119 OP_WAIT_EMPTY = 0x02,
123 OP_SIZE_QUEUE = 0x08,
130 /** Flags for the various options.*/
134 /* operation was done on hardware */
136 /* operation should cause a warning when encountered */
138 /* Queue like a stack, not a queue */
140 /* Mark HW state as waiting for some non-resource constraint
141 * (e.g. wait because SM only starts after 10 items are queued) */
143 /* operation is linking to another state machine */
145 /* queue should be completely cleared/reset before executing this
156 return dynamic_cast<const Params *>(_params);
159 /* struct that is written to the annotation output file */
160 struct AnnotateData : public RefCounted {
172 void serialize(std::ostream &os);
173 void unserialize(Checkpoint *cp, const std::string §ion);
177 typedef RefCountingPtr<AnnotateData> AnnDataPtr;
179 /* header for the annotation file */
180 struct AnnotateHeader {
191 std::vector<uint64_t> annotateIdx;
193 // number of state machines encountered in the simulation
195 // number of states encountered in the simulation
197 // number of states/queues for a given state machine/system respectively
198 std::vector<int> numSt, numQ;
199 // number of systems in the simulation
201 // number of queues in the state machine
203 // maximum connection id assigned so far
206 // Convert state strings into state ids
207 typedef m5::hash_map<std::string, int> SCache;
208 typedef std::vector<SCache> StCache;
210 // Convert sm and queue name,id into queue id
211 typedef std::pair<std::string, uint64_t> Id;
212 typedef m5::hash_map<Id, int> IdHCache;
213 typedef std::vector<IdHCache> IdCache;
215 // Hold mapping of sm and queues to output python
216 typedef std::vector<std::pair<int, Id> > IdMap;
218 // System pointer to name,id
219 typedef std::map<System*, std::pair<std::string, int> > NameCache;
221 // array of systems each of which is a stack of running sm
222 typedef std::pair<int, uint64_t> StackId;
223 typedef std::map<StackId, std::vector<int> > SmStack;
225 // map of each context and if it's currently in explict state mode
226 // states are not automatically updated until it leaves
227 typedef std::map<StackId, bool> SwExpl;
229 typedef std::map<int,int> IMap;
230 // List of annotate records have not been written/completed yet
231 typedef std::list<AnnDataPtr> AnnotateList;
233 // Maintain link state information
234 typedef std::map<int, int> LinkMap;
237 typedef m5::hash_map<Id, AnnDataPtr> ScHCache;
238 typedef std::vector<ScHCache> ScCache;
243 // vector indexed by queueid to find current number of elements and bytes
244 std::vector<int> qSize;
245 std::vector<int32_t> qBytes;
248 // Turn state machine string into state machine id (small int)
249 // Used for outputting key to convert id back into string
251 // Turn state machine id, state name into state id (small int)
253 // turn system, queue, and queue identify into qid (small int)
254 // turn system, state, and context into state machine id (small int)
255 IdCache qCache, smCache;
256 //Link state machines accross system calls
258 // System pointer to name,id
260 // Stack of state machines currently nested (should unwind correctly)
262 // Map of currently outstanding links
264 // If the state machine is currently exculding automatic changes
266 // Last state that a given state machine was in
268 // Hold mapping of sm and queues to output python
270 // Items still in queue, used for sanity checking
271 std::vector<AnnotateList> qData;
273 void doDq(System *sys, int flags, int cpu, int sm, std::string q, int qi,
275 void doQ(System *sys, int flags, int cpu, int sm, std::string q, int qi,
278 void doSwSmEnd(System *sys, int cpuid, std::string sm, uint64_t frame);
280 // Turn a system id, state machine string, state machine id into a small int
281 // for annotation output
283 getSm(int sysi, std::string si, uint64_t id)
286 Id smid = Id(si, id);
288 smi = smCache[sysi-1][smid];
290 smCache[sysi-1][smid] = smi = ++numSm;
292 smMap.push_back(std::make_pair<int, Id>(sysi, smid));
297 // Turn a state machine string, state string into a small int
298 // for annotation output
300 getSt(std::string sm, std::string s)
306 smi = smtCache[sm] = ++numSmt;
308 while (stCache.size() < smi) {
309 //stCache.resize(sm);
310 stCache.push_back(SCache());
313 //assert(stCache.size() == sm);
314 //assert(numSt.size() == sm);
315 sti = stCache[smi-1][s];
317 stCache[smi-1][s] = sti = ++numSt[smi-1];
321 // Turn state machine pointer into a smal int for annotation output
325 NameCache::iterator i = nameCache.find(s);
326 if (i == nameCache.end()) {
327 nameCache[s] = std::make_pair<std::string,int>(s->name(), ++numSys);
328 i = nameCache.find(s);
329 // might need to put smstackid into map here, but perhaps not
330 //smStack.push_back(std::vector<int>());
331 //swExpl.push_back(false);
333 qCache.push_back(IdHCache());
334 smCache.push_back(IdHCache());
335 scLinks.push_back(ScHCache());
337 return i->second.second;
340 // Turn queue name, and queue context into small int for
343 getQ(int sys, std::string q, uint64_t id)
348 qi = qCache[sys-1][qid];
350 qi = qCache[sys-1][qid] = ++numQs;
354 qData.push_back(AnnotateList());
356 qMap.push_back(std::make_pair<int, Id>(sys, qid));
361 void swBegin(System *sys, int cpuid, std::string st, uint64_t frame,
362 bool expl = false, int flags = FL_NONE);
364 AnnDataPtr add(int t, int f, int c, int sm, int stq, int32_t data=0);
370 /** Only allow one CPA object in a system. It doesn't make sense to have
371 * more that one per simulation because if a part of the system was
372 * important it would have annotations and queues, and with more than one
373 * object none of the sanity checking for queues will work. */
378 std::map<std::string, SymbolTable*> userApp;
381 static CPA *cpa() { return _cpa; }
382 void swSmBegin(ThreadContext *tc);
383 void swSmEnd(ThreadContext *tc);
384 void swExplictBegin(ThreadContext *tc);
385 void swAutoBegin(ThreadContext *tc, Addr next_pc);
386 void swEnd(ThreadContext *tc);
387 void swQ(ThreadContext *tc);
388 void swDq(ThreadContext *tc);
389 void swPq(ThreadContext *tc);
390 void swRq(ThreadContext *tc);
391 void swWf(ThreadContext *tc);
392 void swWe(ThreadContext *tc);
393 void swSq(ThreadContext *tc);
394 void swAq(ThreadContext *tc);
395 void swLink(ThreadContext *tc);
396 void swIdentify(ThreadContext *tc);
397 uint64_t swGetId(ThreadContext *tc);
398 void swSyscallLink(ThreadContext *tc);
400 inline void hwBegin(flags f, System *sys, uint64_t frame, std::string sm,
406 int sysi = getSys(sys);
407 int smi = getSm(sysi, sm, frame);
408 add(OP_BEGIN, FL_HW | f, 0, smi, getSt(sm, st));
410 warn("BAD state encountered: at cycle %d: %s\n", curTick, st);
413 inline void hwQ(flags f, System *sys, uint64_t frame, std::string sm,
414 std::string q, uint64_t qid, System *q_sys = NULL, int32_t count = 1)
419 int sysi = getSys(sys);
420 int qi = getQ(q_sys ? getSys(q_sys) : sysi, q, qid);
421 DPRINTFS(AnnotateQ, sys,
422 "hwQ: %s[%#x] cur size %d %d bytes: %d adding: %d\n",
423 q, qid, qSize[qi-1], qData[qi-1].size(), qBytes[qi-1], count);
424 doQ(sys, FL_HW | f, 0, getSm(sysi, sm, frame), q, qi, count);
428 inline void hwDq(flags f, System *sys, uint64_t frame, std::string sm,
429 std::string q, uint64_t qid, System *q_sys = NULL, int32_t count = 1)
434 int sysi = getSys(sys);
435 int qi = getQ(q_sys ? getSys(q_sys) : sysi, q, qid);
436 DPRINTFS(AnnotateQ, sys,
437 "hwDQ: %s[%#x] cur size %d %d bytes: %d removing: %d\n",
438 q, qid, qSize[qi-1], qData[qi-1].size(), qBytes[qi-1], count);
439 doDq(sys, FL_HW | f, 0, getSm(sysi,sm, frame), q, qi, count);
442 inline void hwPq(flags f, System *sys, uint64_t frame, std::string sm,
443 std::string q, uint64_t qid, System *q_sys = NULL, int32_t count = 1)
448 int sysi = getSys(sys);
449 int qi = getQ(q_sys ? getSys(q_sys) : sysi, q, qid);
450 DPRINTFS(AnnotateQ, sys,
451 "hwPQ: %s[%#x] cur size %d %d bytes: %d peeking: %d\n",
452 q, qid, qSize[qi-1], qData[qi-1].size(), qBytes[qi-1], count);
453 add(OP_PEEK, FL_HW | f, 0, getSm(sysi, sm, frame), qi, count);
456 inline void hwRq(flags f, System *sys, uint64_t frame, std::string sm,
457 std::string q, uint64_t qid, System *q_sys = NULL, int32_t count = 1)
462 int sysi = getSys(sys);
463 int qi = getQ(q_sys ? getSys(q_sys) : sysi, q, qid);
464 DPRINTFS(AnnotateQ, sys,
465 "hwRQ: %s[%#x] cur size %d %d bytes: %d reserving: %d\n",
466 q, qid, qSize[qi-1], qData[qi-1].size(), qBytes[qi-1], count);
467 add(OP_RESERVE, FL_HW | f, 0, getSm(sysi, sm, frame), qi, count);
470 inline void hwWf(flags f, System *sys, uint64_t frame, std::string sm,
471 std::string q, uint64_t qid, System *q_sys = NULL, int32_t count = 1)
476 int sysi = getSys(sys);
477 int qi = getQ(q_sys ? getSys(q_sys) : sysi, q, qid);
478 add(OP_WAIT_FULL, FL_HW | f, 0, getSm(sysi, sm, frame), qi, count);
481 inline void hwWe(flags f, System *sys, uint64_t frame, std::string sm,
482 std::string q, uint64_t qid, System *q_sys = NULL, int32_t count = 1)
487 int sysi = getSys(sys);
488 int qi = getQ(q_sys ? getSys(q_sys) : sysi, q, qid);
489 add(OP_WAIT_EMPTY, FL_HW | f, 0, getSm(sysi, sm, frame), qi, count);
496 // This code is ISA specific and will need to be changed
497 // if the annotation code is used for something other than Alpha
498 inline uint64_t getFrame(ThreadContext *tc)
499 { return (tc->readMiscRegNoEffect(TheISA::IPR_PALtemp23) &
502 static bool available() { return true; }
515 void serialize(std::ostream &os);
516 void unserialize(Checkpoint *cp, const std::string §ion);
519 #endif // !CP_ANNOTATE
521 #endif //__BASE__CP_ANNOTATE_HH__