[Misc][ROCm] Enforce no unused variable in ROCm C++ files #19796
Conversation
Signed-off-by: Lu Fang <lufang@fb.com>
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @houseroad, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request aims to enhance code quality for ROCm C++ files by enforcing a compiler error for unused variables. By adding a specific compiler flag, the build process will now fail if any unused variables are detected, promoting cleaner and more maintainable code.
Highlights
- Compiler Configuration: I've updated the
cmake/utils.cmakefile to add the-Werror=unused-variableflag to the ROCm C++ compiler flags. This change will ensure that any unused variables in ROCm C++ code will now be treated as compilation errors, enforcing stricter code quality.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
|
👋 Hi! Thank you for contributing to the vLLM project. 💬 Join our developer Slack at https://slack.vllm.ai to discuss your PR in #pr-reviews, coordinate on features in #feat- channels, or join special interest groups in #sig- channels. Just a reminder: PRs would not trigger full CI run by default. Instead, it would only run Once the PR is approved and ready to go, your PR reviewer(s) can run CI to test the changes comprehensively before merging. To run CI, PR reviewers can either: Add 🚀 |
houseroad
changed the title
There was a problem hiding this comment.
Code Review
This pull request proposes adding the -Werror=unused-variable compiler flag for ROCm (HIP) C++ builds. This is a positive change for code quality, as it will help prevent dead code and improve maintainability by ensuring that all declared variables are utilized.
The primary concern with this change is the current lack of a test plan and results, as indicated in the PR description. Introducing a new error-level compiler flag can lead to build failures if the codebase currently contains unused variables. It's essential to thoroughly test this change across all ROCm build configurations and address any resulting compilation errors before merging. This will ensure the stability of the build and a smooth transition for developers.
| @@ -122,6 +122,7 @@ function (get_torch_gpu_compiler_flags OUT_GPU_FLAGS GPU_LANG) | |||
| "-DENABLE_FP8" | |||
| "-U__HIP_NO_HALF_CONVERSIONS__" | |||
| "-U__HIP_NO_HALF_OPERATORS__" | |||
| "-Werror=unused-variable" | |||
There was a problem hiding this comment.
Adding -Werror=unused-variable is a good step towards improving code quality and maintainability for ROCm builds by ensuring no variables are declared and left unused.
However, introducing a flag that turns warnings into errors can potentially break the build if there are existing instances of unused variables in the ROCm C++ codebase. The pull request description indicates that the Test Plan and Test Results are still 'TODO'.
It's crucial to:
- Run a full build for ROCm targets with this flag enabled.
- Identify and fix any build errors caused by this new flag. This might involve removing the unused variables or annotating them with
[[maybe_unused]]if they are intentionally unused for a valid reason (e.g., future use, conditional compilation). - Update the pull request description with the test plan executed and the results, confirming that the codebase compiles cleanly with this enforcement.
Without this validation, merging this change risks disrupting the development workflow for anyone building for ROCm.
There was a problem hiding this comment.
Verified with the local building.
houseroad
requested review from
Alexei-V-Ivanov-AMD,
tlrmchlsmth,
mgoin,
yeqcharlotte,
hongxiayang and
22quinn
|
Yes, I plan to start with AMD GPU csrc first, since it caused the issues before. I will gradually increase the coverage to more csrc files. |
…ct#19796) Signed-off-by: Lu Fang <lufang@fb.com>
…ct#19796) Signed-off-by: Lu Fang <lufang@fb.com> Signed-off-by: minpeter <kali2005611@gmail.com>
…ct#19796) Signed-off-by: Lu Fang <lufang@fb.com>
Essential Elements of an Effective PR Description Checklist
supported_models.mdandexamplesfor a new model.Purpose
Ensure there is no unused variable in the ROCm C++ files. Follow up of #19609
Test Plan
Local test
python setup.py develop
Test Result
[Expect to fail and failed] With some unused variable ttt
/home/lufang/gitrepos/vllm/build/temp.linux-x86_64-cpython-310/csrc/rocm/attention.hip:3521:7: error: unused variable 'ttt' [-Werror,-Wunused-variable]
3521 | int ttt = 0;
[Expect to build and built] Without unused variables
Using /home/lufang/gitrepos/vllm/.venv/lib/python3.10/site-packages
Finished processing dependencies for vllm==0.9.2.dev137+g3c0e9e7cb.rocm631
(Optional) Documentation Update
N/A