# -*- coding: utf-8 -*-

# Copyright 2014 Red Hat, Inc.
#
# 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 glob
import json
import logging
import os
import re
import shutil
import time
import yaml

from os_net_config import common
from os_net_config import sriov_config
from oslo_concurrency import processutils

logger = logging.getLogger(__name__)
# sriov_config service shall be created and enabled so that the various
# SR-IOV PF and VF configurations shall be done during reboot as well using
# sriov_config.py installed in path /usr/bin/os-net-config-sriov
_SRIOV_CONFIG_SERVICE_FILE = "/etc/systemd/system/sriov_config.service"
_SRIOV_CONFIG_DEVICE_CONTENT = """[Unit]
Description=SR-IOV numvfs configuration
After=systemd-udev-settle.service openibd.service
Before=network-pre.target  openvswitch.service

[Service]
Type=oneshot
ExecStart=/usr/bin/os-net-config-sriov -d

[Install]
WantedBy=basic.target
"""

# dcb_config service shall be created and enabled so that the various
# dcb configurations shall be done during reboot as well using
# dcb_config.py installed in path /usr/bin/os-net-config-dcb
_DCB_CONFIG_SERVICE_FILE = \
    '/etc/systemd/system/os-net-config-dcb-config.service'
_DCB_CONFIG_DEVICE_CONTENT = """[Unit]
Description=DCB configuration
After=NetworkManager

[Service]
Type=oneshot
ExecStart=/usr/bin/os-net-config-dcb

[Install]
WantedBy=basic.target
"""

# VPP startup operational configuration file. The content of this file will
# be executed when VPP starts as if typed from CLI.
_VPP_EXEC_FILE = '/etc/vpp/vpp-exec'


class InvalidInterfaceException(ValueError):
    pass


class VppException(ValueError):
    pass


class ContrailVrouterException(ValueError):
    pass


def write_config(filename, data):
    with open(filename, 'w') as f:
        f.write(str(data))


def is_active_nic(interface_name):
    return _is_available_nic(interface_name, True)


def is_real_nic(interface_name):
    if interface_name == 'lo':
        return True

    device_dir = common.get_dev_path(interface_name, '_device')
    has_device_dir = os.path.isdir(device_dir)

    address = None
    try:
        with open(common.get_dev_path(interface_name, "_address"), 'r') as f:
            address = f.read().rstrip()
    except IOError:
        return False

    if has_device_dir and address:
        return True
    else:
        return False


def _is_available_nic(interface_name, check_active=True):
    try:
        if interface_name == 'lo':
            return False

        if not is_real_nic(interface_name):
            return False

        operstate = None
        with open(common.get_dev_path(interface_name, '_operstate'),
                  'r') as f:
            operstate = f.read().rstrip().lower()
        if check_active and operstate != 'up':
            return False

        # If SR-IOV Virtual Functions (VF) are enabled in an interface, there
        # will be additional nics created for each VF. It has to be ignored in
        # the nic numbering. All the VFs will have a reference to the PF with
        # directory name as 'physfn', if this directory is present it should be
        # ignored.
        if common.is_vf_by_name(interface_name):
            return False

        # nic is available
        return True

    except IOError:
        return False


def _natural_sort_key(s):
    nsre = re.compile('([0-9]+)')
    return [int(text) if text.isdigit() else text
            for text in re.split(nsre, s)]


def _is_embedded_nic(nic):
    if nic.startswith('em') or nic.startswith('eth') or nic.startswith('eno'):
        return True
    return False


def ordered_available_nics():
    return _ordered_nics(False)


def ordered_active_nics():
    return _ordered_nics(True)


def _ordered_nics(check_active):
    embedded_nics = []
    nics = []
    logger.info("Finding active nics")
    for name in glob.iglob(common.SYS_CLASS_NET + '/*'):
        nic = name[(len(common.SYS_CLASS_NET) + 1):]
        if _is_available_nic(nic, check_active):
            if _is_embedded_nic(nic):
                logger.info("%s: an embedded active nic", nic)
                embedded_nics.append(nic)
            else:
                logger.info("%s: an active nic", nic)
                nics.append(nic)
        else:
            logger.info("%s: not an active nic", nic)

    # Adding nics which are bound to DPDK as it will not be found in '/sys'
    # after it is bound to DPDK driver.
    contents = common.get_file_data(common.DPDK_MAPPING_FILE)
    if contents:
        dpdk_map = yaml.safe_load(contents)
        for item in dpdk_map:
            # If the DPDK drivers are bound to a VF, the same needs
            # to be skipped for the NIC ordering
            nic = item['name']
            if common.is_vf(item['pci_address']):
                logger.info("%s: a VF, skipping it for NIC ordering", nic)
            elif common.is_vf_by_name(nic, True):
                logger.info("%s: a VF, skipping it for NIC ordering", nic)
            elif _is_embedded_nic(nic):
                logger.info("%s: an embedded DPDK bound nic", nic)
                if nic not in embedded_nics:
                    embedded_nics.append(nic)
            else:
                logger.info("%s: an DPDK bound nic", nic)
                if nic not in nics:
                    nics.append(nic)
    else:
        logger.info(
            "No DPDK mapping available in path %s", common.DPDK_MAPPING_FILE
        )
    pfs = common.get_sriov_pfs()
    for pf in pfs:
        if _is_embedded_nic(pf["name"]):
            logger.info("%s: an embedded nic configured as PF", pf["name"])
            if pf["name"] not in embedded_nics:
                embedded_nics.append(pf["name"])
        else:
            logger.info("%s: SR-IOV configured nic", pf["name"])
            if pf["name"] not in nics:
                nics.append(pf["name"])

    # NOTE: we could just natural sort all active devices,
    # but this ensures em, eno, and eth are ordered first
    # (more backwards compatible)
    active_nics = (sorted(embedded_nics, key=_natural_sort_key) +
                   sorted(nics, key=_natural_sort_key))
    logger.info("Active nics: %s", active_nics)
    return active_nics


