CheckTable.hh revision 7002 
1
2/*
3 * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
4 * Copyright (c) 2009 Advanced Micro Devices, Inc.
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions are
9 * met: redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer;
11 * redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution;
14 * neither the name of the copyright holders nor the names of its
15 * contributors may be used to endorse or promote products derived from
16 * this software without specific prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 */
30
31#ifndef CHECKTABLE_H
32#define CHECKTABLE_H
33
34#include <iostream>
35
36#include "mem/ruby/common/Global.hh"
37#include "mem/gems_common/Vector.hh"
38
39class Address;
40class Check;
41class RubyTester;
42template <class KEY_TYPE, class VALUE_TYPE> class Map;
43
44class CheckTable {
45public:
46  // Constructors
47  CheckTable(int _num_cpu_sequencers, RubyTester* _tester);
48
49  // Destructor
50  ~CheckTable();
51
52  // Public Methods
53
54  Check* getRandomCheck();
55  Check* getCheck(const Address& address);
56
57  //  bool isPresent(const Address& address) const;
58  //  void removeCheckFromTable(const Address& address);
59  //  bool isTableFull() const;
60  // Need a method to select a check or retrieve a check
61
62  void print(std::ostream& out) const;
63private:
64  // Private Methods
65  void addCheck(const Address& address);
66
67  // Private copy constructor and assignment operator
68  CheckTable(const CheckTable& obj);
69  CheckTable& operator=(const CheckTable& obj);
70
71  // Data Members (m_ prefix)
72  Vector<Check*> m_check_vector;
73  Map<Address, Check*>* m_lookup_map_ptr;
74
75  int m_num_cpu_sequencers;
76  RubyTester* m_tester_ptr;
77};
78
79// Output operator declaration
80std::ostream& operator<<(std::ostream& out, const CheckTable& obj);
81
82// ******************* Definitions *******************
83
84// Output operator definition
85extern inline
86std::ostream& operator<<(std::ostream& out, const CheckTable& obj)
87{
88  obj.print(out);
89  out << std::flush;
90  return out;
91}
92
93#endif //CHECKTABLE_H
94