[thirdparty/gcc.git] / libgomp / doc / openmp-environment-variables / omptargetoffload.rst

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

.. index:: Environment Variable, Implementation specific setting

.. _omp_target_offload:

OMP_TARGET_OFFLOAD -- Controls offloading behaviour
***************************************************

Description:
  Specifies the behaviour with regard to offloading code to a device.  This
  variable can be set to one of three values - ``MANDATORY``, ``DISABLED``
  or ``DEFAULT``.

  If set to ``MANDATORY``, the program will terminate with an error if
  the offload device is not present or is not supported.  If set to
  ``DISABLED``, then offloading is disabled and all code will run on the
  host. If set to ``DEFAULT``, the program will try offloading to the
  device first, then fall back to running code on the host if it cannot.

  If undefined, then the program will behave as if ``DEFAULT`` was set.

Reference:
  :openmp:`5.0`, Section 6.17
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	.. index:: Environment Variable, Implementation specific setting
	7
	8	.. _omp_target_offload:
	9
	10	OMP_TARGET_OFFLOAD -- Controls offloading behaviour
	11	***************************************************
	12
	13	Description:
	14	Specifies the behaviour with regard to offloading code to a device. This
	15	variable can be set to one of three values - ``MANDATORY``, ``DISABLED``
	16	or ``DEFAULT``.
	17
	18	If set to ``MANDATORY``, the program will terminate with an error if
	19	the offload device is not present or is not supported. If set to
	20	``DISABLED``, then offloading is disabled and all code will run on the
	21	host. If set to ``DEFAULT``, the program will try offloading to the
	22	device first, then fall back to running code on the host if it cannot.
	23
	24	If undefined, then the program will behave as if ``DEFAULT`` was set.
	25
	26	Reference:
3ed1b4ce	27	:openmp:`5.0`, Section 6.17