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

Class AbstractCGroupsHandler

java.lang.Object

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

All Implemented Interfaces:

CGroupsHandler

public abstract class AbstractCGroupsHandler
extends Object
implements CGroupsHandler

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.resources.CGroupsHandler

CGroupsHandler.CGroupController

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	cGroupPrefix
protected final CGroupsMountConfig	cGroupsMountConfig
protected Map<CGroupsHandler.CGroupController,String>	controllerPaths
protected static final String	MTAB_FILE
protected final String	mtabFile
protected Map<String,Set<String>>	parsedMtab
protected final PrivilegedOperationExecutor	privilegedOperationExecutor
protected final ReadWriteLock	rwLock

Fields inherited from interface org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.resources.CGroupsHandler

CGROUP_CONTROLLERS_FILE, CGROUP_CPU_MAX, CGROUP_CPU_PERIOD_US, CGROUP_CPU_QUOTA_US, CGROUP_CPU_SHARES, CGROUP_MEMORY_LOW, CGROUP_MEMORY_MAX, CGROUP_NO_LIMIT, CGROUP_PARAM_CLASSID, CGROUP_PARAM_MEMORY_HARD_LIMIT_BYTES, CGROUP_PARAM_MEMORY_MEMSW_USAGE_BYTES, CGROUP_PARAM_MEMORY_OOM_CONTROL, CGROUP_PARAM_MEMORY_SOFT_LIMIT_BYTES, CGROUP_PARAM_MEMORY_SWAP_HARD_LIMIT_BYTES, CGROUP_PARAM_MEMORY_SWAPPINESS, CGROUP_PARAM_MEMORY_USAGE_BYTES, CGROUP_PARAM_WEIGHT, CGROUP_PROCS_FILE, CGROUP_SUBTREE_CONTROL_FILE, UNDER_OOM

Method Summary

Modifier and Type	Method	Description
String	createCGroup(CGroupsHandler.CGroupController controller, String cGroupId)	Creates a cgroup for a given controller.
void	deleteCGroup(CGroupsHandler.CGroupController controller, String cGroupId)	Deletes the specified cgroup.
protected String	findControllerInMtab(String controller, Map<String,Set<String>> entries)	Find the hierarchy of the subsystem.
protected abstract List<CGroupsHandler.CGroupController>	getCGroupControllers()
String	getCGroupMountPath()	Returns CGroup Mount Path.
String	getCGroupParam(CGroupsHandler.CGroupController controller, String cGroupId, String param)	reads a cgroup parameter value, given a controller, cgroup id, parameter.
String	getCGroupV2MountPath()	Returns CGroupV2 Mount Path.
String	getControllerPath(CGroupsHandler.CGroupController controller)	Gets the absolute path to the specified cgroup controller.
protected String	getErrorWithDetails(String errorMessage, String subsystemName, String yarnCgroupPath)	Creates an actionable error message for mtab parsing.
String	getPathForCGroup(CGroupsHandler.CGroupController controller, String cGroupId)	Gets the full path for the cgroup, given a controller and a cgroup id.
String	getPathForCGroupParam(CGroupsHandler.CGroupController controller, String cGroupId, String param)	Gets the full path for a cgroup parameter, given a controller, cgroup id and parameter name.
String	getPathForCGroupTasks(CGroupsHandler.CGroupController controller, String cGroupId)	Gets the full path for the cgroup's tasks file, given a controller and a cgroup id.
String	getRelativePathForCGroup(String cGroupId)	Gets the relative path for the cgroup, independent of a controller, for a given cgroup id.
protected abstract Set<String>	handleMtabEntry(String path, String type, String options)
protected void	init()
void	initializeCGroupController(CGroupsHandler.CGroupController controller)	Mount cgroup or use existing mount point based on configuration.
protected Map<CGroupsHandler.CGroupController,String>	initializeControllerPathsFromMtab(Map<String,Set<String>> mtab)
protected abstract void	mountCGroupController(CGroupsHandler.CGroupController controller)
protected Map<String,Set<String>>	parseMtab(String mtab)
protected abstract Map<String,Set<String>>	parsePreConfiguredMountPath()
String	toString()
void	updateCGroupParam(CGroupsHandler.CGroupController controller, String cGroupId, String param, String value)	updates a cgroup parameter, given a controller, cgroup id, parameter name.
protected abstract void	updateEnabledControllersInHierarchy(File yarnHierarchy, CGroupsHandler.CGroupController controller)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.resources.CGroupsHandler

