Daily bump.
[official-gcc.git] / libgomp / libgomp.h
blob023d8a8c1df7f9da618f69125633559b7be9caef
1 /* Copyright (C) 2005-2021 Free Software Foundation, Inc.
2 Contributed by Richard Henderson <rth@redhat.com>.
4 This file is part of the GNU Offloading and Multi Processing Library
5 (libgomp).
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.
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.
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.
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/>. */
26 /* This file contains data types and function declarations that are not
27 part of the official OpenACC or OpenMP user interfaces. There are
28 declarations in here that are part of the GNU Offloading and Multi
29 Processing ABI, in that the compiler is required to know about them
30 and use them.
32 The convention is that the all caps prefix "GOMP" is used group items
33 that are part of the external ABI, and the lower case prefix "gomp"
34 is used group items that are completely private to the library. */
36 #ifndef LIBGOMP_H
37 #define LIBGOMP_H 1
39 #ifndef _LIBGOMP_CHECKING_
40 /* Define to 1 to perform internal sanity checks. */
41 #define _LIBGOMP_CHECKING_ 0
42 #endif
44 #include "config.h"
45 #include <stdint.h>
46 #include "libgomp-plugin.h"
47 #include "gomp-constants.h"
49 #ifdef HAVE_PTHREAD_H
50 #include <pthread.h>
51 #endif
52 #include <stdbool.h>
53 #include <stdlib.h>
54 #include <stdarg.h>
56 /* Needed for memset in priority_queue.c. */
57 #if _LIBGOMP_CHECKING_
58 # ifdef STRING_WITH_STRINGS
59 # include <string.h>
60 # include <strings.h>
61 # else
62 # ifdef HAVE_STRING_H
63 # include <string.h>
64 # else
65 # ifdef HAVE_STRINGS_H
66 # include <strings.h>
67 # endif
68 # endif
69 # endif
70 #endif
72 #ifdef HAVE_ATTRIBUTE_VISIBILITY
73 # pragma GCC visibility push(hidden)
74 #endif
76 /* If we were a C++ library, we'd get this from <std/atomic>. */
77 enum memmodel
79 MEMMODEL_RELAXED = 0,
80 MEMMODEL_CONSUME = 1,
81 MEMMODEL_ACQUIRE = 2,
82 MEMMODEL_RELEASE = 3,
83 MEMMODEL_ACQ_REL = 4,
84 MEMMODEL_SEQ_CST = 5
87 /* alloc.c */
89 #if defined(HAVE_ALIGNED_ALLOC) \
90 || defined(HAVE__ALIGNED_MALLOC) \
91 || defined(HAVE_POSIX_MEMALIGN) \
92 || defined(HAVE_MEMALIGN)
93 /* Defined if gomp_aligned_alloc doesn't use fallback version
94 and free can be used instead of gomp_aligned_free. */
95 #define GOMP_HAVE_EFFICIENT_ALIGNED_ALLOC 1
96 #endif
98 extern void *gomp_malloc (size_t) __attribute__((malloc));
99 extern void *gomp_malloc_cleared (size_t) __attribute__((malloc));
100 extern void *gomp_realloc (void *, size_t);
101 extern void *gomp_aligned_alloc (size_t, size_t)
102 __attribute__((malloc, alloc_size (2)));
103 extern void gomp_aligned_free (void *);
105 /* Avoid conflicting prototypes of alloca() in system headers by using
106 GCC's builtin alloca(). */
107 #define gomp_alloca(x) __builtin_alloca(x)
109 /* Optimized allocators for team-specific data that will die with the team. */
111 #ifdef __AMDGCN__
112 /* The arena is initialized in config/gcn/team.c. */
113 #define TEAM_ARENA_SIZE 64*1024 /* Must match the value in plugin-gcn.c. */
114 #define TEAM_ARENA_START 16 /* LDS offset of free pointer. */
115 #define TEAM_ARENA_FREE 24 /* LDS offset of free pointer. */
116 #define TEAM_ARENA_END 32 /* LDS offset of end pointer. */
118 static inline void * __attribute__((malloc))
119 team_malloc (size_t size)
121 /* 4-byte align the size. */
122 size = (size + 3) & ~3;
124 /* Allocate directly from the arena.
125 The compiler does not support DS atomics, yet. */
126 void *result;
127 asm ("ds_add_rtn_u64 %0, %1, %2\n\ts_waitcnt 0"
128 : "=v"(result) : "v"(TEAM_ARENA_FREE), "v"(size), "e"(1L) : "memory");
130 /* Handle OOM. */
131 if (result + size > *(void * __lds *)TEAM_ARENA_END)
133 /* While this is experimental, let's make sure we know when OOM
134 happens. */
135 const char msg[] = "GCN team arena exhausted\n";
136 write (2, msg, sizeof(msg)-1);
138 /* Fall back to using the heap (slowly). */
139 result = gomp_malloc (size);
141 return result;
144 static inline void * __attribute__((malloc))
145 team_malloc_cleared (size_t size)
147 char *result = team_malloc (size);
149 /* Clear the allocated memory. */
150 __builtin_memset (result, 0, size);
152 return result;
155 static inline void
156 team_free (void *ptr)
158 /* The whole arena is freed when the kernel exits.
159 However, if we fell back to using heap then we should free it.
160 It would be better if this function could be a no-op, but at least
161 LDS loads are cheap. */
162 if (ptr < *(void * __lds *)TEAM_ARENA_START
163 || ptr >= *(void * __lds *)TEAM_ARENA_END)
164 free (ptr);
166 #else
167 #define team_malloc(...) gomp_malloc (__VA_ARGS__)
168 #define team_malloc_cleared(...) gomp_malloc_cleared (__VA_ARGS__)
169 #define team_free(...) free (__VA_ARGS__)
170 #endif
172 /* error.c */
174 extern void gomp_vdebug (int, const char *, va_list);
175 extern void gomp_debug (int, const char *, ...)
176 __attribute__ ((format (printf, 2, 3)));
177 #define gomp_vdebug(KIND, FMT, VALIST) \
178 do { \
179 if (__builtin_expect (gomp_debug_var, 0)) \
180 (gomp_vdebug) ((KIND), (FMT), (VALIST)); \
181 } while (0)
182 #define gomp_debug(KIND, ...) \
183 do { \
184 if (__builtin_expect (gomp_debug_var, 0)) \
185 (gomp_debug) ((KIND), __VA_ARGS__); \
186 } while (0)
187 extern void gomp_verror (const char *, va_list);
188 extern void gomp_error (const char *, ...)
189 __attribute__ ((format (printf, 1, 2)));
190 extern void gomp_vfatal (const char *, va_list)
191 __attribute__ ((noreturn));
192 extern void gomp_fatal (const char *, ...)
193 __attribute__ ((noreturn, format (printf, 1, 2)));
195 struct gomp_task;
196 struct gomp_taskgroup;
197 struct htab;
199 #include "priority_queue.h"
200 #include "sem.h"
201 #include "mutex.h"
202 #include "bar.h"
203 #include "simple-bar.h"
204 #include "ptrlock.h"
207 /* This structure contains the data to control one work-sharing construct,
208 either a LOOP (FOR/DO) or a SECTIONS. */
210 enum gomp_schedule_type
212 GFS_RUNTIME,
213 GFS_STATIC,
214 GFS_DYNAMIC,
215 GFS_GUIDED,
216 GFS_AUTO,
217 GFS_MONOTONIC = 0x80000000U
220 struct gomp_doacross_work_share
222 union {
223 /* chunk_size copy, as ws->chunk_size is multiplied by incr for
224 GFS_DYNAMIC. */
225 long chunk_size;
226 /* Likewise, but for ull implementation. */
227 unsigned long long chunk_size_ull;
228 /* For schedule(static,0) this is the number
229 of iterations assigned to the last thread, i.e. number of
230 iterations / number of threads. */
231 long q;
232 /* Likewise, but for ull implementation. */
233 unsigned long long q_ull;
235 /* Size of each array entry (padded to cache line size). */
236 unsigned long elt_sz;
237 /* Number of dimensions in sink vectors. */
238 unsigned int ncounts;
239 /* True if the iterations can be flattened. */
240 bool flattened;
241 /* Actual array (of elt_sz sized units), aligned to cache line size.
242 This is indexed by team_id for GFS_STATIC and outermost iteration
243 / chunk_size for other schedules. */
244 unsigned char *array;
245 /* These two are only used for schedule(static,0). */
246 /* This one is number of iterations % number of threads. */
247 long t;
248 union {
249 /* And this one is cached t * (q + 1). */
250 long boundary;
251 /* Likewise, but for the ull implementation. */
252 unsigned long long boundary_ull;
254 /* Pointer to extra memory if needed for lastprivate(conditional). */
255 void *extra;
256 /* Array of shift counts for each dimension if they can be flattened. */
257 unsigned int shift_counts[];
260 /* Like struct gomp_work_share, but only the 1st cacheline of it plus
261 flexible array at the end.
262 Keep in sync with struct gomp_work_share. */
263 struct gomp_work_share_1st_cacheline
265 enum gomp_schedule_type sched;
266 int mode;
267 union {
268 struct {
269 long chunk_size, end, incr;
271 struct {
272 unsigned long long chunk_size_ull, end_ull, incr_ull;
275 union {
276 unsigned *ordered_team_ids;
277 struct gomp_doacross_work_share *doacross;
279 unsigned ordered_num_used, ordered_owner, ordered_cur;
280 struct gomp_work_share *next_alloc;
281 char pad[];
284 struct gomp_work_share
286 /* This member records the SCHEDULE clause to be used for this construct.
287 The user specification of "runtime" will already have been resolved.
288 If this is a SECTIONS construct, this value will always be DYNAMIC. */
289 enum gomp_schedule_type sched;
291 int mode;
293 union {
294 struct {
295 /* This is the chunk_size argument to the SCHEDULE clause. */
296 long chunk_size;
298 /* This is the iteration end point. If this is a SECTIONS construct,
299 this is the number of contained sections. */
300 long end;
302 /* This is the iteration step. If this is a SECTIONS construct, this
303 is always 1. */
304 long incr;
307 struct {
308 /* The same as above, but for the unsigned long long loop variants. */
309 unsigned long long chunk_size_ull;
310 unsigned long long end_ull;
311 unsigned long long incr_ull;
315 union {
316 /* This is a circular queue that details which threads will be allowed
317 into the ordered region and in which order. When a thread allocates
318 iterations on which it is going to work, it also registers itself at
319 the end of the array. When a thread reaches the ordered region, it
320 checks to see if it is the one at the head of the queue. If not, it
321 blocks on its RELEASE semaphore. */
322 unsigned *ordered_team_ids;
324 /* This is a pointer to DOACROSS work share data. */
325 struct gomp_doacross_work_share *doacross;
328 /* This is the number of threads that have registered themselves in
329 the circular queue ordered_team_ids. */
330 unsigned ordered_num_used;
332 /* This is the team_id of the currently acknowledged owner of the ordered
333 section, or -1u if the ordered section has not been acknowledged by
334 any thread. This is distinguished from the thread that is *allowed*
335 to take the section next. */
336 unsigned ordered_owner;
338 /* This is the index into the circular queue ordered_team_ids of the
339 current thread that's allowed into the ordered reason. */
340 unsigned ordered_cur;
342 /* This is a chain of allocated gomp_work_share blocks, valid only
343 in the first gomp_work_share struct in the block. */
344 struct gomp_work_share *next_alloc;
346 /* The above fields are written once during workshare initialization,
347 or related to ordered worksharing. Make sure the following fields
348 are in a different cache line. */
350 /* This lock protects the update of the following members. */
351 #ifdef GOMP_HAVE_EFFICIENT_ALIGNED_ALLOC
352 gomp_mutex_t lock __attribute__((aligned (64)));
353 #else
354 char pad[64 - offsetof (struct gomp_work_share_1st_cacheline, pad)];
355 gomp_mutex_t lock;
356 #endif
358 /* This is the count of the number of threads that have exited the work
359 share construct. If the construct was marked nowait, they have moved on
360 to other work; otherwise they're blocked on a barrier. The last member
361 of the team to exit the work share construct must deallocate it. */
362 unsigned threads_completed;
364 union {
365 /* This is the next iteration value to be allocated. In the case of
366 GFS_STATIC loops, this the iteration start point and never changes. */
367 long next;
369 /* The same, but with unsigned long long type. */
370 unsigned long long next_ull;
372 /* This is the returned data structure for SINGLE COPYPRIVATE. */
373 void *copyprivate;
376 union {
377 /* Link to gomp_work_share struct for next work sharing construct
378 encountered after this one. */
379 gomp_ptrlock_t next_ws;
381 /* gomp_work_share structs are chained in the free work share cache
382 through this. */
383 struct gomp_work_share *next_free;
386 /* Task reductions for this work-sharing construct. */
387 uintptr_t *task_reductions;
389 /* If only few threads are in the team, ordered_team_ids can point
390 to this array which fills the padding at the end of this struct. */
391 unsigned inline_ordered_team_ids[0];
394 extern char gomp_workshare_struct_check1
395 [offsetof (struct gomp_work_share_1st_cacheline, next_alloc)
396 == offsetof (struct gomp_work_share, next_alloc) ? 1 : -1];
397 extern char gomp_workshare_struct_check2
398 [offsetof (struct gomp_work_share, lock) == 64 ? 1 : -1];
400 /* This structure contains all of the thread-local data associated with
401 a thread team. This is the data that must be saved when a thread
402 encounters a nested PARALLEL construct. */
404 struct gomp_team_state
406 /* This is the team of which the thread is currently a member. */
407 struct gomp_team *team;
409 /* This is the work share construct which this thread is currently
410 processing. Recall that with NOWAIT, not all threads may be
411 processing the same construct. */
412 struct gomp_work_share *work_share;
414 /* This is the previous work share construct or NULL if there wasn't any.
415 When all threads are done with the current work sharing construct,
416 the previous one can be freed. The current one can't, as its
417 next_ws field is used. */
418 struct gomp_work_share *last_work_share;
420 /* This is the ID of this thread within the team. This value is
421 guaranteed to be between 0 and N-1, where N is the number of
422 threads in the team. */
423 unsigned team_id;
425 /* Nesting level. */
426 unsigned level;
428 /* Active nesting level. Only active parallel regions are counted. */
429 unsigned active_level;
431 /* Place-partition-var, offset and length into gomp_places_list array. */
432 unsigned place_partition_off;
433 unsigned place_partition_len;
435 /* Def-allocator-var ICV. */
436 uintptr_t def_allocator;
438 #ifdef HAVE_SYNC_BUILTINS
439 /* Number of single stmts encountered. */
440 unsigned long single_count;
441 #endif
443 /* For GFS_RUNTIME loops that resolved to GFS_STATIC, this is the
444 trip number through the loop. So first time a particular loop
445 is encountered this number is 0, the second time through the loop
446 is 1, etc. This is unused when the compiler knows in advance that
447 the loop is statically scheduled. */
448 unsigned long static_trip;
451 struct target_mem_desc;
453 /* These are the OpenMP 4.0 Internal Control Variables described in
454 section 2.3.1. Those described as having one copy per task are
455 stored within the structure; those described as having one copy
456 for the whole program are (naturally) global variables. */
458 struct gomp_task_icv
460 unsigned long nthreads_var;
461 enum gomp_schedule_type run_sched_var;
462 int run_sched_chunk_size;
463 int default_device_var;
464 unsigned int thread_limit_var;
465 bool dyn_var;
466 unsigned char max_active_levels_var;
467 char bind_var;
468 /* Internal ICV. */
469 struct target_mem_desc *target_data;
472 enum gomp_target_offload_t
474 GOMP_TARGET_OFFLOAD_DEFAULT,
475 GOMP_TARGET_OFFLOAD_MANDATORY,
476 GOMP_TARGET_OFFLOAD_DISABLED
479 #define gomp_supported_active_levels UCHAR_MAX
481 extern struct gomp_task_icv gomp_global_icv;
482 #ifndef HAVE_SYNC_BUILTINS
483 extern gomp_mutex_t gomp_managed_threads_lock;
484 #endif
485 extern bool gomp_cancel_var;
486 extern enum gomp_target_offload_t gomp_target_offload_var;
487 extern int gomp_max_task_priority_var;
488 extern unsigned long long gomp_spin_count_var, gomp_throttled_spin_count_var;
489 extern unsigned long gomp_available_cpus, gomp_managed_threads;
490 extern unsigned long *gomp_nthreads_var_list, gomp_nthreads_var_list_len;
491 extern char *gomp_bind_var_list;
492 extern unsigned long gomp_bind_var_list_len;
493 extern void **gomp_places_list;
494 extern unsigned long gomp_places_list_len;
495 extern unsigned int gomp_num_teams_var;
496 extern int gomp_nteams_var;
497 extern int gomp_teams_thread_limit_var;
498 extern int gomp_debug_var;
499 extern bool gomp_display_affinity_var;
500 extern char *gomp_affinity_format_var;
501 extern size_t gomp_affinity_format_len;
502 extern uintptr_t gomp_def_allocator;
503 extern int goacc_device_num;
504 extern char *goacc_device_type;
505 extern int goacc_default_dims[GOMP_DIM_MAX];
507 enum gomp_task_kind
509 /* Implicit task. */
510 GOMP_TASK_IMPLICIT,
511 /* Undeferred task. */
512 GOMP_TASK_UNDEFERRED,
513 /* Task created by GOMP_task and waiting to be run. */
514 GOMP_TASK_WAITING,
515 /* Task currently executing or scheduled and about to execute. */
516 GOMP_TASK_TIED,
517 /* Used for target tasks that have vars mapped and async run started,
518 but not yet completed. Once that completes, they will be readded
519 into the queues as GOMP_TASK_WAITING in order to perform the var
520 unmapping. */
521 GOMP_TASK_ASYNC_RUNNING,
522 /* Task that has finished executing but is waiting for its
523 completion event to be fulfilled. */
524 GOMP_TASK_DETACHED
527 struct gomp_task_depend_entry
529 /* Address of dependency. */
530 void *addr;
531 struct gomp_task_depend_entry *next;
532 struct gomp_task_depend_entry *prev;
533 /* Task that provides the dependency in ADDR. */
534 struct gomp_task *task;
535 /* Depend entry is of type "IN". */
536 bool is_in;
537 bool redundant;
538 bool redundant_out;
541 struct gomp_dependers_vec
543 size_t n_elem;
544 size_t allocated;
545 struct gomp_task *elem[];
548 /* Used when in GOMP_taskwait or in gomp_task_maybe_wait_for_dependencies. */
550 struct gomp_taskwait
552 bool in_taskwait;
553 bool in_depend_wait;
554 /* Number of tasks we are waiting for. */
555 size_t n_depend;
556 gomp_sem_t taskwait_sem;
559 /* This structure describes a "task" to be run by a thread. */
561 struct gomp_task
563 /* Parent of this task. */
564 struct gomp_task *parent;
565 /* Children of this task. */
566 struct priority_queue children_queue;
567 /* Taskgroup this task belongs in. */
568 struct gomp_taskgroup *taskgroup;
569 /* Tasks that depend on this task. */
570 struct gomp_dependers_vec *dependers;
571 struct htab *depend_hash;
572 struct gomp_taskwait *taskwait;
573 /* Number of items in DEPEND. */
574 size_t depend_count;
575 /* Number of tasks this task depends on. Once this counter reaches
576 0, we have no unsatisfied dependencies, and this task can be put
577 into the various queues to be scheduled. */
578 size_t num_dependees;
580 union {
581 /* Valid only if deferred_p is false. */
582 gomp_sem_t *completion_sem;
583 /* Valid only if deferred_p is true. Set to the team that executes the
584 task if the task is detached and the completion event has yet to be
585 fulfilled. */
586 struct gomp_team *detach_team;
588 bool deferred_p;
590 /* Priority of this task. */
591 int priority;
592 /* The priority node for this task in each of the different queues.
593 We put this here to avoid allocating space for each priority
594 node. Then we play offsetof() games to convert between pnode[]
595 entries and the gomp_task in which they reside. */
596 struct priority_node pnode[3];
598 struct gomp_task_icv icv;
599 void (*fn) (void *);
600 void *fn_data;
601 enum gomp_task_kind kind;
602 bool in_tied_task;
603 bool final_task;
604 bool copy_ctors_done;
605 /* Set for undeferred tasks with unsatisfied dependencies which
606 block further execution of their parent until the dependencies
607 are satisfied. */
608 bool parent_depends_on;
609 /* Dependencies provided and/or needed for this task. DEPEND_COUNT
610 is the number of items available. */
611 struct gomp_task_depend_entry depend[];
614 /* This structure describes a single #pragma omp taskgroup. */
616 struct gomp_taskgroup
618 struct gomp_taskgroup *prev;
619 /* Queue of tasks that belong in this taskgroup. */
620 struct priority_queue taskgroup_queue;
621 uintptr_t *reductions;
622 bool in_taskgroup_wait;
623 bool cancelled;
624 bool workshare;
625 gomp_sem_t taskgroup_sem;
626 size_t num_children;
629 /* Various state of OpenMP async offloading tasks. */
630 enum gomp_target_task_state
632 GOMP_TARGET_TASK_DATA,
633 GOMP_TARGET_TASK_BEFORE_MAP,
634 GOMP_TARGET_TASK_FALLBACK,
635 GOMP_TARGET_TASK_READY_TO_RUN,
636 GOMP_TARGET_TASK_RUNNING,
637 GOMP_TARGET_TASK_FINISHED
640 /* This structure describes a target task. */
642 struct gomp_target_task
644 struct gomp_device_descr *devicep;
645 void (*fn) (void *);
646 size_t mapnum;
647 size_t *sizes;
648 unsigned short *kinds;
649 unsigned int flags;
650 enum gomp_target_task_state state;
651 struct target_mem_desc *tgt;
652 struct gomp_task *task;
653 struct gomp_team *team;
654 /* Device-specific target arguments. */
655 void **args;
656 void *hostaddrs[];
659 /* This structure describes a "team" of threads. These are the threads
660 that are spawned by a PARALLEL constructs, as well as the work sharing
661 constructs that the team encounters. */
663 struct gomp_team
665 /* This is the number of threads in the current team. */
666 unsigned nthreads;
668 /* This is number of gomp_work_share structs that have been allocated
669 as a block last time. */
670 unsigned work_share_chunk;
672 /* This is the saved team state that applied to a master thread before
673 the current thread was created. */
674 struct gomp_team_state prev_ts;
676 /* This semaphore should be used by the master thread instead of its
677 "native" semaphore in the thread structure. Required for nested
678 parallels, as the master is a member of two teams. */
679 gomp_sem_t master_release;
681 /* This points to an array with pointers to the release semaphore
682 of the threads in the team. */
683 gomp_sem_t **ordered_release;
685 /* List of work shares on which gomp_fini_work_share hasn't been
686 called yet. If the team hasn't been cancelled, this should be
687 equal to each thr->ts.work_share, but otherwise it can be a possibly
688 long list of workshares. */
689 struct gomp_work_share *work_shares_to_free;
691 /* List of gomp_work_share structs chained through next_free fields.
692 This is populated and taken off only by the first thread in the
693 team encountering a new work sharing construct, in a critical
694 section. */
695 struct gomp_work_share *work_share_list_alloc;
697 /* List of gomp_work_share structs freed by free_work_share. New
698 entries are atomically added to the start of the list, and
699 alloc_work_share can safely only move all but the first entry
700 to work_share_list alloc, as free_work_share can happen concurrently
701 with alloc_work_share. */
702 struct gomp_work_share *work_share_list_free;
704 #ifdef HAVE_SYNC_BUILTINS
705 /* Number of simple single regions encountered by threads in this
706 team. */
707 unsigned long single_count;
708 #else
709 /* Mutex protecting addition of workshares to work_share_list_free. */
710 gomp_mutex_t work_share_list_free_lock;
711 #endif
713 /* This barrier is used for most synchronization of the team. */
714 gomp_barrier_t barrier;
716 /* Initial work shares, to avoid allocating any gomp_work_share
717 structs in the common case. */
718 struct gomp_work_share work_shares[8];
720 gomp_mutex_t task_lock;
721 /* Scheduled tasks. */
722 struct priority_queue task_queue;
723 /* Number of all GOMP_TASK_{WAITING,TIED} tasks in the team. */
724 unsigned int task_count;
725 /* Number of GOMP_TASK_WAITING tasks currently waiting to be scheduled. */
726 unsigned int task_queued_count;
727 /* Number of GOMP_TASK_{WAITING,TIED} tasks currently running
728 directly in gomp_barrier_handle_tasks; tasks spawned
729 from e.g. GOMP_taskwait or GOMP_taskgroup_end don't count, even when
730 that is called from a task run from gomp_barrier_handle_tasks.
731 task_running_count should be always <= team->nthreads,
732 and if current task isn't in_tied_task, then it will be
733 even < team->nthreads. */
734 unsigned int task_running_count;
735 int work_share_cancelled;
736 int team_cancelled;
738 /* Number of tasks waiting for their completion event to be fulfilled. */
739 unsigned int task_detach_count;
741 /* This array contains structures for implicit tasks. */
742 struct gomp_task implicit_task[];
745 /* This structure contains all data that is private to libgomp and is
746 allocated per thread. */
748 struct gomp_thread
750 /* This is the function that the thread should run upon launch. */
751 void (*fn) (void *data);
752 void *data;
754 /* This is the current team state for this thread. The ts.team member
755 is NULL only if the thread is idle. */
756 struct gomp_team_state ts;
758 /* This is the task that the thread is currently executing. */
759 struct gomp_task *task;
761 /* This semaphore is used for ordered loops. */
762 gomp_sem_t release;
764 /* Place this thread is bound to plus one, or zero if not bound
765 to any place. */
766 unsigned int place;
768 /* User pthread thread pool */
769 struct gomp_thread_pool *thread_pool;
771 #if defined(LIBGOMP_USE_PTHREADS) \
772 && (!defined(HAVE_TLS) \
773 || !defined(__GLIBC__) \
774 || !defined(USING_INITIAL_EXEC_TLS))
775 /* pthread_t of the thread containing this gomp_thread.
776 On Linux when using initial-exec TLS,
777 (typeof (pthread_t)) gomp_thread () - pthread_self ()
778 is constant in all threads, so we can optimize and not
779 store it. */
780 #define GOMP_NEEDS_THREAD_HANDLE 1
781 pthread_t handle;
782 #endif
786 struct gomp_thread_pool
788 /* This array manages threads spawned from the top level, which will
789 return to the idle loop once the current PARALLEL construct ends. */
790 struct gomp_thread **threads;
791 unsigned threads_size;
792 unsigned threads_used;
793 /* The last team is used for non-nested teams to delay their destruction to
794 make sure all the threads in the team move on to the pool's barrier before
795 the team's barrier is destroyed. */
796 struct gomp_team *last_team;
797 /* Number of threads running in this contention group. */
798 unsigned long threads_busy;
800 /* This barrier holds and releases threads waiting in thread pools. */
801 gomp_simple_barrier_t threads_dock;
804 enum gomp_cancel_kind
806 GOMP_CANCEL_PARALLEL = 1,
807 GOMP_CANCEL_LOOP = 2,
808 GOMP_CANCEL_FOR = GOMP_CANCEL_LOOP,
809 GOMP_CANCEL_DO = GOMP_CANCEL_LOOP,
810 GOMP_CANCEL_SECTIONS = 4,
811 GOMP_CANCEL_TASKGROUP = 8
814 /* ... and here is that TLS data. */
816 #if defined __nvptx__
817 extern struct gomp_thread *nvptx_thrs __attribute__((shared));
818 static inline struct gomp_thread *gomp_thread (void)
820 int tid;
821 asm ("mov.u32 %0, %%tid.y;" : "=r" (tid));
822 return nvptx_thrs + tid;
824 #elif defined __AMDGCN__
825 static inline struct gomp_thread *gcn_thrs (void)
827 /* The value is at the bottom of LDS. */
828 struct gomp_thread * __lds *thrs = (struct gomp_thread * __lds *)4;
829 return *thrs;
831 static inline void set_gcn_thrs (struct gomp_thread *val)
833 /* The value is at the bottom of LDS. */
834 struct gomp_thread * __lds *thrs = (struct gomp_thread * __lds *)4;
835 *thrs = val;
837 static inline struct gomp_thread *gomp_thread (void)
839 int tid = __builtin_gcn_dim_pos(1);
840 return gcn_thrs () + tid;
842 #elif defined HAVE_TLS || defined USE_EMUTLS
843 extern __thread struct gomp_thread gomp_tls_data;
844 static inline struct gomp_thread *gomp_thread (void)
846 return &gomp_tls_data;
848 #else
849 extern pthread_key_t gomp_tls_key;
850 static inline struct gomp_thread *gomp_thread (void)
852 return pthread_getspecific (gomp_tls_key);
854 #endif
856 extern struct gomp_task_icv *gomp_new_icv (void);
858 /* Here's how to access the current copy of the ICVs. */
860 static inline struct gomp_task_icv *gomp_icv (bool write)
862 struct gomp_task *task = gomp_thread ()->task;
863 if (task)
864 return &task->icv;
865 else if (write)
866 return gomp_new_icv ();
867 else
868 return &gomp_global_icv;
871 #ifdef LIBGOMP_USE_PTHREADS
872 /* The attributes to be used during thread creation. */
873 extern pthread_attr_t gomp_thread_attr;
875 extern pthread_key_t gomp_thread_destructor;
876 #endif
878 /* Function prototypes. */
880 /* affinity.c */
882 extern void gomp_init_affinity (void);
883 #ifdef LIBGOMP_USE_PTHREADS
884 extern void gomp_init_thread_affinity (pthread_attr_t *, unsigned int);
885 #endif
886 extern void **gomp_affinity_alloc (unsigned long, bool);
887 extern void gomp_affinity_init_place (void *);
888 extern bool gomp_affinity_add_cpus (void *, unsigned long, unsigned long,
889 long, bool);
890 extern bool gomp_affinity_remove_cpu (void *, unsigned long);
891 extern bool gomp_affinity_copy_place (void *, void *, long);
892 extern bool gomp_affinity_same_place (void *, void *);
893 extern bool gomp_affinity_finalize_place_list (bool);
894 extern bool gomp_affinity_init_level (int, unsigned long, bool);
895 extern void gomp_affinity_print_place (void *);
896 extern void gomp_get_place_proc_ids_8 (int, int64_t *);
897 extern void gomp_display_affinity_place (char *, size_t, size_t *, int);
899 /* affinity-fmt.c */
901 extern bool gomp_print_string (const char *str, size_t len);
902 extern void gomp_set_affinity_format (const char *, size_t);
903 extern void gomp_display_string (char *, size_t, size_t *, const char *,
904 size_t);
905 #ifdef LIBGOMP_USE_PTHREADS
906 typedef pthread_t gomp_thread_handle;
907 #else
908 typedef struct {} gomp_thread_handle;
909 #endif
910 extern size_t gomp_display_affinity (char *, size_t, const char *,
911 gomp_thread_handle,
912 struct gomp_team_state *, unsigned int);
913 extern void gomp_display_affinity_thread (gomp_thread_handle,
914 struct gomp_team_state *,
915 unsigned int) __attribute__((cold));
917 /* iter.c */
919 extern int gomp_iter_static_next (long *, long *);
920 extern bool gomp_iter_dynamic_next_locked (long *, long *);
921 extern bool gomp_iter_guided_next_locked (long *, long *);
923 #ifdef HAVE_SYNC_BUILTINS
924 extern bool gomp_iter_dynamic_next (long *, long *);
925 extern bool gomp_iter_guided_next (long *, long *);
926 #endif
928 /* iter_ull.c */
930 extern int gomp_iter_ull_static_next (unsigned long long *,
931 unsigned long long *);
932 extern bool gomp_iter_ull_dynamic_next_locked (unsigned long long *,
933 unsigned long long *);
934 extern bool gomp_iter_ull_guided_next_locked (unsigned long long *,
935 unsigned long long *);
937 #if defined HAVE_SYNC_BUILTINS && defined __LP64__
938 extern bool gomp_iter_ull_dynamic_next (unsigned long long *,
939 unsigned long long *);
940 extern bool gomp_iter_ull_guided_next (unsigned long long *,
941 unsigned long long *);
942 #endif
944 /* ordered.c */
946 extern void gomp_ordered_first (void);
947 extern void gomp_ordered_last (void);
948 extern void gomp_ordered_next (void);
949 extern void gomp_ordered_static_init (void);
950 extern void gomp_ordered_static_next (void);
951 extern void gomp_ordered_sync (void);
952 extern void gomp_doacross_init (unsigned, long *, long, size_t);
953 extern void gomp_doacross_ull_init (unsigned, unsigned long long *,
954 unsigned long long, size_t);
956 /* parallel.c */
958 extern unsigned gomp_resolve_num_threads (unsigned, unsigned);
960 /* proc.c (in config/) */
962 extern void gomp_init_num_threads (void);
963 extern unsigned gomp_dynamic_max_threads (void);
965 /* task.c */
967 extern void gomp_init_task (struct gomp_task *, struct gomp_task *,
968 struct gomp_task_icv *);
969 extern void gomp_end_task (void);
970 extern void gomp_barrier_handle_tasks (gomp_barrier_state_t);
971 extern void gomp_task_maybe_wait_for_dependencies (void **);
972 extern bool gomp_create_target_task (struct gomp_device_descr *,
973 void (*) (void *), size_t, void **,
974 size_t *, unsigned short *, unsigned int,
975 void **, void **,
976 enum gomp_target_task_state);
977 extern struct gomp_taskgroup *gomp_parallel_reduction_register (uintptr_t *,
978 unsigned);
979 extern void gomp_workshare_taskgroup_start (void);
980 extern void gomp_workshare_task_reduction_register (uintptr_t *, uintptr_t *);
982 static void inline
983 gomp_finish_task (struct gomp_task *task)
985 if (__builtin_expect (task->depend_hash != NULL, 0))
986 free (task->depend_hash);
989 /* team.c */
991 extern struct gomp_team *gomp_new_team (unsigned);
992 extern void gomp_team_start (void (*) (void *), void *, unsigned,
993 unsigned, struct gomp_team *,
994 struct gomp_taskgroup *);
995 extern void gomp_team_end (void);
996 extern void gomp_free_thread (void *);
997 extern int gomp_pause_host (void);
999 /* target.c */
1001 extern void gomp_init_targets_once (void);
1002 extern int gomp_get_num_devices (void);
1003 extern bool gomp_target_task_fn (void *);
1005 /* Splay tree definitions. */
1006 typedef struct splay_tree_node_s *splay_tree_node;
1007 typedef struct splay_tree_s *splay_tree;
1008 typedef struct splay_tree_key_s *splay_tree_key;
1010 struct target_var_desc {
1011 /* Splay key. */
1012 splay_tree_key key;
1013 /* True if data should be copied from device to host at the end. */
1014 bool copy_from;
1015 /* True if data always should be copied from device to host at the end. */
1016 bool always_copy_from;
1017 /* True if this is for OpenACC 'attach'. */
1018 bool is_attach;
1019 /* If GOMP_MAP_TO_PSET had a NULL pointer; used for Fortran descriptors,
1020 which were initially unallocated. */
1021 bool has_null_ptr_assoc;
1022 /* Relative offset against key host_start. */
1023 uintptr_t offset;
1024 /* Actual length. */
1025 uintptr_t length;
1028 struct target_mem_desc {
1029 /* Reference count. */
1030 uintptr_t refcount;
1031 /* All the splay nodes allocated together. */
1032 splay_tree_node array;
1033 /* Start of the target region. */
1034 uintptr_t tgt_start;
1035 /* End of the targer region. */
1036 uintptr_t tgt_end;
1037 /* Handle to free. */
1038 void *to_free;
1039 /* Previous target_mem_desc. */
1040 struct target_mem_desc *prev;
1041 /* Number of items in following list. */
1042 size_t list_count;
1044 /* Corresponding target device descriptor. */
1045 struct gomp_device_descr *device_descr;
1047 /* List of target items to remove (or decrease refcount)
1048 at the end of region. */
1049 struct target_var_desc list[];
1052 /* Special value for refcount - mask to indicate existence of special
1053 values. Right now we allocate 3 bits. */
1054 #define REFCOUNT_SPECIAL (~(uintptr_t) 0x7)
1056 /* Special value for refcount - infinity. */
1057 #define REFCOUNT_INFINITY (REFCOUNT_SPECIAL | 0)
1058 /* Special value for refcount - tgt_offset contains target address of the
1059 artificial pointer to "omp declare target link" object. */
1060 #define REFCOUNT_LINK (REFCOUNT_SPECIAL | 1)
1062 /* Special value for refcount - structure element sibling list items.
1063 All such key refounts have REFCOUNT_STRUCTELEM bits set, with _FLAG_FIRST
1064 and _FLAG_LAST indicating first and last in the created sibling sequence. */
1065 #define REFCOUNT_STRUCTELEM (REFCOUNT_SPECIAL | 4)
1066 #define REFCOUNT_STRUCTELEM_P(V) \
1067 (((V) & REFCOUNT_STRUCTELEM) == REFCOUNT_STRUCTELEM)
1068 /* The first leading key with _FLAG_FIRST set houses the actual reference count
1069 in the structelem_refcount field. Other siblings point to this counter value
1070 through its structelem_refcount_ptr field. */
1071 #define REFCOUNT_STRUCTELEM_FLAG_FIRST (1)
1072 /* The last key in the sibling sequence has this set. This is required to
1073 indicate the sequence boundary, when we remove the structure sibling list
1074 from the map. */
1075 #define REFCOUNT_STRUCTELEM_FLAG_LAST (2)
1077 #define REFCOUNT_STRUCTELEM_FIRST_P(V) \
1078 (REFCOUNT_STRUCTELEM_P (V) && ((V) & REFCOUNT_STRUCTELEM_FLAG_FIRST))
1079 #define REFCOUNT_STRUCTELEM_LAST_P(V) \
1080 (REFCOUNT_STRUCTELEM_P (V) && ((V) & REFCOUNT_STRUCTELEM_FLAG_LAST))
1082 /* Special offset values. */
1083 #define OFFSET_INLINED (~(uintptr_t) 0)
1084 #define OFFSET_POINTER (~(uintptr_t) 1)
1085 #define OFFSET_STRUCT (~(uintptr_t) 2)
1087 /* Auxiliary structure for infrequently-used or API-specific data. */
1089 struct splay_tree_aux {
1090 /* Pointer to the original mapping of "omp declare target link" object. */
1091 splay_tree_key link_key;
1092 /* For a block with attached pointers, the attachment counters for each.
1093 Only used for OpenACC. */
1094 uintptr_t *attach_count;
1097 struct splay_tree_key_s {
1098 /* Address of the host object. */
1099 uintptr_t host_start;
1100 /* Address immediately after the host object. */
1101 uintptr_t host_end;
1102 /* Descriptor of the target memory. */
1103 struct target_mem_desc *tgt;
1104 /* Offset from tgt->tgt_start to the start of the target object. */
1105 uintptr_t tgt_offset;
1106 /* Reference count. */
1107 uintptr_t refcount;
1108 union {
1109 /* Dynamic reference count. */
1110 uintptr_t dynamic_refcount;
1112 /* Unified reference count for structure element siblings, this is used
1113 when REFCOUNT_STRUCTELEM_FIRST_P(k->refcount) == true, the first sibling
1114 in a structure element sibling list item sequence. */
1115 uintptr_t structelem_refcount;
1117 /* When REFCOUNT_STRUCTELEM_P (k->refcount) == true, this field points
1118 into the (above) structelem_refcount field of the _FIRST splay_tree_key,
1119 the first key in the created sequence. All structure element siblings
1120 share a single refcount in this manner. Since these two fields won't be
1121 used at the same time, they are stashed in a union. */
1122 uintptr_t *structelem_refcount_ptr;
1124 struct splay_tree_aux *aux;
1127 /* The comparison function. */
1129 static inline int
1130 splay_compare (splay_tree_key x, splay_tree_key y)
1132 if (x->host_start == x->host_end
1133 && y->host_start == y->host_end)
1134 return 0;
1135 if (x->host_end <= y->host_start)
1136 return -1;
1137 if (x->host_start >= y->host_end)
1138 return 1;
1139 return 0;
1142 #include "splay-tree.h"
1144 typedef struct acc_dispatch_t
1146 /* Execute. */
1147 __typeof (GOMP_OFFLOAD_openacc_exec) *exec_func;
1149 /* Create/destroy TLS data. */
1150 __typeof (GOMP_OFFLOAD_openacc_create_thread_data) *create_thread_data_func;
1151 __typeof (GOMP_OFFLOAD_openacc_destroy_thread_data)
1152 *destroy_thread_data_func;
1154 struct {
1155 /* Once created and put into the "active" list, asyncqueues are then never
1156 destructed and removed from the "active" list, other than if the TODO
1157 device is shut down. */
1158 gomp_mutex_t lock;
1159 int nasyncqueue;
1160 struct goacc_asyncqueue **asyncqueue;
1161 struct goacc_asyncqueue_list *active;
1163 __typeof (GOMP_OFFLOAD_openacc_async_construct) *construct_func;
1164 __typeof (GOMP_OFFLOAD_openacc_async_destruct) *destruct_func;
1165 __typeof (GOMP_OFFLOAD_openacc_async_test) *test_func;
1166 __typeof (GOMP_OFFLOAD_openacc_async_synchronize) *synchronize_func;
1167 __typeof (GOMP_OFFLOAD_openacc_async_serialize) *serialize_func;
1168 __typeof (GOMP_OFFLOAD_openacc_async_queue_callback) *queue_callback_func;
1170 __typeof (GOMP_OFFLOAD_openacc_async_exec) *exec_func;
1171 __typeof (GOMP_OFFLOAD_openacc_async_dev2host) *dev2host_func;
1172 __typeof (GOMP_OFFLOAD_openacc_async_host2dev) *host2dev_func;
1173 } async;
1175 __typeof (GOMP_OFFLOAD_openacc_get_property) *get_property_func;
1177 /* NVIDIA target specific routines. */
1178 struct {
1179 __typeof (GOMP_OFFLOAD_openacc_cuda_get_current_device)
1180 *get_current_device_func;
1181 __typeof (GOMP_OFFLOAD_openacc_cuda_get_current_context)
1182 *get_current_context_func;
1183 __typeof (GOMP_OFFLOAD_openacc_cuda_get_stream) *get_stream_func;
1184 __typeof (GOMP_OFFLOAD_openacc_cuda_set_stream) *set_stream_func;
1185 } cuda;
1186 } acc_dispatch_t;
1188 /* Various state of the accelerator device. */
1189 enum gomp_device_state
1191 GOMP_DEVICE_UNINITIALIZED,
1192 GOMP_DEVICE_INITIALIZED,
1193 GOMP_DEVICE_FINALIZED
1196 /* This structure describes accelerator device.
1197 It contains name of the corresponding libgomp plugin, function handlers for
1198 interaction with the device, ID-number of the device, and information about
1199 mapped memory. */
1200 struct gomp_device_descr
1202 /* Immutable data, which is only set during initialization, and which is not
1203 guarded by the lock. */
1205 /* The name of the device. */
1206 const char *name;
1208 /* Capabilities of device (supports OpenACC, OpenMP). */
1209 unsigned int capabilities;
1211 /* This is the ID number of device among devices of the same type. */
1212 int target_id;
1214 /* This is the TYPE of device. */
1215 enum offload_target_type type;
1217 /* Function handlers. */
1218 __typeof (GOMP_OFFLOAD_get_name) *get_name_func;
1219 __typeof (GOMP_OFFLOAD_get_caps) *get_caps_func;
1220 __typeof (GOMP_OFFLOAD_get_type) *get_type_func;
1221 __typeof (GOMP_OFFLOAD_get_num_devices) *get_num_devices_func;
1222 __typeof (GOMP_OFFLOAD_init_device) *init_device_func;
1223 __typeof (GOMP_OFFLOAD_fini_device) *fini_device_func;
1224 __typeof (GOMP_OFFLOAD_version) *version_func;
1225 __typeof (GOMP_OFFLOAD_load_image) *load_image_func;
1226 __typeof (GOMP_OFFLOAD_unload_image) *unload_image_func;
1227 __typeof (GOMP_OFFLOAD_alloc) *alloc_func;
1228 __typeof (GOMP_OFFLOAD_free) *free_func;
1229 __typeof (GOMP_OFFLOAD_dev2host) *dev2host_func;
1230 __typeof (GOMP_OFFLOAD_host2dev) *host2dev_func;
1231 __typeof (GOMP_OFFLOAD_dev2dev) *dev2dev_func;
1232 __typeof (GOMP_OFFLOAD_can_run) *can_run_func;
1233 __typeof (GOMP_OFFLOAD_run) *run_func;
1234 __typeof (GOMP_OFFLOAD_async_run) *async_run_func;
1236 /* Splay tree containing information about mapped memory regions. */
1237 struct splay_tree_s mem_map;
1239 /* Mutex for the mutable data. */
1240 gomp_mutex_t lock;
1242 /* Current state of the device. OpenACC allows to move from INITIALIZED state
1243 back to UNINITIALIZED state. OpenMP allows only to move from INITIALIZED
1244 to FINALIZED state (at program shutdown). */
1245 enum gomp_device_state state;
1247 /* OpenACC-specific data and functions. */
1248 /* This is mutable because of its mutable target_data member. */
1249 acc_dispatch_t openacc;
1252 /* Kind of the pragma, for which gomp_map_vars () is called. */
1253 enum gomp_map_vars_kind
1255 GOMP_MAP_VARS_OPENACC = 1,
1256 GOMP_MAP_VARS_TARGET = 2,
1257 GOMP_MAP_VARS_DATA = 4,
1258 GOMP_MAP_VARS_ENTER_DATA = 8
1261 extern void gomp_acc_declare_allocate (bool, size_t, void **, size_t *,
1262 unsigned short *);
1263 struct gomp_coalesce_buf;
1264 extern void gomp_copy_host2dev (struct gomp_device_descr *,
1265 struct goacc_asyncqueue *, void *, const void *,
1266 size_t, bool, struct gomp_coalesce_buf *);
1267 extern void gomp_copy_dev2host (struct gomp_device_descr *,
1268 struct goacc_asyncqueue *, void *, const void *,
1269 size_t);
1270 extern uintptr_t gomp_map_val (struct target_mem_desc *, void **, size_t);
1271 extern void gomp_attach_pointer (struct gomp_device_descr *,
1272 struct goacc_asyncqueue *, splay_tree,
1273 splay_tree_key, uintptr_t, size_t,
1274 struct gomp_coalesce_buf *);
1275 extern void gomp_detach_pointer (struct gomp_device_descr *,
1276 struct goacc_asyncqueue *, splay_tree_key,
1277 uintptr_t, bool, struct gomp_coalesce_buf *);
1278 extern struct target_mem_desc *goacc_map_vars (struct gomp_device_descr *,
1279 struct goacc_asyncqueue *,
1280 size_t, void **, void **,
1281 size_t *, void *, bool,
1282 enum gomp_map_vars_kind);
1283 extern void goacc_unmap_vars (struct target_mem_desc *, bool,
1284 struct goacc_asyncqueue *);
1285 extern void gomp_init_device (struct gomp_device_descr *);
1286 extern bool gomp_fini_device (struct gomp_device_descr *);
1287 extern void gomp_unload_device (struct gomp_device_descr *);
1288 extern bool gomp_remove_var (struct gomp_device_descr *, splay_tree_key);
1289 extern void gomp_remove_var_async (struct gomp_device_descr *, splay_tree_key,
1290 struct goacc_asyncqueue *);
1292 /* work.c */
1294 extern void gomp_init_work_share (struct gomp_work_share *, size_t, unsigned);
1295 extern void gomp_fini_work_share (struct gomp_work_share *);
1296 extern bool gomp_work_share_start (size_t);
1297 extern void gomp_work_share_end (void);
1298 extern bool gomp_work_share_end_cancel (void);
1299 extern void gomp_work_share_end_nowait (void);
1301 static inline void
1302 gomp_work_share_init_done (void)
1304 struct gomp_thread *thr = gomp_thread ();
1305 if (__builtin_expect (thr->ts.last_work_share != NULL, 1))
1306 gomp_ptrlock_set (&thr->ts.last_work_share->next_ws, thr->ts.work_share);
1309 #ifdef HAVE_ATTRIBUTE_VISIBILITY
1310 # pragma GCC visibility pop
1311 #endif
1313 /* Now that we're back to default visibility, include the globals. */
1314 #include "libgomp_g.h"
1316 /* Include omp.h by parts. */
1317 #include "omp-lock.h"
1318 #define _LIBGOMP_OMP_LOCK_DEFINED 1
1319 #include "omp.h.in"
1321 #if !defined (HAVE_ATTRIBUTE_VISIBILITY) \
1322 || !defined (HAVE_ATTRIBUTE_ALIAS) \
1323 || !defined (HAVE_AS_SYMVER_DIRECTIVE) \
1324 || !defined (PIC) \
1325 || !defined (HAVE_SYMVER_SYMBOL_RENAMING_RUNTIME_SUPPORT)
1326 # undef LIBGOMP_GNU_SYMBOL_VERSIONING
1327 #endif
1329 #ifdef LIBGOMP_GNU_SYMBOL_VERSIONING
1330 extern void gomp_init_lock_30 (omp_lock_t *) __GOMP_NOTHROW;
1331 extern void gomp_destroy_lock_30 (omp_lock_t *) __GOMP_NOTHROW;
1332 extern void gomp_set_lock_30 (omp_lock_t *) __GOMP_NOTHROW;
1333 extern void gomp_unset_lock_30 (omp_lock_t *) __GOMP_NOTHROW;
1334 extern int gomp_test_lock_30 (omp_lock_t *) __GOMP_NOTHROW;
1335 extern void gomp_init_nest_lock_30 (omp_nest_lock_t *) __GOMP_NOTHROW;
1336 extern void gomp_destroy_nest_lock_30 (omp_nest_lock_t *) __GOMP_NOTHROW;
1337 extern void gomp_set_nest_lock_30 (omp_nest_lock_t *) __GOMP_NOTHROW;
1338 extern void gomp_unset_nest_lock_30 (omp_nest_lock_t *) __GOMP_NOTHROW;
1339 extern int gomp_test_nest_lock_30 (omp_nest_lock_t *) __GOMP_NOTHROW;
1341 extern void gomp_init_lock_25 (omp_lock_25_t *) __GOMP_NOTHROW;
1342 extern void gomp_destroy_lock_25 (omp_lock_25_t *) __GOMP_NOTHROW;
1343 extern void gomp_set_lock_25 (omp_lock_25_t *) __GOMP_NOTHROW;
1344 extern void gomp_unset_lock_25 (omp_lock_25_t *) __GOMP_NOTHROW;
1345 extern int gomp_test_lock_25 (omp_lock_25_t *) __GOMP_NOTHROW;
1346 extern void gomp_init_nest_lock_25 (omp_nest_lock_25_t *) __GOMP_NOTHROW;
1347 extern void gomp_destroy_nest_lock_25 (omp_nest_lock_25_t *) __GOMP_NOTHROW;
1348 extern void gomp_set_nest_lock_25 (omp_nest_lock_25_t *) __GOMP_NOTHROW;
1349 extern void gomp_unset_nest_lock_25 (omp_nest_lock_25_t *) __GOMP_NOTHROW;
1350 extern int gomp_test_nest_lock_25 (omp_nest_lock_25_t *) __GOMP_NOTHROW;
1352 # define omp_lock_symver(fn) \
1353 __asm (".symver g" #fn "_30, " #fn "@@OMP_3.0"); \
1354 __asm (".symver g" #fn "_25, " #fn "@OMP_1.0");
1355 #else
1356 # define gomp_init_lock_30 omp_init_lock
1357 # define gomp_destroy_lock_30 omp_destroy_lock
1358 # define gomp_set_lock_30 omp_set_lock
1359 # define gomp_unset_lock_30 omp_unset_lock
1360 # define gomp_test_lock_30 omp_test_lock
1361 # define gomp_init_nest_lock_30 omp_init_nest_lock
1362 # define gomp_destroy_nest_lock_30 omp_destroy_nest_lock
1363 # define gomp_set_nest_lock_30 omp_set_nest_lock
1364 # define gomp_unset_nest_lock_30 omp_unset_nest_lock
1365 # define gomp_test_nest_lock_30 omp_test_nest_lock
1366 #endif
1368 #ifdef HAVE_ATTRIBUTE_VISIBILITY
1369 # define attribute_hidden __attribute__ ((visibility ("hidden")))
1370 #else
1371 # define attribute_hidden
1372 #endif
1374 #if __GNUC__ >= 9
1375 # define HAVE_ATTRIBUTE_COPY
1376 #endif
1378 #ifdef HAVE_ATTRIBUTE_COPY
1379 # define attribute_copy(arg) __attribute__ ((copy (arg)))
1380 #else
1381 # define attribute_copy(arg)
1382 #endif
1384 #ifdef HAVE_ATTRIBUTE_ALIAS
1385 # define strong_alias(fn, al) \
1386 extern __typeof (fn) al __attribute__ ((alias (#fn))) attribute_copy (fn);
1388 # define ialias_ulp ialias_str1(__USER_LABEL_PREFIX__)
1389 # define ialias_str1(x) ialias_str2(x)
1390 # define ialias_str2(x) #x
1391 # define ialias(fn) \
1392 extern __typeof (fn) gomp_ialias_##fn \
1393 __attribute__ ((alias (#fn))) attribute_hidden attribute_copy (fn);
1394 # define ialias_redirect(fn) \
1395 extern __typeof (fn) fn __asm__ (ialias_ulp "gomp_ialias_" #fn) attribute_hidden;
1396 # define ialias_call(fn) gomp_ialias_ ## fn
1397 #else
1398 # define ialias(fn)
1399 # define ialias_redirect(fn)
1400 # define ialias_call(fn) fn
1401 #endif
1403 /* Helper function for priority_node_to_task() and
1404 task_to_priority_node().
1406 Return the offset from a task to its priority_node entry. The
1407 priority_node entry is has a type of TYPE. */
1409 static inline size_t
1410 priority_queue_offset (enum priority_queue_type type)
1412 return offsetof (struct gomp_task, pnode[(int) type]);
1415 /* Return the task associated with a priority NODE of type TYPE. */
1417 static inline struct gomp_task *
1418 priority_node_to_task (enum priority_queue_type type,
1419 struct priority_node *node)
1421 return (struct gomp_task *) ((char *) node - priority_queue_offset (type));
1424 /* Return the priority node of type TYPE for a given TASK. */
1426 static inline struct priority_node *
1427 task_to_priority_node (enum priority_queue_type type,
1428 struct gomp_task *task)
1430 return (struct priority_node *) ((char *) task
1431 + priority_queue_offset (type));
1434 #ifdef LIBGOMP_USE_PTHREADS
1435 static inline gomp_thread_handle
1436 gomp_thread_self (void)
1438 return pthread_self ();
1441 static inline gomp_thread_handle
1442 gomp_thread_to_pthread_t (struct gomp_thread *thr)
1444 struct gomp_thread *this_thr = gomp_thread ();
1445 if (thr == this_thr)
1446 return pthread_self ();
1447 #ifdef GOMP_NEEDS_THREAD_HANDLE
1448 return thr->handle;
1449 #else
1450 /* On Linux with initial-exec TLS, the pthread_t of the thread containing
1451 thr can be computed from thr, this_thr and pthread_self (),
1452 as the distance between this_thr and pthread_self () is constant. */
1453 return pthread_self () + ((uintptr_t) thr - (uintptr_t) this_thr);
1454 #endif
1456 #else
1457 static inline gomp_thread_handle
1458 gomp_thread_self (void)
1460 return (gomp_thread_handle) {};
1463 static inline gomp_thread_handle
1464 gomp_thread_to_pthread_t (struct gomp_thread *thr)
1466 (void) thr;
1467 return gomp_thread_self ();
1469 #endif
1471 #endif /* LIBGOMP_H */