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... ",
298 start_tool = (ompt_start_tool_t)dlsym(h,
"ompt_start_tool");
300 OMPT_VERBOSE_INIT_CONTINUED_PRINT(
"Failed: %s\n", dlerror());
303 OMPT_VERBOSE_INIT_PRINT(
"Opening %s... ", fname);
304 HMODULE h = LoadLibrary(fname);
306 OMPT_VERBOSE_INIT_CONTINUED_PRINT(
"Failed: Error %u\n", GetLastError());
308 OMPT_VERBOSE_INIT_CONTINUED_PRINT(
"Success. \n");
309 OMPT_VERBOSE_INIT_PRINT(
"Searching for ompt_start_tool in %s... ",
311 start_tool = (ompt_start_tool_t)GetProcAddress(h,
"ompt_start_tool");
313 OMPT_VERBOSE_INIT_CONTINUED_PRINT(
"Failed: Error %u\n",
317 #error Activation of OMPT is not supported on this platform.
320 ret = (*start_tool)(omp_version, runtime_version);
322 OMPT_VERBOSE_INIT_CONTINUED_PRINT(
"Success.\n");
323 OMPT_VERBOSE_INIT_PRINT(
324 "Tool was started and is using the OMPT interface.\n");
325 ompt_tool_module = h;
328 OMPT_VERBOSE_INIT_CONTINUED_PRINT(
329 "Found but not using the OMPT interface.\n");
330 OMPT_VERBOSE_INIT_PRINT(
"Continuing search...\n");
334 fname = __kmp_str_token(NULL, sep, &buf);
336 __kmp_str_free(&libs);
338 OMPT_VERBOSE_INIT_PRINT(
"No OMP_TOOL_LIBRARIES defined.\n");
343 OMPT_VERBOSE_INIT_PRINT(
"----- END LOGGING OF TOOL REGISTRATION -----\n");
349 const char *fname =
"libarcher.so";
350 OMPT_VERBOSE_INIT_PRINT(
351 "...searching tool libraries failed. Using archer tool.\n");
352 OMPT_VERBOSE_INIT_PRINT(
"Opening %s... ", fname);
353 void *h = dlopen(fname, RTLD_LAZY);
355 OMPT_VERBOSE_INIT_CONTINUED_PRINT(
"Success.\n");
356 OMPT_VERBOSE_INIT_PRINT(
"Searching for ompt_start_tool in %s... ", fname);
357 start_tool = (ompt_start_tool_t)dlsym(h,
"ompt_start_tool");
359 ret = (*start_tool)(omp_version, runtime_version);
361 OMPT_VERBOSE_INIT_CONTINUED_PRINT(
"Success.\n");
362 OMPT_VERBOSE_INIT_PRINT(
363 "Tool was started and is using the OMPT interface.\n");
364 OMPT_VERBOSE_INIT_PRINT(
365 "----- END LOGGING OF TOOL REGISTRATION -----\n");
368 OMPT_VERBOSE_INIT_CONTINUED_PRINT(
369 "Found but not using the OMPT interface.\n");
371 OMPT_VERBOSE_INIT_CONTINUED_PRINT(
"Failed: %s\n", dlerror());
376 OMPT_VERBOSE_INIT_PRINT(
"No OMP tool loaded.\n");
377 OMPT_VERBOSE_INIT_PRINT(
"----- END LOGGING OF TOOL REGISTRATION -----\n");
381 void ompt_pre_init() {
385 static int ompt_pre_initialized = 0;
387 if (ompt_pre_initialized)
390 ompt_pre_initialized = 1;
395 const char *ompt_env_var = getenv(
"OMP_TOOL");
396 tool_setting_e tool_setting = omp_tool_error;
398 if (!ompt_env_var || !strcmp(ompt_env_var,
""))
399 tool_setting = omp_tool_unset;
400 else if (OMPT_STR_MATCH(ompt_env_var,
"disabled"))
401 tool_setting = omp_tool_disabled;
402 else if (OMPT_STR_MATCH(ompt_env_var,
"enabled"))
403 tool_setting = omp_tool_enabled;
405 const char *ompt_env_verbose_init = getenv(
"OMP_TOOL_VERBOSE_INIT");
408 if (ompt_env_verbose_init && strcmp(ompt_env_verbose_init,
"") &&
409 !OMPT_STR_MATCH(ompt_env_verbose_init,
"disabled")) {
411 if (OMPT_STR_MATCH(ompt_env_verbose_init,
"STDERR"))
412 verbose_file = stderr;
413 else if (OMPT_STR_MATCH(ompt_env_verbose_init,
"STDOUT"))
414 verbose_file = stdout;
416 verbose_file = fopen(ompt_env_verbose_init,
"w");
421 printf(
"ompt_pre_init(): tool_setting = %d\n", tool_setting);
423 switch (tool_setting) {
424 case omp_tool_disabled:
425 OMPT_VERBOSE_INIT_PRINT(
"OMP tool disabled. \n");
429 case omp_tool_enabled:
434 ompt_start_tool_result =
435 ompt_try_start_tool(__kmp_openmp_version, ompt_get_runtime_version());
437 memset(&ompt_enabled, 0,
sizeof(ompt_enabled));
442 "Warning: OMP_TOOL has invalid value \"%s\".\n"
443 " legal values are (NULL,\"\",\"disabled\","
448 if (verbose_init && verbose_file != stderr && verbose_file != stdout)
449 fclose(verbose_file);
451 printf(
"ompt_pre_init(): ompt_enabled = %d\n", ompt_enabled);
455 extern "C" int omp_get_initial_device(
void);
457 void ompt_post_init() {
461 static int ompt_post_initialized = 0;
463 if (ompt_post_initialized)
466 ompt_post_initialized = 1;
471 if (ompt_start_tool_result) {
472 ompt_enabled.enabled = !!ompt_start_tool_result->initialize(
473 ompt_fn_lookup, omp_get_initial_device(),
474 &(ompt_start_tool_result->tool_data));
476 if (!ompt_enabled.enabled) {
478 memset(&ompt_enabled, 0,
sizeof(ompt_enabled));
482 kmp_info_t *root_thread = ompt_get_thread();
484 ompt_set_thread_state(root_thread, ompt_state_overhead);
486 if (ompt_enabled.ompt_callback_thread_begin) {
487 ompt_callbacks.ompt_callback(ompt_callback_thread_begin)(
488 ompt_thread_initial, __ompt_get_thread_data_internal());
490 ompt_data_t *task_data;
491 ompt_data_t *parallel_data;
492 __ompt_get_task_info_internal(0, NULL, &task_data, NULL, ¶llel_data,
494 if (ompt_enabled.ompt_callback_implicit_task) {
495 ompt_callbacks.ompt_callback(ompt_callback_implicit_task)(
496 ompt_scope_begin, parallel_data, task_data, 1, 1, ompt_task_initial);
499 ompt_set_thread_state(root_thread, ompt_state_work_serial);
504 if (ompt_enabled.enabled
506 && ompt_start_tool_result && ompt_start_tool_result->finalize
509 ompt_start_tool_result->finalize(&(ompt_start_tool_result->tool_data));
512 if (ompt_tool_module)
513 OMPT_DLCLOSE(ompt_tool_module);
514 memset(&ompt_enabled, 0,
sizeof(ompt_enabled));
525 OMPT_API_ROUTINE
int ompt_enumerate_states(
int current_state,
int *next_state,
526 const char **next_state_name) {
527 const static int len =
sizeof(ompt_state_info) /
sizeof(ompt_state_info_t);
530 for (i = 0; i < len - 1; i++) {
531 if (ompt_state_info[i].state_id == current_state) {
532 *next_state = ompt_state_info[i + 1].state_id;
533 *next_state_name = ompt_state_info[i + 1].state_name;
541 OMPT_API_ROUTINE
int ompt_enumerate_mutex_impls(
int current_impl,
543 const char **next_impl_name) {
544 const static int len =
545 sizeof(kmp_mutex_impl_info) /
sizeof(kmp_mutex_impl_info_t);
547 for (i = 0; i < len - 1; i++) {
548 if (kmp_mutex_impl_info[i].
id != current_impl)
550 *next_impl = kmp_mutex_impl_info[i + 1].id;
551 *next_impl_name = kmp_mutex_impl_info[i + 1].name;
561 OMPT_API_ROUTINE ompt_set_result_t ompt_set_callback(ompt_callbacks_t which,
562 ompt_callback_t callback) {
565 #define ompt_event_macro(event_name, callback_type, event_id) \
567 ompt_callbacks.ompt_callback(event_name) = (callback_type)callback; \
568 ompt_enabled.event_name = (callback != 0); \
570 return ompt_event_implementation_status(event_name); \
572 return ompt_set_always;
574 FOREACH_OMPT_EVENT(ompt_event_macro)
576 #undef ompt_event_macro
579 return ompt_set_error;
583 OMPT_API_ROUTINE
int ompt_get_callback(ompt_callbacks_t which,
584 ompt_callback_t *callback) {
585 if (!ompt_enabled.enabled)
586 return ompt_get_callback_failure;
590 #define ompt_event_macro(event_name, callback_type, event_id) \
592 ompt_callback_t mycb = \
593 (ompt_callback_t)ompt_callbacks.ompt_callback(event_name); \
594 if (ompt_enabled.event_name && mycb) { \
596 return ompt_get_callback_success; \
598 return ompt_get_callback_failure; \
601 FOREACH_OMPT_EVENT(ompt_event_macro)
603 #undef ompt_event_macro
606 return ompt_get_callback_failure;
614 OMPT_API_ROUTINE
int ompt_get_parallel_info(
int ancestor_level,
615 ompt_data_t **parallel_data,
617 if (!ompt_enabled.enabled)
619 return __ompt_get_parallel_info_internal(ancestor_level, parallel_data,
623 OMPT_API_ROUTINE
int ompt_get_state(ompt_wait_id_t *wait_id) {
624 if (!ompt_enabled.enabled)
625 return ompt_state_work_serial;
626 int thread_state = __ompt_get_state_internal(wait_id);
628 if (thread_state == ompt_state_undefined) {
629 thread_state = ompt_state_work_serial;
639 OMPT_API_ROUTINE ompt_data_t *ompt_get_thread_data(
void) {
640 if (!ompt_enabled.enabled)
642 return __ompt_get_thread_data_internal();
645 OMPT_API_ROUTINE
int ompt_get_task_info(
int ancestor_level,
int *type,
646 ompt_data_t **task_data,
647 ompt_frame_t **task_frame,
648 ompt_data_t **parallel_data,
650 if (!ompt_enabled.enabled)
652 return __ompt_get_task_info_internal(ancestor_level, type, task_data,
653 task_frame, parallel_data, thread_num);
656 OMPT_API_ROUTINE
int ompt_get_task_memory(
void **addr,
size_t *size,
658 return __ompt_get_task_memory_internal(addr, size, block);
665 OMPT_API_ROUTINE
int ompt_get_num_procs(
void) {
668 return __kmp_avail_proc;
675 OMPT_API_ROUTINE
int ompt_get_num_places(
void) {
677 #if !KMP_AFFINITY_SUPPORTED
680 if (!KMP_AFFINITY_CAPABLE())
682 return __kmp_affinity_num_masks;
686 OMPT_API_ROUTINE
int ompt_get_place_proc_ids(
int place_num,
int ids_size,
689 #if !KMP_AFFINITY_SUPPORTED
693 int tmp_ids[ids_size];
694 for (
int j = 0; j < ids_size; j++)
696 if (!KMP_AFFINITY_CAPABLE())
698 if (place_num < 0 || place_num >= (
int)__kmp_affinity_num_masks)
702 kmp_affin_mask_t *mask = KMP_CPU_INDEX(__kmp_affinity_masks, place_num);
704 KMP_CPU_SET_ITERATE(i, mask) {
705 if ((!KMP_CPU_ISSET(i, __kmp_affin_fullMask)) ||
706 (!KMP_CPU_ISSET(i, mask))) {
709 if (count < ids_size)
713 if (ids_size >= count) {
714 for (i = 0; i < count; i++) {
722 OMPT_API_ROUTINE
int ompt_get_place_num(
void) {
724 #if !KMP_AFFINITY_SUPPORTED
727 if (!ompt_enabled.enabled || __kmp_get_gtid() < 0)
732 if (!KMP_AFFINITY_CAPABLE())
734 gtid = __kmp_entry_gtid();
735 thread = __kmp_thread_from_gtid(gtid);
736 if (thread == NULL || thread->th.th_current_place < 0)
738 return thread->th.th_current_place;
742 OMPT_API_ROUTINE
int ompt_get_partition_place_nums(
int place_nums_size,
745 #if !KMP_AFFINITY_SUPPORTED
748 if (!ompt_enabled.enabled || __kmp_get_gtid() < 0)
751 int i, gtid, place_num, first_place, last_place, start, end;
753 if (!KMP_AFFINITY_CAPABLE())
755 gtid = __kmp_entry_gtid();
756 thread = __kmp_thread_from_gtid(gtid);
759 first_place = thread->th.th_first_place;
760 last_place = thread->th.th_last_place;
761 if (first_place < 0 || last_place < 0)
763 if (first_place <= last_place) {
770 if (end - start <= place_nums_size)
771 for (i = 0, place_num = start; place_num <= end; ++place_num, ++i) {
772 place_nums[i] = place_num;
774 return end - start + 1;
782 OMPT_API_ROUTINE
int ompt_get_proc_id(
void) {
783 if (!ompt_enabled.enabled || __kmp_get_gtid() < 0)
786 return sched_getcpu();
789 GetCurrentProcessorNumberEx(&pn);
790 return 64 * pn.Group + pn.Number;
813 int __kmp_control_tool(uint64_t command, uint64_t modifier,
void *arg) {
815 if (ompt_enabled.enabled) {
816 if (ompt_enabled.ompt_callback_control_tool) {
817 return ompt_callbacks.ompt_callback(ompt_callback_control_tool)(
818 command, modifier, arg, OMPT_LOAD_RETURN_ADDRESS(__kmp_entry_gtid()));
831 OMPT_API_ROUTINE uint64_t ompt_get_unique_id(
void) {
832 return __ompt_get_unique_id_internal();
835 OMPT_API_ROUTINE
void ompt_finalize_tool(
void) { __kmp_internal_end_atexit(); }
841 OMPT_API_ROUTINE
int ompt_get_target_info(uint64_t *device_num,
842 ompt_id_t *target_id,
843 ompt_id_t *host_op_id) {
847 OMPT_API_ROUTINE
int ompt_get_num_devices(
void) {
855 static ompt_interface_fn_t ompt_fn_lookup(
const char *s) {
857 #define ompt_interface_fn(fn) \
858 fn##_t fn##_f = fn; \
859 if (strcmp(s, #fn) == 0) \
860 return (ompt_interface_fn_t)fn##_f;
862 FOREACH_OMPT_INQUIRY_FN(ompt_interface_fn)