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