libgomp.h 48 KB

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