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

Add winpty_get_console_process_list #130

Merged
merged 3 commits into from
Oct 8, 2017
Merged
Show file tree
Hide file tree
Changes from 2 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
34 changes: 34 additions & 0 deletions src/agent/Agent.cc
Original file line number Diff line number Diff line change
Expand Up @@ -332,6 +332,9 @@ void Agent::handlePacket(ReadBuffer &packet)
// at once, we can ignore the early ones.
handleSetSizePacket(packet);
break;
case AgentMsg::GetConsoleProcessList:
handleGetConsoleProcessListPacket(packet);
break;
default:
trace("Unrecognized message, id:%d", type);
}
Expand Down Expand Up @@ -426,6 +429,37 @@ void Agent::handleSetSizePacket(ReadBuffer &packet)
writePacket(reply);
}

void Agent::handleGetConsoleProcessListPacket(ReadBuffer &packet)
{
packet.assertEof();

auto processList = std::vector<DWORD>(64);
auto processCount = GetConsoleProcessList(&processList[0], processList.size());

// The process list can change while we're trying to read it
while (processList.size() < processCount) {
// Multiplying by two caps the number of iterations
const int newSize = processList.size() * 2;
if (newSize <= processList.size()) { // Ensure we fail when new size overflows
Copy link
Owner

Choose a reason for hiding this comment

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

If this code were to overflow, processList.size() would be 0x40000000, and newSize would be -0x80000000 (i.e. INT_MIN). newSize would be greater than processList.size() because it would be converted from int to size_t for the comparison.

I'd prefer to replace "const int newSize = ... ; ... if { ... }" with:

const auto newSize = std::max<DWORD>(processList.size() * 2, processCount);

If you do, also add #include <algorithm> to the top.

Overflow shouldn't ever happen. If it somehow does, then there is one code path handling it -- std::vector::resize throws std::bad_alloc.

processCount = 0;
break;
}
processList.resize(newSize);
processCount = GetConsoleProcessList(&processList[0], processList.size());
}

if (processCount == 0) {
trace("GetConsoleProcessList failed");
}

auto reply = newPacket();
reply.putInt32(processCount);
for (DWORD i = 0; i < processCount; i++) {
reply.putInt32(processList[i]);
}
writePacket(reply);
}

void Agent::pollConinPipe()
{
const std::string newData = m_coninPipe->readAllToString();
Expand Down
1 change: 1 addition & 0 deletions src/agent/Agent.h
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ class Agent : public EventLoop, public DsrSender
void writePacket(WriteBuffer &packet);
void handleStartProcessPacket(ReadBuffer &packet);
void handleSetSizePacket(ReadBuffer &packet);
void handleGetConsoleProcessListPacket(ReadBuffer &packet);
void pollConinPipe();

protected:
Expand Down
5 changes: 5 additions & 0 deletions src/include/winpty.h
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,11 @@ WINPTY_API BOOL
winpty_set_size(winpty_t *wp, int cols, int rows,
winpty_error_ptr_t *err /*OPTIONAL*/);

/* Gets a list of processes attached to the console. */
WINPTY_API int
winpty_get_console_process_list(winpty_t *wp, int *processList, const int processCount,
winpty_error_ptr_t *err /*OPTIONAL*/);

/* Frees the winpty_t object and the OS resources contained in it. This
* call breaks the connection with the agent, which should then close its
* console, terminating the processes attached to it.
Expand Down
27 changes: 27 additions & 0 deletions src/libwinpty/winpty.cc
Original file line number Diff line number Diff line change
Expand Up @@ -935,6 +935,33 @@ winpty_set_size(winpty_t *wp, int cols, int rows,
} API_CATCH(FALSE)
}

WINPTY_API int
winpty_get_console_process_list(winpty_t *wp, int *processList, const int processCount,
winpty_error_ptr_t *err /*OPTIONAL*/) {
API_TRY {
ASSERT(wp != nullptr);
ASSERT(processList != nullptr);
LockGuard<Mutex> lock(wp->mutex);
RpcOperation rpc(*wp);
auto packet = newPacket();
packet.putInt32(AgentMsg::GetConsoleProcessList);
writePacket(*wp, packet);
auto reply = readPacket(*wp);

auto actualProcessCount = reply.getInt32();

if (actualProcessCount <= processCount) {
for (auto i = 0; i < actualProcessCount; i++) {
processList[i] = reply.getInt32();
}
}

reply.assertEof();
rpc.success();
return actualProcessCount;
} API_CATCH(0)
}

WINPTY_API void winpty_free(winpty_t *wp) {
// At least in principle, CloseHandle can fail, so this deletion can
// fail. It won't throw an exception, but maybe there's an error that
Expand Down
1 change: 1 addition & 0 deletions src/shared/AgentMsg.h
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ struct AgentMsg
enum Type {
StartProcess,
SetSize,
GetConsoleProcessList,
};
};

Expand Down