2 * Copyright (c) 2012 ARM Limited
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.
14 * Redistribution and use in source and binary forms, with or without
15 * modification, are permitted provided that the following conditions are
16 * met: redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer;
18 * redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution;
21 * neither the name of the copyright holders nor the names of its
22 * contributors may be used to endorse or promote products derived from
23 * this software without specific prior written permission.
25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
29 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
30 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
31 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
35 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 * Authors: Andreas Hansson
40 #include "mem/addr_mapper.hh"
42 AddrMapper::AddrMapper(const AddrMapperParams
* p
)
44 masterPort(name() + "-master", *this),
45 slavePort(name() + "-slave", *this)
52 if (!slavePort
.isConnected() || !masterPort
.isConnected())
53 fatal("Address mapper is not connected on both sides.\n");
57 AddrMapper::getMasterPort(const std::string
& if_name
, PortID idx
)
59 if (if_name
== "master") {
62 return MemObject::getMasterPort(if_name
, idx
);
67 AddrMapper::getSlavePort(const std::string
& if_name
, PortID idx
)
69 if (if_name
== "slave") {
72 return MemObject::getSlavePort(if_name
, idx
);
77 AddrMapper::recvFunctional(PacketPtr pkt
)
79 Addr orig_addr
= pkt
->getAddr();
80 pkt
->setAddr(remapAddr(orig_addr
));
81 masterPort
.sendFunctional(pkt
);
82 pkt
->setAddr(orig_addr
);
86 AddrMapper::recvFunctionalSnoop(PacketPtr pkt
)
88 Addr orig_addr
= pkt
->getAddr();
89 pkt
->setAddr(remapAddr(orig_addr
));
90 slavePort
.sendFunctionalSnoop(pkt
);
91 pkt
->setAddr(orig_addr
);
95 AddrMapper::recvAtomic(PacketPtr pkt
)
97 Addr orig_addr
= pkt
->getAddr();
98 pkt
->setAddr(remapAddr(orig_addr
));
99 Tick ret_tick
= masterPort
.sendAtomic(pkt
);
100 pkt
->setAddr(orig_addr
);
105 AddrMapper::recvAtomicSnoop(PacketPtr pkt
)
107 Addr orig_addr
= pkt
->getAddr();
108 pkt
->setAddr(remapAddr(orig_addr
));
109 Tick ret_tick
= slavePort
.sendAtomicSnoop(pkt
);
110 pkt
->setAddr(orig_addr
);
115 AddrMapper::recvTimingReq(PacketPtr pkt
)
117 Addr orig_addr
= pkt
->getAddr();
118 bool needsResponse
= pkt
->needsResponse();
119 bool cacheResponding
= pkt
->cacheResponding();
121 if (needsResponse
&& !cacheResponding
) {
122 pkt
->pushSenderState(new AddrMapperSenderState(orig_addr
));
125 pkt
->setAddr(remapAddr(orig_addr
));
127 // Attempt to send the packet
128 bool successful
= masterPort
.sendTimingReq(pkt
);
130 // If not successful, restore the address and sender state
132 pkt
->setAddr(orig_addr
);
135 delete pkt
->popSenderState();
143 AddrMapper::recvTimingResp(PacketPtr pkt
)
145 AddrMapperSenderState
* receivedState
=
146 dynamic_cast<AddrMapperSenderState
*>(pkt
->senderState
);
148 // Restore initial sender state
149 if (receivedState
== NULL
)
150 panic("AddrMapper %s got a response without sender state\n",
153 Addr remapped_addr
= pkt
->getAddr();
155 // Restore the state and address
156 pkt
->senderState
= receivedState
->predecessor
;
157 pkt
->setAddr(receivedState
->origAddr
);
159 // Attempt to send the packet
160 bool successful
= slavePort
.sendTimingResp(pkt
);
162 // If packet successfully sent, delete the sender state, otherwise
165 delete receivedState
;
167 // Don't delete anything and let the packet look like we did
169 pkt
->senderState
= receivedState
;
170 pkt
->setAddr(remapped_addr
);
176 AddrMapper::recvTimingSnoopReq(PacketPtr pkt
)
178 slavePort
.sendTimingSnoopReq(pkt
);
182 AddrMapper::recvTimingSnoopResp(PacketPtr pkt
)
184 return masterPort
.sendTimingSnoopResp(pkt
);
188 AddrMapper::isSnooping() const
190 if (slavePort
.isSnooping())
191 fatal("AddrMapper doesn't support remapping of snooping requests\n");
196 AddrMapper::recvReqRetry()
198 slavePort
.sendRetryReq();
202 AddrMapper::recvRespRetry()
204 masterPort
.sendRetryResp();
208 AddrMapper::recvRangeChange()
210 slavePort
.sendRangeChange();
213 RangeAddrMapper::RangeAddrMapper(const RangeAddrMapperParams
* p
) :
215 originalRanges(p
->original_ranges
),
216 remappedRanges(p
->remapped_ranges
)
218 if (originalRanges
.size() != remappedRanges
.size())
219 fatal("AddrMapper: original and shadowed range list must "
222 for (size_t x
= 0; x
< originalRanges
.size(); x
++) {
223 if (originalRanges
[x
].size() != remappedRanges
[x
].size())
224 fatal("AddrMapper: original and shadowed range list elements"
225 " aren't all of the same size\n");
230 RangeAddrMapperParams::create()
232 return new RangeAddrMapper(this);
236 RangeAddrMapper::remapAddr(Addr addr
) const
238 for (int i
= 0; i
< originalRanges
.size(); ++i
) {
239 if (originalRanges
[i
].contains(addr
)) {
240 Addr offset
= addr
- originalRanges
[i
].start();
241 return offset
+ remappedRanges
[i
].start();
249 RangeAddrMapper::getAddrRanges() const
251 // Simply return the original ranges as given by the parameters
252 AddrRangeList
ranges(originalRanges
.begin(), originalRanges
.end());