[flang][OpenMP] Added parser support for defaultmap (OpenMP 5.0)

[do]

Summary

This patch adds parser support for defaultmap clause [OpenMP 5.0].

[kiranchandramohan]

Thanks @do for this patch. I have two comments.

1. I think the linux CI is failing since the patch is not formatted. Can you run clang-format on the two source files (flang/include/flang/Parser/parse-tree.h, flang/lib/Parser/openmp-parsers.cpp)? Since we build clang also along with flang you likely have clang-format as well in your bin.

./bin/clang-format -i <path-to-filename>

2. Can you also add a parse-tree dump test similar to what is in the following file? This is just to check that the parse-tree created is correct and it is easier for the reviewers to see the parse-tree.

https://github.com/llvm/llvm-project/blob/main/flang/test/Parser/omp-sections.f90

[do]

In D124190#3471545, @kiranchandramohan wrote:

Thanks @do for this patch. I have two comments.

1. I think the linux CI is failing since the patch is not formatted. Can you run clang-format on the two source files (flang/include/flang/Parser/parse-tree.h, flang/lib/Parser/openmp-parsers.cpp)? Since we build clang also along with flang you likely have clang-format as well in your bin.

./bin/clang-format -i <path-to-filename>

2. Can you also add a parse-tree dump test similar to what is in the following file? This is just to check that the parse-tree created is correct and it is easier for the reviewers to see the parse-tree.

https://github.com/llvm/llvm-project/blob/main/flang/test/Parser/omp-sections.f90

Thanks @kiranchandramohan! Both are addressed.

[peixin]

CI fails. Can you check it?

[peixin]

flang/include/flang/Parser/parse-tree.h

3346

The comment needs changes since you are extending 4.5 to 5.0.

3351

I guess the CI fails for the test case since Aggregate cannot be recognized. Please check it.

[do]

In D124190#3473472, @peixin wrote:

CI fails. Can you check it?

thanks @peixin! will do.

[do]

Addressed comments. Should fix the CI failures as well.

[do]

flang/include/flang/Parser/parse-tree.h

3346

will do. thanks.

3351

will do. thanks.

[peixin]

flang/lib/Parser/openmp-parsers.cpp

55–59

Please remove this previous comment.

59

[do]

flang/lib/Parser/openmp-parsers.cpp

55–59

Will do. Thanks.

[do]

addressing comments.

[kiranchandramohan]

Thanks Dossay for the contribution. LGTM with the two Nits suggested and CI passing. Please wait for @shraiysh and @peixin to approve.

flang/test/Parser/omp-defaultmap-unparse.f90

36–57

Nit: For the unparse tests only the relevant section is required. You can remove the checks for the rest from all the tests.
For e.g for this test, the relevant section is the following.

!PARSE-TREE:      OmpBeginBlockDirective
!PARSE-TREE:        OmpBlockDirective -> llvm::omp::Directive = target
!PARSE-TREE:        OmpClauseList -> OmpClause -> Defaultmap -> OmpDefaultmapClause
!PARSE-TREE:          ImplicitBehavior = Tofrom
!PARSE-TREE:          VariableCategory = Scalar

255–280

Nit: I think you can move these entries also close to the individual tests.

[do]

In D124190#3479479, @kiranchandramohan wrote:

Thanks Dossay for the contribution. LGTM with the two Nits suggested and CI passing. Please wait for @shraiysh and @peixin to approve.

Thanks Kiran! Done.

[kiranchandramohan]

flang/test/Parser/omp-defaultmap-unparse.f90

43–56

@do I meant you can remove the check for Block and OmpEndBlockDirective and just have the following.

!PARSE-TREE:      OmpBeginBlockDirective
!PARSE-TREE:        OmpBlockDirective -> llvm::omp::Directive = target
!PARSE-TREE:        OmpClauseList -> OmpClause -> Defaultmap -> OmpDefaultmapClause
!PARSE-TREE:          ImplicitBehavior = Tofrom
!PARSE-TREE:          VariableCategory = Scalar

[peixin]

flang/include/flang/Parser/parse-tree.h

3346

This change is missed.

[do]

addressing comments.

[shraiysh]

LGTM, thank you for working on this and apologies for the delay in review.

[peixin]

Is this landed?

