Adding PCI module

avocado.utils.pci: Adds pci related modules.
Signed-off-by: NNarasimhan V <sim@linux.vnet.ibm.com>

avocado/utils/pci.py

+# 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; either version 2 of the License, or
+# (at your option) any later version.
+#
+# 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 LICENSE for more details.
+#
+# Copyright: 2016 IBM
+# Author: Narasimhan V <sim@linux.vnet.ibm.com>
+#
+# Author: Kleber Sacilotto de Souza <klebers@linux.vnet.ibm.com>
+# Author: Daniel Kreling <kreling@linux.vnet.ibm.com>
+# for get_memory_address() and get_mask()
+
+"""
+Module for all PCI devices related functions.
+"""
+
+
+import re
+import os
+from genio import read_file
+from . import process
+
+
+def get_domains():
+    """
+    Gets all pci domains.
+    Example, it returns ['0000', '0001', ...]
+
+    :return: List of pci domains.
+    """
+    cmd = "lspci -D"
+    output = process.system_output(cmd, ignore_status=True)
+    if output:
+        domains = []
+        for line in output.splitlines():
+            domains.append(line.split(":")[0])
+        return list(set(domains))
+
+
+def get_pci_addresses():
+    """
+    Gets list of pci addresses in the system.
+    Does not return the PCI Bridges/Switches.
+
+    :return: list of pci addresses.
+    """
+    addresses = []
+    cmd = "lspci -D"
+    for line in process.system_output(cmd).splitlines():
+        if "PCI bridge" not in line:
+            addresses.append(line.split()[0])
+    if addresses:
+        return addresses
+
+
+def get_num_devices_in_domain(domain):
+    """
+    Gets number of devices in a pci domain.
+
+    :parm domain: pci domain.
+
+    :return: number of devices in a pci domain.
+    """
+    cmd = "ls -l /sys/class/*/ -1"
+    output = process.system_output(cmd, ignore_status=True)
+    if output:
+        domain = '/%s' % domain
+        count = 0
+        for line in output.splitlines():
+            if domain in line:
+                count += 1
+        return count
+
+
+def get_disks_in_pci_address(pci_address):
+    """
+    Gets disks in a pci_address.
+
+    :parm pci_address: pci address.
+
+    :return: list of disks in a pci address.
+    """
+    disks_path = "/dev/disk/by-path/"
+    disk_list = []
+    for dev in os.listdir(disks_path):
+        if pci_address in dev:
+            link = os.readlink(os.path.join(disks_path, dev))
+            disk_list.append(os.path.abspath(os.path.join(disks_path, link)))
+    return disk_list
+
+
+def get_nics_in_pci_address(pci_address):
+    """
+    Gets network interface(nic) in a pci address.
+
+    :parm pci_address: pci address.
+
+    :return: list of network interfaces in a pci address.
+    """
+    iface_path = "/sys/class/net/"
+    net_interfaces_list = []
+    for iface in os.listdir(iface_path):
+        if pci_address in os.readlink("%s%s" % (iface_path, iface)):
+            net_interfaces_list.append(iface)
+    return net_interfaces_list
+
+
+def get_pci_fun_list(pci_address):
+    """
+    Gets list of functions in the given pci address.
+    Example: in address 0000:03:00, functions are 0000:03:00.0 and 0000:03:00.1
+
+    :parm pci_address: pci address.
+
+    :return: list of functions in a pci address.
+    """
+    return list(dev for dev in get_pci_addresses() if pci_address in dev)
+
+
+def get_slot_from_sysfs(pci_address):
+    """
+    Gets the pci slot of given address.
+
+    :note: Specific for ppc64 processor.
+
+    :parm pci_address: pci address.
+
+    :return: slot of pci address from sysfs.
+    """
+    if not os.path.isdir('/sys/bus/pci/devices/%s' % pci_address):
+        return
+    devspec = read_file("/sys/bus/pci/devices/%s/devspec" % pci_address)
+    if not os.path.isfile("/proc/device-tree/%s/ibm,loc-code" % devspec):
+        return
+    slot = read_file("/proc/device-tree/%s/ibm,loc-code" % devspec)
+    return re.match(r'((\w+)[\.])+(\w+)-(\w*\d+)-(\w*\d+)|Slot(\d+)',
+                    slot).group()
+
+
+def get_slot_list():
+    """
+    Gets list of pci slots in the system.
+
+    :note: Specific for ppc64 processor.
+
+    :return: list of slots in the system.
+    """
+    return list(set(get_slot_from_sysfs(dev) for dev in get_pci_addresses()))
+
+
+def get_pci_id_from_sysfs(pci_address):
+    """
+    Gets the pci id from sysfs of given pci address.
+
+    :parm pci_address: pci address.
+
+    :return: pci id of a pci address from sysfs.
+    """
+    path = "/sys/bus/pci/devices/%s" % pci_address
+    if os.path.isdir(path):
+        path = "%s/%%s" % path
+        return ":".join(["%04x" % int(open(path % param).read(), 16)
+                         for param in ['vendor', 'device', 'subsystem_vendor',
+                                       'subsystem_device']])
+
+
+def get_pci_prop(pci_address, prop):
+    """
+    Gets specific pci id of given pci address.
+
+    :parm pci_address: pci address.
+    :parm part: prop of pci id.
+
+    :return: specific pci id of a pci address.
+    """
+    cmd = "lspci -Dnvmm -s %s" % pci_address
+    output = process.system_output(cmd, ignore_status=True)
+    if output:
+        for line in output.splitlines():
+            if prop == line.split(':')[0]:
+                return line.split()[-1]
+
+
+def get_pci_id(pci_address):
+    """
+    Gets pci id of given address.
+
+    :parm pci_address: pci address.
+
+    :return: pci id of a pci address.
+    """
+    pci_id = []
+    for params in ['Vendor', 'Device', 'SVendor', 'SDevice']:
+        output = get_pci_prop(pci_address, params)
+        if not output:
+            return
+        pci_id.append(output)
+    if pci_id:
+        return ":".join(pci_id)
+
+
+def get_driver(pci_address):
+    """
+    Gets the kernel driver in use of given pci address.
+
+    :parm pci_address: pci address.
+
+    :return: driver of a pci address.
+    """
+    cmd = "lspci -ks %s" % pci_address
+    output = process.system_output(cmd, ignore_status=True)
+    if output:
+        for line in output.splitlines():
+            if 'Kernel driver in use:' in line:
+                return line.rsplit(None, 1)[-1]
+
+
+def get_memory_address(pci_address):
+    """
+    Gets the memory address of a pci address.
+
+    :note: There may be multiple memory address for a pci address.
+    :note: This function returns only the first such address.
+
+    :parm pci_address: pci address.
+
+    :return: memory address of a pci_address.
+    """
+    cmd = "lspci -bv -s %s" % pci_address
+    output = process.system_output(cmd, ignore_status=True)
+    if output:
+        for line in output.splitlines():
+            if 'Memory at' in line:
+                return "0x%s" % line.split()[2]
+
+
+def get_mask(pci_address):
+    """
+    Gets the mask of pci address.
+
+    :note: There may be multiple memory entries for a pci address.
+    :note: This mask is calculated only with the first such entry.
+
+    :parm pci_address: pci address.
+
+    :return: mask of a pci address.
+    """
+    cmd = "lspci -vv -s %s" % pci_address
+    output = process.system_output(cmd, ignore_status=True)
+    if output:
+        dic = {'K': 1024, 'M': 1048576, 'G': 1073741824}
+        for line in output.splitlines():
+            if 'Region' in line and 'Memory at' in line:
+                val = line.split('=')[-1].split(']')[0]
+                memory_size = int(val[:-1]) * dic[val[-1]]
+                break
+        # int("0xffffffff", 16) = 4294967295
+        mask = hex((memory_size - 1) ^ 4294967295)
+        return mask
+
+
+def get_vpd(pci_addr):
+    """
+    Gets the vpd of the given pci address.
+    lsvpd lists the Vital Product Data of a pci address.
+
+    :note: Specific for ppc64 processor.
+
+    :parm pci_addr: pci address.
+
+    :return: dictionary of vpd of a pci address.
+    """
+    cmd = "lsvpd -l %s" % pci_addr
+    vpd = process.system_output(cmd)
+    vpd_dic = {}
+    dev_list = []
+    for line in vpd.splitlines():
+        if len(line) < 5:
+            continue
+        if '*YL' in line:
+            vpd_dic['slot'] = line[4:]
+        elif '*DS' in line:
+            vpd_dic['pci_id'] = line[4:]
+        elif '*FC' in line:
+            vpd_dic['feature_code'] = line[4:]
+        elif '*AX' in line:
+            if not (pci_addr in line or vpd_dic['pci_id'].split()[0] in line):
+                dev_list.append(line[4:])
+    vpd_dic['devices'] = dev_list
+    return vpd_dic
+
+
+def get_cfg(pci_addr):
+    """
+    Gets the cfg data of the given pci address.
+    lscfg lists the hardware configuration of a pci address.
+
+    :note: Specific for ppc64 processor.
+
+    :parm pci_addr: pci address.
+
+    :return: dictionary of cfg data of a pci address.
+    """
+    cmd = "lscfg -vl %s" % pci_addr
+    cfg = process.system_output(cmd)
+    cfg_dic = {}
+    desc = re.match(r'  (%s)( [-\w+,\.]+)+([ \n])+([-\w+, \(\)])+' % pci_addr,
+                    cfg).group()
+    cfg_dic['Description'] = desc
+    for line in cfg.splitlines():
+        if 'Manufacturer Name' in line:
+            cfg_dic['Mfg'] = line.split('.')[-1]
+        if 'Machine Type-Model' in line:
+            cfg_dic['Model'] = line.split('.')[-1]
+        if 'Device Specific' in line:
+            cfg_dic['YC'] = line.split('.')[-1]
+        if 'Location Code' in line:
+            cfg_dic['YL'] = line.split('..')[-1].strip('.')
+    return cfg_dic