Queen.pm 34.7 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
  gets $worker->batch_size() jobs from the analysis_job table, does its
29
  work, creates the next layer of analysis_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
88
89
90
  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.
               It creates an entry in the hive table, and returns a Worker object 
               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
  my $sql = q{INSERT INTO hive 
184
              (born, last_check_in, beekeeper, process_id, host, analysis_id)
185
              VALUES (NOW(), NOW(), ?,?,?,?)};
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 = $sth->{'mysql_insertid'};
Jessica Severin's avatar
Jessica Severin committed
190
191
  $sth->finish;

Leo Gordon's avatar
Leo Gordon committed
192
  my $worker = $self->fetch_by_worker_id($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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229

    $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) {
      $worker->set_worker_batch_size($batch_size);
    }
    if($job_limit) {
      $worker->job_limit($job_limit);
      $worker->life_span(0);
    }
    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
230
231
232
233
234
235
236
  return $worker;
}

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

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

Leo Gordon's avatar
bugfix    
Leo Gordon committed
238
239
240
  my $cod = $worker->cause_of_death();

  unless ($cod eq 'HIVE_OVERLOAD') {
241
242
243
244
    ## 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);
  }

Jessica Severin's avatar
Jessica Severin committed
245
  my $sql = "UPDATE hive SET died=now(), last_check_in=now()";
246
  $sql .= " ,status='DEAD'";
Jessica Severin's avatar
Jessica Severin committed
247
  $sql .= " ,work_done='" . $worker->work_done . "'";
Leo Gordon's avatar
bugfix    
Leo Gordon committed
248
  $sql .= " ,cause_of_death='$cod'";
Leo Gordon's avatar
Leo Gordon committed
249
  $sql .= " WHERE worker_id='" . $worker->worker_id ."'";
Jessica Severin's avatar
Jessica Severin committed
250

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

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

Jessica Severin's avatar
Jessica Severin committed
270
271
}

272
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
273
274
    my ($self, $meadow, $check_buried_in_haste) = @_;

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

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

281
282
    my %gc_wpid_to_worker = ();

Leo Gordon's avatar
Leo Gordon committed
283
284
285
    foreach my $worker (@$queen_worker_list) {
        next unless($meadow->responsible_for_worker($worker));

286
287
        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
288
289
290
            $worker_status_summary{$status}++;
        } else {
            $worker_status_summary{'AWOL'}++;
291

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

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

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

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

  return unless($worker);
  my $sql = "UPDATE hive SET last_check_in=now()";
336
  $sql .= " ,work_done='" . $worker->work_done . "'";
Leo Gordon's avatar
Leo Gordon committed
337
  $sql .= " WHERE worker_id='" . $worker->worker_id ."'";
Jessica Severin's avatar
Jessica Severin committed
338
339
340
341

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


347
=head2 reset_and_fetch_job_by_dbID
348
349
350

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

=cut

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

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


sub worker_reclaim_job {
  my $self   = shift;
  my $worker = shift;
  my $job    = shift;

  return undef unless($job and $worker);
Leo Gordon's avatar
Leo Gordon committed
386
  $job->worker_id($worker->worker_id);
387
  $self->db->get_AnalysisJobAdaptor->reclaim_job($job);
388
389
390
391
392
393
394
395
396
397
  return $job;
}


######################################
#
# Public API interface for beekeeper
#
######################################

398
399
400
    # Note: asking for Queen->fetch_overdue_workers(0) essentially means
    #       "fetch all workers known to the Queen not to be officially dead"
    #
401
402
403
404
405
406
407
408
409
410
sub fetch_overdue_workers {
  my ($self,$overdue_secs) = @_;

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

  my $constraint = "h.cause_of_death='' ".
                   "AND (UNIX_TIMESTAMP()-UNIX_TIMESTAMP(h.last_check_in))>$overdue_secs";
  return $self->_generic_fetch($constraint);
}

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

414
415
416
417
  my $constraint = "h.cause_of_death='FATALITY' ";
  return $self->_generic_fetch($constraint);
}

