Queen.pm 34.4 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 $analysis->stats->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', 'dir_revhash');  # import 'destringify()' and 'dir_revhash()'
68
use Bio::EnsEMBL::Hive::AnalysisJob;
Jessica Severin's avatar
Jessica Severin committed
69
70
use Bio::EnsEMBL::Hive::Worker;

71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
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';
}
87

Jessica Severin's avatar
Jessica Severin committed
88

89
############################
Jessica Severin's avatar
Jessica Severin committed
90
#
91
# PUBLIC API
Jessica Severin's avatar
Jessica Severin committed
92
#
93
############################
Jessica Severin's avatar
Jessica Severin committed
94

95

Jessica Severin's avatar
Jessica Severin committed
96
97
=head2 create_new_worker

98
99
100
101
  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
102
  Returntype : Bio::EnsEMBL::Hive::Worker
103
  Caller     : runWorker.pl
Jessica Severin's avatar
Jessica Severin committed
104
105
106
107

=cut

sub create_new_worker {
108
    my ($self, @args) = @_;
109

110
111
112
113
114
115
116
117
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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
    my ($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, $compile_module_once) =

    rearrange([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 compile_module_once) ], @args);

    if($resource_class_name) {
        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;
    }
    $resource_class_id ||= 1;

    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')
        or die "Could not create a new worker";
    $sth->finish;

    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;

            # Note: the following die-message will not reach the log files for circular reason!
        system("mkdir -p $worker_log_dir") && die "Could not create '$worker_log_dir' because: $!";

        my $sth_add_log = $self->prepare( "UPDATE worker SET log_dir=? WHERE worker_id=?" );
        $sth_add_log->execute($worker_log_dir, $worker_id);
        $sth_add_log->finish;
    }

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

    $worker->init;

    if($job_limit) {
      $worker->job_limit($job_limit);
      $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);

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

    return $worker;
}


=head2 specialize_new_worker
172

173
174
175
176
177
178
179
180
181
182
183
184
  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.
  Returntype : Bio::EnsEMBL::Hive::Worker
  Caller     : runWorker.pl

=cut

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

    my ($analysis_id, $logic_name, $job_id, $force) =
        rearrange([qw(analysis_id logic_name job_id force) ], @args);
185

186
187
    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
188
189
    }

190
191
    my ($job, $analysis, $stats);
    my $analysis_stats_adaptor = $self->db->get_AnalysisStatsAdaptor;
Jessica Severin's avatar
Jessica Severin committed
192

193
    if($job_id or $analysis_id or $logic_name) {    # probably pre-specialized by running a runWorker.pl by hand
194

195
        if($job_id) {
196
197
198
199
            print "resetting and fetching job for job_id '$job_id'\n";

            my $job_adaptor = $self->db->get_AnalysisJobAdaptor;
            $job_adaptor->reset_job_by_dbID($job_id); 
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217

            $job = $job_adaptor->fetch_by_dbID($job_id)
                or die "job with dbID='$job_id' could not be fetched from the database";

            $analysis_id = $job->analysis_id;
        }

        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";
        }

218
219
220
221
        if($worker->resource_class_id != $analysis->resource_class_id) {
            die "resource_class of analysis ".$analysis->logic_name." is incompatible with this Worker's resource_class";
        }

222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
        $stats = $analysis_stats_adaptor->fetch_by_analysis_id($analysis_id);
        $self->safe_synchronize_AnalysisStats($stats);

        unless($job or $force) {    # do we really need to run this analysis?
            if($self->get_hive_current_load() >= 1.1) {
                die "Hive is overloaded, can't create a worker";
            }
            if($stats->status eq 'BLOCKED') {
                die "Analysis is BLOCKED, can't create workers";
            }
            if($stats->num_required_workers <= 0) {
                die "Analysis does not require workers at the moment";
            }
            if($stats->status eq 'DONE') {
                die "Analysis is DONE, don't need to create workers";
237
238
            }
        }
239

240
    } else {    # probably scheduled by beekeeper.pl
241

242
        $stats = $self->suggest_analysis_to_specialize_by_rc_id($worker->resource_class_id)
243
            or die "Scheduler failed to pick an analysis for the worker";
244

245
        print "Scheduler picked analysis with dbID=".$stats->analysis_id." for the worker\n";
246
247

        $analysis_id = $stats->analysis_id;
248
    }
