OpenMP 5.1 omp_display_env function implementation.

[AndreyChurbanov]

Summary

Patch by Michael Klemm.

It implements omp_display_env() API, which is run time counterpart of the OMP_DISPLAY_ENV environment variable.
This is part of coming OpenMP 5.1 specification to be released later this year.

[AndreyChurbanov]

Added full context.
Also added (missed) "value" attribute to Fortran interfaces.

[kkwli0]

openmp/runtime/src/include/omp_lib.f.var

493

The subroutine is declared as bind(C) and the verbose argument is passed by reference. Does it match the C prototype? Should it have the value attribute as well?

[AndreyChurbanov]

Addressed Kelvin's comment.

[jdoerfert]

We can have filechek tests, right? We should verify a bit more than the existence of a function that will return.

openmp/runtime/src/kmp_settings.cpp

5757

Do we need to keep this code?

[AndreyChurbanov]

In D74956#1887883, @jdoerfert wrote:

We can have filechek tests, right? We should verify a bit more than the existence of a function that will return.

I am not sure how to pipe error output (stderr) to filecheck. I saw some examples of the "2>&1 |", this works in bash, but does not work in c shell. Maybe "|2" can be used?

Could somebody please advise how to better pipe stderr to filecheck? Is the "2>&1 |" appropriate? I personally work in bash usually, but some systems may have other shell by default.

[hbae]

In D74956#1901473, @AndreyChurbanov wrote:

In D74956#1887883, @jdoerfert wrote:

We can have filechek tests, right? We should verify a bit more than the existence of a function that will return.

I am not sure how to pipe error output (stderr) to filecheck. I saw some examples of the "2>&1 |", this works in bash, but does not work in c shell. Maybe "|2" can be used?

Could somebody please advise how to better pipe stderr to filecheck? Is the "2>&1 |" appropriate? I personally work in bash usually, but some systems may have other shell by default.

Can we do it in two steps?

1. Redirect 2 to file A
2. Then, feed A to FileCheck

[jlpeyton]

In D74956#1901473, @AndreyChurbanov wrote:

In D74956#1887883, @jdoerfert wrote:

We can have filechek tests, right? We should verify a bit more than the existence of a function that will return.

I am not sure how to pipe error output (stderr) to filecheck. I saw some examples of the "2>&1 |", this works in bash, but does not work in c shell. Maybe "|2" can be used?

Could somebody please advise how to better pipe stderr to filecheck? Is the "2>&1 |" appropriate? I personally work in bash usually, but some systems may have other shell by default.

Lit parses the 2>&1 directly, redirection is set (probably for subprocess python module), and the text is not sent to an underlying shell. So lit acts as a limited, platform-independent Bourne shell. So It is safe to use 2>&1.

From https://llvm.org/docs/TestingGuide.html:

RUN lines are specified in the comments of the test program using the keyword `RUN` followed by a colon, and lastly the command (pipeline)
to execute. Together, these lines form the "script" that :program:lit executes to run the test case. The syntax of the RUN lines is similar to a
shell's syntax for pipelines including I/O redirection and variable substitution. However, even though these lines may *look* like a shell
script, they are not. RUN lines are interpreted by :program:lit. Consequently, the syntax differs from shell in a few ways. You can specify
as many RUN lines as needed.

[AndreyChurbanov]

Addressed comments: removed "#if 0" code block; added basic checks for the test.

[jdoerfert]

Fine with me, others commented so we should wait.

[hbae]

Looks good to me.

openmp/runtime/src/dllexports

kmp_set_disp_num_buffers                    890
     ompc_set_affinity_format                752
     ompc_get_affinity_format                753
     ompc_display_affinity                   754
     ompc_capture_affinity                   755
     omp_pause_resource                      756
     omp_pause_resource_all                  757
     omp_get_supported_active_levels         758
     omp_fulfill_event                       759
+    omp_display_env                         899
 
     omp_null_allocator                     DATA
     omp_default_mem_alloc                  DATA
     omp_large_cap_mem_alloc                DATA
     omp_const_mem_alloc                    DATA
     omp_high_bw_mem_alloc                  DATA
     omp_low_lat_mem_alloc                  DATA
     omp_cgroup_mem_alloc                   DATA

openmp/runtime/src/include/omp.h.var

typedef enum omp_pause_resource_t {
       omp_pause_soft = 1,
       omp_pause_hard = 2
     } omp_pause_resource_t;
     extern int __KAI_KMPC_CONVENTION omp_pause_resource(omp_pause_resource_t, int);
     extern int __KAI_KMPC_CONVENTION omp_pause_resource_all(omp_pause_resource_t);
 
     extern int __KAI_KMPC_CONVENTION omp_get_supported_active_levels(void);
 
