net/ice/base: introduce and use for each bit iterator

[dpdk.git] / usertools / dpdk-devbind.py

diff --git a/usertools/dpdk-devbind.py b/usertools/dpdk-devbind.py
index d3b1624..094c2ff 100755 (executable)
--- a/usertools/dpdk-devbind.py
+++ b/usertools/dpdk-devbind.py
@@ -3,11 +3,18 @@
 # Copyright(c) 2010-2014 Intel Corporation
 #
 
 # Copyright(c) 2010-2014 Intel Corporation
 #
 

+from __future__ import print_function

 import sys
 import os
 import getopt
 import subprocess
 import sys
 import os
 import getopt
 import subprocess

+from glob import glob

 from os.path import exists, abspath, dirname, basename
 from os.path import exists, abspath, dirname, basename

+from os.path import join as path_join
+
+if sys.version_info.major < 3:
+    print("WARNING: Python 2 is deprecated for use in DPDK, and will not work in future releases.", file=sys.stderr)
+    print("Please use Python 3 instead", file=sys.stderr)

 
 # The PCI base class for all devices
 network_class = {'Class': '02', 'Vendor': None, 'Device': None,
 
 # The PCI base class for all devices
 network_class = {'Class': '02', 'Vendor': None, 'Device': None,


@@ -44,6 +51,8 @@ intel_ioat_bdw = {'Class': '08', 'Vendor': '8086', 'Device': '6f20,6f21,6f22,6f2
               'SVendor': None, 'SDevice': None}
 intel_ioat_skx = {'Class': '08', 'Vendor': '8086', 'Device': '2021',
               'SVendor': None, 'SDevice': None}
               'SVendor': None, 'SDevice': None}
 intel_ioat_skx = {'Class': '08', 'Vendor': '8086', 'Device': '2021',
               'SVendor': None, 'SDevice': None}

+intel_ioat_icx = {'Class': '08', 'Vendor': '8086', 'Device': '0b00',
+              'SVendor': None, 'SDevice': None}

 intel_ntb_skx = {'Class': '06', 'Vendor': '8086', 'Device': '201c',
               'SVendor': None, 'SDevice': None}
 
 intel_ntb_skx = {'Class': '06', 'Vendor': '8086', 'Device': '201c',
               'SVendor': None, 'SDevice': None}
 


@@ -53,7 +62,7 @@ crypto_devices = [encryption_class, intel_processor_class]
 eventdev_devices = [cavium_sso, cavium_tim, octeontx2_sso]
 mempool_devices = [cavium_fpa, octeontx2_npa]
 compress_devices = [cavium_zip]
 eventdev_devices = [cavium_sso, cavium_tim, octeontx2_sso]
 mempool_devices = [cavium_fpa, octeontx2_npa]
 compress_devices = [cavium_zip]

-misc_devices = [intel_ioat_bdw, intel_ioat_skx, intel_ntb_skx, octeontx2_dma]
+misc_devices = [intel_ioat_bdw, intel_ioat_skx, intel_ioat_icx, intel_ntb_skx, octeontx2_dma]

 
 # global dict ethernet devices present. Dictionary indexed by PCI address.
 # Each device within this is itself a dictionary of device properties
 
 # global dict ethernet devices present. Dictionary indexed by PCI address.
 # Each device within this is itself a dictionary of device properties


@@ -82,6 +91,8 @@ Usage:
 where DEVICE1, DEVICE2 etc, are specified via PCI "domain:bus:slot.func" syntax
 or "bus:slot.func" syntax. For devices bound to Linux kernel drivers, they may
 also be referred to by Linux interface name e.g. eth0, eth1, em0, em1, etc.
 where DEVICE1, DEVICE2 etc, are specified via PCI "domain:bus:slot.func" syntax
 or "bus:slot.func" syntax. For devices bound to Linux kernel drivers, they may
 also be referred to by Linux interface name e.g. eth0, eth1, em0, em1, etc.

+If devices are specified using PCI <domain:>bus:device:func format, then
+shell wildcards and ranges may be used, e.g. 80:04.*, 80:04.[0-3]

 
 Options:
     --help, --usage:
 
 Options:
     --help, --usage:


@@ -138,6 +149,9 @@ To unbind 0000:01:00.0 from using any driver
 To bind 0000:02:00.0 and 0000:02:00.1 to the ixgbe kernel driver
         %(argv0)s -b ixgbe 02:00.0 02:00.1
 
 To bind 0000:02:00.0 and 0000:02:00.1 to the ixgbe kernel driver
         %(argv0)s -b ixgbe 02:00.0 02:00.1
 

+To bind all functions on device 0000:02:00 to ixgbe kernel driver
+        %(argv0)s -b ixgbe 02:00.*
+

     """ % locals())  # replace items from local variables
 
 
     """ % locals())  # replace items from local variables
 
 


