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 class VppMRoutePath(VppRoutePath):
174 def __init__(self, nh_sw_if_index, flags,
175 proto=DpoProto.DPO_PROTO_IP4,
177 super(VppMRoutePath, self).__init__(
178 "::" if proto is DpoProto.DPO_PROTO_IP6 else "0.0.0.0",
181 self.nh_i_flags = flags
182 self.bier_imp = bier_imp
185 class VppIpRoute(VppObject):
190 def __init__(self, test, dest_addr,
191 dest_addr_len, paths, table_id=0, is_ip6=0, is_local=0,
192 is_unreach=0, is_prohibit=0):
195 self.dest_addr_len = dest_addr_len
196 self.table_id = table_id
198 self.is_local = is_local
199 self.is_unreach = is_unreach
200 self.is_prohibit = is_prohibit
201 self.dest_addr_p = dest_addr
203 self.dest_addr = inet_pton(AF_INET6, dest_addr)
205 self.dest_addr = inet_pton(AF_INET, dest_addr)
207 def modify(self, paths, is_local=0,
208 is_unreach=0, is_prohibit=0):
210 self.is_local = is_local
211 self.is_unreach = is_unreach
212 self.is_prohibit = is_prohibit
214 def add_vpp_config(self):
215 if self.is_local or self.is_unreach or self.is_prohibit:
216 self._test.vapi.ip_add_del_route(
219 inet_pton(AF_INET6, "::"),
221 is_local=self.is_local,
222 is_unreach=self.is_unreach,
223 is_prohibit=self.is_prohibit,
224 table_id=self.table_id,
227 for path in self.paths:
228 lstack = path.encode_labels()
230 self._test.vapi.ip_add_del_route(
235 table_id=self.table_id,
236 next_hop_out_label_stack=lstack,
237 next_hop_n_out_labels=len(lstack),
238 next_hop_via_label=path.nh_via_label,
239 next_hop_table_id=path.nh_table_id,
240 next_hop_id=path.next_hop_id,
243 is_resolve_host=path.is_resolve_host,
244 is_resolve_attached=path.is_resolve_attached,
245 is_source_lookup=path.is_source_lookup,
246 is_udp_encap=path.is_udp_encap,
247 is_multipath=1 if len(self.paths) > 1 else 0)
248 self._test.registry.register(self, self._test.logger)
250 def remove_vpp_config(self):
251 if self.is_local or self.is_unreach or self.is_prohibit:
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,
261 table_id=self.table_id,
264 for path in self.paths:
265 self._test.vapi.ip_add_del_route(
270 table_id=self.table_id,
271 next_hop_table_id=path.nh_table_id,
272 next_hop_via_label=path.nh_via_label,
273 next_hop_id=path.next_hop_id,
275 is_udp_encap=path.is_udp_encap,
279 def query_vpp_config(self):
280 return find_route(self._test,
284 inet=AF_INET6 if self.is_ip6 == 1 else AF_INET)
287 return self.object_id()
296 class VppIpMRoute(VppObject):
301 def __init__(self, test, src_addr, grp_addr,
302 grp_addr_len, e_flags, paths, table_id=0,
306 self.grp_addr_len = grp_addr_len
307 self.table_id = table_id
308 self.e_flags = e_flags
313 self.grp_addr = inet_pton(AF_INET6, grp_addr)
314 self.src_addr = inet_pton(AF_INET6, src_addr)
316 self.grp_addr = inet_pton(AF_INET, grp_addr)
317 self.src_addr = inet_pton(AF_INET, src_addr)
319 def add_vpp_config(self):
320 for path in self.paths:
321 self._test.vapi.ip_mroute_add_del(self.src_addr,
328 bier_imp=path.bier_imp,
330 table_id=self.table_id,
332 self._test.registry.register(self, self._test.logger)
334 def remove_vpp_config(self):
335 for path in self.paths:
336 self._test.vapi.ip_mroute_add_del(self.src_addr,
343 table_id=self.table_id,
344 bier_imp=path.bier_imp,
348 def update_entry_flags(self, flags):
350 self._test.vapi.ip_mroute_add_del(self.src_addr,
357 table_id=self.table_id,
360 def update_rpf_id(self, rpf_id):
362 self._test.vapi.ip_mroute_add_del(self.src_addr,
370 table_id=self.table_id,
373 def update_path_flags(self, itf, flags):
374 for path in self.paths:
375 if path.nh_itf == itf:
376 path.nh_i_flags = flags
378 self._test.vapi.ip_mroute_add_del(self.src_addr,
385 table_id=self.table_id,
388 def query_vpp_config(self):
390 dump = self._test.vapi.ip6_mfib_dump()
392 dump = self._test.vapi.ip_mfib_dump()
394 if self.grp_addr == e.grp_address \
395 and self.grp_addr_len == e.address_length \
396 and self.src_addr == e.src_address \
397 and self.table_id == e.table_id:
402 return self.object_id()
406 return ("%d:(%s,%s/%d)"
408 inet_ntop(AF_INET6, self.src_addr),
409 inet_ntop(AF_INET6, self.grp_addr),
412 return ("%d:(%s,%s/%d)"
414 inet_ntop(AF_INET, self.src_addr),
415 inet_ntop(AF_INET, self.grp_addr),
419 class VppMFibSignal(object):
420 def __init__(self, test, route, interface, packet):
422 self.interface = interface
426 def compare(self, signal):
427 self.test.assertEqual(self.interface, signal.sw_if_index)
428 self.test.assertEqual(self.route.table_id, signal.table_id)
429 self.test.assertEqual(self.route.grp_addr_len,
430 signal.grp_address_len)
431 for i in range(self.route.grp_addr_len / 8):
432 self.test.assertEqual(self.route.grp_addr[i],
433 signal.grp_address[i])
434 if (self.route.grp_addr_len > 32):
436 self.test.assertEqual(self.route.src_addr[i],
437 signal.src_address[i])
440 class VppMplsIpBind(VppObject):
445 def __init__(self, test, local_label, dest_addr, dest_addr_len,
446 table_id=0, ip_table_id=0, is_ip6=0):
448 self.dest_addr_len = dest_addr_len
449 self.dest_addr = dest_addr
450 self.local_label = local_label
451 self.table_id = table_id
452 self.ip_table_id = ip_table_id
455 self.dest_addrn = inet_pton(AF_INET6, dest_addr)
457 self.dest_addrn = inet_pton(AF_INET, dest_addr)
459 def add_vpp_config(self):
460 self._test.vapi.mpls_ip_bind_unbind(self.local_label,
463 table_id=self.table_id,
464 ip_table_id=self.ip_table_id,
465 is_ip4=(self.is_ip6 == 0))
466 self._test.registry.register(self, self._test.logger)
468 def remove_vpp_config(self):
469 self._test.vapi.mpls_ip_bind_unbind(self.local_label,
472 table_id=self.table_id,
473 ip_table_id=self.ip_table_id,
475 is_ip4=(self.is_ip6 == 0))
477 def query_vpp_config(self):
478 dump = self._test.vapi.mpls_fib_dump()
480 if self.local_label == e.label \
481 and self.table_id == e.table_id:
486 return self.object_id()
489 return ("%d:%s binds %d:%s/%d"
497 class VppMplsTable(VppObject):
503 self.table_id = table_id
505 def add_vpp_config(self):
506 self._test.vapi.mpls_table_add_del(
509 self._test.registry.register(self, self._test.logger)
511 def remove_vpp_config(self):
512 self._test.vapi.mpls_table_add_del(
516 def query_vpp_config(self):
517 # find the default route
518 dump = self._test.vapi.mpls_fib_dump()
524 return self.object_id()
527 return ("table-mpls-%d" % (self.table_id))
530 class VppMplsRoute(VppObject):
535 def __init__(self, test, local_label, eos_bit, paths, table_id=0,
539 self.local_label = local_label
540 self.eos_bit = eos_bit
541 self.table_id = table_id
542 self.is_multicast = is_multicast
544 def add_vpp_config(self):
545 is_multipath = len(self.paths) > 1
546 for path in self.paths:
547 lstack = path.encode_labels()
549 self._test.vapi.mpls_route_add_del(
555 is_multicast=self.is_multicast,
556 is_multipath=is_multipath,
557 table_id=self.table_id,
558 is_interface_rx=path.is_interface_rx,
559 is_rpf_id=path.is_rpf_id,
560 next_hop_out_label_stack=lstack,
561 next_hop_n_out_labels=len(lstack),
562 next_hop_via_label=path.nh_via_label,
563 next_hop_table_id=path.nh_table_id)
564 self._test.registry.register(self, self._test.logger)
566 def remove_vpp_config(self):
567 for path in self.paths:
568 self._test.vapi.mpls_route_add_del(self.local_label,
573 is_rpf_id=path.is_rpf_id,
574 table_id=self.table_id,
577 def query_vpp_config(self):
578 dump = self._test.vapi.mpls_fib_dump()
580 if self.local_label == e.label \
581 and self.eos_bit == e.eos_bit \
582 and self.table_id == e.table_id:
587 return self.object_id()