src/lib/job.cc

   1 /*
   2     Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 /** @file src/job.cc
  21  *  @brief A parent class to represent long-running tasks which are run in their own thread.
  22  */
  23
  24 #include <boost/thread.hpp>
  25 #include <boost/filesystem.hpp>
  26 #include <libdcp/exceptions.h>
  27 #include "job.h"
  28 #include "util.h"
  29
  30 using namespace std;
  31 using namespace boost;
  32
  33 /** @param s FilmState for the film that we are operating on.
  34  *  @param o Options.
  35  *  @param l A log that we can write to.
  36  */
  37 Job::Job (shared_ptr<const FilmState> s, shared_ptr<const Options> o, Log* l)
  38         : _fs (s)
  39         , _opt (o)
  40         , _log (l)
  41         , _state (NEW)
  42         , _start_time (0)
  43         , _progress_unknown (false)
  44         , _ran_for (0)
  45 {
  46         assert (_log);
  47
  48         descend (1);
  49 }
  50
  51 /** Start the job in a separate thread, returning immediately */
  52 void
  53 Job::start ()
  54 {
  55         set_state (RUNNING);
  56         _start_time = time (0);
  57         boost::thread (boost::bind (&Job::run_wrapper, this));
  58 }
  59
  60 /** A wrapper for the ::run() method to catch exceptions */
  61 void
  62 Job::run_wrapper ()
  63 {
  64         try {
  65
  66                 run ();
  67
  68         } catch (libdcp::FileError& e) {
  69
  70                 set_progress (1);
  71                 set_state (FINISHED_ERROR);
  72                 set_error (String::compose ("%1 (%2)", e.what(), filesystem::path (e.filename()).leaf()));
  73
  74         } catch (std::exception& e) {
  75
  76                 set_progress (1);
  77                 set_state (FINISHED_ERROR);
  78                 set_error (e.what ());
  79
  80         }
  81 }
  82
  83 /** @return true if the job is running */
  84 bool
  85 Job::running () const
  86 {
  87         boost::mutex::scoped_lock lm (_state_mutex);
  88         return _state == RUNNING;
  89 }
  90
  91 /** @return true if the job has finished (either successfully or unsuccessfully) */
  92 bool
  93 Job::finished () const
  94 {
  95         boost::mutex::scoped_lock lm (_state_mutex);
  96         return _state == FINISHED_OK || _state == FINISHED_ERROR;
  97 }
  98
  99 /** @return true if the job has finished successfully */
 100 bool
 101 Job::finished_ok () const
 102 {
 103         boost::mutex::scoped_lock lm (_state_mutex);
 104         return _state == FINISHED_OK;
 105 }
 106
 107 /** @return true if the job has finished unsuccessfully */
 108 bool
 109 Job::finished_in_error () const
 110 {
 111         boost::mutex::scoped_lock lm (_state_mutex);
 112         return _state == FINISHED_ERROR;
 113 }
 114
 115 /** Set the state of this job.
 116  *  @param s New state.
 117  */
 118 void
 119 Job::set_state (State s)
 120 {
 121         boost::mutex::scoped_lock lm (_state_mutex);
 122         _state = s;
 123
 124         if (_state == FINISHED_OK || _state == FINISHED_ERROR) {
 125                 _ran_for = elapsed_time ();
 126         }
 127 }
 128
 129 /** A hack to work around our lack of cross-thread
 130  *  signalling; this emits Finished, and listeners
 131  *  assume that it will be emitted in the GUI thread,
 132  *  so this method must be called from the GUI thread.
 133  */
 134 void
 135 Job::emit_finished ()
 136 {
 137         Finished ();
 138 }
 139
 140 /** @return Time (in seconds) that this job has been running */
 141 int
 142 Job::elapsed_time () const
 143 {
 144         if (_start_time == 0) {
 145                 return 0;
 146         }
 147
 148         return time (0) - _start_time;
 149 }
 150
 151 /** Set the progress of the current part of the job.
 152  *  @param p Progress (from 0 to 1)
 153  */
 154 void
 155 Job::set_progress (float p)
 156 {
 157         boost::mutex::scoped_lock lm (_progress_mutex);
 158         _stack.back().normalised = p;
 159 }
 160
 161 /** @return fractional overall progress, or -1 if not known */
 162 float
 163 Job::overall_progress () const
 164 {
 165         boost::mutex::scoped_lock lm (_progress_mutex);
 166         if (_progress_unknown) {
 167                 return -1;
 168         }
 169
 170         float overall = 0;
 171         float factor = 1;
 172         for (list<Level>::const_iterator i = _stack.begin(); i != _stack.end(); ++i) {
 173                 factor *= i->allocation;
 174                 overall += i->normalised * factor;
 175         }
 176
 177         if (overall > 1) {
 178                 overall = 1;
 179         }
 180
 181         return overall;
 182 }
 183
 184 /** Ascend up one level in terms of progress reporting; see descend() */
 185 void
 186 Job::ascend ()
 187 {
 188         boost::mutex::scoped_lock lm (_progress_mutex);
 189
 190         assert (!_stack.empty ());
 191         float const a = _stack.back().allocation;
 192         _stack.pop_back ();
 193         _stack.back().normalised += a;
 194 }
 195
 196 /** Descend down one level in terms of progress reporting; e.g. if
 197  *  there is a task which is split up into N subtasks, each of which
 198  *  report their progress from 0 to 100%, call descend() before executing
 199  *  each subtask, and ascend() afterwards to ensure that overall progress
 200  *  is reported correctly.
 201  *
 202  *  @param a Fraction (from 0 to 1) of the current task to allocate to the subtask.
 203  */
 204 void
 205 Job::descend (float a)
 206 {
 207         boost::mutex::scoped_lock lm (_progress_mutex);
 208         _stack.push_back (Level (a));
 209 }
 210
 211 /** @return Any error string that the job has generated */
 212 string
 213 Job::error () const
 214 {
 215         boost::mutex::scoped_lock lm (_state_mutex);
 216         return _error;
 217 }
 218
 219 /** Set the current error string.
 220  *  @param e New error string.
 221  */
 222 void
 223 Job::set_error (string e)
 224 {
 225         boost::mutex::scoped_lock lm (_state_mutex);
 226         _error = e;
 227 }
 228
 229 /** Say that this job's progress will always be unknown */
 230 void
 231 Job::set_progress_unknown ()
 232 {
 233         boost::mutex::scoped_lock lm (_progress_mutex);
 234         _progress_unknown = true;
 235 }
 236
 237 /** @return Human-readable status of this job */
 238 string
 239 Job::status () const
 240 {
 241         float const p = overall_progress ();
 242         int const t = elapsed_time ();
 243         int const r = remaining_time ();
 244
 245         stringstream s;
 246         if (!finished () && p >= 0 && t > 10 && r > 0) {
 247                 s << rint (p * 100) << "%; " << seconds_to_approximate_hms (r) << " remaining";
 248         } else if (!finished () && (t <= 10 || r == 0)) {
 249                 s << rint (p * 100) << "%";
 250         } else if (finished_ok ()) {
 251                 s << "OK (ran for " << seconds_to_hms (_ran_for) << ")";
 252         } else if (finished_in_error ()) {
 253                 s << "Error (" << error() << ")";
 254         }
 255
 256         return s.str ();
 257 }
 258
 259 /** @return An estimate of the remaining time for this job, in seconds */
 260 int
 261 Job::remaining_time () const
 262 {
 263         return elapsed_time() / overall_progress() - elapsed_time();
 264 }