31 #include "ompt-specific.cpp"
37 #define ompt_get_callback_success 1
38 #define ompt_get_callback_failure 0
40 #define no_tool_present 0
42 #define OMPT_API_ROUTINE static
44 #ifndef OMPT_STR_MATCH
45 #define OMPT_STR_MATCH(haystack, needle) (!strcasecmp(haystack, needle))
52 #define OMPT_VERBOSE_INIT_PRINT(...) \
54 fprintf(verbose_file, __VA_ARGS__)
55 #define OMPT_VERBOSE_INIT_CONTINUED_PRINT(...) \
57 fprintf(verbose_file, __VA_ARGS__)
59 static FILE *verbose_file;
60 static int verbose_init;
67 const char *state_name;
68 ompt_state_t state_id;
74 } kmp_mutex_impl_info_t;
87 ompt_callbacks_active_t ompt_enabled;
89 ompt_state_info_t ompt_state_info[] = {
90 #define ompt_state_macro(state, code) {#state, state},
91 FOREACH_OMPT_STATE(ompt_state_macro)
92 #undef ompt_state_macro
95 kmp_mutex_impl_info_t kmp_mutex_impl_info[] = {
96 #define kmp_mutex_impl_macro(name, id) {#name, name},
97 FOREACH_KMP_MUTEX_IMPL(kmp_mutex_impl_macro)
98 #undef kmp_mutex_impl_macro
101 ompt_callbacks_internal_t ompt_callbacks;
103 static ompt_start_tool_result_t *ompt_start_tool_result = NULL;
106 static HMODULE ompt_tool_module = NULL;
107 #define OMPT_DLCLOSE(Lib) FreeLibrary(Lib)
109 static void *ompt_tool_module = NULL;
110 #define OMPT_DLCLOSE(Lib) dlclose(Lib)
117 static ompt_interface_fn_t ompt_fn_lookup(
const char *s);
119 OMPT_API_ROUTINE ompt_data_t *ompt_get_thread_data(
void);
125 typedef ompt_start_tool_result_t *(*ompt_start_tool_t)(
unsigned int,
139 static ompt_start_tool_result_t *ompt_tool_darwin(
unsigned int omp_version,
140 const char *runtime_version) {
141 ompt_start_tool_result_t *ret = NULL;
143 ompt_start_tool_t start_tool =
144 (ompt_start_tool_t)dlsym(RTLD_DEFAULT,
"ompt_start_tool");
146 ret = start_tool(omp_version, runtime_version);
151 #elif OMPT_HAVE_WEAK_ATTRIBUTE
157 _OMP_EXTERN OMPT_WEAK_ATTRIBUTE ompt_start_tool_result_t *
158 ompt_start_tool(
unsigned int omp_version,
const char *runtime_version) {
159 ompt_start_tool_result_t *ret = NULL;
164 ompt_start_tool_t next_tool =
165 (ompt_start_tool_t)dlsym(RTLD_NEXT,
"ompt_start_tool");
167 ret = next_tool(omp_version, runtime_version);
172 #elif OMPT_HAVE_PSAPI
180 #pragma comment(lib, "psapi.lib")
183 #define NUM_MODULES 128
185 static ompt_start_tool_result_t *
186 ompt_tool_windows(
unsigned int omp_version,
const char *runtime_version) {
188 DWORD needed, new_size;
190 HANDLE process = GetCurrentProcess();
191 modules = (HMODULE *)malloc(NUM_MODULES *
sizeof(HMODULE));
192 ompt_start_tool_t ompt_tool_p = NULL;
195 printf(
"ompt_tool_windows(): looking for ompt_start_tool\n");
197 if (!EnumProcessModules(process, modules, NUM_MODULES *
sizeof(HMODULE),
204 new_size = needed /
sizeof(HMODULE);
205 if (new_size > NUM_MODULES) {
207 printf(
"ompt_tool_windows(): resize buffer to %d bytes\n", needed);
209 modules = (HMODULE *)realloc(modules, needed);
211 if (!EnumProcessModules(process, modules, needed, &needed)) {
216 for (i = 0; i < new_size; ++i) {
217 (FARPROC &)ompt_tool_p = GetProcAddress(modules[i],
"ompt_start_tool");
220 TCHAR modName[MAX_PATH];
221 if (GetModuleFileName(modules[i], modName, MAX_PATH))
222 printf(
"ompt_tool_windows(): ompt_start_tool found in module %s\n",
226 return (*ompt_tool_p)(omp_version, runtime_version);
230 TCHAR modName[MAX_PATH];
231 if (GetModuleFileName(modules[i], modName, MAX_PATH))
232 printf(
"ompt_tool_windows(): ompt_start_tool not found in module %s\n",
241 #error Activation of OMPT is not supported on this platform.
244 static ompt_start_tool_result_t *
245 ompt_try_start_tool(
unsigned int omp_version,
const char *runtime_version) {
246 ompt_start_tool_result_t *ret = NULL;
247 ompt_start_tool_t start_tool = NULL;
250 const char *sep =
";";
252 const char *sep =
":";
255 OMPT_VERBOSE_INIT_PRINT(
"----- START LOGGING OF TOOL REGISTRATION -----\n");
256 OMPT_VERBOSE_INIT_PRINT(
"Search for OMP tool in current address space... ");
260 ret = ompt_tool_darwin(omp_version, runtime_version);
261 #elif OMPT_HAVE_WEAK_ATTRIBUTE
262 ret = ompt_start_tool(omp_version, runtime_version);
263 #elif OMPT_HAVE_PSAPI
264 ret = ompt_tool_windows(omp_version, runtime_version);
266 #error Activation of OMPT is not supported on this platform.
269 OMPT_VERBOSE_INIT_CONTINUED_PRINT(
"Success.\n");
270 OMPT_VERBOSE_INIT_PRINT(
271 "Tool was started and is using the OMPT interface.\n");
272 OMPT_VERBOSE_INIT_PRINT(
"----- END LOGGING OF TOOL REGISTRATION -----\n");
277 OMPT_VERBOSE_INIT_CONTINUED_PRINT(
"Failed.\n");
278 const char *tool_libs = getenv(
"OMP_TOOL_LIBRARIES");
280 OMPT_VERBOSE_INIT_PRINT(
"Searching tool libraries...\n");
281 OMPT_VERBOSE_INIT_PRINT(
"OMP_TOOL_LIBRARIES = %s\n", tool_libs);
282 char *libs = __kmp_str_format(
"%s", tool_libs);
284 char *fname = __kmp_str_token(libs, sep, &buf);
290 OMPT_VERBOSE_INIT_PRINT(
"Opening %s... ", fname);
291 void *h = dlopen(fname, RTLD_LAZY);
293 OMPT_VERBOSE_INIT_CONTINUED_PRINT(
"Failed: %s\n", dlerror());
295 OMPT_VERBOSE_INIT_CONTINUED_PRINT(
"Success. \n");
296 OMPT_VERBOSE_INIT_PRINT(
"Searching for ompt_start_tool in %s... ",
299 start_tool = (ompt_start_tool_t)dlsym(h,
"ompt_start_tool");
301 char *error = dlerror();
303 OMPT_VERBOSE_INIT_CONTINUED_PRINT(
"Failed: %s\n", error);
305 OMPT_VERBOSE_INIT_CONTINUED_PRINT(
"Failed: %s\n",
306 "ompt_start_tool = NULL");
310 OMPT_VERBOSE_INIT_PRINT(
"Opening %s... ", fname);
311 HMODULE h = LoadLibrary(fname);
313 OMPT_VERBOSE_INIT_CONTINUED_PRINT(
"Failed: Error %u\n", GetLastError());
315 OMPT_VERBOSE_INIT_CONTINUED_PRINT(
"Success. \n");
316 OMPT_VERBOSE_INIT_PRINT(
"Searching for ompt_start_tool in %s... ",
318 start_tool = (ompt_start_tool_t)GetProcAddress(h,
"ompt_start_tool");
320 OMPT_VERBOSE_INIT_CONTINUED_PRINT(
"Failed: Error %u\n",
324 #error Activation of OMPT is not supported on this platform.
327 ret = (*start_tool)(omp_version, runtime_version);
329 OMPT_VERBOSE_INIT_CONTINUED_PRINT(
"Success.\n");
330 OMPT_VERBOSE_INIT_PRINT(
331 "Tool was started and is using the OMPT interface.\n");
332 ompt_tool_module = h;
335 OMPT_VERBOSE_INIT_CONTINUED_PRINT(
336 "Found but not using the OMPT interface.\n");
337 OMPT_VERBOSE_INIT_PRINT(
"Continuing search...\n");
341 fname = __kmp_str_token(NULL, sep, &buf);
343 __kmp_str_free(&libs);
345 OMPT_VERBOSE_INIT_PRINT(
"No OMP_TOOL_LIBRARIES defined.\n");
350 OMPT_VERBOSE_INIT_PRINT(
"----- END LOGGING OF TOOL REGISTRATION -----\n");
356 const char *fname =
"libarcher.so";
357 OMPT_VERBOSE_INIT_PRINT(
358 "...searching tool libraries failed. Using archer tool.\n");
359 OMPT_VERBOSE_INIT_PRINT(
"Opening %s... ", fname);
360 void *h = dlopen(fname, RTLD_LAZY);
362 OMPT_VERBOSE_INIT_CONTINUED_PRINT(
"Success.\n");
363 OMPT_VERBOSE_INIT_PRINT(
"Searching for ompt_start_tool in %s... ", fname);
364 start_tool = (ompt_start_tool_t)dlsym(h,
"ompt_start_tool");
366 ret = (*start_tool)(omp_version, runtime_version);
368 OMPT_VERBOSE_INIT_CONTINUED_PRINT(
"Success.\n");
369 OMPT_VERBOSE_INIT_PRINT(
370 "Tool was started and is using the OMPT interface.\n");
371 OMPT_VERBOSE_INIT_PRINT(
372 "----- END LOGGING OF TOOL REGISTRATION -----\n");
375 OMPT_VERBOSE_INIT_CONTINUED_PRINT(
376 "Found but not using the OMPT interface.\n");
378 OMPT_VERBOSE_INIT_CONTINUED_PRINT(
"Failed: %s\n", dlerror());
383 OMPT_VERBOSE_INIT_PRINT(
"No OMP tool loaded.\n");
384 OMPT_VERBOSE_INIT_PRINT(
"----- END LOGGING OF TOOL REGISTRATION -----\n");
388 void ompt_pre_init() {
392 static int ompt_pre_initialized = 0;
394 if (ompt_pre_initialized)
397 ompt_pre_initialized = 1;
402 const char *ompt_env_var = getenv(
"OMP_TOOL");
403 tool_setting_e tool_setting = omp_tool_error;
405 if (!ompt_env_var || !strcmp(ompt_env_var,
""))
406 tool_setting = omp_tool_unset;
407 else if (OMPT_STR_MATCH(ompt_env_var,
"disabled"))
408 tool_setting = omp_tool_disabled;
409 else if (OMPT_STR_MATCH(ompt_env_var,
"enabled"))
410 tool_setting = omp_tool_enabled;
412 const char *ompt_env_verbose_init = getenv(
"OMP_TOOL_VERBOSE_INIT");
415 if (ompt_env_verbose_init && strcmp(ompt_env_verbose_init,
"") &&
416 !OMPT_STR_MATCH(ompt_env_verbose_init,
"disabled")) {
418 if (OMPT_STR_MATCH(ompt_env_verbose_init,
"STDERR"))
419 verbose_file = stderr;
420 else if (OMPT_STR_MATCH(ompt_env_verbose_init,
"STDOUT"))
421 verbose_file = stdout;
423 verbose_file = fopen(ompt_env_verbose_init,
"w");
428 printf(
"ompt_pre_init(): tool_setting = %d\n", tool_setting);
430 switch (tool_setting) {
431 case omp_tool_disabled:
432 OMPT_VERBOSE_INIT_PRINT(
"OMP tool disabled. \n");
436 case omp_tool_enabled:
441 ompt_start_tool_result =
442 ompt_try_start_tool(__kmp_openmp_version, ompt_get_runtime_version());
444 memset(&ompt_enabled, 0,
sizeof(ompt_enabled));
449 "Warning: OMP_TOOL has invalid value \"%s\".\n"
450 " legal values are (NULL,\"\",\"disabled\","
455 if (verbose_init && verbose_file != stderr && verbose_file != stdout)
456 fclose(verbose_file);
458 printf(
"ompt_pre_init(): ompt_enabled = %d\n", ompt_enabled);
462 extern "C" int omp_get_initial_device(
void);
464 void ompt_post_init() {
468 static int ompt_post_initialized = 0;
470 if (ompt_post_initialized)
473 ompt_post_initialized = 1;
478 if (ompt_start_tool_result) {
479 ompt_enabled.enabled = !!ompt_start_tool_result->initialize(
480 ompt_fn_lookup, omp_get_initial_device(),
481 &(ompt_start_tool_result->tool_data));
483 if (!ompt_enabled.enabled) {
485 memset(&ompt_enabled, 0,
sizeof(ompt_enabled));
489 kmp_info_t *root_thread = ompt_get_thread();
491 ompt_set_thread_state(root_thread, ompt_state_overhead);
493 if (ompt_enabled.ompt_callback_thread_begin) {
494 ompt_callbacks.ompt_callback(ompt_callback_thread_begin)(
495 ompt_thread_initial, __ompt_get_thread_data_internal());
497 ompt_data_t *task_data;
498 ompt_data_t *parallel_data;
499 __ompt_get_task_info_internal(0, NULL, &task_data, NULL, ¶llel_data,
501 if (ompt_enabled.ompt_callback_implicit_task) {
502 ompt_callbacks.ompt_callback(ompt_callback_implicit_task)(
503 ompt_scope_begin, parallel_data, task_data, 1, 1, ompt_task_initial);
506 ompt_set_thread_state(root_thread, ompt_state_work_serial);
511 if (ompt_enabled.enabled
513 && ompt_start_tool_result && ompt_start_tool_result->finalize
516 ompt_start_tool_result->finalize(&(ompt_start_tool_result->tool_data));
519 if (ompt_tool_module)
520 OMPT_DLCLOSE(ompt_tool_module);
521 memset(&ompt_enabled, 0,
sizeof(ompt_enabled));
532 OMPT_API_ROUTINE
int ompt_enumerate_states(
int current_state,
int *next_state,
533 const char **next_state_name) {
534 const static int len =
sizeof(ompt_state_info) /
sizeof(ompt_state_info_t);
537 for (i = 0; i < len - 1; i++) {
538 if (ompt_state_info[i].state_id == current_state) {
539 *next_state = ompt_state_info[i + 1].state_id;
540 *next_state_name = ompt_state_info[i + 1].state_name;
548 OMPT_API_ROUTINE
int ompt_enumerate_mutex_impls(
int current_impl,
550 const char **next_impl_name) {
551 const static int len =
552 sizeof(kmp_mutex_impl_info) /
sizeof(kmp_mutex_impl_info_t);
554 for (i = 0; i < len - 1; i++) {
555 if (kmp_mutex_impl_info[i].
id != current_impl)
557 *next_impl = kmp_mutex_impl_info[i + 1].id;
558 *next_impl_name = kmp_mutex_impl_info[i + 1].name;
568 OMPT_API_ROUTINE ompt_set_result_t ompt_set_callback(ompt_callbacks_t which,
569 ompt_callback_t callback) {
572 #define ompt_event_macro(event_name, callback_type, event_id) \
574 ompt_callbacks.ompt_callback(event_name) = (callback_type)callback; \
575 ompt_enabled.event_name = (callback != 0); \
577 return ompt_event_implementation_status(event_name); \
579 return ompt_set_always;
581 FOREACH_OMPT_EVENT(ompt_event_macro)
583 #undef ompt_event_macro
586 return ompt_set_error;
590 OMPT_API_ROUTINE
int ompt_get_callback(ompt_callbacks_t which,
591 ompt_callback_t *callback) {
592 if (!ompt_enabled.enabled)
593 return ompt_get_callback_failure;
597 #define ompt_event_macro(event_name, callback_type, event_id) \
599 ompt_callback_t mycb = \
600 (ompt_callback_t)ompt_callbacks.ompt_callback(event_name); \
601 if (ompt_enabled.event_name && mycb) { \
603 return ompt_get_callback_success; \
605 return ompt_get_callback_failure; \
608 FOREACH_OMPT_EVENT(ompt_event_macro)
610 #undef ompt_event_macro
613 return ompt_get_callback_failure;
621 OMPT_API_ROUTINE
int ompt_get_parallel_info(
int ancestor_level,
622 ompt_data_t **parallel_data,
624 if (!ompt_enabled.enabled)
626 return __ompt_get_parallel_info_internal(ancestor_level, parallel_data,
630 OMPT_API_ROUTINE
int ompt_get_state(ompt_wait_id_t *wait_id) {
631 if (!ompt_enabled.enabled)
632 return ompt_state_work_serial;
633 int thread_state = __ompt_get_state_internal(wait_id);
635 if (thread_state == ompt_state_undefined) {
636 thread_state = ompt_state_work_serial;
646 OMPT_API_ROUTINE ompt_data_t *ompt_get_thread_data(
void) {
647 if (!ompt_enabled.enabled)
649 return __ompt_get_thread_data_internal();
652 OMPT_API_ROUTINE
int ompt_get_task_info(
int ancestor_level,
int *type,
653 ompt_data_t **task_data,
654 ompt_frame_t **task_frame,
655 ompt_data_t **parallel_data,
657 if (!ompt_enabled.enabled)
659 return __ompt_get_task_info_internal(ancestor_level, type, task_data,
660 task_frame, parallel_data, thread_num);
663 OMPT_API_ROUTINE
int ompt_get_task_memory(
void **addr,
size_t *size,
665 return __ompt_get_task_memory_internal(addr, size, block);
672 OMPT_API_ROUTINE
int ompt_get_num_procs(
void) {
675 return __kmp_avail_proc;
682 OMPT_API_ROUTINE
int ompt_get_num_places(
void) {
684 #if !KMP_AFFINITY_SUPPORTED
687 if (!KMP_AFFINITY_CAPABLE())
689 return __kmp_affinity_num_masks;
693 OMPT_API_ROUTINE
int ompt_get_place_proc_ids(
int place_num,
int ids_size,
696 #if !KMP_AFFINITY_SUPPORTED
700 int tmp_ids[ids_size];
701 for (
int j = 0; j < ids_size; j++)
703 if (!KMP_AFFINITY_CAPABLE())
705 if (place_num < 0 || place_num >= (
int)__kmp_affinity_num_masks)
709 kmp_affin_mask_t *mask = KMP_CPU_INDEX(__kmp_affinity_masks, place_num);
711 KMP_CPU_SET_ITERATE(i, mask) {
712 if ((!KMP_CPU_ISSET(i, __kmp_affin_fullMask)) ||
713 (!KMP_CPU_ISSET(i, mask))) {
716 if (count < ids_size)
720 if (ids_size >= count) {
721 for (i = 0; i < count; i++) {
729 OMPT_API_ROUTINE
int ompt_get_place_num(
void) {
731 #if !KMP_AFFINITY_SUPPORTED
734 if (!ompt_enabled.enabled || __kmp_get_gtid() < 0)
739 if (!KMP_AFFINITY_CAPABLE())
741 gtid = __kmp_entry_gtid();
742 thread = __kmp_thread_from_gtid(gtid);
743 if (thread == NULL || thread->th.th_current_place < 0)
745 return thread->th.th_current_place;
749 OMPT_API_ROUTINE
int ompt_get_partition_place_nums(
int place_nums_size,
752 #if !KMP_AFFINITY_SUPPORTED
755 if (!ompt_enabled.enabled || __kmp_get_gtid() < 0)
758 int i, gtid, place_num, first_place, last_place, start, end;
760 if (!KMP_AFFINITY_CAPABLE())
762 gtid = __kmp_entry_gtid();
763 thread = __kmp_thread_from_gtid(gtid);
766 first_place = thread->th.th_first_place;
767 last_place = thread->th.th_last_place;
768 if (first_place < 0 || last_place < 0)
770 if (first_place <= last_place) {
777 if (end - start <= place_nums_size)
778 for (i = 0, place_num = start; place_num <= end; ++place_num, ++i) {
779 place_nums[i] = place_num;
781 return end - start + 1;
789 OMPT_API_ROUTINE
int ompt_get_proc_id(
void) {
790 if (!ompt_enabled.enabled || __kmp_get_gtid() < 0)
793 return sched_getcpu();
796 GetCurrentProcessorNumberEx(&pn);
797 return 64 * pn.Group + pn.Number;
820 int __kmp_control_tool(uint64_t command, uint64_t modifier,
void *arg) {
822 if (ompt_enabled.enabled) {
823 if (ompt_enabled.ompt_callback_control_tool) {
824 return ompt_callbacks.ompt_callback(ompt_callback_control_tool)(
825 command, modifier, arg, OMPT_LOAD_RETURN_ADDRESS(__kmp_entry_gtid()));
838 OMPT_API_ROUTINE uint64_t ompt_get_unique_id(
void) {
839 return __ompt_get_unique_id_internal();
842 OMPT_API_ROUTINE
void ompt_finalize_tool(
void) { __kmp_internal_end_atexit(); }
848 OMPT_API_ROUTINE
int ompt_get_target_info(uint64_t *device_num,
849 ompt_id_t *target_id,
850 ompt_id_t *host_op_id) {
854 OMPT_API_ROUTINE
int ompt_get_num_devices(
void) {
862 static ompt_interface_fn_t ompt_fn_lookup(
const char *s) {
864 #define ompt_interface_fn(fn) \
865 fn##_t fn##_f = fn; \
866 if (strcmp(s, #fn) == 0) \
867 return (ompt_interface_fn_t)fn##_f;
869 FOREACH_OMPT_INQUIRY_FN(ompt_interface_fn)