Queen.pm 27.6 KB
Newer Older
Jessica Severin's avatar
Jessica Severin committed
1 2 3
=pod 

=head1 NAME
4

5 6 7
    Bio::EnsEMBL::Hive::Queen

=head1 DESCRIPTION
Jessica Severin's avatar
Jessica Severin committed
8

9 10 11 12
    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.
13

14 15 16 17
    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).
Jessica Severin's avatar
Jessica Severin committed
18

19 20 21 22 23 24 25 26 27 28 29 30 31 32 33
    Each worker is linked to an analysis_id, registers its self on creation
    into the Hive, creates a RunnableDB instance of the Analysis->module,
    gets $analysis->stats->batch_size jobs from the job table, does its work,
    creates the next layer of job entries by interfacing to
    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
    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.
34

35 36 37 38 39 40 41 42
    The Beekeeper is in charge of interfacing between the Queen and a compute resource
    or 'compute farm'.  Its job is to query Queens if they need any workers and to
    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.

=head1 LICENSE

43
    Copyright [1999-2014] Wellcome Trust Sanger Institute and the EMBL-European Bioinformatics Institute
44 45 46 47 48 49 50 51 52

    Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

         http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software distributed under the License
    is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and limitations under the License.
Jessica Severin's avatar
Jessica Severin committed
53 54

=head1 CONTACT
55

56
    Please subscribe to the Hive mailing list:  http://listserver.ebi.ac.uk/mailman/listinfo/ehive-users  to discuss Hive-related questions or to be notified of our updates
Jessica Severin's avatar
Jessica Severin committed
57 58

=head1 APPENDIX
59

60 61
    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
62 63 64

=cut

65

Jessica Severin's avatar
Jessica Severin committed
66 67 68
package Bio::EnsEMBL::Hive::Queen;

use strict;
69
use File::Path 'make_path';
70

71
use Bio::EnsEMBL::Hive::Utils ('destringify', 'dir_revhash');  # NB: needed by invisible code
72
use Bio::EnsEMBL::Hive::AnalysisJob;
Jessica Severin's avatar
Jessica Severin committed
73
use Bio::EnsEMBL::Hive::Worker;
74
use Bio::EnsEMBL::Hive::Scheduler;
Jessica Severin's avatar
Jessica Severin committed
75

76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91
use base ('Bio::EnsEMBL::Hive::DBSQL::ObjectAdaptor');


sub default_table_name {
    return 'worker';
}


sub default_insertion_method {
    return 'INSERT';
}


sub object_class {
    return 'Bio::EnsEMBL::Hive::Worker';
}
92

Jessica Severin's avatar
Jessica Severin committed
93

94
############################
Jessica Severin's avatar
Jessica Severin committed
95
#
96
# PUBLIC API
Jessica Severin's avatar
Jessica Severin committed
97
#
98
############################
Jessica Severin's avatar
Jessica Severin committed
99

100

Jessica Severin's avatar
Jessica Severin committed
101 102
=head2 create_new_worker

103 104 105 106
  Description: Creates an entry in the worker table,
               populates some non-storable attributes
               and returns a Worker object based on that insert.
               This guarantees that each worker registered in this Queen's hive is properly registered.
Jessica Severin's avatar
Jessica Severin committed
107
  Returntype : Bio::EnsEMBL::Hive::Worker
108
  Caller     : runWorker.pl
Jessica Severin's avatar
Jessica Severin committed
109 110 111 112

=cut

