[flang] lower all intrinsic to hlfir.all operation

[jacob-crawley]

Summary

Carries out the lowering of the all intrinsic into HLFIR

[tblah]

flang/lib/Lower/ConvertCall.cpp

1447

This is very similar to buildNumericalReductionIntrinsic. You could combine these into one by passing a boolean to control whether there is a separate mask value or not.

The only tricky bit here would be the different number of arguments to the buildFunc. It is a bit messy, but I think the easiest would be to have an extra unused mlir::Value argument to the build functions for the logical reductions and initialize it with nullptr when it is unused.

[jacob-crawley]

Thanks for the review.

Combined the logic of buildNumericalReductionIntrinsic and
buildLogicalReductionIntrinsic into a single function.

[tblah]

Thanks!

[jeanPerier]

Thanks, LGTM

flang/lib/Lower/ConvertCall.cpp

genHLFIRIntrinsicRefCore(PreparedActualArguments &loweredActuals,
 
   auto buildProductOperation = [](fir::FirOpBuilder &builder,
                                   mlir::Location loc, mlir::Type resultTy,
                                   mlir::Value array, mlir::Value dim,
                                   mlir::Value mask) {
     return builder.create<hlfir::ProductOp>(loc, resultTy, array, dim, mask);
   };
 
+  auto buildAnyOperation = [](fir::FirOpBuilder &builder, mlir::Location loc,
+                              mlir::Type resultTy, mlir::Value array,
+                              mlir::Value dim, mlir::Value mask) {
+    return builder.create<hlfir::AnyOp>(loc, resultTy, array, dim);
+  };
+
+  auto buildAllOperation = [](fir::FirOpBuilder &builder, mlir::Location loc,
+                              mlir::Type resultTy, mlir::Value array,
+                              mlir::Value dim, mlir::Value mask) {
+    return builder.create<hlfir::AllOp>(loc, resultTy, array, dim);
+  };
+
   auto buildReductionIntrinsic =
       [&](PreparedActualArguments &loweredActuals, mlir::Location loc,
           fir::FirOpBuilder &builder, CallContext &callContext,
           std::function<mlir::Operation *(fir::FirOpBuilder &, mlir::Location,
                                           mlir::Type, mlir::Value, mlir::Value,
                                           mlir::Value)>
-              buildFunc) -> std::optional<hlfir::EntityWithAttributes> {
+              buildFunc,
+          bool hasMask) -> std::optional<hlfir::EntityWithAttributes> {
     // shared logic for building the product and sum operations
     llvm::SmallVector<mlir::Value> operands = getOperandVector(loweredActuals);
-    assert(operands.size() == 3);
     // dim, mask can be NULL if these arguments were not given
     mlir::Value array = operands[0];
     mlir::Value dim = operands[1];
     if (dim)
       dim = hlfir::loadTrivialScalar(loc, builder, hlfir::Entity{dim});
-    mlir::Value mask = operands[2];
+
+    mlir::Value mask;
+    if (hasMask)
+      mask = operands[2];
+
     mlir::Type resultTy = computeResultType(array, *callContext.resultType);
     auto *intrinsicOp = buildFunc(builder, loc, resultTy, array, dim, mask);
     return {hlfir::EntityWithAttributes{intrinsicOp->getResult(0)}};
   };
 
   const std::string intrinsicName = callContext.getProcedureName();
   if (intrinsicName == "sum") {
     return buildReductionIntrinsic(loweredActuals, loc, builder, callContext,
-                                   buildSumOperation);
+                                   buildSumOperation, true);
   }
   if (intrinsicName == "product") {
     return buildReductionIntrinsic(loweredActuals, loc, builder, callContext,
-                                   buildProductOperation);
+                                   buildProductOperation, true);
   }
   if (intrinsicName == "matmul") {
     llvm::SmallVector<mlir::Value> operands = getOperandVector(loweredActuals);
     mlir::Type resultTy =
         computeResultType(operands[0], *callContext.resultType);
     hlfir::MatmulOp matmulOp = builder.create<hlfir::MatmulOp>(
         loc, resultTy, operands[0], operands[1]);
 
if (intrinsicName == "transpose") {
     mlir::Type resultTy = hlfir::ExprType::get(
         builder.getContext(), resultShape, elementType, /*polymorphic=*/false);
     hlfir::TransposeOp transposeOp =
         builder.create<hlfir::TransposeOp>(loc, resultTy, operands[0]);
 
     return {hlfir::EntityWithAttributes{transposeOp.getResult()}};
   }
   if (intrinsicName == "any") {
-    llvm::SmallVector<mlir::Value> operands = getOperandVector(loweredActuals);
-    assert(operands.size() == 2);
-    // dim argument can be NULL if not given
-    mlir::Value mask = operands[0];
-    mlir::Value dim = operands[1];
-    if (dim)
-      dim = hlfir::loadTrivialScalar(loc, builder, hlfir::Entity{dim});
-    mlir::Type resultTy = computeResultType(mask, *callContext.resultType);
-    hlfir::AnyOp anyOp = builder.create<hlfir::AnyOp>(loc, resultTy, mask, dim);
-
-    return {hlfir::EntityWithAttributes{anyOp.getResult()}};
+    return buildReductionIntrinsic(loweredActuals, loc, builder, callContext,
+                                   buildAnyOperation, false);
+  }
+  if (intrinsicName == "all") {
+    return buildReductionIntrinsic(loweredActuals, loc, builder, callContext,
+                                   buildAllOperation, false);
   }
 
   // TODO add hlfir operations for other transformational intrinsics here
 
   // fallback to calling the intrinsic via fir.call
   return genIntrinsicRefCore(loweredActuals, intrinsic, argLowering,
                              callContext);
 }