249

250
        # now set it in the $worker:
Jessica Severin's avatar
Jessica Severin committed
251

252
    $worker->analysis_id( $analysis_id );
Jessica Severin's avatar
Jessica Severin committed
253

254
255
256
257
    if($job) {
        $worker->_specific_job($job);
    } else {    # count it as autonomous worker sharing the load of that analysis:
        $analysis_stats_adaptor->decrease_required_workers($worker->analysis_id);
258
259
260
261
262
263
264
265
266
    }

        # 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() ) {
267
        $analysis_stats_adaptor->increase_running_workers($worker->analysis_id);
268
269
    }

270
271
272
    my $sth_update_analysis_id = $self->prepare( "UPDATE worker SET analysis_id=? WHERE worker_id=?" );
    $sth_update_analysis_id->execute($worker->analysis_id, $worker->dbID);
    $sth_update_analysis_id->finish;
273

274
    $stats->update_status('WORKING');
275

276
    return $worker;
Jessica Severin's avatar
Jessica Severin committed
277
278
}

279

Jessica Severin's avatar
Jessica Severin committed
280
281
282
283
sub register_worker_death {
  my ($self, $worker) = @_;

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

285
  my $cod = $worker->cause_of_death() || 'UNKNOWN';    # make sure we do not attempt to insert a void
Leo Gordon's avatar
bugfix  
Leo Gordon committed
286

287
  my $sql = "UPDATE worker SET died=CURRENT_TIMESTAMP, last_check_in=CURRENT_TIMESTAMP";
288
  $sql .= " ,status='DEAD'";
Jessica Severin's avatar
Jessica Severin committed
289
  $sql .= " ,work_done='" . $worker->work_done . "'";
Leo Gordon's avatar
bugfix  
Leo Gordon committed
290
  $sql .= " ,cause_of_death='$cod'";
291
  $sql .= " WHERE worker_id='" . $worker->dbID ."'";
Jessica Severin's avatar
Jessica Severin committed
292

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

295
  unless( $self->db->hive_use_triggers() ) {
296
      $worker->analysis->stats->adaptor->decrease_running_workers($worker->analysis_id);
297
298
  }

Leo Gordon's avatar
bugfix  
Leo Gordon committed
299
  if($cod eq 'NO_WORK') {
300
    $self->db->get_AnalysisStatsAdaptor->update_status($worker->analysis->dbID, 'ALL_CLAIMED');
301
  }
302
  if($cod eq 'UNKNOWN'
Leo Gordon's avatar
bugfix  
Leo Gordon committed
303
304
305
  or $cod eq 'MEMLIMIT'
  or $cod eq 'RUNLIMIT'
  or $cod eq 'KILLED_BY_USER') {
Leo Gordon's avatar
Leo Gordon committed
306
    $self->db->get_AnalysisJobAdaptor->release_undone_jobs_from_worker($worker);
307
  }
308
  
309
  # re-sync the analysis_stats when a worker dies as part of dynamic sync system
310
  if($self->safe_synchronize_AnalysisStats($worker->analysis->stats)->status ne 'DONE') {
311
312
    # 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
313
    $self->db->get_AnalysisStatsAdaptor->increase_required_workers($worker->analysis->dbID);
314
315
  }

Jessica Severin's avatar
Jessica Severin committed
316
317
}

318

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

322
    warn "GarbageCollector:\tChecking for lost Workers...\n";
323

324
325
326
327
    my $queen_worker_list           = $self->fetch_overdue_workers(0);
    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
328

329
    warn "GarbageCollector:\t[Queen:] we have ".scalar(@$queen_worker_list)." Workers alive.\n";
330

Leo Gordon's avatar
Leo Gordon committed
331
332
    foreach my $worker (@$queen_worker_list) {

333
334
335
        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
336
        } else {
337
            $worker_status_counts{$meadow_type}{'UNREACHABLE'}++;
338

339
            next;   # Worker is unreachable from this Valley
Leo Gordon's avatar
Leo Gordon committed
340
341
        }

342
343
344
345
346
        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'}++;
347

