mk: replace the combined library with a linker script
[dpdk.git] / tools / dpdk_nic_bind.py
index 95d1e51..14c5311 100755 (executable)
@@ -43,12 +43,18 @@ ETHERNET_CLASS = "0200"
 # Each device within this is itself a dictionary of device properties
 devices = {}
 # list of supported DPDK drivers
 # Each device within this is itself a dictionary of device properties
 devices = {}
 # list of supported DPDK drivers
-dpdk_drivers = [ "igb_uio", "vfio-pci" ]
+dpdk_drivers = [ "igb_uio", "vfio-pci", "uio_pci_generic" ]
+
+# command-line arg flags
+b_flag = None
+status_flag = False
+force_flag = False
+args = []
 
 def usage():
     '''Print usage information for the program'''
     argv0 = basename(sys.argv[0])
 
 def usage():
     '''Print usage information for the program'''
     argv0 = basename(sys.argv[0])
-    print """
+    print ("""
 Usage:
 ------
 
 Usage:
 ------
 
@@ -62,7 +68,7 @@ Options:
     --help, --usage:
         Display usage information and quit
 
     --help, --usage:
         Display usage information and quit
 
-    --status:
+    -s, --status:
         Print the current status of all known network interfaces.
         For each device, it displays the PCI domain, bus, slot and function,
         along with a text description of the device. Depending upon whether the
         Print the current status of all known network interfaces.
         For each device, it displays the PCI domain, bus, slot and function,
         along with a text description of the device. Depending upon whether the
@@ -104,7 +110,7 @@ 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
 
-    """ % locals() # replace items from local variables
+    """ % locals()) # replace items from local variables
 
 # This is roughly compatible with check_output function in subprocess module
 # which is only available in python 2.7.
 
 # This is roughly compatible with check_output function in subprocess module
 # which is only available in python 2.7.
@@ -150,27 +156,40 @@ def check_modules():
     '''Checks that igb_uio is loaded'''
     global dpdk_drivers
 
     '''Checks that igb_uio is loaded'''
     global dpdk_drivers
 
-    fd = file("/proc/modules")
-    loaded_mods = fd.readlines()
-    fd.close()
-
     # list of supported modules
     mods =  [{"Name" : driver, "Found" : False} for driver in dpdk_drivers]
 
     # first check if module is loaded
     # list of supported modules
     mods =  [{"Name" : driver, "Found" : False} for driver in dpdk_drivers]
 
     # first check if module is loaded
-    for line in loaded_mods:
+    try:
+        # Get list of sysfs modules (both built-in and dynamically loaded)
+        sysfs_path = '/sys/module/'
+
+        # Get the list of directories in sysfs_path
+        sysfs_mods = [os.path.join(sysfs_path, o) for o
+                      in os.listdir(sysfs_path)
+                      if os.path.isdir(os.path.join(sysfs_path, o))]
+
+        # Extract the last element of '/sys/module/abc' in the array
+        sysfs_mods = [a.split('/')[-1] for a in sysfs_mods]
+
+        # special case for vfio_pci (module is named vfio-pci,
+        # but its .ko is named vfio_pci)
+        sysfs_mods = map(lambda a:
+                         a if a != 'vfio_pci' else 'vfio-pci', sysfs_mods)
+
         for mod in mods:
         for mod in mods:
-            if line.startswith(mod["Name"]):
-                mod["Found"] = True
-            # special case for vfio_pci (module is named vfio-pci,
-            # but its .ko is named vfio_pci)
-            elif line.replace("_", "-").startswith(mod["Name"]):
+            if mod["Name"] in sysfs_mods:
                 mod["Found"] = True
                 mod["Found"] = True
+    except:
+        pass
 
     # check if we have at least one loaded module
 
     # check if we have at least one loaded module
-    if True not in [mod["Found"] for mod in mods]:
-        print "Error - no supported modules are loaded"
-        sys.exit(1)
+    if True not in [mod["Found"] for mod in mods] and b_flag is not None:
+        if b_flag in dpdk_drivers:
+            print ("Error - no supported modules(DPDK driver) are loaded")
+            sys.exit(1)
+        else:
+            print ("Warning - no supported modules(DPDK driver) are loaded")
 
     # 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"]]
@@ -189,7 +208,7 @@ def get_pci_device_details(dev_id):
     for line in extra_info:
         if len(line) == 0:
             continue
     for line in extra_info:
         if len(line) == 0:
             continue
-        name, value = line.split("\t", 1)
+        name, value = line.decode().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
@@ -225,7 +244,7 @@ def get_nic_details():
                 dev["Device"] = int(dev["Device"],16)
                 devices[dev["Slot"]] = dict(dev) # use dict to make copy of dev
         else:
                 dev["Device"] = int(dev["Device"],16)
                 devices[dev["Slot"]] = dict(dev) # use dict to make copy of dev
         else:
