Queen.pm 34.1 KB
Newer Older
Jessica Severin's avatar
Jessica Severin committed
1 2 3 4 5 6
#
# You may distribute this module under the same terms as perl itself

=pod 

=head1 NAME
7

8
  Bio::EnsEMBL::Hive::Queen
Jessica Severin's avatar
Jessica Severin committed
9 10

=head1 SYNOPSIS
11

12
  The Queen of the Hive based job control system
Jessica Severin's avatar
Jessica Severin committed
13 14

=head1 DESCRIPTION
15

16 17 18 19 20 21 22 23 24 25 26 27
  The Queen of the Hive based job control system is responsible to 'birthing' the
  correct number of workers of the right type so that they can find jobs to do.
  It will also free up jobs of Workers that died unexpectantly so that other workers
  can claim them to do.

  Hive based processing is a concept based on a more controlled version
  of an autonomous agent type system.  Each worker is not told what to do
  (like a centralized control system - like the current pipeline system)
  but rather queries a central database for jobs (give me jobs).

  Each worker is linked to an analysis_id, registers its self on creation
  into the Hive, creates a RunnableDB instance of the Analysis->module,
28 29
  gets $worker->batch_size() jobs from the job table, does its
  work, creates the next layer of job entries by interfacing to
30 31 32
  the DataflowRuleAdaptor to determine the analyses it needs to pass its
  output data to and creates jobs on the next analysis database.
  It repeats this cycle until it has lived its lifetime or until there are no
33 34 35 36 37 38 39 40 41 42
  more jobs left.
  The lifetime limit is just a safety limit to prevent these from 'infecting'
  a system.

  The Queens job is to simply birth Workers of the correct analysis_id to get the
  work down.  The only other thing the Queen does is free up jobs that were
  claimed by Workers that died unexpectantly so that other workers can take
  over the work.

  The Beekeeper is in charge of interfacing between the Queen and a compute resource
43
  or 'compute farm'.  Its job is to query Queens if they need any workers and to
44 45 46
  send the requested number of workers to open machines via the runWorker.pl script.
  It is also responsible for interfacing with the Queen to identify worker which died
  unexpectantly.
Jessica Severin's avatar
Jessica Severin committed
47 48

=head1 CONTACT
49

50
  Please contact ehive-users@ebi.ac.uk mailing list with questions/suggestions.
Jessica Severin's avatar
Jessica Severin committed
51 52

=head1 APPENDIX
53

54 55
  The rest of the documentation details each of the object methods. 
  Internal methods are usually preceded with a _
Jessica Severin's avatar
Jessica Severin committed
56 57 58

=cut

59

Jessica Severin's avatar
Jessica Severin committed
60 61 62
package Bio::EnsEMBL::Hive::Queen;

use strict;
63
use POSIX;
64 65 66
use Bio::EnsEMBL::Utils::Argument;
use Bio::EnsEMBL::Utils::Exception;

67
use Bio::EnsEMBL::Hive::Utils 'destringify';  # import 'destringify()'
68
use Bio::EnsEMBL::Hive::AnalysisJob;
Jessica Severin's avatar
Jessica Severin committed
69
use Bio::EnsEMBL::Hive::Worker;
70
use Bio::EnsEMBL::Hive::DBSQL::AnalysisCtrlRuleAdaptor;
Jessica Severin's avatar
Jessica Severin committed
71

Leo Gordon's avatar
Leo Gordon committed
72
use base ('Bio::EnsEMBL::DBSQL::BaseAdaptor');
73

Jessica Severin's avatar
Jessica Severin committed
74

75
############################
Jessica Severin's avatar
Jessica Severin committed
76
#
77
# PUBLIC API for Workers
Jessica Severin's avatar
Jessica Severin committed
78
#
79
############################
Jessica Severin's avatar
Jessica Severin committed
80 81 82

=head2 create_new_worker

83
  Arg [1]    : $analysis_id (optional)
Jessica Severin's avatar
Jessica Severin committed
84
  Example    :
85 86 87
  Description: If analysis_id is specified it will try to create a worker based
               on that analysis.  If not specified the queen will analyze the hive
               and pick the analysis that has the most amount of work to be done.
88
               It creates an entry in the worker table, and returns a Worker object 
89 90
               based on that insert.  This guarantees that each worker registered
               in this queens hive is properly registered.
Jessica Severin's avatar
Jessica Severin committed
91 92 93 94 95 96 97
  Returntype : Bio::EnsEMBL::Hive::Worker
  Exceptions :
  Caller     :

=cut

