move other related utils

Author: ergawy

flang/include/flang/Support/OpenMP-utils.h

@@ -78,20 +78,6 @@ struct EntryBlockArgs {
 mlir::Block *genEntryBlock(
     mlir::OpBuilder &builder, const EntryBlockArgs &args, mlir::Region &region);
 
-mlir::omp::MapInfoOp createMapInfoOp(mlir::OpBuilder &builder,
-    mlir::Location loc, mlir::Value baseAddr, mlir::Value varPtrPtr,
-    llvm::StringRef name, llvm::ArrayRef<mlir::Value> bounds,
-    llvm::ArrayRef<mlir::Value> members, mlir::ArrayAttr membersIndex,
-    uint64_t mapType, mlir::omp::VariableCaptureKind mapCaptureType,
-    mlir::Type retTy, bool partialMap = false,
-    mlir::FlatSymbolRefAttr mapperId = mlir::FlatSymbolRefAttr());
-
-mlir::Value mapTemporaryValue(fir::FirOpBuilder &firOpBuilder,
-    mlir::omp::TargetOp targetOp, mlir::Value val, llvm::StringRef name);
-
-void cloneOrMapRegionOutsiders(
-    fir::FirOpBuilder &firOpBuilder, mlir::omp::TargetOp targetOp);
-
 // Returns true if the variable has a dynamic size and therefore requires
 // bounds operations to describe its extents.
 inline bool needsBoundsOps(mlir::Value var) {

flang/include/flang/Utils/OpenMP.h

@@ -11,6 +11,10 @@
 
 #include "mlir/Dialect/OpenMP/OpenMPDialect.h"
 
+namespace fir {
+class FirOpBuilder;
+} // namespace fir
+
 namespace Fortran::utils::openmp {
 // TODO We can probably move the stuff inside `Support/OpenMP-utils.h/.cpp` here
 // as well.
@@ -28,6 +32,12 @@ mlir::omp::MapInfoOp createMapInfoOp(mlir::OpBuilder &builder,
     uint64_t mapType, mlir::omp::VariableCaptureKind mapCaptureType,
     mlir::Type retTy, bool partialMap = false,
     mlir::FlatSymbolRefAttr mapperId = mlir::FlatSymbolRefAttr());
+
+mlir::Value mapTemporaryValue(fir::FirOpBuilder &firOpBuilder,
+    mlir::omp::TargetOp targetOp, mlir::Value val, llvm::StringRef name);
+
+void cloneOrMapRegionOutsiders(
+    fir::FirOpBuilder &firOpBuilder, mlir::omp::TargetOp targetOp);
 } // namespace Fortran::utils::openmp
 
 #endif // FORTRAN_UTILS_OPENMP_H_

flang/lib/Lower/OpenMP/OpenMP.cpp

@@ -1434,7 +1434,7 @@ static void genBodyOfTargetOp(
   // If so, then either clone them as well if they are MemoryEffectFree, or else
   // copy them to a new temporary and add them to the map and block_argument
   // lists and replace their uses with the new temporary.
-  Fortran::common::openmp::cloneOrMapRegionOutsiders(firOpBuilder, targetOp);
+  cloneOrMapRegionOutsiders(firOpBuilder, targetOp);
 
   // Insert dummy instruction to remember the insertion position. The
   // marker will be deleted since there are not uses.

flang/lib/Optimizer/OpenMP/CMakeLists.txt

@@ -27,6 +27,7 @@ add_flang_library(FlangOpenMPTransforms
   FIRSupport
   FortranSupport
   HLFIRDialect
+  FortranUtils
 
   MLIR_DEPS
   ${dialect_libs}

flang/lib/Optimizer/OpenMP/DoConcurrentConversion.cpp

@@ -18,6 +18,7 @@
 #include "flang/Optimizer/OpenMP/Passes.h"
 #include "flang/Optimizer/OpenMP/Utils.h"
 #include "flang/Support/OpenMP-utils.h"
+#include "flang/Utils/OpenMP.h"
 #include "mlir/Analysis/SliceAnalysis.h"
 #include "mlir/Dialect/Func/IR/FuncOps.h"
 #include "mlir/Dialect/OpenMP/OpenMPDialect.h"
@@ -631,7 +632,7 @@ class DoConcurrentConversion
     llvm::SmallVector<mlir::Value> boundsOps;
     genBoundsOps(builder, liveIn, rawAddr, boundsOps);
 
-    return Fortran::common::openmp::createMapInfoOp(
+    return Fortran::utils::openmp::createMapInfoOp(
         builder, liveIn.getLoc(), rawAddr,
         /*varPtrPtr=*/{}, name.str(), boundsOps,
         /*members=*/{},
@@ -720,7 +721,7 @@ class DoConcurrentConversion
     // MemoryEffectFree, or else copy them to a new temporary and add them to
     // the map and block_argument lists and replace their uses with the new
     // temporary.
-    Fortran::common::openmp::cloneOrMapRegionOutsiders(builder, targetOp);
+    Fortran::utils::openmp::cloneOrMapRegionOutsiders(builder, targetOp);
     rewriter.setInsertionPoint(
         rewriter.create<mlir::omp::TerminatorOp>(targetOp.getLoc()));
 
@@ -753,11 +754,11 @@ class DoConcurrentConversion
              llvm::zip_equal(targetShapeCreationInfo.startIndices,
                              targetShapeCreationInfo.extents)) {
           shapeShiftOperands.push_back(
-              Fortran::common::openmp::mapTemporaryValue(
+              Fortran::utils::openmp::mapTemporaryValue(
                   builder, targetOp, startIndex,
                   liveInName + ".start_idx.dim" + std::to_string(shapeIdx)));
           shapeShiftOperands.push_back(
-              Fortran::common::openmp::mapTemporaryValue(
+              Fortran::utils::openmp::mapTemporaryValue(
                   builder, targetOp, extent,
                   liveInName + ".extent.dim" + std::to_string(shapeIdx)));
           ++shapeIdx;
@@ -772,7 +773,7 @@ class DoConcurrentConversion
       llvm::SmallVector<mlir::Value> shapeOperands;
       size_t shapeIdx = 0;
       for (auto extent : targetShapeCreationInfo.extents) {
-        shapeOperands.push_back(Fortran::common::openmp::mapTemporaryValue(
+        shapeOperands.push_back(Fortran::utils::openmp::mapTemporaryValue(
             builder, targetOp, extent,
             liveInName + ".extent.dim" + std::to_string(shapeIdx)));
         ++shapeIdx;

flang/lib/Support/CMakeLists.txt

@@ -54,17 +54,10 @@ add_flang_library(FortranSupport
   Version.cpp
   ${version_inc}
 
-  DEPENDS
-  FIRDialect
-
-  LINK_LIBS
-  FIRDialect
-
   LINK_COMPONENTS
   Support
 
   MLIR_LIBS
   MLIRIR
   MLIRSupport
-  MLIROpenMPDialect
 )

flang/lib/Support/OpenMP-utils.cpp

@@ -7,15 +7,8 @@
 //===----------------------------------------------------------------------===//
 
 #include "flang/Support/OpenMP-utils.h"
-#include "flang/Optimizer/Builder/DirectivesCommon.h"
-#include "flang/Optimizer/Builder/FIRBuilder.h"
-#include "flang/Optimizer/Builder/HLFIRTools.h"
 
-#include "mlir/Dialect/OpenMP/OpenMPDialect.h"
 #include "mlir/IR/OpDefinition.h"
-#include "mlir/Transforms/RegionUtils.h"
-
-#include "llvm/Frontend/OpenMP/OMPConstants.h"
 
 namespace Fortran::common::openmp {
 mlir::Block *genEntryBlock(mlir::OpBuilder &builder, const EntryBlockArgs &args,
@@ -54,146 +47,4 @@ mlir::Block *genEntryBlock(mlir::OpBuilder &builder, const EntryBlockArgs &args,
 
   return builder.createBlock(&region, {}, types, locs);
 }
-
-mlir::omp::MapInfoOp createMapInfoOp(mlir::OpBuilder &builder,
-    mlir::Location loc, mlir::Value baseAddr, mlir::Value varPtrPtr,
-    llvm::StringRef name, llvm::ArrayRef<mlir::Value> bounds,
-    llvm::ArrayRef<mlir::Value> members, mlir::ArrayAttr membersIndex,
-    uint64_t mapType, mlir::omp::VariableCaptureKind mapCaptureType,
-    mlir::Type retTy, bool partialMap, mlir::FlatSymbolRefAttr mapperId) {
-
-  if (auto boxTy = llvm::dyn_cast<fir::BaseBoxType>(baseAddr.getType())) {
-    baseAddr = fir::BoxAddrOp::create(builder, loc, baseAddr);
-    retTy = baseAddr.getType();
-  }
-
-  mlir::TypeAttr varType = mlir::TypeAttr::get(
-      llvm::cast<mlir::omp::PointerLikeType>(retTy).getElementType());
-
-  // For types with unknown extents such as <2x?xi32> we discard the incomplete
-  // type info and only retain the base type. The correct dimensions are later
-  // recovered through the bounds info.
-  if (auto seqType = llvm::dyn_cast<fir::SequenceType>(varType.getValue()))
-    if (seqType.hasDynamicExtents())
-      varType = mlir::TypeAttr::get(seqType.getEleTy());
-
-  mlir::omp::MapInfoOp op =
-      mlir::omp::MapInfoOp::create(builder, loc, retTy, baseAddr, varType,
-          builder.getIntegerAttr(builder.getIntegerType(64, false), mapType),
-          builder.getAttr<mlir::omp::VariableCaptureKindAttr>(mapCaptureType),
-          varPtrPtr, members, membersIndex, bounds, mapperId,
-          builder.getStringAttr(name), builder.getBoolAttr(partialMap));
-  return op;
-}
-
-mlir::Value mapTemporaryValue(fir::FirOpBuilder &firOpBuilder,
-    mlir::omp::TargetOp targetOp, mlir::Value val, llvm::StringRef name) {
-  mlir::OpBuilder::InsertionGuard guard(firOpBuilder);
-  mlir::Operation *valOp = val.getDefiningOp();
-
-  if (valOp)
-    firOpBuilder.setInsertionPointAfter(valOp);
-  else
-    // This means val is a block argument
-    firOpBuilder.setInsertionPoint(targetOp);
-
-  auto copyVal = firOpBuilder.createTemporary(val.getLoc(), val.getType());
-  firOpBuilder.createStoreWithConvert(copyVal.getLoc(), val, copyVal);
-
-  fir::factory::AddrAndBoundsInfo info = fir::factory::getDataOperandBaseAddr(
-      firOpBuilder, val, /*isOptional=*/false, val.getLoc());
-  llvm::SmallVector<mlir::Value> bounds =
-      fir::factory::genImplicitBoundsOps<mlir::omp::MapBoundsOp,
-          mlir::omp::MapBoundsType>(firOpBuilder, info,
-          hlfir::translateToExtendedValue(
-              val.getLoc(), firOpBuilder, hlfir::Entity{val})
-              .first,
-          /*dataExvIsAssumedSize=*/false, val.getLoc());
-
-  firOpBuilder.setInsertionPoint(targetOp);
-
-  llvm::omp::OpenMPOffloadMappingFlags mapFlag =
-      llvm::omp::OpenMPOffloadMappingFlags::OMP_MAP_IMPLICIT;
-  mlir::omp::VariableCaptureKind captureKind =
-      mlir::omp::VariableCaptureKind::ByRef;
-
-  mlir::Type eleType = copyVal.getType();
-  if (auto refType = mlir::dyn_cast<fir::ReferenceType>(copyVal.getType())) {
-    eleType = refType.getElementType();
-  }
-
-  if (fir::isa_trivial(eleType) || fir::isa_char(eleType)) {
-    captureKind = mlir::omp::VariableCaptureKind::ByCopy;
-  } else if (!fir::isa_builtin_cptr_type(eleType)) {
-    mapFlag |= llvm::omp::OpenMPOffloadMappingFlags::OMP_MAP_TO;
-  }
-
-  mlir::Value mapOp = Fortran::common::openmp::createMapInfoOp(firOpBuilder,
-      copyVal.getLoc(), copyVal,
-      /*varPtrPtr=*/mlir::Value{}, name.str(), bounds,
-      /*members=*/llvm::SmallVector<mlir::Value>{},
-      /*membersIndex=*/mlir::ArrayAttr{},
-      static_cast<std::underlying_type_t<llvm::omp::OpenMPOffloadMappingFlags>>(
-          mapFlag),
-      captureKind, copyVal.getType());
-
-  auto argIface = llvm::cast<mlir::omp::BlockArgOpenMPOpInterface>(*targetOp);
-  mlir::Region &region = targetOp.getRegion();
-
-  // Get the index of the first non-map argument before modifying mapVars,
-  // then append an element to mapVars and an associated entry block
-  // argument at that index.
-  unsigned insertIndex =
-      argIface.getMapBlockArgsStart() + argIface.numMapBlockArgs();
-  targetOp.getMapVarsMutable().append(mapOp);
-  mlir::Value clonedValArg =
-      region.insertArgument(insertIndex, copyVal.getType(), copyVal.getLoc());
-
-  mlir::Block *entryBlock = &region.getBlocks().front();
-  firOpBuilder.setInsertionPointToStart(entryBlock);
-  auto loadOp =
-      firOpBuilder.create<fir::LoadOp>(clonedValArg.getLoc(), clonedValArg);
-  return loadOp.getResult();
-}
-
-void cloneOrMapRegionOutsiders(fir::FirOpBuilder &firOpBuilder,
-                               mlir::omp::TargetOp targetOp) {
-  mlir::Region &region = targetOp.getRegion();
-  mlir::Block *entryBlock = &region.getBlocks().front();
-
-  llvm::SetVector<mlir::Value> valuesDefinedAbove;
-  mlir::getUsedValuesDefinedAbove(region, valuesDefinedAbove);
-  while (!valuesDefinedAbove.empty()) {
-    for (mlir::Value val : valuesDefinedAbove) {
-      mlir::Operation *valOp = val.getDefiningOp();
-
-      // NOTE: We skip BoxDimsOp's as the lesser of two evils is to map the
-      // indices separately, as the alternative is to eventually map the Box,
-      // which comes with a fairly large overhead comparatively. We could be
-      // more robust about this and check using a BackwardsSlice to see if we
-      // run the risk of mapping a box.
-      if (valOp && mlir::isMemoryEffectFree(valOp) &&
-          !mlir::isa<fir::BoxDimsOp>(valOp)) {
-        mlir::Operation *clonedOp = valOp->clone();
-        entryBlock->push_front(clonedOp);
-
-        auto replace = [entryBlock](mlir::OpOperand &use) {
-          return use.getOwner()->getBlock() == entryBlock;
-        };
-
-        valOp->getResults().replaceUsesWithIf(clonedOp->getResults(), replace);
-        valOp->replaceUsesWithIf(clonedOp, replace);
-      } else {
-        mlir::Value mappedTemp = Fortran::common::openmp::mapTemporaryValue(
-            firOpBuilder, targetOp, val,
-            /*name=*/{});
-        val.replaceUsesWithIf(mappedTemp, [entryBlock](mlir::OpOperand &use) {
-          return use.getOwner()->getBlock() == entryBlock;
-        });
-      }
-    }
-    valuesDefinedAbove.clear();
-    mlir::getUsedValuesDefinedAbove(region, valuesDefinedAbove);
-  }
-}
 } // namespace Fortran::common::openmp