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