Queen.pm 30.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
  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;

Jessica Severin's avatar
Jessica Severin committed
67
68
69
use Bio::EnsEMBL::Hive::Worker;
use Bio::EnsEMBL::DBSQL::BaseAdaptor;
use Sys::Hostname;
70
use Bio::EnsEMBL::Hive::DBSQL::AnalysisCtrlRuleAdaptor;
Jessica Severin's avatar
Jessica Severin committed
71

72

Jessica Severin's avatar
Jessica Severin committed
73
74
our @ISA = qw(Bio::EnsEMBL::DBSQL::BaseAdaptor);

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
  my ($analysis_id, $beekeeper ,$pid, $job, $no_write) =
     rearrange([qw(analysis_id beekeeper process_id job no_write) ], @args);
Jessica Severin's avatar
Jessica Severin committed
102

103
  my $analStatsDBA = $self->db->get_AnalysisStatsAdaptor;
104
  return undef unless($analStatsDBA);
105

106
  $analysis_id = $job->analysis_id if(defined($job));
107
  
108
109
110
  my $analysisStats;
  if($analysis_id) {
    $analysisStats = $analStatsDBA->fetch_by_analysis_id($analysis_id);
111
    $self->safe_synchronize_AnalysisStats($analysisStats);
112
    #return undef unless(($analysisStats->status ne 'BLOCKED') and ($analysisStats->num_required_workers > 0));
113
  } else {
114
    $analysisStats = $self->_pick_best_analysis_for_new_worker;
115
  }
116
  return undef unless($analysisStats);
117

118
119
  unless($job) {
    #go into autonomous mode
120
    return undef if($self->get_hive_current_load() >= 1.1);
121
    
122
123
    $analStatsDBA->decrease_needed_workers($analysisStats->analysis_id);
    $analStatsDBA->increase_running_workers($analysisStats->analysis_id);
124
125
126
127
128
129
130
131
132
133
    $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;
    }
134
  }
135
  
Jessica Severin's avatar
Jessica Severin committed
136
  my $host = hostname;
137
  $pid = $$ unless($pid);
138
  $beekeeper = '' unless($beekeeper);
Jessica Severin's avatar
Jessica Severin committed
139

140
141
142
  my $sql = q{INSERT INTO hive 
              (born, last_check_in, process_id, analysis_id, beekeeper, host)
              VALUES (NOW(), NOW(), ?,?,?,?)};
Jessica Severin's avatar
Jessica Severin committed
143
144

  my $sth = $self->prepare($sql);
145
  $sth->execute($pid, $analysisStats->analysis_id, $beekeeper, $host);
Leo Gordon's avatar
Leo Gordon committed
146
  my $worker_id = $sth->{'mysql_insertid'};
Jessica Severin's avatar
Jessica Severin committed
147
148
  $sth->finish;

Leo Gordon's avatar
Leo Gordon committed
149
  my $worker = $self->fetch_by_worker_id($worker_id);
Jessica Severin's avatar
Jessica Severin committed
150
151
  $worker=undef unless($worker and $worker->analysis);

152
  if($worker and $analysisStats) {
153
    $analysisStats->update_status('WORKING');
Jessica Severin's avatar
Jessica Severin committed
154
  }
155
156
157
158
  
  $worker->_specific_job($job) if(defined($job));
  $worker->execute_writes(0) if($no_write);
  
Jessica Severin's avatar
Jessica Severin committed
159
160
161
162
163
164
165
166
  return $worker;
}


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

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

168
169
  # if called without a defined cause_of_death, assume catastrophic failure
  $worker->cause_of_death('FATALITY') unless(defined($worker->cause_of_death));
