blob: e5484a7a92a8ae1c9df423a33f5c938d0517045a [file] [log] [blame]
// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "chromeos/process_proxy/process_proxy.h"
#include <stddef.h>
#include <stdlib.h>
#include <sys/ioctl.h>
#include "base/bind.h"
#include "base/command_line.h"
#include "base/files/file_util.h"
#include "base/location.h"
#include "base/logging.h"
#include "base/posix/eintr_wrapper.h"
#include "base/process/launch.h"
#include "base/process/process.h"
#include "base/single_thread_task_runner.h"
#include "base/thread_task_runner_handle.h"
#include "third_party/cros_system_api/switches/chrome_switches.h"
namespace {
enum PseudoTerminalFd {
PT_MASTER_FD,
PT_SLAVE_FD
};
const int kInvalidFd = -1;
void StopOutputWatcher(scoped_ptr<chromeos::ProcessOutputWatcher> watcher) {
// Just deleting |watcher| if sufficient to stop it.
}
} // namespace
namespace chromeos {
ProcessProxy::ProcessProxy() : process_launched_(false), callback_set_(false) {
// Set pipes to initial, invalid value so we can easily know if a pipe was
// opened by us.
ClearFdPair(pt_pair_);
}
int ProcessProxy::Open(const std::string& command) {
if (process_launched_)
return -1;
if (!CreatePseudoTerminalPair(pt_pair_)) {
return -1;
}
int process_id = LaunchProcess(command, pt_pair_[PT_SLAVE_FD]);
process_launched_ = process_id >= 0;
if (process_launched_) {
CloseFd(&pt_pair_[PT_SLAVE_FD]);
} else {
CloseFdPair(pt_pair_);
}
return process_id;
}
bool ProcessProxy::StartWatchingOutput(
const scoped_refptr<base::SingleThreadTaskRunner>& watcher_runner,
const OutputCallback& callback) {
DCHECK(process_launched_);
CHECK(!output_watcher_.get());
// We give ProcessOutputWatcher a copy of master to make life easier during
// tear down.
// TODO(tbarzic): improve fd managment.
int master_copy = HANDLE_EINTR(dup(pt_pair_[PT_MASTER_FD]));
if (master_copy < 0)
return false;
callback_set_ = true;
callback_ = callback;
callback_runner_ = base::ThreadTaskRunnerHandle::Get();
watcher_runner_ = watcher_runner;
// This object will delete itself once watching is stopped.
// It also takes ownership of the passed fds.
output_watcher_.reset(new ProcessOutputWatcher(
master_copy, base::Bind(&ProcessProxy::OnProcessOutput, this)));
watcher_runner_->PostTask(
FROM_HERE, base::Bind(&ProcessOutputWatcher::Start,
base::Unretained(output_watcher_.get())));
return true;
}
void ProcessProxy::OnProcessOutput(ProcessOutputType type,
const std::string& output,
const base::Closure& callback) {
if (!callback_runner_.get())
return;
callback_runner_->PostTask(
FROM_HERE, base::Bind(&ProcessProxy::CallOnProcessOutputCallback, this,
type, output, callback));
}
void ProcessProxy::CallOnProcessOutputCallback(ProcessOutputType type,
const std::string& output,
const base::Closure& callback) {
// We may receive some output even after Close was called (crosh process does
// not have to quit instantly, or there may be some trailing data left in
// output stream fds). In that case owner of the callback may be gone so we
// don't want to send it anything. |callback_set_| is reset when this gets
// closed.
if (callback_set_) {
output_ack_callback_ = callback;
callback_.Run(type, output);
}
}
void ProcessProxy::AckOutput() {
if (!output_ack_callback_.is_null()) {
output_ack_callback_.Run();
output_ack_callback_.Reset();
}
}
void ProcessProxy::StopWatching() {
if (!output_watcher_.get())
return;
watcher_runner_->PostTask(
FROM_HERE,
base::Bind(&StopOutputWatcher, base::Passed(&output_watcher_)));
}
void ProcessProxy::Close() {
if (!process_launched_)
return;
process_launched_ = false;
callback_set_ = false;
callback_.Reset();
callback_runner_ = NULL;
process_->Terminate(0, true /* wait */);
StopWatching();
CloseFdPair(pt_pair_);
}
bool ProcessProxy::Write(const std::string& text) {
if (!process_launched_)
return false;
// We don't want to write '\0' to the pipe.
size_t data_size = text.length() * sizeof(*text.c_str());
return base::WriteFileDescriptor(
pt_pair_[PT_MASTER_FD], text.c_str(), data_size);
}
bool ProcessProxy::OnTerminalResize(int width, int height) {
if (width < 0 || height < 0)
return false;
winsize ws;
// Number of rows.
ws.ws_row = height;
// Number of columns.
ws.ws_col = width;
return (HANDLE_EINTR(ioctl(pt_pair_[PT_MASTER_FD], TIOCSWINSZ, &ws)) != -1);
}
ProcessProxy::~ProcessProxy() {
Close();
}
bool ProcessProxy::CreatePseudoTerminalPair(int *pt_pair) {
ClearFdPair(pt_pair);
// Open Master.
pt_pair[PT_MASTER_FD] = HANDLE_EINTR(posix_openpt(O_RDWR | O_NOCTTY));
if (pt_pair[PT_MASTER_FD] == -1)
return false;
if (grantpt(pt_pair_[PT_MASTER_FD]) != 0 ||
unlockpt(pt_pair_[PT_MASTER_FD]) != 0) {
CloseFd(&pt_pair[PT_MASTER_FD]);
return false;
}
char* slave_name = NULL;
// Per man page, slave_name must not be freed.
slave_name = ptsname(pt_pair_[PT_MASTER_FD]);
if (slave_name)
pt_pair_[PT_SLAVE_FD] = HANDLE_EINTR(open(slave_name, O_RDWR | O_NOCTTY));
if (pt_pair_[PT_SLAVE_FD] == -1) {
CloseFdPair(pt_pair);
return false;
}
return true;
}
int ProcessProxy::LaunchProcess(const std::string& command, int slave_fd) {
// Redirect crosh process' output and input so we can read it.
base::FileHandleMappingVector fds_mapping;
fds_mapping.push_back(std::make_pair(slave_fd, STDIN_FILENO));
fds_mapping.push_back(std::make_pair(slave_fd, STDOUT_FILENO));
fds_mapping.push_back(std::make_pair(slave_fd, STDERR_FILENO));
base::LaunchOptions options;
// Do not set NO_NEW_PRIVS on processes if the system is in dev-mode. This
// permits sudo in the crosh shell when in developer mode.
options.allow_new_privs = base::CommandLine::ForCurrentProcess()->
HasSwitch(chromeos::switches::kSystemInDevMode);
options.fds_to_remap = &fds_mapping;
options.ctrl_terminal_fd = slave_fd;
options.environ["TERM"] = "xterm";
// Launch the process.
process_.reset(new base::Process(base::LaunchProcess(
base::CommandLine(base::FilePath(command)), options)));
// TODO(rvargas) crbug/417532: This is somewhat wrong but the interface of
// Open vends pid_t* so ownership is quite vague anyway, and Process::Close
// doesn't do much in POSIX.
return process_->IsValid() ? process_->Pid() : -1;
}
void ProcessProxy::CloseFdPair(int* pipe) {
CloseFd(&(pipe[PT_MASTER_FD]));
CloseFd(&(pipe[PT_SLAVE_FD]));
}
void ProcessProxy::CloseFd(int* fd) {
if (*fd != kInvalidFd) {
if (IGNORE_EINTR(close(*fd)) != 0)
DPLOG(WARNING) << "close fd failed.";
}
*fd = kInvalidFd;
}
void ProcessProxy::ClearFdPair(int* pipe) {
pipe[PT_MASTER_FD] = kInvalidFd;
pipe[PT_SLAVE_FD] = kInvalidFd;
}
} // namespace chromeos