14e68ac6e9
A later patch in the pci-device-tracking-in-placement work will extend the existing [pci]passthrough_whitelist config syntax. So we take the opportunity here to deprecate the old non inclusive passthrough_whitelist name and introduce a better one. All the usage of CONF.pci.passthrough_whitelist is now changed over to the new device_spec config. Also the in tree documentation is updated accordinly. However the nova code still has a bunch of references to the "whitelist" terminology. That will be handled in subsequent patches. blueprint: pci-device-tracking-in-placement Change-Id: I843032e113642416114f169069eebf6a56ed78dd
103 lines
3.6 KiB
Python
103 lines
3.6 KiB
Python
# Copyright (c) 2013 Intel, Inc.
|
|
# Copyright (c) 2013 OpenStack Foundation
|
|
# All Rights Reserved.
|
|
#
|
|
# 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.
|
|
|
|
import typing as ty
|
|
|
|
from oslo_serialization import jsonutils
|
|
|
|
from nova import exception
|
|
from nova.i18n import _
|
|
from nova import objects
|
|
from nova.pci import devspec
|
|
|
|
|
|
class Whitelist(object):
|
|
"""White list class to represent assignable pci devices.
|
|
|
|
Not all devices on a compute node can be assigned to a guest. The cloud
|
|
administrator decides which devices can be assigned based on ``vendor_id``
|
|
or ``product_id``, etc. If no white list is specified, no devices will be
|
|
assignable.
|
|
"""
|
|
|
|
def __init__(self, whitelist_spec: str = None) -> None:
|
|
"""White list constructor
|
|
|
|
For example, the following json string specifies that devices whose
|
|
vendor_id is '8086' and product_id is '1520' can be assigned
|
|
to guests. ::
|
|
|
|
'[{"product_id":"1520", "vendor_id":"8086"}]'
|
|
|
|
:param whitelist_spec: A JSON string for a dictionary or list thereof.
|
|
Each dictionary specifies the pci device properties requirement.
|
|
See the definition of ``device_spec`` in
|
|
``nova.conf.pci`` for details and examples.
|
|
"""
|
|
if whitelist_spec:
|
|
self.specs = self._parse_white_list_from_config(whitelist_spec)
|
|
else:
|
|
self.specs = []
|
|
|
|
@staticmethod
|
|
def _parse_white_list_from_config(
|
|
whitelists: str,
|
|
) -> ty.List[devspec.PciDeviceSpec]:
|
|
"""Parse and validate the pci whitelist from the nova config."""
|
|
specs = []
|
|
for jsonspec in whitelists:
|
|
try:
|
|
dev_spec = jsonutils.loads(jsonspec)
|
|
except ValueError:
|
|
raise exception.PciConfigInvalidWhitelist(
|
|
reason=_("Invalid entry: '%s'") % jsonspec)
|
|
if isinstance(dev_spec, dict):
|
|
dev_spec = [dev_spec]
|
|
elif not isinstance(dev_spec, list):
|
|
raise exception.PciConfigInvalidWhitelist(
|
|
reason=_("Invalid entry: '%s'; "
|
|
"Expecting list or dict") % jsonspec)
|
|
|
|
for ds in dev_spec:
|
|
if not isinstance(ds, dict):
|
|
raise exception.PciConfigInvalidWhitelist(
|
|
reason=_("Invalid entry: '%s'; "
|
|
"Expecting dict") % ds)
|
|
|
|
spec = devspec.PciDeviceSpec(ds)
|
|
specs.append(spec)
|
|
|
|
return specs
|
|
|
|
def device_assignable(self, dev: ty.Dict[str, ty.Any]) -> bool:
|
|
"""Check if a device can be assigned to a guest.
|
|
|
|
:param dev: A dictionary describing the device properties
|
|
"""
|
|
for spec in self.specs:
|
|
if spec.match(dev):
|
|
return True
|
|
return False
|
|
|
|
def get_devspec(
|
|
self, pci_dev: 'objects.PciDevice',
|
|
) -> ty.Optional[devspec.PciDeviceSpec]:
|
|
for spec in self.specs:
|
|
if spec.match_pci_obj(pci_dev):
|
|
return spec
|
|
|
|
return None
|