170
171
172
173
174
  unless ($worker->cause_of_death() eq "HIVE_OVERLOAD") {
    ## 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
175
  my $sql = "UPDATE hive SET died=now(), last_check_in=now()";
176
  $sql .= " ,status='DEAD'";
Jessica Severin's avatar
Jessica Severin committed
177
178
  $sql .= " ,work_done='" . $worker->work_done . "'";
  $sql .= " ,cause_of_death='". $worker->cause_of_death ."'";
Leo Gordon's avatar
Leo Gordon committed
179
  $sql .= " WHERE worker_id='" . $worker->worker_id ."'";
Jessica Severin's avatar
Jessica Severin committed
180
181
182
183

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

  if($worker->cause_of_death eq "NO_WORK") {
186
    $self->db->get_AnalysisStatsAdaptor->update_status($worker->analysis->dbID, "ALL_CLAIMED");
187
188
  }
  if($worker->cause_of_death eq "FATALITY") {
Leo Gordon's avatar
Leo Gordon committed
189
    #print("FATAL DEATH Arrrrgggghhhhhhhh (worker_id=",$worker->worker_id,")\n");
190
    $self->db->get_AnalysisJobAdaptor->reset_dead_jobs_for_worker($worker);
191
  }
192
  
193
  # re-sync the analysis_stats when a worker dies as part of dynamic sync system
194
  if($self->safe_synchronize_AnalysisStats($worker->analysis->stats)->status ne 'DONE') {
195
196
    # 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
197
    $self->db->get_AnalysisStatsAdaptor->increase_needed_workers($worker->analysis->dbID);
198
199
  }

Jessica Severin's avatar
Jessica Severin committed
200
201
202
}


203
sub worker_check_in {
Jessica Severin's avatar
Jessica Severin committed
204
205
206
207
  my ($self, $worker) = @_;

  return unless($worker);
  my $sql = "UPDATE hive SET last_check_in=now()";
208
  $sql .= " ,work_done='" . $worker->work_done . "'";
Leo Gordon's avatar
Leo Gordon committed
209
  $sql .= " WHERE worker_id='" . $worker->worker_id ."'";
Jessica Severin's avatar
Jessica Severin committed
210
211
212
213

  my $sth = $self->prepare($sql);
  $sth->execute();
  $sth->finish;
214
  
215
  $self->safe_synchronize_AnalysisStats($worker->analysis->stats);
Jessica Severin's avatar
Jessica Severin committed
216
217
218
}


219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
=head2 worker_grab_jobs

  Arg [1]           : Bio::EnsEMBL::Hive::Worker object $worker
  Example: 
    my $jobs  = $queen->worker_grab_jobs();
  Description: 
    For the specified worker, it will search available jobs, 
    and using the workers requested batch_size, claim/fetch that
    number of jobs, and then return them.
  Returntype : 
    reference to array of Bio::EnsEMBL::Hive::AnalysisJob objects
  Exceptions :
  Caller     :

=cut

sub worker_grab_jobs {
  my $self            = shift;
  my $worker          = shift;
  
  my $jobDBA = $self->db->get_AnalysisJobAdaptor;
  my $claim = $jobDBA->claim_jobs_for_worker($worker);
  my $jobs = $jobDBA->fetch_by_claim_analysis($claim, $worker->analysis->dbID);
  return $jobs;
}

245
=head2 reset_and_fetch_job_by_dbID
246
247
248

  Arg [1]: int $analysis_job_id
  Example: 
249
    my $job = $queen->reset_and_fetch_job_by_dbID($analysis_job_id);
250
251
  Description: 
    For the specified analysis_job_id it will fetch just that job, 
252
253
254
    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 
255
256
    same job simultaneously (use only for debugging).
  Returntype : 
257
    Bio::EnsEMBL::Hive::AnalysisJob object
258
  Exceptions :
259
  Caller     : beekeepers, runWorker.pl scripts
260
261
262

=cut

263
264
sub reset_and_fetch_job_by_dbID {
  my $self = shift;
265
  my $analysis_job_id = shift;
266
  
267
  my $jobDBA = $self->db->get_AnalysisJobAdaptor;
268
269
270
271
272
  $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);
273
  
274
275
276
277
278
279
280
281
282
283
  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
284
  $job->worker_id($worker->worker_id);
285
  $self->db->get_AnalysisJobAdaptor->reclaim_job($job);
286
287
288
289
290
291
292
293
294
295
  return $job;
}


sub worker_register_job_done {
  my $self = shift;
  my $worker = shift;
  my $job = shift;
  
  return unless($job);
Leo Gordon's avatar
Leo Gordon committed
296
  return unless($job->dbID and $job->adaptor and $job->worker_id);
297
  return unless($worker and $worker->analysis and $worker->analysis->dbID);
298
  
299
300
301
302
303
304
305
306
307
  $job->update_status('DONE');
}