+    /* OpenMP 5.1 Display Environment */
+    extern void omp_display_env(int verbose);
+
 #   undef __KAI_KMPC_CONVENTION
 #   undef __KMP_IMP
 
     /* Warning:
        The following typedefs are not standard, deprecated and will be removed in a future release.
     */
     typedef int     omp_int_t;
     typedef double  omp_wtime_t;
 
 #   ifdef __cplusplus
     }
 #   endif
 
 #endif /* __OMP_H */

openmp/runtime/src/include/omp_lib.h.var

!DIR$ ENDIF
 
         function omp_capture_affinity(buffer, format)
           import
           character (len=*) :: format
           character (len=*) :: buffer
           integer (kind=kmp_size_t_kind) :: omp_capture_affinity
         end function omp_capture_affinity
 
+        subroutine omp_display_env(verbose) bind(c)
+          import
+          logical (kind=omp_logical_kind), value :: verbose
+        end subroutine omp_display_env
+
 !       ***
 !       *** kmp_* entry points
 !       ***
 
         subroutine kmp_set_stacksize(size) bind(c)
           import
           integer (kind=omp_integer_kind), value :: size
         end subroutine kmp_set_stacksize

openmp/runtime/src/include/omp_lib.f.var

!DIR$ ENDIF
 
           function omp_capture_affinity(buffer, format)
             use omp_lib_kinds
             character (len=*) format
             character (len=*) buffer
             integer (kind=kmp_size_t_kind) omp_capture_affinity
           end function omp_capture_affinity
 
+          subroutine omp_display_env(verbose) bind(c)
+            use omp_lib_kinds
+            logical (kind=omp_logical_kind) verbose
+          end subroutine omp_display_env
+
 !         ***
 !         *** kmp_* entry points
 !         ***
 
           subroutine kmp_set_stacksize(size)
             use omp_lib_kinds
             integer (kind=omp_integer_kind) size
           end subroutine kmp_set_stacksize

openmp/runtime/src/include/omp_lib.f90.var

!DIR$ ENDIF
 
           function omp_capture_affinity(buffer, format)
             use omp_lib_kinds
             character (len=*) :: format
             character (len=*) :: buffer
             integer (kind=kmp_size_t_kind) :: omp_capture_affinity
           end function omp_capture_affinity
 
+          subroutine omp_display_env(verbose) bind(c)
+            use omp_lib_kinds
+            logical (kind=omp_logical_kind), value :: verbose
+          end subroutine omp_display_env
+
+
 !         ***
 !         *** kmp_* entry points
 !         ***
 
           subroutine kmp_set_stacksize(size) bind(c)
             use omp_lib_kinds
             integer (kind=omp_integer_kind), value :: size
           end subroutine kmp_set_stacksize

openmp/runtime/src/kmp.h

 // be uninitialized after hard pause. Let OMP constructs trigger required
 // initializations.
 static inline void __kmp_resume_if_hard_paused() {
   if (__kmp_pause_status == kmp_hard_paused) {
     __kmp_pause_status = kmp_not_paused;
   }
 }
 
+extern void __kmp_omp_display_env(int verbose);
+
 #ifdef __cplusplus
 }
 #endif
 
 #endif /* KMP_H */

openmp/runtime/src/kmp_ftn_entry.h

 }
 
 void FTN_STDCALL FTN_FULFILL_EVENT(kmp_event_t *event) {
 #ifndef KMP_STUB
   __kmp_fulfill_event(event);
 #endif
 }
 