348
            $mt_and_pid_to_lost_worker{$meadow_type}{$process_id} = $worker;
349
        }
350
351
352
353
354
355
    }

        # 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";
    }
356

357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
    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) {
374
                $worker->cause_of_death( $wpid_to_cod->{$process_id} || 'UNKNOWN');
375
376
                $self->register_worker_death($worker);
            }
377
378
379
        }
    }

380
        # the following bit is completely Meadow-agnostic and only restores database integrity:
Leo Gordon's avatar
Leo Gordon committed
381
    if($check_buried_in_haste) {
382
        warn "GarbageCollector:\tChecking for Workers buried in haste...\n";
383
        my $buried_in_haste_list = $self->fetch_all_dead_workers_with_jobs();
Leo Gordon's avatar
Leo Gordon committed
384
        if(my $bih_number = scalar(@$buried_in_haste_list)) {
385
            warn "GarbageCollector:\tfound $bih_number jobs, reclaiming.\n\n";
Leo Gordon's avatar
Leo Gordon committed
386
387
388
            if($bih_number) {
                my $job_adaptor = $self->db->get_AnalysisJobAdaptor();
                foreach my $worker (@$buried_in_haste_list) {
Leo Gordon's avatar
Leo Gordon committed
389
                    $job_adaptor->release_undone_jobs_from_worker($worker);
Leo Gordon's avatar
Leo Gordon committed
390
391
392
                }
            }
        } else {
393
            warn "GarbageCollector:\tfound none\n";
Leo Gordon's avatar
Leo Gordon committed
394
395
396
        }
    }
}
Jessica Severin's avatar
Jessica Severin committed
397
398


399
400
401
    # 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
402

403
    $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
404
405
406
}


407
=head2 reset_job_by_dbID_and_sync
408

409
  Arg [1]: int $job_id
410
  Example: 
411
    my $job = $queen->reset_job_by_dbID_and_sync($job_id);
412
  Description: 
413
    For the specified job_id it will fetch just that job, 
414
415
416
    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 
417
    same job simultaneously (use only for debugging).
418
  Returntype : none
419
  Exceptions :
420
  Caller     : beekeeper.pl
421
422
423

=cut

424
425
sub reset_job_by_dbID_and_sync {
    my ($self, $job_id) = @_;
426

427
428
429
430
431
432
    my $job_adaptor = $self->db->get_AnalysisJobAdaptor;
    $job_adaptor->reset_job_by_dbID($job_id); 

    my $job = $job_adaptor->fetch_by_dbID($job_id); 
    my $stats = $self->db->get_AnalysisStatsAdaptor->fetch_by_analysis_id($job->analysis_id);
    $self->synchronize_AnalysisStats($stats);
433
434
435
}


436
437
438
439
440
441
######################################
#
# Public API interface for beekeeper
#
######################################

442

443
444
445
    # Note: asking for Queen->fetch_overdue_workers(0) essentially means
    #       "fetch all workers known to the Queen not to be officially dead"
    #
446
sub fetch_overdue_workers {
447
    my ($self,$overdue_secs) = @_;
448

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

451
    my $constraint = "status!='DEAD' AND ".
452
                    ( ($self->dbc->driver eq 'sqlite')
453
454
455
                        ? "(strftime('%s','now')-strftime('%s',last_check_in))>$overdue_secs"
                        : "(UNIX_TIMESTAMP()-UNIX_TIMESTAMP(last_check_in))>$overdue_secs");
    return $self->fetch_all( $constraint );
456
457
}

458
459
460

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

462
    return $self->fetch_all( "JOIN job j USING(worker_id) WHERE j.status NOT IN ('DONE', 'READY', 'FAILED', 'PASSED_ON') GROUP BY worker_id" );
Leo Gordon's avatar
Leo Gordon committed
463
}
Jessica Severin's avatar
Jessica Severin committed
464

465

466
467
=head2 synchronize_hive

Leo Gordon's avatar
Leo Gordon committed
468
  Arg [1]    : $filter_analysis (optional)
469
470
  Example    : $queen->synchronize_hive();
  Description: Runs through all analyses in the system and synchronizes
471
472
              the analysis_stats summary with the states in the job 
              and worker tables.  Then follows by checking all the blocking rules
