cyborg/cyborg/accelerator/drivers/fpga/intel/sysinfo.py

262 lines
8.1 KiB
Python

# Copyright 2018 Intel, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
"""
Cyborg Intel FPGA driver implementation.
"""
# from cyborg.accelerator.drivers.fpga.base import FPGADriver
import glob
import os
import re
from oslo_serialization import jsonutils
from cyborg.agent import rc_fields
from cyborg.objects.driver_objects import driver_deployable, driver_device,\
driver_attach_handle, driver_controlpath_id, driver_attribute
from cyborg.common import constants
SYS_FPGA = "/sys/class/fpga"
DEVICE = "device"
PF = "physfn"
VF = "virtfn*"
BDF_PATTERN = re.compile(
"^[a-fA-F\d]{4}:[a-fA-F\d]{2}:[a-fA-F\d]{2}\.[a-fA-F\d]$")
DEVICE_FILE_MAP = {"vendor": "vendor",
"device": "product_id"}
DEVICE_FILE_HANDLER = {}
DEVICE_EXPOSED = ["vendor", "device"]
RC_FPGA = rc_fields.ResourceClass.normalize_name(
rc_fields.ResourceClass.FPGA)
RESOURCES = {
"fpga": RC_FPGA
}
def all_fpgas():
# glob.glob1("/sys/class/fpga", "*")
return glob.glob(os.path.join(SYS_FPGA, "*"))
def all_vf_fpgas():
return [dev.rsplit("/", 2)[0] for dev in
glob.glob(os.path.join(SYS_FPGA, "*/device/physfn"))]
def all_pfs_have_vf():
return [dev.rsplit("/", 2)[0] for dev in
glob.glob(os.path.join(SYS_FPGA, "*/device/virtfn0"))]
def target_symbolic_map():
maps = {}
for f in glob.glob(os.path.join(SYS_FPGA, "*/device")):
maps[os.path.realpath(f)] = os.path.dirname(f)
return maps
def bdf_path_map():
maps = {}
for f in glob.glob(os.path.join(SYS_FPGA, "*/device")):
maps[os.path.basename(os.path.realpath(f))] = os.path.dirname(f)
return maps
def all_vfs_in_pf_fpgas(pf_path):
maps = target_symbolic_map()
vfs = glob.glob(os.path.join(pf_path, "device/virtfn*"))
return [maps[os.path.realpath(vf)] for vf in vfs]
def all_pf_fpgas():
return [dev.rsplit("/", 2)[0] for dev in
glob.glob(os.path.join(SYS_FPGA, "*/device/sriov_totalvfs"))]
def is_vf(path):
return True if glob.glob(os.path.join(path, "device/physfn")) else False
def find_pf_by_vf(path):
maps = target_symbolic_map()
p = os.path.realpath(os.path.join(path, "device/physfn"))
return maps[p]
def is_bdf(bdf):
return True if BDF_PATTERN.match(bdf) else False
def get_bdf_by_path(path):
return os.path.basename(os.readlink(os.path.join(path, "device")))
def split_bdf(bdf):
return ["0x" + v for v in bdf.replace(".", ":").rsplit(":")[1:]]
def get_pf_bdf(bdf):
path = bdf_path_map().get(bdf)
if path:
path = find_pf_by_vf(path) if is_vf(path) else path
return get_bdf_by_path(path)
return bdf
def get_afu_ids(name):
ids = []
for path in glob.glob(os.path.join(
SYS_FPGA, name, "intel-fpga-port.*", "afu_id")):
with open(path) as f:
first_line = f.readline()
ids.append(first_line.split('\n', 1)[0])
return ids
def get_traits(name, product_id):
# "region_id" not support at present, "CUSTOM_FPGA_REGION_INTEL_UUID"
# "CUSTOM_PROGRAMMABLE" not support at present
traits = ["CUSTOM_FPGA_INTEL"]
for i in get_afu_ids(name):
l = "CUSTOM_FPGA_INTEL_FUNCTION_" + i.upper()
traits.append(l)
return {"traits": traits}
def fpga_device(path):
infos = {}
def read_line(filename):
with open(filename) as f:
return f.readline().strip()
# NOTE "In 3.x, os.path.walk is removed in favor of os.walk."
for (dirpath, dirnames, filenames) in os.walk(path):
for filename in filenames:
if filename in DEVICE_EXPOSED:
key = DEVICE_FILE_MAP.get(filename) or filename
if key in DEVICE_FILE_HANDLER and callable(
DEVICE_FILE_HANDLER(key)):
infos[key] = DEVICE_FILE_HANDLER(key)(
os.path.join(dirpath, filename))
else:
infos[key] = read_line(os.path.join(dirpath, filename))
return infos
def fpga_tree():
def gen_fpga_infos(path, vf=True):
name = os.path.basename(path)
dpath = os.path.realpath(os.path.join(path, DEVICE))
bdf = os.path.basename(dpath)
fpga = {"type": constants.DEVICE_FPGA,
"devices": bdf,
"name": name}
d_info = fpga_device(dpath)
fpga.update(d_info)
traits = get_traits(fpga["name"], fpga["product_id"])
fpga.update(traits)
fpga["rc"] = RESOURCES["fpga"]
return fpga
devs = []
pf_has_vf = all_pfs_have_vf()
for pf in all_pf_fpgas():
fpga = gen_fpga_infos(pf, False)
if pf in pf_has_vf:
# Currently only one region supported.
fpga["regions"] = []
# All VFs here belong to one same region.
vfs = all_vfs_in_pf_fpgas(pf)
for vf in vfs:
vf_fpga = gen_fpga_infos(vf, True)
fpga["regions"].append(vf_fpga)
devs.append(_generate_driver_device(fpga, pf in pf_has_vf))
return devs
def _generate_driver_device(fpga, pf_has_vf):
driver_device_obj = driver_device.DriverDevice()
driver_device_obj.vendor = fpga["vendor"]
driver_device_obj.model = fpga.get('model', "miss_model_info")
driver_device_obj.vendor_board_info = fpga.get('vendor_board_info',
"miss_vb_info")
std_board_info = {'product_id': fpga.get('product_id', None)}
driver_device_obj.std_board_info = jsonutils.dumps(std_board_info)
driver_device_obj.type = fpga["type"]
driver_device_obj.controlpath_id = _generate_controlpath_id(fpga)
driver_device_obj.deployable_list = _generate_dep_list(fpga, pf_has_vf)
return driver_device_obj
def _generate_controlpath_id(fpga):
driver_cpid = driver_controlpath_id.DriverControlPathID()
driver_cpid.cpid_type = "PCI"
driver_cpid.cpid_info = fpga["devices"]
return driver_cpid
def _generate_dep_list(fpga, pf_has_vf):
dep_list = []
driver_dep = driver_deployable.DriverDeployable()
driver_dep.attribute_list = _generate_attribute_list(fpga)
driver_dep.attach_handle_list = []
# pf without sriov enabled.
if not pf_has_vf:
driver_dep.num_accelerators = 1
driver_dep.attach_handle_list = \
[_generate_attach_handle(fpga, pf_has_vf)]
driver_dep.name = fpga["name"]
# pf with sriov enabled, may have several regions and several vfs.
# For now, there is only region, this maybe improve in next release.
else:
driver_dep.num_accelerators = len(fpga["regions"])
for vf in fpga["regions"]:
# Only vfs in regions can be attach, no pf.
driver_dep.attach_handle_list.append(
_generate_attach_handle(vf, False))
driver_dep.name = vf["name"]
return [driver_dep]
def _generate_attach_handle(fpga, pf_has_vf):
driver_ah = driver_attach_handle.DriverAttachHandle()
driver_ah.attach_type = "PCI"
driver_ah.attach_info = fpga["devices"]
driver_ah.in_use = False
return driver_ah
def _generate_attribute_list(fpga):
attr_list = []
for k, v in fpga.items():
if k == "rc":
driver_attr = driver_attribute.DriverAttribute()
driver_attr.key = k
driver_attr.value = fpga.get(k, None)
attr_list.append(driver_attr)
if k == "traits":
values = fpga.get(k, None)
for val in values:
driver_attr = driver_attribute.DriverAttribute()
driver_attr.key = "trait" + str(values.index(val))
driver_attr.value = val
attr_list.append(driver_attr)
return attr_list