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/config/RubyConfig.hh"
  35 #include "mem/gems_common/Vector.hh"
  36
  37 class DataBlock {
  38 public:
  39   // Constructors
  40   DataBlock();
  41
  42   // Destructor
  43   ~DataBlock();
  44
  45   // Public Methods
  46   void clear();
  47   uint8 getByte(int whichByte) const;
  48   void setByte(int whichByte, uint8 data);
  49   bool equal(const DataBlock& obj) const;
  50   void print(ostream& out) const;
  51
  52 private:
  53   // Private Methods
  54
  55   // Data Members (m_ prefix)
  56   Vector<uint8> m_data;
  57 };
  58
  59 // Output operator declaration
  60 ostream& operator<<(ostream& out, const DataBlock& obj);
  61
  62 bool operator==(const DataBlock& obj1, const DataBlock& obj2);
  63
  64
  65 // ******************* Definitions *******************
  66
  67 // Output operator definition
  68 extern inline
  69 ostream& operator<<(ostream& out, const DataBlock& obj)
  70 {
  71   obj.print(out);
  72   out << flush;
  73   return out;
  74 }
  75
  76 extern inline
  77 bool operator==(const DataBlock& obj1,const DataBlock& obj2)
  78 {
  79   return (obj1.equal(obj2));
  80 }
  81
  82 #endif //DATABLOCK_H