src/lib/job_manager.cc

   1 /*
   2     Copyright (C) 2012-2018 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21 /** @file  src/job_manager.cc
  22  *  @brief A simple scheduler for jobs.
  23  */
  24
  25 #include "job_manager.h"
  26 #include "job.h"
  27 #include "cross.h"
  28 #include "analyse_audio_job.h"
  29 #include "film.h"
  30 #include <boost/thread.hpp>
  31 #include <boost/foreach.hpp>
  32 #include <iostream>
  33
  34 using std::string;
  35 using std::list;
  36 using std::cout;
  37 using boost::shared_ptr;
  38 using boost::weak_ptr;
  39 using boost::function;
  40 using boost::dynamic_pointer_cast;
  41 using boost::optional;
  42 using boost::bind;
  43
  44 JobManager* JobManager::_instance = 0;
  45
  46 JobManager::JobManager ()
  47         : _terminate (false)
  48         , _paused (false)
  49         , _scheduler (0)
  50 {
  51
  52 }
  53
  54 void
  55 JobManager::start ()
  56 {
  57         _scheduler = new boost::thread (boost::bind (&JobManager::scheduler, this));
  58 #ifdef DCPOMATIC_LINUX
  59         pthread_setname_np (_scheduler->native_handle(), "job-scheduler");
  60 #endif
  61 }
  62
  63 JobManager::~JobManager ()
  64 {
  65         BOOST_FOREACH (boost::signals2::connection& i, _connections) {
  66                 i.disconnect ();
  67         }
  68
  69         {
  70                 boost::mutex::scoped_lock lm (_mutex);
  71                 _terminate = true;
  72                 _empty_condition.notify_all ();
  73         }
  74
  75         if (_scheduler) {
  76                 /* Ideally this would be a DCPOMATIC_ASSERT(_scheduler->joinable()) but we
  77                    can't throw exceptions from a destructor.
  78                 */
  79                 if (_scheduler->joinable ()) {
  80                         _scheduler->join ();
  81                 }
  82         }
  83
  84         delete _scheduler;
  85 }
  86
  87 shared_ptr<Job>
  88 JobManager::add (shared_ptr<Job> j)
  89 {
  90         {
  91                 boost::mutex::scoped_lock lm (_mutex);
  92                 _jobs.push_back (j);
  93                 _empty_condition.notify_all ();
  94         }
  95
  96         emit (boost::bind (boost::ref (JobAdded), weak_ptr<Job> (j)));
  97
  98         return j;
  99 }
 100
 101 shared_ptr<Job>
 102 JobManager::add_after (shared_ptr<Job> after, shared_ptr<Job> j)
 103 {
 104         {
 105                 boost::mutex::scoped_lock lm (_mutex);
 106                 list<shared_ptr<Job> >::iterator i = find (_jobs.begin(), _jobs.end(), after);
 107                 DCPOMATIC_ASSERT (i != _jobs.end());
 108                 _jobs.insert (i, j);
 109                 _empty_condition.notify_all ();
 110         }
 111
 112         emit (boost::bind (boost::ref (JobAdded), weak_ptr<Job> (j)));
 113
 114         return j;
 115 }
 116
 117 list<shared_ptr<Job> >
 118 JobManager::get () const
 119 {
 120         boost::mutex::scoped_lock lm (_mutex);
 121         return _jobs;
 122 }
 123
 124 bool
 125 JobManager::work_to_do () const
 126 {
 127         boost::mutex::scoped_lock lm (_mutex);
 128         list<shared_ptr<Job> >::const_iterator i = _jobs.begin();
 129         while (i != _jobs.end() && (*i)->finished()) {
 130                 ++i;
 131         }
 132
 133         return i != _jobs.end ();
 134 }
 135
 136 bool
 137 JobManager::errors () const
 138 {
 139         boost::mutex::scoped_lock lm (_mutex);
 140         BOOST_FOREACH (shared_ptr<Job> i, _jobs) {
 141                 if (i->finished_in_error ()) {
 142                         return true;
 143                 }
 144         }
 145
 146         return false;
 147 }
 148
 149 void
 150 JobManager::scheduler ()
 151 {
 152         while (true) {
 153
 154                 boost::mutex::scoped_lock lm (_mutex);
 155
 156                 while (true) {
 157                         bool have_new = false;
 158                         bool have_running = false;
 159                         BOOST_FOREACH (shared_ptr<Job> i, _jobs) {
 160                                 if (i->running()) {
 161                                         have_running = true;
 162                                 }
 163                                 if (i->is_new()) {
 164                                         have_new = true;
 165                                 }
 166                         }
 167
 168                         if ((!have_running && have_new) || _terminate) {
 169                                 break;
 170                         }
 171
 172                         _empty_condition.wait (lm);
 173                 }
 174
 175                 if (_terminate) {
 176                         break;
 177                 }
 178
 179                 BOOST_FOREACH (shared_ptr<Job> i, _jobs) {
 180                         if (i->is_new()) {
 181                                 _connections.push_back (i->FinishedImmediate.connect(bind(&JobManager::job_finished, this)));
 182                                 i->start ();
 183                                 emit (boost::bind (boost::ref (ActiveJobsChanged), _last_active_job, i->json_name()));
 184                                 _last_active_job = i->json_name ();
 185                                 /* Only start one job at once */
 186                                 break;
 187                         }
 188                 }
 189         }
 190 }
 191
 192 void
 193 JobManager::job_finished ()
 194 {
 195         {
 196                 boost::mutex::scoped_lock lm (_mutex);
 197                 emit (boost::bind (boost::ref (ActiveJobsChanged), _last_active_job, optional<string>()));
 198                 _last_active_job = optional<string>();
 199         }
 200
 201         _empty_condition.notify_all ();
 202 }
 203
 204 JobManager *
 205 JobManager::instance ()
 206 {
 207         if (_instance == 0) {
 208                 _instance = new JobManager ();
 209                 _instance->start ();
 210         }
 211
 212         return _instance;
 213 }
 214
 215 void
 216 JobManager::drop ()
 217 {
 218         delete _instance;
 219         _instance = 0;
 220 }
 221
 222 void
 223 JobManager::analyse_audio (
 224         shared_ptr<const Film> film,
 225         shared_ptr<const Playlist> playlist,
 226         bool from_zero,
 227         boost::signals2::connection& connection,
 228         function<void()> ready
 229         )
 230 {
 231         {
 232                 boost::mutex::scoped_lock lm (_mutex);
 233
 234                 BOOST_FOREACH (shared_ptr<Job> i, _jobs) {
 235                         shared_ptr<AnalyseAudioJob> a = dynamic_pointer_cast<AnalyseAudioJob> (i);
 236                         if (a && a->path() == film->audio_analysis_path(playlist)) {
 237                                 i->when_finished (connection, ready);
 238                                 return;
 239                         }
 240                 }
 241         }
 242
 243         shared_ptr<AnalyseAudioJob> job;
 244
 245         {
 246                 boost::mutex::scoped_lock lm (_mutex);
 247
 248                 job.reset (new AnalyseAudioJob (film, playlist, from_zero));
 249                 connection = job->Finished.connect (ready);
 250                 _jobs.push_back (job);
 251                 _empty_condition.notify_all ();
 252         }
 253
 254         emit (boost::bind (boost::ref (JobAdded), weak_ptr<Job> (job)));
 255 }
 256
 257 void
 258 JobManager::increase_priority (shared_ptr<Job> job)
 259 {
 260         bool changed = false;
 261
 262         {
 263                 boost::mutex::scoped_lock lm (_mutex);
 264                 list<shared_ptr<Job> >::iterator last = _jobs.end ();
 265                 for (list<shared_ptr<Job> >::iterator i = _jobs.begin(); i != _jobs.end(); ++i) {
 266                         if (*i == job && last != _jobs.end()) {
 267                                 swap (*i, *last);
 268                                 changed = true;
 269                                 break;
 270                         }
 271                         last = i;
 272                 }
 273         }
 274
 275         if (changed) {
 276                 priority_changed ();
 277         }
 278 }
 279
 280 void
 281 JobManager::priority_changed ()
 282 {
 283         {
 284                 boost::mutex::scoped_lock lm (_mutex);
 285
 286                 bool first = true;
 287                 BOOST_FOREACH (shared_ptr<Job> i, _jobs) {
 288                         if (first) {
 289                                 if (i->is_new ()) {
 290                                         i->start ();
 291                                 } else if (i->paused_by_priority ()) {
 292                                         i->resume ();
 293                                 }
 294                                 first = false;
 295                         } else {
 296                                 if (i->running ()) {
 297                                         i->pause_by_priority ();
 298                                 }
 299                         }
 300                 }
 301         }
 302
 303         emit (boost::bind (boost::ref (JobsReordered)));
 304 }
 305
 306 void
 307 JobManager::decrease_priority (shared_ptr<Job> job)
 308 {
 309         bool changed = false;
 310
 311         {
 312                 boost::mutex::scoped_lock lm (_mutex);
 313                 for (list<shared_ptr<Job> >::iterator i = _jobs.begin(); i != _jobs.end(); ++i) {
 314                         list<shared_ptr<Job> >::iterator next = i;
 315                         ++next;
 316                         if (*i == job && next != _jobs.end()) {
 317                                 swap (*i, *next);
 318                                 changed = true;
 319                                 break;
 320                         }
 321                 }
 322         }
 323
 324         if (changed) {
 325                 priority_changed ();
 326         }
 327 }
 328
 329 void
 330 JobManager::pause ()
 331 {
 332         boost::mutex::scoped_lock lm (_mutex);
 333
 334         if (_paused) {
 335                 return;
 336         }
 337
 338         BOOST_FOREACH (shared_ptr<Job> i, _jobs) {
 339                 if (i->pause_by_user()) {
 340                         _paused_job = i;
 341                 }
 342         }
 343
 344         _paused = true;
 345 }
 346
 347 void
 348 JobManager::resume ()
 349 {
 350         boost::mutex::scoped_lock lm (_mutex);
 351         if (!_paused) {
 352                 return;
 353         }
 354
 355         if (_paused_job) {
 356                 _paused_job->resume ();
 357         }
 358
 359         _paused_job.reset ();
 360         _paused = false;
 361 }