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