[OpenMP] Define named constants for interop's foreign runtime ID

[hbae]

Summary

Also added missing Fortran definitions for interop support.

[AndreyChurbanov]

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

224

Should the first parameter type be omp_interop_t?

[hbae]

Fixed incorrect parameter type.

[JonChesterfield]

Does anyone have a reference for what we're supposed to do with one of these things?

Amdgpu openmp isn't implemented in terms of any of those (it is a layer on HSA), but it's possible we can cobble together enough of a HIP or opencl 'instance' on the fly to satisfy the interface. I can't find any information on what that interface is meant to be though.

[jdoerfert]

In D102883#2791123, @JonChesterfield wrote:

Does anyone have a reference for what we're supposed to do with one of these things?

Amdgpu openmp isn't implemented in terms of any of those (it is a layer on HSA), but it's possible we can cobble together enough of a HIP or opencl 'instance' on the fly to satisfy the interface. I can't find any information on what that interface is meant to be though.

It's pretty much up to the impl what this means. The extra document lists what the user should expect for those foreign runtimes. You can ask them to add HSA without problems, defining what the results of various calls should be (in terms of type).

Also @sriharikrishna is working on getting the early prototype for interop up and running. We'll get some patches hopefully soon. The plugins can then implement their own getters eventually.

[AndreyChurbanov]

LGTM

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

typedef enum omp_interop_rc {
         omp_irc_empty = -1,
         omp_irc_out_of_range = -2,
         omp_irc_type_int = -3,
         omp_irc_type_ptr = -4,
         omp_irc_type_str = -5,
         omp_irc_other = -6
     } omp_interop_rc_t;
 
+    typedef enum omp_interop_fr {
+        omp_ifr_cuda = 1,
+        omp_ifr_cuda_driver = 2,
+        omp_ifr_opencl = 3,
+        omp_ifr_sycl = 4,
+        omp_ifr_hip = 5,
+        omp_ifr_level_zero = 6,
+        omp_ifr_last = 7
+    } omp_interop_fr_t;
+
     typedef void * omp_interop_t;
 
     /*!
      * The `omp_get_num_interop_properties` routine retrieves the number of implementation-defined properties available for an `omp_interop_t` object.
      */
     extern int          __KAI_KMPC_CONVENTION  omp_get_num_interop_properties(const omp_interop_t);
     /*!
      * The `omp_get_interop_int` routine retrieves an integer property from an `omp_interop_t` object.
#   endif
     extern const char * __KAI_KMPC_CONVENTION  omp_get_interop_name(const omp_interop_t, omp_interop_property_t);
     /*!
      * The `omp_get_interop_type_desc` routine retrieves a description of the type of a property associated with an `omp_interop_t` object.
      */
     extern const char * __KAI_KMPC_CONVENTION  omp_get_interop_type_desc(const omp_interop_t, omp_interop_property_t);
     /*!
      * The `omp_get_interop_rc_desc` routine retrieves a description of the return code associated with an `omp_interop_t` object.
      */
     extern const char * __KAI_KMPC_CONVENTION  omp_get_interop_rc_desc(const omp_interop_rc_t, omp_interop_rc_t);
 
     /* OpenMP 5.1 device memory routines */
 
     /*!
      * The `omp_target_memcpy_async` routine asynchronously performs a copy between any combination of host and device pointers.
      */
     extern int    __KAI_KMPC_CONVENTION  omp_target_memcpy_async(void *, const void *, size_t, size_t, size_t, int,
                                              int, int, omp_depend_t *);

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

!
       integer omp_alloctrait_val_kind
       parameter(omp_alloctrait_val_kind=int_ptr_kind())
       integer omp_pause_resource_kind
       parameter(omp_pause_resource_kind=omp_integer_kind)
       integer omp_depend_kind
       parameter(omp_depend_kind=int_ptr_kind())
       integer omp_event_handle_kind
       parameter(omp_event_handle_kind=int_ptr_kind())
+      integer omp_interop_kind
+      parameter(omp_interop_kind=int_ptr_kind())
+      integer omp_interop_fr_kind
+      parameter(omp_interop_fr_kind=omp_integer_kind)
 
       integer(kind=omp_integer_kind)openmp_version
       parameter(openmp_version=@LIBOMP_OMP_YEAR_MONTH@)
       integer(kind=omp_integer_kind)kmp_version_major
       parameter(kmp_version_major=@LIBOMP_VERSION_MAJOR@)
       integer(kind=omp_integer_kind)kmp_version_minor
       parameter(kmp_version_minor=@LIBOMP_VERSION_MINOR@)
       integer(kind=omp_integer_kind)kmp_version_build
