Improve OMPT initialization code

[jmellorcrummey]

Summary

Use of #ifdef OMPT_DEBUG was causing messages to be generated under normal operation when the OpenMP library was compiled with KMP_DEBUG enabled. Elsewhere, KMP_DEBUG evaluates assertions, but never produces messages during normal operation. To avoid this inconsistency, set OMPT_DEBUG using a cmake variable LIBOMP_OMPT_DEBUG.

While I was editing the associated ompt-specific.h and ompt-general.c files, make the spacing and comments consistent.

[jlpeyton]

LGTM.

runtime/CMakeLists.txt

if(LIBOMP_STATS AND (NOT LIBOMP_HAVE_STATS))
   libomp_error_say("Stats-gathering functionality requested but not available")
 endif()
 # The stats functionality requires the std c++ library
 if(LIBOMP_STATS)
   set(LIBOMP_USE_STDCPPLIB TRUE)
 endif()
 
 # OMPT-support
+set(LIBOMP_OMPT_DEBUG FALSE CACHE BOOL
+  "Trace OMPT initialization?")
 set(LIBOMP_OMPT_SUPPORT FALSE CACHE BOOL
   "OMPT-support?")
 set(LIBOMP_OMPT_BLAME TRUE CACHE BOOL
   "OMPT-blame?")
 set(LIBOMP_OMPT_TRACE TRUE CACHE BOOL
   "OMPT-trace?")
 if(LIBOMP_OMPT_SUPPORT AND (NOT LIBOMP_HAVE_OMPT_SUPPORT))
   libomp_error_say("OpenMP Tools Interface requested but not available")

runtime/src/kmp_config.h.cmake

 #cmakedefine01 LIBOMP_HAVE_WEAK_ATTRIBUTE
 #define KMP_HAVE_WEAK_ATTRIBUTE LIBOMP_HAVE_WEAK_ATTRIBUTE
 #cmakedefine01 LIBOMP_HAVE_PSAPI
 #define KMP_HAVE_PSAPI LIBOMP_HAVE_PSAPI
 #cmakedefine01 LIBOMP_STATS
 #define KMP_STATS_ENABLED LIBOMP_STATS
 #cmakedefine01 LIBOMP_USE_DEBUGGER
 #define USE_DEBUGGER LIBOMP_USE_DEBUGGER
+#cmakedefine01 LIBOMP_OMPT_DEBUG
+#define OMPT_DEBUG LIBOMP_OMPT_DEBUG
 #cmakedefine01 LIBOMP_OMPT_SUPPORT
 #define OMPT_SUPPORT LIBOMP_OMPT_SUPPORT
 #cmakedefine01 LIBOMP_OMPT_BLAME
 #define OMPT_BLAME LIBOMP_OMPT_BLAME
 #cmakedefine01 LIBOMP_OMPT_TRACE
 #define OMPT_TRACE LIBOMP_OMPT_TRACE
 #cmakedefine01 LIBOMP_USE_ADAPTIVE_LOCKS
 #define KMP_USE_ADAPTIVE_LOCKS LIBOMP_USE_ADAPTIVE_LOCKS

runtime/src/ompt-general.c

ompt_initialize_t ompt_tool_windows()
     HMODULE *modules;
     HANDLE  process = GetCurrentProcess();
     modules = (HMODULE*)malloc( NUM_MODULES * sizeof(HMODULE) );
     ompt_initialize_t (*ompt_tool_p)() = NULL;
 
 #if OMPT_DEBUG
     printf("ompt_tool_windows(): looking for ompt_tool\n");
 #endif