def diff(filename, data):
    file_data = common.get_file_data(filename)
    logger.debug("Diff file data:\n%s", file_data)
    logger.debug("Diff data:\n%s", data)
    # convert to string as JSON may have unicode in it
    return not file_data == data


def update_dpdk_map(ifname, driver):
    noop = common.get_noop()
    pci_address = common.get_pci_address(ifname)
    # pci address could be fetched before setting the override.
    # Update the dpdk map with the PCI address, so that the succesive
    # runs of os-net-config could fetch the pci address from the dpdk map
    if pci_address and not noop:
        mac_address = common.interface_mac(ifname)
        _update_dpdk_map(ifname, pci_address, mac_address, driver)


def unbind_dpdk_interfaces(pci_address):
    iface_driver = common.get_pci_device_driver(pci_address)
    if iface_driver == "vfio-pci":
        return common.unset_driverctl_override(pci_address)
    else:
        logger.info(
            "%s: not bound with vfio-pci and hence not removing the override",
            pci_address,
        )
        return 0


def bind_dpdk_interfaces(ifname, driver, noop):
    if common.is_mellanox_interface(ifname) and 'vfio-pci' in driver:
        msg = ("For Mellanox NIC %s, the default driver vfio-pci "
               "needs to be overridden" % ifname)
        raise common.OvsDpdkBindException(msg)

    if noop:
        logger.info(
            "%s: Interface is bound to DPDK driver %s", ifname, driver
        )
        return
    pci_address = common.get_pci_address(ifname)
    if pci_address:
        # modbprobe of the driver has to be done before binding.
        # for reboots, puppet will add the modprobe to /etc/rc.modules
        iface_driver = common.get_pci_device_driver(pci_address)
        if iface_driver == driver:
            logger.info("%s: Driver %s is already bound", ifname, driver)
            return
        if 'vfio-pci' in driver:
            try:
                processutils.execute('modprobe', 'vfio-pci')
            except processutils.ProcessExecutionError:
                msg = "Failed to modprobe vfio-pci module"
                raise common.OvsDpdkBindException(msg)

        mac_address = common.interface_mac(ifname)
        vendor_id = common.get_vendor_id(ifname)
        err = common.set_driverctl_override(pci_address, driver)
        if not err:
            _update_dpdk_map(ifname, pci_address, mac_address, driver)
            # Not like other nics, beacause mellanox nics keep the
            # interface after binding it to dpdk, so we are adding
            # ethtool command with 10 attempts after binding the driver
            # just to make sure that the interface is initialized
            # successfully in order not to fail in each of this cases:
            # - get_dpdk_devargs() in case of OvsDpdkPort and
            #   OvsDpdkBond.
            # - bind_dpdk_interface() in case of OvsDpdkBond.
            if vendor_id == common.MLNX_VENDOR_ID:
                processutils.execute('ethtool', '-i', ifname, attempts=10)
    else:
        # Check if the pci address is already fetched and stored.
        # If the pci address could not be fetched from dpdk_mapping.yaml
        # raise OvsDpdkBindException, since the interface is neither
        # available nor bound with dpdk.
        msg = "Interface %s cannot be found" % ifname
        raise common.OvsDpdkBindException(msg)


def is_pci_address_format(identifier):
    """Check if identifier matches PCI address format.

    PCI address format: DDDD:BB:DD.F
    Where:
    - DDDD: 4-digit domain (0000-FFFF)
    - BB: 2-digit bus (00-FF)
    - DD: 2-digit device (00-1F, max 31)
    - F: 1-digit function (0-7, max 7)

    Maximum valid entry: FFFF:FF:1F:7

    :param identifier: String to check
    :returns: True if matches PCI address format, False otherwise
    """
    if not isinstance(identifier, str):
        return False

    # PCI address pattern with proper value constraints
    # Domain: 0000-FFFF, Bus: 00-FF, Device: 00-1F, Function: 0-7
    pci_pattern = (r'^[0-9a-fA-F]{4}:[0-9a-fA-F]{2}:'
                   r'(?:[01][0-9a-fA-F])\.[0-7]$')
    return bool(re.match(pci_pattern, identifier))


def remove_dpdk_interface(identifier):
    """Remove a DPDK interface by name or PCI address.

    Detach and unbind the interface if found.

    :param identifier: Interface name or PCI address
    """
    logger.info("%s: Removing DPDK interface", identifier)
    if is_pci_address_format(identifier):
        pci_address = identifier
    else:
        pci_address = common.get_dpdk_pci_address(identifier)

    if pci_address:
        # Attempt to detach the interface
        detach_result = detach_dpdk_interfaces(pci_address)
        if detach_result == 1:
            # Other detach error - log warning but continue
            logger.warning(
                "%s: Failed to detach dpdk interface, continuing with unbind",
                identifier,
            )
        # detach_result == 0 means success (or device already detached),
        # continue normally
        # Attempt to unbind the interface
        unbind_result = unbind_dpdk_interfaces(pci_address)
        if unbind_result:
            logger.error(
                "%s: Failed to unbind dpdk interface",
                identifier,
            )
            # Don't cleanup map entry if unbind failed
            return

        # Only cleanup map entry if unbind was successful
        logger.info("%s: Successfully removed DPDK interface", identifier)
        delete_dpdk_map_entry(identifier)
    else:
        logger.error("%s: could not find PCI address", identifier)


