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 VppRoutePath(object):
65 nh_via_label=MPLS_LABEL_INVALID,
69 is_resolve_attached=0,
70 proto=DpoProto.DPO_PROTO_IP4):
71 self.nh_itf = nh_sw_if_index
72 self.nh_table_id = nh_table_id
73 self.nh_via_label = nh_via_label
74 self.nh_labels = labels
78 if self.proto is DpoProto.DPO_PROTO_IP6:
79 self.nh_addr = inet_pton(AF_INET6, nh_addr)
80 elif self.proto is DpoProto.DPO_PROTO_IP4:
81 self.nh_addr = inet_pton(AF_INET, nh_addr)
83 self.nh_addr = inet_pton(AF_INET6, "::")
84 self.is_resolve_host = is_resolve_host
85 self.is_resolve_attached = is_resolve_attached
86 self.is_interface_rx = is_interface_rx
93 class VppMRoutePath(VppRoutePath):
95 def __init__(self, nh_sw_if_index, flags):
96 super(VppMRoutePath, self).__init__("0.0.0.0",
98 self.nh_i_flags = flags
101 class VppIpRoute(VppObject):
106 def __init__(self, test, dest_addr,
107 dest_addr_len, paths, table_id=0, is_ip6=0, is_local=0,
108 is_unreach=0, is_prohibit=0):
111 self.dest_addr_len = dest_addr_len
112 self.table_id = table_id
114 self.is_local = is_local
115 self.is_unreach = is_unreach
116 self.is_prohibit = is_prohibit
117 self.dest_addr_p = dest_addr
119 self.dest_addr = inet_pton(AF_INET6, dest_addr)
121 self.dest_addr = inet_pton(AF_INET, dest_addr)
123 def modify(self, paths, is_local=0,
124 is_unreach=0, is_prohibit=0):
126 self.is_local = is_local
127 self.is_unreach = is_unreach
128 self.is_prohibit = is_prohibit
130 def add_vpp_config(self):
131 if self.is_local or self.is_unreach or self.is_prohibit:
132 self._test.vapi.ip_add_del_route(
135 inet_pton(AF_INET6, "::"),
137 is_local=self.is_local,
138 is_unreach=self.is_unreach,
139 is_prohibit=self.is_prohibit,
140 table_id=self.table_id,
143 for path in self.paths:
144 self._test.vapi.ip_add_del_route(
149 table_id=self.table_id,
150 next_hop_out_label_stack=path.nh_labels,
151 next_hop_n_out_labels=len(
153 next_hop_via_label=path.nh_via_label,
154 next_hop_table_id=path.nh_table_id,
156 is_resolve_host=path.is_resolve_host,
157 is_resolve_attached=path.is_resolve_attached,
158 is_multipath=1 if len(self.paths) > 1 else 0)
159 self._test.registry.register(self, self._test.logger)
161 def remove_vpp_config(self):
162 if self.is_local or self.is_unreach or self.is_prohibit:
163 self._test.vapi.ip_add_del_route(
166 inet_pton(AF_INET6, "::"),
168 is_local=self.is_local,
169 is_unreach=self.is_unreach,
170 is_prohibit=self.is_prohibit,
172 table_id=self.table_id,
175 for path in self.paths:
176 self._test.vapi.ip_add_del_route(
181 table_id=self.table_id,
182 next_hop_table_id=path.nh_table_id,
183 next_hop_via_label=path.nh_via_label,
187 def query_vpp_config(self):
188 return find_route(self._test,
192 inet=AF_INET6 if self.is_ip6 == 1 else AF_INET)
195 return self.object_id()
204 class VppIpMRoute(VppObject):
209 def __init__(self, test, src_addr, grp_addr,
210 grp_addr_len, e_flags, paths, table_id=0,
214 self.grp_addr_len = grp_addr_len
215 self.table_id = table_id
216 self.e_flags = e_flags
221 self.grp_addr = inet_pton(AF_INET6, grp_addr)
222 self.src_addr = inet_pton(AF_INET6, src_addr)
224 self.grp_addr = inet_pton(AF_INET, grp_addr)
225 self.src_addr = inet_pton(AF_INET, src_addr)
227 def add_vpp_config(self):
228 for path in self.paths:
229 self._test.vapi.ip_mroute_add_del(self.src_addr,
236 table_id=self.table_id,
238 self._test.registry.register(self, self._test.logger)
240 def remove_vpp_config(self):
241 for path in self.paths:
242 self._test.vapi.ip_mroute_add_del(self.src_addr,
248 table_id=self.table_id,
252 def update_entry_flags(self, flags):
254 self._test.vapi.ip_mroute_add_del(self.src_addr,
260 table_id=self.table_id,
263 def update_rpf_id(self, rpf_id):
265 self._test.vapi.ip_mroute_add_del(self.src_addr,
272 table_id=self.table_id,
275 def update_path_flags(self, itf, flags):
276 for path in self.paths:
277 if path.nh_itf == itf:
278 path.nh_i_flags = flags
280 self._test.vapi.ip_mroute_add_del(self.src_addr,
286 table_id=self.table_id,
289 def query_vpp_config(self):
290 dump = self._test.vapi.ip_fib_dump()
292 if self.grp_addr == e.address \
293 and self.grp_addr_len == e.address_length \
294 and self.table_id == e.table_id:
299 return self.object_id()
303 return ("%d:(%s,%s/%d)"
305 inet_ntop(AF_INET6, self.src_addr),
306 inet_ntop(AF_INET6, self.grp_addr),
309 return ("%d:(%s,%s/%d)"
311 inet_ntop(AF_INET, self.src_addr),
312 inet_ntop(AF_INET, self.grp_addr),
316 class VppMFibSignal(object):
317 def __init__(self, test, route, interface, packet):
319 self.interface = interface
323 def compare(self, signal):
324 self.test.assertEqual(self.interface, signal.sw_if_index)
325 self.test.assertEqual(self.route.table_id, signal.table_id)
326 self.test.assertEqual(self.route.grp_addr_len,
327 signal.grp_address_len)
328 for i in range(self.route.grp_addr_len / 8):
329 self.test.assertEqual(self.route.grp_addr[i],
330 signal.grp_address[i])
331 if (self.route.grp_addr_len > 32):
333 self.test.assertEqual(self.route.src_addr[i],
334 signal.src_address[i])
337 class VppMplsIpBind(VppObject):
342 def __init__(self, test, local_label, dest_addr, dest_addr_len,
343 table_id=0, ip_table_id=0, is_ip6=0):
345 self.dest_addr_len = dest_addr_len
346 self.dest_addr = dest_addr
347 self.local_label = local_label
348 self.table_id = table_id
349 self.ip_table_id = ip_table_id
352 self.dest_addrn = inet_pton(AF_INET6, dest_addr)
354 self.dest_addrn = inet_pton(AF_INET, dest_addr)
356 def add_vpp_config(self):
357 self._test.vapi.mpls_ip_bind_unbind(self.local_label,
360 table_id=self.table_id,
361 ip_table_id=self.ip_table_id,
362 is_ip4=(self.is_ip6 == 0))
363 self._test.registry.register(self, self._test.logger)
365 def remove_vpp_config(self):
366 self._test.vapi.mpls_ip_bind_unbind(self.local_label,
369 table_id=self.table_id,
370 ip_table_id=self.ip_table_id,
372 is_ip4=(self.is_ip6 == 0))
374 def query_vpp_config(self):
375 dump = self._test.vapi.mpls_fib_dump()
377 if self.local_label == e.label \
378 and self.table_id == e.table_id:
383 return self.object_id()
386 return ("%d:%s binds %d:%s/%d"
394 class VppMplsRoute(VppObject):
399 def __init__(self, test, local_label, eos_bit, paths, table_id=0,
403 self.local_label = local_label
404 self.eos_bit = eos_bit
405 self.table_id = table_id
406 self.is_multicast = is_multicast
408 def add_vpp_config(self):
409 is_multipath = len(self.paths) > 1
410 for path in self.paths:
411 self._test.vapi.mpls_route_add_del(
417 is_multicast=self.is_multicast,
418 is_multipath=is_multipath,
419 table_id=self.table_id,
420 is_interface_rx=path.is_interface_rx,
421 is_rpf_id=path.is_rpf_id,
422 next_hop_out_label_stack=path.nh_labels,
423 next_hop_n_out_labels=len(
425 next_hop_via_label=path.nh_via_label,
426 next_hop_table_id=path.nh_table_id)
427 self._test.registry.register(self, self._test.logger)
429 def remove_vpp_config(self):
430 for path in self.paths:
431 self._test.vapi.mpls_route_add_del(self.local_label,
436 is_rpf_id=path.is_rpf_id,
437 table_id=self.table_id,
440 def query_vpp_config(self):
441 dump = self._test.vapi.mpls_fib_dump()
443 if self.local_label == e.label \
444 and self.eos_bit == e.eos_bit \
445 and self.table_id == e.table_id:
450 return self.object_id()