3.2.44  omp_pause_resource_all

Summary The omp_pause_resource_all routine allows the runtime to relinquish resources used by OpenMP on all devices.

Format

 
int omp_pause_resource_all(omp_pause_resource_t kind);
  

 
integer function omp_pause_resource_all(kind) 
integer (kind=omp_pause_resource_kind) kind
  

BindingThe binding task set for an omp_pause_resource_all region is the whole program.

EffectThe omp_pause_resource_all routine allows the runtime to relinquish resources used by OpenMP on all devices. It is equivalent to calling the omp_pause_resource routine once for each available device, including the host device. The argument kind passed to this routine can be one of the valid OpenMP pause kind as defined in Section 3.2.43 on page 1144, or any implementation specific pause kind.

Tool CallbacksIf the tool is not allowed to interact with a given device after encountering this call, then the runtime must call the tool finalizer for that device.

RestrictionsThe omp_pause_resource_all routine has the following restrictions:

• The omp_pause_resource_all region may not be nested in any explicit OpenMP region.
• The routine may only be called when all explicit tasks have finalized execution. Calling the routine in any other circumstances may result in unspecified behavior.

Cross References

• target construct, see Section 2.12.5 on page 478
• declare target directive, see Section 2.12.7 on page 513
• omp_get_num_devices, see Section 3.2.36 on page 1127.
• omp_get_get_initial_device routine, see Section 3.2.41 on page 1139.
• To pause resources on a specific device only, see Section 3.2.43 on page 1144.