memtest.hh revision 8948 
1/*
2 * Copyright (c) 2002-2005 The Regents of The University of Michigan
3 * All rights reserved.
4 *
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.
15 *
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.
27 *
28 * Authors: Erik Hallnor
29 *          Steve Reinhardt
30 */
31
32#ifndef __CPU_MEMTEST_MEMTEST_HH__
33#define __CPU_MEMTEST_MEMTEST_HH__
34
35#include <set>
36
37#include "base/fast_alloc.hh"
38#include "base/statistics.hh"
39#include "mem/mem_object.hh"
40#include "mem/port.hh"
41#include "mem/port_proxy.hh"
42#include "params/MemTest.hh"
43#include "sim/eventq.hh"
44#include "sim/sim_exit.hh"
45#include "sim/sim_object.hh"
46#include "sim/stats.hh"
47
48class Packet;
49class MemTest : public MemObject
50{
51  public:
52    typedef MemTestParams Params;
53    MemTest(const Params *p);
54
55    virtual void init();
56
57    // register statistics
58    virtual void regStats();
59
60    inline Tick ticks(int numCycles) const { return numCycles; }
61
62    // main simulation loop (one cycle)
63    void tick();
64
65    virtual MasterPort &getMasterPort(const std::string &if_name,
66                                      int idx = -1);
67
68    /**
69     * Print state of address in memory system via PrintReq (for
70     * debugging).
71     */
72    void printAddr(Addr a);
73
74  protected:
75    class TickEvent : public Event
76    {
77      private:
78        MemTest *cpu;
79
80      public:
81        TickEvent(MemTest *c) : Event(CPU_Tick_Pri), cpu(c) {}
82        void process() { cpu->tick(); }
83        virtual const char *description() const { return "MemTest tick"; }
84    };
85
86    TickEvent tickEvent;
87
88    class CpuPort : public MasterPort
89    {
90        MemTest *memtest;
91
92      public:
93
94        CpuPort(const std::string &_name, MemTest *_memtest)
95            : MasterPort(_name, _memtest), memtest(_memtest)
96        { }
97
98      protected:
99
100        virtual bool recvTiming(PacketPtr pkt);
101
102        virtual bool recvTimingSnoop(PacketPtr pkt) { return true; }
103
104        virtual Tick recvAtomicSnoop(PacketPtr pkt) { return 0; }
105
106        virtual void recvFunctionalSnoop(PacketPtr pkt) { }
107
108        virtual void recvRetry();
109    };
110
111    CpuPort cachePort;
112    CpuPort funcPort;
113    PortProxy funcProxy;
114
115    class MemTestSenderState : public Packet::SenderState, public FastAlloc
116    {
117      public:
118        /** Constructor. */
119        MemTestSenderState(uint8_t *_data)
120            : data(_data)
121        { }
122
123        // Hold onto data pointer
124        uint8_t *data;
125    };
126
127    PacketPtr retryPkt;
128
129    bool accessRetry;
130
131    //
132    // The dmaOustanding flag enforces only one dma at a time
133    //
134    bool dmaOutstanding;
135
136    unsigned size;              // size of testing memory region
137
138    unsigned percentReads;      // target percentage of read accesses
139    unsigned percentFunctional; // target percentage of functional accesses
140    unsigned percentUncacheable;
141
142    bool issueDmas;
143
144    /** Request id for all generated traffic */
145    MasterID masterId;
146
147    int id;
148
149    std::set<unsigned> outstandingAddrs;
150
151    unsigned blockSize;
152
153    Addr blockAddrMask;
154
155    Addr blockAddr(Addr addr)
156    {
157        return (addr & ~blockAddrMask);
158    }
159
160    Addr traceBlockAddr;
161
162    Addr baseAddr1;             // fix this to option
163    Addr baseAddr2;             // fix this to option
164    Addr uncacheAddr;
165
166    unsigned progressInterval;  // frequency of progress reports
167    Tick nextProgressMessage;   // access # for next progress report
168
169    unsigned percentSourceUnaligned;
170    unsigned percentDestUnaligned;
171
172    Tick noResponseCycles;
173
174    uint64_t numReads;
175    uint64_t numWrites;
176    uint64_t maxLoads;
177
178    bool atomic;
179    bool suppress_func_warnings;
180
181    Stats::Scalar numReadsStat;
182    Stats::Scalar numWritesStat;
183    Stats::Scalar numCopiesStat;
184
185    // called by MemCompleteEvent::process()
186    void completeRequest(PacketPtr pkt);
187
188    void sendPkt(PacketPtr pkt);
189
190    void doRetry();
191
192    friend class MemCompleteEvent;
193};
194
195#endif // __CPU_MEMTEST_MEMTEST_HH__
196
197
198
199