sub create_new_worker {
113 114
    my $self    = shift @_;
    my %flags   = @_;
115

116
    my ($meadow_type, $meadow_name, $process_id, $exec_host, $resource_class_id, $resource_class_name,
117 118 119
        $no_write, $debug, $worker_log_dir, $hive_log_dir, $job_limit, $life_span, $no_cleanup, $retry_throwing_jobs, $can_respecialize)
     = @flags{qw(-meadow_type -meadow_name -process_id -exec_host -resource_class_id -resource_class_name
            -no_write -debug -worker_log_dir -hive_log_dir -job_limit -life_span -no_cleanup -retry_throwing_jobs -can_respecialize)};
120

121 122 123 124 125 126 127 128 129 130 131 132
    foreach my $prev_worker_incarnation (@{ $self->fetch_all( "status!='DEAD' AND meadow_type='$meadow_type' AND meadow_name='$meadow_name' AND process_id='$process_id'" ) }) {
            # so far 'RELOCATED events' has been detected on LSF 9.0 in response to sending signal #99 or #100
            # Since I don't know how to avoid them, I am trying to register them when they happen.
            # The following snippet buries the previous incarnation of the Worker before starting a new one.
            #
            # FIXME: if GarabageCollector (beekeeper -dead) gets to these processes first, it will register them as DEAD/UNKNOWN.
            #       LSF 9.0 does not report "rescheduling" events in the output of 'bacct', but does mention them in 'bhist'.
            #       So parsing 'bhist' output would probably yield the most accurate & confident registration of these events.
        $prev_worker_incarnation->cause_of_death( 'RELOCATED' );
        $self->register_worker_death( $prev_worker_incarnation );
    }

133
    if( defined($resource_class_name) ) {
134 135 136 137 138 139 140 141 142 143 144 145
        my $rc = $self->db->get_ResourceClassAdaptor->fetch_by_name($resource_class_name)
            or die "resource_class with name='$resource_class_name' could not be fetched from the database";

        $resource_class_id = $rc->dbID;
    }

    my $sql = q{INSERT INTO worker (born, last_check_in, meadow_type, meadow_name, host, process_id, resource_class_id)
              VALUES (CURRENT_TIMESTAMP, CURRENT_TIMESTAMP, ?, ?, ?, ?, ?)};

    my $sth = $self->prepare($sql);
    $sth->execute($meadow_type, $meadow_name, $exec_host, $process_id, $resource_class_id);
    my $worker_id = $self->dbc->db_handle->last_insert_id(undef, undef, 'worker', 'worker_id')
146
        or die "Could not insert a new worker";
147 148
    $sth->finish;

149 150 151
    my $worker = $self->fetch_by_dbID($worker_id)
        or die "Could not fetch worker with dbID=$worker_id";

152 153 154 155
    if($hive_log_dir or $worker_log_dir) {
        my $dir_revhash = dir_revhash($worker_id);
        $worker_log_dir ||= $hive_log_dir .'/'. ($dir_revhash ? "$dir_revhash/" : '') .'worker_id_'.$worker_id;

156 157
        eval {
            make_path( $worker_log_dir );
158 159
            1;
        } or die "Could not create '$worker_log_dir' directory : $@";
160

161 162
        $worker->log_dir( $worker_log_dir );
        $self->update_log_dir( $worker );   # autoloaded
163 164 165 166
    }

    $worker->init;

167 168
    if(defined($job_limit)) {
      $worker->job_limiter($job_limit);
169 170 171 172 173 174 175 176 177 178 179 180 181
      $worker->life_span(0);
    }

    $worker->life_span($life_span * 60)                 if($life_span);

    $worker->execute_writes(0)                          if($no_write);

    $worker->perform_cleanup(0)                         if($no_cleanup);

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

    $worker->retry_throwing_jobs($retry_throwing_jobs)  if(defined $retry_throwing_jobs);

182 183
    $worker->can_respecialize($can_respecialize)        if(defined $can_respecialize);

184 185 186 187 188
    return $worker;
}


=head2 specialize_new_worker
189

190 191
  Description: If analysis_id or logic_name is specified it will try to specialize the Worker into this analysis.
               If not specified the Queen will analyze the hive and pick the most suitable analysis.
192
  Caller     : Bio::EnsEMBL::Hive::Worker
193 194 195 196

=cut