+// display environment variables when requested
+void FTN_STDCALL FTN_DISPLAY_ENV(int verbose) {
+#ifndef KMP_STUB
+  __kmp_omp_display_env(verbose);
+#endif
+}
+
 // GCC compatibility (versioned symbols)
 #ifdef KMP_USE_VERSION_SYMBOLS
 
 /* These following sections create versioned symbols for the
    omp_* routines. The KMP_VERSION_SYMBOL macro expands the API name and
    then maps it to a versioned symbol.
    libgomp ``versions'' its symbols (OMP_1.0, OMP_2.0, OMP_3.0, ...) while also
    retaining the default version which libomp uses: VERSION (defined in

openmp/runtime/src/kmp_ftn_os.h

 #define FTN_GET_DEVICE_NUM omp_get_device_num
 #define FTN_SET_AFFINITY_FORMAT omp_set_affinity_format
 #define FTN_GET_AFFINITY_FORMAT omp_get_affinity_format
 #define FTN_DISPLAY_AFFINITY omp_display_affinity
 #define FTN_CAPTURE_AFFINITY omp_capture_affinity
 #define FTN_PAUSE_RESOURCE omp_pause_resource
 #define FTN_PAUSE_RESOURCE_ALL omp_pause_resource_all
 #define FTN_GET_SUPPORTED_ACTIVE_LEVELS omp_get_supported_active_levels
+#define FTN_DISPLAY_ENV omp_display_env
 #define FTN_FULFILL_EVENT omp_fulfill_event
 
 #endif /* KMP_FTN_PLAIN */
 
 /* ------------------------------------------------------------------------ */
 
 #if KMP_FTN_ENTRIES == KMP_FTN_APPEND
 

 #define FTN_GET_DEVICE_NUM omp_get_device_num_
 #define FTN_SET_AFFINITY_FORMAT omp_set_affinity_format_
 #define FTN_GET_AFFINITY_FORMAT omp_get_affinity_format_
 #define FTN_DISPLAY_AFFINITY omp_display_affinity_
 #define FTN_CAPTURE_AFFINITY omp_capture_affinity_
 #define FTN_PAUSE_RESOURCE omp_pause_resource_
 #define FTN_PAUSE_RESOURCE_ALL omp_pause_resource_all_
 #define FTN_GET_SUPPORTED_ACTIVE_LEVELS omp_get_supported_active_levels_
+#define FTN_DISPLAY_ENV omp_display_env_
 #define FTN_FULFILL_EVENT omp_fulfill_event_
 
 #endif /* KMP_FTN_APPEND */
 
 /* ------------------------------------------------------------------------ */
 
 #if KMP_FTN_ENTRIES == KMP_FTN_UPPER
 

 #define FTN_GET_DEVICE_NUM OMP_GET_DEVICE_NUM
 #define FTN_SET_AFFINITY_FORMAT OMP_SET_AFFINITY_FORMAT
 #define FTN_GET_AFFINITY_FORMAT OMP_GET_AFFINITY_FORMAT
 #define FTN_DISPLAY_AFFINITY OMP_DISPLAY_AFFINITY
 #define FTN_CAPTURE_AFFINITY OMP_CAPTURE_AFFINITY
 #define FTN_PAUSE_RESOURCE OMP_PAUSE_RESOURCE
 #define FTN_PAUSE_RESOURCE_ALL OMP_PAUSE_RESOURCE_ALL
 #define FTN_GET_SUPPORTED_ACTIVE_LEVELS OMP_GET_SUPPORTED_ACTIVE_LEVELS
+#define FTN_DISPLAY_ENV OMP_DISPLAY_ENV
 #define FTN_FULFILL_EVENT OMP_FULFILL_EVENT
 
 #endif /* KMP_FTN_UPPER */
 
 /* ------------------------------------------------------------------------ */
 
 #if KMP_FTN_ENTRIES == KMP_FTN_UAPPEND
 

 #define FTN_GET_DEVICE_NUM OMP_GET_DEVICE_NUM_
 #define FTN_SET_AFFINITY_FORMAT OMP_SET_AFFINITY_FORMAT_
 #define FTN_GET_AFFINITY_FORMAT OMP_GET_AFFINITY_FORMAT_
 #define FTN_DISPLAY_AFFINITY OMP_DISPLAY_AFFINITY_
 #define FTN_CAPTURE_AFFINITY OMP_CAPTURE_AFFINITY_
 #define FTN_PAUSE_RESOURCE OMP_PAUSE_RESOURCE_
 #define FTN_PAUSE_RESOURCE_ALL OMP_PAUSE_RESOURCE_ALL_
 #define FTN_GET_SUPPORTED_ACTIVE_LEVELS OMP_GET_SUPPORTED_ACTIVE_LEVELS_
+#define FTN_DISPLAY_ENV OMP_DISPLAY_ENV_
 #define FTN_FULFILL_EVENT OMP_FULFILL_EVENT_
 
 #endif /* KMP_FTN_UAPPEND */
 
 /* -------------------------- GOMP API NAMES ------------------------ */
 // All GOMP_1.0 symbols
 #define KMP_API_NAME_GOMP_ATOMIC_END GOMP_atomic_end
 #define KMP_API_NAME_GOMP_ATOMIC_START GOMP_atomic_start

openmp/runtime/src/kmp_runtime.cpp

#endif
 
   KA_TRACE(10, ("reduction method selected=%08x\n", retval));
 
 #undef FAST_REDUCTION_TREE_METHOD_GENERATED
 #undef FAST_REDUCTION_ATOMIC_METHOD_GENERATED
 
   return (retval);
 }
