Skip to content

Commit 75ae6d3

Browse files
committed
Add brief introduction of lowest latency memspace
1 parent 336dfb8 commit 75ae6d3

File tree

2 files changed

+9
-2
lines changed

2 files changed

+9
-2
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -229,6 +229,11 @@ Can be retrieved using umfMemspaceHighestCapacityGet.
229229
Memspace backed by an aggregated list of NUMA nodes identified as highest bandwidth after selecting each available NUMA node as the initiator.
230230
Querying the bandwidth value requires HMAT support on the platform. Calling `umfMemspaceHighestBandwidthGet()` will return NULL if it's not supported.
231231

232+
#### Lowest latency memspace
233+
234+
Memspace backed by an aggregated list of NUMA nodes identified as lowest latency after selecting each available NUMA node as the initiator.
235+
Querying the latency value requires HMAT support on the platform. Calling `umfMemspaceLowestLatencyGet()` will return NULL if it's not supported.
236+
232237
### Proxy library
233238

234239
UMF provides the UMF proxy library (`umf_proxy`) that makes it possible

include/umf/memspace.h

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,12 +57,14 @@ umf_memspace_handle_t umfMemspaceHostAllGet(void);
5757
umf_memspace_handle_t umfMemspaceHighestCapacityGet(void);
5858

5959
/// \brief Retrieves predefined highest bandwidth memspace.
60-
/// \return highest bandwidth memspace handle on success or NULL on failure.
60+
/// \return highest bandwidth memspace handle on success or NULL on
61+
/// failure (no HMAT support).
6162
///
6263
umf_memspace_handle_t umfMemspaceHighestBandwidthGet(void);
6364

6465
/// \brief Retrieves predefined lowest latency memspace.
65-
/// \return lowest latency memspace handle on success or NULL on failure.
66+
/// \return lowest latency memspace handle on success or NULL on
67+
/// failure (no HMAT support).
6668
///
6769
umf_memspace_handle_t umfMemspaceLowestLatencyGet(void);
6870

0 commit comments

Comments
 (0)