def delete_dpdk_map_entry(identifier):
    """Remove a DPDK mapping entry by interface name or PCI address.

    If the resulting map is empty, remove the DPDK_MAPPING_FILE.

    :param identifier: Interface name or PCI address to remove
    """
    dpdk_map = common.get_dpdk_map()
    new_map = []
    removed = False
    for item in dpdk_map:
        if (item.get("name") == identifier or
                item.get("pci_address") == identifier):
            logger.info(
                "%s: Removing DPDK mapping entry (name: %s, pci: %s)",
                identifier, item.get("name"), item.get("pci_address")
            )
            removed = True
            continue  # Skip this entry
        new_map.append(item)
    if not new_map:
        if os.path.exists(common.DPDK_MAPPING_FILE):
            logger.info(
                "DPDK mapping file %s is empty after removing '%s', "
                "deleting the file.",
                common.DPDK_MAPPING_FILE,
                identifier,
            )
            os.remove(common.DPDK_MAPPING_FILE)
    else:
        common.write_yaml_config(common.DPDK_MAPPING_FILE, new_map)
    if not removed:
        logger.warning(
            "%s: No DPDK mapping entry found in the mapping file.",
            identifier
        )


def _handle_dpdk_detach_error(pci_address,
                              error_msg,
                              attempt,
                              max_retries,
                              retry_delay):
    """Handle DPDK detach error message and return action.

    :param pci_address: PCI address being processed
    :param error_msg: Error message to analyze
    :param attempt: Current attempt number
    :param max_retries: Maximum retry attempts
    :param retry_delay: Delay between retries in seconds
    :returns: 'retry' to continue loop, 'success' for return 0,
              'error' for return 1
    """
    # Device not found in DPDK
    if "not found in DPDK" in error_msg:
        logger.info("%s: Device is already detached", pci_address)
        return 'success'

    # Device is being used by interfaces
    if "is being used by the following interfaces:" in error_msg:
        if attempt < max_retries:
            logger.warning(
                "%s: Device is being used by other interfaces. "
                "Retrying in %d seconds (attempt %d/%d)",
                pci_address, retry_delay, attempt + 1, max_retries
            )
            time.sleep(retry_delay)
            return 'retry'

    # Other errors or max retries exceeded
    logger.error("%s: Detach failed with error: %s", pci_address, error_msg)
    return 'error'


def detach_dpdk_interfaces(pci_address):
    """Detach DPDK interface from OVS bridge.

    :param pci_address: PCI address of the interface to detach
    :returns: 0 on success, 1 on device in use
    """
    cmd = ["ovs-appctl", "netdev-dpdk/detach", pci_address]
    max_retries = 5
    retry_delay = 2  # seconds

    for attempt in range(max_retries + 1):  # 0 to 5 (6 total attempts)
        try:
            logger.info("%s: running %s", pci_address, " ".join(cmd))

            out, err = processutils.execute(*cmd)
            if err:
                action = _handle_dpdk_detach_error(
                    pci_address, err.strip(), attempt, max_retries, retry_delay
                )
                if action == 'success':
                    return 0
                elif action == 'retry':
                    continue
                elif action == 'error':
                    return 1

            logger.info("%s: Successfully detached from DPDK", pci_address)
            return 0

        except processutils.ProcessExecutionError as exc:
            error_output = str(exc.stderr) if exc.stderr else str(exc)
            action = _handle_dpdk_detach_error(
                pci_address, error_output, attempt, max_retries, retry_delay
            )
            if action == 'success':
                return 0
            elif action == 'retry':
                continue
            elif action == 'error':
                return 1

    # If we exit the loop after max retries on stderr "device in use"
    logger.error(
        "%s: Device is still being used by other interfaces after %d retries",
        pci_address, max_retries
    )
    return 1


def translate_ifname_to_pci_address(ifname, noop):
    pci_address = common.get_pci_address(ifname)
    if pci_address and not noop:
        mac_address = common.interface_mac(ifname)
        _update_dpdk_map(ifname, pci_address, mac_address, driver=None)
    return pci_address


def get_dpdk_devargs(ifname, noop):
    if not noop:
        vendor_id = common.get_vendor_id(ifname)
        device_id = common.get_device_id(ifname)
        if vendor_id == common.MLNX_VENDOR_ID:
            if device_id == "0x1007":
                # Some NICs (i.e. Mellanox ConnectX-3) have only one PCI
                # address associated with multiple ports. Using a PCI
                # device won’t work. Instead, we should use
                # "class=eth,mac=<MAC>"
                logger.info("%s: Get devargs for Mellanox CX3 cards", ifname)
                dpdk_devargs = f"class=eth,mac={common.interface_mac(ifname)}"
            else:
                # Get the PCI address of the devices other than CX-3.
                # It includes the VFs as well. For all Other Mellanox devices
                # the PCI address are not stored in dpdk_mapping.yaml file,
                # so we need to get their pci address from sysfs.
                logger.info(
                    "%s: Fetch the pci address for dpdk devargs", ifname
                )
                dpdk_devargs = common.get_pci_address(ifname)
        else:
            logger.info("%s: Fetch the pci address for dpdk devargs", ifname)
            dpdk_devargs = common.get_pci_address(ifname)
        logger.debug("%s: dpdk devargs = %s", ifname, dpdk_devargs)
        return dpdk_devargs


# Once the interface is bound to a DPDK driver, all the references to the
# interface including '/sys' and '/proc', will be removed. And there is no
# way to identify the nic name after it is bound. So, the DPDK bound nic info
# is stored persistently in DPDK_MAPPING_FILE and is used to for nic numbering
# on subsequent runs of os-net-config.
def _update_dpdk_map(ifname, pci_address, mac_address, driver):
    dpdk_map = common.get_dpdk_map()
    for item in dpdk_map:
        if item['pci_address'] == pci_address:
            item['name'] = ifname
            item['mac_address'] = mac_address
            item['driver'] = driver
            break
    else:
        new_item = {}
        new_item['pci_address'] = pci_address
        new_item['name'] = ifname
        new_item['mac_address'] = mac_address
        new_item['driver'] = driver
        dpdk_map.append(new_item)

    common.write_yaml_config(common.DPDK_MAPPING_FILE, dpdk_map)


