2 # VPP Unix Domain Socket Transport.
16 class VppTransport(object):
17 def __init__(self, parent, read_timeout, server_address):
18 self.connected = False
19 self.read_timeout = read_timeout if read_timeout > 0 else 1
21 self.server_address = server_address
22 self.header = struct.Struct('>QII')
23 self.message_table = {}
24 self.sque = multiprocessing.Queue()
25 self.q = multiprocessing.Queue()
26 self.message_thread = threading.Thread(target=self.msg_thread_func)
28 def msg_thread_func(self):
31 rlist, _, _ = select.select([self.socket,
32 self.sque._reader], [], [])
35 logging.error('select failed')
40 if r == self.sque._reader:
45 elif r == self.socket:
54 # Put either to local queue or if context == 0
56 r = self.parent.decode_incoming_msg(msg)
57 if hasattr(r, 'context') and r.context > 0:
60 self.parent.msg_handler_async(msg)
62 raise IOError(2, 'Unknown response from select')
64 def connect(self, name, pfx, msg_handler, rx_qlen):
67 self.socket = socket.socket(socket.AF_UNIX, socket.SOCK_SEQPACKET)
68 self.socket.settimeout(self.read_timeout)
70 # Connect the socket to the port where the server is listening
72 self.socket.connect(self.server_address)
73 except socket.error as msg:
74 logging.error("{} on socket {}".format(msg, self.server_address))
78 # Initialise sockclnt_create
79 sockclnt_create = self.parent.messages['sockclnt_create']
80 sockclnt_create_reply = self.parent.messages['sockclnt_create_reply']
82 args = {'_vl_msg_id': 15,
85 b = sockclnt_create.pack(args)
88 hdr, length = self.parent.header.unpack(msg, 0)
90 raise IOError('Invalid reply message')
92 r, length = sockclnt_create_reply.unpack(msg)
93 self.socket_index = r.index
94 for m in r.message_table:
95 n = m.name.rstrip(b'\x00\x13')
96 self.message_table[n] = m.index
98 self.message_thread.daemon = True
99 self.message_thread.start()
103 def disconnect(self):
105 try: # Might fail, if VPP closes socket before packet makes it out
106 rv = self.parent.api.sockclnt_delete(index=self.socket_index)
109 self.connected = False
111 self.sque.put(True) # Terminate listening thread
112 self.message_thread.join()
124 def get_callback(self, do_async):
127 def get_msg_index(self, name):
129 return self.message_table[name]
133 def msg_table_max_index(self):
134 return len(self.message_table)
136 def write(self, buf):
137 """Send a binary-packed message to VPP."""
138 if not self.connected:
139 raise IOError(1, 'Not connected')
142 header = self.header.pack(0, len(buf), 0)
143 n = self.socket.send(header)
144 n = self.socket.send(buf)
149 msg = self.socket.recv(4096)
152 except socket.error as message:
153 logging.error(message)
156 (_, l, _) = self.header.unpack(msg[:16])
159 buf = bytearray(l + 16)
160 view = memoryview(buf)
163 # Read rest of message
164 remaining_bytes = l - 4096 + 16
165 while remaining_bytes > 0:
166 bytes_to_read = (remaining_bytes if remaining_bytes
168 nbytes = self.socket.recv_into(view, bytes_to_read)
170 logging.error('recv failed')
173 remaining_bytes -= nbytes
179 if not self.connected:
180 raise IOError(1, 'Not connected')
182 return self.q.get(True, self.read_timeout)