Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Flang][OpenMP] Prevent ICE for certain constructs in unnamed programs #73938

Merged
merged 1 commit into from
Feb 22, 2024

Conversation

skatrak
Copy link
Contributor

@skatrak skatrak commented Nov 30, 2023

This patch fixes #72748 by modifying the processing of program units to search for a symbol to which OpenMP REQUIRES clauses can bind to. Rather than picking up the first PFT node with a source reference and getting its associated scope, it picks up the last one.

This avoids using the source from the first specification construct of an nameless program, which can sometimes not be associated to any scope, causing an ICE due to an invalid source location.

@llvmbot llvmbot added flang Flang issues not falling into any other category flang:openmp flang:semantics labels Nov 30, 2023
@llvmbot
Copy link
Collaborator

llvmbot commented Nov 30, 2023

@llvm/pr-subscribers-flang-semantics

Author: Sergio Afonso (skatrak)

Changes

This patch fixes #72748 by modifying the processing of program units to search for a symbol to which OpenMP REQUIRES clauses can bind to. Rather than picking up the first PFT node with a source reference and getting its associated scope, it picks up the last one.

This avoids using the source from the first specification construct of an nameless program, which can sometimes not be associated to any scope, causing an ICE due to an invalid source location.


Full diff: https://github.com/llvm/llvm-project/pull/73938.diff

2 Files Affected:

  • (modified) flang/lib/Semantics/resolve-directives.cpp (+1-1)
  • (added) flang/test/Semantics/OpenMP/struct.f90 (+7)
diff --git a/flang/lib/Semantics/resolve-directives.cpp b/flang/lib/Semantics/resolve-directives.cpp
index da6c865ad56a3b1..9084bffc7139869 100644
--- a/flang/lib/Semantics/resolve-directives.cpp
+++ b/flang/lib/Semantics/resolve-directives.cpp
@@ -25,7 +25,7 @@
 template <typename T>
 static Fortran::semantics::Scope *GetScope(
     Fortran::semantics::SemanticsContext &context, const T &x) {
-  std::optional<Fortran::parser::CharBlock> source{GetSource(x)};
+  std::optional<Fortran::parser::CharBlock> source{GetLastSource(x)};
   return source ? &context.FindScope(*source) : nullptr;
 }
 
diff --git a/flang/test/Semantics/OpenMP/struct.f90 b/flang/test/Semantics/OpenMP/struct.f90
new file mode 100644
index 000000000000000..8ae1fbe4da86f93
--- /dev/null
+++ b/flang/test/Semantics/OpenMP/struct.f90
@@ -0,0 +1,7 @@
+! RUN: %python %S/../test_errors.py %s %flang_fc1 -fopenmp
+! Check OpenMP compatibility with the DEC STRUCTURE extension
+
+structure /s/
+end structure
+
+end

@llvmbot
Copy link
Collaborator

llvmbot commented Nov 30, 2023

@llvm/pr-subscribers-flang-openmp

Author: Sergio Afonso (skatrak)

Changes

This patch fixes #72748 by modifying the processing of program units to search for a symbol to which OpenMP REQUIRES clauses can bind to. Rather than picking up the first PFT node with a source reference and getting its associated scope, it picks up the last one.

This avoids using the source from the first specification construct of an nameless program, which can sometimes not be associated to any scope, causing an ICE due to an invalid source location.


Full diff: https://github.com/llvm/llvm-project/pull/73938.diff

2 Files Affected:

  • (modified) flang/lib/Semantics/resolve-directives.cpp (+1-1)
  • (added) flang/test/Semantics/OpenMP/struct.f90 (+7)
diff --git a/flang/lib/Semantics/resolve-directives.cpp b/flang/lib/Semantics/resolve-directives.cpp
index da6c865ad56a3b1..9084bffc7139869 100644
--- a/flang/lib/Semantics/resolve-directives.cpp
+++ b/flang/lib/Semantics/resolve-directives.cpp
@@ -25,7 +25,7 @@
 template <typename T>
 static Fortran::semantics::Scope *GetScope(
     Fortran::semantics::SemanticsContext &context, const T &x) {
-  std::optional<Fortran::parser::CharBlock> source{GetSource(x)};
+  std::optional<Fortran::parser::CharBlock> source{GetLastSource(x)};
   return source ? &context.FindScope(*source) : nullptr;
 }
 
diff --git a/flang/test/Semantics/OpenMP/struct.f90 b/flang/test/Semantics/OpenMP/struct.f90
new file mode 100644
index 000000000000000..8ae1fbe4da86f93
--- /dev/null
+++ b/flang/test/Semantics/OpenMP/struct.f90
@@ -0,0 +1,7 @@
+! RUN: %python %S/../test_errors.py %s %flang_fc1 -fopenmp
+! Check OpenMP compatibility with the DEC STRUCTURE extension
+
+structure /s/
+end structure
+
+end

@kiranchandramohan
Copy link
Contributor

This looks OK. But GetLastSource does not seem to be used elsewhere. Would be good to check with @klausler.

@@ -25,7 +25,7 @@
template <typename T>
static Fortran::semantics::Scope *GetScope(
Fortran::semantics::SemanticsContext &context, const T &x) {
std::optional<Fortran::parser::CharBlock> source{GetSource(x)};
std::optional<Fortran::parser::CharBlock> source{GetLastSource(x)};
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why does this fix the bug? Wouldn't it still fail when presented with a list or vector or tuple of parse tree nodes with a single element that would fail without this change?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This function is only called for MainProgram, FunctionSubprogram, SubroutineSubprogram and BlockData (see ResolveOmpTopLevelParts in the same file). It tries to get the scope associated to these nodes and crashes while doing so in certain situations when it is a nameless MainProgram. As far as I can tell, the issue is that, when the optional ProgramStmt is not present (nameless program) the call to GetSource will return the source object of the first sourced PFT node that appears in the program, which may not have a scope associated.

In my opinion, it is incorrect to return the scope associated to any inner constructs when querying the program itself. This change makes it so the END statement of the program/function/subroutine/block, which is always present, is picked up every time, preventing this problem and stopping the crash from happening.

Maybe it'd be good to possibly restrict the GetScope function so it fails to compile if we pass any unexpected PFT node type, or just add a comment to describe its intended use. I'll gladly do it if that helps, or if there are any other suggestions as to how to deal with this case.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this sound like a reasonable solution? Thanks!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ping @klausler, I'd appreciate it if you could let me know whether my previous explanation addresses your concerns. Thanks for your time!

This patch fixes llvm#72748 by modifying the processing of program units to search
for a symbol to which OpenMP REQUIRES clauses can bind to. Rather than picking
up the first PFT node with a source reference and getting its associated scope,
it picks up the last one.

This avoids using the source from the first specification construct of an
nameless program, which can sometimes not be associated to any scope, causing
an ICE due to an invalid source location.
@skatrak skatrak merged commit 27498e9 into llvm:main Feb 22, 2024
3 of 4 checks passed
@skatrak skatrak deleted the issue-72748 branch February 22, 2024 14:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
flang:openmp flang:semantics flang Flang issues not falling into any other category
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Flang][OpenMP] crash when a structure exists
4 participants