api: Cleanup APIs interface.api
[vpp.git] / test / vpp_memif.py
1 import socket
2
3 import six
4
5 from vpp_object import VppObject
6 from vpp_ip import VppIpPrefix
7 from vpp_papi import VppEnum
8
9
10 class MEMIF_ROLE:
11     MASTER = 0
12     SLAVE = 1
13
14
15 class MEMIF_MODE:
16     ETHERNET = 0
17     IP = 1
18     PUNT_INJECT = 2
19
20
21 def get_if_dump(dump, sw_if_index):
22     for d in dump:
23         if (d.sw_if_index == sw_if_index):
24             return d
25
26
27 def query_all_memif_vpp_config(_test):
28     return _test.vapi.memif_dump()
29
30
31 def remove_all_memif_vpp_config(_test):
32     dump = _test.vapi.memif_dump()
33     for d in dump:
34         _test.vapi.memif_delete(d.sw_if_index)
35     dump = _test.vapi.memif_socket_filename_dump()
36     for d in dump:
37         if d.socket_id != 0:
38             _test.vapi.memif_socket_filename_add_del(
39                 0, d.socket_id, d.socket_filename)
40
41
42 class VppSocketFilename(VppObject):
43     def __init__(self, test, socket_id, socket_filename,
44                  add_default_folder=False):
45         self._test = test
46         self.socket_id = socket_id
47         self.socket_filename = socket_filename
48
49         # if True insert default socket folder before socket filename,
50         # after adding vpp config
51         self.add_default_folder = add_default_folder
52
53     def add_vpp_config(self):
54         rv = self._test.vapi.memif_socket_filename_add_del(
55             1, self.socket_id, self.socket_filename)
56         if self.add_default_folder:
57             self.socket_filename = b"%s/%s" % (
58                 six.ensure_binary(self._test.tempdir, encoding='utf-8'),
59                 self.socket_filename)
60         return rv
61
62     def remove_vpp_config(self):
63         return self._test.vapi.memif_socket_filename_add_del(
64             0, self.socket_id, self.socket_filename)
65
66     def query_vpp_config(self):
67         return self._test.vapi.memif_socket_filename_dump()
68
69     def object_id(self):
70         return "socket-filename-%d-%s" % (self.socket_id, self.socket_filename)
71
72
73 class VppMemif(VppObject):
74     def __init__(self, test, role, mode, rx_queues=0, tx_queues=0, if_id=0,
75                  socket_id=0, secret="", ring_size=0, buffer_size=0,
76                  hw_addr=""):
77         self._test = test
78         self.role = role
79         self.mode = mode
80         self.rx_queues = rx_queues
81         self.tx_queues = tx_queues
82         self.if_id = if_id
83         self.socket_id = socket_id
84         self.secret = secret
85         self.ring_size = ring_size
86         self.buffer_size = buffer_size
87         self.hw_addr = hw_addr
88         self.sw_if_index = None
89         self.ip_prefix = VppIpPrefix("192.168.%d.%d" %
90                                      (self.if_id + 1, self.role + 1), 24)
91
92     def add_vpp_config(self):
93         rv = self._test.vapi.memif_create(
94             role=self.role,
95             mode=self.mode,
96             rx_queues=self.rx_queues,
97             tx_queues=self.tx_queues,
98             id=self.if_id,
99             socket_id=self.socket_id,
100             secret=self.secret,
101             ring_size=self.ring_size,
102             buffer_size=self.buffer_size,
103             hw_addr=self.hw_addr)
104         try:
105             self.sw_if_index = 0
106         except AttributeError:
107             raise AttributeError('self: %s' % self.__dict__)
108         try:
109             self.sw_if_index = rv.sw_if_index
110         except AttributeError:
111             raise AttributeError("%s %s", self, rv)
112
113         return self.sw_if_index
114
115     def admin_up(self):
116         if self.sw_if_index:
117             return self._test.vapi.sw_interface_set_flags(
118                 sw_if_index=self.sw_if_index, flags=1)
119
120     def admin_down(self):
121         if self.sw_if_index:
122             return self._test.vapi.sw_interface_set_flags(
123                 sw_if_index=self.sw_if_index, flags=0)
124
125     def wait_for_link_up(self, timeout, step=1):
126         if not self.sw_if_index:
127             return False
128         while True:
129             dump = self.query_vpp_config()
130             if dump.link_up_down == 1:
131                 return True
132             self._test.sleep(step)
133             timeout -= step
134             if timeout <= 0:
135                 return False
136
137     def config_ip4(self):
138         return self._test.vapi.sw_interface_add_del_address(
139             sw_if_index=self.sw_if_index, prefix=self.ip_prefix.encode())
140
141     def remove_vpp_config(self):
142         self._test.vapi.memif_delete(self.sw_if_index)
143         self.sw_if_index = None
144
145     def query_vpp_config(self):
146         if not self.sw_if_index:
147             return None
148         dump = self._test.vapi.memif_dump()
149         return get_if_dump(dump, self.sw_if_index)
150
151     def object_id(self):
152         if self.sw_if_index:
153             return "%d:%d:%d" % (self.role, self.if_id, self.sw_if_index)
154         else:
155             return "%d:%d:None" % (self.role, self.if_id)