bcbb212df7
Wide use of CMake 3.28.{1,0[-rcN]} has uncovered some hangs and crashes
in libuv SIGCHLD handling on some platforms, particularly in virtualization
environments on macOS hosts. Although the bug does not seem to be in CMake,
we can restore stability in the CMake 3.28 release series for users of such
platforms by reverting our new uses of libuv for process execution.
Revert implementation changes merged by commit 4771544386 (Merge topic
'replace-cmsysprocess-with-cmuvprocesschain', 2023-09-06, v3.28.0-rc1~138),
but keep test suite updates.
Issue: #25414, #25500, #25562, #25589
90 lines
2.6 KiB
C++
90 lines
2.6 KiB
C++
/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
|
|
file Copyright.txt or https://cmake.org/licensing for details. */
|
|
#pragma once
|
|
|
|
#include "cmConfigure.h" // IWYU pragma: keep
|
|
|
|
#include <cstring>
|
|
#include <iosfwd>
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
#include "cmProcessOutput.h"
|
|
#include "cmUVProcessChain.h"
|
|
|
|
/** \class cmProcessTools
|
|
* \brief Helper classes for process output parsing
|
|
*
|
|
*/
|
|
class cmProcessTools
|
|
{
|
|
public:
|
|
using Encoding = cmProcessOutput::Encoding;
|
|
/** Abstract interface for process output parsers. */
|
|
class OutputParser
|
|
{
|
|
public:
|
|
/** Process the given output data from a tool. Processing may be
|
|
done incrementally. Returns true if the parser is interested
|
|
in any more data and false if it is done. */
|
|
bool Process(const char* data, int length)
|
|
{
|
|
return this->ProcessChunk(data, length);
|
|
}
|
|
bool Process(const char* data)
|
|
{
|
|
return this->Process(data, static_cast<int>(strlen(data)));
|
|
}
|
|
|
|
virtual ~OutputParser() = default;
|
|
|
|
protected:
|
|
/** Implement in a subclass to process a chunk of data. It should
|
|
return true only if it is interested in more data. */
|
|
virtual bool ProcessChunk(const char* data, int length) = 0;
|
|
};
|
|
|
|
/** Process output parser that extracts one line at a time. */
|
|
class LineParser : public OutputParser
|
|
{
|
|
public:
|
|
/** Construct with line separation character and choose whether to
|
|
ignore carriage returns. */
|
|
LineParser(char sep = '\n', bool ignoreCR = true);
|
|
|
|
/** Configure logging of lines as they are extracted. */
|
|
void SetLog(std::ostream* log, const char* prefix);
|
|
|
|
protected:
|
|
std::ostream* Log = nullptr;
|
|
const char* Prefix = nullptr;
|
|
std::string Line;
|
|
char Separator;
|
|
char LineEnd = '\0';
|
|
bool IgnoreCR;
|
|
bool ProcessChunk(const char* data, int length) override;
|
|
|
|
/** Implement in a subclass to process one line of input. It
|
|
should return true only if it is interested in more data. */
|
|
virtual bool ProcessLine() = 0;
|
|
};
|
|
|
|
/** Trivial line handler for simple logging. */
|
|
class OutputLogger : public LineParser
|
|
{
|
|
public:
|
|
OutputLogger(std::ostream& log, const char* prefix = nullptr)
|
|
{
|
|
this->SetLog(&log, prefix);
|
|
}
|
|
|
|
private:
|
|
bool ProcessLine() override { return true; }
|
|
};
|
|
|
|
/** Run a process and send output to given parsers. */
|
|
static std::vector<cmUVProcessChain::Status> RunProcess(
|
|
cmUVProcessChainBuilder& builder, OutputParser* out,
|
|
OutputParser* err = nullptr, Encoding encoding = cmProcessOutput::Auto);
|
|
};
|