@@ -152,6 +166,9 @@ def check_output(args, stderr=None):
 def module_is_loaded(module):
     global loaded_modules
 
 def module_is_loaded(module):
     global loaded_modules
 

+    if module == 'vfio_pci':
+        module = 'vfio-pci'
+

     if loaded_modules:
         return module in loaded_modules
 
     if loaded_modules:
         return module in loaded_modules
 


@@ -185,7 +202,7 @@ def check_modules():
 
     # check if we have at least one loaded module
     if True not in [mod["Found"] for mod in mods] and b_flag is not None:
 
     # check if we have at least one loaded module
     if True not in [mod["Found"] for mod in mods] and b_flag is not None:

-        print("Warning: no supported DPDK kernel modules are loaded")
+        print("Warning: no supported DPDK kernel modules are loaded", file=sys.stderr)

 
     # change DPDK driver list to only contain drivers that are loaded
     dpdk_drivers = [mod["Name"] for mod in mods if mod["Found"]]
 
     # change DPDK driver list to only contain drivers that are loaded
     dpdk_drivers = [mod["Name"] for mod in mods if mod["Found"]]


@@ -207,7 +224,7 @@ def get_pci_device_details(dev_id, probe_lspci):
         for line in extra_info:
             if len(line) == 0:
                 continue
         for line in extra_info:
             if len(line) == 0:
                 continue

-            name, value = line.decode().split("\t", 1)
+            name, value = line.decode("utf8").split("\t", 1)

             name = name.strip(":") + "_str"
             device[name] = value
     # check for a unix interface name
             name = name.strip(":") + "_str"
             device[name] = value
     # check for a unix interface name


@@ -253,7 +270,7 @@ def get_device_details(devices_type):
             # Clear previous device's data
             dev = {}
         else:
             # Clear previous device's data
             dev = {}
         else:

-            name, value = dev_line.decode().split("\t", 1)
+            name, value = dev_line.decode("utf8").split("\t", 1)

             value_list = value.rsplit(' ', 1)
             if len(value_list) > 1:
                 # String stored in <name>_str
             value_list = value.rsplit(' ', 1)
             if len(value_list) > 1:
                 # String stored in <name>_str


@@ -352,14 +369,14 @@ def unbind_one(dev_id, force):
     '''Unbind the device identified by "dev_id" from its current driver'''
     dev = devices[dev_id]
     if not has_driver(dev_id):
     '''Unbind the device identified by "dev_id" from its current driver'''
     dev = devices[dev_id]
     if not has_driver(dev_id):

-        print("%s %s %s is not currently managed by any driver\n" %
-              (dev["Slot"], dev["Device_str"], dev["Interface"]))
+        print("Notice: %s %s %s is not currently managed by any driver" %
+              (dev["Slot"], dev["Device_str"], dev["Interface"]), file=sys.stderr)

         return
 
     # prevent us disconnecting ourselves
     if dev["Ssh_if"] and not force:
         return
 
     # prevent us disconnecting ourselves
     if dev["Ssh_if"] and not force:

-        print("Routing table indicates that interface %s is active. "
-              "Skipping unbind" % (dev_id))
+        print("Warning: routing table indicates that interface %s is active. "
+              "Skipping unbind" % dev_id, file=sys.stderr)

         return
 
     # write to /sys to unbind
         return
 
     # write to /sys to unbind


