src/support/ForkedCalls.cpp

   1 /**
   2  * \file ForkedCalls.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Asger Alstrup
   7  * \author Angus Leeming
   8  * \author Alfredo Braunstein
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #include <config.h>
  14
  15 #include "support/ForkedCalls.h"
  16
  17 #include "support/debug.h"
  18 #include "support/filetools.h"
  19 #include "support/lstrings.h"
  20 #include "support/lyxlib.h"
  21 #include "support/os.h"
  22 #include "support/Timeout.h"
  23
  24 #include "support/bind.h"
  25
  26 #include <cerrno>
  27 #include <cstring>
  28 #include <list>
  29 #include <queue>
  30 #include <sstream>
  31 #include <utility>
  32 #include <vector>
  33
  34 #ifdef _WIN32
  35 # define SIGHUP 1
  36 # define SIGKILL 9
  37 # include <windows.h>
  38 # include <process.h>
  39 # undef max
  40 #else
  41 # include <csignal>
  42 # include <cstdlib>
  43 # ifdef HAVE_UNISTD_H
  44 #  include <unistd.h>
  45 # endif
  46 # include <sys/wait.h>
  47 #endif
  48
  49 using namespace std;
  50
  51
  52 namespace lyx {
  53 namespace support {
  54
  55 namespace {
  56
  57 /////////////////////////////////////////////////////////////////////
  58 //
  59 // Murder
  60 //
  61 /////////////////////////////////////////////////////////////////////
  62
  63 class Murder {
  64 public:
  65         //
  66         static void killItDead(int secs, pid_t pid)
  67         {
  68                 if (secs > 0)
  69                         new Murder(secs, pid);
  70                 else if (pid != 0)
  71                         support::kill(pid, SIGKILL);
  72         }
  73
  74         //
  75         void kill()
  76         {
  77                 if (pid_ != 0)
  78                         support::kill(pid_, SIGKILL);
  79                 lyxerr << "Killed " << pid_ << endl;
  80                 delete this;
  81         }
  82
  83 private:
  84         //
  85         Murder(int secs, pid_t pid)
  86                 : timeout_(1000*secs, Timeout::ONETIME), pid_(pid)
  87         {
  88                 // Connection is closed with this.
  89                 timeout_.timeout.connect([this](){ kill(); });
  90                 timeout_.start();
  91         }
  92
  93         //
  94         Timeout timeout_;
  95         //
  96         pid_t pid_;
  97 };
  98
  99 } // namespace
 100
 101
 102 /////////////////////////////////////////////////////////////////////
 103 //
 104 // ForkedProcess
 105 //
 106 /////////////////////////////////////////////////////////////////////
 107
 108 ForkedProcess::ForkedProcess()
 109         : pid_(0), retval_(0)
 110 {}
 111
 112
 113 bool ForkedProcess::IAmAChild = false;
 114
 115
 116 void ForkedProcess::emitSignal()
 117 {
 118         if (signal_) {
 119                 signal_->operator()(pid_, retval_);
 120         }
 121 }
 122
 123
 124 // Spawn the child process
 125 int ForkedProcess::run(Starttype type)
 126 {
 127         retval_ = 0;
 128         pid_ = generateChild();
 129         if (pid_ <= 0) { // child or fork failed.
 130                 retval_ = 1;
 131                 if (pid_ == 0)
 132                         //we also do this in fork(), too, but maybe someone will try
 133                         //to bypass that
 134                         IAmAChild = true;
 135                 return retval_;
 136         }
 137
 138         switch (type) {
 139         case Wait:
 140                 retval_ = waitForChild();
 141                 break;
 142         case DontWait: {
 143                 // Integrate into the Controller
 144                 ForkedCallsController::addCall(*this);
 145                 break;
 146         }
 147         }
 148
 149         return retval_;
 150 }
 151
 152
 153 bool ForkedProcess::running() const
 154 {
 155         if (pid() <= 0)
 156                 return false;
 157
 158 #if !defined (_WIN32)
 159         // Un-UNIX like, but we don't have much use for
 160         // knowing if a zombie exists, so just reap it first.
 161         int waitstatus;
 162         waitpid(pid(), &waitstatus, WNOHANG);
 163 #endif
 164
 165         // Racy of course, but it will do.
 166         if (support::kill(pid(), 0) && errno == ESRCH)
 167                 return false;
 168         return true;
 169 }
 170
 171
 172 void ForkedProcess::kill(int tol)
 173 {
 174         lyxerr << "ForkedProcess::kill(" << tol << ')' << endl;
 175         if (pid() <= 0) {
 176                 lyxerr << "Can't kill non-existent process!" << endl;
 177                 return;
 178         }
 179
 180         int const tolerance = max(0, tol);
 181         if (tolerance == 0) {
 182                 // Kill it dead NOW!
 183                 Murder::killItDead(0, pid());
 184         } else {
 185                 int ret = support::kill(pid(), SIGHUP);
 186
 187                 // The process is already dead if wait_for_death is false
 188                 bool const wait_for_death = (ret == 0 && errno != ESRCH);
 189
 190                 if (wait_for_death)
 191                         Murder::killItDead(tolerance, pid());
 192         }
 193 }
 194
 195
 196 pid_t ForkedProcess::fork() {
 197 #if !defined (HAVE_FORK)
 198         return -1;
 199 #else
 200         pid_t pid = ::fork();
 201         if (pid == 0)
 202                 IAmAChild = true;
 203         return pid;
 204 #endif
 205 }
 206
 207
 208 // Wait for child process to finish. Returns returncode from child.
 209 int ForkedProcess::waitForChild()
 210 {
 211         // We'll pretend that the child returns 1 on all error conditions.
 212         retval_ = 1;
 213
 214 #if defined (_WIN32)
 215         HANDLE const hProcess = HANDLE(pid_);
 216
 217         DWORD const wait_status = ::WaitForSingleObject(hProcess, INFINITE);
 218
 219         switch (wait_status) {
 220         case WAIT_OBJECT_0: {
 221                 DWORD exit_code = 0;
 222                 if (!GetExitCodeProcess(hProcess, &exit_code)) {
 223                         lyxerr << "GetExitCodeProcess failed waiting for child\n"
 224                                << getChildErrorMessage() << endl;
 225                 } else
 226                         retval_ = exit_code;
 227                 break;
 228         }
 229         case WAIT_FAILED:
 230                 lyxerr << "WaitForSingleObject failed waiting for child\n"
 231                        << getChildErrorMessage() << endl;
 232                 break;
 233         }
 234
 235 #else
 236         int status;
 237         bool wait = true;
 238         while (wait) {
 239                 pid_t waitrpid = waitpid(pid_, &status, WUNTRACED);
 240                 if (waitrpid == -1) {
 241                         lyxerr << "LyX: Error waiting for child:"
 242                                << strerror(errno) << endl;
 243                         wait = false;
 244                 } else if (WIFEXITED(status)) {
 245                         // Child exited normally. Update return value.
 246                         retval_ = WEXITSTATUS(status);
 247                         wait = false;
 248                 } else if (WIFSIGNALED(status)) {
 249                         lyxerr << "LyX: Child didn't catch signal "
 250                                << WTERMSIG(status)
 251                                << "and died. Too bad." << endl;
 252                         wait = false;
 253                 } else if (WIFSTOPPED(status)) {
 254                         lyxerr << "LyX: Child (pid: " << pid_
 255                                << ") stopped on signal "
 256                                << WSTOPSIG(status)
 257                                << ". Waiting for child to finish." << endl;
 258                 } else {
 259                         lyxerr << "LyX: Something rotten happened while "
 260                                 "waiting for child " << pid_ << endl;
 261                         wait = false;
 262                 }
 263         }
 264 #endif
 265         return retval_;
 266 }
 267
 268
 269 /////////////////////////////////////////////////////////////////////
 270 //
 271 // ForkedCall
 272 //
 273 /////////////////////////////////////////////////////////////////////
 274
 275 ForkedCall::ForkedCall(string const & path, string const & lpath)
 276         : cmd_prefix_(to_filesystem8bit(from_utf8(latexEnvCmdPrefix(path, lpath))))
 277 {}
 278
 279
 280 int ForkedCall::startScript(Starttype wait, string const & what)
 281 {
 282         if (wait != Wait) {
 283                 retval_ = startScript(what, sigPtr());
 284                 return retval_;
 285         }
 286
 287         command_ = commandPrep(trim(what));
 288         signal_.reset();
 289         return run(Wait);
 290 }
 291
 292
 293 int ForkedCall::startScript(string const & what, sigPtr signal)
 294 {
 295         command_ = commandPrep(trim(what));
 296         signal_  = signal;
 297
 298         return run(DontWait);
 299 }
 300
 301
 302 // generate child in background
 303 int ForkedCall::generateChild()
 304 {
 305         if (command_.empty())
 306                 return 1;
 307
 308         string const prefixed_command = cmd_prefix_ + command_;
 309
 310 #if !defined (_WIN32)
 311         // POSIX
 312
 313         // Split the input command up into an array of words stored
 314         // in a contiguous block of memory. The array contains pointers
 315         // to each word.
 316         // Don't forget the terminating `\0' character.
 317         char const * const c_str = prefixed_command.c_str();
 318         vector<char> vec(c_str, c_str + prefixed_command.size() + 1);
 319
 320         // Splitting the command up into an array of words means replacing
 321         // the whitespace between words with '\0'. Life is complicated
 322         // however, because words protected by quotes can contain whitespace.
 323         //
 324         // The strategy we adopt is:
 325         // 1. If we're not inside quotes, then replace white space with '\0'.
 326         // 2. If we are inside quotes, then don't replace the white space
 327         //    but do remove the quotes themselves. We do this naively by
 328         //    replacing the quote with '\0' which is fine if quotes
 329         //    delimit the entire word. However, if quotes do not delimit the
 330         //    entire word (i.e., open quote is inside word), simply discard
 331         //    them such as not to break the current word.
 332         char inside_quote = 0;
 333         char c_before_open_quote = ' ';
 334         vector<char>::iterator it = vec.begin();
 335         vector<char>::iterator itc = vec.begin();
 336         vector<char>::iterator const end = vec.end();
 337         for (; it != end; ++it, ++itc) {
 338                 char const c = *it;
 339                 if (!inside_quote) {
 340                         if (c == '\'' || c == '"') {
 341                                 if (c_before_open_quote == ' ')
 342                                         *itc = '\0';
 343                                 else
 344                                         --itc;
 345                                 inside_quote = c;
 346                         } else {
 347                                 if (c == ' ')
 348                                         *itc = '\0';
 349                                 else
 350                                         *itc = c;
 351                                 c_before_open_quote = c;
 352                         }
 353                 } else if (c == inside_quote) {
 354                         if (c_before_open_quote == ' ')
 355                                 *itc = '\0';
 356                         else
 357                                 --itc;
 358                         inside_quote = 0;
 359                 } else
 360                         *itc = c;
 361         }
 362
 363         // Clear what remains.
 364         for (; itc != end; ++itc)
 365                 *itc = '\0';
 366
 367         // Build an array of pointers to each word.
 368         it = vec.begin();
 369         vector<char *> argv;
 370         char prev = '\0';
 371         for (; it != end; ++it) {
 372                 if (*it != '\0' && prev == '\0')
 373                         argv.push_back(&*it);
 374                 prev = *it;
 375         }
 376         argv.push_back(nullptr);
 377
 378         // Debug output.
 379         if (lyxerr.debugging(Debug::FILES)) {
 380                 vector<char *>::iterator ait = argv.begin();
 381                 vector<char *>::iterator const aend = argv.end();
 382                 lyxerr << "<command>\n\t" << prefixed_command
 383                        << "\n\tInterpreted as:\n\n";
 384                 for (; ait != aend; ++ait)
 385                         if (*ait)
 386                                 lyxerr << '\t'<< *ait << '\n';
 387                 lyxerr << "</command>" << endl;
 388         }
 389
 390         pid_t const cpid = ::fork();
 391         if (cpid == 0) {
 392                 // Child
 393                 execvp(argv[0], &*argv.begin());
 394
 395                 // If something goes wrong, we end up here
 396                 lyxerr << "execvp of \"" << command_ << "\" failed: "
 397                        << strerror(errno) << endl;
 398                 _exit(1);
 399         }
 400 #else
 401         // Windows
 402
 403         pid_t cpid = -1;
 404
 405         STARTUPINFO startup;
 406         PROCESS_INFORMATION process;
 407
 408         memset(&startup, 0, sizeof(STARTUPINFO));
 409         memset(&process, 0, sizeof(PROCESS_INFORMATION));
 410
 411         startup.cb = sizeof(STARTUPINFO);
 412
 413         if (CreateProcess(0, (LPSTR)command_.c_str(), 0, 0, FALSE,
 414                 CREATE_NO_WINDOW, 0, 0, &startup, &process)) {
 415                 CloseHandle(process.hThread);
 416                 cpid = (pid_t)process.hProcess;
 417         }
 418 #endif
 419
 420         if (cpid < 0) {
 421                 // Error.
 422                 lyxerr << "Could not fork: " << strerror(errno) << endl;
 423         }
 424
 425         return cpid;
 426 }
 427
 428
 429 /////////////////////////////////////////////////////////////////////
 430 //
 431 // ForkedCallQueue
 432 //
 433 /////////////////////////////////////////////////////////////////////
 434
 435 namespace ForkedCallQueue {
 436
 437 /// A process in the queue
 438 typedef pair<string, ForkedCall::sigPtr> Process;
 439
 440 /// in-progress queue
 441 static queue<Process> callQueue_;
 442
 443 /// flag whether queue is running
 444 static bool running_ = false;
 445
 446 ///
 447 void startCaller();
 448 ///
 449 void stopCaller();
 450 ///
 451 void callback(pid_t, int);
 452
 453 /** Add a process to the queue. Processes are forked sequentially
 454  *  only one is running at a time.
 455  *  Connect to the returned signal and you'll be informed when
 456  *  the process has ended.
 457  */
 458 ForkedCall::sigPtr add(string const & process)
 459 {
 460         ForkedCall::sigPtr ptr;
 461         ptr.reset(new ForkedCall::sig);
 462         callQueue_.push(Process(process, ptr));
 463         if (!running_)
 464                 startCaller();
 465         return ptr;
 466 }
 467
 468
 469 void callNext()
 470 {
 471         if (callQueue_.empty())
 472                 return;
 473         Process pro = callQueue_.front();
 474         callQueue_.pop();
 475         // Bind our chain caller
 476         pro.second->connect(callback);
 477         ForkedCall call;
 478         //If we fail to fork the process, then emit the signal
 479         //to tell the outside world that it failed.
 480         if (call.startScript(pro.first, pro.second) > 0)
 481                 pro.second->operator()(0,1);
 482 }
 483
 484
 485 void callback(pid_t, int)
 486 {
 487         if (callQueue_.empty())
 488                 stopCaller();
 489         else
 490                 callNext();
 491 }
 492
 493
 494 void startCaller()
 495 {
 496         LYXERR(Debug::GRAPHICS, "ForkedCallQueue: waking up");
 497         running_ = true ;
 498         callNext();
 499 }
 500
 501
 502 void stopCaller()
 503 {
 504         running_ = false ;
 505         LYXERR(Debug::GRAPHICS, "ForkedCallQueue: I'm going to sleep");
 506 }
 507
 508
 509 bool running()
 510 {
 511         return running_;
 512 }
 513
 514 } // namespace ForkedCallQueue
 515
 516
 517 /////////////////////////////////////////////////////////////////////
 518 //
 519 // ForkedCallsController
 520 //
 521 /////////////////////////////////////////////////////////////////////
 522
 523 #if defined(_WIN32)
 524 string const getChildErrorMessage()
 525 {
 526         DWORD const error_code = ::GetLastError();
 527
 528         HLOCAL t_message = 0;
 529         bool const ok = ::FormatMessage(
 530                 FORMAT_MESSAGE_ALLOCATE_BUFFER |
 531                 FORMAT_MESSAGE_FROM_SYSTEM,
 532                 0, error_code,
 533                 MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
 534                 (LPTSTR) &t_message, 0, 0
 535                 ) != 0;
 536
 537         ostringstream ss;
 538         ss << "LyX: Error waiting for child: " << error_code;
 539
 540         if (ok) {
 541                 ss << ": " << (LPTSTR)t_message;
 542                 ::LocalFree(t_message);
 543         } else
 544                 ss << ": Error unknown.";
 545
 546         return ss.str();
 547 }
 548 #endif
 549
 550
 551 namespace ForkedCallsController {
 552
 553 typedef shared_ptr<ForkedProcess> ForkedProcessPtr;
 554 typedef list<ForkedProcessPtr> ListType;
 555 typedef ListType::iterator iterator;
 556
 557
 558 /// The child processes
 559 static ListType forkedCalls;
 560
 561 iterator find_pid(pid_t pid)
 562 {
 563         return find_if(forkedCalls.begin(), forkedCalls.end(),
 564                             lyx::bind(equal_to<pid_t>(),
 565                             lyx::bind(&ForkedCall::pid, _1),
 566                             pid));
 567 }
 568
 569
 570 void addCall(ForkedProcess const & newcall)
 571 {
 572         forkedCalls.push_back(newcall.clone());
 573 }
 574
 575
 576 // Check the list of dead children and emit any associated signals.
 577 void handleCompletedProcesses()
 578 {
 579         ListType::iterator it  = forkedCalls.begin();
 580         ListType::iterator end = forkedCalls.end();
 581         while (it != end) {
 582                 ForkedProcessPtr actCall = *it;
 583                 bool remove_it = false;
 584
 585 #if defined(_WIN32)
 586                 HANDLE const hProcess = HANDLE(actCall->pid());
 587
 588                 DWORD const wait_status = ::WaitForSingleObject(hProcess, 0);
 589
 590                 switch (wait_status) {
 591                 case WAIT_TIMEOUT:
 592                         // Still running
 593                         break;
 594                 case WAIT_OBJECT_0: {
 595                         DWORD exit_code = 0;
 596                         if (!GetExitCodeProcess(hProcess, &exit_code)) {
 597                                 lyxerr << "GetExitCodeProcess failed waiting for child\n"
 598                                        << getChildErrorMessage() << endl;
 599                                 // Child died, so pretend it returned 1
 600                                 actCall->setRetValue(1);
 601                         } else {
 602                                 actCall->setRetValue(exit_code);
 603                         }
 604                         CloseHandle(hProcess);
 605                         remove_it = true;
 606                         break;
 607                 }
 608                 case WAIT_FAILED:
 609                         lyxerr << "WaitForSingleObject failed waiting for child\n"
 610                                << getChildErrorMessage() << endl;
 611                         actCall->setRetValue(1);
 612                         CloseHandle(hProcess);
 613                         remove_it = true;
 614                         break;
 615                 }
 616 #else
 617                 pid_t pid = actCall->pid();
 618                 int stat_loc;
 619                 pid_t const waitrpid = waitpid(pid, &stat_loc, WNOHANG);
 620
 621                 if (waitrpid == -1) {
 622                         lyxerr << "LyX: Error waiting for child: "
 623                                << strerror(errno) << endl;
 624
 625                         // Child died, so pretend it returned 1
 626                         actCall->setRetValue(1);
 627                         remove_it = true;
 628
 629                 } else if (waitrpid == 0) {
 630                         // Still running. Move on to the next child.
 631
 632                 } else if (WIFEXITED(stat_loc)) {
 633                         // Ok, the return value goes into retval.
 634                         actCall->setRetValue(WEXITSTATUS(stat_loc));
 635                         remove_it = true;
 636
 637                 } else if (WIFSIGNALED(stat_loc)) {
 638                         // Child died, so pretend it returned 1
 639                         actCall->setRetValue(1);
 640                         remove_it = true;
 641
 642                 } else if (WIFSTOPPED(stat_loc)) {
 643                         lyxerr << "LyX: Child (pid: " << pid
 644                                << ") stopped on signal "
 645                                << WSTOPSIG(stat_loc)
 646                                << ". Waiting for child to finish." << endl;
 647
 648                 } else {
 649                         lyxerr << "LyX: Something rotten happened while "
 650                                 "waiting for child " << pid << endl;
 651
 652                         // Child died, so pretend it returned 1
 653                         actCall->setRetValue(1);
 654                         remove_it = true;
 655                 }
 656 #endif
 657
 658                 if (remove_it) {
 659                         forkedCalls.erase(it);
 660                         actCall->emitSignal();
 661
 662                         /* start all over: emitting the signal can result
 663                          * in changing the list (Ab)
 664                          */
 665                         it = forkedCalls.begin();
 666                 } else {
 667                         ++it;
 668                 }
 669         }
 670 }
 671
 672
 673 // Kill the process prematurely and remove it from the list
 674 // within tolerance secs
 675 void kill(pid_t pid, int tolerance)
 676 {
 677         ListType::iterator it = find_pid(pid);
 678         if (it == forkedCalls.end())
 679                 return;
 680
 681         (*it)->kill(tolerance);
 682         forkedCalls.erase(it);
 683 }
 684
 685 } // namespace ForkedCallsController
 686
 687 } // namespace support
 688 } // namespace lyx