SubBlock.hh revision 7039 
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_SUBBLOCK_HH__
30#define __MEM_RUBY_COMMON_SUBBLOCK_HH__
31
32#include "mem/gems_common/Vector.hh"
33#include "mem/ruby/common/Address.hh"
34#include "mem/ruby/common/DataBlock.hh"
35#include "mem/ruby/common/Global.hh"
36
37class SubBlock
38{
39  public:
40    SubBlock() { }
41    SubBlock(const Address& addr, int size);
42    ~SubBlock() { }
43
44    const Address& getAddress() const { return m_address; }
45    void setAddress(const Address& addr) { m_address = addr; }
46
47    int getSize() const { return m_data.size(); }
48    void setSize(int size) {  m_data.setSize(size); }
49    uint8 getByte(int offset) const { return m_data[offset]; }
50    void setByte(int offset, uint8 data) { m_data[offset] = data; }
51
52    // Shorthands
53    uint8 readByte() const { return getByte(0); }
54    void writeByte(uint8 data) { setByte(0, data); }
55
56    // Merging to and from DataBlocks - We only need to worry about
57    // updates when we are using DataBlocks
58    void mergeTo(DataBlock& data) const { internalMergeTo(data); }
59    void mergeFrom(const DataBlock& data) { internalMergeFrom(data); }
60
61    void print(ostream& out) const;
62
63  private:
64    void internalMergeTo(DataBlock& data) const;
65    void internalMergeFrom(const DataBlock& data);
66
67    // Data Members (m_ prefix)
68    Address m_address;
69    Vector<uint8_t> m_data;
70};
71
72inline ostream&
73operator<<(ostream& out, const SubBlock& obj)
74{
75    obj.print(out);
76    out << flush;
77    return out;
78}
79
80#endif // __MEM_RUBY_COMMON_SUBBLOCK_HH__
81