pvc/daemon-common/network.py

#!/usr/bin/env python3

# network.py - PVC client function library, Network fuctions
# Part of the Parallel Virtual Cluster (PVC) system
#
#    Copyright (C) 2018-2024 Joshua M. Boniface <joshua@boniface.me>
#
#    This program is free software: you can redistribute it and/or modify
#    it under the terms of the GNU General Public License as published by
#    the Free Software Foundation, version 3.
#
#    This program is distributed in the hope that it will be useful,
#    but WITHOUT ANY WARRANTY; without even the implied warranty of
#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#    GNU General Public License for more details.
#
#    You should have received a copy of the GNU General Public License
#    along with this program.  If not, see <https://www.gnu.org/licenses/>.
#
###############################################################################

import re

import daemon_lib.common as common


#
# Cluster search functions
#
def getClusterNetworkList(zkhandler):
    # Get a list of VNIs by listing the children of /networks
    vni_list = zkhandler.children("base.network")
    description_list = []
    # For each VNI, get the corresponding description from the data
    for vni in vni_list:
        description_list.append(zkhandler.read(("network", vni)))
    return vni_list, description_list


def searchClusterByVNI(zkhandler, vni):
    try:
        # Get the lists
        vni_list, description_list = getClusterNetworkList(zkhandler)
        # We're looking for UUID, so find that element ID
        index = vni_list.index(vni)
        # Get the name_list element at that index
        description = description_list[index]
    except ValueError:
        # We didn't find anything
        return None

    return description


def searchClusterByDescription(zkhandler, description):
    try:
        # Get the lists
        vni_list, description_list = getClusterNetworkList(zkhandler)
        # We're looking for name, so find that element ID
        index = description_list.index(description)
        # Get the uuid_list element at that index
        vni = vni_list[index]
    except ValueError:
        # We didn't find anything
        return None

    return vni


def getNetworkVNI(zkhandler, network):
    # Validate and obtain alternate passed value
    if network.isdigit():
        net_description = searchClusterByVNI(zkhandler, network)
        net_vni = searchClusterByDescription(zkhandler, net_description)
    else:
        net_vni = searchClusterByDescription(zkhandler, network)
        net_description = searchClusterByVNI(zkhandler, net_vni)

    return net_vni


def getNetworkDescription(zkhandler, network):
    # Validate and obtain alternate passed value
    if network.isdigit():
        net_description = searchClusterByVNI(zkhandler, network)
        net_vni = searchClusterByDescription(zkhandler, net_description)
    else:
        net_vni = searchClusterByDescription(zkhandler, network)
        net_description = searchClusterByVNI(zkhandler, net_vni)

    return net_description


def getNetworkDHCPLeases(zkhandler, vni):
    # Get a list of DHCP leases by listing the children of /networks/<vni>/dhcp4_leases
    leases = zkhandler.children(("network.lease", vni))
    return sorted(leases)


def getNetworkDHCPReservations(zkhandler, vni):
    # Get a list of DHCP reservations by listing the children of /networks/<vni>/dhcp4_reservations
    reservations = zkhandler.children(("network.reservation", vni))
    return sorted(reservations)


def getNetworkACLs(zkhandler, vni, _direction):
    # Get the (sorted) list of active ACLs
    if _direction == "both":
        directions = ["in", "out"]
    else:
        directions = [_direction]

    full_acl_list = []
    for direction in directions:
        unordered_acl_list = zkhandler.children((f"network.rule.{direction}", vni))
        if len(unordered_acl_list) < 1:
            continue

        ordered_acls = dict()
        for acl in unordered_acl_list:
            order = zkhandler.read(
                (f"network.rule.{direction}", vni, "rule.order", acl)
            )
            if order is None:
                continue
            ordered_acls[order] = acl

        for order in sorted(ordered_acls.keys()):
            rule = zkhandler.read((f"network.rule.{direction}", vni, "rule.rule", acl))
            if rule is None:
                continue
            full_acl_list.append(
                {
                    "direction": direction,
                    "order": int(order),
                    "description": ordered_acls[order],
                    "rule": rule,
                }
            )

    return full_acl_list


