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