Leo Gordon's avatar
Leo Gordon committed
418
419
420
sub fetch_dead_workers_with_jobs {
  my $self = shift;

421
  # select h.worker_id from hive h, analysis_job WHERE h.worker_id=analysis_job.worker_id AND h.cause_of_death!='' AND analysis_job.status not in ('DONE', 'READY','FAILED', 'PASSED_ON') group by h.worker_id
Leo Gordon's avatar
Leo Gordon committed
422

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

428
429
=head2 synchronize_hive

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

=cut

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

445
  my $start_time = time();
446

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

Leo Gordon's avatar
Leo Gordon committed
449
  print STDERR "\nSynchronizing the hive (".scalar(@$list_of_analyses)." analyses this time):\n";
Leo Gordon's avatar
Leo Gordon committed
450
451
  foreach my $analysis (@$list_of_analyses) {
    $self->synchronize_AnalysisStats($analysis->stats);
Leo Gordon's avatar
Leo Gordon committed
452
    print STDERR '.';
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 "Checking blocking control rules:\n";
Leo Gordon's avatar
Leo Gordon committed
457
  foreach my $analysis (@$list_of_analyses) {
458
    $self->check_blocking_control_rules_for_AnalysisStats($analysis->stats);
Leo Gordon's avatar
Leo Gordon committed
459
    print STDERR '.';
460
  }
Leo Gordon's avatar
Leo Gordon committed
461
  print STDERR "\n";
Leo Gordon's avatar
Leo Gordon committed
462

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

466

467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
=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
489
                   ($stats->seconds_since_last_update < 3*60));
490
491
492
493

  # 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;
494
  #print("$sql\n");
495
496
  my $row_count = $self->dbc->do($sql);  
  return $stats unless($row_count == 1);
497
  #printf("got sync_lock on analysis_stats(%d)\n", $stats->analysis_id);
498
499
500
  
  #OK have the lock, go and do the sync
  $self->synchronize_AnalysisStats($stats);
501

502
503
504
505
  return $stats;
}


506
=head2 synchronize_AnalysisStats
507

508
509
510
511
512
513
514
515
  Arg [1]    : Bio::EnsEMBL::Hive::AnalysisStats object
  Example    : $self->synchronize($analysisStats);
  Description: Queries the analysis_job and hive tables to get summary counts
               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
516

517
=cut
518

519
sub synchronize_AnalysisStats {
520
  my $self = shift;
521
  my $analysisStats = shift;
522

523
  return $analysisStats unless($analysisStats);
524
  return $analysisStats unless($analysisStats->analysis_id);
525
  
526
  $analysisStats->refresh(); ## Need to get the new hive_capacity for dynamic analyses
527
528
529
530
531
532
  $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);

533
534
  my $sql = "SELECT status, count(*), semaphore_count FROM analysis_job ".
            "WHERE analysis_id=? GROUP BY status, semaphore_count";
535
536
537
  my $sth = $self->prepare($sql);
  $sth->execute($analysisStats->analysis_id);

538
539
  my $hive_capacity = $analysisStats->hive_capacity;

540
  while (my ($status, $count, $semaphore_count)=$sth->fetchrow_array()) {
541
# print STDERR "$status - $count\n";
542
543
544
545

    my $total = $analysisStats->total_job_count();
    $analysisStats->total_job_count($total + $count);

546
    if(($status eq 'READY') and ($semaphore_count<=0)) {
547
      $analysisStats->unclaimed_job_count($count);
548
549
550
551
552
553
554
555
556
      my $numWorkers;
      if($analysisStats->batch_size > 0) {
        $numWorkers = POSIX::ceil($count / $analysisStats->batch_size);
      } else {
        my $job_msec = $analysisStats->avg_msec_per_job;
        $job_msec = 100 if($job_msec>0 and $job_msec<100);
        $numWorkers = POSIX::ceil(($count * $job_msec) / (3*60*1000)); 
        # guess num needed workers by total jobs / (num jobs a worker could do in 3 minutes)
      }
557
      $numWorkers=$count if($numWorkers==0);
558
559
560
561
562
      if($analysisStats->hive_capacity>0 and $numWorkers > $analysisStats->hive_capacity) {
        $numWorkers=$analysisStats->hive_capacity;
      }
      $analysisStats->num_required_workers($numWorkers);
    }
563
564
    if ($status eq 'DONE') { $analysisStats->done_job_count($count); }
    if ($status eq 'FAILED') { $analysisStats->failed_job_count($count); }
565
566
  }
  $sth->finish;
567

568
  $self->check_blocking_control_rules_for_AnalysisStats($analysisStats);
569

570
571
572
  if($analysisStats->status ne 'BLOCKED') {
    $analysisStats->determine_status();
  }
573

574
575
576
577
  #
  # adjust_stats_for_living_workers
  #
  
578
  if($analysisStats->hive_capacity > 0) {
579
    my $liveCount = $analysisStats->get_running_worker_count();
580
581
582
583
584
585
586
587

    my $numWorkers = $analysisStats->num_required_workers;

    my $capacityAdjust = ($numWorkers + $liveCount) - $analysisStats->hive_capacity;
    $numWorkers -= $capacityAdjust if($capacityAdjust > 0);
    $numWorkers=0 if($numWorkers<0);

    $analysisStats->num_required_workers($numWorkers);
588
  }
