Package org.apache.flink.runtime.scheduler.adaptive.allocator

Class SlotSharingSlotAllocator

java.lang.Object

org.apache.flink.runtime.scheduler.adaptive.allocator.SlotSharingSlotAllocator

All Implemented Interfaces:

SlotAllocator

public class SlotSharingSlotAllocator
extends Object
implements SlotAllocator

SlotAllocator implementation that supports slot sharing.

Method Summary

Modifier and Type	Method	Description
ResourceCounter	calculateRequiredSlots(Iterable<JobInformation.VertexInformation> vertices)	Calculates the total resources required for scheduling the given vertices.
static SlotSharingSlotAllocator	createSlotSharingSlotAllocator(ReserveSlotFunction reserveSlot, FreeSlotFunction freeSlotFunction, IsSlotAvailableAndFreeFunction isSlotAvailableAndFreeFunction, boolean localRecoveryEnabled, String executionTarget, boolean minimalTaskManagerPreferred)
Optional<VertexParallelism>	determineParallelism(JobInformation jobInformation, Collection<? extends SlotInfo> freeSlots)	Determines the parallelism at which the vertices could be scheduled given the collection of slots.
Optional<JobSchedulingPlan>	determineParallelismAndCalculateAssignment(JobInformation jobInformation, Collection<? extends SlotInfo> slots, JobAllocationsInformation jobAllocationsInformation)	Same as SlotAllocator.determineParallelism(JobInformation, Collection) but additionally determine assignment of slots to execution slot sharing groups.
Optional<ReservedSlots>	tryReserveResources(JobSchedulingPlan jobSchedulingPlan)	Reserves slots according to the given assignment if possible.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createSlotSharingSlotAllocator

public static SlotSharingSlotAllocator createSlotSharingSlotAllocator(ReserveSlotFunction reserveSlot,
                                                                      FreeSlotFunction freeSlotFunction,
                                                                      IsSlotAvailableAndFreeFunction isSlotAvailableAndFreeFunction,
                                                                      boolean localRecoveryEnabled,
                                                                      @Nullable
                                                                      String executionTarget,
                                                                      boolean minimalTaskManagerPreferred)

calculateRequiredSlots

public ResourceCounter calculateRequiredSlots(Iterable<JobInformation.VertexInformation> vertices)

Description copied from interface: SlotAllocator

Calculates the total resources required for scheduling the given vertices.

Specified by:

calculateRequiredSlots in interface SlotAllocator

Parameters:

vertices - vertices to schedule

Returns:

required resources

determineParallelism

public Optional<VertexParallelism> determineParallelism(JobInformation jobInformation,
                                                        Collection<? extends SlotInfo> freeSlots)

Description copied from interface: SlotAllocator

Determines the parallelism at which the vertices could be scheduled given the collection of slots. This method may be called with any number of slots providing any amount of resources, irrespective of what SlotAllocator.calculateRequiredSlots(Iterable) returned.

If a VertexParallelism is returned then it covers all vertices contained in the given job information.

Implementations of this method must be side-effect free. There is no guarantee that the result of this method is ever passed to SlotAllocator.tryReserveResources(JobSchedulingPlan).

Specified by:

determineParallelism in interface SlotAllocator

Parameters:

jobInformation - information about the job graph

freeSlots - slots to consider for determining the parallelism

Returns:

potential parallelism for all vertices and implementation-specific information for how the vertices could be assigned to slots, if all vertices could be run with the given slots

determineParallelismAndCalculateAssignment

public Optional<JobSchedulingPlan> determineParallelismAndCalculateAssignment(JobInformation jobInformation,
                                                                              Collection<? extends SlotInfo> slots,
                                                                              JobAllocationsInformation jobAllocationsInformation)

Description copied from interface: SlotAllocator

Same as SlotAllocator.determineParallelism(JobInformation, Collection) but additionally determine assignment of slots to execution slot sharing groups.

Specified by:

determineParallelismAndCalculateAssignment in interface SlotAllocator

tryReserveResources

public Optional<ReservedSlots> tryReserveResources(JobSchedulingPlan jobSchedulingPlan)

Description copied from interface: SlotAllocator

Reserves slots according to the given assignment if possible. If the underlying set of resources has changed and the reservation with respect to vertexParallelism is no longer possible, then this method returns Optional.empty().

Specified by:

tryReserveResources in interface SlotAllocator

Parameters:

jobSchedulingPlan - information on how slots should be assigned to the slots

Returns:

Set of reserved slots if the reservation was successful; otherwise Optional.empty()