Merge pull request #267 from bonachea/prif-0.7-dealloc-coarray

Implement prif_deallocate_coarray and type changes in PRIF 0.7

Author: bonachea

.github/workflows/build.yml

@@ -8,7 +8,7 @@ defaults:
 
 jobs:
   build:
-    name: ${{ matrix.compiler }}-${{ matrix.version }} ${{ matrix.network }} (${{ matrix.os }})
+    name: ${{ matrix.compiler }}-${{ matrix.version }} ${{ matrix.network }} (${{ matrix.os }}) ${{ matrix.label }}
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
@@ -61,11 +61,21 @@ jobs:
             FFLAGS: -mmlir -allow-assumed-rank
             # https://hub.docker.com/r/phhargrove/llvm-flang/tags
             container: phhargrove/llvm-flang:19.1.1-latest
-#          - os: ubuntu-24.04
-#            compiler: flang
-#            version: new
-#            network: smp
-#            container: gmao/llvm-flang:latest
+        # --- PRIF-old coverage ---
+          - os: ubuntu-24.04
+            compiler: flang
+            version: 21
+            network: smp
+            label: PRIF-0.5
+            FFLAGS: -DFORCE_PRIF_0_5
+            container: phhargrove/llvm-flang:21.1.0-latest
+          - os: ubuntu-24.04
+            compiler: flang
+            version: 21
+            network: smp
+            label: PRIF-0.6
+            FFLAGS: -DFORCE_PRIF_0_6
+            container: phhargrove/llvm-flang:21.1.0-latest
         # --- udp coverage for selected configs ---
           - os: macos-15
             compiler: gfortran

docs/implementation-status.md

@@ -70,6 +70,7 @@ are accepted, but in some cases, the associated runtime behavior is not fully im
 | `prif_allocate_coarray`    | **YES** |  |
 | `prif_allocate`            | **YES** |  |
 | `prif_deallocate_coarray`  | *partial* | no `final_func` arg support |
+| `prif_deallocate_coarrays` | *partial* | no `final_func` arg support |
 | `prif_deallocate`          | **YES** |  |
 | `prif_alias_create`        | **YES** | includes `data_pointer_offset` argument added in PRIF 0.6 |
 | `prif_alias_destroy`       | **YES** |  |

src/caffeine/allocation_s.F90

@@ -72,7 +72,14 @@
     allocated_memory = caf_allocate(non_symmetric_heap_mspace, size_in_bytes)
   end procedure
 
+#if FORCE_PRIF_0_5 || FORCE_PRIF_0_6
   module procedure prif_deallocate_coarray
+#else
+  module procedure prif_deallocate_coarray
+    call prif_deallocate_coarrays([coarray_handle], stat, errmsg, errmsg_alloc)
+  end procedure
+  module procedure prif_deallocate_coarrays
+#endif
     ! gfortran is yelling that this isn't valid for bind(C)
     ! https://gcc.gnu.org/bugzilla/show_bug.cgi?id=113338
     ! abstract interface

src/caffeine/prif_private_s.F90

@@ -23,7 +23,7 @@
 
   implicit none
 
-  type(team_data), target :: initial_team
+  type(prif_team_descriptor), target :: initial_team
   type(prif_team_type) :: current_team
   type(c_ptr) :: non_symmetric_heap_mspace
 

src/caffeine/teams_s.F90

@@ -43,7 +43,12 @@
         teams_coarrays(i)%info => tmp_data
         call c_f_pointer(tmp_data%next_handle, tmp_data)
       end do
-      call prif_deallocate_coarray(teams_coarrays, stat, errmsg, errmsg_alloc)
+#if FORCE_PRIF_0_5 || FORCE_PRIF_0_6
+      call prif_deallocate_coarray &
+#else
+      call prif_deallocate_coarrays &
+#endif
+                (teams_coarrays, stat, errmsg, errmsg_alloc)
       nullify(current_team%info%coarrays)
     else
       ! child team sync required by F23 11.1.5.2,

src/prif.F90

@@ -28,7 +28,12 @@ module prif
   public :: prif_init
   public :: prif_register_stop_callback, prif_stop_callback_interface
   public :: prif_stop, prif_error_stop, prif_fail_image
