base: Tag API methods and variables in addr_range_map.hh

Change-Id: I9dc630e7c0d0826a20f032879346da6327b38a2d
Signed-off-by: Hoa Nguyen <hoanguyen@ucdavis.edu>
Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5/+/32956
Reviewed-by: Bobby R. Bruce <bbruce@ucdavis.edu>
Reviewed-by: Jason Lowe-Power <power.jg@gmail.com>
Maintainer: Bobby R. Bruce <bbruce@ucdavis.edu>
Tested-by: kokoro <noreply+kokoro@google.com>
This commit is contained in:
Hoa Nguyen
2020-08-19 23:05:01 -07:00
parent 7d056a5dce
commit b695e09d07

View File

@@ -62,8 +62,13 @@ class AddrRangeMap
typedef std::map<AddrRange, V> RangeMap;
public:
/**
* @ingroup api_addr_range
* @{
*/
typedef typename RangeMap::iterator iterator;
typedef typename RangeMap::const_iterator const_iterator;
/** @} */ // end of api_addr_range
/**
* Find entry that contains the given address range
@@ -74,6 +79,9 @@ class AddrRangeMap
*
* @param r An input address range
* @return An iterator that contains the input address range
*
* @ingroup api_addr_range
* @{
*/
const_iterator
contains(const AddrRange &r) const
@@ -85,6 +93,7 @@ class AddrRangeMap
{
return find(r, [r](const AddrRange r1) { return r.isSubset(r1); });
}
/** @} */ // end of api_addr_range
/**
* Find entry that contains the given address
@@ -95,6 +104,9 @@ class AddrRangeMap
*
* @param r An input address
* @return An iterator that contains the input address
*
* @ingroup api_addr_range
* @{
*/
const_iterator
contains(Addr r) const
@@ -106,6 +118,7 @@ class AddrRangeMap
{
return contains(RangeSize(r, 1));
}
/** @} */ // end of api_addr_range
/**
* Find entry that intersects with the given address range
@@ -116,6 +129,9 @@ class AddrRangeMap
*
* @param r An input address
* @return An iterator that intersects with the input address range
*
* @ingroup api_addr_range
* @{
*/
const_iterator
intersects(const AddrRange &r) const
@@ -127,7 +143,11 @@ class AddrRangeMap
{
return find(r, [r](const AddrRange r1) { return r.intersects(r1); });
}
/** @} */ // end of api_addr_range
/**
* @ingroup api_addr_range
*/
iterator
insert(const AddrRange &r, const V& d)
{
@@ -137,6 +157,9 @@ class AddrRangeMap
return tree.insert(std::make_pair(r, d)).first;
}
/**
* @ingroup api_addr_range
*/
void
erase(iterator p)
{
@@ -144,6 +167,9 @@ class AddrRangeMap
tree.erase(p);
}
/**
* @ingroup api_addr_range
*/
void
erase(iterator p, iterator q)
{
@@ -153,6 +179,9 @@ class AddrRangeMap
tree.erase(p,q);
}
/**
* @ingroup api_addr_range
*/
void
clear()
{
@@ -160,36 +189,54 @@ class AddrRangeMap
tree.erase(tree.begin(), tree.end());
}
/**
* @ingroup api_addr_range
*/
const_iterator
begin() const
{
return tree.begin();
}
/**
* @ingroup api_addr_range
*/
iterator
begin()
{
return tree.begin();
}
/**
* @ingroup api_addr_range
*/
const_iterator
end() const
{
return tree.end();
}
/**
* @ingroup api_addr_range
*/
iterator
end()
{
return tree.end();
}
/**
* @ingroup api_addr_range
*/
std::size_t
size() const
{
return tree.size();
}
/**
* @ingroup api_addr_range
*/
bool
empty() const
{