addr_range.hh revision 9405
12SN/A/* 29235Sandreas.hansson@arm.com * Copyright (c) 2012 ARM Limited 39235Sandreas.hansson@arm.com * All rights reserved 49235Sandreas.hansson@arm.com * 59235Sandreas.hansson@arm.com * The license below extends only to copyright in the software and shall 69235Sandreas.hansson@arm.com * not be construed as granting a license to any other intellectual 79235Sandreas.hansson@arm.com * property including but not limited to intellectual property relating 89235Sandreas.hansson@arm.com * to a hardware implementation of the functionality of the software 99235Sandreas.hansson@arm.com * licensed hereunder. You may use the software subject to the license 109235Sandreas.hansson@arm.com * terms below provided that you ensure that this notice is replicated 119235Sandreas.hansson@arm.com * unmodified and in its entirety in all distributions of the software, 129235Sandreas.hansson@arm.com * modified or unmodified, in source code or in binary form. 139235Sandreas.hansson@arm.com * 141762SN/A * Copyright (c) 2002-2005 The Regents of The University of Michigan 152SN/A * All rights reserved. 162SN/A * 172SN/A * Redistribution and use in source and binary forms, with or without 182SN/A * modification, are permitted provided that the following conditions are 192SN/A * met: redistributions of source code must retain the above copyright 202SN/A * notice, this list of conditions and the following disclaimer; 212SN/A * redistributions in binary form must reproduce the above copyright 222SN/A * notice, this list of conditions and the following disclaimer in the 232SN/A * documentation and/or other materials provided with the distribution; 242SN/A * neither the name of the copyright holders nor the names of its 252SN/A * contributors may be used to endorse or promote products derived from 262SN/A * this software without specific prior written permission. 272SN/A * 282SN/A * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 292SN/A * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 302SN/A * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 312SN/A * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 322SN/A * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 332SN/A * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 342SN/A * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 352SN/A * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 362SN/A * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 372SN/A * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 382SN/A * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 392665SN/A * 402665SN/A * Authors: Nathan Binkert 412665SN/A * Steve Reinhardt 429235Sandreas.hansson@arm.com * Andreas Hansson 432SN/A */ 442SN/A 459235Sandreas.hansson@arm.com#ifndef __BASE_ADDR_RANGE_HH__ 469235Sandreas.hansson@arm.com#define __BASE_ADDR_RANGE_HH__ 472SN/A 489405Sandreas.hansson@arm.com#include "base/cprintf.hh" 499235Sandreas.hansson@arm.com#include "base/types.hh" 509235Sandreas.hansson@arm.com 519235Sandreas.hansson@arm.comclass AddrRange 522SN/A{ 532SN/A 549405Sandreas.hansson@arm.com private: 559405Sandreas.hansson@arm.com 569405Sandreas.hansson@arm.com /// Private fields for the start and end of the range. In the 579405Sandreas.hansson@arm.com /// future, these will be extended with interleaving functionality 589405Sandreas.hansson@arm.com /// and hence should never be manipulated directly. 599405Sandreas.hansson@arm.com Addr _start; 609405Sandreas.hansson@arm.com Addr _end; 619405Sandreas.hansson@arm.com 629235Sandreas.hansson@arm.com public: 632SN/A 649235Sandreas.hansson@arm.com AddrRange() 659405Sandreas.hansson@arm.com : _start(1), _end(0) 669235Sandreas.hansson@arm.com {} 679235Sandreas.hansson@arm.com 689235Sandreas.hansson@arm.com AddrRange(Addr _start, Addr _end) 699405Sandreas.hansson@arm.com : _start(_start), _end(_end) 709235Sandreas.hansson@arm.com {} 719235Sandreas.hansson@arm.com 729405Sandreas.hansson@arm.com /** 739405Sandreas.hansson@arm.com * Get the size of the address range. For a case where 749405Sandreas.hansson@arm.com * interleaving is used this should probably cause a panic. 759405Sandreas.hansson@arm.com */ 769405Sandreas.hansson@arm.com Addr size() const { return _end - _start + 1; } 77532SN/A 789405Sandreas.hansson@arm.com /** 799405Sandreas.hansson@arm.com * Determine if the range is valid. 809405Sandreas.hansson@arm.com */ 819405Sandreas.hansson@arm.com bool valid() const { return _start < _end; } 829405Sandreas.hansson@arm.com 839405Sandreas.hansson@arm.com /** 849405Sandreas.hansson@arm.com * Get the start address of the range. 859405Sandreas.hansson@arm.com */ 869405Sandreas.hansson@arm.com Addr start() const { return _start; } 879405Sandreas.hansson@arm.com 889405Sandreas.hansson@arm.com /** 899405Sandreas.hansson@arm.com * Get a string representation of the range. This could 909405Sandreas.hansson@arm.com * alternatively be implemented as a operator<<, but at the moment 919405Sandreas.hansson@arm.com * that seems like overkill. 929405Sandreas.hansson@arm.com */ 939405Sandreas.hansson@arm.com std::string to_string() const 949405Sandreas.hansson@arm.com { 959405Sandreas.hansson@arm.com return csprintf("[%#llx : %#llx]", _start, _end); 969405Sandreas.hansson@arm.com } 979279Sandreas.hansson@arm.com 989279Sandreas.hansson@arm.com /** 999279Sandreas.hansson@arm.com * Determine if another range intersects this one, i.e. if there 1009279Sandreas.hansson@arm.com * is an address that is both in this range and the other 1019279Sandreas.hansson@arm.com * range. No check is made to ensure either range is valid. 1029279Sandreas.hansson@arm.com * 1039279Sandreas.hansson@arm.com * @param r Range to intersect with 1049279Sandreas.hansson@arm.com * @return true if the intersection of the two ranges is not empty 1059279Sandreas.hansson@arm.com */ 1069279Sandreas.hansson@arm.com bool intersects(const AddrRange& r) const 1079279Sandreas.hansson@arm.com { 1089405Sandreas.hansson@arm.com return _start <= r._end && _end >= r._start; 1099279Sandreas.hansson@arm.com } 1109279Sandreas.hansson@arm.com 1119279Sandreas.hansson@arm.com /** 1129279Sandreas.hansson@arm.com * Determine if this range is a subset of another range, i.e. if 1139279Sandreas.hansson@arm.com * every address in this range is also in the other range. No 1149279Sandreas.hansson@arm.com * check is made to ensure either range is valid. 1159279Sandreas.hansson@arm.com * 1169279Sandreas.hansson@arm.com * @param r Range to compare with 1179279Sandreas.hansson@arm.com * @return true if the this range is a subset of the other one 1189279Sandreas.hansson@arm.com */ 1199279Sandreas.hansson@arm.com bool isSubset(const AddrRange& r) const 1209279Sandreas.hansson@arm.com { 1219405Sandreas.hansson@arm.com return _start >= r._start && _end <= r._end; 1229279Sandreas.hansson@arm.com } 1239405Sandreas.hansson@arm.com 1249405Sandreas.hansson@arm.com /** 1259405Sandreas.hansson@arm.com * Determine if the range contains an address. 1269405Sandreas.hansson@arm.com * 1279405Sandreas.hansson@arm.com * @param a Address to compare with 1289405Sandreas.hansson@arm.com * @return true if the address is in the range 1299405Sandreas.hansson@arm.com */ 1309405Sandreas.hansson@arm.com bool contains(const Addr& a) const 1319405Sandreas.hansson@arm.com { 1329405Sandreas.hansson@arm.com return a >= _start && a <= _end; 1339405Sandreas.hansson@arm.com } 1342SN/A 135531SN/A/** 1369235Sandreas.hansson@arm.com * Keep the operators away from SWIG. 137531SN/A */ 1389235Sandreas.hansson@arm.com#ifndef SWIG 1392SN/A 1409405Sandreas.hansson@arm.com /** 1419405Sandreas.hansson@arm.com * Less-than operator used to turn an STL map into a binary search 1429405Sandreas.hansson@arm.com * tree of non-overlapping address ranges. 1439405Sandreas.hansson@arm.com * 1449405Sandreas.hansson@arm.com * @param r Range to compare with 1459405Sandreas.hansson@arm.com * @return true if the start address is less than that of the other range 1469405Sandreas.hansson@arm.com */ 1479405Sandreas.hansson@arm.com bool operator<(const AddrRange& r) const 1489405Sandreas.hansson@arm.com { 1499405Sandreas.hansson@arm.com return _start < r._start; 1509405Sandreas.hansson@arm.com } 151531SN/A 1529405Sandreas.hansson@arm.com#endif // SWIG 1539405Sandreas.hansson@arm.com}; 1542SN/A 1559235Sandreas.hansson@arm.cominline AddrRange 1569235Sandreas.hansson@arm.comRangeEx(Addr start, Addr end) 1579405Sandreas.hansson@arm.com{ return AddrRange(start, end - 1); } 1582SN/A 1599235Sandreas.hansson@arm.cominline AddrRange 1609235Sandreas.hansson@arm.comRangeIn(Addr start, Addr end) 1619405Sandreas.hansson@arm.com{ return AddrRange(start, end); } 1622SN/A 1639235Sandreas.hansson@arm.cominline AddrRange 1649235Sandreas.hansson@arm.comRangeSize(Addr start, Addr size) 1659405Sandreas.hansson@arm.com{ return AddrRange(start, start + size - 1); } 1662SN/A 1679235Sandreas.hansson@arm.com#endif // __BASE_ADDR_RANGE_HH__ 168