Merge ktlim@zizzer:/bk/m5
[gem5.git] / src / mem / packet.cc
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
29 /**
30 * @file
31 * Definition of the Packet Class, a packet is a transaction occuring
32 * between a single level of the memory heirarchy (ie L1->L2).
33 */
34 #include "base/misc.hh"
35 #include "mem/packet.hh"
36
37 static const std::string ReadReqString("ReadReq");
38 static const std::string WriteReqString("WriteReq");
39 static const std::string WriteReqNoAckString("WriteReqNoAck");
40 static const std::string ReadRespString("ReadResp");
41 static const std::string WriteRespString("WriteResp");
42 static const std::string OtherCmdString("<other>");
43
44 const std::string &
45 Packet::cmdString() const
46 {
47 switch (cmd) {
48 case ReadReq: return ReadReqString;
49 case WriteReq: return WriteReqString;
50 case WriteReqNoAck: return WriteReqNoAckString;
51 case ReadResp: return ReadRespString;
52 case WriteResp: return WriteRespString;
53 default: return OtherCmdString;
54 }
55 }
56
57 /** delete the data pointed to in the data pointer. Ok to call to matter how
58 * data was allocted. */
59 void
60 Packet::deleteData()
61 {
62 assert(staticData || dynamicData);
63 if (staticData)
64 return;
65
66 if (arrayData)
67 delete [] data;
68 else
69 delete data;
70 }
71
72 /** If there isn't data in the packet, allocate some. */
73 void
74 Packet::allocate()
75 {
76 if (data)
77 return;
78 assert(!staticData);
79 dynamicData = true;
80 arrayData = true;
81 data = new uint8_t[getSize()];
82 }
83
84 /** Do the packet modify the same addresses. */
85 bool
86 Packet::intersect(Packet *p)
87 {
88 Addr s1 = getAddr();
89 Addr e1 = getAddr() + getSize();
90 Addr s2 = p->getAddr();
91 Addr e2 = p->getAddr() + p->getSize();
92
93 if (s1 >= s2 && s1 < e2)
94 return true;
95 if (e1 >= s2 && e1 < e2)
96 return true;
97 return false;
98 }
99
100 /** Minimally reset a packet so something like simple cpu can reuse it. */
101 void
102 Packet::reset()
103 {
104 result = Unknown;
105 if (dynamicData) {
106 deleteData();
107 dynamicData = false;
108 arrayData = false;
109 time = curTick;
110 }
111 }
112
113
114 bool
115 fixPacket(Packet *func, Packet *timing)
116 {
117 panic("Need to implement!");
118 }