org.apache.flink.runtime.shuffle.PartitionDescriptor Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of flink-runtime_2.11 Show documentation
There is a newer version: 1.13.6
/*
 * 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.flink.runtime.shuffle;

import org.apache.flink.annotation.VisibleForTesting;
import org.apache.flink.runtime.executiongraph.ExecutionEdge;
import org.apache.flink.runtime.executiongraph.IntermediateResult;
import org.apache.flink.runtime.executiongraph.IntermediateResultPartition;
import org.apache.flink.runtime.io.network.partition.ResultPartitionType;
import org.apache.flink.runtime.jobgraph.IntermediateDataSetID;
import org.apache.flink.runtime.jobgraph.IntermediateResultPartitionID;

import java.io.Serializable;
import java.util.List;

import static org.apache.flink.util.Preconditions.checkArgument;
import static org.apache.flink.util.Preconditions.checkNotNull;

/**
 * Partition descriptor for {@link ShuffleMaster} to obtain {@link ShuffleDescriptor}.
 */
public class PartitionDescriptor implements Serializable {

	private static final long serialVersionUID = 6343547936086963705L;

	/** The ID of the result this partition belongs to. */
	private final IntermediateDataSetID resultId;

	/** The total number of partitions for the result. */
	private final int totalNumberOfPartitions;

	/** The ID of the partition. */
	private final IntermediateResultPartitionID partitionId;

	/** The type of the partition. */
	private final ResultPartitionType partitionType;

	/** The number of subpartitions. */
	private final int numberOfSubpartitions;

	/** Connection index to identify this partition of intermediate result. */
	private final int connectionIndex;

	@VisibleForTesting
	public PartitionDescriptor(
			IntermediateDataSetID resultId,
			int totalNumberOfPartitions,
			IntermediateResultPartitionID partitionId,
			ResultPartitionType partitionType,
			int numberOfSubpartitions,
			int connectionIndex) {
		this.resultId = checkNotNull(resultId);
		checkArgument(totalNumberOfPartitions >= 1);
		this.totalNumberOfPartitions = totalNumberOfPartitions;
		this.partitionId = checkNotNull(partitionId);
		this.partitionType = checkNotNull(partitionType);
		checkArgument(numberOfSubpartitions >= 1);
		this.numberOfSubpartitions = numberOfSubpartitions;
		this.connectionIndex = connectionIndex;
	}

	public IntermediateDataSetID getResultId() {
		return resultId;
	}

	public int getTotalNumberOfPartitions() {
		return totalNumberOfPartitions;
	}

	public IntermediateResultPartitionID getPartitionId() {
		return partitionId;
	}

	public ResultPartitionType getPartitionType() {
		return partitionType;
	}

	public int getNumberOfSubpartitions() {
		return numberOfSubpartitions;
	}

	int getConnectionIndex() {
		return connectionIndex;
	}

	@Override
	public String toString() {
		return String.format(
			"PartitionDescriptor [result id: %s, partition id: %s, partition type: %s, " +
				"subpartitions: %d, connection index: %d]",
			resultId,
			partitionId,
			partitionType,
			numberOfSubpartitions,
			connectionIndex);
	}

	public static PartitionDescriptor from(IntermediateResultPartition partition) {
		checkNotNull(partition);

		// The produced data is partitioned among a number of subpartitions.
		//
		// If no consumers are known at this point, we use a single subpartition, otherwise we have
		// one for each consuming sub task.
		int numberOfSubpartitions = 1;
		List> consumers = partition.getConsumers();
		if (!consumers.isEmpty() && !consumers.get(0).isEmpty()) {
			if (consumers.size() > 1) {
				throw new IllegalStateException("Currently, only a single consumer group per partition is supported.");
			}
			numberOfSubpartitions = consumers.get(0).size();
		}
		IntermediateResult result = partition.getIntermediateResult();
		return new PartitionDescriptor(
			result.getId(),
			partition.getIntermediateResult().getNumberOfAssignedPartitions(),
			partition.getPartitionId(),
			result.getResultType(),
			numberOfSubpartitions,
			result.getConnectionIndex());
	}
}