SubBlock.hh revision 6154:6bb54dcb940e 
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/*
31 * $Id$
32 *
33 */
34
35#ifndef SubBlock_H
36#define SubBlock_H
37
38#include "mem/ruby/common/Global.hh"
39#include "mem/ruby/common/Address.hh"
40#include "mem/ruby/config/RubyConfig.hh"
41#include "mem/ruby/common/DataBlock.hh"
42#include "mem/gems_common/Vector.hh"
43
44class SubBlock {
45public:
46  // Constructors
47  SubBlock() { }
48  SubBlock(const Address& addr, int size);
49  SubBlock(const Address& addr, const Address& logicalAddress, int size);
50
51  // Destructor
52  ~SubBlock() { }
53
54  // Public Methods
55  const Address& getAddress() const { return m_address; }
56  const Address& getLogicalAddress() const { return m_logicalAddress; }
57  void setAddress(const Address& addr) { m_address = addr; }
58  void setLogicalAddress(const Address& addr) { m_logicalAddress = addr; }
59
60  int getSize() const { return m_data.size(); }
61  void setSize(int size) {  m_data.setSize(size); }
62  uint8 getByte(int offset) const { return m_data[offset]; }
63  void setByte(int offset, uint8 data) { m_data[offset] = data; }
64
65  // Shorthands
66  uint8 readByte() const { return getByte(0); }
67  void writeByte(uint8 data) { setByte(0, data); }
68
69  // Merging to and from DataBlocks - We only need to worry about
70  // updates when we are using DataBlocks
71  void mergeTo(DataBlock& data) const { if (DATA_BLOCK) { internalMergeTo(data); } }
72  void mergeFrom(const DataBlock& data) { if (DATA_BLOCK) { internalMergeFrom(data); } }
73
74  void print(ostream& out) const;
75private:
76  // Private Methods
77  //  SubBlock(const SubBlock& obj);
78  //  SubBlock& operator=(const SubBlock& obj);
79  //  bool bytePresent(const Address& addr) { return ((addr.getAddress() >= m_address.getAddress()) && (addr.getAddress() < (m_address.getAddress()+getSize()))); }
80  //  uint8 getByte(const Address& addr) { return m_data[addr.getAddress() - m_address.getAddress()]; }
81
82  void internalMergeTo(DataBlock& data) const;
83  void internalMergeFrom(const DataBlock& data);
84
85  // Data Members (m_ prefix)
86  Address m_address;
87  Address m_logicalAddress;
88  Vector<uint> m_data;
89};
90
91// Output operator declaration
92ostream& operator<<(ostream& out, const SubBlock& obj);
93
94// ******************* Definitions *******************
95
96// Output operator definition
97extern inline
98ostream& operator<<(ostream& out, const SubBlock& obj)
99{
100  obj.print(out);
101  out << flush;
102  return out;
103}
104
105#endif //SubBlock_H
106