3 # Copyright (c) 2016 Cisco and/or its affiliates.
4 # Licensed under the Apache License, Version 2.0 (the "License");
5 # you may not use this file except in compliance with the License.
6 # You may obtain a copy of the License at:
8 # http://www.apache.org/licenses/LICENSE-2.0
10 # Unless required by applicable law or agreed to in writing, software
11 # distributed under the License is distributed on an "AS IS" BASIS,
12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 # See the License for the specific language governing permissions and
14 # limitations under the License.
17 from __future__ import print_function
18 import sys, os, logging, collections, struct, json, threading
19 logging.basicConfig(level=logging.DEBUG)
22 def eprint(*args, **kwargs):
23 print(*args, file=sys.stderr, **kwargs)
26 def __init__(self, apifiles):
30 self.buffersize = 10000
31 self.connected = False
32 self.header = struct.Struct('>HI')
38 self.apifile.append(file)
39 with open(file) as apidef_file:
40 api = json.load(apidef_file)
41 for t in api['types']:
42 self.add_type(t[0], t[1:])
44 for m in api['messages']:
45 self.add_message(m[0], m[1:])
48 if not 'control_ping' in self.messages:
49 raise ValueError(1, 'Error in JSON message definitions')
52 class ContextId(object):
58 get_context = ContextId()
61 print('Connected') if self.connected else print('Not Connected')
62 print('Read API definitions from', self.apifile)
64 def __struct (self, t, n = None, e = 0, vl = None):
65 base_types = { 'u8' : 'B',
78 return struct.Struct('>' + str(e) + 's')
80 # Fixed array of base type
81 return [e, struct.Struct('>' + base_types[t])]
83 # Variable length array
84 return [vl, struct.Struct('>s')] if t == 'u8' else [vl, struct.Struct('>' + base_types[t])]
86 return struct.Struct('>' + base_types[t])
88 if t in self.messages:
89 ### Return a list in case of array ###
91 return [e, lambda self, encode, buf, offset, args: (
92 self.__struct_type(encode, self.messages[t], buf, offset, args)
95 return [vl, lambda self, encode, buf, offset, args: (
96 self.__struct_type(encode, self.messages[t], buf, offset, args)
98 return lambda self, encode, buf, offset, args: (
99 self.__struct_type(encode, self.messages[t], buf, offset, args)
104 def __struct_type(self, encode, msgdef, buf, offset, kwargs):
106 return self.__struct_type_encode(msgdef, buf, offset, kwargs)
108 return self.__struct_type_decode(msgdef, buf, offset)
110 def __struct_type_encode(self, msgdef, buf, offset, kwargs):
115 if k not in msgdef['args']:
116 raise ValueError(1, 'Invalid field-name in message call ' + k)
118 for k,v in msgdef['args'].iteritems():
129 size += v[1](self, True, buf, off + size,
137 buf[off:off + l] = bytearray(kwargs[k])
142 v[1].pack_into(buf, off + size, i)
146 size = v(self, True, buf, off, kwargs[k])
148 v.pack_into(buf, off, kwargs[k])
151 size = v.size if not type(v) is list else 0
153 return off + size - offset
156 def __getitem__(self, name):
157 if name in self.messages:
158 return self.messages[name]
161 def encode(self, msgdef, kwargs):
162 # Make suitably large buffer
163 buf = bytearray(self.buffersize)
165 size = self.__struct_type(True, msgdef, buf, offset, kwargs)
166 return buf[:offset + size]
168 def decode(self, msgdef, buf):
169 return self.__struct_type(False, msgdef, buf, 0, None)[1]
171 def __struct_type_decode(self, msgdef, buf, offset):
175 for k,v in msgdef['args'].iteritems():
179 if callable(v[1]): # compound type
181 if v[0] in msgdef['args']: # vla
187 (s,l) = v[1](self, False, buf, off + size, None)
194 res.append(buf[off:off + size])
203 lst.append(v[1].unpack_from(buf, off + size)[0])
207 (s,l) = v(self, False, buf, off, None)
211 res.append(v.unpack_from(buf, off)[0])
214 return off + size - offset, msgdef['return_tuple']._make(res)
216 def ret_tup(self, name):
217 if name in self.messages and 'return_tuple' in self.messages[name]:
218 return self.messages[name]['return_tuple']
221 def add_message(self, name, msgdef):
222 if name in self.messages:
223 raise ValueError('Duplicate message name: ' + name)
225 args = collections.OrderedDict()
229 if type(f) is dict and 'crc' in f:
230 msg['crc'] = f['crc']
233 args[field_name] = self.__struct(*f)
234 fields.append(field_name)
235 msg['return_tuple'] = collections.namedtuple(name, fields,
237 self.messages[name] = msg
238 self.messages[name]['args'] = args
239 return self.messages[name]
241 def add_type(self, name, typedef):
242 self.add_message('vl_api_' + name + '_t', typedef)
244 def make_function(self, i, msgdef, multipart):
245 return lambda **kwargs: (self._call_vpp(i, msgdef, multipart, **kwargs))
247 def _register_functions(self):
248 self.id_names = [None] * (self.vpp_dictionary_maxid + 1)
249 self.id_msgdef = [None] * (self.vpp_dictionary_maxid + 1)
250 for name, msgdef in self.messages.iteritems():
251 if name in self.vpp_dictionary:
252 if self.messages[name]['crc'] != self.vpp_dictionary[name]['crc']:
253 raise ValueError(3, 'Failed CRC checksum ' + name +
254 ' ' + self.messages[name]['crc'] +
255 ' ' + self.vpp_dictionary[name]['crc'])
256 i = self.vpp_dictionary[name]['id']
257 self.id_msgdef[i] = msgdef
258 self.id_names[i] = name
259 multipart = True if name.find('_dump') > 0 else False
260 setattr(self, name, self.make_function(i, msgdef, multipart))
262 def _write (self, buf):
263 if not self.connected:
264 raise IOError(1, 'Not connected')
265 return vpp_api.write(str(buf))
267 def _load_dictionary(self):
268 self.vpp_dictionary = {}
269 self.vpp_dictionary_maxid = 0
270 d = vpp_api.msg_table()
273 raise IOError(3, 'Cannot get VPP API dictionary')
275 name, crc = n.rsplit('_', 1)
277 self.vpp_dictionary[name] = { 'id' : i, 'crc' : crc }
278 self.vpp_dictionary_maxid = max(self.vpp_dictionary_maxid, i)
280 def connect(self, name, chroot_prefix = None, async = False):
281 msg_handler = self.msg_handler if not async else self.msg_handler_async
282 if not chroot_prefix:
283 rv = vpp_api.connect(name, msg_handler)
285 rv = vpp_api.connect(name, msg_handler, chroot_prefix)
288 raise IOError(2, 'Connect failed')
289 self.connected = True
291 self._load_dictionary()
292 self._register_functions()
294 # Initialise control ping
295 self.control_ping_index = self.vpp_dictionary['control_ping']['id']
296 self.control_ping_msgdef = self.messages['control_ping']
298 def disconnect(self):
299 rv = vpp_api.disconnect()
302 def results_wait(self, context):
303 return (self.results[context]['e'].wait(self.timeout))
305 def results_prepare(self, context):
306 self.results[context] = {}
307 self.results[context]['e'] = threading.Event()
308 self.results[context]['e'].clear()
309 self.results[context]['r'] = []
311 def results_clean(self, context):
312 del self.results[context]
314 def msg_handler(self, msg):
316 eprint('vpp_api.read failed')
319 i, ci = self.header.unpack_from(msg, 0)
320 if self.id_names[i] == 'rx_thread_exit':
324 # Decode message and returns a tuple.
326 msgdef = self.id_msgdef[i]
328 raise IOError(2, 'Reply message undefined')
330 r = self.decode(msgdef, msg)
331 if 'context' in r._asdict():
335 msgname = type(r).__name__
338 # XXX: Call provided callback for event
339 # Are we guaranteed to not get an event during processing of other messages?
340 # How to differentiate what's a callback message and what not? Context = 0?
342 #if not is_waiting_for_reply():
343 if r.context == 0 and self.event_callback:
344 self.event_callback(msgname, r)
348 # Collect results until control ping
350 if msgname == 'control_ping_reply':
351 self.results[context]['e'].set()
354 if not context in self.results:
355 eprint('Not expecting results for this context', context, r)
358 if 'm' in self.results[context]:
359 self.results[context]['r'].append(r)
362 self.results[context]['r'] = r
363 self.results[context]['e'].set()
365 def msg_handler_async(self, msg):
367 eprint('vpp_api.read failed')
370 i, ci = self.header.unpack_from(msg, 0)
371 if self.id_names[i] == 'rx_thread_exit':
375 # Decode message and returns a tuple.
377 msgdef = self.id_msgdef[i]
379 raise IOError(2, 'Reply message undefined')
381 r = self.decode(msgdef, msg)
382 msgname = type(r).__name__
384 self.event_callback(msgname, r)
386 def _control_ping(self, context):
387 self._write(self.encode(self.control_ping_msgdef,
388 { '_vl_msg_id' : self.control_ping_index,
389 'context' : context}))
391 def _call_vpp(self, i, msgdef, multipart, **kwargs):
392 if not 'context' in kwargs:
393 context = self.get_context()
394 kwargs['context'] = context
396 context = kwargs['context']
397 kwargs['_vl_msg_id'] = i
398 b = self.encode(msgdef, kwargs)
400 self.results_prepare(context)
403 self.results[context]['m'] = True
404 self._control_ping(context)
408 self.results_wait(context)
409 r = self.results[context]['r']
410 self.results_clean(context)
413 def _call_vpp_async(self, i, msgdef, multipart, **kwargs):
414 if not 'context' in kwargs:
415 context = self.get_context()
416 kwargs['context'] = context
418 context = kwargs['context']
419 kwargs['_vl_msg_id'] = i
420 b = self.encode(msgdef, kwargs)
424 def register_event_callback(self, callback):
425 self.event_callback = callback