Queen.pm 34.2 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
    return undef if($self->get_hive_current_load() >= 1.1);
168
    
169
170
    $analysis_stats_adaptor->decrease_needed_workers($analysisStats->analysis_id);
    $analysis_stats_adaptor->increase_running_workers($analysisStats->analysis_id);
171
172
173
174
175
176
177
178
179
180
    $analysisStats->print_stats;
    
    if($analysisStats->status eq 'BLOCKED') {
      print("Analysis is BLOCKED, can't create workers\n");
      return undef;
    }
    if($analysisStats->status eq 'DONE') {
      print("Analysis is DONE, don't need to create workers\n");
      return undef;
    }
181
  }
182
  
183
184
  my $sql = q{INSERT INTO worker 
              (born, last_check_in, meadow_type, process_id, host, analysis_id)
185
              VALUES (CURRENT_TIMESTAMP, CURRENT_TIMESTAMP, ?,?,?,?)};
Jessica Severin's avatar
Jessica Severin committed
186
187

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

192
  my $worker = $self->fetch_by_dbID($worker_id);
Jessica Severin's avatar
Jessica Severin committed
193
194
  $worker=undef unless($worker and $worker->analysis);

195
  if($worker and $analysisStats) {
196
    $analysisStats->update_status('WORKING');
Jessica Severin's avatar
Jessica Severin committed
197
  }
198
  
199
  $worker->_specific_job($job) if($job);
200
  $worker->execute_writes(0) if($no_write);
201
202
203
204
205
206
207
208
209
210
211
212
213

    $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) {
214
        $worker->batch_size($batch_size);
215
216
217
218
    }
    if($job_limit) {
      $worker->job_limit($job_limit);
      $worker->life_span(0);
219
220
221
      if($job_limit < $worker->batch_size()) {
        $worker->batch_size( $job_limit );
      }
222
223
224
225
226
227
228
229
230
231
232
    }
    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
233
234
235
236
237
238
239
  return $worker;
}

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

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

Leo Gordon's avatar
bugfix  
Leo Gordon committed
241
242
243
  my $cod = $worker->cause_of_death();

  unless ($cod eq 'HIVE_OVERLOAD') {
244
245
246
247
    ## HIVE_OVERLOAD occurs after a successful update of the analysis_stats teble. (c.f. Worker.pm)
    $worker->analysis->stats->adaptor->decrease_running_workers($worker->analysis->stats->analysis_id);
  }

248
  my $sql = "UPDATE worker SET died=CURRENT_TIMESTAMP, last_check_in=CURRENT_TIMESTAMP";
249
  $sql .= " ,status='DEAD'";
Jessica Severin's avatar
Jessica Severin committed
250
  $sql .= " ,work_done='" . $worker->work_done . "'";
Leo Gordon's avatar
bugfix  
Leo Gordon committed
251
  $sql .= " ,cause_of_death='$cod'";
252
  $sql .= " WHERE worker_id='" . $worker->dbID ."'";
Jessica Severin's avatar
Jessica Severin committed
253

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

Leo Gordon's avatar
bugfix  
Leo Gordon committed
256
  if($cod eq 'NO_WORK') {
257
    $self->db->get_AnalysisStatsAdaptor->update_status($worker->analysis->dbID, 'ALL_CLAIMED');
258
  }
Leo Gordon's avatar
bugfix  
Leo Gordon committed
259
260
261
262
  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
263
    $self->db->get_AnalysisJobAdaptor->release_undone_jobs_from_worker($worker);
264
  }
265
  
266
  # re-sync the analysis_stats when a worker dies as part of dynamic sync system
267
  if($self->safe_synchronize_AnalysisStats($worker->analysis->stats)->status ne 'DONE') {
268
269
    # 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
270
    $self->db->get_AnalysisStatsAdaptor->increase_needed_workers($worker->analysis->dbID);
271
272
  }

Jessica Severin's avatar
Jessica Severin committed
273
274
}

