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
40 def find_route(test, ip_addr, len, table_id=0, inet=AF_INET):
43 routes = test.vapi.ip_fib_dump()
46 routes = test.vapi.ip6_fib_dump()
48 route_addr = inet_pton(inet, ip_addr)
50 if route_addr == e.address[:s] \
51 and len == e.address_length \
52 and table_id == e.table_id:
57 class VppIpTable(VppObject):
64 self.table_id = table_id
67 def add_vpp_config(self):
68 self._test.vapi.ip_table_add_del(
72 self._test.registry.register(self, self._test.logger)
74 def remove_vpp_config(self):
75 self._test.vapi.ip_table_add_del(
80 def query_vpp_config(self):
81 # find the default route
82 return find_route(self._test,
83 "::" if self.is_ip6 else "0.0.0.0",
86 inet=AF_INET6 if self.is_ip6 == 1 else AF_INET)
89 return self.object_id()
92 return ("table-%s-%d" %
93 ("v6" if self.is_ip6 == 1 else "v4",
97 class VppRoutePath(object):
105 nh_via_label=MPLS_LABEL_INVALID,
109 is_resolve_attached=0,
110 proto=DpoProto.DPO_PROTO_IP4):
111 self.nh_itf = nh_sw_if_index
112 self.nh_table_id = nh_table_id
113 self.nh_via_label = nh_via_label
114 self.nh_labels = labels
118 if self.proto is DpoProto.DPO_PROTO_IP6:
119 self.nh_addr = inet_pton(AF_INET6, nh_addr)
120 elif self.proto is DpoProto.DPO_PROTO_IP4:
121 self.nh_addr = inet_pton(AF_INET, nh_addr)
123 self.nh_addr = inet_pton(AF_INET6, "::")
124 self.is_resolve_host = is_resolve_host
125 self.is_resolve_attached = is_resolve_attached
126 self.is_interface_rx = is_interface_rx
133 class VppMRoutePath(VppRoutePath):
135 def __init__(self, nh_sw_if_index, flags):
136 super(VppMRoutePath, self).__init__("0.0.0.0",
138 self.nh_i_flags = flags
141 class VppIpRoute(VppObject):
146 def __init__(self, test, dest_addr,
147 dest_addr_len, paths, table_id=0, is_ip6=0, is_local=0,
148 is_unreach=0, is_prohibit=0):
151 self.dest_addr_len = dest_addr_len
152 self.table_id = table_id
154 self.is_local = is_local
155 self.is_unreach = is_unreach
156 self.is_prohibit = is_prohibit
157 self.dest_addr_p = dest_addr
159 self.dest_addr = inet_pton(AF_INET6, dest_addr)
161 self.dest_addr = inet_pton(AF_INET, dest_addr)
163 def modify(self, paths, is_local=0,
164 is_unreach=0, is_prohibit=0):
166 self.is_local = is_local
167 self.is_unreach = is_unreach
168 self.is_prohibit = is_prohibit
170 def add_vpp_config(self):
171 if self.is_local or self.is_unreach or self.is_prohibit:
172 self._test.vapi.ip_add_del_route(
175 inet_pton(AF_INET6, "::"),
177 is_local=self.is_local,
178 is_unreach=self.is_unreach,
179 is_prohibit=self.is_prohibit,
180 table_id=self.table_id,
183 for path in self.paths:
184 self._test.vapi.ip_add_del_route(
189 table_id=self.table_id,
190 next_hop_out_label_stack=path.nh_labels,
191 next_hop_n_out_labels=len(
193 next_hop_via_label=path.nh_via_label,
194 next_hop_table_id=path.nh_table_id,
196 is_resolve_host=path.is_resolve_host,
197 is_resolve_attached=path.is_resolve_attached,
198 is_multipath=1 if len(self.paths) > 1 else 0)
199 self._test.registry.register(self, self._test.logger)
201 def remove_vpp_config(self):
202 if self.is_local or self.is_unreach or self.is_prohibit:
203 self._test.vapi.ip_add_del_route(
206 inet_pton(AF_INET6, "::"),
208 is_local=self.is_local,
209 is_unreach=self.is_unreach,
210 is_prohibit=self.is_prohibit,
212 table_id=self.table_id,
215 for path in self.paths:
216 self._test.vapi.ip_add_del_route(
221 table_id=self.table_id,
222 next_hop_table_id=path.nh_table_id,
223 next_hop_via_label=path.nh_via_label,
227 def query_vpp_config(self):
228 return find_route(self._test,
232 inet=AF_INET6 if self.is_ip6 == 1 else AF_INET)
235 return self.object_id()
244 class VppIpMRoute(VppObject):
249 def __init__(self, test, src_addr, grp_addr,
250 grp_addr_len, e_flags, paths, table_id=0,
254 self.grp_addr_len = grp_addr_len
255 self.table_id = table_id
256 self.e_flags = e_flags
261 self.grp_addr = inet_pton(AF_INET6, grp_addr)
262 self.src_addr = inet_pton(AF_INET6, src_addr)
264 self.grp_addr = inet_pton(AF_INET, grp_addr)
265 self.src_addr = inet_pton(AF_INET, src_addr)
267 def add_vpp_config(self):
268 for path in self.paths:
269 self._test.vapi.ip_mroute_add_del(self.src_addr,
276 table_id=self.table_id,
278 self._test.registry.register(self, self._test.logger)
280 def remove_vpp_config(self):
281 for path in self.paths:
282 self._test.vapi.ip_mroute_add_del(self.src_addr,
288 table_id=self.table_id,
292 def update_entry_flags(self, flags):
294 self._test.vapi.ip_mroute_add_del(self.src_addr,
300 table_id=self.table_id,
303 def update_rpf_id(self, rpf_id):
305 self._test.vapi.ip_mroute_add_del(self.src_addr,
312 table_id=self.table_id,
315 def update_path_flags(self, itf, flags):
316 for path in self.paths:
317 if path.nh_itf == itf:
318 path.nh_i_flags = flags
320 self._test.vapi.ip_mroute_add_del(self.src_addr,
326 table_id=self.table_id,
329 def query_vpp_config(self):
330 dump = self._test.vapi.ip_fib_dump()
332 if self.grp_addr == e.address \
333 and self.grp_addr_len == e.address_length \
334 and self.table_id == e.table_id:
339 return self.object_id()
343 return ("%d:(%s,%s/%d)"
345 inet_ntop(AF_INET6, self.src_addr),
346 inet_ntop(AF_INET6, self.grp_addr),
349 return ("%d:(%s,%s/%d)"
351 inet_ntop(AF_INET, self.src_addr),
352 inet_ntop(AF_INET, self.grp_addr),
356 class VppMFibSignal(object):
357 def __init__(self, test, route, interface, packet):
359 self.interface = interface
363 def compare(self, signal):
364 self.test.assertEqual(self.interface, signal.sw_if_index)
365 self.test.assertEqual(self.route.table_id, signal.table_id)
366 self.test.assertEqual(self.route.grp_addr_len,
367 signal.grp_address_len)
368 for i in range(self.route.grp_addr_len / 8):
369 self.test.assertEqual(self.route.grp_addr[i],
370 signal.grp_address[i])
371 if (self.route.grp_addr_len > 32):
373 self.test.assertEqual(self.route.src_addr[i],
374 signal.src_address[i])
377 class VppMplsIpBind(VppObject):
382 def __init__(self, test, local_label, dest_addr, dest_addr_len,
383 table_id=0, ip_table_id=0, is_ip6=0):
385 self.dest_addr_len = dest_addr_len
386 self.dest_addr = dest_addr
387 self.local_label = local_label
388 self.table_id = table_id
389 self.ip_table_id = ip_table_id
392 self.dest_addrn = inet_pton(AF_INET6, dest_addr)
394 self.dest_addrn = inet_pton(AF_INET, dest_addr)
396 def add_vpp_config(self):
397 self._test.vapi.mpls_ip_bind_unbind(self.local_label,
400 table_id=self.table_id,
401 ip_table_id=self.ip_table_id,
402 is_ip4=(self.is_ip6 == 0))
403 self._test.registry.register(self, self._test.logger)
405 def remove_vpp_config(self):
406 self._test.vapi.mpls_ip_bind_unbind(self.local_label,
409 table_id=self.table_id,
410 ip_table_id=self.ip_table_id,
412 is_ip4=(self.is_ip6 == 0))
414 def query_vpp_config(self):
415 dump = self._test.vapi.mpls_fib_dump()
417 if self.local_label == e.label \
418 and self.table_id == e.table_id:
423 return self.object_id()
426 return ("%d:%s binds %d:%s/%d"
434 class VppMplsTable(VppObject):
440 self.table_id = table_id
442 def add_vpp_config(self):
443 self._test.vapi.mpls_table_add_del(
446 self._test.registry.register(self, self._test.logger)
448 def remove_vpp_config(self):
449 self._test.vapi.mpls_table_add_del(
453 def query_vpp_config(self):
454 # find the default route
455 dump = self._test.vapi.mpls_fib_dump()
461 return self.object_id()
464 return ("table-mpls-%d" % (self.table_id))
467 class VppMplsRoute(VppObject):
472 def __init__(self, test, local_label, eos_bit, paths, table_id=0,
476 self.local_label = local_label
477 self.eos_bit = eos_bit
478 self.table_id = table_id
479 self.is_multicast = is_multicast
481 def add_vpp_config(self):
482 is_multipath = len(self.paths) > 1
483 for path in self.paths:
484 self._test.vapi.mpls_route_add_del(
490 is_multicast=self.is_multicast,
491 is_multipath=is_multipath,
492 table_id=self.table_id,
493 is_interface_rx=path.is_interface_rx,
494 is_rpf_id=path.is_rpf_id,
495 next_hop_out_label_stack=path.nh_labels,
496 next_hop_n_out_labels=len(
498 next_hop_via_label=path.nh_via_label,
499 next_hop_table_id=path.nh_table_id)
500 self._test.registry.register(self, self._test.logger)
502 def remove_vpp_config(self):
503 for path in self.paths:
504 self._test.vapi.mpls_route_add_del(self.local_label,
509 is_rpf_id=path.is_rpf_id,
510 table_id=self.table_id,
513 def query_vpp_config(self):
514 dump = self._test.vapi.mpls_fib_dump()
516 if self.local_label == e.label \
517 and self.eos_bit == e.eos_bit \
518 and self.table_id == e.table_id:
523 return self.object_id()