c0ab9cb5b5
Until there's a "Wait", there's usually only one API message inflight at a time. In our quest for performance, we put that single API message in charge of its own buffer management: instead of allocating buffers on the heap and deleting them later (storing pointers to them at the far corners of the earth), it would instead allocate them from small internal pools (if possible) and only heap allocate (transparently) if necessary. The pointers flung to the corners of the earth would be pointers (1) back into the API_MSG or (2) to a heap block owned by boost::small_vector. It took us months to realize that those bare pointers were being held by COOKED_READ and RAW_READ and not actually being updated when the API message was _copied_ as it was shuffled off to the background to become a "Wait" message. It turns out that it's trivially possible to crash the console by sending two API calls--one that waits and one that completes immediately--when the waiting message or the "wait completer" has a bunch of dangling pointers in it. It further turns out that some accessibility software (like JAWS) attaches directly to the console session, much like winpty and ConEmu and friends. They're trying to read out the buffer (API call!) and sometimes there's a shell waiting for input (API call!). Oops. In this commit, we fix up the message's internal pointers (in lieu of giving it a proper copy constructor; see GH-10076) and then tell the wait completion routine (which is going to be a COOKED_READ, RAW_READ, DirectRead or WriteData) about the new buffer location. This is a scoped fix that should be replaced (TODO GH-10076) with a final one after Ask mode. Retrieved from https://microsoft.visualstudio.com os.2020 OS official/rs_wdx_dxp_windev eca0875950fd3a9735662474613405e2dc06f485 References GH-10076 Fixes MSFT-33127449 Fixes GH-9692
52 lines
1.7 KiB
C++
52 lines
1.7 KiB
C++
/*++
|
|
Copyright (c) Microsoft Corporation
|
|
Licensed under the MIT license.
|
|
|
|
Module Name:
|
|
- readDataRaw.hpp
|
|
|
|
Abstract:
|
|
- This file defines the read data structure for char-reading console APIs.
|
|
- Raw reads specifically refer to when the client application just wants text data with no edit line.
|
|
- The data struct will help store context across multiple calls or in the case of a wait condition.
|
|
- Wait conditions happen pretty much only when we don't have enough text (keyboard) data to return to the client.
|
|
- This can be triggered via ReadConsole A/W and ReadFile A/W calls.
|
|
|
|
Author:
|
|
- Austin Diviness (AustDi) 1-Mar-2017
|
|
- Michael Niksa (MiNiksa) 1-Mar-2017
|
|
|
|
Revision History:
|
|
- Pulled from original authoring by Therese Stowell (ThereseS) 6-Nov-1990
|
|
- Separated from stream.h/stream.cpp (AustDi, 2017)
|
|
--*/
|
|
|
|
#pragma once
|
|
|
|
#include "readData.hpp"
|
|
|
|
class RAW_READ_DATA final : public ReadData
|
|
{
|
|
public:
|
|
RAW_READ_DATA(_In_ InputBuffer* const pInputBuffer,
|
|
_In_ INPUT_READ_HANDLE_DATA* const pInputReadHandleData,
|
|
const size_t BufferSize,
|
|
_In_ WCHAR* const BufPtr);
|
|
|
|
~RAW_READ_DATA() override;
|
|
|
|
RAW_READ_DATA(RAW_READ_DATA&&) = default;
|
|
|
|
void MigrateUserBuffersOnTransitionToBackgroundWait(const void* oldBuffer, void* newBuffer) override;
|
|
bool Notify(const WaitTerminationReason TerminationReason,
|
|
const bool fIsUnicode,
|
|
_Out_ NTSTATUS* const pReplyStatus,
|
|
_Out_ size_t* const pNumBytes,
|
|
_Out_ DWORD* const pControlKeyState,
|
|
_Out_ void* const pOutputData) override;
|
|
|
|
private:
|
|
size_t _BufferSize;
|
|
PWCHAR _BufPtr;
|
|
};
|