sub specialize_new_worker {
197 198 199
    my $self    = shift @_;
    my $worker  = shift @_;
    my %flags   = @_;
200

201 202
    my ($analysis_id, $logic_name, $job_id, $force)
     = @flags{qw(-analysis_id -logic_name -job_id -force)};
203

204 205
    if( scalar( grep {defined($_)} ($analysis_id, $logic_name, $job_id) ) > 1) {
        die "At most one of the options {-analysis_id, -logic_name, -job_id} can be set to pre-specialize a Worker";
Leo Gordon's avatar
Leo Gordon committed
206 207
    }

208
    my ($analysis, $stats, $special_batch);
209
    my $analysis_stats_adaptor = $self->db->get_AnalysisStatsAdaptor;
Jessica Severin's avatar
Jessica Severin committed
210

211
    if($job_id or $analysis_id or $logic_name) {    # probably pre-specialized from command-line
212

213
        if($job_id) {
214
            warn "resetting and fetching job for job_id '$job_id'\n";
215 216

            my $job_adaptor = $self->db->get_AnalysisJobAdaptor;
217

218 219 220 221 222 223 224 225 226
            my $job = $job_adaptor->fetch_by_dbID( $job_id )
                or die "Could not fetch job with dbID='$job_id'";
            my $job_status = $job->status();

            if($job_status =~/(CLAIMED|PRE_CLEANUP|FETCH_INPUT|RUN|WRITE_OUTPUT|POST_CLEANUP)/ ) {
                die "Job with dbID='$job_id' is already in progress, cannot run";   # FIXME: try GC first, then complain
            } elsif($job_status =~/(DONE|SEMAPHORED)/ and !$force) {
                die "Job with dbID='$job_id' is $job_status, please use -force 1 to override";
            }
227

228 229 230 231 232 233 234 235
            if(($job_status eq 'DONE') and $job->semaphored_job_id) {
                warn "Increasing the semaphore count of the dependent job";
                $job_adaptor->increase_semaphore_count_for_jobid( $job->semaphored_job_id );
            }

            my $worker_id = $worker->dbID;
            if($job = $job_adaptor->reset_or_grab_job_by_dbID($job_id, $worker_id)) {
                $special_batch = [ $job ];
236 237
                $analysis_id = $job->analysis_id;
            } else {
238
                die "Could not claim job with dbID='$job_id' for worker with dbID='$worker_id'";
239
            }
240 241 242 243 244 245 246 247 248 249 250 251 252
        }

        if($logic_name) {
            $analysis = $self->db->get_AnalysisAdaptor->fetch_by_logic_name($logic_name)
                or die "analysis with name='$logic_name' could not be fetched from the database";

            $analysis_id = $analysis->dbID;

        } elsif($analysis_id) {
            $analysis = $self->db->get_AnalysisAdaptor->fetch_by_dbID($analysis_id)
                or die "analysis with dbID='$analysis_id' could not be fetched from the database";
        }

253 254 255
        if( $worker->resource_class_id
        and $worker->resource_class_id != $analysis->resource_class_id) {
                die "resource_class of analysis ".$analysis->logic_name." is incompatible with this Worker's resource_class";
256 257
        }

258
        $stats = $analysis->stats;
259 260
        $self->safe_synchronize_AnalysisStats($stats);

261
        unless($special_batch or $force) {    # do we really need to run this analysis?
262
            if($self->get_hive_current_load() >= 1.1) {
263
                $worker->cause_of_death('HIVE_OVERLOAD');
264
                die "Hive is overloaded, can't specialize a worker";
265 266
            }
            if($stats->status eq 'BLOCKED') {
267
                die "Analysis is BLOCKED, can't specialize a worker";
268
            }
269
            if($stats->num_required_workers <= 0) {
270
                die "Analysis doesn't require extra workers at the moment";
271 272
            }
            if($stats->status eq 'DONE') {
273
                die "Analysis is DONE, and doesn't require workers";
274 275
            }
        }
276
            # probably scheduled by beekeeper.pl:
277
    } elsif( $stats = Bio::EnsEMBL::Hive::Scheduler::suggest_analysis_to_specialize_by_rc_id_meadow_type($self, $worker->resource_class_id, $worker->meadow_type) ) {
278

279
        $worker->analysis( undef ); # make sure we reset anything that was there before
280
        $analysis_id = $stats->analysis_id;
281 282 283
    } else {
        $worker->cause_of_death('NO_ROLE');
        die "No analysis suitable for the worker was found\n";
284
    }
285

286
        # now set it in the $worker:
Jessica Severin's avatar
Jessica Severin committed
287

288
    $worker->analysis_id( $analysis_id );
Jessica Severin's avatar
Jessica Severin committed
289

290
    $self->update_analysis_id( $worker );   # autoloaded
291

292 293
    if($special_batch) {
        $worker->special_batch( $special_batch );
294
    } else {    # count it as autonomous worker sharing the load of that analysis:
295

296
        $analysis_stats_adaptor->update_status($analysis_id, 'WORKING');
297

298
        $analysis_stats_adaptor->decrease_required_workers($worker->analysis_id);
299 300 301 302 303 304 305 306 307
    }

        # 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() ) {
308
        $analysis_stats_adaptor->increase_running_workers($worker->analysis_id);
309
    }
