Package 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	Description
protected Comparator<SchedulableEntity>	comparator
protected Map<String,S>	entitiesToReorder
protected ConcurrentSkipListSet<S>	schedulableEntities

Constructor Summary

Constructors

Constructor	Description
AbstractComparatorOrderingPolicy()

Method Summary

Modifier and Type	Method	Description
void	addAllSchedulableEntities(Collection<S> sc)	Add a collection of SchedulableEntity objects 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)	Notify the OrderingPolicy that the SchedulableEntity has been allocated the given RMContainer, enabling the OrderingPolicy to take appropriate action.
abstract void	containerReleased(S schedulableEntity, RMContainer r)	Notify the OrderingPolicy that the SchedulableEntity has released the given RMContainer, enabling the OrderingPolicy to take appropriate action.
abstract void	demandUpdated(S schedulableEntity)	Notify the OrderingPolicy that the demand for the SchedulableEntity has been updated, enabling the OrderingPolicy to reorder the SchedulableEntity if needed.
protected void	entityRequiresReordering(S schedulableEntity)
Iterator<S>	getAssignmentIterator(IteratorSelector sel)	Return an iterator over the collection of SchedulableEntity objects which orders them for container assignment.
Comparator<SchedulableEntity>	getComparator()
abstract String	getConfigName()	Return configuration name (which will be used to set ordering policy).
abstract String	getInfo()	Return information regarding configuration and status.
int	getNumSchedulableEntities()	Get the number of SchedulableEntity objects managed for allocation and preemption ordering.
Iterator<S>	getPreemptionIterator()	Return an iterator over the collection of SchedulableEntity objects which orders them for preemption.
Collection<S>	getSchedulableEntities()	Get the collection of SchedulableEntity Objects 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 Details

schedulableEntities

protected ConcurrentSkipListSet<S extends SchedulableEntity> schedulableEntities

comparator

protected Comparator<SchedulableEntity> comparator

entitiesToReorder

protected Map<String,S extends SchedulableEntity> entitiesToReorder

Constructor Details

AbstractComparatorOrderingPolicy

public AbstractComparatorOrderingPolicy()

Method Details

getSchedulableEntities

public Collection<S> getSchedulableEntities()

Description copied from interface: OrderingPolicy

Get the collection of SchedulableEntity Objects 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>

Returns:

a collection of SchedulableEntity objects

getAssignmentIterator

public Iterator<S> getAssignmentIterator(IteratorSelector sel)

Description copied from interface: OrderingPolicy

Return an iterator over the collection of SchedulableEntity objects which orders them for container assignment.

Specified by:

getAssignmentIterator in interface OrderingPolicy<S extends SchedulableEntity>

Parameters:

sel - the IteratorSelector to filter with

Returns:

an iterator over the collection of SchedulableEntity objects

getPreemptionIterator

public Iterator<S> getPreemptionIterator()

Description copied from interface: OrderingPolicy

Return an iterator over the collection of SchedulableEntity objects which orders them for preemption.

Specified by:

getPreemptionIterator in interface OrderingPolicy<S extends SchedulableEntity>

Returns:

an iterator over the collection of 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>

Parameters:

s - the SchedulableEntity to add

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>

Parameters:

s - the SchedulableEntity to remove

Returns:

whether the SchedulableEntity was present before this operation

addAllSchedulableEntities

public void addAllSchedulableEntities(Collection<S> sc)

Description copied from interface: OrderingPolicy

Add a collection of SchedulableEntity objects to be managed for allocation and preemption ordering.

Specified by:

addAllSchedulableEntities in interface OrderingPolicy<S extends SchedulableEntity>

Parameters:

sc - the collection of SchedulableEntity objects to add

getNumSchedulableEntities

public int getNumSchedulableEntities()

Description copied from interface: OrderingPolicy

Get the number of SchedulableEntity objects managed for allocation and preemption ordering.

Specified by:

getNumSchedulableEntities in interface OrderingPolicy<S extends SchedulableEntity>

Returns:

the number of SchedulableEntity objects

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>

Parameters:

conf - a map of scheduler configuration properties and values

containerAllocated

public abstract void containerAllocated(S schedulableEntity,
 RMContainer r)

Description copied from interface: OrderingPolicy

Notify the OrderingPolicy that the SchedulableEntity has been allocated the given RMContainer, enabling the OrderingPolicy to take appropriate action. Depending on the comparator, a reordering of the SchedulableEntity may be required.

Specified by:

containerAllocated in interface OrderingPolicy<S extends SchedulableEntity>

Parameters:

schedulableEntity - the SchedulableEntity

r - the allocated RMContainer

containerReleased

public abstract void containerReleased(S schedulableEntity,
 RMContainer r)

Description copied from interface: OrderingPolicy

Notify the OrderingPolicy that the SchedulableEntity has released the given RMContainer, enabling the OrderingPolicy to take appropriate action. Depending on the comparator, a reordering of the SchedulableEntity may be required.

Specified by:

containerReleased in interface OrderingPolicy<S extends SchedulableEntity>

Parameters:

schedulableEntity - the SchedulableEntity

r - the released RMContainer

demandUpdated

public abstract void demandUpdated(S schedulableEntity)

Description copied from interface: OrderingPolicy

Notify the OrderingPolicy that the demand for the SchedulableEntity has been updated, enabling the OrderingPolicy to reorder the SchedulableEntity if needed.

Specified by:

demandUpdated in interface OrderingPolicy<S extends SchedulableEntity>

Parameters:

schedulableEntity - the updated SchedulableEntity

getInfo

public abstract String getInfo()

Description copied from interface: OrderingPolicy

Return information regarding configuration and status.

Specified by:

getInfo in interface OrderingPolicy<S extends SchedulableEntity>

Returns:

configuration and status information

getConfigName

public abstract String getConfigName()

Description copied from interface: OrderingPolicy

Return configuration name (which will be used to set ordering policy).

Specified by:

getConfigName in interface OrderingPolicy<S extends SchedulableEntity>

Returns:

configuration name