473
474
475
476
477
478
479
              and blocks/unblocks analyses as needed.
  Exceptions : none
  Caller     : general

=cut

sub synchronize_hive {
Leo Gordon's avatar
Leo Gordon committed
480
  my $self          = shift;
Leo Gordon's avatar
Leo Gordon committed
481
  my $filter_analysis = shift; # optional parameter
482

483
  my $start_time = time();
484

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

Leo Gordon's avatar
Leo Gordon committed
487
  print STDERR "\nSynchronizing the hive (".scalar(@$list_of_analyses)." analyses this time):\n";
Leo Gordon's avatar
Leo Gordon committed
488
489
  foreach my $analysis (@$list_of_analyses) {
    $self->synchronize_AnalysisStats($analysis->stats);
490
    print STDERR ( ($analysis->stats()->status eq 'BLOCKED') ? 'x' : 'o');
491
  }
Leo Gordon's avatar
Leo Gordon committed
492
  print STDERR "\n";
Leo Gordon's avatar
Leo Gordon committed
493

Leo Gordon's avatar
Leo Gordon committed
494
  print STDERR ''.((time() - $start_time))." seconds to synchronize_hive\n\n";
495
}
496

497

498
499
500
=head2 safe_synchronize_AnalysisStats

  Arg [1]    : Bio::EnsEMBL::Hive::AnalysisStats object
501
  Example    : $self->safe_synchronize_AnalysisStats($stats);
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
  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->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
519
                   ($stats->seconds_since_last_update < 3*60));
520
521
522
523

  # 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;
524
  #print("$sql\n");
525
  my $row_count = $self->dbc->do($sql);  
526
  return $stats unless($row_count == 1);        # return the un-updated status if locked
527
  #printf("got sync_lock on analysis_stats(%d)\n", $stats->analysis_id);
528
  
529
      # since we managed to obtain the lock, let's go and perform the sync:
530
  $self->synchronize_AnalysisStats($stats);
531

532
533
534
535
  return $stats;
}


536
=head2 synchronize_AnalysisStats
537

538
539
  Arg [1]    : Bio::EnsEMBL::Hive::AnalysisStats object
  Example    : $self->synchronize($analysisStats);
540
  Description: Queries the job and worker tables to get summary counts
541
542
543
544
545
               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
546

547
=cut
548

549
sub synchronize_AnalysisStats {
550
  my $self = shift;
551
  my $analysisStats = shift;
552

553
  return $analysisStats unless($analysisStats);
554
  return $analysisStats unless($analysisStats->analysis_id);
555

556
  $analysisStats->refresh(); ## Need to get the new hive_capacity for dynamic analyses
557
558
  my $hive_capacity = $analysisStats->hive_capacity;

559
560
  if($self->db->hive_use_triggers()) {

561
562
            my $job_count = $analysisStats->ready_job_count();
            my $required_workers = $hive_capacity && POSIX::ceil( $job_count / $analysisStats->get_or_estimate_batch_size() );
563

564
565
                # adjust_stats_for_living_workers:
            if($hive_capacity > 0) {
566
                my $unfulfilled_capacity = $hive_capacity - $analysisStats->num_running_workers();
567

568
569
                if($unfulfilled_capacity < $required_workers ) {
                    $required_workers = (0 < $unfulfilled_capacity) ? $unfulfilled_capacity : 0;
570
571
572
573
574
575
                }
            }
            $analysisStats->num_required_workers( $required_workers );

  } else {
      $analysisStats->total_job_count(0);
576
577
      $analysisStats->semaphored_job_count(0);
      $analysisStats->ready_job_count(0);
578
579
580
      $analysisStats->done_job_count(0);
      $analysisStats->failed_job_count(0);
      $analysisStats->num_required_workers(0);
581

582
            # ask for analysis_id to force MySQL to use existing index on (analysis_id, status)
583
      my $sql = "SELECT analysis_id, status, count(*) FROM job WHERE analysis_id=? GROUP BY analysis_id, status";
584
585
      my $sth = $self->prepare($sql);
      $sth->execute($analysisStats->analysis_id);
586

587
588
589
      my $done_here       = 0;
      my $done_elsewhere  = 0;
      my $total_job_count = 0;
590
      while (my ($dummy_analysis_id, $status, $job_count)=$sth->fetchrow_array()) {
591
    # print STDERR "$status: $job_count\n";
592

593
        $total_job_count += $job_count;
594

595
        if($status eq 'READY') {
596
            $analysisStats->ready_job_count($job_count);
597

598
            my $required_workers = $hive_capacity && POSIX::ceil( $job_count / $analysisStats->get_or_estimate_batch_size() );
599
600
601

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

604
605
                if($unfulfilled_capacity < $required_workers ) {
                    $required_workers = (0 < $unfulfilled_capacity) ? $unfulfilled_capacity : 0;
606
                }
607
            }
608
609
            $analysisStats->num_required_workers( $required_workers );

610
611
        } elsif($status eq 'SEMAPHORED') {
            $analysisStats->semaphored_job_count($job_count);
612
        } elsif($status eq 'DONE') {
613
            $done_here = $job_count;
614
        } elsif($status eq 'PASSED_ON') {
615
616
617
            $done_elsewhere = $job_count;
        } elsif ($status eq 'FAILED') {
            $analysisStats->failed_job_count($job_count);
618
        }
619
      } # /while
620
      $sth->finish;
621

622
623
      $analysisStats->total_job_count( $total_job_count );
      $analysisStats->done_job_count( $done_here + $done_elsewhere );
624
  } # /unless $self->{'_hive_use_triggers'}
