src/vpp-api/python/vpp_papi/vpp_serializer.py

   1 #
   2 # Copyright (c) 2018 Cisco and/or its affiliates.
   3 # Licensed under the Apache License, Version 2.0 (the "License");
   4 # you may not use this file except in compliance with the License.
   5 # You may obtain a copy of the License at:
   6 #
   7 #     http://www.apache.org/licenses/LICENSE-2.0
   8 #
   9 # Unless required by applicable law or agreed to in writing, software
  10 # distributed under the License is distributed on an "AS IS" BASIS,
  11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 # See the License for the specific language governing permissions and
  13 # limitations under the License.
  14 #
  15 import collections
  16 from enum import IntFlag
  17 import logging
  18 import socket
  19 import struct
  20 import sys
  21
  22 from . import vpp_format
  23
  24
  25 #
  26 # Set log-level in application by doing e.g.:
  27 # logger = logging.getLogger('vpp_serializer')
  28 # logger.setLevel(logging.DEBUG)
  29 #
  30 logger = logging.getLogger('vpp_papi.serializer')
  31
  32
  33 def check(d):
  34     return type(d) is dict or type(d) is bytes
  35
  36
  37 def conversion_required(data, field_type):
  38     if check(data):
  39         return False
  40     try:
  41         if type(data).__name__ in vpp_format.conversion_table[field_type]:
  42             return True
  43     except KeyError:
  44         return False
  45
  46
  47 def conversion_packer(data, field_type):
  48     t = type(data).__name__
  49     return types[field_type].pack(vpp_format.
  50                                   conversion_table[field_type][t](data))
  51
  52
  53 def conversion_unpacker(data, field_type):
  54     if field_type not in vpp_format.conversion_unpacker_table:
  55         return data
  56     return vpp_format.conversion_unpacker_table[field_type](data)
  57
  58
  59 class Packer:
  60     options = {}
  61
  62     def pack(self, data, kwargs):
  63         raise NotImplementedError
  64
  65     def unpack(self, data, offset, result=None, ntc=False):
  66         raise NotImplementedError
  67
  68     # override as appropriate in subclasses
  69     @staticmethod
  70     def _get_packer_with_options(f_type, options):
  71         return types[f_type]
  72
  73     def get_packer_with_options(self, f_type, options):
  74         if options is not None:
  75             try:
  76                 c = types[f_type].__class__
  77                 return c._get_packer_with_options(f_type, options)
  78             except IndexError:
  79                 raise VPPSerializerValueError(
  80                     "Options not supported for {}{} ({})".
  81                     format(f_type, types[f_type].__class__,
  82                            options))
  83
  84
  85 class BaseTypes(Packer):
  86     def __init__(self, type, elements=0, options=None):
  87         self._type = type
  88         self._elements = elements
  89         base_types = {'u8': '>B',
  90                       'i8': '>b',
  91                       'string': '>s',
  92                       'u16': '>H',
  93                       'i16': '>h',
  94                       'u32': '>I',
  95                       'i32': '>i',
  96                       'u64': '>Q',
  97                       'i64': '>q',
  98                       'f64': '=d',
  99                       'bool': '>?',
 100                       'header': '>HI'}
 101
 102         if elements > 0 and (type == 'u8' or type == 'string'):
 103             self.packer = struct.Struct('>%ss' % elements)
 104         else:
 105             self.packer = struct.Struct(base_types[type])
 106         self.size = self.packer.size
 107         self.options = options
 108
 109     def pack(self, data, kwargs=None):
 110         if data is None:  # Default to zero if not specified
 111             if self.options and 'default' in self.options:
 112                 data = self.options['default']
 113             else:
 114                 data = 0
 115         return self.packer.pack(data)
 116
 117     def unpack(self, data, offset, result=None, ntc=False):
 118         return self.packer.unpack_from(data, offset)[0], self.packer.size
 119
 120     @staticmethod
 121     def _get_packer_with_options(f_type, options):
 122         return BaseTypes(f_type, options=options)
 123
 124     def __repr__(self):
 125         return "BaseTypes(type=%s, elements=%s, options=%s)" % (self._type,
 126                                                                 self._elements,
 127                                                                 self.options)
 128
 129
 130 class String(Packer):
 131     def __init__(self, name, num, options):
 132         self.name = name
 133         self.num = num
 134         self.size = 1
 135         self.length_field_packer = BaseTypes('u32')
 136         self.limit = options['limit'] if 'limit' in options else num
 137         self.fixed = True if num else False
 138         if self.fixed and not self.limit:
 139             raise VPPSerializerValueError(
 140                 "Invalid combination for: {}, {} fixed:{} limit:{}".
 141                 format(name, options, self.fixed, self.limit))
 142
 143     def pack(self, list, kwargs=None):
 144         if not list:
 145             if self.fixed:
 146                 return b"\x00" * self.limit
 147             return self.length_field_packer.pack(0) + b""
 148         if self.limit and len(list) > self.limit - 1:
 149             raise VPPSerializerValueError(
 150                 "Invalid argument length for: {}, {} maximum {}".
 151                 format(list, len(list), self.limit - 1))
 152         if self.fixed:
 153             return list.encode('ascii').ljust(self.limit, b'\x00')
 154         return self.length_field_packer.pack(len(list)) + list.encode('ascii')
 155
 156     def unpack(self, data, offset=0, result=None, ntc=False):
 157         if self.fixed:
 158             p = BaseTypes('u8', self.num)
 159             s = p.unpack(data, offset)
 160             s2 = s[0].split(b'\0', 1)[0]
 161             return (s2.decode('ascii'), self.num)
 162
 163         length, length_field_size = self.length_field_packer.unpack(data,
 164                                                                     offset)
 165         if length == 0:
 166             return '', 0
 167         p = BaseTypes('u8', length)
 168         x, size = p.unpack(data, offset + length_field_size)
 169         return (x.decode('ascii', errors='replace'), size + length_field_size)
 170
 171
 172 types = {'u8': BaseTypes('u8'), 'i8': BaseTypes('i8'),
 173          'u16': BaseTypes('u16'), 'i16': BaseTypes('i16'),
 174          'u32': BaseTypes('u32'), 'i32': BaseTypes('i32'),
 175          'u64': BaseTypes('u64'), 'i64': BaseTypes('i64'),
 176          'f64': BaseTypes('f64'),
 177          'bool': BaseTypes('bool'), 'string': String}
 178
 179 class_types = {}
 180
 181
 182 def vpp_get_type(name):
 183     try:
 184         return types[name]
 185     except KeyError:
 186         return None
 187
 188
 189 class VPPSerializerValueError(ValueError):
 190     pass
 191
 192
 193 class FixedList_u8(Packer):
 194     def __init__(self, name, field_type, num):
 195         self.name = name
 196         self.num = num
 197         self.packer = BaseTypes(field_type, num)
 198         self.size = self.packer.size
 199         self.field_type = field_type
 200
 201     def pack(self, data, kwargs=None):
 202         """Packs a fixed length bytestring. Left-pads with zeros
 203         if input data is too short."""
 204         if not data:
 205             return b'\x00' * self.size
 206
 207         if len(data) > self.num:
 208             raise VPPSerializerValueError(
 209                 'Fixed list length error for "{}", got: {}'
 210                 ' expected: {}'
 211                 .format(self.name, len(data), self.num))
 212
 213         try:
 214             return self.packer.pack(data)
 215         except struct.error:
 216             raise VPPSerializerValueError(
 217                 'Packing failed for "{}" {}'
 218                 .format(self.name, kwargs))
 219
 220     def unpack(self, data, offset=0, result=None, ntc=False):
 221         if len(data[offset:]) < self.num:
 222             raise VPPSerializerValueError(
 223                 'Invalid array length for "{}" got {}'
 224                 ' expected {}'
 225                 .format(self.name, len(data[offset:]), self.num))
 226         return self.packer.unpack(data, offset)
 227
 228     def __repr__(self):
 229         return "FixedList_u8(name=%s, field_type=%s, num=%s)" % (
 230             self.name, self.field_type, self.num
 231         )
 232
 233
 234 class FixedList(Packer):
 235     def __init__(self, name, field_type, num):
 236         self.num = num
 237         self.packer = types[field_type]
 238         self.size = self.packer.size * num
 239         self.name = name
 240         self.field_type = field_type
 241
 242     def pack(self, list, kwargs):
 243         if len(list) != self.num:
 244             raise VPPSerializerValueError(
 245                 'Fixed list length error, got: {} expected: {}'
 246                 .format(len(list), self.num))
 247         b = bytes()
 248         for e in list:
 249             b += self.packer.pack(e)
 250         return b
 251
 252     def unpack(self, data, offset=0, result=None, ntc=False):
 253         # Return a list of arguments
 254         result = []
 255         total = 0
 256         for e in range(self.num):
 257             x, size = self.packer.unpack(data, offset, ntc=ntc)
 258             result.append(x)
 259             offset += size
 260             total += size
 261         return result, total
 262
 263     def __repr__(self):
 264         return "FixedList(name=%s, field_type=%s, num=%s)" % (
 265             self.name, self.field_type, self.num)
 266
 267
 268 class VLAList(Packer):
 269     def __init__(self, name, field_type, len_field_name, index):
 270         self.name = name
 271         self.field_type = field_type
 272         self.index = index
 273         self.packer = types[field_type]
 274         self.size = self.packer.size
 275         self.length_field = len_field_name
 276
 277     def pack(self, lst, kwargs=None):
 278         if not lst:
 279             return b""
 280         if len(lst) != kwargs[self.length_field]:
 281             raise VPPSerializerValueError(
 282                 'Variable length error, got: {} expected: {}'
 283                 .format(len(lst), kwargs[self.length_field]))
 284
 285         # u8 array
 286         if self.packer.size == 1:
 287             if isinstance(lst, list):
 288                 return b''.join(lst)
 289             return bytes(lst)
 290
 291         b = bytes()
 292         for e in lst:
 293             b += self.packer.pack(e)
 294         return b
 295
 296     def unpack(self, data, offset=0, result=None, ntc=False):
 297         # Return a list of arguments
 298         total = 0
 299
 300         # u8 array
 301         if self.packer.size == 1:
 302             if result[self.index] == 0:
 303                 return b'', 0
 304             p = BaseTypes('u8', result[self.index])
 305             return p.unpack(data, offset, ntc=ntc)
 306
 307         r = []
 308         for e in range(result[self.index]):
 309             x, size = self.packer.unpack(data, offset, ntc=ntc)
 310             r.append(x)
 311             offset += size
 312             total += size
 313         return r, total
 314
 315     def __repr__(self):
 316         return "VLAList(name=%s, field_type=%s, " \
 317                "len_field_name=%s, index=%s)" % (
 318                    self.name, self.field_type, self.length_field, self.index
 319                )
 320
 321
 322 class VLAList_legacy(Packer):
 323     def __init__(self, name, field_type):
 324         self.name = name
 325         self.field_type = field_type
 326         self.packer = types[field_type]
 327         self.size = self.packer.size
 328
 329     def pack(self, list, kwargs=None):
 330         if self.packer.size == 1:
 331             return bytes(list)
 332
 333         b = bytes()
 334         for e in list:
 335             b += self.packer.pack(e)
 336         return b
 337
 338     def unpack(self, data, offset=0, result=None, ntc=False):
 339         total = 0
 340         # Return a list of arguments
 341         if (len(data) - offset) % self.packer.size:
 342             raise VPPSerializerValueError(
 343                 'Legacy Variable Length Array length mismatch.')
 344         elements = int((len(data) - offset) / self.packer.size)
 345         r = []
 346         for e in range(elements):
 347             x, size = self.packer.unpack(data, offset, ntc=ntc)
 348             r.append(x)
 349             offset += self.packer.size
 350             total += size
 351         return r, total
 352
 353     def __repr__(self):
 354         return "VLAList_legacy(name=%s, field_type=%s)" % (
 355             self.name, self.field_type
 356         )
 357
 358
 359 class VPPEnumType(Packer):
 360     def __init__(self, name, msgdef, options=None):
 361         self.size = types['u32'].size
 362         self.name = name
 363         self.enumtype = 'u32'
 364         self.msgdef = msgdef
 365         e_hash = {}
 366         for f in msgdef:
 367             if type(f) is dict and 'enumtype' in f:
 368                 if f['enumtype'] != 'u32':
 369                     self.size = types[f['enumtype']].size
 370                     self.enumtype = f['enumtype']
 371                 continue
 372             ename, evalue = f
 373             e_hash[ename] = evalue
 374         self.enum = IntFlag(name, e_hash)
 375         types[name] = self
 376         class_types[name] = VPPEnumType
 377         self.options = options
 378
 379     def __getattr__(self, name):
 380         return self.enum[name]
 381
 382     def __bool__(self):
 383         return True
 384
 385
 386     def pack(self, data, kwargs=None):
 387         if data is None:  # Default to zero if not specified
 388             if self.options and 'default' in self.options:
 389                 data = self.options['default']
 390             else:
 391                 data = 0
 392
 393         return types[self.enumtype].pack(data)
 394
 395     def unpack(self, data, offset=0, result=None, ntc=False):
 396         x, size = types[self.enumtype].unpack(data, offset)
 397         return self.enum(x), size
 398
 399     @staticmethod
 400     def _get_packer_with_options(f_type, options):
 401         return VPPEnumType(f_type, types[f_type].msgdef, options=options)
 402
 403     def __repr__(self):
 404         return "VPPEnumType(name=%s, msgdef=%s, options=%s)" % (
 405             self.name, self.msgdef, self.options
 406         )
 407
 408
 409 class VPPUnionType(Packer):
 410     def __init__(self, name, msgdef):
 411         self.name = name
 412         self.msgdef = msgdef
 413         self.size = 0
 414         self.maxindex = 0
 415         fields = []
 416         self.packers = collections.OrderedDict()
 417         for i, f in enumerate(msgdef):
 418             if type(f) is dict and 'crc' in f:
 419                 self.crc = f['crc']
 420                 continue
 421             f_type, f_name = f
 422             if f_type not in types:
 423                 logger.debug('Unknown union type {}'.format(f_type))
 424                 raise VPPSerializerValueError(
 425                     'Unknown message type {}'.format(f_type))
 426             fields.append(f_name)
 427             size = types[f_type].size
 428             self.packers[f_name] = types[f_type]
 429             if size > self.size:
 430                 self.size = size
 431                 self.maxindex = i
 432
 433         types[name] = self
 434         self.tuple = collections.namedtuple(name, fields, rename=True)
 435
 436     # Union of variable length?
 437     def pack(self, data, kwargs=None):
 438         if not data:
 439             return b'\x00' * self.size
 440
 441         for k, v in data.items():
 442             logger.debug("Key: {} Value: {}".format(k, v))
 443             b = self.packers[k].pack(v, kwargs)
 444             break
 445         r = bytearray(self.size)
 446         r[:len(b)] = b
 447         return r
 448
 449     def unpack(self, data, offset=0, result=None, ntc=False):
 450         r = []
 451         maxsize = 0
 452         for k, p in self.packers.items():
 453             x, size = p.unpack(data, offset, ntc=ntc)
 454             if size > maxsize:
 455                 maxsize = size
 456             r.append(x)
 457         return self.tuple._make(r), maxsize
 458
 459     def __repr__(self):
 460         return"VPPUnionType(name=%s, msgdef=%r)" % (self.name, self.msgdef)
 461
 462
 463 class VPPTypeAlias(Packer):
 464     def __init__(self, name, msgdef, options=None):
 465         self.name = name
 466         self.msgdef = msgdef
 467         t = vpp_get_type(msgdef['type'])
 468         if not t:
 469             raise ValueError('No such type: {}'.format(msgdef['type']))
 470         if 'length' in msgdef:
 471             if msgdef['length'] == 0:
 472                 raise ValueError()
 473             if msgdef['type'] == 'u8':
 474                 self.packer = FixedList_u8(name, msgdef['type'],
 475                                            msgdef['length'])
 476                 self.size = self.packer.size
 477             else:
 478                 self.packer = FixedList(name, msgdef['type'], msgdef['length'])
 479         else:
 480             self.packer = t
 481             self.size = t.size
 482
 483         types[name] = self
 484         self.toplevelconversion = False
 485         self.options = options
 486
 487     def pack(self, data, kwargs=None):
 488         if data and conversion_required(data, self.name):
 489             try:
 490                 return conversion_packer(data, self.name)
 491             # Python 2 and 3 raises different exceptions from inet_pton
 492             except(OSError, socket.error, TypeError):
 493                 pass
 494         if data is None:  # Default to zero if not specified
 495             if self.options and 'default' in self.options:
 496                 data = self.options['default']
 497             else:
 498                 data = 0
 499
 500         return self.packer.pack(data, kwargs)
 501
 502     @staticmethod
 503     def _get_packer_with_options(f_type, options):
 504         return VPPTypeAlias(f_type, types[f_type].msgdef, options=options)
 505
 506     def unpack(self, data, offset=0, result=None, ntc=False):
 507         if ntc is False and self.name in vpp_format.conversion_unpacker_table:
 508             # Disable type conversion for dependent types
 509             ntc = True
 510             self.toplevelconversion = True
 511         t, size = self.packer.unpack(data, offset, result, ntc=ntc)
 512         if self.toplevelconversion:
 513             self.toplevelconversion = False
 514             return conversion_unpacker(t, self.name), size
 515         return t, size
 516
 517     def __repr__(self):
 518         return "VPPTypeAlias(name=%s, msgdef=%s, options=%s)" % (
 519             self.name, self.msgdef, self.options)
 520
 521
 522 class VPPType(Packer):
 523     # Set everything up to be able to pack / unpack
 524     def __init__(self, name, msgdef):
 525         self.name = name
 526         self.msgdef = msgdef
 527         self.packers = []
 528         self.fields = []
 529         self.fieldtypes = []
 530         self.field_by_name = {}
 531         size = 0
 532         for i, f in enumerate(msgdef):
 533             if type(f) is dict and 'crc' in f:
 534                 self.crc = f['crc']
 535                 continue
 536             f_type, f_name = f[:2]
 537             self.fields.append(f_name)
 538             self.field_by_name[f_name] = None
 539             self.fieldtypes.append(f_type)
 540             if f_type not in types:
 541                 logger.debug('Unknown type {}'.format(f_type))
 542                 raise VPPSerializerValueError(
 543                     'Unknown message type {}'.format(f_type))
 544
 545             fieldlen = len(f)
 546             options = [x for x in f if type(x) is dict]
 547             if len(options):
 548                 self.options = options[0]
 549                 fieldlen -= 1
 550             else:
 551                 self.options = {}
 552             if fieldlen == 3:  # list
 553                 list_elements = f[2]
 554                 if list_elements == 0:
 555                     if f_type == 'string':
 556                         p = String(f_name, 0, self.options)
 557                     else:
 558                         p = VLAList_legacy(f_name, f_type)
 559                     self.packers.append(p)
 560                 elif f_type == 'u8':
 561                     p = FixedList_u8(f_name, f_type, list_elements)
 562                     self.packers.append(p)
 563                     size += p.size
 564                 elif f_type == 'string':
 565                     p = String(f_name, list_elements, self.options)
 566                     self.packers.append(p)
 567                     size += p.size
 568                 else:
 569                     p = FixedList(f_name, f_type, list_elements)
 570                     self.packers.append(p)
 571                     size += p.size
 572             elif fieldlen == 4:  # Variable length list
 573                 length_index = self.fields.index(f[3])
 574                 p = VLAList(f_name, f_type, f[3], length_index)
 575                 self.packers.append(p)
 576             else:
 577                 # default support for types that decay to basetype
 578                 if 'default' in self.options:
 579                     p = self.get_packer_with_options(f_type, self.options)
 580                 else:
 581                     p = types[f_type]
 582
 583                 self.packers.append(p)
 584                 size += p.size
 585
 586         self.size = size
 587         self.tuple = collections.namedtuple(name, self.fields, rename=True)
 588         types[name] = self
 589         self.toplevelconversion = False
 590
 591     def pack(self, data, kwargs=None):
 592         if not kwargs:
 593             kwargs = data
 594         b = bytes()
 595
 596         # Try one of the format functions
 597         if data and conversion_required(data, self.name):
 598             return conversion_packer(data, self.name)
 599
 600         for i, a in enumerate(self.fields):
 601             if data and type(data) is not dict and a not in data:
 602                 raise VPPSerializerValueError(
 603                     "Invalid argument: {} expected {}.{}".
 604                     format(data, self.name, a))
 605
 606             # Defaulting to zero.
 607             if not data or a not in data:  # Default to 0
 608                 arg = None
 609                 kwarg = None  # No default for VLA
 610             else:
 611                 arg = data[a]
 612                 kwarg = kwargs[a] if a in kwargs else None
 613             if isinstance(self.packers[i], VPPType):
 614                 b += self.packers[i].pack(arg, kwarg)
 615             else:
 616                 b += self.packers[i].pack(arg, kwargs)
 617
 618         return b
 619
 620     def unpack(self, data, offset=0, result=None, ntc=False):
 621         # Return a list of arguments
 622         result = []
 623         total = 0
 624         if ntc is False and self.name in vpp_format.conversion_unpacker_table:
 625             # Disable type conversion for dependent types
 626             ntc = True
 627             self.toplevelconversion = True
 628
 629         for p in self.packers:
 630             x, size = p.unpack(data, offset, result, ntc)
 631             if type(x) is tuple and len(x) == 1:
 632                 x = x[0]
 633             result.append(x)
 634             offset += size
 635             total += size
 636         t = self.tuple._make(result)
 637
 638         if self.toplevelconversion:
 639             self.toplevelconversion = False
 640             t = conversion_unpacker(t, self.name)
 641         return t, total
 642
 643     def __repr__(self):
 644         return "%s(name=%s, msgdef=%s)" % (
 645             self.__class__.__name__, self.name, self.msgdef
 646         )
 647
 648
 649 class VPPMessage(VPPType):
 650     pass