src/cpu/testers/rubytest/CheckTable.hh

   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_CHECKTABLE_HH__
  31 #define __CPU_RUBYTEST_CHECKTABLE_HH__
  32
  33 #include <iostream>
  34 #include <unordered_map>
  35 #include <vector>
  36
  37 #include "mem/ruby/common/Address.hh"
  38
  39 class Check;
  40 class RubyTester;
  41
  42 class CheckTable
  43 {
  44   public:
  45     CheckTable(int _num_writers, int _num_readers, RubyTester* _tester);
  46     ~CheckTable();
  47
  48     Check* getRandomCheck();
  49     Check* getCheck(Addr address);
  50
  51     //  bool isPresent(const Address& address) const;
  52     //  void removeCheckFromTable(const Address& address);
  53     //  bool isTableFull() const;
  54     // Need a method to select a check or retrieve a check
  55
  56     void print(std::ostream& out) const;
  57
  58   private:
  59     void addCheck(Addr address);
  60
  61     // Private copy constructor and assignment operator
  62     CheckTable(const CheckTable& obj);
  63     CheckTable& operator=(const CheckTable& obj);
  64
  65     std::vector<Check*> m_check_vector;
  66     std::unordered_map<Addr, Check*> m_lookup_map;
  67
  68     int m_num_writers;
  69     int m_num_readers;
  70     RubyTester* m_tester_ptr;
  71 };
  72
  73 inline std::ostream&
  74 operator<<(std::ostream& out, const CheckTable& obj)
  75 {
  76     obj.print(out);
  77     out << std::flush;
  78     return out;
  79 }
  80
  81 #endif // __CPU_RUBYTEST_CHECKTABLE_HH__