src/mem/ruby/common/DataBlock.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_DATABLOCK_HH__
  30 #define __MEM_RUBY_COMMON_DATABLOCK_HH__
  31
  32 #include <iomanip>
  33 #include <iostream>
  34
  35 #include "mem/gems_common/Vector.hh"
  36 #include "mem/ruby/common/Global.hh"
  37 #include "mem/ruby/system/System.hh"
  38
  39 class DataBlock
  40 {
  41   public:
  42     DataBlock()
  43     {
  44         alloc();
  45     }
  46
  47     DataBlock(const DataBlock &cp)
  48     {
  49         m_data = new uint8[RubySystem::getBlockSizeBytes()];
  50         memcpy(m_data, cp.m_data, RubySystem::getBlockSizeBytes());
  51         m_alloc = true;
  52     }
  53
  54     ~DataBlock()
  55     {
  56         if (m_alloc)
  57             delete [] m_data;
  58     }
  59
  60     DataBlock& operator=(const DataBlock& obj);
  61
  62     void assign(uint8* data);
  63
  64     void clear();
  65     uint8 getByte(int whichByte) const;
  66     const uint8* getData(int offset, int len) const;
  67     void setByte(int whichByte, uint8 data);
  68     void setData(uint8* data, int offset, int len);
  69     void copyPartial(const DataBlock & dblk, int offset, int len);
  70     bool equal(const DataBlock& obj) const;
  71     void print(std::ostream& out) const;
  72
  73   private:
  74     void alloc();
  75     uint8* m_data;
  76     bool m_alloc;
  77 };
  78
  79 inline void
  80 DataBlock::assign(uint8* data)
  81 {
  82     if (m_alloc) {
  83         delete [] m_data;
  84     }
  85     m_data = data;
  86     m_alloc = false;
  87 }
  88
  89 inline void
  90 DataBlock::alloc()
  91 {
  92     m_data = new uint8[RubySystem::getBlockSizeBytes()];
  93     m_alloc = true;
  94     clear();
  95 }
  96
  97 inline void
  98 DataBlock::clear()
  99 {
 100     memset(m_data, 0, RubySystem::getBlockSizeBytes());
 101 }
 102
 103 inline bool
 104 DataBlock::equal(const DataBlock& obj) const
 105 {
 106     return !memcmp(m_data, obj.m_data, RubySystem::getBlockSizeBytes());
 107 }
 108
 109 inline void
 110 DataBlock::print(std::ostream& out) const
 111 {
 112     using namespace std;
 113
 114     int size = RubySystem::getBlockSizeBytes();
 115     out << "[ ";
 116     for (int i = 0; i < size; i++) {
 117         out << setw(2) << setfill('0') << hex << "0x" << (int)m_data[i] << " ";
 118         out << setfill(' ');
 119     }
 120     out << dec << "]" << flush;
 121 }
 122
 123 inline uint8
 124 DataBlock::getByte(int whichByte) const
 125 {
 126     return m_data[whichByte];
 127 }
 128
 129 inline const uint8*
 130 DataBlock::getData(int offset, int len) const
 131 {
 132     assert(offset + len <= RubySystem::getBlockSizeBytes());
 133     return &m_data[offset];
 134 }
 135
 136 inline void
 137 DataBlock::setByte(int whichByte, uint8 data)
 138 {
 139     m_data[whichByte] = data;
 140 }
 141
 142 inline void
 143 DataBlock::setData(uint8* data, int offset, int len)
 144 {
 145     assert(offset + len <= RubySystem::getBlockSizeBytes());
 146     memcpy(&m_data[offset], data, len);
 147 }
 148
 149 inline void
 150 DataBlock::copyPartial(const DataBlock & dblk, int offset, int len)
 151 {
 152     setData(&dblk.m_data[offset], offset, len);
 153 }
 154
 155 inline std::ostream&
 156 operator<<(std::ostream& out, const DataBlock& obj)
 157 {
 158     obj.print(out);
 159     out << std::flush;
 160     return out;
 161 }
 162
 163 inline bool
 164 operator==(const DataBlock& obj1,const DataBlock& obj2)
 165 {
 166     return obj1.equal(obj2);
 167 }
 168
 169 #endif // __MEM_RUBY_COMMON_DATABLOCK_HH__