openstack/cyborg
Code Issues Proposed changes

Merge "P2: Changes for db layer, constants and exceptions."

Browse Source
This commit is contained in:
Zuul 2019-08-01 05:59:10 +00:00 committed by Gerrit Code Review
commit d88068f3c2
6 changed files with 256 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
cyborg/common/constants.py
View File

@ -21,7 +21,7 @@ DEVICE_FPGA = 'FPGA'
DEVICE_AICHIP = 'AICHIP'
ARQ_STATES = (ARQINITIAL, ARQBOUND, ARQUNBOUND, ARQBINDFAILED) = \
ARQ_STATES = (ARQ_INITIAL, ARQ_BOUND, ARQ_UNBOUND, ARQ_BIND_FAILED) = \
('Initial', 'Bound', 'Unbound', 'BindFailed')
# Device type

40
cyborg/common/exception.py
View File

@ -86,6 +86,11 @@ class CyborgException(Exception):
return unicode(self.args[0])
class ARQInvalidState(CyborgException):
_msg_fmt = _("Accelerator Requests cannot be requested with "
"state %(state)s.")
class AttachHandleAlreadyExists(CyborgException):
_msg_fmt = _("AttachHandle with uuid %(uuid)s already exists.")
@ -106,6 +111,18 @@ class DeviceProfileAlreadyExists(CyborgException):
_msg_fmt = _("DeviceProfile with uuid %(uuid)s already exists.")
class DeviceProfileNameNotFound(CyborgException):
_msg_fmt = _("DeviceProfile with name %(name)s not found.")
class DeviceProfileNameNeeded(CyborgException):
_msg_fmt = _("DeviceProfile name needed.")
class DeviceProfileGroupsExpected(CyborgException):
_msg_fmt = _("DeviceProfile needs groups field.")
class DeployableAlreadyExists(CyborgException):
_msg_fmt = _("Deployable with uuid %(uuid)s already exists.")
@ -114,6 +131,15 @@ class ExtArqAlreadyExists(CyborgException):
_msg_fmt = _("ExtArq with uuid %(uuid)s already exists.")
class ExpectedOneObject(CyborgException):
_msg_fmt = _("Expected one object of type %(obj)s "
"but got %(count)s.")
class InUse(CyborgException):
_msg_fmt = _("%(object) with %(ident)s is in use.")
class Invalid(CyborgException):
_msg_fmt = _("Invalid parameters.")
code = http_client.BAD_REQUEST
@ -137,6 +163,10 @@ class InvalidParameterValue(Invalid):
_msg_fmt = _("%(err)s")
class NeedAtleastOne(Invalid):
_msg_fmt = _("Need at least one %(obj)s.")
class PatchError(Invalid):
_msg_fmt = _("Couldn't apply patch '%(patch)s'. Reason: %(reason)s")
@ -367,3 +397,13 @@ class ImageBadRequest(Invalid):
class InvalidDriver(Invalid):
_msg_fmt = _("Found an invalid driver: %(name)s")
class InvalidType(Invalid):
_msg_fmt = _("Invalid type for %(obj)s: %(type)s."
"Expected: %(expected)s")
# TODO Merge other NotFound in this generic one?
class ResourceNotFound(Invalid):
_msg_fmt = _("%(resource)s not found %(msg)s")

14
cyborg/db/api.py
View File

@ -51,7 +51,8 @@ class Connection(object):
"""Get requested device."""
@abc.abstractmethod
def device_list(self, context, limit, marker, sort_key, sort_dir):
def device_list(self, context, limit=None, marker=None,
sort_key=None, sort_dir=None):
"""Get requested list of devices."""
@abc.abstractmethod
@ -82,6 +83,10 @@ class Connection(object):
def device_profile_get_by_id(self, context, id):
"""Get requested device_profile by id."""
@abc.abstractmethod
def device_profile_get(self, context, name):
"""Get requested device_profile by name."""
@abc.abstractmethod
def device_profile_list(self, context):
"""Get requested list of device_profiles."""
@ -133,6 +138,11 @@ class Connection(object):
def deployable_get_by_filters_with_attributes(self, context,
filters):
"""Get requested deployable by filters with attributes."""
@abc.abstractmethod
def deployable_get_by_rp_uuid(self, context, rp_uuid):
"""Get requested deployable by resource provider UUID."""
# attributes
@abc.abstractmethod
def attribute_create(self, context, values):
@ -183,7 +193,7 @@ class Connection(object):
"""Update an extarq."""
@abc.abstractmethod
def extarq_list(self, context, limit, marker, sort_key, sort_dir):
def extarq_list(self, context):
"""Get requested list of extarqs."""
@abc.abstractmethod