@@ -367,9 +384,8 @@ def unbind_one(dev_id, force):
     try:
         f = open(filename, "a")
     except:
     try:
         f = open(filename, "a")
     except:

-        print("Error: unbind failed for %s - Cannot open %s"
-              % (dev_id, filename))
-        sys.exit(1)
+        sys.exit("Error: unbind failed for %s - Cannot open %s" %
+                 (dev_id, filename))

     f.write(dev_id)
     f.close()
 
     f.write(dev_id)
     f.close()
 


@@ -382,15 +398,15 @@ def bind_one(dev_id, driver, force):
 
     # prevent disconnection of our ssh session
     if dev["Ssh_if"] and not force:
 
     # prevent disconnection of our ssh session
     if dev["Ssh_if"] and not force:

-        print("Routing table indicates that interface %s is active. "
-              "Not modifying" % (dev_id))
+        print("Warning: routing table indicates that interface %s is active. "
+              "Not modifying" % dev_id, file=sys.stderr)

         return
 
     # unbind any existing drivers we don't want
     if has_driver(dev_id):
         if dev["Driver_str"] == driver:
         return
 
     # unbind any existing drivers we don't want
     if has_driver(dev_id):
         if dev["Driver_str"] == driver:

-            print("%s already bound to driver %s, skipping\n"
-                  % (dev_id, driver))
+            print("Notice: %s already bound to driver %s, skipping" %
+                  (dev_id, driver), file=sys.stderr)

             return
         else:
             saved_driver = dev["Driver_str"]
             return
         else:
             saved_driver = dev["Driver_str"]


@@ -410,14 +426,14 @@ def bind_one(dev_id, driver, force):
                 f = open(filename, "w")
             except:
                 print("Error: bind failed for %s - Cannot open %s"
                 f = open(filename, "w")
             except:
                 print("Error: bind failed for %s - Cannot open %s"

-                      % (dev_id, filename))
+                      % (dev_id, filename), file=sys.stderr)

                 return
             try:
                 f.write("%s" % driver)
                 f.close()
             except:
                 print("Error: bind failed for %s - Cannot write driver %s to "
                 return
             try:
                 f.write("%s" % driver)
                 f.close()
             except:
                 print("Error: bind failed for %s - Cannot write driver %s to "

-                      "PCI ID " % (dev_id, driver))
+                      "PCI ID " % (dev_id, driver), file=sys.stderr)

                 return
         # For kernels < 3.15 use new_id to add PCI id's to the driver
         else:
                 return
         # For kernels < 3.15 use new_id to add PCI id's to the driver
         else:


@@ -426,7 +442,7 @@ def bind_one(dev_id, driver, force):
                 f = open(filename, "w")
             except:
                 print("Error: bind failed for %s - Cannot open %s"
                 f = open(filename, "w")
             except:
                 print("Error: bind failed for %s - Cannot open %s"

-                      % (dev_id, filename))
+                      % (dev_id, filename), file=sys.stderr)

                 return
             try:
                 # Convert Device and Vendor Id to int to write to new_id
                 return
             try:
                 # Convert Device and Vendor Id to int to write to new_id


@@ -435,7 +451,7 @@ def bind_one(dev_id, driver, force):
                 f.close()
             except:
                 print("Error: bind failed for %s - Cannot write new PCI ID to "
                 f.close()
             except:
                 print("Error: bind failed for %s - Cannot write new PCI ID to "

-                      "driver %s" % (dev_id, driver))
+                      "driver %s" % (dev_id, driver), file=sys.stderr)

                 return
 
     # do the bind by writing to /sys
                 return
 
     # do the bind by writing to /sys


@@ -444,7 +460,7 @@ def bind_one(dev_id, driver, force):
         f = open(filename, "a")
     except:
         print("Error: bind failed for %s - Cannot open %s"
         f = open(filename, "a")
     except:
         print("Error: bind failed for %s - Cannot open %s"

-              % (dev_id, filename))
+              % (dev_id, filename), file=sys.stderr)

         if saved_driver is not None:  # restore any previous driver
             bind_one(dev_id, saved_driver, force)
         return
         if saved_driver is not None:  # restore any previous driver
             bind_one(dev_id, saved_driver, force)
         return


