4 object abstractions for representing IP routes in VPP
7 from vpp_object import VppObject
8 from vpp_ip import DpoProto, INVALID_INDEX, VppIpAddressUnion, VppIpMPrefix
9 from ipaddress import ip_network, ip_address, IPv4Network, IPv6Network
10 from vpp_papi_exceptions import UnexpectedApiReturnValueError
12 # from vnet/vnet/mpls/mpls_types.h
13 MPLS_IETF_MAX_LABEL = 0xFFFFF
14 MPLS_LABEL_INVALID = MPLS_IETF_MAX_LABEL + 1
23 FIB_PATH_NH_PROTO_IP4 = 0
24 FIB_PATH_NH_PROTO_IP6 = 1
25 FIB_PATH_NH_PROTO_MPLS = 2
26 FIB_PATH_NH_PROTO_ETHERNET = 3
27 FIB_PATH_NH_PROTO_BIER = 4
28 FIB_PATH_NH_PROTO_NSH = 5
32 FIB_PATH_TYPE_NORMAL = 0
33 FIB_PATH_TYPE_LOCAL = 1
34 FIB_PATH_TYPE_DROP = 2
35 FIB_PATH_TYPE_UDP_ENCAP = 3
36 FIB_PATH_TYPE_BIER_IMP = 4
37 FIB_PATH_TYPE_ICMP_UNREACH = 5
38 FIB_PATH_TYPE_ICMP_PROHIBIT = 6
39 FIB_PATH_TYPE_SOURCE_LOOKUP = 7
41 FIB_PATH_TYPE_INTERFACE_RX = 9
42 FIB_PATH_TYPE_CLASSIFY = 10
46 FIB_PATH_FLAG_NONE = 0
47 FIB_PATH_FLAG_RESOLVE_VIA_ATTACHED = 1
48 FIB_PATH_FLAG_RESOLVE_VIA_HOST = 2
49 FIB_PATH_FLAG_POP_PW_CW = 4
57 def mk_network(addr, len):
58 if ip_address(text_type(addr)).version == 4:
59 return IPv4Network("%s/%d" % (addr, len), strict=False)
61 return IPv6Network("%s/%d" % (addr, len), strict=False)
64 def ip_to_dpo_proto(addr):
66 return DpoProto.DPO_PROTO_IP6
68 return DpoProto.DPO_PROTO_IP4
71 def address_proto(ip_addr):
72 if ip_addr.ip_addr.version == 4:
73 return FibPathProto.FIB_PATH_NH_PROTO_IP4
75 return FibPathProto.FIB_PATH_NH_PROTO_IP6
79 test, addr, len, table_id=0, sw_if_index=None, ignore_default_route=False
81 prefix = mk_network(addr, len)
83 if 4 == prefix.version:
84 routes = test.vapi.ip_route_dump(table_id, False)
86 routes = test.vapi.ip_route_dump(table_id, True)
89 if table_id == e.route.table_id and str(e.route.prefix) == str(prefix):
91 # if the route is a default one of the table:
92 # 0.0.0.0/0, 0.0.0.0/32, 240.0.0.0/4, 255.255.255.255/32
95 and e.route.n_paths == 1
96 and e.route.paths[0].type == FibPathType.FIB_PATH_TYPE_DROP
99 # should be only one path if the user is looking
100 # for the interface the route is reachable through
101 if e.route.n_paths != 1:
104 return e.route.paths[0].sw_if_index == sw_if_index
109 def find_route_in_dump(dump, route, table):
111 if table.table_id == r.route.table_id and route.prefix == r.route.prefix:
112 if len(route.paths) == r.route.n_paths:
117 def find_mroute_in_dump(dump, route, table):
119 if table.table_id == r.route.table_id and route.prefix == r.route.prefix:
124 def find_mroute(test, grp_addr, src_addr, grp_addr_len, table_id=0):
125 ip_mprefix = VppIpMPrefix(text_type(src_addr), text_type(grp_addr), grp_addr_len)
127 if 4 == ip_mprefix.version:
128 routes = test.vapi.ip_mroute_dump(table_id, False)
130 routes = test.vapi.ip_mroute_dump(table_id, True)
133 if table_id == e.route.table_id and ip_mprefix == e.route.prefix:
138 def find_mpls_route(test, table_id, label, eos_bit, paths=None):
139 dump = test.vapi.mpls_route_dump(table_id)
142 label == e.mr_route.mr_label
143 and eos_bit == e.mr_route.mr_eos
144 and table_id == e.mr_route.mr_table_id
149 if len(paths) != len(e.mr_route.mr_paths):
151 for i in range(len(paths)):
152 if paths[i] != e.mr_route.mr_paths[i]:
158 def fib_interface_ip_prefix(test, addr, len, sw_if_index):
159 # can't use python net here since we need the host bits in the prefix
160 prefix = "%s/%d" % (addr, len)
161 addrs = test.vapi.ip_address_dump(
162 sw_if_index, is_ipv6=(6 == ip_address(addr).version)
166 if a.sw_if_index == sw_if_index and str(a.prefix) == prefix:
171 class VppIpTable(VppObject):
172 def __init__(self, test, table_id, is_ip6=0, register=True, name=""):
175 self.table_id = table_id
177 self.register = register
179 def add_vpp_config(self):
180 self._test.vapi.ip_table_add_del(
182 table={"is_ip6": self.is_ip6, "table_id": self.table_id, "name": self.name},
185 self._test.registry.register(self, self._test.logger)
188 def remove_vpp_config(self):
189 self._test.vapi.ip_table_add_del(
190 is_add=0, table={"is_ip6": self.is_ip6, "table_id": self.table_id}
193 def replace_begin(self):
194 self._test.vapi.ip_table_replace_begin(
195 table={"is_ip6": self.is_ip6, "table_id": self.table_id}
198 def replace_end(self):
199 self._test.vapi.ip_table_replace_end(
200 table={"is_ip6": self.is_ip6, "table_id": self.table_id}
204 self._test.vapi.ip_table_flush(
205 table={"is_ip6": self.is_ip6, "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
220 self._test, "::" if self.is_ip6 else "0.0.0.0", 0, self.table_id
224 return "table-%s-%d" % ("v6" if self.is_ip6 == 1 else "v4", self.table_id)
227 class VppIpInterfaceAddress(VppObject):
228 def __init__(self, test, intf, addr, len, bind=None):
233 self.prefix = "%s/%d" % (addr, len)
234 self.host_len = ip_network(self.prefix, strict=False).max_prefixlen
237 self.table_id = bind.table.table_id
239 def add_vpp_config(self):
240 self._test.vapi.sw_interface_add_del_address(
241 sw_if_index=self.intf.sw_if_index, prefix=self.prefix, is_add=1
243 self._test.registry.register(self, self._test.logger)
246 def remove_vpp_config(self):
247 self._test.vapi.sw_interface_add_del_address(
248 sw_if_index=self.intf.sw_if_index, prefix=self.prefix, is_add=0
251 def query_vpp_config(self):
252 # search for the IP address mapping and the two expected
254 v = ip_address(self.addr).version
256 if (v == 4 and self.len < 31) or (v == 6 and self.len < 127):
258 fib_interface_ip_prefix(
259 self._test, self.addr, self.len, self.intf.sw_if_index
265 table_id=self.table_id,
266 sw_if_index=self.intf.sw_if_index,
272 table_id=self.table_id,
273 sw_if_index=self.intf.sw_if_index,
277 return fib_interface_ip_prefix(
278 self._test, self.addr, self.len, self.intf.sw_if_index
283 table_id=self.table_id,
284 sw_if_index=self.intf.sw_if_index,
288 return "interface-ip-%s-%d-%s" % (self.intf, self.table_id, self.prefix)
291 class VppIp6LinkLocalAddress(VppObject):
292 def __init__(self, test, intf, addr):
297 def add_vpp_config(self):
298 self._test.vapi.sw_interface_ip6_set_link_local_address(
299 sw_if_index=self.intf.sw_if_index, ip=self.addr
301 self._test.registry.register(self, self._test.logger)
304 def remove_vpp_config(self):
305 # link locals can't be removed, only changed
308 def query_vpp_config(self):
313 return "ip6-link-local-%s-%s" % (self.intf, self.addr)
316 class VppIpInterfaceBind(VppObject):
317 def __init__(self, test, intf, table):
322 def add_vpp_config(self):
323 if self.table.is_ip6:
324 self.intf.set_table_ip6(self.table.table_id)
326 self.intf.set_table_ip4(self.table.table_id)
327 self._test.registry.register(self, self._test.logger)
330 def remove_vpp_config(self):
331 if 0 == self.table.table_id:
333 if self.table.is_ip6:
334 self.intf.set_table_ip6(0)
336 self.intf.set_table_ip4(0)
338 def query_vpp_config(self):
339 if 0 == self.table.table_id:
343 self._test.vapi.sw_interface_get_table(
344 self.intf.sw_if_index, self.table.is_ip6
346 == self.table.table_id
348 except UnexpectedApiReturnValueError as e:
349 if e.retval == -2: # INVALID_SW_IF_INDEX
354 return "interface-bind-%s-%s" % (self.intf, self.table)
358 def __init__(self, value, mode=MplsLspMode.PIPE, ttl=64, exp=0):
365 is_uniform = 0 if self.mode is MplsLspMode.PIPE else 1
370 "is_uniform": is_uniform,
373 def __eq__(self, other):
374 if isinstance(other, self.__class__):
376 self.value == other.value
377 and self.ttl == other.ttl
378 and self.exp == other.exp
379 and self.mode == other.mode
381 elif hasattr(other, "label"):
383 self.value == other.label
384 and self.ttl == other.ttl
385 and self.exp == other.exp
386 and (self.mode == MplsLspMode.UNIFORM) == other.is_uniform
391 def __ne__(self, other):
392 return not (self == other)
395 class VppFibPathNextHop:
396 def __init__(self, addr, via_label=MPLS_LABEL_INVALID, next_hop_id=INVALID_INDEX):
397 self.addr = VppIpAddressUnion(addr)
398 self.via_label = via_label
399 self.obj_id = next_hop_id
402 if self.via_label is not MPLS_LABEL_INVALID:
403 return {"via_label": self.via_label}
404 if self.obj_id is not INVALID_INDEX:
405 return {"obj_id": self.obj_id}
407 return {"address": self.addr.encode()}
410 if self.via_label is MPLS_LABEL_INVALID:
411 return address_proto(self.addr)
413 return FibPathProto.FIB_PATH_NH_PROTO_MPLS
415 def __eq__(self, other):
416 if not isinstance(other, self.__class__):
417 # try the other instance's __eq__.
418 return NotImplemented
420 self.addr == other.addr
421 and self.via_label == other.via_label
422 and self.obj_id == other.obj_id
433 nh_via_label=MPLS_LABEL_INVALID,
435 next_hop_id=INVALID_INDEX,
437 flags=FibPathFlags.FIB_PATH_FLAG_NONE,
438 type=FibPathType.FIB_PATH_TYPE_NORMAL,
440 self.nh_itf = nh_sw_if_index
441 self.nh_table_id = nh_table_id
442 self.nh_labels = labels
448 self.nh = VppFibPathNextHop(nh_addr, nh_via_label, next_hop_id)
450 self.proto = self.nh.proto()
453 self.next_hop_id = next_hop_id
455 def encode_labels(self):
457 for l in self.nh_labels:
458 if type(l) == VppMplsLabel:
459 lstack.append(l.encode())
461 lstack.append({"label": l, "ttl": 255})
462 while len(lstack) < 16:
471 "table_id": self.nh_table_id,
472 "nh": self.nh.encode(),
473 "next_hop_id": self.next_hop_id,
474 "sw_if_index": self.nh_itf,
475 "rpf_id": self.rpf_id,
479 "n_labels": len(self.nh_labels),
480 "label_stack": self.encode_labels(),
483 def __eq__(self, other):
484 if isinstance(other, self.__class__):
485 return self.nh == other.nh
486 elif hasattr(other, "sw_if_index"):
488 if len(self.nh_labels) != other.n_labels:
490 for i in range(len(self.nh_labels)):
491 if self.nh_labels[i] != other.label_stack[i]:
493 return self.nh_itf == other.sw_if_index
497 def __ne__(self, other):
498 return not (self == other)
501 class VppMRoutePath(VppRoutePath):
507 proto=FibPathProto.FIB_PATH_NH_PROTO_IP4,
508 type=FibPathType.FIB_PATH_TYPE_NORMAL,
509 bier_imp=INVALID_INDEX,
512 nh = "::" if proto is FibPathProto.FIB_PATH_NH_PROTO_IP6 else "0.0.0.0"
513 super(VppMRoutePath, self).__init__(
514 nh, nh_sw_if_index, proto=proto, type=type, next_hop_id=bier_imp
516 self.nh_i_flags = flags
517 self.bier_imp = bier_imp
521 "path": super(VppMRoutePath, self).encode(),
522 "itf_flags": self.nh_i_flags,
526 class VppIpRoute(VppObject):
532 self, test, dest_addr, dest_addr_len, paths, table_id=0, register=True
536 self.table_id = table_id
537 self.prefix = mk_network(dest_addr, dest_addr_len)
538 self.register = register
539 self.stats_index = None
540 self.modified = False
542 self.encoded_paths = []
543 for path in self.paths:
544 self.encoded_paths.append(path.encode())
546 def __eq__(self, other):
547 if self.table_id == other.table_id and self.prefix == other.prefix:
551 def modify(self, paths):
553 self.encoded_paths = []
554 for path in self.paths:
555 self.encoded_paths.append(path.encode())
558 self._test.vapi.ip_route_add_del(
560 "table_id": self.table_id,
561 "prefix": self.prefix,
562 "n_paths": len(self.encoded_paths),
563 "paths": self.encoded_paths,
569 def add_vpp_config(self):
570 r = self._test.vapi.ip_route_add_del(
572 "table_id": self.table_id,
573 "prefix": self.prefix,
574 "n_paths": len(self.encoded_paths),
575 "paths": self.encoded_paths,
580 self.stats_index = r.stats_index
582 self._test.registry.register(self, self._test.logger)
585 def remove_vpp_config(self):
586 # there's no need to issue different deletes for modified routes
587 # we do this only to test the two different ways to delete routes
588 # eiter by passing all the paths to remove and mutlipath=1 or
589 # passing no paths and multipath=0
591 self._test.vapi.ip_route_add_del(
593 "table_id": self.table_id,
594 "prefix": self.prefix,
595 "n_paths": len(self.encoded_paths),
596 "paths": self.encoded_paths,
602 self._test.vapi.ip_route_add_del(
603 route={"table_id": self.table_id, "prefix": self.prefix, "n_paths": 0},
608 def query_vpp_config(self):
611 self.prefix.network_address,
612 self.prefix.prefixlen,
614 ignore_default_route=True,
618 return "%s:table-%d-%s" % (
619 "ip6-route" if self.prefix.version == 6 else "ip-route",
624 def get_stats_to(self):
625 c = self._test.statistics.get_counter("/net/route/to")
626 return c[0][self.stats_index]
628 def get_stats_via(self):
629 c = self._test.statistics.get_counter("/net/route/via")
630 return c[0][self.stats_index]
633 class VppIpRouteV2(VppObject):
639 self, test, dest_addr, dest_addr_len, paths, table_id=0, register=True, src=0
643 self.table_id = table_id
644 self.prefix = mk_network(dest_addr, dest_addr_len)
645 self.register = register
646 self.stats_index = None
647 self.modified = False
650 self.encoded_paths = []
651 for path in self.paths:
652 self.encoded_paths.append(path.encode())
654 def __eq__(self, other):
655 if self.table_id == other.table_id and self.prefix == other.prefix:
659 def modify(self, paths):
661 self.encoded_paths = []
662 for path in self.paths:
663 self.encoded_paths.append(path.encode())
666 self._test.vapi.ip_route_add_del_v2(
668 "table_id": self.table_id,
669 "prefix": self.prefix,
671 "n_paths": len(self.encoded_paths),
672 "paths": self.encoded_paths,
678 def add_vpp_config(self):
679 r = self._test.vapi.ip_route_add_del_v2(
681 "table_id": self.table_id,
682 "prefix": self.prefix,
683 "n_paths": len(self.encoded_paths),
684 "paths": self.encoded_paths,
690 self.stats_index = r.stats_index
692 self._test.registry.register(self, self._test.logger)
695 def remove_vpp_config(self):
696 # there's no need to issue different deletes for modified routes
697 # we do this only to test the two different ways to delete routes
698 # eiter by passing all the paths to remove and mutlipath=1 or
699 # passing no paths and multipath=0
701 self._test.vapi.ip_route_add_del_v2(
703 "table_id": self.table_id,
704 "prefix": self.prefix,
706 "n_paths": len(self.encoded_paths),
707 "paths": self.encoded_paths,
713 self._test.vapi.ip_route_add_del_v2(
715 "table_id": self.table_id,
716 "prefix": self.prefix,
724 def query_vpp_config(self):
727 self.prefix.network_address,
728 self.prefix.prefixlen,
730 ignore_default_route=True,
734 return "%s:table-%d-%s" % (
735 "ip6-route" if self.prefix.version == 6 else "ip-route",
740 def get_stats_to(self):
741 c = self._test.statistics.get_counter("/net/route/to")
742 return c[0][self.stats_index]
744 def get_stats_via(self):
745 c = self._test.statistics.get_counter("/net/route/via")
746 return c[0][self.stats_index]
749 class VppIpMRoute(VppObject):
767 self.table_id = table_id
768 self.e_flags = e_flags
771 self.prefix = VppIpMPrefix(src_addr, grp_addr, grp_addr_len)
772 self.encoded_paths = []
773 for path in self.paths:
774 self.encoded_paths.append(path.encode())
776 def encode(self, paths=None):
777 _paths = self.encoded_paths if paths is None else paths
779 "table_id": self.table_id,
780 "entry_flags": self.e_flags,
781 "rpf_id": self.rpf_id,
782 "prefix": self.prefix.encode(),
783 "n_paths": len(_paths),
787 def add_vpp_config(self):
788 r = self._test.vapi.ip_mroute_add_del(
789 route=self.encode(), is_multipath=1, is_add=1
791 self.stats_index = r.stats_index
792 self._test.registry.register(self, self._test.logger)
795 def remove_vpp_config(self):
796 self._test.vapi.ip_mroute_add_del(route=self.encode(), is_multipath=1, is_add=0)
798 def update_entry_flags(self, flags):
800 self._test.vapi.ip_mroute_add_del(
801 route=self.encode(paths=[]), is_multipath=1, is_add=1
804 def update_rpf_id(self, rpf_id):
806 self._test.vapi.ip_mroute_add_del(
807 route=self.encode(paths=[]), is_multipath=1, is_add=1
810 def update_path_flags(self, itf, flags):
811 for p in range(len(self.paths)):
812 if self.paths[p].nh_itf == itf:
813 self.paths[p].nh_i_flags = flags
814 self.encoded_paths[p] = self.paths[p].encode()
817 self._test.vapi.ip_mroute_add_del(
818 route=self.encode(paths=[self.encoded_paths[p]]), is_add=1, is_multipath=0
821 def query_vpp_config(self):
831 return "%d:(%s,%s/%d)" % (
839 c = self._test.statistics.get_counter("/net/mroute")
840 return c[0][self.stats_index]
844 def __init__(self, test, route, interface, packet):
846 self.interface = interface
850 def compare(self, signal):
851 self.test.assertEqual(self.interface, signal.sw_if_index)
852 self.test.assertEqual(self.route.table_id, signal.table_id)
853 self.test.assertEqual(self.route.prefix, signal.prefix)
856 class VppMplsIpBind(VppObject):
872 self.dest_addr_len = dest_addr_len
873 self.dest_addr = dest_addr
874 self.ip_addr = ip_address(text_type(dest_addr))
875 self.local_label = local_label
876 self.table_id = table_id
877 self.ip_table_id = ip_table_id
878 self.prefix = mk_network(dest_addr, dest_addr_len)
880 def add_vpp_config(self):
881 self._test.vapi.mpls_ip_bind_unbind(
884 table_id=self.table_id,
885 ip_table_id=self.ip_table_id,
887 self._test.registry.register(self, self._test.logger)
889 def remove_vpp_config(self):
890 self._test.vapi.mpls_ip_bind_unbind(
893 table_id=self.table_id,
894 ip_table_id=self.ip_table_id,
898 def query_vpp_config(self):
899 dump = self._test.vapi.mpls_route_dump(self.table_id)
902 self.local_label == e.mr_route.mr_label
903 and self.table_id == e.mr_route.mr_table_id
909 return "%d:%s binds %d:%s/%d" % (
918 class VppMplsTable(VppObject):
919 def __init__(self, test, table_id):
921 self.table_id = table_id
923 def add_vpp_config(self):
924 self._test.vapi.mpls_table_add_del(self.table_id, is_add=1)
925 self._test.registry.register(self, self._test.logger)
927 def remove_vpp_config(self):
928 self._test.vapi.mpls_table_add_del(self.table_id, is_add=0)
930 def query_vpp_config(self):
931 dump = self._test.vapi.mpls_table_dump()
933 if d.mt_table.mt_table_id == self.table_id:
938 return "table-mpls-%d" % (self.table_id)
941 class VppMplsRoute(VppObject):
954 eos_proto=FibPathProto.FIB_PATH_NH_PROTO_IP4,
958 self.local_label = local_label
959 self.eos_bit = eos_bit
960 self.eos_proto = eos_proto
961 self.table_id = table_id
962 self.is_multicast = is_multicast
964 def add_vpp_config(self):
966 for path in self.paths:
967 paths.append(path.encode())
969 r = self._test.vapi.mpls_route_add_del(
979 self.stats_index = r.stats_index
980 self._test.registry.register(self, self._test.logger)
982 def remove_vpp_config(self):
984 for path in self.paths:
985 paths.append(path.encode())
987 self._test.vapi.mpls_route_add_del(
998 def query_vpp_config(self):
999 return find_mpls_route(
1000 self._test, self.table_id, self.local_label, self.eos_bit
1003 def object_id(self):
1004 return "mpls-route-%d:%s/%d" % (
1010 def get_stats_to(self):
1011 c = self._test.statistics.get_counter("/net/route/to")
1012 return c[0][self.stats_index]
1014 def get_stats_via(self):
1015 c = self._test.statistics.get_counter("/net/route/via")
1016 return c[0][self.stats_index]