""" IP Routes object abstractions for representing IP routes in VPP """ from vpp_object import VppObject from vpp_ip import DpoProto, INVALID_INDEX, VppIpAddressUnion, VppIpMPrefix from ipaddress import ip_network, ip_address, IPv4Network, IPv6Network from vpp_papi_exceptions import UnexpectedApiReturnValueError # from vnet/vnet/mpls/mpls_types.h MPLS_IETF_MAX_LABEL = 0xFFFFF MPLS_LABEL_INVALID = MPLS_IETF_MAX_LABEL + 1 try: text_type = unicode except NameError: text_type = str class FibPathProto: FIB_PATH_NH_PROTO_IP4 = 0 FIB_PATH_NH_PROTO_IP6 = 1 FIB_PATH_NH_PROTO_MPLS = 2 FIB_PATH_NH_PROTO_ETHERNET = 3 FIB_PATH_NH_PROTO_BIER = 4 FIB_PATH_NH_PROTO_NSH = 5 class FibPathType: FIB_PATH_TYPE_NORMAL = 0 FIB_PATH_TYPE_LOCAL = 1 FIB_PATH_TYPE_DROP = 2 FIB_PATH_TYPE_UDP_ENCAP = 3 FIB_PATH_TYPE_BIER_IMP = 4 FIB_PATH_TYPE_ICMP_UNREACH = 5 FIB_PATH_TYPE_ICMP_PROHIBIT = 6 FIB_PATH_TYPE_SOURCE_LOOKUP = 7 FIB_PATH_TYPE_DVR = 8 FIB_PATH_TYPE_INTERFACE_RX = 9 FIB_PATH_TYPE_CLASSIFY = 10 class FibPathFlags: FIB_PATH_FLAG_NONE = 0 FIB_PATH_FLAG_RESOLVE_VIA_ATTACHED = 1 FIB_PATH_FLAG_RESOLVE_VIA_HOST = 2 FIB_PATH_FLAG_POP_PW_CW = 4 class MplsLspMode: PIPE = 0 UNIFORM = 1 def mk_network(addr, len): if ip_address(text_type(addr)).version == 4: return IPv4Network("%s/%d" % (addr, len), strict=False) else: return IPv6Network("%s/%d" % (addr, len), strict=False) def ip_to_dpo_proto(addr): if addr.version == 6: return DpoProto.DPO_PROTO_IP6 else: return DpoProto.DPO_PROTO_IP4 def address_proto(ip_addr): if ip_addr.ip_addr.version == 4: return FibPathProto.FIB_PATH_NH_PROTO_IP4 else: return FibPathProto.FIB_PATH_NH_PROTO_IP6 def find_route(test, addr, len, table_id=0, sw_if_index=None): prefix = mk_network(addr, len) if 4 == prefix.version: routes = test.vapi.ip_route_dump(table_id, False) else: routes = test.vapi.ip_route_dump(table_id, True) for e in routes: if table_id == e.route.table_id and str(e.route.prefix) == str(prefix): if not sw_if_index: return True else: # should be only one path if the user is looking # for the interface the route is reachable through if e.route.n_paths != 1: return False else: return e.route.paths[0].sw_if_index == sw_if_index return False def find_route_in_dump(dump, route, table): for r in dump: if table.table_id == r.route.table_id and route.prefix == r.route.prefix: if len(route.paths) == r.route.n_paths: return True return False def find_mroute_in_dump(dump, route, table): for r in dump: if table.table_id == r.route.table_id and route.prefix == r.route.prefix: return True return False def find_mroute(test, grp_addr, src_addr, grp_addr_len, table_id=0): ip_mprefix = VppIpMPrefix(text_type(src_addr), text_type(grp_addr), grp_addr_len) if 4 == ip_mprefix.version: routes = test.vapi.ip_mroute_dump(table_id, False) else: routes = test.vapi.ip_mroute_dump(table_id, True) for e in routes: if table_id == e.route.table_id and ip_mprefix == e.route.prefix: return True return False def find_mpls_route(test, table_id, label, eos_bit, paths=None): dump = test.vapi.mpls_route_dump(table_id) for e in dump: if ( label == e.mr_route.mr_label and eos_bit == e.mr_route.mr_eos and table_id == e.mr_route.mr_table_id ): if not paths: return True else: if len(paths) != len(e.mr_route.mr_paths): return False for i in range(len(paths)): if paths[i] != e.mr_route.mr_paths[i]: return False return True return False def fib_interface_ip_prefix(test, addr, len, sw_if_index): # can't use python net here since we need the host bits in the prefix prefix = "%s/%d" % (addr, len) addrs = test.vapi.ip_address_dump( sw_if_index, is_ipv6=(6 == ip_address(addr).version) ) for a in addrs: if a.sw_if_index == sw_if_index and str(a.prefix) == prefix: return True return False class VppIpTable(VppObject): def __init__(self, test, table_id, is_ip6=0, register=True): self._test = test self.table_id = table_id self.is_ip6 = is_ip6 self.register = register def add_vpp_config(self): self._test.vapi.ip_table_add_del( is_add=1, table={"is_ip6": self.is_ip6, "table_id": self.table_id} ) if self.register: self._test.registry.register(self, self._test.logger) return self def remove_vpp_config(self): self._test.vapi.ip_table_add_del( is_add=0, table={"is_ip6": self.is_ip6, "table_id": self.table_id} ) def replace_begin(self): self._test.vapi.ip_table_replace_begin( table={"is_ip6": self.is_ip6, "table_id": self.table_id} ) def replace_end(self): self._test.vapi.ip_table_replace_end( table={"is_ip6": self.is_ip6, "table_id": self.table_id} ) def flush(self): self._test.vapi.ip_table_flush( table={"is_ip6": self.is_ip6, "table_id": self.table_id} ) def dump(self): return self._test.vapi.ip_route_dump(self.table_id, self.is_ip6) def mdump(self): return self._test.vapi.ip_mroute_dump(self.table_id, self.is_ip6) 
/*
 * Copyright (c) 2015 Cisco and/or its affiliates.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
/*
 * global_funcs.h: global data structure access functions
 */

