Package org.apache.hadoop.yarn.server.nodemanager.containermanager.resourceplugin.fpga

Class IntelFpgaOpenclPlugin

java.lang.Object

org.apache.hadoop.yarn.server.nodemanager.containermanager.resourceplugin.fpga.IntelFpgaOpenclPlugin

All Implemented Interfaces:

AbstractFpgaVendorPlugin

public class IntelFpgaOpenclPlugin
extends java.lang.Object
implements AbstractFpgaVendorPlugin

Intel FPGA for OpenCL plugin. The key points are: 1. It uses Intel's toolchain "aocl" to discover devices/reprogram IP to the device before container launch to achieve a quickest reprogramming path 2. It avoids reprogramming by maintaining a mapping of device to FPGA IP ID 3. It assume IP file is distributed to container directory

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IntelFpgaOpenclPlugin.InnerShellExecutor	Helper class to run aocl diagnose & determine major/minor numbers.

Constructor Summary

Constructors

Constructor	Description
IntelFpgaOpenclPlugin()

Method Summary

Modifier and Type	Method	Description
boolean	configureIP(java.lang.String ipPath, FpgaDevice device)	Program one device.
boolean	diagnose(int timeout)	Diagnose the devices using vendor toolchain but no need to parse device information
java.util.List<FpgaDevice>	discover(int timeout)	Discover the vendor's FPGA devices with execution time constraint
java.lang.String	getDefaultPathToExecutable()
java.lang.String	getDiagnoseInfo(int timeout)
java.lang.String	getFpgaType()	this is actually the opencl platform type
boolean	initPlugin(org.apache.hadoop.conf.Configuration config)	Check the Intel FPGA for OpenCL toolchain.
java.lang.String	retrieveIPfilePath(java.lang.String id, java.lang.String dstDir, java.util.Map<org.apache.hadoop.fs.Path,java.util.List<java.lang.String>> localizedResources)	The vendor plugin download required IP files to a required directory.

Methods inherited from class java.lang.Object

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

Constructor Detail

IntelFpgaOpenclPlugin

public IntelFpgaOpenclPlugin()

Method Detail

getDefaultPathToExecutable

public java.lang.String getDefaultPathToExecutable()

initPlugin

public boolean initPlugin(org.apache.hadoop.conf.Configuration config)

Check the Intel FPGA for OpenCL toolchain.

Specified by:

initPlugin in interface AbstractFpgaVendorPlugin

Parameters:

config - Hadoop configuration

Returns:

true if the initialization was successful

discover

public java.util.List<FpgaDevice> discover(int timeout)

Description copied from interface: AbstractFpgaVendorPlugin

Discover the vendor's FPGA devices with execution time constraint

Specified by:

discover in interface AbstractFpgaVendorPlugin

Parameters:

timeout - The vendor plugin should return result during this time

Returns:

The result will be added to FPGAResourceAllocator for later scheduling

getDiagnoseInfo

public java.lang.String getDiagnoseInfo(int timeout)

diagnose

public boolean diagnose(int timeout)

Description copied from interface: AbstractFpgaVendorPlugin

Diagnose the devices using vendor toolchain but no need to parse device information

Specified by:

diagnose in interface AbstractFpgaVendorPlugin

Parameters:

timeout - timeout in milliseconds

Returns:

true if the diagnostics was successful

getFpgaType

public java.lang.String getFpgaType()

this is actually the opencl platform type

Specified by:

getFpgaType in interface AbstractFpgaVendorPlugin

Returns:

the type of FPGA plugin represented as a string

retrieveIPfilePath

public java.lang.String retrieveIPfilePath(java.lang.String id,
                                           java.lang.String dstDir,
                                           java.util.Map<org.apache.hadoop.fs.Path,java.util.List<java.lang.String>> localizedResources)

Description copied from interface: AbstractFpgaVendorPlugin

The vendor plugin download required IP files to a required directory. It should check if the IP file has already been downloaded.

Specified by:

retrieveIPfilePath in interface AbstractFpgaVendorPlugin

Parameters:

id - The identifier for IP file. Comes from application, ie. matrix_multi_v1

dstDir - The plugin should download IP file to this directory

localizedResources - The container localized resource can be searched for IP file. Key is localized file path and value is soft link names

Returns:

The absolute path string of IP file

configureIP

public boolean configureIP(java.lang.String ipPath,
                           FpgaDevice device)

Program one device. It's ok for the offline "aocl program" failed because the application will always invoke API to program. The reason we do offline reprogramming is to make the application's program process faster.

Specified by:

configureIP in interface AbstractFpgaVendorPlugin

Parameters:

ipPath - the absolute path to the aocx IP file

device - Fpga device object which represents the card

Returns:

false if programming the card fails