public inbox for gcc-patches@gcc.gnu.org
 help / color / mirror / Atom feed
* [committed] libgomp.texi: Add status item, @ref and document omp_in_explicit_task
@ 2023-07-26  9:57 Tobias Burnus
  0 siblings, 0 replies; only message in thread
From: Tobias Burnus @ 2023-07-26  9:57 UTC (permalink / raw)
  To: gcc-patches

[-- Attachment #1: Type: text/plain, Size: 693 bytes --]

I stumbled recently over:
(a) 'omp target defaultmap(to: all)' - now added to the impl.status (as 'N')
(b) a @code that should have been @ref in our .texi
(c) while being there, I completed the 'Tasking Routines'
     section by adding the missing, third routine omp_in_explicit_task.
(Documentation is still missing for about 20 already implemented routines.)

Committed as Rev. r14-2784-g819f3d3692cbfe

Tobias
-----------------
Siemens Electronic Design Automation GmbH; Anschrift: Arnulfstraße 201, 80634 München; Gesellschaft mit beschränkter Haftung; Geschäftsführer: Thomas Heurung, Frank Thürauf; Sitz der Gesellschaft: München; Registergericht München, HRB 106955

[-- Attachment #2: committed.diff --]
[-- Type: text/x-patch, Size: 3297 bytes --]

commit 819f3d3692cbfe69ed7861da6ef47805914bb0b8
Author: Tobias Burnus <tobias@codesourcery.com>
Date:   Wed Jul 26 11:52:20 2023 +0200

    libgomp.texi: Add status item, @ref and document omp_in_explicit_task
    
    libgomp/ChangeLog:
    
            * libgomp.texi (OpenMP 5.2 features): Add 'all' for 'defaultmap' as 'N'.
            (Tasking Routines): Document omp_in_explicit_task.
            (Implementation-defined ICV Initialization): Use @ref not @code.
---
 libgomp/libgomp.texi | 31 +++++++++++++++++++++++++++++--
 1 file changed, 29 insertions(+), 2 deletions(-)

diff --git a/libgomp/libgomp.texi b/libgomp/libgomp.texi
index 9d3b2ae54cb..4ac01e977ec 100644
--- a/libgomp/libgomp.texi
+++ b/libgomp/libgomp.texi
@@ -426,6 +426,7 @@ to address of matching mapped list item per 5.1, Sect. 2.21.7.2 @tab N @tab
       @code{omp_invalid_device} enum/PARAMETER @tab Y @tab
 @item Initial value of @var{default-device-var} ICV with
       @code{OMP_TARGET_OFFLOAD=mandatory} @tab Y @tab
+@item @code{all} as @emph{implicit-behavior} for @code{defaultmap} @tab N @tab
 @item @emph{interop_types} in any position of the modifier list for the @code{init} clause
       of the @code{interop} construct @tab N @tab
 @end multitable
@@ -1370,7 +1371,7 @@ They have C linkage and do not throw exceptions.
 
 @menu
 * omp_get_max_task_priority::   Maximum task priority value that can be set
-@c * omp_in_explicit_task:: <fixme>
+* omp_in_explicit_task::        Whether a given task is an explicit task
 * omp_in_final::                Whether in final or included task region
 @end menu
 
@@ -1399,6 +1400,32 @@ This function obtains the maximum allowed priority number for tasks.
 
 
 
+@node omp_in_explicit_task
+@subsection @code{omp_in_explicit_task} -- Whether a given task is an explicit task
+@table @asis
+@item @emph{Description}:
+The function returns the @var{explicit-task-var} ICV; it returns true when the
+encountering task was generated by a task-generating construct such as
+@code{target}, @code{task} or @code{taskloop}.  Otherwise, the encountering task
+is in an implicit task region such as generated by the implicit or explicit
+@code{parallel} region and @code{omp_in_explicit_task} returns false.
+
+@item @emph{C/C++}
+@multitable @columnfractions .20 .80
+@item @emph{Prototype}: @tab @code{int omp_in_explicit_task(void);}
+@end multitable
+
+@item @emph{Fortran}:
+@multitable @columnfractions .20 .80
+@item @emph{Interface}: @tab @code{logical function omp_in_explicit_task()}
+@end multitable
+
+@item @emph{Reference}:
+@uref{https://www.openmp.org, OpenMP specification v5.2}, Section 18.5.2.
+@end table
+
+
+
 @node omp_in_final
 @subsection @code{omp_in_final} -- Whether in final or included task region
 @table @asis
@@ -4802,7 +4829,7 @@ offloading devices (it's not clear if they should be):
 @item @var{def-allocator-var} @tab See @ref{OMP_ALLOCATOR}.
 @item @var{max-active-levels-var} @tab See @ref{OMP_MAX_ACTIVE_LEVELS}.
 @item @var{dyn-var} @tab See @ref{OMP_DYNAMIC}.
-@item @var{nthreads-var} @tab See @code{OMP_NUM_THREADS}.
+@item @var{nthreads-var} @tab See @ref{OMP_NUM_THREADS}.
 @item @var{num-devices-var} @tab Number of non-host devices found
 by GCC's run-time library
 @item @var{num-procs-var} @tab The number of CPU cores on the

^ permalink raw reply	[flat|nested] only message in thread

only message in thread, other threads:[~2023-07-26  9:57 UTC | newest]

Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-07-26  9:57 [committed] libgomp.texi: Add status item, @ref and document omp_in_explicit_task Tobias Burnus

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).