test/vpp_pg_interface.py

   1 import os
   2 import time
   3 import socket
   4 import struct
   5 from traceback import format_exc, format_stack
   6 from scapy.utils import wrpcap, rdpcap, PcapReader
   7 from scapy.plist import PacketList
   8 from vpp_interface import VppInterface
   9
  10 from scapy.layers.l2 import Ether, ARP
  11 from scapy.layers.inet6 import IPv6, ICMPv6ND_NS, ICMPv6ND_NA,\
  12     ICMPv6NDOptSrcLLAddr, ICMPv6NDOptDstLLAddr, ICMPv6ND_RA, RouterAlert, \
  13     IPv6ExtHdrHopByHop
  14 from util import ppp, ppc
  15 from scapy.utils6 import in6_getnsma, in6_getnsmac, in6_ismaddr
  16 from scapy.utils import inet_pton, inet_ntop
  17
  18
  19 class CaptureTimeoutError(Exception):
  20     """ Exception raised if capture or packet doesn't appear within timeout """
  21     pass
  22
  23
  24 def is_ipv6_misc(p):
  25     """ Is packet one of uninteresting IPv6 broadcasts? """
  26     if p.haslayer(ICMPv6ND_RA):
  27         if in6_ismaddr(p[IPv6].dst):
  28             return True
  29     if p.haslayer(IPv6ExtHdrHopByHop):
  30         for o in p[IPv6ExtHdrHopByHop].options:
  31             if isinstance(o, RouterAlert):
  32                 return True
  33     return False
  34
  35
  36 class VppPGInterface(VppInterface):
  37     """
  38     VPP packet-generator interface
  39     """
  40
  41     @property
  42     def pg_index(self):
  43         """packet-generator interface index assigned by VPP"""
  44         return self._pg_index
  45
  46     @property
  47     def out_path(self):
  48         """pcap file path - captured packets"""
  49         return self._out_path
  50
  51     @property
  52     def in_path(self):
  53         """ pcap file path - injected packets"""
  54         return self._in_path
  55
  56     @property
  57     def capture_cli(self):
  58         """CLI string to start capture on this interface"""
  59         return self._capture_cli
  60
  61     @property
  62     def cap_name(self):
  63         """capture name for this interface"""
  64         return self._cap_name
  65
  66     @property
  67     def input_cli(self):
  68         """CLI string to load the injected packets"""
  69         return self._input_cli
  70
  71     @property
  72     def in_history_counter(self):
  73         """Self-incrementing counter used when renaming old pcap files"""
  74         v = self._in_history_counter
  75         self._in_history_counter += 1
  76         return v
  77
  78     @property
  79     def out_history_counter(self):
  80         """Self-incrementing counter used when renaming old pcap files"""
  81         v = self._out_history_counter
  82         self._out_history_counter += 1
  83         return v
  84
  85     def __init__(self, test, pg_index):
  86         """ Create VPP packet-generator interface """
  87         r = test.vapi.pg_create_interface(pg_index)
  88         self._sw_if_index = r.sw_if_index
  89
  90         super(VppPGInterface, self).__init__(test)
  91
  92         self._in_history_counter = 0
  93         self._out_history_counter = 0
  94         self._out_assert_counter = 0
  95         self._pg_index = pg_index
  96         self._out_file = "pg%u_out.pcap" % self.pg_index
  97         self._out_path = self.test.tempdir + "/" + self._out_file
  98         self._in_file = "pg%u_in.pcap" % self.pg_index
  99         self._in_path = self.test.tempdir + "/" + self._in_file
 100         self._capture_cli = "packet-generator capture pg%u pcap %s" % (
 101             self.pg_index, self.out_path)
 102         self._cap_name = "pcap%u" % self.sw_if_index
 103         self._input_cli = \
 104             "packet-generator new pcap %s source pg%u name %s" % (
 105                 self.in_path, self.pg_index, self.cap_name)
 106
 107     def enable_capture(self):
 108         """ Enable capture on this packet-generator interface"""
 109         try:
 110             if os.path.isfile(self.out_path):
 111                 name = "%s/history.[timestamp:%f].[%s-counter:%04d].%s" % \
 112                     (self.test.tempdir,
 113                      time.time(),
 114                      self.name,
 115                      self.out_history_counter,
 116                      self._out_file)
 117                 self.test.logger.debug("Renaming %s->%s" %
 118                                        (self.out_path, name))
 119                 os.rename(self.out_path, name)
 120         except:
 121             pass
 122         # FIXME this should be an API, but no such exists atm
 123         self.test.vapi.cli(self.capture_cli)
 124         self._pcap_reader = None
 125
 126     def add_stream(self, pkts):
 127         """
 128         Add a stream of packets to this packet-generator
 129
 130         :param pkts: iterable packets
 131
 132         """
 133         try:
 134             if os.path.isfile(self.in_path):
 135                 name = "%s/history.[timestamp:%f].[%s-counter:%04d].%s" %\
 136                     (self.test.tempdir,
 137                      time.time(),
 138                      self.name,
 139                      self.in_history_counter,
 140                      self._in_file)
 141                 self.test.logger.debug("Renaming %s->%s" %
 142                                        (self.in_path, name))
 143                 os.rename(self.in_path, name)
 144         except:
 145             pass
 146         wrpcap(self.in_path, pkts)
 147         self.test.register_capture(self.cap_name)
 148         # FIXME this should be an API, but no such exists atm
 149         self.test.vapi.cli(self.input_cli)
 150
 151     def generate_debug_aid(self, kind):
 152         """ Create a hardlink to the out file with a counter and a file
 153         containing stack trace to ease debugging in case of multiple capture
 154         files present. """
 155         self.test.logger.debug("Generating debug aid for %s on %s" %
 156                                (kind, self._name))
 157         link_path, stack_path = ["%s/debug_%s_%s_%s.%s" %
 158                                  (self.test.tempdir, self._name,
 159                                   self._out_assert_counter, kind, suffix)
 160                                  for suffix in ["pcap", "stack"]
 161                                  ]
 162         os.link(self.out_path, link_path)
 163         with open(stack_path, "w") as f:
 164             f.writelines(format_stack())
 165         self._out_assert_counter += 1
 166
 167     def _get_capture(self, timeout, filter_out_fn=is_ipv6_misc):
 168         """ Helper method to get capture and filter it """
 169         try:
 170             if not self.wait_for_capture_file(timeout):
 171                 return None
 172             output = rdpcap(self.out_path)
 173             self.test.logger.debug("Capture has %s packets" % len(output.res))
 174         except:
 175             self.test.logger.debug("Exception in scapy.rdpcap (%s): %s" %
 176                                    (self.out_path, format_exc()))
 177             return None
 178         before = len(output.res)
 179         if filter_out_fn:
 180             output.res = [p for p in output.res if not filter_out_fn(p)]
 181         removed = before - len(output.res)
 182         if removed:
 183             self.test.logger.debug(
 184                 "Filtered out %s packets from capture (returning %s)" %
 185                 (removed, len(output.res)))
 186         return output
 187
 188     def get_capture(self, expected_count=None, remark=None, timeout=1,
 189                     filter_out_fn=is_ipv6_misc):
 190         """ Get captured packets
 191
 192         :param expected_count: expected number of packets to capture, if None,
 193                                then self.test.packet_count_for_dst_pg_idx is
 194                                used to lookup the expected count
 195         :param remark: remark printed into debug logs
 196         :param timeout: how long to wait for packets
 197         :param filter_out_fn: filter applied to each packet, packets for which
 198                               the filter returns True are removed from capture
 199         :returns: iterable packets
 200         """
 201         remaining_time = timeout
 202         capture = None
 203         name = self.name if remark is None else "%s (%s)" % (self.name, remark)
 204         based_on = "based on provided argument"
 205         if expected_count is None:
 206             expected_count = \
 207                 self.test.get_packet_count_for_if_idx(self.sw_if_index)
 208             based_on = "based on stored packet_infos"
 209             if expected_count == 0:
 210                 raise Exception(
 211                     "Internal error, expected packet count for %s is 0!" %
 212                     name)
 213         self.test.logger.debug("Expecting to capture %s (%s) packets on %s" % (
 214             expected_count, based_on, name))
 215         while remaining_time > 0:
 216             before = time.time()
 217             capture = self._get_capture(remaining_time, filter_out_fn)
 218             elapsed_time = time.time() - before
 219             if capture:
 220                 if len(capture.res) == expected_count:
 221                     # bingo, got the packets we expected
 222                     return capture
 223                 else:
 224                     self.test.logger.debug("Partial capture containing %s "
 225                                            "packets doesn't match expected "
 226                                            "count %s (yet?)" %
 227                                            (len(capture.res), expected_count))
 228             elif expected_count == 0:
 229                 # bingo, got None as we expected - return empty capture
 230                 return PacketList()
 231             remaining_time -= elapsed_time
 232         if capture:
 233             self.generate_debug_aid("count-mismatch")
 234             raise Exception("Captured packets mismatch, captured %s packets, "
 235                             "expected %s packets on %s" %
 236                             (len(capture.res), expected_count, name))
 237         else:
 238             raise Exception("No packets captured on %s" % name)
 239
 240     def assert_nothing_captured(self, remark=None, filter_out_fn=is_ipv6_misc):
 241         """ Assert that nothing unfiltered was captured on interface
 242
 243         :param remark: remark printed into debug logs
 244         :param filter_out_fn: filter applied to each packet, packets for which
 245                               the filter returns True are removed from capture
 246         """
 247         if os.path.isfile(self.out_path):
 248             try:
 249                 capture = self.get_capture(
 250                     0, remark=remark, filter_out_fn=filter_out_fn)
 251                 if not capture or len(capture.res) == 0:
 252                     # junk filtered out, we're good
 253                     return
 254                 self.test.logger.error(
 255                     ppc("Unexpected packets captured:", capture))
 256             except:
 257                 pass
 258             self.generate_debug_aid("empty-assert")
 259             if remark:
 260                 raise AssertionError(
 261                     "Non-empty capture file present for interface %s (%s)" %
 262                     (self.name, remark))
 263             else:
 264                 raise AssertionError("Capture file present for interface %s" %
 265                                      self.name)
 266
 267     def wait_for_capture_file(self, timeout=1):
 268         """
 269         Wait until pcap capture file appears
 270
 271         :param timeout: How long to wait for the packet (default 1s)
 272
 273         :returns: True/False if the file is present or appears within timeout
 274         """
 275         deadline = time.time() + timeout
 276         if not os.path.isfile(self.out_path):
 277             self.test.logger.debug("Waiting for capture file %s to appear, "
 278                                    "timeout is %ss" % (self.out_path, timeout))
 279         else:
 280             self.test.logger.debug("Capture file %s already exists" %
 281                                    self.out_path)
 282             return True
 283         while time.time() < deadline:
 284             if os.path.isfile(self.out_path):
 285                 break
 286             time.sleep(0)  # yield
 287         if os.path.isfile(self.out_path):
 288             self.test.logger.debug("Capture file appeared after %fs" %
 289                                    (time.time() - (deadline - timeout)))
 290         else:
 291             self.test.logger.debug("Timeout - capture file still nowhere")
 292             return False
 293         return True
 294
 295     def verify_enough_packet_data_in_pcap(self):
 296         """
 297         Check if enough data is available in file handled by internal pcap
 298         reader so that a whole packet can be read.
 299
 300         :returns: True if enough data present, else False
 301         """
 302         orig_pos = self._pcap_reader.f.tell()  # save file position
 303         enough_data = False
 304         # read packet header from pcap
 305         packet_header_size = 16
 306         caplen = None
 307         end_pos = None
 308         hdr = self._pcap_reader.f.read(packet_header_size)
 309         if len(hdr) == packet_header_size:
 310             # parse the capture length - caplen
 311             sec, usec, caplen, wirelen = struct.unpack(
 312                 self._pcap_reader.endian + "IIII", hdr)
 313             self._pcap_reader.f.seek(0, 2)  # seek to end of file
 314             end_pos = self._pcap_reader.f.tell()  # get position at end
 315             if end_pos >= orig_pos + len(hdr) + caplen:
 316                 enough_data = True  # yay, we have enough data
 317         self._pcap_reader.f.seek(orig_pos, 0)  # restore original position
 318         return enough_data
 319
 320     def wait_for_packet(self, timeout, filter_out_fn=is_ipv6_misc):
 321         """
 322         Wait for next packet captured with a timeout
 323
 324         :param timeout: How long to wait for the packet
 325
 326         :returns: Captured packet if no packet arrived within timeout
 327         :raises Exception: if no packet arrives within timeout
 328         """
 329         deadline = time.time() + timeout
 330         if self._pcap_reader is None:
 331             if not self.wait_for_capture_file(timeout):
 332                 raise CaptureTimeoutError("Capture file %s did not appear "
 333                                           "within timeout" % self.out_path)
 334             while time.time() < deadline:
 335                 try:
 336                     self._pcap_reader = PcapReader(self.out_path)
 337                     break
 338                 except:
 339                     self.test.logger.debug(
 340                         "Exception in scapy.PcapReader(%s): %s" %
 341                         (self.out_path, format_exc()))
 342         if not self._pcap_reader:
 343             raise CaptureTimeoutError("Capture file %s did not appear within "
 344                                       "timeout" % self.out_path)
 345
 346         poll = False
 347         if timeout > 0:
 348             self.test.logger.debug("Waiting for packet")
 349         else:
 350             poll = True
 351             self.test.logger.debug("Polling for packet")
 352         while time.time() < deadline or poll:
 353             if not self.verify_enough_packet_data_in_pcap():
 354                 time.sleep(0)  # yield
 355                 poll = False
 356                 continue
 357             p = self._pcap_reader.recv()
 358             if p is not None:
 359                 if filter_out_fn is not None and filter_out_fn(p):
 360                     self.test.logger.debug(
 361                         "Packet received after %ss was filtered out" %
 362                         (time.time() - (deadline - timeout)))
 363                 else:
 364                     self.test.logger.debug(
 365                         "Packet received after %fs" %
 366                         (time.time() - (deadline - timeout)))
 367                     return p
 368             time.sleep(0)  # yield
 369             poll = False
 370         self.test.logger.debug("Timeout - no packets received")
 371         raise CaptureTimeoutError("Packet didn't arrive within timeout")
 372
 373     def create_arp_req(self):
 374         """Create ARP request applicable for this interface"""
 375         return (Ether(dst="ff:ff:ff:ff:ff:ff", src=self.remote_mac) /
 376                 ARP(op=ARP.who_has, pdst=self.local_ip4,
 377                     psrc=self.remote_ip4, hwsrc=self.remote_mac))
 378
 379     def create_ndp_req(self):
 380         """Create NDP - NS applicable for this interface"""
 381         nsma = in6_getnsma(inet_pton(socket.AF_INET6, self.local_ip6))
 382         d = inet_ntop(socket.AF_INET6, nsma)
 383
 384         return (Ether(dst=in6_getnsmac(nsma)) /
 385                 IPv6(dst=d, src=self.remote_ip6) /
 386                 ICMPv6ND_NS(tgt=self.local_ip6) /
 387                 ICMPv6NDOptSrcLLAddr(lladdr=self.remote_mac))
 388
 389     def resolve_arp(self, pg_interface=None):
 390         """Resolve ARP using provided packet-generator interface
 391
 392         :param pg_interface: interface used to resolve, if None then this
 393             interface is used
 394
 395         """
 396         if pg_interface is None:
 397             pg_interface = self
 398         self.test.logger.info("Sending ARP request for %s on port %s" %
 399                               (self.local_ip4, pg_interface.name))
 400         arp_req = self.create_arp_req()
 401         pg_interface.add_stream(arp_req)
 402         pg_interface.enable_capture()
 403         self.test.pg_start()
 404         self.test.logger.info(self.test.vapi.cli("show trace"))
 405         try:
 406             captured_packet = pg_interface.wait_for_packet(1)
 407         except:
 408             self.test.logger.info("No ARP received on port %s" %
 409                                   pg_interface.name)
 410             return
 411         arp_reply = captured_packet.copy()  # keep original for exception
 412         # Make Dot1AD packet content recognizable to scapy
 413         if arp_reply.type == 0x88a8:
 414             arp_reply.type = 0x8100
 415             arp_reply = Ether(str(arp_reply))
 416         try:
 417             if arp_reply[ARP].op == ARP.is_at:
 418                 self.test.logger.info("VPP %s MAC address is %s " %
 419                                       (self.name, arp_reply[ARP].hwsrc))
 420                 self._local_mac = arp_reply[ARP].hwsrc
 421             else:
 422                 self.test.logger.info("No ARP received on port %s" %
 423                                       pg_interface.name)
 424         except:
 425             self.test.logger.error(
 426                 ppp("Unexpected response to ARP request:", captured_packet))
 427             raise
 428
 429     def resolve_ndp(self, pg_interface=None, timeout=1):
 430         """Resolve NDP using provided packet-generator interface
 431
 432         :param pg_interface: interface used to resolve, if None then this
 433             interface is used
 434         :param timeout: how long to wait for response before giving up
 435
 436         """
 437         if pg_interface is None:
 438             pg_interface = self
 439         self.test.logger.info("Sending NDP request for %s on port %s" %
 440                               (self.local_ip6, pg_interface.name))
 441         ndp_req = self.create_ndp_req()
 442         pg_interface.add_stream(ndp_req)
 443         pg_interface.enable_capture()
 444         self.test.pg_start()
 445         now = time.time()
 446         deadline = now + timeout
 447         # Enabling IPv6 on an interface can generate more than the
 448         # ND reply we are looking for (namely MLD). So loop through
 449         # the replies to look for want we want.
 450         while now < deadline:
 451             try:
 452                 captured_packet = pg_interface.wait_for_packet(
 453                     deadline - now, filter_out_fn=None)
 454             except:
 455                 self.test.logger.error(
 456                     "Timeout while waiting for NDP response")
 457                 raise
 458             ndp_reply = captured_packet.copy()  # keep original for exception
 459             # Make Dot1AD packet content recognizable to scapy
 460             if ndp_reply.type == 0x88a8:
 461                 ndp_reply.type = 0x8100
 462                 ndp_reply = Ether(str(ndp_reply))
 463             try:
 464                 ndp_na = ndp_reply[ICMPv6ND_NA]
 465                 opt = ndp_na[ICMPv6NDOptDstLLAddr]
 466                 self.test.logger.info("VPP %s MAC address is %s " %
 467                                       (self.name, opt.lladdr))
 468                 self._local_mac = opt.lladdr
 469                 self.test.logger.debug(self.test.vapi.cli("show trace"))
 470                 # we now have the MAC we've been after
 471                 return
 472             except:
 473                 self.test.logger.info(
 474                     ppp("Unexpected response to NDP request:",
 475                         captured_packet))
 476             now = time.time()
 477
 478         self.test.logger.debug(self.test.vapi.cli("show trace"))
 479         raise Exception("Timeout while waiting for NDP response")