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
69 self.is_ip4 = 1 if is_ip6 == 0 else 0
71 self.nh_addr = inet_pton(AF_INET, nh_addr)
73 self.nh_addr = inet_pton(AF_INET6, nh_addr)
74 self.is_resolve_host = is_resolve_host
75 self.is_resolve_attached = is_resolve_attached
76 self.is_interface_rx = is_interface_rx
83 class VppMRoutePath(VppRoutePath):
85 def __init__(self, nh_sw_if_index, flags):
86 super(VppMRoutePath, self).__init__("0.0.0.0",
88 self.nh_i_flags = flags
91 class VppIpRoute(VppObject):
96 def __init__(self, test, dest_addr,
97 dest_addr_len, paths, table_id=0, is_ip6=0, is_local=0,
98 is_unreach=0, is_prohibit=0):
101 self.dest_addr_len = dest_addr_len
102 self.table_id = table_id
104 self.is_local = is_local
105 self.is_unreach = is_unreach
106 self.is_prohibit = is_prohibit
107 self.dest_addr_p = dest_addr
109 self.dest_addr = inet_pton(AF_INET6, dest_addr)
111 self.dest_addr = inet_pton(AF_INET, dest_addr)
113 def modify(self, paths, is_local=0,
114 is_unreach=0, is_prohibit=0):
116 self.is_local = is_local
117 self.is_unreach = is_unreach
118 self.is_prohibit = is_prohibit
120 def add_vpp_config(self):
121 if self.is_local or self.is_unreach or self.is_prohibit:
122 self._test.vapi.ip_add_del_route(
125 inet_pton(AF_INET6, "::"),
127 is_local=self.is_local,
128 is_unreach=self.is_unreach,
129 is_prohibit=self.is_prohibit,
130 table_id=self.table_id,
133 for path in self.paths:
134 self._test.vapi.ip_add_del_route(
139 table_id=self.table_id,
140 next_hop_out_label_stack=path.nh_labels,
141 next_hop_n_out_labels=len(
143 next_hop_via_label=path.nh_via_label,
144 next_hop_table_id=path.nh_table_id,
146 is_resolve_host=path.is_resolve_host,
147 is_resolve_attached=path.is_resolve_attached,
148 is_multipath=1 if len(self.paths) > 1 else 0)
149 self._test.registry.register(self, self._test.logger)
151 def remove_vpp_config(self):
152 if self.is_local or self.is_unreach or self.is_prohibit:
153 self._test.vapi.ip_add_del_route(
156 inet_pton(AF_INET6, "::"),
158 is_local=self.is_local,
159 is_unreach=self.is_unreach,
160 is_prohibit=self.is_prohibit,
162 table_id=self.table_id,
165 for path in self.paths:
166 self._test.vapi.ip_add_del_route(
171 table_id=self.table_id,
172 next_hop_table_id=path.nh_table_id,
173 next_hop_via_label=path.nh_via_label,
177 def query_vpp_config(self):
178 return find_route(self._test,
182 inet=AF_INET6 if self.is_ip6 == 1 else AF_INET)
185 return self.object_id()
194 class VppIpMRoute(VppObject):
199 def __init__(self, test, src_addr, grp_addr,
200 grp_addr_len, e_flags, paths, table_id=0,
204 self.grp_addr_len = grp_addr_len
205 self.table_id = table_id
206 self.e_flags = e_flags
211 self.grp_addr = inet_pton(AF_INET6, grp_addr)
212 self.src_addr = inet_pton(AF_INET6, src_addr)
214 self.grp_addr = inet_pton(AF_INET, grp_addr)
215 self.src_addr = inet_pton(AF_INET, src_addr)
217 def add_vpp_config(self):
218 for path in self.paths:
219 self._test.vapi.ip_mroute_add_del(self.src_addr,
226 table_id=self.table_id,
228 self._test.registry.register(self, self._test.logger)
230 def remove_vpp_config(self):
231 for path in self.paths:
232 self._test.vapi.ip_mroute_add_del(self.src_addr,
238 table_id=self.table_id,
242 def update_entry_flags(self, flags):
244 self._test.vapi.ip_mroute_add_del(self.src_addr,
250 table_id=self.table_id,
253 def update_rpf_id(self, rpf_id):
255 self._test.vapi.ip_mroute_add_del(self.src_addr,
262 table_id=self.table_id,
265 def update_path_flags(self, itf, flags):
266 for path in self.paths:
267 if path.nh_itf == itf:
268 path.nh_i_flags = flags
270 self._test.vapi.ip_mroute_add_del(self.src_addr,
276 table_id=self.table_id,
279 def query_vpp_config(self):
280 dump = self._test.vapi.ip_fib_dump()
282 if self.grp_addr == e.address \
283 and self.grp_addr_len == e.address_length \
284 and self.table_id == e.table_id:
289 return self.object_id()
293 return ("%d:(%s,%s/%d)"
295 inet_ntop(AF_INET6, self.src_addr),
296 inet_ntop(AF_INET6, self.grp_addr),
299 return ("%d:(%s,%s/%d)"
301 inet_ntop(AF_INET, self.src_addr),
302 inet_ntop(AF_INET, self.grp_addr),
306 class VppMFibSignal(object):
307 def __init__(self, test, route, interface, packet):
309 self.interface = interface
313 def compare(self, signal):
314 self.test.assertEqual(self.interface, signal.sw_if_index)
315 self.test.assertEqual(self.route.table_id, signal.table_id)
316 self.test.assertEqual(self.route.grp_addr_len,
317 signal.grp_address_len)
318 for i in range(self.route.grp_addr_len / 8):
319 self.test.assertEqual(self.route.grp_addr[i],
320 signal.grp_address[i])
321 if (self.route.grp_addr_len > 32):
323 self.test.assertEqual(self.route.src_addr[i],
324 signal.src_address[i])
327 class VppMplsIpBind(VppObject):
332 def __init__(self, test, local_label, dest_addr, dest_addr_len,
333 table_id=0, ip_table_id=0, is_ip6=0):
335 self.dest_addr_len = dest_addr_len
336 self.dest_addr = dest_addr
337 self.local_label = local_label
338 self.table_id = table_id
339 self.ip_table_id = ip_table_id
342 self.dest_addrn = inet_pton(AF_INET6, dest_addr)
344 self.dest_addrn = inet_pton(AF_INET, dest_addr)
346 def add_vpp_config(self):
347 self._test.vapi.mpls_ip_bind_unbind(self.local_label,
350 table_id=self.table_id,
351 ip_table_id=self.ip_table_id,
352 is_ip4=(self.is_ip6 == 0))
353 self._test.registry.register(self, self._test.logger)
355 def remove_vpp_config(self):
356 self._test.vapi.mpls_ip_bind_unbind(self.local_label,
359 table_id=self.table_id,
360 ip_table_id=self.ip_table_id,
362 is_ip4=(self.is_ip6 == 0))
364 def query_vpp_config(self):
365 dump = self._test.vapi.mpls_fib_dump()
367 if self.local_label == e.label \
368 and self.table_id == e.table_id:
373 return self.object_id()
376 return ("%d:%s binds %d:%s/%d"
384 class VppMplsRoute(VppObject):
389 def __init__(self, test, local_label, eos_bit, paths, table_id=0,
393 self.local_label = local_label
394 self.eos_bit = eos_bit
395 self.table_id = table_id
396 self.is_multicast = is_multicast
398 def add_vpp_config(self):
399 is_multipath = len(self.paths) > 1
400 for path in self.paths:
401 self._test.vapi.mpls_route_add_del(
407 is_multicast=self.is_multicast,
408 is_multipath=is_multipath,
409 table_id=self.table_id,
410 is_interface_rx=path.is_interface_rx,
411 is_rpf_id=path.is_rpf_id,
412 next_hop_out_label_stack=path.nh_labels,
413 next_hop_n_out_labels=len(
415 next_hop_via_label=path.nh_via_label,
416 next_hop_table_id=path.nh_table_id)
417 self._test.registry.register(self, self._test.logger)
419 def remove_vpp_config(self):
420 for path in self.paths:
421 self._test.vapi.mpls_route_add_del(self.local_label,
426 is_rpf_id=path.is_rpf_id,
427 table_id=self.table_id,
430 def query_vpp_config(self):
431 dump = self._test.vapi.mpls_fib_dump()
433 if self.local_label == e.label \
434 and self.eos_bit == e.eos_bit \
435 and self.table_id == e.table_id:
440 return self.object_id()