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 <inttypes.h>
  33
  34 #include <cassert>
  35 #include <iomanip>
  36 #include <iostream>
  37
  38 class DataBlock
  39 {
  40   public:
  41     DataBlock()
  42     {
  43         alloc();
  44     }
  45
  46     DataBlock(const DataBlock &cp);
  47
  48     ~DataBlock()
  49     {
  50         if (m_alloc)
  51             delete [] m_data;
  52     }
  53
  54     DataBlock& operator=(const DataBlock& obj);
  55
  56     void assign(uint8_t *data);
  57
  58     void clear();
  59     uint8_t getByte(int whichByte) const;
  60     const uint8_t *getData(int offset, int len) const;
  61     void setByte(int whichByte, uint8_t data);
  62     void setData(const uint8_t *data, int offset, int len);
  63     void copyPartial(const DataBlock & dblk, int offset, int len);
  64     bool equal(const DataBlock& obj) const;
  65     void print(std::ostream& out) const;
  66
  67   private:
  68     void alloc();
  69     uint8_t *m_data;
  70     bool m_alloc;
  71 };
  72
  73 inline void
  74 DataBlock::assign(uint8_t *data)
  75 {
  76     assert(data != NULL);
  77     if (m_alloc) {
  78         delete [] m_data;
  79     }
  80     m_data = data;
  81     m_alloc = false;
  82 }
  83
  84 inline uint8_t
  85 DataBlock::getByte(int whichByte) const
  86 {
  87     return m_data[whichByte];
  88 }
  89
  90 inline void
  91 DataBlock::setByte(int whichByte, uint8_t data)
  92 {
  93     m_data[whichByte] = data;
  94 }
  95
  96 inline void
  97 DataBlock::copyPartial(const DataBlock & dblk, int offset, int len)
  98 {
  99     setData(&dblk.m_data[offset], offset, len);
 100 }
 101
 102 inline std::ostream&
 103 operator<<(std::ostream& out, const DataBlock& obj)
 104 {
 105     obj.print(out);
 106     out << std::flush;
 107     return out;
 108 }
 109
 110 inline bool
 111 operator==(const DataBlock& obj1,const DataBlock& obj2)
 112 {
 113     return obj1.equal(obj2);
 114 }
 115
 116 #endif // __MEM_RUBY_COMMON_DATABLOCK_HH__