Jessica Severin's avatar
Jessica Severin committed
310 311
}

312

Jessica Severin's avatar
Jessica Severin committed
313
sub register_worker_death {
314
    my ($self, $worker, $self_burial) = @_;
315

316 317 318 319
    return unless($worker);

    my $cod = $worker->cause_of_death() || 'UNKNOWN';    # make sure we do not attempt to insert a void

320
                    # FIXME: make it possible to set the 'died' timestamp if we have detected it from logs:
321
    my $sql = qq{UPDATE worker SET died=CURRENT_TIMESTAMP
322
    } . ( $self_burial ? ',last_check_in=CURRENT_TIMESTAMP ' : '') . qq{
323 324 325 326 327 328 329 330 331 332 333 334 335
                    ,status='DEAD'
                    ,work_done='}. $worker->work_done . qq{'
                    ,cause_of_death='$cod'
                WHERE worker_id='}. $worker->dbID . qq{'};
    $self->dbc->do( $sql );

    if(my $analysis_id = $worker->analysis_id) {
        my $analysis_stats_adaptor = $self->db->get_AnalysisStatsAdaptor;

        unless( $self->db->hive_use_triggers() ) {
            $analysis_stats_adaptor->decrease_running_workers($worker->analysis_id);
        }

336 337 338 339 340
        unless( $cod eq 'NO_WORK'
            or  $cod eq 'JOB_LIMIT'
            or  $cod eq 'HIVE_OVERLOAD'
            or  $cod eq 'LIFESPAN'
        ) {
341 342 343 344 345 346 347 348 349 350
                $self->db->get_AnalysisJobAdaptor->release_undone_jobs_from_worker($worker);
        }

            # re-sync the analysis_stats when a worker dies as part of dynamic sync system
        if($self->safe_synchronize_AnalysisStats($worker->analysis->stats)->status ne 'DONE') {
            # 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
            $analysis_stats_adaptor->increase_required_workers($worker->analysis_id);
        }
    }
Jessica Severin's avatar
Jessica Severin committed
351 352
}

353

