winpty/agent/LargeConsoleRead.cc
Ryan Prichard 3b73576ab9 Consolidate console read API calls.
* Instead of reading the output line-by-line, figure out what lines we
   need ahead-of-time and issue as few read calls as possible.  On Windows
   8 and up, we issue just one read call.  On earlier versions, we avoid
   reading more than a certain amount.

 * This change reduces the CPU usage.  e.g. In my Windows 10 VM, the idle
   CPU usage of winpty-agent.exe+conhost.exe combined, with an empty
   console, dropped from ~3.6% to ~1.4%.  In a Windows 7 VM, I measured a
   reduction of CPU from ~1.6% to 0.6%.

 * Increase the MAX_CONSOLE_WIDTH from 500 to 2500.  The limiting factor
   now is that LargeConsoleRead reads at least one line at a line, but we
   don't want to read more than 2500 characters in one call on old operating
   systems.

 * Fix the attribute handling in scanForDirtyLines.  (The assignment to
   newAttr was dead.)

The 2500 limit is arbitrary and could probably be increased.  The actual
hard limit depends on the OS and is around 17000.  My understanding is that
the limit is based upon the need to allocate I/O buffers within a shared
64KiB heap, and I'm worried about heap fragmentation.  I know that 2500
is safe, because winpty has been issuing reads of almost 3000 characters
already to find the sync marker.

Fixes https://github.com/rprichard/winpty/issues/44
2015-10-16 15:26:45 -05:00

66 lines
1.9 KiB
C++
Executable File

#include "LargeConsoleRead.h"
#include <stdlib.h>
#include "Agent.h"
#include "Win32Console.h"
namespace {
// Returns true if the OS version is at least Windows 8 (6.2). This function
// should work correctly regardless of how the executable is manifested.
static bool isWindows8OrGreater() {
OSVERSIONINFO info = {0};
info.dwOSVersionInfoSize = sizeof(info);
if (!GetVersionEx(&info)) {
return false;
}
if (info.dwMajorVersion > 6) {
return true;
}
if (info.dwMajorVersion < 6) {
return false;
}
return info.dwMinorVersion >= 2;
}
} // anonymous namespace
LargeConsoleReadBuffer::LargeConsoleReadBuffer() :
m_rect(0, 0, 0, 0), m_rectWidth(0)
{
}
void largeConsoleRead(LargeConsoleReadBuffer &out,
Win32Console &console,
const SmallRect &readArea) {
ASSERT(readArea.Left >= 0 &&
readArea.Top >= 0 &&
readArea.Right >= readArea.Left &&
readArea.Bottom >= readArea.Top &&
readArea.width() <= MAX_CONSOLE_WIDTH);
const size_t count = readArea.width() * readArea.height();
if (out.m_data.size() < count) {
out.m_data.resize(count);
}
out.m_rect = readArea;
out.m_rectWidth = readArea.width();
static const bool useLargeReads = isWindows8OrGreater();
if (useLargeReads) {
console.read(readArea, out.m_data.data());
} else {
const int maxReadLines = std::max(1, MAX_CONSOLE_WIDTH / readArea.width());
int curLine = readArea.Top;
while (curLine <= readArea.Bottom) {
const SmallRect subReadArea(
readArea.Left,
curLine,
readArea.width(),
std::min(maxReadLines, readArea.Bottom + 1 - curLine));
console.read(subReadArea, out.lineDataMut(curLine));
curLine = subReadArea.Bottom + 1;
}
}
}