CheckTable.hh revision 6899 
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 "mem/ruby/common/Global.hh"
35#include "mem/gems_common/Vector.hh"
36
37class Address;
38class Check;
39class RubyTester;
40template <class KEY_TYPE, class VALUE_TYPE> class Map;
41
42class CheckTable {
43public:
44  // Constructors
45  CheckTable(int _num_cpu_sequencers, RubyTester* _tester);
46
47  // Destructor
48  ~CheckTable();
49
50  // Public Methods
51
52  Check* getRandomCheck();
53  Check* getCheck(const Address& address);
54
55  //  bool isPresent(const Address& address) const;
56  //  void removeCheckFromTable(const Address& address);
57  //  bool isTableFull() const;
58  // Need a method to select a check or retrieve a check
59
60  void print(ostream& out) const;
61private:
62  // Private Methods
63  void addCheck(const Address& address);
64
65  // Private copy constructor and assignment operator
66  CheckTable(const CheckTable& obj);
67  CheckTable& operator=(const CheckTable& obj);
68
69  // Data Members (m_ prefix)
70  Vector<Check*> m_check_vector;
71  Map<Address, Check*>* m_lookup_map_ptr;
72
73  int m_num_cpu_sequencers;
74  RubyTester* m_tester_ptr;
75};
76
77// Output operator declaration
78ostream& operator<<(ostream& out, const CheckTable& obj);
79
80// ******************* Definitions *******************
81
82// Output operator definition
83extern inline
84ostream& operator<<(ostream& out, const CheckTable& obj)
85{
86  obj.print(out);
87  out << flush;
88  return out;
89}
90
91#endif //CHECKTABLE_H
92