275
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
276
277
    my ($self, $meadow, $check_buried_in_haste) = @_;

278
    my $worker_status_hash    = $meadow->status_of_all_our_workers();
Leo Gordon's avatar
Leo Gordon committed
279
    my %worker_status_summary = ();
280
    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
281
282
283

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

284
285
    my %gc_wpid_to_worker = ();

Leo Gordon's avatar
Leo Gordon committed
286
287
288
    foreach my $worker (@$queen_worker_list) {
        next unless($meadow->responsible_for_worker($worker));

289
290
        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
291
292
293
            $worker_status_summary{$status}++;
        } else {
            $worker_status_summary{'AWOL'}++;
294

295
            $gc_wpid_to_worker{$process_id} = $worker;
Leo Gordon's avatar
Leo Gordon committed
296
297
298
299
        }
    }
    print "\t".join(', ', map { "$_:$worker_status_summary{$_}" } keys %worker_status_summary)."\n\n";

300
301
302
303
304
305
306
307
308
309
310
    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";
311
312
        while(my ($process_id, $worker) = each %gc_wpid_to_worker) {
            $worker->cause_of_death( $wpid_to_cod->{$process_id} || 'FATALITY');
313
314
315
316
            $self->register_worker_death($worker);
        }
    }

Leo Gordon's avatar
Leo Gordon committed
317
318
    if($check_buried_in_haste) {
        print "====== Checking for workers buried in haste... ";
319
        my $buried_in_haste_list = $self->fetch_all_dead_workers_with_jobs();
Leo Gordon's avatar
Leo Gordon committed
320
321
322
323
324
        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
325
                    $job_adaptor->release_undone_jobs_from_worker($worker);
Leo Gordon's avatar
Leo Gordon committed
326
327
328
329
330
331
332
                }
            }
        } else {
            print "none\n";
        }
    }
}
Jessica Severin's avatar
Jessica Severin committed
333

334
sub worker_check_in {
Jessica Severin's avatar
Jessica Severin committed
335
336
337
  my ($self, $worker) = @_;

  return unless($worker);
338
  my $sql = "UPDATE worker SET last_check_in=CURRENT_TIMESTAMP";
339
  $sql .= " ,work_done='" . $worker->work_done . "'";
340
  $sql .= " WHERE worker_id='" . $worker->dbID ."'";
Jessica Severin's avatar
Jessica Severin committed
341
342
343
344

  my $sth = $self->prepare($sql);
  $sth->execute();
  $sth->finish;
345
  
346
  $self->safe_synchronize_AnalysisStats($worker->analysis->stats);
Jessica Severin's avatar
Jessica Severin committed
347
348
349
}


350
=head2 reset_and_fetch_job_by_dbID
351

352
  Arg [1]: int $job_id
353
  Example: 
354
    my $job = $queen->reset_and_fetch_job_by_dbID($job_id);
355
  Description: 
356
    For the specified job_id it will fetch just that job, 
357
358
359
    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 
360
361
    same job simultaneously (use only for debugging).
  Returntype : 
362
    Bio::EnsEMBL::Hive::AnalysisJob object
363
  Exceptions :
364
  Caller     : beekeepers, runWorker.pl scripts
365
366
367

=cut

368
369
sub reset_and_fetch_job_by_dbID {
  my $self = shift;
370
  my $job_id = shift;
371
  
372
  my $jobDBA = $self->db->get_AnalysisJobAdaptor;
373
  $jobDBA->reset_job_by_dbID($job_id); 
374

375
  my $job = $jobDBA->fetch_by_dbID($job_id); 
376
377
  my $stats = $self->db->get_AnalysisStatsAdaptor->fetch_by_analysis_id($job->analysis_id);
  $self->synchronize_AnalysisStats($stats);
378
  
379
380
381
382
  return $job;
}


383
384
385
386
387
388
######################################
#
# Public API interface for beekeeper
#
######################################

