PAPI: Add MACAddress object wrapper for vl_api_mac_address_t
[vpp.git] / test / vpp_neighbor.py
1 """
2   Neighbour Entries
3
4   object abstractions for ARP and ND
5 """
6
7 from socket import inet_pton, inet_ntop, AF_INET, AF_INET6
8 from vpp_object import *
9 from vpp_papi import mac_pton
10
11
12 def find_nbr(test, sw_if_index, ip_addr, is_static=0, inet=AF_INET, mac=None):
13     nbrs = test.vapi.ip_neighbor_dump(sw_if_index,
14                                       is_ipv6=1 if AF_INET6 == inet else 0)
15     if inet == AF_INET:
16         s = 4
17     else:
18         s = 16
19     nbr_addr = inet_pton(inet, ip_addr)
20
21     for n in nbrs:
22         if nbr_addr == n.ip_address[:s] \
23            and is_static == n.is_static:
24             if mac:
25                 if n.mac_address == mac_pton(mac):
26                     return True
27             else:
28                 return True
29     return False
30
31
32 class VppNeighbor(VppObject):
33     """
34     ARP Entry
35     """
36
37     def __init__(self, test, sw_if_index, mac_addr, nbr_addr,
38                  af=AF_INET, is_static=False, is_no_fib_entry=0):
39         self._test = test
40         self.sw_if_index = sw_if_index
41         self.mac_addr = mac_pton(mac_addr)
42         self.af = af
43         self.is_static = is_static
44         self.is_no_fib_entry = is_no_fib_entry
45         self.nbr_addr = nbr_addr
46         self.nbr_addr_n = inet_pton(af, nbr_addr)
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_n,
53             is_add=1,
54             is_ipv6=1 if AF_INET6 == self.af else 0,
55             is_static=self.is_static,
56             is_no_adj_fib=self.is_no_fib_entry)
57         self.stats_index = r.stats_index
58         self._test.registry.register(self, self._test.logger)
59
60     def remove_vpp_config(self):
61         self._test.vapi.ip_neighbor_add_del(
62             self.sw_if_index,
63             self.mac_addr,
64             self.nbr_addr_n,
65             is_ipv6=1 if AF_INET6 == self.af else 0,
66             is_add=0,
67             is_static=self.is_static)
68
69     def query_vpp_config(self):
70         return find_nbr(self._test,
71                         self.sw_if_index,
72                         self.nbr_addr,
73                         self.is_static,
74                         self.af)
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]