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()}
195 def __eq__(self, other):
196 return self.nh_addr == other.nh_addr
199 class VppMRoutePath(VppRoutePath):
201 def __init__(self, nh_sw_if_index, flags,
203 proto=DpoProto.DPO_PROTO_IP4,
206 nh = "::" if proto is DpoProto.DPO_PROTO_IP6 else "0.0.0.0"
207 super(VppMRoutePath, self).__init__(nh,
210 self.nh_i_flags = flags
211 self.bier_imp = bier_imp
214 class VppIpRoute(VppObject):
219 def __init__(self, test, dest_addr,
220 dest_addr_len, paths, table_id=0, is_ip6=0, is_local=0,
221 is_unreach=0, is_prohibit=0, is_drop=0):
224 self.dest_addr_len = dest_addr_len
225 self.table_id = table_id
227 self.is_local = is_local
228 self.is_unreach = is_unreach
229 self.is_prohibit = is_prohibit
230 self.is_drop = is_drop
231 self.dest_addr_p = dest_addr
233 self.dest_addr = inet_pton(AF_INET6, dest_addr)
235 self.dest_addr = inet_pton(AF_INET, dest_addr)
237 def modify(self, paths, is_local=0,
238 is_unreach=0, is_prohibit=0):
240 self.is_local = is_local
241 self.is_unreach = is_unreach
242 self.is_prohibit = is_prohibit
244 def add_vpp_config(self):
245 if self.is_local or self.is_unreach or \
246 self.is_prohibit or self.is_drop:
247 r = self._test.vapi.ip_add_del_route(
250 inet_pton(AF_INET6, "::"),
252 is_local=self.is_local,
253 is_unreach=self.is_unreach,
254 is_prohibit=self.is_prohibit,
255 is_drop=self.is_drop,
256 table_id=self.table_id,
259 for path in self.paths:
260 lstack = path.encode_labels()
262 r = self._test.vapi.ip_add_del_route(
267 table_id=self.table_id,
268 next_hop_out_label_stack=lstack,
269 next_hop_n_out_labels=len(lstack),
270 next_hop_via_label=path.nh_via_label,
271 next_hop_table_id=path.nh_table_id,
272 next_hop_id=path.next_hop_id,
275 is_resolve_host=path.is_resolve_host,
276 is_resolve_attached=path.is_resolve_attached,
277 is_source_lookup=path.is_source_lookup,
278 is_udp_encap=path.is_udp_encap,
279 is_multipath=1 if len(self.paths) > 1 else 0)
280 self.stats_index = r.stats_index
281 self._test.registry.register(self, self._test.logger)
283 def remove_vpp_config(self):
284 if self.is_local or self.is_unreach or \
285 self.is_prohibit or self.is_drop:
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()
329 def get_stats_to(self):
330 c = self._test.statistics.get_counter("/net/route/to")
331 return c[0][self.stats_index]
333 def get_stats_via(self):
334 c = self._test.statistics.get_counter("/net/route/via")
335 return c[0][self.stats_index]
338 class VppIpMRoute(VppObject):
343 def __init__(self, test, src_addr, grp_addr,
344 grp_addr_len, e_flags, paths, table_id=0,
348 self.grp_addr_len = grp_addr_len
349 self.table_id = table_id
350 self.e_flags = e_flags
354 self.grp_addr_p = grp_addr
355 self.src_addr_p = src_addr
357 self.grp_addr = inet_pton(AF_INET6, grp_addr)
358 self.src_addr = inet_pton(AF_INET6, src_addr)
360 self.grp_addr = inet_pton(AF_INET, grp_addr)
361 self.src_addr = inet_pton(AF_INET, src_addr)
363 def add_vpp_config(self):
364 for path in self.paths:
365 self._test.vapi.ip_mroute_add_del(self.src_addr,
373 bier_imp=path.bier_imp,
375 table_id=self.table_id,
377 self._test.registry.register(self, self._test.logger)
379 def remove_vpp_config(self):
380 for path in self.paths:
381 self._test.vapi.ip_mroute_add_del(self.src_addr,
389 table_id=self.table_id,
390 bier_imp=path.bier_imp,
394 def update_entry_flags(self, flags):
396 self._test.vapi.ip_mroute_add_del(self.src_addr,
404 table_id=self.table_id,
407 def update_rpf_id(self, rpf_id):
409 self._test.vapi.ip_mroute_add_del(self.src_addr,
418 table_id=self.table_id,
421 def update_path_flags(self, itf, flags):
422 for path in self.paths:
423 if path.nh_itf == itf:
424 path.nh_i_flags = flags
426 self._test.vapi.ip_mroute_add_del(self.src_addr,
434 table_id=self.table_id,
437 def query_vpp_config(self):
438 return find_mroute(self._test,
443 inet=AF_INET6 if self.is_ip6 == 1 else AF_INET)
446 return self.object_id()
450 return ("%d:(%s,%s/%d)"
452 inet_ntop(AF_INET6, self.src_addr),
453 inet_ntop(AF_INET6, self.grp_addr),
456 return ("%d:(%s,%s/%d)"
458 inet_ntop(AF_INET, self.src_addr),
459 inet_ntop(AF_INET, self.grp_addr),
463 class VppMFibSignal(object):
464 def __init__(self, test, route, interface, packet):
466 self.interface = interface
470 def compare(self, signal):
471 self.test.assertEqual(self.interface, signal.sw_if_index)
472 self.test.assertEqual(self.route.table_id, signal.table_id)
473 self.test.assertEqual(self.route.grp_addr_len,
474 signal.grp_address_len)
475 for i in range(self.route.grp_addr_len / 8):
476 self.test.assertEqual(self.route.grp_addr[i],
477 signal.grp_address[i])
478 if (self.route.grp_addr_len > 32):
480 self.test.assertEqual(self.route.src_addr[i],
481 signal.src_address[i])
484 class VppMplsIpBind(VppObject):
489 def __init__(self, test, local_label, dest_addr, dest_addr_len,
490 table_id=0, ip_table_id=0, is_ip6=0):
492 self.dest_addr_len = dest_addr_len
493 self.dest_addr = dest_addr
494 self.local_label = local_label
495 self.table_id = table_id
496 self.ip_table_id = ip_table_id
499 self.dest_addrn = inet_pton(AF_INET6, dest_addr)
501 self.dest_addrn = inet_pton(AF_INET, dest_addr)
503 def add_vpp_config(self):
504 self._test.vapi.mpls_ip_bind_unbind(self.local_label,
507 table_id=self.table_id,
508 ip_table_id=self.ip_table_id,
509 is_ip4=(self.is_ip6 == 0))
510 self._test.registry.register(self, self._test.logger)
512 def remove_vpp_config(self):
513 self._test.vapi.mpls_ip_bind_unbind(self.local_label,
516 table_id=self.table_id,
517 ip_table_id=self.ip_table_id,
519 is_ip4=(self.is_ip6 == 0))
521 def query_vpp_config(self):
522 dump = self._test.vapi.mpls_fib_dump()
524 if self.local_label == e.label \
525 and self.table_id == e.table_id:
530 return self.object_id()
533 return ("%d:%s binds %d:%s/%d"
541 class VppMplsTable(VppObject):
547 self.table_id = table_id
549 def add_vpp_config(self):
550 self._test.vapi.mpls_table_add_del(
553 self._test.registry.register(self, self._test.logger)
555 def remove_vpp_config(self):
556 self._test.vapi.mpls_table_add_del(
560 def query_vpp_config(self):
561 # find the default route
562 dump = self._test.vapi.mpls_fib_dump()
568 return self.object_id()
571 return ("table-mpls-%d" % (self.table_id))
574 class VppMplsRoute(VppObject):
579 def __init__(self, test, local_label, eos_bit, paths, table_id=0,
583 self.local_label = local_label
584 self.eos_bit = eos_bit
585 self.table_id = table_id
586 self.is_multicast = is_multicast
588 def add_vpp_config(self):
589 is_multipath = len(self.paths) > 1
590 for path in self.paths:
591 lstack = path.encode_labels()
593 r = self._test.vapi.mpls_route_add_del(
599 is_multicast=self.is_multicast,
600 is_multipath=is_multipath,
601 table_id=self.table_id,
602 is_interface_rx=path.is_interface_rx,
603 is_rpf_id=path.is_rpf_id,
604 next_hop_out_label_stack=lstack,
605 next_hop_n_out_labels=len(lstack),
606 next_hop_via_label=path.nh_via_label,
607 next_hop_table_id=path.nh_table_id)
608 self.stats_index = r.stats_index
609 self._test.registry.register(self, self._test.logger)
611 def remove_vpp_config(self):
612 for path in self.paths:
613 self._test.vapi.mpls_route_add_del(self.local_label,
618 is_rpf_id=path.is_rpf_id,
619 table_id=self.table_id,
622 def query_vpp_config(self):
623 dump = self._test.vapi.mpls_fib_dump()
625 if self.local_label == e.label \
626 and self.eos_bit == e.eos_bit \
627 and self.table_id == e.table_id:
632 return self.object_id()
640 def get_stats_to(self):
641 c = self._test.statistics.get_counter("/net/route/to")
642 return c[0][self.stats_index]
644 def get_stats_via(self):
645 c = self._test.statistics.get_counter("/net/route/via")
646 return c[0][self.stats_index]