-
 // this function is for testing set/get/determine reduce method
 kmp_int32 __kmp_get_reduce_method(void) {
   return ((__kmp_entry_thread()->th.th_local.packed_reduction_method) >> 8);
 }
 
 // Soft pause sets up threads to ignore blocktime and just go to sleep.
 // Spin-wait code checks __kmp_pause_status and reacts accordingly.
 void __kmp_soft_pause() { __kmp_pause_status = kmp_soft_paused; }
if (__kmp_pause_status != kmp_not_paused) {
       __kmp_hard_pause();
       return 0;
     }
   } else {
     // error message about invalid level
     return 1;
   }
 }
+
+
+void __kmp_omp_display_env(int verbose) {
+  // TODO: do we have to init the runtime here?
+  __kmp_acquire_bootstrap_lock(&__kmp_initz_lock);
+  if (__kmp_init_serial == 0)
+    __kmp_do_serial_initialize();
+  __kmp_display_env_impl(!verbose, verbose);
+  __kmp_release_bootstrap_lock(&__kmp_initz_lock);
+}

openmp/runtime/src/kmp_settings.h

 
 #ifndef KMP_SETTINGS_H
 #define KMP_SETTINGS_H
 
 void __kmp_reset_global_vars(void);
 void __kmp_env_initialize(char const *);
 void __kmp_env_print();
 void __kmp_env_print_2();
+void __kmp_display_env_impl(int display_env, int display_env_verbose);
 
 int __kmp_initial_threads_capacity(int req_nproc);
 void __kmp_init_dflt_team_nth();
 int __kmp_convert_to_milliseconds(char const *);
 int __kmp_default_tp_capacity(int, int, int);
 
 #if KMP_MIC
 #define KMP_STR_BUF_PRINT_NAME                                                 \

openmp/runtime/src/kmp_settings.cpp

#endif // KMP_GOMP_COMPAT
   __kmp_env_blk_free(&block);
   __kmp_str_buf_free(&buffer);
 
   __kmp_printf("\n");
 
 } // __kmp_env_print
 
 void __kmp_env_print_2() {
-
+#if 0
   kmp_env_blk_t block;
   kmp_str_buf_t buffer;
 
   __kmp_env_format = 1;
 
   __kmp_stg_init();
   __kmp_str_buf_init(&buffer);
 
#if 0
   __kmp_str_buf_print(&buffer, "\n");
 
   __kmp_printf("%s", buffer.str);
 
   __kmp_env_blk_free(&block);
   __kmp_str_buf_free(&buffer);
 
   __kmp_printf("\n");
+#endif
+  __kmp_display_env_impl(__kmp_display_env, __kmp_display_env_verbose);
 
 } // __kmp_env_print_2
 
+
+void __kmp_display_env_impl(int display_env, int display_env_verbose) {
+  kmp_env_blk_t block;
+  kmp_str_buf_t buffer;
+
+  __kmp_env_format = 1;
+
+  __kmp_stg_init();
+  __kmp_str_buf_init(&buffer);
+
+  __kmp_env_blk_init(&block, NULL);
+  __kmp_env_blk_sort(&block);
+
+  __kmp_str_buf_print(&buffer, "\n%s\n", KMP_I18N_STR(DisplayEnvBegin));
+  __kmp_str_buf_print(&buffer, "   _OPENMP='%d'\n", __kmp_openmp_version);
+
+  for (int i = 0; i < __kmp_stg_count; ++i) {
+    if (__kmp_stg_table[i].print != NULL &&
+        ((display_env &&
+          strncmp(__kmp_stg_table[i].name, "OMP_", 4) == 0) ||
+         display_env_verbose)) {
+      __kmp_stg_table[i].print(&buffer, __kmp_stg_table[i].name,
+                               __kmp_stg_table[i].data);
+    }
+  }
+
+  __kmp_str_buf_print(&buffer, "%s\n", KMP_I18N_STR(DisplayEnvEnd));
+  __kmp_str_buf_print(&buffer, "\n");
+
+  __kmp_printf("%s", buffer.str);
+
+  __kmp_env_blk_free(&block);
+  __kmp_str_buf_free(&buffer);
+
+  __kmp_printf("\n");
+}
+
 // end of file
+

openmp/runtime/test/api/omp_display_env0.c

+// RUN: %libomp-compile-and-run
+// RUN: %libomp-cxx-compile-and-run
+#include <stdio.h>
+#include <omp.h>
+int main()
+{
+  omp_display_env(0);
+  printf("passed\n");
+  return 0;
+}