10b57cec5SDimitry Andric /* 20b57cec5SDimitry Andric * ompt-specific.h - header of OMPT internal functions implementation 30b57cec5SDimitry Andric */ 40b57cec5SDimitry Andric 50b57cec5SDimitry Andric //===----------------------------------------------------------------------===// 60b57cec5SDimitry Andric // 70b57cec5SDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 80b57cec5SDimitry Andric // See https://llvm.org/LICENSE.txt for license information. 90b57cec5SDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 100b57cec5SDimitry Andric // 110b57cec5SDimitry Andric //===----------------------------------------------------------------------===// 120b57cec5SDimitry Andric 130b57cec5SDimitry Andric #ifndef OMPT_SPECIFIC_H 140b57cec5SDimitry Andric #define OMPT_SPECIFIC_H 150b57cec5SDimitry Andric 160b57cec5SDimitry Andric #include "kmp.h" 170b57cec5SDimitry Andric 18480093f4SDimitry Andric #if OMPT_SUPPORT 190b57cec5SDimitry Andric /***************************************************************************** 200b57cec5SDimitry Andric * forward declarations 210b57cec5SDimitry Andric ****************************************************************************/ 220b57cec5SDimitry Andric 230b57cec5SDimitry Andric void __ompt_team_assign_id(kmp_team_t *team, ompt_data_t ompt_pid); 240b57cec5SDimitry Andric void __ompt_thread_assign_wait_id(void *variable); 250b57cec5SDimitry Andric 26fe6060f1SDimitry Andric void __ompt_lw_taskteam_init(ompt_lw_taskteam_t *lwt, kmp_info_t *thr, int gtid, 27fe6060f1SDimitry Andric ompt_data_t *ompt_pid, void *codeptr); 280b57cec5SDimitry Andric 290b57cec5SDimitry Andric void __ompt_lw_taskteam_link(ompt_lw_taskteam_t *lwt, kmp_info_t *thr, 30489b1cf2SDimitry Andric int on_heap, bool always = false); 310b57cec5SDimitry Andric 320b57cec5SDimitry Andric void __ompt_lw_taskteam_unlink(kmp_info_t *thr); 330b57cec5SDimitry Andric 340b57cec5SDimitry Andric ompt_team_info_t *__ompt_get_teaminfo(int depth, int *size); 350b57cec5SDimitry Andric 360b57cec5SDimitry Andric ompt_task_info_t *__ompt_get_task_info_object(int depth); 370b57cec5SDimitry Andric 380b57cec5SDimitry Andric int __ompt_get_parallel_info_internal(int ancestor_level, 390b57cec5SDimitry Andric ompt_data_t **parallel_data, 400b57cec5SDimitry Andric int *team_size); 410b57cec5SDimitry Andric 420b57cec5SDimitry Andric int __ompt_get_task_info_internal(int ancestor_level, int *type, 430b57cec5SDimitry Andric ompt_data_t **task_data, 440b57cec5SDimitry Andric ompt_frame_t **task_frame, 450b57cec5SDimitry Andric ompt_data_t **parallel_data, int *thread_num); 460b57cec5SDimitry Andric 470b57cec5SDimitry Andric ompt_data_t *__ompt_get_thread_data_internal(); 480b57cec5SDimitry Andric 490b57cec5SDimitry Andric /* 500b57cec5SDimitry Andric * Unused currently 510b57cec5SDimitry Andric static uint64_t __ompt_get_get_unique_id_internal(); 520b57cec5SDimitry Andric */ 530b57cec5SDimitry Andric 540b57cec5SDimitry Andric ompt_sync_region_t __ompt_get_barrier_kind(enum barrier_type, kmp_info_t *); 550b57cec5SDimitry Andric 560b57cec5SDimitry Andric /***************************************************************************** 570b57cec5SDimitry Andric * macros 580b57cec5SDimitry Andric ****************************************************************************/ 590b57cec5SDimitry Andric 600b57cec5SDimitry Andric #define OMPT_CUR_TASK_INFO(thr) (&(thr->th.th_current_task->ompt_task_info)) 610b57cec5SDimitry Andric #define OMPT_CUR_TASK_DATA(thr) \ 620b57cec5SDimitry Andric (&(thr->th.th_current_task->ompt_task_info.task_data)) 630b57cec5SDimitry Andric #define OMPT_CUR_TEAM_INFO(thr) (&(thr->th.th_team->t.ompt_team_info)) 640b57cec5SDimitry Andric #define OMPT_CUR_TEAM_DATA(thr) \ 650b57cec5SDimitry Andric (&(thr->th.th_team->t.ompt_team_info.parallel_data)) 660b57cec5SDimitry Andric 670b57cec5SDimitry Andric #define OMPT_HAVE_WEAK_ATTRIBUTE KMP_HAVE_WEAK_ATTRIBUTE 680b57cec5SDimitry Andric #define OMPT_HAVE_PSAPI KMP_HAVE_PSAPI 690b57cec5SDimitry Andric #define OMPT_STR_MATCH(haystack, needle) __kmp_str_match(haystack, 0, needle) 700b57cec5SDimitry Andric 710b57cec5SDimitry Andric inline void *__ompt_load_return_address(int gtid) { 720b57cec5SDimitry Andric kmp_info_t *thr = __kmp_threads[gtid]; 730b57cec5SDimitry Andric void *return_address = thr->th.ompt_thread_info.return_address; 740b57cec5SDimitry Andric thr->th.ompt_thread_info.return_address = NULL; 750b57cec5SDimitry Andric return return_address; 760b57cec5SDimitry Andric } 770b57cec5SDimitry Andric 78e8d8bef9SDimitry Andric /*#define OMPT_STORE_RETURN_ADDRESS(gtid) \ 790b57cec5SDimitry Andric if (ompt_enabled.enabled && gtid >= 0 && __kmp_threads[gtid] && \ 800b57cec5SDimitry Andric !__kmp_threads[gtid]->th.ompt_thread_info.return_address) \ 810b57cec5SDimitry Andric __kmp_threads[gtid]->th.ompt_thread_info.return_address = \ 82e8d8bef9SDimitry Andric __builtin_return_address(0)*/ 83e8d8bef9SDimitry Andric #define OMPT_STORE_RETURN_ADDRESS(gtid) \ 84e8d8bef9SDimitry Andric OmptReturnAddressGuard ReturnAddressGuard{gtid, __builtin_return_address(0)}; 850b57cec5SDimitry Andric #define OMPT_LOAD_RETURN_ADDRESS(gtid) __ompt_load_return_address(gtid) 86e8d8bef9SDimitry Andric #define OMPT_LOAD_OR_GET_RETURN_ADDRESS(gtid) \ 87e8d8bef9SDimitry Andric ((ompt_enabled.enabled && gtid >= 0 && __kmp_threads[gtid] && \ 88fe6060f1SDimitry Andric __kmp_threads[gtid]->th.ompt_thread_info.return_address) \ 89fe6060f1SDimitry Andric ? __ompt_load_return_address(gtid) \ 90fe6060f1SDimitry Andric : __builtin_return_address(0)) 910b57cec5SDimitry Andric 920b57cec5SDimitry Andric //****************************************************************************** 930b57cec5SDimitry Andric // inline functions 940b57cec5SDimitry Andric //****************************************************************************** 950b57cec5SDimitry Andric 960b57cec5SDimitry Andric inline kmp_info_t *ompt_get_thread_gtid(int gtid) { 970b57cec5SDimitry Andric return (gtid >= 0) ? __kmp_thread_from_gtid(gtid) : NULL; 980b57cec5SDimitry Andric } 990b57cec5SDimitry Andric 1000b57cec5SDimitry Andric inline kmp_info_t *ompt_get_thread() { 1010b57cec5SDimitry Andric int gtid = __kmp_get_gtid(); 1020b57cec5SDimitry Andric return ompt_get_thread_gtid(gtid); 1030b57cec5SDimitry Andric } 1040b57cec5SDimitry Andric 1050b57cec5SDimitry Andric inline void ompt_set_thread_state(kmp_info_t *thread, ompt_state_t state) { 106fe6060f1SDimitry Andric if (thread) 1070b57cec5SDimitry Andric thread->th.ompt_thread_info.state = state; 1080b57cec5SDimitry Andric } 1090b57cec5SDimitry Andric 1100b57cec5SDimitry Andric inline const char *ompt_get_runtime_version() { 1110b57cec5SDimitry Andric return &__kmp_version_lib_ver[KMP_VERSION_MAGIC_LEN]; 1120b57cec5SDimitry Andric } 113e8d8bef9SDimitry Andric 114e8d8bef9SDimitry Andric class OmptReturnAddressGuard { 115e8d8bef9SDimitry Andric private: 116e8d8bef9SDimitry Andric bool SetAddress{false}; 117e8d8bef9SDimitry Andric int Gtid; 118e8d8bef9SDimitry Andric 119e8d8bef9SDimitry Andric public: 120e8d8bef9SDimitry Andric OmptReturnAddressGuard(int Gtid, void *ReturnAddress) : Gtid(Gtid) { 121e8d8bef9SDimitry Andric if (ompt_enabled.enabled && Gtid >= 0 && __kmp_threads[Gtid] && 122e8d8bef9SDimitry Andric !__kmp_threads[Gtid]->th.ompt_thread_info.return_address) { 123e8d8bef9SDimitry Andric SetAddress = true; 124e8d8bef9SDimitry Andric __kmp_threads[Gtid]->th.ompt_thread_info.return_address = ReturnAddress; 125e8d8bef9SDimitry Andric } 126e8d8bef9SDimitry Andric } 127e8d8bef9SDimitry Andric ~OmptReturnAddressGuard() { 128e8d8bef9SDimitry Andric if (SetAddress) 129e8d8bef9SDimitry Andric __kmp_threads[Gtid]->th.ompt_thread_info.return_address = NULL; 130e8d8bef9SDimitry Andric } 131e8d8bef9SDimitry Andric }; 132e8d8bef9SDimitry Andric 1335ffd83dbSDimitry Andric #endif // OMPT_SUPPORT 134480093f4SDimitry Andric 135480093f4SDimitry Andric // macros providing the OMPT callbacks for reduction clause 136480093f4SDimitry Andric #if OMPT_SUPPORT && OMPT_OPTIONAL 137480093f4SDimitry Andric #define OMPT_REDUCTION_DECL(this_thr, gtid) \ 138480093f4SDimitry Andric ompt_data_t *my_task_data = OMPT_CUR_TASK_DATA(this_thr); \ 139480093f4SDimitry Andric ompt_data_t *my_parallel_data = OMPT_CUR_TEAM_DATA(this_thr); \ 140480093f4SDimitry Andric void *return_address = OMPT_LOAD_RETURN_ADDRESS(gtid); 141480093f4SDimitry Andric #define OMPT_REDUCTION_BEGIN \ 142480093f4SDimitry Andric if (ompt_enabled.enabled && ompt_enabled.ompt_callback_reduction) { \ 143480093f4SDimitry Andric ompt_callbacks.ompt_callback(ompt_callback_reduction)( \ 144480093f4SDimitry Andric ompt_sync_region_reduction, ompt_scope_begin, my_parallel_data, \ 145480093f4SDimitry Andric my_task_data, return_address); \ 146480093f4SDimitry Andric } 147480093f4SDimitry Andric #define OMPT_REDUCTION_END \ 148480093f4SDimitry Andric if (ompt_enabled.enabled && ompt_enabled.ompt_callback_reduction) { \ 149480093f4SDimitry Andric ompt_callbacks.ompt_callback(ompt_callback_reduction)( \ 150480093f4SDimitry Andric ompt_sync_region_reduction, ompt_scope_end, my_parallel_data, \ 151480093f4SDimitry Andric my_task_data, return_address); \ 152480093f4SDimitry Andric } 153480093f4SDimitry Andric #else // OMPT_SUPPORT && OMPT_OPTIONAL 154480093f4SDimitry Andric #define OMPT_REDUCTION_DECL(this_thr, gtid) 155480093f4SDimitry Andric #define OMPT_REDUCTION_BEGIN 156480093f4SDimitry Andric #define OMPT_REDUCTION_END 157480093f4SDimitry Andric #endif // ! OMPT_SUPPORT && OMPT_OPTIONAL 1580b57cec5SDimitry Andric 1590b57cec5SDimitry Andric #endif 160