Package org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.resources

Class AbstractCGroupsMemoryResourceHandler

java.lang.Object

org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.resources.AbstractCGroupsMemoryResourceHandler

All Implemented Interfaces:

MemoryResourceHandler, ResourceHandler

Direct Known Subclasses:

CGroupsMemoryResourceHandlerImpl, CGroupsV2MemoryResourceHandlerImpl

@Unstable
@Private
public abstract class AbstractCGroupsMemoryResourceHandler
extends Object
implements MemoryResourceHandler

Field Summary

Fields

Modifier and Type	Field	Description
protected static final CGroupsHandler.CGroupController	MEMORY
protected static final int	OPPORTUNISTIC_SOFT_LIMIT

Constructor Summary

Constructors

Constructor	Description
AbstractCGroupsMemoryResourceHandler(CGroupsHandler cGroupsHandler)

Method Summary

Modifier and Type	Method	Description
List<PrivilegedOperation>	bootstrap(org.apache.hadoop.conf.Configuration conf)	Bootstrap resource susbsystem.
protected CGroupsHandler	getCGroupsHandler()
List<PrivilegedOperation>	postComplete(org.apache.hadoop.yarn.api.records.ContainerId containerId)	Perform any tasks necessary after container completion.
List<PrivilegedOperation>	preStart(Container container)	Prepare a resource environment for container launch
List<PrivilegedOperation>	reacquireContainer(org.apache.hadoop.yarn.api.records.ContainerId containerId)	Require state for container that was already launched
List<PrivilegedOperation>	teardown()	Teardown environment for resource subsystem if requested.
String	toString()
List<PrivilegedOperation>	updateContainer(Container container)	Update state for container that was already launched
protected abstract void	updateGuaranteedMemoryLimits(String cgroupId, long containerSoftLimit)
protected abstract void	updateMemoryHardLimit(String cgroupId, long containerHardLimit)
protected abstract void	updateOpportunisticMemoryLimits(String cgroupId)

Methods inherited from class java.lang.Object

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

Field Details

MEMORY

protected static final CGroupsHandler.CGroupController MEMORY

OPPORTUNISTIC_SOFT_LIMIT

protected static final int OPPORTUNISTIC_SOFT_LIMIT

See Also:

• Constant Field Values

Constructor Details

AbstractCGroupsMemoryResourceHandler

public AbstractCGroupsMemoryResourceHandler(CGroupsHandler cGroupsHandler)

Method Details

getCGroupsHandler

protected CGroupsHandler getCGroupsHandler()

bootstrap

public List<PrivilegedOperation> bootstrap(org.apache.hadoop.conf.Configuration conf)
                                    throws ResourceHandlerException

Description copied from interface: ResourceHandler

Bootstrap resource susbsystem.

Specified by:

bootstrap in interface ResourceHandler

Returns:

(possibly empty) list of operations that require elevated privileges

Throws:

ResourceHandlerException

updateContainer

public List<PrivilegedOperation> updateContainer(Container container)
                                          throws ResourceHandlerException

Description copied from interface: ResourceHandler

Update state for container that was already launched

Specified by:

updateContainer in interface ResourceHandler

Parameters:

container - the container being updated.

Returns:

(possibly empty) list of operations that require elevated privileges

Throws:

ResourceHandlerException

updateMemoryHardLimit

protected abstract void updateMemoryHardLimit(String cgroupId,
 long containerHardLimit)
                                       throws ResourceHandlerException

Throws:

ResourceHandlerException

updateOpportunisticMemoryLimits

protected abstract void updateOpportunisticMemoryLimits(String cgroupId)
                                                 throws ResourceHandlerException

Throws:

ResourceHandlerException

updateGuaranteedMemoryLimits

protected abstract void updateGuaranteedMemoryLimits(String cgroupId,
 long containerSoftLimit)
                                              throws ResourceHandlerException

Throws:

ResourceHandlerException

reacquireContainer

public List<PrivilegedOperation> reacquireContainer(org.apache.hadoop.yarn.api.records.ContainerId containerId)
                                             throws ResourceHandlerException

Description copied from interface: ResourceHandler

Require state for container that was already launched

Specified by:

reacquireContainer in interface ResourceHandler

Parameters:

containerId - id of the container being reacquired.

Returns:

(possibly empty) list of operations that require elevated privileges

Throws:

ResourceHandlerException

preStart

public List<PrivilegedOperation> preStart(Container container)
                                   throws ResourceHandlerException

Description copied from interface: ResourceHandler

Prepare a resource environment for container launch

Specified by:

preStart in interface ResourceHandler

Parameters:

container - Container being launched

Returns:

(possibly empty) list of operations that require elevated privileges e.g a) create a custom cgroup b) add pid for container to tasks file for a cgroup.

Throws:

ResourceHandlerException

postComplete

public List<PrivilegedOperation> postComplete(org.apache.hadoop.yarn.api.records.ContainerId containerId)
                                       throws ResourceHandlerException

Description copied from interface: ResourceHandler

Perform any tasks necessary after container completion.

Specified by:

postComplete in interface ResourceHandler

Parameters:

containerId - of the container that was completed.

Returns:

(possibly empty) list of operations that require elevated privileges

Throws:

ResourceHandlerException

teardown

public List<PrivilegedOperation> teardown()
                                   throws ResourceHandlerException

Description copied from interface: ResourceHandler

Teardown environment for resource subsystem if requested. This method needs to be used with care since it could impact running containers.

Specified by:

teardown in interface ResourceHandler

Returns:

(possibly empty) list of operations that require elevated privileges

Throws:

ResourceHandlerException

toString

public String toString()

Overrides:

toString in class Object