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

Class FpgaResourceHandlerImpl

java.lang.Object

org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.resources.fpga.FpgaResourceHandlerImpl

All Implemented Interfaces:

ResourceHandler

@Unstable
@Private
public class FpgaResourceHandlerImpl
extends java.lang.Object
implements ResourceHandler

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	CONTAINER_ID_CLI_OPTION
static java.lang.String	EXCLUDED_FPGAS_CLI_OPTION

Constructor Summary

Constructors

Constructor	Description
FpgaResourceHandlerImpl(Context nmContext, CGroupsHandler cGroupsHandler, PrivilegedOperationExecutor privilegedOperationExecutor, AbstractFpgaVendorPlugin plugin, FpgaDiscoverer fpgaDiscoverer)

Method Summary

Modifier and Type	Method	Description
java.util.List<PrivilegedOperation>	bootstrap(org.apache.hadoop.conf.Configuration configuration)	Bootstrap resource susbsystem.
java.lang.String	getRequestedIPID(Container container)
java.util.List<PrivilegedOperation>	postComplete(org.apache.hadoop.yarn.api.records.ContainerId containerId)	Perform any tasks necessary after container completion.
java.util.List<PrivilegedOperation>	preStart(Container container)	Prepare a resource environment for container launch
java.util.List<PrivilegedOperation>	reacquireContainer(org.apache.hadoop.yarn.api.records.ContainerId containerId)	Require state for container that was already launched
java.util.List<PrivilegedOperation>	teardown()	Teardown environment for resource subsystem if requested.
java.lang.String	toString()
java.util.List<PrivilegedOperation>	updateContainer(Container container)	Update state for container that was already launched

Methods inherited from class java.lang.Object

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

Field Detail

EXCLUDED_FPGAS_CLI_OPTION

public static final java.lang.String EXCLUDED_FPGAS_CLI_OPTION

See Also:

Constant Field Values

CONTAINER_ID_CLI_OPTION

public static final java.lang.String CONTAINER_ID_CLI_OPTION

See Also:

Constant Field Values

Constructor Detail

FpgaResourceHandlerImpl

@VisibleForTesting
public FpgaResourceHandlerImpl(Context nmContext,
                               CGroupsHandler cGroupsHandler,
                               PrivilegedOperationExecutor privilegedOperationExecutor,
                               AbstractFpgaVendorPlugin plugin,
                               FpgaDiscoverer fpgaDiscoverer)

Method Detail

getRequestedIPID

public java.lang.String getRequestedIPID(Container container)

bootstrap

public java.util.List<PrivilegedOperation> bootstrap(org.apache.hadoop.conf.Configuration configuration)
                                              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

preStart

public java.util.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

reacquireContainer

public java.util.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

updateContainer

public java.util.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

postComplete

public java.util.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 java.util.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 java.lang.String toString()

Overrides:

toString in class java.lang.Object