# Copyright (c) 2015 Orange.
# 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.

"""
L2 Agent extension to support bagpipe networking-bgpvpn driver RPCs in the
OpenVSwitch and Linuxbridge agents
"""

import collections
import copy
import itertools
import netaddr

from oslo_concurrency import lockutils
from oslo_config import cfg
from oslo_log import helpers as log_helpers
from oslo_log import log as logging

from networking_bagpipe._i18n import _
from networking_bagpipe.agent import agent_base_info
from networking_bagpipe.agent import bagpipe_bgp_agent
from networking_bagpipe.agent.bgpvpn import constants as bgpvpn_const
from networking_bagpipe.bagpipe_bgp import constants as bbgp_const
from networking_bagpipe.objects import bgpvpn as objects

from neutron.agent.common import ovs_lib
from neutron.agent.linux.openvswitch_firewall import firewall \
    as ovs_fw
from neutron.api.rpc.callbacks.consumer import registry as rpc_registry
from neutron.api.rpc.callbacks import events as rpc_events
from neutron.api.rpc.handlers import resources_rpc
from neutron.conf.agent import common as config
from neutron.conf.plugins.ml2.drivers import ovs_conf
from neutron.debug import debug_agent
from neutron.plugins.ml2.drivers.linuxbridge.agent.common \
    import constants as lnxbridge_agt_constants
from neutron.plugins.ml2.drivers.linuxbridge.agent import \
    linuxbridge_neutron_agent as lnx_agt
from neutron.plugins.ml2.drivers.openvswitch.agent.common \
    import constants as ovs_agt_consts
from neutron.plugins.ml2.drivers.openvswitch.agent import vlanmanager

from neutron_lib.agent import l2_extension
from neutron_lib.api.definitions import bgpvpn
from neutron_lib.api.definitions import bgpvpn_routes_control as bgpvpn_rc
from neutron_lib.callbacks import events
from neutron_lib.callbacks import registry
from neutron_lib.callbacks import resources
from neutron_lib import constants as n_const

LOG = logging.getLogger(__name__)

bagpipe_bgpvpn_opts = [
    cfg.StrOpt('mpls_bridge', default='br-mpls',
               help=_("OVS MPLS bridge to use")),
]

# these options are for internal use only (fullstack tests), and hence
# better kept in a separate table not looked at by oslo gen confi hooks
internal_opts = [
    cfg.StrOpt('tun_to_mpls_peer_patch_port', default='patch-to-mpls',
               help=_("OVS Peer patch port in tunnel bridge to MPLS bridge ")),
    cfg.StrOpt('mpls_to_tun_peer_patch_port', default='patch-from-tun',
               help=_("OVS Peer patch port in MPLS bridge to tunnel bridge ")),
    cfg.StrOpt('mpls_to_int_peer_patch_port', default='patch-mpls-to-int',
               help=_("OVS Peer patch port in MPLS bridge to int bridge ")),
    cfg.StrOpt('int_to_mpls_peer_patch_port', default='patch-int-from-mpls',
               help=_("OVS Peer patch port in int bridge to MPLS bridge ")),
]

cfg.CONF.register_opts(bagpipe_bgpvpn_opts, "BAGPIPE")
cfg.CONF.register_opts(internal_opts, "BAGPIPE")
ovs_conf.register_ovs_agent_opts()
config.register_agent_state_opts_helper(cfg.CONF)


def format_associations_route_targets(assocs):
    rts = collections.defaultdict(set)
    for assoc in assocs:
        rts[bbgp_const.RT_IMPORT] |= set(assoc.bgpvpn.route_targets or ())
        rts[bbgp_const.RT_IMPORT] |= set(assoc.bgpvpn.import_targets or ())

        rts[bbgp_const.RT_EXPORT] |= set(assoc.bgpvpn.route_targets or ())
        rts[bbgp_const.RT_EXPORT] |= set(assoc.bgpvpn.export_targets or ())

    return rts


def bagpipe_vpn_type(bgpvpn_type):
    return bgpvpn_const.BGPVPN_2_BAGPIPE[bgpvpn_type]


def vpn_instance_id_for_port_assoc_route(port_assoc, route):
    bbgp_vpn_type = bagpipe_vpn_type(port_assoc.bgpvpn.type)
    if route.type == bgpvpn_rc.BGPVPN_TYPE:
        return '%s_portassoc_%s_bgpvpn_%s' % (
            bbgp_vpn_type, port_assoc.id, route.bgpvpn.id)
    elif route.type == bgpvpn_rc.PREFIX_TYPE:
        encoded_prefix = str(
            route.prefix).replace('.', '_').replace(':', '_').replace('/', '_')
        return '%s_portassoc_%s_prefix_%s' % (
            bbgp_vpn_type, port_assoc.id, encoded_prefix)
    else:
        LOG.error("unknown route type: %s", route.type)


def advertise_fixed_ip(port_info):
    return (any([assoc.advertise_fixed_ips for assoc
                 in port_info.associations]
                ) or
            any([not isinstance(assoc, objects.BGPVPNPortAssociation) for assoc
                 in port_info.network.associations]))


