summaryrefslogtreecommitdiff
path: root/src/mem/ruby/system/MemoryVector.hh
blob: 315e0094216e4d4047871a315cd584d56137d2a6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
/*
 * Copyright (c) 2009 Mark D. Hill and David A. Wood
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met: redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer;
 * redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution;
 * neither the name of the copyright holders nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef __MEM_RUBY_SYSTEM_MEMORYVECTOR_HH__
#define __MEM_RUBY_SYSTEM_MEMORYVECTOR_HH__

#include "base/trace.hh"
#include "debug/RubyCacheTrace.hh"
#include "mem/ruby/common/Address.hh"

class DirectoryMemory;

/**
 *  MemoryVector holds memory data (DRAM only)
 */
class MemoryVector
{
  public:
    MemoryVector();
    MemoryVector(uint32 size);
    ~MemoryVector();
    friend class DirectoryMemory;

    void resize(uint32 size);  // destructive

    void write(const Address & paddr, uint8* data, int len);
    uint8* read(const Address & paddr, uint8* data, int len);
    uint32 collatePages(uint8* &raw_data);
    void populatePages(uint8* raw_data);

  private:
    uint8* getBlockPtr(const PhysAddress & addr);

    uint32 m_size;
    uint8** m_pages;
    uint32 m_num_pages;
    const uint32 m_page_offset_mask;
    static const uint32 PAGE_SIZE = 4096;
};

inline
MemoryVector::MemoryVector()
    : m_page_offset_mask(4095)
{
    m_size = 0;
    m_num_pages = 0;
    m_pages = NULL;
}

inline
MemoryVector::MemoryVector(uint32 size)
    : m_page_offset_mask(4095)
{
    resize(size);
}

inline
MemoryVector::~MemoryVector()
{
    for (int i = 0; i < m_num_pages; i++) {
        if (m_pages[i] != 0) {
            delete [] m_pages[i];
        }
    }
    delete [] m_pages;
}

inline void
MemoryVector::resize(uint32 size)
{
    if (m_pages != NULL){
        for (int i = 0; i < m_num_pages; i++) {
            if (m_pages[i] != 0) {
                delete [] m_pages[i];
            }
        }
        delete [] m_pages;
    }
    m_size = size;
    assert(size%PAGE_SIZE == 0);
    m_num_pages = size >> 12;
    m_pages = new uint8*[m_num_pages];
    memset(m_pages, 0, m_num_pages * sizeof(uint8*));
}

inline void
MemoryVector::write(const Address & paddr, uint8* data, int len)
{
    assert(paddr.getAddress() + len <= m_size);
    uint32 page_num = paddr.getAddress() >> 12;
    if (m_pages[page_num] == 0) {
        bool all_zeros = true;
        for (int i = 0; i < len;i++) {
            if (data[i] != 0) {
                all_zeros = false;
                break;
            }
        }
        if (all_zeros)
            return;
        m_pages[page_num] = new uint8[PAGE_SIZE];
        memset(m_pages[page_num], 0, PAGE_SIZE);
        uint32 offset = paddr.getAddress() & m_page_offset_mask;
        memcpy(&m_pages[page_num][offset], data, len);
    } else {
        memcpy(&m_pages[page_num][paddr.getAddress()&m_page_offset_mask],
               data, len);
    }
}

inline uint8*
MemoryVector::read(const Address & paddr, uint8* data, int len)
{
    assert(paddr.getAddress() + len <= m_size);
    uint32 page_num = paddr.getAddress() >> 12;
    if (m_pages[page_num] == 0) {
        memset(data, 0, len);
    } else {
        memcpy(data, &m_pages[page_num][paddr.getAddress()&m_page_offset_mask],
               len);
    }
    return data;
}

inline uint8*
MemoryVector::getBlockPtr(const PhysAddress & paddr)
{
    uint32 page_num = paddr.getAddress() >> 12;
    if (m_pages[page_num] == 0) {
        m_pages[page_num] = new uint8[PAGE_SIZE];
        memset(m_pages[page_num], 0, PAGE_SIZE);
    }
    return &m_pages[page_num][paddr.getAddress()&m_page_offset_mask];
}

/*!
 * Function for collating all the pages of the physical memory together.
 * In case a pointer for a page is NULL, this page needs only a single byte
 * to represent that the pointer is NULL. Otherwise, it needs 1 + PAGE_SIZE
 * bytes. The first represents that the page pointer is not NULL, and rest of
 * the bytes represent the data on the page.
 */

inline uint32
MemoryVector::collatePages(uint8* &raw_data)
{
    uint32 num_zero_pages = 0;
    uint32 data_size = 0;

    for (uint32 i = 0;i < m_num_pages; ++i)
    {
        if (m_pages[i] == 0) num_zero_pages++;
    }

    raw_data = new uint8[  sizeof(uint32) /* number of pages*/
                         + m_num_pages /* whether the page is all zeros */
                         + PAGE_SIZE * (m_num_pages - num_zero_pages)];

    /* Write the number of pages to be stored. */
    memcpy(raw_data, &m_num_pages, sizeof(uint32));
    data_size = sizeof(uint32);

    DPRINTF(RubyCacheTrace, "collating %d pages\n", m_num_pages);

    for (uint32 i = 0;i < m_num_pages; ++i)
    {
        if (m_pages[i] == 0) {
            raw_data[data_size] = 0;
        } else {
            raw_data[data_size] = 1;
            memcpy(raw_data + data_size + 1, m_pages[i], PAGE_SIZE);
            data_size += PAGE_SIZE;
        }
        data_size += 1;
    }

    return data_size;
}

/*!
 * Function for populating the pages of the memory using the available raw
 * data. Each page has a byte associate with it, which represents whether the
 * page was NULL or not, when all the pages were collated. The function assumes
 * that the number of pages in the memory are same as those that were recorded
 * in the checkpoint.
 */
inline void
MemoryVector::populatePages(uint8* raw_data)
{
    uint32 data_size = 0;
    uint32 num_pages = 0;

    /* Read the number of pages that were stored. */
    memcpy(&num_pages, raw_data, sizeof(uint32));
    data_size = sizeof(uint32);
    assert(num_pages == m_num_pages);

    DPRINTF(RubyCacheTrace, "Populating %d pages\n", num_pages);

    for (uint32 i = 0;i < m_num_pages; ++i)
    {
        assert(m_pages[i] == 0);
        if (raw_data[data_size] != 0) {
            m_pages[i] = new uint8[PAGE_SIZE];
            memcpy(m_pages[i], raw_data + data_size + 1, PAGE_SIZE);
            data_size += PAGE_SIZE;
        }
        data_size += 1;
    }
}

#endif // __MEM_RUBY_SYSTEM_MEMORYVECTOR_HH__