589

590
  $analysisStats->update;  #update and release sync_lock
591

592
  return $analysisStats;
593
}
594
595


596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
sub check_blocking_control_rules_for_AnalysisStats
{
  my $self = shift;
  my $stats = shift;
  
  return unless($stats);

  #print("check ctrl on analysis ");  $stats->print_stats;
  my $ctrlRules = $self->db->get_AnalysisCtrlRuleAdaptor->
                  fetch_by_ctrled_analysis_id($stats->analysis_id);
  my $allRulesDone = 1;
  if(scalar @$ctrlRules > 0) {
    #print("HAS blocking_ctrl_rules to check\n");
    foreach my $ctrlrule (@{$ctrlRules}) {
      #use this method because the condition_analysis objects can be
      #network distributed to a different database so use it's adaptor to get
      #the AnalysisStats object
      #$ctrlrule->print_rule;
      my $condAnalysis = $ctrlrule->condition_analysis;
      my $condStats = $condAnalysis->stats if($condAnalysis);
      $allRulesDone = 0 unless($condStats and $condStats->status eq 'DONE');
      #print("  "); $condStats->print_stats;
    }
619

620
621
622
    if($allRulesDone) {
      if($stats->status eq 'BLOCKED') {
        #print("  UNBLOCK analysis : all conditions met\n");
623
        $stats->update_status('LOADING'); #trigger sync
624
625
626
627
      }
    } else {
      #print("  RE-BLOCK analysis : some conditions failed\n");
      $stats->update_status('BLOCKED');
628
629
    }
  }
630
631
632
}


Leo Gordon's avatar
Leo Gordon committed
633
634
sub get_num_failed_analyses {
  my ($self, $analysis) = @_;
635
636

  my $statsDBA = $self->db->get_AnalysisStatsAdaptor;
Leo Gordon's avatar
Leo Gordon committed
637
  my $failed_analyses = $statsDBA->fetch_by_statuses(['FAILED']);
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
  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);
}


660
661
sub get_hive_current_load {
  my $self = shift;
Leo Gordon's avatar
Leo Gordon committed
662
  my $sql = "SELECT sum(1/analysis_stats.hive_capacity) FROM hive, analysis_stats ".
663
664
            "WHERE hive.analysis_id=analysis_stats.analysis_id and cause_of_death ='' ".
            "AND analysis_stats.hive_capacity>0";
665
666
667
668
669
  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
670
  print("current hive load = $load\n");
671
672
673
674
  return $load;
}


675
676
677
678
679
680
681
682
sub get_num_running_workers {
  my $self = shift;
  my $sql = "SELECT count(*) FROM hive WHERE cause_of_death =''";
  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
683
  print("current hive num_running_workers = $runningCount\n");
684
685
686
  return $runningCount;
}

687
688
689
sub enter_status {
  my ($self, $worker, $status) = @_;

Leo Gordon's avatar
Leo Gordon committed
690
  $self->dbc->do("UPDATE hive SET status = '$status' WHERE worker_id = ".$worker->worker_id);
691
692
}

693
694
=head2 get_num_needed_workers

695
  Arg[1]     : Bio::EnsEMBL::Analysis object (optional)
696
697
698
699
  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
700
               If Arg[1] is defined, does it only for the given analysis.
701
  Exceptions : none
702
  Caller     : beekeepers and other external processes
703
704
705

=cut

706
sub get_num_needed_workers {
Leo Gordon's avatar
Leo Gordon committed
707
  my ($self, $filter_analysis) = @_;
708

709
  my $statsDBA = $self->db->get_AnalysisStatsAdaptor;
Leo Gordon's avatar
Leo Gordon committed
710
711
712
  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);
713

Leo Gordon's avatar
Leo Gordon committed
714
  return 0 unless(@all_analyses);
715

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

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

Leo Gordon's avatar
Leo Gordon committed
720
721
  my $total_workers = 0;
  my %rc2workers = ();
722

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

Leo Gordon's avatar
Leo Gordon committed
726
        #digging deeper under the surface so need to sync
727
728
729
730
731
732
733
    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);

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

Leo Gordon's avatar
Leo Gordon committed
737
738
739
740
741
742
743
744
    if($analysis_stats->hive_capacity > 0) {   # if there is a limit, use it for cut-off
        my $limit_workers_this_analysis = int($available_load * $analysis_stats->hive_capacity);

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

        $available_load -= 1.0*$workers_this_analysis/$analysis_stats->hive_capacity;
745
    }
