packet.cc revision 5507:52bcc301b467 
1/*
2 * Copyright (c) 2006 The Regents of The University of Michigan
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 * Authors: Ali Saidi
29 *          Steve Reinhardt
30 */
31
32/**
33 * @file
34 * Definition of the Packet Class, a packet is a transaction occuring
35 * between a single level of the memory heirarchy (ie L1->L2).
36 */
37
38#include <iostream>
39#include <cstring>
40#include "base/cprintf.hh"
41#include "base/misc.hh"
42#include "base/trace.hh"
43#include "mem/packet.hh"
44
45// The one downside to bitsets is that static initializers can get ugly.
46#define SET1(a1)                     (1 << (a1))
47#define SET2(a1, a2)                 (SET1(a1) | SET1(a2))
48#define SET3(a1, a2, a3)             (SET2(a1, a2) | SET1(a3))
49#define SET4(a1, a2, a3, a4)         (SET3(a1, a2, a3) | SET1(a4))
50#define SET5(a1, a2, a3, a4, a5)     (SET4(a1, a2, a3, a4) | SET1(a5))
51#define SET6(a1, a2, a3, a4, a5, a6) (SET5(a1, a2, a3, a4, a5) | SET1(a6))
52
53const MemCmd::CommandInfo
54MemCmd::commandInfo[] =
55{
56    /* InvalidCmd */
57    { 0, InvalidCmd, "InvalidCmd" },
58    /* ReadReq */
59    { SET3(IsRead, IsRequest, NeedsResponse), ReadResp, "ReadReq" },
60    /* ReadResp */
61    { SET3(IsRead, IsResponse, HasData), InvalidCmd, "ReadResp" },
62    /* ReadRespWithInvalidate */
63    { SET4(IsRead, IsResponse, HasData, IsInvalidate),
64            InvalidCmd, "ReadRespWithInvalidate" },
65    /* WriteReq */
66    { SET5(IsWrite, NeedsExclusive, IsRequest, NeedsResponse, HasData),
67            WriteResp, "WriteReq" },
68    /* WriteResp */
69    { SET3(IsWrite, NeedsExclusive, IsResponse), InvalidCmd, "WriteResp" },
70    /* Writeback */
71    { SET4(IsWrite, NeedsExclusive, IsRequest, HasData),
72            InvalidCmd, "Writeback" },
73    /* SoftPFReq */
74    { SET4(IsRead, IsRequest, IsSWPrefetch, NeedsResponse),
75            SoftPFResp, "SoftPFReq" },
76    /* HardPFReq */
77    { SET4(IsRead, IsRequest, IsHWPrefetch, NeedsResponse),
78            HardPFResp, "HardPFReq" },
79    /* SoftPFResp */
80    { SET4(IsRead, IsResponse, IsSWPrefetch, HasData),
81            InvalidCmd, "SoftPFResp" },
82    /* HardPFResp */
83    { SET4(IsRead, IsResponse, IsHWPrefetch, HasData),
84            InvalidCmd, "HardPFResp" },
85    /* WriteInvalidateReq */
86    { SET6(IsWrite, NeedsExclusive, IsInvalidate,
87           IsRequest, HasData, NeedsResponse),
88            WriteInvalidateResp, "WriteInvalidateReq" },
89    /* WriteInvalidateResp */
90    { SET3(IsWrite, NeedsExclusive, IsResponse),
91            InvalidCmd, "WriteInvalidateResp" },
92    /* UpgradeReq */
93    { SET4(IsInvalidate, NeedsExclusive, IsRequest, NeedsResponse),
94            UpgradeResp, "UpgradeReq" },
95    /* UpgradeResp */
96    { SET2(NeedsExclusive, IsResponse),
97            InvalidCmd, "UpgradeResp" },
98    /* ReadExReq */
99    { SET5(IsRead, NeedsExclusive, IsInvalidate, IsRequest, NeedsResponse),
100            ReadExResp, "ReadExReq" },
101    /* ReadExResp */
102    { SET4(IsRead, NeedsExclusive, IsResponse, HasData),
103            InvalidCmd, "ReadExResp" },
104    /* LoadLockedReq: note that we use plain ReadResp as response, so that
105     *                we can also use ReadRespWithInvalidate when needed */
106    { SET4(IsRead, IsLocked, IsRequest, NeedsResponse),
107            ReadResp, "LoadLockedReq" },
108    /* StoreCondReq */
109    { SET6(IsWrite, NeedsExclusive, IsLocked,
110           IsRequest, NeedsResponse, HasData),
111            StoreCondResp, "StoreCondReq" },
112    /* StoreCondResp */
113    { SET4(IsWrite, NeedsExclusive, IsLocked, IsResponse),
114            InvalidCmd, "StoreCondResp" },
115    /* SwapReq -- for Swap ldstub type operations */
116    { SET6(IsRead, IsWrite, NeedsExclusive, IsRequest, HasData, NeedsResponse),
117        SwapResp, "SwapReq" },
118    /* SwapResp -- for Swap ldstub type operations */
119    { SET5(IsRead, IsWrite, NeedsExclusive, IsResponse, HasData),
120            InvalidCmd, "SwapResp" },
121    /* NetworkNackError  -- nacked at network layer (not by protocol) */
122    { SET2(IsResponse, IsError), InvalidCmd, "NetworkNackError" },
123    /* InvalidDestError  -- packet dest field invalid */
124    { SET2(IsResponse, IsError), InvalidCmd, "InvalidDestError" },
125    /* BadAddressError   -- memory address invalid */
126    { SET2(IsResponse, IsError), InvalidCmd, "BadAddressError" },
127    /* PrintReq */
128    { SET2(IsRequest, IsPrint), InvalidCmd, "PrintReq" }
129};
130
131
132/** delete the data pointed to in the data pointer. Ok to call to matter how
133 * data was allocted. */
134void
135Packet::deleteData()
136{
137    assert(staticData || dynamicData);
138    if (staticData)
139        return;
140
141    if (arrayData)
142        delete [] data;
143    else
144        delete data;
145}
146
147/** If there isn't data in the packet, allocate some. */
148void
149Packet::allocate()
150{
151    if (data)
152        return;
153    assert(!staticData);
154    dynamicData = true;
155    arrayData = true;
156    data = new uint8_t[getSize()];
157}
158
159
160bool
161Packet::checkFunctional(Printable *obj, Addr addr, int size, uint8_t *data)
162{
163    Addr func_start = getAddr();
164    Addr func_end   = getAddr() + getSize() - 1;
165    Addr val_start  = addr;
166    Addr val_end    = val_start + size - 1;
167
168    if (func_start > val_end || val_start > func_end) {
169        // no intersection
170        return false;
171    }
172
173    // check print first since it doesn't require data
174    if (isPrint()) {
175        dynamic_cast<PrintReqState*>(senderState)->printObj(obj);
176        return false;
177    }
178
179    // if there's no data, there's no need to look further
180    if (!data) {
181        return false;
182    }
183
184    // offset of functional request into supplied value (could be
185    // negative if partial overlap)
186    int offset = func_start - val_start;
187
188    if (isRead()) {
189        if (func_start >= val_start && func_end <= val_end) {
190            allocate();
191            std::memcpy(getPtr<uint8_t>(), data + offset, getSize());
192            makeResponse();
193            return true;
194        } else {
195            // In this case the timing packet only partially satisfies
196            // the request, so we would need more information to make
197            // this work.  Like bytes valid in the packet or
198            // something, so the request could continue and get this
199            // bit of possibly newer data along with the older data
200            // not written to yet.
201            panic("Memory value only partially satisfies the functional "
202                  "request. Now what?");
203        }
204    } else if (isWrite()) {
205        if (offset >= 0) {
206            std::memcpy(data + offset, getPtr<uint8_t>(),
207                        (std::min(func_end, val_end) - func_start) + 1);
208        } else { // val_start > func_start
209            std::memcpy(data, getPtr<uint8_t>() - offset,
210                        (std::min(func_end, val_end) - val_start) + 1);
211        }
212    } else {
213        panic("Don't know how to handle command %s\n", cmdString());
214    }
215
216    // keep going with request by default
217    return false;
218}
219
220
221void
222Packet::print(std::ostream &o, const int verbosity,
223              const std::string &prefix) const
224{
225    ccprintf(o, "%s[%x:%x] %s\n", prefix,
226             getAddr(), getAddr() + getSize() - 1, cmdString());
227}
228
229
230Packet::PrintReqState::PrintReqState(std::ostream &_os, int _verbosity)
231    : curPrefixPtr(new std::string("")), os(_os), verbosity(_verbosity)
232{
233    labelStack.push_back(LabelStackEntry("", curPrefixPtr));
234}
235
236
237Packet::PrintReqState::~PrintReqState()
238{
239    labelStack.pop_back();
240    assert(labelStack.empty());
241    delete curPrefixPtr;
242}
243
244
245Packet::PrintReqState::
246LabelStackEntry::LabelStackEntry(const std::string &_label,
247                                 std::string *_prefix)
248    : label(_label), prefix(_prefix), labelPrinted(false)
249{
250}
251
252
253void
254Packet::PrintReqState::pushLabel(const std::string &lbl,
255                                 const std::string &prefix)
256{
257    labelStack.push_back(LabelStackEntry(lbl, curPrefixPtr));
258    curPrefixPtr = new std::string(*curPrefixPtr);
259    *curPrefixPtr += prefix;
260}
261
262void
263Packet::PrintReqState::popLabel()
264{
265    delete curPrefixPtr;
266    curPrefixPtr = labelStack.back().prefix;
267    labelStack.pop_back();
268    assert(!labelStack.empty());
269}
270
271void
272Packet::PrintReqState::printLabels()
273{
274    if (!labelStack.back().labelPrinted) {
275        LabelStack::iterator i = labelStack.begin();
276        LabelStack::iterator end = labelStack.end();
277        while (i != end) {
278            if (!i->labelPrinted) {
279                ccprintf(os, "%s%s\n", *(i->prefix), i->label);
280                i->labelPrinted = true;
281            }
282            i++;
283        }
284    }
285}
286
287
288void
289Packet::PrintReqState::printObj(Printable *obj)
290{
291    printLabels();
292    obj->print(os, verbosity, curPrefix());
293}
294