[NFC] Move runtime API call generator into Optimizer/Runtime - part 2/2

In order to be able to emit runtime calls in FIR transformation passes,
move the runtime call generators into Optimizer/Runtime.
RTBuilder.h is moved there, as well as DerivedRuntime.h, NumericRuntime.h,
ReductionRuntime.h, CharacterRuntime.h, and TransformationalRuntime.h

All the methods are moved from the Fortran::lower namespace into a new
fir::runtime namespace.

Runtime.[h, cpp] is not moved yet because it uses parse tree nodes.
There is no urgent need to move it now, so I did not attempted to split
it in this PR.

Allocatable.cpp and IO.cpp make direct usages of RTBuilder.h, it may be
cleaner to handle the runtime call generation details in new
Optimizer/xxx files, but this is not done here since this calls are not
currently needed in lib/Optimizer.

Author: jeanPerier

flang/docs/tutorials/addingIntrinsics.md

@@ -167,9 +167,10 @@ The categories are:
 See `include/flang/Support/BoxValue.h` for more details.
 
 If the intrinsic has a runtime implementation, the actual binding should be done in another helper function called
-`gen{Runtime function name}`. For instance character runtime bindings are implemented in `lib/Lower/CharacterRuntime.cpp`
+`gen{Runtime function name}`. For instance character runtime bindings are implemented in `lib/Optimizer/Runtime/Character.cpp`
 See `genTrim` for an example of such runtime binding helper.
-Non character related runtime binding should be added to `lib/Lower/IntrinsicRuntime.cpp`.
+Non character related runtime binding should be added to `lib/Optimizer/Runtime/Xxx.cpp`
+(for runtime API declared in `runtime/xxx.cpp`).
 
 Note: Numerical elemental intrinsics that have libm/libnvmath implementations are automatically mapped and
 do not follow the above patterns (this includes intrinsics like `acos`, `bessel_j`...).
@@ -312,18 +313,18 @@ It also creates a descriptor for the argument with `builder.createBox()`. Note t
 differently because we expect the first one to be modified, but not the second one. This difference preserves SSA
 semantics in the IR (An SSA value cannot change).
 
