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, glob
19 logging.basicConfig(level=logging.DEBUG)
22 def eprint(*args, **kwargs):
23 print(*args, file=sys.stderr, **kwargs)
26 def __init__(self, apifiles = None, testmode = False):
30 self.buffersize = 10000
31 self.connected = False
32 self.header = struct.Struct('>HI')
38 # Pick up API definitions from default directory
39 apifiles = glob.glob('/usr/share/vpp/api/*.api.json')
42 self.apifile.append(file)
43 with open(file) as apidef_file:
44 api = json.load(apidef_file)
45 for t in api['types']:
46 self.add_type(t[0], t[1:])
48 for m in api['messages']:
49 self.add_message(m[0], m[1:])
52 if len(self.messages) == 0 and not testmode:
53 raise ValueError(1, 'Missing JSON message definitions')
56 class ContextId(object):
62 get_context = ContextId()
65 print('Connected') if self.connected else print('Not Connected')
66 print('Read API definitions from', self.apifile)
68 def __struct (self, t, n = None, e = -1, vl = None):
69 base_types = { 'u8' : 'B',
80 if e > 0 and t == 'u8':
82 return struct.Struct('>' + str(e) + 's')
84 # Fixed array of base type
85 return [e, struct.Struct('>' + base_types[t])]
87 # Old style variable array
88 return [-1, struct.Struct('>' + base_types[t])]
90 # Variable length array
91 return [vl, struct.Struct('>s')] if t == 'u8' else \
92 [vl, struct.Struct('>' + base_types[t])]
94 return struct.Struct('>' + base_types[t])
96 if t in self.messages:
97 ### Return a list in case of array ###
99 return [e, lambda self, encode, buf, offset, args: (
100 self.__struct_type(encode, self.messages[t], buf, offset,
103 return [vl, lambda self, encode, buf, offset, args: (
104 self.__struct_type(encode, self.messages[t], buf, offset,
108 raise NotImplementedError(1, 'No support for compound types ' + t)
109 return lambda self, encode, buf, offset, args: (
110 self.__struct_type(encode, self.messages[t], buf, offset, args)
113 raise ValueError(1, 'Invalid message type: ' + t)
115 def __struct_type(self, encode, msgdef, buf, offset, kwargs):
117 return self.__struct_type_encode(msgdef, buf, offset, kwargs)
119 return self.__struct_type_decode(msgdef, buf, offset)
121 def __struct_type_encode(self, msgdef, buf, offset, kwargs):
126 if k not in msgdef['args']:
127 raise ValueError(1, 'Invalid field-name in message call ' + k)
129 for k,v in msgdef['args'].iteritems():
134 e = kwargs[v[0]] if v[0] in kwargs else v[0]
137 size += v[1](self, True, buf, off + size,
145 buf[off:off + l] = bytearray(kwargs[k])
150 v[1].pack_into(buf, off + size, i)
154 size = v(self, True, buf, off, kwargs[k])
156 v.pack_into(buf, off, kwargs[k])
159 size = v.size if not type(v) is list else 0
161 return off + size - offset
164 def __getitem__(self, name):
165 if name in self.messages:
166 return self.messages[name]
169 def encode(self, msgdef, kwargs):
170 # Make suitably large buffer
171 buf = bytearray(self.buffersize)
173 size = self.__struct_type(True, msgdef, buf, offset, kwargs)
174 return buf[:offset + size]
176 def decode(self, msgdef, buf):
177 return self.__struct_type(False, msgdef, buf, 0, None)[1]
179 def __struct_type_decode(self, msgdef, buf, offset):
183 for k,v in msgdef['args'].iteritems():
187 if callable(v[1]): # compound type
189 if v[0] in msgdef['args']: # vla
195 (s,l) = v[1](self, False, buf, off + size, None)
200 if type(v[0]) is int:
201 size = len(buf) - off
204 res.append(buf[off:off + size])
206 e = v[0] if type(v[0]) is int else res[v[2]]
208 e = (len(buf) - off) / v[1].size
213 lst.append(v[1].unpack_from(buf, off + size)[0])
217 (s,l) = v(self, False, buf, off, None)
221 res.append(v.unpack_from(buf, off)[0])
224 return off + size - offset, msgdef['return_tuple']._make(res)
226 def ret_tup(self, name):
227 if name in self.messages and 'return_tuple' in self.messages[name]:
228 return self.messages[name]['return_tuple']
231 def add_message(self, name, msgdef):
232 if name in self.messages:
233 raise ValueError('Duplicate message name: ' + name)
235 args = collections.OrderedDict()
236 argtypes = collections.OrderedDict()
239 for i, f in enumerate(msgdef):
240 if type(f) is dict and 'crc' in f:
241 msg['crc'] = f['crc']
245 if len(f) == 3 and f[2] == 0 and i != len(msgdef) - 2:
246 raise ValueError('Variable Length Array must be last: ' + name)
247 args[field_name] = self.__struct(*f)
248 argtypes[field_name] = field_type
249 if len(f) == 4: # Find offset to # elements field
250 args[field_name].append(args.keys().index(f[3]) - i)
251 fields.append(field_name)
252 msg['return_tuple'] = collections.namedtuple(name, fields,
254 self.messages[name] = msg
255 self.messages[name]['args'] = args
256 self.messages[name]['argtypes'] = argtypes
257 return self.messages[name]
259 def add_type(self, name, typedef):
260 return self.add_message('vl_api_' + name + '_t', typedef)
262 def make_function(self, name, i, msgdef, multipart, async):
264 f = lambda **kwargs: (self._call_vpp_async(i, msgdef, multipart, **kwargs))
266 f = lambda **kwargs: (self._call_vpp(i, msgdef, multipart, **kwargs))
267 args = self.messages[name]['args']
268 argtypes = self.messages[name]['argtypes']
269 f.__name__ = str(name)
270 f.__doc__ = ", ".join(["%s %s" % (argtypes[k], k) for k in args.keys()])
273 def _register_functions(self, async=False):
274 self.id_names = [None] * (self.vpp_dictionary_maxid + 1)
275 self.id_msgdef = [None] * (self.vpp_dictionary_maxid + 1)
276 for name, msgdef in self.messages.iteritems():
277 if name in self.vpp_dictionary:
278 if self.messages[name]['crc'] != self.vpp_dictionary[name]['crc']:
279 raise ValueError(3, 'Failed CRC checksum ' + name +
280 ' ' + self.messages[name]['crc'] +
281 ' ' + self.vpp_dictionary[name]['crc'])
282 i = self.vpp_dictionary[name]['id']
283 self.id_msgdef[i] = msgdef
284 self.id_names[i] = name
285 multipart = True if name.find('_dump') > 0 else False
286 setattr(self, name, self.make_function(name, i, msgdef, multipart, async))
288 def _write (self, buf):
289 if not self.connected:
290 raise IOError(1, 'Not connected')
291 return vpp_api.write(str(buf))
293 def _load_dictionary(self):
294 self.vpp_dictionary = {}
295 self.vpp_dictionary_maxid = 0
296 d = vpp_api.msg_table()
299 raise IOError(3, 'Cannot get VPP API dictionary')
301 name, crc = n.rsplit('_', 1)
303 self.vpp_dictionary[name] = { 'id' : i, 'crc' : crc }
304 self.vpp_dictionary_maxid = max(self.vpp_dictionary_maxid, i)
306 def connect(self, name, chroot_prefix = None, async = False, rx_qlen = 32):
307 msg_handler = self.msg_handler if not async else self.msg_handler_async
308 if not chroot_prefix:
309 rv = vpp_api.connect(name, msg_handler, rx_qlen)
311 rv = vpp_api.connect(name, msg_handler, rx_qlen, chroot_prefix)
314 raise IOError(2, 'Connect failed')
315 self.connected = True
317 self._load_dictionary()
318 self._register_functions(async=async)
320 # Initialise control ping
321 self.control_ping_index = self.vpp_dictionary['control_ping']['id']
322 self.control_ping_msgdef = self.messages['control_ping']
324 def disconnect(self):
325 rv = vpp_api.disconnect()
328 def results_wait(self, context):
329 return (self.results[context]['e'].wait(self.timeout))
331 def results_prepare(self, context):
332 self.results[context] = {}
333 self.results[context]['e'] = threading.Event()
334 self.results[context]['e'].clear()
335 self.results[context]['r'] = []
337 def results_clean(self, context):
338 del self.results[context]
340 def msg_handler(self, msg):
342 eprint('vpp_api.read failed')
345 i, ci = self.header.unpack_from(msg, 0)
346 if self.id_names[i] == 'rx_thread_exit':
350 # Decode message and returns a tuple.
352 msgdef = self.id_msgdef[i]
354 raise IOError(2, 'Reply message undefined')
356 r = self.decode(msgdef, msg)
357 if 'context' in r._asdict():
361 msgname = type(r).__name__
364 # XXX: Call provided callback for event
365 # Are we guaranteed to not get an event during processing of other messages?
366 # How to differentiate what's a callback message and what not? Context = 0?
368 #if not is_waiting_for_reply():
369 if r.context == 0 and self.event_callback:
370 self.event_callback(msgname, r)
374 # Collect results until control ping
376 if msgname == 'control_ping_reply':
377 self.results[context]['e'].set()
380 if not context in self.results:
381 eprint('Not expecting results for this context', context, r)
384 if 'm' in self.results[context]:
385 self.results[context]['r'].append(r)
388 self.results[context]['r'] = r
389 self.results[context]['e'].set()
391 def msg_handler_async(self, msg):
393 eprint('vpp_api.read failed')
396 i, ci = self.header.unpack_from(msg, 0)
397 if self.id_names[i] == 'rx_thread_exit':
401 # Decode message and returns a tuple.
403 msgdef = self.id_msgdef[i]
405 raise IOError(2, 'Reply message undefined')
407 r = self.decode(msgdef, msg)
408 msgname = type(r).__name__
410 self.event_callback(msgname, r)
412 def _control_ping(self, context):
413 self._write(self.encode(self.control_ping_msgdef,
414 { '_vl_msg_id' : self.control_ping_index,
415 'context' : context}))
417 def _call_vpp(self, i, msgdef, multipart, **kwargs):
418 if not 'context' in kwargs:
419 context = self.get_context()
420 kwargs['context'] = context
422 context = kwargs['context']
423 kwargs['_vl_msg_id'] = i
424 b = self.encode(msgdef, kwargs)
426 self.results_prepare(context)
430 self.results[context]['m'] = True
431 self._control_ping(context)
432 self.results_wait(context)
433 r = self.results[context]['r']
434 self.results_clean(context)
437 def _call_vpp_async(self, i, msgdef, multipart, **kwargs):
438 if not 'context' in kwargs:
439 context = self.get_context()
440 kwargs['context'] = context
442 context = kwargs['context']
443 kwargs['_vl_msg_id'] = i
444 b = self.encode(msgdef, kwargs)
448 def register_event_callback(self, callback):
449 self.event_callback = callback