/*
* Eoulsan development code
*
* This code may be freely distributed and modified under the
* terms of the GNU Lesser General Public License version 2.1 or
* later and CeCILL-C. This should be distributed with the code.
* If you do not have a copy, see:
*
* http://www.gnu.org/licenses/lgpl-2.1.txt
* http://www.cecill.info/licences/Licence_CeCILL-C_V1-en.txt
*
* Copyright for this code is held jointly by the Genomic platform
* of the Institut de Biologie de l'École normale supérieure and
* the individual authors. These should be listed in @author doc
* comments.
*
* For more information on the Eoulsan project and its aims,
* or to join the Eoulsan Google group, visit the home page
* at:
*
* http://outils.genomique.biologie.ens.fr/eoulsan
*
*/
package fr.ens.biologie.genomique.eoulsan.core.schedulers;
import static com.google.common.base.Preconditions.checkArgument;
import static com.google.common.base.Preconditions.checkNotNull;
import static com.google.common.base.Preconditions.checkState;
import static fr.ens.biologie.genomique.eoulsan.EoulsanLogger.getLogger;
import java.util.Set;
import fr.ens.biologie.genomique.eoulsan.EoulsanRuntime;
import fr.ens.biologie.genomique.eoulsan.annotations.ExecutionMode;
import fr.ens.biologie.genomique.eoulsan.core.ParallelizationMode;
import fr.ens.biologie.genomique.eoulsan.core.Step;
import fr.ens.biologie.genomique.eoulsan.core.workflow.AbstractStep;
import fr.ens.biologie.genomique.eoulsan.core.workflow.TaskContextImpl;
import fr.ens.biologie.genomique.eoulsan.core.workflow.StepResult;
import fr.ens.biologie.genomique.eoulsan.core.workflow.StepStatus;
/**
* This class defined a combined task scheduler that use several context
* schedulers according to the parallelization mode of the step.
* @author Laurent Jourdren
* @since 2.0
*/
public class CombinedTaskScheduler implements TaskScheduler, Runnable {
private static final int SLEEP_TIME_IN_MS = 200;
private final AbstractTaskScheduler noTaskScheduler;
private final AbstractTaskScheduler stdTaskScheduler;
private final AbstractTaskScheduler ownTaskScheduler;
private final AbstractTaskScheduler hadoopCompatibleTaskScheduler;
private volatile boolean isStarted;
private volatile boolean isStopped;
@Override
public void submit(final Step step, final Set<TaskContextImpl> contexts) {
checkNotNull(contexts, "contexts argument cannot be null");
// Check execution state
checkExecutionState();
for (TaskContextImpl context : contexts) {
submit(step, context);
}
}
@Override
public void submit(final Step step, final TaskContextImpl context) {
checkNotNull(step, "step argument cannot be null");
checkNotNull(context, "context argument cannot be null");
// Check execution state
checkExecutionState();
getTaskScheduler(step).submit(step, context);
}
@Override
public StepStatus getStatus(final Step step) {
checkNotNull(step, "step argument cannot be null");
return getTaskScheduler(step).getStatus(step);
}
@Override
public StepResult getResult(final Step step) {
checkNotNull(step, "step argument cannot be null");
return getTaskScheduler(step).getResult(step);
}
@Override
public int getTaskSubmittedCount(final Step step) {
checkNotNull(step, "step argument cannot be null");
return getTaskScheduler(step).getTaskSubmittedCount(step);
}
@Override
public int getTaskRunningCount(final Step step) {
checkNotNull(step, "step argument cannot be null");
return getTaskScheduler(step).getTaskRunningCount(step);
}
@Override
public int getTaskDoneCount(final Step step) {
checkNotNull(step, "step argument cannot be null");
return getTaskScheduler(step).getTaskDoneCount(step);
}
@Override
public void waitEndOfTasks(final Step step) {
checkNotNull(step, "step argument cannot be null");
// Check execution state
checkExecutionState();
getTaskScheduler(step).waitEndOfTasks(step);
}
@Override
public int getTotalTaskSubmittedCount() {
return this.noTaskScheduler.getTotalTaskSubmittedCount()
+ this.stdTaskScheduler.getTotalTaskSubmittedCount()
+ this.ownTaskScheduler.getTotalTaskSubmittedCount()
+ (this.hadoopCompatibleTaskScheduler != null
? this.hadoopCompatibleTaskScheduler.getTotalTaskRunningCount()
: 0);
}
@Override
public int getTotalTaskRunningCount() {
return this.noTaskScheduler.getTotalTaskRunningCount()
+ this.stdTaskScheduler.getTotalTaskRunningCount()
+ this.ownTaskScheduler.getTotalTaskRunningCount()
+ (this.hadoopCompatibleTaskScheduler != null
? this.hadoopCompatibleTaskScheduler.getTotalTaskRunningCount()
: 0);
}
@Override
public int getTotalTaskDoneCount() {
return this.noTaskScheduler.getTotalTaskDoneCount()
+ this.stdTaskScheduler.getTotalTaskDoneCount()
+ this.ownTaskScheduler.getTotalTaskDoneCount()
+ (this.hadoopCompatibleTaskScheduler != null
? this.hadoopCompatibleTaskScheduler.getTotalTaskDoneCount() : 0);
}
@Override
public void start() {
synchronized (this) {
// Check execution state
checkState(!this.isStopped, "The scheduler is stopped");
this.isStarted = true;
}
this.noTaskScheduler.start();
this.stdTaskScheduler.start();
this.ownTaskScheduler.start();
if (this.hadoopCompatibleTaskScheduler != null) {
this.hadoopCompatibleTaskScheduler.start();
}
// Pause ownTaskScheduler
this.ownTaskScheduler.pause();
// Start the thread
new Thread(this, "TaskScheduler_combined").start();
}
@Override
public void stop() {
// Check execution state
checkExecutionState();
synchronized (this) {
this.isStopped = true;
}
this.noTaskScheduler.stop();
this.stdTaskScheduler.stop();
this.ownTaskScheduler.stop();
if (this.hadoopCompatibleTaskScheduler != null) {
this.hadoopCompatibleTaskScheduler.stop();
}
}
//
// Other method
//
/**
* Check execution state.
*/
private void checkExecutionState() {
synchronized (this) {
checkState(this.isStarted, "The scheduler is not started");
checkState(!this.isStopped, "The scheduler is stopped");
}
}
/**
* Get the parallelization mode of a step.
* @param step the step
* @return the parallelization mode of the step
*/
private static ParallelizationMode getParallelizationMode(final Step step) {
checkNotNull(step, "step argument cannot be null");
return ((AbstractStep) step).getParallelizationMode();
}
/**
* Get the Eoulsan mode of a step.
* @param step the step
* @return the Eoulsan mode of the step
*/
private static ExecutionMode getEoulsanMode(final Step step) {
checkNotNull(step, "step argument cannot be null");
return ((AbstractStep) step).getEoulsanMode();
}
/**
* Get the task scheduler of a step.
* @param step the step
* @return the task scheduler that the step must use
*/
private TaskScheduler getTaskScheduler(final Step step) {
switch (step.getType()) {
case GENERATOR_STEP:
case CHECKER_STEP:
return this.stdTaskScheduler;
default:
break;
}
switch (getParallelizationMode(step)) {
case NOT_NEEDED:
return this.noTaskScheduler;
case STANDARD:
if (this.hadoopCompatibleTaskScheduler == null) {
return this.stdTaskScheduler;
}
return getEoulsanMode(step) == ExecutionMode.HADOOP_COMPATIBLE
? this.hadoopCompatibleTaskScheduler : this.stdTaskScheduler;
case OWN_PARALLELIZATION:
return this.ownTaskScheduler;
default:
throw new IllegalStateException("Unknown Parallelization mode");
}
}
//
// Runnable method
//
@Override
public void run() {
boolean stopped;
synchronized (this) {
stopped = this.isStopped;
}
while (!stopped) {
// Is there some task to do by ownTaskScheduler ?
if (this.ownTaskScheduler.isPaused()
&& this.ownTaskScheduler.getTotalWaitingCount() > 0) {
// If standard scheduler running, pause it
if (!this.stdTaskScheduler.isPaused()) {
this.stdTaskScheduler.pause();
}
// When standard scheduler has finishing current running task resume own
// scheduler
if (this.stdTaskScheduler.getTotalTaskRunningCount() == 0) {
this.ownTaskScheduler.resume();
}
}
if (!this.ownTaskScheduler.isPaused()
&& this.ownTaskScheduler.getTotalTaskRunningCount() == 0
&& this.ownTaskScheduler.getTotalWaitingCount() == 0) {
this.ownTaskScheduler.pause();
this.stdTaskScheduler.resume();
}
// Wait
try {
Thread.sleep(SLEEP_TIME_IN_MS);
} catch (InterruptedException e) {
getLogger().severe(e.getMessage());
}
synchronized (this) {
stopped = this.isStopped;
}
}
}
//
// Constructor
//
/**
* Constructor.
* @param threadNumber number of thread to use by the task scheduler
*/
public CombinedTaskScheduler(final int threadNumber) {
checkArgument(threadNumber > 0, "threadNumber must be > 0");
// Create the schedulers instances
this.stdTaskScheduler = new MultiThreadTaskScheduler(threadNumber);
this.noTaskScheduler = new MonoThreadTaskScheduler();
this.ownTaskScheduler = new MonoThreadTaskScheduler();
this.hadoopCompatibleTaskScheduler =
EoulsanRuntime.getRuntime().getMode().isHadoopMode()
? new HadoopCompatibleTaskScheduler() : null;
}
}