sub create_new_worker {
98 99
  my ($self, @args) = @_;

100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117
  my (  $meadow_type, $process_id, $exec_host,
        $rc_id, $logic_name, $analysis_id, $input_id, $job_id,
        $no_write, $debug, $worker_output_dir, $hive_output_dir, $batch_size, $job_limit, $life_span, $no_cleanup, $retry_throwing_jobs) =

 rearrange([qw(meadow_type process_id exec_host
        rc_id logic_name analysis_id input_id job_id
        no_write debug worker_output_dir hive_output_dir batch_size job_limit life_span no_cleanup retry_throwing_jobs) ], @args);

    if($logic_name) {
        if($analysis_id) {
            die "You should either define -analysis_id or -logic_name, but not both\n";
        }
        if(my $analysis = $self->db->get_AnalysisAdaptor->fetch_by_logic_name($logic_name)) {
            $analysis_id = $analysis->dbID;
        } else {
            die "logic_name '$logic_name' could not be fetched from the database\n";
        }
    }
Jessica Severin's avatar
Jessica Severin committed
118

119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
    my $job;

    if($input_id) {
        if($job_id) {
            die "You should either define -input_id or -job_id, but not both\n";

        } elsif($analysis_id) {
            $job = Bio::EnsEMBL::Hive::AnalysisJob->new(
                -INPUT_ID       => $input_id,
                -ANALYSIS_ID    => $analysis_id,
                -DBID           => -1,
            );
            print "creating a job outside the database\n";
            $job->print_job;
            $debug=1 unless(defined($debug));
            $hive_output_dir='' unless(defined($hive_output_dir)); # make it defined but empty/false
        } else {
            die "For creating a job outside the database either -analysis_id or -logic_name must also be defined\n";
        }
    }

    if($job_id) {
        if($analysis_id) {
            die "When you specify -job_id, please omit both -logic_name and -analysis_id to avoid confusion\n";
        } else {
            print "fetching job for job_id '$job_id'\n";
            if($job = $self->reset_and_fetch_job_by_dbID($job_id)) {
                $analysis_id = $job->analysis_id;
            } else {
                die "job_id '$job_id' could not be fetched from the database\n";
            }
        }
    }
152

153
  
154
  my $analysis_stats_adaptor = $self->db->get_AnalysisStatsAdaptor or return undef;
155 156
  my $analysisStats;
  if($analysis_id) {
157
    $analysisStats = $analysis_stats_adaptor->fetch_by_analysis_id($analysis_id);
158
    $self->safe_synchronize_AnalysisStats($analysisStats);
159
    #return undef unless(($analysisStats->status ne 'BLOCKED') and ($analysisStats->num_required_workers > 0));
160
  } else {
Leo Gordon's avatar
Leo Gordon committed
161
    $analysisStats = $self->_pick_best_analysis_for_new_worker($rc_id);
162
  }
163
  return undef unless($analysisStats);
164

165 166
  unless($job) {
    #go into autonomous mode
167 168 169 170 171

    if($self->get_hive_current_load() >= 1.1) {
        print "Hive is overloaded, can't create a worker\n";
        return;
    }
172
    if($analysisStats->status eq 'BLOCKED') {
173 174
      print "Analysis is BLOCKED, can't create workers\n";
      return;
175 176
    }
    if($analysisStats->status eq 'DONE') {
177 178
      print "Analysis is DONE, don't need to create workers\n";
      return;
179
    }
180

181 182
    $analysis_stats_adaptor->decrease_required_workers($analysisStats->analysis_id);

183
    $analysisStats->print_stats;
184
  }
185
  
186 187 188 189 190 191 192 193 194 195
    # The following increment used to be done only when no specific task was given to the worker,
    # thereby excluding such "special task" workers from being counted in num_running_workers.
    #
    # However this may be tricky to emulate by triggers that know nothing about "special tasks",
    # so I am (temporarily?) simplifying the accounting algorithm.
    #
  unless( $self->db->hive_use_triggers() ) {
        $analysis_stats_adaptor->increase_running_workers($analysisStats->analysis_id);
  }

196 197
  my $sql = q{INSERT INTO worker 
              (born, last_check_in, meadow_type, process_id, host, analysis_id)
198
              VALUES (CURRENT_TIMESTAMP, CURRENT_TIMESTAMP, ?,?,?,?)};
Jessica Severin's avatar
Jessica Severin committed
199 200

  my $sth = $self->prepare($sql);
201
  $sth->execute($meadow_type, $process_id, $exec_host, $analysisStats->analysis_id);
Leo Gordon's avatar
Leo Gordon committed
202
  my $worker_id = $self->dbc->db_handle->last_insert_id(undef, undef, 'worker', 'worker_id');
Jessica Severin's avatar
Jessica Severin committed
203 204
  $sth->finish;

205
  my $worker = $self->fetch_by_dbID($worker_id);
Jessica Severin's avatar
Jessica Severin committed
206 207
  $worker=undef unless($worker and $worker->analysis);

208
  if($worker and $analysisStats) {
209
    $analysisStats->update_status('WORKING');
Jessica Severin's avatar
Jessica Severin committed
210
  }
211
  
212
  $worker->_specific_job($job) if($job);
213
  $worker->execute_writes(0) if($no_write);
214 215 216 217 218 219 220 221 222 223 224 225 226

    $worker->debug($debug) if($debug);
    $worker->worker_output_dir($worker_output_dir) if(defined($worker_output_dir));

    unless(defined($hive_output_dir)) {
        my $arrRef = $self->db->get_MetaContainer->list_value_by_key( 'hive_output_dir' );
        if( @$arrRef ) {
            $hive_output_dir = destringify($arrRef->[0]);
        } 
    }
    $worker->hive_output_dir($hive_output_dir);

    if($batch_size) {
227
        $worker->batch_size($batch_size);
228 229 230 231
    }
    if($job_limit) {
      $worker->job_limit($job_limit);
      $worker->life_span(0);
232 233 234
      if($job_limit < $worker->batch_size()) {
        $worker->batch_size( $job_limit );
      }
235 236 237 238 239 240 241 242 243 244 245
    }
    if($life_span) {
      $worker->life_span($life_span * 60);
    }
    if($no_cleanup) { 
      $worker->perform_cleanup(0); 
    }
    if(defined $retry_throwing_jobs) {
        $worker->retry_throwing_jobs($retry_throwing_jobs);
    }

Jessica Severin's avatar
Jessica Severin committed
246 247 248 249 250 251 252
  return $worker;
}

