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/misc.hh"
41#include "base/trace.hh"
42#include "mem/packet.hh"
43
44// The one downside to bitsets is that static initializers can get ugly.
45#define SET1(a1) (1 << (a1))
46#define SET2(a1, a2) (SET1(a1) | SET1(a2))
47#define SET3(a1, a2, a3) (SET2(a1, a2) | SET1(a3))
48#define SET4(a1, a2, a3, a4) (SET3(a1, a2, a3) | SET1(a4))
49#define SET5(a1, a2, a3, a4, a5) (SET4(a1, a2, a3, a4) | SET1(a5))
50#define SET6(a1, a2, a3, a4, a5, a6) (SET5(a1, a2, a3, a4, a5) | SET1(a6))
51
52const MemCmd::CommandInfo
53MemCmd::commandInfo[] =
54{
55 /* InvalidCmd */
56 { 0, InvalidCmd, "InvalidCmd" },
57 /* ReadReq */
58 { SET3(IsRead, IsRequest, NeedsResponse), ReadResp, "ReadReq" },
59 /* ReadResp */
60 { SET3(IsRead, IsResponse, HasData), InvalidCmd, "ReadResp" },
61 /* WriteReq */
62 { SET4(IsWrite, IsRequest, NeedsResponse, HasData),
63 WriteResp, "WriteReq" },
64 /* WriteResp */
65 { SET2(IsWrite, IsResponse), InvalidCmd, "WriteResp" },
66 /* Writeback */
67 { SET4(IsWrite, IsRequest, HasData, NeedsResponse),
68 WritebackAck, "Writeback" },
69 /* WritebackAck */
70 { SET2(IsWrite, IsResponse), InvalidCmd, "WritebackAck" },
71 /* SoftPFReq */
72 { SET4(IsRead, IsRequest, IsSWPrefetch, NeedsResponse),
73 SoftPFResp, "SoftPFReq" },
74 /* HardPFReq */
75 { SET4(IsRead, IsRequest, IsHWPrefetch, NeedsResponse),
76 HardPFResp, "HardPFReq" },
77 /* SoftPFResp */
78 { SET4(IsRead, IsResponse, IsSWPrefetch, HasData),
79 InvalidCmd, "SoftPFResp" },
80 /* HardPFResp */
81 { SET4(IsRead, IsResponse, IsHWPrefetch, HasData),
82 InvalidCmd, "HardPFResp" },
83 /* InvalidateReq */
84 { SET2(IsInvalidate, IsRequest), InvalidCmd, "InvalidateReq" },
85 /* WriteInvalidateReq */
86 { SET5(IsWrite, IsInvalidate, IsRequest, HasData, NeedsResponse),
87 WriteInvalidateResp, "WriteInvalidateReq" },
88 /* WriteInvalidateResp */
89 { SET3(IsWrite, IsInvalidate, IsResponse),
90 InvalidCmd, "WriteInvalidateResp" },
91 /* UpgradeReq */
92 { SET3(IsInvalidate, IsRequest, IsUpgrade), InvalidCmd, "UpgradeReq" },
93 /* ReadExReq */
94 { SET4(IsRead, IsInvalidate, IsRequest, NeedsResponse),
95 ReadExResp, "ReadExReq" },
96 /* ReadExResp */
97 { SET4(IsRead, IsInvalidate, IsResponse, HasData),
98 InvalidCmd, "ReadExResp" },
99 /* SwapReq -- for Swap ldstub type operations */
100 { SET4(IsReadWrite, IsRequest, HasData, NeedsResponse),
101 SwapResp, "SwapReq" },
102 /* SwapResp -- for Swap ldstub type operations */
103 { SET3(IsReadWrite, IsResponse, HasData),
104 InvalidCmd, "SwapResp" }
105};
106
107
108/** delete the data pointed to in the data pointer. Ok to call to matter how
109 * data was allocted. */
110void
111Packet::deleteData()
112{
113 assert(staticData || dynamicData);
114 if (staticData)
115 return;
116
117 if (arrayData)
118 delete [] data;
119 else
120 delete data;
121}
122
123/** If there isn't data in the packet, allocate some. */
124void
125Packet::allocate()
126{
127 if (data)
128 return;
129 assert(!staticData);
130 dynamicData = true;
131 arrayData = true;
132 data = new uint8_t[getSize()];
133}
134
135/** Do the packet modify the same addresses. */
136bool
137Packet::intersect(PacketPtr p)
138{
139 Addr s1 = getAddr();
140 Addr e1 = getAddr() + getSize() - 1;
141 Addr s2 = p->getAddr();
142 Addr e2 = p->getAddr() + p->getSize() - 1;
143
144 return !(s1 > e2 || e1 < s2);
145}
146
147bool
148fixDelayedResponsePacket(PacketPtr func, PacketPtr timing)
149{
150 bool result;
151
152 if (timing->isRead() || timing->isWrite()) {
153 // Ugly hack to deal with the fact that we queue the requests
154 // and don't convert them to responses until we issue them on
155 // the bus. I tried to avoid this by converting packets to
156 // responses right away, but this breaks during snoops where a
157 // responder may do the conversion before other caches have
158 // done the snoop. Would work if we copied the packet instead
159 // of just hanging on to a pointer.
160 MemCmd oldCmd = timing->cmd;
161 timing->cmd = timing->cmd.responseCommand();
162 result = fixPacket(func, timing);
163 timing->cmd = oldCmd;
164 }
165 else {
166 //Don't toggle if it isn't a read/write response
167 result = fixPacket(func, timing);
168 }
169
170 return result;
171}
172
173bool
174fixPacket(PacketPtr func, PacketPtr timing)
175{
176 Addr funcStart = func->getAddr();
177 Addr funcEnd = func->getAddr() + func->getSize() - 1;
178 Addr timingStart = timing->getAddr();
179 Addr timingEnd = timing->getAddr() + timing->getSize() - 1;
180
181 assert(!(funcStart > timingEnd || timingStart > funcEnd));
182
183 // this packet can't solve our problem, continue on
184 if (!timing->hasData())
185 return true;
186
187 if (func->isRead()) {
188 if (funcStart >= timingStart && funcEnd <= timingEnd) {
189 func->allocate();
190 std::memcpy(func->getPtr<uint8_t>(), timing->getPtr<uint8_t>() +
191 funcStart - timingStart, func->getSize());
192 func->result = Packet::Success;
193 func->flags |= SATISFIED;
194 return false;
195 } else {
196 // In this case the timing packet only partially satisfies the
197 // requset, so we would need more information to make this work.
198 // Like bytes valid in the packet or something, so the request could
199 // continue and get this bit of possibly newer data along with the
200 // older data not written to yet.
201 panic("Timing packet only partially satisfies the functional"
202 "request. Now what?");
203 }
204 } else if (func->isWrite()) {
205 if (funcStart >= timingStart) {
206 std::memcpy(timing->getPtr<uint8_t>() + (funcStart - timingStart),
207 func->getPtr<uint8_t>(),
208 (std::min(funcEnd, timingEnd) - funcStart) + 1);
209 } else { // timingStart > funcStart
210 std::memcpy(timing->getPtr<uint8_t>(),
211 func->getPtr<uint8_t>() + (timingStart - funcStart),
212 (std::min(funcEnd, timingEnd) - timingStart) + 1);
213 }
214 // we always want to keep going with a write
215 return true;
216 } else
217 panic("Don't know how to handle command type %#x\n",
218 func->cmdToIndex());
219
220}
221
222
223std::ostream &
224operator<<(std::ostream &o, const Packet &p)
225{
226
227 o << "[0x";
228 o.setf(std::ios_base::hex, std::ios_base::showbase);
229 o << p.getAddr();
230 o.unsetf(std::ios_base::hex| std::ios_base::showbase);
231 o << ":";
232 o.setf(std::ios_base::hex, std::ios_base::showbase);
233 o << p.getAddr() + p.getSize() - 1 << "] ";
234 o.unsetf(std::ios_base::hex| std::ios_base::showbase);
235
236 if (p.result == Packet::Success)
237 o << "Successful ";
238 if (p.result == Packet::BadAddress)
239 o << "BadAddress ";
240 if (p.result == Packet::Nacked)
241 o << "Nacked ";
242 if (p.result == Packet::Unknown)
243 o << "Inflight ";
244
245 if (p.isRead())
246 o << "Read ";
247 if (p.isWrite())
248 o << "Write ";
249 if (p.isReadWrite())
250 o << "Read/Write ";
251 if (p.isInvalidate())
252 o << "Invalidate ";
253 if (p.isRequest())
254 o << "Request ";
255 if (p.isResponse())
256 o << "Response ";
257 if (p.hasData())
258 o << "w/Data ";
259
260 o << std::endl;
261 return o;
262}
263