4 object abstractions for representing IP routes in VPP
7 from vpp_object import VppObject
8 from socket import inet_pton, inet_ntop, AF_INET, AF_INET6
9 from vpp_ip import DpoProto, INVALID_INDEX, VppIpAddressUnion, \
11 from ipaddress import ip_network, ip_address, IPv4Network, IPv6Network
13 # from vnet/vnet/mpls/mpls_types.h
14 MPLS_IETF_MAX_LABEL = 0xfffff
15 MPLS_LABEL_INVALID = MPLS_IETF_MAX_LABEL + 1
24 MFIB_ITF_FLAG_NONE = 0
25 MFIB_ITF_FLAG_NEGATE_SIGNAL = 1
26 MFIB_ITF_FLAG_ACCEPT = 2
27 MFIB_ITF_FLAG_FORWARD = 4
28 MFIB_ITF_FLAG_SIGNAL_PRESENT = 8
29 MFIB_ITF_FLAG_INTERNAL_COPY = 16
32 class MRouteEntryFlags:
33 MFIB_ENTRY_FLAG_NONE = 0
34 MFIB_ENTRY_FLAG_SIGNAL = 1
35 MFIB_ENTRY_FLAG_DROP = 2
36 MFIB_ENTRY_FLAG_CONNECTED = 4
37 MFIB_ENTRY_FLAG_INHERIT_ACCEPT = 8
41 FIB_PATH_NH_PROTO_IP4 = 0
42 FIB_PATH_NH_PROTO_IP6 = 1
43 FIB_PATH_NH_PROTO_MPLS = 2
44 FIB_PATH_NH_PROTO_ETHERNET = 3
45 FIB_PATH_NH_PROTO_BIER = 4
46 FIB_PATH_NH_PROTO_NSH = 5
50 FIB_PATH_TYPE_NORMAL = 0
51 FIB_PATH_TYPE_LOCAL = 1
52 FIB_PATH_TYPE_DROP = 2
53 FIB_PATH_TYPE_UDP_ENCAP = 3
54 FIB_PATH_TYPE_BIER_IMP = 4
55 FIB_PATH_TYPE_ICMP_UNREACH = 5
56 FIB_PATH_TYPE_ICMP_PROHIBIT = 6
57 FIB_PATH_TYPE_SOURCE_LOOKUP = 7
59 FIB_PATH_TYPE_INTERFACE_RX = 9
60 FIB_PATH_TYPE_CLASSIFY = 10
64 FIB_PATH_FLAG_NONE = 0
65 FIB_PATH_FLAG_RESOLVE_VIA_ATTACHED = 1
66 FIB_PATH_FLAG_RESOLVE_VIA_HOST = 2
67 FIB_PATH_FLAG_POP_PW_CW = 4
75 def mk_network(addr, len):
76 if ip_address(text_type(addr)).version == 4:
77 return IPv4Network("%s/%d" % (addr, len), strict=False)
79 return IPv6Network("%s/%d" % (addr, len), strict=False)
82 def ip_to_dpo_proto(addr):
84 return DpoProto.DPO_PROTO_IP6
86 return DpoProto.DPO_PROTO_IP4
89 def address_proto(ip_addr):
90 if ip_addr.ip_addr.version == 4:
91 return FibPathProto.FIB_PATH_NH_PROTO_IP4
93 return FibPathProto.FIB_PATH_NH_PROTO_IP6
96 def find_route(test, addr, len, table_id=0, sw_if_index=None):
97 prefix = mk_network(addr, len)
99 if 4 == prefix.version:
100 routes = test.vapi.ip_route_dump(table_id, False)
102 routes = test.vapi.ip_route_dump(table_id, True)
105 if table_id == e.route.table_id \
106 and str(e.route.prefix) == str(prefix):
110 # should be only one path if the user is looking
111 # for the interface the route is reachable through
112 if e.route.n_paths != 1:
115 return (e.route.paths[0].sw_if_index == sw_if_index)
120 def find_route_in_dump(dump, route, table):
122 if table.table_id == r.route.table_id \
123 and route.prefix == r.route.prefix:
124 if len(route.paths) == r.route.n_paths:
129 def find_mroute_in_dump(dump, route, table):
131 if table.table_id == r.route.table_id \
132 and route.prefix == r.route.prefix:
137 def find_mroute(test, grp_addr, src_addr, grp_addr_len,
139 ip_mprefix = VppIpMPrefix(text_type(src_addr),
143 if 4 == ip_mprefix.version:
144 routes = test.vapi.ip_mroute_dump(table_id, False)
146 routes = test.vapi.ip_mroute_dump(table_id, True)
149 if table_id == e.route.table_id and ip_mprefix == e.route.prefix:
154 def find_mpls_route(test, table_id, label, eos_bit, paths=None):
155 dump = test.vapi.mpls_route_dump(table_id)
157 if label == e.mr_route.mr_label \
158 and eos_bit == e.mr_route.mr_eos \
159 and table_id == e.mr_route.mr_table_id:
163 if (len(paths) != len(e.mr_route.mr_paths)):
165 for i in range(len(paths)):
166 if (paths[i] != e.mr_route.mr_paths[i]):
172 def fib_interface_ip_prefix(test, addr, len, sw_if_index):
173 # can't use python net here since we need the host bits in the prefix
174 prefix = "%s/%d" % (addr, len)
175 addrs = test.vapi.ip_address_dump(
177 is_ipv6=(6 == ip_address(addr).version))
180 if a.sw_if_index == sw_if_index and \
181 str(a.prefix) == prefix:
186 class VppIpTable(VppObject):
194 self.table_id = table_id
196 self.register = register
198 def add_vpp_config(self):
199 self._test.vapi.ip_table_add_del(is_add=1,
200 table={'is_ip6': self.is_ip6,
201 'table_id': self.table_id})
203 self._test.registry.register(self, self._test.logger)
206 def remove_vpp_config(self):
207 self._test.vapi.ip_table_add_del(is_add=0,
208 table={'is_ip6': self.is_ip6,
209 'table_id': self.table_id})
211 def replace_begin(self):
212 self._test.vapi.ip_table_replace_begin(
213 table={'is_ip6': self.is_ip6,
214 'table_id': self.table_id})
216 def replace_end(self):
217 self._test.vapi.ip_table_replace_end(
218 table={'is_ip6': self.is_ip6,
219 'table_id': self.table_id})
222 self._test.vapi.ip_table_flush(table={'is_ip6': self.is_ip6,
223 'table_id': self.table_id})
226 return self._test.vapi.ip_route_dump(self.table_id, self.is_ip6)
229 return self._test.vapi.ip_mroute_dump(self.table_id, self.is_ip6)
231 def query_vpp_config(self):
232 if self.table_id == 0:
233 # the default table always exists
235 # find the default route
236 return find_route(self._test,
237 "::" if self.is_ip6 else "0.0.0.0",
242 return ("table-%s-%d" %
243 ("v6" if self.is_ip6 == 1 else "v4",
247 class VppIpInterfaceAddress(VppObject):
249 def __init__(self, test, intf, addr, len, bind=None):
254 self.prefix = "%s/%d" % (addr, len)
255 self.host_len = ip_network(self.prefix, strict=False).max_prefixlen
258 self.table_id = bind.table.table_id
260 def add_vpp_config(self):
261 self._test.vapi.sw_interface_add_del_address(
262 sw_if_index=self.intf.sw_if_index, prefix=self.prefix,
264 self._test.registry.register(self, self._test.logger)
267 def remove_vpp_config(self):
268 self._test.vapi.sw_interface_add_del_address(
269 sw_if_index=self.intf.sw_if_index, prefix=self.prefix,
272 def query_vpp_config(self):
273 # search for the IP address mapping and the two expected
275 v = ip_address(self.addr).version
277 if ((v == 4 and self.len < 31) or (v == 6 and self.len < 127)):
278 return (fib_interface_ip_prefix(self._test,
281 self.intf.sw_if_index) &
282 find_route(self._test,
285 table_id=self.table_id,
286 sw_if_index=self.intf.sw_if_index) &
287 find_route(self._test,
290 table_id=self.table_id,
291 sw_if_index=self.intf.sw_if_index))
293 return (fib_interface_ip_prefix(self._test,
296 self.intf.sw_if_index) &
297 find_route(self._test,
300 table_id=self.table_id,
301 sw_if_index=self.intf.sw_if_index))
304 return "interface-ip-%s-%d-%s" % (self.intf,
309 class VppIp6LinkLocalAddress(VppObject):
311 def __init__(self, test, intf, addr):
316 def add_vpp_config(self):
317 self._test.vapi.sw_interface_ip6_set_link_local_address(
318 sw_if_index=self.intf.sw_if_index, ip=self.addr)
319 self._test.registry.register(self, self._test.logger)
322 def remove_vpp_config(self):
323 # link locals can't be removed, only changed
326 def query_vpp_config(self):
331 return "ip6-link-local-%s-%s" % (self.intf, self.addr)
334 class VppIpInterfaceBind(VppObject):
336 def __init__(self, test, intf, table):
341 def add_vpp_config(self):
342 if self.table.is_ip6:
343 self.intf.set_table_ip6(self.table.table_id)
345 self.intf.set_table_ip4(self.table.table_id)
346 self._test.registry.register(self, self._test.logger)
349 def remove_vpp_config(self):
350 if 0 == self.table.table_id:
352 if self.table.is_ip6:
353 self.intf.set_table_ip6(0)
355 self.intf.set_table_ip4(0)
357 def query_vpp_config(self):
358 if 0 == self.table.table_id:
360 return self._test.vapi.sw_interface_get_table(
361 self.intf.sw_if_index,
362 self.table.is_ip6).vrf_id == self.table.table_id
365 return "interface-bind-%s-%s" % (self.intf, self.table)
368 class VppMplsLabel(object):
369 def __init__(self, value, mode=MplsLspMode.PIPE, ttl=64, exp=0):
376 is_uniform = 0 if self.mode is MplsLspMode.PIPE else 1
377 return {'label': self.value,
380 'is_uniform': is_uniform}
382 def __eq__(self, other):
383 if isinstance(other, self.__class__):
384 return (self.value == other.value and
385 self.ttl == other.ttl and
386 self.exp == other.exp and
387 self.mode == other.mode)
388 elif hasattr(other, 'label'):
389 return (self.value == other.label and
390 self.ttl == other.ttl and
391 self.exp == other.exp and
392 (self.mode == MplsLspMode.UNIFORM) == other.is_uniform)
396 def __ne__(self, other):
397 return not (self == other)
400 class VppFibPathNextHop(object):
401 def __init__(self, addr,
402 via_label=MPLS_LABEL_INVALID,
403 next_hop_id=INVALID_INDEX):
404 self.addr = VppIpAddressUnion(addr)
405 self.via_label = via_label
406 self.obj_id = next_hop_id
409 if self.via_label is not MPLS_LABEL_INVALID:
410 return {'via_label': self.via_label}
411 if self.obj_id is not INVALID_INDEX:
412 return {'obj_id': self.obj_id}
414 return {'address': self.addr.encode()}
417 if self.via_label is MPLS_LABEL_INVALID:
418 return address_proto(self.addr)
420 return FibPathProto.FIB_PATH_NH_PROTO_MPLS
422 def __eq__(self, other):
423 if not isinstance(other, self.__class__):
424 # try the other instance's __eq__.
425 return NotImplemented
426 return (self.addr == other.addr and
427 self.via_label == other.via_label and
428 self.obj_id == other.obj_id)
431 class VppRoutePath(object):
439 nh_via_label=MPLS_LABEL_INVALID,
441 next_hop_id=INVALID_INDEX,
443 flags=FibPathFlags.FIB_PATH_FLAG_NONE,
444 type=FibPathType.FIB_PATH_TYPE_NORMAL):
445 self.nh_itf = nh_sw_if_index
446 self.nh_table_id = nh_table_id
447 self.nh_labels = labels
453 self.nh = VppFibPathNextHop(nh_addr, nh_via_label, next_hop_id)
455 self.proto = self.nh.proto()
458 self.next_hop_id = next_hop_id
460 def encode_labels(self):
462 for l in self.nh_labels:
463 if type(l) == VppMplsLabel:
464 lstack.append(l.encode())
466 lstack.append({'label': l,
468 while (len(lstack) < 16):
476 'table_id': self.nh_table_id,
477 'nh': self.nh.encode(),
478 'next_hop_id': self.next_hop_id,
479 'sw_if_index': self.nh_itf,
480 'rpf_id': self.rpf_id,
484 'n_labels': len(self.nh_labels),
485 'label_stack': self.encode_labels()}
487 def __eq__(self, other):
488 if isinstance(other, self.__class__):
489 return self.nh == other.nh
490 elif hasattr(other, 'sw_if_index'):
492 if (len(self.nh_labels) != other.n_labels):
494 for i in range(len(self.nh_labels)):
495 if (self.nh_labels[i] != other.label_stack[i]):
497 return self.nh_itf == other.sw_if_index
501 def __ne__(self, other):
502 return not (self == other)
505 class VppMRoutePath(VppRoutePath):
507 def __init__(self, nh_sw_if_index, flags,
509 proto=FibPathProto.FIB_PATH_NH_PROTO_IP4,
510 type=FibPathType.FIB_PATH_TYPE_NORMAL,
511 bier_imp=INVALID_INDEX):
513 nh = "::" if proto is FibPathProto.FIB_PATH_NH_PROTO_IP6 \
515 super(VppMRoutePath, self).__init__(nh,
519 next_hop_id=bier_imp)
520 self.nh_i_flags = flags
521 self.bier_imp = bier_imp
524 return {'path': super(VppMRoutePath, self).encode(),
525 'itf_flags': self.nh_i_flags}
528 class VppIpRoute(VppObject):
533 def __init__(self, test, dest_addr,
534 dest_addr_len, paths, table_id=0, register=True):
537 self.table_id = table_id
538 self.prefix = mk_network(dest_addr, dest_addr_len)
539 self.register = register
540 self.stats_index = None
541 self.modified = False
543 self.encoded_paths = []
544 for path in self.paths:
545 self.encoded_paths.append(path.encode())
547 def __eq__(self, other):
548 if self.table_id == other.table_id and \
549 self.prefix == other.prefix:
553 def modify(self, paths):
555 self.encoded_paths = []
556 for path in self.paths:
557 self.encoded_paths.append(path.encode())
560 self._test.vapi.ip_route_add_del(route={'table_id': self.table_id,
561 'prefix': self.prefix,
564 'paths': self.encoded_paths,
569 def add_vpp_config(self):
570 r = self._test.vapi.ip_route_add_del(
571 route={'table_id': self.table_id,
572 'prefix': self.prefix,
573 'n_paths': len(self.encoded_paths),
574 'paths': self.encoded_paths,
578 self.stats_index = r.stats_index
580 self._test.registry.register(self, self._test.logger)
583 def remove_vpp_config(self):
584 # there's no need to issue different deletes for modified routes
585 # we do this only to test the two different ways to delete routes
586 # eiter by passing all the paths to remove and mutlipath=1 or
587 # passing no paths and multipath=0
589 self._test.vapi.ip_route_add_del(
590 route={'table_id': self.table_id,
591 'prefix': self.prefix,
594 'paths': self.encoded_paths},
598 self._test.vapi.ip_route_add_del(
599 route={'table_id': self.table_id,
600 'prefix': self.prefix,
605 def query_vpp_config(self):
606 return find_route(self._test,
607 self.prefix.network_address,
608 self.prefix.prefixlen,
612 return ("%s:table-%d-%s" % (
613 'ip6-route' if self.prefix.version == 6 else 'ip-route',
617 def get_stats_to(self):
618 c = self._test.statistics.get_counter("/net/route/to")
619 return c[0][self.stats_index]
621 def get_stats_via(self):
622 c = self._test.statistics.get_counter("/net/route/via")
623 return c[0][self.stats_index]
626 class VppIpMRoute(VppObject):
631 def __init__(self, test, src_addr, grp_addr,
632 grp_addr_len, e_flags, paths, table_id=0,
636 self.table_id = table_id
637 self.e_flags = e_flags
640 self.prefix = VppIpMPrefix(src_addr, grp_addr, grp_addr_len)
641 self.encoded_paths = []
642 for path in self.paths:
643 self.encoded_paths.append(path.encode())
645 def encode(self, paths=None):
646 _paths = self.encoded_paths if paths is None else paths
647 return {'table_id': self.table_id,
648 'entry_flags': self.e_flags,
649 'rpf_id': self.rpf_id,
650 'prefix': self.prefix.encode(),
651 'n_paths': len(_paths),
655 def add_vpp_config(self):
656 r = self._test.vapi.ip_mroute_add_del(route=self.encode(),
659 self.stats_index = r.stats_index
660 self._test.registry.register(self, self._test.logger)
663 def remove_vpp_config(self):
664 self._test.vapi.ip_mroute_add_del(route=self.encode(),
668 def update_entry_flags(self, flags):
670 self._test.vapi.ip_mroute_add_del(route=self.encode(paths=[]),
674 def update_rpf_id(self, rpf_id):
676 self._test.vapi.ip_mroute_add_del(route=self.encode(paths=[]),
680 def update_path_flags(self, itf, flags):
681 for p in range(len(self.paths)):
682 if self.paths[p].nh_itf == itf:
683 self.paths[p].nh_i_flags = flags
684 self.encoded_paths[p] = self.paths[p].encode()
687 self._test.vapi.ip_mroute_add_del(
689 paths=[self.encoded_paths[p]]),
693 def query_vpp_config(self):
694 return find_mroute(self._test,
701 return ("%d:(%s,%s/%d)" % (self.table_id,
707 c = self._test.statistics.get_counter("/net/mroute")
708 return c[0][self.stats_index]
711 class VppMFibSignal(object):
712 def __init__(self, test, route, interface, packet):
714 self.interface = interface
718 def compare(self, signal):
719 self.test.assertEqual(self.interface, signal.sw_if_index)
720 self.test.assertEqual(self.route.table_id, signal.table_id)
721 self.test.assertEqual(self.route.prefix, signal.prefix)
724 class VppMplsIpBind(VppObject):
729 def __init__(self, test, local_label, dest_addr, dest_addr_len,
730 table_id=0, ip_table_id=0, is_ip6=0):
732 self.dest_addr_len = dest_addr_len
733 self.dest_addr = dest_addr
734 self.ip_addr = ip_address(text_type(dest_addr))
735 self.local_label = local_label
736 self.table_id = table_id
737 self.ip_table_id = ip_table_id
738 self.prefix = mk_network(dest_addr, dest_addr_len)
740 def add_vpp_config(self):
741 self._test.vapi.mpls_ip_bind_unbind(self.local_label,
743 table_id=self.table_id,
744 ip_table_id=self.ip_table_id)
745 self._test.registry.register(self, self._test.logger)
747 def remove_vpp_config(self):
748 self._test.vapi.mpls_ip_bind_unbind(self.local_label,
750 table_id=self.table_id,
751 ip_table_id=self.ip_table_id,
754 def query_vpp_config(self):
755 dump = self._test.vapi.mpls_route_dump(self.table_id)
757 if self.local_label == e.mr_route.mr_label \
758 and self.table_id == e.mr_route.mr_table_id:
763 return ("%d:%s binds %d:%s/%d"
771 class VppMplsTable(VppObject):
777 self.table_id = table_id
779 def add_vpp_config(self):
780 self._test.vapi.mpls_table_add_del(
783 self._test.registry.register(self, self._test.logger)
785 def remove_vpp_config(self):
786 self._test.vapi.mpls_table_add_del(
790 def query_vpp_config(self):
791 dump = self._test.vapi.mpls_table_dump()
793 if d.mt_table.mt_table_id == self.table_id:
798 return ("table-mpls-%d" % (self.table_id))
801 class VppMplsRoute(VppObject):
806 def __init__(self, test, local_label, eos_bit, paths, table_id=0,
808 eos_proto=FibPathProto.FIB_PATH_NH_PROTO_IP4):
811 self.local_label = local_label
812 self.eos_bit = eos_bit
813 self.eos_proto = eos_proto
814 self.table_id = table_id
815 self.is_multicast = is_multicast
817 def add_vpp_config(self):
819 for path in self.paths:
820 paths.append(path.encode())
822 r = self._test.vapi.mpls_route_add_del(self.table_id,
828 self.stats_index = r.stats_index
829 self._test.registry.register(self, self._test.logger)
831 def remove_vpp_config(self):
833 for path in self.paths:
834 paths.append(path.encode())
836 self._test.vapi.mpls_route_add_del(self.table_id,
843 def query_vpp_config(self):
844 return find_mpls_route(self._test, self.table_id,
845 self.local_label, self.eos_bit)
848 return ("mpls-route-%d:%s/%d"
853 def get_stats_to(self):
854 c = self._test.statistics.get_counter("/net/route/to")
855 return c[0][self.stats_index]
857 def get_stats_via(self):
858 c = self._test.statistics.get_counter("/net/route/via")
859 return c[0][self.stats_index]