def getNetworkInformation(zkhandler, vni):
    (
        description,
        nettype,
        mtu,
        domain,
        name_servers,
        ip6_network,
        ip6_gateway,
        dhcp6_flag,
        ip4_network,
        ip4_gateway,
        dhcp4_flag,
        dhcp4_start,
        dhcp4_end,
    ) = zkhandler.read_many(
        [
            ("network", vni),
            ("network.type", vni),
            ("network.mtu", vni),
            ("network.domain", vni),
            ("network.nameservers", vni),
            ("network.ip6.network", vni),
            ("network.ip6.gateway", vni),
            ("network.ip6.dhcp", vni),
            ("network.ip4.network", vni),
            ("network.ip4.gateway", vni),
            ("network.ip4.dhcp", vni),
            ("network.ip4.dhcp_start", vni),
            ("network.ip4.dhcp_end", vni),
        ]
    )

    # Construct a data structure to represent the data
    network_information = {
        "vni": int(vni),
        "description": description,
        "type": nettype,
        "mtu": mtu,
        "domain": domain,
        "name_servers": name_servers.split(","),
        "ip6": {
            "network": ip6_network,
            "gateway": ip6_gateway,
            "dhcp_flag": dhcp6_flag,
        },
        "ip4": {
            "network": ip4_network,
            "gateway": ip4_gateway,
            "dhcp_flag": dhcp4_flag,
            "dhcp_start": dhcp4_start,
            "dhcp_end": dhcp4_end,
        },
    }
    return network_information


def getDHCPLeaseInformation(zkhandler, vni, mac_address):
    # Check whether this is a dynamic or static lease
    if zkhandler.exists(("network.lease", vni, "lease", mac_address)):
        type_key = "lease"
    elif zkhandler.exists(("network.reservation", vni, "reservation", mac_address)):
        type_key = "reservation"
    else:
        return None

    hostname = zkhandler.read(
        (f"network.{type_key}", vni, f"{type_key}.hostname", mac_address)
    )
    ip4_address = zkhandler.read(
        (f"network.{type_key}", vni, f"{type_key}.ip", mac_address)
    )
    if type_key == "lease":
        timestamp = zkhandler.read(
            (f"network.{type_key}", vni, f"{type_key}.expiry", mac_address)
        )
    else:
        timestamp = "static"

    # Construct a data structure to represent the data
    lease_information = {
        "hostname": hostname,
        "ip4_address": ip4_address,
        "mac_address": mac_address,
        "timestamp": timestamp,
    }
    return lease_information


def getACLInformation(zkhandler, vni, direction, acl):
    order = zkhandler.read((f"network.rule.{direction}", vni, "rule.order", acl))
    rule = zkhandler.read((f"network.rule.{direction}", vni, "rule.rule", acl))

    # Construct a data structure to represent the data
    acl_information = {
        "order": order,
        "description": acl,
        "rule": rule,
        "direction": direction,
    }
    return acl_information


def isValidMAC(macaddr):
    allowed = re.compile(
        r"(^([0-9A-F]{2}[:]){5}([0-9A-F]{2})$)", re.VERBOSE | re.IGNORECASE
    )

    if allowed.match(macaddr):
        return True
    else:
        return False


def isValidIP(ipaddr):
    ip4_blocks = str(ipaddr).split(".")
    if len(ip4_blocks) == 4:
        for block in ip4_blocks:
            # Check if number is digit, if not checked before calling this function
            if not block.isdigit():
                return False
            tmp = int(block)
            if 0 > tmp > 255:
                return False
        return True
    return False


