# OpenMP* Run-time Library Routines

OpenMP* provides run-time library routines to help you manage your program in parallel mode. Many of these run-time library routines have corresponding environment variables that can be set as defaults. The run-time library routines let you dynamically change these factors to assist in controlling your program. In all cases, a call to a run-time library routine overrides any corresponding environment variable.

### CAUTION

Running OpenMP runtime library routines may initialize the OpenMP runtime environment, which might cause a situation where subsequent programmatic setting of OpenMP environment variables has no effect. To avoid this situation, you can use the Intel extension routine `kmp_set_defaults()` to set OpenMP environment variables.

The compiler supports all the OpenMP* run-time library routines. Refer to the OpenMP* API specification for detailed information about using these routines.

Include the appropriate declarations of the routines in your source code by adding a statement similar to the following:

Example
    #include <omp.h>

The header files are provided in the ../include (Linux*) or ..\include (Windows*) directory of your compiler installation.

### Note

Some of the routines interfaces have offload equivalents. The offload equivalent takes two additional arguments to specify the target type and target number. For more information, see Calling Functions on the CPU to Modify the Coprocessor's Execution Environment.

## Execution Environment Routines

Use these routines to monitor and influence threads and the parallel environment.

Routine | Description
--- | ---
`void omp_set_num_threads(int nthreads)` | Sets the number of threads to use for subsequent parallel regions created by the calling thread.
`void omp_set_dynamic(int dynamic_threads)` | Enables or disables dynamic adjustment of the number of threads used to execute a parallel region. If dynamic_threads is TRUE, dynamic threads are enabled. If dynamic_threads is FALSE, dynamic threads are disabled. Dynamic threads are disabled by default.
`void omp_set_nested(int nested)` | Enables or disables nested parallelism. If nested is TRUE, nested parallelism is enabled. If nested is FALSE, nested parallelism is disabled. Nested parallelism is disabled by default.
`int omp_get_num_threads(void)` | Returns the number of threads that are being used in the current parallel region. This function does not necessarily return the value inherited by the calling thread from the omp_set_num_threads() function.
`int omp_get_max_threads(void)` | Returns the number of threads available to subsequent parallel regions created by the calling thread.
`int omp_get_thread_num(void)` | Returns the thread number of the calling thread, within the context of the current parallel region.
`int omp_get_num_procs(void)` | Returns the number of processors available to the program.
`int omp_in_parallel(void)` | Returns TRUE if called within the dynamic extent of a parallel region executing in parallel; otherwise returns FALSE.
`int omp_in_final(void)` | Returns TRUE if called within a final task region; otherwise returns FALSE.
`int omp_get_dynamic(void)` | Returns TRUE if dynamic thread adjustment is enabled, otherwise returns FALSE.
`int omp_get_nested(void)` | Returns TRUE if nested parallelism is enabled, otherwise returns FALSE.
`int omp_get_thread_limit(void)` | Returns the maximum number of simultaneously executing threads in an OpenMP* program.
`void omp_set_max_active_levels(int max_active_levels)` | Limits the number of nested active parallel regions. The call is ignored if negative max_active_levels specified.
`int omp_get_max_active_levels(void)` | Returns the maximum number of nested active parallel regions.
`int omp_get_level(void)` | Returns the number of nested parallel regions (whether active or inactive) enclosing the task that contains the call, not including the implicit parallel region.
`int omp_get_active_level(void)` | Returns the number of nested, active parallel regions enclosing the task that contains the call.
`int omp_get_ancestor_thread_num(int level)` | Returns the thread number of the ancestor at a given nest level of the current thread.
`int omp_get_team_size(int level)` | Returns the size of the thread team to which the ancestor of the given level belongs.
`void omp_set_schedule(omp_sched_t kind,int chunk_size)` | Determines the schedule of a worksharing loop that is applied when '`runtime`' is used as the schedule kind.
`void omp_get_schedule(omp_sched_kind *kind,int *chunk_size)` | Returns the schedule of a worksharing loop that is applied when the '`runtime`' schedule is used.
`omp_proc_bind_t omp_get_proc_bind(void);` | Returns the currently active thread affinity policy, which is set by environment variable OMP_PROC_BIND. This policy is used for subsequent nested parallel regions.
`int omp_get_num_places(void);` | Returns the number of places available to the execution environment in the place list of the initial task, usually threads, cores, or sockets.
`int omp_get_place_num_procs(int place_num)` | Returns the number of processors associated with the place numbered `place_num`. The routine returns zero when `place_num` is negative or is greater than or equal to omp_get_num_places().
`void omp_get_place_proc_ids(int place_num, int *ids)` | Returns the numerical identifiers of each processor associated with the place numbered place_num. The numerical identifiers are non-negative and their meaning is implementation defined. The numerical identifiers are returned in the array ids and their order in the array is implementation defined. ids must have at least omp_get_place_num_procs(place_num) elements. The routine has no effect when `place_num` is greater than or equal to omp_get_num_places().
`int omp_get_place_num(void)` | Returns the place number of the place to which the encountering thread is bound. The returned value is between 0 and omp_get_num_places() - 1, inclusive. When the encountering thread is not bound to a place, the routine returns -1.
`int omp_get_default_device(void);` | Returns the default device number.
`void omp_set_default_device(int device_number);` | Sets the default device number.
`int omp_get_num_devices(void);` | Gets the number of target devices.
`int omp_get_num_teams(void);` | Gets the number of teams in the current teams region.
`int omp_get_team_num(void);` | Gets the team number of the calling thread.
`int omp_get_cancellation(void);` | Returns TRUE if cancellation is enabled; otherwise, FALSE. This routine can be affected by the setting for environment variable OMP_CANCELLATION.
`int omp_is_initial_device(void);` | Returns TRUE if the current task is running on the host device; otherwise, FALSE.
`int omp_get_initial_device(void);` | Returns the device number of the host device. The value of the device number is implementation defined. If it is between 0 and omp_get_num_devices()-1, then it is valid in all device constructs and routines; if it is outside that range, then it is only valid in the device memory routines and not in the device clause.
`int omp_get_max_task_priority(void);` | Returns the maximum value that can be specified in the priority clause.
`void * omp_target_alloc(size_t size, int device_num)` | Returns a storage location's device address, where the size of the location is measured in bytes.
`void omp_target_free(void *device_ptr, int device_num)` | Frees device memory that was allocated by the omp_target_alloc.
`int omp_target_is_present(void *ptr, int device_num)` | Returns TRUE if the specified pointer is found on the device specified by device_num by a map clause. Otherwise, it returns FALSE.
`int omp_target_memcpy(void *dst, void *src, size_t length, size_t dst_offset, size_t src_offset, int dst_device, int src_device)` | This routine copies length bytes of memory at offset src_offset from src in the device data environment of device src_device_num to dst, starting at offset dst_offset in the device data environment of the device specified by dst_device_num. Returns zero on success and a non-zero value on failure. Use omp_get_initial_device to return a the device number you can use to reference the host device and host device data environment. This routine includes a task scheduling point. The effect of this routine is unspecified when it is called from within a target region.
`int omp_target_memcpy_rect( void *dst, void *src,size_t element_size,int num_dims,const size_t *volume, const size_t *dst_offsets,const size_t *src_offsets, const size_t *dst_dimensions, const size_t *src_dimensions,int dst_device_num, int src_device_num)` | This routine copies a rectangular subvolume of src, in the device data environment of the device specified by src_device_num, to dst, in the device data environment of the device specified by dst_device_num. Specify the volume in terms of the size of an element, the number of its dimensions, and constant arrays of length num_dims. The maximum number of dimensions supported is three or more. The volume array specifies the length, in number of elements, to copy in each dimension from src to dst. The dst_offsets and src_offsets parameters specify the number of elements from the origin of dst and src, in elements. The dst_dimensions and src_dimensions parameters specify the length of each dimension of dst and src. The routine returns zero if successful. If both dst and src are NULL pointers, the routine returns the number of dimensions supported by the implementation for the specified device numbers. You can use the device number returned by omp_get_initial_device to reference the host device and host device data environment. Otherwise, it returns a non-zero value. This routine contains a task scheduling point. The effect of this routine is unspecified when called from within a target region.
`int omp_target_associate_ptr(void *host_ptr, void *device_ptr, size_t size, size_t device_offset, int device_num)` | Maps a device pointer, which might be returned by omp_target_alloc, to a host pointer.

