common/src/main/java/org/apache/uniffle/common/ShuffleBlockInfo.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.uniffle.common;

import java.util.List;

import io.netty.buffer.ByteBuf;
import io.netty.buffer.Unpooled;

import org.apache.uniffle.common.util.ByteBufUtils;

public class ShuffleBlockInfo {

  private int partitionId;
  private long blockId;
  private int length;
  private int shuffleId;
  private long crc;
  private long taskAttemptId;
  private ByteBuf data;
  private List<ShuffleServerInfo> shuffleServerInfos;
  private int uncompressLength;
  private long freeMemory;

  public ShuffleBlockInfo(
      int shuffleId,
      int partitionId,
      long blockId,
      int length,
      long crc,
      byte[] data,
      List<ShuffleServerInfo> shuffleServerInfos,
      int uncompressLength,
      long freeMemory,
      long taskAttemptId) {
    this(
        shuffleId,
        partitionId,
        blockId,
        length,
        crc,
        Unpooled.wrappedBuffer(data),
        shuffleServerInfos,
        uncompressLength,
        freeMemory,
        taskAttemptId);
  }

  public ShuffleBlockInfo(
      int shuffleId,
      int partitionId,
      long blockId,
      int length,
      long crc,
      ByteBuf data,
      List<ShuffleServerInfo> shuffleServerInfos,
      int uncompressLength,
      long freeMemory,
      long taskAttemptId) {
    this.partitionId = partitionId;
    this.blockId = blockId;
    this.length = length;
    this.crc = crc;
    this.data = data;
    this.shuffleId = shuffleId;
    this.shuffleServerInfos = shuffleServerInfos;
    this.uncompressLength = uncompressLength;
    this.freeMemory = freeMemory;
    this.taskAttemptId = taskAttemptId;
  }

  public long getBlockId() {
    return blockId;
  }

  public int getLength() {
    return length;
  }

  // calculate the data size for this block in memory including metadata which are
  // partitionId, blockId, crc, taskAttemptId, length, uncompressLength
  public int getSize() {
    return length + 3 * 8 + 2 * 4;
  }

  public long getCrc() {
    return crc;
  }

  public ByteBuf getData() {
    return data;
  }

  public int getShuffleId() {
    return shuffleId;
  }

  public int getPartitionId() {
    return partitionId;
  }

  public List<ShuffleServerInfo> getShuffleServerInfos() {
    return shuffleServerInfos;
  }

  public int getUncompressLength() {
    return uncompressLength;
  }

  public long getFreeMemory() {
    return freeMemory;
  }

  public long getTaskAttemptId() {
    return taskAttemptId;
  }

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("ShuffleBlockInfo:");
    sb.append("shuffleId[" + shuffleId + "],");
    sb.append("partitionId[" + partitionId + "],");
    sb.append("blockId[" + blockId + "],");
    sb.append("length[" + length + "],");
    sb.append("uncompressLength[" + uncompressLength + "],");
    sb.append("crc[" + crc + "],");
    if (shuffleServerInfos != null) {
      sb.append("shuffleServer[");
      for (ShuffleServerInfo ssi : shuffleServerInfos) {
        sb.append(ssi.getId() + ",");
      }
      sb.append("]");
    } else {
      sb.append("shuffleServer is empty");
    }

    return sb.toString();
  }

  public synchronized void copyDataTo(ByteBuf to) {
    ByteBufUtils.copyByteBuf(data, to);
  }
}