sub register_worker_death {
  my ($self, $worker) = @_;

  return unless($worker);
Leo Gordon's avatar
Leo Gordon committed
253

Leo Gordon's avatar
bugfix  
Leo Gordon committed
254 255
  my $cod = $worker->cause_of_death();

256
  my $sql = "UPDATE worker SET died=CURRENT_TIMESTAMP, last_check_in=CURRENT_TIMESTAMP";
257
  $sql .= " ,status='DEAD'";
Jessica Severin's avatar
Jessica Severin committed
258
  $sql .= " ,work_done='" . $worker->work_done . "'";
Leo Gordon's avatar
bugfix  
Leo Gordon committed
259
  $sql .= " ,cause_of_death='$cod'";
260
  $sql .= " WHERE worker_id='" . $worker->dbID ."'";
Jessica Severin's avatar
Jessica Severin committed
261

Leo Gordon's avatar
bugfix  
Leo Gordon committed
262
  $self->dbc->do( $sql );
263

264 265 266 267
  unless( $self->db->hive_use_triggers() ) {
      $worker->analysis->stats->adaptor->decrease_running_workers($worker->analysis->stats->analysis_id);
  }

Leo Gordon's avatar
bugfix  
Leo Gordon committed
268
  if($cod eq 'NO_WORK') {
269
    $self->db->get_AnalysisStatsAdaptor->update_status($worker->analysis->dbID, 'ALL_CLAIMED');
270
  }
Leo Gordon's avatar
bugfix  
Leo Gordon committed
271 272 273 274
  if($cod eq 'FATALITY'
  or $cod eq 'MEMLIMIT'
  or $cod eq 'RUNLIMIT'
  or $cod eq 'KILLED_BY_USER') {
Leo Gordon's avatar
Leo Gordon committed
275
    $self->db->get_AnalysisJobAdaptor->release_undone_jobs_from_worker($worker);
276
  }
277
  
278
  # re-sync the analysis_stats when a worker dies as part of dynamic sync system
279
  if($self->safe_synchronize_AnalysisStats($worker->analysis->stats)->status ne 'DONE') {
280 281
    # since I'm dying I should make sure there is someone to take my place after I'm gone ...
    # above synch still sees me as a 'living worker' so I need to compensate for that
282
    $self->db->get_AnalysisStatsAdaptor->increase_required_workers($worker->analysis->dbID);
283 284
  }

Jessica Severin's avatar
Jessica Severin committed
285 286
}

287
sub check_for_dead_workers {    # a bit counter-intuitively only looks for current meadow's workers, not all of the dead workers.
Leo Gordon's avatar
Leo Gordon committed
288 289
    my ($self, $meadow, $check_buried_in_haste) = @_;

290
    my $worker_status_hash    = $meadow->status_of_all_our_workers();
Leo Gordon's avatar
Leo Gordon committed
291
    my %worker_status_summary = ();
292
    my $queen_worker_list     = $self->fetch_overdue_workers(0);    # maybe it should return a {meadow->worker_count} hash instead?
Leo Gordon's avatar
Leo Gordon committed
293 294 295

    print "====== Live workers according to    Queen:".scalar(@$queen_worker_list).", Meadow:".scalar(keys %$worker_status_hash)."\n";

296 297
    my %gc_wpid_to_worker = ();

Leo Gordon's avatar
Leo Gordon committed
298 299 300
    foreach my $worker (@$queen_worker_list) {
        next unless($meadow->responsible_for_worker($worker));

301 302
        my $process_id = $worker->process_id();
        if(my $status = $worker_status_hash->{$process_id}) { # can be RUN|PEND|xSUSP
Leo Gordon's avatar
Leo Gordon committed
303 304 305
            $worker_status_summary{$status}++;
        } else {
            $worker_status_summary{'AWOL'}++;
306

307
            $gc_wpid_to_worker{$process_id} = $worker;
Leo Gordon's avatar
Leo Gordon committed
308 309 310 311
        }
    }
    print "\t".join(', ', map { "$_:$worker_status_summary{$_}" } keys %worker_status_summary)."\n\n";

312 313 314 315 316 317 318 319 320 321 322
    if(my $total_lost = scalar(keys %gc_wpid_to_worker)) {
        warn "GarbageCollector: Discovered $total_lost lost workers\n";

        my $wpid_to_cod = {};
        if(UNIVERSAL::can($meadow, 'find_out_causes')) {
            $wpid_to_cod = $meadow->find_out_causes( keys %gc_wpid_to_worker );
            my $lost_with_known_cod = scalar(keys %$wpid_to_cod);
            warn "GarbageCollector: Found why $lost_with_known_cod of them died\n";
        }

        warn "GarbageCollector: Releasing the jobs\n";
323 324
        while(my ($process_id, $worker) = each %gc_wpid_to_worker) {
            $worker->cause_of_death( $wpid_to_cod->{$process_id} || 'FATALITY');
325 326 327 328
            $self->register_worker_death($worker);
        }
    }

Leo Gordon's avatar
Leo Gordon committed
329 330
    if($check_buried_in_haste) {
        print "====== Checking for workers buried in haste... ";
331
        my $buried_in_haste_list = $self->fetch_all_dead_workers_with_jobs();
Leo Gordon's avatar
Leo Gordon committed
332 333 334 335 336
        if(my $bih_number = scalar(@$buried_in_haste_list)) {
            print "$bih_number, reclaiming jobs.\n\n";
            if($bih_number) {
                my $job_adaptor = $self->db->get_AnalysisJobAdaptor();
                foreach my $worker (@$buried_in_haste_list) {
Leo Gordon's avatar
Leo Gordon committed
337
                    $job_adaptor->release_undone_jobs_from_worker($worker);
Leo Gordon's avatar
Leo Gordon committed
338 339 340 341 342 343 344
                }
            }
        } else {
            print "none\n";
        }
    }
}
Jessica Severin's avatar
Jessica Severin committed
345 346