#
# Direct functions
#
def add_network(
    zkhandler,
    vni,
    description,
    nettype,
    mtu,
    domain,
    name_servers,
    ip4_network,
    ip4_gateway,
    ip6_network,
    ip6_gateway,
    dhcp4_flag,
    dhcp4_start,
    dhcp4_end,
):
    # Ensure start and end DHCP ranges are set if the flag is set
    if dhcp4_flag and (not dhcp4_start or not dhcp4_end):
        return (
            False,
            "ERROR: DHCPv4 start and end addresses are required for a DHCPv4-enabled network.",
        )

    # Check if a network with this VNI or description already exists
    if zkhandler.exists(("network", vni)):
        return False, 'ERROR: A network with VNI "{}" already exists!'.format(vni)

    for network in zkhandler.children("base.network"):
        network_description = zkhandler.read(("network", network))
        if network_description == description:
            return (
                False,
                'ERROR: A network with description "{}" already exists!'.format(
                    description
                ),
            )

    # We're generating the default gateway to be ip6_network::1/YY
    if ip6_network:
        dhcp6_flag = "True"
        if not ip6_gateway:
            ip6_netpart, ip6_maskpart = ip6_network.split("/")
            ip6_gateway = "{}1".format(ip6_netpart)
    else:
        dhcp6_flag = "False"

    if nettype in ["managed"] and not domain:
        domain = "{}.local".format(description)

    # Add the new network to Zookeeper
    result = zkhandler.write(
        [
            (("network", vni), description),
            (("network.type", vni), nettype),
            (("network.mtu", vni), mtu),
            (("network.domain", vni), domain),
            (("network.nameservers", vni), name_servers),
            (("network.ip6.network", vni), ip6_network),
            (("network.ip6.gateway", vni), ip6_gateway),
            (("network.ip6.dhcp", vni), dhcp6_flag),
            (("network.ip4.network", vni), ip4_network),
            (("network.ip4.gateway", vni), ip4_gateway),
            (("network.ip4.dhcp", vni), dhcp4_flag),
            (("network.ip4.dhcp_start", vni), dhcp4_start),
            (("network.ip4.dhcp_end", vni), dhcp4_end),
            (("network.lease", vni), ""),
            (("network.reservation", vni), ""),
            (("network.rule", vni), ""),
            (("network.rule.in", vni), ""),
            (("network.rule.out", vni), ""),
        ]
    )

    if result:
        return True, 'Network "{}" added successfully!'.format(description)
    else:
        return False, "ERROR: Failed to add network."


def modify_network(
    zkhandler,
    vni,
    description=None,
    mtu=None,
    domain=None,
    name_servers=None,
    ip4_network=None,
    ip4_gateway=None,
    ip6_network=None,
    ip6_gateway=None,
    dhcp4_flag=None,
    dhcp4_start=None,
    dhcp4_end=None,
):
    # Add the modified parameters to Zookeeper
    update_data = list()
    if description is not None:
        update_data.append((("network", vni), description))
    if mtu is not None:
        update_data.append((("network.mtu", vni), mtu))
    if domain is not None:
        update_data.append((("network.domain", vni), domain))
    if name_servers is not None:
        update_data.append((("network.nameservers", vni), name_servers))
    if ip4_network is not None:
        update_data.append((("network.ip4.network", vni), ip4_network))
    if ip4_gateway is not None:
        update_data.append((("network.ip4.gateway", vni), ip4_gateway))
    if ip6_network is not None:
        update_data.append((("network.ip6.network", vni), ip6_network))
        if ip6_network:
            update_data.append((("network.ip6.dhcp", vni), "True"))
        else:
            update_data.append((("network.ip6.dhcp", vni), "False"))
    if ip6_gateway is not None:
        update_data.append((("network.ip6.gateway", vni), ip6_gateway))
    else:
        # If we're changing the network, but don't also specify the gateway,
        # generate a new one automatically
        if ip6_network:
            ip6_netpart, ip6_maskpart = ip6_network.split("/")
            ip6_gateway = "{}1".format(ip6_netpart)
            update_data.append((("network.ip6.gateway", vni), ip6_gateway))
    if dhcp4_flag is not None:
        update_data.append((("network.ip4.dhcp", vni), dhcp4_flag))
    if dhcp4_start is not None:
        update_data.append((("network.ip4.dhcp_start", vni), dhcp4_start))
    if dhcp4_end is not None:
        update_data.append((("network.ip4.dhcp_end", vni), dhcp4_end))

    zkhandler.write(update_data)

    return True, 'Network "{}" modified successfully!'.format(vni)