class BagpipeBgpvpnAgentExtension(l2_extension.L2AgentExtension,
                                  agent_base_info.BaseInfoManager):

    def __init__(self):
        super(BagpipeBgpvpnAgentExtension, self).__init__()
        self.ports = set()

    @log_helpers.log_method_call
    def consume_api(self, agent_api):
        self.agent_api = agent_api

    @log_helpers.log_method_call
    def initialize(self, connection, driver_type):
        self.driver_type = driver_type
        if self._is_ovs_extension():
            self.int_br = self.agent_api.request_int_br()
            self.tun_br = self.agent_api.request_tun_br()

            if self.tun_br is None:
                raise Exception("tunneling is not enabled in OVS agent, "
                                "however bagpipe_bgpvpn extensions needs it")

            if cfg.CONF.SECURITYGROUP.firewall_driver != "openvswitch":
                LOG.warning('Neutron router fallback supported only with the '
                            '"openvswitch" firewall driver, or if l3agent is '
                            'always deployed on servers distinct from compute '
                            'nodes.')

            self.bagpipe_bgp_agent = (
                bagpipe_bgp_agent.BaGPipeBGPAgent.get_instance(
                    n_const.AGENT_TYPE_OVS)
            )

            self._setup_ovs_bridge()

            self.vlan_manager = vlanmanager.LocalVlanManager()

            registry.subscribe(self.ovs_restarted,
                               resources.AGENT,
                               events.OVS_RESTARTED)

        elif self._is_linuxbridge_extension():
            self.bagpipe_bgp_agent = (
                bagpipe_bgp_agent.BaGPipeBGPAgent.get_instance(
                    n_const.AGENT_TYPE_LINUXBRIDGE)
            )
        else:
            raise Exception("driver type not supported: %s", driver_type)

        self.bagpipe_bgp_agent.register_build_callback(
            bgpvpn_const.BGPVPN_SERVICE,
            self.build_bgpvpn_attach_info)

        # NOTE(tmorin): replace by callback, so that info can be derived
        # from self.ports_info.keys() instead of being duplicated into
        # self.ports
        self.bagpipe_bgp_agent.register_port_list(bgpvpn_const.BGPVPN_SERVICE,
                                                  self.ports)
        # OVO-based BGPVPN RPCs
        self._setup_rpc(connection)

    def _is_ovs_extension(self):
        return self.driver_type == ovs_agt_consts.EXTENSION_DRIVER_TYPE

    def _is_linuxbridge_extension(self):
        return (
            self.driver_type == lnxbridge_agt_constants.EXTENSION_DRIVER_TYPE)

    def _setup_rpc(self, connection):
        self.rpc_pull_api = resources_rpc.ResourcesPullRpcApi()

        rpc_registry.register(self.handle_notification_net_assocs,
                              objects.BGPVPNNetAssociation.obj_name())
        rpc_registry.register(self.handle_notification_router_assocs,
                              objects.BGPVPNRouterAssociation.obj_name())
        rpc_registry.register(self.handle_notification_port_assocs,
                              objects.BGPVPNPortAssociation.obj_name())
        endpoints = [resources_rpc.ResourcesPushRpcCallback()]
        topic_net_assoc = resources_rpc.resource_type_versioned_topic(
            objects.BGPVPNNetAssociation.obj_name())
        topic_router_assoc = resources_rpc.resource_type_versioned_topic(
            objects.BGPVPNRouterAssociation.obj_name())
        topic_port_assoc = resources_rpc.resource_type_versioned_topic(
            objects.BGPVPNPortAssociation.obj_name())
        connection.create_consumer(topic_net_assoc, endpoints, fanout=True)
        connection.create_consumer(topic_router_assoc, endpoints, fanout=True)
        connection.create_consumer(topic_port_assoc, endpoints, fanout=True)

    @log_helpers.log_method_call
    @lockutils.synchronized('bagpipe-bgpvpn')
    def handle_port(self, context, data):
        port_id = data['port_id']
        network_id = data['network_id']

        if self._ignore_port(context, data):
            return

        self.ports.add(port_id)

        net_info, port_info = (
            self._get_network_port_infos(network_id, port_id)
        )

        def delete_hook():
            self._delete_port(context, {'port_id': port_info.id})

        port_info.update_admin_state(data, delete_hook)
        if not port_info.admin_state_up:
            return

        if data['network_type'] == n_const.TYPE_VXLAN:
            net_info.segmentation_id = data['segmentation_id']

        port_info.mac_address = data['mac_address']
        port_info.ip_address = data['fixed_ips'][0]['ip_address']

        net_assocs = self.rpc_pull_api.bulk_pull(
            context,
            objects.BGPVPNNetAssociation.obj_name(),
            filter_kwargs=dict(network_id=network_id))
        # find all the Router Association that are relevant for our network
        router_assocs = self.rpc_pull_api.bulk_pull(
            context,
            objects.BGPVPNRouterAssociation.obj_name(),
            filter_kwargs=dict(network_id=network_id))

        for assoc in itertools.chain(net_assocs, router_assocs):
            # replug_ports=False because we will call do_port_plug
            # once for all associations, and only for this port, out of
            # the loop
            self._add_association_for_net(network_id, assoc,
                                          replug_ports=False)

        port_assocs = self.rpc_pull_api.bulk_pull(
            context,
            objects.BGPVPNPortAssociation.obj_name(),
            filter_kwargs=dict(port_id=port_id))
        for port_assoc in port_assocs:
            self._add_association_for_port(port_info, port_assoc,
                                           replug_port=False)

        if port_info.has_any_association():
            self.bagpipe_bgp_agent.do_port_plug(port_id)

    @lockutils.synchronized('bagpipe-bgpvpn')
    def delete_port(self, context, data):
        self._delete_port(context, data)

    # un-synchronized version, to be called indirectly from handle_port
    @log_helpers.log_method_call
    def _delete_port(self, context, data):
        port_id = data['port_id']
        port_info = self.ports_info.get(port_id)

        if port_info and port_info.has_any_association():
            if not port_info.admin_state_up:
                LOG.debug("port %s was not admin_state_up, ignoring", port_id)
                return

            if len(port_info.network.ports) == 1:
                # last port on network...
                self._stop_gateway_traffic_redirect(port_info.network,
                                                    last_port=True)

            detach_infos = self._build_detach_infos(port_info)

            # here we clean our cache for this port,
            # and for its network if this was the last port on the network
            self._remove_network_port_infos(port_info.network.id, port_id)
            self.ports.remove(port_id)

            self.bagpipe_bgp_agent.do_port_plug_refresh_many(port_id,
                                                             detach_infos)

    @log_helpers.log_method_call
    @lockutils.synchronized('bagpipe-bgpvpn')
    def handle_notification_net_assocs(self, context, resource_type,
                                       net_assocs, event_type):
        for net_assoc in net_assocs:
            if event_type in (rpc_events.CREATED, rpc_events.UPDATED):
                self._add_association_for_net(net_assoc.network_id,
                                              net_assoc)
            elif event_type == rpc_events.DELETED:
                self._remove_association_for_net(net_assoc.network_id,
                                                 net_assoc)
            else:
                LOG.warning("unsupported event: %s", event_type)

    @log_helpers.log_method_call
    @lockutils.synchronized('bagpipe-bgpvpn')
    def handle_notification_router_assocs(self, context, resource_type,
                                          router_assocs, event_type):
        for router_assoc in router_assocs:
            if event_type in (rpc_events.CREATED, rpc_events.UPDATED):
                for connected_net in router_assoc.connected_networks:
                    self._add_association_for_net(connected_net['network_id'],
                                                  router_assoc)
            elif event_type == rpc_events.DELETED:
                for connected_net in router_assoc.connected_networks:
                    self._remove_association_for_net(
                        connected_net['network_id'],
                        router_assoc)
            else:
                LOG.warning("unsupported event: %s", event_type)

    @log_helpers.log_method_call
    def _add_association_for_net(self, network_id, assoc, replug_ports=True):
        LOG.debug("add association with bgpvpn %s", assoc.bgpvpn)

        net_info = self.networks_info[network_id]

        # for now we only support a single IPv4 subnet
        for subnet in assoc.all_subnets(network_id):
            gateway_info = agent_base_info.GatewayInfo(
                subnet['gateway_mac'],
                subnet['gateway_ip']
            )
            if subnet['ip_version'] == 4:
                net_info.set_gateway_info(gateway_info)
                if assoc.bgpvpn.type == bgpvpn.BGPVPN_L3:
                    self._gateway_traffic_redirect(net_info)
                break

        if not net_info:
            LOG.debug("no net_info for network %s, skipping", network_id)
            return

        if not net_info.ports:
            LOG.debug("no port on network %s, skipping", network_id)
            return

        net_info.add_association(assoc)

        if replug_ports:
            for port_info in net_info.ports:
                self.bagpipe_bgp_agent.do_port_plug(port_info.id)

    @log_helpers.log_method_call
    def _remove_association_for_net(self, network_id, assoc,
                                    refresh_plugs=True):
        net_info = self.networks_info.get(network_id)

        if not net_info:
            LOG.debug("no net_info for network %s, skipping", network_id)
            return

        if not net_info.ports:
            LOG.debug("no port on network %s, skipping", network_id)
            return

        # is there an association of same BGPVPN type that remains ?
        remaining = len([1 for a in net_info.associations
                         if a.bgpvpn.type == assoc.bgpvpn.type])

        # we need to build port detach_information before we update
        # net_info.associations:
        if refresh_plugs and remaining <= 1:
            detach_infos = {}
            for port_info in net_info.ports:
                detach_infos[port_info.id] = (
                    self._build_detach_infos(port_info, assoc.bgpvpn.type))

        net_info.remove_association(assoc)

        if remaining > 1 and refresh_plugs:
            LOG.debug("some association of type %s remain, updating all ports",
                      assoc.bgpvpn.type)
            for port_info in net_info.ports:
                self.bagpipe_bgp_agent.do_port_plug(port_info.id)
        else:
            LOG.debug("no association of type %s remains, detaching it for "
                      "all ports", assoc.bgpvpn.type)
            if refresh_plugs:
                for port_info in net_info.ports:
                    self.bagpipe_bgp_agent.do_port_plug_refresh_many(
                        port_info.id,
                        detach_infos[port_info.id])

            if assoc.bgpvpn.type == bgpvpn.BGPVPN_L3:
                self._stop_gateway_traffic_redirect(net_info, last_assoc=True)

    @log_helpers.log_method_call
    @lockutils.synchronized('bagpipe-bgpvpn')
    def handle_notification_port_assocs(self, context, resource_type,
                                        port_assocs, event_type):
        for port_assoc in port_assocs:
            try:
                port_info = self.ports_info[port_assoc.port_id]
            except KeyError:
                LOG.debug("port %s is not present, skipping",
                          port_assoc.port_id)
                continue
            if event_type == rpc_events.CREATED:
                self._add_association_for_port(port_info, port_assoc)
            elif event_type == rpc_events.UPDATED:
                self._update_port_association(port_info, port_assoc)
            elif event_type == rpc_events.DELETED:
                self._remove_association_for_port(port_info, port_assoc)
            else:
                LOG.warning("unsupported event: %s", event_type)

    @log_helpers.log_method_call
    def _update_port_association(self, port_info, new_port_assoc):
        # if we already had this association, do unplugs for prefixes
        # that were in the association but are not port present anymore
        # in new_port_assoc
        assoc_id = new_port_assoc.id
        if port_info.has_association(assoc_id):
            old_routes = set(port_info.get_association(assoc_id).routes)
            new_routes = set(new_port_assoc.routes)
            LOG.debug("old routes: %s", old_routes)
            LOG.debug("new routes: %s", new_routes)

            # update the port association, so that build_bgpvpn_attach_info
            # finds the updated version
            port_info.add_association(new_port_assoc)

            detach_infos = []
            for removed_route in old_routes.difference(new_routes):
                detach_infos.extend(
                    self._build_detach_infos_for_port_assoc(port_info,
                                                            new_port_assoc,
                                                            removed_route))

            self.bagpipe_bgp_agent.do_port_plug_refresh_many(port_info.id,
                                                             detach_infos)
        else:
            self._add_association_for_port(port_info, new_port_assoc)

    @log_helpers.log_method_call
    def _add_association_for_port(self, port_info, assoc, replug_port=True):
        port_info.add_association(assoc)
        self._add_association_for_net(port_info.network.id, assoc,
                                      replug_ports=False)
        if replug_port:
            self.bagpipe_bgp_agent.do_port_plug(port_info.id)

    @log_helpers.log_method_call
    def _remove_association_for_port(self, port_info, assoc):
        detach_infos = self._build_detach_infos_for_port_assoc(port_info,
                                                               assoc)

        port_info.remove_association(assoc)
        self._remove_association_for_net(port_info.network.id, assoc,
                                         refresh_plugs=False)

        self.bagpipe_bgp_agent.do_port_plug_refresh_many(port_info.id,
                                                         detach_infos)

    def _ignore_port(self, context, data):
        if data['port_id'] is None:
            return True

        if (data['device_owner'].startswith(
            n_const.DEVICE_OWNER_NETWORK_PREFIX) and not (data['device_owner']
            in (debug_agent.DEVICE_OWNER_COMPUTE_PROBE,
                debug_agent.DEVICE_OWNER_NETWORK_PROBE))):
            LOG.info("Port %s owner is network:*, we'll do nothing",
                     data['port_id'])
            return True

        return False

    def _setup_ovs_bridge(self):
        '''Setup the MPLS bridge for bagpipe-bgp.

        Creates MPLS bridge, and links it to the integration and tunnel
        bridges using patch ports.

        :param mpls_br: the name of the MPLS bridge.
        '''
        mpls_br = cfg.CONF.BAGPIPE.mpls_bridge
        self.mpls_br = ovs_lib.OVSBridge(mpls_br)

        if not self.mpls_br.bridge_exists(mpls_br):
            LOG.error("Unable to enable MPLS on this agent, MPLS bridge "
                      "%(mpls_br)s doesn't exist. Agent terminated!",
                      {"mpls_br": mpls_br})
            exit(1)

        # set secure mode
        self.mpls_br.set_secure_mode()

        # patch ports for traffic from tun bridge to mpls bridge
        self.patch_tun_to_mpls_ofport = self.tun_br.add_patch_port(
            cfg.CONF.BAGPIPE.tun_to_mpls_peer_patch_port,
            cfg.CONF.BAGPIPE.mpls_to_tun_peer_patch_port)
        self.patch_mpls_to_tun_ofport = self.mpls_br.add_patch_port(
            cfg.CONF.BAGPIPE.mpls_to_tun_peer_patch_port,
            cfg.CONF.BAGPIPE.tun_to_mpls_peer_patch_port)

        # patch ports for traffic from mpls bridge to int bridge
        self.patch_mpls_to_int_ofport = self.mpls_br.add_patch_port(
            cfg.CONF.BAGPIPE.mpls_to_int_peer_patch_port,
            cfg.CONF.BAGPIPE.int_to_mpls_peer_patch_port)
        self.patch_int_to_mpls_ofport = self.int_br.add_patch_port(
            cfg.CONF.BAGPIPE.int_to_mpls_peer_patch_port,
            cfg.CONF.BAGPIPE.mpls_to_int_peer_patch_port)

        if (int(self.patch_tun_to_mpls_ofport) < 0 or
                int(self.patch_mpls_to_tun_ofport) < 0 or
                int(self.patch_int_to_mpls_ofport) < 0 or
                int(self.patch_mpls_to_int_ofport) < 0):
            LOG.error("Failed to create OVS patch port. Cannot have "
                      "MPLS enabled on this agent, since this version "
                      "of OVS does not support patch ports. "
                      "Agent terminated!")
            exit(1)

        self.patch_tun2int = self.tun_br.get_port_ofport(
            cfg.CONF.OVS.tun_peer_patch_port)

        # In br-tun, redirect all traffic from VMs towards the gateway
        # into br-mplsexcept the traffic that already went through br-mpls
        # and came back to br-tun via the fallback mecanism, this traffic is
        # identified by the specific FALLBACK_SRC_MAC MAC address

        # we need to copy the existing br-tun rules to dispatch to UCAST_TO_TUN
        # and FLOOD_TO_TUN, but only for except_from_src_mac MAC,
        # and with a priority of 2
        self.tun_br.add_flow(table=ovs_agt_consts.PATCH_LV_TO_TUN,
                             priority=2,
                             dl_src=bgpvpn_const.FALLBACK_SRC_MAC,
                             dl_dst="00:00:00:00:00:00/01:00:00:00:00:00",
                             actions=("resubmit(,%s)" %
                                      ovs_agt_consts.UCAST_TO_TUN))

        self.tun_br.add_flow(table=ovs_agt_consts.PATCH_LV_TO_TUN,
                             priority=2,
                             dl_src=bgpvpn_const.FALLBACK_SRC_MAC,
                             dl_dst="01:00:00:00:00:00/01:00:00:00:00:00",
                             actions=("resubmit(,%s)" %
                                      ovs_agt_consts.FLOOD_TO_TUN))

        # Redirect traffic from the MPLS bridge to br-int
        self.tun_br.add_flow(in_port=self.patch_tun_to_mpls_ofport,
                             actions="output:%s" % self.patch_tun2int)

        # In br-int...

        self.patch_int2tun = self.int_br.get_port_ofport(
            cfg.CONF.OVS.int_peer_patch_port)

        # when the OVS firewall driver is used, we can handle the
        # case where the gateway is directly connected to br-int:
        # traffic that was already fallback'd is not touched

        self.int_br.add_flow(
            table=ovs_agt_consts.ACCEPTED_EGRESS_TRAFFIC_NORMAL_TABLE,
            priority=3,
            dl_src=bgpvpn_const.FALLBACK_SRC_MAC,
            actions="NORMAL",
        )
        # the base NORMAL action in this table is at priority 1
        # the rules to redirect traffic are setup in gateway_traffic_redirect
        # with a priority of 2

        # OVS1.3 needed for push_vlan in _gateway_traffic_redirect
        self.int_br.use_at_least_protocol(ovs_agt_consts.OPENFLOW13)

    def _redirect_br_tun_to_mpls(self, dst_mac, vlan):
        # then with a priority of 1, we redirect traffic to the dst_mac
        # address to br-mpls
        self.tun_br.add_flow(
            table=ovs_agt_consts.PATCH_LV_TO_TUN,
            priority=1,
            in_port=self.patch_tun2int,
            dl_dst=dst_mac,
            dl_vlan=vlan,
            actions="output:%s" % self.patch_tun_to_mpls_ofport
        )

    def _stop_redirect_br_tun_to_mpls(self, vlan):
        self.tun_br.delete_flows(
            strict=True,
            table=ovs_agt_consts.PATCH_LV_TO_TUN,
            priority=1,
            in_port=self.patch_tun2int,
            dl_vlan=vlan
        )

    @log_helpers.log_method_call
    @lockutils.synchronized('bagpipe-bgpvpn')
    def ovs_restarted(self, resources, event, trigger, payload=None):
        self._setup_ovs_bridge()
        for net_info in self.networks_info.values():
            if (net_info.ports and
                    any([assoc.bgpvpn.type == bgpvpn.BGPVPN_L3
                        for assoc in net_info.associations])):
                self._gateway_traffic_redirect(net_info)
        # TODO(tmorin): need to handle restart on bagpipe-bgp side, in the
        # meantime after an OVS restart, restarting bagpipe-bgp is required

    @log_helpers.log_method_call
    def _enable_gw_arp_responder(self, vlan, gateway_ip):
        # Add ARP responder entry for default gateway in br-tun

        # We may compete with the ARP responder entry for the real MAC
        # if the router is on a network node and we are a compute node,
        # so we must add our rule with a higher priority. Using a different
        # priority also means that arp_responder will not remove our ARP
        # responding flows and we won't remove theirs.

        # NOTE(tmorin): consider adding priority to install_arp_responder
        # and then use it here

        # (mostly copy-pasted ovs_ofctl....install_arp_responder)
        actions = ovs_agt_consts.ARP_RESPONDER_ACTIONS % {
            'mac': netaddr.EUI(bgpvpn_const.DEFAULT_GATEWAY_MAC,
                               dialect=netaddr.mac_unix),
            'ip': netaddr.IPAddress(gateway_ip),
        }
        self.tun_br.add_flow(table=ovs_agt_consts.ARP_RESPONDER,
                             priority=2,  # see above
                             dl_vlan=vlan,
                             proto='arp',
                             arp_op=0x01,
                             arp_tpa='%s' % gateway_ip,
                             actions=actions)

    @log_helpers.log_method_call
    def _disable_gw_arp_responder(self, vlan, gateway_ip):
        if not gateway_ip:
            LOG.warning('could not disable gateway ARP responder for vlan %s: '
                        'no gateway IP', vlan)
            return

        # Remove ARP responder entry for default gateway in br-tun
        self.tun_br.delete_flows(
            strict=True,
            table=ovs_agt_consts.ARP_RESPONDER,
            priority=2,
            dl_vlan=vlan,
            proto='arp',
            arp_op=0x01,
            arp_tpa='%s' % gateway_ip)

    @log_helpers.log_method_call
    def _gateway_traffic_redirect(self, net_info):

        if not self._is_ovs_extension():
            return

        LOG.debug("redirecting gw traffic for net %s: %s", net_info,
                  net_info.gateway_info)

        # similar rules will later be added to redirect the traffic
        # to each specific router MAC to br-mpls

        try:
            vlan = self.vlan_manager.get(net_info.id).vlan

            if net_info.gateway_info.mac:
                # there is a Neutron router on this network, so we won't
                # ARP spoof the gateway IP...
                self._disable_gw_arp_responder(vlan, net_info.gateway_info.ip)
                # but we will redirect traffic toward its MAC to br-mpls

                self._redirect_br_tun_to_mpls(net_info.gateway_info.mac,
                                              vlan)

                # we keep this one just in case VMs have a stale ARP entry
                # for the gateway IP:
                self._redirect_br_tun_to_mpls(bgpvpn_const.DEFAULT_GATEWAY_MAC,
                                              vlan)

                # when the OVS firewall driver is used, we can handle the
                # case where the gateway is directly connected to br-int:
                # traffic to the gateway MAC will be sent directly to br-tun
                # (ensuring that traffic that was already fallback'd is not
                # touched is done in setup_mpls_br)

                # (need push vlan because NORMAL will not be used, and hence
                # won't the vlan tag)
                flow = dict(
                    table=ovs_agt_consts.ACCEPTED_EGRESS_TRAFFIC_NORMAL_TABLE,
                    priority=2,  # before NORMAL action
                    reg_net=vlan,
                    dl_dst=net_info.gateway_info.mac,
                    actions="push_vlan:0x8100,mod_vlan_vid:%d,output:%s" % (
                        vlan, self.patch_int2tun)
                )
                ovs_fw.create_reg_numbers(flow)
                self.int_br.add_flow(**flow)
            else:
                # no Neutron router plugged, so ARP spoofing the
                # gateway IP is needed
                if not net_info.gateway_info.ip:
                    LOG.warning("could not enable gw ARP responder for %s",
                                net_info.id)
                    return
                self._enable_gw_arp_responder(vlan, net_info.gateway_info.ip)

                self._redirect_br_tun_to_mpls(bgpvpn_const.DEFAULT_GATEWAY_MAC,
                                              vlan)

        except vlanmanager.MappingNotFound:
            LOG.warning("no VLAN mapping for net %s, no gateway redirection "
                        "in place", net_info.id)

    @log_helpers.log_method_call
    def _stop_gateway_traffic_redirect(self, net_info,
                                       last_port=False, last_assoc=False):

        if not self._is_ovs_extension():
            return

        if not net_info:
            return

        # if we are unplugging the last_port, we don't need to do
        # anything if there is no l3vpn for this network
        if last_port and not any([assoc.bgpvpn.type == bgpvpn.BGPVPN_L3
                                  for assoc in net_info.associations]):
            return

        # if we have just removed the last l3vpn association for the network
        # then we don't need to do anything if there is no port on this network
        if last_assoc and len(net_info.ports) == 0:
            return

        try:
            vlan = self.vlan_manager.get(net_info.id).vlan
            if net_info.gateway_info.ip:
                self._disable_gw_arp_responder(vlan, net_info.gateway_info.ip)
            else:
                LOG.debug('no gw IP for %s, no ARP responder to disable',
                          net_info.id)

            self._stop_redirect_br_tun_to_mpls(vlan)

            flow = dict(
                table=ovs_agt_consts.ACCEPTED_EGRESS_TRAFFIC_NORMAL_TABLE,
                reg_net=vlan,
            )
            ovs_fw.create_reg_numbers(flow)
            self.int_br.delete_flows(**flow)
        except vlanmanager.MappingNotFound:
            LOG.warning("no VLAN mapping for net %s, could not disable gw "
                        "redirection", net_info.id)

    def _base_attach_info(self, port_info, bbgp_vpn_type):
        i = {
            'mac_address': port_info.mac_address,
            'local_port': {}
        }

        if self._is_ovs_extension():
            vlan = self.vlan_manager.get(port_info.network.id).vlan
            i['local_port']['linuxif'] = (
                '%s:%s' % (bgpvpn_const.LINUXIF_PREFIX, vlan))
        else:
            i['local_port']['linuxif'] = (
                lnx_agt.LinuxBridgeManager.get_tap_device_name(port_info.id))
            if bbgp_vpn_type == bbgp_const.IPVPN:
                # the interface we need to pass to bagpipe is the
                # bridge
                i['local_port'].update({
                    'linuxif': lnx_agt.LinuxBridgeManager.get_bridge_name(
                        port_info.network.id)
                })

        return i

    @log_helpers.log_method_call
    def build_bgpvpn_attach_info(self, port_id):
        if port_id not in self.ports_info:
            LOG.debug("no info for port %s", port_id)
            return {}

        port_info = self.ports_info[port_id]

        if not port_info.admin_state_up:
            LOG.debug("port %s admin-state-up False, no attachment", port_id)
            return {}

        attachments = {}

        for vpn_type in bbgp_const.VPN_TYPES:
            vpn_type_attachments = self._build_attachments(port_info,
                                                           vpn_type)
            if vpn_type_attachments:
                attachments[vpn_type] = vpn_type_attachments

        if attachments:
            attachments['network_id'] = port_info.network.id

        return attachments

    def _build_attachments(self, port_info, bbgp_vpn_type):
        net_info = port_info.network

        assocs = [assoc for assoc in port_info.all_associations
                  if bagpipe_vpn_type(assoc.bgpvpn.type) == bbgp_vpn_type]

        # skip if we don't have any association with a BGPVPN
        # of a type corresponding to bbgp_vpn_type
        if not assocs:
            return

        attach_info = self._base_attach_info(port_info, bbgp_vpn_type)
        attach_info['gateway_ip'] = net_info.gateway_info.ip

        if self._is_ovs_extension():
            # Add OVS VLAN information
            vlan = self.vlan_manager.get(net_info.id).vlan

            if bbgp_vpn_type == bbgp_const.EVPN:
                attach_info['local_port']['vlan'] = vlan

            elif bbgp_vpn_type == bbgp_const.IPVPN:
                attach_info['local_port'].update({
                    'ovs': {
                        'plugged': True,
                        'port_number': self.patch_mpls_to_tun_ofport,
                        'vlan': vlan
                    }
                })

                # Add fallback information if needed as well
                if net_info.gateway_info.mac:
                    attach_info.update({
                        'fallback': {
                            'dst_mac': net_info.gateway_info.mac,
                            'src_mac': bgpvpn_const.FALLBACK_SRC_MAC,
                            'ovs_port_number': self.patch_mpls_to_int_ofport
                        }
                    })
        else:  # linuxbridge
            if bbgp_vpn_type == bbgp_const.EVPN:
                attach_info['linuxbr'] = (
                    lnx_agt.LinuxBridgeManager.get_bridge_name(net_info.id)
                )

        if bbgp_vpn_type == bbgp_const.EVPN:
            # if the network is a VXLAN network, then reuse same VNI
            # in bagpipe-bgp
            vni = net_info.segmentation_id
            LOG.debug("reusing vni %s for net %s", vni, net_info.id)
            attach_info['vni'] = vni

            all_vnis = [
                assoc.bgpvpn.vni
                for assoc in port_info.network.associations
                if (bagpipe_vpn_type(assoc.bgpvpn.type) == bbgp_vpn_type
                    and assoc.bgpvpn.vni is not None)
            ]
            if all_vnis:
                if len(all_vnis) > 1:
                    LOG.warning("multiple VNIs for port %s, using %d",
                                port_info.id, all_vnis[0])
                attach_info['vni'] = all_vnis[0]

        # use the highest local_pref of all associations
        all_local_prefs = [assoc.bgpvpn.local_pref
                           for assoc in assocs
                           if assoc.bgpvpn.local_pref is not None]
        if all_local_prefs:
            attach_info['local_pref'] = max(all_local_prefs)

        attach_info['description'] = {'port': port_info.id}

        # produce attachments
        attachments = []

        # attachment for the port fixed IP
        # except if all routes of all port associations
        # have advertise_fixed_ips = False
        if advertise_fixed_ip(port_info):
            attachment = copy.deepcopy(attach_info)
            attachment['ip_address'] = port_info.ip_address
            attachment['instance_description'] = (
                'BGPVPN %s associations for net %s (%s)' % (
                    bbgp_vpn_type, net_info.id, net_info.gateway_info.ip))
            attachment.update(format_associations_route_targets(assocs))

            attachments.append(attachment)

        # produce one attachment per prefix route address
        # this is to allow a prefix to be exported only toward the BGPVPN
        # of the corresponding association
        for port_assoc in [
                pa for pa in port_info.associations
                if bagpipe_vpn_type(pa.bgpvpn.type) == bbgp_vpn_type]:
            for route in port_assoc.routes:
                attachment = copy.deepcopy(attach_info)
                attachment['vpn_instance_id'] = (
                    vpn_instance_id_for_port_assoc_route(port_assoc, route))
                attachment['direction'] = 'to-port'
                attachment.update(
                    format_associations_route_targets([port_assoc]))
                attachment['local_pref'] = (
                    route.local_pref or port_assoc.bgpvpn.local_pref)

                bgpvpn_desc = port_assoc.bgpvpn.name or port_assoc.bgpvpn.id

                if route.type == bgpvpn_rc.PREFIX_TYPE:
                    attachment['ip_address'] = str(route.prefix)
                    attachment['instance_description'] = (
                        "BGPVPN Port association: prefix route %s to BGPVPN "
                        "%s via port %s (%s)" % (str(route.prefix),
                                                 bgpvpn_desc,
                                                 port_info.id,
                                                 port_info.ip_address))
                    if '/' in str(route.prefix):
                        attachment['advertise_subnet'] = True

                elif route.type == bgpvpn_rc.BGPVPN_TYPE:
                    if not port_assoc.advertise_fixed_ips:
                        LOG.warning("ignoring advertise_fixed_ips False for "
                                    "assoc %s, route %s", port_assoc, route)
                    attachment['ip_address'] = port_info.ip_address
                    attachment['instance_description'] = (
                        "BGPVPN Port association: route leaking from %s into "
                        "%s via port %s (%s)" % (route.bgpvpn.name,
                                                 bgpvpn_desc,
                                                 port_info.id,
                                                 port_info.ip_address))
                    attachment['readvertise'] = {
                        'from_rt': (set(route.bgpvpn.route_targets) |
                                    set(route.bgpvpn.import_targets)),
                        'to_rt': (set(port_assoc.bgpvpn.route_targets) |
                                  set(port_assoc.bgpvpn.export_targets))
                    }
                else:
                    LOG.error("unknown type: %s", route.type)

                attachments.append(attachment)

        return attachments

    @log_helpers.log_method_call
    def _build_detach_infos_for_port_assoc(self, port_info, assoc,
                                           specific_route=None):
        detach_infos = []
        bbgp_vpn_type = bagpipe_vpn_type(assoc.bgpvpn.type)
        base = {
            'network_id': port_info.network.id,
            bbgp_vpn_type: self._base_attach_info(port_info, bbgp_vpn_type)
        }

        routes = [specific_route] if specific_route else assoc.routes
        for route in routes:
            detach = copy.deepcopy(base)
            detach[bbgp_vpn_type]['vpn_instance_id'] = (
                vpn_instance_id_for_port_assoc_route(assoc, route))
            if route.type == bgpvpn_rc.PREFIX_TYPE:
                detach[bbgp_vpn_type]['ip_address'] = str(route.prefix)
            elif route.type == bgpvpn_rc.BGPVPN_TYPE:
                detach[bbgp_vpn_type]['ip_address'] = port_info.ip_address
            else:
                LOG.error("unknown type: %s", route.type)
            detach_infos.append(detach)

        if specific_route is None:
            if advertise_fixed_ip(port_info):
                detach = copy.deepcopy(base)
                detach[bbgp_vpn_type]['ip_address'] = port_info.ip_address
                detach_infos.append(detach)

        return detach_infos

    @log_helpers.log_method_call
    def _build_detach_infos(self, port_info, detach_bgpvpn_type=None):
        detach_infos = []

        if not port_info.admin_state_up:
            LOG.debug("port %s admin-state-up False, no attachment",
                      port_info.id)
            return {}

        # if an association type is not provided, then detach for all VPN types
        # of all the associations relevant for the port
        bgpvpn_types = set([detach_bgpvpn_type] if detach_bgpvpn_type
                           else [assoc.bgpvpn.type for assoc in
                                 port_info.all_associations])

        # associations for the network
        detach_info = {}
        for assoc_type in bgpvpn_types:
            if (assoc_type == bgpvpn.BGPVPN_L3 and
                    not advertise_fixed_ip(port_info)):
                continue
            bbgp_vpn_type = bagpipe_vpn_type(assoc_type)
            detach_info.update({
                bbgp_vpn_type: self._base_attach_info(port_info,
                                                      bbgp_vpn_type)
            })
            detach_info[bbgp_vpn_type]['ip_address'] = port_info.ip_address
        if detach_info:
            detach_info['network_id'] = port_info.network.id
            detach_infos.append(detach_info)

        # port associations
        for assoc_type in bgpvpn_types:
            for association in set(port_info.associations):
                if association.bgpvpn.type == assoc_type:
                    detach_infos.extend(
                        self._build_detach_infos_for_port_assoc(port_info,
                                                                association))

        # detach information for BGPVPN leaks
        # FIXME: this should only be done this when detaching all endpoints
        # Need to handle the casse where:
        # - only one bgpvpn leaking route is removed
        # - one association is removed
        for port_assoc in port_info.associations:
            for route in [route for route in port_assoc.routes
                          if route['type'] == bgpvpn_rc.BGPVPN_TYPE]:
                detach_info = {
                    bbgp_vpn_type: self._base_attach_info(port_info,
                                                          bbgp_vpn_type)
                }
                detach_info[bbgp_vpn_type]['vpn_instance_id'] = (
                    vpn_instance_id_for_port_assoc_route(port_assoc, route))
                detach_info[bbgp_vpn_type]['ip_address'] = port_info.ip_address
                detach_infos.append(detach_info)

        LOG.debug("detach_infos: %s", detach_infos)
        return detach_infos
