[flang] Avoid raising a TODO in fir.boxproc rewrite when not needed (#…

…1560) The pass was raising TODOs when a function both had a fir.boxproc<> argument and a fir.type<> argument (even if the fir.type<> did not contain a fir.boxproc itself). Prevent the TODO from firing when a fir.type<> does not actually contain a fir.boxproc. Add the location for the remaining TODO (it will be needed when procedure pointer components are supported in lowering). FYI, I actually tried to just implement the TODO, but I there is a funny issue. When creating the new fir::RecordType, since the name and context are the same as the type being translated, fir::RecordType:get just returns the existing type, and there is no way to change it (finalize() does nothing since it is already finalized). So this will require to add the ability to mutate the existing type, and I am not sure what are the MLIR constraints here, so I escaped and left the TODO for that case. This patch is part of the upstreaming effort from fir-dev branch. Reviewed By: jeanPerier, PeteSteinfeld Differential Revision: https://reviews.llvm.org/D127633 Co-authored-by: Jean Perier <jperier@nvidia.com>
llvm · Jun 13, 2022 · a370a4f · a370a4f
1 parent c8a9afe
commit a370a4f
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 10 deletions.
diff --git a/flang/lib/Optimizer/CodeGen/BoxedProcedure.cpp b/flang/lib/Optimizer/CodeGen/BoxedProcedure.cpp
@@ -62,12 +62,12 @@ class BoxprocTypeRewriter : public mlir::TypeConverter {
       return false;
     }
     if (auto recTy = ty.dyn_cast<RecordType>()) {
+      if (llvm::any_of(visitedTypes,
+                       [&](mlir::Type rt) { return rt == recTy; }))
+        return false;
       bool result = false;
       visitedTypes.push_back(recTy);
       for (auto t : recTy.getTypeList()) {
-        if (llvm::any_of(visitedTypes,
-                         [&](mlir::Type rt) { return rt == recTy; }))
-          continue;
         if (needsConversion(t.second)) {
           result = true;
           break;
@@ -85,9 +85,10 @@ class BoxprocTypeRewriter : public mlir::TypeConverter {
     return false;
   }
 
-  BoxprocTypeRewriter() {
+  BoxprocTypeRewriter(mlir::Location location) : loc{location} {
     addConversion([](mlir::Type ty) { return ty; });
-    addConversion([](BoxProcType boxproc) { return boxproc.getEleTy(); });
+    addConversion(
+        [&](BoxProcType boxproc) { return convertType(boxproc.getEleTy()); });
     addConversion([&](mlir::TupleType tupTy) {
       llvm::SmallVector<mlir::Type> memTys;
       for (auto ty : tupTy.getTypes())
@@ -117,14 +118,21 @@ class BoxprocTypeRewriter : public mlir::TypeConverter {
       // TODO: add ty.getLayoutMap() as needed.
       return SequenceType::get(ty.getShape(), convertType(ty.getEleTy()));
     });
-    addConversion([&](RecordType ty) {
+    addConversion([&](RecordType ty) -> mlir::Type {
+      if (!needsConversion(ty))
+        return ty;
       // FIR record types can have recursive references, so conversion is a bit
       // more complex than the other types. This conversion is not needed
       // presently, so just emit a TODO message. Need to consider the uniqued
-      // name of the record, etc.
+      // name of the record, etc. Also, fir::RecordType::get returns the
+      // existing type being translated. So finalize() will not change it, and
+      // the translation would not do anything. So the type needs to be mutated,
+      // and this might require special care to comply with MLIR infrastructure.
+
+      // TODO: this will be needed to support derived type containing procedure
+      // pointer components.
       fir::emitFatalError(
-          mlir::UnknownLoc::get(ty.getContext()),
-          "not yet implemented: record type with a boxproc type");
+          loc, "not yet implemented: record type with a boxproc type");
       return RecordType::get(ty.getContext(), "*fixme*");
     });
     addArgumentMaterialization(materializeProcedure);
@@ -141,8 +149,11 @@ class BoxprocTypeRewriter : public mlir::TypeConverter {
                                      inputs[0]);
   }
 
+  void setLocation(mlir::Location location) { loc = location; }
+
 private:
   llvm::SmallVector<mlir::Type> visitedTypes;
+  mlir::Location loc;
 };
 
 /// A `boxproc` is an abstraction for a Fortran procedure reference. Typically,
@@ -170,9 +181,10 @@ class BoxedProcedurePass : public BoxedProcedurePassBase<BoxedProcedurePass> {
     if (options.useThunks) {
       auto *context = &getContext();
       mlir::IRRewriter rewriter(context);
-      BoxprocTypeRewriter typeConverter;
+      BoxprocTypeRewriter typeConverter(mlir::UnknownLoc::get(context));
       mlir::Dialect *firDialect = context->getLoadedDialect("fir");
       getModule().walk([&](mlir::Operation *op) {
+        typeConverter.setLocation(op->getLoc());
         if (auto addr = mlir::dyn_cast<BoxAddrOp>(op)) {
           auto ty = addr.getVal().getType();
           if (typeConverter.needsConversion(ty) ||

diff --git a/flang/test/Fir/boxproc-2.fir b/flang/test/Fir/boxproc-2.fir
@@ -0,0 +1,14 @@
+// Test fir.boxproc type conversion in the boxed-procedure pass.
+// RUN: fir-opt --boxed-procedure %s | FileCheck %s
+
+//CHECK-LABEL:  func.func private @test1(!fir.type<a{x:i32,y:f64}>, () -> ()) -> none
+func.func private @test1(!fir.type<a{x:i32, y:f64}>, !fir.boxproc<() -> ()>) -> none
+
+//CHECK-LABEL:  func.func private @test2((!fir.type<a{x:i32,y:f64}>) -> ()) -> none
+func.func private @test2(!fir.boxproc<(!fir.type<a{x:i32, y:f64}>) -> ()>) -> none
+
+//CHECK-LABEL:  func.func private @test3(() -> !fir.type<a{x:i32,y:f64}>) -> none
+func.func private @test3(!fir.boxproc<() -> (!fir.type<a{x:i32, y:f64}>)>) -> none
+
+//CHECK-LABEL:  func.func private @test5(((i32) -> f32) -> ())
+func.func private @test5(!fir.boxproc<(!fir.boxproc<(i32) -> (f32)>) -> ()>)