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

Class SchedulerUtils

java.lang.Object

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

@InterfaceAudience.Private
@InterfaceStability.Unstable
public class SchedulerUtils
extends Object

Utilities shared by schedulers.

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPLETED_APPLICATION
static String	EXPIRED_CONTAINER
static String	LOST_CONTAINER
static String	PREEMPTED_CONTAINER
static String	RELEASED_CONTAINER
static String	UNRESERVED_CONTAINER

Constructor Summary

Constructors

Constructor and Description
SchedulerUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static org.apache.hadoop.yarn.api.records.ContainerStatus	createAbnormalContainerStatus(org.apache.hadoop.yarn.api.records.ContainerId containerId, String diagnostics) Utility to create a ContainerStatus during exceptional circumstances.
static org.apache.hadoop.yarn.api.records.ContainerStatus	createPreemptedContainerStatus(org.apache.hadoop.yarn.api.records.ContainerId containerId, String diagnostics) Utility to create a ContainerStatus during exceptional circumstances.
static void	normalizeRequest(org.apache.hadoop.yarn.api.records.ResourceRequest ask, org.apache.hadoop.yarn.util.resource.ResourceCalculator resourceCalculator, org.apache.hadoop.yarn.api.records.Resource clusterResource, org.apache.hadoop.yarn.api.records.Resource minimumResource, org.apache.hadoop.yarn.api.records.Resource maximumResource) Utility method to normalize a resource request, by insuring that the requested memory is a multiple of minMemory and is not zero.
static void	normalizeRequest(org.apache.hadoop.yarn.api.records.ResourceRequest ask, org.apache.hadoop.yarn.util.resource.ResourceCalculator resourceCalculator, org.apache.hadoop.yarn.api.records.Resource clusterResource, org.apache.hadoop.yarn.api.records.Resource minimumResource, org.apache.hadoop.yarn.api.records.Resource maximumResource, org.apache.hadoop.yarn.api.records.Resource incrementResource) Utility method to normalize a resource request, by insuring that the requested memory is a multiple of minMemory and is not zero.
static void	normalizeRequests(List<org.apache.hadoop.yarn.api.records.ResourceRequest> asks, org.apache.hadoop.yarn.util.resource.ResourceCalculator resourceCalculator, org.apache.hadoop.yarn.api.records.Resource clusterResource, org.apache.hadoop.yarn.api.records.Resource minimumResource, org.apache.hadoop.yarn.api.records.Resource maximumResource) Utility method to normalize a list of resource requests, by insuring that the memory for each request is a multiple of minMemory and is not zero.
static void	normalizeRequests(List<org.apache.hadoop.yarn.api.records.ResourceRequest> asks, org.apache.hadoop.yarn.util.resource.ResourceCalculator resourceCalculator, org.apache.hadoop.yarn.api.records.Resource clusterResource, org.apache.hadoop.yarn.api.records.Resource minimumResource, org.apache.hadoop.yarn.api.records.Resource maximumResource, org.apache.hadoop.yarn.api.records.Resource incrementResource) Utility method to normalize a list of resource requests, by insuring that the memory for each request is a multiple of minMemory and is not zero.
static void	updateResourceIfChanged(SchedulerNode node, RMNode rmNode, org.apache.hadoop.yarn.api.records.Resource clusterResource, org.apache.commons.logging.Log log) Update resource in SchedulerNode if any resource change in RMNode.
static void	validateResourceRequest(org.apache.hadoop.yarn.api.records.ResourceRequest resReq, org.apache.hadoop.yarn.api.records.Resource maximumResource) Utility method to validate a resource request, by insuring that the requested memory/vcore is non-negative and not greater than max

Methods inherited from class java.lang.Object

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

Field Detail

RELEASED_CONTAINER

public static final String RELEASED_CONTAINER

See Also:

Constant Field Values

LOST_CONTAINER

public static final String LOST_CONTAINER

See Also:

Constant Field Values

PREEMPTED_CONTAINER

public static final String PREEMPTED_CONTAINER

See Also:

Constant Field Values

COMPLETED_APPLICATION

public static final String COMPLETED_APPLICATION

See Also:

Constant Field Values

EXPIRED_CONTAINER

public static final String EXPIRED_CONTAINER

See Also:

Constant Field Values

UNRESERVED_CONTAINER

public static final String UNRESERVED_CONTAINER

See Also:

