Cheri-research/snmalloc
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

NFC: ds/pagemap: tweak commentary

Browse Source
This commit is contained in:
Nathaniel Wesley Filardo
2022-12-10 10:53:56 +00:00
committed by Nathaniel Filardo
parent a42c4303e0
commit 48340faa09
1 changed files with 11 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
src/snmalloc/ds/pagemap.h
View File

@@ -250,10 +250,13 @@ namespace snmalloc
} }
/** /**
*
* Get a non-constant reference to the slot of this pagemap corresponding
* to a particular address.
*
* If the location has not been used before, then * If the location has not been used before, then
* `potentially_out_of_range` should be set to true. * `potentially_out_of_range` should be set to true. This will ensure
* This will ensure there is a location for the * there is memory backing the returned reference.
* read/write.
*/ */
template<bool potentially_out_of_range> template<bool potentially_out_of_range>
T& get_mut(address_t p) T& get_mut(address_t p)
@@ -301,10 +304,12 @@ namespace snmalloc
} }
/** /**
* Get a constant reference to the slot of this pagemap corresponding to a
* particular address.
*
* If the location has not been used before, then * If the location has not been used before, then
* `potentially_out_of_range` should be set to true. * `potentially_out_of_range` should be set to true. This will ensure
* This will ensure there is a location for the * there is memory backing any reads through the returned reference.
* read/write.
*/ */
template<bool potentially_out_of_range> template<bool potentially_out_of_range>
const T& get(address_t p) const T& get(address_t p)