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_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):
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):
111 def find_route_in_dump(dump, route, table):
113 if table.table_id == r.route.table_id \
114 and route.prefix == r.route.prefix:
115 if len(route.paths) == r.route.n_paths:
120 def find_mroute_in_dump(dump, route, table):
122 if table.table_id == r.route.table_id \
123 and route.prefix == r.route.prefix:
128 def find_mroute(test, grp_addr, src_addr, grp_addr_len,
130 ip_mprefix = VppIpMPrefix(text_type(src_addr),
134 if 4 == ip_mprefix.version:
135 routes = test.vapi.ip_mroute_dump(table_id, False)
137 routes = test.vapi.ip_mroute_dump(table_id, True)
140 if table_id == e.route.table_id and ip_mprefix == e.route.prefix:
145 def find_mpls_route(test, table_id, label, eos_bit, paths=None):
146 dump = test.vapi.mpls_route_dump(table_id)
148 if label == e.mr_route.mr_label \
149 and eos_bit == e.mr_route.mr_eos \
150 and table_id == e.mr_route.mr_table_id:
154 if (len(paths) != len(e.mr_route.mr_paths)):
156 for i in range(len(paths)):
157 if (paths[i] != e.mr_route.mr_paths[i]):
163 def fib_interface_ip_prefix(test, addr, len, sw_if_index):
164 # can't use python net here since we need the host bits in the prefix
165 prefix = "%s/%d" % (addr, len)
166 addrs = test.vapi.ip_address_dump(
168 is_ipv6=(6 == ip_address(addr).version))
171 if a.sw_if_index == sw_if_index and \
172 str(a.prefix) == prefix:
177 class VppIpTable(VppObject):
184 self.table_id = table_id
187 def add_vpp_config(self):
188 self._test.vapi.ip_table_add_del(is_add=1,
189 table={'is_ip6': self.is_ip6,
190 'table_id': self.table_id})
191 self._test.registry.register(self, self._test.logger)
194 def remove_vpp_config(self):
195 self._test.vapi.ip_table_add_del(is_add=0,
196 table={'is_ip6': self.is_ip6,
197 'table_id': self.table_id})
199 def replace_begin(self):
200 self._test.vapi.ip_table_replace_begin(
201 table={'is_ip6': self.is_ip6,
202 'table_id': self.table_id})
204 def replace_end(self):
205 self._test.vapi.ip_table_replace_end(
206 table={'is_ip6': self.is_ip6,
207 'table_id': self.table_id})
210 self._test.vapi.ip_table_flush(table={'is_ip6': self.is_ip6,
211 'table_id': self.table_id})
214 return self._test.vapi.ip_route_dump(self.table_id, self.is_ip6)
217 return self._test.vapi.ip_mroute_dump(self.table_id, self.is_ip6)
219 def query_vpp_config(self):
220 if self.table_id == 0:
221 # the default table always exists
223 # find the default route
224 return find_route(self._test,
225 "::" if self.is_ip6 else "0.0.0.0",
230 return ("table-%s-%d" %
231 ("v6" if self.is_ip6 == 1 else "v4",
235 class VppIpInterfaceAddress(VppObject):
237 def __init__(self, test, intf, addr, len):
242 self.prefix = "%s/%d" % (addr, len)
244 def add_vpp_config(self):
245 self._test.vapi.sw_interface_add_del_address(
246 sw_if_index=self.intf.sw_if_index, prefix=self.prefix,
248 self._test.registry.register(self, self._test.logger)
251 def remove_vpp_config(self):
252 self._test.vapi.sw_interface_add_del_address(
253 sw_if_index=self.intf.sw_if_index, prefix=self.prefix,
256 def query_vpp_config(self):
257 return fib_interface_ip_prefix(self._test,
260 self.intf.sw_if_index)
263 return "interface-ip-%s-%s" % (self.intf, self.prefix)
266 class VppIpInterfaceBind(VppObject):
268 def __init__(self, test, intf, table):
273 def add_vpp_config(self):
274 if self.table.is_ip6:
275 self.intf.set_table_ip6(self.table.table_id)
277 self.intf.set_table_ip4(self.table.table_id)
278 self._test.registry.register(self, self._test.logger)
280 def remove_vpp_config(self):
281 if 0 == self.table.table_id:
283 if self.table.is_ip6:
284 self.intf.set_table_ip6(0)
286 self.intf.set_table_ip4(0)
288 def query_vpp_config(self):
289 if 0 == self.table.table_id:
291 return self._test.vapi.sw_interface_get_table(
292 self.intf.sw_if_index,
293 self.table.is_ip6).vrf_id == self.table.table_id
296 return "interface-bind-%s-%s" % (self.intf, self.table)
299 class VppMplsLabel(object):
300 def __init__(self, value, mode=MplsLspMode.PIPE, ttl=64, exp=0):
307 is_uniform = 0 if self.mode is MplsLspMode.PIPE else 1
308 return {'label': self.value,
311 'is_uniform': is_uniform}
313 def __eq__(self, other):
314 if isinstance(other, self.__class__):
315 return (self.value == other.value and
316 self.ttl == other.ttl and
317 self.exp == other.exp and
318 self.mode == other.mode)
319 elif hasattr(other, 'label'):
320 return (self.value == other.label and
321 self.ttl == other.ttl and
322 self.exp == other.exp and
323 (self.mode == MplsLspMode.UNIFORM) == other.is_uniform)
327 def __ne__(self, other):
328 return not (self == other)
331 class VppFibPathNextHop(object):
332 def __init__(self, addr,
333 via_label=MPLS_LABEL_INVALID,
334 next_hop_id=INVALID_INDEX):
335 self.addr = VppIpAddressUnion(addr)
336 self.via_label = via_label
337 self.obj_id = next_hop_id
340 if self.via_label is not MPLS_LABEL_INVALID:
341 return {'via_label': self.via_label}
342 if self.obj_id is not INVALID_INDEX:
343 return {'obj_id': self.obj_id}
345 return {'address': self.addr.encode()}
348 if self.via_label is MPLS_LABEL_INVALID:
349 return address_proto(self.addr)
351 return FibPathProto.FIB_PATH_NH_PROTO_MPLS
353 def __eq__(self, other):
354 if not isinstance(other, self.__class__):
355 # try the other instance's __eq__.
356 return NotImplemented
357 return (self.addr == other.addr and
358 self.via_label == other.via_label and
359 self.obj_id == other.obj_id)
362 class VppRoutePath(object):
370 nh_via_label=MPLS_LABEL_INVALID,
372 next_hop_id=INVALID_INDEX,
374 flags=FibPathFlags.FIB_PATH_FLAG_NONE,
375 type=FibPathType.FIB_PATH_TYPE_NORMAL):
376 self.nh_itf = nh_sw_if_index
377 self.nh_table_id = nh_table_id
378 self.nh_labels = labels
384 self.nh = VppFibPathNextHop(nh_addr, nh_via_label, next_hop_id)
386 self.proto = self.nh.proto()
389 self.next_hop_id = next_hop_id
391 def encode_labels(self):
393 for l in self.nh_labels:
394 if type(l) == VppMplsLabel:
395 lstack.append(l.encode())
397 lstack.append({'label': l,
399 while (len(lstack) < 16):
407 'table_id': self.nh_table_id,
408 'nh': self.nh.encode(),
409 'next_hop_id': self.next_hop_id,
410 'sw_if_index': self.nh_itf,
411 'rpf_id': self.rpf_id,
415 'n_labels': len(self.nh_labels),
416 'label_stack': self.encode_labels()}
418 def __eq__(self, other):
419 if isinstance(other, self.__class__):
420 return self.nh == other.nh
421 elif hasattr(other, 'sw_if_index'):
423 if (len(self.nh_labels) != other.n_labels):
425 for i in range(len(self.nh_labels)):
426 if (self.nh_labels[i] != other.label_stack[i]):
428 return self.nh_itf == other.sw_if_index
432 def __ne__(self, other):
433 return not (self == other)
436 class VppMRoutePath(VppRoutePath):
438 def __init__(self, nh_sw_if_index, flags,
440 proto=FibPathProto.FIB_PATH_NH_PROTO_IP4,
441 type=FibPathType.FIB_PATH_TYPE_NORMAL,
442 bier_imp=INVALID_INDEX):
444 nh = "::" if proto is FibPathProto.FIB_PATH_NH_PROTO_IP6 \
446 super(VppMRoutePath, self).__init__(nh,
450 next_hop_id=bier_imp)
451 self.nh_i_flags = flags
452 self.bier_imp = bier_imp
455 return {'path': super(VppMRoutePath, self).encode(),
456 'itf_flags': self.nh_i_flags}
459 class VppIpRoute(VppObject):
464 def __init__(self, test, dest_addr,
465 dest_addr_len, paths, table_id=0, register=True):
468 self.table_id = table_id
469 self.prefix = mk_network(dest_addr, dest_addr_len)
470 self.register = register
471 self.stats_index = None
472 self.modified = False
474 self.encoded_paths = []
475 for path in self.paths:
476 self.encoded_paths.append(path.encode())
478 def __eq__(self, other):
479 if self.table_id == other.table_id and \
480 self.prefix == other.prefix:
484 def modify(self, paths):
486 self.encoded_paths = []
487 for path in self.paths:
488 self.encoded_paths.append(path.encode())
491 self._test.vapi.ip_route_add_del(route={'table_id': self.table_id,
492 'prefix': self.prefix,
495 'paths': self.encoded_paths,
500 def add_vpp_config(self):
501 r = self._test.vapi.ip_route_add_del(
502 route={'table_id': self.table_id,
503 'prefix': self.prefix,
504 'n_paths': len(self.encoded_paths),
505 'paths': self.encoded_paths,
509 self.stats_index = r.stats_index
511 self._test.registry.register(self, self._test.logger)
514 def remove_vpp_config(self):
515 # there's no need to issue different deletes for modified routes
516 # we do this only to test the two different ways to delete routes
517 # eiter by passing all the paths to remove and mutlipath=1 or
518 # passing no paths and multipath=0
520 self._test.vapi.ip_route_add_del(
521 route={'table_id': self.table_id,
522 'prefix': self.prefix,
525 'paths': self.encoded_paths},
529 self._test.vapi.ip_route_add_del(
530 route={'table_id': self.table_id,
531 'prefix': self.prefix,
536 def query_vpp_config(self):
537 return find_route(self._test,
538 self.prefix.network_address,
539 self.prefix.prefixlen,
543 return ("%s:table-%d-%s" % (
544 'ip6-route' if self.prefix.version == 6 else 'ip-route',
548 def get_stats_to(self):
549 c = self._test.statistics.get_counter("/net/route/to")
550 return c[0][self.stats_index]
552 def get_stats_via(self):
553 c = self._test.statistics.get_counter("/net/route/via")
554 return c[0][self.stats_index]
557 class VppIpMRoute(VppObject):
562 def __init__(self, test, src_addr, grp_addr,
563 grp_addr_len, e_flags, paths, table_id=0,
567 self.table_id = table_id
568 self.e_flags = e_flags
571 self.prefix = VppIpMPrefix(src_addr, grp_addr, grp_addr_len)
572 self.encoded_paths = []
573 for path in self.paths:
574 self.encoded_paths.append(path.encode())
576 def add_vpp_config(self):
577 r = self._test.vapi.ip_mroute_add_del(self.table_id,
578 self.prefix.encode(),
583 self.stats_index = r.stats_index
584 self._test.registry.register(self, self._test.logger)
587 def remove_vpp_config(self):
588 self._test.vapi.ip_mroute_add_del(self.table_id,
589 self.prefix.encode(),
595 def update_entry_flags(self, flags):
597 self._test.vapi.ip_mroute_add_del(self.table_id,
598 self.prefix.encode(),
604 def update_rpf_id(self, rpf_id):
606 self._test.vapi.ip_mroute_add_del(self.table_id,
607 self.prefix.encode(),
613 def update_path_flags(self, itf, flags):
614 for p in range(len(self.paths)):
615 if self.paths[p].nh_itf == itf:
616 self.paths[p].nh_i_flags = flags
617 self.encoded_paths[p] = self.paths[p].encode()
620 self._test.vapi.ip_mroute_add_del(self.table_id,
621 self.prefix.encode(),
624 [self.encoded_paths[p]],
628 def query_vpp_config(self):
629 return find_mroute(self._test,
636 return ("%d:(%s,%s/%d)" % (self.table_id,
642 c = self._test.statistics.get_counter("/net/mroute")
643 return c[0][self.stats_index]
646 class VppMFibSignal(object):
647 def __init__(self, test, route, interface, packet):
649 self.interface = interface
653 def compare(self, signal):
654 self.test.assertEqual(self.interface, signal.sw_if_index)
655 self.test.assertEqual(self.route.table_id, signal.table_id)
656 self.test.assertEqual(self.route.prefix, signal.prefix)
659 class VppMplsIpBind(VppObject):
664 def __init__(self, test, local_label, dest_addr, dest_addr_len,
665 table_id=0, ip_table_id=0, is_ip6=0):
667 self.dest_addr_len = dest_addr_len
668 self.dest_addr = dest_addr
669 self.ip_addr = ip_address(text_type(dest_addr))
670 self.local_label = local_label
671 self.table_id = table_id
672 self.ip_table_id = ip_table_id
673 self.prefix = mk_network(dest_addr, dest_addr_len)
675 def add_vpp_config(self):
676 self._test.vapi.mpls_ip_bind_unbind(self.local_label,
678 table_id=self.table_id,
679 ip_table_id=self.ip_table_id)
680 self._test.registry.register(self, self._test.logger)
682 def remove_vpp_config(self):
683 self._test.vapi.mpls_ip_bind_unbind(self.local_label,
685 table_id=self.table_id,
686 ip_table_id=self.ip_table_id,
689 def query_vpp_config(self):
690 dump = self._test.vapi.mpls_route_dump(self.table_id)
692 if self.local_label == e.mr_route.mr_label \
693 and self.table_id == e.mr_route.mr_table_id:
698 return ("%d:%s binds %d:%s/%d"
706 class VppMplsTable(VppObject):
712 self.table_id = table_id
714 def add_vpp_config(self):
715 self._test.vapi.mpls_table_add_del(
718 self._test.registry.register(self, self._test.logger)
720 def remove_vpp_config(self):
721 self._test.vapi.mpls_table_add_del(
725 def query_vpp_config(self):
726 dump = self._test.vapi.mpls_table_dump()
728 if d.mt_table.mt_table_id == self.table_id:
733 return ("table-mpls-%d" % (self.table_id))
736 class VppMplsRoute(VppObject):
741 def __init__(self, test, local_label, eos_bit, paths, table_id=0,
743 eos_proto=FibPathProto.FIB_PATH_NH_PROTO_IP4):
746 self.local_label = local_label
747 self.eos_bit = eos_bit
748 self.eos_proto = eos_proto
749 self.table_id = table_id
750 self.is_multicast = is_multicast
752 def add_vpp_config(self):
754 for path in self.paths:
755 paths.append(path.encode())
757 r = self._test.vapi.mpls_route_add_del(self.table_id,
763 self.stats_index = r.stats_index
764 self._test.registry.register(self, self._test.logger)
766 def remove_vpp_config(self):
768 for path in self.paths:
769 paths.append(path.encode())
771 self._test.vapi.mpls_route_add_del(self.table_id,
778 def query_vpp_config(self):
779 return find_mpls_route(self._test, self.table_id,
780 self.local_label, self.eos_bit)
783 return ("mpls-route-%d:%s/%d"
788 def get_stats_to(self):
789 c = self._test.statistics.get_counter("/net/route/to")
790 return c[0][self.stats_index]
792 def get_stats_via(self):
793 c = self._test.statistics.get_counter("/net/route/via")
794 return c[0][self.stats_index]