X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;ds=sidebyside;f=src%2Flib%2Fjob.cc;h=9e685ec114cee9d01fe95e998e009b8f59d64390;hb=2310a084216fc737fad879b79ae9f845ac461c1b;hp=8966a65e700eb84b8f3945eb7d81987d8c88f7b5;hpb=fea83d9ef5d02149f857a11de79ed266773fd5a1;p=dcpomatic.git diff --git a/src/lib/job.cc b/src/lib/job.cc index 8966a65e7..9e685ec11 100644 --- a/src/lib/job.cc +++ b/src/lib/job.cc @@ -1,5 +1,5 @@ /* - Copyright (C) 2012-2019 Carl Hetherington + Copyright (C) 2012-2021 Carl Hetherington This file is part of DCP-o-matic. @@ -18,73 +18,74 @@ */ + /** @file src/job.cc * @brief A parent class to represent long-running tasks which are run in their own thread. */ -#include "job.h" -#include "util.h" + +#include "compose.hpp" +#include "constants.h" #include "cross.h" +#include "dcpomatic_log.h" #include "exceptions.h" #include "film.h" +#include "job.h" #include "log.h" -#include "dcpomatic_log.h" -#include "compose.hpp" +#include "util.h" #include #include -#include -#include -#include #include +#include +#include +#include #include #include "i18n.h" -using std::string; -using std::list; + using std::cout; -using boost::shared_ptr; +using std::function; +using std::list; +using std::shared_ptr; +using std::string; using boost::optional; -using boost::function; using namespace dcpomatic; + /** @param film Associated film, or 0 */ Job::Job (shared_ptr film) : _film (film) - , _thread (0) , _state (NEW) - , _start_time (0) , _sub_start_time (0) , _progress (0) - , _ran_for (0) + , _rate_limit_progress(true) { } + Job::~Job () { - stop_thread (); +#ifdef DCPOMATIC_DEBUG + /* Any subclass should have called stop_thread in its destructor */ + assert (!_thread.joinable()); +#endif } + void Job::stop_thread () { - if (_thread) { - _thread->interrupt (); - /* We can't use DCPOMATIC_ASSERT here as it may throw an exception */ - if (_thread->joinable ()) { - try { - _thread->join (); - } catch (...) { - /* Too late to do anything about this */ - } - } - } + boost::this_thread::disable_interruption dis; - delete _thread; - _thread = 0; + _thread.interrupt (); + try { + _thread.join (); + } catch (...) {} } + /** Start the job in a separate thread, returning immediately */ void Job::start () @@ -92,26 +93,29 @@ Job::start () set_state (RUNNING); _start_time = time (0); _sub_start_time = time (0); - _thread = new boost::thread (boost::bind (&Job::run_wrapper, this)); + _thread = boost::thread (boost::bind(&Job::run_wrapper, this)); #ifdef DCPOMATIC_LINUX - pthread_setname_np (_thread->native_handle(), "job-wrapper"); + 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 (dcp::FileError& e) { - string m = String::compose (_("An error occurred whilst handling the file %1."), boost::filesystem::path (e.filename()).leaf()); + string m = String::compose(_("An error occurred whilst handling the file %1."), e.filename().filename()); try { - boost::filesystem::space_info const s = boost::filesystem::space (e.filename()); + auto const s = dcp::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."); @@ -124,13 +128,49 @@ Job::run_wrapper () 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(), + dcp::filesystem::absolute(e.file()).string(), e.what() ) ); @@ -145,7 +185,7 @@ Job::run_wrapper () 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(), + dcp::filesystem::absolute(e.path1()).string(), e.what() ) ); @@ -160,13 +200,11 @@ Job::run_wrapper () set_state (FINISHED_ERROR); } catch (boost::thread_interrupted &) { - - set_state (FINISHED_CANCELLED); - + /* The job was cancelled; there's nothing else we need to do here */ } catch (sub::SubripError& e) { string extra = "Error is near:\n"; - BOOST_FOREACH (string i, e.context()) { + for (auto i: e.context()) { extra += i + "\n"; } @@ -180,7 +218,7 @@ Job::run_wrapper () set_progress (1); set_state (FINISHED_ERROR); - } catch (dcp::DCPReadError& e) { + } catch (dcp::ReadError& e) { set_error (e.message(), e.detail().get_value_or("")); set_progress (1); @@ -198,6 +236,18 @@ Job::run_wrapper () set_progress (1); set_state (FINISHED_ERROR); + } catch (CPLNotFoundError& e) { + + set_error(e.what()); + set_progress(1); + set_state(FINISHED_ERROR); + + } catch (MissingConfigurationError& e) { + + set_error(e.what()); + set_progress(1); + set_state(FINISHED_ERROR); + } catch (std::exception& e) { set_error ( @@ -220,6 +270,7 @@ Job::run_wrapper () } } + /** @return true if this job is new (ie has not started running) */ bool Job::is_new () const @@ -228,6 +279,7 @@ Job::is_new () const return _state == NEW; } + /** @return true if the job is running */ bool Job::running () const @@ -236,6 +288,7 @@ Job::running () const return _state == RUNNING; } + /** @return true if the job has finished (either successfully or unsuccessfully) */ bool Job::finished () const @@ -244,6 +297,7 @@ Job::finished () const return _state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED; } + /** @return true if the job has finished successfully */ bool Job::finished_ok () const @@ -252,6 +306,7 @@ Job::finished_ok () const return _state == FINISHED_OK; } + /** @return true if the job has finished unsuccessfully */ bool Job::finished_in_error () const @@ -260,6 +315,7 @@ Job::finished_in_error () const return _state == FINISHED_ERROR; } + bool Job::finished_cancelled () const { @@ -267,6 +323,7 @@ Job::finished_cancelled () const return _state == FINISHED_CANCELLED; } + bool Job::paused_by_user () const { @@ -274,6 +331,7 @@ Job::paused_by_user () const return _state == PAUSED_BY_USER; } + bool Job::paused_by_priority () const { @@ -281,6 +339,7 @@ Job::paused_by_priority () const return _state == PAUSED_BY_PRIORITY; } + /** Set the state of this job. * @param s New state. */ @@ -291,21 +350,45 @@ Job::set_state (State s) { boost::mutex::scoped_lock lm (_state_mutex); + if (_state == s) { + return; + } + _state = s; if (_state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED) { - _ran_for = time(0) - _start_time; + _finish_time = time(nullptr); finished = true; _sub_name.clear (); } } if (finished) { - emit (boost::bind (boost::ref (Finished))); - FinishedImmediate (); + auto const result = state_to_result(s); + emit(boost::bind(boost::ref(Finished), result)); + FinishedImmediate(result); } } + +Job::Result +Job::state_to_result(State state) const +{ + switch (state) { + case FINISHED_OK: + return Result::RESULT_OK; + case FINISHED_ERROR: + return Result::RESULT_ERROR; + case FINISHED_CANCELLED: + return Result::RESULT_CANCELLED; + default: + DCPOMATIC_ASSERT(false); + }; + + DCPOMATIC_ASSERT(false); +} + + /** @return DCPTime (in seconds) that this sub-job has been running */ int Job::elapsed_sub_time () const @@ -317,6 +400,7 @@ Job::elapsed_sub_time () const return time (0) - _sub_start_time; } + /** Check to see if this job has been interrupted or paused */ void Job::check_for_interruption_or_pause () @@ -330,6 +414,22 @@ Job::check_for_interruption_or_pause () } } + +optional +Job::seconds_since_last_progress_update () const +{ + boost::mutex::scoped_lock lm (_progress_mutex); + if (!_last_progress_update) { + return {}; + } + + struct timeval now; + gettimeofday (&now, 0); + + return seconds(now) - seconds(*_last_progress_update); +} + + /** 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. @@ -339,14 +439,13 @@ Job::set_progress (float p, bool force) { check_for_interruption_or_pause (); - if (!force) { + if (!force && _rate_limit_progress) { /* 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); + double const elapsed = seconds(now) - seconds(*_last_progress_update); if (elapsed < 0.5) { return; } @@ -357,6 +456,7 @@ Job::set_progress (float p, bool force) set_progress_common (p); } + void Job::set_progress_common (optional p) { @@ -368,6 +468,7 @@ Job::set_progress_common (optional p) emit (boost::bind (boost::ref (Progress))); } + /** @return fractional progress of the current sub-job, if known */ optional Job::progress () const @@ -376,6 +477,7 @@ Job::progress () const return _progress; } + void Job::sub (string n) { @@ -389,6 +491,7 @@ Job::sub (string n) _sub_start_time = time (0); } + string Job::error_details () const { @@ -396,6 +499,7 @@ Job::error_details () const return _error_details; } + /** @return A summary of any error that the job has generated */ string Job::error_summary () const @@ -404,6 +508,7 @@ Job::error_summary () const return _error_summary; } + /** Set the current error string. * @param s New error string. * @param d New error detail string. @@ -420,6 +525,7 @@ Job::set_error (string s, string d) _error_details = d; } + /** Say that this job's progress will be unknown until further notice */ void Job::set_progress_unknown () @@ -428,6 +534,7 @@ Job::set_progress_unknown () set_progress_common (optional ()); } + /** @return Human-readable status of this job */ string Job::status () const @@ -436,6 +543,27 @@ Job::status () const int const t = elapsed_sub_time (); int const r = remaining_time (); + auto day_of_week_to_string = [](boost::gregorian::greg_weekday d) -> std::string { + switch (d.as_enum()) { + case boost::date_time::Sunday: + return _("Sunday"); + case boost::date_time::Monday: + return _("Monday"); + case boost::date_time::Tuesday: + return _("Tuesday"); + case boost::date_time::Wednesday: + return _("Wednesday"); + case boost::date_time::Thursday: + return _("Thursday"); + case boost::date_time::Friday: + return _("Friday"); + case boost::date_time::Saturday: + return _("Saturday"); + } + + return d.as_long_string(); + }; + string s; if (!finished () && p) { int pc = lrintf (p.get() * 100); @@ -449,8 +577,8 @@ Job::status () const s += buffer; if (t > 10 && r > 0) { - boost::posix_time::ptime now = boost::posix_time::second_clock::local_time(); - boost::posix_time::ptime finish = now + boost::posix_time::seconds(r); + 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; @@ -467,7 +595,22 @@ Job::status () const ); } } else if (finished_ok ()) { - s = String::compose (_("OK (ran for %1)"), seconds_to_hms (_ran_for)); + auto time_string = [](time_t time) { + auto tm = localtime(&time); + char buffer[8]; + snprintf(buffer, sizeof(buffer), "%02d:%02d", tm->tm_hour, tm->tm_min); + return string(buffer); + }; + auto const duration = _finish_time - _start_time; + if (duration < 10) { + /* It took less than 10 seconds; it doesn't seem worth saying how long it took */ + s = _("OK"); + } else if (duration < 600) { + /* It took less than 10 minutes; it doesn't seem worth saying when it started and finished */ + s = String::compose(_("OK (ran for %1)"), seconds_to_hms(duration)); + } else { + s = String::compose(_("OK (ran for %1 from %2 to %3)"), seconds_to_hms(duration), time_string(_start_time), time_string(_finish_time)); + } } else if (finished_in_error ()) { s = String::compose (_("Error: %1"), error_summary ()); } else if (finished_cancelled ()) { @@ -477,6 +620,7 @@ Job::status () const return s; } + string Job::json_status () const { @@ -501,6 +645,7 @@ Job::json_status () const return ""; } + /** @return An estimate of the remaining time for this sub-job, in seconds */ int Job::remaining_time () const @@ -512,24 +657,21 @@ Job::remaining_time () const return elapsed_sub_time() / progress().get() - elapsed_sub_time(); } + void Job::cancel () { - if (!_thread) { - return; - } + if (_thread.joinable()) { + Job::resume(); - if (paused_by_user() || paused_by_priority()) { - resume (); + _thread.interrupt (); + _thread.join (); } - _thread->interrupt (); - DCPOMATIC_ASSERT (_thread->joinable ()); - _thread->join (); - delete _thread; - _thread = 0; + set_state (FINISHED_CANCELLED); } + /** @return true if the job was paused, false if it was not running */ bool Job::pause_by_user () @@ -547,21 +689,25 @@ Job::pause_by_user () } if (paused) { + pause(); _pause_changed.notify_all (); } return paused; } + void Job::pause_by_priority () { if (running ()) { set_state (PAUSED_BY_PRIORITY); + pause(); _pause_changed.notify_all (); } } + void Job::resume () { @@ -571,17 +717,19 @@ Job::resume () } } + void -Job::when_finished (boost::signals2::connection& connection, function finished) +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 (); + finished(state_to_result(_state)); } else { connection = Finished.connect (finished); } } + optional Job::message () const { @@ -589,9 +737,18 @@ Job::message () const return _message; } + void Job::set_message (string m) { boost::mutex::scoped_lock lm (_state_mutex); _message = m; } + + +void +Job::set_rate_limit_progress(bool rate_limit) +{ + _rate_limit_progress = rate_limit; +} +