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, VppIpPrefix, 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 ip_to_dpo_proto(addr):
77 return DpoProto.DPO_PROTO_IP6
79 return DpoProto.DPO_PROTO_IP4
82 def address_proto(ip_addr):
83 if ip_addr.ip_addr.version is 4:
84 return FibPathProto.FIB_PATH_NH_PROTO_IP4
86 return FibPathProto.FIB_PATH_NH_PROTO_IP6
89 def find_route(test, addr, len, table_id=0):
90 ip_addr = ip_address(text_type(addr))
92 if 4 is ip_addr.version:
93 routes = test.vapi.ip_route_dump(table_id, False)
94 prefix = IPv4Network("%s/%d" % (text_type(addr), len), strict=False)
96 routes = test.vapi.ip_route_dump(table_id, True)
97 prefix = IPv6Network("%s/%d" % (text_type(addr), len), strict=False)
100 if table_id == e.route.table_id \
101 and prefix == e.route.prefix:
106 def find_mroute(test, grp_addr, src_addr, grp_addr_len,
108 ip_mprefix = VppIpMPrefix(text_type(src_addr),
112 if 4 is ip_mprefix.version:
113 routes = test.vapi.ip_mroute_dump(table_id, False)
115 routes = test.vapi.ip_mroute_dump(table_id, True)
118 if table_id == e.route.table_id and ip_mprefix == e.route.prefix:
123 def find_mpls_route(test, table_id, label, eos_bit, paths=None):
124 dump = test.vapi.mpls_route_dump(table_id)
126 if label == e.mr_route.mr_label \
127 and eos_bit == e.mr_route.mr_eos \
128 and table_id == e.mr_route.mr_table_id:
132 if (len(paths) != len(e.mr_route.mr_paths)):
134 for i in range(len(paths)):
135 if (paths[i] != e.mr_route.mr_paths[i]):
141 def fib_interface_ip_prefix(test, address, length, sw_if_index):
142 ip_addr = ip_address(text_type(address))
144 if 4 is ip_addr.version:
145 addrs = test.vapi.ip_address_dump(sw_if_index)
146 prefix = IPv4Network("%s/%d" % (text_type(address), length),
149 addrs = test.vapi.ip_address_dump(sw_if_index, is_ipv6=1)
150 prefix = IPv6Network("%s/%d" % (text_type(address), length),
153 # TODO: refactor this to VppIpPrefix.__eq__
155 if a.sw_if_index == sw_if_index and \
156 a.prefix.network == prefix:
161 class VppIpTable(VppObject):
168 self.table_id = table_id
171 def add_vpp_config(self):
172 self._test.vapi.ip_table_add_del(is_ipv6=self.is_ip6, is_add=1,
173 table_id=self.table_id)
174 self._test.registry.register(self, self._test.logger)
176 def remove_vpp_config(self):
177 self._test.vapi.ip_table_add_del(is_ipv6=self.is_ip6, is_add=0,
178 table_id=self.table_id)
180 def query_vpp_config(self):
181 if self.table_id == 0:
182 # the default table always exists
184 # find the default route
185 return find_route(self._test,
186 "::" if self.is_ip6 else "0.0.0.0",
191 return ("table-%s-%d" %
192 ("v6" if self.is_ip6 == 1 else "v4",
196 class VppIpInterfaceAddress(VppObject):
198 def __init__(self, test, intf, addr, len):
201 self.prefix = VppIpPrefix(addr, len)
203 def add_vpp_config(self):
204 self._test.vapi.sw_interface_add_del_address(
205 sw_if_index=self.intf.sw_if_index, prefix=self.prefix.encode(),
207 self._test.registry.register(self, self._test.logger)
209 def remove_vpp_config(self):
210 self._test.vapi.sw_interface_add_del_address(
211 sw_if_index=self.intf.sw_if_index, prefix=self.prefix.encode(),
214 def query_vpp_config(self):
215 return fib_interface_ip_prefix(self._test,
218 self.intf.sw_if_index)
221 return "interface-ip-%s-%s" % (self.intf, self.prefix)
224 class VppIpInterfaceBind(VppObject):
226 def __init__(self, test, intf, table):
231 def add_vpp_config(self):
232 if self.table.is_ip6:
233 self.intf.set_table_ip6(self.table.table_id)
235 self.intf.set_table_ip4(self.table.table_id)
236 self._test.registry.register(self, self._test.logger)
238 def remove_vpp_config(self):
239 if 0 == self.table.table_id:
241 if self.table.is_ip6:
242 self.intf.set_table_ip6(0)
244 self.intf.set_table_ip4(0)
246 def query_vpp_config(self):
247 if 0 == self.table.table_id:
249 return self._test.vapi.sw_interface_get_table(
250 self.intf.sw_if_index,
251 self.table.is_ip6).vrf_id == self.table.table_id
254 return "interface-bind-%s-%s" % (self.intf, self.table)
257 class VppMplsLabel(object):
258 def __init__(self, value, mode=MplsLspMode.PIPE, ttl=64, exp=0):
265 is_uniform = 0 if self.mode is MplsLspMode.PIPE else 1
266 return {'label': self.value,
269 'is_uniform': is_uniform}
271 def __eq__(self, other):
272 if isinstance(other, self.__class__):
273 return (self.value == other.value and
274 self.ttl == other.ttl and
275 self.exp == other.exp and
276 self.mode == other.mode)
277 elif hasattr(other, 'label'):
278 return (self.value == other.label and
279 self.ttl == other.ttl and
280 self.exp == other.exp and
281 (self.mode == MplsLspMode.UNIFORM) == other.is_uniform)
285 def __ne__(self, other):
286 return not (self == other)
289 class VppFibPathNextHop(object):
290 def __init__(self, addr,
291 via_label=MPLS_LABEL_INVALID,
292 next_hop_id=INVALID_INDEX):
293 self.addr = VppIpAddressUnion(addr)
294 self.via_label = via_label
295 self.obj_id = next_hop_id
298 if self.via_label is not MPLS_LABEL_INVALID:
299 return {'via_label': self.via_label}
300 if self.obj_id is not INVALID_INDEX:
301 return {'obj_id': self.obj_id}
303 return {'address': self.addr.encode()}
306 if self.via_label is MPLS_LABEL_INVALID:
307 return address_proto(self.addr)
309 return FibPathProto.FIB_PATH_NH_PROTO_MPLS
311 def __eq__(self, other):
312 if not isinstance(other, self.__class__):
313 # try the other instance's __eq__.
314 return NotImplemented
315 return (self.addr == other.addr and
316 self.via_label == other.via_label and
317 self.obj_id == other.obj_id)
320 class VppRoutePath(object):
328 nh_via_label=MPLS_LABEL_INVALID,
330 next_hop_id=INVALID_INDEX,
332 flags=FibPathFlags.FIB_PATH_FLAG_NONE,
333 type=FibPathType.FIB_PATH_TYPE_NORMAL):
334 self.nh_itf = nh_sw_if_index
335 self.nh_table_id = nh_table_id
336 self.nh_labels = labels
342 self.nh = VppFibPathNextHop(nh_addr, nh_via_label, next_hop_id)
344 self.proto = self.nh.proto()
347 self.next_hop_id = next_hop_id
349 def encode_labels(self):
351 for l in self.nh_labels:
352 if type(l) == VppMplsLabel:
353 lstack.append(l.encode())
355 lstack.append({'label': l,
357 while (len(lstack) < 16):
365 'table_id': self.nh_table_id,
366 'nh': self.nh.encode(),
367 'next_hop_id': self.next_hop_id,
368 'sw_if_index': self.nh_itf,
369 'rpf_id': self.rpf_id,
373 'n_labels': len(self.nh_labels),
374 'label_stack': self.encode_labels()}
376 def __eq__(self, other):
377 if isinstance(other, self.__class__):
378 return self.nh == other.nh
379 elif hasattr(other, 'sw_if_index'):
381 if (len(self.nh_labels) != other.n_labels):
383 for i in range(len(self.nh_labels)):
384 if (self.nh_labels[i] != other.label_stack[i]):
386 return self.nh_itf == other.sw_if_index
390 def __ne__(self, other):
391 return not (self == other)
394 class VppMRoutePath(VppRoutePath):
396 def __init__(self, nh_sw_if_index, flags,
398 proto=FibPathProto.FIB_PATH_NH_PROTO_IP4,
399 type=FibPathType.FIB_PATH_TYPE_NORMAL,
400 bier_imp=INVALID_INDEX):
402 nh = "::" if proto is FibPathProto.FIB_PATH_NH_PROTO_IP6 \
404 super(VppMRoutePath, self).__init__(nh,
408 next_hop_id=bier_imp)
409 self.nh_i_flags = flags
410 self.bier_imp = bier_imp
413 return {'path': super(VppMRoutePath, self).encode(),
414 'itf_flags': self.nh_i_flags}
417 class VppIpRoute(VppObject):
422 def __init__(self, test, dest_addr,
423 dest_addr_len, paths, table_id=0, register=True):
426 self.table_id = table_id
427 self.prefix = VppIpPrefix(dest_addr, dest_addr_len)
428 self.register = register
429 self.stats_index = None
430 self.modified = False
432 self.encoded_paths = []
433 for path in self.paths:
434 self.encoded_paths.append(path.encode())
436 def __eq__(self, other):
437 if self.table_id == other.table_id and \
438 self.prefix == other.prefix:
442 def modify(self, paths):
444 self.encoded_paths = []
445 for path in self.paths:
446 self.encoded_paths.append(path.encode())
449 self._test.vapi.ip_route_add_del(route={'table_id': self.table_id,
450 'prefix': self.prefix.encode(),
453 'paths': self.encoded_paths,
458 def add_vpp_config(self):
459 r = self._test.vapi.ip_route_add_del(
460 route={'table_id': self.table_id,
461 'prefix': self.prefix.encode(),
462 'n_paths': len(self.encoded_paths),
463 'paths': self.encoded_paths,
467 self.stats_index = r.stats_index
469 self._test.registry.register(self, self._test.logger)
471 def remove_vpp_config(self):
472 # there's no need to issue different deletes for modified routes
473 # we do this only to test the two different ways to delete routes
474 # eiter by passing all the paths to remove and mutlipath=1 or
475 # passing no paths and multipath=0
477 self._test.vapi.ip_route_add_del(
478 route={'table_id': self.table_id,
479 'prefix': self.prefix.encode(),
482 'paths': self.encoded_paths},
486 self._test.vapi.ip_route_add_del(
487 route={'table_id': self.table_id,
488 'prefix': self.prefix.encode(),
493 def query_vpp_config(self):
494 return find_route(self._test,
500 return ("%s:table-%d-%s/%d" % (
501 'ip6-route' if self.prefix.addr.version == 6 else 'ip-route',
506 def get_stats_to(self):
507 c = self._test.statistics.get_counter("/net/route/to")
508 return c[0][self.stats_index]
510 def get_stats_via(self):
511 c = self._test.statistics.get_counter("/net/route/via")
512 return c[0][self.stats_index]
515 class VppIpMRoute(VppObject):
520 def __init__(self, test, src_addr, grp_addr,
521 grp_addr_len, e_flags, paths, table_id=0,
525 self.table_id = table_id
526 self.e_flags = e_flags
529 self.prefix = VppIpMPrefix(src_addr, grp_addr, grp_addr_len)
530 self.encoded_paths = []
531 for path in self.paths:
532 self.encoded_paths.append(path.encode())
534 def add_vpp_config(self):
535 r = self._test.vapi.ip_mroute_add_del(self.table_id,
536 self.prefix.encode(),
541 self.stats_index = r.stats_index
542 self._test.registry.register(self, self._test.logger)
544 def remove_vpp_config(self):
545 self._test.vapi.ip_mroute_add_del(self.table_id,
546 self.prefix.encode(),
552 def update_entry_flags(self, flags):
554 self._test.vapi.ip_mroute_add_del(self.table_id,
555 self.prefix.encode(),
561 def update_rpf_id(self, rpf_id):
563 self._test.vapi.ip_mroute_add_del(self.table_id,
564 self.prefix.encode(),
570 def update_path_flags(self, itf, flags):
571 for p in range(len(self.paths)):
572 if self.paths[p].nh_itf == itf:
573 self.paths[p].nh_i_flags = flags
574 self.encoded_paths[p] = self.paths[p].encode()
577 self._test.vapi.ip_mroute_add_del(self.table_id,
578 self.prefix.encode(),
581 [self.encoded_paths[p]],
585 def query_vpp_config(self):
586 return find_mroute(self._test,
593 return ("%d:(%s,%s/%d)" % (self.table_id,
599 c = self._test.statistics.get_counter("/net/mroute")
600 return c[0][self.stats_index]
603 class VppMFibSignal(object):
604 def __init__(self, test, route, interface, packet):
606 self.interface = interface
610 def compare(self, signal):
611 self.test.assertEqual(self.interface, signal.sw_if_index)
612 self.test.assertEqual(self.route.table_id, signal.table_id)
613 self.test.assertEqual(self.route.prefix, signal.prefix)
616 class VppMplsIpBind(VppObject):
621 def __init__(self, test, local_label, dest_addr, dest_addr_len,
622 table_id=0, ip_table_id=0, is_ip6=0):
624 self.dest_addr_len = dest_addr_len
625 self.dest_addr = dest_addr
626 self.ip_addr = ip_address(text_type(dest_addr))
627 self.local_label = local_label
628 self.table_id = table_id
629 self.ip_table_id = ip_table_id
630 self.prefix = VppIpPrefix(dest_addr, dest_addr_len)
632 def add_vpp_config(self):
633 self._test.vapi.mpls_ip_bind_unbind(self.local_label,
634 self.prefix.encode(),
635 table_id=self.table_id,
636 ip_table_id=self.ip_table_id)
637 self._test.registry.register(self, self._test.logger)
639 def remove_vpp_config(self):
640 self._test.vapi.mpls_ip_bind_unbind(self.local_label,
641 self.prefix.encode(),
642 table_id=self.table_id,
643 ip_table_id=self.ip_table_id,
646 def query_vpp_config(self):
647 dump = self._test.vapi.mpls_route_dump(self.table_id)
649 if self.local_label == e.mr_route.mr_label \
650 and self.table_id == e.mr_route.mr_table_id:
655 return ("%d:%s binds %d:%s/%d"
663 class VppMplsTable(VppObject):
669 self.table_id = table_id
671 def add_vpp_config(self):
672 self._test.vapi.mpls_table_add_del(
675 self._test.registry.register(self, self._test.logger)
677 def remove_vpp_config(self):
678 self._test.vapi.mpls_table_add_del(
682 def query_vpp_config(self):
683 dump = self._test.vapi.mpls_table_dump()
685 if d.mt_table.mt_table_id == self.table_id:
690 return ("table-mpls-%d" % (self.table_id))
693 class VppMplsRoute(VppObject):
698 def __init__(self, test, local_label, eos_bit, paths, table_id=0,
700 eos_proto=FibPathProto.FIB_PATH_NH_PROTO_IP4):
703 self.local_label = local_label
704 self.eos_bit = eos_bit
705 self.eos_proto = eos_proto
706 self.table_id = table_id
707 self.is_multicast = is_multicast
709 def add_vpp_config(self):
711 for path in self.paths:
712 paths.append(path.encode())
714 r = self._test.vapi.mpls_route_add_del(self.table_id,
720 self.stats_index = r.stats_index
721 self._test.registry.register(self, self._test.logger)
723 def remove_vpp_config(self):
725 for path in self.paths:
726 paths.append(path.encode())
728 self._test.vapi.mpls_route_add_del(self.table_id,
735 def query_vpp_config(self):
736 return find_mpls_route(self._test, self.table_id,
737 self.local_label, self.eos_bit)
740 return ("mpls-route-%d:%s/%d"
745 def get_stats_to(self):
746 c = self._test.statistics.get_counter("/net/route/to")
747 return c[0][self.stats_index]
749 def get_stats_via(self):
750 c = self._test.statistics.get_counter("/net/route/via")
751 return c[0][self.stats_index]