1/*
2 * Copyright (c) 2006 The Regents of The University of Michigan
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met: redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer;
9 * redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution;
12 * neither the name of the copyright holders nor the names of its
13 * contributors may be used to endorse or promote products derived from
14 * this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 *
28 * Authors: Ali Saidi
29 * Steve Reinhardt
30 */
31
32/**
33 * @file
34 * Definition of the Packet Class, a packet is a transaction occuring
35 * between a single level of the memory heirarchy (ie L1->L2).
36 */
37#include "base/misc.hh"
38#include "mem/packet.hh"
39
40static const std::string ReadReqString("ReadReq");
41static const std::string WriteReqString("WriteReq");
42static const std::string WriteReqNoAckString("WriteReqNoAck|Writeback");
43static const std::string ReadRespString("ReadResp");
44static const std::string WriteRespString("WriteResp");
45static const std::string SoftPFReqString("SoftPFReq");
46static const std::string SoftPFRespString("SoftPFResp");
47static const std::string HardPFReqString("HardPFReq");
48static const std::string HardPFRespString("HardPFResp");
49static const std::string InvalidateReqString("InvalidateReq");
50static const std::string WriteInvalidateReqString("WriteInvalidateReq");
51static const std::string UpgradeReqString("UpgradeReq");
52static const std::string ReadExReqString("ReadExReq");
53static const std::string ReadExRespString("ReadExResp");
54static const std::string OtherCmdString("<other>");
55
56const std::string &
57Packet::cmdString() const
58{
59 switch (cmd) {
60 case ReadReq: return ReadReqString;
61 case WriteReq: return WriteReqString;
62 case WriteReqNoAck: return WriteReqNoAckString;
63 case ReadResp: return ReadRespString;
64 case WriteResp: return WriteRespString;
65 case SoftPFReq: return SoftPFReqString;
66 case SoftPFResp: return SoftPFRespString;
67 case HardPFReq: return HardPFReqString;
68 case HardPFResp: return HardPFRespString;
69 case InvalidateReq: return InvalidateReqString;
70 case WriteInvalidateReq:return WriteInvalidateReqString;
71 case UpgradeReq: return UpgradeReqString;
72 case ReadExReq: return ReadExReqString;
73 case ReadExResp: return ReadExRespString;
74 default: return OtherCmdString;
75 }
76}
77
78const std::string &
79Packet::cmdIdxToString(Packet::Command idx)
80{
81 switch (idx) {
82 case ReadReq: return ReadReqString;
83 case WriteReq: return WriteReqString;
84 case WriteReqNoAck: return WriteReqNoAckString;
85 case ReadResp: return ReadRespString;
86 case WriteResp: return WriteRespString;
87 case SoftPFReq: return SoftPFReqString;
88 case SoftPFResp: return SoftPFRespString;
89 case HardPFReq: return HardPFReqString;
90 case HardPFResp: return HardPFRespString;
91 case InvalidateReq: return InvalidateReqString;
92 case WriteInvalidateReq:return WriteInvalidateReqString;
93 case UpgradeReq: return UpgradeReqString;
94 case ReadExReq: return ReadExReqString;
95 case ReadExResp: return ReadExRespString;
96 default: return OtherCmdString;
97 }
98}
99
100/** delete the data pointed to in the data pointer. Ok to call to matter how
101 * data was allocted. */
102void
103Packet::deleteData()
104{
105 assert(staticData || dynamicData);
106 if (staticData)
107 return;
108
109 if (arrayData)
110 delete [] data;
111 else
112 delete data;
113}
114
115/** If there isn't data in the packet, allocate some. */
116void
117Packet::allocate()
118{
119 if (data)
120 return;
121 assert(!staticData);
122 dynamicData = true;
123 arrayData = true;
124 data = new uint8_t[getSize()];
125}
126
127/** Do the packet modify the same addresses. */
128bool
129Packet::intersect(Packet *p)
130{
131 Addr s1 = getAddr();
132 Addr e1 = getAddr() + getSize() - 1;
133 Addr s2 = p->getAddr();
134 Addr e2 = p->getAddr() + p->getSize() - 1;
135
136 return !(s1 > e2 || e1 < s2);
137}
138
139bool
140fixPacket(Packet *func, Packet *timing)
141{
142 panic("Need to implement!");
143}