]> git.ipfire.org Git - thirdparty/gcc.git/blob - libgomp/omp_lib.h.in
openmp: Conforming device numbers and omp_{initial,invalid}_device
[thirdparty/gcc.git] / libgomp / omp_lib.h.in
1 ! Copyright (C) 2005-2022 Free Software Foundation, Inc.
2 ! Contributed by Jakub Jelinek <jakub@redhat.com>.
3
4 ! This file is part of the GNU Offloading and Multi Processing Library
5 ! (libgomp).
6
7 ! Libgomp is free software; you can redistribute it and/or modify it
8 ! under the terms of the GNU General Public License as published by
9 ! the Free Software Foundation; either version 3, or (at your option)
10 ! any later version.
11
12 ! Libgomp is distributed in the hope that it will be useful, but WITHOUT ANY
13 ! WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
14 ! FOR A PARTICULAR PURPOSE. See the GNU General Public License for
15 ! more details.
16
17 ! Under Section 7 of GPL version 3, you are granted additional
18 ! permissions described in the GCC Runtime Library Exception, version
19 ! 3.1, as published by the Free Software Foundation.
20
21 ! You should have received a copy of the GNU General Public License and
22 ! a copy of the GCC Runtime Library Exception along with this program;
23 ! see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
24 ! <http://www.gnu.org/licenses/>.
25
26 integer omp_lock_kind, omp_nest_lock_kind, openmp_version
27 parameter (omp_lock_kind = @OMP_LOCK_KIND@)
28 parameter (omp_nest_lock_kind = @OMP_NEST_LOCK_KIND@)
29 integer omp_depend_kind
30 parameter (omp_depend_kind = @OMP_DEPEND_KIND@)
31 integer omp_sched_kind
32 parameter (omp_sched_kind = 4)
33 integer (omp_sched_kind) omp_sched_static, omp_sched_dynamic
34 integer (omp_sched_kind) omp_sched_guided, omp_sched_auto
35 parameter (omp_sched_static = 1)
36 parameter (omp_sched_dynamic = 2)
37 parameter (omp_sched_guided = 3)
38 parameter (omp_sched_auto = 4)
39 integer omp_proc_bind_kind
40 parameter (omp_proc_bind_kind = 4)
41 integer (omp_proc_bind_kind) omp_proc_bind_false
42 integer (omp_proc_bind_kind) omp_proc_bind_true
43 integer (omp_proc_bind_kind) omp_proc_bind_primary
44 integer (omp_proc_bind_kind) omp_proc_bind_master
45 integer (omp_proc_bind_kind) omp_proc_bind_close
46 integer (omp_proc_bind_kind) omp_proc_bind_spread
47 parameter (omp_proc_bind_false = 0)
48 parameter (omp_proc_bind_true = 1)
49 parameter (omp_proc_bind_primary = 2)
50 parameter (omp_proc_bind_master = 2)
51 parameter (omp_proc_bind_close = 3)
52 parameter (omp_proc_bind_spread = 4)
53 integer omp_sync_hint_kind
54 integer omp_lock_hint_kind
55 parameter (omp_sync_hint_kind = 4)
56 parameter (omp_lock_hint_kind = omp_sync_hint_kind)
57 integer (omp_sync_hint_kind) omp_sync_hint_none
58 integer (omp_lock_hint_kind) omp_lock_hint_none
59 integer (omp_sync_hint_kind) omp_sync_hint_uncontended
60 integer (omp_lock_hint_kind) omp_lock_hint_uncontended
61 integer (omp_sync_hint_kind) omp_sync_hint_contended
62 integer (omp_sync_hint_kind) omp_lock_hint_contended
63 integer (omp_lock_hint_kind) omp_sync_hint_nonspeculative
64 integer (omp_lock_hint_kind) omp_lock_hint_nonspeculative
65 integer (omp_sync_hint_kind) omp_sync_hint_speculative
66 integer (omp_lock_hint_kind) omp_lock_hint_speculative
67 parameter (omp_sync_hint_none = 0)
68 parameter (omp_lock_hint_none = 0)
69 parameter (omp_sync_hint_uncontended = 1)
70 parameter (omp_lock_hint_uncontended = 1)
71 parameter (omp_sync_hint_contended = 2)
72 parameter (omp_lock_hint_contended = 2)
73 parameter (omp_sync_hint_nonspeculative = 4)
74 parameter (omp_lock_hint_nonspeculative = 4)
75 parameter (omp_sync_hint_speculative = 8)
76 parameter (omp_lock_hint_speculative = 8)
77 parameter (openmp_version = 201511)
78 integer omp_pause_resource_kind
79 parameter (omp_pause_resource_kind = 4)
80 integer (omp_pause_resource_kind) omp_pause_soft
81 integer (omp_pause_resource_kind) omp_pause_hard
82 parameter (omp_pause_soft = 1)
83 parameter (omp_pause_hard = 2)
84
85 integer omp_allocator_handle_kind, omp_alloctrait_key_kind
86 integer omp_alloctrait_val_kind, omp_memspace_handle_kind
87 integer omp_event_handle_kind
88 parameter (omp_allocator_handle_kind = @INTPTR_T_KIND@)
89 parameter (omp_alloctrait_key_kind = 4)
90 parameter (omp_alloctrait_val_kind = @INTPTR_T_KIND@)
91 parameter (omp_memspace_handle_kind = @INTPTR_T_KIND@)
92 parameter (omp_event_handle_kind = @INTPTR_T_KIND@)
93 integer (omp_alloctrait_key_kind) omp_atk_sync_hint
94 integer (omp_alloctrait_key_kind) omp_atk_alignment
95 integer (omp_alloctrait_key_kind) omp_atk_access
96 integer (omp_alloctrait_key_kind) omp_atk_pool_size
97 integer (omp_alloctrait_key_kind) omp_atk_fallback
98 integer (omp_alloctrait_key_kind) omp_atk_fb_data
99 integer (omp_alloctrait_key_kind) omp_atk_pinned
100 integer (omp_alloctrait_key_kind) omp_atk_partition
101 parameter (omp_atk_sync_hint = 1)
102 parameter (omp_atk_alignment = 2)
103 parameter (omp_atk_access = 3)
104 parameter (omp_atk_pool_size = 4)
105 parameter (omp_atk_fallback = 5)
106 parameter (omp_atk_fb_data = 6)
107 parameter (omp_atk_pinned = 7)
108 parameter (omp_atk_partition = 8)
109 integer (omp_alloctrait_val_kind) omp_atv_false
110 integer (omp_alloctrait_val_kind) omp_atv_true
111 integer (omp_alloctrait_val_kind) omp_atv_default
112 integer (omp_alloctrait_val_kind) omp_atv_contended
113 integer (omp_alloctrait_val_kind) omp_atv_uncontended
114 integer (omp_alloctrait_val_kind) omp_atv_serialized
115 integer (omp_alloctrait_val_kind) omp_atv_sequential
116 integer (omp_alloctrait_val_kind) omp_atv_private
117 integer (omp_alloctrait_val_kind) omp_atv_all
118 integer (omp_alloctrait_val_kind) omp_atv_thread
119 integer (omp_alloctrait_val_kind) omp_atv_pteam
120 integer (omp_alloctrait_val_kind) omp_atv_cgroup
121 integer (omp_alloctrait_val_kind) omp_atv_default_mem_fb
122 integer (omp_alloctrait_val_kind) omp_atv_null_fb
123 integer (omp_alloctrait_val_kind) omp_atv_abort_fb
124 integer (omp_alloctrait_val_kind) omp_atv_allocator_fb
125 integer (omp_alloctrait_val_kind) omp_atv_environment
126 integer (omp_alloctrait_val_kind) omp_atv_nearest
127 integer (omp_alloctrait_val_kind) omp_atv_blocked
128 integer (omp_alloctrait_val_kind) omp_atv_interleaved
129 parameter (omp_atv_default = -1)
130 parameter (omp_atv_false = 0)
131 parameter (omp_atv_true = 1)
132 parameter (omp_atv_contended = 3)
133 parameter (omp_atv_uncontended = 4)
134 parameter (omp_atv_serialized = 5)
135 parameter (omp_atv_sequential = omp_atv_serialized)
136 parameter (omp_atv_private = 6)
137 parameter (omp_atv_all = 7)
138 parameter (omp_atv_thread = 8)
139 parameter (omp_atv_pteam = 9)
140 parameter (omp_atv_cgroup = 10)
141 parameter (omp_atv_default_mem_fb = 11)
142 parameter (omp_atv_null_fb = 12)
143 parameter (omp_atv_abort_fb = 13)
144 parameter (omp_atv_allocator_fb = 14)
145 parameter (omp_atv_environment = 15)
146 parameter (omp_atv_nearest = 16)
147 parameter (omp_atv_blocked = 17)
148 parameter (omp_atv_interleaved = 18)
149 integer (omp_allocator_handle_kind) omp_null_allocator
150 integer (omp_allocator_handle_kind) omp_default_mem_alloc
151 integer (omp_allocator_handle_kind) omp_large_cap_mem_alloc
152 integer (omp_allocator_handle_kind) omp_const_mem_alloc
153 integer (omp_allocator_handle_kind) omp_high_bw_mem_alloc
154 integer (omp_allocator_handle_kind) omp_low_lat_mem_alloc
155 integer (omp_allocator_handle_kind) omp_cgroup_mem_alloc
156 integer (omp_allocator_handle_kind) omp_pteam_mem_alloc
157 integer (omp_allocator_handle_kind) omp_thread_mem_alloc
158 parameter (omp_null_allocator = 0)
159 parameter (omp_default_mem_alloc = 1)
160 parameter (omp_large_cap_mem_alloc = 2)
161 parameter (omp_const_mem_alloc = 3)
162 parameter (omp_high_bw_mem_alloc = 4)
163 parameter (omp_low_lat_mem_alloc = 5)
164 parameter (omp_cgroup_mem_alloc = 6)
165 parameter (omp_pteam_mem_alloc = 7)
166 parameter (omp_thread_mem_alloc = 8)
167 integer (omp_memspace_handle_kind) omp_default_mem_space
168 integer (omp_memspace_handle_kind) omp_large_cap_mem_space
169 integer (omp_memspace_handle_kind) omp_const_mem_space
170 integer (omp_memspace_handle_kind) omp_high_bw_mem_space
171 integer (omp_memspace_handle_kind) omp_low_lat_mem_space
172 parameter (omp_default_mem_space = 0)
173 parameter (omp_large_cap_mem_space = 1)
174 parameter (omp_const_mem_space = 2)
175 parameter (omp_high_bw_mem_space = 3)
176 parameter (omp_low_lat_mem_space = 4)
177 integer omp_initial_device, omp_invalid_device
178 parameter (omp_initial_device = -1)
179 parameter (omp_invalid_device = -4)
180
181 type omp_alloctrait
182 integer (omp_alloctrait_key_kind) key
183 integer (omp_alloctrait_val_kind) value
184 end type omp_alloctrait
185
186 external omp_init_lock, omp_init_nest_lock
187 external omp_init_lock_with_hint
188 external omp_init_nest_lock_with_hint
189 external omp_destroy_lock, omp_destroy_nest_lock
190 external omp_set_lock, omp_set_nest_lock
191 external omp_unset_lock, omp_unset_nest_lock
192 external omp_set_dynamic, omp_set_nested
193 external omp_set_num_threads
194
195 external omp_get_dynamic, omp_get_nested
196 logical(4) omp_get_dynamic, omp_get_nested
197 external omp_test_lock, omp_in_parallel
198 logical(4) omp_test_lock, omp_in_parallel
199
200 external omp_get_max_threads, omp_get_num_procs
201 integer(4) omp_get_max_threads, omp_get_num_procs
202 external omp_get_num_threads, omp_get_thread_num
203 integer(4) omp_get_num_threads, omp_get_thread_num
204 external omp_test_nest_lock
205 integer(4) omp_test_nest_lock
206
207 external omp_get_wtick, omp_get_wtime
208 double precision omp_get_wtick, omp_get_wtime
209
210 external omp_set_schedule, omp_get_schedule
211 external omp_get_thread_limit, omp_set_max_active_levels
212 external omp_get_max_active_levels, omp_get_level
213 external omp_get_ancestor_thread_num, omp_get_team_size
214 external omp_get_active_level
215 external omp_get_supported_active_levels
216 integer(4) omp_get_thread_limit, omp_get_max_active_levels
217 integer(4) omp_get_level, omp_get_ancestor_thread_num
218 integer(4) omp_get_team_size, omp_get_active_level
219 integer(4) omp_get_supported_active_levels
220
221 external omp_in_final
222 logical(4) omp_in_final
223
224 external omp_get_cancellation
225 logical(4) omp_get_cancellation
226
227 external omp_get_proc_bind
228 integer(omp_proc_bind_kind) omp_get_proc_bind
229
230 integer(4) omp_get_num_places
231 external omp_get_num_places
232 integer(4) omp_get_place_num_procs
233 external omp_get_place_num_procs
234 external omp_get_place_proc_ids
235 integer(4) omp_get_place_num
236 external omp_get_place_num
237 integer(4) omp_get_partition_num_places
238 external omp_get_partition_num_places
239 external omp_get_partition_place_nums
240
241 external omp_set_default_device, omp_get_default_device
242 external omp_get_num_devices, omp_get_num_teams
243 external omp_get_team_num
244 integer(4) omp_get_default_device, omp_get_num_devices
245 integer(4) omp_get_num_teams, omp_get_team_num
246
247 external omp_is_initial_device
248 logical(4) omp_is_initial_device
249 external omp_get_initial_device
250 integer(4) omp_get_initial_device
251
252 external omp_get_device_num
253 integer(4) omp_get_device_num
254
255 external omp_get_max_task_priority
256 integer(4) omp_get_max_task_priority
257
258 external omp_set_num_teams, omp_set_teams_thread_limit
259 external omp_get_max_teams, omp_get_teams_thread_limit
260 integer(4) omp_get_max_teams, omp_get_teams_thread_limit
261
262 external omp_fulfill_event
263
264 external omp_set_affinity_format, omp_get_affinity_format
265 external omp_display_affinity, omp_capture_affinity
266 integer(4) omp_get_affinity_format
267 integer(4) omp_capture_affinity
268
269 external omp_pause_resource, omp_pause_resource_all
270 integer(4) omp_pause_resource
271 integer(4) omp_pause_resource_all
272
273 external omp_init_allocator
274 integer (omp_allocator_handle_kind) omp_init_allocator
275 external omp_destroy_allocator
276 external omp_set_default_allocator
277 external omp_get_default_allocator
278 integer (omp_allocator_handle_kind) omp_get_default_allocator
279
280 external omp_display_env
281
282 interface
283 function omp_alloc (size, allocator) bind(c)
284 use, intrinsic :: iso_c_binding, only : c_ptr, c_size_t
285 use, intrinsic :: omp_lib_kinds
286 type(c_ptr) :: omp_alloc
287 integer(c_size_t), value :: size
288 integer(omp_allocator_handle_kind), value :: allocator
289 end function omp_alloc
290 end interface
291
292 interface
293 function omp_aligned_alloc (alignment, size, allocator) bind(c)
294 use, intrinsic :: iso_c_binding, only : c_ptr, c_size_t
295 use, intrinsic :: omp_lib_kinds
296 type(c_ptr) :: omp_aligned_alloc
297 integer(c_size_t), value :: alignment, size
298 integer(omp_allocator_handle_kind), value :: allocator
299 end function omp_aligned_alloc
300 end interface
301
302 interface
303 subroutine omp_free(ptr, allocator) bind(c)
304 use, intrinsic :: iso_c_binding, only : c_ptr
305 use, intrinsic :: omp_lib_kinds
306 type(c_ptr), value :: ptr
307 integer(omp_allocator_handle_kind), value :: allocator
308 end subroutine omp_free
309 end interface
310
311 interface
312 function omp_calloc (nmemb, size, allocator) bind(c)
313 use, intrinsic :: iso_c_binding, only : c_ptr, c_size_t
314 use, intrinsic :: omp_lib_kinds
315 type(c_ptr) :: omp_calloc
316 integer(c_size_t), value :: nmemb, size
317 integer(omp_allocator_handle_kind), value :: allocator
318 end function omp_calloc
319 end interface
320
321 interface
322 function omp_aligned_calloc (alignment, nmemb, size, allocator) &
323 & bind(c)
324 use, intrinsic :: iso_c_binding, only : c_ptr, c_size_t
325 use, intrinsic :: omp_lib_kinds
326 type(c_ptr) :: omp_aligned_calloc
327 integer(c_size_t), value :: alignment, nmemb, size
328 integer(omp_allocator_handle_kind), value :: allocator
329 end function omp_aligned_calloc
330 end interface
331
332 interface
333 function omp_realloc (ptr, size, allocator, free_allocator) &
334 & bind(c)
335 use, intrinsic :: iso_c_binding, only : c_ptr, c_size_t
336 use, intrinsic :: omp_lib_kinds
337 type(c_ptr) :: omp_realloc
338 type(c_ptr), value :: ptr
339 integer(c_size_t), value :: size
340 integer(omp_allocator_handle_kind), value :: allocator
341 integer(omp_allocator_handle_kind), value :: free_allocator
342 end function omp_realloc
343 end interface
344
345 interface
346 function omp_target_alloc (size, device_num) bind(c)
347 use, intrinsic :: iso_c_binding, only : c_ptr, c_size_t, c_int
348 type(c_ptr) :: omp_target_alloc
349 integer(c_size_t), value :: size
350 integer(c_int), value :: device_num
351 end function omp_target_alloc
352 end interface
353
354 interface
355 subroutine omp_target_free (device_ptr, device_num) bind(c)
356 use, intrinsic :: iso_c_binding, only : c_ptr, c_int
357 type(c_ptr), value :: device_ptr
358 integer(c_int), value :: device_num
359 end subroutine omp_target_free
360 end interface
361
362 interface
363 function omp_target_is_present (ptr, device_num) bind(c)
364 use, intrinsic :: iso_c_binding, only : c_ptr, c_int
365 integer(c_int) :: omp_target_is_present
366 type(c_ptr), value :: ptr
367 integer(c_int), value :: device_num
368 end function omp_target_is_present
369 end interface
370
371 interface
372 function omp_target_memcpy (dst, src, length, dst_offset, &
373 & src_offset, dst_device_num, &
374 & src_device_num) bind(c)
375 use, intrinsic :: iso_c_binding, only : c_ptr, c_int, c_size_t
376 integer(c_int) :: omp_target_memcpy
377 type(c_ptr), value :: dst, src
378 integer(c_size_t), value :: length, dst_offset, src_offset
379 integer(c_int), value :: dst_device_num, src_device_num
380 end function omp_target_memcpy
381 end interface
382
383 interface
384 function omp_target_memcpy_async (dst, src, length, dst_offset, &
385 & src_offset, dst_device_num, &
386 & src_device_num, depobj_count, &
387 & depobj_list) bind(c)
388 use, intrinsic :: iso_c_binding, only : c_ptr, c_int, c_size_t
389 import :: omp_depend_kind
390 integer(c_int) :: omp_target_memcpy_async
391 type(c_ptr), value :: dst, src
392 integer(c_size_t), value :: length, dst_offset, src_offset
393 integer(c_int), value :: dst_device_num, src_device_num
394 integer(c_int), value :: depobj_count
395 integer(omp_depend_kind), optional :: depobj_list(*)
396 end function omp_target_memcpy_async
397 end interface
398
399 interface
400 function omp_target_memcpy_rect (dst,src,element_size, num_dims, &
401 & volume, dst_offsets, &
402 & src_offsets, dst_dimensions, &
403 & src_dimensions, dst_device_num, &
404 & src_device_num) bind(c)
405 use, intrinsic :: iso_c_binding, only : c_ptr, c_int, c_size_t
406 integer(c_int) :: omp_target_memcpy_rect
407 type(c_ptr), value :: dst, src
408 integer(c_size_t), value :: element_size
409 integer(c_int), value :: num_dims
410 integer(c_int), value :: dst_device_num, src_device_num
411 integer(c_size_t), intent(in) :: volume(*), dst_offsets(*)
412 integer(c_size_t), intent(in) :: src_offsets(*)
413 integer(c_size_t), intent(in) :: dst_dimensions(*)
414 integer(c_size_t), intent(in) :: src_dimensions(*)
415 end function omp_target_memcpy_rect
416 end interface
417
418 interface
419 function omp_target_memcpy_rect_async (dst,src,element_size, &
420 & num_dims, volume, &
421 & dst_offsets, src_offsets, &
422 & dst_dimensions, &
423 & src_dimensions, &
424 & dst_device_num, &
425 & src_device_num, &
426 & depobj_count, &
427 & depobj_list) bind(c)
428 use, intrinsic :: iso_c_binding, only : c_ptr, c_int, c_size_t
429 import :: omp_depend_kind
430 integer(c_int) :: omp_target_memcpy_rect_async
431 type(c_ptr), value :: dst, src
432 integer(c_size_t), value :: element_size
433 integer(c_int), value :: num_dims, depobj_count
434 integer(c_int), value :: dst_device_num, src_device_num
435 integer(c_size_t), intent(in) :: volume(*), dst_offsets(*)
436 integer(c_size_t), intent(in) :: src_offsets(*)
437 integer(c_size_t), intent(in) :: dst_dimensions(*)
438 integer(c_size_t), intent(in) :: src_dimensions(*)
439 integer(omp_depend_kind), optional :: depobj_list(*)
440 end function omp_target_memcpy_rect_async
441 end interface
442
443 interface
444 function omp_target_associate_ptr (host_ptr, device_ptr, size, &
445 & device_offset, device_num) &
446 & bind(c)
447 use, intrinsic :: iso_c_binding, only : c_ptr, c_size_t, c_int
448 integer(c_int) :: omp_target_associate_ptr
449 type(c_ptr), value :: host_ptr, device_ptr
450 integer(c_size_t), value :: size, device_offset
451 integer(c_int), value :: device_num
452 end function omp_target_associate_ptr
453 end interface
454
455 interface
456 function omp_target_disassociate_ptr (ptr, device_num) bind(c)
457 use, intrinsic :: iso_c_binding, only : c_ptr, c_int
458 integer(c_int) :: omp_target_disassociate_ptr
459 type(c_ptr), value :: ptr
460 integer(c_int), value :: device_num
461 end function omp_target_disassociate_ptr
462 end interface
463
464 interface
465 function omp_get_mapped_ptr (ptr, device_num) bind(c)
466 use, intrinsic :: iso_c_binding, only : c_ptr, c_int
467 type(c_ptr) :: omp_get_mapped_ptr
468 type(c_ptr), value :: ptr
469 integer(c_int), value :: device_num
470 end function omp_get_mapped_ptr
471 end interface
472
473 interface
474 function omp_target_is_accessible (ptr, size, device_num) &
475 & bind(c)
476 use, intrinsic :: iso_c_binding, only : c_ptr, c_size_t, c_int
477 integer(c_int) :: omp_target_is_accessible
478 type(c_ptr), value :: ptr
479 integer(c_size_t), value :: size
480 integer(c_int), value :: device_num
481 end function omp_target_is_accessible
482 end interface