Skip to content
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

[Bugfix][fast] Fix the get_num_blocks_touched logic #6849

Merged
merged 5 commits into from
Aug 8, 2024

Conversation

zachzzc
Copy link
Contributor

@zachzzc zachzzc commented Jul 26, 2024

FILL IN THE PR DESCRIPTION HERE

FIX #xxxx (link existing issues this PR will resolve)

In the existing logics, the number of touched blocks is not calculated correctly.

  1. If the prefix caching is enabled, and the blocks are swapped out, the left-over the caches will be in the evictor group if there are no references. In the meantime, the cache blocks will be evicted, for example, 2 out of 10 cached blocks. Let's say the remaining 8 blocks in the evictor are the last available blocks in the allocator, and the sequence wants to swapped in, the free blocks will count as 8. The touched blocks is calculated as 2, which is incorrect because the cache is not shared by any other blocks. In this case the correct touched blocks should be 10, and can't swap in.

  2. In the regular case, if the lookahead slots are more than the free slots, it first need to occupy the block containing the free slots, then plus the remaining required blocks.

BEFORE SUBMITTING, PLEASE READ THE CHECKLIST BELOW AND FILL IN THE DESCRIPTION ABOVE


PR Checklist (Click to Expand)

Thank you for your contribution to vLLM! Before submitting the pull request, please ensure the PR meets the following criteria. This helps vLLM maintain the code quality and improve the efficiency of the review process.

PR Title and Classification

Only specific types of PRs will be reviewed. The PR title is prefixed appropriately to indicate the type of change. Please use one of the following:

  • [Bugfix] for bug fixes.
  • [CI/Build] for build or continuous integration improvements.
  • [Doc] for documentation fixes and improvements.
  • [Model] for adding a new model or improving an existing model. Model name should appear in the title.
  • [Frontend] For changes on the vLLM frontend (e.g., OpenAI API server, LLM class, etc.)
  • [Kernel] for changes affecting CUDA kernels or other compute kernels.
  • [Core] for changes in the core vLLM logic (e.g., LLMEngine, AsyncLLMEngine, Scheduler, etc.)
  • [Hardware][Vendor] for hardware-specific changes. Vendor name should appear in the prefix (e.g., [Hardware][AMD]).
  • [Misc] for PRs that do not fit the above categories. Please use this sparingly.

Note: If the PR spans more than one category, please include all relevant prefixes.

Code Quality

The PR need to meet the following code quality standards:

  • We adhere to Google Python style guide and Google C++ style guide.
  • Pass all linter checks. Please use format.sh to format your code.
  • The code need to be well-documented to ensure future contributors can easily understand the code.
  • Include sufficient tests to ensure the project to stay correct and robust. This includes both unit tests and integration tests.
  • Please add documentation to docs/source/ if the PR modifies the user-facing behaviors of vLLM. It helps vLLM user understand and utilize the new features or changes.

Notes for Large Changes

Please keep the changes as concise as possible. For major architectural changes (>500 LOC excluding kernel/data/config/test), we would expect a GitHub issue (RFC) discussing the technical design and justification. Otherwise, we will tag it with rfc-required and might not go through the PR.

What to Expect for the Reviews

The goal of the vLLM team is to be a transparent reviewing machine. We would like to make the review process transparent and efficient and make sure no contributor feel confused or frustrated. However, the vLLM team is small, so we need to prioritize some PRs over others. Here is what you can expect from the review process:

  • After the PR is submitted, the PR will be assigned to a reviewer. Every reviewer will pick up the PRs based on their expertise and availability.
  • After the PR is assigned, the reviewer will provide status update every 2-3 days. If the PR is not reviewed within 7 days, please feel free to ping the reviewer or the vLLM team.
  • After the review, the reviewer will put an action-required label on the PR if there are changes required. The contributor should address the comments and ping the reviewer to re-review the PR.
  • Please respond to all comments within a reasonable time frame. If a comment isn't clear or you disagree with a suggestion, feel free to ask for clarification or discuss the suggestion.

Thank You

Finally, thank you for taking the time to read these guidelines and for your interest in contributing to vLLM. Your contributions make vLLM a great tool for everyone!

Copy link

👋 Hi! Thank you for contributing to the vLLM project.
Just a reminder: PRs would not trigger full CI run by default. Instead, it would only run fastcheck CI which consists a small and essential subset of CI tests to quickly catch errors. You can run other CI tests on top of default ones by unblocking the steps in your fast-check build on Buildkite UI.