sub flow_output_job {
  my $self = shift;
  my $job = shift;
  
  return unless($job);
308
  my $create_blocked_job = 0;
309
  $create_blocked_job = 1 if($job->status and ($job->status eq 'BLOCKED'));
310
  
311
  my @output_jobs;
312
313
  my $rules = $self->db->get_DataflowRuleAdaptor->fetch_from_analysis_job($job);
  foreach my $rule (@{$rules}) {
314
    my $job_id = Bio::EnsEMBL::Hive::DBSQL::AnalysisJobAdaptor->CreateNewJob (
315
316
317
        -input_id       => $job->input_id,
        -analysis       => $rule->to_analysis,
        -input_job_id   => $job->dbID,
318
        -block          => $create_blocked_job
319
    );
320
321
322
    my $job_url =  $rule->to_analysis->adaptor->db->dbc->url;
    $job_url .= "/analysis_job?dbID=" . $job_id;
    push @output_jobs, $job_url;
323
  }
324
  return \@output_jobs;
325
326
327
328
329
330
331
332
333
}


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

334
335
336
    # Note: asking for Queen->fetch_overdue_workers(0) essentially means
    #       "fetch all workers known to the Queen not to be officially dead"
    #
337
338
339
340
341
342
343
344
345
346
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);
}

347
348
sub fetch_failed_workers {
  my $self = shift;
Leo Gordon's avatar
Leo Gordon committed
349

350
351
352
353
  my $constraint = "h.cause_of_death='FATALITY' ";
  return $self->_generic_fetch($constraint);
}

Leo Gordon's avatar
Leo Gordon committed
354
355
356
sub fetch_dead_workers_with_jobs {
  my $self = shift;

Leo Gordon's avatar
Leo Gordon committed
357
  # 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') group by h.worker_id
Leo Gordon's avatar
Leo Gordon committed
358

Leo Gordon's avatar
bugfix  
Leo Gordon committed
359
  my $constraint = "h.cause_of_death!='' ";
Leo Gordon's avatar
Leo Gordon committed
360
  my $join = [[['analysis_job', 'j'], " h.worker_id=j.worker_id AND j.status NOT IN ('DONE', 'READY', 'FAILED') GROUP BY h.worker_id"]];
Leo Gordon's avatar
Leo Gordon committed
361
362
  return $self->_generic_fetch($constraint, $join);
}
Jessica Severin's avatar
Jessica Severin committed
363

364
365
=head2 synchronize_hive

Leo Gordon's avatar
Leo Gordon committed
366
  Arg [1]    : $this_analysis (optional)
367
368
369
370
371
372
373
374
375
376
377
  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
378
379
  my $self          = shift;
  my $this_analysis = shift; # optional parameter
380

381
  my $start_time = time();
382

Leo Gordon's avatar
Leo Gordon committed
383
384
  my $list_of_analyses = $this_analysis ? [$this_analysis] : $self->db->get_AnalysisAdaptor->fetch_all;

Leo Gordon's avatar
Leo Gordon committed
385
  print STDERR "\nSynchronizing the hive (".scalar(@$list_of_analyses)." analyses this time):\n";
Leo Gordon's avatar
Leo Gordon committed
386
387
  foreach my $analysis (@$list_of_analyses) {
    $self->synchronize_AnalysisStats($analysis->stats);
Leo Gordon's avatar
Leo Gordon committed
388
    print STDERR '.';
389
  }
Leo Gordon's avatar
Leo Gordon committed
390
  print STDERR "\n";
Leo Gordon's avatar
Leo Gordon committed
391

Leo Gordon's avatar
Leo Gordon committed
392
  print STDERR "Checking blocking control rules:\n";
Leo Gordon's avatar
Leo Gordon committed
393
  foreach my $analysis (@$list_of_analyses) {
394
    $self->check_blocking_control_rules_for_AnalysisStats($analysis->stats);
Leo Gordon's avatar
Leo Gordon committed
395
    print STDERR '.';
396
  }
Leo Gordon's avatar
Leo Gordon committed
397
  print STDERR "\n";
Leo Gordon's avatar
Leo Gordon committed
398

Leo Gordon's avatar
Leo Gordon committed
399
  print STDERR ''.((time() - $start_time))." seconds to synchronize_hive\n\n";
