hadoop ErasureCoder 源码

haddop ErasureCoder 代码

文件路径：/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/erasurecode/coder/ErasureCoder.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.hadoop.io.erasurecode.coder;

import org.apache.hadoop.classification.InterfaceAudience;
import org.apache.hadoop.conf.Configurable;
import org.apache.hadoop.io.erasurecode.ECBlockGroup;
import org.apache.hadoop.io.erasurecode.ErasureCoderOptions;

/**
 * An erasure coder to perform encoding or decoding given a group. Generally it
 * involves calculating necessary internal steps according to codec logic. For
 * each step,it calculates necessary input blocks to read chunks from and output
 * parity blocks to write parity chunks into from the group. It also takes care
 * of appropriate raw coder to use for the step. And encapsulates all the
 * necessary info (input blocks, output blocks and raw coder) into a step
 * represented by {@link ErasureCodingStep}. ErasureCoder callers can use the
 * step to do the real work with retrieved input and output chunks.
 *
 * Note, currently only one coding step is supported. Will support complex cases
 * of multiple coding steps.
 *
 */
@InterfaceAudience.Private
public interface ErasureCoder extends Configurable {

  /**
   * The number of data input units for the coding. A unit can be a byte, chunk
   * or buffer or even a block.
   * @return count of data input units
   */
  int getNumDataUnits();

  /**
   * The number of parity output units for the coding. A unit can be a byte,
   * chunk, buffer or even a block.
   * @return count of parity output units
   */
  int getNumParityUnits();

  /**
   * The options of erasure coder. This option is passed to
   * raw erasure coder as it is.
   * @return erasure coder options
   */
  ErasureCoderOptions getOptions();

  /**
   * Calculate the encoding or decoding steps given a block blockGroup.
   *
   * Note, currently only one coding step is supported. Will support complex
   * cases of multiple coding steps.
   *
   * @param blockGroup the erasure coding block group containing all necessary
   *                   information for codec calculation
   * @return ErasureCodingStep.
   */
  ErasureCodingStep calculateCoding(ECBlockGroup blockGroup);

  /**
   * Tell if direct or off-heap buffer is preferred or not. It's for callers to
   * decide how to allocate coding chunk buffers, either on heap or off heap.
   * It will return false by default.
   * @return true if direct buffer is preferred for performance consideration,
   * otherwise false.
   */
  boolean preferDirectBuffer();

  /**
   * Release the resources if any. Good chance to invoke
   * RawErasureCoder#release.
   */
  void release();
}

相关信息

hadoop 源码目录

相关文章

hadoop DummyErasureDecoder 源码

hadoop DummyErasureEncoder 源码

hadoop ErasureCodingStep 源码

hadoop ErasureDecoder 源码

hadoop ErasureDecodingStep 源码

hadoop ErasureEncoder 源码

hadoop ErasureEncodingStep 源码

hadoop HHErasureCodingStep 源码

hadoop HHXORErasureDecoder 源码

hadoop HHXORErasureDecodingStep 源码