pg: A Tunnel mode variant of a pg interface
[vpp.git] / test / vpp_pg_interface.py
old mode 100644 (file)
new mode 100755 (executable)
index 4707f0b..567b81d
@@ -1,11 +1,15 @@
 import os
-import time
 import socket
+from socket import inet_pton, inet_ntop
 import struct
+import time
 from traceback import format_exc, format_stack
+
+import scapy.compat
 from scapy.utils import wrpcap, rdpcap, PcapReader
 from scapy.plist import PacketList
 from vpp_interface import VppInterface
+from vpp_papi import VppEnum
 
 from scapy.layers.l2 import Ether, ARP
 from scapy.layers.inet6 import IPv6, ICMPv6ND_NS, ICMPv6ND_NA,\
@@ -13,7 +17,6 @@ from scapy.layers.inet6 import IPv6, ICMPv6ND_NS, ICMPv6ND_NA,\
     IPv6ExtHdrHopByHop
 from util import ppp, ppc
 from scapy.utils6 import in6_getnsma, in6_getnsmac, in6_ismaddr
-from scapy.utils import inet_pton, inet_ntop
 
 
 class CaptureTimeoutError(Exception):
@@ -43,30 +46,57 @@ class VppPGInterface(VppInterface):
         """packet-generator interface index assigned by VPP"""
         return self._pg_index
 
+    @property
+    def gso_enabled(self):
+        """gso enabled on packet-generator interface"""
+        if self._gso_enabled == 0:
+            return "gso-disabled"
+        return "gso-enabled"
+
+    @property
+    def gso_size(self):
+        """gso size on packet-generator interface"""
+        return self._gso_size
+
+    @property
+    def coalesce_is_enabled(self):
+        """coalesce enabled on packet-generator interface"""
+        if self._coalesce_enabled == 0:
+            return "coalesce-disabled"
+        return "coalesce-enabled"
+
     @property
     def out_path(self):
         """pcap file path - captured packets"""
         return self._out_path
 
-    @property
-    def in_path(self):
+    def get_in_path(self, worker):
         """ pcap file path - injected packets"""
-        return self._in_path
+        if worker is not None:
+            return "%s/pg%u_wrk%u_in.pcap" % (self.test.tempdir, self.pg_index,
+                                              worker)
+        return "%s/pg%u_in.pcap" % (self.test.tempdir, self.pg_index)
 
     @property
     def capture_cli(self):
         """CLI string to start capture on this interface"""
         return self._capture_cli
 
-    @property
-    def cap_name(self):
-        """capture name for this interface"""
+    def get_cap_name(self, worker=None):
+        """return capture name for this interface and given worker"""
+        if worker is not None:
+            return self._cap_name + "-worker%d" % worker
         return self._cap_name
 
-    @property
-    def input_cli(self):
-        """CLI string to load the injected packets"""
-        return self._input_cli
+    def get_input_cli(self, nb_replays=None, worker=None):
+        """return CLI string to load the injected packets"""
+        input_cli = "packet-generator new pcap %s source pg%u name %s" % (
+            self.get_in_path(worker), self.pg_index, self.get_cap_name(worker))
+        if nb_replays is not None:
+            return "%s limit %d" % (input_cli, nb_replays)
+        if worker is not None:
+            return "%s worker %d" % (input_cli, worker)
+        return input_cli
 
     @property
     def in_history_counter(self):
@@ -82,71 +112,82 @@ class VppPGInterface(VppInterface):
         self._out_history_counter += 1
         return v
 
-    def __init__(self, test, pg_index):
+    def __init__(self, test, pg_index, gso, gso_size, mode):
         """ Create VPP packet-generator interface """
-        r = test.vapi.pg_create_interface(pg_index)
-        self._sw_if_index = r.sw_if_index
+        super().__init__(test)
 
-        super(VppPGInterface, self).__init__(test)
+        r = test.vapi.pg_create_interface_v2(pg_index, gso, gso_size, mode)
+        self.set_sw_if_index(r.sw_if_index)
 
         self._in_history_counter = 0
         self._out_history_counter = 0
         self._out_assert_counter = 0
         self._pg_index = pg_index
+        self._gso_enabled = gso
+        self._gso_size = gso_size
+        self._coalesce_enabled = 0
         self._out_file = "pg%u_out.pcap" % self.pg_index
         self._out_path = self.test.tempdir + "/" + self._out_file
-        self._in_file = "pg%u_in.pcap" % self.pg_index
-        self._in_path = self.test.tempdir + "/" + self._in_file
         self._capture_cli = "packet-generator capture pg%u pcap %s" % (
             self.pg_index, self.out_path)
