Package org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity

Class ResourceCalculationDriver

java.lang.Object

org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.ResourceCalculationDriver

Direct Known Subclasses:

RootCalculationDriver

public class ResourceCalculationDriver
extends java.lang.Object

Drives the main logic of resource calculation for all children under a queue. Acts as a bookkeeper of disposable update information that is used by all children under the common parent.

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.Map<java.lang.String,ResourceVector>	batchRemainingResourcePerLabel
protected java.util.Map<QueueCapacityVector.ResourceUnitCapacityType,AbstractQueueCapacityCalculator>	calculators
protected java.util.Collection<java.lang.String>	definedResources
protected java.util.Map<java.lang.String,ResourceVector>	normalizedResourceRatioPerLabel
protected java.util.Map<java.lang.String,ResourceVector>	overallRemainingResourcePerLabel
protected CSQueue	queue
protected QueueResourceRoundingStrategy	roundingStrategy
protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Double>>	sumWeightsPerLabel
protected QueueCapacityUpdateContext	updateContext
protected java.util.Map<java.lang.String,java.lang.Double>	usedResourceByCurrentCalculatorPerLabel

Constructor Summary

Constructors

Constructor	Description
ResourceCalculationDriver(CSQueue queue, QueueCapacityUpdateContext updateContext, java.util.Map<QueueCapacityVector.ResourceUnitCapacityType,AbstractQueueCapacityCalculator> calculators, java.util.Collection<java.lang.String> definedResources)

Method Summary

Modifier and Type	Method	Description
void	calculateResources()	Calculates and sets the minimum and maximum effective resources for all children under the parent queue with which this driver was initialized.
ResourceVector	getBatchRemainingResource(java.lang.String label)	Returns the remaining resources of a parent that is still available for its children.
java.util.Collection<CSQueue>	getChildQueues()	Returns all the children defined under the driver parent queue.
java.util.Map<java.lang.String,ResourceVector>	getNormalizedResourceRatios()	Returns the ratio of the summary of children absolute configured resources and the parent's effective minimum resource.
double	getParentAbsoluteMaxCapacity(java.lang.String label, java.lang.String resourceName)	Returns the ratio of the parent queue's effective maximum resource relative to the full cluster resource.
double	getParentAbsoluteMinCapacity(java.lang.String label, java.lang.String resourceName)	Returns the ratio of the parent queue's effective minimum resource relative to the full cluster resource.
CSQueue	getQueue()	Returns the parent that is driving the calculation.
double	getRemainingRatioOfResource(java.lang.String label, java.lang.String resourceName)	Returns the remaining resource ratio under the parent queue.
double	getSumWeightsByResource(java.lang.String label, java.lang.String resourceName)	Returns the aggregated children weights.
QueueCapacityUpdateContext	getUpdateContext()	Returns the context that is used throughout the whole update phase.
void	incrementWeight(java.lang.String label, java.lang.String resourceName, double value)	Increments the aggregated weight.

Methods inherited from class java.lang.Object

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

Field Detail

roundingStrategy

protected final QueueResourceRoundingStrategy roundingStrategy

queue

protected final CSQueue queue

updateContext

protected final QueueCapacityUpdateContext updateContext

calculators

protected final java.util.Map<QueueCapacityVector.ResourceUnitCapacityType,AbstractQueueCapacityCalculator> calculators

definedResources

protected final java.util.Collection<java.lang.String> definedResources

overallRemainingResourcePerLabel

protected final java.util.Map<java.lang.String,ResourceVector> overallRemainingResourcePerLabel

batchRemainingResourcePerLabel

protected final java.util.Map<java.lang.String,ResourceVector> batchRemainingResourcePerLabel

normalizedResourceRatioPerLabel

protected final java.util.Map<java.lang.String,ResourceVector> normalizedResourceRatioPerLabel

sumWeightsPerLabel

protected final java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Double>> sumWeightsPerLabel

usedResourceByCurrentCalculatorPerLabel

protected java.util.Map<java.lang.String,java.lang.Double> usedResourceByCurrentCalculatorPerLabel

Constructor Detail

ResourceCalculationDriver

public ResourceCalculationDriver(CSQueue queue,
                                 QueueCapacityUpdateContext updateContext,
                                 java.util.Map<QueueCapacityVector.ResourceUnitCapacityType,AbstractQueueCapacityCalculator> calculators,
                                 java.util.Collection<java.lang.String> definedResources)

Method Detail

getQueue

public CSQueue getQueue()

Returns the parent that is driving the calculation.

Returns:

a common parent queue

getChildQueues

public java.util.Collection<CSQueue> getChildQueues()

Returns all the children defined under the driver parent queue.

Returns:

child queues

getUpdateContext

public QueueCapacityUpdateContext getUpdateContext()

Returns the context that is used throughout the whole update phase.

Returns:

update context

incrementWeight

public void incrementWeight(java.lang.String label,
                            java.lang.String resourceName,
                            double value)

Increments the aggregated weight.

Parameters:

label - node label

resourceName - resource unit name

value - weight value

getSumWeightsByResource

public double getSumWeightsByResource(java.lang.String label,
                                      java.lang.String resourceName)

Returns the aggregated children weights.

Parameters:

label - node label

resourceName - resource unit name

Returns:

aggregated weights of children

getNormalizedResourceRatios

public java.util.Map<java.lang.String,ResourceVector> getNormalizedResourceRatios()

Returns the ratio of the summary of children absolute configured resources and the parent's effective minimum resource.

Returns:

normalized resource ratio for all labels

getRemainingRatioOfResource

public double getRemainingRatioOfResource(java.lang.String label,
                                          java.lang.String resourceName)

Returns the remaining resource ratio under the parent queue. The remaining resource is only decremented after a capacity type is fully evaluated.

Parameters:

label - node label

resourceName - name of resource unit

Returns:

resource ratio

getParentAbsoluteMinCapacity

public double getParentAbsoluteMinCapacity(java.lang.String label,
                                           java.lang.String resourceName)

Returns the ratio of the parent queue's effective minimum resource relative to the full cluster resource.

Parameters:

label - node label

resourceName - name of resource unit

Returns:

absolute minimum capacity

getParentAbsoluteMaxCapacity

public double getParentAbsoluteMaxCapacity(java.lang.String label,
                                           java.lang.String resourceName)

Returns the ratio of the parent queue's effective maximum resource relative to the full cluster resource.

Parameters:

label - node label

resourceName - name of resource unit

Returns:

absolute maximum capacity

getBatchRemainingResource

public ResourceVector getBatchRemainingResource(java.lang.String label)

Returns the remaining resources of a parent that is still available for its children. Decremented only after the calculator is finished its work on the corresponding resources.

Parameters:

label - node label

Returns:

remaining resources

calculateResources

public void calculateResources()

Calculates and sets the minimum and maximum effective resources for all children under the parent queue with which this driver was initialized.