400
}
401

402

403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
=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
425
                   ($stats->seconds_since_last_update < 3*60));
426
427
428
429

  # 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;
430
  #print("$sql\n");
431
432
  my $row_count = $self->dbc->do($sql);  
  return $stats unless($row_count == 1);
433
  #printf("got sync_lock on analysis_stats(%d)\n", $stats->analysis_id);
434
435
436
  
  #OK have the lock, go and do the sync
  $self->synchronize_AnalysisStats($stats);
437

438
439
440
441
  return $stats;
}


442
=head2 synchronize_AnalysisStats
443

444
445
446
447
448
449
450
451
  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
452

453
=cut
454

455
sub synchronize_AnalysisStats {
456
  my $self = shift;
457
  my $analysisStats = shift;
458

459
  return $analysisStats unless($analysisStats);
460
  return $analysisStats unless($analysisStats->analysis_id);
461
  
462
  $analysisStats->refresh(); ## Need to get the new hive_capacity for dynamic analyses
463
464
465
466
467
468
  $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);

469
470
  my $sql = "SELECT status, count(*), semaphore_count>0 semaphored FROM analysis_job ".
            "WHERE analysis_id=? GROUP BY status, semaphored";
471
472
473
  my $sth = $self->prepare($sql);
  $sth->execute($analysisStats->analysis_id);

474
475
  my $hive_capacity = $analysisStats->hive_capacity;

476
  while (my ($status, $count, $semaphored)=$sth->fetchrow_array()) {
477
# print STDERR "$status - $count\n";
478
479
480
481

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

482
    if(($status eq 'READY') and !$semaphored) {
483
      $analysisStats->unclaimed_job_count($count);
484
485
486
487
488
489
490
491
492
      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)
      }
493
      $numWorkers=$count if($numWorkers==0);
494
495
496
497
498
      if($analysisStats->hive_capacity>0 and $numWorkers > $analysisStats->hive_capacity) {
        $numWorkers=$analysisStats->hive_capacity;
      }
      $analysisStats->num_required_workers($numWorkers);
    }
499
500
    if ($status eq 'DONE') { $analysisStats->done_job_count($count); }
    if ($status eq 'FAILED') { $analysisStats->failed_job_count($count); }
501
502
  }
  $sth->finish;
503

504
  $self->check_blocking_control_rules_for_AnalysisStats($analysisStats);
505

506
507
508
  if($analysisStats->status ne 'BLOCKED') {
    $analysisStats->determine_status();
  }
509

510
511
512
513
  #
  # adjust_stats_for_living_workers
  #
  
514
  if($analysisStats->hive_capacity > 0) {
515
    my $liveCount = $analysisStats->get_running_worker_count();
516
517
518
519
520
521
522
523

    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);
524
  }
525

526
  $analysisStats->update;  #update and release sync_lock
527

528
  return $analysisStats;
529
}
530
531


532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
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;
    }
555

556
557
558
    if($allRulesDone) {
      if($stats->status eq 'BLOCKED') {
        #print("  UNBLOCK analysis : all conditions met\n");
559
        $stats->update_status('LOADING'); #trigger sync
560
561
562
563
      }
    } else {
      #print("  RE-BLOCK analysis : some conditions failed\n");
      $stats->update_status('BLOCKED');
564
565
    }
  }
566
567
568
}


569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
sub get_num_failed_analyses
{
  my $self = shift;
  my $analysis = shift;

  my $statsDBA = $self->db->get_AnalysisStatsAdaptor;
  my $failed_analyses = $statsDBA->fetch_by_status('FAILED');
  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);
}


598
599
sub get_hive_current_load {
  my $self = shift;
Leo Gordon's avatar
Leo Gordon committed
600
  my $sql = "SELECT sum(1/analysis_stats.hive_capacity) FROM hive, analysis_stats ".
601
602
            "WHERE hive.analysis_id=analysis_stats.analysis_id and cause_of_death ='' ".
            "AND analysis_stats.hive_capacity>0";
603
604
605
606
607
  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
608
  print("current hive load = $load\n");
609
610
611
612
  return $load;
}


613
614
615
616
617
618
619
620
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
621
  print("current hive num_running_workers = $runningCount\n");
