xref: /freebsd/contrib/llvm-project/openmp/runtime/src/include/omp.h.var (revision 7ef62cebc2f965b0f640263e179276928885e33d)
1/*
2 * include/omp.h.var
3 */
4
5
6//===----------------------------------------------------------------------===//
7//
8// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
9// See https://llvm.org/LICENSE.txt for license information.
10// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
11//
12//===----------------------------------------------------------------------===//
13
14
15#ifndef __OMP_H
16#   define __OMP_H
17
18#   include <stdlib.h>
19#   include <stdint.h>
20
21#   define KMP_VERSION_MAJOR    @LIBOMP_VERSION_MAJOR@
22#   define KMP_VERSION_MINOR    @LIBOMP_VERSION_MINOR@
23#   define KMP_VERSION_BUILD    @LIBOMP_VERSION_BUILD@
24#   define KMP_BUILD_DATE       "@LIBOMP_BUILD_DATE@"
25
26#   ifdef __cplusplus
27    extern "C" {
28#   endif
29
30#   define omp_set_affinity_format   ompc_set_affinity_format
31#   define omp_get_affinity_format   ompc_get_affinity_format
32#   define omp_display_affinity      ompc_display_affinity
33#   define omp_capture_affinity      ompc_capture_affinity
34
35#   if defined(_WIN32)
36#       define __KAI_KMPC_CONVENTION __cdecl
37#       ifndef __KMP_IMP
38#           define __KMP_IMP __declspec(dllimport)
39#       endif
40#   else
41#       define __KAI_KMPC_CONVENTION
42#       ifndef __KMP_IMP
43#           define __KMP_IMP
44#       endif
45#   endif
46
47    /* schedule kind constants */
48    typedef enum omp_sched_t {
49        omp_sched_static  = 1,
50        omp_sched_dynamic = 2,
51        omp_sched_guided  = 3,
52        omp_sched_auto    = 4,
53        omp_sched_monotonic = 0x80000000
54    } omp_sched_t;
55
56    /* set API functions */
57    extern void   __KAI_KMPC_CONVENTION  omp_set_num_threads (int);
58    extern void   __KAI_KMPC_CONVENTION  omp_set_dynamic     (int);
59    extern void   __KAI_KMPC_CONVENTION  omp_set_nested      (int);
60    extern void   __KAI_KMPC_CONVENTION  omp_set_max_active_levels (int);
61    extern void   __KAI_KMPC_CONVENTION  omp_set_schedule          (omp_sched_t, int);
62
63    /* query API functions */
64    extern int    __KAI_KMPC_CONVENTION  omp_get_num_threads  (void);
65    extern int    __KAI_KMPC_CONVENTION  omp_get_dynamic      (void);
66    extern int    __KAI_KMPC_CONVENTION  omp_get_nested       (void);
67    extern int    __KAI_KMPC_CONVENTION  omp_get_max_threads  (void);
68    extern int    __KAI_KMPC_CONVENTION  omp_get_thread_num   (void);
69    extern int    __KAI_KMPC_CONVENTION  omp_get_num_procs    (void);
70    extern int    __KAI_KMPC_CONVENTION  omp_in_parallel      (void);
71    extern int    __KAI_KMPC_CONVENTION  omp_in_final         (void);
72    extern int    __KAI_KMPC_CONVENTION  omp_get_active_level        (void);
73    extern int    __KAI_KMPC_CONVENTION  omp_get_level               (void);
74    extern int    __KAI_KMPC_CONVENTION  omp_get_ancestor_thread_num (int);
75    extern int    __KAI_KMPC_CONVENTION  omp_get_team_size           (int);
76    extern int    __KAI_KMPC_CONVENTION  omp_get_thread_limit        (void);
77    extern int    __KAI_KMPC_CONVENTION  omp_get_max_active_levels   (void);
78    extern void   __KAI_KMPC_CONVENTION  omp_get_schedule            (omp_sched_t *, int *);
79    extern int    __KAI_KMPC_CONVENTION  omp_get_max_task_priority   (void);
80
81    /* lock API functions */
82    typedef struct omp_lock_t {
83        void * _lk;
84    } omp_lock_t;
85
86    extern void   __KAI_KMPC_CONVENTION  omp_init_lock    (omp_lock_t *);
87    extern void   __KAI_KMPC_CONVENTION  omp_set_lock     (omp_lock_t *);
88    extern void   __KAI_KMPC_CONVENTION  omp_unset_lock   (omp_lock_t *);
89    extern void   __KAI_KMPC_CONVENTION  omp_destroy_lock (omp_lock_t *);
90    extern int    __KAI_KMPC_CONVENTION  omp_test_lock    (omp_lock_t *);
91
92    /* nested lock API functions */
93    typedef struct omp_nest_lock_t {
94        void * _lk;
95    } omp_nest_lock_t;
96
97    extern void   __KAI_KMPC_CONVENTION  omp_init_nest_lock    (omp_nest_lock_t *);
98    extern void   __KAI_KMPC_CONVENTION  omp_set_nest_lock     (omp_nest_lock_t *);
99    extern void   __KAI_KMPC_CONVENTION  omp_unset_nest_lock   (omp_nest_lock_t *);
100    extern void   __KAI_KMPC_CONVENTION  omp_destroy_nest_lock (omp_nest_lock_t *);
101    extern int    __KAI_KMPC_CONVENTION  omp_test_nest_lock    (omp_nest_lock_t *);
102
103    /* OpenMP 5.0  Synchronization hints*/
104    typedef enum omp_sync_hint_t {
105        omp_sync_hint_none           = 0,
106        omp_lock_hint_none           = omp_sync_hint_none,
107        omp_sync_hint_uncontended    = 1,
108        omp_lock_hint_uncontended    = omp_sync_hint_uncontended,
109        omp_sync_hint_contended      = (1<<1),
110        omp_lock_hint_contended      = omp_sync_hint_contended,
111        omp_sync_hint_nonspeculative = (1<<2),
112        omp_lock_hint_nonspeculative = omp_sync_hint_nonspeculative,
113        omp_sync_hint_speculative    = (1<<3),
114        omp_lock_hint_speculative    = omp_sync_hint_speculative,
115        kmp_lock_hint_hle            = (1<<16),
116        kmp_lock_hint_rtm            = (1<<17),
117        kmp_lock_hint_adaptive       = (1<<18)
118    } omp_sync_hint_t;
119
120    /* lock hint type for dynamic user lock */
121    typedef omp_sync_hint_t omp_lock_hint_t;
122
123    /* hinted lock initializers */
124    extern void __KAI_KMPC_CONVENTION omp_init_lock_with_hint(omp_lock_t *, omp_lock_hint_t);
125    extern void __KAI_KMPC_CONVENTION omp_init_nest_lock_with_hint(omp_nest_lock_t *, omp_lock_hint_t);
126
127    /* time API functions */
128    extern double __KAI_KMPC_CONVENTION  omp_get_wtime (void);
129    extern double __KAI_KMPC_CONVENTION  omp_get_wtick (void);
130
131    /* OpenMP 4.0 */
132    extern int  __KAI_KMPC_CONVENTION  omp_get_default_device (void);
133    extern void __KAI_KMPC_CONVENTION  omp_set_default_device (int);
134    extern int  __KAI_KMPC_CONVENTION  omp_is_initial_device (void);
135    extern int  __KAI_KMPC_CONVENTION  omp_get_num_devices (void);
136    extern int  __KAI_KMPC_CONVENTION  omp_get_num_teams (void);
137    extern int  __KAI_KMPC_CONVENTION  omp_get_team_num (void);
138    extern int  __KAI_KMPC_CONVENTION  omp_get_cancellation (void);
139
140    /* OpenMP 4.5 */
141    extern int   __KAI_KMPC_CONVENTION  omp_get_initial_device (void);
142    extern void* __KAI_KMPC_CONVENTION  omp_target_alloc(size_t, int);
143    extern void  __KAI_KMPC_CONVENTION  omp_target_free(void *, int);
144    extern int   __KAI_KMPC_CONVENTION  omp_target_is_present(const void *, int);
145    extern int   __KAI_KMPC_CONVENTION  omp_target_memcpy(void *, const void *, size_t, size_t, size_t, int, int);
146    extern int   __KAI_KMPC_CONVENTION  omp_target_memcpy_rect(void *, const void *, size_t, int, const size_t *,
147                                            const size_t *, const size_t *, const size_t *, const size_t *, int, int);
148    extern int   __KAI_KMPC_CONVENTION  omp_target_associate_ptr(const void *, const void *, size_t, size_t, int);
149    extern int   __KAI_KMPC_CONVENTION  omp_target_disassociate_ptr(const void *, int);
150
151    /* OpenMP 5.0 */
152    extern int   __KAI_KMPC_CONVENTION  omp_get_device_num (void);
153    typedef void * omp_depend_t;
154
155    /* OpenMP 5.1 interop */
156    typedef intptr_t omp_intptr_t;
157
158    /* 0..omp_get_num_interop_properties()-1 are reserved for implementation-defined properties */
159    typedef enum omp_interop_property {
160        omp_ipr_fr_id = -1,
161        omp_ipr_fr_name = -2,
162        omp_ipr_vendor = -3,
163        omp_ipr_vendor_name = -4,
164        omp_ipr_device_num = -5,
165        omp_ipr_platform = -6,
166        omp_ipr_device = -7,
167        omp_ipr_device_context = -8,
168        omp_ipr_targetsync = -9,
169        omp_ipr_first = -9
170    } omp_interop_property_t;
171
172    #define omp_interop_none 0
173
174    typedef enum omp_interop_rc {
175        omp_irc_no_value = 1,
176        omp_irc_success = 0,
177        omp_irc_empty = -1,
178        omp_irc_out_of_range = -2,
179        omp_irc_type_int = -3,
180        omp_irc_type_ptr = -4,
181        omp_irc_type_str = -5,
182        omp_irc_other = -6
183    } omp_interop_rc_t;
184
185    typedef enum omp_interop_fr {
186        omp_ifr_cuda = 1,
187        omp_ifr_cuda_driver = 2,
188        omp_ifr_opencl = 3,
189        omp_ifr_sycl = 4,
190        omp_ifr_hip = 5,
191        omp_ifr_level_zero = 6,
192        omp_ifr_last = 7
193    } omp_interop_fr_t;
194
195    typedef void * omp_interop_t;
196
197    /*!
198     * The `omp_get_num_interop_properties` routine retrieves the number of implementation-defined properties available for an `omp_interop_t` object.
199     */
200    extern int          __KAI_KMPC_CONVENTION  omp_get_num_interop_properties(const omp_interop_t);
201    /*!
202     * The `omp_get_interop_int` routine retrieves an integer property from an `omp_interop_t` object.
203     */
204    extern omp_intptr_t __KAI_KMPC_CONVENTION  omp_get_interop_int(const omp_interop_t, omp_interop_property_t, int *);
205    /*!
206     * The `omp_get_interop_ptr` routine retrieves a pointer property from an `omp_interop_t` object.
207     */
208    extern void *       __KAI_KMPC_CONVENTION  omp_get_interop_ptr(const omp_interop_t, omp_interop_property_t, int *);
209    /*!
210     * The `omp_get_interop_str` routine retrieves a string property from an `omp_interop_t` object.
211     */
212    extern const char * __KAI_KMPC_CONVENTION  omp_get_interop_str(const omp_interop_t, omp_interop_property_t, int *);
213    /*!
214     * The `omp_get_interop_name` routine retrieves a property name from an `omp_interop_t` object.
215     */
216    extern const char * __KAI_KMPC_CONVENTION  omp_get_interop_name(const omp_interop_t, omp_interop_property_t);
217    /*!
218     * The `omp_get_interop_type_desc` routine retrieves a description of the type of a property associated with an `omp_interop_t` object.
219     */
220    extern const char * __KAI_KMPC_CONVENTION  omp_get_interop_type_desc(const omp_interop_t, omp_interop_property_t);
221    /*!
222     * The `omp_get_interop_rc_desc` routine retrieves a description of the return code associated with an `omp_interop_t` object.
223     */
224    extern const char * __KAI_KMPC_CONVENTION  omp_get_interop_rc_desc(const omp_interop_t, omp_interop_rc_t);
225
226    /* OpenMP 5.1 device memory routines */
227
228    /*!
229     * The `omp_target_memcpy_async` routine asynchronously performs a copy between any combination of host and device pointers.
230     */
231    extern int    __KAI_KMPC_CONVENTION  omp_target_memcpy_async(void *, const void *, size_t, size_t, size_t, int,
232                                             int, int, omp_depend_t *);
233    /*!
234     * The `omp_target_memcpy_rect_async` routine asynchronously performs a copy between any combination of host and device pointers.
235     */
236    extern int    __KAI_KMPC_CONVENTION  omp_target_memcpy_rect_async(void *, const void *, size_t, int, const size_t *,
237                                             const size_t *, const size_t *, const size_t *, const size_t *, int, int,
238                                             int, omp_depend_t *);
239    /*!
240     * The `omp_get_mapped_ptr` routine returns the device pointer that is associated with a host pointer for a given device.
241     */
242    extern void * __KAI_KMPC_CONVENTION  omp_get_mapped_ptr(const void *, int);
243    extern int    __KAI_KMPC_CONVENTION  omp_target_is_accessible(const void *, size_t, int);
244
245    /* kmp API functions */
246    extern int    __KAI_KMPC_CONVENTION  kmp_get_stacksize          (void);
247    extern void   __KAI_KMPC_CONVENTION  kmp_set_stacksize          (int);
248    extern size_t __KAI_KMPC_CONVENTION  kmp_get_stacksize_s        (void);
249    extern void   __KAI_KMPC_CONVENTION  kmp_set_stacksize_s        (size_t);
250    extern int    __KAI_KMPC_CONVENTION  kmp_get_blocktime          (void);
251    extern int    __KAI_KMPC_CONVENTION  kmp_get_library            (void);
252    extern void   __KAI_KMPC_CONVENTION  kmp_set_blocktime          (int);
253    extern void   __KAI_KMPC_CONVENTION  kmp_set_library            (int);
254    extern void   __KAI_KMPC_CONVENTION  kmp_set_library_serial     (void);
255    extern void   __KAI_KMPC_CONVENTION  kmp_set_library_turnaround (void);
256    extern void   __KAI_KMPC_CONVENTION  kmp_set_library_throughput (void);
257    extern void   __KAI_KMPC_CONVENTION  kmp_set_defaults           (char const *);
258    extern void   __KAI_KMPC_CONVENTION  kmp_set_disp_num_buffers   (int);
259
260    /* Intel affinity API */
261    typedef void * kmp_affinity_mask_t;
262
263    extern int    __KAI_KMPC_CONVENTION  kmp_set_affinity             (kmp_affinity_mask_t *);
264    extern int    __KAI_KMPC_CONVENTION  kmp_get_affinity             (kmp_affinity_mask_t *);
265    extern int    __KAI_KMPC_CONVENTION  kmp_get_affinity_max_proc    (void);
266    extern void   __KAI_KMPC_CONVENTION  kmp_create_affinity_mask     (kmp_affinity_mask_t *);
267    extern void   __KAI_KMPC_CONVENTION  kmp_destroy_affinity_mask    (kmp_affinity_mask_t *);
268    extern int    __KAI_KMPC_CONVENTION  kmp_set_affinity_mask_proc   (int, kmp_affinity_mask_t *);
269    extern int    __KAI_KMPC_CONVENTION  kmp_unset_affinity_mask_proc (int, kmp_affinity_mask_t *);
270    extern int    __KAI_KMPC_CONVENTION  kmp_get_affinity_mask_proc   (int, kmp_affinity_mask_t *);
271
272    /* OpenMP 4.0 affinity API */
273    typedef enum omp_proc_bind_t {
274        omp_proc_bind_false = 0,
275        omp_proc_bind_true = 1,
276        omp_proc_bind_master = 2,
277        omp_proc_bind_close = 3,
278        omp_proc_bind_spread = 4
279    } omp_proc_bind_t;
280
281    extern omp_proc_bind_t __KAI_KMPC_CONVENTION omp_get_proc_bind (void);
282
283    /* OpenMP 4.5 affinity API */
284    extern int  __KAI_KMPC_CONVENTION omp_get_num_places (void);
285    extern int  __KAI_KMPC_CONVENTION omp_get_place_num_procs (int);
286    extern void __KAI_KMPC_CONVENTION omp_get_place_proc_ids (int, int *);
287    extern int  __KAI_KMPC_CONVENTION omp_get_place_num (void);
288    extern int  __KAI_KMPC_CONVENTION omp_get_partition_num_places (void);
289    extern void __KAI_KMPC_CONVENTION omp_get_partition_place_nums (int *);
290
291    extern void * __KAI_KMPC_CONVENTION  kmp_malloc  (size_t);
292    extern void * __KAI_KMPC_CONVENTION  kmp_aligned_malloc  (size_t, size_t);
293    extern void * __KAI_KMPC_CONVENTION  kmp_calloc  (size_t, size_t);
294    extern void * __KAI_KMPC_CONVENTION  kmp_realloc (void *, size_t);
295    extern void   __KAI_KMPC_CONVENTION  kmp_free    (void *);
296
297    extern void   __KAI_KMPC_CONVENTION  kmp_set_warnings_on(void);
298    extern void   __KAI_KMPC_CONVENTION  kmp_set_warnings_off(void);
299
300    /* OpenMP 5.0 Tool Control */
301    typedef enum omp_control_tool_result_t {
302        omp_control_tool_notool = -2,
303        omp_control_tool_nocallback = -1,
304        omp_control_tool_success = 0,
305        omp_control_tool_ignored = 1
306    } omp_control_tool_result_t;
307
308    typedef enum omp_control_tool_t {
309        omp_control_tool_start = 1,
310        omp_control_tool_pause = 2,
311        omp_control_tool_flush = 3,
312        omp_control_tool_end = 4
313    } omp_control_tool_t;
314
315    extern int __KAI_KMPC_CONVENTION omp_control_tool(int, int, void*);
316
317    /* OpenMP 5.0 Memory Management */
318    typedef uintptr_t omp_uintptr_t;
319
320    typedef enum {
321        omp_atk_sync_hint = 1,
322        omp_atk_alignment = 2,
323        omp_atk_access = 3,
324        omp_atk_pool_size = 4,
325        omp_atk_fallback = 5,
326        omp_atk_fb_data = 6,
327        omp_atk_pinned = 7,
328        omp_atk_partition = 8
329    } omp_alloctrait_key_t;
330
331    typedef enum {
332        omp_atv_false = 0,
333        omp_atv_true = 1,
334        omp_atv_contended = 3,
335        omp_atv_uncontended = 4,
336        omp_atv_serialized = 5,
337        omp_atv_sequential = omp_atv_serialized, // (deprecated)
338        omp_atv_private = 6,
339        omp_atv_all = 7,
340        omp_atv_thread = 8,
341        omp_atv_pteam = 9,
342        omp_atv_cgroup = 10,
343        omp_atv_default_mem_fb = 11,
344        omp_atv_null_fb = 12,
345        omp_atv_abort_fb = 13,
346        omp_atv_allocator_fb = 14,
347        omp_atv_environment = 15,
348        omp_atv_nearest = 16,
349        omp_atv_blocked = 17,
350        omp_atv_interleaved = 18
351    } omp_alloctrait_value_t;
352    #define omp_atv_default ((omp_uintptr_t)-1)
353
354    typedef struct {
355        omp_alloctrait_key_t key;
356        omp_uintptr_t value;
357    } omp_alloctrait_t;
358
359#   if defined(_WIN32)
360    // On Windows cl and icl do not support 64-bit enum, let's use integer then.
361    typedef omp_uintptr_t omp_allocator_handle_t;
362    extern __KMP_IMP omp_allocator_handle_t const omp_null_allocator;
363    extern __KMP_IMP omp_allocator_handle_t const omp_default_mem_alloc;
364    extern __KMP_IMP omp_allocator_handle_t const omp_large_cap_mem_alloc;
365    extern __KMP_IMP omp_allocator_handle_t const omp_const_mem_alloc;
366    extern __KMP_IMP omp_allocator_handle_t const omp_high_bw_mem_alloc;
367    extern __KMP_IMP omp_allocator_handle_t const omp_low_lat_mem_alloc;
368    extern __KMP_IMP omp_allocator_handle_t const omp_cgroup_mem_alloc;
369    extern __KMP_IMP omp_allocator_handle_t const omp_pteam_mem_alloc;
370    extern __KMP_IMP omp_allocator_handle_t const omp_thread_mem_alloc;
371    extern __KMP_IMP omp_allocator_handle_t const llvm_omp_target_host_mem_alloc;
372    extern __KMP_IMP omp_allocator_handle_t const llvm_omp_target_shared_mem_alloc;
373    extern __KMP_IMP omp_allocator_handle_t const llvm_omp_target_device_mem_alloc;
374
375    typedef omp_uintptr_t omp_memspace_handle_t;
376    extern __KMP_IMP omp_memspace_handle_t const omp_default_mem_space;
377    extern __KMP_IMP omp_memspace_handle_t const omp_large_cap_mem_space;
378    extern __KMP_IMP omp_memspace_handle_t const omp_const_mem_space;
379    extern __KMP_IMP omp_memspace_handle_t const omp_high_bw_mem_space;
380    extern __KMP_IMP omp_memspace_handle_t const omp_low_lat_mem_space;
381    extern __KMP_IMP omp_memspace_handle_t const llvm_omp_target_host_mem_space;
382    extern __KMP_IMP omp_memspace_handle_t const llvm_omp_target_shared_mem_space;
383    extern __KMP_IMP omp_memspace_handle_t const llvm_omp_target_device_mem_space;
384#   else
385#       if __cplusplus >= 201103
386    typedef enum omp_allocator_handle_t : omp_uintptr_t
387#       else
388    typedef enum omp_allocator_handle_t
389#       endif
390    {
391      omp_null_allocator = 0,
392      omp_default_mem_alloc = 1,
393      omp_large_cap_mem_alloc = 2,
394      omp_const_mem_alloc = 3,
395      omp_high_bw_mem_alloc = 4,
396      omp_low_lat_mem_alloc = 5,
397      omp_cgroup_mem_alloc = 6,
398      omp_pteam_mem_alloc = 7,
399      omp_thread_mem_alloc = 8,
400      llvm_omp_target_host_mem_alloc = 100,
401      llvm_omp_target_shared_mem_alloc = 101,
402      llvm_omp_target_device_mem_alloc = 102,
403      KMP_ALLOCATOR_MAX_HANDLE = UINTPTR_MAX
404    } omp_allocator_handle_t;
405#       if __cplusplus >= 201103
406    typedef enum omp_memspace_handle_t : omp_uintptr_t
407#       else
408    typedef enum omp_memspace_handle_t
409#       endif
410    {
411      omp_default_mem_space = 0,
412      omp_large_cap_mem_space = 1,
413      omp_const_mem_space = 2,
414      omp_high_bw_mem_space = 3,
415      omp_low_lat_mem_space = 4,
416      llvm_omp_target_host_mem_space = 100,
417      llvm_omp_target_shared_mem_space = 101,
418      llvm_omp_target_device_mem_space = 102,
419      KMP_MEMSPACE_MAX_HANDLE = UINTPTR_MAX
420    } omp_memspace_handle_t;
421#   endif
422    extern omp_allocator_handle_t __KAI_KMPC_CONVENTION omp_init_allocator(omp_memspace_handle_t m,
423                                                       int ntraits, omp_alloctrait_t traits[]);
424    extern void __KAI_KMPC_CONVENTION omp_destroy_allocator(omp_allocator_handle_t allocator);
425
426    extern void __KAI_KMPC_CONVENTION omp_set_default_allocator(omp_allocator_handle_t a);
427    extern omp_allocator_handle_t __KAI_KMPC_CONVENTION omp_get_default_allocator(void);
428#   ifdef __cplusplus
429    extern void *__KAI_KMPC_CONVENTION omp_alloc(size_t size, omp_allocator_handle_t a = omp_null_allocator);
430    extern void *__KAI_KMPC_CONVENTION omp_aligned_alloc(size_t align, size_t size,
431                                                         omp_allocator_handle_t a = omp_null_allocator);
432    extern void *__KAI_KMPC_CONVENTION omp_calloc(size_t nmemb, size_t size,
433                                                  omp_allocator_handle_t a = omp_null_allocator);
434    extern void *__KAI_KMPC_CONVENTION omp_aligned_calloc(size_t align, size_t nmemb, size_t size,
435                                                          omp_allocator_handle_t a = omp_null_allocator);
436    extern void *__KAI_KMPC_CONVENTION omp_realloc(void *ptr, size_t size,
437                                                   omp_allocator_handle_t allocator = omp_null_allocator,
438                                                   omp_allocator_handle_t free_allocator = omp_null_allocator);
439    extern void __KAI_KMPC_CONVENTION omp_free(void * ptr, omp_allocator_handle_t a = omp_null_allocator);
440#   else
441    extern void *__KAI_KMPC_CONVENTION omp_alloc(size_t size, omp_allocator_handle_t a);
442    extern void *__KAI_KMPC_CONVENTION omp_aligned_alloc(size_t align, size_t size,
443                                                         omp_allocator_handle_t a);
444    extern void *__KAI_KMPC_CONVENTION omp_calloc(size_t nmemb, size_t size, omp_allocator_handle_t a);
445    extern void *__KAI_KMPC_CONVENTION omp_aligned_calloc(size_t align, size_t nmemb, size_t size,
446                                                          omp_allocator_handle_t a);
447    extern void *__KAI_KMPC_CONVENTION omp_realloc(void *ptr, size_t size, omp_allocator_handle_t allocator,
448                                                   omp_allocator_handle_t free_allocator);
449    extern void __KAI_KMPC_CONVENTION omp_free(void *ptr, omp_allocator_handle_t a);
450#   endif
451
452    /* OpenMP 5.0 Affinity Format */
453    extern void __KAI_KMPC_CONVENTION omp_set_affinity_format(char const *);
454    extern size_t __KAI_KMPC_CONVENTION omp_get_affinity_format(char *, size_t);
455    extern void __KAI_KMPC_CONVENTION omp_display_affinity(char const *);
456    extern size_t __KAI_KMPC_CONVENTION omp_capture_affinity(char *, size_t, char const *);
457
458    /* OpenMP 5.0 events */
459#   if defined(_WIN32)
460    // On Windows cl and icl do not support 64-bit enum, let's use integer then.
461    typedef omp_uintptr_t omp_event_handle_t;
462#   else
463    typedef enum omp_event_handle_t { KMP_EVENT_MAX_HANDLE = UINTPTR_MAX } omp_event_handle_t;
464#   endif
465    extern void __KAI_KMPC_CONVENTION omp_fulfill_event ( omp_event_handle_t event );
466
467    /* OpenMP 5.0 Pause Resources */
468    typedef enum omp_pause_resource_t {
469      omp_pause_resume = 0,
470      omp_pause_soft = 1,
471      omp_pause_hard = 2
472    } omp_pause_resource_t;
473    extern int __KAI_KMPC_CONVENTION omp_pause_resource(omp_pause_resource_t, int);
474    extern int __KAI_KMPC_CONVENTION omp_pause_resource_all(omp_pause_resource_t);
475
476    extern int __KAI_KMPC_CONVENTION omp_get_supported_active_levels(void);
477
478    /* OpenMP 5.1 */
479    extern void __KAI_KMPC_CONVENTION omp_set_num_teams(int num_teams);
480    extern int __KAI_KMPC_CONVENTION omp_get_max_teams(void);
481    extern void __KAI_KMPC_CONVENTION omp_set_teams_thread_limit(int limit);
482    extern int __KAI_KMPC_CONVENTION omp_get_teams_thread_limit(void);
483
484    /* OpenMP 5.1 Display Environment */
485    extern void omp_display_env(int verbose);
486
487#   if defined(_OPENMP) && _OPENMP >= 201811
488    #pragma omp begin declare variant match(device={kind(host)})
489    static inline int omp_is_initial_device(void) { return 1; }
490    #pragma omp end declare variant
491    #pragma omp begin declare variant match(device={kind(nohost)})
492    static inline int omp_is_initial_device(void) { return 0; }
493    #pragma omp end declare variant
494#   endif
495
496    /* OpenMP 5.2 */
497    extern int __KAI_KMPC_CONVENTION omp_in_explicit_task(void);
498
499    /* LLVM Extensions */
500    extern void *llvm_omp_target_dynamic_shared_alloc();
501
502#   undef __KAI_KMPC_CONVENTION
503#   undef __KMP_IMP
504
505    /* Warning:
506       The following typedefs are not standard, deprecated and will be removed in a future release.
507    */
508    typedef int     omp_int_t;
509    typedef double  omp_wtime_t;
510
511#   ifdef __cplusplus
512    }
513#   endif
514
515#endif /* __OMP_H */
516