X-Git-Url: https://git.carlh.net/gitweb/?p=dcpomatic.git;a=blobdiff_plain;f=src%2Flib%2Fjob.cc;h=912c6a6ef3c961374a81bd4863509a94d0c524f2;hp=dacc8bf311e4eb1fcbec1f4026d77b0395ecce2e;hb=a6c4b4fa16d9c6597e362044b875f3d6df80753f;hpb=f5bc071ddac2355da1d116404cc37f4485e97699 diff --git a/src/lib/job.cc b/src/lib/job.cc index dacc8bf31..912c6a6ef 100644 --- a/src/lib/job.cc +++ b/src/lib/job.cc @@ -1,5 +1,5 @@ /* - Copyright (C) 2012-2016 Carl Hetherington + Copyright (C) 2012-2021 Carl Hetherington This file is part of DCP-o-matic. @@ -18,41 +18,43 @@ */ + /** @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 "compose.hpp" +#include "util.h" #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; -#define LOG_ERROR_NC(...) if (_film) { _film->log()->log (__VA_ARGS__, LogEntry::TYPE_ERROR); } -#define LOG_GENERAL(...) if (_film) { _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL); } /** @param film Associated film, or 0 */ Job::Job (shared_ptr film) : _film (film) - , _thread (0) , _state (NEW) , _start_time (0) , _sub_start_time (0) @@ -62,23 +64,28 @@ Job::Job (shared_ptr film) } + Job::~Job () { - 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 */ - } - } - } +#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; - delete _thread; + _thread.interrupt (); + try { + _thread.join (); + } catch (...) {} } + /** Start the job in a separate thread, returning immediately */ void Job::start () @@ -86,13 +93,19 @@ 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"); +#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 (); @@ -102,7 +115,7 @@ Job::run_wrapper () string m = String::compose (_("An error occurred whilst handling the file %1."), boost::filesystem::path (e.filename()).leaf()); try { - boost::filesystem::space_info const s = boost::filesystem::space (e.filename()); + 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."); @@ -115,13 +128,50 @@ 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. Perhaps it does not exist or is in an unexpected format."), - boost::filesystem::absolute (e.file()).string() + _("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() ) ); @@ -134,8 +184,9 @@ Job::run_wrapper () set_error ( String::compose (_("Could not open %1"), e.path1().string ()), String::compose ( - _("DCP-o-matic could not open the file %1. Perhaps it does not exist or is in an unexpected format."), - boost::filesystem::absolute (e.path1()).string() + _("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 { @@ -149,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"; } @@ -169,6 +218,30 @@ Job::run_wrapper () 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); + + } catch (FileError& e) { + + set_error (e.what(), e.what()); + set_progress (1); + set_state (FINISHED_ERROR); + + } catch (CPLNotFoundError& e) { + + set_error(e.what()); + set_progress(1); + set_state(FINISHED_ERROR); + } catch (std::exception& e) { set_error ( @@ -191,6 +264,7 @@ Job::run_wrapper () } } + /** @return true if this job is new (ie has not started running) */ bool Job::is_new () const @@ -199,6 +273,7 @@ Job::is_new () const return _state == NEW; } + /** @return true if the job is running */ bool Job::running () const @@ -207,6 +282,7 @@ Job::running () const return _state == RUNNING; } + /** @return true if the job has finished (either successfully or unsuccessfully) */ bool Job::finished () const @@ -215,6 +291,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 @@ -223,6 +300,7 @@ Job::finished_ok () const return _state == FINISHED_OK; } + /** @return true if the job has finished unsuccessfully */ bool Job::finished_in_error () const @@ -231,6 +309,7 @@ Job::finished_in_error () const return _state == FINISHED_ERROR; } + bool Job::finished_cancelled () const { @@ -238,6 +317,7 @@ Job::finished_cancelled () const return _state == FINISHED_CANCELLED; } + bool Job::paused_by_user () const { @@ -245,6 +325,7 @@ Job::paused_by_user () const return _state == PAUSED_BY_USER; } + bool Job::paused_by_priority () const { @@ -252,6 +333,7 @@ Job::paused_by_priority () const return _state == PAUSED_BY_PRIORITY; } + /** Set the state of this job. * @param s New state. */ @@ -262,6 +344,10 @@ 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) { @@ -272,10 +358,31 @@ Job::set_state (State s) } if (finished) { - emit (boost::bind (boost::ref (Finished))); + 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 @@ -287,6 +394,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 () @@ -300,8 +408,25 @@ 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. */ void Job::set_progress (float p, bool force) @@ -314,8 +439,7 @@ Job::set_progress (float p, bool force) 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; } @@ -326,6 +450,7 @@ Job::set_progress (float p, bool force) set_progress_common (p); } + void Job::set_progress_common (optional p) { @@ -337,6 +462,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 @@ -345,6 +471,7 @@ Job::progress () const return _progress; } + void Job::sub (string n) { @@ -358,6 +485,7 @@ Job::sub (string n) _sub_start_time = time (0); } + string Job::error_details () const { @@ -365,6 +493,7 @@ Job::error_details () const return _error_details; } + /** @return A summary of any error that the job has generated */ string Job::error_summary () const @@ -373,15 +502,15 @@ Job::error_summary () const 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 s, string d) { if (_film) { - LOG_ERROR_NC (s); - LOG_ERROR_NC (d); _film->log()->log (String::compose ("Error in job: %1 (%2)", s, d), LogEntry::TYPE_ERROR); } @@ -390,6 +519,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 () @@ -398,6 +528,7 @@ Job::set_progress_unknown () set_progress_common (optional ()); } + /** @return Human-readable status of this job */ string Job::status () const @@ -406,6 +537,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); @@ -419,15 +571,15 @@ 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); - char finish_string[6]; - snprintf (finish_string, sizeof(finish_string), "%02d:%02d", finish.time_of_day().hours(), finish.time_of_day().minutes()); + 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"), finish.date().day_of_week().as_long_string()); + 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. @@ -447,6 +599,7 @@ Job::status () const return s; } + string Job::json_status () const { @@ -471,6 +624,7 @@ Job::json_status () const return ""; } + /** @return An estimate of the remaining time for this sub-job, in seconds */ int Job::remaining_time () const @@ -482,33 +636,45 @@ Job::remaining_time () const return elapsed_sub_time() / progress().get() - elapsed_sub_time(); } + void Job::cancel () { - if (!_thread) { - return; - } + if (_thread.joinable()) { + 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); } -void + +/** @return true if the job was paused, false if it was not running */ +bool Job::pause_by_user () { - if (running ()) { - set_state (PAUSED_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 () { @@ -518,6 +684,7 @@ Job::pause_by_priority () } } + void Job::resume () { @@ -527,13 +694,30 @@ 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 +{ + boost::mutex::scoped_lock lm (_state_mutex); + return _message; +} + + +void +Job::set_message (string m) +{ + boost::mutex::scoped_lock lm (_state_mutex); + _message = m; +}