5 # Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
8 # Redistribution and use in source and binary forms, with or without
9 # modification, are permitted provided that the following conditions
12 # * Redistributions of source code must retain the above copyright
13 # notice, this list of conditions and the following disclaimer.
14 # * Redistributions in binary form must reproduce the above copyright
15 # notice, this list of conditions and the following disclaimer in
16 # the documentation and/or other materials provided with the
18 # * Neither the name of Intel Corporation nor the names of its
19 # contributors may be used to endorse or promote products derived
20 # from this software without specific prior written permission.
22 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
27 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
28 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
32 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 import sys, os, getopt, subprocess
36 from os.path import exists, abspath, dirname, basename
39 # The PCI device class for ETHERNET devices
40 ETHERNET_CLASS = "0200"
42 # global dict ethernet devices present. Dictionary indexed by PCI address.
43 # Each device within this is itself a dictionary of device properties
45 # list of vendor:device pairs (again stored as dictionary) supported by igb_uio
49 '''Print usage information for the program'''
50 argv0 = basename(sys.argv[0])
55 %(argv0)s [options] DEVICE1 DEVICE2 ....
57 where DEVICE1, DEVICE2 etc, are specified via PCI "domain:bus:slot.func" syntax
58 or "bus:slot.func" syntax. For devices bound to Linux kernel drivers, they may
59 also be referred to by Linux interface name e.g. eth0, eth1, em0, em1, etc.
63 Display usage information and quit
66 Print the current status of all known network interfaces.
67 For each device, it displays the PCI domain, bus, slot and function,
68 along with a text description of the device. Depending upon whether the
69 device is being used by a kernel driver, the igb_uio driver, or no
70 driver, other relevant information will be displayed:
71 * the Linux interface name e.g. if=eth0
72 * the driver being used e.g. drv=igb_uio
73 * any suitable drivers not currently using that device
75 NOTE: if this flag is passed along with a bind/unbind option, the status
76 display will always occur after the other operations have taken place.
78 -b driver, --bind=driver:
79 Select the driver to use or \"none\" to unbind the device
82 Unbind a device (Equivalent to \"-b none\")
85 By default, devices which are used by Linux - as indicated by having
86 routes in the routing table - cannot be modified. Using the --force
87 flag overrides this behavior, allowing active links to be forcibly
89 WARNING: This can lead to loss of network connection and should be used
95 To display current device status:
98 To bind eth1 from the current driver and move to use igb_uio
99 %(argv0)s --bind=igb_uio eth1
101 To unbind 0000:01:00.0 from using any driver
102 %(argv0)s -u 0000:01:00.0
104 To bind 0000:02:00.0 and 0000:02:00.1 to the ixgbe kernel driver
105 %(argv0)s -b ixgbe 02:00.0 02:00.1
107 """ % locals() # replace items from local variables
109 # This is roughly compatible with check_output function in subprocess module
110 # which is only available in python 2.7.
111 def check_output(args, stderr=None):
112 '''Run a command and capture its output'''
113 return subprocess.Popen(args, stdout=subprocess.PIPE,
114 stderr=stderr).communicate()[0]
116 def find_module(mod):
117 '''find the .ko file for kernel module named mod.
118 Searches the $RTE_SDK/$RTE_TARGET directory, the kernel
119 modules directory and finally under the parent directory of
121 # check $RTE_SDK/$RTE_TARGET directory
122 if 'RTE_SDK' in os.environ and 'RTE_TARGET' in os.environ:
123 path = "%s/%s/kmod/%s.ko" % (os.environ['RTE_SDK'],\
124 os.environ['RTE_TARGET'], mod)
130 depmod_out = check_output(["modinfo", "-n", mod], \
131 stderr=subprocess.STDOUT).lower()
132 if "error" not in depmod_out:
133 path = depmod_out.strip()
136 except: # if modinfo can't find module, it fails, so continue
139 # check for a copy based off current path
140 tools_dir = dirname(abspath(sys.argv[0]))
141 if (tools_dir.endswith("tools")):
142 base_dir = dirname(tools_dir)
143 find_out = check_output(["find", base_dir, "-name", mod + ".ko"])
144 if len(find_out) > 0: #something matched
145 path = find_out.splitlines()[0]
150 '''Checks that the needed modules (igb_uio) is loaded, and then
151 determine from the .ko file, what its supported device ids are'''
152 global module_dev_ids
154 fd = file("/proc/modules")
155 loaded_mods = fd.readlines()
159 # first check if module is loaded
161 for line in loaded_mods:
162 if line.startswith(mod):
166 print "Error - module %s not loaded" %mod
169 # now find the .ko and get list of supported vendor/dev-ids
170 modpath = find_module(mod)
172 print "Cannot find module file %s" % (mod + ".ko")
174 depmod_output = check_output(["depmod", "-n", modpath]).splitlines()
175 for line in depmod_output:
176 if not line.startswith("alias"):
178 if not line.endswith(mod):
180 lineparts = line.split()
181 if not(lineparts[1].startswith("pci:")):
184 lineparts[1] = lineparts[1][4:]
185 vendor = lineparts[1][:9]
186 device = lineparts[1][9:18]
187 if vendor.startswith("v") and device.startswith("d"):
188 module_dev_ids.append({"Vendor": int(vendor[1:],16),
189 "Device": int(device[1:],16)})
191 def is_supported_device(dev_id):
192 '''return true if device is supported by igb_uio, false otherwise'''
193 for dev in module_dev_ids:
194 if (dev["Vendor"] == devices[dev_id]["Vendor"] and
195 dev["Device"] == devices[dev_id]["Device"]):
199 def has_driver(dev_id):
200 '''return true if a device is assigned to a driver. False otherwise'''
201 return "Driver_str" in devices[dev_id]
203 def get_nic_details():
204 '''This function populates the "devices" dictionary. The keys used are
205 the pci addresses (domain:bus:slot.func). The values are themselves
206 dictionaries - one for each NIC.'''
211 # first loop through and read details for all devices
212 # request machine readable format, with numeric IDs
214 dev_lines = check_output(["lspci", "-Dvmmn"]).splitlines()
215 for dev_line in dev_lines:
216 if (len(dev_line) == 0):
217 if dev["Class"] == ETHERNET_CLASS:
218 #convert device and vendor ids to numbers, then add to global
219 dev["Vendor"] = int(dev["Vendor"],16)
220 dev["Device"] = int(dev["Device"],16)
221 devices[dev["Slot"]] = dict(dev) # use dict to make copy of dev
223 name, value = dev_line.split("\t", 1)
224 dev[name.rstrip(":")] = value
226 # check what is the interface if any for an ssh connection if
227 # any to this host, so we can mark it later.
229 route = check_output(["ip", "-o", "route"])
230 # filter out all lines for 169.254 routes
231 route = "\n".join(filter(lambda ln: not ln.startswith("169.254"),
233 rt_info = route.split()
234 for i in xrange(len(rt_info) - 1):
235 if rt_info[i] == "dev":
236 ssh_if.append(rt_info[i+1])
238 # based on the basic info, get extended text details
239 for d in devices.keys():
240 extra_info = check_output(["lspci", "-vmmks", d]).splitlines()
241 # parse lspci details
242 for line in extra_info:
245 name, value = line.split("\t", 1)
246 name = name.strip(":") + "_str"
247 devices[d][name] = value
248 # check for a unix interface name
249 sys_path = "/sys/bus/pci/devices/%s/net/" % d
251 devices[d]["Interface"] = ",".join(os.listdir(sys_path))
253 devices[d]["Interface"] = ""
254 # check if a port is used for ssh connection
255 devices[d]["Ssh_if"] = False
256 devices[d]["Active"] = ""
258 if _if in devices[d]["Interface"].split(","):
259 devices[d]["Ssh_if"] = True
260 devices[d]["Active"] = "*Active*"
263 # add igb_uio to list of supporting modules if needed
264 if is_supported_device(d):
265 if "Module_str" in devices[d]:
266 if "igb_uio" not in devices[d]["Module_str"]:
267 devices[d]["Module_str"] = devices[d]["Module_str"] + ",igb_uio"
269 devices[d]["Module_str"] = "igb_uio"
270 if "Module_str" not in devices[d]:
271 devices[d]["Module_str"] = "<none>"
272 # make sure the driver and module strings do not have any duplicates
274 modules = devices[d]["Module_str"].split(",")
275 if devices[d]["Driver_str"] in modules:
276 modules.remove(devices[d]["Driver_str"])
277 devices[d]["Module_str"] = ",".join(modules)
279 def dev_id_from_dev_name(dev_name):
280 '''Take a device "name" - a string passed in by user to identify a NIC
281 device, and determine the device id - i.e. the domain:bus:slot.func - for
282 it, which can then be used to index into the devices array'''
284 # check if it's already a suitable index
285 if dev_name in devices:
287 # check if it's an index just missing the domain part
288 elif "0000:" + dev_name in devices:
289 return "0000:" + dev_name
291 # check if it's an interface name, e.g. eth1
292 for d in devices.keys():
293 if dev_name in devices[d]["Interface"].split(","):
294 return devices[d]["Slot"]
295 # if nothing else matches - error
296 print "Unknown device: %s. " \
297 "Please specify device in \"bus:slot.func\" format" % dev_name
300 def unbind_one(dev_id, force):
301 '''Unbind the device identified by "dev_id" from its current driver'''
302 dev = devices[dev_id]
303 if not has_driver(dev_id):
304 print "%s %s %s is not currently managed by any driver\n" % \
305 (dev["Slot"], dev["Device_str"], dev["Interface"])
308 # prevent us disconnecting ourselves
309 if dev["Ssh_if"] and not force:
310 print "Routing table indicates that interface %s is active" \
311 ". Skipping unbind" % (dev_id)
314 # write to /sys to unbind
315 filename = "/sys/bus/pci/drivers/%s/unbind" % dev["Driver_str"]
317 f = open(filename, "a")
319 print "Error: unbind failed for %s - Cannot open %s" % (dev_id, filename)
324 def bind_one(dev_id, driver, force):
325 '''Bind the device given by "dev_id" to the driver "driver". If the device
326 is already bound to a different driver, it will be unbound first'''
327 dev = devices[dev_id]
328 saved_driver = None # used to rollback any unbind in case of failure
330 # prevent disconnection of our ssh session
331 if dev["Ssh_if"] and not force:
332 print "Routing table indicates that interface %s is active" \
333 ". Not modifying" % (dev_id)
336 # unbind any existing drivers we don't want
337 if has_driver(dev_id):
338 if dev["Driver_str"] == driver:
339 print "%s already bound to driver %s, skipping\n" % (dev_id, driver)
342 saved_driver = dev["Driver_str"]
343 unbind_one(dev_id, force)
344 dev["Driver_str"] = "" # clear driver string
346 # do the bind by writing to /sys
347 filename = "/sys/bus/pci/drivers/%s/bind" % driver
349 f = open(filename, "a")
351 print "Error: bind failed for %s - Cannot open %s" % (dev_id, filename)
352 if saved_driver is not None: # restore any previous driver
353 bind_one(dev_id, saved_driver, force)
359 print "Error: bind failed for %s - Cannot bind to driver %s" % (dev_id, driver)
360 if saved_driver is not None: # restore any previous driver
361 bind_one(dev_id, saved_driver, force)
365 def unbind_all(dev_list, force=False):
366 """Unbind method, takes a list of device locations"""
367 dev_list = map(dev_id_from_dev_name, dev_list)
371 def bind_all(dev_list, driver, force=False):
372 """Unbind method, takes a list of device locations"""
373 dev_list = map(dev_id_from_dev_name, dev_list)
375 bind_one(d, driver, force)
377 def display_devices(title, dev_list, extra_params = None):
378 '''Displays to the user the details of a list of devices given in "dev_list"
379 The "extra_params" parameter, if given, should contain a string with
380 %()s fields in it for replacement by the named fields in each device's
382 strings = [] # this holds the strings to print. We sort before printing
385 if len(dev_list) == 0:
386 strings.append("<none>")
389 if extra_params is not None:
390 strings.append("%s '%s' %s" % (dev["Slot"], \
391 dev["Device_str"], extra_params % dev))
393 strings.append("%s '%s'" % (dev["Slot"], dev["Device_str"]))
394 # sort before printing, so that the entries appear in PCI order
396 print "\n".join(strings) # print one per line
399 '''Function called when the script is passed the "--status" option. Displays
400 to the user what devices are bound to the igb_uio driver, the kernel driver
405 # split our list of devices into the three categories above
406 for d in devices.keys():
407 if not has_driver(d):
408 no_drv.append(devices[d])
410 if devices[d]["Driver_str"] == "igb_uio":
411 uio_drv.append(devices[d])
413 kernel_drv.append(devices[d])
415 # print each category separately, so we can clearly see what's used by DPDK
416 display_devices("Network devices using IGB_UIO driver", uio_drv, \
417 "drv=%(Driver_str)s unused=%(Module_str)s")
418 display_devices("Network devices using kernel driver", kernel_drv,
419 "if=%(Interface)s drv=%(Driver_str)s unused=%(Module_str)s %(Active)s")
420 display_devices("Other network devices", no_drv,\
421 "unused=%(Module_str)s")
424 '''Parses the command-line arguments given by the user and takes the
425 appropriate action for each'''
429 if len(sys.argv) <= 1:
434 opts, args = getopt.getopt(sys.argv[1:], "b:u",
435 ["help", "usage", "status", "force",
437 except getopt.GetoptError, error:
439 print "Run '%s --usage' for further information" % sys.argv[0]
442 for opt, arg in opts:
443 if opt == "--help" or opt == "--usage":
446 if opt == "--status":
450 if opt == "-b" or opt == "-u" or opt == "--bind" or opt == "--unbind":
451 if b_flag is not None:
452 print "Error - Only one bind or unbind may be specified\n"
454 if opt == "-u" or opt == "--unbind":
459 if b_flag is None and not status_flag:
460 print "Error: No action specified for devices. Please give a -b or -u option"
461 print "Run '%s --usage' for further information" % sys.argv[0]
464 if b_flag is not None and len(args) == 0:
465 print "Error: No devices specified."
466 print "Run '%s --usage' for further information" % sys.argv[0]
469 if b_flag == "none" or b_flag == "None":
470 unbind_all(args, force_flag)
471 elif b_flag is not None:
472 bind_all(args, b_flag, force_flag)
474 if b_flag is not None:
475 get_nic_details() # refresh if we have changed anything
479 '''program main function'''
484 if __name__ == "__main__":