625

626
  $analysisStats->check_blocking_control_rules();
627

628
629
630
  if($analysisStats->status ne 'BLOCKED') {
    $analysisStats->determine_status();
  }
631

632
  # $analysisStats->sync_lock(0); ## do we perhaps need it here?
633
  $analysisStats->update;  #update and release sync_lock
634

635
  return $analysisStats;
636
}
637
638


639
640
641
642
643
644
645
646
647
648
649
650
651
652
=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
653
sub get_num_failed_analyses {
654
    my ($self, $filter_analysis) = @_;
655

656
657
658
659
660
661
662
663
664
665
666
667
    my $failed_analyses = $self->db->get_AnalysisAdaptor->fetch_all_failed_analyses();

    my $filter_analysis_failed = 0;

    foreach my $failed_analysis (@$failed_analyses) {
        print "\t##########################################################\n";
        print "\t# Too many jobs in analysis '".$failed_analysis->logic_name."' FAILED #\n";
        print "\t##########################################################\n\n";
        if($filter_analysis and ($filter_analysis->dbID == $failed_analysis)) {
            $filter_analysis_failed = 1;
        }
    }
668

669
    return $filter_analysis ? $filter_analysis_failed : scalar(@$failed_analyses);
670
671
672
}


673
sub get_hive_current_load {
674
675
676
    my $self = shift;
    my $sql = qq{
        SELECT sum(1/hive_capacity)
677
678
679
680
        FROM worker w
        JOIN analysis_stats USING(analysis_id)
        WHERE w.status!='DEAD'
        AND hive_capacity>0
681
682
683
684
685
686
    };
    my $sth = $self->prepare($sql);
    $sth->execute();
    my ($load)=$sth->fetchrow_array();
    $sth->finish;
    return ($load || 0);
687
688
689
}


690
691
692
sub count_running_workers {
    my ($self, $analysis_id) = @_;

693
694
695
696
697
    my $sql = qq{
            SELECT count(*)
            FROM worker
            WHERE status!='DEAD'
        } . ($analysis_id ? " AND analysis_id='$analysis_id'" : '');
698
699
700
701
702
703
704

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

    return $running_workers_count || 0;
705
706
}

707

708
=head2 schedule_workers
709

710
  Arg[1]     : Bio::EnsEMBL::Hive::Analysis object (optional)
711
  Example    : $count = $queen->schedule_workers();
712
713
714
  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
715
               If Arg[1] is defined, does it only for the given analysis.
716
  Exceptions : none
717
  Caller     : beekeepers and other external processes
718
719
720

=cut