-    if( !EnumProcessModules( process, modules, NUM_MODULES * sizeof(HMODULE),
-                             &needed ) ) {
+    if (!EnumProcessModules( process, modules, NUM_MODULES * sizeof(HMODULE),
+                              &needed)) {
         // Regardless of the error reason use the stub initialization function
         free(modules);
         return NULL;
     }
     // Check if NUM_MODULES is enough to list all modules
     new_size = needed / sizeof(HMODULE);
-    if( new_size > NUM_MODULES ) {
+    if (new_size > NUM_MODULES) {
 #if OMPT_DEBUG
     printf("ompt_tool_windows(): resize buffer to %d bytes\n", needed);
 #endif
         modules = (HMODULE*)realloc( modules, needed );
         // If resizing failed use the stub function.
-        if( !EnumProcessModules( process, modules, needed, &needed ) ) {
+        if (!EnumProcessModules(process, modules, needed, &needed)) {
             free(modules);
             return NULL;
         }
     }
-    for( i = 0; i < new_size; ++i ) {
+    for (i = 0; i < new_size; ++i) {
         (FARPROC &)ompt_tool_p = GetProcAddress(modules[i], "ompt_tool");
-        if( ompt_tool_p ) {
+        if (ompt_tool_p) {
 #if OMPT_DEBUG
             TCHAR modName[MAX_PATH];
-            if( GetModuleFileName(modules[i], modName, MAX_PATH))
+            if (GetModuleFileName(modules[i], modName, MAX_PATH))
                 printf("ompt_tool_windows(): ompt_tool found in module %s\n",
                        modName);
 #endif
             free(modules);
             return ompt_tool_p();
         }
 #if OMPT_DEBUG
         else {
             TCHAR modName[MAX_PATH];
-            if( GetModuleFileName(modules[i], modName, MAX_PATH) )
+            if (GetModuleFileName(modules[i], modName, MAX_PATH))
                 printf("ompt_tool_windows(): ompt_tool not found in module %s\n",
                        modName);
         }
 #endif
     }
     free(modules);
     return NULL;
 }
#endif
     case omp_tool_error:
         fprintf(stderr,
             "Warning: OMP_TOOL has invalid value \"%s\".\n"
             "  legal values are (NULL,\"\",\"disabled\","
             "\"enabled\").\n", ompt_env_var);
         break;
     }
 #if OMPT_DEBUG
-    printf("ompt_pre_init():ompt_enabled = %d\n", ompt_enabled);
+    printf("ompt_pre_init(): ompt_enabled = %d\n", ompt_enabled);
 #endif
 }
 
 
 void ompt_post_init()
 {
     //--------------------------------------------------
     // Execute the post-initialization logic only once.

runtime/src/ompt-specific.h

 #ifndef OMPT_SPECIFIC_H
 #define OMPT_SPECIFIC_H
 
 #include "kmp.h"
 
+/*****************************************************************************
+ * types
+ ****************************************************************************/
+
 typedef kmp_info_t ompt_thread_t;
 
+
+
+/*****************************************************************************
+ * forward declarations
+ ****************************************************************************/
+
 void __ompt_team_assign_id(kmp_team_t *team, ompt_parallel_id_t ompt_pid);
 void __ompt_thread_assign_wait_id(void *variable);
 
 void __ompt_lw_taskteam_init(ompt_lw_taskteam_t *lwt, ompt_thread_t *thr,
                              int gtid, void *microtask,
                              ompt_parallel_id_t ompt_pid);
 
 void __ompt_lw_taskteam_link(ompt_lw_taskteam_t *lwt,  ompt_thread_t *thr);

 
 int __ompt_get_parallel_team_size_internal(int ancestor_level);
 
 ompt_task_id_t __ompt_get_task_id_internal(int depth);
 
 ompt_frame_t *__ompt_get_task_frame_internal(int depth);
 
 
+
 /*****************************************************************************
  * macros
  ****************************************************************************/
-#define OMPT_DEBUG KMP_DEBUG
+
 #define OMPT_HAVE_WEAK_ATTRIBUTE KMP_HAVE_WEAK_ATTRIBUTE
 #define OMPT_HAVE_PSAPI KMP_HAVE_PSAPI
 #define OMPT_STR_MATCH(haystack, needle) __kmp_str_match(haystack, 0, needle)
 
 
+
 //******************************************************************************
 // inline functions
 //******************************************************************************
 
 inline ompt_thread_t *
 ompt_get_thread_gtid(int gtid)
 {
     return (gtid >= 0) ? __kmp_thread_from_gtid(gtid) : NULL;