[flang] Add `stopped_images` to list of intrinsics and add test

[ktras]

Summary

Add stopped_images to the list of intrinsic functions. Add a semantics test for stopped_images.

[ngeorge1098]

This comment was removed by ngeorge1098.

[ngeorge1098]

I would add error directives for repeated keywords in the semantics test.

stopped = stopped_images(team=home, team=league(1))

stopped = stopped_images(kind=c_int32_t, kind=c_int64_t)

[ktras]

Add additional non-conforming statements to the stopped_images test.

[ngeorge1098]

This comment was removed by ngeorge1098.

[ngeorge1098]

The semantics test looks good to me.

[ktras]

Thanks @ngeorge1098 for reviewing the test.

Could one of the reviewers (@klausler, @jeanPerier, @PeteSteinfeld, @craig.rasmussen) who has experience with flang/lib/Evaluate/intrinsics.cpp review my edits to add stopped_images to the list of intrinsic functions?

[ktras]

Thanks for the review @klausler.

flang/docs/Intrinsics.md

 
 ### Semantic Analysis
 F18 semantic expression analysis phase detects intrinsic procedure references,
 validates the argument types and deduces the return types.
 This phase currently supports all the intrinsic procedures listed above but the ones in the table below.
 
 | Intrinsic Category | Intrinsic Procedures Lacking Support |
 | --- | --- |
-| Coarray intrinsic functions | LCOBOUND, UCOBOUND, IMAGE_INDEX, STOPPED_IMAGES, COSHAPE |
+| Coarray intrinsic functions | LCOBOUND, UCOBOUND, IMAGE_INDEX, COSHAPE |
 | Object characteristic inquiry functions | ALLOCATED, ASSOCIATED, EXTENDS_TYPE_OF, IS_CONTIGUOUS, PRESENT, RANK, SAME_TYPE, STORAGE_SIZE |
 | Type inquiry intrinsic functions | BIT_SIZE, DIGITS, EPSILON, HUGE, KIND, MAXEXPONENT, MINEXPONENT, NEW_LINE, PRECISION, RADIX, RANGE, TINY|
 | Non-standard intrinsic functions | AND, OR, XOR, LSHIFT, RSHIFT, SHIFT, ZEXT, IZEXT, COSD, SIND, TAND, ACOSD, ASIND, ATAND, ATAN2D, COMPL, DCMPLX, EQV, NEQV, INT8, JINT, JNINT, KNINT, LOC, QCMPLX, DREAL, DFLOAT, QEXT, QFLOAT, QREAL, DNUM, NUM, JNUM, KNUM, QNUM, RNUM, RAN, RANF, ILEN, SIZEOF, MCLOCK, SECNDS, COTAN, IBCHNG, ISHA, ISHC, ISHL, IXOR, IARG, IARGC, NARGS, NUMARG, BADDRESS, IADDR, CACHESIZE, EOF, FP_CLASS, INT_PTR_KIND, ISNAN, MALLOC |
 | Intrinsic subroutines |MVBITS (elemental), CPU_TIME, DATE_AND_TIME, EVENT_QUERY, EXECUTE_COMMAND_LINE, GET_COMMAND, GET_COMMAND_ARGUMENT, GET_ENVIRONMENT_VARIABLE, MOVE_ALLOC, RANDOM_INIT, RANDOM_NUMBER, RANDOM_SEED, SYSTEM_CLOCK |
 | Atomic intrinsic subroutines | ATOMIC_ADD &al. |
 | Collective intrinsic subroutines | CO_BROADCAST &al. |
 
 

flang/lib/Evaluate/intrinsics.cpp

static const IntrinsicInterface genericIntrinsicFunction[]{
     {"sizeof", {{"a", AnyData, Rank::anyOrAssumedRank}}, SubscriptInt,
         Rank::scalar, IntrinsicClass::inquiryFunction},
     {"spacing", {{"x", SameReal}}, SameReal},
     {"spread",
         {{"source", SameType, Rank::known}, RequiredDIM,
             {"ncopies", AnyInt, Rank::scalar}},
         SameType, Rank::rankPlus1, IntrinsicClass::transformationalFunction},
     {"sqrt", {{"x", SameFloating}}, SameFloating},
+    {"stopped_images", {OptionalTEAM, SizeDefaultKIND}, KINDInt, Rank::vector,
+        IntrinsicClass::transformationalFunction},
     {"storage_size", {{"a", AnyData, Rank::anyOrAssumedRank}, SizeDefaultKIND},
         KINDInt, Rank::scalar, IntrinsicClass::inquiryFunction},
     {"sum", {{"array", SameNumeric, Rank::array}, RequiredDIM, OptionalMASK},
         SameNumeric, Rank::dimReduced,
         IntrinsicClass::transformationalFunction},
     {"sum", {{"array", SameNumeric, Rank::array}, MissingDIM, OptionalMASK},
         SameNumeric, Rank::scalar, IntrinsicClass::transformationalFunction},
     {"tan", {{"x", SameFloating}}, SameFloating},
// NULL() is a special case handled in Probe() below
         {{"x", AnyReal, Rank::elemental, Optionality::optional}},
         DefaultLogical},
     {"__builtin_ieee_support_underflow_control",
         {{"x", AnyReal, Rank::elemental, Optionality::optional}},
         DefaultLogical},
 };
 
 // TODO: Coarray intrinsic functions
