Skip to content

Add preference to disable LoopVectorization #2295

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

Merged
merged 1 commit into from
May 23, 2025
Merged

Add preference to disable LoopVectorization #2295

merged 1 commit into from
May 23, 2025

Conversation

vchuravy
Copy link
Member

Enzyme struggles with differentiation through the code that LoopVectorization
generates.

https://docs.sciml.ai/SciMLSensitivity/stable/faq/#How-do-I-isolate-potential-gradient-issues-and-improve-performance?

Is a good way to check if an Elixir's rhs is differentiable.
I ran into this when playing around with https://github.com/trixi-framework/Trixi.jl/blob/31e3c8fee15d9955af8c7c6a64e3bfcfea1c3e94/examples/p4est_2d_dgsem/elixir_navierstokes_NACA0012airfoil_mach08.jl and SciMLSensitivity.jl

Copy link
Contributor

Review checklist

This checklist is meant to assist creators of PRs (to let them know what reviewers will typically look for) and reviewers (to guide them in a structured review process). Items do not need to be checked explicitly for a PR to be eligible for merging.

Purpose and scope

  • The PR has a single goal that is clear from the PR title and/or description.
  • All code changes represent a single set of modifications that logically belong together.
  • No more than 500 lines of code are changed or there is no obvious way to split the PR into multiple PRs.

Code quality

  • The code can be understood easily.
  • Newly introduced names for variables etc. are self-descriptive and consistent with existing naming conventions.
  • There are no redundancies that can be removed by simple modularization/refactoring.
  • There are no leftover debug statements or commented code sections.
  • The code adheres to our conventions and style guide, and to the Julia guidelines.

Documentation

  • New functions and types are documented with a docstring or top-level comment.
  • Relevant publications are referenced in docstrings (see example for formatting).
  • Inline comments are used to document longer or unusual code sections.
  • Comments describe intent ("why?") and not just functionality ("what?").
  • If the PR introduces a significant change or new feature, it is documented in NEWS.md with its PR number.

Testing

  • The PR passes all tests.
  • New or modified lines of code are covered by tests.
  • New or modified tests run in less then 10 seconds.

Performance

  • There are no type instabilities or memory allocations in performance-critical parts.
  • If the PR intent is to improve performance, before/after time measurements are posted in the PR.

Verification

  • The correctness of the code was verified using appropriate tests.
  • If new equations/methods are added, a convergence test has been run and the results
    are posted in the PR.

Created with ❤️ by the Trixi.jl community.

Copy link

codecov bot commented Feb 20, 2025

Codecov Report

Attention: Patch coverage is 16.66667% with 10 lines in your changes missing coverage. Please review.

Project coverage is 96.93%. Comparing base (8c4cd80) to head (3887269).
Report is 2 commits behind head on main.

Files with missing lines Patch % Lines
src/auxiliary/mock_turbo.jl 0.00% 6 Missing ⚠️
src/auxiliary/math.jl 0.00% 3 Missing ⚠️
src/callbacks_step/summary.jl 50.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2295      +/-   ##
==========================================
- Coverage   96.95%   96.93%   -0.02%     
==========================================
  Files         504      505       +1     
  Lines       41721    41732      +11     
==========================================
+ Hits        40448    40449       +1     
- Misses       1273     1283      +10     
Flag Coverage Δ
unittests 96.93% <16.67%> (-0.02%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Member

@sloede sloede left a comment

Choose a reason for hiding this comment

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

Very nice! Just a small naming suggestion...

ranocha
ranocha previously approved these changes Feb 21, 2025
@ranocha
Copy link
Member

ranocha commented Feb 21, 2025

ranocha
ranocha previously approved these changes Feb 21, 2025
src/Trixi.jl Outdated
Comment on lines 74 to 77
# TODO: We should insert !loopinfo !julia.ivdep !julia.simd
# but SimdLoop.compile doesn't deal with nested for loops.
# esc(Base.SimdLoop.compile(body, Symbol("julia.ivdep")))
return esc(body)
Copy link
Member Author

Choose a reason for hiding this comment

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

I believe @turbo also implies @inbounds. Right now this slows down simulations quite a bit.

Copy link
Member

Choose a reason for hiding this comment

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

Yes, it does.

Copy link
Member

Choose a reason for hiding this comment

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

Shall we go ahead with this PR as it is or would you like to change something?

Copy link
Member

Choose a reason for hiding this comment

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

What kind of simulations do you look at to observe the significant slowdown?

Copy link
Member Author

Choose a reason for hiding this comment

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

@vchuravy
Copy link
Member Author

@ranocha this is ready from my side.

@vchuravy vchuravy requested a review from ranocha May 19, 2025 12:39
Copy link
Member

@ranocha ranocha left a comment

Choose a reason for hiding this comment

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

Thanks! Did you test this locally?

@vchuravy
Copy link
Member Author

Did you test this locally?

Only for my implicit example I mentioned earlier today.

@huiyuxie
Copy link
Member

┌ Warning: #= C:\Users\huiyu\.julia\packages\Trixi\kIdT5\src\solvers\dgsem\interpolation.jl:118 =#:
│ `LoopVectorization.check_args` on your inputs failed; running fallback `@inbounds @fastmath` loop instead.
│ Use `warn_check_args=false`, e.g. `@turbo warn_check_args=false ...`, to disable this warning.
└ @ Trixi C:\Users\huiyu\.julia\packages\LoopVectorization\tIJUA\src\condense_loopset.jl:1166

Does this often happen when running examples from Trixi.jl or is it just a rare warning?

@ranocha
Copy link
Member

ranocha commented May 20, 2025

This is a rare warning that you may get if you use "unusual types" (like rational numbers or types from Measurements jl) or array types that are not supported by LoopVectorization.jl (like GPU arrays).

Copy link
Member

@ranocha ranocha left a comment

Choose a reason for hiding this comment

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

Thanks

@ranocha
Copy link
Member

ranocha commented May 20, 2025

Do you have an idea why the threaded CI tests fail?

@ranocha ranocha merged commit a66a18f into main May 23, 2025
38 of 40 checks passed
@ranocha ranocha deleted the vc/turbo branch May 23, 2025 15:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants