7 //===----------------------------------------------------------------------===//
9 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
10 // See https://llvm.org/LICENSE.txt for license information.
11 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
13 //===----------------------------------------------------------------------===//
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"
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
37 # define __KAI_KMPC_CONVENTION __cdecl
39 # define __KMP_IMP __declspec(dllimport)
42 # define __KAI_KMPC_CONVENTION
48 /* schedule kind constants */
49 typedef enum omp_sched_t {
51 omp_sched_dynamic = 2,
54 omp_sched_monotonic = 0x80000000
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);
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);
82 /* lock API functions */
83 typedef struct omp_lock_t {
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 *);
93 /* nested lock API functions */
94 typedef struct omp_nest_lock_t {
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 *);
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)
121 /* lock hint type for dynamic user lock */
122 typedef omp_sync_hint_t omp_lock_hint_t;
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);
128 /* time API functions */
129 extern double __KAI_KMPC_CONVENTION omp_get_wtime (void);
130 extern double __KAI_KMPC_CONVENTION omp_get_wtick (void);
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);
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);
153 extern int __KAI_KMPC_CONVENTION omp_get_device_num (void);
154 typedef void * omp_depend_t;
156 /* OpenMP 5.1 interop */
157 typedef intptr_t omp_intptr_t;
159 /* 0..omp_get_num_interop_properties()-1 are reserved for implementation-defined properties */
160 typedef enum omp_interop_property {
162 omp_ipr_fr_name = -2,
164 omp_ipr_vendor_name = -4,
165 omp_ipr_device_num = -5,
166 omp_ipr_platform = -6,
168 omp_ipr_device_context = -8,
169 omp_ipr_targetsync = -9,
171 } omp_interop_property_t;
173 #define omp_interop_none 0
175 typedef enum omp_interop_rc {
176 omp_irc_no_value = 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,
186 typedef enum omp_interop_fr {
188 omp_ifr_cuda_driver = 2,
192 omp_ifr_level_zero = 6,
196 typedef void * omp_interop_t;
199 * The `omp_get_num_interop_properties` routine retrieves the number of implementation-defined properties available for an `omp_interop_t` object.
201 extern int __KAI_KMPC_CONVENTION omp_get_num_interop_properties(const omp_interop_t);
203 * The `omp_get_interop_int` routine retrieves an integer property from an `omp_interop_t` object.
205 extern omp_intptr_t __KAI_KMPC_CONVENTION omp_get_interop_int(const omp_interop_t, omp_interop_property_t, int *);
207 * The `omp_get_interop_ptr` routine retrieves a pointer property from an `omp_interop_t` object.
209 extern void * __KAI_KMPC_CONVENTION omp_get_interop_ptr(const omp_interop_t, omp_interop_property_t, int *);
211 * The `omp_get_interop_str` routine retrieves a string property from an `omp_interop_t` object.
213 extern const char * __KAI_KMPC_CONVENTION omp_get_interop_str(const omp_interop_t, omp_interop_property_t, int *);
215 * The `omp_get_interop_name` routine retrieves a property name from an `omp_interop_t` object.
217 extern const char * __KAI_KMPC_CONVENTION omp_get_interop_name(const omp_interop_t, omp_interop_property_t);
219 * The `omp_get_interop_type_desc` routine retrieves a description of the type of a property associated with an `omp_interop_t` object.
221 extern const char * __KAI_KMPC_CONVENTION omp_get_interop_type_desc(const omp_interop_t, omp_interop_property_t);
223 * The `omp_get_interop_rc_desc` routine retrieves a description of the return code associated with an `omp_interop_t` object.
225 extern const char * __KAI_KMPC_CONVENTION omp_get_interop_rc_desc(const omp_interop_t, omp_interop_rc_t);
227 /* OpenMP 5.1 device memory routines */
230 * The `omp_target_memcpy_async` routine asynchronously performs a copy between any combination of host and device pointers.
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 *);
235 * The `omp_target_memcpy_rect_async` routine asynchronously performs a copy between any combination of host and device pointers.
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 *);
241 * The `omp_get_mapped_ptr` routine returns the device pointer that is associated with a host pointer for a given device.
243 extern void * __KAI_KMPC_CONVENTION omp_get_mapped_ptr(const void *, int);
244 extern int __KAI_KMPC_CONVENTION omp_target_is_accessible(const void *, size_t, int);
246 /* kmp API functions */
247 extern int __KAI_KMPC_CONVENTION kmp_get_stacksize (void);
248 extern void __KAI_KMPC_CONVENTION kmp_set_stacksize (int);
249 extern size_t __KAI_KMPC_CONVENTION kmp_get_stacksize_s (void);
250 extern void __KAI_KMPC_CONVENTION kmp_set_stacksize_s (size_t);
251 extern int __KAI_KMPC_CONVENTION kmp_get_blocktime (void);
252 extern int __KAI_KMPC_CONVENTION kmp_get_library (void);
253 extern void __KAI_KMPC_CONVENTION kmp_set_blocktime (int);
254 extern void __KAI_KMPC_CONVENTION kmp_set_library (int);
255 extern void __KAI_KMPC_CONVENTION kmp_set_library_serial (void);
256 extern void __KAI_KMPC_CONVENTION kmp_set_library_turnaround (void);
257 extern void __KAI_KMPC_CONVENTION kmp_set_library_throughput (void);
258 extern void __KAI_KMPC_CONVENTION kmp_set_defaults (char const *);
259 extern void __KAI_KMPC_CONVENTION kmp_set_disp_num_buffers (int);
261 /* Intel affinity API */
262 typedef void * kmp_affinity_mask_t;
264 extern int __KAI_KMPC_CONVENTION kmp_set_affinity (kmp_affinity_mask_t *);
265 extern int __KAI_KMPC_CONVENTION kmp_get_affinity (kmp_affinity_mask_t *);
266 extern int __KAI_KMPC_CONVENTION kmp_get_affinity_max_proc (void);
267 extern void __KAI_KMPC_CONVENTION kmp_create_affinity_mask (kmp_affinity_mask_t *);
268 extern void __KAI_KMPC_CONVENTION kmp_destroy_affinity_mask (kmp_affinity_mask_t *);
269 extern int __KAI_KMPC_CONVENTION kmp_set_affinity_mask_proc (int, kmp_affinity_mask_t *);
270 extern int __KAI_KMPC_CONVENTION kmp_unset_affinity_mask_proc (int, kmp_affinity_mask_t *);
271 extern int __KAI_KMPC_CONVENTION kmp_get_affinity_mask_proc (int, kmp_affinity_mask_t *);
273 /* OpenMP 4.0 affinity API */
274 typedef enum omp_proc_bind_t {
275 omp_proc_bind_false = 0,
276 omp_proc_bind_true = 1,
277 omp_proc_bind_master = 2,
278 omp_proc_bind_close = 3,
279 omp_proc_bind_spread = 4
282 extern omp_proc_bind_t __KAI_KMPC_CONVENTION omp_get_proc_bind (void);
284 /* OpenMP 4.5 affinity API */
285 extern int __KAI_KMPC_CONVENTION omp_get_num_places (void);
286 extern int __KAI_KMPC_CONVENTION omp_get_place_num_procs (int);
287 extern void __KAI_KMPC_CONVENTION omp_get_place_proc_ids (int, int *);
288 extern int __KAI_KMPC_CONVENTION omp_get_place_num (void);
289 extern int __KAI_KMPC_CONVENTION omp_get_partition_num_places (void);
290 extern void __KAI_KMPC_CONVENTION omp_get_partition_place_nums (int *);
292 extern void * __KAI_KMPC_CONVENTION kmp_malloc (size_t);
293 extern void * __KAI_KMPC_CONVENTION kmp_aligned_malloc (size_t, size_t);
294 extern void * __KAI_KMPC_CONVENTION kmp_calloc (size_t, size_t);
295 extern void * __KAI_KMPC_CONVENTION kmp_realloc (void *, size_t);
296 extern void __KAI_KMPC_CONVENTION kmp_free (void *);
298 extern void __KAI_KMPC_CONVENTION kmp_set_warnings_on(void);
299 extern void __KAI_KMPC_CONVENTION kmp_set_warnings_off(void);
301 /* OpenMP 5.0 Tool Control */
302 typedef enum omp_control_tool_result_t {
303 omp_control_tool_notool = -2,
304 omp_control_tool_nocallback = -1,
305 omp_control_tool_success = 0,
306 omp_control_tool_ignored = 1
307 } omp_control_tool_result_t;
309 typedef enum omp_control_tool_t {
310 omp_control_tool_start = 1,
311 omp_control_tool_pause = 2,
312 omp_control_tool_flush = 3,
313 omp_control_tool_end = 4
314 } omp_control_tool_t;
316 extern int __KAI_KMPC_CONVENTION omp_control_tool(int, int, void*);
318 /* OpenMP 5.0 Memory Management */
319 typedef uintptr_t omp_uintptr_t;
322 omp_atk_sync_hint = 1,
323 omp_atk_alignment = 2,
325 omp_atk_pool_size = 4,
326 omp_atk_fallback = 5,
329 omp_atk_partition = 8
330 } omp_alloctrait_key_t;
335 omp_atv_contended = 3,
336 omp_atv_uncontended = 4,
337 omp_atv_serialized = 5,
338 omp_atv_sequential = omp_atv_serialized, // (deprecated)
344 omp_atv_default_mem_fb = 11,
345 omp_atv_null_fb = 12,
346 omp_atv_abort_fb = 13,
347 omp_atv_allocator_fb = 14,
348 omp_atv_environment = 15,
349 omp_atv_nearest = 16,
350 omp_atv_blocked = 17,
351 omp_atv_interleaved = 18
352 } omp_alloctrait_value_t;
353 #define omp_atv_default ((omp_uintptr_t)-1)
356 omp_alloctrait_key_t key;
361 // On Windows cl and icl do not support 64-bit enum, let's use integer then.
362 typedef omp_uintptr_t omp_allocator_handle_t;
363 extern __KMP_IMP omp_allocator_handle_t const omp_null_allocator;
364 extern __KMP_IMP omp_allocator_handle_t const omp_default_mem_alloc;
365 extern __KMP_IMP omp_allocator_handle_t const omp_large_cap_mem_alloc;
366 extern __KMP_IMP omp_allocator_handle_t const omp_const_mem_alloc;
367 extern __KMP_IMP omp_allocator_handle_t const omp_high_bw_mem_alloc;
368 extern __KMP_IMP omp_allocator_handle_t const omp_low_lat_mem_alloc;
369 extern __KMP_IMP omp_allocator_handle_t const omp_cgroup_mem_alloc;
370 extern __KMP_IMP omp_allocator_handle_t const omp_pteam_mem_alloc;
371 extern __KMP_IMP omp_allocator_handle_t const omp_thread_mem_alloc;
372 /* Preview of target memory support */
373 extern __KMP_IMP omp_allocator_handle_t const llvm_omp_target_host_mem_alloc;
374 extern __KMP_IMP omp_allocator_handle_t const llvm_omp_target_shared_mem_alloc;
375 extern __KMP_IMP omp_allocator_handle_t const llvm_omp_target_device_mem_alloc;
377 typedef omp_uintptr_t omp_memspace_handle_t;
378 extern __KMP_IMP omp_memspace_handle_t const omp_default_mem_space;
379 extern __KMP_IMP omp_memspace_handle_t const omp_large_cap_mem_space;
380 extern __KMP_IMP omp_memspace_handle_t const omp_const_mem_space;
381 extern __KMP_IMP omp_memspace_handle_t const omp_high_bw_mem_space;
382 extern __KMP_IMP omp_memspace_handle_t const omp_low_lat_mem_space;
383 /* Preview of target memory support */
384 extern __KMP_IMP omp_memspace_handle_t const llvm_omp_target_host_mem_space;
385 extern __KMP_IMP omp_memspace_handle_t const llvm_omp_target_shared_mem_space;
386 extern __KMP_IMP omp_memspace_handle_t const llvm_omp_target_device_mem_space;
388 # if __cplusplus >= 201103
389 typedef enum omp_allocator_handle_t : omp_uintptr_t
391 typedef enum omp_allocator_handle_t
394 omp_null_allocator = 0,
395 omp_default_mem_alloc = 1,
396 omp_large_cap_mem_alloc = 2,
397 omp_const_mem_alloc = 3,
398 omp_high_bw_mem_alloc = 4,
399 omp_low_lat_mem_alloc = 5,
400 omp_cgroup_mem_alloc = 6,
401 omp_pteam_mem_alloc = 7,
402 omp_thread_mem_alloc = 8,
403 /* Preview of target memory support */
404 llvm_omp_target_host_mem_alloc = 100,
405 llvm_omp_target_shared_mem_alloc = 101,
406 llvm_omp_target_device_mem_alloc = 102,
407 KMP_ALLOCATOR_MAX_HANDLE = UINTPTR_MAX
408 } omp_allocator_handle_t;
409 # if __cplusplus >= 201103
410 typedef enum omp_memspace_handle_t : omp_uintptr_t
412 typedef enum omp_memspace_handle_t
415 omp_default_mem_space = 0,
416 omp_large_cap_mem_space = 1,
417 omp_const_mem_space = 2,
418 omp_high_bw_mem_space = 3,
419 omp_low_lat_mem_space = 4,
420 /* Preview of target memory support */
421 llvm_omp_target_host_mem_space = 100,
422 llvm_omp_target_shared_mem_space = 101,
423 llvm_omp_target_device_mem_space = 102,
424 KMP_MEMSPACE_MAX_HANDLE = UINTPTR_MAX
425 } omp_memspace_handle_t;
427 extern omp_allocator_handle_t __KAI_KMPC_CONVENTION omp_init_allocator(omp_memspace_handle_t m,
428 int ntraits, omp_alloctrait_t traits[]);
429 extern void __KAI_KMPC_CONVENTION omp_destroy_allocator(omp_allocator_handle_t allocator);
431 extern void __KAI_KMPC_CONVENTION omp_set_default_allocator(omp_allocator_handle_t a);
432 extern omp_allocator_handle_t __KAI_KMPC_CONVENTION omp_get_default_allocator(void);
434 extern void *__KAI_KMPC_CONVENTION omp_alloc(size_t size, omp_allocator_handle_t a = omp_null_allocator);
435 extern void *__KAI_KMPC_CONVENTION omp_aligned_alloc(size_t align, size_t size,
436 omp_allocator_handle_t a = omp_null_allocator);
437 extern void *__KAI_KMPC_CONVENTION omp_calloc(size_t nmemb, size_t size,
438 omp_allocator_handle_t a = omp_null_allocator);
439 extern void *__KAI_KMPC_CONVENTION omp_aligned_calloc(size_t align, size_t nmemb, size_t size,
440 omp_allocator_handle_t a = omp_null_allocator);
441 extern void *__KAI_KMPC_CONVENTION omp_realloc(void *ptr, size_t size,
442 omp_allocator_handle_t allocator = omp_null_allocator,
443 omp_allocator_handle_t free_allocator = omp_null_allocator);
444 extern void __KAI_KMPC_CONVENTION omp_free(void * ptr, omp_allocator_handle_t a = omp_null_allocator);
446 extern void *__KAI_KMPC_CONVENTION omp_alloc(size_t size, omp_allocator_handle_t a);
447 extern void *__KAI_KMPC_CONVENTION omp_aligned_alloc(size_t align, size_t size,
448 omp_allocator_handle_t a);
449 extern void *__KAI_KMPC_CONVENTION omp_calloc(size_t nmemb, size_t size, omp_allocator_handle_t a);
450 extern void *__KAI_KMPC_CONVENTION omp_aligned_calloc(size_t align, size_t nmemb, size_t size,
451 omp_allocator_handle_t a);
452 extern void *__KAI_KMPC_CONVENTION omp_realloc(void *ptr, size_t size, omp_allocator_handle_t allocator,
453 omp_allocator_handle_t free_allocator);
454 extern void __KAI_KMPC_CONVENTION omp_free(void *ptr, omp_allocator_handle_t a);
457 /* OpenMP 5.0 Affinity Format */
458 extern void __KAI_KMPC_CONVENTION omp_set_affinity_format(char const *);
459 extern size_t __KAI_KMPC_CONVENTION omp_get_affinity_format(char *, size_t);
460 extern void __KAI_KMPC_CONVENTION omp_display_affinity(char const *);
461 extern size_t __KAI_KMPC_CONVENTION omp_capture_affinity(char *, size_t, char const *);
463 /* OpenMP 5.0 events */
465 // On Windows cl and icl do not support 64-bit enum, let's use integer then.
466 typedef omp_uintptr_t omp_event_handle_t;
468 typedef enum omp_event_handle_t { KMP_EVENT_MAX_HANDLE = UINTPTR_MAX } omp_event_handle_t;
470 extern void __KAI_KMPC_CONVENTION omp_fulfill_event ( omp_event_handle_t event );
472 /* OpenMP 5.0 Pause Resources */
473 typedef enum omp_pause_resource_t {
474 omp_pause_resume = 0,
477 } omp_pause_resource_t;
478 extern int __KAI_KMPC_CONVENTION omp_pause_resource(omp_pause_resource_t, int);
479 extern int __KAI_KMPC_CONVENTION omp_pause_resource_all(omp_pause_resource_t);
481 extern int __KAI_KMPC_CONVENTION omp_get_supported_active_levels(void);
484 extern void __KAI_KMPC_CONVENTION omp_set_num_teams(int num_teams);
485 extern int __KAI_KMPC_CONVENTION omp_get_max_teams(void);
486 extern void __KAI_KMPC_CONVENTION omp_set_teams_thread_limit(int limit);
487 extern int __KAI_KMPC_CONVENTION omp_get_teams_thread_limit(void);
489 /* OpenMP 5.1 Display Environment */
490 extern void omp_display_env(int verbose);
492 # if defined(_OPENMP) && _OPENMP >= 201811
493 #pragma omp begin declare variant match(device={kind(host)})
494 static inline int omp_is_initial_device(void) { return 1; }
495 #pragma omp end declare variant
496 #pragma omp begin declare variant match(device={kind(nohost)})
497 static inline int omp_is_initial_device(void) { return 0; }
498 #pragma omp end declare variant
501 # undef __KAI_KMPC_CONVENTION
505 The following typedefs are not standard, deprecated and will be removed in a future release.
507 typedef int omp_int_t;
508 typedef double omp_wtime_t;