Daily bump.
[official-gcc.git] / libgomp / libgomp.h
blob33a9591285fea104a48faecb04106ca760929f9d
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 struct gomp_work_share
262 /* This member records the SCHEDULE clause to be used for this construct.
263 The user specification of "runtime" will already have been resolved.
264 If this is a SECTIONS construct, this value will always be DYNAMIC. */
265 enum gomp_schedule_type sched;
267 int mode;
269 union {
270 struct {
271 /* This is the chunk_size argument to the SCHEDULE clause. */
272 long chunk_size;
274 /* This is the iteration end point. If this is a SECTIONS construct,
275 this is the number of contained sections. */
276 long end;
278 /* This is the iteration step. If this is a SECTIONS construct, this
279 is always 1. */
280 long incr;
283 struct {
284 /* The same as above, but for the unsigned long long loop variants. */
285 unsigned long long chunk_size_ull;
286 unsigned long long end_ull;
287 unsigned long long incr_ull;
291 union {
292 /* This is a circular queue that details which threads will be allowed
293 into the ordered region and in which order. When a thread allocates
294 iterations on which it is going to work, it also registers itself at
295 the end of the array. When a thread reaches the ordered region, it
296 checks to see if it is the one at the head of the queue. If not, it
297 blocks on its RELEASE semaphore. */
298 unsigned *ordered_team_ids;
300 /* This is a pointer to DOACROSS work share data. */
301 struct gomp_doacross_work_share *doacross;
304 /* This is the number of threads that have registered themselves in
305 the circular queue ordered_team_ids. */
306 unsigned ordered_num_used;
308 /* This is the team_id of the currently acknowledged owner of the ordered
309 section, or -1u if the ordered section has not been acknowledged by
310 any thread. This is distinguished from the thread that is *allowed*
311 to take the section next. */
312 unsigned ordered_owner;
314 /* This is the index into the circular queue ordered_team_ids of the
315 current thread that's allowed into the ordered reason. */
316 unsigned ordered_cur;
318 /* This is a chain of allocated gomp_work_share blocks, valid only
319 in the first gomp_work_share struct in the block. */
320 struct gomp_work_share *next_alloc;
322 /* The above fields are written once during workshare initialization,
323 or related to ordered worksharing. Make sure the following fields
324 are in a different cache line. */
326 /* This lock protects the update of the following members. */
327 gomp_mutex_t lock __attribute__((aligned (64)));
329 /* This is the count of the number of threads that have exited the work
330 share construct. If the construct was marked nowait, they have moved on
331 to other work; otherwise they're blocked on a barrier. The last member
332 of the team to exit the work share construct must deallocate it. */
333 unsigned threads_completed;
335 union {
336 /* This is the next iteration value to be allocated. In the case of
337 GFS_STATIC loops, this the iteration start point and never changes. */
338 long next;
340 /* The same, but with unsigned long long type. */
341 unsigned long long next_ull;
343 /* This is the returned data structure for SINGLE COPYPRIVATE. */
344 void *copyprivate;
347 union {
348 /* Link to gomp_work_share struct for next work sharing construct
349 encountered after this one. */
350 gomp_ptrlock_t next_ws;
352 /* gomp_work_share structs are chained in the free work share cache
353 through this. */
354 struct gomp_work_share *next_free;
357 /* Task reductions for this work-sharing construct. */
358 uintptr_t *task_reductions;
360 /* If only few threads are in the team, ordered_team_ids can point
361 to this array which fills the padding at the end of this struct. */
362 unsigned inline_ordered_team_ids[0];
365 /* This structure contains all of the thread-local data associated with
366 a thread team. This is the data that must be saved when a thread
367 encounters a nested PARALLEL construct. */
369 struct gomp_team_state
371 /* This is the team of which the thread is currently a member. */
372 struct gomp_team *team;
374 /* This is the work share construct which this thread is currently
375 processing. Recall that with NOWAIT, not all threads may be
376 processing the same construct. */
377 struct gomp_work_share *work_share;
379 /* This is the previous work share construct or NULL if there wasn't any.
380 When all threads are done with the current work sharing construct,
381 the previous one can be freed. The current one can't, as its
382 next_ws field is used. */
383 struct gomp_work_share *last_work_share;
385 /* This is the ID of this thread within the team. This value is
386 guaranteed to be between 0 and N-1, where N is the number of
387 threads in the team. */
388 unsigned team_id;
390 /* Nesting level. */
391 unsigned level;
393 /* Active nesting level. Only active parallel regions are counted. */
394 unsigned active_level;
396 /* Place-partition-var, offset and length into gomp_places_list array. */
397 unsigned place_partition_off;
398 unsigned place_partition_len;
400 /* Def-allocator-var ICV. */
401 uintptr_t def_allocator;
403 #ifdef HAVE_SYNC_BUILTINS
404 /* Number of single stmts encountered. */
405 unsigned long single_count;
406 #endif
408 /* For GFS_RUNTIME loops that resolved to GFS_STATIC, this is the
409 trip number through the loop. So first time a particular loop
410 is encountered this number is 0, the second time through the loop
411 is 1, etc. This is unused when the compiler knows in advance that
412 the loop is statically scheduled. */
413 unsigned long static_trip;
416 struct target_mem_desc;
418 /* These are the OpenMP 4.0 Internal Control Variables described in
419 section 2.3.1. Those described as having one copy per task are
420 stored within the structure; those described as having one copy
421 for the whole program are (naturally) global variables. */
423 struct gomp_task_icv
425 unsigned long nthreads_var;
426 enum gomp_schedule_type run_sched_var;
427 int run_sched_chunk_size;
428 int default_device_var;
429 unsigned int thread_limit_var;
430 bool dyn_var;
431 unsigned char max_active_levels_var;
432 char bind_var;
433 /* Internal ICV. */
434 struct target_mem_desc *target_data;
437 enum gomp_target_offload_t
439 GOMP_TARGET_OFFLOAD_DEFAULT,
440 GOMP_TARGET_OFFLOAD_MANDATORY,
441 GOMP_TARGET_OFFLOAD_DISABLED
444 #define gomp_supported_active_levels UCHAR_MAX
446 extern struct gomp_task_icv gomp_global_icv;
447 #ifndef HAVE_SYNC_BUILTINS
448 extern gomp_mutex_t gomp_managed_threads_lock;
449 #endif
450 extern bool gomp_cancel_var;
451 extern enum gomp_target_offload_t gomp_target_offload_var;
452 extern int gomp_max_task_priority_var;
453 extern unsigned long long gomp_spin_count_var, gomp_throttled_spin_count_var;
454 extern unsigned long gomp_available_cpus, gomp_managed_threads;
455 extern unsigned long *gomp_nthreads_var_list, gomp_nthreads_var_list_len;
456 extern char *gomp_bind_var_list;
457 extern unsigned long gomp_bind_var_list_len;
458 extern void **gomp_places_list;
459 extern unsigned long gomp_places_list_len;
460 extern unsigned int gomp_num_teams_var;
461 extern int gomp_nteams_var;
462 extern int gomp_teams_thread_limit_var;
463 extern int gomp_debug_var;
464 extern bool gomp_display_affinity_var;
465 extern char *gomp_affinity_format_var;
466 extern size_t gomp_affinity_format_len;
467 extern uintptr_t gomp_def_allocator;
468 extern int goacc_device_num;
469 extern char *goacc_device_type;
470 extern int goacc_default_dims[GOMP_DIM_MAX];
472 enum gomp_task_kind
474 /* Implicit task. */
475 GOMP_TASK_IMPLICIT,
476 /* Undeferred task. */
477 GOMP_TASK_UNDEFERRED,
478 /* Task created by GOMP_task and waiting to be run. */
479 GOMP_TASK_WAITING,
480 /* Task currently executing or scheduled and about to execute. */
481 GOMP_TASK_TIED,
482 /* Used for target tasks that have vars mapped and async run started,
483 but not yet completed. Once that completes, they will be readded
484 into the queues as GOMP_TASK_WAITING in order to perform the var
485 unmapping. */
486 GOMP_TASK_ASYNC_RUNNING,
487 /* Task that has finished executing but is waiting for its
488 completion event to be fulfilled. */
489 GOMP_TASK_DETACHED
492 struct gomp_task_depend_entry
494 /* Address of dependency. */
495 void *addr;
496 struct gomp_task_depend_entry *next;
497 struct gomp_task_depend_entry *prev;
498 /* Task that provides the dependency in ADDR. */
499 struct gomp_task *task;
500 /* Depend entry is of type "IN". */
501 bool is_in;
502 bool redundant;
503 bool redundant_out;
506 struct gomp_dependers_vec
508 size_t n_elem;
509 size_t allocated;
510 struct gomp_task *elem[];
513 /* Used when in GOMP_taskwait or in gomp_task_maybe_wait_for_dependencies. */
515 struct gomp_taskwait
517 bool in_taskwait;
518 bool in_depend_wait;
519 /* Number of tasks we are waiting for. */
520 size_t n_depend;
521 gomp_sem_t taskwait_sem;
524 /* This structure describes a "task" to be run by a thread. */
526 struct gomp_task
528 /* Parent of this task. */
529 struct gomp_task *parent;
530 /* Children of this task. */
531 struct priority_queue children_queue;
532 /* Taskgroup this task belongs in. */
533 struct gomp_taskgroup *taskgroup;
534 /* Tasks that depend on this task. */
535 struct gomp_dependers_vec *dependers;
536 struct htab *depend_hash;
537 struct gomp_taskwait *taskwait;
538 /* Number of items in DEPEND. */
539 size_t depend_count;
540 /* Number of tasks this task depends on. Once this counter reaches
541 0, we have no unsatisfied dependencies, and this task can be put
542 into the various queues to be scheduled. */
543 size_t num_dependees;
545 union {
546 /* Valid only if deferred_p is false. */
547 gomp_sem_t *completion_sem;
548 /* Valid only if deferred_p is true. Set to the team that executes the
549 task if the task is detached and the completion event has yet to be
550 fulfilled. */
551 struct gomp_team *detach_team;
553 bool deferred_p;
555 /* Priority of this task. */
556 int priority;
557 /* The priority node for this task in each of the different queues.
558 We put this here to avoid allocating space for each priority
559 node. Then we play offsetof() games to convert between pnode[]
560 entries and the gomp_task in which they reside. */
561 struct priority_node pnode[3];
563 struct gomp_task_icv icv;
564 void (*fn) (void *);
565 void *fn_data;
566 enum gomp_task_kind kind;
567 bool in_tied_task;
568 bool final_task;
569 bool copy_ctors_done;
570 /* Set for undeferred tasks with unsatisfied dependencies which
571 block further execution of their parent until the dependencies
572 are satisfied. */
573 bool parent_depends_on;
574 /* Dependencies provided and/or needed for this task. DEPEND_COUNT
575 is the number of items available. */
576 struct gomp_task_depend_entry depend[];
579 /* This structure describes a single #pragma omp taskgroup. */
581 struct gomp_taskgroup
583 struct gomp_taskgroup *prev;
584 /* Queue of tasks that belong in this taskgroup. */
585 struct priority_queue taskgroup_queue;
586 uintptr_t *reductions;
587 bool in_taskgroup_wait;
588 bool cancelled;
589 bool workshare;
590 gomp_sem_t taskgroup_sem;
591 size_t num_children;
594 /* Various state of OpenMP async offloading tasks. */
595 enum gomp_target_task_state
597 GOMP_TARGET_TASK_DATA,
598 GOMP_TARGET_TASK_BEFORE_MAP,
599 GOMP_TARGET_TASK_FALLBACK,
600 GOMP_TARGET_TASK_READY_TO_RUN,
601 GOMP_TARGET_TASK_RUNNING,
602 GOMP_TARGET_TASK_FINISHED
605 /* This structure describes a target task. */
607 struct gomp_target_task
609 struct gomp_device_descr *devicep;
610 void (*fn) (void *);
611 size_t mapnum;
612 size_t *sizes;
613 unsigned short *kinds;
614 unsigned int flags;
615 enum gomp_target_task_state state;
616 struct target_mem_desc *tgt;
617 struct gomp_task *task;
618 struct gomp_team *team;
619 /* Device-specific target arguments. */
620 void **args;
621 void *hostaddrs[];
624 /* This structure describes a "team" of threads. These are the threads
625 that are spawned by a PARALLEL constructs, as well as the work sharing
626 constructs that the team encounters. */
628 struct gomp_team
630 /* This is the number of threads in the current team. */
631 unsigned nthreads;
633 /* This is number of gomp_work_share structs that have been allocated
634 as a block last time. */
635 unsigned work_share_chunk;
637 /* This is the saved team state that applied to a master thread before
638 the current thread was created. */
639 struct gomp_team_state prev_ts;
641 /* This semaphore should be used by the master thread instead of its
642 "native" semaphore in the thread structure. Required for nested
643 parallels, as the master is a member of two teams. */
644 gomp_sem_t master_release;
646 /* This points to an array with pointers to the release semaphore
647 of the threads in the team. */
648 gomp_sem_t **ordered_release;
650 /* List of work shares on which gomp_fini_work_share hasn't been
651 called yet. If the team hasn't been cancelled, this should be
652 equal to each thr->ts.work_share, but otherwise it can be a possibly
653 long list of workshares. */
654 struct gomp_work_share *work_shares_to_free;
656 /* List of gomp_work_share structs chained through next_free fields.
657 This is populated and taken off only by the first thread in the
658 team encountering a new work sharing construct, in a critical
659 section. */
660 struct gomp_work_share *work_share_list_alloc;
662 /* List of gomp_work_share structs freed by free_work_share. New
663 entries are atomically added to the start of the list, and
664 alloc_work_share can safely only move all but the first entry
665 to work_share_list alloc, as free_work_share can happen concurrently
666 with alloc_work_share. */
667 struct gomp_work_share *work_share_list_free;
669 #ifdef HAVE_SYNC_BUILTINS
670 /* Number of simple single regions encountered by threads in this
671 team. */
672 unsigned long single_count;
673 #else
674 /* Mutex protecting addition of workshares to work_share_list_free. */
675 gomp_mutex_t work_share_list_free_lock;
676 #endif
678 /* This barrier is used for most synchronization of the team. */
679 gomp_barrier_t barrier;
681 /* Initial work shares, to avoid allocating any gomp_work_share
682 structs in the common case. */
683 struct gomp_work_share work_shares[8];
685 gomp_mutex_t task_lock;
686 /* Scheduled tasks. */
687 struct priority_queue task_queue;
688 /* Number of all GOMP_TASK_{WAITING,TIED} tasks in the team. */
689 unsigned int task_count;
690 /* Number of GOMP_TASK_WAITING tasks currently waiting to be scheduled. */
691 unsigned int task_queued_count;
692 /* Number of GOMP_TASK_{WAITING,TIED} tasks currently running
693 directly in gomp_barrier_handle_tasks; tasks spawned
694 from e.g. GOMP_taskwait or GOMP_taskgroup_end don't count, even when
695 that is called from a task run from gomp_barrier_handle_tasks.
696 task_running_count should be always <= team->nthreads,
697 and if current task isn't in_tied_task, then it will be
698 even < team->nthreads. */
699 unsigned int task_running_count;
700 int work_share_cancelled;
701 int team_cancelled;
703 /* Number of tasks waiting for their completion event to be fulfilled. */
704 unsigned int task_detach_count;
706 /* This array contains structures for implicit tasks. */
707 struct gomp_task implicit_task[];
710 /* This structure contains all data that is private to libgomp and is
711 allocated per thread. */
713 struct gomp_thread
715 /* This is the function that the thread should run upon launch. */
716 void (*fn) (void *data);
717 void *data;
719 /* This is the current team state for this thread. The ts.team member
720 is NULL only if the thread is idle. */
721 struct gomp_team_state ts;
723 /* This is the task that the thread is currently executing. */
724 struct gomp_task *task;
726 /* This semaphore is used for ordered loops. */
727 gomp_sem_t release;
729 /* Place this thread is bound to plus one, or zero if not bound
730 to any place. */
731 unsigned int place;
733 /* User pthread thread pool */
734 struct gomp_thread_pool *thread_pool;
736 #if defined(LIBGOMP_USE_PTHREADS) \
737 && (!defined(HAVE_TLS) \
738 || !defined(__GLIBC__) \
739 || !defined(USING_INITIAL_EXEC_TLS))
740 /* pthread_t of the thread containing this gomp_thread.
741 On Linux when using initial-exec TLS,
742 (typeof (pthread_t)) gomp_thread () - pthread_self ()
743 is constant in all threads, so we can optimize and not
744 store it. */
745 #define GOMP_NEEDS_THREAD_HANDLE 1
746 pthread_t handle;
747 #endif
751 struct gomp_thread_pool
753 /* This array manages threads spawned from the top level, which will
754 return to the idle loop once the current PARALLEL construct ends. */
755 struct gomp_thread **threads;
756 unsigned threads_size;
757 unsigned threads_used;
758 /* The last team is used for non-nested teams to delay their destruction to
759 make sure all the threads in the team move on to the pool's barrier before
760 the team's barrier is destroyed. */
761 struct gomp_team *last_team;
762 /* Number of threads running in this contention group. */
763 unsigned long threads_busy;
765 /* This barrier holds and releases threads waiting in thread pools. */
766 gomp_simple_barrier_t threads_dock;
769 enum gomp_cancel_kind
771 GOMP_CANCEL_PARALLEL = 1,
772 GOMP_CANCEL_LOOP = 2,
773 GOMP_CANCEL_FOR = GOMP_CANCEL_LOOP,
774 GOMP_CANCEL_DO = GOMP_CANCEL_LOOP,
775 GOMP_CANCEL_SECTIONS = 4,
776 GOMP_CANCEL_TASKGROUP = 8
779 /* ... and here is that TLS data. */
781 #if defined __nvptx__
782 extern struct gomp_thread *nvptx_thrs __attribute__((shared));
783 static inline struct gomp_thread *gomp_thread (void)
785 int tid;
786 asm ("mov.u32 %0, %%tid.y;" : "=r" (tid));
787 return nvptx_thrs + tid;
789 #elif defined __AMDGCN__
790 static inline struct gomp_thread *gcn_thrs (void)
792 /* The value is at the bottom of LDS. */
793 struct gomp_thread * __lds *thrs = (struct gomp_thread * __lds *)4;
794 return *thrs;
796 static inline void set_gcn_thrs (struct gomp_thread *val)
798 /* The value is at the bottom of LDS. */
799 struct gomp_thread * __lds *thrs = (struct gomp_thread * __lds *)4;
800 *thrs = val;
802 static inline struct gomp_thread *gomp_thread (void)
804 int tid = __builtin_gcn_dim_pos(1);
805 return gcn_thrs () + tid;
807 #elif defined HAVE_TLS || defined USE_EMUTLS
808 extern __thread struct gomp_thread gomp_tls_data;
809 static inline struct gomp_thread *gomp_thread (void)
811 return &gomp_tls_data;
813 #else
814 extern pthread_key_t gomp_tls_key;
815 static inline struct gomp_thread *gomp_thread (void)
817 return pthread_getspecific (gomp_tls_key);
819 #endif
821 extern struct gomp_task_icv *gomp_new_icv (void);
823 /* Here's how to access the current copy of the ICVs. */
825 static inline struct gomp_task_icv *gomp_icv (bool write)
827 struct gomp_task *task = gomp_thread ()->task;
828 if (task)
829 return &task->icv;
830 else if (write)
831 return gomp_new_icv ();
832 else
833 return &gomp_global_icv;
836 #ifdef LIBGOMP_USE_PTHREADS
837 /* The attributes to be used during thread creation. */
838 extern pthread_attr_t gomp_thread_attr;
840 extern pthread_key_t gomp_thread_destructor;
841 #endif
843 /* Function prototypes. */
845 /* affinity.c */
847 extern void gomp_init_affinity (void);
848 #ifdef LIBGOMP_USE_PTHREADS
849 extern void gomp_init_thread_affinity (pthread_attr_t *, unsigned int);
850 #endif
851 extern void **gomp_affinity_alloc (unsigned long, bool);
852 extern void gomp_affinity_init_place (void *);
853 extern bool gomp_affinity_add_cpus (void *, unsigned long, unsigned long,
854 long, bool);
855 extern bool gomp_affinity_remove_cpu (void *, unsigned long);
856 extern bool gomp_affinity_copy_place (void *, void *, long);
857 extern bool gomp_affinity_same_place (void *, void *);
858 extern bool gomp_affinity_finalize_place_list (bool);
859 extern bool gomp_affinity_init_level (int, unsigned long, bool);
860 extern void gomp_affinity_print_place (void *);
861 extern void gomp_get_place_proc_ids_8 (int, int64_t *);
862 extern void gomp_display_affinity_place (char *, size_t, size_t *, int);
864 /* affinity-fmt.c */
866 extern bool gomp_print_string (const char *str, size_t len);
867 extern void gomp_set_affinity_format (const char *, size_t);
868 extern void gomp_display_string (char *, size_t, size_t *, const char *,
869 size_t);
870 #ifdef LIBGOMP_USE_PTHREADS
871 typedef pthread_t gomp_thread_handle;
872 #else
873 typedef struct {} gomp_thread_handle;
874 #endif
875 extern size_t gomp_display_affinity (char *, size_t, const char *,
876 gomp_thread_handle,
877 struct gomp_team_state *, unsigned int);
878 extern void gomp_display_affinity_thread (gomp_thread_handle,
879 struct gomp_team_state *,
880 unsigned int) __attribute__((cold));
882 /* iter.c */
884 extern int gomp_iter_static_next (long *, long *);
885 extern bool gomp_iter_dynamic_next_locked (long *, long *);
886 extern bool gomp_iter_guided_next_locked (long *, long *);
888 #ifdef HAVE_SYNC_BUILTINS
889 extern bool gomp_iter_dynamic_next (long *, long *);
890 extern bool gomp_iter_guided_next (long *, long *);
891 #endif
893 /* iter_ull.c */
895 extern int gomp_iter_ull_static_next (unsigned long long *,
896 unsigned long long *);
897 extern bool gomp_iter_ull_dynamic_next_locked (unsigned long long *,
898 unsigned long long *);
899 extern bool gomp_iter_ull_guided_next_locked (unsigned long long *,
900 unsigned long long *);
902 #if defined HAVE_SYNC_BUILTINS && defined __LP64__
903 extern bool gomp_iter_ull_dynamic_next (unsigned long long *,
904 unsigned long long *);
905 extern bool gomp_iter_ull_guided_next (unsigned long long *,
906 unsigned long long *);
907 #endif
909 /* ordered.c */
911 extern void gomp_ordered_first (void);
912 extern void gomp_ordered_last (void);
913 extern void gomp_ordered_next (void);
914 extern void gomp_ordered_static_init (void);
915 extern void gomp_ordered_static_next (void);
916 extern void gomp_ordered_sync (void);
917 extern void gomp_doacross_init (unsigned, long *, long, size_t);
918 extern void gomp_doacross_ull_init (unsigned, unsigned long long *,
919 unsigned long long, size_t);
921 /* parallel.c */
923 extern unsigned gomp_resolve_num_threads (unsigned, unsigned);
925 /* proc.c (in config/) */
927 extern void gomp_init_num_threads (void);
928 extern unsigned gomp_dynamic_max_threads (void);
930 /* task.c */
932 extern void gomp_init_task (struct gomp_task *, struct gomp_task *,
933 struct gomp_task_icv *);
934 extern void gomp_end_task (void);
935 extern void gomp_barrier_handle_tasks (gomp_barrier_state_t);
936 extern void gomp_task_maybe_wait_for_dependencies (void **);
937 extern bool gomp_create_target_task (struct gomp_device_descr *,
938 void (*) (void *), size_t, void **,
939 size_t *, unsigned short *, unsigned int,
940 void **, void **,
941 enum gomp_target_task_state);
942 extern struct gomp_taskgroup *gomp_parallel_reduction_register (uintptr_t *,
943 unsigned);
944 extern void gomp_workshare_taskgroup_start (void);
945 extern void gomp_workshare_task_reduction_register (uintptr_t *, uintptr_t *);
947 static void inline
948 gomp_finish_task (struct gomp_task *task)
950 if (__builtin_expect (task->depend_hash != NULL, 0))
951 free (task->depend_hash);
954 /* team.c */
956 extern struct gomp_team *gomp_new_team (unsigned);
957 extern void gomp_team_start (void (*) (void *), void *, unsigned,
958 unsigned, struct gomp_team *,
959 struct gomp_taskgroup *);
960 extern void gomp_team_end (void);
961 extern void gomp_free_thread (void *);
962 extern int gomp_pause_host (void);
964 /* target.c */
966 extern void gomp_init_targets_once (void);
967 extern int gomp_get_num_devices (void);
968 extern bool gomp_target_task_fn (void *);
970 /* Splay tree definitions. */
971 typedef struct splay_tree_node_s *splay_tree_node;
972 typedef struct splay_tree_s *splay_tree;
973 typedef struct splay_tree_key_s *splay_tree_key;
975 struct target_var_desc {
976 /* Splay key. */
977 splay_tree_key key;
978 /* True if data should be copied from device to host at the end. */
979 bool copy_from;
980 /* True if data always should be copied from device to host at the end. */
981 bool always_copy_from;
982 /* True if this is for OpenACC 'attach'. */
983 bool is_attach;
984 /* If GOMP_MAP_TO_PSET had a NULL pointer; used for Fortran descriptors,
985 which were initially unallocated. */
986 bool has_null_ptr_assoc;
987 /* Relative offset against key host_start. */
988 uintptr_t offset;
989 /* Actual length. */
990 uintptr_t length;
993 struct target_mem_desc {
994 /* Reference count. */
995 uintptr_t refcount;
996 /* All the splay nodes allocated together. */
997 splay_tree_node array;
998 /* Start of the target region. */
999 uintptr_t tgt_start;
1000 /* End of the targer region. */
1001 uintptr_t tgt_end;
1002 /* Handle to free. */
1003 void *to_free;
1004 /* Previous target_mem_desc. */
1005 struct target_mem_desc *prev;
1006 /* Number of items in following list. */
1007 size_t list_count;
1009 /* Corresponding target device descriptor. */
1010 struct gomp_device_descr *device_descr;
1012 /* List of target items to remove (or decrease refcount)
1013 at the end of region. */
1014 struct target_var_desc list[];
1017 /* Special value for refcount - mask to indicate existence of special
1018 values. Right now we allocate 3 bits. */
1019 #define REFCOUNT_SPECIAL (~(uintptr_t) 0x7)
1021 /* Special value for refcount - infinity. */
1022 #define REFCOUNT_INFINITY (REFCOUNT_SPECIAL | 0)
1023 /* Special value for refcount - tgt_offset contains target address of the
1024 artificial pointer to "omp declare target link" object. */
1025 #define REFCOUNT_LINK (REFCOUNT_SPECIAL | 1)
1027 /* Special value for refcount - structure element sibling list items.
1028 All such key refounts have REFCOUNT_STRUCTELEM bits set, with _FLAG_FIRST
1029 and _FLAG_LAST indicating first and last in the created sibling sequence. */
1030 #define REFCOUNT_STRUCTELEM (REFCOUNT_SPECIAL | 4)
1031 #define REFCOUNT_STRUCTELEM_P(V) \
1032 (((V) & REFCOUNT_STRUCTELEM) == REFCOUNT_STRUCTELEM)
1033 /* The first leading key with _FLAG_FIRST set houses the actual reference count
1034 in the structelem_refcount field. Other siblings point to this counter value
1035 through its structelem_refcount_ptr field. */
1036 #define REFCOUNT_STRUCTELEM_FLAG_FIRST (1)
1037 /* The last key in the sibling sequence has this set. This is required to
1038 indicate the sequence boundary, when we remove the structure sibling list
1039 from the map. */
1040 #define REFCOUNT_STRUCTELEM_FLAG_LAST (2)
1042 #define REFCOUNT_STRUCTELEM_FIRST_P(V) \
1043 (REFCOUNT_STRUCTELEM_P (V) && ((V) & REFCOUNT_STRUCTELEM_FLAG_FIRST))
1044 #define REFCOUNT_STRUCTELEM_LAST_P(V) \
1045 (REFCOUNT_STRUCTELEM_P (V) && ((V) & REFCOUNT_STRUCTELEM_FLAG_LAST))
1047 /* Special offset values. */
1048 #define OFFSET_INLINED (~(uintptr_t) 0)
1049 #define OFFSET_POINTER (~(uintptr_t) 1)
1050 #define OFFSET_STRUCT (~(uintptr_t) 2)
1052 /* Auxiliary structure for infrequently-used or API-specific data. */
1054 struct splay_tree_aux {
1055 /* Pointer to the original mapping of "omp declare target link" object. */
1056 splay_tree_key link_key;
1057 /* For a block with attached pointers, the attachment counters for each.
1058 Only used for OpenACC. */
1059 uintptr_t *attach_count;
1062 struct splay_tree_key_s {
1063 /* Address of the host object. */
1064 uintptr_t host_start;
1065 /* Address immediately after the host object. */
1066 uintptr_t host_end;
1067 /* Descriptor of the target memory. */
1068 struct target_mem_desc *tgt;
1069 /* Offset from tgt->tgt_start to the start of the target object. */
1070 uintptr_t tgt_offset;
1071 /* Reference count. */
1072 uintptr_t refcount;
1073 union {
1074 /* Dynamic reference count. */
1075 uintptr_t dynamic_refcount;
1077 /* Unified reference count for structure element siblings, this is used
1078 when REFCOUNT_STRUCTELEM_FIRST_P(k->refcount) == true, the first sibling
1079 in a structure element sibling list item sequence. */
1080 uintptr_t structelem_refcount;
1082 /* When REFCOUNT_STRUCTELEM_P (k->refcount) == true, this field points
1083 into the (above) structelem_refcount field of the _FIRST splay_tree_key,
1084 the first key in the created sequence. All structure element siblings
1085 share a single refcount in this manner. Since these two fields won't be
1086 used at the same time, they are stashed in a union. */
1087 uintptr_t *structelem_refcount_ptr;
1089 struct splay_tree_aux *aux;
1092 /* The comparison function. */
1094 static inline int
1095 splay_compare (splay_tree_key x, splay_tree_key y)
1097 if (x->host_start == x->host_end
1098 && y->host_start == y->host_end)
1099 return 0;
1100 if (x->host_end <= y->host_start)
1101 return -1;
1102 if (x->host_start >= y->host_end)
1103 return 1;
1104 return 0;
1107 #include "splay-tree.h"
1109 typedef struct acc_dispatch_t
1111 /* Execute. */
1112 __typeof (GOMP_OFFLOAD_openacc_exec) *exec_func;
1114 /* Create/destroy TLS data. */
1115 __typeof (GOMP_OFFLOAD_openacc_create_thread_data) *create_thread_data_func;
1116 __typeof (GOMP_OFFLOAD_openacc_destroy_thread_data)
1117 *destroy_thread_data_func;
1119 struct {
1120 /* Once created and put into the "active" list, asyncqueues are then never
1121 destructed and removed from the "active" list, other than if the TODO
1122 device is shut down. */
1123 gomp_mutex_t lock;
1124 int nasyncqueue;
1125 struct goacc_asyncqueue **asyncqueue;
1126 struct goacc_asyncqueue_list *active;
1128 __typeof (GOMP_OFFLOAD_openacc_async_construct) *construct_func;
1129 __typeof (GOMP_OFFLOAD_openacc_async_destruct) *destruct_func;
1130 __typeof (GOMP_OFFLOAD_openacc_async_test) *test_func;
1131 __typeof (GOMP_OFFLOAD_openacc_async_synchronize) *synchronize_func;
1132 __typeof (GOMP_OFFLOAD_openacc_async_serialize) *serialize_func;
1133 __typeof (GOMP_OFFLOAD_openacc_async_queue_callback) *queue_callback_func;
1135 __typeof (GOMP_OFFLOAD_openacc_async_exec) *exec_func;
1136 __typeof (GOMP_OFFLOAD_openacc_async_dev2host) *dev2host_func;
1137 __typeof (GOMP_OFFLOAD_openacc_async_host2dev) *host2dev_func;
1138 } async;
1140 __typeof (GOMP_OFFLOAD_openacc_get_property) *get_property_func;
1142 /* NVIDIA target specific routines. */
1143 struct {
1144 __typeof (GOMP_OFFLOAD_openacc_cuda_get_current_device)
1145 *get_current_device_func;
1146 __typeof (GOMP_OFFLOAD_openacc_cuda_get_current_context)
1147 *get_current_context_func;
1148 __typeof (GOMP_OFFLOAD_openacc_cuda_get_stream) *get_stream_func;
1149 __typeof (GOMP_OFFLOAD_openacc_cuda_set_stream) *set_stream_func;
1150 } cuda;
1151 } acc_dispatch_t;
1153 /* Various state of the accelerator device. */
1154 enum gomp_device_state
1156 GOMP_DEVICE_UNINITIALIZED,
1157 GOMP_DEVICE_INITIALIZED,
1158 GOMP_DEVICE_FINALIZED
1161 /* This structure describes accelerator device.
1162 It contains name of the corresponding libgomp plugin, function handlers for
1163 interaction with the device, ID-number of the device, and information about
1164 mapped memory. */
1165 struct gomp_device_descr
1167 /* Immutable data, which is only set during initialization, and which is not
1168 guarded by the lock. */
1170 /* The name of the device. */
1171 const char *name;
1173 /* Capabilities of device (supports OpenACC, OpenMP). */
1174 unsigned int capabilities;
1176 /* This is the ID number of device among devices of the same type. */
1177 int target_id;
1179 /* This is the TYPE of device. */
1180 enum offload_target_type type;
1182 /* Function handlers. */
1183 __typeof (GOMP_OFFLOAD_get_name) *get_name_func;
1184 __typeof (GOMP_OFFLOAD_get_caps) *get_caps_func;
1185 __typeof (GOMP_OFFLOAD_get_type) *get_type_func;
1186 __typeof (GOMP_OFFLOAD_get_num_devices) *get_num_devices_func;
1187 __typeof (GOMP_OFFLOAD_init_device) *init_device_func;
1188 __typeof (GOMP_OFFLOAD_fini_device) *fini_device_func;
1189 __typeof (GOMP_OFFLOAD_version) *version_func;
1190 __typeof (GOMP_OFFLOAD_load_image) *load_image_func;
1191 __typeof (GOMP_OFFLOAD_unload_image) *unload_image_func;
1192 __typeof (GOMP_OFFLOAD_alloc) *alloc_func;
1193 __typeof (GOMP_OFFLOAD_free) *free_func;
1194 __typeof (GOMP_OFFLOAD_dev2host) *dev2host_func;
1195 __typeof (GOMP_OFFLOAD_host2dev) *host2dev_func;
1196 __typeof (GOMP_OFFLOAD_dev2dev) *dev2dev_func;
1197 __typeof (GOMP_OFFLOAD_can_run) *can_run_func;
1198 __typeof (GOMP_OFFLOAD_run) *run_func;
1199 __typeof (GOMP_OFFLOAD_async_run) *async_run_func;
1201 /* Splay tree containing information about mapped memory regions. */
1202 struct splay_tree_s mem_map;
1204 /* Mutex for the mutable data. */
1205 gomp_mutex_t lock;
1207 /* Current state of the device. OpenACC allows to move from INITIALIZED state
1208 back to UNINITIALIZED state. OpenMP allows only to move from INITIALIZED
1209 to FINALIZED state (at program shutdown). */
1210 enum gomp_device_state state;
1212 /* OpenACC-specific data and functions. */
1213 /* This is mutable because of its mutable target_data member. */
1214 acc_dispatch_t openacc;
1217 /* Kind of the pragma, for which gomp_map_vars () is called. */
1218 enum gomp_map_vars_kind
1220 GOMP_MAP_VARS_OPENACC = 1,
1221 GOMP_MAP_VARS_TARGET = 2,
1222 GOMP_MAP_VARS_DATA = 4,
1223 GOMP_MAP_VARS_ENTER_DATA = 8
1226 extern void gomp_acc_declare_allocate (bool, size_t, void **, size_t *,
1227 unsigned short *);
1228 struct gomp_coalesce_buf;
1229 extern void gomp_copy_host2dev (struct gomp_device_descr *,
1230 struct goacc_asyncqueue *, void *, const void *,
1231 size_t, bool, struct gomp_coalesce_buf *);
1232 extern void gomp_copy_dev2host (struct gomp_device_descr *,
1233 struct goacc_asyncqueue *, void *, const void *,
1234 size_t);
1235 extern uintptr_t gomp_map_val (struct target_mem_desc *, void **, size_t);
1236 extern void gomp_attach_pointer (struct gomp_device_descr *,
1237 struct goacc_asyncqueue *, splay_tree,
1238 splay_tree_key, uintptr_t, size_t,
1239 struct gomp_coalesce_buf *);
1240 extern void gomp_detach_pointer (struct gomp_device_descr *,
1241 struct goacc_asyncqueue *, splay_tree_key,
1242 uintptr_t, bool, struct gomp_coalesce_buf *);
1243 extern struct target_mem_desc *goacc_map_vars (struct gomp_device_descr *,
1244 struct goacc_asyncqueue *,
1245 size_t, void **, void **,
1246 size_t *, void *, bool,
1247 enum gomp_map_vars_kind);
1248 extern void goacc_unmap_vars (struct target_mem_desc *, bool,
1249 struct goacc_asyncqueue *);
1250 extern void gomp_init_device (struct gomp_device_descr *);
1251 extern bool gomp_fini_device (struct gomp_device_descr *);
1252 extern void gomp_unload_device (struct gomp_device_descr *);
1253 extern bool gomp_remove_var (struct gomp_device_descr *, splay_tree_key);
1254 extern void gomp_remove_var_async (struct gomp_device_descr *, splay_tree_key,
1255 struct goacc_asyncqueue *);
1257 /* work.c */
1259 extern void gomp_init_work_share (struct gomp_work_share *, size_t, unsigned);
1260 extern void gomp_fini_work_share (struct gomp_work_share *);
1261 extern bool gomp_work_share_start (size_t);
1262 extern void gomp_work_share_end (void);
1263 extern bool gomp_work_share_end_cancel (void);
1264 extern void gomp_work_share_end_nowait (void);
1266 static inline void
1267 gomp_work_share_init_done (void)
1269 struct gomp_thread *thr = gomp_thread ();
1270 if (__builtin_expect (thr->ts.last_work_share != NULL, 1))
1271 gomp_ptrlock_set (&thr->ts.last_work_share->next_ws, thr->ts.work_share);
1274 #ifdef HAVE_ATTRIBUTE_VISIBILITY
1275 # pragma GCC visibility pop
1276 #endif
1278 /* Now that we're back to default visibility, include the globals. */
1279 #include "libgomp_g.h"
1281 /* Include omp.h by parts. */
1282 #include "omp-lock.h"
1283 #define _LIBGOMP_OMP_LOCK_DEFINED 1
1284 #include "omp.h.in"
1286 #if !defined (HAVE_ATTRIBUTE_VISIBILITY) \
1287 || !defined (HAVE_ATTRIBUTE_ALIAS) \
1288 || !defined (HAVE_AS_SYMVER_DIRECTIVE) \
1289 || !defined (PIC) \
1290 || !defined (HAVE_SYMVER_SYMBOL_RENAMING_RUNTIME_SUPPORT)
1291 # undef LIBGOMP_GNU_SYMBOL_VERSIONING
1292 #endif
1294 #ifdef LIBGOMP_GNU_SYMBOL_VERSIONING
1295 extern void gomp_init_lock_30 (omp_lock_t *) __GOMP_NOTHROW;
1296 extern void gomp_destroy_lock_30 (omp_lock_t *) __GOMP_NOTHROW;
1297 extern void gomp_set_lock_30 (omp_lock_t *) __GOMP_NOTHROW;
1298 extern void gomp_unset_lock_30 (omp_lock_t *) __GOMP_NOTHROW;
1299 extern int gomp_test_lock_30 (omp_lock_t *) __GOMP_NOTHROW;
1300 extern void gomp_init_nest_lock_30 (omp_nest_lock_t *) __GOMP_NOTHROW;
1301 extern void gomp_destroy_nest_lock_30 (omp_nest_lock_t *) __GOMP_NOTHROW;
1302 extern void gomp_set_nest_lock_30 (omp_nest_lock_t *) __GOMP_NOTHROW;
1303 extern void gomp_unset_nest_lock_30 (omp_nest_lock_t *) __GOMP_NOTHROW;
1304 extern int gomp_test_nest_lock_30 (omp_nest_lock_t *) __GOMP_NOTHROW;
1306 extern void gomp_init_lock_25 (omp_lock_25_t *) __GOMP_NOTHROW;
1307 extern void gomp_destroy_lock_25 (omp_lock_25_t *) __GOMP_NOTHROW;
1308 extern void gomp_set_lock_25 (omp_lock_25_t *) __GOMP_NOTHROW;
1309 extern void gomp_unset_lock_25 (omp_lock_25_t *) __GOMP_NOTHROW;
1310 extern int gomp_test_lock_25 (omp_lock_25_t *) __GOMP_NOTHROW;
1311 extern void gomp_init_nest_lock_25 (omp_nest_lock_25_t *) __GOMP_NOTHROW;
1312 extern void gomp_destroy_nest_lock_25 (omp_nest_lock_25_t *) __GOMP_NOTHROW;
1313 extern void gomp_set_nest_lock_25 (omp_nest_lock_25_t *) __GOMP_NOTHROW;
1314 extern void gomp_unset_nest_lock_25 (omp_nest_lock_25_t *) __GOMP_NOTHROW;
1315 extern int gomp_test_nest_lock_25 (omp_nest_lock_25_t *) __GOMP_NOTHROW;
1317 # define omp_lock_symver(fn) \
1318 __asm (".symver g" #fn "_30, " #fn "@@OMP_3.0"); \
1319 __asm (".symver g" #fn "_25, " #fn "@OMP_1.0");
1320 #else
1321 # define gomp_init_lock_30 omp_init_lock
1322 # define gomp_destroy_lock_30 omp_destroy_lock
1323 # define gomp_set_lock_30 omp_set_lock
1324 # define gomp_unset_lock_30 omp_unset_lock
1325 # define gomp_test_lock_30 omp_test_lock
1326 # define gomp_init_nest_lock_30 omp_init_nest_lock
1327 # define gomp_destroy_nest_lock_30 omp_destroy_nest_lock
1328 # define gomp_set_nest_lock_30 omp_set_nest_lock
1329 # define gomp_unset_nest_lock_30 omp_unset_nest_lock
1330 # define gomp_test_nest_lock_30 omp_test_nest_lock
1331 #endif
1333 #ifdef HAVE_ATTRIBUTE_VISIBILITY
1334 # define attribute_hidden __attribute__ ((visibility ("hidden")))
1335 #else
1336 # define attribute_hidden
1337 #endif
1339 #if __GNUC__ >= 9
1340 # define HAVE_ATTRIBUTE_COPY
1341 #endif
1343 #ifdef HAVE_ATTRIBUTE_COPY
1344 # define attribute_copy(arg) __attribute__ ((copy (arg)))
1345 #else
1346 # define attribute_copy(arg)
1347 #endif
1349 #ifdef HAVE_ATTRIBUTE_ALIAS
1350 # define strong_alias(fn, al) \
1351 extern __typeof (fn) al __attribute__ ((alias (#fn))) attribute_copy (fn);
1353 # define ialias_ulp ialias_str1(__USER_LABEL_PREFIX__)
1354 # define ialias_str1(x) ialias_str2(x)
1355 # define ialias_str2(x) #x
1356 # define ialias(fn) \
1357 extern __typeof (fn) gomp_ialias_##fn \
1358 __attribute__ ((alias (#fn))) attribute_hidden attribute_copy (fn);
1359 # define ialias_redirect(fn) \
1360 extern __typeof (fn) fn __asm__ (ialias_ulp "gomp_ialias_" #fn) attribute_hidden;
1361 # define ialias_call(fn) gomp_ialias_ ## fn
1362 #else
1363 # define ialias(fn)
1364 # define ialias_redirect(fn)
1365 # define ialias_call(fn) fn
1366 #endif
1368 /* Helper function for priority_node_to_task() and
1369 task_to_priority_node().
1371 Return the offset from a task to its priority_node entry. The
1372 priority_node entry is has a type of TYPE. */
1374 static inline size_t
1375 priority_queue_offset (enum priority_queue_type type)
1377 return offsetof (struct gomp_task, pnode[(int) type]);
1380 /* Return the task associated with a priority NODE of type TYPE. */
1382 static inline struct gomp_task *
1383 priority_node_to_task (enum priority_queue_type type,
1384 struct priority_node *node)
1386 return (struct gomp_task *) ((char *) node - priority_queue_offset (type));
1389 /* Return the priority node of type TYPE for a given TASK. */
1391 static inline struct priority_node *
1392 task_to_priority_node (enum priority_queue_type type,
1393 struct gomp_task *task)
1395 return (struct priority_node *) ((char *) task
1396 + priority_queue_offset (type));
1399 #ifdef LIBGOMP_USE_PTHREADS
1400 static inline gomp_thread_handle
1401 gomp_thread_self (void)
1403 return pthread_self ();
1406 static inline gomp_thread_handle
1407 gomp_thread_to_pthread_t (struct gomp_thread *thr)
1409 struct gomp_thread *this_thr = gomp_thread ();
1410 if (thr == this_thr)
1411 return pthread_self ();
1412 #ifdef GOMP_NEEDS_THREAD_HANDLE
1413 return thr->handle;
1414 #else
1415 /* On Linux with initial-exec TLS, the pthread_t of the thread containing
1416 thr can be computed from thr, this_thr and pthread_self (),
1417 as the distance between this_thr and pthread_self () is constant. */
1418 return pthread_self () + ((uintptr_t) thr - (uintptr_t) this_thr);
1419 #endif
1421 #else
1422 static inline gomp_thread_handle
1423 gomp_thread_self (void)
1425 return (gomp_thread_handle) {};
1428 static inline gomp_thread_handle
1429 gomp_thread_to_pthread_t (struct gomp_thread *thr)
1431 (void) thr;
1432 return gomp_thread_self ();
1434 #endif
1436 #endif /* LIBGOMP_H */