354
sub check_for_dead_workers {    # scans the whole Valley for lost Workers (but ignores unreachagle ones)
355
    my ($self, $valley, $check_buried_in_haste) = @_;
Leo Gordon's avatar
Leo Gordon committed
356

357
    warn "GarbageCollector:\tChecking for lost Workers...\n";
358

359 360
    my $last_few_seconds            = 5;    # FIXME: It is probably a good idea to expose this parameter for easier tuning.
    my $queen_overdue_workers       = $self->fetch_overdue_workers( $last_few_seconds );    # check the workers we have not seen active during the $last_few_seconds
361 362 363
    my %mt_and_pid_to_worker_status = ();
    my %worker_status_counts        = ();
    my %mt_and_pid_to_lost_worker   = ();
Leo Gordon's avatar
Leo Gordon committed
364

365
    warn "GarbageCollector:\t[Queen:] out of ".scalar(@$queen_overdue_workers)." Workers that haven't checked in during the last $last_few_seconds seconds...\n";
366

367
    foreach my $worker (@$queen_overdue_workers) {
Leo Gordon's avatar
Leo Gordon committed
368

369 370 371
        my $meadow_type = $worker->meadow_type;
        if(my $meadow = $valley->find_available_meadow_responsible_for_worker($worker)) {
            $mt_and_pid_to_worker_status{$meadow_type} ||= $meadow->status_of_all_our_workers;
Leo Gordon's avatar
Leo Gordon committed
372
        } else {
373
            $worker_status_counts{$meadow_type}{'UNREACHABLE'}++;
374

375
            next;   # Worker is unreachable from this Valley
Leo Gordon's avatar
Leo Gordon committed
376 377
        }

378 379 380 381 382
        my $process_id = $worker->process_id;
        if(my $status = $mt_and_pid_to_worker_status{$meadow_type}{$process_id}) { # can be RUN|PEND|xSUSP
            $worker_status_counts{$meadow_type}{$status}++;
        } else {
            $worker_status_counts{$meadow_type}{'LOST'}++;
383

384
            $mt_and_pid_to_lost_worker{$meadow_type}{$process_id} = $worker;
385
        }
386 387 388 389 390 391
    }

        # just a quick summary report:
    foreach my $meadow_type (keys %worker_status_counts) {
        warn "GarbageCollector:\t[$meadow_type Meadow:]\t".join(', ', map { "$_:$worker_status_counts{$meadow_type}{$_}" } keys %{$worker_status_counts{$meadow_type}})."\n\n";
    }
392

393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409
    while(my ($meadow_type, $pid_to_lost_worker) = each %mt_and_pid_to_lost_worker) {
        my $this_meadow = $valley->available_meadow_hash->{$meadow_type};

        if(my $lost_this_meadow = scalar(keys %$pid_to_lost_worker) ) {
            warn "GarbageCollector:\tDiscovered $lost_this_meadow lost $meadow_type Workers\n";

            my $wpid_to_cod = {};
            if($this_meadow->can('find_out_causes')) {
                $wpid_to_cod = $this_meadow->find_out_causes( keys %$pid_to_lost_worker );
                my $lost_with_known_cod = scalar(keys %$wpid_to_cod);
                warn "GarbageCollector:\tFound why $lost_with_known_cod of $meadow_type Workers died\n";
            } else {
                warn "GarbageCollector:\t$meadow_type meadow does not support post-mortem examination\n";
            }

            warn "GarbageCollector:\tReleasing the jobs\n";
            while(my ($process_id, $worker) = each %$pid_to_lost_worker) {
410
                $worker->cause_of_death( $wpid_to_cod->{$process_id} || 'UNKNOWN');
411 412
                $self->register_worker_death($worker);
            }
413 414 415
        }
    }

416
        # the following bit is completely Meadow-agnostic and only restores database integrity:
Leo Gordon's avatar
Leo Gordon committed
417
    if($check_buried_in_haste) {
418
        warn "GarbageCollector:\tChecking for Workers buried in haste...\n";
419
        my $buried_in_haste_list = $self->fetch_all_dead_workers_with_jobs();
Leo Gordon's avatar
Leo Gordon committed
420
        if(my $bih_number = scalar(@$buried_in_haste_list)) {
421
            warn "GarbageCollector:\tfound $bih_number jobs, reclaiming.\n\n";
Leo Gordon's avatar
Leo Gordon committed
422 423 424
            if($bih_number) {
                my $job_adaptor = $self->db->get_AnalysisJobAdaptor();
                foreach my $worker (@$buried_in_haste_list) {
Leo Gordon's avatar
Leo Gordon committed
425
                    $job_adaptor->release_undone_jobs_from_worker($worker);
Leo Gordon's avatar
Leo Gordon committed
426 427 428
                }
            }
        } else {
429
            warn "GarbageCollector:\tfound none\n";
Leo Gordon's avatar
Leo Gordon committed
430 431 432
        }
    }
}
Jessica Severin's avatar
Jessica Severin committed
433 434


435 436 437
    # 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
438

439
    $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
440 441 442
}


443
=head2 reset_job_by_dbID_and_sync
444

