src/main/java/org/apache/sysds/runtime/util/DependencyTask.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.apache.sysds.runtime.util;

import java.util.List;
import java.util.concurrent.Callable;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Future;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.sysds.runtime.DMLRuntimeException;

public class DependencyTask<E> implements Comparable<DependencyTask<?>>, Callable<E> {
	public static final boolean ENABLE_DEBUG_DATA = false;
	protected static final Log LOG = LogFactory.getLog(DependencyTask.class.getName());

	private final Callable<E> _task;
	protected final List<DependencyTask<?>> _dependantTasks;
	public List<DependencyTask<?>> _dependencyTasks = null; // only for debugging
	private CompletableFuture<Future<?>> _future;
	private int _rdy = 0;
	private Integer _priority = 0;
	private ExecutorService _pool;

	public DependencyTask(Callable<E> task, List<DependencyTask<?>> dependantTasks) {
		_dependantTasks = dependantTasks;
		_task = task;
	}

	public void addPool(ExecutorService pool) {
		_pool = pool;
	}

	public void assignFuture(CompletableFuture<Future<?>> f) {
		_future = f;
	}

	public boolean isReady() {
		return _rdy == 0;
	}

	public void setPriority(int priority) {
		_priority = priority;
	}

	private boolean decrease() {
		synchronized(this) {
			_rdy -= 1;
			return isReady();
		}
	}

	public void addDependent(DependencyTask<?> dependencyTask) {
		_dependantTasks.add(dependencyTask);
		dependencyTask._rdy += 1;
	}

	@Override
	public E call() throws Exception {
		LOG.debug("Executing Task: " + this);
		long t0 = System.nanoTime();
		E ret = _task.call();
		LOG.debug("Finished Task: " + this + " in: " +
				(String.format("%.3f", (System.nanoTime()-t0)*1e-9)) + "sec.");
		_dependantTasks.forEach(t -> {
			if(t.decrease()) {
				if(_pool == null)
					throw new DMLRuntimeException("ExecutorService was not set for DependencyTask");
				t._future.complete(_pool.submit(t));
			}
		});

		return ret;
	}

	@Override
	public String toString(){
		return _task.toString() + "<Prio: " + _priority + ">" + "<Waiting: " + _dependantTasks.size() + ">";
	}

	@Override
	public int compareTo(DependencyTask<?> task) {
		return -1 * this._priority.compareTo(task._priority);
	}
}