def remove_network(zkhandler, network):
    # Validate and obtain alternate passed value
    vni = getNetworkVNI(zkhandler, network)
    description = getNetworkDescription(zkhandler, network)
    if not vni:
        return False, 'ERROR: Could not find network "{}" in the cluster!'.format(
            network
        )

    # Delete the configuration
    zkhandler.delete([("network", vni)])

    return True, 'Network "{}" removed successfully!'.format(description)


def add_dhcp_reservation(zkhandler, network, ipaddress, macaddress, hostname):
    # Validate and obtain standard passed value
    net_vni = getNetworkVNI(zkhandler, network)
    if not net_vni:
        return False, 'ERROR: Could not find network "{}" in the cluster!'.format(
            network
        )

    # Use lowercase MAC format exclusively
    macaddress = macaddress.lower()

    if not isValidMAC(macaddress):
        return (
            False,
            'ERROR: MAC address "{}" is not valid! Always use ":" as a separator.'.format(
                macaddress
            ),
        )

    if not isValidIP(ipaddress):
        return False, 'ERROR: IP address "{}" is not valid!'.format(macaddress)

    if zkhandler.exists(("network.reservation", net_vni, "reservation", macaddress)):
        return False, 'ERROR: A reservation with MAC "{}" already exists!'.format(
            macaddress
        )

    # Add the new static lease to ZK
    zkhandler.write(
        [
            (("network.reservation", net_vni, "reservation", macaddress), "static"),
            (
                ("network.reservation", net_vni, "reservation.hostname", macaddress),
                hostname,
            ),
            (("network.reservation", net_vni, "reservation.ip", macaddress), ipaddress),
        ]
    )

    return True, 'DHCP reservation "{}" added successfully!'.format(macaddress)


def remove_dhcp_reservation(zkhandler, network, reservation):
    # Validate and obtain standard passed value
    net_vni = getNetworkVNI(zkhandler, network)
    if not net_vni:
        return False, 'ERROR: Could not find network "{}" in the cluster!'.format(
            network
        )

    match_description = ""

    # Check if the reservation matches a static reservation description, a mac, or an IP address currently in the database
    dhcp4_reservations_list = getNetworkDHCPReservations(zkhandler, net_vni)
    for macaddr in dhcp4_reservations_list:
        hostname = zkhandler.read(
            ("network.reservation", net_vni, "reservation.hostname", macaddr)
        )
        ipaddress = zkhandler.read(
            ("network.reservation", net_vni, "reservation.ip", macaddr)
        )
        if (
            reservation == macaddr
            or reservation == hostname
            or reservation == ipaddress
        ):
            match_description = macaddr
            lease_type_zk = "reservation"
            lease_type_human = "static reservation"

    # Check if the reservation matches a dynamic reservation description, a mac, or an IP address currently in the database
    dhcp4_leases_list = getNetworkDHCPLeases(zkhandler, net_vni)
    for macaddr in dhcp4_leases_list:
        hostname = zkhandler.read(("network.lease", net_vni, "lease.hostname", macaddr))
        ipaddress = zkhandler.read(("network.lease", net_vni, "lease.ip", macaddr))
        if (
            reservation == macaddr
            or reservation == hostname
            or reservation == ipaddress
        ):
            match_description = macaddr
            lease_type_zk = "lease"
            lease_type_human = "dynamic lease"

    if not match_description:
        return (
            False,
            'ERROR: No DHCP reservation or lease exists matching "{}"!'.format(
                reservation
            ),
        )

    # Remove the entry from zookeeper
    zkhandler.delete(
        [
            (
                f"network.{lease_type_zk}",
                net_vni,
                f"{lease_type_zk}",
                match_description,
            ),
        ]
    )

    return True, 'DHCP {} "{}" removed successfully!'.format(
        lease_type_human, match_description
    )