445
  Arg [1]: int $job_id
446
  Example: 
447
    my $job = $queen->reset_job_by_dbID_and_sync($job_id);
448
  Description: 
449
    For the specified job_id it will fetch just that job, 
450 451 452
    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 
453
    same job simultaneously (use only for debugging).
454
  Returntype : none
455
  Exceptions :
456
  Caller     : beekeeper.pl
457 458 459

=cut

460 461
sub reset_job_by_dbID_and_sync {
    my ($self, $job_id) = @_;
462

463 464 465
    my $job     = $self->db->get_AnalysisJobAdaptor->reset_or_grab_job_by_dbID($job_id);

    my $stats   = $job->analysis->stats;
466 467

    $self->synchronize_AnalysisStats($stats);
468 469 470
}


471 472 473 474 475 476
######################################
#
# Public API interface for beekeeper
#
######################################

477

478 479 480
    # Note: asking for Queen->fetch_overdue_workers(0) essentially means
    #       "fetch all workers known to the Queen not to be officially dead"
    #
481
sub fetch_overdue_workers {
482
    my ($self,$overdue_secs) = @_;
483

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

486 487 488 489 490 491
    my $constraint = "status!='DEAD' AND ".{
            'mysql'     =>  "(UNIX_TIMESTAMP()-UNIX_TIMESTAMP(last_check_in)) > $overdue_secs",
            'sqlite'    =>  "(strftime('%s','now')-strftime('%s',last_check_in)) > $overdue_secs",
            'pgsql'     =>  "EXTRACT(EPOCH FROM CURRENT_TIMESTAMP - last_check_in) > $overdue_secs",
        }->{ $self->dbc->driver };

492
    return $self->fetch_all( $constraint );
493 494
}

495 496 497

sub fetch_all_dead_workers_with_jobs {
    my $self = shift;
Leo Gordon's avatar
Leo Gordon committed
498

499
    return $self->fetch_all( "JOIN job j USING(worker_id) WHERE worker.status='DEAD' AND j.status NOT IN ('DONE', 'READY', 'FAILED', 'PASSED_ON') GROUP BY worker_id" );
Leo Gordon's avatar
Leo Gordon committed
500
}
Jessica Severin's avatar
Jessica Severin committed
501

502

503 504
=head2 synchronize_hive

Leo Gordon's avatar
Leo Gordon committed
505
  Arg [1]    : $filter_analysis (optional)
506 507
  Example    : $queen->synchronize_hive();
  Description: Runs through all analyses in the system and synchronizes
508 509
              the analysis_stats summary with the states in the job 
              and worker tables.  Then follows by checking all the blocking rules
510 511 512 513 514 515 516
              and blocks/unblocks analyses as needed.
  Exceptions : none
  Caller     : general

=cut

sub synchronize_hive {
Leo Gordon's avatar
Leo Gordon committed
517
  my $self          = shift;
Leo Gordon's avatar
Leo Gordon committed
518
  my $filter_analysis = shift; # optional parameter
519

520
  my $start_time = time();
521

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

Leo Gordon's avatar
Leo Gordon committed
524
  print STDERR "\nSynchronizing the hive (".scalar(@$list_of_analyses)." analyses this time):\n";
Leo Gordon's avatar
Leo Gordon committed
525 526
  foreach my $analysis (@$list_of_analyses) {
    $self->synchronize_AnalysisStats($analysis->stats);
527
    print STDERR ( ($analysis->stats()->status eq 'BLOCKED') ? 'x' : 'o');
528
  }
Leo Gordon's avatar
Leo Gordon committed
529
  print STDERR "\n";
Leo Gordon's avatar
Leo Gordon committed
530

Leo Gordon's avatar
Leo Gordon committed
531
  print STDERR ''.((time() - $start_time))." seconds to synchronize_hive\n\n";
532
}
533

534

535 536 537
=head2 safe_synchronize_AnalysisStats

  Arg [1]    : Bio::EnsEMBL::Hive::AnalysisStats object
538
  Example    : $self->safe_synchronize_AnalysisStats($stats);
