[PATCH] D59214: [private][clang][OpeMP] Model OpenMP structured-block in AST (PR40563)
Roman Lebedev via Phabricator via cfe-commits
cfe-commits at lists.llvm.org
Mon Mar 11 09:04:37 PDT 2019
lebedev.ri created this revision.
lebedev.ri added reviewers: ABataev, rjmccall, hfinkel, rsmith, riccibruno, gribozavr.
lebedev.ri added projects: clang, OpenMP.
Herald added subscribers: jdoerfert, jfb, guansong.
https://www.openmp.org/wp-content/uploads/OpenMP-API-Specification-5.0.pdf, page 3:
structured block
For C/C++, an executable statement, possibly compound, with a single entry at the
top and a single exit at the bottom, or an OpenMP construct.
COMMENT: See Section 2.1 on page 38 for restrictions on structured
blocks.
2.1 Directive Format
Some executable directives include a structured block. A structured block:
• may contain infinite loops where the point of exit is never reached;
• may halt due to an IEEE exception;
• may contain calls to exit(), _Exit(), quick_exit(), abort() or functions with a
_Noreturn specifier (in C) or a noreturn attribute (in C/C++);
• may be an expression statement, iteration statement, selection statement, or try block, provided
that the corresponding compound statement obtained by enclosing it in { and } would be a
structured block; and
Restrictions
Restrictions to structured blocks are as follows:
• Entry to a structured block must not be the result of a branch.
• The point of exit cannot be a branch out of the structured block.
C / C++
• The point of entry to a structured block must not be a call to setjmp().
• longjmp() and throw() must not violate the entry/exit criteria.
Of particular note here is the fact that OpenMP structured blocks are as-if `noexcept`,
in the same sense as with the normal `noexcept` functions in C++.
I.e. if throw happens, and it attempts to travel out of the `noexcept` function
(here: out of the current structured-block), then the program terminates.
Now, one of course can say that since it is explicitly prohibited by the Specification,
then any and all programs that violate this Specification contain undefined behavior,
and are unspecified, and thus no one should care about them. Just don't write broken code /s
But i'm not sure this is a reasonable approach.
I have personally had oss-fuzz issues of this origin - exception thrown inside
of an OpenMP structured-block that is not caught, thus causing program termination.
This issue isn't all that hard to catch, it's not any particularly different from
diagnosing the same situation with the normal `noexcept` function.
Now, clang static analyzer does not presently model exceptions.
But clang-tidy has a simplisic bugprone-exception-escape <https://clang.llvm.org/extra/clang-tidy/checks/bugprone-exception-escape.html> check,
and it is even refactored as a `ExceptionAnalyzer` class for reuse.
So it would be trivial to use that analyzer to check for
exceptions escaping out of OpenMP structured blocks. (patch to follow.)
All that sounds too great to be true. Indeed, there is a caveat.
Presently, it's practically impossible to do. To check a OpenMP structured block
you need to somehow 'get' the OpenMP structured block, and you can't because
it's simply not modelled in AST. `CapturedStmt`/`CapturedDecl` is not it's representation.
Now, it is of course possible to write e.g. some AST matcher that would e.g.
match every OpenMP executable directive, and then return the whatever `Stmt` is
the structured block of said executable directive, if any.
But i said //practically//. This isn't practical for the following reasons:
1. This **will** bitrot. That matcher will need to be kept up-to-date, and refreshed with every new OpenMP spec version.
2. Every single piece of code that would want that knowledge would need to have such matcher. Well, okay, if it is an AST matcher, it could be shared. But then you still have `RecursiveASTVisitor` and friends. `2 > 1`, so now you have code duplication.
So it would be reasonable (and is fully within clang AST spirit) to not
force every single consumer to do that work, but instead store that knowledge
in the correct, and appropriate place - AST, class structure.
Now, there is another hoop we need to get through.
It isn't fully obvious //how// to model this.
The best solution would of course be to simply add a `OMPStructuredBlock` transparent
node. It would be optimal, it would give us two properties:
- Given this `OMPExecutableDirective`, what's it OpenMP structured block?
- It is trivial to check whether the `Stmt*` is a OpenMP structured block (`isa<OMPStructuredBlock>(ptr)`)
But OpenMP structured block isn't **necessarily** the first, direct child of `OMP*Directive`.
(even ignoring the clang's `CapturedStmt`/`CapturedDecl` that were inserted inbetween).
So i'm not sure whether or not we could re-create AST statements after they were already created?
There would be other costs to a new AST node: https://bugs.llvm.org/show_bug.cgi?id=40563#c12
1. You will need to break the representation of loops. The body should be replaced by the "structured block" entity.
2. You will need to support serialization/deserialization.
3. You will need to support template instantiation.
4. You will need to support codegen and take this new construct to account in each OpenMP directive.
Instead, there **is** an functionally-equivalent, alternative solution, consisting of two parts.
Part 1:
- Add a member function `getStructuredBlockImpl()` to the each **child** of `OMPExecutableDirective` class, that would return the statement which is the OpenMP structured block of this OpenMP executable directive. Or, if this OpenMP executable directive is a stand-alone directive, it would return `None`.
- Add a member function `getStructuredBlock()` to the OMPExecutableDirective` class itself, that would cast the `this` to an appropriate sub-class, and call the actual `getStructuredBlockImpl()`.
This way, given an `OMPExecutableDirective`, we can get it's structured block.
Also, since the knowledge is ingrained into the clang OpenMP implementation,
it will not cause any duplication, and won't bitrot - every time a new subclass of `OMPExecutableDirective`
is added, `getStructuredBlockImpl()` will need to be implemented, else it simply won't compile.
Great we achieved 1 of 2 properties of `OMPStructuredBlock` approach.
Thus, there is a second part needed:
- How can we check whether a given `Stmt*` is `OMPStructuredBlock`?
Well, we can't really, in general. I can see this workaround:
class FunctionASTVisitor : public RecursiveASTVisitor<FunctionASTVisitor> {
using Base = RecursiveASTVisitor<FunctionASTVisitor>;
public:
bool VisitOMPExecDir(OMPExecDir *D) {
OmpStructuredStmts.emplace_back(D.getStructuredStmt());
}
bool VisitSOMETHINGELSE(???) {
if(InOmpStructuredStmt)
HI!
}
bool TraverseStmt(Stmt *Node) {
if (!Node)
return Base::TraverseStmt(Node);
if (OmpStructuredStmts.back() == Node)
++InOmpStructuredStmt;
Base::TraverseStmt(Node);
if (OmpStructuredStmts.back() == Node) {
OmpStructuredStmts.pop_back();
--InOmpStructuredStmt;
}
return true;
}
std::vector<Stmt*> OmpStructuredStmts;
int InOmpStructuredStmt = 0;
};
But i really don't see using it in practice.
It's just too intrusive; and again, requires knowledge duplication.
.. but no. The solution lies right on the ground.
Why don't we simply store this `i'm a openmp structured block` in the bitfield of the `Stmt` itself?
This does not appear to have any impact on the memory footprint of the clang AST,
since it's just a single extra bit in the bitfield. At least the static assertions don't fail.
Thus, indeed, we can achieve both of the properties without a new AST node.
We can cheaply set that bit right in sema, at the end of `Sema::ActOnOpenMPExecutableDirective()`,
by just calling the `getStructuredBlock()` that we just added.
Test coverage that demonstrates all this has been added.
This isn't as great with serialization though. Most of it does not use abbrevs,
so we do end up paying the full price (4 bytes?) instead of a single bit.
That price, of course, can be reclaimed by using abbrevs.
In fact, i suspect that //might// not just reclaim these bytes, but pack these PCH significantly.
I'm not seeing a third solution. If there is one, it would be interesting to hear about it.
("just don't write code that would require `isa<OMPStructuredBlock>(ptr)`" is not a solution.)
Fixes PR40563 <https://bugs.llvm.org/show_bug.cgi?id=40563>.
Repository:
rC Clang
https://reviews.llvm.org/D59214
Files:
include/clang/AST/Stmt.h
include/clang/AST/StmtOpenMP.h
include/clang/Basic/OpenMPKinds.def
include/clang/Basic/OpenMPKinds.h
lib/AST/StmtOpenMP.cpp
lib/AST/TextNodeDumper.cpp
lib/Basic/OpenMPKinds.cpp
lib/Sema/SemaOpenMP.cpp
lib/Serialization/ASTReaderStmt.cpp
lib/Serialization/ASTWriterDecl.cpp
lib/Serialization/ASTWriterStmt.cpp
test/AST/ast-dump-openmp-atomic.c
test/AST/ast-dump-openmp-barrier.c
test/AST/ast-dump-openmp-cancel.c
test/AST/ast-dump-openmp-cancellation-point.c
test/AST/ast-dump-openmp-critical.c
test/AST/ast-dump-openmp-distribute-parallel-for-simd.c
test/AST/ast-dump-openmp-distribute-parallel-for.c
test/AST/ast-dump-openmp-distribute-simd.c
test/AST/ast-dump-openmp-distribute.c
test/AST/ast-dump-openmp-flush.c
test/AST/ast-dump-openmp-for-simd.c
test/AST/ast-dump-openmp-for.c
test/AST/ast-dump-openmp-master.c
test/AST/ast-dump-openmp-ordered.c
test/AST/ast-dump-openmp-parallel-for-simd.c
test/AST/ast-dump-openmp-parallel-for.c
test/AST/ast-dump-openmp-parallel-master-XFAIL.c
test/AST/ast-dump-openmp-parallel-sections.c
test/AST/ast-dump-openmp-parallel.c
test/AST/ast-dump-openmp-section.c
test/AST/ast-dump-openmp-sections.c
test/AST/ast-dump-openmp-simd.c
test/AST/ast-dump-openmp-single.c
test/AST/ast-dump-openmp-target-data.c
test/AST/ast-dump-openmp-target-enter-data.c
test/AST/ast-dump-openmp-target-exit-data.c
test/AST/ast-dump-openmp-target-parallel-for-simd.c
test/AST/ast-dump-openmp-target-parallel-for.c
test/AST/ast-dump-openmp-target-parallel.c
test/AST/ast-dump-openmp-target-simd.c
test/AST/ast-dump-openmp-target-teams-distribute-parallel-for-simd.c
test/AST/ast-dump-openmp-target-teams-distribute-parallel-for.c
test/AST/ast-dump-openmp-target-teams-distribute-simd.c
test/AST/ast-dump-openmp-target-teams-distribute.c
test/AST/ast-dump-openmp-target-teams.c
test/AST/ast-dump-openmp-target-update.c
test/AST/ast-dump-openmp-target.c
test/AST/ast-dump-openmp-task.c
test/AST/ast-dump-openmp-taskgroup.c
test/AST/ast-dump-openmp-taskloop-simd.c
test/AST/ast-dump-openmp-taskloop.c
test/AST/ast-dump-openmp-taskwait.c
test/AST/ast-dump-openmp-taskyield.c
test/AST/ast-dump-openmp-teams-distribute-parallel-for-simd.c
test/AST/ast-dump-openmp-teams-distribute-parallel-for.c
test/AST/ast-dump-openmp-teams-distribute-simd.c
test/AST/ast-dump-openmp-teams-distribute.c
test/AST/ast-dump-openmp-teams.c
test/AST/dump.cpp
test/PCH/stmt-openmp_structured_block-bit.cpp
test/PCH/stmt-openmp_structured_block-bit.h
More information about the cfe-commits
mailing list