Expand coverage of this_image semantics testing

[rouson]

Summary

Add a test with a range of this_image() intrinsic function
invocations, including a comprehensive set of standard-conforming
keyword and non-keyword arguments with and without optional
arguments present and with argument positions covering all
possible orderings. Also test that several non-conforming
this_image() invocations generate the correct error messages.

[ktras]

I have only one small suggestion, please see the suggested code edit.

flang/test/Semantics/this_image02.f90

84

Since team is an optional argument, I would recommend using the keyword argument here to explicitly test whether the team argument is being restricted to a scalar of team_type or not.

[ktras]

flang/test/Semantics/this_image02.f90

31

The implementation of this_image does not currently support this call, so please add the following error message before it.
!ERROR: missing mandatory 'dim=' argument

[klausler]

flang/test/Semantics/this_image02.f90

31

Don't change tests to match buggy behavior.

[ktras]

flang/test/Semantics/this_image02.f90

31

I believe that @rouson is working on contributing tests for parallel features but is not currently looking at editing source. It seems to me in this situation there are three options:

1. Do not add an error for this line of code and add an XFAIL directive
2. Do not add an error and do not add XFAIL directive and push a failing test
3. Add the error and when the support is added, the error is removed in the same patch

Based on looking at other tests in the past that had error directives that would go away once certain features were supported, I thought this case was similar and thought the last option was best.

@klausler Since your comment seems to say this is not the best approach, which is the best option for this test and what matches the workflow of the developers?

[klausler]

flang/test/Semantics/this_image02.f90

31

Probably the first option, if the bug can't be fixed. But fixing the bug would be best.

[ktras]

flang/test/Semantics/this_image02.f90

31

@klausler Thanks for your feedback.

[rouson]

Add XFAIL directive and responding to one review comment by adding a keyword argument.

[ktras]

The test is looking great, but I have recognized a couple more changes I would suggest. Please see the inline comments. I would also recommend adding a non-standard conforming call where a constant, either a named constant or a literal constant, is being passed to the dim argument and where its value is out of bounds of the corank of the coarray argument.

flang/test/Semantics/this_image02.f90

25

When the coarray argument is present, but the dim argument is not present, the result will be an array of rank one, so this could be moved to the non-standard conforming section of the test and it could be replaced with a call where the result is assigned to an array.

26

Similar to the comments on the line above, to keep this in the standards conforming section of your test, please replace the variable that the result of the call is being assigned to with an array.

[ktras]

Please see my comment above.

[rouson]

This update fixes the standard-conforming this_image() invocations in which the optional dim argument is not present.

[ktras]

LGTM

flang/test/Semantics/this_image02.f90

+! RUN: %python %S/test_errors.py %s %flang_fc1
+! XFAIL: *
+! Check for semantic errors in this_image() function calls
+
+program this_image_tests
+  use iso_fortran_env, only : team_type
+  implicit none
+
+  !ERROR: Coarray 'team_coarray' may not have type TEAM_TYPE, C_PTR, or C_FUNPTR
+  type(team_type) team_coarray[*]
+  type(team_type) home, league(2)
+  integer n, i, array(1), non_coarray(1), co_array[*]
+  integer, allocatable :: images(:)
+  logical non_integer
+
+  !___ standard-conforming statement with no optional arguments present ___
+  n = this_image()
+
+  !___ standard-conforming statements with team argument present ___
+  n = this_image(home)
+  n = this_image(team=home)
+  n = this_image(league(1))
+
+  !___ standard-conforming statements with coarray argument present ___
+  images = this_image(co_array)
+  images = this_image(coarray=co_array)
+
+  !___ standard-conforming statements with coarray and team arguments present ___
+  images = this_image(co_array, home)
+  images = this_image(co_array, team=home)
+  images = this_image(team_coarray, team=home)
+  images = this_image(team_coarray[1], team=home)
+  images = this_image(coarray=co_array, team=home)
+  images = this_image(team=home, coarray=co_array)
+
+  !___ standard-conforming statements with coarray and dim arguments present ___
+  n = this_image(co_array, i)
+  n = this_image(co_array, dim=i)
+  n = this_image(coarray=co_array, dim=i)
+  n = this_image(dim=i, coarray=co_array)
+
+  !___ standard-conforming statements with all arguments present ___
+  n = this_image(co_array, i, home)
+  n = this_image(co_array, i, team=home)
+  n = this_image(co_array, dim=i, team=home)
+  n = this_image(co_array, team=home, dim=i)
+
+  n = this_image(coarray=co_array, dim=i, team=home)
+  n = this_image(coarray=co_array, team=home, dim=i)
+
+  n = this_image(dim=i, coarray=co_array, team=home)
+  n = this_image(dim=i, team=home, coarray=co_array)
+
+  n = this_image(team=home, dim=i, coarray=co_array)
+  n = this_image(team=home, coarray=co_array, dim=i)
+
+  !___ non-conforming statements ___
+
+  !ERROR: TBD
+  n = this_image(co_array)
+
+  !ERROR: missing mandatory 'dim=' argument
+  n = this_image(i)
+
+  !ERROR: missing mandatory 'coarray=' argument
+  n = this_image(dim=i)
+
+  !ERROR: Actual argument for 'dim=' has bad type 'team_type'
+  n = this_image(i, home)
+
+  !ERROR: missing mandatory 'dim=' argument
+  n = this_image(i, team=home)
+
+  !ERROR: TBD
+  n = this_image(coarray=co_array, dim=2)
+
+  !ERROR: missing mandatory 'coarray=' argument
+  n = this_image(dim=i, team=home)
+
+  !ERROR: missing mandatory 'coarray=' argument
+  n = this_image(team=home, dim=i)
+
+  ! Doesn't produce an error
+  n = this_image(coarray=co_array, i)
+
+  !ERROR: No explicit type declared for 'team'
+  images = this_image(coarray=co_array, team)
+
+  ! non-scalar team_type argument 
+  !ERROR: missing mandatory 'coarray=' argument
+  n = this_image(team=league)
+
+  ! incorrectly typed argument
+  !ERROR: missing mandatory 'dim=' argument
+  n = this_image(3.4)
+
+  !ERROR: too many actual arguments for intrinsic 'this_image'
+  n = this_image(co_array, i, home, 0)
+
+  ! keyword argument with incorrect type
+  !ERROR: missing mandatory 'dim=' argument
+  images = this_image(coarray=non_coarray)
+
+  ! incorrect keyword argument name but valid type (type number)
+  !ERROR: unknown keyword argument to intrinsic 'this_image'
+  images = this_image(co_array=co_array)
+
+  ! incorrect keyword argument name but valid type (team_type)
+  !ERROR: unknown keyword argument to intrinsic 'this_image'
+  n = this_image(my_team=home)
+
+  ! correct keyword argument name but mismatched type
+  !ERROR: Actual argument for 'team=' has bad type 'INTEGER(4)'
+  n = this_image(co_array, i, team=-1)
+
+  !ERROR: 'dim=' argument has unacceptable rank 1
+  n = this_image(co_array, array )
+
+  !ERROR: unknown keyword argument to intrinsic 'this_image'
+  n = this_image(co_array, dims=i)
+
+  !ERROR: Actual argument for 'dim=' has bad type 'LOGICAL(4)'
+  n = this_image(co_array, non_integer)
+
+  ! A this_image reference with a coarray argument of team type shall also have a team argument
+  ! Doesn't produce an error
+  images = this_image(team_coarray)
+end program this_image_tests