flang/test/Lower/HLFIR/all.f90

+! Test lowering of ALL intrinsic to HLFIR
+! RUN: bbc -emit-fir -hlfir -o - %s 2>&1 | FileCheck %s
+
+! simple 1 argument ALL
+subroutine all1(a, s)
+  logical :: a(:), s
+  s = ALL(a)
+end subroutine
+! CHECK-LABEL: func.func @_QPall1(
+! CHECK:           %[[ARG0:.*]]: !fir.box<!fir.array<?x!fir.logical<4>>>
+! CHECK:           %[[ARG1:.*]]: !fir.ref<!fir.logical<4>>
+! CHECK-DAG:     %[[MASK:.*]]:2 = hlfir.declare %[[ARG0]]
+! CHECK-DAG:     %[[OUT:.*]]:2 = hlfir.declare %[[ARG1]]
+! CHECK-NEXT:    %[[EXPR:.*]] = hlfir.all %[[MASK]]#0 : (!fir.box<!fir.array<?x!fir.logical<4>>>) -> !fir.logical<4>
+! CHECK-NEXT:    hlfir.assign %[[EXPR]] to %[[OUT]]#0  : !fir.logical<4>, !fir.ref<!fir.logical<4>>
+! CHECK-NEXT:    return
+! CHECK-NEXT:  }
+
+! all with by-ref DIM argument
+subroutine all2(a, s, d)
+  logical :: a(:,:), s(:)
+  integer :: d
+s = ALL(a, d)
+end subroutine
+! CHECK-LABEL: func.func @_QPall2(
+! CHECK:           %[[ARG0:.*]]: !fir.box<!fir.array<?x?x!fir.logical<4>>> {fir.bindc_name = "a"}
+! CHECK:           %[[ARG1:.*]]: !fir.box<!fir.array<?x!fir.logical<4>>> {fir.bindc_name = "s"}
+! CHECK:           %[[ARG2:.*]]: !fir.ref<i32> {fir.bindc_name = "d"}
+! CHECK-DAG:     %[[MASK:.*]]:2 = hlfir.declare %[[ARG0]]
+! CHECK-DAG:     %[[DIM_REF:.*]]:2 = hlfir.declare %[[ARG2]]
+! CHECK-DAG:     %[[OUT:.*]]:2 = hlfir.declare %[[ARG1]]
+! CHECK-NEXT:    %[[DIM:.*]] = fir.load %[[DIM_REF]]#0 : !fir.ref<i32>
+! CHECK-NEXT:    %[[EXPR:.*]] = hlfir.all %[[MASK]]#0 dim %[[DIM]] : (!fir.box<!fir.array<?x?x!fir.logical<4>>>, i32) -> !hlfir.expr<?x!fir.logical<4>>
+! CHECK-NEXT:    hlfir.assign %[[EXPR]] to %[[OUT]]#0 : !hlfir.expr<?x!fir.logical<4>>, !fir.box<!fir.array<?x!fir.logical<4>>>
+! CHECK-NEXT:    hlfir.destroy %[[EXPR]]
+! CHECK-NEXT:    return
+! CHECK-NEXT:  }
+
+! all with DIM argument by-val, mask isn't boxed
+subroutine all3(s)
+  logical :: s(2)
+  logical :: a(2,2) = reshape((/.true.,.false.,.true.,.false./), shape(a))
+s = ALL(a, 1)
+end subroutine
+! CHECK-LABEL: func.func @_QPall3(
+! CHECK:           %[[ARG0:.*]]: !fir.ref<!fir.array<2x!fir.logical<4>>> {fir.bindc_name = "s"}
+! CHECK-DAG:     %[[ADDR:.*]] = fir.address_of{{.*}} : !fir.ref<!fir.array<2x2x!fir.logical<4>>>
+! CHECK-DAG:     %[[MASK_SHAPE:.*]] = fir.shape {{.*}} -> !fir.shape<2>
+! CHECK-DAG:     %[[MASK:.*]]:2 = hlfir.declare %[[ADDR]](%[[MASK_SHAPE]])
+! CHECK-DAG:     %[[OUT_SHAPE:.*]] = fir.shape {{.*}} -> !fir.shape<1>
+! CHECK-DAG:     %[[OUT:.*]]:2 = hlfir.declare %[[ARG0]](%[[OUT_SHAPE]])
+! CHECK-DAG:     %[[C1:.*]] = arith.constant 1 : i32
+! CHECK-DAG:     %[[EXPR:.*]] = hlfir.all %[[MASK]]#0 dim %[[C1]] : (!fir.ref<!fir.array<2x2x!fir.logical<4>>>, i32) -> !hlfir.expr<2x!fir.logical<4>>
+! CHECK-DAG:     hlfir.assign %[[EXPR]] to %[[OUT]]
+! CHECK-NEXT:    hlfir.destroy %[[EXPR]] : !hlfir.expr<2x!fir.logical<4>>
+! CHECK-NEXT:    return
+! CHECK-NEXT:  }
+
+! all with DIM from pointer
+subroutine all4(a, s, d)
+  integer, pointer :: d
+  logical :: a(:,:), s(:)
+  s = ALL(a, (d))
+end subroutine
+! CHECK-LABEL: func.func @_QPall4(
+! CHECK:           %[[ARG0:.*]]: !fir.box<!fir.array<?x?x!fir.logical<4>>> {fir.bindc_name = "a"}
+! CHECK:           %[[ARG1:.*]]: !fir.box<!fir.array<?x!fir.logical<4>>> {fir.bindc_name = "s"}
+! CHECK:           %[[ARG2:.*]]: !fir.ref<!fir.box<!fir.ptr<i32>>> {fir.bindc_name = "d"}
+! CHECK-DAG:     %[[ARRAY:.*]]:2 = hlfir.declare %[[ARG0]]
+! CHECK-DAG:     %[[OUT:.*]]:2 = hlfir.declare %[[ARG1]]
+! CHECK-DAG:     %[[DIM:.*]]:2 = hlfir.declare %[[ARG2]]
+! CHECK-NEXT:    %[[DIM_BOX:.*]] = fir.load %[[DIM]]#0 : !fir.ref<!fir.box<!fir.ptr<i32>>>
+! CHECK-NEXT:    %[[DIM_ADDR:.*]] = fir.box_addr %[[DIM_BOX]] : (!fir.box<!fir.ptr<i32>>) -> !fir.ptr<i32>
+! CHECK-NEXT:    %[[DIM0:.*]] = fir.load %[[DIM_ADDR]] : !fir.ptr<i32>
+! CHECK-NEXT:    %[[DIM1:.*]] = hlfir.no_reassoc %[[DIM0]] : i32
+! CHECK-NEXT:    %[[EXPR:.*]] = hlfir.all %[[ARRAY]]#0 dim %[[DIM1]] : (!fir.box<!fir.array<?x?x!fir.logical<4>>>, i32) -> !hlfir.expr<?x!fir.logical<4>>
+! CHECK-NEXT:    hlfir.assign %[[EXPR]] to %[[OUT]]#0 : !hlfir.expr<?x!fir.logical<4>>, !fir.box<!fir.array<?x!fir.logical<4>>>
+! CHECK-NEXT:    hlfir.destroy %[[EXPR]] : !hlfir.expr<?x!fir.logical<4>>
+! CHECK-NEXT:    return
+! CHECK-NEXT:  }