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
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 find_route(test, ip_addr, len, table_id=0, inet=AF_INET):
41 routes = test.vapi.ip_fib_dump()
44 routes = test.vapi.ip6_fib_dump()
46 route_addr = inet_pton(inet, ip_addr)
48 if route_addr == e.address[:s] \
49 and len == e.address_length \
50 and table_id == e.table_id:
55 def find_mroute(test, grp_addr, src_addr, grp_addr_len,
56 table_id=0, inet=AF_INET):
59 routes = test.vapi.ip_mfib_dump()
62 routes = test.vapi.ip6_mfib_dump()
63 gaddr = inet_pton(inet, grp_addr)
64 saddr = inet_pton(inet, src_addr)
66 if gaddr == e.grp_address[:s] \
67 and grp_addr_len == e.address_length \
68 and saddr == e.src_address[:s] \
69 and table_id == e.table_id:
74 class VppIpTable(VppObject):
81 self.table_id = table_id
84 def add_vpp_config(self):
85 self._test.vapi.ip_table_add_del(
89 self._test.registry.register(self, self._test.logger)
91 def remove_vpp_config(self):
92 self._test.vapi.ip_table_add_del(
97 def query_vpp_config(self):
98 # find the default route
99 return find_route(self._test,
100 "::" if self.is_ip6 else "0.0.0.0",
103 inet=AF_INET6 if self.is_ip6 == 1 else AF_INET)
106 return self.object_id()
109 return ("table-%s-%d" %
110 ("v6" if self.is_ip6 == 1 else "v4",
114 class VppMplsLabel(object):
115 def __init__(self, value, mode=MplsLspMode.PIPE, ttl=64, exp=0):
122 is_uniform = 0 if self.mode is MplsLspMode.PIPE else 1
123 return {'label': self.value,
126 'is_uniform': is_uniform}
129 class VppRoutePath(object):
137 nh_via_label=MPLS_LABEL_INVALID,
141 is_resolve_attached=0,
145 next_hop_id=0xffffffff,
146 proto=DpoProto.DPO_PROTO_IP4):
147 self.nh_itf = nh_sw_if_index
148 self.nh_table_id = nh_table_id
149 self.nh_via_label = nh_via_label
150 self.nh_labels = labels
154 if self.proto is DpoProto.DPO_PROTO_IP6:
155 self.nh_addr = inet_pton(AF_INET6, nh_addr)
156 elif self.proto is DpoProto.DPO_PROTO_IP4:
157 self.nh_addr = inet_pton(AF_INET, nh_addr)
159 self.nh_addr = inet_pton(AF_INET6, "::")
160 self.is_resolve_host = is_resolve_host
161 self.is_resolve_attached = is_resolve_attached
162 self.is_interface_rx = is_interface_rx
163 self.is_source_lookup = is_source_lookup
168 self.is_udp_encap = is_udp_encap
169 self.next_hop_id = next_hop_id
172 def encode_labels(self):
174 for l in self.nh_labels:
175 if type(l) == VppMplsLabel:
176 lstack.append(l.encode())
178 lstack.append({'label': l,
183 return {'next_hop': self.nh_addr,
187 'table_id': self.nh_table_id,
188 'next_hop_id': self.next_hop_id,
189 'sw_if_index': self.nh_itf,
191 'is_udp_encap': self.is_udp_encap,
192 'n_labels': len(self.nh_labels),
193 'label_stack': self.encode_labels()}
196 class VppMRoutePath(VppRoutePath):
198 def __init__(self, nh_sw_if_index, flags,
200 proto=DpoProto.DPO_PROTO_IP4,
203 nh = "::" if proto is DpoProto.DPO_PROTO_IP6 else "0.0.0.0"
204 super(VppMRoutePath, self).__init__(nh,
207 self.nh_i_flags = flags
208 self.bier_imp = bier_imp
211 class VppIpRoute(VppObject):
216 def __init__(self, test, dest_addr,
217 dest_addr_len, paths, table_id=0, is_ip6=0, is_local=0,
218 is_unreach=0, is_prohibit=0, is_drop=0):
221 self.dest_addr_len = dest_addr_len
222 self.table_id = table_id
224 self.is_local = is_local
225 self.is_unreach = is_unreach
226 self.is_prohibit = is_prohibit
227 self.is_drop = is_drop
228 self.dest_addr_p = dest_addr
230 self.dest_addr = inet_pton(AF_INET6, dest_addr)
232 self.dest_addr = inet_pton(AF_INET, dest_addr)
234 def modify(self, paths, is_local=0,
235 is_unreach=0, is_prohibit=0):
237 self.is_local = is_local
238 self.is_unreach = is_unreach
239 self.is_prohibit = is_prohibit
241 def add_vpp_config(self):
242 if self.is_local or self.is_unreach or \
243 self.is_prohibit or self.is_drop:
244 self._test.vapi.ip_add_del_route(
247 inet_pton(AF_INET6, "::"),
249 is_local=self.is_local,
250 is_unreach=self.is_unreach,
251 is_prohibit=self.is_prohibit,
252 is_drop=self.is_drop,
253 table_id=self.table_id,
256 for path in self.paths:
257 lstack = path.encode_labels()
259 self._test.vapi.ip_add_del_route(
264 table_id=self.table_id,
265 next_hop_out_label_stack=lstack,
266 next_hop_n_out_labels=len(lstack),
267 next_hop_via_label=path.nh_via_label,
268 next_hop_table_id=path.nh_table_id,
269 next_hop_id=path.next_hop_id,
272 is_resolve_host=path.is_resolve_host,
273 is_resolve_attached=path.is_resolve_attached,
274 is_source_lookup=path.is_source_lookup,
275 is_udp_encap=path.is_udp_encap,
276 is_multipath=1 if len(self.paths) > 1 else 0)
277 self._test.registry.register(self, self._test.logger)
279 def remove_vpp_config(self):
280 if self.is_local or self.is_unreach or \
281 self.is_prohibit or self.is_drop:
282 self._test.vapi.ip_add_del_route(
285 inet_pton(AF_INET6, "::"),
287 is_local=self.is_local,
288 is_unreach=self.is_unreach,
289 is_prohibit=self.is_prohibit,
291 table_id=self.table_id,
294 for path in self.paths:
295 self._test.vapi.ip_add_del_route(
300 table_id=self.table_id,
301 next_hop_table_id=path.nh_table_id,
302 next_hop_via_label=path.nh_via_label,
303 next_hop_id=path.next_hop_id,
305 is_udp_encap=path.is_udp_encap,
309 def query_vpp_config(self):
310 return find_route(self._test,
314 inet=AF_INET6 if self.is_ip6 == 1 else AF_INET)
317 return self.object_id()
326 class VppIpMRoute(VppObject):
331 def __init__(self, test, src_addr, grp_addr,
332 grp_addr_len, e_flags, paths, table_id=0,
336 self.grp_addr_len = grp_addr_len
337 self.table_id = table_id
338 self.e_flags = e_flags
342 self.grp_addr_p = grp_addr
343 self.src_addr_p = src_addr
345 self.grp_addr = inet_pton(AF_INET6, grp_addr)
346 self.src_addr = inet_pton(AF_INET6, src_addr)
348 self.grp_addr = inet_pton(AF_INET, grp_addr)
349 self.src_addr = inet_pton(AF_INET, src_addr)
351 def add_vpp_config(self):
352 for path in self.paths:
353 self._test.vapi.ip_mroute_add_del(self.src_addr,
361 bier_imp=path.bier_imp,
363 table_id=self.table_id,
365 self._test.registry.register(self, self._test.logger)
367 def remove_vpp_config(self):
368 for path in self.paths:
369 self._test.vapi.ip_mroute_add_del(self.src_addr,
377 table_id=self.table_id,
378 bier_imp=path.bier_imp,
382 def update_entry_flags(self, flags):
384 self._test.vapi.ip_mroute_add_del(self.src_addr,
392 table_id=self.table_id,
395 def update_rpf_id(self, rpf_id):
397 self._test.vapi.ip_mroute_add_del(self.src_addr,
406 table_id=self.table_id,
409 def update_path_flags(self, itf, flags):
410 for path in self.paths:
411 if path.nh_itf == itf:
412 path.nh_i_flags = flags
414 self._test.vapi.ip_mroute_add_del(self.src_addr,
422 table_id=self.table_id,
425 def query_vpp_config(self):
426 return find_mroute(self._test,
431 inet=AF_INET6 if self.is_ip6 == 1 else AF_INET)
434 return self.object_id()
438 return ("%d:(%s,%s/%d)"
440 inet_ntop(AF_INET6, self.src_addr),
441 inet_ntop(AF_INET6, self.grp_addr),
444 return ("%d:(%s,%s/%d)"
446 inet_ntop(AF_INET, self.src_addr),
447 inet_ntop(AF_INET, self.grp_addr),
451 class VppMFibSignal(object):
452 def __init__(self, test, route, interface, packet):
454 self.interface = interface
458 def compare(self, signal):
459 self.test.assertEqual(self.interface, signal.sw_if_index)
460 self.test.assertEqual(self.route.table_id, signal.table_id)
461 self.test.assertEqual(self.route.grp_addr_len,
462 signal.grp_address_len)
463 for i in range(self.route.grp_addr_len / 8):
464 self.test.assertEqual(self.route.grp_addr[i],
465 signal.grp_address[i])
466 if (self.route.grp_addr_len > 32):
468 self.test.assertEqual(self.route.src_addr[i],
469 signal.src_address[i])
472 class VppMplsIpBind(VppObject):
477 def __init__(self, test, local_label, dest_addr, dest_addr_len,
478 table_id=0, ip_table_id=0, is_ip6=0):
480 self.dest_addr_len = dest_addr_len
481 self.dest_addr = dest_addr
482 self.local_label = local_label
483 self.table_id = table_id
484 self.ip_table_id = ip_table_id
487 self.dest_addrn = inet_pton(AF_INET6, dest_addr)
489 self.dest_addrn = inet_pton(AF_INET, dest_addr)
491 def add_vpp_config(self):
492 self._test.vapi.mpls_ip_bind_unbind(self.local_label,
495 table_id=self.table_id,
496 ip_table_id=self.ip_table_id,
497 is_ip4=(self.is_ip6 == 0))
498 self._test.registry.register(self, self._test.logger)
500 def remove_vpp_config(self):
501 self._test.vapi.mpls_ip_bind_unbind(self.local_label,
504 table_id=self.table_id,
505 ip_table_id=self.ip_table_id,
507 is_ip4=(self.is_ip6 == 0))
509 def query_vpp_config(self):
510 dump = self._test.vapi.mpls_fib_dump()
512 if self.local_label == e.label \
513 and self.table_id == e.table_id:
518 return self.object_id()
521 return ("%d:%s binds %d:%s/%d"
529 class VppMplsTable(VppObject):
535 self.table_id = table_id
537 def add_vpp_config(self):
538 self._test.vapi.mpls_table_add_del(
541 self._test.registry.register(self, self._test.logger)
543 def remove_vpp_config(self):
544 self._test.vapi.mpls_table_add_del(
548 def query_vpp_config(self):
549 # find the default route
550 dump = self._test.vapi.mpls_fib_dump()
556 return self.object_id()
559 return ("table-mpls-%d" % (self.table_id))
562 class VppMplsRoute(VppObject):
567 def __init__(self, test, local_label, eos_bit, paths, table_id=0,
571 self.local_label = local_label
572 self.eos_bit = eos_bit
573 self.table_id = table_id
574 self.is_multicast = is_multicast
576 def add_vpp_config(self):
577 is_multipath = len(self.paths) > 1
578 for path in self.paths:
579 lstack = path.encode_labels()
581 self._test.vapi.mpls_route_add_del(
587 is_multicast=self.is_multicast,
588 is_multipath=is_multipath,
589 table_id=self.table_id,
590 is_interface_rx=path.is_interface_rx,
591 is_rpf_id=path.is_rpf_id,
592 next_hop_out_label_stack=lstack,
593 next_hop_n_out_labels=len(lstack),
594 next_hop_via_label=path.nh_via_label,
595 next_hop_table_id=path.nh_table_id)
596 self._test.registry.register(self, self._test.logger)
598 def remove_vpp_config(self):
599 for path in self.paths:
600 self._test.vapi.mpls_route_add_del(self.local_label,
605 is_rpf_id=path.is_rpf_id,
606 table_id=self.table_id,
609 def query_vpp_config(self):
610 dump = self._test.vapi.mpls_fib_dump()
612 if self.local_label == e.label \
613 and self.eos_bit == e.eos_bit \
614 and self.table_id == e.table_id:
619 return self.object_id()