67
cyborg/db/sqlalchemy/alembic/versions/c1b5abada09c_update_for_nova_integ.py Normal file
View File

@ -0,0 +1,67 @@
#
# 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.
"""update_for_nova_integ
Revision ID: c1b5abada09c
Revises: 589ff20545b7
Create Date: 2019-07-11 22:13:45.773499
"""
# revision identifiers, used by Alembic.
revision = 'c1b5abada09c'
down_revision = '589ff20545b7'
from alembic import op
import sqlalchemy as sa
from cyborg.common import constants
def upgrade():
# Update Deployables
op.add_column(
'deployables',
sa.Column('rp_uuid', sa.String(length=36), nullable=True))
op.add_column(
'deployables',
sa.Column('driver_name', sa.String(length=100), nullable=True))
op.add_column(
'deployables',
sa.Column('num_accelerators_in_use', sa.Integer(), default=0))
# Update ExtARQ table
op.add_column(
'extended_accelerator_requests',
sa.Column('device_profile_group_id', sa.Integer(), nullable=False))
op.add_column(
'extended_accelerator_requests',
sa.Column('instance_uuid', sa.String(length=36),
nullable=True))
op.create_index('extArqs_instance_uuid_idx', # index name
'extended_accelerator_requests', # table name
['instance_uuid'] # columns on which index is defined
)
op.drop_index('extArqs_device_instance_uuid_idx', # index name
'extended_accelerator_requests', # table name
)
op.drop_column('extended_accelerator_requests', 'device_instance_uuid')
# Add more valid states for 'state' field
ns = sa.Enum(constants.ARQ_INITIAL,
constants.ARQ_BOUND,
constants.ARQ_UNBOUND,
constants.ARQ_BIND_FAILED, name='state')
op.alter_column(
'extended_accelerator_requests', 'state',
existing_type=ns, nullable=False, default=constants.ARQ_INITIAL)

144
cyborg/db/sqlalchemy/api.py
View File

