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
  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):
  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         for file in apifiles:
  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:])
  43
  44                 for m in api['messages']:
  45                     self.add_message(m[0], m[1:])
  46
  47         # Basic sanity check
  48         if not 'control_ping' in self.messages:
  49             raise ValueError(1, 'Error in JSON message definitions')
  50
  51
  52     class ContextId(object):
  53         def __init__(self):
  54             self.context = 0
  55         def __call__(self):
  56             self.context += 1
  57             return self.context
  58     get_context = ContextId()
  59
  60     def status(self):
  61         print('Connected') if self.connected else print('Not Connected')
  62         print('Read API definitions from', self.apifile)
  63
  64     def __struct (self, t, n = None, e = 0, vl = None):
  65         base_types = { 'u8' : 'B',
  66                        'u16' : 'H',
  67                        'u32' : 'I',
  68                        'i32' : 'i',
  69                        'u64' : 'Q',
  70                        'f64' : 'd',
  71                        }
  72         pack = None
  73         if t in base_types:
  74             pack = base_types[t]
  75             if not vl:
  76                 if e and t == 'u8':
  77                     # Fixed byte array
  78                     return struct.Struct('>' + str(e) + 's')
  79                 if e:
  80                     # Fixed array of base type
  81                     return [e, struct.Struct('>' + base_types[t])]
  82             else:
  83                 # Variable length array
  84                 return [vl, struct.Struct('>s')] if t == 'u8' else [vl, struct.Struct('>' + base_types[t])]
  85
  86             return struct.Struct('>' + base_types[t])
  87
  88         if t in self.messages:
  89             ### Return a list in case of array ###
  90             if e and not vl:
  91                 return [e, lambda self, encode, buf, offset, args: (
  92                     self.__struct_type(encode, self.messages[t], buf, offset, args)
  93                 )]
  94             if vl:
  95                 return [vl, lambda self, encode, buf, offset, args: (
  96                     self.__struct_type(encode, self.messages[t], buf, offset, args)
  97                 )]
  98             return lambda self, encode, buf, offset, args: (
  99                 self.__struct_type(encode, self.messages[t], buf, offset, args)
 100             )
 101
 102         raise ValueError
 103
 104     def __struct_type(self, encode, msgdef, buf, offset, kwargs):
 105         if encode:
 106             return self.__struct_type_encode(msgdef, buf, offset, kwargs)
 107         else:
 108             return self.__struct_type_decode(msgdef, buf, offset)
 109
 110     def __struct_type_encode(self, msgdef, buf, offset, kwargs):
 111         off = offset
 112         size = 0
 113         for k,v in msgdef['args'].iteritems():
 114             off += size
 115             if k in kwargs:
 116                 if type(v) is list:
 117                     if callable(v[1]):
 118                         if v[0] in kwargs:
 119                             e = kwargs[v[0]]
 120                         else:
 121                             e = v[0]
 122                         size = 0
 123                         for i in range(e):
 124                             size += v[1](self, True, buf, off + size,
 125                                          kwargs[k][i])
 126                     else:
 127                         if v[0] in kwargs:
 128                             l = kwargs[v[0]]
 129                         else:
 130                             l = len(kwargs[k])
 131                         if v[1].size == 1:
 132                             buf[off:off + l] = bytearray(kwargs[k])
 133                             size = l
 134                         else:
 135                             size = 0
 136                             for i in kwargs[k]:
 137                                 v[1].pack_into(buf, off + size, i)
 138                                 size += v[1].size
 139                 else:
 140                     if callable(v):
 141                         size = v(self, True, buf, off, kwargs[k])
 142                     else:
 143                         v.pack_into(buf, off, kwargs[k])
 144                         size = v.size
 145             else:
 146                 size = v.size
 147
 148         return off + size - offset
 149
 150
 151     def __getitem__(self, name):
 152         if name in self.messages:
 153             return self.messages[name]
 154         return None
 155
 156     def encode(self, msgdef, kwargs):
 157         # Make suitably large buffer
 158         buf = bytearray(self.buffersize)
 159         offset = 0
 160         size = self.__struct_type(True, msgdef, buf, offset, kwargs)
 161         return buf[:offset + size]
 162
 163     def decode(self, msgdef, buf):
 164         return self.__struct_type(False, msgdef, buf, 0, None)[1]
 165
 166     def __struct_type_decode(self, msgdef, buf, offset):
 167         res = []
 168         off = offset
 169         size = 0
 170         for k,v in msgdef['args'].iteritems():
 171             off += size
 172             if type(v) is list:
 173                 lst = []
 174                 if callable(v[1]): # compound type
 175                     size = 0
 176                     if v[0] in msgdef['args']: # vla
 177                         e = int(res[-1])
 178                     else: # fixed array
 179                         e = v[0]
 180                     res.append(lst)
 181                     for i in range(e):
 182                         (s,l) = v[1](self, False, buf, off + size, None)
 183                         lst.append(l)
 184                         size += s
 185                     continue
 186
 187                 if v[1].size == 1:
 188                     size = int(res[-1])
 189                     res.append(buf[off:off + size])
 190                 else:
 191                     e = int(res[-1])
 192                     if e == 0:
 193                         raise ValueError
 194                     lst = []
 195                     res.append(lst)
 196                     size = 0
 197                     for i in range(e):
 198                         lst.append(v[1].unpack_from(buf, off + size)[0])
 199                         size += v[1].size
 200             else:
 201                 if callable(v):
 202                     (s,l) = v(self, False, buf, off, None)
 203                     res.append(l)
 204                     size += s
 205                 else:
 206                     res.append(v.unpack_from(buf, off)[0])
 207                     size = v.size
 208
 209         return off + size - offset, msgdef['return_tuple']._make(res)
 210
 211     def ret_tup(self, name):
 212         if name in self.messages and 'return_tuple' in self.messages[name]:
 213             return self.messages[name]['return_tuple']
 214         return None
 215
 216     def add_message(self, name, msgdef):
 217         if name in self.messages:
 218             raise ValueError('Duplicate message name: ' + name)
 219
 220         args = collections.OrderedDict()
 221         fields = []
 222         msg = {}
 223         for f in msgdef:
 224             if type(f) is dict and 'crc' in f:
 225                 msg['crc'] = f['crc']
 226                 continue
 227             field_name = f[1]
 228             args[field_name] = self.__struct(*f)
 229             fields.append(field_name)
 230         msg['return_tuple'] = collections.namedtuple(name, fields,
 231                                                      rename = True)
 232         self.messages[name] = msg
 233         self.messages[name]['args'] = args
 234         return self.messages[name]
 235
 236     def add_type(self, name, typedef):
 237         self.add_message('vl_api_' + name + '_t', typedef)
 238
 239     def make_function(self, i, msgdef, multipart):
 240         return lambda **kwargs: (self._call_vpp(i, msgdef, multipart, **kwargs))
 241
 242     def _register_functions(self):
 243         self.id_names = [None] * (self.vpp_dictionary_maxid + 1)
 244         self.id_msgdef = [None] * (self.vpp_dictionary_maxid + 1)
 245         for name, msgdef in self.messages.iteritems():
 246             if name in self.vpp_dictionary:
 247                 if self.messages[name]['crc'] != self.vpp_dictionary[name]['crc']:
 248                     raise ValueError(3, 'Failed CRC checksum ' + name +
 249                                      ' ' + self.messages[name]['crc'] +
 250                                      ' ' + self.vpp_dictionary[name]['crc'])
 251                 i = self.vpp_dictionary[name]['id']
 252                 self.id_msgdef[i] = msgdef
 253                 self.id_names[i] = name
 254                 multipart = True if name.find('_dump') > 0 else False
 255                 setattr(self, name, self.make_function(i, msgdef, multipart))
 256
 257     def _write (self, buf):
 258         if not self.connected:
 259             raise IOError(1, 'Not connected')
 260         return vpp_api.write(str(buf))
 261
 262     def _load_dictionary(self):
 263         self.vpp_dictionary = {}
 264         self.vpp_dictionary_maxid = 0
 265
 266         d = vpp_api.msg_table()
 267
 268         if not d:
 269             raise IOError(3, 'Cannot get VPP API dictionary')
 270         for i,n in d:
 271             name, crc =  n.rsplit('_', 1)
 272             crc = '0x' + crc
 273             self.vpp_dictionary[name] = { 'id' : i, 'crc' : crc }
 274             self.vpp_dictionary_maxid = max(self.vpp_dictionary_maxid, i)
 275
 276     def connect(self, name, chroot_prefix = None):
 277         if not chroot_prefix:
 278             rv = vpp_api.connect(name, self.msg_handler)
 279         else:
 280             rv = vpp_api.connect(name, self.msg_handler, chroot_prefix)
 281
 282         if rv != 0:
 283             raise IOError(2, 'Connect failed')
 284
 285         self._load_dictionary()
 286         self._register_functions()
 287
 288         # Initialise control ping
 289         self.control_ping_index = self.vpp_dictionary['control_ping']['id']
 290         self.control_ping_msgdef = self.messages['control_ping']
 291
 292         self.connected = True
 293
 294     def disconnect(self):
 295         rv = vpp_api.disconnect()
 296         return rv
 297
 298     def results_wait(self, context):
 299         return (self.results[context]['e'].wait(self.timeout))
 300
 301     def results_prepare(self, context):
 302         self.results[context] = {}
 303         self.results[context]['e'] = threading.Event()
 304         self.results[context]['e'].clear()
 305         self.results[context]['r'] = []
 306
 307     def results_clean(self, context):
 308         del self.results[context]
 309
 310     def msg_handler(self, msg):
 311         if not msg:
 312             eprint('vpp_api.read failed')
 313             return
 314
 315         i, ci = self.header.unpack_from(msg, 0)
 316         if self.id_names[i] == 'rx_thread_exit':
 317             return;
 318
 319         #
 320         # Decode message and returns a tuple.
 321         #
 322         msgdef = self.id_msgdef[i]
 323         if not msgdef:
 324             raise IOError(2, 'Reply message undefined')
 325
 326         r = self.decode(msgdef, msg)
 327         if 'context' in r._asdict():
 328             if r.context > 0:
 329                 context = r.context
 330
 331         msgname = type(r).__name__
 332
 333         #
 334         # XXX: Call provided callback for event
 335         # Are we guaranteed to not get an event during processing of other messages?
 336         # How to differentiate what's a callback message and what not? Context = 0?
 337         #
 338         #if not is_waiting_for_reply():
 339         if r.context == 0 and self.event_callback:
 340             self.event_callback(msgname, r)
 341             return
 342
 343         #
 344         # Collect results until control ping
 345         #
 346         if msgname == 'control_ping_reply':
 347             self.results[context]['e'].set()
 348             return
 349
 350         if not context in self.results:
 351             eprint('Not expecting results for this context', context)
 352             return
 353
 354         if 'm' in self.results[context]:
 355             self.results[context]['r'].append(r)
 356             return
 357
 358         self.results[context]['r'] = r
 359         self.results[context]['e'].set()
 360
 361     def _control_ping(self, context):
 362         self._write(self.encode(self.control_ping_msgdef,
 363                         { '_vl_msg_id' : self.control_ping_index,
 364                           'context' : context}))
 365
 366     def _call_vpp(self, i, msgdef, multipart, **kwargs):
 367         if not 'context' in kwargs:
 368             context = self.get_context()
 369             kwargs['context'] = context
 370         else:
 371             context = kwargs['context']
 372         kwargs['_vl_msg_id'] = i
 373         b = self.encode(msgdef, kwargs)
 374
 375         self.results_prepare(context)
 376
 377         if multipart:
 378             self.results[context]['m'] = True
 379             self._control_ping(context)
 380
 381         self._write(b)
 382
 383         self.results_wait(context)
 384         r = self.results[context]['r']
 385         self.results_clean(context)
 386         return r
 387
 388     def register_event_callback(self, callback):
 389         self.event_callback = callback
 390