src/mem/ruby/common/SubBlock.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  * $Id$
  32  *
  33  */
  34
  35 #ifndef SubBlock_H
  36 #define SubBlock_H
  37
  38 #include "mem/ruby/common/Global.hh"
  39 #include "mem/ruby/common/Address.hh"
  40 #include "mem/ruby/common/DataBlock.hh"
  41 #include "mem/gems_common/Vector.hh"
  42
  43 class SubBlock {
  44 public:
  45   // Constructors
  46   SubBlock() { }
  47   SubBlock(const Address& addr, int size);
  48
  49   // Destructor
  50   ~SubBlock() { }
  51
  52   // Public Methods
  53   const Address& getAddress() const { return m_address; }
  54   void setAddress(const Address& addr) { m_address = addr; }
  55
  56   int getSize() const { return m_data.size(); }
  57   void setSize(int size) {  m_data.setSize(size); }
  58   uint8 getByte(int offset) const { return m_data[offset]; }
  59   void setByte(int offset, uint8 data) { m_data[offset] = data; }
  60
  61   // Shorthands
  62   uint8 readByte() const { return getByte(0); }
  63   void writeByte(uint8 data) { setByte(0, data); }
  64
  65   // Merging to and from DataBlocks - We only need to worry about
  66   // updates when we are using DataBlocks
  67   void mergeTo(DataBlock& data) const { internalMergeTo(data); }
  68   void mergeFrom(const DataBlock& data) { internalMergeFrom(data); }
  69
  70   void print(ostream& out) const;
  71 private:
  72
  73   void internalMergeTo(DataBlock& data) const;
  74   void internalMergeFrom(const DataBlock& data);
  75
  76   // Data Members (m_ prefix)
  77   Address m_address;
  78   Vector<uint> m_data;
  79 };
  80
  81 // Output operator declaration
  82 ostream& operator<<(ostream& out, const SubBlock& obj);
  83
  84 // ******************* Definitions *******************
  85
  86 // Output operator definition
  87 extern inline
  88 ostream& operator<<(ostream& out, const SubBlock& obj)
  89 {
  90   obj.print(out);
  91   out << flush;
  92   return out;
  93 }
  94
  95 #endif //SubBlock_H