@ -106,7 +106,8 @@ def add_identity_filter(query, value):
raise exception.InvalidIdentity(identity=value)
def _paginate_query(context, model, limit, marker, sort_key, sort_dir, query):
def _paginate_query(context, model, query, limit=None, marker=None,
sort_key=None, sort_dir=None):
sort_keys = ['id']
if sort_key and sort_key not in sort_keys:
sort_keys.insert(0, sort_key)
@ -158,7 +159,19 @@ class Connection(api.Connection):
try:
return query.one()
except NoResultFound:
raise exception.NotFound()
raise exception.ResourceNotFound(
resource='Attach Handle',
msg='with id=%s' % id)
def attach_handle_list_by_type(self, context, attach_type='PCI'):
query = model_query(context, models.AttachHandle). \
filter_by(attach_type=attach_type)
try:
return query.all()
except NoResultFound:
raise exception.ResourceNotFound(
resource='Attach Handle',
msg='with type=%s' % attach_type)
def attach_handle_get_by_filters(self, context,
filters, sort_key='created_at',
@ -182,8 +195,8 @@ class Connection(api.Connection):
filters, exact_match_filter_names)
if query_prefix is None:
return []
return _paginate_query(context, models.AttachHandle, limit, marker,
sort_key, sort_dir, query_prefix)
return _paginate_query(context, models.AttachHandle, query_prefix,
limit, marker, sort_key, sort_dir)
def _exact_filter(self, model, query, filters, legal_keys=[]):
"""Applies exact match filtering to a deployable query.
@ -225,7 +238,7 @@ class Connection(api.Connection):
def attach_handle_list(self, context):
query = model_query(context, models.AttachHandle)
return _paginate_query(context, models.AttachHandle)
return _paginate_query(context, models.AttachHandle, query=query)
def attach_handle_update(self, context, uuid, values):
if 'uuid' in values:
@ -245,6 +258,39 @@ class Connection(api.Connection):
ref.update(values)
return ref
@oslo_db_api.retry_on_deadlock
def _do_allocate_attach_handle(self, context, query, values):
"""Atomically get a set of attach handles that match the query
and mark one of those as in_use.
"""
with _session_for_write() as session:
ref = query.with_lockmode('update').one()
ref.update(values)
# FIXME The in_use field doesn't get updated in db.
session.flush()
return ref
def attach_handle_allocate(self, context, attach_type, deployable_id):
"""Allocate an attach handle with a given type and deployable.
To allocate is to get an unused resource and mark it as in_use.
"""
query = model_query(context, models.AttachHandle). \
filter_by(attach_type=attach_type,
deployable_id=deployable_id,
in_use=False)
values = {"in_use": True}
try:
ah = self._do_allocate_attach_handle(context, query, values)
except NoResultFound:
msg = 'Matching attach_type {0} and deployable_id {1}'.format(
attach_type, deployable_id)
raise exception.ResourceNotFound(
resource='AttachHandle', msg=msg)
return ah
# NOTE: For deallocate, we use attach_handle_update()
@oslo_db_api.retry_on_deadlock
def attach_handle_delete(self, context, uuid):
with _session_for_write():
@ -301,12 +347,12 @@ class Connection(api.Connection):
filters, exact_match_filter_names)
if query_prefix is None:
return []
return _paginate_query(context, models.ControlpathID, limit, marker,
sort_key, sort_dir, query_prefix)
return _paginate_query(context, models.ControlpathID, query_prefix,
limit, marker, sort_key, sort_dir)
def control_path_list(self, context):
query = model_query(context, models.ControlpathID)
return _paginate_query(context, models.ControlpathID)
return _paginate_query(context, models.ControlpathID, query=query)
def control_path_update(self, context, uuid, values):
if 'uuid' in values:
@ -379,12 +425,14 @@ class Connection(api.Connection):
filters, exact_match_filter_names)
if query_prefix is None:
return []
return _paginate_query(context, models.Device, limit, marker,
sort_key, sort_dir, query_prefix)
return _paginate_query(context, models.Device, query_prefix,
limit, marker, sort_key, sort_dir)
def device_list(self, context):
def device_list(self, context, limit=None, marker=None,
sort_key=None, sort_dir=None):
query = model_query(context, models.Device)
return _paginate_query(context, models.Device)
return _paginate_query(context, models.Device, query,
limit, marker, sort_key, sort_dir)
def device_update(self, context, uuid, values):
if 'uuid' in values:
@ -452,6 +500,14 @@ class Connection(api.Connection):
except NoResultFound:
raise exception.DeviceProfileNotFound(id=id)
def device_profile_get(self, context, name):
query = model_query(
context, models.DeviceProfile).filter_by(name=name)
try:
return query.one()
except NoResultFound:
raise exception.DeviceProfileNotFound(name=name)
def device_profile_list_by_filters(
self, context, filters, sort_key='created_at', sort_dir='desc',
limit=None, marker=None, join_columns=None):
@ -468,12 +524,12 @@ class Connection(api.Connection):
filters, exact_match_filter_names)
if query_prefix is None:
return []
return _paginate_query(context, models.DeviceProfile, limit, marker,
sort_key, sort_dir, query_prefix)
return _paginate_query(context, models.DeviceProfile, query_prefix,
limit, marker, sort_key, sort_dir)
def device_profile_list(self, context):
query = model_query(context, models.DeviceProfile)
return _paginate_query(context, models.DeviceProfile)
return _paginate_query(context, models.DeviceProfile, query=query)
def device_profile_update(self, context, uuid, values):
if 'uuid' in values:
@ -509,6 +565,7 @@ class Connection(api.Connection):
raise exception.DeviceProfileNotFound(uuid=uuid)
def deployable_create(self, context, values):
raise NotImplementedError() # TODO
if not values.get('uuid'):
values['uuid'] = uuidutils.generate_uuid()
if values.get('id'):
@ -525,6 +582,7 @@ class Connection(api.Connection):
return deployable
def deployable_get(self, context, uuid):
raise NotImplementedError() # TODO
query = model_query(
context,
models.Deployable).filter_by(uuid=uuid)
@ -533,11 +591,20 @@ class Connection(api.Connection):
except NoResultFound:
raise exception.DeployableNotFound(uuid=uuid)
def deployable_get_by_rp_uuid(self, context, rp_uuid):
"""Get a deployable by resource provider UUID."""
query = model_query(
context,
models.Deployable).filter_by(rp_uuid=rp_uuid)
return query.one()
def deployable_list(self, context):
raise NotImplementedError() # TODO
query = model_query(context, models.Deployable)
return query.all()
def deployable_update(self, context, uuid, values):
raise NotImplementedError() # TODO
if 'uuid' in values:
msg = _("Cannot overwrite UUID for an existing Deployable.")
raise exception.InvalidParameterValue(err=msg)
@ -564,6 +631,7 @@ class Connection(api.Connection):
@oslo_db_api.retry_on_deadlock
def deployable_delete(self, context, uuid):
raise NotImplementedError() # TODO
with _session_for_write():
query = model_query(context, models.Deployable)
query = add_identity_filter(query, uuid)
@ -574,6 +642,7 @@ class Connection(api.Connection):
def deployable_get_by_filters_with_attributes(self, context,
filters):
raise NotImplementedError() # TODO
exact_match_filter_names = ['id', 'uuid', 'name',
'parent_id', 'root_id',
@ -668,6 +737,7 @@ class Connection(api.Connection):
keys. Deleted deployables will be returned by default, unless
there's a filter that says otherwise.
"""
raise NotImplementedError() # TODO
if limit == 0:
return []
@ -685,10 +755,11 @@ class Connection(api.Connection):
exact_match_filter_names)
if query_prefix is None:
return []
return _paginate_query(context, models.Deployable, limit, marker,
sort_key, sort_dir, query_prefix)
return _paginate_query(context, models.Deployable, query_prefix,
limit, marker, sort_key, sort_dir)
def attribute_create(self, context, values):
raise NotImplementedError() # TODO
if not values.get('uuid'):
values['uuid'] = uuidutils.generate_uuid()
if values.get('id'):
@ -706,6 +777,7 @@ class Connection(api.Connection):
return attribute
def attribute_get(self, context, uuid):
raise NotImplementedError() # TODO
query = model_query(
context,
models.Attribute).filter_by(uuid=uuid)
@ -715,12 +787,14 @@ class Connection(api.Connection):
raise exception.AttributeNotFound(uuid=uuid)
def attribute_get_by_deployable_id(self, context, deployable_id):
raise NotImplementedError() # TODO
query = model_query(
context,
models.Attribute).filter_by(deployable_id=deployable_id)
return query.all()
def attribute_get_by_filter(self, context, filters):
raise NotImplementedError() # TODO
"""Return attributes that matches the filters
"""
query_prefix = model_query(context, models.Attribute)
@ -748,6 +822,7 @@ class Connection(api.Connection):
# return query
def attribute_update(self, context, uuid, key, value):
raise NotImplementedError() # TODO
return self._do_update_attribute(context, uuid, key, value)
@oslo_db_api.retry_on_deadlock
@ -765,6 +840,7 @@ class Connection(api.Connection):
return ref
def attribute_delete(self, context, uuid):
raise NotImplementedError() # TODO
with _session_for_write():
query = model_query(context, models.Attribute)
query = add_identity_filter(query, uuid)
@ -777,6 +853,17 @@ class Connection(api.Connection):
values['uuid'] = uuidutils.generate_uuid()
if values.get('id'):
values.pop('id', None)
if values.get('device_profile_id'):
pass # Already have the devprof id, so nothing to do
elif values.get('device_profile_name'):
devprof = self.device_profile_get(context,
values['device_profile_name'])
values['device_profile_id'] = devprof['id']
else:
# TODO Use proper exception
raise exception.DeviceProfileNameNeeded()
extarq = models.ExtArq()
extarq.update(values)
@ -815,10 +902,9 @@ class Connection(api.Connection):
ref.update(values)
return ref
def extarq_list(self, context, limit, marker, sort_key, sort_dir):
def extarq_list(self, context):
query = model_query(context, models.ExtArq)
return _paginate_query(context, models.Device, limit, marker,
sort_key, sort_dir, query)
return _paginate_query(context, models.ExtArq, query)
def extarq_get(self, context, uuid):
query = model_query(
@ -902,14 +988,9 @@ class Connection(api.Connection):
# create quota usage in DB if there is no record of this type
# of resource
if resource not in usages:
usages[resource] = self._quota_usage_create(project_id,
resource,
until_refresh
or None,
in_use=0,
reserved=0,
session=session
)
usages[resource] = self._quota_usage_create(
project_id, resource, until_refresh or None,
in_use=0, reserved=0, session=session)
refresh = True
elif usages[resource].in_use < 0:
# Negative in_use count indicates a desync, so try to
@ -928,7 +1009,8 @@ class Connection(api.Connection):
# refresh the usage
if refresh:
# Grab the sync routine
updates = self._sync_acc_res(context, resource, project_id)
updates = self._sync_acc_res(context,
resource, project_id)
for res, in_use in updates.items():
# Make sure we have a destination for the usage!
if res not in usages:
@ -969,8 +1051,8 @@ class Connection(api.Connection):
usages[resource].reserved += delta
session.flush()
if unders:
LOG.warning("Change will make usage less than 0 for the following "
"resources: %s", unders)
LOG.warning("Change will make usage less than 0 for the "
"following resources: %s", unders)
return reservations
def _sync_acc_res(self, context, resource, project_id):

25
cyborg/db/sqlalchemy/models.py
View File

@ -27,6 +27,7 @@ from sqlalchemy import schema
from sqlalchemy import DateTime
from sqlalchemy import orm
from cyborg.common import constants
from cyborg.common import paths
from cyborg.conf import CONF
@ -103,6 +104,18 @@ class Deployable(Base):
num_accelerators = Column(Integer, nullable=False)
device_id = Column(Integer, ForeignKey('devices.id', ondelete="RESTRICT"),
nullable=False)
# The resource provider UUID is nullable for 2 reasons:
# A. on creation, till Placement is populated, this will be null.
# B. Sub-deployables (such as in networked FPGA cards) will have
# this as null.
rp_uuid = Column(String(36), nullable=True)
# This is nullable because the parent deployable in a networked
# FPGA card will have no driver. Only subdeployables have one.
driver_name = Column(String(100), nullable=True)
# The following fields are needed only for deployables with
# num_accelerators > 1
num_accelerators_in_use = Column(Integer, default=0)
# TODO Add programming_in_progress field
class Attribute(Base):
@ -168,7 +181,7 @@ class DeviceProfile(Base):
id = Column(Integer, primary_key=True)
uuid = Column(String(36), nullable=False)
name = Column(String(255), nullable=False)
name = Column(String(255), nullable=False, unique=True)
profile_json = Column(Text, nullable=False)
@ -181,7 +194,7 @@ class ExtArq(Base):
Index('extArqs_project_id_idx', 'project_id'),
Index('extArqs_device_profile_id_idx', 'device_profile_id'),
Index('extArqs_device_rp_uuid_idx', 'device_rp_uuid'),
Index('extArqs_device_instance_uuid_idx', 'device_instance_uuid'),
Index('extArqs_instance_uuid_idx', 'instance_uuid'),
Index('extArqs_attach_handle_id_idx', 'attach_handle_id'),
Index('extArqs_deployable_id_idx', 'deployable_id'),
table_args()
@ -190,14 +203,18 @@ class ExtArq(Base):
id = Column(Integer, primary_key=True)
uuid = Column(String(36), nullable=False, unique=True)
project_id = Column(String(255), nullable=True)
state = Column(Enum('Initial', 'Bound', 'BindFailed', name='state'),
state = Column(Enum(constants.ARQ_INITIAL,
constants.ARQ_BOUND,
constants.ARQ_BIND_FAILED,
constants.ARQ_UNBOUND),
nullable=False)
device_profile_id = Column(Integer, ForeignKey('device_profiles.id',
ondelete="RESTRICT"),
nullable=False)
device_profile_group_id = Column(Integer, nullable=False, default=0)
hostname = Column(String(255), nullable=True)
device_rp_uuid = Column(String(36), nullable=True)
device_instance_uuid = Column(String(36), nullable=True)
instance_uuid = Column(String(36), nullable=True)
attach_handle_id = Column(Integer, ForeignKey('attach_handles.id',
ondelete="RESTRICT"),
nullable=True)