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

Class AppSchedulingInfo

java.lang.Object

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

@Private
@Unstable
public class AppSchedulingInfo
extends java.lang.Object

This class keeps track of all the consumption of an application. This also keeps track of current running/completed containers for the application.

Field Summary

Fields

Modifier and Type	Field	Description
ContainerUpdateContext	updateContext

Constructor Summary

Constructors

Constructor	Description
AppSchedulingInfo(org.apache.hadoop.yarn.api.records.ApplicationAttemptId appAttemptId, java.lang.String user, Queue queue, AbstractUsersManager abstractUsersManager, long epoch, ResourceUsage appResourceUsage, java.util.Map<java.lang.String,java.lang.String> applicationSchedulingEnvs, RMContext rmContext, boolean unmanagedAM)

Method Summary

Modifier and Type	Method	Description
void	addRequestedPartition(java.lang.String partition)
ContainerRequest	allocate(NodeType type, SchedulerNode node, org.apache.hadoop.yarn.server.scheduler.SchedulerRequestKey schedulerKey, RMContainer containerAllocated)
boolean	canDelayTo(org.apache.hadoop.yarn.server.scheduler.SchedulerRequestKey schedulerKey, java.lang.String resourceName)	Can delay to next?.
boolean	checkAllocation(NodeType type, SchedulerNode node, org.apache.hadoop.yarn.server.scheduler.SchedulerRequestKey schedulerKey)
void	checkForDeactivation()
void	decPendingResource(java.lang.String partition, org.apache.hadoop.yarn.api.records.Resource toDecrease)
java.util.List<org.apache.hadoop.yarn.api.records.ResourceRequest>	getAllResourceRequests()	Used by REST API to fetch ResourceRequest
java.util.List<org.apache.hadoop.yarn.api.records.SchedulingRequest>	getAllSchedulingRequests()	Fetch SchedulingRequests.
boolean	getAndResetBlacklistChanged()
org.apache.hadoop.yarn.api.records.ApplicationAttemptId	getApplicationAttemptId()
org.apache.hadoop.yarn.api.records.ApplicationId	getApplicationId()
java.util.Map<java.lang.String,java.lang.String>	getApplicationSchedulingEnvs()	Get scheduling envs configured for this application.
<N extends SchedulerNode> AppPlacementAllocator<N>	getAppPlacementAllocator(org.apache.hadoop.yarn.server.scheduler.SchedulerRequestKey schedulerkey)
java.util.Set<java.lang.String>	getBlackListCopy()
java.lang.String	getDefaultNodeLabelExpression()	Get the defaultNodeLabelExpression for the application's current queue.
java.lang.String	getDefaultResourceRequestAppPlacementType()	Set default App Placement Allocator.
long	getNewContainerId()
PendingAsk	getNextPendingAsk()
PendingAsk	getPendingAsk(org.apache.hadoop.yarn.server.scheduler.SchedulerRequestKey schedulerKey)
PendingAsk	getPendingAsk(org.apache.hadoop.yarn.server.scheduler.SchedulerRequestKey schedulerKey, java.lang.String resourceName)
java.lang.String	getQueueName()
java.util.List<org.apache.hadoop.yarn.api.records.RejectedSchedulingRequest>	getRejectedRequest()
java.util.Set<java.lang.String>	getRequestedPartitions()
RMContext	getRMContext()
java.util.Collection<org.apache.hadoop.yarn.server.scheduler.SchedulerRequestKey>	getSchedulerKeys()
ContainerUpdateContext	getUpdateContext()
java.lang.String	getUser()
boolean	isBlackListedBasedOnLabels(java.lang.String resourceName)
boolean	isPending()
boolean	isPlaceBlacklisted(java.lang.String resourceName, boolean blacklistedBySystem)	Returns if the place (node/rack today) is either blacklisted by the application (user) or the system.
boolean	isUnmanagedAM()
void	move(Queue newQueue)
boolean	precheckNode(org.apache.hadoop.yarn.server.scheduler.SchedulerRequestKey schedulerKey, SchedulerNode schedulerNode, SchedulingMode schedulingMode, java.util.Optional<DiagnosticsCollector> dcOpt)	Pre-check node to see if it satisfy the given schedulerKey and scheduler mode.
void	recoverContainer(RMContainer rmContainer, java.lang.String partition)
void	removeAppPlacement(org.apache.hadoop.yarn.server.scheduler.SchedulerRequestKey schedulerRequestKey)
void	setQueue(Queue queue)
void	setUnmanagedAM(boolean unmanagedAM)
void	stop()
void	transferStateFromPreviousAppSchedulingInfo(AppSchedulingInfo appInfo)
static void	updateMetrics(org.apache.hadoop.yarn.api.records.ApplicationId applicationId, NodeType type, SchedulerNode node, RMContainer containerAllocated, java.lang.String user, Queue queue)
void	updatePlacesBlacklistedByApp(java.util.List<java.lang.String> blacklistAdditions, java.util.List<java.lang.String> blacklistRemovals)	The ApplicationMaster is updating the placesBlacklistedByApp used for containers other than AMs.
void	updatePlacesBlacklistedBySystem(java.util.List<java.lang.String> blacklistAdditions, java.util.List<java.lang.String> blacklistRemovals)	Update the list of places that are blacklisted by the system.
boolean	updateResourceRequests(java.util.List<org.apache.hadoop.yarn.api.records.ResourceRequest> resourceRequests, boolean recoverPreemptedRequestForAContainer)	The ApplicationMaster is updating resource requirements for the application, by asking for more resources and releasing resources acquired by the application.
boolean	updateResourceRequests(java.util.Map<org.apache.hadoop.yarn.server.scheduler.SchedulerRequestKey,java.util.Map<java.lang.String,org.apache.hadoop.yarn.api.records.ResourceRequest>> dedupRequests, boolean recoverPreemptedRequestForAContainer)	The ApplicationMaster is updating resource requirements for the application, by asking for more resources and releasing resources acquired by the application.
boolean	updateSchedulingRequests(java.util.List<org.apache.hadoop.yarn.api.records.SchedulingRequest> schedulingRequests, boolean recoverPreemptedRequestForAContainer)	The ApplicationMaster is updating resource requirements for the application, by asking for more resources and releasing resources acquired by the application.

