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(void *, int);
146 extern int __KAI_KMPC_CONVENTION omp_target_memcpy(void *, void *, size_t, size_t, size_t, int, int);
147 extern int __KAI_KMPC_CONVENTION omp_target_memcpy_rect(void *, 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(void *, void *, size_t, size_t, int);
150 extern int __KAI_KMPC_CONVENTION omp_target_disassociate_ptr(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 void * omp_interop_t;
189 * The `omp_get_num_interop_properties` routine retrieves the number of implementation-defined properties available for an `omp_interop_t` object.
191 extern int __KAI_KMPC_CONVENTION omp_get_num_interop_properties(const omp_interop_t);
193 * The `omp_get_interop_int` routine retrieves an integer property from an `omp_interop_t` object.
195 extern omp_intptr_t __KAI_KMPC_CONVENTION omp_get_interop_int(const omp_interop_t, omp_interop_property_t, int *);
197 * The `omp_get_interop_ptr` routine retrieves a pointer property from an `omp_interop_t` object.
199 extern void * __KAI_KMPC_CONVENTION omp_get_interop_ptr(const omp_interop_t, omp_interop_property_t, int *);
201 * The `omp_get_interop_str` routine retrieves a string property from an `omp_interop_t` object.
203 extern const char * __KAI_KMPC_CONVENTION omp_get_interop_str(const omp_interop_t, omp_interop_property_t, int *);
205 * The `omp_get_interop_name` routine retrieves a property name from an `omp_interop_t` object.
207 extern const char * __KAI_KMPC_CONVENTION omp_get_interop_name(const omp_interop_t, omp_interop_property_t);
209 * The `omp_get_interop_type_desc` routine retrieves a description of the type of a property associated with an `omp_interop_t` object.
211 extern const char * __KAI_KMPC_CONVENTION omp_get_interop_type_desc(const omp_interop_t, omp_interop_property_t);
213 * The `omp_get_interop_rc_desc` routine retrieves a description of the return code associated with an `omp_interop_t` object.
215 extern const char * __KAI_KMPC_CONVENTION omp_get_interop_rc_desc(const omp_interop_rc_t, omp_interop_rc_t);
217 /* OpenMP 5.1 device memory routines */
220 * The `omp_target_memcpy_async` routine asynchronously performs a copy between any combination of host and device pointers.
222 extern int __KAI_KMPC_CONVENTION omp_target_memcpy_async(void *, const void *, size_t, size_t, size_t, int,
223 int, int, omp_depend_t *);
225 * The `omp_target_memcpy_rect_async` routine asynchronously performs a copy between any combination of host and device pointers.
227 extern int __KAI_KMPC_CONVENTION omp_target_memcpy_rect_async(void *, const void *, size_t, int, const size_t *,
228 const size_t *, const size_t *, const size_t *, const size_t *, int, int,
229 int, omp_depend_t *);
231 * The `omp_get_mapped_ptr` routine returns the device pointer that is associated with a host pointer for a given device.
233 extern void * __KAI_KMPC_CONVENTION omp_get_mapped_ptr(const void *, int);
235 /* kmp API functions */
236 extern int __KAI_KMPC_CONVENTION kmp_get_stacksize (void);
237 extern void __KAI_KMPC_CONVENTION kmp_set_stacksize (int);
238 extern size_t __KAI_KMPC_CONVENTION kmp_get_stacksize_s (void);
239 extern void __KAI_KMPC_CONVENTION kmp_set_stacksize_s (size_t);
240 extern int __KAI_KMPC_CONVENTION kmp_get_blocktime (void);
241 extern int __KAI_KMPC_CONVENTION kmp_get_library (void);
242 extern void __KAI_KMPC_CONVENTION kmp_set_blocktime (int);
243 extern void __KAI_KMPC_CONVENTION kmp_set_library (int);
244 extern void __KAI_KMPC_CONVENTION kmp_set_library_serial (void);
245 extern void __KAI_KMPC_CONVENTION kmp_set_library_turnaround (void);
246 extern void __KAI_KMPC_CONVENTION kmp_set_library_throughput (void);
247 extern void __KAI_KMPC_CONVENTION kmp_set_defaults (char const *);
248 extern void __KAI_KMPC_CONVENTION kmp_set_disp_num_buffers (int);
250 /* Intel affinity API */
251 typedef void * kmp_affinity_mask_t;
253 extern int __KAI_KMPC_CONVENTION kmp_set_affinity (kmp_affinity_mask_t *);
254 extern int __KAI_KMPC_CONVENTION kmp_get_affinity (kmp_affinity_mask_t *);
255 extern int __KAI_KMPC_CONVENTION kmp_get_affinity_max_proc (void);
256 extern void __KAI_KMPC_CONVENTION kmp_create_affinity_mask (kmp_affinity_mask_t *);
257 extern void __KAI_KMPC_CONVENTION kmp_destroy_affinity_mask (kmp_affinity_mask_t *);
258 extern int __KAI_KMPC_CONVENTION kmp_set_affinity_mask_proc (int, kmp_affinity_mask_t *);
259 extern int __KAI_KMPC_CONVENTION kmp_unset_affinity_mask_proc (int, kmp_affinity_mask_t *);
260 extern int __KAI_KMPC_CONVENTION kmp_get_affinity_mask_proc (int, kmp_affinity_mask_t *);
262 /* OpenMP 4.0 affinity API */
263 typedef enum omp_proc_bind_t {
264 omp_proc_bind_false = 0,
265 omp_proc_bind_true = 1,
266 omp_proc_bind_master = 2,
267 omp_proc_bind_close = 3,
268 omp_proc_bind_spread = 4
271 extern omp_proc_bind_t __KAI_KMPC_CONVENTION omp_get_proc_bind (void);
273 /* OpenMP 4.5 affinity API */
274 extern int __KAI_KMPC_CONVENTION omp_get_num_places (void);
275 extern int __KAI_KMPC_CONVENTION omp_get_place_num_procs (int);
276 extern void __KAI_KMPC_CONVENTION omp_get_place_proc_ids (int, int *);
277 extern int __KAI_KMPC_CONVENTION omp_get_place_num (void);
278 extern int __KAI_KMPC_CONVENTION omp_get_partition_num_places (void);
279 extern void __KAI_KMPC_CONVENTION omp_get_partition_place_nums (int *);
281 extern void * __KAI_KMPC_CONVENTION kmp_malloc (size_t);
282 extern void * __KAI_KMPC_CONVENTION kmp_aligned_malloc (size_t, size_t);
283 extern void * __KAI_KMPC_CONVENTION kmp_calloc (size_t, size_t);
284 extern void * __KAI_KMPC_CONVENTION kmp_realloc (void *, size_t);
285 extern void __KAI_KMPC_CONVENTION kmp_free (void *);
287 extern void __KAI_KMPC_CONVENTION kmp_set_warnings_on(void);
288 extern void __KAI_KMPC_CONVENTION kmp_set_warnings_off(void);
290 /* OpenMP 5.0 Tool Control */
291 typedef enum omp_control_tool_result_t {
292 omp_control_tool_notool = -2,
293 omp_control_tool_nocallback = -1,
294 omp_control_tool_success = 0,
295 omp_control_tool_ignored = 1
296 } omp_control_tool_result_t;
298 typedef enum omp_control_tool_t {
299 omp_control_tool_start = 1,
300 omp_control_tool_pause = 2,
301 omp_control_tool_flush = 3,
302 omp_control_tool_end = 4
303 } omp_control_tool_t;
305 extern int __KAI_KMPC_CONVENTION omp_control_tool(int, int, void*);
307 /* OpenMP 5.0 Memory Management */
308 typedef uintptr_t omp_uintptr_t;
311 omp_atk_sync_hint = 1,
312 omp_atk_alignment = 2,
314 omp_atk_pool_size = 4,
315 omp_atk_fallback = 5,
318 omp_atk_partition = 8
319 } omp_alloctrait_key_t;
324 omp_atv_contended = 3,
325 omp_atv_uncontended = 4,
326 omp_atv_serialized = 5,
327 omp_atv_sequential = omp_atv_serialized, // (deprecated)
333 omp_atv_default_mem_fb = 11,
334 omp_atv_null_fb = 12,
335 omp_atv_abort_fb = 13,
336 omp_atv_allocator_fb = 14,
337 omp_atv_environment = 15,
338 omp_atv_nearest = 16,
339 omp_atv_blocked = 17,
340 omp_atv_interleaved = 18
341 } omp_alloctrait_value_t;
342 #define omp_atv_default ((omp_uintptr_t)-1)
345 omp_alloctrait_key_t key;
350 // On Windows cl and icl do not support 64-bit enum, let's use integer then.
351 typedef omp_uintptr_t omp_allocator_handle_t;
352 extern __KMP_IMP omp_allocator_handle_t const omp_null_allocator;
353 extern __KMP_IMP omp_allocator_handle_t const omp_default_mem_alloc;
354 extern __KMP_IMP omp_allocator_handle_t const omp_large_cap_mem_alloc;
355 extern __KMP_IMP omp_allocator_handle_t const omp_const_mem_alloc;
356 extern __KMP_IMP omp_allocator_handle_t const omp_high_bw_mem_alloc;
357 extern __KMP_IMP omp_allocator_handle_t const omp_low_lat_mem_alloc;
358 extern __KMP_IMP omp_allocator_handle_t const omp_cgroup_mem_alloc;
359 extern __KMP_IMP omp_allocator_handle_t const omp_pteam_mem_alloc;
360 extern __KMP_IMP omp_allocator_handle_t const omp_thread_mem_alloc;
361 typedef omp_uintptr_t omp_memspace_handle_t;
362 extern __KMP_IMP omp_memspace_handle_t const omp_default_mem_space;
363 extern __KMP_IMP omp_memspace_handle_t const omp_large_cap_mem_space;
364 extern __KMP_IMP omp_memspace_handle_t const omp_const_mem_space;
365 extern __KMP_IMP omp_memspace_handle_t const omp_high_bw_mem_space;
366 extern __KMP_IMP omp_memspace_handle_t const omp_low_lat_mem_space;
368 # if __cplusplus >= 201103
369 typedef enum omp_allocator_handle_t : omp_uintptr_t
371 typedef enum omp_allocator_handle_t
374 omp_null_allocator = 0,
375 omp_default_mem_alloc = 1,
376 omp_large_cap_mem_alloc = 2,
377 omp_const_mem_alloc = 3,
378 omp_high_bw_mem_alloc = 4,
379 omp_low_lat_mem_alloc = 5,
380 omp_cgroup_mem_alloc = 6,
381 omp_pteam_mem_alloc = 7,
382 omp_thread_mem_alloc = 8,
383 KMP_ALLOCATOR_MAX_HANDLE = UINTPTR_MAX
384 } omp_allocator_handle_t;
385 # if __cplusplus >= 201103
386 typedef enum omp_memspace_handle_t : omp_uintptr_t
388 typedef enum omp_memspace_handle_t
391 omp_default_mem_space = 0,
392 omp_large_cap_mem_space = 1,
393 omp_const_mem_space = 2,
394 omp_high_bw_mem_space = 3,
395 omp_low_lat_mem_space = 4,
396 KMP_MEMSPACE_MAX_HANDLE = UINTPTR_MAX
397 } omp_memspace_handle_t;
399 extern omp_allocator_handle_t __KAI_KMPC_CONVENTION omp_init_allocator(omp_memspace_handle_t m,
400 int ntraits, omp_alloctrait_t traits[]);
401 extern void __KAI_KMPC_CONVENTION omp_destroy_allocator(omp_allocator_handle_t allocator);
403 extern void __KAI_KMPC_CONVENTION omp_set_default_allocator(omp_allocator_handle_t a);
404 extern omp_allocator_handle_t __KAI_KMPC_CONVENTION omp_get_default_allocator(void);
406 extern void *__KAI_KMPC_CONVENTION omp_alloc(size_t size, omp_allocator_handle_t a = omp_null_allocator);
407 extern void *__KAI_KMPC_CONVENTION omp_calloc(size_t nmemb, size_t size, omp_allocator_handle_t a = omp_null_allocator);
408 extern void *__KAI_KMPC_CONVENTION omp_realloc(void *ptr, size_t size,
409 omp_allocator_handle_t allocator = omp_null_allocator,
410 omp_allocator_handle_t free_allocator = omp_null_allocator);
411 extern void __KAI_KMPC_CONVENTION omp_free(void * ptr, omp_allocator_handle_t a = omp_null_allocator);
413 extern void *__KAI_KMPC_CONVENTION omp_alloc(size_t size, omp_allocator_handle_t a);
414 extern void *__KAI_KMPC_CONVENTION omp_calloc(size_t nmemb, size_t size, omp_allocator_handle_t a);
415 extern void *__KAI_KMPC_CONVENTION omp_realloc(void *ptr, size_t size, omp_allocator_handle_t allocator,
416 omp_allocator_handle_t free_allocator);
417 extern void __KAI_KMPC_CONVENTION omp_free(void *ptr, omp_allocator_handle_t a);
420 /* OpenMP 5.0 Affinity Format */
421 extern void __KAI_KMPC_CONVENTION omp_set_affinity_format(char const *);
422 extern size_t __KAI_KMPC_CONVENTION omp_get_affinity_format(char *, size_t);
423 extern void __KAI_KMPC_CONVENTION omp_display_affinity(char const *);
424 extern size_t __KAI_KMPC_CONVENTION omp_capture_affinity(char *, size_t, char const *);
426 /* OpenMP 5.0 events */
428 // On Windows cl and icl do not support 64-bit enum, let's use integer then.
429 typedef omp_uintptr_t omp_event_handle_t;
431 typedef enum omp_event_handle_t { KMP_EVENT_MAX_HANDLE = UINTPTR_MAX } omp_event_handle_t;
433 extern void __KAI_KMPC_CONVENTION omp_fulfill_event ( omp_event_handle_t event );
435 /* OpenMP 5.0 Pause Resources */
436 typedef enum omp_pause_resource_t {
437 omp_pause_resume = 0,
440 } omp_pause_resource_t;
441 extern int __KAI_KMPC_CONVENTION omp_pause_resource(omp_pause_resource_t, int);
442 extern int __KAI_KMPC_CONVENTION omp_pause_resource_all(omp_pause_resource_t);
444 extern int __KAI_KMPC_CONVENTION omp_get_supported_active_levels(void);
446 /* OpenMP 5.1 Display Environment */
447 extern void omp_display_env(int verbose);
449 # undef __KAI_KMPC_CONVENTION
453 The following typedefs are not standard, deprecated and will be removed in a future release.
455 typedef int omp_int_t;
456 typedef double omp_wtime_t;