-            name, value = dev_line.split("\t", 1)
+            name, value = dev_line.decode().split("\t", 1)
             dev[name.rstrip(":")] = value
 
     # check what is the interface if any for an ssh connection if
             dev[name.rstrip(":")] = value
 
     # check what is the interface if any for an ssh connection if
@@ -234,17 +253,17 @@ def get_nic_details():
     route = check_output(["ip", "-o", "route"])
     # filter out all lines for 169.254 routes
     route = "\n".join(filter(lambda ln: not ln.startswith("169.254"),
     route = check_output(["ip", "-o", "route"])
     # filter out all lines for 169.254 routes
     route = "\n".join(filter(lambda ln: not ln.startswith("169.254"),
-                             route.splitlines()))
+                             route.decode().splitlines()))
     rt_info = route.split()
     rt_info = route.split()
-    for i in xrange(len(rt_info) - 1):
+    for i in range(len(rt_info) - 1):
         if rt_info[i] == "dev":
             ssh_if.append(rt_info[i+1])
 
     # based on the basic info, get extended text details
     for d in devices.keys():
         # get additional info and add it to existing data
         if rt_info[i] == "dev":
             ssh_if.append(rt_info[i+1])
 
     # based on the basic info, get extended text details
     for d in devices.keys():
         # get additional info and add it to existing data
-        devices[d] = dict(devices[d].items() +
-                          get_pci_device_details(d).items())
+        devices[d] = devices[d].copy()
+        devices[d].update(get_pci_device_details(d).items())
 
         for _if in ssh_if:
             if _if in devices[d]["Interface"].split(","):
 
         for _if in ssh_if:
             if _if in devices[d]["Interface"].split(","):
@@ -284,22 +303,22 @@ def dev_id_from_dev_name(dev_name):
             if dev_name in devices[d]["Interface"].split(","):
                 return devices[d]["Slot"]
     # if nothing else matches - error
             if dev_name in devices[d]["Interface"].split(","):
                 return devices[d]["Slot"]
     # if nothing else matches - error
-    print "Unknown device: %s. " \
-        "Please specify device in \"bus:slot.func\" format" % dev_name
+    print ("Unknown device: %s. " \
+        "Please specify device in \"bus:slot.func\" format" % dev_name)
     sys.exit(1)
 
 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):
     sys.exit(1)
 
 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):
-        print "%s %s %s is not currently managed by any driver\n" % \
-            (dev["Slot"], dev["Device_str"], dev["Interface"])
+        print ("%s %s %s is not currently managed by any driver\n" % \
+            (dev["Slot"], dev["Device_str"], dev["Interface"]))
         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 ("Routing table indicates that interface %s is active" \
+            ". Skipping unbind" % (dev_id))
         return
 
     # write to /sys to unbind
         return
 
     # write to /sys to unbind
@@ -307,8 +326,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)
+        print ("Error: unbind failed for %s - Cannot open %s" % (dev_id, filename))
+        sys.exit(1)
     f.write(dev_id)
     f.close()
 
     f.write(dev_id)
     f.close()
 
@@ -320,14 +339,14 @@ 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 ("Routing table indicates that interface %s is active" \
+            ". Not modifying" % (dev_id))
         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 ("%s already bound to driver %s, skipping\n" % (dev_id, driver))
             return
         else:
             saved_driver = dev["Driver_str"]
             return
         else:
             saved_driver = dev["Driver_str"]
@@ -340,14 +359,14 @@ def bind_one(dev_id, driver, force):
         try:
             f = open(filename, "w")
         except:
         try:
             f = open(filename, "w")
         except:
-            print "Error: bind failed for %s - Cannot open %s" % (dev_id, filename)
+            print ("Error: bind failed for %s - Cannot open %s" % (dev_id, filename))
             return
         try:
             f.write("%04x %04x" % (dev["Vendor"], dev["Device"]))
             f.close()
         except:
             return
         try:
             f.write("%04x %04x" % (dev["Vendor"], dev["Device"]))
             f.close()
         except:
-            print "Error: bind failed for %s - Cannot write new PCI ID to " \
-                "driver %s" % (dev_id, driver)
+            print ("Error: bind failed for %s - Cannot write new PCI ID to " \
+                "driver %s" % (dev_id, driver))
             return
 
     # do the bind by writing to /sys
             return
 
     # do the bind by writing to /sys
@@ -355,7 +374,7 @@ def bind_one(dev_id, driver, force):
     try:
         f = open(filename, "a")
     except:
     try:
         f = open(filename, "a")
     except:
-        print "Error: bind failed for %s - Cannot open %s" % (dev_id, filename)
+        print ("Error: bind failed for %s - Cannot open %s" % (dev_id, filename))
         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
@@ -369,7 +388,7 @@ def bind_one(dev_id, driver, force):
         tmp = get_pci_device_details(dev_id)
         if "Driver_str" in tmp and tmp["Driver_str"] == driver:
             return
         tmp = get_pci_device_details(dev_id)
         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)
