@InterfaceAudience.Private
 @InterfaceStability.Unstable
public interface AbstractFpgaVendorPlugin
FpgaDiscoverer and
 FpgaResourceHandlerImpl
 to discover devices/download IP/configure IP| Modifier and Type | Method and Description | 
|---|---|
| boolean | configureIP(String ipPath,
           FpgaDevice device)The vendor plugin configure an IP file to a device | 
| boolean | diagnose(int timeout)Diagnose the devices using vendor toolchain but no need to parse device information | 
| List<FpgaDevice> | discover(int timeout)Discover the vendor's FPGA devices with execution time constraint | 
| String | getFpgaType()Since all vendor plugins share a  FpgaResourceAllocatorwhich distinguish FPGA devices by type. | 
| boolean | initPlugin(org.apache.hadoop.conf.Configuration conf)Check vendor's toolchain and required environment | 
| String | retrieveIPfilePath(String id,
                  String dstDir,
                  Map<org.apache.hadoop.fs.Path,List<String>> localizedResources)The vendor plugin download required IP files to a required directory. | 
boolean initPlugin(org.apache.hadoop.conf.Configuration conf)
conf - Hadoop configurationboolean diagnose(int timeout)
timeout - timeout in millisecondsList<FpgaDevice> discover(int timeout)
timeout - The vendor plugin should return result during this timeString getFpgaType()
FpgaResourceAllocator
 which distinguish FPGA devices by type. Vendor plugin must report this.String retrieveIPfilePath(String id, String dstDir, Map<org.apache.hadoop.fs.Path,List<String>> localizedResources)
id - The identifier for IP file. Comes from application, ie. matrix_multi_v1dstDir - The plugin should download IP file to this directorylocalizedResources - The container localized resource can be searched for IP file. Key is
 localized file path and value is soft link namesboolean configureIP(String ipPath, FpgaDevice device)
ipPath - The absolute path of the IP filedevice - The FPGA device objectCopyright © 2008–2023 Apache Software Foundation. All rights reserved.