Once the PR is approved and ready to go, please make sure to run full CI as it is required to merge (or just use auto-merge).

To run full CI, you can do one of these:

  • Comment /ready on the PR
  • Add ready label to the PR
  • Enable auto-merge.

🚀

@zachzzc
Copy link
Contributor Author

zachzzc commented Jul 26, 2024

@Kaiyang-Chen @cadedaniel pls review when you have time.

@cadedaniel
Copy link
Collaborator

Thanks for the PR. Can you help me understand the impact here of this bug? e.g. what kind of incorrect swapping behavior / corrupted output.

Can we also add a unit test for the changed logic if possible? the block manager test is very high level unfortunately.

cc @Kaiyang-Chen do you have time to review this change?

@zachzzc
Copy link
Contributor Author

zachzzc commented Jul 26, 2024

Thanks for the PR. Can you help me understand the impact here of this bug? e.g. what kind of incorrect swapping behavior / corrupted output.

Hi Cade. The original problem I see is that when enable prefix caching and use swap for the preemption, the allocate_block_id raised NoFreeBlocksError with my input traces. After investigation, it is because in the _schedule_swapped function, self.block_manager.can_swap_in mistakenly returns OK due to the problem I mentioned in the description.

Can we also add a unit test for the changed logic if possible? the block manager test is very high level unfortunately.

sure I can add smaller tests for the prefix_caching_block and native blocks

@cadedaniel
Copy link
Collaborator

lmk when it's ready for review @zachzzc

@zachzzc
Copy link
Contributor Author

zachzzc commented Jul 31, 2024

lmk when it's ready for review @zachzzc

Yes it is ready for review @cadedaniel

Copy link
Collaborator

@cadedaniel cadedaniel left a comment

Choose a reason for hiding this comment

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

Looks good, small comments

tests/core/block/test_naive_block.py Outdated Show resolved Hide resolved
tests/core/block/test_prefix_caching_block.py Outdated Show resolved Hide resolved
Copy link
Contributor

@Kaiyang-Chen Kaiyang-Chen left a comment

Choose a reason for hiding this comment

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

Generally LGTM. Two small comments.

assert allocator_dst.get_num_blocks_touched(
src_blocks, num_lookahead_slots=1) == num_blocks
assert allocator_dst.get_num_blocks_touched(
src_blocks, num_lookahead_slots=block_size - 1) == num_blocks
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we make num_lookahead_slots a test parameter to follow the convention here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The three lookahead situations are block_size dependent here, I think it is more straightforward to leave it this way.

tests/core/block/test_prefix_caching_block.py Outdated Show resolved Hide resolved
Copy link
Collaborator

@cadedaniel cadedaniel left a comment

Choose a reason for hiding this comment

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

LGTM, can merge once @Kaiyang-Chen 's comments are addressed

@cadedaniel cadedaniel enabled auto-merge (squash) August 8, 2024 17:42
@github-actions github-actions bot added the ready ONLY add when PR is ready to merge/full CI is needed label Aug 8, 2024
@cadedaniel
Copy link
Collaborator

@simon-mo can we get a force merge here

@simon-mo simon-mo disabled auto-merge August 8, 2024 17:43
@simon-mo simon-mo merged commit 782e53a into vllm-project:main Aug 8, 2024
29 of 34 checks passed
@simon-mo
Copy link
Collaborator

simon-mo commented Aug 8, 2024

🫡

@cadedaniel
Copy link
Collaborator

thanks for the contribution @zachzzc !

@zachzzc zachzzc deleted the fix_touched_blocks branch August 8, 2024 18:46
sfc-gh-mkeralapura pushed a commit to sfc-gh-mkeralapura/vllm that referenced this pull request Aug 12, 2024
kylesayrs pushed a commit to neuralmagic/vllm that referenced this pull request Aug 17, 2024
fialhocoelho pushed a commit to opendatahub-io/vllm that referenced this pull request Aug 22, 2024
Alvant pushed a commit to compressa-ai/vllm that referenced this pull request Oct 26, 2024
KuntaiDu pushed a commit to KuntaiDu/vllm that referenced this pull request Nov 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready ONLY add when PR is ready to merge/full CI is needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants