diff options
Diffstat (limited to 'libgomp/libgomp.texi')
| -rw-r--r-- | libgomp/libgomp.texi | 61 |
1 files changed, 52 insertions, 9 deletions
diff --git a/libgomp/libgomp.texi b/libgomp/libgomp.texi index 06b1c67..67e6d19 100644 --- a/libgomp/libgomp.texi +++ b/libgomp/libgomp.texi @@ -155,6 +155,7 @@ linkage, and do not throw exceptions. * omp_get_dynamic:: Dynamic teams setting * omp_get_level:: Number of parallel regions * omp_get_max_active_levels:: Maximum number of active regions +* omp_get_max_task_priority:: Maximum task priority value that can be set * omp_get_max_threads:: Maximum number of threads of parallel region * omp_get_nested:: Nested parallel regions * omp_get_num_devices:: Number of target devices @@ -388,6 +389,27 @@ This function obtains the maximum allowed number of nested, active parallel regi @end table +@node omp_get_max_task_priority +@section @code{omp_get_max_task_priority} -- Maximum priority value +that can be set for tasks. +@table @asis +@item @emph{Description}: +This function obtains the maximum allowed priority number for tasks. + +@item @emph{C/C++} +@multitable @columnfractions .20 .80 +@item @emph{Prototype}: @tab @code{int omp_get_max_task_priority(void);} +@end multitable + +@item @emph{Fortran}: +@multitable @columnfractions .20 .80 +@item @emph{Interface}: @tab @code{integer function omp_get_max_task_priority()} +@end multitable + +@item @emph{Reference}: +@uref{http://www.openmp.org/, OpenMP specification v4.5}, Section 3.2.29. +@end table + @node omp_get_max_threads @section @code{omp_get_max_threads} -- Maximum number of threads of parallel region @@ -581,18 +603,18 @@ set via @env{OMP_PROC_BIND}. Possible values are @code{omp_proc_bind_false}, Obtain the runtime scheduling method. The @var{kind} argument will be set to the value @code{omp_sched_static}, @code{omp_sched_dynamic}, @code{omp_sched_guided} or @code{omp_sched_auto}. The second argument, -@var{modifier}, is set to the chunk size. +@var{chunk_size}, is set to the chunk size. @item @emph{C/C++} @multitable @columnfractions .20 .80 -@item @emph{Prototype}: @tab @code{void omp_get_schedule(omp_sched_t *kind, int *modifier);} +@item @emph{Prototype}: @tab @code{void omp_get_schedule(omp_sched_t *kind, int *chunk_size);} @end multitable @item @emph{Fortran}: @multitable @columnfractions .20 .80 -@item @emph{Interface}: @tab @code{subroutine omp_get_schedule(kind, modifier)} +@item @emph{Interface}: @tab @code{subroutine omp_get_schedule(kind, chunk_size)} @item @tab @code{integer(kind=omp_sched_kind) kind} -@item @tab @code{integer modifier} +@item @tab @code{integer chunk_size} @end multitable @item @emph{See also}: @@ -929,19 +951,19 @@ Sets the runtime scheduling method. The @var{kind} argument can have the value @code{omp_sched_static}, @code{omp_sched_dynamic}, @code{omp_sched_guided} or @code{omp_sched_auto}. Except for @code{omp_sched_auto}, the chunk size is set to the value of -@var{modifier} if positive, or to the default value if zero or negative. -For @code{omp_sched_auto} the @var{modifier} argument is ignored. +@var{chunk_size} if positive, or to the default value if zero or negative. +For @code{omp_sched_auto} the @var{chunk_size} argument is ignored. @item @emph{C/C++} @multitable @columnfractions .20 .80 -@item @emph{Prototype}: @tab @code{void omp_set_schedule(omp_sched_t kind, int modifier);} +@item @emph{Prototype}: @tab @code{void omp_set_schedule(omp_sched_t kind, int chunk_size);} @end multitable @item @emph{Fortran}: @multitable @columnfractions .20 .80 -@item @emph{Interface}: @tab @code{subroutine omp_set_schedule(kind, modifier)} +@item @emph{Interface}: @tab @code{subroutine omp_set_schedule(kind, chunk_size)} @item @tab @code{integer(kind=omp_sched_kind) kind} -@item @tab @code{integer modifier} +@item @tab @code{integer chunk_size} @end multitable @item @emph{See also}: @@ -1311,6 +1333,7 @@ beginning with @env{GOMP_} are GNU extensions. * OMP_DEFAULT_DEVICE:: Set the device used in target regions * OMP_DYNAMIC:: Dynamic adjustment of threads * OMP_MAX_ACTIVE_LEVELS:: Set the maximum number of nested parallel regions +* OMP_MAX_TASK_PRIORITY:: Set the maximum task priority value * OMP_NESTED:: Nested parallel regions * OMP_NUM_THREADS:: Specifies the number of threads to use * OMP_PROC_BIND:: Whether theads may be moved between CPUs @@ -1420,6 +1443,26 @@ If undefined, the number of active levels is unlimited. +@node OMP_MAX_TASK_PRIORITY +@section @env{OMP_MAX_TASK_PRIORITY} -- Set the maximum priority +number that can be set for a task. +@cindex Environment Variable +@table @asis +@item @emph{Description}: +Specifies the initial value for the maximum priority value that can be +set for a task. The value of this variable shall be a non-negative +integer, and zero is allowed. If undefined, the default priority is +0. + +@item @emph{See also}: +@ref{omp_get_max_task_priority} + +@item @emph{Reference}: +@uref{http://www.openmp.org/, OpenMP specification v4.5}, Section 4.14 +@end table + + + @node OMP_NESTED @section @env{OMP_NESTED} -- Nested parallel regions @cindex Environment Variable |