def add_acl(zkhandler, network, direction, description, rule, order):
    # Validate and obtain standard passed value
    net_vni = getNetworkVNI(zkhandler, network)
    if not net_vni:
        return False, 'ERROR: Could not find network "{}" in the cluster!'.format(
            network
        )

    # Check if the ACL matches a description currently in the database
    match_description = ""
    full_acl_list = getNetworkACLs(zkhandler, net_vni, "both")
    for acl in full_acl_list:
        if acl["description"] == description:
            match_description = acl["description"]

    if match_description:
        return False, 'ERROR: A rule with description "{}" already exists!'.format(
            description
        )

    # Change direction to something more usable
    if direction:
        direction = "in"
    else:
        direction = "out"

    # Handle reordering
    full_acl_list = getNetworkACLs(zkhandler, net_vni, direction)
    acl_list_length = len(full_acl_list)
    # Set order to len
    if not order or int(order) > acl_list_length:
        order = acl_list_length
    # Convert passed-in order to an integer
    else:
        order = int(order)

    # Insert into the array at order-1
    full_acl_list.insert(
        order, {"direction": direction, "description": description, "rule": rule}
    )

    # Update the existing ordering
    for idx, acl in enumerate(full_acl_list):
        if acl["description"] == description:
            continue

        if idx == acl["order"]:
            continue
        else:
            zkhandler.write(
                [
                    (
                        (
                            f"network.rule.{direction}",
                            net_vni,
                            "rule.order",
                            acl["description"],
                        ),
                        idx,
                    )
                ]
            )

    # Add the new rule
    zkhandler.write(
        [
            ((f"network.rule.{direction}", net_vni, "rule", description), ""),
            ((f"network.rule.{direction}", net_vni, "rule.order", description), order),
            ((f"network.rule.{direction}", net_vni, "rule.rule", description), rule),
        ]
    )

    return True, 'Firewall rule "{}" added successfully!'.format(description)


def remove_acl(zkhandler, network, description):
    # Validate and obtain standard passed value
    net_vni = getNetworkVNI(zkhandler, network)
    if not net_vni:
        return False, 'ERROR: Could not find network "{}" in the cluster!'.format(
            network
        )

    match_description = ""

    # Check if the ACL matches a description currently in the database
    acl_list = getNetworkACLs(zkhandler, net_vni, "both")
    for acl in acl_list:
        if acl["description"] == description:
            match_description = acl["description"]
            match_direction = acl["direction"]

    if not match_description:
        return (
            False,
            'ERROR: No firewall rule exists matching description "{}"!'.format(
                description
            ),
        )

    # Remove the entry from zookeeper
    zkhandler.delete(
        [(f"network.rule.{match_direction}", net_vni, "rule", match_description)]
    )

    # Update the existing ordering
    updated_acl_list = getNetworkACLs(zkhandler, net_vni, match_direction)
    for idx, acl in enumerate(updated_acl_list):
        if acl["description"] == description:
            continue

        if idx == acl["order"]:
            continue
        else:
            zkhandler.write(
                [
                    (
                        (
                            f"network.rule.{match_direction}",
                            net_vni,
                            "rule.order",
                            acl["description"],
                        ),
                        idx,
                    ),
                ]
            )

    return True, 'Firewall rule "{}" removed successfully!'.format(match_description)


def get_info(zkhandler, network):
    # Validate and obtain alternate passed value
    net_vni = getNetworkVNI(zkhandler, network)
    if not net_vni:
        return False, 'ERROR: Could not find network "{}" in the cluster!'.format(
            network
        )

    network_information = getNetworkInformation(zkhandler, network)
    if not network_information:
        return False, 'ERROR: Could not get information about network "{}"'.format(
            network
        )

    return True, network_information


