3 # Copyright (C) 2017 Netronome Systems, Inc.
4 # Copyright (c) 2019 Mellanox Technologies. All rights reserved
6 # This software is licensed under the GNU General License Version 2,
7 # June 1991 as shown in the file COPYING in the top-level directory of this
10 # THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS"
11 # WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
12 # BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
13 # FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE
14 # OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME
15 # THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
17 from datetime import datetime
35 bpf_test_dir = os.path.dirname(os.path.realpath(__file__))
36 pp = pprint.PrettyPrinter()
37 devs = [] # devices we created for clean up
38 files = [] # files to be removed
39 netns = [] # net namespaces to be removed
41 def log_get_sec(level=0):
42 return "*" * (log_level + level)
44 def log_level_inc(add=1):
48 def log_level_dec(sub=1):
52 def log_level_set(level):
56 def log(header, data, level=None):
58 Output to an optional log.
65 if not isinstance(data, str):
66 data = pp.pformat(data)
69 logfile.write("\n" + log_get_sec() + " ")
71 if len(header) and len(data.strip()):
79 log("SKIP: " + msg, "", level=1)
86 tb = "".join(traceback.extract_stack().format())
88 log("FAIL: " + msg, tb, level=1)
96 def cmd(cmd, shell=True, include_stderr=False, background=False, fail=True):
98 Run a command in subprocess and return tuple of (retval, stdout);
99 optionally return stderr as well as third value.
101 proc = subprocess.Popen(cmd, shell=shell, stdout=subprocess.PIPE,
102 stderr=subprocess.PIPE)
104 msg = "%s START: %s" % (log_get_sec(1),
105 datetime.now().strftime("%H:%M:%S.%f"))
106 log("BKG " + proc.args, msg)
109 return cmd_result(proc, include_stderr=include_stderr, fail=fail)
111 def cmd_result(proc, include_stderr=False, fail=False):
112 stdout, stderr = proc.communicate()
113 stdout = stdout.decode("utf-8")
114 stderr = stderr.decode("utf-8")
118 stderr = "\n" + stderr
119 if stderr[-1] == "\n":
123 log("CMD " + proc.args,
124 "RETCODE: %d\n%s STDOUT:\n%s%s STDERR:%s\n%s END: %s" %
125 (proc.returncode, sec, stdout, sec, stderr,
126 sec, datetime.now().strftime("%H:%M:%S.%f")))
128 if proc.returncode != 0 and fail:
129 if len(stderr) > 0 and stderr[-1] == "\n":
131 raise Exception("Command failed: %s\n%s" % (proc.args, stderr))
134 return proc.returncode, stdout, stderr
136 return proc.returncode, stdout
139 cmd("rm -f %s" % (f))
143 def tool(name, args, flags, JSON=True, ns="", fail=True, include_stderr=False):
146 params += "%s " % (flags["json"])
149 ns = "ip netns exec %s " % (ns)
152 ret, stdout, stderr = cmd(ns + name + " " + params + args,
153 fail=fail, include_stderr=True)
155 ret, stdout = cmd(ns + name + " " + params + args,
156 fail=fail, include_stderr=False)
158 if JSON and len(stdout.strip()) != 0:
159 out = json.loads(stdout)
164 return ret, out, stderr
168 def bpftool(args, JSON=True, ns="", fail=True, include_stderr=False):
169 return tool("bpftool", args, {"json":"-p"}, JSON=JSON, ns=ns,
170 fail=fail, include_stderr=include_stderr)
172 def bpftool_prog_list(expected=None, ns=""):
173 _, progs = bpftool("prog show", JSON=True, ns=ns, fail=True)
174 # Remove the base progs
178 if expected is not None:
179 if len(progs) != expected:
180 fail(True, "%d BPF programs loaded, expected %d" %
181 (len(progs), expected))
184 def bpftool_map_list(expected=None, ns=""):
185 _, maps = bpftool("map show", JSON=True, ns=ns, fail=True)
186 # Remove the base maps
190 if expected is not None:
191 if len(maps) != expected:
192 fail(True, "%d BPF maps loaded, expected %d" %
193 (len(maps), expected))
196 def bpftool_prog_list_wait(expected=0, n_retry=20):
197 for i in range(n_retry):
198 nprogs = len(bpftool_prog_list())
199 if nprogs == expected:
202 raise Exception("Time out waiting for program counts to stabilize want %d, have %d" % (expected, nprogs))
204 def bpftool_map_list_wait(expected=0, n_retry=20):
205 for i in range(n_retry):
206 nmaps = len(bpftool_map_list())
207 if nmaps == expected:
210 raise Exception("Time out waiting for map counts to stabilize want %d, have %d" % (expected, nmaps))
212 def bpftool_prog_load(sample, file_name, maps=[], prog_type="xdp", dev=None,
213 fail=True, include_stderr=False):
214 args = "prog load %s %s" % (os.path.join(bpf_test_dir, sample), file_name)
215 if prog_type is not None:
216 args += " type " + prog_type
218 args += " dev " + dev
220 args += " map " + " map ".join(maps)
222 res = bpftool(args, fail=fail, include_stderr=include_stderr)
224 files.append(file_name)
227 def ip(args, force=False, JSON=True, ns="", fail=True, include_stderr=False):
229 args = "-force " + args
230 return tool("ip", args, {"json":"-j"}, JSON=JSON, ns=ns,
231 fail=fail, include_stderr=include_stderr)
233 def tc(args, JSON=True, ns="", fail=True, include_stderr=False):
234 return tool("tc", args, {"json":"-p"}, JSON=JSON, ns=ns,
235 fail=fail, include_stderr=include_stderr)
237 def ethtool(dev, opt, args, fail=True):
238 return cmd("ethtool %s %s %s" % (opt, dev["ifname"], args), fail=fail)
240 def bpf_obj(name, sec=".text", path=bpf_test_dir,):
241 return "obj %s sec %s" % (os.path.join(path, name), sec)
243 def bpf_pinned(name):
244 return "pinned %s" % (name)
246 def bpf_bytecode(bytecode):
247 return "bytecode \"%s\"" % (bytecode)
249 def mknetns(n_retry=10):
250 for i in range(n_retry):
251 name = ''.join([random.choice(string.ascii_letters) for i in range(8)])
252 ret, _ = ip("netns add %s" % (name), fail=False)
258 def int2str(fmt, val):
260 for b in struct.pack(fmt, val):
262 return " ".join(map(lambda x: str(x), ret))
267 inttab.append(int(i, 16))
268 ba = bytearray(inttab)
271 elif len(strtab) == 8:
274 raise Exception("String array of len %d can't be unpacked to an int" %
276 return struct.unpack(fmt, ba)[0]
280 Class for accessing DebugFS directories as a dictionary.
283 def __init__(self, path):
285 self._dict = self._debugfs_dir_read(path)
288 return len(self._dict.keys())
290 def __getitem__(self, key):
292 key = list(self._dict.keys())[key]
293 return self._dict[key]
295 def __setitem__(self, key, value):
296 log("DebugFS set %s = %s" % (key, value), "")
299 cmd("echo '%s' > %s/%s" % (value, self.path, key))
302 _, out = cmd('cat %s/%s' % (self.path, key))
303 self._dict[key] = out.strip()
305 def _debugfs_dir_read(self, path):
308 log("DebugFS state for %s" % (path), "")
311 _, out = cmd('ls ' + path)
312 for f in out.split():
316 p = os.path.join(path, f)
317 if not os.stat(p).st_mode & stat.S_IRUSR:
320 if os.path.isfile(p) and os.access(p, os.R_OK):
321 _, out = cmd('cat %s/%s' % (path, f))
323 elif os.path.isdir(p):
324 dfs[f] = DebugfsDir(p)
326 raise Exception("%s is neither file nor directory" % (p))
329 log("DebugFS state", dfs)
336 Class for netdevsim bus device and its attributes.
339 def __init__(self, port_count=1):
343 with open("/sys/bus/netdevsim/new_device", "w") as f:
344 f.write("%u %u" % (addr, port_count))
346 if e.errno == errno.ENOSPC:
353 # As probe of netdevsim device might happen from a workqueue,
354 # so wait here until all netdevs appear.
355 self.wait_for_netdevs(port_count)
357 ret, out = cmd("udevadm settle", fail=False)
359 raise Exception("udevadm settle failed")
360 ifnames = self.get_ifnames()
363 self.dfs_dir = "/sys/kernel/debug/netdevsim/netdevsim%u/" % addr
366 for port_index in range(port_count):
367 self.nsims.append(NetdevSim(self, port_index, ifnames[port_index]))
369 def get_ifnames(self):
371 listdir = os.listdir("/sys/bus/netdevsim/devices/netdevsim%u/net/" % self.addr)
372 for ifname in listdir:
373 ifnames.append(ifname)
377 def wait_for_netdevs(self, port_count):
379 timeout_start = time.time()
383 ifnames = self.get_ifnames()
384 except FileNotFoundError as e:
386 if len(ifnames) == port_count:
388 if time.time() < timeout_start + timeout:
390 raise Exception("netdevices did not appear within timeout")
392 def dfs_num_bound_progs(self):
393 path = os.path.join(self.dfs_dir, "bpf_bound_progs")
394 _, progs = cmd('ls %s' % (path))
395 return len(progs.split())
397 def dfs_get_bound_progs(self, expected):
398 progs = DebugfsDir(os.path.join(self.dfs_dir, "bpf_bound_progs"))
399 if expected is not None:
400 if len(progs) != expected:
401 fail(True, "%d BPF programs bound, expected %d" %
402 (len(progs), expected))
406 with open("/sys/bus/netdevsim/del_device", "w") as f:
407 f.write("%u" % self.addr)
410 def remove_nsim(self, nsim):
411 self.nsims.remove(nsim)
412 with open("/sys/bus/netdevsim/devices/netdevsim%u/del_port" % self.addr ,"w") as f:
413 f.write("%u" % nsim.port_index)
417 Class for netdevsim netdevice and its attributes.
420 def __init__(self, nsimdev, port_index, ifname):
421 # In case udev renamed the netdev to according to new schema,
422 # check if the name matches the port_index.
423 nsimnamere = re.compile("eni\d+np(\d+)")
424 match = nsimnamere.match(ifname)
425 if match and int(match.groups()[0]) != port_index + 1:
426 raise Exception("netdevice name mismatches the expected one")
428 self.nsimdev = nsimdev
429 self.port_index = port_index
431 self.dfs_dir = "%s/ports/%u/" % (nsimdev.dfs_dir, port_index)
433 _, [self.dev] = ip("link show dev %s" % ifname)
435 def __getitem__(self, key):
439 self.nsimdev.remove_nsim(self)
441 def dfs_refresh(self):
442 self.dfs = DebugfsDir(self.dfs_dir)
445 def dfs_read(self, f):
446 path = os.path.join(self.dfs_dir, f)
447 _, data = cmd('cat %s' % (path))
450 def wait_for_flush(self, bound=0, total=0, n_retry=20):
451 for i in range(n_retry):
452 nbound = self.nsimdev.dfs_num_bound_progs()
453 nprogs = len(bpftool_prog_list())
454 if nbound == bound and nprogs == total:
457 raise Exception("Time out waiting for program counts to stabilize want %d/%d, have %d bound, %d loaded" % (bound, total, nbound, nprogs))
459 def set_ns(self, ns):
460 name = "1" if ns == "" else ns
461 ip("link set dev %s netns %s" % (self.dev["ifname"], name), ns=self.ns)
464 def set_mtu(self, mtu, fail=True):
465 return ip("link set dev %s mtu %d" % (self.dev["ifname"], mtu),
468 def set_xdp(self, bpf, mode, force=False, JSON=True, verbose=False,
469 fail=True, include_stderr=False):
472 return ip("link set dev %s xdp%s %s" % (self.dev["ifname"], mode, bpf),
473 force=force, JSON=JSON,
474 fail=fail, include_stderr=include_stderr)
476 def unset_xdp(self, mode, force=False, JSON=True,
477 fail=True, include_stderr=False):
478 return ip("link set dev %s xdp%s off" % (self.dev["ifname"], mode),
479 force=force, JSON=JSON,
480 fail=fail, include_stderr=include_stderr)
482 def ip_link_show(self, xdp):
483 _, link = ip("link show dev %s" % (self['ifname']))
485 raise Exception("Multiple objects on ip link show")
488 fail(xdp != "xdp" in link,
489 "XDP program not reporting in iplink (reported %s, expected %s)" %
490 ("xdp" in link, xdp))
493 def tc_add_ingress(self):
494 tc("qdisc add dev %s ingress" % (self['ifname']))
496 def tc_del_ingress(self):
497 tc("qdisc del dev %s ingress" % (self['ifname']))
499 def tc_flush_filters(self, bound=0, total=0):
500 self.tc_del_ingress()
501 self.tc_add_ingress()
502 self.wait_for_flush(bound=bound, total=total)
504 def tc_show_ingress(self, expected=None):
505 # No JSON support, oh well...
506 flags = ["skip_sw", "skip_hw", "in_hw"]
507 named = ["protocol", "pref", "chain", "handle", "id", "tag"]
509 args = "-s filter show dev %s ingress" % (self['ifname'])
510 _, out = tc(args, JSON=False)
513 lines = out.split('\n')
516 if "handle" not in words:
520 fltr[flag] = flag in words
523 idx = words.index(name)
524 fltr[name] = words[idx + 1]
529 if expected is not None:
530 fail(len(filters) != expected,
531 "%d ingress filters loaded, expected %d" %
532 (len(filters), expected))
535 def cls_filter_op(self, op, qdisc="ingress", prio=None, handle=None,
536 chain=None, cls="", params="",
537 fail=True, include_stderr=False):
540 spec += " prio %d" % (prio)
542 spec += " handle %s" % (handle)
543 if chain is not None:
544 spec += " chain %d" % (chain)
546 return tc("filter {op} dev {dev} {qdisc} {spec} {cls} {params}"\
547 .format(op=op, dev=self['ifname'], qdisc=qdisc, spec=spec,
548 cls=cls, params=params),
549 fail=fail, include_stderr=include_stderr)
551 def cls_bpf_add_filter(self, bpf, op="add", prio=None, handle=None,
552 chain=None, da=False, verbose=False,
553 skip_sw=False, skip_hw=False,
554 fail=True, include_stderr=False):
567 return self.cls_filter_op(op=op, prio=prio, handle=handle, cls=cls,
568 chain=chain, params=params,
569 fail=fail, include_stderr=include_stderr)
571 def set_ethtool_tc_offloads(self, enable, fail=True):
572 args = "hw-tc-offload %s" % ("on" if enable else "off")
573 return ethtool(self, "-K", args, fail=fail)
575 ################################################################################
577 global files, netns, devs
582 cmd("rm -f %s" % (f))
584 cmd("ip netns delete %s" % (ns))
588 def pin_prog(file_name, idx=0):
589 progs = bpftool_prog_list(expected=(idx + 1))
591 bpftool("prog pin id %d %s" % (prog["id"], file_name))
592 files.append(file_name)
594 return file_name, bpf_pinned(file_name)
596 def pin_map(file_name, idx=0, expected=1):
597 maps = bpftool_map_list(expected=expected)
599 bpftool("map pin id %d %s" % (m["id"], file_name))
600 files.append(file_name)
602 return file_name, bpf_pinned(file_name)
604 def check_dev_info_removed(prog_file=None, map_file=None):
605 bpftool_prog_list(expected=0)
606 ret, err = bpftool("prog show pin %s" % (prog_file), fail=False)
607 fail(ret == 0, "Showing prog with removed device did not fail")
608 fail(err["error"].find("No such device") == -1,
609 "Showing prog with removed device expected ENODEV, error is %s" %
612 bpftool_map_list(expected=0)
613 ret, err = bpftool("map show pin %s" % (map_file), fail=False)
614 fail(ret == 0, "Showing map with removed device did not fail")
615 fail(err["error"].find("No such device") == -1,
616 "Showing map with removed device expected ENODEV, error is %s" %
619 def check_dev_info(other_ns, ns, prog_file=None, map_file=None, removed=False):
620 progs = bpftool_prog_list(expected=1, ns=ns)
623 fail("dev" not in prog.keys(), "Device parameters not reported")
625 fail("ifindex" not in dev.keys(), "Device parameters not reported")
626 fail("ns_dev" not in dev.keys(), "Device parameters not reported")
627 fail("ns_inode" not in dev.keys(), "Device parameters not reported")
630 fail("ifname" not in dev.keys(), "Ifname not reported")
631 fail(dev["ifname"] != sim["ifname"],
632 "Ifname incorrect %s vs %s" % (dev["ifname"], sim["ifname"]))
634 fail("ifname" in dev.keys(), "Ifname is reported for other ns")
636 maps = bpftool_map_list(expected=2, ns=ns)
638 fail("dev" not in m.keys(), "Device parameters not reported")
639 fail(dev != m["dev"], "Map's device different than program's")
641 def check_extack(output, reference, args):
644 lines = output.split("\n")
645 comp = len(lines) >= 2 and lines[1] == 'Error: ' + reference
646 fail(not comp, "Missing or incorrect netlink extack message")
648 def check_extack_nsim(output, reference, args):
649 check_extack(output, "netdevsim: " + reference, args)
651 def check_no_extack(res, needle):
652 fail((res[1] + res[2]).count(needle) or (res[1] + res[2]).count("Warning:"),
653 "Found '%s' in command output, leaky extack?" % (needle))
655 def check_verifier_log(output, reference):
656 lines = output.split("\n")
657 for l in reversed(lines):
660 fail(True, "Missing or incorrect message from netdevsim in verifier log")
662 def check_multi_basic(two_xdps):
663 fail(two_xdps["mode"] != 4, "Bad mode reported with multiple programs")
664 fail("prog" in two_xdps, "Base program reported in multi program mode")
665 fail(len(two_xdps["attached"]) != 2,
666 "Wrong attached program count with two programs")
667 fail(two_xdps["attached"][0]["prog"]["id"] ==
668 two_xdps["attached"][1]["prog"]["id"],
669 "Offloaded and other programs have the same id")
671 def test_spurios_extack(sim, obj, skip_hw, needle):
672 res = sim.cls_bpf_add_filter(obj, prio=1, handle=1, skip_hw=skip_hw,
674 check_no_extack(res, needle)
675 res = sim.cls_bpf_add_filter(obj, op="replace", prio=1, handle=1,
676 skip_hw=skip_hw, include_stderr=True)
677 check_no_extack(res, needle)
678 res = sim.cls_filter_op(op="delete", prio=1, handle=1, cls="bpf",
680 check_no_extack(res, needle)
682 def test_multi_prog(simdev, sim, obj, modename, modeid):
683 start_test("Test multi-attachment XDP - %s + offload..." %
684 (modename or "default", ))
685 sim.set_xdp(obj, "offload")
686 xdp = sim.ip_link_show(xdp=True)["xdp"]
687 offloaded = sim.dfs_read("bpf_offloaded_id")
688 fail("prog" not in xdp, "Base program not reported in single program mode")
689 fail(len(xdp["attached"]) != 1,
690 "Wrong attached program count with one program")
692 sim.set_xdp(obj, modename)
693 two_xdps = sim.ip_link_show(xdp=True)["xdp"]
695 fail(xdp["attached"][0] not in two_xdps["attached"],
696 "Offload program not reported after other activated")
697 check_multi_basic(two_xdps)
699 offloaded2 = sim.dfs_read("bpf_offloaded_id")
700 fail(offloaded != offloaded2,
701 "Offload ID changed after loading other program")
703 start_test("Test multi-attachment XDP - replace...")
704 ret, _, err = sim.set_xdp(obj, "offload", fail=False, include_stderr=True)
705 fail(ret == 0, "Replaced one of programs without -force")
706 check_extack(err, "XDP program already attached.", args)
708 if modename == "" or modename == "drv":
709 othermode = "" if modename == "drv" else "drv"
710 start_test("Test multi-attachment XDP - detach...")
711 ret, _, err = sim.unset_xdp(othermode, force=True,
712 fail=False, include_stderr=True)
713 fail(ret == 0, "Removed program with a bad mode")
714 check_extack(err, "program loaded with different flags.", args)
716 sim.unset_xdp("offload")
717 xdp = sim.ip_link_show(xdp=True)["xdp"]
718 offloaded = sim.dfs_read("bpf_offloaded_id")
720 fail(xdp["mode"] != modeid, "Bad mode reported after multiple programs")
721 fail("prog" not in xdp,
722 "Base program not reported after multi program mode")
723 fail(xdp["attached"][0] not in two_xdps["attached"],
724 "Offload program not reported after other activated")
725 fail(len(xdp["attached"]) != 1,
726 "Wrong attached program count with remaining programs")
727 fail(offloaded != "0", "Offload ID reported with only other program left")
729 start_test("Test multi-attachment XDP - reattach...")
730 sim.set_xdp(obj, "offload")
731 two_xdps = sim.ip_link_show(xdp=True)["xdp"]
733 fail(xdp["attached"][0] not in two_xdps["attached"],
734 "Other program not reported after offload activated")
735 check_multi_basic(two_xdps)
737 start_test("Test multi-attachment XDP - device remove...")
740 simdev = NetdevSimDev()
742 sim.set_ethtool_tc_offloads(True)
746 parser = argparse.ArgumentParser()
747 parser.add_argument("--log", help="output verbose log to given file")
748 args = parser.parse_args()
750 logfile = open(args.log, 'w+')
751 logfile.write("# -*-Org-*-")
753 log("Prepare...", "", level=1)
757 skip(os.getuid() != 0, "test must be run as root")
760 ret, progs = bpftool("prog", fail=False)
761 skip(ret != 0, "bpftool not installed")
763 _, base_maps = bpftool("map")
766 ret, out = cmd("modprobe netdevsim", fail=False)
767 skip(ret != 0, "netdevsim module could not be loaded")
770 _, out = cmd("mount")
771 if out.find("/sys/kernel/debug type debugfs") == -1:
772 cmd("mount -t debugfs none /sys/kernel/debug")
774 # Check samples are compiled
775 samples = ["sample_ret0.o", "sample_map_ret0.o"]
777 ret, out = cmd("ls %s/%s" % (bpf_test_dir, s), fail=False)
778 skip(ret != 0, "sample %s/%s not found, please compile it" %
781 # Check if iproute2 is built with libmnl (needed by extack support)
782 _, _, err = cmd("tc qdisc delete dev lo handle 0",
783 fail=False, include_stderr=True)
784 if err.find("Error: Failed to find qdisc with specified handle.") == -1:
785 print("Warning: no extack message in iproute2 output, libmnl missing?")
786 log("Warning: no extack message in iproute2 output, libmnl missing?", "")
789 # Check if net namespaces seem to work
791 skip(ns is None, "Could not create a net namespace")
792 cmd("ip netns delete %s" % (ns))
796 obj = bpf_obj("sample_ret0.o")
797 bytecode = bpf_bytecode("1,6 0 0 4294967295,")
799 start_test("Test destruction of generic XDP...")
800 simdev = NetdevSimDev()
802 sim.set_xdp(obj, "generic")
804 bpftool_prog_list_wait(expected=0)
806 simdev = NetdevSimDev()
810 start_test("Test TC non-offloaded...")
811 ret, _ = sim.cls_bpf_add_filter(obj, skip_hw=True, fail=False)
812 fail(ret != 0, "Software TC filter did not load")
814 start_test("Test TC non-offloaded isn't getting bound...")
815 ret, _ = sim.cls_bpf_add_filter(obj, fail=False)
816 fail(ret != 0, "Software TC filter did not load")
817 simdev.dfs_get_bound_progs(expected=0)
819 sim.tc_flush_filters()
821 start_test("Test TC offloads are off by default...")
822 ret, _, err = sim.cls_bpf_add_filter(obj, skip_sw=True,
823 fail=False, include_stderr=True)
824 fail(ret == 0, "TC filter loaded without enabling TC offloads")
825 check_extack(err, "TC offload is disabled on net device.", args)
828 sim.set_ethtool_tc_offloads(True)
829 sim.dfs["bpf_tc_non_bound_accept"] = "Y"
831 start_test("Test TC offload by default...")
832 ret, _ = sim.cls_bpf_add_filter(obj, fail=False)
833 fail(ret != 0, "Software TC filter did not load")
834 simdev.dfs_get_bound_progs(expected=0)
835 ingress = sim.tc_show_ingress(expected=1)
837 fail(not fltr["in_hw"], "Filter not offloaded by default")
839 sim.tc_flush_filters()
841 start_test("Test TC cBPF bytcode tries offload by default...")
842 ret, _ = sim.cls_bpf_add_filter(bytecode, fail=False)
843 fail(ret != 0, "Software TC filter did not load")
844 simdev.dfs_get_bound_progs(expected=0)
845 ingress = sim.tc_show_ingress(expected=1)
847 fail(not fltr["in_hw"], "Bytecode not offloaded by default")
849 sim.tc_flush_filters()
850 sim.dfs["bpf_tc_non_bound_accept"] = "N"
852 start_test("Test TC cBPF unbound bytecode doesn't offload...")
853 ret, _, err = sim.cls_bpf_add_filter(bytecode, skip_sw=True,
854 fail=False, include_stderr=True)
855 fail(ret == 0, "TC bytecode loaded for offload")
856 check_extack_nsim(err, "netdevsim configured to reject unbound programs.",
860 start_test("Test non-0 chain offload...")
861 ret, _, err = sim.cls_bpf_add_filter(obj, chain=1, prio=1, handle=1,
863 fail=False, include_stderr=True)
864 fail(ret == 0, "Offloaded a filter to chain other than 0")
865 check_extack(err, "Driver supports only offload of chain 0.", args)
866 sim.tc_flush_filters()
868 start_test("Test TC replace...")
869 sim.cls_bpf_add_filter(obj, prio=1, handle=1)
870 sim.cls_bpf_add_filter(obj, op="replace", prio=1, handle=1)
871 sim.cls_filter_op(op="delete", prio=1, handle=1, cls="bpf")
873 sim.cls_bpf_add_filter(obj, prio=1, handle=1, skip_sw=True)
874 sim.cls_bpf_add_filter(obj, op="replace", prio=1, handle=1, skip_sw=True)
875 sim.cls_filter_op(op="delete", prio=1, handle=1, cls="bpf")
877 sim.cls_bpf_add_filter(obj, prio=1, handle=1, skip_hw=True)
878 sim.cls_bpf_add_filter(obj, op="replace", prio=1, handle=1, skip_hw=True)
879 sim.cls_filter_op(op="delete", prio=1, handle=1, cls="bpf")
881 start_test("Test TC replace bad flags...")
884 ret, _ = sim.cls_bpf_add_filter(obj, op="replace", prio=1, handle=1,
885 skip_sw=(j == 1), skip_hw=(j == 2),
887 fail(bool(ret) != bool(j),
888 "Software TC incorrect load in replace test, iteration %d" %
890 sim.cls_filter_op(op="delete", prio=1, handle=1, cls="bpf")
892 start_test("Test spurious extack from the driver...")
893 test_spurios_extack(sim, obj, False, "netdevsim")
894 test_spurios_extack(sim, obj, True, "netdevsim")
896 sim.set_ethtool_tc_offloads(False)
898 test_spurios_extack(sim, obj, False, "TC offload is disabled")
899 test_spurios_extack(sim, obj, True, "TC offload is disabled")
901 sim.set_ethtool_tc_offloads(True)
903 sim.tc_flush_filters()
905 start_test("Test TC offloads work...")
906 ret, _, err = sim.cls_bpf_add_filter(obj, verbose=True, skip_sw=True,
907 fail=False, include_stderr=True)
908 fail(ret != 0, "TC filter did not load with TC offloads enabled")
909 check_verifier_log(err, "[netdevsim] Hello from netdevsim!")
911 start_test("Test TC offload basics...")
912 dfs = simdev.dfs_get_bound_progs(expected=1)
913 progs = bpftool_prog_list(expected=1)
914 ingress = sim.tc_show_ingress(expected=1)
919 fail(fltr["skip_hw"], "TC does reports 'skip_hw' on offloaded filter")
920 fail(not fltr["in_hw"], "TC does not report 'in_hw' for offloaded filter")
921 fail(not fltr["skip_sw"], "TC does not report 'skip_sw' back")
923 start_test("Test TC offload is device-bound...")
924 fail(str(prog["id"]) != fltr["id"], "Program IDs don't match")
925 fail(prog["tag"] != fltr["tag"], "Program tags don't match")
926 fail(fltr["id"] != dprog["id"], "Program IDs don't match")
927 fail(dprog["state"] != "xlated", "Offloaded program state not translated")
928 fail(dprog["loaded"] != "Y", "Offloaded program is not loaded")
930 start_test("Test disabling TC offloads is rejected while filters installed...")
931 ret, _ = sim.set_ethtool_tc_offloads(False, fail=False)
932 fail(ret == 0, "Driver should refuse to disable TC offloads with filters installed...")
934 start_test("Test qdisc removal frees things...")
935 sim.tc_flush_filters()
936 sim.tc_show_ingress(expected=0)
938 start_test("Test disabling TC offloads is OK without filters...")
939 ret, _ = sim.set_ethtool_tc_offloads(False, fail=False)
941 "Driver refused to disable TC offloads without filters installed...")
943 sim.set_ethtool_tc_offloads(True)
945 start_test("Test destroying device gets rid of TC filters...")
946 sim.cls_bpf_add_filter(obj, skip_sw=True)
948 bpftool_prog_list_wait(expected=0)
950 simdev = NetdevSimDev()
952 sim.set_ethtool_tc_offloads(True)
954 start_test("Test destroying device gets rid of XDP...")
955 sim.set_xdp(obj, "offload")
957 bpftool_prog_list_wait(expected=0)
959 simdev = NetdevSimDev()
961 sim.set_ethtool_tc_offloads(True)
963 start_test("Test XDP prog reporting...")
964 sim.set_xdp(obj, "drv")
965 ipl = sim.ip_link_show(xdp=True)
966 progs = bpftool_prog_list(expected=1)
967 fail(ipl["xdp"]["prog"]["id"] != progs[0]["id"],
968 "Loaded program has wrong ID")
970 start_test("Test XDP prog replace without force...")
971 ret, _ = sim.set_xdp(obj, "drv", fail=False)
972 fail(ret == 0, "Replaced XDP program without -force")
973 sim.wait_for_flush(total=1)
975 start_test("Test XDP prog replace with force...")
976 ret, _ = sim.set_xdp(obj, "drv", force=True, fail=False)
977 fail(ret != 0, "Could not replace XDP program with -force")
978 bpftool_prog_list_wait(expected=1)
979 ipl = sim.ip_link_show(xdp=True)
980 progs = bpftool_prog_list(expected=1)
981 fail(ipl["xdp"]["prog"]["id"] != progs[0]["id"],
982 "Loaded program has wrong ID")
983 fail("dev" in progs[0].keys(),
984 "Device parameters reported for non-offloaded program")
986 start_test("Test XDP prog replace with bad flags...")
987 ret, _, err = sim.set_xdp(obj, "generic", force=True,
988 fail=False, include_stderr=True)
989 fail(ret == 0, "Replaced XDP program with a program in different mode")
991 "native and generic XDP can't be active at the same time.",
993 ret, _, err = sim.set_xdp(obj, "", force=True,
994 fail=False, include_stderr=True)
995 fail(ret == 0, "Replaced XDP program with a program in different mode")
996 check_extack(err, "program loaded with different flags.", args)
998 start_test("Test XDP prog remove with bad flags...")
999 ret, _, err = sim.unset_xdp("", force=True,
1000 fail=False, include_stderr=True)
1001 fail(ret == 0, "Removed program with a bad mode")
1002 check_extack(err, "program loaded with different flags.", args)
1004 start_test("Test MTU restrictions...")
1005 ret, _ = sim.set_mtu(9000, fail=False)
1007 "Driver should refuse to increase MTU to 9000 with XDP loaded...")
1008 sim.unset_xdp("drv")
1009 bpftool_prog_list_wait(expected=0)
1011 ret, _, err = sim.set_xdp(obj, "drv", fail=False, include_stderr=True)
1012 fail(ret == 0, "Driver should refuse to load program with MTU of 9000...")
1013 check_extack_nsim(err, "MTU too large w/ XDP enabled.", args)
1016 sim.wait_for_flush()
1017 start_test("Test non-offload XDP attaching to HW...")
1018 bpftool_prog_load("sample_ret0.o", "/sys/fs/bpf/nooffload")
1019 nooffload = bpf_pinned("/sys/fs/bpf/nooffload")
1020 ret, _, err = sim.set_xdp(nooffload, "offload",
1021 fail=False, include_stderr=True)
1022 fail(ret == 0, "attached non-offloaded XDP program to HW")
1023 check_extack_nsim(err, "xdpoffload of non-bound program.", args)
1024 rm("/sys/fs/bpf/nooffload")
1026 start_test("Test offload XDP attaching to drv...")
1027 bpftool_prog_load("sample_ret0.o", "/sys/fs/bpf/offload",
1029 offload = bpf_pinned("/sys/fs/bpf/offload")
1030 ret, _, err = sim.set_xdp(offload, "drv", fail=False, include_stderr=True)
1031 fail(ret == 0, "attached offloaded XDP program to drv")
1032 check_extack(err, "using device-bound program without HW_MODE flag is not supported.", args)
1033 rm("/sys/fs/bpf/offload")
1034 sim.wait_for_flush()
1036 start_test("Test XDP offload...")
1037 _, _, err = sim.set_xdp(obj, "offload", verbose=True, include_stderr=True)
1038 ipl = sim.ip_link_show(xdp=True)
1039 link_xdp = ipl["xdp"]["prog"]
1040 progs = bpftool_prog_list(expected=1)
1042 fail(link_xdp["id"] != prog["id"], "Loaded program has wrong ID")
1043 check_verifier_log(err, "[netdevsim] Hello from netdevsim!")
1045 start_test("Test XDP offload is device bound...")
1046 dfs = simdev.dfs_get_bound_progs(expected=1)
1049 fail(prog["id"] != link_xdp["id"], "Program IDs don't match")
1050 fail(prog["tag"] != link_xdp["tag"], "Program tags don't match")
1051 fail(str(link_xdp["id"]) != dprog["id"], "Program IDs don't match")
1052 fail(dprog["state"] != "xlated", "Offloaded program state not translated")
1053 fail(dprog["loaded"] != "Y", "Offloaded program is not loaded")
1055 start_test("Test removing XDP program many times...")
1056 sim.unset_xdp("offload")
1057 sim.unset_xdp("offload")
1058 sim.unset_xdp("drv")
1059 sim.unset_xdp("drv")
1062 bpftool_prog_list_wait(expected=0)
1064 start_test("Test attempt to use a program for a wrong device...")
1065 simdev2 = NetdevSimDev()
1066 sim2, = simdev2.nsims
1067 sim2.set_xdp(obj, "offload")
1068 pin_file, pinned = pin_prog("/sys/fs/bpf/tmp")
1070 ret, _, err = sim.set_xdp(pinned, "offload",
1071 fail=False, include_stderr=True)
1072 fail(ret == 0, "Pinned program loaded for a different device accepted")
1073 check_extack_nsim(err, "program bound to different dev.", args)
1075 ret, _, err = sim.set_xdp(pinned, "offload",
1076 fail=False, include_stderr=True)
1077 fail(ret == 0, "Pinned program loaded for a removed device accepted")
1078 check_extack_nsim(err, "xdpoffload of non-bound program.", args)
1080 bpftool_prog_list_wait(expected=0)
1082 simdev, sim = test_multi_prog(simdev, sim, obj, "", 1)
1083 simdev, sim = test_multi_prog(simdev, sim, obj, "drv", 1)
1084 simdev, sim = test_multi_prog(simdev, sim, obj, "generic", 2)
1086 start_test("Test mixing of TC and XDP...")
1087 sim.tc_add_ingress()
1088 sim.set_xdp(obj, "offload")
1089 ret, _, err = sim.cls_bpf_add_filter(obj, skip_sw=True,
1090 fail=False, include_stderr=True)
1091 fail(ret == 0, "Loading TC when XDP active should fail")
1092 check_extack_nsim(err, "driver and netdev offload states mismatch.", args)
1093 sim.unset_xdp("offload")
1094 sim.wait_for_flush()
1096 sim.cls_bpf_add_filter(obj, skip_sw=True)
1097 ret, _, err = sim.set_xdp(obj, "offload", fail=False, include_stderr=True)
1098 fail(ret == 0, "Loading XDP when TC active should fail")
1099 check_extack_nsim(err, "TC program is already loaded.", args)
1101 start_test("Test binding TC from pinned...")
1102 pin_file, pinned = pin_prog("/sys/fs/bpf/tmp")
1103 sim.tc_flush_filters(bound=1, total=1)
1104 sim.cls_bpf_add_filter(pinned, da=True, skip_sw=True)
1105 sim.tc_flush_filters(bound=1, total=1)
1107 start_test("Test binding XDP from pinned...")
1108 sim.set_xdp(obj, "offload")
1109 pin_file, pinned = pin_prog("/sys/fs/bpf/tmp2", idx=1)
1111 sim.set_xdp(pinned, "offload", force=True)
1112 sim.unset_xdp("offload")
1113 sim.set_xdp(pinned, "offload", force=True)
1114 sim.unset_xdp("offload")
1116 start_test("Test offload of wrong type fails...")
1117 ret, _ = sim.cls_bpf_add_filter(pinned, da=True, skip_sw=True, fail=False)
1118 fail(ret == 0, "Managed to attach XDP program to TC")
1120 start_test("Test asking for TC offload of two filters...")
1121 sim.cls_bpf_add_filter(obj, da=True, skip_sw=True)
1122 ret, _, err = sim.cls_bpf_add_filter(obj, da=True, skip_sw=True,
1123 fail=False, include_stderr=True)
1124 fail(ret == 0, "Managed to offload two TC filters at the same time")
1125 check_extack_nsim(err, "driver and netdev offload states mismatch.", args)
1127 sim.tc_flush_filters(bound=2, total=2)
1129 start_test("Test if netdev removal waits for translation...")
1131 sim.dfs["dev/bpf_bind_verifier_delay"] = delay_msec
1133 cmd_line = "tc filter add dev %s ingress bpf %s da skip_sw" % \
1134 (sim['ifname'], obj)
1135 tc_proc = cmd(cmd_line, background=True, fail=False)
1136 # Wait for the verifier to start
1137 while simdev.dfs_num_bound_progs() <= 2:
1141 ret, _ = cmd_result(tc_proc, fail=False)
1142 time_diff = end - start
1143 log("Time", "start:\t%s\nend:\t%s\ndiff:\t%s" % (start, end, time_diff))
1145 fail(ret == 0, "Managed to load TC filter on a unregistering device")
1146 delay_sec = delay_msec * 0.001
1147 fail(time_diff < delay_sec, "Removal process took %s, expected %s" %
1148 (time_diff, delay_sec))
1150 # Remove all pinned files and reinstantiate the netdev
1152 bpftool_prog_list_wait(expected=0)
1154 simdev = NetdevSimDev()
1156 map_obj = bpf_obj("sample_map_ret0.o")
1157 start_test("Test loading program with maps...")
1158 sim.set_xdp(map_obj, "offload", JSON=False) # map fixup msg breaks JSON
1160 start_test("Test bpftool bound info reporting (own ns)...")
1161 check_dev_info(False, "")
1163 start_test("Test bpftool bound info reporting (other ns)...")
1166 check_dev_info(True, "")
1168 start_test("Test bpftool bound info reporting (remote ns)...")
1169 check_dev_info(False, ns)
1171 start_test("Test bpftool bound info reporting (back to own ns)...")
1173 check_dev_info(False, "")
1175 prog_file, _ = pin_prog("/sys/fs/bpf/tmp_prog")
1176 map_file, _ = pin_map("/sys/fs/bpf/tmp_map", idx=1, expected=2)
1179 start_test("Test bpftool bound info reporting (removed dev)...")
1180 check_dev_info_removed(prog_file=prog_file, map_file=map_file)
1182 # Remove all pinned files and reinstantiate the netdev
1184 bpftool_prog_list_wait(expected=0)
1186 simdev = NetdevSimDev()
1189 start_test("Test map update (no flags)...")
1190 sim.set_xdp(map_obj, "offload", JSON=False) # map fixup msg breaks JSON
1191 maps = bpftool_map_list(expected=2)
1192 array = maps[0] if maps[0]["type"] == "array" else maps[1]
1193 htab = maps[0] if maps[0]["type"] == "hash" else maps[1]
1196 bpftool("map update id %d key %s value %s" %
1197 (m["id"], int2str("I", i), int2str("Q", i * 3)))
1200 ret, _ = bpftool("map update id %d key %s value %s" %
1201 (m["id"], int2str("I", 3), int2str("Q", 3 * 3)),
1203 fail(ret == 0, "added too many entries")
1205 start_test("Test map update (exists)...")
1208 bpftool("map update id %d key %s value %s exist" %
1209 (m["id"], int2str("I", i), int2str("Q", i * 3)))
1212 ret, err = bpftool("map update id %d key %s value %s exist" %
1213 (m["id"], int2str("I", 3), int2str("Q", 3 * 3)),
1215 fail(ret == 0, "updated non-existing key")
1216 fail(err["error"].find("No such file or directory") == -1,
1217 "expected ENOENT, error is '%s'" % (err["error"]))
1219 start_test("Test map update (noexist)...")
1222 ret, err = bpftool("map update id %d key %s value %s noexist" %
1223 (m["id"], int2str("I", i), int2str("Q", i * 3)),
1225 fail(ret == 0, "updated existing key")
1226 fail(err["error"].find("File exists") == -1,
1227 "expected EEXIST, error is '%s'" % (err["error"]))
1229 start_test("Test map dump...")
1231 _, entries = bpftool("map dump id %d" % (m["id"]))
1233 key = str2int(entries[i]["key"])
1234 fail(key != i, "expected key %d, got %d" % (key, i))
1235 val = str2int(entries[i]["value"])
1236 fail(val != i * 3, "expected value %d, got %d" % (val, i * 3))
1238 start_test("Test map getnext...")
1240 _, entry = bpftool("map getnext id %d" % (m["id"]))
1241 key = str2int(entry["next_key"])
1242 fail(key != 0, "next key %d, expected %d" % (key, 0))
1243 _, entry = bpftool("map getnext id %d key %s" %
1244 (m["id"], int2str("I", 0)))
1245 key = str2int(entry["next_key"])
1246 fail(key != 1, "next key %d, expected %d" % (key, 1))
1247 ret, err = bpftool("map getnext id %d key %s" %
1248 (m["id"], int2str("I", 1)), fail=False)
1249 fail(ret == 0, "got next key past the end of map")
1250 fail(err["error"].find("No such file or directory") == -1,
1251 "expected ENOENT, error is '%s'" % (err["error"]))
1253 start_test("Test map delete (htab)...")
1255 bpftool("map delete id %d key %s" % (htab["id"], int2str("I", i)))
1257 start_test("Test map delete (array)...")
1259 ret, err = bpftool("map delete id %d key %s" %
1260 (htab["id"], int2str("I", i)), fail=False)
1261 fail(ret == 0, "removed entry from an array")
1262 fail(err["error"].find("No such file or directory") == -1,
1263 "expected ENOENT, error is '%s'" % (err["error"]))
1265 start_test("Test map remove...")
1266 sim.unset_xdp("offload")
1267 bpftool_map_list_wait(expected=0)
1270 simdev = NetdevSimDev()
1272 sim.set_xdp(map_obj, "offload", JSON=False) # map fixup msg breaks JSON
1274 bpftool_map_list_wait(expected=0)
1276 start_test("Test map creation fail path...")
1277 simdev = NetdevSimDev()
1279 sim.dfs["bpf_map_accept"] = "N"
1280 ret, _ = sim.set_xdp(map_obj, "offload", JSON=False, fail=False)
1282 "netdevsim didn't refuse to create a map with offload disabled")
1286 start_test("Test multi-dev ASIC program reuse...")
1287 simdevA = NetdevSimDev()
1288 simA, = simdevA.nsims
1289 simdevB = NetdevSimDev(3)
1290 simB1, simB2, simB3 = simdevB.nsims
1291 sims = (simA, simB1, simB2, simB3)
1292 simB = (simB1, simB2, simB3)
1294 bpftool_prog_load("sample_map_ret0.o", "/sys/fs/bpf/nsimA",
1296 progA = bpf_pinned("/sys/fs/bpf/nsimA")
1297 bpftool_prog_load("sample_map_ret0.o", "/sys/fs/bpf/nsimB",
1298 dev=simB1['ifname'])
1299 progB = bpf_pinned("/sys/fs/bpf/nsimB")
1301 simA.set_xdp(progA, "offload", JSON=False)
1302 for d in simdevB.nsims:
1303 d.set_xdp(progB, "offload", JSON=False)
1305 start_test("Test multi-dev ASIC cross-dev replace...")
1306 ret, _ = simA.set_xdp(progB, "offload", force=True, JSON=False, fail=False)
1307 fail(ret == 0, "cross-ASIC program allowed")
1308 for d in simdevB.nsims:
1309 ret, _ = d.set_xdp(progA, "offload", force=True, JSON=False, fail=False)
1310 fail(ret == 0, "cross-ASIC program allowed")
1312 start_test("Test multi-dev ASIC cross-dev install...")
1314 d.unset_xdp("offload")
1316 ret, _, err = simA.set_xdp(progB, "offload", force=True, JSON=False,
1317 fail=False, include_stderr=True)
1318 fail(ret == 0, "cross-ASIC program allowed")
1319 check_extack_nsim(err, "program bound to different dev.", args)
1320 for d in simdevB.nsims:
1321 ret, _, err = d.set_xdp(progA, "offload", force=True, JSON=False,
1322 fail=False, include_stderr=True)
1323 fail(ret == 0, "cross-ASIC program allowed")
1324 check_extack_nsim(err, "program bound to different dev.", args)
1326 start_test("Test multi-dev ASIC cross-dev map reuse...")
1328 mapA = bpftool("prog show %s" % (progA))[1]["map_ids"][0]
1329 mapB = bpftool("prog show %s" % (progB))[1]["map_ids"][0]
1331 ret, _ = bpftool_prog_load("sample_map_ret0.o", "/sys/fs/bpf/nsimB_",
1332 dev=simB3['ifname'],
1333 maps=["idx 0 id %d" % (mapB)],
1335 fail(ret != 0, "couldn't reuse a map on the same ASIC")
1336 rm("/sys/fs/bpf/nsimB_")
1338 ret, _, err = bpftool_prog_load("sample_map_ret0.o", "/sys/fs/bpf/nsimA_",
1340 maps=["idx 0 id %d" % (mapB)],
1341 fail=False, include_stderr=True)
1342 fail(ret == 0, "could reuse a map on a different ASIC")
1343 fail(err.count("offload device mismatch between prog and map") == 0,
1344 "error message missing for cross-ASIC map")
1346 ret, _, err = bpftool_prog_load("sample_map_ret0.o", "/sys/fs/bpf/nsimB_",
1347 dev=simB1['ifname'],
1348 maps=["idx 0 id %d" % (mapA)],
1349 fail=False, include_stderr=True)
1350 fail(ret == 0, "could reuse a map on a different ASIC")
1351 fail(err.count("offload device mismatch between prog and map") == 0,
1352 "error message missing for cross-ASIC map")
1354 start_test("Test multi-dev ASIC cross-dev destruction...")
1355 bpftool_prog_list_wait(expected=2)
1358 bpftool_prog_list_wait(expected=1)
1360 ifnameB = bpftool("prog show %s" % (progB))[1]["dev"]["ifname"]
1361 fail(ifnameB != simB1['ifname'], "program not bound to original device")
1363 bpftool_prog_list_wait(expected=1)
1365 start_test("Test multi-dev ASIC cross-dev destruction - move...")
1366 ifnameB = bpftool("prog show %s" % (progB))[1]["dev"]["ifname"]
1367 fail(ifnameB not in (simB2['ifname'], simB3['ifname']),
1368 "program not bound to remaining devices")
1371 ifnameB = bpftool("prog show %s" % (progB))[1]["dev"]["ifname"]
1372 fail(ifnameB != simB3['ifname'], "program not bound to remaining device")
1376 bpftool_prog_list_wait(expected=0)
1378 start_test("Test multi-dev ASIC cross-dev destruction - orphaned...")
1379 ret, out = bpftool("prog show %s" % (progB), fail=False)
1380 fail(ret == 0, "got information about orphaned program")
1381 fail("error" not in out, "no error reported for get info on orphaned")
1382 fail(out["error"] != "can't get prog info: No such device",
1383 "wrong error for get info on orphaned")
1385 print("%s: OK" % (os.path.basename(__file__)))
1388 log("Clean up...", "", level=1)