folly/Subprocess.cpp

   1 /*
   2  * Copyright 2014 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
  46 extern char** environ;
  47
  48 constexpr int kExecFailure = 127;
  49 constexpr int kChildFailure = 126;
  50
  51 namespace folly {
  52
  53 ProcessReturnCode::State ProcessReturnCode::state() const {
  54   if (rawStatus_ == RV_NOT_STARTED) return NOT_STARTED;
  55   if (rawStatus_ == RV_RUNNING) return RUNNING;
  56   if (WIFEXITED(rawStatus_)) return EXITED;
  57   if (WIFSIGNALED(rawStatus_)) return KILLED;
  58   throw std::runtime_error(to<std::string>(
  59       "Invalid ProcessReturnCode: ", rawStatus_));
  60 }
  61
  62 void ProcessReturnCode::enforce(State expected) const {
  63   State s = state();
  64   if (s != expected) {
  65     throw std::logic_error(to<std::string>(
  66       "Bad use of ProcessReturnCode; state is ", s, " expected ", expected
  67     ));
  68   }
  69 }
  70
  71 int ProcessReturnCode::exitStatus() const {
  72   enforce(EXITED);
  73   return WEXITSTATUS(rawStatus_);
  74 }
  75
  76 int ProcessReturnCode::killSignal() const {
  77   enforce(KILLED);
  78   return WTERMSIG(rawStatus_);
  79 }
  80
  81 bool ProcessReturnCode::coreDumped() const {
  82   enforce(KILLED);
  83   return WCOREDUMP(rawStatus_);
  84 }
  85
  86 std::string ProcessReturnCode::str() const {
  87   switch (state()) {
  88   case NOT_STARTED:
  89     return "not started";
  90   case RUNNING:
  91     return "running";
  92   case EXITED:
  93     return to<std::string>("exited with status ", exitStatus());
  94   case KILLED:
  95     return to<std::string>("killed by signal ", killSignal(),
  96                            (coreDumped() ? " (core dumped)" : ""));
  97   }
  98   CHECK(false);  // unreached
  99 }
 100
 101 CalledProcessError::CalledProcessError(ProcessReturnCode rc)
 102   : returnCode_(rc),
 103     what_(returnCode_.str()) {
 104 }
 105
 106 SubprocessSpawnError::SubprocessSpawnError(const char* executable,
 107                                            int errCode,
 108                                            int errnoValue)
 109   : errnoValue_(errnoValue),
 110     what_(to<std::string>(errCode == kExecFailure ?
 111                             "failed to execute " :
 112                             "error preparing to execute ",
 113                           executable, ": ", errnoStr(errnoValue))) {
 114 }
 115
 116 namespace {
 117
 118 // Copy pointers to the given strings in a format suitable for posix_spawn
 119 std::unique_ptr<const char*[]> cloneStrings(const std::vector<std::string>& s) {
 120   std::unique_ptr<const char*[]> d(new const char*[s.size() + 1]);
 121   for (size_t i = 0; i < s.size(); i++) {
 122     d[i] = s[i].c_str();
 123   }
 124   d[s.size()] = nullptr;
 125   return d;
 126 }
 127
 128 // Check a wait() status, throw on non-successful
 129 void checkStatus(ProcessReturnCode returnCode) {
 130   if (returnCode.state() != ProcessReturnCode::EXITED ||
 131       returnCode.exitStatus() != 0) {
 132     throw CalledProcessError(returnCode);
 133   }
 134 }
 135
 136 }  // namespace
 137
 138 Subprocess::Options& Subprocess::Options::fd(int fd, int action) {
 139   if (action == Subprocess::PIPE) {
 140     if (fd == 0) {
 141       action = Subprocess::PIPE_IN;
 142     } else if (fd == 1 || fd == 2) {
 143       action = Subprocess::PIPE_OUT;
 144     } else {
 145       throw std::invalid_argument(
 146           to<std::string>("Only fds 0, 1, 2 are valid for action=PIPE: ", fd));
 147     }
 148   }
 149   fdActions_[fd] = action;
 150   return *this;
 151 }
 152
 153 Subprocess::Subprocess(
 154     const std::vector<std::string>& argv,
 155     const Options& options,
 156     const char* executable,
 157     const std::vector<std::string>* env)
 158   : pid_(-1),
 159     returnCode_(RV_NOT_STARTED) {
 160   if (argv.empty()) {
 161     throw std::invalid_argument("argv must not be empty");
 162   }
 163   if (!executable) executable = argv[0].c_str();
 164   spawn(cloneStrings(argv), executable, options, env);
 165 }
 166
 167 Subprocess::Subprocess(
 168     const std::string& cmd,
 169     const Options& options,
 170     const std::vector<std::string>* env)
 171   : pid_(-1),
 172     returnCode_(RV_NOT_STARTED) {
 173   if (options.usePath_) {
 174     throw std::invalid_argument("usePath() not allowed when running in shell");
 175   }
 176   const char* shell = getenv("SHELL");
 177   if (!shell) {
 178     shell = "/bin/sh";
 179   }
 180
 181   std::unique_ptr<const char*[]> argv(new const char*[4]);
 182   argv[0] = shell;
 183   argv[1] = "-c";
 184   argv[2] = cmd.c_str();
 185   argv[3] = nullptr;
 186   spawn(std::move(argv), shell, options, env);
 187 }
 188
 189 Subprocess::~Subprocess() {
 190   CHECK_NE(returnCode_.state(), ProcessReturnCode::RUNNING)
 191     << "Subprocess destroyed without reaping child";
 192   closeAll();
 193 }
 194
 195 namespace {
 196 void closeChecked(int fd) {
 197   checkUnixError(::close(fd), "close");
 198 }
 199
 200 struct ChildErrorInfo {
 201   int errCode;
 202   int errnoValue;
 203 };
 204
 205 FOLLY_NORETURN void childError(int errFd, int errCode, int errnoValue);
 206 void childError(int errFd, int errCode, int errnoValue) {
 207   ChildErrorInfo info = {errCode, errnoValue};
 208   // Write the error information over the pipe to our parent process.
 209   // We can't really do anything else if this write call fails.
 210   writeNoInt(errFd, &info, sizeof(info));
 211   // exit
 212   _exit(errCode);
 213 }
 214
 215 }  // namespace
 216
 217 void Subprocess::closeAll() {
 218   for (auto& p : pipes_) {
 219     closeChecked(p.parentFd);
 220   }
 221   pipes_.clear();
 222 }
 223
 224 void Subprocess::setAllNonBlocking() {
 225   for (auto& p : pipes_) {
 226     int fd = p.parentFd;
 227     int flags = ::fcntl(fd, F_GETFL);
 228     checkUnixError(flags, "fcntl");
 229     int r = ::fcntl(fd, F_SETFL, flags | O_NONBLOCK);
 230     checkUnixError(r, "fcntl");
 231   }
 232 }
 233
 234 void Subprocess::spawn(
 235     std::unique_ptr<const char*[]> argv,
 236     const char* executable,
 237     const Options& optionsIn,
 238     const std::vector<std::string>* env) {
 239   if (optionsIn.usePath_ && env) {
 240     throw std::invalid_argument(
 241         "usePath() not allowed when overriding environment");
 242   }
 243
 244   // Make a copy, we'll mutate options
 245   Options options(optionsIn);
 246
 247   // On error, close all of the pipes_
 248   auto pipesGuard = makeGuard([&] {
 249     for (auto& p : this->pipes_) {
 250       CHECK_ERR(::close(p.parentFd));
 251     }
 252   });
 253
 254   // Create a pipe to use to receive error information from the child,
 255   // in case it fails before calling exec()
 256   int errFds[2];
 257 #if FOLLY_HAVE_PIPE2
 258   checkUnixError(::pipe2(errFds, O_CLOEXEC), "pipe2");
 259 #else
 260   checkUnixError(::pipe(errFds), "pipe");
 261 #endif
 262   SCOPE_EXIT {
 263     CHECK_ERR(::close(errFds[0]));
 264     if (errFds[1] >= 0) {
 265       CHECK_ERR(::close(errFds[1]));
 266     }
 267   };
 268
 269 #if !FOLLY_HAVE_PIPE2
 270   // Ask the child to close the read end of the error pipe.
 271   checkUnixError(fcntl(errFds[0], F_SETFD, FD_CLOEXEC), "set FD_CLOEXEC");
 272   // Set the close-on-exec flag on the write side of the pipe.
 273   // This way the pipe will be closed automatically in the child if execve()
 274   // succeeds.  If the exec fails the child can write error information to the
 275   // pipe.
 276   checkUnixError(fcntl(errFds[1], F_SETFD, FD_CLOEXEC), "set FD_CLOEXEC");
 277 #endif
 278
 279   // Perform the actual work of setting up pipes then forking and
 280   // executing the child.
 281   spawnInternal(std::move(argv), executable, options, env, errFds[1]);
 282
 283   // After spawnInternal() returns the child is alive.  We have to be very
 284   // careful about throwing after this point.  We are inside the constructor,
 285   // so if we throw the Subprocess object will have never existed, and the
 286   // destructor will never be called.
 287   //
 288   // We should only throw if we got an error via the errFd, and we know the
 289   // child has exited and can be immediately waited for.  In all other cases,
 290   // we have no way of cleaning up the child.
 291
 292   // Close writable side of the errFd pipe in the parent process
 293   CHECK_ERR(::close(errFds[1]));
 294   errFds[1] = -1;
 295
 296   // Read from the errFd pipe, to tell if the child ran into any errors before
 297   // calling exec()
 298   readChildErrorPipe(errFds[0], executable);
 299
 300   // We have fully succeeded now, so release the guard on pipes_
 301   pipesGuard.dismiss();
 302 }
 303
 304 void Subprocess::spawnInternal(
 305     std::unique_ptr<const char*[]> argv,
 306     const char* executable,
 307     Options& options,
 308     const std::vector<std::string>* env,
 309     int errFd) {
 310   // Parent work, pre-fork: create pipes
 311   std::vector<int> childFds;
 312   // Close all of the childFds as we leave this scope
 313   SCOPE_EXIT {
 314     // These are only pipes, closing them shouldn't fail
 315     for (int cfd : childFds) {
 316       CHECK_ERR(::close(cfd));
 317     }
 318   };
 319
 320   int r;
 321   for (auto& p : options.fdActions_) {
 322     if (p.second == PIPE_IN || p.second == PIPE_OUT) {
 323       int fds[2];
 324       // We're setting both ends of the pipe as close-on-exec. The child
 325       // doesn't need to reset the flag on its end, as we always dup2() the fd,
 326       // and dup2() fds don't share the close-on-exec flag.
 327 #if FOLLY_HAVE_PIPE2
 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       PipeInfo pinfo;
 339       pinfo.direction = p.second;
 340       int cfd;
 341       if (p.second == PIPE_IN) {
 342         // Child gets reading end
 343         pinfo.parentFd = fds[1];
 344         cfd = fds[0];
 345       } else {
 346         pinfo.parentFd = fds[0];
 347         cfd = fds[1];
 348       }
 349       p.second = cfd;  // ensure it gets dup2()ed
 350       pinfo.childFd = p.first;
 351       childFds.push_back(cfd);
 352       pipes_.push_back(pinfo);
 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   return 0;
 496 }
 497
 498 int Subprocess::runChild(const char* executable,
 499                          char** argv, char** env,
 500                          const Options& options) const {
 501   // Now, finally, exec.
 502   if (options.usePath_) {
 503     ::execvp(executable, argv);
 504   } else {
 505     ::execve(executable, argv, env);
 506   }
 507   return errno;
 508 }
 509
 510 void Subprocess::readChildErrorPipe(int pfd, const char* executable) {
 511   ChildErrorInfo info;
 512   auto rc = readNoInt(pfd, &info, sizeof(info));
 513   if (rc == 0) {
 514     // No data means the child executed successfully, and the pipe
 515     // was closed due to the close-on-exec flag being set.
 516     return;
 517   } else if (rc != sizeof(ChildErrorInfo)) {
 518     // An error occurred trying to read from the pipe, or we got a partial read.
 519     // Neither of these cases should really occur in practice.
 520     //
 521     // We can't get any error data from the child in this case, and we don't
 522     // know if it is successfully running or not.  All we can do is to return
 523     // normally, as if the child executed successfully.  If something bad
 524     // happened the caller should at least get a non-normal exit status from
 525     // the child.
 526     LOG(ERROR) << "unexpected error trying to read from child error pipe " <<
 527       "rc=" << rc << ", errno=" << errno;
 528     return;
 529   }
 530
 531   // We got error data from the child.  The child should exit immediately in
 532   // this case, so wait on it to clean up.
 533   wait();
 534
 535   // Throw to signal the error
 536   throw SubprocessSpawnError(executable, info.errCode, info.errnoValue);
 537 }
 538
 539 ProcessReturnCode Subprocess::poll() {
 540   returnCode_.enforce(ProcessReturnCode::RUNNING);
 541   DCHECK_GT(pid_, 0);
 542   int status;
 543   pid_t found = ::waitpid(pid_, &status, WNOHANG);
 544   checkUnixError(found, "waitpid");
 545   if (found != 0) {
 546     returnCode_ = ProcessReturnCode(status);
 547     pid_ = -1;
 548   }
 549   return returnCode_;
 550 }
 551
 552 bool Subprocess::pollChecked() {
 553   if (poll().state() == ProcessReturnCode::RUNNING) {
 554     return false;
 555   }
 556   checkStatus(returnCode_);
 557   return true;
 558 }
 559
 560 ProcessReturnCode Subprocess::wait() {
 561   returnCode_.enforce(ProcessReturnCode::RUNNING);
 562   DCHECK_GT(pid_, 0);
 563   int status;
 564   pid_t found;
 565   do {
 566     found = ::waitpid(pid_, &status, 0);
 567   } while (found == -1 && errno == EINTR);
 568   checkUnixError(found, "waitpid");
 569   DCHECK_EQ(found, pid_);
 570   returnCode_ = ProcessReturnCode(status);
 571   pid_ = -1;
 572   return returnCode_;
 573 }
 574
 575 void Subprocess::waitChecked() {
 576   wait();
 577   checkStatus(returnCode_);
 578 }
 579
 580 void Subprocess::sendSignal(int signal) {
 581   returnCode_.enforce(ProcessReturnCode::RUNNING);
 582   int r = ::kill(pid_, signal);
 583   checkUnixError(r, "kill");
 584 }
 585
 586 pid_t Subprocess::pid() const {
 587   return pid_;
 588 }
 589
 590 namespace {
 591
 592 std::pair<const uint8_t*, size_t> queueFront(const IOBufQueue& queue) {
 593   auto* p = queue.front();
 594   if (!p) return std::make_pair(nullptr, 0);
 595   return io::Cursor(p).peek();
 596 }
 597
 598 // fd write
 599 bool handleWrite(int fd, IOBufQueue& queue) {
 600   for (;;) {
 601     auto p = queueFront(queue);
 602     if (p.second == 0) {
 603       return true;  // EOF
 604     }
 605
 606     ssize_t n = writeNoInt(fd, p.first, p.second);
 607     if (n == -1 && errno == EAGAIN) {
 608       return false;
 609     }
 610     checkUnixError(n, "write");
 611     queue.trimStart(n);
 612   }
 613 }
 614
 615 // fd read
 616 bool handleRead(int fd, IOBufQueue& queue) {
 617   for (;;) {
 618     auto p = queue.preallocate(100, 65000);
 619     ssize_t n = readNoInt(fd, p.first, p.second);
 620     if (n == -1 && errno == EAGAIN) {
 621       return false;
 622     }
 623     checkUnixError(n, "read");
 624     if (n == 0) {
 625       return true;
 626     }
 627     queue.postallocate(n);
 628   }
 629 }
 630
 631 bool discardRead(int fd) {
 632   static const size_t bufSize = 65000;
 633   // Thread unsafe, but it doesn't matter.
 634   static std::unique_ptr<char[]> buf(new char[bufSize]);
 635
 636   for (;;) {
 637     ssize_t n = readNoInt(fd, buf.get(), bufSize);
 638     if (n == -1 && errno == EAGAIN) {
 639       return false;
 640     }
 641     checkUnixError(n, "read");
 642     if (n == 0) {
 643       return true;
 644     }
 645   }
 646 }
 647
 648 }  // namespace
 649
 650 std::pair<std::string, std::string> Subprocess::communicate(
 651     StringPiece input) {
 652   IOBufQueue inputQueue;
 653   inputQueue.wrapBuffer(input.data(), input.size());
 654
 655   auto outQueues = communicateIOBuf(std::move(inputQueue));
 656   auto outBufs = std::make_pair(outQueues.first.move(),
 657                                 outQueues.second.move());
 658   std::pair<std::string, std::string> out;
 659   if (outBufs.first) {
 660     outBufs.first->coalesce();
 661     out.first.assign(reinterpret_cast<const char*>(outBufs.first->data()),
 662                      outBufs.first->length());
 663   }
 664   if (outBufs.second) {
 665     outBufs.second->coalesce();
 666     out.second.assign(reinterpret_cast<const char*>(outBufs.second->data()),
 667                      outBufs.second->length());
 668   }
 669   return out;
 670 }
 671
 672 std::pair<IOBufQueue, IOBufQueue> Subprocess::communicateIOBuf(
 673     IOBufQueue input) {
 674   // If the user supplied a non-empty input buffer, make sure
 675   // that stdin is a pipe so we can write the data.
 676   if (!input.empty()) {
 677     // findByChildFd() will throw std::invalid_argument if no pipe for
 678     // STDIN_FILENO exists
 679     findByChildFd(STDIN_FILENO);
 680   }
 681
 682   std::pair<IOBufQueue, IOBufQueue> out;
 683
 684   auto readCallback = [&] (int pfd, int cfd) -> bool {
 685     if (cfd == STDOUT_FILENO) {
 686       return handleRead(pfd, out.first);
 687     } else if (cfd == STDERR_FILENO) {
 688       return handleRead(pfd, out.second);
 689     } else {
 690       // Don't close the file descriptor, the child might not like SIGPIPE,
 691       // just read and throw the data away.
 692       return discardRead(pfd);
 693     }
 694   };
 695
 696   auto writeCallback = [&] (int pfd, int cfd) -> bool {
 697     if (cfd == STDIN_FILENO) {
 698       return handleWrite(pfd, input);
 699     } else {
 700       // If we don't want to write to this fd, just close it.
 701       return true;
 702     }
 703   };
 704
 705   communicate(std::move(readCallback), std::move(writeCallback));
 706
 707   return out;
 708 }
 709
 710 void Subprocess::communicate(FdCallback readCallback,
 711                              FdCallback writeCallback) {
 712   returnCode_.enforce(ProcessReturnCode::RUNNING);
 713   setAllNonBlocking();
 714
 715   std::vector<pollfd> fds;
 716   fds.reserve(pipes_.size());
 717   std::vector<int> toClose;
 718   toClose.reserve(pipes_.size());
 719
 720   while (!pipes_.empty()) {
 721     fds.clear();
 722     toClose.clear();
 723
 724     for (auto& p : pipes_) {
 725       pollfd pfd;
 726       pfd.fd = p.parentFd;
 727       // Yes, backwards, PIPE_IN / PIPE_OUT are defined from the
 728       // child's point of view.
 729       if (!p.enabled) {
 730         // Still keeping fd in watched set so we get notified of POLLHUP /
 731         // POLLERR
 732         pfd.events = 0;
 733       } else if (p.direction == PIPE_IN) {
 734         pfd.events = POLLOUT;
 735       } else {
 736         pfd.events = POLLIN;
 737       }
 738       fds.push_back(pfd);
 739     }
 740
 741     int r;
 742     do {
 743       r = ::poll(fds.data(), fds.size(), -1);
 744     } while (r == -1 && errno == EINTR);
 745     checkUnixError(r, "poll");
 746
 747     for (size_t i = 0; i < pipes_.size(); ++i) {
 748       auto& p = pipes_[i];
 749       DCHECK_EQ(fds[i].fd, p.parentFd);
 750       short events = fds[i].revents;
 751
 752       bool closed = false;
 753       if (events & POLLOUT) {
 754         DCHECK(!(events & POLLIN));
 755         if (writeCallback(p.parentFd, p.childFd)) {
 756           toClose.push_back(i);
 757           closed = true;
 758         }
 759       }
 760
 761       // Call read callback on POLLHUP, to give it a chance to read (and act
 762       // on) end of file
 763       if (events & (POLLIN | POLLHUP)) {
 764         DCHECK(!(events & POLLOUT));
 765         if (readCallback(p.parentFd, p.childFd)) {
 766           toClose.push_back(i);
 767           closed = true;
 768         }
 769       }
 770
 771       if ((events & (POLLHUP | POLLERR)) && !closed) {
 772         toClose.push_back(i);
 773         closed = true;
 774       }
 775     }
 776
 777     // Close the fds in reverse order so the indexes hold after erase()
 778     for (int idx : boost::adaptors::reverse(toClose)) {
 779       auto pos = pipes_.begin() + idx;
 780       closeChecked(pos->parentFd);
 781       pipes_.erase(pos);
 782     }
 783   }
 784 }
 785
 786 void Subprocess::enableNotifications(int childFd, bool enabled) {
 787   pipes_[findByChildFd(childFd)].enabled = enabled;
 788 }
 789
 790 bool Subprocess::notificationsEnabled(int childFd) const {
 791   return pipes_[findByChildFd(childFd)].enabled;
 792 }
 793
 794 int Subprocess::findByChildFd(int childFd) const {
 795   auto pos = std::lower_bound(
 796       pipes_.begin(), pipes_.end(), childFd,
 797       [] (const PipeInfo& info, int fd) { return info.childFd < fd; });
 798   if (pos == pipes_.end() || pos->childFd != childFd) {
 799     throw std::invalid_argument(folly::to<std::string>(
 800         "child fd not found ", childFd));
 801   }
 802   return pos - pipes_.begin();
 803 }
 804
 805 void Subprocess::closeParentFd(int childFd) {
 806   int idx = findByChildFd(childFd);
 807   closeChecked(pipes_[idx].parentFd);
 808   pipes_.erase(pipes_.begin() + idx);
 809 }
 810
 811 namespace {
 812
 813 class Initializer {
 814  public:
 815   Initializer() {
 816     // We like EPIPE, thanks.
 817     ::signal(SIGPIPE, SIG_IGN);
 818   }
 819 };
 820
 821 Initializer initializer;
 822
 823 }  // namespace
 824
 825 }  // namespace folly