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, is_drop=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.is_drop = is_drop
236 self.dest_addr_p = dest_addr
238 self.dest_addr = inet_pton(AF_INET6, dest_addr)
240 self.dest_addr = inet_pton(AF_INET, dest_addr)
242 def modify(self, paths, is_local=0,
243 is_unreach=0, is_prohibit=0):
245 self.is_local = is_local
246 self.is_unreach = is_unreach
247 self.is_prohibit = is_prohibit
249 def add_vpp_config(self):
250 if self.is_local or self.is_unreach or \
251 self.is_prohibit or self.is_drop:
252 self._test.vapi.ip_add_del_route(
255 inet_pton(AF_INET6, "::"),
257 is_local=self.is_local,
258 is_unreach=self.is_unreach,
259 is_prohibit=self.is_prohibit,
260 is_drop=self.is_drop,
261 table_id=self.table_id,
264 for path in self.paths:
265 lstack = path.encode_labels()
267 self._test.vapi.ip_add_del_route(
272 table_id=self.table_id,
273 next_hop_out_label_stack=lstack,
274 next_hop_n_out_labels=len(lstack),
275 next_hop_via_label=path.nh_via_label,
276 next_hop_table_id=path.nh_table_id,
277 next_hop_id=path.next_hop_id,
280 is_resolve_host=path.is_resolve_host,
281 is_resolve_attached=path.is_resolve_attached,
282 is_source_lookup=path.is_source_lookup,
283 is_udp_encap=path.is_udp_encap,
284 is_multipath=1 if len(self.paths) > 1 else 0)
285 self._test.registry.register(self, self._test.logger)
287 def remove_vpp_config(self):
288 if self.is_local or self.is_unreach or \
289 self.is_prohibit or self.is_drop:
290 self._test.vapi.ip_add_del_route(
293 inet_pton(AF_INET6, "::"),
295 is_local=self.is_local,
296 is_unreach=self.is_unreach,
297 is_prohibit=self.is_prohibit,
299 table_id=self.table_id,
302 for path in self.paths:
303 self._test.vapi.ip_add_del_route(
308 table_id=self.table_id,
309 next_hop_table_id=path.nh_table_id,
310 next_hop_via_label=path.nh_via_label,
311 next_hop_id=path.next_hop_id,
313 is_udp_encap=path.is_udp_encap,
317 def query_vpp_config(self):
318 return find_route(self._test,
322 inet=AF_INET6 if self.is_ip6 == 1 else AF_INET)
325 return self.object_id()
334 class VppIpMRoute(VppObject):
339 def __init__(self, test, src_addr, grp_addr,
340 grp_addr_len, e_flags, paths, table_id=0,
344 self.grp_addr_len = grp_addr_len
345 self.table_id = table_id
346 self.e_flags = e_flags
350 self.grp_addr_p = grp_addr
351 self.src_addr_p = src_addr
353 self.grp_addr = inet_pton(AF_INET6, grp_addr)
354 self.src_addr = inet_pton(AF_INET6, src_addr)
356 self.grp_addr = inet_pton(AF_INET, grp_addr)
357 self.src_addr = inet_pton(AF_INET, src_addr)
359 def add_vpp_config(self):
360 for path in self.paths:
361 self._test.vapi.ip_mroute_add_del(self.src_addr,
369 bier_imp=path.bier_imp,
371 table_id=self.table_id,
373 self._test.registry.register(self, self._test.logger)
375 def remove_vpp_config(self):
376 for path in self.paths:
377 self._test.vapi.ip_mroute_add_del(self.src_addr,
385 table_id=self.table_id,
386 bier_imp=path.bier_imp,
390 def update_entry_flags(self, flags):
392 self._test.vapi.ip_mroute_add_del(self.src_addr,
400 table_id=self.table_id,
403 def update_rpf_id(self, rpf_id):
405 self._test.vapi.ip_mroute_add_del(self.src_addr,
414 table_id=self.table_id,
417 def update_path_flags(self, itf, flags):
418 for path in self.paths:
419 if path.nh_itf == itf:
420 path.nh_i_flags = flags
422 self._test.vapi.ip_mroute_add_del(self.src_addr,
430 table_id=self.table_id,
433 def query_vpp_config(self):
434 return find_mroute(self._test,
439 inet=AF_INET6 if self.is_ip6 == 1 else AF_INET)
442 return self.object_id()
446 return ("%d:(%s,%s/%d)"
448 inet_ntop(AF_INET6, self.src_addr),
449 inet_ntop(AF_INET6, self.grp_addr),
452 return ("%d:(%s,%s/%d)"
454 inet_ntop(AF_INET, self.src_addr),
455 inet_ntop(AF_INET, self.grp_addr),
459 class VppMFibSignal(object):
460 def __init__(self, test, route, interface, packet):
462 self.interface = interface
466 def compare(self, signal):
467 self.test.assertEqual(self.interface, signal.sw_if_index)
468 self.test.assertEqual(self.route.table_id, signal.table_id)
469 self.test.assertEqual(self.route.grp_addr_len,
470 signal.grp_address_len)
471 for i in range(self.route.grp_addr_len / 8):
472 self.test.assertEqual(self.route.grp_addr[i],
473 signal.grp_address[i])
474 if (self.route.grp_addr_len > 32):
476 self.test.assertEqual(self.route.src_addr[i],
477 signal.src_address[i])
480 class VppMplsIpBind(VppObject):
485 def __init__(self, test, local_label, dest_addr, dest_addr_len,
486 table_id=0, ip_table_id=0, is_ip6=0):
488 self.dest_addr_len = dest_addr_len
489 self.dest_addr = dest_addr
490 self.local_label = local_label
491 self.table_id = table_id
492 self.ip_table_id = ip_table_id
495 self.dest_addrn = inet_pton(AF_INET6, dest_addr)
497 self.dest_addrn = inet_pton(AF_INET, dest_addr)
499 def add_vpp_config(self):
500 self._test.vapi.mpls_ip_bind_unbind(self.local_label,
503 table_id=self.table_id,
504 ip_table_id=self.ip_table_id,
505 is_ip4=(self.is_ip6 == 0))
506 self._test.registry.register(self, self._test.logger)
508 def remove_vpp_config(self):
509 self._test.vapi.mpls_ip_bind_unbind(self.local_label,
512 table_id=self.table_id,
513 ip_table_id=self.ip_table_id,
515 is_ip4=(self.is_ip6 == 0))
517 def query_vpp_config(self):
518 dump = self._test.vapi.mpls_fib_dump()
520 if self.local_label == e.label \
521 and self.table_id == e.table_id:
526 return self.object_id()
529 return ("%d:%s binds %d:%s/%d"
537 class VppMplsTable(VppObject):
543 self.table_id = table_id
545 def add_vpp_config(self):
546 self._test.vapi.mpls_table_add_del(
549 self._test.registry.register(self, self._test.logger)
551 def remove_vpp_config(self):
552 self._test.vapi.mpls_table_add_del(
556 def query_vpp_config(self):
557 # find the default route
558 dump = self._test.vapi.mpls_fib_dump()
564 return self.object_id()
567 return ("table-mpls-%d" % (self.table_id))
570 class VppMplsRoute(VppObject):
575 def __init__(self, test, local_label, eos_bit, paths, table_id=0,
579 self.local_label = local_label
580 self.eos_bit = eos_bit
581 self.table_id = table_id
582 self.is_multicast = is_multicast
584 def add_vpp_config(self):
585 is_multipath = len(self.paths) > 1
586 for path in self.paths:
587 lstack = path.encode_labels()
589 self._test.vapi.mpls_route_add_del(
595 is_multicast=self.is_multicast,
596 is_multipath=is_multipath,
597 table_id=self.table_id,
598 is_interface_rx=path.is_interface_rx,
599 is_rpf_id=path.is_rpf_id,
600 next_hop_out_label_stack=lstack,
601 next_hop_n_out_labels=len(lstack),
602 next_hop_via_label=path.nh_via_label,
603 next_hop_table_id=path.nh_table_id)
604 self._test.registry.register(self, self._test.logger)
606 def remove_vpp_config(self):
607 for path in self.paths:
608 self._test.vapi.mpls_route_add_del(self.local_label,
613 is_rpf_id=path.is_rpf_id,
614 table_id=self.table_id,
617 def query_vpp_config(self):
618 dump = self._test.vapi.mpls_fib_dump()
620 if self.local_label == e.label \
621 and self.eos_bit == e.eos_bit \
622 and self.table_id == e.table_id:
627 return self.object_id()