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
74 def ip_to_dpo_proto(addr):
76 return DpoProto.DPO_PROTO_IP6
78 return DpoProto.DPO_PROTO_IP4
81 def address_proto(ip_addr):
82 if ip_addr.ip_addr.version is 4:
83 return FibPathProto.FIB_PATH_NH_PROTO_IP4
85 return FibPathProto.FIB_PATH_NH_PROTO_IP6
88 def find_route(test, addr, len, table_id=0):
89 ip_addr = ip_address(text_type(addr))
91 if 4 is ip_addr.version:
92 routes = test.vapi.ip_route_dump(table_id, False)
93 prefix = IPv4Network("%s/%d" % (text_type(addr), len), strict=False)
95 routes = test.vapi.ip_route_dump(table_id, True)
96 prefix = IPv6Network("%s/%d" % (text_type(addr), len), strict=False)
99 if table_id == e.route.table_id \
100 and prefix == e.route.prefix:
105 def find_mroute(test, grp_addr, src_addr, grp_addr_len,
107 ip_mprefix = VppIpMPrefix(text_type(src_addr),
111 if 4 is ip_mprefix.version:
112 routes = test.vapi.ip_mroute_dump(table_id, False)
114 routes = test.vapi.ip_mroute_dump(table_id, True)
117 if table_id == e.route.table_id and ip_mprefix == e.route.prefix:
122 def find_mpls_route(test, table_id, label, eos_bit, paths=None):
123 dump = test.vapi.mpls_route_dump(table_id)
125 if label == e.mr_route.mr_label \
126 and eos_bit == e.mr_route.mr_eos \
127 and table_id == e.mr_route.mr_table_id:
131 if (len(paths) != len(e.mr_route.mr_paths)):
133 for i in range(len(paths)):
134 if (paths[i] != e.mr_route.mr_paths[i]):
140 def fib_interface_ip_prefix(test, address, length, sw_if_index):
141 ip_addr = ip_address(text_type(address))
143 if 4 is ip_addr.version:
144 addrs = test.vapi.ip_address_dump(sw_if_index)
145 prefix = IPv4Network("%s/%d" % (text_type(address), length),
148 addrs = test.vapi.ip_address_dump(sw_if_index, is_ipv6=1)
149 prefix = IPv6Network("%s/%d" % (text_type(address), length),
152 # TODO: refactor this to VppIpPrefix.__eq__
154 if a.sw_if_index == sw_if_index and \
160 class VppIpTable(VppObject):
167 self.table_id = table_id
170 def add_vpp_config(self):
171 self._test.vapi.ip_table_add_del(is_ipv6=self.is_ip6, is_add=1,
172 table_id=self.table_id)
173 self._test.registry.register(self, self._test.logger)
175 def remove_vpp_config(self):
176 self._test.vapi.ip_table_add_del(is_ipv6=self.is_ip6, is_add=0,
177 table_id=self.table_id)
179 def query_vpp_config(self):
180 if self.table_id == 0:
181 # the default table always exists
183 # find the default route
184 return find_route(self._test,
185 "::" if self.is_ip6 else "0.0.0.0",
190 return ("table-%s-%d" %
191 ("v6" if self.is_ip6 == 1 else "v4",
195 class VppIpInterfaceAddress(VppObject):
197 def __init__(self, test, intf, addr, len):
200 self.prefix = VppIpPrefix(addr, len)
202 def add_vpp_config(self):
203 self._test.vapi.sw_interface_add_del_address(
204 sw_if_index=self.intf.sw_if_index, address=self.prefix.bytes,
205 address_length=self.prefix.length, is_ipv6=self.prefix.is_ip6,
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, address=self.prefix.bytes,
212 address_length=self.prefix.length, is_ipv6=self.prefix.is_ip6,
215 def query_vpp_config(self):
216 return fib_interface_ip_prefix(self._test,
219 self.intf.sw_if_index)
222 return "interface-ip-%s-%s" % (self.intf, self.prefix)
225 class VppIpInterfaceBind(VppObject):
227 def __init__(self, test, intf, table):
232 def add_vpp_config(self):
233 if self.table.is_ip6:
234 self.intf.set_table_ip6(self.table.table_id)
236 self.intf.set_table_ip4(self.table.table_id)
237 self._test.registry.register(self, self._test.logger)
239 def remove_vpp_config(self):
240 if 0 == self.table.table_id:
242 if self.table.is_ip6:
243 self.intf.set_table_ip6(0)
245 self.intf.set_table_ip4(0)
247 def query_vpp_config(self):
248 if 0 == self.table.table_id:
250 return self._test.vapi.sw_interface_get_table(
251 self.intf.sw_if_index,
252 self.table.is_ip6).vrf_id == self.table.table_id
255 return "interface-bind-%s-%s" % (self.intf, self.table)
258 class VppMplsLabel(object):
259 def __init__(self, value, mode=MplsLspMode.PIPE, ttl=64, exp=0):
266 is_uniform = 0 if self.mode is MplsLspMode.PIPE else 1
267 return {'label': self.value,
270 'is_uniform': is_uniform}
272 def __eq__(self, other):
273 if isinstance(other, self.__class__):
274 return (self.value == other.value and
275 self.ttl == other.ttl and
276 self.exp == other.exp and
277 self.mode == other.mode)
278 elif hasattr(other, 'label'):
279 return (self.value == other.label and
280 self.ttl == other.ttl and
281 self.exp == other.exp and
282 (self.mode == MplsLspMode.UNIFORM) == other.is_uniform)
286 def __ne__(self, other):
287 return not (self == other)
290 class VppFibPathNextHop(object):
291 def __init__(self, addr,
292 via_label=MPLS_LABEL_INVALID,
293 next_hop_id=INVALID_INDEX):
294 self.addr = VppIpAddressUnion(addr)
295 self.via_label = via_label
296 self.obj_id = next_hop_id
299 if self.via_label is not MPLS_LABEL_INVALID:
300 return {'via_label': self.via_label}
301 if self.obj_id is not INVALID_INDEX:
302 return {'obj_id': self.obj_id}
304 return {'address': self.addr.encode()}
307 if self.via_label is MPLS_LABEL_INVALID:
308 return address_proto(self.addr)
310 return FibPathProto.FIB_PATH_NH_PROTO_MPLS
312 def __eq__(self, other):
313 if not isinstance(other, self.__class__):
314 # try the other instance's __eq__.
315 return NotImplemented
316 return (self.addr == other.addr and
317 self.via_label == other.via_label and
318 self.obj_id == other.obj_id)
321 class VppRoutePath(object):
329 nh_via_label=MPLS_LABEL_INVALID,
331 next_hop_id=INVALID_INDEX,
333 flags=FibPathFlags.FIB_PATH_FLAG_NONE,
334 type=FibPathType.FIB_PATH_TYPE_NORMAL):
335 self.nh_itf = nh_sw_if_index
336 self.nh_table_id = nh_table_id
337 self.nh_labels = labels
343 self.nh = VppFibPathNextHop(nh_addr, nh_via_label, next_hop_id)
345 self.proto = self.nh.proto()
348 self.next_hop_id = next_hop_id
350 def encode_labels(self):
352 for l in self.nh_labels:
353 if type(l) == VppMplsLabel:
354 lstack.append(l.encode())
356 lstack.append({'label': l,
358 while (len(lstack) < 16):
366 'table_id': self.nh_table_id,
367 'nh': self.nh.encode(),
368 'next_hop_id': self.next_hop_id,
369 'sw_if_index': self.nh_itf,
370 'rpf_id': self.rpf_id,
374 'n_labels': len(self.nh_labels),
375 'label_stack': self.encode_labels()}
377 def __eq__(self, other):
378 if isinstance(other, self.__class__):
379 return self.nh == other.nh
380 elif hasattr(other, 'sw_if_index'):
382 if (len(self.nh_labels) != other.n_labels):
384 for i in range(len(self.nh_labels)):
385 if (self.nh_labels[i] != other.label_stack[i]):
387 return self.nh_itf == other.sw_if_index
391 def __ne__(self, other):
392 return not (self == other)
395 class VppMRoutePath(VppRoutePath):
397 def __init__(self, nh_sw_if_index, flags,
399 proto=FibPathProto.FIB_PATH_NH_PROTO_IP4,
400 type=FibPathType.FIB_PATH_TYPE_NORMAL,
401 bier_imp=INVALID_INDEX):
403 nh = "::" if proto is FibPathProto.FIB_PATH_NH_PROTO_IP6 \
405 super(VppMRoutePath, self).__init__(nh,
409 next_hop_id=bier_imp)
410 self.nh_i_flags = flags
411 self.bier_imp = bier_imp
414 return {'path': super(VppMRoutePath, self).encode(),
415 'itf_flags': self.nh_i_flags}
418 class VppIpRoute(VppObject):
423 def __init__(self, test, dest_addr,
424 dest_addr_len, paths, table_id=0, register=True):
427 self.table_id = table_id
428 self.prefix = VppIpPrefix(dest_addr, dest_addr_len)
429 self.register = register
430 self.stats_index = None
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())
448 self._test.vapi.ip_route_add_del(route={'table_id': self.table_id,
449 'prefix': self.prefix.encode(),
452 'paths': self.encoded_paths,
457 def add_vpp_config(self):
458 r = self._test.vapi.ip_route_add_del(
459 route={'table_id': self.table_id,
460 'prefix': self.prefix.encode(),
461 'n_paths': len(self.encoded_paths),
462 'paths': self.encoded_paths,
466 self.stats_index = r.stats_index
468 self._test.registry.register(self, self._test.logger)
470 def remove_vpp_config(self):
471 self._test.vapi.ip_route_add_del(route={'table_id': self.table_id,
472 'prefix': self.prefix.encode(),
475 'paths': self.encoded_paths,
480 def query_vpp_config(self):
481 return find_route(self._test,
487 return ("%s:table-%d-%s/%d" % (
488 'ip6-route' if self.prefix.addr.version == 6 else 'ip-route',
493 def get_stats_to(self):
494 c = self._test.statistics.get_counter("/net/route/to")
495 return c[0][self.stats_index]
497 def get_stats_via(self):
498 c = self._test.statistics.get_counter("/net/route/via")
499 return c[0][self.stats_index]
502 class VppIpMRoute(VppObject):
507 def __init__(self, test, src_addr, grp_addr,
508 grp_addr_len, e_flags, paths, table_id=0,
512 self.table_id = table_id
513 self.e_flags = e_flags
516 self.prefix = VppIpMPrefix(src_addr, grp_addr, grp_addr_len)
517 self.encoded_paths = []
518 for path in self.paths:
519 self.encoded_paths.append(path.encode())
521 def add_vpp_config(self):
522 r = self._test.vapi.ip_mroute_add_del(self.table_id,
523 self.prefix.encode(),
528 self.stats_index = r.stats_index
529 self._test.registry.register(self, self._test.logger)
531 def remove_vpp_config(self):
532 self._test.vapi.ip_mroute_add_del(self.table_id,
533 self.prefix.encode(),
539 def update_entry_flags(self, flags):
541 self._test.vapi.ip_mroute_add_del(self.table_id,
542 self.prefix.encode(),
548 def update_rpf_id(self, rpf_id):
550 self._test.vapi.ip_mroute_add_del(self.table_id,
551 self.prefix.encode(),
557 def update_path_flags(self, itf, flags):
558 for p in range(len(self.paths)):
559 if self.paths[p].nh_itf == itf:
560 self.paths[p].nh_i_flags = flags
561 self.encoded_paths[p] = self.paths[p].encode()
564 self._test.vapi.ip_mroute_add_del(self.table_id,
565 self.prefix.encode(),
568 [self.encoded_paths[p]],
572 def query_vpp_config(self):
573 return find_mroute(self._test,
580 return ("%d:(%s,%s/%d)" % (self.table_id,
586 c = self._test.statistics.get_counter("/net/mroute")
587 return c[0][self.stats_index]
590 class VppMFibSignal(object):
591 def __init__(self, test, route, interface, packet):
593 self.interface = interface
597 def compare(self, signal):
598 self.test.assertEqual(self.interface, signal.sw_if_index)
599 self.test.assertEqual(self.route.table_id, signal.table_id)
600 self.test.assertEqual(self.route.prefix, signal.prefix)
603 class VppMplsIpBind(VppObject):
608 def __init__(self, test, local_label, dest_addr, dest_addr_len,
609 table_id=0, ip_table_id=0, is_ip6=0):
611 self.dest_addr_len = dest_addr_len
612 self.dest_addr = dest_addr
613 self.ip_addr = ip_address(text_type(dest_addr))
614 self.local_label = local_label
615 self.table_id = table_id
616 self.ip_table_id = ip_table_id
617 self.prefix = VppIpPrefix(dest_addr, dest_addr_len)
619 def add_vpp_config(self):
620 self._test.vapi.mpls_ip_bind_unbind(self.local_label,
621 self.prefix.encode(),
622 table_id=self.table_id,
623 ip_table_id=self.ip_table_id)
624 self._test.registry.register(self, self._test.logger)
626 def remove_vpp_config(self):
627 self._test.vapi.mpls_ip_bind_unbind(self.local_label,
628 self.prefix.encode(),
629 table_id=self.table_id,
630 ip_table_id=self.ip_table_id,
633 def query_vpp_config(self):
634 dump = self._test.vapi.mpls_route_dump(self.table_id)
636 if self.local_label == e.mr_route.mr_label \
637 and self.table_id == e.mr_route.mr_table_id:
642 return ("%d:%s binds %d:%s/%d"
650 class VppMplsTable(VppObject):
656 self.table_id = table_id
658 def add_vpp_config(self):
659 self._test.vapi.mpls_table_add_del(
662 self._test.registry.register(self, self._test.logger)
664 def remove_vpp_config(self):
665 self._test.vapi.mpls_table_add_del(
669 def query_vpp_config(self):
670 dump = self._test.vapi.mpls_table_dump()
672 if d.mt_table.mt_table_id == self.table_id:
677 return ("table-mpls-%d" % (self.table_id))
680 class VppMplsRoute(VppObject):
685 def __init__(self, test, local_label, eos_bit, paths, table_id=0,
687 eos_proto=FibPathProto.FIB_PATH_NH_PROTO_IP4):
690 self.local_label = local_label
691 self.eos_bit = eos_bit
692 self.eos_proto = eos_proto
693 self.table_id = table_id
694 self.is_multicast = is_multicast
696 def add_vpp_config(self):
698 for path in self.paths:
699 paths.append(path.encode())
701 r = self._test.vapi.mpls_route_add_del(self.table_id,
707 self.stats_index = r.stats_index
708 self._test.registry.register(self, self._test.logger)
710 def remove_vpp_config(self):
712 for path in self.paths:
713 paths.append(path.encode())
715 self._test.vapi.mpls_route_add_del(self.table_id,
722 def query_vpp_config(self):
723 return find_mpls_route(self._test, self.table_id,
724 self.local_label, self.eos_bit)
727 return ("mpls-route-%d:%s/%d"
732 def get_stats_to(self):
733 c = self._test.statistics.get_counter("/net/route/to")
734 return c[0][self.stats_index]
736 def get_stats_via(self):
737 c = self._test.statistics.get_counter("/net/route/via")
738 return c[0][self.stats_index]