def get_list(zkhandler, limit, is_fuzzy=True):
    net_list = []
    full_net_list = zkhandler.children("base.network")

    if is_fuzzy and limit:
        # Implicitly assume fuzzy limits
        if not re.match(r"\^.*", limit):
            limit = ".*" + limit
        if not re.match(r".*\$", limit):
            limit = limit + ".*"

    for net in full_net_list:
        description = zkhandler.read(("network", net))
        if limit:
            try:
                if re.fullmatch(limit, net):
                    net_list.append(getNetworkInformation(zkhandler, net))
                if re.fullmatch(limit, description):
                    net_list.append(getNetworkInformation(zkhandler, net))
            except Exception as e:
                return False, "Regex Error: {}".format(e)
        else:
            net_list.append(getNetworkInformation(zkhandler, net))

    return True, net_list


def get_list_dhcp(zkhandler, network, limit, only_static=False, is_fuzzy=True):
    # Validate and obtain alternate passed value
    net_vni = getNetworkVNI(zkhandler, network)
    if not net_vni:
        return False, 'ERROR: Could not find network "{}" in the cluster!'.format(
            network
        )

    dhcp_list = []

    if only_static:
        full_dhcp_list = getNetworkDHCPReservations(zkhandler, net_vni)
    else:
        full_dhcp_list = getNetworkDHCPReservations(zkhandler, net_vni)
        full_dhcp_list += getNetworkDHCPLeases(zkhandler, net_vni)

    if is_fuzzy and limit:
        # Implicitly assume fuzzy limits
        if not re.match(r"\^.*", limit):
            limit = ".*" + limit
        if not re.match(r".*\$", limit):
            limit = limit + ".*"

    for lease in full_dhcp_list:
        valid_lease = False
        if limit:
            if re.fullmatch(limit, lease):
                valid_lease = True
            if re.fullmatch(limit, lease):
                valid_lease = True
        else:
            valid_lease = True

        if valid_lease:
            dhcp_list.append(getDHCPLeaseInformation(zkhandler, net_vni, lease))

    return True, dhcp_list


def get_list_acl(zkhandler, network, limit, direction, is_fuzzy=True):
    # Validate and obtain alternate passed value
    net_vni = getNetworkVNI(zkhandler, network)
    if not net_vni:
        return False, 'ERROR: Could not find network "{}" in the cluster!'.format(
            network
        )

    # Change direction to something more usable
    if direction is None:
        direction = "both"
    elif direction is True:
        direction = "in"
    elif direction is False:
        direction = "out"

    acl_list = []
    full_acl_list = getNetworkACLs(zkhandler, net_vni, direction)

    if is_fuzzy and limit:
        # Implicitly assume fuzzy limits
        if not re.match(r"\^.*", limit):
            limit = ".*" + limit
        if not re.match(r".*\$", limit):
            limit = limit + ".*"

    for acl in full_acl_list:
        valid_acl = False
        if limit:
            if re.fullmatch(limit, acl["description"]):
                valid_acl = True
        else:
            valid_acl = True

        if valid_acl:
            acl_list.append(acl)

    return True, acl_list


#
# SR-IOV functions
#
# These are separate since they don't work like other network types
#
def getSRIOVPFInformation(zkhandler, node, pf):
    mtu = zkhandler.read(("node.sriov.pf", node, "sriov_pf.mtu", pf))

    retcode, vf_list = get_list_sriov_vf(zkhandler, node, pf)
    if retcode:
        vfs = common.sortInterfaceNames([vf["phy"] for vf in vf_list if vf["pf"] == pf])
    else:
        vfs = []

    # Construct a data structure to represent the data
    pf_information = {
        "phy": pf,
        "mtu": mtu,
        "vfs": vfs,
    }
    return pf_information


def get_info_sriov_pf(zkhandler, node, pf):
    pf_information = getSRIOVPFInformation(zkhandler, node, pf)
    if not pf_information:
        return (
            False,
            'ERROR: Could not get information about SR-IOV PF "{}" on node "{}"'.format(
                pf, node
            ),
        )

    return True, pf_information


