2 * Copyright (c) 2011 ARM Limited
5 * The license below extends only to copyright in the software and shall
6 * not be construed as granting a license to any other intellectual
7 * property including but not limited to intellectual property relating
8 * to a hardware implementation of the functionality of the software
9 * licensed hereunder. You may use the software subject to the license
10 * terms below provided that you ensure that this notice is replicated
11 * unmodified and in its entirety in all distributions of the software,
12 * modified or unmodified, in source code or in binary form.
14 * Copyright (c) 2006 The Regents of The University of Michigan
15 * Copyright (c) 2010 Advanced Micro Devices, Inc.
16 * All rights reserved.
18 * Redistribution and use in source and binary forms, with or without
19 * modification, are permitted provided that the following conditions are
20 * met: redistributions of source code must retain the above copyright
21 * notice, this list of conditions and the following disclaimer;
22 * redistributions in binary form must reproduce the above copyright
23 * notice, this list of conditions and the following disclaimer in the
24 * documentation and/or other materials provided with the distribution;
25 * neither the name of the copyright holders nor the names of its
26 * contributors may be used to endorse or promote products derived from
27 * this software without specific prior written permission.
29 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
30 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
31 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
32 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
33 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
34 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
35 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
36 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
37 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
38 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
39 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
47 * Definition of the Packet Class, a packet is a transaction occuring
48 * between a single level of the memory heirarchy (ie L1->L2).
54 #include "base/cprintf.hh"
55 #include "base/misc.hh"
56 #include "base/trace.hh"
57 #include "mem/packet.hh"
61 // The one downside to bitsets is that static initializers can get ugly.
62 #define SET1(a1) (1 << (a1))
63 #define SET2(a1, a2) (SET1(a1) | SET1(a2))
64 #define SET3(a1, a2, a3) (SET2(a1, a2) | SET1(a3))
65 #define SET4(a1, a2, a3, a4) (SET3(a1, a2, a3) | SET1(a4))
66 #define SET5(a1, a2, a3, a4, a5) (SET4(a1, a2, a3, a4) | SET1(a5))
67 #define SET6(a1, a2, a3, a4, a5, a6) (SET5(a1, a2, a3, a4, a5) | SET1(a6))
69 const MemCmd::CommandInfo
70 MemCmd::commandInfo
[] =
73 { 0, InvalidCmd
, "InvalidCmd" },
75 { SET3(IsRead
, IsRequest
, NeedsResponse
), ReadResp
, "ReadReq" },
77 { SET3(IsRead
, IsResponse
, HasData
), InvalidCmd
, "ReadResp" },
78 /* ReadRespWithInvalidate */
79 { SET4(IsRead
, IsResponse
, HasData
, IsInvalidate
),
80 InvalidCmd
, "ReadRespWithInvalidate" },
82 { SET5(IsWrite
, NeedsExclusive
, IsRequest
, NeedsResponse
, HasData
),
83 WriteResp
, "WriteReq" },
85 { SET3(IsWrite
, NeedsExclusive
, IsResponse
), InvalidCmd
, "WriteResp" },
87 { SET4(IsWrite
, NeedsExclusive
, IsRequest
, HasData
),
88 InvalidCmd
, "Writeback" },
90 { SET4(IsRead
, IsRequest
, IsSWPrefetch
, NeedsResponse
),
91 SoftPFResp
, "SoftPFReq" },
93 { SET4(IsRead
, IsRequest
, IsHWPrefetch
, NeedsResponse
),
94 HardPFResp
, "HardPFReq" },
96 { SET4(IsRead
, IsResponse
, IsSWPrefetch
, HasData
),
97 InvalidCmd
, "SoftPFResp" },
99 { SET4(IsRead
, IsResponse
, IsHWPrefetch
, HasData
),
100 InvalidCmd
, "HardPFResp" },
101 /* WriteInvalidateReq (currently unused, see packet.hh) */
102 { SET6(IsWrite
, NeedsExclusive
, IsInvalidate
,
103 IsRequest
, HasData
, NeedsResponse
),
104 WriteInvalidateResp
, "WriteInvalidateReq" },
105 /* WriteInvalidateResp (currently unused, see packet.hh) */
106 { SET3(IsWrite
, NeedsExclusive
, IsResponse
),
107 InvalidCmd
, "WriteInvalidateResp" },
109 { SET5(IsInvalidate
, NeedsExclusive
, IsUpgrade
, IsRequest
, NeedsResponse
),
110 UpgradeResp
, "UpgradeReq" },
111 /* SCUpgradeReq: response could be UpgradeResp or UpgradeFailResp */
112 { SET6(IsInvalidate
, NeedsExclusive
, IsUpgrade
, IsLlsc
,
113 IsRequest
, NeedsResponse
),
114 UpgradeResp
, "SCUpgradeReq" },
116 { SET3(NeedsExclusive
, IsUpgrade
, IsResponse
),
117 InvalidCmd
, "UpgradeResp" },
118 /* SCUpgradeFailReq: generates UpgradeFailResp ASAP */
119 { SET5(IsInvalidate
, NeedsExclusive
, IsLlsc
,
120 IsRequest
, NeedsResponse
),
121 UpgradeFailResp
, "SCUpgradeFailReq" },
122 /* UpgradeFailResp */
123 { SET2(NeedsExclusive
, IsResponse
),
124 InvalidCmd
, "UpgradeFailResp" },
126 { SET5(IsRead
, NeedsExclusive
, IsInvalidate
, IsRequest
, NeedsResponse
),
127 ReadExResp
, "ReadExReq" },
129 { SET4(IsRead
, NeedsExclusive
, IsResponse
, HasData
),
130 InvalidCmd
, "ReadExResp" },
131 /* LoadLockedReq: note that we use plain ReadResp as response, so that
132 * we can also use ReadRespWithInvalidate when needed */
133 { SET4(IsRead
, IsLlsc
, IsRequest
, NeedsResponse
),
134 ReadResp
, "LoadLockedReq" },
136 { SET6(IsWrite
, NeedsExclusive
, IsLlsc
,
137 IsRequest
, NeedsResponse
, HasData
),
138 StoreCondResp
, "StoreCondReq" },
139 /* StoreCondFailReq: generates failing StoreCondResp ASAP */
140 { SET6(IsWrite
, NeedsExclusive
, IsLlsc
,
141 IsRequest
, NeedsResponse
, HasData
),
142 StoreCondResp
, "StoreCondFailReq" },
144 { SET4(IsWrite
, NeedsExclusive
, IsLlsc
, IsResponse
),
145 InvalidCmd
, "StoreCondResp" },
146 /* SwapReq -- for Swap ldstub type operations */
147 { SET6(IsRead
, IsWrite
, NeedsExclusive
, IsRequest
, HasData
, NeedsResponse
),
148 SwapResp
, "SwapReq" },
149 /* SwapResp -- for Swap ldstub type operations */
150 { SET5(IsRead
, IsWrite
, NeedsExclusive
, IsResponse
, HasData
),
151 InvalidCmd
, "SwapResp" },
152 /* IntReq -- for interrupts */
153 { SET4(IsWrite
, IsRequest
, NeedsResponse
, HasData
),
154 MessageResp
, "MessageReq" },
155 /* IntResp -- for interrupts */
156 { SET2(IsWrite
, IsResponse
), InvalidCmd
, "MessageResp" },
157 /* InvalidDestError -- packet dest field invalid */
158 { SET2(IsResponse
, IsError
), InvalidCmd
, "InvalidDestError" },
159 /* BadAddressError -- memory address invalid */
160 { SET2(IsResponse
, IsError
), InvalidCmd
, "BadAddressError" },
161 /* FunctionalReadError */
162 { SET3(IsRead
, IsResponse
, IsError
), InvalidCmd
, "FunctionalReadError" },
163 /* FunctionalWriteError */
164 { SET3(IsWrite
, IsResponse
, IsError
), InvalidCmd
, "FunctionalWriteError" },
166 { SET2(IsRequest
, IsPrint
), InvalidCmd
, "PrintReq" },
168 { SET3(IsRequest
, IsFlush
, NeedsExclusive
), InvalidCmd
, "FlushReq" },
169 /* Invalidation Request */
170 { SET3(NeedsExclusive
, IsInvalidate
, IsRequest
),
171 InvalidCmd
, "InvalidationReq" },
175 Packet::checkFunctional(Printable
*obj
, Addr addr
, int size
, uint8_t *data
)
177 Addr func_start
= getAddr();
178 Addr func_end
= getAddr() + getSize() - 1;
179 Addr val_start
= addr
;
180 Addr val_end
= val_start
+ size
- 1;
182 if (func_start
> val_end
|| val_start
> func_end
) {
187 // check print first since it doesn't require data
189 dynamic_cast<PrintReqState
*>(senderState
)->printObj(obj
);
193 // if there's no data, there's no need to look further
198 // offset of functional request into supplied value (could be
199 // negative if partial overlap)
200 int offset
= func_start
- val_start
;
203 if (func_start
>= val_start
&& func_end
<= val_end
) {
205 memcpy(getPtr
<uint8_t>(), data
+ offset
, getSize());
208 // Offsets and sizes to copy in case of partial overlap
213 // calculate offsets and copy sizes for the two byte arrays
214 if (val_start
< func_start
&& val_end
<= func_end
) {
215 val_offset
= func_start
- val_start
;
217 overlap_size
= val_end
- func_start
;
218 } else if (val_start
>= func_start
&& val_end
> func_end
) {
220 func_offset
= val_start
- func_start
;
221 overlap_size
= func_end
- val_start
;
222 } else if (val_start
>= func_start
&& val_end
<= func_end
) {
224 func_offset
= val_start
- func_start
;
227 panic("BUG: Missed a case for a partial functional request");
230 // Figure out how much of the partial overlap should be copied
231 // into the packet and not overwrite previously found bytes.
232 if (bytesValidStart
== 0 && bytesValidEnd
== 0) {
233 // No bytes have been copied yet, just set indices
235 bytesValidStart
= func_offset
;
236 bytesValidEnd
= func_offset
+ overlap_size
;
238 // Some bytes have already been copied. Use bytesValid
239 // indices and offset values to figure out how much data
240 // to copy and where to copy it to.
242 // Indice overlap conditions to check
243 int a
= func_offset
- bytesValidStart
;
244 int b
= (func_offset
+ overlap_size
) - bytesValidEnd
;
245 int c
= func_offset
- bytesValidEnd
;
246 int d
= (func_offset
+ overlap_size
) - bytesValidStart
;
248 if (a
>= 0 && b
<= 0) {
249 // bytes already in pkt data array are superset of
250 // found bytes, will not copy any bytes
252 } else if (a
< 0 && d
>= 0 && b
<= 0) {
253 // found bytes will move bytesValidStart towards 0
254 overlap_size
= bytesValidStart
- func_offset
;
255 bytesValidStart
= func_offset
;
256 } else if (b
> 0 && c
<= 0 && a
>= 0) {
257 // found bytes will move bytesValidEnd
258 // towards end of pkt data array
260 (func_offset
+ overlap_size
) - bytesValidEnd
;
261 val_offset
+= bytesValidEnd
- func_offset
;
262 func_offset
= bytesValidEnd
;
263 bytesValidEnd
+= overlap_size
;
264 } else if (a
< 0 && b
> 0) {
265 // Found bytes are superset of copied range. Will move
266 // bytesValidStart towards 0 and bytesValidEnd towards
267 // end of pkt data array. Need to break copy into two
268 // pieces so as to not overwrite previously found data.
270 // copy the first half
271 uint8_t *dest
= getPtr
<uint8_t>() + func_offset
;
272 uint8_t *src
= data
+ val_offset
;
273 memcpy(dest
, src
, (bytesValidStart
- func_offset
));
275 // re-calc the offsets and indices to do the copy
276 // required for the second half
277 val_offset
+= (bytesValidEnd
- func_offset
);
278 bytesValidStart
= func_offset
;
280 (func_offset
+ overlap_size
) - bytesValidEnd
;
281 func_offset
= bytesValidEnd
;
282 bytesValidEnd
+= overlap_size
;
283 } else if ((c
> 0 && b
> 0)
284 || (a
< 0 && d
< 0)) {
285 // region to be copied is discontiguous! Not supported.
286 panic("BUG: Discontiguous bytes found"
287 "for functional copying!");
290 assert(bytesValidEnd
<= getSize());
292 // copy partial data into the packet's data array
293 uint8_t *dest
= getPtr
<uint8_t>() + func_offset
;
294 uint8_t *src
= data
+ val_offset
;
295 memcpy(dest
, src
, overlap_size
);
297 // check if we're done filling the functional access
298 bool done
= (bytesValidStart
== 0) && (bytesValidEnd
== getSize());
301 } else if (isWrite()) {
303 memcpy(data
+ offset
, getPtr
<uint8_t>(),
304 (min(func_end
, val_end
) - func_start
) + 1);
306 // val_start > func_start
307 memcpy(data
, getPtr
<uint8_t>() - offset
,
308 (min(func_end
, val_end
) - val_start
) + 1);
311 panic("Don't know how to handle command %s\n", cmdString());
314 // keep going with request by default
319 Packet::pushSenderState(Packet::SenderState
*sender_state
)
321 assert(sender_state
!= NULL
);
322 sender_state
->predecessor
= senderState
;
323 senderState
= sender_state
;
326 Packet::SenderState
*
327 Packet::popSenderState()
329 assert(senderState
!= NULL
);
330 SenderState
*sender_state
= senderState
;
331 senderState
= sender_state
->predecessor
;
332 sender_state
->predecessor
= NULL
;
337 Packet::print(ostream
&o
, const int verbosity
, const string
&prefix
) const
339 ccprintf(o
, "%s[%x:%x] %s\n", prefix
,
340 getAddr(), getAddr() + getSize() - 1, cmdString());
343 Packet::PrintReqState::PrintReqState(ostream
&_os
, int _verbosity
)
344 : curPrefixPtr(new string("")), os(_os
), verbosity(_verbosity
)
346 labelStack
.push_back(LabelStackEntry("", curPrefixPtr
));
349 Packet::PrintReqState::~PrintReqState()
351 labelStack
.pop_back();
352 assert(labelStack
.empty());
356 Packet::PrintReqState::
357 LabelStackEntry::LabelStackEntry(const string
&_label
, string
*_prefix
)
358 : label(_label
), prefix(_prefix
), labelPrinted(false)
363 Packet::PrintReqState::pushLabel(const string
&lbl
, const string
&prefix
)
365 labelStack
.push_back(LabelStackEntry(lbl
, curPrefixPtr
));
366 curPrefixPtr
= new string(*curPrefixPtr
);
367 *curPrefixPtr
+= prefix
;
371 Packet::PrintReqState::popLabel()
374 curPrefixPtr
= labelStack
.back().prefix
;
375 labelStack
.pop_back();
376 assert(!labelStack
.empty());
380 Packet::PrintReqState::printLabels()
382 if (!labelStack
.back().labelPrinted
) {
383 LabelStack::iterator i
= labelStack
.begin();
384 LabelStack::iterator end
= labelStack
.end();
386 if (!i
->labelPrinted
) {
387 ccprintf(os
, "%s%s\n", *(i
->prefix
), i
->label
);
388 i
->labelPrinted
= true;
397 Packet::PrintReqState::printObj(Printable
*obj
)
400 obj
->print(os
, verbosity
, curPrefix());