539 540 541 542 543 544 545 546 547
  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 {
548 549 550 551 552 553 554 555 556 557
    my ($self, $stats) = @_;

    my $max_refresh_attempts = 5;
    while($stats->sync_lock and $max_refresh_attempts--) {   # another Worker/Beekeeper is synching this analysis right now
        sleep(1);
        $stats->refresh();  # just try to avoid collision
    }

    return $stats if($stats->status eq 'DONE');
    return $stats if(($stats->status eq 'WORKING') and
558
                   ($stats->seconds_since_last_update < 3*60));
559

560 561 562 563 564
        # 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;
    my $row_count = $self->dbc->do($sql);  
    return $stats unless($row_count == 1);        # return the un-updated status if locked
565
  
566 567
        # if we managed to obtain the lock, let's go and perform the sync:
    $self->synchronize_AnalysisStats($stats);
568

569
    return $stats;
570 571 572
}


573
=head2 synchronize_AnalysisStats
574

575 576
  Arg [1]    : Bio::EnsEMBL::Hive::AnalysisStats object
  Example    : $self->synchronize($analysisStats);
577
  Description: Queries the job and worker tables to get summary counts
578 579 580 581 582
               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
583

584
=cut
585

586
sub synchronize_AnalysisStats {
587 588 589 590 591 592 593 594
    my $self = shift;
    my $analysisStats = shift;

    return $analysisStats unless($analysisStats);
    return $analysisStats unless($analysisStats->analysis_id);

    $analysisStats->refresh(); ## Need to get the new hive_capacity for dynamic analyses

595
    my $job_counts = $self->db->hive_use_triggers() ? undef : $self->db->get_AnalysisJobAdaptor->fetch_job_counts_hashed_by_status( $analysisStats->analysis_id );
596

597
    $analysisStats->recalculate_from_job_counts( $job_counts );
598

599 600
    # $analysisStats->sync_lock(0); ## do we perhaps need it here?
    $analysisStats->update;  #update and release sync_lock
601

602
    return $analysisStats;
603
}
604 605


606 607 608 609 610 611 612 613 614 615 616 617 618 619
=head2 get_num_failed_analyses

  Arg [1]    : Bio::EnsEMBL::Hive::AnalysisStats object (optional)
  Example    : if( $self->get_num_failed_analyses( $my_analysis )) { do_something; }
  Example    : my $num_failed_analyses = $self->get_num_failed_analyses();
  Description: Reports all failed analyses and returns
                either the number of total failed (if no $filter_analysis was provided)
                or 1/0, depending on whether $filter_analysis failed or not.
  Returntype : int
  Exceptions : none
  Caller     : general

=cut

Leo Gordon's avatar
Leo Gordon committed
620
sub get_num_failed_analyses {
621
    my ($self, $filter_analysis) = @_;
622

623 624 625 626 627
    my $failed_analyses = $self->db->get_AnalysisAdaptor->fetch_all_failed_analyses();

    my $filter_analysis_failed = 0;

    foreach my $failed_analysis (@$failed_analyses) {
628 629 630
        warn "\t##########################################################\n";
        warn "\t# Too many jobs in analysis '".$failed_analysis->logic_name."' FAILED #\n";
        warn "\t##########################################################\n\n";
631 632 633 634
        if($filter_analysis and ($filter_analysis->dbID == $failed_analysis)) {
            $filter_analysis_failed = 1;
        }
    }
635

636
    return $filter_analysis ? $filter_analysis_failed : scalar(@$failed_analyses);
637 638 639
}


640
sub get_hive_current_load {
641 642 643
    my $self = shift;
    my $sql = qq{
        SELECT sum(1/hive_capacity)
644 645 646
        FROM worker w
        JOIN analysis_stats USING(analysis_id)
        WHERE w.status!='DEAD'
647
        AND hive_capacity IS NOT NULL
648
        AND hive_capacity>0
649 650 651 652 653 654
    };
    my $sth = $self->prepare($sql);
    $sth->execute();
    my ($load)=$sth->fetchrow_array();
    $sth->finish;
    return ($load || 0);
655 656 657
}


