[fir] Add base for runtime builder unittests

[clementval]

Summary

This patch adds the common base shared by builder runtime
unittests. It extracted from D114460 to make it easier to base other patches
on it.

[clementval]

Remove extra brace

[clementval]

Fix checkCallOpFromResultBox

[rovka]

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

87

I think this needs a comment about exactly what it's checking (e.g. some fir snippet), so it's easier for people to know when to use it.

[clementval]

• Add comment for check function.
• Move RTBuilder.h from D114460. This file is used by D114460, D114470, D114472, D114475, D114477, D114477

[clementval]

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

87

Added some comments.

[clementval]

Fix fir::LLVMPointerType::get due to missing builder.

[rovka]

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

62 ↗

(On Diff #389719)

(moving the discussion here from D114460)
What I had in mind was either:
Option 1 - SFINAE:

template <typename T>
static constexpr typenane std::enable_if_t<std::is_integral_v<T>, TypeBuilderFunc> getModel() {
  return [](mlir::MLIRContext *context) -> mlir::Type {
    return mlir::IntegerType::get(context, 8 * sizeof(T));
  };
}
// [...] lots of similar templates for is_floating_point, is_pointer etc etc

or Option 2 - single template (probably easier to follow and maintain):
template <typename T>
static constexpr TypeBuilderFunc getModel() {

return [](mlir::MLIRContext *context) -> mlir::Type {
   if constexpr (std::is_integral_v<T>) {
      return mlir::IntegerType::get(context, 8 * sizeof(T));
   } else // [...] branches for std::is_floating_point, is_pointer etc
};

}

[kiranchandramohan]

Can flang/lib/Lower/RTBuilder.h be deleted now?

LGTM. Please wait for a day if there are comments outstanding in this patch or before it was refactored.

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

141 ↗

(On Diff #389719)

Nit: This is either my lack of familiarity or a bug.

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

78

Nit: would it make sense to check the return value or return type since some runtime functions return an mlir::value and others return in the descriptor passed as an argument?

[clementval]

In D114557#3153687, @kiranchandramohan wrote:

Can flang/lib/Lower/RTBuilder.h be deleted now?

Yeah I think lowering can use this more complete version. It should be refactored in fir-dev before upstreaming.

[clementval]

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

141 ↗

(On Diff #389719)

Yeah it looks odd. Let me double check that in fir-dev.

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

78

Of course we can check more stuff. I was just trying to find a trade off between no test and time spent on upstreaming this.

[awarzynski]

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

62 ↗

(On Diff #389719)

+1

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

28

[nit] Could func1 be replaced with something a bit more unique/descriptive? Perhaps dummy_func_for_runtime_unit_tests?

113

This way you could avoid else further down. This is a nit.

115

Can this dyn_cast fail? Perhaps add EXPECT_NE(nullptr, convOp);?

[clementval]

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

62 ↗

(On Diff #389719)

This can be a nice refactoring. I think this can be done after upstreaming.

141 ↗

(On Diff #389719)

I guess the initial author made the assumption that std::size_t == long long. I updated that.

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

28

Not sure it improves anything since it is never queried or anything but if you like it better with another name then fine,

[clementval]

ddress review comments

[rovka]

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

62 ↗

(On Diff #389719)

Ok, SGTM.

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

87

Thanks, I think it's much clearer now (although the use of 'result' is still a bit misleading, since you're actually starting from a function argument rather than the actual result, which would be %0 in the snippet; I don't have a better name for it though, so feel free to leave it as is).

[clementval]

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

62 ↗

(On Diff #389719)

Added to the board https://github.com/flang-compiler/f18-llvm-project/issues/1272

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

+//===- RuntimeCalltestBase.cpp -- Base for runtime call generation 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
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef FORTRAN_OPTIMIZER_BUILDER_RUNTIME_RUNTIMECALLTESTBASE_H
+#define FORTRAN_OPTIMIZER_BUILDER_RUNTIME_RUNTIMECALLTESTBASE_H
+
+#include "gtest/gtest.h"
+#include "flang/Optimizer/Builder/FIRBuilder.h"
+#include "flang/Optimizer/Support/InitFIR.h"
+#include "flang/Optimizer/Support/KindMapping.h"
+
+struct RuntimeCallTest : public testing::Test {
+public:
+  void SetUp() override {
+    mlir::OpBuilder builder(&context);
+    auto loc = builder.getUnknownLoc();
+
+    // Set up a Module with a dummy function operation inside.
+    // Set the insertion point in the function entry block.
+    mlir::ModuleOp mod = builder.create<mlir::ModuleOp>(loc);
+    mlir::FuncOp func = mlir::FuncOp::create(
+        loc, "func1", builder.getFunctionType(llvm::None, llvm::None));
+    auto *entryBlock = func.addEntryBlock();
+    mod.push_back(mod);
+    builder.setInsertionPointToStart(entryBlock);
+
+    fir::support::loadDialects(context);
+    kindMap = std::make_unique<fir::KindMapping>(&context);
+    firBuilder = std::make_unique<fir::FirOpBuilder>(mod, *kindMap);
+
+    i8Ty = firBuilder->getI8Type();
+    i16Ty = firBuilder->getIntegerType(16);
+    i32Ty = firBuilder->getI32Type();
+    i64Ty = firBuilder->getI64Type();
+    i128Ty = firBuilder->getIntegerType(128);
+
+    f32Ty = firBuilder->getF32Type();
+    f64Ty = firBuilder->getF64Type();
+    f80Ty = firBuilder->getF80Type();
+    f128Ty = firBuilder->getF128Type();
+
+    c4Ty = fir::ComplexType::get(firBuilder->getContext(), 4);
+    c8Ty = fir::ComplexType::get(firBuilder->getContext(), 8);
+    c10Ty = fir::ComplexType::get(firBuilder->getContext(), 10);
+    c16Ty = fir::ComplexType::get(firBuilder->getContext(), 16);
+  }
+
+  mlir::MLIRContext context;
+  std::unique_ptr<fir::KindMapping> kindMap;
+  std::unique_ptr<fir::FirOpBuilder> firBuilder;
+
+  // Commonly used types
+  mlir::Type i8Ty;
+  mlir::Type i16Ty;
+  mlir::Type i32Ty;
+  mlir::Type i64Ty;
+  mlir::Type i128Ty;
+  mlir::Type f32Ty;
+  mlir::Type f64Ty;
+  mlir::Type f80Ty;
+  mlir::Type f128Ty;
+  mlir::Type c4Ty;
+  mlir::Type c8Ty;
+  mlir::Type c10Ty;
+  mlir::Type c16Ty;
+};
+
+static void checkCallOp(
+    mlir::Operation *op, llvm::StringRef fctName, unsigned nbArgs) {
+  EXPECT_TRUE(mlir::isa<fir::CallOp>(*op));
+  auto callOp = mlir::dyn_cast<fir::CallOp>(*op);
+  EXPECT_TRUE(callOp.callee().hasValue());
+  mlir::SymbolRefAttr callee = *callOp.callee();
+  EXPECT_EQ(fctName, callee.getRootReference().getValue());
+  // sourceFile and sourceLine are added arguments.
+  EXPECT_EQ(nbArgs + 2, callOp.args().size());
+}
+
+static void checkCallOpFromResultBox(
+    mlir::Value result, llvm::StringRef fctName, unsigned nbArgs) {
+  EXPECT_TRUE(result.hasOneUse());
+  auto &u = result.users_begin();
+  if (mlir::isa<fir::CallOp>(*u.getOwner())) {
+    checkCallOp(u.getOwner(), fctName, nbArgs);
+  } else {
+    auto convOp = mlir::dyn_cast<fir::ConvertOp>(*u.getOwner());
+    checkCallOpFromResultBox(convOp.getResult(), fctName, nbArgs);
+  }
+}
+
+#endif // FORTRAN_OPTIMIZER_BUILDER_RUNTIME_RUNTIMECALLTESTBASE_H