def get_totalvfs(iface_name):
    max_vf_path = os.path.join(common.SYS_CLASS_NET,
                               iface_name, 'device/sriov_totalvfs')
    if os.path.exists(max_vf_path):
        try:
            with open(max_vf_path, 'r') as f:
                max_vfs = int(f.read())
                logger.info("%s: sriov_totalvfs=%d", iface_name, max_vfs)
                return max_vfs
        except IOError as exc:
            logger.error(
                "%s: Unable to read total_vfs: %s",
                iface_name,
                exc
            )
            return -1
    logger.info(
        "%s: sriov_totalvfs can't be read. SR-IOV is not enabled.", iface_name
    )
    return -1


def get_sriov_dev_from_pci_address(pci_address):
    sriov_map = common.get_sriov_map()
    for item in sriov_map:
        if item['pci_address'] == pci_address:
            return item
    return None


def get_sriov_dev_from_name(dev_name):
    sriov_map = common.get_sriov_map()
    for item in sriov_map:
        if item['name'] == dev_name:
            return item
    return None


def remove_entries_for_sriov_dev(identifier):
    """Remove SR-IOV mapping entries for a PF and/or VF.

    - If a VF is identifier is given, remove only the VF entry from sriovmap
    - If only a PF is identifier is specified, remove that PF entry
      and all its VF entries.
    - Additionally, if the resulting SR-IOV map becomes empty, delete
      `common.SRIOV_CONFIG_FILE` and disable the `sriov_config` systemd
      service.

    :param identifier: PF/VF selector string in one of the formats

    - "sriov:<pf_name>:<vf_id>" to remove a specific VF entry
    - PCI address (DDDD:BB:DD.F) of PF/VF (to resolve from the SR-IOV map)
    - PF name or VF name (as stored in the SR-IOV map)
    """
    vf_id = None
    dev_item = None
    pf_name = None
    if identifier.startswith("sriov:"):
        pf_name = identifier.split(":")[1]
        vf_id = int(identifier.split(":")[2])
    elif is_pci_address_format(identifier):
        dev_item = get_sriov_dev_from_pci_address(identifier)
    else:
        dev_item = get_sriov_dev_from_name(identifier)

    if dev_item:
        if dev_item["device_type"] == "vf":
            vf_id = int(dev_item.get("device", {}).get("vfid"))
            pf_name = dev_item["device"]["name"]
        else:
            pf_name = dev_item["name"]

    sriov_map = common.get_sriov_map()
    new_map = []
    for item in sriov_map:
        if (item["device_type"] == "vf" and
                item["device"]["name"] == pf_name and
                (vf_id is None or (
                int(item.get("device", {}).get("vfid")) == vf_id))):
            logger.debug(
                "%s: Removing VF %s from sriov_map", pf_name, item["name"]
            )
            continue  # Skip this VF
        if (item["device_type"] == "pf" and
                vf_id is None and item["name"] == pf_name):
            logger.debug("%s: Removing PF from sriov_map", pf_name)
            continue  # Skip this PF
        new_map.append(item)

    # Remove the sriov_map file if it is empty
    if not new_map:
        logger.debug(
            "sriov map file is empty and hence removing %s",
            common.SRIOV_CONFIG_FILE
        )
        try:
            os.remove(common.SRIOV_CONFIG_FILE)
        except OSError:
            logger.error("Failed to remove sriov map file")
            pass
        disable_sriov_config_service()
    else:
        common.write_yaml_config(common.SRIOV_CONFIG_FILE, new_map)


def update_sriov_pf_map(ifname, numvfs, noop, promisc=None,
                        link_mode='legacy', vdpa=False, steering_mode=None,
                        lag_candidate=None, drivers_autoprobe=True,
                        pci_address=None, mac_address=None):
    if noop:
        return
    if common.is_pf_attached_to_guest(ifname):
        logger.info("%s: Attached to guest, skip reading numvfs", ifname)
    else:
        # when the PF is attached to the guest, it will be bound
        # with vfio-pci. and the numvfs could not be read and
        # hence avoid reading the numvfs
        cur_numvfs = sriov_config.get_numvfs(ifname)
        if cur_numvfs > 0 and cur_numvfs != numvfs:
            msg = ("Can't change the numvfs for %s" % ifname)
            raise sriov_config.SRIOVNumvfsException(msg)

    # Allow configuring the sriov map even if the PF is attached to the guest
    sriov_map = common.get_sriov_map()
    for item in sriov_map:
        if item['device_type'] == 'pf' and item['name'] == ifname:
            item['numvfs'] = numvfs
            item['drivers_autoprobe'] = drivers_autoprobe
            item['vdpa'] = vdpa
            if promisc is not None:
                item['promisc'] = promisc
            item['link_mode'] = link_mode
            if steering_mode is not None:
                item['steering_mode'] = steering_mode
            if lag_candidate is not None:
                item['lag_candidate'] = lag_candidate
            if pci_address:
                item['pci_address'] = pci_address
            if mac_address:
                item['mac_address'] = mac_address
            break
    else:
        new_item = {}
        new_item['device_type'] = 'pf'
        new_item['name'] = ifname
        new_item['numvfs'] = numvfs
        new_item['drivers_autoprobe'] = drivers_autoprobe
        new_item['vdpa'] = vdpa
        if promisc is not None:
            new_item['promisc'] = promisc
        new_item['link_mode'] = link_mode
        if steering_mode is not None:
            new_item['steering_mode'] = steering_mode
        if lag_candidate is not None:
            new_item['lag_candidate'] = lag_candidate
        if pci_address:
            new_item['pci_address'] = pci_address
        if mac_address:
            new_item['mac_address'] = mac_address
        sriov_map.append(new_item)

    common.write_yaml_config(common.SRIOV_CONFIG_FILE, sriov_map)