def get_list_sriov_pf(zkhandler, node):
    pf_list = list()
    pf_phy_list = zkhandler.children(("node.sriov.pf", node))
    for phy in pf_phy_list:
        retcode, pf_information = get_info_sriov_pf(zkhandler, node, phy)
        if retcode:
            pf_list.append(pf_information)

    return True, pf_list


def getSRIOVVFInformation(zkhandler, node, vf):
    if not zkhandler.exists(("node.sriov.vf", node, "sriov_vf", vf)):
        return []

    (
        pf,
        mtu,
        mac,
        vlan_id,
        vlan_qos,
        tx_rate_min,
        tx_rate_max,
        link_state,
        spoof_check,
        trust,
        query_rss,
        pci_domain,
        pci_bus,
        pci_slot,
        pci_function,
        used,
        used_by_domain,
    ) = zkhandler.read_many(
        [
            ("node.sriov.vf", node, "sriov_vf.pf", vf),
            ("node.sriov.vf", node, "sriov_vf.mtu", vf),
            ("node.sriov.vf", node, "sriov_vf.mac", vf),
            ("node.sriov.vf", node, "sriov_vf.config.vlan_id", vf),
            ("node.sriov.vf", node, "sriov_vf.config.vlan_qos", vf),
            ("node.sriov.vf", node, "sriov_vf.config.tx_rate_min", vf),
            ("node.sriov.vf", node, "sriov_vf.config.tx_rate_max", vf),
            ("node.sriov.vf", node, "sriov_vf.config.link_state", vf),
            ("node.sriov.vf", node, "sriov_vf.config.spoof_check", vf),
            ("node.sriov.vf", node, "sriov_vf.config.trust", vf),
            ("node.sriov.vf", node, "sriov_vf.config.query_rss", vf),
            ("node.sriov.vf", node, "sriov_vf.pci.domain", vf),
            ("node.sriov.vf", node, "sriov_vf.pci.bus", vf),
            ("node.sriov.vf", node, "sriov_vf.pci.slot", vf),
            ("node.sriov.vf", node, "sriov_vf.pci.function", vf),
            ("node.sriov.vf", node, "sriov_vf.used", vf),
            ("node.sriov.vf", node, "sriov_vf.used_by", vf),
        ]
    )

    vf_information = {
        "phy": vf,
        "pf": pf,
        "mtu": mtu,
        "mac": mac,
        "config": {
            "vlan_id": vlan_id,
            "vlan_qos": vlan_qos,
            "tx_rate_min": tx_rate_min,
            "tx_rate_max": tx_rate_max,
            "link_state": link_state,
            "spoof_check": spoof_check,
            "trust": trust,
            "query_rss": query_rss,
        },
        "pci": {
            "domain": pci_domain,
            "bus": pci_bus,
            "slot": pci_slot,
            "function": pci_function,
        },
        "usage": {
            "used": used,
            "domain": used_by_domain,
        },
    }
    return vf_information


def get_info_sriov_vf(zkhandler, node, vf):
    # Verify node is valid
    valid_node = common.verifyNode(zkhandler, node)
    if not valid_node:
        return False, 'ERROR: Specified node "{}" is invalid.'.format(node)

    vf_information = getSRIOVVFInformation(zkhandler, node, vf)
    if not vf_information:
        return False, 'ERROR: Could not find SR-IOV VF "{}" on node "{}"'.format(
            vf, node
        )

    return True, vf_information


def get_list_sriov_vf(zkhandler, node, pf=None):
    # Verify node is valid
    valid_node = common.verifyNode(zkhandler, node)
    if not valid_node:
        return False, 'ERROR: Specified node "{}" is invalid.'.format(node)

    vf_list = list()
    vf_phy_list = common.sortInterfaceNames(zkhandler.children(("node.sriov.vf", node)))
    for phy in vf_phy_list:
        retcode, vf_information = get_info_sriov_vf(zkhandler, node, phy)
        if retcode:
            if pf is not None:
                if vf_information["pf"] == pf:
                    vf_list.append(vf_information)
            else:
                vf_list.append(vf_information)

    return True, vf_list