347 348 349
    # a new version that both checks in and updates the status
sub check_in_worker {
    my ($self, $worker) = @_;
Jessica Severin's avatar
Jessica Severin committed
350

351
    $self->dbc->do("UPDATE worker SET last_check_in=CURRENT_TIMESTAMP, status='".$worker->status."', work_done='".$worker->work_done."' WHERE worker_id='".$worker->dbID."'");
Jessica Severin's avatar
Jessica Severin committed
352 353 354
}


355
=head2 reset_and_fetch_job_by_dbID
356

357
  Arg [1]: int $job_id
358
  Example: 
359
    my $job = $queen->reset_and_fetch_job_by_dbID($job_id);
360
  Description: 
361
    For the specified job_id it will fetch just that job, 
362 363 364
    reset it completely as if it has never run, and return it.  
    Specifying a specific job bypasses the safety checks, 
    thus multiple workers could be running the 
365 366
    same job simultaneously (use only for debugging).
  Returntype : 
367
    Bio::EnsEMBL::Hive::AnalysisJob object
368
  Exceptions :
369
  Caller     : beekeepers, runWorker.pl scripts
370 371 372

=cut

373 374
sub reset_and_fetch_job_by_dbID {
  my $self = shift;
375
  my $job_id = shift;
376
  
377
  my $jobDBA = $self->db->get_AnalysisJobAdaptor;
378
  $jobDBA->reset_job_by_dbID($job_id); 
379

380
  my $job = $jobDBA->fetch_by_dbID($job_id); 
381 382
  my $stats = $self->db->get_AnalysisStatsAdaptor->fetch_by_analysis_id($job->analysis_id);
  $self->synchronize_AnalysisStats($stats);
383
  
384 385 386 387
  return $job;
}


388 389 390 391 392 393
######################################
#
# Public API interface for beekeeper
#
######################################

394 395 396
    # Note: asking for Queen->fetch_overdue_workers(0) essentially means
    #       "fetch all workers known to the Queen not to be officially dead"
    #
397 398 399 400 401
sub fetch_overdue_workers {
  my ($self,$overdue_secs) = @_;

  $overdue_secs = 3600 unless(defined($overdue_secs));

402 403 404 405
  my $constraint = "w.cause_of_death='' AND ".
                    ( ($self->dbc->driver eq 'sqlite')
                        ? "(strftime('%s','now')-strftime('%s',w.last_check_in))>$overdue_secs"
                        : "(UNIX_TIMESTAMP()-UNIX_TIMESTAMP(w.last_check_in))>$overdue_secs");
406 407 408
  return $self->_generic_fetch($constraint);
}

409 410
sub fetch_failed_workers {
  my $self = shift;
Leo Gordon's avatar
Leo Gordon committed
411

412
  my $constraint = "w.cause_of_death='FATALITY' ";
413 414 415
  return $self->_generic_fetch($constraint);
}

416
sub fetch_all_dead_workers_with_jobs {
Leo Gordon's avatar
Leo Gordon committed
417 418
  my $self = shift;

419
  # SELECT w.* FROM worker h, job j WHERE w.worker_id=j.worker_id AND w.cause_of_death!='' AND j.status NOT IN ('DONE', 'READY','FAILED', 'PASSED_ON') GROUP BY w.worker_id
Leo Gordon's avatar
Leo Gordon committed
420

421 422
  my $constraint = "w.cause_of_death!='' ";
  my $join = [[['job', 'j'], " w.worker_id=j.worker_id AND j.status NOT IN ('DONE', 'READY', 'FAILED', 'PASSED_ON') GROUP BY w.worker_id"]];
Leo Gordon's avatar
Leo Gordon committed
423 424
  return $self->_generic_fetch($constraint, $join);
}
Jessica Severin's avatar
Jessica Severin committed
425

426 427
=head2 synchronize_hive

