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,
61 self.nh_itf = nh_sw_if_index
62 self.nh_table_id = nh_table_id
63 self.nh_via_label = nh_via_label
64 self.nh_labels = labels
68 self.nh_addr = inet_pton(AF_INET6, nh_addr)
70 self.nh_addr = inet_pton(AF_INET, nh_addr)
71 self.is_interface_rx = is_interface_rx
78 class VppMRoutePath(VppRoutePath):
80 def __init__(self, nh_sw_if_index, flags):
81 super(VppMRoutePath, self).__init__("0.0.0.0",
83 self.nh_i_flags = flags
86 class VppIpRoute(VppObject):
91 def __init__(self, test, dest_addr,
92 dest_addr_len, paths, table_id=0, is_ip6=0, is_local=0,
93 is_unreach=0, is_prohibit=0):
96 self.dest_addr_len = dest_addr_len
97 self.table_id = table_id
99 self.is_local = is_local
100 self.is_unreach = is_unreach
101 self.is_prohibit = is_prohibit
102 self.dest_addr_p = dest_addr
104 self.dest_addr = inet_pton(AF_INET6, dest_addr)
106 self.dest_addr = inet_pton(AF_INET, dest_addr)
108 def modify(self, paths, is_local=0,
109 is_unreach=0, is_prohibit=0):
111 self.is_local = is_local
112 self.is_unreach = is_unreach
113 self.is_prohibit = is_prohibit
115 def add_vpp_config(self):
116 if self.is_local or self.is_unreach or self.is_prohibit:
117 self._test.vapi.ip_add_del_route(
120 inet_pton(AF_INET6, "::"),
122 is_local=self.is_local,
123 is_unreach=self.is_unreach,
124 is_prohibit=self.is_prohibit,
125 table_id=self.table_id,
128 for path in self.paths:
129 self._test.vapi.ip_add_del_route(
134 table_id=self.table_id,
135 next_hop_out_label_stack=path.nh_labels,
136 next_hop_n_out_labels=len(
138 next_hop_via_label=path.nh_via_label,
140 self._test.registry.register(self, self._test.logger)
142 def remove_vpp_config(self):
143 if self.is_local or self.is_unreach or self.is_prohibit:
144 self._test.vapi.ip_add_del_route(
147 inet_pton(AF_INET6, "::"),
149 is_local=self.is_local,
150 is_unreach=self.is_unreach,
151 is_prohibit=self.is_prohibit,
153 table_id=self.table_id,
156 for path in self.paths:
157 self._test.vapi.ip_add_del_route(self.dest_addr,
161 table_id=self.table_id,
165 def query_vpp_config(self):
166 return find_route(self._test,
170 inet=AF_INET6 if self.is_ip6 == 1 else AF_INET)
173 return self.object_id()
182 class VppIpMRoute(VppObject):
187 def __init__(self, test, src_addr, grp_addr,
188 grp_addr_len, e_flags, paths, table_id=0,
192 self.grp_addr_len = grp_addr_len
193 self.table_id = table_id
194 self.e_flags = e_flags
199 self.grp_addr = inet_pton(AF_INET6, grp_addr)
200 self.src_addr = inet_pton(AF_INET6, src_addr)
202 self.grp_addr = inet_pton(AF_INET, grp_addr)
203 self.src_addr = inet_pton(AF_INET, src_addr)
205 def add_vpp_config(self):
206 for path in self.paths:
207 self._test.vapi.ip_mroute_add_del(self.src_addr,
214 table_id=self.table_id,
216 self._test.registry.register(self, self._test.logger)
218 def remove_vpp_config(self):
219 for path in self.paths:
220 self._test.vapi.ip_mroute_add_del(self.src_addr,
226 table_id=self.table_id,
230 def update_entry_flags(self, flags):
232 self._test.vapi.ip_mroute_add_del(self.src_addr,
238 table_id=self.table_id,
241 def update_rpf_id(self, rpf_id):
243 self._test.vapi.ip_mroute_add_del(self.src_addr,
250 table_id=self.table_id,
253 def update_path_flags(self, itf, flags):
254 for path in self.paths:
255 if path.nh_itf == itf:
256 path.nh_i_flags = flags
258 self._test.vapi.ip_mroute_add_del(self.src_addr,
264 table_id=self.table_id,
267 def query_vpp_config(self):
268 dump = self._test.vapi.ip_fib_dump()
270 if self.grp_addr == e.address \
271 and self.grp_addr_len == e.address_length \
272 and self.table_id == e.table_id:
277 return self.object_id()
281 return ("%d:(%s,%s/%d)"
283 inet_ntop(AF_INET6, self.src_addr),
284 inet_ntop(AF_INET6, self.grp_addr),
287 return ("%d:(%s,%s/%d)"
289 inet_ntop(AF_INET, self.src_addr),
290 inet_ntop(AF_INET, self.grp_addr),
294 class VppMFibSignal(object):
295 def __init__(self, test, route, interface, packet):
297 self.interface = interface
301 def compare(self, signal):
302 self.test.assertEqual(self.interface, signal.sw_if_index)
303 self.test.assertEqual(self.route.table_id, signal.table_id)
304 self.test.assertEqual(self.route.grp_addr_len,
305 signal.grp_address_len)
306 for i in range(self.route.grp_addr_len / 8):
307 self.test.assertEqual(self.route.grp_addr[i],
308 signal.grp_address[i])
309 if (self.route.grp_addr_len > 32):
311 self.test.assertEqual(self.route.src_addr[i],
312 signal.src_address[i])
315 class VppMplsIpBind(VppObject):
320 def __init__(self, test, local_label, dest_addr, dest_addr_len,
321 table_id=0, ip_table_id=0):
323 self.dest_addr = inet_pton(AF_INET, dest_addr)
324 self.dest_addr_len = dest_addr_len
325 self.local_label = local_label
326 self.table_id = table_id
327 self.ip_table_id = ip_table_id
329 def add_vpp_config(self):
330 self._test.vapi.mpls_ip_bind_unbind(self.local_label,
333 table_id=self.table_id,
334 ip_table_id=self.ip_table_id)
335 self._test.registry.register(self, self._test.logger)
337 def remove_vpp_config(self):
338 self._test.vapi.mpls_ip_bind_unbind(self.local_label,
343 def query_vpp_config(self):
344 dump = self._test.vapi.mpls_fib_dump()
346 if self.local_label == e.label \
347 and self.eos_bit == e.eos_bit \
348 and self.table_id == e.table_id:
353 return self.object_id()
356 return ("%d:%s binds %d:%s/%d"
360 inet_ntop(AF_INET, self.dest_addr),
364 class VppMplsRoute(VppObject):
369 def __init__(self, test, local_label, eos_bit, paths, table_id=0,
373 self.local_label = local_label
374 self.eos_bit = eos_bit
375 self.table_id = table_id
376 self.is_multicast = is_multicast
378 def add_vpp_config(self):
379 is_multipath = len(self.paths) > 1
380 for path in self.paths:
381 self._test.vapi.mpls_route_add_del(
387 is_multicast=self.is_multicast,
388 is_multipath=is_multipath,
389 table_id=self.table_id,
390 is_interface_rx=path.is_interface_rx,
391 is_rpf_id=path.is_rpf_id,
392 next_hop_out_label_stack=path.nh_labels,
393 next_hop_n_out_labels=len(
395 next_hop_via_label=path.nh_via_label,
396 next_hop_table_id=path.nh_table_id)
397 self._test.registry.register(self, self._test.logger)
399 def remove_vpp_config(self):
400 for path in self.paths:
401 self._test.vapi.mpls_route_add_del(self.local_label,
406 is_rpf_id=path.is_rpf_id,
407 table_id=self.table_id,
410 def query_vpp_config(self):
411 dump = self._test.vapi.mpls_fib_dump()
413 if self.local_label == e.label \
414 and self.eos_bit == e.eos_bit \
415 and self.table_id == e.table_id:
420 return self.object_id()