def _set_vf_fields(vf_name, vlan_id, qos, spoofcheck, trust, state, macaddr,
                   promisc, pci_address, min_tx_rate, max_tx_rate, driver):
    vf_configs = {}
    vf_configs['name'] = vf_name
    if vlan_id != 0:
        vf_configs['vlan_id'] = vlan_id
    else:
        vf_configs['vlan_id'] = None
    if qos != 0:
        vf_configs['qos'] = qos
    else:
        vf_configs['qos'] = None
    vf_configs['min_tx_rate'] = min_tx_rate
    vf_configs['max_tx_rate'] = max_tx_rate
    vf_configs['spoofcheck'] = spoofcheck
    vf_configs['trust'] = trust
    vf_configs['state'] = state
    vf_configs['macaddr'] = macaddr
    vf_configs['promisc'] = promisc
    vf_configs['pci_address'] = pci_address
    if driver:
        vf_configs['driver'] = driver
    return vf_configs


def _clear_empty_values(vf_config):
    for (key, val) in list(vf_config.items()):
        if val is None:
            del vf_config[key]


def update_sriov_vf_map(pf_name, vfid, vf_name, vlan_id=0, qos=0,
                        spoofcheck=None, trust=None, state=None, macaddr=None,
                        promisc=None, pci_address=None,
                        min_tx_rate=0, max_tx_rate=0, driver=None):
    sriov_map = common.get_sriov_map()
    for item in sriov_map:
        if (item['device_type'] == 'vf' and
           item['device'].get('name') == pf_name and
           item['device'].get('vfid') == vfid):
            item.update(_set_vf_fields(vf_name, vlan_id, qos, spoofcheck,
                                       trust, state, macaddr, promisc,
                                       pci_address, min_tx_rate, max_tx_rate,
                                       driver))
            _clear_empty_values(item)
            break
    else:
        new_item = {}
        new_item['device_type'] = 'vf'
        new_item['device'] = {"name": pf_name, "vfid": vfid}
        new_item.update(_set_vf_fields(vf_name, vlan_id, qos, spoofcheck,
                                       trust, state, macaddr, promisc,
                                       pci_address, min_tx_rate, max_tx_rate,
                                       driver))
        _clear_empty_values(new_item)
        sriov_map.append(new_item)

    common.write_yaml_config(common.SRIOV_CONFIG_FILE, sriov_map)


def _get_vf_name_from_map(pf_name, vfid):
    sriov_map = common.get_sriov_map()
    for item in sriov_map:
        if (item['device_type'] == 'vf' and
           item['device'].get('name') == pf_name and
           item['device'].get('vfid') == vfid):
            return item['name']


def nicpart_udev_rules_check():
    """Clean-up UDEV rules on initial deployment

     After writing sriov_config.yaml file, clean-up
     UDEV rule(s) of PF for which VFs are used by host
    """
    if not os.path.exists(sriov_config._UDEV_LEGACY_RULE_FILE):
        return

    udev = '^KERNEL=="(.*)", RUN.*'
    udev_reg = re.compile(udev, 0)

    with open(sriov_config._UDEV_LEGACY_RULE_FILE, "r") as fp:
        rules = fp.readlines()

    with open(sriov_config._UDEV_LEGACY_RULE_FILE, "w") as fp:
        for line in rules:
            match = udev_reg.match(line)
            if match:
                dev_name = match.group(1)
                if not sriov_config.is_partitioned_pf(dev_name):
                    fp.write(line)
            else:
                fp.write(line)


def is_dcb_config_required():
    if os.path.isfile(common.DCB_CONFIG_FILE):
        return True
    return False


def configure_dcb_config_service():
    """Generate the os-net-config-dcb-config.service

     This service shall reconfigure the dcb configuration
     during reboot of the nodes.
    """
    with open(_DCB_CONFIG_SERVICE_FILE, 'w') as f:
        f.write(_DCB_CONFIG_DEVICE_CONTENT)
    processutils.execute('systemctl', 'enable', 'os-net-config-dcb-config')


def _configure_sriov_config_service():
    """Generate the sriov_config.service

     sriov_config service shall configure the numvfs for the SriovPF nics
     during reboot of the nodes.
    """
    with open(_SRIOV_CONFIG_SERVICE_FILE, 'w') as f:
        f.write(_SRIOV_CONFIG_DEVICE_CONTENT)
    processutils.execute('systemctl', 'enable', 'sriov_config')


def disable_sriov_config_service():
    if common.get_noop():
        return
    try:
        processutils.execute("systemctl", "disable", "sriov_config")
    except processutils.ProcessExecutionError as e:
        logger.warning("Failed to disable sriov_config service: %s", e)


def configure_sriov_pfs(execution_from_cli=False, restart_openvswitch=False):
    logger.info("Configuring PFs now")
    sriov_config.configure_sriov_pf(
        execution_from_cli=execution_from_cli,
        restart_openvswitch=restart_openvswitch)
    _configure_sriov_config_service()


def configure_sriov_vfs():
    logger.info("Configuring VFs now")
    sriov_config.configure_sriov_vf()
    nicpart_udev_rules_check()


