[flang][OpenMP] Add semantic check for threadprivate directive

[peixin]

Summary

This patch implements the following check for THREADPRIVATE construct:

A variable that is part of another variable (as an array, structure
element or type parameter inquiry) cannot appear in a threadprivate
directive.

[kiranchandramohan]

LGTM. I have some Nit comments. Please fix it if possible.

What about the other checks?

flang/lib/Semantics/check-omp-structure.cpp

1555–1563

Nit: Would having a lambda be a better option? The lambda can take the clause or directive as an argument.

1556

Nit: an THREADPRIVATE -> a THREADPRIVATE

[peixin]

In D109685#2997488, @kiranchandramohan wrote:

LGTM. I have some Nit comments. Please fix it if possible.

What about the other checks?

I am studying on them and they will come later. I prefer to separate semantic checks with different styles in multiple PRs to make review work easier, but I will keep similar semantic checks in one PR so that the code will not revised again and again.

flang/lib/Semantics/check-omp-structure.cpp

1555–1563

Thanks for the advice. This kind of semantic check is only performed on allocate directive, threadprivate directive, declare target directive, private or shared clause. I replace the comparison check with OmpDirectiveSet currently and do not change the description of PRIVATE or SHARED into dynamic clause name, which is not necessary for current OpenMP 5.1 standard. I agree with you that lambda would be better if more clauses have this restriction.

1556

Fixed.

[peixin]

@kiranchandramohan Does this patch need more review or is it ok to land?

[kiranchandramohan]

Thanks. Please go ahead and submit.

flang/lib/Semantics/check-omp-structure.h

#include "llvm/Frontend/OpenMP/OMP.inc"
   void Enter(const parser::OpenMPDeclareSimdConstruct &);
   void Leave(const parser::OpenMPDeclareSimdConstruct &);
   void Enter(const parser::OpenMPDeclarativeAllocate &);
   void Leave(const parser::OpenMPDeclarativeAllocate &);
   void Enter(const parser::OpenMPDeclareTargetConstruct &);
   void Leave(const parser::OpenMPDeclareTargetConstruct &);
   void Enter(const parser::OpenMPExecutableAllocate &);
   void Leave(const parser::OpenMPExecutableAllocate &);
+  void Enter(const parser::OpenMPThreadprivate &);
+  void Leave(const parser::OpenMPThreadprivate &);
 
   void Enter(const parser::OpenMPSimpleStandaloneConstruct &);
   void Leave(const parser::OpenMPSimpleStandaloneConstruct &);
   void Enter(const parser::OpenMPFlushConstruct &);
   void Leave(const parser::OpenMPFlushConstruct &);
   void Enter(const parser::OpenMPCancelConstruct &);
   void Leave(const parser::OpenMPCancelConstruct &);
   void Enter(const parser::OpenMPCancellationPointConstruct &);

flang/lib/Semantics/check-omp-structure.cpp

 // constructs unless a nowait clause is specified. Only OMPD_end_sections is
 // popped becuase it is pushed while entering the EndSectionsDirective.
 void OmpStructureChecker::Leave(const parser::OmpEndSectionsDirective &x) {
   if (GetContext().directive == llvm::omp::Directive::OMPD_end_sections) {
     dirContext_.pop_back();
   }
 }
 
+void OmpStructureChecker::Enter(const parser::OpenMPThreadprivate &c) {
+  const auto &dir{std::get<parser::Verbatim>(c.t)};
+  PushContextAndClauseSets(
+      dir.source, llvm::omp::Directive::OMPD_threadprivate);
+}
+
+void OmpStructureChecker::Leave(const parser::OpenMPThreadprivate &c) {
+  const auto &dir{std::get<parser::Verbatim>(c.t)};
+  const auto &objectList{std::get<parser::OmpObjectList>(c.t)};
+  CheckIsVarPartOfAnotherVar(dir.source, objectList);
+  dirContext_.pop_back();
+}
+
 void OmpStructureChecker::Enter(const parser::OpenMPDeclareSimdConstruct &x) {
   const auto &dir{std::get<parser::Verbatim>(x.t)};
   PushContextAndClauseSets(dir.source, llvm::omp::Directive::OMPD_declare_simd);
 }
 
 void OmpStructureChecker::Leave(const parser::OpenMPDeclareSimdConstruct &) {
   dirContext_.pop_back();
 }
