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
45#include "base/compiler.hh"
46#include "base/misc.hh"
47#include "mem/request.hh"
48#include "sim/host.hh"
49#include "sim/core.hh"
50
51
52struct Packet;
53typedef Packet *PacketPtr;
54typedef uint8_t* PacketDataPtr;
55typedef std::list<PacketPtr> PacketList;
56
57class MemCmd
58{
59 public:
60
61 /** List of all commands associated with a packet. */
62 enum Command
63 {
64 InvalidCmd,
65 ReadReq,
66 ReadResp,
67 WriteReq,
68 WriteResp,
69 Writeback,
70 WritebackAck,
71 SoftPFReq,
72 HardPFReq,
73 SoftPFResp,
74 HardPFResp,
75 WriteInvalidateReq,
76 WriteInvalidateResp,
77 UpgradeReq,
78 ReadExReq,
79 ReadExResp,
80 LoadLockedReq,
81 LoadLockedResp,
82 StoreCondReq,
83 StoreCondResp,
84 SwapReq,
85 SwapResp,
86 NUM_MEM_CMDS
87 };
88
89 private:
90 /** List of command attributes. */
91 enum Attribute
92 {
93 IsRead, //!< Data flows from responder to requester
94 IsWrite, //!< Data flows from requester to responder
95 IsPrefetch, //!< Not a demand access
96 IsInvalidate,
97 NeedsExclusive, //!< Requires exclusive copy to complete in-cache
98 IsRequest, //!< Issued by requester
99 IsResponse, //!< Issue by responder
100 NeedsResponse, //!< Requester needs response from target
101 IsSWPrefetch,
102 IsHWPrefetch,
103 IsUpgrade,
104 IsLocked, //!< Alpha/MIPS LL or SC access
105 HasData, //!< There is an associated payload
106 NUM_COMMAND_ATTRIBUTES
107 };
108
109 /** Structure that defines attributes and other data associated
110 * with a Command. */
111 struct CommandInfo {
112 /** Set of attribute flags. */
113 const std::bitset<NUM_COMMAND_ATTRIBUTES> attributes;
114 /** Corresponding response for requests; InvalidCmd if no
115 * response is applicable. */
116 const Command response;
117 /** String representation (for printing) */
118 const std::string str;
119 };
120
121 /** Array to map Command enum to associated info. */
122 static const CommandInfo commandInfo[];
123
124 private:
125
126 Command cmd;
127
128 bool testCmdAttrib(MemCmd::Attribute attrib) const {
129 return commandInfo[cmd].attributes[attrib] != 0;
130 }
131
132 public:
133
134 bool isRead() const { return testCmdAttrib(IsRead); }
135 bool isWrite() const { return testCmdAttrib(IsWrite); }
136 bool isRequest() const { return testCmdAttrib(IsRequest); }
137 bool isResponse() const { return testCmdAttrib(IsResponse); }
138 bool needsExclusive() const { return testCmdAttrib(NeedsExclusive); }
139 bool needsResponse() const { return testCmdAttrib(NeedsResponse); }
140 bool isInvalidate() const { return testCmdAttrib(IsInvalidate); }
141 bool hasData() const { return testCmdAttrib(HasData); }
142 bool isReadWrite() const { return isRead() && isWrite(); }
143 bool isLocked() const { return testCmdAttrib(IsLocked); }
144
145 const Command responseCommand() const {
146 return commandInfo[cmd].response;
147 }
148
149 /** Return the string to a cmd given by idx. */
150 const std::string &toString() const {
151 return commandInfo[cmd].str;
152 }
153
154 int toInt() const { return (int)cmd; }
155
156 MemCmd(Command _cmd)
157 : cmd(_cmd)
158 { }
159
160 MemCmd(int _cmd)
161 : cmd((Command)_cmd)
162 { }
163
164 MemCmd()
165 : cmd(InvalidCmd)
166 { }
167
168 bool operator==(MemCmd c2) { return (cmd == c2.cmd); }
169 bool operator!=(MemCmd c2) { return (cmd != c2.cmd); }
170
171 friend class Packet;
172};
173
174/**
175 * A Packet is used to encapsulate a transfer between two objects in
176 * the memory system (e.g., the L1 and L2 cache). (In contrast, a
177 * single Request travels all the way from the requester to the
178 * ultimate destination and back, possibly being conveyed by several
179 * different Packets along the way.)
180 */
181class Packet
182{
183 public:
184
185 typedef MemCmd::Command Command;
186
187 private:
188 /** A pointer to the data being transfered. It can be differnt
189 * sizes at each level of the heirarchy so it belongs in the
190 * packet, not request. This may or may not be populated when a
191 * responder recieves the packet. If not populated it memory
192 * should be allocated.
193 */
194 PacketDataPtr data;
195
196 /** Is the data pointer set to a value that shouldn't be freed
197 * when the packet is destroyed? */
198 bool staticData;
199 /** The data pointer points to a value that should be freed when
200 * the packet is destroyed. */
201 bool dynamicData;
202 /** the data pointer points to an array (thus delete [] ) needs to
203 * be called on it rather than simply delete.*/
204 bool arrayData;
205
206 /** The address of the request. This address could be virtual or
207 * physical, depending on the system configuration. */
208 Addr addr;
209
210 /** The size of the request or transfer. */
211 int size;
212
213 /** Device address (e.g., bus ID) of the source of the
214 * transaction. The source is not responsible for setting this
215 * field; it is set implicitly by the interconnect when the
216 * packet is first sent. */
217 short src;
218
219 /** Device address (e.g., bus ID) of the destination of the
220 * transaction. The special value Broadcast indicates that the
221 * packet should be routed based on its address. This field is
222 * initialized in the constructor and is thus always valid
223 * (unlike * addr, size, and src). */
224 short dest;
225
226 /** Are the 'addr' and 'size' fields valid? */
227 bool addrSizeValid;
228 /** Is the 'src' field valid? */
229 bool srcValid;
230
231 enum SnoopFlag {
232 MemInhibit,
233 Shared,
234 NUM_SNOOP_FLAGS
235 };
236
237 /** Coherence snoopFlags for snooping */
238 std::bitset<NUM_SNOOP_FLAGS> snoopFlags;
239
240 public:
241
242 /** Used to calculate latencies for each packet.*/
243 Tick time;
244
245 /** The time at which the packet will be fully transmitted */
246 Tick finishTime;
247
248 /** The time at which the first chunk of the packet will be transmitted */
249 Tick firstWordTime;
250
251 /** The special destination address indicating that the packet
252 * should be routed based on its address. */
253 static const short Broadcast = -1;
254
255 /** A pointer to the original request. */
256 RequestPtr req;
257
258 /** A virtual base opaque structure used to hold coherence-related
259 * state. A specific subclass would be derived from this to
260 * carry state specific to a particular coherence protocol. */
261 class CoherenceState {
262 public:
263 virtual ~CoherenceState() {}
264 };
265
266 /** This packet's coherence state. Caches should use
267 * dynamic_cast<> to cast to the state appropriate for the
268 * system's coherence protocol. */
269 CoherenceState *coherence;
270
271 /** A virtual base opaque structure used to hold state associated
272 * with the packet but specific to the sending device (e.g., an
273 * MSHR). A pointer to this state is returned in the packet's
274 * response so that the sender can quickly look up the state
275 * needed to process it. A specific subclass would be derived
276 * from this to carry state specific to a particular sending
277 * device. */
278 class SenderState {
279 public:
280 virtual ~SenderState() {}
281 };
282
283 /** This packet's sender state. Devices should use dynamic_cast<>
284 * to cast to the state appropriate to the sender. */
285 SenderState *senderState;
286
287 public:
288
289 /** The command field of the packet. */
290 MemCmd cmd;
291
292 /** Return the string name of the cmd field (for debugging and
293 * tracing). */
294 const std::string &cmdString() const { return cmd.toString(); }
295
296 /** Return the index of this command. */
297 inline int cmdToIndex() const { return cmd.toInt(); }
298
299 public:
300
301 bool isRead() const { return cmd.isRead(); }
302 bool isWrite() const { return cmd.isWrite(); }
303 bool isRequest() const { return cmd.isRequest(); }
304 bool isResponse() const { return cmd.isResponse(); }
305 bool needsExclusive() const { return cmd.needsExclusive(); }
306 bool needsResponse() const { return cmd.needsResponse(); }
307 bool isInvalidate() const { return cmd.isInvalidate(); }
308 bool hasData() const { return cmd.hasData(); }
309 bool isReadWrite() const { return cmd.isReadWrite(); }
310 bool isLocked() const { return cmd.isLocked(); }
311
312 void assertMemInhibit() { snoopFlags[MemInhibit] = true; }
313 void assertShared() { snoopFlags[Shared] = true; }
314 bool memInhibitAsserted() { return snoopFlags[MemInhibit]; }
315 bool sharedAsserted() { return snoopFlags[Shared]; }
316
317 bool nic_pkt() { panic("Unimplemented"); M5_DUMMY_RETURN }
318
319 /** Possible results of a packet's request. */
320 enum Result
321 {
322 Success,
323 BadAddress,
324 Nacked,
325 Unknown
326 };
327
328 /** The result of this packet's request. */
329 Result result;
330
331 /** Accessor function that returns the source index of the packet. */
332 short getSrc() const { assert(srcValid); return src; }
333 void setSrc(short _src) { src = _src; srcValid = true; }
334 /** Reset source field, e.g. to retransmit packet on different bus. */
335 void clearSrc() { srcValid = false; }
336
337 /** Accessor function that returns the destination index of
338 the packet. */
339 short getDest() const { return dest; }
340 void setDest(short _dest) { dest = _dest; }
341
342 Addr getAddr() const { assert(addrSizeValid); return addr; }
343 int getSize() const { assert(addrSizeValid); return size; }
344 Addr getOffset(int blkSize) const { return addr & (Addr)(blkSize - 1); }
345
346 void addrOverride(Addr newAddr) { assert(addrSizeValid); addr = newAddr; }
347 void cmdOverride(MemCmd newCmd) { cmd = newCmd; }
348
349 /** Constructor. Note that a Request object must be constructed
350 * first, but the Requests's physical address and size fields
351 * need not be valid. The command and destination addresses
352 * must be supplied. */
353 Packet(Request *_req, MemCmd _cmd, short _dest)
354 : data(NULL), staticData(false), dynamicData(false), arrayData(false),
355 addr(_req->paddr), size(_req->size), dest(_dest),
356 addrSizeValid(_req->validPaddr), srcValid(false),
357 snoopFlags(0),
358 time(curTick),
359 req(_req), coherence(NULL), senderState(NULL), cmd(_cmd),
360 result(Unknown)
361 {
362 }
363
364 /** Alternate constructor if you are trying to create a packet with
365 * a request that is for a whole block, not the address from the req.
366 * this allows for overriding the size/addr of the req.*/
367 Packet(Request *_req, MemCmd _cmd, short _dest, int _blkSize)
368 : data(NULL), staticData(false), dynamicData(false), arrayData(false),
369 addr(_req->paddr & ~(_blkSize - 1)), size(_blkSize), dest(_dest),
370 addrSizeValid(_req->validPaddr), srcValid(false),
371 snoopFlags(0),
372 time(curTick),
373 req(_req), coherence(NULL), senderState(NULL), cmd(_cmd),
374 result(Unknown)
375 {
376 }
377
378 /** Alternate constructor for copying a packet. Copy all fields
379 * *except* set data allocation as static... even if the original
380 * packet's data was dynamic, we don't want to free it when the
381 * new packet is deallocated. Note that if original packet used
382 * dynamic data, user must guarantee that the new packet's
383 * lifetime is less than that of the original packet. */
384 Packet(Packet *origPkt)
385 : data(NULL), staticData(false), dynamicData(false), arrayData(false),
386 addr(origPkt->addr), size(origPkt->size),
387 dest(origPkt->dest),
388 addrSizeValid(origPkt->addrSizeValid), srcValid(origPkt->srcValid),
389 snoopFlags(origPkt->snoopFlags),
390 time(curTick),
391 req(origPkt->req), coherence(origPkt->coherence),
392 senderState(origPkt->senderState), cmd(origPkt->cmd),
393 result(origPkt->result)
394 {
395 }
396
397 /** Destructor. */
398 ~Packet()
399 { if (staticData || dynamicData) deleteData(); }
400
401 /** Reinitialize packet address and size from the associated
402 * Request object, and reset other fields that may have been
403 * modified by a previous transaction. Typically called when a
404 * statically allocated Request/Packet pair is reused for
405 * multiple transactions. */
406 void reinitFromRequest() {
407 assert(req->validPaddr);
408 snoopFlags = 0;
409 addr = req->paddr;
410 size = req->size;
411 time = req->time;
412 addrSizeValid = true;
413 result = Unknown;
414 if (dynamicData) {
415 deleteData();
416 dynamicData = false;
417 arrayData = false;
418 }
419 }
420
421 /**
422 * Take a request packet and modify it in place to be suitable for
423 * returning as a response to that request. The source and
424 * destination fields are *not* modified, as is appropriate for
425 * atomic accesses.
426 */
427 void makeAtomicResponse()
428 {
429 assert(needsResponse());
430 assert(isRequest());
431 assert(result == Unknown);
432 cmd = cmd.responseCommand();
433 result = Success;
434 }
435
436 /**
437 * Perform the additional work required for timing responses above
438 * and beyond atomic responses; i.e., change the destination to
439 * point back to the requester and clear the source field.
440 */
441 void convertAtomicToTimingResponse()
442 {
443 dest = src;
444 srcValid = false;
445 }
446
447 /**
448 * Take a request packet and modify it in place to be suitable for
449 * returning as a response to a timing request.
450 */
451 void makeTimingResponse()
452 {
453 makeAtomicResponse();
454 convertAtomicToTimingResponse();
455 }
456
457 /**
458 * Take a request packet that has been returned as NACKED and
459 * modify it so that it can be sent out again. Only packets that
460 * need a response can be NACKED, so verify that that is true.
461 */
462 void
463 reinitNacked()
464 {
465 assert(needsResponse() && result == Nacked);
466 dest = Broadcast;
467 result = Unknown;
468 }
469
470
471 /**
472 * Set the data pointer to the following value that should not be
473 * freed.
474 */
475 template <typename T>
476 void
477 dataStatic(T *p)
478 {
479 if(dynamicData)
480 dynamicData = false;
481 data = (PacketDataPtr)p;
482 staticData = true;
483 }
484
485 /**
486 * Set the data pointer to a value that should have delete []
487 * called on it.
488 */
489 template <typename T>
490 void
491 dataDynamicArray(T *p)
492 {
493 assert(!staticData && !dynamicData);
494 data = (PacketDataPtr)p;
495 dynamicData = true;
496 arrayData = true;
497 }
498
499 /**
500 * set the data pointer to a value that should have delete called
501 * on it.
502 */
503 template <typename T>
504 void
505 dataDynamic(T *p)
506 {
507 assert(!staticData && !dynamicData);
508 data = (PacketDataPtr)p;
509 dynamicData = true;
510 arrayData = false;
511 }
512
513 /** get a pointer to the data ptr. */
514 template <typename T>
515 T*
516 getPtr()
517 {
518 assert(staticData || dynamicData);
519 return (T*)data;
520 }
521
522 /** return the value of what is pointed to in the packet. */
523 template <typename T>
524 T get();
525
526 /** set the value in the data pointer to v. */
527 template <typename T>
528 void set(T v);
529
530 /**
531 * Copy data into the packet from the provided pointer.
532 */
533 void setData(uint8_t *p)
534 {
535 std::memcpy(getPtr<uint8_t>(), p, getSize());
536 }
537
538 /**
539 * Copy data into the packet from the provided block pointer,
540 * which is aligned to the given block size.
541 */
542 void setDataFromBlock(uint8_t *blk_data, int blkSize)
543 {
544 setData(blk_data + getOffset(blkSize));
545 }
546
547 /**
548 * Copy data from the packet to the provided block pointer, which
549 * is aligned to the given block size.
550 */
551 void writeData(uint8_t *p)
552 {
553 std::memcpy(p, getPtr<uint8_t>(), getSize());
554 }
555
556 /**
557 * Copy data from the packet to the memory at the provided pointer.
558 */
559 void writeDataToBlock(uint8_t *blk_data, int blkSize)
560 {
561 writeData(blk_data + getOffset(blkSize));
562 }
563
564 /**
565 * delete the data pointed to in the data pointer. Ok to call to
566 * matter how data was allocted.
567 */
568 void deleteData();
569
570 /** If there isn't data in the packet, allocate some. */
571 void allocate();
572
573 /** Do the packet modify the same addresses. */
574 bool intersect(PacketPtr p);
575
576 /**
577 * Check a functional request against a memory value represented
578 * by a base/size pair and an associated data array. If the
579 * functional request is a read, it may be satisfied by the memory
580 * value. If the functional request is a write, it may update the
581 * memory value.
582 */
583 bool checkFunctional(Addr base, int size, uint8_t *data);
584
585 /**
586 * Check a functional request against a memory value stored in
587 * another packet (i.e. an in-transit request or response).
588 */
589 bool checkFunctional(PacketPtr otherPkt) {
590 return (otherPkt->hasData() &&
591 checkFunctional(otherPkt->getAddr(), otherPkt->getSize(),
592 otherPkt->getPtr<uint8_t>()));
593 }
594};
595
596
597
598/** Temporary for backwards compatibility.
599 */
600inline
601bool fixPacket(PacketPtr func, PacketPtr timing) {
602 return !func->checkFunctional(timing);
603}
604
605/** This function is a wrapper for the fixPacket field that toggles
606 * the hasData bit it is used when a response is waiting in the
607 * caches, but hasn't been marked as a response yet (so the fixPacket
608 * needs to get the correct value for the hasData)
609 */
610bool fixDelayedResponsePacket(PacketPtr func, PacketPtr timing);
611
612std::ostream & operator<<(std::ostream &o, const Packet &p);
613
614#endif //__MEM_PACKET_HH