Leo Gordon's avatar
Leo Gordon committed
428
  Arg [1]    : $filter_analysis (optional)
429 430
  Example    : $queen->synchronize_hive();
  Description: Runs through all analyses in the system and synchronizes
431 432
              the analysis_stats summary with the states in the job 
              and worker tables.  Then follows by checking all the blocking rules
433 434 435 436 437 438 439
              and blocks/unblocks analyses as needed.
  Exceptions : none
  Caller     : general

=cut

sub synchronize_hive {
Leo Gordon's avatar
Leo Gordon committed
440
  my $self          = shift;
Leo Gordon's avatar
Leo Gordon committed
441
  my $filter_analysis = shift; # optional parameter
442

443
  my $start_time = time();
444

Leo Gordon's avatar
Leo Gordon committed
445
  my $list_of_analyses = $filter_analysis ? [$filter_analysis] : $self->db->get_AnalysisAdaptor->fetch_all;
Leo Gordon's avatar
Leo Gordon committed
446

Leo Gordon's avatar
Leo Gordon committed
447
  print STDERR "\nSynchronizing the hive (".scalar(@$list_of_analyses)." analyses this time):\n";
Leo Gordon's avatar
Leo Gordon committed
448 449
  foreach my $analysis (@$list_of_analyses) {
    $self->synchronize_AnalysisStats($analysis->stats);
Leo Gordon's avatar
Leo Gordon committed
450
    print STDERR '.';
451
  }
Leo Gordon's avatar
Leo Gordon committed
452
  print STDERR "\n";
Leo Gordon's avatar
Leo Gordon committed
453

Leo Gordon's avatar
Leo Gordon committed
454
  print STDERR "Checking blocking control rules:\n";
Leo Gordon's avatar
Leo Gordon committed
455
  foreach my $analysis (@$list_of_analyses) {
Leo Gordon's avatar
Leo Gordon committed
456 457
    my $open = $analysis->stats->check_blocking_control_rules();
    print STDERR ($open ? 'o' : 'x');
458
  }
Leo Gordon's avatar
Leo Gordon committed
459
  print STDERR "\n";
Leo Gordon's avatar
Leo Gordon committed
460

Leo Gordon's avatar
Leo Gordon committed
461
  print STDERR ''.((time() - $start_time))." seconds to synchronize_hive\n\n";
462
}
463

464

465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486
=head2 safe_synchronize_AnalysisStats

  Arg [1]    : Bio::EnsEMBL::Hive::AnalysisStats object
  Example    : $self->synchronize($analysisStats);
  Description: Prewrapper around synchronize_AnalysisStats that does
               checks and grabs sync_lock before proceeding with sync.
               Used by distributed worker sync system to avoid contention.
  Exceptions : none
  Caller     : general

=cut

sub safe_synchronize_AnalysisStats {
  my $self = shift;
  my $stats = shift;

  return $stats unless($stats);
  return $stats unless($stats->analysis_id);
  return $stats if($stats->status eq 'SYNCHING');
  return $stats if($stats->status eq 'DONE');
  return $stats if($stats->sync_lock);
  return $stats if(($stats->status eq 'WORKING') and
487
                   ($stats->seconds_since_last_update < 3*60));
488 489 490 491

  # OK try to claim the sync_lock
  my $sql = "UPDATE analysis_stats SET status='SYNCHING', sync_lock=1 ".
            "WHERE sync_lock=0 and analysis_id=" . $stats->analysis_id;
492
  #print("$sql\n");
493 494
  my $row_count = $self->dbc->do($sql);  
  return $stats unless($row_count == 1);
495
  #printf("got sync_lock on analysis_stats(%d)\n", $stats->analysis_id);
496 497 498
  
  #OK have the lock, go and do the sync
  $self->synchronize_AnalysisStats($stats);
499

500 501 502 503
  return $stats;
}


504
=head2 synchronize_AnalysisStats
505

506 507
  Arg [1]    : Bio::EnsEMBL::Hive::AnalysisStats object
  Example    : $self->synchronize($analysisStats);
508
  Description: Queries the job and worker tables to get summary counts
509 510 511 512 513
               and rebuilds the AnalysisStats object.  Then updates the
               analysis_stats table with the new summary info
  Returntype : newly synced Bio::EnsEMBL::Hive::AnalysisStats object
  Exceptions : none
  Caller     : general
514

515
=cut
516

