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