5 from traceback import format_exc, format_stack
8 from scapy.utils import wrpcap, rdpcap, PcapReader
9 from scapy.plist import PacketList
10 from vpp_interface import VppInterface
12 from scapy.layers.l2 import Ether, ARP
13 from scapy.layers.inet6 import IPv6, ICMPv6ND_NS, ICMPv6ND_NA,\
14 ICMPv6NDOptSrcLLAddr, ICMPv6NDOptDstLLAddr, ICMPv6ND_RA, RouterAlert, \
16 from util import ppp, ppc
17 from scapy.utils6 import in6_getnsma, in6_getnsmac, in6_ismaddr
18 from scapy.utils import inet_pton, inet_ntop
21 class CaptureTimeoutError(Exception):
22 """ Exception raised if capture or packet doesn't appear within timeout """
27 """ Is packet one of uninteresting IPv6 broadcasts? """
28 if p.haslayer(ICMPv6ND_RA):
29 if in6_ismaddr(p[IPv6].dst):
31 if p.haslayer(IPv6ExtHdrHopByHop):
32 for o in p[IPv6ExtHdrHopByHop].options:
33 if isinstance(o, RouterAlert):
38 class VppPGInterface(VppInterface):
40 VPP packet-generator interface
45 """packet-generator interface index assigned by VPP"""
50 """pcap file path - captured packets"""
55 """ pcap file path - injected packets"""
59 def capture_cli(self):
60 """CLI string to start capture on this interface"""
61 return self._capture_cli
65 """capture name for this interface"""
70 """CLI string to load the injected packets"""
71 if self._nb_replays is not None:
72 return "%s limit %d" % (self._input_cli, self._nb_replays)
73 return self._input_cli
76 def in_history_counter(self):
77 """Self-incrementing counter used when renaming old pcap files"""
78 v = self._in_history_counter
79 self._in_history_counter += 1
83 def out_history_counter(self):
84 """Self-incrementing counter used when renaming old pcap files"""
85 v = self._out_history_counter
86 self._out_history_counter += 1
89 def __init__(self, test, pg_index):
90 """ Create VPP packet-generator interface """
91 super(VppPGInterface, self).__init__(test)
93 r = test.vapi.pg_create_interface(pg_index)
94 self.set_sw_if_index(r.sw_if_index)
96 self._in_history_counter = 0
97 self._out_history_counter = 0
98 self._out_assert_counter = 0
99 self._pg_index = pg_index
100 self._out_file = "pg%u_out.pcap" % self.pg_index
101 self._out_path = self.test.tempdir + "/" + self._out_file
102 self._in_file = "pg%u_in.pcap" % self.pg_index
103 self._in_path = self.test.tempdir + "/" + self._in_file
104 self._capture_cli = "packet-generator capture pg%u pcap %s" % (
105 self.pg_index, self.out_path)
106 self._cap_name = "pcap%u" % self.sw_if_index
108 "packet-generator new pcap %s source pg%u name %s" % (
109 self.in_path, self.pg_index, self.cap_name)
110 self._nb_replays = None
112 def enable_capture(self):
113 """ Enable capture on this packet-generator interface
114 of at most n packets.
115 If n < 0, this is no limit
118 if os.path.isfile(self.out_path):
119 name = "%s/history.[timestamp:%f].[%s-counter:%04d].%s" % \
123 self.out_history_counter,
125 self.test.logger.debug("Renaming %s->%s" %
126 (self.out_path, name))
127 os.rename(self.out_path, name)
130 # FIXME this should be an API, but no such exists atm
131 self.test.vapi.cli(self.capture_cli)
132 self._pcap_reader = None
134 def disable_capture(self):
135 self.test.vapi.cli("%s disable" % self.capture_cli)
137 def add_stream(self, pkts, nb_replays=None):
139 Add a stream of packets to this packet-generator
141 :param pkts: iterable packets
144 self._nb_replays = nb_replays
146 if os.path.isfile(self.in_path):
147 name = "%s/history.[timestamp:%f].[%s-counter:%04d].%s" %\
151 self.in_history_counter,
153 self.test.logger.debug("Renaming %s->%s" %
154 (self.in_path, name))
155 os.rename(self.in_path, name)
158 wrpcap(self.in_path, pkts)
159 self.test.register_capture(self.cap_name)
160 # FIXME this should be an API, but no such exists atm
161 self.test.vapi.cli(self.input_cli)
163 def generate_debug_aid(self, kind):
164 """ Create a hardlink to the out file with a counter and a file
165 containing stack trace to ease debugging in case of multiple capture
167 self.test.logger.debug("Generating debug aid for %s on %s" %
169 link_path, stack_path = ["%s/debug_%s_%s_%s.%s" %
170 (self.test.tempdir, self._name,
171 self._out_assert_counter, kind, suffix)
172 for suffix in ["pcap", "stack"]
174 os.link(self.out_path, link_path)
175 with open(stack_path, "w") as f:
176 f.writelines(format_stack())
177 self._out_assert_counter += 1
179 def _get_capture(self, timeout, filter_out_fn=is_ipv6_misc):
180 """ Helper method to get capture and filter it """
182 if not self.wait_for_capture_file(timeout):
184 output = rdpcap(self.out_path)
185 self.test.logger.debug("Capture has %s packets" % len(output.res))
187 self.test.logger.debug("Exception in scapy.rdpcap (%s): %s" %
188 (self.out_path, format_exc()))
190 before = len(output.res)
192 output.res = [p for p in output.res if not filter_out_fn(p)]
193 removed = before - len(output.res)
195 self.test.logger.debug(
196 "Filtered out %s packets from capture (returning %s)" %
197 (removed, len(output.res)))
200 def get_capture(self, expected_count=None, remark=None, timeout=1,
201 filter_out_fn=is_ipv6_misc):
202 """ Get captured packets
204 :param expected_count: expected number of packets to capture, if None,
205 then self.test.packet_count_for_dst_pg_idx is
206 used to lookup the expected count
207 :param remark: remark printed into debug logs
208 :param timeout: how long to wait for packets
209 :param filter_out_fn: filter applied to each packet, packets for which
210 the filter returns True are removed from capture
211 :returns: iterable packets
213 remaining_time = timeout
215 name = self.name if remark is None else "%s (%s)" % (self.name, remark)
216 based_on = "based on provided argument"
217 if expected_count is None:
219 self.test.get_packet_count_for_if_idx(self.sw_if_index)
220 based_on = "based on stored packet_infos"
221 if expected_count == 0:
223 "Internal error, expected packet count for %s is 0!" %
225 self.test.logger.debug("Expecting to capture %s (%s) packets on %s" % (
226 expected_count, based_on, name))
227 while remaining_time > 0:
229 capture = self._get_capture(remaining_time, filter_out_fn)
230 elapsed_time = time.time() - before
232 if len(capture.res) == expected_count:
233 # bingo, got the packets we expected
235 elif len(capture.res) > expected_count:
236 self.test.logger.error(
237 ppc("Unexpected packets captured:", capture))
240 self.test.logger.debug("Partial capture containing %s "
241 "packets doesn't match expected "
243 (len(capture.res), expected_count))
244 elif expected_count == 0:
245 # bingo, got None as we expected - return empty capture
247 remaining_time -= elapsed_time
249 self.generate_debug_aid("count-mismatch")
250 raise Exception("Captured packets mismatch, captured %s packets, "
251 "expected %s packets on %s" %
252 (len(capture.res), expected_count, name))
254 raise Exception("No packets captured on %s" % name)
256 def assert_nothing_captured(self, remark=None, filter_out_fn=is_ipv6_misc):
257 """ Assert that nothing unfiltered was captured on interface
259 :param remark: remark printed into debug logs
260 :param filter_out_fn: filter applied to each packet, packets for which
261 the filter returns True are removed from capture
263 if os.path.isfile(self.out_path):
265 capture = self.get_capture(
266 0, remark=remark, filter_out_fn=filter_out_fn)
267 if not capture or len(capture.res) == 0:
268 # junk filtered out, we're good
272 self.generate_debug_aid("empty-assert")
274 raise AssertionError(
275 "Non-empty capture file present for interface %s (%s)" %
278 raise AssertionError("Capture file present for interface %s" %
281 def wait_for_capture_file(self, timeout=1):
283 Wait until pcap capture file appears
285 :param timeout: How long to wait for the packet (default 1s)
287 :returns: True/False if the file is present or appears within timeout
289 deadline = time.time() + timeout
290 if not os.path.isfile(self.out_path):
291 self.test.logger.debug("Waiting for capture file %s to appear, "
292 "timeout is %ss" % (self.out_path, timeout))
294 self.test.logger.debug("Capture file %s already exists" %
297 while time.time() < deadline:
298 if os.path.isfile(self.out_path):
300 self._test.sleep(0) # yield
301 if os.path.isfile(self.out_path):
302 self.test.logger.debug("Capture file appeared after %fs" %
303 (time.time() - (deadline - timeout)))
305 self.test.logger.debug("Timeout - capture file still nowhere")
309 def verify_enough_packet_data_in_pcap(self):
311 Check if enough data is available in file handled by internal pcap
312 reader so that a whole packet can be read.
314 :returns: True if enough data present, else False
316 orig_pos = self._pcap_reader.f.tell() # save file position
318 # read packet header from pcap
319 packet_header_size = 16
322 hdr = self._pcap_reader.f.read(packet_header_size)
323 if len(hdr) == packet_header_size:
324 # parse the capture length - caplen
325 sec, usec, caplen, wirelen = struct.unpack(
326 self._pcap_reader.endian + "IIII", hdr)
327 self._pcap_reader.f.seek(0, 2) # seek to end of file
328 end_pos = self._pcap_reader.f.tell() # get position at end
329 if end_pos >= orig_pos + len(hdr) + caplen:
330 enough_data = True # yay, we have enough data
331 self._pcap_reader.f.seek(orig_pos, 0) # restore original position
334 def wait_for_packet(self, timeout, filter_out_fn=is_ipv6_misc):
336 Wait for next packet captured with a timeout
338 :param timeout: How long to wait for the packet
340 :returns: Captured packet if no packet arrived within timeout
341 :raises Exception: if no packet arrives within timeout
343 deadline = time.time() + timeout
344 if self._pcap_reader is None:
345 if not self.wait_for_capture_file(timeout):
346 raise CaptureTimeoutError("Capture file %s did not appear "
347 "within timeout" % self.out_path)
348 while time.time() < deadline:
350 self._pcap_reader = PcapReader(self.out_path)
353 self.test.logger.debug(
354 "Exception in scapy.PcapReader(%s): %s" %
355 (self.out_path, format_exc()))
356 if not self._pcap_reader:
357 raise CaptureTimeoutError("Capture file %s did not appear within "
358 "timeout" % self.out_path)
362 self.test.logger.debug("Waiting for packet")
365 self.test.logger.debug("Polling for packet")
366 while time.time() < deadline or poll:
367 if not self.verify_enough_packet_data_in_pcap():
368 self._test.sleep(0) # yield
371 p = self._pcap_reader.recv()
373 if filter_out_fn is not None and filter_out_fn(p):
374 self.test.logger.debug(
375 "Packet received after %ss was filtered out" %
376 (time.time() - (deadline - timeout)))
378 self.test.logger.debug(
379 "Packet received after %fs" %
380 (time.time() - (deadline - timeout)))
382 self._test.sleep(0) # yield
384 self.test.logger.debug("Timeout - no packets received")
385 raise CaptureTimeoutError("Packet didn't arrive within timeout")
387 def create_arp_req(self):
388 """Create ARP request applicable for this interface"""
389 return (Ether(dst="ff:ff:ff:ff:ff:ff", src=self.remote_mac) /
390 ARP(op=ARP.who_has, pdst=self.local_ip4,
391 psrc=self.remote_ip4, hwsrc=self.remote_mac))
393 def create_ndp_req(self):
394 """Create NDP - NS applicable for this interface"""
395 nsma = in6_getnsma(inet_pton(socket.AF_INET6, self.local_ip6))
396 d = inet_ntop(socket.AF_INET6, nsma)
398 return (Ether(dst=in6_getnsmac(nsma)) /
399 IPv6(dst=d, src=self.remote_ip6) /
400 ICMPv6ND_NS(tgt=self.local_ip6) /
401 ICMPv6NDOptSrcLLAddr(lladdr=self.remote_mac))
403 def resolve_arp(self, pg_interface=None):
404 """Resolve ARP using provided packet-generator interface
406 :param pg_interface: interface used to resolve, if None then this
410 if pg_interface is None:
412 self.test.logger.info("Sending ARP request for %s on port %s" %
413 (self.local_ip4, pg_interface.name))
414 arp_req = self.create_arp_req()
415 pg_interface.add_stream(arp_req)
416 pg_interface.enable_capture()
418 self.test.logger.info(self.test.vapi.cli("show trace"))
420 captured_packet = pg_interface.wait_for_packet(1)
422 self.test.logger.info("No ARP received on port %s" %
425 arp_reply = captured_packet.copy() # keep original for exception
427 if arp_reply[ARP].op == ARP.is_at:
428 self.test.logger.info("VPP %s MAC address is %s " %
429 (self.name, arp_reply[ARP].hwsrc))
430 self._local_mac = arp_reply[ARP].hwsrc
432 self.test.logger.info("No ARP received on port %s" %
435 self.test.logger.error(
436 ppp("Unexpected response to ARP request:", captured_packet))
439 def resolve_ndp(self, pg_interface=None, timeout=1):
440 """Resolve NDP using provided packet-generator interface
442 :param pg_interface: interface used to resolve, if None then this
444 :param timeout: how long to wait for response before giving up
447 if pg_interface is None:
449 self.test.logger.info("Sending NDP request for %s on port %s" %
450 (self.local_ip6, pg_interface.name))
451 ndp_req = self.create_ndp_req()
452 pg_interface.add_stream(ndp_req)
453 pg_interface.enable_capture()
456 deadline = now + timeout
457 # Enabling IPv6 on an interface can generate more than the
458 # ND reply we are looking for (namely MLD). So loop through
459 # the replies to look for want we want.
460 while now < deadline:
462 captured_packet = pg_interface.wait_for_packet(
463 deadline - now, filter_out_fn=None)
465 self.test.logger.error(
466 "Timeout while waiting for NDP response")
468 ndp_reply = captured_packet.copy() # keep original for exception
470 ndp_na = ndp_reply[ICMPv6ND_NA]
471 opt = ndp_na[ICMPv6NDOptDstLLAddr]
472 self.test.logger.info("VPP %s MAC address is %s " %
473 (self.name, opt.lladdr))
474 self._local_mac = opt.lladdr
475 self.test.logger.debug(self.test.vapi.cli("show trace"))
476 # we now have the MAC we've been after
479 self.test.logger.info(
480 ppp("Unexpected response to NDP request:",
484 self.test.logger.debug(self.test.vapi.cli("show trace"))
485 raise Exception("Timeout while waiting for NDP response")