// WorkflowProcessor.java
// (C) 2008 by Michael Peter Christen; mc@yacy.net, Frankfurt a. M., Germany
// first published 27.02.2008 on http://yacy.net
//
// $LastChangedDate$
// $LastChangedRevision$
// $LastChangedBy$
//
// LICENSE
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
package net.yacy.kelondro.workflow;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.concurrent.BlockingQueue;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.LinkedBlockingQueue;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicInteger;
import net.yacy.cora.util.ConcurrentLog;
import net.yacy.kelondro.util.NamePrefixThreadFactory;
public class WorkflowProcessor<J extends WorkflowJob> {
public static final int availableCPU = Runtime.getRuntime().availableProcessors();
private static final ArrayList<WorkflowProcessor<?>> processMonitor = new ArrayList<WorkflowProcessor<?>>();
private ExecutorService executor;
private AtomicInteger executorRunning;
private BlockingQueue<J> input;
private final WorkflowProcessor<J> output;
private final int maxpoolsize;
private final Object environment;
private final String processName, methodName, description;
private final String[] childs;
private long blockTime, execTime, passOnTime;
private long execCount;
public WorkflowProcessor(
final String name, final String description, final String[] childnames,
final Object env, final String jobExecMethod,
final int inputQueueSize, final WorkflowProcessor<J> output,
final int maxpoolsize) {
// start a fixed number of executors that handle entries in the process queue
this.environment = env;
this.processName = name;
this.description = description;
this.methodName = jobExecMethod;
this.childs = childnames;
this.maxpoolsize = maxpoolsize;
this.input = new LinkedBlockingQueue<J>(Math.max(maxpoolsize + 1, inputQueueSize));
this.output = output;
this.executor = Executors.newCachedThreadPool(new NamePrefixThreadFactory(this.methodName));
this.executorRunning = new AtomicInteger(0);
/*
for (int i = 0; i < this.maxpoolsize; i++) {
this.executor.submit(new InstantBlockingThread<J>(this));
this.executorRunning++;
}
*/
// init statistics
this.blockTime = 0;
this.execTime = 0;
this.passOnTime = 0;
this.execCount = 0;
// store this object for easy monitoring
processMonitor.add(this);
}
public Object getEnvironment() {
return this.environment;
}
public String getMethodName() {
return this.methodName;
}
public int getQueueSize() {
if (this.input == null) return 0;
return this.input.size();
}
public boolean queueIsEmpty() {
return this.input == null || this.input.isEmpty();
}
public int getMaxQueueSize() {
if (this.input == null) return 0;
return this.input.size() + this.input.remainingCapacity();
}
public int getMaxConcurrency() {
return this.maxpoolsize;
}
public int getExecutors() {
return this.executorRunning.get();
}
/**
* the decExecutors method may only be called within the AbstractBlockingThread while loop!!
*/
public void decExecutors() {
this.executorRunning.decrementAndGet();
}
public J take() throws InterruptedException {
// read from the input queue
if (this.input == null) {
return null;
}
final long t = System.currentTimeMillis();
final J j = this.input.take();
this.blockTime += System.currentTimeMillis() - t;
return j;
}
public void passOn(final J next) {
// don't mix this method up with enQueue()!
// this method enqueues into the _next_ queue, not this queue!
if (this.output == null) {
return;
}
final long t = System.currentTimeMillis();
this.output.enQueue(next);
this.passOnTime += System.currentTimeMillis() - t;
}
public void clear() {
if (this.input != null) {
this.input.clear();
}
}
private synchronized void relaxCapacity() {
if (this.input.isEmpty()) {
return;
}
if (this.input.remainingCapacity() > 1000) {
return;
}
final BlockingQueue<J> i = new LinkedBlockingQueue<J>();
J e;
while (!this.input.isEmpty()) {
e = this.input.poll();
if (e == null) {
break;
}
i.add(e);
}
this.input = i;
}
@SuppressWarnings("unchecked")
public void enQueue(final J in) {
// ensure that enough job executors are running
if (this.input == null || this.executor == null || this.executor.isShutdown() || this.executor.isTerminated()) {
// execute serialized without extra thread
//Log.logWarning("PROCESSOR", "executing job " + environment.getClass().getName() + "." + methodName + " serialized");
try {
final J out = (J) InstantBlockingThread.execMethod(this.environment, this.methodName).invoke(this.environment, new Object[]{in});
if (out != null && this.output != null) {
this.output.enQueue(out);
}
} catch (final Throwable e) {
ConcurrentLog.logException(e);
}
return;
}
// execute concurrent in thread
while (this.input != null) {
try {
this.input.put(in);
if (this.input.size() > this.executorRunning.get() && this.executorRunning.get() < this.maxpoolsize) synchronized (executor) {
if (this.input.size() > this.executorRunning.get() && this.executorRunning.get() < this.maxpoolsize) {
this.executorRunning.incrementAndGet();
this.executor.submit(new InstantBlockingThread<J>(this));
}
}
break;
} catch (final Throwable e) {
try {Thread.sleep(10);} catch (final InterruptedException ee) {}
}
}
}
@SuppressWarnings("unchecked")
public void shutdown() {
if (this.executor == null) {
return;
}
if (this.executor.isShutdown()) {
return;
}
// before we put pills into the queue, make sure that they will take them
relaxCapacity();
// put poison pills into the queue
for (int i = 0; i < this.executorRunning.get(); i++) {
try {
ConcurrentLog.info("serverProcessor", "putting poison pill in queue " + this.processName + ", thread " + i);
this.input.put((J) WorkflowJob.poisonPill); // put a poison pill into the queue which will kill the job
ConcurrentLog.info("serverProcessor", ".. poison pill is in queue " + this.processName + ", thread " + i + ". awaiting termination");
} catch (final InterruptedException e) { }
}
// wait until input queue is empty
for (int i = 0; i < 10; i++) {
if (this.input.size() <= 0) break;
ConcurrentLog.info("WorkflowProcess", "waiting for queue " + this.processName + " to shut down; input.size = " + this.input.size());
try {Thread.sleep(1000);} catch (final InterruptedException e) {}
}
this.executorRunning.set(0);
// shut down executors
if (this.executor != null & !this.executor.isShutdown()) {
// wait for shutdown
try {
this.executor.shutdown();
for (int i = 0; i < 60; i++) {
this.executor.awaitTermination(1, TimeUnit.SECONDS);
if (this.input.size() <= 0) break;
}
} catch (final InterruptedException e) {}
}
ConcurrentLog.info("serverProcessor", "queue " + this.processName + ": shutdown.");
this.executor = null;
this.input = null;
// remove entry from monitor
final Iterator<WorkflowProcessor<?>> i = processes();
WorkflowProcessor<?> p;
while (i.hasNext()) {
p = i.next();
if (p == this) {
i.remove();
break;
}
}
}
public static Iterator<WorkflowProcessor<?>> processes() {
return processMonitor.iterator();
}
protected void increaseJobTime(final long time) {
this.execTime += time;
this.execCount++;
}
public String getName() {
return this.processName;
}
public String getDescription() {
return this.description;
}
public String getChilds() {
final StringBuilder s = new StringBuilder(this.childs.length * 40 + 1);
for (final String child : this.childs) {
s.append(child);
s.append(' ');
}
return s.toString();
}
/**
* the block time is the time that a take() blocks until it gets a value
* @return
*/
public long getBlockTime() {
return this.blockTime;
}
/**
* the exec time is the complete time of the execution and processing of the value from take()
* @return
*/
public long getExecTime() {
return this.execTime;
}
public long getExecCount() {
return this.execCount;
}
/**
* the passOn time is the time that a put() takes to enqueue a result value to the next queue
* in case that the target queue is limited and may be full, this value may increase
* @return
*/
public long getPassOnTime() {
return this.passOnTime;
}
}