622
623
624
  return $runningCount;
}

625
626
627
sub enter_status {
  my ($self, $worker, $status) = @_;

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

631
632
=head2 get_num_needed_workers

633
  Arg[1]     : Bio::EnsEMBL::Analysis object (optional)
634
635
636
637
  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
638
               If Arg[1] is defined, does it only for the given analysis.
639
  Exceptions : none
640
  Caller     : beekeepers and other external processes
641
642
643

=cut

644
sub get_num_needed_workers {
645
  my $self = shift;
646
  my $analysis = shift;
647

648
  my $statsDBA = $self->db->get_AnalysisStatsAdaptor;
649
  my $neededAnals = $statsDBA->fetch_by_needed_workers(undef,$self->{maximise_concurrency});
650
651
652
  my $deeper_stats_list = $statsDBA->fetch_by_status('LOADING', 'BLOCKED');
  push @$neededAnals, @$deeper_stats_list;

653
  return 0 unless($neededAnals);
654

655
656
657
658
659
  my $availableLoad = 1.0 - $self->get_hive_current_load();
  return 0 if($availableLoad <0.0);

  my $numWorkers = 0;
  foreach my $analysis_stats (@{$neededAnals}) {
660
661
    next if (defined $analysis && $analysis->dbID != $analysis_stats->analysis_id);

662
663
    #$analysis_stats->print_stats();

664
665
666
667
668
669
670
671
    #digging deeper under the surface so need to sync
    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);

672
673
674
675
676
677
    my $thisLoad = 0.0;
    if($analysis_stats->hive_capacity>0) {
      $thisLoad = $analysis_stats->num_required_workers * (1/$analysis_stats->hive_capacity);
    }

    if(($analysis_stats->hive_capacity<=0) or ($thisLoad < $availableLoad)) {
678
679
680
      $numWorkers += $analysis_stats->num_required_workers;
      $availableLoad -= $thisLoad;
      $analysis_stats->print_stats();
681
      printf("  %5d workers (%1.3f remaining-hive-load)\n", $numWorkers, $availableLoad);
682
    } else {
683
      my $workerCount = POSIX::ceil($availableLoad * $analysis_stats->hive_capacity);
684
685
686
      $numWorkers += $workerCount;
      $availableLoad -=  $workerCount * (1/$analysis_stats->hive_capacity);
      $analysis_stats->print_stats();
687
      printf("  %5d workers (%1.3f remaining-hive-load) use only %3d workers\n", $numWorkers, $availableLoad, $workerCount);
688
      last;
689
    }
690
    last if($availableLoad <= 0.0);
691
  }
692

693
  printf("need $numWorkers workers (availLoad=%1.5f)\n", $availableLoad);
694
  return $numWorkers;
695
696
}

697
sub get_hive_progress {
698
  my $self = shift;
Leo Gordon's avatar
Leo Gordon committed
699
  my $sql = "SELECT sum(done_job_count), sum(failed_job_count), sum(total_job_count), ".
700
701
            "sum(unclaimed_job_count * analysis_stats.avg_msec_per_job)/1000/60/60 ".
            "FROM analysis_stats";
702
703
  my $sth = $self->prepare($sql);
  $sth->execute();
704
  my ($done, $failed, $total, $cpuhrs) = $sth->fetchrow_array();
705
  $sth->finish;
706
707
708
709
710
711
712

  $done   ||= 0;
  $failed ||= 0;
  $total  ||= 0;
  my $completed = $total
    ? ((100.0 * ($done+$failed))/$total)
    : 0.0;
713
714
715
  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
716
  return $remaining;
717
718
}

Leo Gordon's avatar
Leo Gordon committed
719
720
721
722
723
sub print_hive_status {
    my ($self, $this_analysis) = @_;

    $self->print_analysis_status($this_analysis);
    $self->print_running_worker_status;
724
725
726
}


Leo Gordon's avatar
Leo Gordon committed
727
728
sub print_analysis_status {
    my ($self, $this_analysis) = @_;
729

Leo Gordon's avatar
Leo Gordon committed
730
731
732
733
    my $list_of_analyses = $this_analysis ? [$this_analysis] : $self->db->get_AnalysisAdaptor->fetch_all;
    foreach my $analysis (sort {$a->dbID <=> $b->dbID} @$list_of_analyses) {
        $analysis->stats->print_stats($self->{'verbose_stats'});
    }
734
735
736
}


