[thirdparty/gcc.git] / libgomp / doc / openmp-runtime-library-routines / ompgetprocbind.rst

..
  Copyright 1988-2022 Free Software Foundation, Inc.
  This is part of the GCC manual.
  For copying conditions, see the copyright.rst file.

.. _omp_get_proc_bind:

omp_get_proc_bind -- Whether theads may be moved between CPUs
*************************************************************

Description:
  This functions returns the currently active thread affinity policy, which is
  set via :envvar:`OMP_PROC_BIND`.  Possible values are ``omp_proc_bind_false``,
  ``omp_proc_bind_true``, ``omp_proc_bind_primary``,
  ``omp_proc_bind_master``, ``omp_proc_bind_close`` and ``omp_proc_bind_spread``,
  where ``omp_proc_bind_master`` is an alias for ``omp_proc_bind_primary``.

C/C++:
  .. list-table::

     * - *Prototype*:
       - ``omp_proc_bind_t omp_get_proc_bind(void);``

Fortran:
  .. list-table::

     * - *Interface*:
       - ``integer(kind=omp_proc_bind_kind) function omp_get_proc_bind()``

See also:
  :ref:`OMP_PROC_BIND`, :ref:`OMP_PLACES`, :ref:`GOMP_CPU_AFFINITY`,

Reference:
  :openmp:`4.5`, Section 3.2.22.
Commit	Line	Data
c63539ff ML	1	..
	2	Copyright 1988-2022 Free Software Foundation, Inc.
	3	This is part of the GCC manual.
	4	For copying conditions, see the copyright.rst file.
	5
	6	.. _omp_get_proc_bind:
	7
	8	omp_get_proc_bind -- Whether theads may be moved between CPUs
	9	*************************************************************
	10
	11	Description:
	12	This functions returns the currently active thread affinity policy, which is
	13	set via :envvar:`OMP_PROC_BIND`. Possible values are ``omp_proc_bind_false``,
	14	``omp_proc_bind_true``, ``omp_proc_bind_primary``,
	15	``omp_proc_bind_master``, ``omp_proc_bind_close`` and ``omp_proc_bind_spread``,
	16	where ``omp_proc_bind_master`` is an alias for ``omp_proc_bind_primary``.
	17
	18	C/C++:
	19	.. list-table::
	20
	21	* - Prototype:
	22	- ``omp_proc_bind_t omp_get_proc_bind(void);``
	23
	24	Fortran:
	25	.. list-table::
	26
	27	* - Interface:
	28	- ``integer(kind=omp_proc_bind_kind) function omp_get_proc_bind()``
	29
	30	See also:
	31	:ref:`OMP_PROC_BIND`, :ref:`OMP_PLACES`, :ref:`GOMP_CPU_AFFINITY`,
	32
	33	Reference:
3ed1b4ce	34	:openmp:`4.5`, Section 3.2.22.