def get_vf_devname(pf_name, vfid):
    """Get the VF device name

    :params pf_name: PF device name
    :params vfid: VF id for which the name is required
    :returns: VF name
    """
    # Fetch the name of the VF device from the sr-iov config map.
    # If the map does not have the VF name, then the sysfs shall be parsed.
    vf_name = _get_vf_name_from_map(pf_name, vfid)
    if vf_name is not None:
        return vf_name
    vf_path = common.get_dev_path(pf_name, f"virtfn{vfid}/net")
    # The path /sys/class/net/{pf_name}/device/virtfn{vfid}/net/{vf_name}
    # will be available when the default VF driver is bound with the VF.
    # When sriov_drivers_autoprobe=0, the drivers will not be bound with
    # VF by default and hence the path will not be available. In NIC
    # partitioning use cases, the driver will be bound by os-net-config.
    # It is necessary to wait for the above path to be available in order
    # to read the VF name. Few retries are made to check for the existence
    # of the vf_path.
    for i in range(30):
        if os.path.exists(vf_path):
            break
        time.sleep(1)
    else:
        msg = "NIC %s with VF id: %d could not be found" % (pf_name, vfid)
        raise common.SriovVfNotFoundException(msg)

    if os.path.isdir(vf_path):
        vf_nic = os.listdir(vf_path)
    if len(vf_nic) != 1:
        msg = "VF name could not be identified in %s" % vf_path
        raise common.SriovVfNotFoundException(msg)
    # The VF's actual device name shall be the only directory seen in the path
    # /sys/class/net/<pf_name>/device/virtfn<vfid>/net
    return vf_nic[0]


def backup_map_files(backup_path):
    logger.debug("Backing up DPDK, SR-IOV, and mapping files.")
    src_files = [common.DPDK_MAPPING_FILE,
                 common.SRIOV_CONFIG_FILE,
                 sriov_config._UDEV_LEGACY_RULE_FILE
                 ]
    for src in src_files:
        if os.path.exists(src):
            src_name = os.path.basename(src)
            bkup_file = os.path.join(backup_path, src_name)
            logger.info("Copying %s -> %s", src, bkup_file)
            shutil.copy(src, bkup_file)
        else:
            logger.warning("%s does not exist", src)


def get_interface_maxmtu(name):
    """Check if requested interface MTU exceeds allowed max_mtu.

    :param name: Interface name
    :return: True, if mtu exceeds limit. Else False
    """
    noop = common.get_noop()
    cmd = ['ip', '-d', '-j', 'link', 'show', name]
    if not noop:
        try:
            out, err = processutils.execute(*cmd)
            if err:
                logger.info("%s: Unable to get max_mtu : %s", name, err)
                return -1
            if out:
                data = json.loads(out)
                maxmtu = int(data[0].get('max_mtu'))
                if maxmtu is not None:
                    logger.debug("%s: Max MTU supported is %s", name, maxmtu)
                    return maxmtu
        except processutils.ProcessExecutionError as exc:
            # Check if the error is due to device not existing
            if 'does not exist' in str(exc).lower():
                logger.info(
                    "%s: Interface does not exist, skipping MTU validation",
                    name
                )
            else:
                logger.info("%s: Unable to get max_mtu, error: %s", name, exc)
            return -1
    return -1


def restart_vpp(vpp_interfaces):
    for vpp_int in vpp_interfaces:
        if 'vfio-pci' in vpp_int.uio_driver:
            processutils.execute('modprobe', 'vfio-pci')
    logger.info('Restarting VPP')
    processutils.execute('systemctl', 'restart', 'vpp')


def _get_vpp_interface(pci_addr, tries=1, timeout=5):
    """Get VPP interface information from a given PCI address

    From a running VPP instance, attempt to find the interface name and index
    from a given PCI address of a NIC. The index is used to identify VPP bond
    interface associated with the VPP interface.

    :param pci_addr: PCI address to lookup, in the form of DDDD:BB:SS.F, where
                     - DDDD = Domain
                     - BB = Bus Number
                     - SS = Slot number
                     - F = Function
    :param tries: Number of tries for getting vppctl output. Defaults to 1.
    :param timeout: Timeout in seconds between tries. Defaults to 5.
    :return: VPP interface name. None if an interface is not found.
    """
    if not pci_addr:
        return None

    for _ in range(tries):
        try:
            timestamp = time.time()
            processutils.execute('systemctl', 'is-active', 'vpp')
            out, err = processutils.execute('vppctl', 'show', 'interface',
                                            check_exit_code=False)
            logger.debug("vppctl show interface\n%s\n%s\n", out, err)
            m = re.search(r':([0-9a-fA-F]{2}):([0-9a-fA-F]{2}).([0-9a-fA-F])',
                          pci_addr)
            if m:
                formatted_pci = "%x/%x/%x" % (int(m.group(1), 16),
                                              int(m.group(2), 16),
                                              int(m.group(3), 16))
            else:
                raise VppException('Invalid PCI address format: %s' % pci_addr)

            m = re.search(r'^(\w+%s)\s+(\d+)' % formatted_pci, out,
                          re.MULTILINE)
            if m:
                logger.info(
                    "VPP interface found: %s, index: %s",
                    m.group(1),
                    m.group(2),
                )
                return {'name': m.group(1), 'index': m.group(2)}
        except processutils.ProcessExecutionError:
            pass

        time.sleep(max(0, (timestamp + timeout) - time.time()))
    else:
        logger.info("Interface with pci address %s not bound to vpp", pci_addr)
        return None


