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 ("table-%s-%d" %
148 ("v6" if self.is_ip6 == 1 else "v4",
152 class VppIpInterfaceAddress(VppObject):
154 def __init__(self, test, intf, addr, len):
157 self.prefix = VppIpPrefix(addr, len)
159 def add_vpp_config(self):
160 self._test.vapi.sw_interface_add_del_address(
161 sw_if_index=self.intf.sw_if_index, address=self.prefix.bytes,
162 address_length=self.prefix.length, is_ipv6=self.prefix.is_ip6,
164 self._test.registry.register(self, self._test.logger)
166 def remove_vpp_config(self):
167 self._test.vapi.sw_interface_add_del_address(
168 sw_if_index=self.intf.sw_if_index, address=self.prefix.bytes,
169 address_length=self.prefix.length, is_ipv6=self.prefix.is_ip6,
172 def query_vpp_config(self):
173 return fib_interface_ip_prefix(self._test,
176 self.intf.sw_if_index)
179 return "interface-ip-%s-%s" % (self.intf, self.prefix)
182 class VppIpInterfaceBind(VppObject):
184 def __init__(self, test, intf, table):
189 def add_vpp_config(self):
190 if self.table.is_ip6:
191 self.intf.set_table_ip6(self.table.table_id)
193 self.intf.set_table_ip4(self.table.table_id)
194 self._test.registry.register(self, self._test.logger)
196 def remove_vpp_config(self):
197 if 0 == self.table.table_id:
199 if self.table.is_ip6:
200 self.intf.set_table_ip6(0)
202 self.intf.set_table_ip4(0)
204 def query_vpp_config(self):
205 if 0 == self.table.table_id:
207 return self._test.vapi.sw_interface_get_table(
208 self.intf.sw_if_index,
209 self.table.is_ip6).vrf_id == self.table.table_id
212 return "interface-bind-%s-%s" % (self.intf, self.table)
215 class VppMplsLabel(object):
216 def __init__(self, value, mode=MplsLspMode.PIPE, ttl=64, exp=0):
223 is_uniform = 0 if self.mode is MplsLspMode.PIPE else 1
224 return {'label': self.value,
227 'is_uniform': is_uniform}
229 def __eq__(self, other):
230 if isinstance(other, self.__class__):
231 return (self.value == other.value and
232 self.ttl == other.ttl and
233 self.exp == other.exp and
234 self.mode == other.mode)
235 elif hasattr(other, 'label'):
236 return (self.value == other.label and
237 self.ttl == other.ttl and
238 self.exp == other.exp and
239 (self.mode == MplsLspMode.UNIFORM) == other.is_uniform)
243 def __ne__(self, other):
244 return not (self == other)
247 class VppRoutePath(object):
255 nh_via_label=MPLS_LABEL_INVALID,
259 is_resolve_attached=0,
263 next_hop_id=0xffffffff,
264 proto=DpoProto.DPO_PROTO_IP4):
266 self.nh_itf = nh_sw_if_index
267 self.nh_table_id = nh_table_id
268 self.nh_via_label = nh_via_label
269 self.nh_labels = labels
272 if self.proto is DpoProto.DPO_PROTO_IP6:
273 self.nh_addr = inet_pton(AF_INET6, nh_addr)
274 elif self.proto is DpoProto.DPO_PROTO_IP4:
275 self.nh_addr = inet_pton(AF_INET, nh_addr)
277 self.nh_addr = inet_pton(AF_INET6, "::")
278 self.is_resolve_host = is_resolve_host
279 self.is_resolve_attached = is_resolve_attached
280 self.is_interface_rx = is_interface_rx
281 self.is_source_lookup = is_source_lookup
286 self.is_udp_encap = is_udp_encap
287 self.next_hop_id = next_hop_id
290 def encode_labels(self):
292 for l in self.nh_labels:
293 if type(l) == VppMplsLabel:
294 lstack.append(l.encode())
296 lstack.append({'label': l,
301 return {'next_hop': self.nh_addr,
304 'table_id': self.nh_table_id,
305 'next_hop_id': self.next_hop_id,
306 'sw_if_index': self.nh_itf,
308 'is_udp_encap': self.is_udp_encap,
309 'n_labels': len(self.nh_labels),
310 'label_stack': self.encode_labels()}
312 def __eq__(self, other):
313 if isinstance(other, self.__class__):
314 return self.nh_addr == other.nh_addr
315 elif hasattr(other, 'sw_if_index'):
317 if (len(self.nh_labels) != other.n_labels):
319 for i in range(len(self.nh_labels)):
320 if (self.nh_labels[i] != other.label_stack[i]):
322 return self.nh_itf == other.sw_if_index
326 def __ne__(self, other):
327 return not (self == other)
330 class VppMRoutePath(VppRoutePath):
332 def __init__(self, nh_sw_if_index, flags,
334 proto=DpoProto.DPO_PROTO_IP4,
337 nh = "::" if proto is DpoProto.DPO_PROTO_IP6 else "0.0.0.0"
338 super(VppMRoutePath, self).__init__(nh,
341 self.nh_i_flags = flags
342 self.bier_imp = bier_imp
345 class VppIpRoute(VppObject):
350 def __init__(self, test, dest_addr,
351 dest_addr_len, paths, table_id=0, is_ip6=0, is_local=0,
352 is_unreach=0, is_prohibit=0, is_drop=0):
355 self.dest_addr_len = dest_addr_len
356 self.table_id = table_id
358 self.is_local = is_local
359 self.is_unreach = is_unreach
360 self.is_prohibit = is_prohibit
361 self.is_drop = is_drop
362 self.dest_addr_p = dest_addr
364 self.dest_addr = inet_pton(AF_INET6, dest_addr)
366 self.dest_addr = inet_pton(AF_INET, dest_addr)
368 def modify(self, paths, is_local=0,
369 is_unreach=0, is_prohibit=0):
371 self.is_local = is_local
372 self.is_unreach = is_unreach
373 self.is_prohibit = is_prohibit
375 def add_vpp_config(self):
376 if self.is_unreach or self.is_prohibit or self.is_drop:
377 r = self._test.vapi.ip_add_del_route(
378 dst_address=self.dest_addr,
379 dst_address_length=self.dest_addr_len,
380 next_hop_address=inet_pton(
382 next_hop_sw_if_index=0xffffffff,
383 table_id=self.table_id,
384 is_drop=self.is_drop,
385 is_unreach=self.is_unreach,
386 is_prohibit=self.is_prohibit,
388 is_local=self.is_local)
390 for path in self.paths:
391 lstack = path.encode_labels()
393 r = self._test.vapi.ip_add_del_route(
394 dst_address=self.dest_addr,
395 dst_address_length=self.dest_addr_len,
396 next_hop_address=path.nh_addr,
397 next_hop_sw_if_index=path.nh_itf, table_id=self.table_id,
398 next_hop_table_id=path.nh_table_id,
399 next_hop_n_out_labels=len(lstack),
400 next_hop_out_label_stack=lstack,
401 next_hop_via_label=path.nh_via_label,
402 next_hop_id=path.next_hop_id,
403 is_resolve_host=path.is_resolve_host,
404 is_resolve_attached=path.is_resolve_attached,
405 is_ipv6=self.is_ip6, is_local=self.is_local,
406 is_multipath=1 if len(self.paths) > 1 else 0,
407 is_dvr=path.is_dvr, is_udp_encap=path.is_udp_encap,
408 is_source_lookup=path.is_source_lookup)
409 self.stats_index = r.stats_index
410 self._test.registry.register(self, self._test.logger)
412 def remove_vpp_config(self):
413 if self.is_unreach or self.is_prohibit or self.is_drop:
414 self._test.vapi.ip_add_del_route(
415 dst_address=self.dest_addr,
416 dst_address_length=self.dest_addr_len,
417 next_hop_address=inet_pton(
419 next_hop_sw_if_index=0xffffffff,
420 table_id=self.table_id, is_add=0,
421 is_unreach=self.is_unreach,
422 is_prohibit=self.is_prohibit,
424 is_local=self.is_local)
426 for path in self.paths:
427 self._test.vapi.ip_add_del_route(
428 dst_address=self.dest_addr,
429 dst_address_length=self.dest_addr_len,
430 next_hop_address=path.nh_addr,
431 next_hop_sw_if_index=path.nh_itf,
432 table_id=self.table_id,
433 next_hop_table_id=path.nh_table_id,
434 next_hop_via_label=path.nh_via_label,
435 next_hop_id=path.next_hop_id,
436 is_add=0, is_ipv6=self.is_ip6,
438 is_udp_encap=path.is_udp_encap)
440 def query_vpp_config(self):
441 return find_route(self._test,
445 inet=AF_INET6 if self.is_ip6 == 1 else AF_INET)
453 def get_stats_to(self):
454 c = self._test.statistics.get_counter("/net/route/to")
455 return c[0][self.stats_index]
457 def get_stats_via(self):
458 c = self._test.statistics.get_counter("/net/route/via")
459 return c[0][self.stats_index]
462 class VppIpMRoute(VppObject):
467 def __init__(self, test, src_addr, grp_addr,
468 grp_addr_len, e_flags, paths, table_id=0,
472 self.grp_addr_len = grp_addr_len
473 self.table_id = table_id
474 self.e_flags = e_flags
478 self.grp_addr_p = grp_addr
479 self.src_addr_p = src_addr
481 self.grp_addr = inet_pton(AF_INET6, grp_addr)
482 self.src_addr = inet_pton(AF_INET6, src_addr)
484 self.grp_addr = inet_pton(AF_INET, grp_addr)
485 self.src_addr = inet_pton(AF_INET, src_addr)
487 def add_vpp_config(self):
488 for path in self.paths:
489 r = self._test.vapi.ip_mroute_add_del(self.src_addr,
497 bier_imp=path.bier_imp,
499 table_id=self.table_id,
501 self.stats_index = r.stats_index
502 self._test.registry.register(self, self._test.logger)
504 def remove_vpp_config(self):
505 for path in self.paths:
506 self._test.vapi.ip_mroute_add_del(self.src_addr,
514 table_id=self.table_id,
515 bier_imp=path.bier_imp,
519 def update_entry_flags(self, flags):
521 self._test.vapi.ip_mroute_add_del(self.src_addr,
529 table_id=self.table_id,
532 def update_rpf_id(self, rpf_id):
534 self._test.vapi.ip_mroute_add_del(self.src_addr,
543 table_id=self.table_id,
546 def update_path_flags(self, itf, flags):
547 for path in self.paths:
548 if path.nh_itf == itf:
549 path.nh_i_flags = flags
551 self._test.vapi.ip_mroute_add_del(self.src_addr,
559 table_id=self.table_id,
562 def query_vpp_config(self):
563 return find_mroute(self._test,
568 inet=AF_INET6 if self.is_ip6 == 1 else AF_INET)
572 return ("%d:(%s,%s/%d)"
574 inet_ntop(AF_INET6, self.src_addr),
575 inet_ntop(AF_INET6, self.grp_addr),
578 return ("%d:(%s,%s/%d)"
580 inet_ntop(AF_INET, self.src_addr),
581 inet_ntop(AF_INET, self.grp_addr),
585 c = self._test.statistics.get_counter("/net/mroute")
586 return c[0][self.stats_index]
589 class VppMFibSignal(object):
590 def __init__(self, test, route, interface, packet):
592 self.interface = interface
596 def compare(self, signal):
597 self.test.assertEqual(self.interface, signal.sw_if_index)
598 self.test.assertEqual(self.route.table_id, signal.table_id)
599 self.test.assertEqual(self.route.grp_addr_len,
600 signal.grp_address_len)
601 for i in range(self.route.grp_addr_len / 8):
602 self.test.assertEqual(self.route.grp_addr[i],
603 signal.grp_address[i])
604 if (self.route.grp_addr_len > 32):
606 self.test.assertEqual(self.route.src_addr[i],
607 signal.src_address[i])
610 class VppMplsIpBind(VppObject):
615 def __init__(self, test, local_label, dest_addr, dest_addr_len,
616 table_id=0, ip_table_id=0, is_ip6=0):
618 self.dest_addr_len = dest_addr_len
619 self.dest_addr = dest_addr
620 self.local_label = local_label
621 self.table_id = table_id
622 self.ip_table_id = ip_table_id
625 self.dest_addrn = inet_pton(AF_INET6, dest_addr)
627 self.dest_addrn = inet_pton(AF_INET, dest_addr)
629 def add_vpp_config(self):
630 self._test.vapi.mpls_ip_bind_unbind(self.local_label,
633 table_id=self.table_id,
634 ip_table_id=self.ip_table_id,
635 is_ip4=(self.is_ip6 == 0))
636 self._test.registry.register(self, self._test.logger)
638 def remove_vpp_config(self):
639 self._test.vapi.mpls_ip_bind_unbind(self.local_label,
642 table_id=self.table_id,
643 ip_table_id=self.ip_table_id,
645 is_ip4=(self.is_ip6 == 0))
647 def query_vpp_config(self):
648 dump = self._test.vapi.mpls_fib_dump()
650 if self.local_label == e.label \
651 and self.table_id == e.table_id:
656 return ("%d:%s binds %d:%s/%d"
664 class VppMplsTable(VppObject):
670 self.table_id = table_id
672 def add_vpp_config(self):
673 self._test.vapi.mpls_table_add_del(
676 self._test.registry.register(self, self._test.logger)
678 def remove_vpp_config(self):
679 self._test.vapi.mpls_table_add_del(
683 def query_vpp_config(self):
684 # find the default route
685 dump = self._test.vapi.mpls_fib_dump()
691 return ("table-mpls-%d" % (self.table_id))
694 class VppMplsRoute(VppObject):
699 def __init__(self, test, local_label, eos_bit, paths, table_id=0,
703 self.local_label = local_label
704 self.eos_bit = eos_bit
705 self.table_id = table_id
706 self.is_multicast = is_multicast
708 def add_vpp_config(self):
709 is_multipath = len(self.paths) > 1
710 for path in self.paths:
711 lstack = path.encode_labels()
713 r = self._test.vapi.mpls_route_add_del(
714 mr_label=self.local_label,
716 mr_next_hop_proto=path.proto,
717 mr_next_hop=path.nh_addr,
718 mr_next_hop_sw_if_index=path.nh_itf,
719 mr_table_id=self.table_id,
720 mr_next_hop_table_id=path.nh_table_id,
721 mr_next_hop_n_out_labels=len(
723 mr_next_hop_out_label_stack=lstack,
724 mr_next_hop_via_label=path.nh_via_label,
725 mr_is_interface_rx=path.is_interface_rx,
726 mr_is_rpf_id=path.is_rpf_id,
727 mr_is_multicast=self.is_multicast,
728 mr_is_multipath=is_multipath)
729 self.stats_index = r.stats_index
730 self._test.registry.register(self, self._test.logger)
732 def remove_vpp_config(self):
733 for path in self.paths:
734 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_is_rpf_id=path.is_rpf_id,
744 def query_vpp_config(self):
745 return find_mpls_route(self._test, self.table_id,
746 self.local_label, self.eos_bit)
754 def get_stats_to(self):
755 c = self._test.statistics.get_counter("/net/route/to")
756 return c[0][self.stats_index]
758 def get_stats_via(self):
759 c = self._test.statistics.get_counter("/net/route/via")
760 return c[0][self.stats_index]