-  public :: prif_allocate_coarray, prif_allocate, prif_deallocate_coarray, prif_deallocate
+  public :: prif_allocate_coarray, prif_allocate, prif_deallocate
+#if FORCE_PRIF_0_5 || FORCE_PRIF_0_6
+  public :: prif_deallocate_coarray
+#else
+  public :: prif_deallocate_coarray, prif_deallocate_coarrays
+#endif
   public :: prif_put, prif_put_indirect, prif_get, prif_get_indirect, prif_put_with_notify, prif_put_with_notify_indirect
   public :: prif_put_indirect_with_notify, prif_put_indirect_with_notify_indirect
   public :: prif_get_strided, prif_get_strided_indirect, prif_put_strided, prif_put_strided_indirect
@@ -139,7 +144,7 @@ module prif
 
   type, public :: prif_team_type
     private
-    type(team_data), pointer :: info => null()
+    type(prif_team_descriptor), pointer :: info => null()
   end type
 
   abstract interface
@@ -214,13 +219,30 @@ module subroutine prif_allocate(size_in_bytes, allocated_memory, stat, errmsg, e
       character(len=:), intent(inout), allocatable, optional :: errmsg_alloc
     end subroutine
 
+#if FORCE_PRIF_0_5 || FORCE_PRIF_0_6
     module subroutine prif_deallocate_coarray(coarray_handles, stat, errmsg, errmsg_alloc)
       implicit none
       type(prif_coarray_handle), intent(in) :: coarray_handles(:)
       integer(c_int), intent(out), optional :: stat
       character(len=*), intent(inout), optional :: errmsg
       character(len=:), intent(inout), allocatable, optional :: errmsg_alloc
     end subroutine
+#else
+    module subroutine prif_deallocate_coarray(coarray_handle, stat, errmsg, errmsg_alloc)
+      implicit none
+      type(prif_coarray_handle), intent(in) :: coarray_handle
+      integer(c_int), intent(out), optional :: stat
+      character(len=*), intent(inout), optional :: errmsg
+      character(len=:), intent(inout), allocatable, optional :: errmsg_alloc
+    end subroutine
+    module subroutine prif_deallocate_coarrays(coarray_handles, stat, errmsg, errmsg_alloc)
+      implicit none
+      type(prif_coarray_handle), intent(in) :: coarray_handles(:)
+      integer(c_int), intent(out), optional :: stat
+      character(len=*), intent(inout), optional :: errmsg
+      character(len=:), intent(inout), allocatable, optional :: errmsg_alloc
+    end subroutine
+#endif
 
     module subroutine prif_deallocate(mem, stat, errmsg, errmsg_alloc)
       implicit none
@@ -1155,14 +1177,14 @@ module subroutine prif_atomic_ref_logical_indirect(image_num, atom_remote_ptr, v
     type(c_ptr) :: reserved
   end type
 
-  type, private :: team_data
+  type, private :: prif_team_descriptor
     type(c_ptr) :: gex_team
     type(c_ptr) :: heap_mspace
     integer(c_intptr_t) :: heap_start
     integer(c_size_t) :: heap_size
     integer(c_int64_t) :: team_number
     integer(c_int) :: this_image, num_images
-    type(team_data), pointer :: parent_team => null()
+    type(prif_team_descriptor), pointer :: parent_team => null()
     type(prif_coarray_descriptor), pointer :: coarrays => null()
     type(child_team_info), pointer :: child_heap_info => null()
   end type

test/main.F90

@@ -26,6 +26,7 @@ function run() result(passed)
         use caf_image_index_test, only: &
                 caf_image_index_prif_image_index => &
                     test_prif_image_index
+        use prif_types_test, only: test_prif_types
         use caf_rma_test, only: &
                 caf_rma_prif_rma => &
                     test_prif_rma
@@ -73,6 +74,7 @@ function run() result(passed)
     end block
 #endif
         individual_tests = [a00_caffeinate_caffeinate()]
+        individual_tests = [individual_tests, test_prif_types()]
         individual_tests = [individual_tests, caf_allocate_prif_allocate()]
         individual_tests = [individual_tests, caf_image_index_prif_image_index()]
         individual_tests = [individual_tests, caf_rma_prif_rma()]

test/prif_allocate_test.F90

@@ -1,10 +1,17 @@
 module caf_allocate_test
   use prif, only : &
-      prif_allocate_coarray, prif_deallocate_coarray, &
+      prif_allocate_coarray, &
       prif_allocate, prif_deallocate, &
       prif_coarray_handle, prif_num_images, prif_size_bytes, &
       prif_set_context_data, prif_get_context_data, prif_local_data_pointer, &
       prif_alias_create, prif_alias_destroy
+#if FORCE_PRIF_0_5 || FORCE_PRIF_0_6
+  use prif, only : prif_deallocate_coarray_ => prif_deallocate_coarray
+# define prif_deallocate_coarray(h)    prif_deallocate_coarray_([h])
+# define prif_deallocate_coarrays(arr) prif_deallocate_coarray_(arr)
+#else
+  use prif, only : prif_deallocate_coarray, prif_deallocate_coarrays
+#endif
   use veggies, only: result_t, test_item_t, assert_that, assert_equals, describe, it, succeed
   use iso_c_binding, only: &
       c_ptr, c_int, c_int64_t, c_size_t, c_funptr, c_null_funptr, &
@@ -78,7 +85,7 @@ function check_allocate_integer_scalar_coarray_with_corank1() result(result_)
       end do
     end block
 
-    call prif_deallocate_coarray([coarray_handle])
+    call prif_deallocate_coarray(coarray_handle)
 
   end function
 
@@ -258,7 +265,7 @@ function check_allocate_integer_array_coarray_with_corank2() result(result_)
       end do
     end block
 
-    call prif_deallocate_coarray([coarray_handle])
+    call prif_deallocate_coarray(coarray_handle)
 
   end function
 end module caf_allocate_test

test/prif_atomic_test.F90

@@ -6,6 +6,11 @@ module caf_atomic_test
             c_ptr, c_int64_t, c_intptr_t, c_size_t, c_null_funptr, c_f_pointer, c_loc, c_sizeof
     use veggies, only: result_t, test_item_t, assert_equals, assert_that, describe, it, succeed
     use prif
+#if FORCE_PRIF_0_5 || FORCE_PRIF_0_6
+  use prif, only : prif_deallocate_coarray_ => prif_deallocate_coarray
+# define prif_deallocate_coarray(h)    prif_deallocate_coarray_([h])
+# define prif_deallocate_coarrays(arr) prif_deallocate_coarray_(arr)
+#endif
 
     implicit none
     private
@@ -325,8 +330,7 @@ function check_atomic_uncontended() result(result_)
 
         end block
 
-        call prif_deallocate_coarray([coarray_handle_int])
-        call prif_deallocate_coarray([coarray_handle_logical])
+        call prif_deallocate_coarrays(([coarray_handle_int,coarray_handle_logical]))
     end function
 
     function check_atomic_contended() result(result_)

test/prif_coarray_inquiry_test.F90

@@ -6,6 +6,13 @@ module prif_coarray_inquiry_test_m
       prif_lcobound_no_dim, prif_lcobound_with_dim, &
       prif_ucobound_no_dim, prif_ucobound_with_dim, &
       prif_coshape
+#if FORCE_PRIF_0_5 || FORCE_PRIF_0_6
+  use prif, only : prif_deallocate_coarray_ => prif_deallocate_coarray
+# define prif_deallocate_coarray(h)    prif_deallocate_coarray_([h])
+# define prif_deallocate_coarrays(arr) prif_deallocate_coarray_(arr)
+#else
+  use prif, only : prif_deallocate_coarray, prif_deallocate_coarrays
+#endif
   use julienne_m, only: &
      operator(//) &
     ,operator(.all.) &
@@ -68,7 +75,7 @@ function check_prif_local_data_pointer() result(diag)
               allocation_ptr)
       call prif_local_data_pointer(coarray_handle, local_ptr)
       diag = .expect. c_associated(local_ptr, allocation_ptr)
-      call prif_deallocate_coarray([coarray_handle])
+      call prif_deallocate_coarray(coarray_handle)
   end function
 
   impure elemental function check_cobound(corank) result(diag)
@@ -132,7 +139,7 @@ impure elemental function check_cobound(corank) result(diag)
     diag = diag .also. &
       (.all. ((ucobounds - lcobounds + 1) .equalsExpected. sizes)) // "prif_coshape is valid"
 
-    call prif_deallocate_coarray([coarray_handle])
+    call prif_deallocate_coarray(coarray_handle)
   end function
 
   function check_cobounds() result(diag)