def set_sriov_vf_config(
    zkhandler,
    node,
    vf,
    vlan_id=None,
    vlan_qos=None,
    tx_rate_min=None,
    tx_rate_max=None,
    link_state=None,
    spoof_check=None,
    trust=None,
    query_rss=None,
):
    # Verify node is valid
    valid_node = common.verifyNode(zkhandler, node)
    if not valid_node:
        return False, 'ERROR: Specified node "{}" is invalid.'.format(node)

    # Verify VF is valid
    vf_information = getSRIOVVFInformation(zkhandler, node, vf)
    if not vf_information:
        return False, 'ERROR: Could not find SR-IOV VF "{}" on node "{}".'.format(
            vf, node
        )

    update_list = list()

    if vlan_id is not None:
        update_list.append(
            (("node.sriov.vf", node, "sriov_vf.config.vlan_id", vf), vlan_id)
        )

    if vlan_qos is not None:
        update_list.append(
            (("node.sriov.vf", node, "sriov_vf.config.vlan_qos", vf), vlan_qos)
        )

    if tx_rate_min is not None:
        update_list.append(
            (("node.sriov.vf", node, "sriov_vf.config.tx_rate_min", vf), tx_rate_min)
        )

    if tx_rate_max is not None:
        update_list.append(
            (("node.sriov.vf", node, "sriov_vf.config.tx_rate_max", vf), tx_rate_max)
        )

    if link_state is not None:
        update_list.append(
            (("node.sriov.vf", node, "sriov_vf.config.link_state", vf), link_state)
        )

    if spoof_check is not None:
        update_list.append(
            (("node.sriov.vf", node, "sriov_vf.config.spoof_check", vf), spoof_check)
        )

    if trust is not None:
        update_list.append(
            (("node.sriov.vf", node, "sriov_vf.config.trust", vf), trust)
        )

    if query_rss is not None:
        update_list.append(
            (("node.sriov.vf", node, "sriov_vf.config.query_rss", vf), query_rss)
        )

    if len(update_list) < 1:
        return False, "ERROR: No changes to apply."

    result = zkhandler.write(update_list)
    if result:
        return (
            True,
            'Successfully modified configuration of SR-IOV VF "{}" on node "{}".'.format(
                vf, node
            ),
        )
    else:
        return (
            False,
            'Failed to modify configuration of SR-IOV VF "{}" on node "{}".'.format(
                vf, node
            ),
        )


def set_sriov_vf_vm(zkhandler, vm_uuid, node, vf, vf_macaddr, vf_type):
    # Verify node is valid
    valid_node = common.verifyNode(zkhandler, node)
    if not valid_node:
        return False

    # Verify VF is valid
    vf_information = getSRIOVVFInformation(zkhandler, node, vf)
    if not vf_information:
        return False

    update_list = [
        (("node.sriov.vf", node, "sriov_vf.used", vf), "True"),
        (("node.sriov.vf", node, "sriov_vf.used_by", vf), vm_uuid),
        (("node.sriov.vf", node, "sriov_vf.mac", vf), vf_macaddr),
    ]

    # Hostdev type SR-IOV prevents the guest from live migrating
    if vf_type == "hostdev":
        update_list.append((("domain.meta.migrate_method", vm_uuid), "shutdown"))

    zkhandler.write(update_list)

    return True


def unset_sriov_vf_vm(zkhandler, node, vf):
    # Verify node is valid
    valid_node = common.verifyNode(zkhandler, node)
    if not valid_node:
        return False

    # Verify VF is valid
    vf_information = getSRIOVVFInformation(zkhandler, node, vf)
    if not vf_information:
        return False

    update_list = [
        (("node.sriov.vf", node, "sriov_vf.used", vf), "False"),
        (("node.sriov.vf", node, "sriov_vf.used_by", vf), ""),
        (
            ("node.sriov.vf", node, "sriov_vf.mac", vf),
            zkhandler.read(("node.sriov.vf", node, "sriov_vf.phy_mac", vf)),
        ),
    ]

    zkhandler.write(update_list)

    return True