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
11 # from vnet/vnet/mpls/mpls_types.h
12 MPLS_IETF_MAX_LABEL = 0xfffff
13 MPLS_LABEL_INVALID = MPLS_IETF_MAX_LABEL + 1
17 MFIB_ITF_FLAG_NONE = 0
18 MFIB_ITF_FLAG_NEGATE_SIGNAL = 1
19 MFIB_ITF_FLAG_ACCEPT = 2
20 MFIB_ITF_FLAG_FORWARD = 4
21 MFIB_ITF_FLAG_SIGNAL_PRESENT = 8
22 MFIB_ITF_FLAG_INTERNAL_COPY = 16
25 class MRouteEntryFlags:
26 MFIB_ENTRY_FLAG_NONE = 0
27 MFIB_ENTRY_FLAG_SIGNAL = 1
28 MFIB_ENTRY_FLAG_DROP = 2
29 MFIB_ENTRY_FLAG_CONNECTED = 4
30 MFIB_ENTRY_FLAG_INHERIT_ACCEPT = 8
38 def ip_to_dpo_proto(addr):
40 return DpoProto.DPO_PROTO_IP6
42 return DpoProto.DPO_PROTO_IP4
45 def find_route(test, ip_addr, len, table_id=0, inet=AF_INET):
48 routes = test.vapi.ip_fib_dump()
51 routes = test.vapi.ip6_fib_dump()
53 route_addr = inet_pton(inet, ip_addr)
55 if route_addr == e.address[:s] \
56 and len == e.address_length \
57 and table_id == e.table_id:
62 def find_mroute(test, grp_addr, src_addr, grp_addr_len,
63 table_id=0, inet=AF_INET):
66 routes = test.vapi.ip_mfib_dump()
69 routes = test.vapi.ip6_mfib_dump()
70 gaddr = inet_pton(inet, grp_addr)
71 saddr = inet_pton(inet, src_addr)
73 if gaddr == e.grp_address[:s] \
74 and grp_addr_len == e.address_length \
75 and saddr == e.src_address[:s] \
76 and table_id == e.table_id:
81 def find_mpls_route(test, table_id, label, eos_bit, paths=None):
82 dump = test.vapi.mpls_fib_dump()
85 and eos_bit == e.eos_bit \
86 and table_id == e.table_id:
90 if (len(paths) != len(e.path)):
92 for i in range(len(paths)):
93 if (paths[i] != e.path[i]):
99 def fib_interface_ip_prefix(test, address, length, sw_if_index):
100 vp = VppIpPrefix(address, length)
101 addrs = test.vapi.ip_address_dump(sw_if_index, is_ipv6=vp.is_ip6)
109 if a.prefix_length == length and \
110 a.sw_if_index == sw_if_index and \
111 a.ip[:n] == vp.bytes:
116 class VppIpTable(VppObject):
123 self.table_id = table_id
126 def add_vpp_config(self):
127 self._test.vapi.ip_table_add_del(
131 self._test.registry.register(self, self._test.logger)
133 def remove_vpp_config(self):
134 self._test.vapi.ip_table_add_del(
139 def query_vpp_config(self):
140 if self.table_id == 0:
141 # the default table always exists
143 # find the default route
144 return find_route(self._test,
145 "::" if self.is_ip6 else "0.0.0.0",
148 inet=AF_INET6 if self.is_ip6 == 1 else AF_INET)
151 return self.object_id()
154 return ("table-%s-%d" %
155 ("v6" if self.is_ip6 == 1 else "v4",
159 class VppIpInterfaceAddress(VppObject):
161 def __init__(self, test, intf, addr, len):
164 self.prefix = VppIpPrefix(addr, len)
166 def add_vpp_config(self):
167 self._test.vapi.sw_interface_add_del_address(
168 self.intf.sw_if_index,
172 is_ipv6=self.prefix.is_ip6)
173 self._test.registry.register(self, self._test.logger)
175 def remove_vpp_config(self):
176 self._test.vapi.sw_interface_add_del_address(
177 self.intf.sw_if_index,
181 is_ipv6=self.prefix.is_ip6)
183 def query_vpp_config(self):
184 return fib_interface_ip_prefix(self._test,
187 self.intf.sw_if_index)
190 return self.object_id()
193 return "interface-ip-%s-%s" % (self.intf, self.prefix)
196 class VppIpInterfaceBind(VppObject):
198 def __init__(self, test, intf, table):
203 def add_vpp_config(self):
204 if self.table.is_ip6:
205 self.intf.set_table_ip6(self.table.table_id)
207 self.intf.set_table_ip4(self.table.table_id)
208 self._test.registry.register(self, self._test.logger)
210 def remove_vpp_config(self):
211 if 0 == self.table.table_id:
213 if self.table.is_ip6:
214 self.intf.set_table_ip6(0)
216 self.intf.set_table_ip4(0)
218 def query_vpp_config(self):
219 if 0 == self.table.table_id:
221 return self._test.vapi.sw_interface_get_table(
222 self.intf.sw_if_index,
223 self.table.is_ip6).vrf_id == self.table.table_id
226 return self.object_id()
229 return "interface-bind-%s-%s" % (self.intf, self.table)
232 class VppMplsLabel(object):
233 def __init__(self, value, mode=MplsLspMode.PIPE, ttl=64, exp=0):
240 is_uniform = 0 if self.mode is MplsLspMode.PIPE else 1
241 return {'label': self.value,
244 'is_uniform': is_uniform}
246 def __eq__(self, other):
247 if isinstance(other, self.__class__):
248 return (self.value == other.value and
249 self.ttl == other.ttl and
250 self.exp == other.exp and
251 self.mode == other.mode)
252 elif hasattr(other, 'label'):
253 return (self.value == other.label and
254 self.ttl == other.ttl and
255 self.exp == other.exp and
256 (self.mode == MplsLspMode.UNIFORM) == other.is_uniform)
260 def __ne__(self, other):
261 return not (self == other)
264 class VppRoutePath(object):
272 nh_via_label=MPLS_LABEL_INVALID,
276 is_resolve_attached=0,
280 next_hop_id=0xffffffff,
281 proto=DpoProto.DPO_PROTO_IP4):
283 self.nh_itf = nh_sw_if_index
284 self.nh_table_id = nh_table_id
285 self.nh_via_label = nh_via_label
286 self.nh_labels = labels
289 if self.proto is DpoProto.DPO_PROTO_IP6:
290 self.nh_addr = inet_pton(AF_INET6, nh_addr)
291 elif self.proto is DpoProto.DPO_PROTO_IP4:
292 self.nh_addr = inet_pton(AF_INET, nh_addr)
294 self.nh_addr = inet_pton(AF_INET6, "::")
295 self.is_resolve_host = is_resolve_host
296 self.is_resolve_attached = is_resolve_attached
297 self.is_interface_rx = is_interface_rx
298 self.is_source_lookup = is_source_lookup
303 self.is_udp_encap = is_udp_encap
304 self.next_hop_id = next_hop_id
307 def encode_labels(self):
309 for l in self.nh_labels:
310 if type(l) == VppMplsLabel:
311 lstack.append(l.encode())
313 lstack.append({'label': l,
318 return {'next_hop': self.nh_addr,
321 'table_id': self.nh_table_id,
322 'next_hop_id': self.next_hop_id,
323 'sw_if_index': self.nh_itf,
325 'is_udp_encap': self.is_udp_encap,
326 'n_labels': len(self.nh_labels),
327 'label_stack': self.encode_labels()}
329 def __eq__(self, other):
330 if isinstance(other, self.__class__):
331 return self.nh_addr == other.nh_addr
332 elif hasattr(other, 'sw_if_index'):
334 if (len(self.nh_labels) != other.n_labels):
336 for i in range(len(self.nh_labels)):
337 if (self.nh_labels[i] != other.label_stack[i]):
339 return self.nh_itf == other.sw_if_index
343 def __ne__(self, other):
344 return not (self == other)
347 class VppMRoutePath(VppRoutePath):
349 def __init__(self, nh_sw_if_index, flags,
351 proto=DpoProto.DPO_PROTO_IP4,
354 nh = "::" if proto is DpoProto.DPO_PROTO_IP6 else "0.0.0.0"
355 super(VppMRoutePath, self).__init__(nh,
358 self.nh_i_flags = flags
359 self.bier_imp = bier_imp
362 class VppIpRoute(VppObject):
367 def __init__(self, test, dest_addr,
368 dest_addr_len, paths, table_id=0, is_ip6=0, is_local=0,
369 is_unreach=0, is_prohibit=0, is_drop=0):
372 self.dest_addr_len = dest_addr_len
373 self.table_id = table_id
375 self.is_local = is_local
376 self.is_unreach = is_unreach
377 self.is_prohibit = is_prohibit
378 self.is_drop = is_drop
379 self.dest_addr_p = dest_addr
381 self.dest_addr = inet_pton(AF_INET6, dest_addr)
383 self.dest_addr = inet_pton(AF_INET, dest_addr)
385 def modify(self, paths, is_local=0,
386 is_unreach=0, is_prohibit=0):
388 self.is_local = is_local
389 self.is_unreach = is_unreach
390 self.is_prohibit = is_prohibit
392 def add_vpp_config(self):
393 if self.is_unreach or self.is_prohibit or self.is_drop:
394 r = self._test.vapi.ip_add_del_route(
397 inet_pton(AF_INET6, "::"),
399 is_local=self.is_local,
400 is_unreach=self.is_unreach,
401 is_prohibit=self.is_prohibit,
402 is_drop=self.is_drop,
403 table_id=self.table_id,
406 for path in self.paths:
407 lstack = path.encode_labels()
409 r = self._test.vapi.ip_add_del_route(
414 table_id=self.table_id,
415 next_hop_out_label_stack=lstack,
416 next_hop_n_out_labels=len(lstack),
417 next_hop_via_label=path.nh_via_label,
418 next_hop_table_id=path.nh_table_id,
419 next_hop_id=path.next_hop_id,
422 is_local=self.is_local,
423 is_resolve_host=path.is_resolve_host,
424 is_resolve_attached=path.is_resolve_attached,
425 is_source_lookup=path.is_source_lookup,
426 is_udp_encap=path.is_udp_encap,
427 is_multipath=1 if len(self.paths) > 1 else 0)
428 self.stats_index = r.stats_index
429 self._test.registry.register(self, self._test.logger)
431 def remove_vpp_config(self):
432 if self.is_unreach or self.is_prohibit or self.is_drop:
433 self._test.vapi.ip_add_del_route(
436 inet_pton(AF_INET6, "::"),
438 is_local=self.is_local,
439 is_unreach=self.is_unreach,
440 is_prohibit=self.is_prohibit,
442 table_id=self.table_id,
445 for path in self.paths:
446 self._test.vapi.ip_add_del_route(
451 table_id=self.table_id,
452 next_hop_table_id=path.nh_table_id,
453 next_hop_via_label=path.nh_via_label,
454 next_hop_id=path.next_hop_id,
456 is_udp_encap=path.is_udp_encap,
460 def query_vpp_config(self):
461 return find_route(self._test,
465 inet=AF_INET6 if self.is_ip6 == 1 else AF_INET)
468 return self.object_id()
476 def get_stats_to(self):
477 c = self._test.statistics.get_counter("/net/route/to")
478 return c[0][self.stats_index]
480 def get_stats_via(self):
481 c = self._test.statistics.get_counter("/net/route/via")
482 return c[0][self.stats_index]
485 class VppIpMRoute(VppObject):
490 def __init__(self, test, src_addr, grp_addr,
491 grp_addr_len, e_flags, paths, table_id=0,
495 self.grp_addr_len = grp_addr_len
496 self.table_id = table_id
497 self.e_flags = e_flags
501 self.grp_addr_p = grp_addr
502 self.src_addr_p = src_addr
504 self.grp_addr = inet_pton(AF_INET6, grp_addr)
505 self.src_addr = inet_pton(AF_INET6, src_addr)
507 self.grp_addr = inet_pton(AF_INET, grp_addr)
508 self.src_addr = inet_pton(AF_INET, src_addr)
510 def add_vpp_config(self):
511 for path in self.paths:
512 r = self._test.vapi.ip_mroute_add_del(self.src_addr,
520 bier_imp=path.bier_imp,
522 table_id=self.table_id,
524 self.stats_index = r.stats_index
525 self._test.registry.register(self, self._test.logger)
527 def remove_vpp_config(self):
528 for path in self.paths:
529 self._test.vapi.ip_mroute_add_del(self.src_addr,
537 table_id=self.table_id,
538 bier_imp=path.bier_imp,
542 def update_entry_flags(self, flags):
544 self._test.vapi.ip_mroute_add_del(self.src_addr,
552 table_id=self.table_id,
555 def update_rpf_id(self, rpf_id):
557 self._test.vapi.ip_mroute_add_del(self.src_addr,
566 table_id=self.table_id,
569 def update_path_flags(self, itf, flags):
570 for path in self.paths:
571 if path.nh_itf == itf:
572 path.nh_i_flags = flags
574 self._test.vapi.ip_mroute_add_del(self.src_addr,
582 table_id=self.table_id,
585 def query_vpp_config(self):
586 return find_mroute(self._test,
591 inet=AF_INET6 if self.is_ip6 == 1 else AF_INET)
594 return self.object_id()
598 return ("%d:(%s,%s/%d)"
600 inet_ntop(AF_INET6, self.src_addr),
601 inet_ntop(AF_INET6, self.grp_addr),
604 return ("%d:(%s,%s/%d)"
606 inet_ntop(AF_INET, self.src_addr),
607 inet_ntop(AF_INET, self.grp_addr),
611 c = self._test.statistics.get_counter("/net/mroute")
612 return c[0][self.stats_index]
615 class VppMFibSignal(object):
616 def __init__(self, test, route, interface, packet):
618 self.interface = interface
622 def compare(self, signal):
623 self.test.assertEqual(self.interface, signal.sw_if_index)
624 self.test.assertEqual(self.route.table_id, signal.table_id)
625 self.test.assertEqual(self.route.grp_addr_len,
626 signal.grp_address_len)
627 for i in range(self.route.grp_addr_len / 8):
628 self.test.assertEqual(self.route.grp_addr[i],
629 signal.grp_address[i])
630 if (self.route.grp_addr_len > 32):
632 self.test.assertEqual(self.route.src_addr[i],
633 signal.src_address[i])
636 class VppMplsIpBind(VppObject):
641 def __init__(self, test, local_label, dest_addr, dest_addr_len,
642 table_id=0, ip_table_id=0, is_ip6=0):
644 self.dest_addr_len = dest_addr_len
645 self.dest_addr = dest_addr
646 self.local_label = local_label
647 self.table_id = table_id
648 self.ip_table_id = ip_table_id
651 self.dest_addrn = inet_pton(AF_INET6, dest_addr)
653 self.dest_addrn = inet_pton(AF_INET, dest_addr)
655 def add_vpp_config(self):
656 self._test.vapi.mpls_ip_bind_unbind(self.local_label,
659 table_id=self.table_id,
660 ip_table_id=self.ip_table_id,
661 is_ip4=(self.is_ip6 == 0))
662 self._test.registry.register(self, self._test.logger)
664 def remove_vpp_config(self):
665 self._test.vapi.mpls_ip_bind_unbind(self.local_label,
668 table_id=self.table_id,
669 ip_table_id=self.ip_table_id,
671 is_ip4=(self.is_ip6 == 0))
673 def query_vpp_config(self):
674 dump = self._test.vapi.mpls_fib_dump()
676 if self.local_label == e.label \
677 and self.table_id == e.table_id:
682 return self.object_id()
685 return ("%d:%s binds %d:%s/%d"
693 class VppMplsTable(VppObject):
699 self.table_id = table_id
701 def add_vpp_config(self):
702 self._test.vapi.mpls_table_add_del(
705 self._test.registry.register(self, self._test.logger)
707 def remove_vpp_config(self):
708 self._test.vapi.mpls_table_add_del(
712 def query_vpp_config(self):
713 # find the default route
714 dump = self._test.vapi.mpls_fib_dump()
720 return self.object_id()
723 return ("table-mpls-%d" % (self.table_id))
726 class VppMplsRoute(VppObject):
731 def __init__(self, test, local_label, eos_bit, paths, table_id=0,
735 self.local_label = local_label
736 self.eos_bit = eos_bit
737 self.table_id = table_id
738 self.is_multicast = is_multicast
740 def add_vpp_config(self):
741 is_multipath = len(self.paths) > 1
742 for path in self.paths:
743 lstack = path.encode_labels()
745 r = self._test.vapi.mpls_route_add_del(
751 is_multicast=self.is_multicast,
752 is_multipath=is_multipath,
753 table_id=self.table_id,
754 is_interface_rx=path.is_interface_rx,
755 is_rpf_id=path.is_rpf_id,
756 next_hop_out_label_stack=lstack,
757 next_hop_n_out_labels=len(lstack),
758 next_hop_via_label=path.nh_via_label,
759 next_hop_table_id=path.nh_table_id)
760 self.stats_index = r.stats_index
761 self._test.registry.register(self, self._test.logger)
763 def remove_vpp_config(self):
764 for path in self.paths:
765 self._test.vapi.mpls_route_add_del(self.local_label,
770 is_rpf_id=path.is_rpf_id,
771 table_id=self.table_id,
774 def query_vpp_config(self):
775 return find_mpls_route(self._test, self.table_id,
776 self.local_label, self.eos_bit)
779 return self.object_id()
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]