4 object abstractions for representing IP routes in VPP
7 from vpp_object import VppObject
8 from vpp_ip import DpoProto, INVALID_INDEX, VppIpAddressUnion, \
10 from ipaddress import ip_network, ip_address, IPv4Network, IPv6Network
11 from vpp_papi_exceptions import UnexpectedApiReturnValueError
13 # from vnet/vnet/mpls/mpls_types.h
14 MPLS_IETF_MAX_LABEL = 0xfffff
15 MPLS_LABEL_INVALID = MPLS_IETF_MAX_LABEL + 1
24 FIB_PATH_NH_PROTO_IP4 = 0
25 FIB_PATH_NH_PROTO_IP6 = 1
26 FIB_PATH_NH_PROTO_MPLS = 2
27 FIB_PATH_NH_PROTO_ETHERNET = 3
28 FIB_PATH_NH_PROTO_BIER = 4
29 FIB_PATH_NH_PROTO_NSH = 5
33 FIB_PATH_TYPE_NORMAL = 0
34 FIB_PATH_TYPE_LOCAL = 1
35 FIB_PATH_TYPE_DROP = 2
36 FIB_PATH_TYPE_UDP_ENCAP = 3
37 FIB_PATH_TYPE_BIER_IMP = 4
38 FIB_PATH_TYPE_ICMP_UNREACH = 5
39 FIB_PATH_TYPE_ICMP_PROHIBIT = 6
40 FIB_PATH_TYPE_SOURCE_LOOKUP = 7
42 FIB_PATH_TYPE_INTERFACE_RX = 9
43 FIB_PATH_TYPE_CLASSIFY = 10
47 FIB_PATH_FLAG_NONE = 0
48 FIB_PATH_FLAG_RESOLVE_VIA_ATTACHED = 1
49 FIB_PATH_FLAG_RESOLVE_VIA_HOST = 2
50 FIB_PATH_FLAG_POP_PW_CW = 4
58 def mk_network(addr, len):
59 if ip_address(text_type(addr)).version == 4:
60 return IPv4Network("%s/%d" % (addr, len), strict=False)
62 return IPv6Network("%s/%d" % (addr, len), strict=False)
65 def ip_to_dpo_proto(addr):
67 return DpoProto.DPO_PROTO_IP6
69 return DpoProto.DPO_PROTO_IP4
72 def address_proto(ip_addr):
73 if ip_addr.ip_addr.version == 4:
74 return FibPathProto.FIB_PATH_NH_PROTO_IP4
76 return FibPathProto.FIB_PATH_NH_PROTO_IP6
79 def find_route(test, addr, len, table_id=0, sw_if_index=None):
80 prefix = mk_network(addr, len)
82 if 4 == prefix.version:
83 routes = test.vapi.ip_route_dump(table_id, False)
85 routes = test.vapi.ip_route_dump(table_id, True)
88 if table_id == e.route.table_id \
89 and str(e.route.prefix) == str(prefix):
93 # should be only one path if the user is looking
94 # for the interface the route is reachable through
95 if e.route.n_paths != 1:
98 return (e.route.paths[0].sw_if_index == sw_if_index)
103 def find_route_in_dump(dump, route, table):
105 if table.table_id == r.route.table_id \
106 and route.prefix == r.route.prefix:
107 if len(route.paths) == r.route.n_paths:
112 def find_mroute_in_dump(dump, route, table):
114 if table.table_id == r.route.table_id \
115 and route.prefix == r.route.prefix:
120 def find_mroute(test, grp_addr, src_addr, grp_addr_len,
122 ip_mprefix = VppIpMPrefix(text_type(src_addr),
126 if 4 == ip_mprefix.version:
127 routes = test.vapi.ip_mroute_dump(table_id, False)
129 routes = test.vapi.ip_mroute_dump(table_id, True)
132 if table_id == e.route.table_id and ip_mprefix == e.route.prefix:
137 def find_mpls_route(test, table_id, label, eos_bit, paths=None):
138 dump = test.vapi.mpls_route_dump(table_id)
140 if label == e.mr_route.mr_label \
141 and eos_bit == e.mr_route.mr_eos \
142 and table_id == e.mr_route.mr_table_id:
146 if (len(paths) != len(e.mr_route.mr_paths)):
148 for i in range(len(paths)):
149 if (paths[i] != e.mr_route.mr_paths[i]):
155 def fib_interface_ip_prefix(test, addr, len, sw_if_index):
156 # can't use python net here since we need the host bits in the prefix
157 prefix = "%s/%d" % (addr, len)
158 addrs = test.vapi.ip_address_dump(
160 is_ipv6=(6 == ip_address(addr).version))
163 if a.sw_if_index == sw_if_index and \
164 str(a.prefix) == prefix:
169 class VppIpTable(VppObject):
177 self.table_id = table_id
179 self.register = register
181 def add_vpp_config(self):
182 self._test.vapi.ip_table_add_del(is_add=1,
183 table={'is_ip6': self.is_ip6,
184 'table_id': self.table_id})
186 self._test.registry.register(self, self._test.logger)
189 def remove_vpp_config(self):
190 self._test.vapi.ip_table_add_del(is_add=0,
191 table={'is_ip6': self.is_ip6,
192 'table_id': self.table_id})
194 def replace_begin(self):
195 self._test.vapi.ip_table_replace_begin(
196 table={'is_ip6': self.is_ip6,
197 'table_id': self.table_id})
199 def replace_end(self):
200 self._test.vapi.ip_table_replace_end(
201 table={'is_ip6': self.is_ip6,
202 'table_id': self.table_id})
205 self._test.vapi.ip_table_flush(table={'is_ip6': self.is_ip6,
206 'table_id': self.table_id})
209 return self._test.vapi.ip_route_dump(self.table_id, self.is_ip6)
212 return self._test.vapi.ip_mroute_dump(self.table_id, self.is_ip6)
214 def query_vpp_config(self):
215 if self.table_id == 0:
216 # the default table always exists
218 # find the default route
219 return find_route(self._test,
220 "::" if self.is_ip6 else "0.0.0.0",
225 return ("table-%s-%d" %
226 ("v6" if self.is_ip6 == 1 else "v4",
230 class VppIpInterfaceAddress(VppObject):
232 def __init__(self, test, intf, addr, len, bind=None):
237 self.prefix = "%s/%d" % (addr, len)
238 self.host_len = ip_network(self.prefix, strict=False).max_prefixlen
241 self.table_id = bind.table.table_id
243 def add_vpp_config(self):
244 self._test.vapi.sw_interface_add_del_address(
245 sw_if_index=self.intf.sw_if_index, prefix=self.prefix,
247 self._test.registry.register(self, self._test.logger)
250 def remove_vpp_config(self):
251 self._test.vapi.sw_interface_add_del_address(
252 sw_if_index=self.intf.sw_if_index, prefix=self.prefix,
255 def query_vpp_config(self):
256 # search for the IP address mapping and the two expected
258 v = ip_address(self.addr).version
260 if ((v == 4 and self.len < 31) or (v == 6 and self.len < 127)):
261 return (fib_interface_ip_prefix(self._test,
264 self.intf.sw_if_index) &
265 find_route(self._test,
268 table_id=self.table_id,
269 sw_if_index=self.intf.sw_if_index) &
270 find_route(self._test,
273 table_id=self.table_id,
274 sw_if_index=self.intf.sw_if_index))
276 return (fib_interface_ip_prefix(self._test,
279 self.intf.sw_if_index) &
280 find_route(self._test,
283 table_id=self.table_id,
284 sw_if_index=self.intf.sw_if_index))
287 return "interface-ip-%s-%d-%s" % (self.intf,
292 class VppIp6LinkLocalAddress(VppObject):
294 def __init__(self, test, intf, addr):
299 def add_vpp_config(self):
300 self._test.vapi.sw_interface_ip6_set_link_local_address(
301 sw_if_index=self.intf.sw_if_index, ip=self.addr)
302 self._test.registry.register(self, self._test.logger)
305 def remove_vpp_config(self):
306 # link locals can't be removed, only changed
309 def query_vpp_config(self):
314 return "ip6-link-local-%s-%s" % (self.intf, self.addr)
317 class VppIpInterfaceBind(VppObject):
319 def __init__(self, test, intf, table):
324 def add_vpp_config(self):
325 if self.table.is_ip6:
326 self.intf.set_table_ip6(self.table.table_id)
328 self.intf.set_table_ip4(self.table.table_id)
329 self._test.registry.register(self, self._test.logger)
332 def remove_vpp_config(self):
333 if 0 == self.table.table_id:
335 if self.table.is_ip6:
336 self.intf.set_table_ip6(0)
338 self.intf.set_table_ip4(0)
340 def query_vpp_config(self):
341 if 0 == self.table.table_id:
344 return self._test.vapi.sw_interface_get_table(
345 self.intf.sw_if_index,
346 self.table.is_ip6).vrf_id == self.table.table_id
347 except UnexpectedApiReturnValueError as e:
348 if e.retval == -2: # INVALID_SW_IF_INDEX
353 return "interface-bind-%s-%s" % (self.intf, self.table)
357 def __init__(self, value, mode=MplsLspMode.PIPE, ttl=64, exp=0):
364 is_uniform = 0 if self.mode is MplsLspMode.PIPE else 1
365 return {'label': self.value,
368 'is_uniform': is_uniform}
370 def __eq__(self, other):
371 if isinstance(other, self.__class__):
372 return (self.value == other.value and
373 self.ttl == other.ttl and
374 self.exp == other.exp and
375 self.mode == other.mode)
376 elif hasattr(other, 'label'):
377 return (self.value == other.label and
378 self.ttl == other.ttl and
379 self.exp == other.exp and
380 (self.mode == MplsLspMode.UNIFORM) == other.is_uniform)
384 def __ne__(self, other):
385 return not (self == other)
388 class VppFibPathNextHop:
389 def __init__(self, addr,
390 via_label=MPLS_LABEL_INVALID,
391 next_hop_id=INVALID_INDEX):
392 self.addr = VppIpAddressUnion(addr)
393 self.via_label = via_label
394 self.obj_id = next_hop_id
397 if self.via_label is not MPLS_LABEL_INVALID:
398 return {'via_label': self.via_label}
399 if self.obj_id is not INVALID_INDEX:
400 return {'obj_id': self.obj_id}
402 return {'address': self.addr.encode()}
405 if self.via_label is MPLS_LABEL_INVALID:
406 return address_proto(self.addr)
408 return FibPathProto.FIB_PATH_NH_PROTO_MPLS
410 def __eq__(self, other):
411 if not isinstance(other, self.__class__):
412 # try the other instance's __eq__.
413 return NotImplemented
414 return (self.addr == other.addr and
415 self.via_label == other.via_label and
416 self.obj_id == other.obj_id)
427 nh_via_label=MPLS_LABEL_INVALID,
429 next_hop_id=INVALID_INDEX,
431 flags=FibPathFlags.FIB_PATH_FLAG_NONE,
432 type=FibPathType.FIB_PATH_TYPE_NORMAL):
433 self.nh_itf = nh_sw_if_index
434 self.nh_table_id = nh_table_id
435 self.nh_labels = labels
441 self.nh = VppFibPathNextHop(nh_addr, nh_via_label, next_hop_id)
443 self.proto = self.nh.proto()
446 self.next_hop_id = next_hop_id
448 def encode_labels(self):
450 for l in self.nh_labels:
451 if type(l) == VppMplsLabel:
452 lstack.append(l.encode())
454 lstack.append({'label': l,
456 while (len(lstack) < 16):
464 'table_id': self.nh_table_id,
465 'nh': self.nh.encode(),
466 'next_hop_id': self.next_hop_id,
467 'sw_if_index': self.nh_itf,
468 'rpf_id': self.rpf_id,
472 'n_labels': len(self.nh_labels),
473 'label_stack': self.encode_labels()}
475 def __eq__(self, other):
476 if isinstance(other, self.__class__):
477 return self.nh == other.nh
478 elif hasattr(other, 'sw_if_index'):
480 if (len(self.nh_labels) != other.n_labels):
482 for i in range(len(self.nh_labels)):
483 if (self.nh_labels[i] != other.label_stack[i]):
485 return self.nh_itf == other.sw_if_index
489 def __ne__(self, other):
490 return not (self == other)
493 class VppMRoutePath(VppRoutePath):
495 def __init__(self, nh_sw_if_index, flags,
497 proto=FibPathProto.FIB_PATH_NH_PROTO_IP4,
498 type=FibPathType.FIB_PATH_TYPE_NORMAL,
499 bier_imp=INVALID_INDEX):
501 nh = "::" if proto is FibPathProto.FIB_PATH_NH_PROTO_IP6 \
503 super(VppMRoutePath, self).__init__(nh,
507 next_hop_id=bier_imp)
508 self.nh_i_flags = flags
509 self.bier_imp = bier_imp
512 return {'path': super(VppMRoutePath, self).encode(),
513 'itf_flags': self.nh_i_flags}
516 class VppIpRoute(VppObject):
521 def __init__(self, test, dest_addr,
522 dest_addr_len, paths, table_id=0, register=True):
525 self.table_id = table_id
526 self.prefix = mk_network(dest_addr, dest_addr_len)
527 self.register = register
528 self.stats_index = None
529 self.modified = False
531 self.encoded_paths = []
532 for path in self.paths:
533 self.encoded_paths.append(path.encode())
535 def __eq__(self, other):
536 if self.table_id == other.table_id and \
537 self.prefix == other.prefix:
541 def modify(self, paths):
543 self.encoded_paths = []
544 for path in self.paths:
545 self.encoded_paths.append(path.encode())
548 self._test.vapi.ip_route_add_del(route={'table_id': self.table_id,
549 'prefix': self.prefix,
552 'paths': self.encoded_paths,
557 def add_vpp_config(self):
558 r = self._test.vapi.ip_route_add_del(
559 route={'table_id': self.table_id,
560 'prefix': self.prefix,
561 'n_paths': len(self.encoded_paths),
562 'paths': self.encoded_paths,
566 self.stats_index = r.stats_index
568 self._test.registry.register(self, self._test.logger)
571 def remove_vpp_config(self):
572 # there's no need to issue different deletes for modified routes
573 # we do this only to test the two different ways to delete routes
574 # eiter by passing all the paths to remove and mutlipath=1 or
575 # passing no paths and multipath=0
577 self._test.vapi.ip_route_add_del(
578 route={'table_id': self.table_id,
579 'prefix': self.prefix,
582 'paths': self.encoded_paths},
586 self._test.vapi.ip_route_add_del(
587 route={'table_id': self.table_id,
588 'prefix': self.prefix,
593 def query_vpp_config(self):
594 return find_route(self._test,
595 self.prefix.network_address,
596 self.prefix.prefixlen,
600 return ("%s:table-%d-%s" % (
601 'ip6-route' if self.prefix.version == 6 else 'ip-route',
605 def get_stats_to(self):
606 c = self._test.statistics.get_counter("/net/route/to")
607 return c[0][self.stats_index]
609 def get_stats_via(self):
610 c = self._test.statistics.get_counter("/net/route/via")
611 return c[0][self.stats_index]
614 class VppIpRouteV2(VppObject):
619 def __init__(self, test, dest_addr,
620 dest_addr_len, paths, table_id=0,
621 register=True, src=0):
624 self.table_id = table_id
625 self.prefix = mk_network(dest_addr, dest_addr_len)
626 self.register = register
627 self.stats_index = None
628 self.modified = False
631 self.encoded_paths = []
632 for path in self.paths:
633 self.encoded_paths.append(path.encode())
635 def __eq__(self, other):
636 if self.table_id == other.table_id and \
637 self.prefix == other.prefix:
641 def modify(self, paths):
643 self.encoded_paths = []
644 for path in self.paths:
645 self.encoded_paths.append(path.encode())
648 self._test.vapi.ip_route_add_del_v2(route={'table_id': self.table_id,
649 'prefix': self.prefix,
653 'paths': self.encoded_paths,
658 def add_vpp_config(self):
659 r = self._test.vapi.ip_route_add_del_v2(
660 route={'table_id': self.table_id,
661 'prefix': self.prefix,
662 'n_paths': len(self.encoded_paths),
663 'paths': self.encoded_paths,
668 self.stats_index = r.stats_index
670 self._test.registry.register(self, self._test.logger)
673 def remove_vpp_config(self):
674 # there's no need to issue different deletes for modified routes
675 # we do this only to test the two different ways to delete routes
676 # eiter by passing all the paths to remove and mutlipath=1 or
677 # passing no paths and multipath=0
679 self._test.vapi.ip_route_add_del_v2(
680 route={'table_id': self.table_id,
681 'prefix': self.prefix,
685 'paths': self.encoded_paths},
689 self._test.vapi.ip_route_add_del_v2(
690 route={'table_id': self.table_id,
691 'prefix': self.prefix,
697 def query_vpp_config(self):
698 return find_route(self._test,
699 self.prefix.network_address,
700 self.prefix.prefixlen,
704 return ("%s:table-%d-%s" % (
705 'ip6-route' if self.prefix.version == 6 else 'ip-route',
709 def get_stats_to(self):
710 c = self._test.statistics.get_counter("/net/route/to")
711 return c[0][self.stats_index]
713 def get_stats_via(self):
714 c = self._test.statistics.get_counter("/net/route/via")
715 return c[0][self.stats_index]
718 class VppIpMRoute(VppObject):
723 def __init__(self, test, src_addr, grp_addr,
724 grp_addr_len, e_flags, paths, table_id=0,
728 self.table_id = table_id
729 self.e_flags = e_flags
732 self.prefix = VppIpMPrefix(src_addr, grp_addr, grp_addr_len)
733 self.encoded_paths = []
734 for path in self.paths:
735 self.encoded_paths.append(path.encode())
737 def encode(self, paths=None):
738 _paths = self.encoded_paths if paths is None else paths
739 return {'table_id': self.table_id,
740 'entry_flags': self.e_flags,
741 'rpf_id': self.rpf_id,
742 'prefix': self.prefix.encode(),
743 'n_paths': len(_paths),
747 def add_vpp_config(self):
748 r = self._test.vapi.ip_mroute_add_del(route=self.encode(),
751 self.stats_index = r.stats_index
752 self._test.registry.register(self, self._test.logger)
755 def remove_vpp_config(self):
756 self._test.vapi.ip_mroute_add_del(route=self.encode(),
760 def update_entry_flags(self, flags):
762 self._test.vapi.ip_mroute_add_del(route=self.encode(paths=[]),
766 def update_rpf_id(self, rpf_id):
768 self._test.vapi.ip_mroute_add_del(route=self.encode(paths=[]),
772 def update_path_flags(self, itf, flags):
773 for p in range(len(self.paths)):
774 if self.paths[p].nh_itf == itf:
775 self.paths[p].nh_i_flags = flags
776 self.encoded_paths[p] = self.paths[p].encode()
779 self._test.vapi.ip_mroute_add_del(
781 paths=[self.encoded_paths[p]]),
785 def query_vpp_config(self):
786 return find_mroute(self._test,
793 return ("%d:(%s,%s/%d)" % (self.table_id,
799 c = self._test.statistics.get_counter("/net/mroute")
800 return c[0][self.stats_index]
804 def __init__(self, test, route, interface, packet):
806 self.interface = interface
810 def compare(self, signal):
811 self.test.assertEqual(self.interface, signal.sw_if_index)
812 self.test.assertEqual(self.route.table_id, signal.table_id)
813 self.test.assertEqual(self.route.prefix, signal.prefix)
816 class VppMplsIpBind(VppObject):
821 def __init__(self, test, local_label, dest_addr, dest_addr_len,
822 table_id=0, ip_table_id=0, is_ip6=0):
824 self.dest_addr_len = dest_addr_len
825 self.dest_addr = dest_addr
826 self.ip_addr = ip_address(text_type(dest_addr))
827 self.local_label = local_label
828 self.table_id = table_id
829 self.ip_table_id = ip_table_id
830 self.prefix = mk_network(dest_addr, dest_addr_len)
832 def add_vpp_config(self):
833 self._test.vapi.mpls_ip_bind_unbind(self.local_label,
835 table_id=self.table_id,
836 ip_table_id=self.ip_table_id)
837 self._test.registry.register(self, self._test.logger)
839 def remove_vpp_config(self):
840 self._test.vapi.mpls_ip_bind_unbind(self.local_label,
842 table_id=self.table_id,
843 ip_table_id=self.ip_table_id,
846 def query_vpp_config(self):
847 dump = self._test.vapi.mpls_route_dump(self.table_id)
849 if self.local_label == e.mr_route.mr_label \
850 and self.table_id == e.mr_route.mr_table_id:
855 return ("%d:%s binds %d:%s/%d"
863 class VppMplsTable(VppObject):
869 self.table_id = table_id
871 def add_vpp_config(self):
872 self._test.vapi.mpls_table_add_del(
875 self._test.registry.register(self, self._test.logger)
877 def remove_vpp_config(self):
878 self._test.vapi.mpls_table_add_del(
882 def query_vpp_config(self):
883 dump = self._test.vapi.mpls_table_dump()
885 if d.mt_table.mt_table_id == self.table_id:
890 return ("table-mpls-%d" % (self.table_id))
893 class VppMplsRoute(VppObject):
898 def __init__(self, test, local_label, eos_bit, paths, table_id=0,
900 eos_proto=FibPathProto.FIB_PATH_NH_PROTO_IP4):
903 self.local_label = local_label
904 self.eos_bit = eos_bit
905 self.eos_proto = eos_proto
906 self.table_id = table_id
907 self.is_multicast = is_multicast
909 def add_vpp_config(self):
911 for path in self.paths:
912 paths.append(path.encode())
914 r = self._test.vapi.mpls_route_add_del(self.table_id,
920 self.stats_index = r.stats_index
921 self._test.registry.register(self, self._test.logger)
923 def remove_vpp_config(self):
925 for path in self.paths:
926 paths.append(path.encode())
928 self._test.vapi.mpls_route_add_del(self.table_id,
935 def query_vpp_config(self):
936 return find_mpls_route(self._test, self.table_id,
937 self.local_label, self.eos_bit)
940 return ("mpls-route-%d:%s/%d"
945 def get_stats_to(self):
946 c = self._test.statistics.get_counter("/net/route/to")
947 return c[0][self.stats_index]
949 def get_stats_via(self):
950 c = self._test.statistics.get_counter("/net/route/via")
951 return c[0][self.stats_index]