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',
39 if elements > 0 and type == 'u8':
40 self.packer = struct.Struct('>%ss' % elements)
42 self.packer = struct.Struct(base_types[type])
43 self.size = self.packer.size
44 logger.debug('Adding {} with format: {}'
45 .format(type, base_types[type]))
47 def pack(self, data, kwargs=None):
48 return self.packer.pack(data)
50 def unpack(self, data, offset, result=None):
51 return self.packer.unpack_from(data, offset)[0], self.packer.size
55 types['u8'] = BaseTypes('u8')
56 types['u16'] = BaseTypes('u16')
57 types['u32'] = BaseTypes('u32')
58 types['i32'] = BaseTypes('i32')
59 types['u64'] = BaseTypes('u64')
60 types['f64'] = BaseTypes('f64')
64 def __init__(self, name, field_type, num):
67 self.packer = BaseTypes(field_type, num)
68 self.size = self.packer.size
70 def pack(self, list, kwargs):
71 """Packs a fixed length bytestring. Left-pads with zeros
72 if input data is too short."""
73 if len(list) > self.num:
74 raise ValueError('Fixed list length error for "{}", got: {}'
76 .format(self.name, len(list), self.num))
77 return self.packer.pack(list)
79 def unpack(self, data, offset=0, result=None):
80 if len(data[offset:]) < self.num:
81 raise ValueError('Invalid array length for "{}" got {}'
83 .format(self.name, len(data[offset:]), self.num))
84 return self.packer.unpack(data, offset)
88 def __init__(self, name, field_type, num):
90 self.packer = types[field_type]
91 self.size = self.packer.size * num
93 def pack(self, list, kwargs):
94 if len(list) != self.num:
95 raise ValueError('Fixed list length error, got: {} expected: {}'
96 .format(len(list), self.num))
99 b += self.packer.pack(e)
102 def unpack(self, data, offset=0, result=None):
103 # Return a list of arguments
106 for e in range(self.num):
107 x, size = self.packer.unpack(data, offset)
115 def __init__(self, name, field_type, len_field_name, index):
118 self.packer = types[field_type]
119 self.size = self.packer.size
120 self.length_field = len_field_name
122 def pack(self, list, kwargs=None):
123 if len(list) != kwargs[self.length_field]:
124 raise ValueError('Variable length error, got: {} expected: {}'
125 .format(len(list), kwargs[self.length_field]))
129 if self.packer.size == 1:
130 return bytearray(list)
133 b += self.packer.pack(e)
136 def unpack(self, data, offset=0, result=None):
137 # Return a list of arguments
141 if self.packer.size == 1:
142 if result[self.index] == 0:
144 p = BaseTypes('u8', result[self.index])
145 return p.unpack(data, offset)
148 for e in range(result[self.index]):
149 x, size = self.packer.unpack(data, offset)
156 class VLAList_legacy():
157 def __init__(self, name, field_type):
158 self.packer = types[field_type]
159 self.size = self.packer.size
161 def pack(self, list, kwargs=None):
162 if self.packer.size == 1:
167 b += self.packer.pack(e)
170 def unpack(self, data, offset=0, result=None):
172 # Return a list of arguments
173 if (len(data) - offset) % self.packer.size:
174 raise ValueError('Legacy Variable Length Array length mismatch.')
175 elements = int((len(data) - offset) / self.packer.size)
177 for e in range(elements):
178 x, size = self.packer.unpack(data, offset)
180 offset += self.packer.size
186 def __init__(self, name, msgdef):
187 self.size = types['u32'].size
190 if type(f) is dict and 'enumtype' in f:
191 if f['enumtype'] != 'u32':
192 raise NotImplementedError
195 e_hash[ename] = evalue
196 self.enum = IntEnum(name, e_hash)
198 logger.debug('Adding enum {}'.format(name))
200 def __getattr__(self, name):
201 return self.enum[name]
203 def pack(self, data, kwargs=None):
204 return types['u32'].pack(data, kwargs)
206 def unpack(self, data, offset=0, result=None):
207 x, size = types['u32'].unpack(data, offset)
208 return self.enum(x), size
211 class VPPUnionType():
212 def __init__(self, name, msgdef):
217 self.packers = collections.OrderedDict()
218 for i, f in enumerate(msgdef):
219 if type(f) is dict and 'crc' in f:
223 if f_type not in types:
224 logger.debug('Unknown union type {}'.format(f_type))
225 raise ValueError('Unknown message type {}'.format(f_type))
226 fields.append(f_name)
227 size = types[f_type].size
228 self.packers[f_name] = types[f_type]
234 self.tuple = collections.namedtuple(name, fields, rename=True)
235 logger.debug('Adding union {}'.format(name))
237 def pack(self, data, kwargs=None):
238 for k, v in data.items():
239 logger.debug("Key: {} Value: {}".format(k, v))
240 b = self.packers[k].pack(v, kwargs)
242 r = bytearray(self.size)
246 def unpack(self, data, offset=0, result=None):
249 for k, p in self.packers.items():
250 x, size = p.unpack(data, offset)
254 return self.tuple._make(r), maxsize
258 # Set everything up to be able to pack / unpack
259 def __init__(self, name, msgdef):
265 self.field_by_name = {}
267 for i, f in enumerate(msgdef):
268 if type(f) is dict and 'crc' in f:
271 f_type, f_name = f[:2]
272 self.fields.append(f_name)
273 self.field_by_name[f_name] = None
274 self.fieldtypes.append(f_type)
275 if f_type not in types:
276 logger.debug('Unknown type {}'.format(f_type))
277 raise ValueError('Unknown message type {}'.format(f_type))
278 if len(f) == 3: # list
280 if list_elements == 0:
281 p = VLAList_legacy(f_name, f_type)
282 self.packers.append(p)
284 p = FixedList_u8(f_name, f_type, list_elements)
285 self.packers.append(p)
288 p = FixedList(f_name, f_type, list_elements)
289 self.packers.append(p)
291 elif len(f) == 4: # Variable length list
292 # Find index of length field
293 length_index = self.fields.index(f[3])
294 p = VLAList(f_name, f_type, f[3], length_index)
295 self.packers.append(p)
297 self.packers.append(types[f_type])
298 size += types[f_type].size
301 self.tuple = collections.namedtuple(name, self.fields, rename=True)
303 logger.debug('Adding type {}'.format(name))
305 def pack(self, data, kwargs=None):
309 for i, a in enumerate(self.fields):
311 b += b'\x00' * self.packers[i].size
314 if isinstance(self.packers[i], VPPType):
315 b += self.packers[i].pack(data[a], kwargs[a])
317 b += self.packers[i].pack(data[a], kwargs)
320 def unpack(self, data, offset=0, result=None):
321 # Return a list of arguments
324 for p in self.packers:
325 x, size = p.unpack(data, offset, result)
326 if type(x) is tuple and len(x) == 1:
331 t = self.tuple._make(result)
335 class VPPMessage(VPPType):