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