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:
7 # http://www.apache.org/licenses/LICENSE-2.0
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.
21 if sys.version_info <= (3, 4):
22 from aenum import IntEnum # noqa: F401
24 from enum import IntEnum # noqa: F401
26 if sys.version_info <= (3, 6):
27 from aenum import IntFlag # noqa: F401
30 from enum import IntFlag # noqa: F401
32 from . import vpp_format # noqa: E402
35 # Set log-level in application by doing e.g.:
36 # logger = logging.getLogger('vpp_serializer')
37 # logger.setLevel(logging.DEBUG)
39 logger = logging.getLogger(__name__)
41 if sys.version[0] == '2':
42 def check(d): type(d) is dict
44 def check(d): type(d) is dict or type(d) is bytes
47 def conversion_required(data, field_type):
51 if type(data).__name__ in vpp_format.conversion_table[field_type]:
57 def conversion_packer(data, field_type):
58 t = type(data).__name__
59 return types[field_type].pack(vpp_format.
60 conversion_table[field_type][t](data))
63 def conversion_unpacker(data, field_type):
64 if field_type not in vpp_format.conversion_unpacker_table:
66 return vpp_format.conversion_unpacker_table[field_type](data)
69 # TODO: post 20.01, remove inherit from object.
73 def pack(self, data, kwargs):
74 raise NotImplementedError
76 def unpack(self, data, offset, result=None, ntc=False):
77 raise NotImplementedError
79 # override as appropriate in subclasses
80 def _get_packer_with_options(self, f_type, options):
83 def get_packer_with_options(self, f_type, options):
84 if options is not None:
86 return self._get_packer_with_options(f_type, options)
88 raise VPPSerializerValueError(
89 "Options not supported for {}{} ({})".
90 format(f_type, types[f_type].__class__,
94 class BaseTypes(Packer):
95 def __init__(self, type, elements=0, options=None):
97 self._elements = elements
98 base_types = {'u8': '>B',
111 if elements > 0 and (type == 'u8' or type == 'string'):
112 self.packer = struct.Struct('>%ss' % elements)
114 self.packer = struct.Struct(base_types[type])
115 self.size = self.packer.size
116 self.options = options
118 def pack(self, data, kwargs=None):
119 if data is None: # Default to zero if not specified
120 if self.options and 'default' in self.options:
121 data = self.options['default']
124 return self.packer.pack(data)
126 def unpack(self, data, offset, result=None, ntc=False):
127 return self.packer.unpack_from(data, offset)[0], self.packer.size
129 def _get_packer_with_options(self, f_type, options):
130 c = types[f_type].__class__
131 return c(f_type, options=options)
134 return "BaseTypes(type=%s, elements=%s, options=%s)" % (self._type,
139 class String(Packer):
140 def __init__(self, name, num, options):
144 self.length_field_packer = BaseTypes('u32')
145 self.limit = options['limit'] if 'limit' in options else num
146 self.fixed = True if num else False
147 if self.fixed and not self.limit:
148 raise VPPSerializerValueError(
149 "Invalid argument length for: {}, {} maximum {}".
150 format(list, len(list), self.limit))
152 def pack(self, list, kwargs=None):
155 return b"\x00" * self.limit
156 return self.length_field_packer.pack(0) + b""
157 if self.limit and len(list) > self.limit - 1:
158 raise VPPSerializerValueError(
159 "Invalid argument length for: {}, {} maximum {}".
160 format(list, len(list), self.limit - 1))
162 return list.encode('ascii').ljust(self.limit, b'\x00')
163 return self.length_field_packer.pack(len(list)) + list.encode('ascii')
165 def unpack(self, data, offset=0, result=None, ntc=False):
167 p = BaseTypes('u8', self.num)
168 s = p.unpack(data, offset)
169 s2 = s[0].split(b'\0', 1)[0]
170 return (s2.decode('ascii'), self.num)
172 length, length_field_size = self.length_field_packer.unpack(data,
176 p = BaseTypes('u8', length)
177 x, size = p.unpack(data, offset + length_field_size)
178 #x2 = x.split(b'\0', 1)[0]
179 return (x.decode('ascii', errors='replace'), size + length_field_size)
182 types = {'u8': BaseTypes('u8'), 'i8': BaseTypes('i8'),
183 'u16': BaseTypes('u16'), 'i16': BaseTypes('i16'),
184 'u32': BaseTypes('u32'), 'i32': BaseTypes('i32'),
185 'u64': BaseTypes('u64'), 'i64': BaseTypes('i64'),
186 'f64': BaseTypes('f64'),
187 'bool': BaseTypes('bool'), 'string': String}
192 def vpp_get_type(name):
199 class VPPSerializerValueError(ValueError):
203 class FixedList_u8(Packer):
204 def __init__(self, name, field_type, num):
207 self.packer = BaseTypes(field_type, num)
208 self.size = self.packer.size
209 self.field_type = field_type
211 def pack(self, data, kwargs=None):
212 """Packs a fixed length bytestring. Left-pads with zeros
213 if input data is too short."""
215 return b'\x00' * self.size
217 if len(data) > self.num:
218 raise VPPSerializerValueError(
219 'Fixed list length error for "{}", got: {}'
221 .format(self.name, len(data), self.num))
224 return self.packer.pack(data)
226 raise VPPSerializerValueError(
227 'Packing failed for "{}" {}'
228 .format(self.name, kwargs))
230 def unpack(self, data, offset=0, result=None, ntc=False):
231 if len(data[offset:]) < self.num:
232 raise VPPSerializerValueError(
233 'Invalid array length for "{}" got {}'
235 .format(self.name, len(data[offset:]), self.num))
236 return self.packer.unpack(data, offset)
239 return "FixedList_u8(name=%s, field_type=%s, num=%s)" % (
240 self.name, self.field_type, self.num
244 class FixedList(Packer):
245 def __init__(self, name, field_type, num):
247 self.packer = types[field_type]
248 self.size = self.packer.size * num
250 self.field_type = field_type
252 def pack(self, list, kwargs):
253 if len(list) != self.num:
254 raise VPPSerializerValueError(
255 'Fixed list length error, got: {} expected: {}'
256 .format(len(list), self.num))
259 b += self.packer.pack(e)
262 def unpack(self, data, offset=0, result=None, ntc=False):
263 # Return a list of arguments
266 for e in range(self.num):
267 x, size = self.packer.unpack(data, offset, ntc=ntc)
274 return "FixedList_(name=%s, field_type=%s, num=%s)" % (
275 self.name, self.field_type, self.num )
278 class VLAList(Packer):
279 def __init__(self, name, field_type, len_field_name, index):
281 self.field_type = field_type
283 self.packer = types[field_type]
284 self.size = self.packer.size
285 self.length_field = len_field_name
287 def pack(self, lst, kwargs=None):
290 if len(lst) != kwargs[self.length_field]:
291 raise VPPSerializerValueError(
292 'Variable length error, got: {} expected: {}'
293 .format(len(lst), kwargs[self.length_field]))
296 if self.packer.size == 1:
297 if isinstance(lst, list):
303 b += self.packer.pack(e)
306 def unpack(self, data, offset=0, result=None, ntc=False):
307 # Return a list of arguments
311 if self.packer.size == 1:
312 if result[self.index] == 0:
314 p = BaseTypes('u8', result[self.index])
315 return p.unpack(data, offset, ntc=ntc)
318 for e in range(result[self.index]):
319 x, size = self.packer.unpack(data, offset, ntc=ntc)
326 return "VLAList(name=%s, field_type=%s, " \
327 "len_field_name=%s, index=%s)" % (
328 self.name, self.field_type, self.length_field, self.index
332 class VLAList_legacy(Packer):
333 def __init__(self, name, field_type):
335 self.field_type = field_type
336 self.packer = types[field_type]
337 self.size = self.packer.size
339 def pack(self, list, kwargs=None):
340 if self.packer.size == 1:
345 b += self.packer.pack(e)
348 def unpack(self, data, offset=0, result=None, ntc=False):
350 # Return a list of arguments
351 if (len(data) - offset) % self.packer.size:
352 raise VPPSerializerValueError(
353 'Legacy Variable Length Array length mismatch.')
354 elements = int((len(data) - offset) / self.packer.size)
356 for e in range(elements):
357 x, size = self.packer.unpack(data, offset, ntc=ntc)
359 offset += self.packer.size
364 return "VLAList_legacy(name=%s, field_type=%s)" % (
365 self.name, self.field_type
369 class VPPEnumType(Packer):
370 def __init__(self, name, msgdef, options=None):
371 self.size = types['u32'].size
373 self.enumtype = 'u32'
377 if type(f) is dict and 'enumtype' in f:
378 if f['enumtype'] != 'u32':
379 self.size = types[f['enumtype']].size
380 self.enumtype = f['enumtype']
383 e_hash[ename] = evalue
384 self.enum = IntFlag(name, e_hash)
386 class_types[name] = VPPEnumType
387 self.options = options
389 def __getattr__(self, name):
390 return self.enum[name]
395 # TODO: Remove post 20.01.
396 if sys.version[0] == '2':
397 __nonzero__ = __bool__
399 def pack(self, data, kwargs=None):
400 if data is None: # Default to zero if not specified
401 if self.options and 'default' in self.options:
402 data = self.options['default']
406 return types[self.enumtype].pack(data)
408 def unpack(self, data, offset=0, result=None, ntc=False):
409 x, size = types[self.enumtype].unpack(data, offset)
410 return self.enum(x), size
412 def _get_packer_with_options(self, f_type, options):
413 c = types[f_type].__class__
414 return c(f_type, types[f_type].msgdef, options=options)
417 return "VPPEnumType(name=%s, msgdef=%s, options=%s)" % (
418 self.name, self.msgdef, self.options
422 class VPPUnionType(Packer):
423 def __init__(self, name, msgdef):
429 self.packers = collections.OrderedDict()
430 for i, f in enumerate(msgdef):
431 if type(f) is dict and 'crc' in f:
435 if f_type not in types:
436 logger.debug('Unknown union type {}'.format(f_type))
437 raise VPPSerializerValueError(
438 'Unknown message type {}'.format(f_type))
439 fields.append(f_name)
440 size = types[f_type].size
441 self.packers[f_name] = types[f_type]
447 self.tuple = collections.namedtuple(name, fields, rename=True)
449 # Union of variable length?
450 def pack(self, data, kwargs=None):
452 return b'\x00' * self.size
454 for k, v in data.items():
455 logger.debug("Key: {} Value: {}".format(k, v))
456 b = self.packers[k].pack(v, kwargs)
458 r = bytearray(self.size)
462 def unpack(self, data, offset=0, result=None, ntc=False):
465 for k, p in self.packers.items():
466 x, size = p.unpack(data, offset, ntc=ntc)
470 return self.tuple._make(r), maxsize
473 return"VPPUnionType(name=%s, msgdef=%r)" % (self.name, self.msgdef)
476 class VPPTypeAlias(Packer):
477 def __init__(self, name, msgdef, options=None):
480 t = vpp_get_type(msgdef['type'])
482 raise ValueError('No such type: {}'.format(msgdef['type']))
483 if 'length' in msgdef:
484 if msgdef['length'] == 0:
486 if msgdef['type'] == 'u8':
487 self.packer = FixedList_u8(name, msgdef['type'],
489 self.size = self.packer.size
491 self.packer = FixedList(name, msgdef['type'], msgdef['length'])
497 self.toplevelconversion = False
498 self.options = options
500 def pack(self, data, kwargs=None):
501 if data and conversion_required(data, self.name):
503 return conversion_packer(data, self.name)
504 # Python 2 and 3 raises different exceptions from inet_pton
505 except(OSError, socket.error, TypeError):
507 if data is None: # Default to zero if not specified
508 if self.options and 'default' in self.options:
509 data = self.options['default']
513 return self.packer.pack(data, kwargs)
515 def _get_packer_with_options(self, f_type, options):
516 c = types[f_type].__class__
517 return c(f_type, types[f_type].msgdef, options=options)
519 def unpack(self, data, offset=0, result=None, ntc=False):
520 if ntc is False and self.name in vpp_format.conversion_unpacker_table:
521 # Disable type conversion for dependent types
523 self.toplevelconversion = True
524 t, size = self.packer.unpack(data, offset, result, ntc=ntc)
525 if self.toplevelconversion:
526 self.toplevelconversion = False
527 return conversion_unpacker(t, self.name), size
531 return "VPPTypeAlias(name=%s, msgdef=%s, options=%s)" % (
532 self.name, self.msgdef, self.options)
535 class VPPType(Packer):
536 # Set everything up to be able to pack / unpack
537 def __init__(self, name, msgdef):
543 self.field_by_name = {}
545 for i, f in enumerate(msgdef):
546 if type(f) is dict and 'crc' in f:
549 f_type, f_name = f[:2]
550 self.fields.append(f_name)
551 self.field_by_name[f_name] = None
552 self.fieldtypes.append(f_type)
553 if f_type not in types:
554 logger.debug('Unknown type {}'.format(f_type))
555 raise VPPSerializerValueError(
556 'Unknown message type {}'.format(f_type))
559 options = [x for x in f if type(x) is dict]
561 self.options = options[0]
565 if fieldlen == 3: # list
567 if list_elements == 0:
568 if f_type == 'string':
569 p = String(f_name, 0, self.options)
571 p = VLAList_legacy(f_name, f_type)
572 self.packers.append(p)
574 p = FixedList_u8(f_name, f_type, list_elements)
575 self.packers.append(p)
577 elif f_type == 'string':
578 p = String(f_name, list_elements, self.options)
579 self.packers.append(p)
582 p = FixedList(f_name, f_type, list_elements)
583 self.packers.append(p)
585 elif fieldlen == 4: # Variable length list
586 length_index = self.fields.index(f[3])
587 p = VLAList(f_name, f_type, f[3], length_index)
588 self.packers.append(p)
590 # default support for types that decay to basetype
591 if 'default' in self.options:
592 p = self.get_packer_with_options(f_type, self.options)
596 self.packers.append(p)
600 self.tuple = collections.namedtuple(name, self.fields, rename=True)
602 self.toplevelconversion = False
604 def pack(self, data, kwargs=None):
609 # Try one of the format functions
610 if data and conversion_required(data, self.name):
611 return conversion_packer(data, self.name)
613 for i, a in enumerate(self.fields):
614 if data and type(data) is not dict and a not in data:
615 raise VPPSerializerValueError(
616 "Invalid argument: {} expected {}.{}".
617 format(data, self.name, a))
619 # Defaulting to zero.
620 if not data or a not in data: # Default to 0
622 kwarg = None # No default for VLA
625 kwarg = kwargs[a] if a in kwargs else None
626 if isinstance(self.packers[i], VPPType):
627 b += self.packers[i].pack(arg, kwarg)
629 b += self.packers[i].pack(arg, kwargs)
633 def unpack(self, data, offset=0, result=None, ntc=False):
634 # Return a list of arguments
637 if ntc is False and self.name in vpp_format.conversion_unpacker_table:
638 # Disable type conversion for dependent types
640 self.toplevelconversion = True
642 for p in self.packers:
643 x, size = p.unpack(data, offset, result, ntc)
644 if type(x) is tuple and len(x) == 1:
649 t = self.tuple._make(result)
651 if self.toplevelconversion:
652 self.toplevelconversion = False
653 t = conversion_unpacker(t, self.name)
657 return "%s(name=%s, msgdef=%s)" % (
658 self.__class__.__name__, self.name, self.msgdef
662 class VPPMessage(VPPType):