Fix a sixel crash when the buffer is reflowed #17951
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
microsoft-github-policy-service
bot
added
the
Issue-Bug
j4james
force-pushed
the
fix-sixel-crash
branch
from
8ed4cc0
to
4632707
Compare
lhecker
approved these changes
Sep 23, 2024
DHowett
pushed a commit
that referenced
this pull request
Sep 24, 2024
## Summary of the Pull Request The sixel parser has an internal buffer that holds the indexed-color representation of the image, prior to it being translated to RGB. This buffer only retains the section of the image that is within the visible viewport, so we're continually erasing segments from the top of it when the image is large enough to trigger a scroll. But there is a problem that arises if the window or font is resized so that the buffer needs to reflow, because that can result in the image being pushed entirely offscreen. At that point the segment we're trying to erase is actually larger than the buffer itself, which can end up causing the terminal to crash To fix this, we just need to check for an oversized erase attempt and simply clear the buffer instead. ## Validation Steps Performed I could easily reproduce this crash in Windows Terminal by resizing the font while viewing an animated gif with img2sixel. With this PR applied the crash no longer occurs. ## PR Checklist - [x] Closes #17947 (cherry picked from commit fc586e2) Service-Card-Id: PVTI_lADOAF3p4s4AmhmQzgTTKv4 Service-Version: 1.22
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary of the Pull Request
The sixel parser has an internal buffer that holds the indexed-color
representation of the image, prior to it being translated to RGB. This
buffer only retains the section of the image that is within the visible
viewport, so we're continually erasing segments from the top of it when
the image is large enough to trigger a scroll.
But there is a problem that arises if the window or font is resized so
that the buffer needs to reflow, because that can result in the image
being pushed entirely offscreen. At that point the segment we're trying
to erase is actually larger than the buffer itself, which can end up
causing the terminal to crash
To fix this, we just need to check for an oversized erase attempt and
simply clear the buffer instead.
Validation Steps Performed
I could easily reproduce this crash in Windows Terminal by resizing the
font while viewing an animated gif with img2sixel. With this PR applied
the crash no longer occurs.
PR Checklist