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