12#ifndef FORTRAN_SEMANTICS_CHECK_DIRECTIVE_STRUCTURE_H_
13#define FORTRAN_SEMANTICS_CHECK_DIRECTIVE_STRUCTURE_H_
15#include "flang/Common/enum-set.h"
16#include "flang/Semantics/semantics.h"
17#include "flang/Semantics/tools.h"
18#include "llvm/ADT/iterator_range.h"
20#include <unordered_map>
22namespace Fortran::semantics {
34template <
typename D>
class NoBranchingEnforce {
38 std::string &&upperCaseDirName)
39 : context_{context}, sourcePosition_{sourcePosition},
40 upperCaseDirName_{std::move(upperCaseDirName)},
41 currentDirective_{directive}, numDoConstruct_{0} {}
42 template <
typename T>
bool Pre(
const T &) {
return true; }
43 template <
typename T>
void Post(
const T &) {}
46 currentStatementSourcePosition_ = statement.source;
55 void Post(
const parser::ReturnStmt &) { EmitBranchOutError(
"RETURN"); }
56 void Post(
const parser::ExitStmt &exitStmt) {
57 if (
const auto &exitName{exitStmt.v}) {
58 CheckConstructNameBranching(
"EXIT", exitName.value());
60 CheckConstructNameBranching(
"EXIT");
63 void Post(
const parser::CycleStmt &cycleStmt) {
64 if (
const auto &cycleName{cycleStmt.v}) {
65 CheckConstructNameBranching(
"CYCLE", cycleName.value());
67 if constexpr (std::is_same_v<D, llvm::omp::Directive>) {
68 switch ((llvm::omp::Directive)currentDirective_) {
70 case llvm::omp::Directive::OMPD_do:
71 case llvm::omp::Directive::OMPD_simd:
72 case llvm::omp::Directive::OMPD_parallel_do:
73 case llvm::omp::Directive::OMPD_parallel_do_simd:
74 case llvm::omp::Directive::OMPD_distribute_parallel_do:
75 case llvm::omp::Directive::OMPD_distribute_parallel_do_simd:
76 case llvm::omp::Directive::OMPD_distribute_parallel_for:
77 case llvm::omp::Directive::OMPD_distribute_simd:
78 case llvm::omp::Directive::OMPD_distribute_parallel_for_simd:
79 case llvm::omp::Directive::OMPD_target_teams_distribute:
80 case llvm::omp::Directive::OMPD_target_teams_distribute_simd:
81 case llvm::omp::Directive::OMPD_target_teams_distribute_parallel_do:
82 case llvm::omp::Directive::
83 OMPD_target_teams_distribute_parallel_do_simd:
88 }
else if constexpr (std::is_same_v<D, llvm::acc::Directive>) {
89 switch ((llvm::acc::Directive)currentDirective_) {
92 case llvm::acc::Directive::ACCD_loop:
93 case llvm::acc::Directive::ACCD_kernels_loop:
94 case llvm::acc::Directive::ACCD_parallel_loop:
95 case llvm::acc::Directive::ACCD_serial_loop:
101 CheckConstructNameBranching(
"CYCLE");
107 return {
"Enclosing %s construct"_en_US, upperCaseDirName_};
110 void EmitBranchOutError(
const char *stmt)
const {
112 .Say(currentStatementSourcePosition_,
113 "%s statement is not allowed in a %s construct"_err_en_US, stmt,
115 .Attach(sourcePosition_, GetEnclosingMsg());
118 inline void EmitUnlabelledBranchOutError(
const char *stmt) {
120 .Say(currentStatementSourcePosition_,
121 "%s to construct outside of %s construct is not allowed"_err_en_US,
122 stmt, upperCaseDirName_)
123 .Attach(sourcePosition_, GetEnclosingMsg());
126 void EmitBranchOutErrorWithName(
128 const std::string branchingToName{toName.ToString()};
130 .Say(currentStatementSourcePosition_,
131 "%s to construct '%s' outside of %s construct is not allowed"_err_en_US,
132 stmt, branchingToName, upperCaseDirName_)
133 .Attach(sourcePosition_, GetEnclosingMsg());
142 void CheckConstructNameBranching(
144 const ConstructStack &stack{context_.constructStack()};
145 for (
auto iter{stack.cend()}; iter-- != stack.cbegin();) {
146 const ConstructNode &construct{*iter};
147 const auto &constructName{MaybeGetNodeName(construct)};
149 if (stmtName.source == constructName->source) {
150 EmitBranchOutErrorWithName(stmt, stmtName);
158 void CheckConstructNameBranching(
const char *stmt) {
160 if (numDoConstruct_ > 0) {
165 EmitUnlabelledBranchOutError(stmt);
171 std::string upperCaseDirName_;
182template <
typename D,
typename C,
typename PC, std::
size_t ClauseEnumSize>
187 &directiveClausesMap)
188 : context_{context}, directiveClausesMap_(directiveClausesMap) {}
189 virtual ~DirectiveStructureChecker() {}
191 using ClauseMapTy = std::multimap<C, const PC *>;
192 struct DirectiveContext {
194 : directiveSource{source}, directive{d} {}
204 const PC *clause{
nullptr};
205 ClauseMapTy clauseInfo;
206 std::list<C> actualClauses;
207 std::list<C> endDirectiveClauses;
208 std::list<C> crtGroup;
212 void SetLoopIv(
Symbol *symbol) { GetContext().loopIV = symbol; }
215 DirectiveContext &GetContext() {
216 CHECK(!dirContext_.empty());
217 return dirContext_.back();
220 DirectiveContext &GetContextParent() {
221 CHECK(dirContext_.size() >= 2);
222 return dirContext_[dirContext_.size() - 2];
225 void SetContextClause(
const PC &clause) {
226 GetContext().clauseSource = clause.source;
227 GetContext().clause = &clause;
230 void ResetPartialContext(
const parser::CharBlock &source) {
231 CHECK(!dirContext_.empty());
232 SetContextDirectiveSource(source);
233 GetContext().allowedClauses = {};
234 GetContext().allowedOnceClauses = {};
235 GetContext().allowedExclusiveClauses = {};
236 GetContext().requiredClauses = {};
237 GetContext().clauseInfo = {};
238 GetContext().loopIV = {
nullptr};
241 void SetContextDirectiveSource(
const parser::CharBlock &directive) {
242 GetContext().directiveSource = directive;
245 void SetContextDirectiveEnum(D dir) { GetContext().directive = dir; }
247 void SetContextAllowed(
const common::EnumSet<C, ClauseEnumSize> &allowed) {
248 GetContext().allowedClauses = allowed;
251 void SetContextAllowedOnce(
252 const common::EnumSet<C, ClauseEnumSize> &allowedOnce) {
253 GetContext().allowedOnceClauses = allowedOnce;
256 void SetContextAllowedExclusive(
257 const common::EnumSet<C, ClauseEnumSize> &allowedExclusive) {
258 GetContext().allowedExclusiveClauses = allowedExclusive;
261 void SetContextRequired(
const common::EnumSet<C, ClauseEnumSize> &required) {
262 GetContext().requiredClauses = required;
265 void SetContextClauseInfo(C type) {
266 GetContext().clauseInfo.emplace(type, GetContext().clause);
269 void AddClauseToCrtContext(C type) {
270 GetContext().actualClauses.push_back(type);
273 void AddClauseToCrtGroupInContext(C type) {
274 GetContext().crtGroup.push_back(type);
277 void ResetCrtGroup() { GetContext().crtGroup.clear(); }
280 const PC *FindClause(C type) {
return FindClause(GetContext(), type); }
284 auto it{context.clauseInfo.find(type)};
285 if (it != context.clauseInfo.end()) {
292 const PC *FindClauseParent(C type) {
293 auto it{GetContextParent().clauseInfo.find(type)};
294 if (it != GetContextParent().clauseInfo.end()) {
300 llvm::iterator_range<typename ClauseMapTy::iterator> FindClauses(C type) {
301 auto it{GetContext().clauseInfo.equal_range(type)};
302 return llvm::make_range(it);
306 CHECK(!dirContext_.empty());
307 auto it{dirContext_.rbegin()};
308 if (++it != dirContext_.rend()) {
314 void PushContext(
const parser::CharBlock &source, D dir) {
315 dirContext_.emplace_back(source, dir);
319 CHECK(!dirContext_.empty());
320 auto it{dirContext_.rbegin()};
321 while (++it != dirContext_.rend()) {
322 if (it->directive == dir) {
329 bool CurrentDirectiveIsNested() {
return dirContext_.size() > 1; };
331 void SetClauseSets(D dir) {
332 dirContext_.back().allowedClauses = directiveClausesMap_[dir].allowed;
333 dirContext_.back().allowedOnceClauses =
334 directiveClausesMap_[dir].allowedOnce;
335 dirContext_.back().allowedExclusiveClauses =
336 directiveClausesMap_[dir].allowedExclusive;
337 dirContext_.back().requiredClauses =
338 directiveClausesMap_[dir].requiredOneOf;
340 void PushContextAndClauseSets(
const parser::CharBlock &source, D dir) {
341 PushContext(source, dir);
345 void SayNotMatching(
const parser::CharBlock &,
const parser::CharBlock &);
347 template <
typename B>
void CheckMatching(
const B &beginDir,
const B &endDir) {
348 const auto &begin{beginDir.v};
349 const auto &end{endDir.v};
351 SayNotMatching(beginDir.source, endDir.source);
356 void CheckNoBranching(
const parser::Block &block, D directive,
357 const parser::CharBlock &directiveSource);
360 void CheckOnlyAllowedAfter(C clause, common::EnumSet<C, ClauseEnumSize> set);
362 void CheckRequireAtLeastOneOf(
bool warnInsteadOfError =
false);
366 bool CheckAllowed(C clause,
bool warnInsteadOfError =
false);
370 void CheckAllowedOncePerGroup(C clause, C separator);
372 void CheckMutuallyExclusivePerGroup(
373 C clause, C separator, common::EnumSet<C, ClauseEnumSize> set);
375 void CheckAtLeastOneClause();
377 void CheckNotAllowedIfClause(
378 C clause, common::EnumSet<C, ClauseEnumSize> set);
380 std::string ContextDirectiveAsFortran();
382 void RequiresConstantPositiveParameter(
383 const C &clause,
const parser::ScalarIntConstantExpr &i);
385 void RequiresPositiveParameter(
const C &clause,
386 const parser::ScalarIntExpr &i, llvm::StringRef paramName =
"parameter",
387 bool allowZero =
true);
389 void OptionalConstantPositiveParameter(
390 const C &clause,
const std::optional<parser::ScalarIntConstantExpr> &o);
392 virtual llvm::StringRef getClauseName(C clause) {
return ""; };
394 virtual llvm::StringRef getDirectiveName(D directive) {
return ""; };
396 SemanticsContext &context_;
397 std::vector<DirectiveContext> dirContext_;
398 std::unordered_map<D, DirectiveClauses<C, ClauseEnumSize>>
399 directiveClausesMap_;
401 std::string ClauseSetToString(
const common::EnumSet<C, ClauseEnumSize> set);
404template <
typename D,
typename C,
typename PC, std::
size_t ClauseEnumSize>
405void DirectiveStructureChecker<D, C, PC, ClauseEnumSize>::CheckNoBranching(
406 const parser::Block &block, D directive,
407 const parser::CharBlock &directiveSource) {
409 context_, directiveSource, directive, ContextDirectiveAsFortran()};
410 parser::Walk(block, noBranchingEnforce);
415template <
typename D,
typename C,
typename PC, std::
size_t ClauseEnumSize>
416void DirectiveStructureChecker<D, C, PC, ClauseEnumSize>::CheckOnlyAllowedAfter(
417 C clause, common::EnumSet<C, ClauseEnumSize> set) {
418 bool enforceCheck =
false;
419 for (
auto cl : GetContext().actualClauses) {
423 }
else if (enforceCheck && !set.test(cl)) {
424 auto parserClause = GetContext().clauseInfo.find(cl);
425 context_.Say(parserClause->second->source,
426 "Clause %s is not allowed after clause %s on the %s "
427 "directive"_err_en_US,
428 parser::ToUpperCaseLetters(getClauseName(cl).str()),
429 parser::ToUpperCaseLetters(getClauseName(clause).str()),
430 ContextDirectiveAsFortran());
436template <
typename D,
typename C,
typename PC, std::
size_t ClauseEnumSize>
438 ClauseEnumSize>::CheckAtLeastOneClause() {
439 if (GetContext().actualClauses.empty()) {
440 context_.Say(GetContext().directiveSource,
441 "At least one clause is required on the %s directive"_err_en_US,
442 ContextDirectiveAsFortran());
446template <
typename D,
typename C,
typename PC, std::
size_t ClauseEnumSize>
448DirectiveStructureChecker<D, C, PC, ClauseEnumSize>::ClauseSetToString(
449 const common::EnumSet<C, ClauseEnumSize> set) {
451 set.IterateOverMembers([&](C o) {
454 list.append(parser::ToUpperCaseLetters(getClauseName(o).str()));
461template <
typename D,
typename C,
typename PC, std::
size_t ClauseEnumSize>
463 ClauseEnumSize>::CheckRequireAtLeastOneOf(
bool warnInsteadOfError) {
464 if (GetContext().requiredClauses.empty()) {
467 for (
auto cl : GetContext().actualClauses) {
468 if (GetContext().requiredClauses.test(cl)) {
473 if (warnInsteadOfError) {
474 context_.Warn(common::UsageWarning::Portability,
475 GetContext().directiveSource,
476 "At least one of %s clause should appear on the %s directive"_port_en_US,
477 ClauseSetToString(GetContext().requiredClauses),
478 ContextDirectiveAsFortran());
480 context_.Say(GetContext().directiveSource,
481 "At least one of %s clause must appear on the %s directive"_err_en_US,
482 ClauseSetToString(GetContext().requiredClauses),
483 ContextDirectiveAsFortran());
487template <
typename D,
typename C,
typename PC, std::
size_t ClauseEnumSize>
489 ClauseEnumSize>::ContextDirectiveAsFortran() {
490 return parser::ToUpperCaseLetters(
491 getDirectiveName(GetContext().directive).str());
495template <
typename D,
typename C,
typename PC, std::
size_t ClauseEnumSize>
496bool DirectiveStructureChecker<D, C, PC, ClauseEnumSize>::CheckAllowed(
497 C clause,
bool warnInsteadOfError) {
498 if (!GetContext().allowedClauses.test(clause) &&
499 !GetContext().allowedOnceClauses.test(clause) &&
500 !GetContext().allowedExclusiveClauses.test(clause) &&
501 !GetContext().requiredClauses.test(clause)) {
502 if (warnInsteadOfError) {
503 context_.Warn(common::UsageWarning::Portability,
504 GetContext().clauseSource,
505 "%s clause is not allowed on the %s directive and will be ignored"_port_en_US,
506 parser::ToUpperCaseLetters(getClauseName(clause).str()),
507 parser::ToUpperCaseLetters(GetContext().directiveSource.ToString()));
509 context_.Say(GetContext().clauseSource,
510 "%s clause is not allowed on the %s directive"_err_en_US,
511 parser::ToUpperCaseLetters(getClauseName(clause).str()),
512 parser::ToUpperCaseLetters(GetContext().directiveSource.ToString()));
516 if ((GetContext().allowedOnceClauses.test(clause) ||
517 GetContext().allowedExclusiveClauses.test(clause)) &&
518 FindClause(clause)) {
519 context_.Say(GetContext().clauseSource,
520 "At most one %s clause can appear on the %s directive"_err_en_US,
521 parser::ToUpperCaseLetters(getClauseName(clause).str()),
522 parser::ToUpperCaseLetters(GetContext().directiveSource.ToString()));
525 if (GetContext().allowedExclusiveClauses.test(clause)) {
526 std::vector<C> others;
527 GetContext().allowedExclusiveClauses.IterateOverMembers([&](C o) {
529 others.emplace_back(o);
532 for (
const auto &e : others) {
533 context_.Say(GetContext().clauseSource,
534 "%s and %s clauses are mutually exclusive and may not appear on the "
535 "same %s directive"_err_en_US,
536 parser::ToUpperCaseLetters(getClauseName(clause).str()),
537 parser::ToUpperCaseLetters(getClauseName(e).str()),
538 parser::ToUpperCaseLetters(GetContext().directiveSource.ToString()));
540 if (!others.empty()) {
544 SetContextClauseInfo(clause);
545 AddClauseToCrtContext(clause);
546 AddClauseToCrtGroupInContext(clause);
552template <
typename D,
typename C,
typename PC, std::
size_t ClauseEnumSize>
554 ClauseEnumSize>::CheckNotAllowedIfClause(C clause,
555 common::EnumSet<C, ClauseEnumSize> set) {
556 if (!llvm::is_contained(GetContext().actualClauses, clause)) {
560 for (
auto cl : GetContext().actualClauses) {
562 context_.Say(GetContext().directiveSource,
563 "Clause %s is not allowed if clause %s appears on the %s directive"_err_en_US,
564 parser::ToUpperCaseLetters(getClauseName(cl).str()),
565 parser::ToUpperCaseLetters(getClauseName(clause).str()),
566 ContextDirectiveAsFortran());
571template <
typename D,
typename C,
typename PC, std::
size_t ClauseEnumSize>
573 ClauseEnumSize>::CheckAllowedOncePerGroup(C clause, C separator) {
574 bool clauseIsPresent =
false;
575 for (
auto cl : GetContext().actualClauses) {
577 if (clauseIsPresent) {
578 context_.Say(GetContext().clauseSource,
579 "At most one %s clause can appear on the %s directive or in group separated by the %s clause"_err_en_US,
580 parser::ToUpperCaseLetters(getClauseName(clause).str()),
581 parser::ToUpperCaseLetters(GetContext().directiveSource.ToString()),
582 parser::ToUpperCaseLetters(getClauseName(separator).str()));
584 clauseIsPresent =
true;
588 clauseIsPresent =
false;
592template <
typename D,
typename C,
typename PC, std::
size_t ClauseEnumSize>
594 ClauseEnumSize>::CheckMutuallyExclusivePerGroup(C clause, C separator,
595 common::EnumSet<C, ClauseEnumSize> set) {
598 for (
auto cl : GetContext().actualClauses) {
599 if (cl == separator) {
603 context_.Say(GetContext().directiveSource,
604 "Clause %s is not allowed if clause %s appears on the %s directive"_err_en_US,
605 parser::ToUpperCaseLetters(getClauseName(clause).str()),
606 parser::ToUpperCaseLetters(getClauseName(cl).str()),
607 ContextDirectiveAsFortran());
612 for (
auto cl : GetContext().crtGroup) {
614 context_.Say(GetContext().directiveSource,
615 "Clause %s is not allowed if clause %s appears on the %s directive"_err_en_US,
616 parser::ToUpperCaseLetters(getClauseName(clause).str()),
617 parser::ToUpperCaseLetters(getClauseName(cl).str()),
618 ContextDirectiveAsFortran());
624template <
typename D,
typename C,
typename PC, std::
size_t ClauseEnumSize>
626 ClauseEnumSize>::RequiresConstantPositiveParameter(
const C &clause,
627 const parser::ScalarIntConstantExpr &i) {
628 if (
const auto v{GetIntValue(i)}) {
630 context_.Say(GetContext().clauseSource,
631 "The parameter of the %s clause must be "
632 "a constant positive integer expression"_err_en_US,
633 parser::ToUpperCaseLetters(getClauseName(clause).str()));
639template <
typename D,
typename C,
typename PC, std::
size_t ClauseEnumSize>
641 ClauseEnumSize>::OptionalConstantPositiveParameter(
const C &clause,
642 const std::optional<parser::ScalarIntConstantExpr> &o) {
643 if (o != std::nullopt) {
644 RequiresConstantPositiveParameter(clause, o.value());
648template <
typename D,
typename C,
typename PC, std::
size_t ClauseEnumSize>
649void DirectiveStructureChecker<D, C, PC, ClauseEnumSize>::SayNotMatching(
650 const parser::CharBlock &beginSource,
const parser::CharBlock &endSource) {
652 .Say(endSource,
"Unmatched %s directive"_err_en_US,
653 parser::ToUpperCaseLetters(endSource.ToString()))
654 .Attach(beginSource,
"Does not match directive"_en_US);
658template <
typename D,
typename C,
typename PC, std::
size_t ClauseEnumSize>
660 ClauseEnumSize>::RequiresPositiveParameter(
const C &clause,
661 const parser::ScalarIntExpr &i, llvm::StringRef paramName,
bool allowZero) {
662 if (
const auto v{GetIntValue(i)}) {
663 if (*v < (allowZero ? 0 : 1)) {
664 context_.Say(GetContext().clauseSource,
665 "The %s of the %s clause must be "
666 "a positive integer expression"_err_en_US,
668 parser::ToUpperCaseLetters(getClauseName(clause).str()));
Definition char-block.h:28
Definition check-directive-structure.h:183
Definition check-directive-structure.h:34
Definition semantics.h:67
Definition parse-tree.h:2339
Definition parse-tree.h:580
Definition parse-tree.h:355
Definition semantics.h:421
Definition check-directive-structure.h:24
Definition check-directive-structure.h:192