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,
197 if path.proto == DpoProto.DPO_PROTO_ETHERNET else 0,
198 is_resolve_host=path.is_resolve_host,
199 is_resolve_attached=path.is_resolve_attached,
200 is_multipath=1 if len(self.paths) > 1 else 0)
201 self._test.registry.register(self, self._test.logger)
203 def remove_vpp_config(self):
204 if self.is_local or self.is_unreach or self.is_prohibit:
205 self._test.vapi.ip_add_del_route(
208 inet_pton(AF_INET6, "::"),
210 is_local=self.is_local,
211 is_unreach=self.is_unreach,
212 is_prohibit=self.is_prohibit,
214 table_id=self.table_id,
217 for path in self.paths:
218 self._test.vapi.ip_add_del_route(
223 table_id=self.table_id,
224 next_hop_table_id=path.nh_table_id,
225 next_hop_via_label=path.nh_via_label,
229 def query_vpp_config(self):
230 return find_route(self._test,
234 inet=AF_INET6 if self.is_ip6 == 1 else AF_INET)
237 return self.object_id()
246 class VppIpMRoute(VppObject):
251 def __init__(self, test, src_addr, grp_addr,
252 grp_addr_len, e_flags, paths, table_id=0,
256 self.grp_addr_len = grp_addr_len
257 self.table_id = table_id
258 self.e_flags = e_flags
263 self.grp_addr = inet_pton(AF_INET6, grp_addr)
264 self.src_addr = inet_pton(AF_INET6, src_addr)
266 self.grp_addr = inet_pton(AF_INET, grp_addr)
267 self.src_addr = inet_pton(AF_INET, src_addr)
269 def add_vpp_config(self):
270 for path in self.paths:
271 self._test.vapi.ip_mroute_add_del(self.src_addr,
278 table_id=self.table_id,
280 self._test.registry.register(self, self._test.logger)
282 def remove_vpp_config(self):
283 for path in self.paths:
284 self._test.vapi.ip_mroute_add_del(self.src_addr,
290 table_id=self.table_id,
294 def update_entry_flags(self, flags):
296 self._test.vapi.ip_mroute_add_del(self.src_addr,
302 table_id=self.table_id,
305 def update_rpf_id(self, rpf_id):
307 self._test.vapi.ip_mroute_add_del(self.src_addr,
314 table_id=self.table_id,
317 def update_path_flags(self, itf, flags):
318 for path in self.paths:
319 if path.nh_itf == itf:
320 path.nh_i_flags = flags
322 self._test.vapi.ip_mroute_add_del(self.src_addr,
328 table_id=self.table_id,
331 def query_vpp_config(self):
332 dump = self._test.vapi.ip_fib_dump()
334 if self.grp_addr == e.address \
335 and self.grp_addr_len == e.address_length \
336 and self.table_id == e.table_id:
341 return self.object_id()
345 return ("%d:(%s,%s/%d)"
347 inet_ntop(AF_INET6, self.src_addr),
348 inet_ntop(AF_INET6, self.grp_addr),
351 return ("%d:(%s,%s/%d)"
353 inet_ntop(AF_INET, self.src_addr),
354 inet_ntop(AF_INET, self.grp_addr),
358 class VppMFibSignal(object):
359 def __init__(self, test, route, interface, packet):
361 self.interface = interface
365 def compare(self, signal):
366 self.test.assertEqual(self.interface, signal.sw_if_index)
367 self.test.assertEqual(self.route.table_id, signal.table_id)
368 self.test.assertEqual(self.route.grp_addr_len,
369 signal.grp_address_len)
370 for i in range(self.route.grp_addr_len / 8):
371 self.test.assertEqual(self.route.grp_addr[i],
372 signal.grp_address[i])
373 if (self.route.grp_addr_len > 32):
375 self.test.assertEqual(self.route.src_addr[i],
376 signal.src_address[i])
379 class VppMplsIpBind(VppObject):
384 def __init__(self, test, local_label, dest_addr, dest_addr_len,
385 table_id=0, ip_table_id=0, is_ip6=0):
387 self.dest_addr_len = dest_addr_len
388 self.dest_addr = dest_addr
389 self.local_label = local_label
390 self.table_id = table_id
391 self.ip_table_id = ip_table_id
394 self.dest_addrn = inet_pton(AF_INET6, dest_addr)
396 self.dest_addrn = inet_pton(AF_INET, dest_addr)
398 def add_vpp_config(self):
399 self._test.vapi.mpls_ip_bind_unbind(self.local_label,
402 table_id=self.table_id,
403 ip_table_id=self.ip_table_id,
404 is_ip4=(self.is_ip6 == 0))
405 self._test.registry.register(self, self._test.logger)
407 def remove_vpp_config(self):
408 self._test.vapi.mpls_ip_bind_unbind(self.local_label,
411 table_id=self.table_id,
412 ip_table_id=self.ip_table_id,
414 is_ip4=(self.is_ip6 == 0))
416 def query_vpp_config(self):
417 dump = self._test.vapi.mpls_fib_dump()
419 if self.local_label == e.label \
420 and self.table_id == e.table_id:
425 return self.object_id()
428 return ("%d:%s binds %d:%s/%d"
436 class VppMplsTable(VppObject):
442 self.table_id = table_id
444 def add_vpp_config(self):
445 self._test.vapi.mpls_table_add_del(
448 self._test.registry.register(self, self._test.logger)
450 def remove_vpp_config(self):
451 self._test.vapi.mpls_table_add_del(
455 def query_vpp_config(self):
456 # find the default route
457 dump = self._test.vapi.mpls_fib_dump()
463 return self.object_id()
466 return ("table-mpls-%d" % (self.table_id))
469 class VppMplsRoute(VppObject):
474 def __init__(self, test, local_label, eos_bit, paths, table_id=0,
478 self.local_label = local_label
479 self.eos_bit = eos_bit
480 self.table_id = table_id
481 self.is_multicast = is_multicast
483 def add_vpp_config(self):
484 is_multipath = len(self.paths) > 1
485 for path in self.paths:
486 self._test.vapi.mpls_route_add_del(
492 is_multicast=self.is_multicast,
493 is_multipath=is_multipath,
494 table_id=self.table_id,
495 is_interface_rx=path.is_interface_rx,
496 is_rpf_id=path.is_rpf_id,
497 next_hop_out_label_stack=path.nh_labels,
498 next_hop_n_out_labels=len(
500 next_hop_via_label=path.nh_via_label,
501 next_hop_table_id=path.nh_table_id)
502 self._test.registry.register(self, self._test.logger)
504 def remove_vpp_config(self):
505 for path in self.paths:
506 self._test.vapi.mpls_route_add_del(self.local_label,
511 is_rpf_id=path.is_rpf_id,
512 table_id=self.table_id,
515 def query_vpp_config(self):
516 dump = self._test.vapi.mpls_fib_dump()
518 if self.local_label == e.label \
519 and self.eos_bit == e.eos_bit \
520 and self.table_id == e.table_id:
525 return self.object_id()