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
41 def find_route(test, ip_addr, len, table_id=0, inet=AF_INET):
44 routes = test.vapi.ip_fib_dump()
47 routes = test.vapi.ip6_fib_dump()
49 route_addr = inet_pton(inet, ip_addr)
51 if route_addr == e.address[:s] \
52 and len == e.address_length \
53 and table_id == e.table_id:
58 class VppIpTable(VppObject):
65 self.table_id = table_id
68 def add_vpp_config(self):
69 self._test.vapi.ip_table_add_del(
73 self._test.registry.register(self, self._test.logger)
75 def remove_vpp_config(self):
76 self._test.vapi.ip_table_add_del(
81 def query_vpp_config(self):
82 # find the default route
83 return find_route(self._test,
84 "::" if self.is_ip6 else "0.0.0.0",
87 inet=AF_INET6 if self.is_ip6 == 1 else AF_INET)
90 return self.object_id()
93 return ("table-%s-%d" %
94 ("v6" if self.is_ip6 == 1 else "v4",
98 class VppRoutePath(object):
106 nh_via_label=MPLS_LABEL_INVALID,
110 is_resolve_attached=0,
113 next_hop_id=0xffffffff,
114 proto=DpoProto.DPO_PROTO_IP4):
115 self.nh_itf = nh_sw_if_index
116 self.nh_table_id = nh_table_id
117 self.nh_via_label = nh_via_label
118 self.nh_labels = labels
122 if self.proto is DpoProto.DPO_PROTO_IP6:
123 self.nh_addr = inet_pton(AF_INET6, nh_addr)
124 elif self.proto is DpoProto.DPO_PROTO_IP4:
125 self.nh_addr = inet_pton(AF_INET, nh_addr)
127 self.nh_addr = inet_pton(AF_INET6, "::")
128 self.is_resolve_host = is_resolve_host
129 self.is_resolve_attached = is_resolve_attached
130 self.is_interface_rx = is_interface_rx
131 self.is_source_lookup = is_source_lookup
136 self.is_udp_encap = is_udp_encap
137 self.next_hop_id = next_hop_id
140 class VppMRoutePath(VppRoutePath):
142 def __init__(self, nh_sw_if_index, flags,
143 proto=DpoProto.DPO_PROTO_IP4,
145 super(VppMRoutePath, self).__init__(
146 "::" if proto is DpoProto.DPO_PROTO_IP6 else "0.0.0.0",
149 self.nh_i_flags = flags
150 self.bier_imp = bier_imp
153 class VppIpRoute(VppObject):
158 def __init__(self, test, dest_addr,
159 dest_addr_len, paths, table_id=0, is_ip6=0, is_local=0,
160 is_unreach=0, is_prohibit=0):
163 self.dest_addr_len = dest_addr_len
164 self.table_id = table_id
166 self.is_local = is_local
167 self.is_unreach = is_unreach
168 self.is_prohibit = is_prohibit
169 self.dest_addr_p = dest_addr
171 self.dest_addr = inet_pton(AF_INET6, dest_addr)
173 self.dest_addr = inet_pton(AF_INET, dest_addr)
175 def modify(self, paths, is_local=0,
176 is_unreach=0, is_prohibit=0):
178 self.is_local = is_local
179 self.is_unreach = is_unreach
180 self.is_prohibit = is_prohibit
182 def add_vpp_config(self):
183 if self.is_local or self.is_unreach or self.is_prohibit:
184 self._test.vapi.ip_add_del_route(
187 inet_pton(AF_INET6, "::"),
189 is_local=self.is_local,
190 is_unreach=self.is_unreach,
191 is_prohibit=self.is_prohibit,
192 table_id=self.table_id,
195 for path in self.paths:
196 self._test.vapi.ip_add_del_route(
201 table_id=self.table_id,
202 next_hop_out_label_stack=path.nh_labels,
203 next_hop_n_out_labels=len(
205 next_hop_via_label=path.nh_via_label,
206 next_hop_table_id=path.nh_table_id,
207 next_hop_id=path.next_hop_id,
210 if path.proto == DpoProto.DPO_PROTO_ETHERNET else 0,
211 is_resolve_host=path.is_resolve_host,
212 is_resolve_attached=path.is_resolve_attached,
213 is_source_lookup=path.is_source_lookup,
214 is_udp_encap=path.is_udp_encap,
215 is_multipath=1 if len(self.paths) > 1 else 0)
216 self._test.registry.register(self, self._test.logger)
218 def remove_vpp_config(self):
219 if self.is_local or self.is_unreach or self.is_prohibit:
220 self._test.vapi.ip_add_del_route(
223 inet_pton(AF_INET6, "::"),
225 is_local=self.is_local,
226 is_unreach=self.is_unreach,
227 is_prohibit=self.is_prohibit,
229 table_id=self.table_id,
232 for path in self.paths:
233 self._test.vapi.ip_add_del_route(
238 table_id=self.table_id,
239 next_hop_table_id=path.nh_table_id,
240 next_hop_via_label=path.nh_via_label,
241 next_hop_id=path.next_hop_id,
243 is_udp_encap=path.is_udp_encap,
246 def query_vpp_config(self):
247 return find_route(self._test,
251 inet=AF_INET6 if self.is_ip6 == 1 else AF_INET)
254 return self.object_id()
263 class VppIpMRoute(VppObject):
268 def __init__(self, test, src_addr, grp_addr,
269 grp_addr_len, e_flags, paths, table_id=0,
273 self.grp_addr_len = grp_addr_len
274 self.table_id = table_id
275 self.e_flags = e_flags
280 self.grp_addr = inet_pton(AF_INET6, grp_addr)
281 self.src_addr = inet_pton(AF_INET6, src_addr)
283 self.grp_addr = inet_pton(AF_INET, grp_addr)
284 self.src_addr = inet_pton(AF_INET, src_addr)
286 def add_vpp_config(self):
287 for path in self.paths:
288 self._test.vapi.ip_mroute_add_del(self.src_addr,
295 bier_imp=path.bier_imp,
297 table_id=self.table_id,
299 self._test.registry.register(self, self._test.logger)
301 def remove_vpp_config(self):
302 for path in self.paths:
303 self._test.vapi.ip_mroute_add_del(self.src_addr,
310 table_id=self.table_id,
314 def update_entry_flags(self, flags):
316 self._test.vapi.ip_mroute_add_del(self.src_addr,
323 table_id=self.table_id,
326 def update_rpf_id(self, rpf_id):
328 self._test.vapi.ip_mroute_add_del(self.src_addr,
336 table_id=self.table_id,
339 def update_path_flags(self, itf, flags):
340 for path in self.paths:
341 if path.nh_itf == itf:
342 path.nh_i_flags = flags
344 self._test.vapi.ip_mroute_add_del(self.src_addr,
351 table_id=self.table_id,
354 def query_vpp_config(self):
356 dump = self._test.vapi.ip6_mfib_dump()
358 dump = self._test.vapi.ip_mfib_dump()
360 if self.grp_addr == e.grp_address \
361 and self.grp_addr_len == e.address_length \
362 and self.src_addr == e.src_address \
363 and self.table_id == e.table_id:
368 return self.object_id()
372 return ("%d:(%s,%s/%d)"
374 inet_ntop(AF_INET6, self.src_addr),
375 inet_ntop(AF_INET6, self.grp_addr),
378 return ("%d:(%s,%s/%d)"
380 inet_ntop(AF_INET, self.src_addr),
381 inet_ntop(AF_INET, self.grp_addr),
385 class VppMFibSignal(object):
386 def __init__(self, test, route, interface, packet):
388 self.interface = interface
392 def compare(self, signal):
393 self.test.assertEqual(self.interface, signal.sw_if_index)
394 self.test.assertEqual(self.route.table_id, signal.table_id)
395 self.test.assertEqual(self.route.grp_addr_len,
396 signal.grp_address_len)
397 for i in range(self.route.grp_addr_len / 8):
398 self.test.assertEqual(self.route.grp_addr[i],
399 signal.grp_address[i])
400 if (self.route.grp_addr_len > 32):
402 self.test.assertEqual(self.route.src_addr[i],
403 signal.src_address[i])
406 class VppMplsIpBind(VppObject):
411 def __init__(self, test, local_label, dest_addr, dest_addr_len,
412 table_id=0, ip_table_id=0, is_ip6=0):
414 self.dest_addr_len = dest_addr_len
415 self.dest_addr = dest_addr
416 self.local_label = local_label
417 self.table_id = table_id
418 self.ip_table_id = ip_table_id
421 self.dest_addrn = inet_pton(AF_INET6, dest_addr)
423 self.dest_addrn = inet_pton(AF_INET, dest_addr)
425 def add_vpp_config(self):
426 self._test.vapi.mpls_ip_bind_unbind(self.local_label,
429 table_id=self.table_id,
430 ip_table_id=self.ip_table_id,
431 is_ip4=(self.is_ip6 == 0))
432 self._test.registry.register(self, self._test.logger)
434 def remove_vpp_config(self):
435 self._test.vapi.mpls_ip_bind_unbind(self.local_label,
438 table_id=self.table_id,
439 ip_table_id=self.ip_table_id,
441 is_ip4=(self.is_ip6 == 0))
443 def query_vpp_config(self):
444 dump = self._test.vapi.mpls_fib_dump()
446 if self.local_label == e.label \
447 and self.table_id == e.table_id:
452 return self.object_id()
455 return ("%d:%s binds %d:%s/%d"
463 class VppMplsTable(VppObject):
469 self.table_id = table_id
471 def add_vpp_config(self):
472 self._test.vapi.mpls_table_add_del(
475 self._test.registry.register(self, self._test.logger)
477 def remove_vpp_config(self):
478 self._test.vapi.mpls_table_add_del(
482 def query_vpp_config(self):
483 # find the default route
484 dump = self._test.vapi.mpls_fib_dump()
490 return self.object_id()
493 return ("table-mpls-%d" % (self.table_id))
496 class VppMplsRoute(VppObject):
501 def __init__(self, test, local_label, eos_bit, paths, table_id=0,
505 self.local_label = local_label
506 self.eos_bit = eos_bit
507 self.table_id = table_id
508 self.is_multicast = is_multicast
510 def add_vpp_config(self):
511 is_multipath = len(self.paths) > 1
512 for path in self.paths:
513 self._test.vapi.mpls_route_add_del(
519 is_multicast=self.is_multicast,
520 is_multipath=is_multipath,
521 table_id=self.table_id,
522 is_interface_rx=path.is_interface_rx,
523 is_rpf_id=path.is_rpf_id,
524 next_hop_out_label_stack=path.nh_labels,
525 next_hop_n_out_labels=len(
527 next_hop_via_label=path.nh_via_label,
528 next_hop_table_id=path.nh_table_id)
529 self._test.registry.register(self, self._test.logger)
531 def remove_vpp_config(self):
532 for path in self.paths:
533 self._test.vapi.mpls_route_add_del(self.local_label,
538 is_rpf_id=path.is_rpf_id,
539 table_id=self.table_id,
542 def query_vpp_config(self):
543 dump = self._test.vapi.mpls_fib_dump()
545 if self.local_label == e.label \
546 and self.eos_bit == e.eos_bit \
547 and self.table_id == e.table_id:
552 return self.object_id()