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

Interface CGroupsHandler

@Private
@Unstable
public interface CGroupsHandler

Provides CGroups functionality. Implementations are expected to be thread-safe

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	CGroupsHandler.CGroupController	List of supported cgroup subsystem types.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	CGROUP_CPU_PERIOD_US
static java.lang.String	CGROUP_CPU_QUOTA_US
static java.lang.String	CGROUP_CPU_SHARES
static java.lang.String	CGROUP_NO_LIMIT
static java.lang.String	CGROUP_PARAM_BLKIO_WEIGHT
static java.lang.String	CGROUP_PARAM_CLASSID
static java.lang.String	CGROUP_PARAM_MEMORY_HARD_LIMIT_BYTES
static java.lang.String	CGROUP_PARAM_MEMORY_MEMSW_USAGE_BYTES
static java.lang.String	CGROUP_PARAM_MEMORY_OOM_CONTROL
static java.lang.String	CGROUP_PARAM_MEMORY_SOFT_LIMIT_BYTES
static java.lang.String	CGROUP_PARAM_MEMORY_SWAP_HARD_LIMIT_BYTES
static java.lang.String	CGROUP_PARAM_MEMORY_SWAPPINESS
static java.lang.String	CGROUP_PARAM_MEMORY_USAGE_BYTES
static java.lang.String	CGROUP_PROCS_FILE
static java.lang.String	UNDER_OOM

Method Summary

Modifier and Type	Method	Description
java.lang.String	createCGroup(CGroupsHandler.CGroupController controller, java.lang.String cGroupId)	Creates a cgroup for a given controller.
void	deleteCGroup(CGroupsHandler.CGroupController controller, java.lang.String cGroupId)	Deletes the specified cgroup.
java.lang.String	getCGroupMountPath()	Returns CGroup Mount Path.
java.lang.String	getCGroupParam(CGroupsHandler.CGroupController controller, java.lang.String cGroupId, java.lang.String param)	reads a cgroup parameter value, given a controller, cgroup id, parameter.
java.lang.String	getControllerPath(CGroupsHandler.CGroupController controller)	Gets the absolute path to the specified cgroup controller.
java.lang.String	getPathForCGroup(CGroupsHandler.CGroupController controller, java.lang.String cGroupId)	Gets the full path for the cgroup, given a controller and a cgroup id.
java.lang.String	getPathForCGroupParam(CGroupsHandler.CGroupController controller, java.lang.String cGroupId, java.lang.String param)	Gets the full path for a cgroup parameter, given a controller, cgroup id and parameter name.
java.lang.String	getPathForCGroupTasks(CGroupsHandler.CGroupController controller, java.lang.String cGroupId)	Gets the full path for the cgroup's tasks file, given a controller and a cgroup id.
java.lang.String	getRelativePathForCGroup(java.lang.String cGroupId)	Gets the relative path for the cgroup, independent of a controller, for a given cgroup id.
void	initializeCGroupController(CGroupsHandler.CGroupController controller)	Mounts or initializes a cgroup controller.
void	updateCGroupParam(CGroupsHandler.CGroupController controller, java.lang.String cGroupId, java.lang.String param, java.lang.String value)	updates a cgroup parameter, given a controller, cgroup id, parameter name.

Field Detail

CGROUP_PROCS_FILE

static final java.lang.String CGROUP_PROCS_FILE

See Also:

Constant Field Values

CGROUP_PARAM_CLASSID

static final java.lang.String CGROUP_PARAM_CLASSID

See Also:

Constant Field Values

CGROUP_PARAM_BLKIO_WEIGHT

static final java.lang.String CGROUP_PARAM_BLKIO_WEIGHT

See Also:

Constant Field Values

CGROUP_PARAM_MEMORY_HARD_LIMIT_BYTES

static final java.lang.String CGROUP_PARAM_MEMORY_HARD_LIMIT_BYTES

See Also:

Constant Field Values

CGROUP_PARAM_MEMORY_SWAP_HARD_LIMIT_BYTES

static final java.lang.String CGROUP_PARAM_MEMORY_SWAP_HARD_LIMIT_BYTES

See Also:

Constant Field Values

CGROUP_PARAM_MEMORY_SOFT_LIMIT_BYTES

static final java.lang.String CGROUP_PARAM_MEMORY_SOFT_LIMIT_BYTES

See Also:

Constant Field Values

CGROUP_PARAM_MEMORY_OOM_CONTROL

static final java.lang.String CGROUP_PARAM_MEMORY_OOM_CONTROL

See Also:

Constant Field Values

CGROUP_PARAM_MEMORY_SWAPPINESS

static final java.lang.String CGROUP_PARAM_MEMORY_SWAPPINESS

See Also:

Constant Field Values

CGROUP_PARAM_MEMORY_USAGE_BYTES

static final java.lang.String CGROUP_PARAM_MEMORY_USAGE_BYTES

See Also:

Constant Field Values

CGROUP_PARAM_MEMORY_MEMSW_USAGE_BYTES

static final java.lang.String CGROUP_PARAM_MEMORY_MEMSW_USAGE_BYTES

See Also:

Constant Field Values

CGROUP_NO_LIMIT

static final java.lang.String CGROUP_NO_LIMIT

See Also:

Constant Field Values

UNDER_OOM

static final java.lang.String UNDER_OOM

See Also:

Constant Field Values

CGROUP_CPU_PERIOD_US

static final java.lang.String CGROUP_CPU_PERIOD_US

See Also:

Constant Field Values

CGROUP_CPU_QUOTA_US

static final java.lang.String CGROUP_CPU_QUOTA_US

See Also:

Constant Field Values

CGROUP_CPU_SHARES

static final java.lang.String CGROUP_CPU_SHARES

See Also:

Constant Field Values

Method Detail

initializeCGroupController

void initializeCGroupController(CGroupsHandler.CGroupController controller)
                         throws ResourceHandlerException

Mounts or initializes a cgroup controller.

Parameters:

controller - - the controller being initialized

Throws:

ResourceHandlerException - the initialization failed due to the environment

createCGroup

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

Creates a cgroup for a given controller.

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

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

Deletes the specified cgroup.

Parameters:

controller - - controller type for the cgroup

cGroupId - - id of the cgroup being deleted

Throws:

ResourceHandlerException - deletion failed

getControllerPath

java.lang.String getControllerPath(CGroupsHandler.CGroupController controller)

Gets the absolute path to the specified cgroup controller.

Parameters:

controller - - controller type for the cgroup

Returns:

the root of the controller.

getRelativePathForCGroup

java.lang.String getRelativePathForCGroup(java.lang.String cGroupId)

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

Parameters:

cGroupId - - id of the cgroup

Returns:

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

getPathForCGroup

java.lang.String getPathForCGroup(CGroupsHandler.CGroupController controller,
                                  java.lang.String cGroupId)

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

Parameters:

controller - - controller type for the cgroup

cGroupId - - id of the cgroup

Returns:

full path for the cgroup

getPathForCGroupTasks

java.lang.String getPathForCGroupTasks(CGroupsHandler.CGroupController controller,
                                       java.lang.String cGroupId)

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

Parameters:

controller - - controller type for the cgroup

cGroupId - - id of the cgroup

Returns:

full path for the cgroup's tasks file

getPathForCGroupParam

java.lang.String getPathForCGroupParam(CGroupsHandler.CGroupController controller,
                                       java.lang.String cGroupId,
                                       java.lang.String param)

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

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

updateCGroupParam

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

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

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

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

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

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

java.lang.String getCGroupMountPath()

Returns CGroup Mount Path.

Returns:

parameter value as read from the parameter file