Use IP and MAC API types for neighbors
[vpp.git] / test / vpp_neighbor.py
1 """
2   Neighbour Entries
3
4   object abstractions for ARP and ND
5 """
6
7 from ipaddress import ip_address
8 from vpp_object import *
9 from vpp_papi import mac_pton, VppEnum
10
11
12 def find_nbr(test, sw_if_index, nbr_addr, is_static=0, mac=None):
13     ip_addr = ip_address(unicode(nbr_addr))
14     e = VppEnum.vl_api_ip_neighbor_flags_t
15     nbrs = test.vapi.ip_neighbor_dump(sw_if_index,
16                                       is_ipv6=(6 is ip_addr.version))
17
18     for n in nbrs:
19         if ip_addr == n.neighbor.ip_address and \
20            is_static == (n.neighbor.flags & e.IP_API_NEIGHBOR_FLAG_STATIC):
21             if mac:
22                 if mac == str(n.neighbor.mac_address):
23                     return True
24             else:
25                 return True
26     return False
27
28
29 class VppNeighbor(VppObject):
30     """
31     ARP Entry
32     """
33
34     def __init__(self, test, sw_if_index, mac_addr, nbr_addr,
35                  is_static=False, is_no_fib_entry=False):
36         self._test = test
37         self.sw_if_index = sw_if_index
38         self.mac_addr = mac_addr
39         self.nbr_addr = nbr_addr
40
41         e = VppEnum.vl_api_ip_neighbor_flags_t
42         self.flags = e.IP_API_NEIGHBOR_FLAG_NONE
43         if is_static:
44             self.flags |= e.IP_API_NEIGHBOR_FLAG_STATIC
45         if is_no_fib_entry:
46             self.flags |= e.IP_API_NEIGHBOR_FLAG_NO_FIB_ENTRY
47
48     def add_vpp_config(self):
49         r = self._test.vapi.ip_neighbor_add_del(
50             self.sw_if_index,
51             self.mac_addr,
52             self.nbr_addr,
53             is_add=1,
54             flags=self.flags)
55         self.stats_index = r.stats_index
56         self._test.registry.register(self, self._test.logger)
57
58     def remove_vpp_config(self):
59         self._test.vapi.ip_neighbor_add_del(
60             self.sw_if_index,
61             self.mac_addr,
62             self.nbr_addr,
63             is_add=0,
64             flags=self.flags)
65
66     def is_static(self):
67         e = VppEnum.vl_api_ip_neighbor_flags_t
68         return (self.flags & e.IP_API_NEIGHBOR_FLAG_STATIC)
69
70     def query_vpp_config(self):
71         return find_nbr(self._test,
72                         self.sw_if_index,
73                         self.nbr_addr,
74                         self.is_static())
75
76     def __str__(self):
77         return self.object_id()
78
79     def object_id(self):
80         return ("%d:%s" % (self.sw_if_index, self.nbr_addr))
81
82     def get_stats(self):
83         c = self._test.statistics.get_counter("/net/adjacency")
84         return c[0][self.stats_index]