-        self._cap_name = "pcap%u" % self.sw_if_index
-        self._input_cli = \
-            "packet-generator new pcap %s source pg%u name %s" % (
-                self.in_path, self.pg_index, self.cap_name)
+        self._cap_name = "pcap%u-sw_if_index-%s" % (
+            self.pg_index, self.sw_if_index)
 
-    def enable_capture(self):
-        """ Enable capture on this packet-generator interface"""
+    def rename_old_pcap_file(self, path, counter):
+        filename = os.path.basename(path)
         try:
-            if os.path.isfile(self.out_path):
+            if os.path.isfile(path):
                 name = "%s/history.[timestamp:%f].[%s-counter:%04d].%s" % \
                     (self.test.tempdir,
                      time.time(),
                      self.name,
-                     self.out_history_counter,
-                     self._out_file)
+                     counter,
+                     filename)
                 self.test.logger.debug("Renaming %s->%s" %
-                                       (self.out_path, name))
-                os.rename(self.out_path, name)
-        except:
-            pass
+                                       (path, name))
+                os.rename(path, name)
+        except OSError:
+            self.test.logger.debug("OSError: Could not rename %s %s" %
+                                   (path, filename))
+
+    def enable_capture(self):
+        """ Enable capture on this packet-generator interface
+            of at most n packets.
+            If n < 0, this is no limit
+        """
+        # disable the capture to flush the capture
+        self.disable_capture()
+        self.rename_old_pcap_file(self.out_path, self.out_history_counter)
         # FIXME this should be an API, but no such exists atm
         self.test.vapi.cli(self.capture_cli)
         self._pcap_reader = None
 
-    def add_stream(self, pkts):
+    def disable_capture(self):
+        self.test.vapi.cli("%s disable" % self.capture_cli)
+
+    def coalesce_enable(self):
+        """ Enable packet coalesce on this packet-generator interface"""
+        self._coalesce_enabled = 1
+        self.test.vapi.pg_interface_enable_disable_coalesce(self.sw_if_index,
+                                                            1)
+
+    def coalesce_disable(self):
+        """ Disable packet coalesce on this packet-generator interface"""
+        self._coalesce_enabled = 0
+        self.test.vapi.pg_interface_enable_disable_coalesce(self.sw_if_index,
+                                                            0)
+
+    def add_stream(self, pkts, nb_replays=None, worker=None):
         """
         Add a stream of packets to this packet-generator
 
         :param pkts: iterable packets
 
         """
-        try:
-            if os.path.isfile(self.in_path):
-                name = "%s/history.[timestamp:%f].[%s-counter:%04d].%s" %\
-                    (self.test.tempdir,
-                     time.time(),
-                     self.name,
-                     self.in_history_counter,
-                     self._in_file)
-                self.test.logger.debug("Renaming %s->%s" %
-                                       (self.in_path, name))
-                os.rename(self.in_path, name)
-        except:
-            pass
-        wrpcap(self.in_path, pkts)
-        self.test.register_capture(self.cap_name)
+        wrpcap(self.get_in_path(worker), pkts)
+        self.test.register_pcap(self, worker)
         # FIXME this should be an API, but no such exists atm
-        self.test.vapi.cli(self.input_cli)
+        self.test.vapi.cli(self.get_input_cli(nb_replays, worker))
 
     def generate_debug_aid(self, kind):
         """ Create a hardlink to the out file with a counter and a file
@@ -220,6 +261,10 @@ class VppPGInterface(VppInterface):
                 if len(capture.res) == expected_count:
                     # bingo, got the packets we expected
                     return capture
+                elif len(capture.res) > expected_count:
+                    self.test.logger.error(
+                        ppc("Unexpected packets captured:", capture))
+                    break
                 else:
                     self.test.logger.debug("Partial capture containing %s "
                                            "packets doesn't match expected "
@@ -251,8 +296,6 @@ class VppPGInterface(VppInterface):
                 if not capture or len(capture.res) == 0:
                     # junk filtered out, we're good
                     return
-                self.test.logger.error(
-                    ppc("Unexpected packets captured:", capture))
             except:
                 pass
             self.generate_debug_aid("empty-assert")
@@ -264,6 +307,20 @@ class VppPGInterface(VppInterface):
                 raise AssertionError("Capture file present for interface %s" %
                                      self.name)
 
+    def wait_for_pg_stop(self):
+        # wait till packet-generator is stopped
+        # "show packet-generator" while it is still running gives this:
+        # Name               Enabled        Count     Parameters
+        # pcap0-sw_if_inde     Yes           64       limit 64, ...
+        #
+        # also have a 5-minute timeout just in case things go terribly wrong...
+        deadline = time.time() + 300
+        while self.test.vapi.cli('show packet-generator').find("Yes") != -1:
+            self._test.sleep(0.01)  # yield
+            if time.time() > deadline:
+                self.test.logger.debug("Timeout waiting for pg to stop")
+                break
+
     def wait_for_capture_file(self, timeout=1):
         """
         Wait until pcap capture file appears