Leo Gordon's avatar
Leo Gordon committed
737
sub print_running_worker_status {
738
  my $self = shift;
739

Leo Gordon's avatar
Leo Gordon committed
740
  print "====== Live workers according to Queen:\n";
741
742
743
  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
744
745

  my $total = 0;
746
747
748
749
  my $sth = $self->prepare($sql);
  $sth->execute();
  while((my $logic_name, my $count)=$sth->fetchrow_array()) {
    printf("%20s : %d workers\n", $logic_name, $count);
750
    $total += $count;
751
  }
752
  printf("  %d total workers\n", $total);
Leo Gordon's avatar
Leo Gordon committed
753
  print "===========================\n";
754
  $sth->finish;
755
}
756

757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
=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
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
=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}) {
        $self->register_worker_death($worker);
    }
}

804

Jessica Severin's avatar
Jessica Severin committed
805
806
807
808
809
#
# INTERNAL METHODS
#
###################

810
811
812
813
814
815
sub _pick_best_analysis_for_new_worker {
  my $self = shift;

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

816
  my ($stats) = @{$statsDBA->fetch_by_needed_workers(1,$self->{maximise_concurrency})};
817
818
819
820
821
  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));
  }
822
823

  # ok so no analyses 'need' workers.
824
825
826
  if ($self->get_num_failed_analyses()) {
    return undef;
  }
827
828
829
830
831
832
833
  # 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");
  my $stats_list = $statsDBA->fetch_by_status('LOADING', 'BLOCKED');
  foreach $stats (@$stats_list) {
    #$stats->print_stats();
834
    $self->safe_synchronize_AnalysisStats($stats);
835
836
    #$stats->print_stats();

837
    return $stats if(($stats->status ne 'BLOCKED') and ($stats->num_required_workers > 0));
838
839
  }

840
  ($stats) = @{$statsDBA->fetch_by_needed_workers(1,$self->{maximise_concurrency})};
841
842
843
844
845
846
  return $stats if($stats);

  return undef;
}


Leo Gordon's avatar
Leo Gordon committed
847
=head2 fetch_by_worker_id
Jessica Severin's avatar
Jessica Severin committed
848
849
850

  Arg [1]    : int $id
               the unique database identifier for the feature to be obtained
851
  Example    : $feat = $queen->fetch_by_dbID(1234);
Jessica Severin's avatar
Jessica Severin committed
852
853
854
855
856
857
858
859
  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
860
sub fetch_by_worker_id {
Jessica Severin's avatar
Jessica Severin committed
861
862
863
  my ($self,$id) = @_;

  unless(defined $id) {
864
    throw("fetch_by_dbID must have an id");
Jessica Severin's avatar
Jessica Severin committed
865
866
867
868
  }

  my @tabs = $self->_tables;

Leo Gordon's avatar
Leo Gordon committed
869
  my $constraint = "h.worker_id = $id";
Jessica Severin's avatar
Jessica Severin committed
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
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

  #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
953
  return qw (h.worker_id
Jessica Severin's avatar
Jessica Severin committed
954
             h.analysis_id
955
             h.beekeeper
Jessica Severin's avatar
Jessica Severin committed
956
957
958
             h.host
             h.process_id
             h.work_done
959
             h.status
Jessica Severin's avatar
Jessica Severin committed
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
             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
979
    $worker->worker_id($column{'worker_id'});
980
    $worker->beekeeper($column{'beekeeper'});
Jessica Severin's avatar
Jessica Severin committed
981
982
983
    $worker->host($column{'host'});
    $worker->process_id($column{'process_id'});
    $worker->work_done($column{'work_done'});
984
    $worker->status($column{'status'});
Jessica Severin's avatar
Jessica Severin committed
985
986
987
988
    $worker->born($column{'born'});
    $worker->last_check_in($column{'last_check_in'});
    $worker->died($column{'died'});
    $worker->cause_of_death($column{'cause_of_death'});
989
    $worker->queen($self);
Jessica Severin's avatar
Jessica Severin committed
990
991
    $worker->db($self->db);

992
993
    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
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
    }

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

  return \@workers
}

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

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


1;