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 is 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 is 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 is 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)
250 def remove_vpp_config(self):
251 self._test.vapi.sw_interface_add_del_address(
252 sw_if_index=self.intf.sw_if_index, prefix=self.prefix,
255 def query_vpp_config(self):
256 return fib_interface_ip_prefix(self._test,
259 self.intf.sw_if_index)
262 return "interface-ip-%s-%s" % (self.intf, self.prefix)
265 class VppIpInterfaceBind(VppObject):
267 def __init__(self, test, intf, table):
272 def add_vpp_config(self):
273 if self.table.is_ip6:
274 self.intf.set_table_ip6(self.table.table_id)
276 self.intf.set_table_ip4(self.table.table_id)
277 self._test.registry.register(self, self._test.logger)
279 def remove_vpp_config(self):
280 if 0 == self.table.table_id:
282 if self.table.is_ip6:
283 self.intf.set_table_ip6(0)
285 self.intf.set_table_ip4(0)
287 def query_vpp_config(self):
288 if 0 == self.table.table_id:
290 return self._test.vapi.sw_interface_get_table(
291 self.intf.sw_if_index,
292 self.table.is_ip6).vrf_id == self.table.table_id
295 return "interface-bind-%s-%s" % (self.intf, self.table)
298 class VppMplsLabel(object):
299 def __init__(self, value, mode=MplsLspMode.PIPE, ttl=64, exp=0):
306 is_uniform = 0 if self.mode is MplsLspMode.PIPE else 1
307 return {'label': self.value,
310 'is_uniform': is_uniform}
312 def __eq__(self, other):
313 if isinstance(other, self.__class__):
314 return (self.value == other.value and
315 self.ttl == other.ttl and
316 self.exp == other.exp and
317 self.mode == other.mode)
318 elif hasattr(other, 'label'):
319 return (self.value == other.label and
320 self.ttl == other.ttl and
321 self.exp == other.exp and
322 (self.mode == MplsLspMode.UNIFORM) == other.is_uniform)
326 def __ne__(self, other):
327 return not (self == other)
330 class VppFibPathNextHop(object):
331 def __init__(self, addr,
332 via_label=MPLS_LABEL_INVALID,
333 next_hop_id=INVALID_INDEX):
334 self.addr = VppIpAddressUnion(addr)
335 self.via_label = via_label
336 self.obj_id = next_hop_id
339 if self.via_label is not MPLS_LABEL_INVALID:
340 return {'via_label': self.via_label}
341 if self.obj_id is not INVALID_INDEX:
342 return {'obj_id': self.obj_id}
344 return {'address': self.addr.encode()}
347 if self.via_label is MPLS_LABEL_INVALID:
348 return address_proto(self.addr)
350 return FibPathProto.FIB_PATH_NH_PROTO_MPLS
352 def __eq__(self, other):
353 if not isinstance(other, self.__class__):
354 # try the other instance's __eq__.
355 return NotImplemented
356 return (self.addr == other.addr and
357 self.via_label == other.via_label and
358 self.obj_id == other.obj_id)
361 class VppRoutePath(object):
369 nh_via_label=MPLS_LABEL_INVALID,
371 next_hop_id=INVALID_INDEX,
373 flags=FibPathFlags.FIB_PATH_FLAG_NONE,
374 type=FibPathType.FIB_PATH_TYPE_NORMAL):
375 self.nh_itf = nh_sw_if_index
376 self.nh_table_id = nh_table_id
377 self.nh_labels = labels
383 self.nh = VppFibPathNextHop(nh_addr, nh_via_label, next_hop_id)
385 self.proto = self.nh.proto()
388 self.next_hop_id = next_hop_id
390 def encode_labels(self):
392 for l in self.nh_labels:
393 if type(l) == VppMplsLabel:
394 lstack.append(l.encode())
396 lstack.append({'label': l,
398 while (len(lstack) < 16):
406 'table_id': self.nh_table_id,
407 'nh': self.nh.encode(),
408 'next_hop_id': self.next_hop_id,
409 'sw_if_index': self.nh_itf,
410 'rpf_id': self.rpf_id,
414 'n_labels': len(self.nh_labels),
415 'label_stack': self.encode_labels()}
417 def __eq__(self, other):
418 if isinstance(other, self.__class__):
419 return self.nh == other.nh
420 elif hasattr(other, 'sw_if_index'):
422 if (len(self.nh_labels) != other.n_labels):
424 for i in range(len(self.nh_labels)):
425 if (self.nh_labels[i] != other.label_stack[i]):
427 return self.nh_itf == other.sw_if_index
431 def __ne__(self, other):
432 return not (self == other)
435 class VppMRoutePath(VppRoutePath):
437 def __init__(self, nh_sw_if_index, flags,
439 proto=FibPathProto.FIB_PATH_NH_PROTO_IP4,
440 type=FibPathType.FIB_PATH_TYPE_NORMAL,
441 bier_imp=INVALID_INDEX):
443 nh = "::" if proto is FibPathProto.FIB_PATH_NH_PROTO_IP6 \
445 super(VppMRoutePath, self).__init__(nh,
449 next_hop_id=bier_imp)
450 self.nh_i_flags = flags
451 self.bier_imp = bier_imp
454 return {'path': super(VppMRoutePath, self).encode(),
455 'itf_flags': self.nh_i_flags}
458 class VppIpRoute(VppObject):
463 def __init__(self, test, dest_addr,
464 dest_addr_len, paths, table_id=0, register=True):
467 self.table_id = table_id
468 self.prefix = mk_network(dest_addr, dest_addr_len)
469 self.register = register
470 self.stats_index = None
471 self.modified = False
473 self.encoded_paths = []
474 for path in self.paths:
475 self.encoded_paths.append(path.encode())
477 def __eq__(self, other):
478 if self.table_id == other.table_id and \
479 self.prefix == other.prefix:
483 def modify(self, paths):
485 self.encoded_paths = []
486 for path in self.paths:
487 self.encoded_paths.append(path.encode())
490 self._test.vapi.ip_route_add_del(route={'table_id': self.table_id,
491 'prefix': self.prefix,
494 'paths': self.encoded_paths,
499 def add_vpp_config(self):
500 r = self._test.vapi.ip_route_add_del(
501 route={'table_id': self.table_id,
502 'prefix': self.prefix,
503 'n_paths': len(self.encoded_paths),
504 'paths': self.encoded_paths,
508 self.stats_index = r.stats_index
510 self._test.registry.register(self, self._test.logger)
513 def remove_vpp_config(self):
514 # there's no need to issue different deletes for modified routes
515 # we do this only to test the two different ways to delete routes
516 # eiter by passing all the paths to remove and mutlipath=1 or
517 # passing no paths and multipath=0
519 self._test.vapi.ip_route_add_del(
520 route={'table_id': self.table_id,
521 'prefix': self.prefix,
524 'paths': self.encoded_paths},
528 self._test.vapi.ip_route_add_del(
529 route={'table_id': self.table_id,
530 'prefix': self.prefix,
535 def query_vpp_config(self):
536 return find_route(self._test,
537 self.prefix.network_address,
538 self.prefix.prefixlen,
542 return ("%s:table-%d-%s" % (
543 'ip6-route' if self.prefix.version == 6 else 'ip-route',
547 def get_stats_to(self):
548 c = self._test.statistics.get_counter("/net/route/to")
549 return c[0][self.stats_index]
551 def get_stats_via(self):
552 c = self._test.statistics.get_counter("/net/route/via")
553 return c[0][self.stats_index]
556 class VppIpMRoute(VppObject):
561 def __init__(self, test, src_addr, grp_addr,
562 grp_addr_len, e_flags, paths, table_id=0,
566 self.table_id = table_id
567 self.e_flags = e_flags
570 self.prefix = VppIpMPrefix(src_addr, grp_addr, grp_addr_len)
571 self.encoded_paths = []
572 for path in self.paths:
573 self.encoded_paths.append(path.encode())
575 def add_vpp_config(self):
576 r = self._test.vapi.ip_mroute_add_del(self.table_id,
577 self.prefix.encode(),
582 self.stats_index = r.stats_index
583 self._test.registry.register(self, self._test.logger)
586 def remove_vpp_config(self):
587 self._test.vapi.ip_mroute_add_del(self.table_id,
588 self.prefix.encode(),
594 def update_entry_flags(self, flags):
596 self._test.vapi.ip_mroute_add_del(self.table_id,
597 self.prefix.encode(),
603 def update_rpf_id(self, rpf_id):
605 self._test.vapi.ip_mroute_add_del(self.table_id,
606 self.prefix.encode(),
612 def update_path_flags(self, itf, flags):
613 for p in range(len(self.paths)):
614 if self.paths[p].nh_itf == itf:
615 self.paths[p].nh_i_flags = flags
616 self.encoded_paths[p] = self.paths[p].encode()
619 self._test.vapi.ip_mroute_add_del(self.table_id,
620 self.prefix.encode(),
623 [self.encoded_paths[p]],
627 def query_vpp_config(self):
628 return find_mroute(self._test,
635 return ("%d:(%s,%s/%d)" % (self.table_id,
641 c = self._test.statistics.get_counter("/net/mroute")
642 return c[0][self.stats_index]
645 class VppMFibSignal(object):
646 def __init__(self, test, route, interface, packet):
648 self.interface = interface
652 def compare(self, signal):
653 self.test.assertEqual(self.interface, signal.sw_if_index)
654 self.test.assertEqual(self.route.table_id, signal.table_id)
655 self.test.assertEqual(self.route.prefix, signal.prefix)
658 class VppMplsIpBind(VppObject):
663 def __init__(self, test, local_label, dest_addr, dest_addr_len,
664 table_id=0, ip_table_id=0, is_ip6=0):
666 self.dest_addr_len = dest_addr_len
667 self.dest_addr = dest_addr
668 self.ip_addr = ip_address(text_type(dest_addr))
669 self.local_label = local_label
670 self.table_id = table_id
671 self.ip_table_id = ip_table_id
672 self.prefix = mk_network(dest_addr, dest_addr_len)
674 def add_vpp_config(self):
675 self._test.vapi.mpls_ip_bind_unbind(self.local_label,
677 table_id=self.table_id,
678 ip_table_id=self.ip_table_id)
679 self._test.registry.register(self, self._test.logger)
681 def remove_vpp_config(self):
682 self._test.vapi.mpls_ip_bind_unbind(self.local_label,
684 table_id=self.table_id,
685 ip_table_id=self.ip_table_id,
688 def query_vpp_config(self):
689 dump = self._test.vapi.mpls_route_dump(self.table_id)
691 if self.local_label == e.mr_route.mr_label \
692 and self.table_id == e.mr_route.mr_table_id:
697 return ("%d:%s binds %d:%s/%d"
705 class VppMplsTable(VppObject):
711 self.table_id = table_id
713 def add_vpp_config(self):
714 self._test.vapi.mpls_table_add_del(
717 self._test.registry.register(self, self._test.logger)
719 def remove_vpp_config(self):
720 self._test.vapi.mpls_table_add_del(
724 def query_vpp_config(self):
725 dump = self._test.vapi.mpls_table_dump()
727 if d.mt_table.mt_table_id == self.table_id:
732 return ("table-mpls-%d" % (self.table_id))
735 class VppMplsRoute(VppObject):
740 def __init__(self, test, local_label, eos_bit, paths, table_id=0,
742 eos_proto=FibPathProto.FIB_PATH_NH_PROTO_IP4):
745 self.local_label = local_label
746 self.eos_bit = eos_bit
747 self.eos_proto = eos_proto
748 self.table_id = table_id
749 self.is_multicast = is_multicast
751 def add_vpp_config(self):
753 for path in self.paths:
754 paths.append(path.encode())
756 r = self._test.vapi.mpls_route_add_del(self.table_id,
762 self.stats_index = r.stats_index
763 self._test.registry.register(self, self._test.logger)
765 def remove_vpp_config(self):
767 for path in self.paths:
768 paths.append(path.encode())
770 self._test.vapi.mpls_route_add_del(self.table_id,
777 def query_vpp_config(self):
778 return find_mpls_route(self._test, self.table_id,
779 self.local_label, self.eos_bit)
782 return ("mpls-route-%d:%s/%d"
787 def get_stats_to(self):
788 c = self._test.statistics.get_counter("/net/route/to")
789 return c[0][self.stats_index]
791 def get_stats_via(self):
792 c = self._test.statistics.get_counter("/net/route/via")
793 return c[0][self.stats_index]