src/mem/ruby/recorder/TraceRecord.hh

   1 /*
   2  * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are
   7  * met: redistributions of source code must retain the above copyright
   8  * notice, this list of conditions and the following disclaimer;
   9  * redistributions in binary form must reproduce the above copyright
  10  * notice, this list of conditions and the following disclaimer in the
  11  * documentation and/or other materials provided with the distribution;
  12  * neither the name of the copyright holders nor the names of its
  13  * contributors may be used to endorse or promote products derived from
  14  * this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  17  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  18  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  19  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  20  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  26  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 /*
  30  * A entry in the cache request record. It is aware of the ruby time
  31  * and can issue the request back to the cache.
  32  */
  33
  34 #ifndef __MEM_RUBY_RECORDER_TRACERECORD_HH__
  35 #define __MEM_RUBY_RECORDER_TRACERECORD_HH__
  36
  37 #include <iostream>
  38
  39 #include "mem/ruby/common/Address.hh"
  40 #include "mem/ruby/common/Global.hh"
  41 #include "mem/ruby/system/NodeID.hh"
  42 #include "mem/ruby/system/Sequencer.hh"
  43
  44 class CacheMsg;
  45
  46 class TraceRecord
  47 {
  48   public:
  49     TraceRecord(Sequencer* _sequencer, const Address& data_addr,
  50         const Address& pc_addr, RubyRequestType type, Time time);
  51
  52     TraceRecord()
  53     {
  54         m_sequencer_ptr = NULL;
  55         m_time = 0;
  56         m_type = RubyRequestType_NULL;
  57     }
  58
  59     TraceRecord(const TraceRecord& obj);
  60     TraceRecord& operator=(const TraceRecord& obj);
  61
  62     void issueRequest() const;
  63
  64     void print(std::ostream& out) const;
  65     void output(std::ostream& out) const;
  66     bool input(std::istream& in);
  67
  68   private:
  69     friend bool operator>(const TraceRecord& n1, const TraceRecord& n2);
  70
  71     Sequencer* m_sequencer_ptr;
  72     Time m_time;
  73     Address m_data_address;
  74     Address m_pc_address;
  75     RubyRequestType m_type;
  76 };
  77
  78 inline bool
  79 operator>(const TraceRecord& n1, const TraceRecord& n2)
  80 {
  81     return n1.m_time > n2.m_time;
  82 }
  83
  84 inline std::ostream&
  85 operator<<(std::ostream& out, const TraceRecord& obj)
  86 {
  87     obj.print(out);
  88     out << std::flush;
  89     return out;
  90 }
  91
  92 #endif // __MEM_RUBY_RECORDER_TRACERECORD_HH__