org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy

Class AbstractComparatorOrderingPolicy<S extends SchedulableEntity>

java.lang.Object

org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy.AbstractComparatorOrderingPolicy<S>

All Implemented Interfaces:

OrderingPolicy<S>

Direct Known Subclasses:

FairOrderingPolicy, FifoOrderingPolicy, FifoOrderingPolicyForPendingApps

public abstract class AbstractComparatorOrderingPolicy<S extends SchedulableEntity>
extends Object
implements OrderingPolicy<S>

An OrderingPolicy which can serve as a baseclass for policies which can be expressed in terms of comparators

Field Summary

Fields

Modifier and Type	Field and Description
protected Comparator<SchedulableEntity>	comparator
protected Map<String,S>	entitiesToReorder
protected TreeSet<S>	schedulableEntities

Constructor Summary

Constructors

Constructor and Description
AbstractComparatorOrderingPolicy()

Method Summary

Modifier and Type	Method and Description
void	addAllSchedulableEntities(Collection<S> sc) Add a collection of SchedulableEntities to be managed for allocation and preemption ordering
void	addSchedulableEntity(S s) Add a SchedulableEntity to be managed for allocation and preemption ordering
abstract void	configure(Map<String,String> conf) Provides configuration information for the policy from the scheduler configuration
abstract void	containerAllocated(S schedulableEntity, RMContainer r) The passed SchedulableEntity has been allocated the passed Container, take appropriate action (depending on comparator, a reordering of the SchedulableEntity may be required)
abstract void	containerReleased(S schedulableEntity, RMContainer r) The passed SchedulableEntity has released the passed Container, take appropriate action (depending on comparator, a reordering of the SchedulableEntity may be required)
abstract void	demandUpdated(S schedulableEntity) Demand Updated for the passed schedulableEntity, reorder if needed.
protected void	entityRequiresReordering(S schedulableEntity)
Iterator<S>	getAssignmentIterator() Return an iterator over the collection of SchedulableEntities which orders them for container assignment
Comparator<SchedulableEntity>	getComparator()
abstract String	getInfo() Display information regarding configuration and status
int	getNumSchedulableEntities() Get the number of SchedulableEntities managed for allocation and preemption ordering
Iterator<S>	getPreemptionIterator() Return an iterator over the collection of SchedulableEntities which orders them for preemption
Collection<S>	getSchedulableEntities() Get the collection of SchedulableEntities which are managed by this OrderingPolicy - should include processes returned by the Assignment and Preemption iterator with no guarantees regarding order
boolean	removeSchedulableEntity(S s) Remove a SchedulableEntity from management for allocation and preemption ordering
protected void	reorderSchedulableEntity(S schedulableEntity)
protected void	reorderScheduleEntities()
static void	updateSchedulingResourceUsage(ResourceUsage ru)

Methods inherited from class java.lang.Object

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

Field Detail

schedulableEntities

protected TreeSet<S extends SchedulableEntity> schedulableEntities

comparator

protected Comparator<SchedulableEntity> comparator

entitiesToReorder

protected Map<String,S extends SchedulableEntity> entitiesToReorder

Constructor Detail

AbstractComparatorOrderingPolicy

public AbstractComparatorOrderingPolicy()

Method Detail

getSchedulableEntities

public Collection<S> getSchedulableEntities()

Description copied from interface: OrderingPolicy

Get the collection of SchedulableEntities which are managed by this OrderingPolicy - should include processes returned by the Assignment and Preemption iterator with no guarantees regarding order

Specified by:

getSchedulableEntities in interface OrderingPolicy<S extends SchedulableEntity>

getAssignmentIterator

public Iterator<S> getAssignmentIterator()

Description copied from interface: OrderingPolicy

Return an iterator over the collection of SchedulableEntities which orders them for container assignment

Specified by:

getAssignmentIterator in interface OrderingPolicy<S extends SchedulableEntity>

getPreemptionIterator

public Iterator<S> getPreemptionIterator()

Description copied from interface: OrderingPolicy

Return an iterator over the collection of SchedulableEntities which orders them for preemption

Specified by:

getPreemptionIterator in interface OrderingPolicy<S extends SchedulableEntity>

updateSchedulingResourceUsage

public static void updateSchedulingResourceUsage(ResourceUsage ru)

reorderSchedulableEntity

protected void reorderSchedulableEntity(S schedulableEntity)

reorderScheduleEntities

protected void reorderScheduleEntities()

entityRequiresReordering

protected void entityRequiresReordering(S schedulableEntity)

getComparator

public Comparator<SchedulableEntity> getComparator()

addSchedulableEntity

public void addSchedulableEntity(S s)

Description copied from interface: OrderingPolicy

Add a SchedulableEntity to be managed for allocation and preemption ordering

Specified by:

addSchedulableEntity in interface OrderingPolicy<S extends SchedulableEntity>

removeSchedulableEntity

public boolean removeSchedulableEntity(S s)

Description copied from interface: OrderingPolicy

Remove a SchedulableEntity from management for allocation and preemption ordering

Specified by:

removeSchedulableEntity in interface OrderingPolicy<S extends SchedulableEntity>

addAllSchedulableEntities

public void addAllSchedulableEntities(Collection<S> sc)

Description copied from interface: OrderingPolicy

Add a collection of SchedulableEntities to be managed for allocation and preemption ordering

Specified by:

addAllSchedulableEntities in interface OrderingPolicy<S extends SchedulableEntity>

getNumSchedulableEntities

public int getNumSchedulableEntities()

Description copied from interface: OrderingPolicy

Get the number of SchedulableEntities managed for allocation and preemption ordering

Specified by:

getNumSchedulableEntities in interface OrderingPolicy<S extends SchedulableEntity>

configure

public abstract void configure(Map<String,String> conf)

Description copied from interface: OrderingPolicy

Provides configuration information for the policy from the scheduler configuration

Specified by:

configure in interface OrderingPolicy<S extends SchedulableEntity>

containerAllocated

public abstract void containerAllocated(S schedulableEntity,
                                        RMContainer r)

Description copied from interface: OrderingPolicy

The passed SchedulableEntity has been allocated the passed Container, take appropriate action (depending on comparator, a reordering of the SchedulableEntity may be required)

Specified by:

containerAllocated in interface OrderingPolicy<S extends SchedulableEntity>

containerReleased

public abstract void containerReleased(S schedulableEntity,
                                       RMContainer r)

Description copied from interface: OrderingPolicy

The passed SchedulableEntity has released the passed Container, take appropriate action (depending on comparator, a reordering of the SchedulableEntity may be required)

Specified by:

containerReleased in interface OrderingPolicy<S extends SchedulableEntity>

demandUpdated

public abstract void demandUpdated(S schedulableEntity)

Description copied from interface: OrderingPolicy

Demand Updated for the passed schedulableEntity, reorder if needed.

Specified by:

demandUpdated in interface OrderingPolicy<S extends SchedulableEntity>

getInfo

public abstract String getInfo()

Description copied from interface: OrderingPolicy

Display information regarding configuration and status

Specified by:

getInfo in interface OrderingPolicy<S extends SchedulableEntity>