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),
153 if a.sw_if_index == sw_if_index and \
159 class VppIpTable(VppObject):
166 self.table_id = table_id
169 def add_vpp_config(self):
170 self._test.vapi.ip_table_add_del(is_ipv6=self.is_ip6, is_add=1,
171 table_id=self.table_id)
172 self._test.registry.register(self, self._test.logger)
174 def remove_vpp_config(self):
175 self._test.vapi.ip_table_add_del(is_ipv6=self.is_ip6, is_add=0,
176 table_id=self.table_id)
178 def query_vpp_config(self):
179 if self.table_id == 0:
180 # the default table always exists
182 # find the default route
183 return find_route(self._test,
184 "::" if self.is_ip6 else "0.0.0.0",
189 return ("table-%s-%d" %
190 ("v6" if self.is_ip6 == 1 else "v4",
194 class VppIpInterfaceAddress(VppObject):
196 def __init__(self, test, intf, addr, len):
199 self.prefix = VppIpPrefix(addr, len)
201 def add_vpp_config(self):
202 self._test.vapi.sw_interface_add_del_address(
203 sw_if_index=self.intf.sw_if_index, address=self.prefix.bytes,
204 address_length=self.prefix.length, is_ipv6=self.prefix.is_ip6,
206 self._test.registry.register(self, self._test.logger)
208 def remove_vpp_config(self):
209 self._test.vapi.sw_interface_add_del_address(
210 sw_if_index=self.intf.sw_if_index, address=self.prefix.bytes,
211 address_length=self.prefix.length, is_ipv6=self.prefix.is_ip6,
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
430 self.encoded_paths = []
431 for path in self.paths:
432 self.encoded_paths.append(path.encode())
434 def __eq__(self, other):
435 if self.table_id == other.table_id and \
436 self.prefix == other.prefix:
440 def modify(self, paths):
442 self.encoded_paths = []
443 for path in self.paths:
444 self.encoded_paths.append(path.encode())
446 self._test.vapi.ip_route_add_del(route={'table_id': self.table_id,
447 'prefix': self.prefix.encode(),
450 'paths': self.encoded_paths,
455 def add_vpp_config(self):
456 r = self._test.vapi.ip_route_add_del(
457 route={'table_id': self.table_id,
458 'prefix': self.prefix.encode(),
459 'n_paths': len(self.encoded_paths),
460 'paths': self.encoded_paths,
464 self.stats_index = r.stats_index
466 self._test.registry.register(self, self._test.logger)
468 def remove_vpp_config(self):
469 self._test.vapi.ip_route_add_del(route={'table_id': self.table_id,
470 'prefix': self.prefix.encode(),
473 'paths': self.encoded_paths,
478 def query_vpp_config(self):
479 return find_route(self._test,
490 def get_stats_to(self):
491 c = self._test.statistics.get_counter("/net/route/to")
492 return c[0][self.stats_index]
494 def get_stats_via(self):
495 c = self._test.statistics.get_counter("/net/route/via")
496 return c[0][self.stats_index]
499 class VppIpMRoute(VppObject):
504 def __init__(self, test, src_addr, grp_addr,
505 grp_addr_len, e_flags, paths, table_id=0,
509 self.table_id = table_id
510 self.e_flags = e_flags
513 self.prefix = VppIpMPrefix(src_addr, grp_addr, grp_addr_len)
514 self.encoded_paths = []
515 for path in self.paths:
516 self.encoded_paths.append(path.encode())
518 def add_vpp_config(self):
519 r = self._test.vapi.ip_mroute_add_del(self.table_id,
520 self.prefix.encode(),
525 self.stats_index = r.stats_index
526 self._test.registry.register(self, self._test.logger)
528 def remove_vpp_config(self):
529 self._test.vapi.ip_mroute_add_del(self.table_id,
530 self.prefix.encode(),
536 def update_entry_flags(self, flags):
538 self._test.vapi.ip_mroute_add_del(self.table_id,
539 self.prefix.encode(),
545 def update_rpf_id(self, rpf_id):
547 self._test.vapi.ip_mroute_add_del(self.table_id,
548 self.prefix.encode(),
554 def update_path_flags(self, itf, flags):
555 for p in range(len(self.paths)):
556 if self.paths[p].nh_itf == itf:
557 self.paths[p].nh_i_flags = flags
558 self.encoded_paths[p] = self.paths[p].encode()
561 self._test.vapi.ip_mroute_add_del(self.table_id,
562 self.prefix.encode(),
565 [self.encoded_paths[p]],
569 def query_vpp_config(self):
570 return find_mroute(self._test,
577 return ("%d:(%s,%s/%d)" % (self.table_id,
583 c = self._test.statistics.get_counter("/net/mroute")
584 return c[0][self.stats_index]
587 class VppMFibSignal(object):
588 def __init__(self, test, route, interface, packet):
590 self.interface = interface
594 def compare(self, signal):
595 self.test.assertEqual(self.interface, signal.sw_if_index)
596 self.test.assertEqual(self.route.table_id, signal.table_id)
597 self.test.assertEqual(self.route.prefix, signal.prefix)
600 class VppMplsIpBind(VppObject):
605 def __init__(self, test, local_label, dest_addr, dest_addr_len,
606 table_id=0, ip_table_id=0, is_ip6=0):
608 self.dest_addr_len = dest_addr_len
609 self.dest_addr = dest_addr
610 self.ip_addr = ip_address(text_type(dest_addr))
611 self.local_label = local_label
612 self.table_id = table_id
613 self.ip_table_id = ip_table_id
614 self.prefix = VppIpPrefix(dest_addr, dest_addr_len)
616 def add_vpp_config(self):
617 self._test.vapi.mpls_ip_bind_unbind(self.local_label,
618 self.prefix.encode(),
619 table_id=self.table_id,
620 ip_table_id=self.ip_table_id)
621 self._test.registry.register(self, self._test.logger)
623 def remove_vpp_config(self):
624 self._test.vapi.mpls_ip_bind_unbind(self.local_label,
625 self.prefix.encode(),
626 table_id=self.table_id,
627 ip_table_id=self.ip_table_id,
630 def query_vpp_config(self):
631 dump = self._test.vapi.mpls_route_dump(self.table_id)
633 if self.local_label == e.mr_route.mr_label \
634 and self.table_id == e.mr_route.mr_table_id:
639 return ("%d:%s binds %d:%s/%d"
647 class VppMplsTable(VppObject):
653 self.table_id = table_id
655 def add_vpp_config(self):
656 self._test.vapi.mpls_table_add_del(
659 self._test.registry.register(self, self._test.logger)
661 def remove_vpp_config(self):
662 self._test.vapi.mpls_table_add_del(
666 def query_vpp_config(self):
667 dump = self._test.vapi.mpls_table_dump()
669 if d.mt_table.mt_table_id == self.table_id:
674 return ("table-mpls-%d" % (self.table_id))
677 class VppMplsRoute(VppObject):
682 def __init__(self, test, local_label, eos_bit, paths, table_id=0,
684 eos_proto=FibPathProto.FIB_PATH_NH_PROTO_IP4):
687 self.local_label = local_label
688 self.eos_bit = eos_bit
689 self.eos_proto = eos_proto
690 self.table_id = table_id
691 self.is_multicast = is_multicast
693 def add_vpp_config(self):
695 for path in self.paths:
696 paths.append(path.encode())
698 r = self._test.vapi.mpls_route_add_del(self.table_id,
704 self.stats_index = r.stats_index
705 self._test.registry.register(self, self._test.logger)
707 def remove_vpp_config(self):
709 for path in self.paths:
710 paths.append(path.encode())
712 self._test.vapi.mpls_route_add_del(self.table_id,
719 def query_vpp_config(self):
720 return find_mpls_route(self._test, self.table_id,
721 self.local_label, self.eos_bit)
729 def get_stats_to(self):
730 c = self._test.statistics.get_counter("/net/route/to")
731 return c[0][self.stats_index]
733 def get_stats_via(self):
734 c = self._test.statistics.get_counter("/net/route/via")
735 return c[0][self.stats_index]