389
390
391
    # Note: asking for Queen->fetch_overdue_workers(0) essentially means
    #       "fetch all workers known to the Queen not to be officially dead"
    #
392
393
394
395
396
sub fetch_overdue_workers {
  my ($self,$overdue_secs) = @_;

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

397
398
399
400
  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");
401
402
403
  return $self->_generic_fetch($constraint);
}

404
405
sub fetch_failed_workers {
  my $self = shift;
Leo Gordon's avatar
Leo Gordon committed
406

407
  my $constraint = "w.cause_of_death='FATALITY' ";
408
409
410
  return $self->_generic_fetch($constraint);
}

411
sub fetch_all_dead_workers_with_jobs {
Leo Gordon's avatar
Leo Gordon committed
412
413
  my $self = shift;

414
  # 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
415

416
417
  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
418
419
  return $self->_generic_fetch($constraint, $join);
}
Jessica Severin's avatar
Jessica Severin committed
420

421
422
=head2 synchronize_hive

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

=cut

sub synchronize_hive {
Leo Gordon's avatar
Leo Gordon committed
435
  my $self          = shift;
Leo Gordon's avatar
Leo Gordon committed
436
  my $filter_analysis = shift; # optional parameter
437

438
  my $start_time = time();
439

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

Leo Gordon's avatar
Leo Gordon committed
442
  print STDERR "\nSynchronizing the hive (".scalar(@$list_of_analyses)." analyses this time):\n";
Leo Gordon's avatar
Leo Gordon committed
443
444
  foreach my $analysis (@$list_of_analyses) {
    $self->synchronize_AnalysisStats($analysis->stats);
Leo Gordon's avatar
Leo Gordon committed
445
    print STDERR '.';
446
  }
Leo Gordon's avatar
Leo Gordon committed
447
  print STDERR "\n";
Leo Gordon's avatar
Leo Gordon committed
448

Leo Gordon's avatar
Leo Gordon committed
449
  print STDERR "Checking blocking control rules:\n";
Leo Gordon's avatar
Leo Gordon committed
450
  foreach my $analysis (@$list_of_analyses) {
Leo Gordon's avatar
Leo Gordon committed
451
452
    my $open = $analysis->stats->check_blocking_control_rules();
    print STDERR ($open ? 'o' : 'x');
453
  }
Leo Gordon's avatar
Leo Gordon committed
454
  print STDERR "\n";
Leo Gordon's avatar
Leo Gordon committed
455

Leo Gordon's avatar
Leo Gordon committed
456
  print STDERR ''.((time() - $start_time))." seconds to synchronize_hive\n\n";
457
}
458

459

460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
=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
482
                   ($stats->seconds_since_last_update < 3*60));
483
484
485
486

  # 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;
487
  #print("$sql\n");
488
489
  my $row_count = $self->dbc->do($sql);  
  return $stats unless($row_count == 1);
490
  #printf("got sync_lock on analysis_stats(%d)\n", $stats->analysis_id);
491
492
493
  
  #OK have the lock, go and do the sync
  $self->synchronize_AnalysisStats($stats);
494

495
496
497
498
  return $stats;
}


499
=head2 synchronize_AnalysisStats
500

501
502
  Arg [1]    : Bio::EnsEMBL::Hive::AnalysisStats object
  Example    : $self->synchronize($analysisStats);
503
  Description: Queries the job and worker tables to get summary counts
504
505
506
507
508
               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
509

510
=cut
511

512
sub synchronize_AnalysisStats {
513
  my $self = shift;
514
  my $analysisStats = shift;
515

516
  return $analysisStats unless($analysisStats);
517
  return $analysisStats unless($analysisStats->analysis_id);
518
519

  my $analysis_stats_adaptor = $self->db->get_AnalysisStatsAdaptor or return undef;
520

521
  $analysisStats->refresh(); ## Need to get the new hive_capacity for dynamic analyses
522
523
  my $hive_capacity = $analysisStats->hive_capacity;

524
525
526
527
  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() );
