RubyTester.hh revision 8922 
1/*
2 * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
3 * Copyright (c) 2009 Advanced Micro Devices, Inc.
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are
8 * met: redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer;
10 * redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution;
13 * neither the name of the copyright holders nor the names of its
14 * contributors may be used to endorse or promote products derived from
15 * this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 */
29
30#ifndef __CPU_RUBYTEST_RUBYTESTER_HH__
31#define __CPU_RUBYTEST_RUBYTESTER_HH__
32
33#include <iostream>
34#include <string>
35#include <vector>
36
37#include "cpu/testers/rubytest/CheckTable.hh"
38#include "mem/ruby/common/Global.hh"
39#include "mem/ruby/common/SubBlock.hh"
40#include "mem/ruby/system/RubyPort.hh"
41#include "mem/mem_object.hh"
42#include "mem/packet.hh"
43#include "params/RubyTester.hh"
44
45class RubyTester : public MemObject
46{
47  public:
48    class CpuPort : public MasterPort
49    {
50      private:
51        RubyTester *tester;
52
53      public:
54        CpuPort(const std::string &_name, RubyTester *_tester, int _idx)
55            : MasterPort(_name, _tester), tester(_tester), idx(_idx)
56        {}
57
58        int idx;
59
60      protected:
61        virtual bool recvTiming(PacketPtr pkt);
62        virtual void recvRetry()
63        { panic("%s does not expect a retry\n", name()); }
64        virtual Tick recvAtomic(PacketPtr pkt);
65        virtual void recvFunctional(PacketPtr pkt) { }
66    };
67
68    struct SenderState : public Packet::SenderState
69    {
70        SubBlock* subBlock;
71        Packet::SenderState *saved;
72
73        SenderState(Address addr, int size,
74                    Packet::SenderState *sender_state = NULL)
75            : saved(sender_state)
76        {
77            subBlock = new SubBlock(addr, size);
78        }
79
80        ~SenderState()
81        {
82            delete subBlock;
83        }
84    };
85
86    typedef RubyTesterParams Params;
87    RubyTester(const Params *p);
88    ~RubyTester();
89
90    virtual MasterPort &getMasterPort(const std::string &if_name,
91                                      int idx = -1);
92
93    MasterPort* getCpuPort(int idx);
94
95    virtual void init();
96
97    void wakeup();
98
99    void incrementCheckCompletions() { m_checks_completed++; }
100
101    void printStats(std::ostream& out) const {}
102    void clearStats() {}
103    void printConfig(std::ostream& out) const {}
104
105    void print(std::ostream& out) const;
106    bool getCheckFlush() { return m_check_flush; }
107
108    MasterID masterId() { return _masterId; }
109  protected:
110    class CheckStartEvent : public Event
111    {
112      private:
113        RubyTester *tester;
114
115      public:
116        CheckStartEvent(RubyTester *_tester)
117            : Event(CPU_Tick_Pri), tester(_tester)
118        {}
119        void process() { tester->wakeup(); }
120        virtual const char *description() const { return "RubyTester tick"; }
121    };
122
123    CheckStartEvent checkStartEvent;
124
125    MasterID _masterId;
126
127  private:
128    void hitCallback(NodeID proc, SubBlock* data);
129
130    void checkForDeadlock();
131
132    // Private copy constructor and assignment operator
133    RubyTester(const RubyTester& obj);
134    RubyTester& operator=(const RubyTester& obj);
135
136    CheckTable* m_checkTable_ptr;
137    std::vector<Time> m_last_progress_vector;
138
139    uint64 m_checks_completed;
140    std::vector<CpuPort*> ports;
141    uint64 m_checks_to_complete;
142    int m_deadlock_threshold;
143    int m_num_cpu_sequencers;
144    int m_wakeup_frequency;
145    bool m_check_flush;
146};
147
148inline std::ostream&
149operator<<(std::ostream& out, const RubyTester& obj)
150{
151    obj.print(out);
152    out << std::flush;
153    return out;
154}
155
156#endif // __CPU_RUBYTEST_RUBYTESTER_HH__
157