if (const auto *compSymbol{structComp->component.symbol}) {
       }
     }
   }
   return dataRefIsTypeParamInquiry;
 }
 
 void OmpStructureChecker::CheckIsVarPartOfAnotherVar(
     const parser::CharBlock &source, const parser::OmpObjectList &objList) {
-
+  OmpDirectiveSet nonPartialVarSet{llvm::omp::Directive::OMPD_allocate,
+      llvm::omp::Directive::OMPD_threadprivate};
   for (const auto &ompObject : objList.v) {
     std::visit(
         common::visitors{
             [&](const parser::Designator &designator) {
               if (const auto *dataRef{
                       std::get_if<parser::DataRef>(&designator.u)}) {
                 if (IsDataRefTypeParamInquiry(dataRef)) {
                   context_.Say(source,
-                      "A type parameter inquiry cannot appear in an ALLOCATE directive"_err_en_US);
+                      "A type parameter inquiry cannot appear on the %s "
+                      "directive"_err_en_US,
+                      ContextDirectiveAsFortran());
                 } else if (parser::Unwrap<parser::StructureComponent>(
                                ompObject) ||
                     parser::Unwrap<parser::ArrayElement>(ompObject)) {
+                  if (nonPartialVarSet.test(GetContext().directive)) {
                     context_.Say(source,
                         "A variable that is part of another variable (as an "
-                      "array or structure element)"
-                      " cannot appear in a PRIVATE or SHARED clause or on the ALLOCATE directive."_err_en_US);
+                        "array or structure element) cannot appear on the %s "
+                        "directive"_err_en_US,
+                        ContextDirectiveAsFortran());
+                  } else {
+                    context_.Say(source,
+                        "A variable that is part of another variable (as an "
+                        "array or structure element) cannot appear in a "
+                        "PRIVATE or SHARED clause"_err_en_US);
+                  }
                 }
               }
             },
             [&](const parser::Name &name) {},
         },
         ompObject.u);
   }
 }
 
 void OmpStructureChecker::Enter(const parser::OmpClause::Firstprivate &x) {

flang/test/Semantics/omp-allocate03.f90

 ! RUN: %python %S/test_errors.py %s %flang_fc1 -fopenmp
 ! OpenMP Version 5.0
 ! 2.11.3 allocate Directive
 ! A variable that is part of another variable (as an array or
 ! structure element) cannot appear in an allocate directive.
 subroutine allocate()
 use omp_lib
 
   type my_type
     integer :: array(10)
   end type my_type
   type(my_type) :: my_var
   real, dimension (:,:), allocatable :: darray
   integer :: a, b
 
-  !!ERROR: A variable that is part of another variable (as an array or structure element) cannot appear in an ALLOCATE directive
-  !ERROR: A variable that is part of another variable (as an array or structure element) cannot appear in a PRIVATE or SHARED clause or on the ALLOCATE directive.
+  !ERROR: A variable that is part of another variable (as an array or structure element) cannot appear on the ALLOCATE directive
   !$omp allocate(my_var%array)
 
-  !ERROR: A variable that is part of another variable (as an array or structure element) cannot appear in a PRIVATE or SHARED clause or on the ALLOCATE directive.
+  !ERROR: A variable that is part of another variable (as an array or structure element) cannot appear on the ALLOCATE directive
   !$omp allocate(darray, my_var%array) allocator(omp_default_mem_alloc)
     allocate ( darray(a, b) )
 
 end subroutine allocate

flang/test/Semantics/omp-allocate07.f90

type my_type(kind_param, len_param)
     INTEGER :: array(10)
   end type
 
   type(my_type(2, 4)) :: my_var
   INTEGER(KIND=4) :: x
   CHARACTER(LEN=32) :: w
   INTEGER, DIMENSION(:), ALLOCATABLE :: y
   
-  !ERROR: A type parameter inquiry cannot appear in an ALLOCATE directive
+  !ERROR: A type parameter inquiry cannot appear on the ALLOCATE directive
   !$omp allocate(x%KIND)
   
-  !ERROR: A type parameter inquiry cannot appear in an ALLOCATE directive
+  !ERROR: A type parameter inquiry cannot appear on the ALLOCATE directive
   !$omp allocate(w%LEN)
 
-  !ERROR: A type parameter inquiry cannot appear in an ALLOCATE directive
+  !ERROR: A type parameter inquiry cannot appear on the ALLOCATE directive
   !$omp allocate(y%KIND)
   
-  !ERROR: A type parameter inquiry cannot appear in an ALLOCATE directive
+  !ERROR: A type parameter inquiry cannot appear on the ALLOCATE directive
   !$omp allocate(my_var%kind_param)
  
-  !ERROR: A type parameter inquiry cannot appear in an ALLOCATE directive
+  !ERROR: A type parameter inquiry cannot appear on the ALLOCATE directive
   !$omp allocate(my_var%len_param)
 
 end subroutine allocate
 

flang/test/Semantics/omp-parallel-private01.f90

 !RUN: %python %S/test_errors.py %s %flang -fopenmp
 ! OpenMP Version 4.5
 ! 2.15.3.3 parallel private Clause
 program omp_parallel_private
   integer :: i, j, a(10), b(10), c(10)
   integer :: k = 10
   type my_type
     integer :: array(10)
   end type my_type
 
   type(my_type) :: my_var
 
-  !ERROR: A variable that is part of another variable (as an array or structure element) cannot appear in a PRIVATE or SHARED clause or on the ALLOCATE directive.
+  !ERROR: A variable that is part of another variable (as an array or structure element) cannot appear in a PRIVATE or SHARED clause
   !$omp parallel private(my_var%array)
   do i = 1, 10
     c(i) = a(i) + b(i) + k
     my_var%array(i) = k
   end do
   !$omp end parallel
 end program omp_parallel_private

flang/test/Semantics/omp-parallel-private02.f90

 !RUN: %python %S/test_errors.py %s %flang -fopenmp
 ! OpenMP Version 4.5
 ! 2.15.3.3 parallel private Clause
 program omp_parallel_private
   integer :: i, j, a(10), b(10), c(10)
   integer :: k = 10
   integer :: array(10)
 
   do i = 1, 10
     array(i) = i
   end do
 
-  !ERROR: A variable that is part of another variable (as an array or structure element) cannot appear in a PRIVATE or SHARED clause or on the ALLOCATE directive.
+  !ERROR: A variable that is part of another variable (as an array or structure element) cannot appear in a PRIVATE or SHARED clause
   !$omp parallel private(array(i))
   do i = 1, 10
     c(i) = a(i) + b(i) + k
     array(i) = k
   end do
   !$omp end parallel
 end program omp_parallel_private

flang/test/Semantics/omp-parallel-private03.f90

program omp_parallel_private
 
   real :: arr(10)
   integer :: intx = 10
 
   do i = 1, 10
     arr(i) = 0.0
   end do
 
-  !ERROR: A variable that is part of another variable (as an array or structure element) cannot appear in a PRIVATE or SHARED clause or on the ALLOCATE directive.
+  !ERROR: A variable that is part of another variable (as an array or structure element) cannot appear in a PRIVATE or SHARED clause
   !$omp parallel private(arr(i),intx)
   do i = 1, 10
     c(i) = a(i) + b(i) + k
     my_var%array(i) = k+intx
     arr(i) = k
   end do
   !$omp end parallel
 end program omp_parallel_private

flang/test/Semantics/omp-parallel-private04.f90

program omp_parallel_private
 
   real :: arr(10)
   integer :: intx = 10
 
   do i = 1, 10
     arr(i) = 0.0
   end do
 
-  !ERROR: A variable that is part of another variable (as an array or structure element) cannot appear in a PRIVATE or SHARED clause or on the ALLOCATE directive.
+  !ERROR: A variable that is part of another variable (as an array or structure element) cannot appear in a PRIVATE or SHARED clause
   !$omp parallel private(arr,intx,my_var%array(1))
   do i = 1, 10
     c(i) = a(i) + b(i) + k
     my_var%array(i) = k+intx
     arr(i) = k
   end do
   !$omp end parallel
 end program omp_parallel_private

flang/test/Semantics/omp-parallel-shared01.f90

 !RUN: %python %S/test_errors.py %s %flang -fopenmp
 ! OpenMP Version 4.5
 ! 2.15.3.2 parallel shared Clause
 program omp_parallel_shared
   integer :: i, j, a(10), b(10), c(10)
   integer :: k = 10
   type my_type
   integer :: array(10)
   end type my_type
 
   type(my_type) :: my_var
 
-  !ERROR: A variable that is part of another variable (as an array or structure element) cannot appear in a PRIVATE or SHARED clause or on the ALLOCATE directive.
+  !ERROR: A variable that is part of another variable (as an array or structure element) cannot appear in a PRIVATE or SHARED clause
   !$omp parallel shared(my_var%array)
   do i = 1, 10
     c(i) = a(i) + b(i) +  k
     my_var%array(i) = k
   end do
   !$omp end parallel
 end program omp_parallel_shared

flang/test/Semantics/omp-parallel-shared02.f90

 !RUN: %python %S/test_errors.py %s %flang -fopenmp
 ! OpenMP Version 4.5
 ! 2.15.3.2 parallel shared Clause
 program omp_parallel_shared
   integer :: i, j, a(10), b(10), c(10)
   integer :: k = 10
   integer :: array(10)
 
   do i = 1, 10
     array(i) = i
   end do
 
-  !ERROR: A variable that is part of another variable (as an array or structure element) cannot appear in a PRIVATE or SHARED clause or on the ALLOCATE directive.
+  !ERROR: A variable that is part of another variable (as an array or structure element) cannot appear in a PRIVATE or SHARED clause
   !$omp parallel shared(array(i))
   do i = 1, 10
     c(i) = a(i) + b(i) + k
     array(i) = k
   end do
   !$omp end parallel
 end program omp_parallel_shared

flang/test/Semantics/omp-parallel-shared03.f90

program omp_parallel_shared
 
   real :: arr(10)
   integer :: intx = 10
 
   do i = 1, 10
     arr(i) = 0.0
   end do
 
-  !ERROR: A variable that is part of another variable (as an array or structure element) cannot appear in a PRIVATE or SHARED clause or on the ALLOCATE directive.
+  !ERROR: A variable that is part of another variable (as an array or structure element) cannot appear in a PRIVATE or SHARED clause
   !$omp parallel shared(arr(i),intx)
   do i = 1, 10
      c(i) = a(i) + b(i) + k
      my_var%array(i) = k+intx
      arr(i) = k
   end do
   !$omp end parallel
 end program omp_parallel_shared

flang/test/Semantics/omp-parallel-shared04.f90

program omp_parallel_shared
 
   real :: arr(10)
   integer :: intx = 10
 
   do i = 1, 10
     arr(i) = 0.0
   end do
 
-  !ERROR: A variable that is part of another variable (as an array or structure element) cannot appear in a PRIVATE or SHARED clause or on the ALLOCATE directive.
+  !ERROR: A variable that is part of another variable (as an array or structure element) cannot appear in a PRIVATE or SHARED clause
   !$omp parallel shared(arr,intx,my_var%array(1))
   do i = 1, 10
     c(i) = a(i) + b(i) + k
     my_var%array(i) = k+intx
     arr(i) = k
   end do
   !$omp end parallel
 end program omp_parallel_shared

flang/test/Semantics/omp-threadprivate01.f90

+! RUN: %python %S/test_errors.py %s %flang_fc1 -fopenmp
+! OpenMP Version 5.1
+! Check OpenMP construct validity for the following directives:
+! 2.21.2 Threadprivate Directive
+
+module thread_private01
+  use omp_lib
+  type my_type(kind_param, len_param)
+    integer, KIND :: kind_param
+    integer, LEN :: len_param
+    integer :: t_i
+    integer :: t_arr(10)
+  end type my_type
+
+  type(my_type(2, 4)) :: my_var
+  integer :: arr(10)
+  integer(kind=4) :: x
+  character(len=32) :: w
+  integer, dimension(:), allocatable :: y
+
+  !$omp threadprivate(my_var)
+
+  !ERROR: A variable that is part of another variable (as an array or structure element) cannot appear on the THREADPRIVATE directive
+  !$omp threadprivate(my_var%t_i)
+
+  !ERROR: A variable that is part of another variable (as an array or structure element) cannot appear on the THREADPRIVATE directive
+  !$omp threadprivate(my_var%t_arr)
+
+  !ERROR: A type parameter inquiry cannot appear on the THREADPRIVATE directive
+  !$omp threadprivate(my_var%kind_param)
+
+  !ERROR: A type parameter inquiry cannot appear on the THREADPRIVATE directive
+  !$omp threadprivate(my_var%len_param)
+
+  !$omp threadprivate(arr)
+
+  !ERROR: A variable that is part of another variable (as an array or structure element) cannot appear on the THREADPRIVATE directive
+  !$omp threadprivate(arr(1))
+
+  !ERROR: A variable that is part of another variable (as an array or structure element) cannot appear on the THREADPRIVATE directive
+  !$omp threadprivate(arr(1:2))
+
+  !ERROR: A type parameter inquiry cannot appear on the THREADPRIVATE directive
+  !$omp threadprivate(x%KIND)
+
+  !ERROR: A type parameter inquiry cannot appear on the THREADPRIVATE directive
+  !$omp threadprivate(w%LEN)
+
+  !ERROR: A type parameter inquiry cannot appear on the THREADPRIVATE directive
+  !$omp threadprivate(y%KIND)
+end