1/*
2 * Copyright (c) 2012 ARM Limited
3 * All rights reserved
4 *
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.
13 *
14 * Copyright (c) 2006 The Regents of The University of Michigan
15 * Copyright (c) 2010 Advanced Micro Devices, Inc.
16 * All rights reserved.
17 *
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.
28 *
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.
40 *
41 * Authors: Ron Dreslinski
42 * Steve Reinhardt
43 * Ali Saidi
| 1/*
2 * Copyright (c) 2012 ARM Limited
3 * All rights reserved
4 *
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.
13 *
14 * Copyright (c) 2006 The Regents of The University of Michigan
15 * Copyright (c) 2010 Advanced Micro Devices, Inc.
16 * All rights reserved.
17 *
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.
28 *
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.
40 *
41 * Authors: Ron Dreslinski
42 * Steve Reinhardt
43 * Ali Saidi
|
| 44 * Andreas Hansson
|
44 */
45
46/**
47 * @file
48 * Declaration of the Packet class.
49 */
50
51#ifndef __MEM_PACKET_HH__
52#define __MEM_PACKET_HH__
53
54#include <bitset>
55#include <cassert>
56#include <list>
57
58#include "base/cast.hh"
59#include "base/compiler.hh"
60#include "base/fast_alloc.hh"
61#include "base/flags.hh"
62#include "base/misc.hh"
63#include "base/printable.hh"
64#include "base/types.hh"
65#include "mem/request.hh"
66#include "sim/core.hh"
67
68class Packet;
69typedef Packet *PacketPtr;
70typedef uint8_t* PacketDataPtr;
71typedef std::list<PacketPtr> PacketList;
72
73class MemCmd
74{
75 friend class Packet;
76
77 public:
78 /**
79 * List of all commands associated with a packet.
80 */
81 enum Command
82 {
83 InvalidCmd,
84 ReadReq,
85 ReadResp,
86 ReadRespWithInvalidate,
87 WriteReq,
88 WriteResp,
89 Writeback,
90 SoftPFReq,
91 HardPFReq,
92 SoftPFResp,
93 HardPFResp,
94 // WriteInvalidateReq transactions used to be generated by the
95 // DMA ports when writing full blocks to memory, however, it
96 // is not used anymore since we put the I/O cache in place to
97 // deal with partial block writes. Hence, WriteInvalidateReq
98 // and WriteInvalidateResp are currently unused. The
99 // implication is that the I/O cache does read-exclusive
100 // operations on every full-cache-block DMA, and ultimately
101 // this needs to be fixed.
102 WriteInvalidateReq,
103 WriteInvalidateResp,
104 UpgradeReq,
105 SCUpgradeReq, // Special "weak" upgrade for StoreCond
106 UpgradeResp,
107 SCUpgradeFailReq, // Failed SCUpgradeReq in MSHR (never sent)
108 UpgradeFailResp, // Valid for SCUpgradeReq only
109 ReadExReq,
110 ReadExResp,
111 LoadLockedReq,
112 StoreCondReq,
113 StoreCondFailReq, // Failed StoreCondReq in MSHR (never sent)
114 StoreCondResp,
115 SwapReq,
116 SwapResp,
117 MessageReq,
118 MessageResp,
119 // Error responses
120 // @TODO these should be classified as responses rather than
121 // requests; coding them as requests initially for backwards
122 // compatibility
123 NetworkNackError, // nacked at network layer (not by protocol)
124 InvalidDestError, // packet dest field invalid
125 BadAddressError, // memory address invalid
126 FunctionalReadError, // unable to fulfill functional read
127 FunctionalWriteError, // unable to fulfill functional write
128 // Fake simulator-only commands
129 PrintReq, // Print state matching address
130 FlushReq, //request for a cache flush
131 InvalidationReq, // request for address to be invalidated from lsq
132 NUM_MEM_CMDS
133 };
134
135 private:
136 /**
137 * List of command attributes.
138 */
139 enum Attribute
140 {
141 IsRead, //!< Data flows from responder to requester
142 IsWrite, //!< Data flows from requester to responder
143 IsUpgrade,
144 IsInvalidate,
145 NeedsExclusive, //!< Requires exclusive copy to complete in-cache
146 IsRequest, //!< Issued by requester
147 IsResponse, //!< Issue by responder
148 NeedsResponse, //!< Requester needs response from target
149 IsSWPrefetch,
150 IsHWPrefetch,
151 IsLlsc, //!< Alpha/MIPS LL or SC access
152 HasData, //!< There is an associated payload
153 IsError, //!< Error response
154 IsPrint, //!< Print state matching address (for debugging)
155 IsFlush, //!< Flush the address from caches
156 NUM_COMMAND_ATTRIBUTES
157 };
158
159 /**
160 * Structure that defines attributes and other data associated
161 * with a Command.
162 */
163 struct CommandInfo
164 {
165 /// Set of attribute flags.
166 const std::bitset<NUM_COMMAND_ATTRIBUTES> attributes;
167 /// Corresponding response for requests; InvalidCmd if no
168 /// response is applicable.
169 const Command response;
170 /// String representation (for printing)
171 const std::string str;
172 };
173
174 /// Array to map Command enum to associated info.
175 static const CommandInfo commandInfo[];
176
177 private:
178
179 Command cmd;
180
181 bool
182 testCmdAttrib(MemCmd::Attribute attrib) const
183 {
184 return commandInfo[cmd].attributes[attrib] != 0;
185 }
186
187 public:
188
189 bool isRead() const { return testCmdAttrib(IsRead); }
190 bool isWrite() const { return testCmdAttrib(IsWrite); }
191 bool isUpgrade() const { return testCmdAttrib(IsUpgrade); }
192 bool isRequest() const { return testCmdAttrib(IsRequest); }
193 bool isResponse() const { return testCmdAttrib(IsResponse); }
194 bool needsExclusive() const { return testCmdAttrib(NeedsExclusive); }
195 bool needsResponse() const { return testCmdAttrib(NeedsResponse); }
196 bool isInvalidate() const { return testCmdAttrib(IsInvalidate); }
197 bool hasData() const { return testCmdAttrib(HasData); }
198 bool isReadWrite() const { return isRead() && isWrite(); }
199 bool isLLSC() const { return testCmdAttrib(IsLlsc); }
200 bool isError() const { return testCmdAttrib(IsError); }
201 bool isPrint() const { return testCmdAttrib(IsPrint); }
202 bool isFlush() const { return testCmdAttrib(IsFlush); }
203
204 const Command
205 responseCommand() const
206 {
207 return commandInfo[cmd].response;
208 }
209
210 /// Return the string to a cmd given by idx.
211 const std::string &toString() const { return commandInfo[cmd].str; }
212 int toInt() const { return (int)cmd; }
213
214 MemCmd(Command _cmd) : cmd(_cmd) { }
215 MemCmd(int _cmd) : cmd((Command)_cmd) { }
216 MemCmd() : cmd(InvalidCmd) { }
217
218 bool operator==(MemCmd c2) const { return (cmd == c2.cmd); }
219 bool operator!=(MemCmd c2) const { return (cmd != c2.cmd); }
220};
221
222/**
223 * A Packet is used to encapsulate a transfer between two objects in
224 * the memory system (e.g., the L1 and L2 cache). (In contrast, a
225 * single Request travels all the way from the requester to the
226 * ultimate destination and back, possibly being conveyed by several
227 * different Packets along the way.)
228 */
229class Packet : public FastAlloc, public Printable
230{
231 public:
232 typedef uint32_t FlagsType;
233 typedef ::Flags<FlagsType> Flags;
| 45 */
46
47/**
48 * @file
49 * Declaration of the Packet class.
50 */
51
52#ifndef __MEM_PACKET_HH__
53#define __MEM_PACKET_HH__
54
55#include <bitset>
56#include <cassert>
57#include <list>
58
59#include "base/cast.hh"
60#include "base/compiler.hh"
61#include "base/fast_alloc.hh"
62#include "base/flags.hh"
63#include "base/misc.hh"
64#include "base/printable.hh"
65#include "base/types.hh"
66#include "mem/request.hh"
67#include "sim/core.hh"
68
69class Packet;
70typedef Packet *PacketPtr;
71typedef uint8_t* PacketDataPtr;
72typedef std::list<PacketPtr> PacketList;
73
74class MemCmd
75{
76 friend class Packet;
77
78 public:
79 /**
80 * List of all commands associated with a packet.
81 */
82 enum Command
83 {
84 InvalidCmd,
85 ReadReq,
86 ReadResp,
87 ReadRespWithInvalidate,
88 WriteReq,
89 WriteResp,
90 Writeback,
91 SoftPFReq,
92 HardPFReq,
93 SoftPFResp,
94 HardPFResp,
95 // WriteInvalidateReq transactions used to be generated by the
96 // DMA ports when writing full blocks to memory, however, it
97 // is not used anymore since we put the I/O cache in place to
98 // deal with partial block writes. Hence, WriteInvalidateReq
99 // and WriteInvalidateResp are currently unused. The
100 // implication is that the I/O cache does read-exclusive
101 // operations on every full-cache-block DMA, and ultimately
102 // this needs to be fixed.
103 WriteInvalidateReq,
104 WriteInvalidateResp,
105 UpgradeReq,
106 SCUpgradeReq, // Special "weak" upgrade for StoreCond
107 UpgradeResp,
108 SCUpgradeFailReq, // Failed SCUpgradeReq in MSHR (never sent)
109 UpgradeFailResp, // Valid for SCUpgradeReq only
110 ReadExReq,
111 ReadExResp,
112 LoadLockedReq,
113 StoreCondReq,
114 StoreCondFailReq, // Failed StoreCondReq in MSHR (never sent)
115 StoreCondResp,
116 SwapReq,
117 SwapResp,
118 MessageReq,
119 MessageResp,
120 // Error responses
121 // @TODO these should be classified as responses rather than
122 // requests; coding them as requests initially for backwards
123 // compatibility
124 NetworkNackError, // nacked at network layer (not by protocol)
125 InvalidDestError, // packet dest field invalid
126 BadAddressError, // memory address invalid
127 FunctionalReadError, // unable to fulfill functional read
128 FunctionalWriteError, // unable to fulfill functional write
129 // Fake simulator-only commands
130 PrintReq, // Print state matching address
131 FlushReq, //request for a cache flush
132 InvalidationReq, // request for address to be invalidated from lsq
133 NUM_MEM_CMDS
134 };
135
136 private:
137 /**
138 * List of command attributes.
139 */
140 enum Attribute
141 {
142 IsRead, //!< Data flows from responder to requester
143 IsWrite, //!< Data flows from requester to responder
144 IsUpgrade,
145 IsInvalidate,
146 NeedsExclusive, //!< Requires exclusive copy to complete in-cache
147 IsRequest, //!< Issued by requester
148 IsResponse, //!< Issue by responder
149 NeedsResponse, //!< Requester needs response from target
150 IsSWPrefetch,
151 IsHWPrefetch,
152 IsLlsc, //!< Alpha/MIPS LL or SC access
153 HasData, //!< There is an associated payload
154 IsError, //!< Error response
155 IsPrint, //!< Print state matching address (for debugging)
156 IsFlush, //!< Flush the address from caches
157 NUM_COMMAND_ATTRIBUTES
158 };
159
160 /**
161 * Structure that defines attributes and other data associated
162 * with a Command.
163 */
164 struct CommandInfo
165 {
166 /// Set of attribute flags.
167 const std::bitset<NUM_COMMAND_ATTRIBUTES> attributes;
168 /// Corresponding response for requests; InvalidCmd if no
169 /// response is applicable.
170 const Command response;
171 /// String representation (for printing)
172 const std::string str;
173 };
174
175 /// Array to map Command enum to associated info.
176 static const CommandInfo commandInfo[];
177
178 private:
179
180 Command cmd;
181
182 bool
183 testCmdAttrib(MemCmd::Attribute attrib) const
184 {
185 return commandInfo[cmd].attributes[attrib] != 0;
186 }
187
188 public:
189
190 bool isRead() const { return testCmdAttrib(IsRead); }
191 bool isWrite() const { return testCmdAttrib(IsWrite); }
192 bool isUpgrade() const { return testCmdAttrib(IsUpgrade); }
193 bool isRequest() const { return testCmdAttrib(IsRequest); }
194 bool isResponse() const { return testCmdAttrib(IsResponse); }
195 bool needsExclusive() const { return testCmdAttrib(NeedsExclusive); }
196 bool needsResponse() const { return testCmdAttrib(NeedsResponse); }
197 bool isInvalidate() const { return testCmdAttrib(IsInvalidate); }
198 bool hasData() const { return testCmdAttrib(HasData); }
199 bool isReadWrite() const { return isRead() && isWrite(); }
200 bool isLLSC() const { return testCmdAttrib(IsLlsc); }
201 bool isError() const { return testCmdAttrib(IsError); }
202 bool isPrint() const { return testCmdAttrib(IsPrint); }
203 bool isFlush() const { return testCmdAttrib(IsFlush); }
204
205 const Command
206 responseCommand() const
207 {
208 return commandInfo[cmd].response;
209 }
210
211 /// Return the string to a cmd given by idx.
212 const std::string &toString() const { return commandInfo[cmd].str; }
213 int toInt() const { return (int)cmd; }
214
215 MemCmd(Command _cmd) : cmd(_cmd) { }
216 MemCmd(int _cmd) : cmd((Command)_cmd) { }
217 MemCmd() : cmd(InvalidCmd) { }
218
219 bool operator==(MemCmd c2) const { return (cmd == c2.cmd); }
220 bool operator!=(MemCmd c2) const { return (cmd != c2.cmd); }
221};
222
223/**
224 * A Packet is used to encapsulate a transfer between two objects in
225 * the memory system (e.g., the L1 and L2 cache). (In contrast, a
226 * single Request travels all the way from the requester to the
227 * ultimate destination and back, possibly being conveyed by several
228 * different Packets along the way.)
229 */
230class Packet : public FastAlloc, public Printable
231{
232 public:
233 typedef uint32_t FlagsType;
234 typedef ::Flags<FlagsType> Flags;
|
234 typedef short NodeID;
| |
235
236 private:
237 static const FlagsType PUBLIC_FLAGS = 0x00000000;
238 static const FlagsType PRIVATE_FLAGS = 0x00007F0F;
239 static const FlagsType COPY_FLAGS = 0x0000000F;
240
241 static const FlagsType SHARED = 0x00000001;
242 // Special control flags
243 /// Special timing-mode atomic snoop for multi-level coherence.
244 static const FlagsType EXPRESS_SNOOP = 0x00000002;
245 /// Does supplier have exclusive copy?
246 /// Useful for multi-level coherence.
247 static const FlagsType SUPPLY_EXCLUSIVE = 0x00000004;
248 // Snoop response flags
249 static const FlagsType MEM_INHIBIT = 0x00000008;
250 /// Are the 'addr' and 'size' fields valid?
251 static const FlagsType VALID_ADDR = 0x00000100;
252 static const FlagsType VALID_SIZE = 0x00000200;
| 235
236 private:
237 static const FlagsType PUBLIC_FLAGS = 0x00000000;
238 static const FlagsType PRIVATE_FLAGS = 0x00007F0F;
239 static const FlagsType COPY_FLAGS = 0x0000000F;
240
241 static const FlagsType SHARED = 0x00000001;
242 // Special control flags
243 /// Special timing-mode atomic snoop for multi-level coherence.
244 static const FlagsType EXPRESS_SNOOP = 0x00000002;
245 /// Does supplier have exclusive copy?
246 /// Useful for multi-level coherence.
247 static const FlagsType SUPPLY_EXCLUSIVE = 0x00000004;
248 // Snoop response flags
249 static const FlagsType MEM_INHIBIT = 0x00000008;
250 /// Are the 'addr' and 'size' fields valid?
251 static const FlagsType VALID_ADDR = 0x00000100;
252 static const FlagsType VALID_SIZE = 0x00000200;
|
253 /// Is the 'src' field valid?
254 static const FlagsType VALID_SRC = 0x00000400;
255 static const FlagsType VALID_DST = 0x00000800;
| |
256 /// Is the data pointer set to a value that shouldn't be freed
257 /// when the packet is destroyed?
258 static const FlagsType STATIC_DATA = 0x00001000;
259 /// The data pointer points to a value that should be freed when
260 /// the packet is destroyed.
261 static const FlagsType DYNAMIC_DATA = 0x00002000;
262 /// the data pointer points to an array (thus delete []) needs to
263 /// be called on it rather than simply delete.
264 static const FlagsType ARRAY_DATA = 0x00004000;
265 /// suppress the error if this packet encounters a functional
266 /// access failure.
267 static const FlagsType SUPPRESS_FUNC_ERROR = 0x00008000;
268
269 Flags flags;
270
271 public:
272 typedef MemCmd::Command Command;
273
274 /// The command field of the packet.
275 MemCmd cmd;
276
277 /// A pointer to the original request.
278 RequestPtr req;
279
280 private:
281 /**
282 * A pointer to the data being transfered. It can be differnt
283 * sizes at each level of the heirarchy so it belongs in the
284 * packet, not request. This may or may not be populated when a
285 * responder recieves the packet. If not populated it memory should
286 * be allocated.
287 */
288 PacketDataPtr data;
289
290 /// The address of the request. This address could be virtual or
291 /// physical, depending on the system configuration.
292 Addr addr;
293
294 /// The size of the request or transfer.
295 unsigned size;
296
297 /**
298 * Source port identifier set on a request packet to enable
299 * appropriate routing of the responses. The source port
300 * identifier is set by any multiplexing component, e.g. a bus, as
301 * the timing responses need this information to be routed back to
302 * the appropriate port at a later point in time. The field can be
303 * updated (over-written) as the request packet passes through
304 * additional multiplexing components, and it is their
305 * responsibility to remember the original source port identifier,
306 * for example by using an appropriate sender state. The latter is
307 * done in the cache and bridge.
308 */
| 253 /// Is the data pointer set to a value that shouldn't be freed
254 /// when the packet is destroyed?
255 static const FlagsType STATIC_DATA = 0x00001000;
256 /// The data pointer points to a value that should be freed when
257 /// the packet is destroyed.
258 static const FlagsType DYNAMIC_DATA = 0x00002000;
259 /// the data pointer points to an array (thus delete []) needs to
260 /// be called on it rather than simply delete.
261 static const FlagsType ARRAY_DATA = 0x00004000;
262 /// suppress the error if this packet encounters a functional
263 /// access failure.
264 static const FlagsType SUPPRESS_FUNC_ERROR = 0x00008000;
265
266 Flags flags;
267
268 public:
269 typedef MemCmd::Command Command;
270
271 /// The command field of the packet.
272 MemCmd cmd;
273
274 /// A pointer to the original request.
275 RequestPtr req;
276
277 private:
278 /**
279 * A pointer to the data being transfered. It can be differnt
280 * sizes at each level of the heirarchy so it belongs in the
281 * packet, not request. This may or may not be populated when a
282 * responder recieves the packet. If not populated it memory should
283 * be allocated.
284 */
285 PacketDataPtr data;
286
287 /// The address of the request. This address could be virtual or
288 /// physical, depending on the system configuration.
289 Addr addr;
290
291 /// The size of the request or transfer.
292 unsigned size;
293
294 /**
295 * Source port identifier set on a request packet to enable
296 * appropriate routing of the responses. The source port
297 * identifier is set by any multiplexing component, e.g. a bus, as
298 * the timing responses need this information to be routed back to
299 * the appropriate port at a later point in time. The field can be
300 * updated (over-written) as the request packet passes through
301 * additional multiplexing components, and it is their
302 * responsibility to remember the original source port identifier,
303 * for example by using an appropriate sender state. The latter is
304 * done in the cache and bridge.
305 */
|
309 NodeID src;
| 306 PortID src;
|
310
311 /**
312 * Destination port identifier that is present on all response
313 * packets that passed through a multiplexing component as a
314 * request packet. The source port identifier is turned into a
315 * destination port identifier when the packet is turned into a
316 * response, and the destination is used, e.g. by the bus, to
317 * select the appropriate path through the interconnect.
318 */
| 307
308 /**
309 * Destination port identifier that is present on all response
310 * packets that passed through a multiplexing component as a
311 * request packet. The source port identifier is turned into a
312 * destination port identifier when the packet is turned into a
313 * response, and the destination is used, e.g. by the bus, to
314 * select the appropriate path through the interconnect.
315 */
|
319 NodeID dest;
| 316 PortID dest;
|
320
321 /**
322 * The original value of the command field. Only valid when the
323 * current command field is an error condition; in that case, the
324 * previous contents of the command field are copied here. This
325 * field is *not* set on non-error responses.
326 */
327 MemCmd origCmd;
328
329 /**
330 * These values specify the range of bytes found that satisfy a
331 * functional read.
332 */
333 uint16_t bytesValidStart;
334 uint16_t bytesValidEnd;
335
336 public:
337 /// Used to calculate latencies for each packet.
338 Tick time;
339
340 /// The time at which the packet will be fully transmitted
341 Tick finishTime;
342
343 /// The time at which the first chunk of the packet will be transmitted
344 Tick firstWordTime;
345
346 /**
347 * A virtual base opaque structure used to hold state associated
348 * with the packet but specific to the sending device (e.g., an
349 * MSHR). A pointer to this state is returned in the packet's
350 * response so that the sender can quickly look up the state
351 * needed to process it. A specific subclass would be derived
352 * from this to carry state specific to a particular sending
353 * device.
354 */
355 struct SenderState
356 {
357 virtual ~SenderState() {}
358 };
359
360 /**
361 * Object used to maintain state of a PrintReq. The senderState
362 * field of a PrintReq should always be of this type.
363 */
364 class PrintReqState : public SenderState, public FastAlloc
365 {
366 private:
367 /**
368 * An entry in the label stack.
369 */
370 struct LabelStackEntry
371 {
372 const std::string label;
373 std::string *prefix;
374 bool labelPrinted;
375 LabelStackEntry(const std::string &_label, std::string *_prefix);
376 };
377
378 typedef std::list<LabelStackEntry> LabelStack;
379 LabelStack labelStack;
380
381 std::string *curPrefixPtr;
382
383 public:
384 std::ostream &os;
385 const int verbosity;
386
387 PrintReqState(std::ostream &os, int verbosity = 0);
388 ~PrintReqState();
389
390 /**
391 * Returns the current line prefix.
392 */
393 const std::string &curPrefix() { return *curPrefixPtr; }
394
395 /**
396 * Push a label onto the label stack, and prepend the given
397 * prefix string onto the current prefix. Labels will only be
398 * printed if an object within the label's scope is printed.
399 */
400 void pushLabel(const std::string &lbl,
401 const std::string &prefix = " ");
402
403 /**
404 * Pop a label off the label stack.
405 */
406 void popLabel();
407
408 /**
409 * Print all of the pending unprinted labels on the
410 * stack. Called by printObj(), so normally not called by
411 * users unless bypassing printObj().
412 */
413 void printLabels();
414
415 /**
416 * Print a Printable object to os, because it matched the
417 * address on a PrintReq.
418 */
419 void printObj(Printable *obj);
420 };
421
422 /**
423 * This packet's sender state. Devices should use dynamic_cast<>
424 * to cast to the state appropriate to the sender. The intent of
425 * this variable is to allow a device to attach extra information
426 * to a request. A response packet must return the sender state
427 * that was attached to the original request (even if a new packet
428 * is created).
429 */
430 SenderState *senderState;
431
432 /// Return the string name of the cmd field (for debugging and
433 /// tracing).
434 const std::string &cmdString() const { return cmd.toString(); }
435
436 /// Return the index of this command.
437 inline int cmdToIndex() const { return cmd.toInt(); }
438
439 bool isRead() const { return cmd.isRead(); }
440 bool isWrite() const { return cmd.isWrite(); }
441 bool isUpgrade() const { return cmd.isUpgrade(); }
442 bool isRequest() const { return cmd.isRequest(); }
443 bool isResponse() const { return cmd.isResponse(); }
444 bool needsExclusive() const { return cmd.needsExclusive(); }
445 bool needsResponse() const { return cmd.needsResponse(); }
446 bool isInvalidate() const { return cmd.isInvalidate(); }
447 bool hasData() const { return cmd.hasData(); }
448 bool isReadWrite() const { return cmd.isReadWrite(); }
449 bool isLLSC() const { return cmd.isLLSC(); }
450 bool isError() const { return cmd.isError(); }
451 bool isPrint() const { return cmd.isPrint(); }
452 bool isFlush() const { return cmd.isFlush(); }
453
454 // Snoop flags
455 void assertMemInhibit() { flags.set(MEM_INHIBIT); }
456 bool memInhibitAsserted() { return flags.isSet(MEM_INHIBIT); }
457 void assertShared() { flags.set(SHARED); }
458 bool sharedAsserted() { return flags.isSet(SHARED); }
459
460 // Special control flags
461 void setExpressSnoop() { flags.set(EXPRESS_SNOOP); }
462 bool isExpressSnoop() { return flags.isSet(EXPRESS_SNOOP); }
463 void setSupplyExclusive() { flags.set(SUPPLY_EXCLUSIVE); }
464 void clearSupplyExclusive() { flags.clear(SUPPLY_EXCLUSIVE); }
465 bool isSupplyExclusive() { return flags.isSet(SUPPLY_EXCLUSIVE); }
466 void setSuppressFuncError() { flags.set(SUPPRESS_FUNC_ERROR); }
467 bool suppressFuncError() { return flags.isSet(SUPPRESS_FUNC_ERROR); }
468
469 // Network error conditions... encapsulate them as methods since
470 // their encoding keeps changing (from result field to command
471 // field, etc.)
472 void
473 setNacked()
474 {
475 assert(isResponse());
476 cmd = MemCmd::NetworkNackError;
477 }
478
479 void
480 setBadAddress()
481 {
482 assert(isResponse());
483 cmd = MemCmd::BadAddressError;
484 }
485
486 bool wasNacked() const { return cmd == MemCmd::NetworkNackError; }
487 bool hadBadAddress() const { return cmd == MemCmd::BadAddressError; }
488 void copyError(Packet *pkt) { assert(pkt->isError()); cmd = pkt->cmd; }
489
| 317
318 /**
319 * The original value of the command field. Only valid when the
320 * current command field is an error condition; in that case, the
321 * previous contents of the command field are copied here. This
322 * field is *not* set on non-error responses.
323 */
324 MemCmd origCmd;
325
326 /**
327 * These values specify the range of bytes found that satisfy a
328 * functional read.
329 */
330 uint16_t bytesValidStart;
331 uint16_t bytesValidEnd;
332
333 public:
334 /// Used to calculate latencies for each packet.
335 Tick time;
336
337 /// The time at which the packet will be fully transmitted
338 Tick finishTime;
339
340 /// The time at which the first chunk of the packet will be transmitted
341 Tick firstWordTime;
342
343 /**
344 * A virtual base opaque structure used to hold state associated
345 * with the packet but specific to the sending device (e.g., an
346 * MSHR). A pointer to this state is returned in the packet's
347 * response so that the sender can quickly look up the state
348 * needed to process it. A specific subclass would be derived
349 * from this to carry state specific to a particular sending
350 * device.
351 */
352 struct SenderState
353 {
354 virtual ~SenderState() {}
355 };
356
357 /**
358 * Object used to maintain state of a PrintReq. The senderState
359 * field of a PrintReq should always be of this type.
360 */
361 class PrintReqState : public SenderState, public FastAlloc
362 {
363 private:
364 /**
365 * An entry in the label stack.
366 */
367 struct LabelStackEntry
368 {
369 const std::string label;
370 std::string *prefix;
371 bool labelPrinted;
372 LabelStackEntry(const std::string &_label, std::string *_prefix);
373 };
374
375 typedef std::list<LabelStackEntry> LabelStack;
376 LabelStack labelStack;
377
378 std::string *curPrefixPtr;
379
380 public:
381 std::ostream &os;
382 const int verbosity;
383
384 PrintReqState(std::ostream &os, int verbosity = 0);
385 ~PrintReqState();
386
387 /**
388 * Returns the current line prefix.
389 */
390 const std::string &curPrefix() { return *curPrefixPtr; }
391
392 /**
393 * Push a label onto the label stack, and prepend the given
394 * prefix string onto the current prefix. Labels will only be
395 * printed if an object within the label's scope is printed.
396 */
397 void pushLabel(const std::string &lbl,
398 const std::string &prefix = " ");
399
400 /**
401 * Pop a label off the label stack.
402 */
403 void popLabel();
404
405 /**
406 * Print all of the pending unprinted labels on the
407 * stack. Called by printObj(), so normally not called by
408 * users unless bypassing printObj().
409 */
410 void printLabels();
411
412 /**
413 * Print a Printable object to os, because it matched the
414 * address on a PrintReq.
415 */
416 void printObj(Printable *obj);
417 };
418
419 /**
420 * This packet's sender state. Devices should use dynamic_cast<>
421 * to cast to the state appropriate to the sender. The intent of
422 * this variable is to allow a device to attach extra information
423 * to a request. A response packet must return the sender state
424 * that was attached to the original request (even if a new packet
425 * is created).
426 */
427 SenderState *senderState;
428
429 /// Return the string name of the cmd field (for debugging and
430 /// tracing).
431 const std::string &cmdString() const { return cmd.toString(); }
432
433 /// Return the index of this command.
434 inline int cmdToIndex() const { return cmd.toInt(); }
435
436 bool isRead() const { return cmd.isRead(); }
437 bool isWrite() const { return cmd.isWrite(); }
438 bool isUpgrade() const { return cmd.isUpgrade(); }
439 bool isRequest() const { return cmd.isRequest(); }
440 bool isResponse() const { return cmd.isResponse(); }
441 bool needsExclusive() const { return cmd.needsExclusive(); }
442 bool needsResponse() const { return cmd.needsResponse(); }
443 bool isInvalidate() const { return cmd.isInvalidate(); }
444 bool hasData() const { return cmd.hasData(); }
445 bool isReadWrite() const { return cmd.isReadWrite(); }
446 bool isLLSC() const { return cmd.isLLSC(); }
447 bool isError() const { return cmd.isError(); }
448 bool isPrint() const { return cmd.isPrint(); }
449 bool isFlush() const { return cmd.isFlush(); }
450
451 // Snoop flags
452 void assertMemInhibit() { flags.set(MEM_INHIBIT); }
453 bool memInhibitAsserted() { return flags.isSet(MEM_INHIBIT); }
454 void assertShared() { flags.set(SHARED); }
455 bool sharedAsserted() { return flags.isSet(SHARED); }
456
457 // Special control flags
458 void setExpressSnoop() { flags.set(EXPRESS_SNOOP); }
459 bool isExpressSnoop() { return flags.isSet(EXPRESS_SNOOP); }
460 void setSupplyExclusive() { flags.set(SUPPLY_EXCLUSIVE); }
461 void clearSupplyExclusive() { flags.clear(SUPPLY_EXCLUSIVE); }
462 bool isSupplyExclusive() { return flags.isSet(SUPPLY_EXCLUSIVE); }
463 void setSuppressFuncError() { flags.set(SUPPRESS_FUNC_ERROR); }
464 bool suppressFuncError() { return flags.isSet(SUPPRESS_FUNC_ERROR); }
465
466 // Network error conditions... encapsulate them as methods since
467 // their encoding keeps changing (from result field to command
468 // field, etc.)
469 void
470 setNacked()
471 {
472 assert(isResponse());
473 cmd = MemCmd::NetworkNackError;
474 }
475
476 void
477 setBadAddress()
478 {
479 assert(isResponse());
480 cmd = MemCmd::BadAddressError;
481 }
482
483 bool wasNacked() const { return cmd == MemCmd::NetworkNackError; }
484 bool hadBadAddress() const { return cmd == MemCmd::BadAddressError; }
485 void copyError(Packet *pkt) { assert(pkt->isError()); cmd = pkt->cmd; }
486
|
490 bool isSrcValid() { return flags.isSet(VALID_SRC); }
| 487 bool isSrcValid() const { return src != InvalidPortID; }
|
491 /// Accessor function to get the source index of the packet.
| 488 /// Accessor function to get the source index of the packet.
|
492 NodeID getSrc() const { assert(flags.isSet(VALID_SRC)); return src; }
| 489 PortID getSrc() const { assert(isSrcValid()); return src; }
|
493 /// Accessor function to set the source index of the packet.
| 490 /// Accessor function to set the source index of the packet.
|
494 void setSrc(NodeID _src) { src = _src; flags.set(VALID_SRC); }
| 491 void setSrc(PortID _src) { src = _src; }
|
495 /// Reset source field, e.g. to retransmit packet on different bus.
| 492 /// Reset source field, e.g. to retransmit packet on different bus.
|
496 void clearSrc() { flags.clear(VALID_SRC); }
| 493 void clearSrc() { src = InvalidPortID; }
|
497
| 494
|
498 bool isDestValid() { return flags.isSet(VALID_DST); }
| 495 bool isDestValid() const { return dest != InvalidPortID; }
|
499 /// Accessor function for the destination index of the packet.
| 496 /// Accessor function for the destination index of the packet.
|
500 NodeID getDest() const { assert(flags.isSet(VALID_DST)); return dest; }
| 497 PortID getDest() const { assert(isDestValid()); return dest; }
|
501 /// Accessor function to set the destination index of the packet.
| 498 /// Accessor function to set the destination index of the packet.
|
502 void setDest(NodeID _dest) { dest = _dest; flags.set(VALID_DST); }
| 499 void setDest(PortID _dest) { dest = _dest; }
|
503 /// Reset destination field, e.g. to turn a response into a request again.
| 500 /// Reset destination field, e.g. to turn a response into a request again.
|
504 void clearDest() { flags.clear(VALID_DST); }
| 501 void clearDest() { dest = InvalidPortID; }
|
505
506 Addr getAddr() const { assert(flags.isSet(VALID_ADDR)); return addr; }
507 unsigned getSize() const { assert(flags.isSet(VALID_SIZE)); return size; }
508 Addr getOffset(int blkSize) const { return getAddr() & (Addr)(blkSize - 1); }
509
510 /**
511 * It has been determined that the SC packet should successfully update
512 * memory. Therefore, convert this SC packet to a normal write.
513 */
514 void
515 convertScToWrite()
516 {
517 assert(isLLSC());
518 assert(isWrite());
519 cmd = MemCmd::WriteReq;
520 }
521
522 /**
523 * When ruby is in use, Ruby will monitor the cache line and thus M5
524 * phys memory should treat LL ops as normal reads.
525 */
526 void
527 convertLlToRead()
528 {
529 assert(isLLSC());
530 assert(isRead());
531 cmd = MemCmd::ReadReq;
532 }
533
534 /**
535 * Constructor. Note that a Request object must be constructed
536 * first, but the Requests's physical address and size fields need
537 * not be valid. The command must be supplied.
538 */
539 Packet(Request *_req, MemCmd _cmd)
540 : cmd(_cmd), req(_req), data(NULL),
| 502
503 Addr getAddr() const { assert(flags.isSet(VALID_ADDR)); return addr; }
504 unsigned getSize() const { assert(flags.isSet(VALID_SIZE)); return size; }
505 Addr getOffset(int blkSize) const { return getAddr() & (Addr)(blkSize - 1); }
506
507 /**
508 * It has been determined that the SC packet should successfully update
509 * memory. Therefore, convert this SC packet to a normal write.
510 */
511 void
512 convertScToWrite()
513 {
514 assert(isLLSC());
515 assert(isWrite());
516 cmd = MemCmd::WriteReq;
517 }
518
519 /**
520 * When ruby is in use, Ruby will monitor the cache line and thus M5
521 * phys memory should treat LL ops as normal reads.
522 */
523 void
524 convertLlToRead()
525 {
526 assert(isLLSC());
527 assert(isRead());
528 cmd = MemCmd::ReadReq;
529 }
530
531 /**
532 * Constructor. Note that a Request object must be constructed
533 * first, but the Requests's physical address and size fields need
534 * not be valid. The command must be supplied.
535 */
536 Packet(Request *_req, MemCmd _cmd)
537 : cmd(_cmd), req(_req), data(NULL),
|
| 538 src(InvalidPortID), dest(InvalidPortID),
|
541 bytesValidStart(0), bytesValidEnd(0),
542 time(curTick()), senderState(NULL)
543 {
544 if (req->hasPaddr()) {
545 addr = req->getPaddr();
546 flags.set(VALID_ADDR);
547 }
548 if (req->hasSize()) {
549 size = req->getSize();
550 flags.set(VALID_SIZE);
551 }
552 }
553
554 /**
555 * Alternate constructor if you are trying to create a packet with
556 * a request that is for a whole block, not the address from the
557 * req. this allows for overriding the size/addr of the req.
558 */
559 Packet(Request *_req, MemCmd _cmd, int _blkSize)
560 : cmd(_cmd), req(_req), data(NULL),
| 539 bytesValidStart(0), bytesValidEnd(0),
540 time(curTick()), senderState(NULL)
541 {
542 if (req->hasPaddr()) {
543 addr = req->getPaddr();
544 flags.set(VALID_ADDR);
545 }
546 if (req->hasSize()) {
547 size = req->getSize();
548 flags.set(VALID_SIZE);
549 }
550 }
551
552 /**
553 * Alternate constructor if you are trying to create a packet with
554 * a request that is for a whole block, not the address from the
555 * req. this allows for overriding the size/addr of the req.
556 */
557 Packet(Request *_req, MemCmd _cmd, int _blkSize)
558 : cmd(_cmd), req(_req), data(NULL),
|
| 559 src(InvalidPortID), dest(InvalidPortID),
|
561 bytesValidStart(0), bytesValidEnd(0),
562 time(curTick()), senderState(NULL)
563 {
564 if (req->hasPaddr()) {
565 addr = req->getPaddr() & ~(_blkSize - 1);
566 flags.set(VALID_ADDR);
567 }
568 size = _blkSize;
569 flags.set(VALID_SIZE);
570 }
571
572 /**
573 * Alternate constructor for copying a packet. Copy all fields
574 * *except* if the original packet's data was dynamic, don't copy
575 * that, as we can't guarantee that the new packet's lifetime is
576 * less than that of the original packet. In this case the new
577 * packet should allocate its own data.
578 */
579 Packet(Packet *pkt, bool clearFlags = false)
580 : cmd(pkt->cmd), req(pkt->req),
581 data(pkt->flags.isSet(STATIC_DATA) ? pkt->data : NULL),
582 addr(pkt->addr), size(pkt->size), src(pkt->src), dest(pkt->dest),
583 bytesValidStart(pkt->bytesValidStart), bytesValidEnd(pkt->bytesValidEnd),
584 time(curTick()), senderState(pkt->senderState)
585 {
586 if (!clearFlags)
587 flags.set(pkt->flags & COPY_FLAGS);
588
| 560 bytesValidStart(0), bytesValidEnd(0),
561 time(curTick()), senderState(NULL)
562 {
563 if (req->hasPaddr()) {
564 addr = req->getPaddr() & ~(_blkSize - 1);
565 flags.set(VALID_ADDR);
566 }
567 size = _blkSize;
568 flags.set(VALID_SIZE);
569 }
570
571 /**
572 * Alternate constructor for copying a packet. Copy all fields
573 * *except* if the original packet's data was dynamic, don't copy
574 * that, as we can't guarantee that the new packet's lifetime is
575 * less than that of the original packet. In this case the new
576 * packet should allocate its own data.
577 */
578 Packet(Packet *pkt, bool clearFlags = false)
579 : cmd(pkt->cmd), req(pkt->req),
580 data(pkt->flags.isSet(STATIC_DATA) ? pkt->data : NULL),
581 addr(pkt->addr), size(pkt->size), src(pkt->src), dest(pkt->dest),
582 bytesValidStart(pkt->bytesValidStart), bytesValidEnd(pkt->bytesValidEnd),
583 time(curTick()), senderState(pkt->senderState)
584 {
585 if (!clearFlags)
586 flags.set(pkt->flags & COPY_FLAGS);
587
|
589 flags.set(pkt->flags & (VALID_ADDR|VALID_SIZE|VALID_SRC|VALID_DST));
| 588 flags.set(pkt->flags & (VALID_ADDR|VALID_SIZE));
|
590 flags.set(pkt->flags & STATIC_DATA);
591
592 }
593
594 /**
595 * clean up packet variables
596 */
597 ~Packet()
598 {
599 // If this is a request packet for which there's no response,
600 // delete the request object here, since the requester will
601 // never get the chance.
602 if (req && isRequest() && !needsResponse())
603 delete req;
604 deleteData();
605 }
606
607 /**
608 * Reinitialize packet address and size from the associated
609 * Request object, and reset other fields that may have been
610 * modified by a previous transaction. Typically called when a
611 * statically allocated Request/Packet pair is reused for multiple
612 * transactions.
613 */
614 void
615 reinitFromRequest()
616 {
617 assert(req->hasPaddr());
618 flags = 0;
619 addr = req->getPaddr();
620 size = req->getSize();
621 time = req->time();
622
623 flags.set(VALID_ADDR|VALID_SIZE);
624 deleteData();
625 }
626
627 /**
628 * Take a request packet and modify it in place to be suitable for
629 * returning as a response to that request. The source field is
630 * turned into the destination, and subsequently cleared. Note
631 * that the latter is not necessary for atomic requests, but
632 * causes no harm as neither field is valid.
633 */
634 void
635 makeResponse()
636 {
637 assert(needsResponse());
638 assert(isRequest());
639 origCmd = cmd;
640 cmd = cmd.responseCommand();
641
642 // responses are never express, even if the snoop that
643 // triggered them was
644 flags.clear(EXPRESS_SNOOP);
645
646 dest = src;
| 589 flags.set(pkt->flags & STATIC_DATA);
590
591 }
592
593 /**
594 * clean up packet variables
595 */
596 ~Packet()
597 {
598 // If this is a request packet for which there's no response,
599 // delete the request object here, since the requester will
600 // never get the chance.
601 if (req && isRequest() && !needsResponse())
602 delete req;
603 deleteData();
604 }
605
606 /**
607 * Reinitialize packet address and size from the associated
608 * Request object, and reset other fields that may have been
609 * modified by a previous transaction. Typically called when a
610 * statically allocated Request/Packet pair is reused for multiple
611 * transactions.
612 */
613 void
614 reinitFromRequest()
615 {
616 assert(req->hasPaddr());
617 flags = 0;
618 addr = req->getPaddr();
619 size = req->getSize();
620 time = req->time();
621
622 flags.set(VALID_ADDR|VALID_SIZE);
623 deleteData();
624 }
625
626 /**
627 * Take a request packet and modify it in place to be suitable for
628 * returning as a response to that request. The source field is
629 * turned into the destination, and subsequently cleared. Note
630 * that the latter is not necessary for atomic requests, but
631 * causes no harm as neither field is valid.
632 */
633 void
634 makeResponse()
635 {
636 assert(needsResponse());
637 assert(isRequest());
638 origCmd = cmd;
639 cmd = cmd.responseCommand();
640
641 // responses are never express, even if the snoop that
642 // triggered them was
643 flags.clear(EXPRESS_SNOOP);
644
645 dest = src;
|
647 flags.set(VALID_DST, flags.isSet(VALID_SRC));
648 flags.clear(VALID_SRC);
| 646 clearSrc();
|
649 }
650
651 void
652 makeAtomicResponse()
653 {
654 makeResponse();
655 }
656
657 void
658 makeTimingResponse()
659 {
660 makeResponse();
661 }
662
663 void
664 setFunctionalResponseStatus(bool success)
665 {
666 if (!success) {
667 if (isWrite()) {
668 cmd = MemCmd::FunctionalWriteError;
669 } else {
670 cmd = MemCmd::FunctionalReadError;
671 }
672 }
673 }
674
675 /**
676 * Take a request packet that has been returned as NACKED and
677 * modify it so that it can be sent out again. Only packets that
678 * need a response can be NACKED, so verify that that is true.
679 */
680 void
681 reinitNacked()
682 {
683 assert(wasNacked());
684 cmd = origCmd;
685 assert(needsResponse());
686 clearDest();
687 }
688
689 void
690 setSize(unsigned size)
691 {
692 assert(!flags.isSet(VALID_SIZE));
693
694 this->size = size;
695 flags.set(VALID_SIZE);
696 }
697
698
699 /**
700 * Set the data pointer to the following value that should not be
701 * freed.
702 */
703 template <typename T>
704 void
705 dataStatic(T *p)
706 {
707 assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA|ARRAY_DATA));
708 data = (PacketDataPtr)p;
709 flags.set(STATIC_DATA);
710 }
711
712 /**
713 * Set the data pointer to a value that should have delete []
714 * called on it.
715 */
716 template <typename T>
717 void
718 dataDynamicArray(T *p)
719 {
720 assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA|ARRAY_DATA));
721 data = (PacketDataPtr)p;
722 flags.set(DYNAMIC_DATA|ARRAY_DATA);
723 }
724
725 /**
726 * set the data pointer to a value that should have delete called
727 * on it.
728 */
729 template <typename T>
730 void
731 dataDynamic(T *p)
732 {
733 assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA|ARRAY_DATA));
734 data = (PacketDataPtr)p;
735 flags.set(DYNAMIC_DATA);
736 }
737
738 /**
739 * get a pointer to the data ptr.
740 */
741 template <typename T>
742 T*
743 getPtr(bool null_ok = false)
744 {
745 assert(null_ok || flags.isSet(STATIC_DATA|DYNAMIC_DATA));
746 return (T*)data;
747 }
748
749 /**
750 * return the value of what is pointed to in the packet.
751 */
752 template <typename T>
753 T get();
754
755 /**
756 * set the value in the data pointer to v.
757 */
758 template <typename T>
759 void set(T v);
760
761 /**
762 * Copy data into the packet from the provided pointer.
763 */
764 void
765 setData(uint8_t *p)
766 {
767 if (p != getPtr<uint8_t>())
768 std::memcpy(getPtr<uint8_t>(), p, getSize());
769 }
770
771 /**
772 * Copy data into the packet from the provided block pointer,
773 * which is aligned to the given block size.
774 */
775 void
776 setDataFromBlock(uint8_t *blk_data, int blkSize)
777 {
778 setData(blk_data + getOffset(blkSize));
779 }
780
781 /**
782 * Copy data from the packet to the provided block pointer, which
783 * is aligned to the given block size.
784 */
785 void
786 writeData(uint8_t *p)
787 {
788 std::memcpy(p, getPtr<uint8_t>(), getSize());
789 }
790
791 /**
792 * Copy data from the packet to the memory at the provided pointer.
793 */
794 void
795 writeDataToBlock(uint8_t *blk_data, int blkSize)
796 {
797 writeData(blk_data + getOffset(blkSize));
798 }
799
800 /**
801 * delete the data pointed to in the data pointer. Ok to call to
802 * matter how data was allocted.
803 */
804 void
805 deleteData()
806 {
807 if (flags.isSet(ARRAY_DATA))
808 delete [] data;
809 else if (flags.isSet(DYNAMIC_DATA))
810 delete data;
811
812 flags.clear(STATIC_DATA|DYNAMIC_DATA|ARRAY_DATA);
813 data = NULL;
814 }
815
816 /** If there isn't data in the packet, allocate some. */
817 void
818 allocate()
819 {
820 if (data) {
821 assert(flags.isSet(STATIC_DATA|DYNAMIC_DATA));
822 return;
823 }
824
825 assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA));
826 flags.set(DYNAMIC_DATA|ARRAY_DATA);
827 data = new uint8_t[getSize()];
828 }
829
830 /**
831 * Check a functional request against a memory value represented
832 * by a base/size pair and an associated data array. If the
833 * functional request is a read, it may be satisfied by the memory
834 * value. If the functional request is a write, it may update the
835 * memory value.
836 */
837 bool checkFunctional(Printable *obj, Addr base, int size, uint8_t *data);
838
839 /**
840 * Check a functional request against a memory value stored in
841 * another packet (i.e. an in-transit request or response).
842 */
843 bool
844 checkFunctional(PacketPtr other)
845 {
846 uint8_t *data = other->hasData() ? other->getPtr<uint8_t>() : NULL;
847 return checkFunctional(other, other->getAddr(), other->getSize(),
848 data);
849 }
850
851 /**
852 * Push label for PrintReq (safe to call unconditionally).
853 */
854 void
855 pushLabel(const std::string &lbl)
856 {
857 if (isPrint())
858 safe_cast<PrintReqState*>(senderState)->pushLabel(lbl);
859 }
860
861 /**
862 * Pop label for PrintReq (safe to call unconditionally).
863 */
864 void
865 popLabel()
866 {
867 if (isPrint())
868 safe_cast<PrintReqState*>(senderState)->popLabel();
869 }
870
871 void print(std::ostream &o, int verbosity = 0,
872 const std::string &prefix = "") const;
873};
874
875#endif //__MEM_PACKET_HH
| 647 }
648
649 void
650 makeAtomicResponse()
651 {
652 makeResponse();
653 }
654
655 void
656 makeTimingResponse()
657 {
658 makeResponse();
659 }
660
661 void
662 setFunctionalResponseStatus(bool success)
663 {
664 if (!success) {
665 if (isWrite()) {
666 cmd = MemCmd::FunctionalWriteError;
667 } else {
668 cmd = MemCmd::FunctionalReadError;
669 }
670 }
671 }
672
673 /**
674 * Take a request packet that has been returned as NACKED and
675 * modify it so that it can be sent out again. Only packets that
676 * need a response can be NACKED, so verify that that is true.
677 */
678 void
679 reinitNacked()
680 {
681 assert(wasNacked());
682 cmd = origCmd;
683 assert(needsResponse());
684 clearDest();
685 }
686
687 void
688 setSize(unsigned size)
689 {
690 assert(!flags.isSet(VALID_SIZE));
691
692 this->size = size;
693 flags.set(VALID_SIZE);
694 }
695
696
697 /**
698 * Set the data pointer to the following value that should not be
699 * freed.
700 */
701 template <typename T>
702 void
703 dataStatic(T *p)
704 {
705 assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA|ARRAY_DATA));
706 data = (PacketDataPtr)p;
707 flags.set(STATIC_DATA);
708 }
709
710 /**
711 * Set the data pointer to a value that should have delete []
712 * called on it.
713 */
714 template <typename T>
715 void
716 dataDynamicArray(T *p)
717 {
718 assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA|ARRAY_DATA));
719 data = (PacketDataPtr)p;
720 flags.set(DYNAMIC_DATA|ARRAY_DATA);
721 }
722
723 /**
724 * set the data pointer to a value that should have delete called
725 * on it.
726 */
727 template <typename T>
728 void
729 dataDynamic(T *p)
730 {
731 assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA|ARRAY_DATA));
732 data = (PacketDataPtr)p;
733 flags.set(DYNAMIC_DATA);
734 }
735
736 /**
737 * get a pointer to the data ptr.
738 */
739 template <typename T>
740 T*
741 getPtr(bool null_ok = false)
742 {
743 assert(null_ok || flags.isSet(STATIC_DATA|DYNAMIC_DATA));
744 return (T*)data;
745 }
746
747 /**
748 * return the value of what is pointed to in the packet.
749 */
750 template <typename T>
751 T get();
752
753 /**
754 * set the value in the data pointer to v.
755 */
756 template <typename T>
757 void set(T v);
758
759 /**
760 * Copy data into the packet from the provided pointer.
761 */
762 void
763 setData(uint8_t *p)
764 {
765 if (p != getPtr<uint8_t>())
766 std::memcpy(getPtr<uint8_t>(), p, getSize());
767 }
768
769 /**
770 * Copy data into the packet from the provided block pointer,
771 * which is aligned to the given block size.
772 */
773 void
774 setDataFromBlock(uint8_t *blk_data, int blkSize)
775 {
776 setData(blk_data + getOffset(blkSize));
777 }
778
779 /**
780 * Copy data from the packet to the provided block pointer, which
781 * is aligned to the given block size.
782 */
783 void
784 writeData(uint8_t *p)
785 {
786 std::memcpy(p, getPtr<uint8_t>(), getSize());
787 }
788
789 /**
790 * Copy data from the packet to the memory at the provided pointer.
791 */
792 void
793 writeDataToBlock(uint8_t *blk_data, int blkSize)
794 {
795 writeData(blk_data + getOffset(blkSize));
796 }
797
798 /**
799 * delete the data pointed to in the data pointer. Ok to call to
800 * matter how data was allocted.
801 */
802 void
803 deleteData()
804 {
805 if (flags.isSet(ARRAY_DATA))
806 delete [] data;
807 else if (flags.isSet(DYNAMIC_DATA))
808 delete data;
809
810 flags.clear(STATIC_DATA|DYNAMIC_DATA|ARRAY_DATA);
811 data = NULL;
812 }
813
814 /** If there isn't data in the packet, allocate some. */
815 void
816 allocate()
817 {
818 if (data) {
819 assert(flags.isSet(STATIC_DATA|DYNAMIC_DATA));
820 return;
821 }
822
823 assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA));
824 flags.set(DYNAMIC_DATA|ARRAY_DATA);
825 data = new uint8_t[getSize()];
826 }
827
828 /**
829 * Check a functional request against a memory value represented
830 * by a base/size pair and an associated data array. If the
831 * functional request is a read, it may be satisfied by the memory
832 * value. If the functional request is a write, it may update the
833 * memory value.
834 */
835 bool checkFunctional(Printable *obj, Addr base, int size, uint8_t *data);
836
837 /**
838 * Check a functional request against a memory value stored in
839 * another packet (i.e. an in-transit request or response).
840 */
841 bool
842 checkFunctional(PacketPtr other)
843 {
844 uint8_t *data = other->hasData() ? other->getPtr<uint8_t>() : NULL;
845 return checkFunctional(other, other->getAddr(), other->getSize(),
846 data);
847 }
848
849 /**
850 * Push label for PrintReq (safe to call unconditionally).
851 */
852 void
853 pushLabel(const std::string &lbl)
854 {
855 if (isPrint())
856 safe_cast<PrintReqState*>(senderState)->pushLabel(lbl);
857 }
858
859 /**
860 * Pop label for PrintReq (safe to call unconditionally).
861 */
862 void
863 popLabel()
864 {
865 if (isPrint())
866 safe_cast<PrintReqState*>(senderState)->popLabel();
867 }
868
869 void print(std::ostream &o, int verbosity = 0,
870 const std::string &prefix = "") const;
871};
872
873#endif //__MEM_PACKET_HH
|