org.apache.flink.runtime.jobmaster.slotpool.SlotProvider Maven / Gradle / Ivy

/*
 * 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.jobmaster.slotpool;

import org.apache.flink.api.common.time.Time;
import org.apache.flink.runtime.clusterframework.types.SlotProfile;
import org.apache.flink.runtime.instance.SlotSharingGroupId;
import org.apache.flink.runtime.jobmanager.scheduler.CoLocationConstraint;
import org.apache.flink.runtime.jobmanager.scheduler.ScheduledUnit;
import org.apache.flink.runtime.jobmaster.LogicalSlot;
import org.apache.flink.runtime.jobmaster.SlotRequestId;
import org.apache.flink.runtime.messages.Acknowledge;

import javax.annotation.Nullable;

import java.util.List;
import java.util.concurrent.CompletableFuture;

/**
 * The slot provider is responsible for preparing slots for ready-to-run tasks.
 *
 * It supports two allocating modes:
 * 

 *     Immediate allocating: A request for a task slot immediately gets satisfied, we can call
 *         {@link CompletableFuture#getNow(Object)} to get the allocated slot.
 *     Queued allocating: A request for a task slot is queued and returns a future that will be
 *         fulfilled as soon as a slot becomes available.
 * 
 */
public interface SlotProvider {

	/**
	 * Allocating slot with specific requirement.
	 *
	 * @param slotRequestId identifying the slot request
	 * @param task The task to allocate the slot for
	 * @param allowQueued Whether allow the task be queued if we do not have enough resource
	 * @param slotProfile profile of the requested slot
	 * @param timeout after which the allocation fails with a timeout exception
	 * @return The future of the allocation
	 */
	CompletableFuture allocateSlot(
		SlotRequestId slotRequestId,
		ScheduledUnit task,
		boolean allowQueued,
		SlotProfile slotProfile,
		Time timeout);

	/**
	 * Batch allocating slots with specific requirements.
	 *
	 * @param slotRequestIds identifying the slot requests
	 * @param tasks The tasks to allocate the slots for
	 * @param allowQueued Whether allow the task be queued if we do not have enough resource
	 * @param slotProfiles profiles of the requested slot
	 * @param timeout after which the allocation fails with a timeout exception
	 * @return The future of the allocation
	 */
	List> allocateSlots(
		List slotRequestIds,
		List tasks,
		boolean allowQueued,
		List slotProfiles,
		Time timeout);

	/**
	 * Allocating slot with specific requirement.
	 *
	 * @param task The task to allocate the slot for
	 * @param allowQueued Whether allow the task be queued if we do not have enough resource
	 * @param slotProfile profile of the requested slot
	 * @param timeout after which the allocation fails with a timeout exception
	 * @return The future of the allocation
	 */
	default CompletableFuture allocateSlot(
		ScheduledUnit task,
		boolean allowQueued,
		SlotProfile slotProfile,
		Time timeout) {
		return allocateSlot(
			new SlotRequestId(),
			task,
			allowQueued,
			slotProfile,
			timeout);
	}

	/**
	 * Cancels the slot request with the given {@link SlotRequestId} and {@link SlotSharingGroupId}.
	 *
	 * @param slotRequestId identifying the slot request to cancel
	 * @param slotSharingGroupId identifying the slot request to cancel
	 * @param cause of the cancellation
	 * @return Future which is completed once the slot request has been cancelled
	 */
	CompletableFuture cancelSlotRequest(
		SlotRequestId slotRequestId,
		@Nullable SlotSharingGroupId slotSharingGroupId,
		@Nullable CoLocationConstraint coLocationConstraint,
		Throwable cause);
}