src/mem/ruby/system/TimerTable.hh

   1
   2 /*
   3  * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
   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 /*
  31  * TimerTable.h
  32  *
  33  * Description:
  34  *
  35  * $Id$
  36  *
  37  */
  38
  39 #ifndef TIMERTABLE_H
  40 #define TIMERTABLE_H
  41
  42 #include "Global.hh"
  43 #include "Map.hh"
  44 #include "Address.hh"
  45 class Consumer;
  46 class Chip;
  47
  48 class TimerTable {
  49 public:
  50
  51   // Constructors
  52   TimerTable(Chip* chip_ptr);
  53
  54   // Destructor
  55   //~TimerTable();
  56
  57   // Class Methods
  58   static void printConfig(ostream& out) {}
  59
  60   // Public Methods
  61   void setConsumer(Consumer* consumer_ptr) { ASSERT(m_consumer_ptr==NULL); m_consumer_ptr = consumer_ptr; }
  62   void setDescription(const string& name) { m_name = name; }
  63
  64   bool isReady() const;
  65   const Address& readyAddress() const;
  66   bool isSet(const Address& address) const { return m_map.exist(address); }
  67   void set(const Address& address, Time relative_latency);
  68   void unset(const Address& address);
  69   void print(ostream& out) const;
  70 private:
  71   // Private Methods
  72   void updateNext() const;
  73
  74   // Private copy constructor and assignment operator
  75   TimerTable(const TimerTable& obj);
  76   TimerTable& operator=(const TimerTable& obj);
  77
  78   // Data Members (m_prefix)
  79   Map<Address, Time> m_map;
  80   Chip* m_chip_ptr;
  81   mutable bool m_next_valid;
  82   mutable Time m_next_time; // Only valid if m_next_valid is true
  83   mutable Address m_next_address;  // Only valid if m_next_valid is true
  84   Consumer* m_consumer_ptr;  // Consumer to signal a wakeup()
  85   string m_name;
  86 };
  87
  88 // ******************* Definitions *******************
  89
  90 // Output operator definition
  91 extern inline
  92 ostream& operator<<(ostream& out, const TimerTable& obj)
  93 {
  94   obj.print(out);
  95   out << flush;
  96   return out;
  97 }
  98 #endif //TIMERTABLE_H