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_CHECK_HH__
31#define __CPU_RUBYTEST_CHECK_HH__
32
33#include <iostream>
34
35#include "cpu/testers/rubytest/RubyTester.hh"
36#include "mem/ruby/common/Address.hh"
37#include "mem/ruby/protocol/RubyAccessMode.hh"
38#include "mem/ruby/protocol/TesterStatus.hh"
39
40class SubBlock;
41
42const int CHECK_SIZE_BITS = 2;
43const int CHECK_SIZE = (1 << CHECK_SIZE_BITS);
44
45class Check
46{
47  public:
48    Check(Addr address, Addr pc, int _num_writers,
49          int _num_readers, RubyTester* _tester);
50
51    void initiate(); // Does Action or Check or nether
52    void performCallback(NodeID proc, SubBlock* data, Cycles curTime);
53    Addr getAddress() const { return m_address; }
54    void changeAddress(Addr address);
55
56    void print(std::ostream& out) const;
57
58  private:
59    void initiateFlush();
60    void initiatePrefetch();
61    void initiateAction();
62    void initiateCheck();
63
64    void pickValue();
65    void pickInitiatingNode();
66
67    void debugPrint();
68
69    TesterStatus m_status;
70    uint8_t m_value;
71    int m_store_count;
72    NodeID m_initiatingNode;
73    Addr m_address;
74    Addr m_pc;
75    RubyAccessMode m_access_mode;
76    int m_num_writers;
77    int m_num_readers;
78    RubyTester* m_tester_ptr;
79};
80
81inline std::ostream&
82operator<<(std::ostream& out, const Check& obj)
83{
84    obj.print(out);
85    out << std::flush;
86    return out;
87}
88
89#endif // __CPU_RUBYTEST_CHECK_HH__
90