Methods inherited from class java.lang.Object

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

Field Detail

updateContext

public final ContainerUpdateContext updateContext

Constructor Detail

AppSchedulingInfo

public AppSchedulingInfo(org.apache.hadoop.yarn.api.records.ApplicationAttemptId appAttemptId,
                         java.lang.String user,
                         Queue queue,
                         AbstractUsersManager abstractUsersManager,
                         long epoch,
                         ResourceUsage appResourceUsage,
                         java.util.Map<java.lang.String,java.lang.String> applicationSchedulingEnvs,
                         RMContext rmContext,
                         boolean unmanagedAM)

Method Detail

getDefaultResourceRequestAppPlacementType

public java.lang.String getDefaultResourceRequestAppPlacementType()

Set default App Placement Allocator.

Returns:

app placement class.

getApplicationId

public org.apache.hadoop.yarn.api.records.ApplicationId getApplicationId()

getApplicationAttemptId

public org.apache.hadoop.yarn.api.records.ApplicationAttemptId getApplicationAttemptId()

getUser

public java.lang.String getUser()

getNewContainerId

public long getNewContainerId()

getQueueName

public java.lang.String getQueueName()

isPending

public boolean isPending()

setUnmanagedAM

public void setUnmanagedAM(boolean unmanagedAM)

isUnmanagedAM

public boolean isUnmanagedAM()

getRequestedPartitions

public java.util.Set<java.lang.String> getRequestedPartitions()

getUpdateContext

public ContainerUpdateContext getUpdateContext()

updateResourceRequests

public boolean updateResourceRequests(java.util.List<org.apache.hadoop.yarn.api.records.ResourceRequest> resourceRequests,
                                      boolean recoverPreemptedRequestForAContainer)

The ApplicationMaster is updating resource requirements for the application, by asking for more resources and releasing resources acquired by the application.

Parameters:

resourceRequests - resource requests to be allocated

recoverPreemptedRequestForAContainer - recover ResourceRequest/SchedulingRequest on preemption

Returns:

true if any resource was updated, false otherwise

updateResourceRequests

public boolean updateResourceRequests(java.util.Map<org.apache.hadoop.yarn.server.scheduler.SchedulerRequestKey,java.util.Map<java.lang.String,org.apache.hadoop.yarn.api.records.ResourceRequest>> dedupRequests,
                                      boolean recoverPreemptedRequestForAContainer)

The ApplicationMaster is updating resource requirements for the application, by asking for more resources and releasing resources acquired by the application.

Parameters:

dedupRequests - (dedup) resource requests to be allocated

recoverPreemptedRequestForAContainer - recover ResourceRequest/SchedulingRequest on preemption

Returns:

true if any resource was updated, false otherwise

updateSchedulingRequests

public boolean updateSchedulingRequests(java.util.List<org.apache.hadoop.yarn.api.records.SchedulingRequest> schedulingRequests,
                                        boolean recoverPreemptedRequestForAContainer)

The ApplicationMaster is updating resource requirements for the application, by asking for more resources and releasing resources acquired by the application.

Parameters:

schedulingRequests - resource requests to be allocated

recoverPreemptedRequestForAContainer - recover ResourceRequest/SchedulingRequest on preemption

Returns:

true if any resource was updated, false otherwise

removeAppPlacement

public void removeAppPlacement(org.apache.hadoop.yarn.server.scheduler.SchedulerRequestKey schedulerRequestKey)

addRequestedPartition

public void addRequestedPartition(java.lang.String partition)

decPendingResource

public void decPendingResource(java.lang.String partition,
                               org.apache.hadoop.yarn.api.records.Resource toDecrease)

updatePlacesBlacklistedByApp

public void updatePlacesBlacklistedByApp(java.util.List<java.lang.String> blacklistAdditions,
                                         java.util.List<java.lang.String> blacklistRemovals)

