addr_range_map.hh revision 12776:410b60d8a397 
1/*
2 * Copyright (c) 2012, 2018 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 * Copyright (c) 2006 The Regents of The University of Michigan
15 * All rights reserved.
16 *
17 * Redistribution and use in source and binary forms, with or without
18 * modification, are permitted provided that the following conditions are
19 * met: redistributions of source code must retain the above copyright
20 * notice, this list of conditions and the following disclaimer;
21 * redistributions in binary form must reproduce the above copyright
22 * notice, this list of conditions and the following disclaimer in the
23 * documentation and/or other materials provided with the distribution;
24 * neither the name of the copyright holders nor the names of its
25 * contributors may be used to endorse or promote products derived from
26 * this software without specific prior written permission.
27 *
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 *
40 * Authors: Ali Saidi
41 *          Andreas Hansson
42 */
43
44#ifndef __BASE_ADDR_RANGE_MAP_HH__
45#define __BASE_ADDR_RANGE_MAP_HH__
46
47#include <map>
48#include <utility>
49
50#include "base/addr_range.hh"
51
52/**
53 * The AddrRangeMap uses an STL map to implement an interval tree for
54 * address decoding. The value stored is a template type and can be
55 * e.g. a port identifier, or a pointer.
56 */
57template <typename V>
58class AddrRangeMap
59{
60  private:
61    typedef std::map<AddrRange, V> RangeMap;
62
63  public:
64    typedef typename RangeMap::iterator iterator;
65    typedef typename RangeMap::const_iterator const_iterator;
66
67    /**
68     * Find entry that contains the given address range
69     *
70     * Searches through the ranges in the address map and returns an
71     * iterator to the entry which range is a superset of the input
72     * address range. Returns end() if none found.
73     *
74     * @param r An input address range
75     * @return An iterator that contains the input address range
76     */
77    const_iterator
78    contains(const AddrRange &r) const
79    {
80        return find(r, [r](const AddrRange r1) { return r.isSubset(r1); });
81    }
82
83    /**
84     * Find entry that contains the given address
85     *
86     * Searches through the ranges in the address map and returns an
87     * iterator to the entry which range is a superset of the input
88     * address. Returns end() if none found.
89     *
90     * @param r An input address
91     * @return An iterator that contains the input address
92     */
93    const_iterator
94    contains(Addr r) const
95    {
96        return contains(RangeSize(r, 1));
97    }
98
99    /**
100     * Find entry that intersects with the given address range
101     *
102     * Searches through the ranges in the address map and returns an
103     * iterator to the first entry which range intersects with the
104     * input address.
105     *
106     * @param r An input address
107     * @return An iterator that intersects with the input address range
108     */
109    const_iterator
110    intersects(const AddrRange &r) const
111    {
112        return find(r, [r](const AddrRange r1) { return r.intersects(r1); });
113    }
114
115    const_iterator
116    insert(const AddrRange &r, const V& d)
117    {
118        if (intersects(r) != end())
119            return tree.end();
120
121        return tree.insert(std::make_pair(r, d)).first;
122    }
123
124    void
125    erase(iterator p)
126    {
127        tree.erase(p);
128    }
129
130    void
131    erase(iterator p, iterator q)
132    {
133        tree.erase(p,q);
134    }
135
136    void
137    clear()
138    {
139        tree.erase(tree.begin(), tree.end());
140    }
141
142    const_iterator
143    begin() const
144    {
145        return tree.begin();
146    }
147
148    iterator
149    begin()
150    {
151        return tree.begin();
152    }
153
154    const_iterator
155    end() const
156    {
157        return tree.end();
158    }
159
160    iterator
161    end()
162    {
163        return tree.end();
164    }
165
166    std::size_t
167    size() const
168    {
169        return tree.size();
170    }
171
172    bool
173    empty() const
174    {
175        return tree.empty();
176    }
177
178  private:
179    /**
180     * Find entry that satisfies a condition on an address range
181     *
182     * Searches through the ranges in the address map and returns an
183     * iterator to the entry that satisfies the input conidition on
184     * the input address range. Returns end() if none found.
185     *
186     * @param r An input address range
187     * @param f A condition on an address range
188     * @return An iterator that contains the input address range
189     */
190    const_iterator
191    find(const AddrRange &r, std::function<bool(const AddrRange)> cond) const
192    {
193        const_iterator next = tree.upper_bound(r);
194        if (next != end() && cond(next->first)) {
195            return next;
196        }
197        if (next == begin())
198            return end();
199        next--;
200
201        const_iterator i;
202        do {
203            i = next;
204            if (cond(i->first)) {
205                return i;
206            }
207            // Keep looking if the next range merges with the current one.
208        } while (next != begin() &&
209                 (--next)->first.mergesWith(i->first));
210
211        return end();
212    }
213
214    RangeMap tree;
215};
216
217#endif //__BASE_ADDR_RANGE_MAP_HH__
218