org.apache.hadoop.hdfs.protocol.datatransfer.DataTransferProtoUtil.java Source code

Introduction

Here is the source code for org.apache.hadoop.hdfs.protocol.datatransfer.DataTransferProtoUtil.java

Source

/**
 * 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.hdfs.protocol.datatransfer;

import java.io.IOException;

import org.apache.hadoop.classification.InterfaceAudience;
import org.apache.hadoop.classification.InterfaceStability;
import org.apache.hadoop.hdfs.protocol.ExtendedBlock;
import org.apache.hadoop.hdfs.protocol.proto.DataTransferProtos.BaseHeaderProto;
import org.apache.hadoop.hdfs.protocol.proto.DataTransferProtos.BlockOpResponseProto;
import org.apache.hadoop.hdfs.protocol.proto.DataTransferProtos.ChecksumProto;
import org.apache.hadoop.hdfs.protocol.proto.DataTransferProtos.ClientOperationHeaderProto;
import org.apache.hadoop.hdfs.protocol.proto.DataTransferProtos.DataTransferTraceInfoProto;
import org.apache.hadoop.hdfs.protocol.proto.DataTransferProtos.OpWriteBlockProto;
import org.apache.hadoop.hdfs.protocol.proto.DataTransferProtos.Status;
import org.apache.hadoop.hdfs.protocol.proto.HdfsProtos.ChecksumTypeProto;
import org.apache.hadoop.hdfs.protocolPB.PBHelperClient;
import org.apache.hadoop.hdfs.security.token.block.BlockTokenIdentifier;
import org.apache.hadoop.hdfs.security.token.block.InvalidBlockTokenException;
import org.apache.hadoop.security.token.Token;
import org.apache.hadoop.util.DataChecksum;
import org.apache.htrace.core.SpanId;
import org.apache.htrace.core.Tracer;

/**
 * Static utilities for dealing with the protocol buffers used by the
 * Data Transfer Protocol.
 */
@InterfaceAudience.Private
@InterfaceStability.Evolving
public abstract class DataTransferProtoUtil {
    static BlockConstructionStage fromProto(OpWriteBlockProto.BlockConstructionStage stage) {
        return BlockConstructionStage.valueOf(stage.name());
    }

    static OpWriteBlockProto.BlockConstructionStage toProto(BlockConstructionStage stage) {
        return OpWriteBlockProto.BlockConstructionStage.valueOf(stage.name());
    }

    public static ChecksumProto toProto(DataChecksum checksum) {
        ChecksumTypeProto type = PBHelperClient.convert(checksum.getChecksumType());
        // ChecksumType#valueOf never returns null
        return ChecksumProto.newBuilder().setBytesPerChecksum(checksum.getBytesPerChecksum()).setType(type).build();
    }

    public static DataChecksum fromProto(ChecksumProto proto) {
        if (proto == null) {
            return null;
        }

        int bytesPerChecksum = proto.getBytesPerChecksum();
        DataChecksum.Type type = PBHelperClient.convert(proto.getType());
        return DataChecksum.newDataChecksum(type, bytesPerChecksum);
    }

    static ClientOperationHeaderProto buildClientHeader(ExtendedBlock blk, String client,
            Token<BlockTokenIdentifier> blockToken) {
        return ClientOperationHeaderProto.newBuilder().setBaseHeader(buildBaseHeader(blk, blockToken))
                .setClientName(client).build();
    }

    static BaseHeaderProto buildBaseHeader(ExtendedBlock blk, Token<BlockTokenIdentifier> blockToken) {
        BaseHeaderProto.Builder builder = BaseHeaderProto.newBuilder().setBlock(PBHelperClient.convert(blk))
                .setToken(PBHelperClient.convert(blockToken));
        SpanId spanId = Tracer.getCurrentSpanId();
        if (spanId.isValid()) {
            builder.setTraceInfo(DataTransferTraceInfoProto.newBuilder().setTraceId(spanId.getHigh())
                    .setParentId(spanId.getLow()));
        }
        return builder.build();
    }

    public static SpanId fromProto(DataTransferTraceInfoProto proto) {
        if ((proto != null) && proto.hasTraceId() && proto.hasParentId()) {
            return new SpanId(proto.getTraceId(), proto.getParentId());
        }
        return null;
    }

    public static void checkBlockOpStatus(BlockOpResponseProto response, String logInfo) throws IOException {
        checkBlockOpStatus(response, logInfo, false);
    }

    public static void checkBlockOpStatus(BlockOpResponseProto response, String logInfo,
            boolean checkBlockPinningErr) throws IOException {
        if (response.getStatus() != Status.SUCCESS) {
            if (response.getStatus() == Status.ERROR_ACCESS_TOKEN) {
                throw new InvalidBlockTokenException(
                        "Got access token error" + ", status message " + response.getMessage() + ", " + logInfo);
            } else if (checkBlockPinningErr && response.getStatus() == Status.ERROR_BLOCK_PINNED) {
                throw new BlockPinningException("Got error" + ", status=" + response.getStatus().name()
                        + ", status message " + response.getMessage() + ", " + logInfo);
            } else {
                throw new IOException("Got error" + ", status=" + response.getStatus().name() + ", status message "
                        + response.getMessage() + ", " + logInfo);
            }
        }
    }
}