528

529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
                # adjust_stats_for_living_workers:
            if($hive_capacity > 0) {
                my $capacity_allows_to_add = $hive_capacity - $analysis_stats_adaptor->get_running_worker_count($analysisStats);

                if($capacity_allows_to_add < $required_workers ) {
                    $required_workers = (0 < $capacity_allows_to_add) ? $capacity_allows_to_add : 0;
                }
            }
            $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);
545

546
547
548
549
      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);
550
551


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

557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
        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) {
                my $capacity_allows_to_add = $hive_capacity - $analysis_stats_adaptor->get_running_worker_count($analysisStats);

                if($capacity_allows_to_add < $required_workers ) {
                    $required_workers = (0 < $capacity_allows_to_add) ? $capacity_allows_to_add : 0;
                }
572
            }
573
574
575
576
577
578
579
580
            $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);
581
        }
582
583
      }
      $sth->finish;
584

585
586
      $analysisStats->done_job_count($done_here + $done_elsewhere);
  } # /unless $self->{'_hive_use_triggers'}
587

588
  $analysisStats->check_blocking_control_rules();
589

590
591
592
  if($analysisStats->status ne 'BLOCKED') {
    $analysisStats->determine_status();
  }
593

594
  $analysisStats->update;  #update and release sync_lock
595

596
  return $analysisStats;
597
}
598
599


Leo Gordon's avatar
Leo Gordon committed
600
601
sub get_num_failed_analyses {
  my ($self, $analysis) = @_;
602
603

  my $statsDBA = $self->db->get_AnalysisStatsAdaptor;
Leo Gordon's avatar
Leo Gordon committed
604
  my $failed_analyses = $statsDBA->fetch_by_statuses(['FAILED']);
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
  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);
}


627
628
sub get_hive_current_load {
  my $self = shift;
629
630
631
  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";
632
633
634
635
636
  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
637
  print("current hive load = $load\n");
638
639
640
641
  return $load;
}


642
643
sub get_num_running_workers {
  my $self = shift;
644
  my $sql = "SELECT count(*) FROM worker WHERE cause_of_death =''";
645
646
647
648
649
  my $sth = $self->prepare($sql);
  $sth->execute();
  (my $runningCount)=$sth->fetchrow_array();
  $sth->finish;
  $runningCount=0 unless($runningCount);
Leo Gordon's avatar
Leo Gordon committed
650
  print("current hive num_running_workers = $runningCount\n");
651
652
653
  return $runningCount;
}

654
655
656
sub enter_status {
  my ($self, $worker, $status) = @_;

657
  $self->dbc->do("UPDATE worker SET status = '$status' WHERE worker_id = ".$worker->dbID);
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);
}

Leo Gordon's avatar
Leo Gordon committed
725
sub get_needed_workers_resync_if_necessary {
Leo Gordon's avatar
Leo Gordon committed
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
    my ($self, $meadow, $analysis) = @_;

    my $load                     = $self->get_hive_current_load();
    my $running_count            = $self->get_num_running_workers();
    my ($needed_count, $rc_hash) = $self->get_num_needed_workers($analysis);

    if($load==0 and $needed_count==0 and $running_count==0) {
        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
741
    return ($needed_count, $rc_hash);
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
  }
868

869
  # ok so no analyses 'need' workers with the given $rc_id.
870
871
872
  if ($self->get_num_failed_analyses()) {
    return undef;
  }
873
874
875
876
  # see if anything needs an update, in case there are
  # hidden jobs that haven't made it into the summary stats

  print("QUEEN: no obvious needed workers, need to dig deeper\n");
Leo Gordon's avatar
Leo Gordon committed
877
  my $stats_list = $statsDBA->fetch_by_statuses(['LOADING', 'BLOCKED']);
878
  foreach $stats (@$stats_list) {
879
    $self->safe_synchronize_AnalysisStats($stats);
880

Leo Gordon's avatar
Leo Gordon committed
881
    return $stats if(($stats->status ne 'BLOCKED') and ($stats->num_required_workers > 0) and (!defined($rc_id) or ($stats->rc_id == $rc_id)));
882
883
  }

884
    # does the following really ever help?
Leo Gordon's avatar
Leo Gordon committed
885
  ($stats) = @{$statsDBA->fetch_by_needed_workers(1,$self->{maximise_concurrency}, $rc_id)};
886
  return $stats;
887
888
889
}


