240 lines
9.1 KiB
Python
240 lines
9.1 KiB
Python
# Copyright (c) 2015 OpenStack Foundation. All rights reserved.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
# not use this file except in compliance with the License. You may obtain
|
|
# a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations
|
|
# under the License.
|
|
|
|
import collections
|
|
import datetime
|
|
|
|
from neutron_lib.db import api as lib_db_api
|
|
|
|
from neutron.db import api as db_api
|
|
from neutron.objects import quota as quota_obj
|
|
|
|
|
|
# Wrapper for utcnow - needed for mocking it in unit tests
|
|
def utcnow():
|
|
return datetime.datetime.utcnow()
|
|
|
|
|
|
class QuotaUsageInfo(collections.namedtuple(
|
|
'QuotaUsageInfo', ['resource', 'tenant_id', 'used', 'dirty'])):
|
|
"""Information about resource quota usage."""
|
|
|
|
|
|
class ReservationInfo(collections.namedtuple(
|
|
'ReservationInfo', ['reservation_id', 'tenant_id',
|
|
'expiration', 'deltas'])):
|
|
"""Information about a resource reservation."""
|
|
|
|
|
|
@lib_db_api.retry_if_session_inactive()
|
|
def get_quota_usage_by_resource_and_tenant(context, resource, tenant_id):
|
|
"""Return usage info for a given resource and tenant.
|
|
|
|
:param context: Request context
|
|
:param resource: Name of the resource
|
|
:param tenant_id: Tenant identifier
|
|
:returns: a QuotaUsageInfo instance
|
|
"""
|
|
|
|
result = quota_obj.QuotaUsage.get_object_dirty_protected(
|
|
context, resource=resource, project_id=tenant_id)
|
|
if not result:
|
|
return
|
|
return QuotaUsageInfo(result.resource, result.project_id, result.in_use,
|
|
result.dirty)
|
|
|
|
|
|
@lib_db_api.retry_if_session_inactive()
|
|
def get_quota_usage_by_resource(context, resource):
|
|
objs = quota_obj.QuotaUsage.get_objects(context, resource=resource)
|
|
return [QuotaUsageInfo(item.resource,
|
|
item.project_id,
|
|
item.in_use,
|
|
item.dirty) for item in objs]
|
|
|
|
|
|
@lib_db_api.retry_if_session_inactive()
|
|
def get_quota_usage_by_tenant_id(context, tenant_id):
|
|
objs = quota_obj.QuotaUsage.get_objects(context, project_id=tenant_id)
|
|
return [QuotaUsageInfo(item.resource,
|
|
tenant_id,
|
|
item.in_use,
|
|
item.dirty) for item in objs]
|
|
|
|
|
|
@lib_db_api.retry_if_session_inactive()
|
|
def set_quota_usage(context, resource, tenant_id,
|
|
in_use=None, delta=False):
|
|
"""Set resource quota usage.
|
|
|
|
:param context: instance of neutron context with db session
|
|
:param resource: name of the resource for which usage is being set
|
|
:param tenant_id: identifier of the tenant for which quota usage is
|
|
being set
|
|
:param in_use: integer specifying the new quantity of used resources,
|
|
or a delta to apply to current used resource
|
|
:param delta: Specifies whether in_use is an absolute number
|
|
or a delta (default to False)
|
|
"""
|
|
with db_api.context_manager.writer.using(context):
|
|
usage_data = quota_obj.QuotaUsage.get_object(
|
|
context, resource=resource, project_id=tenant_id)
|
|
if not usage_data:
|
|
# Must create entry
|
|
usage_data = quota_obj.QuotaUsage(
|
|
context, resource=resource, project_id=tenant_id)
|
|
usage_data.create()
|
|
# Perform explicit comparison with None as 0 is a valid value
|
|
if in_use is not None:
|
|
if delta:
|
|
in_use = usage_data.in_use + in_use
|
|
usage_data.in_use = in_use
|
|
# After an explicit update the dirty bit should always be reset
|
|
usage_data.dirty = False
|
|
usage_data.update()
|
|
return QuotaUsageInfo(usage_data.resource, usage_data.project_id,
|
|
usage_data.in_use, usage_data.dirty)
|
|
|
|
|
|
@lib_db_api.retry_if_session_inactive()
|
|
@db_api.context_manager.writer
|
|
def set_quota_usage_dirty(context, resource, tenant_id, dirty=True):
|
|
"""Set quota usage dirty bit for a given resource and tenant.
|
|
|
|
:param resource: a resource for which quota usage if tracked
|
|
:param tenant_id: tenant identifier
|
|
:param dirty: the desired value for the dirty bit (defaults to True)
|
|
:returns: 1 if the quota usage data were updated, 0 otherwise.
|
|
"""
|
|
obj = quota_obj.QuotaUsage.get_object(
|
|
context, resource=resource, project_id=tenant_id)
|
|
if obj:
|
|
obj.dirty = dirty
|
|
obj.update()
|
|
return 1
|
|
return 0
|
|
|
|
|
|
@lib_db_api.retry_if_session_inactive()
|
|
@db_api.context_manager.writer
|
|
def set_resources_quota_usage_dirty(context, resources, tenant_id, dirty=True):
|
|
"""Set quota usage dirty bit for a given tenant and multiple resources.
|
|
|
|
:param resources: list of resource for which the dirty bit is going
|
|
to be set
|
|
:param tenant_id: tenant identifier
|
|
:param dirty: the desired value for the dirty bit (defaults to True)
|
|
:returns: the number of records for which the bit was actually set.
|
|
"""
|
|
filters = {'project_id': tenant_id}
|
|
if resources:
|
|
filters['resource'] = resources
|
|
objs = quota_obj.QuotaUsage.get_objects(context, **filters)
|
|
for obj in objs:
|
|
obj.dirty = dirty
|
|
obj.update()
|
|
return len(objs)
|
|
|
|
|
|
@lib_db_api.retry_if_session_inactive()
|
|
@db_api.context_manager.writer
|
|
def set_all_quota_usage_dirty(context, resource, dirty=True):
|
|
"""Set the dirty bit on quota usage for all tenants.
|
|
|
|
:param resource: the resource for which the dirty bit should be set
|
|
:returns: the number of tenants for which the dirty bit was
|
|
actually updated
|
|
"""
|
|
# TODO(manjeets) consider squashing this method with
|
|
# set_resources_quota_usage_dirty
|
|
objs = quota_obj.QuotaUsage.get_objects(context, resource=resource)
|
|
for obj in objs:
|
|
obj.dirty = dirty
|
|
obj.update()
|
|
return len(objs)
|
|
|
|
|
|
@lib_db_api.retry_if_session_inactive()
|
|
def create_reservation(context, tenant_id, deltas, expiration=None):
|
|
# This method is usually called from within another transaction.
|
|
# Consider using begin_nested
|
|
expiration = expiration or (utcnow() + datetime.timedelta(0, 120))
|
|
delta_objs = []
|
|
for (resource, delta) in deltas.items():
|
|
delta_objs.append(quota_obj.ResourceDelta(
|
|
context, resource=resource, amount=delta))
|
|
reserv_obj = quota_obj.Reservation(
|
|
context, project_id=tenant_id, expiration=expiration,
|
|
resource_deltas=delta_objs)
|
|
reserv_obj.create()
|
|
return ReservationInfo(reserv_obj['id'],
|
|
reserv_obj['project_id'],
|
|
reserv_obj['expiration'],
|
|
dict((delta.resource, delta.amount)
|
|
for delta in reserv_obj.resource_deltas))
|
|
|
|
|
|
@lib_db_api.retry_if_session_inactive()
|
|
def get_reservation(context, reservation_id):
|
|
reserv_obj = quota_obj.Reservation.get_object(context, id=reservation_id)
|
|
if not reserv_obj:
|
|
return
|
|
return ReservationInfo(reserv_obj['id'],
|
|
reserv_obj['project_id'],
|
|
reserv_obj['expiration'],
|
|
dict((delta.resource, delta.amount)
|
|
for delta in reserv_obj.resource_deltas))
|
|
|
|
|
|
@lib_db_api.retry_if_session_inactive()
|
|
@db_api.context_manager.writer
|
|
def remove_reservation(context, reservation_id, set_dirty=False):
|
|
reservation = quota_obj.Reservation.get_object(context, id=reservation_id)
|
|
if not reservation:
|
|
# TODO(salv-orlando): Raise here and then handle the exception?
|
|
return
|
|
tenant_id = reservation.project_id
|
|
resources = [delta.resource for delta in reservation.resource_deltas]
|
|
reservation.delete()
|
|
if set_dirty:
|
|
# quota_usage for all resource involved in this reservation must
|
|
# be marked as dirty
|
|
set_resources_quota_usage_dirty(context, resources, tenant_id)
|
|
return 1
|
|
|
|
|
|
@lib_db_api.retry_if_session_inactive()
|
|
def get_reservations_for_resources(context, tenant_id, resources,
|
|
expired=False):
|
|
"""Retrieve total amount of reservations for specified resources.
|
|
|
|
:param context: Neutron context with db session
|
|
:param tenant_id: Tenant identifier
|
|
:param resources: Resources for which reserved amounts should be fetched
|
|
:param expired: False to fetch active reservations, True to fetch expired
|
|
reservations (defaults to False)
|
|
:returns: a dictionary mapping resources with corresponding deltas
|
|
"""
|
|
# NOTE(manjeets) we are using utcnow() here because it
|
|
# can be mocked easily where as datetime is built in type
|
|
# mock.path does not allow mocking built in types.
|
|
return quota_obj.Reservation.get_total_reservations_map(
|
|
context, utcnow(), tenant_id, resources, expired)
|
|
|
|
|
|
@lib_db_api.retry_if_session_inactive()
|
|
@db_api.context_manager.writer
|
|
def remove_expired_reservations(context, tenant_id=None):
|
|
return quota_obj.Reservation.delete_expired(context, utcnow(), tenant_id)
|