[flang] Add failed_images to list of intrinsics and add test

[ktras]

Summary

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

[jeanPerier]

LGTM, thanks

[ktras]

@jeanPerier Thank you for the review. I have two differentials now that have been approved and are ready to land but I do not have push permissions. Would it be appropriate for me to apply for push permissions at this point? Or is there someone who can help push my changes to main?

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, FAILED_IMAGES, IMAGE_INDEX, STOPPED_IMAGES, COSHAPE |
+| Coarray intrinsic functions | LCOBOUND, UCOBOUND, IMAGE_INDEX, STOPPED_IMAGES, 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[]{
     {"exp", {{"x", SameFloating}}, SameFloating},
     {"exp", {{"x", SameFloating}}, SameFloating},
     {"exponent", {{"x", AnyReal}}, DefaultInt},
     {"exp", {{"x", SameFloating}}, SameFloating},
     {"extends_type_of",
         {{"a", ExtensibleDerived, Rank::anyOrAssumedRank},
             {"mold", ExtensibleDerived, Rank::anyOrAssumedRank}},
         DefaultLogical, Rank::scalar, IntrinsicClass::inquiryFunction},
+    {"failed_images", {OptionalTEAM, SizeDefaultKIND}, KINDInt, Rank::vector,
+        IntrinsicClass::transformationalFunction},
     {"findloc",
         {{"array", AnyNumeric, Rank::array},
             {"value", AnyNumeric, Rank::scalar}, RequiredDIM, OptionalMASK,
             SizeDefaultKIND,
             {"back", AnyLogical, Rank::scalar, Optionality::optional}},
         KINDInt, Rank::locReduced, IntrinsicClass::transformationalFunction},
     {"findloc",
         {{"array", AnyNumeric, Rank::array},
// 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, FAILED_IMAGES, IMAGE_INDEX,
+//   LCOBOUND, UCOBOUND, IMAGE_INDEX,
 //   STOPPED_IMAGES, 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,

flang/test/Semantics/failed_images.f90

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