LLVM OpenMP* Runtime Library
kmp_itt.cpp
1 #include "kmp_config.h"
2 
3 #if USE_ITT_BUILD
4 /*
5  * kmp_itt.cpp -- ITT Notify interface.
6  */
7 
8 //===----------------------------------------------------------------------===//
9 //
10 // The LLVM Compiler Infrastructure
11 //
12 // This file is dual licensed under the MIT and the University of Illinois Open
13 // Source Licenses. See LICENSE.txt for details.
14 //
15 //===----------------------------------------------------------------------===//
16 
17 #include "kmp_itt.h"
18 
19 #if KMP_DEBUG
20 #include "kmp_itt.inl"
21 #endif
22 
23 #if USE_ITT_NOTIFY
24 
25 #include "ittnotify_config.h"
26 __itt_global __kmp_ittapi_clean_global;
27 extern __itt_global __kmp_itt__ittapi_global;
28 kmp_int32 __kmp_barrier_domain_count;
29 kmp_int32 __kmp_region_domain_count;
30 __itt_domain *__kmp_itt_barrier_domains[KMP_MAX_FRAME_DOMAINS];
31 __itt_domain *__kmp_itt_region_domains[KMP_MAX_FRAME_DOMAINS];
32 __itt_domain *__kmp_itt_imbalance_domains[KMP_MAX_FRAME_DOMAINS];
33 kmp_int32 __kmp_itt_region_team_size[KMP_MAX_FRAME_DOMAINS];
34 __itt_domain *metadata_domain = NULL;
35 __itt_string_handle *string_handle_imbl = NULL;
36 __itt_string_handle *string_handle_loop = NULL;
37 __itt_string_handle *string_handle_sngl = NULL;
38 
39 #include "kmp_i18n.h"
40 #include "kmp_str.h"
41 #include "kmp_version.h"
42 
43 KMP_BUILD_ASSERT(sizeof(kmp_itt_mark_t) == sizeof(__itt_mark_type));
44 
45 /* Previously used warnings:
46 
47  KMP_WARNING( IttAllNotifDisabled );
48  KMP_WARNING( IttObjNotifDisabled );
49  KMP_WARNING( IttMarkNotifDisabled );
50  KMP_WARNING( IttUnloadLibFailed, libittnotify );
51 */
52 
53 kmp_int32 __kmp_itt_prepare_delay = 0;
54 kmp_bootstrap_lock_t __kmp_itt_debug_lock =
55  KMP_BOOTSTRAP_LOCK_INITIALIZER(__kmp_itt_debug_lock);
56 
57 #endif // USE_ITT_NOTIFY
58 
59 void __kmp_itt_reset() {
60 #if USE_ITT_NOTIFY
61  __kmp_itt__ittapi_global = __kmp_ittapi_clean_global;
62 #endif
63 }
64 
65 void __kmp_itt_initialize() {
66 
67 // ITTNotify library is loaded and initialized at first call to any ittnotify
68 // function, so we do not need to explicitly load it any more. Just report OMP
69 // RTL version to ITTNotify.
70 
71 #if USE_ITT_NOTIFY
72  // Backup a clean global state
73  __kmp_ittapi_clean_global = __kmp_itt__ittapi_global;
74 
75  // Report OpenMP RTL version.
76  kmp_str_buf_t buf;
77  __itt_mark_type version;
78  __kmp_str_buf_init(&buf);
79  __kmp_str_buf_print(&buf, "OMP RTL Version %d.%d.%d", __kmp_version_major,
80  __kmp_version_minor, __kmp_version_build);
81  if (__itt_api_version_ptr != NULL) {
82  __kmp_str_buf_print(&buf, ":%s", __itt_api_version());
83  }
84  version = __itt_mark_create(buf.str);
85  __itt_mark(version, NULL);
86  __kmp_str_buf_free(&buf);
87 #endif
88 
89 } // __kmp_itt_initialize
90 
91 void __kmp_itt_destroy() {
92 #if USE_ITT_NOTIFY
93  __kmp_itt_fini_ittlib();
94 #endif
95 } // __kmp_itt_destroy
96 
97 extern "C" void __itt_error_handler(__itt_error_code err, va_list args) {
98 
99  switch (err) {
100  case __itt_error_no_module: {
101  char const *library = va_arg(args, char const *);
102 #if KMP_OS_WINDOWS
103  int sys_err = va_arg(args, int);
104  kmp_msg_t err_code = KMP_SYSERRCODE(sys_err);
105  __kmp_msg(kmp_ms_warning, KMP_MSG(IttLoadLibFailed, library), err_code,
106  __kmp_msg_null);
107  if (__kmp_generate_warnings == kmp_warnings_off) {
108  __kmp_str_free(&err_code.str);
109  }
110 #else
111  char const *sys_err = va_arg(args, char const *);
112  kmp_msg_t err_code = KMP_SYSERRMESG(sys_err);
113  __kmp_msg(kmp_ms_warning, KMP_MSG(IttLoadLibFailed, library), err_code,
114  __kmp_msg_null);
115  if (__kmp_generate_warnings == kmp_warnings_off) {
116  __kmp_str_free(&err_code.str);
117  }
118 #endif
119  } break;
120  case __itt_error_no_symbol: {
121  char const *library = va_arg(args, char const *);
122  char const *symbol = va_arg(args, char const *);
123  KMP_WARNING(IttLookupFailed, symbol, library);
124  } break;
125  case __itt_error_unknown_group: {
126  char const *var = va_arg(args, char const *);
127  char const *group = va_arg(args, char const *);
128  KMP_WARNING(IttUnknownGroup, var, group);
129  } break;
130  case __itt_error_env_too_long: {
131  char const *var = va_arg(args, char const *);
132  size_t act_len = va_arg(args, size_t);
133  size_t max_len = va_arg(args, size_t);
134  KMP_WARNING(IttEnvVarTooLong, var, (unsigned long)act_len,
135  (unsigned long)max_len);
136  } break;
137  case __itt_error_cant_read_env: {
138  char const *var = va_arg(args, char const *);
139  int sys_err = va_arg(args, int);
140  kmp_msg_t err_code = KMP_ERR(sys_err);
141  __kmp_msg(kmp_ms_warning, KMP_MSG(CantGetEnvVar, var), err_code,
142  __kmp_msg_null);
143  if (__kmp_generate_warnings == kmp_warnings_off) {
144  __kmp_str_free(&err_code.str);
145  }
146  } break;
147  case __itt_error_system: {
148  char const *func = va_arg(args, char const *);
149  int sys_err = va_arg(args, int);
150  kmp_msg_t err_code = KMP_SYSERRCODE(sys_err);
151  __kmp_msg(kmp_ms_warning, KMP_MSG(IttFunctionError, func), err_code,
152  __kmp_msg_null);
153  if (__kmp_generate_warnings == kmp_warnings_off) {
154  __kmp_str_free(&err_code.str);
155  }
156  } break;
157  default: { KMP_WARNING(IttUnknownError, err); }
158  }
159 } // __itt_error_handler
160 
161 #endif /* USE_ITT_BUILD */