+        print ("Error: bind failed for %s - Cannot bind to driver %s" % (dev_id, driver))
         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
@@ -382,7 +401,7 @@ def unbind_all(dev_list, force=False):
         unbind_one(d, force)
 
 def bind_all(dev_list, driver, force=False):
         unbind_one(d, force)
 
 def bind_all(dev_list, driver, force=False):
-    """Unbind method, takes a list of device locations"""
+    """Bind method, takes a list of device locations"""
     global devices
 
     dev_list = map(dev_id_from_dev_name, dev_list)
     global devices
 
     dev_list = map(dev_id_from_dev_name, dev_list)
@@ -414,8 +433,8 @@ def display_devices(title, dev_list, extra_params = None):
     %()s fields in it for replacement by the named fields in each device's
     dictionary.'''
     strings = [] # this holds the strings to print. We sort before printing
     %()s fields in it for replacement by the named fields in each device's
     dictionary.'''
     strings = [] # this holds the strings to print. We sort before printing
-    print "\n%s" % title
-    print   "="*len(title)
+    print ("\n%s" % title)
+    print   ("="*len(title))
     if len(dev_list) == 0:
         strings.append("<none>")
     else:
     if len(dev_list) == 0:
         strings.append("<none>")
     else:
@@ -427,7 +446,7 @@ def display_devices(title, dev_list, extra_params = None):
                 strings.append("%s '%s'" % (dev["Slot"], dev["Device_str"]))
     # sort before printing, so that the entries appear in PCI order
     strings.sort()
                 strings.append("%s '%s'" % (dev["Slot"], dev["Device_str"]))
     # sort before printing, so that the entries appear in PCI order
     strings.sort()
-    print "\n".join(strings) # print one per line
+    print ("\n".join(strings)) # print one per line
 
 def show_status():
     '''Function called when the script is passed the "--status" option. Displays
 
 def show_status():
     '''Function called when the script is passed the "--status" option. Displays
@@ -459,47 +478,55 @@ def show_status():
 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'''
-    b_flag = None
-    status_flag = False
-    force_flag = False
+    global b_flag
+    global status_flag
+    global force_flag
+    global args
     if len(sys.argv) <= 1:
         usage()
         sys.exit(0)
 
     try:
     if len(sys.argv) <= 1:
         usage()
         sys.exit(0)
 
     try:
-        opts, args = getopt.getopt(sys.argv[1:], "b:u",
+        opts, args = getopt.getopt(sys.argv[1:], "b:us",
                                ["help", "usage", "status", "force",
                                 "bind=", "unbind"])
                                ["help", "usage", "status", "force",
                                 "bind=", "unbind"])
-    except getopt.GetoptError, error:
-        print str(error)
-        print "Run '%s --usage' for further information" % sys.argv[0]
+    except (getopt.GetoptError, error):
+        print (str(error))
+        print ("Run '%s --usage' for further information" % sys.argv[0])
         sys.exit(1)
 
     for opt, arg in opts:
         if opt == "--help" or opt == "--usage":
             usage()
             sys.exit(0)
         sys.exit(1)
 
     for opt, arg in opts:
         if opt == "--help" or opt == "--usage":
             usage()
             sys.exit(0)
-        if opt == "--status":
+        if opt == "--status" or opt == "-s":
             status_flag = True
         if opt == "--force":
             force_flag = True
         if opt == "-b" or opt == "-u" or opt == "--bind" or opt == "--unbind":
             if b_flag is not None:
             status_flag = True
         if opt == "--force":
             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"
+                print ("Error - Only one bind or unbind may be specified\n")
                 sys.exit(1)
             if opt == "-u" or opt == "--unbind":
                 b_flag = "none"
             else:
                 b_flag = arg
 
                 sys.exit(1)
             if opt == "-u" or opt == "--unbind":
                 b_flag = "none"
             else:
                 b_flag = arg
 
+def do_arg_actions():
+    '''do the actual action requested by the user'''
+    global b_flag
+    global status_flag
+    global force_flag
+    global args
+
     if b_flag is None and not status_flag:
     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")
+        print ("Run '%s --usage' for further information" % sys.argv[0])
         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.")
+        print ("Run '%s --usage' for further information" % sys.argv[0])
         sys.exit(1)
 
     if b_flag == "none" or b_flag == "None":
         sys.exit(1)
 
     if b_flag == "none" or b_flag == "None":
@@ -513,9 +540,10 @@ def parse_args():
 
 def main():
     '''program main function'''
 
 def main():
     '''program main function'''
+    parse_args()
     check_modules()
     get_nic_details()
     check_modules()
     get_nic_details()
-    parse_args()
+    do_arg_actions()
 
 if __name__ == "__main__":
     main()
 
 if __name__ == "__main__":
     main()