-//   LCOBOUND, UCOBOUND, IMAGE_INDEX,
-//   STOPPED_IMAGES, COSHAPE
+//   LCOBOUND, UCOBOUND, IMAGE_INDEX, COSHAPE
 // TODO: Non-standard intrinsic functions
 //  LSHIFT, RSHIFT, SHIFT, ZEXT, IZEXT,
 //  COMPL, EQV, NEQV, INT8, JINT, JNINT, KNINT,
 //  QCMPLX, QEXT, QFLOAT, QREAL, DNUM,
 //  INUM, JNUM, KNUM, QNUM, RNUM, RAN, RANF, ILEN,
 //  MCLOCK, SECNDS, COTAN, IBCHNG, ISHA, ISHC, ISHL, IXOR
 //  IARG, IARGC, NARGS, NUMARG, BADDRESS, IADDR, CACHESIZE,
 //  EOF, FP_CLASS, INT_PTR_KIND, MALLOC

flang/test/Semantics/stopped_images.f90

+! RUN: %python %S/test_errors.py %s %flang_fc1
+! Check for semantic errors in stopped_images() function calls
+! as defined in 16.9.183 in the Fortran 2018 standard
+
+program stopped_images_test
+  use iso_fortran_env, only: team_type
+  use iso_c_binding, only: c_int32_t, c_int64_t
+  implicit none
+
+  type(team_type) home, league(2)
+  integer n, i, array(1), non_constant
+  integer, allocatable :: stopped(:)
+  integer, allocatable :: wrong_rank(:,:)
+  logical non_integer, non_team
+  character, allocatable :: wrong_result(:)
+
+  !___ standard-conforming statement with no optional arguments present ___
+  stopped = stopped_images()
+
+  !___ standard-conforming statements with optional team argument present ___
+  stopped = stopped_images(home)
+  stopped = stopped_images(team=home)
+  stopped = stopped_images(league(1))
+
+  !___ standard-conforming statements with optional kind argument present ___
+  stopped = stopped_images(kind=c_int32_t)
+
+  !___ standard-conforming statements with both optional arguments present ___
+  stopped = stopped_images(home, c_int32_t)
+  stopped = stopped_images(team=home, kind=c_int32_t)
+  stopped = stopped_images(kind=c_int32_t, team=home)
+
+  !___ non-conforming statements ___
+
+  !ERROR: Actual argument for 'team=' has bad type 'LOGICAL(4)'
+  stopped = stopped_images(non_team)
+
+  !ERROR: 'team=' argument has unacceptable rank 1
+  stopped = stopped_images(league)
+
+  !ERROR: Actual argument for 'team=' has bad type 'INTEGER(4)'
+  stopped = stopped_images(team=-1)
+
+  !ERROR: Actual argument for 'team=' has bad type 'INTEGER(4)'
+  stopped = stopped_images(team=i, kind=c_int32_t)
+
+  !ERROR: Actual argument for 'team=' has bad type 'INTEGER(4)'
+  stopped = stopped_images(i, c_int32_t)
+
+  !ERROR: Actual argument for 'team=' has bad type 'INTEGER(4)'
+  stopped = stopped_images(c_int32_t)
+
+  !ERROR: repeated keyword argument to intrinsic 'stopped_images'
+  stopped = stopped_images(team=home, team=league(1))
+
+  !ERROR: 'kind=' argument must be a constant scalar integer whose value is a supported kind for the intrinsic result type
+  stopped = stopped_images(kind=non_constant)
+
+  !ERROR: Actual argument for 'kind=' has bad type 'LOGICAL(4)'
+  stopped = stopped_images(home, non_integer)
+
+  !ERROR: Actual argument for 'kind=' has bad type 'LOGICAL(4)'
+  stopped = stopped_images(kind=non_integer)
+
+  !ERROR: 'kind=' argument has unacceptable rank 1
+  stopped = stopped_images(kind=array)
+
+  !ERROR: repeated keyword argument to intrinsic 'stopped_images'
+  stopped = stopped_images(kind=c_int32_t, kind=c_int64_t)
+
+  !ERROR: too many actual arguments for intrinsic 'stopped_images'
+  stopped = stopped_images(home, c_int32_t, 3)
+
+  !ERROR: Actual argument for 'team=' has bad type 'REAL(4)'
+  stopped = stopped_images(3.4)
+
+  !ERROR: unknown keyword argument to intrinsic 'stopped_images'
+  stopped = stopped_images(kinds=c_int32_t)
+
+  !ERROR: unknown keyword argument to intrinsic 'stopped_images'
+  stopped = stopped_images(home, kinds=c_int32_t)
+
+  !ERROR: unknown keyword argument to intrinsic 'stopped_images'
+  stopped = stopped_images(my_team=home)
+
+  !ERROR: No intrinsic or user-defined ASSIGNMENT(=) matches scalar INTEGER(4) and rank 1 array of INTEGER(4)
+  n = stopped_images()
+
+  !ERROR: No intrinsic or user-defined ASSIGNMENT(=) matches rank 2 array of INTEGER(4) and rank 1 array of INTEGER(4)
+  wrong_rank = stopped_images()
+
+  !ERROR: No intrinsic or user-defined ASSIGNMENT(=) matches operand types CHARACTER(KIND=1) and INTEGER(4)
+  wrong_result = stopped_images()
+
+end program stopped_images_test