[flang] Upstream partial lowering of EXIT intrinsic

[josh.mottley.arm]

Summary

This patch adds partial lowering of the "EXIT" intrinsic to
the backend runtime hook implemented in patch D110741. It also adds a
helper function to the RuntimeCallTestBase.h for testing for an
intrinsic function call in a mlir::Block.

[awarzynski]

Thanks @josh.mottley.arm , comments inline!

flang/unittests/Optimizer/Builder/Runtime/RuntimeCallTestBase.h

123–126

Could you refine this a bit?

• "Check the operations in \p block for containing a fir::CallOp operation where its name matches \p fctName" -> this suggests that the name of fir::CallOp should be fctName, but in fact it's the function that fir::CallOp calls that's matched against fctName
• This method will only check the first instance of fir::CallOpt(fctName)and exit, right? I think that that's fine, but worth documenting too.

127–142

A bit more context:

• EXPECT_TRUE(block); --> I would move this to where the block is created. In this function I'd use assertinstead (to verify that this method is used correctly)
• you don't really need opFound :)
• everything else is a "nit" - feel free to ignore

[josh.mottley.arm]

Addressed awarzynski comments.

[josh.mottley.arm]

flang/unittests/Optimizer/Builder/Runtime/RuntimeCallTestBase.h

123–126

Is this comment better?

[awarzynski]

Thanks for addressing my comments! LGTM

flang/unittests/Optimizer/Builder/Runtime/StopTest.cpp

15

19

nit

[josh.mottley.arm]

Addressed awarzynski comments.

flang/include/flang/Optimizer/Builder/Runtime/Stop.h

+//===-- Stop.h - generate stop runtime API calls ----------------*- C++ -*-===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef FORTRAN_OPTIMIZER_BUILDER_RUNTIME_STOP_H
+#define FORTRAN_OPTIMIZER_BUILDER_RUNTIME_STOP_H
+
+namespace mlir {
+class Value;
+class Location;
+} // namespace mlir
+
+namespace fir {
+class FirOpBuilder;
+}
+
+namespace fir::runtime {
+
+/// Generate call to EXIT intrinsic runtime routine.
+void genExit(fir::FirOpBuilder &, mlir::Location, mlir::Value status);
+
+} // namespace fir::runtime
+#endif // FORTRAN_OPTIMIZER_BUILDER_RUNTIME_STOP_H

flang/lib/Optimizer/Builder/CMakeLists.txt

 get_property(dialect_libs GLOBAL PROPERTY MLIR_DIALECT_LIBS)
 
 add_flang_library(FIRBuilder
   BoxValue.cpp
   Character.cpp
   Complex.cpp
   DoLoopHelper.cpp
   FIRBuilder.cpp
   MutableBox.cpp
   Runtime/Assign.cpp
   Runtime/Character.cpp
   Runtime/Command.cpp
   Runtime/Derived.cpp
   Runtime/Numeric.cpp
   Runtime/Ragged.cpp
   Runtime/Reduction.cpp
+  Runtime/Stop.cpp
   Runtime/Transformational.cpp
 
   DEPENDS
   FIRDialect
   FIRSupport
   ${dialect_libs}
 
   LINK_LIBS
   FIRDialect
   FIRSupport
   ${dialect_libs}
 )

flang/lib/Optimizer/Builder/Runtime/Stop.cpp

+//===-- Stop.h - generate stop runtime API calls ----------------*- C++ -*-===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+#include "flang/Optimizer/Builder/Runtime/Stop.h"
+#include "flang/Optimizer/Builder/FIRBuilder.h"
+#include "flang/Optimizer/Builder/Runtime/RTBuilder.h"
+#include "flang/Runtime/stop.h"
+
+using namespace Fortran::runtime;
+
+void fir::runtime::genExit(fir::FirOpBuilder &builder, mlir::Location loc,
+                           mlir::Value status) {
+  auto exitFunc = fir::runtime::getRuntimeFunc<mkRTKey(Exit)>(loc, builder);
+  llvm::SmallVector<mlir::Value> args =
+      fir::runtime::createArguments(builder, loc, exitFunc.getType(), status);
+  builder.create<fir::CallOp>(loc, exitFunc, args);
+}

flang/unittests/Optimizer/Builder/Runtime/RuntimeCallTestBase.h

static inline void checkCallOpFromResultBox(mlir::Value result,
   const auto &u = result.user_begin();
   if (mlir::isa<fir::CallOp>(*u))
     return checkCallOp(*u, fctName, nbArgs, addLocArgs);
   auto convOp = mlir::dyn_cast<fir::ConvertOp>(*u);
   EXPECT_NE(nullptr, convOp);
   checkCallOpFromResultBox(convOp.getResult(), fctName, nbArgs, addLocArgs);
 }
 
+/// Check the operations in \p block for a `fir::CallOp` operation where the
+/// function being called shares its function name with \p fctName and the
+/// number of arguments is equal to \p nbArgs. Note that this check only cares
+/// if the operation exists, and not the order in when the operation is called.
+/// This results in exiting the test as soon as the first correct instance of
+/// `fir::CallOp` is found).
+static inline void checkBlockForCallOp(
+    mlir::Block *block, llvm::StringRef fctName, unsigned nbArgs) {
+  assert(block && "mlir::Block given is a nullptr");
+  for (auto &op : block->getOperations()) {
+    if (auto callOp = mlir::dyn_cast<fir::CallOp>(op)) {
+      if (fctName == callOp.callee()->getRootReference().getValue()) {
+        EXPECT_EQ(nbArgs, callOp.args().size());
+        return;
+      }
+    }
+  }
+  FAIL() << "No calls to " << fctName << " were found!";
+}
+
 #endif // FORTRAN_OPTIMIZER_BUILDER_RUNTIME_RUNTIMECALLTESTBASE_H

flang/unittests/Optimizer/Builder/Runtime/StopTest.cpp

+//===- StopTest.cpp -- Stop runtime builder unit tests ---------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+#include "flang/Optimizer/Builder/Runtime/Stop.h"
+#include "RuntimeCallTestBase.h"
+#include "gtest/gtest.h"
+
+TEST_F(RuntimeCallTest, genExitTest) {
+  mlir::Location loc = firBuilder->getUnknownLoc();
+  mlir::Value status = firBuilder->createIntegerConstant(loc, i32Ty, 0);
+  fir::runtime::genExit(*firBuilder, loc, status);
+  mlir::Block *block = firBuilder->getBlock();
+  EXPECT_TRUE(block) << "Failed to retrieve the block!";
+  checkBlockForCallOp(block, "_FortranAExit", 1);
+}

flang/unittests/Optimizer/CMakeLists.txt

add_flang_unittest(FlangOptimizerTests
   Builder/FIRBuilderTest.cpp
   Builder/Runtime/AssignTest.cpp
   Builder/Runtime/CommandTest.cpp
   Builder/Runtime/CharacterTest.cpp
   Builder/Runtime/DerivedTest.cpp
   Builder/Runtime/NumericTest.cpp
   Builder/Runtime/RaggedTest.cpp
   Builder/Runtime/ReductionTest.cpp
+  Builder/Runtime/StopTest.cpp
   Builder/Runtime/TransformationalTest.cpp
   FIRContextTest.cpp
   InternalNamesTest.cpp
   KindMappingTest.cpp
   RTBuilder.cpp
 )
 target_link_libraries(FlangOptimizerTests
   PRIVATE
   ${LIBS})