1 """ test framework utilities """
6 from socket import AF_INET6
8 from copy import deepcopy
9 from collections import UserDict
12 from scapy.layers.l2 import Ether
13 from scapy.layers.inet import IP
14 from scapy.layers.inet6 import (
20 from scapy.packet import Raw
21 from scapy.utils import hexdump
22 from scapy.utils6 import in6_mactoifaceid
24 from io import BytesIO
25 from vpp_papi import mac_pton
27 # Set up an empty logger for the testcase that can be overridden as necessary
28 null_logger = logging.getLogger("VppTestCase.util")
29 null_logger.addHandler(logging.NullHandler())
33 return packet.__repr__()
36 def ppp(headline, packet):
37 """Return string containing headline and output of scapy packet.show()"""
38 return "%s\n%s\n\n%s\n" % (
40 hexdump(packet, dump=True),
41 packet.show(dump=True),
45 def ppc(headline, capture, limit=10):
46 """Return string containing ppp() printout for a capture.
48 :param headline: printed as first line of output
49 :param capture: packets to print
50 :param limit: limit the print to # of packets
55 if limit < len(capture):
56 tail = "\nPrint limit reached, %s out of %s packets printed" % (
61 [ppp("Packet #%s:" % count, p) for count, p in zip(range(0, limit), capture)]
63 return "%s\n%s%s" % (headline, body, tail)
66 def ip4_range(ip4, s, e):
67 tmp = ip4.rsplit(".", 1)[0]
68 return ("%s.%d" % (tmp, i) for i in range(s, e))
71 def mcast_ip_to_mac(ip):
72 ip = ipaddress.ip_address(ip)
73 if not ip.is_multicast:
74 raise ValueError("Must be multicast address.")
77 mcast_mac = "01:00:5e:%02x:%02x:%02x" % (
78 (ip_as_int >> 16) & 0x7F,
79 (ip_as_int >> 8) & 0xFF,
83 mcast_mac = "33:33:%02x:%02x:%02x:%02x" % (
84 (ip_as_int >> 24) & 0xFF,
85 (ip_as_int >> 16) & 0xFF,
86 (ip_as_int >> 8) & 0xFF,
92 # wrapper around scapy library function.
94 euid = in6_mactoifaceid(str(mac))
95 addr = "fe80::" + euid
99 def ip6_normalize(ip6):
100 return socket.inet_ntop(socket.AF_INET6, socket.inet_pton(socket.AF_INET6, ip6))
103 def get_core_path(tempdir):
104 return "%s/%s" % (tempdir, get_core_pattern())
107 def is_core_present(tempdir):
108 return os.path.isfile(get_core_path(tempdir))
111 def get_core_pattern():
112 with open("/proc/sys/kernel/core_pattern", "r") as f:
113 corefmt = f.read().strip()
117 def check_core_path(logger, core_path):
118 corefmt = get_core_pattern()
119 if corefmt.startswith("|"):
121 "WARNING: redirecting the core dump through a"
122 " filter may result in truncated dumps."
125 " You may want to check the filter settings"
126 " or uninstall it and edit the"
127 " /proc/sys/kernel/core_pattern accordingly."
129 logger.error(" current core pattern is: %s" % corefmt)
132 class NumericConstant:
136 def __init__(self, value):
146 if self._value in self.desc_dict:
147 return self.desc_dict[self._value]
152 """Generic test host "connected" to VPPs interface."""
162 return mac_pton(self._mac)
166 """IPv4 address - string"""
171 """IPv4 address of remote host - raw, suitable as API parameter."""
172 return socket.inet_pton(socket.AF_INET, self._ip4)
176 """IPv6 address - string"""
181 """IPv6 address of remote host - raw, suitable as API parameter."""
182 return socket.inet_pton(socket.AF_INET6, self._ip6)
186 """IPv6 link-local address - string"""
191 """IPv6 link-local address of remote host -
192 raw, suitable as API parameter."""
193 return socket.inet_pton(socket.AF_INET6, self._ip6_ll)
195 def __eq__(self, other):
196 if isinstance(other, Host):
198 self.mac == other.mac
199 and self.ip4 == other.ip4
200 and self.ip6 == other.ip6
201 and self.ip6_ll == other.ip6_ll
206 def __ne__(self, other):
207 return not self.__eq__(other)
210 return "Host { mac:%s ip4:%s ip6:%s ip6_ll:%s }" % (
218 return hash(self.__repr__())
220 def __init__(self, mac=None, ip4=None, ip6=None, ip6_ll=None):
224 self._ip6_ll = ip6_ll
228 """L4 'connection' tied to two VPP interfaces"""
230 def __init__(self, testcase, if1, if2, af, l4proto, port1, port2):
231 self.testcase = testcase
232 self.ifs = [None, None]
235 self.address_family = af
236 self.l4proto = l4proto
237 self.ports = [None, None]
238 self.ports[0] = port1
239 self.ports[1] = port2
242 def pkt(self, side, l4args={}, payload="x"):
243 is_ip6 = 1 if self.address_family == AF_INET6 else 0
246 src_if = self.ifs[s0]
247 dst_if = self.ifs[s1]
249 IP(src=src_if.remote_ip4, dst=dst_if.remote_ip4),
250 IPv6(src=src_if.remote_ip6, dst=dst_if.remote_ip6),
252 merged_l4args = {"sport": self.ports[s0], "dport": self.ports[s1]}
253 merged_l4args.update(l4args)
255 Ether(dst=src_if.local_mac, src=src_if.remote_mac)
257 / self.l4proto(**merged_l4args)
262 def send(self, side, flags=None, payload=""):
264 if flags is not None:
265 l4args["flags"] = flags
266 self.ifs[side].add_stream(self.pkt(side, l4args=l4args, payload=payload))
267 self.ifs[1 - side].enable_capture()
268 self.testcase.pg_start()
270 def recv(self, side):
271 p = self.ifs[side].wait_for_packet(1)
274 def send_through(self, side, flags=None, payload=""):
275 self.send(side, flags, payload)
276 p = self.recv(1 - side)
279 def send_pingpong(self, side, flags1=None, flags2=None):
280 p1 = self.send_through(side, flags1)
281 p2 = self.send_through(1 - side, flags2)
286 L4_CONN_SIDE_ZERO = 0
290 def fragment_rfc791(packet, fragsize, logger=null_logger):
292 Fragment an IPv4 packet per RFC 791
293 :param packet: packet to fragment
294 :param fragsize: size at which to fragment
295 :note: IP options are not supported
296 :returns: list of fragments
298 logger.debug(ppp("Fragmenting packet:", packet))
299 packet = packet.__class__(scapy.compat.raw(packet)) # recalc. all values
300 if len(packet[IP].options) > 0:
301 raise Exception("Not implemented")
302 if len(packet) <= fragsize:
305 pre_ip_len = len(packet) - len(packet[IP])
306 ip_header_len = packet[IP].ihl * 4
307 hex_packet = scapy.compat.raw(packet)
308 hex_headers = hex_packet[: (pre_ip_len + ip_header_len)]
309 hex_payload = hex_packet[(pre_ip_len + ip_header_len) :]
313 otl = len(packet[IP])
314 nfb = int((fragsize - pre_ip_len - ihl * 4) / 8)
317 p = packet.__class__(hex_headers + hex_payload[: nfb * 8])
320 p[IP].len = ihl * 4 + nfb * 8
324 p = packet.__class__(hex_headers + hex_payload[nfb * 8 :])
325 p[IP].len = otl - nfb * 8
326 p[IP].frag = fo + nfb
329 more_fragments = fragment_rfc791(p, fragsize, logger)
330 pkts.extend(more_fragments)
335 def fragment_rfc8200(packet, identification, fragsize, logger=null_logger):
337 Fragment an IPv6 packet per RFC 8200
338 :param packet: packet to fragment
339 :param fragsize: size at which to fragment
340 :note: IP options are not supported
341 :returns: list of fragments
343 packet = packet.__class__(scapy.compat.raw(packet)) # recalc. all values
344 if len(packet) <= fragsize:
346 logger.debug(ppp("Fragmenting packet:", packet))
350 hop_by_hop_hdr = None
354 l = packet.getlayer(counter)
356 if l.__class__ is IPv6:
358 # ignore 2nd IPv6 header and everything below..
362 elif l.__class__ is IPv6ExtHdrFragment:
363 raise Exception("Already fragmented")
364 elif l.__class__ is IPv6ExtHdrRouting:
365 routing_hdr = counter
366 elif l.__class__ is IPv6ExtHdrHopByHop:
367 hop_by_hop_hdr = counter
371 and not l.__class__.__name__.startswith("IPv6ExtHdr")
373 upper_layer = counter
374 counter = counter + 1
375 l = packet.getlayer(counter)
378 "Layers seen: IPv6(#%s), Routing(#%s), HopByHop(#%s), upper(#%s)"
379 % (ipv6_nr, routing_hdr, hop_by_hop_hdr, upper_layer)
382 if upper_layer is None:
383 raise Exception("Upper layer header not found in IPv6 packet")
385 last_per_fragment_hdr = ipv6_nr
386 if routing_hdr is None:
387 if hop_by_hop_hdr is not None:
388 last_per_fragment_hdr = hop_by_hop_hdr
390 last_per_fragment_hdr = routing_hdr
391 logger.debug("Last per-fragment hdr is #%s" % (last_per_fragment_hdr))
393 per_fragment_headers = packet.copy()
394 per_fragment_headers[last_per_fragment_hdr].remove_payload()
395 logger.debug(ppp("Per-fragment headers:", per_fragment_headers))
397 ext_and_upper_layer = packet.getlayer(last_per_fragment_hdr)[1]
398 hex_payload = scapy.compat.raw(ext_and_upper_layer)
399 logger.debug("Payload length is %s" % len(hex_payload))
400 logger.debug(ppp("Ext and upper layer:", ext_and_upper_layer))
402 fragment_ext_hdr = IPv6ExtHdrFragment()
403 logger.debug(ppp("Fragment header:", fragment_ext_hdr))
405 len_ext_and_upper_layer_payload = len(ext_and_upper_layer.payload)
406 if not len_ext_and_upper_layer_payload and hasattr(ext_and_upper_layer, "data"):
407 len_ext_and_upper_layer_payload = len(ext_and_upper_layer.data)
410 len(per_fragment_headers)
411 + len(fragment_ext_hdr)
412 + len(ext_and_upper_layer)
413 - len_ext_and_upper_layer_payload
417 "Cannot fragment this packet - MTU too small "
418 "(%s, %s, %s, %s, %s)"
420 len(per_fragment_headers),
421 len(fragment_ext_hdr),
422 len(ext_and_upper_layer),
423 len_ext_and_upper_layer_payload,
428 orig_nh = packet[IPv6].nh
429 p = per_fragment_headers
432 p = p / fragment_ext_hdr
433 del p[IPv6ExtHdrFragment].nh
434 first_payload_len_nfb = int((fragsize - len(p)) / 8)
435 p = p / Raw(hex_payload[: first_payload_len_nfb * 8])
437 p[IPv6ExtHdrFragment].nh = orig_nh
438 p[IPv6ExtHdrFragment].id = identification
439 p[IPv6ExtHdrFragment].offset = 0
440 p[IPv6ExtHdrFragment].m = 1
441 p = p.__class__(scapy.compat.raw(p))
442 logger.debug(ppp("Fragment %s:" % len(pkts), p))
444 offset = first_payload_len_nfb * 8
445 logger.debug("Offset after first fragment: %s" % offset)
446 while len(hex_payload) > offset:
447 p = per_fragment_headers
450 p = p / fragment_ext_hdr
451 del p[IPv6ExtHdrFragment].nh
452 l_nfb = int((fragsize - len(p)) / 8)
453 p = p / Raw(hex_payload[offset : offset + l_nfb * 8])
454 p[IPv6ExtHdrFragment].nh = orig_nh
455 p[IPv6ExtHdrFragment].id = identification
456 p[IPv6ExtHdrFragment].offset = int(offset / 8)
457 p[IPv6ExtHdrFragment].m = 1
458 p = p.__class__(scapy.compat.raw(p))
459 logger.debug(ppp("Fragment %s:" % len(pkts), p))
461 offset = offset + l_nfb * 8
463 pkts[-1][IPv6ExtHdrFragment].m = 0 # reset more-flags in last fragment
468 def reassemble4_core(listoffragments, return_ip):
470 first = listoffragments[0]
472 for pkt in listoffragments:
473 buffer.seek(pkt[IP].frag * 8)
474 buffer.write(bytes(pkt[IP].payload))
475 first.len = len(buffer.getvalue()) + 20
479 header = bytes(first[IP])[:20]
480 return first[IP].__class__(header + buffer.getvalue())
482 header = bytes(first[Ether])[:34]
483 return first[Ether].__class__(header + buffer.getvalue())
486 def reassemble4_ether(listoffragments):
487 return reassemble4_core(listoffragments, False)
490 def reassemble4(listoffragments):
491 return reassemble4_core(listoffragments, True)
494 class UnexpectedPacketError(Exception):
495 def __init__(self, packet, msg=""):
500 return f"\nUnexpected packet:\n{pr(self.packet)}{self.msg}"
503 def recursive_dict_merge(dict_base, dict_update):
504 """Recursively merge base dict with update dict, return merged dict"""
505 for key in dict_update:
507 if type(dict_update[key]) is dict:
508 dict_base[key] = recursive_dict_merge(dict_base[key], dict_update[key])
510 dict_base[key] = dict_update[key]
512 dict_base[key] = dict_update[key]
516 class StatsDiff(UserDict):
518 Diff dictionary is a dictionary of dictionaries of interesting stats:
522 "err" : { '/error/counter1' : 4, },
523 sw_if_index1 : { '/stat/segment/counter1' : 5,
524 '/stat/segment/counter2' : 6,
526 sw_if_index2 : { '/stat/segment/counter1' : 7,
530 It describes a per sw-if-index diffset, where each key is stat segment
531 path and value is the expected change for that counter for sw-if-index.
532 Special case string "err" is used for error counters, which are not per
536 __slots__ = () # prevent setting properties to act like a dictionary
538 def __init__(self, data):
539 super().__init__(data)
541 def __or__(self, other):
542 return recursive_dict_merge(deepcopy(self.data), other)