xref: /freebsd/contrib/llvm-project/openmp/runtime/src/ompt-specific.h (revision 489b1cf2ecf5b9b4a394857987014bfb09067726)
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 
180b57cec5SDimitry Andric /*****************************************************************************
190b57cec5SDimitry Andric  * forward declarations
200b57cec5SDimitry Andric  ****************************************************************************/
210b57cec5SDimitry Andric 
220b57cec5SDimitry Andric void __ompt_team_assign_id(kmp_team_t *team, ompt_data_t ompt_pid);
230b57cec5SDimitry Andric void __ompt_thread_assign_wait_id(void *variable);
240b57cec5SDimitry Andric 
250b57cec5SDimitry Andric void __ompt_lw_taskteam_init(ompt_lw_taskteam_t *lwt, kmp_info_t *thr,
260b57cec5SDimitry Andric                              int gtid, ompt_data_t *ompt_pid, void *codeptr);
270b57cec5SDimitry Andric 
280b57cec5SDimitry Andric void __ompt_lw_taskteam_link(ompt_lw_taskteam_t *lwt, kmp_info_t *thr,
29*489b1cf2SDimitry Andric                              int on_heap, bool always = false);
300b57cec5SDimitry Andric 
310b57cec5SDimitry Andric void __ompt_lw_taskteam_unlink(kmp_info_t *thr);
320b57cec5SDimitry Andric 
330b57cec5SDimitry Andric ompt_team_info_t *__ompt_get_teaminfo(int depth, int *size);
340b57cec5SDimitry Andric 
350b57cec5SDimitry Andric ompt_task_info_t *__ompt_get_task_info_object(int depth);
360b57cec5SDimitry Andric 
370b57cec5SDimitry Andric int __ompt_get_parallel_info_internal(int ancestor_level,
380b57cec5SDimitry Andric                                       ompt_data_t **parallel_data,
390b57cec5SDimitry Andric                                       int *team_size);
400b57cec5SDimitry Andric 
410b57cec5SDimitry Andric int __ompt_get_task_info_internal(int ancestor_level, int *type,
420b57cec5SDimitry Andric                                   ompt_data_t **task_data,
430b57cec5SDimitry Andric                                   ompt_frame_t **task_frame,
440b57cec5SDimitry Andric                                   ompt_data_t **parallel_data, int *thread_num);
450b57cec5SDimitry Andric 
460b57cec5SDimitry Andric ompt_data_t *__ompt_get_thread_data_internal();
470b57cec5SDimitry Andric 
480b57cec5SDimitry Andric /*
490b57cec5SDimitry Andric  * Unused currently
500b57cec5SDimitry Andric static uint64_t __ompt_get_get_unique_id_internal();
510b57cec5SDimitry Andric */
520b57cec5SDimitry Andric 
530b57cec5SDimitry Andric ompt_sync_region_t __ompt_get_barrier_kind(enum barrier_type, kmp_info_t *);
540b57cec5SDimitry Andric 
550b57cec5SDimitry Andric /*****************************************************************************
560b57cec5SDimitry Andric  * macros
570b57cec5SDimitry Andric  ****************************************************************************/
580b57cec5SDimitry Andric 
590b57cec5SDimitry Andric #define OMPT_CUR_TASK_INFO(thr) (&(thr->th.th_current_task->ompt_task_info))
600b57cec5SDimitry Andric #define OMPT_CUR_TASK_DATA(thr)                                                \
610b57cec5SDimitry Andric   (&(thr->th.th_current_task->ompt_task_info.task_data))
620b57cec5SDimitry Andric #define OMPT_CUR_TEAM_INFO(thr) (&(thr->th.th_team->t.ompt_team_info))
630b57cec5SDimitry Andric #define OMPT_CUR_TEAM_DATA(thr)                                                \
640b57cec5SDimitry Andric   (&(thr->th.th_team->t.ompt_team_info.parallel_data))
650b57cec5SDimitry Andric 
660b57cec5SDimitry Andric #define OMPT_HAVE_WEAK_ATTRIBUTE KMP_HAVE_WEAK_ATTRIBUTE
670b57cec5SDimitry Andric #define OMPT_HAVE_PSAPI KMP_HAVE_PSAPI
680b57cec5SDimitry Andric #define OMPT_STR_MATCH(haystack, needle) __kmp_str_match(haystack, 0, needle)
690b57cec5SDimitry Andric 
700b57cec5SDimitry Andric inline void *__ompt_load_return_address(int gtid) {
710b57cec5SDimitry Andric   kmp_info_t *thr = __kmp_threads[gtid];
720b57cec5SDimitry Andric   void *return_address = thr->th.ompt_thread_info.return_address;
730b57cec5SDimitry Andric   thr->th.ompt_thread_info.return_address = NULL;
740b57cec5SDimitry Andric   return return_address;
750b57cec5SDimitry Andric }
760b57cec5SDimitry Andric 
770b57cec5SDimitry Andric #define OMPT_STORE_RETURN_ADDRESS(gtid)                                        \
780b57cec5SDimitry Andric   if (ompt_enabled.enabled && gtid >= 0 && __kmp_threads[gtid] &&              \
790b57cec5SDimitry Andric       !__kmp_threads[gtid]->th.ompt_thread_info.return_address)                \
800b57cec5SDimitry Andric   __kmp_threads[gtid]->th.ompt_thread_info.return_address =                    \
810b57cec5SDimitry Andric       __builtin_return_address(0)
820b57cec5SDimitry Andric #define OMPT_LOAD_RETURN_ADDRESS(gtid) __ompt_load_return_address(gtid)
830b57cec5SDimitry Andric 
840b57cec5SDimitry Andric //******************************************************************************
850b57cec5SDimitry Andric // inline functions
860b57cec5SDimitry Andric //******************************************************************************
870b57cec5SDimitry Andric 
880b57cec5SDimitry Andric inline kmp_info_t *ompt_get_thread_gtid(int gtid) {
890b57cec5SDimitry Andric   return (gtid >= 0) ? __kmp_thread_from_gtid(gtid) : NULL;
900b57cec5SDimitry Andric }
910b57cec5SDimitry Andric 
920b57cec5SDimitry Andric inline kmp_info_t *ompt_get_thread() {
930b57cec5SDimitry Andric   int gtid = __kmp_get_gtid();
940b57cec5SDimitry Andric   return ompt_get_thread_gtid(gtid);
950b57cec5SDimitry Andric }
960b57cec5SDimitry Andric 
970b57cec5SDimitry Andric inline void ompt_set_thread_state(kmp_info_t *thread, ompt_state_t state) {
980b57cec5SDimitry Andric   thread->th.ompt_thread_info.state = state;
990b57cec5SDimitry Andric }
1000b57cec5SDimitry Andric 
1010b57cec5SDimitry Andric inline const char *ompt_get_runtime_version() {
1020b57cec5SDimitry Andric   return &__kmp_version_lib_ver[KMP_VERSION_MAGIC_LEN];
1030b57cec5SDimitry Andric }
1040b57cec5SDimitry Andric 
1050b57cec5SDimitry Andric #endif
106