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
|
// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "chrome/test/chromedriver/net/pipe_builder.h"
#include <cstdlib>
#include <memory>
#include <string>
#include <utility>
#include "base/command_line.h"
#include "base/files/file_util.h"
#include "base/files/platform_file.h"
#include "base/strings/string_number_conversions.h"
#include "build/build_config.h"
#include "chrome/test/chromedriver/chrome/status.h"
#include "chrome/test/chromedriver/net/pipe_connection.h"
#include "chrome/test/chromedriver/net/sync_websocket.h"
#if BUILDFLAG(IS_WIN)
#include <windows.h>
#include "base/win/windows_handle_util.h"
#endif
namespace {
#if BUILDFLAG(IS_POSIX)
// The values for kReadFD and kWriteFD come from
// content/browser/devtools/devtools_pipe_handler.cc
constexpr int kReadFD = 3;
constexpr int kWriteFD = 4;
#endif
} // namespace
const char PipeBuilder::kAsciizProtocolMode[] = "asciiz";
const char PipeBuilder::kCborProtocolMode[] = "cbor";
bool PipeBuilder::PlatformIsSupported() {
#if BUILDFLAG(IS_POSIX) || BUILDFLAG(IS_WIN)
return true;
#else
return false;
#endif
}
PipeBuilder::PipeBuilder() = default;
PipeBuilder::~PipeBuilder() = default;
std::unique_ptr<SyncWebSocket> PipeBuilder::TakeSocket() {
return std::unique_ptr<SyncWebSocket>(connection_.release());
}
void PipeBuilder::SetProtocolMode(std::string mode) {
if (mode.empty()) {
mode = kAsciizProtocolMode;
}
protocol_mode_ = mode;
}
Status PipeBuilder::BuildSocket() {
if (protocol_mode_ != kAsciizProtocolMode) {
return Status{kUnknownError, "only ASCIIZ protocol mode is supported"};
}
#if BUILDFLAG(IS_POSIX) || BUILDFLAG(IS_WIN)
if (!read_file_.is_valid() || !write_file_.is_valid()) {
return Status{kUnknownError, "pipes are not initialized"};
}
connection_ = std::make_unique<PipeConnection>(std::move(read_file_),
std::move(write_file_));
return Status{kOk};
#else
return Status{kUnknownError, "pipes are not supported on this platform"};
#endif
}
Status PipeBuilder::CloseChildEndpoints() {
#if BUILDFLAG(IS_POSIX) || BUILDFLAG(IS_WIN)
for (base::ScopedPlatformFile& file : child_ends_) {
file = base::ScopedPlatformFile();
}
return Status{kOk};
#else
return Status{kUnknownError, "pipes are not supported on this platform"};
#endif
}
Status PipeBuilder::SetUpPipes(base::LaunchOptions* options,
base::CommandLine* command) {
if (protocol_mode_ != kAsciizProtocolMode) {
return Status{kUnknownError, "only ASCIIZ protocol mode is supported"};
}
#if BUILDFLAG(IS_POSIX)
base::ScopedFD parent_read;
base::ScopedFD child_write;
base::ScopedFD child_read;
base::ScopedFD parent_write;
if (!CreatePipe(&parent_read, &child_write, false) ||
!CreatePipe(&child_read, &parent_write, false) ||
// the local ends must be closed in the child process
!base::SetCloseOnExec(parent_read.get()) ||
!base::SetCloseOnExec(parent_write.get())) {
return Status{kUnknownError, "unable to setup a pipe"};
}
options->fds_to_remap.emplace_back(child_read.get(), kReadFD);
options->fds_to_remap.emplace_back(child_write.get(), kWriteFD);
read_file_ = std::move(parent_read);
write_file_ = std::move(parent_write);
child_ends_[0] = std::move(child_read);
child_ends_[1] = std::move(child_write);
return Status{kOk};
#elif BUILDFLAG(IS_WIN)
HANDLE child_read_handle;
HANDLE parent_write_handle;
HANDLE parent_read_handle;
HANDLE child_write_handle;
if (!CreatePipe(&child_read_handle, &parent_write_handle, nullptr, 0)) {
return Status{kUnknownError, "unable to setup a pipe"};
}
base::win::ScopedHandle child_read(child_read_handle);
base::win::ScopedHandle parent_write(parent_write_handle);
if (!CreatePipe(&parent_read_handle, &child_write_handle, nullptr, 0)) {
return Status{kUnknownError, "unable to setup a pipe"};
}
base::win::ScopedHandle parent_read(parent_read_handle);
base::win::ScopedHandle child_write(child_write_handle);
std::string in_pipe_name =
base::NumberToString(base::win::HandleToUint32(child_read.get()));
std::string out_pipe_name =
base::NumberToString(base::win::HandleToUint32(child_write.get()));
// We use the fact that inherited handles in the child process have the same
// value and access rights as in the parent process.
// See:
// https://learn.microsoft.com/en-us/windows/win32/api/processthreadsapi/nf-processthreadsapi-createprocessa
command->AppendSwitchASCII("remote-debugging-io-pipes",
in_pipe_name + "," + out_pipe_name);
options->handles_to_inherit.push_back(child_read.get());
options->handles_to_inherit.push_back(child_write.get());
read_file_ = std::move(parent_read);
write_file_ = std::move(parent_write);
child_ends_[0] = std::move(child_read);
child_ends_[1] = std::move(child_write);
return Status{kOk};
#else
return Status{kUnknownError, "pipes are not supported on this platform"};
#endif
}
|