X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Flib%2Fjob.cc;h=52558046ae8ec66ecd580194bf3f51558efd504e;hb=fc1441eeaa3c0805c37809685ea7a3f5ca173666;hp=e78a9131581e6183ceefc2fb96ac20a4b28f421e;hpb=4ca2fcc360bbae05e896590fd53327616f9bd2a5;p=dcpomatic.git diff --git a/src/lib/job.cc b/src/lib/job.cc index e78a91315..52558046a 100644 --- a/src/lib/job.cc +++ b/src/lib/job.cc @@ -1,51 +1,81 @@ /* - Copyright (C) 2012 Carl Hetherington + Copyright (C) 2012-2021 Carl Hetherington - This program is free software; you can redistribute it and/or modify + This file is part of DCP-o-matic. + + DCP-o-matic is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. - This program is distributed in the hope that it will be useful, + DCP-o-matic is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + along with DCP-o-matic. If not, see . */ -/** @file src/job.cc +/** @file src/job.cc * @brief A parent class to represent long-running tasks which are run in their own thread. */ -#include -#include -#include #include "job.h" #include "util.h" - -using namespace std; -using namespace boost; - -/** @param s FilmState for the film that we are operating on. - * @param o Options. - * @param l A log that we can write to. - */ -Job::Job (shared_ptr s, shared_ptr o, Log* l) - : _fs (s) - , _opt (o) - , _log (l) +#include "cross.h" +#include "exceptions.h" +#include "film.h" +#include "log.h" +#include "dcpomatic_log.h" +#include "compose.hpp" +#include +#include +#include +#include +#include +#include + +#include "i18n.h" + +using std::string; +using std::list; +using std::cout; +using std::shared_ptr; +using boost::optional; +using std::function; +using namespace dcpomatic; + +/** @param film Associated film, or 0 */ +Job::Job (shared_ptr film) + : _film (film) , _state (NEW) , _start_time (0) - , _progress_unknown (false) + , _sub_start_time (0) + , _progress (0) , _ran_for (0) { - assert (_log); - - descend (1); + +} + +Job::~Job () +{ +#ifdef DCPOMATIC_DEBUG + /* Any subclass should have called stop_thread in its destructor */ + assert (!_thread.joinable()); +#endif +} + +void +Job::stop_thread () +{ + boost::this_thread::disable_interruption dis; + + _thread.interrupt (); + try { + _thread.join (); + } catch (...) {} } /** Start the job in a separate thread, returning immediately */ @@ -54,34 +84,181 @@ Job::start () { set_state (RUNNING); _start_time = time (0); - boost::thread (boost::bind (&Job::run_wrapper, this)); + _sub_start_time = time (0); + _thread = boost::thread (boost::bind(&Job::run_wrapper, this)); +#ifdef DCPOMATIC_LINUX + pthread_setname_np (_thread.native_handle(), "job-wrapper"); +#endif } /** A wrapper for the ::run() method to catch exceptions */ void Job::run_wrapper () { + start_of_thread (String::compose("Job-%1", json_name())); + try { run (); - } catch (libdcp::FileError& e) { - + } catch (dcp::FileError& e) { + + string m = String::compose (_("An error occurred whilst handling the file %1."), boost::filesystem::path (e.filename()).leaf()); + + try { + auto const s = boost::filesystem::space (e.filename()); + if (s.available < pow (1024, 3)) { + m += N_("\n\n"); + m += _("The drive that the film is stored on is low in disc space. Free some more space and try again."); + } + } catch (...) { + + } + + set_error (e.what(), m); + set_progress (1); + set_state (FINISHED_ERROR); + + } catch (dcp::StartCompressionError& e) { + + bool done = false; + +#ifdef DCPOMATIC_WINDOWS +#if (__GNUC__ && !__x86_64__) + /* 32-bit */ + set_error ( + _("Failed to encode the DCP."), + _("This error has probably occurred because you are running the 32-bit version of DCP-o-matic and " + "trying to use too many encoding threads. Please reduce the 'number of threads DCP-o-matic should " + "use' in the General tab of Preferences and try again.") + ); + done = true; +#else + /* 64-bit */ + if (running_32_on_64()) { + set_error ( + _("Failed to encode the DCP."), + _("This error has probably occurred because you are running the 32-bit version of DCP-o-matic. Please re-install DCP-o-matic with the 64-bit installer and try again.") + ); + done = true; + } +#endif +#endif + + if (!done) { + set_error ( + e.what (), + string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM + ); + } + + set_progress (1); + set_state (FINISHED_ERROR); + + } catch (OpenFileError& e) { + + set_error ( + String::compose (_("Could not open %1"), e.file().string()), + String::compose ( + _("DCP-o-matic could not open the file %1 (%2). Perhaps it does not exist or is in an unexpected format."), + boost::filesystem::absolute (e.file()).string(), + e.what() + ) + ); + + set_progress (1); + set_state (FINISHED_ERROR); + + } catch (boost::filesystem::filesystem_error& e) { + + if (e.code() == boost::system::errc::no_such_file_or_directory) { + set_error ( + String::compose (_("Could not open %1"), e.path1().string ()), + String::compose ( + _("DCP-o-matic could not open the file %1 (%2). Perhaps it does not exist or is in an unexpected format."), + boost::filesystem::absolute (e.path1()).string(), + e.what() + ) + ); + } else { + set_error ( + e.what (), + string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM + ); + } + + set_progress (1); + set_state (FINISHED_ERROR); + + } catch (boost::thread_interrupted &) { + + set_state (FINISHED_CANCELLED); + + } catch (sub::SubripError& e) { + + string extra = "Error is near:\n"; + for (auto i: e.context()) { + extra += i + "\n"; + } + + set_error (e.what (), extra); + set_progress (1); + set_state (FINISHED_ERROR); + + } catch (std::bad_alloc& e) { + + set_error (_("Out of memory"), _("There was not enough memory to do this. If you are running a 32-bit operating system try reducing the number of encoding threads in the General tab of Preferences.")); + set_progress (1); + set_state (FINISHED_ERROR); + + } catch (dcp::ReadError& e) { + + set_error (e.message(), e.detail().get_value_or("")); + set_progress (1); + set_state (FINISHED_ERROR); + + } catch (KDMError& e) { + + set_error (e.summary(), e.detail()); set_progress (1); set_state (FINISHED_ERROR); - stringstream s; - s << e.what() << "(" << filesystem::path (e.filename()).leaf() << ")"; - set_error (s.str ()); - + + } catch (FileError& e) { + + set_error (e.what(), e.what()); + set_progress (1); + set_state (FINISHED_ERROR); + } catch (std::exception& e) { + set_error ( + e.what (), + string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM + ); + set_progress (1); set_state (FINISHED_ERROR); - set_error (e.what ()); + } catch (...) { + + set_error ( + _("Unknown error"), + string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM + ); + + set_progress (1); + set_state (FINISHED_ERROR); } } +/** @return true if this job is new (ie has not started running) */ +bool +Job::is_new () const +{ + boost::mutex::scoped_lock lm (_state_mutex); + return _state == NEW; +} + /** @return true if the job is running */ bool Job::running () const @@ -95,7 +272,7 @@ bool Job::finished () const { boost::mutex::scoped_lock lm (_state_mutex); - return _state == FINISHED_OK || _state == FINISHED_ERROR; + return _state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED; } /** @return true if the job has finished successfully */ @@ -114,153 +291,335 @@ Job::finished_in_error () const return _state == FINISHED_ERROR; } +bool +Job::finished_cancelled () const +{ + boost::mutex::scoped_lock lm (_state_mutex); + return _state == FINISHED_CANCELLED; +} + +bool +Job::paused_by_user () const +{ + boost::mutex::scoped_lock lm (_state_mutex); + return _state == PAUSED_BY_USER; +} + +bool +Job::paused_by_priority () const +{ + boost::mutex::scoped_lock lm (_state_mutex); + return _state == PAUSED_BY_PRIORITY; +} + /** Set the state of this job. * @param s New state. */ void Job::set_state (State s) { - boost::mutex::scoped_lock lm (_state_mutex); - _state = s; + bool finished = false; - if (_state == FINISHED_OK || _state == FINISHED_ERROR) { - _ran_for = elapsed_time (); + { + boost::mutex::scoped_lock lm (_state_mutex); + _state = s; + + if (_state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED) { + _ran_for = time(0) - _start_time; + finished = true; + _sub_name.clear (); + } } -} -/** A hack to work around our lack of cross-thread - * signalling; this emits Finished, and listeners - * assume that it will be emitted in the GUI thread, - * so this method must be called from the GUI thread. - */ -void -Job::emit_finished () -{ - Finished (); + if (finished) { + emit (boost::bind (boost::ref (Finished))); + FinishedImmediate (); + } } -/** @return Time (in seconds) that this job has been running */ +/** @return DCPTime (in seconds) that this sub-job has been running */ int -Job::elapsed_time () const +Job::elapsed_sub_time () const { - if (_start_time == 0) { + if (_sub_start_time == 0) { return 0; } - - return time (0) - _start_time; + + return time (0) - _sub_start_time; +} + +/** Check to see if this job has been interrupted or paused */ +void +Job::check_for_interruption_or_pause () +{ + boost::this_thread::interruption_point (); + + boost::mutex::scoped_lock lm (_state_mutex); + while (_state == PAUSED_BY_USER || _state == PAUSED_BY_PRIORITY) { + emit (boost::bind (boost::ref (Progress))); + _pause_changed.wait (lm); + } } /** Set the progress of the current part of the job. * @param p Progress (from 0 to 1) + * @param force Do not ignore this update, even if it hasn't been long since the last one. */ void -Job::set_progress (float p) +Job::set_progress (float p, bool force) { - boost::mutex::scoped_lock lm (_progress_mutex); - _stack.back().normalised = p; + check_for_interruption_or_pause (); + + if (!force) { + /* Check for excessively frequent progress reporting */ + boost::mutex::scoped_lock lm (_progress_mutex); + struct timeval now; + gettimeofday (&now, 0); + if (_last_progress_update && _last_progress_update->tv_sec > 0) { + double const elapsed = (now.tv_sec + now.tv_usec / 1000000.0) + - (_last_progress_update->tv_sec + _last_progress_update->tv_usec / 1000000.0); + if (elapsed < 0.5) { + return; + } + } + _last_progress_update = now; + } + + set_progress_common (p); } -/** @return fractional overall progress, or -1 if not known */ -float -Job::overall_progress () const +void +Job::set_progress_common (optional p) { - boost::mutex::scoped_lock lm (_progress_mutex); - if (_progress_unknown) { - return -1; + { + boost::mutex::scoped_lock lm (_progress_mutex); + _progress = p; } - float overall = 0; - float factor = 1; - for (list::const_iterator i = _stack.begin(); i != _stack.end(); ++i) { - factor *= i->allocation; - overall += i->normalised * factor; - } - - if (overall > 1) { - overall = 1; - } - - return overall; + emit (boost::bind (boost::ref (Progress))); } -/** Ascend up one level in terms of progress reporting; see descend() */ -void -Job::ascend () +/** @return fractional progress of the current sub-job, if known */ +optional +Job::progress () const { boost::mutex::scoped_lock lm (_progress_mutex); - - assert (!_stack.empty ()); - float const a = _stack.back().allocation; - _stack.pop_back (); - _stack.back().normalised += a; -} - -/** Descend down one level in terms of progress reporting; e.g. if - * there is a task which is split up into N subtasks, each of which - * report their progress from 0 to 100%, call descend() before executing - * each subtask, and ascend() afterwards to ensure that overall progress - * is reported correctly. - * - * @param a Fraction (from 0 to 1) of the current task to allocate to the subtask. - */ + return _progress; +} + void -Job::descend (float a) +Job::sub (string n) { - boost::mutex::scoped_lock lm (_progress_mutex); - _stack.push_back (Level (a)); + { + boost::mutex::scoped_lock lm (_progress_mutex); + LOG_GENERAL ("Sub-job %1 starting", n); + _sub_name = n; + } + + set_progress (0, true); + _sub_start_time = time (0); } -/** @return Any error string that the job has generated */ string -Job::error () const +Job::error_details () const { boost::mutex::scoped_lock lm (_state_mutex); - return _error; + return _error_details; +} + +/** @return A summary of any error that the job has generated */ +string +Job::error_summary () const +{ + boost::mutex::scoped_lock lm (_state_mutex); + return _error_summary; } /** Set the current error string. - * @param e New error string. + * @param s New error string. + * @param d New error detail string. */ void -Job::set_error (string e) +Job::set_error (string s, string d) { + if (_film) { + _film->log()->log (String::compose ("Error in job: %1 (%2)", s, d), LogEntry::TYPE_ERROR); + } + boost::mutex::scoped_lock lm (_state_mutex); - _error = e; + _error_summary = s; + _error_details = d; } -/** Say that this job's progress will always be unknown */ +/** Say that this job's progress will be unknown until further notice */ void Job::set_progress_unknown () { - boost::mutex::scoped_lock lm (_progress_mutex); - _progress_unknown = true; + check_for_interruption_or_pause (); + set_progress_common (optional ()); } /** @return Human-readable status of this job */ string Job::status () const { - float const p = overall_progress (); - int const t = elapsed_time (); + optional p = progress (); + int const t = elapsed_sub_time (); int const r = remaining_time (); - - stringstream s; - if (!finished () && p >= 0 && t > 10 && r > 0) { - s << rint (p * 100) << "%; " << seconds_to_approximate_hms (r) << " remaining"; - } else if (!finished () && (t <= 10 || r == 0)) { - s << rint (p * 100) << "%"; + + string s; + if (!finished () && p) { + int pc = lrintf (p.get() * 100); + if (pc == 100) { + /* 100% makes it sound like we've finished when we haven't */ + pc = 99; + } + + char buffer[64]; + snprintf (buffer, sizeof(buffer), "%d%%", pc); + s += buffer; + + if (t > 10 && r > 0) { + auto now = boost::posix_time::second_clock::local_time(); + auto finish = now + boost::posix_time::seconds(r); + char finish_string[16]; + snprintf (finish_string, sizeof(finish_string), "%02d:%02d", int(finish.time_of_day().hours()), int(finish.time_of_day().minutes())); + string day; + if (now.date() != finish.date()) { + /// TRANSLATORS: the %1 in this string will be filled in with a day of the week + /// to say what day a job will finish. + day = String::compose (_(" on %1"), day_of_week_to_string(finish.date().day_of_week())); + } + /// TRANSLATORS: "remaining; finishing at" here follows an amount of time that is remaining + /// on an operation; after it is an estimated wall-clock completion time. + s += String::compose( + _("; %1 remaining; finishing at %2%3"), + seconds_to_approximate_hms(r), finish_string, day + ); + } } else if (finished_ok ()) { - s << "OK (ran for " << seconds_to_hms (_ran_for) << ")"; + s = String::compose (_("OK (ran for %1)"), seconds_to_hms (_ran_for)); } else if (finished_in_error ()) { - s << "Error (" << error() << ")"; + s = String::compose (_("Error: %1"), error_summary ()); + } else if (finished_cancelled ()) { + s = _("Cancelled"); + } + + return s; +} + +string +Job::json_status () const +{ + boost::mutex::scoped_lock lm (_state_mutex); + + switch (_state) { + case NEW: + return N_("new"); + case RUNNING: + return N_("running"); + case PAUSED_BY_USER: + case PAUSED_BY_PRIORITY: + return N_("paused"); + case FINISHED_OK: + return N_("finished_ok"); + case FINISHED_ERROR: + return N_("finished_error"); + case FINISHED_CANCELLED: + return N_("finished_cancelled"); } - return s.str (); + return ""; } -/** @return An estimate of the remaining time for this job, in seconds */ +/** @return An estimate of the remaining time for this sub-job, in seconds */ int Job::remaining_time () const { - return elapsed_time() / overall_progress() - elapsed_time(); + if (progress().get_value_or(0) == 0) { + return elapsed_sub_time (); + } + + return elapsed_sub_time() / progress().get() - elapsed_sub_time(); +} + +void +Job::cancel () +{ + if (!_thread.joinable()) { + return; + } + + if (paused_by_user() || paused_by_priority()) { + resume (); + } + + _thread.interrupt (); + _thread.join (); +} + +/** @return true if the job was paused, false if it was not running */ +bool +Job::pause_by_user () +{ + bool paused = false; + { + boost::mutex::scoped_lock lm (_state_mutex); + /* We can set _state here directly because we have a lock and we aren't + setting the job to FINISHED_* + */ + if (_state == RUNNING) { + paused = true; + _state = PAUSED_BY_USER; + } + } + + if (paused) { + _pause_changed.notify_all (); + } + + return paused; +} + +void +Job::pause_by_priority () +{ + if (running ()) { + set_state (PAUSED_BY_PRIORITY); + _pause_changed.notify_all (); + } +} + +void +Job::resume () +{ + if (paused_by_user() || paused_by_priority()) { + set_state (RUNNING); + _pause_changed.notify_all (); + } +} + +void +Job::when_finished (boost::signals2::connection& connection, function finished) +{ + boost::mutex::scoped_lock lm (_state_mutex); + if (_state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED) { + finished (); + } else { + connection = Finished.connect (finished); + } +} + +optional +Job::message () const +{ + boost::mutex::scoped_lock lm (_state_mutex); + return _message; +} + +void +Job::set_message (string m) +{ + boost::mutex::scoped_lock lm (_state_mutex); + _message = m; }