addr_range.hh revision 9334:0a12b040494a 
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 * Copyright (c) 2002-2005 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: Nathan Binkert
41 *          Steve Reinhardt
42 *          Andreas Hansson
43 */
44
45#ifndef __BASE_ADDR_RANGE_HH__
46#define __BASE_ADDR_RANGE_HH__
47
48#include <utility> // pair & make_pair
49
50#include "base/types.hh"
51
52class AddrRange
53{
54
55  public:
56
57    Addr start;
58    Addr end;
59
60    AddrRange()
61        : start(1), end(0)
62    {}
63
64    AddrRange(Addr _start, Addr _end)
65        : start(_start), end(_end)
66    {}
67
68    AddrRange(const std::pair<Addr, Addr> &r)
69        : start(r.first), end(r.second)
70    {}
71
72    Addr size() const { return end - start + 1; }
73    bool valid() const { return start < end; }
74
75    /**
76     * Determine if another range intersects this one, i.e. if there
77     * is an address that is both in this range and the other
78     * range. No check is made to ensure either range is valid.
79     *
80     * @param r Range to intersect with
81     * @return true if the intersection of the two ranges is not empty
82     */
83    bool intersects(const AddrRange& r) const
84    {
85        return (start <= r.start && end >= r.start) ||
86            (start <= r.end && end >= r.end);
87    }
88
89    /**
90     * Determine if this range is a subset of another range, i.e. if
91     * every address in this range is also in the other range. No
92     * check is made to ensure either range is valid.
93     *
94     * @param r Range to compare with
95     * @return true if the this range is a subset of the other one
96     */
97    bool isSubset(const AddrRange& r) const
98    {
99        return start >= r.start && end <= r.end;
100    }
101};
102
103/**
104 * Keep the operators away from SWIG.
105 */
106#ifndef SWIG
107
108/**
109 * @param range1 is a range.
110 * @param range2 is a range.
111 * @return if range1 is less than range2 and does not overlap range1.
112 */
113inline bool
114operator<(const AddrRange& range1, const AddrRange& range2)
115{
116    return range1.start < range2.start;
117}
118
119/**
120 * @param addr address in the range
121 * @param range range compared against.
122 * @return indicates that the address is not within the range.
123 */
124inline bool
125operator!=(const Addr& addr, const AddrRange& range)
126{
127    return addr < range.start || addr > range.end;
128}
129
130/**
131 * @param range range compared against.
132 * @param pos position compared to the range.
133 * @return indicates that position pos is within the range.
134 */
135inline bool
136operator==(const AddrRange& range, const Addr& addr)
137{
138    return addr >= range.start && addr <= range.end;
139}
140
141inline AddrRange
142RangeEx(Addr start, Addr end)
143{ return std::make_pair(start, end - 1); }
144
145inline AddrRange
146RangeIn(Addr start, Addr end)
147{ return std::make_pair(start, end); }
148
149inline AddrRange
150RangeSize(Addr start, Addr size)
151{ return std::make_pair(start, start + size - 1); }
152
153#endif // SWIG
154
155#endif // __BASE_ADDR_RANGE_HH__
156