Hash :
113f847b
Author :
Date :
2023-06-26T12:07:52
centralize basic OS/platform detection functions We had multiple different places that defined these, and with varying naming schemes. Centralize them to be defined in platform_helpers.h. Also renaming the IsApple(uint32_t) functions to IsAppleGPU(uint32_t) to avoid ambiguous meaning: "IsApple" should mean "is Apple-vended OS" while "IsAppleGPU" should mean "is Apple GPU vendor ID". Bug: angleproject:8229 Change-Id: If4e3fc5ac1b5b8ad416663950a1b2ee912ccad99 Reviewed-on: https://chromium-review.googlesource.com/c/angle/angle/+/4647291 Reviewed-by: Shahbaz Youssefi <syoussefi@chromium.org> Reviewed-by: Steven Noonan <steven@uplinklabs.net> Auto-Submit: Steven Noonan <steven@uplinklabs.net> Reviewed-by: Roman Lavrov <romanl@google.com> Commit-Queue: Shahbaz Youssefi <syoussefi@chromium.org>
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444
//
// Copyright 2014 The ANGLE Project Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
//
// test_utils_win.cpp: Implementation of OS-specific functions for Windows
#include "util/test_utils.h"
#include <aclapi.h>
#include <stdarg.h>
#include <windows.h>
#include <array>
#include <iostream>
#include <vector>
#include "anglebase/no_destructor.h"
#include "common/angleutils.h"
#include "common/platform_helpers.h"
namespace angle
{
namespace
{
struct ScopedPipe
{
~ScopedPipe()
{
closeReadHandle();
closeWriteHandle();
}
bool closeReadHandle()
{
if (readHandle)
{
if (::CloseHandle(readHandle) == FALSE)
{
std::cerr << "Error closing write handle: " << GetLastError();
return false;
}
readHandle = nullptr;
}
return true;
}
bool closeWriteHandle()
{
if (writeHandle)
{
if (::CloseHandle(writeHandle) == FALSE)
{
std::cerr << "Error closing write handle: " << GetLastError();
return false;
}
writeHandle = nullptr;
}
return true;
}
bool valid() const { return readHandle != nullptr || writeHandle != nullptr; }
bool initPipe(SECURITY_ATTRIBUTES *securityAttribs)
{
if (::CreatePipe(&readHandle, &writeHandle, securityAttribs, 0) == FALSE)
{
std::cerr << "Error creating pipe: " << GetLastError() << "\n";
return false;
}
#if !defined(ANGLE_ENABLE_WINDOWS_UWP)
// Ensure the read handles to the pipes are not inherited.
if (::SetHandleInformation(readHandle, HANDLE_FLAG_INHERIT, 0) == FALSE)
{
std::cerr << "Error setting handle info on pipe: " << GetLastError() << "\n";
return false;
}
#endif // !defined(ANGLE_ENABLE_WINDOWS_UWP)
return true;
}
HANDLE readHandle = nullptr;
HANDLE writeHandle = nullptr;
};
// Returns false on EOF or error.
void ReadFromFile(bool blocking, HANDLE handle, std::string *out)
{
char buffer[8192];
DWORD bytesRead = 0;
while (true)
{
if (!blocking)
{
BOOL success = ::PeekNamedPipe(handle, nullptr, 0, nullptr, &bytesRead, nullptr);
if (success == FALSE || bytesRead == 0)
return;
}
BOOL success = ::ReadFile(handle, buffer, sizeof(buffer), &bytesRead, nullptr);
if (success == FALSE || bytesRead == 0)
return;
out->append(buffer, bytesRead);
}
// unreachable.
}
// Returns the Win32 last error code or ERROR_SUCCESS if the last error code is
// ERROR_FILE_NOT_FOUND or ERROR_PATH_NOT_FOUND. This is useful in cases where
// the absence of a file or path is a success condition (e.g., when attempting
// to delete an item in the filesystem).
bool ReturnSuccessOnNotFound()
{
const DWORD error_code = ::GetLastError();
return (error_code == ERROR_FILE_NOT_FOUND || error_code == ERROR_PATH_NOT_FOUND);
}
// Job objects seems to have problems on the Chromium CI and Windows 7.
bool ShouldUseJobObjects()
{
#if defined(ANGLE_ENABLE_WINDOWS_UWP)
return false;
#else
return IsWindows10OrLater();
#endif
}
class WindowsProcess : public Process
{
public:
WindowsProcess(const std::vector<const char *> &commandLineArgs,
ProcessOutputCapture captureOutput)
{
mProcessInfo.hProcess = INVALID_HANDLE_VALUE;
mProcessInfo.hThread = INVALID_HANDLE_VALUE;
std::vector<char> commandLineString;
for (const char *arg : commandLineArgs)
{
if (arg)
{
if (!commandLineString.empty())
{
commandLineString.push_back(' ');
}
commandLineString.insert(commandLineString.end(), arg, arg + strlen(arg));
}
}
commandLineString.push_back('\0');
// Set the bInheritHandle flag so pipe handles are inherited.
SECURITY_ATTRIBUTES securityAttribs;
securityAttribs.nLength = sizeof(SECURITY_ATTRIBUTES);
securityAttribs.bInheritHandle = TRUE;
securityAttribs.lpSecurityDescriptor = nullptr;
STARTUPINFOA startInfo = {};
const bool captureStdout = captureOutput != ProcessOutputCapture::Nothing;
const bool captureStderr =
captureOutput == ProcessOutputCapture::StdoutAndStderrInterleaved ||
captureOutput == ProcessOutputCapture::StdoutAndStderrSeparately;
const bool pipeStderrToStdout =
captureOutput == ProcessOutputCapture::StdoutAndStderrInterleaved;
// Create pipes for stdout and stderr.
startInfo.cb = sizeof(STARTUPINFOA);
startInfo.hStdInput = ::GetStdHandle(STD_INPUT_HANDLE);
if (captureStdout)
{
if (!mStdoutPipe.initPipe(&securityAttribs))
{
return;
}
startInfo.hStdOutput = mStdoutPipe.writeHandle;
}
else
{
startInfo.hStdOutput = ::GetStdHandle(STD_OUTPUT_HANDLE);
}
if (pipeStderrToStdout)
{
startInfo.hStdError = startInfo.hStdOutput;
}
else if (captureStderr)
{
if (!mStderrPipe.initPipe(&securityAttribs))
{
return;
}
startInfo.hStdError = mStderrPipe.writeHandle;
}
else
{
startInfo.hStdError = ::GetStdHandle(STD_ERROR_HANDLE);
}
#if !defined(ANGLE_ENABLE_WINDOWS_UWP)
if (captureStdout || captureStderr)
{
startInfo.dwFlags |= STARTF_USESTDHANDLES;
}
if (ShouldUseJobObjects())
{
// Create job object. Job objects allow us to automatically force child processes to
// exit if the parent process is unexpectedly killed. This should prevent ghost
// processes from hanging around.
mJobHandle = ::CreateJobObjectA(nullptr, nullptr);
if (mJobHandle == NULL)
{
std::cerr << "Error creating job object: " << GetLastError() << "\n";
return;
}
JOBOBJECT_EXTENDED_LIMIT_INFORMATION limitInfo = {};
limitInfo.BasicLimitInformation.LimitFlags = JOB_OBJECT_LIMIT_KILL_ON_JOB_CLOSE;
if (::SetInformationJobObject(mJobHandle, JobObjectExtendedLimitInformation, &limitInfo,
sizeof(limitInfo)) == FALSE)
{
std::cerr << "Error setting job information: " << GetLastError() << "\n";
return;
}
}
#endif // !defined(ANGLE_ENABLE_WINDOWS_UWP)
// Create the child process.
if (::CreateProcessA(nullptr, commandLineString.data(), nullptr, nullptr,
TRUE, // Handles are inherited.
0, nullptr, nullptr, &startInfo, &mProcessInfo) == FALSE)
{
std::cerr << "CreateProcessA Error code: " << GetLastError() << "\n";
return;
}
#if !defined(ANGLE_ENABLE_WINDOWS_UWP)
if (mJobHandle != nullptr)
{
if (::AssignProcessToJobObject(mJobHandle, mProcessInfo.hProcess) == FALSE)
{
std::cerr << "AssignProcessToJobObject failed: " << GetLastError() << "\n";
return;
}
}
#endif // !defined(ANGLE_ENABLE_WINDOWS_UWP)
// Close the write end of the pipes, so EOF can be generated when child exits.
if (!mStdoutPipe.closeWriteHandle() || !mStderrPipe.closeWriteHandle())
return;
mStarted = true;
mTimer.start();
}
~WindowsProcess() override
{
if (mProcessInfo.hProcess != INVALID_HANDLE_VALUE)
{
::CloseHandle(mProcessInfo.hProcess);
}
if (mProcessInfo.hThread != INVALID_HANDLE_VALUE)
{
::CloseHandle(mProcessInfo.hThread);
}
if (mJobHandle != nullptr)
{
::CloseHandle(mJobHandle);
}
}
bool started() override { return mStarted; }
bool finish() override
{
if (mStdoutPipe.valid())
{
ReadFromFile(true, mStdoutPipe.readHandle, &mStdout);
}
if (mStderrPipe.valid())
{
ReadFromFile(true, mStderrPipe.readHandle, &mStderr);
}
DWORD result = ::WaitForSingleObject(mProcessInfo.hProcess, INFINITE);
mTimer.stop();
return result == WAIT_OBJECT_0;
}
bool finished() override
{
if (!mStarted)
return false;
// Pipe stdin and stdout.
if (mStdoutPipe.valid())
{
ReadFromFile(false, mStdoutPipe.readHandle, &mStdout);
}
if (mStderrPipe.valid())
{
ReadFromFile(false, mStderrPipe.readHandle, &mStderr);
}
DWORD result = ::WaitForSingleObject(mProcessInfo.hProcess, 0);
if (result == WAIT_OBJECT_0)
{
mTimer.stop();
return true;
}
if (result == WAIT_TIMEOUT)
return false;
mTimer.stop();
std::cerr << "Unexpected result from WaitForSingleObject: " << result
<< ". Last error: " << ::GetLastError() << "\n";
return false;
}
int getExitCode() override
{
if (!mStarted)
return -1;
if (mProcessInfo.hProcess == INVALID_HANDLE_VALUE)
return -1;
DWORD exitCode = 0;
if (::GetExitCodeProcess(mProcessInfo.hProcess, &exitCode) == FALSE)
return -1;
return static_cast<int>(exitCode);
}
bool kill() override
{
if (!mStarted)
return true;
HANDLE newHandle;
if (::DuplicateHandle(::GetCurrentProcess(), mProcessInfo.hProcess, ::GetCurrentProcess(),
&newHandle, PROCESS_ALL_ACCESS, false,
DUPLICATE_CLOSE_SOURCE) == FALSE)
{
std::cerr << "Error getting permission to terminate process: " << ::GetLastError()
<< "\n";
return false;
}
mProcessInfo.hProcess = newHandle;
#if !defined(ANGLE_ENABLE_WINDOWS_UWP)
if (::TerminateThread(mProcessInfo.hThread, 1) == FALSE)
{
std::cerr << "TerminateThread failed: " << GetLastError() << "\n";
return false;
}
#endif // !defined(ANGLE_ENABLE_WINDOWS_UWP)
if (::TerminateProcess(mProcessInfo.hProcess, 1) == FALSE)
{
std::cerr << "TerminateProcess failed: " << GetLastError() << "\n";
return false;
}
mStarted = false;
mTimer.stop();
return true;
}
private:
bool mStarted = false;
ScopedPipe mStdoutPipe;
ScopedPipe mStderrPipe;
PROCESS_INFORMATION mProcessInfo = {};
HANDLE mJobHandle = nullptr;
};
} // namespace
void Sleep(unsigned int milliseconds)
{
::Sleep(static_cast<DWORD>(milliseconds));
}
void WriteDebugMessage(const char *format, ...)
{
va_list args;
va_start(args, format);
int size = vsnprintf(nullptr, 0, format, args);
va_end(args);
std::vector<char> buffer(size + 2);
va_start(args, format);
vsnprintf(buffer.data(), size + 1, format, args);
va_end(args);
OutputDebugStringA(buffer.data());
}
Process *LaunchProcess(const std::vector<const char *> &args, ProcessOutputCapture captureOutput)
{
return new WindowsProcess(args, captureOutput);
}
bool DeleteSystemFile(const char *path)
{
if (strlen(path) >= MAX_PATH)
return false;
const DWORD attr = ::GetFileAttributesA(path);
// Report success if the file or path does not exist.
if (attr == INVALID_FILE_ATTRIBUTES)
{
return ReturnSuccessOnNotFound();
}
// Clear the read-only bit if it is set.
if ((attr & FILE_ATTRIBUTE_READONLY) &&
!::SetFileAttributesA(path, attr & ~FILE_ATTRIBUTE_READONLY))
{
// It's possible for |path| to be gone now under a race with other deleters.
return ReturnSuccessOnNotFound();
}
// We don't handle directories right now.
if ((attr & FILE_ATTRIBUTE_DIRECTORY) != 0)
{
return false;
}
return !!::DeleteFileA(path) ? true : ReturnSuccessOnNotFound();
}
const char *GetNativeEGLLibraryNameWithExtension()
{
return "libEGL.dll";
}
} // namespace angle