folly/Subprocess.cpp

   1 /*
   2  * Copyright 2016 Facebook, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *   http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef _GNU_SOURCE
  18 #define _GNU_SOURCE
  19 #endif
  20
  21 #include <folly/Subprocess.h>
  22
  23 #if __linux__
  24 #include <sys/prctl.h>
  25 #endif
  26 #include <fcntl.h>
  27 #include <poll.h>
  28
  29 #include <unistd.h>
  30
  31 #include <array>
  32 #include <algorithm>
  33 #include <system_error>
  34
  35 #include <boost/container/flat_set.hpp>
  36 #include <boost/range/adaptors.hpp>
  37
  38 #include <glog/logging.h>
  39
  40 #include <folly/Conv.h>
  41 #include <folly/Exception.h>
  42 #include <folly/ScopeGuard.h>
  43 #include <folly/String.h>
  44 #include <folly/io/Cursor.h>
  45 #include <folly/portability/Environment.h>
  46
  47 constexpr int kExecFailure = 127;
  48 constexpr int kChildFailure = 126;
  49
  50 namespace folly {
  51
  52 ProcessReturnCode::ProcessReturnCode(ProcessReturnCode&& p) noexcept
  53   : rawStatus_(p.rawStatus_) {
  54   p.rawStatus_ = ProcessReturnCode::RV_NOT_STARTED;
  55 }
  56
  57 ProcessReturnCode& ProcessReturnCode::operator=(ProcessReturnCode&& p)
  58     noexcept {
  59   rawStatus_ = p.rawStatus_;
  60   p.rawStatus_ = ProcessReturnCode::RV_NOT_STARTED;
  61   return *this;
  62 }
  63
  64 ProcessReturnCode::State ProcessReturnCode::state() const {
  65   if (rawStatus_ == RV_NOT_STARTED) return NOT_STARTED;
  66   if (rawStatus_ == RV_RUNNING) return RUNNING;
  67   if (WIFEXITED(rawStatus_)) return EXITED;
  68   if (WIFSIGNALED(rawStatus_)) return KILLED;
  69   throw std::runtime_error(to<std::string>(
  70       "Invalid ProcessReturnCode: ", rawStatus_));
  71 }
  72
  73 void ProcessReturnCode::enforce(State expected) const {
  74   State s = state();
  75   if (s != expected) {
  76     throw std::logic_error(to<std::string>(
  77       "Bad use of ProcessReturnCode; state is ", s, " expected ", expected
  78     ));
  79   }
  80 }
  81
  82 int ProcessReturnCode::exitStatus() const {
  83   enforce(EXITED);
  84   return WEXITSTATUS(rawStatus_);
  85 }
  86
  87 int ProcessReturnCode::killSignal() const {
  88   enforce(KILLED);
  89   return WTERMSIG(rawStatus_);
  90 }
  91
  92 bool ProcessReturnCode::coreDumped() const {
  93   enforce(KILLED);
  94   return WCOREDUMP(rawStatus_);
  95 }
  96
  97 std::string ProcessReturnCode::str() const {
  98   switch (state()) {
  99   case NOT_STARTED:
 100     return "not started";
 101   case RUNNING:
 102     return "running";
 103   case EXITED:
 104     return to<std::string>("exited with status ", exitStatus());
 105   case KILLED:
 106     return to<std::string>("killed by signal ", killSignal(),
 107                            (coreDumped() ? " (core dumped)" : ""));
 108   }
 109   CHECK(false);  // unreached
 110   return "";  // silence GCC warning
 111 }
 112
 113 CalledProcessError::CalledProcessError(ProcessReturnCode rc)
 114   : returnCode_(rc),
 115     what_(returnCode_.str()) {
 116 }
 117
 118 SubprocessSpawnError::SubprocessSpawnError(const char* executable,
 119                                            int errCode,
 120                                            int errnoValue)
 121   : errnoValue_(errnoValue),
 122     what_(to<std::string>(errCode == kExecFailure ?
 123                             "failed to execute " :
 124                             "error preparing to execute ",
 125                           executable, ": ", errnoStr(errnoValue))) {
 126 }
 127
 128 namespace {
 129
 130 // Copy pointers to the given strings in a format suitable for posix_spawn
 131 std::unique_ptr<const char*[]> cloneStrings(const std::vector<std::string>& s) {
 132   std::unique_ptr<const char*[]> d(new const char*[s.size() + 1]);
 133   for (size_t i = 0; i < s.size(); i++) {
 134     d[i] = s[i].c_str();
 135   }
 136   d[s.size()] = nullptr;
 137   return d;
 138 }
 139
 140 // Check a wait() status, throw on non-successful
 141 void checkStatus(ProcessReturnCode returnCode) {
 142   if (returnCode.state() != ProcessReturnCode::EXITED ||
 143       returnCode.exitStatus() != 0) {
 144     throw CalledProcessError(returnCode);
 145   }
 146 }
 147
 148 }  // namespace
 149
 150 Subprocess::Options& Subprocess::Options::fd(int fd, int action) {
 151   if (action == Subprocess::PIPE) {
 152     if (fd == 0) {
 153       action = Subprocess::PIPE_IN;
 154     } else if (fd == 1 || fd == 2) {
 155       action = Subprocess::PIPE_OUT;
 156     } else {
 157       throw std::invalid_argument(
 158           to<std::string>("Only fds 0, 1, 2 are valid for action=PIPE: ", fd));
 159     }
 160   }
 161   fdActions_[fd] = action;
 162   return *this;
 163 }
 164
 165 Subprocess::Subprocess(
 166     const std::vector<std::string>& argv,
 167     const Options& options,
 168     const char* executable,
 169     const std::vector<std::string>* env)
 170   : pid_(-1),
 171     returnCode_(RV_NOT_STARTED) {
 172   if (argv.empty()) {
 173     throw std::invalid_argument("argv must not be empty");
 174   }
 175   if (!executable) executable = argv[0].c_str();
 176   spawn(cloneStrings(argv), executable, options, env);
 177 }
 178
 179 Subprocess::Subprocess(
 180     const std::string& cmd,
 181     const Options& options,
 182     const std::vector<std::string>* env)
 183   : pid_(-1),
 184     returnCode_(RV_NOT_STARTED) {
 185   if (options.usePath_) {
 186     throw std::invalid_argument("usePath() not allowed when running in shell");
 187   }
 188   const char* shell = getenv("SHELL");
 189   if (!shell) {
 190     shell = "/bin/sh";
 191   }
 192
 193   std::unique_ptr<const char*[]> argv(new const char*[4]);
 194   argv[0] = shell;
 195   argv[1] = "-c";
 196   argv[2] = cmd.c_str();
 197   argv[3] = nullptr;
 198   spawn(std::move(argv), shell, options, env);
 199 }
 200
 201 Subprocess::~Subprocess() {
 202   CHECK_NE(returnCode_.state(), ProcessReturnCode::RUNNING)
 203     << "Subprocess destroyed without reaping child";
 204 }
 205
 206 namespace {
 207
 208 struct ChildErrorInfo {
 209   int errCode;
 210   int errnoValue;
 211 };
 212
 213 FOLLY_NORETURN void childError(int errFd, int errCode, int errnoValue);
 214 void childError(int errFd, int errCode, int errnoValue) {
 215   ChildErrorInfo info = {errCode, errnoValue};
 216   // Write the error information over the pipe to our parent process.
 217   // We can't really do anything else if this write call fails.
 218   writeNoInt(errFd, &info, sizeof(info));
 219   // exit
 220   _exit(errCode);
 221 }
 222
 223 }  // namespace
 224
 225 void Subprocess::setAllNonBlocking() {
 226   for (auto& p : pipes_) {
 227     int fd = p.pipe.fd();
 228     int flags = ::fcntl(fd, F_GETFL);
 229     checkUnixError(flags, "fcntl");
 230     int r = ::fcntl(fd, F_SETFL, flags | O_NONBLOCK);
 231     checkUnixError(r, "fcntl");
 232   }
 233 }
 234
 235 void Subprocess::spawn(
 236     std::unique_ptr<const char*[]> argv,
 237     const char* executable,
 238     const Options& optionsIn,
 239     const std::vector<std::string>* env) {
 240   if (optionsIn.usePath_ && env) {
 241     throw std::invalid_argument(
 242         "usePath() not allowed when overriding environment");
 243   }
 244
 245   // Make a copy, we'll mutate options
 246   Options options(optionsIn);
 247
 248   // On error, close all pipes_ (ignoring errors, but that seems fine here).
 249   auto pipesGuard = makeGuard([this] { pipes_.clear(); });
 250
 251   // Create a pipe to use to receive error information from the child,
 252   // in case it fails before calling exec()
 253   int errFds[2];
 254 #if FOLLY_HAVE_PIPE2
 255   checkUnixError(::pipe2(errFds, O_CLOEXEC), "pipe2");
 256 #else
 257   checkUnixError(::pipe(errFds), "pipe");
 258 #endif
 259   SCOPE_EXIT {
 260     CHECK_ERR(::close(errFds[0]));
 261     if (errFds[1] >= 0) {
 262       CHECK_ERR(::close(errFds[1]));
 263     }
 264   };
 265
 266 #if !FOLLY_HAVE_PIPE2
 267   // Ask the child to close the read end of the error pipe.
 268   checkUnixError(fcntl(errFds[0], F_SETFD, FD_CLOEXEC), "set FD_CLOEXEC");
 269   // Set the close-on-exec flag on the write side of the pipe.
 270   // This way the pipe will be closed automatically in the child if execve()
 271   // succeeds.  If the exec fails the child can write error information to the
 272   // pipe.
 273   checkUnixError(fcntl(errFds[1], F_SETFD, FD_CLOEXEC), "set FD_CLOEXEC");
 274 #endif
 275
 276   // Perform the actual work of setting up pipes then forking and
 277   // executing the child.
 278   spawnInternal(std::move(argv), executable, options, env, errFds[1]);
 279
 280   // After spawnInternal() returns the child is alive.  We have to be very
 281   // careful about throwing after this point.  We are inside the constructor,
 282   // so if we throw the Subprocess object will have never existed, and the
 283   // destructor will never be called.
 284   //
 285   // We should only throw if we got an error via the errFd, and we know the
 286   // child has exited and can be immediately waited for.  In all other cases,
 287   // we have no way of cleaning up the child.
 288
 289   // Close writable side of the errFd pipe in the parent process
 290   CHECK_ERR(::close(errFds[1]));
 291   errFds[1] = -1;
 292
 293   // Read from the errFd pipe, to tell if the child ran into any errors before
 294   // calling exec()
 295   readChildErrorPipe(errFds[0], executable);
 296
 297   // We have fully succeeded now, so release the guard on pipes_
 298   pipesGuard.dismiss();
 299 }
 300
 301 void Subprocess::spawnInternal(
 302     std::unique_ptr<const char*[]> argv,
 303     const char* executable,
 304     Options& options,
 305     const std::vector<std::string>* env,
 306     int errFd) {
 307   // Parent work, pre-fork: create pipes
 308   std::vector<int> childFds;
 309   // Close all of the childFds as we leave this scope
 310   SCOPE_EXIT {
 311     // These are only pipes, closing them shouldn't fail
 312     for (int cfd : childFds) {
 313       CHECK_ERR(::close(cfd));
 314     }
 315   };
 316
 317   int r;
 318   for (auto& p : options.fdActions_) {
 319     if (p.second == PIPE_IN || p.second == PIPE_OUT) {
 320       int fds[2];
 321       // We're setting both ends of the pipe as close-on-exec. The child
 322       // doesn't need to reset the flag on its end, as we always dup2() the fd,
 323       // and dup2() fds don't share the close-on-exec flag.
 324 #if FOLLY_HAVE_PIPE2
 325       // If possible, set close-on-exec atomically. Otherwise, a concurrent
 326       // Subprocess invocation can fork() between "pipe" and "fnctl",
 327       // causing FDs to leak.
 328       r = ::pipe2(fds, O_CLOEXEC);
 329       checkUnixError(r, "pipe2");
 330 #else
 331       r = ::pipe(fds);
 332       checkUnixError(r, "pipe");
 333       r = fcntl(fds[0], F_SETFD, FD_CLOEXEC);
 334       checkUnixError(r, "set FD_CLOEXEC");
 335       r = fcntl(fds[1], F_SETFD, FD_CLOEXEC);
 336       checkUnixError(r, "set FD_CLOEXEC");
 337 #endif
 338       pipes_.emplace_back();
 339       Pipe& pipe = pipes_.back();
 340       pipe.direction = p.second;
 341       int cfd;
 342       if (p.second == PIPE_IN) {
 343         // Child gets reading end
 344         pipe.pipe = folly::File(fds[1], /*owns_fd=*/ true);
 345         cfd = fds[0];
 346       } else {
 347         pipe.pipe = folly::File(fds[0], /*owns_fd=*/ true);
 348         cfd = fds[1];
 349       }
 350       p.second = cfd;  // ensure it gets dup2()ed
 351       pipe.childFd = p.first;
 352       childFds.push_back(cfd);
 353     }
 354   }
 355
 356   // This should already be sorted, as options.fdActions_ is
 357   DCHECK(std::is_sorted(pipes_.begin(), pipes_.end()));
 358
 359   // Note that the const casts below are legit, per
 360   // http://pubs.opengroup.org/onlinepubs/009695399/functions/exec.html
 361
 362   char** argVec = const_cast<char**>(argv.get());
 363
 364   // Set up environment
 365   std::unique_ptr<const char*[]> envHolder;
 366   char** envVec;
 367   if (env) {
 368     envHolder = cloneStrings(*env);
 369     envVec = const_cast<char**>(envHolder.get());
 370   } else {
 371     envVec = environ;
 372   }
 373
 374   // Block all signals around vfork; see http://ewontfix.com/7/.
 375   //
 376   // As the child may run in the same address space as the parent until
 377   // the actual execve() system call, any (custom) signal handlers that
 378   // the parent has might alter parent's memory if invoked in the child,
 379   // with undefined results.  So we block all signals in the parent before
 380   // vfork(), which will cause them to be blocked in the child as well (we
 381   // rely on the fact that Linux, just like all sane implementations, only
 382   // clones the calling thread).  Then, in the child, we reset all signals
 383   // to their default dispositions (while still blocked), and unblock them
 384   // (so the exec()ed process inherits the parent's signal mask)
 385   //
 386   // The parent also unblocks all signals as soon as vfork() returns.
 387   sigset_t allBlocked;
 388   r = sigfillset(&allBlocked);
 389   checkUnixError(r, "sigfillset");
 390   sigset_t oldSignals;
 391
 392   r = pthread_sigmask(SIG_SETMASK, &allBlocked, &oldSignals);
 393   checkPosixError(r, "pthread_sigmask");
 394   SCOPE_EXIT {
 395     // Restore signal mask
 396     r = pthread_sigmask(SIG_SETMASK, &oldSignals, nullptr);
 397     CHECK_EQ(r, 0) << "pthread_sigmask: " << errnoStr(r);  // shouldn't fail
 398   };
 399
 400   // Call c_str() here, as it's not necessarily safe after fork.
 401   const char* childDir =
 402     options.childDir_.empty() ? nullptr : options.childDir_.c_str();
 403   pid_t pid = vfork();
 404   if (pid == 0) {
 405     int errnoValue = prepareChild(options, &oldSignals, childDir);
 406     if (errnoValue != 0) {
 407       childError(errFd, kChildFailure, errnoValue);
 408     }
 409
 410     errnoValue = runChild(executable, argVec, envVec, options);
 411     // If we get here, exec() failed.
 412     childError(errFd, kExecFailure, errnoValue);
 413   }
 414   // In parent.  Make sure vfork() succeeded.
 415   checkUnixError(pid, errno, "vfork");
 416
 417   // Child is alive.  We have to be very careful about throwing after this
 418   // point.  We are inside the constructor, so if we throw the Subprocess
 419   // object will have never existed, and the destructor will never be called.
 420   //
 421   // We should only throw if we got an error via the errFd, and we know the
 422   // child has exited and can be immediately waited for.  In all other cases,
 423   // we have no way of cleaning up the child.
 424   pid_ = pid;
 425   returnCode_ = ProcessReturnCode(RV_RUNNING);
 426 }
 427
 428 int Subprocess::prepareChild(const Options& options,
 429                              const sigset_t* sigmask,
 430                              const char* childDir) const {
 431   // While all signals are blocked, we must reset their
 432   // dispositions to default.
 433   for (int sig = 1; sig < NSIG; ++sig) {
 434     ::signal(sig, SIG_DFL);
 435   }
 436
 437   {
 438     // Unblock signals; restore signal mask.
 439     int r = pthread_sigmask(SIG_SETMASK, sigmask, nullptr);
 440     if (r != 0) {
 441       return r;  // pthread_sigmask() returns an errno value
 442     }
 443   }
 444
 445   // Change the working directory, if one is given
 446   if (childDir) {
 447     if (::chdir(childDir) == -1) {
 448       return errno;
 449     }
 450   }
 451
 452   // We don't have to explicitly close the parent's end of all pipes,
 453   // as they all have the FD_CLOEXEC flag set and will be closed at
 454   // exec time.
 455
 456   // Close all fds that we're supposed to close.
 457   for (auto& p : options.fdActions_) {
 458     if (p.second == CLOSE) {
 459       if (::close(p.first) == -1) {
 460         return errno;
 461       }
 462     } else if (p.second != p.first) {
 463       if (::dup2(p.second, p.first) == -1) {
 464         return errno;
 465       }
 466     }
 467   }
 468
 469   // If requested, close all other file descriptors.  Don't close
 470   // any fds in options.fdActions_, and don't touch stdin, stdout, stderr.
 471   // Ignore errors.
 472   if (options.closeOtherFds_) {
 473     for (int fd = getdtablesize() - 1; fd >= 3; --fd) {
 474       if (options.fdActions_.count(fd) == 0) {
 475         ::close(fd);
 476       }
 477     }
 478   }
 479
 480 #if __linux__
 481   // Opt to receive signal on parent death, if requested
 482   if (options.parentDeathSignal_ != 0) {
 483     if (prctl(PR_SET_PDEATHSIG, options.parentDeathSignal_, 0, 0, 0) == -1) {
 484       return errno;
 485     }
 486   }
 487 #endif
 488
 489   if (options.processGroupLeader_) {
 490     if (setpgrp() == -1) {
 491       return errno;
 492     }
 493   }
 494
 495   // The user callback comes last, so that the child is otherwise all set up.
 496   if (options.dangerousPostForkPreExecCallback_) {
 497     if (int error = (*options.dangerousPostForkPreExecCallback_)()) {
 498       return error;
 499     }
 500   }
 501
 502   return 0;
 503 }
 504
 505 int Subprocess::runChild(const char* executable,
 506                          char** argv, char** env,
 507                          const Options& options) const {
 508   // Now, finally, exec.
 509   if (options.usePath_) {
 510     ::execvp(executable, argv);
 511   } else {
 512     ::execve(executable, argv, env);
 513   }
 514   return errno;
 515 }
 516
 517 void Subprocess::readChildErrorPipe(int pfd, const char* executable) {
 518   ChildErrorInfo info;
 519   auto rc = readNoInt(pfd, &info, sizeof(info));
 520   if (rc == 0) {
 521     // No data means the child executed successfully, and the pipe
 522     // was closed due to the close-on-exec flag being set.
 523     return;
 524   } else if (rc != sizeof(ChildErrorInfo)) {
 525     // An error occurred trying to read from the pipe, or we got a partial read.
 526     // Neither of these cases should really occur in practice.
 527     //
 528     // We can't get any error data from the child in this case, and we don't
 529     // know if it is successfully running or not.  All we can do is to return
 530     // normally, as if the child executed successfully.  If something bad
 531     // happened the caller should at least get a non-normal exit status from
 532     // the child.
 533     LOG(ERROR) << "unexpected error trying to read from child error pipe " <<
 534       "rc=" << rc << ", errno=" << errno;
 535     return;
 536   }
 537
 538   // We got error data from the child.  The child should exit immediately in
 539   // this case, so wait on it to clean up.
 540   wait();
 541
 542   // Throw to signal the error
 543   throw SubprocessSpawnError(executable, info.errCode, info.errnoValue);
 544 }
 545
 546 ProcessReturnCode Subprocess::poll() {
 547   returnCode_.enforce(ProcessReturnCode::RUNNING);
 548   DCHECK_GT(pid_, 0);
 549   int status;
 550   pid_t found = ::waitpid(pid_, &status, WNOHANG);
 551   // The spec guarantees that EINTR does not occur with WNOHANG, so the only
 552   // two remaining errors are ECHILD (other code reaped the child?), or
 553   // EINVAL (cosmic rays?), both of which merit an abort:
 554   PCHECK(found != -1) << "waitpid(" << pid_ << ", &status, WNOHANG)";
 555   if (found != 0) {
 556     // Though the child process had quit, this call does not close the pipes
 557     // since its descendants may still be using them.
 558     returnCode_ = ProcessReturnCode(status);
 559     pid_ = -1;
 560   }
 561   return returnCode_;
 562 }
 563
 564 bool Subprocess::pollChecked() {
 565   if (poll().state() == ProcessReturnCode::RUNNING) {
 566     return false;
 567   }
 568   checkStatus(returnCode_);
 569   return true;
 570 }
 571
 572 ProcessReturnCode Subprocess::wait() {
 573   returnCode_.enforce(ProcessReturnCode::RUNNING);
 574   DCHECK_GT(pid_, 0);
 575   int status;
 576   pid_t found;
 577   do {
 578     found = ::waitpid(pid_, &status, 0);
 579   } while (found == -1 && errno == EINTR);
 580   // The only two remaining errors are ECHILD (other code reaped the
 581   // child?), or EINVAL (cosmic rays?), and both merit an abort:
 582   PCHECK(found != -1) << "waitpid(" << pid_ << ", &status, WNOHANG)";
 583   // Though the child process had quit, this call does not close the pipes
 584   // since its descendants may still be using them.
 585   DCHECK_EQ(found, pid_);
 586   returnCode_ = ProcessReturnCode(status);
 587   pid_ = -1;
 588   return returnCode_;
 589 }
 590
 591 void Subprocess::waitChecked() {
 592   wait();
 593   checkStatus(returnCode_);
 594 }
 595
 596 void Subprocess::sendSignal(int signal) {
 597   returnCode_.enforce(ProcessReturnCode::RUNNING);
 598   int r = ::kill(pid_, signal);
 599   checkUnixError(r, "kill");
 600 }
 601
 602 pid_t Subprocess::pid() const {
 603   return pid_;
 604 }
 605
 606 namespace {
 607
 608 std::pair<const uint8_t*, size_t> queueFront(const IOBufQueue& queue) {
 609   auto* p = queue.front();
 610   if (!p) return std::make_pair(nullptr, 0);
 611   return io::Cursor(p).peek();
 612 }
 613
 614 // fd write
 615 bool handleWrite(int fd, IOBufQueue& queue) {
 616   for (;;) {
 617     auto p = queueFront(queue);
 618     if (p.second == 0) {
 619       return true;  // EOF
 620     }
 621
 622     ssize_t n = writeNoInt(fd, p.first, p.second);
 623     if (n == -1 && errno == EAGAIN) {
 624       return false;
 625     }
 626     checkUnixError(n, "write");
 627     queue.trimStart(n);
 628   }
 629 }
 630
 631 // fd read
 632 bool handleRead(int fd, IOBufQueue& queue) {
 633   for (;;) {
 634     auto p = queue.preallocate(100, 65000);
 635     ssize_t n = readNoInt(fd, p.first, p.second);
 636     if (n == -1 && errno == EAGAIN) {
 637       return false;
 638     }
 639     checkUnixError(n, "read");
 640     if (n == 0) {
 641       return true;
 642     }
 643     queue.postallocate(n);
 644   }
 645 }
 646
 647 bool discardRead(int fd) {
 648   static const size_t bufSize = 65000;
 649   // Thread unsafe, but it doesn't matter.
 650   static std::unique_ptr<char[]> buf(new char[bufSize]);
 651
 652   for (;;) {
 653     ssize_t n = readNoInt(fd, buf.get(), bufSize);
 654     if (n == -1 && errno == EAGAIN) {
 655       return false;
 656     }
 657     checkUnixError(n, "read");
 658     if (n == 0) {
 659       return true;
 660     }
 661   }
 662 }
 663
 664 }  // namespace
 665
 666 std::pair<std::string, std::string> Subprocess::communicate(
 667     StringPiece input) {
 668   IOBufQueue inputQueue;
 669   inputQueue.wrapBuffer(input.data(), input.size());
 670
 671   auto outQueues = communicateIOBuf(std::move(inputQueue));
 672   auto outBufs = std::make_pair(outQueues.first.move(),
 673                                 outQueues.second.move());
 674   std::pair<std::string, std::string> out;
 675   if (outBufs.first) {
 676     outBufs.first->coalesce();
 677     out.first.assign(reinterpret_cast<const char*>(outBufs.first->data()),
 678                      outBufs.first->length());
 679   }
 680   if (outBufs.second) {
 681     outBufs.second->coalesce();
 682     out.second.assign(reinterpret_cast<const char*>(outBufs.second->data()),
 683                      outBufs.second->length());
 684   }
 685   return out;
 686 }
 687
 688 std::pair<IOBufQueue, IOBufQueue> Subprocess::communicateIOBuf(
 689     IOBufQueue input) {
 690   // If the user supplied a non-empty input buffer, make sure
 691   // that stdin is a pipe so we can write the data.
 692   if (!input.empty()) {
 693     // findByChildFd() will throw std::invalid_argument if no pipe for
 694     // STDIN_FILENO exists
 695     findByChildFd(STDIN_FILENO);
 696   }
 697
 698   std::pair<IOBufQueue, IOBufQueue> out;
 699
 700   auto readCallback = [&] (int pfd, int cfd) -> bool {
 701     if (cfd == STDOUT_FILENO) {
 702       return handleRead(pfd, out.first);
 703     } else if (cfd == STDERR_FILENO) {
 704       return handleRead(pfd, out.second);
 705     } else {
 706       // Don't close the file descriptor, the child might not like SIGPIPE,
 707       // just read and throw the data away.
 708       return discardRead(pfd);
 709     }
 710   };
 711
 712   auto writeCallback = [&] (int pfd, int cfd) -> bool {
 713     if (cfd == STDIN_FILENO) {
 714       return handleWrite(pfd, input);
 715     } else {
 716       // If we don't want to write to this fd, just close it.
 717       return true;
 718     }
 719   };
 720
 721   communicate(std::move(readCallback), std::move(writeCallback));
 722
 723   return out;
 724 }
 725
 726 void Subprocess::communicate(FdCallback readCallback,
 727                              FdCallback writeCallback) {
 728   // This serves to prevent wait() followed by communicate(), but if you
 729   // legitimately need that, send a patch to delete this line.
 730   returnCode_.enforce(ProcessReturnCode::RUNNING);
 731   setAllNonBlocking();
 732
 733   std::vector<pollfd> fds;
 734   fds.reserve(pipes_.size());
 735   std::vector<size_t> toClose;  // indexes into pipes_
 736   toClose.reserve(pipes_.size());
 737
 738   while (!pipes_.empty()) {
 739     fds.clear();
 740     toClose.clear();
 741
 742     for (auto& p : pipes_) {
 743       pollfd pfd;
 744       pfd.fd = p.pipe.fd();
 745       // Yes, backwards, PIPE_IN / PIPE_OUT are defined from the
 746       // child's point of view.
 747       if (!p.enabled) {
 748         // Still keeping fd in watched set so we get notified of POLLHUP /
 749         // POLLERR
 750         pfd.events = 0;
 751       } else if (p.direction == PIPE_IN) {
 752         pfd.events = POLLOUT;
 753       } else {
 754         pfd.events = POLLIN;
 755       }
 756       fds.push_back(pfd);
 757     }
 758
 759     int r;
 760     do {
 761       r = ::poll(fds.data(), fds.size(), -1);
 762     } while (r == -1 && errno == EINTR);
 763     checkUnixError(r, "poll");
 764
 765     for (size_t i = 0; i < pipes_.size(); ++i) {
 766       auto& p = pipes_[i];
 767       auto parentFd = p.pipe.fd();
 768       DCHECK_EQ(fds[i].fd, parentFd);
 769       short events = fds[i].revents;
 770
 771       bool closed = false;
 772       if (events & POLLOUT) {
 773         DCHECK(!(events & POLLIN));
 774         if (writeCallback(parentFd, p.childFd)) {
 775           toClose.push_back(i);
 776           closed = true;
 777         }
 778       }
 779
 780       // Call read callback on POLLHUP, to give it a chance to read (and act
 781       // on) end of file
 782       if (events & (POLLIN | POLLHUP)) {
 783         DCHECK(!(events & POLLOUT));
 784         if (readCallback(parentFd, p.childFd)) {
 785           toClose.push_back(i);
 786           closed = true;
 787         }
 788       }
 789
 790       if ((events & (POLLHUP | POLLERR)) && !closed) {
 791         toClose.push_back(i);
 792         closed = true;
 793       }
 794     }
 795
 796     // Close the fds in reverse order so the indexes hold after erase()
 797     for (int idx : boost::adaptors::reverse(toClose)) {
 798       auto pos = pipes_.begin() + idx;
 799       pos->pipe.close();  // Throws on error
 800       pipes_.erase(pos);
 801     }
 802   }
 803 }
 804
 805 void Subprocess::enableNotifications(int childFd, bool enabled) {
 806   pipes_[findByChildFd(childFd)].enabled = enabled;
 807 }
 808
 809 bool Subprocess::notificationsEnabled(int childFd) const {
 810   return pipes_[findByChildFd(childFd)].enabled;
 811 }
 812
 813 size_t Subprocess::findByChildFd(int childFd) const {
 814   auto pos = std::lower_bound(
 815       pipes_.begin(), pipes_.end(), childFd,
 816       [] (const Pipe& pipe, int fd) { return pipe.childFd < fd; });
 817   if (pos == pipes_.end() || pos->childFd != childFd) {
 818     throw std::invalid_argument(folly::to<std::string>(
 819         "child fd not found ", childFd));
 820   }
 821   return pos - pipes_.begin();
 822 }
 823
 824 void Subprocess::closeParentFd(int childFd) {
 825   int idx = findByChildFd(childFd);
 826   pipes_[idx].pipe.close();  // May throw
 827   pipes_.erase(pipes_.begin() + idx);
 828 }
 829
 830 std::vector<Subprocess::ChildPipe> Subprocess::takeOwnershipOfPipes() {
 831   std::vector<Subprocess::ChildPipe> pipes;
 832   for (auto& p : pipes_) {
 833     pipes.emplace_back(p.childFd, std::move(p.pipe));
 834   }
 835   pipes_.clear();
 836   return pipes;
 837 }
 838
 839 namespace {
 840
 841 class Initializer {
 842  public:
 843   Initializer() {
 844     // We like EPIPE, thanks.
 845     ::signal(SIGPIPE, SIG_IGN);
 846   }
 847 };
 848
 849 Initializer initializer;
 850
 851 }  // namespace
 852
 853 }  // namespace folly