[do]

In D124190#3518117, @peixin wrote:

Is this landed?

Thanks @peixin for checking, working on it. Will update when done.

[shraiysh]

@do I am trying to land this patch for you as you suggested, but I need your email address to make you the author of this patch. I believe this patch was uploaded via the web interface and so it doesn't have your email address tied to it.

flang/include/flang/Parser/parse-tree.h

 };
 
 // 2.15.5.1 map -> MAP ([ [ALWAYS[,]] map-type : ] variable-name-list)
 struct OmpMapClause {
   TUPLE_CLASS_BOILERPLATE(OmpMapClause);
   std::tuple<std::optional<OmpMapType>, OmpObjectList> t;
 };
 
 // 2.15.5.2 defaultmap -> DEFAULTMAP (implicit-behavior[:variable-category])
 struct OmpDefaultmapClause {
   TUPLE_CLASS_BOILERPLATE(OmpDefaultmapClause);
-  ENUM_CLASS(ImplicitBehavior, Tofrom)
-  ENUM_CLASS(VariableCategory, Scalar)
+  ENUM_CLASS(
+      ImplicitBehavior, Alloc, To, From, Tofrom, Firstprivate, None, Default)
+  ENUM_CLASS(VariableCategory, Scalar, Aggregate, Allocatable, Pointer)
   std::tuple<ImplicitBehavior, std::optional<VariableCategory>> t;
 };
 
 // 2.7.1 sched-modifier -> MONOTONIC | NONMONOTONIC | SIMD
 struct OmpScheduleModifierType {
   ENUM_CLASS(ModType, Monotonic, Nonmonotonic, Simd)
   WRAPPER_CLASS_BOILERPLATE(OmpScheduleModifierType, ModType);
 };

 // 2.14.1 cancel -> CANCEL construct-type-clause [ [,] if-clause]
 struct OpenMPCancelConstruct {
   TUPLE_CLASS_BOILERPLATE(OpenMPCancelConstruct);
   WRAPPER_CLASS(If, ScalarLogicalExpr);
   CharBlock source;
   std::tuple<Verbatim, OmpCancelType, std::optional<If>> t;
 };
 
-
 // 2.17.8 flush -> FLUSH [memory-order-clause] [(variable-name-list)]
 struct OpenMPFlushConstruct {
   TUPLE_CLASS_BOILERPLATE(OpenMPFlushConstruct);
   CharBlock source;
   std::tuple<Verbatim, std::optional<std::list<OmpMemoryOrderClause>>,
       std::optional<OmpObjectList>>
       t;
 };

flang/lib/Parser/openmp-parsers.cpp

("TO"_id >> pure(OmpMapType::Type::To) ||
         "ALLOC" >> pure(OmpMapType::Type::Alloc) ||
         "RELEASE" >> pure(OmpMapType::Type::Release) ||
         "DELETE" >> pure(OmpMapType::Type::Delete)) /
         ":"))
 
 TYPE_PARSER(construct<OmpMapClause>(
     maybe(Parser<OmpMapType>{}), Parser<OmpObjectList>{}))
 
