Commit 72832460 by Uros Bizjak Committed by Uros Bizjak

libgomp.texi (Runitme Library Routines): Remove multiple @menu.

	* libgomp.texi (Runitme Library Routines): Remove multiple @menu.
	(Environment Variables) Move OMP_PROC_BIND and OMP_STACKSIZE node
	texts according to their @menu entry positions.

From-SVN: r210580
parent a9dd0112
2014-05-18 Uros Bizjak <ubizjak@gmail.com>
* libgomp.texi (Runitme Library Routines): Remove multiple @menu.
(Environment Variables) Move OMP_PROC_BIND and OMP_STACKSIZE node
texts according to their @menu entry positions.
2014-05-11 Jakub Jelinek <jakub@redhat.com> 2014-05-11 Jakub Jelinek <jakub@redhat.com>
* testsuite/libgomp.fortran/cancel-do-1.f90: New test. * testsuite/libgomp.fortran/cancel-do-1.f90: New test.
......
...@@ -130,10 +130,10 @@ The runtime routines described here are defined by Section 3 of the OpenMP ...@@ -130,10 +130,10 @@ The runtime routines described here are defined by Section 3 of the OpenMP
specification in version 4.0. The routines are structured in following specification in version 4.0. The routines are structured in following
three parts: three parts:
@menu
Control threads, processors and the parallel environment. They have C Control threads, processors and the parallel environment. They have C
linkage, and do not throw exceptions. linkage, and do not throw exceptions.
@menu
* omp_get_active_level:: Number of active parallel regions * omp_get_active_level:: Number of active parallel regions
* omp_get_ancestor_thread_num:: Ancestor thread ID * omp_get_ancestor_thread_num:: Ancestor thread ID
* omp_get_cancellation:: Whether cancellation support is enabled * omp_get_cancellation:: Whether cancellation support is enabled
...@@ -162,11 +162,9 @@ linkage, and do not throw exceptions. ...@@ -162,11 +162,9 @@ linkage, and do not throw exceptions.
* omp_set_nested:: Enable/disable nested parallel regions * omp_set_nested:: Enable/disable nested parallel regions
* omp_set_num_threads:: Set upper team size limit * omp_set_num_threads:: Set upper team size limit
* omp_set_schedule:: Set the runtime scheduling method * omp_set_schedule:: Set the runtime scheduling method
@end menu
Initialize, set, test, unset and destroy simple and nested locks. Initialize, set, test, unset and destroy simple and nested locks.
@menu
* omp_init_lock:: Initialize simple lock * omp_init_lock:: Initialize simple lock
* omp_set_lock:: Wait for and set simple lock * omp_set_lock:: Wait for and set simple lock
* omp_test_lock:: Test and set simple lock if available * omp_test_lock:: Test and set simple lock if available
...@@ -177,11 +175,9 @@ Initialize, set, test, unset and destroy simple and nested locks. ...@@ -177,11 +175,9 @@ Initialize, set, test, unset and destroy simple and nested locks.
* omp_test_nest_lock:: Test and set nested lock if available * omp_test_nest_lock:: Test and set nested lock if available
* omp_unset_nest_lock:: Unset nested lock * omp_unset_nest_lock:: Unset nested lock
* omp_destroy_nest_lock:: Destroy nested lock * omp_destroy_nest_lock:: Destroy nested lock
@end menu
Portable, thread-based, wall clock timer. Portable, thread-based, wall clock timer.
@menu
* omp_get_wtick:: Get timer precision. * omp_get_wtick:: Get timer precision.
* omp_get_wtime:: Elapsed wall clock time. * omp_get_wtime:: Elapsed wall clock time.
@end menu @end menu
...@@ -1448,6 +1444,33 @@ level. If undefined one thread per CPU is used. ...@@ -1448,6 +1444,33 @@ level. If undefined one thread per CPU is used.
@node OMP_PROC_BIND
@section @env{OMP_PROC_BIND} -- Whether theads may be moved between CPUs
@cindex Environment Variable
@table @asis
@item @emph{Description}:
Specifies whether threads may be moved between processors. If set to
@code{TRUE}, OpenMP theads should not be moved; if set to @code{FALSE}
they may be moved. Alternatively, a comma separated list with the
values @code{MASTER}, @code{CLOSE} and @code{SPREAD} can be used to specify
the thread affinity policy for the corresponding nesting level. With
@code{MASTER} the worker threads are in the same place partition as the
master thread. With @code{CLOSE} those are kept close to the master thread
in contiguous place partitions. And with @code{SPREAD} a sparse distribution
across the place partitions is used.
When undefined, @env{OMP_PROC_BIND} defaults to @code{TRUE} when
@env{OMP_PLACES} or @env{GOMP_CPU_AFFINITY} is set and @code{FALSE} otherwise.
@item @emph{See also}:
@ref{OMP_PLACES}, @ref{GOMP_CPU_AFFINITY}, @ref{omp_get_proc_bind}
@item @emph{Reference}:
@uref{http://www.openmp.org/, OpenMP specification v4.0}, Section 4.4
@end table
@node OMP_PLACES @node OMP_PLACES
@section @env{OMP_PLACES} -- Specifies on which CPUs the theads should be placed @section @env{OMP_PLACES} -- Specifies on which CPUs the theads should be placed
@cindex Environment Variable @cindex Environment Variable
...@@ -1490,29 +1513,22 @@ between CPUs following no placement policy. ...@@ -1490,29 +1513,22 @@ between CPUs following no placement policy.
@node OMP_PROC_BIND @node OMP_STACKSIZE
@section @env{OMP_PROC_BIND} -- Whether theads may be moved between CPUs @section @env{OMP_STACKSIZE} -- Set default thread stack size
@cindex Environment Variable @cindex Environment Variable
@table @asis @table @asis
@item @emph{Description}: @item @emph{Description}:
Specifies whether threads may be moved between processors. If set to Set the default thread stack size in kilobytes, unless the number
@code{TRUE}, OpenMP theads should not be moved; if set to @code{FALSE} is suffixed by @code{B}, @code{K}, @code{M} or @code{G}, in which
they may be moved. Alternatively, a comma separated list with the case the size is, respectively, in bytes, kilobytes, megabytes
values @code{MASTER}, @code{CLOSE} and @code{SPREAD} can be used to specify or gigabytes. This is different from @code{pthread_attr_setstacksize}
the thread affinity policy for the corresponding nesting level. With which gets the number of bytes as an argument. If the stack size cannot
@code{MASTER} the worker threads are in the same place partition as the be set due to system constraints, an error is reported and the initial
master thread. With @code{CLOSE} those are kept close to the master thread stack size is left unchanged. If undefined, the stack size is system
in contiguous place partitions. And with @code{SPREAD} a sparse distribution dependent.
across the place partitions is used.
When undefined, @env{OMP_PROC_BIND} defaults to @code{TRUE} when
@env{OMP_PLACES} or @env{GOMP_CPU_AFFINITY} is set and @code{FALSE} otherwise.
@item @emph{See also}:
@ref{OMP_PLACES}, @ref{GOMP_CPU_AFFINITY}, @ref{omp_get_proc_bind}
@item @emph{Reference}: @item @emph{Reference}:
@uref{http://www.openmp.org/, OpenMP specification v4.0}, Section 4.4 @uref{http://www.openmp.org/, OpenMP specification v4.0}, Section 4.7
@end table @end table
...@@ -1538,26 +1554,6 @@ dynamic scheduling and a chunk size of 1 is used. ...@@ -1538,26 +1554,6 @@ dynamic scheduling and a chunk size of 1 is used.
@node OMP_STACKSIZE
@section @env{OMP_STACKSIZE} -- Set default thread stack size
@cindex Environment Variable
@table @asis
@item @emph{Description}:
Set the default thread stack size in kilobytes, unless the number
is suffixed by @code{B}, @code{K}, @code{M} or @code{G}, in which
case the size is, respectively, in bytes, kilobytes, megabytes
or gigabytes. This is different from @code{pthread_attr_setstacksize}
which gets the number of bytes as an argument. If the stack size cannot
be set due to system constraints, an error is reported and the initial
stack size is left unchanged. If undefined, the stack size is system
dependent.
@item @emph{Reference}:
@uref{http://www.openmp.org/, OpenMP specification v4.0}, Section 4.7
@end table
@node OMP_THREAD_LIMIT @node OMP_THREAD_LIMIT
@section @env{OMP_THREAD_LIMIT} -- Set the maximum number of threads @section @env{OMP_THREAD_LIMIT} -- Set the maximum number of threads
@cindex Environment Variable @cindex Environment Variable
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment