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 class VppIpTable(VppObject):
70 self.table_id = table_id
73 def add_vpp_config(self):
74 self._test.vapi.ip_table_add_del(
78 self._test.registry.register(self, self._test.logger)
80 def remove_vpp_config(self):
81 self._test.vapi.ip_table_add_del(
86 def query_vpp_config(self):
87 # find the default route
88 return find_route(self._test,
89 "::" if self.is_ip6 else "0.0.0.0",
92 inet=AF_INET6 if self.is_ip6 == 1 else AF_INET)
95 return self.object_id()
98 return ("table-%s-%d" %
99 ("v6" if self.is_ip6 == 1 else "v4",
103 class VppMplsLabel(object):
104 def __init__(self, value, mode=MplsLspMode.PIPE, ttl=64, exp=0):
111 is_uniform = 0 if self.mode is MplsLspMode.PIPE else 1
112 return {'label': self.value,
115 'is_uniform': is_uniform}
118 class VppRoutePath(object):
126 nh_via_label=MPLS_LABEL_INVALID,
130 is_resolve_attached=0,
134 next_hop_id=0xffffffff,
135 proto=DpoProto.DPO_PROTO_IP4):
136 self.nh_itf = nh_sw_if_index
137 self.nh_table_id = nh_table_id
138 self.nh_via_label = nh_via_label
139 self.nh_labels = labels
143 if self.proto is DpoProto.DPO_PROTO_IP6:
144 self.nh_addr = inet_pton(AF_INET6, nh_addr)
145 elif self.proto is DpoProto.DPO_PROTO_IP4:
146 self.nh_addr = inet_pton(AF_INET, nh_addr)
148 self.nh_addr = inet_pton(AF_INET6, "::")
149 self.is_resolve_host = is_resolve_host
150 self.is_resolve_attached = is_resolve_attached
151 self.is_interface_rx = is_interface_rx
152 self.is_source_lookup = is_source_lookup
157 self.is_udp_encap = is_udp_encap
158 self.next_hop_id = next_hop_id
161 def encode_labels(self):
163 for l in self.nh_labels:
164 if type(l) == VppMplsLabel:
165 lstack.append(l.encode())
167 lstack.append({'label': l,
172 return {'next_hop': self.nh_addr,
176 'table_id': self.nh_table_id,
177 'next_hop_id': self.next_hop_id,
178 'sw_if_index': self.nh_itf,
180 'is_udp_encap': self.is_udp_encap,
181 'n_labels': len(self.nh_labels),
182 'label_stack': self.encode_labels()}
185 class VppMRoutePath(VppRoutePath):
187 def __init__(self, nh_sw_if_index, flags,
188 proto=DpoProto.DPO_PROTO_IP4,
190 super(VppMRoutePath, self).__init__(
191 "::" if proto is DpoProto.DPO_PROTO_IP6 else "0.0.0.0",
194 self.nh_i_flags = flags
195 self.bier_imp = bier_imp
198 class VppIpRoute(VppObject):
203 def __init__(self, test, dest_addr,
204 dest_addr_len, paths, table_id=0, is_ip6=0, is_local=0,
205 is_unreach=0, is_prohibit=0):
208 self.dest_addr_len = dest_addr_len
209 self.table_id = table_id
211 self.is_local = is_local
212 self.is_unreach = is_unreach
213 self.is_prohibit = is_prohibit
214 self.dest_addr_p = dest_addr
216 self.dest_addr = inet_pton(AF_INET6, dest_addr)
218 self.dest_addr = inet_pton(AF_INET, dest_addr)
220 def modify(self, paths, is_local=0,
221 is_unreach=0, is_prohibit=0):
223 self.is_local = is_local
224 self.is_unreach = is_unreach
225 self.is_prohibit = is_prohibit
227 def add_vpp_config(self):
228 if self.is_local or self.is_unreach or self.is_prohibit:
229 self._test.vapi.ip_add_del_route(
232 inet_pton(AF_INET6, "::"),
234 is_local=self.is_local,
235 is_unreach=self.is_unreach,
236 is_prohibit=self.is_prohibit,
237 table_id=self.table_id,
240 for path in self.paths:
241 lstack = path.encode_labels()
243 self._test.vapi.ip_add_del_route(
248 table_id=self.table_id,
249 next_hop_out_label_stack=lstack,
250 next_hop_n_out_labels=len(lstack),
251 next_hop_via_label=path.nh_via_label,
252 next_hop_table_id=path.nh_table_id,
253 next_hop_id=path.next_hop_id,
256 is_resolve_host=path.is_resolve_host,
257 is_resolve_attached=path.is_resolve_attached,
258 is_source_lookup=path.is_source_lookup,
259 is_udp_encap=path.is_udp_encap,
260 is_multipath=1 if len(self.paths) > 1 else 0)
261 self._test.registry.register(self, self._test.logger)
263 def remove_vpp_config(self):
264 if self.is_local or self.is_unreach or self.is_prohibit:
265 self._test.vapi.ip_add_del_route(
268 inet_pton(AF_INET6, "::"),
270 is_local=self.is_local,
271 is_unreach=self.is_unreach,
272 is_prohibit=self.is_prohibit,
274 table_id=self.table_id,
277 for path in self.paths:
278 self._test.vapi.ip_add_del_route(
283 table_id=self.table_id,
284 next_hop_table_id=path.nh_table_id,
285 next_hop_via_label=path.nh_via_label,
286 next_hop_id=path.next_hop_id,
288 is_udp_encap=path.is_udp_encap,
292 def query_vpp_config(self):
293 return find_route(self._test,
297 inet=AF_INET6 if self.is_ip6 == 1 else AF_INET)
300 return self.object_id()
309 class VppIpMRoute(VppObject):
314 def __init__(self, test, src_addr, grp_addr,
315 grp_addr_len, e_flags, paths, table_id=0,
319 self.grp_addr_len = grp_addr_len
320 self.table_id = table_id
321 self.e_flags = e_flags
326 self.grp_addr = inet_pton(AF_INET6, grp_addr)
327 self.src_addr = inet_pton(AF_INET6, src_addr)
329 self.grp_addr = inet_pton(AF_INET, grp_addr)
330 self.src_addr = inet_pton(AF_INET, src_addr)
332 def add_vpp_config(self):
333 for path in self.paths:
334 self._test.vapi.ip_mroute_add_del(self.src_addr,
341 bier_imp=path.bier_imp,
343 table_id=self.table_id,
345 self._test.registry.register(self, self._test.logger)
347 def remove_vpp_config(self):
348 for path in self.paths:
349 self._test.vapi.ip_mroute_add_del(self.src_addr,
356 table_id=self.table_id,
357 bier_imp=path.bier_imp,
361 def update_entry_flags(self, flags):
363 self._test.vapi.ip_mroute_add_del(self.src_addr,
370 table_id=self.table_id,
373 def update_rpf_id(self, rpf_id):
375 self._test.vapi.ip_mroute_add_del(self.src_addr,
383 table_id=self.table_id,
386 def update_path_flags(self, itf, flags):
387 for path in self.paths:
388 if path.nh_itf == itf:
389 path.nh_i_flags = flags
391 self._test.vapi.ip_mroute_add_del(self.src_addr,
398 table_id=self.table_id,
401 def query_vpp_config(self):
403 dump = self._test.vapi.ip6_mfib_dump()
405 dump = self._test.vapi.ip_mfib_dump()
407 if self.grp_addr == e.grp_address \
408 and self.grp_addr_len == e.address_length \
409 and self.src_addr == e.src_address \
410 and self.table_id == e.table_id:
415 return self.object_id()
419 return ("%d:(%s,%s/%d)"
421 inet_ntop(AF_INET6, self.src_addr),
422 inet_ntop(AF_INET6, self.grp_addr),
425 return ("%d:(%s,%s/%d)"
427 inet_ntop(AF_INET, self.src_addr),
428 inet_ntop(AF_INET, self.grp_addr),
432 class VppMFibSignal(object):
433 def __init__(self, test, route, interface, packet):
435 self.interface = interface
439 def compare(self, signal):
440 self.test.assertEqual(self.interface, signal.sw_if_index)
441 self.test.assertEqual(self.route.table_id, signal.table_id)
442 self.test.assertEqual(self.route.grp_addr_len,
443 signal.grp_address_len)
444 for i in range(self.route.grp_addr_len / 8):
445 self.test.assertEqual(self.route.grp_addr[i],
446 signal.grp_address[i])
447 if (self.route.grp_addr_len > 32):
449 self.test.assertEqual(self.route.src_addr[i],
450 signal.src_address[i])
453 class VppMplsIpBind(VppObject):
458 def __init__(self, test, local_label, dest_addr, dest_addr_len,
459 table_id=0, ip_table_id=0, is_ip6=0):
461 self.dest_addr_len = dest_addr_len
462 self.dest_addr = dest_addr
463 self.local_label = local_label
464 self.table_id = table_id
465 self.ip_table_id = ip_table_id
468 self.dest_addrn = inet_pton(AF_INET6, dest_addr)
470 self.dest_addrn = inet_pton(AF_INET, dest_addr)
472 def add_vpp_config(self):
473 self._test.vapi.mpls_ip_bind_unbind(self.local_label,
476 table_id=self.table_id,
477 ip_table_id=self.ip_table_id,
478 is_ip4=(self.is_ip6 == 0))
479 self._test.registry.register(self, self._test.logger)
481 def remove_vpp_config(self):
482 self._test.vapi.mpls_ip_bind_unbind(self.local_label,
485 table_id=self.table_id,
486 ip_table_id=self.ip_table_id,
488 is_ip4=(self.is_ip6 == 0))
490 def query_vpp_config(self):
491 dump = self._test.vapi.mpls_fib_dump()
493 if self.local_label == e.label \
494 and self.table_id == e.table_id:
499 return self.object_id()
502 return ("%d:%s binds %d:%s/%d"
510 class VppMplsTable(VppObject):
516 self.table_id = table_id
518 def add_vpp_config(self):
519 self._test.vapi.mpls_table_add_del(
522 self._test.registry.register(self, self._test.logger)
524 def remove_vpp_config(self):
525 self._test.vapi.mpls_table_add_del(
529 def query_vpp_config(self):
530 # find the default route
531 dump = self._test.vapi.mpls_fib_dump()
537 return self.object_id()
540 return ("table-mpls-%d" % (self.table_id))
543 class VppMplsRoute(VppObject):
548 def __init__(self, test, local_label, eos_bit, paths, table_id=0,
552 self.local_label = local_label
553 self.eos_bit = eos_bit
554 self.table_id = table_id
555 self.is_multicast = is_multicast
557 def add_vpp_config(self):
558 is_multipath = len(self.paths) > 1
559 for path in self.paths:
560 lstack = path.encode_labels()
562 self._test.vapi.mpls_route_add_del(
568 is_multicast=self.is_multicast,
569 is_multipath=is_multipath,
570 table_id=self.table_id,
571 is_interface_rx=path.is_interface_rx,
572 is_rpf_id=path.is_rpf_id,
573 next_hop_out_label_stack=lstack,
574 next_hop_n_out_labels=len(lstack),
575 next_hop_via_label=path.nh_via_label,
576 next_hop_table_id=path.nh_table_id)
577 self._test.registry.register(self, self._test.logger)
579 def remove_vpp_config(self):
580 for path in self.paths:
581 self._test.vapi.mpls_route_add_del(self.local_label,
586 is_rpf_id=path.is_rpf_id,
587 table_id=self.table_id,
590 def query_vpp_config(self):
591 dump = self._test.vapi.mpls_fib_dump()
593 if self.local_label == e.label \
594 and self.eos_bit == e.eos_bit \
595 and self.table_id == e.table_id:
600 return self.object_id()