def _get_vpp_bond(member_ids):
    """Get VPP bond information from a given list of VPP interface indices

    :param member_ids: list of VPP interfaces indices for the bond
    :return: VPP bond name and index. None if an interface is not found.
    """
    if not member_ids:
        return None

    member_ids.sort()
    member_ids_str = ' '.join(member_ids)

    out, err = processutils.execute('vppctl', 'show',
                                    'hardware-interfaces', 'bond', 'brief',
                                    check_exit_code=False)
    logger.debug("vppctl show hardware-interfaces bond brief\n%s", out)
    m = re.search(r'^\s*(BondEthernet\d+)\s+(\d+)\s+.+Slave-Idx:\s+%s\s*$' %
                  member_ids_str,
                  out,
                  re.MULTILINE)
    if m:
        logger.info("Bond found: %s, index: %s", m.group(1), m.group(2))
        return {'name': m.group(1), 'index': m.group(2)}
    else:
        logger.info(
            'Bond with member indices "%s" not found in VPP', member_ids_str
        )
        return None


def generate_vpp_config(vpp_config_path, vpp_interfaces, vpp_bonds):
    """Generate configuration content for VPP

    Generate interface related configuration content for VPP. Current
    configuration will be preserved, with interface related configurations
    updated or inserted. The config only affects 'dpdk' section of VPP config
    file, and only those lines affecting interfaces, specifically, lines
    containing the following:
    dpdk {
      ...
      dev <pci_dev> {<options>}
      uio-driver <uio_driver_name>
      ...
    }

    :param vpp_config_path: VPP Configuration file path
    :param vpp_interfaces: List of VPP interface objects
    :param vpp_bonds: List of VPP bond objects
    :return: updated VPP config content.
    """

    data = common.get_file_data(vpp_config_path)

    # Add interface config to 'dpdk' section
    for vpp_interface in vpp_interfaces:
        if vpp_interface.pci_dev:
            logger.info(
                "vpp interface %s pci dev: %s",
                vpp_interface.name,
                vpp_interface.pci_dev,
            )

            if vpp_interface.options:
                int_cfg = '%s {%s}' % (vpp_interface.pci_dev,
                                       vpp_interface.options)
            else:
                int_cfg = vpp_interface.pci_dev

            # Make sure 'dpdk' section exists in the config
            if not re.search(r'^\s*dpdk\s*\{', data, re.MULTILINE):
                data += "\ndpdk {\n}\n"

            # Find existing config line for the device we are trying to
            # configure, the line should look like 'dev <pci_dev>  ...'
            # If such config line is found, we will replace the line with
            # appropriate configuration, otherwise, add a new config line
            # in 'dpdk' section of the config.
            m = re.search(r'^\s*dev\s+%s\s*(\{[^}]*\})?\s*$'
                          % vpp_interface.pci_dev, data,
                          re.IGNORECASE | re.MULTILINE)
            if m:
                data = re.sub(m.group(0), '  dev %s\n' % int_cfg, data,
                              flags=re.MULTILINE)
            else:
                data = re.sub(r'(^\s*dpdk\s*\{)',
                              r'\1\n  dev %s\n' % int_cfg,
                              data,
                              flags=re.MULTILINE)

            if vpp_interface.uio_driver:
                # Check if there is existing uio-driver configuration, if
                # found, the line will be replaced with the appropriate
                # configuration, otherwise, add a new line in 'dpdk' section.
                m = re.search(r'^\s*uio-driver.*$', data, re.MULTILINE)
                if m:
                    data = re.sub(r'^\s*uio-driver.*$', '  uio-driver %s'
                                  % vpp_interface.uio_driver, data,
                                  flags=re.MULTILINE)
                else:
                    data = re.sub(r'(^\s*dpdk\s*\{)',
                                  r'\1\n  uio-driver %s'
                                  % vpp_interface.uio_driver,
                                  data,
                                  flags=re.MULTILINE)
        else:
            raise VppException('Interface %s has no PCI address and is not'
                               ' found in mapping file' % vpp_interface.name)

    # Add bond config to 'dpdk' section
    for vpp_bond in vpp_bonds:
        slave_str = ''
        for member in vpp_bond.members:
            slave_str += ",slave=%s" % member.pci_dev
        if vpp_bond.bonding_options:
            options_str = ',' + vpp_bond.bonding_options.strip(' ,')
        else:
            options_str = ''

        if slave_str:
            m = re.search(r'^\s*vdev\s+%s.*$' % vpp_bond.name,
                          data, re.MULTILINE)
            if m:
                data = re.sub(m.group(0), r'  vdev %s%s%s'
                              % (vpp_bond.name, slave_str, options_str),
                              data)
            else:
                data = re.sub(r'(^\s*dpdk\s*\{)',
                              r'\1\n  vdev %s%s%s'
                              % (vpp_bond.name, slave_str, options_str),
                              data,
                              flags=re.MULTILINE)

    # Add start up script for VPP to config. This script will be executed by
    # VPP on service start.
    if not re.search(r'^\s*unix\s*\{', data, re.MULTILINE):
        data += "\nunix {\n}\n"

    m = re.search(r'^\s*(exec|startup-config).*$',
                  data,
                  re.IGNORECASE | re.MULTILINE)
    if m:
        data = re.sub(m.group(0), '  exec %s' % _VPP_EXEC_FILE, data)
    else:
        data = re.sub(r'(^\s*unix\s*\{)',
                      r'\1\n  exec %s' % _VPP_EXEC_FILE,
                      data,
                      flags=re.MULTILINE)
    # Make sure startup script exists to avoid VPP startup failure.
    open(_VPP_EXEC_FILE, 'a').close()

    return data


