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, prefix=self.prefix.encode(),
166 self._test.registry.register(self, self._test.logger)
168 def remove_vpp_config(self):
169 self._test.vapi.sw_interface_add_del_address(
170 sw_if_index=self.intf.sw_if_index, prefix=self.prefix.encode(),
173 def query_vpp_config(self):
174 return fib_interface_ip_prefix(self._test,
177 self.intf.sw_if_index)
180 return self.object_id()
183 return "interface-ip-%s-%s" % (self.intf, self.prefix)
186 class VppIpInterfaceBind(VppObject):
188 def __init__(self, test, intf, table):
193 def add_vpp_config(self):
194 if self.table.is_ip6:
195 self.intf.set_table_ip6(self.table.table_id)
197 self.intf.set_table_ip4(self.table.table_id)
198 self._test.registry.register(self, self._test.logger)
200 def remove_vpp_config(self):
201 if 0 == self.table.table_id:
203 if self.table.is_ip6:
204 self.intf.set_table_ip6(0)
206 self.intf.set_table_ip4(0)
208 def query_vpp_config(self):
209 if 0 == self.table.table_id:
211 return self._test.vapi.sw_interface_get_table(
212 self.intf.sw_if_index,
213 self.table.is_ip6).vrf_id == self.table.table_id
216 return self.object_id()
219 return "interface-bind-%s-%s" % (self.intf, self.table)
222 class VppMplsLabel(object):
223 def __init__(self, value, mode=MplsLspMode.PIPE, ttl=64, exp=0):
230 is_uniform = 0 if self.mode is MplsLspMode.PIPE else 1
231 return {'label': self.value,
234 'is_uniform': is_uniform}
236 def __eq__(self, other):
237 if isinstance(other, self.__class__):
238 return (self.value == other.value and
239 self.ttl == other.ttl and
240 self.exp == other.exp and
241 self.mode == other.mode)
242 elif hasattr(other, 'label'):
243 return (self.value == other.label and
244 self.ttl == other.ttl and
245 self.exp == other.exp and
246 (self.mode == MplsLspMode.UNIFORM) == other.is_uniform)
250 def __ne__(self, other):
251 return not (self == other)
254 class VppRoutePath(object):
262 nh_via_label=MPLS_LABEL_INVALID,
266 is_resolve_attached=0,
270 next_hop_id=0xffffffff,
271 proto=DpoProto.DPO_PROTO_IP4):
273 self.nh_itf = nh_sw_if_index
274 self.nh_table_id = nh_table_id
275 self.nh_via_label = nh_via_label
276 self.nh_labels = labels
279 if self.proto is DpoProto.DPO_PROTO_IP6:
280 self.nh_addr = inet_pton(AF_INET6, nh_addr)
281 elif self.proto is DpoProto.DPO_PROTO_IP4:
282 self.nh_addr = inet_pton(AF_INET, nh_addr)
284 self.nh_addr = inet_pton(AF_INET6, "::")
285 self.is_resolve_host = is_resolve_host
286 self.is_resolve_attached = is_resolve_attached
287 self.is_interface_rx = is_interface_rx
288 self.is_source_lookup = is_source_lookup
293 self.is_udp_encap = is_udp_encap
294 self.next_hop_id = next_hop_id
297 def encode_labels(self):
299 for l in self.nh_labels:
300 if type(l) == VppMplsLabel:
301 lstack.append(l.encode())
303 lstack.append({'label': l,
308 return {'next_hop': self.nh_addr,
311 'table_id': self.nh_table_id,
312 'next_hop_id': self.next_hop_id,
313 'sw_if_index': self.nh_itf,
315 'is_udp_encap': self.is_udp_encap,
316 'n_labels': len(self.nh_labels),
317 'label_stack': self.encode_labels()}
319 def __eq__(self, other):
320 if isinstance(other, self.__class__):
321 return self.nh_addr == other.nh_addr
322 elif hasattr(other, 'sw_if_index'):
324 if (len(self.nh_labels) != other.n_labels):
326 for i in range(len(self.nh_labels)):
327 if (self.nh_labels[i] != other.label_stack[i]):
329 return self.nh_itf == other.sw_if_index
333 def __ne__(self, other):
334 return not (self == other)
337 class VppMRoutePath(VppRoutePath):
339 def __init__(self, nh_sw_if_index, flags,
341 proto=DpoProto.DPO_PROTO_IP4,
344 nh = "::" if proto is DpoProto.DPO_PROTO_IP6 else "0.0.0.0"
345 super(VppMRoutePath, self).__init__(nh,
348 self.nh_i_flags = flags
349 self.bier_imp = bier_imp
352 class VppIpRoute(VppObject):
357 def __init__(self, test, dest_addr,
358 dest_addr_len, paths, table_id=0, is_ip6=0, is_local=0,
359 is_unreach=0, is_prohibit=0, is_drop=0):
362 self.dest_addr_len = dest_addr_len
363 self.table_id = table_id
365 self.is_local = is_local
366 self.is_unreach = is_unreach
367 self.is_prohibit = is_prohibit
368 self.is_drop = is_drop
369 self.dest_addr_p = dest_addr
371 self.dest_addr = inet_pton(AF_INET6, dest_addr)
373 self.dest_addr = inet_pton(AF_INET, dest_addr)
375 def modify(self, paths, is_local=0,
376 is_unreach=0, is_prohibit=0):
378 self.is_local = is_local
379 self.is_unreach = is_unreach
380 self.is_prohibit = is_prohibit
382 def add_vpp_config(self):
383 if self.is_unreach or self.is_prohibit or self.is_drop:
384 r = self._test.vapi.ip_add_del_route(
385 dst_address=self.dest_addr,
386 dst_address_length=self.dest_addr_len,
387 next_hop_address=inet_pton(
389 next_hop_sw_if_index=0xffffffff,
390 table_id=self.table_id,
391 is_drop=self.is_drop,
392 is_unreach=self.is_unreach,
393 is_prohibit=self.is_prohibit,
395 is_local=self.is_local)
397 for path in self.paths:
398 lstack = path.encode_labels()
400 r = self._test.vapi.ip_add_del_route(
401 dst_address=self.dest_addr,
402 dst_address_length=self.dest_addr_len,
403 next_hop_address=path.nh_addr,
404 next_hop_sw_if_index=path.nh_itf, table_id=self.table_id,
405 next_hop_table_id=path.nh_table_id,
406 next_hop_n_out_labels=len(lstack),
407 next_hop_out_label_stack=lstack,
408 next_hop_via_label=path.nh_via_label,
409 next_hop_id=path.next_hop_id,
410 is_resolve_host=path.is_resolve_host,
411 is_resolve_attached=path.is_resolve_attached,
412 is_ipv6=self.is_ip6, is_local=self.is_local,
413 is_multipath=1 if len(self.paths) > 1 else 0,
414 is_dvr=path.is_dvr, is_udp_encap=path.is_udp_encap,
415 is_source_lookup=path.is_source_lookup)
416 self.stats_index = r.stats_index
417 self._test.registry.register(self, self._test.logger)
419 def remove_vpp_config(self):
420 if self.is_unreach or self.is_prohibit or self.is_drop:
421 self._test.vapi.ip_add_del_route(
422 dst_address=self.dest_addr,
423 dst_address_length=self.dest_addr_len,
424 next_hop_address=inet_pton(
426 next_hop_sw_if_index=0xffffffff,
427 table_id=self.table_id, is_add=0,
428 is_unreach=self.is_unreach,
429 is_prohibit=self.is_prohibit,
431 is_local=self.is_local)
433 for path in self.paths:
434 self._test.vapi.ip_add_del_route(
435 dst_address=self.dest_addr,
436 dst_address_length=self.dest_addr_len,
437 next_hop_address=path.nh_addr,
438 next_hop_sw_if_index=path.nh_itf,
439 table_id=self.table_id,
440 next_hop_table_id=path.nh_table_id,
441 next_hop_via_label=path.nh_via_label,
442 next_hop_id=path.next_hop_id,
443 is_add=0, is_ipv6=self.is_ip6,
445 is_udp_encap=path.is_udp_encap)
447 def query_vpp_config(self):
448 return find_route(self._test,
452 inet=AF_INET6 if self.is_ip6 == 1 else AF_INET)
455 return self.object_id()
463 def get_stats_to(self):
464 c = self._test.statistics.get_counter("/net/route/to")
465 return c[0][self.stats_index]
467 def get_stats_via(self):
468 c = self._test.statistics.get_counter("/net/route/via")
469 return c[0][self.stats_index]
472 class VppIpMRoute(VppObject):
477 def __init__(self, test, src_addr, grp_addr,
478 grp_addr_len, e_flags, paths, table_id=0,
482 self.grp_addr_len = grp_addr_len
483 self.table_id = table_id
484 self.e_flags = e_flags
488 self.grp_addr_p = grp_addr
489 self.src_addr_p = src_addr
491 self.grp_addr = inet_pton(AF_INET6, grp_addr)
492 self.src_addr = inet_pton(AF_INET6, src_addr)
494 self.grp_addr = inet_pton(AF_INET, grp_addr)
495 self.src_addr = inet_pton(AF_INET, src_addr)
497 def add_vpp_config(self):
498 for path in self.paths:
499 r = self._test.vapi.ip_mroute_add_del(self.src_addr,
507 bier_imp=path.bier_imp,
509 table_id=self.table_id,
511 self.stats_index = r.stats_index
512 self._test.registry.register(self, self._test.logger)
514 def remove_vpp_config(self):
515 for path in self.paths:
516 self._test.vapi.ip_mroute_add_del(self.src_addr,
524 table_id=self.table_id,
525 bier_imp=path.bier_imp,
529 def update_entry_flags(self, flags):
531 self._test.vapi.ip_mroute_add_del(self.src_addr,
539 table_id=self.table_id,
542 def update_rpf_id(self, rpf_id):
544 self._test.vapi.ip_mroute_add_del(self.src_addr,
553 table_id=self.table_id,
556 def update_path_flags(self, itf, flags):
557 for path in self.paths:
558 if path.nh_itf == itf:
559 path.nh_i_flags = flags
561 self._test.vapi.ip_mroute_add_del(self.src_addr,
569 table_id=self.table_id,
572 def query_vpp_config(self):
573 return find_mroute(self._test,
578 inet=AF_INET6 if self.is_ip6 == 1 else AF_INET)
581 return self.object_id()
585 return ("%d:(%s,%s/%d)"
587 inet_ntop(AF_INET6, self.src_addr),
588 inet_ntop(AF_INET6, self.grp_addr),
591 return ("%d:(%s,%s/%d)"
593 inet_ntop(AF_INET, self.src_addr),
594 inet_ntop(AF_INET, self.grp_addr),
598 c = self._test.statistics.get_counter("/net/mroute")
599 return c[0][self.stats_index]
602 class VppMFibSignal(object):
603 def __init__(self, test, route, interface, packet):
605 self.interface = interface
609 def compare(self, signal):
610 self.test.assertEqual(self.interface, signal.sw_if_index)
611 self.test.assertEqual(self.route.table_id, signal.table_id)
612 self.test.assertEqual(self.route.grp_addr_len,
613 signal.grp_address_len)
614 for i in range(self.route.grp_addr_len / 8):
615 self.test.assertEqual(self.route.grp_addr[i],
616 signal.grp_address[i])
617 if (self.route.grp_addr_len > 32):
619 self.test.assertEqual(self.route.src_addr[i],
620 signal.src_address[i])
623 class VppMplsIpBind(VppObject):
628 def __init__(self, test, local_label, dest_addr, dest_addr_len,
629 table_id=0, ip_table_id=0, is_ip6=0):
631 self.dest_addr_len = dest_addr_len
632 self.dest_addr = dest_addr
633 self.local_label = local_label
634 self.table_id = table_id
635 self.ip_table_id = ip_table_id
638 self.dest_addrn = inet_pton(AF_INET6, dest_addr)
640 self.dest_addrn = inet_pton(AF_INET, dest_addr)
642 def add_vpp_config(self):
643 self._test.vapi.mpls_ip_bind_unbind(self.local_label,
646 table_id=self.table_id,
647 ip_table_id=self.ip_table_id,
648 is_ip4=(self.is_ip6 == 0))
649 self._test.registry.register(self, self._test.logger)
651 def remove_vpp_config(self):
652 self._test.vapi.mpls_ip_bind_unbind(self.local_label,
655 table_id=self.table_id,
656 ip_table_id=self.ip_table_id,
658 is_ip4=(self.is_ip6 == 0))
660 def query_vpp_config(self):
661 dump = self._test.vapi.mpls_fib_dump()
663 if self.local_label == e.label \
664 and self.table_id == e.table_id:
669 return self.object_id()
672 return ("%d:%s binds %d:%s/%d"
680 class VppMplsTable(VppObject):
686 self.table_id = table_id
688 def add_vpp_config(self):
689 self._test.vapi.mpls_table_add_del(
692 self._test.registry.register(self, self._test.logger)
694 def remove_vpp_config(self):
695 self._test.vapi.mpls_table_add_del(
699 def query_vpp_config(self):
700 # find the default route
701 dump = self._test.vapi.mpls_fib_dump()
707 return self.object_id()
710 return ("table-mpls-%d" % (self.table_id))
713 class VppMplsRoute(VppObject):
718 def __init__(self, test, local_label, eos_bit, paths, table_id=0,
722 self.local_label = local_label
723 self.eos_bit = eos_bit
724 self.table_id = table_id
725 self.is_multicast = is_multicast
727 def add_vpp_config(self):
728 is_multipath = len(self.paths) > 1
729 for path in self.paths:
730 lstack = path.encode_labels()
732 r = self._test.vapi.mpls_route_add_del(
733 mr_label=self.local_label,
735 mr_next_hop_proto=path.proto,
736 mr_next_hop=path.nh_addr,
737 mr_next_hop_sw_if_index=path.nh_itf,
738 mr_table_id=self.table_id,
739 mr_next_hop_table_id=path.nh_table_id,
740 mr_next_hop_n_out_labels=len(
742 mr_next_hop_out_label_stack=lstack,
743 mr_next_hop_via_label=path.nh_via_label,
744 mr_is_interface_rx=path.is_interface_rx,
745 mr_is_rpf_id=path.is_rpf_id,
746 mr_is_multicast=self.is_multicast,
747 mr_is_multipath=is_multipath)
748 self.stats_index = r.stats_index
749 self._test.registry.register(self, self._test.logger)
751 def remove_vpp_config(self):
752 for path in self.paths:
753 self._test.vapi.mpls_route_add_del(
754 mr_label=self.local_label,
756 mr_next_hop_proto=path.proto,
757 mr_next_hop=path.nh_addr,
758 mr_next_hop_sw_if_index=path.nh_itf,
759 mr_table_id=self.table_id,
760 mr_is_rpf_id=path.is_rpf_id,
763 def query_vpp_config(self):
764 return find_mpls_route(self._test, self.table_id,
765 self.local_label, self.eos_bit)
768 return self.object_id()
776 def get_stats_to(self):
777 c = self._test.statistics.get_counter("/net/route/to")
778 return c[0][self.stats_index]
780 def get_stats_via(self):
781 c = self._test.statistics.get_counter("/net/route/via")
782 return c[0][self.stats_index]