## Lock Routines

Use these routines to affect OpenMP* locks.

Function | Description
--- | ---
`void omp_init_lock(omp_lock_t svar)` | Initializes the lock associated with the simple lock variable svar for use in subsequent calls.
`void omp_init_lock_with_hint(omp_lock_t *svar, omp_lock_hint_t hint)` | Initializes the lock associated with svar to the unlocked state, optionally choosing a specific lock implementation based on hint.
`void omp_destroy_lock(omp_lock_t svar)` | Causes the lock specified by svar to become undefined or uninitialized.
`void omp_set_lock(omp_lock_t svar)` | Forces the executing thread to wait until the lock associated with svar is available. The thread is granted ownership of the lock when it becomes available.
`void omp_unset_lock(omp_lock_t svar)` | Releases the executing thread from ownership of the lock associated with svar. The behavior is undefined if the executing thread does not own the lock associated with svar.
`int omp_test_lock(omp_lock_t svar)` | Attempts to set the lock associated with svar. If successful, returns TRUE, otherwise returns FALSE.
`void omp_init_nest_lock(omp_nest_lock_t nvar)` | Initializes the nested lock associated with the nested lock variable nvar for use in the subsequent calls.
`void omp_init_lock_with_hint(omp_lock_t *nvar, omp_lock_hint_t hint);void omp_init_nest_lock_with_hint(omp_nest_lock_t *nvar, omp_lock_hint_t hint);` | Initializes the nested lock associated with nvar to the unlocked state, optionally choosing a specific lock implementation based on hint. The nesting count for nvar is set to zero.
`void omp_destroy_nest_lock(omp_nest_lock_t nvar)` | Causes the nested lock associated with nvar to become undefined or uninitialized.
`void omp_set_nest_lock(omp_nest_lock_t nvar)` | Forces the executing thread to wait until the nested lock associated with nvar is available. If the thread already owns the lock, then the lock nesting count is incremented.
`void omp_unset_nest_lock(omp_nest_lock_t lock)` | Releases the executing thread from ownership of the nested lock associated with nvar if the nesting count is zero; otherwise, the nesting count is decremented. Behavior is undefined if the executing thread does not own the nested lock associated with nvar.
`int omp_test_nest_lock(omp_nest_lock_t lock)` | Attempts to set the nested lock specified by nvar. If successful, returns the nesting count, otherwise returns zero.

## Timing Routines

Function | Description
--- | ---
`double omp_get_wtime(void)` | Returns a double precision value equal to the elapsed wall clock time (in seconds) relative to an arbitrary reference time. The reference time does not change during program execution.
`double omp_get_wtick(void)` | Returns a double precision value equal to the number of seconds between successive clock ticks.

    integer (omp_lock_hint_kind), parameter :: omp_lock_hint_none           = 0
    integer (omp_lock_hint_kind), parameter :: omp_lock_hint_uncontended    = 1
    integer (omp_lock_hint_kind), parameter :: omp_lock_hint_contended      = 2
    integer (omp_lock_hint_kind), parameter :: omp_lock_hint_nonspeculative = 4
    integer (omp_lock_hint_kind), parameter :: omp_lock_hint_speculative    = 8

Parent topic: OpenMP* Library Support

## See Also

Intel Extension Routines to OpenMP*