X-Git-Url: https://gerrit.fd.io/r/gitweb?p=vpp.git;a=blobdiff_plain;f=src%2Fvpp-api%2Fpython%2Fvpp_papi%2Fvpp_serializer.py;h=a001cca565aae923164f76ae4c92d8375dd24dfa;hp=7f5c5ace2dc877abb0918b1258d33b0acb3c26b9;hb=53fffa1;hpb=a7564e8004fd6d9a63eb0605f752f27a71403645 diff --git a/src/vpp-api/python/vpp_papi/vpp_serializer.py b/src/vpp-api/python/vpp_papi/vpp_serializer.py index 7f5c5ace2dc..a001cca565a 100644 --- a/src/vpp-api/python/vpp_papi/vpp_serializer.py +++ b/src/vpp-api/python/vpp_papi/vpp_serializer.py @@ -17,6 +17,7 @@ import struct import collections from enum import IntEnum import logging +from .vpp_format import VPPFormat # # Set log-level in application by doing e.g.: @@ -26,7 +27,7 @@ import logging logger = logging.getLogger(__name__) -class BaseTypes(): +class BaseTypes(object): def __init__(self, type, elements=0): base_types = {'u8': '>B', 'u16': '>H', @@ -34,6 +35,7 @@ class BaseTypes(): 'i32': '>i', 'u64': '>Q', 'f64': '>d', + 'bool': '>?', 'header': '>HI'} if elements > 0 and type == 'u8': @@ -45,12 +47,12 @@ class BaseTypes(): .format(type, base_types[type])) def pack(self, data, kwargs=None): - logger.debug("Data: {} Format: {}".format(data, self.packer.format)) + if not data: # Default to zero if not specified + data = 0 return self.packer.pack(data) def unpack(self, data, offset, result=None): - logger.debug("@ {} Format: {}".format(offset, self.packer.format)) - return self.packer.unpack_from(data, offset)[0] + return self.packer.unpack_from(data, offset)[0], self.packer.size types = {} @@ -60,20 +62,28 @@ types['u32'] = BaseTypes('u32') types['i32'] = BaseTypes('i32') types['u64'] = BaseTypes('u64') types['f64'] = BaseTypes('f64') +types['bool'] = BaseTypes('bool') -class FixedList_u8(): +def vpp_get_type(name): + try: + return types[name] + except KeyError: + return None + + +class FixedList_u8(object): def __init__(self, name, field_type, num): self.name = name self.num = num self.packer = BaseTypes(field_type, num) self.size = self.packer.size - def pack(self, list, kwargs): + def pack(self, list, kwargs = None): """Packs a fixed length bytestring. Left-pads with zeros if input data is too short.""" - logger.debug("Data: {}".format(list)) - + if not list: + return b'\x00' * self.size if len(list) > self.num: raise ValueError('Fixed list length error for "{}", got: {}' ' expected: {}' @@ -84,19 +94,17 @@ class FixedList_u8(): if len(data[offset:]) < self.num: raise ValueError('Invalid array length for "{}" got {}' ' expected {}' - .format(self.name, len(data), self.num)) + .format(self.name, len(data[offset:]), self.num)) return self.packer.unpack(data, offset) -class FixedList(): +class FixedList(object): def __init__(self, name, field_type, num): self.num = num self.packer = types[field_type] self.size = self.packer.size * num def pack(self, list, kwargs): - logger.debug("Data: {}".format(list)) - if len(list) != self.num: raise ValueError('Fixed list length error, got: {} expected: {}' .format(len(list), self.num)) @@ -108,22 +116,26 @@ class FixedList(): def unpack(self, data, offset=0, result=None): # Return a list of arguments result = [] + total = 0 for e in range(self.num): - x = self.packer.unpack(data, offset) + x, size = self.packer.unpack(data, offset) result.append(x) - offset += self.packer.size - return result + offset += size + total += size + return result, total -class VLAList(): +class VLAList(object): def __init__(self, name, field_type, len_field_name, index): + self.name = name self.index = index self.packer = types[field_type] self.size = self.packer.size self.length_field = len_field_name def pack(self, list, kwargs=None): - logger.debug("Data: {}".format(list)) + if not list: + return b"" if len(list) != kwargs[self.length_field]: raise ValueError('Variable length error, got: {} expected: {}' .format(len(list), kwargs[self.length_field])) @@ -138,24 +150,23 @@ class VLAList(): return b def unpack(self, data, offset=0, result=None): - logger.debug("Data: {} @ {} Result: {}" - .format(list, offset, result[self.index])) # Return a list of arguments + total = 0 # u8 array if self.packer.size == 1: if result[self.index] == 0: - return b'' + return b'', 0 p = BaseTypes('u8', result[self.index]) - r = p.unpack(data, offset) - return r + return p.unpack(data, offset) r = [] for e in range(result[self.index]): - x = self.packer.unpack(data, offset) + x, size = self.packer.unpack(data, offset) r.append(x) - offset += self.packer.size - return r + offset += size + total += size + return r, total class VLAList_legacy(): @@ -164,8 +175,6 @@ class VLAList_legacy(): self.size = self.packer.size def pack(self, list, kwargs=None): - logger.debug("Data: {}".format(list)) - if self.packer.size == 1: return bytes(list) @@ -175,21 +184,21 @@ class VLAList_legacy(): return b def unpack(self, data, offset=0, result=None): + total = 0 # Return a list of arguments if (len(data) - offset) % self.packer.size: raise ValueError('Legacy Variable Length Array length mismatch.') elements = int((len(data) - offset) / self.packer.size) r = [] - logger.debug("Legacy VLA: {} elements of size {}" - .format(elements, self.packer.size)) for e in range(elements): - x = self.packer.unpack(data, offset) + x, size = self.packer.unpack(data, offset) r.append(x) offset += self.packer.size - return r + total += size + return r, total -class VPPEnumType(): +class VPPEnumType(object): def __init__(self, name, msgdef): self.size = types['u32'].size e_hash = {} @@ -207,16 +216,18 @@ class VPPEnumType(): def __getattr__(self, name): return self.enum[name] + def __nonzero__(self): + return True + def pack(self, data, kwargs=None): - logger.debug("Data: {}".format(data)) - return types['u32'].pack(data, kwargs) + return types['u32'].pack(data) def unpack(self, data, offset=0, result=None): - x = types['u32'].unpack(data, offset) - return self.enum(x) + x, size = types['u32'].unpack(data, offset) + return self.enum(x), size -class VPPUnionType(): +class VPPUnionType(object): def __init__(self, name, msgdef): self.name = name self.size = 0 @@ -242,26 +253,43 @@ class VPPUnionType(): self.tuple = collections.namedtuple(name, fields, rename=True) logger.debug('Adding union {}'.format(name)) + # Union of variable length? def pack(self, data, kwargs=None): - logger.debug("Data: {}".format(data)) + if not data: + return b'\x00' * self.size + for k, v in data.items(): logger.debug("Key: {} Value: {}".format(k, v)) b = self.packers[k].pack(v, kwargs) - offset = self.size - self.packers[k].size break r = bytearray(self.size) - r[offset:] = b + r[:len(b)] = b return r def unpack(self, data, offset=0, result=None): r = [] + maxsize = 0 for k, p in self.packers.items(): - union_offset = self.size - p.size - r.append(p.unpack(data, offset + union_offset)) - return self.tuple._make(r) + x, size = p.unpack(data, offset) + if size > maxsize: + maxsize = size + r.append(x) + return self.tuple._make(r), maxsize + + +def VPPTypeAlias(name, msgdef): + t = vpp_get_type(msgdef['type']) + if not t: + raise ValueError() + if 'length' in msgdef: + if msgdef['length'] == 0: + raise ValueError() + types[name] = FixedList(name, msgdef['type'], msgdef['length']) + else: + types[name] = t -class VPPType(): +class VPPType(object): # Set everything up to be able to pack / unpack def __init__(self, name, msgdef): self.name = name @@ -312,31 +340,49 @@ class VPPType(): def pack(self, data, kwargs=None): if not kwargs: kwargs = data - logger.debug("Data: {}".format(data)) b = bytes() for i, a in enumerate(self.fields): - if a not in data: - logger.debug("Argument {} not given, defaulting to 0" - .format(a)) - b += b'\x00' * self.packers[i].size - continue + + # Try one of the format functions + if data and type(data) is not dict and a not in data: + raise ValueError("Invalid argument: {} expected {}.{}". + format(data, self.name, a)) + + # Defaulting to zero. + if not data or a not in data: # Default to 0 + arg = None + kwarg = None # No default for VLA + else: + arg = data[a] + kwarg = kwargs[a] if a in kwargs else None if isinstance(self.packers[i], VPPType): - b += self.packers[i].pack(data[a], kwargs[a]) + try: + b += self.packers[i].pack(arg, kwarg) + except ValueError: + # Invalid argument, can we convert it? + arg = VPPFormat.format(self.packers[i].name, data[a]) + data[a] = arg + kwarg = arg + b += self.packers[i].pack(arg, kwarg) else: - b += self.packers[i].pack(data[a], kwargs) + b += self.packers[i].pack(arg, kwargs) + return b def unpack(self, data, offset=0, result=None): # Return a list of arguments result = [] + total = 0 for p in self.packers: - x = p.unpack(data, offset, result) + x, size = p.unpack(data, offset, result) if type(x) is tuple and len(x) == 1: x = x[0] result.append(x) - offset += p.size - return self.tuple._make(result) + offset += size + total += size + t = self.tuple._make(result) + return t, total class VPPMessage(VPPType):