Leo Gordon's avatar
Leo Gordon committed
746
747
748
749
750
751
    $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);
752
  }
753

Leo Gordon's avatar
Leo Gordon committed
754
755
756
757
  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
758
sub get_needed_workers_resync_if_necessary {
Leo Gordon's avatar
Leo Gordon committed
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
    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
774
    return ($needed_count, $rc_hash);
775
776
}

Leo Gordon's avatar
Leo Gordon committed
777
sub get_remaining_jobs_show_hive_progress {
778
  my $self = shift;
Leo Gordon's avatar
Leo Gordon committed
779
  my $sql = "SELECT sum(done_job_count), sum(failed_job_count), sum(total_job_count), ".
780
781
            "sum(unclaimed_job_count * analysis_stats.avg_msec_per_job)/1000/60/60 ".
            "FROM analysis_stats";
782
783
  my $sth = $self->prepare($sql);
  $sth->execute();
784
  my ($done, $failed, $total, $cpuhrs) = $sth->fetchrow_array();
785
  $sth->finish;
786
787
788
789
790
791
792

  $done   ||= 0;
  $failed ||= 0;
  $total  ||= 0;
  my $completed = $total
    ? ((100.0 * ($done+$failed))/$total)
    : 0.0;
793
794
795
  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
796
  return $remaining;
797
798
}

799
800
801
802
803
804
805
806
## Can't see where this method is used.
#
#sub print_hive_status {
#    my ($self, $filter_analysis) = @_;
#
#    $self->print_analysis_status($filter_analysis);
#    $self->print_running_worker_status;
#}
807
808


Leo Gordon's avatar
Leo Gordon committed
809
sub print_analysis_status {
Leo Gordon's avatar
Leo Gordon committed
810
    my ($self, $filter_analysis) = @_;
811

Leo Gordon's avatar
Leo Gordon committed
812
    my $list_of_analyses = $filter_analysis ? [$filter_analysis] : $self->db->get_AnalysisAdaptor->fetch_all;
Leo Gordon's avatar
Leo Gordon committed
813
814
815
    foreach my $analysis (sort {$a->dbID <=> $b->dbID} @$list_of_analyses) {
        $analysis->stats->print_stats($self->{'verbose_stats'});
    }
816
817
818
}


Leo Gordon's avatar
Leo Gordon committed
819
sub print_running_worker_status {
820
  my $self = shift;
821

Leo Gordon's avatar
Leo Gordon committed
822
  print "====== Live workers according to Queen:\n";
823
824
825
  my $sql = "select logic_name, count(*) from hive, analysis ".
            "where hive.analysis_id=analysis.analysis_id and hive.cause_of_death='' ".
            "group by hive.analysis_id";
Leo Gordon's avatar
Leo Gordon committed
826
827

  my $total = 0;
828
829
830
831
  my $sth = $self->prepare($sql);
  $sth->execute();
  while((my $logic_name, my $count)=$sth->fetchrow_array()) {
    printf("%20s : %d workers\n", $logic_name, $count);
832
    $total += $count;
833
  }
834
  printf("  %d total workers\n", $total);
Leo Gordon's avatar
Leo Gordon committed
835
  print "===========================\n";
836
  $sth->finish;
837
}
838

839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
=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

sub monitor
{
  my $self = shift;
  my $sql = qq{
      INSERT INTO monitor
      SELECT
          now(),
          count(*),
          sum(work_done/TIME_TO_SEC(TIMEDIFF(now(),born))),
          sum(work_done/TIME_TO_SEC(TIMEDIFF(now(),born)))/count(*),
          group_concat(DISTINCT logic_name)
      FROM hive left join analysis USING (analysis_id)
      WHERE cause_of_death = ""};
      
  my $sth = $self->prepare($sql);
  $sth->execute();
}

Leo Gordon's avatar
Leo Gordon committed
868
869
870
871
872
873
874
875
876
877
878
879
880
881
=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}) {
882
        $worker->cause_of_death( 'FATALITY' );  # well, maybe we could have investigated further...
Leo Gordon's avatar
Leo Gordon committed
883
884
885
886
        $self->register_worker_death($worker);
    }
}

887

Jessica Severin's avatar
Jessica Severin committed
888
889
890
891
892
#
# INTERNAL METHODS
#
###################