658 659 660
sub count_running_workers {
    my ($self, $analysis_id) = @_;

661 662
    return $self->count_all( "status!='DEAD'".($analysis_id ? " AND analysis_id=$analysis_id" : '') );
}
663 664


665 666 667 668
sub get_workers_rank {
    my ($self, $worker) = @_;

    return $self->count_all( "status!='DEAD' AND analysis_id=".$worker->analysis_id." AND worker_id<".$worker->dbID );
669 670
}

671

Leo Gordon's avatar
Leo Gordon committed
672
sub get_remaining_jobs_show_hive_progress {
673
  my $self = shift;
Leo Gordon's avatar
Leo Gordon committed
674
  my $sql = "SELECT sum(done_job_count), sum(failed_job_count), sum(total_job_count), ".
675
            "sum(ready_job_count * analysis_stats.avg_msec_per_job)/1000/60/60 ".
676
            "FROM analysis_stats";
677 678
  my $sth = $self->prepare($sql);
  $sth->execute();
679
  my ($done, $failed, $total, $cpuhrs) = $sth->fetchrow_array();
680
  $sth->finish;
681 682 683 684 685 686 687

  $done   ||= 0;
  $failed ||= 0;
  $total  ||= 0;
  my $completed = $total
    ? ((100.0 * ($done+$failed))/$total)
    : 0.0;
688
  my $remaining = $total - $done - $failed;
689
  warn sprintf("hive %1.3f%% complete (< %1.3f CPU_hrs) (%d todo + %d done + %d failed = %d total)\n",
690
          $completed, $cpuhrs, $remaining, $done, $failed, $total);
Leo Gordon's avatar
Leo Gordon committed
691
  return $remaining;
692 693
}

694

Leo Gordon's avatar
Leo Gordon committed
695
sub print_analysis_status {
Leo Gordon's avatar
Leo Gordon committed
696
    my ($self, $filter_analysis) = @_;
697

Leo Gordon's avatar
Leo Gordon committed
698
    my $list_of_analyses = $filter_analysis ? [$filter_analysis] : $self->db->get_AnalysisAdaptor->fetch_all;
Leo Gordon's avatar
Leo Gordon committed
699
    foreach my $analysis (sort {$a->dbID <=> $b->dbID} @$list_of_analyses) {
700
        print $analysis->stats->toString . "\n";
Leo Gordon's avatar
Leo Gordon committed
701
    }
702 703 704
}


Leo Gordon's avatar
Leo Gordon committed
705
sub print_running_worker_counts {
706
    my $self = shift;
707

708 709 710
    my $sql = qq{
        SELECT logic_name, count(*)
        FROM worker w
711
        JOIN analysis_base a USING(analysis_id)
712
        WHERE w.status!='DEAD'
713
        GROUP BY a.analysis_id
714
    };
Leo Gordon's avatar
Leo Gordon committed
715

716 717 718 719 720 721 722 723 724 725 726
    my $total_workers = 0;
    my $sth = $self->prepare($sql);
    $sth->execute();

    print "\n===== Stats of live Workers according to the Queen: ======\n";
    while((my $logic_name, my $worker_count)=$sth->fetchrow_array()) {
        printf("%30s : %d workers\n", $logic_name, $worker_count);
        $total_workers += $worker_count;
    }
    $sth->finish;
    printf("%30s : %d workers\n\n", '======= TOTAL =======', $total_workers);
727
}
728

729

Leo Gordon's avatar
Leo Gordon committed
730 731 732 733 734 735 736 737 738 739 740 741
=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;

742 743
    my $all_workers_considered_alive = $self->fetch_all( "status!='DEAD'" );
    foreach my $worker (@{$all_workers_considered_alive}) {
744
        $worker->cause_of_death( 'UNKNOWN' );  # well, maybe we could have investigated further...
Leo Gordon's avatar
Leo Gordon committed
745 746 747 748
        $self->register_worker_death($worker);
    }
}

749

Jessica Severin's avatar
Jessica Severin committed
750
1;