890
=head2 fetch_by_dbID
Jessica Severin's avatar
Jessica Severin committed
891
892
893

  Arg [1]    : int $id
               the unique database identifier for the feature to be obtained
894
  Example    : $feat = $queen->fetch_by_dbID(1234);
Jessica Severin's avatar
Jessica Severin committed
895
896
897
  Description: Returns the feature created from the database defined by the
               the id $id.
  Returntype : Bio::EnsEMBL::Hive::Worker
898
  Exceptions : thrown if $worker_id is not defined
Jessica Severin's avatar
Jessica Severin committed
899
900
901
902
  Caller     : general

=cut

903
904
sub fetch_by_dbID {
  my ($self, $worker_id) = @_;
Jessica Severin's avatar
Jessica Severin committed
905

906
  unless(defined $worker_id) {
907
    throw("fetch_by_dbID must have an id");
Jessica Severin's avatar
Jessica Severin committed
908
909
  }

910
  my ($obj) = @{$self->_generic_fetch( "w.worker_id = $worker_id" ) };
Jessica Severin's avatar
Jessica Severin committed
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
  return $obj;
}

=head2 _generic_fetch

  Arg [1]    : (optional) string $constraint
               An SQL query constraint (i.e. part of the WHERE clause)
  Arg [2]    : (optional) string $logic_name
               the logic_name of the analysis of the features to obtain
  Example    : $fts = $a->_generic_fetch('contig_id in (1234, 1235)', 'Swall');
  Description: Performs a database fetch and returns feature objects in
               contig coordinates.
  Returntype : listref of Bio::EnsEMBL::SeqFeature in contig coordinates
  Exceptions : none
  Caller     : BaseFeatureAdaptor, ProxyDnaAlignFeatureAdaptor::_generic_fetch

=cut

sub _generic_fetch {
  my ($self, $constraint, $join) = @_;

  my @tables = $self->_tables;
  my $columns = join(', ', $self->_columns());

  if ($join) {
    foreach my $single_join (@{$join}) {
      my ($tablename, $condition, $extra_columns) = @{$single_join};
      if ($tablename && $condition) {
        push @tables, $tablename;

        if($constraint) {
          $constraint .= " AND $condition";
        } else {
          $constraint = " $condition";
        }
      }
      if ($extra_columns) {
        $columns .= ", " . join(', ', @{$extra_columns});
      }
    }
  }

  #construct a nice table string like 'table1 t1, table2 t2'
  my $tablenames = join(', ', map({ join(' ', @$_) } @tables));

  my $sql = "SELECT $columns FROM $tablenames";

  my $default_where = $self->_default_where_clause;
  my $final_clause = $self->_final_clause;

  #append a where clause if it was defined
  if($constraint) {
    $sql .= " WHERE $constraint ";
    if($default_where) {
      $sql .= " AND $default_where ";
    }
  } elsif($default_where) {
    $sql .= " WHERE $default_where ";
  }

  #append additional clauses which may have been defined
  $sql .= " $final_clause";

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

#  print STDERR $sql,"\n";

  return $self->_objs_from_sth($sth);
}

sub _tables {
  my $self = shift;

985
  return (['worker', 'w']);
Jessica Severin's avatar
Jessica Severin committed
986
987
988
989
990
}

sub _columns {
  my $self = shift;

991
992
993