OpenStack Networking (Neutron)
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

162 lines
6.9 KiB

# Copyright 2013 VMware, Inc. 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
# 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
from neutron_lib.api.definitions import allowedaddresspairs as addr_apidef
from neutron_lib.api.definitions import port as port_def
from neutron_lib.api import validators
from neutron_lib.db import api as db_api
from neutron_lib.db import resource_extend
from neutron_lib.db import utils as db_utils
from neutron_lib.exceptions import allowedaddresspairs as addr_exc
from neutron_lib.objects import exceptions
from neutron_lib.utils import net as net_utils
from neutron.objects.port.extensions import (allowedaddresspairs
as obj_addr_pair)
class AllowedAddressPairsMixin(object):
"""Mixin class for allowed address pairs."""
def _process_create_allowed_address_pairs(self, context, port,
if not validators.is_attr_set(allowed_address_pairs):
return []
with db_api.CONTEXT_WRITER.using(context):
for address_pair in allowed_address_pairs:
# use port.mac_address if no mac address in address pair
if 'mac_address' not in address_pair:
address_pair['mac_address'] = port['mac_address']
# retain string format as passed through API
mac_address = net_utils.AuthenticEUI(
ip_address = net_utils.AuthenticIPNetwork(
pair_obj = obj_addr_pair.AllowedAddressPair(
except exceptions.NeutronDbObjectDuplicateEntry:
raise addr_exc.DuplicateAddressPairInRequest(
return allowed_address_pairs
def get_allowed_address_pairs(self, context, port_id):
pairs = obj_addr_pair.AllowedAddressPair.get_objects(
context, port_id=port_id)
return [self._make_allowed_address_pairs_dict(pair.db_obj)
for pair in pairs]
def get_allowed_address_pairs_for_ports(self, context, port_ids):
pairs = (
context, port_ids=port_ids))
result = collections.defaultdict(list)
for pair in pairs:
return result
def _extend_port_dict_allowed_address_pairs(port_res, port_db):
# If port_db is provided, allowed address pairs will be accessed via
# sqlalchemy models. As they're loaded together with ports this
# will not cause an extra query.
allowed_address_pairs = [
address_pair) for
address_pair in port_db.allowed_address_pairs]
port_res[addr_apidef.ADDRESS_PAIRS] = allowed_address_pairs
return port_res
def _delete_allowed_address_pairs(self, context, id):
context, port_id=id)
def _make_allowed_address_pairs_dict(allowed_address_pairs,
res = {'mac_address': allowed_address_pairs['mac_address'],
'ip_address': allowed_address_pairs['ip_address']}
return db_utils.resource_fields(res, fields)
def _has_address_pairs(self, port):
return (validators.is_attr_set(
port['port'][addr_apidef.ADDRESS_PAIRS]) and
port['port'][addr_apidef.ADDRESS_PAIRS] != [])
def _check_update_has_allowed_address_pairs(self, port):
"""Determine if request has an allowed address pair.
Return True if the port parameter has a non-empty
'allowed_address_pairs' attribute. Otherwise returns False.
return (addr_apidef.ADDRESS_PAIRS in port['port'] and
def _check_update_deletes_allowed_address_pairs(self, port):
"""Determine if request deletes address pair.
Return True if port has an allowed address pair and its value
is either [] or not is_attr_set, otherwise return False
return (addr_apidef.ADDRESS_PAIRS in port['port'] and
not self._has_address_pairs(port))
def is_address_pairs_attribute_updated(self, port, update_attrs):
"""Check if the address pairs attribute is being updated.
Returns True if there is an update. This can be used to decide
if a port update notification should be sent to agents or third
party controllers.
new_pairs = update_attrs.get(addr_apidef.ADDRESS_PAIRS)
if new_pairs is None:
return False
old_pairs = port.get(addr_apidef.ADDRESS_PAIRS)
# Missing or unchanged address pairs in attributes mean no update
return new_pairs != old_pairs
def update_address_pairs_on_port(self, context, port_id, port,
original_port, updated_port):
"""Update allowed address pairs on port.
Returns True if an update notification is required. Notification
is not done here because other changes on the port may need
notification. This method is expected to be called within
a transaction.
new_pairs = port['port'].get(addr_apidef.ADDRESS_PAIRS)
if self.is_address_pairs_attribute_updated(original_port,
updated_port[addr_apidef.ADDRESS_PAIRS] = new_pairs
self._delete_allowed_address_pairs(context, port_id)
context, updated_port, new_pairs)
return True
return False