721
sub schedule_workers {
722
  my ($self, $filter_analysis, $orig_pending_by_rc_name, $available_submit_limit) = @_;
723

724
725
726
  my @suitable_analyses         = $filter_analysis
                                    ? ( $filter_analysis->stats )
                                    : @{ $self->db->get_AnalysisStatsAdaptor->fetch_all_by_suitability_rc_id() };
727

728
729
730
731
  my $analysis_id2rc_id         = $self->db->get_AnalysisAdaptor->fetch_HASHED_FROM_analysis_id_TO_resource_class_id();
  my $rc_id2name                = $self->db->get_ResourceClassAdaptor->fetch_HASHED_FROM_resource_class_id_TO_name();
        # combined mapping
  my %analysis_id2rc_name       = map { $_ => $rc_id2name->{ $analysis_id2rc_id->{ $_ }} } keys %$analysis_id2rc_id;
732

733
  return {} unless(@suitable_analyses);
734

735
  my %pending_by_rc_name        = %{ $orig_pending_by_rc_name || {} };  # NB: make our own copy to be able to modify it
736
  my $total_workers_to_run      = 0;
737
  my %workers_to_run_by_rc_name = ();
738
  my $available_load            = 1.0 - $self->get_hive_current_load();
739

740

741
  foreach my $analysis_stats (@suitable_analyses) {
742
743
    last if ($available_load <= 0.0);
    last if (defined($available_submit_limit) and !$available_submit_limit);
744

Leo Gordon's avatar
Leo Gordon committed
745
        #digging deeper under the surface so need to sync
746
    if(($analysis_stats->status eq 'LOADING') or ($analysis_stats->status eq 'BLOCKED') or ($analysis_stats->status eq 'ALL_CLAIMED')) {
747
748
749
750
751
752
      $self->synchronize_AnalysisStats($analysis_stats);
    }

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

753
        # 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
754
    my $workers_this_analysis = $analysis_stats->num_required_workers;
755

756
757
758
759
760
761
    if(defined($available_submit_limit)) {                              # submit_limit total capping, if available
        if($workers_this_analysis > $available_submit_limit) {
            $workers_this_analysis = $available_submit_limit;
        }
        $available_submit_limit -= $workers_this_analysis;
    }
Leo Gordon's avatar
Leo Gordon committed
762

763
764
765
766
767
    if((my $hive_capacity = $analysis_stats->hive_capacity) > 0) {      # per-analysis hive_capacity capping, if available
        my $remaining_capacity_for_this_analysis = int($available_load * $hive_capacity);

        if($workers_this_analysis > $remaining_capacity_for_this_analysis) {
            $workers_this_analysis = $remaining_capacity_for_this_analysis;
Leo Gordon's avatar
Leo Gordon committed
768
769
        }

770
        $available_load -= 1.0*$workers_this_analysis/$hive_capacity;
771
    }
Leo Gordon's avatar
Leo Gordon committed
772

773
    my $curr_rc_name    = $analysis_id2rc_name{ $analysis_stats->analysis_id };
774

775
776
777
778
779
780
    if($pending_by_rc_name{ $curr_rc_name }) {                              # per-rc_name capping by pending processes, if available
        my $pending_this_analysis = ($pending_by_rc_name{ $curr_rc_name } < $workers_this_analysis) ? $pending_by_rc_name{ $curr_rc_name } : $workers_this_analysis;

        print "Scheduler detected $pending_this_analysis pending workers with resource_class_name=$curr_rc_name\n";
        $workers_this_analysis                  -= $pending_this_analysis;
        $pending_by_rc_name{ $curr_rc_name }    -= $pending_this_analysis;
781
782
    }

783
784
    next unless($workers_this_analysis);    # do not autovivify the hash by a zero

785
    $total_workers_to_run += $workers_this_analysis;
786
    $workers_to_run_by_rc_name{ $curr_rc_name } += $workers_this_analysis;
787
    $analysis_stats->print_stats();
788
    printf("Scheduler suggests adding %d more workers of resource_class_name=%s for analysis_id=%d [%1.3f hive_load remaining]\n", $workers_this_analysis, $curr_rc_name, $analysis_stats->analysis_id, $available_load);
789
  }
790

791
  printf("Scheduler suggests adding a total of %d workers [%1.5f hive_load remaining]\n", $total_workers_to_run, $available_load);
792
  return \%workers_to_run_by_rc_name;
Leo Gordon's avatar
Leo Gordon committed
793
794
}

