2 * \file ForkedCalls.cpp
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Asger Alstrup
7 * \author Angus Leeming
8 * \author Alfredo Braunstein
10 * Full author contact details are available in file CREDITS.
15 #include "support/ForkedCalls.h"
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"
24 #include "support/bind.h"
44 # include <sys/wait.h>
56 /////////////////////////////////////////////////////////////////////
60 /////////////////////////////////////////////////////////////////////
62 class Murder : public boost::signals::trackable {
65 static void killItDead(int secs, pid_t pid)
68 new Murder(secs, pid);
70 support::kill(pid, SIGKILL);
77 support::kill(pid_, SIGKILL);
78 lyxerr << "Killed " << pid_ << endl;
84 Murder(int secs, pid_t pid)
85 : timeout_(1000*secs, Timeout::ONETIME), pid_(pid)
87 timeout_.timeout.connect(lyx::bind(&Murder::kill, this));
100 /////////////////////////////////////////////////////////////////////
104 /////////////////////////////////////////////////////////////////////
106 ForkedProcess::ForkedProcess()
107 : pid_(0), retval_(0)
111 bool ForkedProcess::IAmAChild = false;
114 void ForkedProcess::emitSignal()
117 signal_->operator()(pid_, retval_);
122 // Spawn the child process
123 int ForkedProcess::run(Starttype type)
126 pid_ = generateChild();
127 if (pid_ <= 0) { // child or fork failed.
130 //we also do this in fork(), too, but maybe someone will try
138 retval_ = waitForChild();
141 // Integrate into the Controller
142 ForkedCallsController::addCall(*this);
151 bool ForkedProcess::running() const
156 #if !defined (_WIN32)
157 // Un-UNIX like, but we don't have much use for
158 // knowing if a zombie exists, so just reap it first.
160 waitpid(pid(), &waitstatus, WNOHANG);
163 // Racy of course, but it will do.
164 if (support::kill(pid(), 0) && errno == ESRCH)
170 void ForkedProcess::kill(int tol)
172 lyxerr << "ForkedProcess::kill(" << tol << ')' << endl;
174 lyxerr << "Can't kill non-existent process!" << endl;
178 int const tolerance = max(0, tol);
179 if (tolerance == 0) {
181 Murder::killItDead(0, pid());
183 int ret = support::kill(pid(), SIGHUP);
185 // The process is already dead if wait_for_death is false
186 bool const wait_for_death = (ret == 0 && errno != ESRCH);
189 Murder::killItDead(tolerance, pid());
194 pid_t ForkedProcess::fork() {
195 #if !defined (HAVE_FORK)
198 pid_t pid = ::fork();
206 // Wait for child process to finish. Returns returncode from child.
207 int ForkedProcess::waitForChild()
209 // We'll pretend that the child returns 1 on all error conditions.
213 HANDLE const hProcess = HANDLE(pid_);
215 DWORD const wait_status = ::WaitForSingleObject(hProcess, INFINITE);
217 switch (wait_status) {
218 case WAIT_OBJECT_0: {
220 if (!GetExitCodeProcess(hProcess, &exit_code)) {
221 lyxerr << "GetExitCodeProcess failed waiting for child\n"
222 << getChildErrorMessage() << endl;
228 lyxerr << "WaitForSingleObject failed waiting for child\n"
229 << getChildErrorMessage() << endl;
237 pid_t waitrpid = waitpid(pid_, &status, WUNTRACED);
238 if (waitrpid == -1) {
239 lyxerr << "LyX: Error waiting for child:"
240 << strerror(errno) << endl;
242 } else if (WIFEXITED(status)) {
243 // Child exited normally. Update return value.
244 retval_ = WEXITSTATUS(status);
246 } else if (WIFSIGNALED(status)) {
247 lyxerr << "LyX: Child didn't catch signal "
249 << "and died. Too bad." << endl;
251 } else if (WIFSTOPPED(status)) {
252 lyxerr << "LyX: Child (pid: " << pid_
253 << ") stopped on signal "
255 << ". Waiting for child to finish." << endl;
257 lyxerr << "LyX: Something rotten happened while "
258 "waiting for child " << pid_ << endl;
267 /////////////////////////////////////////////////////////////////////
271 /////////////////////////////////////////////////////////////////////
273 ForkedCall::ForkedCall(string const & path)
274 : cmd_prefix_(to_filesystem8bit(from_utf8(latexEnvCmdPrefix(path))))
278 int ForkedCall::startScript(Starttype wait, string const & what)
281 retval_ = startScript(what, SignalTypePtr());
285 command_ = trim(what);
291 int ForkedCall::startScript(string const & what, SignalTypePtr signal)
293 command_ = trim(what);
296 return run(DontWait);
300 // generate child in background
301 int ForkedCall::generateChild()
303 if (command_.empty())
306 string const line = cmd_prefix_ + command_;
308 #if !defined (_WIN32)
311 // Split the input command up into an array of words stored
312 // in a contiguous block of memory. The array contains pointers
314 // Don't forget the terminating `\0' character.
315 char const * const c_str = line.c_str();
316 vector<char> vec(c_str, c_str + line.size() + 1);
318 // Splitting the command up into an array of words means replacing
319 // the whitespace between words with '\0'. Life is complicated
320 // however, because words protected by quotes can contain whitespace.
322 // The strategy we adopt is:
323 // 1. If we're not inside quotes, then replace white space with '\0'.
324 // 2. If we are inside quotes, then don't replace the white space
325 // but do remove the quotes themselves. We do this naively by
326 // replacing the quote with '\0' which is fine if quotes
327 // delimit the entire word. However, if quotes do not delimit the
328 // entire word (i.e., open quote is inside word), simply discard
329 // them such as not to break the current word.
330 char inside_quote = 0;
331 char c_before_open_quote = ' ';
332 vector<char>::iterator it = vec.begin();
333 vector<char>::iterator itc = vec.begin();
334 vector<char>::iterator const end = vec.end();
335 for (; it != end; ++it, ++itc) {
338 if (c == '\'' || c == '"') {
339 if (c_before_open_quote == ' ')
349 c_before_open_quote = c;
351 } else if (c == inside_quote) {
352 if (c_before_open_quote == ' ')
361 // Clear what remains.
362 for (; itc != end; ++itc)
365 // Build an array of pointers to each word.
369 for (; it != end; ++it) {
370 if (*it != '\0' && prev == '\0')
371 argv.push_back(&*it);
377 if (lyxerr.debugging(Debug::FILES)) {
378 vector<char *>::iterator ait = argv.begin();
379 vector<char *>::iterator const aend = argv.end();
380 lyxerr << "<command>\n\t" << line
381 << "\n\tInterpretted as:\n\n";
382 for (; ait != aend; ++ait)
384 lyxerr << '\t'<< *ait << '\n';
385 lyxerr << "</command>" << endl;
388 pid_t const cpid = ::fork();
391 execvp(argv[0], &*argv.begin());
393 // If something goes wrong, we end up here
394 lyxerr << "execvp of \"" << command_ << "\" failed: "
395 << strerror(errno) << endl;
404 PROCESS_INFORMATION process;
406 memset(&startup, 0, sizeof(STARTUPINFO));
407 memset(&process, 0, sizeof(PROCESS_INFORMATION));
409 startup.cb = sizeof(STARTUPINFO);
411 if (CreateProcess(0, (LPSTR)line.c_str(), 0, 0, FALSE,
412 CREATE_NO_WINDOW, 0, 0, &startup, &process)) {
413 CloseHandle(process.hThread);
414 cpid = (pid_t)process.hProcess;
420 lyxerr << "Could not fork: " << strerror(errno) << endl;
427 /////////////////////////////////////////////////////////////////////
431 /////////////////////////////////////////////////////////////////////
433 namespace ForkedCallQueue {
435 /// A process in the queue
436 typedef pair<string, ForkedCall::SignalTypePtr> Process;
437 /** Add a process to the queue. Processes are forked sequentially
438 * only one is running at a time.
439 * Connect to the returned signal and you'll be informed when
440 * the process has ended.
442 ForkedCall::SignalTypePtr add(string const & process);
444 /// in-progress queue
445 static queue<Process> callQueue_;
447 /// flag whether queue is running
448 static bool running_ = 0;
455 void callback(pid_t, int);
457 ForkedCall::SignalTypePtr add(string const & process)
459 ForkedCall::SignalTypePtr ptr;
460 ptr.reset(new ForkedCall::SignalType);
461 callQueue_.push(Process(process, ptr));
470 if (callQueue_.empty())
472 Process pro = callQueue_.front();
474 // Bind our chain caller
475 pro.second->connect(lyx::bind(&ForkedCallQueue::callback, _1, _2));
477 //If we fail to fork the process, then emit the signal
478 //to tell the outside world that it failed.
479 if (call.startScript(pro.first, pro.second) > 0)
480 pro.second->operator()(0,1);
484 void callback(pid_t, int)
486 if (callQueue_.empty())
495 LYXERR(Debug::GRAPHICS, "ForkedCallQueue: waking up");
504 LYXERR(Debug::GRAPHICS, "ForkedCallQueue: I'm going to sleep");
513 } // namespace ForkedCallsQueue
517 /////////////////////////////////////////////////////////////////////
519 // ForkedCallsController
521 /////////////////////////////////////////////////////////////////////
524 string const getChildErrorMessage()
526 DWORD const error_code = ::GetLastError();
528 HLOCAL t_message = 0;
529 bool const ok = ::FormatMessage(
530 FORMAT_MESSAGE_ALLOCATE_BUFFER |
531 FORMAT_MESSAGE_FROM_SYSTEM,
533 MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
534 (LPTSTR) &t_message, 0, 0
538 ss << "LyX: Error waiting for child: " << error_code;
541 ss << ": " << (LPTSTR)t_message;
542 ::LocalFree(t_message);
544 ss << ": Error unknown.";
551 namespace ForkedCallsController {
553 typedef shared_ptr<ForkedProcess> ForkedProcessPtr;
554 typedef list<ForkedProcessPtr> ListType;
555 typedef ListType::iterator iterator;
558 /// The child processes
559 static ListType forkedCalls;
561 iterator find_pid(pid_t pid)
563 return find_if(forkedCalls.begin(), forkedCalls.end(),
564 lyx::bind(equal_to<pid_t>(),
565 lyx::bind(&ForkedCall::pid, _1),
570 void addCall(ForkedProcess const & newcall)
572 forkedCalls.push_back(newcall.clone());
576 // Check the list of dead children and emit any associated signals.
577 void handleCompletedProcesses()
579 ListType::iterator it = forkedCalls.begin();
580 ListType::iterator end = forkedCalls.end();
582 ForkedProcessPtr actCall = *it;
583 bool remove_it = false;
586 HANDLE const hProcess = HANDLE(actCall->pid());
588 DWORD const wait_status = ::WaitForSingleObject(hProcess, 0);
590 switch (wait_status) {
594 case WAIT_OBJECT_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);
602 actCall->setRetValue(exit_code);
604 CloseHandle(hProcess);
609 lyxerr << "WaitForSingleObject failed waiting for child\n"
610 << getChildErrorMessage() << endl;
611 actCall->setRetValue(1);
612 CloseHandle(hProcess);
617 pid_t pid = actCall->pid();
619 pid_t const waitrpid = waitpid(pid, &stat_loc, WNOHANG);
621 if (waitrpid == -1) {
622 lyxerr << "LyX: Error waiting for child: "
623 << strerror(errno) << endl;
625 // Child died, so pretend it returned 1
626 actCall->setRetValue(1);
629 } else if (waitrpid == 0) {
630 // Still running. Move on to the next child.
632 } else if (WIFEXITED(stat_loc)) {
633 // Ok, the return value goes into retval.
634 actCall->setRetValue(WEXITSTATUS(stat_loc));
637 } else if (WIFSIGNALED(stat_loc)) {
638 // Child died, so pretend it returned 1
639 actCall->setRetValue(1);
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;
649 lyxerr << "LyX: Something rotten happened while "
650 "waiting for child " << pid << endl;
652 // Child died, so pretend it returned 1
653 actCall->setRetValue(1);
659 forkedCalls.erase(it);
660 actCall->emitSignal();
662 /* start all over: emiting the signal can result
663 * in changing the list (Ab)
665 it = forkedCalls.begin();
673 // Kill the process prematurely and remove it from the list
674 // within tolerance secs
675 void kill(pid_t pid, int tolerance)
677 ListType::iterator it = find_pid(pid);
678 if (it == forkedCalls.end())
681 (*it)->kill(tolerance);
682 forkedCalls.erase(it);
685 } // namespace ForkedCallsController
687 } // namespace support