Here is a follow up patch for documentation of the omp.h allocators,
I'm not super happy with it but I wanted to get eyes on it before I go
to sleep tonight.
I want the table in there somewhere but I'm not confident that where I
put it was the right place.
Alex
From c8cef447baf16743f7bf0d887d3fd09108d3a607 Mon Sep 17 00:00:00 2001
From: waffl3x <waff...@baylibre.com>
Date: Tue, 15 Apr 2025 18:50:30 -0600
Subject: [PATCH] Docs: Document omp::allocator::* and ompx::allocator::*
allocators.
libgomp/ChangeLog:
* libgomp.texi: Add omp::allocator::* table.
Add example using omp::allocator::cgroup.
Signed-off-by: waffl3x <waff...@baylibre.com>
---
libgomp/libgomp.texi | 26 ++++++++++++++++++++++++++
1 file changed, 26 insertions(+)
diff --git a/libgomp/libgomp.texi b/libgomp/libgomp.texi
index 3d3a56cc29a..fd35c445a25 100644
--- a/libgomp/libgomp.texi
+++ b/libgomp/libgomp.texi
@@ -3950,6 +3950,24 @@ value.
@item ompx_gnu_pinned_mem_alloc @tab omp_default_mem_space (GNU extension)
@end multitable
+Each predefined allocator, including omp_null_allocator, also corresponds to an
+allocator template. This allows C++ standard library containers to use OpenMP
+allocation routines.
+
+@multitable @columnfractions .45 .45
+@headitem Predefined allocators @tab Associated allocator template
+@item omp_null_allocator @tab omp::allocator::null_allocator
+@item omp_default_mem_alloc @tab omp::allocator::default_mem
+@item omp_large_cap_mem_alloc @tab omp::allocator::large_cap_mem
+@item omp_const_mem_alloc @tab omp::allocator::const_mem
+@item omp_high_bw_mem_alloc @tab omp::allocator::high_bw_mem
+@item omp_low_lat_mem_alloc @tab omp::allocator::low_lat_mem
+@item omp_cgroup_mem_alloc @tab omp::allocator::cgroup_mem
+@item omp_pteam_mem_alloc @tab omp::allocator::pteam_mem
+@item omp_thread_mem_alloc @tab omp::allocator::thread_mem
+@item ompx_gnu_pinned_mem_alloc @tab ompx::allocator::gnu_pinned_mem
+@end multitable
+
The predefined allocators use the default values for the traits,
as listed below. Except that the last three allocators have the
@code{access} trait set to @code{cgroup}, @code{pteam}, and
@@ -6758,6 +6776,14 @@ see @ref{OMP_ALLOCATOR}. Predefined allocators without an associated memory
space use the @code{omp_default_mem_space} memory space. See additionally
@ref{Offload-Target Specifics}.
+Each predefined allocator, including omp_null_allocator, has a corresponding
+allocator class template that meet the C++ allocator completeness requirements.
+These are located in the omp::allocator namespace, and the ompx::allocator
+namespace for gnu extensions.
+@smallexample
+std::vector<int, omp::allocator::cgroup_mem<int>> vec;
+@end smallexample
+
For the memory spaces, the following applies:
@itemize
@item @code{omp_default_mem_space} is supported
--
2.47.1
