-
Notifications
You must be signed in to change notification settings - Fork 14.3k
[Clang][OpenMP][LoopTransformations] Fix incorrect number of generated loops for Tile and Reverse directives #140532
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
Conversation
Thank you for submitting a Pull Request (PR) to the LLVM Project! This PR will be automatically labeled and the relevant teams will be notified. If you wish to, you can add reviewers by using the "Reviewers" section on this page. If this is not working for you, it is probably because you do not have write permissions for the repository. In which case you can instead tag reviewers by name in a comment by using If you have received no comments on your PR for a week, you can request a review by "ping"ing the PR by adding a comment “Ping”. The common courtesy "ping" rate is once a week. Please remember that you are asking for valuable time from other developers. If you have further questions, they may be answered by the LLVM GitHub User Guide. You can also ask questions in a comment on this PR, on the LLVM Discord or on the forums. |
@llvm/pr-subscribers-clang-modules @llvm/pr-subscribers-clang Author: Walter J.T.V (eZWALT) ChangesThis patch is closely related to #139293 and addresses an existing issue in the loop transformation codebase. Specifically, it corrects the handling of the Previously, this variable was inaccurately set for certain transformations like reverse or tile. While this did not lead to functional bugs, since the value was only checked to determine whether it was greater than zero or equal to zero, the inconsistency could introduce problems when supporting more complex directives in the future. Full diff: https://github.com/llvm/llvm-project/pull/140532.diff 1 Files Affected:
diff --git a/clang/include/clang/AST/StmtOpenMP.h b/clang/include/clang/AST/StmtOpenMP.h
index 736bcabbad1f7..7ded194dd6eb2 100644
--- a/clang/include/clang/AST/StmtOpenMP.h
+++ b/clang/include/clang/AST/StmtOpenMP.h
@@ -5790,7 +5790,9 @@ class OMPReverseDirective final : public OMPLoopTransformationDirective {
explicit OMPReverseDirective(SourceLocation StartLoc, SourceLocation EndLoc)
: OMPLoopTransformationDirective(OMPReverseDirectiveClass,
llvm::omp::OMPD_reverse, StartLoc,
- EndLoc, 1) {}
+ EndLoc, 1) {
+ setNumGeneratedLoops(1);
+ }
void setPreInits(Stmt *PreInits) {
Data->getChildren()[PreInitsOffset] = PreInits;
@@ -5857,7 +5859,7 @@ class OMPInterchangeDirective final : public OMPLoopTransformationDirective {
: OMPLoopTransformationDirective(OMPInterchangeDirectiveClass,
llvm::omp::OMPD_interchange, StartLoc,
EndLoc, NumLoops) {
- setNumGeneratedLoops(3 * NumLoops);
+ setNumGeneratedLoops(NumLoops);
}
void setPreInits(Stmt *PreInits) {
|
Do we need the number of generated loops at all? Is it used anywhere? Maybe it worth it to remove it? |
@alexey-bataev NumGeneratedLoops refers to the number of individual loops produced, while NumGeneratedLoopNests captures the structure of nested loops. For current and future transformations, having access to both could be important for representing complex constructs accurately. Removing NumGeneratedLoops would require changes across the loop transformations logic it's not clear the benefit would justify that cost, particularly given the potential utility of retaining this semantic distinction.I’m not 100% certain all current transformations depend on that level of detail, but I believe it’s valuable to preserve until proven otherwise. |
I've identified a case where |
Are there any tests that might be affected by this change? |
Yesterday I ran all the tests (check-clang-openmp and check-clang) and no change in the behaviour or incidence was found, although i'll re-execute them just as a sanity check. Just a remainder but this merge request should be merged firstly before #139293. |
It would be good to try to find the cases that may reveal this issues before committing the patch |
Yes, i'll go through loop transformations tests and notify you tomorrow if this is the case, but i'm pretty sure that these are not breaking changes for the same reason that i told you on the other PR, NumGeneratedLoops is almost only being used in the CheckTransformableLoopNest and well i will have to check both ActOnOMPReverse/InterchangeDirective |
Before leaving i can attest that the regression tests have been passed twice 👍 |
@alexey-bataev
These values are passed into the
|
Can you remove these hardcoded values and use the stored value instead? Otherwise, it is meaningless and should be removed |
But this rigidity stems from the Note that inferring this knowledge is trivial in the old scheme of loop transformations, since almost all have one top-level loop, or the loop count is specified by a clause , for example,
Preserving this semantic information is important, and there’s no reason to change it right now. |
What I see in the source code that it is used as a boolean flag. Can we transform it to bool? There is no need to keep it integer |
Please could you cite the exact line? I'm not sure if you are refering to the logic inside checkTransformableLoopNest or not. |
I check getNumGeneratedLoops() function usage. I see that it is used only in 2 linesб which can be replaced by just a boolean |
We could add a boolean function like 'AreThereGeneratedLoops()', but getGeneratedNumLoops() is also used to count the total loops inside 'AnalyzeLoopSequence', which feeds into NumGeneratedLoops in OMPFuseDirective. Changing its return type would break that. While we could remove NumGeneratedLoops out of OMPLoopTransformation AST nodes, it provides useful semantic flexibility for future transformations. There’s a tradeoff, but I believe keeping it does more good than harm. |
gentle ping @alexey-bataev |
Could you point, where this is located? |
Of course, See line 14315 in |
Although now that i think about it, this function is not inside this PR but rather on the PR #139293, but the dependency is clear. |
gentle ping :) |
This change makes sense to me. In principle, the information of generated loops is only needed in dependent contexts (not yet fully expanded templates); elsewhere we get the loop nest structure from I think a test case could be possible under the following conditions:
In that case |
I originally kept the After revising this topic thoroughly, I believe the most reasonable course of action would be to close this PR and keep @alexey-bataev , @Meinersbur what do you think? Will this information ever be needed? |
gentle ping @alexey-bataev @Meinersbur ;) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am OK with this patch as-is, independented of #139293 since it was cleary a (my) mistake. Just a test case to detect regressions would be nice if possible.
So I LGTM this patch. If @alexey-bataev wants additional changes, this can be done independently.
Thank you! But before accepting the merge, does this mean that we discard everything that i said about refactoring these variables and just keep it as it is in both reviews @alexey-bataev ? Also, could you @Meinersbur specify what exactly do you mean with a regression test for such thing? You mean like incorporating some kind of logic which includes NumGeneratedLoops in all LoopTransformation directives or just tile and reverse? Just want to be sure before proceeding with #139293, in the aforementioned case it would not need further revision. |
I'm guessing that is a yes, could you @alexey-bataev please approve the workflows and we proceed to merge? Then we can go straight into the #139293 PR :) |
I did that already. |
Whatever the refactoring will be, this I think this patch is useful by itself. Even if the refactoring will delete all this code, the commit can be cherry-picked for those who do not want the refactoring. I don't think we should work forever on obvious fixes in case we can find something nicer. With the reproducer I meant the |
Okay now I get it, it makes sense! I'll upload the commit right now and check the tests just in case! Could you then tomorrow if the changes seems ok to you merge the pull request? I dont have enough permissions to perform such actions! |
Gentle ping @Meinersbur, if i understood you correctly, these were the changes you were talking about. I reran the whole test pipeline and everything works fine. Can you accept if this looks ok to you? thanks! |
I think he approved already your changes, you can merge the patch |
Well yes but i don't have enough permissions to merge. |
@eZWALT Congratulations on having your first Pull Request (PR) merged into the LLVM Project! Your changes will be combined with recent changes from other authors, then tested by our build bots. If there is a problem with a build, you may receive a report in an email or a comment on this PR. Please check whether problems have been caused by your change specifically, as the builds can include changes from many authors. It is not uncommon for your change to be included in a build that fails due to someone else's changes, or infrastructure issues. How to do this, and the rest of the post-merge process, is covered in detail here. If your change does cause a problem, it may be reverted, or you can revert it yourself. This is a normal part of LLVM development. You can fix your changes and open a new PR to merge them again. If you don't get any reports, no action is required from you. Your changes are working as expected, well done! |
I didn't know. Additional changes are find, I just merged it. Thanks for the patch. |
LLVM Buildbot has detected a new failure on builder Full details are available at: https://lab.llvm.org/buildbot/#/builders/27/builds/11766 Here is the relevant piece of the build log for the reference
|
Thank you so much @Meinersbur ! |
This patch is closely related to #139293 and addresses an existing issue in the loop transformation codebase. Specifically, it corrects the handling of the
NumGeneratedLoops
variable inOMPLoopTransformationDirective
AST nodes and its inheritors (such as OMPUnrollDirective, OMPTileDirective, etc.).Previously, this variable was inaccurately set for certain transformations like reverse or tile. While this did not lead to functional bugs, since the value was only checked to determine whether it was greater than zero or equal to zero, the inconsistency could introduce problems when supporting more complex directives in the future.
@alexey-bataev , @Meinersbur