4 object abstractions for representing IP routes in VPP
7 from vpp_object import *
8 from socket import inet_pton, inet_ntop, AF_INET, AF_INET6
10 # from vnet/vnet/mpls/mpls_types.h
11 MPLS_IETF_MAX_LABEL = 0xfffff
12 MPLS_LABEL_INVALID = MPLS_IETF_MAX_LABEL + 1
16 MFIB_ITF_FLAG_NONE = 0
17 MFIB_ITF_FLAG_NEGATE_SIGNAL = 1
18 MFIB_ITF_FLAG_ACCEPT = 2
19 MFIB_ITF_FLAG_FORWARD = 4
20 MFIB_ITF_FLAG_SIGNAL_PRESENT = 8
21 MFIB_ITF_FLAG_INTERNAL_COPY = 16
24 class MRouteEntryFlags:
25 MFIB_ENTRY_FLAG_NONE = 0
26 MFIB_ENTRY_FLAG_SIGNAL = 1
27 MFIB_ENTRY_FLAG_DROP = 2
28 MFIB_ENTRY_FLAG_CONNECTED = 4
29 MFIB_ENTRY_FLAG_INHERIT_ACCEPT = 8
36 DPO_PROTO_ETHERNET = 3
46 def find_route(test, ip_addr, len, table_id=0, inet=AF_INET):
49 routes = test.vapi.ip_fib_dump()
52 routes = test.vapi.ip6_fib_dump()
54 route_addr = inet_pton(inet, ip_addr)
56 if route_addr == e.address[:s] \
57 and len == e.address_length \
58 and table_id == e.table_id:
63 def find_mroute(test, grp_addr, src_addr, grp_addr_len,
64 table_id=0, inet=AF_INET):
67 routes = test.vapi.ip_mfib_dump()
70 routes = test.vapi.ip6_mfib_dump()
71 gaddr = inet_pton(inet, grp_addr)
72 saddr = inet_pton(inet, src_addr)
74 if gaddr == e.grp_address[:s] \
75 and grp_addr_len == e.address_length \
76 and saddr == e.src_address[:s] \
77 and table_id == e.table_id:
82 class VppIpTable(VppObject):
89 self.table_id = table_id
92 def add_vpp_config(self):
93 self._test.vapi.ip_table_add_del(
97 self._test.registry.register(self, self._test.logger)
99 def remove_vpp_config(self):
100 self._test.vapi.ip_table_add_del(
105 def query_vpp_config(self):
106 # find the default route
107 return find_route(self._test,
108 "::" if self.is_ip6 else "0.0.0.0",
111 inet=AF_INET6 if self.is_ip6 == 1 else AF_INET)
114 return self.object_id()
117 return ("table-%s-%d" %
118 ("v6" if self.is_ip6 == 1 else "v4",
122 class VppMplsLabel(object):
123 def __init__(self, value, mode=MplsLspMode.PIPE, ttl=64, exp=0):
130 is_uniform = 0 if self.mode is MplsLspMode.PIPE else 1
131 return {'label': self.value,
134 'is_uniform': is_uniform}
137 class VppRoutePath(object):
145 nh_via_label=MPLS_LABEL_INVALID,
149 is_resolve_attached=0,
153 next_hop_id=0xffffffff,
154 proto=DpoProto.DPO_PROTO_IP4):
155 self.nh_itf = nh_sw_if_index
156 self.nh_table_id = nh_table_id
157 self.nh_via_label = nh_via_label
158 self.nh_labels = labels
162 if self.proto is DpoProto.DPO_PROTO_IP6:
163 self.nh_addr = inet_pton(AF_INET6, nh_addr)
164 elif self.proto is DpoProto.DPO_PROTO_IP4:
165 self.nh_addr = inet_pton(AF_INET, nh_addr)
167 self.nh_addr = inet_pton(AF_INET6, "::")
168 self.is_resolve_host = is_resolve_host
169 self.is_resolve_attached = is_resolve_attached
170 self.is_interface_rx = is_interface_rx
171 self.is_source_lookup = is_source_lookup
176 self.is_udp_encap = is_udp_encap
177 self.next_hop_id = next_hop_id
180 def encode_labels(self):
182 for l in self.nh_labels:
183 if type(l) == VppMplsLabel:
184 lstack.append(l.encode())
186 lstack.append({'label': l,
191 return {'next_hop': self.nh_addr,
195 'table_id': self.nh_table_id,
196 'next_hop_id': self.next_hop_id,
197 'sw_if_index': self.nh_itf,
199 'is_udp_encap': self.is_udp_encap,
200 'n_labels': len(self.nh_labels),
201 'label_stack': self.encode_labels()}
204 class VppMRoutePath(VppRoutePath):
206 def __init__(self, nh_sw_if_index, flags,
208 proto=DpoProto.DPO_PROTO_IP4,
211 nh = "::" if proto is DpoProto.DPO_PROTO_IP6 else "0.0.0.0"
212 super(VppMRoutePath, self).__init__(nh,
215 self.nh_i_flags = flags
216 self.bier_imp = bier_imp
219 class VppIpRoute(VppObject):
224 def __init__(self, test, dest_addr,
225 dest_addr_len, paths, table_id=0, is_ip6=0, is_local=0,
226 is_unreach=0, is_prohibit=0):
229 self.dest_addr_len = dest_addr_len
230 self.table_id = table_id
232 self.is_local = is_local
233 self.is_unreach = is_unreach
234 self.is_prohibit = is_prohibit
235 self.dest_addr_p = dest_addr
237 self.dest_addr = inet_pton(AF_INET6, dest_addr)
239 self.dest_addr = inet_pton(AF_INET, dest_addr)
241 def modify(self, paths, is_local=0,
242 is_unreach=0, is_prohibit=0):
244 self.is_local = is_local
245 self.is_unreach = is_unreach
246 self.is_prohibit = is_prohibit
248 def add_vpp_config(self):
249 if self.is_local or self.is_unreach or self.is_prohibit:
250 self._test.vapi.ip_add_del_route(
253 inet_pton(AF_INET6, "::"),
255 is_local=self.is_local,
256 is_unreach=self.is_unreach,
257 is_prohibit=self.is_prohibit,
258 table_id=self.table_id,
261 for path in self.paths:
262 lstack = path.encode_labels()
264 self._test.vapi.ip_add_del_route(
269 table_id=self.table_id,
270 next_hop_out_label_stack=lstack,
271 next_hop_n_out_labels=len(lstack),
272 next_hop_via_label=path.nh_via_label,
273 next_hop_table_id=path.nh_table_id,
274 next_hop_id=path.next_hop_id,
277 is_resolve_host=path.is_resolve_host,
278 is_resolve_attached=path.is_resolve_attached,
279 is_source_lookup=path.is_source_lookup,
280 is_udp_encap=path.is_udp_encap,
281 is_multipath=1 if len(self.paths) > 1 else 0)
282 self._test.registry.register(self, self._test.logger)
284 def remove_vpp_config(self):
285 if self.is_local or self.is_unreach or self.is_prohibit:
286 self._test.vapi.ip_add_del_route(
289 inet_pton(AF_INET6, "::"),
291 is_local=self.is_local,
292 is_unreach=self.is_unreach,
293 is_prohibit=self.is_prohibit,
295 table_id=self.table_id,
298 for path in self.paths:
299 self._test.vapi.ip_add_del_route(
304 table_id=self.table_id,
305 next_hop_table_id=path.nh_table_id,
306 next_hop_via_label=path.nh_via_label,
307 next_hop_id=path.next_hop_id,
309 is_udp_encap=path.is_udp_encap,
313 def query_vpp_config(self):
314 return find_route(self._test,
318 inet=AF_INET6 if self.is_ip6 == 1 else AF_INET)
321 return self.object_id()
330 class VppIpMRoute(VppObject):
335 def __init__(self, test, src_addr, grp_addr,
336 grp_addr_len, e_flags, paths, table_id=0,
340 self.grp_addr_len = grp_addr_len
341 self.table_id = table_id
342 self.e_flags = e_flags
346 self.grp_addr_p = grp_addr
347 self.src_addr_p = src_addr
349 self.grp_addr = inet_pton(AF_INET6, grp_addr)
350 self.src_addr = inet_pton(AF_INET6, src_addr)
352 self.grp_addr = inet_pton(AF_INET, grp_addr)
353 self.src_addr = inet_pton(AF_INET, src_addr)
355 def add_vpp_config(self):
356 for path in self.paths:
357 self._test.vapi.ip_mroute_add_del(self.src_addr,
365 bier_imp=path.bier_imp,
367 table_id=self.table_id,
369 self._test.registry.register(self, self._test.logger)
371 def remove_vpp_config(self):
372 for path in self.paths:
373 self._test.vapi.ip_mroute_add_del(self.src_addr,
381 table_id=self.table_id,
382 bier_imp=path.bier_imp,
386 def update_entry_flags(self, flags):
388 self._test.vapi.ip_mroute_add_del(self.src_addr,
396 table_id=self.table_id,
399 def update_rpf_id(self, rpf_id):
401 self._test.vapi.ip_mroute_add_del(self.src_addr,
410 table_id=self.table_id,
413 def update_path_flags(self, itf, flags):
414 for path in self.paths:
415 if path.nh_itf == itf:
416 path.nh_i_flags = flags
418 self._test.vapi.ip_mroute_add_del(self.src_addr,
426 table_id=self.table_id,
429 def query_vpp_config(self):
430 return find_mroute(self._test,
435 inet=AF_INET6 if self.is_ip6 == 1 else AF_INET)
438 return self.object_id()
442 return ("%d:(%s,%s/%d)"
444 inet_ntop(AF_INET6, self.src_addr),
445 inet_ntop(AF_INET6, self.grp_addr),
448 return ("%d:(%s,%s/%d)"
450 inet_ntop(AF_INET, self.src_addr),
451 inet_ntop(AF_INET, self.grp_addr),
455 class VppMFibSignal(object):
456 def __init__(self, test, route, interface, packet):
458 self.interface = interface
462 def compare(self, signal):
463 self.test.assertEqual(self.interface, signal.sw_if_index)
464 self.test.assertEqual(self.route.table_id, signal.table_id)
465 self.test.assertEqual(self.route.grp_addr_len,
466 signal.grp_address_len)
467 for i in range(self.route.grp_addr_len / 8):
468 self.test.assertEqual(self.route.grp_addr[i],
469 signal.grp_address[i])
470 if (self.route.grp_addr_len > 32):
472 self.test.assertEqual(self.route.src_addr[i],
473 signal.src_address[i])
476 class VppMplsIpBind(VppObject):
481 def __init__(self, test, local_label, dest_addr, dest_addr_len,
482 table_id=0, ip_table_id=0, is_ip6=0):
484 self.dest_addr_len = dest_addr_len
485 self.dest_addr = dest_addr
486 self.local_label = local_label
487 self.table_id = table_id
488 self.ip_table_id = ip_table_id
491 self.dest_addrn = inet_pton(AF_INET6, dest_addr)
493 self.dest_addrn = inet_pton(AF_INET, dest_addr)
495 def add_vpp_config(self):
496 self._test.vapi.mpls_ip_bind_unbind(self.local_label,
499 table_id=self.table_id,
500 ip_table_id=self.ip_table_id,
501 is_ip4=(self.is_ip6 == 0))
502 self._test.registry.register(self, self._test.logger)
504 def remove_vpp_config(self):
505 self._test.vapi.mpls_ip_bind_unbind(self.local_label,
508 table_id=self.table_id,
509 ip_table_id=self.ip_table_id,
511 is_ip4=(self.is_ip6 == 0))
513 def query_vpp_config(self):
514 dump = self._test.vapi.mpls_fib_dump()
516 if self.local_label == e.label \
517 and self.table_id == e.table_id:
522 return self.object_id()
525 return ("%d:%s binds %d:%s/%d"
533 class VppMplsTable(VppObject):
539 self.table_id = table_id
541 def add_vpp_config(self):
542 self._test.vapi.mpls_table_add_del(
545 self._test.registry.register(self, self._test.logger)
547 def remove_vpp_config(self):
548 self._test.vapi.mpls_table_add_del(
552 def query_vpp_config(self):
553 # find the default route
554 dump = self._test.vapi.mpls_fib_dump()
560 return self.object_id()
563 return ("table-mpls-%d" % (self.table_id))
566 class VppMplsRoute(VppObject):
571 def __init__(self, test, local_label, eos_bit, paths, table_id=0,
575 self.local_label = local_label
576 self.eos_bit = eos_bit
577 self.table_id = table_id
578 self.is_multicast = is_multicast
580 def add_vpp_config(self):
581 is_multipath = len(self.paths) > 1
582 for path in self.paths:
583 lstack = path.encode_labels()
585 self._test.vapi.mpls_route_add_del(
591 is_multicast=self.is_multicast,
592 is_multipath=is_multipath,
593 table_id=self.table_id,
594 is_interface_rx=path.is_interface_rx,
595 is_rpf_id=path.is_rpf_id,
596 next_hop_out_label_stack=lstack,
597 next_hop_n_out_labels=len(lstack),
598 next_hop_via_label=path.nh_via_label,
599 next_hop_table_id=path.nh_table_id)
600 self._test.registry.register(self, self._test.logger)
602 def remove_vpp_config(self):
603 for path in self.paths:
604 self._test.vapi.mpls_route_add_del(self.local_label,
609 is_rpf_id=path.is_rpf_id,
610 table_id=self.table_id,
613 def query_vpp_config(self):
614 dump = self._test.vapi.mpls_fib_dump()
616 if self.local_label == e.label \
617 and self.eos_bit == e.eos_bit \
618 and self.table_id == e.table_id:
623 return self.object_id()