-// 2.15.5.2 defaultmap -> DEFAULTMAP (TOFROM:SCALAR)
+// [OpenMP 5.0]
+// 2.19.7.2 defaultmap(implicit-behavior[:variable-category])
+//  implicit-behavior -> ALLOC | TO | FROM | TOFROM | FIRSRTPRIVATE | NONE |
+//  DEFAULT
+//  variable-category -> SCALAR | AGGREGATE | ALLOCATABLE | POINTER
 TYPE_PARSER(construct<OmpDefaultmapClause>(
     construct<OmpDefaultmapClause::ImplicitBehavior>(
-        "TOFROM" >> pure(OmpDefaultmapClause::ImplicitBehavior::Tofrom)),
-    maybe(":" >> construct<OmpDefaultmapClause::VariableCategory>("SCALAR" >>
-                     pure(OmpDefaultmapClause::VariableCategory::Scalar)))))
+        "ALLOC" >> pure(OmpDefaultmapClause::ImplicitBehavior::Alloc) ||
+        "TO"_id >> pure(OmpDefaultmapClause::ImplicitBehavior::To) ||
+        "FROM" >> pure(OmpDefaultmapClause::ImplicitBehavior::From) ||
+        "TOFROM" >> pure(OmpDefaultmapClause::ImplicitBehavior::Tofrom) ||
+        "FIRSTPRIVATE" >>
+            pure(OmpDefaultmapClause::ImplicitBehavior::Firstprivate) ||
+        "NONE" >> pure(OmpDefaultmapClause::ImplicitBehavior::None) ||
+        "DEFAULT" >> pure(OmpDefaultmapClause::ImplicitBehavior::Default)),
+    maybe(":" >>
+        construct<OmpDefaultmapClause::VariableCategory>(
+            "SCALAR" >> pure(OmpDefaultmapClause::VariableCategory::Scalar) ||
+            "AGGREGATE" >>
+                pure(OmpDefaultmapClause::VariableCategory::Aggregate) ||
+            "ALLOCATABLE" >>
+                pure(OmpDefaultmapClause::VariableCategory::Allocatable) ||
+            "POINTER" >>
+                pure(OmpDefaultmapClause::VariableCategory::Pointer)))))
 
 // 2.7.1 SCHEDULE ([modifier1 [, modifier2]:]kind[, chunk_size])
 //       Modifier ->  MONITONIC | NONMONOTONIC | SIMD
 //       kind -> STATIC | DYNAMIC | GUIDED | AUTO | RUNTIME
 //       chunk_size -> ScalarIntExpr
 TYPE_PARSER(construct<OmpScheduleModifierType>(
     "MONOTONIC" >> pure(OmpScheduleModifierType::ModType::Monotonic) ||
     "NONMONOTONIC" >> pure(OmpScheduleModifierType::ModType::Nonmonotonic) ||

flang/test/Parser/omp-defaultmap-unparse.f90

+! RUN: %flang_fc1 -fdebug-unparse-no-sema -fopenmp %s | FileCheck --ignore-case %s
+! RUN: %flang_fc1 -fdebug-dump-parse-tree-no-sema -fopenmp %s | FileCheck --check-prefix="PARSE-TREE" %s
+program main
+!CHECK-LABEL: program main
+  implicit none
+
+  integer, parameter :: N = 256
+
+  type data01
+   integer :: a
+   integer :: arr(N)
+  end type
+
+  real :: arrA(N), arrB(N)
+  integer, target :: arrC(N)
+  type(data01) :: data01_a  
+  integer, allocatable :: alloc_arr(:)
+  integer, pointer :: ptrArr(:)  
+
+  arrA = 1.414
+  arrB = 3.14
+  arrC = -1
+  data01_a%a = -1
+  data01_arr = -1
+  allocate(alloc_arr(N))
+  alloc_arr = -1
+
+
+!CHECK: !$omp target defaultmap(tofrom:scalar)  
+  !$omp target defaultmap(tofrom:scalar) 
+  do i = 1, N
+   a = 3.14
+  enddo
+!CHECK: !$omp end target
+  !$omp end target
+
+!PARSE-TREE:      OmpBeginBlockDirective
+!PARSE-TREE:        OmpBlockDirective -> llvm::omp::Directive = target
+!PARSE-TREE:        OmpClauseList -> OmpClause -> Defaultmap -> OmpDefaultmapClause
+!PARSE-TREE:          ImplicitBehavior = Tofrom
+!PARSE-TREE:          VariableCategory = Scalar
+
+!CHECK: !$omp target defaultmap(alloc:scalar)
+  !$omp target defaultmap(alloc:scalar)
+   a = 4.56
+!CHECK: !$omp end target
+  !$omp end target
+
+!PARSE-TREE:      OmpBeginBlockDirective
+!PARSE-TREE:        OmpBlockDirective -> llvm::omp::Directive = target
+!PARSE-TREE:        OmpClauseList -> OmpClause -> Defaultmap -> OmpDefaultmapClause
+!PARSE-TREE:          ImplicitBehavior = Alloc
+!PARSE-TREE:          VariableCategory = Scalar
+
+!CHECK: !$omp target defaultmap(none)
+  !$omp target defaultmap(none)
+   a = 6.78
+!CHECK: !$omp end target
+  !$omp end target
+
+!PARSE-TREE:      OmpBeginBlockDirective
+!PARSE-TREE:        OmpBlockDirective -> llvm::omp::Directive = target
+!PARSE-TREE:        OmpClauseList -> OmpClause -> Defaultmap -> OmpDefaultmapClause
+!PARSE-TREE:          ImplicitBehavior = None
+
+!CHECK: !$omp target defaultmap(none:scalar)
+  !$omp target defaultmap(none:scalar)
+   a = 4.78
+!CHECK: !$omp end target 
+  !$omp end target
+
+!PARSE-TREE:      OmpBeginBlockDirective
+!PARSE-TREE:        OmpBlockDirective -> llvm::omp::Directive = target
+!PARSE-TREE:        OmpClauseList -> OmpClause -> Defaultmap -> OmpDefaultmapClause
+!PARSE-TREE:          ImplicitBehavior = None
+!PARSE-TREE:          VariableCategory = Scalar
+
+!CHECK: !$omp target defaultmap(to:scalar)
+  !$omp target defaultmap(to:scalar)
+   a = 2.39
+!CHECK: !$omp end target
+  !$omp end target
+
+!PARSE-TREE:      OmpBeginBlockDirective
+!PARSE-TREE:        OmpBlockDirective -> llvm::omp::Directive = target
+!PARSE-TREE:        OmpClauseList -> OmpClause -> Defaultmap -> OmpDefaultmapClause
+!PARSE-TREE:          ImplicitBehavior = To
+!PARSE-TREE:          VariableCategory = Scalar
+
+!CHECK: !$omp target defaultmap(firstprivate:scalar)
+  !$omp target defaultmap(firstprivate:scalar)
+   a = 9.45
+!CHECK: !$omp end target
+  !$omp end target
+
+!PARSE-TREE:      OmpBeginBlockDirective
+!PARSE-TREE:        OmpBlockDirective -> llvm::omp::Directive = target
+!PARSE-TREE:        OmpClauseList -> OmpClause -> Defaultmap -> OmpDefaultmapClause
+!PARSE-TREE:          ImplicitBehavior = Firstprivate
+!PARSE-TREE:          VariableCategory = Scalar
+ 
+!CHECK: !$omp target defaultmap(tofrom:aggregate)
+  !$omp target defaultmap(tofrom:aggregate)
+   arrC(1) = 10
+   data01_a%a = 11
+   data01_a%arr(1) = 100
+   data01_a%arr(2) = 245
+!CHECK: !$omp end target
+  !$omp end target
+
+!PARSE-TREE:      OmpBeginBlockDirective
+!PARSE-TREE:        OmpBlockDirective -> llvm::omp::Directive = target
+!PARSE-TREE:        OmpClauseList -> OmpClause -> Defaultmap -> OmpDefaultmapClause
+!PARSE-TREE:          ImplicitBehavior = Tofrom
+!PARSE-TREE:          VariableCategory = Aggregate
+ 
+!CHECK: !$omp target defaultmap(tofrom:allocatable)  
+  !$omp target defaultmap(tofrom:allocatable)
+   alloc_arr(23) = 234
+!CHECK: !$omp end target
+  !$omp end target
+
+!PARSE-TREE:      OmpBeginBlockDirective
+!PARSE-TREE:        OmpBlockDirective -> llvm::omp::Directive = target
+!PARSE-TREE:        OmpClauseList -> OmpClause -> Defaultmap -> OmpDefaultmapClause
+!PARSE-TREE:          ImplicitBehavior = Tofrom
+!PARSE-TREE:          VariableCategory = Allocatable
+ 
+!CHECK: !$omp target defaultmap(default:pointer)
+  !$omp target defaultmap(default:pointer)
+   ptrArr=>arrC
+   ptrArr(2) = 5
+   prtArr(200) = 34
+!CHECK: !$omp end target
+  !$omp end target 
+
+!PARSE-TREE:      OmpBeginBlockDirective
+!PARSE-TREE:        OmpBlockDirective -> llvm::omp::Directive = target
+!PARSE-TREE:        OmpClauseList -> OmpClause -> Defaultmap -> OmpDefaultmapClause
+!PARSE-TREE:          ImplicitBehavior = Default
+!PARSE-TREE:          VariableCategory = Pointer
+
+end program main
+!CHECK-LABEL: end program main