517
sub synchronize_AnalysisStats {
518
  my $self = shift;
519
  my $analysisStats = shift;
520

521
  return $analysisStats unless($analysisStats);
522
  return $analysisStats unless($analysisStats->analysis_id);
523

524
  $analysisStats->refresh(); ## Need to get the new hive_capacity for dynamic analyses
525 526
  my $hive_capacity = $analysisStats->hive_capacity;

527 528 529 530
  if($self->db->hive_use_triggers()) {

            my $job_count = $analysisStats->unclaimed_job_count();
            my $required_workers = POSIX::ceil( $job_count / $analysisStats->get_or_estimate_batch_size() );
531

532 533
                # adjust_stats_for_living_workers:
            if($hive_capacity > 0) {
534
                my $unfulfilled_capacity = $hive_capacity - $analysisStats->num_running_workers();
535

536 537
                if($unfulfilled_capacity < $required_workers ) {
                    $required_workers = (0 < $unfulfilled_capacity) ? $unfulfilled_capacity : 0;
538 539 540 541 542 543 544 545 546 547
                }
            }
            $analysisStats->num_required_workers( $required_workers );

  } else {
      $analysisStats->total_job_count(0);
      $analysisStats->unclaimed_job_count(0);
      $analysisStats->done_job_count(0);
      $analysisStats->failed_job_count(0);
      $analysisStats->num_required_workers(0);
548

549 550 551 552
      my $sql = "SELECT status, count(*), semaphore_count FROM job ".
                "WHERE analysis_id=? GROUP BY status, semaphore_count";
      my $sth = $self->prepare($sql);
      $sth->execute($analysisStats->analysis_id);
553 554


555 556 557 558
      my $done_here      = 0;
      my $done_elsewhere = 0;
      while (my ($status, $job_count, $semaphore_count)=$sth->fetchrow_array()) {
    # print STDERR "$status: $job_count\n";
559

560 561 562 563 564 565 566 567 568 569
        my $curr_total = $analysisStats->total_job_count();
        $analysisStats->total_job_count($curr_total + $job_count);

        if(($status eq 'READY') and ($semaphore_count<=0)) {
            $analysisStats->unclaimed_job_count($job_count);

            my $required_workers = POSIX::ceil( $job_count / $analysisStats->get_or_estimate_batch_size() );

                # adjust_stats_for_living_workers:
            if($hive_capacity > 0) {
570
                my $unfulfilled_capacity = $hive_capacity - $self->count_running_workers( $analysisStats->analysis_id() );
571

572 573
                if($unfulfilled_capacity < $required_workers ) {
                    $required_workers = (0 < $unfulfilled_capacity) ? $unfulfilled_capacity : 0;
574
                }
575
            }
576 577 578 579 580 581 582 583
            $analysisStats->num_required_workers( $required_workers );

        } elsif($status eq 'DONE' and $semaphore_count<=0) {
            $done_here = $job_count;
        } elsif($status eq 'PASSED_ON' and $semaphore_count<=0) {
            $done_elsewhere = $job_count;
        } elsif ($status eq 'FAILED') {
            $analysisStats->failed_job_count($job_count);
584
        }
585 586
      }
      $sth->finish;
587

588 589
      $analysisStats->done_job_count($done_here + $done_elsewhere);
  } # /unless $self->{'_hive_use_triggers'}
590

591
  $analysisStats->check_blocking_control_rules();
592

593 594 595
  if($analysisStats->status ne 'BLOCKED') {
    $analysisStats->determine_status();
  }
596

597
  $analysisStats->update;  #update and release sync_lock
598

599
  return $analysisStats;
600
}
601 602


Leo Gordon's avatar
Leo Gordon committed
603 604
sub get_num_failed_analyses {
  my ($self, $analysis) = @_;
605 606

  my $statsDBA = $self->db->get_AnalysisStatsAdaptor;
Leo Gordon's avatar
Leo Gordon committed
607
  my $failed_analyses = $statsDBA->fetch_by_statuses(['FAILED']);
608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629
  if ($analysis) {
    foreach my $this_failed_analysis (@$failed_analyses) {
      if ($this_failed_analysis->analysis_id == $analysis->dbID) {
        print "#########################################################\n",
            " Too many jobs failed for analysis ".$analysis->logic_name.". FAIL!!\n",
            "#########################################################\n\n";
        return 1;
      }
    }
    return 0;
  }

  if (@$failed_analyses) {
    print "##################################################\n",
        " Too many failed jobs. FAIL!!\n",
        "##################################################\n";
  }

  return scalar(@$failed_analyses);
}


630 631
sub get_hive_current_load {
  my $self = shift;
632 633 634
  my $sql = "SELECT sum(1/s.hive_capacity) FROM worker w, analysis_stats s ".
            "WHERE w.analysis_id=s.analysis_id and w.cause_of_death ='' ".
            "AND s.hive_capacity>0";
635 636 637 638 639
  my $sth = $self->prepare($sql);
  $sth->execute();
  (my $load)=$sth->fetchrow_array();
  $sth->finish;
  $load=0 unless($load);
Leo Gordon's avatar
Leo Gordon committed
640
  print("current hive load = $load\n");
641 642 643 644
  return $load;
}


645 646 647 648 649 650 651 652 653 654 655 656
sub count_running_workers {
    my ($self, $analysis_id) = @_;

    my $sql = "SELECT count(*) FROM worker WHERE cause_of_death =''"
        . ($analysis_id ? " AND analysis_id='$analysis_id'" : '');

    my $sth = $self->prepare($sql);
    $sth->execute();
    (my $running_workers_count)=$sth->fetchrow_array();
    $sth->finish();

    return $running_workers_count || 0;
657 658
}

659

660 661
=head2 get_num_needed_workers

662
  Arg[1]     : Bio::EnsEMBL::Analysis object (optional)
663 664 665 666
  Example    : $count = $queen->get_num_needed_workers();
  Description: Runs through the analyses in the system which are waiting
               for workers to be created for them.  Calculates the maximum
               number of workers needed to fill the current needs of the system
