packet.cc revision 7465:f97b62be544f 
1/*
2 * Copyright (c) 2006 The Regents of The University of Michigan
3 * Copyright (c) 2010 Advancec Micro Devices, Inc.
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are
8 * met: redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer;
10 * redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution;
13 * neither the name of the copyright holders nor the names of its
14 * contributors may be used to endorse or promote products derived from
15 * this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 *
29 * Authors: Ali Saidi
30 *          Steve Reinhardt
31 */
32
33/**
34 * @file
35 * Definition of the Packet Class, a packet is a transaction occuring
36 * between a single level of the memory heirarchy (ie L1->L2).
37 */
38
39#include <iostream>
40#include <cstring>
41#include "base/cprintf.hh"
42#include "base/misc.hh"
43#include "base/trace.hh"
44#include "mem/packet.hh"
45
46using namespace std;
47
48// The one downside to bitsets is that static initializers can get ugly.
49#define SET1(a1)                     (1 << (a1))
50#define SET2(a1, a2)                 (SET1(a1) | SET1(a2))
51#define SET3(a1, a2, a3)             (SET2(a1, a2) | SET1(a3))
52#define SET4(a1, a2, a3, a4)         (SET3(a1, a2, a3) | SET1(a4))
53#define SET5(a1, a2, a3, a4, a5)     (SET4(a1, a2, a3, a4) | SET1(a5))
54#define SET6(a1, a2, a3, a4, a5, a6) (SET5(a1, a2, a3, a4, a5) | SET1(a6))
55
56const MemCmd::CommandInfo
57MemCmd::commandInfo[] =
58{
59    /* InvalidCmd */
60    { 0, InvalidCmd, "InvalidCmd" },
61    /* ReadReq */
62    { SET3(IsRead, IsRequest, NeedsResponse), ReadResp, "ReadReq" },
63    /* ReadResp */
64    { SET3(IsRead, IsResponse, HasData), InvalidCmd, "ReadResp" },
65    /* ReadRespWithInvalidate */
66    { SET4(IsRead, IsResponse, HasData, IsInvalidate),
67            InvalidCmd, "ReadRespWithInvalidate" },
68    /* WriteReq */
69    { SET5(IsWrite, NeedsExclusive, IsRequest, NeedsResponse, HasData),
70            WriteResp, "WriteReq" },
71    /* WriteResp */
72    { SET3(IsWrite, NeedsExclusive, IsResponse), InvalidCmd, "WriteResp" },
73    /* Writeback */
74    { SET4(IsWrite, NeedsExclusive, IsRequest, HasData),
75            InvalidCmd, "Writeback" },
76    /* SoftPFReq */
77    { SET4(IsRead, IsRequest, IsSWPrefetch, NeedsResponse),
78            SoftPFResp, "SoftPFReq" },
79    /* HardPFReq */
80    { SET4(IsRead, IsRequest, IsHWPrefetch, NeedsResponse),
81            HardPFResp, "HardPFReq" },
82    /* SoftPFResp */
83    { SET4(IsRead, IsResponse, IsSWPrefetch, HasData),
84            InvalidCmd, "SoftPFResp" },
85    /* HardPFResp */
86    { SET4(IsRead, IsResponse, IsHWPrefetch, HasData),
87            InvalidCmd, "HardPFResp" },
88    /* WriteInvalidateReq */
89    { SET6(IsWrite, NeedsExclusive, IsInvalidate,
90           IsRequest, HasData, NeedsResponse),
91            WriteInvalidateResp, "WriteInvalidateReq" },
92    /* WriteInvalidateResp */
93    { SET3(IsWrite, NeedsExclusive, IsResponse),
94            InvalidCmd, "WriteInvalidateResp" },
95    /* UpgradeReq */
96    { SET5(IsInvalidate, NeedsExclusive, IsUpgrade, IsRequest, NeedsResponse),
97            UpgradeResp, "UpgradeReq" },
98    /* SCUpgradeReq: response could be UpgradeResp or UpgradeFailResp */
99    { SET6(IsInvalidate, NeedsExclusive, IsUpgrade, IsLlsc,
100           IsRequest, NeedsResponse),
101            UpgradeResp, "SCUpgradeReq" },
102    /* UpgradeResp */
103    { SET3(NeedsExclusive, IsUpgrade, IsResponse),
104            InvalidCmd, "UpgradeResp" },
105    /* SCUpgradeFailReq: generates UpgradeFailResp ASAP */
106    { SET5(IsInvalidate, NeedsExclusive, IsLlsc,
107           IsRequest, NeedsResponse),
108            UpgradeFailResp, "SCUpgradeFailReq" },
109    /* UpgradeFailResp */
110    { SET2(NeedsExclusive, IsResponse),
111            InvalidCmd, "UpgradeFailResp" },
112    /* ReadExReq */
113    { SET5(IsRead, NeedsExclusive, IsInvalidate, IsRequest, NeedsResponse),
114            ReadExResp, "ReadExReq" },
115    /* ReadExResp */
116    { SET4(IsRead, NeedsExclusive, IsResponse, HasData),
117            InvalidCmd, "ReadExResp" },
118    /* LoadLockedReq: note that we use plain ReadResp as response, so that
119     *                we can also use ReadRespWithInvalidate when needed */
120    { SET4(IsRead, IsLlsc, IsRequest, NeedsResponse),
121            ReadResp, "LoadLockedReq" },
122    /* StoreCondReq */
123    { SET6(IsWrite, NeedsExclusive, IsLlsc,
124           IsRequest, NeedsResponse, HasData),
125            StoreCondResp, "StoreCondReq" },
126    /* StoreCondResp */
127    { SET4(IsWrite, NeedsExclusive, IsLlsc, IsResponse),
128            InvalidCmd, "StoreCondResp" },
129    /* SwapReq -- for Swap ldstub type operations */
130    { SET6(IsRead, IsWrite, NeedsExclusive, IsRequest, HasData, NeedsResponse),
131        SwapResp, "SwapReq" },
132    /* SwapResp -- for Swap ldstub type operations */
133    { SET5(IsRead, IsWrite, NeedsExclusive, IsResponse, HasData),
134            InvalidCmd, "SwapResp" },
135    /* IntReq -- for interrupts */
136    { SET4(IsWrite, IsRequest, NeedsResponse, HasData),
137        MessageResp, "MessageReq" },
138    /* IntResp -- for interrupts */
139    { SET2(IsWrite, IsResponse), InvalidCmd, "MessageResp" },
140    /* NetworkNackError  -- nacked at network layer (not by protocol) */
141    { SET2(IsResponse, IsError), InvalidCmd, "NetworkNackError" },
142    /* InvalidDestError  -- packet dest field invalid */
143    { SET2(IsResponse, IsError), InvalidCmd, "InvalidDestError" },
144    /* BadAddressError   -- memory address invalid */
145    { SET2(IsResponse, IsError), InvalidCmd, "BadAddressError" },
146    /* PrintReq */
147    { SET2(IsRequest, IsPrint), InvalidCmd, "PrintReq" }
148};
149
150bool
151Packet::checkFunctional(Printable *obj, Addr addr, int size, uint8_t *data)
152{
153    Addr func_start = getAddr();
154    Addr func_end   = getAddr() + getSize() - 1;
155    Addr val_start  = addr;
156    Addr val_end    = val_start + size - 1;
157
158    if (func_start > val_end || val_start > func_end) {
159        // no intersection
160        return false;
161    }
162
163    // check print first since it doesn't require data
164    if (isPrint()) {
165        dynamic_cast<PrintReqState*>(senderState)->printObj(obj);
166        return false;
167    }
168
169    // if there's no data, there's no need to look further
170    if (!data) {
171        return false;
172    }
173
174    // offset of functional request into supplied value (could be
175    // negative if partial overlap)
176    int offset = func_start - val_start;
177
178    if (isRead()) {
179        if (func_start >= val_start && func_end <= val_end) {
180            allocate();
181            memcpy(getPtr<uint8_t>(), data + offset, getSize());
182            makeResponse();
183            return true;
184        } else {
185            // In this case the timing packet only partially satisfies
186            // the request, so we would need more information to make
187            // this work.  Like bytes valid in the packet or
188            // something, so the request could continue and get this
189            // bit of possibly newer data along with the older data
190            // not written to yet.
191            panic("Memory value only partially satisfies the functional "
192                  "request. Now what?");
193        }
194    } else if (isWrite()) {
195        if (offset >= 0) {
196            memcpy(data + offset, getPtr<uint8_t>(),
197                   (min(func_end, val_end) - func_start) + 1);
198        } else {
199            // val_start > func_start
200            memcpy(data, getPtr<uint8_t>() - offset,
201                   (min(func_end, val_end) - val_start) + 1);
202        }
203    } else {
204        panic("Don't know how to handle command %s\n", cmdString());
205    }
206
207    // keep going with request by default
208    return false;
209}
210
211void
212Packet::print(ostream &o, const int verbosity, const string &prefix) const
213{
214    ccprintf(o, "%s[%x:%x] %s\n", prefix,
215             getAddr(), getAddr() + getSize() - 1, cmdString());
216}
217
218Packet::PrintReqState::PrintReqState(ostream &_os, int _verbosity)
219    : curPrefixPtr(new string("")), os(_os), verbosity(_verbosity)
220{
221    labelStack.push_back(LabelStackEntry("", curPrefixPtr));
222}
223
224Packet::PrintReqState::~PrintReqState()
225{
226    labelStack.pop_back();
227    assert(labelStack.empty());
228    delete curPrefixPtr;
229}
230
231Packet::PrintReqState::
232LabelStackEntry::LabelStackEntry(const string &_label, string *_prefix)
233    : label(_label), prefix(_prefix), labelPrinted(false)
234{
235}
236
237void
238Packet::PrintReqState::pushLabel(const string &lbl, const string &prefix)
239{
240    labelStack.push_back(LabelStackEntry(lbl, curPrefixPtr));
241    curPrefixPtr = new string(*curPrefixPtr);
242    *curPrefixPtr += prefix;
243}
244
245void
246Packet::PrintReqState::popLabel()
247{
248    delete curPrefixPtr;
249    curPrefixPtr = labelStack.back().prefix;
250    labelStack.pop_back();
251    assert(!labelStack.empty());
252}
253
254void
255Packet::PrintReqState::printLabels()
256{
257    if (!labelStack.back().labelPrinted) {
258        LabelStack::iterator i = labelStack.begin();
259        LabelStack::iterator end = labelStack.end();
260        while (i != end) {
261            if (!i->labelPrinted) {
262                ccprintf(os, "%s%s\n", *(i->prefix), i->label);
263                i->labelPrinted = true;
264            }
265            i++;
266        }
267    }
268}
269
270
271void
272Packet::PrintReqState::printObj(Printable *obj)
273{
274    printLabels();
275    obj->print(os, verbosity, curPrefix());
276}
277