3601 lines
148 KiB
Python
3601 lines
148 KiB
Python
# 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 collections
|
|
import copy
|
|
import itertools
|
|
import random
|
|
|
|
# NOTE(cdent): The resource provider objects are designed to never be
|
|
# used over RPC. Remote manipulation is done with the placement HTTP
|
|
# API. The 'remotable' decorators should not be used, the objects should
|
|
# not be registered and there is no need to express VERSIONs nor handle
|
|
# obj_make_compatible.
|
|
|
|
import os_traits
|
|
from oslo_concurrency import lockutils
|
|
from oslo_config import cfg
|
|
from oslo_db import api as oslo_db_api
|
|
from oslo_db import exception as db_exc
|
|
from oslo_log import log as logging
|
|
import six
|
|
import sqlalchemy as sa
|
|
from sqlalchemy import exc as sqla_exc
|
|
from sqlalchemy import func
|
|
from sqlalchemy import sql
|
|
from sqlalchemy.sql import null
|
|
|
|
from nova.db.sqlalchemy import api as db_api
|
|
from nova.db.sqlalchemy import api_models as models
|
|
from nova.db.sqlalchemy import resource_class_cache as rc_cache
|
|
from nova import exception
|
|
from nova.i18n import _
|
|
from nova.objects import base
|
|
from nova.objects import fields
|
|
|
|
_TRAIT_TBL = models.Trait.__table__
|
|
_ALLOC_TBL = models.Allocation.__table__
|
|
_INV_TBL = models.Inventory.__table__
|
|
_RP_TBL = models.ResourceProvider.__table__
|
|
# Not used in this file but used in tests.
|
|
_RC_TBL = models.ResourceClass.__table__
|
|
_AGG_TBL = models.PlacementAggregate.__table__
|
|
_RP_AGG_TBL = models.ResourceProviderAggregate.__table__
|
|
_RP_TRAIT_TBL = models.ResourceProviderTrait.__table__
|
|
_PROJECT_TBL = models.Project.__table__
|
|
_USER_TBL = models.User.__table__
|
|
_CONSUMER_TBL = models.Consumer.__table__
|
|
_RC_CACHE = None
|
|
_TRAIT_LOCK = 'trait_sync'
|
|
_TRAITS_SYNCED = False
|
|
|
|
CONF = cfg.CONF
|
|
LOG = logging.getLogger(__name__)
|
|
|
|
|
|
@db_api.api_context_manager.reader
|
|
def _ensure_rc_cache(ctx):
|
|
"""Ensures that a singleton resource class cache has been created in the
|
|
module's scope.
|
|
|
|
:param ctx: `nova.context.RequestContext` that may be used to grab a DB
|
|
connection.
|
|
"""
|
|
global _RC_CACHE
|
|
if _RC_CACHE is not None:
|
|
return
|
|
_RC_CACHE = rc_cache.ResourceClassCache(ctx)
|
|
|
|
|
|
@oslo_db_api.wrap_db_retry(max_retries=5, retry_on_deadlock=True)
|
|
@db_api.api_context_manager.writer
|
|
def _trait_sync(ctx):
|
|
"""Sync the os_traits symbols to the database.
|
|
|
|
Reads all symbols from the os_traits library, checks if any of them do
|
|
not exist in the database and bulk-inserts those that are not. This is
|
|
done once per process using this code if either Trait.get_by_name or
|
|
TraitList.get_all is called.
|
|
|
|
:param ctx: `nova.context.RequestContext` that may be used to grab a DB
|
|
connection.
|
|
"""
|
|
# Create a set of all traits in the os_traits library.
|
|
std_traits = set(os_traits.get_traits())
|
|
sel = sa.select([_TRAIT_TBL.c.name])
|
|
res = ctx.session.execute(sel).fetchall()
|
|
# Create a set of all traits in the db that are not custom
|
|
# traits.
|
|
db_traits = set(
|
|
r[0] for r in res
|
|
if not os_traits.is_custom(r[0])
|
|
)
|
|
# Determine those traits which are in os_traits but not
|
|
# currently in the database, and insert them.
|
|
need_sync = std_traits - db_traits
|
|
ins = _TRAIT_TBL.insert()
|
|
batch_args = [
|
|
{'name': six.text_type(trait)}
|
|
for trait in need_sync
|
|
]
|
|
if batch_args:
|
|
try:
|
|
ctx.session.execute(ins, batch_args)
|
|
LOG.info("Synced traits from os_traits into API DB: %s",
|
|
need_sync)
|
|
except db_exc.DBDuplicateEntry:
|
|
pass # some other process sync'd, just ignore
|
|
|
|
|
|
def _ensure_trait_sync(ctx):
|
|
"""Ensures that the os_traits library is synchronized to the traits db.
|
|
|
|
If _TRAITS_SYNCED is False then this process has not tried to update the
|
|
traits db. Do so by calling _trait_sync. Since the placement API server
|
|
could be multi-threaded, lock around testing _TRAITS_SYNCED to avoid
|
|
duplicating work.
|
|
|
|
Different placement API server processes that talk to the same database
|
|
will avoid issues through the power of transactions.
|
|
|
|
:param ctx: `nova.context.RequestContext` that may be used to grab a DB
|
|
connection.
|
|
"""
|
|
global _TRAITS_SYNCED
|
|
# If another thread is doing this work, wait for it to complete.
|
|
# When that thread is done _TRAITS_SYNCED will be true in this
|
|
# thread and we'll simply return.
|
|
with lockutils.lock(_TRAIT_LOCK):
|
|
if not _TRAITS_SYNCED:
|
|
_trait_sync(ctx)
|
|
_TRAITS_SYNCED = True
|
|
|
|
|
|
def _get_current_inventory_resources(ctx, rp):
|
|
"""Returns a set() containing the resource class IDs for all resources
|
|
currently having an inventory record for the supplied resource provider.
|
|
|
|
:param ctx: `nova.context.RequestContext` that may be used to grab a DB
|
|
connection.
|
|
:param rp: Resource provider to query inventory for.
|
|
"""
|
|
cur_res_sel = sa.select([_INV_TBL.c.resource_class_id]).where(
|
|
_INV_TBL.c.resource_provider_id == rp.id)
|
|
existing_resources = ctx.session.execute(cur_res_sel).fetchall()
|
|
return set([r[0] for r in existing_resources])
|
|
|
|
|
|
def _delete_inventory_from_provider(ctx, rp, to_delete):
|
|
"""Deletes any inventory records from the supplied provider and set() of
|
|
resource class identifiers.
|
|
|
|
If there are allocations for any of the inventories to be deleted raise
|
|
InventoryInUse exception.
|
|
|
|
:param ctx: `nova.context.RequestContext` that contains an oslo_db Session
|
|
:param rp: Resource provider from which to delete inventory.
|
|
:param to_delete: set() containing resource class IDs for records to
|
|
delete.
|
|
"""
|
|
allocation_query = sa.select(
|
|
[_ALLOC_TBL.c.resource_class_id.label('resource_class')]).where(
|
|
sa.and_(_ALLOC_TBL.c.resource_provider_id == rp.id,
|
|
_ALLOC_TBL.c.resource_class_id.in_(to_delete))
|
|
).group_by(_ALLOC_TBL.c.resource_class_id)
|
|
allocations = ctx.session.execute(allocation_query).fetchall()
|
|
if allocations:
|
|
resource_classes = ', '.join([_RC_CACHE.string_from_id(alloc[0])
|
|
for alloc in allocations])
|
|
raise exception.InventoryInUse(resource_classes=resource_classes,
|
|
resource_provider=rp.uuid)
|
|
|
|
del_stmt = _INV_TBL.delete().where(sa.and_(
|
|
_INV_TBL.c.resource_provider_id == rp.id,
|
|
_INV_TBL.c.resource_class_id.in_(to_delete)))
|
|
res = ctx.session.execute(del_stmt)
|
|
return res.rowcount
|
|
|
|
|
|
def _add_inventory_to_provider(ctx, rp, inv_list, to_add):
|
|
"""Inserts new inventory records for the supplied resource provider.
|
|
|
|
:param ctx: `nova.context.RequestContext` that contains an oslo_db Session
|
|
:param rp: Resource provider to add inventory to.
|
|
:param inv_list: InventoryList object
|
|
:param to_add: set() containing resource class IDs to search inv_list for
|
|
adding to resource provider.
|
|
"""
|
|
for rc_id in to_add:
|
|
rc_str = _RC_CACHE.string_from_id(rc_id)
|
|
inv_record = inv_list.find(rc_str)
|
|
if inv_record.capacity <= 0:
|
|
raise exception.InvalidInventoryCapacity(
|
|
resource_class=rc_str,
|
|
resource_provider=rp.uuid)
|
|
ins_stmt = _INV_TBL.insert().values(
|
|
resource_provider_id=rp.id,
|
|
resource_class_id=rc_id,
|
|
total=inv_record.total,
|
|
reserved=inv_record.reserved,
|
|
min_unit=inv_record.min_unit,
|
|
max_unit=inv_record.max_unit,
|
|
step_size=inv_record.step_size,
|
|
allocation_ratio=inv_record.allocation_ratio)
|
|
ctx.session.execute(ins_stmt)
|
|
|
|
|
|
def _update_inventory_for_provider(ctx, rp, inv_list, to_update):
|
|
"""Updates existing inventory records for the supplied resource provider.
|
|
|
|
:param ctx: `nova.context.RequestContext` that contains an oslo_db Session
|
|
:param rp: Resource provider on which to update inventory.
|
|
:param inv_list: InventoryList object
|
|
:param to_update: set() containing resource class IDs to search inv_list
|
|
for updating in resource provider.
|
|
:returns: A list of (uuid, class) tuples that have exceeded their
|
|
capacity after this inventory update.
|
|
"""
|
|
exceeded = []
|
|
for rc_id in to_update:
|
|
rc_str = _RC_CACHE.string_from_id(rc_id)
|
|
inv_record = inv_list.find(rc_str)
|
|
if inv_record.capacity <= 0:
|
|
raise exception.InvalidInventoryCapacity(
|
|
resource_class=rc_str,
|
|
resource_provider=rp.uuid)
|
|
allocation_query = sa.select(
|
|
[func.sum(_ALLOC_TBL.c.used).label('usage')]).\
|
|
where(sa.and_(
|
|
_ALLOC_TBL.c.resource_provider_id == rp.id,
|
|
_ALLOC_TBL.c.resource_class_id == rc_id))
|
|
allocations = ctx.session.execute(allocation_query).first()
|
|
if (allocations
|
|
and allocations['usage'] is not None
|
|
and allocations['usage'] > inv_record.capacity):
|
|
exceeded.append((rp.uuid, rc_str))
|
|
upd_stmt = _INV_TBL.update().where(sa.and_(
|
|
_INV_TBL.c.resource_provider_id == rp.id,
|
|
_INV_TBL.c.resource_class_id == rc_id)).values(
|
|
total=inv_record.total,
|
|
reserved=inv_record.reserved,
|
|
min_unit=inv_record.min_unit,
|
|
max_unit=inv_record.max_unit,
|
|
step_size=inv_record.step_size,
|
|
allocation_ratio=inv_record.allocation_ratio)
|
|
res = ctx.session.execute(upd_stmt)
|
|
if not res.rowcount:
|
|
raise exception.InventoryWithResourceClassNotFound(
|
|
resource_class=rc_str)
|
|
return exceeded
|
|
|
|
|
|
def _increment_provider_generation(ctx, rp):
|
|
"""Increments the supplied provider's generation value, supplying the
|
|
currently-known generation. Returns whether the increment succeeded.
|
|
|
|
:param ctx: `nova.context.RequestContext` that contains an oslo_db Session
|
|
:param rp: `ResourceProvider` whose generation should be updated.
|
|
:returns: The new resource provider generation value if successful.
|
|
:raises nova.exception.ConcurrentUpdateDetected: if another thread updated
|
|
the same resource provider's view of its inventory or allocations
|
|
in between the time when this object was originally read
|
|
and the call to set the inventory.
|
|
"""
|
|
rp_gen = rp.generation
|
|
new_generation = rp_gen + 1
|
|
upd_stmt = _RP_TBL.update().where(sa.and_(
|
|
_RP_TBL.c.id == rp.id,
|
|
_RP_TBL.c.generation == rp_gen)).values(
|
|
generation=(new_generation))
|
|
|
|
res = ctx.session.execute(upd_stmt)
|
|
if res.rowcount != 1:
|
|
raise exception.ConcurrentUpdateDetected
|
|
return new_generation
|
|
|
|
|
|
@db_api.api_context_manager.writer
|
|
def _add_inventory(context, rp, inventory):
|
|
"""Add one Inventory that wasn't already on the provider.
|
|
|
|
:raises `exception.ResourceClassNotFound` if inventory.resource_class
|
|
cannot be found in either the standard classes or the DB.
|
|
"""
|
|
_ensure_rc_cache(context)
|
|
rc_id = _RC_CACHE.id_from_string(inventory.resource_class)
|
|
inv_list = InventoryList(objects=[inventory])
|
|
_add_inventory_to_provider(
|
|
context, rp, inv_list, set([rc_id]))
|
|
rp.generation = _increment_provider_generation(context, rp)
|
|
|
|
|
|
@db_api.api_context_manager.writer
|
|
def _update_inventory(context, rp, inventory):
|
|
"""Update an inventory already on the provider.
|
|
|
|
:raises `exception.ResourceClassNotFound` if inventory.resource_class
|
|
cannot be found in either the standard classes or the DB.
|
|
"""
|
|
_ensure_rc_cache(context)
|
|
rc_id = _RC_CACHE.id_from_string(inventory.resource_class)
|
|
inv_list = InventoryList(objects=[inventory])
|
|
exceeded = _update_inventory_for_provider(
|
|
context, rp, inv_list, set([rc_id]))
|
|
rp.generation = _increment_provider_generation(context, rp)
|
|
return exceeded
|
|
|
|
|
|
@db_api.api_context_manager.writer
|
|
def _delete_inventory(context, rp, resource_class):
|
|
"""Delete up to one Inventory of the given resource_class string.
|
|
|
|
:raises `exception.ResourceClassNotFound` if resource_class
|
|
cannot be found in either the standard classes or the DB.
|
|
"""
|
|
_ensure_rc_cache(context)
|
|
rc_id = _RC_CACHE.id_from_string(resource_class)
|
|
if not _delete_inventory_from_provider(context, rp, [rc_id]):
|
|
raise exception.NotFound(
|
|
'No inventory of class %s found for delete'
|
|
% resource_class)
|
|
rp.generation = _increment_provider_generation(context, rp)
|
|
|
|
|
|
@db_api.api_context_manager.writer
|
|
def _set_inventory(context, rp, inv_list):
|
|
"""Given an InventoryList object, replaces the inventory of the
|
|
resource provider in a safe, atomic fashion using the resource
|
|
provider's generation as a consistent view marker.
|
|
|
|
:param context: Nova RequestContext.
|
|
:param rp: `ResourceProvider` object upon which to set inventory.
|
|
:param inv_list: `InventoryList` object to save to backend storage.
|
|
:returns: A list of (uuid, class) tuples that have exceeded their
|
|
capacity after this inventory update.
|
|
:raises nova.exception.ConcurrentUpdateDetected: if another thread updated
|
|
the same resource provider's view of its inventory or allocations
|
|
in between the time when this object was originally read
|
|
and the call to set the inventory.
|
|
:raises `exception.ResourceClassNotFound` if any resource class in any
|
|
inventory in inv_list cannot be found in either the standard
|
|
classes or the DB.
|
|
:raises `exception.InventoryInUse` if we attempt to delete inventory
|
|
from a provider that has allocations for that resource class.
|
|
"""
|
|
_ensure_rc_cache(context)
|
|
|
|
existing_resources = _get_current_inventory_resources(context, rp)
|
|
these_resources = set([_RC_CACHE.id_from_string(r.resource_class)
|
|
for r in inv_list.objects])
|
|
|
|
# Determine which resources we should be adding, deleting and/or
|
|
# updating in the resource provider's inventory by comparing sets
|
|
# of resource class identifiers.
|
|
to_add = these_resources - existing_resources
|
|
to_delete = existing_resources - these_resources
|
|
to_update = these_resources & existing_resources
|
|
exceeded = []
|
|
|
|
if to_delete:
|
|
_delete_inventory_from_provider(context, rp, to_delete)
|
|
if to_add:
|
|
_add_inventory_to_provider(context, rp, inv_list, to_add)
|
|
if to_update:
|
|
exceeded = _update_inventory_for_provider(context, rp, inv_list,
|
|
to_update)
|
|
|
|
# Here is where we update the resource provider's generation value. If
|
|
# this update updates zero rows, that means that another thread has updated
|
|
# the inventory for this resource provider between the time the caller
|
|
# originally read the resource provider record and inventory information
|
|
# and this point. We raise an exception here which will rollback the above
|
|
# transaction and return an error to the caller to indicate that they can
|
|
# attempt to retry the inventory save after reverifying any capacity
|
|
# conditions and re-reading the existing inventory information.
|
|
rp.generation = _increment_provider_generation(context, rp)
|
|
|
|
return exceeded
|
|
|
|
|
|
@db_api.api_context_manager.reader
|
|
def _get_provider_by_uuid(context, uuid):
|
|
"""Given a UUID, return a dict of information about the resource provider
|
|
from the database.
|
|
|
|
:raises: NotFound if no such provider was found
|
|
:param uuid: The UUID to look up
|
|
"""
|
|
rpt = sa.alias(_RP_TBL, name="rp")
|
|
parent = sa.alias(_RP_TBL, name="parent")
|
|
root = sa.alias(_RP_TBL, name="root")
|
|
# TODO(jaypipes): Change this to an inner join when we are sure all
|
|
# root_provider_id values are NOT NULL
|
|
rp_to_root = sa.outerjoin(rpt, root, rpt.c.root_provider_id == root.c.id)
|
|
rp_to_parent = sa.outerjoin(rp_to_root, parent,
|
|
rpt.c.parent_provider_id == parent.c.id)
|
|
cols = [
|
|
rpt.c.id,
|
|
rpt.c.uuid,
|
|
rpt.c.name,
|
|
rpt.c.generation,
|
|
root.c.uuid.label("root_provider_uuid"),
|
|
parent.c.uuid.label("parent_provider_uuid"),
|
|
rpt.c.updated_at,
|
|
rpt.c.created_at,
|
|
]
|
|
sel = sa.select(cols).select_from(rp_to_parent).where(rpt.c.uuid == uuid)
|
|
res = context.session.execute(sel).fetchone()
|
|
if not res:
|
|
raise exception.NotFound(
|
|
'No resource provider with uuid %s found' % uuid)
|
|
return dict(res)
|
|
|
|
|
|
@db_api.api_context_manager.reader
|
|
def _get_aggregates_by_provider_id(context, rp_id):
|
|
join_statement = sa.join(
|
|
_AGG_TBL, _RP_AGG_TBL, sa.and_(
|
|
_AGG_TBL.c.id == _RP_AGG_TBL.c.aggregate_id,
|
|
_RP_AGG_TBL.c.resource_provider_id == rp_id))
|
|
sel = sa.select([_AGG_TBL.c.uuid]).select_from(join_statement)
|
|
return [r[0] for r in context.session.execute(sel).fetchall()]
|
|
|
|
|
|
@db_api.api_context_manager.writer
|
|
def _set_aggregates(context, rp_id, provided_aggregates):
|
|
# When aggregate uuids are persisted no validation is done
|
|
# to ensure that they refer to something that has meaning
|
|
# elsewhere. It is assumed that code which makes use of the
|
|
# aggregates, later, will validate their fitness.
|
|
# TODO(cdent): At the moment we do not delete
|
|
# a PlacementAggregate that no longer has any associations
|
|
# with at least one resource provider. We may wish to do that
|
|
# to avoid bloat if it turns out we're creating a lot of noise.
|
|
# Not doing now to move things along.
|
|
provided_aggregates = set(provided_aggregates)
|
|
existing_aggregates = set(_get_aggregates_by_provider_id(context, rp_id))
|
|
to_add = provided_aggregates - existing_aggregates
|
|
target_aggregates = list(provided_aggregates)
|
|
|
|
# Create any aggregates that do not yet exist in
|
|
# PlacementAggregates. This is different from
|
|
# the set in existing_aggregates; those are aggregates for
|
|
# which there are associations for the resource provider
|
|
# at rp_id. The following loop checks for the existence of any
|
|
# aggregate with the provided uuid. In this way we only
|
|
# create a new row in the PlacementAggregate table if the
|
|
# aggregate uuid has never been seen before. Code further
|
|
# below will update the associations.
|
|
for agg_uuid in to_add:
|
|
found_agg = context.session.query(models.PlacementAggregate.uuid).\
|
|
filter_by(uuid=agg_uuid).first()
|
|
if not found_agg:
|
|
new_aggregate = models.PlacementAggregate(uuid=agg_uuid)
|
|
try:
|
|
context.session.add(new_aggregate)
|
|
# Flush each aggregate to explicitly call the INSERT
|
|
# statement that could result in an integrity error
|
|
# if some other thread has added this agg_uuid. This
|
|
# also makes sure that the new aggregates have
|
|
# ids when the SELECT below happens.
|
|
context.session.flush()
|
|
except db_exc.DBDuplicateEntry:
|
|
# Something else has already added this agg_uuid
|
|
pass
|
|
|
|
# Remove all aggregate associations so we can refresh them
|
|
# below. This means that all associations are added, but the
|
|
# aggregates themselves stay around.
|
|
context.session.query(models.ResourceProviderAggregate).filter_by(
|
|
resource_provider_id=rp_id).delete()
|
|
|
|
# Set resource_provider_id, aggregate_id pairs to
|
|
# ResourceProviderAggregate table.
|
|
if target_aggregates:
|
|
select_agg_id = sa.select([rp_id, models.PlacementAggregate.id]).\
|
|
where(models.PlacementAggregate.uuid.in_(target_aggregates))
|
|
insert_aggregates = models.ResourceProviderAggregate.__table__.\
|
|
insert().from_select(['resource_provider_id', 'aggregate_id'],
|
|
select_agg_id)
|
|
context.session.execute(insert_aggregates)
|
|
|
|
|
|
@db_api.api_context_manager.reader
|
|
def _get_traits_by_provider_id(context, rp_id):
|
|
t = sa.alias(_TRAIT_TBL, name='t')
|
|
rpt = sa.alias(_RP_TRAIT_TBL, name='rpt')
|
|
|
|
join_cond = sa.and_(t.c.id == rpt.c.trait_id,
|
|
rpt.c.resource_provider_id == rp_id)
|
|
join = sa.join(t, rpt, join_cond)
|
|
sel = sa.select([t.c.id, t.c.name,
|
|
t.c.created_at, t.c.updated_at]).select_from(join)
|
|
return [dict(r) for r in context.session.execute(sel).fetchall()]
|
|
|
|
|
|
def _add_traits_to_provider(ctx, rp_id, to_add):
|
|
"""Adds trait associations to the provider with the supplied ID.
|
|
|
|
:param ctx: `nova.context.RequestContext` that has an oslo_db Session
|
|
:param rp_id: Internal ID of the resource provider on which to add
|
|
trait associations
|
|
:param to_add: set() containing internal trait IDs for traits to add
|
|
"""
|
|
for trait_id in to_add:
|
|
try:
|
|
ins_stmt = _RP_TRAIT_TBL.insert().values(
|
|
resource_provider_id=rp_id,
|
|
trait_id=trait_id)
|
|
ctx.session.execute(ins_stmt)
|
|
except db_exc.DBDuplicateEntry:
|
|
# Another thread already set this trait for this provider. Ignore
|
|
# this for now (but ConcurrentUpdateDetected will end up being
|
|
# raised almost assuredly when we go to increment the resource
|
|
# provider's generation later, but that's also fine)
|
|
pass
|
|
|
|
|
|
def _delete_traits_from_provider(ctx, rp_id, to_delete):
|
|
"""Deletes trait associations from the provider with the supplied ID and
|
|
set() of internal trait IDs.
|
|
|
|
:param ctx: `nova.context.RequestContext` that has an oslo_db Session
|
|
:param rp_id: Internal ID of the resource provider from which to delete
|
|
trait associations
|
|
:param to_delete: set() containing internal trait IDs for traits to
|
|
delete
|
|
"""
|
|
del_stmt = _RP_TRAIT_TBL.delete().where(
|
|
sa.and_(
|
|
_RP_TRAIT_TBL.c.resource_provider_id == rp_id,
|
|
_RP_TRAIT_TBL.c.trait_id.in_(to_delete)))
|
|
ctx.session.execute(del_stmt)
|
|
|
|
|
|
@db_api.api_context_manager.writer
|
|
def _set_traits(context, rp, traits):
|
|
"""Given a ResourceProvider object and a TraitList object, replaces the set
|
|
of traits associated with the resource provider.
|
|
|
|
:raises: ConcurrentUpdateDetected if the resource provider's traits or
|
|
inventory was changed in between the time when we first started to
|
|
set traits and the end of this routine.
|
|
|
|
:param rp: The ResourceProvider object to set traits against
|
|
:param traits: A TraitList object or list of Trait objects
|
|
"""
|
|
# Get the internal IDs of our existing traits
|
|
existing_traits = _get_traits_by_provider_id(context, rp.id)
|
|
existing_traits = set(rec['id'] for rec in existing_traits)
|
|
want_traits = set(trait.id for trait in traits)
|
|
|
|
to_add = want_traits - existing_traits
|
|
to_delete = existing_traits - want_traits
|
|
|
|
if not to_add and not to_delete:
|
|
return
|
|
|
|
if to_delete:
|
|
_delete_traits_from_provider(context, rp.id, to_delete)
|
|
if to_add:
|
|
_add_traits_to_provider(context, rp.id, to_add)
|
|
rp.generation = _increment_provider_generation(context, rp)
|
|
|
|
|
|
@db_api.api_context_manager.reader
|
|
def _has_child_providers(context, rp_id):
|
|
"""Returns True if the supplied resource provider has any child providers,
|
|
False otherwise
|
|
"""
|
|
child_sel = sa.select([_RP_TBL.c.id])
|
|
child_sel = child_sel.where(_RP_TBL.c.parent_provider_id == rp_id)
|
|
child_res = context.session.execute(child_sel.limit(1)).fetchone()
|
|
if child_res:
|
|
return True
|
|
return False
|
|
|
|
|
|
@db_api.api_context_manager.writer
|
|
def _set_root_provider_id(context, rp_id, root_id):
|
|
"""Simply sets the root_provider_id value for a provider identified by
|
|
rp_id. Used in online data migration.
|
|
|
|
:param rp_id: Internal ID of the provider to update
|
|
:param root_id: Value to set root provider to
|
|
"""
|
|
upd = _RP_TBL.update().where(_RP_TBL.c.id == rp_id)
|
|
upd = upd.values(root_provider_id=root_id)
|
|
context.session.execute(upd)
|
|
|
|
|
|
ProviderIds = collections.namedtuple(
|
|
'ProviderIds', 'id uuid parent_id parent_uuid root_id root_uuid')
|
|
|
|
|
|
def _provider_ids_from_uuid(context, uuid):
|
|
"""Given the UUID of a resource provider, returns a namedtuple
|
|
(ProviderIds) with the internal ID, the UUID, the parent provider's
|
|
internal ID, parent provider's UUID, the root provider's internal ID and
|
|
the root provider UUID.
|
|
|
|
:returns: ProviderIds object containing the internal IDs and UUIDs of the
|
|
provider identified by the supplied UUID
|
|
:param uuid: The UUID of the provider to look up
|
|
"""
|
|
# SELECT
|
|
# rp.id, rp.uuid,
|
|
# parent.id AS parent_id, parent.uuid AS parent_uuid,
|
|
# root.id AS root_id, root.uuid AS root_uuid
|
|
# FROM resource_providers AS rp
|
|
# LEFT JOIN resource_providers AS parent
|
|
# ON rp.parent_provider_id = parent.id
|
|
# LEFT JOIN resource_providers AS root
|
|
# ON rp.root_provider_id = root.id
|
|
me = sa.alias(_RP_TBL, name="me")
|
|
parent = sa.alias(_RP_TBL, name="parent")
|
|
root = sa.alias(_RP_TBL, name="root")
|
|
cols = [
|
|
me.c.id,
|
|
me.c.uuid,
|
|
parent.c.id.label('parent_id'),
|
|
parent.c.uuid.label('parent_uuid'),
|
|
root.c.id.label('root_id'),
|
|
root.c.uuid.label('root_uuid'),
|
|
]
|
|
# TODO(jaypipes): Change this to an inner join when we are sure all
|
|
# root_provider_id values are NOT NULL
|
|
me_to_root = sa.outerjoin(me, root, me.c.root_provider_id == root.c.id)
|
|
me_to_parent = sa.outerjoin(me_to_root, parent,
|
|
me.c.parent_provider_id == parent.c.id)
|
|
sel = sa.select(cols).select_from(me_to_parent)
|
|
sel = sel.where(me.c.uuid == uuid)
|
|
res = context.session.execute(sel).fetchone()
|
|
if not res:
|
|
return None
|
|
return ProviderIds(**dict(res))
|
|
|
|
|
|
@db_api.api_context_manager.writer
|
|
def _delete_rp_record(context, _id):
|
|
return context.session.query(models.ResourceProvider).\
|
|
filter(models.ResourceProvider.id == _id).\
|
|
delete(synchronize_session=False)
|
|
|
|
|
|
@base.NovaObjectRegistry.register_if(False)
|
|
class ResourceProvider(base.NovaObject, base.NovaTimestampObject):
|
|
SETTABLE_FIELDS = ('name', 'parent_provider_uuid')
|
|
|
|
fields = {
|
|
'id': fields.IntegerField(read_only=True),
|
|
'uuid': fields.UUIDField(nullable=False),
|
|
'name': fields.StringField(nullable=False),
|
|
'generation': fields.IntegerField(nullable=False),
|
|
# UUID of the root provider in a hierarchy of providers. Will be equal
|
|
# to the uuid field if this provider is the root provider of a
|
|
# hierarchy. This field is never manually set by the user. Instead, it
|
|
# is automatically set to either the root provider UUID of the parent
|
|
# or the UUID of the provider itself if there is no parent. This field
|
|
# is an optimization field that allows us to very quickly query for all
|
|
# providers within a particular tree without doing any recursive
|
|
# querying.
|
|
'root_provider_uuid': fields.UUIDField(nullable=False),
|
|
# UUID of the direct parent provider, or None if this provider is a
|
|
# "root" provider.
|
|
'parent_provider_uuid': fields.UUIDField(nullable=True, default=None),
|
|
}
|
|
|
|
def create(self):
|
|
if 'id' in self:
|
|
raise exception.ObjectActionError(action='create',
|
|
reason='already created')
|
|
if 'uuid' not in self:
|
|
raise exception.ObjectActionError(action='create',
|
|
reason='uuid is required')
|
|
if 'name' not in self:
|
|
raise exception.ObjectActionError(action='create',
|
|
reason='name is required')
|
|
if 'root_provider_uuid' in self:
|
|
raise exception.ObjectActionError(
|
|
action='create',
|
|
reason=_('root provider UUID cannot be manually set.'))
|
|
|
|
self.obj_set_defaults()
|
|
updates = self.obj_get_changes()
|
|
self._create_in_db(self._context, updates)
|
|
self.obj_reset_changes()
|
|
|
|
def destroy(self):
|
|
self._delete(self._context, self.id)
|
|
|
|
def save(self):
|
|
updates = self.obj_get_changes()
|
|
if updates and any(k not in self.SETTABLE_FIELDS
|
|
for k in updates.keys()):
|
|
raise exception.ObjectActionError(
|
|
action='save',
|
|
reason='Immutable fields changed')
|
|
self._update_in_db(self._context, self.id, updates)
|
|
self.obj_reset_changes()
|
|
|
|
@classmethod
|
|
def get_by_uuid(cls, context, uuid):
|
|
"""Returns a new ResourceProvider object with the supplied UUID.
|
|
|
|
:raises NotFound if no such provider could be found
|
|
:param uuid: UUID of the provider to search for
|
|
"""
|
|
rp_rec = _get_provider_by_uuid(context, uuid)
|
|
return cls._from_db_object(context, cls(), rp_rec)
|
|
|
|
def add_inventory(self, inventory):
|
|
"""Add one new Inventory to the resource provider.
|
|
|
|
Fails if Inventory of the provided resource class is
|
|
already present.
|
|
"""
|
|
_add_inventory(self._context, self, inventory)
|
|
self.obj_reset_changes()
|
|
|
|
def delete_inventory(self, resource_class):
|
|
"""Delete Inventory of provided resource_class."""
|
|
_delete_inventory(self._context, self, resource_class)
|
|
self.obj_reset_changes()
|
|
|
|
def set_inventory(self, inv_list):
|
|
"""Set all resource provider Inventory to be the provided list."""
|
|
exceeded = _set_inventory(self._context, self, inv_list)
|
|
for uuid, rclass in exceeded:
|
|
LOG.warning('Resource provider %(uuid)s is now over-'
|
|
'capacity for %(resource)s',
|
|
{'uuid': uuid, 'resource': rclass})
|
|
self.obj_reset_changes()
|
|
|
|
def update_inventory(self, inventory):
|
|
"""Update one existing Inventory of the same resource class.
|
|
|
|
Fails if no Inventory of the same class is present.
|
|
"""
|
|
exceeded = _update_inventory(self._context, self, inventory)
|
|
for uuid, rclass in exceeded:
|
|
LOG.warning('Resource provider %(uuid)s is now over-'
|
|
'capacity for %(resource)s',
|
|
{'uuid': uuid, 'resource': rclass})
|
|
self.obj_reset_changes()
|
|
|
|
def get_aggregates(self):
|
|
"""Get the aggregate uuids associated with this resource provider."""
|
|
return _get_aggregates_by_provider_id(self._context, self.id)
|
|
|
|
def set_aggregates(self, aggregate_uuids):
|
|
"""Set the aggregate uuids associated with this resource provider.
|
|
|
|
If an aggregate does not exist, one will be created using the
|
|
provided uuid.
|
|
"""
|
|
_set_aggregates(self._context, self.id, aggregate_uuids)
|
|
|
|
def set_traits(self, traits):
|
|
"""Replaces the set of traits associated with the resource provider
|
|
with the given list of Trait objects.
|
|
|
|
:param traits: A list of Trait objects representing the traits to
|
|
associate with the provider.
|
|
"""
|
|
_set_traits(self._context, self, traits)
|
|
self.obj_reset_changes()
|
|
|
|
@db_api.api_context_manager.writer
|
|
def _create_in_db(self, context, updates):
|
|
parent_id = None
|
|
root_id = None
|
|
# User supplied a parent, let's make sure it exists
|
|
parent_uuid = updates.pop('parent_provider_uuid')
|
|
if parent_uuid is not None:
|
|
# Setting parent to ourselves doesn't make any sense
|
|
if parent_uuid == self.uuid:
|
|
raise exception.ObjectActionError(
|
|
action='create',
|
|
reason=_('parent provider UUID cannot be same as '
|
|
'UUID. Please set parent provider UUID to '
|
|
'None if there is no parent.'))
|
|
|
|
parent_ids = _provider_ids_from_uuid(context, parent_uuid)
|
|
if parent_ids is None:
|
|
raise exception.ObjectActionError(
|
|
action='create',
|
|
reason=_('parent provider UUID does not exist.'))
|
|
|
|
parent_id = parent_ids.id
|
|
root_id = parent_ids.root_id
|
|
updates['root_provider_id'] = root_id
|
|
updates['parent_provider_id'] = parent_id
|
|
self.root_provider_uuid = parent_ids.root_uuid
|
|
|
|
db_rp = models.ResourceProvider()
|
|
db_rp.update(updates)
|
|
context.session.add(db_rp)
|
|
context.session.flush()
|
|
|
|
self.id = db_rp.id
|
|
self.generation = db_rp.generation
|
|
|
|
if root_id is None:
|
|
# User did not specify a parent when creating this provider, so the
|
|
# root_provider_id needs to be set to this provider's newly-created
|
|
# internal ID
|
|
db_rp.root_provider_id = db_rp.id
|
|
context.session.add(db_rp)
|
|
context.session.flush()
|
|
self.root_provider_uuid = self.uuid
|
|
|
|
@staticmethod
|
|
@db_api.api_context_manager.writer
|
|
def _delete(context, _id):
|
|
# Do a quick check to see if the provider is a parent. If it is, don't
|
|
# allow deleting the provider. Note that the foreign key constraint on
|
|
# resource_providers.parent_provider_id will prevent deletion of the
|
|
# parent within the transaction below. This is just a quick
|
|
# short-circuit outside of the transaction boundary.
|
|
if _has_child_providers(context, _id):
|
|
raise exception.CannotDeleteParentResourceProvider()
|
|
|
|
# Don't delete the resource provider if it has allocations.
|
|
rp_allocations = context.session.query(models.Allocation).\
|
|
filter(models.Allocation.resource_provider_id == _id).\
|
|
count()
|
|
if rp_allocations:
|
|
raise exception.ResourceProviderInUse()
|
|
# Delete any inventory associated with the resource provider
|
|
context.session.query(models.Inventory).\
|
|
filter(models.Inventory.resource_provider_id == _id).\
|
|
delete(synchronize_session=False)
|
|
# Delete any aggregate associations for the resource provider
|
|
# The name substitution on the next line is needed to satisfy pep8
|
|
RPA_model = models.ResourceProviderAggregate
|
|
context.session.query(RPA_model).\
|
|
filter(RPA_model.resource_provider_id == _id).delete()
|
|
# delete any trait associations for the resource provider
|
|
RPT_model = models.ResourceProviderTrait
|
|
context.session.query(RPT_model).\
|
|
filter(RPT_model.resource_provider_id == _id).delete()
|
|
# set root_provider_id to null to make deletion possible
|
|
context.session.query(models.ResourceProvider).\
|
|
filter(models.ResourceProvider.id == _id,
|
|
models.ResourceProvider.root_provider_id == _id).\
|
|
update({'root_provider_id': None})
|
|
# Now delete the RP record
|
|
try:
|
|
result = _delete_rp_record(context, _id)
|
|
except sqla_exc.IntegrityError:
|
|
# NOTE(jaypipes): Another thread snuck in and parented this
|
|
# resource provider in between the above check for
|
|
# _has_child_providers() and our attempt to delete the record
|
|
raise exception.CannotDeleteParentResourceProvider()
|
|
if not result:
|
|
raise exception.NotFound()
|
|
|
|
@db_api.api_context_manager.writer
|
|
def _update_in_db(self, context, id, updates):
|
|
if 'parent_provider_uuid' in updates:
|
|
# TODO(jaypipes): For now, "re-parenting" and "un-parenting" are
|
|
# not possible. If the provider already had a parent, we don't
|
|
# allow changing that parent due to various issues, including:
|
|
#
|
|
# * if the new parent is a descendant of this resource provider, we
|
|
# introduce the possibility of a loop in the graph, which would
|
|
# be very bad
|
|
# * potentially orphaning heretofore-descendants
|
|
#
|
|
# So, for now, let's just prevent re-parenting...
|
|
my_ids = _provider_ids_from_uuid(context, self.uuid)
|
|
parent_uuid = updates.pop('parent_provider_uuid')
|
|
if parent_uuid is not None:
|
|
parent_ids = _provider_ids_from_uuid(context, parent_uuid)
|
|
# User supplied a parent, let's make sure it exists
|
|
if parent_ids is None:
|
|
raise exception.ObjectActionError(
|
|
action='create',
|
|
reason=_('parent provider UUID does not exist.'))
|
|
if (my_ids.parent_id is not None and
|
|
my_ids.parent_id != parent_ids.id):
|
|
raise exception.ObjectActionError(
|
|
action='update',
|
|
reason=_('re-parenting a provider is not '
|
|
'currently allowed.'))
|
|
|
|
updates['root_provider_id'] = parent_ids.root_id
|
|
updates['parent_provider_id'] = parent_ids.id
|
|
self.root_provider_uuid = parent_ids.root_uuid
|
|
else:
|
|
if my_ids.parent_id is not None:
|
|
raise exception.ObjectActionError(
|
|
action='update',
|
|
reason=_('un-parenting a provider is not '
|
|
'currently allowed.'))
|
|
|
|
db_rp = context.session.query(models.ResourceProvider).filter_by(
|
|
id=id).first()
|
|
db_rp.update(updates)
|
|
try:
|
|
db_rp.save(context.session)
|
|
except sqla_exc.IntegrityError:
|
|
# NOTE(jaypipes): Another thread snuck in and deleted the parent
|
|
# for this resource provider in between the above check for a valid
|
|
# parent provider and here...
|
|
raise exception.ObjectActionError(
|
|
action='update',
|
|
reason=_('parent provider UUID does not exist.'))
|
|
|
|
@staticmethod
|
|
@db_api.api_context_manager.writer # Needed for online data migration
|
|
def _from_db_object(context, resource_provider, db_resource_provider):
|
|
# Online data migration to populate root_provider_id
|
|
# TODO(jaypipes): Remove when all root_provider_id values are NOT NULL
|
|
if db_resource_provider['root_provider_uuid'] is None:
|
|
rp_id = db_resource_provider['id']
|
|
uuid = db_resource_provider['uuid']
|
|
db_resource_provider['root_provider_uuid'] = uuid
|
|
_set_root_provider_id(context, rp_id, rp_id)
|
|
for field in resource_provider.fields:
|
|
setattr(resource_provider, field, db_resource_provider[field])
|
|
resource_provider._context = context
|
|
resource_provider.obj_reset_changes()
|
|
return resource_provider
|
|
|
|
|
|
@db_api.api_context_manager.reader
|
|
def _get_providers_with_shared_capacity(ctx, rc_id, amount):
|
|
"""Returns a list of resource provider IDs (internal IDs, not UUIDs)
|
|
that have capacity for a requested amount of a resource and indicate that
|
|
they share resource via an aggregate association.
|
|
|
|
Shared resource providers are marked with a standard trait called
|
|
MISC_SHARES_VIA_AGGREGATE. This indicates that the provider allows its
|
|
inventory to be consumed by other resource providers associated via an
|
|
aggregate link.
|
|
|
|
For example, assume we have two compute nodes, CN_1 and CN_2, each with
|
|
inventory of VCPU and MEMORY_MB but not DISK_GB (in other words, these are
|
|
compute nodes with no local disk). There is a resource provider called
|
|
"NFS_SHARE" that has an inventory of DISK_GB and has the
|
|
MISC_SHARES_VIA_AGGREGATE trait. Both the "CN_1" and "CN_2" compute node
|
|
resource providers and the "NFS_SHARE" resource provider are associated
|
|
with an aggregate called "AGG_1".
|
|
|
|
The scheduler needs to determine the resource providers that can fulfill a
|
|
request for 2 VCPU, 1024 MEMORY_MB and 100 DISK_GB.
|
|
|
|
Clearly, no single provider can satisfy the request for all three
|
|
resources, since neither compute node has DISK_GB inventory and the
|
|
NFS_SHARE provider has no VCPU or MEMORY_MB inventories.
|
|
|
|
However, if we consider the NFS_SHARE resource provider as providing
|
|
inventory of DISK_GB for both CN_1 and CN_2, we can include CN_1 and CN_2
|
|
as potential fits for the requested set of resources.
|
|
|
|
To facilitate that matching query, this function returns all providers that
|
|
indicate they share their inventory with providers in some aggregate and
|
|
have enough capacity for the requested amount of a resource.
|
|
|
|
To follow the example above, if we were to call
|
|
_get_providers_with_shared_capacity(ctx, "DISK_GB", 100), we would want to
|
|
get back the ID for the NFS_SHARE resource provider.
|
|
"""
|
|
# The SQL we need to generate here looks like this:
|
|
#
|
|
# SELECT rp.id
|
|
# FROM resource_providers AS rp
|
|
# INNER JOIN resource_provider_traits AS rpt
|
|
# ON rp.id = rpt.resource_provider_id
|
|
# INNER JOIN traits AS t
|
|
# AND rpt.trait_id = t.id
|
|
# AND t.name = "MISC_SHARES_VIA_AGGREGATE"
|
|
# INNER JOIN inventories AS inv
|
|
# ON rp.id = inv.resource_provider_id
|
|
# AND inv.resource_class_id = $rc_id
|
|
# LEFT JOIN (
|
|
# SELECT resource_provider_id, SUM(used) as used
|
|
# FROM allocations
|
|
# WHERE resource_class_id = $rc_id
|
|
# GROUP BY resource_provider_id
|
|
# ) AS usage
|
|
# ON rp.id = usage.resource_provider_id
|
|
# WHERE COALESCE(usage.used, 0) + $amount <= (
|
|
# inv.total + inv.reserved) * inv.allocation_ratio
|
|
# ) AND
|
|
# inv.min_unit <= $amount AND
|
|
# inv.max_unit >= $amount AND
|
|
# $amount % inv.step_size = 0
|
|
# GROUP BY rp.id
|
|
|
|
rp_tbl = sa.alias(_RP_TBL, name='rp')
|
|
inv_tbl = sa.alias(_INV_TBL, name='inv')
|
|
t_tbl = sa.alias(_TRAIT_TBL, name='t')
|
|
rpt_tbl = sa.alias(_RP_TRAIT_TBL, name='rpt')
|
|
|
|
rp_to_rpt_join = sa.join(
|
|
rp_tbl, rpt_tbl,
|
|
rp_tbl.c.id == rpt_tbl.c.resource_provider_id,
|
|
)
|
|
|
|
rpt_to_t_join = sa.join(
|
|
rp_to_rpt_join, t_tbl,
|
|
sa.and_(
|
|
rpt_tbl.c.trait_id == t_tbl.c.id,
|
|
# The traits table wants unicode trait names, but os_traits
|
|
# presents native str, so we need to cast.
|
|
t_tbl.c.name == six.text_type(os_traits.MISC_SHARES_VIA_AGGREGATE),
|
|
),
|
|
)
|
|
|
|
rp_to_inv_join = sa.join(
|
|
rpt_to_t_join, inv_tbl,
|
|
sa.and_(
|
|
rpt_tbl.c.resource_provider_id == inv_tbl.c.resource_provider_id,
|
|
inv_tbl.c.resource_class_id == rc_id,
|
|
),
|
|
)
|
|
|
|
usage = sa.select([_ALLOC_TBL.c.resource_provider_id,
|
|
sql.func.sum(_ALLOC_TBL.c.used).label('used')])
|
|
usage = usage.where(_ALLOC_TBL.c.resource_class_id == rc_id)
|
|
usage = usage.group_by(_ALLOC_TBL.c.resource_provider_id)
|
|
usage = sa.alias(usage, name='usage')
|
|
|
|
inv_to_usage_join = sa.outerjoin(
|
|
rp_to_inv_join, usage,
|
|
inv_tbl.c.resource_provider_id == usage.c.resource_provider_id,
|
|
)
|
|
|
|
sel = sa.select([rp_tbl.c.id]).select_from(inv_to_usage_join)
|
|
sel = sel.where(
|
|
sa.and_(
|
|
func.coalesce(usage.c.used, 0) + amount <= (
|
|
inv_tbl.c.total - inv_tbl.c.reserved
|
|
) * inv_tbl.c.allocation_ratio,
|
|
inv_tbl.c.min_unit <= amount,
|
|
inv_tbl.c.max_unit >= amount,
|
|
amount % inv_tbl.c.step_size == 0,
|
|
),
|
|
)
|
|
sel = sel.group_by(rp_tbl.c.id)
|
|
return [r[0] for r in ctx.session.execute(sel)]
|
|
|
|
|
|
@db_api.api_context_manager.reader
|
|
def _get_all_with_shared(ctx, resources):
|
|
"""Uses some more advanced SQL to find providers that either have the
|
|
requested resources "locally" or are associated with a provider that shares
|
|
those requested resources.
|
|
|
|
:param resources: Dict keyed by resource class integer ID of requested
|
|
amounts of that resource
|
|
"""
|
|
# NOTE(jaypipes): The SQL we generate here depends on which resource
|
|
# classes have providers that share that resource via an aggregate.
|
|
#
|
|
# We begin building a "join chain" by starting with a projection from the
|
|
# resource_providers table:
|
|
#
|
|
# SELECT rp.id
|
|
# FROM resource_providers AS rp
|
|
#
|
|
# in addition to a copy of resource_provider_aggregates for each resource
|
|
# class that has a shared provider:
|
|
#
|
|
# resource_provider_aggregates AS sharing_{RC_NAME},
|
|
#
|
|
# We then join to a copy of the inventories table for each resource we are
|
|
# requesting:
|
|
#
|
|
# {JOIN TYPE} JOIN inventories AS inv_{RC_NAME}
|
|
# ON {JOINING TABLE}.id = inv_{RC_NAME}.resource_provider_id
|
|
# AND inv_{RC_NAME}.resource_class_id = $RC_ID
|
|
# LEFT JOIN (
|
|
# SELECT resource_provider_id, SUM(used) AS used
|
|
# FROM allocations
|
|
# WHERE resource_class_id = $VCPU_ID
|
|
# GROUP BY resource_provider_id
|
|
# ) AS usage_{RC_NAME}
|
|
# ON inv_{RC_NAME}.resource_provider_id = \
|
|
# usage_{RC_NAME}.resource_provider_id
|
|
#
|
|
# For resource classes that DO NOT have any shared resource providers, the
|
|
# {JOIN TYPE} will be an INNER join, because we are filtering out any
|
|
# resource providers that do not have local inventory of that resource
|
|
# class.
|
|
#
|
|
# For resource classes that DO have shared resource providers, the {JOIN
|
|
# TYPE} will be a LEFT (OUTER) join.
|
|
#
|
|
# For the first join, {JOINING TABLE} will be resource_providers. For each
|
|
# subsequent resource class that is added to the SQL expression, {JOINING
|
|
# TABLE} will be the alias of the inventories table that refers to the
|
|
# previously-processed resource class.
|
|
#
|
|
# For resource classes that DO have shared providers, we also perform a
|
|
# "butterfly join" against two copies of the resource_provider_aggregates
|
|
# table:
|
|
#
|
|
# +-----------+ +------------+ +-------------+ +------------+
|
|
# | last_inv | | rpa_shared | | rpa_sharing | | rp_sharing |
|
|
# +-----------| +------------+ +-------------+ +------------+
|
|
# | rp_id |=>| rp_id | | rp_id |<=| id |
|
|
# | | | agg_id |<=| agg_id | | |
|
|
# +-----------+ +------------+ +-------------+ +------------+
|
|
#
|
|
# Note in the diagram above, we call the _get_providers_sharing_capacity()
|
|
# for a resource class to construct the "rp_sharing" set/table.
|
|
#
|
|
# The first part of the butterfly join is an outer join against a copy of
|
|
# the resource_provider_aggregates table in order to winnow results to
|
|
# providers that are associated with any aggregate that the sharing
|
|
# provider is associated with:
|
|
#
|
|
# LEFT JOIN resource_provider_aggregates AS shared_{RC_NAME}
|
|
# ON {JOINING_TABLE}.id = shared_{RC_NAME}.resource_provider_id
|
|
#
|
|
# The above is then joined to the set of aggregates associated with the set
|
|
# of sharing providers for that resource:
|
|
#
|
|
# LEFT JOIN resource_provider_aggregates AS sharing_{RC_NAME}
|
|
# ON shared_{RC_NAME}.aggregate_id = sharing_{RC_NAME}.aggregate_id
|
|
#
|
|
# We calculate the WHERE conditions based on whether the resource class has
|
|
# any shared providers.
|
|
#
|
|
# For resource classes that DO NOT have any shared resource providers, the
|
|
# WHERE clause constructed finds resource providers that have inventory for
|
|
# "local" resource providers:
|
|
#
|
|
# WHERE (COALESCE(usage_vcpu.used, 0) + $AMOUNT <=
|
|
# (inv_{RC_NAME}.total + inv_{RC_NAME}.reserved)
|
|
# * inv_{RC_NAME}.allocation_ratio
|
|
# AND
|
|
# inv_{RC_NAME}.min_unit <= $AMOUNT AND
|
|
# inv_{RC_NAME}.max_unit >= $AMOUNT AND
|
|
# $AMOUNT_VCPU % inv_{RC_NAME}.step_size == 0)
|
|
#
|
|
# For resource classes that DO have shared resource providers, the WHERE
|
|
# clause is slightly more complicated:
|
|
#
|
|
# WHERE (
|
|
# inv_{RC_NAME}.resource_provider_id IS NOT NULL AND
|
|
# (
|
|
# (
|
|
# COALESCE(usage_{RC_NAME}.used, 0) + $AMOUNT_VCPU <=
|
|
# (inv_{RC_NAME}.total + inv_{RC_NAME}.reserved)
|
|
# * inv_{RC_NAME}.allocation_ratio
|
|
# ) AND
|
|
# inv_{RC_NAME}.min_unit <= $AMOUNT_VCPU AND
|
|
# inv_{RC_NAME}.max_unit >= $AMOUNT_VCPU AND
|
|
# $AMOUNT_VCPU % inv_{RC_NAME}.step_size == 0
|
|
# ) OR
|
|
# sharing_{RC_NAME}.resource_provider_id IS NOT NULL
|
|
# )
|
|
#
|
|
# Finally, we GROUP BY the resource provider ID:
|
|
#
|
|
# GROUP BY rp.id
|
|
#
|
|
# To show an example, here is the exact SQL that will be generated in an
|
|
# environment that has a shared storage pool and compute nodes that have
|
|
# vCPU and RAM associated with the same aggregate as the provider
|
|
# representing the shared storage pool:
|
|
#
|
|
# SELECT rp.*
|
|
# FROM resource_providers AS rp
|
|
# INNER JOIN inventories AS inv_vcpu
|
|
# ON rp.id = inv_vcpu.resource_provider_id
|
|
# AND inv_vcpu.resource_class_id = $VCPU_ID
|
|
# LEFT JOIN (
|
|
# SELECT resource_provider_id, SUM(used) AS used
|
|
# FROM allocations
|
|
# WHERE resource_class_id = $VCPU_ID
|
|
# GROUP BY resource_provider_id
|
|
# ) AS usage_vcpu
|
|
# ON inv_vcpu.resource_provider_id = \
|
|
# usage_vcpu.resource_provider_id
|
|
# INNER JOIN inventories AS inv_memory_mb
|
|
# ON inv_vcpu.resource_provider_id = inv_memory_mb.resource_provider_id
|
|
# AND inv_memory_mb.resource_class_id = $MEMORY_MB_ID
|
|
# LEFT JOIN (
|
|
# SELECT resource_provider_id, SUM(used) AS used
|
|
# FROM allocations
|
|
# WHERE resource_class_id = $MEMORY_MB_ID
|
|
# GROUP BY resource_provider_id
|
|
# ) AS usage_memory_mb
|
|
# ON inv_memory_mb.resource_provider_id = \
|
|
# usage_memory_mb.resource_provider_id
|
|
# LEFT JOIN inventories AS inv_disk_gb
|
|
# ON inv_memory_mb.resource_provider_id = \
|
|
# inv_disk_gb.resource_provider_id
|
|
# AND inv_disk_gb.resource_class_id = $DISK_GB_ID
|
|
# LEFT JOIN (
|
|
# SELECT resource_provider_id, SUM(used) AS used
|
|
# FROM allocations
|
|
# WHERE resource_class_id = $DISK_GB_ID
|
|
# GROUP BY resource_provider_id
|
|
# ) AS usage_disk_gb
|
|
# ON inv_disk_gb.resource_provider_id = \
|
|
# usage_disk_gb.resource_provider_id
|
|
# LEFT JOIN resource_provider_aggregates AS shared_disk_gb
|
|
# ON inv_memory_mb.resource_provider_id = \
|
|
# shared_disk.resource_provider_id
|
|
# LEFT JOIN resource_provider_aggregates AS sharing_disk_gb
|
|
# ON shared_disk_gb.aggregate_id = sharing_disk_gb.aggregate_id
|
|
# AND sharing_disk_gb.resource_provider_id IN ($RPS_SHARING_DISK)
|
|
# WHERE (
|
|
# (
|
|
# COALESCE(usage_vcpu.used, 0) + $AMOUNT_VCPU <=
|
|
# (inv_vcpu.total + inv_vcpu.reserved)
|
|
# * inv_vcpu.allocation_ratio
|
|
# ) AND
|
|
# inv_vcpu.min_unit <= $AMOUNT_VCPU AND
|
|
# inv_vcpu.max_unit >= $AMOUNT_VCPU AND
|
|
# $AMOUNT_VCPU % inv_vcpu.step_size == 0
|
|
# ) AND (
|
|
# (
|
|
# COALESCE(usage_memory_mb.used, 0) + $AMOUNT_VCPU <=
|
|
# (inv_memory_mb.total + inv_memory_mb.reserved)
|
|
# * inv_memory_mb.allocation_ratio
|
|
# ) AND
|
|
# inv_memory_mb.min_unit <= $AMOUNT_MEMORY_MB AND
|
|
# inv_memory_mb.max_unit >= $AMOUNT_MEMORY_MB AND
|
|
# $AMOUNT_MEMORY_MB % inv_memory_mb.step_size == 0
|
|
# ) AND (
|
|
# inv_disk.resource_provider_id IS NOT NULL AND
|
|
# (
|
|
# (
|
|
# COALESCE(usage_disk_gb.used, 0) + $AMOUNT_DISK_GB <=
|
|
# (inv_disk_gb.total + inv_disk_gb.reserved)
|
|
# * inv_disk_gb.allocation_ratio
|
|
# ) AND
|
|
# inv_disk_gb.min_unit <= $AMOUNT_DISK_GB AND
|
|
# inv_disk_gb.max_unit >= $AMOUNT_DISK_GB AND
|
|
# $AMOUNT_DISK_GB % inv_disk_gb.step_size == 0
|
|
# ) OR
|
|
# sharing_disk_gb.resource_provider_id IS NOT NULL
|
|
# )
|
|
# GROUP BY rp.id
|
|
|
|
rpt = sa.alias(_RP_TBL, name="rp")
|
|
|
|
# Contains a set of resource provider IDs for each resource class requested
|
|
sharing_providers = {
|
|
rc_id: _get_providers_with_shared_capacity(ctx, rc_id, amount)
|
|
for rc_id, amount in resources.items()
|
|
}
|
|
|
|
name_map = {
|
|
rc_id: _RC_CACHE.string_from_id(rc_id).lower() for rc_id in resources
|
|
}
|
|
|
|
# Dict, keyed by resource class ID, of an aliased table object for the
|
|
# inventories table winnowed to only that resource class.
|
|
inv_tables = {
|
|
rc_id: sa.alias(_INV_TBL, name='inv_%s' % name_map[rc_id])
|
|
for rc_id in resources
|
|
}
|
|
|
|
# Dict, keyed by resource class ID, of a derived table (subquery in the
|
|
# FROM clause or JOIN) against the allocations table winnowed to only that
|
|
# resource class, grouped by resource provider.
|
|
usage_tables = {
|
|
rc_id: sa.alias(
|
|
sa.select([
|
|
_ALLOC_TBL.c.resource_provider_id,
|
|
sql.func.sum(_ALLOC_TBL.c.used).label('used'),
|
|
]).where(
|
|
_ALLOC_TBL.c.resource_class_id == rc_id
|
|
).group_by(
|
|
_ALLOC_TBL.c.resource_provider_id
|
|
),
|
|
name='usage_%s' % name_map[rc_id],
|
|
)
|
|
for rc_id in resources
|
|
}
|
|
|
|
# Dict, keyed by resource class ID, of an aliased table of
|
|
# resource_provider_aggregates representing the aggregates associated with
|
|
# a provider sharing the resource class
|
|
sharing_tables = {
|
|
rc_id: sa.alias(_RP_AGG_TBL, name='sharing_%s' % name_map[rc_id])
|
|
for rc_id in resources
|
|
if len(sharing_providers[rc_id]) > 0
|
|
}
|
|
|
|
# Dict, keyed by resource class ID, of an aliased table of
|
|
# resource_provider_aggregates representing the resource providers
|
|
# associated by aggregate to the providers sharing a particular resource
|
|
# class.
|
|
shared_tables = {
|
|
rc_id: sa.alias(_RP_AGG_TBL, name='shared_%s' % name_map[rc_id])
|
|
for rc_id in resources
|
|
if len(sharing_providers[rc_id]) > 0
|
|
}
|
|
|
|
# List of the WHERE conditions we build up by looking at the contents
|
|
# of the sharing providers
|
|
where_conds = []
|
|
|
|
# Primary selection is on the resource_providers table and all of the
|
|
# aliased table copies of resource_provider_aggregates for each resource
|
|
# being shared
|
|
sel = sa.select([rpt.c.id])
|
|
|
|
# The chain of joins that we eventually pass to select_from()
|
|
join_chain = None
|
|
|
|
for rc_id, sps in sharing_providers.items():
|
|
it = inv_tables[rc_id]
|
|
ut = usage_tables[rc_id]
|
|
amount = resources[rc_id]
|
|
|
|
rp_link = join_chain if join_chain is not None else rpt
|
|
|
|
# We can do a more efficient INNER JOIN when we don't have shared
|
|
# resource providers for this resource class
|
|
joiner = sa.join
|
|
if sps:
|
|
joiner = sa.outerjoin
|
|
# Add a join condition winnowing this copy of inventories table
|
|
# to only the resource class being analyzed in this loop...
|
|
inv_join = joiner(rp_link, it,
|
|
sa.and_(rpt.c.id == it.c.resource_provider_id,
|
|
it.c.resource_class_id == rc_id))
|
|
usage_join = sa.outerjoin(inv_join, ut,
|
|
rpt.c.id == ut.c.resource_provider_id)
|
|
join_chain = usage_join
|
|
|
|
usage_cond = sa.and_(
|
|
((sql.func.coalesce(ut.c.used, 0) + amount) <=
|
|
(it.c.total - it.c.reserved) * it.c.allocation_ratio),
|
|
it.c.min_unit <= amount,
|
|
it.c.max_unit >= amount,
|
|
amount % it.c.step_size == 0)
|
|
if not sps:
|
|
where_conds.append(usage_cond)
|
|
else:
|
|
sharing = sharing_tables[rc_id]
|
|
shared = shared_tables[rc_id]
|
|
cond = sa.or_(
|
|
sa.and_(
|
|
it.c.resource_provider_id != sa.null(),
|
|
usage_cond,
|
|
),
|
|
sharing.c.resource_provider_id != sa.null())
|
|
where_conds.append(cond)
|
|
|
|
# We need to add the "butterfly" join now that produces the set of
|
|
# resource providers associated with a provider that is sharing the
|
|
# resource via an aggregate
|
|
shared_join = sa.outerjoin(join_chain, shared,
|
|
rpt.c.id == shared.c.resource_provider_id)
|
|
sharing_join = sa.outerjoin(shared_join, sharing,
|
|
sa.and_(
|
|
shared.c.aggregate_id == sharing.c.aggregate_id,
|
|
sharing.c.resource_provider_id.in_(sps),
|
|
))
|
|
join_chain = sharing_join
|
|
|
|
sel = sel.select_from(join_chain)
|
|
sel = sel.where(sa.and_(*where_conds))
|
|
sel = sel.group_by(rpt.c.id)
|
|
|
|
return [r for r in ctx.session.execute(sel)]
|
|
|
|
|
|
@base.NovaObjectRegistry.register_if(False)
|
|
class ResourceProviderList(base.ObjectListBase, base.NovaObject):
|
|
|
|
fields = {
|
|
'objects': fields.ListOfObjectsField('ResourceProvider'),
|
|
}
|
|
|
|
@staticmethod
|
|
@db_api.api_context_manager.reader
|
|
def _get_all_by_filters_from_db(context, filters):
|
|
# Eg. filters can be:
|
|
# filters = {
|
|
# 'name': <name>,
|
|
# 'uuid': <uuid>,
|
|
# 'member_of': [<aggregate_uuid>, <aggregate_uuid>]
|
|
# 'resources': {
|
|
# 'VCPU': 1,
|
|
# 'MEMORY_MB': 1024
|
|
# },
|
|
# 'in_tree': <uuid>,
|
|
# }
|
|
if not filters:
|
|
filters = {}
|
|
else:
|
|
# Since we modify the filters, copy them so that we don't modify
|
|
# them in the calling program.
|
|
filters = copy.deepcopy(filters)
|
|
name = filters.pop('name', None)
|
|
uuid = filters.pop('uuid', None)
|
|
member_of = filters.pop('member_of', [])
|
|
|
|
resources = filters.pop('resources', {})
|
|
# NOTE(sbauza): We want to key the dict by the resource class IDs
|
|
# and we want to make sure those class names aren't incorrect.
|
|
resources = {_RC_CACHE.id_from_string(r_name): amount
|
|
for r_name, amount in resources.items()}
|
|
rp = sa.alias(_RP_TBL, name="rp")
|
|
root_rp = sa.alias(_RP_TBL, name="root_rp")
|
|
parent_rp = sa.alias(_RP_TBL, name="parent_rp")
|
|
|
|
cols = [
|
|
rp.c.id,
|
|
rp.c.uuid,
|
|
rp.c.name,
|
|
rp.c.generation,
|
|
rp.c.updated_at,
|
|
rp.c.created_at,
|
|
root_rp.c.uuid.label("root_provider_uuid"),
|
|
parent_rp.c.uuid.label("parent_provider_uuid"),
|
|
]
|
|
|
|
# TODO(jaypipes): Convert this to an inner join once all
|
|
# root_provider_id values are NOT NULL
|
|
rp_to_root = sa.outerjoin(rp, root_rp,
|
|
rp.c.root_provider_id == root_rp.c.id)
|
|
rp_to_parent = sa.outerjoin(rp_to_root, parent_rp,
|
|
rp.c.parent_provider_id == parent_rp.c.id)
|
|
|
|
query = sa.select(cols).select_from(rp_to_parent)
|
|
|
|
if name:
|
|
query = query.where(rp.c.name == name)
|
|
if uuid:
|
|
query = query.where(rp.c.uuid == uuid)
|
|
if 'in_tree' in filters:
|
|
# The 'in_tree' parameter is the UUID of a resource provider that
|
|
# the caller wants to limit the returned providers to only those
|
|
# within its "provider tree". So, we look up the resource provider
|
|
# having the UUID specified by the 'in_tree' parameter and grab the
|
|
# root_provider_id value of that record. We can then ask for only
|
|
# those resource providers having a root_provider_id of that value.
|
|
tree_uuid = filters.pop('in_tree')
|
|
tree_ids = _provider_ids_from_uuid(context, tree_uuid)
|
|
if tree_ids is None:
|
|
# List operations should simply return an empty list when a
|
|
# non-existing resource provider UUID is given.
|
|
return []
|
|
root_id = tree_ids.root_id
|
|
# TODO(jaypipes): Remove this OR condition when root_provider_id
|
|
# is not nullable in the database and all resource provider records
|
|
# have populated the root provider ID.
|
|
where_cond = sa.or_(rp.c.id == root_id,
|
|
rp.c.root_provider_id == root_id)
|
|
query = query.where(where_cond)
|
|
|
|
# If 'member_of' has values join with the PlacementAggregates to
|
|
# get those resource providers that are associated with any of the
|
|
# list of aggregate uuids provided with 'member_of'.
|
|
if member_of:
|
|
join_statement = sa.join(_AGG_TBL, _RP_AGG_TBL, sa.and_(
|
|
_AGG_TBL.c.id == _RP_AGG_TBL.c.aggregate_id,
|
|
_AGG_TBL.c.uuid.in_(member_of)))
|
|
resource_provider_id = _RP_AGG_TBL.c.resource_provider_id
|
|
rps_in_aggregates = sa.select(
|
|
[resource_provider_id]).select_from(join_statement)
|
|
query = query.where(rp.c.id.in_(rps_in_aggregates))
|
|
|
|
if not resources:
|
|
# Returns quickly the list in case we don't need to check the
|
|
# resource usage
|
|
res = context.session.execute(query).fetchall()
|
|
return [dict(r) for r in res]
|
|
|
|
# NOTE(sbauza): In case we want to look at the resource criteria, then
|
|
# the SQL generated from this case looks something like:
|
|
# SELECT
|
|
# rp.*
|
|
# FROM resource_providers AS rp
|
|
# JOIN inventories AS inv
|
|
# ON rp.id = inv.resource_provider_id
|
|
# LEFT JOIN (
|
|
# SELECT resource_provider_id, resource_class_id, SUM(used) AS used
|
|
# FROM allocations
|
|
# WHERE resource_class_id IN ($RESOURCE_CLASSES)
|
|
# GROUP BY resource_provider_id, resource_class_id
|
|
# ) AS usage
|
|
# ON inv.resource_provider_id = usage.resource_provider_id
|
|
# AND inv.resource_class_id = usage.resource_class_id
|
|
# AND (inv.resource_class_id = $X AND (used + $AMOUNT_X <= (
|
|
# total + reserved) * inv.allocation_ratio) AND
|
|
# inv.min_unit <= $AMOUNT_X AND inv.max_unit >= $AMOUNT_X AND
|
|
# $AMOUNT_X % inv.step_size == 0)
|
|
# OR (inv.resource_class_id = $Y AND (used + $AMOUNT_Y <= (
|
|
# total + reserved) * inv.allocation_ratio) AND
|
|
# inv.min_unit <= $AMOUNT_Y AND inv.max_unit >= $AMOUNT_Y AND
|
|
# $AMOUNT_Y % inv.step_size == 0)
|
|
# OR (inv.resource_class_id = $Z AND (used + $AMOUNT_Z <= (
|
|
# total + reserved) * inv.allocation_ratio) AND
|
|
# inv.min_unit <= $AMOUNT_Z AND inv.max_unit >= $AMOUNT_Z AND
|
|
# $AMOUNT_Z % inv.step_size == 0))
|
|
# GROUP BY rp.id
|
|
# HAVING
|
|
# COUNT(DISTINCT(inv.resource_class_id)) == len($RESOURCE_CLASSES)
|
|
#
|
|
# with a possible additional WHERE clause for the name and uuid that
|
|
# comes from the above filters
|
|
|
|
# First JOIN between inventories and RPs is here
|
|
inv_join = sa.join(rp_to_parent, _INV_TBL,
|
|
rp.c.id == _INV_TBL.c.resource_provider_id)
|
|
|
|
# Now, below is the LEFT JOIN for getting the allocations usage
|
|
usage = sa.select([_ALLOC_TBL.c.resource_provider_id,
|
|
_ALLOC_TBL.c.resource_class_id,
|
|
sql.func.sum(_ALLOC_TBL.c.used).label('used')])
|
|
usage = usage.where(_ALLOC_TBL.c.resource_class_id.in_(resources))
|
|
usage = usage.group_by(_ALLOC_TBL.c.resource_provider_id,
|
|
_ALLOC_TBL.c.resource_class_id)
|
|
usage = sa.alias(usage, name='usage')
|
|
usage_join = sa.outerjoin(inv_join, usage,
|
|
sa.and_(
|
|
usage.c.resource_provider_id == (
|
|
_INV_TBL.c.resource_provider_id),
|
|
usage.c.resource_class_id == _INV_TBL.c.resource_class_id))
|
|
|
|
# And finally, we verify for each resource class if the requested
|
|
# amount isn't more than the left space (considering the allocation
|
|
# ratio, the reserved space and the min and max amount possible sizes)
|
|
where_clauses = [
|
|
sa.and_(
|
|
_INV_TBL.c.resource_class_id == r_idx,
|
|
(func.coalesce(usage.c.used, 0) + amount <= (
|
|
_INV_TBL.c.total - _INV_TBL.c.reserved
|
|
) * _INV_TBL.c.allocation_ratio),
|
|
_INV_TBL.c.min_unit <= amount,
|
|
_INV_TBL.c.max_unit >= amount,
|
|
amount % _INV_TBL.c.step_size == 0
|
|
)
|
|
for (r_idx, amount) in resources.items()]
|
|
query = query.select_from(usage_join)
|
|
query = query.where(sa.or_(*where_clauses))
|
|
query = query.group_by(rp.c.id)
|
|
# NOTE(sbauza): Only RPs having all the asked resources can be provided
|
|
query = query.having(sql.func.count(
|
|
sa.distinct(_INV_TBL.c.resource_class_id)) == len(resources))
|
|
|
|
res = context.session.execute(query).fetchall()
|
|
return [dict(r) for r in res]
|
|
|
|
@classmethod
|
|
def get_all_by_filters(cls, context, filters=None):
|
|
"""Returns a list of `ResourceProvider` objects that have sufficient
|
|
resources in their inventories to satisfy the amounts specified in the
|
|
`filters` parameter.
|
|
|
|
If no resource providers can be found, the function will return an
|
|
empty list.
|
|
|
|
:param context: `nova.context.RequestContext` that may be used to grab
|
|
a DB connection.
|
|
:param filters: Can be `name`, `uuid`, `member_of`, `in_tree` or
|
|
`resources` where `member_of` is a list of aggregate
|
|
uuids, `in_tree` is a UUID of a resource provider that
|
|
we can use to find the root provider ID of the tree of
|
|
providers to filter results by and `resources` is a
|
|
dict of amounts keyed by resource classes.
|
|
:type filters: dict
|
|
"""
|
|
_ensure_rc_cache(context)
|
|
resource_providers = cls._get_all_by_filters_from_db(context, filters)
|
|
return base.obj_make_list(context, cls(context),
|
|
ResourceProvider, resource_providers)
|
|
|
|
|
|
@base.NovaObjectRegistry.register_if(False)
|
|
class Inventory(base.NovaObject, base.NovaTimestampObject):
|
|
|
|
fields = {
|
|
'id': fields.IntegerField(read_only=True),
|
|
'resource_provider': fields.ObjectField('ResourceProvider'),
|
|
'resource_class': fields.ResourceClassField(read_only=True),
|
|
'total': fields.NonNegativeIntegerField(),
|
|
'reserved': fields.NonNegativeIntegerField(default=0),
|
|
'min_unit': fields.NonNegativeIntegerField(default=1),
|
|
'max_unit': fields.NonNegativeIntegerField(default=1),
|
|
'step_size': fields.NonNegativeIntegerField(default=1),
|
|
'allocation_ratio': fields.NonNegativeFloatField(default=1.0),
|
|
}
|
|
|
|
@property
|
|
def capacity(self):
|
|
"""Inventory capacity, adjusted by allocation_ratio."""
|
|
return int((self.total - self.reserved) * self.allocation_ratio)
|
|
|
|
|
|
@db_api.api_context_manager.reader
|
|
def _get_inventory_by_provider_id(ctx, rp_id):
|
|
inv = sa.alias(_INV_TBL, name="i")
|
|
cols = [
|
|
inv.c.resource_class_id,
|
|
inv.c.total,
|
|
inv.c.reserved,
|
|
inv.c.min_unit,
|
|
inv.c.max_unit,
|
|
inv.c.step_size,
|
|
inv.c.allocation_ratio,
|
|
inv.c.updated_at,
|
|
inv.c.created_at,
|
|
]
|
|
sel = sa.select(cols)
|
|
sel = sel.where(inv.c.resource_provider_id == rp_id)
|
|
|
|
return [dict(r) for r in ctx.session.execute(sel)]
|
|
|
|
|
|
@base.NovaObjectRegistry.register_if(False)
|
|
class InventoryList(base.ObjectListBase, base.NovaObject):
|
|
|
|
fields = {
|
|
'objects': fields.ListOfObjectsField('Inventory'),
|
|
}
|
|
|
|
def find(self, res_class):
|
|
"""Return the inventory record from the list of Inventory records that
|
|
matches the supplied resource class, or None.
|
|
|
|
:param res_class: An integer or string representing a resource
|
|
class. If the value is a string, the method first
|
|
looks up the resource class identifier from the
|
|
string.
|
|
"""
|
|
if not isinstance(res_class, six.string_types):
|
|
raise ValueError
|
|
|
|
for inv_rec in self.objects:
|
|
if inv_rec.resource_class == res_class:
|
|
return inv_rec
|
|
|
|
@classmethod
|
|
def get_all_by_resource_provider(cls, context, rp):
|
|
_ensure_rc_cache(context)
|
|
db_inv = _get_inventory_by_provider_id(context, rp.id)
|
|
# Build up a list of Inventory objects, setting the Inventory object
|
|
# fields to the same-named database record field we got from
|
|
# _get_inventory_by_provider_id(). We already have the ResourceProvider
|
|
# object so we just pass that object to the Inventory object
|
|
# constructor as-is
|
|
objs = [
|
|
Inventory(
|
|
context, resource_provider=rp,
|
|
resource_class=_RC_CACHE.string_from_id(
|
|
rec['resource_class_id']),
|
|
**rec)
|
|
for rec in db_inv
|
|
]
|
|
inv_list = cls(context, objects=objs)
|
|
return inv_list
|
|
|
|
|
|
@base.NovaObjectRegistry.register_if(False)
|
|
class Allocation(base.NovaObject, base.NovaTimestampObject):
|
|
|
|
fields = {
|
|
'id': fields.IntegerField(),
|
|
'resource_provider': fields.ObjectField('ResourceProvider'),
|
|
'consumer_id': fields.UUIDField(),
|
|
'resource_class': fields.ResourceClassField(),
|
|
'used': fields.IntegerField(),
|
|
# The following two fields are allowed to be set to None to
|
|
# support Allocations that were created before the fields were
|
|
# required.
|
|
'project_id': fields.StringField(nullable=True),
|
|
'user_id': fields.StringField(nullable=True),
|
|
}
|
|
|
|
def ensure_consumer_project_user(self, ctx):
|
|
"""Examines the project_id, user_id of the object along with the
|
|
supplied consumer_id and ensures that if project_id and user_id
|
|
are set that there are records in the consumers, projects, and
|
|
users table for these entities.
|
|
|
|
:param ctx: `nova.context.RequestContext` object that has the oslo.db
|
|
Session object in it
|
|
"""
|
|
# If project_id and user_id are not set then silently
|
|
# move on. This allows microversion <1.8 to continue to work. Since
|
|
# then the fields are required and the enforcement is at the HTTP
|
|
# API layer.
|
|
if not ('project_id' in self and
|
|
self.project_id is not None and
|
|
'user_id' in self and
|
|
self.user_id is not None):
|
|
return
|
|
# Grab the project internal ID if it exists in the projects table
|
|
pid = _ensure_project(ctx, self.project_id)
|
|
# Grab the user internal ID if it exists in the users table
|
|
uid = _ensure_user(ctx, self.user_id)
|
|
|
|
# Add the consumer if it doesn't already exist
|
|
sel_stmt = sa.select([_CONSUMER_TBL.c.uuid]).where(
|
|
_CONSUMER_TBL.c.uuid == self.consumer_id)
|
|
result = ctx.session.execute(sel_stmt).fetchall()
|
|
if not result:
|
|
try:
|
|
ctx.session.execute(_CONSUMER_TBL.insert().values(
|
|
uuid=self.consumer_id,
|
|
project_id=pid,
|
|
user_id=uid))
|
|
except db_exc.DBDuplicateEntry:
|
|
# We assume at this time that a consumer project/user can't
|
|
# change, so if we get here, we raced and should just pass
|
|
# if the consumer already exists.
|
|
pass
|
|
|
|
|
|
@db_api.api_context_manager.writer
|
|
def _delete_allocations_for_consumer(ctx, consumer_id):
|
|
"""Deletes any existing allocations that correspond to the allocations to
|
|
be written. This is wrapped in a transaction, so if the write subsequently
|
|
fails, the deletion will also be rolled back.
|
|
"""
|
|
del_sql = _ALLOC_TBL.delete().where(
|
|
_ALLOC_TBL.c.consumer_id == consumer_id)
|
|
ctx.session.execute(del_sql)
|
|
|
|
|
|
def _check_capacity_exceeded(ctx, allocs):
|
|
"""Checks to see if the supplied allocation records would result in any of
|
|
the inventories involved having their capacity exceeded.
|
|
|
|
Raises an InvalidAllocationCapacityExceeded exception if any inventory
|
|
would be exhausted by the allocation. Raises an
|
|
InvalidAllocationConstraintsViolated exception if any of the `step_size`,
|
|
`min_unit` or `max_unit` constraints in an inventory will be violated
|
|
by any one of the allocations.
|
|
|
|
If no inventories would be exceeded or violated by the allocations, the
|
|
function returns a list of `ResourceProvider` objects that contain the
|
|
generation at the time of the check.
|
|
|
|
:param ctx: `nova.context.RequestContext` that has an oslo_db Session
|
|
:param allocs: List of `Allocation` objects to check
|
|
"""
|
|
# The SQL generated below looks like this:
|
|
# SELECT
|
|
# rp.id,
|
|
# rp.uuid,
|
|
# rp.generation,
|
|
# inv.resource_class_id,
|
|
# inv.total,
|
|
# inv.reserved,
|
|
# inv.allocation_ratio,
|
|
# allocs.used
|
|
# FROM resource_providers AS rp
|
|
# JOIN inventories AS i1
|
|
# ON rp.id = i1.resource_provider_id
|
|
# LEFT JOIN (
|
|
# SELECT resource_provider_id, resource_class_id, SUM(used) AS used
|
|
# FROM allocations
|
|
# WHERE resource_class_id IN ($RESOURCE_CLASSES)
|
|
# GROUP BY resource_provider_id, resource_class_id
|
|
# ) AS allocs
|
|
# ON inv.resource_provider_id = allocs.resource_provider_id
|
|
# AND inv.resource_class_id = allocs.resource_class_id
|
|
# WHERE rp.uuid IN ($RESOURCE_PROVIDERS)
|
|
# AND inv.resource_class_id IN ($RESOURCE_CLASSES)
|
|
#
|
|
# We then take the results of the above and determine if any of the
|
|
# inventory will have its capacity exceeded.
|
|
rc_ids = set([_RC_CACHE.id_from_string(a.resource_class)
|
|
for a in allocs])
|
|
provider_uuids = set([a.resource_provider.uuid for a in allocs])
|
|
|
|
usage = sa.select([_ALLOC_TBL.c.resource_provider_id,
|
|
_ALLOC_TBL.c.resource_class_id,
|
|
sql.func.sum(_ALLOC_TBL.c.used).label('used')])
|
|
usage = usage.where(_ALLOC_TBL.c.resource_class_id.in_(rc_ids))
|
|
usage = usage.group_by(_ALLOC_TBL.c.resource_provider_id,
|
|
_ALLOC_TBL.c.resource_class_id)
|
|
usage = sa.alias(usage, name='usage')
|
|
|
|
inv_join = sql.join(_RP_TBL, _INV_TBL,
|
|
sql.and_(_RP_TBL.c.id == _INV_TBL.c.resource_provider_id,
|
|
_INV_TBL.c.resource_class_id.in_(rc_ids)))
|
|
primary_join = sql.outerjoin(inv_join, usage,
|
|
sql.and_(
|
|
_INV_TBL.c.resource_provider_id == usage.c.resource_provider_id,
|
|
_INV_TBL.c.resource_class_id == usage.c.resource_class_id)
|
|
)
|
|
cols_in_output = [
|
|
_RP_TBL.c.id.label('resource_provider_id'),
|
|
_RP_TBL.c.uuid,
|
|
_RP_TBL.c.generation,
|
|
_INV_TBL.c.resource_class_id,
|
|
_INV_TBL.c.total,
|
|
_INV_TBL.c.reserved,
|
|
_INV_TBL.c.allocation_ratio,
|
|
_INV_TBL.c.min_unit,
|
|
_INV_TBL.c.max_unit,
|
|
_INV_TBL.c.step_size,
|
|
usage.c.used,
|
|
]
|
|
|
|
sel = sa.select(cols_in_output).select_from(primary_join)
|
|
sel = sel.where(
|
|
sa.and_(_RP_TBL.c.uuid.in_(provider_uuids),
|
|
_INV_TBL.c.resource_class_id.in_(rc_ids)))
|
|
records = ctx.session.execute(sel)
|
|
# Create a map keyed by (rp_uuid, res_class) for the records in the DB
|
|
usage_map = {}
|
|
provs_with_inv = set()
|
|
for record in records:
|
|
map_key = (record['uuid'], record['resource_class_id'])
|
|
if map_key in usage_map:
|
|
raise KeyError("%s already in usage_map, bad query" % str(map_key))
|
|
usage_map[map_key] = record
|
|
provs_with_inv.add(record["uuid"])
|
|
# Ensure that all providers have existing inventory
|
|
missing_provs = provider_uuids - provs_with_inv
|
|
if missing_provs:
|
|
class_str = ', '.join([_RC_CACHE.string_from_id(rc_id)
|
|
for rc_id in rc_ids])
|
|
provider_str = ', '.join(missing_provs)
|
|
raise exception.InvalidInventory(resource_class=class_str,
|
|
resource_provider=provider_str)
|
|
|
|
res_providers = {}
|
|
for alloc in allocs:
|
|
rc_id = _RC_CACHE.id_from_string(alloc.resource_class)
|
|
rp_uuid = alloc.resource_provider.uuid
|
|
key = (rp_uuid, rc_id)
|
|
try:
|
|
usage = usage_map[key]
|
|
except KeyError:
|
|
# The resource class at rc_id is not in the usage map.
|
|
raise exception.InvalidInventory(
|
|
resource_class=alloc.resource_class,
|
|
resource_provider=rp_uuid)
|
|
amount_needed = alloc.used
|
|
allocation_ratio = usage['allocation_ratio']
|
|
min_unit = usage['min_unit']
|
|
max_unit = usage['max_unit']
|
|
step_size = usage['step_size']
|
|
|
|
# check min_unit, max_unit, step_size
|
|
if (amount_needed < min_unit or amount_needed > max_unit or
|
|
amount_needed % step_size != 0):
|
|
LOG.warning(
|
|
"Allocation for %(rc)s on resource provider %(rp)s "
|
|
"violates min_unit, max_unit, or step_size. "
|
|
"Requested: %(requested)s, min_unit: %(min_unit)s, "
|
|
"max_unit: %(max_unit)s, step_size: %(step_size)s",
|
|
{'rc': alloc.resource_class,
|
|
'rp': rp_uuid,
|
|
'requested': amount_needed,
|
|
'min_unit': min_unit,
|
|
'max_unit': max_unit,
|
|
'step_size': step_size})
|
|
raise exception.InvalidAllocationConstraintsViolated(
|
|
resource_class=alloc.resource_class,
|
|
resource_provider=rp_uuid)
|
|
|
|
# usage["used"] can be returned as None
|
|
used = usage['used'] or 0
|
|
capacity = (usage['total'] - usage['reserved']) * allocation_ratio
|
|
if capacity < (used + amount_needed):
|
|
LOG.warning(
|
|
"Over capacity for %(rc)s on resource provider %(rp)s. "
|
|
"Needed: %(needed)s, Used: %(used)s, Capacity: %(cap)s",
|
|
{'rc': alloc.resource_class,
|
|
'rp': rp_uuid,
|
|
'needed': amount_needed,
|
|
'used': used,
|
|
'cap': capacity})
|
|
raise exception.InvalidAllocationCapacityExceeded(
|
|
resource_class=alloc.resource_class,
|
|
resource_provider=rp_uuid)
|
|
if rp_uuid not in res_providers:
|
|
res_providers[rp_uuid] = alloc.resource_provider
|
|
return res_providers
|
|
|
|
|
|
def _ensure_lookup_table_entry(ctx, tbl, external_id):
|
|
"""Ensures the supplied external ID exists in the specified lookup table
|
|
and if not, adds it. Returns the internal ID.
|
|
|
|
:param ctx: `nova.context.RequestContext` object that has the oslo.db
|
|
Session object in it
|
|
:param tbl: The lookup table
|
|
:param external_id: The external project or user identifier
|
|
:type external_id: string
|
|
"""
|
|
# Grab the project internal ID if it exists in the projects table
|
|
sel = sa.select([tbl.c.id]).where(
|
|
tbl.c.external_id == external_id
|
|
)
|
|
res = ctx.session.execute(sel).fetchall()
|
|
if not res:
|
|
try:
|
|
ins_stmt = tbl.insert().values(external_id=external_id)
|
|
res = ctx.session.execute(ins_stmt)
|
|
return res.inserted_primary_key[0]
|
|
except db_exc.DBDuplicateEntry:
|
|
# Another thread added it just before us, so just read the
|
|
# internal ID that that thread created...
|
|
res = ctx.session.execute(sel).fetchall()
|
|
|
|
return res[0][0]
|
|
|
|
|
|
def _ensure_project(ctx, external_id):
|
|
"""Ensures the supplied external project ID exists in the projects lookup
|
|
table and if not, adds it. Returns the internal project ID.
|
|
|
|
:param ctx: `nova.context.RequestContext` object that has the oslo.db
|
|
Session object in it
|
|
:param external_id: The external project identifier
|
|
:type external_id: string
|
|
"""
|
|
return _ensure_lookup_table_entry(ctx, _PROJECT_TBL, external_id)
|
|
|
|
|
|
def _ensure_user(ctx, external_id):
|
|
"""Ensures the supplied external user ID exists in the users lookup table
|
|
and if not, adds it. Returns the internal user ID.
|
|
|
|
:param ctx: `nova.context.RequestContext` object that has the oslo.db
|
|
Session object in it
|
|
:param external_id: The external user identifier
|
|
:type external_id: string
|
|
"""
|
|
return _ensure_lookup_table_entry(ctx, _USER_TBL, external_id)
|
|
|
|
|
|
@db_api.api_context_manager.reader
|
|
def _get_allocations_by_provider_id(ctx, rp_id):
|
|
allocs = sa.alias(_ALLOC_TBL, name="a")
|
|
cols = [
|
|
allocs.c.resource_class_id,
|
|
allocs.c.consumer_id,
|
|
allocs.c.used,
|
|
allocs.c.updated_at,
|
|
allocs.c.created_at
|
|
]
|
|
sel = sa.select(cols)
|
|
sel = sel.where(allocs.c.resource_provider_id == rp_id)
|
|
|
|
return [dict(r) for r in ctx.session.execute(sel)]
|
|
|
|
|
|
@db_api.api_context_manager.reader
|
|
def _get_allocations_by_consumer_uuid(ctx, consumer_uuid):
|
|
allocs = sa.alias(_ALLOC_TBL, name="a")
|
|
rp = sa.alias(_RP_TBL, name="rp")
|
|
consumer = sa.alias(_CONSUMER_TBL, name="c")
|
|
project = sa.alias(_PROJECT_TBL, name="p")
|
|
user = sa.alias(_USER_TBL, name="u")
|
|
cols = [
|
|
allocs.c.resource_provider_id,
|
|
rp.c.name.label("resource_provider_name"),
|
|
rp.c.uuid.label("resource_provider_uuid"),
|
|
rp.c.generation.label("resource_provider_generation"),
|
|
allocs.c.resource_class_id,
|
|
allocs.c.consumer_id,
|
|
allocs.c.used,
|
|
project.c.external_id.label("project_id"),
|
|
user.c.external_id.label("user_id"),
|
|
]
|
|
# Build up the joins of the five tables we need to interact with.
|
|
rp_join = sa.join(allocs, rp, allocs.c.resource_provider_id == rp.c.id)
|
|
consumer_join = sa.outerjoin(rp_join, consumer,
|
|
allocs.c.consumer_id == consumer.c.uuid)
|
|
project_join = sa.outerjoin(consumer_join, project,
|
|
consumer.c.project_id == project.c.id)
|
|
user_join = sa.outerjoin(project_join, user,
|
|
consumer.c.user_id == user.c.id)
|
|
|
|
sel = sa.select(cols).select_from(user_join)
|
|
sel = sel.where(allocs.c.consumer_id == consumer_uuid)
|
|
|
|
return [dict(r) for r in ctx.session.execute(sel)]
|
|
|
|
|
|
@base.NovaObjectRegistry.register_if(False)
|
|
class AllocationList(base.ObjectListBase, base.NovaObject):
|
|
|
|
fields = {
|
|
'objects': fields.ListOfObjectsField('Allocation'),
|
|
}
|
|
|
|
@oslo_db_api.wrap_db_retry(max_retries=5, retry_on_deadlock=True)
|
|
@db_api.api_context_manager.writer
|
|
def _set_allocations(self, context, allocs):
|
|
"""Write a set of allocations.
|
|
|
|
We must check that there is capacity for each allocation.
|
|
If there is not we roll back the entire set.
|
|
|
|
:raises `exception.ResourceClassNotFound` if any resource class in any
|
|
allocation in allocs cannot be found in either the standard
|
|
classes or the DB.
|
|
:raises `exception.InvalidAllocationCapacityExceeded` if any inventory
|
|
would be exhausted by the allocation.
|
|
:raises `InvalidAllocationConstraintsViolated` if any of the
|
|
`step_size`, `min_unit` or `max_unit` constraints in an
|
|
inventory will be violated by any one of the allocations.
|
|
"""
|
|
_ensure_rc_cache(context)
|
|
# Make sure that all of the allocations are new.
|
|
for alloc in allocs:
|
|
if 'id' in alloc:
|
|
raise exception.ObjectActionError(action='create',
|
|
reason='already created')
|
|
|
|
# First delete any existing allocations for any consumers. This
|
|
# provides a clean slate for the consumers mentioned in the list of
|
|
# allocations being manipulated.
|
|
consumer_ids = set(alloc.consumer_id for alloc in allocs)
|
|
for consumer_id in consumer_ids:
|
|
_delete_allocations_for_consumer(context, consumer_id)
|
|
|
|
# Before writing any allocation records, we check that the submitted
|
|
# allocations do not cause any inventory capacity to be exceeded for
|
|
# any resource provider and resource class involved in the allocation
|
|
# transaction. _check_capacity_exceeded() raises an exception if any
|
|
# inventory capacity is exceeded. If capacity is not exceeeded, the
|
|
# function returns a list of ResourceProvider objects containing the
|
|
# generation of the resource provider at the time of the check. These
|
|
# objects are used at the end of the allocation transaction as a guard
|
|
# against concurrent updates.
|
|
#
|
|
# Don't check capacity when alloc.used is zero. Zero is not a valid
|
|
# amount when making an allocation (the minimum consumption of a
|
|
# resource is one) but is used in this method to indicate a need for
|
|
# removal. Providing 0 is controlled at the HTTP API layer where PUT
|
|
# /allocations does not allow empty allocations. When POST /allocations
|
|
# is implemented it will for the special case of atomically setting and
|
|
# removing different allocations in the same request.
|
|
# _check_capacity_exceeded will raise a ResourceClassNotFound # if any
|
|
# allocation is using a resource class that does not exist.
|
|
visited_rps = _check_capacity_exceeded(context,
|
|
[alloc for alloc in
|
|
allocs if alloc.used > 0])
|
|
seen_consumers = set()
|
|
for alloc in allocs:
|
|
# If alloc.used is set to zero that is a signal that we don't want
|
|
# to (re-)create any allocations for this resource class.
|
|
# _delete_current_allocs has already wiped out allocations so all
|
|
# that's being done here is adding the resource provider to
|
|
# visited_rps so its generation will be checked at the end of the
|
|
# transaction.
|
|
if alloc.used == 0:
|
|
rp = alloc.resource_provider
|
|
visited_rps[rp.uuid] = rp
|
|
continue
|
|
consumer_id = alloc.consumer_id
|
|
# Only set consumer <-> project/user association if we haven't set
|
|
# it already.
|
|
if consumer_id not in seen_consumers:
|
|
alloc.ensure_consumer_project_user(context)
|
|
seen_consumers.add(consumer_id)
|
|
rp = alloc.resource_provider
|
|
rc_id = _RC_CACHE.id_from_string(alloc.resource_class)
|
|
ins_stmt = _ALLOC_TBL.insert().values(
|
|
resource_provider_id=rp.id,
|
|
resource_class_id=rc_id,
|
|
consumer_id=consumer_id,
|
|
used=alloc.used)
|
|
context.session.execute(ins_stmt)
|
|
|
|
# Generation checking happens here. If the inventory for this resource
|
|
# provider changed out from under us, this will raise a
|
|
# ConcurrentUpdateDetected which can be caught by the caller to choose
|
|
# to try again. It will also rollback the transaction so that these
|
|
# changes always happen atomically.
|
|
for rp in visited_rps.values():
|
|
rp.generation = _increment_provider_generation(context, rp)
|
|
|
|
@classmethod
|
|
def get_all_by_resource_provider(cls, context, rp):
|
|
_ensure_rc_cache(context)
|
|
db_allocs = _get_allocations_by_provider_id(context, rp.id)
|
|
# Build up a list of Allocation objects, setting the Allocation object
|
|
# fields to the same-named database record field we got from
|
|
# _get_allocations_by_provider_id(). We already have the
|
|
# ResourceProvider object so we just pass that object to the Allocation
|
|
# object constructor as-is
|
|
objs = [
|
|
Allocation(
|
|
context, resource_provider=rp,
|
|
resource_class=_RC_CACHE.string_from_id(
|
|
rec['resource_class_id']),
|
|
**rec)
|
|
for rec in db_allocs
|
|
]
|
|
alloc_list = cls(context, objects=objs)
|
|
return alloc_list
|
|
|
|
@classmethod
|
|
def get_all_by_consumer_id(cls, context, consumer_id):
|
|
_ensure_rc_cache(context)
|
|
db_allocs = _get_allocations_by_consumer_uuid(context, consumer_id)
|
|
# Build up a list of Allocation objects, setting the Allocation object
|
|
# fields to the same-named database record field we got from
|
|
# _get_allocations_by_consumer_id().
|
|
#
|
|
# NOTE(jaypipes): Unlike with get_all_by_resource_provider(), we do
|
|
# NOT already have the ResourceProvider object so we construct a new
|
|
# ResourceProvider object below by looking at the resource provider
|
|
# fields returned by _get_allocations_by_consumer_id().
|
|
objs = [
|
|
Allocation(
|
|
context, resource_provider=ResourceProvider(
|
|
context,
|
|
id=rec['resource_provider_id'],
|
|
uuid=rec['resource_provider_uuid'],
|
|
name=rec['resource_provider_name'],
|
|
generation=rec['resource_provider_generation']),
|
|
resource_class=_RC_CACHE.string_from_id(
|
|
rec['resource_class_id']),
|
|
**rec)
|
|
for rec in db_allocs
|
|
]
|
|
alloc_list = cls(context, objects=objs)
|
|
return alloc_list
|
|
|
|
def create_all(self):
|
|
"""Create the supplied allocations.
|
|
|
|
Note that the Allocation objects that are created are not
|
|
returned to the caller, nor are their database ids set. If
|
|
those ids are required use one of the get_all_by* methods.
|
|
"""
|
|
# TODO(jaypipes): Retry the allocation writes on
|
|
# ConcurrentUpdateDetected
|
|
self._set_allocations(self._context, self.objects)
|
|
|
|
def delete_all(self):
|
|
# Allocations can only have a single consumer, so take advantage of
|
|
# that fact and do an efficient batch delete
|
|
consumer_uuid = self.objects[0].consumer_id
|
|
_delete_allocations_for_consumer(self._context, consumer_uuid)
|
|
|
|
def __repr__(self):
|
|
strings = [repr(x) for x in self.objects]
|
|
return "AllocationList[" + ", ".join(strings) + "]"
|
|
|
|
|
|
@base.NovaObjectRegistry.register_if(False)
|
|
class Usage(base.NovaObject):
|
|
|
|
fields = {
|
|
'resource_class': fields.ResourceClassField(read_only=True),
|
|
'usage': fields.NonNegativeIntegerField(),
|
|
}
|
|
|
|
@staticmethod
|
|
def _from_db_object(context, target, source):
|
|
for field in target.fields:
|
|
if field not in ('resource_class'):
|
|
setattr(target, field, source[field])
|
|
|
|
if 'resource_class' not in target:
|
|
rc_str = _RC_CACHE.string_from_id(source['resource_class_id'])
|
|
target.resource_class = rc_str
|
|
|
|
target._context = context
|
|
target.obj_reset_changes()
|
|
return target
|
|
|
|
|
|
@base.NovaObjectRegistry.register_if(False)
|
|
class UsageList(base.ObjectListBase, base.NovaObject):
|
|
|
|
fields = {
|
|
'objects': fields.ListOfObjectsField('Usage'),
|
|
}
|
|
|
|
@staticmethod
|
|
@db_api.api_context_manager.reader
|
|
def _get_all_by_resource_provider_uuid(context, rp_uuid):
|
|
query = (context.session.query(models.Inventory.resource_class_id,
|
|
func.coalesce(func.sum(models.Allocation.used), 0))
|
|
.join(models.ResourceProvider,
|
|
models.Inventory.resource_provider_id ==
|
|
models.ResourceProvider.id)
|
|
.outerjoin(models.Allocation,
|
|
sql.and_(models.Inventory.resource_provider_id ==
|
|
models.Allocation.resource_provider_id,
|
|
models.Inventory.resource_class_id ==
|
|
models.Allocation.resource_class_id))
|
|
.filter(models.ResourceProvider.uuid == rp_uuid)
|
|
.group_by(models.Inventory.resource_class_id))
|
|
result = [dict(resource_class_id=item[0], usage=item[1])
|
|
for item in query.all()]
|
|
return result
|
|
|
|
@staticmethod
|
|
@db_api.api_context_manager.reader
|
|
def _get_all_by_project_user(context, project_id, user_id=None):
|
|
query = (context.session.query(models.Allocation.resource_class_id,
|
|
func.coalesce(func.sum(models.Allocation.used), 0))
|
|
.join(models.Consumer,
|
|
models.Allocation.consumer_id == models.Consumer.uuid)
|
|
.join(models.Project,
|
|
models.Consumer.project_id == models.Project.id)
|
|
.filter(models.Project.external_id == project_id))
|
|
if user_id:
|
|
query = query.join(models.User,
|
|
models.Consumer.user_id == models.User.id)
|
|
query = query.filter(models.User.external_id == user_id)
|
|
query = query.group_by(models.Allocation.resource_class_id)
|
|
result = [dict(resource_class_id=item[0], usage=item[1])
|
|
for item in query.all()]
|
|
return result
|
|
|
|
@classmethod
|
|
def get_all_by_resource_provider_uuid(cls, context, rp_uuid):
|
|
_ensure_rc_cache(context)
|
|
usage_list = cls._get_all_by_resource_provider_uuid(context, rp_uuid)
|
|
return base.obj_make_list(context, cls(context), Usage, usage_list)
|
|
|
|
@classmethod
|
|
def get_all_by_project_user(cls, context, project_id, user_id=None):
|
|
_ensure_rc_cache(context)
|
|
usage_list = cls._get_all_by_project_user(context, project_id,
|
|
user_id=user_id)
|
|
return base.obj_make_list(context, cls(context), Usage, usage_list)
|
|
|
|
def __repr__(self):
|
|
strings = [repr(x) for x in self.objects]
|
|
return "UsageList[" + ", ".join(strings) + "]"
|
|
|
|
|
|
@base.NovaObjectRegistry.register_if(False)
|
|
class ResourceClass(base.NovaObject, base.NovaTimestampObject):
|
|
|
|
MIN_CUSTOM_RESOURCE_CLASS_ID = 10000
|
|
"""Any user-defined resource classes must have an identifier greater than
|
|
or equal to this number.
|
|
"""
|
|
|
|
# Retry count for handling possible race condition in creating resource
|
|
# class. We don't ever want to hit this, as it is simply a race when
|
|
# creating these classes, but this is just a stopgap to prevent a potential
|
|
# infinite loop.
|
|
RESOURCE_CREATE_RETRY_COUNT = 100
|
|
|
|
fields = {
|
|
'id': fields.IntegerField(read_only=True),
|
|
'name': fields.ResourceClassField(nullable=False),
|
|
}
|
|
|
|
@staticmethod
|
|
def _from_db_object(context, target, source):
|
|
for field in target.fields:
|
|
setattr(target, field, source[field])
|
|
|
|
target._context = context
|
|
target.obj_reset_changes()
|
|
return target
|
|
|
|
@classmethod
|
|
def get_by_name(cls, context, name):
|
|
"""Return a ResourceClass object with the given string name.
|
|
|
|
:param name: String name of the resource class to find
|
|
|
|
:raises: ResourceClassNotFound if no such resource class was found
|
|
"""
|
|
_ensure_rc_cache(context)
|
|
rc = _RC_CACHE.all_from_string(name)
|
|
obj = cls(context, id=rc['id'], name=rc['name'],
|
|
updated_at=rc['updated_at'], created_at=rc['created_at'])
|
|
obj.obj_reset_changes()
|
|
return obj
|
|
|
|
@staticmethod
|
|
@db_api.api_context_manager.reader
|
|
def _get_next_id(context):
|
|
"""Utility method to grab the next resource class identifier to use for
|
|
user-defined resource classes.
|
|
"""
|
|
query = context.session.query(func.max(models.ResourceClass.id))
|
|
max_id = query.one()[0]
|
|
if not max_id:
|
|
return ResourceClass.MIN_CUSTOM_RESOURCE_CLASS_ID
|
|
else:
|
|
return max_id + 1
|
|
|
|
def create(self):
|
|
if 'id' in self:
|
|
raise exception.ObjectActionError(action='create',
|
|
reason='already created')
|
|
if 'name' not in self:
|
|
raise exception.ObjectActionError(action='create',
|
|
reason='name is required')
|
|
if self.name in fields.ResourceClass.STANDARD:
|
|
raise exception.ResourceClassExists(resource_class=self.name)
|
|
|
|
if not self.name.startswith(fields.ResourceClass.CUSTOM_NAMESPACE):
|
|
raise exception.ObjectActionError(
|
|
action='create',
|
|
reason='name must start with ' +
|
|
fields.ResourceClass.CUSTOM_NAMESPACE)
|
|
|
|
updates = self.obj_get_changes()
|
|
# There is the possibility of a race when adding resource classes, as
|
|
# the ID is generated locally. This loop catches that exception, and
|
|
# retries until either it succeeds, or a different exception is
|
|
# encountered.
|
|
retries = self.RESOURCE_CREATE_RETRY_COUNT
|
|
while retries:
|
|
retries -= 1
|
|
try:
|
|
rc = self._create_in_db(self._context, updates)
|
|
self._from_db_object(self._context, self, rc)
|
|
break
|
|
except db_exc.DBDuplicateEntry as e:
|
|
if 'id' in e.columns:
|
|
# Race condition for ID creation; try again
|
|
continue
|
|
# The duplication is on the other unique column, 'name'. So do
|
|
# not retry; raise the exception immediately.
|
|
raise exception.ResourceClassExists(resource_class=self.name)
|
|
else:
|
|
# We have no idea how common it will be in practice for the retry
|
|
# limit to be exceeded. We set it high in the hope that we never
|
|
# hit this point, but added this log message so we know that this
|
|
# specific situation occurred.
|
|
LOG.warning("Exceeded retry limit on ID generation while "
|
|
"creating ResourceClass %(name)s",
|
|
{'name': self.name})
|
|
msg = _("creating resource class %s") % self.name
|
|
raise exception.MaxDBRetriesExceeded(action=msg)
|
|
|
|
@staticmethod
|
|
@db_api.api_context_manager.writer
|
|
def _create_in_db(context, updates):
|
|
next_id = ResourceClass._get_next_id(context)
|
|
rc = models.ResourceClass()
|
|
rc.update(updates)
|
|
rc.id = next_id
|
|
context.session.add(rc)
|
|
return rc
|
|
|
|
def destroy(self):
|
|
if 'id' not in self:
|
|
raise exception.ObjectActionError(action='destroy',
|
|
reason='ID attribute not found')
|
|
# Never delete any standard resource class, since the standard resource
|
|
# classes don't even exist in the database table anyway.
|
|
_ensure_rc_cache(self._context)
|
|
if self.id in (rc['id'] for rc in _RC_CACHE.STANDARDS):
|
|
raise exception.ResourceClassCannotDeleteStandard(
|
|
resource_class=self.name)
|
|
|
|
self._destroy(self._context, self.id, self.name)
|
|
_RC_CACHE.clear()
|
|
|
|
@staticmethod
|
|
@db_api.api_context_manager.writer
|
|
def _destroy(context, _id, name):
|
|
# Don't delete the resource class if it is referred to in the
|
|
# inventories table.
|
|
num_inv = context.session.query(models.Inventory).filter(
|
|
models.Inventory.resource_class_id == _id).count()
|
|
if num_inv:
|
|
raise exception.ResourceClassInUse(resource_class=name)
|
|
|
|
res = context.session.query(models.ResourceClass).filter(
|
|
models.ResourceClass.id == _id).delete()
|
|
if not res:
|
|
raise exception.NotFound()
|
|
|
|
def save(self):
|
|
if 'id' not in self:
|
|
raise exception.ObjectActionError(action='save',
|
|
reason='ID attribute not found')
|
|
updates = self.obj_get_changes()
|
|
# Never update any standard resource class, since the standard resource
|
|
# classes don't even exist in the database table anyway.
|
|
_ensure_rc_cache(self._context)
|
|
if self.id in (rc['id'] for rc in _RC_CACHE.STANDARDS):
|
|
raise exception.ResourceClassCannotUpdateStandard(
|
|
resource_class=self.name)
|
|
self._save(self._context, self.id, self.name, updates)
|
|
_RC_CACHE.clear()
|
|
|
|
@staticmethod
|
|
@db_api.api_context_manager.writer
|
|
def _save(context, id, name, updates):
|
|
db_rc = context.session.query(models.ResourceClass).filter_by(
|
|
id=id).first()
|
|
db_rc.update(updates)
|
|
try:
|
|
db_rc.save(context.session)
|
|
except db_exc.DBDuplicateEntry:
|
|
raise exception.ResourceClassExists(resource_class=name)
|
|
|
|
|
|
@base.NovaObjectRegistry.register_if(False)
|
|
class ResourceClassList(base.ObjectListBase, base.NovaObject):
|
|
|
|
fields = {
|
|
'objects': fields.ListOfObjectsField('ResourceClass'),
|
|
}
|
|
|
|
@staticmethod
|
|
@db_api.api_context_manager.reader
|
|
def _get_all(context):
|
|
_ensure_rc_cache(context)
|
|
customs = list(context.session.query(models.ResourceClass).all())
|
|
return _RC_CACHE.STANDARDS + customs
|
|
|
|
@classmethod
|
|
def get_all(cls, context):
|
|
resource_classes = cls._get_all(context)
|
|
return base.obj_make_list(context, cls(context),
|
|
ResourceClass, resource_classes)
|
|
|
|
def __repr__(self):
|
|
strings = [repr(x) for x in self.objects]
|
|
return "ResourceClassList[" + ", ".join(strings) + "]"
|
|
|
|
|
|
@base.NovaObjectRegistry.register_if(False)
|
|
class Trait(base.NovaObject, base.NovaTimestampObject):
|
|
|
|
# All the user-defined traits must begin with this prefix.
|
|
CUSTOM_NAMESPACE = 'CUSTOM_'
|
|
|
|
fields = {
|
|
'id': fields.IntegerField(read_only=True),
|
|
'name': fields.StringField(nullable=False)
|
|
}
|
|
|
|
@staticmethod
|
|
def _from_db_object(context, trait, db_trait):
|
|
for key in trait.fields:
|
|
setattr(trait, key, db_trait[key])
|
|
trait.obj_reset_changes()
|
|
trait._context = context
|
|
return trait
|
|
|
|
@staticmethod
|
|
@db_api.api_context_manager.writer
|
|
def _create_in_db(context, updates):
|
|
trait = models.Trait()
|
|
trait.update(updates)
|
|
context.session.add(trait)
|
|
return trait
|
|
|
|
def create(self):
|
|
if 'id' in self:
|
|
raise exception.ObjectActionError(action='create',
|
|
reason='already created')
|
|
if 'name' not in self:
|
|
raise exception.ObjectActionError(action='create',
|
|
reason='name is required')
|
|
|
|
updates = self.obj_get_changes()
|
|
|
|
try:
|
|
db_trait = self._create_in_db(self._context, updates)
|
|
except db_exc.DBDuplicateEntry:
|
|
raise exception.TraitExists(name=self.name)
|
|
|
|
self._from_db_object(self._context, self, db_trait)
|
|
|
|
@staticmethod
|
|
@db_api.api_context_manager.writer # trait sync can cause a write
|
|
def _get_by_name_from_db(context, name):
|
|
_ensure_trait_sync(context)
|
|
result = context.session.query(models.Trait).filter_by(
|
|
name=name).first()
|
|
if not result:
|
|
raise exception.TraitNotFound(names=name)
|
|
return result
|
|
|
|
@classmethod
|
|
def get_by_name(cls, context, name):
|
|
db_trait = cls._get_by_name_from_db(context, six.text_type(name))
|
|
return cls._from_db_object(context, cls(), db_trait)
|
|
|
|
@staticmethod
|
|
@db_api.api_context_manager.writer
|
|
def _destroy_in_db(context, _id, name):
|
|
num = context.session.query(models.ResourceProviderTrait).filter(
|
|
models.ResourceProviderTrait.trait_id == _id).count()
|
|
if num:
|
|
raise exception.TraitInUse(name=name)
|
|
|
|
res = context.session.query(models.Trait).filter_by(
|
|
name=name).delete()
|
|
if not res:
|
|
raise exception.TraitNotFound(names=name)
|
|
|
|
def destroy(self):
|
|
if 'name' not in self:
|
|
raise exception.ObjectActionError(action='destroy',
|
|
reason='name is required')
|
|
|
|
if not self.name.startswith(self.CUSTOM_NAMESPACE):
|
|
raise exception.TraitCannotDeleteStandard(name=self.name)
|
|
|
|
if 'id' not in self:
|
|
raise exception.ObjectActionError(action='destroy',
|
|
reason='ID attribute not found')
|
|
|
|
self._destroy_in_db(self._context, self.id, self.name)
|
|
|
|
|
|
@base.NovaObjectRegistry.register_if(False)
|
|
class TraitList(base.ObjectListBase, base.NovaObject):
|
|
|
|
fields = {
|
|
'objects': fields.ListOfObjectsField('Trait')
|
|
}
|
|
|
|
@staticmethod
|
|
@db_api.api_context_manager.writer # trait sync can cause a write
|
|
def _get_all_from_db(context, filters):
|
|
_ensure_trait_sync(context)
|
|
if not filters:
|
|
filters = {}
|
|
|
|
query = context.session.query(models.Trait)
|
|
if 'name_in' in filters:
|
|
query = query.filter(models.Trait.name.in_(
|
|
[six.text_type(n) for n in filters['name_in']]
|
|
))
|
|
if 'prefix' in filters:
|
|
query = query.filter(
|
|
models.Trait.name.like(six.text_type(filters['prefix'] + '%')))
|
|
if 'associated' in filters:
|
|
if filters['associated']:
|
|
query = query.join(models.ResourceProviderTrait,
|
|
models.Trait.id == models.ResourceProviderTrait.trait_id
|
|
).distinct()
|
|
else:
|
|
query = query.outerjoin(models.ResourceProviderTrait,
|
|
models.Trait.id == models.ResourceProviderTrait.trait_id
|
|
).filter(models.ResourceProviderTrait.trait_id == null())
|
|
|
|
return query.all()
|
|
|
|
@base.remotable_classmethod
|
|
def get_all(cls, context, filters=None):
|
|
db_traits = cls._get_all_from_db(context, filters)
|
|
return base.obj_make_list(context, cls(context), Trait, db_traits)
|
|
|
|
@classmethod
|
|
def get_all_by_resource_provider(cls, context, rp):
|
|
"""Returns a TraitList containing Trait objects for any trait
|
|
associated with the supplied resource provider.
|
|
"""
|
|
db_traits = _get_traits_by_provider_id(context, rp.id)
|
|
return base.obj_make_list(context, cls(context), Trait, db_traits)
|
|
|
|
|
|
@base.NovaObjectRegistry.register_if(False)
|
|
class AllocationRequestResource(base.NovaObject):
|
|
|
|
fields = {
|
|
'resource_provider': fields.ObjectField('ResourceProvider'),
|
|
'resource_class': fields.ResourceClassField(read_only=True),
|
|
'amount': fields.NonNegativeIntegerField(),
|
|
}
|
|
|
|
|
|
@base.NovaObjectRegistry.register_if(False)
|
|
class AllocationRequest(base.NovaObject):
|
|
|
|
fields = {
|
|
'resource_requests': fields.ListOfObjectsField(
|
|
'AllocationRequestResource'
|
|
),
|
|
}
|
|
|
|
|
|
@base.NovaObjectRegistry.register_if(False)
|
|
class ProviderSummaryResource(base.NovaObject):
|
|
|
|
fields = {
|
|
'resource_class': fields.ResourceClassField(read_only=True),
|
|
'capacity': fields.NonNegativeIntegerField(),
|
|
'used': fields.NonNegativeIntegerField(),
|
|
}
|
|
|
|
|
|
@base.NovaObjectRegistry.register_if(False)
|
|
class ProviderSummary(base.NovaObject):
|
|
|
|
fields = {
|
|
'resource_provider': fields.ObjectField('ResourceProvider'),
|
|
'resources': fields.ListOfObjectsField('ProviderSummaryResource'),
|
|
'traits': fields.ListOfObjectsField('Trait'),
|
|
}
|
|
|
|
@property
|
|
def resource_class_names(self):
|
|
"""Helper property that returns a set() of resource class string names
|
|
that are included in the provider summary.
|
|
"""
|
|
return set(res.resource_class for res in self.resources)
|
|
|
|
|
|
@db_api.api_context_manager.reader
|
|
def _get_usages_by_provider_and_rc(ctx, rp_ids, rc_ids):
|
|
"""Returns a row iterator of usage records grouped by resource provider ID
|
|
and resource class ID for all resource providers and resource classes
|
|
involved in our request
|
|
"""
|
|
# We build up a SQL expression that looks like this:
|
|
# SELECT
|
|
# rp.id as resource_provider_id
|
|
# , rp.uuid as resource_provider_uuid
|
|
# , inv.resource_class_id
|
|
# , inv.total
|
|
# , inv.reserved
|
|
# , inv.allocation_ratio
|
|
# , usage.used
|
|
# FROM resource_providers AS rp
|
|
# JOIN inventories AS inv
|
|
# ON rp.id = inv.resource_provider_id
|
|
# LEFT JOIN (
|
|
# SELECT resource_provider_id, resource_class_id, SUM(used) as used
|
|
# FROM allocations
|
|
# WHERE resource_provider_id IN ($rp_ids)
|
|
# AND resource_class_id IN ($rc_ids)
|
|
# GROUP BY resource_provider_id, resource_class_id
|
|
# )
|
|
# AS usages
|
|
# ON inv.resource_provider_id = usage.resource_provider_id
|
|
# AND inv.resource_class_id = usage.resource_class_id
|
|
# WHERE rp.id IN ($rp_ids)
|
|
# AND inv.resource_class_id IN ($rc_ids)
|
|
rpt = sa.alias(_RP_TBL, name="rp")
|
|
inv = sa.alias(_INV_TBL, name="inv")
|
|
# Build our derived table (subquery in the FROM clause) that sums used
|
|
# amounts for resource provider and resource class
|
|
usage = sa.alias(
|
|
sa.select([
|
|
_ALLOC_TBL.c.resource_provider_id,
|
|
_ALLOC_TBL.c.resource_class_id,
|
|
sql.func.sum(_ALLOC_TBL.c.used).label('used'),
|
|
]).where(
|
|
sa.and_(
|
|
_ALLOC_TBL.c.resource_provider_id.in_(rp_ids),
|
|
_ALLOC_TBL.c.resource_class_id.in_(rc_ids),
|
|
),
|
|
).group_by(
|
|
_ALLOC_TBL.c.resource_provider_id,
|
|
_ALLOC_TBL.c.resource_class_id
|
|
),
|
|
name='usage',
|
|
)
|
|
# Build a join between the resource providers and inventories table
|
|
rpt_inv_join = sa.join(rpt, inv, rpt.c.id == inv.c.resource_provider_id)
|
|
# And then join to the derived table of usages
|
|
usage_join = sa.outerjoin(
|
|
rpt_inv_join,
|
|
usage,
|
|
sa.and_(
|
|
usage.c.resource_provider_id == inv.c.resource_provider_id,
|
|
usage.c.resource_class_id == inv.c.resource_class_id,
|
|
),
|
|
)
|
|
query = sa.select([
|
|
rpt.c.id.label("resource_provider_id"),
|
|
rpt.c.uuid.label("resource_provider_uuid"),
|
|
inv.c.resource_class_id,
|
|
inv.c.total,
|
|
inv.c.reserved,
|
|
inv.c.allocation_ratio,
|
|
usage.c.used,
|
|
]).select_from(usage_join).where(
|
|
sa.and_(rpt.c.id.in_(rp_ids),
|
|
inv.c.resource_class_id.in_(rc_ids)))
|
|
return ctx.session.execute(query).fetchall()
|
|
|
|
|
|
@db_api.api_context_manager.reader
|
|
def _get_provider_ids_having_any_trait(ctx, traits):
|
|
"""Returns a list of resource provider internal IDs that have ANY of the
|
|
supplied traits.
|
|
|
|
:param ctx: Session context to use
|
|
:param traits: A map, keyed by trait string name, of trait internal IDs, at
|
|
least one of which each provider must have associated with
|
|
it.
|
|
:raise ValueError: If traits is empty or None.
|
|
"""
|
|
if not traits:
|
|
raise ValueError(_('traits must not be empty'))
|
|
|
|
rptt = sa.alias(_RP_TRAIT_TBL, name="rpt")
|
|
sel = sa.select([rptt.c.resource_provider_id])
|
|
sel = sel.where(rptt.c.trait_id.in_(traits.values()))
|
|
sel = sel.group_by(rptt.c.resource_provider_id)
|
|
return [r[0] for r in ctx.session.execute(sel)]
|
|
|
|
|
|
@db_api.api_context_manager.reader
|
|
def _get_provider_ids_having_all_traits(ctx, required_traits):
|
|
"""Returns a list of resource provider internal IDs that have ALL of the
|
|
required traits.
|
|
|
|
NOTE: Don't call this method with no required_traits.
|
|
|
|
:param ctx: Session context to use
|
|
:param required_traits: A map, keyed by trait string name, of required
|
|
trait internal IDs that each provider must have
|
|
associated with it
|
|
:raise ValueError: If required_traits is empty or None.
|
|
"""
|
|
if not required_traits:
|
|
raise ValueError(_('required_traits must not be empty'))
|
|
|
|
rptt = sa.alias(_RP_TRAIT_TBL, name="rpt")
|
|
sel = sa.select([rptt.c.resource_provider_id])
|
|
sel = sel.where(rptt.c.trait_id.in_(required_traits.values()))
|
|
sel = sel.group_by(rptt.c.resource_provider_id)
|
|
# Only get the resource providers that have ALL the required traits, so we
|
|
# need to GROUP BY the resource provider and ensure that the
|
|
# COUNT(trait_id) is equal to the number of traits we are requiring
|
|
num_traits = len(required_traits)
|
|
cond = sa.func.count(rptt.c.trait_id) == num_traits
|
|
sel = sel.having(cond)
|
|
return [r[0] for r in ctx.session.execute(sel)]
|
|
|
|
|
|
@db_api.api_context_manager.reader
|
|
def _has_provider_trees(ctx):
|
|
"""Simple method that returns whether provider trees (i.e. nested resource
|
|
providers) are in use in the deployment at all. This information is used to
|
|
switch code paths when attempting to retrieve allocation candidate
|
|
information. The code paths are eminently easier to execute and follow for
|
|
non-nested scenarios...
|
|
|
|
NOTE(jaypipes): The result of this function can be cached extensively.
|
|
"""
|
|
sel = sa.select([_RP_TBL.c.id])
|
|
sel = sel.where(_RP_TBL.c.parent_provider_id.isnot(None))
|
|
sel = sel.limit(1)
|
|
res = ctx.session.execute(sel).fetchall()
|
|
return len(res) > 0
|
|
|
|
|
|
@db_api.api_context_manager.reader
|
|
def _get_provider_ids_matching_all(ctx, resources, required_traits):
|
|
"""Returns a list of resource provider internal IDs that have available
|
|
inventory to satisfy all the supplied requests for resources.
|
|
|
|
:note: This function is used for scenarios that do NOT involve sharing
|
|
providers. It also only looks at individual resource providers, not
|
|
provider trees.
|
|
|
|
:param ctx: Session context to use
|
|
:param resources: A dict, keyed by resource class ID, of the amount
|
|
requested of that resource class.
|
|
:param required_traits: A map, keyed by trait string name, of required
|
|
trait internal IDs that each provider must have
|
|
associated with it
|
|
"""
|
|
trait_rps = None
|
|
if required_traits:
|
|
trait_rps = _get_provider_ids_having_all_traits(ctx, required_traits)
|
|
if not trait_rps:
|
|
return []
|
|
|
|
rpt = sa.alias(_RP_TBL, name="rp")
|
|
|
|
rc_name_map = {
|
|
rc_id: _RC_CACHE.string_from_id(rc_id).lower() for rc_id in resources
|
|
}
|
|
|
|
# Dict, keyed by resource class ID, of an aliased table object for the
|
|
# inventories table winnowed to only that resource class.
|
|
inv_tables = {
|
|
rc_id: sa.alias(_INV_TBL, name='inv_%s' % rc_name_map[rc_id])
|
|
for rc_id in resources
|
|
}
|
|
|
|
# Dict, keyed by resource class ID, of a derived table (subquery in the
|
|
# FROM clause or JOIN) against the allocations table winnowed to only that
|
|
# resource class, grouped by resource provider.
|
|
usage_tables = {
|
|
rc_id: sa.alias(
|
|
sa.select([
|
|
_ALLOC_TBL.c.resource_provider_id,
|
|
sql.func.sum(_ALLOC_TBL.c.used).label('used'),
|
|
]).where(
|
|
_ALLOC_TBL.c.resource_class_id == rc_id
|
|
).group_by(
|
|
_ALLOC_TBL.c.resource_provider_id
|
|
),
|
|
name='usage_%s' % rc_name_map[rc_id],
|
|
)
|
|
for rc_id in resources
|
|
}
|
|
|
|
sel = sa.select([rpt.c.id])
|
|
|
|
# List of the WHERE conditions we build up by iterating over the requested
|
|
# resources
|
|
where_conds = []
|
|
|
|
# First filter by the resource providers that had all the required traits
|
|
if trait_rps:
|
|
where_conds.append(rpt.c.id.in_(trait_rps))
|
|
|
|
# The chain of joins that we eventually pass to select_from()
|
|
join_chain = rpt
|
|
|
|
for rc_id, amount in resources.items():
|
|
inv_by_rc = inv_tables[rc_id]
|
|
usage_by_rc = usage_tables[rc_id]
|
|
|
|
# We can do a more efficient INNER JOIN because we don't have shared
|
|
# resource providers to deal with
|
|
rp_inv_join = sa.join(
|
|
join_chain, inv_by_rc,
|
|
sa.and_(
|
|
inv_by_rc.c.resource_provider_id == rpt.c.id,
|
|
# Add a join condition winnowing this copy of inventories table
|
|
# to only the resource class being analyzed in this loop...
|
|
inv_by_rc.c.resource_class_id == rc_id,
|
|
),
|
|
)
|
|
rp_inv_usage_join = sa.outerjoin(
|
|
rp_inv_join, usage_by_rc,
|
|
inv_by_rc.c.resource_provider_id ==
|
|
usage_by_rc.c.resource_provider_id,
|
|
)
|
|
join_chain = rp_inv_usage_join
|
|
|
|
usage_cond = sa.and_(
|
|
(
|
|
(sql.func.coalesce(usage_by_rc.c.used, 0) + amount) <=
|
|
(inv_by_rc.c.total - inv_by_rc.c.reserved) *
|
|
inv_by_rc.c.allocation_ratio
|
|
),
|
|
inv_by_rc.c.min_unit <= amount,
|
|
inv_by_rc.c.max_unit >= amount,
|
|
amount % inv_by_rc.c.step_size == 0,
|
|
)
|
|
where_conds.append(usage_cond)
|
|
|
|
sel = sel.select_from(join_chain)
|
|
sel = sel.where(sa.and_(*where_conds))
|
|
|
|
return [r[0] for r in ctx.session.execute(sel)]
|
|
|
|
|
|
@db_api.api_context_manager.reader
|
|
def _provider_aggregates(ctx, rp_ids):
|
|
"""Given a list of resource provider internal IDs, returns a dict,
|
|
keyed by those provider IDs, of sets of aggregate ids associated
|
|
with that provider.
|
|
|
|
:raises: ValueError when rp_ids is empty.
|
|
|
|
:param ctx: nova.context.RequestContext object
|
|
:param rp_ids: list of resource provider IDs
|
|
"""
|
|
if not rp_ids:
|
|
raise ValueError(_("Expected rp_ids to be a list of resource provider "
|
|
"internal IDs, but got an empty list."))
|
|
|
|
rpat = sa.alias(_RP_AGG_TBL, name='rpat')
|
|
sel = sa.select([rpat.c.resource_provider_id,
|
|
rpat.c.aggregate_id])
|
|
sel = sel.where(rpat.c.resource_provider_id.in_(rp_ids))
|
|
res = collections.defaultdict(set)
|
|
for r in ctx.session.execute(sel):
|
|
res[r[0]].add(r[1])
|
|
return res
|
|
|
|
|
|
@db_api.api_context_manager.reader
|
|
def _get_trees_matching_all_resources(ctx, resources):
|
|
"""Returns a list of root provider internal IDs for provider trees where
|
|
the nodes in the tree collectively have available inventory to satisfy all
|
|
the supplied requests for resources.
|
|
|
|
:note: This function is used for scenarios that do NOT involve sharing
|
|
providers AND where there are nested providers present in the deployment.
|
|
|
|
:param ctx: Session context to use
|
|
:param resources: A dict, keyed by resource class ID, of the amount
|
|
requested of that resource class.
|
|
"""
|
|
# Imagine a request group that contains a request for the following
|
|
# resources:
|
|
#
|
|
# * VCPU: 2
|
|
# * MEMORY_MB: 2048
|
|
# * SRIOV_NET_VF: 1
|
|
#
|
|
# The SQL we want to produce looks like this:
|
|
#
|
|
# SELECT rp.root_provider_id
|
|
# FROM resource_providers AS rp
|
|
# JOIN inventories AS inv
|
|
# ON rp.id = inv.resource_provider_id
|
|
# LEFT JOIN (
|
|
# SELECT resource_provider_id, resource_class_id, SUM(used) AS used
|
|
# FROM allocations
|
|
# WHERE resource_class_id IN ($RESOURCES)
|
|
# GROUP BY resource_provider_id, resource_class_id
|
|
# ) AS usages
|
|
# ON inv.resource_provider_id = usages.resource_provider_id
|
|
# AND inv.resource_class_id = usages.resource_class_id
|
|
# WHERE inv.resource_class_id IN ($RESOURCES) AND
|
|
# (
|
|
# inv.resource_class_id = $VCPU
|
|
# AND (((inv.total - inv.reserved) * inv.allocation_ratio) <
|
|
# (COALESCE(usage.used, 0) + $VCPU_REQUESTED))
|
|
# AND inv.min_unit >= $VCPU_REQUESTED
|
|
# AND inv.max_unit <= $VCPU_REQUESTED
|
|
# AND inv.step_size % $VCPU_REQUESTED = 0
|
|
# ) OR (
|
|
# inv.resource_class_id = $RAM
|
|
# AND (((inv.total - inv.reserved) * inv.allocation_ratio) <
|
|
# (COALESCE(usage.used, 0) + $RAM_REQUESTED))
|
|
# AND inv.min_unit >= $RAM_REQUESTED
|
|
# AND inv.max_unit <= $RAM_REQUESTED
|
|
# AND inv.step_size % $RAM_REQUESTED = 0
|
|
# ) OR (
|
|
# inv.resource_class_id = $SRIOV_NET_VF
|
|
# AND (((inv.total - inv.reserved) * inv.allocation_ratio) <
|
|
# (COALESCE(usage.used, 0) + $VF_REQUESTED))
|
|
# AND inv.min_unit >= $VF_REQUESTED
|
|
# AND inv.max_unit <= $VF_REQUESTED
|
|
# AND inv.step_size % $VF_REQUESTED = 0
|
|
# )
|
|
# GROUP BY rp.root_provider_id
|
|
# HAVING COUNT(DISTINCT inv.resource_class_id) = 3;
|
|
rpt = sa.alias(_RP_TBL, name="rp")
|
|
inv = sa.alias(_INV_TBL, name="inv")
|
|
|
|
# Derived table containing usage numbers for all resource providers for
|
|
# each resource class involved in the request
|
|
usages = sa.alias(
|
|
sa.select([
|
|
_ALLOC_TBL.c.resource_provider_id,
|
|
_ALLOC_TBL.c.resource_class_id,
|
|
sql.func.sum(_ALLOC_TBL.c.used).label('used'),
|
|
]).where(
|
|
_ALLOC_TBL.c.resource_class_id.in_(resources),
|
|
).group_by(
|
|
_ALLOC_TBL.c.resource_provider_id,
|
|
_ALLOC_TBL.c.resource_class_id
|
|
),
|
|
name='usage',
|
|
)
|
|
|
|
sel = sa.select([rpt.c.root_provider_id])
|
|
|
|
rp_inv_join = sa.join(rpt, inv, rpt.c.id == inv.c.resource_provider_id)
|
|
rp_inv_usage_join = sa.outerjoin(
|
|
rp_inv_join, usages,
|
|
sa.and_(
|
|
inv.c.resource_provider_id ==
|
|
usages.c.resource_provider_id,
|
|
inv.c.resource_class_id ==
|
|
usages.c.resource_class_id,
|
|
))
|
|
|
|
usage_conds = []
|
|
for rc_id, amount in resources.items():
|
|
usage_cond = sa.and_(
|
|
inv.c.resource_class_id == rc_id,
|
|
(
|
|
(sql.func.coalesce(usages.c.used, 0) + amount) <=
|
|
(inv.c.total - inv.c.reserved) * inv.c.allocation_ratio
|
|
),
|
|
inv.c.min_unit <= amount,
|
|
inv.c.max_unit >= amount,
|
|
amount % inv.c.step_size == 0,
|
|
)
|
|
usage_conds.append(usage_cond)
|
|
|
|
sel = sel.select_from(rp_inv_usage_join)
|
|
sel = sel.where(
|
|
sa.and_(inv.c.resource_class_id.in_(resources),
|
|
sa.or_(*usage_conds)))
|
|
sel = sel.group_by(rpt.c.root_provider_id)
|
|
sel = sel.having(
|
|
sql.func.count(
|
|
sql.func.distinct(inv.c.resource_class_id)) == len(resources))
|
|
|
|
return [r[0] for r in ctx.session.execute(sel)]
|
|
|
|
|
|
def _build_provider_summaries(context, usages, prov_traits):
|
|
"""Given a list of dicts of usage information and a map of providers to
|
|
their associated string traits, returns a dict, keyed by resource provider
|
|
ID, of ProviderSummary objects.
|
|
|
|
:param context: nova.context.RequestContext object
|
|
:param usages: A list of dicts with the following format:
|
|
|
|
{
|
|
'resource_provider_id': <internal resource provider ID>,
|
|
'resource_provider_uuid': <UUID>,
|
|
'resource_class_id': <internal resource class ID>,
|
|
'total': integer,
|
|
'reserved': integer,
|
|
'allocation_ratio': float,
|
|
}
|
|
:param prov_traits: A dict, keyed by internal resource provider ID, of
|
|
string trait names associated with that provider
|
|
"""
|
|
# Build up a dict, keyed by internal resource provider ID, of
|
|
# ProviderSummary objects containing one or more ProviderSummaryResource
|
|
# objects representing the resources the provider has inventory for.
|
|
summaries = {}
|
|
for usage in usages:
|
|
rp_id = usage['resource_provider_id']
|
|
rp_uuid = usage['resource_provider_uuid']
|
|
rc_id = usage['resource_class_id']
|
|
# NOTE(jaypipes): usage['used'] may be None due to the LEFT JOIN of
|
|
# the usages subquery, so we coerce NULL values to 0 here.
|
|
used = usage['used'] or 0
|
|
allocation_ratio = usage['allocation_ratio']
|
|
cap = int((usage['total'] - usage['reserved']) * allocation_ratio)
|
|
traits = prov_traits.get(rp_id) or []
|
|
|
|
summary = summaries.get(rp_id)
|
|
if not summary:
|
|
summary = ProviderSummary(
|
|
context,
|
|
resource_provider=ResourceProvider(
|
|
context,
|
|
uuid=rp_uuid,
|
|
),
|
|
resources=[],
|
|
)
|
|
summaries[rp_id] = summary
|
|
|
|
rc_name = _RC_CACHE.string_from_id(rc_id)
|
|
rpsr = ProviderSummaryResource(
|
|
context,
|
|
resource_class=rc_name,
|
|
capacity=cap,
|
|
used=used,
|
|
)
|
|
summary.resources.append(rpsr)
|
|
summary.traits = [Trait(context, name=tname) for tname in traits]
|
|
return summaries
|
|
|
|
|
|
def _aggregates_associated_with_providers(a, b, prov_aggs):
|
|
"""quickly check if the two rps are in the same aggregates
|
|
|
|
:param a: resource provider ID for first provider
|
|
:param b: resource provider ID for second provider
|
|
:param prov_aggs: a dict keyed by resource provider IDs, of sets
|
|
of aggregate ids associated with that provider
|
|
"""
|
|
a_aggs = prov_aggs[a]
|
|
b_aggs = prov_aggs[b]
|
|
return a_aggs & b_aggs
|
|
|
|
|
|
def _shared_allocation_request_resources(ctx, ns_rp_id, requested_resources,
|
|
sharing, summaries, prov_aggs):
|
|
"""Returns a dict, keyed by resource class ID, of lists of
|
|
AllocationRequestResource objects that represent resources that are
|
|
provided by a sharing provider.
|
|
|
|
:param ctx: nova.context.RequestContext object
|
|
:param ns_rp_id: an internal ID of a non-sharing resource provider
|
|
:param requested_resources: dict, keyed by resource class ID, of amounts
|
|
being requested for that resource class
|
|
:param sharing: dict, keyed by resource class ID, of lists of resource
|
|
provider IDs that share that resource class and can
|
|
contribute to the overall allocation request
|
|
:param summaries: dict, keyed by resource provider ID, of ProviderSummary
|
|
objects containing usage and trait information for
|
|
resource providers involved in the overall request
|
|
:param prov_aggs: dict, keyed by resource provider ID, of sets of
|
|
aggregate ids associated with that provider.
|
|
"""
|
|
res_requests = collections.defaultdict(list)
|
|
for rc_id in sharing:
|
|
for rp_id in sharing[rc_id]:
|
|
aggs_in_both = _aggregates_associated_with_providers(
|
|
ns_rp_id, rp_id, prov_aggs)
|
|
if not aggs_in_both:
|
|
continue
|
|
summary = summaries[rp_id]
|
|
rp_uuid = summary.resource_provider.uuid
|
|
res_req = AllocationRequestResource(
|
|
ctx,
|
|
resource_provider=ResourceProvider(ctx, uuid=rp_uuid),
|
|
resource_class=_RC_CACHE.string_from_id(rc_id),
|
|
amount=requested_resources[rc_id],
|
|
)
|
|
res_requests[rc_id].append(res_req)
|
|
return res_requests
|
|
|
|
|
|
def _allocation_request_for_provider(ctx, requested_resources, rp_uuid):
|
|
"""Returns an AllocationRequest object containing AllocationRequestResource
|
|
objects for each resource class in the supplied requested resources dict.
|
|
|
|
:param ctx: nova.context.RequestContext object
|
|
:param requested_resources: dict, keyed by resource class ID, of amounts
|
|
being requested for that resource class
|
|
:param rp_uuid: UUID of the resource provider supplying the resources
|
|
"""
|
|
resource_requests = [
|
|
AllocationRequestResource(
|
|
ctx, resource_provider=ResourceProvider(ctx, uuid=rp_uuid),
|
|
resource_class=_RC_CACHE.string_from_id(rc_id),
|
|
amount=amount,
|
|
) for rc_id, amount in requested_resources.items()
|
|
]
|
|
return AllocationRequest(ctx, resource_requests=resource_requests)
|
|
|
|
|
|
def _alloc_candidates_no_shared(ctx, requested_resources, rp_ids):
|
|
"""Returns a tuple of (allocation requests, provider summaries) for a
|
|
supplied set of requested resource amounts and resource providers. The
|
|
supplied resource providers have capacity to satisfy ALL of the resources
|
|
in the requested resources as well as ALL required traits that were
|
|
requested by the user.
|
|
|
|
This is an optimized code path for the common scenario when no sharing
|
|
providers exist in the system for any requested resource. In this scenario,
|
|
we can more efficiently build the list of AllocationRequest and
|
|
ProviderSummary objects due to not having to determine requests for some
|
|
shared and some non-shared resources.
|
|
|
|
:param ctx: nova.context.RequestContext object
|
|
:param requested_resources: dict, keyed by resource class ID, of amounts
|
|
being requested for that resource class
|
|
:param rp_ids: List of resource provider IDs for providers that matched the
|
|
requested resources
|
|
"""
|
|
if not rp_ids:
|
|
return [], []
|
|
# Grab usage summaries for each provider and resource class requested
|
|
requested_rc_ids = list(requested_resources)
|
|
usages = _get_usages_by_provider_and_rc(ctx, rp_ids, requested_rc_ids)
|
|
|
|
# Get a dict, keyed by resource provider internal ID, of trait string names
|
|
# that provider has associated with it
|
|
prov_traits = _provider_traits(ctx, rp_ids)
|
|
|
|
# Get a dict, keyed by resource provider internal ID, of ProviderSummary
|
|
# objects for all providers
|
|
summaries = _build_provider_summaries(ctx, usages, prov_traits)
|
|
|
|
# Next, build up a list of allocation requests. These allocation requests
|
|
# are AllocationRequest objects, containing resource provider UUIDs,
|
|
# resource class names and amounts to consume from that resource provider
|
|
alloc_requests = []
|
|
for rp_id in rp_ids:
|
|
rp_summary = summaries[rp_id]
|
|
rp_uuid = rp_summary.resource_provider.uuid
|
|
req_obj = _allocation_request_for_provider(ctx, requested_resources,
|
|
rp_uuid)
|
|
alloc_requests.append(req_obj)
|
|
return alloc_requests, list(summaries.values())
|
|
|
|
|
|
def _alloc_candidates_with_shared(ctx, requested_resources, required_traits,
|
|
ns_rp_ids, sharing):
|
|
"""Returns a tuple of (allocation requests, provider summaries) for a
|
|
supplied set of requested resource amounts and resource providers.
|
|
|
|
The allocation requests will contain resource providers that EITHER have
|
|
all the resources to satisfy each requested resource amount OR can satisfy
|
|
some of the requested resources AND are associated by aggregate to a
|
|
resource provider that shares the missing resources with it.
|
|
|
|
:param ctx: nova.context.RequestContext object
|
|
:param requested_resources: dict, keyed by resource class ID, of amounts
|
|
being requested for that resource class
|
|
:param required_traits: A map, keyed by trait string name, of required
|
|
trait internal IDs that each *allocation request's
|
|
set of providers* must *collectively* have
|
|
associated with them
|
|
:param ns_rp_ids: List of resource provider IDs for providers that EITHER
|
|
match all of the requested resources or are associated
|
|
with sharing providers that can satisfy missing requested
|
|
resources. In other words, this is the list of resource
|
|
provider IDs for all providers that are NOT sharing a
|
|
resource.
|
|
:param sharing: dict, keyed by resource class ID, of a set of resource
|
|
provider IDs that share that resource class
|
|
"""
|
|
# We need to grab usage information for all the providers identified as
|
|
# potentially fulfilling part of the resource request. This includes
|
|
# non-sharing providers returned from the call to _get_all_with_shared() as
|
|
# well as all the providers of shared resources. Here, we simply grab a
|
|
# unique set of all those resource provider internal IDs by set union'ing
|
|
# them together
|
|
all_rp_ids = set(ns_rp_ids)
|
|
for rps in sharing.values():
|
|
all_rp_ids |= set(rps)
|
|
|
|
# Short out if no providers have been found at this point.
|
|
if not all_rp_ids:
|
|
return [], []
|
|
|
|
# Grab usage summaries for each provider (local or sharing) and resource
|
|
# class requested
|
|
requested_rc_ids = list(requested_resources)
|
|
usages = _get_usages_by_provider_and_rc(ctx, all_rp_ids, requested_rc_ids)
|
|
|
|
# Get a dict, keyed by resource provider internal ID, of trait string names
|
|
# that provider has associated with it
|
|
prov_traits = _provider_traits(ctx, all_rp_ids)
|
|
|
|
# Get a dict, keyed by resource provider internal ID, of ProviderSummary
|
|
# objects for all providers involved in the request
|
|
summaries = _build_provider_summaries(ctx, usages, prov_traits)
|
|
|
|
# Next, build up a list of allocation requests. These allocation requests
|
|
# are AllocationRequest objects, containing resource provider UUIDs,
|
|
# resource class names and amounts to consume from that resource provider
|
|
alloc_requests = []
|
|
|
|
# Build a list of the sets of provider internal IDs that end up in
|
|
# allocation request objects. This is used to ensure we don't end up
|
|
# having allocation requests with duplicate sets of resource providers.
|
|
alloc_prov_ids = []
|
|
|
|
# Get a dict, keyed by resource provider internal ID, of sets of aggregate
|
|
# ids that provider has associated with it
|
|
prov_aggregates = _provider_aggregates(ctx, all_rp_ids)
|
|
|
|
for ns_rp_id in ns_rp_ids:
|
|
if ns_rp_id not in summaries:
|
|
# This resource provider is not providing any resources that have
|
|
# been requested. This means that this resource provider has some
|
|
# requested resources shared *with* it but the allocation of the
|
|
# requested resource will not be made against it. Since this
|
|
# provider won't actually have an allocation request written for
|
|
# it, we just ignore it and continue
|
|
continue
|
|
# NOTE(jaypipes): The "ns_" prefix for variables in this code block
|
|
# indicates the variable is something related to the non-sharing
|
|
# provider involved in the request
|
|
ns_rp_summary = summaries[ns_rp_id]
|
|
ns_rp_uuid = ns_rp_summary.resource_provider.uuid
|
|
ns_resource_class_names = ns_rp_summary.resource_class_names
|
|
ns_resources = set(
|
|
rc_id for rc_id in requested_resources
|
|
if _RC_CACHE.string_from_id(rc_id) in ns_resource_class_names
|
|
)
|
|
shared_resources = set(requested_resources) - ns_resources
|
|
|
|
# We need to figure out which traits are NOT provided by the "local"
|
|
# provider and that would need to be provided by the sharing
|
|
# provider(s)
|
|
ns_prov_traits = set(prov_traits.get(ns_rp_id, []))
|
|
missing_traits = set(required_traits) - ns_prov_traits
|
|
|
|
# Determine if the non-sharing provider actually has all the
|
|
# resources requested. If not, we need to add an AllocationRequest
|
|
# alternative containing this resource for each sharing provider.
|
|
# NOTE(jaypipes): If a provider has inventory for a resource class and
|
|
# ALSO has that resource class shared with it, we currently ALWAYS take
|
|
# the non-shared inventory.
|
|
# See: https://bugs.launchpad.net/nova/+bug/1724613
|
|
has_all = len(shared_resources) == 0
|
|
if has_all:
|
|
# If this resource provider has all the requested resources, then
|
|
# require that it must also have ALL required traits.
|
|
# TODO(jaypipes): This is kind of buggy behaviour. We should be
|
|
# able to consider permutations of non-sharing providers that have
|
|
# all the resources but have missing required traits with sharing
|
|
# providers that have those missing traits.
|
|
if missing_traits:
|
|
LOG.debug('Excluding non-sharing provider %s: it has all '
|
|
'resources but is missing traits (%s).',
|
|
ns_rp_uuid, ', '.join(missing_traits))
|
|
continue
|
|
req = _allocation_request_for_provider(ctx, requested_resources,
|
|
ns_rp_uuid)
|
|
alloc_requests.append(req)
|
|
continue
|
|
|
|
has_none = len(ns_resources) == 0
|
|
if has_none:
|
|
# This resource provider doesn't actually provide any requested
|
|
# resource. It only has requested resources shared *with* it.
|
|
# We do not list this provider in allocation_requests but do
|
|
# list it in provider_summaries.
|
|
continue
|
|
|
|
# Add an AllocationRequest that includes resources from the
|
|
# non-sharing provider AND shared resources from each sharing
|
|
# provider of that resource class. This is where we construct all the
|
|
# possible permutations of non-shared resources and shared resources.
|
|
ns_res_requests = [
|
|
AllocationRequestResource(
|
|
ctx, resource_provider=ResourceProvider(ctx, uuid=ns_rp_uuid),
|
|
resource_class=_RC_CACHE.string_from_id(rc_id),
|
|
amount=amount,
|
|
) for rc_id, amount in requested_resources.items()
|
|
if rc_id in ns_resources
|
|
]
|
|
|
|
# Build a dict, keyed by resource class ID, of lists of
|
|
# AllocationRequestResource objects that represent each
|
|
# resource provider for a shared resource
|
|
sharing_resource_requests = _shared_allocation_request_resources(
|
|
ctx, ns_rp_id, requested_resources,
|
|
sharing, summaries, prov_aggregates)
|
|
|
|
# A list of lists of AllocationRequestResource objects for each type of
|
|
# shared resource class
|
|
shared_request_groups = [
|
|
sharing_resource_requests[shared_rc_id]
|
|
for shared_rc_id in shared_resources
|
|
]
|
|
for shared_res_requests in itertools.product(*shared_request_groups):
|
|
# Before we add the allocation request to our list, we first need
|
|
# to ensure that the sharing providers involved in this allocation
|
|
# request have all of the traits that the non-sharing providers
|
|
# don't have
|
|
sharing_prov_ids = set()
|
|
sharing_traits = set()
|
|
for shared_res_req in shared_res_requests:
|
|
sharing_rp_uuid = shared_res_req.resource_provider.uuid
|
|
shared_rp_id = None
|
|
for rp_id, summary in summaries.items():
|
|
if summary.resource_provider.uuid == sharing_rp_uuid:
|
|
shared_rp_id = rp_id
|
|
break
|
|
sharing_prov_ids.add(shared_rp_id)
|
|
share_prov_traits = prov_traits.get(shared_rp_id, [])
|
|
sharing_traits |= set(share_prov_traits)
|
|
|
|
# Check if there are missing traits with sharing providers
|
|
still_missing_traits = missing_traits - sharing_traits
|
|
if still_missing_traits:
|
|
LOG.debug('Excluding non-sharing provider %s with sharing '
|
|
'providers %s: missing traits %s are not satisfied '
|
|
'by sharing providers.',
|
|
ns_rp_uuid, sharing_prov_ids,
|
|
','.join(still_missing_traits))
|
|
continue
|
|
|
|
# Check if we already have this combination in alloc_requests
|
|
prov_ids = set([ns_rp_id]) | sharing_prov_ids
|
|
if prov_ids in alloc_prov_ids:
|
|
continue
|
|
|
|
alloc_prov_ids.append(prov_ids)
|
|
resource_requests = ns_res_requests + list(shared_res_requests)
|
|
req = AllocationRequest(ctx, resource_requests=resource_requests)
|
|
alloc_requests.append(req)
|
|
|
|
# The process above may have removed some previously-identified resource
|
|
# providers from being included in the allocation requests due to the
|
|
# sharing providers not satisfying trait requirements that were missing
|
|
# from "local providers". So, here, we need to remove any provider
|
|
# summaries for resource providers that do not appear in any allocation
|
|
# requests.
|
|
alloc_req_rp_uuids = set()
|
|
for ar in alloc_requests:
|
|
for rr in ar.resource_requests:
|
|
alloc_req_rp_uuids.add(rr.resource_provider.uuid)
|
|
|
|
# Look up the internal ID for each identified rp UUID
|
|
alloc_req_rp_ids = set()
|
|
for rp_uuid in alloc_req_rp_uuids:
|
|
for rp_id, summary in summaries.items():
|
|
if summary.resource_provider.uuid == rp_uuid:
|
|
alloc_req_rp_ids.add(rp_id)
|
|
|
|
p_sums_ids = set(summaries)
|
|
eliminated_rp_ids = p_sums_ids - alloc_req_rp_ids
|
|
for elim_id in eliminated_rp_ids:
|
|
del summaries[elim_id]
|
|
|
|
return alloc_requests, list(summaries.values())
|
|
|
|
|
|
@db_api.api_context_manager.reader
|
|
def _provider_traits(ctx, rp_ids):
|
|
"""Given a list of resource provider internal IDs, returns a dict, keyed by
|
|
those provider IDs, of string trait names associated with that provider.
|
|
|
|
:raises: ValueError when rp_ids is empty.
|
|
|
|
:param ctx: nova.context.RequestContext object
|
|
:param rp_ids: list of resource provider IDs
|
|
"""
|
|
if not rp_ids:
|
|
raise ValueError(_("Expected rp_ids to be a list of resource provider "
|
|
"internal IDs, but got an empty list."))
|
|
|
|
rptt = sa.alias(_RP_TRAIT_TBL, name='rptt')
|
|
tt = sa.alias(_TRAIT_TBL, name='t')
|
|
j = sa.join(rptt, tt, rptt.c.trait_id == tt.c.id)
|
|
sel = sa.select([rptt.c.resource_provider_id, tt.c.name]).select_from(j)
|
|
sel = sel.where(rptt.c.resource_provider_id.in_(rp_ids))
|
|
res = collections.defaultdict(list)
|
|
for r in ctx.session.execute(sel):
|
|
res[r[0]].append(r[1])
|
|
return res
|
|
|
|
|
|
@db_api.api_context_manager.reader
|
|
def _trait_ids_from_names(ctx, names):
|
|
"""Given a list of string trait names, returns a dict, keyed by those
|
|
string names, of the corresponding internal integer trait ID.
|
|
|
|
:raises: ValueError when names is empty.
|
|
|
|
:param ctx: nova.context.RequestContext object
|
|
:param names: list of string trait names
|
|
"""
|
|
if not names:
|
|
raise ValueError(_("Expected names to be a list of string trait "
|
|
"names, but got an empty list."))
|
|
|
|
# Avoid SAWarnings about unicode types...
|
|
unames = map(six.text_type, names)
|
|
tt = sa.alias(_TRAIT_TBL, name='t')
|
|
sel = sa.select([tt.c.name, tt.c.id]).where(tt.c.name.in_(unames))
|
|
return {r[0]: r[1] for r in ctx.session.execute(sel)}
|
|
|
|
|
|
@base.NovaObjectRegistry.register_if(False)
|
|
class AllocationCandidates(base.NovaObject):
|
|
"""The AllocationCandidates object is a collection of possible allocations
|
|
that match some request for resources, along with some summary information
|
|
about the resource providers involved in these allocation candidates.
|
|
"""
|
|
|
|
fields = {
|
|
# A collection of allocation possibilities that can be attempted by the
|
|
# caller that would, at the time of calling, meet the requested
|
|
# resource constraints
|
|
'allocation_requests': fields.ListOfObjectsField('AllocationRequest'),
|
|
# Information about usage and inventory that relate to any provider
|
|
# contained in any of the AllocationRequest objects in the
|
|
# allocation_requests field
|
|
'provider_summaries': fields.ListOfObjectsField('ProviderSummary'),
|
|
}
|
|
|
|
@classmethod
|
|
def get_by_requests(cls, context, requests, limit=None):
|
|
"""Returns an AllocationCandidates object containing all resource
|
|
providers matching a set of supplied resource constraints, with a set
|
|
of allocation requests constructed from that list of resource
|
|
providers. If CONF.placement.randomize_allocation_candidates is True
|
|
(default is False) then the order of the allocation requests will
|
|
be randomized.
|
|
|
|
:param requests: List of nova.api.openstack.placement.util.RequestGroup
|
|
:param limit: An integer, N, representing the maximum number of
|
|
allocation candidates to return. If
|
|
CONF.placement.randomize_allocation_candidates is True
|
|
this will be a random sampling of N of the available
|
|
results. If False then the first N results, in whatever
|
|
order the database picked them, will be returned. In
|
|
either case if there are fewer than N total results,
|
|
all the results will be returned.
|
|
"""
|
|
_ensure_rc_cache(context)
|
|
_ensure_trait_sync(context)
|
|
alloc_reqs, provider_summaries = cls._get_by_requests(context,
|
|
requests,
|
|
limit)
|
|
return cls(
|
|
context,
|
|
allocation_requests=alloc_reqs,
|
|
provider_summaries=provider_summaries,
|
|
)
|
|
|
|
@staticmethod
|
|
@db_api.api_context_manager.reader
|
|
def _get_by_requests(context, requests, limit=None):
|
|
# We first get the list of "root providers" that either have the
|
|
# requested resources or are associated with the providers that
|
|
# share one or more of the requested resource(s)
|
|
# TODO(efried): Handle non-sharing groups.
|
|
# For now, this extracts just the sharing group's resources & traits.
|
|
sharing_groups = [request_group for request_group in requests
|
|
if not request_group.use_same_provider]
|
|
if len(sharing_groups) != 1 or not sharing_groups[0].resources:
|
|
raise ValueError(_("The requests parameter must contain one "
|
|
"RequestGroup with use_same_provider=False and "
|
|
"nonempty resources."))
|
|
|
|
# Transform resource string names to internal integer IDs
|
|
resources = {
|
|
_RC_CACHE.id_from_string(key): value
|
|
for key, value in sharing_groups[0].resources.items()
|
|
}
|
|
|
|
traits = sharing_groups[0].required_traits
|
|
# maps the trait name to the trait internal ID
|
|
trait_map = {}
|
|
if traits:
|
|
trait_map = _trait_ids_from_names(context, traits)
|
|
# Double-check that we found a trait ID for each requested name
|
|
if len(trait_map) != len(traits):
|
|
missing = traits - set(trait_map)
|
|
raise exception.TraitNotFound(names=', '.join(missing))
|
|
|
|
# Contains a set of resource provider IDs that share some inventory for
|
|
# each resource class requested. We do this here as an optimization. If
|
|
# we have no sharing providers, the SQL to find matching providers for
|
|
# the requested resources is much simpler.
|
|
# TODO(jaypipes): Consider caching this for some amount of time since
|
|
# sharing providers generally don't change often and here we aren't
|
|
# concerned with how *much* inventory/capacity the sharing provider
|
|
# has, only that it is sharing *some* inventory of a particular
|
|
# resource class.
|
|
sharing_providers = {
|
|
rc_id: _get_providers_with_shared_capacity(context, rc_id, amount)
|
|
for rc_id, amount in resources.items()
|
|
}
|
|
have_sharing = any(sharing_providers.values())
|
|
if not have_sharing:
|
|
# We know there's no sharing providers, so we can more efficiently
|
|
# get a list of resource provider IDs that have ALL the requested
|
|
# resources and more efficiently construct the allocation requests
|
|
# NOTE(jaypipes): When we start handling nested providers, we may
|
|
# add new code paths or modify this code path to return root
|
|
# provider IDs of provider trees instead of the resource provider
|
|
# IDs.
|
|
rp_ids = _get_provider_ids_matching_all(context, resources,
|
|
trait_map)
|
|
alloc_request_objs, summary_objs = _alloc_candidates_no_shared(
|
|
context, resources, rp_ids)
|
|
else:
|
|
if trait_map:
|
|
trait_rps = _get_provider_ids_having_any_trait(context,
|
|
trait_map)
|
|
if not trait_rps:
|
|
# If there aren't any providers that have any of the
|
|
# required traits, just exit early...
|
|
return [], []
|
|
|
|
# rp_ids contains a list of resource provider IDs that EITHER have
|
|
# all the requested resources themselves OR have some resources
|
|
# and are related to a provider that is sharing some resources
|
|
# with it. In other words, this is the list of resource provider
|
|
# IDs that are NOT sharing resources.
|
|
rps = _get_all_with_shared(context, resources)
|
|
rp_ids = set([r[0] for r in rps])
|
|
alloc_request_objs, summary_objs = _alloc_candidates_with_shared(
|
|
context, resources, trait_map, rp_ids, sharing_providers)
|
|
|
|
# Limit the number of allocation request objects. We do this after
|
|
# creating all of them so that we can do a random slice without
|
|
# needing to mess with the complex sql above or add additional
|
|
# columns to the DB.
|
|
|
|
# Track the resource provider uuids that we have chosen so that
|
|
# we can pull out their summaries below.
|
|
alloc_req_rp_uuids = set()
|
|
if limit and limit <= len(alloc_request_objs):
|
|
if CONF.placement.randomize_allocation_candidates:
|
|
alloc_request_objs = random.sample(alloc_request_objs, limit)
|
|
else:
|
|
alloc_request_objs = alloc_request_objs[:limit]
|
|
# Extract resource provider uuids from the resource requests.
|
|
for aro in alloc_request_objs:
|
|
for arr in aro.resource_requests:
|
|
alloc_req_rp_uuids.add(arr.resource_provider.uuid)
|
|
elif CONF.placement.randomize_allocation_candidates:
|
|
random.shuffle(alloc_request_objs)
|
|
|
|
# Limit summaries to only those mentioned in the allocation requests.
|
|
if limit and limit <= len(alloc_request_objs):
|
|
kept_summary_objs = []
|
|
for summary in summary_objs:
|
|
rp_uuid = summary.resource_provider.uuid
|
|
# Skip a summary if we are limiting and haven't selected an
|
|
# allocation request that uses the resource provider.
|
|
if rp_uuid not in alloc_req_rp_uuids:
|
|
continue
|
|
kept_summary_objs.append(summary)
|
|
else:
|
|
kept_summary_objs = summary_objs
|
|
|
|
return alloc_request_objs, kept_summary_objs
|