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