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.
18 from enum import IntEnum
22 # Set log-level in application by doing e.g.:
23 # logger = logging.getLogger('vpp_serializer')
24 # logger.setLevel(logging.DEBUG)
26 logger = logging.getLogger(__name__)
30 def __init__(self, type, elements=0):
31 base_types = {'u8': '>B',
40 if elements > 0 and type == 'u8':
41 self.packer = struct.Struct('>%ss' % elements)
43 self.packer = struct.Struct(base_types[type])
44 self.size = self.packer.size
45 logger.debug('Adding {} with format: {}'
46 .format(type, base_types[type]))
48 def pack(self, data, kwargs=None):
49 return self.packer.pack(data)
51 def unpack(self, data, offset, result=None):
52 return self.packer.unpack_from(data, offset)[0], self.packer.size
56 types['u8'] = BaseTypes('u8')
57 types['u16'] = BaseTypes('u16')
58 types['u32'] = BaseTypes('u32')
59 types['i32'] = BaseTypes('i32')
60 types['u64'] = BaseTypes('u64')
61 types['f64'] = BaseTypes('f64')
62 types['bool'] = BaseTypes('bool')
66 def __init__(self, name, field_type, num):
69 self.packer = BaseTypes(field_type, num)
70 self.size = self.packer.size
72 def pack(self, list, kwargs):
73 """Packs a fixed length bytestring. Left-pads with zeros
74 if input data is too short."""
75 if len(list) > self.num:
76 raise ValueError('Fixed list length error for "{}", got: {}'
78 .format(self.name, len(list), self.num))
79 return self.packer.pack(list)
81 def unpack(self, data, offset=0, result=None):
82 if len(data[offset:]) < self.num:
83 raise ValueError('Invalid array length for "{}" got {}'
85 .format(self.name, len(data[offset:]), self.num))
86 return self.packer.unpack(data, offset)
90 def __init__(self, name, field_type, num):
92 self.packer = types[field_type]
93 self.size = self.packer.size * num
95 def pack(self, list, kwargs):
96 if len(list) != self.num:
97 raise ValueError('Fixed list length error, got: {} expected: {}'
98 .format(len(list), self.num))
101 b += self.packer.pack(e)
104 def unpack(self, data, offset=0, result=None):
105 # Return a list of arguments
108 for e in range(self.num):
109 x, size = self.packer.unpack(data, offset)
117 def __init__(self, name, field_type, len_field_name, index):
120 self.packer = types[field_type]
121 self.size = self.packer.size
122 self.length_field = len_field_name
124 def pack(self, list, kwargs=None):
125 if len(list) != kwargs[self.length_field]:
126 raise ValueError('Variable length error, got: {} expected: {}'
127 .format(len(list), kwargs[self.length_field]))
131 if self.packer.size == 1:
132 return bytearray(list)
135 b += self.packer.pack(e)
138 def unpack(self, data, offset=0, result=None):
139 # Return a list of arguments
143 if self.packer.size == 1:
144 if result[self.index] == 0:
146 p = BaseTypes('u8', result[self.index])
147 return p.unpack(data, offset)
150 for e in range(result[self.index]):
151 x, size = self.packer.unpack(data, offset)
158 class VLAList_legacy():
159 def __init__(self, name, field_type):
160 self.packer = types[field_type]
161 self.size = self.packer.size
163 def pack(self, list, kwargs=None):
164 if self.packer.size == 1:
169 b += self.packer.pack(e)
172 def unpack(self, data, offset=0, result=None):
174 # Return a list of arguments
175 if (len(data) - offset) % self.packer.size:
176 raise ValueError('Legacy Variable Length Array length mismatch.')
177 elements = int((len(data) - offset) / self.packer.size)
179 for e in range(elements):
180 x, size = self.packer.unpack(data, offset)
182 offset += self.packer.size
188 def __init__(self, name, msgdef):
189 self.size = types['u32'].size
192 if type(f) is dict and 'enumtype' in f:
193 if f['enumtype'] != 'u32':
194 raise NotImplementedError
197 e_hash[ename] = evalue
198 self.enum = IntEnum(name, e_hash)
200 logger.debug('Adding enum {}'.format(name))
202 def __getattr__(self, name):
203 return self.enum[name]
205 def pack(self, data, kwargs=None):
206 return types['u32'].pack(data, kwargs)
208 def unpack(self, data, offset=0, result=None):
209 x, size = types['u32'].unpack(data, offset)
210 return self.enum(x), size
213 class VPPUnionType():
214 def __init__(self, name, msgdef):
219 self.packers = collections.OrderedDict()
220 for i, f in enumerate(msgdef):
221 if type(f) is dict and 'crc' in f:
225 if f_type not in types:
226 logger.debug('Unknown union type {}'.format(f_type))
227 raise ValueError('Unknown message type {}'.format(f_type))
228 fields.append(f_name)
229 size = types[f_type].size
230 self.packers[f_name] = types[f_type]
236 self.tuple = collections.namedtuple(name, fields, rename=True)
237 logger.debug('Adding union {}'.format(name))
239 def pack(self, data, kwargs=None):
240 for k, v in data.items():
241 logger.debug("Key: {} Value: {}".format(k, v))
242 b = self.packers[k].pack(v, kwargs)
244 r = bytearray(self.size)
248 def unpack(self, data, offset=0, result=None):
251 for k, p in self.packers.items():
252 x, size = p.unpack(data, offset)
256 return self.tuple._make(r), maxsize
260 # Set everything up to be able to pack / unpack
261 def __init__(self, name, msgdef):
267 self.field_by_name = {}
269 for i, f in enumerate(msgdef):
270 if type(f) is dict and 'crc' in f:
273 f_type, f_name = f[:2]
274 self.fields.append(f_name)
275 self.field_by_name[f_name] = None
276 self.fieldtypes.append(f_type)
277 if f_type not in types:
278 logger.debug('Unknown type {}'.format(f_type))
279 raise ValueError('Unknown message type {}'.format(f_type))
280 if len(f) == 3: # list
282 if list_elements == 0:
283 p = VLAList_legacy(f_name, f_type)
284 self.packers.append(p)
286 p = FixedList_u8(f_name, f_type, list_elements)
287 self.packers.append(p)
290 p = FixedList(f_name, f_type, list_elements)
291 self.packers.append(p)
293 elif len(f) == 4: # Variable length list
294 # Find index of length field
295 length_index = self.fields.index(f[3])
296 p = VLAList(f_name, f_type, f[3], length_index)
297 self.packers.append(p)
299 self.packers.append(types[f_type])
300 size += types[f_type].size
303 self.tuple = collections.namedtuple(name, self.fields, rename=True)
305 logger.debug('Adding type {}'.format(name))
307 def pack(self, data, kwargs=None):
311 for i, a in enumerate(self.fields):
313 b += b'\x00' * self.packers[i].size
316 if isinstance(self.packers[i], VPPType):
317 b += self.packers[i].pack(data[a], kwargs[a])
319 b += self.packers[i].pack(data[a], kwargs)
322 def unpack(self, data, offset=0, result=None):
323 # Return a list of arguments
326 for p in self.packers:
327 x, size = p.unpack(data, offset, result)
328 if type(x) is tuple and len(x) == 1:
333 t = self.tuple._make(result)
337 class VPPMessage(VPPType):