org.apache.hadoop.tools.util.ProducerConsumer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hadoop-distcp
Apache Hadoop Distributed Copy
There is a newer version: 3.4.1
/**
 * 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.hadoop.tools.util;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.LinkedBlockingQueue;
import java.util.concurrent.atomic.AtomicInteger;

/**
 * ProducerConsumer class encapsulates input and output queues and a
 * thread-pool of Workers that loop on WorkRequest{@literal } inputQueue
 * and for each consumed WorkRequest Workers invoke
 * WorkRequestProcessor.processItem() and output resulting
 * WorkReport{@literal } to the outputQueue.
 */
public class ProducerConsumer {
  private Log LOG = LogFactory.getLog(ProducerConsumer.class);
  private LinkedBlockingQueue> inputQueue;
  private LinkedBlockingQueue> outputQueue;
  private ExecutorService executor;
  private AtomicInteger workCnt;

  /**
   *  ProducerConsumer maintains input and output queues and a thread-pool of
   *  workers.
   *
   *  @param numThreads   Size of thread-pool to execute Workers.
   */
  public ProducerConsumer(int numThreads) {
    this.inputQueue = new LinkedBlockingQueue<>();
    this.outputQueue = new LinkedBlockingQueue<>();
    executor = Executors.newFixedThreadPool(numThreads);
    workCnt = new AtomicInteger(0);
  }

  /**
   *  Add another worker that will consume WorkRequest{@literal } items
   *  from input queue, process each item using supplied processor, and for
   *  every processed item output WorkReport{@literal } to output queue.
   *
   *  @param processor  Processor implementing WorkRequestProcessor interface.
   *
   */
  public void addWorker(WorkRequestProcessor processor) {
    executor.execute(new Worker(processor));
  }

  /**
   *  Shutdown ProducerConsumer worker thread-pool without waiting for
   *  completion of any pending work.
   */
  public void shutdown() {
    if (hasWork()) {
      LOG.warn("Shutdown() is called but there are still unprocessed work!");
    }
    executor.shutdownNow();
  }

  /**
   *  Returns number of pending ProducerConsumer items (submitted to input
   *  queue for processing via put() method but not yet consumed by take()
   *  or blockingTake().
   *
   *  @return  Number of items in ProducerConsumer (either pending for
   *           processing or waiting to be consumed).
   */
  public int getWorkCnt() {
    return workCnt.get();
  }

  /**
   *  Returns true if there are items in ProducerConsumer that are either
   *  pending for processing or waiting to be consumed.
   *
   *  @return  True if there were more items put() to ProducerConsumer than
   *           consumed by take() or blockingTake().
   */
  public boolean hasWork() {
    return workCnt.get() > 0;
  }

  /**
   *  Blocking put workRequest to ProducerConsumer input queue.
   *
   *  @param  workRequest item to be processed.
   */
  public void put(WorkRequest workRequest) {
    boolean isDone = false;
    while (!isDone) {
      try {
        inputQueue.put(workRequest);
        workCnt.incrementAndGet();
        isDone = true;
      } catch (InterruptedException ie) {
        LOG.error("Could not put workRequest into inputQueue. Retrying...");
      }
    }
  }

  /**
   *  Blocking take from ProducerConsumer output queue that can be interrupted.
   *
   *  @throws InterruptedException if interrupted before an element becomes
   *  available.
   *  @return  item returned by processor's processItem().
   */
  public WorkReport take() throws InterruptedException {
    WorkReport report = outputQueue.take();
    workCnt.decrementAndGet();
    return report;
  }

  /**
   *  Blocking take from ProducerConsumer output queue (catches exceptions and
   *  retries forever).
   *
   *  @return  item returned by processor's processItem().
   */
  public WorkReport blockingTake() {
    while (true) {
      try {
        WorkReport report = outputQueue.take();
        workCnt.decrementAndGet();
        return report;
      } catch (InterruptedException ie) {
        LOG.debug("Retrying in blockingTake...");
      }
    }
  }

  /**
   * Worker thread implementation.
   *
   */
  private class Worker implements Runnable {
    private WorkRequestProcessor processor;

    /**
     * Constructor.
     * @param processor is used to process an item from input queue.
     */
    public Worker(WorkRequestProcessor processor) {
      this.processor = processor;
    }

    /**
     * The worker continuously gets an item from input queue, process it and
     * then put the processed result into output queue. It waits to get an item
     * from input queue if there's none.
     */
    public void run() {
      while (true) {
        WorkRequest work;

        try {
          work = inputQueue.take();
        } catch (InterruptedException e) {
          // It is assumed that if an interrupt occurs while taking a work
          // out from input queue, the interrupt is likely triggered by
          // ProducerConsumer.shutdown(). Therefore, exit the thread.
          LOG.debug("Interrupted while waiting for requests from inputQueue.");
          return;
        }

        boolean isDone = false;
        while (!isDone) {
          try {
            // if the interrupt happens while the work is being processed,
            // go back to process the same work again.
            WorkReport result = processor.processItem(work);
            outputQueue.put(result);
            isDone = true;
          } catch (InterruptedException ie) {
            LOG.debug("Worker thread was interrupted while processing an item,"
                + " or putting into outputQueue. Retrying...");
          }
        }
      }
    }
  }
}