#ifndef included_vlib_global_funcs_h_
#define included_vlib_global_funcs_h_

always_inline vlib_main_t *
vlib_get_main (void)
{
  vlib_main_t *vm;
  vm = vlib_mains[vlib_get_thread_index ()];
  ASSERT (vm);
  return vm;
}

always_inline vlib_thread_main_t *
vlib_get_thread_main ()
{
  return &vlib_thread_main;
}

#endif /* included_vlib_global_funcs_h_ */

/*
 * fd.io coding-style-patch-verification: ON
 *
 * Local Variables:
 * eval: (c-set-style "gnu")
 * End:
 */
for i in range(len(self.nh_labels)): if self.nh_labels[i] != other.label_stack[i]: return False return self.nh_itf == other.sw_if_index else: return False def __ne__(self, other): return not (self == other) class VppMRoutePath(VppRoutePath): def __init__( self, nh_sw_if_index, flags, nh=None, proto=FibPathProto.FIB_PATH_NH_PROTO_IP4, type=FibPathType.FIB_PATH_TYPE_NORMAL, bier_imp=INVALID_INDEX, ): if not nh: nh = "::" if proto is FibPathProto.FIB_PATH_NH_PROTO_IP6 else "0.0.0.0" super(VppMRoutePath, self).__init__( nh, nh_sw_if_index, proto=proto, type=type, next_hop_id=bier_imp ) self.nh_i_flags = flags self.bier_imp = bier_imp def encode(self): return { "path": super(VppMRoutePath, self).encode(), "itf_flags": self.nh_i_flags, } class VppIpRoute(VppObject): """ IP Route """ def __init__( self, test, dest_addr, dest_addr_len, paths, table_id=0, register=True ): self._test = test self.paths = paths self.table_id = table_id self.prefix = mk_network(dest_addr, dest_addr_len) self.register = register self.stats_index = None self.modified = False self.encoded_paths = [] for path in self.paths: self.encoded_paths.append(path.encode()) def __eq__(self, other): if self.table_id == other.table_id and self.prefix == other.prefix: return True return False def modify(self, paths): self.paths = paths self.encoded_paths = [] for path in self.paths: self.encoded_paths.append(path.encode()) self.modified = True self._test.vapi.ip_route_add_del( route={ "table_id": self.table_id, "prefix": self.prefix, "n_paths": len(self.encoded_paths), "paths": self.encoded_paths, }, is_add=1, is_multipath=0, ) def add_vpp_config(self): r = self._test.vapi.ip_route_add_del( route={ "table_id": self.table_id, "prefix": self.prefix, "n_paths": len(self.encoded_paths), "paths": self.encoded_paths, }, is_add=1, is_multipath=0, ) self.stats_index = r.stats_index if self.register: self._test.registry.register(self, self._test.logger) return self def remove_vpp_config(self): # there's no need to issue different deletes for modified routes # we do this only to test the two different ways to delete routes # eiter by passing all the paths to remove and mutlipath=1 or # passing no paths and multipath=0 if self.modified: self._test.vapi.ip_route_add_del( route={ "table_id": self.table_id, "prefix": self.prefix, "n_paths": len(self.encoded_paths), "paths": self.encoded_paths, }, is_add=0, is_multipath=1, ) else: self._test.vapi.ip_route_add_del( route={"table_id": self.table_id, "prefix": self.prefix, "n_paths": 0}, is_add=0, is_multipath=0, ) def query_vpp_config(self): return find_route( self._test, self.prefix.network_address, self.prefix.prefixlen, self.table_id, ) def object_id(self): return "%s:table-%d-%s" % ( "ip6-route" if self.prefix.version == 6 else "ip-route", self.table_id, self.prefix, ) def get_stats_to(self): c = self._test.statistics.get_counter("/net/route/to") return c[0][self.stats_index] def get_stats_via(self): c = self._test.statistics.get_counter("/net/route/via") return c[0][self.stats_index] class VppIpRouteV2(VppObject): """ IP Route V2 """ def __init__( self, test, dest_addr, dest_addr_len, paths, table_id=0, register=True, src=0 ): self._test = test self.paths = paths self.table_id = table_id self.prefix = mk_network(dest_addr, dest_addr_len) self.register = register self.stats_index = None self.modified = False self.src = src self.encoded_paths = [] for path in self.paths: self.encoded_paths.append(path.encode()) def __eq__(self, other): if self.table_id == other.table_id and self.prefix == other.prefix: return True return False def modify(self, paths): self.paths = paths self.encoded_paths = [] for path in self.paths: self.encoded_paths.append(path.encode()) self.modified = True self._test.vapi.ip_route_add_del_v2( route={ "table_id": self.table_id, "prefix": self.prefix, "src": self.src, "n_paths": len(self.encoded_paths), "paths": self.encoded_paths, }, is_add=1, is_multipath=0, ) def add_vpp_config(self): r = self._test.vapi.ip_route_add_del_v2( route={ "table_id": self.table_id, "prefix": self.prefix, "n_paths": len(self.encoded_paths), "paths": self.encoded_paths, "src": self.src, }, is_add=1, is_multipath=0, ) self.stats_index = r.stats_index if self.register: self._test.registry.register(self, self._test.logger) return self def remove_vpp_config(self): # there's no need to issue different deletes for modified routes # we do this only to test the two different ways to delete routes # eiter by passing all the paths to remove and mutlipath=1 or # passing no paths and multipath=0 if self.modified: self._test.vapi.ip_route_add_del_v2( route={ "table_id": self.table_id, "prefix": self.prefix, "src": self.src, "n_paths": len(self.encoded_paths), "paths": self.encoded_paths, }, is_add=0, is_multipath=1, ) else: self._test.vapi.ip_route_add_del_v2( route={ "table_id": self.table_id, "prefix": self.prefix, "src": self.src, "n_paths": 0, }, is_add=0, is_multipath=0, ) def query_vpp_config(self): return find_route( self._test, self.prefix.network_address, self.prefix.prefixlen, self.table_id, ) def object_id(self): return "%s:table-%d-%s" % ( "ip6-route" if self.prefix.version == 6 else "ip-route", self.table_id, self.prefix, ) def get_stats_to(self): c = self._test.statistics.get_counter("/net/route/to") return c[0][self.stats_index] def get_stats_via(self): c = self._test.statistics.get_counter("/net/route/via") return c[0][self.stats_index] class VppIpMRoute(VppObject): """ IP Multicast Route """ def __init__( self, test, src_addr, grp_addr, grp_addr_len, e_flags, paths, table_id=0, rpf_id=0, ): self._test = test self.paths = paths self.table_id = table_id self.e_flags = e_flags self.rpf_id = rpf_id self.prefix = VppIpMPrefix(src_addr, grp_addr, grp_addr_len) self.encoded_paths = [] for path in self.paths: self.encoded_paths.append(path.encode()) def encode(self, paths=None): _paths = self.encoded_paths if paths is None else paths return { "table_id": self.table_id, "entry_flags": self.e_flags, "rpf_id": self.rpf_id, "prefix": self.prefix.encode(), "n_paths": len(_paths), "paths": _paths, } def add_vpp_config(self): r = self._test.vapi.ip_mroute_add_del( route=self.encode(), is_multipath=1, is_add=1 ) self.stats_index = r.stats_index self._test.registry.register(self, self._test.logger) return self def remove_vpp_config(self): self._test.vapi.ip_mroute_add_del(route=self.encode(), is_multipath=1, is_add=0) def update_entry_flags(self, flags): self.e_flags = flags self._test.vapi.ip_mroute_add_del( route=self.encode(paths=[]), is_multipath=1, is_add=1 ) def update_rpf_id(self, rpf_id): self.rpf_id = rpf_id self._test.vapi.ip_mroute_add_del( route=self.encode(paths=[]), is_multipath=1, is_add=1 ) def update_path_flags(self, itf, flags): for p in range(len(self.paths)): if self.paths[p].nh_itf == itf: self.paths[p].nh_i_flags = flags self.encoded_paths[p] = self.paths[p].encode() break self._test.vapi.ip_mroute_add_del( route=self.encode(paths=[self.encoded_paths[p]]), is_add=1, is_multipath=0 ) def query_vpp_config(self): return find_mroute( self._test, self.prefix.gaddr, self.prefix.saddr, self.prefix.length, self.table_id, ) def object_id(self): return "%d:(%s,%s/%d)" % ( self.table_id, self.prefix.saddr, self.prefix.gaddr, self.prefix.length, ) def get_stats(self): c = self._test.statistics.get_counter("/net/mroute") return c[0][self.stats_index] class VppMFibSignal: def __init__(self, test, route, interface, packet): self.route = route self.interface = interface self.packet = packet self.test = test def compare(self, signal): self.test.assertEqual(self.interface, signal.sw_if_index) self.test.assertEqual(self.route.table_id, signal.table_id) self.test.assertEqual(self.route.prefix, signal.prefix) class VppMplsIpBind(VppObject): """ MPLS to IP Binding """ def __init__( self, test, local_label, dest_addr, dest_addr_len, table_id=0, ip_table_id=0, is_ip6=0, ): self._test = test self.dest_addr_len = dest_addr_len self.dest_addr = dest_addr self.ip_addr = ip_address(text_type(dest_addr)) self.local_label = local_label self.table_id = table_id self.ip_table_id = ip_table_id self.prefix = mk_network(dest_addr, dest_addr_len) def add_vpp_config(self): self._test.vapi.mpls_ip_bind_unbind( self.local_label, self.prefix, table_id=self.table_id, ip_table_id=self.ip_table_id, ) self._test.registry.register(self, self._test.logger) def remove_vpp_config(self): self._test.vapi.mpls_ip_bind_unbind( self.local_label, self.prefix, table_id=self.table_id, ip_table_id=self.ip_table_id, is_bind=0, ) def query_vpp_config(self): dump = self._test.vapi.mpls_route_dump(self.table_id) for e in dump: if ( self.local_label == e.mr_route.mr_label and self.table_id == e.mr_route.mr_table_id ): return True return False def object_id(self): return "%d:%s binds %d:%s/%d" % ( self.table_id, self.local_label, self.ip_table_id, self.dest_addr, self.dest_addr_len, ) class VppMplsTable(VppObject): def __init__(self, test, table_id): self._test = test self.table_id = table_id def add_vpp_config(self): self._test.vapi.mpls_table_add_del(self.table_id, is_add=1) self._test.registry.register(self, self._test.logger) def remove_vpp_config(self): self._test.vapi.mpls_table_add_del(self.table_id, is_add=0) def query_vpp_config(self): dump = self._test.vapi.mpls_table_dump() for d in dump: if d.mt_table.mt_table_id == self.table_id: return True return False def object_id(self): return "table-mpls-%d" % (self.table_id) class VppMplsRoute(VppObject): """ MPLS Route/LSP """ def __init__( self, test, local_label, eos_bit, paths, table_id=0, is_multicast=0, eos_proto=FibPathProto.FIB_PATH_NH_PROTO_IP4, ): self._test = test self.paths = paths self.local_label = local_label self.eos_bit = eos_bit self.eos_proto = eos_proto self.table_id = table_id self.is_multicast = is_multicast def add_vpp_config(self): paths = [] for path in self.paths: paths.append(path.encode()) r = self._test.vapi.mpls_route_add_del( self.table_id, self.local_label, self.eos_bit, self.eos_proto, self.is_multicast, paths, 1, 0, ) self.stats_index = r.stats_index self._test.registry.register(self, self._test.logger) def remove_vpp_config(self): paths = [] for path in self.paths: paths.append(path.encode()) self._test.vapi.mpls_route_add_del( self.table_id, self.local_label, self.eos_bit, self.eos_proto, self.is_multicast, paths, 0, 0, ) def query_vpp_config(self): return find_mpls_route( self._test, self.table_id, self.local_label, self.eos_bit ) def object_id(self): return "mpls-route-%d:%s/%d" % ( self.table_id, self.local_label, 20 + self.eos_bit, ) def get_stats_to(self): c = self._test.statistics.get_counter("/net/route/to") return c[0][self.stats_index] def get_stats_via(self): c = self._test.statistics.get_counter("/net/route/via") return c[0][self.stats_index]