summaryrefslogtreecommitdiff
path: root/src/mem/ruby/storebuffer/storebuffer.cc
blob: d6ec0959eeb32548be953682782fe82c0c86511d (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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
/*
 * Copyright (c) 1999-2008 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.
 */

#include <map>

#include "mem/ruby/common/Global.hh"
#include "mem/ruby/storebuffer/storebuffer.hh"

using namespace std;

#define SYSTEM_EXIT ASSERT(0)

// global map of request id_s to map them back to storebuffer pointers
map<uint64_t, StoreBuffer *> request_map;

void
hit(int64_t id)
{
    if (request_map.find(id) == request_map.end()) {
        ERROR_OUT("Request ID not found in the map");
        DEBUG_EXPR(STOREBUFFER_COMP, MedPrio, id);
        ASSERT(0);
    } else {
        request_map[id]->complete(id);
        request_map.erase(id);
    }
}

StoreBuffer::StoreBuffer(uint32 id, uint32 block_bits, int storebuffer_size)
{
    iseq = 0;
    tso_iseq = 0;
    char name [] = "Sequencer_";
    char port_name [13];
    sprintf(port_name, "%s%d", name, id);
    m_port = libruby_get_port(port_name, hit);
    m_hit_callback = NULL;
    ASSERT(storebuffer_size >= 0);
    m_storebuffer_size = storebuffer_size;
    m_id = id;
    m_block_size = 1 << block_bits;
    m_block_mask = ~(m_block_size - 1);
    m_buffer_size = 0;
    m_use_storebuffer = false;
    m_storebuffer_full = false;
    m_storebuffer_flushing = false;
    m_stalled_issue = true;
    if (m_storebuffer_size > 0){
        m_use_storebuffer = true;
    }

#ifdef DEBUG_WRITE_BUFFER
    DEBUG_OUT("*******storebuffer_t::Using Write Buffer? %d\n",
              m_use_storebuffer);
#endif
}

StoreBuffer::~StoreBuffer()
{
}

void
StoreBuffer::registerHitCallback(void (*hit_callback)(int64_t request_id))
{
    assert(m_hit_callback == NULL); // can't assign hit_callback twice
    m_hit_callback = hit_callback;
}


void
StoreBuffer::addToStoreBuffer(RubyRequest request)
{
    if (!m_use_storebuffer) {
        // make request to libruby
        uint64_t id = libruby_issue_request(m_port, request);
        if (request_map.find(id) != request_map.end()) {
            ERROR_OUT("Request ID is already in the map");
            DEBUG_EXPR(STOREBUFFER_COMP, MedPrio, id);
            ASSERT(0);
        } else {
            request_map.insert(make_pair(id, this));
            outstanding_requests.insert(make_pair(id, request));
        }
        return;
    }


#ifdef DEBUG_WRITE_BUFFER
    DEBUG_OUT("\n***StoreBuffer: addToStoreBuffer BEGIN, contents:\n");
    DEBUG_OUT("\n");
    DEBUG_OUT("\t INSERTING new request\n");
#endif

    buffer.push_front(SBEntry(request, NULL));

    m_buffer_size++;

    if (m_buffer_size >= m_storebuffer_size) {
        m_storebuffer_full = true;
    } else if (m_stalled_issue) {
        m_stalled_issue = false;
        issueNextStore();
    }

    iseq++;

#ifdef DEBUG_WRITE_BUFFER
    DEBUG_OUT("***StoreBuffer: addToStoreBuffer END, contents:\n");
    DEBUG_OUT("\n");
#endif
}


// Return value of -2 indicates that the load request was satisfied by
// the store buffer
// Return value of -3 indicates a partial match, so the load has to
// retry until NO_MATCH
// Alternatively we could satisfy the partial match, but tso gets
// complicated and more races
int64_t
StoreBuffer::handleLoad(RubyRequest request)
{
    if (!m_use_storebuffer) {
        // make a request to ruby
        return libruby_issue_request(m_port, request);
    }

    load_match match = checkForLoadHit(request);
    if (match == FULL_MATCH) {
        // fill data
        returnMatchedData(request);
        iseq++;
        return -2;
    } else if (match == NO_MATCH) {
        // make request to libruby and return the id
        uint64_t id = libruby_issue_request(m_port, request);
        if (request_map.find(id) != request_map.end()) {
            ERROR_OUT("Request ID is already in the map");
            DEBUG_EXPR(STOREBUFFER_COMP, MedPrio, id);
            ASSERT(0);
        } else {
            request_map.insert(make_pair(id, this));
            outstanding_requests.insert(make_pair(id, request));
        }
        iseq++;
        return id;
    } else { // partial match
        return -3;
    }
}

// This function will fill the data array if any match is found
load_match
StoreBuffer::checkForLoadHit(RubyRequest request)
{
    if (!m_use_storebuffer) {
        // this function should never be called if we are not using a
        // store buffer
        ERROR_OUT("checkForLoadHit called while write buffer is not in use");
        ASSERT(0);
    }

    physical_address_t physical_address = request.paddr;
    int len = request.len;

    uint8_t * data = new uint8_t[64];
    memset(data, 0, 64);
    for (int i = physical_address % 64; i < len; i++)
        data[i] = 1;

    bool found = false;
    physical_address_t lineaddr = physical_address & m_block_mask;

    // iterate over the buffer looking for hits
    deque<SBEntry>::iterator it = buffer.begin();
    for (; it != buffer.end(); it++) {
        RubyRequest &req = it->m_request;
        if ((req.paddr & m_block_mask) != lineaddr)
            continue;

        found = true;
        for (int i = req.paddr % 64; i < req.len; i++)
            data[i] = 0;
    }

    // if any matching entry is found, determine if all the
    // requested bytes have been matched
    if (found) {
        ASSERT(m_buffer_size > 0);
        int unmatched_bytes = 0;
        for (int i = physical_address%64; i < len; i++) {
            unmatched_bytes = unmatched_bytes + data[i];
        }
        if (unmatched_bytes == 0) {
            delete data;
            return FULL_MATCH;
        } else {
            delete data;
            return PARTIAL_MATCH;
        }
    } else {
        delete data;
        return NO_MATCH;
    }
}

void
StoreBuffer::returnMatchedData(RubyRequest request)
{
    if (!m_use_storebuffer) {
        ERROR_OUT("returnMatchedData called while write buffer is not in use");
        ASSERT(0);
    }

    uint8_t * data = new uint8_t[64];
    memset(data, 0, 64);
    uint8_t * written = new uint8_t[64];
    memset(written, 0, 64);

    physical_address_t physical_address = request.paddr;
    int len = request.len;

    ASSERT(checkForLoadHit(request) != NO_MATCH);
    physical_address_t lineaddr = physical_address & m_block_mask;
    bool found = false;
    deque<SBEntry>::iterator satisfying_store;
    deque<SBEntry>::iterator it = buffer.begin();
    for (; it != buffer.end(); it++) {
        if ((it->m_request.paddr & m_block_mask) == lineaddr) {
            if (!found) {
                found = true;
            }
            uint8_t * dataPtr = it->m_request.data;
            int offset = it->m_request.paddr%64;
            for (int i = offset; i < it->m_request.len; i++) {
                if (!written[i]) { // don't overwrite data with earlier data
                    data[i] = dataPtr[i-offset];
                    written[i] = 1;
                }
            }
        }
    }

    int i = physical_address%64;
    for (int j = 0; (i < physical_address%64 + len) && (j < len); i++, j++) {
        if (written[i]) {
            request.data[j] = data[i];
        }
    }

    delete data;
    delete written;
}

void
StoreBuffer::flushStoreBuffer()
{
    if (!m_use_storebuffer) {
        // do nothing
        return;
    }

#ifdef DEBUG_WRITE_BUFFER
    DEBUG_OUT("\n***StoreBuffer: flushStoreBuffer BEGIN, contents:\n");
    DEBUG_OUT("\n");
#endif

    m_storebuffer_flushing = (m_buffer_size > 0);
}

void
StoreBuffer::issueNextStore()
{
    SBEntry request = buffer.back();
    uint64_t id = libruby_issue_request(m_port, request.m_request);
    if (request_map.find(id) != request_map.end()) {
        assert(0);
    } else {
        request_map.insert(make_pair(id, this));
        outstanding_requests.insert(make_pair(id, request.m_request));
    }
}

void
StoreBuffer::complete(uint64_t id)
{
    if (!m_use_storebuffer) {
        m_hit_callback(id);
        return;
    }

    ASSERT(outstanding_requests.find(id) != outstanding_requests.end());
    physical_address_t physical_address =
        outstanding_requests.find(id)->second.paddr;
    RubyRequestType type = outstanding_requests.find(id)->second.type;
#ifdef DEBUG_WRITE_BUFFER
    DEBUG_OUT("\n***StoreBuffer: complete BEGIN, contents:\n");
    DEBUG_OUT("\n");
#endif

    if (type == RubyRequestType_ST) {
        physical_address_t lineaddr = physical_address & m_block_mask;

        // Note fastpath hits are handled like regular requests - they
        // must remove the WB entry!
        if (lineaddr != physical_address) {
            ERROR_OUT("error: StoreBuffer: ruby returns pa 0x%0llx "
                      "which is not a cache line: 0x%0llx\n",
                      physical_address, lineaddr);
        }

        SBEntry from_buffer = buffer.back();
        if ((from_buffer.m_request.paddr & m_block_mask) == lineaddr &&
                from_buffer.m_request.type == type) {
            buffer.pop_back();
            m_buffer_size--;
            ASSERT(m_buffer_size >= 0);

            // schedule the next request
            if (m_buffer_size > 0) {
                issueNextStore();
            } else if (m_buffer_size == 0) {
                m_storebuffer_flushing = false;
                m_stalled_issue = true;
            }

            m_storebuffer_full = false;
        } else {
            ERROR_OUT("[%d] error: StoreBuffer: at complete, address 0x%0llx "
                      "not found.\n", m_id, lineaddr);
            ERROR_OUT("StoreBuffer:: complete FAILS\n");
            ASSERT(0);
        }

#ifdef DEBUG_WRITE_BUFFER
        DEBUG_OUT("***StoreBuffer: complete END, contents:\n");
        DEBUG_OUT("\n");
#endif
    } else if (type == RubyRequestType_LD) {
        m_hit_callback(id);
    }

    // LD, ST or FETCH hit callback
    outstanding_requests.erase(id);
}

void
StoreBuffer::print()
{
    DEBUG_OUT("[%d] StoreBuffer: Total entries: %d Outstanding: %d\n",
              m_id, m_buffer_size);

    if (!m_use_storebuffer)
        DEBUG_OUT("\t WRITE BUFFER NOT USED\n");
}