@@ -272,6 +329,7 @@ class VppPGInterface(VppInterface):
 
         :returns: True/False if the file is present or appears within timeout
         """
+        self.wait_for_pg_stop()
         deadline = time.time() + timeout
         if not os.path.isfile(self.out_path):
             self.test.logger.debug("Waiting for capture file %s to appear, "
@@ -283,7 +341,7 @@ class VppPGInterface(VppInterface):
         while time.time() < deadline:
             if os.path.isfile(self.out_path):
                 break
-            time.sleep(0)  # yield
+            self._test.sleep(0)  # yield
         if os.path.isfile(self.out_path):
             self.test.logger.debug("Capture file appeared after %fs" %
                                    (time.time() - (deadline - timeout)))
@@ -351,7 +409,7 @@ class VppPGInterface(VppInterface):
             self.test.logger.debug("Polling for packet")
         while time.time() < deadline or poll:
             if not self.verify_enough_packet_data_in_pcap():
-                time.sleep(0)  # yield
+                self._test.sleep(0)  # yield
                 poll = False
                 continue
             p = self._pcap_reader.recv()
@@ -365,7 +423,7 @@ class VppPGInterface(VppInterface):
                         "Packet received after %fs" %
                         (time.time() - (deadline - timeout)))
                     return p
-            time.sleep(0)  # yield
+            self._test.sleep(0)  # yield
             poll = False
         self.test.logger.debug("Timeout - no packets received")
         raise CaptureTimeoutError("Packet didn't arrive within timeout")
@@ -376,14 +434,16 @@ class VppPGInterface(VppInterface):
                 ARP(op=ARP.who_has, pdst=self.local_ip4,
                     psrc=self.remote_ip4, hwsrc=self.remote_mac))
 
-    def create_ndp_req(self):
+    def create_ndp_req(self, addr=None):
         """Create NDP - NS applicable for this interface"""
-        nsma = in6_getnsma(inet_pton(socket.AF_INET6, self.local_ip6))
+        if not addr:
+            addr = self.local_ip6
+        nsma = in6_getnsma(inet_pton(socket.AF_INET6, addr))
         d = inet_ntop(socket.AF_INET6, nsma)
 
         return (Ether(dst=in6_getnsmac(nsma)) /
                 IPv6(dst=d, src=self.remote_ip6) /
-                ICMPv6ND_NS(tgt=self.local_ip6) /
+                ICMPv6ND_NS(tgt=addr) /
                 ICMPv6NDOptSrcLLAddr(lladdr=self.remote_mac))
 
     def resolve_arp(self, pg_interface=None):
@@ -409,10 +469,6 @@ class VppPGInterface(VppInterface):
                                   pg_interface.name)
             return
         arp_reply = captured_packet.copy()  # keep original for exception
-        # Make Dot1AD packet content recognizable to scapy
-        if arp_reply.type == 0x88a8:
-            arp_reply.type = 0x8100
-            arp_reply = Ether(str(arp_reply))
         try:
             if arp_reply[ARP].op == ARP.is_at:
                 self.test.logger.info("VPP %s MAC address is %s " %
@@ -426,19 +482,22 @@ class VppPGInterface(VppInterface):
                 ppp("Unexpected response to ARP request:", captured_packet))
             raise
 
-    def resolve_ndp(self, pg_interface=None, timeout=1):
+    def resolve_ndp(self, pg_interface=None, timeout=1, link_layer=False):
         """Resolve NDP using provided packet-generator interface
 
         :param pg_interface: interface used to resolve, if None then this
             interface is used
         :param timeout: how long to wait for response before giving up
+        :param link_layer: resolve for global address if False (default)
+            or for link-layer address if True
 
         """
         if pg_interface is None:
             pg_interface = self
+        addr = self.local_ip6_ll if link_layer else self.local_ip6
         self.test.logger.info("Sending NDP request for %s on port %s" %
-                              (self.local_ip6, pg_interface.name))
-        ndp_req = self.create_ndp_req()
+                              (addr, pg_interface.name))
+        ndp_req = self.create_ndp_req(addr)
         pg_interface.add_stream(ndp_req)
         pg_interface.enable_capture()
         self.test.pg_start()
@@ -456,10 +515,6 @@ class VppPGInterface(VppInterface):
                     "Timeout while waiting for NDP response")
                 raise
             ndp_reply = captured_packet.copy()  # keep original for exception
-            # Make Dot1AD packet content recognizable to scapy
-            if ndp_reply.type == 0x88a8:
-                ndp_reply.type = 0x8100
-                ndp_reply = Ether(str(ndp_reply))
             try:
                 ndp_na = ndp_reply[ICMPv6ND_NA]
                 opt = ndp_na[ICMPv6NDOptDstLLAddr]