addr_mapper.hh revision 9294:8fb03b13de02 
1/*
2 * Copyright (c) 2012 ARM Limited
3 * All rights reserved
4 *
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.
13 *
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.
24 *
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.
36 *
37 * Authors: Andreas Hansson
38 */
39
40#ifndef __MEM_ADDR_MAPPER_HH__
41#define __MEM_ADDR_MAPPER_HH__
42
43#include "mem/mem_object.hh"
44#include "params/AddrMapper.hh"
45#include "params/RangeAddrMapper.hh"
46
47/**
48 * An address mapper changes the packet addresses in going from the
49 * slave port side of the mapper to the master port side. When the
50 * slave port is queried for the address ranges, it also performs the
51 * necessary range updates. Note that snoop requests that travel from
52 * the master port (i.e. the memory side) to the slave port are
53 * currently not modified.
54 */
55
56class AddrMapper : public MemObject
57{
58
59  public:
60
61    AddrMapper(const AddrMapperParams* params);
62
63    virtual ~AddrMapper() { }
64
65    virtual BaseMasterPort& getMasterPort(const std::string& if_name,
66                                          PortID idx = InvalidPortID);
67
68    virtual BaseSlavePort& getSlavePort(const std::string& if_name,
69                                        PortID idx = InvalidPortID);
70
71    virtual void init();
72
73  protected:
74
75    /**
76     * This function does the actual remapping of one address to another.
77     * It is pure virtual in this case to to allow any implementation
78     * required.
79     * @param addr the address to remap
80     * @return the new address (can be unchanged)
81     */
82    virtual Addr remapAddr(Addr addr) const = 0;
83
84    class AddrMapperSenderState : public Packet::SenderState
85    {
86
87      public:
88
89        /**
90         * Construct a new sender state and remember the original one
91         * so that we can implement a stack.
92         *
93         * @param _origSenderState Sender state to remember
94         * @param _origAddr Address before remapping
95         */
96        AddrMapperSenderState(SenderState* _origSenderState,
97                              Addr _origAddr)
98            : origSenderState(_origSenderState), origAddr(_origAddr)
99        { }
100
101        /** Destructor */
102        ~AddrMapperSenderState() { }
103
104        /** Pointer to old sender state of packet */
105        SenderState* origSenderState;
106
107        /** The original address the packet was destined for */
108        Addr origAddr;
109
110    };
111
112    class MapperMasterPort : public MasterPort
113    {
114
115      public:
116
117        MapperMasterPort(const std::string& _name, AddrMapper& _mapper)
118            : MasterPort(_name, &_mapper), mapper(_mapper)
119        { }
120
121      protected:
122
123        void recvFunctionalSnoop(PacketPtr pkt)
124        {
125            mapper.recvFunctionalSnoop(pkt);
126        }
127
128        Tick recvAtomicSnoop(PacketPtr pkt)
129        {
130            return mapper.recvAtomicSnoop(pkt);
131        }
132
133        bool recvTimingResp(PacketPtr pkt)
134        {
135            return mapper.recvTimingResp(pkt);
136        }
137
138        void recvTimingSnoopReq(PacketPtr pkt)
139        {
140            mapper.recvTimingSnoopReq(pkt);
141        }
142
143        void recvRangeChange()
144        {
145            mapper.recvRangeChange();
146        }
147
148        bool isSnooping() const
149        {
150            return mapper.isSnooping();
151        }
152
153        unsigned deviceBlockSize() const
154        {
155            return mapper.deviceBlockSizeMaster();
156        }
157
158        void recvRetry()
159        {
160            mapper.recvRetryMaster();
161        }
162
163      private:
164
165        AddrMapper& mapper;
166
167    };
168
169    /** Instance of master port, facing the memory side */
170    MapperMasterPort masterPort;
171
172    class MapperSlavePort : public SlavePort
173    {
174
175      public:
176
177        MapperSlavePort(const std::string& _name, AddrMapper& _mapper)
178            : SlavePort(_name, &_mapper), mapper(_mapper)
179        { }
180
181      protected:
182
183        void recvFunctional(PacketPtr pkt)
184        {
185            mapper.recvFunctional(pkt);
186        }
187
188        Tick recvAtomic(PacketPtr pkt)
189        {
190            return mapper.recvAtomic(pkt);
191        }
192
193        bool recvTimingReq(PacketPtr pkt)
194        {
195            return mapper.recvTimingReq(pkt);
196        }
197
198        bool recvTimingSnoopResp(PacketPtr pkt)
199        {
200            return mapper.recvTimingSnoopResp(pkt);
201        }
202
203        unsigned deviceBlockSize() const
204        {
205            return mapper.deviceBlockSizeSlave();
206        }
207
208        AddrRangeList getAddrRanges() const
209        {
210            return mapper.getAddrRanges();
211        }
212
213        void recvRetry()
214        {
215            mapper.recvRetrySlave();
216        }
217
218      private:
219
220        AddrMapper& mapper;
221
222    };
223
224    /** Instance of slave port, i.e. on the CPU side */
225    MapperSlavePort slavePort;
226
227    void recvFunctional(PacketPtr pkt);
228
229    void recvFunctionalSnoop(PacketPtr pkt);
230
231    Tick recvAtomic(PacketPtr pkt);
232
233    Tick recvAtomicSnoop(PacketPtr pkt);
234
235    bool recvTimingReq(PacketPtr pkt);
236
237    bool recvTimingResp(PacketPtr pkt);
238
239    void recvTimingSnoopReq(PacketPtr pkt);
240
241    bool recvTimingSnoopResp(PacketPtr pkt);
242
243    unsigned deviceBlockSizeMaster();
244
245    unsigned deviceBlockSizeSlave();
246
247    virtual AddrRangeList getAddrRanges() const = 0;
248
249    bool isSnooping() const;
250
251    void recvRetryMaster();
252
253    void recvRetrySlave();
254
255    void recvRangeChange();
256};
257
258/**
259 * Range address mapper that maps a set of original ranges to a set of
260 * remapped ranges, where a specific range is of the same size
261 * (original and remapped), only with an offset. It's useful for cases
262 * where memory is mapped to two different locations
263 */
264class RangeAddrMapper : public AddrMapper
265{
266
267  public:
268
269    RangeAddrMapper(const RangeAddrMapperParams* p);
270
271    ~RangeAddrMapper() { }
272
273    AddrRangeList getAddrRanges() const;
274
275  protected:
276
277    /**
278     * This contains a list of ranges the should be remapped. It must
279     * be the exact same length as remappedRanges which describes what
280     * manipulation should be done to each range.
281     */
282    std::vector<AddrRange> originalRanges;
283
284    /**
285     * This contains a list of ranges that addresses should be
286     * remapped to. See the description for originalRanges above
287     */
288    std::vector<AddrRange> remappedRanges;
289
290    Addr remapAddr(Addr addr) const;
291
292};
293
294#endif //__MEM_ADDR_MAPPER_HH__
295