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
32 def find_route(test, ip_addr, len, table_id=0, inet=AF_INET):
35 routes = test.vapi.ip_fib_dump()
38 routes = test.vapi.ip6_fib_dump()
40 route_addr = inet_pton(inet, ip_addr)
42 if route_addr == e.address[:s] \
43 and len == e.address_length \
44 and table_id == e.table_id:
49 class VppRoutePath(object):
57 nh_via_label=MPLS_LABEL_INVALID,
62 is_resolve_attached=0):
63 self.nh_itf = nh_sw_if_index
64 self.nh_table_id = nh_table_id
65 self.nh_via_label = nh_via_label
66 self.nh_labels = labels
70 self.nh_addr = inet_pton(AF_INET6, nh_addr)
72 self.nh_addr = inet_pton(AF_INET, nh_addr)
73 self.is_resolve_host = is_resolve_host
74 self.is_resolve_attached = is_resolve_attached
75 self.is_interface_rx = is_interface_rx
82 class VppMRoutePath(VppRoutePath):
84 def __init__(self, nh_sw_if_index, flags):
85 super(VppMRoutePath, self).__init__("0.0.0.0",
87 self.nh_i_flags = flags
90 class VppIpRoute(VppObject):
95 def __init__(self, test, dest_addr,
96 dest_addr_len, paths, table_id=0, is_ip6=0, is_local=0,
97 is_unreach=0, is_prohibit=0):
100 self.dest_addr_len = dest_addr_len
101 self.table_id = table_id
103 self.is_local = is_local
104 self.is_unreach = is_unreach
105 self.is_prohibit = is_prohibit
106 self.dest_addr_p = dest_addr
108 self.dest_addr = inet_pton(AF_INET6, dest_addr)
110 self.dest_addr = inet_pton(AF_INET, dest_addr)
112 def modify(self, paths, is_local=0,
113 is_unreach=0, is_prohibit=0):
115 self.is_local = is_local
116 self.is_unreach = is_unreach
117 self.is_prohibit = is_prohibit
119 def add_vpp_config(self):
120 if self.is_local or self.is_unreach or self.is_prohibit:
121 self._test.vapi.ip_add_del_route(
124 inet_pton(AF_INET6, "::"),
126 is_local=self.is_local,
127 is_unreach=self.is_unreach,
128 is_prohibit=self.is_prohibit,
129 table_id=self.table_id,
132 for path in self.paths:
133 self._test.vapi.ip_add_del_route(
138 table_id=self.table_id,
139 next_hop_out_label_stack=path.nh_labels,
140 next_hop_n_out_labels=len(
142 next_hop_via_label=path.nh_via_label,
143 next_hop_table_id=path.nh_table_id,
145 is_resolve_host=path.is_resolve_host,
146 is_resolve_attached=path.is_resolve_attached,
147 is_multipath=1 if len(self.paths) > 1 else 0)
148 self._test.registry.register(self, self._test.logger)
150 def remove_vpp_config(self):
151 if self.is_local or self.is_unreach or self.is_prohibit:
152 self._test.vapi.ip_add_del_route(
155 inet_pton(AF_INET6, "::"),
157 is_local=self.is_local,
158 is_unreach=self.is_unreach,
159 is_prohibit=self.is_prohibit,
161 table_id=self.table_id,
164 for path in self.paths:
165 self._test.vapi.ip_add_del_route(
170 table_id=self.table_id,
171 next_hop_table_id=path.nh_table_id,
172 next_hop_via_label=path.nh_via_label,
176 def query_vpp_config(self):
177 return find_route(self._test,
181 inet=AF_INET6 if self.is_ip6 == 1 else AF_INET)
184 return self.object_id()
193 class VppIpMRoute(VppObject):
198 def __init__(self, test, src_addr, grp_addr,
199 grp_addr_len, e_flags, paths, table_id=0,
203 self.grp_addr_len = grp_addr_len
204 self.table_id = table_id
205 self.e_flags = e_flags
210 self.grp_addr = inet_pton(AF_INET6, grp_addr)
211 self.src_addr = inet_pton(AF_INET6, src_addr)
213 self.grp_addr = inet_pton(AF_INET, grp_addr)
214 self.src_addr = inet_pton(AF_INET, src_addr)
216 def add_vpp_config(self):
217 for path in self.paths:
218 self._test.vapi.ip_mroute_add_del(self.src_addr,
225 table_id=self.table_id,
227 self._test.registry.register(self, self._test.logger)
229 def remove_vpp_config(self):
230 for path in self.paths:
231 self._test.vapi.ip_mroute_add_del(self.src_addr,
237 table_id=self.table_id,
241 def update_entry_flags(self, flags):
243 self._test.vapi.ip_mroute_add_del(self.src_addr,
249 table_id=self.table_id,
252 def update_rpf_id(self, rpf_id):
254 self._test.vapi.ip_mroute_add_del(self.src_addr,
261 table_id=self.table_id,
264 def update_path_flags(self, itf, flags):
265 for path in self.paths:
266 if path.nh_itf == itf:
267 path.nh_i_flags = flags
269 self._test.vapi.ip_mroute_add_del(self.src_addr,
275 table_id=self.table_id,
278 def query_vpp_config(self):
279 dump = self._test.vapi.ip_fib_dump()
281 if self.grp_addr == e.address \
282 and self.grp_addr_len == e.address_length \
283 and self.table_id == e.table_id:
288 return self.object_id()
292 return ("%d:(%s,%s/%d)"
294 inet_ntop(AF_INET6, self.src_addr),
295 inet_ntop(AF_INET6, self.grp_addr),
298 return ("%d:(%s,%s/%d)"
300 inet_ntop(AF_INET, self.src_addr),
301 inet_ntop(AF_INET, self.grp_addr),
305 class VppMFibSignal(object):
306 def __init__(self, test, route, interface, packet):
308 self.interface = interface
312 def compare(self, signal):
313 self.test.assertEqual(self.interface, signal.sw_if_index)
314 self.test.assertEqual(self.route.table_id, signal.table_id)
315 self.test.assertEqual(self.route.grp_addr_len,
316 signal.grp_address_len)
317 for i in range(self.route.grp_addr_len / 8):
318 self.test.assertEqual(self.route.grp_addr[i],
319 signal.grp_address[i])
320 if (self.route.grp_addr_len > 32):
322 self.test.assertEqual(self.route.src_addr[i],
323 signal.src_address[i])
326 class VppMplsIpBind(VppObject):
331 def __init__(self, test, local_label, dest_addr, dest_addr_len,
332 table_id=0, ip_table_id=0, is_ip6=0):
334 self.dest_addr_len = dest_addr_len
335 self.dest_addr = dest_addr
336 self.local_label = local_label
337 self.table_id = table_id
338 self.ip_table_id = ip_table_id
341 self.dest_addrn = inet_pton(AF_INET6, dest_addr)
343 self.dest_addrn = inet_pton(AF_INET, dest_addr)
345 def add_vpp_config(self):
346 self._test.vapi.mpls_ip_bind_unbind(self.local_label,
349 table_id=self.table_id,
350 ip_table_id=self.ip_table_id,
351 is_ip4=(self.is_ip6 == 0))
352 self._test.registry.register(self, self._test.logger)
354 def remove_vpp_config(self):
355 self._test.vapi.mpls_ip_bind_unbind(self.local_label,
358 table_id=self.table_id,
359 ip_table_id=self.ip_table_id,
361 is_ip4=(self.is_ip6 == 0))
363 def query_vpp_config(self):
364 dump = self._test.vapi.mpls_fib_dump()
366 if self.local_label == e.label \
367 and self.table_id == e.table_id:
372 return self.object_id()
375 return ("%d:%s binds %d:%s/%d"
383 class VppMplsRoute(VppObject):
388 def __init__(self, test, local_label, eos_bit, paths, table_id=0,
392 self.local_label = local_label
393 self.eos_bit = eos_bit
394 self.table_id = table_id
395 self.is_multicast = is_multicast
397 def add_vpp_config(self):
398 is_multipath = len(self.paths) > 1
399 for path in self.paths:
400 self._test.vapi.mpls_route_add_del(
406 is_multicast=self.is_multicast,
407 is_multipath=is_multipath,
408 table_id=self.table_id,
409 is_interface_rx=path.is_interface_rx,
410 is_rpf_id=path.is_rpf_id,
411 next_hop_out_label_stack=path.nh_labels,
412 next_hop_n_out_labels=len(
414 next_hop_via_label=path.nh_via_label,
415 next_hop_table_id=path.nh_table_id)
416 self._test.registry.register(self, self._test.logger)
418 def remove_vpp_config(self):
419 for path in self.paths:
420 self._test.vapi.mpls_route_add_del(self.local_label,
425 is_rpf_id=path.is_rpf_id,
426 table_id=self.table_id,
429 def query_vpp_config(self):
430 dump = self._test.vapi.mpls_fib_dump()
432 if self.local_label == e.label \
433 and self.eos_bit == e.eos_bit \
434 and self.table_id == e.table_id:
439 return self.object_id()