xref: /freebsd/contrib/llvm-project/openmp/runtime/src/ompt-specific.h (revision 0b57cec536236d46e3dba9bd041533462f33dbb7)
1*0b57cec5SDimitry Andric /*
2*0b57cec5SDimitry Andric  * ompt-specific.h - header of OMPT internal functions implementation
3*0b57cec5SDimitry Andric  */
4*0b57cec5SDimitry Andric 
5*0b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
6*0b57cec5SDimitry Andric //
7*0b57cec5SDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
8*0b57cec5SDimitry Andric // See https://llvm.org/LICENSE.txt for license information.
9*0b57cec5SDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
10*0b57cec5SDimitry Andric //
11*0b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
12*0b57cec5SDimitry Andric 
13*0b57cec5SDimitry Andric #ifndef OMPT_SPECIFIC_H
14*0b57cec5SDimitry Andric #define OMPT_SPECIFIC_H
15*0b57cec5SDimitry Andric 
16*0b57cec5SDimitry Andric #include "kmp.h"
17*0b57cec5SDimitry Andric 
18*0b57cec5SDimitry Andric /*****************************************************************************
19*0b57cec5SDimitry Andric  * forward declarations
20*0b57cec5SDimitry Andric  ****************************************************************************/
21*0b57cec5SDimitry Andric 
22*0b57cec5SDimitry Andric void __ompt_team_assign_id(kmp_team_t *team, ompt_data_t ompt_pid);
23*0b57cec5SDimitry Andric void __ompt_thread_assign_wait_id(void *variable);
24*0b57cec5SDimitry Andric 
25*0b57cec5SDimitry Andric void __ompt_lw_taskteam_init(ompt_lw_taskteam_t *lwt, kmp_info_t *thr,
26*0b57cec5SDimitry Andric                              int gtid, ompt_data_t *ompt_pid, void *codeptr);
27*0b57cec5SDimitry Andric 
28*0b57cec5SDimitry Andric void __ompt_lw_taskteam_link(ompt_lw_taskteam_t *lwt, kmp_info_t *thr,
29*0b57cec5SDimitry Andric                              int on_heap);
30*0b57cec5SDimitry Andric 
31*0b57cec5SDimitry Andric void __ompt_lw_taskteam_unlink(kmp_info_t *thr);
32*0b57cec5SDimitry Andric 
33*0b57cec5SDimitry Andric ompt_team_info_t *__ompt_get_teaminfo(int depth, int *size);
34*0b57cec5SDimitry Andric 
35*0b57cec5SDimitry Andric ompt_task_info_t *__ompt_get_task_info_object(int depth);
36*0b57cec5SDimitry Andric 
37*0b57cec5SDimitry Andric int __ompt_get_parallel_info_internal(int ancestor_level,
38*0b57cec5SDimitry Andric                                       ompt_data_t **parallel_data,
39*0b57cec5SDimitry Andric                                       int *team_size);
40*0b57cec5SDimitry Andric 
41*0b57cec5SDimitry Andric int __ompt_get_task_info_internal(int ancestor_level, int *type,
42*0b57cec5SDimitry Andric                                   ompt_data_t **task_data,
43*0b57cec5SDimitry Andric                                   ompt_frame_t **task_frame,
44*0b57cec5SDimitry Andric                                   ompt_data_t **parallel_data, int *thread_num);
45*0b57cec5SDimitry Andric 
46*0b57cec5SDimitry Andric ompt_data_t *__ompt_get_thread_data_internal();
47*0b57cec5SDimitry Andric 
48*0b57cec5SDimitry Andric /*
49*0b57cec5SDimitry Andric  * Unused currently
50*0b57cec5SDimitry Andric static uint64_t __ompt_get_get_unique_id_internal();
51*0b57cec5SDimitry Andric */
52*0b57cec5SDimitry Andric 
53*0b57cec5SDimitry Andric ompt_sync_region_t __ompt_get_barrier_kind(enum barrier_type, kmp_info_t *);
54*0b57cec5SDimitry Andric 
55*0b57cec5SDimitry Andric /*****************************************************************************
56*0b57cec5SDimitry Andric  * macros
57*0b57cec5SDimitry Andric  ****************************************************************************/
58*0b57cec5SDimitry Andric 
59*0b57cec5SDimitry Andric #define OMPT_CUR_TASK_INFO(thr) (&(thr->th.th_current_task->ompt_task_info))
60*0b57cec5SDimitry Andric #define OMPT_CUR_TASK_DATA(thr)                                                \
61*0b57cec5SDimitry Andric   (&(thr->th.th_current_task->ompt_task_info.task_data))
62*0b57cec5SDimitry Andric #define OMPT_CUR_TEAM_INFO(thr) (&(thr->th.th_team->t.ompt_team_info))
63*0b57cec5SDimitry Andric #define OMPT_CUR_TEAM_DATA(thr)                                                \
64*0b57cec5SDimitry Andric   (&(thr->th.th_team->t.ompt_team_info.parallel_data))
65*0b57cec5SDimitry Andric 
66*0b57cec5SDimitry Andric #define OMPT_HAVE_WEAK_ATTRIBUTE KMP_HAVE_WEAK_ATTRIBUTE
67*0b57cec5SDimitry Andric #define OMPT_HAVE_PSAPI KMP_HAVE_PSAPI
68*0b57cec5SDimitry Andric #define OMPT_STR_MATCH(haystack, needle) __kmp_str_match(haystack, 0, needle)
69*0b57cec5SDimitry Andric 
70*0b57cec5SDimitry Andric inline void *__ompt_load_return_address(int gtid) {
71*0b57cec5SDimitry Andric   kmp_info_t *thr = __kmp_threads[gtid];
72*0b57cec5SDimitry Andric   void *return_address = thr->th.ompt_thread_info.return_address;
73*0b57cec5SDimitry Andric   thr->th.ompt_thread_info.return_address = NULL;
74*0b57cec5SDimitry Andric   return return_address;
75*0b57cec5SDimitry Andric }
76*0b57cec5SDimitry Andric 
77*0b57cec5SDimitry Andric #define OMPT_STORE_RETURN_ADDRESS(gtid)                                        \
78*0b57cec5SDimitry Andric   if (ompt_enabled.enabled && gtid >= 0 && __kmp_threads[gtid] &&              \
79*0b57cec5SDimitry Andric       !__kmp_threads[gtid]->th.ompt_thread_info.return_address)                \
80*0b57cec5SDimitry Andric   __kmp_threads[gtid]->th.ompt_thread_info.return_address =                    \
81*0b57cec5SDimitry Andric       __builtin_return_address(0)
82*0b57cec5SDimitry Andric #define OMPT_LOAD_RETURN_ADDRESS(gtid) __ompt_load_return_address(gtid)
83*0b57cec5SDimitry Andric 
84*0b57cec5SDimitry Andric //******************************************************************************
85*0b57cec5SDimitry Andric // inline functions
86*0b57cec5SDimitry Andric //******************************************************************************
87*0b57cec5SDimitry Andric 
88*0b57cec5SDimitry Andric inline kmp_info_t *ompt_get_thread_gtid(int gtid) {
89*0b57cec5SDimitry Andric   return (gtid >= 0) ? __kmp_thread_from_gtid(gtid) : NULL;
90*0b57cec5SDimitry Andric }
91*0b57cec5SDimitry Andric 
92*0b57cec5SDimitry Andric inline kmp_info_t *ompt_get_thread() {
93*0b57cec5SDimitry Andric   int gtid = __kmp_get_gtid();
94*0b57cec5SDimitry Andric   return ompt_get_thread_gtid(gtid);
95*0b57cec5SDimitry Andric }
96*0b57cec5SDimitry Andric 
97*0b57cec5SDimitry Andric inline void ompt_set_thread_state(kmp_info_t *thread, ompt_state_t state) {
98*0b57cec5SDimitry Andric   thread->th.ompt_thread_info.state = state;
99*0b57cec5SDimitry Andric }
100*0b57cec5SDimitry Andric 
101*0b57cec5SDimitry Andric inline const char *ompt_get_runtime_version() {
102*0b57cec5SDimitry Andric   return &__kmp_version_lib_ver[KMP_VERSION_MAGIC_LEN];
103*0b57cec5SDimitry Andric }
104*0b57cec5SDimitry Andric 
105*0b57cec5SDimitry Andric #endif
106