text: # Copyright (c) 2014 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
  
  from oslo_config import cfg
  from oslo_log import log as logging
  from oslo_utils import excutils
  import six
  
  from neutron._i18n import _, _LI, _LW
  from neutron.api.v2 import attributes
  from neutron.callbacks import events
  from neutron.callbacks import exceptions
  from neutron.callbacks import registry
  from neutron.callbacks import resources
  from neutron.common import constants as l3_const
  from neutron.common import exceptions as n_exc
  from neutron.common import utils as n_utils
  from neutron.db import l3_attrs_db
  from neutron.db import l3_db
  from neutron.db import l3_dvrscheduler_db as l3_dvrsched_db
  from neutron.db import models_v2
  from neutron.extensions import l3
  from neutron.extensions import portbindings
  from neutron import manager
  from neutron.plugins.common import constants
  from neutron.plugins.common import utils as p_utils
  
  
  LOG = logging.getLogger(__name__)
  router_distributed_opts = [
      cfg.BoolOpt('router_distributed',
                  default=False,
                  help=_("System-wide flag to determine the type of router "
                         "that tenants can create. Only admin can override.")),
  ]
  cfg.CONF.register_opts(router_distributed_opts)
  
  
  class L3_NAT_with_dvr_db_mixin(l3_db.L3_NAT_db_mixin,
                                 l3_attrs_db.ExtraAttributesMixin):
      """Mixin class to enable DVR support."""
  
      router_device_owners = (
          l3_db.L3_NAT_db_mixin.router_device_owners +
          (l3_const.DEVICE_OWNER_DVR_INTERFACE,
           l3_const.DEVICE_OWNER_ROUTER_SNAT,
           l3_const.DEVICE_OWNER_AGENT_GW))
  
      extra_attributes = (
          l3_attrs_db.ExtraAttributesMixin.extra_attributes + [{
              'name': "distributed",
              'default': cfg.CONF.router_distributed
          }])
  
      def _create_router_db(self, context, router, tenant_id):
          """Create a router db object with dvr additions."""
          router['distributed'] = is_distributed_router(router)
          with context.session.begin(subtransactions=True):
              router_db = super(
                  L3_NAT_with_dvr_db_mixin, self)._create_router_db(
                      context, router, tenant_id)
              self._process_extra_attr_router_create(context, router_db, router)
              return router_db
  
      def _validate_router_migration(self, context, router_db, router_res):
          """Allow centralized -> distributed state transition only."""
          if (router_db.extra_attributes.distributed and
              router_res.get('distributed') is False):
              LOG.info(_LI("Centralizing distributed router %s "
                           "is not supported"), router_db['id'])
              raise n_exc.BadRequest(
                  resource='router',
                  msg=_("Migration from distributed router to centralized is "
                        "not supported"))
          elif (not router_db.extra_attributes.distributed and
                router_res.get('distributed')):
              # router should be disabled in order for upgrade
              if router_db.admin_state_up:
                  msg = _('Cannot upgrade active router to distributed. Please '
                          'set router admin_state_up to False prior to upgrade.')
                  raise n_exc.BadRequest(resource='router', msg=msg)
  
              # Notify advanced services of the imminent state transition
              # for the router.
              try:
                  kwargs = {'context': context, 'router': router_db}
                  registry.notify(
                      resources.ROUTER, events.BEFORE_UPDATE, self, **kwargs)
              except exceptions.CallbackFailure as e:
                  with excutils.save_and_reraise_exception():
                      # NOTE(armax): preserve old check's behavior
                      if len(e.errors) == 1:
                          raise e.errors[0].error
                      raise l3.RouterInUse(router_id=router_db['id'],
                                           reason=e)
  
      def _update_distributed_attr(
          self, context, router_id, router_db, data):
          """Update the model to support the dvr case of a router."""
          if data.get('distributed'):
              old_owner = l3_const.DEVICE_OWNER_ROUTER_INTF
              new_owner = l3_const.DEVICE_OWNER_DVR_INTERFACE
              for rp in router_db.attached_ports.filter_by(port_type=old_owner):
                  rp.port_type = new_owner
                  rp.port.device_owner = new_owner
  
      def _update_router_db(self, context, router_id, data):
          with context.session.begin(subtransactions=True):
              router_db = super(
                  L3_NAT_with_dvr_db_mixin, self)._update_router_db(
                      context, router_id, data)
              migrating_to_distributed = (
                  not router_db.extra_attributes.distributed and
                  data.get('distributed') is True)
              self._validate_router_migration(context, router_db, data)
              router_db.extra_attributes.update(data)
              self._update_distributed_attr(
                  context, router_id, router_db, data)
              if migrating_to_distributed:
                  if router_db['gw_port_id']:
                      # If the Legacy router is getting migrated to a DVR
                      # router, make sure to create corresponding
                      # snat interface ports that are to be consumed by
                      # the Service Node.
                      if not self._create_snat_intf_ports_if_not_exists(
                          context.elevated(), router_db):
                          LOG.debug("SNAT interface ports not created: %s",
                                    router_db['id'])
                  cur_agents = self.list_l3_agents_hosting_router(
                      context, router_db['id'])['agents']
                  for agent in cur_agents:
                      self._unbind_router(context, router_db['id'],
                                          agent['id'])
              return router_db
  
      def _delete_current_gw_port(self, context, router_id, router, new_network):
          """
          Overriden here to handle deletion of dvr internal ports.
  
          If there is a valid router update with gateway port to be deleted,
          then go ahead and delete the csnat ports and the floatingip
          agent gateway port associated with the dvr router.
          """
  
          gw_ext_net_id = (
              router.gw_port['network_id'] if router.gw_port else None)
  
          super(L3_NAT_with_dvr_db_mixin,
                self)._delete_current_gw_port(context, router_id,
                                              router, new_network)
          if (is_distributed_router(router) and
              gw_ext_net_id != new_network and gw_ext_net_id is not None):
              self.delete_csnat_router_interface_ports(
                  context.elevated(), router)
              # NOTE(Swami): Delete the Floatingip agent gateway port
              # on all hosts when it is the last gateway port in the
              # given external network.
              filters = {'network_id': [gw_ext_net_id],
                         'device_owner': [l3_const.DEVICE_OWNER_ROUTER_GW]}
              ext_net_gw_ports = self._core_plugin.get_ports(
                  context.elevated(), filters)
              if not ext_net_gw_ports:
                  self.delete_floatingip_agent_gateway_port(
                      context.elevated(), None, gw_ext_net_id)
                  # Send the information to all the L3 Agent hosts
                  # to clean up the fip namespace as it is no longer required.
                  self.l3_rpc_notifier.delete_fipnamespace_for_ext_net(
                      context, gw_ext_net_id)
  
      def _create_gw_port(self, context, router_id, router, new_network,
                          ext_ips):
          super(L3_NAT_with_dvr_db_mixin,
                self)._create_gw_port(context, router_id, router, new_network,
                                      ext_ips)
          # Make sure that the gateway port exists before creating the
          # snat interface ports for distributed router.
          if router.extra_attributes.distributed and router.gw_port:
              snat_p_list = self._create_snat_intf_ports_if_not_exists(
                  context.elevated(), router)
              if not snat_p_list:
                  LOG.debug("SNAT interface ports not created: %s", snat_p_list)
  
      def _get_device_owner(self, context, router=None):
          """Get device_owner for the specified router."""
          router_is_uuid = isinstance(router, six.string_types)
          if router_is_uuid:
              router = self._get_router(context, router)
          if is_distributed_router(router):
              return l3_const.DEVICE_OWNER_DVR_INTERFACE
          return super(L3_NAT_with_dvr_db_mixin,
                       self)._get_device_owner(context, router)
  
      def _get_interface_ports_for_network(self, context, network_id):
          router_intf_qry = context.session.query(l3_db.RouterPort)
          router_intf_qry = router_intf_qry.join(models_v2.Port)
  
          return router_intf_qry.filter(
              models_v2.Port.network_id == network_id,
              l3_db.RouterPort.port_type.in_(l3_const.ROUTER_INTERFACE_OWNERS)
          )
  
      def _update_fip_assoc(self, context, fip, floatingip_db, external_port):
          """Override to create floating agent gw port for DVR.
  
          Floating IP Agent gateway port will be created when a
          floatingIP association happens.
          """
          fip_port = fip.get('port_id')
          super(L3_NAT_with_dvr_db_mixin, self)._update_fip_assoc(
              context, fip, floatingip_db, external_port)
          associate_fip = fip_port and floatingip_db['id']
          if associate_fip and floatingip_db.get('router_id'):
              admin_ctx = context.elevated()
              router_dict = self.get_router(
                  admin_ctx, floatingip_db['router_id'])
              # Check if distributed router and then create the
              # FloatingIP agent gateway port
              if router_dict.get('distributed'):
                  vm_hostid = self._get_vm_port_hostid(
                      context, fip_port)
                  if vm_hostid:
                      # FIXME (Swami): This FIP Agent Gateway port should be
                      # created only once and there should not be a duplicate
                      # for the same host. Until we find a good solution for
                      # augmenting multiple server requests we should use the
                      # existing flow.
                      fip_agent_port = (
                          self.create_fip_agent_gw_port_if_not_exists(
                              admin_ctx, external_port['network_id'],
                              vm_hostid))
                      LOG.debug("FIP Agent gateway port: %s", fip_agent_port)
  
      def _get_floatingip_on_port(self, context, port_id=None):
          """Helper function to retrieve the fip associated with port."""
          fip_qry = context.session.query(l3_db.FloatingIP)
          floating_ip = fip_qry.filter_by(fixed_port_id=port_id)
          return floating_ip.first()
  
      def add_router_interface(self, context, router_id, interface_info):
          add_by_port, add_by_sub = self._validate_interface_info(interface_info)
          router = self._get_router(context, router_id)
          device_owner = self._get_device_owner(context, router)
  
          # This should be True unless adding an IPv6 prefix to an existing port
          new_port = True
  
          if add_by_port:
              port, subnets = self._add_interface_by_port(
                      context, router, interface_info['port_id'], device_owner)
          elif add_by_sub:
              port, subnets, new_port = self._add_interface_by_subnet(
                      context, router, interface_info['subnet_id'], device_owner)
  
          subnet = subnets[0]
  
          if new_port:
              if router.extra_attributes.distributed and router.gw_port:
                  try:
                      admin_context = context.elevated()
                      self._add_csnat_router_interface_port(
                          admin_context, router, port['network_id'],
                          port['fixed_ips'][-1]['subnet_id'])
                  except Exception:
                      with excutils.save_and_reraise_exception():
                          # we need to preserve the original state prior
                          # the request by rolling back the port creation
                          # that led to new_port=True
                          self._core_plugin.delete_port(
                              admin_context, port['id'])
  
              with context.session.begin(subtransactions=True):
                  router_port = l3_db.RouterPort(
                      port_id=port['id'],
                      router_id=router.id,
                      port_type=device_owner
                  )
                  context.session.add(router_port)
  
          # NOTE: For IPv6 additional subnets added to the same
          # network we need to update the CSNAT port with respective
          # IPv6 subnet
          elif subnet and port:
              fixed_ip = {'subnet_id': subnet['id']}
              if subnet['ip_version'] == 6:
                  # Add new prefix to an existing ipv6 csnat port with the
                  # same network id if one exists
                  cs_port = self._find_router_port_by_network_and_device_owner(
                      router, subnet['network_id'],
                      l3_const.DEVICE_OWNER_ROUTER_SNAT)
                  if cs_port:
                      fixed_ips = list(cs_port['port']['fixed_ips'])
                      fixed_ips.append(fixed_ip)
                      updated_port = self._core_plugin.update_port(
                          context.elevated(),
                          cs_port['port_id'], {'port': {'fixed_ips': fixed_ips}})
                      LOG.debug("CSNAT port updated for IPv6 subnet: "
                                "%s", updated_port)
          router_interface_info = self._make_router_interface_info(
              router_id, port['tenant_id'], port['id'], subnet['id'],
              [subnet['id']])
          self.notify_router_interface_action(
              context, router_interface_info, 'add')
          return router_interface_info
  
      def _port_has_ipv6_address(self, port, csnat_port_check=True):
          """Overridden to return False if DVR SNAT port."""
          if csnat_port_check:
              if port['device_owner'] == l3_const.DEVICE_OWNER_ROUTER_SNAT:
                  return False
          return super(L3_NAT_with_dvr_db_mixin,
                       self)._port_has_ipv6_address(port)
  
      def _find_router_port_by_network_and_device_owner(
          self, router, net_id, device_owner):
          for port in router.attached_ports:
              p = port['port']
              if (p['network_id'] == net_id and
                  p['device_owner'] == device_owner and
                  self._port_has_ipv6_address(p, csnat_port_check=False)):
                  return port
  
      def _check_for_multiprefix_csnat_port_and_update(
          self, context, router, subnet, port):
          """Checks if the csnat port contains multiple ipv6 prefixes.
  
          If the csnat port contains multiple ipv6 prefixes for the given
          network when a router interface is deleted, make sure we don't
          delete the port when a single subnet is deleted and just update
          it with the right fixed_ip.
          This function returns true if it is a multiprefix port.
          """
          subnet_id = subnet['id']
          if router.gw_port:
              # If router has a gateway port, check if it has IPV6 subnet
              cs_port = (
                  self._find_router_port_by_network_and_device_owner(
                      router, subnet['network_id'],
                      l3_const.DEVICE_OWNER_ROUTER_SNAT))
              if cs_port:
                  fixed_ips = (
                      [fixedip for fixedip in
                          cs_port['port']['fixed_ips']
                          if fixedip['subnet_id'] != subnet_id])
                  if fixed_ips:
                      # multiple prefix port - delete prefix from port
                      self._core_plugin.update_port(
                          context.elevated(),
                          cs_port['port_id'], {'port': {'fixed_ips': fixed_ips}})
                      return True
          return False
  
      def _check_dvr_router_remove_required_and_notify_agent(
          self, context, router, port, subnet):
          if router.extra_attributes.distributed:
              is_multiple_prefix_csport = (
                  self._check_for_multiprefix_csnat_port_and_update(
                      context, router, subnet, port))
              if not is_multiple_prefix_csport:
                  # Single prefix port - go ahead and delete the port
                  self.delete_csnat_router_interface_ports(
                      context.elevated(), router, subnet_id=subnet['id'])
              plugin = manager.NeutronManager.get_service_plugins().get(
                          constants.L3_ROUTER_NAT)
              l3_agents = plugin.get_l3_agents_hosting_routers(context,
                                                               [router['id']])
              subnet_ids = plugin.get_subnet_ids_on_router(
                  context, router['id'])
              if subnet_ids:
                  for l3_agent in l3_agents:
                      if not plugin.check_ports_exist_on_l3agent(
                          context, l3_agent, subnet_ids):
                          plugin.remove_router_from_l3_agent(
                              context, l3_agent['id'], router['id'])
          router_interface_info = self._make_router_interface_info(
              router['id'], port['tenant_id'], port['id'], subnet['id'],
              [subnet['id']])
          self.notify_router_interface_action(
              context, router_interface_info, 'remove')
          return router_interface_info
  
      def remove_router_interface(self, context, router_id, interface_info):
          remove_by_port, remove_by_subnet = (
              self._validate_interface_info(interface_info, for_removal=True)
          )
          port_id = interface_info.get('port_id')
          subnet_id = interface_info.get('subnet_id')
          router = self._get_router(context, router_id)
          device_owner = self._get_device_owner(context, router)
  
          if remove_by_port:
              port, subnets = self._remove_interface_by_port(
                      context, router_id, port_id, subnet_id, device_owner)
  
          # remove_by_subnet is not used here, because the validation logic of
          # _validate_interface_info ensures that at least one of remote_by_*
          # is True.
          else:
              port, subnets = self._remove_interface_by_subnet(
                      context, router_id, subnet_id, device_owner)
  
          subnet = subnets[0]
          router_interface_info = (
              self._check_dvr_router_remove_required_and_notify_agent(
                  context, router, port, subnet))
          return router_interface_info
  
      def _get_snat_sync_interfaces(self, context, router_ids):
          """Query router interfaces that relate to list of router_ids."""
          if not router_ids:
              return []
          qry = context.session.query(l3_db.RouterPort)
          qry = qry.filter(
              l3_db.RouterPort.router_id.in_(router_ids),
              l3_db.RouterPort.port_type == l3_const.DEVICE_OWNER_ROUTER_SNAT
          )
          interfaces = collections.defaultdict(list)
          for rp in qry:
              interfaces[rp.router_id].append(
                  self._core_plugin._make_port_dict(rp.port, None))
          LOG.debug("Return the SNAT ports: %s", interfaces)
          return interfaces
  
      def _build_routers_list(self, context, routers, gw_ports):
          # Perform a single query up front for all routers
          if not routers:
              return []
          router_ids = [r['id'] for r in routers]
          snat_binding = l3_dvrsched_db.CentralizedSnatL3AgentBinding
          query = (context.session.query(snat_binding).
                   filter(snat_binding.router_id.in_(router_ids))).all()
          bindings = dict((b.router_id, b) for b in query)
  
          for rtr in routers:
              gw_port_id = rtr['gw_port_id']
              # Collect gw ports only if available
              if gw_port_id and gw_ports.get(gw_port_id):
                  rtr['gw_port'] = gw_ports[gw_port_id]
                  if 'enable_snat' in rtr[l3.EXTERNAL_GW_INFO]:
                      rtr['enable_snat'] = (
                          rtr[l3.EXTERNAL_GW_INFO]['enable_snat'])
  
                  binding = bindings.get(rtr['id'])
                  if not binding:
                      rtr['gw_port_host'] = None
                      LOG.debug('No snat is bound to router %s', rtr['id'])
                      continue
  
                  rtr['gw_port_host'] = binding.l3_agent.host
  
          return routers
  
      def _process_routers(self, context, routers):
          routers_dict = {}
          snat_intfs_by_router_id = self._get_snat_sync_interfaces(
              context, [r['id'] for r in routers])
          for router in routers:
              routers_dict[router['id']] = router
              if router['gw_port_id']:
                  snat_router_intfs = snat_intfs_by_router_id[router['id']]
                  LOG.debug("SNAT ports returned: %s ", snat_router_intfs)
                  router[l3_const.SNAT_ROUTER_INTF_KEY] = snat_router_intfs
          return routers_dict
  
      def _process_floating_ips_dvr(self, context, routers_dict,
                                    floating_ips, host, agent):
          fip_sync_interfaces = None
          LOG.debug("FIP Agent : %s ", agent.id)
          for floating_ip in floating_ips:
              router = routers_dict.get(floating_ip['router_id'])
              if router:
                  router_floatingips = router.get(l3_const.FLOATINGIP_KEY, [])
                  if router['distributed']:
                      if floating_ip.get('host', None) != host:
                          continue
                      LOG.debug("Floating IP host: %s", floating_ip['host'])
                  router_floatingips.append(floating_ip)
                  router[l3_const.FLOATINGIP_KEY] = router_floatingips
                  if not fip_sync_interfaces:
                      fip_sync_interfaces = self._get_fip_sync_interfaces(
                          context, agent.id)
                      LOG.debug("FIP Agent ports: %s", fip_sync_interfaces)
                  router[l3_const.FLOATINGIP_AGENT_INTF_KEY] = (
                      fip_sync_interfaces)
  
      def _get_fip_sync_interfaces(self, context, fip_agent_id):
          """Query router interfaces that relate to list of router_ids."""
          if not fip_agent_id:
              return []
          filters = {'device_id': [fip_agent_id],
                     'device_owner': [l3_const.DEVICE_OWNER_AGENT_GW]}
          interfaces = self._core_plugin.get_ports(context.elevated(), filters)
          LOG.debug("Return the FIP ports: %s ", interfaces)
          return interfaces
  
      def _get_dvr_sync_data(self, context, host, agent, router_ids=None,
                            active=None):
          routers, interfaces, floating_ips = self._get_router_info_list(
              context, router_ids=router_ids, active=active,
              device_owners=l3_const.ROUTER_INTERFACE_OWNERS)
          dvr_router_ids = set(router['id'] for router in routers
                               if is_distributed_router(router))
          floating_ip_port_ids = [fip['port_id'] for fip in floating_ips
                                  if fip['router_id'] in dvr_router_ids]
          if floating_ip_port_ids:
              port_filter = {portbindings.HOST_ID: [host],
                             'id': floating_ip_port_ids}
              ports = self._core_plugin.get_ports(context, port_filter)
              port_dict = dict((port['id'], port) for port in ports)
              # Add the port binding host to the floatingip dictionary
              for fip in floating_ips:
                  vm_port = port_dict.get(fip['port_id'], None)
                  if vm_port:
                      fip['host'] = self._get_vm_port_hostid(context,
                                                             fip['port_id'],
                                                             port=vm_port)
          routers_dict = self._process_routers(context, routers)
          self._process_floating_ips_dvr(context, routers_dict,
                                         floating_ips, host, agent)
          ports_to_populate = []
          for router in routers_dict.values():
              if router.get('gw_port'):
                  ports_to_populate.append(router['gw_port'])
              if router.get(l3_const.FLOATINGIP_AGENT_INTF_KEY):
                  ports_to_populate += router[l3_const.FLOATINGIP_AGENT_INTF_KEY]
              if router.get(l3_const.SNAT_ROUTER_INTF_KEY):
                  ports_to_populate += router[l3_const.SNAT_ROUTER_INTF_KEY]
          ports_to_populate += interfaces
          self._populate_subnets_for_ports(context, ports_to_populate)
          self._process_interfaces(routers_dict, interfaces)
          return list(routers_dict.values())
  
      def _get_vm_port_hostid(self, context, port_id, port=None):
          """Return the portbinding host_id."""
          vm_port_db = port or self._core_plugin.get_port(context, port_id)
          device_owner = vm_port_db['device_owner'] if vm_port_db else ""
          if (n_utils.is_dvr_serviced(device_owner) or
              device_owner == l3_const.DEVICE_OWNER_AGENT_GW):
              return vm_port_db[portbindings.HOST_ID]
  
      def _get_agent_gw_ports_exist_for_network(
              self, context, network_id, host, agent_id):
          """Return agent gw port if exist, or None otherwise."""
          if not network_id:
              LOG.debug("Network not specified")
              return
  
          filters = {
              'network_id': [network_id],
              'device_id': [agent_id],
              'device_owner': [l3_const.DEVICE_OWNER_AGENT_GW]
          }
          ports = self._core_plugin.get_ports(context, filters)
          if ports:
              return ports[0]
  
      def _get_router_ids(self, context):
          """Function to retrieve router IDs for a context without joins"""
          query = self._model_query(context, l3_db.Router.id)
          return [row[0] for row in query]
  
      def delete_floatingip_agent_gateway_port(
          self, context, host_id, ext_net_id):
          """Function to delete FIP gateway port with given ext_net_id."""
          # delete any fip agent gw port
          device_filter = {'device_owner': [l3_const.DEVICE_OWNER_AGENT_GW],
                           'network_id': [ext_net_id]}
          ports = self._core_plugin.get_ports(context,
                                              filters=device_filter)
          for p in ports:
              if not host_id or p[portbindings.HOST_ID] == host_id:
                  self._core_plugin.ipam.delete_port(context, p['id'])
                  if host_id:
                      return
  
      def create_fip_agent_gw_port_if_not_exists(
          self, context, network_id, host):
          """Function to return the FIP Agent GW port.
  
          This function will create a FIP Agent GW port
          if required. If the port already exists, it
          will return the existing port and will not
          create a new one.
          """
          l3_agent_db = self._get_agent_by_type_and_host(
              context, l3_const.AGENT_TYPE_L3, host)
          if l3_agent_db:
              LOG.debug("Agent ID exists: %s", l3_agent_db['id'])
              f_port = self._get_agent_gw_ports_exist_for_network(
                  context, network_id, host, l3_agent_db['id'])
              if not f_port:
                  LOG.info(_LI('Agent Gateway port does not exist,'
                               ' so create one: %s'), f_port)
                  port_data = {'tenant_id': '',
                               'network_id': network_id,
                               'device_id': l3_agent_db['id'],
                               'device_owner': l3_const.DEVICE_OWNER_AGENT_GW,
                               portbindings.HOST_ID: host,
                               'admin_state_up': True,
                               'name': ''}
                  agent_port = p_utils.create_port(self._core_plugin, context,
                                                   {'port': port_data})
                  if agent_port:
                      self._populate_subnets_for_ports(context, [agent_port])
                      return agent_port
                  msg = _("Unable to create the Agent Gateway Port")
                  raise n_exc.BadRequest(resource='router', msg=msg)
              else:
                  self._populate_subnets_for_ports(context, [f_port])
                  return f_port
  
      def _get_snat_interface_ports_for_router(self, context, router_id):
          """Return all existing snat_router_interface ports."""
          qry = context.session.query(l3_db.RouterPort)
          qry = qry.filter_by(
              router_id=router_id,
              port_type=l3_const.DEVICE_OWNER_ROUTER_SNAT
          )
  
          ports = [self._core_plugin._make_port_dict(rp.port, None)
                   for rp in qry]
          return ports
  
      def _add_csnat_router_interface_port(
              self, context, router, network_id, subnet_id, do_pop=True):
          """Add SNAT interface to the specified router and subnet."""
          port_data = {'tenant_id': '',
                       'network_id': network_id,
                       'fixed_ips': [{'subnet_id': subnet_id}],
                       'device_id': router.id,
                       'device_owner': l3_const.DEVICE_OWNER_ROUTER_SNAT,
                       'admin_state_up': True,
                       'name': ''}
          snat_port = p_utils.create_port(self._core_plugin, context,
                                          {'port': port_data})
          if not snat_port:
              msg = _("Unable to create the SNAT Interface Port")
              raise n_exc.BadRequest(resource='router', msg=msg)
  
          with context.session.begin(subtransactions=True):
              router_port = l3_db.RouterPort(
                  port_id=snat_port['id'],
                  router_id=router.id,
                  port_type=l3_const.DEVICE_OWNER_ROUTER_SNAT
              )
              context.session.add(router_port)
  
          if do_pop:
              return self._populate_subnets_for_ports(context, [snat_port])
          return snat_port
  
      def _create_snat_intf_ports_if_not_exists(self, context, router):
          """Function to return the snat interface port list.
  
          This function will return the snat interface port list
          if it exists. If the port does not exist it will create
          new ports and then return the list.
          """
          port_list = self._get_snat_interface_ports_for_router(
              context, router.id)
          if port_list:
              self._populate_subnets_for_ports(context, port_list)
              return port_list
          port_list = []
  
          int_ports = (
              rp.port for rp in
              router.attached_ports.filter_by(
                  port_type=l3_const.DEVICE_OWNER_DVR_INTERFACE
              )
          )
          LOG.info(_LI('SNAT interface port list does not exist,'
                       ' so create one: %s'), port_list)
          for intf in int_ports:
              if intf.fixed_ips:
                  # Passing the subnet for the port to make sure the IP's
                  # are assigned on the right subnet if multiple subnet
                  # exists
                  snat_port = self._add_csnat_router_interface_port(
                      context, router, intf['network_id'],
                      intf['fixed_ips'][0]['subnet_id'], do_pop=False)
                  port_list.append(snat_port)
          if port_list:
              self._populate_subnets_for_ports(context, port_list)
          return port_list
  
      def dvr_vmarp_table_update(self, context, port_dict, action):
          """Notify L3 agents of VM ARP table changes.
  
          When a VM goes up or down, look for one DVR router on the port's
          subnet, and send the VM's ARP details to all L3 agents hosting the
          router.
          """
  
          # Check this is a valid VM or service port
          if not (n_utils.is_dvr_serviced(port_dict['device_owner']) and
                  port_dict['fixed_ips']):
              return
          ip_address = port_dict['fixed_ips'][0]['ip_address']
          subnet = port_dict['fixed_ips'][0]['subnet_id']
          filters = {'fixed_ips': {'subnet_id': [subnet]}}
          ports = self._core_plugin.get_ports(context, filters=filters)
          for port in ports:
              if port['device_owner'] == l3_const.DEVICE_OWNER_DVR_INTERFACE:
                  router_id = port['device_id']
                  router_dict = self._get_router(context, router_id)
                  if router_dict.extra_attributes.distributed:
                      arp_table = {'ip_address': ip_address,
                                   'mac_address': port_dict['mac_address'],
                                   'subnet_id': subnet}
                      if action == "add":
                          notify_action = self.l3_rpc_notifier.add_arp_entry
                      elif action == "del":
                          notify_action = self.l3_rpc_notifier.del_arp_entry
                      notify_action(context, router_id, arp_table)
                      return
  
      def delete_csnat_router_interface_ports(self, context,
                                              router, subnet_id=None):
          # Each csnat router interface port is associated
          # with a subnet, so we need to pass the subnet id to
          # delete the right ports.
  
          # TODO(markmcclain): This is suboptimal but was left to reduce
          # changeset size since it is late in cycle
          ports = [
              rp.port.id for rp in
              router.attached_ports.filter_by(
                      port_type=l3_const.DEVICE_OWNER_ROUTER_SNAT)
              if rp.port
          ]
  
          c_snat_ports = self._core_plugin.get_ports(
              context,
              filters={'id': ports}
          )
          for p in c_snat_ports:
              if subnet_id is None:
                  self._core_plugin.delete_port(context,
                                                p['id'],
                                                l3_port_check=False)
              else:
                  if p['fixed_ips'][0]['subnet_id'] == subnet_id:
                      LOG.debug("Subnet matches: %s", subnet_id)
                      self._core_plugin.delete_port(context,
                                                    p['id'],
                                                    l3_port_check=False)
  
      def create_floatingip(self, context, floatingip,
                            initial_status=l3_const.FLOATINGIP_STATUS_ACTIVE):
          floating_ip = self._create_floatingip(
              context, floatingip, initial_status)
          self._notify_floating_ip_change(context, floating_ip)
          return floating_ip
  
      def _notify_floating_ip_change(self, context, floating_ip):
          router_id = floating_ip['router_id']
          fixed_port_id = floating_ip['port_id']
          # we need to notify agents only in case Floating IP is associated
          if not router_id or not fixed_port_id:
              return
  
          try:
              # using admin context as router may belong to admin tenant
              router = self._get_router(context.elevated(), router_id)
          except l3.RouterNotFound:
              LOG.warning(_LW("Router %s was not found. "
                              "Skipping agent notification."),
                          router_id)
              return
  
          if is_distributed_router(router):
              host = self._get_vm_port_hostid(context, fixed_port_id)
              self.l3_rpc_notifier.routers_updated_on_host(
                  context, [router_id], host)
          else:
              self.notify_router_updated(context, router_id)
  
      def update_floatingip(self, context, id, floatingip):
          old_floatingip, floatingip = self._update_floatingip(
              context, id, floatingip)
          self._notify_floating_ip_change(context, old_floatingip)
          if (floatingip['router_id'] != old_floatingip['router_id'] or
                  floatingip['port_id'] != old_floatingip['port_id']):
              self._notify_floating_ip_change(context, floatingip)
          return floatingip
  
      def delete_floatingip(self, context, id):
          floating_ip = self._delete_floatingip(context, id)
          self._notify_floating_ip_change(context, floating_ip)
  
  
  def is_distributed_router(router):
      """Return True if router to be handled is distributed."""
      try:
          # See if router is a DB object first
          requested_router_type = router.extra_attributes.distributed
      except AttributeError:
          # if not, try to see if it is a request body
          requested_router_type = router.get('distributed')
      if attributes.is_attr_set(requested_router_type):
          return requested_router_type
      return cfg.CONF.router_distributed
  