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(
387 dst_address=self.dest_addr,
388 dst_address_length=self.dest_addr_len,
389 next_hop_address=inet_pton(
391 next_hop_sw_if_index=0xffffffff,
392 table_id=self.table_id,
393 is_drop=self.is_drop,
394 is_unreach=self.is_unreach,
395 is_prohibit=self.is_prohibit,
397 is_local=self.is_local)
399 for path in self.paths:
400 lstack = path.encode_labels()
402 r = self._test.vapi.ip_add_del_route(
403 dst_address=self.dest_addr,
404 dst_address_length=self.dest_addr_len,
405 next_hop_address=path.nh_addr,
406 next_hop_sw_if_index=path.nh_itf, table_id=self.table_id,
407 next_hop_table_id=path.nh_table_id,
408 next_hop_n_out_labels=len(lstack),
409 next_hop_out_label_stack=lstack,
410 next_hop_via_label=path.nh_via_label,
411 next_hop_id=path.next_hop_id,
412 is_resolve_host=path.is_resolve_host,
413 is_resolve_attached=path.is_resolve_attached,
414 is_ipv6=self.is_ip6, is_local=self.is_local,
415 is_multipath=1 if len(self.paths) > 1 else 0,
416 is_dvr=path.is_dvr, is_udp_encap=path.is_udp_encap,
417 is_source_lookup=path.is_source_lookup)
418 self.stats_index = r.stats_index
419 self._test.registry.register(self, self._test.logger)
421 def remove_vpp_config(self):
422 if self.is_unreach or self.is_prohibit or self.is_drop:
423 self._test.vapi.ip_add_del_route(
424 dst_address=self.dest_addr,
425 dst_address_length=self.dest_addr_len,
426 next_hop_address=inet_pton(
428 next_hop_sw_if_index=0xffffffff,
429 table_id=self.table_id, is_add=0,
430 is_unreach=self.is_unreach,
431 is_prohibit=self.is_prohibit,
433 is_local=self.is_local)
435 for path in self.paths:
436 self._test.vapi.ip_add_del_route(
437 dst_address=self.dest_addr,
438 dst_address_length=self.dest_addr_len,
439 next_hop_address=path.nh_addr,
440 next_hop_sw_if_index=path.nh_itf,
441 table_id=self.table_id,
442 next_hop_table_id=path.nh_table_id,
443 next_hop_via_label=path.nh_via_label,
444 next_hop_id=path.next_hop_id,
445 is_add=0, is_ipv6=self.is_ip6,
447 is_udp_encap=path.is_udp_encap)
449 def query_vpp_config(self):
450 return find_route(self._test,
454 inet=AF_INET6 if self.is_ip6 == 1 else AF_INET)
457 return self.object_id()
465 def get_stats_to(self):
466 c = self._test.statistics.get_counter("/net/route/to")
467 return c[0][self.stats_index]
469 def get_stats_via(self):
470 c = self._test.statistics.get_counter("/net/route/via")
471 return c[0][self.stats_index]
474 class VppIpMRoute(VppObject):
479 def __init__(self, test, src_addr, grp_addr,
480 grp_addr_len, e_flags, paths, table_id=0,
484 self.grp_addr_len = grp_addr_len
485 self.table_id = table_id
486 self.e_flags = e_flags
490 self.grp_addr_p = grp_addr
491 self.src_addr_p = src_addr
493 self.grp_addr = inet_pton(AF_INET6, grp_addr)
494 self.src_addr = inet_pton(AF_INET6, src_addr)
496 self.grp_addr = inet_pton(AF_INET, grp_addr)
497 self.src_addr = inet_pton(AF_INET, src_addr)
499 def add_vpp_config(self):
500 for path in self.paths:
501 r = self._test.vapi.ip_mroute_add_del(self.src_addr,
509 bier_imp=path.bier_imp,
511 table_id=self.table_id,
513 self.stats_index = r.stats_index
514 self._test.registry.register(self, self._test.logger)
516 def remove_vpp_config(self):
517 for path in self.paths:
518 self._test.vapi.ip_mroute_add_del(self.src_addr,
526 table_id=self.table_id,
527 bier_imp=path.bier_imp,
531 def update_entry_flags(self, flags):
533 self._test.vapi.ip_mroute_add_del(self.src_addr,
541 table_id=self.table_id,
544 def update_rpf_id(self, rpf_id):
546 self._test.vapi.ip_mroute_add_del(self.src_addr,
555 table_id=self.table_id,
558 def update_path_flags(self, itf, flags):
559 for path in self.paths:
560 if path.nh_itf == itf:
561 path.nh_i_flags = flags
563 self._test.vapi.ip_mroute_add_del(self.src_addr,
571 table_id=self.table_id,
574 def query_vpp_config(self):
575 return find_mroute(self._test,
580 inet=AF_INET6 if self.is_ip6 == 1 else AF_INET)
583 return self.object_id()
587 return ("%d:(%s,%s/%d)"
589 inet_ntop(AF_INET6, self.src_addr),
590 inet_ntop(AF_INET6, self.grp_addr),
593 return ("%d:(%s,%s/%d)"
595 inet_ntop(AF_INET, self.src_addr),
596 inet_ntop(AF_INET, self.grp_addr),
600 c = self._test.statistics.get_counter("/net/mroute")
601 return c[0][self.stats_index]
604 class VppMFibSignal(object):
605 def __init__(self, test, route, interface, packet):
607 self.interface = interface
611 def compare(self, signal):
612 self.test.assertEqual(self.interface, signal.sw_if_index)
613 self.test.assertEqual(self.route.table_id, signal.table_id)
614 self.test.assertEqual(self.route.grp_addr_len,
615 signal.grp_address_len)
616 for i in range(self.route.grp_addr_len / 8):
617 self.test.assertEqual(self.route.grp_addr[i],
618 signal.grp_address[i])
619 if (self.route.grp_addr_len > 32):
621 self.test.assertEqual(self.route.src_addr[i],
622 signal.src_address[i])
625 class VppMplsIpBind(VppObject):
630 def __init__(self, test, local_label, dest_addr, dest_addr_len,
631 table_id=0, ip_table_id=0, is_ip6=0):
633 self.dest_addr_len = dest_addr_len
634 self.dest_addr = dest_addr
635 self.local_label = local_label
636 self.table_id = table_id
637 self.ip_table_id = ip_table_id
640 self.dest_addrn = inet_pton(AF_INET6, dest_addr)
642 self.dest_addrn = inet_pton(AF_INET, dest_addr)
644 def add_vpp_config(self):
645 self._test.vapi.mpls_ip_bind_unbind(self.local_label,
648 table_id=self.table_id,
649 ip_table_id=self.ip_table_id,
650 is_ip4=(self.is_ip6 == 0))
651 self._test.registry.register(self, self._test.logger)
653 def remove_vpp_config(self):
654 self._test.vapi.mpls_ip_bind_unbind(self.local_label,
657 table_id=self.table_id,
658 ip_table_id=self.ip_table_id,
660 is_ip4=(self.is_ip6 == 0))
662 def query_vpp_config(self):
663 dump = self._test.vapi.mpls_fib_dump()
665 if self.local_label == e.label \
666 and self.table_id == e.table_id:
671 return self.object_id()
674 return ("%d:%s binds %d:%s/%d"
682 class VppMplsTable(VppObject):
688 self.table_id = table_id
690 def add_vpp_config(self):
691 self._test.vapi.mpls_table_add_del(
694 self._test.registry.register(self, self._test.logger)
696 def remove_vpp_config(self):
697 self._test.vapi.mpls_table_add_del(
701 def query_vpp_config(self):
702 # find the default route
703 dump = self._test.vapi.mpls_fib_dump()
709 return self.object_id()
712 return ("table-mpls-%d" % (self.table_id))
715 class VppMplsRoute(VppObject):
720 def __init__(self, test, local_label, eos_bit, paths, table_id=0,
724 self.local_label = local_label
725 self.eos_bit = eos_bit
726 self.table_id = table_id
727 self.is_multicast = is_multicast
729 def add_vpp_config(self):
730 is_multipath = len(self.paths) > 1
731 for path in self.paths:
732 lstack = path.encode_labels()
734 r = self._test.vapi.mpls_route_add_del(
735 mr_label=self.local_label,
737 mr_next_hop_proto=path.proto,
738 mr_next_hop=path.nh_addr,
739 mr_next_hop_sw_if_index=path.nh_itf,
740 mr_table_id=self.table_id,
741 mr_next_hop_table_id=path.nh_table_id,
742 mr_next_hop_n_out_labels=len(
744 mr_next_hop_out_label_stack=lstack,
745 mr_next_hop_via_label=path.nh_via_label,
746 mr_is_interface_rx=path.is_interface_rx,
747 mr_is_rpf_id=path.is_rpf_id,
748 mr_is_multicast=self.is_multicast,
749 mr_is_multipath=is_multipath)
750 self.stats_index = r.stats_index
751 self._test.registry.register(self, self._test.logger)
753 def remove_vpp_config(self):
754 for path in self.paths:
755 self._test.vapi.mpls_route_add_del(
756 mr_label=self.local_label,
758 mr_next_hop_proto=path.proto,
759 mr_next_hop=path.nh_addr,
760 mr_next_hop_sw_if_index=path.nh_itf,
761 mr_table_id=self.table_id,
762 mr_is_rpf_id=path.is_rpf_id,
765 def query_vpp_config(self):
766 return find_mpls_route(self._test, self.table_id,
767 self.local_label, self.eos_bit)
770 return self.object_id()
778 def get_stats_to(self):
779 c = self._test.statistics.get_counter("/net/route/to")
780 return c[0][self.stats_index]
782 def get_stats_via(self):
783 c = self._test.statistics.get_counter("/net/route/via")
784 return c[0][self.stats_index]