795

796
sub schedule_workers_resync_if_necessary {
797
798
799
    my ($self, $valley, $analysis) = @_;

    my $meadow              = $valley->get_current_meadow();
Leo Gordon's avatar
Leo Gordon committed
800

801
    my $pending_by_rc_name  = ($meadow->can('count_pending_workers_by_rc_name') and $meadow->config_get('PendingAdjust')) ? $meadow->count_pending_workers_by_rc_name() : {};
802
803
    my $submit_limit        = $meadow->config_get('SubmitWorkersMax');
    my $meadow_limit        = ($meadow->can('count_running_workers') and defined($meadow->config_get('TotalRunningWorkersMax'))) ? $meadow->config_get('TotalRunningWorkersMax') - $meadow->count_running_workers : undef;
Leo Gordon's avatar
Leo Gordon committed
804

805
806
807
808
    my $available_submit_limit = ($submit_limit and $meadow_limit)
                                    ? (($submit_limit<$meadow_limit) ? $submit_limit : $meadow_limit)
                                    : (defined($submit_limit) ? $submit_limit : $meadow_limit);

809
    my $workers_to_run_by_rc_name = $self->schedule_workers($analysis, $pending_by_rc_name, $available_submit_limit);
810

811
    unless( keys %$workers_to_run_by_rc_name or $self->get_hive_current_load() or $self->count_running_workers() ) {
812
        print "\nScheduler: nothing is running and nothing to do (according to analysis_stats) => executing garbage collection and sync\n" ;
Leo Gordon's avatar
Leo Gordon committed
813

814
        $self->check_for_dead_workers($valley, 1);
815
        $self->synchronize_hive($analysis);
Leo Gordon's avatar
Leo Gordon committed
816

817
        $workers_to_run_by_rc_name = $self->schedule_workers($analysis, $pending_by_rc_name, $available_submit_limit);
Leo Gordon's avatar
Leo Gordon committed
818
819
    }

820
    return $workers_to_run_by_rc_name;
821
822
}

823

Leo Gordon's avatar
Leo Gordon committed
824
sub get_remaining_jobs_show_hive_progress {
825
  my $self = shift;
Leo Gordon's avatar
Leo Gordon committed
826
  my $sql = "SELECT sum(done_job_count), sum(failed_job_count), sum(total_job_count), ".
827
            "sum(ready_job_count * analysis_stats.avg_msec_per_job)/1000/60/60 ".
828
            "FROM analysis_stats";
829
830
  my $sth = $self->prepare($sql);
  $sth->execute();
831
  my ($done, $failed, $total, $cpuhrs) = $sth->fetchrow_array();
832
  $sth->finish;
833
834
835
836
837
838
839

  $done   ||= 0;
  $failed ||= 0;
  $total  ||= 0;
  my $completed = $total
    ? ((100.0 * ($done+$failed))/$total)
    : 0.0;
840
841
842
  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
843
  return $remaining;
844
845
}

846

Leo Gordon's avatar
Leo Gordon committed
847
sub print_analysis_status {
Leo Gordon's avatar
Leo Gordon committed
848
    my ($self, $filter_analysis) = @_;
849

Leo Gordon's avatar
Leo Gordon committed
850
    my $list_of_analyses = $filter_analysis ? [$filter_analysis] : $self->db->get_AnalysisAdaptor->fetch_all;
Leo Gordon's avatar
Leo Gordon committed
851
    foreach my $analysis (sort {$a->dbID <=> $b->dbID} @$list_of_analyses) {
852
        $analysis->stats->print_stats();
Leo Gordon's avatar
Leo Gordon committed
853
    }
854
855
856
}


Leo Gordon's avatar
Leo Gordon committed
857
sub print_running_worker_counts {
858
    my $self = shift;
859

860
861
862
863
864
865
866
    my $sql = qq{
        SELECT logic_name, count(*)
        FROM worker w
        JOIN analysis_base USING(analysis_id)
        WHERE w.status!='DEAD'
        GROUP BY analysis_id
    };
Leo Gordon's avatar
Leo Gordon committed
867

868
869
870
871
872
873
874
875
876
877
878
    my $total_workers = 0;
    my