getValidCGroups

Field Details

MTAB_FILE

protected static final String MTAB_FILE

See Also:

• Constant Field Values

mtabFile

protected final String mtabFile

cGroupsMountConfig

protected final CGroupsMountConfig cGroupsMountConfig

rwLock

protected final ReadWriteLock rwLock

controllerPaths

protected Map<CGroupsHandler.CGroupController,String> controllerPaths

parsedMtab

protected Map<String,Set<String>> parsedMtab

privilegedOperationExecutor

protected final PrivilegedOperationExecutor privilegedOperationExecutor

cGroupPrefix

protected final String cGroupPrefix

Method Details

init

protected void init()
             throws ResourceHandlerException

Throws:

ResourceHandlerException

getControllerPath

public String getControllerPath(CGroupsHandler.CGroupController controller)

Description copied from interface: CGroupsHandler

Gets the absolute path to the specified cgroup controller.

Specified by:

getControllerPath in interface CGroupsHandler

Parameters:

controller - - controller type for the cgroup

Returns:

the root of the controller.

parsePreConfiguredMountPath

protected abstract Map<String,Set<String>> parsePreConfiguredMountPath()
                                                                throws IOException

Throws:

IOException

initializeControllerPathsFromMtab

protected Map<CGroupsHandler.CGroupController,String> initializeControllerPathsFromMtab(Map<String,Set<String>> mtab)

getCGroupControllers

protected abstract List<CGroupsHandler.CGroupController> getCGroupControllers()

parseMtab

protected Map<String,Set<String>> parseMtab(String mtab)
                                     throws IOException

Throws:

IOException

handleMtabEntry

protected abstract Set<String> handleMtabEntry(String path,
 String type,
 String options)
                                        throws IOException

Throws:

IOException

findControllerInMtab

protected String findControllerInMtab(String controller,
 Map<String,Set<String>> entries)

Find the hierarchy of the subsystem. The kernel ensures that a subsystem can only be part of a single hierarchy. The subsystem can be part of multiple mount points, if they belong to the same hierarchy.

Parameters:

controller - subsystem like cpu, cpuset, etc...

entries - map of paths to mount options

Returns:

the first mount path that has the requested subsystem

mountCGroupController

protected abstract void mountCGroupController(CGroupsHandler.CGroupController controller)
                                       throws ResourceHandlerException

Throws:

ResourceHandlerException

getRelativePathForCGroup

public String getRelativePathForCGroup(String cGroupId)

Description copied from interface: CGroupsHandler

Gets the relative path for the cgroup, independent of a controller, for a given cgroup id.

Specified by:

getRelativePathForCGroup in interface CGroupsHandler

Parameters:

cGroupId - - id of the cgroup

Returns:

path for the cgroup relative to the root of (any) controller.

getPathForCGroup

public String getPathForCGroup(CGroupsHandler.CGroupController controller,
 String cGroupId)

Description copied from interface: CGroupsHandler

Gets the full path for the cgroup, given a controller and a cgroup id.

Specified by:

getPathForCGroup in interface CGroupsHandler

Parameters:

controller - - controller type for the cgroup

cGroupId - - id of the cgroup

Returns:

full path for the cgroup

getPathForCGroupTasks

public String getPathForCGroupTasks(CGroupsHandler.CGroupController controller,
 String cGroupId)

Description copied from interface: CGroupsHandler

Gets the full path for the cgroup's tasks file, given a controller and a cgroup id.

Specified by:

getPathForCGroupTasks in interface CGroupsHandler

Parameters:

controller - - controller type for the cgroup

cGroupId - - id of the cgroup

Returns:

full path for the cgroup's tasks file

getPathForCGroupParam

