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 kmp_int32 __kmp_barrier_domain_count;
26 kmp_int32 __kmp_region_domain_count;
27 __itt_domain *__kmp_itt_barrier_domains[KMP_MAX_FRAME_DOMAINS];
28 __itt_domain *__kmp_itt_region_domains[KMP_MAX_FRAME_DOMAINS];
29 __itt_domain *__kmp_itt_imbalance_domains[KMP_MAX_FRAME_DOMAINS];
30 kmp_int32 __kmp_itt_region_team_size[KMP_MAX_FRAME_DOMAINS];
31 __itt_domain *metadata_domain = NULL;
32 __itt_string_handle *string_handle_imbl = NULL;
33 __itt_string_handle *string_handle_loop = NULL;
34 __itt_string_handle *string_handle_sngl = NULL;
35 
36 #include "kmp_i18n.h"
37 #include "kmp_str.h"
38 #include "kmp_version.h"
39 
40 KMP_BUILD_ASSERT(sizeof(kmp_itt_mark_t) == sizeof(__itt_mark_type));
41 
42 /* Previously used warnings:
43 
44  KMP_WARNING( IttAllNotifDisabled );
45  KMP_WARNING( IttObjNotifDisabled );
46  KMP_WARNING( IttMarkNotifDisabled );
47  KMP_WARNING( IttUnloadLibFailed, libittnotify );
48 */
49 
50 kmp_int32 __kmp_itt_prepare_delay = 0;
51 kmp_bootstrap_lock_t __kmp_itt_debug_lock =
52  KMP_BOOTSTRAP_LOCK_INITIALIZER(__kmp_itt_debug_lock);
53 
54 #endif // USE_ITT_NOTIFY
55 
56 void __kmp_itt_initialize() {
57 
58 // ITTNotify library is loaded and initialized at first call to any ittnotify
59 // function, so we do not need to explicitly load it any more. Just report OMP
60 // RTL version to ITTNotify.
61 
62 #if USE_ITT_NOTIFY
63  // Report OpenMP RTL version.
64  kmp_str_buf_t buf;
65  __itt_mark_type version;
66  __kmp_str_buf_init(&buf);
67  __kmp_str_buf_print(&buf, "OMP RTL Version %d.%d.%d", __kmp_version_major,
68  __kmp_version_minor, __kmp_version_build);
69  if (__itt_api_version_ptr != NULL) {
70  __kmp_str_buf_print(&buf, ":%s", __itt_api_version());
71  }
72  version = __itt_mark_create(buf.str);
73  __itt_mark(version, NULL);
74  __kmp_str_buf_free(&buf);
75 #endif
76 
77 } // __kmp_itt_initialize
78 
79 void __kmp_itt_destroy() {
80 #if USE_ITT_NOTIFY
81  __kmp_itt_fini_ittlib();
82 #endif
83 } // __kmp_itt_destroy
84 
85 extern "C" void __itt_error_handler(__itt_error_code err, va_list args) {
86 
87  switch (err) {
88  case __itt_error_no_module: {
89  char const *library = va_arg(args, char const *);
90 #if KMP_OS_WINDOWS
91  int sys_err = va_arg(args, int);
92  kmp_msg_t err_code = KMP_SYSERRCODE(sys_err);
93  __kmp_msg(kmp_ms_warning, KMP_MSG(IttLoadLibFailed, library), err_code,
94  __kmp_msg_null);
95  if (__kmp_generate_warnings == kmp_warnings_off) {
96  __kmp_str_free(&err_code.str);
97  }
98 #else
99  char const *sys_err = va_arg(args, char const *);
100  kmp_msg_t err_code = KMP_SYSERRMESG(sys_err);
101  __kmp_msg(kmp_ms_warning, KMP_MSG(IttLoadLibFailed, library), err_code,
102  __kmp_msg_null);
103  if (__kmp_generate_warnings == kmp_warnings_off) {
104  __kmp_str_free(&err_code.str);
105  }
106 #endif
107  } break;
108  case __itt_error_no_symbol: {
109  char const *library = va_arg(args, char const *);
110  char const *symbol = va_arg(args, char const *);
111  KMP_WARNING(IttLookupFailed, symbol, library);
112  } break;
113  case __itt_error_unknown_group: {
114  char const *var = va_arg(args, char const *);
115  char const *group = va_arg(args, char const *);
116  KMP_WARNING(IttUnknownGroup, var, group);
117  } break;
118  case __itt_error_env_too_long: {
119  char const *var = va_arg(args, char const *);
120  size_t act_len = va_arg(args, size_t);
121  size_t max_len = va_arg(args, size_t);
122  KMP_WARNING(IttEnvVarTooLong, var, (unsigned long)act_len,
123  (unsigned long)max_len);
124  } break;
125  case __itt_error_cant_read_env: {
126  char const *var = va_arg(args, char const *);
127  int sys_err = va_arg(args, int);
128  kmp_msg_t err_code = KMP_ERR(sys_err);
129  __kmp_msg(kmp_ms_warning, KMP_MSG(CantGetEnvVar, var), err_code,
130  __kmp_msg_null);
131  if (__kmp_generate_warnings == kmp_warnings_off) {
132  __kmp_str_free(&err_code.str);
133  }
134  } break;
135  case __itt_error_system: {
136  char const *func = va_arg(args, char const *);
137  int sys_err = va_arg(args, int);
138  kmp_msg_t err_code = KMP_SYSERRCODE(sys_err);
139  __kmp_msg(kmp_ms_warning, KMP_MSG(IttFunctionError, func), err_code,
140  __kmp_msg_null);
141  if (__kmp_generate_warnings == kmp_warnings_off) {
142  __kmp_str_free(&err_code.str);
143  }
144  } break;
145  default: { KMP_WARNING(IttUnknownError, err); }
146  }
147 } // __itt_error_handler
148 
149 #endif /* USE_ITT_BUILD */