sim: Move the draining interface into a separate base class
[gem5.git] / src / cpu / testers / directedtest / InvalidateGenerator.hh
1 /*
2 * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
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
29 //
30 // This Directed Generator generates GETX requests for all nodes in the
31 // system. The GETX requests are generated one at a time in round-robin fashion
32 // 0...1...2...etc.
33 //
34
35 #ifndef __CPU_DIRECTEDTEST_INVALIDATEGENERATOR_HH__
36 #define __CPU_DIRECTEDTEST_INVALIDATEGENERATOR_HH__
37
38 #include "cpu/testers/directedtest/DirectedGenerator.hh"
39 #include "cpu/testers/directedtest/RubyDirectedTester.hh"
40 #include "mem/protocol/InvalidateGeneratorStatus.hh"
41 #include "params/InvalidateGenerator.hh"
42
43 class InvalidateGenerator : public DirectedGenerator
44 {
45 public:
46 typedef InvalidateGeneratorParams Params;
47 InvalidateGenerator(const Params *p);
48
49 ~InvalidateGenerator();
50
51 bool initiate();
52 void performCallback(uint32_t proc, Addr address);
53
54 private:
55 InvalidateGeneratorStatus m_status;
56 Addr m_address;
57 uint32_t m_active_read_node;
58 uint32_t m_active_inv_node;
59 uint32_t m_addr_increment_size;
60 };
61
62 #endif //__CPU_DIRECTEDTEST_INVALIDATEGENERATOR_HH__
63