test/vpp_interface.py

   1 from abc import abstractmethod, ABCMeta
   2 import socket
   3
   4 from util import Host, mk_ll_addr, mactobinary
   5
   6
   7 class VppInterface(object):
   8     """Generic VPP interface."""
   9     __metaclass__ = ABCMeta
  10
  11     @property
  12     def sw_if_index(self):
  13         """Interface index assigned by VPP."""
  14         return self._sw_if_index
  15
  16     @property
  17     def remote_mac(self):
  18         """MAC-address of the remote interface "connected" to this interface"""
  19         return self._remote_hosts[0].mac
  20
  21     @property
  22     def local_mac(self):
  23         """MAC-address of the VPP interface."""
  24         return self._local_mac
  25
  26     @property
  27     def local_ip4(self):
  28         """Local IPv4 address on VPP interface (string)."""
  29         return self._local_ip4
  30
  31     @property
  32     def local_ip4n(self):
  33         """Local IPv4 address - raw, suitable as API parameter."""
  34         return socket.inet_pton(socket.AF_INET, self._local_ip4)
  35
  36     @property
  37     def remote_ip4(self):
  38         """IPv4 address of remote peer "connected" to this interface."""
  39         return self._remote_hosts[0].ip4
  40
  41     @property
  42     def remote_ip4n(self):
  43         """IPv4 address of remote peer - raw, suitable as API parameter."""
  44         return socket.inet_pton(socket.AF_INET, self.remote_ip4)
  45
  46     @property
  47     def local_ip6(self):
  48         """Local IPv6 address on VPP interface (string)."""
  49         return self._local_ip6
  50
  51     @property
  52     def local_ip6n(self):
  53         """Local IPv6 address - raw, suitable as API parameter."""
  54         return socket.inet_pton(socket.AF_INET6, self.local_ip6)
  55
  56     @property
  57     def remote_ip6(self):
  58         """IPv6 address of remote peer "connected" to this interface."""
  59         return self._remote_hosts[0].ip6
  60
  61     @property
  62     def remote_ip6n(self):
  63         """IPv6 address of remote peer - raw, suitable as API parameter"""
  64         return socket.inet_pton(socket.AF_INET6, self.remote_ip6)
  65
  66     @property
  67     def local_ip6_ll(self):
  68         """Local IPv6 linnk-local address on VPP interface (string)."""
  69         return self._local_ip6_ll
  70
  71     @property
  72     def local_ip6n_ll(self):
  73         """Local IPv6 link-local address - raw, suitable as API parameter."""
  74         return self._local_ip6n_ll
  75
  76     @property
  77     def remote_ip6_ll(self):
  78         """Link-local IPv6 address of remote peer
  79         "connected" to this interface."""
  80         return self._remote_ip6_ll
  81
  82     @property
  83     def remote_ip6n_ll(self):
  84         """Link-local IPv6 address of remote peer
  85         - raw, suitable as API parameter"""
  86         return self._remote_ip6n_ll
  87
  88     @property
  89     def name(self):
  90         """Name of the interface."""
  91         return self._name
  92
  93     @property
  94     def dump(self):
  95         """RAW result of sw_interface_dump for this interface."""
  96         return self._dump
  97
  98     @property
  99     def test(self):
 100         """Test case creating this interface."""
 101         return self._test
 102
 103     @property
 104     def remote_hosts(self):
 105         """Remote hosts list"""
 106         return self._remote_hosts
 107
 108     @remote_hosts.setter
 109     def remote_hosts(self, value):
 110         """
 111         :param list value: List of remote hosts.
 112         """
 113         self._remote_hosts = value
 114         self._hosts_by_mac = {}
 115         self._hosts_by_ip4 = {}
 116         self._hosts_by_ip6 = {}
 117         for host in self._remote_hosts:
 118             self._hosts_by_mac[host.mac] = host
 119             self._hosts_by_ip4[host.ip4] = host
 120             self._hosts_by_ip6[host.ip6] = host
 121
 122     def host_by_mac(self, mac):
 123         """
 124         :param mac: MAC address to find host by.
 125         :return: Host object assigned to interface.
 126         """
 127         return self._hosts_by_mac[mac]
 128
 129     def host_by_ip4(self, ip):
 130         """
 131         :param ip: IPv4 address to find host by.
 132         :return: Host object assigned to interface.
 133         """
 134         return self._hosts_by_ip4[ip]
 135
 136     def host_by_ip6(self, ip):
 137         """
 138         :param ip: IPv6 address to find host by.
 139         :return: Host object assigned to interface.
 140         """
 141         return self._hosts_by_ip6[ip]
 142
 143     def generate_remote_hosts(self, count=1):
 144         """Generate and add remote hosts for the interface.
 145
 146         :param int count: Number of generated remote hosts.
 147         """
 148         self._remote_hosts = []
 149         self._hosts_by_mac = {}
 150         self._hosts_by_ip4 = {}
 151         self._hosts_by_ip6 = {}
 152         for i in range(
 153                 2, count + 2):  # 0: network address, 1: local vpp address
 154             mac = "02:%02x:00:00:ff:%02x" % (self.sw_if_index, i)
 155             ip4 = "172.16.%u.%u" % (self.sw_if_index, i)
 156             ip6 = "fd01:%x::%x" % (self.sw_if_index, i)
 157             ip6_ll = mk_ll_addr(mac)
 158             host = Host(mac, ip4, ip6, ip6_ll)
 159             self._remote_hosts.append(host)
 160             self._hosts_by_mac[mac] = host
 161             self._hosts_by_ip4[ip4] = host
 162             self._hosts_by_ip6[ip6] = host
 163
 164     @abstractmethod
 165     def __init__(self, test):
 166         self._test = test
 167
 168         self._remote_hosts = []
 169         self._hosts_by_mac = {}
 170         self._hosts_by_ip4 = {}
 171         self._hosts_by_ip6 = {}
 172
 173     def set_mac(self, mac):
 174         self._local_mac = mac
 175         self._local_ip6_ll = mk_ll_addr(mac)
 176         self.test.vapi.sw_interface_set_mac_address(
 177             self.sw_if_index,
 178             mactobinary(self._local_mac))
 179
 180     def set_sw_if_index(self, sw_if_index):
 181         self._sw_if_index = sw_if_index
 182
 183         self.generate_remote_hosts()
 184
 185         self._local_ip4 = "172.16.%u.1" % self.sw_if_index
 186         self._local_ip4n = socket.inet_pton(socket.AF_INET, self.local_ip4)
 187         self._local_ip4_subnet = "172.16.%u.0" % self.sw_if_index
 188         self._local_ip4n_subnet = socket.inet_pton(socket.AF_INET,
 189                                                    self._local_ip4_subnet)
 190         self._local_ip4_bcast = "172.16.%u.255" % self.sw_if_index
 191         self._local_ip4n_bcast = socket.inet_pton(socket.AF_INET,
 192                                                   self._local_ip4_bcast)
 193         self.local_ip4_prefix_len = 24
 194         self.has_ip4_config = False
 195         self.ip4_table_id = 0
 196
 197         self._local_ip6 = "fd01:%x::1" % self.sw_if_index
 198         self._local_ip6n = socket.inet_pton(socket.AF_INET6, self.local_ip6)
 199         self.local_ip6_prefix_len = 64
 200         self.has_ip6_config = False
 201         self.ip6_table_id = 0
 202
 203         r = self.test.vapi.sw_interface_dump()
 204         for intf in r:
 205             if intf.sw_if_index == self.sw_if_index:
 206                 self._name = intf.interface_name.split(b'\0', 1)[0]
 207                 self._local_mac = \
 208                     ':'.join(intf.l2_address.encode('hex')[i:i + 2]
 209                              for i in range(0, 12, 2))
 210                 self._dump = intf
 211                 break
 212         else:
 213             raise Exception(
 214                 "Could not find interface with sw_if_index %d "
 215                 "in interface dump %s" %
 216                 (self.sw_if_index, repr(r)))
 217         self._local_ip6_ll = mk_ll_addr(self.local_mac)
 218         self._local_ip6n_ll = socket.inet_pton(socket.AF_INET6,
 219                                                self.local_ip6_ll)
 220         self._remote_ip6_ll = mk_ll_addr(self.remote_mac)
 221         self._remote_ip6n_ll = socket.inet_pton(socket.AF_INET6,
 222                                                 self.remote_ip6_ll)
 223
 224     def config_ip4(self):
 225         """Configure IPv4 address on the VPP interface."""
 226         self.test.vapi.sw_interface_add_del_address(
 227             self.sw_if_index, self.local_ip4n, self.local_ip4_prefix_len)
 228         self.has_ip4_config = True
 229
 230     def unconfig_ip4(self):
 231         """Remove IPv4 address on the VPP interface."""
 232         try:
 233             if self.has_ip4_config:
 234                 self.test.vapi.sw_interface_add_del_address(
 235                     self.sw_if_index,
 236                     self.local_ip4n,
 237                     self.local_ip4_prefix_len,
 238                     is_add=0)
 239         except AttributeError:
 240             self.has_ip4_config = False
 241         self.has_ip4_config = False
 242
 243     def configure_ipv4_neighbors(self):
 244         """For every remote host assign neighbor's MAC to IPv4 addresses.
 245
 246         :param vrf_id: The FIB table / VRF ID. (Default value = 0)
 247         """
 248         for host in self._remote_hosts:
 249             macn = host.mac.replace(":", "").decode('hex')
 250             ipn = host.ip4n
 251             self.test.vapi.ip_neighbor_add_del(
 252                 self.sw_if_index, macn, ipn)
 253
 254     def config_ip6(self):
 255         """Configure IPv6 address on the VPP interface."""
 256         self.test.vapi.sw_interface_add_del_address(
 257             self.sw_if_index, self._local_ip6n, self.local_ip6_prefix_len,
 258             is_ipv6=1)
 259         self.has_ip6_config = True
 260
 261     def unconfig_ip6(self):
 262         """Remove IPv6 address on the VPP interface."""
 263         try:
 264             if self.has_ip6_config:
 265                 self.test.vapi.sw_interface_add_del_address(
 266                     self.sw_if_index,
 267                     self.local_ip6n,
 268                     self.local_ip6_prefix_len,
 269                     is_ipv6=1, is_add=0)
 270         except AttributeError:
 271             self.has_ip6_config = False
 272         self.has_ip6_config = False
 273
 274     def configure_ipv6_neighbors(self):
 275         """For every remote host assign neighbor's MAC to IPv6 addresses.
 276
 277         :param vrf_id: The FIB table / VRF ID. (Default value = 0)
 278         """
 279         for host in self._remote_hosts:
 280             macn = host.mac.replace(":", "").decode('hex')
 281             ipn = host.ip6n
 282             self.test.vapi.ip_neighbor_add_del(
 283                 self.sw_if_index, macn, ipn, is_ipv6=1)
 284
 285     def unconfig(self):
 286         """Unconfigure IPv6 and IPv4 address on the VPP interface."""
 287         self.unconfig_ip4()
 288         self.unconfig_ip6()
 289
 290     def set_table_ip4(self, table_id):
 291         """Set the interface in a IPv4 Table.
 292
 293         .. note:: Must be called before configuring IP4 addresses.
 294         """
 295         self.ip4_table_id = table_id
 296         self.test.vapi.sw_interface_set_table(
 297             self.sw_if_index, 0, self.ip4_table_id)
 298
 299     def set_table_ip6(self, table_id):
 300         """Set the interface in a IPv6 Table.
 301
 302         .. note:: Must be called before configuring IP6 addresses.
 303         """
 304         self.ip6_table_id = table_id
 305         self.test.vapi.sw_interface_set_table(
 306             self.sw_if_index, 1, self.ip6_table_id)
 307
 308     def disable_ipv6_ra(self):
 309         """Configure IPv6 RA suppress on the VPP interface."""
 310         self.test.vapi.sw_interface_ra_suppress(self.sw_if_index)
 311
 312     def ip6_ra_config(self, no=0, suppress=0, send_unicast=0):
 313         """Configure IPv6 RA suppress on the VPP interface."""
 314         self.test.vapi.ip6_sw_interface_ra_config(self.sw_if_index,
 315                                                   no,
 316                                                   suppress,
 317                                                   send_unicast)
 318
 319     def ip6_ra_prefix(self, address, address_length, is_no=0,
 320                       off_link=0, no_autoconfig=0, use_default=0):
 321         """Configure IPv6 RA suppress on the VPP interface."""
 322         self.test.vapi.ip6_sw_interface_ra_prefix(self.sw_if_index,
 323                                                   address,
 324                                                   address_length,
 325                                                   is_no=is_no,
 326                                                   off_link=off_link,
 327                                                   no_autoconfig=no_autoconfig,
 328                                                   use_default=use_default)
 329
 330     def admin_up(self):
 331         """Put interface ADMIN-UP."""
 332         self.test.vapi.sw_interface_set_flags(self.sw_if_index,
 333                                               admin_up_down=1)
 334
 335     def admin_down(self):
 336         """Put interface ADMIN-down."""
 337         self.test.vapi.sw_interface_set_flags(self.sw_if_index,
 338                                               admin_up_down=0)
 339
 340     def ip6_enable(self):
 341         """IPv6 Enable interface"""
 342         self.test.vapi.ip6_sw_interface_enable_disable(self.sw_if_index,
 343                                                        enable=1)
 344
 345     def ip6_disable(self):
 346         """Put interface ADMIN-DOWN."""
 347         self.test.vapi.ip6_sw_interface_enable_disable(self.sw_if_index,
 348                                                        enable=0)
 349
 350     def add_sub_if(self, sub_if):
 351         """Register a sub-interface with this interface.
 352
 353         :param sub_if: sub-interface
 354         """
 355         if not hasattr(self, 'sub_if'):
 356             self.sub_if = sub_if
 357         else:
 358             if isinstance(self.sub_if, list):
 359                 self.sub_if.append(sub_if)
 360             else:
 361                 self.sub_if = sub_if
 362
 363     def enable_mpls(self):
 364         """Enable MPLS on the VPP interface."""
 365         self.test.vapi.sw_interface_enable_disable_mpls(
 366             self.sw_if_index)
 367
 368     def disable_mpls(self):
 369         """Enable MPLS on the VPP interface."""
 370         self.test.vapi.sw_interface_enable_disable_mpls(
 371             self.sw_if_index, 0)
 372
 373     def is_ip4_entry_in_fib_dump(self, dump):
 374         for i in dump:
 375             if i.address == self.local_ip4n and \
 376                i.address_length == self.local_ip4_prefix_len and \
 377                i.table_id == self.ip4_table_id:
 378                 return True
 379         return False
 380
 381     def set_unnumbered(self, ip_sw_if_index):
 382         """ Set the interface to unnumbered via ip_sw_if_index """
 383         self.test.vapi.sw_interface_set_unnumbered(
 384             self.sw_if_index,
 385             ip_sw_if_index)
 386
 387     def unset_unnumbered(self, ip_sw_if_index):
 388         """ Unset the interface to unnumbered via ip_sw_if_index """
 389         self.test.vapi.sw_interface_set_unnumbered(
 390             self.sw_if_index,
 391             ip_sw_if_index,
 392             is_add=0)
 393
 394     def set_proxy_arp(self, enable=1):
 395         """ Set the interface to enable/disable Proxy ARP """
 396         self.test.vapi.proxy_arp_intfc_enable_disable(
 397             self.sw_if_index,
 398             enable)
 399
 400     def query_vpp_config(self):
 401         dump = self.test.vapi.sw_interface_dump()
 402         return self.is_interface_config_in_dump(dump)
 403
 404     def is_interface_config_in_dump(self, dump):
 405         for i in dump:
 406             if i.interface_name.rstrip(' \t\r\n\0') == self.name and \
 407                i.sw_if_index == self.sw_if_index:
 408                 return True
 409         else:
 410             return False