!
 
       integer(kind=omp_pause_resource_kind)omp_pause_resume
       parameter(omp_pause_resume=0)
       integer(kind=omp_pause_resource_kind)omp_pause_soft
       parameter(omp_pause_soft=1)
       integer(kind=omp_pause_resource_kind)omp_pause_hard
       parameter(omp_pause_hard=2)
 
+      integer(kind=omp_interop_fr_kind)omp_ifr_cuda
+      parameter(omp_ifr_cuda=1)
+      integer(kind=omp_interop_fr_kind)omp_ifr_cuda_driver
+      parameter(omp_ifr_cuda_driver=2)
+      integer(kind=omp_interop_fr_kind)omp_ifr_opencl
+      parameter(omp_ifr_opencl=3)
+      integer(kind=omp_interop_fr_kind)omp_ifr_sycl
+      parameter(omp_ifr_sycl=4)
+      integer(kind=omp_interop_fr_kind)omp_ifr_hip
+      parameter(omp_ifr_hip=5)
+      integer(kind=omp_interop_fr_kind)omp_ifr_level_zero
+      parameter(omp_ifr_level_zero=6)
+      integer(kind=omp_interop_fr_kind)omp_ifr_last
+      parameter(omp_ifr_last=7)
+
+      integer(kind=omp_interop_kind)omp_interop_none
+      parameter(omp_interop_none=0)
+
       interface
 
 !       ***
 !       *** omp_* entry points
 !       ***
 
         subroutine omp_set_num_threads(num_threads) bind(c)
           import

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

!
         integer, parameter :: omp_sync_hint_kind     = omp_integer_kind
         integer, parameter :: omp_lock_hint_kind     = omp_sync_hint_kind
         integer, parameter :: omp_control_tool_kind  = omp_integer_kind
         integer, parameter :: omp_control_tool_result_kind = omp_integer_kind
         integer, parameter :: omp_allocator_handle_kind = c_intptr_t
         integer, parameter :: omp_memspace_handle_kind = c_intptr_t
         integer, parameter :: omp_alloctrait_key_kind = omp_integer_kind
         integer, parameter :: omp_alloctrait_val_kind = c_intptr_t
+        integer, parameter :: omp_interop_kind = c_intptr_t
+        integer, parameter :: omp_interop_fr_kind = omp_integer_kind
 
         type omp_alloctrait
           integer(kind=omp_alloctrait_key_kind) key
           integer(kind=omp_alloctrait_val_kind) value
         end type omp_alloctrait
 
         integer, parameter :: omp_pause_resource_kind = omp_integer_kind
         integer, parameter :: omp_depend_kind = c_intptr_t
!
         integer (kind=omp_memspace_handle_kind), parameter :: llvm_omp_target_host_mem_space = 100
         integer (kind=omp_memspace_handle_kind), parameter :: llvm_omp_target_shared_mem_space = 101
         integer (kind=omp_memspace_handle_kind), parameter :: llvm_omp_target_device_mem_space = 102
 
         integer (kind=omp_pause_resource_kind), parameter :: omp_pause_resume = 0
         integer (kind=omp_pause_resource_kind), parameter :: omp_pause_soft = 1
         integer (kind=omp_pause_resource_kind), parameter :: omp_pause_hard = 2
 
+        integer (kind=omp_interop_fr_kind), parameter :: omp_ifr_cuda = 1
+        integer (kind=omp_interop_fr_kind), parameter :: omp_ifr_cuda_driver = 2
+        integer (kind=omp_interop_fr_kind), parameter :: omp_ifr_opencl = 3
+        integer (kind=omp_interop_fr_kind), parameter :: omp_ifr_sycl = 4
+        integer (kind=omp_interop_fr_kind), parameter :: omp_ifr_hip = 5
+        integer (kind=omp_interop_fr_kind), parameter :: omp_ifr_level_zero = 6
+        integer (kind=omp_interop_fr_kind), parameter :: omp_ifr_last = 7
+
+        integer (kind=omp_interop_kind), parameter :: omp_interop_none = 0
+
         interface
 
 !         ***
 !         *** omp_* entry points
 !         ***
 
           subroutine omp_set_num_threads(num_threads) bind(c)
             use omp_lib_kinds