Constant Field Values

Constructor Detail

SchedulerUtils

public SchedulerUtils()

Method Detail

createAbnormalContainerStatus

public static org.apache.hadoop.yarn.api.records.ContainerStatus createAbnormalContainerStatus(org.apache.hadoop.yarn.api.records.ContainerId containerId,
                                                                               String diagnostics)

Utility to create a ContainerStatus during exceptional circumstances.

Parameters:

containerId - ContainerId of returned/released/lost container.

diagnostics - diagnostic message

Returns:

ContainerStatus for an returned/released/lost container

createPreemptedContainerStatus

public static org.apache.hadoop.yarn.api.records.ContainerStatus createPreemptedContainerStatus(org.apache.hadoop.yarn.api.records.ContainerId containerId,
                                                                                String diagnostics)

Utility to create a ContainerStatus during exceptional circumstances.

Parameters:

containerId - ContainerId of returned/released/lost container.

diagnostics - diagnostic message

Returns:

ContainerStatus for an returned/released/lost container

normalizeRequests

public static void normalizeRequests(List<org.apache.hadoop.yarn.api.records.ResourceRequest> asks,
                     org.apache.hadoop.yarn.util.resource.ResourceCalculator resourceCalculator,
                     org.apache.hadoop.yarn.api.records.Resource clusterResource,
                     org.apache.hadoop.yarn.api.records.Resource minimumResource,
                     org.apache.hadoop.yarn.api.records.Resource maximumResource)

Utility method to normalize a list of resource requests, by insuring that the memory for each request is a multiple of minMemory and is not zero.

normalizeRequest

public static void normalizeRequest(org.apache.hadoop.yarn.api.records.ResourceRequest ask,
                    org.apache.hadoop.yarn.util.resource.ResourceCalculator resourceCalculator,
                    org.apache.hadoop.yarn.api.records.Resource clusterResource,
                    org.apache.hadoop.yarn.api.records.Resource minimumResource,
                    org.apache.hadoop.yarn.api.records.Resource maximumResource)

Utility method to normalize a resource request, by insuring that the requested memory is a multiple of minMemory and is not zero.

updateResourceIfChanged

public static void updateResourceIfChanged(SchedulerNode node,
                           RMNode rmNode,
                           org.apache.hadoop.yarn.api.records.Resource clusterResource,
                           org.apache.commons.logging.Log log)

Update resource in SchedulerNode if any resource change in RMNode.

Parameters:

node - SchedulerNode with old resource view

rmNode - RMNode with new resource view

clusterResource - the cluster's resource that need to update

log - Scheduler's log for resource change

normalizeRequests

public static void normalizeRequests(List<org.apache.hadoop.yarn.api.records.ResourceRequest> asks,
                     org.apache.hadoop.yarn.util.resource.ResourceCalculator resourceCalculator,
                     org.apache.hadoop.yarn.api.records.Resource clusterResource,
                     org.apache.hadoop.yarn.api.records.Resource minimumResource,
                     org.apache.hadoop.yarn.api.records.Resource maximumResource,
                     org.apache.hadoop.yarn.api.records.Resource incrementResource)

Utility method to normalize a list of resource requests, by insuring that the memory for each request is a multiple of minMemory and is not zero.

normalizeRequest

public static void normalizeRequest(org.apache.hadoop.yarn.api.records.ResourceRequest ask,
                    org.apache.hadoop.yarn.util.resource.ResourceCalculator resourceCalculator,
                    org.apache.hadoop.yarn.api.records.Resource clusterResource,
                    org.apache.hadoop.yarn.api.records.Resource minimumResource,
                    org.apache.hadoop.yarn.api.records.Resource maximumResource,
                    org.apache.hadoop.yarn.api.records.Resource incrementResource)

Utility method to normalize a resource request, by insuring that the requested memory is a multiple of minMemory and is not zero.

validateResourceRequest

public static void validateResourceRequest(org.apache.hadoop.yarn.api.records.ResourceRequest resReq,
                           org.apache.hadoop.yarn.api.records.Resource maximumResource)
                                    throws org.apache.hadoop.yarn.exceptions.InvalidResourceRequestException

Utility method to validate a resource request, by insuring that the requested memory/vcore is non-negative and not greater than max

Throws:

InvalidResourceRequestException - when there is invalid request

org.apache.hadoop.yarn.exceptions.InvalidResourceRequestException