def update_vpp_mapping(vpp_interfaces, vpp_bonds):
    """Verify VPP interface binding and update mapping file

    VppException will be raised if interfaces are not properly bound.

    :param vpp_interfaces: List of VPP interface objects
    :param vpp_bonds: List of VPP bond objects
    """
    cli_list = []

    for vpp_int in vpp_interfaces:
        # Try to get VPP interface name. In case VPP service is down
        # for some reason, we will restart VPP and try again. Currently
        # only trying one more time, can turn into a retry_counter if needed
        # in the future.
        for i in range(2):
            int_info = _get_vpp_interface(vpp_int.pci_dev,
                                          tries=12, timeout=5)
            if not int_info:
                restart_vpp(vpp_interfaces)
            else:
                vpp_int.vpp_name = int_info['name']
                vpp_int.vpp_idx = int_info['index']
                break
        else:
            raise VppException('Interface %s with pci address %s not '
                               'bound to vpp'
                               % (vpp_int.name, vpp_int.pci_dev))

        # Generate content of startup script for VPP
        if not vpp_bonds:
            cli_list.append('set interface state %s up'
                            % int_info['name'])
            for address in vpp_int.addresses:
                cli_list.append('set interface ip address %s %s/%s\n'
                                % (int_info['name'], address.ip,
                                   address.prefixlen))

        logger.info(
            "Updating mapping for vpp interface %s:"
            "pci_dev: %s mac address: %s uio driver: %s",
            vpp_int.name,
            vpp_int.pci_dev,
            vpp_int.hwaddr,
            vpp_int.uio_driver,
        )
        _update_dpdk_map(vpp_int.name, vpp_int.pci_dev, vpp_int.hwaddr,
                         vpp_int.uio_driver)

    for vpp_bond in vpp_bonds:
        bond_ids = [member.vpp_idx for member in vpp_bond.members]
        bond_info = _get_vpp_bond(bond_ids)
        if bond_info:
            cli_list.append('set interface state %s up'
                            % bond_info['name'])
            for address in vpp_bond.addresses:
                cli_list.append('set interface ip address %s %s/%s'
                                % (bond_info['name'], address.ip,
                                   address.prefixlen))
        else:
            raise VppException('Bond %s not found in VPP.' % vpp_bond.name)

    vpp_start_cli = common.get_file_data(_VPP_EXEC_FILE)
    for cli_line in cli_list:
        if not re.search(r'^\s*%s\s*$' % cli_line,
                         vpp_start_cli, re.MULTILINE):
            vpp_start_cli += cli_line + '\n'

    if diff(_VPP_EXEC_FILE, vpp_start_cli):
        write_config(_VPP_EXEC_FILE, vpp_start_cli)
        restart_vpp(vpp_interfaces)

    # Enable VPP service to make the VPP interface configuration
    # persistent.
    processutils.execute('systemctl', 'enable', 'vpp')


def is_ovs_installed():
    """Check if OpenVswitch is installed

    Verify that OpenVswitch is installed by checking if
    ovs-appctl is on the system.  If OVS is not installed
    it will limit os-net-config's ability to set up ovs-bonds,
    ovs-bridges etc.
    """
    return os.path.exists("/usr/bin/ovs-appctl")


def iproute2_path():
    """Find 'ip' executable."""
    if os.access('/sbin/ip', os.X_OK):
        ipcmd = '/sbin/ip'
    elif os.access('/usr/sbin/ip', os.X_OK):
        ipcmd = '/usr/sbin/ip'
    else:
        logger.warning("Could not execute /sbin/ip or /usr/sbin/ip")
        return False
    return ipcmd


def ethtool_path():
    """Find 'ethtool' executable."""
    if os.access('/sbin/ethtool', os.X_OK):
        ethtoolcmd = '/sbin/ethtool'
    elif os.access('/usr/sbin/ethtool', os.X_OK):
        ethtoolcmd = '/usr/sbin/ethtool'
    else:
        logger.warning("Could not execute /sbin/ethtool or /usr/sbin/ethtool")
        return False
    return ethtoolcmd


def sysctl_path():
    """Find 'sysctl' executable."""
    if common.get_noop():
        return "/sbin/sysctl"

    if os.access('/sbin/sysctl', os.X_OK):
        sysctlcmd = '/sbin/sysctl'
    elif os.access('/usr/sbin/sysctl', os.X_OK):
        sysctlcmd = '/usr/sbin/sysctl'
    else:
        logger.warning("Could not execute /sbin/sysctl or /usr/sbin/sysctl")
        return ""
    return sysctlcmd


def set_accept_ra_sysctl(iface, noop):
    """Set /proc/sys/net/ipv6/conf/<iface>/accept_ra """
    filename = "/proc/sys/net/ipv6/conf/{}/accept_ra".format(iface)
    logger.info(
        "%s IPV6_FORCE_ACCEPT_RA=no: sysctl net.ipv6.conf.%s.accept_ra=0",
        iface,
        iface
    )
    if not noop:
        # Set sysctl
        if os.path.exists(filename):
            with open(filename, 'w') as f:
                f.write("0")


def write_bonding_masters(bond_name, action="add"):
    """Write to /sys/class/net/bonding_masters to create or remove bond

    :param bond_name: Name of the bonding interface (e.g. bond0)
    :param action: Action to perform - "add" to create, "remove" to delete
    """
    bonding_masters_path = "/sys/class/net/bonding_masters"
    if action == "add":
        write_value = bond_name
        logger.info("Creating bonding interface: %s", bond_name)
    elif action == "remove":
        write_value = "-%s" % bond_name
        logger.info("Removing bonding interface: %s", bond_name)
    else:
        raise ValueError("Action must be 'add' or 'remove', got: %s" % action)

    if not common.get_noop():
        try:
            with open(bonding_masters_path, 'w') as f:
                f.write(write_value)
            logger.debug("Successfully wrote '%s' to %s",
                         write_value, bonding_masters_path)
        except FileNotFoundError:
            logger.warning("Bonding masters file not found: %s",
                           bonding_masters_path)
        except (IOError, OSError) as e:
            logger.error("Failed to write to %s: %s", bonding_masters_path, e)
    else:
        logger.info("NOOP: Would write '%s' to %s",
                    write_value, bonding_masters_path)