public String getPathForCGroupParam(CGroupsHandler.CGroupController controller,
 String cGroupId,
 String param)

Description copied from interface: CGroupsHandler

Gets the full path for a cgroup parameter, given a controller, cgroup id and parameter name.

Specified by:

getPathForCGroupParam in interface CGroupsHandler

Parameters:

controller - - controller type for the cgroup

cGroupId - - id of the cgroup

param - - cgroup parameter ( e.g classid )

Returns:

full path for the cgroup parameter

initializeCGroupController

public void initializeCGroupController(CGroupsHandler.CGroupController controller)
                                throws ResourceHandlerException

Mount cgroup or use existing mount point based on configuration.

Specified by:

initializeCGroupController in interface CGroupsHandler

Parameters:

controller - - the controller being initialized

Throws:

ResourceHandlerException - yarn hierarchy cannot be created or accessed for any reason

updateEnabledControllersInHierarchy

protected abstract void updateEnabledControllersInHierarchy(File yarnHierarchy,
 CGroupsHandler.CGroupController controller)
                                                     throws ResourceHandlerException

Throws:

ResourceHandlerException

getErrorWithDetails

protected String getErrorWithDetails(String errorMessage,
 String subsystemName,
 String yarnCgroupPath)

Creates an actionable error message for mtab parsing.

Parameters:

errorMessage - message to use

subsystemName - cgroup subsystem

yarnCgroupPath - cgroup path that failed

Returns:

a string builder that can be appended by the caller

createCGroup

public String createCGroup(CGroupsHandler.CGroupController controller,
 String cGroupId)
                    throws ResourceHandlerException

Description copied from interface: CGroupsHandler

Creates a cgroup for a given controller.

Specified by:

createCGroup in interface CGroupsHandler

Parameters:

controller - - controller type for which the cgroup is being created

cGroupId - - id of the cgroup being created

Returns:

full path to created cgroup

Throws:

ResourceHandlerException - creation failed

deleteCGroup

public void deleteCGroup(CGroupsHandler.CGroupController controller,
 String cGroupId)
                  throws ResourceHandlerException

Description copied from interface: CGroupsHandler

Deletes the specified cgroup.

Specified by:

deleteCGroup in interface CGroupsHandler

Parameters:

controller - - controller type for the cgroup

cGroupId - - id of the cgroup being deleted

Throws:

ResourceHandlerException - deletion failed

updateCGroupParam

public void updateCGroupParam(CGroupsHandler.CGroupController controller,
 String cGroupId,
 String param,
 String value)
                       throws ResourceHandlerException

Description copied from interface: CGroupsHandler

updates a cgroup parameter, given a controller, cgroup id, parameter name. and a parameter value

Specified by:

updateCGroupParam in interface CGroupsHandler

Parameters:

controller - - controller type for the cgroup

cGroupId - - id of the cgroup

param - - cgroup parameter ( e.g classid )

value - - value to be written to the parameter file

Throws:

ResourceHandlerException - the operation failed

getCGroupParam

public String getCGroupParam(CGroupsHandler.CGroupController controller,
 String cGroupId,
 String param)
                      throws ResourceHandlerException

Description copied from interface: CGroupsHandler

reads a cgroup parameter value, given a controller, cgroup id, parameter. name

Specified by:

getCGroupParam in interface CGroupsHandler

Parameters:

controller - - controller type for the cgroup

cGroupId - - id of the cgroup

param - - cgroup parameter ( e.g classid )

Returns:

parameter value as read from the parameter file

Throws:

ResourceHandlerException - the operation failed

getCGroupMountPath

public String getCGroupMountPath()

Description copied from interface: CGroupsHandler

Returns CGroup Mount Path.

Specified by:

getCGroupMountPath in interface CGroupsHandler

Returns:

parameter value as read from the parameter file

getCGroupV2MountPath

public String getCGroupV2MountPath()

Description copied from interface: CGroupsHandler

Returns CGroupV2 Mount Path.

Specified by:

getCGroupV2MountPath in interface CGroupsHandler

Returns:

parameter value as read from the parameter file

toString

public String toString()

Overrides:

toString in class Object