mirror of
https://github.com/Kitware/CMake.git
synced 2026-08-09 09:12:00 +00:00
194232e2bc
The POSIX pipe read wrappers stored the return of ::read() into an unsigned result, so a negative count (e.g. EBADF from a concurrent close on another thread) became SIZE_MAX. ContentReader::buffer() would then try to grow its deque by ~18 exabytes and crash with either std::length_error (glibc) or a stack smash (libc++). Treat any non-positive ::read() return as EOF/error, close the pipe, and return 0 so the peer's SessionThread observes a clean empty payload. cmDebuggerPipeClient is test-only infrastructure; production cmake is always the pipe server. Production close() assumes sequential access, which holds in normal use (the adapter destructor joins SessionThread before closing the connection). The new abrupt- disconnect test however needs to wake a sibling thread blocked in read() on the same fd, which Linux ::close() does not do. Add a ShutdownForTesting() method that calls shutdown(SHUT_RDWR) without freeing the fd, so any concurrent blocking read wakes with a clean zero-length return. On Windows, CloseHandle already cancels pending overlapped I/O, so the helper just forwards to close(). Use it from testProtocolWithPipesAbruptDisconnect in place of close().
109 lines
2.6 KiB
C++
109 lines
2.6 KiB
C++
/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
|
|
file LICENSE.rst or https://cmake.org/licensing for details. */
|
|
#pragma once
|
|
|
|
#include "cmConfigure.h" // IWYU pragma: keep
|
|
|
|
#include <condition_variable>
|
|
#include <cstddef>
|
|
#include <future>
|
|
#include <memory>
|
|
#include <mutex>
|
|
#include <string>
|
|
#include <thread>
|
|
|
|
#include <windows.h>
|
|
|
|
#include <cm3p/cppdap/io.h>
|
|
|
|
#include "cmDebuggerAdapter.h"
|
|
|
|
namespace cmDebugger {
|
|
|
|
#ifdef _WIN32
|
|
|
|
class DuplexPipe_WIN32
|
|
{
|
|
public:
|
|
DuplexPipe_WIN32(HANDLE read);
|
|
~DuplexPipe_WIN32();
|
|
|
|
void close();
|
|
size_t read(void* buffer, size_t n);
|
|
bool write(void const* buffer, size_t n);
|
|
|
|
bool WaitForConnection();
|
|
|
|
private:
|
|
HANDLE hPipe;
|
|
OVERLAPPED readOp;
|
|
OVERLAPPED writeOp;
|
|
};
|
|
|
|
class cmDebuggerPipeConnection_WIN32
|
|
: public dap::ReaderWriter
|
|
, public cmDebuggerConnection
|
|
, public std::enable_shared_from_this<cmDebuggerPipeConnection_WIN32>
|
|
{
|
|
public:
|
|
cmDebuggerPipeConnection_WIN32(std::string name);
|
|
~cmDebuggerPipeConnection_WIN32() override;
|
|
|
|
void WaitForConnection() override;
|
|
|
|
bool StartListening(std::string& errorMessage) override;
|
|
std::shared_ptr<dap::Reader> GetReader() override;
|
|
std::shared_ptr<dap::Writer> GetWriter() override;
|
|
|
|
// dap::ReaderWriter implementation
|
|
|
|
bool isOpen() override;
|
|
void close() override;
|
|
size_t read(void* buffer, size_t n) override;
|
|
bool write(void const* buffer, size_t n) override;
|
|
|
|
// Used for unit test synchronization
|
|
std::promise<void> StartedListening;
|
|
|
|
private:
|
|
void CloseConnection();
|
|
std::string GetErrorMessage(DWORD errorCode);
|
|
|
|
std::string const PipeName;
|
|
std::unique_ptr<DuplexPipe_WIN32> pipes;
|
|
};
|
|
|
|
using cmDebuggerPipeConnection = cmDebuggerPipeConnection_WIN32;
|
|
|
|
class cmDebuggerPipeClient_WIN32
|
|
: public dap::ReaderWriter
|
|
, public std::enable_shared_from_this<cmDebuggerPipeClient_WIN32>
|
|
{
|
|
public:
|
|
cmDebuggerPipeClient_WIN32(std::string name);
|
|
~cmDebuggerPipeClient_WIN32();
|
|
void WaitForConnection();
|
|
|
|
bool isOpen() override;
|
|
void close() override;
|
|
size_t read(void* buffer, size_t n) override;
|
|
bool write(void const* buffer, size_t n) override;
|
|
|
|
// Unit-test helper: on Windows CloseHandle already cancels any
|
|
// pending overlapped I/O, so this just delegates to close().
|
|
// Production code does not use cmDebuggerPipeClient.
|
|
void ShutdownForTesting() { this->close(); }
|
|
|
|
private:
|
|
std::string GetErrorMessage(DWORD errorCode);
|
|
|
|
std::string const PipeName;
|
|
std::unique_ptr<DuplexPipe_WIN32> pipes;
|
|
};
|
|
|
|
using cmDebuggerPipeClient = cmDebuggerPipeClient_WIN32;
|
|
|
|
#endif // _WIN32
|
|
|
|
} // namespace cmDebugger
|