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: Ron Dreslinski
29 * Steve Reinhardt
30 * Ali Saidi
31 */
32
33/**
34 * @file
35 * Declaration of the Packet class.
36 */
37
38#ifndef __MEM_PACKET_HH__
39#define __MEM_PACKET_HH__
40
41#include <cassert>
42#include <list>
| 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: Ron Dreslinski
29 * Steve Reinhardt
30 * Ali Saidi
31 */
32
33/**
34 * @file
35 * Declaration of the Packet class.
36 */
37
38#ifndef __MEM_PACKET_HH__
39#define __MEM_PACKET_HH__
40
41#include <cassert>
42#include <list>
|
43#include <bitset>
| |
44
| 43
|
| 44#include "base/compiler.hh"
|
45#include "base/misc.hh"
46#include "mem/request.hh"
47#include "sim/host.hh"
48#include "sim/root.hh"
49
50
51struct Packet;
52typedef Packet *PacketPtr;
53typedef uint8_t* PacketDataPtr;
54typedef std::list<PacketPtr> PacketList;
55
56//Coherence Flags
57#define NACKED_LINE (1 << 0)
58#define SATISFIED (1 << 1)
59#define SHARED_LINE (1 << 2)
60#define CACHE_LINE_FILL (1 << 3)
61#define COMPRESSED (1 << 4)
62#define NO_ALLOCATE (1 << 5)
63#define SNOOP_COMMIT (1 << 6)
64
| 45#include "base/misc.hh"
46#include "mem/request.hh"
47#include "sim/host.hh"
48#include "sim/root.hh"
49
50
51struct Packet;
52typedef Packet *PacketPtr;
53typedef uint8_t* PacketDataPtr;
54typedef std::list<PacketPtr> PacketList;
55
56//Coherence Flags
57#define NACKED_LINE (1 << 0)
58#define SATISFIED (1 << 1)
59#define SHARED_LINE (1 << 2)
60#define CACHE_LINE_FILL (1 << 3)
61#define COMPRESSED (1 << 4)
62#define NO_ALLOCATE (1 << 5)
63#define SNOOP_COMMIT (1 << 6)
64
|
65
66class MemCmd
67{
68 public:
69
70 /** List of all commands associated with a packet. */
71 enum Command
72 {
73 InvalidCmd,
74 ReadReq,
75 WriteReq,
76 WriteReqNoAck,
77 ReadResp,
78 WriteResp,
79 Writeback,
80 SoftPFReq,
81 HardPFReq,
82 SoftPFResp,
83 HardPFResp,
84 InvalidateReq,
85 WriteInvalidateReq,
86 WriteInvalidateResp,
87 UpgradeReq,
88 ReadExReq,
89 ReadExResp,
90 NUM_MEM_CMDS
91 };
92
93 private:
94 /** List of command attributes. */
95 enum Attribute
96 {
97 IsRead,
98 IsWrite,
99 IsPrefetch,
100 IsInvalidate,
101 IsRequest,
102 IsResponse,
103 NeedsResponse,
104 IsSWPrefetch,
105 IsHWPrefetch,
106 IsUpgrade,
107 HasData,
108 NUM_COMMAND_ATTRIBUTES
109 };
110
111 /** Structure that defines attributes and other data associated
112 * with a Command. */
113 struct CommandInfo {
114 /** Set of attribute flags. */
115 const std::bitset<NUM_COMMAND_ATTRIBUTES> attributes;
116 /** Corresponding response for requests; InvalidCmd if no
117 * response is applicable. */
118 const Command response;
119 /** String representation (for printing) */
120 const std::string str;
121 };
122
123 /** Array to map Command enum to associated info. */
124 static const CommandInfo commandInfo[];
125
126 private:
127
128 Command cmd;
129
130 bool testCmdAttrib(MemCmd::Attribute attrib) const {
131 return commandInfo[cmd].attributes[attrib] != 0;
132 }
133
134 public:
135
136 bool isRead() const { return testCmdAttrib(IsRead); }
137 bool isWrite() const { return testCmdAttrib(IsWrite); }
138 bool isRequest() const { return testCmdAttrib(IsRequest); }
139 bool isResponse() const { return testCmdAttrib(IsResponse); }
140 bool needsResponse() const { return testCmdAttrib(NeedsResponse); }
141 bool isInvalidate() const { return testCmdAttrib(IsInvalidate); }
142 bool hasData() const { return testCmdAttrib(HasData); }
143
144 const Command responseCommand() const {
145 return commandInfo[cmd].response;
146 }
147
148 /** Return the string to a cmd given by idx. */
149 const std::string &toString() const {
150 return commandInfo[cmd].str;
151 }
152
153 int toInt() const { return (int)cmd; }
154
155 MemCmd(Command _cmd)
156 : cmd(_cmd)
157 { }
158
159 MemCmd(int _cmd)
160 : cmd((Command)_cmd)
161 { }
162
163 MemCmd()
164 : cmd(InvalidCmd)
165 { }
166
167 bool operator==(MemCmd c2) { return (cmd == c2.cmd); }
168 bool operator!=(MemCmd c2) { return (cmd != c2.cmd); }
169
170 friend class Packet;
171};
172
| 65//for now. @todo fix later
66#define NUM_MEM_CMDS (1 << 11)
|
173/**
174 * A Packet is used to encapsulate a transfer between two objects in
175 * the memory system (e.g., the L1 and L2 cache). (In contrast, a
176 * single Request travels all the way from the requester to the
177 * ultimate destination and back, possibly being conveyed by several
178 * different Packets along the way.)
179 */
180class Packet
181{
182 public:
| 67/**
68 * A Packet is used to encapsulate a transfer between two objects in
69 * the memory system (e.g., the L1 and L2 cache). (In contrast, a
70 * single Request travels all the way from the requester to the
71 * ultimate destination and back, possibly being conveyed by several
72 * different Packets along the way.)
73 */
74class Packet
75{
76 public:
|
183
184 typedef MemCmd::Command Command;
185
| |
186 /** Temporary FLAGS field until cache gets working, this should be in coherence/sender state. */
187 uint64_t flags;
188
189 private:
190 /** A pointer to the data being transfered. It can be differnt
191 * sizes at each level of the heirarchy so it belongs in the
192 * packet, not request. This may or may not be populated when a
193 * responder recieves the packet. If not populated it memory
194 * should be allocated.
195 */
196 PacketDataPtr data;
197
198 /** Is the data pointer set to a value that shouldn't be freed
199 * when the packet is destroyed? */
200 bool staticData;
201 /** The data pointer points to a value that should be freed when
202 * the packet is destroyed. */
203 bool dynamicData;
204 /** the data pointer points to an array (thus delete [] ) needs to
205 * be called on it rather than simply delete.*/
206 bool arrayData;
207
208 /** The address of the request. This address could be virtual or
209 * physical, depending on the system configuration. */
210 Addr addr;
211
212 /** The size of the request or transfer. */
213 int size;
214
215 /** Device address (e.g., bus ID) of the source of the
216 * transaction. The source is not responsible for setting this
217 * field; it is set implicitly by the interconnect when the
218 * packet is first sent. */
219 short src;
220
221 /** Device address (e.g., bus ID) of the destination of the
222 * transaction. The special value Broadcast indicates that the
223 * packet should be routed based on its address. This field is
224 * initialized in the constructor and is thus always valid
225 * (unlike * addr, size, and src). */
226 short dest;
227
228 /** Are the 'addr' and 'size' fields valid? */
229 bool addrSizeValid;
230 /** Is the 'src' field valid? */
231 bool srcValid;
232
233
234 public:
235
236 /** Used to calculate latencies for each packet.*/
237 Tick time;
238
239 /** The time at which the packet will be fully transmitted */
240 Tick finishTime;
241
242 /** The time at which the first chunk of the packet will be transmitted */
243 Tick firstWordTime;
244
245 /** The special destination address indicating that the packet
246 * should be routed based on its address. */
247 static const short Broadcast = -1;
248
249 /** A pointer to the original request. */
250 RequestPtr req;
251
252 /** A virtual base opaque structure used to hold coherence-related
253 * state. A specific subclass would be derived from this to
254 * carry state specific to a particular coherence protocol. */
255 class CoherenceState {
256 public:
257 virtual ~CoherenceState() {}
258 };
259
260 /** This packet's coherence state. Caches should use
261 * dynamic_cast<> to cast to the state appropriate for the
262 * system's coherence protocol. */
263 CoherenceState *coherence;
264
265 /** A virtual base opaque structure used to hold state associated
266 * with the packet but specific to the sending device (e.g., an
267 * MSHR). A pointer to this state is returned in the packet's
268 * response so that the sender can quickly look up the state
269 * needed to process it. A specific subclass would be derived
270 * from this to carry state specific to a particular sending
271 * device. */
272 class SenderState {
273 public:
274 virtual ~SenderState() {}
275 };
276
277 /** This packet's sender state. Devices should use dynamic_cast<>
278 * to cast to the state appropriate to the sender. */
279 SenderState *senderState;
280
| 77 /** Temporary FLAGS field until cache gets working, this should be in coherence/sender state. */
78 uint64_t flags;
79
80 private:
81 /** A pointer to the data being transfered. It can be differnt
82 * sizes at each level of the heirarchy so it belongs in the
83 * packet, not request. This may or may not be populated when a
84 * responder recieves the packet. If not populated it memory
85 * should be allocated.
86 */
87 PacketDataPtr data;
88
89 /** Is the data pointer set to a value that shouldn't be freed
90 * when the packet is destroyed? */
91 bool staticData;
92 /** The data pointer points to a value that should be freed when
93 * the packet is destroyed. */
94 bool dynamicData;
95 /** the data pointer points to an array (thus delete [] ) needs to
96 * be called on it rather than simply delete.*/
97 bool arrayData;
98
99 /** The address of the request. This address could be virtual or
100 * physical, depending on the system configuration. */
101 Addr addr;
102
103 /** The size of the request or transfer. */
104 int size;
105
106 /** Device address (e.g., bus ID) of the source of the
107 * transaction. The source is not responsible for setting this
108 * field; it is set implicitly by the interconnect when the
109 * packet is first sent. */
110 short src;
111
112 /** Device address (e.g., bus ID) of the destination of the
113 * transaction. The special value Broadcast indicates that the
114 * packet should be routed based on its address. This field is
115 * initialized in the constructor and is thus always valid
116 * (unlike * addr, size, and src). */
117 short dest;
118
119 /** Are the 'addr' and 'size' fields valid? */
120 bool addrSizeValid;
121 /** Is the 'src' field valid? */
122 bool srcValid;
123
124
125 public:
126
127 /** Used to calculate latencies for each packet.*/
128 Tick time;
129
130 /** The time at which the packet will be fully transmitted */
131 Tick finishTime;
132
133 /** The time at which the first chunk of the packet will be transmitted */
134 Tick firstWordTime;
135
136 /** The special destination address indicating that the packet
137 * should be routed based on its address. */
138 static const short Broadcast = -1;
139
140 /** A pointer to the original request. */
141 RequestPtr req;
142
143 /** A virtual base opaque structure used to hold coherence-related
144 * state. A specific subclass would be derived from this to
145 * carry state specific to a particular coherence protocol. */
146 class CoherenceState {
147 public:
148 virtual ~CoherenceState() {}
149 };
150
151 /** This packet's coherence state. Caches should use
152 * dynamic_cast<> to cast to the state appropriate for the
153 * system's coherence protocol. */
154 CoherenceState *coherence;
155
156 /** A virtual base opaque structure used to hold state associated
157 * with the packet but specific to the sending device (e.g., an
158 * MSHR). A pointer to this state is returned in the packet's
159 * response so that the sender can quickly look up the state
160 * needed to process it. A specific subclass would be derived
161 * from this to carry state specific to a particular sending
162 * device. */
163 class SenderState {
164 public:
165 virtual ~SenderState() {}
166 };
167
168 /** This packet's sender state. Devices should use dynamic_cast<>
169 * to cast to the state appropriate to the sender. */
170 SenderState *senderState;
171
|
| 172 private:
173 /** List of command attributes. */
174 // If you add a new CommandAttribute, make sure to increase NUM_MEM_CMDS
175 // as well.
176 enum CommandAttribute
177 {
178 IsRead = 1 << 0,
179 IsWrite = 1 << 1,
180 IsPrefetch = 1 << 2,
181 IsInvalidate = 1 << 3,
182 IsRequest = 1 << 4,
183 IsResponse = 1 << 5,
184 NeedsResponse = 1 << 6,
185 IsSWPrefetch = 1 << 7,
186 IsHWPrefetch = 1 << 8,
187 IsUpgrade = 1 << 9,
188 HasData = 1 << 10
189 };
190
|
281 public:
| 191 public:
|
| 192 /** List of all commands associated with a packet. */
193 enum Command
194 {
195 InvalidCmd = 0,
196 ReadReq = IsRead | IsRequest | NeedsResponse,
197 WriteReq = IsWrite | IsRequest | NeedsResponse | HasData,
198 WriteReqNoAck = IsWrite | IsRequest | HasData,
199 ReadResp = IsRead | IsResponse | NeedsResponse | HasData,
200 WriteResp = IsWrite | IsResponse | NeedsResponse,
201 Writeback = IsWrite | IsRequest | HasData,
202 SoftPFReq = IsRead | IsRequest | IsSWPrefetch | NeedsResponse,
203 HardPFReq = IsRead | IsRequest | IsHWPrefetch | NeedsResponse,
204 SoftPFResp = IsRead | IsResponse | IsSWPrefetch
205 | NeedsResponse | HasData,
206 HardPFResp = IsRead | IsResponse | IsHWPrefetch
207 | NeedsResponse | HasData,
208 InvalidateReq = IsInvalidate | IsRequest,
209 WriteInvalidateReq = IsWrite | IsInvalidate | IsRequest
210 | HasData | NeedsResponse,
211 WriteInvalidateResp = IsWrite | IsInvalidate | IsRequest
212 | NeedsResponse | IsResponse,
213 UpgradeReq = IsInvalidate | IsRequest | IsUpgrade,
214 ReadExReq = IsRead | IsInvalidate | IsRequest | NeedsResponse,
215 ReadExResp = IsRead | IsInvalidate | IsResponse
216 | NeedsResponse | HasData
217 };
|
282
| 218
|
283 /** The command field of the packet. */
284 MemCmd cmd;
285
| |
286 /** Return the string name of the cmd field (for debugging and
287 * tracing). */
| 219 /** Return the string name of the cmd field (for debugging and
220 * tracing). */
|
288 const std::string &cmdString() const { return cmd.toString(); }
| 221 const std::string &cmdString() const;
|
289
| 222
|
| 223 /** Reutrn the string to a cmd given by idx. */
224 const std::string &cmdIdxToString(Command idx);
225
|
290 /** Return the index of this command. */
| 226 /** Return the index of this command. */
|
291 inline int cmdToIndex() const { return cmd.toInt(); }
| 227 inline int cmdToIndex() const { return (int) cmd; }
|
292
| 228
|
293 public:
| 229 /** The command field of the packet. */
230 Command cmd;
|
294
| 231
|
295 bool isRead() const { return cmd.isRead(); }
296 bool isWrite() const { return cmd.isWrite(); }
297 bool isRequest() const { return cmd.isRequest(); }
298 bool isResponse() const { return cmd.isResponse(); }
299 bool needsResponse() const { return cmd.needsResponse(); }
300 bool isInvalidate() const { return cmd.isInvalidate(); }
301 bool hasData() const { return cmd.hasData(); }
| 232 bool isRead() const { return (cmd & IsRead) != 0; }
233 bool isWrite() const { return (cmd & IsWrite) != 0; }
234 bool isRequest() const { return (cmd & IsRequest) != 0; }
235 bool isResponse() const { return (cmd & IsResponse) != 0; }
236 bool needsResponse() const { return (cmd & NeedsResponse) != 0; }
237 bool isInvalidate() const { return (cmd & IsInvalidate) != 0; }
238 bool hasData() const { return (cmd & HasData) != 0; }
|
302
303 bool isCacheFill() const { return (flags & CACHE_LINE_FILL) != 0; }
304 bool isNoAllocate() const { return (flags & NO_ALLOCATE) != 0; }
305 bool isCompressed() const { return (flags & COMPRESSED) != 0; }
306
307 bool nic_pkt() { panic("Unimplemented"); M5_DUMMY_RETURN }
308
309 /** Possible results of a packet's request. */
310 enum Result
311 {
312 Success,
313 BadAddress,
314 Nacked,
315 Unknown
316 };
317
318 /** The result of this packet's request. */
319 Result result;
320
321 /** Accessor function that returns the source index of the packet. */
322 short getSrc() const { assert(srcValid); return src; }
323 void setSrc(short _src) { src = _src; srcValid = true; }
324
325 /** Accessor function that returns the destination index of
326 the packet. */
327 short getDest() const { return dest; }
328 void setDest(short _dest) { dest = _dest; }
329
330 Addr getAddr() const { assert(addrSizeValid); return addr; }
331 int getSize() const { assert(addrSizeValid); return size; }
332 Addr getOffset(int blkSize) const { return addr & (Addr)(blkSize - 1); }
333
334 void addrOverride(Addr newAddr) { assert(addrSizeValid); addr = newAddr; }
| 239
240 bool isCacheFill() const { return (flags & CACHE_LINE_FILL) != 0; }
241 bool isNoAllocate() const { return (flags & NO_ALLOCATE) != 0; }
242 bool isCompressed() const { return (flags & COMPRESSED) != 0; }
243
244 bool nic_pkt() { panic("Unimplemented"); M5_DUMMY_RETURN }
245
246 /** Possible results of a packet's request. */
247 enum Result
248 {
249 Success,
250 BadAddress,
251 Nacked,
252 Unknown
253 };
254
255 /** The result of this packet's request. */
256 Result result;
257
258 /** Accessor function that returns the source index of the packet. */
259 short getSrc() const { assert(srcValid); return src; }
260 void setSrc(short _src) { src = _src; srcValid = true; }
261
262 /** Accessor function that returns the destination index of
263 the packet. */
264 short getDest() const { return dest; }
265 void setDest(short _dest) { dest = _dest; }
266
267 Addr getAddr() const { assert(addrSizeValid); return addr; }
268 int getSize() const { assert(addrSizeValid); return size; }
269 Addr getOffset(int blkSize) const { return addr & (Addr)(blkSize - 1); }
270
271 void addrOverride(Addr newAddr) { assert(addrSizeValid); addr = newAddr; }
|
335 void cmdOverride(MemCmd newCmd) { cmd = newCmd; }
| 272 void cmdOverride(Command newCmd) { cmd = newCmd; }
|
336
337 /** Constructor. Note that a Request object must be constructed
338 * first, but the Requests's physical address and size fields
339 * need not be valid. The command and destination addresses
340 * must be supplied. */
| 273
274 /** Constructor. Note that a Request object must be constructed
275 * first, but the Requests's physical address and size fields
276 * need not be valid. The command and destination addresses
277 * must be supplied. */
|
341 Packet(Request *_req, MemCmd _cmd, short _dest)
| 278 Packet(Request *_req, Command _cmd, short _dest)
|
342 : data(NULL), staticData(false), dynamicData(false), arrayData(false),
343 addr(_req->paddr), size(_req->size), dest(_dest),
344 addrSizeValid(_req->validPaddr),
345 srcValid(false),
346 req(_req), coherence(NULL), senderState(NULL), cmd(_cmd),
347 result(Unknown)
348 {
349 flags = 0;
350 time = curTick;
351 }
352
353 /** Alternate constructor if you are trying to create a packet with
354 * a request that is for a whole block, not the address from the req.
355 * this allows for overriding the size/addr of the req.*/
| 279 : data(NULL), staticData(false), dynamicData(false), arrayData(false),
280 addr(_req->paddr), size(_req->size), dest(_dest),
281 addrSizeValid(_req->validPaddr),
282 srcValid(false),
283 req(_req), coherence(NULL), senderState(NULL), cmd(_cmd),
284 result(Unknown)
285 {
286 flags = 0;
287 time = curTick;
288 }
289
290 /** Alternate constructor if you are trying to create a packet with
291 * a request that is for a whole block, not the address from the req.
292 * this allows for overriding the size/addr of the req.*/
|
356 Packet(Request *_req, MemCmd _cmd, short _dest, int _blkSize)
| 293 Packet(Request *_req, Command _cmd, short _dest, int _blkSize)
|
357 : data(NULL), staticData(false), dynamicData(false), arrayData(false),
358 addr(_req->paddr & ~(_blkSize - 1)), size(_blkSize),
359 dest(_dest),
360 addrSizeValid(_req->validPaddr), srcValid(false),
361 req(_req), coherence(NULL), senderState(NULL), cmd(_cmd),
362 result(Unknown)
363 {
364 flags = 0;
365 time = curTick;
366 }
367
368 /** Destructor. */
369 ~Packet()
370 { if (staticData || dynamicData) deleteData(); }
371
372 /** Reinitialize packet address and size from the associated
373 * Request object, and reset other fields that may have been
374 * modified by a previous transaction. Typically called when a
375 * statically allocated Request/Packet pair is reused for
376 * multiple transactions. */
377 void reinitFromRequest() {
378 assert(req->validPaddr);
379 flags = 0;
380 addr = req->paddr;
381 size = req->size;
382 time = req->time;
383 addrSizeValid = true;
384 result = Unknown;
385 if (dynamicData) {
386 deleteData();
387 dynamicData = false;
388 arrayData = false;
389 }
390 }
391
392 /** Take a request packet and modify it in place to be suitable
393 * for returning as a response to that request. Used for timing
394 * accesses only. For atomic and functional accesses, the
395 * request packet is always implicitly passed back *without*
396 * modifying the destination fields, so this function
397 * should not be called. */
398 void makeTimingResponse() {
399 assert(needsResponse());
400 assert(isRequest());
| 294 : data(NULL), staticData(false), dynamicData(false), arrayData(false),
295 addr(_req->paddr & ~(_blkSize - 1)), size(_blkSize),
296 dest(_dest),
297 addrSizeValid(_req->validPaddr), srcValid(false),
298 req(_req), coherence(NULL), senderState(NULL), cmd(_cmd),
299 result(Unknown)
300 {
301 flags = 0;
302 time = curTick;
303 }
304
305 /** Destructor. */
306 ~Packet()
307 { if (staticData || dynamicData) deleteData(); }
308
309 /** Reinitialize packet address and size from the associated
310 * Request object, and reset other fields that may have been
311 * modified by a previous transaction. Typically called when a
312 * statically allocated Request/Packet pair is reused for
313 * multiple transactions. */
314 void reinitFromRequest() {
315 assert(req->validPaddr);
316 flags = 0;
317 addr = req->paddr;
318 size = req->size;
319 time = req->time;
320 addrSizeValid = true;
321 result = Unknown;
322 if (dynamicData) {
323 deleteData();
324 dynamicData = false;
325 arrayData = false;
326 }
327 }
328
329 /** Take a request packet and modify it in place to be suitable
330 * for returning as a response to that request. Used for timing
331 * accesses only. For atomic and functional accesses, the
332 * request packet is always implicitly passed back *without*
333 * modifying the destination fields, so this function
334 * should not be called. */
335 void makeTimingResponse() {
336 assert(needsResponse());
337 assert(isRequest());
|
401 cmd = cmd.responseCommand();
| 338 int icmd = (int)cmd;
339 icmd &= ~(IsRequest);
340 icmd |= IsResponse;
341 if (isRead())
342 icmd |= HasData;
343 if (isWrite())
344 icmd &= ~HasData;
345 cmd = (Command)icmd;
|
402 dest = src;
403 srcValid = false;
404 }
405
| 346 dest = src;
347 srcValid = false;
348 }
349
|
| 350
351 void toggleData() {
352 int icmd = (int)cmd;
353 icmd ^= HasData;
354 cmd = (Command)icmd;
355 }
356
|
406 /**
407 * Take a request packet and modify it in place to be suitable for
408 * returning as a response to that request.
409 */
410 void makeAtomicResponse()
411 {
412 assert(needsResponse());
413 assert(isRequest());
| 357 /**
358 * Take a request packet and modify it in place to be suitable for
359 * returning as a response to that request.
360 */
361 void makeAtomicResponse()
362 {
363 assert(needsResponse());
364 assert(isRequest());
|
414 cmd = cmd.responseCommand();
| 365 int icmd = (int)cmd;
366 icmd &= ~(IsRequest);
367 icmd |= IsResponse;
368 if (isRead())
369 icmd |= HasData;
370 if (isWrite())
371 icmd &= ~HasData;
372 cmd = (Command)icmd;
|
415 }
416
417 /**
418 * Take a request packet that has been returned as NACKED and
419 * modify it so that it can be sent out again. Only packets that
420 * need a response can be NACKED, so verify that that is true.
421 */
422 void
423 reinitNacked()
424 {
425 assert(needsResponse() && result == Nacked);
426 dest = Broadcast;
427 result = Unknown;
428 }
429
430
431 /**
432 * Set the data pointer to the following value that should not be
433 * freed.
434 */
435 template <typename T>
436 void
437 dataStatic(T *p)
438 {
439 if(dynamicData)
440 dynamicData = false;
441 data = (PacketDataPtr)p;
442 staticData = true;
443 }
444
445 /**
446 * Set the data pointer to a value that should have delete []
447 * called on it.
448 */
449 template <typename T>
450 void
451 dataDynamicArray(T *p)
452 {
453 assert(!staticData && !dynamicData);
454 data = (PacketDataPtr)p;
455 dynamicData = true;
456 arrayData = true;
457 }
458
459 /**
460 * set the data pointer to a value that should have delete called
461 * on it.
462 */
463 template <typename T>
464 void
465 dataDynamic(T *p)
466 {
467 assert(!staticData && !dynamicData);
468 data = (PacketDataPtr)p;
469 dynamicData = true;
470 arrayData = false;
471 }
472
473 /** get a pointer to the data ptr. */
474 template <typename T>
475 T*
476 getPtr()
477 {
478 assert(staticData || dynamicData);
479 return (T*)data;
480 }
481
482 /** return the value of what is pointed to in the packet. */
483 template <typename T>
484 T get();
485
486 /** set the value in the data pointer to v. */
487 template <typename T>
488 void set(T v);
489
490 /**
491 * delete the data pointed to in the data pointer. Ok to call to
492 * matter how data was allocted.
493 */
494 void deleteData();
495
496 /** If there isn't data in the packet, allocate some. */
497 void allocate();
498
499 /** Do the packet modify the same addresses. */
500 bool intersect(PacketPtr p);
501};
502
503/** This function given a functional packet and a timing packet either satisfies
504 * the timing packet, or updates the timing packet to reflect the updated state
505 * in the timing packet. It returns if the functional packet should continue to
506 * traverse the memory hierarchy or not.
507 */
508bool fixPacket(PacketPtr func, PacketPtr timing);
509
510/** This function is a wrapper for the fixPacket field that toggles the hasData bit
511 * it is used when a response is waiting in the caches, but hasn't been marked as a
512 * response yet (so the fixPacket needs to get the correct value for the hasData)
513 */
514bool fixDelayedResponsePacket(PacketPtr func, PacketPtr timing);
515
516std::ostream & operator<<(std::ostream &o, const Packet &p);
517
518#endif //__MEM_PACKET_HH
| 373 }
374
375 /**
376 * Take a request packet that has been returned as NACKED and
377 * modify it so that it can be sent out again. Only packets that
378 * need a response can be NACKED, so verify that that is true.
379 */
380 void
381 reinitNacked()
382 {
383 assert(needsResponse() && result == Nacked);
384 dest = Broadcast;
385 result = Unknown;
386 }
387
388
389 /**
390 * Set the data pointer to the following value that should not be
391 * freed.
392 */
393 template <typename T>
394 void
395 dataStatic(T *p)
396 {
397 if(dynamicData)
398 dynamicData = false;
399 data = (PacketDataPtr)p;
400 staticData = true;
401 }
402
403 /**
404 * Set the data pointer to a value that should have delete []
405 * called on it.
406 */
407 template <typename T>
408 void
409 dataDynamicArray(T *p)
410 {
411 assert(!staticData && !dynamicData);
412 data = (PacketDataPtr)p;
413 dynamicData = true;
414 arrayData = true;
415 }
416
417 /**
418 * set the data pointer to a value that should have delete called
419 * on it.
420 */
421 template <typename T>
422 void
423 dataDynamic(T *p)
424 {
425 assert(!staticData && !dynamicData);
426 data = (PacketDataPtr)p;
427 dynamicData = true;
428 arrayData = false;
429 }
430
431 /** get a pointer to the data ptr. */
432 template <typename T>
433 T*
434 getPtr()
435 {
436 assert(staticData || dynamicData);
437 return (T*)data;
438 }
439
440 /** return the value of what is pointed to in the packet. */
441 template <typename T>
442 T get();
443
444 /** set the value in the data pointer to v. */
445 template <typename T>
446 void set(T v);
447
448 /**
449 * delete the data pointed to in the data pointer. Ok to call to
450 * matter how data was allocted.
451 */
452 void deleteData();
453
454 /** If there isn't data in the packet, allocate some. */
455 void allocate();
456
457 /** Do the packet modify the same addresses. */
458 bool intersect(PacketPtr p);
459};
460
461/** This function given a functional packet and a timing packet either satisfies
462 * the timing packet, or updates the timing packet to reflect the updated state
463 * in the timing packet. It returns if the functional packet should continue to
464 * traverse the memory hierarchy or not.
465 */
466bool fixPacket(PacketPtr func, PacketPtr timing);
467
468/** This function is a wrapper for the fixPacket field that toggles the hasData bit
469 * it is used when a response is waiting in the caches, but hasn't been marked as a
470 * response yet (so the fixPacket needs to get the correct value for the hasData)
471 */
472bool fixDelayedResponsePacket(PacketPtr func, PacketPtr timing);
473
474std::ostream & operator<<(std::ostream &o, const Packet &p);
475
476#endif //__MEM_PACKET_HH
|