Remove circular dependency between libFIRSupport and libFIRDialect

[Renaud-K]

Summary

Fix for shared library build. Moved the buildDispatchTable function from the .cpp the header file. Remove .cpp file since no longer needed

[tschuett]

flang/include/flang/Optimizer/Support/Utils.h

18

You seem to have a dependency from support on the dialect? Shouldn't it be the other way around?

[vzakhari]

flang/include/flang/Optimizer/Support/Utils.h

18

You seem to have a dependency from support on the dialect? Shouldn't it be the other way around?

Yes, this looks worrisome. I guess it should be okay while there is no link dependency on libFIRDialect. I am approving this for the sake of resolving the buildbot issue.

[Renaud-K]

flang/include/flang/Optimizer/Support/Utils.h

18

We already have InternalNames.cpp dependending on FIRType.h, InitFIR.cpp dependending on FIRDialect.h and as you point out Utils.h depending on FIRType.h. FIROps.h depends on the same code generation step as FIRType.h. So this is not really adding anything new.
It is captured in the cmake files with

DEPENDS
  FIROpsIncGen

There is also a dependency of FIRDialect to FIRSupport at link time. That's unfortunate but it cannot be addressed by this patch.

flang/include/flang/Optimizer/Support/Utils.h

 //===-- Optimizer/Support/Utils.h -------------------------------*- 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
 //
 //===----------------------------------------------------------------------===//
 //
 // Coding style: https://mlir.llvm.org/getting_started/DeveloperGuide/
 //
 //===----------------------------------------------------------------------===//
 
 #ifndef FORTRAN_OPTIMIZER_SUPPORT_UTILS_H
 #define FORTRAN_OPTIMIZER_SUPPORT_UTILS_H
 
 #include "flang/Common/default-kinds.h"
+#include "flang/Optimizer/Dialect/FIROps.h"
 #include "flang/Optimizer/Dialect/FIRType.h"
 #include "mlir/Dialect/Arith/IR/Arith.h"
 #include "mlir/Dialect/Func/IR/FuncOps.h"
 #include "mlir/IR/BuiltinAttributes.h"
 #include "mlir/IR/BuiltinOps.h"
 #include "llvm/ADT/DenseMap.h"
 #include "llvm/ADT/StringRef.h"
 
 namespace fir {
 /// Return the integer value of a arith::ConstantOp.
 inline std::int64_t toInt(mlir::arith::ConstantOp cop) {
   return cop.getValue().cast<mlir::IntegerAttr>().getValue().getSExtValue();
 }
 
 // Reconstruct binding tables for dynamic dispatch.
 using BindingTable = llvm::DenseMap<llvm::StringRef, unsigned>;
 using BindingTables = llvm::DenseMap<llvm::StringRef, BindingTable>;
-void buildBindingTables(BindingTables &, mlir::ModuleOp mod);
+
+inline void buildBindingTables(BindingTables &bindingTables,
+                               mlir::ModuleOp mod) {
+
+  // The binding tables are defined in FIR from lowering as fir.dispatch_table
+  // operation. Go through each binding tables and store the procedure name and
+  // binding index for later use by the fir.dispatch conversion pattern.
+  for (auto dispatchTableOp : mod.getOps<fir::DispatchTableOp>()) {
+    unsigned bindingIdx = 0;
+    BindingTable bindings;
+    if (dispatchTableOp.getRegion().empty()) {
+      bindingTables[dispatchTableOp.getSymName()] = bindings;
+      continue;
+    }
+    for (auto dtEntry : dispatchTableOp.getBlock().getOps<fir::DTEntryOp>()) {
+      bindings[dtEntry.getMethod()] = bindingIdx;
+      ++bindingIdx;
+    }
+    bindingTables[dispatchTableOp.getSymName()] = bindings;
+  }
+}
 
 // Translate front-end KINDs for use in the IR and code gen.
 inline std::vector<fir::KindTy>
 fromDefaultKinds(const Fortran::common::IntrinsicTypeDefaultKinds &defKinds) {
   return {static_cast<fir::KindTy>(defKinds.GetDefaultKind(
               Fortran::common::TypeCategory::Character)),
           static_cast<fir::KindTy>(
               defKinds.GetDefaultKind(Fortran::common::TypeCategory::Complex)),

flang/lib/Optimizer/Support/CMakeLists.txt

 get_property(dialect_libs GLOBAL PROPERTY MLIR_DIALECT_LIBS)
 
 add_flang_library(FIRSupport
   FIRContext.cpp
   InitFIR.cpp
   InternalNames.cpp
   KindMapping.cpp
-  Utils.cpp
 
   DEPENDS
   FIROpsIncGen
   HLFIROpsIncGen
   MLIRIR
   ${dialect_libs}
 
   LINK_LIBS
   ${dialect_libs}
   MLIROpenMPToLLVMIRTranslation
   MLIRLLVMToLLVMIRTranslation
   MLIRTargetLLVMIRExport
 
   LINK_COMPONENTS
   TargetParser
 )

flang/lib/Optimizer/Support/Utils.cpp

-//===-- Utils.cpp ---------------------------------------------------===//
-//
-// 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
-//
-//===----------------------------------------------------------------------===//
-//
-// Coding style: https://mlir.llvm.org/getting_started/DeveloperGuide/
-//
-//===----------------------------------------------------------------------===//
-
-#include "flang/Optimizer/Support/Utils.h"
-#include "flang/Optimizer/Dialect/FIROps.h"
-
-namespace fir {
-void buildBindingTables(BindingTables &bindingTables, mlir::ModuleOp mod) {
-
-  // The binding tables are defined in FIR from lowering as fir.dispatch_table
-  // operation. Go through each binding tables and store the procedure name and
-  // binding index for later use by the fir.dispatch conversion pattern.
-  for (auto dispatchTableOp : mod.getOps<fir::DispatchTableOp>()) {
-    unsigned bindingIdx = 0;
-    BindingTable bindings;
-    if (dispatchTableOp.getRegion().empty()) {
-      bindingTables[dispatchTableOp.getSymName()] = bindings;
-      continue;
-    }
-    for (auto dtEntry : dispatchTableOp.getBlock().getOps<fir::DTEntryOp>()) {
-      bindings[dtEntry.getMethod()] = bindingIdx;
-      ++bindingIdx;
-    }
-    bindingTables[dispatchTableOp.getSymName()] = bindings;
-  }
-}
-} // namespace fir