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):
193 self.table_id = table_id
196 def add_vpp_config(self):
197 self._test.vapi.ip_table_add_del(is_add=1,
198 table={'is_ip6': self.is_ip6,
199 'table_id': self.table_id})
200 self._test.registry.register(self, self._test.logger)
203 def remove_vpp_config(self):
204 self._test.vapi.ip_table_add_del(is_add=0,
205 table={'is_ip6': self.is_ip6,
206 'table_id': self.table_id})
208 def replace_begin(self):
209 self._test.vapi.ip_table_replace_begin(
210 table={'is_ip6': self.is_ip6,
211 'table_id': self.table_id})
213 def replace_end(self):
214 self._test.vapi.ip_table_replace_end(
215 table={'is_ip6': self.is_ip6,
216 'table_id': self.table_id})
219 self._test.vapi.ip_table_flush(table={'is_ip6': self.is_ip6,
220 'table_id': self.table_id})
223 return self._test.vapi.ip_route_dump(self.table_id, self.is_ip6)
226 return self._test.vapi.ip_mroute_dump(self.table_id, self.is_ip6)
228 def query_vpp_config(self):
229 if self.table_id == 0:
230 # the default table always exists
232 # find the default route
233 return find_route(self._test,
234 "::" if self.is_ip6 else "0.0.0.0",
239 return ("table-%s-%d" %
240 ("v6" if self.is_ip6 == 1 else "v4",
244 class VppIpInterfaceAddress(VppObject):
246 def __init__(self, test, intf, addr, len, bind=None):
251 self.prefix = "%s/%d" % (addr, len)
252 self.host_len = ip_network(self.prefix, strict=False).max_prefixlen
255 self.table_id = bind.table.table_id
257 def add_vpp_config(self):
258 self._test.vapi.sw_interface_add_del_address(
259 sw_if_index=self.intf.sw_if_index, prefix=self.prefix,
261 self._test.registry.register(self, self._test.logger)
264 def remove_vpp_config(self):
265 self._test.vapi.sw_interface_add_del_address(
266 sw_if_index=self.intf.sw_if_index, prefix=self.prefix,
269 def query_vpp_config(self):
270 # search for the IP address mapping and the two expected
272 v = ip_address(self.addr).version
274 if ((v == 4 and self.len < 31) or (v == 6 and self.len < 127)):
275 return (fib_interface_ip_prefix(self._test,
278 self.intf.sw_if_index) &
279 find_route(self._test,
282 table_id=self.table_id,
283 sw_if_index=self.intf.sw_if_index) &
284 find_route(self._test,
287 table_id=self.table_id,
288 sw_if_index=self.intf.sw_if_index))
290 return (fib_interface_ip_prefix(self._test,
293 self.intf.sw_if_index) &
294 find_route(self._test,
297 table_id=self.table_id,
298 sw_if_index=self.intf.sw_if_index))
301 return "interface-ip-%s-%d-%s" % (self.intf,
306 class VppIpInterfaceBind(VppObject):
308 def __init__(self, test, intf, table):
313 def add_vpp_config(self):
314 if self.table.is_ip6:
315 self.intf.set_table_ip6(self.table.table_id)
317 self.intf.set_table_ip4(self.table.table_id)
318 self._test.registry.register(self, self._test.logger)
321 def remove_vpp_config(self):
322 if 0 == self.table.table_id:
324 if self.table.is_ip6:
325 self.intf.set_table_ip6(0)
327 self.intf.set_table_ip4(0)
329 def query_vpp_config(self):
330 if 0 == self.table.table_id:
332 return self._test.vapi.sw_interface_get_table(
333 self.intf.sw_if_index,
334 self.table.is_ip6).vrf_id == self.table.table_id
337 return "interface-bind-%s-%s" % (self.intf, self.table)
340 class VppMplsLabel(object):
341 def __init__(self, value, mode=MplsLspMode.PIPE, ttl=64, exp=0):
348 is_uniform = 0 if self.mode is MplsLspMode.PIPE else 1
349 return {'label': self.value,
352 'is_uniform': is_uniform}
354 def __eq__(self, other):
355 if isinstance(other, self.__class__):
356 return (self.value == other.value and
357 self.ttl == other.ttl and
358 self.exp == other.exp and
359 self.mode == other.mode)
360 elif hasattr(other, 'label'):
361 return (self.value == other.label and
362 self.ttl == other.ttl and
363 self.exp == other.exp and
364 (self.mode == MplsLspMode.UNIFORM) == other.is_uniform)
368 def __ne__(self, other):
369 return not (self == other)
372 class VppFibPathNextHop(object):
373 def __init__(self, addr,
374 via_label=MPLS_LABEL_INVALID,
375 next_hop_id=INVALID_INDEX):
376 self.addr = VppIpAddressUnion(addr)
377 self.via_label = via_label
378 self.obj_id = next_hop_id
381 if self.via_label is not MPLS_LABEL_INVALID:
382 return {'via_label': self.via_label}
383 if self.obj_id is not INVALID_INDEX:
384 return {'obj_id': self.obj_id}
386 return {'address': self.addr.encode()}
389 if self.via_label is MPLS_LABEL_INVALID:
390 return address_proto(self.addr)
392 return FibPathProto.FIB_PATH_NH_PROTO_MPLS
394 def __eq__(self, other):
395 if not isinstance(other, self.__class__):
396 # try the other instance's __eq__.
397 return NotImplemented
398 return (self.addr == other.addr and
399 self.via_label == other.via_label and
400 self.obj_id == other.obj_id)
403 class VppRoutePath(object):
411 nh_via_label=MPLS_LABEL_INVALID,
413 next_hop_id=INVALID_INDEX,
415 flags=FibPathFlags.FIB_PATH_FLAG_NONE,
416 type=FibPathType.FIB_PATH_TYPE_NORMAL):
417 self.nh_itf = nh_sw_if_index
418 self.nh_table_id = nh_table_id
419 self.nh_labels = labels
425 self.nh = VppFibPathNextHop(nh_addr, nh_via_label, next_hop_id)
427 self.proto = self.nh.proto()
430 self.next_hop_id = next_hop_id
432 def encode_labels(self):
434 for l in self.nh_labels:
435 if type(l) == VppMplsLabel:
436 lstack.append(l.encode())
438 lstack.append({'label': l,
440 while (len(lstack) < 16):
448 'table_id': self.nh_table_id,
449 'nh': self.nh.encode(),
450 'next_hop_id': self.next_hop_id,
451 'sw_if_index': self.nh_itf,
452 'rpf_id': self.rpf_id,
456 'n_labels': len(self.nh_labels),
457 'label_stack': self.encode_labels()}
459 def __eq__(self, other):
460 if isinstance(other, self.__class__):
461 return self.nh == other.nh
462 elif hasattr(other, 'sw_if_index'):
464 if (len(self.nh_labels) != other.n_labels):
466 for i in range(len(self.nh_labels)):
467 if (self.nh_labels[i] != other.label_stack[i]):
469 return self.nh_itf == other.sw_if_index
473 def __ne__(self, other):
474 return not (self == other)
477 class VppMRoutePath(VppRoutePath):
479 def __init__(self, nh_sw_if_index, flags,
481 proto=FibPathProto.FIB_PATH_NH_PROTO_IP4,
482 type=FibPathType.FIB_PATH_TYPE_NORMAL,
483 bier_imp=INVALID_INDEX):
485 nh = "::" if proto is FibPathProto.FIB_PATH_NH_PROTO_IP6 \
487 super(VppMRoutePath, self).__init__(nh,
491 next_hop_id=bier_imp)
492 self.nh_i_flags = flags
493 self.bier_imp = bier_imp
496 return {'path': super(VppMRoutePath, self).encode(),
497 'itf_flags': self.nh_i_flags}
500 class VppIpRoute(VppObject):
505 def __init__(self, test, dest_addr,
506 dest_addr_len, paths, table_id=0, register=True):
509 self.table_id = table_id
510 self.prefix = mk_network(dest_addr, dest_addr_len)
511 self.register = register
512 self.stats_index = None
513 self.modified = False
515 self.encoded_paths = []
516 for path in self.paths:
517 self.encoded_paths.append(path.encode())
519 def __eq__(self, other):
520 if self.table_id == other.table_id and \
521 self.prefix == other.prefix:
525 def modify(self, paths):
527 self.encoded_paths = []
528 for path in self.paths:
529 self.encoded_paths.append(path.encode())
532 self._test.vapi.ip_route_add_del(route={'table_id': self.table_id,
533 'prefix': self.prefix,
536 'paths': self.encoded_paths,
541 def add_vpp_config(self):
542 r = self._test.vapi.ip_route_add_del(
543 route={'table_id': self.table_id,
544 'prefix': self.prefix,
545 'n_paths': len(self.encoded_paths),
546 'paths': self.encoded_paths,
550 self.stats_index = r.stats_index
552 self._test.registry.register(self, self._test.logger)
555 def remove_vpp_config(self):
556 # there's no need to issue different deletes for modified routes
557 # we do this only to test the two different ways to delete routes
558 # eiter by passing all the paths to remove and mutlipath=1 or
559 # passing no paths and multipath=0
561 self._test.vapi.ip_route_add_del(
562 route={'table_id': self.table_id,
563 'prefix': self.prefix,
566 'paths': self.encoded_paths},
570 self._test.vapi.ip_route_add_del(
571 route={'table_id': self.table_id,
572 'prefix': self.prefix,
577 def query_vpp_config(self):
578 return find_route(self._test,
579 self.prefix.network_address,
580 self.prefix.prefixlen,
584 return ("%s:table-%d-%s" % (
585 'ip6-route' if self.prefix.version == 6 else 'ip-route',
589 def get_stats_to(self):
590 c = self._test.statistics.get_counter("/net/route/to")
591 return c[0][self.stats_index]
593 def get_stats_via(self):
594 c = self._test.statistics.get_counter("/net/route/via")
595 return c[0][self.stats_index]
598 class VppIpMRoute(VppObject):
603 def __init__(self, test, src_addr, grp_addr,
604 grp_addr_len, e_flags, paths, table_id=0,
608 self.table_id = table_id
609 self.e_flags = e_flags
612 self.prefix = VppIpMPrefix(src_addr, grp_addr, grp_addr_len)
613 self.encoded_paths = []
614 for path in self.paths:
615 self.encoded_paths.append(path.encode())
617 def add_vpp_config(self):
618 r = self._test.vapi.ip_mroute_add_del(self.table_id,
619 self.prefix.encode(),
624 self.stats_index = r.stats_index
625 self._test.registry.register(self, self._test.logger)
628 def remove_vpp_config(self):
629 self._test.vapi.ip_mroute_add_del(self.table_id,
630 self.prefix.encode(),
636 def update_entry_flags(self, flags):
638 self._test.vapi.ip_mroute_add_del(self.table_id,
639 self.prefix.encode(),
645 def update_rpf_id(self, rpf_id):
647 self._test.vapi.ip_mroute_add_del(self.table_id,
648 self.prefix.encode(),
654 def update_path_flags(self, itf, flags):
655 for p in range(len(self.paths)):
656 if self.paths[p].nh_itf == itf:
657 self.paths[p].nh_i_flags = flags
658 self.encoded_paths[p] = self.paths[p].encode()
661 self._test.vapi.ip_mroute_add_del(self.table_id,
662 self.prefix.encode(),
665 [self.encoded_paths[p]],
669 def query_vpp_config(self):
670 return find_mroute(self._test,
677 return ("%d:(%s,%s/%d)" % (self.table_id,
683 c = self._test.statistics.get_counter("/net/mroute")
684 return c[0][self.stats_index]
687 class VppMFibSignal(object):
688 def __init__(self, test, route, interface, packet):
690 self.interface = interface
694 def compare(self, signal):
695 self.test.assertEqual(self.interface, signal.sw_if_index)
696 self.test.assertEqual(self.route.table_id, signal.table_id)
697 self.test.assertEqual(self.route.prefix, signal.prefix)
700 class VppMplsIpBind(VppObject):
705 def __init__(self, test, local_label, dest_addr, dest_addr_len,
706 table_id=0, ip_table_id=0, is_ip6=0):
708 self.dest_addr_len = dest_addr_len
709 self.dest_addr = dest_addr
710 self.ip_addr = ip_address(text_type(dest_addr))
711 self.local_label = local_label
712 self.table_id = table_id
713 self.ip_table_id = ip_table_id
714 self.prefix = mk_network(dest_addr, dest_addr_len)
716 def add_vpp_config(self):
717 self._test.vapi.mpls_ip_bind_unbind(self.local_label,
719 table_id=self.table_id,
720 ip_table_id=self.ip_table_id)
721 self._test.registry.register(self, self._test.logger)
723 def remove_vpp_config(self):
724 self._test.vapi.mpls_ip_bind_unbind(self.local_label,
726 table_id=self.table_id,
727 ip_table_id=self.ip_table_id,
730 def query_vpp_config(self):
731 dump = self._test.vapi.mpls_route_dump(self.table_id)
733 if self.local_label == e.mr_route.mr_label \
734 and self.table_id == e.mr_route.mr_table_id:
739 return ("%d:%s binds %d:%s/%d"
747 class VppMplsTable(VppObject):
753 self.table_id = table_id
755 def add_vpp_config(self):
756 self._test.vapi.mpls_table_add_del(
759 self._test.registry.register(self, self._test.logger)
761 def remove_vpp_config(self):
762 self._test.vapi.mpls_table_add_del(
766 def query_vpp_config(self):
767 dump = self._test.vapi.mpls_table_dump()
769 if d.mt_table.mt_table_id == self.table_id:
774 return ("table-mpls-%d" % (self.table_id))
777 class VppMplsRoute(VppObject):
782 def __init__(self, test, local_label, eos_bit, paths, table_id=0,
784 eos_proto=FibPathProto.FIB_PATH_NH_PROTO_IP4):
787 self.local_label = local_label
788 self.eos_bit = eos_bit
789 self.eos_proto = eos_proto
790 self.table_id = table_id
791 self.is_multicast = is_multicast
793 def add_vpp_config(self):
795 for path in self.paths:
796 paths.append(path.encode())
798 r = self._test.vapi.mpls_route_add_del(self.table_id,
804 self.stats_index = r.stats_index
805 self._test.registry.register(self, self._test.logger)
807 def remove_vpp_config(self):
809 for path in self.paths:
810 paths.append(path.encode())
812 self._test.vapi.mpls_route_add_del(self.table_id,
819 def query_vpp_config(self):
820 return find_mpls_route(self._test, self.table_id,
821 self.local_label, self.eos_bit)
824 return ("mpls-route-%d:%s/%d"
829 def get_stats_to(self):
830 c = self._test.statistics.get_counter("/net/route/to")
831 return c[0][self.stats_index]
833 def get_stats_via(self):
834 c = self._test.statistics.get_counter("/net/route/via")
835 return c[0][self.stats_index]