Package org.apache.hadoop.yarn.server.nodemanager.containermanager.resourceplugin.com.nec

Class NECVEPlugin

java.lang.Object

org.apache.hadoop.yarn.server.nodemanager.containermanager.resourceplugin.com.nec.NECVEPlugin

All Implemented Interfaces:

DevicePlugin, DevicePluginScheduler

public class NECVEPlugin
extends java.lang.Object
implements DevicePlugin, DevicePluginScheduler

A device framework plugin which supports NEC Vector Engine.

Constructor Summary

Constructors

Constructor	Description
NECVEPlugin()

Method Summary

Modifier and Type	Method	Description
java.util.Set<Device>	allocateDevices(java.util.Set<Device> availableDevices, int count, java.util.Map<java.lang.String,java.lang.String> env)	Called when allocating devices.
java.util.Set<Device>	getDevices()	Called when update node resource.
DeviceRegisterRequest	getRegisterRequestInfo()	Called first when device plugin framework wants to register.
DeviceRuntimeSpec	onDevicesAllocated(java.util.Set<Device> set, YarnRuntimeType yarnRuntimeType)	Asking how these devices should be prepared/used before/when container launch.
void	onDevicesReleased(java.util.Set<Device> releasedDevices)	Called after device released.

Methods inherited from class java.lang.Object

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

Constructor Detail

NECVEPlugin

public NECVEPlugin()
            throws ResourceHandlerException

Throws:

ResourceHandlerException

Method Detail

getRegisterRequestInfo

public DeviceRegisterRequest getRegisterRequestInfo()

Description copied from interface: DevicePlugin

Called first when device plugin framework wants to register.

Specified by:

getRegisterRequestInfo in interface DevicePlugin

Returns:

DeviceRegisterRequest DeviceRegisterRequest

getDevices

public java.util.Set<Device> getDevices()

Description copied from interface: DevicePlugin

Called when update node resource.

Specified by:

getDevices in interface DevicePlugin

Returns:

a set of Device, TreeSet recommended

onDevicesAllocated

public DeviceRuntimeSpec onDevicesAllocated(java.util.Set<Device> set,
                                            YarnRuntimeType yarnRuntimeType)

Description copied from interface: DevicePlugin

Asking how these devices should be prepared/used before/when container launch. A plugin can do some tasks in its own or define it in DeviceRuntimeSpec to let the framework do it. For instance, define VolumeSpec to let the framework to create volume before running container.

Specified by:

onDevicesAllocated in interface DevicePlugin

Parameters:

set - A set of allocated Device.

yarnRuntimeType - Indicate which runtime YARN will use Could be RUNTIME_DEFAULT or RUNTIME_DOCKER in DeviceRuntimeSpec constants. The default means YARN's non-docker container runtime is used. The docker means YARN's docker container runtime is used.

Returns:

a DeviceRuntimeSpec description about environment, VolumeSpec, MountVolumeSpec. etc

onDevicesReleased

public void onDevicesReleased(java.util.Set<Device> releasedDevices)

Description copied from interface: DevicePlugin

Called after device released.

Specified by:

onDevicesReleased in interface DevicePlugin

Parameters:

releasedDevices - A set of released devices

allocateDevices

public java.util.Set<Device> allocateDevices(java.util.Set<Device> availableDevices,
                                             int count,
                                             java.util.Map<java.lang.String,java.lang.String> env)

Description copied from interface: DevicePluginScheduler

Called when allocating devices. The framework will do all device book keeping and fail recovery. So this hook could be stateless and only do scheduling based on available devices passed in. It could be invoked multiple times by the framework. The hint in environment variables passed in could be potentially used in making better scheduling decision. For instance, GPU scheduling might support different kind of policy. The container can set it through environment variables.

Specified by:

allocateDevices in interface DevicePluginScheduler

Parameters:

availableDevices - Devices allowed to be chosen from.

count - Number of device to be allocated.

env - Environment variables of the container.

Returns:

A set of Device allocated