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(is_ipv6=self.is_ip6, is_add=1,
128 table_id=self.table_id)
129 self._test.registry.register(self, self._test.logger)
131 def remove_vpp_config(self):
132 self._test.vapi.ip_table_add_del(is_ipv6=self.is_ip6, is_add=0,
133 table_id=self.table_id)
135 def query_vpp_config(self):
136 if self.table_id == 0:
137 # the default table always exists
139 # find the default route
140 return find_route(self._test,
141 "::" if self.is_ip6 else "0.0.0.0",
144 inet=AF_INET6 if self.is_ip6 == 1 else AF_INET)
147 return self.object_id()
150 return ("table-%s-%d" %
151 ("v6" if self.is_ip6 == 1 else "v4",
155 class VppIpInterfaceAddress(VppObject):
157 def __init__(self, test, intf, addr, len):
160 self.prefix = VppIpPrefix(addr, len)
162 def add_vpp_config(self):
163 self._test.vapi.sw_interface_add_del_address(
164 sw_if_index=self.intf.sw_if_index, address=self.prefix.bytes,
165 address_length=self.prefix.length, is_ipv6=self.prefix.is_ip6,
167 self._test.registry.register(self, self._test.logger)
169 def remove_vpp_config(self):
170 self._test.vapi.sw_interface_add_del_address(
171 sw_if_index=self.intf.sw_if_index, address=self.prefix.bytes,
172 address_length=self.prefix.length, is_ipv6=self.prefix.is_ip6,
175 def query_vpp_config(self):
176 return fib_interface_ip_prefix(self._test,
179 self.intf.sw_if_index)
182 return self.object_id()
185 return "interface-ip-%s-%s" % (self.intf, self.prefix)
188 class VppIpInterfaceBind(VppObject):
190 def __init__(self, test, intf, table):
195 def add_vpp_config(self):
196 if self.table.is_ip6:
197 self.intf.set_table_ip6(self.table.table_id)
199 self.intf.set_table_ip4(self.table.table_id)
200 self._test.registry.register(self, self._test.logger)
202 def remove_vpp_config(self):
203 if 0 == self.table.table_id:
205 if self.table.is_ip6:
206 self.intf.set_table_ip6(0)
208 self.intf.set_table_ip4(0)
210 def query_vpp_config(self):
211 if 0 == self.table.table_id:
213 return self._test.vapi.sw_interface_get_table(
214 self.intf.sw_if_index,
215 self.table.is_ip6).vrf_id == self.table.table_id
218 return self.object_id()
221 return "interface-bind-%s-%s" % (self.intf, self.table)
224 class VppMplsLabel(object):
225 def __init__(self, value, mode=MplsLspMode.PIPE, ttl=64, exp=0):
232 is_uniform = 0 if self.mode is MplsLspMode.PIPE else 1
233 return {'label': self.value,
236 'is_uniform': is_uniform}
238 def __eq__(self, other):
239 if isinstance(other, self.__class__):
240 return (self.value == other.value and
241 self.ttl == other.ttl and
242 self.exp == other.exp and
243 self.mode == other.mode)
244 elif hasattr(other, 'label'):
245 return (self.value == other.label and
246 self.ttl == other.ttl and
247 self.exp == other.exp and
248 (self.mode == MplsLspMode.UNIFORM) == other.is_uniform)
252 def __ne__(self, other):
253 return not (self == other)
256 class VppRoutePath(object):
264 nh_via_label=MPLS_LABEL_INVALID,
268 is_resolve_attached=0,
272 next_hop_id=0xffffffff,
273 proto=DpoProto.DPO_PROTO_IP4):
275 self.nh_itf = nh_sw_if_index
276 self.nh_table_id = nh_table_id
277 self.nh_via_label = nh_via_label
278 self.nh_labels = labels
281 if self.proto is DpoProto.DPO_PROTO_IP6:
282 self.nh_addr = inet_pton(AF_INET6, nh_addr)
283 elif self.proto is DpoProto.DPO_PROTO_IP4:
284 self.nh_addr = inet_pton(AF_INET, nh_addr)
286 self.nh_addr = inet_pton(AF_INET6, "::")
287 self.is_resolve_host = is_resolve_host
288 self.is_resolve_attached = is_resolve_attached
289 self.is_interface_rx = is_interface_rx
290 self.is_source_lookup = is_source_lookup
295 self.is_udp_encap = is_udp_encap
296 self.next_hop_id = next_hop_id
299 def encode_labels(self):
301 for l in self.nh_labels:
302 if type(l) == VppMplsLabel:
303 lstack.append(l.encode())
305 lstack.append({'label': l,
310 return {'next_hop': self.nh_addr,
313 'table_id': self.nh_table_id,
314 'next_hop_id': self.next_hop_id,
315 'sw_if_index': self.nh_itf,
317 'is_udp_encap': self.is_udp_encap,
318 'n_labels': len(self.nh_labels),
319 'label_stack': self.encode_labels()}
321 def __eq__(self, other):
322 if isinstance(other, self.__class__):
323 return self.nh_addr == other.nh_addr
324 elif hasattr(other, 'sw_if_index'):
326 if (len(self.nh_labels) != other.n_labels):
328 for i in range(len(self.nh_labels)):
329 if (self.nh_labels[i] != other.label_stack[i]):
331 return self.nh_itf == other.sw_if_index
335 def __ne__(self, other):
336 return not (self == other)
339 class VppMRoutePath(VppRoutePath):
341 def __init__(self, nh_sw_if_index, flags,
343 proto=DpoProto.DPO_PROTO_IP4,
346 nh = "::" if proto is DpoProto.DPO_PROTO_IP6 else "0.0.0.0"
347 super(VppMRoutePath, self).__init__(nh,
350 self.nh_i_flags = flags
351 self.bier_imp = bier_imp
354 class VppIpRoute(VppObject):
359 def __init__(self, test, dest_addr,
360 dest_addr_len, paths, table_id=0, is_ip6=0, is_local=0,
361 is_unreach=0, is_prohibit=0, is_drop=0):
364 self.dest_addr_len = dest_addr_len
365 self.table_id = table_id
367 self.is_local = is_local
368 self.is_unreach = is_unreach
369 self.is_prohibit = is_prohibit
370 self.is_drop = is_drop
371 self.dest_addr_p = dest_addr
373 self.dest_addr = inet_pton(AF_INET6, dest_addr)
375 self.dest_addr = inet_pton(AF_INET, dest_addr)
377 def modify(self, paths, is_local=0,
378 is_unreach=0, is_prohibit=0):
380 self.is_local = is_local
381 self.is_unreach = is_unreach
382 self.is_prohibit = is_prohibit
384 def add_vpp_config(self):
385 if self.is_unreach or self.is_prohibit or self.is_drop:
386 r = self._test.vapi.ip_add_del_route(
389 inet_pton(AF_INET6, "::"),
391 is_local=self.is_local,
392 is_unreach=self.is_unreach,
393 is_prohibit=self.is_prohibit,
394 is_drop=self.is_drop,
395 table_id=self.table_id,
398 for path in self.paths:
399 lstack = path.encode_labels()
401 r = self._test.vapi.ip_add_del_route(
406 table_id=self.table_id,
407 next_hop_out_label_stack=lstack,
408 next_hop_n_out_labels=len(lstack),
409 next_hop_via_label=path.nh_via_label,
410 next_hop_table_id=path.nh_table_id,
411 next_hop_id=path.next_hop_id,
414 is_local=self.is_local,
415 is_resolve_host=path.is_resolve_host,
416 is_resolve_attached=path.is_resolve_attached,
417 is_source_lookup=path.is_source_lookup,
418 is_udp_encap=path.is_udp_encap,
419 is_multipath=1 if len(self.paths) > 1 else 0)
420 self.stats_index = r.stats_index
421 self._test.registry.register(self, self._test.logger)
423 def remove_vpp_config(self):
424 if self.is_unreach or self.is_prohibit or self.is_drop:
425 self._test.vapi.ip_add_del_route(
428 inet_pton(AF_INET6, "::"),
430 is_local=self.is_local,
431 is_unreach=self.is_unreach,
432 is_prohibit=self.is_prohibit,
434 table_id=self.table_id,
437 for path in self.paths:
438 self._test.vapi.ip_add_del_route(
443 table_id=self.table_id,
444 next_hop_table_id=path.nh_table_id,
445 next_hop_via_label=path.nh_via_label,
446 next_hop_id=path.next_hop_id,
448 is_udp_encap=path.is_udp_encap,
452 def query_vpp_config(self):
453 return find_route(self._test,
457 inet=AF_INET6 if self.is_ip6 == 1 else AF_INET)
460 return self.object_id()
468 def get_stats_to(self):
469 c = self._test.statistics.get_counter("/net/route/to")
470 return c[0][self.stats_index]
472 def get_stats_via(self):
473 c = self._test.statistics.get_counter("/net/route/via")
474 return c[0][self.stats_index]
477 class VppIpMRoute(VppObject):
482 def __init__(self, test, src_addr, grp_addr,
483 grp_addr_len, e_flags, paths, table_id=0,
487 self.grp_addr_len = grp_addr_len
488 self.table_id = table_id
489 self.e_flags = e_flags
493 self.grp_addr_p = grp_addr
494 self.src_addr_p = src_addr
496 self.grp_addr = inet_pton(AF_INET6, grp_addr)
497 self.src_addr = inet_pton(AF_INET6, src_addr)
499 self.grp_addr = inet_pton(AF_INET, grp_addr)
500 self.src_addr = inet_pton(AF_INET, src_addr)
502 def add_vpp_config(self):
503 for path in self.paths:
504 r = self._test.vapi.ip_mroute_add_del(self.src_addr,
512 bier_imp=path.bier_imp,
514 table_id=self.table_id,
516 self.stats_index = r.stats_index
517 self._test.registry.register(self, self._test.logger)
519 def remove_vpp_config(self):
520 for path in self.paths:
521 self._test.vapi.ip_mroute_add_del(self.src_addr,
529 table_id=self.table_id,
530 bier_imp=path.bier_imp,
534 def update_entry_flags(self, flags):
536 self._test.vapi.ip_mroute_add_del(self.src_addr,
544 table_id=self.table_id,
547 def update_rpf_id(self, rpf_id):
549 self._test.vapi.ip_mroute_add_del(self.src_addr,
558 table_id=self.table_id,
561 def update_path_flags(self, itf, flags):
562 for path in self.paths:
563 if path.nh_itf == itf:
564 path.nh_i_flags = flags
566 self._test.vapi.ip_mroute_add_del(self.src_addr,
574 table_id=self.table_id,
577 def query_vpp_config(self):
578 return find_mroute(self._test,
583 inet=AF_INET6 if self.is_ip6 == 1 else AF_INET)
586 return self.object_id()
590 return ("%d:(%s,%s/%d)"
592 inet_ntop(AF_INET6, self.src_addr),
593 inet_ntop(AF_INET6, self.grp_addr),
596 return ("%d:(%s,%s/%d)"
598 inet_ntop(AF_INET, self.src_addr),
599 inet_ntop(AF_INET, self.grp_addr),
603 c = self._test.statistics.get_counter("/net/mroute")
604 return c[0][self.stats_index]
607 class VppMFibSignal(object):
608 def __init__(self, test, route, interface, packet):
610 self.interface = interface
614 def compare(self, signal):
615 self.test.assertEqual(self.interface, signal.sw_if_index)
616 self.test.assertEqual(self.route.table_id, signal.table_id)
617 self.test.assertEqual(self.route.grp_addr_len,
618 signal.grp_address_len)
619 for i in range(self.route.grp_addr_len / 8):
620 self.test.assertEqual(self.route.grp_addr[i],
621 signal.grp_address[i])
622 if (self.route.grp_addr_len > 32):
624 self.test.assertEqual(self.route.src_addr[i],
625 signal.src_address[i])
628 class VppMplsIpBind(VppObject):
633 def __init__(self, test, local_label, dest_addr, dest_addr_len,
634 table_id=0, ip_table_id=0, is_ip6=0):
636 self.dest_addr_len = dest_addr_len
637 self.dest_addr = dest_addr
638 self.local_label = local_label
639 self.table_id = table_id
640 self.ip_table_id = ip_table_id
643 self.dest_addrn = inet_pton(AF_INET6, dest_addr)
645 self.dest_addrn = inet_pton(AF_INET, dest_addr)
647 def add_vpp_config(self):
648 self._test.vapi.mpls_ip_bind_unbind(self.local_label,
651 table_id=self.table_id,
652 ip_table_id=self.ip_table_id,
653 is_ip4=(self.is_ip6 == 0))
654 self._test.registry.register(self, self._test.logger)
656 def remove_vpp_config(self):
657 self._test.vapi.mpls_ip_bind_unbind(self.local_label,
660 table_id=self.table_id,
661 ip_table_id=self.ip_table_id,
663 is_ip4=(self.is_ip6 == 0))
665 def query_vpp_config(self):
666 dump = self._test.vapi.mpls_fib_dump()
668 if self.local_label == e.label \
669 and self.table_id == e.table_id:
674 return self.object_id()
677 return ("%d:%s binds %d:%s/%d"
685 class VppMplsTable(VppObject):
691 self.table_id = table_id
693 def add_vpp_config(self):
694 self._test.vapi.mpls_table_add_del(
697 self._test.registry.register(self, self._test.logger)
699 def remove_vpp_config(self):
700 self._test.vapi.mpls_table_add_del(
704 def query_vpp_config(self):
705 # find the default route
706 dump = self._test.vapi.mpls_fib_dump()
712 return self.object_id()
715 return ("table-mpls-%d" % (self.table_id))
718 class VppMplsRoute(VppObject):
723 def __init__(self, test, local_label, eos_bit, paths, table_id=0,
727 self.local_label = local_label
728 self.eos_bit = eos_bit
729 self.table_id = table_id
730 self.is_multicast = is_multicast
732 def add_vpp_config(self):
733 is_multipath = len(self.paths) > 1
734 for path in self.paths:
735 lstack = path.encode_labels()
737 r = self._test.vapi.mpls_route_add_del(
743 is_multicast=self.is_multicast,
744 is_multipath=is_multipath,
745 table_id=self.table_id,
746 is_interface_rx=path.is_interface_rx,
747 is_rpf_id=path.is_rpf_id,
748 next_hop_out_label_stack=lstack,
749 next_hop_n_out_labels=len(lstack),
750 next_hop_via_label=path.nh_via_label,
751 next_hop_table_id=path.nh_table_id)
752 self.stats_index = r.stats_index
753 self._test.registry.register(self, self._test.logger)
755 def remove_vpp_config(self):
756 for path in self.paths:
757 self._test.vapi.mpls_route_add_del(self.local_label,
762 is_rpf_id=path.is_rpf_id,
763 table_id=self.table_id,
766 def query_vpp_config(self):
767 return find_mpls_route(self._test, self.table_id,
768 self.local_label, self.eos_bit)
771 return self.object_id()
779 def get_stats_to(self):
780 c = self._test.statistics.get_counter("/net/route/to")
781 return c[0][self.stats_index]
783 def get_stats_via(self):
784 c = self._test.statistics.get_counter("/net/route/via")
785 return c[0][self.stats_index]