@@ -459,7 +475,7 @@ def bind_one(dev_id, driver, force):
         if "Driver_str" in tmp and tmp["Driver_str"] == driver:
             return
         print("Error: bind failed for %s - Cannot bind to driver %s"
         if "Driver_str" in tmp and tmp["Driver_str"] == driver:
             return
         print("Error: bind failed for %s - Cannot bind to driver %s"

-              % (dev_id, driver))
+              % (dev_id, driver), file=sys.stderr)

         if saved_driver is not None:  # restore any previous driver
             bind_one(dev_id, saved_driver, force)
         return
         if saved_driver is not None:  # restore any previous driver
             bind_one(dev_id, saved_driver, force)
         return


@@ -472,16 +488,14 @@ def bind_one(dev_id, driver, force):
         try:
             f = open(filename, "w")
         except:
         try:
             f = open(filename, "w")
         except:

-            print("Error: unbind failed for %s - Cannot open %s"
+            sys.exit("Error: unbind failed for %s - Cannot open %s"

                   % (dev_id, filename))
                   % (dev_id, filename))

-            sys.exit(1)

         try:
             f.write("\00")
             f.close()
         except:
         try:
             f.write("\00")
             f.close()
         except:

-            print("Error: unbind failed for %s - Cannot open %s"
+            sys.exit("Error: unbind failed for %s - Cannot open %s"

                   % (dev_id, filename))
                   % (dev_id, filename))

-            sys.exit(1)

 
 
 def unbind_all(dev_list, force=False):
 
 
 def unbind_all(dev_list, force=False):


@@ -522,7 +536,7 @@ def bind_all(dev_list, driver, force=False):
         pass
 
     # check if we're attempting to bind to a driver that isn't loaded
         pass
 
     # check if we're attempting to bind to a driver that isn't loaded

-    if not module_is_loaded(driver):
+    if not module_is_loaded(driver.replace('-','_')):

         sys.exit("Error: Driver '%s' is not loaded." % driver)
 
     try:
         sys.exit("Error: Driver '%s' is not loaded." % driver)
 
     try:


@@ -576,7 +590,7 @@ def display_devices(title, dev_list, extra_params=None):
     strings.sort()
     print("\n".join(strings))  # print one per line
 
     strings.sort()
     print("\n".join(strings))  # print one per line
 

-def show_device_status(devices_type, device_name):
+def show_device_status(devices_type, device_name, if_field=False):

     global dpdk_drivers
     kernel_drv = []
     dpdk_drv = []
     global dpdk_drivers
     kernel_drv = []
     dpdk_drv = []


@@ -608,8 +622,11 @@ def show_device_status(devices_type, device_name):
         display_devices("%s devices using DPDK-compatible driver" % device_name,
                         dpdk_drv, "drv=%(Driver_str)s unused=%(Module_str)s")
     if len(kernel_drv) != 0:
         display_devices("%s devices using DPDK-compatible driver" % device_name,
                         dpdk_drv, "drv=%(Driver_str)s unused=%(Module_str)s")
     if len(kernel_drv) != 0:

