Skip to content

[Flang] Add parser support for prefetch directive #139702

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions flang/docs/Directives.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,9 @@ A list of non-standard directives supported by Flang
integer that specifying the unrolling factor. When `N` is `0` or `1`, the loop
should not be unrolled at all. If `N` is omitted the optimizer will
selects the number of times to unroll the loop.
* `!dir$ prefetch designator[, designator]...`, where the designator list can be
a variable or an array reference. This directive is used to insert a hint to
the code generator to prefetch instructions for memory references.
* `!dir$ novector` disabling vectorization on the following loop.
* `!dir$ nounroll` disabling unrolling on the following loop.
* `!dir$ nounroll_and_jam` disabling unrolling and jamming on the following loop.
Expand Down
1 change: 1 addition & 0 deletions flang/include/flang/Parser/dump-parse-tree.h
Original file line number Diff line number Diff line change
Expand Up @@ -214,6 +214,7 @@ class ParseTreeDumper {
NODE(CompilerDirective, NoVector)
NODE(CompilerDirective, NoUnroll)
NODE(CompilerDirective, NoUnrollAndJam)
NODE(CompilerDirective, Prefetch)
NODE(parser, ComplexLiteralConstant)
NODE(parser, ComplexPart)
NODE(parser, ComponentArraySpec)
Expand Down
9 changes: 7 additions & 2 deletions flang/include/flang/Parser/parse-tree.h
Original file line number Diff line number Diff line change
Expand Up @@ -3354,6 +3354,7 @@ struct StmtFunctionStmt {
// !DIR$ NOVECTOR
// !DIR$ NOUNROLL
// !DIR$ NOUNROLL_AND_JAM
// !DIR$ PREFETCH designator[, designator]...
// !DIR$ <anything else>
struct CompilerDirective {
UNION_CLASS_BOILERPLATE(CompilerDirective);
Expand All @@ -3379,14 +3380,18 @@ struct CompilerDirective {
struct UnrollAndJam {
WRAPPER_CLASS_BOILERPLATE(UnrollAndJam, std::optional<std::uint64_t>);
};
struct Prefetch {
WRAPPER_CLASS_BOILERPLATE(
Prefetch, std::list<common::Indirection<Designator>>);
};
EMPTY_CLASS(NoVector);
EMPTY_CLASS(NoUnroll);
EMPTY_CLASS(NoUnrollAndJam);
EMPTY_CLASS(Unrecognized);
CharBlock source;
std::variant<std::list<IgnoreTKR>, LoopCount, std::list<AssumeAligned>,
VectorAlways, std::list<NameValue>, Unroll, UnrollAndJam, Unrecognized,
NoVector, NoUnroll, NoUnrollAndJam>
VectorAlways, std::list<NameValue>, Unroll, UnrollAndJam, Prefetch,
Unrecognized, NoVector, NoUnroll, NoUnrollAndJam>
u;
};

Expand Down
4 changes: 4 additions & 0 deletions flang/lib/Parser/Fortran-parsers.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -1294,6 +1294,7 @@ TYPE_PARSER(construct<StatOrErrmsg>("STAT =" >> statVariable) ||
// !DIR$ LOOP COUNT (n1[, n2]...)
// !DIR$ name[=value] [, name[=value]]...
// !DIR$ UNROLL [n]
// !DIR$ PREFETCH designator[, designator]...
// !DIR$ <anything else>
constexpr auto ignore_tkr{
"IGNORE_TKR" >> optionalList(construct<CompilerDirective::IgnoreTKR>(
Expand All @@ -1308,6 +1309,8 @@ constexpr auto vectorAlways{
"VECTOR ALWAYS" >> construct<CompilerDirective::VectorAlways>()};
constexpr auto unroll{
"UNROLL" >> construct<CompilerDirective::Unroll>(maybe(digitString64))};
constexpr auto prefetch{"PREFETCH" >>
construct<CompilerDirective::Prefetch>(nonemptyList(indirect(designator)))};
constexpr auto unrollAndJam{"UNROLL_AND_JAM" >>
construct<CompilerDirective::UnrollAndJam>(maybe(digitString64))};
constexpr auto novector{"NOVECTOR" >> construct<CompilerDirective::NoVector>()};
Expand All @@ -1321,6 +1324,7 @@ TYPE_PARSER(beginDirective >> "DIR$ "_tok >>
construct<CompilerDirective>(vectorAlways) ||
construct<CompilerDirective>(unrollAndJam) ||
construct<CompilerDirective>(unroll) ||
construct<CompilerDirective>(prefetch) ||
construct<CompilerDirective>(novector) ||
construct<CompilerDirective>(nounrollAndJam) ||
construct<CompilerDirective>(nounroll) ||
Expand Down
4 changes: 4 additions & 0 deletions flang/lib/Parser/unparse.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -1854,6 +1854,10 @@ class UnparseVisitor {
Word("!DIR$ UNROLL");
Walk(" ", unroll.v);
},
[&](const CompilerDirective::Prefetch &prefetch) {
Word("!DIR$ PREFETCH");
Walk(" ", prefetch.v);
},
[&](const CompilerDirective::UnrollAndJam &unrollAndJam) {
Word("!DIR$ UNROLL_AND_JAM");
Walk(" ", unrollAndJam.v);
Expand Down
80 changes: 80 additions & 0 deletions flang/test/Parser/prefetch.f90
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
!RUN: %flang_fc1 -fdebug-unparse-no-sema %s 2>&1 | FileCheck %s -check-prefix=UNPARSE
!RUN: %flang_fc1 -fdebug-dump-parse-tree-no-sema %s 2>&1 | FileCheck %s -check-prefix=TREE

subroutine test_prefetch_01(a, b)
integer, intent(in) :: a
integer, intent(inout) :: b(5)
integer :: i = 2
integer :: res

!TREE: | | DeclarationConstruct -> SpecificationConstruct -> CompilerDirective -> Prefetch -> Designator -> DataRef -> Name = 'a'

!UNPARSE: !DIR$ PREFETCH a
!dir$ prefetch a
b(1) = a

!TREE: | | ExecutionPartConstruct -> ExecutableConstruct -> CompilerDirective -> Prefetch -> Designator -> DataRef -> Name = 'b'

!UNPARSE: !DIR$ PREFETCH b
!dir$ prefetch b
res = sum(b)

!TREE: | | ExecutionPartConstruct -> ExecutableConstruct -> CompilerDirective -> Prefetch -> Designator -> DataRef -> Name = 'a'
!TREE: | | Designator -> DataRef -> ArrayElement
!TREE: | | | DataRef -> Name = 'b'
!TREE: | | | SectionSubscript -> SubscriptTriplet
!TREE: | | | | Scalar -> Integer -> Expr -> LiteralConstant -> IntLiteralConstant = '3'
!TREE: | | | | Scalar -> Integer -> Expr -> LiteralConstant -> IntLiteralConstant = '5'

!UNPARSE: !DIR$ PREFETCH a, b(3:5)
!dir$ prefetch a, b(3:5)
res = a + b(4)

!TREE: | | ExecutionPartConstruct -> ExecutableConstruct -> CompilerDirective -> Prefetch -> Designator -> DataRef -> Name = 'res'
!TREE: | | Designator -> DataRef -> ArrayElement
!TREE: | | | DataRef -> Name = 'b'
!TREE: | | | SectionSubscript -> Integer -> Expr -> Add
!TREE: | | | | Expr -> Designator -> DataRef -> Name = 'i'
!TREE: | | | | Expr -> LiteralConstant -> IntLiteralConstant = '2'

!UNPARSE: !DIR$ PREFETCH res, b(i+2)
!dir$ prefetch res, b(i+2)
res = res + b(i+2)
end subroutine

subroutine test_prefetch_02(n, a)
integer, intent(in) :: n
integer, intent(in) :: a(n)
type :: t
real, allocatable :: x(:, :)
end type t
type(t) :: p

do i = 1, n
!TREE: | | | | ExecutionPartConstruct -> ExecutableConstruct -> CompilerDirective -> Prefetch -> Designator -> DataRef -> ArrayElement
!TREE: | | | | | DataRef -> StructureComponent
!TREE: | | | | | | DataRef -> Name = 'p'
!TREE: | | | | | | Name = 'x'
!TREE: | | | | | SectionSubscript -> Integer -> Expr -> Designator -> DataRef -> Name = 'i'
!TREE: | | | | | SectionSubscript -> SubscriptTriplet
!TREE: | | | | Designator -> DataRef -> Name = 'a'

!UNPARSE: !DIR$ PREFETCH p%x(i,:), a
!dir$ prefetch p%x(i, :), a
do j = 1, n
!TREE: | | | | | | ExecutionPartConstruct -> ExecutableConstruct -> CompilerDirective -> Prefetch -> Designator -> DataRef -> ArrayElement
!TREE: | | | | | | | DataRef -> StructureComponent
!TREE: | | | | | | | | DataRef -> Name = 'p'
!TREE: | | | | | | | | Name = 'x'
!TREE: | | | | | | | SectionSubscript -> Integer -> Expr -> Designator -> DataRef -> Name = 'i'
!TREE: | | | | | | | SectionSubscript -> Integer -> Expr -> Designator -> DataRef -> Name = 'j'
!TREE: | | | | | | Designator -> DataRef -> ArrayElement
!TREE: | | | | | | | DataRef -> Name = 'a'
!TREE: | | | | | | | SectionSubscript -> Integer -> Expr -> Designator -> DataRef -> Name = 'i'

!UNPARSE: !DIR$ PREFETCH p%x(i,j), a(i)
!dir$ prefetch p%x(i, j), a(i)
p%x(i, j) = p%x(i, j) ** a(j)
end do
end do
end subroutine