893
sub _pick_best_analysis_for_new_worker {
Leo Gordon's avatar
Leo Gordon committed
894
895
  my $self  = shift;
  my $rc_id = shift;    # this parameter will need to percolate very deep
896
897
898
899

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

Leo Gordon's avatar
Leo Gordon committed
900
  my ($stats) = @{$statsDBA->fetch_by_needed_workers(1,$self->{maximise_concurrency}, $rc_id)};
901
902
903
904
905
  if($stats) {
    #synchronize and double check that it can be run
    $self->safe_synchronize_AnalysisStats($stats);
    return $stats if(($stats->status ne 'BLOCKED') and ($stats->num_required_workers > 0));
  }
906
907

  # ok so no analyses 'need' workers.
908
909
910
  if ($self->get_num_failed_analyses()) {
    return undef;
  }
911
912
913
914
  # 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
915
  my $stats_list = $statsDBA->fetch_by_statuses(['LOADING', 'BLOCKED']);
916
  foreach $stats (@$stats_list) {
917
    $self->safe_synchronize_AnalysisStats($stats);
918

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

Leo Gordon's avatar
Leo Gordon committed
922
  ($stats) = @{$statsDBA->fetch_by_needed_workers(1,$self->{maximise_concurrency}, $rc_id)};
923
924
925
926
927
928
  return $stats if($stats);

  return undef;
}


Leo Gordon's avatar
Leo Gordon committed
929
=head2 fetch_by_worker_id
Jessica Severin's avatar
Jessica Severin committed
930
931
932

  Arg [1]    : int $id
               the unique database identifier for the feature to be obtained
933
  Example    : $feat = $queen->fetch_by_dbID(1234);
Jessica Severin's avatar
Jessica Severin committed
934
935
936
937
938
939
940
941
  Description: Returns the feature created from the database defined by the
               the id $id.
  Returntype : Bio::EnsEMBL::Hive::Worker
  Exceptions : thrown if $id is not defined
  Caller     : general

=cut

Leo Gordon's avatar
Leo Gordon committed
942
sub fetch_by_worker_id {
Jessica Severin's avatar
Jessica Severin committed
943
944
945
  my ($self,$id) = @_;

  unless(defined $id) {
946
    throw("fetch_by_dbID must have an id");
Jessica Severin's avatar
Jessica Severin committed
947
948
949
950
  }

  my @tabs = $self->_tables;

Leo Gordon's avatar
Leo Gordon committed
951
  my $constraint = "h.worker_id = $id";
Jessica Severin's avatar
Jessica Severin committed
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
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034

  #return first element of _generic_fetch list
  my ($obj) = @{$self->_generic_fetch($constraint)};
  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;

  return (['hive', 'h']);
}

sub _columns {
  my $self = shift;

Leo Gordon's avatar
Leo Gordon committed
1035
  return qw (h.worker_id
Jessica Severin's avatar
Jessica Severin committed
1036
             h.analysis_id
1037
             h.beekeeper
Jessica Severin's avatar
Jessica Severin committed
1038
1039
1040
             h.host
             h.process_id
             h.work_done
1041
             h.status
Jessica Severin's avatar
Jessica Severin committed
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
             h.born
             h.last_check_in
             h.died
             h.cause_of_death
            );
}

sub _objs_from_sth {
  my ($self, $sth) = @_;

  my %column;
  $sth->bind_columns( \( @column{ @{$sth->{NAME_lc} } } ));

  my @workers = ();

  while ($sth->fetch()) {
    my $worker = new Bio::EnsEMBL::Hive::Worker;
    $worker->init;

Leo Gordon's avatar
Leo Gordon committed
1061
    $worker->worker_id($column{'worker_id'});
1062
    $worker->beekeeper($column{'beekeeper'});
Jessica Severin's avatar
Jessica Severin committed
1063
1064
1065
    $worker->host($column{'host'});
    $worker->process_id($column{'process_id'});
    $worker->work_done($column{'work_done'});
1066
    $worker->status($column{'status'});
Jessica Severin's avatar
Jessica Severin committed
1067
1068
1069
1070
    $worker->born($column{'born'});
    $worker->last_check_in($column{'last_check_in'});
    $worker->died($column{'died'});
    $worker->cause_of_death($column{'cause_of_death'});
1071
    $worker->queen($self);
Jessica Severin's avatar
Jessica Severin committed
1072
1073
    $worker->db($self->db);

1074
1075
    if($column{'analysis_id'} and $self->db->get_AnalysisAdaptor) {
      $worker->analysis($self->db->get_AnalysisAdaptor->fetch_by_dbID($column{'analysis_id'}));
Jessica Severin's avatar
Jessica Severin committed
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
    }

    push @workers, $worker;
  }
  $sth->finish;

  return \@workers
}

sub _default_where_clause {
  my $self = shift;
  return '';
}

sub _final_clause {
  my $self = shift;
  return '';
}


1;