+        if_text = ""
+        if if_field:
+            if_text = "if=%(Interface)s "

         display_devices("%s devices using kernel driver" % device_name, kernel_drv,
         display_devices("%s devices using kernel driver" % device_name, kernel_drv,

-                        "if=%(Interface)s drv=%(Driver_str)s "
+                        if_text + "drv=%(Driver_str)s "

                         "unused=%(Module_str)s %(Active)s")
     if len(no_drv) != 0:
         display_devices("Other %s devices" % device_name, no_drv,
                         "unused=%(Module_str)s %(Active)s")
     if len(no_drv) != 0:
         display_devices("Other %s devices" % device_name, no_drv,


@@ -621,7 +638,7 @@ def show_status():
     kernel driver or to no driver'''
 
     if status_dev == "net" or status_dev == "all":
     kernel driver or to no driver'''
 
     if status_dev == "net" or status_dev == "all":

-        show_device_status(network_devices, "Network")
+        show_device_status(network_devices, "Network", if_field=True)

 
     if status_dev == "baseband" or status_dev == "all":
         show_device_status(baseband_devices, "Baseband")
 
     if status_dev == "baseband" or status_dev == "all":
         show_device_status(baseband_devices, "Baseband")


@@ -641,6 +658,19 @@ def show_status():
     if status_dev == "misc" or status_dev == "all":
         show_device_status(misc_devices, "Misc (rawdev)")
 
     if status_dev == "misc" or status_dev == "all":
         show_device_status(misc_devices, "Misc (rawdev)")
 

+
+def pci_glob(arg):
+    '''Returns a list containing either:
+    * List of PCI B:D:F matching arg, using shell wildcards e.g. 80:04.*
+    * Only the passed arg if matching list is empty'''
+    sysfs_path = "/sys/bus/pci/devices"
+    for _glob in [arg, '0000:' + arg]:
+        paths = [basename(path) for path in glob(path_join(sysfs_path, _glob))]
+        if paths:
+            return paths
+    return [arg]
+
+

 def parse_args():
     '''Parses the command-line arguments given by the user and takes the
     appropriate action for each'''
 def parse_args():
     '''Parses the command-line arguments given by the user and takes the
     appropriate action for each'''


@@ -676,13 +706,17 @@ def parse_args():
             force_flag = True
         if opt == "-b" or opt == "-u" or opt == "--bind" or opt == "--unbind":
             if b_flag is not None:
             force_flag = True
         if opt == "-b" or opt == "-u" or opt == "--bind" or opt == "--unbind":
             if b_flag is not None:

-                print("Error - Only one bind or unbind may be specified\n")
-                sys.exit(1)
+                sys.exit("Error: binding and unbinding are mutually exclusive")

             if opt == "-u" or opt == "--unbind":
                 b_flag = "none"
             else:
                 b_flag = arg
 
             if opt == "-u" or opt == "--unbind":
                 b_flag = "none"
             else:
                 b_flag = arg
 

+    # resolve any PCI globs in the args
+    new_args = []
+    for arg in args:
+        new_args.extend(pci_glob(arg))
+    args = new_args

 
 def do_arg_actions():
     '''do the actual action requested by the user'''
 
 def do_arg_actions():
     '''do the actual action requested by the user'''


@@ -692,14 +726,14 @@ def do_arg_actions():
     global args
 
     if b_flag is None and not status_flag:
     global args
 
     if b_flag is None and not status_flag:

-        print("Error: No action specified for devices."
-              "Please give a -b or -u option")
-        print("Run '%s --usage' for further information" % sys.argv[0])
+        print("Error: No action specified for devices. "
+              "Please give a -b or -u option", file=sys.stderr)
+        usage()

         sys.exit(1)
 
     if b_flag is not None and len(args) == 0:
         sys.exit(1)
 
     if b_flag is not None and len(args) == 0:

-        print("Error: No devices specified.")
-        print("Run '%s --usage' for further information" % sys.argv[0])
+        print("Error: No devices specified.", file=sys.stderr)
+        usage()

         sys.exit(1)
 
     if b_flag == "none" or b_flag == "None":
         sys.exit(1)
 
     if b_flag == "none" or b_flag == "None":


@@ -727,8 +761,7 @@ def main():
         ret = subprocess.call(['which', 'lspci'],
                               stdout=devnull, stderr=devnull)
         if ret != 0:
         ret = subprocess.call(['which', 'lspci'],
                               stdout=devnull, stderr=devnull)
         if ret != 0:

-            print("'lspci' not found - please install 'pciutils'")
-            sys.exit(1)
+            sys.exit("'lspci' not found - please install 'pciutils'")

     parse_args()
     check_modules()
     clear_data()
     parse_args()
     check_modules()
     clear_data()