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

Properly fix ConPTY buffer corking #16793

Merged
merged 1 commit into from
Mar 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/renderer/vt/invalidate.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,10 @@ CATCH_RETURN();
// end paint to specifically handle this.
_circled = circled;

// If we flushed for any reason other than circling (i.e, a sequence that we
// didn't understand), we don't need to push the buffer out on EndPaint.
_noFlushOnEnd = !circled;

_trace.TraceTriggerCircling(*pForcePaint);
return S_OK;
}
Expand Down
14 changes: 13 additions & 1 deletion src/renderer/vt/paint.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,19 @@ using namespace Microsoft::Console::Types;
RETURN_IF_FAILED(_MoveCursor(_deferredCursorPos));
}

_Flush();
// If this frame was triggered because we encountered a VT sequence which
// required the buffered state to get printed, we don't want to flush this
// frame to the pipe. That might result in us rendering half the output of a
// particular frame (as emitted by the client).
//
// Instead, we'll leave this frame in _buffer, and just keep appending to
// it as needed.
if (!_noFlushOnEnd)
{
_Flush();
}

_noFlushOnEnd = false;
return S_OK;
}

Expand Down
19 changes: 17 additions & 2 deletions src/renderer/vt/state.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -136,10 +136,19 @@ CATCH_RETURN();

void VtEngine::_Flush() noexcept
{
if (!_corked && !_buffer.empty())
if (_buffer.empty())
{
return;
}

if (!_corked)
{
_flushImpl();
return;
}

// Defer the flush until someone calls Cork(false).
_flushRequested = true;
}

// _corked is often true and separating _flushImpl() out allows _flush() to be inlined.
Expand Down Expand Up @@ -167,7 +176,13 @@ void VtEngine::_flushImpl() noexcept
void VtEngine::Cork(bool corked) noexcept
{
_corked = corked;
_Flush();

// Now do the deferred flush from a previous call to _Flush().
if (!corked && _flushRequested)
{
_flushRequested = false;
_flushImpl();
}
}

// Method Description:
Expand Down
2 changes: 2 additions & 0 deletions src/renderer/vt/vtrenderer.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,9 @@ namespace Microsoft::Console::Render

bool _resizeQuirk{ false };
bool _passthrough{ false };
bool _noFlushOnEnd{ false };
bool _corked{ false };
bool _flushRequested{ false };
std::optional<TextColor> _newBottomLineBG{ std::nullopt };

[[nodiscard]] HRESULT _WriteFill(const size_t n, const char c) noexcept;
Expand Down
Loading