src/mem/ruby/common/SubBlock.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 #ifndef __MEM_RUBY_COMMON_SUBBLOCK_HH__
  30 #define __MEM_RUBY_COMMON_SUBBLOCK_HH__
  31
  32 #include <iostream>
  33 #include <vector>
  34
  35 #include "mem/ruby/common/Address.hh"
  36 #include "mem/ruby/common/DataBlock.hh"
  37
  38 class SubBlock
  39 {
  40   public:
  41     SubBlock() { }
  42     SubBlock(Addr addr, int size);
  43     ~SubBlock() { }
  44
  45     Addr getAddress() const { return m_address; }
  46     void setAddress(Addr addr) { m_address = addr; }
  47
  48     int getSize() const { return m_data.size(); }
  49     void resize(int size) {  m_data.resize(size); }
  50     uint8_t getByte(int offset) const { return m_data[offset]; }
  51     void setByte(int offset, uint8_t data) { m_data[offset] = data; }
  52
  53     // Shorthands
  54     uint8_t readByte() const { return getByte(0); }
  55     void writeByte(uint8_t data) { setByte(0, data); }
  56
  57     // Merging to and from DataBlocks - We only need to worry about
  58     // updates when we are using DataBlocks
  59     void mergeTo(DataBlock& data) const { internalMergeTo(data); }
  60     void mergeFrom(const DataBlock& data) { internalMergeFrom(data); }
  61
  62     void print(std::ostream& out) const;
  63
  64   private:
  65     void internalMergeTo(DataBlock& data) const;
  66     void internalMergeFrom(const DataBlock& data);
  67
  68     // Data Members (m_ prefix)
  69     Addr m_address;
  70     std::vector<uint8_t> m_data;
  71 };
  72
  73 inline std::ostream&
  74 operator<<(std::ostream& out, const SubBlock& obj)
  75 {
  76     obj.print(out);
  77     out << std::flush;
  78     return out;
  79 }
  80
  81 #endif // __MEM_RUBY_COMMON_SUBBLOCK_HH__