667
               If Arg[1] is defined, does it only for the given analysis.
668
  Exceptions : none
669
  Caller     : beekeepers and other external processes
670 671 672

=cut

673
sub get_num_needed_workers {
Leo Gordon's avatar
Leo Gordon committed
674
  my ($self, $filter_analysis) = @_;
675

676
  my $statsDBA = $self->db->get_AnalysisStatsAdaptor;
Leo Gordon's avatar
Leo Gordon committed
677 678 679
  my $clearly_needed_analyses     = $statsDBA->fetch_by_needed_workers(undef,$self->{maximise_concurrency});
  my $potentially_needed_analyses = $statsDBA->fetch_by_statuses(['LOADING', 'BLOCKED']);
  my @all_analyses = (@$clearly_needed_analyses, @$potentially_needed_analyses);
680

Leo Gordon's avatar
Leo Gordon committed
681
  return 0 unless(@all_analyses);
682

Leo Gordon's avatar
Leo Gordon committed
683
  my $available_load = 1.0 - $self->get_hive_current_load();
684

Leo Gordon's avatar
Leo Gordon committed
685
  return 0 if($available_load <=0.0);
686

Leo Gordon's avatar
Leo Gordon committed
687 688
  my $total_workers = 0;
  my %rc2workers = ();
689

Leo Gordon's avatar
Leo Gordon committed
690 691
  foreach my $analysis_stats (@all_analyses) {
    next if (defined $filter_analysis && $filter_analysis->dbID != $analysis_stats->analysis_id);
692

Leo Gordon's avatar
Leo Gordon committed
693
        #digging deeper under the surface so need to sync
694 695 696 697 698 699 700
    if(($analysis_stats->status eq 'LOADING') or ($analysis_stats->status eq 'BLOCKED')) {
      $self->synchronize_AnalysisStats($analysis_stats);
    }

    next if($analysis_stats->status eq 'BLOCKED');
    next if($analysis_stats->num_required_workers == 0);

701
        # FIXME: the following call *sometimes* returns a stale number greater than the number of workers actually needed for an analysis; -sync fixes it
Leo Gordon's avatar
Leo Gordon committed
702
    my $workers_this_analysis = $analysis_stats->num_required_workers;
703

704 705
    if((my $hive_capacity = $analysis_stats->hive_capacity) > 0) {   # if there is a limit, use it for cut-off
        my $limit_workers_this_analysis = int($available_load * $hive_capacity);
Leo Gordon's avatar
Leo Gordon committed
706 707 708 709 710

        if($workers_this_analysis > $limit_workers_this_analysis) {
            $workers_this_analysis = $limit_workers_this_analysis;
        }

711
        $available_load -= 1.0*$workers_this_analysis/$hive_capacity;
712
    }
Leo Gordon's avatar
Leo Gordon committed
713 714 715 716 717 718
    $total_workers += $workers_this_analysis;
    $rc2workers{$analysis_stats->rc_id} += $workers_this_analysis;
    $analysis_stats->print_stats();
    printf("  (%1.3f remaining-hive-load) use %3d workers of analysis_id=%d\n", $available_load, $workers_this_analysis, $analysis_stats->analysis_id);

    last if($available_load <= 0.0);
719
  }
720

Leo Gordon's avatar
Leo Gordon committed
721 722 723 724
  printf("need a total of $total_workers workers (availLoad=%1.5f)\n", $available_load);
  return ($total_workers, \%rc2workers);
}

725

Leo Gordon's avatar
Leo Gordon committed
726
sub get_needed_workers_resync_if_necessary {
Leo Gordon's avatar
Leo Gordon committed
727 728 729 730
    my ($self, $meadow, $analysis) = @_;

    my ($needed_count, $rc_hash) = $self->get_num_needed_workers($analysis);

731
    unless( $needed_count or $self->get_hive_current_load() or $self->count_running_workers() ) {
Leo Gordon's avatar
Leo Gordon committed
732 733 734 735 736 737 738 739
        print "*** nothing is running and nothing to do (according to analysis_stats) => perform a hard resync\n" ;

        $self->synchronize_hive($analysis);
        $self->check_for_dead_workers($meadow, 1);

        ($needed_count, $rc_hash) = $self->get_num_needed_workers($analysis);
    }

Leo Gordon's avatar
Leo Gordon committed
740
    return ($needed_count, $rc_hash);
741 742
}

743

Leo Gordon's avatar
Leo Gordon committed
744
sub get_remaining_jobs_show_hive_progress {
745
  my $self = shift;
Leo Gordon's avatar
Leo Gordon committed
746
  my $sql = "SELECT sum(done_job_count), sum(failed_job_count), sum(total_job_count), ".
747 748
            "sum(unclaimed_job_count * analysis_stats.avg_msec_per_job)/1000/60/60 ".
            "FROM analysis_stats";
749 750
  my $sth = $self->prepare($sql);
  $sth->execute();
751
  my ($done, $failed, $total, $cpuhrs) = $sth->fetchrow_array();
752
  $sth->finish;
753 754 755 756 757 758 759

  $done   ||= 0;
  $failed ||= 0;
  $total  ||= 0;
  my $completed = $total
    ? ((100.0 * ($done+$failed))/$total)
    : 0.0;
760 761 762
  my $remaining = $total - $done - $failed;
  printf("hive %1.3f%% complete (< %1.3f CPU_hrs) (%d todo + %d done + %d failed = %d total)\n", 
          $completed, $cpuhrs, $remaining, $done, $failed, $total);
Leo Gordon's avatar
Leo Gordon committed
763
  return $remaining;
764 765
}

