vpp-api/python/vpp_papi/vpp_papi.py

   1 #!/usr/bin/env python
   2 #
   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:
   7 #
   8 #     http://www.apache.org/licenses/LICENSE-2.0
   9 #
  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.
  15 #
  16
  17 from __future__ import print_function
  18 import sys, os, logging, collections, struct, json, threading, glob
  19 logging.basicConfig(level=logging.DEBUG)
  20 import vpp_api
  21
  22 def eprint(*args, **kwargs):
  23     print(*args, file=sys.stderr, **kwargs)
  24
  25 class VPP():
  26     def __init__(self, apifiles = None, testmode = False):
  27         self.messages = {}
  28         self.id_names = []
  29         self.id_msgdef = []
  30         self.buffersize = 10000
  31         self.connected = False
  32         self.header = struct.Struct('>HI')
  33         self.results = {}
  34         self.timeout = 5
  35         self.apifile = []
  36
  37         if not apifiles:
  38             # Pick up API definitions from default directory
  39             apifiles = glob.glob('/usr/share/vpp/api/*.api.json')
  40
  41         for file in apifiles:
  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:])
  47
  48                 for m in api['messages']:
  49                     self.add_message(m[0], m[1:])
  50
  51         # Basic sanity check
  52         if len(self.messages) == 0 and not testmode:
  53             raise ValueError(1, 'Missing JSON message definitions')
  54
  55
  56     class ContextId(object):
  57         def __init__(self):
  58             self.context = 0
  59         def __call__(self):
  60             self.context += 1
  61             return self.context
  62     get_context = ContextId()
  63
  64     def status(self):
  65         print('Connected') if self.connected else print('Not Connected')
  66         print('Read API definitions from', self.apifile)
  67
  68     def __struct (self, t, n = None, e = -1, vl = None):
  69         base_types = { 'u8' : 'B',
  70                        'u16' : 'H',
  71                        'u32' : 'I',
  72                        'i32' : 'i',
  73                        'u64' : 'Q',
  74                        'f64' : 'd',
  75                        }
  76         pack = None
  77         if t in base_types:
  78             pack = base_types[t]
  79             if not vl:
  80                 if e > 0 and t == 'u8':
  81                     # Fixed byte array
  82                     return struct.Struct('>' + str(e) + 's')
  83                 if e > 0:
  84                     # Fixed array of base type
  85                     return [e, struct.Struct('>' + base_types[t])]
  86                 elif e == 0:
  87                     # Old style variable array
  88                     return [-1, struct.Struct('>' + base_types[t])]
  89             else:
  90                 # Variable length array
  91                 return [vl, struct.Struct('>s')] if t == 'u8' else \
  92                     [vl, struct.Struct('>' + base_types[t])]
  93
  94             return struct.Struct('>' + base_types[t])
  95
  96         if t in self.messages:
  97             ### Return a list in case of array ###
  98             if e > 0 and not vl:
  99                 return [e, lambda self, encode, buf, offset, args: (
 100                     self.__struct_type(encode, self.messages[t], buf, offset,
 101                                        args))]
 102             if vl:
 103                 return [vl, lambda self, encode, buf, offset, args: (
 104                     self.__struct_type(encode, self.messages[t], buf, offset,
 105                                        args))]
 106             elif e == 0:
 107                 # Old style VLA
 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)
 111             )
 112
 113         raise ValueError(1, 'Invalid message type: ' + t)
 114
 115     def __struct_type(self, encode, msgdef, buf, offset, kwargs):
 116         if encode:
 117             return self.__struct_type_encode(msgdef, buf, offset, kwargs)
 118         else:
 119             return self.__struct_type_decode(msgdef, buf, offset)
 120
 121     def __struct_type_encode(self, msgdef, buf, offset, kwargs):
 122         off = offset
 123         size = 0
 124
 125         for k in kwargs:
 126             if k not in msgdef['args']:
 127                 raise ValueError(1, 'Invalid field-name in message call ' + k)
 128
 129         for k,v in msgdef['args'].iteritems():
 130             off += size
 131             if k in kwargs:
 132                 if type(v) is list:
 133                     if callable(v[1]):
 134                         e = kwargs[v[0]] if v[0] in kwargs else v[0]
 135                         size = 0
 136                         for i in range(e):
 137                             size += v[1](self, True, buf, off + size,
 138                                          kwargs[k][i])
 139                     else:
 140                         if v[0] in kwargs:
 141                             l = kwargs[v[0]]
 142                         else:
 143                             l = len(kwargs[k])
 144                         if v[1].size == 1:
 145                             buf[off:off + l] = bytearray(kwargs[k])
 146                             size = l
 147                         else:
 148                             size = 0
 149                             for i in kwargs[k]:
 150                                 v[1].pack_into(buf, off + size, i)
 151                                 size += v[1].size
 152                 else:
 153                     if callable(v):
 154                         size = v(self, True, buf, off, kwargs[k])
 155                     else:
 156                         v.pack_into(buf, off, kwargs[k])
 157                         size = v.size
 158             else:
 159                 size = v.size if not type(v) is list else 0
 160
 161         return off + size - offset
 162
 163
 164     def __getitem__(self, name):
 165         if name in self.messages:
 166             return self.messages[name]
 167         return None
 168
 169     def encode(self, msgdef, kwargs):
 170         # Make suitably large buffer
 171         buf = bytearray(self.buffersize)
 172         offset = 0
 173         size = self.__struct_type(True, msgdef, buf, offset, kwargs)
 174         return buf[:offset + size]
 175
 176     def decode(self, msgdef, buf):
 177         return self.__struct_type(False, msgdef, buf, 0, None)[1]
 178
 179     def __struct_type_decode(self, msgdef, buf, offset):
 180         res = []
 181         off = offset
 182         size = 0
 183         for k,v in msgdef['args'].iteritems():
 184             off += size
 185             if type(v) is list:
 186                 lst = []
 187                 if callable(v[1]): # compound type
 188                     size = 0
 189                     if v[0] in msgdef['args']: # vla
 190                         e = res[v[2]]
 191                     else: # fixed array
 192                         e = v[0]
 193                     res.append(lst)
 194                     for i in range(e):
 195                         (s,l) = v[1](self, False, buf, off + size, None)
 196                         lst.append(l)
 197                         size += s
 198                     continue
 199                 if v[1].size == 1:
 200                     if type(v[0]) is int:
 201                         size = len(buf) - off
 202                     else:
 203                         size = res[v[2]]
 204                     res.append(buf[off:off + size])
 205                 else:
 206                     e = v[0] if type(v[0]) is int else res[v[2]]
 207                     if e == -1:
 208                         e = (len(buf) - off) / v[1].size
 209                     if e == 0:
 210                         raise ValueError(1,
 211                                          'Variable length array, empty length: ' + k)
 212                     lst = []
 213                     res.append(lst)
 214                     size = 0
 215                     for i in range(e):
 216                         lst.append(v[1].unpack_from(buf, off + size)[0])
 217                         size += v[1].size
 218             else:
 219                 if callable(v):
 220                     (s,l) = v(self, False, buf, off, None)
 221                     res.append(l)
 222                     size += s
 223                 else:
 224                     res.append(v.unpack_from(buf, off)[0])
 225                     size = v.size
 226
 227         return off + size - offset, msgdef['return_tuple']._make(res)
 228
 229     def ret_tup(self, name):
 230         if name in self.messages and 'return_tuple' in self.messages[name]:
 231             return self.messages[name]['return_tuple']
 232         return None
 233
 234     def add_message(self, name, msgdef):
 235         if name in self.messages:
 236             raise ValueError('Duplicate message name: ' + name)
 237
 238         args = collections.OrderedDict()
 239         argtypes = collections.OrderedDict()
 240         fields = []
 241         msg = {}
 242         for i, f in enumerate(msgdef):
 243             if type(f) is dict and 'crc' in f:
 244                 msg['crc'] = f['crc']
 245                 continue
 246             field_type = f[0]
 247             field_name = f[1]
 248             if len(f) == 3 and f[2] == 0 and i != len(msgdef) - 2:
 249                 raise ValueError('Variable Length Array must be last: ' + name)
 250             args[field_name] = self.__struct(*f)
 251             argtypes[field_name] = field_type
 252             if len(f) == 4: # Find offset to # elements field
 253                 args[field_name].append(args.keys().index(f[3]) - i)
 254             fields.append(field_name)
 255         msg['return_tuple'] = collections.namedtuple(name, fields,
 256                                                      rename = True)
 257         self.messages[name] = msg
 258         self.messages[name]['args'] = args
 259         self.messages[name]['argtypes'] = argtypes
 260         return self.messages[name]
 261
 262     def add_type(self, name, typedef):
 263         return self.add_message('vl_api_' + name + '_t', typedef)
 264
 265     def make_function(self, name, i, msgdef, multipart, async):
 266         if (async):
 267             f = lambda **kwargs: (self._call_vpp_async(i, msgdef, multipart, **kwargs))
 268         else:
 269             f = lambda **kwargs: (self._call_vpp(i, msgdef, multipart, **kwargs))
 270         args = self.messages[name]['args']
 271         argtypes = self.messages[name]['argtypes']
 272         f.__name__ = str(name)
 273         f.__doc__ = ", ".join(["%s %s" % (argtypes[k], k) for k in args.keys()])
 274         return f
 275
 276     def _register_functions(self, async=False):
 277         self.id_names = [None] * (self.vpp_dictionary_maxid + 1)
 278         self.id_msgdef = [None] * (self.vpp_dictionary_maxid + 1)
 279         for name, msgdef in self.messages.iteritems():
 280             if name in self.vpp_dictionary:
 281                 if self.messages[name]['crc'] != self.vpp_dictionary[name]['crc']:
 282                     raise ValueError(3, 'Failed CRC checksum ' + name +
 283                                      ' ' + self.messages[name]['crc'] +
 284                                      ' ' + self.vpp_dictionary[name]['crc'])
 285                 i = self.vpp_dictionary[name]['id']
 286                 self.id_msgdef[i] = msgdef
 287                 self.id_names[i] = name
 288                 multipart = True if name.find('_dump') > 0 else False
 289                 setattr(self, name, self.make_function(name, i, msgdef, multipart, async))
 290
 291     def _write (self, buf):
 292         if not self.connected:
 293             raise IOError(1, 'Not connected')
 294         return vpp_api.write(str(buf))
 295
 296     def _load_dictionary(self):
 297         self.vpp_dictionary = {}
 298         self.vpp_dictionary_maxid = 0
 299         d = vpp_api.msg_table()
 300
 301         if not d:
 302             raise IOError(3, 'Cannot get VPP API dictionary')
 303         for i,n in d:
 304             name, crc =  n.rsplit('_', 1)
 305             crc = '0x' + crc
 306             self.vpp_dictionary[name] = { 'id' : i, 'crc' : crc }
 307             self.vpp_dictionary_maxid = max(self.vpp_dictionary_maxid, i)
 308
 309     def connect(self, name, chroot_prefix = None, async = False):
 310         msg_handler = self.msg_handler if not async else self.msg_handler_async
 311         if not chroot_prefix:
 312             rv = vpp_api.connect(name, msg_handler)
 313         else:
 314             rv = vpp_api.connect(name, msg_handler, chroot_prefix)
 315
 316         if rv != 0:
 317             raise IOError(2, 'Connect failed')
 318         self.connected = True
 319
 320         self._load_dictionary()
 321         self._register_functions(async=async)
 322
 323         # Initialise control ping
 324         self.control_ping_index = self.vpp_dictionary['control_ping']['id']
 325         self.control_ping_msgdef = self.messages['control_ping']
 326
 327     def disconnect(self):
 328         rv = vpp_api.disconnect()
 329         return rv
 330
 331     def results_wait(self, context):
 332         return (self.results[context]['e'].wait(self.timeout))
 333
 334     def results_prepare(self, context):
 335         self.results[context] = {}
 336         self.results[context]['e'] = threading.Event()
 337         self.results[context]['e'].clear()
 338         self.results[context]['r'] = []
 339
 340     def results_clean(self, context):
 341         del self.results[context]
 342
 343     def msg_handler(self, msg):
 344         if not msg:
 345             eprint('vpp_api.read failed')
 346             return
 347
 348         i, ci = self.header.unpack_from(msg, 0)
 349         if self.id_names[i] == 'rx_thread_exit':
 350             return;
 351
 352         #
 353         # Decode message and returns a tuple.
 354         #
 355         msgdef = self.id_msgdef[i]
 356         if not msgdef:
 357             raise IOError(2, 'Reply message undefined')
 358
 359         r = self.decode(msgdef, msg)
 360         if 'context' in r._asdict():
 361             if r.context > 0:
 362                 context = r.context
 363
 364         msgname = type(r).__name__
 365
 366         #
 367         # XXX: Call provided callback for event
 368         # Are we guaranteed to not get an event during processing of other messages?
 369         # How to differentiate what's a callback message and what not? Context = 0?
 370         #
 371         #if not is_waiting_for_reply():
 372         if r.context == 0 and self.event_callback:
 373             self.event_callback(msgname, r)
 374             return
 375
 376         #
 377         # Collect results until control ping
 378         #
 379         if msgname == 'control_ping_reply':
 380             self.results[context]['e'].set()
 381             return
 382
 383         if not context in self.results:
 384             eprint('Not expecting results for this context', context, r)
 385             return
 386
 387         if 'm' in self.results[context]:
 388             self.results[context]['r'].append(r)
 389             return
 390
 391         self.results[context]['r'] = r
 392         self.results[context]['e'].set()
 393
 394     def msg_handler_async(self, msg):
 395         if not msg:
 396             eprint('vpp_api.read failed')
 397             return
 398
 399         i, ci = self.header.unpack_from(msg, 0)
 400         if self.id_names[i] == 'rx_thread_exit':
 401             return;
 402
 403         #
 404         # Decode message and returns a tuple.
 405         #
 406         msgdef = self.id_msgdef[i]
 407         if not msgdef:
 408             raise IOError(2, 'Reply message undefined')
 409
 410         r = self.decode(msgdef, msg)
 411         msgname = type(r).__name__
 412
 413         self.event_callback(msgname, r)
 414
 415     def _control_ping(self, context):
 416         self._write(self.encode(self.control_ping_msgdef,
 417                         { '_vl_msg_id' : self.control_ping_index,
 418                           'context' : context}))
 419
 420     def _call_vpp(self, i, msgdef, multipart, **kwargs):
 421         if not 'context' in kwargs:
 422             context = self.get_context()
 423             kwargs['context'] = context
 424         else:
 425             context = kwargs['context']
 426         kwargs['_vl_msg_id'] = i
 427         b = self.encode(msgdef, kwargs)
 428
 429         self.results_prepare(context)
 430         self._write(b)
 431
 432         if multipart:
 433             self.results[context]['m'] = True
 434             self._control_ping(context)
 435         self.results_wait(context)
 436         r = self.results[context]['r']
 437         self.results_clean(context)
 438         return r
 439
 440     def _call_vpp_async(self, i, msgdef, multipart, **kwargs):
 441         if not 'context' in kwargs:
 442             context = self.get_context()
 443             kwargs['context'] = context
 444         else:
 445             context = kwargs['context']
 446         kwargs['_vl_msg_id'] = i
 447         b = self.encode(msgdef, kwargs)
 448
 449         self._write(b)
 450
 451     def register_event_callback(self, callback):
 452         self.event_callback = callback
 453