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,
112 next_hop_id=0xffffffff,
113 proto=DpoProto.DPO_PROTO_IP4):
114 self.nh_itf = nh_sw_if_index
115 self.nh_table_id = nh_table_id
116 self.nh_via_label = nh_via_label
117 self.nh_labels = labels
121 if self.proto is DpoProto.DPO_PROTO_IP6:
122 self.nh_addr = inet_pton(AF_INET6, nh_addr)
123 elif self.proto is DpoProto.DPO_PROTO_IP4:
124 self.nh_addr = inet_pton(AF_INET, nh_addr)
126 self.nh_addr = inet_pton(AF_INET6, "::")
127 self.is_resolve_host = is_resolve_host
128 self.is_resolve_attached = is_resolve_attached
129 self.is_interface_rx = is_interface_rx
130 self.is_source_lookup = is_source_lookup
135 self.is_udp_encap = is_udp_encap
136 self.next_hop_id = next_hop_id
139 class VppMRoutePath(VppRoutePath):
141 def __init__(self, nh_sw_if_index, flags):
142 super(VppMRoutePath, self).__init__("0.0.0.0",
144 self.nh_i_flags = flags
147 class VppIpRoute(VppObject):
152 def __init__(self, test, dest_addr,
153 dest_addr_len, paths, table_id=0, is_ip6=0, is_local=0,
154 is_unreach=0, is_prohibit=0):
157 self.dest_addr_len = dest_addr_len
158 self.table_id = table_id
160 self.is_local = is_local
161 self.is_unreach = is_unreach
162 self.is_prohibit = is_prohibit
163 self.dest_addr_p = dest_addr
165 self.dest_addr = inet_pton(AF_INET6, dest_addr)
167 self.dest_addr = inet_pton(AF_INET, dest_addr)
169 def modify(self, paths, is_local=0,
170 is_unreach=0, is_prohibit=0):
172 self.is_local = is_local
173 self.is_unreach = is_unreach
174 self.is_prohibit = is_prohibit
176 def add_vpp_config(self):
177 if self.is_local or self.is_unreach or self.is_prohibit:
178 self._test.vapi.ip_add_del_route(
181 inet_pton(AF_INET6, "::"),
183 is_local=self.is_local,
184 is_unreach=self.is_unreach,
185 is_prohibit=self.is_prohibit,
186 table_id=self.table_id,
189 for path in self.paths:
190 self._test.vapi.ip_add_del_route(
195 table_id=self.table_id,
196 next_hop_out_label_stack=path.nh_labels,
197 next_hop_n_out_labels=len(
199 next_hop_via_label=path.nh_via_label,
200 next_hop_table_id=path.nh_table_id,
201 next_hop_id=path.next_hop_id,
204 if path.proto == DpoProto.DPO_PROTO_ETHERNET else 0,
205 is_resolve_host=path.is_resolve_host,
206 is_resolve_attached=path.is_resolve_attached,
207 is_source_lookup=path.is_source_lookup,
208 is_udp_encap=path.is_udp_encap,
209 is_multipath=1 if len(self.paths) > 1 else 0)
210 self._test.registry.register(self, self._test.logger)
212 def remove_vpp_config(self):
213 if self.is_local or self.is_unreach or self.is_prohibit:
214 self._test.vapi.ip_add_del_route(
217 inet_pton(AF_INET6, "::"),
219 is_local=self.is_local,
220 is_unreach=self.is_unreach,
221 is_prohibit=self.is_prohibit,
223 table_id=self.table_id,
226 for path in self.paths:
227 self._test.vapi.ip_add_del_route(
232 table_id=self.table_id,
233 next_hop_table_id=path.nh_table_id,
234 next_hop_via_label=path.nh_via_label,
235 next_hop_id=path.next_hop_id,
237 is_udp_encap=path.is_udp_encap,
240 def query_vpp_config(self):
241 return find_route(self._test,
245 inet=AF_INET6 if self.is_ip6 == 1 else AF_INET)
248 return self.object_id()
257 class VppIpMRoute(VppObject):
262 def __init__(self, test, src_addr, grp_addr,
263 grp_addr_len, e_flags, paths, table_id=0,
267 self.grp_addr_len = grp_addr_len
268 self.table_id = table_id
269 self.e_flags = e_flags
274 self.grp_addr = inet_pton(AF_INET6, grp_addr)
275 self.src_addr = inet_pton(AF_INET6, src_addr)
277 self.grp_addr = inet_pton(AF_INET, grp_addr)
278 self.src_addr = inet_pton(AF_INET, src_addr)
280 def add_vpp_config(self):
281 for path in self.paths:
282 self._test.vapi.ip_mroute_add_del(self.src_addr,
289 table_id=self.table_id,
291 self._test.registry.register(self, self._test.logger)
293 def remove_vpp_config(self):
294 for path in self.paths:
295 self._test.vapi.ip_mroute_add_del(self.src_addr,
301 table_id=self.table_id,
305 def update_entry_flags(self, flags):
307 self._test.vapi.ip_mroute_add_del(self.src_addr,
313 table_id=self.table_id,
316 def update_rpf_id(self, rpf_id):
318 self._test.vapi.ip_mroute_add_del(self.src_addr,
325 table_id=self.table_id,
328 def update_path_flags(self, itf, flags):
329 for path in self.paths:
330 if path.nh_itf == itf:
331 path.nh_i_flags = flags
333 self._test.vapi.ip_mroute_add_del(self.src_addr,
339 table_id=self.table_id,
342 def query_vpp_config(self):
343 dump = self._test.vapi.ip_fib_dump()
345 if self.grp_addr == e.address \
346 and self.grp_addr_len == e.address_length \
347 and self.table_id == e.table_id:
352 return self.object_id()
356 return ("%d:(%s,%s/%d)"
358 inet_ntop(AF_INET6, self.src_addr),
359 inet_ntop(AF_INET6, self.grp_addr),
362 return ("%d:(%s,%s/%d)"
364 inet_ntop(AF_INET, self.src_addr),
365 inet_ntop(AF_INET, self.grp_addr),
369 class VppMFibSignal(object):
370 def __init__(self, test, route, interface, packet):
372 self.interface = interface
376 def compare(self, signal):
377 self.test.assertEqual(self.interface, signal.sw_if_index)
378 self.test.assertEqual(self.route.table_id, signal.table_id)
379 self.test.assertEqual(self.route.grp_addr_len,
380 signal.grp_address_len)
381 for i in range(self.route.grp_addr_len / 8):
382 self.test.assertEqual(self.route.grp_addr[i],
383 signal.grp_address[i])
384 if (self.route.grp_addr_len > 32):
386 self.test.assertEqual(self.route.src_addr[i],
387 signal.src_address[i])
390 class VppMplsIpBind(VppObject):
395 def __init__(self, test, local_label, dest_addr, dest_addr_len,
396 table_id=0, ip_table_id=0, is_ip6=0):
398 self.dest_addr_len = dest_addr_len
399 self.dest_addr = dest_addr
400 self.local_label = local_label
401 self.table_id = table_id
402 self.ip_table_id = ip_table_id
405 self.dest_addrn = inet_pton(AF_INET6, dest_addr)
407 self.dest_addrn = inet_pton(AF_INET, dest_addr)
409 def add_vpp_config(self):
410 self._test.vapi.mpls_ip_bind_unbind(self.local_label,
413 table_id=self.table_id,
414 ip_table_id=self.ip_table_id,
415 is_ip4=(self.is_ip6 == 0))
416 self._test.registry.register(self, self._test.logger)
418 def remove_vpp_config(self):
419 self._test.vapi.mpls_ip_bind_unbind(self.local_label,
422 table_id=self.table_id,
423 ip_table_id=self.ip_table_id,
425 is_ip4=(self.is_ip6 == 0))
427 def query_vpp_config(self):
428 dump = self._test.vapi.mpls_fib_dump()
430 if self.local_label == e.label \
431 and self.table_id == e.table_id:
436 return self.object_id()
439 return ("%d:%s binds %d:%s/%d"
447 class VppMplsTable(VppObject):
453 self.table_id = table_id
455 def add_vpp_config(self):
456 self._test.vapi.mpls_table_add_del(
459 self._test.registry.register(self, self._test.logger)
461 def remove_vpp_config(self):
462 self._test.vapi.mpls_table_add_del(
466 def query_vpp_config(self):
467 # find the default route
468 dump = self._test.vapi.mpls_fib_dump()
474 return self.object_id()
477 return ("table-mpls-%d" % (self.table_id))
480 class VppMplsRoute(VppObject):
485 def __init__(self, test, local_label, eos_bit, paths, table_id=0,
489 self.local_label = local_label
490 self.eos_bit = eos_bit
491 self.table_id = table_id
492 self.is_multicast = is_multicast
494 def add_vpp_config(self):
495 is_multipath = len(self.paths) > 1
496 for path in self.paths:
497 self._test.vapi.mpls_route_add_del(
503 is_multicast=self.is_multicast,
504 is_multipath=is_multipath,
505 table_id=self.table_id,
506 is_interface_rx=path.is_interface_rx,
507 is_rpf_id=path.is_rpf_id,
508 next_hop_out_label_stack=path.nh_labels,
509 next_hop_n_out_labels=len(
511 next_hop_via_label=path.nh_via_label,
512 next_hop_table_id=path.nh_table_id)
513 self._test.registry.register(self, self._test.logger)
515 def remove_vpp_config(self):
516 for path in self.paths:
517 self._test.vapi.mpls_route_add_del(self.local_label,
522 is_rpf_id=path.is_rpf_id,
523 table_id=self.table_id,
526 def query_vpp_config(self):
527 dump = self._test.vapi.mpls_fib_dump()
529 if self.local_label == e.label \
530 and self.eos_bit == e.eos_bit \
531 and self.table_id == e.table_id:
536 return self.object_id()