766

Leo Gordon's avatar
Leo Gordon committed
767
sub print_analysis_status {
Leo Gordon's avatar
Leo Gordon committed
768
    my ($self, $filter_analysis) = @_;
769

Leo Gordon's avatar
Leo Gordon committed
770
    my $list_of_analyses = $filter_analysis ? [$filter_analysis] : $self->db->get_AnalysisAdaptor->fetch_all;
Leo Gordon's avatar
Leo Gordon committed
771 772 773
    foreach my $analysis (sort {$a->dbID <=> $b->dbID} @$list_of_analyses) {
        $analysis->stats->print_stats($self->{'verbose_stats'});
    }
774 775 776
}


Leo Gordon's avatar
Leo Gordon committed
777
sub print_running_worker_status {
778
  my $self = shift;
779

Leo Gordon's avatar
Leo Gordon committed
780
  print "====== Live workers according to Queen:\n";
781 782 783
  my $sql = "SELECT logic_name, count(*) FROM worker, analysis ".
            "WHERE worker.analysis_id=analysis.analysis_id AND worker.cause_of_death='' ".
            "GROUP BY worker.analysis_id";
Leo Gordon's avatar
Leo Gordon committed
784

785
  my $total_workers = 0;
786 787
  my $sth = $self->prepare($sql);
  $sth->execute();
788 789 790
  while((my $logic_name, my $worker_count)=$sth->fetchrow_array()) {
    printf("%20s : %d workers\n", $logic_name, $worker_count);
    $total_workers += $worker_count;
791
  }
792
  printf("  %d total workers\n", $total_workers);
Leo Gordon's avatar
Leo Gordon committed
793
  print "===========================\n";
794
  $sth->finish;
795
}
796

797 798 799 800 801 802 803 804 805 806 807
=head2 monitor

  Arg[1]     : --none--
  Example    : $queen->monitor();
  Description: Monitors current throughput and store the result in the monitor
               table
  Exceptions : none
  Caller     : beekeepers and other external processes

=cut

Leo Gordon's avatar
Leo Gordon committed
808
sub monitor {
809 810 811 812
  my $self = shift;
  my $sql = qq{
      INSERT INTO monitor
      SELECT
813
          CURRENT_TIMESTAMP,
814
          count(*),
Leo Gordon's avatar
Leo Gordon committed
815 816 817 818 819 820
  }. ( ($self->dbc->driver eq 'sqlite')
        ? qq{ sum(work_done/(strftime('%s','now')-strftime('%s',born))),
              sum(work_done/(strftime('%s','now')-strftime('%s',born)))/count(*), }
        : qq{ sum(work_done/(UNIX_TIMESTAMP()-UNIX_TIMESTAMP(born))),
              sum(work_done/(UNIX_TIMESTAMP()-UNIX_TIMESTAMP(born)))/count(*), }
  ). qq{
821
          group_concat(DISTINCT logic_name)
822
      FROM worker left join analysis USING (analysis_id)
823 824
      WHERE cause_of_death = ''
  };
825 826 827 828 829
      
  my $sth = $self->prepare($sql);
  $sth->execute();
}

Leo Gordon's avatar
Leo Gordon committed
830 831 832 833 834 835 836 837 838 839 840 841 842 843
=head2 register_all_workers_dead

  Example    : $queen->register_all_workers_dead();
  Description: Registers all workers dead
  Exceptions : none
  Caller     : beekeepers and other external processes

=cut

sub register_all_workers_dead {
    my $self = shift;

    my $overdueWorkers = $self->fetch_overdue_workers(0);
    foreach my $worker (@{$overdueWorkers}) {
844
        $worker->cause_of_death( 'FATALITY' );  # well, maybe we could have investigated further...
Leo Gordon's avatar
Leo Gordon committed
845 846 847 848
        $self->register_worker_death($worker);
    }
}

849

Jessica Severin's avatar
Jessica Severin committed
850 851 852 853 854
#
# INTERNAL METHODS
#
###################

855
sub _pick_best_analysis_for_new_worker {
Leo Gordon's avatar
Leo Gordon committed
856 857
  my $self  = shift;
  my $rc_id = shift;    # this parameter will need to percolate very deep
858 859 860 861

  my $statsDBA = $self->db->get_AnalysisStatsAdaptor;
  return undef unless($statsDBA);

Leo Gordon's avatar
Leo Gordon committed
862
  my ($stats) = @{$statsDBA->fetch_by_needed_workers(1,$self->{maximise_concurrency}, $rc_id)};
863 864 865
  if($stats) {
    #synchronize and double check that it can be run
    $self->safe_synchronize_AnalysisStats($stats);
866
    return $stats if(($stats->status ne 'BLOCKED') and ($stats->num_required_workers > 0) and (!defined($rc_id) or ($stats->rc_id == $rc_id)));
867
  }