The ApplicationMaster is updating the placesBlacklistedByApp used for containers other than AMs.

Parameters:

blacklistAdditions - resources to be added to the userBlacklist

blacklistRemovals - resources to be removed from the userBlacklist

updatePlacesBlacklistedBySystem

public void updatePlacesBlacklistedBySystem(java.util.List<java.lang.String> blacklistAdditions,
                                            java.util.List<java.lang.String> blacklistRemovals)

Update the list of places that are blacklisted by the system. Today the system only blacklists places when it sees that AMs failed there

Parameters:

blacklistAdditions - resources to be added to placesBlacklistedBySystem

blacklistRemovals - resources to be removed from placesBlacklistedBySystem

getAndResetBlacklistChanged

public boolean getAndResetBlacklistChanged()

getSchedulerKeys

public java.util.Collection<org.apache.hadoop.yarn.server.scheduler.SchedulerRequestKey> getSchedulerKeys()

getAllResourceRequests

public java.util.List<org.apache.hadoop.yarn.api.records.ResourceRequest> getAllResourceRequests()

Used by REST API to fetch ResourceRequest

Returns:

All pending ResourceRequests.

getAllSchedulingRequests

public java.util.List<org.apache.hadoop.yarn.api.records.SchedulingRequest> getAllSchedulingRequests()

Fetch SchedulingRequests.

Returns:

All pending SchedulingRequests.

getRejectedRequest

public java.util.List<org.apache.hadoop.yarn.api.records.RejectedSchedulingRequest> getRejectedRequest()

getNextPendingAsk

public PendingAsk getNextPendingAsk()

getPendingAsk

public PendingAsk getPendingAsk(org.apache.hadoop.yarn.server.scheduler.SchedulerRequestKey schedulerKey)

getPendingAsk

public PendingAsk getPendingAsk(org.apache.hadoop.yarn.server.scheduler.SchedulerRequestKey schedulerKey,
                                java.lang.String resourceName)

isPlaceBlacklisted

public boolean isPlaceBlacklisted(java.lang.String resourceName,
                                  boolean blacklistedBySystem)

Returns if the place (node/rack today) is either blacklisted by the application (user) or the system.

Parameters:

resourceName - the resourcename

blacklistedBySystem - true if it should check amBlacklist

Returns:

true if its blacklisted

isBlackListedBasedOnLabels

public boolean isBlackListedBasedOnLabels(java.lang.String resourceName)

allocate

public ContainerRequest allocate(NodeType type,
                                 SchedulerNode node,
                                 org.apache.hadoop.yarn.server.scheduler.SchedulerRequestKey schedulerKey,
                                 RMContainer containerAllocated)

checkForDeactivation

public void checkForDeactivation()

move

public void move(Queue newQueue)

stop

public void stop()

setQueue

public void setQueue(Queue queue)

getBlackListCopy

public java.util.Set<java.lang.String> getBlackListCopy()

transferStateFromPreviousAppSchedulingInfo

public void transferStateFromPreviousAppSchedulingInfo(AppSchedulingInfo appInfo)

recoverContainer

public void recoverContainer(RMContainer rmContainer,
                             java.lang.String partition)

checkAllocation

public boolean checkAllocation(NodeType type,
                               SchedulerNode node,
                               org.apache.hadoop.yarn.server.scheduler.SchedulerRequestKey schedulerKey)

updateMetrics

public static void updateMetrics(org.apache.hadoop.yarn.api.records.ApplicationId applicationId,
                                 NodeType type,
                                 SchedulerNode node,
                                 RMContainer containerAllocated,
                                 java.lang.String user,
                                 Queue queue)

getAppPlacementAllocator

public <N extends SchedulerNode> AppPlacementAllocator<N> getAppPlacementAllocator(org.apache.hadoop.yarn.server.scheduler.SchedulerRequestKey schedulerkey)

canDelayTo

public boolean canDelayTo(org.apache.hadoop.yarn.server.scheduler.SchedulerRequestKey schedulerKey,
                          java.lang.String resourceName)

Can delay to next?.

Parameters:

schedulerKey - schedulerKey

resourceName - resourceName

Returns:

If request exists, return {relaxLocality} Otherwise, return true.

precheckNode

public boolean precheckNode(org.apache.hadoop.yarn.server.scheduler.SchedulerRequestKey schedulerKey,
                            SchedulerNode schedulerNode,
                            SchedulingMode schedulingMode,
                            java.util.Optional<DiagnosticsCollector> dcOpt)

Pre-check node to see if it satisfy the given schedulerKey and scheduler mode.

Parameters:

schedulerKey - schedulerKey

schedulerNode - schedulerNode

schedulingMode - schedulingMode

dcOpt - optional diagnostics collector

Returns:

can use the node or not.

getApplicationSchedulingEnvs

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

Get scheduling envs configured for this application.

Returns:

a map of applicationSchedulingEnvs

getDefaultNodeLabelExpression

public java.lang.String getDefaultNodeLabelExpression()

Get the defaultNodeLabelExpression for the application's current queue.

Returns:

defaultNodeLabelExpression

getRMContext

public RMContext getRMContext()