-The actual runtime call is generated by `Fortran::lower::genTrim` defined in `lib/Lower/CharacterRuntime.cpp`
+The actual runtime call is generated by `Fortran::lower::genTrim` defined in `lib/Optimizer/Runtime/Character.cpp`
 After the runtime call, the result descriptor is read to build the resulting `fir::CharBoxValue`
 with the result address and length. Since the result address was allocated, it is added to a clean-up list so that
 it can be deallocated after the statement.
 
 The implementation of the runtime call in lowering looks like:
 
 ```c++
-void Fortran::lower::genTrim(fir::FirOpBuilder &builder,
+void fir::runtime::genTrim(fir::FirOpBuilder &builder,
                              mlir::Location loc, mlir::Value resultBox,
                              mlir::Value stringBox) {
-  auto trimFunc = getRuntimeFunc<mkRTKey(Trim)>(loc, builder);
+  auto trimFunc = fir::runtime::getRuntimeFunc<mkRTKey(Trim)>(loc, builder);
   auto fTy = trimFunc.getType();
   auto sourceFile = fir::factory::locationToFilename(builder, loc);
   auto sourceLine =

flang/include/flang/Lower/Allocatable.h

@@ -10,6 +10,9 @@
 //
 //===----------------------------------------------------------------------===//
 
+#ifndef FORTRAN_LOWER_ALLOCATABLE_H
+#define FORTRAN_LOWER_ALLOCATABLE_H
+
 #include "flang/Optimizer/Builder/MutableBox.h"
 #include "llvm/ADT/StringRef.h"
 
@@ -73,3 +76,5 @@ void associateMutableBox(
     mlir::ValueRange lbounds, Fortran::lower::StatementContext &);
 
 } // namespace Fortran::lower
+
+#endif // FORTRAN_LOWER_ALLOCATABLE_H

flang/include/flang/Optimizer/Runtime/Character.h

@@ -1,13 +1,13 @@
-//===-- Lower/CharacterRuntime.h -- lower CHARACTER operations --*- C++ -*-===//
+//===-- Character.h -- generate calls to character runtime API --*- 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_LOWER_CHARACTERRUNTIME_H
-#define FORTRAN_LOWER_CHARACTERRUNTIME_H
+#ifndef FORTRAN_OPTIMIZER_RUNTIME_CHARACTER_H
+#define FORTRAN_OPTIMIZER_RUNTIME_CHARACTER_H
 
 #include "mlir/Dialect/StandardOps/IR/Ops.h"
 
@@ -16,8 +16,7 @@ class ExtendedValue;
 class FirOpBuilder;
 } // namespace fir
 
-namespace Fortran {
-namespace lower {
+namespace fir::runtime {
 
 /// Generate a call to the ADJUSTL runtime.
 /// This calls the simple runtime entry point that then calls into the more
@@ -130,7 +129,6 @@ mlir::Value genVerify(fir::FirOpBuilder &builder, mlir::Location loc, int kind,
                       mlir::Value setBase, mlir::Value setLen,
                       mlir::Value back);
 
-} // namespace lower
-} // namespace Fortran
+} // namespace fir::runtime
 
-#endif // FORTRAN_LOWER_CHARACTERRUNTIME_H
+#endif // FORTRAN_OPTIMIZER_RUNTIME_CHARACTER_H

flang/include/flang/Optimizer/Runtime/Derived.h

@@ -1,13 +1,13 @@
-//===-- Lower/DerivedRuntime.h - lower derived type runtime API -*- C++ -*-===//
+//===-- Derived.h - generate derived type 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_LOWER_DERIVEDRUNTIME_H
-#define FORTRAN_LOWER_DERIVEDRUNTIME_H
+#ifndef FORTRAN_OPTIMIZER_RUNTIME_DERIVED_H
+#define FORTRAN_OPTIMIZER_RUNTIME_DERIVED_H
 
 namespace mlir {
 class Value;
@@ -18,7 +18,7 @@ namespace fir {
 class FirOpBuilder;
 }
 
-namespace Fortran::lower {
+namespace fir::runtime {
 
 /// Generate call to derived type initialization runtime routine to
 /// default initialize \p box.
@@ -35,5 +35,5 @@ void genDerivedTypeDestroy(fir::FirOpBuilder &builder, mlir::Location loc,
 void genDerivedTypeAssign(fir::FirOpBuilder &builder, mlir::Location loc,
                           mlir::Value destinationBox, mlir::Value sourceBox);
 
-} // namespace Fortran::lower
-#endif
+} // namespace fir::runtime
+#endif // FORTRAN_OPTIMIZER_RUNTIME_DERIVED_H

flang/include/flang/Optimizer/Runtime/Numeric.h

@@ -1,13 +1,13 @@
-//===-- Lower/NumericRuntime.h -- lower numeric intrinsics --*- C++ -*-===//
+//===-- Numeric.h -- generate numeric intrinsics runtime 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_LOWER_NUMERICRUNTIME_H
-#define FORTRAN_LOWER_NUMERICRUNTIME_H
+#ifndef FORTRAN_OPTIMIZER_RUNTIME_NUMERIC_H
+#define FORTRAN_OPTIMIZER_RUNTIME_NUMERIC_H
 
 #include "mlir/Dialect/StandardOps/IR/Ops.h"
 
@@ -16,7 +16,7 @@ class ExtendedValue;
 class FirOpBuilder;
 } // namespace fir
 
-namespace Fortran::lower {
+namespace fir::runtime {
 
 /// Generate call to Exponent intrinsic runtime routine.
 mlir::Value genExponent(fir::FirOpBuilder &builder, mlir::Location loc,
@@ -46,5 +46,5 @@ mlir::Value genSetExponent(fir::FirOpBuilder &builder, mlir::Location loc,
 mlir::Value genSpacing(fir::FirOpBuilder &builder, mlir::Location loc,
                        mlir::Value x);
 
-} // namespace Fortran::lower
-#endif
+} // namespace fir::runtime
+#endif // FORTRAN_OPTIMIZER_RUNTIME_NUMERIC_H

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

@@ -14,28 +14,29 @@
 ///
 //===----------------------------------------------------------------------===//
 
-#ifndef FORTRAN_LOWER_RTBUILDER_H
-#define FORTRAN_LOWER_RTBUILDER_H
+#ifndef FORTRAN_OPTIMIZER_RUNTIME_RTBUILDER_H
+#define FORTRAN_OPTIMIZER_RUNTIME_RTBUILDER_H
 
-#include "flang/Lower/ConvertType.h"
+#include "flang/Common/Fortran.h"
 #include "flang/Optimizer/Builder/FIRBuilder.h"
 #include "flang/Optimizer/Dialect/FIRType.h"
 #include "mlir/IR/BuiltinTypes.h"
 #include "mlir/IR/MLIRContext.h"
 #include "llvm/ADT/SmallVector.h"
 #include <functional>
 
-// List the runtime headers we want to be able to dissect
-#include "../../runtime/io-api.h"
-
 // Incomplete type indicating C99 complex ABI in interfaces. Beware, _Complex
 // and std::complex are layout compatible, but not compatible in all ABI call
 // interface (e.g. X86 32 bits). _Complex is not standard C++, so do not use
 // it here.
 struct c_float_complex_t;
 struct c_double_complex_t;
 
-namespace Fortran::lower {
+namespace Fortran::runtime {
+class Descriptor;
+}
+
+namespace fir::runtime {
 
 using TypeBuilderFunc = mlir::Type (*)(mlir::MLIRContext *);
 using FuncTypeBuilderFunc = mlir::FunctionType (*)(mlir::MLIRContext *);
@@ -76,13 +77,6 @@ constexpr TypeBuilderFunc getModel<int &>() {
   };
 }
 template <>
-constexpr TypeBuilderFunc getModel<Fortran::runtime::io::Iostat>() {
-  return [](mlir::MLIRContext *context) -> mlir::Type {
-    return mlir::IntegerType::get(context,
-                                  8 * sizeof(Fortran::runtime::io::Iostat));
-  };
-}
-template <>
 constexpr TypeBuilderFunc getModel<char *>() {
   return [](mlir::MLIRContext *context) -> mlir::Type {
     return fir::ReferenceType::get(mlir::IntegerType::get(context, 8));
@@ -156,10 +150,6 @@ constexpr TypeBuilderFunc getModel<unsigned long long>() {
   };
 }
 template <>
-constexpr TypeBuilderFunc getModel<Fortran::runtime::io::IoStatementState *>() {
-  return getModel<char *>();
-}
-template <>
 constexpr TypeBuilderFunc getModel<double>() {
   return [](mlir::MLIRContext *context) -> mlir::Type {
     return mlir::FloatType::getF64(context);
@@ -261,13 +251,6 @@ constexpr TypeBuilderFunc getModel<Fortran::common::TypeCategory>() {
   };
 }
 template <>
-constexpr TypeBuilderFunc
-getModel<const Fortran::runtime::io::NamelistGroup &>() {
-  return [](mlir::MLIRContext *context) -> mlir::Type {
-    return fir::ReferenceType::get(mlir::TupleType::get(context));
-  };
-}
-template <>
 constexpr TypeBuilderFunc getModel<void>() {
   return [](mlir::MLIRContext *context) -> mlir::Type {
     return mlir::NoneType::get(context);
@@ -355,10 +338,10 @@ struct RuntimeTableEntry<RuntimeTableKey<KT>, RuntimeIdentifier<Cs...>> {
       E(X, 43), E(X, 44), E(X, 45), E(X, 46), E(X, 47), E(X, 48), E(X, 49)
 #define ExpandKey(X) MacroExpandKey(QuoteKey(X))
 #define FullSeq(X) std::integer_sequence<char, ExpandKey(X)>
-#define AsSequence(X) decltype(Fortran::lower::details::filter(FullSeq(X){}))
+#define AsSequence(X) decltype(fir::runtime::details::filter(FullSeq(X){}))
 #define mkKey(X)                                                               \
-  Fortran::lower::RuntimeTableEntry<                                           \
-      Fortran::lower::RuntimeTableKey<decltype(X)>, AsSequence(X)>
+  fir::runtime::RuntimeTableEntry<fir::runtime::RuntimeTableKey<decltype(X)>,  \
+                                  AsSequence(X)>
 #define mkRTKey(X) mkKey(RTNAME(X))
 
 /// Get (or generate) the MLIR FuncOp for a given runtime function. Its template
@@ -405,6 +388,6 @@ createArguments(fir::FirOpBuilder &builder, mlir::Location loc,
   return result;
 }
 
-} // namespace Fortran::lower
+} // namespace fir::runtime
 
-#endif // FORTRAN_LOWER_RTBUILDER_H
+#endif // FORTRAN_OPTIMIZER_RUNTIME_RTBUILDER_H

flang/include/flang/Optimizer/Runtime/Reduction.h

@@ -1,13 +1,13 @@
-//===-- Lower/ReductionRuntime.h -- lower reduction intrinsics --*- C++ -*-===//
+//===-- Reduction.h -- generate calls to reduction runtime API --*- 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_LOWER_REDUCTIONRUNTIME_H
-#define FORTRAN_LOWER_REDUCTIONRUNTIME_H
+#ifndef FORTRAN_OPTIMIZER_RUNTIME_REDUCTION_H
+#define FORTRAN_OPTIMIZER_RUNTIME_REDUCTION_H
 
 #include "mlir/Dialect/StandardOps/IR/Ops.h"
 
@@ -16,7 +16,7 @@ class ExtendedValue;
 class FirOpBuilder;
 } // namespace fir
 
-namespace Fortran::lower {
+namespace fir::runtime {
 
 /// Generate call to all runtime routine.
 /// This calls the descriptor based runtime call implementation of the all
@@ -143,6 +143,6 @@ void genSumDim(fir::FirOpBuilder &builder, mlir::Location loc,
                mlir::Value resultBox, mlir::Value arrayBox, mlir::Value dim,
                mlir::Value maskBox);
 
-} // namespace Fortran::lower
+} // namespace fir::runtime
 
-#endif // FORTRAN_LOWER_REDUCTIONRUNTIME_H
+#endif // FORTRAN_OPTIMIZER_RUNTIME_REDUCTION_H

flang/include/flang/Optimizer/Runtime/Transformational.h

@@ -1,14 +1,14 @@
-//===-- Lower/TransformationalRuntime.h --*- C++ -*-===//
-// lower transformational intrinsics
+//===-- Transformational.h --------------------------------------*- C++ -*-===//
+// Generate transformational intrinsic runtime API calls.
 //
 // 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_LOWER_TRANSFORMATIONALRUNTIME_H
-#define FORTRAN_LOWER_TRANSFORMATIONALRUNTIME_H
+#ifndef FORTRAN_OPTIMIZER_RUNTIME_TRANSFORMATIONAL_H
+#define FORTRAN_OPTIMIZER_RUNTIME_TRANSFORMATIONAL_H
 
 #include "mlir/Dialect/StandardOps/IR/Ops.h"
 
@@ -17,7 +17,7 @@ class ExtendedValue;
 class FirOpBuilder;
 } // namespace fir
 
-namespace Fortran::lower {
+namespace fir::runtime {
 
 void genCshift(fir::FirOpBuilder &builder, mlir::Location loc,
                mlir::Value resultBox, mlir::Value arrayBox,
@@ -50,6 +50,6 @@ void genUnpack(fir::FirOpBuilder &builder, mlir::Location loc,
                mlir::Value resultBox, mlir::Value vectorBox,
                mlir::Value maskBox, mlir::Value fieldBox);
 
-} // namespace Fortran::lower
+} // namespace fir::runtime
 
-#endif // FORTRAN_LOWER_TRANSFORMATIONALRUNTIME_H
+#endif // FORTRAN_OPTIMIZER_RUNTIME_TRANSFORMATIONAL_H

flang/lib/Lower/Allocatable.cpp

@@ -13,7 +13,6 @@
 #include "flang/Lower/Allocatable.h"
 #include "../runtime/allocatable.h"
 #include "../runtime/pointer.h"
-#include "RTBuilder.h"
 #include "StatementContext.h"
 #include "flang/Evaluate/tools.h"
 #include "flang/Lower/AbstractConverter.h"
@@ -23,6 +22,7 @@
 #include "flang/Optimizer/Builder/FIRBuilder.h"
 #include "flang/Optimizer/Dialect/FIROps.h"
 #include "flang/Optimizer/Dialect/FIROpsSupport.h"
+#include "flang/Optimizer/Runtime/RTBuilder.h"
 #include "flang/Optimizer/Support/FatalError.h"
 #include "flang/Parser/parse-tree.h"
 #include "flang/Semantics/tools.h"
@@ -119,9 +119,9 @@ static void genRuntimeSetBounds(fir::FirOpBuilder &builder, mlir::Location loc,
                                 mlir::Value upperBound) {
   auto callee =
       box.isPointer()
-          ? Fortran::lower::getRuntimeFunc<mkRTKey(PointerSetBounds)>(loc,
-                                                                      builder)
-          : Fortran::lower::getRuntimeFunc<mkRTKey(AllocatableSetBounds)>(
+          ? fir::runtime::getRuntimeFunc<mkRTKey(PointerSetBounds)>(loc,
+                                                                    builder)
+          : fir::runtime::getRuntimeFunc<mkRTKey(AllocatableSetBounds)>(
                 loc, builder);
   llvm::SmallVector<mlir::Value> args{box.getAddr(), dimIndex, lowerBound,
                                       upperBound};
@@ -139,9 +139,9 @@ static void genRuntimeInitCharacter(fir::FirOpBuilder &builder,
                                     mlir::Value len) {
   auto callee =
       box.isPointer()
-          ? Fortran::lower::getRuntimeFunc<mkRTKey(PointerNullifyCharacter)>(
+          ? fir::runtime::getRuntimeFunc<mkRTKey(PointerNullifyCharacter)>(
                 loc, builder)
-          : Fortran::lower::getRuntimeFunc<mkRTKey(AllocatableInitCharacter)>(
+          : fir::runtime::getRuntimeFunc<mkRTKey(AllocatableInitCharacter)>(
                 loc, builder);
   auto inputTypes = callee.getType().getInputs();
   if (inputTypes.size() != 5)
@@ -167,10 +167,9 @@ static mlir::Value genRuntimeAllocate(fir::FirOpBuilder &builder,
                                       ErrorManager &errorManager) {
   auto callee =
       box.isPointer()
-          ? Fortran::lower::getRuntimeFunc<mkRTKey(PointerAllocate)>(loc,
-                                                                     builder)
-          : Fortran::lower::getRuntimeFunc<mkRTKey(AllocatableAllocate)>(
-                loc, builder);
+          ? fir::runtime::getRuntimeFunc<mkRTKey(PointerAllocate)>(loc, builder)
+          : fir::runtime::getRuntimeFunc<mkRTKey(AllocatableAllocate)>(loc,
+                                                                       builder);
   llvm::SmallVector<mlir::Value> args{
       box.getAddr(), errorManager.hasStat, errorManager.errMsgAddr,
       errorManager.sourceFile, errorManager.sourceLine};
@@ -189,9 +188,9 @@ static mlir::Value genRuntimeDeallocate(fir::FirOpBuilder &builder,
   auto boxAddress = fir::factory::getMutableIRBox(builder, loc, box);
   auto callee =
       box.isPointer()
-          ? Fortran::lower::getRuntimeFunc<mkRTKey(PointerDeallocate)>(loc,
-                                                                       builder)
-          : Fortran::lower::getRuntimeFunc<mkRTKey(AllocatableDeallocate)>(
+          ? fir::runtime::getRuntimeFunc<mkRTKey(PointerDeallocate)>(loc,
+                                                                     builder)
+          : fir::runtime::getRuntimeFunc<mkRTKey(AllocatableDeallocate)>(
                 loc, builder);
   llvm::SmallVector<mlir::Value> args{
       boxAddress, errorManager.hasStat, errorManager.errMsgAddr,